downloads.DownloadQuery
Le type DownloadQuery
de l'API downloads
définit un ensemble de paramètres pouvant être utilisés pour rechercher dans le gestionnaire de téléchargements un ensemble spécifique de téléchargements.
Ce type est utilisé par exemple dans downloads.search()
et downloads.erase()
, en tant qu'objet de requête pour filtrer l'ensemble de DownloadItems
pour retourner ou effacer.
Type
Les valeurs de ce type sont des objets. Ils contiennent les propriétés suivantes :
query
Facultatif-
Un
tableau
dechaines
. Inclure uniquementDownloadItems
dont lenom de fichier
ou l'URL
contient toutes les chaînes données. Vous pouvez également inclure des termes commençant par un titet (-) — ces termes ne doivent pas figurer dans lenom du fichier
ou l'url
de l'élément à inclure. startedBefore
Facultatif-
Un
DownloadTime
. Inclure uniquementDownloadItems
qui a démarré avant l'heure indiquée. startedAfter
Facultatif-
Un
DownloadTime
. Inclure uniquementDownloadItems
qui a démarré après l'heure indiquée. endedBefore
Facultatif-
Un
DownloadTime
. Inclure uniquementDownloadItems
qui s'est terminé avant l'heure indiquée. endedAfter
Facultatif-
Un
DownloadTime
. Inclure uniquementDownloadItems
qui s'est terminé après l'heure indiquée. totalBytesGreater
Facultatif-
Un
number
représentant un nombre d'octets. Inclure uniquementDownloadItems
dont letotalBytes
est supérieur au nombre donné. totalBytesLess
Facultatif-
Un
number
représentant un nombre d'octets. Inclure seulementDownloadItems
dont letotalBytes
est inférieur au nombre donné. filenameRegex
Facultatif-
Un
string
représentant une expression régulière. Inclure uniquementDownloadItems
dont lenom du fichier
correspond à l'expression régulière donnée.. urlRegex
Facultatif-
Un
string
représentant une expression régulière. Inclure uniquementDownloadItems
dont la valeur d'url
correspond à l'expression régulière donnée.. limit
Facultatif-
Un
integer
représentant un nombre de résultats. Incluez uniquement le nombre spécifié deDownloadItems
. orderBy
Facultatif-
Un
tableau
dechaînes
représentant les propriétésDownloadItem
les résultats de la recherche doivent être tirés par exemple, en incluantstartTime
puistotalBytes
dans le tableau trieraitDownloadItems
par leur heure de début, puis le total des octets — dans l'ordre croissant. Pour spécifier le tri par une propriété dans l'ordre décroissant, préfixez-le avec un trait d'union, par exemple-startTime
. id
Facultatif-
Un
integer
représentant l'ID dudownloads.DownloadItem
que vous souhaitez interroger. url
Facultatif-
Un
string
représentant l'URL absolue à partir de laquelle le téléchargement a été initié, avant toute redirection. filename
Facultatif-
Un string représentant le chemin local absolu du fichier téléchargé que vous souhaitez interroger.
danger
Facultatif-
Une chaîne représentant un
downloads.DangerType
— inclut uniquementDownloadItems
avec cette valeur dedanger
. mime
Facultatif-
Un
string
représentant un type MIME. Incluez uniquementDownloadItems
avec cette valeurmime
. startTime
Facultatif-
Un
string
représentant une heure au format ISO 8601. Incluez seulementDownloadItems
avec cette valeurstartTime
. endTime
Facultatif-
Un
string
représentant une heure au format ISO 8601. Inclure uniquement sera limité àDownloadItems
avec cette valeurendTime
. state
Facultatif-
Un
string
représentant un téléchargementdownloads.State
(in_progress
,interrupted
, orcomplete
). Inclure uniquementDownloadItems
avec cette valeur d'état
. paused
Facultatif-
Un
boolean
qui indique si un téléchargement est en pause — c'est-à-dire qui a cessé de lire les données de l'hôte, mais qui a conservé la connexion ouverte (true
), ou non (false
). inclure uniquementDownloadItems
avec cette valeur depause
. error
Facultatif-
Une chaîne représentant un
downloads.InterruptReason
— une raison pour laquelle un téléchargement a été interrompu. Inclure uniquementDownloadItems
avec cette valeur d'erreur
. bytesReceived
Facultatif-
Un
number
représentant le nombre d'octets reçus jusqu'ici de l'hôte, sans tenir compte de la compression de fichier. Inclure seulementDownloadItems
avec cette valeurbytesReceived
. totalBytes
Facultatif-
Un
number
représentant le nombre total d'octets dans le fichier téléchargé, sans tenir compte de la compression de fichier. Inclure seulementDownloadItems
avec cette valeurtotalBytes
. fileSize
Facultatif-
number
. Nombre d'octets dans le fichier entier après la décompression, ou -1 si inconnu. Unnombre
représentant le nombre total d'octets dans le fichier après la décompression. Inclure seulementDownloadItems
avec cette valeurfileSize
. exists
Facultatif-
Un
boolean
si un fichier téléchargé existe toujours (true
) ou non (false
). Inclure seulementDownloadItems
avec cette valeurexiste
.
Compatibilité des navigateurs
BCD tables only load in the browser
Note :
Cette API est basée sur l'API Chromium chrome.downloads
.
Les données de compatibilité relatives à Microsoft Edge sont fournies par Microsoft Corporation et incluses ici sous la licence Creative Commons Attribution 3.0 pour les États-Unis.