ExtendedDoorLockTrait.StructureMode

enum ExtendedDoorLockTrait.StructureMode : Enum, ClusterEnum

kotlin.Any
↳	kotlin.Enum
	↳	com.google.home.google.ExtendedDoorLockTrait.StructureMode

The structure mode.

Summary

Enum Values
`StructureModeAway`	Away mode - users are away.
`StructureModeHome`	Home mode - users are home.
`StructureModeSleep`	Sleep mode - users are sleeping.
`StructureModeUnspecified`	Unspecified.
`StructureModeVacation`	Vacation mode - users are on vacation.
`UnknownValue`	The enum value is out of range.

Public functions
`String`	`@HomeExperimentalGenericApi toDescription()`
`ExtendedDoorLockTrait.StructureMode`	`valueOf(value: String)` Returns the enum constant of this type with the specified name.
`Array<ExtendedDoorLockTrait.StructureMode>`	`values()` Returns an array containing the constants of this enum type, in the order they're declared.

Public properties
`open String`	`traitId` Trait identifier of the Matter Cluster that defines the enum Data Type.
`open String`	`typeName` Name of the Matter Data Type that the enum belongs to, in UpperCamelCase, e.g. "AlarmCodeEnum" from Door Lock Cluster.
`open ULong`	`value` Integer identifier of the enum value per the Matter Application Clusters spec, e.g. 1 for Door Lock Cluster AlarmCodeEnum.LockFactoryReset.

Enum Values

StructureModeAway

val ExtendedDoorLockTrait.StructureMode.StructureModeAway: ExtendedDoorLockTrait.StructureMode

Away mode - users are away.

StructureModeHome

val ExtendedDoorLockTrait.StructureMode.StructureModeHome: ExtendedDoorLockTrait.StructureMode

Home mode - users are home.

StructureModeSleep

val ExtendedDoorLockTrait.StructureMode.StructureModeSleep: ExtendedDoorLockTrait.StructureMode

Sleep mode - users are sleeping.

StructureModeUnspecified

val ExtendedDoorLockTrait.StructureMode.StructureModeUnspecified: ExtendedDoorLockTrait.StructureMode

Unspecified.

StructureModeVacation

val ExtendedDoorLockTrait.StructureMode.StructureModeVacation: ExtendedDoorLockTrait.StructureMode

Vacation mode - users are on vacation.

UnknownValue

val ExtendedDoorLockTrait.StructureMode.UnknownValue: ExtendedDoorLockTrait.StructureMode

The enum value is out of range. For example, a newer Matter cluster definition may support enum values not yet supported by the Home APIs.

Public functions

toDescription

@HomeExperimentalGenericApi
fun toDescription(): String

valueOf

fun valueOf(value: String): ExtendedDoorLockTrait.StructureMode

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Throws
`kotlin.IllegalArgumentException`	if this enum type has no constant with the specified name

values

fun values(): Array<ExtendedDoorLockTrait.StructureMode>

Returns an array containing the constants of this enum type, in the order they're declared.

This method may be used to iterate over the constants.

Public properties

traitId

open val traitId: String

Trait identifier of the Matter Cluster that defines the enum Data Type. Refer to ClusterId.traitId for the format.

typeName

open val typeName: String

Name of the Matter Data Type that the enum belongs to, in UpperCamelCase, e.g. "AlarmCodeEnum" from Door Lock Cluster.

value

open val value: ULong

Integer identifier of the enum value per the Matter Application Clusters spec, e.g. 1 for Door Lock Cluster AlarmCodeEnum.LockFactoryReset.