QueueClient.ReceiveMessagesAsync Method

Definition

Namespace:

Azure.Storage.Queues

Assembly:

Azure.Storage.Queues.dll

Package:

Azure.Storage.Queues v12.20.1

Overloads

ReceiveMessagesAsync()	Retrieves one or more messages from the front of the queue. For more information, see Get Messages.
ReceiveMessagesAsync(CancellationToken)	Retrieves one or more messages from the front of the queue. For more information, see Get Messages.
ReceiveMessagesAsync(Nullable<Int32>, Nullable<TimeSpan>, CancellationToken)	Retrieves one or more messages from the front of the queue. For more information, see Get Messages.

ReceiveMessagesAsync()

Source:

QueueClient.cs

Retrieves one or more messages from the front of the queue.

For more information, see Get Messages.

public virtual System.Threading.Tasks.Task<Azure.Response<Azure.Storage.Queues.Models.QueueMessage[]>> ReceiveMessagesAsync ();

abstract member ReceiveMessagesAsync : unit -> System.Threading.Tasks.Task<Azure.Response<Azure.Storage.Queues.Models.QueueMessage[]>>
override this.ReceiveMessagesAsync : unit -> System.Threading.Tasks.Task<Azure.Response<Azure.Storage.Queues.Models.QueueMessage[]>>

Public Overridable Function ReceiveMessagesAsync () As Task(Of Response(Of QueueMessage()))

Returns

Task<Response<QueueMessage[]>>

Response<T> where T is an array of QueueMessage

ReceiveMessagesAsync(CancellationToken)

Source:

QueueClient.cs

Retrieves one or more messages from the front of the queue.

For more information, see Get Messages.

public virtual System.Threading.Tasks.Task<Azure.Response<Azure.Storage.Queues.Models.QueueMessage[]>> ReceiveMessagesAsync (System.Threading.CancellationToken cancellationToken = default);

abstract member ReceiveMessagesAsync : System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<Azure.Storage.Queues.Models.QueueMessage[]>>
override this.ReceiveMessagesAsync : System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<Azure.Storage.Queues.Models.QueueMessage[]>>

Public Overridable Function ReceiveMessagesAsync (Optional cancellationToken As CancellationToken = Nothing) As Task(Of Response(Of QueueMessage()))

Parameters

cancellationToken

CancellationToken

Optional CancellationToken

Returns

Task<Response<QueueMessage[]>>

Response<T> where T is an array of QueueMessage

ReceiveMessagesAsync(Nullable<Int32>, Nullable<TimeSpan>, CancellationToken)

Source:

QueueClient.cs

Retrieves one or more messages from the front of the queue.

For more information, see Get Messages.

public virtual System.Threading.Tasks.Task<Azure.Response<Azure.Storage.Queues.Models.QueueMessage[]>> ReceiveMessagesAsync (int? maxMessages = default, TimeSpan? visibilityTimeout = default, System.Threading.CancellationToken cancellationToken = default);

abstract member ReceiveMessagesAsync : Nullable<int> * Nullable<TimeSpan> * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<Azure.Storage.Queues.Models.QueueMessage[]>>
override this.ReceiveMessagesAsync : Nullable<int> * Nullable<TimeSpan> * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<Azure.Storage.Queues.Models.QueueMessage[]>>

Public Overridable Function ReceiveMessagesAsync (Optional maxMessages As Nullable(Of Integer) = Nothing, Optional visibilityTimeout As Nullable(Of TimeSpan) = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task(Of Response(Of QueueMessage()))

Parameters

maxMessages

Nullable<Int32>

Optional. A nonzero integer value that specifies the number of messages to retrieve from the queue, up to a maximum of 32. If fewer are visible, the visible messages are returned. By default, a single message is retrieved from the queue with this operation.

visibilityTimeout

Nullable<TimeSpan>

Optional. Specifies the new visibility timeout value, in seconds, relative to server time. The default value is 30 seconds.

cancellationToken

CancellationToken

Optional CancellationToken

Returns

Task<Response<QueueMessage[]>>

Response<T> where T is an array of QueueMessage