Opis
Użyj chrome.gcm
, aby 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()
chrome.gcm.register(
senderIds: string[],
callback?: function,
)
Rejestruje aplikację w FCM. Identyfikator rejestracji będzie zwracany przez funkcję 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
string[]
Lista identyfikatorów serwerów, które mogą wysyłać wiadomości do aplikacji. Powinien zawierać od 1 do 100.
-
wywołanie zwrotne
funkcja opcjonalnie
Parametr
callback
wygląda tak:(registrationId: string) => void
-
registrationId
string,
Identyfikator rejestracji przypisany do aplikacji przez FCM.
-
Akcje powrotne
-
Obietnica<string>
Chrome 116 i nowsze wersjeObietnice są obsługiwane w platformie Manifest V3 i nowszych, ale wywołania zwrotne są dostępne na potrzeby zgodności wstecznej. Nie można użyć obu w tym samym wywołaniu funkcji. Obietnica znika z tym samym typem, który jest przekazywany do wywołania zwrotnego.
send()
chrome.gcm.send(
message: object,
callback?: function,
)
Wysyła wiadomość zgodnie z jej zawartością.
Parametry
-
wiadomość
obiekt
Wiadomość, która ma zostać wysłana do drugiej osoby przez FCM.
-
dane
obiekt
Dane wiadomości, które mają zostać wysłane na serwer. Prefiksy kluczy
goog.
igoogle
bez rozróżniania wielkości liter orazcollapse_key
z rozróżnianiem wielkości liter są niedozwolone. Suma wszystkich par klucz-wartość nie powinna przekraczaćgcm.MAX_MESSAGE_SIZE
. -
destinationId
string,
Identyfikator serwera, na który wysłać wiadomość, przypisany przez Konsolę interfejsów API Google.
-
messageId
string,
Identyfikator wiadomości. Każda wiadomość w zakresie aplikacji musi być niepowtarzalna. Wskazówki na temat wybierania i przetwarzania identyfikatora znajdziesz w dokumentacji Komunikacji w chmurze.
-
timeToLive
Liczba opcjonalnie
Czas życia wiadomości (w sekundach). Jeśli nie można wysłać wiadomości w tym czasie, zostaje zgłoszone zdarzenie onSendError. Wartość 0 oznacza, że wiadomość powinna zostać wysłana natychmiast. Jeśli jest to niemożliwe, oznacza to, że nie ma ona miejsca. Domyślna wartość czasu życia wynosi 86 400 sekund (1 dzień), a maksymalna – 2 419 200 sekund (28 dni).
-
-
wywołanie zwrotne
funkcja opcjonalnie
Parametr
callback
wygląda tak:(messageId: string) => void
-
messageId
string,
Identyfikator wiadomości, dla której wykonano wywołanie zwrotne.
-
Akcje powrotne
-
Obietnica<string>
Chrome 116 i nowsze wersjeObietnice są obsługiwane w platformie Manifest V3 i nowszych, ale wywołania zwrotne są dostępne na potrzeby zgodności wstecznej. Nie można użyć obu w tym samym wywołaniu funkcji. Obietnica znika z tym samym typem, który jest przekazywany do wywołania zwrotnego.
unregister()
chrome.gcm.unregister(
callback?: function,
)
Wyrejestrowuje aplikację z FCM.
Parametry
-
wywołanie zwrotne
funkcja opcjonalnie
Parametr
callback
wygląda tak:() => void
Akcje powrotne
-
Promise<void>
Chrome 116 i nowsze wersjeObietnice są obsługiwane w platformie Manifest V3 i nowszych, ale wywołania zwrotne są dostępne na potrzeby zgodności wstecznej. Nie można użyć obu w tym samym wywołaniu funkcji. Obietnica znika 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 sekcji Wiadomości niezwijane i zwijane.
-
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
-
error
obiekt
-
szczegóły
obiekt
dodatkowe informacje o błędzie, jeśli są dostępne.
-
errorMessage
string,
Komunikat o błędzie z opisem problemu.
-
messageId
ciąg znaków opcjonalny
Identyfikator komunikatu z tym błędem, jeśli jest on związany z konkretną wiadomością.
-
-