MessagesTrait.Attributes
interface MessagesTrait.Attributes
Messages |
API for the Messages trait. |
Attributes for the Messages cluster.
Summary
Public properties |
|
|---|---|
List<UInt> |
A list of client-generated commands which are supported by this cluster server instance. |
List<ByteArray>? |
A list of the message IDs of the messages that are being presented to the user. |
List<UInt> |
A list of the attribute IDs of the attributes supported by the cluster instance. |
UShort |
The revision of the server cluster specification supported by the cluster instance. |
MessagesTrait.Feature |
Whether the server supports zero or more optional cluster features. |
List<UInt> |
A list of server-generated commands (server to client) which are supported by this cluster server instance. |
List<MessagesTrait.MessageStruct>? |
A list of queued messages. |
Public properties
acceptedCommandList
val acceptedCommandList: List<UInt>
A list of client-generated commands which are supported by this cluster server instance.
activeMessageIds
val activeMessageIds: List<ByteArray>?
A list of the message IDs of the messages that are being presented to the user. A message ID is an octet string with a fixed length of 16, containing the binary encoding of a UUID as specified in RFC 4122.
Access type: Read
attributeList
val attributeList: List<UInt>
A list of the attribute IDs of the attributes supported by the cluster instance.
clusterRevision
val clusterRevision: UShort
The revision of the server cluster specification supported by the cluster instance.
featureMap
val featureMap: MessagesTrait.Feature
Whether the server supports zero or more optional cluster features. A cluster feature is a set of cluster elements that are mandatory or optional for a defined feature of the cluster. If a cluster feature is supported by the cluster instance, then the corresponding bit is set to 1, otherwise the bit is set to 0 (zero).
generatedCommandList
val generatedCommandList: List<UInt>
A list of server-generated commands (server to client) which are supported by this cluster server instance.
messages
val messages: List<MessagesTrait.MessageStruct>?
A list of queued messages. To preserve user privacy, the server can further limit the set of messages returned in a read request.
Access type: Read