Spec-Zone.ru › Web Extensions

notifications.NotificationOptions

Этот тип содержит все данные, необходимые для:

  • создания уведомления с помощью notifications.create(),
  • обновления существующего уведомления с помощью notifications.update().

Тип

Значения этого типа — объекты. Они содержат свойства, перечисленные ниже.

Первые три свойства — type, title, message — являются обязательными в notifications.create(), но необязательными в notifications.update(). В настоящее время Firefox поддерживает только свойства type, title, message, и iconUrl; и единственное поддерживаемое значение для type — 'basic'.

type

notifications.TemplateType. Тип уведомления, который вы хотите. В зависимости от вашего выбора здесь, некоторые другие свойства являются обязательными или запрещены.

message

string. Основное содержимое уведомления.

title

string. Заголовок уведомления.

iconUrl Необязательно

string. URL, указывающий на значок для отображения в уведомлении. URL может быть: URL данных, URL объекта, URL http или https, или относительный URL файла внутри расширения. При использовании изображения SVG убедитесь, что изображение содержит атрибуты высоты и ширины, например, <svg width="96" height="96"…. В противном случае изображение может не отобразиться.

contextMessage Необязательно

string. Дополнительное содержимое для отображения.

priority Необязательно

number. Приоритет уведомления: может быть 0, 1 или 2. По умолчанию равен 0, если опущено.

eventTime Необязательно

number. Отметка времени уведомления в миллисекундах с момента эпохи.

buttons Необязательно

array из button. Массив до 2 кнопок для включения в уведомление. Вы можете прослушивать щелчки кнопок с помощью notifications.onButtonClicked. Каждая кнопка задаётся как объект со следующими свойствами:

title

string. Заголовок кнопки.

iconUrl Необязательно

string. URL, указывающий на значок для кнопки.

imageUrl

string. URL, указывающий на изображение для использования в уведомлении. URL может быть: URL данных, URL объекта или относительным URL файла внутри расширения. При использовании изображения SVG убедитесь, что изображение содержит атрибуты высоты и ширины, например, <svg width="96" height="96"…. В противном случае изображение может не отобразиться.

Это свойство разрешено только если type равно "image". В этом случае оно является обязательным, если NotificationOptions используется в notifications.create(), и необязательным, если используется в notifications.update().

items

array из item. Массив элементов для включения в уведомление. В зависимости от настроек механизма уведомлений операционной системы, некоторые из предоставленных вами элементов могут не отображаться. Каждый элемент задаётся как объект со следующими свойствами:

title

string. Заголовок для отображения в элементе.

message

string. Сообщение для отображения в элементе.

Это свойство разрешено только если type равно "list". В этом случае оно является обязательным, если NotificationOptions используется в notifications.create(), и необязательным, если используется в notifications.update().

progress

integer. Целое число от 0 до 100, используемое для представления текущего прогресса в индикаторе прогресса.

Это свойство разрешено только если type равно "progress". В этом случае оно является обязательным, если NotificationOptions используется в notifications.create(), и необязательным, если используется в notifications.update().

Обратите внимание, что appIconMaskUrl и isClickable не поддерживаются.

Совместимость с браузерами

Рабочий стол Мобильные устройства
Chrome Edge Firefox Internet Explorer Opera Safari WebView Android Chrome Android Firefox for Android Opera Android Safari на IOS Samsung Internet
NotificationOptions Да 17 45 ? Да Нет ? ? 48 ? Нет ?
appIconMaskUrl Да 79
НетУказание этого параметра не приводит к ошибке, но его значение игнорируется.
? Да Нет ? ?
НетУказание этого параметра не приводит к ошибке, но его значение игнорируется.
? Нет ?
buttons Да 79 Нет ?
НетУказание параметра 'buttons' вызовет асинхронную ошибку в Opera.
Нет ? ? Нет ? Нет ?
contextMessage 31 79
НетУказание этого параметра не приводит к ошибке, но его значение игнорируется.
?
НетУказание этого параметра не приводит к ошибке, но его значение игнорируется в Opera 18 и выше.
Нет ? ?
НетУказание этого параметра не приводит к ошибке, но его значение игнорируется.
? Нет ?
eventTime Да 79
НетУказание этого параметра не приводит к ошибке, но его значение игнорируется.
? Да Нет ? ?
НетУказание этого параметра не приводит к ошибке, но его значение игнорируется.
? Нет ?
imageUrl Да 79
НетУказание этого параметра не приводит к ошибке, но его значение игнорируется.
?
НетУказание этого параметра не приводит к ошибке, но его значение игнорируется.
Нет ? ?
НетУказание этого параметра не приводит к ошибке, но его значение игнорируется.
? Нет ?
isClickable 32 79
НетУказание этого параметра не приводит к ошибке, но его значение игнорируется.
?
НетУказание 'isClickable' в значении false вызовет асинхронную ошибку в Opera 19 и выше. Более старые версии Opera бросают ошибку синхронно, если этот параметр задан.
Нет ? ?
НетУказание этого параметра не приводит к ошибке, но его значение игнорируется.
? Нет ?
items
ДаТолько первый элемент отображается на macOS.
79Только первый элемент отображается на macOS.
НетУказание этого параметра не приводит к ошибке, но его значение игнорируется.
?
НетУказание этого параметра не приводит к ошибке, но его значение игнорируется.
Нет ? ?
НетУказание этого параметра не приводит к ошибке, но его значение игнорируется.
? Нет ?
priority Да 79
НетУказание этого параметра не приводит к ошибке, но его значение игнорируется.
? Да Нет ? ?
НетУказание этого параметра не приводит к ошибке, но его значение игнорируется.
? Нет ?
progress 30 79
НетУказание этого параметра не приводит к ошибке, но его значение игнорируется.
?
НетУказание этого параметра не приводит к ошибке, но его значение игнорируется в Opera 17 и выше.
Нет ? ?
НетУказание этого параметра не приводит к ошибке, но его значение игнорируется.
? Нет ?
requireInteraction 50 79 Нет ?
НетУказание этого параметра не приводит к ошибке, но его значение игнорируется в Opera 37 и выше.
Нет ? ? Нет ? Нет ?

Примечание: Этот API основан на API chrome.notifications Chromium.

© 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

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API