Funktionen und Einstellungen

Eine Einrichtungsvorlage mit den Installationsanweisungen und dem vollständigen Markdown-Leitfaden für diesen Plugin kopieren.

Updater-Plugin-Konfiguration

Siehe den Github Readme für weitere Informationen.

CapacitorUpdater kann mit diesen Optionen konfiguriert werden:

Eigenschaft	Typ	Beschreibung	Standardwert	Da seit
`appReadyTimeout`	`number`	Konfigurieren Sie die Anzahl der Millisekunden, nach denen das native Plugin eine Aktualisierung als ‘fehlgeschlagen’ betrachten sollte. Verfügbar auf Android, iOS und Electron.	`10000 // (10 seconds)`
`responseTimeout`	`number`	Konfigurieren Sie die Anzahl der Millisekunden, nach denen das native Plugin eine API-Timeout betrachten sollte. 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 Auto-Update über einen Update-Server verwenden soll. Verfügbar auf Android, iOS und Electron.	`true`
`resetWhenUpdate`	`boolean`	Löschen Sie automatisch vorherige 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 "" um die Statistikberichterstattung zu deaktivieren.	`https://plugin.capgo.app/stats`
`publicKey`	`string`	Konfigurieren Sie die öffentliche Schlüssel für Ende-zu-Ende-Live-Update-Verschlü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 Aktualisierungsantrag verwendet. Wenn nicht gesetzt, wird das Plugin die Version aus dem native code abrufen. Verfügbar auf Android, iOS und Electron.	`undefined`	4.17.48
`directUpdate`	`boolean \| ‘always’ \| ‘atInstall’ \| ‘onLaunch’`	Konfigurieren Sie, wann der Plugin die direkten Updates installieren sollte. Nur für die automatische Aktualisierung. 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 aktualisiert. - false: Führen Sie keine direkten Updates durch (verwenden Sie die Standardverhalten: Laden Sie herunter, wenn die App gestartet wird, setzen Sie, wenn die App im Hintergrund läuft) - atInstall: Führen Sie direkte Updates nur durch, wenn die App installiert wird, aktualisiert wird, sonst verhalten Sie sich wie directUpdate = false - onLaunch: Führen Sie direkte Updates nur durch, wenn die App installiert wird, aktualisiert wird oder nachdem die App beendet wurde, sonst verhalten Sie sich wie directUpdate = false - immer: Führen Sie direkte Updates in allen vorherigen Fällen durch (App installiert, aktualisiert aus dem Store, nachdem die App beendet wurde oder die App wiederhergestellt wurde), 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`	Automatisieren Sie die Versteckung des Splashscreens, wenn Sie direkte Updates verwenden. Wenn aktiviert, versteckt das Plugin den Splashscreen nach der Anwendung von Updates oder wenn keine Updates erforderlich sind. Dies entfernt die Notwendigkeit, manuell auf appReady-Ereignisse zu lauschen und die Methode SplashScreen.hide() aufzurufen. Nur funktioniert, wenn directUpdate auf „atInstall“, „immer“ oder true eingestellt ist. Erfordert die Installation und Konfiguration des @capacitor/splash-screen-Plugins mit launchAutoHide: false. 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 des Zeitraums. Die Einheit ist in Sekunden. Verfügbar auf Android, iOS und Electron. Kann nicht kleiner als 600 Sekunden (10 Minuten) sein.	`600 // (10 minutes)`
`localS3`	`boolean`	Konfigurieren Sie den CLI zum Einsatz eines lokalen Servers für die Testung oder eines selbstgehosteten Updateservers.	`undefined`	4.17.48
`localHost`	`string`	Konfigurieren Sie den CLI zum Einsatz eines lokalen Servers für die Testung oder eines selbstgehosteten Updateservers.	`undefined`	4.17.48
`localWebHost`	`string`	Konfigurieren Sie den CLI zum Einsatz eines lokalen Servers für die Testung oder eines selbstgehosteten Updateservers.	`undefined`	4.17.48
`localSupa`	`string`	Konfigurieren Sie den CLI zum Einsatz eines lokalen Servers für die Testung oder eines selbstgehosteten Updateservers.	`undefined`	4.17.48
`localSupaAnon`	`string`	Konfigurieren Sie den CLI zum Einsatz eines lokalen Servers für die Testung.	`undefined`	4.17.48
`localApi`	`string`	Konfigurieren Sie den CLI zum Einsatz eines lokalen api für die Testung.	`undefined`	6.3.3
`localApiFiles`	`string`	Konfigurieren Sie den CLI zum Einsatz 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 vom Client-Seitigen JavaScript zu ändern.	`false`	5.4.0
`defaultChannel`	`string`	Setzen Sie die Standardkanal für die App in der Konfiguration. Groß- und Kleinschreibung beachten. Diese Einstellung wird die Standardkanal-Einstellung im Cloud übernehmen, aber die im Cloud vorgenommenen Übernahmen respektieren.	`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, um die URL-Pfad nach einem Neuladen zu speichern. 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-Konsolenfenster protokolliert. Nur das native Protokoll wird durchgeführt.	`false`	7.3.0
`shakeMenu`	`boolean`	Aktivieren Sie den Ruckelnachklang, um das Aktualisierungsmenü für Debugging-/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
Typische 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 Rollover durchgeführt) Standardmäßig sollte diese Methode innerhalb der ersten 10 Sekunden nach App-Start aufgerufen werden, andernfalls wird ein Rollover durchgeführt. Dieses Verhalten kann mit {@link appReadyTimeout} geändert werden

Rückgabewert 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 Abrufen von Updates.

Seit: 5.4.0

setStatsUrl(…)

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

Setze die statsUrl für die App, 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 die channelUrl für die App, diese wird verwendet, um den Kanal zu setzen.

Parameter	Typ	Beschreibung
`options`	`ChannelUrl`	enthält die URL, die zum Setzen des Kanals verwendet werden soll.

Seit: 5.4.0

download(…)

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

Lade ein neues Bundle vom angegebenen URL herunter, es sollte ein Zip-File sein, mit Dateien drin oder mit einer eindeutigen ID drin mit allen Deinen Dateien

Parameter	Typ	Beschreibung
`options`	`DownloadOptions`	Der {@link Download-Optionen für die Herunterladung einer neuen Bundle-ZIP.Rückgabewert:

next(…) Promise<BundleInfo>

Abschnitt mit dem Titel “next(…)

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

Parameter

protectedTokens	Typ	Beschreibung
`options`	`BundleId`	Enthält die ID des nächsten Bundle, das bei der nächsten App-Starteinstellung gesetzt werden soll. {@link BundleInfo.id}

Rückgabewert: Promise<BundleInfo>

set(…)

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

Setzt das aktuelle Bundle und lädt die App sofort neu.

Parameter	Typ	Beschreibung
`options`	`BundleId`	Ein {@link "object"} mit dem neuen Bundle-Id, der als aktuell gesetzt werden soll. __CAPGO_KEEP_0__delete(…)

Abschnitt mit dem Titel “delete(…)

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

Param

Typ	Beschreibung	Ein {@link "BundleId"}
`options`	`BundleId`	A {@link "BundleId"} object containing the new bundle id to set as current. delete(…)Objekt, das die ID eines zu löschenden Bundles enthält (Hinweis: Dies ist die Bundle-ID, nicht der Versionsname)

list(…)

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

Alle lokal heruntergeladenen Bundles in Ihrer App abrufen

Parameter	Typ	Beschreibung
`options`	`ListOptions`	Die {@link ListOptions} für die Auflistung von Bundles

Rückgabewert: Promise<BundleListResult>

reset(…)

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

Die App auf den builtin Bundle (das an die Apple App Store / Google Play Store gesendet wurde) oder das letzte erfolgreich geladene Bundle.

Param	Typ	Beschreibung
`options`	`ResetOptions`	Enthält {@link ResetOptions.toLastSuccessful}, `true` setzt sich auf das Standard-Bundle zurück und `false` wird auf das letzte erfolgreich geladene Bundle zurückgesetzt.

aktuell()

current() => Promise<CurrentBundleResult>

Liefert das aktuelle Bundle zurück, wenn keine gesetzt sind, builtin . currentNative ist das ursprüngliche Bundle, das auf dem Gerät installiert ist

Rückgabe: Promise<CurrentBundleResult>

reload()

reload() => Promise<void>

Die Ansicht neu laden

setMultiDelay(…)

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

Setzt ein Array von {@link "DelayCondition"} Bedingungen, die das Plugin verwendet, um die Aktualisierung zu verzögern. Nachdem alle Bedingungen erfüllt sind, wird der Aktualisierungsprozess wie gewöhnlich fortgesetzt, sodass die Aktualisierung nach einem Hintergrundlaufen oder einem App-Töten 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 inkonsistentes Verhalten, wenn die Option "kill" ausgelöst wird. Die Aktualisierung wird nach dem ersten Töten und nicht nach dem nächsten Hintergrundlaufen wie bei anderen Optionen ausgelöst. Dies wird in einer zukünftigen großen Version behoben. ParamTyp date Beschreibung background Enthalten in den {@link "DelayCondition"} nativeVersion __CAPGO_KEEP_0__ kill __CAPGO_KEEP_1__

__CAPGO_KEEP_2__	__CAPGO_KEEP_3__	__CAPGO_KEEP_4__
`options`	`MultiDelayConditions`	__CAPGO_KEEP_5__ MultiDelayConditions__CAPGO_KEEP_0__

Seit: 4.3.0

cancelDelay()

cancelDelay() => Promise<void>

Storniert eine { @link DelayCondition } um eine Aktualisierung sofort zu verarbeiten. Seit:getLatest(…)

Abschnitt mit dem Titel “getLatest(…) 4.0.0

Copy to clipboard

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

Laden Sie die neueste Bundle von der Update-URL

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 allow_device_self_set für diese Funktion aktiviert sein.

Wichtige Hinweise:

Verwenden Sie diese Methode nicht, um den Kanal bei der Startzeit zu setzen. Verwenden Sie stattdessen defaultChannel in Ihrer Capacitor-Konfiguration an.
Diese Methode ist für die Verwendung nach der App-Initialisierung und der Interaktion des Benutzers (z.B. das Opt-in in ein Beta-Programm) vorgesehen.
Öffentliche Kanäle können nicht selbst zugewiesen werden. Wenn ein Kanal als publicmarkiert ist, wird bei Aufruf von setChannel() eine Fehlermeldung zurückgegeben. Um einen öffentlichen Kanal zu verwenden, rufen Sie stattdessen unsetChannel() auf - das Gerät fällt automatisch auf den entsprechenden öffentlichen Kanal zurück.
Verwenden Sie listChannels() um zu ermitteln, welche Kanäle verfügbar sind und ob sie die Selbstzuteilung zulassen.

Parameter	Typ	Beschreibung
`options`	`SetChannelOptions`	Ist der {@link SetChannelOptions} Kanal zum Setzen

Rückgabewert: Promise<ChannelRes>

Seit: 4.7.0

unsetChannel(…)

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

Setzen Sie den Kanal-Übertrag für dieses Gerät zurück. Nachdem Sie diese Methode aufgerufen haben, wird das Gerät automatisch Updates vom öffentlichen Kanal empfangen, der seinen Bedingungen (Plattform, Gerärtyp, Build-Typ) entspricht.

Dies ist nützlich, wenn:

Sie möchten ein Gerät auf die Standard-Update-Track zurücksetzen
Sie möchten einen öffentlichen Kanal verwenden (da öffentliche Kanäle nicht selbst zugewiesen werden können via setChannel())

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

Listet alle für dieses Gerät verfügbaren Kanäle auf. 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 Selbstzuweisung zulassen.

Jeder Kanal in der Ergebnisliste enthält:

public: Wenn true, ist dies ein Standardkanal. Sie können ihn nicht selbst zuweisen, indem Sie setChannel(). Stattdessen wird das Gerät, wenn Sie die Kanalzuweisung entfernen, automatisch Updates von diesem öffentlichen Kanal erhalten. unsetChannel(): Wenn
allow_self_setEach channel in the result includes: true, dies ist ein ein selbst-zuweisbares Kanal. Sie können den Gerät explizit diesem Kanal zuweisen, indem Sie setChannel().

Rückgabe: 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 die {@link SetCustomIdOptions} Custom-ID, um zu setzen

Seit: 4.9.0

getBuiltinVersion()

getBuiltinVersion() => Promise<BuiltinVersion>

Ermittelt die native App-Version oder die eingebettete Version, wenn diese in der Konfiguration gesetzt ist

Rückgabewert: Promise<BuiltinVersion>

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

Abrufen der nativen Capacitor-Updater-Pluginversion (wird an den Auto-Update-Server gesendet)

Rückgabewert: Promise<PluginVersion>

isAutoUpdateEnabled()

isAutoUpdateEnabled() => Promise<AutoUpdateEnabled>

Abrufen des Zustands der Auto-Update-Konfiguration

Rückgabewert: Promise<AutoUpdateEnabled>

removeAllListeners()

removeAllListeners() => Promise<void>

Entferne alle Listener für dieses Plugin.

Seit: 1.0.0

addListener(‘download’, …)

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

Höre beim App-Downloadereignis ab. Wird einmalig ausgelöst, wenn der Download gestartet wird, während des Downloads und wenn er abgeschlossen ist. Dies gibt dir alle Download-Prozentsätze während des Downloads zurück.

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

Gibt zurück: Promise<PluginListenerHandle>

Seit: 2.0.11

addListener(‘noNeedUpdate’, …)

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

Zurückliegende Aktualisierung verfolgen, nützlich, wenn Sie jede Zeit die App neu starten möchten

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

Gibt zurück: Promise<PluginListenerHandle>

Seit: 4.0.0

addListener(‘updateAvailable’, …)

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

Zu einem verfügbaren Update-Event lauschen, nützlich, wenn Sie jede Zeit, wenn die App gestartet wird, eine Zwangskontrolle durchführen 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>

Zu downloadComplete-Ereignissen lauschen.

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ören Sie auf das Major-Update-Ereignis in der App, damit Sie wissen, 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 hören Sie auf ein Update-Fehlerereignis, damit Sie wissen, wenn das Update bei der nächsten App-Start fehlschlägt

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

Rückgabewert: Promise<PluginListenerHandle>

Seit: 2.3.0

addListener(‘downloadFailed’, …) hinzufügen

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

Parameter

Typ	addListener(‘downloadFailed’, …) hinzufügen
`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 App-Neuladen-Ereignis zu, damit Sie wissen, wenn ein Neuladen stattgefunden hat

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

