chrome.notifications

Opis

Interfejs API chrome.notifications umożliwia tworzenie rozszerzonych powiadomień na podstawie szablonów i wyświetlanie ich użytkownikom w obszarze powiadomień.

Uprawnienia

notifications

Typy

NotificationBitmap

NotificationButton

Właściwości

  • iconUrl

    ciąg znaków opcjonalny

    Wycofane od Chrome 59

    Ikony przycisków nie są widoczne dla użytkowników systemu Mac OS X.

  • tytuł

    ciąg znaków

NotificationItem

Właściwości

  • wiadomość

    ciąg znaków

    Dodatkowe informacje o tym produkcie.

  • tytuł

    ciąg znaków

    Tytuł jednego elementu powiadomienia o liście.

NotificationOptions

Właściwości

  • appIconMaskUrl

    ciąg znaków opcjonalny

    Wycofane od Chrome 59

    Maska ikony aplikacji nie jest widoczna dla użytkowników Mac OS X.

    Adres URL maski ikony aplikacji. Adresy URL mają te same ograniczenia co iconUrl.

    Maska ikony aplikacji powinna być w kanale alfa, ponieważ brany jest pod uwagę tylko kanał alfa obrazu.

  • Przyciski

    NotificationButton[] opcjonalny

    Tekst i ikony maksymalnie dwóch przycisków działań związanych z powiadomieniami.

  • contextMessage

    ciąg znaków opcjonalny

    Naprzemienne treści powiadomień zawierające mniejszą czcionkę.

  • eventTime

    liczba opcjonalnie

    Sygnatura czasowa związana z powiadomieniem wyrażona w milisekundach po epoki (np. Date.now() + n).

  • iconUrl

    ciąg znaków opcjonalny

    Adres URL awatara nadawcy, ikony aplikacji lub miniatury do powiadomień o obrazach.

    Adresy URL mogą być adresem URL danych, adresem URL obiektu blob lub adresem URL odnoszącym się 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 59

    Obraz nie jest widoczny dla użytkowników systemu Mac OS X.

    Adres URL miniatury obrazu na potrzeby powiadomień dotyczących obrazów. Adresy URL mają te same ograniczenia co iconUrl.

  • isClickable

    Wartość logiczna opcjonalna

    Wycofane od Chrome 67

    Ta wskazówka dotycząca interfejsu jest ignorowana od Chrome 67

  • items

    NotificationItem[] opcjonalny

    Elementy powiadomień dotyczących wielu produktów. W systemie Mac OS X użytkownicy 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

    Priorytet ma zakres od -2 do 2. –2 to najniższy priorytet. 2 to najwyższa wartość. Wartość domyślna to 0. Na platformach, które nie obsługują centrum powiadomień (Windows, Linux i Mac), wartości -2 i -1 powodują błąd, ponieważ powiadomienia z tymi priorytetami w ogóle nie będą wyświetlane.

  • postęp

    liczba opcjonalnie

    Aktualny postęp wynosi od 0 do 100.

  • requireInteraction

    Wartość logiczna opcjonalna

    Chrome w wersji 50 lub nowszej .

    Wskazuje, że powiadomienie powinno pozostać widoczne na ekranie, dopóki użytkownik go nie aktywuje lub nie zamknie. Wartość domyślna to fałsz.

  • cichy

    Wartość logiczna opcjonalna

    Chrome w wersji 70 lub nowszej .

    Oznacza, że podczas wyświetlania powiadomienia nie powinny być generowane żadne dźwięki ani wibracje. Wartość domyślna to fałsz.

  • tytuł

    ciąg znaków opcjonalny

    Tytuł powiadomienia (np. nazwa nadawcy e-maila).

    **Uwaga:**ta wartość jest wymagana w przypadku metody notifications.create().

  • typ

    Opcjonalny TemplateType

    Typ powiadomienia, który ma się wyświetlać. Wymagany w przypadku metody notifications.create.

PermissionLevel

Typ wyliczeniowy

"granted"
Określa, czy użytkownik zdecydował się na wyświetlanie powiadomień z aplikacji lub rozszerzenia. Jest to wartość domyślna podczas instalacji.

"denied"
Określa, że użytkownik wyłączył powiadomienia z aplikacji lub rozszerzenia.

TemplateType

Typ wyliczeniowy

"basic"
Zawiera ikonę, tytuł, wiadomość,expandMessage i maksymalnie 2 przyciski.

"image"
Zawiera ikonę, tytuł, wiadomość,expandMessage, obraz i maksymalnie 2 przyciski.

"list"
Zawiera ikonę, tytuł, wiadomość, elementy i maksymalnie dwa przyciski. W systemach Mac OS X użytkownicy widzą tylko pierwszy element.

