Funktionen und Einstellungen

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 | ‘off’ | ‘atBackground’ | ‘atInstall’ | ‘onLaunch’ | ‘always’ | ‘onlyDownload’	Konfigurieren Sie, wie das Plugin Auto-Update über einen Update-Server verwendet. true entspricht ‘atBackground’; false entspricht ‘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-Aktualisierung, ansonsten verwenden Sie atBackground - onLaunch: Anwenden sofort bei der Startanzeige, ansonsten verwenden Sie atBackground nach der Startprü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, 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 Updateantrag 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 “immer”. 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” - immer: Gleichbedeutend mit autoUpdate: “immer” - true: Gleichbedeutend mit “immer” 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 für die Rückwärtskompatibilität weiterhin unterstützt. Benötigt das @capacitor/splash-screen-Plugin, das installiert und mit launchAutoHide: false konfiguriert sein muss. Benötigt die Aktualisierung auf Android und iOS aktiviert zu sein.	false	7.6.0
periodCheckDelay	number	Konfigurieren Sie die Verzögerungszeit für die Periodeaktualisierung. 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 die Testung oder eines selbstgehosteten Aktualisierungsservers.	undefined	4.17.48
localHost	string	Konfigurieren Sie den CLI zur Verwendung eines lokalen Servers für die Testung oder eines selbstgehosteten Aktualisierungsservers.	undefined	4.17.48
localWebHost	string	Konfigurieren Sie den CLI zur Verwendung eines lokalen Servers für die Testung oder eines selbstgehosteten Aktualisierungsservers.	undefined	4.17.48
localSupa	string	Konfigurieren Sie den CLI zur Verwendung eines lokalen Servers für die Testung.	undefined	4.17.48
localSupaAnon	string	Konfigurieren Sie den CLI zur Verwendung eines lokalen __CAPGO_KEEP_1__ für die Testung.	undefined	4.17.48
localApi	string	Konfigurieren Sie den CLI zur Verwendung eines lokalen Dateisystems api für die Testung.	undefined	6.3.3
localApiFiles	string	Configure the CLI to use a local file api for testing.	undefined	6.3.3
allowModifyUrl	boolean	__CAPGO_KEEP_0__ ist ein Platzhalter für den Plugin-Namen, __CAPGO_KEEP_1__ ist ein Platzhalter für die Datei- oder Server-URL.	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 in der Cloud überschreiben, aber die in der Cloud vorgenommenen Überschreibungen 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 die native Protokollierung wird durchgeführt.	false	7.3.0
shakeMenu	boolean	Aktivieren Sie die Erschütterungsgeste, um das Aktualisierungs-Menü für Debugging- und Testzwecke anzuzeigen.	false	7.5.0

Beispiele

Zum Clipboard kopieren 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
    }
  }
}

Zum Clipboard kopieren 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- Alias

Methode

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. Ä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 zum Senden von Statistiken verwendet wird.

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

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	Der {@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 einem Neustart der App verwendet werden soll.

Param	Typ	Beschreibung
options	BundleId	Enthält die ID des nächsten Bundle, das bei dem nächsten App-Start verwendet 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 dem native App-Storage. 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 Bundles enthält (Hinweis: Dies ist die Bundle-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	list(…)
options	ListOptions	Alle lokal heruntergeladenen Bundles in Ihrer App abrufen ListeOptionen__CAPGO_KEEP_0__ für die Auflistung 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	Mit {@link} ResetOptions.toLastSuccessful}, true wird auf die interne 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 ursprüngliche Bundle zurück, das auf dem Gerät installiert ist builtinRückgabe:

reload() Promise<CurrentBundleResult>

---

Abschnitt mit dem Titel “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 Hintergrund- oder App-Kill 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 Kill und nicht nach dem nächsten Hintergrund wie bei anderen Optionen ausgelö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 das {@link MultiDelayConditions}-Array von Bedingungen zum Setzen

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 Plugin-gesteuerten lokalen Kanal für dieses Gerät. Der Kanal muss allow_device_self_set für dies zu funktionieren.

setChannel() Überprüft den Kanal mit dem Backend und speichert den ausgewählten Kanal lokal auf dem Gerät. Es wird weder ein Backend-Device-Überschreibung erstellt noch aktualisiert, daher erscheint das Gerät nicht als überschrieben im Capgo-Dashboard. Nur Zuweisungen, die aus dem Dashboard oder dem öffentlichen API erstellt wurden, werden im Device-Überschreibungs-UI angezeigt.

Wichtige Hinweise:

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

Param	Typ	Beschreibung
options	SetChannelOptions	Ist der Kanal zum Setzen von {@link SetChannelOptions}

Kanal zum Setzen Promise<ChannelRes>

Rückgabewert: 4.7.0

---

Seit:

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

Setzen Sie den Plugin-gesteuerten lokalen Kanal für dieses Gerät zurück. Dies löscht nur den lokal von setChannel() es löscht jedoch keine Dashboard- oder öffentlichen API Geräteüberschreibungsdaten.

Nach dem Aufrufen dieser Methode gelten die normalen Kanalvorrangregeln: Ein bestehendes Dashboard- oder öffentliches API Geräteüberschreibungsdatum gewinnt immer noch; andernfalls kann das Gerät auf den passenden öffentlichen/Standardkanal für seine Bedingungen (Plattform, Geräetyp, Build-Typ) zurückfallen.

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 selbstständig über setChannel())

