notifications.NotificationOptions

This type contains all the data needed to:

• create a notification using notifications.create(),
• update an existing notification using notifications.update().

Type

Values of this type are objects. They contain the properties listed below.

The first four properties - type, iconUrl, title, message - are mandatory in notifications.create(), and optional in notifications.update(). Firefox currently supports only these four properties.

type

notifications.TemplateType. The type of notification you want. Depending on your choice here, certain other properties are either mandatory or are not permitted.

iconUrl

string. A URL pointing to an icon to display in the notification. The URL can be: a data URL, a blob URL, or the relative URL of a file within the add-on.

title

string. The notification's title.

message

string. The notification's main content.

contextMessageOptional

string. Supplementary content to display.

priorityOptional

number. The notification's priority: may be 0, 1, or 2. Defaults to 0 if omitted.

eventTimeOptional

number. A timestamp for the notification in milliseconds since the epoch.

buttonsOptional

array of button. An array of up to 2 buttons to include in the notification. You can listen for button clicks using notifications.onButtonClick. Each button is specified as an object with the following properties:

title

string. Title for the button.

iconUrlOptional

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 add-on.

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.

Browser compatibility

1. Firefox only supports: type, iconUrl, title, message.
2. Firefox only supports: type, iconUrl, title, message.