DoorLockTrait.LockOperationTypeEnum

enum DoorLockTrait.LockOperationTypeEnum : Enum, ClusterEnum

kotlin.Any
↳	kotlin.Enum
	↳	com.google.home.matter.standard.DoorLockTrait.LockOperationTypeEnum

The type of Lock operation performed.

Summary

Enum Values
`ForcedUserEvent`	Triggered by using a user with `UserTypeEnum` set to `ForcedUser`.
`Lock`	Lock operation.
`NonAccessUserEvent`	Triggered by keypad entry for user with User Type set to Non-Access User.
`UnknownValue`	The enum value is out of range.
`Unlatch`	Unlatch event.
`Unlock`	Unlock operation.

Public functions
`DoorLockTrait.LockOperationTypeEnum`	`valueOf(value: String)` Returns the enum constant of this type with the specified name.
`Array<DoorLockTrait.LockOperationTypeEnum>`	`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

ForcedUserEvent

val DoorLockTrait.LockOperationTypeEnum.ForcedUserEvent: DoorLockTrait.LockOperationTypeEnum

Triggered by using a user with UserTypeEnum set to ForcedUser.

Lock

val DoorLockTrait.LockOperationTypeEnum.Lock: DoorLockTrait.LockOperationTypeEnum

Lock operation.

NonAccessUserEvent

val DoorLockTrait.LockOperationTypeEnum.NonAccessUserEvent: DoorLockTrait.LockOperationTypeEnum

Triggered by keypad entry for user with User Type set to Non-Access User.

UnknownValue

val DoorLockTrait.LockOperationTypeEnum.UnknownValue: DoorLockTrait.LockOperationTypeEnum

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.

Unlatch

val DoorLockTrait.LockOperationTypeEnum.Unlatch: DoorLockTrait.LockOperationTypeEnum

Unlatch event.

Unlock

val DoorLockTrait.LockOperationTypeEnum.Unlock: DoorLockTrait.LockOperationTypeEnum

Unlock operation.

Public functions

valueOf

fun valueOf(value: String): DoorLockTrait.LockOperationTypeEnum

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<DoorLockTrait.LockOperationTypeEnum>

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.