browser.downloads

Description

Utilisez l'API chrome.downloads pour lancer, surveiller, manipuler et rechercher des téléchargements de manière programmatique.

Autorisations

downloads

Vous devez déclarer l'autorisation "downloads" dans le fichier manifeste de l'extension pour utiliser cette API.

{
  "name": "My extension",
  ...
  "permissions": [
    "downloads"
  ],
}

Exemples

Vous trouverez des exemples simples d'utilisation de l'API browser.downloads dans le répertoire examples/api/downloads. Pour obtenir d'autres exemples et de l'aide pour afficher le code source, consultez Exemples.

Types

BooleanDelta

Propriétés

• actuellement

  boolean facultatif

• précédent

  boolean facultatif

DangerType

Énumération

"file"
Le nom du fichier téléchargé est suspect.

"url"
L'URL du téléchargement est connue pour être malveillante.

"content"
Le fichier téléchargé est connu pour être malveillant.

"uncommon"
L'URL du téléchargement n'est pas souvent téléchargée et peut être dangereuse.

"host"
Le téléchargement provient d'un hôte connu pour distribuer des binaires malveillants et est probablement dangereux.

"unwanted"
Le téléchargement est potentiellement indésirable ou dangereux. Par exemple, il peut modifier les paramètres du navigateur ou de l'ordinateur.

"safe"
Le téléchargement ne présente aucun danger connu pour l'ordinateur de l'utilisateur.

"accepted"
L'utilisateur a accepté le téléchargement dangereux.

"allowlistedByPolicy"
Valeurs liées à l'entreprise.

"asyncScanning"

"asyncLocalPasswordScanning"

"passwordProtected"

"blockedTooLarge"

"sensitiveContentWarning"

"sensitiveContentBlock"

"deepScannedFailed"

"deepScannedSafe"

"deepScannedOpenedDangerous"

"promptForScanning"

"promptForLocalPasswordScanning"

"accountCompromise"

"blockedScanFailed"

"forceSaveToGdrive"
À utiliser par l'extension Secure Enterprise Browser. Si nécessaire, Chrome bloque le téléchargement sur le disque et télécharge le fichier directement dans Google Drive.

"forceSaveToOnedrive"
À utiliser par l'extension Secure Enterprise Browser. Si nécessaire, Chrome bloque le téléchargement sur le disque et télécharge le fichier directement sur OneDrive.

DoubleDelta

Propriétés

• actuellement

  number facultatif

• précédent

  number facultatif

DownloadDelta

Propriétés

• canResume

  BooleanDelta facultatif

  La modification de canResume, le cas échéant.

• danger

  StringDelta facultatif

  La modification de danger, le cas échéant.

• endTime

  StringDelta facultatif

  La modification de endTime, le cas échéant.

• erreur

  StringDelta facultatif

  La modification de error, le cas échéant.

• existe

  BooleanDelta facultatif

  La modification de exists, le cas échéant.

• fileSize

  DoubleDelta facultatif

  La modification de fileSize, le cas échéant.

• filename

  StringDelta facultatif

  La modification de filename, le cas échéant.

• finalUrl

  StringDelta facultatif

  Chrome 54 ou version ultérieure browser.* depuis Chrome 148

  La modification de finalUrl, le cas échéant.

• id

  nombre

  id de l'élément DownloadItem qui a été modifié.

• mime

  StringDelta facultatif

  La modification de mime, le cas échéant.

• mis en veille

  BooleanDelta facultatif

  La modification de paused, le cas échéant.

• startTime

  StringDelta facultatif

  La modification de startTime, le cas échéant.

• state

  StringDelta facultatif

  La modification de state, le cas échéant.

• totalBytes

  DoubleDelta facultatif

  La modification de totalBytes, le cas échéant.

• url

  StringDelta facultatif

  La modification de url, le cas échéant.

DownloadItem

Propriétés

• byExtensionId

  chaîne facultatif

  Identifiant de l'extension qui a lancé ce téléchargement, si celui-ci a été lancé par une extension. Ne change pas une fois défini.

