Funktionen und Einstellungen

Updater-Plugin-Konfiguration

Siehe die Github Readme Weitere Informationen finden Sie unter.

CapacitorUpdater kann mit diesen Optionen konfiguriert werden:

Eigenschaft	Typ	Beschreibung	Standard	Seit
appReadyTimeout	number	Konfigurieren Sie die Anzahl der Millisekunden, nach denen das native Plugin eine Aktualisierung als fehlgeschlagen betrachtet. Verfügbar auf Android, iOS und Electron.	10000 // (10 seconds)
responseTimeout	number	Konfigurieren Sie die Anzahl der Millisekunden, nach denen das native Plugin einen API-Timeout betrachtet. Verfügbar auf Android, iOS und Electron.	20000 // (20 seconds)
autoDeleteFailed	boolean	Konfigurieren Sie, ob das Plugin automatisch fehlgeschlagene Pakete löschen soll. Verfügbar auf Android, iOS und Electron.	true
autoDeletePrevious	boolean	Konfigurieren Sie, ob das Plugin automatisch vorherige Pakete nach einer erfolgreichen Aktualisierung löschen soll. Verfügbar auf Android, iOS und Electron.	true
autoUpdate	boolean	Konfigurieren Sie, ob das Plugin eine automatische Aktualisierung über einen Update-Server verwenden soll. Verfügbar auf Android, iOS und Electron.	true
resetWhenUpdate	boolean	Löschen Sie automatisch vorher heruntergeladene Pakete, wenn ein neueres natives App-Paket auf das Gerät installiert wird. Verfügbar auf Android, iOS und Electron.	true
updateUrl	string	Konfigurieren Sie die URL / Endpunkt, an den Aktualisierungsanfragen gesendet werden. Verfügbar auf Android, iOS und Electron.	https://plugin.capgo.app/updates
channelUrl	string	Konfigurieren Sie die URL / Endpunkt für Kanaloperationen. Verfügbar auf Android, iOS und Electron.	https://plugin.capgo.app/channel_self
statsUrl	string	Konfigurieren Sie die URL / Endpunkt, an den Aktualisierungsstatistiken gesendet werden. Verfügbar auf Android, iOS und Electron. Setzen Sie auf "" zum Deaktivieren der Statistikberichterstellung.	https://plugin.capgo.app/stats
publicKey	string	Konfigurieren Sie die öffentliche Schlüssel für Ende-zu-Ende-Live-Aktualisierungsverschlüsselung Version 2. Verfügbar auf Android, iOS und Electron.	undefined	6.2.0
version	string	Konfigurieren Sie die aktuelle Version der App. Diese wird für den ersten Updateantrag verwendet. Wenn nicht gesetzt, wird der Plugin die Version vom native code. Verfügbar auf Android, iOS und Electron.	undefined	4.17.48
directUpdate	boolean | ‘always’ | ‘atInstall’ | ‘onLaunch’	Konfigurieren Sie, wann das Plugin Updates direkt installieren soll. Nur für den Auto-Update-Modus. Funktioniert gut für Apps kleiner als 10 MB und mit Uploads, die mit dem Flag –delta durchgeführt werden. Zip- oder Apps größer als 10 MB werden für die Benutzer relativ langsam zum Aktualisieren sein. - false: Führen Sie keine direkten Updates durch (verwenden Sie die Standardverhalten: Herunterladen am Start, setzen, wenn im Hintergrund) - atInstall: Direkte Update nur, wenn die App installiert wird, aktualisiert aus dem Store, andernfalls wie directUpdate = false - onLaunch: Direkte Update nur, wenn die App installiert, aktualisiert aus dem Store oder nach App-Töten, andernfalls wie directUpdate = false - immer: Direkte Update in allen vorherigen Fällen (App installiert, aktualisiert aus dem Store, nach App-Töten oder App-Wiederherstellung), nie wie directUpdate = false - true: (deprecated) Gleichbedeutend mit „immer“ für die Rückwärtskompatibilität Verfügbar auf Android, iOS und Electron.	false	5.1.0
autoSplashscreen	boolean	Automatisch verstecken Sie den Splashscreen, wenn Sie directUpdate verwenden. Wenn aktiviert, versteckt der Plugin automatisch den Splashscreen, nachdem Updates angewendet wurden oder wenn kein Update erforderlich ist. Dies entfällt die Notwendigkeit, manuell auf appReady-Ereignisse zu lauschen und SplashScreen.hide() aufzurufen. Funktioniert nur, wenn directUpdate auf „atInstall“, „always“ oder true gesetzt ist. Erfordert das @capacitor/splash-screen-Plugin, das mit launchAutoHide: false konfiguriert ist. Erfordert die Aktivierung von autoUpdate und directUpdate. Verfügbar auf Android und iOS.	false	7.6.0
periodCheckDelay	number	Konfigurieren Sie die Verzögerungszeit für die Überprüfung der Zeitabstände. Die Einheit beträgt Sekunden. Verfügbar auf Android, iOS und Electron. Die Zeit darf nicht weniger als 600 Sekunden (10 Minuten) betragen.	600 // (10 minutes)
localS3	boolean	Konfigurieren Sie den CLI für die Verwendung eines lokalen Servers zum Testen oder einem selbst gehosteten Update-Server.	undefined	4.17.48
localHost	string	Konfigurieren Sie den CLI für die Verwendung eines lokalen Servers zum Testen oder eines selbst gehosteten Updateservers.	undefined	4.17.48
localWebHost	string	Konfigurieren Sie den CLI für die Verwendung eines lokalen Servers zum Testen oder eines selbst gehosteten Updateservers.	undefined	4.17.48
localSupa	string	Konfigurieren Sie den CLI für die Verwendung eines lokalen Servers zum Testen oder einem selbst gehosteten Update-Server.	undefined	4.17.48
localSupaAnon	string	Konfigurieren Sie die CLI für die Verwendung eines lokalen Servers zum Testen.	undefined	4.17.48
localApi	string	Konfigurieren Sie die CLI zur Verwendung eines lokalen api für die Testung.	undefined	6.3.3
localApiFiles	string	Konfigurieren Sie die CLI zur Verwendung eines lokalen Dateisystems api für die Testung.	undefined	6.3.3
allowModifyUrl	boolean	Ermöglichen Sie dem Plugin, die updateUrl, statsUrl und channelUrl dynamisch von der JavaScript-Seite zu ändern.	false	5.4.0
defaultChannel	string	Stellen Sie die Standardkanal für die App in der Konfiguration ein. Fallunterscheidend. Diese Einstellung wird die im Cloud gesetzte Standardkanal überschreiben, respektiert aber noch die im Cloud vorgenommenen Überschreibungen.	undefined	5.5.0
appId	string	Konfigurieren Sie die App-ID für die App in der Konfiguration.	undefined	6.0.0
keepUrlPathAfterReload	boolean	Konfigurieren Sie das Plugin, damit die URL-Pfad nach einem Neuladen beibehalten wird. WARNUNG: Wenn ein Neuladen ausgelöst wird, wird ‘window.history’ gelöscht.	false	6.8.0
disableJSLogging	boolean	Deaktivieren Sie die JavaScript-Protokollierung des Plugins. Wenn wahr, wird das Plugin nicht im JavaScript-Konsolenprotokoll protokolliert. Nur das native Protokoll wird durchgeführt.	false	7.3.0
shakeMenu	boolean	Aktivieren Sie den Schiebe-Gestus, um das Aktualisierungsmenü für Debugging- und Testzwecke anzuzeigen	false	7.5.0

