JobRouterClient.GetQueuePositionAsync Method
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
GetQueuePositionAsync(String, CancellationToken) |
Gets a job's position details. |
GetQueuePositionAsync(String, RequestContext) |
[Protocol Method] Gets a job's position details.
|
- Source:
- JobRouterClient.cs
- 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
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
Azure SDK for .NET Preview and Azure SDK for .NET Latest
Product | Versions |
---|---|
Azure SDK for .NET | Latest, Preview |
- Source:
- JobRouterClient.cs
- 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
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
Azure SDK for .NET Preview and Azure SDK for .NET Latest
Product | Versions |
---|---|
Azure SDK for .NET | Latest, Preview |
Azure SDK for .NET feedback
Azure SDK for .NET is an open source project. Select a link to provide feedback: