JobRouterClient.GetQueuePositionAsync Method

Definition

Namespace:

Azure.Communication.JobRouter

Assembly:

Azure.Communication.JobRouter.dll

Package:

Azure.Communication.JobRouter v1.0.0

Overloads

GetQueuePositionAsync(String, CancellationToken)	Gets a job's position details.
GetQueuePositionAsync(String, RequestContext)	[Protocol Method] Gets a job's position details. This protocol method allows explicit creation of the request and processing of the response for advanced scenarios. Please try the simpler GetQueuePositionAsync(String, CancellationToken) convenience overload with strongly typed models first.

GetQueuePositionAsync(String, CancellationToken)

Source:

JobRouterClient.cs

Gets a job's position details.

public virtual System.Threading.Tasks.Task<Azure.Response<Azure.Communication.JobRouter.RouterJobPositionDetails>> GetQueuePositionAsync (string jobId, System.Threading.CancellationToken cancellationToken = default);

abstract member GetQueuePositionAsync : string * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<Azure.Communication.JobRouter.RouterJobPositionDetails>>
override this.GetQueuePositionAsync : string * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<Azure.Communication.JobRouter.RouterJobPositionDetails>>

Public Overridable Function GetQueuePositionAsync (jobId As String, Optional cancellationToken As CancellationToken = Nothing) As Task(Of Response(Of RouterJobPositionDetails))

Parameters

jobId

String

Id of the job.

cancellationToken

CancellationToken

The cancellation token to use.

Returns

Task<Response<RouterJobPositionDetails>>

Exceptions

RequestFailedException

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

ArgumentNullException

jobId is null.

ArgumentException

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

GetQueuePositionAsync(String, RequestContext)

Source:

JobRouterClient.cs

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

• This protocol method allows explicit creation of the request and processing of the response for advanced scenarios.
• Please try the simpler GetQueuePositionAsync(String, CancellationToken) convenience overload with strongly typed models first.

public virtual System.Threading.Tasks.Task<Azure.Response> GetQueuePositionAsync (string jobId, Azure.RequestContext context);

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

Public Overridable Function GetQueuePositionAsync (jobId As String, context As RequestContext) As Task(Of Response)

Parameters

jobId

String

Id of the job.

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.