Funktionen und Einstellungen

Updater-Plugin-Konfiguration

Siehe den Github Readme Weitere Informationen finden Sie hier.

CapacitorUpdater kann mit diesen Optionen konfiguriert werden:

Eigenschaft	Typ	Beschreibung	Standardwert	Seit
appReadyTimeout	number	Konfigurieren Sie die Anzahl der Millisekunden, die der native Plugin wartet, bevor eine Aktualisierung als ‘fehlgeschlagen’ betrachtet wird. Verfügbar auf Android, iOS und Electron.	10000 // (10 seconds)
responseTimeout	number	Konfigurieren Sie die Anzahl der Millisekunden, die der native Plugin wartet, bevor API Timeout betrachtet wird. Verfügbar auf Android, iOS und Electron.	20000 // (20 seconds)
autoDeleteFailed	boolean	Konfigurieren Sie, ob der Plugin automatisch fehlgeschlagene Pakete löschen soll. Verfügbar auf Android, iOS und Electron.	true
autoDeletePrevious	boolean	Konfigurieren Sie, ob der 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 der Plugin Auto-Update über einen Update-Server verwenden soll. 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 wechselt - atInstall: Anwenden sofort nur nach einer frischen Installation oder einer native App-Update, ansonsten verwenden Sie atBackground - onLaunch: Anwenden sofort bei der Start, ansonsten verwenden Sie atBackground nach der Start-Überprüfung - immer: Anwenden sofort, wenn 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	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, zu dem 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, zu dem 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 Update-Antrag verwendet. Wenn nicht gesetzt, wird der Plugin die Version vom nativen 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	Automatisieren Sie die Versteckung des Splashscreens, 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 lauschen und SplashScreen.hide() aufzurufen. Funktioniert nur, wenn autoUpdate auf “atInstall”, “onLaunch” oder “always” eingestellt ist. Legacy-Werte für directUpdate sind für die Rückwärtskompatibilität weiterhin unterstützt. Erfordert die Installation und Konfiguration des @capacitor/splash-screen-Plugins mit launchAutoHide: false. Erfordert die Aktivierung von Auto-Update. Verfügbar auf Android und iOS.	false	7.6.0
periodCheckDelay	number	Konfigurieren Sie die Verzögerungszeit für den Zeitraum des Update-Checks. Die Einheit ist in Sekunden. Verfügbar auf Android, iOS und Electron. Kann 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 eines selbstgehosteten Update-Servers.	undefined	4.17.48
localHost	string	Konfigurieren Sie den CLI für die Verwendung eines lokalen Servers zum Testen oder eines selbstgehosteten Update-Servers.	undefined	4.17.48
localWebHost	string	Konfigurieren Sie den CLI für die Verwendung eines lokalen Servers zum Testen oder eines selbstgehosteten Update-Servers.	undefined	4.17.48
localSupa	string	Konfigurieren Sie den CLI für die Verwendung eines lokalen Servers zum Testen oder eines selbstgehosteten Update-Servers.	undefined	4.17.48
localSupaAnon	string	Konfigurieren Sie den CLI für die Verwendung eines lokalen Servers zum Testen.	undefined	4.17.48
localApi	string	Konfigurieren Sie den CLI für die Verwendung eines lokalen api zum Testen.	undefined	6.3.3
localApiFiles	string	Konfigurieren Sie den CLI für die Verwendung eines lokalen Dateisystems api zum Testen.	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	Setzen Sie die Standardkanal für die App in der Konfiguration. Groß-/Kleinschreibung beachten. Diese Einstellung wird die Standardkanal-Einstellung im Cloud übernehmen, wird aber die im Cloud vorgenommenen Übernahmen noch 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, 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 in die JavaScript-Konsole geschrieben. Nur die native Protokollierung wird durchgeführt.	false	7.3.0
shakeMenu	boolean	Aktivieren Sie die Erschütterungsgeste, um das Aktualisierungsmenü zum Debuggen/Prüfen zu zeigen	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()
• Schnittstellen
• 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, ansonsten wird ein Rollover durchgeführt. Dieses Verhalten kann mit {@link appReadyTimeout} geändert werden

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 für die Suche nach Updates verwendet wird.

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 eines leeren Strings deaktiviert die Statistiksammlung.

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

Seit: 5.4.0

---

setChannelUrl(…)

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

Setze die channelUrl für die App, dies wird verwendet, um den Kanal zu setzen.

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

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 DownloadOptions} für das Herunterladen eines neuen Bundle ZIP-Dateis.

Rückgabewert: Promise<BundleInfo>

---

next(…)

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

Setze das nächste Bundle, das bei einem Neustart der App verwendet werden soll.

