Messaging class

Servizio di messaggistica legato all'app fornita.

Firma:

export declare class Messaging 

Proprietà

Proprietà Modificatori Tipo Descrizione
app App L' app associata all'istanza del servizio Messaging corrente.

Metodi

Metodo Modificatori Descrizione
invia(messaggio, dryRun) Invia il messaggio specificato tramite FCM.
sendAll(messaggi, dryRun) Invia tutti i messaggi nell'array specificato tramite Firebase Cloud Messaging. Utilizza il batch per inviare l'intero elenco come una singola chiamata RPC. Rispetto al metodo send() , questo metodo è molto più efficiente per inviare più messaggi. L'elenco delle risposte ottenuto dal valore restituito corrisponde all'ordine dei token in MulticastMessage . Un errore di questo metodo indica un fallimento totale, ovvero che non è stato possibile inviare nessuno dei messaggi nell'elenco. Gli errori parziali sono indicati da un valore restituito BatchResponse .
sendEach(messaggi, dryRun) Invia ogni messaggio nell'array specificato tramite Firebase Cloud Messaging. A differenza di Messaging.sendAll() , questo metodo effettua una singola chiamata RPC per ogni messaggio nell'array specificato. L'elenco delle risposte ottenuto dal valore restituito corrisponde all'ordine dei messages . Un errore da questo metodo o un BatchResponse con tutti gli errori indica un errore totale, ovvero che non è stato possibile inviare nessuno dei messaggi nell'elenco. Gli errori parziali o l'assenza di errori sono indicati solo da un valore restituito BatchResponse .
sendEachForMulticast(messaggio, dryRun) Invia il messaggio multicast specificato a tutti i token di registrazione FCM specificati in esso. Questo metodo utilizza l'API Messaging.sendEach() dietro le quinte per inviare il messaggio specificato a tutti i destinatari di destinazione. L'elenco delle risposte ottenuto dal valore restituito corrisponde all'ordine dei token in MulticastMessage . Un errore da questo metodo o un BatchResponse con tutti gli errori indica un errore totale, il che significa che è stato possibile inviare i messaggi nell'elenco. Guasti o guasti parziali sono indicati solo da un valore restituito BatchResponse .
sendMulticast(messaggio, dryRun) Invia il messaggio multicast specificato a tutti i token di registrazione FCM specificati in esso. Questo metodo utilizza l'API sendAll() dietro le quinte per inviare il messaggio specificato a tutti i destinatari di destinazione. L'elenco delle risposte ottenuto dal valore restituito corrisponde all'ordine dei token in MulticastMessage . Un errore di questo metodo indica un errore totale, ovvero che il messaggio non è stato inviato a nessuno dei token nell'elenco. Gli errori parziali sono indicati da un valore restituito BatchResponse .
sendToCondition(condizione, carico utile, opzioni) Invia un messaggio FCM a una condizione. Vedi Invia a una condizione per esempi di codice e documentazione dettagliata.
sendToDevice(registrationTokenOrTokens, payload, opzioni) Invia un messaggio FCM a un singolo dispositivo corrispondente al token di registrazione fornito. Vedi Invio a singoli dispositivi per esempi di codice e documentazione dettagliata. Accetta un registrationToken da inviare a un singolo dispositivo o un parametro registrationTokens contenente una serie di token da inviare a più dispositivi.
sendToDeviceGroup(notificationKey, payload, opzioni) Invia un messaggio FCM a un gruppo di dispositivi corrispondente alla chiave di notifica fornita. Vedi Invia a un gruppo di dispositivi per esempi di codici e documentazione dettagliata.
sendToTopic(argomento, payload, opzioni) Invia un messaggio FCM a un argomento. Vedere Invia a un argomento per esempi di codice e documentazione dettagliata.
SubscribeToTopic(registrationTokenOrTokens, argomento) Sottoscrive un dispositivo a un argomento FCM. Vedere Sottoscrivere un argomento per esempi di codice e documentazione dettagliata. Facoltativamente, puoi fornire una serie di token per sottoscrivere più dispositivi.
unsubscribeFromTopic(registrationTokenOrTokens, argomento) Annulla la sottoscrizione di un dispositivo da un argomento FCM. Vedere Annullare l'iscrizione a un argomento per esempi di codice e documentazione dettagliata. Facoltativamente, puoi fornire una serie di token per annullare l'iscrizione a più dispositivi.

