Zum Hauptinhalt springen
@capgo/capacitor-Benachrichtigungen Geräte-APIs Open Source

Benachrichtigungen Capacitor-Plugin

Send native iOS- und Android-Benachrichtigungen von Capgo mit Benutzerlookup, Badges, Statistiken und Stille-Update-Überprüfungen.

Installieren

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

Richtlinie

Benutzung von Benachrichtigungen in Capacitor

Verwendung von @capgo/capacitor-notifications

Send native iOS- und Android-Benachrichtigungen von Capgo mit Benutzerlookup, Badges, Vordergrund-/Offen-Tracking, Hintergrundrückruf und stille Capgo Live-Update-Überprüfungen.

Das Plugin ist für den Capgo-Benachrichtigungs-Pipeline erstellt. Capgo speichert Plattform-Zugriffsmetadaten und Kampagnensteuerungsdaten in Postgres, während aktive Gerätestatus und Lieferungsereignisse in Cloudflare Analytics Engine geschrieben werden.

Installieren

Use the Capgo CLI for a guided setup:

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

Manuelle Installation:

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

Konfigurieren

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

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

Ein registrierter Benutzer anmelden

Mint identityProof aus Ihrem Backend mit POST /notifications/recipients/proof Dann registrieren Sie das Gerät, nachdem Ihr Login erfolgreich war.

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

Hinweis auf Ereignisse abonnieren

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()
  }
})

iOS-Einrichtung

Zulassen Benachrichtigungen über Push-Nachrichten and Hintergrund-Modi > Remote-Nachrichten Hier in Xcode.

Forward remote notifications from 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)
}

Android-Einrichtung

Ausführen npx cap sync androidKonfigurieren Sie die Android-Plattformkredenziale in Capgo, stellen Sie die Benachrichtigungs-Erlaubnis auf Android 13+ ein und testen Sie auf einem Gerät oder einem Emulator mit Google Play-Diensten.

Überprüfungsliste

  • Ausführen npx @capgo/cli@latest notifications setup com.example.app aus dem Ordner, der das capacitor.config.*.
  • Suchen Sie den Empfänger in Capgo nach externer Kunden-ID.
  • Bestätigen Sie, dass das Gerät die Plattform android oder ios und die Genehmigung wurde erteilt.
  • Hinzufügen von temporären Hörern für registrationChanged, notificationReceived, notificationOpened, und backgroundNotification.
  • Ein Testbenachrichtigung von der Dashboard senden.
  • Überprüfe Statistiken für anstehende, gesendete, empfangene und geöffnete Ereignisse.
  • Für stille Aktualisierungsprüfungen, überprüfen Sie @capgo/capacitor-updater ist installiert und autoUpdater ist aktiviert.

Vollständige Referenz

Mit @capgo/capacitor-notifications fortfahren

Wenn Sie __CAPGO_KEEP_0__ verwenden Mit @capgo/capacitor-notifications um native Push-Nachrichten zu planen, verbinden Sie es mit @capgo/capacitor-Benachrichtigungen um die Implementierungsdetails zu erhalten Debugging um zu überprüfen @capgo/capacitor-Updater um stille Aktualisierungsprüfungen durchzuführen, und Capgo Plugin-Verzeichnis für andere native Plugins.

FAQ

Benutzerhandbuch für die Benachrichtigungs-Plugin

Wie installiere ich das Benachrichtigungs-Plugin in einer Capacitor-Anwendung?

Führen Sie "bun add @capgo/capacitor-notifications" (oder "npm install @capgo/capacitor-notifications"), dann führen Sie "bunx cap sync" aus, damit die iOS- und Android-Projekte die native code-Datei aufnehmen. Importieren Sie sie aus "@capgo/capacitor-notifications" in Ihrer Anwendung code.

Funktioniert @capgo/capacitor-notifications mit React, Vue und Angular?

Ja. Das Benachrichtigungs-Plugin ist ein Capacitor-Paket, daher funktioniert es mit jedem Web-Framework, das innerhalb von Capacitor läuft, einschließlich Ionic, React, Vue, Angular, Svelte und plain JavaScript.

Welche Capacitor-Version unterstützt @capgo/capacitor-notifications?

Capgo-Plugins folgen der Capacitor-Version: verwenden Sie die Plugin-Major-Version, die Ihrem Capacitor-Major-Version entspricht (z.B. Plugin v8 mit Capacitor 8). Die Kompatibilitäts-Tabelle im GitHub-README listet die unterstützten Versionen auf.

Ist @capgo/capacitor-notifications kostenlos und Open-Source?

Ja. Die Quellcode-code ist öffentlich auf GitHub unter https://github.com/Cap-go/capgo/tree/main/packages/capacitor-notifications/ verfügbar und das Paket kann kostenlos installiert werden von npm. Bug-Reports und Pull-Requests sind willkommen.

Kann ich code aktualisieren, das Notifications verwendet, ohne eine App-Store-Bewertung?

Installieren oder aktualisieren Sie das Plugin ändert die native code, daher benötigt es eine neue Build des Speicherorts. Nachdem das geschehen ist, können JavaScript-, HTML- und CSS-Änderungen, die das Plugin aufrufen, sofort mit Capgo Live-Updates verschickt werden.

Schiffe Benachrichtigungen-Änderungen ohne auf die App-Überprüfung zu warten

Einmal der Plugin in Ihrem Store-Build installiert, werden Capgo lebendige Updates Ihre JavaScript-, HTML- und CSS-Änderungen innerhalb von Minuten an die Benutzer pushen.

Start mit Capgo