Funktionen und Einstellungen

Einen Setup-Befehl mit den Installationsanweisungen und der vollständigen Markdown-Anleitung 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	Standard	Seit
`appReadyTimeout`	`number`	Konfigurieren Sie die Anzahl der Millisekunden, die das native Plugin wartet, bevor es eine Aktualisierung als ‘fehlgeschlagen’ betrachtet. Verfügbar auf Android, iOS und Electron.	`10000 // (10 seconds)`
`responseTimeout`	`number`	Konfigurieren Sie die Anzahl der Millisekunden, die das native Plugin wartet, bevor es API Timeout als fehlgeschlagen 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 \| ‘off’ \| ‘atBackground’ \| ‘atInstall’ \| ‘onLaunch’ \| ‘always’ \| ‘onlyDownload’`	Konfigurieren Sie, wie das Plugin Auto-Update über einen Update-Server verwendet. true ist gleichbedeutend mit ‘atBackground’; false ist gleichbedeutend mit ‘off’. - off: Deaktivieren Sie Auto-Update - atBackground: Überprüfen und herunterladen automatisch, dann anwenden, wenn die App in den Hintergrund bewegt wird - atInstall: Anwenden sofort nur nach einer frischen Installation oder einer native App-Update, ansonsten verwenden Sie atBackground - onLaunch: Anwenden sofort bei der Startanzeige, ansonsten verwenden Sie atBackground nach der Startprüfung - immer: Anwenden sofort, sobald Auto-Update läuft - nurHerunterladen: Überprüfen und herunterladen automatisch, emit updateAvailable und setzen Sie das nächste Paket nie automatisch. Verfügbar auf Android, iOS und Electron.	`”atBackground” // true is still accepted`
`resetWhenUpdate`	`boolean`	Automatisch löschen Sie die vorher heruntergeladenen 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 Aktualisierungsprüfungen 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 das ö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. Dies 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’`	Veraltet. Verwenden Sie stattdessen die autoUpdate-String-Modi: “atInstall”, “onLaunch” oder “always”. Diese Option bleibt für bestehende Apps unterstützt. - false: Führen Sie keine direkten Updates durch - atInstall: Gleichbedeutend mit autoUpdate: “atInstall” - onLaunch: Gleichbedeutend mit autoUpdate: “onLaunch” - always: Gleichbedeutend mit autoUpdate: “always” - true: Gleichbedeutend mit “always” für die Rückwärtskompatibilität. Verfügbar auf Android, iOS und Electron.	`false`	5.1.0
`autoSplashscreen`	`boolean`	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. Funktioniert nur, wenn autoUpdate auf „atInstall“, „onLaunch“ oder „always“ eingestellt ist. Legacy-Werte für directUpdate sind weiterhin für die Kompatibilität mit älteren Versionen unterstützt. Erfordert die Installation und Konfiguration des @capacitor/splash-screen-Plugins mit launchAutoHide: false. Erfordert die Aktivierung der Auto-Update-Funktion. Verfügbar auf Android und iOS.	`false`	7.6.0
`periodCheckDelay`	`number`	Konfigurieren Sie die Verzögerungszeit für die Periode-Update-Überprüfung. 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 zur Verwendung eines lokalen Servers für Tests oder eines selbst gehosteten Update-Servers.	`undefined`	4.17.48
`localHost`	`string`	Konfigurieren Sie den CLI zur Verwendung eines lokalen Servers für Tests oder eines selbst gehosteten Update-Servers.	`undefined`	4.17.48
`localWebHost`	`string`	Konfigurieren Sie den CLI zur Verwendung eines lokalen Servers für Tests oder eines selbst gehosteten Update-Servers.	`undefined`	4.17.48
`localSupa`	`string`	Konfigurieren Sie den CLI zur Verwendung eines lokalen Servers für Tests oder eines selbst gehosteten Update-Servers.	`undefined`	4.17.48
`localSupaAnon`	`string`	Konfigurieren Sie den CLI zur Verwendung eines lokalen Servers für Tests.	`undefined`	4.17.48
`localApi`	`string`	Konfigurieren Sie den CLI zur Verwendung eines lokalen api für Tests.	`undefined`	6.3.3
`localApiFiles`	`string`	Konfigurieren Sie den CLI zur Verwendung eines lokalen Dateisystems api für Tests.	`undefined`	6.3.3
`allowModifyUrl`	`boolean`	Erlassen Sie die Berechtigung, dass der Plugin die updateUrl, statsUrl und channelUrl dynamisch von der JavaScript-Seite anpassen kann.	`false`	5.4.0
`defaultChannel`	`string`	Setze die Standardkanal für die App in der Konfiguration. Groß- und Kleinschreibung beachten. Diese Einstellung wird die Standardkanal in der Cloud überschreiben, aber die in der Cloud vorgenommenen Überschreibungen respektieren.	`undefined`	5.5.0
`appId`	`string`	Konfiguriere die App-ID für die App in der Konfiguration.	`undefined`	6.0.0
`keepUrlPathAfterReload`	`boolean`	Konfiguriere das Plugin, damit die URL-Pfad nach einem Neuladen beibehalten werden. WARNUNG: Wenn ein Neuladen ausgelöst wird, wird ‘window.history’ gelöscht.	`false`	6.8.0
`disableJSLogging`	`boolean`	Deaktiviere die JavaScript-Protokollierung des Plugins. Wenn wahr, wird das Plugin nicht im JavaScript-Konsolenfenster protokolliert. Nur die native Protokollierung wird durchgeführt.	`false`	7.3.0
`shakeMenu`	`boolean`	Aktiviere den Schiebe-Gestus, um das Update-Menü 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": "onlyDownload",
      "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: 'onlyDownload',
      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-Bezeichner

Methoden

notifyAppReady()

notifyAppReady() => Promise<AppReadyResult>

Benachrichtige den Capacitor-Updater darüber, dass die aktuelle Bundle läuft (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, ansonsten wird ein Rollover durchgeführt. Ändern Sie dieses Verhalten mit {@link appReadyTimeout}

Rückgabe: Promise<AppReadyResult>

setUpdateUrl(…)

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

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

Parameter	Typ	Beschreibung
`options`	`UpdateUrl`	enthält die URL, die zum Überprüfen von Updates verwendet werden soll.

Seit: 5.4.0

setStatsUrl(…)

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

Setze die statsUrl für die App, diese wird verwendet, um Statistiken zu senden. Die Übermittlung einer leeren Zeichenkette wird die Erfassung von Statistiken deaktivieren.

Parameter	Typ	Beschreibung
`options`	`StatsUrl`	enthält die URL, die für die Übermittlung von Statistiken verwendet werden soll.

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 für die Einstellung des Kanals verwendet werden soll.

Seit: 5.4.0

download(…)

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

Herunterladen eines neuen Bundles aus der bereitgestellten URL, es sollte ein Zip-File sein, mit Dateien drinnen oder mit einer eindeutigen ID drinnen mit allen Ihren Dateien

Parameter	Typ	Beschreibung
`options`	`DownloadOptions`	Die {@link DownloadOptions} für das Herunterladen eines neuen Bundles zip.

Rückgabewert: Promise<BundleInfo>

next(…)

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

Legt das nächste Bundle fest, das bei der Wiederherstellung der App verwendet werden soll.

Param	Typ	Beschreibung
`options`	`BundleId`	Enthält die ID des nächsten Bundle, das bei der nächsten App-Start-Phase 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 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} Objekt, das die ID eines zu löschenden Pakets enthält (Hinweis: Dies ist die Paket-ID, NICHT der Versionsname) list(…)Abschnitt mit dem Titel “list(…)

Auf die Zwischenablage kopieren

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

Typ

Beschreibung	Das {@link} Objekt	Copy to clipboard
`options`	`ListOptions`	Get all locally downloaded bundles in your app ListeOptionen} zum Auflisten von Bundles

Rückgabe: Promise<BundleListResult>

reset(…)

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

Die App zurücksetzen auf den builtin Bundle (das einem Apple App Store / Google Play Store gesendet wurde) oder den letzten erfolgreich geladenen Bundle.

Parameter	Typ	Beschreibung
`options`	`ResetOptions`	Enthält {@link} ResetOptions.toLastSuccessful}, `true` wird auf die eingebaute Bundle zurückgesetzt und `false` wird auf das letzte erfolgreich geladene Bundle zurückgesetzt.

current()

current() => Promise<CurrentBundleResult>

Gibt das aktuelle Bundle zurück, wenn keines gesetzt ist, gibt es das Standard-Bundle zurück. 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

__CAPGO_KEEP_0__

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. Param__CAPGO_KEEP_0__ date __CAPGO_KEEP_0__ background __CAPGO_KEEP_0__ nativeVersion __CAPGO_KEEP_0__ kill __CAPGO_KEEP_0__

__CAPGO_KEEP_0__	Typ	Beschreibung
`options`	`MultiDelayConditions`	Enthält die {@link MultiDelayConditions} Menge von Bedingungen, um

Seit: 4.3.0

cancelDelay()

cancelDelay() => Promise<void>

Storniert ein {@link DelayCondition} zur sofortigen Verarbeitung eines Updates.

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 allow_device_self_set für dies zu funktionieren.

Wichtige Hinweise:

Verwenden Sie diese Methode nicht, um den Kanal bei der Bootzeit zu setzen. Verwenden Sie stattdessen defaultChannel in Ihrer Capacitor-Konfiguration anstatt.
Diese Methode ist für die Verwendung nach der App-Initialisierung und nachdem 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 publicmarkiert ist, setChannel() wird bei Aufruf von unsetChannel() eine Fehlermeldung zurückgegeben. Um einen öffentlichen Kanal zu verwenden, rufen Sie stattdessen
auf - das Gerät fällt automatisch auf den passenden öffentlichen Kanal zurück. listChannels() um zu ermitteln, welche Kanäle verfügbar sind und ob sie Selbstzuweisungen zulassen.

Param	Typ	Beschreibung
`options`	`SetChannelOptions`	Sind die {@link SetChannelOptions} Kanal-Einstellungen zum Setzen

Rückgabewert: Promise<ChannelRes>

Seit: 4.7.0

Kanal(…)

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

Entfernen Sie die Kanalüberschreibung für dieses Gerät. Nachdem Sie diese Methode aufgerufen haben, wird das Gerät automatisch Updates von dem öffentlichen Kanal empfangen, der seinen Bedingungen (Plattform, Gerärtyp, Buildtyp) entspricht.

Dies ist nützlich, wenn:

Sie ein Gerät wieder auf die Standardaktualisierungsstrecke verschieben möchten
Sie einen öffentlichen Kanal verwenden möchten (da öffentliche Kanäle nicht selbst zugewiesen werden können via setChannel())

Param	Type
`options`	`UnsetChannelOptions`

Since: 4.7.0

getChannel()

getChannel() => Promise<GetChannelRes>

Ermitteln Sie den Kanal für dieses Gerät

Rückgabewert: Promise<GetChannelRes>

Seit: 4.8.0

listChannels()

listChannels() => Promise<ListChannelsResult>

Liste aller für dieses Gerät verfügbaren Kanäle. Gibt Kanäle zurück, die mit dem aktuellen Umfeld des Geräts (Plattform, Emulator/Realgerät, Entwicklungs-/Produktionsumgebung) kompatibel sind und entweder öffentlich sind oder Selbstzuweisung zulassen.

Jeder Kanal in der Ergebnisliste enthält:

publicWenn truedies ein Standardkanal ist Standardkanal. Sie können ihn nicht selbst zuweisen.Sie können ihn nicht selbst zuweisen. setChannel(). Anstatt, wenn Sie die Kanalzuweisung Ihres Geräts entfernen, unsetChannel(), wird das Gerät automatisch Updates von diesem öffentlichen Kanal erhalten.
allow_self_set: Wenn true, ist dies ein selbstzuweisbarer Kanal. Sie können das Gerät explizit diesem Kanal zuweisen, indem Sie setChannel().

Returns: Promise<ListChannelsResult>

Seit: 7.5.0

setCustomId(…)

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

Setzen Sie eine benutzerdefinierte ID für dieses Gerät

Parameter	Typ	Beschreibung
`options`	`SetCustomIdOptions`	ist der {@link SetCustomIdOptions} benutzerdefinierte ID, um zu setzen

Seit: 4.9.0

getBuiltinVersion()

getBuiltinVersion() => Promise<BuiltinVersion>

Ermitteln Sie die native App-Version oder die eingebettete Version, wenn sie in der Konfiguration gesetzt ist

Rückgabewert: Promise<BuiltinVersion>

Seit: 5.2.0

getDeviceId()

getDeviceId() => Promise<DeviceId>

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

Rückgabewert: Promise<DeviceId>

getPluginVersion()

getPluginVersion() => Promise<PluginVersion>

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

Rückgabewert: Promise<PluginVersion>

isAutoUpdateEnabled()

isAutoUpdateEnabled() => Promise<AutoUpdateEnabled>

Ermitteln Sie den Zustand der Auto-Update-Konfiguration.

Rückgabewert: Promise<AutoUpdateEnabled>

removeAllListeners()

removeAllListeners() => Promise<void>

Entfernen Sie alle Listener für diesen Plugin.

Seit: 1.0.0

addListener(‘download’, …)

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

Hören Sie auf das Ereignis des Bundle-Downloads in der App. Wird einmal ausgelöst, wenn ein Download gestartet wird, während des Herunterladens und wenn er fertig ist.

Dies gibt Ihnen alle Download-Prozentsätze während des Herunterladens zurück.	Param
`eventName`	`’download’`
`listenerFunc`	`(state: DownloadEvent) => void`

Typ Promise<PluginListenerHandle>

Rückgabewert: 2.0.11

Seit:

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

Auf die Zwischenablage kopieren

Hören Sie auf das Ereignis 'noNeedUpdate', …, nützlich, wenn Sie jede Zeit, wenn die App gestartet wird, eine Zwangskontrolle durchführen möchten.	Param
`eventName`	`’noNeedUpdate’`
`listenerFunc`	`(state: NoNeedEvent) => void`

Typ Promise<PluginListenerHandle>

Seit: 4.0.0

addListener(‘updateAvailable’, …)

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

Verfügbarkeit von Updates abrufen, nützlich, wenn Sie jede Zeit, wenn die App gestartet wird, eine Überprüfung durchführen möchten

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

Wert zurückgeben: Promise<PluginListenerHandle>

Seit: 4.0.0

addListener(‘downloadComplete’, …)

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

Download-Complete-Ereignisse abrufen.

__CAPGO_KEEP_0__	__CAPGO_KEEP_0__
`eventName`	`’downloadComplete’`
`listenerFunc`	`(state: DownloadCompleteEvent) => void`

__CAPGO_KEEP_0__: Promise<PluginListenerHandle>

Seit: 4.0.0

Hinzufügen von Ereignis-Hörern für 'majorAvailable', …

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

Hören Sie nach einem Major-Update-Ereignis im App, informieren Sie sich, wenn ein Major-Update durch die Einstellung 'disableAutoUpdateBreaking' blockiert wird.

__CAPGO_KEEP_0__	__CAPGO_KEEP_0__
`eventName`	`’majorAvailable’`
`listenerFunc`	`(state: MajorAvailableEvent) => void`

__CAPGO_KEEP_0__ Promise<PluginListenerHandle>

Seit: 2.3.0

addListener(‘updateFailed’, …)

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

Im App-Update-Fehlerereignis lauschen, informiert Sie, 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>

Hören Sie auf ein Download-Fehlerereignis in der App, damit Sie wissen, wenn ein Bundle heruntergeladen hat fehlgeschlagen

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 ein Reloadereignis in der App, damit Sie wissen, wenn ein Reload aufgetreten ist

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>

App-Ready-Ereignis abrufen, um zu bestimmen, wenn die App bereit zum Einsatz ist

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

Rückgabewert: Promise<PluginListenerHandle>

Seit: 5.1.0

isAutoUpdateAvailable()

isAutoUpdateAvailable() => Promise<AutoUpdateAvailable>

Ermitteln Sie, 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. Rückgabewert ist null, 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 einen boolean, um das Shake-Menü zu aktivieren oder zu deaktivieren

Seit: 7.5.0

__CAPGO_KEEP_0__

isShakeMenuEnabled() => Promise<ShakeMenuEnabled>

Gibt den aktuellen Zustand des Shake-Menüs zurück

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`