Beispiele

In capacitor.config.json:

{
  "plugins": {
    "CapacitorUpdater": {
      "appReadyTimeout": 1000 // (1 second),
      "responseTimeout": 10 // (10 second),
      "autoDeleteFailed": false,
      "autoDeletePrevious": false,
      "autoUpdate": false,
      "resetWhenUpdate": false,
      "updateUrl": https://example.com/api/auto_update,
      "channelUrl": https://example.com/api/channel,
      "statsUrl": https://example.com/api/stats,
      "publicKey": undefined,
      "version": undefined,
      "directUpdate": undefined,
      "autoSplashscreen": undefined,
      "periodCheckDelay": undefined,
      "localS3": undefined,
      "localHost": undefined,
      "localWebHost": undefined,
      "localSupa": undefined,
      "localSupaAnon": undefined,
      "localApi": undefined,
      "localApiFiles": undefined,
      "allowModifyUrl": undefined,
      "defaultChannel": undefined,
      "appId": undefined,
      "keepUrlPathAfterReload": undefined,
      "disableJSLogging": undefined,
      "shakeMenu": undefined
    }
  }
}

In capacitor.config.ts:

import { CapacitorConfig } from '@capacitor/cli';

const config: CapacitorConfig = {
  plugins: {
    CapacitorUpdater: {
      appReadyTimeout: 1000 // (1 second),
      responseTimeout: 10 // (10 second),
      autoDeleteFailed: false,
      autoDeletePrevious: false,
      autoUpdate: false,
      resetWhenUpdate: false,
      updateUrl: https://example.com/api/auto_update,
      channelUrl: https://example.com/api/channel,
      statsUrl: https://example.com/api/stats,
      publicKey: undefined,
      version: undefined,
      directUpdate: undefined,
      autoSplashscreen: undefined,
      periodCheckDelay: undefined,
      localS3: undefined,
      localHost: undefined,
      localWebHost: undefined,
      localSupa: undefined,
      localSupaAnon: undefined,
      localApi: undefined,
      localApiFiles: undefined,
      allowModifyUrl: undefined,
      defaultChannel: undefined,
      appId: undefined,
      keepUrlPathAfterReload: undefined,
      disableJSLogging: undefined,
      shakeMenu: undefined,
    },
  },
};

