IDocumentDeltaConnection Interface

Packages > @fluidframework/driver-definitions > IDocumentDeltaConnection

Signature:

export interface IDocumentDeltaConnection extends IEventProvider<IDocumentDeltaConnectionEvents> 

Extends: IEventProvider<IDocumentDeltaConnectionEvents>

Properties

List of properties of this interface
Property Type Description
checkpointSequenceNumber number Last known sequence number to ordering service at the time of connection It may lap actual last sequence number (quite a bit, if container is very active). But it's best information for client to figure out how far it is behind, at least for "read" connections. "write" connections may use own "join" op to similar information, that is likely to be more up-to-date.
claims ITokenClaims Claims for the client
clientId string ClientID for the connection
existing boolean Whether the connection was made to a new or existing document
initialClients ISignalClient[] Prior clients already connected.
initialMessages ISequencedDocumentMessage[] Messages sent during the connection
initialSignals ISignalMessage[] Signals sent during the connection
maxMessageSize number Maximum size of a message that can be sent to the server. Messages larger than this size must be chunked.
mode ConnectionMode Mode of the client
serviceConfiguration IClientConfiguration Configuration details provided by the service
version string Protocol version being used with the service

Methods

List of methods of this class
Method Description
close() Disconnects the given delta connection
submit(messages) Submit a new message to the server
submitSignal(message) Submit a new signal to the server

Events

checkpointSequenceNumber

Last known sequence number to ordering service at the time of connection It may lap actual last sequence number (quite a bit, if container is very active). But it’s best information for client to figure out how far it is behind, at least for “read” connections. “write” connections may use own “join” op to similar information, that is likely to be more up-to-date.

Signature:

checkpointSequenceNumber?: number;

claims

Claims for the client

Signature:

claims: ITokenClaims;

clientId

ClientID for the connection

Signature:

clientId: string;

existing

Whether the connection was made to a new or existing document

Signature:

existing: boolean;

initialClients

Prior clients already connected.

Signature:

initialClients: ISignalClient[];

initialMessages

Messages sent during the connection

Signature:

initialMessages: ISequencedDocumentMessage[];

initialSignals

Signals sent during the connection

Signature:

initialSignals: ISignalMessage[];

maxMessageSize

Maximum size of a message that can be sent to the server. Messages larger than this size must be chunked.

Signature:

maxMessageSize: number;

mode

Mode of the client

Signature:

mode: ConnectionMode;

serviceConfiguration

Configuration details provided by the service

Signature:

serviceConfiguration: IClientConfiguration;

version

Protocol version being used with the service

Signature:

version: string;

Methods

close

Disconnects the given delta connection

Signature:

close(): void;

Returns:

void

submit

Submit a new message to the server

Signature:

submit(messages: IDocumentMessage[]): void;

Parameters

List of parameters
Parameter Type Description
messages IDocumentMessage[]

Returns:

void

submitSignal

Submit a new signal to the server

Signature:

submitSignal(message: any): void;

Parameters

List of parameters
Parameter Type Description
message any

Returns:

void