IConnectionDetails Interface
Contract representing the result of a newly established connection to the server for syncing deltas.
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 | Beta | number | undefined | Last known sequence number to ordering service at the time of connection. |
| claims | Beta | ITokenClaims | |
| clientId | Beta | string | The client's unique identifier assigned by the service. |
| serviceConfiguration | Beta | IClientConfiguration |
Property Details
checkpointSequenceNumber
Last known sequence number to ordering service at the time of connection.
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
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.
For more information about our API support guarantees, see here.
Signature
clientId: string;
Type: string
Remarks
It is not stable across reconnections.
serviceConfiguration
For more information about our API support guarantees, see here.
Signature
serviceConfiguration: IClientConfiguration;
Type: IClientConfiguration