Messaging class

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

Podpis:

export declare class Messaging 

Właściwości

Właściwość Modyfikatory Typ Opis
aplikacja Aplikacja Aplikacja powiązana z bieżącą instancją usługi Messaging.

Metody

Metoda Modyfikatory Opis
enableLegacyHttpTransport(), Umożliwia korzystanie ze starszego transportu HTTP/1.1 w sendEach() i sendEachForMulticast().
send(message, dryRun) Wysyła daną wiadomość przez FCM.
sendAll(messages, dryRun) Wysyła wszystkie komunikaty z danej tablicy przez Komunikację w chmurze Firebase (FCM). Stosuje grupowanie do wysłania całej listy jako jednego wywołania RPC. W porównaniu z metodą send() ta metoda jest znacznie wydajniejszym sposobem wysyłania wielu wiadomości.Lista odpowiedzi uzyskana na podstawie zwracanej wartości odpowiada kolejności tokenów w MulticastMessage. Wystąpienie błędu tej metody oznacza całkowitą niepowodzenie, co oznacza, że nie udało się wysłać żadnych wiadomości z listy. Częściowe błędy są oznaczone zwracaną wartością BatchResponse.
sendEach(wiadomości, dryRun) Wysyła każdą wiadomość w danej tablicy przez Komunikację w chmurze Firebase (FCM).W przeciwieństwie do Messaging.sendAll() ta metoda wykonuje pojedyncze wywołanie RPC dla każdej wiadomości w danej tablicy.Lista odpowiedzi uzyskanych ze zwróconej wartości odpowiada kolejności messages. Błąd tej metody lub BatchResponse ze wszystkimi błędami oznacza, że nie udało się wysłać żadnej wiadomości z listy. Częściowe lub brak błędów są wskazywane tylko przez zwracaną wartość BatchResponse.
sendEachForMulticast(message, dryRun) Wysyła daną wiadomość multicast do wszystkich podanych w niej tokenów rejestracji FCM.Ta metoda używa wewnętrznego interfejsu API Messaging.sendEach(), aby wysłać daną wiadomość do wszystkich docelowych odbiorców. Lista odpowiedzi uzyskana ze zwróconej wartości odpowiada kolejności tokenów w MulticastMessage. Błąd tej metody lub BatchResponse ze wszystkimi błędami oznacza, że nie udało się wysłać wiadomości. Oznacza to, że wiadomości z listy mogły zostać wysłane. Częściowe niepowodzenia są wskazywane tylko przez zwracaną wartość BatchResponse.
sendMulticast(message, dryRun) Wysyła daną wiadomość multicast do wszystkich podanych w niej tokenów rejestracji FCM.Ta metoda korzysta z wewnętrznego interfejsu API sendAll(), aby wysłać daną wiadomość do wszystkich docelowych odbiorców. Lista odpowiedzi uzyskana ze zwróconej wartości odpowiada kolejności tokenów w MulticastMessage. Błąd z tej metody oznacza całkowitą niepowodzenie, co oznacza, że wiadomość nie została wysłana do żadnego tokena na liście. Częściowe błędy są oznaczone zwracaną wartością BatchResponse.
sendToCondition(warunek; ładunek; opcje) Wysyła wiadomość FCM do warunku.Przykładowy kod i szczegółową dokumentację znajdziesz w sekcji Wysyłanie do warunku.
sendToDevice(registrationTokenOrTokens, ładunek, opcje) Wysyła wiadomość FCM do jednego urządzenia odpowiadającego podanym tokenowi rejestracji.Przykładowy kod i szczegółową dokumentację znajdziesz w artykule Wysyłanie na poszczególne urządzenia. Pobiera parametr registrationToken (wysyłanie do jednego urządzenia) lub parametr registrationTokens zawierający tablicę tokenów do wysłania na wiele urządzeń.
sendToDeviceGroup(notificationKey, load, options) Wysyła wiadomość FCM do grupy urządzeń odpowiadającej podanym kluczowi powiadomień.Przykładowe kody i szczegółową dokumentację znajdziesz w artykule Wysyłanie do grupy urządzeń.
sendToTopic(temat, ładunek, opcje) Wysyła wiadomość FCM do tematu.Przykładowy kod i szczegółową dokumentację znajdziesz w artykule Wysyłanie do tematu.
subscribeToTopic(RegistrationTokenOrTokens, temat) Subskrybuje temat FCM na urządzeniu.Przykładowe fragmenty kodu i szczegółową dokumentację znajdziesz w artykule Subskrybowanie tematu. Opcjonalnie możesz podać tablicę tokenów, aby zasubskrybować wiele urządzeń.
unsubscribeFromTopic(registrationTokenOrTokens, temat) Anuluje subskrypcję tematu FCM na urządzeniu.Zobacz Anulowanie subskrypcji tematu, aby uzyskać przykładowy kod i szczegółową dokumentację. Opcjonalnie możesz podać tablicę tokenów umożliwiających anulowanie subskrypcji na wielu urządzeniach.

