chrome.gcm

refresh date: 2026-09-25 robots: noindex

Opis

Użyj chrome.gcm, aby umożliwić aplikacjom i rozszerzeniom wysyłanie i odbieranie wiadomości za pomocą Komunikacji 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,
): Promise<string>

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

Parametry

• senderIds

  string[]

  Lista identyfikatorów serwerów, które mogą wysyłać wiadomości do aplikacji. Powinien zawierać co najmniej 1 i nie więcej niż 100 identyfikatorów nadawców.

• callback

  function opcjonalne

  Parametr callback wygląda tak:

  (registrationId: string) => void

  • registrationId

    tekst

    Identyfikator rejestracji przypisany do aplikacji przez FCM.

Zwroty

• Promise<string>

  Chrome 116 lub nowsza wersja

  Rozwiązuje problem po zakończeniu rejestracji.

  Obiekty Promise są obsługiwane tylko w przypadku platformy Manifest V3 i nowszych. Na innych platformach należy używać wywołań zwrotnych.

send()

Obietnica

chrome.gcm.send(
  message: object,
  callback?: function,
): Promise<string>

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

Parametry

• wiadomość

  obiekt

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

  • dane

    obiekt

    Dane wiadomości do wysłania na serwer. Prefiksy kluczy nie mogą zawierać ciągów goog. i google (wielkość liter nie jest rozróżniana) ani ciągu collapse_key (wielkość liter ma znaczenie). Suma wszystkich par klucz-wartość nie powinna przekraczać gcm.MAX_MESSAGE_SIZE.

  • destinationId

    tekst

    Identyfikator serwera, na który ma zostać wysłana wiadomość, przypisany przez Konsolę interfejsów API Google.

  • messageId

    tekst

    Identyfikator wiadomości. Musi być unikalny dla każdej wiadomości w zakresie aplikacji. Wskazówki dotyczące wybierania identyfikatora i postępowania z nim znajdziesz w dokumentacji Komunikacji w chmurze.

  • timeToLive

    number optional

    Czas życia wiadomości w sekundach. Jeśli nie uda się wysłać wiadomości w tym czasie, zostanie wywołane zdarzenie onSendError. Wartość 0 oznacza, że wiadomość powinna zostać wysłana natychmiast, a jeśli nie jest to możliwe, powinno wystąpić niepowodzenie. Domyślna wartość czasu życia to 86 400 sekund (1 dzień), a maksymalna – 2 419 200 sekund (28 dni).

• callback

  function opcjonalne

  Parametr callback wygląda tak:

  (messageId: string) => void

  • messageId

    tekst

    Identyfikator wiadomości, dla której zostało wywołane wywołanie zwrotne.

Zwroty

• Promise<string>

  Chrome 116 lub nowsza wersja

  Rozwiązuje problem po pomyślnym dodaniu wiadomości do kolejki wysyłania. Jeśli wystąpi błąd, obietnica zostanie odrzucona.

  Obiekty Promise są obsługiwane tylko w przypadku platformy Manifest V3 i nowszych. Na innych platformach należy używać wywołań zwrotnych.

unregister()

Obietnica

chrome.gcm.unregister(
  callback?: function,
): Promise<void>

Wyrejestrowuje aplikację z FCM.

Parametry

• callback

  function opcjonalne

  Parametr callback wygląda tak:

  () => void

Zwroty

• thought Promise<void>

  Chrome 116 lub nowsza wersja

  Rozwiązuje problem po zakończeniu wyrejestrowywania. Jeśli obietnica nie zostanie odrzucona, wyrejestrowanie się powiodło.

  Obiekty Promise są obsługiwane tylko w przypadku platformy Manifest V3 i nowszych. Na innych platformach należy używać wywołań zwrotnych.

Wydarzenia

onMessage

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

Uruchamiane, gdy wiadomość zostanie odebrana przez FCM.

Parametry

• callback

  funkcja

  Parametr callback wygląda tak:

  (message: object) => void

  • wiadomość

    obiekt

    • collapseKey

      ciąg znaków opcjonalny

      Klucz zwijania wiadomości. Szczegółowe informacje znajdziesz w sekcji Wiadomości zwijane i niezwijane.

    • 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 przez serwer aplikacji do aplikacji. Szczegółowe informacje o obsłudze tego zdarzenia znajdziesz w sekcji Czas życia wiadomości.

Parametry

• callback

  funkcja

  Parametr callback wygląda tak:

  () => void

onSendError

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

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

Parametry

• callback

  funkcja

  Parametr callback wygląda tak:

  (error: object) => void

  • błąd

    obiekt

    • szczegóły

      obiekt

      Dodatkowe informacje o błędzie (jeśli są dostępne).

    • Komunikat o błędzie

      tekst

      Komunikat o błędzie opisujący problem.

    • messageId

      ciąg znaków opcjonalny

      Identyfikator wiadomości, której dotyczy błąd, jeśli błąd jest związany z konkretną wiadomością.