ServiceAreaTrait.SelectAreasStatus
enum ServiceAreaTrait.SelectAreasStatus : Enum, ClusterEnum
The status of the SelectAreas command.
Summary
Enum Values |
|
|---|---|
InvalidInMode |
The received request cannot be handled due to the current mode of the device. |
InvalidSet |
The set of values is invalid, for example areas on different floors that a robot knows it can't reach on its own. |
Success |
Attempting to operate in the areas identified by the entries of the |
UnknownValue |
The enum value is out of range. |
UnsupportedArea |
The value of at least one of the entries of the |
Public functions |
|
|---|---|
String |
|
ServiceAreaTrait.SelectAreasStatus |
Returns the enum constant of this type with the specified name. |
Array<ServiceAreaTrait.SelectAreasStatus> |
values()Returns an array containing the constants of this enum type, in the order they're declared. |
Public properties |
|
|---|---|
EnumEntries<ServiceAreaTrait.SelectAreasStatus> |
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
InvalidInMode
val ServiceAreaTrait.SelectAreasStatus.InvalidInMode: ServiceAreaTrait.SelectAreasStatus
The received request cannot be handled due to the current mode of the device.
InvalidSet
val ServiceAreaTrait.SelectAreasStatus.InvalidSet: ServiceAreaTrait.SelectAreasStatus
The set of values is invalid, for example areas on different floors that a robot knows it can't reach on its own.
Success
val ServiceAreaTrait.SelectAreasStatus.Success: ServiceAreaTrait.SelectAreasStatus
Attempting to operate in the areas identified by the entries of the newAreas field is allowed and possible. The selectedAreas attribute is set to the value of the newAreas field.
UnknownValue
val ServiceAreaTrait.SelectAreasStatus.UnknownValue: ServiceAreaTrait.SelectAreasStatus
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.
UnsupportedArea
val ServiceAreaTrait.SelectAreasStatus.UnsupportedArea: ServiceAreaTrait.SelectAreasStatus
The value of at least one of the entries of the newAreas field doesn't match any entries in the supportedAreas attribute.
Public functions
valueOf
fun valueOf(value: String): ServiceAreaTrait.SelectAreasStatus
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.SelectAreasStatus>
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.SelectAreasStatus>
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.