struct MessagesTrait

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


  ### [supportedEventTypes](https://developers.home.google.com/reference/swift/GoogleHomeTypes/Enums/Matter/MessagesTrait#/s:15GoogleHomeTypes6MatterO13MessagesTraitV014supportedEventC0Say0aB3SDK0H0_pXpGvpZ)


  ` List of the event types that are supported by `MessagesTrait`.

  #### Declaration

  Swift

      static let supportedEventTypes: [any Event.Type]

- `


  ### [supportedCommandTypes](https://developers.home.google.com/reference/swift/GoogleHomeTypes/Enums/Matter/MessagesTrait#/s:15GoogleHomeTypes6MatterO13MessagesTraitV016supportedCommandC0Say0aB3SDK0H0_pXpGvpZ)


  ` List of the commands that are supported by `MessagesTrait`.

  #### Declaration

  Swift

      static let supportedCommandTypes: [any Command.Type]

- `


  ### [identifier](https://developers.home.google.com/reference/swift/GoogleHomeTypes/Enums/Matter/MessagesTrait#/s:15GoogleHomeTypes6MatterO13MessagesTraitV10identifierSSvpZ)


  ` The trait identifier.

  #### Declaration

  Swift

      static let identifier: String

- `


  ### [metadata](https://developers.home.google.com/reference/swift/GoogleHomeTypes/Enums/Matter/MessagesTrait#/s:15GoogleHomeTypes6MatterO13MessagesTraitV8metadata0aB3SDK0F8MetadataVvp)


  ` Metadata about this `Trait`.

  #### Declaration

  Swift

      let metadata: TraitMetadata

- `


  ### [attributes](https://developers.home.google.com/reference/swift/GoogleHomeTypes/Enums/Matter/MessagesTrait#/s:15GoogleHomeTypes6MatterO13MessagesTraitV10attributesAE10AttributesVvp)


  ` List of attributes for the `MessagesTrait`.

  #### Declaration

  Swift

      let attributes: https://developers.home.google.com/reference/swift/GoogleHomeTypes/Enums/Matter.html.MessagesTrait.https://developers.home.google.com/reference/swift/GoogleHomeTypes/Enums/Matter/MessagesTrait/Attributes.html

- `


  ### [init(decoder:interactionProxy:metadata:)](https://developers.home.google.com/reference/swift/GoogleHomeTypes/Enums/Matter/MessagesTrait#/s:15GoogleHomeTypes6MatterO13MessagesTraitV7decoder16interactionProxy8metadataAE0aB3SDK0F7DecoderV_AI011InteractionI0_pSgAI0F8MetadataVtKcfc)


  ` Creates a new Trait instance using data read from the given `TraitDecoder`.
  Throws
  `HomeError.parseError` when parsing fails.

  #### Declaration

  Swift

      init(decoder: TraitDecoder, interactionProxy: (any InteractionProxy)?, metadata: TraitMetadata) throws

  #### Parameters

  |---|---|
  | ` decoder ` | The raw data representing this Trait. |
  | ` interactionProxy ` | Proxy to the Interaction Client. |
  | ` metadata ` | Metadata about this Trait. |

- `


  ### [encode(with:)](https://developers.home.google.com/reference/swift/GoogleHomeTypes/Enums/Matter/MessagesTrait#/s:15GoogleHomeTypes6MatterO13MessagesTraitV6encode4withy0aB3SDK0F7EncoderC_tKF)


  ` Writes this object to the given `TraitEncoder`.
  Throws `HomeError.encodingFailed` if the data could not be encoded.

  #### Declaration

  Swift

      func encode(with encoder: TraitEncoder) throws

- `


  ### [forceRead()](https://developers.home.google.com/reference/swift/GoogleHomeTypes/Enums/Matter/MessagesTrait#/s:15GoogleHomeTypes6MatterO13MessagesTraitV9forceReadyyYaKF)


  ` This API provides the ability to invalidate state retrieved through subscriptions to the
  target device in the cases where state is not being reported correctly, either intentionally
  (e.g attributes in Matter traits with the "C" quality) or unintentionally due to poor
  implementations.

  When successful, this API will result in a forced read of the convening scope as specified by
  the sub-class and return the result through existing Trait subscriptions if present and
  active.

  This API is to be used sparingly as it can impact the performance and battery life of the
  target device. As such, this API may be throttled by the platform.
  Callers SHALL be prepared to deal with `HomeError`s thrown by this call.

  #### Declaration

  Swift

      func forceRead() async throws

- `


  ### [Attributes](https://developers.home.google.com/reference/swift/GoogleHomeTypes/Enums/Matter/MessagesTrait/Attributes.html)


  ` Attributes for the `https://developers.home.google.com/reference/swift/GoogleHomeTypes/Enums/Matter/MessagesTrait.html`.

  #### Declaration

  Swift

      struct Attributes

