SetQueueMetadata Method
Sets user-defined metadata on the queue.
Syntax
queue.setQueueMetadata([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 sets the user-defined metadata for the queue specified by QueueName. The current queue's metadata is represents in name value pair form by the Metadata property. AddUserMetadata may be used before calling CreateQueue or SetQueueMetadata.
To update a queue's metadata first call GetQueueMetadata, then make modifications by setting updated values in Metadata and adding new elements with this method. Finally, call SetQueueMetadata
To remove all metadata from a queue, first clear Metadata and then call SetQueueMetadata.
Note: metadata names must adhere to the C# identifier naming rules. See C# Identifier for more details.