Guía
Cómo usar Firebase Messaging en Capacitor
Uso de @capgo/capacitor-firebase-messaging
Plugin de Capacitor para Firebase Cloud Messaging (FCM).
Instalar
bun add @capgo/capacitor-firebase-messaging
bunx cap sync
bunx cap sync copia el code nativo del plugin en tus proyectos nativos. Ejecútalo de nuevo tras cada actualización del plugin.
Importar
import { FirebaseMessaging } from '@capgo/capacitor-firebase-messaging';
API de un vistazo
| Método | Descripción |
|---|---|
checkPermissions |
Comprueba el permiso para recibir notificaciones push. |
requestPermissions |
Solicita permiso para recibir notificaciones push. |
isSupported |
Verifica si todas las APIs requeridas existen. |
getToken |
Registra la app para recibir notificaciones push. Devuelve un token de FCM que puede usarse para enviar mensajes push a esa instancia de Messaging. |
deleteToken |
Elimina el token de FCM y desregistra la app para dejar de recibir notificaciones push. Puede llamarse, por ejemplo, cuando un usuario cierra sesión. |
getDeliveredNotifications |
Obtén una lista de las notificaciones visibles en la pantalla de notificaciones. |
removeDeliveredNotifications |
Elimina notificaciones específicas de la pantalla de notificaciones. |
removeAllDeliveredNotifications |
Elimina todas las notificaciones de la pantalla de notificaciones. |
subscribeToTopic |
Se suscribe a un topic en segundo plano. |
unsubscribeFromTopic |
Se desuscribe de un topic en segundo plano. |
createChannel |
Crea un canal de notificaciones. |
deleteChannel |
Elimina un canal de notificaciones. |
listChannels |
Lista los canales de notificación disponibles. |
Ejemplos
checkPermissions()
Comprueba el permiso para recibir notificaciones push.
import { FirebaseMessaging } from '@capgo/capacitor-firebase-messaging';
const result = await FirebaseMessaging.checkPermissions();
console.log(result);
requestPermissions()
Solicita permiso para recibir notificaciones push.
import { FirebaseMessaging } from '@capgo/capacitor-firebase-messaging';
const result = await FirebaseMessaging.requestPermissions();
console.log(result);
isSupported()
Verifica si todas las APIs requeridas existen.
import { FirebaseMessaging } from '@capgo/capacitor-firebase-messaging';
const result = await FirebaseMessaging.isSupported();
console.log(result);
getToken()
Registra la app para recibir notificaciones push. Devuelve un token de FCM que puede usarse para enviar mensajes push a esa instancia de Messaging.
import { FirebaseMessaging } from '@capgo/capacitor-firebase-messaging';
const result = await FirebaseMessaging.getToken();
// The result holds sensitive values: use it without logging it.
deleteToken()
Elimina el token de FCM y desregistra la app para dejar de recibir notificaciones push. Puede llamarse, por ejemplo, cuando un usuario cierra sesión.
import { FirebaseMessaging } from '@capgo/capacitor-firebase-messaging';
await FirebaseMessaging.deleteToken();
getDeliveredNotifications()
Obtén una lista de las notificaciones visibles en la pantalla de notificaciones.
import { FirebaseMessaging } from '@capgo/capacitor-firebase-messaging';
const result = await FirebaseMessaging.getDeliveredNotifications();
console.log(result);
La tabla anterior enumera los 13 métodos principales. Los helpers de versión y listener, así como el contrato completo de cada método, están documentados en la repositorio GitHub.
Escuchar eventos
addListener devuelve un handle. Llama handle.remove() cuando la pantalla se desmonte, o FirebaseMessaging.removeAllListeners() para limpiar todos los listeners.
Referencia completa
Continúa desde Uso de @capgo/capacitor-firebase-messaging
Si estás usando Uso de @capgo/capacitor-firebase-messaging para planificar el trabajo con plugins nativos, conéctalo con Directorio de plugins de Capgo para el flujo de trabajo del producto en Capgo Plugin Directory, Plugins de Capacitor por Capgo para el detalle de implementación en los Plugins de Capacitor por Capgo, Añadir o actualizar plugins para el detalle de implementación en Agregar o actualizar plugins, Alternativas a plugins de Ionic Enterprise para el flujo de trabajo en Alternativas a plugins de Ionic Enterprise, y Native Builds de Capgo para el flujo de trabajo del producto en Capgo Native Builds.