Prise en main

Installer

Vous pouvez utiliser notre configuration assistée par IA pour installer le plugin. Ajoutez les skills Capgo à votre outil d'IA avec la commande suivante :

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

Utilisez ensuite le prompt suivant :

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

Si vous préférez une installation manuelle, installez le plugin en exécutant les commandes suivantes et suivez les instructions spécifiques à chaque plateforme ci-dessous :

bun add @capgo/capacitor-rich-notifications
bunx cap sync

Importer

import { RichNotifications } from '@capgo/capacitor-rich-notifications';

Démarrage rapide

import { RichNotifications } from '@capgo/capacitor-rich-notifications';

const { status } = await RichNotifications.requestPermission();
if (status !== 'granted') return;

Exemple : createChannel

import { RichNotifications } from '@capgo/capacitor-rich-notifications';

await RichNotifications.createChannel({
  id: 'alerts',
  name: 'Alerts',
  importance: 'high',
});

Exemple : display

import { RichNotifications } from '@capgo/capacitor-rich-notifications';

const { id } = await RichNotifications.display({
  title: 'Hello',
  body: 'Tap to open',
  channelId: 'alerts',
});

Erreurs courantes

• Écouteurs: supprimez les handles lors du démontage des écrans.
• Sync native : exécuter bunx cap sync après les mises à jour du plugin.
• Source de vérité : fiez-vous src/definitions.ts au repo GitHub.

Configuration de la plateforme

• Configuration iOS pour les catégories et les niveaux d'interruption.
• Configuration Android pour POST_NOTIFICATIONS, canaux et permissions exactes d’alarme ou de service en premier plan (facultatives).

Utilisation

import { RichNotifications } from '@capgo/capacitor-rich-notifications';

await RichNotifications.requestPermission();

await RichNotifications.createChannel({
  id: 'messages',
  name: 'Messages',
  importance: 'high',
});

await RichNotifications.display({
  title: 'Hello',
  body: 'Tap to open the app',
  channelId: 'messages',
});

await RichNotifications.addListener('press', (event) => {
  console.log(event.id, event.actionId, event.input);
});