Parameter	Typ	Beschreibung
options	BundleId	Enthält die ID des nächsten Bundle, das bei der nächsten App-Startseite gesetzt werden soll. Link}

BundleInfo.id Promise<BundleInfo>

---

Rückgabewert

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

Zur Zwischenablage kopieren

Setze das aktuelle Bundle und lade die App sofort neu.	Parameter	Typ
options	BundleId	Beschreibung BundleId__CAPGO_KEEP_0__

---

delete(…)

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

Löscht die angegebene Verpackung aus der native App-Speicherung. Verwenden Sie mit {@link list} um die gespeicherten Bundle-IDs zu erhalten.

Param	Typ	Beschreibung
options	BundleId	Ein {@link "BundleId"} Objekt, das die ID einer Verpackung enthält, die gelöscht werden soll (Hinweis: Dies ist die Verpackungs-ID, NICHT der Versionsname) Deletes the specified bundle from the native app storage. Use with {@link list} to get the stored Bundle IDs.A {__CAPGO_KEEP_0__} object containing the ID of a bundle to delete (note, this is the bundle id, NOT the version name)

---

list(…)

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

Alle lokal heruntergeladene Pakete in Ihrer App abrufen

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

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.

Parameter	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.

---

current()

current() => Promise<CurrentBundleResult>

Liefere das aktuelle Bundle, wenn keine gesetzt sind, liefert es builtin. currentNative ist das ursprüngliche Bundle, das auf dem Gerät installiert ist

Rückgabe: Promise<CurrentBundleResult>

---

reload()

reload() => Promise<void>

Lade die Ansicht neu

---

setMultiDelay(…)

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

Setzt ein {@link "DelayCondition"} Array mit 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 iso8601-Datumszeichenkette 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-Vorgang nach dem ersten Töten und nicht nach dem nächsten Hintergrundlaufen auslöst. Dies wird in einer zukünftigen großen Version behoben. Parameter TypBeschreibung date Das enthält das {@link "MultiDelayConditions"} background 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. nativeVersion Parameter kill Typ

Beschreibung	Das enthält das {@link "MultiDelayConditions"}	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.
options	MultiDelayConditions	Parameter TypenMenge von Bedingungen zum Setzen

Seit: 4.3.0

---

cancelDelay()

cancelDelay() => Promise<void>

Storniert eine { @link DelayCondition } zur sofortigen Verarbeitung eines Updates. Seit:getLatest(…)

Abschnitt mit dem Titel „getLatest(…) 4.0.0

---

Zum Kopieren in die Zwischenablage

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

Laden Sie das 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 Bootphase zu setzen. Verwenden Sie die defaultChannel in Ihrer Capacitor-Konfiguration anstatt.
• Diese Methode ist für die Verwendung nach der App-Initialisierung und der Benutzerinteraktion (z.B. das Beitritt zu einem Beta-Programm) vorgesehen.
• Öffentliche Kanäle können nicht selbst zugewiesen werden. Wenn ein Kanal als public, die Funktion setChannel() wird einen Fehler zurückgeben. Um einen öffentlichen Kanal zu verwenden, rufen Sie unsetChannel() an - der Gerät wird automatisch auf den passenden öffentlichen Kanal zurückfallen.
• 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. Nach dem Aufrufen dieser Methode 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 Standardaktualisierungsstrecke zurücksetzen
• 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>

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) und entweder öffentlich oder der 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()anstatt dessen, wenn Sie Ihre Kanalzuweisung entfernen, indem Sie unsetChannel(), wird das Gerät automatisch Updates von diesem öffentlichen Kanal erhalten.
• allow_self_set: Wenn true, ist dies ein selbstzuweisbarer KanalSie 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>

Einen benutzerdefinierten ID für dieses Gerät setzen

Parameter	Typ	Beschreibung
options	SetCustomIdOptions	ist der {@link} SetCustomIdOptions__CAPGO_KEEP_0__

Seit: 4.9.0

---

getBuiltinVersion()

getBuiltinVersion() => Promise<BuiltinVersion>

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

Rückgabewert: Promise<BuiltinVersion>

Seit: 5.2.0

---

getDeviceId()

getDeviceId() => Promise<DeviceId>

Erhalte eine 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>

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

Rückgabewert: Promise<PluginVersion>

---

isAutoUpdateEnabled()

isAutoUpdateEnabled() => Promise<AutoUpdateEnabled>

Erhalte den Zustand der Auto-Update-Konfiguration.

Rückgabewert: Promise<AutoUpdateEnabled>

---

removeAllListeners()

removeAllListeners() => Promise<void>

Entferne alle Listener für diesen Plugin.

Seit: 1.0.0

---

addListener(‘download’, …)

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

