@matter/types 0.13.0-alpha.0-20250329-cd36948da → 0.13.0-alpha.0-20250330-df5a17eba

package/dist/esm/clusters/messages.js

@@ -37,7 +37,7 @@ var Messages;
      * confirmation is required, the device SHOULD present the message until it is either confirmed by the user
      * selecting a confirmation option, or the message expires.
      *
-     * @see {@link MatterSpecification.v13.Cluster} § 1.16.5.2.1
+     * @see {@link MatterSpecification.v14.Cluster} § 1.16.5.2.1
      */
     confirmationRequired: BitFlag(0),
     /**
@@ -46,7 +46,7 @@ var Messages;
      * This bit shall indicate that a MessagePresented event SHOULD be generated based on the response of the user
      * to the message.
      *
-     * @see {@link MatterSpecification.v13.Cluster} § 1.16.5.2.2
+     * @see {@link MatterSpecification.v14.Cluster} § 1.16.5.2.2
      */
     responseRequired: BitFlag(1),
     /**
@@ -54,7 +54,7 @@ var Messages;
      *
      * This bit shall indicate that a free-form user reply is to be included in the confirmation of receipt.
      *
-     * @see {@link MatterSpecification.v13.Cluster} § 1.16.5.2.3
+     * @see {@link MatterSpecification.v14.Cluster} § 1.16.5.2.3
      */
     replyMessage: BitFlag(2),
     /**
@@ -63,7 +63,7 @@ var Messages;
      * This bit shall indicate the current confirmation state of a message, which is useful in the event that there
      * are multiple Messages cluster client devices on a network.
      *
-     * @see {@link MatterSpecification.v13.Cluster} § 1.16.5.2.4
+     * @see {@link MatterSpecification.v14.Cluster} § 1.16.5.2.4
      */
     messageConfirmed: BitFlag(3),
     /**
@@ -72,7 +72,7 @@ var Messages;
      * This bit shall indicate that user authentication (e.g. by password or PIN) is required before viewing a
      * message.
      *
-     * @see {@link MatterSpecification.v13.Cluster} § 1.16.5.2.5
+     * @see {@link MatterSpecification.v14.Cluster} § 1.16.5.2.5
      */
     messageProtected: BitFlag(4)
   };
@@ -80,13 +80,13 @@ var Messages;
     /**
      * This field shall indicate a unique unsigned 32-bit number identifier for this message response option.
      *
-     * @see {@link MatterSpecification.v13.Cluster} § 1.16.5.6.1
+     * @see {@link MatterSpecification.v14.Cluster} § 1.16.5.6.1
      */
     messageResponseId: TlvField(0, TlvUInt32.bound({ min: 1 })),
     /**
      * This field shall indicate the text for this option; e.g. "Yes", "No", etc.
      *
-     * @see {@link MatterSpecification.v13.Cluster} § 1.16.5.6.2
+     * @see {@link MatterSpecification.v14.Cluster} § 1.16.5.6.2
      */
     label: TlvField(1, TlvString.bound({ maxLength: 32 }))
   });
@@ -94,39 +94,39 @@ var Messages;
     /**
      * This field shall indicate a globally unique ID for this message.
      *
-     * @see {@link MatterSpecification.v13.Cluster} § 1.16.5.5.1
+     * @see {@link MatterSpecification.v14.Cluster} § 1.16.5.5.1
      */
     messageId: TlvField(0, TlvByteString.bound({ length: 16 })),
     /**
      * This field shall indicate the priority level for this message.
      *
-     * @see {@link MatterSpecification.v13.Cluster} § 1.16.5.5.2
+     * @see {@link MatterSpecification.v14.Cluster} § 1.16.5.5.2
      */
     priority: TlvField(1, TlvEnum()),
     /**
      * This field shall indicate control information related to the message.
      *
-     * @see {@link MatterSpecification.v13.Cluster} § 1.16.5.5.3
+     * @see {@link MatterSpecification.v14.Cluster} § 1.16.5.5.3
      */
     messageControl: TlvField(2, TlvBitmap(TlvUInt16, Messages2.MessageControl)),
     /**
      * This field shall indicate the time in UTC at which the message becomes available to be presented. A null
      * value shall indicate "now."
      *
-     * @see {@link MatterSpecification.v13.Cluster} § 1.16.5.5.4
+     * @see {@link MatterSpecification.v14.Cluster} § 1.16.5.5.4
      */
     startTime: TlvField(3, TlvNullable(TlvEpochS)),
     /**
      * 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 {@link MatterSpecification.v13.Cluster} § 1.16.5.5.5
+     * @see {@link MatterSpecification.v14.Cluster} § 1.16.5.5.5
      */
     duration: TlvField(4, TlvNullable(TlvUInt64)),
     /**
      * This field shall indicate a string containing the message to be presented.
      *
-     * @see {@link MatterSpecification.v13.Cluster} § 1.16.5.5.6
+     * @see {@link MatterSpecification.v14.Cluster} § 1.16.5.5.6
      */
     messageText: TlvField(5, TlvString.bound({ maxLength: 256 })),
     /**
@@ -138,7 +138,7 @@ var Messages;
      *
      * If the ResponseRequired bit is not set on the message, this list shall be ignored.
      *
-     * @see {@link MatterSpecification.v13.Cluster} § 1.16.5.5.7
+     * @see {@link MatterSpecification.v14.Cluster} § 1.16.5.5.7
      */
     responses: TlvOptionalField(6, TlvArray(Messages2.TlvMessageResponseOption, { maxLength: 4 })),
     fabricIndex: TlvField(254, TlvFabricIndex)
