Interface Download

Cancel the transfer. Valid in the following states:

• STARTING,
• QUEUED,
• IN_PROGRESS

Returns

A Promise which will resolve when the transfer has canceled successfully.

Opens destination folder chosen during the download initialization.

This simplifies the process of finding the downloaded file or files on transfer completion but is otherwise not required.

This launches a finder window for Mac or an explorer window for windows

Returns

A Promise which will resolve when the destination folder opens in a file browser.

Retry the incomplete transfer. Valid in the following states

• FAILURE
• CANCELED

Returns

A Promise which will resolve when the retry has been successfully initiated.

Prompts for the destination folder for the downloaded files. This launches a native folder chooser.

Returns

A Promise which will resolve when the destination folder is chosen in native file chooser window

Start the transfer. Valid in the following states:

• IDLE

Returns

A Promise which will resolve when the transfer has started successfully.

Subscribe to a transfer event. Note that all subscriptions will automatically be removed once a download has completed.

Example

addSubscriptions(download: Download) {
    const listener = (data: TransferEventCallbackData): Promise<void> => {
       const { transfer, transferEvent }: TransferEventCallbackData = data;
       const { type, eventData }: TransferEvent = transferEvent;
       switch (type) {
         case TransferEventType.TRANSFER_STARTED:
           //Cast to the associated type of event data
           const progressData: TransferProgressEventData = <TransferProgressEventData>eventData;
           // process as appropriate
           break;
         case TransferEventType.TRANSFER_COMPLETED:
           const completedData: TransferCompletedEventData = <TransferCompletedEventData>eventData;
           // process as appropriate
           break;
       }
    }
    download.subscribe(TransferEventType.TRANSFER_PROGRESS, startListener);
    download.subscribe(TransferEventType.TRANSFER_COMPLETED, startListener);
}

Unsubscribe from a transfer event

Returns

true if the listener was present and unsubscribed, false if there was no match for the eventType / listener combination.

Returns

true when 1 or more listeners were removed.