downloads.DownloadQuery
DownloadQuery
是 downloads
API 的一种类型,它定义了一组参数,可用于在下载管理器中搜索特定的一组下载。
例如,此类型用于 downloads.search()
和 downloads.erase()
,作为查询对象来筛选要返回或删除的 DownloadItems
集。
类型
此类型的值为对象。它们包含以下属性
query
可选-
一个
string
的array
。仅包含filename
或url
包含所有给定字符串的DownloadItems
。您还可以包含以连字符 (-) 开头的术语 - 这些术语**不得**包含在项目的filename
或url
中,否则它将被包含。 startedBefore
可选-
一个
DownloadTime
。仅包含在给定时间之前开始的DownloadItems
。 startedAfter
可选-
一个
DownloadTime
。仅包含在给定时间之后开始的DownloadItems
。 endedBefore
可选-
一个
DownloadTime
。仅包含在给定时间之前结束的DownloadItems
。 endedAfter
可选-
一个
DownloadTime
。仅包含在给定时间之后结束的DownloadItems
。 totalBytesGreater
可选-
一个表示字节数的
number
。仅包含totalBytes
大于给定数字的DownloadItems
。 totalBytesLess
可选-
一个表示字节数的
number
。仅包含totalBytes
小于给定数字的DownloadItems
。 filenameRegex
可选-
一个表示正则表达式的
string
。仅包含filename
值与给定正则表达式匹配的DownloadItems
。 urlRegex
可选-
一个表示正则表达式的
string
。仅包含url
值与给定正则表达式匹配的DownloadItems
。 limit
可选-
一个表示结果数的
integer
。仅包含指定数量的DownloadItems
。 orderBy
可选-
一个表示
DownloadItem
属性的string
的array
,搜索结果应按此属性排序。例如,在数组中包含startTime
然后是totalBytes
将按其开始时间对DownloadItems
进行排序,然后按总字节数排序 - 按照升序排序。要指定按属性降序排序,请在属性前加上连字符,例如-startTime
。 id
可选-
一个表示要查询的
downloads.DownloadItem
的 ID 的integer
。 url
可选-
一个表示启动下载的绝对 URL 的
string
,在任何重定向之前。 filename
可选-
一个表示要查询的下载文件的绝对本地路径的字符串。
danger
可选-
一个表示
downloads.DangerType
的字符串 - 仅包含具有此danger
值的DownloadItems
。 mime
可选-
一个表示 MIME 类型的
string
。仅包含具有此mime
值的DownloadItems
。 startTime
可选-
一个表示 ISO 8601 格式时间的
string
。仅包含具有此startTime
值的DownloadItems
。 endTime
可选-
一个表示 ISO 8601 格式时间的
string
。仅限于具有此endTime
值的DownloadItems
。 state
可选-
一个表示下载
downloads.State
(in_progress
、interrupted
或complete
)的string
类型字符串。仅包含具有此state
值的DownloadItems
。 paused
可选-
一个
boolean
类型布尔值,指示下载是否已暂停,即已停止从主机读取数据但保持连接打开(true
)或未暂停(false
)。仅包含具有此paused
值的DownloadItems
。 error
可选-
一个表示
downloads.InterruptReason
的字符串,即下载中断的原因。仅包含具有此error
值的DownloadItems
。 bytesReceived
可选-
一个
number
类型数字,表示迄今为止从主机接收到的字节数,不考虑文件压缩。仅包含具有此bytesReceived
值的DownloadItems
。 totalBytes
可选-
一个
number
类型数字,表示下载文件中总字节数,不考虑文件压缩。仅包含具有此totalBytes
值的DownloadItems
。 fileSize
可选-
number
。解压缩后整个文件的字节数,如果未知则为 -1。一个number
类型数字,表示文件解压缩后的总字节数。仅包含具有此fileSize
值的DownloadItems
。 exists
可选-
一个
boolean
类型布尔值,指示下载的文件是否仍然存在(true
)或不存在(false
)。仅包含具有此exists
值的DownloadItems
。
浏览器兼容性
BCD 表格仅在启用 JavaScript 的浏览器中加载。
注意:此 API 基于 Chromium 的chrome.downloads
API。