Skip to content 

IConnectionDetails Interface

Packages > @fluidframework/container-definitions > IConnectionDetails

Contract representing the result of a newly established connection to the server for syncing deltas

Signature:

export interface IConnectionDetails 

Properties

List of properties of this interface
Property Type Description
checkpointSequenceNumber number | undefined 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
clientId string
existing boolean
initialClients ISignalClient[]
initialContents IContentMessage[]
initialMessages ISequencedDocumentMessage[]
initialSignals ISignalMessage[]
maxMessageSize number
mode ConnectionMode
parentBranch string | null
serviceConfiguration IServiceConfiguration
version string

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 | undefined;

claims

Signature:

claims: ITokenClaims;

clientId

Signature:

clientId: string;

existing

Signature:

existing: boolean;

initialClients

Signature:

initialClients: ISignalClient[];

initialContents

Signature:

initialContents: IContentMessage[];

initialMessages

Signature:

initialMessages: ISequencedDocumentMessage[];

initialSignals

Signature:

initialSignals: ISignalMessage[];

maxMessageSize

Signature:

maxMessageSize: number;

mode

Signature:

mode: ConnectionMode;

parentBranch

Signature:

parentBranch: string | null;

serviceConfiguration

Signature:

serviceConfiguration: IServiceConfiguration;

version

Signature:

version: string;