Cette page a été traduite à partir de l'anglais par la communauté. Vous pouvez également contribuer en rejoignant la communauté francophone sur MDN Web Docs.

downloads.getFileIcon()

La fonction getFileIcon() de l'API downloads récupère une icône pour le téléchargement spécifié.

Pour les nouveaux téléchargements, les icônes de fichiers sont disponibles après la réception de l'événement downloads.onCreated. L'image renvoyée par cette fonction pendant le téléchargement peut être différente de l'image renvoyée une fois le téléchargement terminé.

La récupération d'icônes s'effectue en interrogeant la plateforme sous-jacente. L'icône renvoyée dépendra donc d'un certain nombre de facteurs, notamment l'état du téléchargement, la plate-forme, les types de fichiers enregistrés et le thème visuel.

C'est une fonction asynchrone qui renvoie une Promise.

Syntaxe

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

Paramètres

downloadId

Un integer eprésentant l'ID du téléchargement.

optionsFacultatif

Un object d'options représentant les préférences pour l'icône à extraire. Il peut prendre les propriétés suivantes :

sizeFacultatif

Un integer représentant la taille de l'icône. La taille de l'icône retournée sera la taille fournie au carré (en pixels). Si elle est omise, la taille par défaut de l'icône est 32x32 pixels.

Valeur retournée

Une Promise. Si la requête réussit, la promesse sera remplie avec une chaîne représentant l'URL absolue de l'icône. Si la requête échoue, la promesse sera rejetée avec un message d'erreur.

Compatibilité du navigateur

BCD tables only load in the browser

Exemples

Cet exemple enregistre l'URL de l'icône pour le téléchargement le plus récent :

function gotIcon(iconUrl) {
  console.log(iconUrl);
}

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

function getIcon(downloadItems) {
    if (downloadItems.length > 0) {
      latestDownloadId = downloadItems[0].id;
      var gettingIcon = browser.downloads.getFileIcon(latestDownloadId);
      gettingIcon.then(gotIcon, onError);
    }
  }

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

searching.then(getIcon, onError);

Example extensions

Note :

Cette API est basée sur l'API Chromium chrome.downloads.

Les données de compatibilité relatives à Microsoft Edge sont fournies par Microsoft Corporation et incluses ici sous la licence Creative Commons Attribution 3.0 pour les États-Unis.