Messaggistica.app

L' app associata all'istanza del servizio Messaging corrente.

Firma:

get app(): App;

Esempio

var app = messaging.app;

Messaggistica.send()

Invia il messaggio specificato tramite FCM.

Firma:

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

Parametri

Parametro Tipo Descrizione
Messaggio Messaggio Il carico utile del messaggio.
funzionamento a secco booleano Indica se inviare il messaggio in modalità di prova (solo convalida).

Ritorna:

Promesso<string>

Una promessa mantenuta con una stringa ID messaggio univoca dopo che il messaggio è stato trasmesso con successo al servizio FCM per la consegna.

Messaggistica.sendAll()

Utilizzare invece Messaging.sendEach() .

Invia tutti i messaggi nell'array specificato tramite Firebase Cloud Messaging. Utilizza il batch per inviare l'intero elenco come una singola chiamata RPC. Rispetto al metodo send() , questo metodo è molto più efficiente per inviare più messaggi.

L'elenco delle risposte ottenuto dal valore restituito corrisponde all'ordine dei token nel MulticastMessage . Un errore di questo metodo indica un fallimento totale, ovvero che non è stato possibile inviare nessuno dei messaggi nell'elenco. Gli errori parziali sono indicati da un valore restituito BatchResponse .

Firma:

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

Parametri

Parametro Tipo Descrizione
messaggi Messaggio [] Un array non vuoto contenente fino a 500 messaggi.
funzionamento a secco booleano Indica se inviare i messaggi nella modalità di prova (solo convalida).

Ritorna:

Promessa < BatchResponse >

Una promessa soddisfatta con un oggetto che rappresenta il risultato dell'operazione di invio.

Messaggistica.sendEach()

Invia ogni messaggio nell'array specificato tramite Firebase Cloud Messaging.

A differenza di Messaging.sendAll() , questo metodo effettua una singola chiamata RPC per ogni messaggio nell'array specificato.

L'elenco delle risposte ottenuto dal valore restituito corrisponde all'ordine dei messages . Un errore da questo metodo o un BatchResponse con tutti gli errori indica un errore totale, ovvero che non è stato possibile inviare nessuno dei messaggi nell'elenco. Gli errori parziali o l'assenza di errori sono indicati solo da un valore restituito BatchResponse .

Firma:

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

Parametri

Parametro Tipo Descrizione
messaggi Messaggio [] Un array non vuoto contenente fino a 500 messaggi.
funzionamento a secco booleano Indica se inviare i messaggi nella modalità di prova (solo convalida).

Ritorna:

Promessa < BatchResponse >

Una promessa soddisfatta con un oggetto che rappresenta il risultato dell'operazione di invio.

Messaging.sendEachForMulticast()

Invia il messaggio multicast specificato a tutti i token di registrazione FCM specificati in esso.

Questo metodo utilizza l'API Messaging.sendEach() dietro le quinte per inviare il messaggio specificato a tutti i destinatari di destinazione. L'elenco delle risposte ottenuto dal valore restituito corrisponde all'ordine dei token nel MulticastMessage . Un errore da questo metodo o un BatchResponse con tutti gli errori indica un errore totale, il che significa che è stato possibile inviare i messaggi nell'elenco. Guasti o guasti parziali sono indicati solo da un valore restituito BatchResponse .

Firma:

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

Parametri

Parametro Tipo Descrizione
Messaggio Messaggio multicast Un messaggio multicast contenente fino a 500 token.
funzionamento a secco booleano Indica se inviare il messaggio in modalità di prova (solo convalida).

Ritorna:

Promessa < BatchResponse >

Una promessa soddisfatta con un oggetto che rappresenta il risultato dell'operazione di invio.

Messaggistica.sendMulticast()

Utilizzare invece Messaging.sendEachForMulticast() .

Invia il messaggio multicast specificato a tutti i token di registrazione FCM specificati in esso.

Questo metodo utilizza l'API sendAll() dietro le quinte per inviare il messaggio specificato a tutti i destinatari di destinazione. L'elenco delle risposte ottenuto dal valore restituito corrisponde all'ordine dei token nel MulticastMessage . Un errore di questo metodo indica un errore totale, ovvero che il messaggio non è stato inviato a nessuno dei token nell'elenco. Gli errori parziali sono indicati da un valore restituito BatchResponse .

Firma:

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

Parametri

