BreakoutRoomsCallFeature interface

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 rooms call feature.

Extends

CallFeature

Properties

assignedBreakoutRooms
breakoutRooms
breakoutRoomsSettings

Inherited Properties

name	The feature name.

Methods

off("breakoutRoomsUpdated", BreakoutRoomsUpdatedListener)	Subscribe function for BreakoutRooms Updated event
on("breakoutRoomsUpdated", BreakoutRoomsUpdatedListener)	Subscribe function for BreakoutRooms Updated event

Inherited Methods

dispose()

Property Details

assignedBreakoutRooms

assignedBreakoutRooms?: BreakoutRoom

Property Value

BreakoutRoom

breakoutRooms

breakoutRooms?: BreakoutRoom[]

Property Value

BreakoutRoom[]

breakoutRoomsSettings

breakoutRoomsSettings?: BreakoutRoomsSettings

Property Value

BreakoutRoomsSettings

Inherited Property Details

name

The feature name.

name: string

Property Value

string

Inherited From CallFeature.name

Method Details

off("breakoutRoomsUpdated", BreakoutRoomsUpdatedListener)

Subscribe function for BreakoutRooms Updated event

function off(event: "breakoutRoomsUpdated", listener: BreakoutRoomsUpdatedListener)

Parameters

event

"breakoutRoomsUpdated"

AllBreakoutRoomsUpdated

listener

BreakoutRoomsUpdatedListener

callback function that was used to subscribe to this event

on("breakoutRoomsUpdated", BreakoutRoomsUpdatedListener)

Subscribe function for BreakoutRooms Updated event

function on(event: "breakoutRoomsUpdated", listener: BreakoutRoomsUpdatedListener)

Parameters

event

"breakoutRoomsUpdated"

AllBreakoutRoomsUpdated

listener

BreakoutRoomsUpdatedListener

callback function that was used to subscribe to this event

Inherited Method Details

dispose()

function dispose()

Inherited From CallFeature.dispose