Fortsetzen von Einstellungen

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

Tipp

Jede Änderung an diesen Einstellungen im capacitor.config-File erfordert eine Synchronisierung der Plattform und eine Veröffentlichung im Store, damit Produktionsanwendungen sie erhalten.

Hinweis

Benötigen Sie EU-Datensicherheit für Capgo Cloud? Aktivieren Sie updateUrl zum https://plugin.eu.capgo.app/updates, statsUrl zum https://plugin.eu.capgo.app/stats, und channelUrl zum https://plugin.eu.capgo.app/channel_self. Siehe auch Datenstandort.

allowModifyUrl

Erlassen Sie dem Plugin die Möglichkeit, 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
    }
  }
}

appId

Konfigurieren Sie die Anwendungs-ID für die Anwendung 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 der native Plugin wartet, bevor eine Aktualisierung als fehlgeschlagen gilt.

Verfügbar auf Android, iOS und Electron.

Standard: 10000 (10 Sekunden)

capacitor.config.json

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

autoDeleteFailed

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

autoDeletePrevious

Konfigurieren, ob der Plugin nach einer erfolgreichen Aktualisierung automatisch vorherige Pakete 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 der Plugin die Splash-Screens automatisch nach Updates oder wenn kein Update erforderlich ist. Dies entfernt die Notwendigkeit, manuell auf appReady-Ereignisse zu lauschen und die Methode SplashScreen.hide() aufzurufen. Nur funktioniert, wenn autoUpdate ist auf "atInstall", "onLaunch", oder "always". Legacy-Werte werden für die Rückwärtskompatibilität unterstützt. Benötigt das @__CAPGO_KEEP_0__/splash-screen-Plugin, das installiert und mit launchAutoHide: false konfiguriert sein muss. Benötigt die Aktualisierung auf automatisch aktiviert 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.

Standard:

__CAPGO_KEEP_0__.config.json false

capacitor.config.json

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

autoUpdate

Konfigurieren Sie, wie das Plugin Updates prüft, herunterlädt und anwendet. Das Plugin prü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 den Timer-Interval. true Wertebasierte Boolean-Werte sind für die Rückwärtskompatibilität noch unterstützt: "atBackground" ist gleichbedeutend mit false und "off"ist gleichbedeutend mit

. Die String-Werte kombinieren die vorherigen Auto-Update- und Direkt-Update-Konfigurationen.

• "off" Optionen: falseoder
• "atBackground" Abschalten der automatischen Update-Überprüfungen trueoder
• "atInstall": Sofort anwenden nur nach einer frischen Installation oder einer Update-Installation aus dem App-Store; andernfalls verwenden "atBackground" Verhalten
• "onLaunch": Sofort anwenden, wenn die App aus einem getöteten Zustand (kalte Start) in den Vordergrund gebracht wird. Nach dieser ersten Überprüfung fällt man dann auf das "atBackground" Verhalten
• "always": Überprüfen Sie bei jeder Vordergrund-Übergang und wenden Sie sich sofort an, wenn ein Update verfügbar ist
• "onlyDownload": Überprüfen und herunterladen automatisch, emittieren updateAvailable, und setzen Sie nie das nächste Bundle oder wenden Sie ein Update automatisch an

Verfügbar auf Android, iOS und Electron.

Standard: "atBackground" (true ist immer noch 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 den 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 Überschreibungen.

Verfügbar auf Android, iOS und Electron.

Standard: undefined

capacitor.config.json

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

directUpdate

Veraltet. Verwenden Sie stattdessen autoUpdate String-Modi anstatt: "atInstall", "onLaunch", oder "always". Diese Option bleibt für bestehende Apps unterstützt.

Optionen:

• false: Mache keine direkten Updates
• 'atInstall': Ebenso wie autoUpdate: "atInstall"
• 'onLaunch': Ebenso wie autoUpdate: "onLaunch"
• 'always': Ebenso wie autoUpdate: "always"
• true: (veraltet) Ebenso 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 beizubehalten.

Achtung

Wenn eine Neuladung 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 die Verzögerungszeit für die Periode der Aktualisierungskontrolle. 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.

Standardmäßig: undefined

capacitor.config.json

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

Achtung

publicKey konfiguriert Verschlüsselung V2 und muss der private Schlüssel entsprechen, der während der Upload verwendet wird. Für Delta-Updates verwenden Sie V2-Verschlüsselung mit partieller Verschlüsselung aktiviert und aktivieren Sie die verschlüsselte-Bundle-Erzwischung, wenn Ihre Organisation verlangt, dass jeder Upload verschlüsselt ist. Verlassen Sie sich nicht allein auf publicKey als Serverseitig-Politik, um einen unverschlüsselten Delta zu verhindern.

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/Endpunkt, an den Aktualisierungsstatistiken gesendet werden.

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

Deaktivieren statsUrl Deaktiviert nicht alle Capgo-Gerätespeicher. Wenn updateUrl bleibt aktiviert, /updates speichert die Abrechnungszeile MAU, die Geräteinventar und die Updateentscheidungsereignisdaten weiterhin, die zum Senden von Updates und zur MAU-Zählung erforderlich sind. Siehe Zu Compliance für die Detailauflistung auf Feldebene.

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 Update-Abfragen 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 aus der native code abrufen.

Verfügbar auf Android, iOS und Electron.

Standard: undefined

capacitor.config.json

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

Entwicklungs-Einstellungen

localApi

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

Standard: undefined

Einstellungen für den capacitor.config.json

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

localApiFiles

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

Standard: undefined

capacitor.config.json

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

localHost

Konfigurieren Sie den CLI zur Verwendung eines lokalen Servers für die Testung oder Selbstverwaltung des Updateservers.

Standard: undefined

capacitor.config.json

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

localSupa

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

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 eines selbstgefertigten Update-Servers.

Standard: undefined

capacitor.config.json

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

Tipp

Es gibt weitere Einstellungen im Capgo Web-App die pro Kanal konfiguriert werden können, ohne eine native App-Version freizugeben.

Fortsetzen von Einstellungen

Wenn Sie Einstellungen um das Dashboard und die API-Operationen zu planen und zu verbinden 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.