downloads.DownloadQuery

downloads API 中的 DownloadQuery 类型定义了一组参数,可用于在下载管理器中搜索特定下载项。

此类型例如用于 downloads.search()downloads.erase() 中,作为查询对象来过滤要返回或删除的 DownloadItems 集合。

类型

此类型的值是对象。它们包含以下属性:

cookieStoreId 可选

下载发生的 上下文身份 的 cookie 存储 ID。有关更多信息,请参阅 与上下文身份配合使用

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 可选

一个 `string` 组成的 `array`,表示应按其对搜索结果进行排序的 DownloadItem 属性。例如,在数组中包含 `startTime` 然后是 `totalBytes` 将按开始时间、然后是总字节数对 DownloadItems 进行升序排序。要指定降序排序,请在其前面加上连字符,例如 `-startTime`。

id 可选

一个 `integer`,表示您要查询的 downloads.DownloadItem 的 ID。

url 可选

一个 `string`,表示下载的起始绝对 URL,在任何重定向之前。

filename 可选

一个 `string`,表示您要查询的下载文件的绝对本地路径。

danger 可选

一个 `string`,表示 downloads.DangerType — 仅包含具有此 `danger` 值的 DownloadItems

mime 可选

一个 `string`,表示 MIME 类型。仅包含具有此 `mime` 值的 DownloadItems

startTime 可选

一个 `string`,表示 ISO 8601 格式的时间。仅包含具有此 `startTime` 值的 DownloadItems

endTime 可选

一个 `string`,表示 ISO 8601 格式的时间。仅包含具有此 `endTime` 值的 DownloadItems

state 可选

一个 `string`,表示下载 downloads.Statein_progressinterruptedcomplete)。仅包含具有此 `state` 值的 DownloadItems

paused 可选

一个 `boolean`,表示下载是否已暂停 — 即,已停止从主机读取数据,但保持连接打开(true),或者未暂停(false)。仅包含具有此 `paused` 值的 DownloadItems

error 可选

一个 `string`,表示 downloads.InterruptReason — 下载中断的原因。仅包含具有此 `error` 值的 DownloadItems

bytesReceived 可选

一个 `number`,表示当前从主机接收到的字节数,不考虑文件压缩。仅包含具有此 `bytesReceived` 值的 DownloadItems

totalBytes 可选

一个 `number`,表示下载文件的总字节数,不考虑文件压缩。仅包含具有此 `totalBytes` 值的 DownloadItems

fileSize 可选

number。解压缩后整个文件中的字节数,如果未知则为 -1。一个 `number`,表示解压缩后文件中总字节数。仅包含具有此 `fileSize` 值的 DownloadItems

exists 可选

一个 `boolean`,指示下载的文件是否存在(true)或不存在(false)。仅包含具有此 `exists` 值的 DownloadItems

浏览器兼容性

注意: 此 API 基于 Chromium 的 chrome.downloads API。