Share via

JobRouterClient.CompleteJob Method

  • Reference

Definition

Namespace:
Azure.Communication.JobRouter
Assembly:
Azure.Communication.JobRouter.dll
Package:
Azure.Communication.JobRouter v1.0.0
Package:
Azure.Communication.JobRouter v1.1.0-beta.1

Overloads

CompleteJob(String, String, RequestContent, RequestContext)

[Protocol Method] Completes an assigned 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.CompleteJob(System.String,System.String,Azure.Communication.JobRouter.CompleteJobOptions,System.Threading.CancellationToken) convenience overload with strongly typed models first.
CompleteJob(CompleteJobOptions, CancellationToken)

Completes an assigned job.

CompleteJob(String, String, RequestContent, RequestContext)

Source:
JobRouterClient.cs
Source:
JobRouterClient.cs

[Protocol Method] Completes an assigned 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.CompleteJob(System.String,System.String,Azure.Communication.JobRouter.CompleteJobOptions,System.Threading.CancellationToken) convenience overload with strongly typed models first. 
public virtual Azure.Response CompleteJob (string jobId, string assignmentId, Azure.Core.RequestContent content, Azure.RequestContext context = default);
abstract member CompleteJob : string * string * Azure.Core.RequestContent * Azure.RequestContext -> Azure.Response
override this.CompleteJob : string * string * Azure.Core.RequestContent * Azure.RequestContext -> Azure.Response
Public Overridable Function CompleteJob (jobId As String, assignmentId As String, content As RequestContent, Optional context As RequestContext = Nothing) As 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

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.

Applies to

CompleteJob(CompleteJobOptions, CancellationToken)

Source:
JobRouterClient.cs
Source:
JobRouterClient.cs

Completes an assigned job.

public virtual Azure.Response CompleteJob (Azure.Communication.JobRouter.CompleteJobOptions options, System.Threading.CancellationToken cancellationToken = default);
abstract member CompleteJob : Azure.Communication.JobRouter.CompleteJobOptions * System.Threading.CancellationToken -> Azure.Response
override this.CompleteJob : Azure.Communication.JobRouter.CompleteJobOptions * System.Threading.CancellationToken -> Azure.Response
Public Overridable Function CompleteJob (options As CompleteJobOptions, Optional cancellationToken As CancellationToken = Nothing) As Response

Parameters

options
CompleteJobOptions

Options for completing job.

cancellationToken
CancellationToken

The cancellation token to use.

Returns

Response

Exceptions

RequestFailedException

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

ArgumentNullException

options is null.

Applies to