IQueueingServiceListMessagesAsync Method |
This API is preliminary and subject to change.
Gets a list of messages currently in a queue.
Namespace: net.openstack.Core.ProvidersAssembly: openstacknet (in openstacknet.dll) Version: 1.7.7+Branch.master.Sha.25d803f397c8693c2c13777ef6675f796f520f2c
Syntax Task<QueuedMessageList> ListMessagesAsync(
QueueName queueName,
QueuedMessageListId marker,
Nullable<int> limit,
bool echo,
bool includeClaimed,
CancellationToken cancellationToken
)
Function ListMessagesAsync (
queueName As QueueName,
marker As QueuedMessageListId,
limit As Nullable(Of Integer),
echo As Boolean,
includeClaimed As Boolean,
cancellationToken As CancellationToken
) As Task(Of QueuedMessageList)
Task<QueuedMessageList^>^ ListMessagesAsync(
QueueName^ queueName,
QueuedMessageListId^ marker,
Nullable<int> limit,
bool echo,
bool includeClaimed,
CancellationToken cancellationToken
)
abstract ListMessagesAsync :
queueName : QueueName *
marker : QueuedMessageListId *
limit : Nullable<int> *
echo : bool *
includeClaimed : bool *
cancellationToken : CancellationToken -> Task<QueuedMessageList>
Parameters
- queueName
- Type: net.openstack.Core.Domain.QueuesQueueName
The queue name. - marker
- Type: net.openstack.Core.Domain.QueuesQueuedMessageListId
The identifier of the message list page to return. This is obtained from NextPageId. If this value is , the list starts at the beginning. - limit
- Type: SystemNullableInt32
The maximum number of messages to return. If this value is , a provider-specific default value is used. - echo
- Type: SystemBoolean
to include messages created by the current client; otherwise, . - includeClaimed
- Type: SystemBoolean
to include claimed messages; otherwise to return only unclaimed messages. - cancellationToken
- Type: System.ThreadingCancellationToken
The CancellationToken that the task will observe.
Return Value
Type:
TaskQueuedMessageListA
Task object representing the asynchronous operation. When the task completes successfully, the
Result property will contain a collection of
QueuedMessage objects describing the messages in the queue.
Exceptions Version Information .NET Framework
Supported in: 4.5
openstack.net
Supported in: 1.6, 1.5, 1.4, 1.3.6
See Also