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.
Values of this type are objects. They contain the following properties:
cookieStoreId
可选
The cookie store ID of the contextual identity in which the download took place.
query
可选
An
array
of
string
s. Include only
DownloadItems
whose
filename
or
url
contains all of the given strings. You can also include terms beginning with a dash (-) — these terms
不必
be contained in the item's
filename
or
url
for it to be included.
startedBefore
可选
A
DownloadTime
. Include only
DownloadItems
that started before the given time.
startedAfter
可选
A
DownloadTime
. Include only
DownloadItems
that started after the given time.
endedBefore
可选
A
DownloadTime
. Include only
DownloadItems
that ended before the given time.
endedAfter
可选
A
DownloadTime
. Include only
DownloadItems
that ended after the given time.
totalBytesGreater
可选
A
编号
representing a number of bytes. Include only
DownloadItems
whose
totalBytes
is greater than the given number.
totalBytesLess
可选
A
编号
representing a number of bytes. Include only
DownloadItems
whose
totalBytes
is less than the given number.
filenameRegex
可选
A
string
representing a regular expression. Include only
DownloadItems
whose
filename
value matches the given regular expression.
urlRegex
可选
A
string
representing a regular expression. Include only
DownloadItems
whose
url
value matches the given regular expression.
limit
可选
An
integer
representing a number of results. Include only the specified number of
DownloadItems
.
orderBy
可选
An
array
of
string
s representing
DownloadItem
properties the search results should be sorted by. For example, including
startTime
then
totalBytes
in the array would sort the
DownloadItems
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
可选
An
integer
representing the ID of the
downloads.DownloadItem
you want to query.
url
可选
A
string
representing the absolute URL that the download was initiated from, before any redirects.
filename
可选
A string representing the absolute local path of the download file you want to query.
danger
可选
A string representing a
downloads.DangerType
— include only
DownloadItems
with this
danger
值。
mime
可选
A
string
representing a MIME type. Include only
DownloadItems
with this
mime
值。
startTime
可选
A
string
representing an
ISO 8601
format time. Include only
DownloadItems
with this
startTime
值。
endTime
可选
A
string
representing an
ISO 8601
format time. Include only will limited to
DownloadItems
with this
endTime
值。
state
可选
A
string
representing a download
downloads.State
(
in_progress
,
interrupted
，或
complete
). Include only
DownloadItems
with this
state
值。
paused
可选
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 only
DownloadItems
with this
paused
值。
error
可选
A string representing an
downloads.InterruptReason
— a reason why a download was interrupted. Include only
DownloadItems
with this
error
值。
bytesReceived
可选
A
编号
representing the number of bytes received so far from the host, without considering file compression. Include only
DownloadItems
with this
bytesReceived
值。
totalBytes
可选
A
编号
representing the total number of bytes in the downloaded file, without considering file compression. Include only
DownloadItems
with this
totalBytes
值。
fileSize
可选
编号
. Number of bytes in the whole file post-decompression, or -1 if unknown. A
编号
representing the total number of bytes in the file after decompression. Include only
DownloadItems
with this
fileSize
值。
exists
可选
A
boolean
indicating whether a downloaded file still exists (
true
) 或不 (
false
). Include only
DownloadItems
with this
exists
值。
BCD tables only load in the browser
注意：
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.
最后修改： , 由 MDN 贡献者