Parametro Tipo Descrizione
Messaggio Messaggio multicast Un messaggio multicast contenente fino a 500 token.
funzionamento a secco booleano Indica se inviare il messaggio in modalità di prova (solo convalida).

Ritorna:

Promessa < BatchResponse >

Una promessa soddisfatta con un oggetto che rappresenta il risultato dell'operazione di invio.

Messaggistica.sendToCondition()

Invia un messaggio FCM a una condizione.

Vedi Invia a una condizione per esempi di codice e documentazione dettagliata.

Firma:

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

Parametri

Parametro Tipo Descrizione
condizione corda La condizione che determina a quali argomenti inviare il messaggio.
carico utile MessaggisticaPayload Il carico utile del messaggio.
opzioni Opzioni di messaggistica Opzioni facoltative per modificare il messaggio.

Ritorna:

Promessa< MessagingConditionResponse >

Una promessa mantenuta con la risposta del server dopo che il messaggio è stato inviato.

Messaggistica.sendToDevice()

Utilizzare invece Messaging.send() .

Invia un messaggio FCM a un singolo dispositivo corrispondente al token di registrazione fornito.

Vedi Invio a singoli dispositivi per esempi di codici e documentazione dettagliata. Accetta un registrationToken da inviare a un singolo dispositivo o un parametro registrationTokens contenente una serie di token da inviare a più dispositivi.

Firma:

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

Parametri

Parametro Tipo Descrizione
registrazioneTokenOrTokens stringa | corda[]
carico utile MessaggisticaPayload Il carico utile del messaggio.
opzioni Opzioni di messaggistica Opzioni facoltative per modificare il messaggio.

Ritorna:

Promessa< MessagingDevicesResponse >

Una promessa mantenuta con la risposta del server dopo che il messaggio è stato inviato.

Messaggistica.sendToDeviceGroup()

Utilizzare invece Messaging.send() .

Invia un messaggio FCM a un gruppo di dispositivi corrispondente alla chiave di notifica fornita.

Vedi Invia a un gruppo di dispositivi per esempi di codici e documentazione dettagliata.

Firma:

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

Parametri

Parametro Tipo Descrizione
notificationKey corda La chiave di notifica per il gruppo di dispositivi a cui inviare il messaggio.
carico utile MessaggisticaPayload Il carico utile del messaggio.
opzioni Opzioni di messaggistica Opzioni facoltative per modificare il messaggio.

Ritorna:

Promessa< MessagingDeviceGroupResponse >

Una promessa mantenuta con la risposta del server dopo che il messaggio è stato inviato.

Messaggistica.sendToTopic()

Invia un messaggio FCM a un argomento.

Vedere Invia a un argomento per esempi di codice e documentazione dettagliata.

Firma:

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

Parametri

Parametro Tipo Descrizione
argomento corda L'argomento a cui inviare il messaggio.
carico utile MessaggisticaPayload Il carico utile del messaggio.
opzioni Opzioni di messaggistica Opzioni facoltative per modificare il messaggio.

Ritorna:

Promessa< MessagingTopicResponse >

Una promessa mantenuta con la risposta del server dopo che il messaggio è stato inviato.

Messaggistica.subscribeToTopic()

Sottoscrive un dispositivo a un argomento FCM.

Vedere Sottoscrivere un argomento per esempi di codice e documentazione dettagliata. Facoltativamente, puoi fornire una serie di token per sottoscrivere più dispositivi.

Firma:

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

Parametri

Parametro Tipo Descrizione
registrazioneTokenOrTokens stringa | corda[]
argomento corda L'argomento a cui iscriversi.

Ritorna:

Promessa< MessagingTopicManagementResponse >

Una promessa mantenuta con la risposta del server dopo che il dispositivo è stato iscritto all'argomento.

Messaging.unsubscribeFromTopic()

Annulla la sottoscrizione di un dispositivo da un argomento FCM.

Vedere Annullare l'iscrizione a un argomento per esempi di codice e documentazione dettagliata. Facoltativamente, puoi fornire una serie di token per annullare l'iscrizione a più dispositivi.

Firma:

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

Parametri

Parametro Tipo Descrizione
registrazioneTokenOrTokens stringa | corda[]
argomento corda L'argomento da cui annullare l'iscrizione.

Ritorna:

Promessa< MessagingTopicManagementResponse >

Una promessa mantenuta con la risposta del server dopo che il dispositivo è stato annullato l'iscrizione all'argomento.