AccountRole Property

The role of the user.

Syntax

 box.getAccountRole([callback])

Possible Values

  0 (urUser), 
  1 (urCoadmin), 
  2 (urAdmin)

Default Value

0

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 getAccountRole([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 setAccountRole([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 role of the user. Possible values are:

• 0 (urUser)
• 1 (urCoadmin)
• 2 (urAdmin)

This property is read-only.

Data Type

Integer