IDocumentDeltaConnection Interface

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 IDocumentDeltaConnection extends IDisposable, IEventProvider<IDocumentDeltaConnectionEvents>

Extends: IDisposable, IEventProvider<IDocumentDeltaConnectionEvents>

Properties

Property	Alerts	Modifiers	Type	Description
checkpointSequenceNumber	Beta	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	Beta		ITokenClaims	Claims for the client
clientId	Beta		string	ClientID for the connection
existing	Beta		boolean	Whether the connection was made to a new or existing document
initialClients	Beta		ISignalClient[]	Prior clients already connected.
initialMessages	Beta		ISequencedDocumentMessage[]	Messages sent during the connection
initialSignals	Beta		ISignalMessage[]	Signals sent during the connection
mode	Beta		ConnectionMode	Mode of the client
relayServiceAgent	Beta	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	Beta		IClientConfiguration	Configuration details provided by the service
submitSignal	Beta		(content: string, targetClientId?: string) => void	Submits a new signal to the server
version	Beta		string	Protocol version being used with the service

Methods

Method	Alerts	Return Type	Description
submit(messages)	Beta	void	Submit a new message 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.

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

checkpointSequenceNumber?: number;

Type: number

claims

Claims for the client

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

claims: ITokenClaims;

Type: ITokenClaims

clientId

ClientID for the connection

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

clientId: string;

Type: string

existing

Whether the connection was made to a new or existing document

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

existing: boolean;

Type: boolean

initialClients

Prior clients already connected.

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

initialClients: ISignalClient[];

Type: ISignalClient[]

initialMessages

Messages sent during the connection

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

initialMessages: ISequencedDocumentMessage[];

Type: ISequencedDocumentMessage[]

initialSignals

Signals sent during the connection

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

initialSignals: ISignalMessage[];

Type: ISignalMessage[]

mode

Mode of the client

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

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"

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

relayServiceAgent?: string;

Type: string

serviceConfiguration

Configuration details provided by the service

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

serviceConfiguration: IClientConfiguration;

Type: IClientConfiguration

submitSignal

Submits a new signal to the server

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

submitSignal: (content: string, targetClientId?: string) => void;

Type: (content: string, targetClientId?: string) => void

version

Protocol version being used with the service

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

version: string;

Type: string

Method Details

submit

Submit a new message to the server

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

submit(messages: IDocumentMessage[]): void;

Parameters

Parameter	Type	Description
messages	IDocumentMessage[]