JobRouterClient.GetQueuePosition Method

Definition

Overloads

GetQueuePosition(String, RequestContext)

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

GetQueuePosition(String, CancellationToken)

Gets a job's position details.

GetQueuePosition(String, RequestContext)

Source:
JobRouterClient.cs
Source:
JobRouterClient.cs

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

public virtual Azure.Response GetQueuePosition (string jobId, Azure.RequestContext context);
abstract member GetQueuePosition : string * Azure.RequestContext -> Azure.Response
override this.GetQueuePosition : string * Azure.RequestContext -> Azure.Response
Public Overridable Function GetQueuePosition (jobId As String, context As RequestContext) As 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

The response returned from the service.

Exceptions

jobId is null.

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

Service returned a non-success status code.

Applies to

GetQueuePosition(String, CancellationToken)

Source:
JobRouterClient.cs
Source:
JobRouterClient.cs

Gets a job's position details.

public virtual Azure.Response<Azure.Communication.JobRouter.RouterJobPositionDetails> GetQueuePosition (string jobId, System.Threading.CancellationToken cancellationToken = default);
abstract member GetQueuePosition : string * System.Threading.CancellationToken -> Azure.Response<Azure.Communication.JobRouter.RouterJobPositionDetails>
override this.GetQueuePosition : string * System.Threading.CancellationToken -> Azure.Response<Azure.Communication.JobRouter.RouterJobPositionDetails>
Public Overridable Function GetQueuePosition (jobId As String, Optional cancellationToken As CancellationToken = Nothing) As Response(Of RouterJobPositionDetails)

Parameters

jobId
String

Id of the job.

cancellationToken
CancellationToken

The cancellation token to use.

Returns

Exceptions

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

jobId is null.

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

Applies to