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
Summary
- Types
- Methods
- Events
Types
NotificationBitmap
NotificationButton
Properties
- iconUrl
string optional
Deprecated since Chrome 59Button 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 since Chrome 59The 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
NotificationButton[] optional
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
notifications.create
method. - imageUrl
string optional
Deprecated since Chrome 59The 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 since Chrome 67This 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
notifications.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
Chrome 50+Indicates that the notification should remain visible on screen until the user activates or dismisses the notification. This defaults to false.
- silent
boolean optional
Chrome 70+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
notifications.create
method. - type
TemplateType optional
Which type of notification to display. Required for
notifications.create
method.
PermissionLevel
Type
"granted"
, or"denied"
TemplateType
Type
"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
notifications.create
method. - callback
function optional
The
callback
parameter looks like:(wasCleared: boolean) => void
- 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. - options
Contents of the notification.
- callback
function optional
The
callback
parameter looks like:(notificationId: string) => void
- notificationId
string
getAll
chrome.notifications.getAll(
callback:
function,
)
Retrieves all the notifications of this app or extension.
Parameters
- callback
function
The
callback
parameter looks like:(notifications: object) => void
- notifications
object
getPermissionLevel
chrome.notifications.getPermissionLevel(
callback:
function,
)
Retrieves whether the user has enabled notifications from this app or extension.
Parameters
- callback
function
The
callback
parameter looks like:(level: PermissionLevel) => void
- level
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
notifications.create
method. - options
Contents of the notification to update to.
- callback
function optional
The
callback
parameter looks like:(wasUpdated: boolean) => void
- wasUpdated
boolean
Events
onButtonClicked
chrome.notifications.onButtonClicked.addListener(
callback:
function,
)
The user pressed a button in the notification.
Parameters
- callback
function
The
callback
parameter looks like:(notificationId: string, buttonIndex: number) => void
- notificationId
string
- buttonIndex
number
onClicked
chrome.notifications.onClicked.addListener(
callback:
function,
)
The user clicked in a non-button area of the notification.
Parameters
- callback
function
The
callback
parameter looks like:(notificationId: string) => void
- notificationId
string
onClosed
chrome.notifications.onClosed.addListener(
callback:
function,
)
The notification closed, either by the system or by user action.
Parameters
- callback
function
The
callback
parameter looks like:(notificationId: string, byUser: boolean) => void
- notificationId
string
- byUser
boolean
onPermissionLevelChanged
chrome.notifications.onPermissionLevelChanged.addListener(
callback:
function,
)
The user changes the permission level. As of Chrome 47, only ChromeOS has UI that dispatches this event.
Parameters
- callback
function
The
callback
parameter looks like:(level: PermissionLevel) => void
- level
onShowSettings
chrome.notifications.onShowSettings.addListener(
callback:
function,
)
Custom notification settings button is no longer supported.
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.
Parameters
- callback
function
The
callback
parameter looks like:() => void