• byExtensionName

  chaîne facultatif

  Nom localisé de l'extension qui a lancé ce téléchargement, si celui-ci a été lancé par une extension. Peut changer si l'extension change de nom ou si l'utilisateur change de paramètres régionaux.

• bytesReceived

  nombre

  Nombre d'octets reçus jusqu'à présent de l'hôte, sans tenir compte de la compression des fichiers.

• canResume

  booléen

  "True" si le téléchargement est en cours et mis en pause, ou s'il est interrompu et peut être repris là où il a été interrompu.

• danger

  DangerType

  Indique si ce téléchargement est considéré comme sûr ou s'il est connu pour être suspect.

• endTime

  chaîne facultatif

  Heure de fin du téléchargement au format ISO 8601. Peut être transmis directement au constructeur Date : chrome.downloads.search({}, function(items){items.forEach(function(item){if (item.endTime) console.log(new Date(item.endTime))})})

• erreur

  InterruptReason facultatif

  Pourquoi le téléchargement a été interrompu. Plusieurs types d'erreurs HTTP peuvent être regroupés sous l'une des erreurs commençant par SERVER_. Les erreurs liées au réseau commencent par NETWORK_, les erreurs liées au processus d'écriture du fichier dans le système de fichiers commencent par FILE_ et les interruptions initiées par l'utilisateur commencent par USER_.

• estimatedEndTime

  chaîne facultatif

  Heure estimée de la fin du téléchargement, au format ISO 8601. Peut être transmis directement au constructeur Date : chrome.downloads.search({}, function(items){items.forEach(function(item){if (item.estimatedEndTime) console.log(new Date(item.estimatedEndTime))})})

• existe

  booléen

  Indique si le fichier téléchargé existe toujours. Ces informations peuvent être obsolètes, car Chrome ne surveille pas automatiquement la suppression des fichiers. Appelez search() pour vérifier l'existence du fichier. Une fois la vérification de l'existence terminée, si le fichier a été supprimé, un événement onChanged est déclenché. Notez que search() n'attend pas que la vérification de l'existence soit terminée avant de renvoyer un résultat. Par conséquent, les résultats de search() peuvent ne pas refléter précisément le système de fichiers. De plus, search() peut être appelé aussi souvent que nécessaire, mais ne vérifiera pas l'existence du fichier plus d'une fois toutes les 10 secondes.

• fileSize

  nombre

  Nombre d'octets dans l'ensemble du fichier après décompression, ou -1 si inconnu.

• filename

  chaîne

  Chemin d'accès local absolu.

• finalUrl

  chaîne

  Chrome 54 ou version ultérieure browser.* depuis Chrome 148

  URL absolue à partir de laquelle ce téléchargement est effectué, après toutes les redirections.

• id

  nombre

  Identifiant persistant d'une session de navigateur à l'autre.

• navigation privée

  booléen

  "False" si ce téléchargement est enregistré dans l'historique, "true" s'il ne l'est pas.

• mime

  chaîne

  Type MIME du fichier.

• mis en veille

  booléen

  "True" si le téléchargement a cessé de lire les données de l'hôte, mais a maintenu la connexion ouverte.

• URL de provenance

  chaîne

  URL absolue.

• startTime

  chaîne

  Heure à laquelle le téléchargement a commencé, au format ISO 8601. Peut être transmis directement au constructeur Date : chrome.downloads.search({}, function(items){items.forEach(function(item){console.log(new Date(item.startTime))})})

• state

  État

  Indique si le téléchargement est en cours, interrompu ou terminé.

• totalBytes

  nombre

  Nombre d'octets dans l'ensemble du fichier, sans tenir compte de la compression de fichier, ou -1 si inconnu.

• url

  chaîne

  URL absolue à partir de laquelle ce téléchargement a été lancé, avant toute redirection.

DownloadOptions

Propriétés

• body

  chaîne facultatif

  Corps du post.

• conflictAction

  FilenameConflictAction facultatif

  Action à effectuer si filename existe déjà.

