Settings

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

Tipp

Alle Änderungen an diesen Einstellungen in der Datei „capacitor.config“ erfordern eine Synchronisierung der Plattform und eine Freigabe im Store, damit Produktions-Apps sie empfangen können.

allowModifyUrl

Ermöglichen Sie dem Plugin, updateUrl, statsUrl undchannelUrl dynamisch von der JavaScript-Seite aus zu ändern.

Verfügbar auf Android, iOS und Electron.

Standard: false

capacitor.config.json

{
  "plugins": {
    "CapacitorUpdater": {
      "allowModifyUrl": true
    }
  }
}

appId

Konfigurieren Sie die App-ID für die App in der Konfiguration.

Verfügbar auf Android, iOS und Electron.

Standard: undefined

capacitor.config.json

{
  "plugins": {
    "CapacitorUpdater": {
      "appId": "com.example.app"
    }
  }
}

appReadyTimeout

Konfigurieren Sie die Anzahl der Millisekunden, die das native Plugin warten soll, bevor ein Update als „fehlgeschlagen“ betrachtet wird.

Verfügbar auf Android, iOS und Electron.

Standard: 10000 (10 Sekunden)

capacitor.config.json

{
  "plugins": {
    "CapacitorUpdater": {
      "appReadyTimeout": 1000
    }
  }
}

autoDeleteFailed

Konfigurieren Sie, ob das Plugin fehlerhafte Bundles automatisch löschen soll.

Verfügbar auf Android, iOS und Electron.

Standard: true

capacitor.config.json

{
  "plugins": {
    "CapacitorUpdater": {
      "autoDeleteFailed": false
    }
  }
}

autoDeletePrevious

Konfigurieren Sie, ob das Plugin nach einem erfolgreichen Update automatisch vorherige Bundles löschen soll.

Verfügbar auf Android, iOS und Electron.

Standard: true

capacitor.config.json

{
  "plugins": {
    "CapacitorUpdater": {
      "autoDeletePrevious": false
    }
  }
}

autoSplashscreen

Automatisches Ausblenden des Begrüßungsbildschirms bei Verwendung von DirectUpdate. Wenn diese Option aktiviert ist, blendet das Plugin den Begrüßungsbildschirm automatisch aus, nachdem Updates angewendet wurden oder wenn kein Update erforderlich ist. Dadurch entfällt die Notwendigkeit, manuell auf appReady-Ereignisse zu warten und SplashScreen.hide() aufzurufen. Funktioniert nur, wenn directUpdate auf „atInstall“, „always“ oder true gesetzt ist. Erfordert die Installation und Konfiguration des Plugins @capacitor/splash-screen mit launchAutoHide: false. Erfordert die Aktivierung von autoUpdate und directUpdate.

Verfügbar auf Android, iOS und Electron.

Standard: false

capacitor.config.json

{
  "plugins": {
    "CapacitorUpdater": {
      "autoUpdate": true,
      "directUpdate": "atInstall",
      "autoSplashscreen": true
    }
  }
}

autoUpdate

Konfigurieren Sie, ob das Plugin Auto Update über einen Update-Server verwenden soll.

Verfügbar auf Android, iOS und Electron.

Standard: true

capacitor.config.json

{
  "plugins": {
    "CapacitorUpdater": {
      "autoUpdate": false
    }
  }
}

channelUrl

Konfigurieren Sie die URL/den 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"
    }
  }
}

defaultChannel

Legen Sie in der Konfiguration den Standardkanal für die App fest. Groß- und Kleinschreibung beachten. Diese Einstellung überschreibt den in der Cloud festgelegten Standardkanal, berücksichtigt jedoch weiterhin die in der Cloud vorgenommenen Überschreibungen.

Verfügbar auf Android, iOS und Electron.

Standard: undefined

capacitor.config.json

{
  "plugins": {
    "CapacitorUpdater": {
      "defaultChannel": "production"
    }
  }
}

directUpdate

Konfigurieren Sie, wann das Plugin Updates direkt installieren soll. Nur für den AutoUpdate-Modus. Funktioniert gut für Apps mit weniger als 10 MB und mit Uploads, die mit der Flagge —delta erfolgen. Zip-Dateien oder Apps mit mehr als 10 MB werden für Benutzer relativ langsam aktualisiert.Optionen:

• false: Niemals direkte Updates durchführen (Standardverhalten verwenden: beim Start herunterladen, im Hintergrund festlegen)
• „atInstall“: Direktes Update nur, wenn die App installiert ist, aus dem Store aktualisiert, andernfalls als „directUpdate = false“ fungieren
• „onLaunch“: Direktes Update nur bei installierter App, Aktualisierung aus dem Store oder nach App-Kill, andernfalls als „directUpdate = false“ fungieren
• „Immer“: Direktes Update in allen vorherigen Fällen (App installiert, aus dem Store aktualisiert, nach App-Kill oder App-Fortsetzung), niemals als „directUpdate = false“ fungieren
• true: (veraltet) Aus Gründen der Abwärtskompatibilität dasselbe wie „always“.

Verfügbar für Android, iOS und Electron.

Standard: false

capacitor.config.json

{
  "plugins": {
    "CapacitorUpdater": {
      "autoUpdate": true,
      "directUpdate": "atInstall"
    }
  }
}

disableJSLogging

