JobRouterClient Class

Definition

The JobRouter service client.

public class JobRouterClient
type JobRouterClient = class
Public Class JobRouterClient
Inheritance
JobRouterClient

Constructors

JobRouterClient()

Initializes a new instance of JobRouterClient for mocking.

JobRouterClient(String, JobRouterClientOptions)

Initializes a new instance of JobRouterClient.

JobRouterClient(Uri, AzureKeyCredential, JobRouterClientOptions)

Initializes a new instance of JobRouterClient.

JobRouterClient(Uri, TokenCredential, JobRouterClientOptions)

Initializes a new instance of JobRouterClient.

Properties

Pipeline

The HTTP pipeline for sending and receiving REST requests and responses.

Methods

AcceptJobOffer(String, String, CancellationToken)

Accepts an offer to work on a job and returns a 409/Conflict if another agent accepted the job already.

AcceptJobOffer(String, String, RequestContext)

[Protocol Method] Accepts an offer to work on a job and returns a 409/Conflict if another agent accepted the job already.

AcceptJobOfferAsync(String, String, CancellationToken)

Accepts an offer to work on a job and returns a 409/Conflict if another agent accepted the job already.

AcceptJobOfferAsync(String, String, RequestContext)

[Protocol Method] Accepts an offer to work on a job and returns a 409/Conflict if another agent accepted the job already.

CancelJob(CancelJobOptions, CancellationToken)

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

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

Closes a completed job.

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

Completes an assigned job.

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.
CompleteJobAsync(CompleteJobOptions, CancellationToken)

Completes an assigned job.

