chrome.gcm

Opis

Użyj usługi chrome.gcm, by umożliwić aplikacjom i rozszerzeniom wysyłanie i odbieranie wiadomości przez Komunikację w chmurze Firebase (FCM).

Uprawnienia

gcm

Właściwości

MAX_MESSAGE_SIZE

Maksymalny rozmiar (w bajtach) wszystkich par klucz-wartość w wiadomości.

Wartość

4096

Metody

register()

Obietnica .
chrome.gcm.register(
  senderIds: string[],
  callback?: function,
)

Rejestruje aplikację w FCM. Identyfikator rejestracji zostanie zwrócony przez callback. Jeśli funkcja register zostanie wywołana ponownie z tą samą listą wartości senderIds, zwrócony zostanie ten sam identyfikator rejestracji.

Parametry

  • senderIds

    ciąg znaków[]

    Lista identyfikatorów serwerów, które mogą wysyłać komunikaty do aplikacji. Powinien zawierać od 1 do 100 identyfikatorów nadawcy.

  • wywołanie zwrotne

    funkcja optional

    Parametr callback wygląda tak: 

    (registrationId: string) => void

    • registrationId

      ciąg znaków

      Identyfikator rejestracji przypisany do aplikacji przez FCM.

Zwroty

  • Obietnica<ciąg>

    Chrome 116 lub nowszy .

    Obietnice są obsługiwane w Manifest V3 i nowszych, ale wywołania zwrotne są podane w przypadku zgodność wsteczną. Nie można użyć obu w tym samym wywołaniu funkcji. Polecenie promowane jest realizowane z tym samym typem, który jest przekazywany do wywołania zwrotnego.

send()

Obietnica .
chrome.gcm.send(
  message: object,
  callback?: function,
)

Wysyła wiadomość zgodnie z jej treścią.

Parametry

  • wiadomość

    Obiekt

    Wiadomość do wysłania drugiej stronie przez FCM.

    • dane

      Obiekt

      Dane wiadomości do wysłania na serwer. Prefiksy goog. i google bez rozróżniania wielkości liter, a także collapse_key (z uwzględnieniem wielkości liter) nie są dozwolone jako prefiksy klucza. Suma wszystkich par klucz-wartość nie powinna przekraczać gcm.MAX_MESSAGE_SIZE.

    • destinationId

      ciąg znaków

      Identyfikator serwera, do którego wysyłana jest wiadomość, przypisany przez Konsolę interfejsów API Google.

    • messageId

      ciąg znaków

      Identyfikator wiadomości. Musi być unikalny dla każdego komunikatu w zakresie aplikacji. Zapoznaj się z dokumentacją Komunikacji w chmurze, aby dowiedzieć się, jak wybrać identyfikator i obsługiwać go.

    • timeToLive

      liczba opcjonalnie

      Czas życia wiadomości w sekundach. Jeśli nie można jej wysłać w tym czasie, wywoływane jest zdarzenie onSendError. Czas życia danych równy 0 oznacza, że wiadomość powinna zostać wysłana natychmiast lub niepowodzeniem, jeśli nie jest to możliwe. Domyślna wartość czasu życia danych to 86 400 sekund (1 dzień), a maksymalna – 2 419 200 sekund (28 dni).

  • wywołanie zwrotne

    funkcja optional

    Parametr callback wygląda tak: 

    (messageId: string) => void

    • messageId

      ciąg znaków

      Identyfikator wiadomości, dla której nawiązano wywołanie zwrotne.

Zwroty

  • Obietnica<ciąg>

    Chrome 116 lub nowszy .

    Obietnice są obsługiwane w Manifest V3 i nowszych, ale wywołania zwrotne są podane w przypadku zgodność wsteczną. Nie można użyć obu w tym samym wywołaniu funkcji. Polecenie promowane jest realizowane z tym samym typem, który jest przekazywany do wywołania zwrotnego.

unregister()

Obietnica .
chrome.gcm.unregister(
  callback?: function,
)

Wyrejestrowuje aplikację z FCM.

Parametry

  • wywołanie zwrotne

    funkcja optional

    Parametr callback wygląda tak: 

    () => void

Zwroty

  • Obietnica<void>

    Chrome 116 lub nowszy .

    Obietnice są obsługiwane w Manifest V3 i nowszych, ale wywołania zwrotne są podane w przypadku zgodność wsteczną. Nie można użyć obu w tym samym wywołaniu funkcji. Polecenie promowane jest realizowane z tym samym typem, który jest przekazywany do wywołania zwrotnego.

Wydarzenia

onMessage

chrome.gcm.onMessage.addListener(
  callback: function,
)

Uruchamiane po otrzymaniu wiadomości przez FCM.

Parametry

  • wywołanie zwrotne

    funkcja

    Parametr callback wygląda tak: 

    (message: object) => void

    • wiadomość

      Obiekt

      • collapseKey

        ciąg znaków opcjonalny

        Klucz zwijania wiadomości. Więcej informacji znajdziesz w artykule Wiadomości bez możliwości zwijania i zwijania.

      • dane

        Obiekt

        Dane wiadomości.

      • od

        ciąg znaków opcjonalny

        Nadawca, który wysłał wiadomość.

onMessagesDeleted

chrome.gcm.onMessagesDeleted.addListener(
  callback: function,
)

Uruchamiane, gdy serwer FCM musiał usunąć wiadomości wysłane do aplikacji przez serwer aplikacji. Szczegółowe informacje o obsłudze tego zdarzenia znajdziesz w sekcji Czas trwania wiadomości.

Parametry

  • wywołanie zwrotne

    funkcja

    Parametr callback wygląda tak: 

    () => void

onSendError

chrome.gcm.onSendError.addListener(
  callback: function,
)

Uruchamiane, gdy nie można było wysłać wiadomości do serwera FCM.

Parametry

  • wywołanie zwrotne

    funkcja

    Parametr callback wygląda tak: 

    (error: object) => void

    • błąd

      Obiekt

      • szczegóły

        Obiekt

        Dodatkowe informacje na temat błędu, jeśli są dostępne.

      • errorMessage

        ciąg znaków

        Komunikat o błędzie opisujący problem.

      • messageId

        ciąg znaków opcjonalny

        Identyfikator komunikatu z tym błędem, jeśli błąd jest związany z konkretnym komunikatem.