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	Standard	Seit
appReadyTimeout	number	Konfigurieren Sie die Anzahl der Millisekunden, nach denen das native Plugin eine Aktualisierung als ‘fehlgeschlagen’ betrachtet.	10000 // (10 seconds)
responseTimeout	number	Konfigurieren Sie die Anzahl der Millisekunden, nach denen das native Plugin eine API Timeout betrachtet.	20000 // (20 seconds)
autoDeleteFailed	boolean	Konfigurieren Sie, ob das Plugin automatisch fehlgeschlagene Pakete löschen soll.	true
autoDeletePrevious	boolean	Konfigurieren Sie, ob das Plugin automatisch vorherige Pakete nach einer erfolgreichen Aktualisierung löschen soll.	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-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 an.	”atBackground” // true is still accepted
resetWhenUpdate	boolean	Automatisch löschen Sie die vorher heruntergeladenen Pakete, wenn ein neueres natives App-Paket auf das Gerät installiert wird. Verfügbar auf Android, iOS und Electron.	true
updateUrl	string	Konfigurieren Sie die URL / Endpunkt, an den Aktualisierungsprüfungen gesendet werden. Verfügbar auf Android, iOS und Electron.	https://plugin.capgo.app/updates
channelUrl	string	Konfigurieren Sie die URL / Endpunkt für Kanaloperationen. Verfügbar auf Android, iOS und Electron.	https://plugin.capgo.app/channel_self
statsUrl	string	Konfigurieren Sie die URL / Endpunkt, an den Aktualisierungsstatistiken gesendet werden. Verfügbar auf Android, iOS und Electron. Setzen Sie auf "" um die Statistikberichterstattung zu deaktivieren.	https://plugin.capgo.app/stats
publicKey	string	Konfigurieren Sie die öffentliche Schlüssel für Ende-zu-Ende-Live-Update-Verschlüsselung Version 2. Verfügbar auf Android, iOS und Electron.	undefined	6.2.0
version	string	Konfigurieren Sie die aktuelle Version der App. Diese wird für den ersten Aktualisierungsantrag verwendet. Wenn nicht gesetzt, wird der Plugin die Version vom native code. Verfügbar auf Android, iOS und Electron.	undefined	4.17.48
directUpdate	boolean | ‘always’ | ‘atInstall’ | ‘onLaunch’	Veraltet. Verwenden Sie stattdessen die autoUpdate-String-Modi: “atInstall”, “onLaunch” oder “always”. Diese Option bleibt für bestehende Apps unterstützt. - false: Führen Sie keine direkten Updates durch - atInstall: Gleichbedeutend mit autoUpdate: “atInstall” - onLaunch: Gleichbedeutend mit autoUpdate: “onLaunch” - always: Gleichbedeutend mit autoUpdate: “always” - true: Gleichbedeutend mit “always” für die Rückwärtskompatibilität. Verfügbar auf Android, iOS und Electron.	false	5.1.0
autoSplashscreen	boolean	Automatisch die Versteckung des Splashscreens steuern, wenn Instant-Apply-Modi verwendet werden. Wenn aktiviert, versteckt der Plugin automatisch den Splashscreen nach Updates oder wenn kein Update erforderlich ist. Dies entfernt die Notwendigkeit, manuell auf appReady-Ereignisse zu hören und SplashScreen.hide() aufzurufen. Funktioniert nur, wenn autoUpdate auf „atInstall“, „onLaunch“ oder „always“ eingestellt ist. Legacy-Werte für directUpdate sind weiterhin für die Kompatibilität mit älteren Versionen unterstützt. Erfordert die Installation und Konfiguration des @capacitor/splash-screen-Plugins mit launchAutoHide: false. Erfordert die Aktivierung der Auto-Update-Funktion. Verfügbar auf Android und iOS.	false	7.6.0
periodCheckDelay	number	Konfigurieren Sie die Verzögerungszeit für die periodische Überprüfung auf Updates. 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 oder einer selbstgehosteten Update-Server.	undefined	4.17.48
localSupaAnon	string	Konfigurieren Sie den CLI zur Verwendung eines lokalen Servers für Tests.	undefined	4.17.48
localApi	string	Konfigurieren Sie den CLI zur Verwendung eines lokalen api für Tests.	undefined	6.3.3
localApiFiles	string	Konfigurieren Sie den CLI zur Verwendung eines lokalen Dateisystems api für Tests.	undefined	6.3.3
allowModifyUrl	boolean	Ermöglichen Sie dem Plugin, die updateUrl, statsUrl und channelUrl dynamisch von der JavaScript-Seite zu ändern.	false	5.4.0
defaultChannel	string	Setze die Standardkanal für die App in der Konfiguration. Fallunterscheidung. Diese Einstellung wird die Standardkanal in der Cloud überschreiben, respektiert aber die in der Cloud vorgenommenen Überschreibungen.	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, 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	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 Update-Menü für Debugging-/Testzwecke anzuzeigen	false	7.5.0

