Messages

interface Messages : MessagesTrait.Attributes, MatterTrait, MessagesCommands

API for the Messages trait. This trait provides an interface for passing messages that a device can present to the user.

Summary

Nested types

Descriptor enum for this trait's attributes.

Descriptor enum for this trait's commands.

Public functions
Boolean
Boolean

Public properties
open TraitFactory<Messages>

Inherited functions
From com.google.home.matter.standard.MessagesCommands
suspend Unit

Cancels the messages in the passed fields.
suspend Unit
presentMessagesRequest(
    messageId: ByteArray,
    priority: MessagesTrait.MessagePriorityEnum,
    messageControl: MessagesTrait.MessageControlBitmap,
    startTime: UInt?,
    duration: ULong?,
    messageText: String,
    optionalArgs: MessagesTrait.PresentMessagesRequestCommand.OptionalArgs.() -> Unit
)

Appends the message in the passed fields to the messages attribute.
From com.google.home.TraitStateInvalidation
suspend Unit

Inherited properties
From com.google.home.matter.standard.MessagesTrait.Attributes
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.
From com.google.home.Trait
Trait.TraitMetadata

Public functions

supports

fun supports(attribute: Messages.Attribute): Boolean

supports

fun supports(command: Messages.Command): Boolean

Public properties

factory

open val factory: TraitFactory<Messages>