downloads.DownloadQuery
downloads API 中的 DownloadQuery 类型定义了一组参数,可用于在下载管理器中搜索特定下载项。
此类型例如用于 downloads.search() 和 downloads.erase() 中,作为查询对象来过滤要返回或删除的 DownloadItems 集合。
类型
此类型的值是对象。它们包含以下属性:
-
下载发生的 上下文身份 的 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.State(in_progress、interrupted或complete)。仅包含具有此 `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。