IdentifyTrait.IdentifyTypeEnum
enum IdentifyTrait.IdentifyTypeEnum : Enum, ClusterEnum
The identification state presented to the user.
Summary
Enum Values |
|
|---|---|
Actuator |
The identification state is conveyed by actuator functionality, such as through a window blind operation or in-wall relay. |
AudibleBeep |
The identification state is conveyed by an audible beep. |
Display |
The identification state is visible on a display. |
LightOutput |
The identification state is conveyed by the lighting output of a lighting product. |
None |
The identification state is not presented to the user. |
UnknownValue |
The enum value is out of range. |
VisibleIndicator |
The identification state is conveyed by an indicator on the device, such as a small LED. |
Public functions |
|
|---|---|
IdentifyTrait.IdentifyTypeEnum |
Returns the enum constant of this type with the specified name. |
Array<IdentifyTrait.IdentifyTypeEnum> |
values()Returns an array containing the constants of this enum type, in the order they're declared. |
Enum Values
Actuator
val IdentifyTrait.IdentifyTypeEnum.Actuator: IdentifyTrait.IdentifyTypeEnum
The identification state is conveyed by actuator functionality, such as through a window blind operation or in-wall relay.
AudibleBeep
val IdentifyTrait.IdentifyTypeEnum.AudibleBeep: IdentifyTrait.IdentifyTypeEnum
The identification state is conveyed by an audible beep.
Display
val IdentifyTrait.IdentifyTypeEnum.Display: IdentifyTrait.IdentifyTypeEnum
The identification state is visible on a display.
LightOutput
val IdentifyTrait.IdentifyTypeEnum.LightOutput: IdentifyTrait.IdentifyTypeEnum
The identification state is conveyed by the lighting output of a lighting product.
None
val IdentifyTrait.IdentifyTypeEnum.None: IdentifyTrait.IdentifyTypeEnum
The identification state is not presented to the user.
UnknownValue
val IdentifyTrait.IdentifyTypeEnum.UnknownValue: IdentifyTrait.IdentifyTypeEnum
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.
VisibleIndicator
val IdentifyTrait.IdentifyTypeEnum.VisibleIndicator: IdentifyTrait.IdentifyTypeEnum
The identification state is conveyed by an indicator on the device, such as a small LED.
Public functions
valueOf
fun valueOf(value: String): IdentifyTrait.IdentifyTypeEnum
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<IdentifyTrait.IdentifyTypeEnum>
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.