PeekMessages Method

Retrieves a message from the front of the queue, without changing the message visibility.

Syntax

queue.peekMessages([callback])

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 this 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 method retrieves messages from the queue specified by QueueName. Details of each returned message are available through the Message event or the Messages property.

By default, the class will retrieve only one message. Multiple messages may be retrieved by setting MaxResults.

This method differs from ListMessages in that it does not change the visibility of a message. The messages retrieved here will remain visible to other clients. This method will not populate MessagesPopReceipt.