Edit

Share via

BreakoutRoom interface

  • Reference
Package:
@azure/communication-calling

Note

This API is in Beta and provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.

Breakout room details

Properties

autoMoveParticipantToBreakoutRoom

Automatically move people to breakout rooms when they join
call

breakout room call object when the participant joins the breakout room
displayName

display name of the breakout room
invitees

the list of invitees who are assigned to a breakout room
state

state of the breakout room
threadId

threadId of the breakout room

Methods

join()

allows the participant to join the breakout room when Automove people to rooms is set to false.

Property Details

autoMoveParticipantToBreakoutRoom

Automatically move people to breakout rooms when they join

autoMoveParticipantToBreakoutRoom?: boolean

Property Value

boolean

call

breakout room call object when the participant joins the breakout room

call?: Call | TeamsCall

Property Value

Call | TeamsCall

displayName

display name of the breakout room

displayName?: string

Property Value

string

invitees

the list of invitees who are assigned to a breakout room

invitees?: Invitee[]

Property Value

Invitee[]

state

state of the breakout room

state: BreakoutRoomState

Property Value

BreakoutRoomState

threadId

threadId of the breakout room

threadId: string

Property Value

string

Method Details

join()

allows the participant to join the breakout room when Automove people to rooms is set to false.

function join(): Promise<Call | TeamsCall>

Returns

Promise<Call | TeamsCall>