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, nach denen das native Plugin eine Aktualisierung als fehlgeschlagen betrachten sollte. Verfügbar auf Android, iOS und Electron.	10000 // (10 seconds)
responseTimeout	number	Konfigurieren Sie die Anzahl der Millisekunden, nach denen das native Plugin eine API-Timeout betrachten sollte. Verfügbar auf Android, iOS und Electron.	20000 // (20 seconds)
autoDeleteFailed	boolean	Konfigurieren Sie, ob das Plugin automatisch fehlgeschlagene Pakete löschen soll. Verfügbar auf Android, iOS und Electron.	true
autoDeletePrevious	boolean	Konfigurieren Sie, ob das Plugin automatisch vorherige Pakete nach einer erfolgreichen Aktualisierung löschen soll. Verfügbar auf Android, iOS und Electron.	true
autoUpdate	boolean | ‘off’ | ‘atBackground’ | ‘atInstall’ | ‘onLaunch’ | ‘always’ | ‘onlyDownload’	Konfigurieren Sie, wie das Plugin Auto-Update über einen Update-Server verwendet. true entspricht „atBackground“; false entspricht „off“. - off: Deaktivieren Sie Auto-Update - atBackground: Überprüfen und herunterladen automatisch, dann anwenden, wenn die App in den Hintergrund verschoben wird - atInstall: Anwenden sofort nur nach einer frischen Installation oder einer native App-Aktualisierung, ansonsten verwenden Sie atBackground - onLaunch: Anwenden sofort bei der Startanmeldung, ansonsten verwenden Sie atBackground nach der Startprüfung - immer: Anwenden sofort, wenn Auto-Update läuft - nurHerunterladen: Überprüfen und herunterladen automatisch, emit updateAvailable und setzen Sie das nächste Paket nie automatisch. Instant-Apply-Modi („atInstall“, „onLaunch“, „immer“) sollten mit —delta hochgeladen werden, um die Benutzererfahrung nicht zu verlangsamen. Auf Android und iOS sind diese Modi an autoSplashscreen: true und @capacitor/splash-screen mit launchAutoHide: false gebunden. Verfügbar auf Android, iOS und Electron.	“atBackground” // true is still accepted
resetWhenUpdate	boolean	Automatisch löschen Sie vorher 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 Update-Abfragen 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 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 für Android, iOS und Electron.	undefined	6.2.0
version	string	Konfigurieren Sie die aktuelle Version der App. Diese wird für den ersten Update-Antrag 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 den Benutzererlebnis nicht verzögert. Auf Android und iOS sind diese Modi an die Einstellung autoSplashscreen: true und @capacitor/splash-screen mit launchAutoHide: false gebunden. - false: Melden Sie 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	Benötigt wird, wenn Instant-Apply-Modi verwendet werden („atInstall“, „onLaunch“ oder „immer“), einschließlich der veralteten directUpdate-Werte. @capacitor/splash-screen muss installiert und mit launchAutoHide: false konfiguriert sein. Wenn aktiviert, versteckt das Plugin die Splash-Screen nach der Anwendung von Updates oder wenn kein Update erforderlich ist. Dies entfernt die Notwendigkeit, manuell auf appReady-Ereignisse zu lauschen und SplashScreen.hide() aufzurufen. Verfügbar auf Android und iOS.	false	7.6.0
periodCheckDelay	number	Konfigurieren Sie die Verzögerungszeit für den periodischen Update-Check. 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 Selbsthosting des Update-Servers.	undefined	4.17.48
localHost	string	Konfigurieren Sie den CLI zur Verwendung eines lokalen Servers für Tests oder Selbsthosting des Update-Servers.	undefined	4.17.48
localWebHost	string	Konfigurieren Sie den CLI zur Verwendung eines lokalen Servers für Tests oder Selbsthosting des Update-Servers.	undefined	4.17.48
localSupa	string	Konfigurieren Sie den CLI zur Verwendung eines lokalen Servers für Tests oder Selbsthosting des Update-Servers.	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	Configure the CLI to use a local file api for testing.	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 übernehmen, wird aber noch die im Cloud vorgenommenen Übernahmen respektieren.	undefined	5.5.0
appId	string	Konfigurieren Sie die App-ID für die App in der Konfiguration.	undefined	6.0.0
keepUrlPathAfterReload	boolean	Konfigurieren Sie das Plugin, um die URL-Pfad nach einem Neuladen beizubehalten. 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 die native Protokollierung 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

