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

browser.downloads.onErased.addListener(listener)
browser.downloads.onErased.removeListener(listener)
browser.downloads.onErased.hasListener(listener)

Events have three functions:

addListener(callback): 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. Returns true if it is listening, false otherwise.

addListener syntax

Parameters

callback

A callback function that will be called when this event occurs. This function will be passed the following arguments:

downloadId: An integer representing the id of the downloads.DownloadItem that was erased.

Browser compatibility

	Desktop						Mobile
	Chrome	Edge	Firefox	Internet Explorer	Opera	Safari	WebView Android	Chrome Android	Firefox for Android	Opera Android	Safari on IOS	Samsung Internet
`onErased`	Yes	79	48	?	Yes	No	?	?	48–79	?	No	?

Examples

Add a listener for onErased events, then erase the most recent download:

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.

© 2005–2023 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/onErased