downloads.DownloadItem

DownloadItem 型別是 downloads API 的一部分,它表示一個已下載的檔案。

型別

此型別的值是物件。它們包含以下屬性:

byExtensionId 可選

一個 string,表示觸發下載的擴充套件程式的 ID(如果下載是由擴充套件程式觸發的)。此值一旦設定就不會改變。如果下載不是由擴充套件程式觸發的,則為 undefined

byExtensionName 可選

一個 string,表示觸發下載的擴充套件程式的名稱(如果下載是由擴充套件程式觸發的)。如果擴充套件程式更改了其名稱或使用者更改了其區域設定,此值可能會發生變化。如果下載不是由擴充套件程式觸發的,則為 undefined

bytesReceived

一個 number,表示在下載過程中迄今為止從主機接收到的位元組數;這不考慮檔案壓縮。

canResume

一個 boolean,指示當前中斷(例如,暫停)的下載是否可以從中斷點恢復(true),或不能(false)。

cookieStoreId 可選

下載發生的 上下文身份 的 cookie 儲存 ID。有關更多資訊,請參閱 上下文身份的使用

danger

一個字串,指示下載是安全還是已知可疑。其可能值定義在 downloads.DangerType 型別中。

endTime 可選

一個 string(採用 ISO 8601 格式),表示自 UNIX 紀元以來到此下載結束的毫秒數。如果下載尚未完成,則此值為 undefined

error 可選

一個字串,指示下載中斷的原因。可能值定義在 downloads.InterruptReason 型別中。如果未發生錯誤,則此值為 undefined

estimatedEndTime 可選

一個 string(採用 ISO 8601 格式),表示自 UNIX 紀元以來到此下載預計完成時間的毫秒數。如果未知,則此值為 undefined(特別是在傳遞到 downloads.onCreatedDownloadItem 中,此值為 undefined)。

exists

一個 boolean,指示下載的檔案是否仍然存在(true)或不存在(false)。此資訊可能過時,因為瀏覽器不會自動監視檔案刪除 — 要檢查檔案是否存在,請呼叫 downloads.search() 方法,並按檔案進行過濾。

檔名

一個 string,表示檔案的絕對本地路徑。

fileSize

一個 number,表示解壓縮後整個檔案中的總位元組數。值為 -1 表示檔案總大小未知。

id

一個 integer,表示下載檔案的唯一識別符號,該識別符號在瀏覽器會話之間是持久的。

incognito

一個 boolean,指示下載是否記錄在瀏覽器的歷史記錄中(false),或未記錄(true)。

mime

一個 string,表示下載檔案的 MIME 型別。

paused

一個 boolean,指示下載是否已暫停,即下載是否已停止從主機讀取資料但已保持連線開啟。如果是,則值為 true;如果不是,則值為 false

referrer

一個 string,表示下載檔案的引薦來源地址。

startTime

一個 string(採用 ISO 8601 格式),表示自 UNIX 紀元以來到此下載開始的毫秒數。

state

一個 string,指示下載是正在進行、已中斷還是已完成。可能值定義在 downloads.State 型別中。

totalBytes

一個 number,表示正在下載的檔案中的總位元組數。這不考慮檔案壓縮。值為 -1 表示總位元組數未知。

url

一個 string,表示檔案下載的絕對 URL。

瀏覽器相容性

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