WL.createBackgroundDownload

Creates a background transfer operation to download a file from Microsoft OneDrive.

This is an async method that returns a Promise object, which allows you to attach events to receive download operations, or handle errors.

Parameters

• properties

  Required. A JSON object that contains the following properties, which are necessary to make the REST API call:

  Name	Type	Description	Default Value
  path	string	Required. The path to the file to download. For information on specifying paths for REST objects, see REST reference.	None
  file_output	Windows.Storage.StorageFile	Optional. The file output object to which the downloaded file data is written.	None

• callback

  Optional. A callback function that is invoked when the download call is complete.

  Note

  Although the callback parameter is still supported, we recommend that you use the Promise object instead, which is described later in this topic.

Return value

Returns a Promise object. This object allows you to attach events to handle success, errors, and progressed situations.

Remarks

A download operation consists of:

• A Guid property that allows you to track the download operation.

• A start() method to start the operation.

If the call is successful, you will receive a download operation in the onSuccess event.

Requirements