notifications.clear()

Clears a notification, given its ID.

Syntax

chrome.notifications.clear(
  id,                            // string
  function(wasCleared) {...}     // optional function
)

This API is also available as browser.notifications.clear() in a version that returns a promise.

Parameters

id

string. The ID of the notification to clear. This is the same as the ID passed into notifications.create()'s callback.

callbackOptional

function. The function is passed the following arguments:

wasCleared

boolean. true if the notification was cleared, or false if it was not (for example, because the notification referenced by id did not exist).

Browser compatibility

The compatibility table in 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

This example shows a notification when the user clicks a browser action, unless the notification was already being shown, in which case it clears the notification:

var myNotification = "my-notification";

chrome.browserAction.onClicked.addListener(function () {
  chrome.notifications.getAll((all) => {
    if (myNotification in all) {
      chrome.notifications.clear(myNotification);
    } else {
      chrome.notifications.create(myNotification, {
        "type": "basic",
        "iconUrl": chrome.extension.getURL("icons/cake-48.png"),
        "title": "Am imposing title",
        "message": "Some interesting content"
      });
    }
  });
});