notifications.onClosed
Fired when a notification is closed, either by the system or by the user.
Syntax
browser.notifications.onClosed.addListener(listener)
browser.notifications.onClosed.removeListener(listener)
browser.notifications.onClosed.hasListener(listener)
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
listener
is registered for this event. Returnstrue
if it is listening,false
otherwise.
addListener syntax
Parameters
callback
-
Function that will be called when this event occurs. The function will be passed the following arguments:
notificationId
string
. ID of the notification that closed.byUser
boolean
.true
if the notification was closed by the user, orfalse
if it was closed by the system. This argument is not supported in Firefox.
Browser compatibility
Report problems with this compatibility data on GitHubwebextensions-desktop | webextensions-mobile | |||||
---|---|---|---|---|---|---|
onClosed | ChromeFull support28 | EdgeFull support17 | FirefoxFull support45 | OperaFull support25 | SafariNo supportNo | Firefox for AndroidFull support48 |
byUser | ChromeFull supportYes | EdgeFull support79 | FirefoxNo supportNo | OperaFull supportYes | SafariNo supportNo | Firefox for AndroidNo supportNo |
Legend
- Full support
- Full support
- No support
- No support
The compatibility table on 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 simple example we add a listener to the notifications.onClosed
event to listen for system notifications being closed. When this occurs, we log an appropriate message to the console.
browser.notifications.onClosed.addListener(function(notificationId) {
console.log('Notification ' + notificationId + ' has closed.');
});
Acknowledgements
This API is based on Chromium's chrome.notifications
API.
Microsoft Edge compatibility data is supplied by Microsoft Corporation and is included here under the Creative Commons Attribution 3.0 United States License.