Share via

QueueClient.ReceiveMessageAsync Method

  • Reference

Definition

Namespace:
Azure.Storage.Queues
Assembly:
Azure.Storage.Queues.dll
Package:
Azure.Storage.Queues v12.21.0
Package:
Azure.Storage.Queues v12.21.0-beta.2
Source:
QueueClient.cs
Source:
QueueClient.cs

Retrieves one message 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>> ReceiveMessageAsync (TimeSpan? visibilityTimeout = default, System.Threading.CancellationToken cancellationToken = default);
abstract member ReceiveMessageAsync : Nullable<TimeSpan> * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<Azure.Storage.Queues.Models.QueueMessage>>
override this.ReceiveMessageAsync : Nullable<TimeSpan> * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<Azure.Storage.Queues.Models.QueueMessage>>
Public Overridable Function ReceiveMessageAsync (Optional visibilityTimeout As Nullable(Of TimeSpan) = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task(Of Response(Of QueueMessage))

Parameters

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 a QueueMessage

Applies to