"progress"
Zawiera ikonę, tytuł, wiadomość, postęp i maksymalnie 2 przyciski.

Metody

clear()

Obietnica .
chrome.notifications.clear(
  notificationId: string,
  callback?: function,
)

Usuwa określone powiadomienie.

Parametry

  • notificationId

    ciąg znaków

    Identyfikator powiadomienia, które ma zostać wyczyszczone. Jest on zwracany przez metodę notifications.create.

  • wywołanie zwrotne

    funkcja optional

    Parametr callback wygląda tak: 

    (wasCleared: boolean) => void

    • wasCleared

      wartość logiczna

Zwroty

  • Promise<boolean>

    Chrome 116 lub nowszy .

    Obietnice są obsługiwane tylko na platformie Manifest V3 i nowszych, inne platformy muszą używać wywołań zwrotnych.

create()

Obietnica .
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 zasada jest nieskonfigurowana lub pusta, identyfikator jest generowany automatycznie. Jeśli odpowiada ono istniejącemu powiadomieniu, ta metoda najpierw usuwa to powiadomienie przed kontynuacją operacji tworzenia. Identyfikator może mieć maksymalnie 500 znaków.

    Parametr notificationId jest wymagany przed wersją Chrome 42.

  • Treść powiadomienia.

  • wywołanie zwrotne

    funkcja optional

    Parametr callback wygląda tak: 

    (notificationId: string) => void

    • notificationId

      ciąg znaków

Zwroty

  • Obietnica<ciąg>

    Chrome 116 lub nowszy .

    Obietnice są obsługiwane tylko na platformie Manifest V3 i nowszych, inne platformy muszą używać wywołań zwrotnych.

getAll()

Obietnica .
chrome.notifications.getAll(
  callback?: function,
)

Pobiera wszystkie powiadomienia z tej aplikacji lub tego rozszerzenia.

Parametry

  • wywołanie zwrotne

    funkcja optional

    Parametr callback wygląda tak: 

    (notifications: object) => void

    • powiadomienia

      Obiekt

Zwroty

  • Promise&lt;object&gt;

    Chrome 116 lub nowszy .

    Obietnice są obsługiwane tylko na platformie Manifest V3 i nowszych, inne platformy muszą używać wywołań zwrotnych.

getPermissionLevel()

Obietnica .
chrome.notifications.getPermissionLevel(
  callback?: function,
)

Określa, czy użytkownik włączył powiadomienia z tej aplikacji lub tego rozszerzenia.

Parametry

Zwroty

  • Promise&lt;PermissionLevel&gt;

    Chrome 116 lub nowszy .

    Obietnice są obsługiwane tylko na platformie Manifest V3 i nowszych, inne platformy muszą używać wywołań zwrotnych.

update()

Obietnica .
chrome.notifications.update(
  notificationId: string,
  options: NotificationOptions,
  callback?: function,
)

Aktualizuje istniejące powiadomienie.

Parametry

  • notificationId

    ciąg znaków

    Identyfikator powiadomienia do zaktualizowania. Jest on zwracany przez metodę notifications.create.

  • Zawartość powiadomienia, które ma zostać zaktualizowane.

  • wywołanie zwrotne

    funkcja optional

    Parametr callback wygląda tak: 

    (wasUpdated: boolean) => void

    • wasUpdated

      wartość logiczna

Zwroty

  • Promise&lt;boolean&gt;

    Chrome 116 lub nowszy .

    Obietnice są obsługiwane tylko na platformie Manifest V3 i nowszych, 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

      ciąg znaków

    • buttonIndex

      liczba

onClicked

chrome.notifications.onClicked.addListener(
  callback: function,
)

Użytkownik kliknął obszar powiadomienia, który nie jest przyciskiem.

Parametry

  • wywołanie zwrotne

    funkcja

    Parametr callback wygląda tak: 

    (notificationId: string) => void

    • notificationId

      ciąg znaków

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

      ciąg znaków

    • byUser

      wartość logiczna

onPermissionLevelChanged

chrome.notifications.onPermissionLevelChanged.addListener(
  callback: function,
)

Użytkownik zmieni poziom uprawnień. Od Chrome 47 tylko ChromeOS ma interfejs, który wysyła to zdarzenie.

Parametry

onShowSettings

Wycofane od Chrome 65
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 Chrome 47 tylko ChromeOS ma interfejs, który wysyła to zdarzenie. W Chrome 65 ten interfejs został też usunięty z ChromeOS.

Parametry

  • wywołanie zwrotne

    funkcja

    Parametr callback wygląda tak: 

    () => void