Zum Inhalt springen

Einstellungen

Um eine feinere Kontrolle über das Update-System zu haben, können Sie es mit diesen Einstellungen konfigurieren:

Ermöglichen Sie dem Plugin, die updateUrl, statsUrl und channelUrl dynamisch von der JavaScript-Seite zu ändern.

Verfügbar auf Android, iOS und Electron.

Standard: false

capacitor.config.json
{
"plugins": {
"CapacitorUpdater": {
"allowModifyUrl": true
}
}
}

Konfigurieren Sie die App-ID für die App im Konfigurationsdatei.

Verfügbar auf Android, iOS und Electron.

Standard: undefined

capacitor.config.json
{
"plugins": {
"CapacitorUpdater": {
"appId": "com.example.app"
}
}
}

Konfigurieren Sie die Anzahl der Millisekunden, die das native Plugin vor der Annahme eines Updates als ‘fehlgeschlagen’ wartet.

Verfügbar auf Android, iOS und Electron.

Standard: 10000 (10 Sekunden)

capacitor.config.json
{
"plugins": {
"CapacitorUpdater": {
"appReadyTimeout": 1000
}
}
}

Konfigurieren Sie, ob das Plugin fehlgeschlagene Pakete automatisch löschen soll.

Verfügbar auf Android, iOS und Electron.

Standard: true

capacitor.config.json
{
"plugins": {
"CapacitorUpdater": {
"autoDeleteFailed": false
}
}
}

Konfigurieren, ob der Plugin nach einer erfolgreichen Aktualisierung die vorherigen Bundles automatisch löschen soll.

Verfügbar auf Android, iOS und Electron.

Standard: true

capacitor.config.json
{
"plugins": {
"CapacitorUpdater": {
"autoDeletePrevious": false
}
}
}

Automatisch die Anzeige der Splash-Screens verstecken, wenn Instant-Apply-Modi verwendet werden. Wenn aktiviert, versteckt das Plugin die Splash-Screens automatisch nach Updates oder wenn keine Updates erforderlich sind. Dies entfernt die Notwendigkeit, manuell auf appReady-Ereignisse zu lauschen und SplashScreen.hide() aufzurufen. Nur funktioniert, wenn autoUpdate auf "atInstall", "onLaunch", oder "always". Legacy directUpdate values are still supported for backward compatibility. Requires the @capacitor/splash-screen plugin to be installed and configured with launchAutoHide: false. Requires Auto Update to be enabled.

Benötigt das @__CAPGO_KEEP_0__/splash-screen-Plugin, das installiert und mit launchAutoHide: false konfiguriert sein muss.

Benötigt die Aktualisierung automatisch zu aktivieren. false

capacitor.config.json
{
"plugins": {
"CapacitorUpdater": {
"autoUpdate": "atInstall",
"autoSplashscreen": true
}
}
}

Zwischenablage kopieren true Abschnitt mit dem Titel „autoUpdate“ "atBackground" Konfigurieren, wie das Plugin die Aktualisierung über einen Update-Server verwenden soll. false Boolesche Werte werden weiterhin für die Kompatibilität mit älteren Versionen unterstützt: "off".

ist gleichbedeutend mit und ist gleichbedeutend mit und Optionen:

  • "off" oder false: Aktualisierung deaktivieren
  • "atBackground" oder true: Automatisch überprüfen und herunterladen, dann anwenden, wenn die App in den Hintergrund verschoben wird
  • "atInstall": Sofort anwenden, nur nach einer frischen Installation oder einer nativen App-Update, ansonsten verwenden "atBackground"
  • "onLaunch": Sofort anwenden, sobald die App gestartet wird, ansonsten verwenden "atBackground" nach der Startprüfung
  • "always": Sofort anwenden, sobald die Aktualisierung läuft
  • "onlyDownload": Automatisch überprüfen und herunterladen, ausgeben updateAvailable, und stelle das nächste Bundle nie automatisch ein

