downloads.DownloadQuery
The DownloadQuery
type of the downloads
API defines a set of parameters that can be used to search the downloads manager for a specific set of downloads.
This type is used for example in downloads.search()
and downloads.erase()
, as a query object to filter the set of DownloadItems
to return or erase.
Type
Values of this type are objects. They contain the following properties:
query
Optional- An
array
ofstring
s. Include onlyDownloadItems
whosefilename
orurl
contains all of the given strings. You can also include terms beginning with a dash (-) — these terms must not be contained in the item'sfilename
orurl
for it to be included. startedBefore
Optional- A
DownloadTime
. Include onlyDownloadItems
that started before the given time. startedAfter
Optional- A
DownloadTime
. Include onlyDownloadItems
that started after the given time. endedBefore
Optional- A
DownloadTime
. Include onlyDownloadItems
that ended before the given time. endedAfter
Optional- A
DownloadTime
. Include onlyDownloadItems
that ended after the given time. totalBytesGreater
Optional- A
number
representing a number of bytes. Include onlyDownloadItems
whosetotalBytes
is greater than the given number. totalBytesLess
Optional- A
number
representing a number of bytes. Include onlyDownloadItems
whosetotalBytes
is less than the given number. filenameRegex
Optional- A
string
representing a regular expression. Include onlyDownloadItems
whosefilename
value matches the given regular expression. urlRegex
Optional- A
string
representing a regular expression. Include onlyDownloadItems
whoseurl
value matches the given regular expression. limit
Optional- An
integer
representing a number of results. Include only the specified number ofDownloadItems
. orderBy
Optional- An
array
ofstring
s representingDownloadItem
properties the search results should be sorted by. For example, includingstartTime
thentotalBytes
in the array would sort theDownloadItems
by their start time, then total bytes — in ascending order. To specify sorting by a property in descending order, prefix it with a hyphen, for example-startTime
. id
Optional- An
integer
representing the ID of thedownloads.DownloadItem
you want to query. url
Optional- A
string
representing the absolute URL that the download was initiated from, before any redirects. filename
Optional- A string representing the absolute local path of the download file you want to query.
danger
Optional- A string representing a
downloads.DangerType
— include onlyDownloadItems
with thisdanger
value. mime
Optional- A
string
representing a MIME type. Include onlyDownloadItems
with thismime
value. startTime
Optional- A
string
representing an ISO 8601 format time. Include onlyDownloadItems
with thisstartTime
value. endTime
Optional- A
string
representing an ISO 8601 format time. Include only will limited toDownloadItems
with thisendTime
value. state
Optional- A
string
representing a downloaddownloads.State
(in_progress
,interrupted
, orcomplete
). Include onlyDownloadItems
with thisstate
value. paused
Optional- A
boolean
that indicates whether a download is paused — i.e. has stopped reading data from the host, but kept the connection open (true
), or not (false
). Include onlyDownloadItems
with thispaused
value. error
Optional- A string representing an
downloads.InterruptReason
— a reason why a download was interrupted. Include onlyDownloadItems
with thiserror
value. bytesReceived
Optional- A
number
representing the number of bytes received so far from the host, without considering file compression. Include onlyDownloadItems
with thisbytesReceived
value. totalBytes
Optional- A
number
representing the total number of bytes in the downloaded file, without considering file compression. Include onlyDownloadItems
with thistotalBytes
value. fileSize
Optionalnumber
. Number of bytes in the whole file post-decompression, or -1 if unknown. Anumber
representing the total number of bytes in the file after decompression. Include onlyDownloadItems
with thisfileSize
value.exists
Optional- A
boolean
indicating whether a downloaded file still exists (true
) or not (false
). Include onlyDownloadItems
with thisexists
value.
Browser compatibility
BCD tables only load in the browser
The compatibility table in this page is generated from structured data. If you'd like to contribute to the data, please check out https://github.com/mdn/browser-compat-data and send us a pull request.
This API is based on Chromium's chrome.downloads
API.
Microsoft Edge compatibility data is supplied by Microsoft Corporation and is included here under the Creative Commons Attribution 3.0 United States License.