Packages > @fluidframework/protocol-definitions > ISequencedDocumentMessage
ISequencedDocumentMessage Interface
Sequenced message for a distributed document.
Signature
export interface ISequencedDocumentMessage
Properties
| Property | Alerts | Modifiers | Type | Description |
|---|---|---|---|---|
| clientId | string | null | The client ID that submitted the message. For server generated messages the clientId will be null; | ||
| clientSequenceNumber | number | The document's client sequence number. | ||
| compression |
DEPRECATED
|
optional
|
string | The compression algorithm that was used to compress contents of this message. |
| contents | unknown | The contents of the message. | ||
| data |
optional
|
string | Data provided by service. Only present in service generated messages. | |
| expHash1 |
DEPRECATED
|
optional
|
string | Experimental field for storing the rolling hash at sequence number. |
| metadata |
optional
|
unknown | App provided metadata about the operation. | |
| minimumSequenceNumber | number | The minimum sequence number for all connected clients. | ||
| origin |
optional
|
IBranchOrigin | Origin branch information for the message. | |
| referenceSequenceNumber | number | The reference sequence number the message was sent relative to. | ||
| sequenceNumber | number | The sequenced identifier. | ||
| serverMetadata |
optional
|
unknown | Server provided metadata about the operation. | |
| timestamp | number | Timestamp when the server ticketed the message. | ||
| traces |
optional
|
ITrace[] | Traces related to the packet. | |
| type | string | The type of operation. |
Property Details
clientId
The client ID that submitted the message. For server generated messages the clientId will be null;
Signature
clientId: string | null;
clientSequenceNumber
The document’s client sequence number.
Signature
clientSequenceNumber: number;
compression
The compression algorithm that was used to compress contents of this message.
API This
Use ISequencedDocumentMessageExperimental instead.
Signature
compression?: string;
contents
The contents of the message.
Signature
contents: unknown;
data
Data provided by service. Only present in service generated messages.
Signature
data?: string;
expHash1
Experimental field for storing the rolling hash at sequence number.
API This
Use ISequencedDocumentMessageExperimental instead.
Signature
expHash1?: string;
metadata
App provided metadata about the operation.
Signature
metadata?: unknown;
minimumSequenceNumber
The minimum sequence number for all connected clients.
Signature
minimumSequenceNumber: number;
origin
Origin branch information for the message.
Signature
origin?: 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.
Signature
referenceSequenceNumber: number;
sequenceNumber
The sequenced identifier.
Signature
sequenceNumber: number;
serverMetadata
Server provided metadata about the operation.
Signature
serverMetadata?: unknown;
timestamp
Timestamp when the server ticketed the message.
Signature
timestamp: number;
traces
Traces related to the packet.
Signature
traces?: ITrace[];
type
The type of operation.
Signature
type: string;