Firebase Messaging Plugin Capacitor

Utiliser @capgo/capacitor-firebase-messaging

Plugin Capacitor pour Firebase Cloud Messaging (FCM).

Installer

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

bunx cap sync copie le code natif du plugin dans vos projets natifs. Relancez-l’après chaque mise à jour du plugin.

Importer

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

Aperçu de API

Méthode	Description
checkPermissions	Vérifier la permission de recevoir des notifications push.
requestPermissions	Demander la permission de recevoir des notifications push.
isSupported	Vérifie si toutes les API requises existent.
getToken	Enregistrer l'app pour recevoir des notifications push. Retourne un token FCM utilisable pour envoyer des messages push à cette instance Messaging.
deleteToken	Supprimer le token FCM et désenregistrer l'app pour arrêter de recevoir des notifications push. Peut être appelé, par exemple, lors de la déconnexion d'un utilisateur.
getDeliveredNotifications	Récupérer la liste des notifications visibles sur l'écran de notifications.
removeDeliveredNotifications	Supprimez des notifications spécifiques de l'écran des notifications.
removeAllDeliveredNotifications	Supprimez toutes les notifications de l'écran des notifications.
subscribeToTopic	S'abonne à un topic en arrière-plan.
unsubscribeFromTopic	Se désabonne d'un topic en arrière-plan.
createChannel	Créer un canal de notification.
deleteChannel	Supprimer un canal de notification.
listChannels	Lister les canaux de notification disponibles.

Exemples

checkPermissions()

Vérifier la permission de recevoir des notifications push.

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

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

requestPermissions()

Demander la permission de recevoir des notifications push.

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

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

isSupported()

Vérifie si toutes les API requises existent.

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

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

getToken()

Enregistrer l'app pour recevoir des notifications push. Retourne un token FCM utilisable pour envoyer des messages push à cette instance Messaging.

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

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

deleteToken()

Supprimer le token FCM et désenregistrer l'app pour arrêter de recevoir des notifications push. Peut être appelé, par exemple, lors de la déconnexion d'un utilisateur.

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

await FirebaseMessaging.deleteToken();

getDeliveredNotifications()

Récupérer la liste des notifications visibles sur l'écran de notifications.

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

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

Le tableau ci-dessus liste les 13 méthodes principales. Les helpers de listener et de version, ainsi que le contrat complet de chaque méthode, sont documentés dans la dépôt GitHub.

Écouter les événements

addListener renvoie un handle. Appelez handle.remove() lors du démontage de l'écran, ou FirebaseMessaging.removeAllListeners() pour supprimer tous les listeners.

Référence complète

• dépôt GitHub
• Documentation
• Référence API

Continuez avec l'utilisation de @capgo/capacitor-firebase-messaging

Si vous utilisez Utiliser @capgo/capacitor-firebase-messaging pour planifier le travail sur les plugins natifs, connectez-l’à Capgo Répertoire des plugins pour le workflow produit dans Capgo Plugin Directory, Plugins Capacitor par Capgo pour les détails d'implémentation dans Plugins Capacitor par Capgo, Ajouter ou mettre à jour des plugins pour les détails d'implémentation dans Adding or Updating Plugins, Alternatives aux plugins Ionic Enterprise pour le workflow produit dans les alternatives aux plugins Ionic Enterprise, et Capgo Native Build pour le workflow produit dans Capgo Native Builds.