LocalFile Property

The path to a local file for uploading or downloading an object. When downloading, if the file exists it is overwritten (optional).

Syntax

 gdata.getLocalFile([callback])
 gdata.setLocalFile( localFile, [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 getLocalFile([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 setLocalFile([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 is used when downloading an object via QueryFeed or when uploading an object via UpdateEntry or CustomRequest.

When QueryFeed is called and LocalFile is set to a valid path, the retrieved object data will be written directly to the specified file. If the file already exists, Overwrite will determine if the file gets overwritten.

When UpdateEntry or CustomRequest is called and LocalFile is set to a valid path, the specified file will be used to create the object.

If LocalFile is an empty string, all data received is provided via the TransferredData property and can be specified within the CustomRequest method when uploading.

Data Type

String