Spec-Zone.ru › Web Extensions

downloads.getFileIcon()

Функция getFileIcon() API downloads извлекает значок для указанного загрузки.

Для новых загрузок значки файлов доступны после получения события downloads.onCreated. Изображение, возвращаемое этой функцией во время загрузки, может отличаться от изображения, возвращаемого после завершения загрузки.

Извлечение значка выполняется путем запроса к платформе. Значок, который возвращается, будет зависеть от ряда факторов, включая состояние загрузки, платформу, зарегистрированные типы файлов и визуальную тему.

Это асинхронная функция, которая возвращает Promise.

Синтаксис

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

Параметры

downloadId

Строка, представляющая идентификатор загрузки.

options Необязательно

Объект опций object для получения значка. Он может содержать следующие свойства:

size Необязательно

Числовое значение, представляющее размер значка. Размер возвращаемого значка будет равен предоставленному размеру в квадрате (в пикселях). Если опущено, размер значка по умолчанию составляет 32x32 пикселя.

Возвращаемое значение

A Promise. Если запрос выполнен успешно, промис выполнится со строкой, представляющей абсолютный URL значка. Если запрос завершится ошибкой, промис будет отклонен с сообщением об ошибке.

Совместимость с браузерами

Рабочие столы Мобильные устройства
Chrome Edge Firefox Internet Explorer Opera Safari WebView Android Chrome Android Firefox for Android Opera Android Safari on IOS Samsung Internet
getFileIcon Да 79 48 ? Да Нет ? ? Нет ? Нет ?

Примеры

В этом примере выводится URL значка для последней загрузки:

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);

Примеры расширений

  • latest-download

Примечание: Этот API основан на API chrome.downloads Chromium.

© 2005–2023 MDN contributors.
Licensed under the Creative Commons Attribution-ShareAlike License v2.5 or later.
https://developer.mozilla.org/en-US/docs/Mozilla/Add-ons/WebExtensions/API/downloads/getFileIcon

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API