IDocumentMessage Interface

Document-specific message.

Signature

export interface IDocumentMessage

Property	Modifiers	Type	Description
clientSequenceNumber		number	The document's client sequence number.
compression	`optional`	string	The compression algorithm that was used to compress contents of this message. Not ready for use
contents		unknown	The contents of the message.
metadata	`optional`	unknown	App provided metadata about the operation.
referenceSequenceNumber		number	The reference sequence number the message was sent relative to.
serverMetadata	`optional`	unknown	Server provided metadata about the operation.
traces	`optional`	ITrace[]	Traces related to the packet.
type		string	The type of document message being sent.

The document’s client sequence number.

clientSequenceNumber: number;

The compression algorithm that was used to compress contents of this message. Not ready for use

compression?: string;

The contents of the message.

contents: unknown;

App provided metadata about the operation.

metadata?: unknown;

The reference sequence number the message was sent relative to.

referenceSequenceNumber: number;

Server provided metadata about the operation.

serverMetadata?: unknown;

Traces related to the packet.

traces?: ITrace[];

The type of document message being sent.

type: string;