• filename

  chaîne facultatif

  Chemin d'accès au fichier par rapport au répertoire "Téléchargements" pour contenir le fichier téléchargé, pouvant contenir des sous-répertoires. Les chemins absolus, les chemins vides et les chemins contenant des références arrière « .. » provoquent une erreur. onDeterminingFilename permet de suggérer un nom de fichier une fois que le type MIME du fichier et un nom de fichier provisoire ont été déterminés.

• headers

  HeaderNameValuePair[] facultatif

  En-têtes HTTP supplémentaires à envoyer avec la requête si l'URL utilise le protocole HTTP[s]. Chaque en-tête est représenté sous la forme d'un dictionnaire contenant les clés name et value ou binaryValue, limitées à celles autorisées par XMLHttpRequest.

• method

  HttpMethod facultatif

  Méthode HTTP à utiliser si l'URL utilise le protocole HTTP[S].

• saveAs

  boolean facultatif

  Utilisez un sélecteur de fichiers pour permettre à l'utilisateur de sélectionner un nom de fichier, que filename soit défini ou existe déjà.

• url

  chaîne

  URL à télécharger.

DownloadQuery

Propriétés

• bytesReceived

  number facultatif

  Nombre d'octets reçus jusqu'à présent de l'hôte, sans tenir compte de la compression des fichiers.

• danger

  DangerType facultatif

  Indique si ce téléchargement est considéré comme sûr ou s'il est connu pour être suspect.

• endTime

  chaîne facultatif

  Heure de fin du téléchargement au format ISO 8601.

• endedAfter

  chaîne facultatif

  Limite les résultats aux DownloadItem qui se sont terminés après la milliseconde indiquée au format ISO 8601

• endedBefore

  chaîne facultatif

  Limite les résultats aux DownloadItem qui se sont terminés avant la milliseconde indiquée au format ISO 8601.

• erreur

  InterruptReason facultatif

  Pourquoi un téléchargement a été interrompu.

• existe

  boolean facultatif

  Indique si le fichier téléchargé existe.

• fileSize

  number facultatif

  Nombre d'octets dans l'ensemble du fichier après décompression, ou -1 si inconnu.

• filename

  chaîne facultatif

  Chemin d'accès local absolu.

• filenameRegex

  chaîne facultatif

  Limite les résultats aux DownloadItem dont le filename correspond à l'expression régulière donnée.

• finalUrl

  chaîne facultatif

  Chrome 54 ou version ultérieure browser.* depuis Chrome 148

  URL absolue à partir de laquelle ce téléchargement est effectué, après toutes les redirections.

• finalUrlRegex

  chaîne facultatif

  Chrome 54 ou version ultérieure browser.* depuis Chrome 148

  Limite les résultats aux DownloadItem dont le finalUrl correspond à l'expression régulière donnée.

• id

  number facultatif

  id de l'DownloadItem à interroger.

• limite

  number facultatif

  Nombre maximal de DownloadItem correspondants renvoyés. La valeur par défaut est de 1 000. Définissez cette valeur sur 0 pour renvoyer tous les DownloadItem correspondants. Consultez search pour savoir comment parcourir les résultats.

• mime

  chaîne facultatif

  Type MIME du fichier.

• orderBy

  string[] facultatif

  Définissez les éléments de ce tableau sur les propriétés DownloadItem afin de trier les résultats de recherche. Par exemple, la définition de orderBy=['startTime'] trie les DownloadItem par heure de début, dans l'ordre croissant. Pour spécifier l'ordre décroissant, ajoutez un trait d'union en préfixe : "-startTime".

• mis en veille

  boolean facultatif

  "True" si le téléchargement a cessé de lire les données de l'hôte, mais a maintenu la connexion ouverte.

• requête

  string[] facultatif

  Ce tableau de termes de recherche limite les résultats aux DownloadItem dont les champs filename, url ou finalUrl contiennent tous les termes de recherche qui ne commencent pas par un tiret "-" et aucun des termes de recherche qui commencent par un tiret.

• startTime

  chaîne facultatif

  Heure à laquelle le téléchargement a commencé, au format ISO 8601.

• startedAfter

  chaîne facultatif

  Limite les résultats aux DownloadItem qui ont commencé après la milliseconde indiquée au format ISO 8601.