Methode

notifyAppReady()

notifyAppReady() => Promise<AppReadyResult>

Notify Capacitor Updater that the current bundle is working (a rollback will occur if this method is not called on every app launch) By default this method should be called in the first 10 sec after app launch, otherwise a rollback will occur. Change this behaviour with {@link appReadyTimeout}

Returns: Promise<AppReadyResult>

---

Rückgabewert:

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

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

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

Parameter	Typ	Beschreibung
options	StatsUrl	enthält die URL zur Verwendung für die Übermittlung von Statistiken.

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 zum Festlegen des Kanals.

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 drinnen oder mit einer eindeutigen ID drinnen mit allen Ihren Dateien

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

Rückgabewerte: Promise<BundleInfo>

---

next(…)

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

Setzen Sie 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 Pakets, das bei der nächsten App-Start-Instanz gesetzt werden soll. BundleInfo.id}

Rückgabewerte: Promise<BundleInfo>

---

set(…)

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

Setze das aktuelle Paket und lade die App sofort neu.

Parameter	Typ	Beschreibung
options	BundleId	Ein {@link} BundleId} Objekt, das den neuen Bundle-Id enthält, der als aktuell gesetzt werden soll.

---

delete(…)

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

Löscht den angegebenen Bundle aus dem native App-Storage. Verwenden Sie dazu {@link list} um die gespeicherten Bundle-IDs zu erhalten.

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

---

list(…)

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

Alle lokal heruntergeladenen Bündel in Ihrer App abrufen

Param	Typ	Beschreibung
options	ListOptions	Die {@link ListOptions} für die Auflistung von Bündeln

Returns: Promise<BundleListResult>

---

reset(…)

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

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

Parameter	Typ	Description
options	ResetOptions	Beschreibung ResetOptions.zuLetztemErfolgreichen}, true zurücksetzt sich auf die interne Bundle false wird auf den letzten erfolgreich geladenen Bundle zurückgesetzt.

---

current()

current() => Promise<CurrentBundleResult>

Ermittelt den aktuellen Bundle, wenn keines gesetzt ist, gibt es zurück builtincurrentNative ist das ursprüngliche Bundle, das auf dem Gerät installiert ist

Rückgabe: Promise<CurrentBundleResult>

---

reload()

reload() => Promise<void>

Die Ansicht neu laden

---

setMultiDelay(…)

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

Setzt ein {@link} DelayCondition} array containing conditions that the Plugin will use to delay the update. After all conditions are met, the update process will run start again as usual, so update will be installed after a backgrounding or killing the app. For the date Für die Art, sollte der Wert ein ISO8601-Datumsstring sein. background Für die Eigenschaft "timeout" sollte der Wert eine Zahl in Millisekunden sein. nativeVersion Die Art sollte eine, der Wert sollte die Versionsnummer sein. kill kind, the value is not used. The function has inconsistent behavior the option kill do trigger the update after the first kill and not after the next background like other options. This will be fixed in a future major release.

Typ	Parameter	Übersetzung
options	MultiDelayConditions	Enthält den {@link} MultiDelayConditions} Array von Bedingungen, um zu setzen

Seit: 4.3.0

---

cancelDelay()

cancelDelay() => Promise<void>

Storniert eine {@link} DelayCondition} zur sofortigen Verarbeitung eines Updates.

Seit: 4.0.0

---

getLatest(…)

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

Laden Sie das neueste Bundle vom Update-URL

Parameter	Typ
options	GetLatestOptions

Rückgabewert: Promise<LatestVersion>

Seit: 4.0.0

---

setChannel(…)

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

Setzt den von dem Plugin verwalteten lokalen Kanal für dieses Gerät. Der Kanal muss allow_device_self_set für dieses zu funktionieren.

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

Wichtige Hinweise:

• Do not use this method to set the channel at boot. Use the defaultChannel in Ihrer Capacitor-Konfiguration anstatt.
• Nachdem das App-Programm bereit ist und der Benutzer interagiert hat (z.B. sich für ein Beta-Programm angemeldet hat).
• Öffentliche Kanäle können nicht selbst zugewiesen werden. Wenn ein Kanal als public, calling setChannel() will return an error. To use a public channel, call unsetChannel() anstatt - das Gerät fällt automatisch auf die passende öffentliche Kanal zurück.
• Use listChannels() um zu ermitteln, welche Kanäle verfügbar sind und ob sie Selbstzuweisung zulassen.

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