Messaging.app

Aplikacja powiązana z bieżącą instancją usługi Messaging.

Podpis:

get app(): App;

Przykład

var app = messaging.app;

Messaging.enableLegacyHttpTransport(),

Zostanie on usunięty, gdy implementacja transportu HTTP/2 osiągnie taką samą stabilność jak starsza implementacja HTTP/1.1.

Umożliwia korzystanie ze starszego transportu HTTP/1.1 w sendEach() i sendEachForMulticast().

Podpis:

enableLegacyHttpTransport(): void;

Zwroty:

nieważne

Przykład

const messaging = getMessaging(app);
messaging.enableLegacyTransport();
messaging.sendEach(messages);

Messaging.send()

Wysyła daną wiadomość przez FCM.

Podpis:

send(message: Message, dryRun?: boolean): Promise<string>;

Parametry

Parametr Typ Opis
wiadomość Wiadomość Ładunek wiadomości.
uruchomienie próbne wartość logiczna Określa, czy wysłać wiadomość w trybie próbnym (tylko weryfikacja).

Zwroty:

Obietnica<ciąg>

Obietnica zrealizowana z unikalnym identyfikatorem wiadomości po przekazaniu wiadomości do usługi FCM w celu jej dostarczenia.

Messaging.sendAll()

Użyj zamiast tego funkcji Messaging.sendEach().

Wysyła wszystkie komunikaty z danej tablicy przez Komunikację w chmurze Firebase (FCM). Stosuje grupowanie do wysłania całej listy jako jednego wywołania RPC. W porównaniu z metodą send() ta metoda jest znacznie wydajniejszym sposobem wysyłania wielu wiadomości.

Lista odpowiedzi uzyskana ze zwróconej wartości odpowiada kolejności tokenów w MulticastMessage. Wystąpienie błędu tej metody oznacza całkowitą niepowodzenie, co oznacza, że nie udało się wysłać żadnych wiadomości z listy. Częściowe błędy są oznaczone zwracaną wartością BatchResponse.

Podpis:

sendAll(messages: Message[], dryRun?: boolean): Promise<BatchResponse>;

Parametry

Parametr Typ Opis
wiadomości Wiadomość[] Niepusta tablica zawierająca maksymalnie 500 wiadomości.
uruchomienie próbne wartość logiczna Określa, czy wysyłać wiadomości w trybie próbnym (tylko weryfikacja).

Zwroty:

Obietnica<BatchResponse>

Obietnica zrealizowana przez obiekt reprezentujący wynik operacji wysyłania.

Messaging.sendEach()

Wysyła każdą wiadomość w danej tablicy przez Komunikację w chmurze Firebase (FCM).

W odróżnieniu od Messaging.sendAll() ta metoda powoduje utworzenie pojedynczego wywołania RPC dla każdej wiadomości w danej tablicy.

Lista odpowiedzi uzyskana na podstawie zwróconej wartości ma kolejność messages. Błąd tej metody lub BatchResponse ze wszystkimi błędami oznacza, że nie udało się wysłać żadnej wiadomości z listy. Częściowe lub brak błędów są wskazywane tylko przez zwracaną wartość BatchResponse.

Podpis:

sendEach(messages: Message[], dryRun?: boolean): Promise<BatchResponse>;

Parametry

