@capgo/capacitor-updater

Live update pour les applications capacitor.

Également disponible pour Cordova et Electron

Les live update Capgo ne sont pas limitées à Capacitor. Utilisez le même backend et CLI avec des plugins clients frères :

Updater Cordova OTA pour Cordova sur iOS 7+ et Android 13+.

Updater Electron Des live update(s) desktop avec le même API.

Aperçu

@capgo/capacitor-updater déploient Mises à jour de bundle JS pour les apps Capacitor en production sans attendre la validation des stores. Téléchargez les bundles signés en arrière-plan, gérez le déploiement progressif avec des canaux et des règles de délai, et effectuez un rollback si notifyAppReady() n'est pas appelé dans la configuration de appReadyTimeout.

Cas d'usage typiques : hotfix de bugs en production, bêtas progressives par canal, expérimentations UI A/B, et rollback d'urgence vers le bundle intégré.

Support des plateformes

Plateforme	Support
iOS	Oui
Android	Oui
Le Web	Les bundles s'appliquent à la couche WebView dans les shells natifs, pas aux sites statiques hébergés

Les clients Cordova et Electron utilisent les plugins frères liés ci-dessus avec le même backend Capgo.

Fonctionnalités clés

notifyAppReady - Notifier la couche native que le JavaScript a été initialisé avec succès.
setUpdateUrl - Définir l'URL de mise à jour de l'application dynamiquement au runtime.
setStatsUrl - Définir l'URL des statistiques de l'application dynamiquement au runtime.
setChannelUrl - Définir l'URL du canal de l'application dynamiquement au runtime.

API public

