DownloadFile Method

Downloads the currently selected file.

Syntax

gdrive.downloadFile(fileFormat, [callback])

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 this 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 method downloads the file selected by ResourceIndex. If LocalFile is set the file will be saved to the specified location. If LocalFile is not set the file data will be held by ResourceData.

The FileFormat parameter specifies the formatting to be applied when saving the file, such as "text/plain". Specify an empty string for this parameter to use the default format for the file. Possible formats may be found by querying the ResourceFormats property.

Note: The file to be downloaded may be selected by calling either ListResources or GetResourceInfo and setting ResourceIndex, or simply by setting ResourceId before calling this method.