RaiseHandCallFeature interface

Package:

@azure/communication-calling

Raise hand call reaction feature.

Extends

CallFeature

Inherited Properties

name	The feature name.

Methods

getRaisedHands()	Get status of all participants with active raise hand status
lowerAllHands()	Send request to remove raise hand state for every participant on the call
lowerHand()	Send request to remove the raised hand state for local participant
lowerHands((CommunicationUserIdentifier | MicrosoftTeamsUserIdentifier)[])	Send request to remove the raised hand states for remote participants
off("loweredHandEvent", LoweredHandListener)	Unsubscribe function for raiseHandChanged event
off("raisedHandEvent", RaisedHandListener)	Unsubscribe function for raiseHandChanged event
on("loweredHandEvent", LoweredHandListener)	Subscribe function for raiseHandChanged event
on("raisedHandEvent", RaisedHandListener)	Subscribe function for raiseHandChanged event
raiseHand()	Send request to raise hand for local participant

Inherited Methods

dispose()

Inherited Property Details

name

The feature name.

name: string

Property Value

string

Inherited From CallFeature.name

Method Details

getRaisedHands()

Get status of all participants with active raise hand status

function getRaisedHands(): RaisedHand[]

Returns

RaisedHand[]

array of states with all participants with active raise hand status

lowerAllHands()

Send request to remove raise hand state for every participant on the call

function lowerAllHands(): Promise<void>

Returns

Promise<void>

lowerHand()

Send request to remove the raised hand state for local participant

function lowerHand(): Promise<void>

Returns

Promise<void>

lowerHands((CommunicationUserIdentifier | MicrosoftTeamsUserIdentifier)[])

Send request to remove the raised hand states for remote participants

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

Parameters

identifiers

(CommunicationUserIdentifier | MicrosoftTeamsUserIdentifier)[]

is list of Identifiers to remove multiple raised hand states for other users

Returns

Promise<void>

off("loweredHandEvent", LoweredHandListener)

Unsubscribe function for raiseHandChanged event

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

Parameters

event

"loweredHandEvent"

event name

listener

LoweredHandListener

callback fn that was used to unsubscribe to this event

off("raisedHandEvent", RaisedHandListener)

Unsubscribe function for raiseHandChanged event

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

Parameters

event

"raisedHandEvent"

event name

listener

RaisedHandListener

callback fn that was used to unsubscribe to this event

on("loweredHandEvent", LoweredHandListener)

Subscribe function for raiseHandChanged event

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

Parameters

event

"loweredHandEvent"

event name

listener

LoweredHandListener

callback fn that was used to subscribe to this event

on("raisedHandEvent", RaisedHandListener)

Subscribe function for raiseHandChanged event

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

Parameters

event

"raisedHandEvent"

event name

listener

RaisedHandListener

callback fn that was used to subscribe to this event

raiseHand()

Send request to raise hand for local participant

function raiseHand(): Promise<void>

Returns

Promise<void>

Inherited Method Details

dispose()

function dispose()

Inherited From CallFeature.dispose