Richtlinie
Verwendung von Firebase Messaging in Capacitor
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 Plugin's native code in Ihre native Projekte. Führen Sie es erneut aus, nachdem jede Plugin-Upgrade durchgeführt wurde.
Importieren
import { FirebaseMessaging } from '@capgo/capacitor-firebase-messaging';
API im Überblick
| Methode | Beschreibung |
|---|---|
checkPermissions |
Überprüfen Sie die Berechtigung, Push-Benachrichtigungen zu empfangen. |
requestPermissions |
Anfordern Sie die Berechtigung, Push-Benachrichtigungen zu empfangen. |
isSupported |
Überprüft, ob alle erforderlichen APIs existieren. |
getToken |
Registrieren Sie die App, um Push-Benachrichtigungen zu empfangen. Gibt ein FCM-Token zurück, das zum Senden von Push-Nachrichten an diese Messaging-Instanz verwendet werden kann. |
deleteToken |
Löschen Sie den FCM-Token und deaktivieren Sie die App, um Push-Benachrichtigungen zu stoppen. Dies kann zum Beispiel dann erfolgen, wenn ein Benutzer sich abmeldet. |
getDeliveredNotifications |
Holen Sie sich eine Liste der Benachrichtigungen, die auf dem Benachrichtigungs-Bildschirm sichtbar sind. |
removeDeliveredNotifications |
Löschen Sie bestimmte Benachrichtigungen vom Benachrichtigungs-Bildschirm. |
removeAllDeliveredNotifications |
Löschen Sie alle Benachrichtigungen vom Benachrichtigungs-Bildschirm. |
subscribeToTopic |
Abonnieren Sie das Thema im Hintergrund. |
unsubscribeFromTopic |
Abonnieren Sie das Thema im Hintergrund. |
createChannel |
Eine Benachrichtigungs-Kanäle erstellen. |
deleteChannel |
Einen Benachrichtigungs-Kanal löschen. |
listChannels |
Liste der verfügbaren Benachrichtigungs-Kanäle. |
Beispiele
checkPermissions()
Zugriff auf Benachrichtigungen überprüfen.
import { FirebaseMessaging } from '@capgo/capacitor-firebase-messaging';
const result = await FirebaseMessaging.checkPermissions();
console.log(result);
requestPermissions()
Eine Benachrichtigungsberechtigung anfordern.
import { FirebaseMessaging } from '@capgo/capacitor-firebase-messaging';
const result = await FirebaseMessaging.requestPermissions();
console.log(result);
isSupported()
Überprüfen, ob alle erforderlichen APIs existieren.
import { FirebaseMessaging } from '@capgo/capacitor-firebase-messaging';
const result = await FirebaseMessaging.isSupported();
console.log(result);
getToken()
Registrieren Sie die App, um Benachrichtigungen zu erhalten. Gibt einen FCM-Token zurück, der zum Senden von Benachrichtigungen an diese Messaging-Instanz verwendet werden kann.
import { FirebaseMessaging } from '@capgo/capacitor-firebase-messaging';
const result = await FirebaseMessaging.getToken();
// The result holds sensitive values: use it without logging it.
deleteToken()
Entfernen Sie den FCM-Token und deaktivieren Sie die App, um die Empfangung von Benachrichtigungen zu beenden. Dies kann zum Beispiel aufgerufen werden, wenn ein Benutzer sich abmeldet.
import { FirebaseMessaging } from '@capgo/capacitor-firebase-messaging';
await FirebaseMessaging.deleteToken();
getDeliveredNotifications()
Erhalten Sie eine Liste von Benachrichtigungen, die auf dem Benachrichtigungs-Bildschirm sichtbar sind.
import { FirebaseMessaging } from '@capgo/capacitor-firebase-messaging';
const result = await FirebaseMessaging.getDeliveredNotifications();
console.log(result);
Die Tabelle oben listet die 13 Kernmethoden. Helfer für Listener und Versionen sowie die vollständige Vertragsstruktur jeder Methode sind in der GitHub Repository.
Veranstaltungen anhören
addListener gibt einen Handle zurück. Ruf handle.remove() wenn die Bildschirmabrechnung aufgehoben wird, oder FirebaseMessaging.removeAllListeners() um jeden Listener zu löschen.
Vollständige Referenz
Weitermachen von Using @capgo/capacitor-firebase-messaging
Wenn Sie Using verwenden Mit @capgo/capacitor-firebase-messaging um native Plugin-Arbeit zu planen, verbinden Sie es mit Capgo Plugin-Verzeichnis für den Produktworkflow in Capgo Plugin-Verzeichnis Capacitor Plugins von Capgo für die Implementierungsdetails in Capacitor Plugins von Capgo Hinzufügen oder Aktualisieren von Plugins für die Implementierungsdetails in Hinzufügen oder Aktualisieren von Plugins Ionic Enterprise Plugin Alternativen für den Produktworkflow in Ionic Enterprise Plugin Alternativen, und Capgo Native Builds für den Produktworkflow in Capgo Native Builds.