Funktionen und Einstellungen

Updater-Plugin-Konfiguration

Siehe den Github Readme 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. Verfügbar auf Android, iOS und Electron.	10000 // (10 seconds)
responseTimeout	number	Konfigurieren Sie die Anzahl der Millisekunden, die das native Plugin wartet, bevor es eine API-Timeout betrachtet. Verfügbar auf Android, iOS und Electron.	20000 // (20 seconds)
autoDeleteFailed	boolean	Konfigurieren Sie, ob der Plugin automatisch fehlgeschlagene Pakete löschen soll. Verfügbar auf Android, iOS und Electron.	true
autoDeletePrevious	boolean	Konfigurieren Sie, ob der Plugin automatisch vorherige Pakete nach einer erfolgreichen Aktualisierung löschen soll. Verfügbar auf Android, iOS und Electron.	true
autoUpdate	boolean | ‘off’ | ‘atBackground’ | ‘atInstall’ | ‘onLaunch’ | ‘always’ | ‘onlyDownload’	Konfigurieren Sie, wie der Plugin Auto-Update über einen Update-Server verwenden soll. true ist gleichbedeutend mit „atBackground“; false ist gleichbedeutend mit „off“. - off: Deaktivieren Sie Auto-Update - atBackground: Überprüfen und herunterladen automatisch, dann anwenden, wenn die App in den Hintergrund wechselt - atInstall: Anwenden sofort nur nach einer frischen Installation oder einer native App-Update, ansonsten verwenden Sie atBackground - onLaunch: Anwenden sofort bei der Start, ansonsten verwenden Sie atBackground nach der Start-Überprüfung - immer: Anwenden sofort, wenn Auto-Update läuft - nurHerunterladen: Überprüfen und herunterladen automatisch, emit updateAvailable und setzen Sie das nächste Paket nie automatisch. Verfügbar auf Android, iOS und Electron.	”atBackground” // true is still accepted
resetWhenUpdate	boolean	Löschen Sie automatisch vorherige heruntergeladene Pakete, wenn ein neueres natives App-Paket auf das Gerät installiert wird. Verfügbar auf Android, iOS und Electron.	true
updateUrl	string	Konfigurieren Sie die URL / Endpunkt, an den Aktualisierungsanfragen 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 Update-Anfrage verwendet. Wenn nicht gesetzt, wird der Plugin die Version vom nativen code. Verfügbar auf Android, iOS und Electron.	undefined	4.17.48
directUpdate	boolean | ‘always’ | ‘atInstall’ | ‘onLaunch’	Veraltet. Verwenden Sie stattdessen die 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 Auto-Update: “atInstall” - onLaunch: Gleichbedeutend mit Auto-Update: “onLaunch” - always: Gleichbedeutend mit Auto-Update: “always” - true: Gleichbedeutend mit “always” für die Rückwärtskompatibilität. Verfügbar auf Android, iOS und Electron.	false	5.1.0
autoSplashscreen	boolean	Automatisieren Sie die Versteckung des Splashscreens, wenn Instant-Apply-Modi verwendet werden. Wenn aktiviert, versteckt der Plugin automatisch den Splashscreen nach Updates werden angewendet oder wenn kein Update erforderlich ist. Dies entfernt die Notwendigkeit, manuell auf appReady-Ereignisse zu lauschen und SplashScreen.hide() aufzurufen. Funktioniert nur, wenn Auto-Update auf “atInstall”, “onLaunch” oder “always” eingestellt ist. Legacy-Direct-Update-Werte bleiben für die Rückwärtskompatibilität unterstützt. Erfordert die Installation und Konfiguration des @capacitor/splash-screen-Plugins mit launchAutoHide: false. Erfordert die Aktivierung von Auto-Update. Verfügbar auf Android und iOS.	false	7.6.0
periodCheckDelay	number	Konfigurieren Sie die Verzögerungszeit für den Zeitraum des Update-Checks. Die Einheit ist in Sekunden. Verfügbar auf Android, iOS und Electron. Kann nicht 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 selbstgefertigten Update-Servers.	undefined	4.17.48
localHost	string	Konfigurieren Sie die CLI zur Verwendung eines lokalen Servers für die Testung oder eines selbstgefertigten Update-Servers.	undefined	4.17.48
localWebHost	string	Konfigurieren Sie die CLI zur Verwendung eines lokalen Servers für die Testung oder eines selbstgefertigten Update-Servers.	undefined	4.17.48
localSupa	string	Konfigurieren Sie die CLI zur Verwendung eines lokalen Servers für die Testung oder eines selbstgefertigten Update-Servers.	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	Ermöglichen Sie dem Plugin, die updateUrl, statsUrl und channelUrl dynamisch von der JavaScript-Seite zu ändern.	false	5.4.0
defaultChannel	string	Setzen Sie die Standardkanal für die App in der Konfiguration. Groß- und Kleinschreibung beachten. Diese Einstellung wird die Standardkanal-Einstellung im Cloud überlagern, aber die im Cloud vorgenommenen Überschreibungen werden noch respektiert.	undefined	5.5.0
appId	string	Konfigurieren Sie die App-ID für die App in der Konfiguration.	undefined	6.0.0
keepUrlPathAfterReload	boolean	Konfigurieren Sie das Plugin, um die URL-Pfad nach einem Neuladen zu speichern. WARNUNG: Wenn ein Neuladen ausgelöst wird, wird ‘window.history’ geleert.	false	6.8.0
disableJSLogging	boolean	Deaktivieren Sie die JavaScript-Protokollierung des Plugins. Wenn wahr, wird das Plugin nicht im JavaScript-Konsolenprotokoll protokolliert. Nur die native Protokollierung wird durchgeführt.	false	7.3.0
shakeMenu	boolean	Aktivieren Sie den Erschütterungsbefehl, um das Aktualisierungsmenü zum Debuggen/Prüfen zu zeigen	false	7.5.0

