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

The compatibility table in this page is generated from structured data. If you'd like to contribute to the data, please check out https://github.com/mdn/browser-compat-data and send us a pull request.

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 : 'https://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);
});

// Copyright 2015 The Chromium Authors. All rights reserved.
//
// Redistribution and use in source and binary forms, with or without
// modification, are permitted provided that the following conditions are
// met:
//
//    * Redistributions of source code must retain the above copyright
// notice, this list of conditions and the following disclaimer.
//    * Redistributions in binary form must reproduce the above
// copyright notice, this list of conditions and the following disclaimer
// in the documentation and/or other materials provided with the
// distribution.
//    * Neither the name of Google Inc. nor the names of its
// contributors may be used to endorse or promote products derived from
// this software without specific prior written permission.
//
// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
// "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
// LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
// A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
// OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
// SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
// LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
// DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
// THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
// (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
// OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.