@firebase/messaging/sw

Funciones

Función	Descripción
function(app, ...)
getMessaging(app)	Recupera una instancia de Firebase Cloud Messaging.
function(messaging, ...)
experimentalSetDeliveryMetricsExportedToBigQueryEnabled(mensajería, habilitar)	Habilita o inhabilita la exportación de métricas de entrega de mensajes de Firebase Cloud Messaging a BigQuery. Según la configuración predeterminada, las métricas de entrega de mensajes no se exportan a BigQuery. Usa este método para habilitar o inhabilitar la exportación en el entorno de ejecución.
onBackgroundMessage(mensaje, nextOrObserver)	Se llama cuando se recibe un mensaje mientras la app se ejecuta en segundo plano. Se considera que una app está en segundo plano si no se muestra ninguna ventana activa.
function()
isSupported()	Verifica si todas las APIs necesarias existen en el contexto de SW

Interfaces

Interfaz	Descripción
FcmOptions	Opciones para las funciones que proporciona el SDK de FCM para la Web. Consulta WebpushFcmOptions.
GetTokenOptions	Opciones para getToken().
MessagePayload.	Carga útil del mensaje que contiene la carga útil de notificación representada con NotificationPayload y la carga útil de datos que contiene una cantidad arbitraria de pares clave-valor enviados por los desarrolladores a través de la API de Send.
Mensajes	Interfaz pública del SDK de Firebase Cloud Messaging.
NotificationPayload.	Muestra los detalles de las notificaciones. Los detalles se envían a través de la API de Send.

función(app, ...)

getMessaging(app)

Recupera una instancia de Firebase Cloud Messaging.

Firma:

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

Parámetros

Parámetro	Tipo	Descripción
app	App de Firebase

Muestra:

Mensajes

La instancia de Firebase Cloud Messaging asociada con la app de Firebase proporcionada.

función(mensajería, ...)

experimentalSetDeliveryMetricsExportedToBigQueryEnabled(mensaje, habilitar)

Habilita o inhabilita la exportación de métricas de entrega de mensajes de Firebase Cloud Messaging a BigQuery. Según la configuración predeterminada, las métricas de entrega de mensajes no se exportan a BigQuery. Usa este método para habilitar o inhabilitar la exportación en el entorno de ejecución.

Firma:

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

Parámetros

Parámetro	Tipo	Descripción
mensajería	Mensajes	La instancia FirebaseMessaging
habilitar	booleano	Indica si Firebase Cloud Messaging debe exportar métricas de entrega de mensajes a BigQuery.

Muestra:

void

onBackgroundMessage(mensajería, nextOrObserver)

Se llama cuando se recibe un mensaje mientras la app se ejecuta en segundo plano. Se considera que una app 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	Mensajes	La instancia Messaging.
nextOrObserver	NextFn<MessagePayload> | Observador<MessagePayload>	Se llama a esta función, o al objeto observador con next definido, cuando se recibe un mensaje y la app se encuentra en segundo plano.

Muestra:

Anular la suscripción

Para dejar de escuchar mensajes, ejecuta esta función que se muestra.

función()

isSupported()

Verifica si todas las APIs necesarias existen en el contexto de SW

Firma:

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

Muestra:

Promise<boolean>

una promesa que se resuelve como un valor booleano.