chrome.downloads

Description

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

Autorisations

downloads

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 concernant l'affichage du code source, consultez la section Exemples.

Types

BooleanDelta

Propriétés

  • en cours

    Booléen facultatif

  • précédent

    Booléen facultatif

DangerType

fichier

Le nom de fichier du téléchargement est suspect.

url

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

de qualité, inédits, adaptés et variés

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

rare

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 binaires malveillants. Il est probablement dangereux.

non souhaité

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

entreprises sécurisées

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

accepté(s)

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

Enum

"file"

"url"

"content"

"uncommon"

"host"

"unwanted"

"asyncScanning"

"asyncLocalPasswordScanning"

"passwordProtected"

"blockedTooLarge"

"sensitiveContentWarning"

"sensitiveContentBlock"

"promptForScanning"

"promptForLocalPasswordScanning"

"accountCompromise"

"blockedScanFailed"

DoubleDelta

Propriétés

  • en cours

    numéro facultatif

  • précédent

    numéro facultatif

DownloadDelta

Propriétés

  • canResume

    BooleanDelta facultatif

    Modification de canResume, le cas échéant.

  • Danger

    StringDelta facultatif

    Modification de danger, le cas échéant.

  • endTime

    StringDelta facultatif

    Modification de endTime, le cas échéant.

  • error

    StringDelta facultatif

    Modification de error, le cas échéant.

  • existe

    BooleanDelta facultatif

    Modification de exists, le cas échéant.

  • fileSize

    DoubleDelta facultatif

    Modification de fileSize, le cas échéant.

  • filename

    StringDelta facultatif

    Modification de filename, le cas échéant.

  • finalUrl

    StringDelta facultatif

    Chrome 54 et versions ultérieures

    Modification de finalUrl, le cas échéant.

  • id

    Nombre

    id de DownloadItem qui a été modifié.

  • mime

    StringDelta facultatif

    Modification de mime, le cas échéant.

  • mis en veille

    BooleanDelta facultatif

    Modification de paused, le cas échéant.

  • startTime

    StringDelta facultatif

    Modification de startTime, le cas échéant.

  • state

    StringDelta facultatif

    Modification de state, le cas échéant.

  • totalBytes

    DoubleDelta facultatif

    Modification de totalBytes, le cas échéant.

  • url

    StringDelta facultatif

    Modification de url, le cas échéant.

DownloadItem

Propriétés

  • byExtensionId

    string facultatif

    Identifiant de l'extension qui a lancé ce téléchargement, s'il a été lancé par une extension. Ne change pas une fois défini.

  • byExtensionName

    string facultatif

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

  • bytesReceived

    Nombre

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

  • canResume

    boolean

    Défini sur "true" si le téléchargement est en cours et en pause, ou s'il est interrompu et peut être relancé à partir de l'endroit où il a été interrompu.

  • Danger

    DangerType

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

  • endTime

    string facultatif

    Heure à laquelle le téléchargement s'est terminé, au format ISO 8601. Peut être transmis directement au constructeur de date: chrome.downloads.search({}, function(items){items.forEach(function(item){if (item.endTime) console.log(new Date(item.endTime))})})

  • error

    InterruptReason facultatif

    Raison pour laquelle 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

    string facultatif

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

  • existe

    boolean

    Indique si le fichier téléchargé existe toujours. Ces informations peuvent être obsolètes, car Chrome ne recherche pas automatiquement la suppression des fichiers. Appelez search() pour déclencher la vérification de l'existence d'un fichier. Une fois la vérification d'existence terminée, si le fichier a été supprimé, un événement onChanged se déclenche. Notez que search() n'attend pas la fin de la vérification d'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. En outre, la fonction search() peut être appelée aussi souvent que nécessaire, mais ne vérifie pas l'existence des fichiers 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 et versions ultérieures

    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

    boolean

    "false" si le téléchargement est enregistré dans l'historique, "true" dans le cas contraire.

  • mime

    chaîne

    Type MIME du fichier.

  • mis en veille

    boolean

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

  • referrer

    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 de 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 du 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

    string facultatif

    Corps du post.

  • conflictAction

    FilenameConflictAction facultatif

    Action à effectuer si filename existe déjà.

  • filename

    string facultatif

    Chemin d'accès relatif au répertoire des téléchargements pour contenir le fichier téléchargé, contenant éventuellement des sous-répertoires. Les chemins absolus, vides et 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 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

    Booléen facultatif

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

  • url

    chaîne

    URL à télécharger.

DownloadQuery

