Lobby interface

Package:

@azure/communication-calling

Teams meeting lobby

Properties

participants

Collection of remote participants who have "InLobby" state in Teams meeting.

Methods

admit(CommunicationIdentifier, AdmitLobbyParticipantOptions)	/** Admit a participant from the lobby.
admitAll(AdmitLobbyParticipantOptions)	Admit all participants from the lobby.
off("lobbyParticipantsUpdated", CollectionUpdatedEvent<RemoteParticipant>)	Unsubscribe function for lobbyParticipantsUpdated event.
on("lobbyParticipantsUpdated", CollectionUpdatedEvent<RemoteParticipant>)	Subscribe function for lobbyParticipantsUpdated event.
reject(CommunicationIdentifier, RejectLobbyParticipantOptions)	Reject a participant from the lobby.

Property Details

participants

Collection of remote participants who have "InLobby" state in Teams meeting.

participants: readonly RemoteParticipant[]

Property Value

readonly RemoteParticipant[]

Method Details

admit(CommunicationIdentifier, AdmitLobbyParticipantOptions)

/**

• Admit a participant from the lobby.

function admit(participant: CommunicationIdentifier, options?: AdmitLobbyParticipantOptions): Promise<void>

Parameters

participant

CommunicationIdentifier

the participant to be admitted.

options

AdmitLobbyParticipantOptions

Returns

Promise<void>

admitAll(AdmitLobbyParticipantOptions)

Admit all participants from the lobby.

function admitAll(options?: AdmitLobbyParticipantOptions): Promise<AdmitAllOperationResult>

Parameters

options

AdmitLobbyParticipantOptions

Returns

Promise<AdmitAllOperationResult>

off("lobbyParticipantsUpdated", CollectionUpdatedEvent<RemoteParticipant>)

Unsubscribe function for lobbyParticipantsUpdated event.

function off(event: "lobbyParticipantsUpdated", listener: CollectionUpdatedEvent<RemoteParticipant>)

Parameters

event

"lobbyParticipantsUpdated"

event name.

listener

CollectionUpdatedEvent<RemoteParticipant>

callback fn that was used to subscribe to this event.

on("lobbyParticipantsUpdated", CollectionUpdatedEvent<RemoteParticipant>)

Subscribe function for lobbyParticipantsUpdated event.

function on(event: "lobbyParticipantsUpdated", listener: CollectionUpdatedEvent<RemoteParticipant>)

Parameters

event

"lobbyParticipantsUpdated"

event name.

listener

CollectionUpdatedEvent<RemoteParticipant>

callback fn that will be called when this collection will change, it will pass arrays of added and removed elements.

reject(CommunicationIdentifier, RejectLobbyParticipantOptions)

Reject a participant from the lobby.

function reject(participant: CommunicationIdentifier, options?: RejectLobbyParticipantOptions): Promise<void>

Parameters

participant

CommunicationIdentifier

the participant to be admitted.

options

RejectLobbyParticipantOptions

Returns

Promise<void>