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 das Synchronisieren der Plattform und die Freigabe im Store, damit Produktionsanwendungen sie erhalten.

Hinweis

Braucht man EU-Datensicherheit für Capgo Cloud? Setze updateUrl zu https://plugin.eu.capgo.app/updates, statsUrl zu https://plugin.eu.capgo.app/stats, und channelUrl zu https://plugin.eu.capgo.app/channel_self. Siehe Datenstandort.

allowModifyUrl

Ermöglichen Sie dem Plugin, 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 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 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 das 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, nachdem Updates angewendet wurden oder wenn kein Update erforderlich ist. Dies entfernt die Notwendigkeit, manuell auf appReady-Ereignisse zu lauschen und die SplashScreen.hide()-Methode aufzurufen. Nur funktioniert, wenn autoUpdate auf "atInstall", "onLaunch", oder "always" eingestellt ist. Legacy directUpdate Werte werden weiterhin unterstützt, um die Kompatibilität mit älteren Versionen zu gewährleisten. Benötigt das @capacitor/splash-screen-Plugin, um installiert und konfiguriert zu sein, mit launchAutoHide: false. Benötigt die Auto-Update-Funktion.

Verfügbar auf Android, iOS und Electron.

Standard: false

capacitor.config.json

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

autoUpdate

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 Auto-Update
• "atBackground" oder true: Überprüfen und automatisch herunterladen, dann anwenden, wenn die App in den Hintergrund verschoben wird
• "atInstall": Anwenden Sie es sofort nur nach einer frischen Installation oder einem native App-Update, ansonsten verwenden Sie "atBackground"
• "onLaunch": Anwenden Sie es sofort bei der Start, ansonsten verwenden Sie "atBackground" nach dem Launch überprüfen
• "always"Sofort anwenden, sobald Auto Update läuft
• "onlyDownload"Überprüfen und automatisch herunterladen, emitieren updateAvailable, und nie die nächste Bundle 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 ist wichtig. Diese Einstellung wird die Standardkanal im Cloud überschreiben, aber die im Cloud gesetzten Überschreibungen werden immer noch berücksichtigt.

Verfügbar auf Android, iOS und Electron.

Standard: undefined

capacitor.config.json

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

directUpdate

Veraltet. Verwenden Sie stattdessen autoUpdate string-Modi anstelle: "atInstall", "onLaunch"oder "always"Dieses 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 “immer” für die Rückwärtskompatibilität

Verfügbar auf Android, iOS und Electron.

Standard: false

capacitor.config.json

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

disableJSLogging

JavaScript-Protokollierung des Plugins deaktivieren. 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

Wenn ein Neuladen 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 Überprüfung der Zeitabschnitte. 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

Löscht automatisch die vorherigen 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 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 Deaktivieren beinhaltet nicht die Deaktivierung aller Capgo Gerätespeicher. Wenn updateUrl bleibt aktiviert, /updates speichert noch die Abrechnungs-MAU-Zeile, Geräteinventar und Update-Ereignisdaten zum Ausliefern von Updates und zur MAU-Zählung. Siehe Zu Compliance für die Feld-basierte Auflistung.

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 Aktualisierungsanfragen 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 die erste Aktualisierungsanfrage verwendet. Wenn nicht gesetzt, wird der Plugin die Version aus der nativen 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 die CLI zur Verwendung einer lokalen api für die Testung.

Standard: undefined

capacitor.config.json

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

localApiFiles

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

Standard: undefined

capacitor.config.json

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

localHost

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

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 Selbsthosting des 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 selbstgehosteten 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öffentlichung erforderlich ist.

Bleib weiterhin in Einstellungen

Wenn Sie Einstellungen für die Planung Ihres Dashboards und API-Operationen verwenden, 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üsseln und Geräte für die Implementierungsdetails in Geräten.