Funktionen und Einstellungen

Abschnitt mit dem Titel „Updater-Plugin-Konfiguration“

See the Github Updater-Plugin-Konfiguration für weitere Informationen.

CapacitorUpdater kann mit diesen Optionen konfiguriert werden:

Eigenschaft	Typ	Beschreibung	Standard	Seit
appReadyTimeout	number	Konfigurieren Sie die Anzahl der Millisekunden, die das native Plugin wartet, bevor es eine Aktualisierung als fehlgeschlagen betrachtet.	10000 // (10 seconds)
responseTimeout	number	Konfigurieren Sie die Anzahl der Millisekunden, die das native Plugin wartet, bevor es API als 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 der Plugin die Auto-Update-Funktion über einen Update-Server verwenden soll. true entspricht dabei „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: Wenden Sie die Änderungen sofort nur nach einer frischen Installation oder einer nativen App-Update an, ansonsten verwenden Sie atBackground - onLaunch: Wenden Sie die Änderungen sofort bei der Startphase an, ansonsten verwenden Sie atBackground nach der Startprüfung - immer: Wenden Sie die Änderungen sofort an, wenn Auto-Update läuft - nurHerunterladen: Überprüfen und herunterladen automatisch, emittieren Sie updateAvailable und setzen Sie die nächste Bundle nie automatisch. Die Instant-Apply-Modi („atInstall“, „onLaunch“, „immer“) sollten mit —delta hochgeladen werden, um die Benutzererfahrung nicht zu verlangsamen. Auf Android und iOS sind diese Modi auf autoSplashscreen: true und @capacitor/splash-screen mit launchAutoHide: false angewiesen. Verfügbar auf Android, iOS und Electron.	“atBackground” // true is still accepted
resetWhenUpdate	boolean	Löschen Sie automatisch vorher heruntergeladene Bundles, wenn ein neuerer nativer App-Bundle auf das Gerät installiert wird. Verfügbar auf Android, iOS und Electron.	true
updateUrl	string	Konfigurieren Sie die URL/Endpunkt, an den Update-Prü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 Update-Statistiken gesendet werden. Verfügbar auf Android, iOS und Electron. Setzen Sie auf "" um die Statistik-Reporting zu deaktivieren.	https://plugin.capgo.app/stats
publicKey	string	Konfigurieren Sie die öffentliche Schlüssel für Ende-zu-Ende-Live-Update-Verschlüsselung Version 2. Verfügbar auf Android, iOS und Electron.	undefined	6.2.0
version	string	Konfigurieren Sie die aktuelle Version der App. Diese wird für den ersten Update-Anfrage verwendet. Wenn nicht gesetzt, wird die Version vom native code abgerufen. 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. Instant-Apply sollte mit —delta hochgeladen werden, damit die Aktualisierung die Benutzererfahrung nicht verlangsamt. Auf Android und iOS sind diese Modi die Verwendung von autoSplashscreen: true und @capacitor/splash-screen mit launchAutoHide: false erforderlich. - false: Mache keine direkten Updates - 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	Erforderlich, wenn Instant-Apply-Modi (“atInstall”, “onLaunch” oder “always”) verwendet werden, einschließlich der veralteten directUpdate-Werte. @capacitor/splash-screen muss installiert und konfiguriert sein, um launchAutoHide: false zu verwenden. Wenn aktiviert, versteckt der Plugin die Splash-Screen nach der Anwendung von Updates oder wenn kein Update erforderlich ist. Dies entfernt die Notwendigkeit, manuell auf appReady-Ereignisse zu hören und SplashScreen.hide() aufzurufen. Verfügbar auf Android und iOS.	false	7.6.0
periodCheckDelay	number	Konfigurieren Sie die Verzögerungszeit für die Intervallprüfung. Die Einheit ist in Sekunden. Verfügbar für Android, iOS und Electron. Kann nicht kleiner als 600 Sekunden (10 Minuten) sein.	600 // (10 minutes)
localS3	boolean	Konfigurieren Sie die CLI zur Verwendung eines lokalen Servers für die Testung oder eines selbstgehosteten Updateservers.	undefined	4.17.48
localHost	string	Konfigurieren Sie die CLI zur Verwendung eines lokalen Servers für die Testung oder eines selbstgehosteten Updateservers.	undefined	4.17.48
localWebHost	string	Konfigurieren Sie die CLI zur Verwendung eines lokalen Servers für die Testung oder eines selbstgehosteten Updateservers.	undefined	4.17.48
localSupa	string	Konfigurieren Sie die CLI zur Verwendung eines lokalen Servers für die Testung oder eines selbstgehosteten Updateservers.	undefined	4.17.48
localSupaAnon	string	Konfigurieren Sie die CLI zur Verwendung eines lokalen Servers für die Testung.	undefined	4.17.48
localApi	string	Konfigurieren Sie die CLI zur Verwendung eines lokalen api für die Testung.	undefined	6.3.3
localApiFiles	string	Konfigurieren Sie die CLI zur Verwendung eines lokalen Dateisystems api für die Testung.	undefined	6.3.3
allowModifyUrl	boolean	Erstellen Sie die Möglichkeit, dass das Plugin die updateUrl, statsUrl und channelUrl dynamisch von der JavaScript-Seite ändern kann.	false	5.4.0
defaultChannel	string	Legen Sie die Standardkanal für die App im Konfigurationsdatei fest. Groß- und kleinschreibungssensitiv. Diese Einstellung wird die im Cloud gesetzte Standardkanal überschreiben, aber die im Cloud vorgenommenen Überschreibungen respektieren.	undefined	5.5.0
appId	string	Legen Sie die App-ID für die App im Konfigurationsdatei fest.	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-Konsolenprotokoll protokolliert. Nur das native Protokoll wird durchgeführt.	false	7.3.0
shakeMenu	boolean	Aktivieren Sie die Erschütterungsgeste, um das Update-Menü für Debugging- und Testzwecke anzuzeigen	false	7.5.0

