IConnection Interface

Base interface for information for each connection made to the Fluid session.

Signature

export interface IConnection

Remarks

This interface can be extended to provide additional information specific to each service.

Properties

Property	Modifiers	Type	Description
id	readonly	string	A unique ID for the connection. A single user may have multiple connections, each with a different ID.
mode	readonly	"write" | "read"	Whether the connection is in read or read/write mode.

Property Details

id

A unique ID for the connection. A single user may have multiple connections, each with a different ID.

Signature

readonly id: string;

Type: string

mode

Whether the connection is in read or read/write mode.

Signature

readonly mode: "write" | "read";

Type: "write" | "read"