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。