downloads.open() - Content

The open() function of the {{WebExtAPIRef("downloads")}} API opens the downloaded file with its associated application. A {{WebExtAPIRef("downloads.onChanged")}} event fires when the item is opened for the first time.

To use this function in your extension you must ask for the "downloads.open" manifest permission, as well as the "downloads" permission. Also, you can only call this function from inside the handler for a user action.

This is an asynchronous function that returns a Promise.

Syntax

js-nolint

let opening = browser.downloads.open(
  downloadId      // integer
)

Parameters

downloadId
- : An integer representing the id of the {{WebExtAPIRef("downloads.DownloadItem")}} you want to open.

Return value

A Promise. If the request is successful, the promise is fulfilled with no arguments. If the request failed, the promise is rejected with an error message.

Examples

This example opens the most recently downloaded item:

function onOpened() {
  console.log(`Opened download item`);
}

function onError(error) {
  console.log(`Error opening item: ${error}`);
}

function openDownload(downloadItems) {
  if (downloadItems.length > 0) {
    let opening = browser.downloads.open(downloadItems[0].id);
    opening.then(onOpened, onError);
  }
}

let searching = browser.downloads.search({
  limit: 1,
  orderBy: ["-startTime"],
});

searching.then(openDownload, onError);

Browser compatibility

[!NOTE] This API is based on Chromium's chrome.downloads API.