Einstellungen

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

Tip

Jede Änderung dieser Einstellungen in capacitor.config-Datei erfordert, dass die Plattform synchronisiert und zum Store freigegeben wird, damit Produktionsanwendungen sie erhalten.

Hinweis

Need EU data residency for Capgo Cloud? Set updateUrl zu https://plugin.eu.capgo.app/updates, statsUrl auf https://plugin.eu.capgo.app/statsEU-Datenverwaltung für __CAPGO_KEEP_0__ Cloud channelUrl . https://plugin.eu.capgo.app/channel_selfSee Datenstandort.

allowModifyUrl

Erlassen Sie dem Plugin die Änderung der updateUrl, statsUrl und channelUrl dynamisch von der JavaScript-Seite.

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, nach denen das native Plugin eine Aktualisierung als ‘fehlgeschlagen’ betrachten sollte.

Verfügbar auf Android, iOS und Electron.

Standard: 10000 (10 Sekunden)

capacitor.config.json

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

autoDeleteFailed

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
    }
  }
}

autoDeletePrevious

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
    }
  }
}

autoSplashscreen

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 festgelegt ist "atInstall", "onLaunch", oder "always". Legacy-Werte werden für die Rückwärtskompatibilität weiterhin unterstützt. Benötigt das @__CAPGO_KEEP_0__/splash-screen-Plugin, um installiert und konfiguriert zu sein, mit launchAutoHide: false. Benötigt Auto Update, um aktiviert zu sein. 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.

Verfügbar auf Android, iOS und Electron.

Standard: false

capacitor.config.json

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

autoUpdate

Konfigurieren Sie, wie der Plugin Updates überprüft, herunterlädt und anwendet. Das Plugin überprüft Updates, wenn die App in den Vordergrund bewegt wird und auf einem wiederholten Timer, während die App geöffnet bleibt. periodCheckDelay Steuern Sie die Timerintervalle. Boolesche Werte werden für die Rückwärtskompatibilität noch unterstützt: true ist gleichbedeutend mit "atBackground" und false ist gleichbedeutend mit "off". String-Werte kombinieren die vorherigen Auto-Update- und Direkt-Update-Konfigurationen.

Optionen:

• "off" oder false: Aktualisierungsprüfungen automatisch deaktivieren
• "atBackground" oder true: Jedes Mal, wenn die Anwendung im Vordergrund ist, automatisch prüfen und herunterladen, dann die Aktualisierung bei der nächsten Übergabe in den Hintergrund anwenden
• "atInstall": Sofort anwenden, nur nach einer frischen Installation oder einer Aktualisierung über den native App Store; andernfalls verwenden "atBackground" Verhalten
• "onLaunch": Sofort anwenden, nur wenn die Anwendung von einem getöteten Zustand (kalter Start) in den Vordergrund gebracht wird. Nach dieser ersten Prüfung fällt man dann zurück auf "atBackground" Verhalten
• "always": Jedes Mal, wenn die Anwendung im Vordergrund wechselt, prüfen und sofort anwenden, sobald eine Aktualisierung verfügbar ist
• "onlyDownload": Automatisch prüfen und herunterladen, updateAvailable, ausgeben und nie die nächste Bundle oder eine Aktualisierung automatisch setzen

Verfügbar auf Android, iOS und Electron.

Standard: "atBackground" (true wird weiterhin akzeptiert)

capacitor.config.json

{
  "plugins": {
    "CapacitorUpdater": {
      "autoUpdate": "onlyDownload"
    }
  }
}

channelUrl

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"
    }
  }
}

defaultChannel

Legen Sie die Standardkanal für die App im Konfigurationsdatei fest. Groß- und Kleinschreibung beachten. Diese Einstellung überschreibt die Standardkanal-Einstellung im Cloud, aber respektiert noch die im Cloud vorgenommenen Überlagerungen.

Verfügbar auf Android, iOS und Electron.

Standard: undefined

capacitor.config.json

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

directUpdate

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

Optionen:

• false: Führen Sie keine direkten Updates durch
• 'atInstall': Gleich wie autoUpdate: "atInstall"
• 'onLaunch': Gleich wie autoUpdate: "onLaunch"
• 'always': Gleich wie autoUpdate: "always"
• true: (veraltet) Gleich wie "always" zurückwärtskompatibel

Verfügbar auf Android, iOS und Electron.

Standard: false

capacitor.config.json

{
  "plugins": {
    "CapacitorUpdater": {
      "autoUpdate": "atInstall"
    }
  }
}

disableJSLogging

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
    }
  }
}

keepUrlPathAfterReload

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

Vorsicht

Bei einem Neuladen wird ‘window.history’ gelöscht.

Verfügbar auf Android, iOS und Electron.

Standard: false

capacitor.config.json

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

periodCheckDelay

Konfigurieren Sie die Verzögerungszeit für die Überprüfung des Zeitraums. 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)
    }
  }
}

publicKey

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"
    }
  }
}

resetWhenUpdate

Automatisch löschen Sie die vorher heruntergeladenen Pakete, 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
    }
  }
}

responseTimeout

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

Verfügbar auf Android, iOS und Electron.

Standard: 20 (20 Sekunden)

capacitor.config.json

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

shakeMenu

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

Verfügbar auf Android, iOS und Electron.

Standard: false

capacitor.config.json

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

statsUrl

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

Verfügbar auf Android, iOS und Electron. Setzen Sie auf "" um explizite Statistikberichterstattung durch /stats.

Deaktivieren statsUrl deaktiviert nicht alle Capgo Gerätespeicher. Wenn updateUrl bleibt aktiv, /updates speichert die Abrechnungszeile MAU, die Geräteinventar und die Updateentscheidungsereignisdaten weiterhin, die zum Bereitstellen von Updates und zur Zählung von MAU erforderlich sind. Siehe Compliance zur detaillierten Auflistung der Felder.

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

capacitor.config.json

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

updateUrl

Konfigurieren Sie die URL / Endpunkt, an den die Updateprü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. Diese wird für den ersten Updateantrag verwendet. Wenn nicht gesetzt, wird der Plugin die Version vom nativen code abrufen.

Verfügbar auf Android, iOS und Electron.

Standard: undefined

capacitor.config.json

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

Einstellungen für die Entwicklung

localApi

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

Standard: undefined

capacitor.Konfigurationsdatei.json

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

localApiFiles

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

Standard: undefined

capacitor.Konfigurationsdatei.json

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

localHost

Konfigurieren Sie das CLI zur Verwendung eines lokalen Servers für die Testung oder Selbstbetrieb des Update-Servers.

Standard: undefined

capacitor.Konfigurationsdatei.json

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

localSupa

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

Standard: undefined

capacitor.config.json

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

localSupaAnon

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"
    }
  }
}

localWebHost

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

Standard: undefined

capacitor.config.json

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

Tipp

Es stehen weitere Einstellungen im Capgo Web-App zur Verfügung, die pro Kanal konfiguriert werden können, ohne dass eine native App veröffentlicht werden muss.

Fortsetzen von Einstellungen

Wenn Sie Einstellungen Um das Dashboard und die API-Operationen zu planen, 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üssel, und Geräte für die Implementierungsdetails in Geräte.