You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: src/pages/docs/chat/rooms/index.mdx
+5-5Lines changed: 5 additions & 5 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -16,7 +16,7 @@ The channel name is the same as the room name with an appended suffix of `::$cha
16
16
Users send messages to a room and subscribe to the room in order to receive messages.
17
17
18
18
<Iflang="javascript,swift,kotlin">
19
-
A `room` is created, or an existing one is retrieved from the `rooms` collection using the <Iflang="javascript">[`rooms.get()`](https://sdk.ably.com/builds/ably/ably-chat-js/main/typedoc/interfaces/chat-js.Rooms.html#get)</If><Iflang="swift">[`rooms.get()`](https://sdk.ably.com/builds/ably/ably-chat-swift/main/AblyChat/documentation/ablychat/rooms/get%28roomid%3Aoptions%3A%29)</If><Iflang="kotlin">[`rooms.get()`](https://sdk.ably.com/builds/ably/ably-chat-kotlin/main/dokka/chat-android/com.ably.chat/-rooms/get.html)</If> method:
19
+
A `room` is created, or an existing one is retrieved from the `rooms` collection using the <Iflang="javascript">[`rooms.get()`](https://sdk.ably.com/builds/ably/ably-chat-js/main/typedoc/interfaces/chat-js.Rooms.html#get)</If><Iflang="swift">[`rooms.get()`](https://sdk.ably.com/builds/ably/ably-chat-swift/main/AblyChat/documentation/ablychat/rooms/get%28named%3Aoptions%3A%29)</If><Iflang="kotlin">[`rooms.get()`](https://sdk.ably.com/builds/ably/ably-chat-kotlin/main/dokka/chat-android/com.ably.chat/-rooms/get.html)</If> method:
20
20
</If>
21
21
22
22
<Iflang="react">
@@ -57,7 +57,7 @@ const App = () => {
57
57
```
58
58
59
59
```swift
60
-
let room =tryawait chatClient.rooms.get(roomID: "basketball-stream", options: .init(occupancy: .init(enableEvents: true)))
60
+
let room =tryawait chatClient.rooms.get(named: "basketball-stream", options: .init(occupancy: .init(enableEvents: true)))
61
61
```
62
62
63
63
```kotlin
@@ -97,7 +97,7 @@ let presence = PresenceOptions(enter: false)
97
97
let typing =TypingOptions(heartbeatThrottle: 5.0) // seconds
98
98
// using defaults for reactions and occupancy
99
99
let options =RoomOptions(presence: presence, typing: typing, occupancy: .init())
100
-
let room =tryawait chatClient.rooms.get(roomID: "basketball-stream", options: options)
100
+
let room =tryawait chatClient.rooms.get(named: "basketball-stream", options: options)
101
101
```
102
102
103
103
```kotlin
@@ -132,15 +132,15 @@ Releasing a room allows the underlying resources to be garbage collected or rele
132
132
Releasing a room may be optional for many applications. If you have multiple transient rooms, such as in the case of a 1:1 support chat, then it may be more beneficial. Also, proactively disconnecting rather than waiting for the standard two-minute timeout can help reduce costs and improve performance.
133
133
134
134
<Iflang="javascript,swift,kotlin">
135
-
Once <Iflang="javascript">[`rooms.release()`](https://sdk.ably.com/builds/ably/ably-chat-js/main/typedoc/interfaces/chat-js.Rooms.html#release)</If><Iflang="swift">[`rooms.release()`](https://sdk.ably.com/builds/ably/ably-chat-swift/main/AblyChat/documentation/ablychat/rooms/release%28roomid%3A%29)</If><Iflang="kotlin">[`rooms.release()`](https://sdk.ably.com/builds/ably/ably-chat-kotlin/main/dokka/chat-android/com.ably.chat/-rooms/release.html)</If> has been called, the room will be unusable and a new instance will need to be created using [`rooms.get()`](#create) if you want to reuse it.
135
+
Once <Iflang="javascript">[`rooms.release()`](https://sdk.ably.com/builds/ably/ably-chat-js/main/typedoc/interfaces/chat-js.Rooms.html#release)</If><Iflang="swift">[`rooms.release()`](https://sdk.ably.com/builds/ably/ably-chat-swift/main/AblyChat/documentation/ablychat/rooms/release%28named%3A%29)</If><Iflang="kotlin">[`rooms.release()`](https://sdk.ably.com/builds/ably/ably-chat-kotlin/main/dokka/chat-android/com.ably.chat/-rooms/release.html)</If> has been called, the room will be unusable and a new instance will need to be created using [`rooms.get()`](#create) if you want to reuse it.
0 commit comments