Méthode	Description
`notifyAppReady`	Informer la couche native que l'initialisation du JavaScript a réussi.
`setUpdateUrl`	Définir l'URL de mise à jour de l'application dynamiquement au runtime.
`setStatsUrl`	Définir l'URL des statistiques de l'application dynamiquement au runtime.
`setChannelUrl`	Définir l'URL du canal de l'application dynamiquement au runtime.
`download`	Télécharger un nouveau bundle depuis l'URL fournie pour une installation ultérieure.
`next`	Définir le prochain bundle à activer lors du passage en arrière-plan ou du redémarrage de l'app.
`set`	Définir le bundle actuel et recharger immédiatement l'app.
`delete`	Supprimer un bundle du stockage local pour libérer de l'espace disque.
`setBundleError`	Marquer manuellement un bundle comme ayant échoué en mode mise à jour manuelle.
`list`	Récupérer tous les bundles téléchargés localement et stockés dans votre app.
`reset`	Réinitialiser l'app vers un bundle stable connu.
`current`	Obtenir les informations sur le bundle actuellement actif.
`reload`	Recharger manuellement l'app pour appliquer une mise à jour en attente.
`setMultiDelay`	Configurer les conditions à remplir avant d'appliquer une mise à jour en attente.
`cancelDelay`	Annuler toutes les conditions de délai et appliquer la mise à jour en attente immédiatement.
`getLatest`	Vérifier le serveur de mise à jour pour obtenir la dernière version de bundle disponible.
`setChannel`	Définissez un canal de mise à jour local pour cet appareil. Cela ne crée pas de API device override dans le dashboard.
`unsetChannel`	Supprimez l'attribution de canal de l'appareil et revenez au canal par défaut.
`getChannel`	Récupérez le canal actuellement assigné à cet appareil.
`listChannels`	Récupérez la liste de tous les canaux auxquels cet appareil peut s'auto-assigner.
`setCustomId`	Définissez un identifiant personnalisé pour cet appareil.
`getBuiltinVersion`	Récupérez la version du bundle intégré (la version d'origine livrée avec votre app native).
`getDeviceId`	Obtenez l'identifiant unique et respectueux de la vie privée de cet appareil.
`getPluginVersion`	Récupérez la version du plugin Capacitor Updater installé dans votre app.
`isAutoUpdateEnabled`	Vérifiez si les mises à jour automatiques sont actuellement activées.
`removeAllListeners`	Supprimez tous les écouteurs d'événements enregistrés pour ce plugin.
`addListener`	Écoutez l'événement de téléchargement du bundle dans l'app. Se déclenche dès qu'un téléchargement démarre, pendant le téléchargement et à la fin. Cela vous renvoie le pourcentage de téléchargement tout au long de celui-ci.
`addListener`	Écoutez l'événement indiquant qu'aucune mise à jour n'est nécessaire, utile si vous souhaitez forcer une vérification à chaque lancement de l'app.
`addListener`	Écoutez l'événement de mise à jour disponible, utile pour forcer une vérification à chaque lancement de l'app.
`addListener`	Écouter les événements downloadComplete.
`addListener`	Écoutez les événements de mise à jour critique lorsque le backend signale une mise à jour incompatible avec l'app actuelle. Émet la même charge utile que l'ancien `majorAvailable` listener.
`addListener`	Écoutez l'événement de mise à jour majeure dans l'app, pour savoir quand une mise à jour majeure est bloquée via disableAutoUpdateBreaking.
`addListener`	Écoutez l'événement d'échec de mise à jour dans l'app, pour savoir quand une mise à jour n'a pas pu s'installer au prochain démarrage.
`addListener`	Écoutez l'événement set dans l'app, pour savoir quand un bundle a été appliqué avec succès. Cet événement est conservé nativement jusqu'à ce que le JavaScript le consomme ; si l'app redémarre avant que votre listener ne soit attaché, le dernier `set` événement est délivré dès que le listener s'abonne.
`addListener`	Écoutez l'événement set next dans l'app, pour savoir quand un bundle est mis en file d'attente pour la prochaine installation.
`addListener`	Écoutez l'événement d'échec de téléchargement dans l'app, pour savoir quand le téléchargement d'un bundle a échoué.
`addListener`	Écoutez l'événement de reload dans l'app, pour savoir quand le reload a eu lieu.
`addListener`	Écoutez l'événement app ready dans l'app, pour savoir quand l'app est prête à l'emploi. Cet événement est conservé nativement jusqu'à ce que le JavaScript le consomme, il peut donc être délivré après un reload même si le listener est attaché plus tard au démarrage.
`addListener`	Écouter l'événement privé de canal, déclenché lorsqu'on tente de définir un canal qui n'autorise pas l'auto-assignation de l'appareil.
`addListener`	Écouter les changements d'état des mises à jour flexibles sur Android.
`isAutoUpdateAvailable`	Vérifier si la fonctionnalité de mise à jour automatique est disponible (non désactivée par une configuration de serveur personnalisée).
`getNextBundle`	Récupérer les informations sur le bundle en attente d'activation au prochain rechargement.
`getFailedUpdate`	Récupérer les informations sur le bundle le plus récent dont le chargement a échoué.
`setShakeMenu`	Activer ou désactiver le menu du geste de secousse pour le débogage et les tests.
`isShakeMenuEnabled`	Vérifier si le menu de débogage du geste de secousse est actuellement activé.
`setShakeChannelSelector`	Activez ou désactivez le sélecteur de canal par secousse (shake) au runtime.
`isShakeChannelSelectorEnabled`	Vérifiez si le sélecteur de canal par secousse est actuellement activé.
`getAppId`	Récupérer l'App ID actuellement configuré pour la communication avec le serveur de mise à jour.
`setAppId`	Modifier dynamiquement l'App ID utilisé pour la communication avec le serveur de mise à jour.
`getAppUpdateInfo`	Récupérer les informations sur la disponibilité de l'app sur l'App Store ou le Play Store.
`openAppStore`	Ouvrez la page de l'application sur l'App Store ou le Play Store.
`performImmediateUpdate`	Effectuez une mise à jour immédiate dans l'application sur Android.
`startFlexibleUpdate`	Lancez une mise à jour flexible dans l'application sur Android.
`completeFlexibleUpdate`	Terminez une mise à jour flexible dans l'application sur Android.

Source de vérité

Cette référence est synchronisée depuis src/definitions.ts dans capacitor-updater.

Continuez avec @capgo/capacitor-updater

Si vous utilisez @capgo/capacitor-updater pour planifier le travail sur les plugins natifs, connectez-l’à Utiliser @capgo/capacitor-updater pour la capacité native dans « Utiliser @capgo/capacitor-updater », 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 Ajout ou mise à jour de plugins, et Alternatives aux plugins Ionic Enterprise pour le workflow produit dans Alternatives aux plugins Ionic Enterprise.