downloads.onCreated

The onCreated() event of the downloads API fires when a download begins, i.e. when downloads.download() is successfully invoked.

The listener is passed the downloads.DownloadItem object in question as a parameter.

Syntax

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

Events have three functions:

addListener(listener): 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

function

The function called when this event occurs. This function is passed this argument:

downloadItem: The downloads.DownloadItem object in question.

Browser compatibility

BCD tables only load in the browser

Examples

Log the URL of items as they are downloaded:

function handleCreated(item) {
  console.log(item.url);
}

browser.downloads.onCreated.addListener(handleCreated);

Note: This API is based on Chromium's chrome.downloads API.