@firebase/messaging/sw

Funzioni

Funzione Descrizione
funzione(app, ...)
getMessaging(app) Recupera un'istanza Firebase Cloud Messaging.
funzione (messaggistica, ...)
sperimentaleSetDeliveryMetricsExportedToBigQueryEnabled(messaggistica, abilita) Abilita o disabilita l'esportazione delle metriche di consegna dei messaggi Firebase Cloud Messaging in BigQuery. Per impostazione predefinita, le metriche di recapito dei messaggi non vengono esportate in BigQuery. Utilizzare questo metodo per abilitare o disabilitare l'esportazione in fase di runtime.
onBackgroundMessage(messaggistica, nextOrObserver) Chiamato quando viene ricevuto un messaggio mentre l'app è in background. Un'app viene considerata in background se non viene visualizzata alcuna finestra attiva.
funzione()
è supportato() Controlla se tutte le API richieste esistono nel contesto SW

Interfacce

Interfaccia Descrizione
Opzioni Fcm Opzioni per le funzionalità fornite da FCM SDK per il Web. Vedere Opzioni WebpushFcm .
OttieniOpzioniToken Opzioni per getToken() .
MessaggioPayload Payload del messaggio che contiene il payload della notifica rappresentato con NotificationPayload e il payload dei dati che contiene un numero arbitrario di coppie chiave-valore inviate dagli sviluppatori tramite l' API di invio .
Messaggistica Interfaccia pubblica dell'SDK Firebase Cloud Messaging.
NotificaPayload Visualizza i dettagli della notifica. I dettagli vengono inviati tramite l' API di invio .

funzione(app, ...)

getMessaging(app)

Recupera un'istanza Firebase Cloud Messaging.

Firma:

export declare function getMessagingInSw(app?: FirebaseApp): Messaging;

Parametri

Parametro Tipo Descrizione
app FirebaseApp

Ritorna:

Messaggistica

L'istanza Firebase Cloud Messaging associata all'app Firebase fornita.

funzione (messaggistica, ...)

sperimentaleSetDeliveryMetricsExportedToBigQueryEnabled(messaggistica, abilita)

Abilita o disabilita l'esportazione delle metriche di consegna dei messaggi Firebase Cloud Messaging in BigQuery. Per impostazione predefinita, le metriche di recapito dei messaggi non vengono esportate in BigQuery. Utilizzare questo metodo per abilitare o disabilitare l'esportazione in fase di runtime.

Firma:

export declare function experimentalSetDeliveryMetricsExportedToBigQueryEnabled(messaging: Messaging, enable: boolean): void;

Parametri

Parametro Tipo Descrizione
messaggistica Messaggistica L'istanza FirebaseMessaging .
abilitare booleano Indica se Firebase Cloud Messaging deve esportare le metriche di recapito dei messaggi in BigQuery.

Ritorna:

vuoto

onBackgroundMessage(messaggistica, nextOrObserver)

Chiamato quando viene ricevuto un messaggio mentre l'app è in background. Un'app viene considerata in background se non viene visualizzata alcuna finestra attiva.

Firma:

export declare function onBackgroundMessage(messaging: Messaging, nextOrObserver: NextFn<MessagePayload> | Observer<MessagePayload>): Unsubscribe;

Parametri

Parametro Tipo Descrizione
messaggistica Messaggistica L'istanza di messaggistica .
nextOrObserver SuccessivoFn < MessaggioPayload > | Osservatore < MessaggioPayload > Questa funzione, o oggetto osservatore con la definizione next , viene chiamata quando viene ricevuto un messaggio e l'app è attualmente in background.

Ritorna:

Annulla l'iscrizione

Per interrompere l'ascolto dei messaggi, eseguire questa funzione restituita

funzione()

è supportato()

Controlla se tutte le API richieste esistono nel contesto SW

Firma:

export declare function isSwSupported(): Promise<boolean>;

Ritorna:

Promesso<booleano>

una Promessa che si risolve in un valore booleano.