Funktionen und Einstellungen

GitHub

Einen Setup-Vorschlag mit den Installationsanweisungen und der vollständigen Markdown-Anleitung für diesen Plugin kopieren.

Abschnitt mit dem Titel „Updater-Plugin-Konfiguration“

See the Github Includes install, sync, und die Quell-Markdown-Anleitung. Weitere Informationen finden Sie hier.

CapacitorUpdater kann mit diesen Optionen konfiguriert werden:

Eigenschaft	Typ	Beschreibung	Standardwert	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 einen API Timeout betrachtet.	`20000 // (20 seconds)`
`autoDeleteFailed`	`boolean`	Konfigurieren Sie, ob das Plugin automatisch fehlgeschlagene Pakete löschen soll.	`true`
`autoDeletePrevious`	`boolean`	Konfigurieren Sie, ob das Plugin automatisch vorherige Pakete nach einer erfolgreichen Aktualisierung löschen soll.	`true`
`autoUpdate`	`boolean \| ‘off’ \| ‘atBackground’ \| ‘atInstall’ \| ‘onLaunch’ \| ‘always’ \| ‘onlyDownload’`	Konfigurieren Sie, wie das Plugin Auto-Update über einen Update-Server verwendet. true entspricht 'atBackground'; false entspricht 'off'. - off: Deaktivieren Sie Auto-Update - atBackground: Überprüfen und herunterladen automatisch, dann anwenden, wenn die App in den Hintergrund wechselt - atInstall: Anwenden sofort nur nach einer frischen Installation oder einer native App-Aktualisierung, ansonsten verwenden Sie atBackground - onLaunch: Anwenden sofort bei der Startanzeige, ansonsten verwenden Sie atBackground nach der Startprüfung - immer: Anwenden sofort, wenn Auto-Update läuft - nurHerunterladen: Überprüfen und herunterladen automatisch, emittieren Sie updateAvailable und setzen Sie den nächsten Bundle nie automatisch.	`”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 Aktualisierungsprüfungen gesendet werden. Verfügbar auf Android, iOS und Electron.	`https://plugin.capgo.app/updates`
`channelUrl`	`string`	Konfigurieren Sie die URL / Endpunkt für Kanaloperationen. Verfügbar auf Android, iOS und Electron.	`https://plugin.capgo.app/channel_self`
`statsUrl`	`string`	Konfigurieren Sie die URL / Endpunkt, an den Aktualisierungsstatistiken gesendet werden. Verfügbar auf Android, iOS und Electron. Setzen Sie auf "" um die Statistikberichterstattung zu deaktivieren.	`https://plugin.capgo.app/stats`
`publicKey`	`string`	Konfigurieren Sie die öffentliche Schlüssel für Ende-zu-Ende-Live-Update-Verschlüsselung Version 2. Verfügbar auf Android, iOS und Electron.	`undefined`	6.2.0
`version`	`string`	Konfigurieren Sie die aktuelle Version der App. Diese wird für den ersten Aktualisierungsantrag verwendet. Wenn nicht gesetzt, wird der Plugin die Version vom native code. Verfügbar auf Android, iOS und Electron.	`undefined`	4.17.48
`directUpdate`	`boolean \| ‘always’ \| ‘atInstall’ \| ‘onLaunch’`	Veraltet. Verwenden Sie stattdessen die 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`	Automatisch die Versteckung des Splashscreens steuern, wenn Instant-Apply-Modi verwendet werden. Wenn aktiviert, versteckt der Plugin automatisch den Splashscreen nach Updates oder wenn kein Update erforderlich ist. Dies entfernt die Notwendigkeit, manuell auf appReady-Ereignisse zu hören und SplashScreen.hide() aufzurufen. Funktioniert nur, wenn autoUpdate auf „atInstall“, „onLaunch“ oder „always“ eingestellt ist. Legacy-Werte für directUpdate sind für die Rückwärtskompatibilität weiterhin unterstützt. Erfordert die Installation und Konfiguration des @capacitor/splash-screen-Plugins mit launchAutoHide: false. Erfordert die Aktivierung der Auto-Update-Funktion. Verfügbar auf Android und iOS.	`false`	7.6.0
`periodCheckDelay`	`number`	Konfigurieren Sie die Verzögerungszeit für den 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 einer selbstgefertigten Update-Server.	`undefined`	4.17.48
`localHost`	`string`	Konfigurieren Sie den CLI zur Verwendung eines lokalen Servers für Tests oder einer selbstgefertigten Update-Server.	`undefined`	4.17.48
`localWebHost`	`string`	Konfigurieren Sie den CLI zur Verwendung eines lokalen Servers für Tests oder einer selbstgefertigten Update-Server.	`undefined`	4.17.48
`localSupa`	`string`	Konfigurieren Sie den CLI zur Verwendung eines lokalen Servers für Tests oder einer selbstgefertigten Update-Server.	`undefined`	4.17.48
`localSupaAnon`	`string`	Konfigurieren Sie den CLI zur Verwendung eines lokalen Servers für Tests.	`undefined`	4.17.48
`localApi`	`string`	Konfigurieren Sie den CLI zur Verwendung eines lokalen api für Tests.	`undefined`	6.3.3
`localApiFiles`	`string`	Konfigurieren Sie den CLI zur Verwendung eines lokalen Dateisystems api für Tests.	`undefined`	6.3.3
`allowModifyUrl`	`boolean`	Erlassen Sie dem Plugin die Möglichkeit, 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, der im Cloud gesetzt wurde, überschreiben, aber die im Cloud gesetzten Ü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 die Plugin-Einstellung, 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 in die JavaScript-Konsole geschrieben. 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

Methoden

appReady() notifyen

notifyAppReady() => Promise<AppReadyResult>

Benachrichtige den Capacitor-Updater darüber, dass die aktuelle Bundle funktioniert (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, andernfalls wird ein Rollover durchgeführt. Ändere dieses Verhalten mit {@link appReadyTimeout}

Rückgabewerte: Promise<AppReadyResult>

setUpdateUrl(…)

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

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

Parameter	Typ	Beschreibung
`options`	`UpdateUrl`	enthält die URL, die zum Überprüfen von Updates verwendet werden soll.

Seit: 5.4.0

Abschnitt mit dem Titel “setStatsUrl(…)”

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

Parameter

Typ	Beschreibung	contains the URL to use for checking for updates.
`options`	`StatsUrl`	enthält die URL, die zum Senden von Statistiken verwendet werden soll.

Seit: 5.4.0

setChannelUrl(…)

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

Setze die channelUrl für die App, diese wird zum Setzen des Kanals verwendet.

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

Seit: 5.4.0

download(…)

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

Ein neues Bundle von der bereitgestellten URL herunterladen, es sollte ein Zip-Datei sein, mit Dateien drin oder mit einer eindeutigen ID drin mit allen Deinen Dateien

Parameter	Typ	Beschreibung
`options`	`DownloadOptions`	Der {@link} DownloadOptions} für das Herunterladen einer neuen Bundle-Zip-Datei.

Rückgabewert: Promise<BundleInfo>

next(…)

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

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

Param	Typ	Beschreibung
`options`	`BundleId`	Enthält die ID des nächsten Bundles, das bei dem nächsten App-Start verwendet werden soll. {@link} BundleInfo.id}

Rückgabewerte: Promise<BundleInfo>

set(…)

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

Legt das aktuelle Bundle fest 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(options: BundleId) => Promise<void>

In die Zwischenablage kopieren

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

Objekt, das die ID eines zu löschenden Pakets enthält (Hinweis: Dies ist die Paket-ID, NICHT der Versionsname)

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

Auf die Zwischenablage kopieren

Alle lokal heruntergeladenen Pakete in Ihrer App abrufen	Param	Typ
`options`	`ListOptions`	Beschreibung Listmöglichkeiten} für die Auflistung von Bundeln

Rückgabe: Promise<BundleListResult>

reset(…)

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

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

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

current()

current() => Promise<CurrentBundleResult>

Gibt das aktuelle Bundle zurück, wenn keines gesetzt ist, gibt es builtincurrentNative 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 Array von Bedingungen, die der Plugin zum Hinauszögern der Aktualisierung verwenden wird. Nachdem alle Bedingungen erfüllt sind, wird der Aktualisierungsprozess wie gewohnt fortgesetzt, sodass die Aktualisierung nach einem Hintergrundlaufen oder einem Kill des Apps installiert wird. Für die Der Wert sollte eine ISO-8601-Datumszeichenfolge sein. Für die Der Wert sollte eine Zahl in Millisekunden sein. Für die date Der Wert sollte die Versionsnummer sein. Für die background Der Wert wird nicht verwendet. Die Funktion zeigt inkonsistentes Verhalten, wenn die Option 'kill' den Update-Prozess nach dem ersten Kill und nicht nach dem nächsten Hintergrundlaufen auslöst. Dies wird in einer zukünftigen großen Version behoben. nativeVersion Eigenschaft kill Parameter

Zwischenablage	Typ	Beschreibung
`options`	`MultiDelayConditions`	Enthält den {@link} MultiDelayConditions} Array von Bedingungen, um

Seit: 4.3.0

cancelDelay()

cancelDelay() => Promise<void>

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

Seitdem: 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>

Seitdem: 4.0.0

setChannel(…)

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

Legt die vom Plugin verwaltete lokale Kanal für dieses Gerät fest. Der Kanal muss allow_device_self_set für dies zu funktionieren aktiviert sein.

setChannel() Überprüft den Kanal mit dem Backend und speichert den ausgewählten Kanal lokal auf dem Gerät. Es wird kein Backend-Device-Übertrag oder eine Aktualisierung erstellt, 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-Übertrag-UI angezeigt.

Wichtige Hinweise:

Verwenden Sie diese Methode nicht, um den Kanal bei der Startphase zu setzen. Verwenden Sie stattdessen defaultChannel in Ihrer Capacitor-Konfiguration.
Diese Methode ist für die Verwendung nach der App-Initialisierung und nachdem der Benutzer interagiert hat (z.B. sich für ein Beta-Programm angemeldet hat), vorgesehen.
Öffentliche Kanäle können nicht selbst zugewiesen werden. Wenn ein Kanal als publicaufrufen wird, wird ein Fehler zurückgegeben. Um einen öffentlichen Kanal zu verwenden, rufen Sie stattdessen setChannel() auf - das Gerät fällt automatisch auf den entsprechenden öffentlichen Kanal zurück. unsetChannel() instead - the device will automatically fall back to the matching public channel.
Verwenden listChannels() um zu ermitteln, welche Kanäle verfügbar sind und ob sie Selbstzuweisungen zulassen.

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

Rückgabewerte: Promise<ChannelRes>

Seit: 4.7.0

unsetChannel(…)

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

Löschen Sie die vom Plugin verwaltete lokale Kanal für dieses Gerät. Dies löscht nur den lokal durch das Plugin gespeicherten Kanal und nicht die Dashboard- oder öffentlichen Geräteüberschreibungsdaten. setChannel(); it does not delete Dashboard or Public API Device Override records.

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

Dies ist nützlich, wenn:

Sie ein Gerät auf die Standardaktualisierungsstrecke zurücksetzen möchten
Sie einen öffentlichen Kanal verwenden möchten (da öffentliche Kanäle nicht selbst über die setChannel())

Parameter	Typ
`options`	`UnsetChannelOptions`

Seit: 4.7.0

getChannel()

getChannel() => Promise<GetChannelRes>

Ermitteln Sie den Kanal für dieses Gerät

Rückgabewerte: Promise<GetChannelRes>

Seit: 4.8.0

listChannels()

listChannels() => Promise<ListChannelsResult>

Listet alle verfügbaren Kanäle für dieses Gerät 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 true, dies ist ein Standardkanal. Sie können es nicht selbst zuweisen, indem Sie setChannel(). Stattdessen entfernen Sie Ihre Kanalzuweisung, indem Sie unsetChannel(), dann wird das Gerät automatisch Updates von diesem öffentlichen Kanal erhalten.
allow_self_set: Wenn true, ist dies ein ein selbst zuweisbarer Kanal. 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>

Eine benutzerdefinierte ID für dieses Gerät festlegen

Param	Typ	Beschreibung
`options`	`SetCustomIdOptions`	ist die {@link} SetCustomIdOptions} die zu setzende customId

Seit: 4.9.0

getBuiltinVersion()

getBuiltinVersion() => Promise<BuiltinVersion>

Ermitteln Sie die native App-Version oder die in der Konfiguration gesetzte Version

Rückgabewerte: Promise<BuiltinVersion>

Seit: 5.2.0

getDeviceId()

getDeviceId() => Promise<DeviceId>

Ermittelt eine eindeutige ID, die zum Identifizieren des Geräts dient (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>

Gibt den Zustand der automatischen Update-Konfiguration zurück.

Rückgabewerte: Promise<AutoUpdateEnabled>

removeAllListeners()

removeAllListeners() => Promise<void>

Entfernt alle Listener für diesen Plugin.

Seit: 1.0.0

addListener(‘download’, …)

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

Hört auf das Ereignis zum Herunterladen des Pakets im App. Wird einmal ausgelöst, wenn ein Download gestartet wird, während des Herunterladens und wenn fertig ist.

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

Rückgabewert: Promise<PluginListenerHandle>

Seit: 2.0.11

addListener(‘noNeedUpdate’, …)

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

Hört auf das Ereignis, dass kein Update erforderlich ist, nützlich, wenn Sie jede Zeit, wenn die App gestartet wird, eine Zwangsprüfung 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 das verfügbare Update-Ereignis zum Zwingen einer Überprüfung bei jedem App-Start

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

Rückgabewerte: Promise<PluginListenerHandle>

Seit: 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ückgabewert: Promise<PluginListenerHandle>

Seit: 4.0.0

addListener(‘majorAvailable’, …)

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

Höre nach Major-Update-Ereignis im App, informiert dich, wenn ein Major-Update durch die Einstellung disableAutoUpdateBreaking blockiert ist

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ören Sie in der App nach dem update-failed-Ereignis, um zu erfahren, wenn die Aktualisierung beim nächsten App-Start fehlschlägt

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

Rückgabewerte: Promise<PluginListenerHandle>

Seit: 2.3.0

addListener(‘downloadFailed’, …)

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

Hört bei einem Download-Fehlerereignis im App nach, informiert Sie, wenn ein Bundle-Download fehlgeschlagen ist

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

Rückgabewert: Promise<PluginListenerHandle>

Seit: 4.0.0

addListener(‘appReloaded’, …)

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

Hört bei einem Reloadereignis im App nach, informiert Sie, wenn ein Reload geschehen 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ören Sie auf das Ereignis “app ready” im App, damit Sie wissen, wenn die App bereit ist zum Gebrauch

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

Rückgabewerte: Promise<PluginListenerHandle>

Seit: 5.1.0

isAutoUpdateAvailable()

isAutoUpdateAvailable() => Promise<AutoUpdateAvailable>

Ermitteln Sie, ob ein automatischer Update verfügbar ist (nicht durch serverUrl deaktiviert).

Rückgabewerte: Promise<AutoUpdateAvailable>

getNextBundle()

getNextBundle() => Promise<BundleInfo | null>

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

Rückgabewerte: Promise<BundleInfo | null>

Seit: 6.8.0

setShakeMenu(…)

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

Enablen oder deaktivieren Sie das Shake-Menü für Debugging- oder 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>

Ruft den aktuellen Zustand des Shake-Menüs ab

Rückgabewerte: Promise<ShakeMenuEnabled>

Seit: 7.5.0

Schnittstellen

AppReadyResult

Eigenschaft	Typ
`bundle`	`BundleInfo`

BundleInfo

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

Update-URL

Eigenschaft	Typ
`url`	`string`

Stats-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 Backend verwenden, werden alle Informationen durch die Methode getLatest bereitgestellt. Wenn Sie Backend nicht verwenden, müssen Sie die URL und die Version des Bundles bereitstellen. SessionKeys sind erforderlich, wenn Sie das Bundle mit der CLI-Kommandozeilenanweisung Verschlüsseln, Sie sollten sie als Ergebnis der Anweisung erhalten.

Eigenschaft	Typ	Beschreibung	Standard	Seit
`url`	`string`	Die URL des zip-Dateis des Bundles (z.B. dist.zip), das heruntergeladen werden soll. (Dies kann jede URL sein. Zum Beispiel: Amazon S3, ein GitHub-Tag, jeder andere Ort, an dem Sie Ihr Bundle gehostet haben.)
`version`	`string`	Die Version code/Name dieses Bundles/Version
`sessionKey`	`string`	Die Sitzungsschlüssel für die Aktualisierung, wenn das Bundle mit einem Sitzungsschlüssel verschlüsselt ist	`undefined`	4.0.0
`checksum`	`string`	Die Prüfsumme für die Aktualisierung, sie sollte in sha256 und mit einem privaten Schlüssel verschlüsselt sein, wenn das Bundle verschlüsselt ist	`undefined`	4.0.0
`manifest`	`ManifestEntry[]`	Das Manifest für Delta (Manifest) mehrfachdatei-Downloads	`undefined`	6.1.0

ManifestEintrag

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

BundleId

Eigenschaft	Typ
`id`	`string`

BundleListResult

Eigenschaft	Typ
`bundles`	`BundleInfo[]`

ListOptions

Eigenschaft	Typ	Beschreibung	Standard	Seit
`raw`	`boolean`	Ob die Rohliste der Pakete oder das Manifest zurückgegeben werden soll. Wenn wahr, wird die Liste versuchen, die interne Datenbank zu lesen und nicht die Dateien auf der Festplatte.	`false`	6.14.0

ResetOptions

Eigenschaft	Typ
`toLastSuccessful`	`boolean`

Aktueller Bundle-Ergebnis

Eigenschaft	Typ
`bundle`	`BundleInfo`
`native`	`string`

MultiDelayBedingungen

Eigenschaft	Typ
`delayConditions`	`DelayCondition[]`

Zusätzliche Verzögerungsbedingung

Eigenschaft	Typ	Beschreibung
`kind`	`DelayUntilNext`	Einstellungen für die Verzögerungskonditionen 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	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`