Propriétés

  • bytesReceived

    numéro facultatif

    Nombre d'octets reçus jusqu'à présent depuis 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é d'être suspect.

  • endTime

    string facultatif

    Heure à laquelle le téléchargement s'est terminé, au format ISO 8601.

  • endedAfter

    string facultatif

    Limite les résultats à DownloadItem qui se termine après le ms donnés au format ISO 8601

  • endedBefore

    string facultatif

    Limite les résultats au format ISO 8601 à DownloadItem qui se termine avant le ms donné.

  • error

    InterruptReason facultatif

    Raisons pour lesquelles un téléchargement a été interrompu.

  • existe

    Booléen facultatif

    Indique si le fichier téléchargé existe

  • fileSize

    numéro facultatif

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

  • filename

    string facultatif

    Chemin d'accès local absolu.

  • filenameRegex

    string facultatif

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

  • finalUrl

    string facultatif

    Chrome 54 et versions ultérieures

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

  • finalUrlRegex

    string facultatif

    Chrome 54 et versions ultérieures

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

  • id

    numéro facultatif

    Le id du DownloadItem à interroger.

  • limite

    numéro 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

    string 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, si vous définissez orderBy=['startTime'], les DownloadItem sont triées par heure de début dans l'ordre croissant. Pour spécifier l'ordre décroissant, ajoutez un trait d'union au début: "-startTime".

  • mis en veille

    Booléen facultatif

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

  • requête

    string[] facultatif

    Ce tableau de termes de recherche limite les résultats à DownloadItem dont le champ filename, url ou finalUrl contient tous les termes de recherche qui ne commencent pas par un tiret -, ni aucun des termes de recherche commençant par un tiret.

  • startTime

    string facultatif

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

  • startedAfter

    string facultatif

    Limite les résultats à DownloadItem qui ont commencé après le ms donnés au format ISO 8601.

  • startedBefore

    string facultatif

    Limite les résultats à DownloadItem qui ont commencé avant les millisecondes indiquées, au format ISO 8601.

  • state

    État facultatif

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

  • totalBytes

    numéro facultatif

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

  • totalBytesGreater

    numéro facultatif

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

  • totalBytesLess

    numéro facultatif

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

  • url

    string facultatif

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

  • urlRegex

    string facultatif

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

FilenameConflictAction

uniquifier

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

Écraser

Le fichier existant sera remplacé par le nouveau fichier.

invite

L'utilisateur sera invité à sélectionner un sélecteur de fichier.

Enum

"uniquify"

FilenameSuggestion

Propriétés

  • conflictAction

    FilenameConflictAction facultatif

    Action à effectuer si filename existe déjà.

  • filename

    chaîne

    Nouvelle cible DownloadItem.filename de DownloadItem, en tant que chemin relatif au répertoire de téléchargements par défaut de l'utilisateur, contenant éventuellement des sous-répertoires Les chemins absolus, vides et contenant des références arrière ".." sont ignorés. filename est ignoré s'il existe des écouteurs onDeterminingFilename enregistrés par des extensions.

GetFileIconOptions

Propriétés

  • taille

     facultatif

    Taille de l'icône affichée. L'icône est carrée, avec des dimensions x dimensions en pixels. Par défaut, la taille maximale de l'icône est de 32 x 32 pixels. Les seules tailles acceptées sont 16 et 32. Toute autre taille ne doit pas être spécifiée.

HeaderNameValuePair

Propriétés

  • name

    chaîne

    Nom de l'en-tête HTTP.

  • valeur

    chaîne

    Valeur de l'en-tête HTTP.

HttpMethod

Enum

InterruptReason

Enum

"FILE_FAILED"

"FILE_ACCESS_DENIED"

"FILE_NO_SPACE"

"FILE_VIRUS_INFECTED"

"FILE_TRANSIENT_ERROR"

"FILE_BLOCKED"

"FILE_SECURITY_CHECK_FAILED"

"FILE_TOO_SHORT"

"FILE_HASH_MISMATCH"

"FILE_SAME_AS_SOURCE"

"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 à l'hôte du fichier.

terminé

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

Enum

"in_progress"

"complete"

StringDelta

Propriétés

  • en cours

    string facultatif

  • précédent

    string facultatif

UiOptions

Chrome 105 et versions ultérieures

Propriétés

  • activé

    boolean

    Activer ou désactiver l'interface utilisateur de téléchargement

Méthodes

acceptDanger()

Promesse 
chrome.downloads.acceptDanger(
  downloadId: number,
  callback?: function,
)