export default config;

• notifyAppReady()
• setUpdateUrl(...)
• setStatsUrl(...)
• setChannelUrl(...)
• download(...)
• next(...)
• set(...)
• delete(...)
• list(...)
• reset(...)
• current()
• reload()
• setMultiDelay(...)
• cancelDelay()
• getLatest(...)
• setChannel(...)
• unsetChannel(...)
• getChannel()
• listChannels()
• setCustomId(...)
• getBuiltinVersion()
• getDeviceId()
• getPluginVersion()
• isAutoUpdateEnabled()
• removeAllListeners()
• addListener('download', ...)
• addListener('noNeedUpdate', ...)
• addListener('updateAvailable', ...)
• addListener('downloadComplete', ...)
• addListener('majorAvailable', ...)
• addListener('updateFailed', ...)
• addListener('downloadFailed', ...)
• addListener('appReloaded', ...)
• addListener('appReady', ...)
• isAutoUpdateAvailable()
• getNextBundle()
• setShakeMenu(...)
• isShakeMenuEnabled()
• Interfaces
• Typ- Alias

Methoden

notifyAppReady()

notifyAppReady() => Promise<AppReadyResult>

Benachrichtige den Capacitor-Updater darüber, dass die aktuelle Bundle funktioniert (wird bei Nichtaufruf dieser Methode bei jedem App-Start ein Rollback durchgeführt) Standardmäßig sollte diese Methode innerhalb der ersten 10 Sekunden nach App-Start aufgerufen werden, andernfalls wird ein Rollback durchgeführt. Ändern Sie dieses Verhalten mit {@link appReadyTimeout}

Rückgabe: Promise<AppReadyResult>

---

setUpdateUrl(…)

setUpdateUrl(options: UpdateUrl) => Promise<void>

Setze die updateUrl für die App, diese wird verwendet, um nach Updates zu suchen.

Parameter:	Typ	Beschreibung
options	UpdateUrl	enthält die URL zum Überprüfen von Updates.

Seitdem: 5.4.0

---

