ServiceAreaTrait.SkipAreaStatus
enum ServiceAreaTrait.SkipAreaStatus : Enum, ClusterEnum
The status of the SkipArea command.
Summary
Enum Values |
|
|---|---|
InvalidAreaList |
The |
InvalidInMode |
The received request cannot be handled due to the current mode of the device. |
InvalidSkippedArea |
The |
Success |
Skipping the area is allowed and possible, or the device was operating at the last available area and has stopped. |
UnknownValue |
The enum value is out of range. |
Public functions |
|
|---|---|
String |
|
ServiceAreaTrait.SkipAreaStatus |
Returns the enum constant of this type with the specified name. |
Array<ServiceAreaTrait.SkipAreaStatus> |
values()Returns an array containing the constants of this enum type, in the order they're declared. |
Public properties |
|
|---|---|
EnumEntries<ServiceAreaTrait.SkipAreaStatus> |
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
InvalidAreaList
val ServiceAreaTrait.SkipAreaStatus.InvalidAreaList: ServiceAreaTrait.SkipAreaStatus
The selectedAreas attribute is empty.
InvalidInMode
val ServiceAreaTrait.SkipAreaStatus.InvalidInMode: ServiceAreaTrait.SkipAreaStatus
The received request cannot be handled due to the current mode of the device. For example, the currentArea attribute is null or the device is not operating.
InvalidSkippedArea
val ServiceAreaTrait.SkipAreaStatus.InvalidSkippedArea: ServiceAreaTrait.SkipAreaStatus
The skippedArea field doesn't match an entry in the supportedAreas list.
Success
val ServiceAreaTrait.SkipAreaStatus.Success: ServiceAreaTrait.SkipAreaStatus
Skipping the area is allowed and possible, or the device was operating at the last available area and has stopped.
UnknownValue
val ServiceAreaTrait.SkipAreaStatus.UnknownValue: ServiceAreaTrait.SkipAreaStatus
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): ServiceAreaTrait.SkipAreaStatus
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<ServiceAreaTrait.SkipAreaStatus>
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<ServiceAreaTrait.SkipAreaStatus>
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.