Skip to content

Commit 9137c7a

Browse files
committed
Update breakoutrooms-web.md
Consolidated settings in a table
1 parent bd1ee9b commit 9137c7a

File tree

1 file changed

+18
-35
lines changed

1 file changed

+18
-35
lines changed

articles/communication-services/how-tos/calling-sdk/includes/breakoutrooms/breakoutrooms-web.md

Lines changed: 18 additions & 35 deletions
Original file line numberDiff line numberDiff line change
@@ -197,61 +197,44 @@ Use the following code to stop receiving breakoutRooms events.
197197
```js
198198
breakoutRoomsFeature.off('breakoutRoomsUpdated', breakoutRoomsUpdatedListener);
199199
```
200-
### Breakout room properties
200+
### Breakout room properties
201201

202202
Breakout rooms have the following properties:
203203

204-
```js
205-
const displayName : string = breakoutRoom.displayName;
206-
```
207-
208-
- `displayName` : Name of the breakout room. This property is read-only.
204+
> [Note:]
205+
> The following sample code efficiently displays all breakout room properties. It is not intended to be reused as shown. In practice you only use the properties needed for your breakout room scenario.
209206
210207
```js
208+
const displayName : string = breakoutRoom.displayName;
211209
const threadId : string = breakoutRoom.threadId;
212-
```
213-
214-
- `threadId` : You can use chat thread ID to join chat of the breakout room. This property is read-only.
215-
216-
```js
217210
const state : BreakoutRoomState = breakoutRoom.state;
218-
```
219-
220-
- `state` : State of the breakout room. It can be either `open` or `closed`. Users would be able to join the breakout room only when the state is `open`. This property is read-only.
221-
222-
```js
223-
const autoMoveParticipantToBreakoutRoom : boolean = breakoutRoom.autoMoveParticipantToBreakoutRoom;
224-
```
225-
226-
- `autoMoveParticipantToBreakoutRoom` : Boolean value, which indicates whether the users are moved to breakout rooms automatically when the `state` of `assignedBreakoutRoom` is set to `open`. This property is read-only. In the Teams UI settings for breakout rooms, the organizer, co-organizer, or breakout room manager can adjust this specific setting. By setting this option to `true`, participants are automatically transferred to their designated breakout room. Conversely, if you set this property to `false`, then you must manually call the `join` method to move participants into the breakout room.
227-
228-
```js
211+
const autoMoveParticipantToBreakoutRoom : boolean = breakoutRoom.autoMoveParticipantToBreakoutRoom;
229212
const call : Call | TeamsCall = breakoutRoom.call;
230-
```
231-
232-
- `call` : Breakout room call object. This object is returned when the user joins the breakout room call automatically or by calling `join` method on `assignedBreakoutRoom` object. This property is read-only.
233-
234-
```js
235213
const invitees : Invitee[] = breakoutRoom.invitees;
236214
```
237215

238-
- `invitees` : The list of invitees who are assigned to the breakout room. This property is read-only.
216+
| Breakout room properties | Description|
217+
| --- | --- |
218+
| `displayName` | Name of the breakout room. This property is read-only. |
219+
| `threadId` | Use the chat thread ID to join chat of the breakout room. This property is read-only. |
220+
| `state` | State of the breakout room. It can be either `open` or `closed`. Users would be able to join the breakout room only when the state is `open`. This property is read-only. |
221+
| `autoMoveParticipantToBreakoutRoom` | Boolean value indicating whether the users are moved to breakout rooms automatically when the `state` of `assignedBreakoutRoom` is set to `open`. This property is read-only. In the Teams UI settings for breakout rooms, the organizer, co-organizer, or breakout room manager can adjust this specific setting. By setting this option to `true`, participants are automatically transferred to their designated breakout room. Conversely, if you set this property to `false`, then you must manually call the `join` method to move participants into the breakout room. |
222+
| `call` | Breakout room call object. This object is returned when the user joins the breakout room call automatically or by calling the `join` method on `assignedBreakoutRoom` object. This property is read-only. |
223+
| `invitees` | The list of invitees who are assigned to the breakout room. This property is read-only. |
239224

240-
### Breakout room settings
225+
### Breakout room settings
241226

242227
Breakout rooms share setting that has the following properties:
243228

244229
```js
245230
const disableReturnToMainMeeting : boolean = breakoutRoomsSettings.disableReturnToMainMeeting;
246-
```
247-
248-
- `disableReturnToMainMeeting` : Disable participants to return to the main meeting from the breakout room call. This property is read-only. In the Teams UI settings for breakout rooms, the organizer, co-organizer, or breakout room manager can adjust this specific setting to control when the participant of breakout rooms can return to the main meeting.
249-
250-
```js
251231
const roomEndTime : TimestampInfo = breakoutRoomsSettings.roomEndTime;
252232
```
253233

254-
- `roomEndTime`: Breakout room end time set by the Microsoft 365 user with role organizer, co-organizer, or breakout room manager of the main meeting. This property is read-only.
234+
| Breakout room properties | Description|
235+
| --- | --- |
236+
| `disableReturnToMainMeeting` | Disable participants to return to the main meeting from the breakout room call. This property is read-only. In the Teams UI settings for breakout rooms, the organizer, co-organizer, or breakout room manager can adjust this specific setting to control when the participant of breakout rooms can return to the main meeting. |
237+
| `roomEndTime` | Breakout room end time set by the Microsoft 365 user with role organizer, co-organizer, or breakout room manager of the main meeting. This property is read-only. |
255238

256239
### Troubleshooting
257240

0 commit comments

Comments
 (0)