• startedBefore

  chaîne facultatif

  Limite les résultats aux DownloadItem qui ont commencé avant la milliseconde indiquée au format ISO 8601.

• state

  State (facultatif)

  Indique si le téléchargement est en cours, interrompu ou terminé.

• totalBytes

  number facultatif

  Nombre d'octets dans l'ensemble du fichier, sans tenir compte de la compression de fichier, ou -1 si inconnu.

• totalBytesGreater

  number facultatif

  Limite les résultats aux DownloadItem dont la valeur totalBytes est supérieure à l'entier donné.

• totalBytesLess

  number facultatif

  Limite les résultats aux DownloadItem dont la valeur totalBytes est inférieure à l'entier donné.

• url

  chaîne facultatif

  URL absolue à partir de laquelle ce téléchargement a été lancé, avant toute redirection.

• urlRegex

  chaîne facultatif

  Limite les résultats aux DownloadItem dont le url correspond à l'expression régulière donnée.

FilenameConflictAction

uniquify

Pour éviter les doublons, le filename est modifié pour inclure un compteur avant l'extension du nom de fichier.

écraser

Le fichier existant sera écrasé par le nouveau fichier.

prompt

Une boîte de dialogue de sélection de fichiers s'affiche.

Énumération

"uniquify"

"overwrite"

"prompt"

FilenameSuggestion

Propriétés

• conflictAction

  FilenameConflictAction facultatif

  Action à effectuer si filename existe déjà.

• filename

  chaîne

  Nouvelle cible DownloadItem.filename de DownloadItem, sous la forme d'un chemin d'accès relatif au répertoire "Téléchargements" par défaut de l'utilisateur, pouvant contenir des sous-répertoires. Les chemins d'accès absolus, les chemins d'accès vides et les chemins d'accès contenant des références arrière ".." seront ignorés. filename est ignoré si des écouteurs onDeterminingFilename sont enregistrés par des extensions.

GetFileIconOptions

Propriétés

• taille

  number facultatif

  Taille de l'icône renvoyée en pixels indépendants de la densité (DIP). La valeur doit être 16 ou 32 (32 par défaut). Sur les écrans haute résolution, l'image renvoyée est mise à l'échelle en fonction du facteur de scaling de l'appareil (par exemple, 64 x 64 px pour une taille de 32 sur un écran 2x). Les appels provenant de service workers en arrière-plan sont définis par défaut sur une échelle de 1x.

HeaderNameValuePair

Propriétés

• nom

  chaîne

  Nom de l'en-tête HTTP.

• valeur

  chaîne

  Valeur de l'en-tête HTTP.

HttpMethod

Énumération

"GET"

"POST"

InterruptReason

Énumération

"FILE_FAILED"

"FILE_ACCESS_DENIED"

"FILE_NO_SPACE"

"FILE_NAME_TOO_LONG"

"FILE_TOO_LARGE"

"FILE_VIRUS_INFECTED"

"FILE_TRANSIENT_ERROR"

"FILE_BLOCKED"

"FILE_SECURITY_CHECK_FAILED"

"FILE_TOO_SHORT"

"FILE_HASH_MISMATCH"

"FILE_SAME_AS_SOURCE"

"NETWORK_FAILED"

"NETWORK_TIMEOUT"

"NETWORK_DISCONNECTED"

"NETWORK_SERVER_DOWN"

"NETWORK_INVALID_REQUEST"

"SERVER_FAILED"

"SERVER_NO_RANGE"

"SERVER_BAD_CONTENT"

"SERVER_UNAUTHORIZED"

"SERVER_CERT_PROBLEM"

"SERVER_FORBIDDEN"

"SERVER_UNREACHABLE"

"SERVER_CONTENT_LENGTH_MISMATCH"

"SERVER_CROSS_ORIGIN_REDIRECT"

"USER_CANCELED"

"USER_SHUTDOWN"

"CRASH"

State

in_progress

Le téléchargement reçoit actuellement des données du serveur.

interrompu

Une erreur a interrompu la connexion avec l'hôte du fichier.

terminé

Le téléchargement a bien été effectué.