Beispiele

In capacitor.config.json:

{
  "plugins": {
    "CapacitorUpdater": {
      "appReadyTimeout": 1000 // (1 second),
      "responseTimeout": 10 // (10 second),
      "autoDeleteFailed": false,
      "autoDeletePrevious": false,
      "autoUpdate": "onlyDownload",
      "resetWhenUpdate": false,
      "updateUrl": https://example.com/api/auto_update,
      "channelUrl": https://example.com/api/channel,
      "statsUrl": https://example.com/api/stats,
      "publicKey": undefined,
      "version": undefined,
      "directUpdate": undefined,
      "autoSplashscreen": undefined,
      "periodCheckDelay": undefined,
      "localS3": undefined,
      "localHost": undefined,
      "localWebHost": undefined,
      "localSupa": undefined,
      "localSupaAnon": undefined,
      "localApi": undefined,
      "localApiFiles": undefined,
      "allowModifyUrl": undefined,
      "defaultChannel": undefined,
      "appId": undefined,
      "keepUrlPathAfterReload": undefined,
      "disableJSLogging": undefined,
      "shakeMenu": undefined
    }
  }
}

In capacitor.config.ts:

import { CapacitorConfig } from '@capacitor/cli';

const config: CapacitorConfig = {
  plugins: {
    CapacitorUpdater: {
      appReadyTimeout: 1000 // (1 second),
      responseTimeout: 10 // (10 second),
      autoDeleteFailed: false,
      autoDeletePrevious: false,
      autoUpdate: 'onlyDownload',
      resetWhenUpdate: false,
      updateUrl: https://example.com/api/auto_update,
      channelUrl: https://example.com/api/channel,
      statsUrl: https://example.com/api/stats,
      publicKey: undefined,
      version: undefined,
      directUpdate: undefined,
      autoSplashscreen: undefined,
      periodCheckDelay: undefined,
      localS3: undefined,
      localHost: undefined,
      localWebHost: undefined,
      localSupa: undefined,
      localSupaAnon: undefined,
      localApi: undefined,
      localApiFiles: undefined,
      allowModifyUrl: undefined,
      defaultChannel: undefined,
      appId: undefined,
      keepUrlPathAfterReload: undefined,
      disableJSLogging: undefined,
      shakeMenu: undefined,
    },
  },
};

