Spec-Zone.ru › Web APIs

API оповещений

Ограниченная доступность

Эта функция не является базовой, так как она не работает в некоторых из самых широко используемых браузеров.

  • Подробнее
  • Полная совместимость
  • Отправить отзыв

Безопасный контекст: Эта функция доступна только в безопасных контекстах (HTTPS) в некоторых или всех поддерживающих браузерах.

Примечание: Эта функция доступна в Web Workers.

API оповещений предоставляет веб-разработчикам способ установки значка на документе или приложении в качестве уведомления о том, что состояние изменилось, не отображая более отвлекающие уведомления. Типичный пример использования — приложение с функцией обмена сообщениями, отображающее значок на значке приложения, чтобы показать, что новые сообщения поступили.

Концепции и использование

Веб-разработчики часто обновляют значки закладок или заголовки документов для указания состояния. API оповещений предоставляет более элегантный способ отображения состояния, предоставляя метод, который имеет смысл для пользователя и может поэтому отображаться таким образом, который соответствует остальной части пользовательского интерфейса.

Типы значков

Существует два типа значков:

  • Значки документа, которые обычно отображаются в вкладке браузера рядом с или на значке страницы.
  • Значки приложения, которые связаны с значком установленного веб-приложения. Они могут отображаться на значке приложения в доке, полке или на главном экране в зависимости от используемого устройства.

Состояния значков

Значок может иметь одно из трех возможных значений, которые устанавливаются внутри:

nothing

Указывает, что в настоящее время значок не установлен. Значок может быть в этом состоянии из-за его очистки приложением или сброса пользовательским агентом.

flag

Указывает, что значок установлен, но не имеет конкретных данных для отображения. Значок будет в этом состоянии, если приложение установило значок, но не передало никакого значения в метод.

целое число

Значение, передаваемое при установке значка. Это значение никогда не будет 0, передача значения 0 при установке значка приведет к очистке значка пользовательским агентом, установив его в nothing.

Установка значков

Значок устанавливается с помощью методов setAppBadge() (для установленных приложений). Если эти методы не получают параметров, значение значка равно flag. Пользовательский агент отобразит значок уведомления, например, цветной круг на значке.

Эти методы также могут получить параметр contents, который должен быть числом. Затем это число будет отображаться как часть значка. Пользовательские агенты могут изменить это значение каким-либо образом. Например, если вы передадите очень большое число, например, 4000, пользовательский агент может отобразить его как 99+ в значке. Пользовательские агенты также могут проигнорировать эти данные и отобразить маркер вместо этого.

Очистка значков

Значки очищаются с помощью методов clearAppBadge(). Эти методы не принимают параметров и устанавливают значение значка в nothing. Кроме того, передача значения 0 в setAppBadge() установит значение значка в nothing и очистит значок.

Интерфейсы

Нет.

Расширения интерфейса Navigator

Navigator.setAppBadge()

Устанавливает значок на значке, связанном с этим приложением.

Navigator.clearAppBadge()

Очищает значок на значке, связанном с этим приложением.

Расширения интерфейса WorkerNavigator

WorkerNavigator.setAppBadge()

Устанавливает значок на значке, связанном с этим приложением.

WorkerNavigator.clearAppBadge()

Очищает значок на значке, связанном с этим приложением.

Примеры

Для установки значка уведомления на текущем приложении со значением 12:

navigator.setAppBadge(12);

Для очистки значка уведомления на текущем приложении:

navigator.clearAppBadge();

Спецификации

Спецификация
API оповещений
# setappbadge-method

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

Рабочий стол Мобильные устройства
Chrome Edge Firefox Opera Safari Chrome Android Firefox для Android Opera Android Safari на IOS Samsung Internet WebView Android
Badging_API
81Только Windows и macOS. Linux не предлагает универсального API оповещений на уровне операционной системы.
81Только Windows и macOS. Linux не предлагает универсального API оповещений на уровне операционной системы.
Нет Нет
17["Оповещения поддерживаются для установленных веб-приложений на macOS Sonoma и выше.", "Передача 0 в качестве аргумента очистит значок вместо отображения точки без номера."]
Нет Нет Нет
16.4["Оповещения поддерживаются для веб-приложений, сохраненных на главном экране.", "Передача 0 в качестве аргумента очистит значок вместо отображения точки без номера."]
Нет Нет

См. также

  • Оповещения для значков приложений
  • Описание API оповещений

© 2005–2024 MDN contributors.
Licensed under the Creative Commons Attribution-ShareAlike License v2.5 or later.
https://developer.mozilla.org/en-US/docs/Web/API/Badging_API

Spec-Zone.ru

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