Einstellungen

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

Tipp

Jeder Änderung an diesen Einstellungen im capacitor.config-Datei erfordert die Synchronisierung der Plattform und die Freigabe im Store, damit Produktionsanwendungen sie erhalten.

Hinweis

Brauchen Sie EU-Datensicherheit für Capgo Cloud? Setzen Sie updateUrl auf https://plugin.eu.capgo.app/updates, statsUrl auf https://plugin.eu.capgo.app/statsund channelUrl zum https://plugin.eu.capgo.app/channel_self. Siehe Standort der Daten.

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 App-ID für die App im Konfigurationsdatei.

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 Bundles 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 Bundles löschen soll.

Verfügbar auf Android, iOS und Electron.

Standard: true

capacitor.config.json

{
  "plugins": {
    "CapacitorUpdater": {
      "autoDeletePrevious": false
    }
  }
}

autoSplashscreen

Automatisch die Versteckung des Splashscreens steuern, wenn Instant-Apply-Modi verwendet werden. Wenn aktiviert, versteckt der Plugin automatisch den Splashscreen nach Updates oder wenn kein Update erforderlich ist. Dies entfernt die Notwendigkeit, manuell auf appReady-Ereignisse zu hören und SplashScreen.hide() aufzurufen. Nur funktioniert, wenn autoUpdate ist auf "atInstall", "onLaunch", oder "always". Legacy directUpdate Werte sind weiterhin für die Rückwärtskompatibilität unterstützt. Benötigt das @capacitor/splash-screen-Plugin, um installiert und konfiguriert zu sein, mit launchAutoHide: false. Benötigt Auto-Update, um aktiviert zu sein.

Verfügbar auf Android, iOS und Electron.

Standard: false

capacitor.config.json

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

autoUpdate

Konfigurieren Sie, wie das Plugin nach, herunterlädt und live-Updates 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 die Timer-Intervalle. Boolesche Werte sind weiterhin für die Rückwärtskompatibilität unterstützt: true ist gleichbedeutend mit "atBackground" und false ist gleichbedeutend mit "off". String-Werte kombinieren die vorherige Auto-Update- und Direkt-Update-Konfiguration.

Optionen:

• "off" oder false: Deaktivieren Sie automatische Update-Überprüfungen
• "atBackground" oder true: Überprüfen und herunterladen Sie automatisch bei jedem Vordergrund-Überprüfung, dann wird die Aktualisierung bei der nächsten Übergabe in den Hintergrund angewendet
• "atInstall": Wenden Sie sie sofort nur nach einer frischen Installation oder einer nativen App-Store-Update an; andernfalls verwenden Sie "atBackground" Verhalten
• "onLaunch": Wenden Sie sie sofort an, wenn die App von einem getöteten Zustand (kalter Start) in den Vordergrund gebracht wird. Nach dieser ersten Überprüfung fällt man dann zurück zu "atBackground" Verhalten
• "always": Überprüfen Sie bei jeder Vordergrundübergang und wenden Sie es sofort an, sobald ein Update verfügbar ist
• "onlyDownload": Überprüfen und automatisch herunterladen, ausgeben updateAvailable, und setzen Sie niemals die 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 wird die im Cloud gesetzte Standardkanal überschreiben, aber die im Cloud gesetzten Überwritungen respektieren.

Verfügbar auf Android, iOS und Electron.

Standard: undefined

capacitor.config.json

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

directUpdate

Veraltet. Verwenden Sie stattdessen autoUpdate string-Modi "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 "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 Periodeaktualisierung. 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üsselte-Bundle-Erzwischung, wenn Ihre Organisation jede Upload verschlüsselt anfordert. Verlassen Sie sich nicht allein auf als Serverseitige Richtlinie, um einen unverschlüsselten Delta zu verhindern. publicKey Abschnitt mit dem Titel „resetWhenUpdate“

resetWhenUpdate

Verfügbar auf Android, iOS und Electron.

__CAPGO_KEEP_0__

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 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 die Aktualisierungsstatistiken gesendet werden.

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

Deaktivieren statsUrl Deaktivieren beinhaltet nicht die Deaktivierung aller Capgo Gerätespeicher. Wenn updateUrl bleibt aktiviert, /updates speichert immer noch die Abrechnungs-MAU-Zeile, die Geräteinventar und die Update-Ereignisdaten, die zum Bereitstellen von Updates und zur Abrechnung von MAU erforderlich sind. Siehe 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 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 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 CLI zum Testen mit einem lokalen api zu verwenden.

Standard: undefined

capacitor.config.json

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

localApiFiles

Konfigurieren Sie den CLI für die Verwendung eines lokalen Dateisystems api zum Testen.

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.

Abschnitt mit dem Titel “localHost” undefined

capacitor.Konfigurationsdatei.json

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

localSupaAnon

Konfigurieren Sie das CLI für die Verwendung eines lokalen Servers zum Testen.

Standard: undefined

capacitor.Konfigurationsdatei.json

{
  "plugins": {
    "CapacitorUpdater": {
      "localSupaAnon": "YOUR_LOCAL_ANON_KEY"
    }
  }
}

localWebHost

Konfigurieren Sie das CLI für die Verwendung eines lokalen Servers zum Testen oder eines selbst gehosteten Update-Servers.

Standard: undefined

capacitor.Konfigurationsdatei.json

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

Tip

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

Weitergehen von 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üssel, und Geräte für die Implementierungsdetails in Geräte.