MessagesTimeNextVisible Property

The time when the message will be visible to other clients.

Syntax

 queue.getMessagesTimeNextVisible(index, [callback])

Default Value

""

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 getMessagesTimeNextVisible([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 setMessagesTimeNextVisible([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

The time when the message will be visible to other clients. When ListMessages is called, the message will not be visible by other clients until VisibilityTimeout has expired. This property represents the time at which the timeout will expire.

The size of the array is controlled by the MessagesCount property.

This property is read-only and not available at design time.

Data Type

String