chrome.gcm

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 funkcja register zostanie ponownie wywołana z tą samą listą senderIds, zostanie zwrócony 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 nadawcy.

  • callback

    funkcja opcjonalna

    Parametr callback wygląda tak:

    (registrationId: string) => void

    • registrationId

      ciąg znaków

      Identyfikator rejestracji przypisany do aplikacji przez FCM.

Zwroty

  • Promise<string>

    Chrome 116 lub nowsza

    Obietnice są obsługiwane tylko w przypadku platformy Manifest V3 i nowszych. Inne platformy muszą 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 za pomocą FCM.

    • dane

      obiekt

      Dane wiadomości do wysłania na serwer. Jako prefiksów kluczy nie można używać atrybutów goog. i google, w których wielkość liter nie jest rozróżniana, ani atrybutu collapse_key, w którym wielkość liter jest rozróżniana. Suma wszystkich par klucz/wartość nie powinna przekraczać gcm.MAX_MESSAGE_SIZE.

    • destinationId

      ciąg znaków

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

    • messageId

      ciąg znaków

      Identyfikator wiadomości. Musi być unikalny dla każdej wiadomości w zakresie aplikacji. Więcej informacji o wybieraniu i obsłudze identyfikatora znajdziesz w dokumentacji Cloud Messaging.

    • timeToLive

      number opcjonalny

      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 wskazuje, że wiadomość powinna zostać wysłana natychmiast lub nie powinna zostać wysłana w przypadku braku takiej możliwości. Domyślna wartość czasu życia to 86 400 sekund (1 dzień), a maksymalna to 2 419 200 sekund (28 dni).

  • callback

    funkcja opcjonalna

    Parametr callback wygląda tak:

    (messageId: string) => void

    • messageId

      ciąg znaków

      Identyfikator wiadomości, dla której wywołano wywołanie zwrotne.

Zwroty

  • Promise<string>

    Chrome 116 lub nowsza

    Obietnice są obsługiwane tylko w przypadku platformy Manifest V3 i nowszych. Inne platformy muszą używać wywołań zwrotnych.

unregister()

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

Wyrejestrowuje aplikację z FCM.

Parametry

  • callback

    funkcja opcjonalna

    Parametr callback wygląda tak:

    () => void

Zwroty

  • Promise<void>

    Chrome 116 lub nowsza

    Obietnice są obsługiwane tylko w przypadku platformy Manifest V3 i nowszych. Inne platformy muszą używać wywołań zwrotnych.

Wydarzenia

onMessage

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

Wywoływane, gdy wiadomość zostanie odebrana przez FCM.

Parametry

onMessagesDeleted

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

Wywoływane, gdy serwer FCM musi usunąć wiadomości wysłane przez serwer aplikacji do aplikacji. Szczegółowe informacje o obsłudze tego zdarzenia znajdziesz w sekcji Okres istnienia wiadomości.

Parametry

  • callback

    funkcja

    Parametr callback wygląda tak:

    () => void

onSendError

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

Wywoływane, gdy nie można wysłać wiadomości na serwer FCM.

Parametry

  • callback

    funkcja

    Parametr callback wygląda tak:

    (error: object) => void

    • błąd

      obiekt

      • szczegóły

        obiekt

        Dodatkowe szczegóły dotyczące błędu, jeśli są dostępne.

      • errorMessage

        ciąg znaków

        Komunikat o błędzie z opisem problemu.

      • messageId

        string opcjonalny

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