firebase-admin.messaging package

Komunikacja w chmurze Firebase (FCM).

Funkcje

Funkcja Opis
getMessaging(aplikacja) Pobiera usługę Messaging dla aplikacji domyślnej lub danej aplikacji.Funkcja admin.messaging() może być wywoływana bez argumentów umożliwiających dostęp do usługi Messaging domyślnej aplikacji lub jako admin.messaging(app) w celu uzyskania dostępu do usługi Messaging powiązanej z konkretną aplikacją.

Zajęcia

Klasa Opis
FirebaseMessagingError. Struktura kodów błędów w Wiadomościach Firebase. Rozszerza ten błąd PrefixedFirebaseError.
Wiadomości Usługa przesyłania wiadomości powiązana z udostępnioną aplikacją.
MessagingClientErrorCode Kody błędów klientów aplikacji do obsługi wiadomości i ich komunikaty domyślne.

Interfejsy

Interfejs Opis
AndroidConfig, Reprezentuje opcje związane z Androidem, które można uwzględnić w wiadomości.
AndroidFcmOptions Przedstawia opcje funkcji dostępnych w pakiecie SDK FCM na Androida.
AndroidPowiadomienie. Reprezentuje opcje powiadomień związane z Androidem, które można uwzględnić w elemencie AndroidConfig.
Konfiguracja pns Reprezentuje opcje specyficzne dla APNs, które można uwzględnić w wiadomości. Informacje o różnych nagłówkach i polach ładunku obsługiwanych przez punkty APN znajdziesz w dokumentacji Apple.
ApnsFcmOptions Reprezentuje opcje funkcji dostępnych w pakiecie SDK FCM na iOS.
ApnsPayload Reprezentuje ładunek wiadomości APNs. Składa się głównie ze słownika aps. Może też jednak zawierać inne dowolne klucze niestandardowe.
Aplikacje Reprezentuje słownik API, który jest częścią wiadomości APNs.
ApsAlert
Wiadomość podstawowa
BatchResponse Interfejs reprezentujący odpowiedź serwera za pomocą metod Messaging.sendAll() i Messaging.sendMulticast().
ConditionMessage
Krytyczny dźwięk Reprezentuje krytyczną konfigurację dźwięku, która może zostać uwzględniona w słowniku aps ładunku APNs.
DataMessagePayload Interfejs reprezentujący ładunek wiadomości ze starszym interfejsem API FCM. Komunikaty z danymi pozwalają programistom wysyłać 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 zarezerwowanych ciągów znaków:
  • from
  • Wszystkie elementy zaczynające się od google.
Przykładowe fragmenty kodu i szczegółową dokumentację znajdziesz w artykule Tworzenie żądań wysyłania.
FcmOptions Reprezentuje niezależne od platformy opcje funkcji udostępnianych przez pakiety SDK FCM.
Ustawienia oświetlenia Reprezentuje ustawienia umożliwiające kontrolowanie diody LED powiadomień, które można uwzględnić w powiadomieniu AndroidPowiadomienie.
MessagingConditionResponse (Odpowiedź w języku MessagingCondition) Interfejs reprezentujący odpowiedź serwera ze starszej metody Messaging.sendToCondition().Przykładowy kod i szczegółową dokumentację znajdziesz w sekcji Wysyłanie do warunku.
MessagingDeviceGroupResponse Interfejs reprezentujący odpowiedź serwera za pomocą metody Messaging.sendToDeviceGroup().Przykładowy kod i szczegółową dokumentację znajdziesz w sekcji Wysyłanie wiadomości do grup urządzeń.
MessagingDeviceResult Ładunek poszczególnych odpowiedzi dotyczących stanu z 1 urządzeń
Odpowiedź na urządzenie do obsługi wiadomości Interfejs reprezentujący stan wiadomości wysłanej do konkretnego urządzenia za pomocą starszych interfejsów API FCM.Przykładowy kod i szczegółową dokumentację znajdziesz w sekcji Wysyłanie na poszczególne urządzenia.
MessagingOptions (w języku angielskim) Interfejs przedstawiający opcje dostępne 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 przedstawiający ładunek wiadomości Komunikacja w chmurze Firebase (FCM). Wymagany jest co najmniej jeden z tych kluczy: data i notification.Przykładowy kod i szczegółową dokumentację znajdziesz w artykule Tworzenie żądań wysyłania.
MessagingTopicManagementResponse Interfejs reprezentujący odpowiedź serwera w metodach Messaging.subscribeToTopic() i Messaging.unsubscribeFromTopic().Przykładowy kod i szczegółową dokumentację znajdziesz w artykule Zarządzanie tematami na serwerze.
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 Send to a topic (Wyślij do tematu).
Wiadomość MulticastMessage Ładunek dla metody Messaging.sendMulticast(). Ładunek zawiera wszystkie pola typu BaseMessage oraz listę tokenów.
Powiadomienie Powiadomienie, które można dołączyć do wiadomości.
notificationMessagePayload Interfejs reprezentujący ładunek wiadomości powiadomienia starszego interfejsu API FCM. Wiadomości z powiadomieniami pozwalają programistom wysyłać do 4 KB wstępnie zdefiniowanych par klucz-wartość. Poniżej znajdziesz akceptowane klucze.Przykłady kodu i szczegółową dokumentację znajdziesz w artykule Tworzenie żądań wysyłania.
Wyślij odpowiedź Interfejs przedstawiający stan pojedynczej wiadomości wysłanej w ramach żądania zbiorczego.
TokenMessage
TopicMessage
WebpushConfig Reprezentuje opcje protokołu WebPush, które można uwzględnić w wiadomości.
WebpushFcmOptions Przedstawia opcje funkcji dostępnych w pakiecie SDK FCM na potrzeby aplikacji internetowych (które nie są częścią standardu Webpush).
WebpushPowiadomienie Reprezentuje opcje powiadomień specyficzne dla WebPush, które mogą zostać uwzględnione w WebpushConfig. Obsługuje większość opcji standardowych określonych w specyfikacji powiadomień internetowych .

Aliasy typu

Wpisz alias Opis
Wiadomość Ładunek dla operacji Messaging.send(). Ładunek zawiera wszystkie pola typu BaseMessage i dokładnie jedno z pól tokena, tematu lub warunku.

getMessaging(aplikacja)

Pobiera usługę Messaging z aplikacji domyślnej lub danej.

Funkcja admin.messaging() może być wywoływana bez argumentów umożliwiających dostęp do usługi Messaging domyślnej aplikacji lub jako admin.messaging(app) w celu uzyskania dostępu 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, dla której Messaging ma zwrócić usługę. Jeśli nie zostanie podana, zostanie zwrócona domyślna usługa Messaging.

Zwroty:

Wiadomości

Domyślna usługa Messaging w przypadku braku aplikacji lub usługa Messaging powiązana z udostępnioną 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 z pól tokena, tematu lub warunku.

Podpis:

export type Message = TokenMessage | TopicMessage | ConditionMessage;