Rückgabewert: Promise<PluginListenerHandle>

Seit: 4.3.0

addListener(‘appReady’, …)

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

Hört auf das App-Ready-Ereignis im App, damit Sie wissen, wenn die App bereit ist, verwendet zu werden

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

Rückgabewert: Promise<PluginListenerHandle>

Seit: 5.1.0

isAutoUpdateAvailable()

isAutoUpdateAvailable() => Promise<AutoUpdateAvailable>

Ermitteln, ob eine automatische Aktualisierung verfügbar ist (nicht durch serverUrl deaktiviert).

Rückgabewert: Promise<AutoUpdateAvailable>

getNextBundle()

getNextBundle() => Promise<BundleInfo | null>

Ermitteln Sie das nächste Bundle, das verwendet wird, wenn die App neu geladen wird. Gibt null zurück, wenn kein nächstes 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

Parameter	Typ	Beschreibung
`options`	`SetShakeMenuOptions`	Enthält boolean, um das Shake-Menü zu aktivieren oder zu deaktivieren

Seit: 7.5.0

isShakeMenuEnabled()

isShakeMenuEnabled() => Promise<ShakeMenuEnabled>

Ermittelt den aktuellen Zustand des Shake-Menüs

Rückgabewert: Promise<ShakeMenuEnabled>

