Attr Method

Returns the value of the specified attribute.

Syntax

rest.attr(attrName, [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, data){ }

'err' is the error that occurred. If there was no error, then 'err' is 'null'.

'data' is the value returned by the method.

'err' has 2 properties which hold detailed information:

err.code
err.message

Remarks

If the attribute does not exist, an empty string is returned if ErrorOnEmptyAttr is set to false, otherwise an exception is thrown.

Please refer to the XAttributes properties for more information.