Param	Type
options	UnsetChannelOptions

Seit: 4.7.0

---

getChannel()

getChannel() => Promise<GetChannelRes>

Ermittle den Kanal für dieses Gerät

Rückgabewert: Promise<GetChannelRes>

Seit: 4.8.0

---

listChannels()

listChannels() => Promise<ListChannelsResult>

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

Jeder Kanal in der Ergebnisliste enthält:

• publicWenn true, dies ist ein Standardkanal. Sie können es nicht selbst zuweisen, indem Sie setChannel(). Stattdessen entfernen Sie Ihre Kanalzuweisung mit unsetChannel(), dann wird das Gerät automatisch Updates von diesem öffentlichen Kanal erhalten.
• allow_self_set: Wenn true, ist dies ein selbst zuweisbarer 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, die festgelegt werden soll

Seit: 4.9.0

---

getBuiltinVersion()

getBuiltinVersion() => Promise<BuiltinVersion>

Holen Sie sich die native App-Version oder die in der Konfiguration gesetzte Builtin-Version

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>

Stellt die native Capacitor Updater-Pluginversion dar (wird 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ört auf das Ereignis des Bundle-Downloads im 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

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

Rückgabewert: Promise<PluginListenerHandle>

Seit: 2.0.11

---

addListener(‘noNeedUpdate’, …) hinzufügen

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

Hört auf das Ereignis, dass kein Update erforderlich ist, nützlich, wenn Sie jede Zeit, wenn die App gestartet wird, eine Zwangskontrolle durchführen möchten

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

Returns: Promise<PluginListenerHandle>

Seit: 4.0.0

---

addListener(‘updateAvailable’, …)

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

Verwenden Sie diesen Event, um bei jedem App-Start eine Überprüfung durchzuführen

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

Returns: Promise<PluginListenerHandle>

Seit: 4.0.0

---

addListener(‘downloadComplete’, …)

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

Hören Sie auf Download-Complete-Ereignisse.

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 Major-Update-Ereignisse in der App, um zu erfahren, wenn eine Major-Update-Blockierung durch die Einstellung von disableAutoUpdateBreaking erfolgt 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>

Hören Sie im App nach dem update-Fehlerereignis, damit Sie wissen, wenn die Aktualisierung 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ört bei einem Download-Fehlerereignis im App nach, informiert Sie, wenn ein Bundle-Download fehlgeschlagen ist

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ört bei einem Reloadereignis im App nach, informiert Sie, wenn ein Reload erfolgt ist

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

Wert zurückgeben: Promise<PluginListenerHandle>

Seit: 4.3.0

---

addListener(‘appReady’, …)

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

App-Ready-Ereignis abrufen, informiert Sie, wenn die App bereit ist zum Einsatz

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

Wert zurückgeben: 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: 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/Zwischenspeicherungszwecke

Param	Typ	Beschreibung
options	SetShakeMenuOptions	Enthält einen booleschen Wert, um das Shake-Menü 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

---

Schnittstellen

AppReady-Ergebnis

Eigenschaft	Typ
bundle	BundleInfo

Bündelinformationen

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

Update-URL

Eigenschaft	Typ
url	string

Stats-URL

Eigenschaft	Typ
url	string

Kanal-URL

Eigenschaft	Typ
url	string

Herunterlademöglichkeiten

Diese URL und Versionen werden verwendet, um das Bundle vom Server herunterzuladen, 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. SessionKey sind erforderlich, wenn Sie das Bundle mit dem CLI-Befehl encrypt verschlüsselt haben, Sie sollten sie als Ergebnis des Befehls erhalten.

Eigenschaft	Typ	Beschreibung	Standard	Seit
url	string	Die URL des zip-Dateis des Bundles (z.B. dist.zip), das heruntergeladen werden soll. (Dies kann jede URL sein. Zum Beispiel: Amazon S3, ein GitHub-Tag, jeder andere Ort, an dem Sie Ihr Bundle gehostet haben.)
version	string	Die Version code/Name dieses Bundles/Version
sessionKey	string	Die Sitzungsschlüssel für die Aktualisierung, wenn das Bundle mit einer Sitzungsschlü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) multi-file 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

