LocalDirectory Property

The directory to which received files are saved.

Syntax

 xmpp.getLocalDirectory([callback])
 xmpp.setLocalDirectory( localDirectory, [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 getLocalDirectory([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 setLocalDirectory([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 setting specifies the directory on disk to which received files will be saved. If this property is not set and a file is received the file data will be available through the Transfer event parameters. This property may also be set when the StartTransfer event fires.

Data Type

String