Seit: 7.5.0

Interfaces

AppReadyResult

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 einen Backend-Server verwenden, werden alle Informationen durch die Methode getLatest bereitgestellt. Wenn Sie keinen Backend-Server verwenden, müssen Sie die URL und die Version des Bundles bereitstellen. Sitzungs-Schlüssel sind erforderlich, wenn Sie das Bundle mit dem Befehl CLI verschlüsselt haben, Sie sollten sie als Ergebnis des Befehls erhalten.

Eigenschaft	Typ	Beschreibung	Standard	Seitdem
`url`	`string`	Die URL des Bundle-Zip-Dateis (z.B. dist.zip), die heruntergeladen werden soll. (Dies kann jede URL sein. Z.B. Amazon S3, ein GitHub-Tag, jeder andere Ort, an dem Sie Ihr Bundle gehostet haben.)
`version`	`string`	Die Version code/Name dieses Bundles/Versions
`sessionKey`	`string`	Die Sitzungsschlüssel für die Aktualisierung, wenn das Bundle mit einem Sitzungsschlüssel verschlüsselt ist	`undefined`	4.0.0
`checksum`	`string`	Der Prüfsummenwert für die Aktualisierung, er sollte in sha256 und mit einem privaten Schlüssel verschlüsselt sein, wenn das Bundle verschlüsselt ist	`undefined`	4.0.0
`manifest`	`ManifestEntry[]`	Das Manifest für Delta (manifest)-Multi-Datei-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`

BundleListResult

Eigenschaft	Typ
`bundles`	`BundleInfo[]`

ListOptions

Eigenschaft	Typ	Beschreibung	Standard	Seitdem
`raw`	`boolean`	Entscheidet, ob die ungefährdete Bundle-Liste oder das Manifest zurückgegeben werden soll. Wenn wahr, wird die Liste versuchen, die interne Datenbank zu lesen, anstatt Dateien auf der Festplatte.	`false`	6.14.0

ResetOptions

Eigenschaft	Typ
`toLastSuccessful`	`boolean`

AktuellesBundle-Ergebnis

Eigenschaft	Typ
`bundle`	`BundleInfo`
`native`	`string`

Mehrfachverzögerungskriterien

Eigenschaft	Typ
`delayConditions`	`DelayCondition[]`

Verzögerungsbedingung

Eigenschaft	Typ	Beschreibung
`kind`	`DelayUntilNext`	Konfigurieren Sie Verzögerungsbedingungen in setMultiDelay
`value`	`string`

NeuesteVersion

Eigenschaft	Typ	Beschreibung	Seit
`version`	`string`	Ergibt das getLatest-Methoden	4.0.0
`checksum`	`string`		6
`major`	`boolean`
`message`	`string`
`sessionKey`	`string`
`error`	`string`
`old`	`string`
`url`	`string`
`manifest`	`ManifestEntry[]`		6.1

GetLatest-Optionen

Eigenschaft	Typ	Beschreibung	Standardwert	Seit
`channel`	`string`	Der Kanal, um die neueste Version zu erhalten Der Kanal muss ‘self_assign’ zulassen, damit dies funktioniert	`undefined`	6.8.0

KanalRes

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

SetChannelOptions

Eigenschaft	Typ
`channel`	`string`
`triggerAutoUpdate`	`boolean`

UnsetChannelOptions

Eigenschaft	Typ
`triggerAutoUpdate`	`boolean`

GetChannelRes

Eigenschaft	Typ	Beschreibung	Seit
`channel`	`string`	Aktueller Status des Abrufs des Kanals	4.8.0
`error`	`string`
`message`	`string`
`status`	`string`
`allowSet`	`boolean`

ListChannelsResult

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

KanalInfo

Kanal	Typ	Beschreibung	Seit
`id`	`string`	Die Kanal-ID	7.5.0
`name`	`string`	Kanalname	7.5.0
`public`	`boolean`	Wenn wahr, ist dies ein Standard-/Rückfallkanal. Geräte können sich nicht selbst auf öffentliche Kanäle eintragen. 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 eintragen, 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

BuiltinVersion	Abschnitt mit dem Titel „BuiltinVersion“
`customId`	`string`

Eigenschaft

__CAPGO_KEEP_0__	Typ
`version`	`string`

Geräte-ID

Eigenschaft	Typ
`deviceId`	`string`

Plugin-Version

Eigenschaft	Typ
`version`	`string`

Automatische Aktualisierung aktiviert

Eigenschaft	Typ
`enabled`	`boolean`

__CAPGO_KEEP_0__

Eigenschaft	Typ
`remove`	`() => Promise<void>`

Download-Event

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

KeineNotwendigkeitEvent

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

UpdateAvailableEvent

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

DownloadCompleteEvent

Eigenschaft	Typ	Beschreibung	Seitdem
`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 Hauptbundle verfügbar ist.	4.0.0

UpdateFailedEvent

Eigenschaft	Typ	Beschreibung	Seit
`bundle`	`BundleInfo`	Wird ausgelöst, wenn die Aktualisierung fehlschlägt.	4.0.0

DownloadFailedEvent

Eigenschaft	Typ	Beschreibung	Seit
`version`	`string`	Wird ausgelöst, 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 wird ausstehend behandelt, um es als nächstes Bundle zu setzen. downloading: Das Bundle wird heruntergeladen. geschafft: Das Bundle wurde heruntergeladen und ist bereit, als nächstes Bundle gesetzt zu werden. fehlerhaft: Das Bundle konnte nicht heruntergeladen werden. SET als nächstes Bundle setzen. Delay bis zum nächsten Abschnitt "Delay bis zum nächsten"

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

Delay bis zum nächsten Bundle

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