downloads.DownloadQuery

Der DownloadQuery-Typ der downloads API definiert eine Reihe von Parametern, die verwendet werden können, um im Download-Manager nach einem bestimmten Satz von Downloads zu suchen.

Dieser Typ wird beispielsweise in downloads.search() und downloads.erase() verwendet, als Abfrageobjekt, um die Menge der DownloadItems zu filtern, die zurückgegeben oder gelöscht werden sollen.

Typ

Werte dieses Typs sind Objekte. Sie enthalten die folgenden Eigenschaften:

cookieStoreId Optional

Die Cookie-Store-ID der kontextuellen Identität, in der der Download stattfand. Siehe Arbeiten mit kontextuellen Identitäten für weitere Informationen.

query Optional

Ein array von strings. Nur DownloadItems einbeziehen, deren filename oder url alle angegebenen Strings enthalten. Sie können auch Begriffe einbeziehen, die mit einem Bindestrich (-) beginnen — diese Begriffe dürfen nicht im filename oder url des Elements enthalten sein, damit es einbezogen wird.

startedBefore Optional

Ein DownloadTime. Nur DownloadItems einbeziehen, die vor der angegebenen Zeit gestartet wurden.

startedAfter Optional

Ein DownloadTime. Nur DownloadItems einbeziehen, die nach der angegebenen Zeit gestartet wurden.

endedBefore Optional

Ein DownloadTime. Nur DownloadItems einbeziehen, die vor der angegebenen Zeit beendet wurden.

endedAfter Optional

Ein DownloadTime. Nur DownloadItems einbeziehen, die nach der angegebenen Zeit beendet wurden.

totalBytesGreater Optional

Eine number, die eine Anzahl von Bytes repräsentiert. Nur DownloadItems einbeziehen, deren totalBytes größer sind als die angegebene Zahl.

totalBytesLess Optional

Eine number, die eine Anzahl von Bytes repräsentiert. Nur DownloadItems einbeziehen, deren totalBytes kleiner sind als die angegebene Zahl.

filenameRegex Optional

Ein string, der einen regulären Ausdruck repräsentiert. Nur DownloadItems einbeziehen, deren filename-Wert dem angegebenen regulären Ausdruck entspricht.

urlRegex Optional

Ein string, der einen regulären Ausdruck repräsentiert. Nur DownloadItems einbeziehen, deren url-Wert dem angegebenen regulären Ausdruck entspricht.

limit Optional

Ein integer, der eine Anzahl von Ergebnissen repräsentiert. Nur die angegebene Anzahl von DownloadItems einbeziehen.

orderBy Optional

Ein array von strings, der DownloadItem-Eigenschaften repräsentiert, nach denen die Suchergebnisse sortiert werden sollen. Beispielsweise würde die Einbeziehung von startTime und dann totalBytes in das Array die DownloadItems nach ihrer Startzeit und dann nach Gesamtbytes sortieren — in aufsteigender Reihenfolge. Um eine Eigenschaft in absteigender Reihenfolge zu sortieren, wird sie mit einem Bindestrich vorangestellt, z. B. -startTime.

id Optional

Ein integer, der die ID des downloads.DownloadItem repräsentiert, nach dem Sie suchen möchten.

url Optional

Ein string, der die absolute URL repräsentiert, von der der Download initiiert wurde, vor jeglichen Weiterleitungen.

filename Optional

Ein String, der den absoluten lokalen Pfad der Download-Datei repräsentiert, nach der Sie suchen möchten.

danger Optional

Ein String, der einen downloads.DangerType repräsentiert — nur DownloadItems mit diesem danger-Wert einbeziehen.

mime Optional

Ein string, der einen MIME-Typ repräsentiert. Nur DownloadItems mit diesem mime-Wert einbeziehen.

startTime Optional

Ein string, der eine Zeit im ISO 8601-Format repräsentiert. Nur DownloadItems mit diesem startTime-Wert einbeziehen.

endTime Optional

Ein string, der eine Zeit im ISO 8601-Format repräsentiert. Nur die DownloadItems mit diesem endTime-Wert einbeziehen.

state Optional

Ein string, der einen Download-downloads.State (in_progress, interrupted, oder complete) repräsentiert. Nur DownloadItems mit diesem state-Wert einbeziehen.

paused Optional

Ein boolean, der angibt, ob ein Download pausiert ist — d.h. das Lesen von Daten vom Host gestoppt hat, aber die Verbindung offen gehalten hat (true), oder nicht (false). Nur DownloadItems mit diesem paused-Wert einbeziehen.

error Optional

Ein String, der einen downloads.InterruptReason repräsentiert — ein Grund, warum ein Download unterbrochen wurde. Nur DownloadItems mit diesem error-Wert einbeziehen.

bytesReceived Optional

Eine number, die die Anzahl der bisher vom Host empfangenen Bytes ohne Berücksichtigung der Dateikomprimierung repräsentiert. Nur DownloadItems mit diesem bytesReceived-Wert einbeziehen.

totalBytes Optional

Eine number, die die Gesamtzahl der Bytes in der heruntergeladenen Datei ohne Berücksichtigung der Dateikomprimierung repräsentiert. Nur DownloadItems mit diesem totalBytes-Wert einbeziehen.

fileSize Optional

number. Anzahl der Bytes in der gesamten Datei nach Dekomprimierung, oder -1, wenn unbekannt. Eine number, die die Gesamtzahl der Bytes in der Datei nach Dekomprimierung repräsentiert. Nur DownloadItems mit diesem fileSize-Wert einbeziehen.

exists Optional

Ein boolean, der angibt, ob eine heruntergeladene Datei noch existiert (true) oder nicht (false). Nur DownloadItems mit diesem exists-Wert einbeziehen.

Browser-Kompatibilität

Hinweis: Diese API basiert auf der API chrome.downloads von Chromium.