@capgo/capacitor-notifications

Présentation

@capgo/capacitor-notifications connecte une application Capacitor à la file d'attente de notifications native de Capgo. Votre application enregistre un ID d'utilisateur client signé avec Capgo, Capgo conserve l'état de l'appareil actif le plus récent 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 de mise à jour silencieuses Capgo en direct à partir de la Capgo table de bord ou API.

La fonctionnalité est conçue pour éviter une table de dispositifs de notification à haut cardinalité dans Capgo Postgres. 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 en lecture seule.

Quels sont les Capgo stockés ?

Les données	Où elles vivent	Pourquoi
Métadonnées de métadonnées de plateforme	Capgo Postgres	Nécessaires pour gérer la configuration et les autorisations de l'application.
Les secrets de plateforme privés	L'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 des appareils actifs à 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é

Capgo n'oblige pas à télécharger une liste d'utilisateurs ou à maintenir une table de dispositifs.

• Votre backend connaît l'ID utilisateur client réel.
• Votre backend demande à Capgo une clé valide à court terme. identityProof.
• L'application s'enregistre avec externalId et cette preuve après votre propre authentification utilisateur réussie.
• Capgo déduit des clés internes déterministes pour le destinataire et l'installation native.
• En envoyant à la même externalId retrouve les appareils actifs de l'utilisateur.

Cela vous permet de consulter 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

• 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 en JavaScript.
• Suivre les événements de réception et d'ouverture de notification.
• 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 silencieuse.
• Déclencher @capgo/capacitor-updater à partir d'une notification silencieuse.

Statistiques

Capgo enregistre les événements de notification dans Cloudflare Engine d'analyse pour que les statistiques du tableau de bord restent abordables :

• queued
• sent
• provider_accepted
• received
• opened
• failed
• permission_changed
• background_started
• background_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

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 l'application native.
clearBadge	Supprime l'icône de l'application native.
incrementBadge	Augmente l'icône de l'application native.
enableUpdaterIntegration	Active la gestion silencieuse de la vérification 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 de fond et expose finish().
addListener('registrationChanged')	Se déclenche lorsqu'un utilisateur ouvre une notification.

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 plateau accepte un message répété. Utilisez les IDs de collapsage pour les vérifications de mise à jour et rendez les travaux de fond idempotents.

Les notifications de fond iOS sont de meilleure volonté. Le système peut limiter ou ignorer l'exécution de fond 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 durs.

Continuez de là à partir de @capgo/capacitor-notifications

Si vous utilisez @capgo/capacitor-notifications pour planifier les messages push, connectez-l’avec Getting Started pour la configuration initiale Debugging pour le dépannage @capgo/capacitor-updater contexte : texte HTML fragment d'une chaîne de Capgo UI plus longue (clé parente `appflow_migration_step1`). Page/zone : Comparaison / migration de l'application Appflow. Rôle : Copie du site Web. Vu dans : page ionic-appflow.astro. Clé de message `appflow_migration_step1` (Étape 1 de la migration d'Appflow). pour les vérifications de mise à jour silencieuses, et le répertoire du plugin Capgo {"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"}]}