Rückgabewerte: Promise<ChannelRes>

Seit: 4.7.0

---

unsetChannel(…)

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

Entferne die vom Plugin verwaltete lokale Kanalinstellung für dieses Gerät. Dies löscht nur den lokal gespeicherten Kanal. setChannel()Es löscht keine Dashboard- oder Public API Geräteüberschreibungsdaten.

Nachdem Sie diese Methode aufgerufen haben, gelten die normalen Kanalvorrangregeln: Ein bestehendes Dashboard- oder Public API Geräteüberschreibungsprotokoll 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

context 4.7.0

---

getChannel()

getChannel() => Promise<GetChannelRes>

Abschnitt mit dem Titel „getChannel()“

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

• publicWenn truedies ein Standardkanal istSie können ihn nicht selbst zuweisen, indem Sie setChannel()Stattdessen entfernen Sie Ihre Kanalzuweisung, indem Sie unsetChannel(), das Gerät erhält automatisch Updates aus diesem öffentlichen Kanal.
• allow_self_set: Wenn true, dies ein selbstzuteilbarer Kanalist. Sie können das Gerät explizit diesem Kanal zuweisen, indem Sie setChannel().

Returns: Promise<ListChannelsResult>

Since: 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 customId zum setzen

Seit: 4.9.0

---

getBuiltinVersion()

getBuiltinVersion() => Promise<BuiltinVersion>

Get the native app version or the builtin version if set in config

Rückgabewerte: Promise<BuiltinVersion>

Seit: 5.2.0

---

getDeviceId()

getDeviceId() => Promise<DeviceId>

Ermittle eine eindeutige ID zur Geräteidentifizierung (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>

Get the state of auto update config.

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. Wird einmal ausgelöst, während des Herunterladens und wenn fertig. Dies gibt Ihnen alle Download-Prozentsätze während des Herunterladens zurück.

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

Rückgabewert: Promise<PluginListenerHandle>

Seit: 2.0.11

---

addListener('keineUpdateNotiz', ...)

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

Hören Sie auf Updates ohne Not, nützlich wenn Sie jede Zeit beim App-Start eine Überprüfung durchführen möchten

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

Höre nach dem verfügbaren Updateereignis, nützlich, wenn du jede Zeit eine Überprüfung durchführen möchtest, wenn die App gestartet wird

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

Seit: Promise<PluginListenerHandle>

Returns: 4.0.0

---

addListener('downloadComplete', …)

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

Höre nach downloadComplete-Ereignissen.

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ört auf Major-Update-Ereignis im App ab, informiert Sie, wenn ein Major-Update durch die Einstellung 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öre bei der App nach dem Fehler bei der Aktualisierung und informiere dich, wenn die Aktualisierung bei der nächsten App-Start fehlschlägt

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

Seit: Promise<PluginListenerHandle>

Returns: 2.3.0

---

addListener('downloadFailed', …)

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

Höre bei der App nach dem Fehler bei der Herunterladung und informiere dich, wenn eine Bundle-herunterladung 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ört auf das App-Neuladen-Ereignis zu und informiert Sie, wenn das Neuladen 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>

Hört das app-fertig-Event im App ab, 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>

Prüfen, ob automatische Updates verfügbar sind (nicht durch serverUrl deaktiviert).

Rückgabewerte: Promise<AutoUpdateAvailable>

---

getNextBundle()

getNextBundle() => Promise<BundleInfo | null>

Gibt das nächste Bundle zurück, 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 das Shake-Menü für Debugging- und Testzwecke

Parameter	Typ	Beschreibung
options	SetShakeMenuOptions	Enthält 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

StatsUrl

Prop	Typ
url	string

ChannelUrl

Prop	Typ
url	string

DownloadOptionen

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. Sollten Sie das Bundle mit dem Befehl CLI verschlüsselt haben, sind SessionKeys erforderlich. Diese sollten als Ergebnis des Befehls bereitgestellt werden.

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

__CAPGO_KEEP_0__

BundleId	Typ
id	string

BundleListResult

BundleId	Typ
bundles	BundleInfo[]

BundleListResult

BundleId	Typ	Beschreibung	Standard	Seit
raw	boolean	Ob die 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

ResetOptions

Prop	Typ
toLastSuccessful	boolean

CurrentBundleResult

Prop	Typ
bundle	BundleInfo
native	string

MultiDelayBedingungen

Eigenschaft	Typ
delayConditions	DelayCondition[]

Verzugsbedingung

Eigenschaft	Typ	Beschreibung
kind	DelayUntilNext	Setzen Sie Verzugsbedingungen 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

GetLatest-Optionen

Eigenschaft	Typ	Beschreibung	Standard	Seitdem
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	Seitdem
status	string	Aktueller Status des gesetzten Kanals	4.7.0
error	string
message	string

SetChannelOptions

Eigenschaft	Typ
channel	string
triggerAutoUpdate	boolean

__CAPGO_KEEP_0__

Prop	Typ
triggerAutoUpdate	boolean

Eigenschaft

Prop	Typ	Description	Beschreibung
channel	string	Aktueller Status des Kanalabrufs	4.8.0
error	string
message	string
status	string
allowSet	boolean

ListChannelsErgbnis

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

Kanalinformationen

Eigenschaft	Typ	Beschreibung	Seitdem
id	number	Die numerische Kanal-ID	7.5.0
name	string	Der Kanalname	7.5.0
public	boolean	Wenn wahr, ist dies ein Standard-/Rückfall-Kanal. Geräte können sich nicht selbst auf öffentliche Kanäle eintragen. Stattdessen wird, wenn ein Gerät seine Kanal-Überschreibung entfernt (mit der Verwendung von) unsetChannel()), es wird 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()zurücksetzen. 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

