chrome.downloads

Description

Utilisez l'API chrome.downloads pour programmer, lancer, surveiller, manipuler et rechercher des téléchargements.

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 chrome.downloads dans examples/api/downloads . Pour obtenir d'autres exemples et obtenir de l'aide sur l'affichage du code source, consultez la section Exemples.

Types

BooleanDelta

Propriétés

  • actuellement

    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.

contenu

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

rare

L'URL de 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 et est probablement dangereux.

indésirables

Le téléchargement est potentiellement indésirable ou dangereux. Exemple : il pourrait apporter des modifications aux 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ée

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

Énumération

"fichier"

"url"

"contenu"

"rare"

"host"

"indésirable"

"sécurisé"

"accepted"

"allowlistedByPolicy"

"asyncScanning"

"asyncLocalPasswordScanning"

"Protégé par mot de passe"

"blockedTooLarge"

"sensitiveContentWarning"

"sensitiveContentBlock"

"deepScannedFailed"

"deepScannedSafe"

"deepSCANOpenedDangereux"

"promptForScanning"

"promptForLocalPasswordScanning"

"accountCompromise"

"blockedScanFailed"

DoubleDelta

Propriétés

  • actuellement

    numéro facultatif

  • précédent

    numéro facultatif

DownloadDelta

Propriétés

  • canResume

    BooleanDelta facultatif

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

  • danger

    StringDelta facultatif

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

  • endTime

    StringDelta facultatif

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

  • erreur

    StringDelta facultatif

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

  • existe

    BooleanDelta facultatif

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

  • fileSize

    DoubleDelta facultatif

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

  • filename

    StringDelta facultatif

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

  • finalUrl

    StringDelta facultatif

    Chrome (version 54 ou ultérieure)

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

  • id

    Nombre

    id du DownloadItem qui a été modifié.

  • mime

    StringDelta facultatif

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

  • mis en veille

    BooleanDelta facultatif

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

  • startTime

    StringDelta facultatif

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

  • state

    StringDelta facultatif

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

  • totalBytes

    DoubleDelta facultatif

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

  • url

    StringDelta facultatif

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

DownloadItem

Propriétés

  • byExtensionId

    chaîne facultatif

    Identifiant de l'extension à l'origine du téléchargement si celui-ci a été lancé par une extension. Ce paramètre ne change pas une fois qu'il est défini.

  • byExtensionName

    chaîne facultatif

    Nom localisé de l'extension à l'origine du téléchargement si celui-ci a été lancé par une extension. Peut changer si l'extension change de nom ou si l'utilisateur modifie 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

    booléen

    Vrai si le téléchargement est en cours et suspendu, ou s'il est interrompu et qu'il peut être repris à partir de là où il a été interrompu.

  • danger

    DangerType

    Indique si ce téléchargement est considéré comme sûr ou 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

    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 déclenchées par l'utilisateur par USER_.

  • estimatedEndTime

    chaîne facultatif

    Durée estimée 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 sont peut-être obsolètes, car Chrome ne surveille pas automatiquement la suppression des fichiers. Appelez search() pour déclencher la vérification de l'existence des fichiers. 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. Par conséquent, les résultats de search() peuvent ne pas refléter précisément le système de fichiers. En outre, search() peut être appelé aussi souvent que nécessaire, mais ne vérifie 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 (version 54 ou ultérieure)

    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 le téléchargement est enregistré dans l'historique et sur "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 de début du téléchargement, 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 du fichier, ou -1 si inconnu.

  • url

    chaîne

    URL absolue à partir de laquelle ce téléchargement a été initié, 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 relatif au répertoire "Téléchargements" pour contenir le fichier téléchargé. Les éventuels sous-répertoires peuvent être inclus. Chemins absolus, chemins vides et chemins contenant des références arrière ".." génère 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éfini ou déjà 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 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 à DownloadItem qui se sont terminés après le nombre de ms indiqué au format ISO 8601

  • endedBefore

    chaîne facultatif

    Limite les résultats à DownloadItem qui se sont terminés avant la valeur ms donnée au format ISO 8601.

  • erreur

    InterruptReason facultatif

    la raison pour laquelle 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

    chaîne facultatif

    Chemin d'accès local absolu.

  • filenameRegex

    chaîne facultatif

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

  • finalUrl

    chaîne facultatif

    Chrome (version 54 ou ultérieure)

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

  • finalUrlRegex

    chaîne facultatif

    Chrome (version 54 ou ultérieure)

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

  • id

    numéro facultatif

    id du DownloadItem à interroger.

  • limite

    numéro facultatif

    Nombre maximal d'éléments DownloadItem correspondants renvoyés. La valeur par défaut est 1 000. Définissez la valeur sur 0 pour renvoyer tous les DownloadItem correspondants. Consultez search pour découvrir comment parcourir les pages de 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, si vous définissez orderBy=['startTime'], les DownloadItem sont triés par heure de début dans l'ordre croissant. Pour indiquer l'ordre décroissant, ajoutez le préfixe "-startTime" en préfixe.

  • mis en veille

    Booléen 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 filename, url ou finalUrl contiennent tous les termes de recherche ne commençant pas par un tiret ("-") et aucun des termes de recherche commençant par un tiret.

  • startTime

    chaîne facultatif

    Heure de début du téléchargement, au format ISO 8601.

  • startedAfter

    chaîne facultatif

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

  • startedBefore

    chaîne facultatif

    Limite les résultats à DownloadItem ayant commencé avant la valeur "ms" 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

    chaîne facultatif

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

  • urlRegex

    chaîne facultatif

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

