chrome.downloads

Cette autorisation déclenche un avertissement.

Description

Utilisez l'API chrome.downloads pour initier, surveiller, manipuler et rechercher des téléchargements par voie programmatique.

Autorisations

downloads

Fichier manifeste

Pour utiliser cette API, vous devez déclarer l'autorisation "downloads" dans le fichier manifeste de l'extension.

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

Exemples

Vous trouverez des exemples simples d'utilisation de l'API chrome.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

    booléen facultatif

  • précédent

    booléen facultatif

DangerType

fichier

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

url

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

contenu

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

peu fréquents

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

hôte

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

indésirables

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

vous protège

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

Acceptée

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

Énumération

"file"

"url"

"content"

"uncommon"

"host"

"unwanted"

"safe"

"accepted"

"allowlistedByPolicy"

"asyncScanning"

"asyncLocalPasswordScanning"

"passwordProtected"

"blockedTooLarge"

"sensitiveContentWarning"

"sensitiveContentBlock"

"deepScannedFailed"

"deepScannedSafe"

"deepScannedOpenedDangerous"

"promptForScanning"

"promptForLocalPasswordScanning"

"accountCompromise"

"blockedScanFailed"

DoubleDelta

Propriétés

  • actuellement

    number facultatif

  • précédent

    number facultatif

DownloadDelta

Propriétés

  • canResume

    BooleanDelta facultatif

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

  • danger

    StringDelta facultatif

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

  • endTime

    StringDelta facultatif

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

  • erreur

    StringDelta facultatif

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

  • existe

    BooleanDelta facultatif

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

  • fileSize

    DoubleDelta facultatif

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

  • filename

    StringDelta facultatif

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

  • finalUrl

    StringDelta facultatif

    Chrome 54 et versions ultérieures

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

  • id

    Total

    Le id de DownloadItem qui a été modifié.

  • mime

    StringDelta facultatif

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

  • mis en veille

    BooleanDelta facultatif

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

  • startTime

    StringDelta facultatif

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

  • state

    StringDelta facultatif

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

  • totalBytes

    DoubleDelta facultatif

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

  • url

    StringDelta facultatif

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

DownloadItem

Propriétés

  • byExtensionId

    chaîne facultative

    Identifiant de l'extension qui a lancé ce téléchargement, si c'est le cas. Il ne change pas une fois défini.

  • byExtensionName

    chaîne facultative

    Nom localisé de l'extension qui a lancé ce téléchargement, si c'est le cas. Cette valeur peut changer si l'extension change de nom ou si l'utilisateur modifie ses paramètres régionaux.

  • bytesReceived

    Total

    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 s'est arrêté.

  • danger

    DangerType

    Indique si ce téléchargement est considéré comme sûr ou suspect.

  • endTime

    chaîne facultative

    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_, celles 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 facultative

    Heure estimée 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.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 de fichiers. Appelez search() pour déclencher la vérification de 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 la fin de la vérification de l'existence 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

    Total

    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 et versions ultérieures

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

  • id

    Total

    Identifiant persistant d'une session de navigation à 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

    La valeur est "true" si le téléchargement a cessé de lire les données de l'hôte, mais a conservé 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

    Total

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

  • 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 facultative

    Corps de l'article.

  • conflictAction

    FilenameConflictAction facultatif

    Action à effectuer si filename existe déjà.

  • filename

    chaîne facultative

    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 ".." génèrent une erreur. onDeterminingFilename permet de suggérer un nom de fichier une fois que le type MIME et un nom 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

    booléen facultatif

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

  • url

    chaîne

    URL de téléchargement.

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 suspect.

  • endTime

    chaîne facultative

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

  • endedAfter

    chaîne facultative

    Limite les résultats aux DownloadItem qui se sont terminés après le nombre de millisecondes indiqué au format ISO 8601

  • endedBefore

    chaîne facultative

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

  • erreur

    InterruptReason facultatif

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

  • existe

    booléen facultatif

    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 facultative

    Chemin d'accès local absolu.

  • filenameRegex

    chaîne facultative

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

  • finalUrl

    chaîne facultative

    Chrome 54 et versions ultérieures

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

  • finalUrlRegex

    chaîne facultative

    Chrome 54 et versions ultérieures

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

  • id

    number facultatif

    id du DownloadItem à interroger.

  • limite

    number facultatif

    Nombre maximal de DownloadItem correspondants renvoyés. La valeur par défaut est 1 000. Définissez la valeur sur 0 pour renvoyer toutes les DownloadItem correspondantes. Pour savoir comment parcourir les résultats, consultez search.

  • mime

    chaîne facultative

    Type MIME du fichier.

  • orderBy

    string[] facultatif

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

  • mis en veille

    booléen facultatif

    La valeur est "true" si le téléchargement a cessé de lire les données de l'hôte, mais a conservé la connexion ouverte.

  • requête

    string[] facultatif

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

  • startTime

    chaîne facultative

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

  • startedAfter

    chaîne facultative

    Limite les résultats aux DownloadItem qui ont commencé après le nombre de millisecondes indiqué au format ISO 8601.

  • startedBefore

    chaîne facultative

    Limite les résultats aux DownloadItem qui ont commencé avant la date donnée en millisecondes au format ISO 8601.

  • state

    État 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, ou -1 si la valeur est inconnue.

  • totalBytesGreater

    number facultatif

    Limite les résultats à DownloadItem dont totalBytes est supérieur à l'entier donné.

  • totalBytesLess

    number facultatif

    Limite les résultats à DownloadItem dont totalBytes est inférieur à l'entier donné.

  • url

    chaîne facultative

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

  • urlRegex

    chaîne facultative

    Limite les résultats aux DownloadItem dont le url correspond à l'expression régulière indiqué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 remplacé par le nouveau fichier.

