firebase-admin.messaging package

Komunikacja w chmurze Firebase (FCM).

Funkcje

Funkcja	Opis
getMessaging(aplikacja),	Pobiera usługę Messaging (wiadomości) dla domyślnej aplikacji lub aplikacji.`admin.messaging()` można wywołać bez argumentów, by uzyskać dostęp do usługi `Messaging` domyślnej aplikacji, lub jako `admin.messaging(app)`, aby uzyskać dostęp do usługi `Messaging` powiązanej z konkretną aplikacją.

Zajęcia

Klasa	Opis
Wiadomości	Usługa przesyłania wiadomości powiązana z udostępnioną aplikacją.

Interfejsy

Interfejs	Opis
Konfiguracja Androida	Reprezentuje opcje specyficzne dla Androida, które mogą być uwzględnione w wiadomości.
AndroidFcmOptions	Reprezentuje opcje funkcji udostępnianych przez pakiet SDK FCM na Androida.
Powiadomienie na Androidzie	Reprezentuje opcje powiadomień specyficzne dla Androida, które mogą być uwzględnione w konfiguracji AndroidConfig.
ApnsConfig	Reprezentuje opcje specyficzne dla APNs, które mogą być uwzględnione w wiadomości. W dokumentacji Apple znajdziesz informacje o różnych nagłówkach i polach ładunku obsługiwanych przez punkty APN.
ApnsFcmOptions	Reprezentuje opcje funkcji udostępnianych przez pakiet SDK FCM na iOS.
ApnsPayload	Reprezentuje ładunek wiadomości APNs. Zawiera głównie słownik `aps`. Może też zawierać inne dowolne klucze niestandardowe.
AP	Reprezentuje słownik aps, który jest częścią wiadomości APNs.
Alerty Aps
Wiadomość podstawowa
BatchResponse (Odpowiedź wsadowa)	Interfejs reprezentujący odpowiedź serwera z metod Messaging.sendAll() i Messaging.sendMulticast().
Wiadomość dotycząca warunku
Dźwięk krytyczny	Reprezentuje krytyczną konfigurację dźwięku, którą można uwzględnić w słowniku `aps` ładunku APNs.
DataMessagePayload	Interfejs przedstawiający ładunek wiadomości ze starszym interfejsem API FCM. Komunikaty dotyczące danych umożliwiają programistom wysyłanie do 4 KB niestandardowych par klucz-wartość. Klucze i wartości muszą być ciągami tekstowymi. Klucze mogą być dowolnymi ciągami niestandardowymi, z wyjątkiem tych zastrzeżonych: `from` Wszystko, co zaczyna się od `google.` Przykład i szczegółową dokumentację znajdziesz w artykule Tworzenie żądań wysyłania.
Opcje Fcm	Reprezentuje opcje niezależne od platformy w przypadku funkcji dostępnych w pakietach SDK FCM.
Ustawienia oświetlenia	Reprezentuje ustawienia pozwalające sterować diodą LED powiadomień, którą można uwzględnić w elemencie Android Notification.
MessagingConditionResponse	Interfejs reprezentujący odpowiedź serwera ze starszej metody Messaging.sendToCondition().Przykładowy kod i szczegółową dokumentację znajdziesz w sekcji Wyślij do warunku.
MessagingDeviceGroupResponse	Interfejs reprezentujący odpowiedź serwera z metody Messaging.sendToDeviceGroup().Przykładowy kod i szczegółową dokumentację znajdziesz w artykule Wysyłanie wiadomości do grup urządzeń.
MessagingDeviceResult	Ładunek z poszczególnymi odpowiedziami na pytania o stan z jednego urządzenia
MessagingdevicesResponse	Interfejs przedstawiający stan wiadomości wysłanej na poszczególne urządzenia przez starsze wersje interfejsów API FCM.Przykładowy kod i szczegółową dokumentację znajdziesz w sekcji Wysyłanie na poszczególne urządzenia.
MessagingOptions	Interfejs przedstawiający opcje, które można udostępnić podczas wysyłania wiadomości za pomocą starszych interfejsów API FCM.Przykładowy kod i szczegółową dokumentację znajdziesz w artykule Tworzenie żądań wysyłania.
MessagingPayload	Interfejs reprezentujący ładunek wiadomości w usłudze Komunikacja w chmurze Firebase (FCM). Wymagany jest co najmniej 1 klucz `data` i `notification`.Przykładowy kod i szczegółową dokumentację znajdziesz w sekcji Tworzenie żądań wysyłania.
MessagingTopicManagementResponse (Odpowiedź na temat zarządzania tematem)	Interfejs reprezentujący odpowiedź serwera z metod Messaging.subscribeToTopic() i Messaging.unsubscribeFromTopic().Przykładowe fragmenty kodu i szczegółową dokumentację znajdziesz w sekcji Zarządzanie tematami z serwera.
MessagingTopicResponse (Odpowiedź na temat wiadomości)	Interfejs reprezentujący odpowiedź serwera ze starszej metody Messaging.sendToTopic().Przykładowy kod i szczegółową dokumentację znajdziesz w sekcji Wysyłanie do tematu.
Wiadomość multicast	Ładunek dla metody Messaging.sendMulticast(). Ładunek zawiera wszystkie pola typu BaseMessage oraz listę tokenów.
Powiadomienie	Powiadomienie, które można dodać do wiadomości.
PowiadomieniaMessagePayload	Interfejs reprezentujący ładunek wiadomości powiadomienia starszego interfejsu API FCM. Komunikaty z powiadomieniami umożliwiają programistom wysyłanie do 4 KB wstępnie zdefiniowanych par klucz-wartość. Poniżej znajdziesz akceptowane klucze.Przykładowy kod i szczegółową dokumentację znajdziesz w artykule Tworzenie żądań wysyłania.
SendResponse	Interfejs przedstawiający stan pojedynczej wiadomości wysłanej w ramach żądania zbiorczego.
TokenMessage
Temat:
WebpushConfig	Reprezentuje opcje protokołu WebPush, które mogą być uwzględnione w wiadomości.
WebpushFcmOptions	Reprezentuje opcje funkcji zapewnianych przez pakiet SDK FCM na potrzeby aplikacji internetowych (które nie są częścią standardu Webpush).
WebpushNotification	Reprezentuje opcje powiadomień specyficzne dla WebPush, które mogą być uwzględnione w konfiguracji WebpushConfig. Obsługuje większość opcji standardowych zdefiniowanych w specyfikacji powiadomień internetowych.

