Lobby interface
Teams 會議大廳
屬性
participants | Teams 會議中具有 「InLobby」 狀態的遠端參與者集合。 |
方法
admit(Communication |
/**
|
admit |
允許來自大廳的所有參與者。 |
off("lobby |
針對 lobbyParticipantsUpdated 事件取消訂閱函式。 |
on("lobby |
適用於 lobbyParticipantsUpdated 事件的訂閱函式。 |
reject(Communication |
拒絕大廳中的參與者。 |
屬性詳細資料
participants
Teams 會議中具有 「InLobby」 狀態的遠端參與者集合。
participants: readonly RemoteParticipant[]
屬性值
readonly RemoteParticipant[]
方法詳細資料
admit(CommunicationIdentifier, AdmitLobbyParticipantOptions)
/**
- 允許來自大廳的參與者。
function admit(participant: CommunicationIdentifier, options?: AdmitLobbyParticipantOptions): Promise<void>
參數
- participant
- CommunicationIdentifier
要接受的參與者。
- options
- AdmitLobbyParticipantOptions
傳回
Promise<void>
admitAll(AdmitLobbyParticipantOptions)
允許來自大廳的所有參與者。
function admitAll(options?: AdmitLobbyParticipantOptions): Promise<AdmitAllOperationResult>
參數
- options
- AdmitLobbyParticipantOptions
傳回
Promise<AdmitAllOperationResult>
off("lobbyParticipantsUpdated", CollectionUpdatedEvent<RemoteParticipant>)
針對 lobbyParticipantsUpdated 事件取消訂閱函式。
function off(event: "lobbyParticipantsUpdated", listener: CollectionUpdatedEvent<RemoteParticipant>)
參數
- event
-
"lobbyParticipantsUpdated"
事件名稱。
- listener
用來訂閱此事件的回呼 fn。
on("lobbyParticipantsUpdated", CollectionUpdatedEvent<RemoteParticipant>)
適用於 lobbyParticipantsUpdated 事件的訂閱函式。
function on(event: "lobbyParticipantsUpdated", listener: CollectionUpdatedEvent<RemoteParticipant>)
參數
- event
-
"lobbyParticipantsUpdated"
事件名稱。
- listener
回呼 fn 會在此集合變更時呼叫,它會傳遞已新增和移除項目的陣列。
reject(CommunicationIdentifier, RejectLobbyParticipantOptions)
拒絕大廳中的參與者。
function reject(participant: CommunicationIdentifier, options?: RejectLobbyParticipantOptions): Promise<void>
參數
- participant
- CommunicationIdentifier
要接受的參與者。
- options
- RejectLobbyParticipantOptions
傳回
Promise<void>