RaiseHandAction

@ExperimentalAppActions
interface RaiseHandAction

The action used to determine if the raise hand action is supported by the calling application and notify the calling application when the user requests to raise or lower their hand.

Summary

Public functions
suspend CallControlResult

Request the calling application to raise or lower this user's hand.

Public properties
Boolean

Whether or not raising/lowering hands is supported by the calling application.

Public functions

requestRaisedHandStateChange

suspend fun requestRaisedHandStateChange(isRaised: Boolean): CallControlResult

Request the calling application to raise or lower this user's hand.

Whether or not this user's hand is currently raised is determined by inspecting whether or not this Participant is currently included in the ParticipantExtensionRemote.addRaiseHandAction onRaisedHandsChanged callback List.

Note: A CallControlResult.Success result does not mean that the raised hand state of the user has changed. It only means that the request was received by the remote application and processed. This can be used to gray out UI until the request has processed.

Parameters
isRaised: Boolean

true if this user has raised their hand, false if they have lowered their hand
Returns
CallControlResult

Whether or not the remote application received this event. This does not mean that the operation succeeded, but rather the remote received and processed the event successfully.

Public properties

isSupported

Added in 1.0.0-beta01
var isSupported: Boolean

Whether or not raising/lowering hands is supported by the calling application.

if true, then updates about raised hands from the calling application will be notified. If false, then the calling application doesn't support this action and state changes will not be notified to the caller and requestRaisedHandStateChange requests will fail.

Must not be queried until CallExtensionScope.onConnected is called or an error will be thrown.