Skip to main content

IConnectionDetails Interface

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

This API is provided for existing users, but is not recommended for new users.

To use, import via @fluidframework/container-definitions/legacy.

For more information about our API support guarantees, see here.

Signature​

export interface IConnectionDetails

Properties​

Property Alerts Type Description
checkpointSequenceNumber Alpha number | undefined Last known sequence number to ordering service at the time of connection.
claims Alpha ITokenClaims
clientId Alpha string The client's unique identifier assigned by the service.
serviceConfiguration Alpha IClientConfiguration

Property Details​

checkpointSequenceNumber​

Last known sequence number to ordering service at the time of connection.

This API is provided as an alpha preview and may change without notice.

To use, import via @fluidframework/container-definitions/alpha.

For more information about our API support guarantees, see here.

Signature​

checkpointSequenceNumber: number | undefined;

Type: number | undefined

Remarks​

It may lag behind the actual last sequence number (quite a bit, if the container is very active), but it's the best information the client has to figure out how far behind it is, at least for "read" connections. "write" connections may use the client's own "join" op to obtain similar information which is likely to be more up-to-date.

claims​

This API is provided as an alpha preview and may change without notice.

To use, import via @fluidframework/container-definitions/alpha.

For more information about our API support guarantees, see here.

Signature​

claims: ITokenClaims;

Type: ITokenClaims

clientId​

The client's unique identifier assigned by the service.

This API is provided as an alpha preview and may change without notice.

To use, import via @fluidframework/container-definitions/alpha.

For more information about our API support guarantees, see here.

Signature​

clientId: string;

Type: string

Remarks​

It is not stable across reconnections.

serviceConfiguration​

This API is provided as an alpha preview and may change without notice.

To use, import via @fluidframework/container-definitions/alpha.

For more information about our API support guarantees, see here.

Signature​

serviceConfiguration: IClientConfiguration;

Type: IClientConfiguration