Beispiele

In capacitor.config.json:

{
  "plugins": {
    "CapacitorUpdater": {
      "appReadyTimeout": 1000 // (1 second),
      "responseTimeout": 10 // (10 second),
      "autoDeleteFailed": false,
      "autoDeletePrevious": false,
      "autoUpdate": "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 Alias

Methoden

notifyAppReady()

notifyAppReady() => Promise<AppReadyResult>

Benachrichtige den Capacitor-Updater darüber, dass die aktuelle Bundle läuft (wird bei Nichtaufruf dieser Methode bei jedem App-Start ein Rollback durchgeführt) Standardmäßig sollte diese Methode innerhalb der ersten 10 Sekunden nach App-Start aufgerufen werden, ansonsten wird ein Rollback durchgeführt. Dieses Verhalten kann mit {@link appReadyTimeout} geändert werden

Rückgabe: Promise<AppReadyResult>

---

setUpdateUrl(…)

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

Setze die updateUrl für die App, diese wird verwendet, um Updates zu überprüfen.

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>

,

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

Laden Sie ein neues Bundle von der bereitgestellten URL herunter, 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>

---

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 BundleIdEin Objekt vom Typ BundleId, 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 Pakets enthält (Hinweis: Dies ist die Paket-ID, NICHT der Versionsname) list(…)Abschnitt mit dem Titel “list(…)

---

Auf die Zwischenablage kopieren

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

Typ

Beschreibung	Das {@link} Objekt	Section titled “list(…)
options	ListOptions	Get all locally downloaded bundles in your app Listmöglichkeiten} zum Auflisten von Bundles

Rückgabe: Promise<BundleListResult>

---

reset(…)

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

Setze die App auf den builtin Bundle (das an die Apple App Store / Google Play Store gesendet wurde) oder den letzten erfolgreich geladenen Bundle.

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

---

current()

current() => Promise<CurrentBundleResult>

Gibt das aktuelle Bundle zurück, wenn keine gesetzt sind, gibt es das Standardbundle 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 gewohnt 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" aktiviert ist. Die Aktualisierung wird nach dem ersten Töten des Apps und nicht nach dem nächsten Hintergrundstart 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 den {@link MultiDelayConditions} Array von Bedingungen, um

Seit: 4.3.0

---

cancelDelay()

cancelDelay() => Promise<void>

Storniert eine {@link DelayCondition}, um eine Aktualisierung sofort zu verarbeiten.

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 Plugin-gesteuerte 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, dann speichert der ausgewählte Kanal lokal auf dem Gerät. Es wird kein Backend-Device-Überschreibung erstellt oder aktualisiert, daher wird das Gerät nicht als überschrieben im Capgo-Dashboard angezeigt. Nur Zuweisungen, die aus dem Dashboard oder dem öffentlichen API erstellt wurden, werden im Device-Überschreibung-UI angezeigt.

Wichtige Hinweise:

• Verwenden Sie diese Methode nicht, um den Kanal bei der Startphase zu setzen. Verwenden Sie stattdessen 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 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	Setzt den Kanal {@link SetChannelOptions} zum Setzen

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 von setChannel()gespeicherten Kanal und löscht nicht die Dashboard- oder Public API Geräteüberschreibungsdaten.

Nach dem Aufrufen dieser Methode gelten die normalen Kanalvorrangregeln: Ein bestehendes Dashboard- oder Public API Geräteüberschreibungsdatum gewinnt immer noch; andernfalls kann das Gerät auf den passenden öffentlichen/Standardkanal für seine Bedingungen (Plattform, Gerärtyp, 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 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 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 gesetzt werden soll

Seit: 4.9.0

---

getBuiltinVersion()

getBuiltinVersion() => Promise<BuiltinVersion>

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

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

Returns: Promise<DeviceId>

---

getPluginVersion()

getPluginVersion() => Promise<PluginVersion>

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

Returns: Promise<PluginVersion>

---

isAutoUpdateEnabled()

isAutoUpdateEnabled() => Promise<AutoUpdateEnabled>

Ermitteln Sie den Zustand der Auto-Update-Konfiguration.

Rückgabe: 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>

Bei der App den Download-Event abhören. Wird einmalig ausgelöst, wenn der Download gestartet wurde, während des Downloadens und wenn er fertig ist. Dies gibt Ihnen alle Download-Prozentsätze während des Downloads zurück

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

Bei der App das Update-Event abhören, nützlich, wenn Sie jede Zeit das Update überprüfen möchten, wenn die App gestartet wird

Param	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 diesen Event, um bei jedem App-Start eine Aktualisierung zu überprüfen

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>

Hören Sie nach downloadComplete-Ereignissen.

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 nach dem Major-Update-Ereignis in der App, um zu erfahren, wenn ein Major-Update durch die Einstellung von disableAutoUpdateBreaking blockiert wird.

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

Rückgabewert: Promise<PluginListenerHandle>

Seit: 2.3.0

---

addListener(‘updateFailed’, …)

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

Hören Sie auf das Ereignis “Update fehlgeschlagen” in der App, damit Sie wissen, wenn die Aktualisierung bei der nächsten App-Start fehlschlägt

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

Rückgabewert: Promise<PluginListenerHandle>

Seit: 2.3.0

---

addListener(‘downloadFailed’, …)

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

Höre bei einem Download-Fehlerereignis im App nach, um zu wissen, 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öre bei einem Reloadereignis im App nach, um zu wissen, wenn ein Reload geschehen 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, um zu erfahren, 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 automatische Aktualisierung verfügbar ist (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/Zwischenschaltzwecke

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

Bundle-Informationen

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

Update-URL

Eigenschaft	Typ
url	string

StatsUrl

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. SessionKeys sind erforderlich, wenn Sie das Bundle mit dem Befehl CLI 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 zu lesen anstatt Dateien auf der Festplatte.	false	6.14.0

ResetOptions

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

Eigenschaft	Typ
triggerAutoUpdate	boolean

Kanalabruf

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 zuweisen. Stattdessen wird, wenn ein Gerät seine Kanal-Überschreibung (mit "") entfernt, es automatisch Updates vom passenden öffentlichen Kanal erhalten. unsetChannel()Wenn wahr, können Geräte sich explizit auf diesen Kanal zuweisen, indem sie "" verwenden. Dies wird typischerweise für Beta-Tests, A/B-Tests oder opt-in-Update-Tracks verwendet.	7.5.0
allow_self_set	boolean	Kanal-Befehle verwenden den Kanal " setChannel(), nicht diese numerische "	7.5.0

SetCustomIdOptions name__CAPGO_KEEP_0__ id.

__CAPGO_KEEP_0__

Eigenschaft	Typ
customId	string

Bauartversion

Eigenschaft	Typ
version	string

Geräte-ID

Eigenschaft	Typ
deviceId	string

Pluginversion

Eigenschaft	Typ
version	string

Automatische Aktualisierung aktivieren

Eigenschaft	Typ
enabled	boolean

Plugin-Listener-Handle

Eigenschaft	Typ
remove	() => Promise<void>

Download-Event

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 eine neue Aktualisierung verfügbar ist.	4.0.0

MajorAvailableEvent

Eigenschaft	Typ	Beschreibung	Seit
version	string	Wird ausgelöst, wenn eine neue Hauptversion 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 eine Herunterladen fehlschlägt.	4.0.0

AppReadyEvent

Prop	Typ	Beschreibung	Seit
bundle	BundleInfo	Ausgelöst, wenn die App zum Einsatz bereit ist.	5.2.0
status	string

AutoUpdateAvailable

Prop	Typ
available	boolean

SetShakeMenuOptions

Eigenschaft	Typ
enabled	boolean

ShakeMenuEnabled

Eigenschaft	Typ
enabled	boolean

Typ-Bezeichner

BundleStatus

pending: Die Verpackung ist noch nicht bereit SET als das nächste Bundle herunterladen. als das nächste Bundle herunterladen. downloading: Das Bundle wird heruntergeladen. success: Das Bundle wurde heruntergeladen und ist bereit zum Ausführen von als das nächste Bundle herunterladen. error: Das Bundle konnte nicht heruntergeladen werden.

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

Bis zum nächsten

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

Weitermachen von Funktionen und Einstellungen

Wenn Sie " Funktionen und Einstellungen um das Dashboard und API-Operationen zu planen, verbinden Sie es mit Mit @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.