OperationalStateTrait.OperationalStateEnum
enum OperationalStateTrait.OperationalStateEnum : Enum, ClusterEnum
| kotlin.Any | ||
| ↳ | kotlin.Enum | |
| ↳ | com.google.home.matter.standard.OperationalStateTrait.OperationalStateEnum | |
The operational states.
Summary
Enum Values |
|
|---|---|
Error |
The device is in an error state. |
Paused |
The device has paused during an operation. |
Running |
The device is operating. |
Stopped |
The device is stopped. |
UnknownValue |
The enum value is out of range. |
Public functions |
|
|---|---|
OperationalStateTrait.OperationalStateEnum |
Returns the enum constant of this type with the specified name. |
Array<OperationalStateTrait.OperationalStateEnum> |
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
Error
val OperationalStateTrait.OperationalStateEnum.Error: OperationalStateTrait.OperationalStateEnum
The device is in an error state.
Paused
val OperationalStateTrait.OperationalStateEnum.Paused: OperationalStateTrait.OperationalStateEnum
The device has paused during an operation.
Running
val OperationalStateTrait.OperationalStateEnum.Running: OperationalStateTrait.OperationalStateEnum
The device is operating.
Stopped
val OperationalStateTrait.OperationalStateEnum.Stopped: OperationalStateTrait.OperationalStateEnum
The device is stopped.
UnknownValue
val OperationalStateTrait.OperationalStateEnum.UnknownValue: OperationalStateTrait.OperationalStateEnum
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): OperationalStateTrait.OperationalStateEnum
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<OperationalStateTrait.OperationalStateEnum>
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.