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

BCD tables only load in the browser

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);

var erasing = browser.downloads.erase({
  limit: 1,
  orderBy: ["-startTime"]
});

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.