IConnect Interface

Message sent to connect to the given document.

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 IConnect

Properties

Property	Alerts	Modifiers	Type	Description
client	Beta		IClient	Type of the client trying to connect
driverVersion	Beta	optional	string	Version of the driver which is connecting. It can be used at server to record in telemetry or to block/allow specific driver version for specific features.
epoch	Beta	optional	string	Represents the version of document at client. It should match the version on server for connection to be successful.
id	Beta		string	The document that is being connected to
mode	Beta		ConnectionMode	Connection mode of client.
nonce	Beta	optional	string	An optional nonce used during connection to identify connection attempts
relayUserAgent	Beta	optional	string	Properties that client can send to server to tell info about client environment. These are a bunch of properties separated by ";" which server can log to better understand client environment etc. Format: "prop1:val1;prop2:val2;prop3:val3"
supportedFeatures	Beta	optional	Record<string, unknown>	A list of optional features that client supports. Features supported might be service specific. If we have standardized features across all services, they need to be exposed in more structured way.
tenantId	Beta		string	The tenant ID for the document.
token	Beta		string | null	Authorization token
versions	Beta		string[]	Semver list of protocol versions supported by the client ordered in priority of use

Property Details

client

Type of the client trying to connect

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

client: IClient;

Type: IClient

driverVersion

Version of the driver which is connecting. It can be used at server to record in telemetry or to block/allow specific driver version for specific features.

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

driverVersion?: string;

Type: string

epoch

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

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

id

The document that is being connected to

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

id: string;

Type: string

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

relayUserAgent

Properties that client can send to server to tell info about client environment. These are a bunch of properties separated by ";" which server can log to better understand client environment etc. 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

relayUserAgent?: string;

Type: string

supportedFeatures

A list of optional features that client 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>

tenantId

The tenant ID for the 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

tenantId: string;

Type: string

token

Authorization token

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

token: string | null;

Type: string | null

versions

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

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

versions: string[];

Type: string[]