LockUnlockTrait.LockState
enum LockUnlockTrait.LockState : Enum, ClusterEnum
The current state of the device.
Summary
Enum Values |
|
|---|---|
Jammed |
The device is jammed and its locked state cannot be determined. |
Locked |
The device is locked. |
UnknownValue |
The enum value is out of range. |
Unlocked |
The device is unlocked. |
Unspecified |
The lock state is unspecified. |
Public functions |
|
|---|---|
LockUnlockTrait.LockState |
Returns the enum constant of this type with the specified name. |
Array<LockUnlockTrait.LockState> |
values()Returns an array containing the constants of this enum type, in the order they're declared. |
Public properties |
|
|---|---|
open String |
Trait identifier of the Matter Cluster that defines the enum Data Type. |
open String |
Name of the Matter Data Type that the enum belongs to, in UpperCamelCase, e.g. "AlarmCodeEnum" from Door Lock Cluster. |
open ULong |
Integer identifier of the enum value per the Matter Application Clusters spec, e.g. 1 for Door Lock Cluster AlarmCodeEnum.LockFactoryReset. |
Enum Values
Jammed
val LockUnlockTrait.LockState.Jammed: LockUnlockTrait.LockState
The device is jammed and its locked state cannot be determined.
UnknownValue
val LockUnlockTrait.LockState.UnknownValue: LockUnlockTrait.LockState
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.
Unspecified
val LockUnlockTrait.LockState.Unspecified: LockUnlockTrait.LockState
The lock state is unspecified.
Public functions
valueOf
fun valueOf(value: String): LockUnlockTrait.LockState
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<LockUnlockTrait.LockState>
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.