Énumération

"in_progress"

"interrupted"

"complete"

StringDelta

Propriétés

• actuellement

  chaîne facultatif

• précédent

  chaîne facultatif

UiOptions

Chrome 105 et versions ultérieures browser.* depuis Chrome 148

Propriétés

• activé

  booléen

  Activez ou désactivez l'interface utilisateur de téléchargement.

Méthodes

acceptDanger()

browser.downloads.acceptDanger(
  downloadId: number,
): Promise<void>

Inviter l'utilisateur à accepter un téléchargement dangereux. Ne peut être appelée qu'à partir d'un contexte visible (onglet, fenêtre ou pop-up d'action de page/navigateur). N'accepte pas automatiquement les téléchargements dangereux. Si le téléchargement est accepté, un événement onChanged se déclenche. Sinon, rien ne se passe. Lorsque toutes les données sont récupérées dans un fichier temporaire et que le téléchargement n'est pas dangereux ou que le danger a été accepté, le fichier temporaire est renommé avec le nom de fichier cible, l'état state passe à "complete" et onChanged se déclenche.

Paramètres

• downloadId

  nombre

  Identifiant de l'objet DownloadItem.

Renvoie

• Promise<void>

  Chrome 96+ browser.* depuis Chrome 148

  Renvoie une promesse qui se résout lorsque la boîte de dialogue d'invite de danger se ferme.

cancel()

browser.downloads.cancel(
  downloadId: number,
): Promise<void>

Annuler un téléchargement Lorsque callback est exécuté, le téléchargement est annulé, terminé, interrompu ou n'existe plus.

Paramètres

• downloadId

  nombre

  ID du téléchargement à annuler.

Renvoie

• Promise<void>

  Chrome 96+ browser.* depuis Chrome 148

  Renvoie une promesse qui se résout lorsque la demande d'annulation est terminée.

download()

browser.downloads.download(
  options: DownloadOptions,
): Promise<number>

Télécharger une URL Si l'URL utilise le protocole HTTP[S], la requête inclura tous les cookies actuellement définis pour son nom d'hôte. Si filename et saveAs sont tous deux spécifiés, la boîte de dialogue "Enregistrer sous" s'affiche, préremplie avec le filename spécifié. Si le téléchargement a bien démarré, callback sera appelé avec le downloadId du nouveau DownloadItem. Si une erreur s'est produite lors du démarrage du téléchargement, callback sera appelé avec downloadId=undefined et runtime.lastError contiendra une chaîne descriptive. Il n'est pas garanti que les chaînes d'erreur restent rétrocompatibles entre les versions. Les extensions ne doivent pas l'analyser.

Paramètres

• options

  DownloadOptions

  Quels éléments télécharger et comment.

Renvoie

• Promise<number>

  Chrome 96+ browser.* depuis Chrome 148

  Renvoie une promesse qui se résout avec l'ID du nouveau DownloadItem.

erase()

browser.downloads.erase(
  query: DownloadQuery,
): Promise<number[]>

Effacez les DownloadItem correspondants de l'historique sans supprimer le fichier téléchargé. Un événement onErased sera déclenché pour chaque DownloadItem correspondant à query, puis callback sera appelé.

Paramètres

• requête

  DownloadQuery

Renvoie

• Promise<number[]>

  Chrome 96+ browser.* depuis Chrome 148

getFileIcon()

browser.downloads.getFileIcon(
  downloadId: number,
  options?: GetFileIconOptions,
): Promise<string | undefined>

Récupère une icône pour le téléchargement spécifié. Pour les nouveaux téléchargements, les icônes de fichier sont disponibles une fois que le nom du fichier cible du téléchargement a été déterminé (par exemple, lorsque onChanged se déclenche avec une modification de filename). Si vous tentez de récupérer l'icône avant que le nom de fichier ne soit déterminé, une erreur sera générée via runtime.lastError. L'image renvoyée par cette fonction pendant un téléchargement peut être différente de celle renvoyée une fois le téléchargement terminé. La récupération des icônes s'effectue en interrogeant le système d'exploitation ou le kit d'outils sous-jacent, selon la plate-forme. L'icône renvoyée dépend donc de plusieurs facteurs, y compris l'état du téléchargement, la plate-forme, les types de fichiers enregistrés et le thème visuel. Si l'icône d'un fichier ne peut pas être déterminée, runtime.lastError contiendra un message d'erreur.

