Variable TlvMessageConst

Type declaration

• duration: FieldType<null | number | bigint>

  This field shall indicate the amount of time, in milliseconds, after the StartTime during which the message is available to be presented. A null value shall indicate "until changed".

  See

  MatterSpecification.v13.Cluster § 1.16.5.5.5

• fabricIndex: FieldType<FabricIndex>

• messageControl: FieldType<TypeFromPartialBitSchema<{
      confirmationRequired: BitFlag;
      messageConfirmed: BitFlag;
      messageProtected: BitFlag;
      replyMessage: BitFlag;
      responseRequired: BitFlag;
  }>>

  This field shall indicate control information related to the message.

  See

  MatterSpecification.v13.Cluster § 1.16.5.5.3

• messageId: FieldType<Uint8Array>

  This field shall indicate a globally unique ID for this message.

  See

  MatterSpecification.v13.Cluster § 1.16.5.5.1

• messageText: FieldType<string>

  This field shall indicate a string containing the message to be presented.

  See

  MatterSpecification.v13.Cluster § 1.16.5.5.6

• priority: FieldType<Messages.MessagePriority>

  This field shall indicate the priority level for this message.

  See

  MatterSpecification.v13.Cluster § 1.16.5.5.2

• responses: OptionalFieldType<TypeFromFields<{
      label: FieldType<string>;
      messageResponseId: FieldType<number>;
  }>[]>

  This field shall indicate a list of potential responses to the message. The entries in this list shall have unique values of MessageResponseID.

  If the ResponseRequired bit is set on the message but this list is empty, the device shall provide a generic acknowledgement button, e.g. "OK".

  If the ResponseRequired bit is not set on the message, this list shall be ignored.

  See

  MatterSpecification.v13.Cluster § 1.16.5.5.7

• startTime: FieldType<null | number>

  This field shall indicate the time in UTC at which the message becomes available to be presented. A null value shall indicate "now."

  See

  MatterSpecification.v13.Cluster § 1.16.5.5.4