requête

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 DownloadItem.filename cible de DownloadItem, sous la forme d'un chemin d'accès relatif au répertoire de téléchargements par défaut de l'utilisateur, pouvant contenir des sous-répertoires. Les chemins absolus, les chemins vides et les chemins 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. L'icône sera carrée et mesurera "taille" x "taille" pixels. La taille par défaut et la plus grande taille pour l'icône sont de 32 x 32 pixels. Les seules tailles acceptées sont 16 et 32. Toute autre taille spécifiée sera considérée comme une erreur.

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.

interrompue

Une erreur a interrompu la connexion avec l'hébergeur de fichiers.

terminé

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

Énumération

"in_progress"

"interrupted"

"complete"

StringDelta

Propriétés

  • actuellement

    chaîne facultative

  • précédent

    chaîne facultative

UiOptions

Chrome 105 et versions ultérieures

Propriétés

  • activé

    booléen

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

Méthodes

acceptDanger()

Promise 
chrome.downloads.acceptDanger(
  downloadId: number,
  callback?: function,
): Promise<void>

Invitez l'utilisateur à accepter un téléchargement dangereux. Ne peut être appelé que depuis 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 est déclenché. Dans le cas contraire, 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 risque a été accepté, le fichier temporaire est renommé avec le nom de fichier cible, state passe à "complete" et onChanged est déclenché.

Paramètres

  • downloadId

    Total

    Identifiant de DownloadItem.

  • callback

    function facultatif

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

    () => void

Renvoie

  • Promise<void>

    Chrome 96 et versions ultérieures

    Les promesses ne sont compatibles qu'avec Manifest V3 et les versions ultérieures. Les autres plates-formes doivent utiliser des rappels.

cancel()

Promise 
chrome.downloads.cancel(
  downloadId: number,
  callback?: function,
): 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

    Total

    ID du téléchargement à annuler.

  • callback

    function facultatif

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

    () => void

Renvoie

  • Promise<void>

    Chrome 96 et versions ultérieures

    Les promesses ne sont compatibles qu'avec Manifest V3 et les versions ultérieures. Les autres plates-formes doivent utiliser des rappels.

download()

Promise 
chrome.downloads.download(
  options: DownloadOptions,
  callback?: function,
): Promise<number>

Téléchargez une URL. Si l'URL utilise le protocole HTTP[S], la requête inclut tous les cookies actuellement définis pour son nom d'hôte. Si les options filename et saveAs sont spécifiées, la boîte de dialogue "Enregistrer sous" s'affiche, préremplie avec la valeur filename spécifiée. Si le téléchargement a bien démarré, callback sera appelé avec le nouveau downloadId de 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 procéder

  • callback

    function facultatif

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

    (downloadId: number) => void

    • downloadId

      Total

Renvoie

  • Promise<number>

    Chrome 96 et versions ultérieures

    Les promesses ne sont compatibles qu'avec Manifest V3 et les versions ultérieures. Les autres plates-formes doivent utiliser des rappels.

erase()

Promise 
chrome.downloads.erase(
  query: DownloadQuery,
  callback?: function,
): Promise<number[]>

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

Paramètres

  • requête

    DownloadQuery

  • callback

    function facultatif

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

    (erasedIds: number[]) => void

    • erasedIds

      number[]

Renvoie

  • Promise<number[]>

    Chrome 96 et versions ultérieures

    Les promesses ne sont compatibles qu'avec Manifest V3 et les versions ultérieures. Les autres plates-formes doivent utiliser des rappels.

getFileIcon()