export default config;

• notifyAppReady()
• setUpdateUrl(...)
• setStatsUrl(...)
• setChannelUrl(...)
• download(...)
• next(...)
• set(...)
• delete(...)
• list(...)
• reset(...)
• current()
• reload()
• setMultiDelay(...)
• cancelDelay()
• getLatest(...)
• setChannel(...)
• unsetChannel(...)
• getChannel()
• listChannels()
• setCustomId(...)
• getBuiltinVersion()
• getDeviceId()
• getPluginVersion()
• isAutoUpdateEnabled()
• removeAllListeners()
• addListener('download', ...)
• addListener('noNeedUpdate', ...)
• addListener('updateAvailable', ...)
• addListener('downloadComplete', ...)
• addListener('majorAvailable', ...)
• addListener('updateFailed', ...)
• addListener('downloadFailed', ...)
• addListener('appReloaded', ...)
• addListener('appReady', ...)
• isAutoUpdateAvailable()
• getNextBundle()
• setShakeMenu(...)
• isShakeMenuEnabled()
• Interfaces
• Typ- Alias

Methoden

notifyAppReady()

notifyAppReady() => Promise<AppReadyResult>

Benachrichtige Capacitor Updater darüber, dass die aktuelle Bundle funktioniert (wird bei Nichtaufruf dieser Methode bei jedem App-Start ein Rollover erfolgen) Standardmäßig sollte diese Methode innerhalb der ersten 10 Sekunden nach App-Start aufgerufen werden, ansonsten erfolgt ein Rollover. Ändern Sie dieses Verhalten mit {@link appReadyTimeout}

Rückgabewerte: Promise<AppReadyResult>

---

setUpdateUrl(…)

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

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

Parameter	Typ	Beschreibung
options	UpdateUrl	enthält die URL zum Abrufen von Updates.

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 Übertragung einer leeren Zeichenkette deaktiviert die Erfassung von Statistiken.

Parameter	Typ	Beschreibung
options	StatsUrl	enthält die URL zum Senden von Statistiken.

Seit: 5.4.0

---

setChannelUrl(…)

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

Setze die URL für das Channel für die App, diese wird verwendet, um das Channel zu setzen.

Parameter	Typ	Beschreibung
options	ChannelUrl	enthält die URL, die zum Setzen des Channels verwendet werden soll.

Seit: 5.4.0

---

download(…)

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

Lade ein neues Bundle vom angegebenen URL herunter, es sollte ein Zip-File sein, mit Dateien darin oder mit einer eindeutigen ID darin mit allen Ihren Dateien

Parameter	Typ	Beschreibung
options	DownloadOptions	Die {@link} für das Herunterladen einer neuen Bundle ZIP-Datei. Rückgabewerte:next(…)

Abschnitt mit dem Titel “next(…)” Promise<BundleInfo>

---

In die Zwischenablage kopieren

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

next(…)

Abschnitt mit dem Titel “next(…)	Typ	Beschreibung
options	BundleId	Enthält die ID des nächsten Pakets, das bei der nächsten App-Start-Instanz gesetzt werden soll. {@link} BundleInfo.id}

Rückgabewerte: Promise<BundleInfo>

---

set(…)

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

Setzt das aktuelle Paket 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 Anwendung aus dem native App-Storage. Verwenden Sie dazu {@link list} um die gespeicherten Bundle-IDs zu erhalten.