Beispiele

In capacitor.config.json:

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

In capacitor.config.ts:

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

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

export default config;

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

Methoden

notifyAppReady()

notifyAppReady() => Promise<AppReadyResult>

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

Rückgabewert Promise<AppReadyResult>

---

setUpdateUrl(…)

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

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

Parameter	Typ	Beschreibung
options	UpdateUrl	enthält die URL, die für die Suche nach Updates verwendet wird.

Seit: 5.4.0

---

setStatsUrl(…)

setStatsUrl(options: StatsUrl) => Promise<void>

Setze die statsUrl für die App, diese wird verwendet, um Statistiken zu senden. Das Übergeben eines leeren Strings wird die Sammlung von Statistiken deaktivieren.

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

Seit: 5.4.0

---

setChannelUrl(…)

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

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

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

Seit: 5.4.0

---

download(…)

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

Laden Sie ein neues Bundle von der bereitgestellten 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	Der {@link Download-Optionen} für das Herunterladen eines neuen Bundle-Zip-Dateis.

Rückgabewert: Promise<BundleInfo>

---

next(…)

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

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

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

BundleInfo.id Promise<BundleInfo>

---

Rückgabewert

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

Zur Zwischenablage kopieren

Setze das aktuelle Bundle und lade die App sofort neu.	Parameter	Typ
options	BundleId	Beschreibung BundleIdEin 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 Speicher. Verwenden Sie mit {@link list} um die gespeicherten Bundle-IDs zu erhalten.

Param	Typ	Beschreibung
options	BundleId	Ein {@link "BundleId"} Objekt, das die ID einer Bundle enthält, die gelöscht werden soll (Hinweis: Dies ist die Bundle-Id, NICHT der Versionsname) __CAPGO_KEEP_0____CAPGO_KEEP_0__

---

liste(…)

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

Alle lokal heruntergeladenen Pakete in Ihrer App abrufen

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

Rückgabewert: Promise<BundleListResult>

---

reset(…)

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

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

