DoorLockTrait.OperationErrorEnum
enum DoorLockTrait.OperationErrorEnum : Enum, ClusterEnum
Indicates the cause of the Lock or Unlock operation failure.
Summary
Enum Values |
|
|---|---|
DisabledUserDenied |
The Lock or Unlock error was due to a disabled user ID or credential. |
InsufficientBattery |
The Lock or Unlock error was due to there being insufficient battery power to safely actuate the lock. |
InvalidCredential |
The Lock or Unlock error was due to an invalid credential. |
Restricted |
The Lock or Unlock error was due to a schedule restriction. |
UnknownValue |
The enum value is out of range. |
Unspecified |
The Lock or Unlock error was due to an unknown or unspecified source. |
Public functions |
|
|---|---|
DoorLockTrait.OperationErrorEnum |
Returns the enum constant of this type with the specified name. |
Array<DoorLockTrait.OperationErrorEnum> |
values()Returns an array containing the constants of this enum type, in the order they're declared. |
Enum Values
DisabledUserDenied
val DoorLockTrait.OperationErrorEnum.DisabledUserDenied: DoorLockTrait.OperationErrorEnum
The Lock or Unlock error was due to a disabled user ID or credential.
InsufficientBattery
val DoorLockTrait.OperationErrorEnum.InsufficientBattery: DoorLockTrait.OperationErrorEnum
The Lock or Unlock error was due to there being insufficient battery power to safely actuate the lock.
InvalidCredential
val DoorLockTrait.OperationErrorEnum.InvalidCredential: DoorLockTrait.OperationErrorEnum
The Lock or Unlock error was due to an invalid credential.
Restricted
val DoorLockTrait.OperationErrorEnum.Restricted: DoorLockTrait.OperationErrorEnum
The Lock or Unlock error was due to a schedule restriction.
UnknownValue
val DoorLockTrait.OperationErrorEnum.UnknownValue: DoorLockTrait.OperationErrorEnum
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 DoorLockTrait.OperationErrorEnum.Unspecified: DoorLockTrait.OperationErrorEnum
The Lock or Unlock error was due to an unknown or unspecified source.
Public functions
valueOf
fun valueOf(value: String): DoorLockTrait.OperationErrorEnum
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.OperationErrorEnum>
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.