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

chrome.downloads.onErased.addListener(function(downloadId) {...})
chrome.downloads.onErased.removeListener(listener)
chrome.downloads.onErased.hasListener(listener)

This API is also available as browser.downloads.onErased.*.

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

Chrome Edge Firefox Firefox for Android Opera
Basic support Yes No 48.0 48.0 33

Examples

In this snippet, we have two buttons, one that downloads a copy of a video by calling downloads.download(), and another that deletes all the files that have been downloaded. It does this by calling downloads.search() with an empty query object to return all downloads, then calling downloads.removeFile() and downloads.erase() for each download id.

The onErased event is fired after each downloads.erase() call; in the event handler, we are reporting the id of each erased download to the console.

var downloadBtn = document.querySelector('.download');
var deleteBtn = document.querySelector('.delete');

downloadBtn.onclick = function() {
  chrome.downloads.download({ url : 'http://www.example.com/myBigVideo.mp4'});
}

deleteBtn.onclick = function() {
  chrome.downloads.search({}, function(results) {
    for(var i = 0; i < results.length; i++) {
      chrome.downloads.removeFile(results[i].id);
      chrome.downloads.erase({ id : results[i].id });
    }
  });
}

chrome.downloads.onErased.addListener(function(downloadId) {
  console.log('Deleted file ID: ' + downloadId);
});

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: Makyen, chrisdavidmills, wbamberg
 Last updated by: Makyen,