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 :

queryFacultatif

Un tableau de chaines. Inclure uniquement DownloadItems dont le nom 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 le nom du fichier ou l'url de l'élément à inclure.

startedBeforeFacultatif

Un DownloadTime. Inclure uniquement DownloadItems qui a démarré avant l'heure indiquée.

startedAfterFacultatif

Un DownloadTime. Inclure uniquement DownloadItems qui a démarré après l'heure indiquée.

endedBeforeFacultatif

Un DownloadTime. Inclure uniquement DownloadItems qui s'est terminé avant l'heure indiquée.

endedAfterFacultatif

Un DownloadTime. Inclure uniquement DownloadItems qui s'est terminé après l'heure indiquée.

totalBytesGreaterFacultatif

Un number représentant un nombre d'octets. Inclure uniquement DownloadItems dont le totalBytes est supérieur au nombre donné.

totalBytesLessFacultatif

Un number représentant un nombre d'octets. Inclure seulement DownloadItems dont le totalBytes est inférieur au nombre donné.

filenameRegexFacultatif

Un string représentant une expression régulière. Inclure uniquement DownloadItems dont le nom du fichier correspond à l'expression régulière donnée..

urlRegexFacultatif

Un string représentant une expression régulière. Inclure uniquement DownloadItems dont la valeur d'url correspond à l'expression régulière donnée..

limitFacultatif

Un integer représentant un nombre de résultats. Incluez uniquement le nombre spécifié de DownloadItems.

orderByFacultatif

Un tableau de chaînes représentant les propriétés DownloadItem les résultats de la recherche doivent être tirés par exemple, en incluant startTime puis totalBytes dans le tableau trierait DownloadItems 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.

idFacultatif

Un integer représentant l'ID du downloads.DownloadItem que vous souhaitez interroger.

urlFacultatif

Un string représentant l'URL absolue à partir de laquelle le téléchargement a été initié, avant toute redirection.

filenameFacultatif

Un string représentant le chemin local absolu du fichier téléchargé que vous souhaitez interroger.

dangerFacultatif

Une chaîne représentant un downloads.DangerType — inclut uniquement DownloadItems avec cette valeur de danger .

mimeFacultatif

Un string représentant un type MIME. Incluez uniquement DownloadItems avec cette valeur mime.

startTimeFacultatif

Un string représentant une heure au format ISO 8601. Incluez seulement DownloadItems avec cette valeur startTime.

endTimeFacultatif

Un string représentant une heure au format ISO 8601. Inclure uniquement sera limité à DownloadItems avec cette valeur endTime.

stateFacultatif

Un string représentant un téléchargement downloads.State (in_progress, interrupted, or complete). Inclure uniquement DownloadItems avec cette valeur d' état.

pausedFacultatif

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 uniquement DownloadItems avec cette valeur de pause.

errorFacultatif

Une chaîne représentant un downloads.InterruptReason — une raison pour laquelle un téléchargement a été interrompu. Inclure uniquement DownloadItems avec cette valeur d' erreur .

bytesReceivedFacultatif

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 seulement DownloadItems avec cette valeur bytesReceived.

totalBytesFacultatif

Un number représentant le nombre total d'octets dans le fichier téléchargé, sans tenir compte de la compression de fichier. Inclure seulement DownloadItems avec cette valeur totalBytes.

fileSizeFacultatif

number. Nombre d'octets dans le fichier entier après la décompression, ou -1 si inconnu. Un nombre représentant le nombre total d'octets dans le fichier après la décompression. Inclure seulement DownloadItems avec cette valeur fileSize.

existsFacultatif

Un boolean si un fichier téléchargé existe toujours (true) ou non (false). Inclure seulement DownloadItems avec cette valeur existe.

Compatibilité des navigateurs