DoorLockTrait.DoorLockOperationEventCode

enum DoorLockTrait.DoorLockOperationEventCode : Enum, ClusterEnum


Door lock operation event codes.

Summary

Enum Values

AutoLock

Automatic lock.

KeyLock

Key lock.

KeyUnlock

Key unlock.

Lock

Lock.

LockInvalidPinOrId

Invalid credential provided when attempting to lock.

LockInvalidSchedule

Invalid lock schedule.

ManualLock

Manual lock.

ManualUnlock

Manual unlock.

OneTouchLock

One touch lock.

ScheduleLock

Schedule lock.

ScheduleUnlock

Schedule unlock.

UnknownOrMfgSpecific

Unknown or manufacturer-specific event.

UnknownValue

The enum value is out of range.

Unlock

Unlock.

UnlockInvalidPinOrId

Invalid credential provided when attempting to unlock.

UnlockInvalidSchedule

Invalid unlock schedule.

Public functions

DoorLockTrait.DoorLockOperationEventCode
valueOf(value: String)

Returns the enum constant of this type with the specified name.

Array<DoorLockTrait.DoorLockOperationEventCode>

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

LockInvalidPinOrId

val DoorLockTrait.DoorLockOperationEventCode.LockInvalidPinOrIdDoorLockTrait.DoorLockOperationEventCode

Invalid credential provided when attempting to lock.

UnknownOrMfgSpecific

val DoorLockTrait.DoorLockOperationEventCode.UnknownOrMfgSpecificDoorLockTrait.DoorLockOperationEventCode

Unknown or manufacturer-specific event.

UnknownValue

val DoorLockTrait.DoorLockOperationEventCode.UnknownValueDoorLockTrait.DoorLockOperationEventCode

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.

UnlockInvalidPinOrId

val DoorLockTrait.DoorLockOperationEventCode.UnlockInvalidPinOrIdDoorLockTrait.DoorLockOperationEventCode

Invalid credential provided when attempting to unlock.

Public functions

valueOf

fun valueOf(value: String): DoorLockTrait.DoorLockOperationEventCode

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.DoorLockOperationEventCode>

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