QueueName Property
The name of the current queue.
Syntax
queue.getQueueName([callback]) queue.setQueueName( queueName, [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 getQueueName([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 setQueueName([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 name of the current queue used for operations on a queue. This property must be set before calling the following methods:
- ClearMessages
- CreateMessage
- CreateQueue
- DeleteMessage
- DeleteQueue
- GetQueueMetadata
- ListMessages
- PeekMessages
- SetQueueMetadata
Note: The queue name must be a valid DNS name, conforming to the following naming rules:
- A queue name must start with a letter or number, and may contain only letters, numbers, and the dash (-) character.
- The first and last letters in the queue name must be alphanumeric. The dash (-) character may not be the first or last letter. Consecutive dash characters are not permitted in the queue name; every dash character must be immediately preceded and followed by a letter or number.
- All letters in a queue name must be lowercase.
- A queue name must be from 3 through 63 characters long.
Data Type
String