ResourceName Property

The name of the resource.

Syntax

 box.getResourceName([callback])
 box.setResourceName( resourceName, [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 getResourceName([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 setResourceName([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 specifies the name of the resource.

Naming restrictions:

• Names must be 255 characters or less.
• Names with non-printable ASCII are not supported.
• Names with the characters "/", "\", or trailing whitespace are not supported.
• The special names "." and ".." are not supported.

Data Type

String