@capgo/capacitor-notifications
Présentation
Présentation@capgo/capacitor-notifications connecte une application Capacitor à la file d'attente de notifications natives de Capgo. Votre application enregistre un ID d'utilisateur client signé avec Capgo, Capgo conserve l'état de l'appareil actif dans l'Cloudflare Engine d'analyse, et vous pouvez envoyer des notifications, définir des badges, inspecter les statistiques de livraison et déclencher des vérifications silencieuses de mise à jour en direct Capgo à partir du tableau de bord Capgo ou de l'API.
La fonctionnalité est conçue pour éviter une table de dispositifs de notification à haute cardinalité dans l'Capgo Postgres. Le Postgres ne stocke que des données de plan de contrôl’à faible cardinalité telles que les paramètres d'application, les métadonnées de métadonnées de plateforme, les brouillons de campagne, les horaires et les enregistrements de campagne agrégés. L'état de l'appareil actif et les événements de notification sont des lignes d'__CAPGO_KEEP_4__ Engine d'analyse qui s'ajoutent en lecture seule.
Quels sont les Capgo stockés
Titre de la section « Quels sont les Capgo stockés »| Les données | Où elles vivent | Pourquoi |
|---|---|---|
| Métadonnées de métadonnées de plateforme | Capgo Postgres | Besoin pour gérer la configuration et les autorisations de l'application. |
| Mots de passe de plateforme privés | Environnement de travail | Évite de stocker des informations de connexion privées dans les tables destinées aux clients. |
| Conception de campagnes et paramètres | Capgo Postgres | Données de contrôle plan de faible cardinalité. |
| État d'enregistrement actif du dispositif | Cloudflare Engine d'analytique | Registre de dispositif actif à faible coût et sans modification. |
| Événements de notification | Cloudflare Engine d'analytique | Statistiques à faible coût pour les événements en attente, envoyés, reçus, ouverts, échoués et en arrière-plan. |
Modèle d'identité
Modèle d'identitéCapgo ne vous demande pas de télécharger une liste d'utilisateurs ou de maintenir une table de dispositifs.
- Votre backend connaît l'ID utilisateur client réel.
- Votre backend demande à Capgo un jeton à vie courte.
identityProof. - L'application s'enregistre avec
externalIdet que cette preuve après votre propre authentification utilisateur réussit. - Capgo dérive des clés internes déterministes pour le destinataire et l'installation native.
- En envoyant à la même
externalIdretrouve les appareils actifs de l'utilisateur à nouveau.
Cela vous permet de rechercher les appareils d'un utilisateur, d'attribuer des badges et de cibler des campagnes de notification sans stocker des lignes de notification par appareil dans Capgo Postgres.
Capacités de base
Sous-titre « Capacités de base »- Enregistrer les appareils avec un ID utilisateur externe authentifié.
- Actualiser les balises, les attributs, le consentement et l'état du jeton lors du démarrage de l'application ou des changements de jeton.
- Recevoir des notifications en arrière-plan dans JavaScript.
- Suivre les événements de notification reçue et ouverte.
- Gérer les notifications de données en arrière-plan.
- Définir, effacer et incrémenter les icônes de l'application.
- Créer des canaux de notification Android.
- Envoyer des notifications uniques, des notifications de campagne, des mises à jour d'icônes et des vérifications de mise à jour silencieuses.
- Déclencher
@capgo/capacitor-updaterà partir d'une notification silencieuse.
Statistiques
Section intitulée « Statistiques »Capgo écrit les événements de notification dans Cloudflare Engine d'analyse pour que les statistiques du tableau de bord restent abordables :
queuedsentprovider_acceptedreceivedopenedfailedpermission_changedbackground_startedbackground_finished
Les statistiques sont des signaux opérationnels, pas un registre permanent par destinataire. La rétention de l'engin d'analytique signifie que les appareils actifs doivent rafraîchir leur inscription périodiquement.
Public API
Section intitulée « Public API »| Méthode | Description |
|---|---|
configure | Configure l'ID d'application Capgo, l'hôte API et le comportement d'intégration de mise à jour. |
register | Enregistre l'installation actuelle pour un ID d'utilisateur client externe. |
setExternalId | Modifie l'ID d'utilisateur client externe après connexion ou changement de compte. |
setTags | Remplace les balises utilisées pour la ciblage de l'audience. |
setBadge | Configure l'icône de la notification native. |
clearBadge | Supprime l'icône de la notification native. |
incrementBadge | Augmente l'icône de la notification native. |
enableUpdaterIntegration | Active le traitement silencieux des mises à jour. @capgo/capacitor-updater. |
runUpdateCheck | Exécute manuellement l'intégration de mise à jour pour les tests. |
trackReceived | Écrit manuellement un événement reçu. |
trackOpened | Écrit manuellement un événement ouvert. |
addListener('notificationReceived') | Se déclenche lorsqu'une notification est reçue tandis que JavaScript est actif. |
addListener('notificationOpened') | Se déclenche lorsqu'un utilisateur ouvre une notification. |
addListener('backgroundNotification') | Se déclenche pour les notifications de données en arrière-plan et expose finish(). |
addListener('registrationChanged') | Se déclenche lorsqu'un jeton de push natif change. |
Garanties de livraison
Section intitulée « Garanties de livraison »Le push natif est au moins une fois. Une campagne peut être réessayée, et un appareil peut recevoir une copie si le système accepte un message répété. Utilisez les IDs de collapsage pour les vérifications de mise à jour et rendez les travaux en arrière-plan idempotents.
Les notifications en arrière-plan iOS sont de meilleure volonté. Le système peut limiter ou ignorer l'exécution en arrière-plan en fonction de la batterie, du comportement de l'utilisateur, de l'état de force-quit et de la politique du système. N'ayez pas confiance dans les notifications silencieuses pour les délais d'expiration.
Continuez de là à @capgo/capacitor-notifications
Section intitulée « Continuez de là à @capgo/capacitor-notifications »Si vous utilisez @__CAPGO_KEEP_0__/__CAPGO_KEEP_1__-notifications @capgo/capacitor-notifications pour planifier les messages push, connectez-l’avec Getting Started pour la configuration Debugging pour le dépannage @capgo/capacitor-updater pour les vérifications de mise à jour silencieuses, et Capgo Répertoire des plugins {"targetLanguage":"French","pagePath":"/fr/docs/plugins/notifications/","protectedTokens":["Cloudflare","Capacitor","GitHub","Capgo","code","API","SDK","CLI","npm","bun"],"items":[{"text":"pour les autres plugins natifs."},{"text":"Éditer la page"}]}