Param	Typ	Beschreibung
options	ResetOptions	Enthält {@link ResetOptions.toLastSuccessful}, true setzt sich auf das Standard-Bundle zurück und false wird auf das letzte erfolgreich geladene Bundle zurückgesetzt.

---

current()

current() => Promise<CurrentBundleResult>

Liefert das aktuelle Bundle zurück, wenn keine gesetzt sind, wird es zurückgegeben builtin. currentNative ist das ursprüngliche Bundle, das auf dem Gerät installiert ist

Rückgabewert: Promise<CurrentBundleResult>

---

reload()

reload() => Promise<void>

Die Ansicht neu laden

---

setMultiDelay(…)

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

Setzt ein {@link "DelayCondition"} Array mit Bedingungen, die das Plugin verwendet, um die Aktualisierung zu verzögern. Nachdem alle Bedingungen erfüllt sind, wird der Aktualisierungsprozess wie gewöhnlich fortgesetzt, sodass die Aktualisierung nach einem Hintergrundlaufen oder einem App-Töten installiert wird. Für den "kind", sollte der Wert eine 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 weist inkonsistente Verhaltensweisen auf, 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. Param TypBeschreibung date Enthält das {@link "MultiDelayConditions"} background Setzt ein {@link "DelayCondition"} Array mit Bedingungen, die das Plugin verwendet, um die Aktualisierung zu verzögern. Nachdem alle Bedingungen erfüllt sind, wird der Aktualisierungsprozess wie gewöhnlich fortgesetzt, sodass die Aktualisierung nach einem Hintergrundlaufen oder einem App-Töten installiert wird. Für den "kind", sollte der Wert eine 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 weist inkonsistente Verhaltensweisen auf, 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. Param nativeVersion Typ kill Beschreibung

Enthält das {@link "MultiDelayConditions"}	Setzt ein {@link "DelayCondition"} Array mit Bedingungen, die das Plugin verwendet, um die Aktualisierung zu verzögern. Nachdem alle Bedingungen erfüllt sind, wird der Aktualisierungsprozess wie gewöhnlich fortgesetzt, sodass die Aktualisierung nach einem Hintergrundlaufen oder einem App-Töten installiert wird. Für den "kind", sollte der Wert eine 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 weist inkonsistente Verhaltensweisen auf, 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. Param	Typ
options	MultiDelayConditions	Beschreibung Enthält das {@link "MultiDelayConditions"}Menge von Bedingungen zum Setzen

Seit: 4.3.0

---

cancelDelay()

cancelDelay() => Promise<void>

Stellt eine {@link DelayCondition} ein, um eine Aktualisierung sofort zu verarbeiten. Seit:getLatest(…)

Abschnitt mit dem Titel “getLatest(…)” 4.0.0

---

In die Zwischenablage kopieren

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

Laden Sie das neueste Bundle von der Update-URL

Parameter	Typ
options	GetLatestOptions

Rückgabewert: Promise<LatestVersion>

Seit: 4.0.0

---

setChannel(…)

setChannel(options: SetChannelOptions) => Promise<ChannelRes>

Setzt den vom Plugin verwalteten lokalen Kanal für dieses Gerät. Der Kanal muss allow_device_self_set für dies zu funktionieren. validiert den Kanal mit dem Backend, dann speichert den ausgewählten Kanal lokal auf dem Gerät ab. Es wird kein Backend-Device-Überschreibung erstellt oder aktualisiert, daher wird das Gerät nicht als überschrieben im __CAPGO_KEEP_0__-Dashboard angezeigt. Nur Zuweisungen, die aus dem Dashboard oder dem öffentlichen __CAPGO_KEEP_1__ erstellt wurden, werden im Device-Überschreibungs-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.

Important notes:

