This type contains all the data needed to:
- create a notification using
notifications.create()
, - update an existing notification using
notifications.update()
.
This type contains all the data needed to:
notifications.create()
,notifications.update()
.Values of this type are objects. They contain the properties listed below.
The first three properties - type
, title
, message
- are mandatory in notifications.create()
, but optional in notifications.update()
. Firefox currently: only supports the type
, title
, message
, and iconUrl
properties; and the only supported value for type
is 'basic'
.
type
notifications.TemplateType
. The type of notification you want. Depending on your choice here, certain other properties are either mandatory or are not permitted.
message
string
. The notification's main content.
title
string
. The notification's title.
iconUrl
Optional
string
. A URL pointing to an icon to display in the notification. The URL can be: a data URL, a blob URL, a http or https URL, or the relative URL of a file within the extension. When using an SVG image, ensure that the image includes height and width attributes, for example, <svg width="96" height="96"…
. Otherwise, the image may not display.
contextMessage
Optional
string
. Supplementary content to display.
priority
Optional
number
. The notification's priority: may be 0, 1, or 2. Defaults to 0 if omitted.
eventTime
Optional
number
. A timestamp for the notification in milliseconds since the epoch.
array
of button
. An array of up to 2 buttons to include in the notification. You can listen for button clicks using notifications.onButtonClicked
. Each button is specified as an object with the following properties:
title
string
. Title for the button.
iconUrl
Optional
string
. URL pointing to an icon for the button.
imageUrl
string
. A URL pointing to an image to use in the notification. The URL can be: a data URL, a blob URL, or the relative URL of a file within the extension. When using an SVG image, ensure that the image includes height and width attributes, for example, <svg width="96" height="96"…
. Otherwise, the image may not display.
This property is only permitted if type
is "image"
. In this case, it is mandatory if the NotificationOptions
is used in notifications.create()
, and optional if it is used in notifications.update()
.
items
array
of item
. An array of items to include in the notification. Depending on the settings for the operating system's notification mechanism, some of the items you provide might not be displayed. Each item is specified as an object with the following properties:
title
string
. Title to display in the item.
message
string
. Message to display in the item.
This property is only permitted if type
is "list"
. In this case, it is mandatory if the NotificationOptions
is used in notifications.create()
, and optional if it is used in notifications.update()
.
progress
integer
. An integer between 0 and 100, used to represent the current progress in a progress indicator.
This property is only permitted if type
is "progress"
. In this case, it is mandatory if the NotificationOptions
is used in notifications.create()
, and optional if it is used in notifications.update()
.
Note that appIconMaskUrl
and isClickable
are not supported.
Desktop | Mobile | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|
Chrome | Edge | Firefox | Internet Explorer | Opera | Safari | WebView Android | Chrome Android | Firefox for Android | Opera Android | Safari on IOS | Samsung Internet | |
NotificationOptions |
Yes | 17 | 45 | ? | Yes | No | ? | ? | 48 | ? | No | ? |
appIconMaskUrl |
Yes | 79 |
NoSpecifying this option doesn't throw an error, but its value is ignored. |
? | Yes | No | ? | ? |
NoSpecifying this option doesn't throw an error, but its value is ignored. |
? | No | ? |
buttons |
Yes | 79 | No | ? |
NoSpecifying the 'buttons' option will cause an asynchronous error on Opera. |
No | ? | ? | No | ? | No | ? |
contextMessage |
31 | 79 |
NoSpecifying this option doesn't throw an error, but its value is ignored. |
? |
NoSpecifying this option doesn't throw an error, but its value is ignored, on Opera 18 and above. |
No | ? | ? |
NoSpecifying this option doesn't throw an error, but its value is ignored. |
? | No | ? |
eventTime |
Yes | 79 |
NoSpecifying this option doesn't throw an error, but its value is ignored. |
? | Yes | No | ? | ? |
NoSpecifying this option doesn't throw an error, but its value is ignored. |
? | No | ? |
imageUrl |
Yes | 79 |
NoSpecifying this option doesn't throw an error, but its value is ignored. |
? |
NoSpecifying this option doesn't throw an error, but its value is ignored. |
No | ? | ? |
NoSpecifying this option doesn't throw an error, but its value is ignored. |
? | No | ? |
isClickable |
32 | 79 |
NoSpecifying this option doesn't throw an error, but its value is ignored. |
? |
NoSetting 'isClickable' to false will cause an asynchronous error on Opera 19 and above. Older Opera versions throw an error synchronously if this options is given. |
No | ? | ? |
NoSpecifying this option doesn't throw an error, but its value is ignored. |
? | No | ? |
items |
YesOn macOS only the first item is shown. |
79On macOS only the first item is shown. |
NoSpecifying this option doesn't throw an error, but its value is ignored. |
? |
NoSpecifying this option doesn't throw an error, but its value is ignored. |
No | ? | ? |
NoSpecifying this option doesn't throw an error, but its value is ignored. |
? | No | ? |
priority |
Yes | 79 |
NoSpecifying this option doesn't throw an error, but its value is ignored. |
? | Yes | No | ? | ? |
NoSpecifying this option doesn't throw an error, but its value is ignored. |
? | No | ? |
progress |
30 | 79 |
NoSpecifying this option doesn't throw an error, but its value is ignored. |
? |
NoSpecifying this option doesn't throw an error, but its value is ignored, on Opera 17 and above. |
No | ? | ? |
NoSpecifying this option doesn't throw an error, but its value is ignored. |
? | No | ? |
requireInteraction |
50 | 79 | No | ? |
NoSpecifying this option doesn't throw an error, but its value is ignored, on Opera 37 and above. |
No | ? | ? | No | ? | No | ? |
Note: This API is based on Chromium's chrome.notifications
API.
© 2005–2023 MDN contributors.
Licensed under the Creative Commons Attribution-ShareAlike License v2.5 or later.
https://developer.mozilla.org/en-US/docs/Mozilla/Add-ons/WebExtensions/API/notifications/NotificationOptions