Zum Inhalt springen

Einstellungen

Tipp

Abschnitt mit dem Titel “allowModifyUrl”

Verfügbar auf Android, iOS und Electron.

Standard: false

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

Konfigurieren Sie die Anwendungs-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"
}
}
}

Konfigurieren Sie die Anzahl der Millisekunden, die der native Plugin wartet, bevor er eine Aktualisierung als fehlgeschlagen betrachtet.

Verfügbar auf Android, iOS und Electron.

Standard: 10000 (10 Sekunden)

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

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

Verfügbar auf Android, iOS und Electron.

Standard: true

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

Konfigurieren Sie, ob der Plugin automatisch vorherige Pakete nach einer erfolgreichen Aktualisierung 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. autoUpdate Dies entfernt die Notwendigkeit, manuell auf appReady-Ereignisse zu lauschen und SplashScreen.hide() aufzurufen. "atInstall", "onLaunch"Nur funktioniert, wenn "always"auf 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.

verwendet wird. Legacy-Werte werden für die Rückwärtskompatibilität noch unterstützt. Anforderungen: Das @__CAPGO_KEEP_0__/splash-screen-Plugin muss installiert und mit launchAutoHide: false konfiguriert sein. Anforderungen: Die Auto-Update-Funktion muss aktiviert sein.

Standard: false

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

Konfigurieren Sie, wie der Plugin die Auto-Update-Funktion über einen Update-Server verwenden soll. Boolesche Werte werden weiterhin für die Rückwärtskompatibilität unterstützt: true ist gleichbedeutend mit "atBackground" oder false ist gleichbedeutend mit "off".

Optionen:

  • "off" oder false: Deaktivieren Sie die Auto-Update-Funktion
  • "atBackground" oder true: Überprüfen und automatisch herunterladen, dann anwenden, wenn die App in den Hintergrund verschwindet
  • "atInstall": Anwenden, sobald die App neu installiert oder eine native App aktualisiert wurde, ansonsten verwenden "atBackground"
  • "onLaunch": Anwenden, sobald die App gestartet wird, ansonsten verwenden "atBackground" nach dem Start überprüfen
  • "always": Anwenden, sobald Auto Update läuft
  • "onlyDownload": Überprüfen und automatisch herunterladen, ausgeben, und nie die nächste Bundle automatisch setzen updateAvailableVerfügbar auf Android, iOS und Electron.

Standard:

ist weiterhin akzeptiert) "atBackground" (true __CAPGO_KEEP_0__.config.json

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ß- und Kleinschreibung beachten. Diese Einstellung überschreibt die Standardkanal, die in der Cloud gesetzt wurde, aber die in der Cloud vorgenommenen Überschreibungen werden noch 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 Aktualisierungen
  • 'atInstall': Gleich wie autoUpdate: "atInstall"
  • 'onLaunch': Gleich wie autoUpdate: "onLaunch"
  • 'always': Gleich wie autoUpdate: "always"
  • true: (veraltet) Gleich wie “immer” für die Rückwärtskompatibilitä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 in die JavaScript-Konsole geschrieben. Nur die native Protokollierung 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 beibehalten.

Verfügbar auf Android, iOS und Electron.

Standard: false

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

Konfigurieren Sie die Verzögerungszeit für die Periodeaktualisierung. 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 vorherige 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, nach denen die native Plugin als API timeout betrachtet wird.

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 Aktualisierungsmenü zum Debuggen/Überprüfen zu zeigen.

Verfügbar auf Android, iOS und Electron.

Standard: false

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

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

Verfügbar auf Android, iOS und Electron. Setzen Sie auf "" um die Statistikberichterstattung 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 die Aktualisierungsprüfungen gesendet werden.

Verfügbar auf Android, iOS und Electron.

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

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

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

Verfügbar auf Android, iOS und Electron.

Standard: undefined

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

Konfigurieren Sie die CLI zur Verwendung einer lokalen api für die Testung.

Standard: undefined

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

Konfigurieren Sie den CLI zur Verwendung eines lokalen Dateis api für die Testung.

Standard: undefined

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

Konfigurieren Sie den CLI zur Verwendung eines lokalen Servers für die Testung oder Selbstverwaltung 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 eines selbstgefertigten 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"
}
}
}