- `


  ### [==(_:_:)](https://developers.home.google.com/reference/swift/GoogleHomeTypes/Enums/Matter/MessagesTrait#/s:15GoogleHomeTypes6MatterO13MessagesTraitV2eeoiySbAE_AEtFZ)


  ` Returns a Boolean value indicating whether two values are equal.

  Equality is the inverse of inequality. For any values `a` and `b`,
  `a == b` implies that `a != b` is `false`.

  #### Declaration

  Swift

      static func == (lhs: https://developers.home.google.com/reference/swift/GoogleHomeTypes/Enums/Matter.html.MessagesTrait, rhs: https://developers.home.google.com/reference/swift/GoogleHomeTypes/Enums/Matter.html.MessagesTrait) -> Bool

  #### Parameters

  |---|---|
  | ` lhs ` | A value to compare. |
  | ` rhs ` | Another value to compare. |

- `


  ### [hash(into:)](https://developers.home.google.com/reference/swift/GoogleHomeTypes/Enums/Matter/MessagesTrait#/s:15GoogleHomeTypes6MatterO13MessagesTraitV4hash4intoys6HasherVz_tF)


  ` Hashes the essential components of this value by feeding them into the
  given hasher.

  Implement this method to conform to the `Hashable` protocol. The
  components used for hashing must be the same as the components compared
  in your type's `==` operator implementation. Call `hasher.combine(_:)`
  with each of these components.
  Important

  In your implementation of `hash(into:)`,
  don't call `finalize()` on the `hasher` instance provided,
  or replace it with a different instance.
  Doing so may become a compile-time error in the future.

  #### Declaration

  Swift

      func hash(into hasher: inout Hasher)

- `


  ### [MessageResponseOptionStruct](https://developers.home.google.com/reference/swift/GoogleHomeTypes/Enums/Matter/MessagesTrait/MessageResponseOptionStruct.html)


  ` A possible response to a message.

  #### Declaration

  Swift

      struct MessageResponseOptionStruct

- `


  ### [MessageStruct](https://developers.home.google.com/reference/swift/GoogleHomeTypes/Enums/Matter/MessagesTrait/MessageStruct.html)


  ` Information about a single message.

  #### Declaration

  Swift

      struct MessageStruct

- `


  ### [MessageQueuedEvent](https://developers.home.google.com/reference/swift/GoogleHomeTypes/Enums/Matter/MessagesTrait/MessageQueuedEvent.html)


  ` This event is sent when a message is added to the `https://developers.home.google.com/reference/swift/GoogleHomeTypes/Enums/Matter/MessagesTrait/Attributes.html#/s:15GoogleHomeTypes6MatterO13MessagesTraitV10AttributesV8messagesSayAE13MessageStructVGSgvp`
  attribute.

  #### Declaration

  Swift

      struct MessageQueuedEvent

- `


  ### [MessagePresentedEvent](https://developers.home.google.com/reference/swift/GoogleHomeTypes/Enums/Matter/MessagesTrait/MessagePresentedEvent.html)


  ` This event is sent when a message is presented to the user.

  #### Declaration

  Swift

      struct MessagePresentedEvent

- `


  ### [MessageCompleteEvent](https://developers.home.google.com/reference/swift/GoogleHomeTypes/Enums/Matter/MessagesTrait/MessageCompleteEvent.html)


  ` This event is sent when the message is confirmed by the user or when the duration of the
  message has elapsed without confirmation.

  #### Declaration

  Swift

      struct MessageCompleteEvent

- `


  ### [supportsPresentMessagesRequestCommand](https://developers.home.google.com/reference/swift/GoogleHomeTypes/Enums/Matter/MessagesTrait#/s:15GoogleHomeTypes6MatterO13MessagesTraitV015supportsPresentE14RequestCommandSbvp)


  ` Whether the device supports the `presentMessagesRequest` command for this trait.

  #### Declaration

  Swift

      var supportsPresentMessagesRequestCommand: Bool { get }

- `


  ### [presentMessagesRequest(messageID:priority:messageControl:startTime:duration:messageText:optionalArgsProvider:)](https://developers.home.google.com/reference/swift/GoogleHomeTypes/Enums/Matter/MessagesTrait#/s:15GoogleHomeTypes6MatterO13MessagesTraitV07presentE7Request9messageID8priority0I7Control9startTime8duration0I4Text20optionalArgsProvidery10Foundation4DataV_AE19MessagePriorityEnumOAE0vL6BitmapVs6UInt32VSgs6UInt64VSgSSyAE07PresenteH7CommandV08OptionalR0CYbcSgtYaKF)


  ` Appends the message in the passed fields to the `https://developers.home.google.com/reference/swift/GoogleHomeTypes/Enums/Matter/MessagesTrait/Attributes.html#/s:15GoogleHomeTypes6MatterO13MessagesTraitV10AttributesV8messagesSayAE13MessageStructVGSgvp` attribute.
  If appending the message would cause the number of messages to be greater than the capacity of
  the list, the device will not append any message to `https://developers.home.google.com/reference/swift/GoogleHomeTypes/Enums/Matter/MessagesTrait/Attributes.html#/s:15GoogleHomeTypes6MatterO13MessagesTraitV10AttributesV8messagesSayAE13MessageStructVGSgvp`, and
  will return a status code of `RESOURCE_EXHAUSTED`.

  #### Declaration

  Swift

      func presentMessagesRequest(messageID: Data, priority: https://developers.home.google.com/reference/swift/GoogleHomeTypes/Enums/Matter.html.MessagesTrait.https://developers.home.google.com/reference/swift/GoogleHomeTypes/Enums/Matter/MessagesTrait/MessagePriorityEnum.html, messageControl: https://developers.home.google.com/reference/swift/GoogleHomeTypes/Enums/Matter.html.MessagesTrait.https://developers.home.google.com/reference/swift/GoogleHomeTypes/Enums/Matter/MessagesTrait/MessageControlBitmap.html, startTime: UInt32?, duration: UInt64?, messageText: String, optionalArgsProvider: (@Sendable (https://developers.home.google.com/reference/swift/GoogleHomeTypes/Enums/Matter.html.MessagesTrait.PresentMessagesRequestCommand.OptionalArgs) -> Void)? = nil) async throws

  #### Parameters

  |---|---|
  | ` priority ` | The priority level for this message. |
  | ` messageControl ` | The control information related to the message. |
  | ` startTime ` | The time, in UTC, at which the message becomes available to be presented. A null value indicates that the message is available immediately. |
  | ` duration ` | The amount of time, in milliseconds, after the `startTime` during which the message is available to be presented. A null value means that the `duration` time remains the same until it's actively changed. |
  | ` messageText ` | A string that contains the message to be presented to the user. |

- `


  ### [presentMessagesRequestBatchable(messageID:priority:messageControl:startTime:duration:messageText:optionalArgsProvider:)](https://developers.home.google.com/reference/swift/GoogleHomeTypes/Enums/Matter/MessagesTrait#/s:15GoogleHomeTypes6MatterO13MessagesTraitV07presentE16RequestBatchable9messageID8priority0J7Control9startTime8duration0J4Text20optionalArgsProvider0aB3SDK0I7CommandVyytG10Foundation4DataV_AE19MessagePriorityEnumOAE0yM6BitmapVs6UInt32VSgs6UInt64VSgSSyAE07PresentehV0V08OptionalS0CcSgtKF)


  ` The batchable version of presentMessagesRequest command above.
  See also
  presentMessagesRequest

  #### Declaration

  Swift

      func presentMessagesRequestBatchable(messageID: Data, priority: https://developers.home.google.com/reference/swift/GoogleHomeTypes/Enums/Matter.html.MessagesTrait.https://developers.home.google.com/reference/swift/GoogleHomeTypes/Enums/Matter/MessagesTrait/MessagePriorityEnum.html, messageControl: https://developers.home.google.com/reference/swift/GoogleHomeTypes/Enums/Matter.html.MessagesTrait.https://developers.home.google.com/reference/swift/GoogleHomeTypes/Enums/Matter/MessagesTrait/MessageControlBitmap.html, startTime: UInt32?, duration: UInt64?, messageText: String, optionalArgsProvider: ((https://developers.home.google.com/reference/swift/GoogleHomeTypes/Enums/Matter.html.MessagesTrait.PresentMessagesRequestCommand.OptionalArgs) -> Void)? = nil) throws -> BatchableCommand<Void>

- `


  ### [supportsCancelMessagesRequestCommand](https://developers.home.google.com/reference/swift/GoogleHomeTypes/Enums/Matter/MessagesTrait#/s:15GoogleHomeTypes6MatterO13MessagesTraitV014supportsCancelE14RequestCommandSbvp)


  ` Whether the device supports the `cancelMessagesRequest` command for this trait.

  #### Declaration

  Swift

      var supportsCancelMessagesRequestCommand: Bool { get }

- `


  ### [cancelMessagesRequest(messageIDs:)](https://developers.home.google.com/reference/swift/GoogleHomeTypes/Enums/Matter/MessagesTrait#/s:15GoogleHomeTypes6MatterO13MessagesTraitV06cancelE7Request10messageIDsySay10Foundation4DataVG_tYaKF)


  ` Cancels the messages in the passed fields.

  #### Declaration

  Swift

      func cancelMessagesRequest(messageIDs: [Data]) async throws

- `


  ### [cancelMessagesRequestBatchable(messageIDs:)](https://developers.home.google.com/reference/swift/GoogleHomeTypes/Enums/Matter/MessagesTrait#/s:15GoogleHomeTypes6MatterO13MessagesTraitV06cancelE16RequestBatchable10messageIDs0aB3SDK0I7CommandVyytGSay10Foundation4DataVG_tKF)


  ` The batchable version of cancelMessagesRequest command above.
  See also
  cancelMessagesRequest

  #### Declaration

  Swift

      func cancelMessagesRequestBatchable(messageIDs: [Data]) throws -> BatchableCommand<Void>

- `


  ### [FutureMessagePreferenceEnum](https://developers.home.google.com/reference/swift/GoogleHomeTypes/Enums/Matter/MessagesTrait/FutureMessagePreferenceEnum.html)


  ` 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.

  #### Declaration

  Swift

      enum FutureMessagePreferenceEnum

- `


  ### [MessagePriorityEnum](https://developers.home.google.com/reference/swift/GoogleHomeTypes/Enums/Matter/MessagesTrait/MessagePriorityEnum.html)


  ` 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.

  #### Declaration

  Swift

      enum MessagePriorityEnum

- `


  ### [Feature](https://developers.home.google.com/reference/swift/GoogleHomeTypes/Enums/Matter/MessagesTrait/Feature.html)


  ` Messages cluster FeatureMap.

  #### Declaration

  Swift

      struct Feature

- `


  ### [MessageControlBitmap](https://developers.home.google.com/reference/swift/GoogleHomeTypes/Enums/Matter/MessagesTrait/MessageControlBitmap.html)


  ` Control information related to a message.

  #### Declaration

  Swift

      struct MessageControlBitmap