Parametr Typ Opis
wiadomości Wiadomość[] Niepusta tablica zawierająca maksymalnie 500 wiadomości.
uruchomienie próbne wartość logiczna Określa, czy wysyłać wiadomości w trybie próbnym (tylko weryfikacja).

Zwroty:

Obietnica<BatchResponse>

Obietnica zrealizowana przez obiekt reprezentujący wynik operacji wysyłania.

Messaging.sendEachForMulticast()

Wysyła daną wiadomość multicast do wszystkich podanych w niej tokenów rejestracji FCM.

Ta metoda korzysta z wewnętrznego interfejsu API Messaging.sendEach(), aby wysłać daną wiadomość do wszystkich docelowych odbiorców. Lista odpowiedzi uzyskana ze zwróconej wartości odpowiada kolejności tokenów w MulticastMessage. Błąd tej metody lub BatchResponse ze wszystkimi błędami oznacza, że nie udało się wysłać wiadomości. Oznacza to, że wiadomości z listy mogły zostać wysłane. Częściowe niepowodzenia są wskazywane tylko przez zwracaną wartość BatchResponse.

Podpis:

sendEachForMulticast(message: MulticastMessage, dryRun?: boolean): Promise<BatchResponse>;

Parametry

Parametr Typ Opis
wiadomość Wiadomość MulticastMessage Wiadomość grupowa zawierająca maksymalnie 500 tokenów.
uruchomienie próbne wartość logiczna Określa, czy wysłać wiadomość w trybie próbnym (tylko weryfikacja).

Zwroty:

Obietnica<BatchResponse>

Obietnica zrealizowana przez obiekt reprezentujący wynik operacji wysyłania.

Messaging.sendMulticast()

Zamiast niej użyj Messaging.sendEachForMulticast().

Wysyła daną wiadomość multicast do wszystkich podanych w niej tokenów rejestracji FCM.

Ta metoda korzysta z wewnętrznego interfejsu API sendAll(), aby wysłać daną wiadomość do wszystkich docelowych odbiorców. Lista odpowiedzi uzyskana ze zwróconej wartości odpowiada kolejności tokenów w MulticastMessage. Błąd z tej metody oznacza całkowitą niepowodzenie, co oznacza, że wiadomość nie została wysłana do żadnego tokena na liście. Częściowe błędy są oznaczone zwracaną wartością BatchResponse.

Podpis:

sendMulticast(message: MulticastMessage, dryRun?: boolean): Promise<BatchResponse>;

Parametry

Parametr Typ Opis
wiadomość Wiadomość MulticastMessage Wiadomość grupowa zawierająca maksymalnie 500 tokenów.
uruchomienie próbne wartość logiczna Określa, czy wysłać wiadomość w trybie próbnym (tylko weryfikacja).

Zwroty:

Obietnica<BatchResponse>

Obietnica zrealizowana przez obiekt reprezentujący wynik operacji wysyłania.

Messaging.sendToCondition()

Użyj Messaging.send().

Wysyła wiadomość FCM do warunku.

Przykładowe fragmenty kodu i szczegółową dokumentację znajdziesz w sekcji Wysyłanie do warunku.

Podpis:

sendToCondition(condition: string, payload: MessagingPayload, options?: MessagingOptions): Promise<MessagingConditionResponse>;

Parametry

Parametr Typ Opis
stan ciąg znaków Warunek określający tematy, do których ma zostać wysłana wiadomość.
ładunek MessagingPayload Ładunek wiadomości.
opcje MessagingOptions (w języku angielskim) Opcjonalne opcje zmiany wiadomości.

Zwroty:

Obietnica<MessagingConditionResponse>

Obietnica spełniona z odpowiedzią serwera po wysłaniu wiadomości.

Messaging.sendToDevice()

Użyj Messaging.send().

Wysyła wiadomość FCM do jednego urządzenia odpowiadającego podanemu tokenowi rejestracji.

Przykładowe fragmenty kodu i szczegółową dokumentację znajdziesz w sekcji Wysyłanie na poszczególne urządzenia. Pobiera parametr registrationToken (wysyłanie do jednego urządzenia) lub parametr registrationTokens zawierający tablicę tokenów do wysłania na wiele urządzeń.

