Firebase Cloud Messaging (FCM).
Funzioni
| Funzione | Descrizione |
|---|---|
| getMessaging(app) | Ottiene il servizio di messaggistica per l'app predefinita o per una determinata app. admin.messaging() può essere chiamato senza argomenti per accedere al servizio Messaging dell'app predefinita o come admin.messaging(app) per accedere al servizio Messaging associato a un'app specifica. |
Classi
| Classe | Descrizione |
|---|---|
| Messaggistica | Servizio di messaggistica legato all'app fornita. |
Interfacce
| Interfaccia | Descrizione |
|---|---|
| AndroidConfig | Rappresenta le opzioni specifiche di Android che possono essere incluse in un messaggio . |
| Opzioni AndroidFcm | Rappresenta le opzioni per le funzionalità fornite dall'SDK FCM per Android. |
| AndroidNotifica | Rappresenta le opzioni di notifica specifiche di Android che possono essere incluse in AndroidConfig . |
| ApnsConfig | Rappresenta le opzioni specifiche degli APN che possono essere incluse in un messaggio . Fare riferimento alla documentazione Apple per le varie intestazioni e campi di payload supportati dagli APN. |
| Opzioni ApnsFcm | Rappresenta le opzioni per le funzionalità fornite dall'SDK FCM per iOS. |
| ApnsPayload | Rappresenta il payload di un messaggio APN. Consiste principalmente nel dizionario aps . Ma può contenere anche altre chiavi personalizzate arbitrarie. |
| Ap | Rappresenta il dizionario aps che fa parte dei messaggi APN. |
| ApsAlert | |
| BaseMessage | |
| Risposta batch | Interfaccia che rappresenta la risposta del server dai metodi Messaging.sendAll() e Messaging.sendMulticast() . |
| CondizioneMessaggio | |
| CriticalSound | Rappresenta una configurazione audio critica che può essere inclusa nel dizionario aps di un payload APN. |
| DataMessagePayload | Interfaccia che rappresenta un payload di messaggi di dati API legacy FCM. I messaggi di dati consentono agli sviluppatori di inviare fino a 4 KB di coppie chiave-valore personalizzate. Le chiavi e i valori devono essere entrambi stringhe. Le chiavi possono essere qualsiasi stringa personalizzata, ad eccezione delle seguenti stringhe riservate:
|
| Opzioni Fcm | Rappresenta opzioni indipendenti dalla piattaforma per le funzionalità fornite dagli SDK FCM. |
| Impostazioni luce | Rappresenta le impostazioni per controllare il LED di notifica che possono essere incluse in AndroidNotification . |
| MessagingConditionResponse | Interfaccia che rappresenta la risposta del server dal metodo legacy Messaging.sendToCondition() . Vedi Invia a una condizione per esempi di codice e documentazione dettagliata. |
| MessagingDeviceGroupResponse | Interfaccia che rappresenta la risposta del server dal metodo Messaging.sendToDeviceGroup() . Vedi Invio di messaggi a gruppi di dispositivi per esempi di codici e documentazione dettagliata. |
| MessagingDeviceResult | Payload di risposta allo stato individuale da singoli dispositivi |
| MessagingDevicesResponse | Interfaccia che rappresenta lo stato di un messaggio inviato a un singolo dispositivo tramite le API legacy FCM. Vedi Invio a singoli dispositivi per esempi di codice e documentazione dettagliata. |
| Opzioni di messaggistica | Interfaccia che rappresenta le opzioni che possono essere fornite quando si invia un messaggio tramite le API legacy FCM. Vedi Compilare richieste di invio per esempi di codice e documentazione dettagliata. |
| MessaggisticaPayload | Interfaccia che rappresenta un payload del messaggio Firebase Cloud Messaging. Sono necessarie una o entrambe le chiavi data e notification . Vedi Compilare richieste di invio per esempi di codice e documentazione dettagliata. |
| MessagingTopicManagementResponse | Interfaccia che rappresenta la risposta del server dai metodi Messaging.subscribeToTopic() e Messaging.unsubscribeFromTopic() . Vedi Gestire argomenti dal server per esempi di codice e documentazione dettagliata. |
| MessagingTopicResponse | Interfaccia che rappresenta la risposta del server dal metodo legacy Messaging.sendToTopic() . Vedere Invia a un argomento per esempi di codice e documentazione dettagliata. |
| Messaggio multicast | Payload per il metodo Messaging.sendMulticast() . Il payload contiene tutti i campi nel tipo BaseMessage e un elenco di token. |
| Notifica | Una notifica che può essere inclusa in Message . |
| NotificationMessagePayload | Interfaccia che rappresenta un payload del messaggio di notifica dell'API legacy FCM. I messaggi di notifica consentono agli sviluppatori di inviare fino a 4 KB di coppie chiave-valore predefinite. Le chiavi accettate sono descritte di seguito. Vedi Compilare richieste di invio per esempi di codice e documentazione dettagliata. |
| Invia risposta | Interfaccia che rappresenta lo stato di un singolo messaggio inviato come parte di una richiesta batch. |
| TokenMessage | |
| ArgomentoMessaggio | |
| WebpushConfig | Rappresenta le opzioni del protocollo WebPush che possono essere incluse in un messaggio . |
| WebpushFcmOpzioni | Rappresenta le opzioni per le funzionalità fornite da FCM SDK per Web (che non fanno parte dello standard Webpush). |
| WebpushNotification | Rappresenta le opzioni di notifica specifiche di WebPush che possono essere incluse in WebpushConfig . Ciò supporta la maggior parte delle opzioni standard definite nella specifica Web Notification . |
Digitare Alias
| Digita Alias | Descrizione |
|---|---|
| Messaggio | Payload per l'operazione Messaging.send() . Il payload contiene tutti i campi nel tipo BaseMessage ed esattamente uno tra token, argomento o condizione. |
getMessaging()
Ottiene il servizio di messaggistica per l'app predefinita o per una determinata app.
admin.messaging() può essere chiamato senza argomenti per accedere al servizio Messaging dell'app predefinita o come admin.messaging(app) per accedere al servizio Messaging associato a un'app specifica.
Firma:
export declare function getMessaging(app?: App): Messaging;
Parametri
| Parametro | Tipo | Descrizione |
|---|---|---|
| app | App | App opzionale di cui restituire il servizio Messaging . Se non fornito, verrà restituito il servizio Messaging predefinito. |
Ritorna:
Il servizio Messaging predefinito se non viene fornita alcuna app o il servizio Messaging associato all'app fornita.
Esempio 1
// Get the Messaging service for the default app
const defaultMessaging = getMessaging();
Esempio 2
// Get the Messaging service for a given app
const otherMessaging = getMessaging(otherApp);
Messaggio
Payload per l'operazione Messaging.send() . Il payload contiene tutti i campi del tipo BaseMessage ed esattamente uno tra token, argomento o condizione.
Firma:
export type Message = TokenMessage | TopicMessage | ConditionMessage;