Aller au contenu principal
@capgo/capacitor-notifications API de l'appareil Open source

Notifications Plugin Capacitor

Envoyez des notifications push natives iOS et Android depuis Capgo, avec lookup utilisateur, badges, stats et vérifications silencieuses de mises à jour

Installer

bun add @capgo/capacitor-notifications bunx cap sync
npm, pnpm ou yarn
  • npm install @capgo/capacitor-notifications
  • pnpm add @capgo/capacitor-notifications
  • yarn add @capgo/capacitor-notifications

Guide

Comment utiliser les notifications dans Capacitor

Utiliser @capgo/capacitor-notifications

Envoyez des notifications push natives iOS et Android depuis Capgo avec recherche d'utilisateurs, badges, suivi foreground/open, callbacks en arrière-plan et vérifications silencieuses de Capgo live-update.

Le plugin est conçu pour le pipeline de notifications Capgo. Capgo stocke les métadonnées des identifiants de plateforme et les données de contrôle de campagne dans Postgres, tandis que l'état des appareils actifs et les événements de livraison sont écrits dans le moteur Cloudflare Analytics.

Installer

Utilisez Capgo CLI pour une configuration guidée :

npx @capgo/cli@latest notifications setup com.example.app

Installation manuelle :

npm install @capgo/capacitor-notifications @capgo/capacitor-updater
npx cap sync

Configurer

import { CapgoNotifications } from '@capgo/capacitor-notifications'

await CapgoNotifications.configure({
  appId: 'com.example.app',
  autoUpdater: true,
  updateInstallMode: 'next',
})

Enregistrer un utilisateur authentifié

Générer identityProof depuis votre backend avec POST /notifications/recipients/proof, puis enregistrez l'appareil une fois votre propre connexion réussie.

await CapgoNotifications.register({
  externalId: 'customer-user-123',
  identityProof,
  tags: ['paid'],
  attributes: { plan: 'team' },
  consent: true,
})

Écouter les événements

await CapgoNotifications.addListener('notificationReceived', (notification) => {
  console.log('Received', notification)
})

await CapgoNotifications.addListener('notificationOpened', (event) => {
  console.log('Opened', event.notification.id)
})

await CapgoNotifications.addListener('backgroundNotification', async (event) => {
  try {
    console.log('Background payload', event.notification.data)
  } finally {
    await event.finish()
  }
})

Configuration iOS

Activer Notifications push et Modes en arrière-plan > Notifications distantes dans Xcode.

Transférez les notifications distantes depuis ios/App/App/AppDelegate.swift:

func application(_ application: UIApplication, didReceiveRemoteNotification userInfo: [AnyHashable: Any], fetchCompletionHandler completionHandler: @escaping (UIBackgroundFetchResult) -> Void) {
    NotificationCenter.default.post(name: Notification.Name("CapgoNotificationsRemoteNotification"), object: userInfo)
    completionHandler(.newData)
}

Configuration Android

Exécutez npx cap sync android, configurez les identifiants de la plateforme Android dans Capgo, demandez l'autorisation de notification sur Android 13+ et testez sur un appareil ou un émulateur avec les services Google Play.

Checklist de débogage

  • Exécutez npx @capgo/cli@latest notifications setup com.example.app depuis le dossier qui contient capacitor.config.*.
  • Recherchez le destinataire dans Capgo par l'ID client externe.
  • Confirmez que l'appareil possède la plateforme android ou ios et la permission est accordée.
  • Ajouter des listeners temporaires pour registrationChanged, notificationReceived, notificationOpened, et backgroundNotification.
  • Envoyez une notification de test depuis le dashboard.
  • Consultez les statistiques des événements mis en attente, envoyés, reçus et ouverts.
  • Pour les vérifications de mise à jour silencieuses, vérifiez @capgo/capacitor-updater est installé et que autoUpdater est activé.

Référence complète

Continuer avec l'utilisation de @capgo/capacitor-notifications

Si vous utilisez Utiliser @capgo/capacitor-notifications pour planifier les notifications push natives, connectez-l’à @capgo/capacitor-notifications pour les détails d'implémentation, Débogage pour le dépannage, @capgo/capacitor-updater pour les vérifications silencieuses de mise à jour, et Capgo Répertoire des plugins pour les autres plugins natifs.

FAQ

FAQ sur le plugin Notifications

Comment installer le plugin Notifications dans une application Capacitor ?

Exécutez "bun add @capgo/capacitor-notifications" (ou "npm install @capgo/capacitor-notifications"), puis lancez "bunx cap sync" pour que les projets iOS et Android prennent en compte le code natif. Importez-le depuis "@capgo/capacitor-notifications" dans le code de votre application.

Est-ce que @capgo/capacitor-notifications fonctionne avec React, Vue et Angular ?

Oui. Notifications est un package Capacitor, il fonctionne donc avec n'importe quel framework web qui tourne dans Capacitor, y compris Ionic, React, Vue, Angular, Svelte et le JavaScript pur.

Quelle version de Capacitor est supportée par @capgo/capacitor-notifications ?

Les plugins Capgo suivent la version majeure de Capacitor : utilisez la version majeure du plugin qui correspond à la version majeure de votre Capacitor (par exemple le plugin v8 avec Capacitor 8). Le tableau de compatibilité du README de GitHub recense les versions maintenues.

Est-ce que @capgo/capacitor-notifications est gratuit et open source ?

Oui. Le code source code est public sur GitHub à l'adresse https://github.com/Cap-go/capgo/tree/main/packages/capacitor-notifications/ et le package s'installe gratuitement depuis npm. Les rapports de bugs et les pull requests sont les bienvenus.

Puis-je mettre à jour code utilisant les Notifications sans passer par une revue de l'App Store ?

L'installation ou la mise à jour du plugin modifie le code natif, ce qui impose un nouveau build pour les stores. Ensuite, les changements JavaScript, HTML et CSS qui appellent le plugin peuvent être livrés instantanément via les live updates de Capgo.

Déployez les changements de Notifications sans attendre la validation de l'app

Une fois le plugin intégré à votre build de store, Capgo live updates déploie vos changements JavaScript, HTML et CSS aux utilisateurs en quelques minutes.

Commencez avec Capgo