FilenameConflictAction

uniquify

Pour éviter les doublons, filename est modifié de manière à 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 fichier s'affiche.

Énumération

"uniquify"

"écraser"

"requête"

FilenameSuggestion

Propriétés

  • conflictAction

    FilenameConflictAction facultatif

    Action à effectuer si filename existe déjà.

  • filename

    chaîne

    La nouvelle cible DownloadItem.filename de DownloadItem, sous la forme d'un chemin d'accès relatif au répertoire de téléchargement par défaut de l'utilisateur, contenant éventuellement des sous-répertoires. Chemins absolus, chemins vides et chemins contenant des références arrière ".." sont ignorées. filename est ignoré si des écouteurs onDeterminingFilename sont enregistrés par des extensions.

GetFileIconOptions

Propriétés

  • taille

    numéro facultatif

    Taille de l'icône renvoyée. L'icône sera carrée avec ses dimensions * taille en pixels. La taille par défaut et la plus grande de l'icône est de 32 x 32 pixels. Les seules tailles prises en charge sont 16 et 32. Vous ne devez pas indiquer une autre taille.

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"

"FICHIER_TROP_LONG"

"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"

"interrompu"

"complete"

StringDelta

Propriétés

  • actuellement

    chaîne facultatif

  • précédent

    chaîne facultatif

UiOptions

Chrome 105 ou version ultérieure

Propriétés

  • activé

    booléen

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

Méthodes

acceptDanger()

<ph type="x-smartling-placeholder"></ph> Promesse 
chrome.downloads.acceptDanger(
  downloadId: number,
  callback?: function,
)

