Funktionen und Einstellungen

Updater-Plugin-Konfiguration

Siehe den Github Readme zur weiteren Information.

CapacitorUpdater kann mit diesen Optionen konfiguriert werden:

Eigenschaft	Typ	Beschreibung	Standard	Seit
appReadyTimeout	number	Konfigurieren Sie die Anzahl der Millisekunden, nach denen das native Plugin eine Aktualisierung als ‘fehlgeschlagen’ 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 ist gleichbedeutend mit „hintergrundmäßig“; false ist gleichbedeutend mit „ausgeschaltet“. - ausgeschaltet: Deaktivieren Sie Auto-Update - hintergrundmäßig: Überprüfen und herunterladen Sie automatisch, dann anwenden, wenn die App in den Hintergrund wechselt - beiInstall: Anwenden Sie sofort nur nach einer frischen Installation oder einer native App-Update, ansonsten verwenden Sie hintergrundmäßig - beiStart: Anwenden Sie sofort bei Start, ansonsten verwenden Sie hintergrundmäßig nach der Start-Überprüfung - immer: Anwenden Sie sofort, wenn Auto-Update läuft - nurHerunterladen: Überprüfen und herunterladen Sie automatisch, emittieren Sie 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 native 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 native code. Verfügbar auf Android, iOS und Electron.	undefined	4.17.48
directUpdate	boolean | ‘always’ | ‘atInstall’ | ‘onLaunch’	Veraltet. Verwenden Sie stattdessen die Auto-Update-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 werden 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 der Auto-Update-Funktion. Verfügbar auf Android und iOS.	false	7.6.0
periodCheckDelay	number	Konfigurieren Sie die Verzögerungszeit für den Zeitraum der 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 einer selbstgehosteten Update-Server.	undefined	4.17.48
localHost	string	Konfigurieren Sie den CLI zur Verwendung eines lokalen Servers für Tests oder einer selbstgehosteten Update-Server.	undefined	4.17.48
localWebHost	string	Konfigurieren Sie den CLI zur Verwendung eines lokalen Servers für Tests oder einer selbstgehosteten Update-Server.	undefined	4.17.48
localSupa	string	Konfigurieren Sie den CLI zur Verwendung eines lokalen Servers für Tests.	undefined	4.17.48
localSupaAnon	string	Konfigurieren Sie den CLI zur Verwendung einer lokalen __CAPGO_KEEP_1__ für Tests.	undefined	4.17.48
localApi	string	Konfigurieren Sie den CLI zur Verwendung einer lokalen Datei api für Tests.	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 erforderlicher Parameter. Bitte ersetzen Sie ihn durch den tatsächlichen Wert.	false	5.4.0
defaultChannel	string	Setze die Standardkanal für die App in der Konfiguration. Groß- und Kleinschreibung beachten. Diese Einstellung wird die im Cloud gesetzte Standardkanal überschreiben, aber die im 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 wird. 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 in die JavaScript-Konsole geschrieben. Nur die native Protokollierung wird durchgeführt.	false	7.3.0
shakeMenu	boolean	Aktiviere den Schiebe-Gestus, um das Aktualisierungs-Menü für Debugging/Zwischenspeicherungszwecke 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
• Typische Aliasnamen

Methode

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 Rollback durchgeführt) Standardmäßig sollte diese Methode innerhalb der ersten 10 Sekunden nach App-Start aufgerufen werden, andernfalls wird ein Rollback durchgeführt. Ändern Sie dieses Verhalten mit {@link appReadyTimeout}

Rückgabe: Promise<AppReadyResult>

---

setUpdateUrl(…)

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

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

Param	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. Das Übergeben einer leeren Zeichenkette wird die Erfassung von Statistiken deaktivieren.

Param	Typ	Beschreibung
options	StatsUrl	enthält die URL, die zum Senden 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 zum Setzen des Kanals verwendet werden soll.

Seit: 5.4.0

---

download(…)

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

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

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

Rückgabewert: Promise<BundleInfo>

---

weiter(…)

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

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

Param	Typ	Beschreibung
options	BundleId	Enthält die ID des nächsten Bundle, das bei der nächsten App-Ladung 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 die angegebene 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 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}	list(…)
options	ListOptions	Copy to clipboard ListeOptionen__CAPGO_KEEP_0__ zur Auflistung von Bundles

Rückgabe: Promise<BundleListResult>

---

reset(…)

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

Setze die App auf den builtin Bundle (das einem Apple App Store / Google Play Store gesendet wurde) oder das letzte erfolgreich geladene Bundle zurück.

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 keine gesetzt sind, 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 Hintergrundstart oder einem App-Töten installiert wird. Für den "kind", sollte der Wert eine ISO-8601-Datumszeichenfolge sein. Für den "kind", sollte der Wert eine Zahl in Millisekunden sein. Für den "kind", sollte der Wert eine Versionsnummer sein. Für den "kind", wird der Wert nicht verwendet. Die Funktion zeigt inkonsistentes Verhalten, wenn die Option "kill" den Update-Vorgang nach dem ersten Töten und nicht nach dem nächsten Hintergrundstart 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 den {@link MultiDelayConditions}-Array von Bedingungen, um

Seit: 4.3.0

---

cancelDelay()

cancelDelay() => Promise<void>

