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
listenerargument is the listener to remove. hasListener(listener)-
Check whether a given
listeneris registered for this event. Returnstrueif it is listening,falseotherwise.
addListener syntax
Parameters
function-
The function called when this event occurs. This function is passed this argument:
downloadItem-
The
downloads.DownloadItemobject in question.
Examples
Log the URL of items as they are downloaded:
function handleCreated(item) {
console.log(item.url);
}
browser.downloads.onCreated.addListener(handleCreated);
Browser compatibility
| desktop | mobile | ||||||
|---|---|---|---|---|---|---|---|
onCreated
|
|
|
|
|
|
|
|
Legend
Tip: you can click/tap on a cell for more information.
- Full support
- Full support
- No support
- No support
Note:
This API is based on Chromium's chrome.downloads API.