Param	Typ	Beschreibung
options	BundleId	Ein {@link} BundleIdObjekt, das die ID eines zu löschenden Bundles enthält (Hinweis: Dies ist die Bundle-ID, NICHT der Versionsname)

---

list(…)

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

Alle lokal heruntergeladenen Bundles in Ihrer App abrufen

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

Rückgabewerte: Promise<BundleListResult>

---

reset(…)

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

Die App auf die builtin Bundle (das an die Apple App Store / Google Play Store gesendet wurde) oder das letzte erfolgreich geladene Bundle.

Param	Typ	Beschreibung
options	ResetOptions	Mit {@link ResetOptions.toLastSuccessful}, true setzt auf das Standard-Bundle und wird auf das letzte erfolgreich geladene Bundle zurückgesetzt. false reset(…)

---

aktuell()

current() => Promise<CurrentBundleResult>

Liefert das aktuelle Bundle zurück, wenn keine gesetzt sind, gibt es zurück builtincurrentNative ist das ursprüngliche Bundle, das auf dem Gerät installiert ist

Rückgabewerte: Promise<CurrentBundleResult>

---

erneuern()

reload() => Promise<void>

Die Ansicht neu laden

---

setMultiDelay(…)

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

Setzt ein Array von Bedingungen, die der Plugin verwendet, um die Aktualisierung zu verzögern. Nachdem alle Bedingungen erfüllt sind, wird der Aktualisierungsprozess wie gewöhnlich fortgesetzt, sodass die Aktualisierung nach einem Hintergrundlaufen oder einem App-Töten installiert wird. Für die Bedingung "kind", sollte der Wert ein ISO-8601-Datumsstring sein. Für die Bedingung "kind", sollte der Wert eine Zahl in Millisekunden sein. Für die Bedingung "kind", sollte der Wert eine Versionsnummer sein. Für die Bedingung "kind", wird der Wert nicht verwendet. Die Funktion zeigt inkonsistentes Verhalten, wenn die Option "kill" die Aktualisierung nach dem ersten Töten und nicht nach dem nächsten Hintergrundlaufen auslöst. Dies wird in einer zukünftigen großen Version behoben. ParameterTyp date Beschreibung background Enthalten das Array von Bedingungen, die der Plugin verwendet, um die Aktualisierung zu verzögern. nativeVersion DelayCondition kill DelayCondition

DelayCondition	DelayCondition	DelayCondition
options	MultiDelayConditions	DelayCondition MultiDelayBedingungenEin Array von Bedingungen, umzusetzen

Seit: 4.3.0

---

cancelDelay()

cancelDelay() => Promise<void>

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

Seit: 4.0.0

---

getLatest(…)

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

Laden Sie das neueste Bundle vom Update-URL ab

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 überprüft den Kanal mit dem Backend, dann speichert der ausgewählte Kanal lokal auf dem Gerät. Es wird kein Backend-Device-Übertrag oder keine Aktualisierung erstellt, daher erscheint das Gerät nicht als überschrieben im __CAPGO_KEEP_0__-Dashboard. Nur Zuweisungen, die aus dem Dashboard oder dem öffentlichen __CAPGO_KEEP_1__ erstellt wurden, werden im Device-Übertrag-UI angezeigt.

setChannel() validates the channel with the backend, then stores the selected channel locally on the device. It does not create or update a backend Device Override, so the device will not appear as overridden in the Capgo dashboard. Only assignments created from the dashboard or the Public API are shown in the Device Override UI.

Wichtige Hinweise:

• Verwenden Sie diese Methode nicht, um den Kanal bei der Startzeit zu setzen. Verwenden Sie stattdessen den defaultChannel in Ihrer Capacitor-Konfiguration.
• Diese Methode ist für die Verwendung nach der App-Initialisierung und nachdem der Benutzer interagiert hat (z.B. sich für ein Beta-Programm entschieden hat), 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 die Selbstzuweisung zulassen.

