| IQueueingService Methods |
This API is preliminary and subject to change.
The IQueueingService type exposes the following members.
Methods| Name | Description | |
|---|---|---|
 | ClaimMessageAsync |
Claim messages from a queue.
|
 | CreateQueueAsync |
Creates a queue, if it does not already exist.
|
| DeleteMessageAsync |
Deletes a message from a queue.
|
| DeleteMessagesAsync |
Deletes messages from a queue.
|
| DeleteQueueAsync |
Deletes a queue.
|
| GetHomeAsync |
Gets the home document describing the operations supported by the service.
|
| GetMessageAsync |
Gets detailed information about a specific queued message.
|
| GetMessagesAsync |
Get messages from a queue.
|
| GetNodeHealthAsync |
Checks the queueing service node status.
|
| GetQueueMetadataAsync(QueueName, CancellationToken) |
Gets the metadata associated with a queue.
|
| GetQueueMetadataAsyncT(QueueName, CancellationToken) |
Gets the metadata associated with a queue, as a strongly-typed object.
|
| GetQueueStatisticsAsync |
Gets statistics for a queue.
|
| ListMessagesAsync |
Gets a list of messages currently in a queue.
|
| ListQueuesAsync |
Gets a list of queues.
|
| PostMessagesAsync(QueueName, IEnumerableMessage, CancellationToken) |
Posts messages to a queue.
|
| PostMessagesAsync(QueueName, CancellationToken, Message) |
Posts messages to a queue.
|
| PostMessagesAsyncT(QueueName, IEnumerableMessageT, CancellationToken) |
Posts messages to a queue.
|
| PostMessagesAsyncT(QueueName, CancellationToken, MessageT) |
Posts messages to a queue.
|
| QueryClaimAsync |
Gets detailed information about the current state of a claim.
|
| QueueExistsAsync |
Checks for the existence of a queue with a particular name.
|
| ReleaseClaimAsync |
Immediately release a claim, making any (remaining, non-deleted) messages associated
with the claim available to other workers.
|
| SetQueueMetadataAsyncT |
Sets the metadata associated with a queue.
|
| UpdateClaimAsync |
Renews a claim, by updating the time-to-live and resetting the age of the claim to zero.
|
Extension Methods| Name | Description | |
|---|---|---|
 | ClaimMessage |
Claim messages from a queue.
(Defined by QueueingServiceExtensions.) |
| CreateQueue |
Creates a queue, if it does not already exist.
(Defined by QueueingServiceExtensions.) |
| DeleteMessage |
Deletes a message from a queue.
(Defined by QueueingServiceExtensions.) |
| DeleteMessages |
Deletes messages from a queue.
(Defined by QueueingServiceExtensions.) |
| DeleteQueue |
Deletes a queue.
(Defined by QueueingServiceExtensions.) |
| GetHome |
Gets the home document describing the operations supported by the service.
(Defined by QueueingServiceExtensions.) |
| GetMessage |
Gets detailed information about a specific queued message.
(Defined by QueueingServiceExtensions.) |
| GetMessages |
Get messages from a queue.
(Defined by QueueingServiceExtensions.) |
| GetNodeHealth |
Checks the queueing service node status.
(Defined by QueueingServiceExtensions.) |
| GetQueueMetadata(QueueName) | Overloaded.
Gets the metadata associated with a queue.
(Defined by QueueingServiceExtensions.) |
| GetQueueMetadataT(QueueName) | Overloaded.
Gets the metadata associated with a queue, as a strongly-typed object.
(Defined by QueueingServiceExtensions.) |
| GetQueueStatistics |
Gets statistics for a queue.
(Defined by QueueingServiceExtensions.) |
| ListMessages |
Gets a list of messages currently in a queue.
(Defined by QueueingServiceExtensions.) |
| ListQueues |
Gets a list of queues.
(Defined by QueueingServiceExtensions.) |
| PostMessages(QueueName, IEnumerableMessage) | Overloaded.
Posts messages to a queue.
(Defined by QueueingServiceExtensions.) |
| PostMessages(QueueName, Message) | Overloaded.
Posts messages to a queue.
(Defined by QueueingServiceExtensions.) |
| PostMessagesT(QueueName, IEnumerableMessageT) | Overloaded.
Posts messages to a queue.
(Defined by QueueingServiceExtensions.) |
| PostMessagesT(QueueName, MessageT) | Overloaded.
Posts messages to a queue.
(Defined by QueueingServiceExtensions.) |
| QueryClaim |
Gets detailed information about the current state of a claim.
(Defined by QueueingServiceExtensions.) |
| QueueExists |
Checks for the existence of a queue with a particular name.
(Defined by QueueingServiceExtensions.) |
| ReleaseClaim |
Immediately release a claim, making any (remaining, non-deleted) messages associated
with the claim available to other workers.
(Defined by QueueingServiceExtensions.) |
| SetQueueMetadataT |
Sets the metadata associated with a queue.
(Defined by QueueingServiceExtensions.) |
| UpdateClaim |
Renews a claim, by updating the time-to-live and resetting the age of the claim to zero.
(Defined by QueueingServiceExtensions.) |
See Also