IConnect Interface

Packages > @fluidframework/protocol-definitions > IConnect

Message sent to connect to the given document

Signature:

export interface IConnect 

Properties

List of properties of this interface
Property Type Description
client IClient Type of the client trying to connect
epoch string Represents the version of document at client. It should match the version on server for connection to be successful.
id string The document that is being connected to
mode ConnectionMode Connection mode of client.
nonce string An optional nonce used during connection to identify connection attempts
tenantId string The tenant ID for the document
token string | null Authorization token
versions string[] Semver list of protocol versions supported by the client ordered in priority of use

Events

client

Type of the client trying to connect

Signature:

client: IClient;

epoch

Represents the version of document at client. It should match the version on server for connection to be successful.

Signature:

epoch?: string;

id

The document that is being connected to

Signature:

id: string;

mode

Connection mode of client.

Signature:

mode: ConnectionMode;

nonce

An optional nonce used during connection to identify connection attempts

Signature:

nonce?: string;

tenantId

The tenant ID for the document

Signature:

tenantId: string;

token

Authorization token

Signature:

token: string | null;

versions

Semver list of protocol versions supported by the client ordered in priority of use

Signature:

versions: string[];