Lobby interface

Paket:

@azure/communication-calling

Teams-Besprechungslobby

Eigenschaften

participants

Sammlung von Remoteteilnehmern mit dem Status "InLobby" in der Teams-Besprechung.

Methoden

admit(CommunicationIdentifier, AdmitLobbyParticipantOptions)	/** Zulassen eines Teilnehmers aus der Lobby.
admitAll(AdmitLobbyParticipantOptions)	Alle Teilnehmer aus der Lobby zulassen.
off("lobbyParticipantsUpdated", CollectionUpdatedEvent<RemoteParticipant>)	Unsubscribe-Funktion für das Ereignis lobbyParticipantsUpdated.
on("lobbyParticipantsUpdated", CollectionUpdatedEvent<RemoteParticipant>)	Subscribe-Funktion für das Ereignis lobbyParticipantsUpdated.
reject(CommunicationIdentifier, RejectLobbyParticipantOptions)	Lehnen Sie einen Teilnehmer aus der Lobby ab.

Details zur Eigenschaft

participants

Sammlung von Remoteteilnehmern mit dem Status "InLobby" in der Teams-Besprechung.

participants: readonly RemoteParticipant[]

Eigenschaftswert

readonly RemoteParticipant[]

Details zur Methode

admit(CommunicationIdentifier, AdmitLobbyParticipantOptions)

/**

• Zulassen eines Teilnehmers aus der Lobby.

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

Parameter

participant

CommunicationIdentifier

der zuzulassende Teilnehmer.

options

AdmitLobbyParticipantOptions

Gibt zurück

Promise<void>

admitAll(AdmitLobbyParticipantOptions)

Alle Teilnehmer aus der Lobby zulassen.

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

Parameter

options

AdmitLobbyParticipantOptions

Gibt zurück

Promise<AdmitAllOperationResult>

off("lobbyParticipantsUpdated", CollectionUpdatedEvent<RemoteParticipant>)

Unsubscribe-Funktion für das Ereignis lobbyParticipantsUpdated.

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

Parameter

event

"lobbyParticipantsUpdated"

Ereignisname.

listener

CollectionUpdatedEvent<RemoteParticipant>

Rückruf fn, der zum Abonnieren dieses Ereignisses verwendet wurde.

on("lobbyParticipantsUpdated", CollectionUpdatedEvent<RemoteParticipant>)

Subscribe-Funktion für das Ereignis lobbyParticipantsUpdated.

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

Parameter

event

"lobbyParticipantsUpdated"

Ereignisname.

listener

CollectionUpdatedEvent<RemoteParticipant>

callback fn, der aufgerufen wird, wenn sich diese Auflistung ändert, übergeben Arrays von hinzugefügten und entfernten Elementen.

reject(CommunicationIdentifier, RejectLobbyParticipantOptions)

Lehnen Sie einen Teilnehmer aus der Lobby ab.

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

Parameter

participant

CommunicationIdentifier

der zuzulassende Teilnehmer.

options

RejectLobbyParticipantOptions

Gibt zurück

Promise<void>