ColorControlTrait.DirectionEnum
enum ColorControlTrait.DirectionEnum : Enum, ClusterEnum
The direction in which to change an attribute whose values are arranged in a circle.
Summary
Enum Values |
|
|---|---|
Down |
Decrease the value to reach the target setting. |
Longest |
Take the longest path to reach the target setting. |
Shortest |
Take the shortest path to reach the target setting. |
UnknownValue |
The enum value is out of range. |
Up |
Increase the value to reach the target setting. |
Public functions |
|
|---|---|
ColorControlTrait.DirectionEnum |
Returns the enum constant of this type with the specified name. |
Array<ColorControlTrait.DirectionEnum> |
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
Down
val ColorControlTrait.DirectionEnum.Down: ColorControlTrait.DirectionEnum
Decrease the value to reach the target setting.
Longest
val ColorControlTrait.DirectionEnum.Longest: ColorControlTrait.DirectionEnum
Take the longest path to reach the target setting.
Shortest
val ColorControlTrait.DirectionEnum.Shortest: ColorControlTrait.DirectionEnum
Take the shortest path to reach the target setting.
UnknownValue
val ColorControlTrait.DirectionEnum.UnknownValue: ColorControlTrait.DirectionEnum
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.
Up
val ColorControlTrait.DirectionEnum.Up: ColorControlTrait.DirectionEnum
Increase the value to reach the target setting.
Public functions
valueOf
fun valueOf(value: String): ColorControlTrait.DirectionEnum
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<ColorControlTrait.DirectionEnum>
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.