@firebase/messaging/sw

Funkcje

Funkcja	Opis
function(aplikacja, ...)
getMessaging(aplikacja)	Pobiera instancję Komunikacji w chmurze Firebase (FCM).
function(komunikat, ...)
experimentalSetDeliveryMetricsExportedToBigQueryEnabled(komunikat, włącz)	Włącza lub wyłącza eksportowanie wskaźników dotyczących dostarczania wiadomości Komunikacja w chmurze Firebase (FCM) do BigQuery. Domyślnie wskaźniki dotyczące dostarczania wiadomości nie są eksportowane do BigQuery. Użyj tej metody, aby włączyć lub wyłączyć eksportowanie w czasie działania aplikacji.
onBackgroundMessage(komunikat, nextOrObserver)	Wywoływane w przypadku odebrania wiadomości, gdy aplikacja działa w tle. Aplikacja jest uznawana za działającą w tle, jeśli nie wyświetla się żadne aktywne okno.
function()
isSupported()	Sprawdza, czy w kontekście oprogramowania 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 getMessagingInSw(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, ...)

ExperimentSetDeliveryMetricsExportedToBigQueryEnabled(komunikat, włącz)

Włącza lub wyłącza eksportowanie wskaźników dotyczących dostarczania wiadomości Komunikacja w chmurze Firebase (FCM) do BigQuery. Domyślnie wskaźniki dotyczące dostarczania wiadomości nie są eksportowane do BigQuery. Użyj tej metody, aby włączyć lub wyłączyć eksportowanie w czasie działania aplikacji.

Podpis:

export declare function experimentalSetDeliveryMetricsExportedToBigQueryEnabled(messaging: Messaging, enable: boolean): void;

Parametry

Parametr	Typ	Opis
wiadomości	Wiadomości	Instancja FirebaseMessaging.
włącz	wartość logiczna	Określa, czy Firebase Cloud Messaging ma eksportować wskaźniki dostarczania wiadomości do BigQuery.

Zwroty:

nieważne

onBackgroundMessage(komunikat, nextOrObserver)

Wywoływane w przypadku odebrania wiadomości, gdy aplikacja działa w tle. Aplikacja jest uznawana za działającą w tle, jeśli nie wyświetla się żadne aktywne okno.

Podpis:

export declare function onBackgroundMessage(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 (inaczej obiekt obserwatora ze zdefiniowanym identyfikatorem next) jest wywoływana po otrzymaniu wiadomości, a aplikacja działa obecnie w tle.

Zwroty:

Anuluj subskrypcję

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

funkcja()

issupported()

Sprawdza, czy w kontekście oprogramowania istnieją wszystkie wymagane interfejsy API

Podpis:

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

Zwroty:

Promise<boolean>

obietnica prowadząca do wartości logicznej.