CompleteJobAsync(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.CompleteJobAsync(System.String,System.String,Azure.Communication.JobRouter.CompleteJobOptions,System.Threading.CancellationToken) convenience overload with strongly typed models first.
CreateJob(CreateJobOptions, CancellationToken)

Creates a new job to be routed.

CreateJobAsync(CreateJobOptions, CancellationToken)

Creates a new job to be routed.

CreateJobWithClassificationPolicy(CreateJobWithClassificationPolicyOptions, CancellationToken)

Creates a new job to be routed with classification property.

CreateJobWithClassificationPolicyAsync(CreateJobWithClassificationPolicyOptions, CancellationToken)

Creates a new job to be routed with classification property.

CreateWorker(CreateWorkerOptions, CancellationToken)

Create or update a worker to process jobs.

CreateWorkerAsync(CreateWorkerOptions, CancellationToken)

Create or update a worker to process jobs.

DeclineJobOffer(DeclineJobOfferOptions, CancellationToken)

Declines an offer to work on a job.

DeclineJobOffer(String, String, RequestContent, RequestContext)

[Protocol Method] Declines an offer to work on a 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.DeclineJobOffer(System.String,System.String,Azure.Communication.JobRouter.DeclineJobOfferOptions,System.Threading.CancellationToken) convenience overload with strongly typed models first.
DeclineJobOfferAsync(DeclineJobOfferOptions, CancellationToken)

Declines an offer to work on a job.

DeclineJobOfferAsync(String, String, RequestContent, RequestContext)

[Protocol Method] Declines an offer to work on a 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.DeclineJobOfferAsync(System.String,System.String,Azure.Communication.JobRouter.DeclineJobOfferOptions,System.Threading.CancellationToken) convenience overload with strongly typed models first.
DeleteJob(String, RequestContext)

[Protocol Method] Deletes a job and all of its traces.

  • This protocol method allows explicit creation of the request and processing of the response for advanced scenarios.
DeleteJobAsync(String, RequestContext)

[Protocol Method] Deletes a job and all of its traces.

  • This protocol method allows explicit creation of the request and processing of the response for advanced scenarios.
DeleteWorker(String, RequestContext)

[Protocol Method] Deletes a worker and all of its traces.

  • This protocol method allows explicit creation of the request and processing of the response for advanced scenarios.
DeleteWorkerAsync(String, RequestContext)

[Protocol Method] Deletes a worker and all of its traces.

  • This protocol method allows explicit creation of the request and processing of the response for advanced scenarios.
GetJob(String, CancellationToken)

Retrieves an existing job by Id.

GetJob(String, RequestContext)

[Protocol Method] Retrieves an existing job by Id.

GetJobAsync(String, CancellationToken)

Retrieves an existing job by Id.

GetJobAsync(String, RequestContext)

[Protocol Method] Retrieves an existing job by Id.

GetJobs(Nullable<RouterJobStatusSelector>, String, String, String, Nullable<DateTimeOffset>, Nullable<DateTimeOffset>, CancellationToken)

Retrieves list of jobs based on filter parameters.

GetJobs(String, String, String, String, Nullable<DateTimeOffset>, Nullable<DateTimeOffset>, RequestContext)

[Protocol Method] Retrieves list of jobs based on filter parameters.

  • 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.GetJobs(System.Nullable{System.Int32},System.Nullable{Azure.Communication.JobRouter.RouterJobStatusSelector},System.String,System.String,System.String,System.Nullable{System.DateTimeOffset},System.Nullable{System.DateTimeOffset},System.Threading.CancellationToken) convenience overload with strongly typed models first.
GetJobsAsync(Nullable<RouterJobStatusSelector>, String, String, String, Nullable<DateTimeOffset>, Nullable<DateTimeOffset>, CancellationToken)

Retrieves list of jobs based on filter parameters.

GetJobsAsync(String, String, String, String, Nullable<DateTimeOffset>, Nullable<DateTimeOffset>, RequestContext)

[Protocol Method] Retrieves list of jobs based on filter parameters.

  • 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.GetJobsAsync(System.Nullable{System.Int32},System.Nullable{Azure.Communication.JobRouter.RouterJobStatusSelector},System.String,System.String,System.String,System.Nullable{System.DateTimeOffset},System.Nullable{System.DateTimeOffset},System.Threading.CancellationToken) convenience overload with strongly typed models first.
GetQueuePosition(String, CancellationToken)

Gets a job's position details.

GetQueuePosition(String, RequestContext)

[Protocol Method] Gets a job's position details.

GetQueuePositionAsync(String, CancellationToken)

Gets a job's position details.

GetQueuePositionAsync(String, RequestContext)

[Protocol Method] Gets a job's position details.

GetQueueStatistics(String, CancellationToken)

Retrieves a queue's statistics.

GetQueueStatistics(String, RequestContext)

[Protocol Method] Retrieves a queue's statistics.

GetQueueStatisticsAsync(String, CancellationToken)

Retrieves a queue's statistics.

GetQueueStatisticsAsync(String, RequestContext)

[Protocol Method] Retrieves a queue's statistics.

GetWorker(String, CancellationToken)

Retrieves an existing worker by Id.

GetWorker(String, RequestContext)

[Protocol Method] Retrieves an existing worker by Id.

GetWorkerAsync(String, CancellationToken)

Retrieves an existing worker by Id.

GetWorkerAsync(String, RequestContext)

[Protocol Method] Retrieves an existing worker by Id.

GetWorkers(Nullable<RouterWorkerStateSelector>, String, String, Nullable<Boolean>, CancellationToken)

Retrieves existing workers.

GetWorkers(String, String, String, Nullable<Boolean>, RequestContext)

[Protocol Method] Retrieves existing workers.

  • 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.GetWorkers(System.Nullable{System.Int32},System.Nullable{Azure.Communication.JobRouter.RouterWorkerStateSelector},System.String,System.String,System.Nullable{System.Boolean},System.Threading.CancellationToken) convenience overload with strongly typed models first.
GetWorkersAsync(Nullable<RouterWorkerStateSelector>, String, String, Nullable<Boolean>, CancellationToken)

Retrieves existing workers.

GetWorkersAsync(String, String, String, Nullable<Boolean>, RequestContext)

[Protocol Method] Retrieves existing workers.

  • 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.GetWorkersAsync(System.Nullable{System.Int32},System.Nullable{Azure.Communication.JobRouter.RouterWorkerStateSelector},System.String,System.String,System.Nullable{System.Boolean},System.Threading.CancellationToken) convenience overload with strongly typed models first.
ReclassifyJob(String, CancellationToken)

Reclassify a job.

ReclassifyJob(String, RequestContent, RequestContext)

[Protocol Method] Reclassify a 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.ReclassifyJob(System.String,Azure.Communication.JobRouter.ReclassifyJobOptions,System.Threading.CancellationToken) convenience overload with strongly typed models first.
ReclassifyJobAsync(String, CancellationToken)

Reclassify a job.

ReclassifyJobAsync(String, RequestContent, RequestContext)

[Protocol Method] Reclassify a 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.ReclassifyJobAsync(System.String,Azure.Communication.JobRouter.ReclassifyJobOptions,System.Threading.CancellationToken) convenience overload with strongly typed models first.
UnassignJob(String, String, RequestContent, RequestContext)

[Protocol Method] Unassign a 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.UnassignJob(System.String,System.String,Azure.Communication.JobRouter.UnassignJobOptions,System.Threading.CancellationToken) convenience overload with strongly typed models first.
UnassignJob(UnassignJobOptions, CancellationToken)

Unassign a job.

UnassignJobAsync(String, String, RequestContent, RequestContext)

[Protocol Method] Unassign a 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.UnassignJobAsync(System.String,System.String,Azure.Communication.JobRouter.UnassignJobOptions,System.Threading.CancellationToken) convenience overload with strongly typed models first.
UnassignJobAsync(UnassignJobOptions, CancellationToken)

Unassign a job.

UpdateJob(RouterJob, RequestConditions, CancellationToken)

Update an existing job.

UpdateJob(String, RequestContent, RequestConditions, RequestContext)

[Protocol Method] Updates a router job.

  • This protocol method allows explicit creation of the request and processing of the response for advanced scenarios.
UpdateJobAsync(RouterJob, RequestConditions, CancellationToken)

Update an existing job.

UpdateJobAsync(String, RequestContent, RequestConditions, RequestContext)

[Protocol Method] Updates a router job.

  • This protocol method allows explicit creation of the request and processing of the response for advanced scenarios.
UpdateWorker(RouterWorker, RequestConditions, CancellationToken)

Update a worker to process jobs.

UpdateWorker(String, RequestContent, RequestConditions, RequestContext)

[Protocol Method] Updates a worker.

  • This protocol method allows explicit creation of the request and processing of the response for advanced scenarios.
UpdateWorkerAsync(RouterWorker, RequestConditions, CancellationToken)

Update a worker to process jobs.

UpdateWorkerAsync(String, RequestContent, RequestConditions, RequestContext)

[Protocol Method] Updates a worker.

  • This protocol method allows explicit creation of the request and processing of the response for advanced scenarios.

Applies to