Skip to main content
Version: v1

IConnect Interface

Message sent to connect to the given document

Signature​

export interface IConnect

Properties​

Property Modifiers Type Description
client IClient Type of the client trying to connect
epoch optional 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 optional string An optional nonce used during connection to identify connection attempts
relayUserAgent 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 optional Record<string, any> 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 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

Property Details​

client​

Type of the client trying to connect

Signature​

client: IClient;

Type: IClient

epoch​

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

Signature​

epoch?: string;

Type: string

id​

The document that is being connected to

Signature​

id: string;

Type: string

mode​

Connection mode of client.

Signature​

mode: ConnectionMode;

Type: ConnectionMode

nonce​

An optional nonce used during connection to identify connection attempts

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"

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.

Signature​

supportedFeatures?: Record<string, any>;

Type: Record<string, any>

tenantId​

The tenant ID for the document

Signature​

tenantId: string;

Type: string

token​

Authorization token

Signature​

token: string | null;

Type: string | null

versions​

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

Signature​

versions: string[];

Type: string[]