Inviter l'utilisateur à accepter un téléchargement dangereux Elle ne peut être appelée que depuis un contexte visible (onglet, fenêtre ou pop-up d'action sur la page ou dans le navigateur). Les téléchargements dangereux ne sont pas automatiquement acceptés. 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 extraites 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é en nom de fichier cible, state passe à "complete" et onChanged se déclenche.

Paramètres

  • downloadId

    Nombre

    Identifiant de DownloadItem.

  • rappel

    fonction facultative

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

    ()=>void

Renvoie

  • Promise<void>

    Chrome 96 et versions ultérieures

    Les promesses sont compatibles avec Manifest V3 et les versions ultérieures, mais des rappels sont fournis pour assurer la rétrocompatibilité. Vous ne pouvez pas utiliser les deux dans le même appel de fonction. La promesse est résolue avec le même type que celui transmis au rappel.

cancel()

Promesse 
chrome.downloads.cancel(
  downloadId: number,
  callback?: function,
)

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.

  • rappel

    fonction facultative

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

    ()=>void

Renvoie

  • Promise<void>

    Chrome 96 et versions ultérieures

    Les promesses sont compatibles avec Manifest V3 et les versions ultérieures, mais des rappels sont fournis pour assurer la rétrocompatibilité. Vous ne pouvez pas utiliser les deux dans le même appel de fonction. La promesse est résolue avec le même type que celui transmis au rappel.

download()

Promesse 
chrome.downloads.download(
  options: DownloadOptions,
  callback?: function,
)

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 champs filename et saveAs sont tous les deux spécifiés, la boîte de dialogue "Enregistrer sous" s'affiche. Elle contient déjà les informations filename spécifiées. Si le téléchargement a démarré, callback est appelé avec le nouveau downloadId de DownloadItem. Si une erreur s'est produite lors du démarrage du téléchargement, callback est appelé avec downloadId=undefined, et runtime.lastError contient 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

    Quoi télécharger et comment

  • rappel

    fonction facultative

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

    (downloadId: number)=>void

    • downloadId

      Nombre

Renvoie

  • Promesse<number>

    Chrome 96 et versions ultérieures

    Les promesses sont compatibles avec Manifest V3 et les versions ultérieures, mais des rappels sont fournis pour assurer la rétrocompatibilité. Vous ne pouvez pas utiliser les deux dans le même appel de fonction. La promesse est résolue avec le même type que celui transmis au rappel.

erase()

Promesse 
chrome.downloads.erase(
  query: DownloadQuery,
  callback?: function,
)

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

Paramètres

  • requête

    DownloadQuery

  • rappel

    fonction facultative

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

    (erasedIds: number[])=>void

    • erasedIds

      nombre[]

Renvoie

  • Promesse<number[]>

    Chrome 96 et versions ultérieures

    Les promesses sont compatibles avec Manifest V3 et les versions ultérieures, mais des rappels sont fournis pour assurer la rétrocompatibilité. Vous ne pouvez pas utiliser les deux dans le même appel de fonction. La promesse est résolue avec le même type que celui transmis au rappel.

getFileIcon()

Promesse 
chrome.downloads.getFileIcon(
  downloadId: number,
  options?: GetFileIconOptions,
  callback?: function,
)

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 après la réception de l'événement onCreated. L'image renvoyée par cette fonction lorsqu'un téléchargement est en cours peut être différente de l'image 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-jacents, en fonction de la plate-forme. L'icône affichée dépend 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 contient un message d'erreur.

Paramètres

  • downloadId

    Nombre

    Identifiant du téléchargement.

  • options

    GetFileIconOptions facultatif

  • rappel

    fonction facultative

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

    (iconURL?: string)=>void

    • iconURL

      string facultatif

Renvoie

  • Promesse<string|undefined>

    Chrome 96 et versions ultérieures

    Les promesses sont compatibles avec Manifest V3 et les versions ultérieures, mais des rappels sont fournis pour assurer la rétrocompatibilité. Vous ne pouvez pas utiliser les deux dans le même appel de fonction. La promesse est résolue avec le même type que celui transmis au rappel.

open()

Promesse 
chrome.downloads.open(
  downloadId: number,
  callback?: function,
)

Ouvre le fichier téléchargé 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é.

  • rappel

    fonction facultative

    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 sont compatibles avec Manifest V3 et les versions ultérieures, mais des rappels sont fournis pour assurer la rétrocompatibilité. Vous ne pouvez pas utiliser les deux dans le même appel de fonction. La promesse est résolue avec le même type que celui transmis au rappel.

pause()

Promesse 
chrome.downloads.pause(
  downloadId: number,
  callback?: function,
)

Interrompez 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 échoue si le téléchargement n'est pas actif.

