downloads.DownloadItem

The DownloadItem type of the downloads API represents a downloaded file.

Type

Values of this type are objects. They contain the following properties:

byExtensionIdOptional
A 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.
byExtensionNameOptional
A 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
A number representing the number of bytes received so far from the host during the download; this does not take file compression into consideration.
canResume
A boolean indicating whether a currently-interrupted (e.g. paused) download can be resumed from the point where it was interrupted (true), or not (false).
danger
A string indicating whether this download is thought to be safe or known to be suspicious. Its possible values are defined in the downloads.DangerType type.
endTimeOptional
A 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.
errorOptional
A string indicating why a download was interrupted. Possible values are defined in the downloads.InterruptReason type. This is undefined if an error has not occurred.
estimatedEndTimeOptional
A 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
A 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
A string representing the file's absolute local path.
fileSize
A 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
An integer representing a unique identifier for the downloaded file that is persistent across browser sessions.
incognito
A boolean that indicates whether the download is recorded in the browser's history (false), or not (true).
mime
A string representing the downloaded file's MIME type.
paused
A 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
A string representing the downloaded file's referrer.
startTime
A string (in ISO 8601 format) representing the number of milliseconds between the UNIX epoch and when this download began.
state
A string Indicating whether the download is progressing, interrupted, or complete. Possible values are defined in the downloads.State type.
totalBytes
A 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
A string representing the absolute URL from which the file was downloaded.

Browser compatibility

Update compatibility data on GitHub
DesktopMobile
ChromeEdgeFirefoxOperaFirefox for Android
byExtensionIdChrome Full support YesEdge No support NoFirefox Full support 47Opera Full support YesFirefox Android Full support 48
byExtensionNameChrome Full support YesEdge No support NoFirefox Full support 47Opera Full support YesFirefox Android Full support 48
bytesReceivedChrome Full support YesEdge No support NoFirefox Full support 47Opera Full support YesFirefox Android Full support 48
canResumeChrome Full support YesEdge No support NoFirefox Full support 47Opera Full support YesFirefox Android Full support 48
dangerChrome Full support YesEdge No support NoFirefox No support No
Notes
No support No
Notes
Notes Always given as 'safe'.
Opera Full support YesFirefox Android No support No
Notes
No support No
Notes
Notes Always given as 'safe'.
endTimeChrome Full support YesEdge No support NoFirefox No support NoOpera Full support YesFirefox Android No support No
errorChrome Full support YesEdge No support NoFirefox Full support 47Opera Full support YesFirefox Android Full support 48
estimatedEndTimeChrome Full support YesEdge No support NoFirefox Full support 57Opera Full support YesFirefox Android Full support 57
existsChrome Full support YesEdge No support NoFirefox Full support 47Opera Full support YesFirefox Android Full support 48
filenameChrome Full support YesEdge No support NoFirefox Full support 47Opera Full support YesFirefox Android Full support 48
fileSizeChrome Full support YesEdge No support NoFirefox Full support 47Opera Full support YesFirefox Android Full support 48
idChrome Full support YesEdge No support NoFirefox Full support 47Opera Full support YesFirefox Android Full support 48
incognitoChrome Full support YesEdge No support NoFirefox Full support 47Opera Full support YesFirefox Android Full support 48
mimeChrome Full support YesEdge No support NoFirefox Full support 47Opera Full support YesFirefox Android Full support 48
pausedChrome Full support YesEdge No support NoFirefox Full support 47Opera Full support YesFirefox Android Full support 48
referrerChrome Full support YesEdge No support NoFirefox Full support 47Opera Full support YesFirefox Android Full support 48
startTimeChrome Full support YesEdge No support NoFirefox Full support 47Opera Full support YesFirefox Android Full support 48
stateChrome Full support YesEdge No support NoFirefox Full support 47Opera Full support YesFirefox Android Full support 48
totalBytesChrome Full support YesEdge No support NoFirefox Full support 47Opera Full support YesFirefox Android Full support 48
urlChrome Full support YesEdge No support NoFirefox Full support 47Opera Full support YesFirefox Android Full support 48

Legend

Full support  
Full support
No support  
No support
See implementation notes.
See implementation notes.

Acknowledgements

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.

Document Tags and Contributors

Contributors to this page: wbamberg, andrewtruongmoz, JeffersonScher, chrisdavidmills
Last updated by: wbamberg,