Click or drag to resize
IQueueingService.ListMessagesAsync Method
This API is preliminary and subject to change.
Gets a list of messages currently in a queue.

Namespace: net.openstack.Core.Providers
Assembly: 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
)

Parameters

queueName
Type: net.openstack.Core.Domain.Queues.QueueName
The queue name.
marker
Type: net.openstack.Core.Domain.Queues.QueuedMessageListId
The identifier of the message list page to return. This is obtained from NextPageId. If this value is null, the list starts at the beginning.
limit
Type: System.Nullable<Int32>
The maximum number of messages to return. If this value is null, a provider-specific default value is used.
echo
Type: System.Boolean
true to include messages created by the current client; otherwise, false.
includeClaimed
Type: System.Boolean
true to include claimed messages; otherwise false to return only unclaimed messages.
cancellationToken
Type: System.Threading.CancellationToken
The CancellationToken that the task will observe.

Return Value

Type: Task<QueuedMessageList>
A 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
ExceptionCondition
ArgumentNullExceptionIf queueName is null.
ArgumentOutOfRangeExceptionIf limit is less than or equal to 0.
WebExceptionIf the REST request does not return successfully.
Version Information

.NET Framework

Supported in: 4.5

openstack.net

Supported in: 1.6, 1.5, 1.4, 1.3.6
See Also