ActionsTrait.ActionTypeEnum
enum ActionsTrait.ActionTypeEnum : Enum, ClusterEnum
Action types.
Summary
Enum Values |
|
|---|---|
Alarm |
Higher priority notification. |
Automation |
Control an automation (for example, motion-activated lights). |
Exception |
A sequence of commands that runs when the expected does not happen. |
Notification |
Send a message to the user. |
Other |
Use this only when none of the other values applies. |
Scene |
Set the endpoints to a predetermined state. |
Sequence |
A sequence of states with a specific time pattern. |
UnknownValue |
The enum value is out of range. |
Public functions |
|
|---|---|
ActionsTrait.ActionTypeEnum |
Returns the enum constant of this type with the specified name. |
Array<ActionsTrait.ActionTypeEnum> |
values()Returns an array containing the constants of this enum type, in the order they're declared. |
Enum Values
Alarm
val ActionsTrait.ActionTypeEnum.Alarm: ActionsTrait.ActionTypeEnum
Higher priority notification.
Automation
val ActionsTrait.ActionTypeEnum.Automation: ActionsTrait.ActionTypeEnum
Control an automation (for example, motion-activated lights).
Exception
val ActionsTrait.ActionTypeEnum.Exception: ActionsTrait.ActionTypeEnum
A sequence of commands that runs when the expected does not happen.
Notification
val ActionsTrait.ActionTypeEnum.Notification: ActionsTrait.ActionTypeEnum
Send a message to the user.
Other
val ActionsTrait.ActionTypeEnum.Other: ActionsTrait.ActionTypeEnum
Use this only when none of the other values applies.
Scene
val ActionsTrait.ActionTypeEnum.Scene: ActionsTrait.ActionTypeEnum
Set the endpoints to a predetermined state.
Sequence
val ActionsTrait.ActionTypeEnum.Sequence: ActionsTrait.ActionTypeEnum
A sequence of states with a specific time pattern.
UnknownValue
val ActionsTrait.ActionTypeEnum.UnknownValue: ActionsTrait.ActionTypeEnum
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): ActionsTrait.ActionTypeEnum
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<ActionsTrait.ActionTypeEnum>
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.