JobRouterClient.CloseJobAsync Method

Definition

Namespace:

Azure.Communication.JobRouter

Assembly:

Azure.Communication.JobRouter.dll

Package:

Azure.Communication.JobRouter v1.0.0

Overloads

CloseJobAsync(CloseJobOptions, CancellationToken)

Closes a completed job.

CloseJobAsync(String, String, RequestContent, RequestContext)

[Protocol Method] Closes a completed job. 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.CloseJobAsync(System.String,System.String,Azure.Communication.JobRouter.CloseJobOptions,System.Threading.CancellationToken) convenience overload with strongly typed models first.

CloseJobAsync(CloseJobOptions, CancellationToken)

Source:

JobRouterClient.cs

Closes a completed job.

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

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

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

Parameters

options

CloseJobOptions

Options for closing 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.

CloseJobAsync(String, String, RequestContent, RequestContext)

Source:

JobRouterClient.cs

[Protocol Method] Closes a completed job.

• 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.CloseJobAsync(System.String,System.String,Azure.Communication.JobRouter.CloseJobOptions,System.Threading.CancellationToken) convenience overload with strongly typed models first.

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

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

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

Parameters

jobId

String

Id of a job.

assignmentId

String

Id of a job assignment.

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 or assignmentId is null.

ArgumentException

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

RequestFailedException

Service returned a non-success status code.