Deaktivieren Sie die JavaScript-Protokollierung des Plugins. Wenn „true“, meldet sich das Plugin nicht an der JavaScript-Konsole an. Es wird nur das native Protokoll erstellt.

Verfügbar auf Android, iOS und Electron.

Standard: false

capacitor.config.json

{
  "plugins": {
    "CapacitorUpdater": {
      "disableJSLogging": true
    }
  }
}

keepUrlPathAfterReload

Konfigurieren Sie das Plugin so, dass der URL-Pfad nach einem Neuladen erhalten bleibt.

Vorsicht

Wenn ein Neuladen ausgelöst wird, wird „window.history“ gelöscht.

Verfügbar auf Android, iOS und Electron.

Standard: false

capacitor.config.json

{
  "plugins": {
    "CapacitorUpdater": {
      "keepUrlPathAfterReload": true
    }
  }
}

periodCheckDelay

Konfigurieren Sie den Verzögerungszeitraum für die Periodenaktualisierungsprüfung. Die Einheit ist in Sekunden. Darf nicht kürzer 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)
    }
  }
}

publicKey

Konfigurieren Sie den öffentlichen Schlüssel für die End-to-End-Live-Update-Verschlüsselung Version 2.

Verfügbar auf Android, iOS und Electron.

Standard: undefined

capacitor.config.json

{
  "plugins": {
    "CapacitorUpdater": {
      "publicKey": "YOUR_PUBLIC_KEY"
    }
  }
}

resetWhenUpdate

Löschen Sie zuvor heruntergeladene Bundles automatisch, wenn ein neueres natives App-Bundle auf dem Gerät installiert wird.

Verfügbar auf Android, iOS und Electron.

Standard: true

capacitor.config.json

{
  "plugins": {
    "CapacitorUpdater": {
      "resetWhenUpdate": false
    }
  }
}

responseTimeout

Konfigurieren Sie die Anzahl der Millisekunden, die das native Plugin warten soll, bevor das Zeitlimit API berücksichtigt wird.

Verfügbar auf Android, iOS und Electron.

Standard: 20 (20 Sekunden)

capacitor.config.json

{
  "plugins": {
    "CapacitorUpdater": {
      "responseTimeout": 10 // (10 seconds)
    }
  }
}

shakeMenu

Aktivieren Sie die Schüttelgeste, um das Update-Menü zu Debug-/Testzwecken anzuzeigen.

Verfügbar auf Android, iOS und Electron.

Standard: false

capacitor.config.json

{
  "plugins": {
    "CapacitorUpdater": {
      "shakeMenu": true
    }
  }
}

statsUrl

Konfigurieren Sie die URL/den Endpunkt, an den Update-Statistiken gesendet werden.

Verfügbar auf Android, iOS und Electron. Auf „“ setzen, um die Statistikberichterstattung zu deaktivieren.

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

capacitor.config.json

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

updateUrl

Konfigurieren Sie die URL/den Endpunkt, an den Update-Prü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"
    }
  }
}

version

Konfigurieren Sie die aktuelle Version der App. Dies wird für die erste Update-Anfrage verwendet. Wenn nicht festgelegt, erhält das Plugin die Version aus dem nativen Code.

Verfügbar auf Android, iOS und Electron.

Standard: undefined

capacitor.config.json

{
  "plugins": {
    "CapacitorUpdater": {
      "version": "1.0.0"
    }
  }
}

Entwicklungseinstellungen

localApi> Konfigurieren Sie CLI so, dass zum Testen eine lokale API verwendet wird.

Standard: undefined

capacitor.config.json

{
  "plugins": {
    "CapacitorUpdater": {
      "localApi": "http://localhost:54321/functions/v1"
    }
  }
}

localApiFiles

Konfigurieren Sie CLI so, dass zum Testen eine lokale Datei-API verwendet wird.

Standard: undefined

capacitor.config.json

{
  "plugins": {
    "CapacitorUpdater": {
      "localApiFiles": "http://localhost:54321/functions/v1/files"
    }
  }
}

localHost

Konfigurieren Sie CLI so, dass ein lokaler Server zum Testen oder ein selbstgehosteter Update-Server verwendet wird.

Standard: undefined

capacitor.config.json

{
  "plugins": {
    "CapacitorUpdater": {
      "localHost": "http://localhost:5173"
    }
  }
}

localSupa

Konfigurieren Sie CLI so, dass ein lokaler Server zum Testen oder ein selbstgehosteter Update-Server verwendet wird.

Standard: undefined

capacitor.config.json

{
  "plugins": {
    "CapacitorUpdater": {
      "localSupa": "http://localhost:54321"
    }
  }
}

localSupaAnon

Konfigurieren Sie CLI so, dass zum Testen ein lokaler Server verwendet wird.

Standard: undefined

capacitor.config.json

{
  "plugins": {
    "CapacitorUpdater": {
      "localSupaAnon": "YOUR_LOCAL_ANON_KEY"
    }
  }
}

localWebHost

Konfigurieren Sie CLI so, dass ein lokaler Server zum Testen oder ein selbstgehosteter Update-Server verwendet wird.

Standard: undefined

capacitor.config.json

{
  "plugins": {
    "CapacitorUpdater": {
      "localWebHost": "http://localhost:5173"
    }
  }
}

Tipp

In der Capgo Web-App sind zusätzliche Einstellungen verfügbar, die pro Kanal konfiguriert werden können, ohne dass eine native App-Version erforderlich ist.