Skip to content

Add ChatClient.dispose() documentation #3177

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
AndyTWF wants to merge 1 commit into
base: main
Choose a base branch
from
Draft

Add ChatClient.dispose() documentation #3177

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
37 changes: 37 additions & 0 deletions src/pages/docs/chat/setup.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -330,3 +330,40 @@ The `logLevel` sets the verbosity of logs that will be output by the SDK. The fo
| `error` | A given operation has failed and cannot be automatically recovered. The error may threaten the continuity of operation. |
| `silent` | No logging will be performed. |

## Dispose of the client <a id="dispose"/>

Use the <If lang="javascript,react">[`dispose()`](https://sdk.ably.com/builds/ably/ably-chat-js/main/typedoc/interfaces/chat-js.ChatClient.html#dispose)</If><If lang="swift">[`dispose()`](https://sdk.ably.com/builds/ably/ably-chat-swift/main/AblyChat/documentation/ablychat/chatclient/dispose%28%29)</If><If lang="kotlin,jetpack">[`dispose()`](https://sdk.ably.com/builds/ably/ably-chat-kotlin/main/dokka/chat/com.ably.chat/-chat-client/dispose.html)</If> method to release all resources associated with the chat client when you are done using it:

<Code>
```javascript
await chatClient.dispose();
```

```react
await chatClient.dispose();
```

```swift
await chatClient.dispose()
```

```kotlin
chatClient.dispose()
```

```jetpack
chatClient.dispose()
```
</Code>

Calling `dispose()` will:
- Release all rooms managed by the client
- Clean up connection listeners and timers
- Free internal resources

After calling `dispose()`, the client should not be used. Attempting to get a room after dispose has been called will throw an error. This method is idempotent, so calling it multiple times has no additional effect.

<Aside data-type='note'>
The `dispose()` method does not close the underlying Ably Realtime connection, as that connection is owned by the Pub/Sub client that was passed to the Chat client during instantiation. To close the connection, call `close()` on the Pub/Sub client directly.
</Aside>