Funktionen und Einstellungen
Updater Plugin Konfiguration
Section titled “Updater Plugin Konfiguration”Siehe Github Readme für weitere Informationen
CapacitorUpdater kann mit diesen Optionen konfiguriert werden:
| Eigenschaft | Typ | Beschreibung | Standard | Seit |
|---|---|---|---|---|
appReadyTimeout | number | Konfiguriert die Anzahl der Millisekunden, die das native Plugin warten soll, bevor ein Update als ‘fehlgeschlagen’ gilt. Nur verfügbar für Android und iOS | 10000 // (10 Sekunden) | |
responseTimeout | number | Konfiguriert die Anzahl der Millisekunden, die das native Plugin warten soll, bevor API-Timeout eintritt. Nur verfügbar für Android und iOS | 20 // (20 Sekunden) | |
autoDeleteFailed | boolean | Konfiguriert, ob das Plugin fehlgeschlagene Bundles automatisch löschen soll. Nur verfügbar für Android und iOS | true | |
autoDeletePrevious | boolean | Konfiguriert, ob das Plugin vorherige Bundles nach einem erfolgreichen Update automatisch löschen soll. Nur verfügbar für Android und iOS | true | |
autoUpdate | boolean | Konfiguriert, ob das Plugin Auto-Update über einen Update-Server verwenden soll. Nur verfügbar für Android und iOS | true | |
resetWhenUpdate | boolean | Löscht automatisch zuvor heruntergeladene Bundles, wenn ein neueres natives App-Bundle auf dem Gerät installiert wird. Nur verfügbar für Android und iOS | true | |
updateUrl | string | Konfiguriert die URL / den Endpunkt, an den Update-Prüfungen gesendet werden. Nur verfügbar für Android und iOS | https://plugin.capgo.app/updates | |
channelUrl | string | Konfiguriert die URL / den Endpunkt für Kanal-Operationen. Nur verfügbar für Android und iOS | https://plugin.capgo.app/channel_self | |
statsUrl | string | Konfiguriert die URL / den Endpunkt, an den Update-Statistiken gesendet werden. Nur verfügbar für Android und iOS. Auf "" setzen, um Statistik-Reporting zu deaktivieren | https://plugin.capgo.app/stats | |
privateKey | string | Konfiguriert den privaten Schlüssel für Ende-zu-Ende Live-Update-Verschlüsselung. Nur verfügbar für Android und iOS. Veraltet in Version 6.2.0, wird in Version 7.0.0 entfernt | undefined | |
publicKey | string | Konfiguriert den öffentlichen Schlüssel für Ende-zu-Ende Live-Update-Verschlüsselung Version 2. Nur verfügbar für Android und iOS | undefined | 6.2.0 |
version | string | Konfiguriert die aktuelle Version der App. Wird für die erste Update-Anfrage verwendet. Wenn nicht gesetzt, holt das Plugin die Version aus dem nativen Code. Nur verfügbar für Android und iOS | undefined | 4.17.48 |
directUpdate | boolean | Lässt das Plugin Updates direkt installieren, wenn die App gerade aktualisiert/installiert wurde. Nur für autoUpdate-Modus. Nur verfügbar für Android und iOS | undefined | 5.1.0 |
periodCheckDelay | number | Konfiguriert die Verzögerungsperiode für periodische Update-Prüfungen in Sekunden. Nur verfügbar für Android und iOS. Kann nicht weniger als 600 Sekunden (10 Minuten) sein | 600 // (10 Minuten) | |
localS3 | boolean | Konfiguriert die CLI zur Verwendung eines lokalen Servers für Tests oder selbst-gehosteten Update-Server | undefined | 4.17.48 |
localHost | string | Konfiguriert die CLI zur Verwendung eines lokalen Servers für Tests oder selbst-gehosteten Update-Server | undefined | 4.17.48 |
localWebHost | string | Konfiguriert die CLI zur Verwendung eines lokalen Servers für Tests oder selbst-gehosteten Update-Server | undefined | 4.17.48 |
localSupa | string | Konfiguriert die CLI zur Verwendung eines lokalen Servers für Tests oder selbst-gehosteten Update-Server | undefined | 4.17.48 |
localSupaAnon | string | Konfiguriert die CLI zur Verwendung eines lokalen Servers für Tests | undefined | 4.17.48 |
localApi | string | Konfiguriert die CLI zur Verwendung einer lokalen API für Tests | undefined | 6.3.3 |
localApiFiles | string | Konfiguriert die CLI zur Verwendung einer lokalen Datei-API für Tests | undefined | 6.3.3 |
allowModifyUrl | boolean | Erlaubt dem Plugin, updateUrl, statsUrl und channelUrl dynamisch von der JavaScript-Seite zu ändern | false | 5.4.0 |
defaultChannel | string | Setzt den Standard-Kanal für die App in der Konfiguration | undefined | 4.17.48 |
appId | string | App-ID in der Konfiguration für die App konfigurieren | undefined | 600 |
keepUrlPathAfterReload | boolean | Plugin so konfigurieren, dass der URL-Pfad nach einem Reload erhalten bleibt WARNUNG: Wenn ein Reload ausgelöst wird, wird ‘windowhistory’ gelöscht | false | 680 |
Beispiele
Section titled “Beispiele”In capacitorconfigjson:
{ "plugins": { "CapacitorUpdater": { "appReadyTimeout": 1000 // (1 Sekunde), "responseTimeout": 10 // (10 Sekunden), "autoDeleteFailed": false, "autoDeletePrevious": false, "autoUpdate": false, "resetWhenUpdate": false, "updateUrl": https://examplecom/api/auto_update, "channelUrl": https://examplecom/api/channel, "statsUrl": https://examplecom/api/stats, "privateKey": undefined, "publicKey": undefined, "version": undefined, "directUpdate": 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 } }}In capacitorconfigts:
/// <reference types="@capgo/capacitor-updater" />
import { CapacitorConfig } from '@capacitor/cli';
const config: CapacitorConfig = { plugins: { CapacitorUpdater: { appReadyTimeout: 1000 // (1 Sekunde), responseTimeout: 10 // (10 Sekunden), autoDeleteFailed: false, autoDeletePrevious: false, autoUpdate: false, resetWhenUpdate: false, updateUrl: https://examplecom/api/auto_update, channelUrl: https://examplecom/api/channel, statsUrl: https://examplecom/api/stats, privateKey: undefined, publicKey: undefined, version: undefined, directUpdate: 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, }, },};
export default config;notifyAppReady()setUpdateUrl()setStatsUrl()setChannelUrl()download()next()set()delete()list()reset()current()reload()setMultiDelay()cancelDelay()getLatest()setChannel()unsetChannel()getChannel()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()- Schnittstellen
- Typalias
Methoden
Section titled “Methoden”notifyAppReady()
Section titled “notifyAppReady()”notifyAppReady() => Promise<AppReadyResult>Benachrichtigt Capacitor Updater, dass das aktuelle Bundle funktioniert (ein Rollback erfolgt, wenn diese Methode nicht bei jedem App-Start aufgerufen wird) Standardmäßig sollte diese Methode innerhalb der ersten 10 Sekunden nach dem App-Start aufgerufen werden, andernfalls erfolgt ein Rollback Dieses Verhalten kann mit {@link appReadyTimeout} geändert werden
Returns: Promise<AppReadyResult>
setUpdateUrl()
Section titled “setUpdateUrl()”setUpdateUrl(options: UpdateUrl) => Promise<void>Legt die updateUrl für die App fest, diese wird zum Prüfen auf Updates verwendet
| Param | Type | Description |
|---|---|---|
options | UpdateUrl | enthält die URL, die für Update-Prüfungen genutzt wird |
Seit: 540
setStatsUrl()
Section titled “setStatsUrl()”setStatsUrl(options: StatsUrl) => Promise<void>Legt die statsUrl für die App fest, diese wird zum Senden von Statistiken verwendet. Wenn ein leerer String übergeben wird, wird die Erfassung von Statistiken deaktiviert
| Param | Type | Description |
|---|---|---|
options | StatsUrl | enthält die URL, die für das Senden von Statistiken verwendet wird |
Seit: 540
setChannelUrl()
Section titled “setChannelUrl()”setChannelUrl(options: ChannelUrl) => Promise<void>Legt die channelUrl für die App fest, diese wird zum Setzen des Kanals verwendet
| Param | Type | Description |
|---|---|---|
options | ChannelUrl | enthält die URL, die für das Setzen des Kanals verwendet wird |
Seit: 540
download()
Section titled “download()”download(options: DownloadOptions) => Promise<BundleInfo>Lädt ein neues Bundle von der angegebenen URL herunter, es sollte eine ZIP-Datei sein, mit Dateien innerhalb oder mit einer eindeutigen ID innerhalb mit all Ihren Dateien
| Param | Type | Description |
|---|---|---|
options | DownloadOptions | Die {@link DownloadOptions} für das Herunterladen eines neuen Bundle-ZIPs |
Returns: Promise<BundleInfo>
next()
Section titled “next()”next(options: BundleId) => Promise<BundleInfo>Legt das nächste Bundle fest, das verwendet werden soll, wenn die App neu geladen wird| Param | Type | Beschreibung |
| ------------- | --------------------------------------------- | ---------------------------------------------------------------------------------------------- |
| options | BundleId | Enthält die ID des nächsten Bundles, das beim nächsten App-Start gesetzt wird {@link BundleInfoid} |
Returns: Promise<BundleInfo>
set(options: BundleId) => Promise<void>Setzt das aktuelle Bundle und lädt die App sofort neu
| Param | Type | Beschreibung |
|---|---|---|
options | BundleId | Ein {@link BundleId} Objekt, das die neue Bundle-ID enthält |
delete()
Section titled “delete()”delete(options: BundleId) => Promise<void>Löscht das angegebene Bundle aus dem nativen App-Speicher. Verwenden Sie {@link list} um die gespeicherten Bundle-IDs zu erhalten
| Param | Type | Beschreibung |
|---|---|---|
options | BundleId | Ein {@link BundleId} Objekt, das die ID des zu löschenden Bundles enthält (Hinweis: dies ist die Bundle-ID, NICHT der Versionsname) |
list()
Section titled “list()”list(options?: ListOptions | undefined) => Promise<BundleListResult>Alle lokal heruntergeladenen Bundles in Ihrer App abrufen
| Param | Type | Beschreibung |
|---|---|---|
options | ListOptions | Die {@link ListOptions} für das Auflisten von Bundles |
Returns: Promise<BundleListResult>
reset()
Section titled “reset()”reset(options?: ResetOptions | undefined) => Promise<void>Setzt die App auf das ‘builtin’ Bundle (das an den Apple App Store / Google Play Store gesendet wurde) oder das zuletzt erfolgreich geladene Bundle zurück
| Param | Type | Beschreibung |
|---|---|---|
options | ResetOptions | Enthält {@link ResetOptionstoLastSuccessful}, true setzt auf das builtin Bundle zurück und false setzt auf das zuletzt erfolgreich geladene Bundle zurück |
current()
Section titled “current()”current() => Promise<CurrentBundleResult>Ruft das aktuelle Bundle ab, wenn keines gesetzt ist, wird ‘builtin’ zurückgegeben. currentNative ist das ursprünglich auf dem Gerät installierte Bundle
Returns: Promise<CurrentBundleResult>
reload()
Section titled “reload()”reload() => Promise<void>Die Ansicht neu laden
setMultiDelay()
Section titled “setMultiDelay()”setMultiDelay(options: MultiDelayConditions) => Promise<void>Setzt ein {@link DelayCondition} Array mit Bedingungen, die das Plugin verwendet, um das Update zu verzögern Nachdem alle Bedingungen erfüllt sind, wird der Update-Prozess wie gewohnt neu gestartet, sodass das Update nach dem Hintergrundsetzen oder Beenden der App installiert wird Für die Art ‘date’ sollte der Wert ein iso8601-Datums-String sein Für die Art ‘background’ sollte der Wert eine Zahl in Millisekunden sein Für die Art ‘nativeVersion’ sollte der Wert die Versionsnummer sein Für die Art ‘kill’ wird der Wert nicht verwendet Die Funktion hat inkonsistentes Verhalten: Die Option kill löst das Update nach dem ersten Beenden aus und nicht nach dem nächsten Hintergrundsetzen wie andere Optionen. Dies wird in einem zukünftigen Major Release behoben
| Param | Type | Beschreibung |
|---|---|---|
options | MultiDelayConditions | Enthält das {@link MultiDelayConditions} Array von Bedingungen |
Seit: 430
cancelDelay()
Section titled “cancelDelay()”cancelDelay() => Promise<void>Bricht eine {@link DelayCondition} ab, um ein Update sofort zu verarbeiten
Seit: 400
getLatest()
Section titled “getLatest()”getLatest(options?: GetLatestOptions | undefined) => Promise<LatestVersion>Neuestes verfügbares Bundle von der Update-URL abrufen
| Param | Type |
|---|---|
options | GetLatestOptions |
Returns: Promise<LatestVersion>
Seit: 400
setChannel()
Section titled “setChannel()”setChannel(options: SetChannelOptions) => Promise<ChannelRes>Setzt den Kanal für dieses Gerät. Der Kanal muss Selbstzuweisung erlauben, damit dies funktioniert
Verwenden Sie diese Methode nicht, um den Kanal beim Start zu setzen, wenn autoUpdate in der {@link PluginsConfig} aktiviert ist
Diese Methode dient dazu, den Kanal zu setzen, nachdem die App bereit ist
Diese Methode sendet eine Anfrage an den Capgo-Backend, um die Geräte-ID mit dem Kanal zu verknüpfen. Capgo kann dies je nach den Einstellungen Ihres Kanals akzeptieren oder ablehnen
| Param | Type | Beschreibung |
|---|---|---|
options | SetChannelOptions | Ist die {@link SetChannelOptions} Kanal zu setzen |
Returns: Promise<ChannelRes>
Seit: 470
unsetChannel()
Section titled “unsetChannel()”unsetChannel(options: UnsetChannelOptions) => Promise<void>Hebt die Einstellung des Kanals für dieses Gerät aufDas Gerät kehrt dann zum Standardkanal zurück
| Param | Type |
|---|---|
options | UnsetChannelOptions |
Seit: 470
getChannel()
Section titled “getChannel()”getChannel() => Promise<GetChannelRes>Rufe den Kanal für dieses Gerät ab
Returns: Promise<GetChannelRes>
Seit: 480
setCustomId()
Section titled “setCustomId()”setCustomId(options: SetCustomIdOptions) => Promise<void>Lege eine benutzerdefinierte ID für dieses Gerät fest
| Param | Type | Description |
|---|---|---|
options | SetCustomIdOptions | ist die {@link SetCustomIdOptions} customId zum Setzen |
Seit: 490
getBuiltinVersion()
Section titled “getBuiltinVersion()”getBuiltinVersion() => Promise<BuiltinVersion>Rufe die native App-Version oder die in der Konfiguration festgelegte Builtin-Version ab
Returns: Promise<BuiltinVersion>
Seit: 520
getDeviceId()
Section titled “getDeviceId()”getDeviceId() => Promise<DeviceId>Rufe eindeutige ID ab, die zur Identifizierung des Geräts verwendet wird (wird an den Auto-Update-Server gesendet)
Returns: Promise<DeviceId>
getPluginVersion()
Section titled “getPluginVersion()”getPluginVersion() => Promise<PluginVersion>Rufe die native Capacitor Updater Plugin-Version ab (wird an den Auto-Update-Server gesendet)
Returns: Promise<PluginVersion>
isAutoUpdateEnabled()
Section titled “isAutoUpdateEnabled()”isAutoUpdateEnabled() => Promise<AutoUpdateEnabled>Rufe den Status der Auto-Update-Konfiguration ab
Returns: Promise<AutoUpdateEnabled>
removeAllListeners()
Section titled “removeAllListeners()”removeAllListeners() => Promise<void>Entferne alle Listener für dieses Plugin
Seit: 100
addListener(‘download’, )
Section titled “addListener(‘download’, )”addListener(eventName: 'download', listenerFunc: (state: DownloadEvent) => void) => Promise<PluginListenerHandle>Höre auf Bundle-Download-Events in der App. Wird ausgelöst, wenn ein Download startet, während des Downloads und wenn er abgeschlossen ist
| Param | Type |
|---|---|
eventName | ’download’ |
listenerFunc | (state: DownloadEvent) => void |
Returns: Promise<PluginListenerHandle>
Seit: 2011
addListener(‘noNeedUpdate’, )
Section titled “addListener(‘noNeedUpdate’, )”addListener(eventName: 'noNeedUpdate', listenerFunc: (state: NoNeedEvent) => void) => Promise<PluginListenerHandle>Höre auf Events, wenn kein Update benötigt wird. Nützlich, wenn bei jedem App-Start eine Überprüfung erzwungen werden soll
| Param | Type |
|---|---|
eventName | ’noNeedUpdate’ |
listenerFunc | (state: NoNeedEvent) => void |
Returns: Promise<PluginListenerHandle>
Seit: 400
addListener(‘updateAvailable’, )
Section titled “addListener(‘updateAvailable’, )”addListener(eventName: 'updateAvailable', listenerFunc: (state: UpdateAvailableEvent) => void) => Promise<PluginListenerHandle>Höre auf verfügbare Update-Events. Nützlich, wenn bei jedem App-Start eine Überprüfung erzwungen werden soll
| Param | Type |
|---|---|
eventName | ’updateAvailable’ |
listenerFunc | (state: UpdateAvailableEvent) => void |
Returns: Promise<PluginListenerHandle>
Seit: 400
addListener(‘downloadComplete’, )
Section titled “addListener(‘downloadComplete’, )”addListener(eventName: 'downloadComplete', listenerFunc: (state: DownloadCompleteEvent) => void) => Promise<PluginListenerHandle>Höre auf downloadComplete Events
| Param | Type |
|---|---|
eventName | ’downloadComplete’ |
listenerFunc | (state: DownloadCompleteEvent) => void |
Returns: Promise<PluginListenerHandle>
Seit: 400
addListener(‘majorAvailable’, )
Section titled “addListener(‘majorAvailable’, )”addListener(eventName: 'majorAvailable', listenerFunc: (state: MajorAvailableEvent) => void) => Promise<PluginListenerHandle>Höre auf Major-Update-Events in der App. Informiert dich, wenn ein Major-Update durch die Einstellung disableAutoUpdateBreaking blockiert wird
| Param | Type |
|---|---|
eventName | ’majorAvailable’ |
listenerFunc | (state: MajorAvailableEvent) => void |
Returns: Promise<PluginListenerHandle>
Seit: 230
addListener(‘updateFailed’, )
Section titled “addListener(‘updateFailed’, )”addListener(eventName: 'updateFailed', listenerFunc: (state: UpdateFailedEvent) => void) => Promise<PluginListenerHandle>Höre auf Update-Fehlschlag-Events in der App. Informiert dich, wenn ein Update beim nächsten App-Start nicht installiert werden konnte
| Param | Type |
|---|---|
eventName | ’updateFailed’ |
listenerFunc | (state: UpdateFailedEvent) => void |
Returns: Promise<PluginListenerHandle>
Seit: 230
addListener(‘downloadFailed’,```typescript
Section titled “addListener(‘downloadFailed’,```typescript”addListener(eventName: ‘downloadFailed’, listenerFunc: (state: DownloadFailedEvent) => void) => Promise
Lauschen Sie auf das Download-Fehlerereignis in der App, das Sie darüber informiert, wenn ein Bundle-Download fehlgeschlagen ist
| Param | Typ ||--------------|----------------------------------------------------------------------------------------|| **`eventName`** | <code>'downloadFailed'</code> || **`listenerFunc`** | <code>(state: <a href="#downloadfailedevent">DownloadFailedEvent</a>) => void</code> |
**Gibt zurück:** <code>Promise<<a href="#pluginlistenerhandle">PluginListenerHandle</a>></code>
**Seit:** 400
--------------------
## addListener('appReloaded', )
```typescriptaddListener(eventName: 'appReloaded', listenerFunc: () => void) => Promise<PluginListenerHandle>Lauschen Sie auf das Neuladen-Ereignis in der App, das Sie darüber informiert, wenn ein Neuladen stattgefunden hat
| Param | Typ |
|---|---|
eventName | ’appReloaded’ |
listenerFunc | () => void |
Gibt zurück: Promise<PluginListenerHandle>
Seit: 430
addListener(‘appReady’, )
Section titled “addListener(‘appReady’, )”addListener(eventName: 'appReady', listenerFunc: (state: AppReadyEvent) => void) => Promise<PluginListenerHandle>Lauschen Sie auf das App-Bereit-Ereignis in der App, das Sie darüber informiert, wenn die App einsatzbereit ist
| Param | Typ |
|---|---|
eventName | ’appReady’ |
listenerFunc | (state: AppReadyEvent) => void |
Gibt zurück: Promise<PluginListenerHandle>
Seit: 510
isAutoUpdateAvailable()
Section titled “isAutoUpdateAvailable()”isAutoUpdateAvailable() => Promise<AutoUpdateAvailable>Prüfen Sie, ob automatische Aktualisierung verfügbar ist (nicht durch serverUrl deaktiviert)
Gibt zurück: Promise<AutoUpdateAvailable>
getNextBundle()
Section titled “getNextBundle()”getNextBundle() => Promise<BundleInfo | null>Ruft das nächste Bundle ab, das beim Neuladen der App verwendet wird Gibt null zurück, wenn kein nächstes Bundle festgelegt ist
Gibt zurück: Promise<BundleInfo | null>
Seit: 680
Interfaces
Section titled “Interfaces”AppReadyResult
Section titled “AppReadyResult”| Eigenschaft | Typ |
|---|---|
bundle | BundleInfo |
BundleInfo
Section titled “BundleInfo”| Eigenschaft | Typ |
|---|---|
id | string |
version | string |
downloaded | string |
checksum | string |
status | BundleStatus |
UpdateUrl
Section titled “UpdateUrl”| Eigenschaft | Typ |
|---|---|
url | string |
StatsUrl
Section titled “StatsUrl”| Eigenschaft | Typ |
|---|---|
url | string |
ChannelUrl
Section titled “ChannelUrl”| Eigenschaft | Typ |
|---|---|
url | string |
DownloadOptions
Section titled “DownloadOptions”| Eigenschaft | Typ | Beschreibung | Standard | Seit |
|---|---|---|---|---|
url | string | Die URL der Bundle-ZIP-Datei (z.B. distzip), die heruntergeladen werden soll (Dies kann eine beliebige URL sein, z.B. Amazon S3, ein GitHub-Tag oder ein anderer Ort, an dem Sie Ihr Bundle gehostet haben) | ||
version | string | Der Versions-Code/Name dieses Bundles/dieser Version | ||
sessionKey | string | Der Sitzungsschlüssel für das Update | undefined | 400 |
checksum | string | Die Prüfsumme für das Update | undefined | 400 |
BundleId
Section titled “BundleId”| Eigenschaft | Typ |
|---|---|
id | string |
BundleListResult
Section titled “BundleListResult”| Eigenschaft | Typ |
|---|---|
bundles | BundleInfo[] |
ListOptions
Section titled “ListOptions”| Eigenschaft | Typ | Beschreibung | Standard | Seit |
|---|---|---|---|---|
raw | boolean | Ob die rohe Bundle-Liste oder das Manifest zurückgegeben werden soll. Wenn true, wird versucht, die interne Datenbank anstelle von Dateien auf der Festplatte zu lesen | false | 6140 |
ResetOptions
Section titled “ResetOptions”| Eigenschaft | Typ |
|---|---|
toLastSuccessful | boolean |
CurrentBundleResult
Section titled “CurrentBundleResult”| Eigenschaft | Typ |
|---|---|
bundle | BundleInfo |
native | string |
MultiDelayConditions
Section titled “MultiDelayConditions”| Eigenschaft | Typ |
|---|---|
delayConditions | DelayCondition[] |
DelayCondition
Section titled “DelayCondition”| Eigenschaft | Typ | Beschreibung |
|---|---|---|
kind | DelayUntilNext | Verzögerungsbedingungen in setMultiDelay einrichten |
value | string |
LatestVersion
Section titled “LatestVersion”| Eigenschaft | Typ | Beschreibung | Seit |
|---|---|---|---|
version | string | Ergebnis der getLatest-Methode | 400 |
checksum | string | 6 | |
major | boolean | ||
message | string | ||
sessionKey | string | ||
error | string | ||
old | string | ||
url | string | ||
manifest | ManifestEntry[] | 61 |
ManifestEntry
Section titled “ManifestEntry”| Eigenschaft | Typ |
|---|---|
file_name | string | null |
file_hash | string | null |
download_url | string | null |
GetLatestOptions
Section titled “GetLatestOptions”| Eigenschaft | Typ | Beschreibung | Standard | Seit |
|---|---|---|---|---|
channel | string | Der Kanal, für den die neueste Version abgerufen werden soll. Der Kanal muss ‘self_assign’ für die Funktionalität erlauben | undefined | 680 |
ChannelRes
Section titled “ChannelRes”| Eigenschaft | Typ | Beschreibung | Seit |
|---|---|---|---|
status | string | Aktueller Status des Kanals | 470 |
error | string | ||
message | string |
SetChannelOptions
Section titled “SetChannelOptions”| Eigenschaft | Typ |
|---|---|
channel | string |
triggerAutoUpdate | boolean |
UnsetChannelOptions
Section titled “UnsetChannelOptions”| Eigenschaft | Typ |
|---|---|
triggerAutoUpdate | boolean |
GetChannelRes
Section titled “GetChannelRes”| Eigenschaft | Typ | Beschreibung | Seit |
|---|---|---|---|
channel | string | Aktueller Status des Kanals | 480 |
error | string | ||
message | string | ||
status | string | ||
allowSet | boolean |
SetCustomIdOptions
Section titled “SetCustomIdOptions”| Eigenschaft | Typ |
|---|---|
customId | string |
BuiltinVersion
Section titled “BuiltinVersion”| Eigenschaft | Typ |
|---|---|
version | string |
DeviceId
Section titled “DeviceId”| Eigenschaft | Typ |
|---|---|
deviceId | string |
PluginVersion
Section titled “PluginVersion”| Eigenschaft | Typ |
|---|---|
version | string |
AutoUpdateEnabled
Section titled “AutoUpdateEnabled”| Eigenschaft | Typ |
|---|---|
enabled | boolean |
PluginListenerHandle
Section titled “PluginListenerHandle”| Eigenschaft | Typ |
|---|---|
remove | () => Promise<void> |
DownloadEvent
Section titled “DownloadEvent”| Eigenschaft | Typ | Beschreibung | Seit |
|---|---|---|---|
percent | number | Aktueller Download-Status, zwischen 0 und 100 | 400 |
bundle | BundleInfo |
NoNeedEvent
Section titled “NoNeedEvent”| Eigenschaft | Typ | Beschreibung | Seit |
|---|---|---|---|
bundle | BundleInfo | Aktueller Download-Status, zwischen 0 und 100 | 400 |
UpdateAvailableEvent
Section titled “UpdateAvailableEvent”| Eigenschaft | Typ | Beschreibung | Seit |
|---|---|---|---|
bundle | BundleInfo | Aktueller Download-Status, zwischen 0 und 100 | 400 |
DownloadCompleteEvent
Section titled “DownloadCompleteEvent”| Eigenschaft | Typ | Beschreibung | Seit |
|---|---|---|---|
bundle | BundleInfo | Wird ausgelöst, wenn ein Update verfügbar ist | 400 |
MajorAvailableEvent
Section titled “MajorAvailableEvent”| Eigenschaft | Typ | Beschreibung | Seit |
|---|---|---|---|
version | string | Wird ausgelöst, wenn ein Major-Update verfügbar ist | 400 |
UpdateFailedEvent
Section titled “UpdateFailedEvent”| Eigenschaft | Typ | Beschreibung | Seit |
|---|---|---|---|
bundle | BundleInfo | Wird ausgelöst, wenn ein Update fehlgeschlagen ist | 400 |
DownloadFailedEvent
Section titled “DownloadFailedEvent”| Eigenschaft | Typ | Beschreibung | Seit |
|---|---|---|---|
version | string | Wird ausgelöst, wenn ein Download fehlschlägt | 400 |
AppReadyEvent
Section titled “AppReadyEvent”| Eigenschaft | Typ | Beschreibung | Seit |
|---|---|---|---|
bundle | BundleInfo | Wird ausgelöst, wenn die App bereit ist | 520 |
status | string |
AutoUpdateAvailable
Section titled “AutoUpdateAvailable”| Eigenschaft | Typ |
|---|---|
available | boolean |
Type Aliases
Section titled “Type Aliases”BundleStatus
Section titled “BundleStatus”‘success’ | ‘error’ | ‘pending’ | ‘downloading’
DelayUntilNext
Section titled “DelayUntilNext”‘background’ | ‘kill’ | ‘nativeVersion’ | ‘date’