DoorLockTrait.AlarmCodeEnum
enum DoorLockTrait.AlarmCodeEnum : Enum, ClusterEnum
Alarm codes.
Summary
Enum Values |
|
|---|---|
DoorAjar |
The door is ajar. |
DoorForcedOpen |
The door has been forced open without the lock having been unlocked. |
ForcedUser |
Activate the user SOS alarm. |
FrontEsceutcheonRemoved |
The front escutcheon of the lock has been removed. |
LockFactoryReset |
The lock is reset to factory defaults. |
LockJammed |
The lock is jammed. |
LockRadioPowerCycled |
The lock has been radio power-cycled. |
UnknownValue |
The enum value is out of range. |
WrongCodeEntryLimit |
The lock has exceeded the wrong code entry limit. |
Public functions |
|
|---|---|
DoorLockTrait.AlarmCodeEnum |
Returns the enum constant of this type with the specified name. |
Array<DoorLockTrait.AlarmCodeEnum> |
values()Returns an array containing the constants of this enum type, in the order they're declared. |
Enum Values
DoorForcedOpen
val DoorLockTrait.AlarmCodeEnum.DoorForcedOpen: DoorLockTrait.AlarmCodeEnum
The door has been forced open without the lock having been unlocked.
ForcedUser
val DoorLockTrait.AlarmCodeEnum.ForcedUser: DoorLockTrait.AlarmCodeEnum
Activate the user SOS alarm.
FrontEsceutcheonRemoved
val DoorLockTrait.AlarmCodeEnum.FrontEsceutcheonRemoved: DoorLockTrait.AlarmCodeEnum
The front escutcheon of the lock has been removed.
LockFactoryReset
val DoorLockTrait.AlarmCodeEnum.LockFactoryReset: DoorLockTrait.AlarmCodeEnum
The lock is reset to factory defaults.
LockJammed
val DoorLockTrait.AlarmCodeEnum.LockJammed: DoorLockTrait.AlarmCodeEnum
The lock is jammed.
LockRadioPowerCycled
val DoorLockTrait.AlarmCodeEnum.LockRadioPowerCycled: DoorLockTrait.AlarmCodeEnum
The lock has been radio power-cycled.
UnknownValue
val DoorLockTrait.AlarmCodeEnum.UnknownValue: DoorLockTrait.AlarmCodeEnum
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.
WrongCodeEntryLimit
val DoorLockTrait.AlarmCodeEnum.WrongCodeEntryLimit: DoorLockTrait.AlarmCodeEnum
The lock has exceeded the wrong code entry limit.
Public functions
valueOf
fun valueOf(value: String): DoorLockTrait.AlarmCodeEnum
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.AlarmCodeEnum>
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.