Typ aliasów

Typ aliasu	Opis
Wiadomość	Ładunek dla operacji Messaging.send(). Ładunek zawiera wszystkie pola typu BaseMessage i dokładnie jedno – token, temat lub warunek.

getMessaging(aplikacja)

Pobiera usługę Messaging (wiadomości) z domyślnej lub konkretnej aplikacji.

Funkcję admin.messaging() można wywołać bez argumentów, aby uzyskać dostęp do usługi Messaging domyślnej aplikacji, lub jako admin.messaging(app), aby uzyskać dostęp do usługi Messaging powiązanej z konkretną aplikacją.

Podpis:

export declare function getMessaging(app?: App): Messaging;

Parametry

Parametr	Typ	Opis
aplikacja	Aplikacja	Opcjonalna aplikacja, której usługa `Messaging` ma zostać zwrócona. Jeśli nie zostanie podana, zostanie zwrócona domyślna usługa `Messaging`.

Zwroty:

Wiadomości

Domyślna usługa Messaging, jeśli nie podano żadnej aplikacji lub usługa Messaging powiązana z daną aplikacją.

Przykład 1

// Get the Messaging service for the default app
const defaultMessaging = getMessaging();

Przykład 2

// Get the Messaging service for a given app
const otherMessaging = getMessaging(otherApp);

Wiadomość

Ładunek dla operacji Messaging.send(). Ładunek zawiera wszystkie pola typu BaseMessage i dokładnie jedno – token, temat lub warunek.

Podpis:

export type Message = TokenMessage | TopicMessage | ConditionMessage;