IConnected Interface

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

The client who is sending the message

Signature:

clientId: string;

existing

Whether or not this is an existing document

Signature:

existing: boolean;

initialClients

Prior clients already connected.

Signature:

initialClients: ISignalClient[];

initialContents

Contents sent during the connection

Signature:

initialContents: IContentMessage[];

initialMessages

Messages sent during the connection

Signature:

initialMessages: ISequencedDocumentMessage[];

initialSignals

Signals sent during the connection

Signature:

initialSignals: ISignalMessage[];

maxMessageSize

Maximum size of a message before chunking is required

Signature:

maxMessageSize: number;

mode

Connection mode of client.

Signature:

mode: ConnectionMode;

nonce

An optional nonce used during connection to identify connection attempts

Signature:

nonce?: string;

parentBranch

The parent branch for the document

Signature:

parentBranch: string | null;

serviceConfiguration

Configuration details provided by the service

Signature:

serviceConfiguration: IServiceConfiguration;

supportedVersions

List of protocol versions supported by the server

Signature:

supportedVersions: string[];

version

Protocol version selected by the server to communicate with the client

Signature:

version: string;