Zum Inhalt springen

@capgo/capacitor-Updater

Echtzeit-Update für capacitor-Anwendungen.

Capgo-Live-Updates sind nicht nur auf Capacitor beschränkt. Verwenden Sie denselben Backend und CLI mit den Geschwister-Client-Plugins:

Live-Update für capacitor-Apps

  • notifyAppReady - Melden Sie dem native Layer, dass JavaScript erfolgreich initialisiert wurde.
  • setUpdateUrl - Setzen Sie die Update-URL für die App dynamisch bei Laufzeit.
  • setStatsUrl - Setzen Sie die Statistik-URL für die App dynamisch bei Laufzeit.
  • setChannelUrl - Setzen Sie die Kanal-URL für die App dynamisch bei Laufzeit.
MethodeBeschreibung
notifyAppReadyMelden Sie dem native Layer, dass JavaScript erfolgreich initialisiert wurde.
setUpdateUrlSetzen Sie die Update-URL für die App dynamisch bei Laufzeit.
setStatsUrlSetze die URL für Statistiken für die App dynamisch bei Laufzeit.
setChannelUrlSetze die URL für den Kanal für die App dynamisch bei Laufzeit.
downloadLade ein neues Bundle vom angegebenen URL für eine spätere Installation herunter.
nextSetze das nächste Bundle, das aktiviert werden soll, wenn die App sich im Hintergrund befindet oder neu gestartet wird.
setSetze das aktuelle Bundle und lädt die App sofort neu.
deleteLösche ein Bundle aus der lokalen Speicherung, um Speicherplatz frei zu machen.
setBundleErrorMarkiere ein Bundle manuell als fehlgeschlagen/fehlerhaft in der manuellen Update-Modus.
listErhalte alle lokal heruntergeladenen Bundles, die in deiner App gespeichert sind.
resetSetze die App auf ein bekanntes gutes Bundle zurück.
currentErhalte Informationen über das derzeit aktive Bundle.
reloadLade die App manuell neu, um eine sichere Update anzuwenden.
setMultiDelayKonfiguriere Bedingungen, die vor der Anwendung eines sicheren Updates erfüllt werden müssen.
cancelDelayAlle Auslauftbedingungen stornieren und die vorliegende Aktualisierung sofort anwenden.
getLatestÜberprüfen Sie den Aktualisierungsserver auf die neueste verfügbare Bundle-Version.
setChannelSetzen Sie einen lokalen Runtime-Aktualisierungskanal für dieses Gerät. Dies schafft keine Dashboard-API Geräteüberschreibung.
unsetChannelEntfernen Sie die Gerätezuweisung des Kanals und kehren Sie zur Standardkanal zurück.
getChannelErmitteln Sie die aktuell zugewiesene Kanal für dieses Gerät.
listChannelsErmitteln Sie die Liste aller verfügbaren Kanäle für dieses Gerät, um sich selbst zuzuweisen.
setCustomIdSetzen Sie einen benutzerdefinierten Identifikator für dieses Gerät.
getBuiltinVersionErmitteln Sie die eingebaute Bundle-Version (die ursprüngliche Version, die mit Ihrer nativen App geliefert wurde).
getDeviceIdErmitteln Sie die einzigartige, datenschutzfreundliche Identifikation für dieses Gerät.
getPluginVersionErmitteln Sie die Version des Capacitor Updater-Plugins, das in Ihrer App installiert ist.
isAutoUpdateEnabledÜberprüfen Sie, ob automatische Aktualisierungen derzeit aktiviert sind.
removeAllListenersEntfernen Sie alle für dieses Plugin registrierten Ereignislistener.
addListenerHören Sie auf das Ereignis zum Herunterladen der Bundle in der App. Wird einmal ausgelöst, wenn ein Herunterladen begonnen, während des Herunterladens und wenn fertig ist. Dies gibt Ihnen alle Download-Prozentsätze während des Herunterladens zurück.
addListenerHören Sie auf das Ereignis, wenn kein Update erforderlich ist, nützlich, wenn Sie jede Zeit die App starten möchten.
addListenerHören Sie auf das Ereignis, wenn ein Update verfügbar ist, nützlich, wenn Sie jede Zeit die App starten möchten.
addListenerHören Sie auf DownloadComplete-Ereignisse.
addListenerHören Sie auf das Ereignis, wenn ein Update als inkompatibel mit der aktuellen App markiert wird. Emittiert den gleichen Payload wie der "legacy"-Hörer. majorAvailable Hören Sie auf das Ereignis für eine große App-Update in der App, lassen Sie wissen, wenn eine große App-Update durch die Einstellung "disableAutoUpdateBreaking" blockiert wird.
addListenerHören Sie auf das Ereignis für ein Update-Fehler in der App, lassen Sie wissen, wenn ein Update fehlschlägt, um es bei der nächsten App-Startinstallation zu installieren.
addListenerHören Sie auf das Ereignis, wenn ein Bundle erfolgreich angewendet wurde. Dieses Ereignis wird natively bis JavaScript es konsumiert, behalten, sodass wenn die App sich vorher neu lädt, bevor Ihr Hörer sich anhängt, das letzte anstehende Ereignis einmal, wenn der Hörer sich anhängt, geliefert wird.
addListenerHören Sie auf das Ereignis, wenn ein Bundle als nächstes Bundle zum Installieren in der App angezeigt wird. set Hören Sie auf das Ereignis, wenn ein Bundle-Download fehlschlägt.
addListener__CAPGO_KEEP_0__
addListener__CAPGO_KEEP_1__
addListenerListen auf das Reload-Ereignis in der App, informiert Sie, wenn ein Reload erfolgt ist.
addListenerListen auf das App-Ready-Ereignis in der App, informiert Sie, wenn die App zum Einsatz bereit ist. Dieses Ereignis wird natively bis JavaScript es konsumiert, so dass es auch nach einem Reload noch geliefert werden kann, selbst wenn der Listener später in der App-Startzeit hinzugefügt wird.
addListenerListen auf das Channel-Private-Ereignis, ausgelöst, wenn versucht wird, einen Channel zu setzen, der keine Geräte-Selbstzuweisung zulässt.
addListenerListen auf flexible Aktualisierungsstatusänderungen auf Android.
isAutoUpdateAvailableÜberprüfen, ob die Auto-Update-Funktion verfügbar ist (nicht durch eine benutzerdefinierte Serverkonfiguration deaktiviert).
getNextBundleErmitteln Sie Informationen über das Bundle, das auf dem nächsten Reload aktiviert werden soll.
getFailedUpdateErmitteln Sie Informationen über das letzte Bundle, das nicht geladen werden konnte.
setShakeMenuAktivieren oder deaktivieren Sie das Shake-Gesten-Menü für Debugging und Testing.
isShakeMenuEnabledÜberprüfen Sie, ob das Shake-Gesten-Debug-Menü derzeit aktiviert ist.
setShakeChannelSelectorAktivieren oder deaktivieren Sie den Shake-Channel-Selector zur Laufzeit.
isShakeChannelSelectorEnabledÜberprüfen Sie, ob der Shake-Channel-Selector derzeit aktiviert ist.
getAppIdErmitteln Sie die derzeit konfigurierte App-ID, die für die Kommunikation mit dem Update-Server verwendet wird.
setAppIdDynamisch ändern Sie die App-ID für die Kommunikation mit dem Update-Server.
getAppUpdateInfoErmitteln Sie Informationen über die Verfügbarkeit der App im App Store oder Play Store.
openAppStoreÖffnen Sie die App-Seite im App Store oder Play Store.
performImmediateUpdateFühren Sie ein sofortiges In-App-Update auf Android durch.
startFlexibleUpdateStarten Sie ein flexibles In-App-Update auf Android.
completeFlexibleUpdateBeenden Sie ein flexibles In-App-Update auf Android.

Diese Referenz wird von src/definitions.ts in capacitor-Updater.

Wenn Sie @capgo/capacitor-Updater zur Planung von native Plugin-Arbeiten verwenden, verbinden Sie es mit Mit @capgo/capacitor-Updater für die native Fähigkeit in Mit @capgo/capacitor-Updater, Capgo Plugin-Ordner für den Produktworkflow in Capgo Plugin-Ordner, Capacitor Plugins von Capgo für die Implementierungsdetails in Capacitor Plugins von Capgo, Hinzufügen oder Aktualisieren von Plugins für die Implementierungsdetails in Hinzufügen oder Aktualisieren von Plugins, und Alternativen zum Ionic Enterprise Plugin für den Produktworkflow in Alternativen zum Ionic Enterprise Plugin.