downloads.onChanged
The onChanged() event of the downloads API is fired when any of a downloads.DownloadItem's properties changes (except for bytesReceived).
The onChanged() event of the downloads API is fired when any of a downloads.DownloadItem's properties changes (except for bytesReceived).
The listener is passed a downloadDelta as a parameter — an object containing the downloadId of the downloads.DownloadItem object in question, plus the status of all the properties that changed.
Syntax
browser.downloads.onChanged.addListener(listener)
browser.downloads.onChanged.removeListener(listener)
browser.downloads.onChanged.hasListener(listener)
Events have three functions:
addListener(listener)- : Adds a listener to this event.
removeListener(listener)- : Stop listening to this event. The
listenerargument is the listener to remove. hasListener(listener)- : Check whether a given
listeneris registered for this event. Returnstrueif it is listening,falseotherwise.
addListener syntax
Parameters
listener- : The function called when this event occurs. This function will be passed this argument:
downloadDelta- : An
objectrepresenting the downloads.DownloadItem object that changed, and the status of all the properties that changed in it. See the downloadDelta section for more details.
Additional objects
downloadDelta
The downloadDelta object has the following properties available:
id- : An
integerrepresenting theidof the downloads.DownloadItem that changed. url- : A downloads.StringDelta object describing a change in a downloads.DownloadItem's
url. filename- : A downloads.StringDelta object describing a change in a downloads.DownloadItem's
filename. danger- : A downloads.StringDelta object describing a change in a downloads.DownloadItem's
danger. mime- : A downloads.StringDelta object describing a change in a downloads.DownloadItem's
mime. startTime- : A downloads.StringDelta object describing a change in a downloads.DownloadItem's
startTime. endTime- : A downloads.StringDelta object describing a change in a downloads.DownloadItem's
endTime. state- : A downloads.StringDelta object describing a change in a downloads.DownloadItem's
state. canResume- : A downloads.BooleanDelta object describing a change in a downloads.DownloadItem's
canResumestatus. paused- : A downloads.BooleanDelta object describing a change in a downloads.DownloadItem's
pausedstatus. error- : A downloads.StringDelta object describing a change in a downloads.DownloadItem's
errorstatus. totalBytes- : A downloads.DoubleDelta object describing a change in a downloads.DownloadItem's
totalBytes. fileSize- : A downloads.DoubleDelta object describing a change in a downloads.DownloadItem's
fileSize. exists- : A downloads.BooleanDelta object describing a change in a downloads.DownloadItem's
existsstatus.
Examples
Log a message when downloads complete:
function handleChanged(delta) {
if (delta.state && delta.state.current === "complete") {
console.log(`Download ${delta.id} has completed.`);
}
}
browser.downloads.onChanged.addListener(handleChanged);
Browser compatibility
[!NOTE] This API is based on Chromium's
chrome.downloadsAPI.