[]
        
(Showing Draft Content)

Client

Class: Client

Represents a collaboration client for bidirectional communication with the server.

Table of contents

Constructors

Accessors

Methods

Constructors

constructor

new Client(url?, options?)

Creates a new collaboration client instance.

Parameters

Name Type
url? string
options? IClientOptions

Accessors

url

get url(): string

Retrieves the server URL of the client.

Returns

string

Methods

connect

connect(roomId, options?): Connection

Establishes a connection to a specified room.

Parameters

Name Type Description
roomId string The ID of the room to connect to.
options? IConnectOptions -

Returns

Connection

  • A new connection instance.