JobRouterClient.CancelJobAsync Method

Definition

Namespace:

Azure.Communication.JobRouter

Assembly:

Azure.Communication.JobRouter.dll

Package:

Azure.Communication.JobRouter v1.0.0

Overloads

CancelJobAsync(CancelJobOptions, CancellationToken)

Submits request to cancel an existing job by Id while supplying free-form cancellation reason.

CancelJobAsync(String, RequestContent, RequestContext)

[Protocol Method] Submits request to cancel an existing job by Id while supplying free-form cancellation reason. This protocol method allows explicit creation of the request and processing of the response for advanced scenarios. Please try the simpler Azure.Communication.JobRouter.JobRouterClient.CancelJobAsync(System.String,Azure.Communication.JobRouter.CancelJobOptions,System.Threading.CancellationToken) convenience overload with strongly typed models first.

CancelJobAsync(CancelJobOptions, CancellationToken)

Source:

JobRouterClient.cs

Submits request to cancel an existing job by Id while supplying free-form cancellation reason.

public virtual System.Threading.Tasks.Task<Azure.Response> CancelJobAsync (Azure.Communication.JobRouter.CancelJobOptions options, System.Threading.CancellationToken cancellationToken = default);

abstract member CancelJobAsync : Azure.Communication.JobRouter.CancelJobOptions * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response>
override this.CancelJobAsync : Azure.Communication.JobRouter.CancelJobOptions * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response>

Public Overridable Function CancelJobAsync (options As CancelJobOptions, Optional cancellationToken As CancellationToken = Nothing) As Task(Of Response)

Parameters

options

CancelJobOptions

Options for cancelling job.

cancellationToken

CancellationToken

The cancellation token to use.

Returns

Task<Response>

Exceptions

RequestFailedException

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

ArgumentNullException

options is null.

CancelJobAsync(String, RequestContent, RequestContext)

Source:

JobRouterClient.cs

[Protocol Method] Submits request to cancel an existing job by Id while supplying free-form cancellation reason.

• This protocol method allows explicit creation of the request and processing of the response for advanced scenarios.
• Please try the simpler Azure.Communication.JobRouter.JobRouterClient.CancelJobAsync(System.String,Azure.Communication.JobRouter.CancelJobOptions,System.Threading.CancellationToken) convenience overload with strongly typed models first.

public virtual System.Threading.Tasks.Task<Azure.Response> CancelJobAsync (string jobId, Azure.Core.RequestContent content, Azure.RequestContext context = default);

abstract member CancelJobAsync : string * Azure.Core.RequestContent * Azure.RequestContext -> System.Threading.Tasks.Task<Azure.Response>
override this.CancelJobAsync : string * Azure.Core.RequestContent * Azure.RequestContext -> System.Threading.Tasks.Task<Azure.Response>

Public Overridable Function CancelJobAsync (jobId As String, content As RequestContent, Optional context As RequestContext = Nothing) As Task(Of Response)

Parameters

jobId

String

Id of a job.

content

RequestContent

The content to send as the body of the request.

context

RequestContext

The request context, which can override default behaviors of the client pipeline on a per-call basis.

Returns

Task<Response>

The response returned from the service.

Exceptions

ArgumentNullException

jobId is null.

ArgumentException

jobId is an empty string, and was expected to be non-empty.

RequestFailedException

Service returned a non-success status code.