Opis
Przy użyciu interfejsu API chrome.notifications
możesz tworzyć zaawansowane powiadomienia za pomocą szablonów i wyświetlać je użytkownikom w obszarze powiadomień.
Uprawnienia
notifications
Typy
NotificationBitmap
NotificationButton
Właściwości
-
iconUrl
ciąg znaków opcjonalny
Wycofane od Chrome 59Ikony przycisków nie są widoczne w systemie Mac OS X.
-
title
string,
NotificationItem
Właściwości
-
wiadomość
string,
Dodatkowe informacje o tym elemencie.
-
title
string,
Tytuł jednego elementu powiadomienia z listą.
NotificationOptions
Właściwości
-
appIconMaskUrl
ciąg znaków opcjonalny
Wycofane od Chrome 59Maska ikony aplikacji nie jest widoczna dla użytkowników systemu macOS.
Adres URL maski ikony aplikacji. Adresy URL mają takie same ograniczenia jak iconUrl.
Maska ikony aplikacji powinna być w wersji alfa, ponieważ brany jest pod uwagę tylko kanał alfa obrazu.
-
przyciski
NotificationButton[] opcjonalnie
Tekst i ikony maksymalnie 2 przycisków działań dotyczących powiadomień.
-
contextMessage
ciąg znaków opcjonalny
Alternatywne treści powiadomień z mniejszą czcionką.
-
eventTime
Liczba opcjonalnie
Związana z powiadomieniem sygnatura czasowa (w milisekundach od początku epoki, np.
Date.now() + n
). -
iconUrl
ciąg znaków opcjonalny
Adres URL awatara nadawcy, ikony aplikacji lub miniatury powiadomień graficznych.
Adresy URL mogą być adresami URL danych, obiektu blob lub adresem URL względnym do zasobu w pliku .crx tego rozszerzenia.
**Uwaga:**ta wartość jest wymagana w przypadku metody
notifications.create
()
. -
imageUrl
ciąg znaków opcjonalny
Wycofane od Chrome 59Obraz nie jest widoczny dla użytkowników systemu Mac OS X.
Adres URL miniatury obrazu na potrzeby powiadomień tego typu. Adresy URL mają takie same ograniczenia jak iconUrl.
-
isClickable
wartość logiczna opcjonalna
Wycofane od Chrome 67W wersji Chrome 67 ta wskazówka jest ignorowana
-
items
NotificationItem[] opcjonalnie
Elementy dla powiadomień dotyczących wielu produktów. Użytkownicy systemu Mac OS X widzą tylko pierwszy element.
-
wiadomość
ciąg znaków opcjonalny
Główna treść powiadomienia.
**Uwaga:**ta wartość jest wymagana w przypadku metody
notifications.create
()
. -
kampanii
Liczba opcjonalnie
Priorytety mają wartość z zakresu od –2 do 2. -2 oznacza najniższy priorytet. 2 to najwyższa wartość. Wartość domyślna to zero. Na platformach, które nie obsługują centrum powiadomień (Windows, Linux i Mac), klawisze -2 i -1 powodują wyświetlenie błędu, ponieważ powiadomienia z takimi priorytetami w ogóle nie są wyświetlane.
-
postęp
Liczba opcjonalnie
Aktualny postęp mieści się w zakresie od 0 do 100.
-
requireInteraction
wartość logiczna opcjonalna
Chrome 50 i nowsze wersjeWskazuje, że powiadomienie powinno pozostać widoczne na ekranie, dopóki użytkownik go nie aktywuje lub nie odrzuci. Wartość domyślna to fałsz.
-
cichy
wartość logiczna opcjonalna
Chrome 70 i nowsze wersjeOznacza, że powiadomienie nie może być sygnalizowane dźwiękiem ani wibracjami. Wartość domyślna to fałsz.
-
title
ciąg znaków opcjonalny
Tytuł powiadomienia (np. nazwa nadawcy e-maila).
**Uwaga:**ta wartość jest wymagana w przypadku metody
notifications.create
()
. -
Niestandardowy typ treści
TemplateType opcjonalnie
Typ powiadomienia, które ma być wyświetlane. Wymagany w przypadku metody
notifications.create
.
PermissionLevel
Typ wyliczeniowy
"granted"
Określa, że użytkownik włączył wyświetlanie powiadomień z aplikacji lub rozszerzenia. Jest to wartość domyślna podczas instalacji.
"denied"
Określa, że użytkownik zrezygnował z wyświetlania powiadomień z aplikacji lub rozszerzenia.
TemplateType
Typ wyliczeniowy
„Podstawowa”
Zawiera ikonę, tytuł, komunikat, rozwiniętą wiadomość i maksymalnie 2 przyciski.
"image"
Zawiera ikonę, tytuł, wiadomość, rozszerzoną wiadomość, obraz i maksymalnie 2 przyciski.
"list"
Zawiera ikonę, tytuł, wiadomość, elementy i maksymalnie 2 przyciski. Użytkownicy systemu Mac OS X widzą tylko pierwszy element.
"progress"
Zawiera ikonę, tytuł, komunikat, postęp i maksymalnie 2 przyciski.
Metody
clear()
chrome.notifications.clear(
notificationId: string,
callback?: function,
)
Usuwa określone powiadomienie.
Parametry
-
notificationId
string,
Identyfikator powiadomienia do wyczyszczenia. Ta wartość jest zwracana przez metodę
notifications.create
. -
wywołanie zwrotne
funkcja opcjonalnie
Parametr
callback
wygląda tak:(wasCleared: boolean) => void
-
wasCleared
boolean
-
Zwroty
-
Promise<boolean>
Chrome 116 i nowsze wersjeObietnice są obsługiwane tylko w przypadku platformy Manifest V3 i nowszych platform. Inne platformy muszą używać wywołań zwrotnych.
create()
chrome.notifications.create(
notificationId?: string,
options: NotificationOptions,
callback?: function,
)
Tworzy i wyświetla powiadomienie.
Parametry
-
notificationId
ciąg znaków opcjonalny
Identyfikator powiadomienia. Jeśli identyfikator jest nieskonfigurowany lub pusty, identyfikator zostanie wygenerowany automatycznie. Jeśli pasuje do istniejącego powiadomienia, ta metoda najpierw usuwa to powiadomienie przed kontynuacją operacji tworzenia. Identyfikator nie może mieć więcej niż 500 znaków.
Parametr
notificationId
jest wymagany w wersjach Chrome wcześniejszych niż 42. -
Opcje
Treść powiadomienia.
-
wywołanie zwrotne
funkcja opcjonalnie
Parametr
callback
wygląda tak:(notificationId: string) => void
-
notificationId
string,
-
Zwroty
-
Obietnica<string>
Chrome 116 i nowsze wersjeObietnice są obsługiwane tylko w przypadku platformy Manifest V3 i nowszych platform. Inne platformy muszą używać wywołań zwrotnych.
getAll()
chrome.notifications.getAll(
callback?: function,
)
Pobiera wszystkie powiadomienia z tej aplikacji lub tego rozszerzenia.
Parametry
-
wywołanie zwrotne
funkcja opcjonalnie
Parametr
callback
wygląda tak:(notifications: object) => void
-
powiadomienia
obiekt
-
Zwroty
-
Promise<object>
Chrome 116 i nowsze wersjeObietnice są obsługiwane tylko w przypadku platformy Manifest V3 i nowszych platform. Inne platformy muszą używać wywołań zwrotnych.
getPermissionLevel()
chrome.notifications.getPermissionLevel(
callback?: function,
)
Pobiera informacje o tym, czy użytkownik włączył powiadomienia z tej aplikacji lub tego rozszerzenia.
Parametry
-
wywołanie zwrotne
funkcja opcjonalnie
Parametr
callback
wygląda tak:(level: PermissionLevel) => void
-
poziom
-
Zwroty
-
Promise<PermissionLevel>
Chrome 116 i nowsze wersjeObietnice są obsługiwane tylko w przypadku platformy Manifest V3 i nowszych platform. Inne platformy muszą używać wywołań zwrotnych.
update()
chrome.notifications.update(
notificationId: string,
options: NotificationOptions,
callback?: function,
)
Aktualizuje istniejące powiadomienie.
Parametry
-
notificationId
string,
Identyfikator powiadomienia do zaktualizowania. Ta wartość jest zwracana przez metodę
notifications.create
. -
Opcje
Treść powiadomienia, którego ma dotyczyć aktualizacja.
-
wywołanie zwrotne
funkcja opcjonalnie
Parametr
callback
wygląda tak:(wasUpdated: boolean) => void
-
wasUpdated
boolean
-
Zwroty
-
Promise<boolean>
Chrome 116 i nowsze wersjeObietnice są obsługiwane tylko w przypadku platformy Manifest V3 i nowszych platform. Inne platformy muszą używać wywołań zwrotnych.
Wydarzenia
onButtonClicked
chrome.notifications.onButtonClicked.addListener(
callback: function,
)
Użytkownik nacisnął przycisk w powiadomieniu.
Parametry
-
wywołanie zwrotne
funkcja
Parametr
callback
wygląda tak:(notificationId: string, buttonIndex: number) => void
-
notificationId
string,
-
buttonIndex
Liczba
-
onClicked
chrome.notifications.onClicked.addListener(
callback: function,
)
Użytkownik kliknął obszar powiadomienia niebędący przyciskiem.
Parametry
-
wywołanie zwrotne
funkcja
Parametr
callback
wygląda tak:(notificationId: string) => void
-
notificationId
string,
-
onClosed
chrome.notifications.onClosed.addListener(
callback: function,
)
Powiadomienie zostało zamknięte przez system lub działanie użytkownika.
Parametry
-
wywołanie zwrotne
funkcja
Parametr
callback
wygląda tak:(notificationId: string, byUser: boolean) => void
-
notificationId
string,
-
byUser
boolean
-
onPermissionLevelChanged
chrome.notifications.onPermissionLevelChanged.addListener(
callback: function,
)
Użytkownik zmienia poziom uprawnień. Od wersji Chrome 47 tylko ChromeOS ma interfejs użytkownika, który wysyła to zdarzenie.
Parametry
-
wywołanie zwrotne
funkcja
Parametr
callback
wygląda tak:(level: PermissionLevel) => void
-
poziom
-
onShowSettings
chrome.notifications.onShowSettings.addListener(
callback: function,
)
Przycisk niestandardowych ustawień powiadomień nie jest już obsługiwany.
Użytkownik kliknął link do ustawień powiadomień w aplikacji. Od wersji Chrome 47 tylko ChromeOS ma interfejs użytkownika, który wysyła to zdarzenie. W Chrome 65 ten interfejs został usunięty również z ChromeOS.
Parametry
-
wywołanie zwrotne
funkcja
Parametr
callback
wygląda tak:() => void