Podpis:

sendToDevice(registrationTokenOrTokens: string | string[], payload: MessagingPayload, options?: MessagingOptions): Promise<MessagingDevicesResponse>;

Parametry

Parametr Typ Opis
rejestracjaTokenOrTokens ciąg znaków | ciąg znaków[]
ładunek MessagingPayload Ładunek wiadomości.
opcje MessagingOptions (w języku angielskim) Opcjonalne opcje zmiany wiadomości.

Zwroty:

Obietnica<MessagingDeviceResponse>

Obietnica spełniona z odpowiedzią serwera po wysłaniu wiadomości.

Messaging.sendToDeviceGroup()

Użyj Messaging.send().

Wysyła wiadomość FCM do grupy urządzeń odpowiadającej podanemu kluczowi powiadomień.

Przykładowe kody i szczegółową dokumentację znajdziesz w sekcji Wysyłanie do grupy urządzeń.

Podpis:

sendToDeviceGroup(notificationKey: string, payload: MessagingPayload, options?: MessagingOptions): Promise<MessagingDeviceGroupResponse>;

Parametry

Parametr Typ Opis
klucz powiadomień ciąg znaków Klucz powiadomień grupy urządzeń, do której ma zostać wysłana wiadomość.
ładunek MessagingPayload Ładunek wiadomości.
opcje MessagingOptions (w języku angielskim) Opcjonalne opcje zmiany wiadomości.

Zwroty:

Obietnica<MessagingDeviceGroupResponse>

Obietnica spełniona z odpowiedzią serwera po wysłaniu wiadomości.

Messaging.sendToTopic()

Użyj Messaging.send().

Wysyła wiadomość FCM do tematu.

Przykładowy kod i szczegółową dokumentację znajdziesz w sekcji Send to a topic (Wysyłanie do tematu).

Podpis:

sendToTopic(topic: string, payload: MessagingPayload, options?: MessagingOptions): Promise<MessagingTopicResponse>;

Parametry

Parametr Typ Opis
temat ciąg znaków Temat, do którego ma zostać wysłana wiadomość.
ładunek MessagingPayload Ładunek wiadomości.
opcje MessagingOptions (w języku angielskim) Opcjonalne opcje zmiany wiadomości.

Zwroty:

Obietnica<MessagingTopicResponse>

Obietnica spełniona z odpowiedzią serwera po wysłaniu wiadomości.

Messaging.subscribeToTopic()

Subskrybuje temat FCM na urządzeniu.

Przykładowy kod i szczegółową dokumentację znajdziesz w artykule Subskrybowanie tematu. Opcjonalnie możesz podać tablicę tokenów, aby zasubskrybować wiele urządzeń.

Podpis:

subscribeToTopic(registrationTokenOrTokens: string | string[], topic: string): Promise<MessagingTopicManagementResponse>;

Parametry

Parametr Typ Opis
rejestracjaTokenOrTokens ciąg znaków | ciąg znaków[]
temat ciąg znaków Temat, który chcesz zasubskrybować.

Zwroty:

Obietnica<MessagingTopicManagementResponse>

Obietnica spełniona z odpowiedzią serwera po zasubskrybowaniu tematu przez urządzenie.

Messaging.unsubscribeFromTopic().

Anuluje subskrypcję tematu w FCM na urządzeniu.

Przykładowy kod i szczegółową dokumentację znajdziesz w artykule Anulowanie subskrypcji tematu. Opcjonalnie możesz podać tablicę tokenów umożliwiających anulowanie subskrypcji na wielu urządzeniach.

Podpis:

unsubscribeFromTopic(registrationTokenOrTokens: string | string[], topic: string): Promise<MessagingTopicManagementResponse>;

Parametry

Parametr Typ Opis
rejestracjaTokenOrTokens ciąg znaków | ciąg znaków[]
temat ciąg znaków Temat, od którego chcesz anulować subskrypcję.

Zwroty:

Obietnica<MessagingTopicManagementResponse>

Obietnica spełniona przez odpowiedź serwera po anulowaniu subskrypcji tematu na urządzeniu.