RaiseHandCallFeature interface

包:

@azure/communication-calling

举手呼叫反应功能。

扩展

CallFeature

继承属性

name

功能名称。

方法

getRaisedHands()	获取具有活动举手状态的所有参与者的状态
lowerAllHands()	发送请求以删除通话中每个参与者的举手状态
lowerHand()	发送请求以删除本地参与者的举手状态
lowerHands((CommunicationUserIdentifier | MicrosoftTeamsUserIdentifier)[])	发送请求以删除远程参与者的举手状态
off("loweredHandEvent", LoweredHandListener)	Unsubscribe function for raiseHandChanged 事件
off("raisedHandEvent", RaisedHandListener)	Unsubscribe function for 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)

Unsubscribe function for raiseHandChanged 事件

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

参数

event

"loweredHandEvent"

事件名称

listener

LoweredHandListener

用于取消订阅此事件的回调 fn

off("raisedHandEvent", RaisedHandListener)

Unsubscribe function for 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