Mise à jour
Copiez un prompt de configuration avec les étapes d'installation et le guide Markdown complet pour ce plugin.
Lorsque vous publiez une mise à jour pour votre application Capgo, vous souhaitez probablement que vos utilisateurs reçoivent cette mise à jour le plus rapidement possible. Mais vous ne voulez pas non plus perturber leur expérience en leur forçant de attendre une téléchargement ou de redémarrer l'application au milieu d'une session.
Le comportement de mise à jour de Capgo est conçu pour trouver un équilibre entre la livraison des mises à jour rapidement et la minimisation de la perturbation pour vos utilisateurs.
Flux de mise à jour par défaut
Section intitulée « Flux de mise à jour par défaut »Par défaut, voici comment Capgo gère les mises à jour des applications :
-
Lorsque l'application passe en avant-plan, le plugin Capgo vérifie si une nouvelle mise à jour est disponible. Alors que l'application reste ouverte, il vérifie à nouveau à intervalles réguliers contrôlés par
periodCheckDelay(défaut 10 minutes). -
Si une mise à jour est trouvée, elle est téléchargée en arrière-plan tandis que l'utilisateur continue à utiliser la version actuelle de l'application.
-
Une fois le téléchargement terminé, Capgo attend que l'utilisateur mette l'application en arrière-plan.
-
Lorsque l'utilisateur ramène l'application à l'avant-plan, ils seront en train de lancer la version mise à jour.
Cette progression garantit que les utilisateurs sont toujours en train de lancer la dernière version de votre application, sans jamais être interrompus par des invitations à mettre à jour ou contraints d'attendre des téléchargements.
Pourquoi Cette Approche ?
Sous-titre « Pourquoi Cette Approche ? »La mise à jour d'une application sur un événement de fond ou de suppression présente quelques avantages clés pour l'expérience utilisateur :
-
Les utilisateurs ne sont pas interrompus par des invitations à mettre à jour ou contraints d'attendre des téléchargements au milieu d'une session.
-
Les mises à jour sont appliquées de manière fluide entre les sessions, de sorte que l'expérience de lancement de l'application est toujours fraîche.
-
Vous pouvez livrer des mises à jour fréquentes sans vous soucier de perturber les utilisateurs actifs.
Le principal inconvénient est que si un utilisateur met votre application en arrière-plan et la reprend rapidement, il peut perdre tout l'état non enregistré depuis que la mise à jour a été appliquée entre ces actions.
Pour atténuer cela, nous recommandons :
-
Enregistrez l'état fréquemment et restaurez-le de manière gracieuse lorsque l'application reprend.
-
Évitez les mises à jour très fréquentes qui modifient de grandes parties de l'état de l'application.
-
Considérez la personnalisation du comportement de mise à jour pour les flux sensibles (voir ci-dessous).
Personnaliser Lorsque les Mises à Jour Sont Appliquées
Section intitulée « Personnaliser Lorsque les Mises à Jour Sont Appliquées »Dans certains cas, vous pourriez vouloir plus de contrôle sur l'exact moment où une mise à jour est appliquée. Par exemple, vous pourriez vouloir vous assurer que l'utilisateur a terminé un flux en cours avant de mettre à jour, ou coordonner une mise à jour de l'application avec une modification côté serveur.
Capgo fournit une setDelay fonction qui vous permet de spécifier des conditions qui doivent être remplies avant que la mise à jour soit installée :
import { CapacitorUpdater } from '@capgo/capacitor-updater';
await CapacitorUpdater.setMultiDelay({ delayConditions: [ { kind: 'date', value: '2023-06-01T00:00:00.000Z', }, { kind: 'background', value: '60000', }, ],});Cet exemple retarderait l'installation d'une mise à jour jusqu'après le 1er juin 2023 ET l'application aurait été mis en arrière-plan pendant au moins 60 secondes.
Les conditions de retard disponibles sont :
date: Attendre après une date et heure spécifique pour appliquer la mise à jour.background: Attendre une durée minimale après que l'application est mise en arrière-plan pour appliquer la mise à jour.nativeVersion: Attendre que soit installé un fichier binaire natif avec une version minimale avant d'appliquer la mise à jour.kill: Attendre jusqu'au prochain événement de mort de l'application pour appliquer la mise à jour.
Vous pouvez combiner ces conditions pour contrôler précisément quand une mise à jour est installée.
Appliquer les Mises à Jour Immédiatement
Titre de la section « Mise à jour immédiate »For critical updates or apps with very simple state, you may want to apply an update as soon as it’s downloaded, without waiting for a background or kill event. Capgo supports this via the autoUpdate Capacitor prend en charge cela via la
autoUpdate fichier, pas en JavaScript __CAPGO_KEEP_0__. Il prend en charge ces valeurs : capacitor.config.ts file, not in JavaScript code. It supports these values:
falseAlternatives : Appflow, Capawesome ou Capacitor ?'off': Désactiver les vérifications automatiques de mise à jourtrueou'atBackground'(par défaut) : Vérifiez et téléchargez automatiquement à chaque vérification en avant-plan, puis appliquez la mise à jour la prochaine fois que l'application passe en arrière-plan'atInstall': Appliquer immédiatement uniquement après une installation fraîche ou une mise à jour de l'application native ; sinon utilisez"atBackground"comportement'onLaunch': Appliquer immédiatement uniquement lorsque l'application est ramenée à l'avant-plan à partir d'un état tué (démarrage froid). Après cette première vérification, reculez sur"atBackground"comportement'always': Vérifiez à chaque transition en avant-plan et appliquez immédiatement dès que une mise à jour est disponible'onlyDownload': Vérifiez et téléchargez automatiquement, émettezupdateAvailable, et n'installez jamais le prochain bundle ou appliquez une mise à jour automatiquement
Tester une Build Native Sans Mises à Jour en Direct
Titre de la section « Tester une Build Native Sans Mises à Jour en Direct »Voir Tester les Builds Native Sans Mises à Jour pour les garanties de configuration de version native, de politique de canal et de CI.
import { CapacitorConfig } from '@capacitor/cli';
const config: CapacitorConfig = { plugins: { CapacitorUpdater: { autoUpdate: 'always', // or 'atInstall' for updates only on app install/update autoSplashscreen: true, keepUrlPathAfterReload: true, }, SplashScreen: { launchAutoHide: false, // Required when using instant apply with autoSplashscreen }, },};
export default config;Avec autoUpdate: 'always', Capgo vérifie à chaque transition en avant-plan et applique une mise à jour immédiate dès que le téléchargement est terminé pendant cette vérification, même si l'utilisateur utilise actuellement l'application. Les vérifications périodiques contrôlées par periodCheckDelay peuvent déclencher le même comportement d'application immédiate pendant que l'application reste ouverte.
Notez que puisque autoUpdate est une configuration native, les modes d'application instantanée nécessitent une gestion supplémentaire dans votre code JavaScript.
Téléchargement Automatique Sans Application
Sous-titre “Téléchargement Automatique Sans Application”Si vous souhaitez que Capgo vérifie et télécharge les mises à jour automatiquement sans les appliquer jamais automatiquement, utilisez autoUpdate: 'onlyDownload':
const config: CapacitorConfig = { plugins: { CapacitorUpdater: { autoUpdate: 'onlyDownload', }, },};Dans ce mode, le plugin émet updateAvailable après téléchargement d'un bundle. Votre application peut ensuite décider quand appeler CapacitorUpdater.set() ou afficher son propre prompt de mise à jour.
Gestion Automatique de l'Ecran de Splash
Titre de la section « Gestion automatique de l'écran de chargement »Pour rendre les modes d'application instantanés plus faciles à utiliser, Capgo fournit une autoSplashscreen option qui gère automatiquement la suppression de l'écran de chargement pour vous (disponible depuis la version 7.6.0) :
const config: CapacitorConfig = { plugins: { CapacitorUpdater: { autoUpdate: 'always', // or 'atInstall' autoSplashscreen: true, // Automatically hide splashscreen keepUrlPathAfterReload: true, }, SplashScreen: { launchAutoHide: false, }, },};Lorsque autoSplashscreen est activé :
- Le plugin supprime automatiquement l'écran de chargement lorsque l'on applique une mise à jour
- Le plugin supprime automatiquement l'écran de chargement lorsque aucune mise à jour n'est nécessaire
- Vous n'avez pas besoin de vous tenir informé des
appReadyévénements ou d'appelerSplashScreen.hide()
Gestion manuelle de l'écran de chargement
Titre de la section « Gestion manuelle de l'écran de chargement »Si vous préférez un contrôle manuel ou avez besoin de logique personnalisée, vous pouvez désactiver autoSplashscreen et le gérer vous-même :
import { CapacitorUpdater } from '@capgo/capacitor-updater';import { SplashScreen } from '@capacitor/splash-screen';
CapacitorUpdater.addListener('appReady', () => { // Hide splash screen SplashScreen.hide();});
CapacitorUpdater.notifyAppReady();Le appReady L'événement se déclenche une fois l'application terminée de s'initialiser et d'appliquer les mises à jour en attente. C'est le point auquel il est sécurisé de montrer l'interface utilisateur de votre application, car il s'assure que l'utilisateur verra la dernière version.
En plus de gérer l'événement appReady nous recommandons de définir l'option de configuration sur keepUrlPathAfterReload lorsque vous utilisez un mode d'application instantanée. Cela préserve l'actuelle chemin d'URL lorsque l'application est rechargée en raison d'une mise à jour, ce qui aide à maintenir l'emplacement de l'utilisateur dans l'application et à réduire la désorientation. true Si vous n'avez pas géré l'événement
et défini appReady lorsque vous utilisez un mode d'application instantanée, l'utilisateur peut brièvement voir une version périmée de l'application, être renvoyé vers la route initiale ou voir un éclatement pendant que la mise à jour est appliquée. keepUrlPathAfterReload __CAPGO_KEEP_0__
En utilisant un mode d'application instantanée, vous pouvez livrer des correctifs critiques ou des mises à jour de sécurité, mais cela comporte quelques compromis :
- L’utilisateur peut voir un bref éclat ou un état de chargement pendant que la mise à jour est appliquée si vous n'avez pas géré correctement l'écran de splash (soit avec
autoSplashscreenou le traitement manuelappReadydes événements). - Si la mise à jour modifie l'état de l'application ou l'interface utilisateur, l’utilisateur peut voir un changement disruptif au milieu d'une session.
- La localisation de l'utilisateur dans l'application peut être perdue si
keepUrlPathAfterReloadn'est pas défini, ce qui peut les dérouter. - Vous devrez gérer soigneusement la sauvegarde et la restauration de l'état pour assurer une transition fluide.
Si vous activez l'application instantanée, nous vous recommandons :
- Utiliser
autoSplashscreen: truepour la configuration la plus simple, ou gérer manuellement l'événementappReadysi vous avez besoin de logique personnalisée. - Paramètres
keepUrlPathAfterReloadàtruecontexte : Page/zone : Page de produit de mises à jour en direct. Rôle : Étiquette de l'IU courte ou élément de navigation. Clé de message `live_update_dynamic_label_to` (Étiquette de mise à jour en direct dynamique To). - pour conserver l'emplacement de l'utilisateur dans l'application.
- Enregistrement et restauration de l'état de l'application au besoin pour éviter la perte de progression de l'utilisateur.
In most cases, the default update behavior provides the best balance of delivering updates quickly and minimizing disruption. But for apps with specific needs, Capgo provides the flexibility to customize when and how updates are applied.
Dans la plupart des cas, le comportement de mise à jour par défaut fournit la meilleure balance entre la livraison rapide des mises à jour et la minimisation de la perturbation. Mais pour les applications ayant des besoins spécifiques, __CAPGO_KEEP_0__ offre la flexibilité de personnaliser quand et comment les mises à jour sont appliquées.
Continuez de la section Comportement de mise à jourTitre de section intitulé « Continuez de la section Comportement de mise à jour » Si vous utilisez Comportement de mise à jour pour planifier la livraison de mises à jour en direct, connectez-l’à la mise à jour en direct Capgo de Capgo pour le flux de travail du produit dans les mises à jour en direct Capgo Vue d'ensemble pour le détail d'implémentation dans Vue d'ensemble Fonctionnalités pour le détail d'implémentation dans Fonctionnalités Types de mise à jour pour le détail d'implémentation dans Types de mise à jour, et Démarrage rapide pour le détail d'implémentation dans Démarrage rapide