Übersicht
Abschnitt mit dem Titel “Übersicht”Echtzeit-Update für capacitor-Anwendungen.
Kernfunktionen
Abschnitt mit dem Titel “Kernfunktionen”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.
Öffentliche API
Abschnitt mit dem Titel “Öffentliche API”| Methode | Beschreibung |
|---|---|
notifyAppReady | Benachrichtige die native Layer, dass JavaScript erfolgreich initialisiert wurde. |
setUpdateUrl | Setze die Update-URL für die App dynamisch bei Laufzeit. |
setStatsUrl | Setze die Statistik-URL für die App dynamisch bei Laufzeit. |
setChannelUrl | Setze die Kanal-URL für die App dynamisch bei Laufzeit. |
download | Lade ein neues Bundle von der bereitgestellten URL für eine spätere Installation herunter. |
next | Setze das nächste Bundle, das aktiviert werden soll, wenn die App sich im Hintergrund befindet oder neu gestartet wird. |
set | Setze das aktuelle Bundle und lädt die App sofort neu. |
delete | Lösche ein Bundle aus der lokalen Speicherung, um Platz auf der Festplatte frei zu machen. |
setBundleError | Markiere ein Bundle manuell als fehlgeschlagen/fehlerhaft in der manuellen Update-Modus. |
list | Erhalte alle lokal heruntergeladenen Bundles, die in deiner App gespeichert sind. |
reset | Setze die App auf ein bekanntes gutes Bundle zurück. |
current | Erfahren Sie Informationen über die derzeit aktive Bundle. |
reload | Laden Sie die App manuell neu, um eine vorliegende Aktualisierung anzuwenden. |
setMultiDelay | Konfigurieren Sie Bedingungen, die vor der Anwendung einer vorliegenden Aktualisierung erfüllt sein müssen. |
cancelDelay | Stornieren 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. |
setChannel | Zuweisen Sie diesem Gerät eine bestimmte Aktualisierungs-Kanal auf Laufzeit. |
unsetChannel | Entfernen Sie die Zuweisung des Geräts an einen Kanal und kehren Sie zur Standardkanal zurück. |
getChannel | Erfahren Sie die derzeit zugewiesene Kanal für dieses Gerät. |
listChannels | Erfahren Sie eine Liste aller verfügbaren Kanäle für dieses Gerät, um es selbst zuzuweisen. |
setCustomId | Setzen Sie einen benutzerdefinierten Identifikator für dieses Gerät. |
getBuiltinVersion | Erfahren Sie die eingebaute Bundle-Version (die ursprüngliche Version, die mit Ihrer nativen App geliefert wurde). |
getDeviceId | Erfahren Sie die einzigartige, datenschutzfreundliche Identifikation für dieses Gerät. |
getPluginVersion | Hol dir die Version des Capacitor-Updater-Plugins, das in deiner App installiert ist. |
isAutoUpdateEnabled | Überprüfe, ob automatische Updates derzeit aktiviert sind. |
removeAllListeners | Entferne alle für dieses Plugin registrierten Ereignislistener. |
addListener | Höre auf das Ereignis "Bundle-Download" in der App. Es wird einmalig 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. |
addListener | Höre auf das Ereignis "Keine Aktualisierung erforderlich", nützlich, wenn du jede Zeit, wenn die App gestartet wird, eine Zwangskontrolle durchführen möchtest. |
addListener | Höre auf das Ereignis "Aktualisierung verfügbar", nützlich, wenn du jede Zeit, wenn die App gestartet wird, eine Zwangskontrolle durchführen möchtest. |
addListener | Höre auf das Ereignis "Download abgeschlossen". |
addListener | Höre auf das Ereignis "Aktualisierung blockiert", 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. |
addListener | Höre auf das Ereignis "Aktualisierungsfehler" in der App, damit du weißt, wenn die Aktualisierung fehlschlägt, um in der nächsten App-Startinstallation installiert zu werden. |
addListener | Höre auf das Ereignis "Einstellung" in der App, damit du weißt, wenn eine Bundle erfolgreich angewendet wurde. Dieses Ereignis wird natively bis JavaScript es konsumiert, aufbewahrt, also wenn die App sich vorher neu lädt, bevor dein Listener angehängt wird, ist der letzte pendende |
addListener | Höre auf das Ereignis "Einstellung" in der App, damit du weißt, wenn eine Bundle erfolgreich angewendet wurde. Dieses Ereignis wird natively bis JavaScript es konsumiert, aufbewahrt, also wenn die App sich vorher neu lädt, bevor dein Listener angehängt wird, ist der letzte pendende set Der Ereignis wird einmalig geliefert, wenn der Listener sich anmeldet. |
addListener | Hören Sie auf das nächste Ereignis in der App, damit Sie wissen, wenn ein Bundle als nächstes Bundle zum Installieren in der Warteschlange ist. |
addListener | Hören Sie auf das Download-Fehler-Ereignis in der App, damit Sie wissen, wenn ein Bundle-Download fehlgeschlagen ist. |
addListener | Hören Sie auf das Reload-Ereignis in der App, damit Sie wissen, wenn eine Reload-Vorgang stattgefunden hat. |
addListener | Hö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 ein Reload stattgefunden hat, selbst wenn der Listener später in der App-Startsequenz angehängt wird. |
addListener | Hö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. |
addListener | Hö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 Server-Konfiguration deaktiviert). |
getNextBundle | Erhalten Sie Informationen über das Bundle, das auf dem nächsten Reload aktiviert werden soll. |
getFailedUpdate | Rufen Sie Informationen über das jüngst fehlgeschlagene Bundle ab. |
setShakeMenu | Aktivieren oder deaktivieren Sie das Shake-Gesten-Menü zum Debuggen und Testen. |
isShakeMenuEnabled | Überprüfen Sie, ob das Shake-Gesten-Debug-Menü derzeit aktiviert ist. |
setShakeChannelSelector | Aktivieren oder deaktivieren Sie den Shake-Kanal-Selektor zur Laufzeit. |
isShakeChannelSelectorEnabled | Überprüfen Sie, ob der Shake-Kanal-Selektor derzeit aktiviert ist. |
getAppId | Ermitteln 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. |
getAppUpdateInfo | Ermitteln 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. |
performImmediateUpdate | Führen Sie einen sofortigen In-App-Update auf Android durch. |
startFlexibleUpdate | Starten Sie einen flexiblen In-App-Update auf Android. |
completeFlexibleUpdate | Beenden Sie einen flexiblen In-App-Update auf Android. |
Quelle der Wahrheit
Abschnitt mit dem Titel „Quelle der Wahrheit“Diese Referenz wird von GitHub synchronisiert. src/definitions.ts in capacitor-Updater.