Getting Started

Instalar

Puede utilizar nuestra configuración asistida por IA para instalar el plugin. Agregue las Capgo habilidades a su herramienta de IA mediante el siguiente comando:

npx skills add https://github.com/Cap-go/capgo-skills --skill capacitor-plugins

Entonces utilice la siguiente solicitud:

Use the `capacitor-plugins` skill from `Cap-go/capgo-skills` to install the `@capgo/capacitor-firebase-messaging` plugin in my project.

Si prefiere la configuración manual, instale el complemento ejecutando los siguientes comandos y siguiendo las instrucciones específicas de la plataforma a continuación:

bun add @capgo/capacitor-firebase-messaging
npx cap sync

Importar

import { FirebaseMessaging } from '@capgo/capacitor-firebase-messaging';

Comienzo rápido

import { FirebaseMessaging } from '@capgo/capacitor-firebase-messaging';

const result = await FirebaseMessaging.checkPermissions();
console.log(result);

Ejemplo: solicitar permisos

import { FirebaseMessaging } from '@capgo/capacitor-firebase-messaging';

const result = await FirebaseMessaging.requestPermissions();
console.log(result);

Ejemplo: comprobar compatibilidad

import { FirebaseMessaging } from '@capgo/capacitor-firebase-messaging';

const result = await FirebaseMessaging.isSupported();
console.log(result);

Trampas comunes

• Permisos: llamar checkPermissions() luego requestPermissions() cuando sea necesario.
• Escuchadores: eliminar manejadores cuando las pantallas se desmonten.
• Fuente de verdad: confiar src/definitions.ts en el repositorio GitHub.

API Resumen

checkPermissions

Verifique permiso para recibir notificaciones push.

En Androide, este método solo necesita llamarse en Android 13+.

import { FirebaseMessaging } from '@capgo/capacitor-firebase-messaging';

const result = await FirebaseMessaging.checkPermissions();
console.log(result);

requestPermissions

Sección titulada “requestPermissions”

En Androide, este método solo necesita llamarse en Android 13+.

import { FirebaseMessaging } from '@capgo/capacitor-firebase-messaging';

const result = await FirebaseMessaging.requestPermissions();
console.log(result);

isSupported

Verifica si existen todas las API necesarias.

Siempre devuelve true en Android e iOS.

import { FirebaseMessaging } from '@capgo/capacitor-firebase-messaging';

const result = await FirebaseMessaging.isSupported();
console.log(result);

getToken

Registra la aplicación para recibir notificaciones push. Devuelve un token FCM que se puede utilizar para enviar mensajes push a esa instancia de Mensajería.

También habilita la inicialización automática de FCM.

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 FCM y desregistra la aplicación para detener las notificaciones push. Puede llamarse, por ejemplo, cuando un usuario se desloguea.

import { FirebaseMessaging } from '@capgo/capacitor-firebase-messaging';

await FirebaseMessaging.deleteToken();

getDeliveredNotifications

Obtén una lista de notificaciones que están visibles en la pantalla de notificaciones.

Nota: Esto devolverá todas las notificaciones entregadas, incluidas las notificaciones locales, y no solo las notificaciones FCM.

En Android, el campo de datos de la notificación FCM NO se incluirá.

import { FirebaseMessaging } from '@capgo/capacitor-firebase-messaging';

const result = await FirebaseMessaging.getDeliveredNotifications();
console.log(result);

removeDeliveredNotifications

Elimina notificaciones específicas de la pantalla de notificaciones.

import { FirebaseMessaging } from '@capgo/capacitor-firebase-messaging';

await FirebaseMessaging.removeDeliveredNotifications({ notifications: [] });

removeAllDeliveredNotifications

Elimina todas las notificaciones de la pantalla de notificaciones.

Nota: Esto eliminará todas las notificaciones entregadas, incluidas las notificaciones locales, y no solo las notificaciones FCM.

import { FirebaseMessaging } from '@capgo/capacitor-firebase-messaging';

