downloads.getFileIcon()

Syntax

let gettingIcon = browser.downloads.getFileIcon(
  downloadId,           // integer
  options               // optional object
)

Parameters

downloadId

An integer representing the ID of the download.

options Optional

An options object representing preferences for the icon to be retrieved. It can take the following properties:

size Optional

An integer representing the size of the icon. The returned icon's size will be the provided size squared (in pixels). If omitted, the default size for the icon is 32x32 pixels.

Return value

A Promise. If the request succeeds, the promise will be fulfilled with a string representing the absolute URL of the icon. If the request fails, the promise will be rejected with an error message.

Examples

This example logs the icon URL for the most recent download:

function gotIcon(iconUrl) {
  console.log(iconUrl);
}
function onError(error) {
  console.log(`Error: ${error}`);
}
function getIcon(downloadItems) {
  if (downloadItems.length > 0) {
    latestDownloadId = downloadItems[0].id;
    let gettingIcon = browser.downloads.getFileIcon(latestDownloadId);
    gettingIcon.then(gotIcon, onError);
  }
}
let searching = browser.downloads.search({
  limit: 1,
  orderBy: ["-startTime"],
});
searching.then(getIcon, onError);

Example extensions

• latest-download

Browser compatibility