downloads.getFileIcon()

The getFileIcon() function of the downloads API retrieves an icon for the specified download.

For new downloads, file icons are available after the downloads.onCreated event has been received. The image returned by this function while a download is in progress may be different from the image returned after the download is complete.

Icon retrieval is done by querying the underlying platform. The icon that is returned will therefore depend on a number of factors including state of the download, platform, registered file types and visual theme.

If a file icon cannot be determined, runtime.lastError will be set with an appropriate error message.

Syntax

chrome.downloads.getFileIcon(
  downloadId,             // integer
  options,                // optional object
  function(iconURL) {...} // function
)

This API is also available as browser.downloads.getFileIcon() in a version that returns a promise.

Parameters

downloadId

An integer representing the ID of the download.

optionsOptional

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

sizeOptional

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.

function

A callback function invoked when the icon has been fetched. The function is passed the following arguments:

iconURLOptional

A string representing the absolute URL of the icon.

Browser compatibility

The compatibility table in this page is generated from structured data. If you'd like to contribute to the data, please check out https://github.com/mdn/browser-compat-data and send us a pull request.

Examples

The following snippet fetches the DownloadItem  for the most recent download. If there is one, it attempts to retrieve the item's icon using getFileIcon().

The callback function updateIconUrl() displays the icon in an <img> element if the call was successful or handles the error case.

function updateIconUrl(iconUrl) {
  if (chrome.runtime.lastError) {
    console.error(chrome.runtime.lastError);
    iconUrl = "";
  }
  var downloadIcon = document.querySelector("#icon");
  downloadIcon.setAttribute("src", iconUrl);
}

function getIconForDownload(downloadItems) {
  if (downloadItems.length > 0) {
    latestDownloadId = downloadItems[0].id;
    chrome.downloads.getFileIcon(latestDownloadId, updateIconUrl);
  }
}

chrome.downloads.search({
  limit: 1,
  orderBy: ["-startTime"]
}, getIconForDownload);

Example add-ons

• latest-download

// Copyright 2015 The Chromium Authors. All rights reserved.
//
// Redistribution and use in source and binary forms, with or without
// modification, are permitted provided that the following conditions are
// met:
//
//    * Redistributions of source code must retain the above copyright
// notice, this list of conditions and the following disclaimer.
//    * Redistributions in binary form must reproduce the above
// copyright notice, this list of conditions and the following disclaimer
// in the documentation and/or other materials provided with the
// distribution.
//    * Neither the name of Google Inc. nor the names of its
// contributors may be used to endorse or promote products derived from
// this software without specific prior written permission.
//
// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
// "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
// LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
// A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
// OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
// SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
// LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
// DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
// THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
// (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
// OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.