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. Returns true 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, or false if it was closed by the system. This argument is not supported in Firefox.

Browser compatibility

Chrome Edge Firefox Firefox for Android Opera
Basic support Yes No 45.0 48.0 33

Compatibility notes

Firefox

  • byUser is not supported.

Firefox for Android

  • byUser is not supported.

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.

Document Tags and Contributors

 Contributors to this page: wbamberg, Makyen, chrisdavidmills
 Last updated by: wbamberg,