Interface RoomOption

Room creation options.

interface RoomOption {
    isAutoJoinRoom?: boolean;
    isBackToMainSessionEnabled?: boolean;
    isTimerEnabled?: boolean;
    needCountDown?: boolean;
    notNotifyMe?: boolean;
    timerDuration?: number;
    waitSeconds?: number;
}

Properties

Optional isAutoJoinRoom

isAutoJoinRoom?: boolean

Whether to automatically join the room when the participant is assigned to a room.

Optional isBackToMainSessionEnabled

isBackToMainSessionEnabled?: boolean

Whether to allow participants in the room to return to the main session.

Optional isTimerEnabled

isTimerEnabled?: boolean

Whether to set a timer for the breakout room.

Optional needCountDown

needCountDown?: boolean

Whether to offer a countdown after closing the breakout room.

Optional notNotifyMe

notNotifyMe?: boolean

Whether to notify the user when the time is up. True: Do not notify. False: Notify.

Optional timerDuration

timerDuration?: number

Duration of the timer.

Optional waitSeconds

waitSeconds?: number

When the breakout room is closing, the buffer time (in seconds) to leave the room. Values: 10 | 15 | 30 | 60 | 120.

Settings

Member Visibility

Theme

On This Page

isAutoJoinRoomisBackToMainSessionEnabledisTimerEnabledneedCountDownnotNotifyMetimerDurationwaitSeconds