Paramètres

• downloadId

  nombre

  Identifiant du téléchargement.

• options

  GetFileIconOptions facultatif

Renvoie

• Promise<string | undefined>

  Chrome 96+ browser.* depuis Chrome 148

  Renvoie une promesse qui se résout avec l'URL d'une image représentant le téléchargement.

open()

browser.downloads.open(
  downloadId: number,
): Promise<void>

Ouvre le fichier téléchargé maintenant si DownloadItem est terminé. Sinon, renvoie une erreur via runtime.lastError. Cette méthode nécessite l'autorisation "downloads.open" en plus de l'autorisation "downloads". Un événement onChanged se déclenche lorsque l'élément est ouvert pour la première fois. Cette méthode ne peut être appelée qu'en réponse à un geste de l'utilisateur.

Paramètres

• downloadId

  nombre

  Identifiant du fichier téléchargé.

Renvoie

• Promise<void>

  Chrome 123+ browser.* depuis Chrome 148

pause()

browser.downloads.pause(
  downloadId: number,
): Promise<void>

Mettre en pause le téléchargement. Si la requête a abouti, le téléchargement est suspendu. Sinon, runtime.lastError contient un message d'erreur. La requête échouera si le téléchargement n'est pas actif.

Paramètres

• downloadId

  nombre

  ID du téléchargement à mettre en pause.

Renvoie

• Promise<void>

  Chrome 96+ browser.* depuis Chrome 148

  Renvoie une promesse qui se résout lorsque la demande de mise en pause est terminée.

removeFile()

browser.downloads.removeFile(
  downloadId: number,
): Promise<void>

Supprimez le fichier téléchargé s'il existe et que DownloadItem est terminé. Sinon, renvoyez une erreur via runtime.lastError.

Paramètres

• downloadId

  nombre

Renvoie

• Promise<void>

  Chrome 96+ browser.* depuis Chrome 148

resume()

browser.downloads.resume(
  downloadId: number,
): Promise<void>

Reprendre un téléchargement suspendu. Si la requête a abouti, le téléchargement est en cours et n'est pas mis en pause. Sinon, runtime.lastError contient un message d'erreur. La requête échouera si le téléchargement n'est pas actif.

Paramètres

• downloadId

  nombre

  ID du téléchargement à reprendre.

Renvoie

• Promise<void>

  Chrome 96+ browser.* depuis Chrome 148

  Renvoie une promesse qui se résout lorsque la requête de reprise est terminée.

search()

browser.downloads.search(
  query: DownloadQuery,
): Promise<DownloadItem[]>

Recherchez DownloadItem. Définissez query sur l'objet vide pour obtenir tous les DownloadItem. Pour obtenir un DownloadItem spécifique, définissez uniquement le champ id. Pour parcourir un grand nombre d'éléments, définissez orderBy: ['-startTime'], définissez limit sur le nombre d'éléments par page et définissez startedAfter sur le startTime du dernier élément de la dernière page.

Paramètres

• requête

  DownloadQuery

Renvoie

• thought Promise<DownloadItem[]>

  Chrome 96+ browser.* depuis Chrome 148

setShelfEnabled()

Obsolète depuis Chrome 117

browser.downloads.setShelfEnabled(
  enabled: boolean,
): void

Utilisez plutôt setUiOptions.

Activez ou désactivez l'étagère grise en bas de chaque fenêtre associée au profil de navigateur actuel. La barre d'état sera désactivée tant qu'au moins une extension l'aura désactivée. Si vous activez la barre d'état alors qu'au moins une autre extension l'a désactivée, une erreur est renvoyée via runtime.lastError. Nécessite l'autorisation "downloads.shelf" en plus de l'autorisation "downloads".

Paramètres

• activé

  booléen

setUiOptions()

