DoorLockTrait.LockOperationTypeEnum

enum DoorLockTrait.LockOperationTypeEnum : Enum, ClusterEnum


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>

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

Public properties

open String
open String
open ULong

Enum Values

ForcedUserEvent

val DoorLockTrait.LockOperationTypeEnum.ForcedUserEventDoorLockTrait.LockOperationTypeEnum

Triggered by using a user with UserTypeEnum set to ForcedUser.

NonAccessUserEvent

val DoorLockTrait.LockOperationTypeEnum.NonAccessUserEventDoorLockTrait.LockOperationTypeEnum

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

UnknownValue

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

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 traitIdString

typeName

open val typeNameString

value

open val valueULong