@@ -147,39 +147,39 @@ var Messages;
     /**
      * This field shall indicate a globally unique ID for this message. See MessageID.
      *
-     * @see {@link MatterSpecification.v13.Cluster} § 1.16.7.1.1
+     * @see {@link MatterSpecification.v14.Cluster} § 1.16.7.1.1
      */
     messageId: TlvField(0, TlvByteString.bound({ length: 16 })),
     /**
      * This field shall indicate the priority level for this message. See Priority.
      *
-     * @see {@link MatterSpecification.v13.Cluster} § 1.16.7.1.2
+     * @see {@link MatterSpecification.v14.Cluster} § 1.16.7.1.2
      */
     priority: TlvField(1, TlvEnum()),
     /**
      * This field shall indicate control information related to the message. See MessageControl.
      *
-     * @see {@link MatterSpecification.v13.Cluster} § 1.16.7.1.3
+     * @see {@link MatterSpecification.v14.Cluster} § 1.16.7.1.3
      */
     messageControl: TlvField(2, TlvBitmap(TlvUInt16, Messages2.MessageControl)),
     /**
      * This field shall indicate the time in UTC at which the message becomes available to be presented. A null
      * value shall indicate "now." See StartTime.
      *
-     * @see {@link MatterSpecification.v13.Cluster} § 1.16.7.1.4
+     * @see {@link MatterSpecification.v14.Cluster} § 1.16.7.1.4
      */
     startTime: TlvField(3, TlvNullable(TlvEpochS)),
     /**
      * 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 Duration.
      *
-     * @see {@link MatterSpecification.v13.Cluster} § 1.16.7.1.5
+     * @see {@link MatterSpecification.v14.Cluster} § 1.16.7.1.5
      */
     duration: TlvField(4, TlvNullable(TlvUInt64)),
     /**
      * This field shall indicate a string containing the message to be presented. See MessageText.
      *
-     * @see {@link MatterSpecification.v13.Cluster} § 1.16.7.1.6
+     * @see {@link MatterSpecification.v14.Cluster} § 1.16.7.1.6
      */
     messageText: TlvField(5, TlvString.bound({ maxLength: 256 })),
     /**
@@ -191,7 +191,7 @@ var Messages;
      *
      * If the ResponseRequired bit is not set on the message, this list shall be ignored. See Responses.
      *
-     * @see {@link MatterSpecification.v13.Cluster} § 1.16.7.1.7
+     * @see {@link MatterSpecification.v14.Cluster} § 1.16.7.1.7
      */
     responses: TlvOptionalField(6, TlvArray(Messages2.TlvMessageResponseOption, { maxLength: 4 }))
   });
@@ -205,7 +205,7 @@ var Messages;
      * Message IDs in this command that indicate messages that do not exist in Messages, or that are not scoped to
      * the fabric of the sender, shall be ignored.
      *
-     * @see {@link MatterSpecification.v13.Cluster} § 1.16.7.2.1
+     * @see {@link MatterSpecification.v14.Cluster} § 1.16.7.2.1
      */
     messageIDs: TlvField(0, TlvArray(TlvByteString.bound({ length: 16 }), { maxLength: 8 }))
   });
@@ -213,7 +213,7 @@ var Messages;
     /**
      * This field shall indicate the MessageID for newly added message.
      *
-     * @see {@link MatterSpecification.v13.Cluster} § 1.16.8.1.1
+     * @see {@link MatterSpecification.v14.Cluster} § 1.16.8.1.1
      */
     messageId: TlvField(0, TlvByteString.bound({ length: 16 })),
     fabricIndex: TlvField(254, TlvFabricIndex)
@@ -222,7 +222,7 @@ var Messages;
     /**
      * This field shall indicate the MessageID for the message being presented.
      *
-     * @see {@link MatterSpecification.v13.Cluster} § 1.16.8.2.1
+     * @see {@link MatterSpecification.v14.Cluster} § 1.16.8.2.1
      */
     messageId: TlvField(0, TlvByteString.bound({ length: 16 })),
     fabricIndex: TlvField(254, TlvFabricIndex)
