Variable BaseConst

Type declaration

• Readonlyattributes: {
      activeMessageIDs: Attribute<Uint8Array[], any>;
      messages: FabricScopedAttribute<TypeFromFields<{
          duration: FieldType<null | number | bigint>;
          fabricIndex: FieldType<FabricIndex>;
          messageControl: FieldType<TypeFromPartialBitSchema<{
              confirmationRequired: BitFlag;
              messageConfirmed: BitFlag;
              messageProtected: BitFlag;
              replyMessage: BitFlag;
              responseRequired: BitFlag;
          }>>;
          messageId: FieldType<Uint8Array>;
          messageText: FieldType<string>;
          priority: FieldType<Messages.MessagePriority>;
          responses: OptionalFieldType<TypeFromFields<{
              label: FieldType<(...)>;
              messageResponseId: FieldType<(...)>;
          }>[]>;
          startTime: FieldType<null | number>;
      }>[], any>;
  }

  • ReadonlyactiveMessageIDs: Attribute<Uint8Array[], any>

    Indicates a list of the MessageIDs of the Messages currently being presented. If this list is empty, no messages are currently being presented.

    This list shall NOT be fabric-scoped; it shall contain MessageIDs for all Messages being presented, no matter what fabric the client that queued them is on.

    See

    MatterSpecification.v13.Cluster § 1.16.6.2

  • Readonlymessages: FabricScopedAttribute<TypeFromFields<{
        duration: FieldType<null | number | bigint>;
        fabricIndex: FieldType<FabricIndex>;
        messageControl: FieldType<TypeFromPartialBitSchema<{
            confirmationRequired: BitFlag;
            messageConfirmed: BitFlag;
            messageProtected: BitFlag;
            replyMessage: BitFlag;
            responseRequired: BitFlag;
        }>>;
        messageId: FieldType<Uint8Array>;
        messageText: FieldType<string>;
        priority: FieldType<Messages.MessagePriority>;
        responses: OptionalFieldType<TypeFromFields<{
            label: FieldType<(...)>;
            messageResponseId: FieldType<(...)>;
        }>[]>;
        startTime: FieldType<null | number>;
    }>[], any>

    Indicates a list of queued messages.

    In addition to filtering based upon fabric, to preserve user privacy, the server may further limit the set of messages returned in a read request. At minimum, the server shall return to a client those messages that the client itself created/submitted.

    See

    MatterSpecification.v13.Cluster § 1.16.6.1

• Readonlycommands: {
      cancelMessagesRequest: Command<TypeFromFields<{
          messageIDs: FieldType<Uint8Array[]>;
      }>, void, any>;
      presentMessagesRequest: Command<TypeFromFields<{
          duration: FieldType<null | number | bigint>;
          messageControl: FieldType<TypeFromPartialBitSchema<{
              confirmationRequired: BitFlag;
              messageConfirmed: BitFlag;
              messageProtected: BitFlag;
              replyMessage: BitFlag;
              responseRequired: BitFlag;
          }>>;
          messageId: FieldType<Uint8Array>;
          messageText: FieldType<string>;
          priority: FieldType<Messages.MessagePriority>;
          responses: OptionalFieldType<TypeFromFields<{
              label: FieldType<string>;
              messageResponseId: FieldType<number>;
          }>[]>;
          startTime: FieldType<null | number>;
      }>, void, any>;
  }

  • ReadonlycancelMessagesRequest: Command<TypeFromFields<{
        messageIDs: FieldType<Uint8Array[]>;
    }>, void, any>

    See

    MatterSpecification.v13.Cluster § 1.16.7.2

  • ReadonlypresentMessagesRequest: Command<TypeFromFields<{
        duration: FieldType<null | number | bigint>;
        messageControl: FieldType<TypeFromPartialBitSchema<{
            confirmationRequired: BitFlag;
            messageConfirmed: BitFlag;
            messageProtected: BitFlag;
            replyMessage: BitFlag;
            responseRequired: BitFlag;
        }>>;
        messageId: FieldType<Uint8Array>;
        messageText: FieldType<string>;
        priority: FieldType<Messages.MessagePriority>;
        responses: OptionalFieldType<TypeFromFields<{
            label: FieldType<string>;
            messageResponseId: FieldType<number>;
        }>[]>;
        startTime: FieldType<null | number>;
    }>, void, any>

    Upon receipt, this shall cause the message in the passed fields to be appended to the Messages attribute.

    If appending the message would cause the number of messages to be greater than the capacity of the list, the device shall NOT append any message to Messages, and shall return a status code of RESOURCE_EXHAUSTED.

    When displaying a message in response to this command, an indication (ex. visual) of the origin node of the command shall be provided. This could be in the form of a friendly name label which uniquely identifies the node to the user. This friendly name label is typically assigned by the Matter Admin at the time of commissioning and, when it’s a device, is often editable by the user. It might be a combination of a company name and friendly name, for example, ”Acme” or “Acme Streaming Service on Alice’s Phone”.

    NOTE

    It is currently not specified where the friendly name label can be found on the node, meaning that clients SHOULD NOT rely on a certain method they happen to observe in a particular server instance, since other instances could employ a different method.

    The device SHOULD make it possible for the user to view which nodes have access to this cluster and to individually remove privileges for each node.

    See

    MatterSpecification.v13.Cluster § 1.16.7.1