Verfügbar auf Android, iOS und Electron.

Standard: "atBackground" (true wird weiterhin akzeptiert)

capacitor.config.json
{
"plugins": {
"CapacitorUpdater": {
"autoUpdate": "onlyDownload"
}
}
}

Konfigurieren Sie die URL / Endpunkt für Kanaloperationen.

Verfügbar auf Android, iOS und Electron.

Standard: https://plugin.capgo.app/channel_self

capacitor.config.json
{
"plugins": {
"CapacitorUpdater": {
"channelUrl": "https://example.com/api/channel"
}
}
}

Legen Sie die Standardkanal für die App im Konfigurationsdatei fest. Groß-/Kleinschreibung beachten. Diese Einstellung überschreibt die Standardkanal, die in der Cloud gesetzt wurde, aber die in der Cloud vorgenommenen Überschreibungen respektiert.

Verfügbar auf Android, iOS und Electron.

Standard: undefined

capacitor.config.json
{
"plugins": {
"CapacitorUpdater": {
"defaultChannel": "production"
}
}
}

Veraltet. Verwenden Sie stattdessen autoUpdate Zeichenmodi anstelle: "atInstall", "onLaunch", oder "always" Diese Option bleibt für bestehende Apps unterstützt.

Optionen:

  • false: Machen Sie keine direkten Updates
  • 'atInstall': Gleich wie autoUpdate: "atInstall"
  • 'onLaunch': Gleich wie autoUpdate: "onLaunch"
  • 'always': Gleich wie autoUpdate: "always"
  • true: (deprecated) Gleich wie “immer” für die Kompatibilität

Verfügbar auf Android, iOS und Electron.

Standard: false

capacitor.config.json
{
"plugins": {
"CapacitorUpdater": {
"autoUpdate": "atInstall"
}
}
}

Deaktivieren Sie die JavaScript-Protokollierung des Plugins. Wenn wahr, wird das Plugin nicht im JavaScript-Konsolenprotokoll protokolliert. Nur das native Protokoll wird durchgeführt.

Verfügbar auf Android, iOS und Electron.

Standard: false

capacitor.config.json
{
"plugins": {
"CapacitorUpdater": {
"disableJSLogging": true
}
}
}

Konfigurieren Sie das Plugin, um die URL-Pfad nach einem Neuladen zu behalten.

Verfügbar auf Android, iOS und Electron.

Standard: false

capacitor.config.json
{
"plugins": {
"CapacitorUpdater": {
"keepUrlPathAfterReload": true
}
}
}

Konfigurieren Sie die Verzögerungszeit für die Periodeaktualisierungskontrolle. Die Einheit ist in Sekunden. Kann nicht kleiner als 600 Sekunden (10 Minuten) sein.

Verfügbar auf Android, iOS und Electron.

Standard: 600 (10 Minuten)

capacitor.config.json
{
"plugins": {
"CapacitorUpdater": {
"periodCheckDelay": 600 // (10 minutes)
}
}
}

Konfigurieren Sie die öffentliche Schlüssel für Ende-zu-Ende-Live-Update-Verschlüsselung Version 2.

Verfügbar auf Android, iOS und Electron.

Standard: undefined

capacitor.config.json
{
"plugins": {
"CapacitorUpdater": {
"publicKey": "YOUR_PUBLIC_KEY"
}
}
}

Automatisch vorher heruntergeladene Pakete löschen, wenn ein neueres natives App-Paket auf das Gerät installiert wird.

Verfügbar auf Android, iOS und Electron.

Standard: true

capacitor.config.json
{
"plugins": {
"CapacitorUpdater": {
"resetWhenUpdate": false
}
}
}

Konfigurieren Sie die Anzahl der Millisekunden, die der native Plugin wartet, bevor er API als Zeitüberschreitung betrachtet.

Verfügbar auf Android, iOS und Electron.

Standard: 20 (20 Sekunden)

