Allez directement au contenu principal
@capgo/capacitor-notifications APIs de dispositifs Source d'ouverture

Notifications plugin Capacitor

Envoie des notifications push natives iOS et Android à partir de Capgo avec recherche d'utilisateur, badges, statistiques et vérifications de mise à jour silencieuse.

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

Utilisation de @capgo/capacitor-notifications

Envoyez des notifications push natives iOS et Android à partir de Capgo avec recherche d'utilisateur, badges, suivi en arrière-plan/ouverture, rappels en arrière-plan et vérifications de mise à jour silencieuses Capgo.

Le plugin est conçu pour le pipeline de notification Capgo. Capgo stocke les métadonnées de la plateforme et les données de contrôle de campagne dans Postgres, tandis que l'état actif des appareils et les événements de livraison sont écrits dans l'Cloudflare Engine d'analyse.

Installer

Utilisez le 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 signé

Mint identityProof à partir de votre backend avec POST /notifications/recipients/proofpuis enregistrez le dispositif après que votre connexion réussisse.

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 d'arrière-plan > Notifications à distance en Xcode.

Transmettre les notifications à distance 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

Démarrer npx cap sync androidconfigurez les informations de plateforme Android dans Capgo, demandez la permission de notification sur Android 13+ et testez sur un appareil ou un émulateur avec Google Play services.

Liste de vérification de débogage

  • Démarrer npx @capgo/cli@latest notifications setup com.example.app à partir du dossier qui contient capacitor.config.*.
  • Recherchez le destinataire dans Capgo par ID client externe.
  • Vérifiez que l'appareil a les informations de plateforme android or ios et la permission est accordée.
  • Ajoutez des écouteurs temporaires pour registrationChanged, notificationReceived, notificationOpened, et backgroundNotification.
  • Envoi d'une notification de test depuis l'interface de dashboard.
  • Vérifiez les statistiques pour les événements en attente, envoyés, reçus et ouverts.
  • Vérifiez les mises à jour silencieuses @capgo/capacitor-updater est installé et autoUpdater est activé.

Référence complète

Continuez à utiliser @capgo/capacitor-notifications

Si vous utilisez Utilisez @capgo/capacitor-notifications pour planifier le messagerie de poussée native, connectez-l’avec @capgo/capacitor-notifications pour les détails d'implémentation, Débogage pour le dépannage, @capgo/capacitor-mises-à-jour pour les vérifications de mise à jour silencieuses, et Répertoire de plugins Capgo pour les autres plugins natifs.

FAQ

FAQ du plugin de notifications

Comment installer le plugin de notifications dans une application Capacitor ?

Exécutez « bun add @capgo/capacitor-notifications » (ou « npm install @capgo/capacitor-notifications »), puis exécutez « bunx cap sync » afin que les projets iOS et Android prennent en compte les natives code. Importez-l’à partir de « @capgo/capacitor-notifications » dans votre application code.

Le plugin @capgo/capacitor-notifications fonctionne-t-il avec React, Vue et Angular ?

Oui. Le plugin de notifications est un package Capacitor, il fonctionne donc avec tout framework web qui tourne à l'intérieur de Capacitor, y compris Ionic, React, Vue, Angular, Svelte et JavaScript pur.

Quelle version de Capacitor est prise en charge 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, plugin v8 avec Capacitor 8). La table de compatibilité dans le README du GitHub liste les versions maintenues.

Le plugin @capgo/capacitor-notifications est-il 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 est gratuit pour l'installer à partir de npm. Les rapports de bogues et les demandes de modification sont les bienvenus.

Peut-on mettre à jour code qui utilise Notifications sans passer par une revue de l'App Store ?

En installant ou en mettant à jour le plugin, les natives code changent, il faut donc une nouvelle build de magasin. Une fois cela fait, les modifications JavaScript, HTML et CSS qui appellent le plugin peuvent être envoyées instantanément avec les mises à jour Capgo en direct.

Ship Notifications changes without waiting for app review

Une fois le plugin est dans votre magasin de build, Capgo les mises à jour en direct poussent vos modifications JavaScript, HTML et CSS vers les utilisateurs en quelques minutes.

Commencez avec Capgo