IDocumentDeltaConnection Interface

Signature

export interface IDocumentDeltaConnection extends IDisposable, IEventProvider<IDocumentDeltaConnectionEvents>

Extends: IDisposable, IEventProvider<IDocumentDeltaConnectionEvents

Properties

Property	Modifiers	Type	Description
checkpointSequenceNumber	optional	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
mode		ConnectionMode	Mode of the client
relayServiceAgent	optional	string	Properties that server can send to client to tell info about node that client is connected to. For ex, for spo it could contain info like build version, environment, region etc. These properties can be logged by client to better understand server environment etc. and use it in case error occurs. Format: "prop1:val1;prop2:val2;prop3:val3"
serviceConfiguration		IClientConfiguration	Configuration details provided by the service
version		string	Protocol version being used with the service

Methods

Method	Return Type	Description
submit(messages)	void	Submit a new message to the server
submitSignal(message)	void	Submit a new signal to the server

Property Details

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;

Type: number

claims

Claims for the client

Signature

claims: ITokenClaims;

Type: ITokenClaims

clientId

ClientID for the connection

Signature

clientId: string;

Type: string

existing

Whether the connection was made to a new or existing document

Signature

existing: boolean;

Type: boolean

initialClients

Prior clients already connected.

Signature

initialClients: ISignalClient[];

Type: ISignalClient[]

initialMessages

Messages sent during the connection

Signature

initialMessages: ISequencedDocumentMessage[];

Type: ISequencedDocumentMessage[]

initialSignals

Signals sent during the connection

Signature

initialSignals: ISignalMessage[];

Type: ISignalMessage[]

mode

Mode of the client

Signature

mode: ConnectionMode;

Type: ConnectionMode

relayServiceAgent

Properties that server can send to client to tell info about node that client is connected to. For ex, for spo it could contain info like build version, environment, region etc. These properties can be logged by client to better understand server environment etc. and use it in case error occurs. Format: "prop1:val1;prop2:val2;prop3:val3"

Signature

relayServiceAgent?: string;

Type: string

serviceConfiguration

Configuration details provided by the service

Signature

serviceConfiguration: IClientConfiguration;

Type: IClientConfiguration

version

Protocol version being used with the service

Signature

version: string;

Type: string

Method Details

submit

Submit a new message to the server

Signature

submit(messages: IDocumentMessage[]): void;

Parameters

Parameter	Type	Description
messages	IDocumentMessage[]

submitSignal

Submit a new signal to the server

Signature

submitSignal(message: any): void;

Parameters

Parameter	Type	Description
message	any