__CAPGO_KEEP_0__

Eigenschaft	Typ
version	string

Geräte-ID

Eigenschaft	Typ
deviceId	string

__CAPGO_KEEP_0__

Eigenschaft	Typ
version	string

__CAPGO_KEEP_0__

Eigenschaft	Typ
enabled	boolean

Plugin-Listener-Handle

Eigenschaft	Typ
remove	() => Promise<void>

DownloadEvent

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

KeineNotwendigkeit

Eigenschaft	Typ	Beschreibung	Seit
bundle	BundleInfo	Aktueller Downloadstatus, zwischen 0 und 100.	4.0.0

UpdateVerfügbarkeit

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

DownloadCompleteEvent

Eigenschaft	Typ	Beschreibung	Seit
bundle	BundleInfo	Ausgibt, wenn ein neuer Update verfügbar ist.	4.0.0

MajorAvailableEvent

Eigenschaft	Typ	Beschreibung	Seit
version	string	Ausgibt, wenn ein neuer großer Bundle verfügbar ist.	4.0.0

UpdateFailedEvent

Eigenschaft	Typ	Beschreibung	Seit
bundle	BundleInfo	Emit when a update failed to install.	4.0.0

DownloadFailedEvent

Eigenschaft	Typ	Beschreibung	Seit
version	string	Ausgibt, wenn ein Download fehlschlägt.	4.0.0

AppReadyEvent

Eigenschaft	Typ	Beschreibung	Seit
bundle	BundleInfo	Verfügbar, wenn die App bereit ist zum Einsatz zu sein.	5.2.0
status	string

Auto-Update verfügbar

Eigenschaft	Typ
available	boolean

SetShakeMenuOptions

Eigenschaft	Typ
enabled	boolean

ShakeMenuEnabled

Eigenschaft	Typ
enabled	boolean

Typbezeichner

Paketstatus

ausstehend: Das Paket ist ausstehend, um als SET als nächstes Paket herunterzuladen. herunterladen: Das Paket wird heruntergeladen. erfolgreich: Das Paket wurde heruntergeladen und ist bereit, um als SET Das nächste Paket. Fehler: Das Paket konnte nicht heruntergeladen werden.

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

DelayUntilNext

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

Weitermachen von Funktionen und Einstellungen

Wenn Sie Functions and settings verwenden 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 Mit @capgo/capacitor-Updater API-Übersicht zur Implementierungsdetail in API Übersicht Einleitung zur Implementierungsdetail in Einleitung API Schlüssel zur Implementierungsdetail in API Schlüssel und Geräte für die Implementierungsdetails in Geräten.