QueueReceiveMessageOptions interface

Package:

@azure/storage-queue

Options to configure <xref:QueueClient.receiveMessages> operation

Extends

MessagesDequeueOptionalParams

Properties

abortSignal	The signal which can be used to abort requests.
customHeaders	will be applied before the request is sent.
numberOfMessages	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.
onDownloadProgress	Callback which fires upon download progress.
onUploadProgress	Callback which fires upon upload progress.
requestId	Provides a client-generated, opaque value with a 1 KB character limit that is recorded in the analytics logs when storage analytics logging is enabled.
serializerOptions	Options to override XML parsing/building behavior.
shouldDeserialize	Whether or not the HttpOperationResponse should be deserialized. If this is undefined, then the HttpOperationResponse should be deserialized.
timeout	The number of milliseconds a request can take before automatically being terminated. If the request is terminated, an AbortError is thrown.
timeoutInSeconds	The The timeout parameter is expressed in seconds. For more information, see Setting Timeouts for Queue Service Operations.
tracingContext	Tracing: Context used when creating spans.
tracingOptions	Options to configure spans created when tracing is enabled.
visibilityTimeout	Optional. Specifies the new visibility timeout value, in seconds, relative to server time. The default value is 30 seconds. A specified value must be larger than or equal to 1 second, and cannot be larger than 7 days, or larger than 2 hours on REST protocol versions prior to version 2011-08-18. The visibility timeout of a message can be set to a value later than the expiry time.

Property Details

abortSignal

The signal which can be used to abort requests.

abortSignal?: AbortSignalLike

Property Value

AbortSignalLike

customHeaders

will be applied before the request is sent.

customHeaders?: [key: string]: string

Property Value

[key: string]: string

numberOfMessages

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.

numberOfMessages?: number

Property Value

number

onDownloadProgress

Callback which fires upon download progress.

onDownloadProgress?: (progress: TransferProgressEvent) => void

Property Value

(progress: TransferProgressEvent) => void

onUploadProgress

Callback which fires upon upload progress.

onUploadProgress?: (progress: TransferProgressEvent) => void

Property Value

(progress: TransferProgressEvent) => void

requestId

Provides a client-generated, opaque value with a 1 KB character limit that is recorded in the analytics logs when storage analytics logging is enabled.

requestId?: string

Property Value

string

serializerOptions

Options to override XML parsing/building behavior.

serializerOptions?: SerializerOptions

Property Value

SerializerOptions

shouldDeserialize

Whether or not the HttpOperationResponse should be deserialized. If this is undefined, then the HttpOperationResponse should be deserialized.

shouldDeserialize?: boolean | (response: HttpOperationResponse) => boolean

Property Value

boolean | (response: HttpOperationResponse) => boolean

timeout

The number of milliseconds a request can take before automatically being terminated. If the request is terminated, an AbortError is thrown.

timeout?: number

Property Value

number

timeoutInSeconds

The The timeout parameter is expressed in seconds. For more information, see Setting Timeouts for Queue Service Operations.

timeoutInSeconds?: number

Property Value

number

tracingContext

Tracing: Context used when creating spans.

tracingContext?: Context

Property Value

Context

tracingOptions

Options to configure spans created when tracing is enabled.

tracingOptions?: OperationTracingOptions

Property Value

OperationTracingOptions

visibilityTimeout

Optional. Specifies the new visibility timeout value, in seconds, relative to server time. The default value is 30 seconds. A specified value must be larger than or equal to 1 second, and cannot be larger than 7 days, or larger than 2 hours on REST protocol versions prior to version 2011-08-18. The visibility timeout of a message can be set to a value later than the expiry time.

visibilityTimeout?: number

Property Value

number