MessagesTrait.MessagePriorityEnum
enum MessagesTrait.MessagePriorityEnum : Enum, ClusterEnum
Priority should be used to determine which messages to show when the number of eligible messages is larger than the device's capacity to present them.
Summary
Enum Values |
|
|---|---|
Critical |
The message should be sent with a critical level of importance. |
High |
The message should be sent with a high level of importance. |
Low |
The message should be sent with a low level of importance. |
Medium |
The message should be sent with a medium level of importance. |
UnknownValue |
The enum value is out of range. |
Public functions |
|
|---|---|
String |
|
MessagesTrait.MessagePriorityEnum |
Returns the enum constant of this type with the specified name. |
Array<MessagesTrait.MessagePriorityEnum> |
values()Returns an array containing the constants of this enum type, in the order they're declared. |
Public properties |
|
|---|---|
EnumEntries<MessagesTrait.MessagePriorityEnum> |
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
Critical
val MessagesTrait.MessagePriorityEnum.Critical: MessagesTrait.MessagePriorityEnum
The message should be sent with a critical level of importance.
High
val MessagesTrait.MessagePriorityEnum.High: MessagesTrait.MessagePriorityEnum
The message should be sent with a high level of importance.
Low
val MessagesTrait.MessagePriorityEnum.Low: MessagesTrait.MessagePriorityEnum
The message should be sent with a low level of importance.
Medium
val MessagesTrait.MessagePriorityEnum.Medium: MessagesTrait.MessagePriorityEnum
The message should be sent with a medium level of importance.
UnknownValue
val MessagesTrait.MessagePriorityEnum.UnknownValue: MessagesTrait.MessagePriorityEnum
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): MessagesTrait.MessagePriorityEnum
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<MessagesTrait.MessagePriorityEnum>
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<MessagesTrait.MessagePriorityEnum>
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.