@@ -239,21 +239,21 @@ var Messages;
     /**
      * This field shall indicate the MessageID for the message being confirmed.
      *
-     * @see {@link MatterSpecification.v13.Cluster} § 1.16.8.3.1
+     * @see {@link MatterSpecification.v14.Cluster} § 1.16.8.3.1
      */
     messageId: TlvField(0, TlvByteString.bound({ length: 16 })),
     /**
      * This field shall indicate the MessageResponseID selected by the user. If there was no response before the
      * Duration of the message has elapsed, this field shall be null.
      *
-     * @see {@link MatterSpecification.v13.Cluster} § 1.16.8.3.2
+     * @see {@link MatterSpecification.v14.Cluster} § 1.16.8.3.2
      */
     responseId: TlvOptionalField(1, TlvNullable(TlvUInt32)),
     /**
      * This field shall indicate a user-provided reply to the message. If there was no reply, or the message did not
      * have the ReplyRequired bit set, this field shall be null.
      *
-     * @see {@link MatterSpecification.v13.Cluster} § 1.16.8.3.3
+     * @see {@link MatterSpecification.v14.Cluster} § 1.16.8.3.3
      */
     reply: TlvOptionalField(2, TlvNullable(TlvString.bound({ maxLength: 256 }))),
     futureMessagesPreference: TlvField(3, TlvNullable(TlvEnum())),
@@ -270,7 +270,7 @@ var Messages;
        * This feature shall indicate that the device can get confirmation from a user that the message was
        * received.
        *
-       * @see {@link MatterSpecification.v13.Cluster} § 1.16.4.1
+       * @see {@link MatterSpecification.v14.Cluster} § 1.16.4.1
        */
       receivedConfirmation: BitFlag(0),
       /**
@@ -279,7 +279,7 @@ var Messages;
        * 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 {@link MatterSpecification.v13.Cluster} § 1.16.4.2
+       * @see {@link MatterSpecification.v14.Cluster} § 1.16.4.2
        */
       confirmationResponse: BitFlag(1),
       /**
@@ -288,7 +288,7 @@ var Messages;
        * This feature shall indicate that the device is capable of collecting a free-form text response to a
        * message.
        *
-       * @see {@link MatterSpecification.v13.Cluster} § 1.16.4.3
+       * @see {@link MatterSpecification.v14.Cluster} § 1.16.4.3
        */
       confirmationReply: BitFlag(2),
       /**
@@ -297,7 +297,7 @@ var Messages;
        * 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 {@link MatterSpecification.v13.Cluster} § 1.16.4.4
+       * @see {@link MatterSpecification.v14.Cluster} § 1.16.4.4
        */
       protectedMessages: BitFlag(3)
     },
@@ -309,7 +309,7 @@ var Messages;
        * 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 {@link MatterSpecification.v13.Cluster} § 1.16.6.1
+       * @see {@link MatterSpecification.v14.Cluster} § 1.16.6.1
        */
       messages: FabricScopedAttribute(0, TlvArray(Messages2.TlvMessage, { maxLength: 8 }), { default: [] }),
       /**
@@ -319,7 +319,7 @@ var Messages;
        * 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 {@link MatterSpecification.v13.Cluster} § 1.16.6.2
+       * @see {@link MatterSpecification.v14.Cluster} § 1.16.6.2
        */
       activeMessageIDs: Attribute(
         1,
@@ -351,11 +351,11 @@ var Messages;
        * 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 {@link MatterSpecification.v13.Cluster} § 1.16.7.1
+       * @see {@link MatterSpecification.v14.Cluster} § 1.16.7.1
        */
       presentMessagesRequest: Command(0, Messages2.TlvPresentMessagesRequest, 0, TlvNoResponse),
       /**
-       * @see {@link MatterSpecification.v13.Cluster} § 1.16.7.2
+       * @see {@link MatterSpecification.v14.Cluster} § 1.16.7.2
        */
       cancelMessagesRequest: Command(1, Messages2.TlvCancelMessagesRequest, 1, TlvNoResponse)
     },
@@ -363,20 +363,20 @@ var Messages;
       /**
        * This event shall be generated when a message is added to the messages attribute.
        *
-       * @see {@link MatterSpecification.v13.Cluster} § 1.16.8.1
+       * @see {@link MatterSpecification.v14.Cluster} § 1.16.8.1
        */
       messageQueued: Event(0, EventPriority.Info, Messages2.TlvMessageQueuedEvent),
       /**
        * This event shall be generated when the message is presented to the user.
        *
-       * @see {@link MatterSpecification.v13.Cluster} § 1.16.8.2
+       * @see {@link MatterSpecification.v14.Cluster} § 1.16.8.2
        */
       messagePresented: Event(1, EventPriority.Info, Messages2.TlvMessagePresentedEvent),
       /**
        * 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 {@link MatterSpecification.v13.Cluster} § 1.16.8.3
+       * @see {@link MatterSpecification.v14.Cluster} § 1.16.8.3
        */
       messageComplete: Event(2, EventPriority.Info, Messages2.TlvMessageCompleteEvent)
     },