Lobby interface

Teams 会议大厅

属性

participants

Teams 会议中处于“InLobby”状态的远程参与者集合。

方法

admit(CommunicationIdentifier, AdmitLobbyParticipantOptions)

/**

  • 允许大厅中的参与者。
admitAll(AdmitLobbyParticipantOptions)

允许来自大厅的所有参与者。

off("lobbyParticipantsUpdated", CollectionUpdatedEvent<RemoteParticipant>)

lobbyParticipantsUpdated 事件的取消订阅函数。

on("lobbyParticipantsUpdated", CollectionUpdatedEvent<RemoteParticipant>)

lobbyParticipantsUpdated 事件的 Subscribe 函数。

reject(CommunicationIdentifier, RejectLobbyParticipantOptions)

拒绝来自大厅的参与者。

属性详细信息

participants

Teams 会议中处于“InLobby”状态的远程参与者集合。

participants: readonly RemoteParticipant[]

属性值

readonly RemoteParticipant[]

方法详细信息

admit(CommunicationIdentifier, AdmitLobbyParticipantOptions)

/**

  • 允许大厅中的参与者。
function admit(participant: CommunicationIdentifier, options?: AdmitLobbyParticipantOptions): Promise<void>

参数

participant
CommunicationIdentifier

要被录取的参与者。

返回

Promise<void>

admitAll(AdmitLobbyParticipantOptions)

允许来自大厅的所有参与者。

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

参数

返回

off("lobbyParticipantsUpdated", CollectionUpdatedEvent<RemoteParticipant>)

lobbyParticipantsUpdated 事件的取消订阅函数。

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

参数

event

"lobbyParticipantsUpdated"

事件名称。

listener

CollectionUpdatedEvent<RemoteParticipant>

用于订阅此事件的 callback fn。

on("lobbyParticipantsUpdated", CollectionUpdatedEvent<RemoteParticipant>)

lobbyParticipantsUpdated 事件的 Subscribe 函数。

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

参数

event

"lobbyParticipantsUpdated"

事件名称。

listener

CollectionUpdatedEvent<RemoteParticipant>

回调 fn,此集合更改时将调用,它将传递已添加和已删除元素的数组。

reject(CommunicationIdentifier, RejectLobbyParticipantOptions)

拒绝来自大厅的参与者。

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

参数

participant
CommunicationIdentifier

要被录取的参与者。

返回

Promise<void>