Paramètres

  • downloadId

    Nombre

    ID du téléchargement à suspendre.

  • rappel

    fonction facultative

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

    ()=>void

Renvoie

  • Promise<void>

    Chrome 96 et versions ultérieures

    Les promesses sont compatibles avec Manifest V3 et les versions ultérieures, mais des rappels sont fournis pour assurer la rétrocompatibilité. Vous ne pouvez pas utiliser les deux dans le même appel de fonction. La promesse est résolue avec le même type que celui transmis au rappel.

removeFile()

Promesse 
chrome.downloads.removeFile(
  downloadId: number,
  callback?: function,
)

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

Paramètres

  • downloadId

    Nombre

  • rappel

    fonction facultative

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

    ()=>void

Renvoie

  • Promise<void>

    Chrome 96 et versions ultérieures

    Les promesses sont compatibles avec Manifest V3 et les versions ultérieures, mais des rappels sont fournis pour assurer la rétrocompatibilité. Vous ne pouvez pas utiliser les deux dans le même appel de fonction. La promesse est résolue avec le même type que celui transmis au rappel.

resume()

Promesse 
chrome.downloads.resume(
  downloadId: number,
  callback?: function,
)

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

Paramètres

  • downloadId

    Nombre

    ID du téléchargement à reprendre.

  • rappel

    fonction facultative

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

    ()=>void

Renvoie

  • Promise<void>

    Chrome 96 et versions ultérieures

    Les promesses sont compatibles avec Manifest V3 et les versions ultérieures, mais des rappels sont fournis pour assurer la rétrocompatibilité. Vous ne pouvez pas utiliser les deux dans le même appel de fonction. La promesse est résolue avec le même type que celui transmis au rappel.

Promesse 
chrome.downloads.search(
  query: DownloadQuery,
  callback?: function,
)

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'], limit sur le nombre d'éléments par page, et startedAfter sur la startTime du dernier élément de la dernière page.

Paramètres

Renvoie

  • Promise<DownloadItem[]>

    Chrome 96 et versions ultérieures

    Les promesses sont compatibles avec Manifest V3 et les versions ultérieures, mais des rappels sont fournis pour assurer la rétrocompatibilité. Vous ne pouvez pas utiliser les deux dans le même appel de fonction. La promesse est résolue avec le même type que celui transmis au rappel.

setShelfEnabled()

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

Utilisez setUiOptions à la place.

Activez ou désactivez la section 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 jusqu'à runtime.lastError. Nécessite l'autorisation "downloads.shelf" en plus de l'autorisation "downloads".

Paramètres

  • activé

    boolean

setUiOptions()

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

Modifier 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'interface de téléchargement sera masquée. Si UiOptions.enabled est défini sur "true" 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.ui" en plus de l'autorisation "downloads".

Paramètres

  • options

    UiOptions

    Encapsulez une modification apportée à l'interface utilisateur de téléchargement.

  • rappel

    fonction facultative

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

    ()=>void

Renvoie

  • Promise<void>

    Les promesses sont compatibles avec Manifest V3 et les versions ultérieures, mais des rappels sont fournis pour assurer la rétrocompatibilité. Vous ne pouvez pas utiliser les deux dans le même appel de fonction. La promesse est résolue avec le même type que celui transmis au rappel.

show()

chrome.downloads.show(
  downloadId: number,
)

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

chrome.downloads.showDefaultFolder()

Afficher le dossier "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, à l'exception de bytesReceived et estimatedEndTime, change, cet événement se déclenche avec downloadId et un objet contenant les propriétés modifiées.

Paramètres

  • rappel

    function

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

    (downloadDelta: DownloadDelta)=>void

onCreated

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

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

Paramètres

  • rappel

    function

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

    (downloadItem: DownloadItem)=>void

onDeterminingFilename

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

Au cours du processus de détermination du nom de fichier, les extensions ont la possibilité de remplacer la cible DownloadItem.filename. 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 est appelé automatiquement. Le DownloadItem ne se terminera pas tant que tous les écouteurs n'auront pas appelé suggest. Les écouteurs peuvent appeler suggest sans aucun argument afin de permettre au téléchargement d'utiliser downloadItem.filename comme nom de fichier, ou transmettre un objet suggestion à suggest afin de 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 au résultat de l'extension, les utilisateurs ne doivent pas installer d'extensions susceptibles de provoquer des conflits. 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 n'aient été déterminés, transmettez filename à download.

Paramètres

onErased

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

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

Paramètres

  • rappel

    function

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

    (downloadId: number)=>void

    • downloadId

      Nombre