Parameter	Typ	Beschreibung
options	SetChannelOptions	Link zu SetChannelOptionsSetzt den

Rückgabewerte: Promise<ChannelRes>

Seit: 4.7.0

---

unsetChannel(…)

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

Löscht die vom Plugin verwaltete lokale Kanalinstellung für dieses Gerät. Dies löscht nur die lokal gespeicherte Kanalinstellung, nicht die Dashboard- oder Public __CAPGO_KEEP_0__ Geräteüberschreibungsdaten. setChannel(); it does not delete Dashboard or Public API Device Override records.

Nachdem Sie diese Methode aufgerufen haben, gelten die normalen Kanalvorrangregeln: Ein bestehendes Dashboard oder ein öffentlicher API Geräte-Übertragungs-Modus gewinnt immer noch; andernfalls kann das Gerät auf die passende öffentliche/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 selbst zugewiesen werden können via) setChannel())

Parameter	Typ
options	UnsetChannelOptions

Seit: 4.7.0

---

getChannel()

getChannel() => Promise<GetChannelRes>

Ermitteln Sie den Kanal für dieses Gerät

Rückgabewert: Promise<GetChannelRes>

Seitdem: 4.8.0

---

listChannels()

listChannels() => Promise<ListChannelsResult>

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

Jeder Kanal im Ergebnis enthält:

• publicWenn: true, dies ist ein StandardkanalSie können ihn nicht selbst zuweisen, indem Sie setChannel()Stattdessen wird, wenn Sie Ihre Kanalzuweisung mit unsetChannel()entfernen, wird das Gerät automatisch Updates von diesem öffentlichen Kanal erhalten.
• allow_self_set: Wenn true, dies ist ein selbstzuweisbarer Kanal. Sie können den Geräte explizit diesem Kanal zuweisen, indem Sie setChannel().

Rückgabewerte: 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} die Option zum Setzen von customId

Seit: 4.9.0

---

getBuiltinVersion()

getBuiltinVersion() => Promise<BuiltinVersion>

Ermittelt die native App-Version oder die in der Konfiguration gesetzte Version

Rückgabewerte: 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ückgabewerte: Promise<DeviceId>

---

getPluginVersion()

getPluginVersion() => Promise<PluginVersion>

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

Rückgabewerte: Promise<PluginVersion>

---

isAutoUpdateEnabled()

isAutoUpdateEnabled() => Promise<AutoUpdateEnabled>

Ermitteln Sie den Zustand der automatischen Update-Konfiguration.

Rückgabewerte: Promise<AutoUpdateEnabled>

---

removeAllListeners()

removeAllListeners() => Promise<void>

Entfernen Sie alle Listener für dieses Plugin.

Seit: 1.0.0

---

addListener(‘download’, …)

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

Hören Sie auf das Ereignis zum Herunterladen des Pakets im App. Es wird einmal ausgelöst, wenn das Herunterladen begonnen wird, während des Herunterladens und wenn es abgeschlossen ist. Dies gibt Ihnen alle Download-Prozentsätze während des Herunterladens zurück.

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

Rückgabewerte: Promise<PluginListenerHandle>

Seit: 2.0.11

---

addListener(‘noNeedUpdate’, …)

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

Hören Sie auf das Ereignis „keine Aktualisierung erforderlich“, 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

Rückgabewerte: Promise<PluginListenerHandle>

Seit: 4.0.0

---

addListener(‘updateAvailable’, …)

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

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

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

Rückgabewert: Promise<PluginListenerHandle>

Seit: 4.0.0

---

addListener(‘downloadComplete’, …)

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

Verwenden Sie diesen Event, um das Download-Complete Ereignis zu hören.

Parameter	Typ
eventName	‘downloadComplete’
listenerFunc	(state: DownloadCompleteEvent) => void

Rückgabewerte: Promise<PluginListenerHandle>

Seit: 4.0.0

---

