Class ChatClient

This is the core client for Ably chat. It provides access to chat rooms.

Index

Constructors

Accessors

clientId clientOptions connection realtime rooms

Methods

Constructors

constructor

new ChatClient(
realtime: Realtime,
clientOptions?: ChatClientOptions,
): ChatClient
Constructor for Chat
Parameters
- realtime: Realtime
  The Ably Realtime client.
- OptionalclientOptions: ChatClientOptions
  The client options.
Returns ChatClient
- Defined in src/core/chat-client.ts:50

Accessors

clientId

get clientId(): string
Returns the clientId of the current client.

Returns string
The clientId.
- Defined in src/core/chat-client.ts:85

clientOptions

get clientOptions(): ChatClientOptions
Returns the resolved client options for the client, including any defaults that have been set.

Returns ChatClientOptions
The client options.
- Defined in src/core/chat-client.ts:101

connection

get connection(): Connection
Returns the underlying connection to Ably, which can be used to monitor the client's connection to Ably servers.

Returns Connection
The connection object.
- Defined in src/core/chat-client.ts:77

realtime

get realtime(): Realtime
Returns the underlying Ably Realtime client.

Returns Realtime
The Ably Realtime client.
- Defined in src/core/chat-client.ts:93

rooms

get rooms(): Rooms
Returns the rooms object, which provides access to chat rooms.

Returns Rooms
The rooms object.
- Defined in src/core/chat-client.ts:68

Methods

dispose

dispose(): Promise<void>
Disposes of the ChatClient instance, cleaning up any resources and rendering it unusable. This method will release all rooms before disposing of the client.

Returns Promise<void>
- Defined in src/core/chat-client.ts:140