QueuePrefix Property

If set, ListQueues will only return queues that begin with this prefix.

Syntax

 queue.getQueuePrefix([callback])
 queue.setQueuePrefix( queuePrefix, [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 getQueuePrefix([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 setQueuePrefix([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 may be set before calling ListQueues to filter the results. If this property is set, when ListQueues is called the server will only return queues that begin with the specified prefix.

This property is not available at design time.

Data Type

String