SimplifiedOnOffTrait.OnOffEnum
enum SimplifiedOnOffTrait.OnOffEnum : Enum, ClusterEnum
The on or off state of the device.
Summary
Enum Values |
|
|---|---|
Off |
The device is off. |
On |
The device is on. |
UnknownValue |
The enum value is out of range. |
Unspecified |
The device's on or off state is unspecified. |
Public functions |
|
|---|---|
SimplifiedOnOffTrait.OnOffEnum |
Returns the enum constant of this type with the specified name. |
Array<SimplifiedOnOffTrait.OnOffEnum> |
values()Returns an array containing the constants of this enum type, in the order they're declared. |
Enum Values
UnknownValue
val SimplifiedOnOffTrait.OnOffEnum.UnknownValue: SimplifiedOnOffTrait.OnOffEnum
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 SimplifiedOnOffTrait.OnOffEnum.Unspecified: SimplifiedOnOffTrait.OnOffEnum
The device's on or off state is unspecified.
Public functions
valueOf
fun valueOf(value: String): SimplifiedOnOffTrait.OnOffEnum
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<SimplifiedOnOffTrait.OnOffEnum>
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.