Package version:

Interface QueueReceiveMessageOptions

Options to configure QueueClient.receiveMessages operation

interface QueueReceiveMessageOptions {
    abortSignal?: any;
    numberOfMessages?: number;
    requestId?: string;
    timeoutInSeconds?: number;
    tracingOptions?: any;
    visibilityTimeout?: number;
}

Hierarchy (view full)

Properties

abortSignal? numberOfMessages? requestId? timeoutInSeconds? tracingOptions? visibilityTimeout?

Properties

OptionalabortSignal

abortSignal?: any

An implementation of the AbortSignalLike interface to signal the request to cancel the operation. For example, use the @azure/abort-controller to create an AbortSignal.

OptionalnumberOfMessages

numberOfMessages?: number

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.

OptionalrequestId

requestId?: string

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.

OptionaltimeoutInSeconds

timeoutInSeconds?: number

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

OptionaltracingOptions

tracingOptions?: any

Options to configure spans created when tracing is enabled.

OptionalvisibilityTimeout

visibilityTimeout?: number

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.

Settings

Member Visibility