VisibilityTimeout Property

The visibility duration in seconds for messages in the queue.

Syntax

 queue.getVisibilityTimeout([callback])
 queue.setVisibilityTimeout( visibilityTimeout, [callback])

Default Value

0

Callback

The 'callback' parameter specifies a function which will be called when the operation completes (or an error is encountered). If the 'callback' parameter is not specified, then the method will block and will not return until the operation completes (or an error is encountered).

The callback for the getVisibilityTimeout([callback]) method is defined as:

function(err, data){ }

'err' is the error that occurred. If there was no error, then 'err' is 'null'.

'data' is the value returned by the method.

The callback for the setVisibilityTimeout([callback]) method is defined as:

function(err){ }

'err' is the error that occurred. If there was no error, then 'err' is 'null'.

'err' has 2 properties which hold detailed information:

err.code
err.message

Remarks

This property controls the visibility timeout in seconds of messages retrieved by calling ListMessages. After the message has been retrieved, it is not visible to other clients for the time interval specified by the VisibilityTimeout.

If this property is set to 0 (default), the Azure service will use the default visibility timeout of 30 seconds.

The maximum value for this property is 7200 (2 hours).

Data Type

Integer