Saltar al contenido principal
@capgo/capacitor-firebase-messaging Comunicación Código abierto

Firebase Messaging plugin Capacitor

Plugin Capacitor para Firebase Cloud Messaging (FCM)

Instalar

bun add @capgo/capacitor-firebase-messaging bunx cap sync
npm, pnpm o yarn
  • npm install @capgo/capacitor-firebase-messaging
  • pnpm add @capgo/capacitor-firebase-messaging
  • yarn add @capgo/capacitor-firebase-messaging

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.

FAQ

FAQ del plugin Firebase Messaging

¿Cómo instalo el plugin de Firebase Messaging en una app de Capacitor?

Ejecuta "bun add @capgo/capacitor-firebase-messaging" (o "npm install @capgo/capacitor-firebase-messaging"), luego ejecuta "bunx cap sync" para que los proyectos de iOS y Android tomen el code nativo. Impórtalo desde "@capgo/capacitor-firebase-messaging" en el code de tu app.

¿Funciona @capgo/capacitor-firebase-messaging con React, Vue y Angular?

Sí. Firebase Messaging es un paquete Capacitor, así que funciona con cualquier framework web que se ejecute dentro de Capacitor, incluidos Ionic, React, Vue, Angular, Svelte y JavaScript puro.

¿Qué versión de Capacitor soporta @capgo/capacitor-firebase-messaging?

Los plugins de Capgo siguen la versión mayor de Capacitor: usa la versión mayor del plugin que coincida con la versión mayor de tu Capacitor (por ejemplo, el plugin v8 con Capacitor 8). La tabla de compatibilidad del README de GitHub lista las versiones mantenidas.

¿Es @capgo/capacitor-firebase-messaging gratuito y open source?

Sí. El código fuente de code es público en GitHub en https://github.com/Cap-go/capacitor-firebase/tree/main/packages/messaging y el paquete se instala gratis desde npm. Los reportes de bugs y los pull requests son bienvenidos.

¿Puedo actualizar code que usa Firebase Messaging sin pasar por la revisión de la App Store?

Instalar o actualizar el plugin cambia el code nativo, así que requiere un nuevo build para la tienda. Después, los cambios de JavaScript, HTML y CSS que llamen al plugin se pueden publicar al instante con las live updates de Capgo.

Lanza cambios de Firebase Messaging sin esperar la revisión de la app

Una vez que el plugin esté en tu store build, Capgo live updates envía tus cambios de JavaScript, HTML y CSS a los usuarios en minutos.

Empieza con Capgo