OnOffTrait.StartUpOnOffEnum
enum OnOffTrait.StartUpOnOffEnum : Enum, ClusterEnum
Startup behaviors for a device.
Summary
Enum Values |
|
|---|---|
Off |
Sets the |
On |
Sets the |
Toggle |
If the previous value of the |
UnknownValue |
The enum value is out of range. |
Public functions |
|
|---|---|
OnOffTrait.StartUpOnOffEnum |
Returns the enum constant of this type with the specified name. |
Array<OnOffTrait.StartUpOnOffEnum> |
values()Returns an array containing the constants of this enum type, in the order they're declared. |
Enum Values
Off
val OnOffTrait.StartUpOnOffEnum.Off: OnOffTrait.StartUpOnOffEnum
Sets the onOff attribute to false on startup.
On
val OnOffTrait.StartUpOnOffEnum.On: OnOffTrait.StartUpOnOffEnum
Sets the onOff attribute to true on startup.
Toggle
val OnOffTrait.StartUpOnOffEnum.Toggle: OnOffTrait.StartUpOnOffEnum
If the previous value of the onOff attribute is false, set the onOff attribute to true on startup, and vice versa.
UnknownValue
val OnOffTrait.StartUpOnOffEnum.UnknownValue: OnOffTrait.StartUpOnOffEnum
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.
Public functions
valueOf
fun valueOf(value: String): OnOffTrait.StartUpOnOffEnum
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<OnOffTrait.StartUpOnOffEnum>
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.