# KickParticipantAction

# KickParticipantAction

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/KickParticipantAction.kt+class:androidx.core.telecom.extensions.KickParticipantAction)  
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/KickParticipantAction "View this page in Java")

<br />

```
@ExperimentalAppActions
interface KickParticipantAction
```

<br />

*** ** * ** ***

The action used to determine if the calling application supports kicking participants and request to kick[Participant](https://developer.android.com/reference/kotlin/androidx/core/telecom/extensions/Participant)s in the call.

## Summary

|                                                 ### Public functions                                                  |
|-----------------------------------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| `suspend `[CallControlResult](https://developer.android.com/reference/kotlin/androidx/core/telecom/CallControlResult) | [requestKickParticipant](https://developer.android.com/reference/kotlin/androidx/core/telecom/extensions/KickParticipantAction#requestKickParticipant(androidx.core.telecom.extensions.Participant))`(participant: `[Participant](https://developer.android.com/reference/kotlin/androidx/core/telecom/extensions/Participant)`)` Request to kick a[participant](https://developer.android.com/reference/kotlin/androidx/core/telecom/extensions/KickParticipantAction#requestKickParticipant(androidx.core.telecom.extensions.Participant))in the call. |

|                                ### 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/KickParticipantAction#isSupported()) Whether or not kicking participants is supported by the calling application. |

## Public functions

### requestKickParticipant

```
suspend fun requestKickParticipant(participant: Participant): CallControlResult
```

Request to kick a[participant](https://developer.android.com/reference/kotlin/androidx/core/telecom/extensions/KickParticipantAction#requestKickParticipant(androidx.core.telecom.extensions.Participant))in the call.

Whether or not the[Participant](https://developer.android.com/reference/kotlin/androidx/core/telecom/extensions/Participant)is allowed to be kicked is up to the calling application, so requesting to kick a[Participant](https://developer.android.com/reference/kotlin/androidx/core/telecom/extensions/Participant)may result in no action being taken. For example, the calling application may choose not to complete a request to kick the host of the call or kick the[Participant](https://developer.android.com/reference/kotlin/androidx/core/telecom/extensions/Participant)representing this user.

Note: This operation succeeding does not mean that the participant was kicked, it only means that the request was received and processed by the remote application. If the[Participant](https://developer.android.com/reference/kotlin/androidx/core/telecom/extensions/Participant)is indeed kicked, the[CallExtensionScope.addParticipantExtension](https://developer.android.com/reference/kotlin/androidx/core/telecom/extensions/CallExtensionScope#addParticipantExtension(kotlin.coroutines.SuspendFunction1,kotlin.coroutines.SuspendFunction1))`onParticipantsUpdated`callback will be updated to remove the kicked[Participant](https://developer.android.com/reference/kotlin/androidx/core/telecom/extensions/Participant).  

|                                                        Parameters                                                         |
|---------------------------------------------------------------------------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------|
| `participant: `[Participant](https://developer.android.com/reference/kotlin/androidx/core/telecom/extensions/Participant) | The[Participant](https://developer.android.com/reference/kotlin/androidx/core/telecom/extensions/Participant)to kick from the call. |

|                                                   Returns                                                   |
|-------------------------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------|
| [CallControlResult](https://developer.android.com/reference/kotlin/androidx/core/telecom/CallControlResult) | The result of whether or not this request was successfully sent to the remote application and processed. |

## 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 kicking participants is supported by the calling application.

if`true`, then requests to kick participants will be sent to the calling application. If`false`, then the calling application doesn't support this action and 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.