downloads.erase()

Erase matching DownloadItems from history, without deleting the downloaded file.

Syntax

browser.downloads.erase(
  query,                    // DownloadQuery
  function(erasedIds) {...} // optional function
)

Parameters

query

downloads.DownloadQuery.

Values of this type are objects. They contain the following properties:

queryOptional

array of string. This array of search terms limits results to DownloadItems whose filename or url contain all of the search terms that do not begin with a dash '-' and none of the search terms that do begin with a dash.

startedBeforeOptional

downloads.DownloadTime. Limits results to downloads that started before the given ms since the epoch.

startedAfterOptional

downloads.DownloadTime. Limits results to downloads that started after the given ms since the epoch.

endedBeforeOptional

downloads.DownloadTime. Limits results to downloads that ended before the given ms since the epoch.

endedAfterOptional

downloads.DownloadTime. Limits results to downloads that ended after the given ms since the epoch.

totalBytesGreaterOptional

number. Limits results to downloads whose totalBytes is greater than the given integer.

totalBytesLessOptional

number. Limits results to downloads whose totalBytes is less than the given integer.

filenameRegexOptional

string. Limits results to DownloadItems whose filename matches the given regular expression.

urlRegexOptional

string. Limits results to DownloadItems whose url matches the given regular expression.

limitOptional

integer. Setting this integer limits the number of results. Otherwise, all matching DownloadItems will be returned.

orderByOptional

array of string. Setting elements of this array to DownloadItem properties in order to sort the search results. For example, setting orderBy='startTime' sorts the DownloadItems by their start time in ascending order. To specify descending order, prefix orderBy with a hyphen: '-startTime'.

idOptional

integer.

urlOptional

string. Absolute URL.

filenameOptional

string. Absolute local path.

dangerOptional

downloads.DangerType. Indication of whether this download is thought to be safe or known to be suspicious.

mimeOptional

string. The file's MIME type.

startTimeOptional

string.

endTimeOptional

string.

stateOptional

downloads.State. Indicates whether the download is progressing, interrupted, or complete.

pausedOptional

boolean. True if the download has stopped reading data from the host, but kept the connection open.

errorOptional

downloads.InterruptReason. Why a download was interrupted.

bytesReceivedOptional

number. Number of bytes received so far from the host, without considering file compression.

totalBytesOptional

number. Number of bytes in the whole file, without considering file compression, or -1 if unknown.

fileSizeOptional

number. Number of bytes in the whole file post-decompression, or -1 if unknown.

existsOptional

boolean.

callbackOptional

function. The function is passed the following arguments:

erasedIds

array of integer.

Browser compatibility

Examples

// 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.