CallConnection.RemoveParticipantAsync Method

Definition

Namespace:

Azure.Communication.CallAutomation

Assembly:

Azure.Communication.CallAutomation.dll

Package:

Azure.Communication.CallAutomation v1.3.0

Overloads

RemoveParticipantAsync(RemoveParticipantOptions, CancellationToken)	Remove participants from the call.
RemoveParticipantAsync(CommunicationIdentifier, String, CancellationToken)	Remove participants from the call.

RemoveParticipantAsync(RemoveParticipantOptions, CancellationToken)

Source:

CallConnection.cs

Remove participants from the call.

public virtual System.Threading.Tasks.Task<Azure.Response<Azure.Communication.CallAutomation.RemoveParticipantResult>> RemoveParticipantAsync (Azure.Communication.CallAutomation.RemoveParticipantOptions options, System.Threading.CancellationToken cancellationToken = default);

abstract member RemoveParticipantAsync : Azure.Communication.CallAutomation.RemoveParticipantOptions * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<Azure.Communication.CallAutomation.RemoveParticipantResult>>
override this.RemoveParticipantAsync : Azure.Communication.CallAutomation.RemoveParticipantOptions * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<Azure.Communication.CallAutomation.RemoveParticipantResult>>

Public Overridable Function RemoveParticipantAsync (options As RemoveParticipantOptions, Optional cancellationToken As CancellationToken = Nothing) As Task(Of Response(Of RemoveParticipantResult))

Parameters

options

RemoveParticipantOptions

Options for the RemoveParticipants operations.

cancellationToken

CancellationToken

The cancellation token

Returns

Task<Response<RemoveParticipantResult>>

Exceptions

RequestFailedException

The server returned an error. See Message for details returned from the server.

ArgumentNullException

options is null.

RemoveParticipantAsync(CommunicationIdentifier, String, CancellationToken)

Source:

CallConnection.cs

Remove participants from the call.

public virtual System.Threading.Tasks.Task<Azure.Response<Azure.Communication.CallAutomation.RemoveParticipantResult>> RemoveParticipantAsync (Azure.Communication.CommunicationIdentifier participantToRemove, string operationContext = default, System.Threading.CancellationToken cancellationToken = default);

abstract member RemoveParticipantAsync : Azure.Communication.CommunicationIdentifier * string * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<Azure.Communication.CallAutomation.RemoveParticipantResult>>
override this.RemoveParticipantAsync : Azure.Communication.CommunicationIdentifier * string * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<Azure.Communication.CallAutomation.RemoveParticipantResult>>

Public Overridable Function RemoveParticipantAsync (participantToRemove As CommunicationIdentifier, Optional operationContext As String = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task(Of Response(Of RemoveParticipantResult))

Parameters

participantToRemove

CommunicationIdentifier

The list of identity of participants to be removed from the call.

operationContext

String

The Operation Context.

cancellationToken

CancellationToken

The cancellation token.

Returns

Task<Response<RemoveParticipantResult>>

Exceptions

RequestFailedException

The server returned an error. See Message for details returned from the server.

ArgumentNullException

participantToRemove is null.