Zum Hauptinhalt springen
@capgo/capacitor-firebase-messaging Kommunikation Open Source

Firebase Messaging Capacitor Plugin

Capacitor Plugin für Firebase Cloud Messaging (FCM)

Installieren

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

Anleitung

Firebase Messaging in Capacitor nutzen

Verwendung von @capgo/capacitor-firebase-messaging

Capacitor Plugin für Firebase Cloud Messaging (FCM).

Installieren

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

bunx cap sync kopiert das native code des Plugins in deine nativen Projekte. Führe es nach jedem Plugin-Upgrade erneut aus.

Importieren

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

API im Überblick

Methode Beschreibung
checkPermissions Berechtigung für Push-Benachrichtigungen prüfen.
requestPermissions Berechtigung für Push-Benachrichtigungen anfordern.
isSupported Prüft, ob alle erforderlichen APIs vorhanden sind.
getToken Registriert die App für Push-Benachrichtigungen. Gibt einen FCM-Token zurück, der zum Senden von Push-Nachrichten an diese Messaging-Instanz genutzt werden kann.
deleteToken Löscht den FCM-Token und meldet die App ab, um den Empfang von Push-Benachrichtigungen zu stoppen. Kann z. B. beim Logout des Nutzers aufgerufen werden.
getDeliveredNotifications Ruft eine Liste der Benachrichtigungen ab, die im Benachrichtigungsbildschirm sichtbar sind.
removeDeliveredNotifications Entfernt spezifische Benachrichtigungen aus dem Benachrichtigungsbildschirm.
removeAllDeliveredNotifications Entfernt alle Benachrichtigungen aus dem Benachrichtigungsbildschirm.
subscribeToTopic Abonniert ein Topic im Hintergrund.
unsubscribeFromTopic Meldet sich im Hintergrund von einem Topic ab.
createChannel Erstellt einen Notification Channel.
deleteChannel Löscht einen Notification Channel.
listChannels Listet die verfügbaren Notification Channels auf.

Beispiele

checkPermissions()

Prüft die Berechtigung für Push-Benachrichtigungen.

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

const result = await FirebaseMessaging.checkPermissions();
console.log(result);

requestPermissions()

Fordert die Berechtigung für Push-Benachrichtigungen an.

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

const result = await FirebaseMessaging.requestPermissions();
console.log(result);

isSupported()

Prüft, ob alle erforderlichen APIs vorhanden sind.

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

const result = await FirebaseMessaging.isSupported();
console.log(result);

getToken()

Registriere die App, um Push-Benachrichtigungen zu erhalten. Es wird ein FCM-Token zurückgegeben, mit dem Push-Nachrichten an diese Messaging-Instanz gesendet werden können.

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

const result = await FirebaseMessaging.getToken();
// The result holds sensitive values: use it without logging it.

deleteToken()

Löscht den FCM-Token und meldet die App ab, damit keine Push-Benachrichtigungen mehr ankommen. Kann z. B. beim Logout eines Nutzers aufgerufen werden.

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

await FirebaseMessaging.deleteToken();

getDeliveredNotifications()

Ruft eine Liste der Benachrichtigungen ab, die auf dem Benachrichtigungsbildschirm sichtbar sind.

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

const result = await FirebaseMessaging.getDeliveredNotifications();
console.log(result);

Die obige Tabelle listet die 13 Kernmethoden auf. Listener- und Versions-Helper sowie der vollständige Contract jeder Methode findest du in der GitHub-Repository.

Auf Events hören

addListener gibt ein Handle zurück. Rufe handle.remove() auf, wenn der Screen unmountet, oder FirebaseMessaging.removeAllListeners() um alle Listener zu entfernen.

Vollständige Referenz

Weiterlesen nach der Nutzung von @capgo/capacitor-firebase-messaging

Wenn Sie ... verwenden Verwendung von @capgo/capacitor-firebase-messaging um die Arbeit an Native Plugins zu planen, verbinde es mit Capgo Plugin-Verzeichnis für den Produkt-Workflow im Capgo Plugin-Verzeichnis, Capacitor Plugins von Capgo für die Implementierungsdetails in Capacitor Plugins von Capgo, Plugins hinzufügen oder aktualisieren für die Implementierungsdetails in Adding or Updating Plugins, Ionic Enterprise Plugin-Alternativen für den Produkt-Workflow in Ionic Enterprise Plugin Alternatives und Capgo Native Builds für den Produkt-Workflow in Capgo Native Builds.

FAQ

Firebase Messaging Plugin FAQ

Wie installiere ich das Firebase Messaging Plugin in einer Capacitor App?

Führe "bun add @capgo/capacitor-firebase-messaging" (oder "npm install @capgo/capacitor-firebase-messaging") aus und danach "bunx cap sync", damit die iOS- und Android-Projekte das native code übernehmen. Importiere es in deiner App code aus "@capgo/capacitor-firebase-messaging".

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

Ja. Firebase Messaging ist ein Capacitor Package und funktioniert daher mit jedem Web-Framework, das in Capacitor läuft, einschließlich Ionic, React, Vue, Angular, Svelte und reinem JavaScript.

Welche Capacitor Version wird von @capgo/capacitor-firebase-messaging unterstützt?

Capgo Plugins folgen der Major-Version von Capacitor: Nutze die Plugin-Major-Version, die zu deiner Capacitor Major-Version passt (z. B. Plugin v8 mit Capacitor 8). Die Kompatibilitätstabelle im GitHub README listet die gepflegten Versionen auf.

Ist @capgo/capacitor-firebase-messaging kostenlos und Open Source?

Ja. Der code Code ist öffentlich auf GitHub unter https://github.com/Cap-go/capacitor-firebase/tree/main/packages/messaging einsehbar und das Package kann kostenlos via npm installiert werden. Bug Reports und Pull Requests sind willkommen.

Kann ich code mit Firebase Messaging ohne App Store Review aktualisieren?

Die Installation oder das Upgrade des Plugins ändert den nativen code, deshalb ist ein neuer Store-Build nötig. Danach lassen sich JavaScript-, HTML- und CSS-Änderungen, die das Plugin aufrufen, sofort mit Capgo Live Updates ausliefern.

Firebase Messaging-Änderungen deployen, ohne auf den App-Review zu warten

Sobald das Plugin in deinem Store-Build ist, pushen Capgo Live Updates deine JavaScript-, HTML- und CSS-Änderungen in Minuten an die Nutzer.

Starte mit Capgo