Chrome 105 et versions ultérieures browser.* depuis Chrome 148

browser.downloads.setUiOptions(
  options: UiOptions,
): Promise<void>

Modifiez l'interface utilisateur de téléchargement de chaque fenêtre associée au profil de navigateur actuel. Tant qu'au moins une extension a défini UiOptions.enabled sur "false", l'UI de téléchargement est masquée. Si vous définissez UiOptions.enabled sur "true" alors qu'au moins une autre extension l'a désactivé, une erreur sera renvoyée via runtime.lastError. Nécessite l'autorisation "downloads.ui" en plus de l'autorisation "downloads".

Paramètres

• options

  UiOptions

  Encapsuler une modification de l'UI de téléchargement.

Renvoie

• Promise<void>

  Renvoie une promesse qui se résout une fois la mise à jour de l'UI terminée.

show()

browser.downloads.show(
  downloadId: number,
): void

Affichez le fichier téléchargé dans son dossier dans un gestionnaire de fichiers.

Paramètres

• downloadId

  nombre

  Identifiant du fichier téléchargé.

showDefaultFolder()

browser.downloads.showDefaultFolder(): void

Afficher le dossier "Téléchargements" par défaut dans un gestionnaire de fichiers.

Événements

onChanged

browser.downloads.onChanged.addListener(
  callback: function,
)

Lorsque l'une des propriétés d'un DownloadItem change (à l'exception de bytesReceived et estimatedEndTime), cet événement se déclenche avec le downloadId et un objet contenant les propriétés qui ont changé.

Paramètres

• callback

  fonction

  Le paramètre callback se présente comme suit :

  (downloadDelta: DownloadDelta) => void

  • downloadDelta

    DownloadDelta

onCreated

browser.downloads.onCreated.addListener(
  callback: function,
)

Cet événement se déclenche avec l'objet DownloadItem lorsqu'un téléchargement commence.

Paramètres

• callback

  fonction

  Le paramètre callback se présente comme suit :

  (downloadItem: DownloadItem) => void

  • downloadItem

    DownloadItem

onDeterminingFilename

browser.downloads.onDeterminingFilename.addListener(
  callback: function,
)

Lors du processus de détermination du nom de fichier, les extensions pourront remplacer le DownloadItem.filename cible. Chaque extension ne peut pas enregistrer plus d'un écouteur pour cet événement. Chaque écouteur doit appeler suggest une seule fois, de manière synchrone ou asynchrone. Si l'écouteur appelle suggest de manière asynchrone, il doit renvoyer true. Si l'écouteur n'appelle pas suggest de manière synchrone ni ne renvoie true, suggest sera appelé automatiquement. DownloadItem ne se terminera pas tant que tous les écouteurs n'auront pas appelé suggest. Les écouteurs peuvent appeler suggest sans aucun argument pour permettre au téléchargement d'utiliser downloadItem.filename pour son nom de fichier, ou transmettre un objet suggestion à suggest pour remplacer le nom de fichier cible. Si plusieurs extensions remplacent le nom de fichier, la dernière extension installée dont l'écouteur transmet un objet suggestion à suggest l'emporte. Pour éviter toute confusion quant à l'extension qui l'emportera, les utilisateurs ne doivent pas installer d'extensions susceptibles d'entrer en conflit. Si le téléchargement est initié par download et que le nom de fichier cible est connu avant que le type MIME et le nom de fichier provisoire n'aient été déterminés, transmettez plutôt filename à download.

Paramètres

• callback

  fonction

  Le paramètre callback se présente comme suit :

  (downloadItem: DownloadItem, suggest: function) => void

  • downloadItem

    DownloadItem

  • suggest

    fonction

    Le paramètre suggest se présente comme suit :

    (suggestion?: FilenameSuggestion) => void

    • suggestion

      FilenameSuggestion facultatif

onErased

browser.downloads.onErased.addListener(
  callback: function,
)

Se déclenche avec l'downloadId lorsqu'un téléchargement est effacé de l'historique.

Paramètres

• callback

  fonction

  Le paramètre callback se présente comme suit :

  (downloadId: number) => void

  • downloadId

    nombre