setStatsUrl(…

setStatsUrl(options: StatsUrl) => Promise<void>

Stellen Sie die statsUrl für die App ein, diese wird verwendet, um Statistiken zu senden. Das Übergeben einer leeren Zeichenkette wird die Erfassung von Statistiken deaktivieren.

Parameter	Typ	Beschreibung
options	StatsUrl	enthält die URL zum Senden von Statistiken.

Seit: 5.4.0

---

setChannelUrl(…)

setChannelUrl(options: ChannelUrl) => Promise<void>

Setze den Kanal-URL für die App, dies wird zum Setzen des Kanals verwendet.

Parameter	Typ	Beschreibung
options	ChannelUrl	enthält die zu verwendende URL zum Setzen des Kanals.

Seit: 5.4.0

---

download(…)

download(options: DownloadOptions) => Promise<BundleInfo>

Laden Sie ein neues Bundle von der bereitgestellten URL herunter, es sollte ein Zip-Datei sein, mit Dateien darin oder mit einer eindeutigen ID darin mit allen Ihren Dateien

Param	Typ	Beschreibung
options	DownloadOptions	Die {@link DownloadOptions} für das Herunterladen eines neuen Bundle Zip.

Rückgabewert: Promise<BundleInfo>

---

next(…)

next(options: BundleId) => Promise<BundleInfo>

Legen Sie das nächste Bundle fest, das bei der Neuladung der App verwendet werden soll.

Param	Typ	Beschreibung
options	BundleId	Enthält die ID des nächsten Bundle, das bei der nächsten App-Launch-Operation festgelegt werden soll. {@link BundleInfo.id}

Rückgabewert: Promise<BundleInfo>

---

set(…)

set(options: BundleId) => Promise<void>

Setzen Sie das aktuelle Bundle und laden Sie die App sofort neu.

Param	Typ	Beschreibung
options	BundleId	Ein {@link BundleId} Objekt, das den neuen Bundle-Id enthält, der als aktuell gesetzt werden soll.

---

delete(…)

delete(options: BundleId) => Promise<void>

Löscht den angegebenen Bundle aus der native App-Speicher. Verwenden Sie dazu {@link list} , um die gespeicherten Bundle-IDs zu erhalten.

Parameter	Typ	Beschreibung
options	BundleId	Ein {@link "object"} mit der ID eines zu löschenden Pakets (Hinweis: Dies ist die Paket-ID, NICHT der Versionsname) __CAPGO_KEEP_0__list(…)

---

Abschnitt mit dem Titel “list(…)

list(options?: ListOptions | undefined) => Promise<BundleListResult>

Param

Typ	Beschreibung	Das {@link "object"}
options	ListOptions	ListOptions Alle lokalen Pakete in Ihrer App auflistenfür die Auflistung von Bundeln

Rückgabe: Promise<BundleListResult>

---

reset(…)

reset(options?: ResetOptions | undefined) => Promise<void>

Setzen Sie die App auf den builtin Bundel (den, der an die Apple App Store / Google Play Store gesendet wurde) oder den letzten erfolgreich geladenen Bundel.

Parameter	Typ	Beschreibung
options	ResetOptions	Enthaltend {@link ResetOptions.toLastSuccessful}, true zur internen Bundle zurücksetzt und false wird auf das letzte erfolgreich geladene Bundle zurückgesetzt.

---

aktuell()

current() => Promise<CurrentBundleResult>

Gibt das aktuelle Bundle zurück, wenn keines gesetzt ist, gibt es builtin. currentNative ist das ursprüngliche auf dem Gerät installierte Bundle

Rückgabe: Promise<CurrentBundleResult>

---

reload()

reload() => Promise<void>

Laden Sie die Ansicht neu

---

setMultiDelay(…)

setMultiDelay(options: MultiDelayConditions) => Promise<void>

Setzt ein Array von {@link DelayCondition} an, das der Plugin verwendet wird, um die Aktualisierung zu verzögern. Nachdem alle Bedingungen erfüllt sind, wird der Aktualisierungsprozess wie gewöhnlich fortgesetzt, sodass die Aktualisierung nach einem Hintergrundprozess oder einem Beenden der App installiert wird. Für den "kind", sollte der Wert eine ISO-8601-Datumszeichenfolge sein. Für den "kind", sollte der Wert eine Zahl in Millisekunden sein. Für den "kind", sollte der Wert eine Versionsnummer sein. Für den "kind", wird der Wert nicht verwendet. Die Funktion zeigt inkonsistente Verhaltensweisen, wenn die Option "kill" den Update-Prozess nach dem ersten Beenden und nicht nach dem nächsten Hintergrundprozess auslöst. Dies wird in einer zukünftigen großen Version behoben. ParameterTyp date setMultiDelay(…) background Abschnitt: setMultiDelay(…) nativeVersion Copy to clipboard kill Sets a {@link DelayCondition} array containing conditions that the Plugin will use to delay the update. After all conditions are met, the update process will run start again as usual, so update will be installed after a backgrounding or killing the app. For the "kind", the value should be an iso8601 date string. For the "kind", the value should be a number in milliseconds. For the "kind", the value should be the version number. For the "kind", the value is not used. The function has inconsistent behavior the option kill do trigger the update after the first kill and not after the next background like other options. This will be fixed in a future major release.

Parameter	Typ	Beschreibung
options	MultiDelayConditions	Enthält den {@link MultiDelayConditions} Array von Bedingungen, um

Seit: 4.3.0

---

cancelDelay()

cancelDelay() => Promise<void>

Storniert eine {@link DelayCondition} um eine Aktualisierung sofort zu verarbeiten.

Seit: 4.0.0

---

getLatest(…)

getLatest(options?: GetLatestOptions | undefined) => Promise<LatestVersion>

Letztes Bundle abrufen, das von der Update-URL verfügbar ist

Parameter	Typ
options	GetLatestOptions

Rückgabewert: Promise<LatestVersion>

Seit: 4.0.0

---

setChannel(…)

setChannel(options: SetChannelOptions) => Promise<ChannelRes>

Setzt den Kanal für dieses Gerät. Der Kanal muss vorhanden sein allow_device_self_set für dies zu funktionieren.

Wichtige Hinweise:

• Verwenden Sie diese Methode nicht, um den Kanal bei der Startzeit zu setzen. Verwenden Sie die __CAPGO_KEEP_0__-Methode. defaultChannel in Ihrer Capacitor-Konfiguration anstatt.
• Nachdem das App-Programm bereit ist und der Benutzer interagiert hat (z.B. sich für ein Beta-Programm angemeldet hat).
• Öffentliche Kanäle können nicht selbst zugewiesen werden. Wenn ein Kanal als public,rufen setChannel() wird ein Fehler ausgelöst. Um einen öffentlichen Kanal zu verwenden, rufen Sie unsetChannel() anstatt - das Gerät fällt automatisch auf die entsprechende öffentliche Kanal zurück.
• Benutzen listChannels() Um herauszufinden, welche Kanäle verfügbar sind und ob sie Selbstzuweisungen zulassen.

Parameter	Typ	Beschreibung
options	SetChannelOptions	Is the {@link SetzeKanalOptionenKanal zum Setzen

Rückgabewerte: Promise<ChannelRes>

Seitdem: 4.7.0

---

unsetChannel(…

unsetChannel(options: UnsetChannelOptions) => Promise<void>

Entfernen Sie die Kanalüberschreibung für dieses Gerät. Nachdem Sie diese Methode aufgerufen haben, erhält das Gerät automatisch Updates von der Öffentlicher Kanal der seinen Bedingungen (Plattform, Geräteart, Build-Typ) entspricht.

Dies ist nützlich, wenn:

• Sie möchten ein Gerät in die Standardaktualisierungsrichtlinie zurückversetzen
• Sie möchten einen öffentlichen Kanal verwenden (da öffentliche Kanäle nicht selbst zugewiesen werden können via setChannel())

Parameter	Typ
options	UnsetChannelOptions

Seit: 4.7.0

---

getChannel()

getChannel() => Promise<GetChannelRes>

Ermitteln Sie den Kanal für dieses Gerät

Rückgabe: Promise<GetChannelRes>

Seit: 4.8.0

---

listChannels()

listChannels() => Promise<ListChannelsResult>

Alle verfügbaren Kanäle für dieses Gerät auflisten. Gibt Kanäle zurück, die mit dem aktuellen Umfeld des Geräts (Plattform, Emulator/Realgerät, Entwicklungs-/Produktionsbuild) kompatibel sind und entweder öffentlich sind oder sich selbst zuweisen lassen.

Jeder Kanal in der Ergebnisliste enthält:

• publicWenn truedies ein Standardkanal ist. Sie können ihn nicht selbst zuweisen, indem Sie setChannel()anstatt dessen entfernen Sie die Zuweisung Ihres Kanals mit unsetChannel()Die App erhält automatisch Updates von diesem öffentlichen Kanal.
• allow_self_setWenn trueDies ist ein selbstzuweisbarer Kanal.Sie können den Geräte explizit diesem Kanal zuweisen, indem Sie setChannel().

Rückgabewert: Promise<ListChannelsResult>

Seit: 7.5.0

---

setCustomId(…)

setCustomId(options: SetCustomIdOptions) => Promise<void>

Setzen Sie einen benutzerdefinierten ID für dieses Gerät

Parameter:	Typ	Beschreibung
options	SetCustomIdOptions	ist der {@link __CAPGO_KEEP_0__SetCustomIdOptions

} Custom-ID, um sie zu setzen 4.9.0

---

Seit:

getBuiltinVersion() => Promise<BuiltinVersion>

Zwischenablage kopieren

Ermittelt die native App-Version oder die eingebettete Version, wenn sie in der Konfiguration gesetzt ist Promise<BuiltinVersion>

Rückgabewert: 5.2.0

---

getDeviceId()

getDeviceId() => Promise<DeviceId>

Eindeutige ID, die zum Identifizieren des Geräts verwendet wird (wird an den Auto-Update-Server gesendet)

Rückgabewert: Promise<DeviceId>

---

getPluginVersion()

getPluginVersion() => Promise<PluginVersion>

Die native Capacitor-Updater-Pluginversion (wird an den Auto-Update-Server gesendet)

Rückgabewert: Promise<PluginVersion>

---

isAutoUpdateEnabled()

isAutoUpdateEnabled() => Promise<AutoUpdateEnabled>

Ermitteln Sie den Zustand der Auto-Update-Konfiguration.

Rückgabe: Promise<AutoUpdateEnabled>

---

removeAllListeners()

removeAllListeners() => Promise<void>

Entfernen Sie alle Listener für dieses Plugin.

Seit: 1.0.0

---

addListener(‘download’, …)

addListener(eventName: 'download', listenerFunc: (state: DownloadEvent) => void) => Promise<PluginListenerHandle>

Hören Sie auf das Bundle-Download-Ereignis ab. Wird einmal ausgelöst, wenn der Download begonnen wird, während des Herunterladens und wenn er abgeschlossen ist. Gibt Ihnen alle Download-Prozentsätze während des Downloads zurück.

Parameter	Typ
eventName	’download’
listenerFunc	(state: DownloadEvent) => void

Rückgabewert: Promise<PluginListenerHandle>

Seit: 2.0.11

---

addListener(‘keineAktualisierungBenötigt’, …)

addListener(eventName: 'noNeedUpdate', listenerFunc: (state: NoNeedEvent) => void) => Promise<PluginListenerHandle>

Hören Sie auf das Ereignis, dass keine Aktualisierung erforderlich ist, nützlich, wenn Sie jede Zeit, wenn die App gestartet wird, eine Überprüfung durchführen möchten

Parameter	Typ
eventName	’noNeedUpdate’
listenerFunc	(state: NoNeedEvent) => void

Rückgabewert: Promise<PluginListenerHandle>

Seit: 4.0.0

---

addListener(‘updateVerfügbar’, …)

addListener(eventName: 'updateAvailable', listenerFunc: (state: UpdateAvailableEvent) => void) => Promise<PluginListenerHandle>

Hören Sie nach verfügbaren Update-Event, nützlich, wenn Sie jede Zeit, wenn die App gestartet wird, manuell überprüfen möchten

Parameter	Typ
eventName	’updateAvailable’
listenerFunc	(state: UpdateAvailableEvent) => void

Rückgabewert: Promise<PluginListenerHandle>

Seit: 4.0.0

---

addListener(‘downloadComplete’, …)

addListener(eventName: 'downloadComplete', listenerFunc: (state: DownloadCompleteEvent) => void) => Promise<PluginListenerHandle>

Hören Sie nach downloadComplete-Ereignissen.

Parameter	Typ
eventName	’downloadComplete’
listenerFunc	(state: DownloadCompleteEvent) => void

Rückgabewert: Promise<PluginListenerHandle>

Seit: 4.0.0

---

addListener(‘majorAvailable’, …)

addListener(eventName: 'majorAvailable', listenerFunc: (state: MajorAvailableEvent) => void) => Promise<PluginListenerHandle>

Hört auf das Major-Update-Ereignis im App ab, informiert Sie, wenn ein Major-Update durch die Einstellung von disableAutoUpdateBreaking blockiert wird

Parameter	Typ
eventName	’majorAvailable’
listenerFunc	(state: MajorAvailableEvent) => void

Rückgabewert: Promise<PluginListenerHandle>

Seit: 2.3.0

---

addListener(‘updateFailed’, …)

addListener(eventName: 'updateFailed', listenerFunc: (state: UpdateFailedEvent) => void) => Promise<PluginListenerHandle>

Im App-App hören Sie nach dem Update-Fehlerereignis, damit Sie wissen, wenn das Update beim nächsten App-Start fehlschlägt

Parameter	Typ
eventName	’updateFailed’
listenerFunc	(state: UpdateFailedEvent) => void

Rückgabewert: Promise<PluginListenerHandle>

Seit: 2.3.0

---

addListener(‘downloadFailed’, …)

addListener(eventName: 'downloadFailed', listenerFunc: (state: DownloadFailedEvent) => void) => Promise<PluginListenerHandle>

Im App-App hören Sie nach dem Download-Fehlerereignis, damit Sie wissen, wenn ein Bundle heruntergeladen hat fehlschlägt

Parameter	Typ
eventName	’downloadFailed’
listenerFunc	(state: DownloadFailedEvent) => void

Rückgabewert: Promise<PluginListenerHandle>

Seit: 4.0.0

---

addListener(‘appReloaded’, …)

addListener(eventName: 'appReloaded', listenerFunc: () => void) => Promise<PluginListenerHandle>

Hören Sie auf das Ereignis des App-Neuladens, informieren Sie sich, wenn das Neuladen erfolgt ist

Parameter	Typ
eventName	’appReloaded’
listenerFunc	() => void

Rückgabewert: Promise<PluginListenerHandle>

Seit: 4.3.0

---

Hinzufügen von Listenern (‘appReady’, …)

addListener(eventName: 'appReady', listenerFunc: (state: AppReadyEvent) => void) => Promise<PluginListenerHandle>

Hören Sie auf das App-Ready-Ereignis in der App, um zu erfahren, wann die App bereit ist zum Einsatz

Parameter	Typ
eventName	’appReady’
listenerFunc	(state: AppReadyEvent) => void

Rückgabewert: Promise<PluginListenerHandle>

Seit: 5.1.0

---

isAutoUpdateAvailable()

isAutoUpdateAvailable() => Promise<AutoUpdateAvailable>

Prüfen, ob eine automatische Aktualisierung verfügbar ist (nicht durch serverUrl deaktiviert)

Rückgabewert: Promise<AutoUpdateAvailable>

---

getNextBundle()

getNextBundle() => Promise<BundleInfo | null>

Holt die nächste Bundle, die verwendet wird, wenn die App neu geladen wird. Gibt null zurück, wenn keine nächste Bundle festgelegt ist.

Rückgabewert: Promise<BundleInfo | null>

Seit: 6.8.0

---

setShakeMenu(…)

setShakeMenu(options: SetShakeMenuOptions) => Promise<void>

Aktivieren oder deaktivieren Sie das Shake-Menü für Debugging- und Testzwecke

Param	Typ	Beschreibung
options	SetShakeMenuOptions	__CAPGO_KEEP_0__

Seit: 7.5.0

---

__CAPGO_KEEP_0__()

isShakeMenuEnabled() => Promise<ShakeMenuEnabled>

Ermittelt den aktuellen Zustand des Shake-Menüs

Rückgabewert: Promise<ShakeMenuEnabled>

Seit: 7.5.0

---

Interfaces

AppReadyErfolgreich

Eigenschaft	Typ
bundle	BundleInfo

BundleInfo

Eigenschaft	Typ
id	string
version	string
downloaded	string
checksum	string
status	BundleStatus

Update-URL

Eigenschaft	Typ
url	string

Statistik-URL

Eigenschaft	Typ
url	string

Kanal-URL

Eigenschaft	Typ
url	string

Herunterlademöglichkeiten

Diese URL und Versionen werden zum Herunterladen des Bundles vom Server verwendet. Wenn Sie den Backend-Modus verwenden, werden alle Informationen durch die Methode getLatest bereitgestellt. Wenn Sie den Backend-Modus nicht verwenden, müssen Sie die URL und die Version des Bundles angeben. Bei verschlüsselten Bundeln sind Prüfsumme und Sitzungsschlüssel erforderlich, wenn Sie das Kommando encrypt mit CLI verwendet haben, sollten Sie sie als Ergebnis des Kommandos erhalten.

Eigenschaft	Typ	Beschreibung	Standard	Seit
url	string	Die URL des Zip-Dateipakets (z.B. dist.zip), das heruntergeladen werden soll. (Dies kann jede beliebige URL sein. Zum Beispiel Amazon S3, ein GitHub-Tag, irgendein anderer Ort, an dem Sie Ihr Paket hochgeladen haben.)
version	string	Die Version code/Name dieses Pakets/Versions
sessionKey	string	Die Sitzungsschlüssel für die Aktualisierung, wenn das Paket mit einem Sitzungsschlüssel verschlüsselt ist	undefined	4.0.0
checksum	string	Die Überprüfungszeichenfolge für die Aktualisierung, sie sollte in sha256 und mit einem privaten Schlüssel verschlüsselt sein, wenn das Paket verschlüsselt ist	undefined	4.0.0
manifest	ManifestEntry[]	Das Manifest für Delta (manifest) mehrfachdatei-Downloads	undefined	6.1.0

ManifestEintrag

Eigenschaft	Typ
file_name	string | null
file_hash	string | null
download_url	string | null

BundleId

Eigenschaft	Typ
id	string

BundleList-Ergebnis

Eigenschaft	Typ
bundles	BundleInfo[]

Listenoptionen

Eigenschaft	Typ	Beschreibung	Standard	Seit
raw	boolean	Ob die Liste der Rohpaketliste oder das Manifest zurückgegeben werden soll. Wenn wahr, wird die Liste versuchen, die interne Datenbank statt der Dateien auf der Festplatte zu lesen.	false	6.14.0

ResetOptions

Eigenschaft	Typ
toLastSuccessful	boolean

AktuellesBundleResult

Eigenschaft	Typ
bundle	BundleInfo
native	string

MultiDelayBedingungen

Eigenschaft	Typ
delayConditions	DelayCondition[]

Verzögerungsbedingung

Eigenschaft	Typ	Beschreibung
kind	DelayUntilNext	Konfiguration von Verzögerungsbedingungen in setMultiDelay
value	string

Letzte Version

Prop	Typ	Beschreibung	Seit
version	string	Ergebnis der Methode getLatest	4.0.0
checksum	string		6
major	boolean
message	string
sessionKey	string
error	string
old	string
url	string
manifest	ManifestEntry[]		6.1

GetLatest-Optionen

Prop	Typ	Beschreibung	Standardwert	Seitdem
channel	string	Der Kanal, um die neueste Version für <b>Der Kanal</b> zu erhalten, muss ‘self_assign’ zulassen, damit dies funktioniert	undefined	6.8.0

ChannelRes

Eigenschaft	Typ	Beschreibung	Seitdem
status	string	Aktueller Status des gesetzten Kanals	4.7.0
error	string
message	string

SetChannelOptions

Eigenschaft	Typ
channel	string
triggerAutoUpdate	boolean

UnsetChannelOptionen

Eigenschaft	Typ
triggerAutoUpdate	boolean

GetChannelRes

Eigenschaft	Typ	Beschreibung	Seit
channel	string	Aktueller Status von get channel	4.8.0
error	string
message	string
status	string
allowSet	boolean

Liste der Kanäle

Eigenschaft	Typ	Beschreibung	Seit
channels	ChannelInfo[]	Liste der verfügbaren Kanäle	7.5.0

Kanalinformationen

Eigenschaft	Typ	Beschreibung	Seitdem
id	string	Der Kanal-IDs	7.5.0
name	string	Der Kanalname	7.5.0
public	boolean	Wenn wahr, ist dies ein Standard-/Rückfall-Kanal. Geräte können sich nicht selbst auf öffentliche Kanäle zuweisen. Stattdessen wird, wenn ein Gerät seinen Kanal-Übertrag (mit "") entfernt, es automatisch Updates vom passenden öffentlichen Kanal erhalten. unsetChannel()Wenn wahr, können Geräte sich explizit auf diesen Kanal zuweisen, indem sie "" verwenden. Dies wird typischerweise für Beta-Tests, A/B-Tests oder opt-in-Update-Tracks verwendet.	7.5.0
allow_self_set	boolean	SetCustomIdOptions setChannel()Abschnitt mit dem Titel „SetCustomIdOptions“	7.5.0

Eigenschaft

Bauart	__CAPGO_KEEP_0__
customId	string

__CAPGO_KEEP_1__

Eigenschaft	Typ
version	string

Geräte-ID

Eigenschaft	Typ
deviceId	string

Plugin-Version

Eigenschaft	Typ
version	string

Automatische Aktualisierung aktiviert

Eigenschaft	Typ
enabled	boolean

PluginListenerHandle

Eigenschaft	Typ
remove	() => Promise<void>

DownloadEvent

Eigenschaft	Typ	Beschreibung	Seit
percent	number	Aktueller Downloadstatus, zwischen 0 und 100.	4.0.0
bundle	BundleInfo

KeineNotwendigeEreignis

Eigenschaft	Typ	Beschreibung	Seit
bundle	BundleInfo	Aktueller Downloadstatus, zwischen 0 und 100.	4.0.0

Aktualisierungsverfügbarkeitsereignis

Eigenschaft	Typ	Beschreibung	Seit
bundle	BundleInfo	Aktueller Status der Herunterladung, zwischen 0 und 100.	4.0.0

DownloadCompleteEvent

Eigenschaft	Typ	Beschreibung	Seit
bundle	BundleInfo	Auslösen, wenn eine neue Aktualisierung verfügbar ist.	4.0.0

MajorAvailableEvent

Eigenschaft	Typ	Beschreibung	Seit
version	string	Wird ausgelöst, wenn ein neuer Hauptpaketbereich verfügbar ist.	4.0.0

UpdateFailedEvent

Eigenschaft	Typ	Beschreibung	Seit
bundle	BundleInfo	Emit wenn eine Aktualisierung nicht installiert werden konnte.	4.0.0

DownloadFailedEvent

Eigenschaft	Typ	Beschreibung	Seit
version	string	Emit wenn ein Download fehlschlägt.	4.0.0

AppReadyEvent

Eigenschaft	Typ	Beschreibung	Seit
bundle	BundleInfo	Emittiert, wenn die App zum Einsatz bereit ist.	5.2.0
status	string

AutoUpdateVerfügbar

Eigenschaft	Typ
available	boolean

SetShakeMenuOptions

Eigenschaft	Typ
enabled	boolean

ShakeMenuAktiviert

Eigenschaft	Typ
enabled	boolean

Typ-Bezeichner

Bundle-Status

ausstehend: Das Bundle ist ausstehend, um als nächstes Bundle heruntergeladen zu werden. SET als nächstes Bundle heruntergeladen. downloading: Das Bundle wird heruntergeladen. SET als nächstes Bundle heruntergeladen. fehlgeschlagen: Das Bundle ist fehlgeschlagen heruntergeladen.

‘success’ | ‘error’ | ‘pending’ | ‘downloading’

Verzögerung bis zum nächsten

‘background’ | ‘kill’ | ‘nativeVersion’ | ‘date’