addListener(‘majorAvailable’, …)

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

Hören Sie sich das Major-Update-Ereignis im App an, damit Sie wissen, wenn ein Major-Update durch die Einstellung von disableAutoUpdateBreaking blockiert wird

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

Rückgabewerte: Promise<PluginListenerHandle>

Seit: 2.3.0

---

addListener(‘updateFailed’, …)

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

Hört das Update-Fehlerereignis im App ab, informiert Sie, wenn das Update beim nächsten App-Start fehlschlägt, um zu installieren

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 das Download-Fehlerereignis in der App ab, informiert Sie, wenn ein Bundle-Download fehlschlägt

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

Rückgabewerte: Promise<PluginListenerHandle>

Seit: 4.0.0

---

addListener(‘appReloaded’, …)

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

Hören Sie auf das Ereignis des App-Neustarts, informieren Sie sich, wenn ein Neustart erfolgt ist

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

Rückgabewerte: 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 Gebrauch

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

Rückgabewert: Promise<PluginListenerHandle>

Seit: 5.1.0

---

isAutoUpdateAvailable()

isAutoUpdateAvailable() => Promise<AutoUpdateAvailable>

Ermitteln, ob eine automatische Aktualisierung verfügbar ist (nicht durch serverUrl deaktiviert).

Rückgabewert: Promise<AutoUpdateAvailable>

---

getNextBundle()

getNextBundle() => Promise<BundleInfo | null>

Ermittelt das nächste Bundle, das verwendet wird, wenn die App neu geladen wird. Gibt null zurück, wenn kein nächstes Bundle festgelegt ist.

Rückgabewerte: Promise<BundleInfo | null>

Seit: 6.8.0

---

setShakeMenu(…)

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

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

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

Seit: 7.5.0

---

isShakeMenuEnabled()

isShakeMenuEnabled() => Promise<ShakeMenuEnabled>

Ermittelt den aktuellen Zustand des Shake-Menüs

Rückgabewerte: Promise<ShakeMenuEnabled>

Seit: 7.5.0

---

Interfaces

AppReadyResult

Eigenschaft	Typ
bundle	BundleInfo

BundleInfo

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

Update-URL

Eigenschaft	Typ
url	string

Statistik-URL

Eigenschaft	Typ
url	string

ChannelUrl

Eigenschaft	Typ
url	string

Download-Optionen

This URL and versions are used to download the bundle from the server, If you use backend all information will be given by the method getLatest. If you don’t use backend, you need to provide the URL and version of the bundle. SessionKey are required if you encrypted the bundle with the CLI command encrypt, you should receive them as result of the command.

Typ	Download-Optionen	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. Z.B. Amazon S3, ein GitHub-Tag, jeder andere Ort, an dem Sie Ihr Bundle gehostet haben.)
version	string	Die Version code/Name dieses Bundles/Versions
sessionKey	string	Die Sitzungsschlüssel für die Aktualisierung, wenn das Bundle mit einem Sitzungsschlüssel verschlüsselt ist	undefined	4.0.0
checksum	string	Der Prüfsummenwert für die Aktualisierung, er sollte in sha256 und mit einem privaten Schlüssel verschlüsselt sein, wenn das Bundle verschlüsselt ist	undefined	4.0.0
manifest	ManifestEntry[]	Das Manifest für Delta (manifest) mehrfachdatei-Downloads	undefined	6.1.0

ManifestEintrag

Eigenschaft	Typ
file_name	string | null
file_hash	string | null
download_url	string | null

BundleId

Prop	Typ
id	string

BundleListResult

Prop	Typ
bundles	BundleInfo[]

ListOptions

Prop	Typ	Beschreibung	Standard	Seit
raw	boolean	Ob die Rohliste der Bundle 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

AktuellerBundleResult

Eigenschaft	Typ
bundle	BundleInfo
native	string

MultiDelayBedingungen

Eigenschaft	Typ
delayConditions	DelayCondition[]

