QueueClient.ReceiveMessage Method

Definition

Namespace:

Azure.Storage.Queues

Assembly:

Azure.Storage.Queues.dll

Package:

Azure.Storage.Queues v12.17.1

Source:

QueueClient.cs

Receives one message from the front of the queue.

For more information, see Get Messages.

public virtual Azure.Response<Azure.Storage.Queues.Models.QueueMessage> ReceiveMessage (TimeSpan? visibilityTimeout = default, System.Threading.CancellationToken cancellationToken = default);

abstract member ReceiveMessage : Nullable<TimeSpan> * System.Threading.CancellationToken -> Azure.Response<Azure.Storage.Queues.Models.QueueMessage>
override this.ReceiveMessage : Nullable<TimeSpan> * System.Threading.CancellationToken -> Azure.Response<Azure.Storage.Queues.Models.QueueMessage>

Public Overridable Function ReceiveMessage (Optional visibilityTimeout As Nullable(Of TimeSpan) = Nothing, Optional cancellationToken As CancellationToken = Nothing) As 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

Response<QueueMessage>

Response<T> where T is a QueueMessage