Zum Inhalt springen

@capgo/capacitor-Updater

Live-Update für capacitor-Apps.

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

Übersicht

Übersicht

Echtzeit-Update für capacitor-Anwendungen.

Kernfunktionen

Übersicht
  • 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
notifyAppReadyBenachrichtige die native Layer, dass JavaScript erfolgreich initialisiert wurde.
setUpdateUrlSetze die Update-URL für die App dynamisch bei Laufzeit.
setStatsUrlSetze die Statistik-URL für die App dynamisch bei Laufzeit.
setChannelUrlSetze die Kanal-URL für die App dynamisch bei Laufzeit.
downloadLade ein neues Bundle von der bereitgestellten 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 lade 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.
currentErfahren Sie Informationen über die derzeit aktive Bundle.
reloadLaden Sie die App manuell neu, um eine vorliegende Aktualisierung anzuwenden.
setMultiDelayKonfigurieren Sie Bedingungen, die vor der Anwendung einer vorliegenden Aktualisierung erfüllt sein müssen.
cancelDelayStornieren Sie alle Verzögerungsbedingungen und wenden Sie die vorliegende Aktualisierung sofort an.
getLatestÜberprüfen Sie den Aktualisierungsserver auf die neueste verfügbare Bundle-Version.
setChannelSetzen Sie einen lokalen Runtime-Aktualisierungschannel für dieses Gerät. Es wird keine Dashboard-API Geräteüberschreibung erstellt.
unsetChannelEntfernen Sie die Geräte-Zuweisung und kehren Sie zur Standardkanal zurück.
getChannelErfahren Sie die derzeit zugewiesene Kanal für dieses Gerät.
listChannelsErfahren 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.
getBuiltinVersionErfahren Sie die interne Bundle-Version (die ursprüngliche Version, die mit Ihrer nativen App geliefert wurde).
getDeviceIdErfahren Sie die einzigartige, datenschutzfreundliche Identifikation für dieses Gerät.
getPluginVersionHol dir die Version des Capacitor-Updater-Plugins, das in deiner App installiert ist.
isAutoUpdateEnabledÜberprüfe, ob automatische Updates derzeit aktiviert sind.
removeAllListenersEntferne alle für dieses Plugin registrierten Ereignis-Listener.
addListenerHöre auf das Ereignis "Bundle-Download" in der App. Es wird einmal ausgelöst, wenn ein Download gestartet wird, während er läuft und wenn er abgeschlossen ist. Dies gibt dir während des Downloads alle Download-Prozentsätze zurück.
addListenerHöre auf das Ereignis "Keine Aktualisierung erforderlich", nützlich, wenn du jede Zeit, wenn die App gestartet wird, eine Zwangskontrolle durchführen möchtest.
addListenerHöre auf das Ereignis "Verfügbare Aktualisierung", nützlich, wenn du jede Zeit, wenn die App gestartet wird, eine Zwangskontrolle durchführen möchtest.
addListenerHöre auf das Ereignis "Download-Abgeschlossen".
addListenerHöre auf das Ereignis "Zerstörerische Aktualisierung", wenn der Backend eine Aktualisierung als inkompatibel mit der aktuellen App markiert. Emittiert den gleichen Payload wie der Legacy-Listener. majorAvailable Höre auf das Ereignis "Große Aktualisierung" in der App, damit du weißt, wenn eine große Aktualisierung blockiert wird, indem du disableAutoUpdateBreaking setzt.
addListenerHöre auf das Ereignis "Aktualisierung fehlgeschlagen" in der App, damit du weißt, wenn die Aktualisierung fehlschlägt, um in der nächsten App-Startinstallation installiert zu werden.
addListenerHöre auf das Ereignis "Set" in der App, damit du weißt, wenn ein Bundle erfolgreich angewendet wurde. Dieses Ereignis wird natively bis JavaScript es konsumiert, behalten, also wenn die App sich vorher neu lädt, bevor dein Listener angehängt wird, ist der letzte pendende
addListenerHöre auf das Ereignis "Set" in der App, damit du weißt, wenn ein Bundle erfolgreich angewendet wurde. Dieses Ereignis wird natively bis JavaScript es konsumiert, behalten, also wenn die App sich vorher neu lädt, bevor dein Listener angehängt wird, ist der letzte pendende set Das Ereignis wird einmalig geliefert, wenn der Listener sich anmeldet.
addListenerHören Sie auf das nächste Ereignis in der App, damit Sie wissen, wenn ein Paket als nächstes Paket zum Installieren in der Warteschlange ist.
addListenerHören Sie auf das Download-Fehlerereignis in der App, damit Sie wissen, wenn ein Paket heruntergeladen hat fehlgeschlagen.
addListenerHören Sie auf das Reload-Ereignis in der App, damit Sie wissen, wenn eine Neuladung erfolgt ist.
addListenerHören Sie auf das App-Ready-Ereignis in der App, damit Sie wissen, wenn die App zum Einsatz bereit ist. Dieses Ereignis wird nativ bis JavaScript es konsumiert, behalten, sodass es auch noch geliefert werden kann, nachdem eine Neuladung erfolgt ist, selbst wenn der Listener später in der App-Startphase angehängt wird.
addListenerHören Sie auf das Kanal-Private-Ereignis, das ausgelöst wird, wenn versucht wird, einen Kanal zu setzen, der keine Geräte-Selbstzuweisung zulässt.
addListenerHören Sie auf flexible Update-Zustandsänderungen auf Android.
isAutoUpdateAvailableÜberprüfen Sie, ob die Auto-Update-Funktion verfügbar ist (nicht durch eine benutzerdefinierte Serverkonfiguration deaktiviert).
getNextBundleErmitteln Sie Informationen über das Paket, das auf die Aktivierung auf der nächsten Neuladung wartet.
getFailedUpdateErmitteln Sie Informationen über das letzte Paket, das geladen hat fehlgeschlagen.
setShakeMenuAktivieren oder deaktivieren Sie das Shake-Gesten-Menü für Debugging und Testen.
isShakeMenuEnabledÜberprüfen Sie, ob das Shake-Gesten-Debug-Menü derzeit aktiviert ist.
setShakeChannelSelectorAktivieren oder deaktivieren Sie den Shake-Kanal-Selektor zur Laufzeit.
isShakeChannelSelectorEnabledÜberprüfen Sie, ob der Shake-Kanal-Selektor derzeit aktiviert ist.
getAppIdErmitteln Sie die derzeit konfigurierte App-ID, die für die Kommunikation mit dem Update-Server verwendet wird.
setAppIdÄndern Sie dynamisch die App-ID, die für die Kommunikation mit dem Update-Server verwendet wird.
getAppUpdateInfoErmitteln Sie Informationen über die Verfügbarkeit der App im App Store oder Play Store.
openAppStoreÖffnen Sie die Seite der App im App Store oder Play Store.
performImmediateUpdateFühren Sie einen sofortigen 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 GitHub synchronisiert. src/definitions.ts in capacitor-aktualisierer.

Wenn Sie native Plugin-Arbeit mit @capgo/capacitor-aktualisierer planen, verbinden Sie es mit Mit @capgo/capacitor-aktualisierer für die native Fähigkeit in Mit @capgo/capacitor-aktualisierer, Capgo-Plugin-Verzeichnis für den Produktworkflow in Capgo-Plugin-Verzeichnis, Capacitor-Plugins von Capgo für die Implementierungsdetails in Capacitor Plugins durch Capgo, Hinzufügen oder Aktualisieren von Plugins für die Implementierungsdetails in Hinzufügen oder Aktualisieren von Plugins, und Alternativen zu Ionic Enterprise Plugins für den Produktworkflow in Alternativen zu Ionic Enterprise Plugins.