Interface State

interface State {
    activeMessageIDs: Uint8Array[];
    messages: 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<string>;
            messageResponseId: FieldType<number>;
        }>[]>;
        startTime: FieldType<null | number>;
    }>[];
}

Hierarchy

  • StateType
    • State

Properties

activeMessageIDs messages

Properties

ReadonlyactiveMessageIDs

activeMessageIDs: Uint8Array[]

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

messages: 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<string>;
        messageResponseId: FieldType<number>;
    }>[]>;
    startTime: FieldType<null | number>;
}>[]

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

Settings

Member Visibility

On This Page

Properties