CallbackMode Property

Whether the class should operate in callback mode.

Syntax

 cbvault.getCallbackMode([callback])
 cbvault.setCallbackMode( callbackMode, [callback])

Default Value

FALSE

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 getCallbackMode([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 setCallbackMode([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 whether the class should operate in callback mode, causing all vault access to be performed via the events listed below. Please refer to the Callback Mode topic for more information.

When this property is enabled, the following events must all be implemented in order for the class to function correctly:

Note: This property cannot be changed when Active is true, and cannot be changed within events.

Data Type

Boolean