SetChannelOptions

Eigenschaft	Typ
`triggerAutoUpdate`	`boolean`

GetChannelRes

Eigenschaft	Typ	Beschreibung	Seitdem
`channel`	`string`	Aktueller Status von get channel	4.8.0
`error`	`string`
`message`	`string`
`status`	`string`
`allowSet`	`boolean`

ListChannelsResult

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

ChannelInfo

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

Kanal-Befehle verwenden den Kanal nameund nicht diese numerische id.

SetCustomIdOptions

Prop	Typ
`customId`	`string`

Integrierte Version

Prop	Typ
`version`	`string`

Geräte-ID

Prop	Typ
`deviceId`	`string`

Pluginversion

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`	Derzeitiger Status der Herunterladung, zwischen 0 und 100.	4.0.0
`bundle`	`BundleInfo`

KeineNotwendigkeitsevent

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

UpdateAvailableEvent

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`	Ausgelöst, wenn eine Aktualisierung nicht installiert werden konnte.	4.0.0

DownloadFailedEvent

Eigenschaft	Typ	Beschreibung	Seit
`version`	`string`	Ausgelöst, wenn ein Download fehlschlägt.	4.0.0

AppReadyEvent

Eigenschaft	Typ	Beschreibung	Seit
`bundle`	`BundleInfo`	Wird ausgelöst, wenn die App zum Einsatz bereit ist.	5.2.0
`status`	`string`

AutoUpdateAvailable

Eigenschaft	Typ
`available`	`boolean`

SetShakeMenuOptions

Eigenschaft	Typ
`enabled`	`boolean`

ShakeMenuAktiviert

Eigenschaft	Typ
`enabled`	`boolean`

Typische Alias

Abschnitt mit dem Titel “BundleStatus”

pending: Das Bundle steht noch aus SET als das nächste Bundle. herunterladen: Das Bundle wird heruntergeladen. erfolg: Das Bundle wurde heruntergeladen und ist bereit, umgesetzt zu werden.

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

SET

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

fehler: Das Bundle konnte nicht heruntergeladen werden.

Abschnitt mit dem Titel „Delay bis zum nächsten“ Fortsetzung von Funktionen und Einstellungen to plan dashboard and API operations, connect it with Using @capgo/capacitor-updater für die native Fähigkeit in @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äten.