• Verwenden Sie diese Methode nicht, um den Kanal bei der Startzeit zu setzen. Verwenden Sie stattdessen defaultChannel in Ihrer Capacitor-Konfiguration.
• Diese Methode ist für die Verwendung nach der App-Initialisierung und nachdem der Benutzer interagiert hat (z.B. indem er sich für ein Beta-Programm anmeldet), vorgesehen.
• Öffentliche Kanäle können nicht selbst zugewiesen werden. Wenn ein Kanal als publicmarkiert ist, wird bei Aufruf von setChannel() eine Fehlermeldung zurückgegeben. Um einen öffentlichen Kanal zu verwenden, rufen Sie stattdessen unsetChannel() auf - der Gerätefallt dann automatisch auf den entsprechenden öffentlichen Kanal zurück.
• Verwenden Sie listChannels() um zu ermitteln, welche Kanäle verfügbar sind und ob sie die Selbstzuteilung zulassen.

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

Rückgabewert: Promise<ChannelRes>

Seit: 4.7.0

---

unsetChannel(…)

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

Löschen Sie den vom Plugin verwalteten lokalen Kanal für dieses Gerät. Dies löscht nur den lokal vom Plugin gespeicherten Kanal und nicht die Dashboard- oder Public __CAPGO_KEEP_0__ Geräteüberschreibungsdaten. setChannel()Nachdem Sie diese Methode aufgerufen haben, 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äetyp, Buildtyp) zurückfallen.

Unset the plugin-managed local channel for this device. This clears only the channel stored locally by Capgo; it does not delete Dashboard or Public API Device Override records.

Dies ist nützlich, wenn:

• Sie möchten ein Gerät auf die Standard-Update-Track zurücksetzen
• Sie möchten einen öffentlichen Kanal verwenden (da öffentliche Kanäle nicht selbst zugewiesen werden können via setChannel())

Param	Typ
options	UnsetChannelOptions

Seit: 4.7.0

---

getChannel()

getChannel() => Promise<GetChannelRes>

Ermitteln Sie den Kanal für dieses Gerät

Rückgabe: Promise<GetChannelRes>

Seit: 4.8.0

---

listChannels()

listChannels() => Promise<ListChannelsResult>

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

Jeder Kanal in der Ergebnisliste enthält:

• public: Wenn true, ist dies ein Standardkanal. Sie können ihn nicht selbst zuweisen, indem Sie setChannel(). Stattdessen wird das Gerät, wenn Sie die Zuweisung Ihres Kanals mit unsetChannel()aufheben, automatisch Updates von diesem öffentlichen Kanal erhalten.
• allow_self_set: Wenn trueDies ist ein selbst zuweisender Kanal . Sie können den Gerät explizit dieser Kanal zuweisen, indem SieRückgabewert setChannel().

Seit Promise<ListChannelsResult>

setCustomId(…) 7.5.0

---

Abschnitt mit dem Titel “setCustomId(…)”

setCustomId(options: SetCustomIdOptions) => Promise<void>

Parameter

Typ	Beschreibung	Param __CAPGO_KEEP_0__ Type __CAPGO_KEEP_1__ Description __CAPGO_KEEP_2__
options	SetCustomIdOptions	ist die {@link SetCustomIdOptions} Custom-ID, um festzulegen

Seit: 4.9.0

---

getBuiltinVersion()

getBuiltinVersion() => Promise<BuiltinVersion>

Ermittelt die native App-Version oder die eingebettete Version, wenn diese in der Konfiguration festgelegt ist

Rückgabewert: Promise<BuiltinVersion>

Seit: 5.2.0

---

getDeviceId()

getDeviceId() => Promise<DeviceId>

Ermittle die eindeutige ID, die zum Identifizieren des Geräts verwendet wird (wird an den Auto-Update-Server gesendet)

Rückgabewert: Promise<DeviceId>

---

getPluginVersion()

getPluginVersion() => Promise<PluginVersion>

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

Rückgabewert: Promise<PluginVersion>

---

isAutoUpdateEnabled()

isAutoUpdateEnabled() => Promise<AutoUpdateEnabled>

Ermittle den Zustand der Auto-Update-Konfiguration.

Rückgabewert: Promise<AutoUpdateEnabled>

---

removeAllListeners()

removeAllListeners() => Promise<void>