Storniert einen {@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 die vom Plugin verwaltete lokale 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. bei der Teilnahme an einem 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 entsprechenden ö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	Stellt den Kanal für die Einstellung {@link SetChannelOptions} dar.

Rückgabewert: Promise<ChannelRes>

Seit: 4.7.0

---

unsetChannel(…)

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 gespeicherten Kanal und nicht die Dashboard- oder öffentlichen Geräteüberschreibungsdaten. setChannel(); it does not delete Dashboard or Public API Device Override records.

After calling this method, normal channel precedence applies: an existing Dashboard or Public API Device Override still wins; otherwise the device can fall back to the matching public/default channel for its conditions (platform, device type, build type).

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
• Param setChannel())

Type	Seit:
options	UnsetChannelOptions

getChannel() 4.7.0

---

Abschnitt mit dem Titel “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 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 sich selbst zuweisen lassen.

Jeder Kanal im Ergebnis 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>

Eine benutzerdefinierte ID für dieses Gerät festlegen

Parameter	Typ	Beschreibung
options	SetCustomIdOptions	ist die {@link SetCustomIdOptions} benutzerdefinierteId, die festgelegt werden soll

Seit: 4.9.0

---

getBuiltinVersion()

getBuiltinVersion() => Promise<BuiltinVersion>

Erhalten Sie die native App-Version oder die in der Konfiguration gesetzte Version, wenn sie gesetzt ist

Returns: Promise<BuiltinVersion>

Seit: 5.2.0

---

getDeviceId()

getDeviceId() => Promise<DeviceId>

Eindeutige ID zur Identifizierung des Geräts (wird an Auto-Update-Server gesendet)

Returns: Promise<DeviceId>

---

getPluginVersion()

getPluginVersion() => Promise<PluginVersion>

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

Returns: 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 wurde, während des Herunterladens und wenn 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

Wert zurückgeben: Promise<PluginListenerHandle>

Seit: 4.0.0

---

addListener(‘updateAvailable’, …)

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

Verwenden Sie das verfügbare Update-Ereignis zum Abhören, nützlich, wenn Sie jede Zeit, wenn die App gestartet wird, eine Zwangskontrolle durchführen möchten

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

Wert zurückgeben: 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, lassen Sie Sie wissen, wenn ein Major-Update durch die Einstellung von disableAutoUpdateBreaking blockiert ist

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

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

Wert zurückgeben: Promise<PluginListenerHandle>

Seit: 2.3.0

---

addListener(‘downloadFailed’, …)

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

Hört bei der App auf das Download-Fehlerereignis zu, damit Sie wissen, wenn ein Bundle heruntergeladen hat fehlschlagen

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

Rückgabewert: Promise<PluginListenerHandle>

Seit: 4.0.0

---

addListener(‘appReloaded’, …) hinzufügen

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

Hört bei der App auf das Reload-Ereignis zu, damit Sie wissen, wenn eine Neuladung 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>

Get if auto update ist verfügbar (nicht durch serverUrl deaktiviert).

Returns: Promise<AutoUpdateAvailable>

---

getNextBundle()

getNextBundle() => Promise<BundleInfo | null>

Erhalte das nächste Bundle, das verwendet wird, wenn die App neu geladen wird. Returns null, wenn kein nächstes Bundle gesetzt ist.

Returns: Promise<BundleInfo | null>

Since: 6.8.0

---

setShakeMenu(…)

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

Aktivieren oder deaktivieren Sie das Shake-Menü für Debugging/Zwischenspeicherungszwecke

Parameter	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

StatsUrl

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

aktuelles Paketergebnis

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’ erlauben, damit dies funktioniert	undefined	6.8.0

ChannelRes

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

SetChannelOptions

Eigenschaft	Typ
channel	string
triggerAutoUpdate	boolean

SetChannelOptions deaktivieren

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

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

ChannelInfo

Prop	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ückfallkanal. Geräte können sich nicht selbst auf öffentliche Kanäle zuweisen. Stattdessen wird, wenn ein Gerät seinen Kanal-Übertrag (mit "") entfernt, es automatisch Updates vom entsprechenden öffentlichen Kanal erhalten. unsetChannel()Wenn wahr, können Geräte sich explizit auf diesen Kanal mithilfe von "" zuweisen. Dies wird typischerweise für Beta-Tests, A/B-Tests oder opt-in-Update-Tracks verwendet.	7.5.0
allow_self_set	boolean	Kanalbefehle verwenden den Kanal setChannel(), nicht diese numerische "	7.5.0

SetCustomIdOptions nameSetCustomIdOptions id.

SetCustomIdOptions

Eigenschaft	Typ
customId	string

Bauartversion

Eigenschaft	Typ
version	string

Geräte-ID

Eigenschaft	Typ
deviceId	string

Pluginversion

Eigenschaft	Typ
version	string

Automatische Aktualisierung aktiviert

Eigenschaft	Typ
enabled	boolean

Plugin-Listener-Handle

Typ	Herunterladungsereignis
remove	() => Promise<void>

__CAPGO_KEEP_0__

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

NoNeedEvent

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

UpdateAvailableEvent

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

DownloadCompleteEvent

Prop	Type	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 Hauptbundle 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

BundleStatus

pendend: Das Bundle ist noch nicht bereit SET als das nächste Bundle. als das nächste Bundle herunterladen: Das Bundle wird heruntergeladen. erfolg: Das Bundle wurde heruntergeladen und ist bereit zum Ausführen. SET als das nächste Bundle.

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

fehler: Das Bundle konnte nicht heruntergeladen werden.

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

Abschnitt mit dem Titel “Warten bis zum nächsten”

Abschnitt mit dem Titel “Fortsetzen von Funktionen und Einstellungen” Wenn Sie " to plan dashboard and API operations, connect it with 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.