Inicio

Instalar

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

Importar

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

API Resumen

checkPermissions

Verificar permiso para recibir notificaciones push.

Activado AndroidEn este caso, se debe llamar solo en Android 13+.

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

await FirebaseMessaging.checkPermissions();

requestPermissions

Solicitar permiso para recibir notificaciones push.

On AndroidEsta función solo necesita ser llamada en Android 13+.

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

await FirebaseMessaging.requestPermissions();

isSupported

Verifica si existen todas las API necesarias.

Siempre devuelve true en Android e iOS.

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

await FirebaseMessaging.isSupported();

getToken

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

Este método también reactiva la inicialización automática de FCM.

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

await FirebaseMessaging.getToken();

deleteToken

Elimine el token de FCM y desregístrele la aplicación para detener la recepción de notificaciones push. Puede llamarse, por ejemplo, cuando un usuario se desloguea.

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

await FirebaseMessaging.deleteToken();

getDeliveredNotifications

Obtenga 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';

await FirebaseMessaging.getDeliveredNotifications();

removeDeliveredNotifications

Elimine notificaciones específicas de la pantalla de notificaciones.

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

await FirebaseMessaging.removeDeliveredNotifications({} as RemoveDeliveredNotificationsOptions);

removeAllDeliveredNotifications

Eliminar 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

Suscribirse a un tema en segundo plano.

Solo disponible para Android e iOS.

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

await FirebaseMessaging.subscribeToTopic({} as SubscribeToTopicOptions);

unsubscribeFromTopic

Desuscribirse de un tema en segundo plano.

Solo disponible para Android e iOS.

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

await FirebaseMessaging.unsubscribeFromTopic({} as UnsubscribeFromTopicOptions);

createChannel

Crear un canal de notificaciones.

Sólo disponible para Android (SDK 26+).

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

await FirebaseMessaging.createChannel({} as CreateChannelOptions);

deleteChannel

Borrar un canal de notificaciones.

Sólo disponible para Android (SDK 26+).

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

await FirebaseMessaging.deleteChannel({} as DeleteChannelOptions);

listChannels

Mostrar los canales de notificaciones disponibles.

Sólo disponible para Android (SDK 26+).

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

await FirebaseMessaging.listChannels();

Referencia de tipos

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

Llamada de retorno para recibir 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.tsRe-ruta la sincronización cuando los cambios públicos API cambian en la fuente.

Sigue adelante desde Getting Started

Si estás utilizando Getting Started para planificar la consola y API operaciones, conecta con Resumen API para el detalle de implementación en Resumen API Introducción para el detalle de implementación en Introducción API Claves para el detalle de implementación en API Claves Dispositivos para el detalle de implementación en Dispositivos, y Paquetes para el detalle de implementación en Paquetes.