@firebase/messaging

Funkcje

Funkcjonować Opis
funkcja (aplikacja, ...)
getMessaging (aplikacja) Pobiera instancję Firebase Cloud Messaging.
funkcja (wiadomości, ...)
usuńToken (wiadomości) Usuwa token rejestracji powiązany z tą instancją Messaging i anuluje subskrypcję instancji Messaging z subskrypcji push.
getToken(wiadomości, opcje) Subskrybuje instancję Messaging do powiadomień push. Zwraca token rejestracji Firebase Cloud Messaging, którego można używać do wysyłania wiadomości push do tej instancji Messaging . Jeśli pozwolenie na powiadomienie nie zostało jeszcze przyznane, ta metoda poprosi użytkownika o pozwolenie. Zwrócona obietnica zostanie odrzucona, jeśli użytkownik nie zezwoli aplikacji na wyświetlanie powiadomień.
onMessage(wiadomości, nextOrObserver) Po odebraniu wiadomości push, a użytkownik znajduje się obecnie na stronie Twojego źródła, wiadomość jest przekazywana na stronę i wywoływane jest zdarzenie onMessage() z ładunkiem wiadomości push.
funkcjonować()
jest wspierany() Sprawdza, czy w przeglądarce istnieją wszystkie wymagane interfejsy API.

Interfejsy

Interfejs Opis
Opcje Fcm Opcje funkcji udostępnianych przez pakiet FCM SDK dla Internetu. Zobacz Opcje WebpushFcm .
Opcje GetTokena Opcje getToken() .
Ładunek wiadomości Ładunek wiadomości zawierający ładunek powiadomienia reprezentowany przez NotificationPayload oraz ładunek danych zawierający dowolną liczbę par klucz-wartość wysyłanych przez programistów za pośrednictwem interfejsu API Send .
Wiadomości Publiczny interfejs pakietu SDK Firebase Cloud Messaging.
PowiadomienieŁadunek Wyświetl szczegóły powiadomienia. Szczegóły są przesyłane za pośrednictwem interfejsu API wysyłania .

funkcja (aplikacja, ...)

getMessaging (aplikacja)

Pobiera instancję Firebase Cloud Messaging.

Podpis:

export declare function getMessagingInWindow(app?: FirebaseApp): Messaging;

Parametry

Parametr Typ Opis
aplikacja Aplikacja Firebase

Zwroty:

Wiadomości

Instancja Firebase Cloud Messaging powiązana z dostarczoną aplikacją Firebase.

funkcja (wiadomości, ...)

usuńToken (wiadomości)

Usuwa token rejestracji powiązany z tą instancją Messaging i anuluje subskrypcję instancji Messaging z subskrypcji push.

Podpis:

export declare function deleteToken(messaging: Messaging): Promise<boolean>;

Parametry

Parametr Typ Opis
wiadomości Wiadomości Instancja Messaging .

Zwroty:

Obietnica<boolean>

Obietnica zostaje rozpatrzona, gdy token zostanie pomyślnie usunięty.

getToken(wiadomości, opcje)

Subskrybuje instancję Messaging do powiadomień push. Zwraca token rejestracji Firebase Cloud Messaging, którego można używać do wysyłania wiadomości push do tej instancji Messaging .

Jeśli pozwolenie na powiadomienie nie zostało jeszcze przyznane, ta metoda poprosi użytkownika o pozwolenie. Zwrócona obietnica zostanie odrzucona, jeśli użytkownik nie zezwoli aplikacji na wyświetlanie powiadomień.

Podpis:

export declare function getToken(messaging: Messaging, options?: GetTokenOptions): Promise<string>;

Parametry

Parametr Typ Opis
wiadomości Wiadomości Instancja Messaging .
opcje Opcje GetTokena Zapewnia opcjonalny klucz pusty i opcjonalną rejestrację pracownika serwisu.

Zwroty:

Obietnica<string>

Obietnica rozwiązuje się za pomocą tokena rejestracyjnego FCM.

onMessage(wiadomości, nextOrObserver)

Po odebraniu wiadomości push, a użytkownik znajduje się obecnie na stronie Twojego źródła, wiadomość jest przekazywana na stronę i wywoływane jest zdarzenie onMessage() z ładunkiem wiadomości push.

Podpis:

export declare function onMessage(messaging: Messaging, nextOrObserver: NextFn<MessagePayload> | Observer<MessagePayload>): Unsubscribe;

Parametry

Parametr Typ Opis
wiadomości Wiadomości Instancja Messaging .
nextOrObserver NastępnyFn < Ładunek wiadomości > | Obserwator < Ładunek wiadomości > Ta funkcja, czyli obiekt obserwatora ze zdefiniowanym next , wywoływany jest po otrzymaniu wiadomości, a użytkownik aktualnie przegląda Twoją stronę.

Zwroty:

Zrezygnuj z subskrypcji

Aby przestać nasłuchiwać wiadomości, wykonaj tę zwróconą funkcję.

funkcjonować()

jest wspierany()

Sprawdza, czy w przeglądarce istnieją wszystkie wymagane interfejsy API.

Podpis:

export declare function isWindowSupported(): Promise<boolean>;

Zwroty:

Obietnica<boolean>

Obietnica, której wynikiem jest wartość logiczna.