CallConnection.RemoveParticipant Method

Definition

Namespace:

Azure.Communication.CallAutomation

Assembly:

Azure.Communication.CallAutomation.dll

Package:

Azure.Communication.CallAutomation v1.2.0

Overloads

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

RemoveParticipant(RemoveParticipantOptions, CancellationToken)

Source:

CallConnection.cs

Remove participants from the call.

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

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

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

Parameters

options

RemoveParticipantOptions

Options for the RemoveParticipants operations.

cancellationToken

CancellationToken

The cancellation token

Returns

Response<RemoveParticipantResult>

Exceptions

RequestFailedException

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

ArgumentNullException

options is null.

RemoveParticipant(CommunicationIdentifier, String, CancellationToken)

Source:

CallConnection.cs

Remove participants from the call.

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

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

Public Overridable Function RemoveParticipant (participantToRemove As CommunicationIdentifier, Optional operationContext As String = Nothing, Optional cancellationToken As CancellationToken = Nothing) As 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

Response<RemoveParticipantResult>

Exceptions

RequestFailedException

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

ArgumentNullException

participantToRemove is null.