UpdateUrl

Eigenschaft	Typ
`url`	`string`

StatsUrl

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	Seit
`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) 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`

BundleListResult

Eigenschaft	Typ
`bundles`	`BundleInfo[]`

ListOptions

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`

AktuellerBundleResult

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

MultiDelayBedingungen

Eigenschaft	Typ
`delayConditions`	`DelayCondition[]`

Verzugsbedingung

Eigenschaft	Typ	Beschreibung
`kind`	`DelayUntilNext`	Stellen Sie Verzugsbedingungen in setMultiDelay ein
`value`	`string`

Neueste Version

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

Optionen für getLatest

Prop	Typ	Beschreibung	Standard	Seit
`channel`	`string`	Der Kanal, um die neueste Version für den Kanal zu erhalten. Der Kanal muss 'self_assign' erlauben, damit dies funktioniert.	`undefined`	6.8.0

ChannelRes

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

Beschreibung	Seit	Prop	Type
`channel`	`string`	Aktueller Status des Kanalabonnements	4.8.0
`error`	`string`
`message`	`string`
`status`	`string`
`allowSet`	`boolean`

ListChannelsResult

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

Kanalinformationen

Eigenschaft	Typ	Beschreibung	Seit
`id`	`string`	Der Kanal-Id	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 seine Kanal-Überprüfung (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

__CAPGO_KEEP_0__	__CAPGO_KEEP_1__
`customId`	`string`

__CAPGO_KEEP_0__

__CAPGO_KEEP_1__	__CAPGO_KEEP_2__
`version`	`string`

__CAPGO_KEEP_3__

__CAPGO_KEEP_1__	__CAPGO_KEEP_2__
`deviceId`	`string`

__CAPGO_KEEP_4__

__CAPGO_KEEP_1__	__CAPGO_KEEP_2__
`version`	`string`

AutoUpdateAktiviert

Eigenschaft	Typ
`enabled`	`boolean`

Hörer-Plugin-Handle

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

Herunterladen-Ereignis

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

NoNeedEvent

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

UpdateAvailableEvent

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

DownloadCompleteEvent

Eigenschaft	Typ	Beschreibung	Seit
`bundle`	`BundleInfo`	Ausgelöst, wenn eine neue Aktualisierung verfügbar ist.	4.0.0

Hauptverfügbarkeitsereignis

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

UpdateFehlgeschlagenerEvent

Eigenschaft	Typ	Beschreibung	Seitdem
`bundle`	`BundleInfo`	Emitiert, wenn eine Aktualisierung fehlschlug, sich zu installieren.	4.0.0

DownloadFailedEvent

Eigenschaft	Typ	Beschreibung	Seitdem
`version`	`string`	Emitiert, wenn eine Herunterladen fehlschlägt.	4.0.0

AppReadyEvent

Eigenschaft	Typ	Beschreibung	Seit
`bundle`	`BundleInfo`	Ausgelöst, 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

warte: Das Bundle wird vorbereitet, um heruntergeladen zu werden. SET als nächstes Bundle herunterladen. herunterladen: Das Bundle wird heruntergeladen. erfolgreich: Das Bundle wurde heruntergeladen und ist bereit, um gesetzt zu werden. SET As nächster Bundle. Fehler: Das Bundle konnte nicht heruntergeladen werden.

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

Verschieben bis zum nächsten Bundle

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