Promise 
chrome.downloads.getFileIcon(
  downloadId: number,
  options?: GetFileIconOptions,
  callback?: function,
): 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 l'événement onCreated reçu. L'image renvoyée par cette fonction pendant le 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 l'ensemble d'outils sous-jacents en fonction de la plate-forme. L'icône renvoyée dépendra donc d'un certain nombre de facteurs, y compris l'état du téléchargement, la plate-forme, les types de fichiers enregistrés et le thème visuel. Si une icône de fichier ne peut pas être déterminée, runtime.lastError contiendra un message d'erreur.

Paramètres

  • downloadId

    Total

    Identifiant du téléchargement.

  • options

    GetFileIconOptions facultatif

  • callback

    function facultatif

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

    (iconURL?: string) => void

    • iconURL

      chaîne facultative

Renvoie

  • Promise<string | undefined>

    Chrome 96 et versions ultérieures

    Les promesses ne sont compatibles qu'avec Manifest V3 et les versions ultérieures. Les autres plates-formes doivent utiliser des rappels.

open()

Promise 
chrome.downloads.open(
  downloadId: number,
  callback?: function,
): 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

    Total

    Identifiant du fichier téléchargé.

  • callback

    function facultatif

    Chrome 123 et versions ultérieures

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

    () => void

Renvoie

  • Promise<void>

    Chrome 123 et versions ultérieures

    Les promesses ne sont compatibles qu'avec Manifest V3 et les versions ultérieures. Les autres plates-formes doivent utiliser des rappels.

pause()

Promise 
chrome.downloads.pause(
  downloadId: number,
  callback?: function,
): Promise<void>

Mettez le téléchargement en pause. Si la requête a abouti, le téléchargement est 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

    Total

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

  • callback

    function facultatif

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

    () => void

Renvoie

  • Promise<void>

    Chrome 96 et versions ultérieures

    Les promesses ne sont compatibles qu'avec Manifest V3 et les versions ultérieures. Les autres plates-formes doivent utiliser des rappels.

removeFile()

Promise 
chrome.downloads.removeFile(
  downloadId: number,
  callback?: function,
): 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

    Total

  • callback

    function facultatif

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

    () => void

Renvoie

  • Promise<void>

    Chrome 96 et versions ultérieures

    Les promesses ne sont compatibles qu'avec Manifest V3 et les versions ultérieures. Les autres plates-formes doivent utiliser des rappels.

resume()

Promise 
chrome.downloads.resume(
  downloadId: number,
  callback?: function,
): Promise<void>

Reprenez 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

    Total

    ID du téléchargement à reprendre.

  • callback

    function facultatif

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

    () => void

Renvoie

  • Promise<void>

    Chrome 96 et versions ultérieures

    Les promesses ne sont compatibles qu'avec Manifest V3 et les versions ultérieures. Les autres plates-formes doivent utiliser des rappels.

Promise 
chrome.downloads.search(
  query: DownloadQuery,
  callback?: function,
): 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

Renvoie

  • Promise<DownloadItem[]>

    Chrome 96 et versions ultérieures

    Les promesses ne sont compatibles qu'avec Manifest V3 et les versions ultérieures. Les autres plates-formes doivent utiliser des rappels.

setShelfEnabled()

Obsolète depuis Chrome 117
chrome.downloads.setShelfEnabled(
  enabled: boolean,
): void

Utilisez plutôt setUiOptions.

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

Paramètres

  • activé

    booléen

setUiOptions()

Promise Chrome 105 et versions ultérieures 
chrome.downloads.setUiOptions(
  options: UiOptions,
  callback?: function,
): Promise<void>

Modifier l'UI 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'interface utilisateur de téléchargement sera 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

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

  • callback

    function facultatif

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

    () => void

Renvoie

  • Promise<void>

    Les promesses ne sont compatibles qu'avec Manifest V3 et les versions ultérieures. Les autres plates-formes doivent utiliser des rappels.

show()

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

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

Paramètres

  • downloadId

    Total

    Identifiant du fichier téléchargé.

showDefaultFolder()

chrome.downloads.showDefaultFolder(): void

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

Événements

onChanged

chrome.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 est déclenché avec 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

onCreated

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

Cet événement est déclenché 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

onDeterminingFilename

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

Lors de la détermination du nom de fichier, les extensions auront la possibilité de remplacer le DownloadItem.filename cible. Chaque extension ne peut enregistrer qu'un seul écouteur pour cet événement. Chaque écouteur doit appeler suggest exactement une 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 et ne renvoie pas true, suggest est appelé automatiquement. DownloadItem ne se termine que lorsque tous les écouteurs ont 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 est prioritaire. Pour éviter toute confusion quant à l'extension qui sera utilisée, les utilisateurs ne doivent pas installer d'extensions susceptibles d'entrer en conflit. Si le téléchargement est lancé par download et que le nom de fichier cible est connu avant que le type MIME et le nom de fichier provisoire aient été déterminés, transmettez filename à download à la place.

Paramètres

  • callback

    fonction

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

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

onErased

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

Déclenché avec 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

      Total