KickParticipantAction
@ExperimentalAppActions
interface KickParticipantAction
The action used to determine if the calling application supports kicking participants and request to kick Participants in the call.
Summary
Public functions |
|
|---|---|
suspend CallControlResult |
requestKickParticipant(participant: Participant)Request to kick a |
Public properties |
|
|---|---|
Boolean |
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 in the call.
Whether or not the Participant is allowed to be kicked is up to the calling application, so requesting to kick a 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 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 is indeed kicked, the CallExtensionScope.addParticipantExtension onParticipantsUpdated callback will be updated to remove the kicked Participant.
| Parameters | |
|---|---|
participant: Participant |
The |
| Returns | |
|---|---|
CallControlResult |
The result of whether or not this request was successfully sent to the remote application and processed. |
Public properties
isSupported
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 is called.