Verzugsbedingung

Eigenschaft	Typ	Beschreibung
kind	DelayUntilNext	Konfiguration von Verzugsbedingungen in setMultiDelay
value	string

NeuesteVersion

Eigenschaft	Typ	Beschreibung	Seit
version	string	Ergibtbeschreibung 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

GetLatestOptionen

Eigenschaft	Typ	Beschreibung	Standardwert	Seit
channel	string	Der Kanal, um die neueste Version zu erhalten. Der Kanal muss ‘self_assign’ zulassen, damit dies funktioniert.	undefined	6.8.0

ChannelRes

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

SetChannelOptions

Eigenschaft	Typ
channel	string
triggerAutoUpdate	boolean

UnsetChannelEinstellungen

Eigenschaft	Typ
triggerAutoUpdate	boolean

GetChannelRes

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

ListChannelsResult

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

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 entfernt (mit der Funktion) unsetChannel()automatisch Updates vom entsprechenden öffentlichen Kanal erhalten.	7.5.0
allow_self_set	boolean	Wenn wahr, können Geräte sich explizit auf diesen Kanal mithilfe von setChannel()zuweisen. Dies wird typischerweise für Beta-Tests, A/B-Tests oder opt-in-Update-Tracks verwendet.	7.5.0

Kanalbefehle verwenden den Kanal nameund nicht diese numerische id.

SetCustomIdOptions

Eigenschaft	Typ
customId	string

Integrierte Version

Eigenschaft	Typ
version	string

Geräte-ID

Eigenschaft	Typ
deviceId	string

Plugin-Version

Eigenschaft	Typ
version	string

Automatische Aktualisierung aktivieren

Eigenschaft	Typ
enabled	boolean

Plugin-Listener-Handle

Eigenschaft	Typ
remove	() => Promise<void>

Herunterladen-Ereignis

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

KeineNotwendigeEreignis

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

UpdateVerfügbarEreignis

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

DownloadCompleteEvent

Eigenschaft	Typ	Beschreibung	Seit
bundle	BundleInfo	Emittiert, wenn eine neue Aktualisierung verfügbar ist.	4.0.0

MajorAvailableEvent

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

UpdateFailedEvent

Eigenschaft	Typ	Beschreibung	Seitdem
bundle	BundleInfo	Emitiert, wenn eine Aktualisierung nicht installiert werden konnte.	4.0.0

DownloadFailedEvent

Eigenschaft	Typ	Beschreibung	Seitdem
version	string	Emitiert, wenn ein Download fehlschlägt.	4.0.0

AppReadyEvent

Eigenschaft	Typ	Beschreibung	Seit
bundle	BundleInfo	Ausgestoßen, wenn die App zum Einsatz bereit ist.	5.2.0
status	string

AutoUpdateVerfügbar

Eigenschaft	Typ
available	boolean

Setzen von Shake-Menü-Optionen

Eigenschaft	Typ
enabled	boolean

ShakeMenuAktiviert

Eigenschaft	Typ
enabled	boolean

Typ-Bezeichner

Bundle-Status

warte: Das Bundle wird vorbereitet, um als nächstes Bundle zu gelten. downloading: Das Bundle wird heruntergeladen. erfolgreich: Das Bundle wurde heruntergeladen und ist bereit, als nächstes Bundle zu gelten. SET als nächstes Bundle. herunterladen: Das Bundle wird heruntergeladen. Warten Sie auf das nächste Paket. Fehler: Das Paket konnte nicht heruntergeladen werden.

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

Delay bis zum nächsten

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

Fortsetzen von Funktionen und Einstellungen

Wenn Sie "Funktionen und Einstellungen" verwenden Funktionen und Einstellungen um das Dashboard und die API-Operationen zu planen, verbinden Sie es mit Verwenden Sie @capgo/capacitor-Updater für die native Fähigkeit in Verwenden Sie @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.