The DownloadItem
type of the downloads
API represents a downloaded file.
Values of this type are objects. They contain the following properties:
byExtensionId
Optional
string
representing the ID of the extension that triggered the download (if it was triggered by an extension). This does not change once set. If the download was not triggered by an extension this is undefined.byExtensionName
Optional
string
representing the name of the extension that triggered the download (if it was triggered by an extension). This may change if the extension changes its name or the user changes their locale. If the download was not triggered by an extension this is undefined.bytesReceived
number
representing the number of bytes received so far from the host during the download; this does not take file compression into consideration.canResume
boolean
indicating whether a currently-interrupted (e.g. paused) download can be resumed from the point where it was interrupted (true
), or not (false
).cookieStoreId
Optional
danger
downloads.DangerType
type.endTime
Optional
string
(in ISO 8601 format) representing the number of milliseconds between the UNIX epoch and when this download ended. This is undefined if the download has not yet finished.error
Optional
downloads.InterruptReason
type. This is undefined if an error has not occurred.estimatedEndTime
Optional
string
(in ISO 8601 format) representing the estimated number of milliseconds between the UNIX epoch and when this download is estimated to be completed. This is undefined if it is not known (in particular, it is undefined in the DownloadItem
that's passed into downloads.onCreated
).exists
boolean
indicating whether a downloaded file still exists (true
) or not (false
). This information might be out-of-date, as browsers do not automatically watch for file removal — to check whether a file exists, call the downloads.search()
method, filtering for the file in question.filename
string
representing the file's absolute local path.fileSize
number
indicating the total number of bytes in the whole file, after decompression. A value of -1 here means that the total file size is unknown.id
integer
representing a unique identifier for the downloaded file that is persistent across browser sessions.incognito
boolean
that indicates whether the download is recorded in the browser's history (false
), or not (true
).mime
string
representing the downloaded file's MIME type.paused
boolean
indicating whether the download is paused, i.e. if the download has stopped reading data from the host but has kept the connection open. If so, the value is true
, false
if not.referrer
string
representing the downloaded file's referrer.startTime
string
(in ISO 8601 format) representing the number of milliseconds between the UNIX epoch and when this download began.state
string
Indicating whether the download is progressing, interrupted, or complete. Possible values are defined in the downloads.State
type.totalBytes
number
indicating the total number of bytes in the file being downloaded. This does not take file compression into consideration. A value of -1 here means that the total number of bytes is unknown.url
string
representing the absolute URL from which the file was downloaded.Desktop | Mobile | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|
Chrome | Edge | Firefox | Internet Explorer | Opera | Safari | WebView Android | Chrome Android | Firefox for Android | Opera Android | Safari on IOS | Samsung Internet | |
byExtensionId |
Yes |
79 |
47 |
? |
Yes |
No |
? |
? |
48-79 |
? |
? |
? |
byExtensionName |
Yes |
79 |
47 |
? |
Yes |
No |
? |
? |
48-79 |
? |
? |
? |
bytesReceived |
Yes |
79 |
47 |
? |
Yes |
No |
? |
? |
48-79 |
? |
? |
? |
canResume |
Yes |
79 |
47 |
? |
Yes |
No |
? |
? |
48-79 |
? |
? |
? |
cookieStoreId |
No |
No |
92 |
? |
No |
No |
? |
? |
No |
? |
? |
? |
danger |
Yes |
79 |
No
Always given as 'safe'.
|
? |
Yes |
No |
? |
? |
No |
? |
? |
? |
endTime |
Yes |
79 |
No |
? |
Yes |
No |
? |
? |
No |
? |
? |
? |
error |
Yes |
79 |
47 |
? |
Yes |
No |
? |
? |
48-79 |
? |
? |
? |
estimatedEndTime |
Yes |
79 |
57 |
? |
Yes |
No |
? |
? |
57-79 |
? |
? |
? |
exists |
Yes |
79 |
47 |
? |
Yes |
No |
? |
? |
48-79 |
? |
? |
? |
filename |
Yes |
79 |
47 |
? |
Yes |
No |
? |
? |
48-79 |
? |
? |
? |
fileSize |
Yes |
79 |
47 |
? |
Yes |
No |
? |
? |
48-79 |
? |
? |
? |
id |
Yes |
79 |
47 |
? |
Yes |
No |
? |
? |
48-79 |
? |
? |
? |
incognito |
Yes |
79 |
47 |
? |
Yes |
No |
? |
? |
48-79 |
? |
? |
? |
mime |
Yes |
79 |
47 |
? |
Yes |
No |
? |
? |
48-79 |
? |
? |
? |
paused |
Yes |
79 |
47 |
? |
Yes |
No |
? |
? |
48-79 |
? |
? |
? |
referrer |
Yes |
79 |
47 |
? |
Yes |
No |
? |
? |
48-79 |
? |
? |
? |
startTime |
Yes |
79 |
47 |
? |
Yes |
No |
? |
? |
48-79 |
? |
? |
? |
state |
Yes |
79 |
47 |
? |
Yes |
No |
? |
? |
48-79 |
? |
? |
? |
totalBytes |
Yes |
79 |
47 |
? |
Yes |
No |
? |
? |
48-79 |
? |
? |
? |
url |
Yes |
79 |
47 |
? |
Yes |
No |
? |
? |
48-79 |
? |
? |
? |
Note: This API is based on Chromium's chrome.downloads
API.
Microsoft Edge compatibility data is supplied by Microsoft Corporation and is included here under the Creative Commons Attribution 3.0 United States License.
© 2005–2021 MDN contributors.
Licensed under the Creative Commons Attribution-ShareAlike License v2.5 or later.
https://developer.mozilla.org/en-US/docs/Mozilla/Add-ons/WebExtensions/API/downloads/DownloadItem