FilterMonitoringTrait.ChangeIndication
enum FilterMonitoringTrait.ChangeIndication : Enum, ClusterEnum
Describes the requirements for when to change the filter.
Summary
Enum Values |
|
|---|---|
Critical |
The filter resource is exhausted, and immediate intervention is required. |
Ok |
The filter is in good condition, and no intervention is required. |
UnknownValue |
The enum value is out of range. |
Unspecified |
The filter condition is not specified. |
Warning |
The filter resource will be exhausted soon, and intervention will be required. |
Public functions |
|
|---|---|
FilterMonitoringTrait.ChangeIndication |
Returns the enum constant of this type with the specified name. |
Array<FilterMonitoringTrait.ChangeIndication> |
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
Critical
val FilterMonitoringTrait.ChangeIndication.Critical: FilterMonitoringTrait.ChangeIndication
The filter resource is exhausted, and immediate intervention is required.
Ok
val FilterMonitoringTrait.ChangeIndication.Ok: FilterMonitoringTrait.ChangeIndication
The filter is in good condition, and no intervention is required.
UnknownValue
val FilterMonitoringTrait.ChangeIndication.UnknownValue: FilterMonitoringTrait.ChangeIndication
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.
Unspecified
val FilterMonitoringTrait.ChangeIndication.Unspecified: FilterMonitoringTrait.ChangeIndication
The filter condition is not specified.
Warning
val FilterMonitoringTrait.ChangeIndication.Warning: FilterMonitoringTrait.ChangeIndication
The filter resource will be exhausted soon, and intervention will be required.
Public functions
valueOf
fun valueOf(value: String): FilterMonitoringTrait.ChangeIndication
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<FilterMonitoringTrait.ChangeIndication>
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.