IDocumentMessage Interface

Document-specific message.

This API is provided for existing users, but is not recommended for new users.

To use, import via @fluidframework/driver-definitions/legacy.

For more information about our API support guarantees, see here.

Signature

export interface IDocumentMessage

Properties

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

Property Details

clientSequenceNumber

The document's client sequence number.

This API is provided for existing users, but is not recommended for new users.

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. Not ready for use

This API is provided for existing users, but is not recommended for new users.

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 for existing users, but is not recommended for new users.

For more information about our API support guarantees, see here.

Signature

contents: unknown;

Type: unknown

metadata

App provided metadata about the operation.

This API is provided for existing users, but is not recommended for new users.

For more information about our API support guarantees, see here.

Signature

metadata?: unknown;

Type: unknown

referenceSequenceNumber

The reference sequence number the message was sent relative to.

This API is provided for existing users, but is not recommended for new users.

For more information about our API support guarantees, see here.

Signature

referenceSequenceNumber: number;

Type: number

serverMetadata

Server provided metadata about the operation.

This API is provided for existing users, but is not recommended for new users.

For more information about our API support guarantees, see here.

Signature

serverMetadata?: unknown;

Type: unknown

traces

Traces related to the packet.

This API is provided for existing users, but is not recommended for new users.

For more information about our API support guarantees, see here.

Signature

traces?: ITrace[];

Type: ITrace[]

type

The type of document message being sent.

This API is provided for existing users, but is not recommended for new users.

For more information about our API support guarantees, see here.

Signature

type: string;

Type: string