MessagesTrait.FutureMessagePreferenceEnum
enum MessagesTrait.FutureMessagePreferenceEnum : Enum, ClusterEnum
| kotlin.Any | ||
| ↳ | kotlin.Enum | |
| ↳ | com.google.home.matter.standard.MessagesTrait.FutureMessagePreferenceEnum | |
A display device may include this preference in the MessageComplete event as a hint to clients about how to handle future similar messages for the user.
Summary
Enum Values |
|
|---|---|
Allowed |
Similar messages are allowed to be presented to the user. |
Banned |
No further messages should be sent to the user. |
Disallowed |
Similar messages are not allowed to be presented to the user. |
Increased |
Similar messages are allowed to be presented to the user, but at an increased rate. |
Reduced |
Similar messages are allowed to be presented to the user, but at a reduced rate. |
UnknownValue |
The enum value is out of range. |
Public functions |
|
|---|---|
String |
|
MessagesTrait.FutureMessagePreferenceEnum |
Returns the enum constant of this type with the specified name. |
Array<MessagesTrait.FutureMessagePreferenceEnum> |
values()Returns an array containing the constants of this enum type, in the order they're declared. |
Public properties |
|
|---|---|
EnumEntries<MessagesTrait.FutureMessagePreferenceEnum> |
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
Allowed
val MessagesTrait.FutureMessagePreferenceEnum.Allowed: MessagesTrait.FutureMessagePreferenceEnum
Similar messages are allowed to be presented to the user.
Banned
val MessagesTrait.FutureMessagePreferenceEnum.Banned: MessagesTrait.FutureMessagePreferenceEnum
No further messages should be sent to the user.
Disallowed
val MessagesTrait.FutureMessagePreferenceEnum.Disallowed: MessagesTrait.FutureMessagePreferenceEnum
Similar messages are not allowed to be presented to the user.
Increased
val MessagesTrait.FutureMessagePreferenceEnum.Increased: MessagesTrait.FutureMessagePreferenceEnum
Similar messages are allowed to be presented to the user, but at an increased rate.
Reduced
val MessagesTrait.FutureMessagePreferenceEnum.Reduced: MessagesTrait.FutureMessagePreferenceEnum
Similar messages are allowed to be presented to the user, but at a reduced rate.
UnknownValue
val MessagesTrait.FutureMessagePreferenceEnum.UnknownValue: MessagesTrait.FutureMessagePreferenceEnum
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.FutureMessagePreferenceEnum
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.FutureMessagePreferenceEnum>
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.FutureMessagePreferenceEnum>
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.