Höre auf das Ereignis zum Herunterladen der App-Bundle ab. Wird einmal ausgelöst, wenn das Herunterladen begonnen wurde, während des Herunterladens und wenn abgeschlossen ist. Dies gibt dir alle Download-Prozentsätze während des Herunterladens zurück

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

Rückgabewert: Promise<PluginListenerHandle>

Seit: 2.0.11

---

addListener(‘noNeedUpdate’, …)

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

Hören Sie auf das Ereignis ‘noNeedUpdate’, 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(‘updateAvailable’, …)

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

Verwenden Sie das Ereignis zur Verfügung stehender Updates, 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

Rückgabewert: Promise<PluginListenerHandle>

Seit: 4.0.0

---

addListener(‘downloadComplete’, …)

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

Verwenden Sie das Ereignis downloadComplete.

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 bei der App auf Major-Updates, informiert Sie, wenn ein Major-Update durch die Einstellung von disableAutoUpdateBreaking blockiert ist

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>

Listen auf Update-Fehlerereignis in der App, informiert Sie, wenn die Aktualisierung zum Installieren fehlschlägt bei der nächsten App-Start

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

Listen auf Download-Fehlerereignis in der App, informiert Sie, wenn eine Bundle-Download fehlschlägt

Param	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 ‘App-Neuladen’, informiert Sie, wenn das Neuladen erfolgt 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>

Hören Sie auf das Ereignis "app ready" in der App, um zu wissen, wenn die App bereit ist zum Einsatz zu sein

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>

Gibt das nächste Bundle zurück, das bei einem Neustart der App verwendet wird. Gibt null zurück, wenn kein nächstes Bundle gesetzt ist.

Rückgabewert: Promise<BundleInfo | null>

Seit: 6.8.0

---

setShakeMenu(…)

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

Aktiviert oder deaktiviert die Shake-Menü-Funktion für Debugging- und Testzwecke

Parameter	Typ	Beschreibung
options	SetShakeMenuOptions	Enthält einen booleschen Wert, um die Shake-Menü-Funktion zu aktivieren oder zu deaktivieren

Seit: 7.5.0

---

isShakeMenuEnabled()

isShakeMenuEnabled() => Promise<ShakeMenuEnabled>

Ermitteln Sie 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

ChannelUrl

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 angeben. Sitzungschlü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	Standardwert	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 Sitzungs-Schlüssel für die Aktualisierung, wenn das Bundle mit einem Sitzungs-Schlüssel verschlüsselt ist	undefined	4.0.0
checksum	string	Die Prüfsumme für die Aktualisierung, sie 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

BundleList-Ergebnis

Eigenschaft	Typ
bundles	BundleInfo[]

Listeoptionen

Beschreibung	Standardwert	Default	__CAPGO_KEEP_0__	Da
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 statt Dateien auf der Festplatte zu lesen.	false	6.14.0

Reset-Optionen

Eigenschaft	Typ
toLastSuccessful	boolean

Aktueller Bundle-Ergebnis

Eigenschaft	Typ
bundle	BundleInfo
native	string

Mehrfach verzögerte Bedingungen

Eigenschaft	Typ
delayConditions	DelayCondition[]

Verzögerungsbedingung

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

Neueste Version

Eigenschaft	Typ	Beschreibung	Seit
version	string	Ergibt sich aus 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

GetLatestOptions

Eigenschaft	Typ	Beschreibung	Standard	Seit
channel	string	Der Kanal, um die neueste Version zu erhalten. Der Kanal muss ‘self_assign’ zulassen, 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

Eigenschaft	Typ	Beschreibung	Seit
channel	string	Aktueller Status von get channel	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

KanalInfo

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

Kanal-Befehle verwenden den Kanal name, nicht diesen numerischen id.

SetCustomIdOptions

Abschnitt mit dem Titel “SetCustomIdOptions”	Prop
customId	string

Typ

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

NoNeedEvent

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

UpdateAvailableEvent

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

DownloadCompleteEvent

Prop	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 Hauptbundle verfügbar ist.	4.0.0

UpdateFailedEvent

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

Herunterladungsfehlerereignis

Eigenschaft	Typ	Beschreibung	Seit
version	string	Wird ausgelöst, wenn eine Herunterladung fehlschlägt.	4.0.0

App-Startereignis

Eigenschaft	Typ	Beschreibung	Seitdem
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 zu werden. SET als das nächste Bundle. downloaden: Das Bundle wird heruntergeladen. SET als das nächste Bundle. fehlgeschlagen: Das Bundle ist fehlgeschlagen, um heruntergeladen zu werden.

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

Verschieben bis zum nächsten

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

Weitermachen von Funktionen und Einstellungen

Wenn Sie " Funktionen und Einstellungen zum Planen von Dashboard 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.