Allez directement au contenu principal
@capgo/capacitor-firebase-messaging Communication Source ouverte

Firebase Messaging plugin Capacitor

Capacitor plugin pour Firebase Cloud Messaging (FCM)

Installer

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

Guide

Comment utiliser Firebase Messaging dans Capacitor

Utilisez @capgo/capacitor-firebase-messaging

Capacitor plugin pour Firebase Cloud Messaging (FCM).

Installer

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

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

Importer

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

API en un coup d'œil

Méthode Description
checkPermissions Vérifiez la permission pour recevoir des notifications push.
requestPermissions Demandez la permission pour recevoir des notifications push.
isSupported Vérifiez si tous les API requis existent.
getToken Inscrivez l'application pour recevoir des notifications push. Renvoie un jeton FCM pouvant être utilisé pour envoyer des messages push vers cette instance de Messaging.
deleteToken Supprimez le jeton FCM et désinscrivez l'application pour arrêter de recevoir des notifications push. Peut être appelé, par exemple, lorsqu'un utilisateur se déconnecte.
getDeliveredNotifications Obtenez une liste de notifications visibles sur l'écran des 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 sujet en arrière-plan.
unsubscribeFromTopic S'abonne à un sujet en arrière-plan.
createChannel Créez un canal de notification.
deleteChannel Supprimez un canal de notification.
listChannels Listez les canaux de notification disponibles.

Exemples

checkPermissions()

Vérifiez la permission pour recevoir des notifications push.

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

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

requestPermissions()

Demandez la permission pour recevoir des notifications push.

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

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

isSupported()

Vérifiez si tous les API requis existent.

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

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

getToken()

Enregistrez l'application pour recevoir les notifications push. Renvoie un jeton FCM qui peut être utilisé pour envoyer des messages push à cet instance de Messaging.

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

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

deleteToken()

Supprimez le jeton FCM et désenregistrez l'application pour arrêter de recevoir les notifications push. Cela peut être appelé, par exemple, lorsque l'utilisateur se déconnecte.

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

await FirebaseMessaging.deleteToken();

getDeliveredNotifications()

Obtenez une liste de notifications qui sont visibles sur l'écran des notifications.

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

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

La table ci-dessus liste les 13 méthodes de base. Les écouteurs et les assistants de version, ainsi que la pleine convention de chaque méthode, sont documentés dans le GitHub dépôt.

Écoutez les événements

addListener renvoie un gestionnaire. Appelez handle.remove() lorsque l'écran est démonté, ou FirebaseMessaging.removeAllListeners() pour supprimer tous les écouteurs.

Référence complète

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

Si vous utilisez L'utilisation de @capgo/capacitor-firebase-messaging Pour planifier le travail de plugin natif, connectez-l’avec Répertoire de plugin Capgo pour le flux de travail du produit dans le Répertoire de plugin Capgo Capacitor Plugins par Capgo pour les détails d'implémentation dans Capacitor Plugins par Capgo Ajouter ou mettre à jour les plugins pour les détails d'implémentation dans Ajouter ou mettre à jour les plugins Alternatives de plugins Ionic Enterprise pour le flux de travail du produit dans les alternatives du plugin Enterprise Ionic Capgo Bâtissez des applications natives pour le flux de travail du produit dans Capgo Builds natifs.

FAQ

FAQ du plugin de messagerie Firebase

Comment puis-je installer le plugin de messagerie Firebase dans une application Capacitor?

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

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

Oui. Le plugin de messagerie Firebase est un paquet Capacitor, il fonctionne donc avec tout framework web qui s'exécute à l'intérieur de Capacitor, y compris Ionic, React, Vue, Angular, Svelte et JavaScript simple.

Quelle version de Capacitor est prise en charge par @capgo/capacitor-firebase-messaging?

Les plugins Capgo suivent la version majeure de Capacitor : utilisez la version majeure du plugin qui correspond à votre version majeure de Capacitor (par exemple, plugin v8 avec Capacitor 8). La table de compatibilité dans le fichier README du GitHub liste les versions maintenues.

Le plugin @capgo/capacitor-firebase-messaging est-il gratuit et open source?

Oui. Le code source code est public sur GitHub à l'adresse https://github.com/Cap-go/capacitor-firebase/tree/main/packages/messaging et le paquet est gratuit à installer à partir de npm. Les rapports de bogues et les demandes de modification sont les bienvenus.

Puis-je mettre à jour code utilisant Firebase Messaging sans passer par une revue de l'App Store ?

L'installation ou la mise à niveau du plugin modifie le code natif code, il faut donc une nouvelle mise à jour de l'application. Une fois cela fait, les modifications JavaScript, HTML et CSS qui appellent le plugin peuvent être envoyées instantanément avec les mises à jour en direct Capgo.

Envoyez les modifications de Firebase Messaging sans attendre la revue de l'application

Une fois le plugin dans votre magasin de build, Capgo les mises à jour en temps réel déployent vos modifications JavaScript, HTML et CSS chez les utilisateurs en quelques minutes.

Démarrer avec Capgo