DeviceEnergyManagementTrait.OptOutStateEnum
enum DeviceEnergyManagementTrait.OptOutStateEnum : Enum, ClusterEnum
| kotlin.Any | ||
| ↳ | kotlin.Enum | |
| ↳ | com.google.home.matter.standard.DeviceEnergyManagementTrait.OptOutStateEnum | |
The opt-out state of the ESA.
Summary
Enum Values |
|
|---|---|
GridOptOut |
The user has opted out of grid EMS optimizations only. |
LocalOptOut |
The user has opted out of local EMS optimizations only. |
NoOptOut |
The user has not opted out of either local or grid optimizations. |
OptOut |
The user has opted out of all external optimizations. |
UnknownValue |
The enum value is out of range. |
Public functions |
|
|---|---|
String |
|
DeviceEnergyManagementTrait.OptOutStateEnum |
Returns the enum constant of this type with the specified name. |
Array<DeviceEnergyManagementTrait.OptOutStateEnum> |
values()Returns an array containing the constants of this enum type, in the order they're declared. |
Public properties |
|
|---|---|
EnumEntries<DeviceEnergyManagementTrait.OptOutStateEnum> |
Returns a representation of an immutable list of all enum entries, in the order they're declared. |
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
GridOptOut
val DeviceEnergyManagementTrait.OptOutStateEnum.GridOptOut: DeviceEnergyManagementTrait.OptOutStateEnum
The user has opted out of grid EMS optimizations only.
LocalOptOut
val DeviceEnergyManagementTrait.OptOutStateEnum.LocalOptOut: DeviceEnergyManagementTrait.OptOutStateEnum
The user has opted out of local EMS optimizations only.
NoOptOut
val DeviceEnergyManagementTrait.OptOutStateEnum.NoOptOut: DeviceEnergyManagementTrait.OptOutStateEnum
The user has not opted out of either local or grid optimizations.
OptOut
val DeviceEnergyManagementTrait.OptOutStateEnum.OptOut: DeviceEnergyManagementTrait.OptOutStateEnum
The user has opted out of all external optimizations.
UnknownValue
val DeviceEnergyManagementTrait.OptOutStateEnum.UnknownValue: DeviceEnergyManagementTrait.OptOutStateEnum
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): DeviceEnergyManagementTrait.OptOutStateEnum
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<DeviceEnergyManagementTrait.OptOutStateEnum>
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
entries
val entries: EnumEntries<DeviceEnergyManagementTrait.OptOutStateEnum>
Returns a representation of an immutable list of all enum entries, in the order they're declared.
This method may be used to iterate over the enum entries.
traitId
open val traitId: String
Trait identifier of the Matter Cluster that defines the enum Data Type. Refer to ClusterId.traitId for the format.