@firebase/messaging

Funkcje

Funkcja Opis
function(aplikacja, ...)
getMessaging(aplikacja) Pobiera instancję Komunikacji w chmurze Firebase (FCM).
function(komunikat, ...)
deleteToken(komunikat) Usuwa token rejestracji powiązany z tym wystąpieniem Messaging i anuluje subskrypcję instancji Messaging od subskrypcji push.
getToken(wiadomości, opcje) Subskrybuje instancję Messaging, aby otrzymywać powiadomienia push. Zwraca token rejestracji Komunikacji w chmurze Firebase, którego można używać do wysyłania wiadomości push do instancji Messaging.Jeśli uprawnienia do wyświetlania powiadomień nie zostały jeszcze przyznane, ta metoda pyta użytkownika o zgodę. Zwrócona obietnica jest odrzucana, jeśli użytkownik nie zezwala aplikacji na wyświetlanie powiadomień.
onMessage(komunikat, nextOrObserver) Gdy użytkownik otrzyma komunikat push, a użytkownik jest obecnie na stronie z Twojego źródła, wiadomość zostanie do niej przekazana, a z ładunkiem tego komunikatu wysyłane będzie zdarzenie onMessage().
function()
isSupported() Sprawdza, czy w przeglądarce istnieją wszystkie wymagane interfejsy API.

Interfejsy

Interfejs Opis
FcmOptions Opcje funkcji zapewnianych przez pakiet SDK FCM na potrzeby witryn. Zobacz WebpushFcmOptions.
GetTokenOptions Opcje getToken().
MessagePayload Ładunek wiadomości zawierający ładunek powiadomień reprezentowany za pomocą funkcji notificationPayload oraz ładunek danych, który zawiera dowolną liczbę par klucz-wartość wysłanych przez deweloperów za pomocą interfejsu Send API.
Wiadomości Publiczny interfejs pakietu SDK Firebase Cloud Messaging.
Powiadomienia ładunku danych Wyświetl szczegóły powiadomień. Szczegóły są przesyłane przez Send API.

funkcja(aplikacja, ...)

getMessaging(aplikacja)

Pobiera instancję Komunikacji w chmurze Firebase (FCM).

Podpis:

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

Parametry

Parametr Typ Opis
aplikacja Aplikacja Firebase

Zwroty:

Wiadomości

Instancja Komunikacji w chmurze Firebase (FCM) powiązana z podaną aplikacją Firebase.

funkcja(komunikat, ...)

deleteToken(wiadomości)

Usuwa token rejestracji powiązany z tym wystąpieniem Messaging i anuluje subskrypcję instancji Messaging od subskrypcji push.

Podpis:

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

Parametry

Parametr Typ Opis
wiadomości Wiadomości instancja Messaging (Wiadomości).

Zwroty:

Promise&lt;boolean&gt;

Obietnica wygaśnie, gdy token zostanie usunięty.

getToken(wiadomości, opcje)

Subskrybuje instancję Messaging, aby otrzymywać powiadomienia push. Zwraca token rejestracji Komunikacji w chmurze Firebase, którego można używać do wysyłania komunikatów push do instancji Messaging.

Jeśli uprawnienia do wyświetlania powiadomień nie zostały jeszcze przyznane, ta metoda poprosi użytkownika o zgodę. Zwrócona obietnica jest odrzucana, jeśli użytkownik nie zezwala 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 (Wiadomości).
opcje GetTokenOptions Udostępnia opcjonalny klucz vapid i opcjonalną rejestrację skryptu service worker.

Zwroty:

Obietnica<ciąg>

Obiecywanie jest realizowane przy użyciu tokena rejestracji FCM.

onMessage(komunikat, nextOrObserver)

Gdy użytkownik otrzyma komunikat push, a użytkownik jest obecnie na stronie z Twojego źródła, wiadomość zostanie do niej przekazana, a z ładunkiem tego komunikatu wysyłane będzie zdarzenie onMessage().

Podpis:

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

Parametry

Parametr Typ Opis
wiadomości Wiadomości instancja Messaging (Wiadomości).
nextOrObserver NextFn<MessagePayload> | Obserwator<MessagePayload> Ta funkcja (czyli obiekt obserwatora ze zdefiniowaną wartością next) jest wywoływana po otrzymaniu wiadomości, gdy użytkownik aktualnie przegląda Twoją stronę.

Zwroty:

Anuluj subskrypcję

Aby zatrzymać nasłuchiwanie wiadomości, uruchom tę zwrócona funkcję.

funkcja()

issupported()

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

Podpis:

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

Zwroty:

Promise&lt;boolean&gt;

obietnica prowadząca do wartości logicznej.