CallConnection.MuteParticipantAsync Method

Definition

Namespace:

Azure.Communication.CallAutomation

Assembly:

Azure.Communication.CallAutomation.dll

Package:

Azure.Communication.CallAutomation v1.3.0

Overloads

MuteParticipantAsync(MuteParticipantOptions, CancellationToken)	Mute participants on the call.
MuteParticipantAsync(CommunicationIdentifier, CancellationToken)	Mute participants on the call. Only Acs Users are currently supported.

MuteParticipantAsync(MuteParticipantOptions, CancellationToken)

Source:

CallConnection.cs

Mute participants on the call.

public virtual System.Threading.Tasks.Task<Azure.Response<Azure.Communication.CallAutomation.MuteParticipantResult>> MuteParticipantAsync (Azure.Communication.CallAutomation.MuteParticipantOptions options, System.Threading.CancellationToken cancellationToken = default);

abstract member MuteParticipantAsync : Azure.Communication.CallAutomation.MuteParticipantOptions * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<Azure.Communication.CallAutomation.MuteParticipantResult>>
override this.MuteParticipantAsync : Azure.Communication.CallAutomation.MuteParticipantOptions * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<Azure.Communication.CallAutomation.MuteParticipantResult>>

Public Overridable Function MuteParticipantAsync (options As MuteParticipantOptions, Optional cancellationToken As CancellationToken = Nothing) As Task(Of Response(Of MuteParticipantResult))

Parameters

options

MuteParticipantOptions

Options for the MuteParticipant operation.

cancellationToken

CancellationToken

The cancellation token.

Returns

Task<Response<MuteParticipantResult>>

Exceptions

ArgumentNullException

options is null.

ArgumentException

options OperationContext is too long.

RequestFailedException

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

MuteParticipantAsync(CommunicationIdentifier, CancellationToken)

Source:

CallConnection.cs

Mute participants on the call. Only Acs Users are currently supported.

public virtual System.Threading.Tasks.Task<Azure.Response<Azure.Communication.CallAutomation.MuteParticipantResult>> MuteParticipantAsync (Azure.Communication.CommunicationIdentifier targetParticipant, System.Threading.CancellationToken cancellationToken = default);

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

Public Overridable Function MuteParticipantAsync (targetParticipant As CommunicationIdentifier, Optional cancellationToken As CancellationToken = Nothing) As Task(Of Response(Of MuteParticipantResult))

Parameters

targetParticipant

CommunicationIdentifier

Participants to mute.

cancellationToken

CancellationToken

The cancellation token.

Returns

Task<Response<MuteParticipantResult>>

Exceptions

ArgumentNullException

targetParticipant is null.

RequestFailedException

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