Entferne alle Listener für dieses Plugin.

Seit: 1.0.0

---

addListener(‘download’, …)

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

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

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

Wert zurückgeben: Promise<PluginListenerHandle>

Seit: 2.0.11

---

addListener(‘noNeedUpdate’, …)

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

Zum Ereignis “keine Aktualisierung erforderlich” hören, nützlich, wenn Sie jede Zeit, wenn die App gestartet wird, eine Überprüfung durchführen möchten

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

Wert zurückgeben: Promise<PluginListenerHandle>

Seit: 4.0.0

---

addListener(‘updateAvailable’, …)

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

Zu einem verfügbaren Update-Event hö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

Rückgabewert: Promise<PluginListenerHandle>

Seit: 4.0.0

---

addListener(‘downloadComplete’, …)

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

Zu DownloadComplete-Ereignissen hören.

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, damit Sie wissen, 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ört bei einem Update-Fehlerereignis im App auf, informiert Sie, wenn das Update beim nächsten App-Start fehlschlägt

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

Rückgabewert: Promise<PluginListenerHandle>

Seit: 2.3.0

---

addListener(‘downloadFailed’, …)

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

Hört bei einem Download-Fehlerereignis in der App auf, informiert Sie, wenn ein Bundle-Download fehlschlägt

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

Wert zurückgeben: Promise<PluginListenerHandle>

Seit: 4.0.0

---

addListener(‘appReloaded’, …)

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

App-Neuladen verfolgen, informiert Sie, wenn Neuladen 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>

Hört auf das App-Ready-Ereignis im App, damit Sie wissen, wenn die App bereit ist, verwendet zu werden

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

Rückgabewert: Promise<PluginListenerHandle>

Seit: 5.1.0

---

isAutoUpdateAvailable()

isAutoUpdateAvailable() => Promise<AutoUpdateAvailable>

Ermitteln, ob eine Auto-Update verfügbar ist (nicht durch serverUrl deaktiviert).

Rückgabewert: Promise<AutoUpdateAvailable>

---

getNextBundle()

getNextBundle() => Promise<BundleInfo | null>

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

Rückgabewert: Promise<BundleInfo | null>

Seit: 6.8.0

---

setShakeMenu(…)

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

Aktivieren oder deaktivieren Sie das Shake-Menü für Debugging- und Testzwecke

Parameter	Typ	Beschreibung
options	SetShakeMenuOptions	Enthält boolean, 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ückgabewert: Promise<ShakeMenuEnabled>

Seit: 7.5.0

---

Interfaces

AppReadyResult

Eigenschaft	Typ
bundle	BundleInfo

BundleInfo

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

Update-URL

Eigenschaft	Typ
url	string

Statistik-URL

Eigenschaft	Typ
url	string

Kanal-URL

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. Sitzungs-Schlüssel sind erforderlich, wenn Sie das Bundle mit dem Befehl CLI verschlüsselt haben, Sie sollten sie als Ergebnis des Befehls erhalten.

Eigenschaft	Typ	Beschreibung	Standard	Seitdem
url	string	Die URL des Bundle-Zip-Dateis (z.B. dist.zip), die 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/Versions
sessionKey	string	Der Sitzungscode für die Aktualisierung, wenn das Bundle mit einem Sitzungscode 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)-Multi-Datei-Downloads	undefined	6.1.0

ManifestEintrag

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

Bundel-ID

Eigenschaft	Typ
id	string

BundleListResult

Eigenschaft	Typ
bundles	BundleInfo[]

ListOptions

Eigenschaft	Typ	Beschreibung	Standard	Seitdem
raw	boolean	Ob die ungefilterte Liste der Pakete 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

Reset-Optionen

Eigenschaft	Typ
toLastSuccessful	boolean

aktuelles Paket-Ergebnis

Eigenschaft	Typ
bundle	BundleInfo
native	string

Mehrfach-Verzögerungsbedingungen

Eigenschaft	Typ
delayConditions	DelayCondition[]

Verzögerungsbedingung