Invitez l'utilisateur à accepter un téléchargement dangereux. Vous ne pouvez l'appeler qu'à partir d'un contexte visible (onglet, fenêtre ou pop-up d'action sur la page/le 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é comme le nom de fichier cible, state devient "complete" et onChanged se déclenche.

Paramètres

  • downloadId

    Nombre

    Identifiant de DownloadItem.

  • rappel

    function facultatif

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

    () => void

Renvoie

  • Promesse<void>

    Chrome 96 ou version ultérieure

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

cancel()

<ph type="x-smartling-placeholder"></ph> Promesse 
chrome.downloads.cancel(
  downloadId: number,
  callback?: function,
)

Annulez 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

    Identifiant du téléchargement à annuler.

  • rappel

    function facultatif

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

    () => void

Renvoie

  • Promesse<void>

    Chrome 96 ou version ultérieure

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

download()

<ph type="x-smartling-placeholder"></ph> Promesse 
chrome.downloads.download(
  options: DownloadOptions,
  callback?: function,
)

Téléchargez 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 les 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 commencé correctement, callback sera appelé avec le nouveau downloadId du 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

    Que télécharger et comment ?

  • rappel

    function facultatif

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

    (downloadId: number) => void

    • downloadId

      Nombre

Renvoie

  • Promise&lt;number&gt;

    Chrome 96 ou version ultérieure

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

erase()

<ph type="x-smartling-placeholder"></ph> 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

    function facultatif

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

    (erasedIds: number[]) => void

    • erasedIds

      numéro[]

Renvoie

  • Promesse<numéro[]>

    Chrome 96 ou version ultérieure

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

getFileIcon()

<ph type="x-smartling-placeholder"></ph> 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é. Les icônes sont récupérées en interrogeant le système d'exploitation ou le kit d'outils sous-jacent, en fonction de la plate-forme. L'icône renvoyé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. S'il est impossible d'identifier une icône de fichier, runtime.lastError affichera un message d'erreur.

Paramètres

  • downloadId

    Nombre

    Identifiant du téléchargement.

  • options

    GetFileIconOptions facultatif

  • rappel

    function facultatif

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

    (iconURL?: string) => void

    • iconURL

      chaîne facultatif

Renvoie

  • Promise<chaîne | indéfini>

    Chrome 96 ou version ultérieure

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

open()

<ph type="x-smartling-placeholder"></ph> Promesse 
chrome.downloads.open(
  downloadId: number,
  callback?: function,
)

Ouvre maintenant le fichier téléchargé si DownloadItem est terminé. Sinon, elle 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

    function facultatif

    Chrome 123 et versions ultérieures

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

    () => void

Renvoie

  • Promesse<void>

    Chrome 123 et versions ultérieures

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

pause()

<ph type="x-smartling-placeholder"></ph> Promesse 
chrome.downloads.pause(
  downloadId: number,
  callback?: function,
)

Interrompez le téléchargement. Si la requête aboutit, 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

    Identifiant du téléchargement à suspendre.

  • rappel

    function facultatif

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

    () => void

Renvoie

  • Promesse<void>

    Chrome 96 ou version ultérieure

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

removeFile()

<ph type="x-smartling-placeholder"></ph> Promesse 
chrome.downloads.removeFile(
  downloadId: number,
  callback?: function,
)

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

Paramètres

  • downloadId

    Nombre

  • rappel

    function facultatif

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

    () => void

Renvoie

  • Promesse<void>

    Chrome 96 ou version ultérieure

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

resume()

<ph type="x-smartling-placeholder"></ph> Promesse 
chrome.downloads.resume(
  downloadId: number,
  callback?: function,
)

Reprenez un téléchargement suspendu. Si la requête aboutit, 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

    Identifiant du téléchargement à reprendre.

  • rappel

    function facultatif

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

    () => void

Renvoie

  • Promesse<void>

    Chrome 96 ou version ultérieure

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

<ph type="x-smartling-placeholder"></ph> Promesse 
chrome.downloads.search(
  query: DownloadQuery,
  callback?: function,
)

Recherchez DownloadItem. Définissez query sur l'objet vide pour obtenir l'intégralité des 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&lt;DownloadItem[]&gt;

    Chrome 96 ou version ultérieure

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

setShelfEnabled()

<ph type="x-smartling-placeholder"></ph> Obsolète depuis Chrome 117
chrome.downloads.setShelfEnabled(
  enabled: boolean,
)

Utilisez setUiOptions à la place.

Activez ou désactivez 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 a été 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()

<ph type="x-smartling-placeholder"></ph> Promesse Chrome 105 ou version ultérieure 
chrome.downloads.setUiOptions(
  options: UiOptions,
  callback?: function,
)

Modifiez 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'UI de téléchargement est masquée. Si vous définissez UiOptions.enabled sur "true" alors qu'au moins une autre extension a été 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 dans l'interface de téléchargement.

  • rappel

    function facultatif

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

    () => void

Renvoie

  • Promesse<void>

    Les promesses sont prises en charge dans Manifest V3 et versions ultérieures, mais les rappels sont fournis pour rétrocompatibilité. Vous ne pouvez pas utiliser les deux sur le même appel de fonction. La 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, est modifiée, cet événement se déclenche avec downloadId et un objet contenant les propriétés modifiées.

Paramètres

  • rappel

    fonction

    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 au début du téléchargement.

Paramètres

  • rappel

    fonction

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

    (downloadItem: DownloadItem) => void

onDeterminingFilename

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

Lors du processus de détermination du nom de fichier, les extensions ont la possibilité de remplacer la cible DownloadItem.filename. Une 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 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 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 à l'extension qui sera gagnante, les utilisateurs ne doivent pas installer d'extensions susceptibles d'entraîner un 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 plutôt filename à download.

Paramètres

  • rappel

    fonction

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

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

onErased

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

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

Paramètres

  • rappel

    fonction

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

    (downloadId: number) => void

    • downloadId

      Nombre