Usługa przesyłania wiadomości powiązana z dostarczoną aplikacją.
Podpis:
export declare class Messaging
Nieruchomości
Nieruchomość | Modyfikatory | Typ | Opis |
---|---|---|---|
aplikacja | Aplikacja | Aplikacja powiązana z bieżącą instancją usługi Messaging . |
Metody
metoda | Modyfikatory | Opis |
---|---|---|
wyślij(wiadomość, dryRun) | Wysyła podaną wiadomość poprzez FCM. | |
sendAll(wiadomości, dryRun) | Wysyła wszystkie wiadomości w danej tablicy za pośrednictwem Firebase Cloud Messaging. Wykorzystuje przetwarzanie wsadowe, aby wysłać całą listę jako pojedyncze wywołanie RPC. W porównaniu z metodą send() ta metoda jest znacznie wydajniejszą metodą wysyłania wielu wiadomości. Lista odpowiedzi uzyskana ze zwracanej wartości odpowiada kolejności tokenów w wiadomości MulticastMessage . Błąd tej metody oznacza całkowitą porażkę, co oznacza, że nie udało się wysłać żadnej wiadomości z listy. Częściowe awarie są wskazywane przez wartość zwracaną BatchResponse . | |
sendEach(wiadomości, dryRun) | Wysyła każdą wiadomość w danej tablicy za pośrednictwem Firebase Cloud Messaging. W przeciwieństwie do Messaging.sendAll() , ta metoda wykonuje pojedyncze wywołanie RPC dla każdego komunikatu w danej tablicy. Lista odpowiedzi uzyskana ze zwróconej wartości odpowiada kolejności messages . Błąd tej metody lub BatchResponse ze wszystkimi błędami wskazuje na całkowitą awarię, co oznacza, że nie można wysłać żadnego komunikatu z listy. Częściowe awarie lub brak awarii są wskazywane jedynie przez wartość zwracaną BatchResponse . | |
sendEachForMulticast(wiadomość, dryRun) | Wysyła daną wiadomość multiemisji do wszystkich określonych w niej tokenów rejestracyjnych FCM. Ta metoda wykorzystuje pod maską interfejs API Messaging.sendEach() w celu wysłania danej wiadomości do wszystkich docelowych odbiorców. Lista odpowiedzi uzyskana ze zwracanej wartości odpowiada kolejności tokenów w wiadomości MulticastMessage . Błąd tej metody lub BatchResponse ze wszystkimi błędami wskazuje na całkowitą awarię, co oznacza, że można było wysłać komunikaty z listy. Częściowe awarie lub awarie są wskazywane jedynie przez wartość zwracaną BatchResponse . | |
sendMulticast(wiadomość, dryRun) | Wysyła daną wiadomość multiemisji do wszystkich określonych w niej tokenów rejestracyjnych FCM. Ta metoda wykorzystuje pod maską funkcję sendAll() w celu wysłania danej wiadomości do wszystkich docelowych odbiorców. Lista odpowiedzi uzyskana ze zwracanej wartości odpowiada kolejności tokenów w wiadomości MulticastMessage . Błąd tej metody oznacza całkowitą porażkę, co oznacza, że wiadomość nie została wysłana do żadnego z tokenów na liście. Częściowe awarie są wskazywane przez wartość zwracaną BatchResponse . | |
sendToCondition(stan, ładunek, opcje) | Wysyła komunikat FCM do warunku. Zobacz Wyślij do warunku , aby zapoznać się z przykładowymi kodami i szczegółową dokumentacją. | |
sendToDevice(token rejestracyjnyOrTokens, ładunek, opcje) | Wysyła wiadomość FCM do pojedynczego urządzenia odpowiadającego podanemu tokenowi rejestracyjnemu. Zobacz Wysyłanie do poszczególnych urządzeń , aby zapoznać się z przykładowymi kodami i szczegółową dokumentacją. Pobiera registrationToken do wysłania na pojedyncze urządzenie lub parametr registrationTokens zawierający tablicę tokenów do wysłania do wielu urządzeń. | |
sendToDeviceGroup(klucz powiadomienia, ładunek, opcje) | Wysyła wiadomość FCM do grupy urządzeń odpowiadającej podanemu kluczowi powiadomienia. Zobacz Wysyłanie do grupy urządzeń , aby zapoznać się z przykładowymi kodami i szczegółową dokumentacją. | |
sendToTopic(temat, ładunek, opcje) | Wysyła wiadomość FCM do tematu. Zobacz Wyślij do tematu , aby uzyskać próbki kodu i szczegółową dokumentację. | |
subskrybujToTopic(Token rejestracjiOrTokens, temat) | Subskrybuje urządzenie w temacie FCM. Zobacz Subskrybuj temat , aby uzyskać próbki kodu i szczegółową dokumentację. Opcjonalnie możesz udostępnić szereg tokenów do subskrybowania wielu urządzeń. | |
unsubscribeFromTopic(token rejestracyjnyOrTokens, temat) | Anuluje subskrypcję urządzenia z tematu FCM. Zobacz Anulowanie subskrypcji tematu, aby zapoznać się z przykładowymi kodami i szczegółową dokumentacją. Opcjonalnie możesz podać szereg tokenów, aby anulować subskrypcję wielu urządzeń. |
Wiadomości.aplikacja
Aplikacja powiązana z bieżącą instancją usługi Messaging
.
Podpis:
get app(): App;
Przykład
var app = messaging.app;
Wiadomości.send()
Wysyła podaną wiadomość poprzez FCM.
Podpis:
send(message: Message, dryRun?: boolean): Promise<string>;
Parametry
Parametr | Typ | Opis |
---|---|---|
wiadomość | Wiadomość | Ładunek wiadomości. |
próba | wartość logiczna | Określa, czy wysłać wiadomość w trybie próbnym (tylko weryfikacja). |
Zwroty:
Obietnica<string>
Obietnica spełniona za pomocą unikalnego ciągu identyfikatora wiadomości po pomyślnym przekazaniu wiadomości do usługi FCM w celu dostarczenia.
Wiadomości.sendAll()
Zamiast tego użyj metody Messaging.sendEach() .
Wysyła wszystkie wiadomości w danej tablicy za pośrednictwem Firebase Cloud Messaging. Wykorzystuje przetwarzanie wsadowe, aby wysłać całą listę jako pojedyncze wywołanie RPC. W porównaniu z metodą send()
ta metoda jest znacznie wydajniejszą metodą wysyłania wielu wiadomości.
Lista odpowiedzi uzyskana ze zwracanej wartości odpowiada kolejności tokenów w wiadomości MulticastMessage
. Błąd tej metody oznacza całkowitą porażkę, co oznacza, że nie udało się wysłać żadnej wiadomości z listy. Częściowe awarie są wskazywane przez wartość zwracaną BatchResponse
.
Podpis:
sendAll(messages: Message[], dryRun?: boolean): Promise<BatchResponse>;
Parametry
Parametr | Typ | Opis |
---|---|---|
wiadomości | Wiadomość [] | Niepusta tablica zawierająca maksymalnie 500 komunikatów. |
próba | wartość logiczna | Określa, czy wysyłać komunikaty w trybie próbnym (tylko weryfikacja). |
Zwroty:
Obietnica< BatchResponse >
Obietnica spełniona za pomocą obiektu reprezentującego wynik operacji wysyłania.
Wiadomości.sendEach()
Wysyła każdą wiadomość w danej tablicy za pośrednictwem Firebase Cloud Messaging.
W przeciwieństwie do Messaging.sendAll() , ta metoda wykonuje pojedyncze wywołanie RPC dla każdego komunikatu w danej tablicy.
Lista odpowiedzi uzyskana ze zwracanej wartości odpowiada kolejności messages
. Błąd tej metody lub BatchResponse
ze wszystkimi błędami wskazuje na całkowitą awarię, co oznacza, że nie można wysłać żadnego komunikatu z listy. Częściowe awarie lub brak awarii są wskazywane jedynie przez wartość zwracaną BatchResponse
.
Podpis:
sendEach(messages: Message[], dryRun?: boolean): Promise<BatchResponse>;
Parametry
Parametr | Typ | Opis |
---|---|---|
wiadomości | Wiadomość [] | Niepusta tablica zawierająca maksymalnie 500 komunikatów. |
próba | wartość logiczna | Określa, czy wysyłać komunikaty w trybie próbnym (tylko weryfikacja). |
Zwroty:
Obietnica< BatchResponse >
Obietnica spełniona za pomocą obiektu reprezentującego wynik operacji wysyłania.
Wiadomości.sendEachForMulticast()
Wysyła daną wiadomość multiemisji do wszystkich określonych w niej tokenów rejestracyjnych FCM.
Ta metoda wykorzystuje pod maską interfejs API Messaging.sendEach() w celu wysłania danej wiadomości do wszystkich docelowych odbiorców. Lista odpowiedzi uzyskana ze zwracanej wartości odpowiada kolejności tokenów w wiadomości MulticastMessage
. Błąd tej metody lub BatchResponse
ze wszystkimi błędami wskazuje na całkowitą awarię, co oznacza, że można było wysłać komunikaty z listy. Częściowe awarie lub awarie są wskazywane jedynie przez wartość zwracaną BatchResponse
.
Podpis:
sendEachForMulticast(message: MulticastMessage, dryRun?: boolean): Promise<BatchResponse>;
Parametry
Parametr | Typ | Opis |
---|---|---|
wiadomość | Wiadomość multiemisji | Wiadomość multiemisji zawierająca do 500 tokenów. |
próba | wartość logiczna | Określa, czy wysłać wiadomość w trybie próbnym (tylko weryfikacja). |
Zwroty:
Obietnica< BatchResponse >
Obietnica spełniona za pomocą obiektu reprezentującego wynik operacji wysyłania.
Wiadomości.sendMulticast()
Zamiast tego użyj metody Messaging.sendEachForMulticast() .
Wysyła daną wiadomość multiemisji do wszystkich określonych w niej tokenów rejestracyjnych FCM.
Ta metoda wykorzystuje pod maską funkcję sendAll()
w celu wysłania danej wiadomości do wszystkich docelowych odbiorców. Lista odpowiedzi uzyskana ze zwracanej wartości odpowiada kolejności tokenów w wiadomości MulticastMessage
. Błąd tej metody oznacza całkowitą porażkę, co oznacza, że wiadomość nie została wysłana do żadnego z tokenów na liście. Częściowe awarie są wskazywane przez wartość zwracaną BatchResponse
.
Podpis:
sendMulticast(message: MulticastMessage, dryRun?: boolean): Promise<BatchResponse>;
Parametry
Parametr | Typ | Opis |
---|---|---|
wiadomość | Wiadomość multiemisji | Wiadomość multiemisji zawierająca do 500 tokenów. |
próba | wartość logiczna | Określa, czy wysłać wiadomość w trybie próbnym (tylko weryfikacja). |
Zwroty:
Obietnica< BatchResponse >
Obietnica spełniona za pomocą obiektu reprezentującego wynik operacji wysyłania.
Wiadomości.sendToCondition()
Wysyła komunikat FCM do warunku.
Zobacz Wyślij do warunku , aby zapoznać się z przykładowymi kodami i szczegółową dokumentacją.
Podpis:
sendToCondition(condition: string, payload: MessagingPayload, options?: MessagingOptions): Promise<MessagingConditionResponse>;
Parametry
Parametr | Typ | Opis |
---|---|---|
stan | strunowy | Warunek określający do jakich tematów wysłać wiadomość. |
ładunek | Przesyłanie wiadomości | Ładunek wiadomości. |
opcje | Opcje wiadomości | Opcjonalne opcje zmiany wiadomości. |
Zwroty:
Obietnica< MessagingConditionResponse >
Obietnica spełniona wraz z odpowiedzią serwera po wysłaniu wiadomości.
Wiadomości.sendToDevice()
Zamiast tego użyj metody Messaging.send() .
Wysyła wiadomość FCM do pojedynczego urządzenia odpowiadającego podanemu tokenowi rejestracyjnemu.
Zobacz Wysyłanie do poszczególnych urządzeń , aby zapoznać się z przykładowymi kodami i szczegółową dokumentacją. Pobiera registrationToken
do wysłania na pojedyncze urządzenie lub parametr registrationTokens
zawierający tablicę tokenów do wysłania do wielu urządzeń.
Podpis:
sendToDevice(registrationTokenOrTokens: string | string[], payload: MessagingPayload, options?: MessagingOptions): Promise<MessagingDevicesResponse>;
Parametry
Parametr | Typ | Opis |
---|---|---|
rejestracjaTokenOrTokens | ciąg | strunowy[] | |
ładunek | Przesyłanie wiadomości | Ładunek wiadomości. |
opcje | Opcje wiadomości | Opcjonalne opcje zmiany wiadomości. |
Zwroty:
Obietnica< Odpowiedź MessagingDevices >
Obietnica spełniona wraz z odpowiedzią serwera po wysłaniu wiadomości.
Wiadomości.sendToDeviceGroup()
Zamiast tego użyj metody Messaging.send() .
Wysyła wiadomość FCM do grupy urządzeń odpowiadającej podanemu kluczowi powiadomienia.
Zobacz Wysyłanie do grupy urządzeń , aby zapoznać się z przykładowymi kodami i szczegółową dokumentacją.
Podpis:
sendToDeviceGroup(notificationKey: string, payload: MessagingPayload, options?: MessagingOptions): Promise<MessagingDeviceGroupResponse>;
Parametry
Parametr | Typ | Opis |
---|---|---|
klucz powiadomienia | strunowy | Klucz powiadomienia dla grupy urządzeń, do której ma zostać wysłana wiadomość. |
ładunek | Przesyłanie wiadomości | Ładunek wiadomości. |
opcje | Opcje wiadomości | Opcjonalne opcje zmiany wiadomości. |
Zwroty:
Obietnica< MessagingDeviceGroupResponse >
Obietnica spełniona wraz z odpowiedzią serwera po wysłaniu wiadomości.
Wiadomości.sendToTopic()
Wysyła wiadomość FCM do tematu.
Zobacz Wyślij do tematu , aby uzyskać próbki kodu i szczegółową dokumentację.
Podpis:
sendToTopic(topic: string, payload: MessagingPayload, options?: MessagingOptions): Promise<MessagingTopicResponse>;
Parametry
Parametr | Typ | Opis |
---|---|---|
temat | strunowy | Temat, do którego ma zostać wysłana wiadomość. |
ładunek | Przesyłanie wiadomości | Ładunek wiadomości. |
opcje | Opcje wiadomości | Opcjonalne opcje zmiany wiadomości. |
Zwroty:
Obietnica< MessagingTopicResponse >
Obietnica spełniona wraz z odpowiedzią serwera po wysłaniu wiadomości.
Wiadomości.subscribeToTopic()
Subskrybuje urządzenie w temacie FCM.
Zobacz Subskrybuj temat , aby uzyskać próbki kodu i szczegółową dokumentację. Opcjonalnie możesz udostępnić szereg tokenów do subskrybowania wielu urządzeń.
Podpis:
subscribeToTopic(registrationTokenOrTokens: string | string[], topic: string): Promise<MessagingTopicManagementResponse>;
Parametry
Parametr | Typ | Opis |
---|---|---|
rejestracjaTokenOrTokens | ciąg | strunowy[] | |
temat | strunowy | Temat, który chcesz subskrybować. |
Zwroty:
Obietnica< MessagingTopicManagementResponse >
Obietnica spełniona wraz z odpowiedzią serwera po zasubskrybowaniu tematu przez urządzenie.
Wiadomości.unsubscribeFromTopic()
Anuluje subskrypcję urządzenia z tematu FCM.
Zobacz Anulowanie subskrypcji tematu, aby zapoznać się z przykładowymi kodami i szczegółową dokumentacją. Opcjonalnie możesz podać szereg tokenów, aby anulować subskrypcję wielu urządzeń.
Podpis:
unsubscribeFromTopic(registrationTokenOrTokens: string | string[], topic: string): Promise<MessagingTopicManagementResponse>;
Parametry
Parametr | Typ | Opis |
---|---|---|
rejestracjaTokenOrTokens | ciąg | strunowy[] | |
temat | strunowy | Temat, z którego chcesz zrezygnować. |
Zwroty:
Obietnica< MessagingTopicManagementResponse >
Obietnica spełniona wraz z odpowiedzią serwera po wypisaniu się urządzenia z tematu.