Eigenschaft	Typ	Beschreibung
kind	DelayUntilNext	Konfiguration von Verzögerungsbedingungen in setMultiDelay
value	string

AktuelleVersion

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

GetLatestOptions

Eigenschaft	Typ	Beschreibung	Standardwert	Seit
channel	string	Der Kanal, für den die neueste Version abgerufen werden soll. Der Kanal muss ‘self_assign’ zulassen, damit dies funktioniert.	undefined	6.8.0

KanalRes

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

SetChannelOptions

Eigenschaft	Typ
channel	string
triggerAutoUpdate	boolean

UnsetChannelOptions

Eigenschaft	Typ
triggerAutoUpdate	boolean

GetChannelRes

Eigenschaft	Typ	Beschreibung	Seit
channel	string	Aktueller Status des Abrufs des Kanals	4.8.0
error	string
message	string
status	string
allowSet	boolean

ListChannelsResult

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

KanalInfo

Eigenschaft	Typ	Beschreibung	Seit
id	number	Die numerische Kanal-ID	7.5.0
name	string	Der Kanalname	7.5.0
public	boolean	Wenn wahr, ist dies ein Standard-/Rückfallkanal. Geräte können sich nicht selbst auf öffentliche Kanäle eintragen. Stattdessen wird, wenn ein Gerät seinen Kanal-Übertrag (mit "") entfernt, es automatisch Updates vom passenden öffentlichen Kanal erhalten. unsetChannel()Wenn wahr, können Geräte sich explizit auf diesen Kanal eintragen, 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	Kanalbefehle verwenden den Kanal "", nicht diesen numerischen "" setChannel()SetCustomIdOptions	7.5.0

Abschnitt mit dem Titel „SetCustomIdOptions“ nameEigenschaft id.

Typ

Version	Version
customId	string

__CAPGO_KEEP_0__

Eigenschaft	Typ
version	string

Geräte-ID

Eigenschaft	Typ
deviceId	string

Plugin-Version

Eigenschaft	Typ
version	string

Automatische Aktualisierung aktiviert

Eigenschaft	Typ
enabled	boolean

PluginListenerHandle

Eigenschaft	Typ
remove	() => Promise<void>

DownloadEvent

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

NoNeedEvent

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

UpdateAvailableEvent

Prop	Typ	Beschreibung	Seit
bundle	BundleInfo	__CAPGO_KEEP_0__	4.0.0

DownloadCompleteEvent

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

MajorAvailableEvent

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

UpdateFailedEvent

Eigenschaft	Typ	Beschreibung	Seit
bundle	BundleInfo	Emit wenn eine Aktualisierung nicht installiert werden konnte.	4.0.0

DownloadFailedEvent

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

AutoUpdateVerfügbar

Eigenschaft	Typ
available	boolean

ShakeMenüoptionen festlegen

Eigenschaft	Typ
enabled	boolean

ShakeMenü aktivieren

Eigenschaft	Typ
enabled	boolean

Typ-Bezeichner

Bundle-Status

ausstehend: Das Bundle ist ausstehend, um als nächstes zu werden. downloaden: Das Bundle wird heruntergeladen. geschafft: Das Bundle wurde heruntergeladen und ist bereit, als nächstes zu werden. fehlerhaft: Das Bundle konnte nicht heruntergeladen werden. EINSTELLUNG EINSTELLUNG EINSTELLUNG EINSTELLUNG

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

Delay bis zum nächsten

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

Weitermachen von Funktionen und Einstellungen

Wenn Sie " Funktionen und Einstellungen zum Planen Ihres Dashboards und API-Operationen verwenden, verbinden Sie es mit Mit @capgo/capacitor-Updater für die native Fähigkeit in Mit @capgo/capacitor-Updater, API-Übersicht für die Implementierungsdetails in API-Übersicht, Einführung für die Implementierungsdetails in Einführung API Schlüssel für die Implementierungsdetails in API Schlüssel und Geräte für die Implementierungsdetails in Geräte.