Update-Verhalten
Kopiere einen Setup-Prompt mit den Installationsschritten und dem vollständigen Markdown-Guide für dieses Plugin.
Wenn du ein Update für deine Capgo-App veröffentlichst, möchtest du wahrscheinlich, dass deine Nutzer es so schnell wie möglich erhalten. Gleichzeitig willst du aber nicht, dass ihre Erfahrung gestört wird, indem du sie zum Warten auf einen Download oder zum Neustart der App mitten in einer Sitzung zwingst.
Das Update-Verhalten von Capgo ist so konzipiert, dass es schnell Updates ausliefert und gleichzeitig Störungen für Ihre Nutzer minimiert.
Standard-Update-Flow
Abschnitt mit dem Titel „Standard-Update-Flow“Standardmäßig verarbeitet Capgo App-Updates wie folgt:
-
Wenn die App in den Vordergrund wechselt, prüft das Capgo-Plugin, ob ein neues Update verfügbar ist. Solange die App geöffnet bleibt, wird dies zusätzlich über einen wiederkehrenden Timer überprüft, der gesteuert wird durch
periodCheckDelay(Standard: 10 Minuten). -
Wenn ein Update gefunden wird, wird es im Hintergrund heruntergeladen, während der Nutzer weiterhin die aktuelle Version der App verwendet.
-
Sobald der Download abgeschlossen ist, wartet Capgo, bis der Nutzer die App in den Hintergrund verschiebt.
-
Wenn der Nutzer die App als Nächstes in den Vordergrund bringt, läuft die aktualisierte Version.
Dieser Flow stellt sicher, dass Nutzer immer die neueste Version deiner App verwenden, ohne jemals durch Update-Hinweise unterbrochen zu werden oder auf Downloads warten zu müssen.
Warum dieser Ansatz?
Abschnitt mit dem Titel „Warum dieser Ansatz?“Das Anwenden von Updates im Hintergrund oder bei einem Kill-Event hat einige entscheidende Vorteile für die User Experience:
-
Nutzer werden nicht durch Update-Prompts unterbrochen oder gezwungen, mitten in einer Session auf Downloads zu warten.
-
Updates werden nahtlos zwischen den Sitzungen angewendet, sodass sich das Starten der App immer wie neu anfühlt.
-
Du kannst häufig Updates ausliefern, ohne aktive Nutzer zu stören.
Der Hauptnachteil ist: Wenn ein Nutzer die App kurz in den Hintergrund schiebt und sofort wieder öffnet, kann ungespeicherter State verloren gehen, falls das Update genau dazwischen angewendet wurde.
Um dies zu minimieren, empfehlen wir:
-
Den State häufig zu speichern und ihn beim App-Resume sauber wiederherzustellen.
-
Sehr häufige Updates zu vermeiden, die große Teile des App-States verändern.
-
Erwäge, das Update-Verhalten für sensible Abläufe anzupassen (siehe unten).
Anpassen, wann Updates angewendet werden
Abschnitt mit dem Titel „Anpassen, wann Updates angewendet werden“In manchen Fällen benötigen Sie mehr Kontrolle darüber, wann genau ein Update angewendet wird. Sie möchten beispielsweise sicherstellen, dass ein Nutzer einen laufenden Ablauf abschließt, bevor das Update erfolgt, oder ein App-Update mit einer serverseitigen Änderung koordinieren.
Capgo bietet ein setDelay Funktion, mit der Sie Bedingungen festlegen können, die vor der Installation eines Updates erfüllt sein müssen:
import { CapacitorUpdater } from '@capgo/capacitor-updater';
await CapacitorUpdater.setMultiDelay({ delayConditions: [ { kind: 'date', value: '2023-06-01T00:00:00.000Z', }, { kind: 'background', value: '60000', }, ],});Dieses Beispiel verzögert die Installation eines Updates bis nach dem 1. Juni 2023 UND bis die App mindestens 60 Sekunden im Hintergrund war.
Die verfügbaren Verzögerungsbedingungen sind:
date: Warte bis nach einem bestimmten Datum/Zeitpunkt, bevor das Update angewendet wird.background: Warte eine Mindestdauer, nachdem die App in den Hintergrund gegangen ist, bevor das Update angewendet wird.nativeVersion: Warte, bis ein Native Build mit einer Mindestversion installiert ist, bevor das Update angewendet wird.kill: Warte auf das nächste App-Kill-Event, um das Update anzuwenden.
Du kannst diese Bedingungen kombinieren, um genau zu steuern, wann ein Update installiert wird.
Updates sofort anwenden
Abschnitt „Updates sofort anwenden“Für kritische Updates oder Apps mit sehr einfachem State möchtest du ein Update eventuell sofort nach dem Download anwenden, ohne auf ein Background- oder Kill-Event zu warten. Capgo unterstützt dies über die autoUpdate Policy in deiner Capacitor Config.
autoUpdate ist in deiner capacitor.config.ts Datei festgelegt, nicht im JavaScript code. Unterstützt werden diese Werte:
falseoder'off': Automatische Update-Checks deaktivierentrueoder'atBackground'(Standard): Bei jedem Foreground-Check automatisch prüfen und downloaden, dann das Update anwenden, wenn die App das nächste Mal in den Hintergrund wechselt'atInstall': Nur nach einer Neuinstallation oder einem nativen App-Store-Update sofort anwenden; andernfalls nutze"atBackground"Verhalten'onLaunch': Nur anwenden, wenn die App aus dem beendeten Zustand in den Vordergrund geholt wird (Cold Start). Nach dieser ersten Prüfung wird auf"atBackground"Verhalten'always': Bei jedem Wechsel in den Vordergrund prüfen und sofort anwenden, wenn ein Update verfügbar ist'onlyDownload': Automatisch prüfen und herunterladen, ausgebenupdateAvailable, und niemals das nächste Bundle setzen oder ein Update automatisch anwenden
Native Build ohne Live Updates testen
Abschnitt mit dem Titel „Ein Native Build ohne Live Updates testen“Siehe Native Builds ohne Live Updates testen für die Sicherheitsvorkehrungen der nativen Version, der Kanalrichtlinie und der CI-Konfiguration.
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 for instant apply with autoSplashscreen }, },};
export default config;Mit autoUpdate: 'always', Capgo prüft bei jedem Wechsel in den Vordergrund und wendet ein Update sofort an, sobald der Download während dieses Checks abgeschlossen ist – auch wenn der Nutzer die App gerade aktiv nutzt. Periodische Checks, gesteuert durch periodCheckDelay können dasselbe sofortige Anwenden auslösen, während die App geöffnet bleibt.
Beachte, dass autoUpdate eine native Konfiguration ist, erfordern Instant-Apply-Modi zusätzliches Handling in deinem JavaScript code.
Automatisch herunterladen, ohne anzuwenden
Abschnitt mit dem Titel „Automatisch herunterladen, ohne anzuwenden“Wenn Capgo Updates automatisch prüfen und herunterladen, aber nie automatisch anwenden soll, verwende autoUpdate: 'onlyDownload':
const config: CapacitorConfig = { plugins: { CapacitorUpdater: { autoUpdate: 'onlyDownload', }, },};In diesem Modus sendet das Plugin updateAvailable nachdem ein Bundle heruntergeladen wurde. Deine App kann dann entscheiden, wann CapacitorUpdater.set() aufgerufen wird oder ein eigener Update-Prompt angezeigt wird.
Automatisches Splashscreen-Handling
Abschnitt: „Automatisches Splashscreen-Handling“Instant-Apply-Modi ("atInstall", "onLaunch", "always") erfordern autoSplashscreen und @capacitor/splash-screen (verfügbar ab Version 7.6.0). Installiere das Plugin und halte den Splashscreen sichtbar, bis Capgo ihn ausblendet:
const config: CapacitorConfig = { plugins: { CapacitorUpdater: { autoUpdate: 'always', // or 'atInstall' autoSplashscreen: true, // Automatically hide splashscreen keepUrlPathAfterReload: true, }, SplashScreen: { launchAutoHide: false, }, },};Wenn autoSplashscreen ist aktiviert:
- Das Plugin blendet den Splashscreen automatisch aus, sobald ein Update angewendet wurde
- Das Plugin blendet den Splashscreen automatisch aus, wenn kein Update nötig ist
- Du musst nicht manuell auf
appReadyEvents lauschen oderSplashScreen.hide()
Extra work after the splash hides
Section titled “Extra work after the splash hides”Behalten autoSplashscreen: true. Wenn du zusätzliche Logik benötigst, nachdem das Update bereit ist, lausche auch auf appReady ebenso. Überspringe das Splash-Plugin nicht oder autoSplashscreen dafür:
import { CapacitorUpdater } from '@capgo/capacitor-updater';
CapacitorUpdater.addListener('appReady', () => { // Update is applied. autoSplashscreen already hid the splash.});
CapacitorUpdater.notifyAppReady();Der appReady Das Event wird ausgelöst, sobald die App die Initialisierung abgeschlossen und alle ausstehenden Updates angewendet hat.
Setzen Sie keepUrlPathAfterReload zu true bei Verwendung des Instant-Apply-Modus. Dies erhält den aktuellen URL-Pfad, wenn die App aufgrund eines Updates neu geladen wird.
Der Instant-Apply-Modus ist nützlich für kritische Bugfixes oder Security-Patches, bringt aber gewisse Nachteile mit sich:
- Der Nutzer sieht eventuell ein kurzes Flackern oder einen Ladezustand während des Updates, wenn
@capacitor/splash-screenfehlt oderautoSplashscreenist nicht aktiviert. - Wenn das Update den App-State oder die UI ändert, kann der Nutzer mitten in einer Session eine störende Veränderung erleben.
- Die Position des Nutzers in der App kann verloren gehen, wenn
keepUrlPathAfterReloadnicht festgelegt ist, was zu Verwirrung führen kann. - Du musst das Speichern und Wiederherstellen des States sorgfältig handhaben, um einen reibungslosen Übergang sicherzustellen.
Falls du Instant Apply aktivierst, empfehlen wir:
- Hochladen mit
npx @capgo/cli@latest bundle upload --delta, damit der Download die User Experience nicht verlangsamt. - Installieren von
@capacitor/splash-screenund FestlegenautoSplashscreen: truemitlaunchAutoHide: false. - Einstellung
keepUrlPathAfterReloadzutrueum den Standort des Nutzers in der App beizubehalten. - Speichern und Wiederherstellen des App-Zustands bei Bedarf, um den Fortschritt der Nutzer nicht zu verlieren.
- Gründliches Testen des Update-Verhaltens Ihrer App, um sicherzustellen, dass es keine abrupten Übergänge, verlorenen Zustände oder verwirrende Standortänderungen gibt.
In den meisten Fällen bietet das Standard-Update-Verhalten die beste Balance zwischen schneller Auslieferung von Updates und minimaler Unterbrechung. Für Apps mit speziellen Anforderungen bietet Capgo jedoch die Flexibilität, individuell festzulegen, wann und wie Updates angewendet werden.
Weiter geht's mit dem Update-Verhalten
Abschnitt mit dem Titel „Weiter von Update Behavior“Wenn du es nutzt Update-Verhalten um die Auslieferung von live update zu planen, verbinde sie mit Capgo Live Updates für den Produkt-Workflow in Capgo Live Updates, Übersicht für die Implementierungsdetails in Overview, Funktionen für die Implementierungsdetails in Features, Update-Typen für die Implementierungsdetails in Update Types, und Erste Schritte für die Implementierungsdetails in Getting Started.