Aktueller Bundle-Ergebniswert

Eigenschaft	Typ
bundle	BundleInfo
native	string

Mehrfach verzögerte Bedingungen

Eigenschaft	Typ
delayConditions	DelayCondition[]

Verzögerungsbedingung

Eigenschaft	Typ	Beschreibung
kind	DelayUntilNext	Einstellungen für verzögerte Bedingungen in setMultiDelay
value	string

Neueste Version

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

Optionen für GetLatest

Eigenschaft	Typ	Beschreibung	Standard	Seit
channel	string	Der Kanal, um die neueste Version für den Kanal 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

SetChannelOptions

Eigenschaft	Typ
triggerAutoUpdate	boolean

GetChannelRes

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

ListChannelsResult

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

ChannelInfo

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 ein Standard-/Rückfall-Kanal. Geräte können sich nicht selbst auf öffentliche Kanäle eintragen. Stattdessen wird, wenn ein Gerät seine Kanal-Übertragung (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 eintragen, indem sie setChannel() verwenden. 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 diese numerische id.

SetCustomIdOptions

Eigenschaft	Typ
customId	string

BuiltinVersion

Eigenschaft	Typ
version	string

Geräte-ID

Eigenschaft	Typ
deviceId	string

Plugin-Version

Eigenschaft	Typ
version	string

Automatische Aktualisierung aktiviert

Eigenschaft	Typ
enabled	boolean

Plugin-Listener-Handle

Eigenschaft	Typ
remove	() => Promise<void>

Download-Event

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

KeineBrauchEvent

Eigenschaft	Typ	Beschreibung	Seit
bundle	BundleInfo	Aktueller Status der Herunterladung, 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	Wird ausgelöst, wenn ein neuer Update verfügbar ist.	4.0.0

MajorAvailableEvent

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

UpdateFailedEvent

Eigenschaft	Typ	Beschreibung	Seit
bundle	BundleInfo	Wird ausgelöst, wenn eine Aktualisierung nicht installiert werden konnte.	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	Wird ausgelöst, wenn die App zum Einsatz bereit ist.	5.2.0
status	string

AutoUpdateAvailable

Eigenschaft	Typ
available	boolean

SetShakeMenuOptions

Eigenschaft	Typ
enabled	boolean

ShakeMenuEnabled

Eigenschaft	Typ
enabled	boolean

Typ-Bezeichner

Abschnitt mit dem Titel “Typ-Bezeichner”

pending: Die Verpackung ist noch nicht bereit SET als das nächste Bundle. herunterladen: Das Bundle wird heruntergeladen. erfolg: Das Bundle wurde heruntergeladen und ist bereit.

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

SET

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

Bis zum nächsten

Weitermachen von Funktionen und Einstellungen Abschnitt mit dem Titel “Weitermachen von Funktionen und Einstellungen” to plan dashboard and API operations, connect it with Funktionen und Einstellungen" zum Planen Ihres Dashboards und capgo-Operationen verwenden, verbinden Sie es mit "Using @capgo/capacitor-updater" für die native Fähigkeit in Verwendung von @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.