@firebase/messaging

Funciones

Función Descripción
función (aplicación, ...)
obtener mensajería (aplicación) Recupera una instancia de Firebase Cloud Messaging.
función (mensajería, ...)
eliminarToken(mensajería) Elimina el token de registro asociado con esta instancia de mensajería y cancela la suscripción de la instancia de mensajería a la suscripción push.
getToken(mensajería, opciones) Suscribe la instancia de mensajería para enviar notificaciones. Devuelve un token de registro de Firebase Cloud Messaging que se puede usar para enviar mensajes push a esa instancia de Messaging . Si aún no se ha concedido el permiso de notificación, este método solicita permiso al usuario. La promesa devuelta se rechaza si el usuario no permite que la aplicación muestre notificaciones.
onMessage(mensajería, nextOrObserver) Cuando se recibe un mensaje push y el usuario se encuentra actualmente en una página de su origen, el mensaje se pasa a la página y se envía un evento onMessage() con la carga útil del mensaje push.
función()
esta apoyado() Comprueba si todas las API requeridas existen en el navegador.

Interfaces

Interfaz Descripción
Opciones de Fcm Opciones para las funciones proporcionadas por FCM SDK para Web. Ver Opciones de WebpushFcm .
Obtener opciones de token Opciones para getToken() .
Carga útil del mensaje Carga útil del mensaje que contiene la carga útil de notificación que se representa con NotificationPayload y la carga útil 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.
Carga útil de notificación Mostrar detalles de notificación. Los detalles se envían a través de la API de envío. .

función (aplicación, ...)

obtener mensajería (aplicación)

Recupera una instancia de Firebase Cloud Messaging.

Firma:

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

Parámetros

Parámetro Tipo Descripción
aplicación Aplicación Firebase

Devoluciones:

Mensajería

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

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

eliminarToken(mensajería)

Elimina el token de registro asociado con esta instancia de mensajería y cancela la suscripción de la instancia de mensajería a la suscripción push.

Firma:

export declare function deleteToken(messaging: Messaging): Promise<boolean>;

Parámetros

Parámetro Tipo Descripción
mensajería Mensajería La instancia de mensajería .

Devoluciones:

Promesa<booleana>

La promesa se resuelve cuando el token se elimina correctamente.

getToken(mensajería, opciones)

Suscribe la instancia de mensajería para enviar notificaciones. Devuelve un token de registro de Firebase Cloud Messaging que se puede usar para enviar mensajes push a esa instancia de Messaging .

Si aún no se ha concedido el permiso de notificación, este método solicita permiso al usuario. La promesa devuelta se rechaza si el usuario no permite que la aplicación muestre notificaciones.

Firma:

export declare function getToken(messaging: Messaging, options?: GetTokenOptions): Promise<string>;

Parámetros

Parámetro Tipo Descripción
mensajería Mensajería La instancia de mensajería .
opciones Obtener opciones de token Proporciona una clave insípida opcional y un registro de trabajador de servicio opcional.

Devoluciones:

Promesa<cadena>

La promesa se resuelve con un token de registro de FCM.

onMessage(mensajería, nextOrObserver)

Cuando se recibe un mensaje push y el usuario se encuentra actualmente en una página de su origen, el mensaje se pasa a la página y se envía un evento onMessage() con la carga útil del mensaje push.

Firma:

export declare function onMessage(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 el usuario está viendo su página actualmente.

Devoluciones:

Darse de baja

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

función()

esta apoyado()

Comprueba si todas las API requeridas existen en el navegador.

Firma:

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

Devoluciones:

Promesa<booleana>

una Promesa que se resuelve en un booleano.