Einstellungen

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

Tip

Jede Änderung an diesen Einstellungen im capacitor.config-Datei 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 vom Client-Seitigen JavaScript 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.

Standardmäßig: undefined

capacitor.config.json

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

appReadyTimeout

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.

Standardmäßig: 10000 (10 Sekunden)

capacitor.config.json

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

autoDeleteFailed

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

autoDeletePrevious

Konfigurieren Sie, 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-Screen verstecken, wenn Instant-Apply-Modi verwendet werden. Wenn aktiviert, versteckt der Plugin die Splash-Screen automatisch, nachdem Updates angewendet wurden 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 festgelegt ist, oder "atInstall", "onLaunch". Legacy-Werte werden für die Rückwärtskompatibilität noch unterstützt. Benötigt das @__CAPGO_KEEP_0__/splash-screen-Plugin, das installiert und konfiguriert sein muss, mit launchAutoHide: false. Benötigt die Aktualisierung auf automatisch aktiviert sein. "always"Verfügbar auf Android, iOS und Electron. 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.

__CAPGO_KEEP_0__.config.json

Zwischenablage kopieren false

capacitor

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

autoUpdate

Konfigurieren Sie, wie das 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 steuert den Timer-Interval. true Boolesche Werte sind für die Rückwärtskompatibilität noch unterstützt: "atBackground" ist gleichbedeutend mit false und "off"ist gleichbedeutend mit

. String-Werte kombinieren die vorherige Auto-Update- und Direkt-Update-Konfiguration.

• "off" Optionen: falseoder
• "atBackground" Deaktivieren Sie die automatischen Update-Überprüfungen trueoder
• "atInstall": Sofort nur nach einer frischen Installation oder einer Update-Installation aus dem App-Store anwenden; andernfalls verwenden "atBackground" Verhalten
• "onLaunch": Sofort nur, wenn die App aus einem getöteten Zustand (kalter Start) in den Vordergrund gebracht wird. Nach dieser ersten Überprüfung fällt man dann zurück auf "atBackground" Verhalten
• "always": Überprüfen Sie bei jeder Vordergrund-Übergabe und wenden Sie die Updates sofort an, wenn diese verfügbar sind
• "onlyDownload": Überprüfen und automatisch herunterladen, ausgeben 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 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 Überschreibungen.

Verfügbar auf Android, iOS und Electron.

Standard: undefined

capacitor.config.json

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

directUpdate

Veraltet. Verwenden Sie stattdessen autoUpdate Zeichenfolgenmodi anstatt: "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 "always" für die Rückwärtskompatibilität

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 in der JavaScript-Konsole protokolliert. Nur die native Protokollierung 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.

Vorsicht

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 periodische 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.

Standard: undefined

capacitor.config.json

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

Vorsicht

publicKey konfiguriert Verschlüsselung V2 und muss der privaten 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üsselung von Bundeln, wenn Ihre Organisation verlangt, dass jeder Upload verschlüsselt ist. Verlassen Sie sich nicht allein auf publicKey als Serverseitig-Policy, 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 Zeitüberschreitung 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 Aktualisierungsmenü zum Debuggen/Prü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 aktiv, /updates speichert die Abrechnungszeile MAU, die Geräteinventar und die Updateentscheidungsereignisdaten weiterhin, die zum Servieren von Updates und zur Zählung von MAU erforderlich sind. Siehe Zu Compliance für die Feldübersicht.

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 Update-Antrag verwendet. Wenn nicht gesetzt, wird die Version vom native code abgerufen.

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

capacitor.Konfigurationsdatei.json

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

localApiFiles

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

Standardmäßig: 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 Selbstverwaltung des Updateservers.

Standardmäßig: 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"
    }
  }
}

Tip

Es gibt weitere Einstellungen im Capgo Web-App die pro Kanal konfiguriert werden können, ohne dass eine native App-Veröffentlichung erforderlich ist.

Weitergehen von Einstellungen

Wenn Sie Einstellungen Einstellungen für das Planungsdashboard und die API-Operationen, 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.