RaiseHandCallFeature interface

套件:

@azure/communication-calling

舉手呼叫反應功能。

Extends

CallFeature

繼承的屬性

name

功能名稱。

方法

getRaisedHands()	取得具有主動舉手狀態的所有參與者的狀態
lowerAllHands()	傳送要求以移除通話上每個參與者的舉手狀態
lowerHand()	傳送要求以移除本機參與者的舉手狀態
lowerHands((CommunicationUserIdentifier | MicrosoftTeamsUserIdentifier)[])	傳送要求以移除遠端參與者的舉手狀態
off("loweredHandEvent", LoweredHandListener)	raiseHandChanged 事件的取消訂閱函式
off("raisedHandEvent", RaisedHandListener)	raiseHandChanged 事件的取消訂閱函式
on("loweredHandEvent", LoweredHandListener)	raiseHandChanged 事件的 Subscribe 函式
on("raisedHandEvent", RaisedHandListener)	raiseHandChanged 事件的 Subscribe 函式
raiseHand()	傳送要求給本機參與者舉手

繼承的方法

dispose()

繼承的屬性詳細資料

name

功能名稱。

name: string

屬性值

string

繼承自CallFeature.name

方法詳細資料

getRaisedHands()

取得具有主動舉手狀態的所有參與者的狀態

function getRaisedHands(): RaisedHand[]

傳回

RaisedHand[]

具有作用中舉手狀態之所有參與者的狀態陣列

lowerAllHands()

傳送要求以移除通話上每個參與者的舉手狀態

function lowerAllHands(): Promise<void>

傳回

Promise<void>

lowerHand()

傳送要求以移除本機參與者的舉手狀態

function lowerHand(): Promise<void>

傳回

Promise<void>

lowerHands((CommunicationUserIdentifier | MicrosoftTeamsUserIdentifier)[])

傳送要求以移除遠端參與者的舉手狀態

function lowerHands(identifiers: (CommunicationUserIdentifier | MicrosoftTeamsUserIdentifier)[]): Promise<void>

參數

identifiers

(CommunicationUserIdentifier | MicrosoftTeamsUserIdentifier)[]

是要移除其他使用者多個引發之手狀態的標識符清單

傳回

Promise<void>

off("loweredHandEvent", LoweredHandListener)

raiseHandChanged 事件的取消訂閱函式

function off(event: "loweredHandEvent", listener: LoweredHandListener)

參數

event

"loweredHandEvent"

事件名稱

listener

LoweredHandListener

回呼 fn，用來取消訂閱此事件

off("raisedHandEvent", RaisedHandListener)

raiseHandChanged 事件的取消訂閱函式

function off(event: "raisedHandEvent", listener: RaisedHandListener)

參數

event

"raisedHandEvent"

事件名稱

listener

RaisedHandListener

回呼 fn，用來取消訂閱此事件

on("loweredHandEvent", LoweredHandListener)

raiseHandChanged 事件的 Subscribe 函式

function on(event: "loweredHandEvent", listener: LoweredHandListener)

參數

event

"loweredHandEvent"

事件名稱

listener

LoweredHandListener

回呼 fn，用來訂閱此事件

on("raisedHandEvent", RaisedHandListener)

raiseHandChanged 事件的 Subscribe 函式

function on(event: "raisedHandEvent", listener: RaisedHandListener)

參數

event

"raisedHandEvent"

事件名稱

listener

RaisedHandListener

回呼 fn，用來訂閱此事件

raiseHand()

傳送要求給本機參與者舉手

function raiseHand(): Promise<void>

傳回

Promise<void>

繼承的方法的詳細資料

dispose()

function dispose()

繼承自CallFeature.dispose