# RaiseHandAction

# RaiseHandAction

Artifact:[androidx.core:core-telecom](https://developer.android.com/jetpack/androidx/releases/core)  
[View Source](https://cs.android.com/search?q=file:androidx/core/telecom/extensions/RaiseHandAction.kt+class:androidx.core.telecom.extensions.RaiseHandAction)  
Added in[1.0.0](https://developer.android.com/jetpack/androidx/releases/core#1.0.0)

*** ** * ** ***

Kotlin\|[Java](https://developer.android.com/reference/androidx/core/telecom/extensions/RaiseHandAction "View this page in Java")

<br />

```
@ExperimentalAppActions
interface RaiseHandAction
```

<br />

*** ** * ** ***

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](https://developer.android.com/reference/kotlin/androidx/core/telecom/CallControlResult) | [requestRaisedHandStateChange](https://developer.android.com/reference/kotlin/androidx/core/telecom/extensions/RaiseHandAction#requestRaisedHandStateChange(kotlin.Boolean))`(isRaised: `[Boolean](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-boolean/index.html)`)` Request the calling application to raise or lower this user's hand. |

|                                ### Public properties                                |
|-------------------------------------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| [Boolean](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-boolean/index.html) | [isSupported](https://developer.android.com/reference/kotlin/androidx/core/telecom/extensions/RaiseHandAction#isSupported()) 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](https://developer.android.com/reference/kotlin/androidx/core/telecom/extensions/Participant)is currently included in the[ParticipantExtensionRemote.addRaiseHandAction](https://developer.android.com/reference/kotlin/androidx/core/telecom/extensions/ParticipantExtensionRemote#addRaiseHandAction(kotlin.coroutines.SuspendFunction1))`onRaisedHandsChanged`callback`List`.

Note: A[CallControlResult.Success](https://developer.android.com/reference/kotlin/androidx/core/telecom/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](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-boolean/index.html) | `true`if this user has raised their hand,`false`if they have lowered their hand |

|                                                   Returns                                                   |
|-------------------------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| [CallControlResult](https://developer.android.com/reference/kotlin/androidx/core/telecom/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](https://developer.android.com/jetpack/androidx/releases/core#1.0.0)  

```
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](https://developer.android.com/reference/kotlin/androidx/core/telecom/extensions/RaiseHandAction#requestRaisedHandStateChange(kotlin.Boolean))requests will fail.

Must not be queried until[CallExtensionScope.onConnected](https://developer.android.com/reference/kotlin/androidx/core/telecom/extensions/CallExtensionScope#onConnected(kotlin.coroutines.SuspendFunction1))is called or an error will be thrown.