AirQualityTrait.AirQualityEnum
enum AirQualityTrait.AirQualityEnum : Enum, ClusterEnum
The quality of the analyzed air.
Summary
Enum Values |
|
|---|---|
ExtremelyPoor |
The air quality is extremely poor. |
Fair |
The air quality is fair. |
Good |
The air quality is good. |
Moderate |
The air quality is moderate. |
Poor |
The air quality is poor. |
Unknown |
The air quality is unknown. |
UnknownValue |
The enum value is out of range. |
VeryPoor |
The air quality is very poor. |
Public functions |
|
|---|---|
AirQualityTrait.AirQualityEnum |
Returns the enum constant of this type with the specified name. |
Array<AirQualityTrait.AirQualityEnum> |
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
ExtremelyPoor
val AirQualityTrait.AirQualityEnum.ExtremelyPoor: AirQualityTrait.AirQualityEnum
The air quality is extremely poor.
Fair
val AirQualityTrait.AirQualityEnum.Fair: AirQualityTrait.AirQualityEnum
The air quality is fair.
Good
val AirQualityTrait.AirQualityEnum.Good: AirQualityTrait.AirQualityEnum
The air quality is good.
Moderate
val AirQualityTrait.AirQualityEnum.Moderate: AirQualityTrait.AirQualityEnum
The air quality is moderate.
Poor
val AirQualityTrait.AirQualityEnum.Poor: AirQualityTrait.AirQualityEnum
The air quality is poor.
Unknown
val AirQualityTrait.AirQualityEnum.Unknown: AirQualityTrait.AirQualityEnum
The air quality is unknown.
UnknownValue
val AirQualityTrait.AirQualityEnum.UnknownValue: AirQualityTrait.AirQualityEnum
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.
VeryPoor
val AirQualityTrait.AirQualityEnum.VeryPoor: AirQualityTrait.AirQualityEnum
The air quality is very poor.
Public functions
valueOf
fun valueOf(value: String): AirQualityTrait.AirQualityEnum
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<AirQualityTrait.AirQualityEnum>
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.