ISequencedDocumentMessage Interface
Packages > fluid-framework > ISequencedDocumentMessage
Sequenced message for a distributed document.
This API is provided for existing users, but is not recommended for new users.
To use, import via fluid-framework/legacy.
For more information about our API support guarantees, see here .
Signature
export interface ISequencedDocumentMessage
Properties
| Property | Alerts | Modifiers | Type | Description |
|---|---|---|---|---|
| clientId | Alpha |
string | null | The client ID that submitted the message. For server generated messages the clientId will be null; | |
| clientSequenceNumber | Alpha |
number | The document's client sequence number. | |
| compression | Deprecated, Alpha |
optional |
string | The compression algorithm that was used to compress contents of this message. |
| contents | Alpha |
unknown | The contents of the message. | |
| data | Alpha |
optional |
string | Data provided by service. Only present in service generated messages. |
| expHash1 | Deprecated, Alpha |
optional |
string | Experimental field for storing the rolling hash at sequence number. |
| metadata | Alpha |
optional |
unknown | App provided metadata about the operation. |
| minimumSequenceNumber | Alpha |
number | The minimum sequence number for all connected clients. | |
| origin | Alpha |
optional |
IBranchOrigin | Origin branch information for the message. |
| referenceSequenceNumber | Alpha |
number | The reference sequence number the message was sent relative to. | |
| sequenceNumber | Alpha |
number | The sequenced identifier. | |
| serverMetadata | Alpha |
optional |
unknown | Server provided metadata about the operation. |
| timestamp | Alpha |
number | Timestamp when the server ticketed the message. | |
| traces | Alpha |
optional |
ITrace[] | Traces related to the packet. |
| type | Alpha |
string | The type of operation. |
Property Details
clientId
The client ID that submitted the message. For server generated messages the clientId will be null;
This API is provided as an alpha preview and may change without notice.
To use, import via fluid-framework/alpha.
For more information about our API support guarantees, see here .
Signature
clientId: string | null;
Type: string | null
clientSequenceNumber
The document’s client sequence number.
This API is provided as an alpha preview and may change without notice.
To use, import via fluid-framework/alpha.
For more information about our API support guarantees, see here .
Signature
clientSequenceNumber: number;
Type: number
compression
The compression algorithm that was used to compress contents of this message.
This API is deprecated and will be removed in a future release.
Use ISequencedDocumentMessageExperimental instead.
This API is provided as an alpha preview and may change without notice.
To use, import via fluid-framework/alpha.
For more information about our API support guarantees, see here .
Signature
compression?: string;
Type: string
contents
The contents of the message.
This API is provided as an alpha preview and may change without notice.
To use, import via fluid-framework/alpha.
For more information about our API support guarantees, see here .
Signature
contents: unknown;
Type: unknown
data
Data provided by service. Only present in service generated messages.
This API is provided as an alpha preview and may change without notice.
To use, import via fluid-framework/alpha.
For more information about our API support guarantees, see here .
Signature
data?: string;
Type: string
expHash1
Experimental field for storing the rolling hash at sequence number.
This API is deprecated and will be removed in a future release.
Use ISequencedDocumentMessageExperimental instead.
This API is provided as an alpha preview and may change without notice.
To use, import via fluid-framework/alpha.
For more information about our API support guarantees, see here .
Signature
expHash1?: string;
Type: string
metadata
App provided metadata about the operation.
This API is provided as an alpha preview and may change without notice.
To use, import via fluid-framework/alpha.
For more information about our API support guarantees, see here .
Signature
metadata?: unknown;
Type: unknown
minimumSequenceNumber
The minimum sequence number for all connected clients.
This API is provided as an alpha preview and may change without notice.
To use, import via fluid-framework/alpha.
For more information about our API support guarantees, see here .
Signature
minimumSequenceNumber: number;
Type: number
origin
Origin branch information for the message.
This API is provided as an alpha preview and may change without notice.
To use, import via fluid-framework/alpha.
For more information about our API support guarantees, see here .
Signature
origin?: IBranchOrigin;
Type: IBranchOrigin
Remarks
Can be marked undefined if the current message is also the origin.
referenceSequenceNumber
The reference sequence number the message was sent relative to.
This API is provided as an alpha preview and may change without notice.
To use, import via fluid-framework/alpha.
For more information about our API support guarantees, see here .
Signature
referenceSequenceNumber: number;
Type: number
sequenceNumber
The sequenced identifier.
This API is provided as an alpha preview and may change without notice.
To use, import via fluid-framework/alpha.
For more information about our API support guarantees, see here .
Signature
sequenceNumber: number;
Type: number
serverMetadata
Server provided metadata about the operation.
This API is provided as an alpha preview and may change without notice.
To use, import via fluid-framework/alpha.
For more information about our API support guarantees, see here .
Signature
serverMetadata?: unknown;
Type: unknown
timestamp
Timestamp when the server ticketed the message.
This API is provided as an alpha preview and may change without notice.
To use, import via fluid-framework/alpha.
For more information about our API support guarantees, see here .
Signature
timestamp: number;
Type: number
traces
Traces related to the packet.
This API is provided as an alpha preview and may change without notice.
To use, import via fluid-framework/alpha.
For more information about our API support guarantees, see here .
Signature
traces?: ITrace[];
Type: ITrace []
type
The type of operation.
This API is provided as an alpha preview and may change without notice.
To use, import via fluid-framework/alpha.
For more information about our API support guarantees, see here .
Signature
type: string;
Type: string