capacitor.config.json
{
"plugins": {
"CapacitorUpdater": {
"responseTimeout": 10 // (10 seconds)
}
}
}

Aktivieren Sie die Erschütterungsgeste, um das Aktualisierungs-Menü zum Debuggen/Prüfen zu zeigen.

Verfügbar auf Android, iOS und Electron.

Standard: false

capacitor.config.json
{
"plugins": {
"CapacitorUpdater": {
"shakeMenu": true
}
}
}

Konfigurieren Sie die URL/Zielpunkt, an den Aktualisierungsstatistiken gesendet werden.

Verfügbar auf Android, iOS und Electron. Setzen Sie auf "" um die Statistikübermittlung zu deaktivieren.

Standard: https://plugin.capgo.app/stats

capacitor.config.json
{
"plugins": {
"CapacitorUpdater": {
"statsUrl": "https://example.com/api/stats"
}
}
}

Konfigurieren Sie die URL / Endpunkt, an den Aktualisierungsprüfungen gesendet werden.

Verfügbar auf Android, iOS und Electron.

Standard: https://plugin.capgo.app/updates

capacitor.config.json
{
"plugins": {
"CapacitorUpdater": {
"updateUrl": "https://example.com/api/auto_update"
}
}
}

Konfigurieren Sie die aktuelle Version der App. Diese wird für den ersten Aktualisierungsantrag verwendet. Wenn nicht gesetzt, wird der Plugin die Version aus der nativen code.

Verfügbar auf Android, iOS und Electron.

Standard: undefined

capacitor.config.json
{
"plugins": {
"CapacitorUpdater": {
"version": "1.0.0"
}
}
}

Entwickler-Einstellungen

Entwicklungs-Einstellungen

localApi

localApi

Konfigurieren Sie den CLI zum Testen mit einem lokalen api zu verwenden.

Standard: undefined

capacitor.config.json
{
"plugins": {
"CapacitorUpdater": {
"localApi": "http://localhost:54321/functions/v1"
}
}
}

localApiFiles

localApiFiles

Konfigurieren Sie den CLI zum Testen mit einem lokalen Datei api zu verwenden.

Standard: undefined

capacitor.config.json
{
"plugins": {
"CapacitorUpdater": {
"localApiFiles": "http://localhost:54321/functions/v1/files"
}
}
}

localHost

localHost

Konfigurieren Sie den CLI für die Verwendung eines lokalen Servers zum Testen oder Selbsthosting des Update-Servers.

Standard: undefined

capacitor.config.json
{
"plugins": {
"CapacitorUpdater": {
"localHost": "http://localhost:5173"
}
}
}

Konfigurieren Sie den CLI für die Verwendung eines lokalen Servers zum Testen oder Selbsthosting des Update-Servers.

Standard: undefined

capacitor.config.json
{
"plugins": {
"CapacitorUpdater": {
"localSupa": "http://localhost:54321"
}
}
}

Konfigurieren Sie den CLI für die Verwendung eines lokalen Servers zum Testen.

Standard: undefined

capacitor.config.json
{
"plugins": {
"CapacitorUpdater": {
"localSupaAnon": "YOUR_LOCAL_ANON_KEY"
}
}
}

Konfigurieren Sie den CLI für die Verwendung eines lokalen Servers zum Testen oder eines selbstgehosteten Update-Servers.

Standard: undefined

capacitor.config.json
{
"plugins": {
"CapacitorUpdater": {
"localWebHost": "http://localhost:5173"
}
}
}

Wenn Sie " Einstellungen zum Planen von Dashboard und API-Operationen verwenden, verbinden Sie es mit Mit @capgo/capacitor-Updater für die native Fähigkeit in Mit @capgo/capacitor-Updater, API-Übersicht für die Implementierungsdetails in API-Übersicht, Einführung für die Implementierungsdetails in Einführung, API-Schlüssel für die Implementierungsdetails in API Schlüsseln und Geräte für die Implementierungsdetails in Geräten.