@firebase/messaging

Funciones

Función Descripción
function(app, ...)
getMessaging(app) Recupera una instancia de Firebase Cloud Messaging.
function(messaging, ...)
deleteToken(mensaje) Borra el token de registro asociado con esta instancia Messaging y anula la suscripción de la instancia Messaging de la suscripción de envío.
getToken(mensajería, opciones) Suscribe la instancia de Messaging a las notificaciones push. 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 otorgó el permiso de notificaciones, este método pide permiso al usuario. La promesa que se muestra se rechaza si el usuario no permite que la app muestre notificaciones.
onMessage(mensaje, nextOrObserver) Cuando se recibe un mensaje push y el usuario se encuentra en una página de tu origen, el mensaje se pasa a la página y se despacha un evento onMessage() con la carga útil del mensaje push.
function()
isSupported() Comprueba si todas las APIs obligatorias existen en el navegador.

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 getMessagingInWindow(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, ...)

deleteToken(mensaje)

Borra el token de registro asociado con esta instancia Messaging y anula la suscripción de la instancia Messaging de la suscripción de envío.

Firma:

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

Parámetros

Parámetro Tipo Descripción
mensajería Mensajes La instancia Messaging.

Muestra:

Promise&lt;boolean&gt;

La promesa se resuelve cuando se borra correctamente el token.

getToken(mensaje, opciones)

Suscribe la instancia de Messaging a las notificaciones push. 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 otorgó el permiso de notificaciones, este método solicita el permiso al usuario. La promesa que se muestra se rechaza si el usuario no permite que la app muestre notificaciones.

Firma:

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

Parámetros

Parámetro Tipo Descripción
mensajería Mensajes La instancia Messaging.
opciones GetTokenOptions Proporciona una clave vapid opcional y un registro opcional de service worker.

Muestra:

Promesa<string>

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

onMessage(mensaje, nextOrObserver)

Cuando se recibe un mensaje push y el usuario se encuentra en una página de tu origen, el mensaje se pasa a la página y se despacha 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 Mensajes La instancia Messaging.
nextOrObserver NextFn<MessagePayload> | Observador<MessagePayload> Cuando se recibe un mensaje y el usuario está viendo tu página en ese momento, se llama a esta función, o al objeto de observador con next definido.

Muestra:

Anular la suscripción

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

función()

isSupported()

Comprueba si todas las APIs obligatorias existen en el navegador.

Firma:

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

Muestra:

Promise&lt;boolean&gt;

una promesa que se resuelve como un valor booleano.