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_selfDatensicherheit Sektion mit Titel “allowModifyUrl”.

allowModifyUrl

Verfügbar auf Android, iOS und Electron.

Standard:

__CAPGO_KEEP_0__.config.json 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 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
    }
  }
}

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

Erforderlich bei Verwendung von Instant-Apply-Modi ("atInstall", "onLaunch", einschließlich des veralteten "always"), einschließlich der veralteten directUpdate Installieren und festlegen @capacitor/splash-screen und launchAutoHide: false. Wenn aktiviert, versteckt der Plugin den Splashscreen nach Anwendung von Updates oder wenn kein Update erforderlich ist. Dies entfernt die Notwendigkeit, manuell auf appReady-Ereignisse zu lauschen und SplashScreen.hide() aufzurufen.

Verfügbar auf Android und iOS.

Standard: false

capacitor.config.json

{
  "plugins": {
    "CapacitorUpdater": {
      "autoUpdate": "atInstall",
      "autoSplashscreen": true
    },
    "SplashScreen": {
      "launchAutoHide": false
    }
  }
}

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 wiederholenden Timer, während die App geöffnet bleibt. periodCheckDelay steuert den Timerintervall. Boolesche Werte werden weiterhin für die Rückwärtskompatibilität unterstützt: true ist gleichbedeutend mit "atBackground" und false ist gleichbedeutend mit "off"und

Optionen:

• "off" oder falseOptionen:
• "atBackground" oder true: Prüfen und herunterladen Sie automatisch bei jedem Vordergrundprüfung, dann wird die Aktualisierung die nächste Zeit die App im Hintergrund bewegt
• "atInstall": Wenden Sie sofort nur nach einer frischen Installation oder einer nativen App-Store-Update an; ansonsten verwenden Sie "atBackground" Verhalten
• "onLaunch": Wenden Sie sofort nur an, wenn die App von einem getöteten Zustand (kalter Start) in den Vordergrund gebracht wird. Nach der ersten Überprüfung fällt zurück zu "atBackground" Verhalten
• "always": Überprüfen Sie bei jeder Vordergrund-Übergang und wenden Sie sofort an, wenn eine Aktualisierung verfügbar ist
• "onlyDownload": Überprüfen und herunterladen Sie automatisch, senden Sie updateAvailable, und setzen Sie nie die nächste Bundle oder wenden Sie eine Aktualisierung automatisch an

Instant-Apply-Modi ("atInstall", "onLaunch", "always") gelten während der Benutzer wartet. Hochladen mit npx @capgo/cli@latest bundle upload --delta so laden nur geänderte Dateien herunter. Eine vollständige Zip-Upload verlangsamt die Benutzererfahrung. Auf Android und iOS sind diese Modi erforderlich autoSplashscreen: true und (und) @capacitor/splash-screen mit launchAutoHide: false.

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 in der Konfiguration fest. Groß- und kleinschreibungssensitiv. Diese Einstellung überschreibt die in der Cloud festgelegte Standardkanal, respektiert aber die in der Cloud vorgenommenen Überschreibungen.

Verfügbar auf Android, iOS und Electron.

Standard: undefined

capacitor.config.json

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

directUpdate

Veraltet. Verwenden Sie autoUpdate Zeichenmodi anstatt: "atInstall", "onLaunch", oder "always". Diese Option bleibt für bestehende Apps unterstützt. Die sofortige Anwendung sollte mit --delta so hochgeladen werden, damit die Aktualisierung die Benutzererfahrung nicht verzögert. Diese Modi erfordern autoSplashscreen: true und @capacitor/splash-screen mit launchAutoHide: false.

Einstellungen:

• false: Nie direkt aktualisieren
• 'atInstall': Ebenso wie autoUpdate: "atInstall"
• 'onLaunch': Ebenso wie autoUpdate: "onLaunch"
• 'always': Ebenso wie autoUpdate: "always"
• true: (veraltet) Ebenso wie "always" zurückliegende Kompatibilitä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 im JavaScript-Konsolenfenster 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, damit der URL-Pfad nach einem Neuladen beibehalten wird.

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 periodische Überprüfung. 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"
    }
  }
}

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 auf publicKey alleine als Serverseitig-Policy, um einen unverschlüsselten Delta zu verhindern.

resetWhenUpdate

Automatisch löschen Sie vorher heruntergeladene Bundles, wenn ein neueres natives App-Bundle 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 das native Plugin wartet, bevor es 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 Update-Menü für Debugging- und Testzwecke anzuzeigen.

Verfügbar auf Android, iOS und Electron.

Standard: false

capacitor.config.json

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

statsUrl

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

Verfügbar auf Android, iOS und Electron. Setzen Sie auf "" um explizites Statistik-Reporting durch /stats.

Deaktivieren statsUrl Deaktiviert nicht alle Capgo-Gerätespeicher. Wenn updateUrl bleibt aktiviert, /updates speichert der Gerätespeicher weiterhin die Abrechnungs-MAU-Zeile, die Geräteinventar und die Update-Entscheidungsereignisdaten, die zum Servieren von Updates und zur MAU-Zählung erforderlich sind. Siehe Zu Compliance für die Detailanalyse.

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 Aktualisierungsprü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 Aktualisierungsantrag verwendet. Wenn nicht gesetzt, wird der Plugin die Version vom 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 Tests.

Standard: undefined

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 zur Verwendung eines lokalen Servers für die Testung oder Selbstverwaltung des Updateservers.

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 selbst gehosteten Update-Servers.

Standard: undefined

capacitor.config.json

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

Tip

Es gibt weitere Einstellungen im Capgo Web-App Fortsetzen von Einstellungen

Abschnitt mit dem Titel “Fortsetzen von Einstellungen”

Einstellungen zur Planung von Dashboard und API-Einstellungen verwenden, verbinden Sie es mit Mit @capgo/capacitor-Updater für die native Fähigkeit in Mit @capgo/capacitor-Updater, API Übersicht zur Implementierungsdetail in API Übersicht Einführung zur Implementierungsdetail in Einführung API Schlüssel zur Implementierungsdetail in API Schlüssel und Geräte zur Implementierungsdetail in Geräte.