IConnected Interface

Message sent to indicate a client has connected to the server.

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 IConnected

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	The client who is sending the message
epoch	Beta	optional	string	Represents the version of document at server.
existing	Beta		boolean	Whether or not this is an 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
maxMessageSize	Beta		number	Maximum size of a message before chunking is required
mode	Beta		ConnectionMode	Connection mode of client.
nonce	Beta	optional	string	An optional nonce used during connection to identify connection attempts
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
supportedFeatures	Beta	optional	Record<string, unknown>	A list of optional features that ordering service supports. Features supported might be service specific. If we have standardized features across all services, they need to be exposed in more structured way.
supportedVersions	Beta		string[]	List of protocol versions supported by the server
timestamp	Beta	optional	number	The time the client connected
version	Beta		string	Protocol version selected by the server to communicate with the client

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

The client who is sending the message

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

epoch

Represents the version of document at 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

epoch?: string;

Type: string

existing

Whether or not this is an 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[]

maxMessageSize

Maximum size of a message before chunking is required

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

maxMessageSize: number;

Type: number

mode

Connection mode of 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

nonce

An optional nonce used during connection to identify connection attempts

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

nonce?: string;

Type: string

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

supportedFeatures

A list of optional features that ordering service supports. Features supported might be service specific. If we have standardized features across all services, they need to be exposed in more structured way.

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

supportedFeatures?: Record<string, unknown>;

Type: Record<string, unknown>

supportedVersions

List of protocol versions supported by 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

supportedVersions: string[];

Type: string[]

timestamp

The time the client 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

timestamp?: number;

Type: number

version

Protocol version selected by the server to communicate with 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

version: string;

Type: string