• Readonlyevents: {
      messageComplete: Event<TypeFromFields<{
          fabricIndex: FieldType<FabricIndex>;
          futureMessagesPreference: FieldType<null | Messages.FutureMessagePreference>;
          messageId: FieldType<Uint8Array>;
          reply: OptionalFieldType<null | string>;
          responseId: OptionalFieldType<null | number>;
      }>, any>;
      messagePresented: Event<TypeFromFields<{
          fabricIndex: FieldType<FabricIndex>;
          messageId: FieldType<Uint8Array>;
      }>, any>;
      messageQueued: Event<TypeFromFields<{
          fabricIndex: FieldType<FabricIndex>;
          messageId: FieldType<Uint8Array>;
      }>, any>;
  }

  • ReadonlymessageComplete: Event<TypeFromFields<{
        fabricIndex: FieldType<FabricIndex>;
        futureMessagesPreference: FieldType<null | Messages.FutureMessagePreference>;
        messageId: FieldType<Uint8Array>;
        reply: OptionalFieldType<null | string>;
        responseId: OptionalFieldType<null | number>;
    }>, any>

    This event shall be generated when the message is confirmed by the user, or when the Duration of the message has elapsed without confirmation.

    See

    MatterSpecification.v13.Cluster § 1.16.8.3

  • ReadonlymessagePresented: Event<TypeFromFields<{
        fabricIndex: FieldType<FabricIndex>;
        messageId: FieldType<Uint8Array>;
    }>, any>

    This event shall be generated when the message is presented to the user.

    See

    MatterSpecification.v13.Cluster § 1.16.8.2

  • ReadonlymessageQueued: Event<TypeFromFields<{
        fabricIndex: FieldType<FabricIndex>;
        messageId: FieldType<Uint8Array>;
    }>, any>

    This event shall be generated when a message is added to the messages attribute.

    See

    MatterSpecification.v13.Cluster § 1.16.8.1

• Readonlyextensions: readonly [{
      component: false;
      flags: {
          confirmationResponse: true;
          receivedConfirmation: false;
      };
  }, {
      component: false;
      flags: {
          confirmationReply: true;
          receivedConfirmation: false;
      };
  }]

  This metadata controls which MessagesCluster elements matter.js activates for specific feature combinations.

• Readonlyfeatures: {
      confirmationReply: BitFlag;
      confirmationResponse: BitFlag;
      protectedMessages: BitFlag;
      receivedConfirmation: BitFlag;
  }

  • ReadonlyconfirmationReply: BitFlag

    ConfirmationReply

    This feature shall indicate that the device is capable of collecting a free-form text response to a message.

    See

    MatterSpecification.v13.Cluster § 1.16.4.3

  • ReadonlyconfirmationResponse: BitFlag

    ConfirmationResponse

    This feature shall indicate that the device is capable of presenting a list of responses to the user and recording the user’s choice of response.

    See

    MatterSpecification.v13.Cluster § 1.16.4.2

  • ReadonlyprotectedMessages: BitFlag

    ProtectedMessages

    This feature shall indicate that the device is capable of requiring the user to authenticate before viewing a message; e.g. entering a PIN or password before viewing a message with billing information.

    See

    MatterSpecification.v13.Cluster § 1.16.4.4

  • ReadonlyreceivedConfirmation: BitFlag

    ReceivedConfirmation

    This feature shall indicate that the device can get confirmation from a user that the message was received.

    See

    MatterSpecification.v13.Cluster § 1.16.4.1

• Readonlyid: 151

• Readonlyname: "Messages"

• Readonlyrevision: 3