@firebase/messaging/sw

Funciones

Función Descripción
función (aplicación...)
getMessaging (aplicación) Recupera una instancia de Firebase Cloud Messaging.
función (mensajería...)
experimentalSetDeliveryMetricsExportedToBigQueryEnabled(mensajería, habilitar) Habilita o deshabilita la exportación de métricas de entrega de mensajes de Firebase Cloud Messaging a BigQuery. De forma predeterminada, las métricas de entrega de mensajes no se exportan a BigQuery. Utilice este método para habilitar o deshabilitar la exportación en tiempo de ejecución.
onBackgroundMessage(mensajería, nextOrObserver) Se llama cuando se recibe un mensaje mientras la aplicación está en segundo plano. Se considera que una aplicación está en segundo plano si no se muestra ninguna ventana activa.
función()
esta apoyado() Comprueba si todas las API requeridas existen dentro de SW Context

Interfaces

Interfaz Descripción
FcmOpciones Opciones para funciones proporcionadas por FCM SDK for Web. Ver WebpushFcmOptions .
GetTokenOptions Opciones para getToken() .
MensajePayload Carga de mensaje que contiene la carga de notificación que se representa con NotificationPayload y la carga de datos que contiene un número arbitrario de pares clave-valor enviados por los desarrolladores a través de la API de envío .
Mensajería Interfaz pública del SDK de Firebase Cloud Messaging.
NotificaciónPayload Muestra los detalles de la notificación. Los detalles se envían a través de la API de envío .

getMessaging()

Recupera una instancia de Firebase Cloud Messaging.

Firma:

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

Parámetros

Parámetro Tipo Descripción
aplicación FirebaseApp

Devoluciones:

Mensajería

La instancia de Firebase Cloud Messaging asociada con la aplicación firebase proporcionada.

experimentalSetDeliveryMetricsExportedToBigQueryEnabled()

Habilita o deshabilita la exportación de métricas de entrega de mensajes de Firebase Cloud Messaging a BigQuery. De forma predeterminada, las métricas de entrega de mensajes no se exportan a BigQuery. Utilice este método para habilitar o deshabilitar la exportación en tiempo de ejecución.

Firma:

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

Parámetros

Parámetro Tipo Descripción
mensajería Mensajería La instancia FirebaseMessaging .
permitir booleano Si Firebase Cloud Messaging debe exportar métricas de entrega de mensajes a BigQuery.

Devoluciones:

vacío

onBackgroundMessage()

Se llama cuando se recibe un mensaje mientras la aplicación está en segundo plano. Se considera que una aplicación está en segundo plano si no se muestra ninguna ventana activa.

Firma:

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

Parámetros

Parámetro Tipo Descripción
mensajería Mensajería La instancia de mensajería .
siguienteOrObserver SiguienteFn < Carga útil del mensaje > | Observador < Carga útil del mensaje > Esta función, u objeto observador con next definido, se llama cuando se recibe un mensaje y la aplicación está actualmente en segundo plano.

Devoluciones:

Darse de baja

Para dejar de escuchar mensajes, ejecute esta función devuelta

esta apoyado()

Comprueba si todas las API requeridas existen dentro de SW Context

Firma:

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

Devoluciones:

Promesa<booleano>

una promesa que se resuelve en un valor booleano.