ResourceDownloadURL Property

The URL used to download the file contents.

Syntax

 onedrive.getResourceDownloadURL([callback])
 onedrive.setResourceDownloadURL( resourceDownloadURL, [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 getResourceDownloadURL([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 setResourceDownloadURL([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 holds the URL that is used to download the file contents. This may optionally be set before calling DownloadFile.

This is populated after calling GetResourceInfo ListResources, and UploadFile.

The URL is a short-lived URL that will expire shortly after being created. Authentication is required to download data from this URL.

This property is not available at design time.

Data Type

String