downloads.onErased
The onErased()
event of the downloads
API fires when a download is erased from the browser history.
The listener is passed the downloadId
of the downloads.DownloadItem
object in question as a parameter.
Syntax
js
browser.downloads.onErased.addListener(listener)
browser.downloads.onErased.removeListener(listener)
browser.downloads.onErased.hasListener(listener)
Events have three functions:
addListener(listener)
-
Adds a listener to this event.
removeListener(listener)
-
Stop listening to this event. The
listener
argument is the listener to remove. hasListener(listener)
-
Check whether a given
listener
is registered for this event. Returnstrue
if it is listening,false
otherwise.
addListener syntax
Parameters
listener
-
The function called when this event occurs. This function is passed this argument:
downloadId
-
An
integer
representing theid
of thedownloads.DownloadItem
that was erased.
Browser compatibility
BCD tables only load in the browser
Examples
Add a listener for onErased
events, then erase the most recent download:
js
function handleErased(item) {
console.log(`Erased: ${item}`);
}
browser.downloads.onErased.addListener(handleErased);
let erasing = browser.downloads.erase({
limit: 1,
orderBy: ["-startTime"]
});
Note: This API is based on Chromium's chrome.downloads
API.