Welcome Getting started API Reference Samples
Welcome Getting started API Reference Samples

chrome.notifications

  • Description

    Use the chrome.notifications API to create rich notifications using templates and show these notifications to users in the system tray.

  • Permissions
    notifications

Summary

Types

NotificationButton

Properties

  • iconUrl
    string optional

    Deprecated. Button icons not visible for Mac OS X users.

  • title
    string

NotificationItem

Properties

  • message
    string

    Additional details about this item.

  • title
    string

    Title of one item of a list notification.

NotificationOptions

Properties

  • appIconMaskUrl
    string optional

    Deprecated. The app icon mask is not visible for Mac OS X users.

    A URL to the app icon mask. URLs have the same restrictions as iconUrl.

    The app icon mask should be in alpha channel, as only the alpha channel of the image will be considered.

  • buttons

    Text and icons for up to two notification action buttons.

  • contextMessage
    string optional

    Alternate notification content with a lower-weight font.

  • eventTime
    number optional

    A timestamp associated with the notification, in milliseconds past the epoch (e.g. Date.now() + n).

  • iconUrl
    string optional

    A URL to the sender's avatar, app icon, or a thumbnail for image notifications.

    URLs can be a data URL, a blob URL, or a URL relative to a resource within this extension's .crx file Required for create method.

  • imageUrl
    string optional

    Deprecated. The image is not visible for Mac OS X users.

    A URL to the image thumbnail for image-type notifications. URLs have the same restrictions as iconUrl.

  • isClickable
    boolean optional

    Deprecated. This UI hint is ignored as of Chrome 67

  • items
    NotificationItem[] optional

    Items for multi-item notifications. Users on Mac OS X only see the first item.

  • message
    string optional

    Main notification content. Required for create method.

  • priority
    number optional

    Priority ranges from -2 to 2. -2 is lowest priority. 2 is highest. Zero is default. On platforms that don't support a notification center (Windows, Linux & Mac), -2 and -1 result in an error as notifications with those priorities will not be shown at all.

  • progress
    number optional

    Current progress ranges from 0 to 100.

  • requireInteraction
    boolean optional

    Indicates that the notification should remain visible on screen until the user activates or dismisses the notification. This defaults to false.

  • silent
    boolean optional

    Indicates that no sounds or vibrations should be made when the notification is being shown. This defaults to false.

  • title
    string optional

    Title of the notification (e.g. sender name for email). Required for create method.

  • type
    TemplateType optional

    Which type of notification to display. Required for create method.

PermissionLevel

Enum

"granted", or "denied"

TemplateType

Enum

"basic", "image", "list", or "progress"

Methods

clear

chrome.notifications.clear(notificationId: string, callback: function)

Clears the specified notification.

Parameters

  • notificationId
    string

    The id of the notification to be cleared. This is returned by create method.

  • callback
    function

    Called to indicate whether a matching notification existed.

    The callback is required before Chrome 42.

    The callback parameter should be a function that looks like this:

    (wasCleared: boolean) => {...}
    • wasCleared
      boolean

create

chrome.notifications.create(notificationId?: string, options: NotificationOptions, callback: function)

Creates and displays a notification.

Parameters

  • notificationId
    string optional

    Identifier of the notification. If not set or empty, an ID will automatically be generated. If it matches an existing notification, this method first clears that notification before proceeding with the create operation. The identifier may not be longer than 500 characters.

    The notificationId parameter is required before Chrome 42.

  • Contents of the notification.

  • callback
    function

    Returns the notification id (either supplied or generated) that represents the created notification.

    The callback is required before Chrome 42.

    The callback parameter should be a function that looks like this:

    (notificationId: string) => {...}
    • notificationId
      string

getAll

chrome.notifications.getAll(callback: function)

Retrieves all the notifications of this app or extension.

Parameters

  • callback
    function

    Returns the set of notification_ids currently in the system.

    The callback parameter should be a function that looks like this:

    (notifications: object) => {...}
    • notifications
      object

getPermissionLevel

chrome.notifications.getPermissionLevel(callback: function)

Retrieves whether the user has enabled notifications from this app or extension.

Parameters

  • callback
    function

    Returns the current permission level.

    The callback parameter should be a function that looks like this:

    (level: PermissionLevel) => {...}

update

chrome.notifications.update(notificationId: string, options: NotificationOptions, callback: function)

Updates an existing notification.

Parameters

  • notificationId
    string

    The id of the notification to be updated. This is returned by create method.

  • Contents of the notification to update to.

  • callback
    function

    Called to indicate whether a matching notification existed.

    The callback is required before Chrome 42.

    The callback parameter should be a function that looks like this:

    (wasUpdated: boolean) => {...}
    • wasUpdated
      boolean

Events

onButtonClicked

chrome.notifications.onButtonClicked.addListener(listener: function)

The user pressed a button in the notification.

Event

  • listener
    function

    The listener parameter should be a function that looks like this:

    (notificationId: string, buttonIndex: number) => {...}
    • notificationId
      string
    • buttonIndex
      number

onClicked

chrome.notifications.onClicked.addListener(listener: function)

The user clicked in a non-button area of the notification.

Event

  • listener
    function

    The listener parameter should be a function that looks like this:

    (notificationId: string) => {...}
    • notificationId
      string

onClosed

chrome.notifications.onClosed.addListener(listener: function)

The notification closed, either by the system or by user action.

Event

  • listener
    function

    The listener parameter should be a function that looks like this:

    (notificationId: string, byUser: boolean) => {...}
    • notificationId
      string
    • byUser
      boolean

onPermissionLevelChanged

chrome.notifications.onPermissionLevelChanged.addListener(listener: function)

The user changes the permission level. As of Chrome 47, only ChromeOS has UI that dispatches this event.

Event

onShowSettings

chrome.notifications.onShowSettings.addListener(listener: function)

The user clicked on a link for the app's notification settings. As of Chrome 47, only ChromeOS has UI that dispatches this event. As of Chrome 65, that UI has been removed from ChromeOS, too.

Event

  • listener
    function

    Deprecated. Custom notification settings button is no longer supported.

    The listener parameter should be a function that looks like this:

    () => {...}
We serve cookies on this site to analyze traffic, remember your preferences, and optimize your experience.