await FirebaseMessaging.removeAllDeliveredNotifications();

subscribeToTopic

Se suscribe a un tema en segundo plano.

Sólo disponible para Android e iOS.

import { FirebaseMessaging } from '@capgo/capacitor-firebase-messaging';

await FirebaseMessaging.subscribeToTopic({ topic: 'topic' });

unsubscribeFromTopic

Desuscribe de un tema en segundo plano.

Sólo disponible para Android e iOS.

import { FirebaseMessaging } from '@capgo/capacitor-firebase-messaging';

await FirebaseMessaging.unsubscribeFromTopic({ topic: 'topic' });

createChannel

Crear un canal de notificación.

Only available for Android (SDK 26+).

import { FirebaseMessaging } from '@capgo/capacitor-firebase-messaging';

await FirebaseMessaging.createChannel({
  id: 'id-123',
  name: 'example',
});

deleteChannel

Eliminar un canal de notificaciones

Solo disponible para Android (SDK 26+)

import { FirebaseMessaging } from '@capgo/capacitor-firebase-messaging';

await FirebaseMessaging.deleteChannel({ id: 'id-123' });

listChannels

Listar los canales de notificaciones disponibles

Solo disponible para Android (SDK 26+)

import { FirebaseMessaging } from '@capgo/capacitor-firebase-messaging';

const result = await FirebaseMessaging.listChannels();
console.log(result);

Tipo de referencia

PermissionStatus

export interface PermissionStatus {
  /**
   * @since 0.2.2
   */
  receive: PermissionState;
}

IsSupportedResult

export interface IsSupportedResult {
  /**
   * @since 0.3.1
   */
  isSupported: boolean;
}

GetTokenOptions

export interface GetTokenOptions {
  /**
   * Your VAPID public key, which is required to retrieve the current registration token on the web.
   *
   * Only available for Web.
   */
  vapidKey?: string;
  /**
   * The service worker registration for receiving push messaging.
   * If the registration is not provided explicitly, you need to have a `firebase-messaging-sw.js` at your root location.
   *
   * Only available for Web.
   */
  serviceWorkerRegistration?: ServiceWorkerRegistration;
}

GetTokenResult

export interface GetTokenResult {
  /**
   * @since 0.2.2
   */
  token: string;
}

GetDeliveredNotificationsResult

export interface GetDeliveredNotificationsResult {
  /**
   * @since 0.2.2
   */
  notifications: Notification[];
}

RemoveDeliveredNotificationsOptions

export interface RemoveDeliveredNotificationsOptions {
  /**
   * @since 0.4.0
   */
  notifications: Notification[];
}

SubscribeToTopicOptions

export interface SubscribeToTopicOptions {
  /**
   * The name of the topic to subscribe.
   *
   * @since 0.2.2
   */
  topic: string;
}

UnsubscribeFromTopicOptions

export interface UnsubscribeFromTopicOptions {
  /**
   * The name of the topic to unsubscribe from.
   *
   * @since 0.2.2
   */
  topic: string;
}

CreateChannelOptions

export type CreateChannelOptions = Channel;

DeleteChannelOptions

export interface DeleteChannelOptions {
  /**
   * The channel identifier.
   *
   * @since 1.4.0
   */
  id: string;
}

ListChannelsResult

export interface ListChannelsResult {
  channels: Channel[];
}

TokenReceivedListener

Escuchar el evento de token recibido

export type TokenReceivedListener = (event: TokenReceivedEvent) => void;

Fuente de Verdad

Esta página se genera a partir del plugin’s src/definitions.ts. Vuelva a sincronizar cuando los cambios públicos API cambien en la fuente.

Sigue adelante desde Getting Started

Si estás utilizando Getting Started para planificar la consola y API operaciones, conecta con API Overview para los detalles de implementación en API Overview, Introducción para los detalles de implementación en Introducción API Claves para los detalles de implementación en API Claves Dispositivos para los detalles de implementación en dispositivos. Bundles para los detalles de implementación en Dispositivos, y