Funzioni e impostazioni

Configurazione Plugin Updater

Consulta il Readme su Github per ulteriori informazioni.

CapacitorUpdater può essere configurato con queste opzioni:

Prop	Type	Description	Default	Since
appReadyTimeout	number	Configura il numero di millisecondi che il plugin nativo dovrebbe aspettare prima di considerare un aggiornamento ‘non riuscito’. Disponibile solo per Android e iOS.	10000 // (10 secondi)
responseTimeout	number	Configura il numero di millisecondi che il plugin nativo dovrebbe aspettare prima di considerare un timeout API. Disponibile solo per Android e iOS.	20 // (20 secondi)
autoDeleteFailed	boolean	Configura se il plugin dovrebbe eliminare automaticamente i bundle non riusciti. Disponibile solo per Android e iOS.	true
autoDeletePrevious	boolean	Configura se il plugin dovrebbe eliminare automaticamente i bundle precedenti dopo un aggiornamento riuscito. Disponibile solo per Android e iOS.	true
autoUpdate	boolean	Configura se il plugin dovrebbe utilizzare l’aggiornamento automatico tramite un server di aggiornamento. Disponibile solo per Android e iOS.	true
resetWhenUpdate	boolean	Elimina automaticamente i bundle scaricati precedentemente quando viene installato un nuovo bundle di app nativo sul dispositivo. Disponibile solo per Android e iOS.	true
updateUrl	string	Configura l’URL / endpoint a cui vengono inviati i controlli degli aggiornamenti. Disponibile solo per Android e iOS.	https://plugin.capgo.app/updates
channelUrl	string	Configura l’URL / endpoint per le operazioni del canale. Disponibile solo per Android e iOS.	https://plugin.capgo.app/channel_self
statsUrl	string	Configura l’URL / endpoint a cui vengono inviate le statistiche degli aggiornamenti. Disponibile solo per Android e iOS. Imposta su "" per disabilitare la segnalazione delle statistiche.	https://plugin.capgo.app/stats
publicKey	string	Configura la chiave pubblica per la crittografia end to end degli aggiornamenti in tempo reale. Versione 2 Disponibile solo per Android e iOS.	undefined	6.2.0
version	string	Configura la versione corrente dell’app. Verrà utilizzato per la prima richiesta di aggiornamento. Se non impostato, il plugin otterrà la versione dal codice nativo. Disponibile solo per Android e iOS.	undefined	4.17.48
directUpdate	boolean | ‘always’ | ‘atInstall’ | ‘onLaunch’	Configura quando il plugin dovrebbe installare direttamente gli aggiornamenti. Solo per la modalità autoUpdate. Funziona bene per app di dimensioni inferiori a 10MB e con caricamenti effettuati utilizzando il flag —partial. Gli zip o le app di dimensioni superiori a 10MB saranno relativamente lenti per gli utenti da aggiornare. - false: Non eseguire mai aggiornamenti diretti (usa il comportamento predefinito: scarica all’inizio, imposta quando in background) - atInstall: Aggiornamento diretto solo quando l’app viene installata, aggiornata dallo store, altrimenti agisci come directUpdate = false - onLaunch: Aggiornamento diretto solo all’installazione dell’app, aggiornamento dallo store o dopo l’eliminazione dell’app, altrimenti agisci come directUpdate = false - always: Aggiornamento diretto in tutti i casi precedenti (app installata, aggiornata dallo store, dopo l’eliminazione dell’app o la ripresa dell’app), non agire mai come directUpdate = false - true: (deprecato) Come “always” per la compatibilità con le versioni precedenti Solo per Android e iOS.	false	5.1.0
autoSplashscreen	boolean	Gestisce automaticamente l’occultamento della splashscreen quando si utilizza directUpdate. Se abilitato, il plugin nasconderà automaticamente la splashscreen dopo l’applicazione degli aggiornamenti o quando non è necessario nessun aggiornamento. Ciò elimina la necessità di ascoltare manualmente gli eventi appReady e chiamare SplashScreen.hide(). Funziona solo quando directUpdate è impostato su “atInstall”, “always” o true. Richiede che il plugin @capacitor/splash-screen sia installato e configurato con launchAutoHide: false. Richiede che autoUpdate e directUpdate siano abilitati. Solo per Android e iOS.	false	7.6.0
periodCheckDelay	number	Configura il periodo di ritardo per il controllo periodico degli aggiornamenti. L’unità è in secondi. Solo per Android e iOS. Non può essere inferiore a 600 secondi (10 minuti).	600 // (10 minuti)
localS3	boolean	Configura la CLI per utilizzare un server locale per i test o un server di aggiornamento self-hosted.	undefined	4.17.48
localHost	string	Configura la CLI per utilizzare un server locale per i test o un server di aggiornamento self-hosted.	undefined	4.17.48
localWebHost	string	Configura la CLI per utilizzare un server locale per i test o un server di aggiornamento self-hosted.	undefined	4.17.48
localSupa	string	Configura la CLI per utilizzare un server locale per i test o un server di aggiornamento self-hosted.	undefined	4.17.48
localSupaAnon	string	Configura la CLI per utilizzare un server locale per i test.	undefined	4.17.48
localApi	string	Configura la CLI per utilizzare un api locale per i test.	undefined	6.3.3
localApiFiles	string	Configura la CLI per utilizzare un api di file locale per i test.	undefined	6.3.3
allowModifyUrl	boolean	Permette al plugin di modificare dinamicamente updateUrl, statsUrl e channelUrl dal lato JavaScript.	false	5.4.0
defaultChannel	string	Imposta il canale predefinito per l’app nella configurazione. Sensibile alle maiuscole. Questa impostazione sovrascriverà il canale predefinito impostato nel cloud, ma rispetterà comunque le sostituzioni effettuate nel cloud.	undefined	5.5.0
appId	string	Configura l’id dell’app per l’app nella configurazione.	undefined	6.0.0
keepUrlPathAfterReload	boolean	Configura il plugin per mantenere il percorso URL dopo un ricaricamento. AVVERTENZA: Quando viene attivato un ricaricamento, ‘window.history’ verrà cancellato.	false	6.8.0
disableJSLogging	boolean	Disabilita la registrazione JavaScript del plugin. se true, il plugin non registrerà la console JavaScript. solo il log nativo verrà eseguito	false	7.3.0
shakeMenu	boolean	Abilita il gesto di scuotimento per mostrare il menu di aggiornamento per scopi di debug/test	false	7.5.0

Esempi

In capacitor.config.json:

{
  "plugins": {
    "CapacitorUpdater": {
      "appReadyTimeout": 1000 // (1 secondo),
      "responseTimeout": 10 // (10 secondi),
      "autoDeleteFailed": false,
      "autoDeletePrevious": false,
      "autoUpdate": false,
      "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:

/// <reference types="@capgo/capacitor-updater" />

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

const config: CapacitorConfig = {
  plugins: {
    CapacitorUpdater: {
      appReadyTimeout: 1000 // (1 secondo),
      responseTimeout: 10 // (10 secondi),
      autoDeleteFailed: false,
      autoDeletePrevious: false,
      autoUpdate: false,
      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()
• Interfacce
• Alias di Tipo

Metodi

notifyAppReady()

notifyAppReady() => Promise<AppReadyResult>

Notifica a Capacitor Updater che il bundle corrente funziona (un rollback si verificherà se questo metodo non viene chiamato ad ogni avvio dell’app) Per impostazione predefinita, questo metodo dovrebbe essere chiamato nei primi 10 secondi dopo l’avvio dell’app, altrimenti si verificherà un rollback. Modifica questo comportamento con {@link appReadyTimeout}

Restituisce: Promise<AppReadyResult>

---

setUpdateUrl(…)

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

Imposta l’updateUrl per l’app, questo verrà utilizzato per verificare gli aggiornamenti.

Param	Type	Description
options	UpdateUrl	contiene l’URL da utilizzare per verificare gli aggiornamenti.

Since: 5.4.0

---

setStatsUrl(…)

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

Imposta l’statsUrl per l’app, questo verrà utilizzato per inviare le statistiche. Il passaggio di una stringa vuota disabiliterà la raccolta di statistiche.

Param	Type	Description
options	StatsUrl	contiene l’URL da utilizzare per inviare le statistiche.

Since: 5.4.0

---

setChannelUrl(…)

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

Imposta l’channelUrl per l’app, questo verrà utilizzato per impostare il canale.

Param	Type	Description
options	ChannelUrl	contiene l’URL da utilizzare per impostare il canale.

Since: 5.4.0

---

download(…)

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

Scarica un nuovo bundle dall’URL fornito, dovrebbe essere un file zip, con file dentro o con un id univoco dentro con tutti i tuoi file

Param	Type	Description
options	DownloadOptions	Le {@link DownloadOptions} per scaricare un nuovo bundle zip.

Restituisce: Promise<BundleInfo>

---

next(…)

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

Imposta il bundle successivo da utilizzare quando l’app viene ricaricata.

Param	Type	Description
options	BundleId	Contiene l’ID del bundle successivo da impostare al prossimo avvio dell’app. {@link BundleInfo.id}

Restituisce: Promise<BundleInfo>

---

set(…)

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

Imposta il bundle corrente e ricarica immediatamente l’app.

Param	Type	Description
options	BundleId	Un oggetto {@link BundleId} contenente il nuovo id del bundle da impostare come corrente.

---

delete(…)

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

Elimina il bundle specificato dall’archiviazione nativa dell’app. Usa con {@link list} per ottenere gli ID dei Bundle memorizzati.

Param	Type	Description
options	BundleId	Un oggetto {@link BundleId} contenente l’ID di un bundle da eliminare (nota, questo è l’id del bundle, NON il nome della versione)

---

list(…)

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

Ottieni tutti i bundle scaricati localmente nella tua app

Param	Type	Description
options	ListOptions	Le {@link ListOptions} per elencare i bundle

Restituisce: Promise<BundleListResult>

---

reset(…)

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

Ripristina l’app al bundle builtin (quello inviato a Apple App Store / Google Play Store) o all’ultimo bundle caricato con successo.

Param	Type	Description
options	ResetOptions	Contenente {@link ResetOptions.toLastSuccessful}, true ripristina il bundle builtin e false ripristinerà l’ultimo bundle caricato con successo.

---

current()

current() => Promise<CurrentBundleResult>

Ottieni il bundle corrente, se nessuno è impostato restituisce builtin. currentNative è il bundle originale installato sul dispositivo

Restituisce: Promise<CurrentBundleResult>

---

reload()

reload() => Promise<void>

Ricarica la vista

---

setMultiDelay(…)

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

Imposta un array {@link DelayCondition} contenente le condizioni che il Plugin utilizzerà per ritardare l’aggiornamento. Dopo che tutte le condizioni sono soddisfatte, il processo di aggiornamento verrà eseguito di nuovo come al solito, quindi l’aggiornamento verrà installato dopo l’inserimento in background o l’interruzione dell’app. Per il tipo date, il valore dovrebbe essere una stringa di data iso8601. Per il tipo background, il valore dovrebbe essere un numero in millisecondi. Per il tipo nativeVersion, il valore dovrebbe essere il numero di versione. Per il tipo kill, il valore non viene utilizzato. La funzione ha un comportamento incoerente, l’opzione kill attiva l’aggiornamento dopo il primo kill e non dopo il successivo background come altre opzioni. Questo verrà corretto in una versione principale futura.

Param	Type	Description
options	MultiDelayConditions	Contenente l’array {@link MultiDelayConditions} di condizioni da impostare

Since: 4.3.0

---

cancelDelay()

cancelDelay() => Promise<void>

Annulla un {@link DelayCondition} per elaborare un aggiornamento immediatamente.

Since: 4.0.0

---

getLatest(…)

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

Ottieni il bundle più recente disponibile da update Url

Param	Type
options	GetLatestOptions

Restituisce: Promise<LatestVersion>

Since: 4.0.0

---

setChannel(…)

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

Imposta il canale per questo dispositivo. Il canale deve consentire l’autoassegnazione perché questo funzioni. Non utilizzare questo metodo per impostare il canale all’avvio. Questo metodo serve a impostare il canale dopo che l’app è pronta e l’utente ha interagito. Se desideri impostare il canale all’avvio, utilizza {@link PluginsConfig} per impostare il canale predefinito. Questo metodo invia al backend Capgo una richiesta per collegare l’ID del dispositivo al canale. Capgo può accettare o rifiutare in base alle impostazioni del tuo canale.

Param	Type	Description
options	SetChannelOptions	È la {@link SetChannelOptions} canale da impostare

Restituisce: Promise<ChannelRes>

Since: 4.7.0

---

unsetChannel(…)

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

Annulla l’impostazione del canale per questo dispositivo. Il dispositivo tornerà quindi al canale predefinito

Param	Type
options	UnsetChannelOptions

Since: 4.7.0

---

getChannel()

getChannel() => Promise<GetChannelRes>

Ottieni il canale per questo dispositivo

Restituisce: Promise<GetChannelRes>

Since: 4.8.0

---

listChannels()

listChannels() => Promise<ListChannelsResult>

Elenca tutti i canali disponibili per questo dispositivo che consentono l’autoassegnazione

Restituisce: Promise<ListChannelsResult>

Since: 7.5.0

---

setCustomId(…)

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

Imposta un ID personalizzato per questo dispositivo

Param	Type	Description
options	SetCustomIdOptions	è l’opzione {@link SetCustomIdOptions} customId da impostare

Since: 4.9.0

---

getBuiltinVersion()

getBuiltinVersion() => Promise<BuiltinVersion>

Ottieni la versione dell’app nativa o la versione builtin se impostato nella configurazione

Restituisce: Promise<BuiltinVersion>

Since: 5.2.0

---

getDeviceId()

getDeviceId() => Promise<DeviceId>

Ottieni l’ID univoco utilizzato per identificare il dispositivo (inviato al server di aggiornamento automatico)

Restituisce: Promise<DeviceId>

---

getPluginVersion()

getPluginVersion() => Promise<PluginVersion>

Ottieni la versione del plugin Capacitor Updater nativo (inviato al server di aggiornamento automatico)

Restituisce: Promise<PluginVersion>

---

isAutoUpdateEnabled()

isAutoUpdateEnabled() => Promise<AutoUpdateEnabled>

Ottieni lo stato della configurazione dell’aggiornamento automatico.

Restituisce: Promise<AutoUpdateEnabled>

---

removeAllListeners()

removeAllListeners() => Promise<void>

Rimuovi tutti i listener per questo plugin.

Since: 1.0.0

---

addListener(‘download’, …)

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

Ascolta l’evento di download del bundle nell’App. Si attiva una volta che è iniziato il download, durante il download e al termine. Questo ti restituirà la percentuale di download durante il download

Param	Type
eventName	’download’
listenerFunc	(state: DownloadEvent) => void

Restituisce: Promise<PluginListenerHandle>

Since: 2.0.11

---

addListener(‘noNeedUpdate’, …)

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

Ascolta l’evento nessun aggiornamento necessario, utile quando vuoi forzare il controllo ogni volta che l’app viene avviata

Param	Type
eventName	’noNeedUpdate’
listenerFunc	(state: NoNeedEvent) => void

Restituisce: Promise<PluginListenerHandle>

Since: 4.0.0

---

addListener(‘updateAvailable’, …)

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

Ascolta l’evento di aggiornamento disponibile, utile quando desideri forzare il controllo ogni volta che l’app viene avviata

Param	Type
eventName	’updateAvailable’
listenerFunc	(state: UpdateAvailableEvent) => void

Restituisce: Promise<PluginListenerHandle>

Since: 4.0.0

---

addListener(‘downloadComplete’, …)

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

Ascolta gli eventi downloadComplete.

Param	Type
eventName	’downloadComplete’
listenerFunc	(state: DownloadCompleteEvent) => void

Restituisce: Promise<PluginListenerHandle>

Since: 4.0.0

---

addListener(‘majorAvailable’, …)

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

Ascolta l’evento di aggiornamento importante nell’App, ti fa sapere quando l’aggiornamento importante è bloccato dall’impostazione disableAutoUpdateBreaking

Param	Type
eventName	’majorAvailable’
listenerFunc	(state: MajorAvailableEvent) => void

Restituisce: Promise<PluginListenerHandle>

Since: 2.3.0

---

addListener(‘updateFailed’, …)

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

Ascolta l’evento di aggiornamento non riuscito nell’App, ti fa sapere quando l’aggiornamento non è riuscito a installarsi al prossimo avvio dell’app

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

Restituisce: Promise<PluginListenerHandle>

Since: 2.3.0

---

addListener(‘downloadFailed’, …)

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

Ascolta l’evento di download non riuscito nell’App, ti fa sapere quando il download di un bundle non è riuscito

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

Restituisce: Promise<PluginListenerHandle>

Since: 4.0.0

---

addListener(‘appReloaded’, …)

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

Ascolta l’evento di ricaricamento nell’App, ti fa sapere quando si è verificato il ricaricamento

Param	Type
eventName	’appReloaded’
listenerFunc	() => void

Restituisce: Promise<PluginListenerHandle>

Since: 4.3.0

---

addListener(‘appReady’, …)

addListener(eventName: 'appReady', listenerFunc: (state: AppReadyEvent) => void) => Promise<PluginListenerHandle>

Ascolta l’evento app pronto nell’App, ti fa sapere quando l’app è pronta per l’uso

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

Restituisce: Promise<PluginListenerHandle>

Since: 5.1.0

---

isAutoUpdateAvailable()

isAutoUpdateAvailable() => Promise<AutoUpdateAvailable>

Scopri se l’aggiornamento automatico è disponibile (non disabilitato da serverUrl).

Restituisce: Promise<AutoUpdateAvailable>

---

getNextBundle()

getNextBundle() => Promise<BundleInfo | null>

Ottieni il bundle successivo che verrà utilizzato quando l’app viene ricaricata. Restituisce null se nessun bundle successivo è impostato.

Restituisce: Promise<BundleInfo | null>

Since: 6.8.0

---

setShakeMenu(…)

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

Abilita o disabilita il menu di scuotimento per scopi di debug/test

Param	Type	Description
options	SetShakeMenuOptions	Contiene il booleano abilitato per abilitare o disabilitare il menu di scuotimento

Since: 7.5.0

---

isShakeMenuEnabled()

isShakeMenuEnabled() => Promise<ShakeMenuEnabled>

Ottieni lo stato corrente del menu di scuotimento

Restituisce: Promise<ShakeMenuEnabled>

Since: 7.5.0

---

Interfacce

AppReadyResult

Prop	Type
bundle	BundleInfo

BundleInfo

Prop	Type
id	string
version	string
downloaded	string
checksum	string
status	BundleStatus

UpdateUrl

Prop	Type
url	string

StatsUrl

Prop	Type
url	string

ChannelUrl

Prop	Type
url	string

DownloadOptions

Questo URL e le versioni vengono utilizzati per scaricare il bundle dal server. Se utilizzi il backend, tutte le informazioni verranno fornite dal metodo getLatest. Se non utilizzi il backend, devi fornire l’URL e la versione del bundle. Checksum e sessionKey sono obbligatori se hai crittografato il bundle con il comando CLI encrypt, dovresti riceverli come risultato del comando.

Prop	Type	Description	Default	Since
url	string	L’URL del file zip bundle (ad esempio: dist.zip) da scaricare. (Questo può essere qualsiasi URL. Ad esempio: Amazon S3, un tag GitHub, qualsiasi altro luogo in cui hai ospitato il tuo bundle.)
version	string	Il codice di versione/nome di questo bundle/versione
sessionKey	string	La chiave di sessione per l’aggiornamento, quando il bundle è crittografato con una chiave di sessione	undefined	4.0.0
checksum	string	Il checksum per l’aggiornamento, dovrebbe essere in sha256 e crittografato con chiave privata se il bundle è crittografato	undefined	4.0.0
manifest	ManifestEntry[]	Il manifesto per i download di più file	undefined	6.1.0

ManifestEntry

Prop	Type
file_name	string | null
file_hash	string | null
download_url	string | null

BundleId

Prop	Type
id	string

BundleListResult

Prop	Type
bundles	BundleInfo[]

ListOptions

Prop	Type	Description	Default	Since
raw	boolean	Se restituire l’elenco dei bundle non elaborato o il manifesto. Se true, l’elenco tenterà di leggere il database interno anziché i file su disco.	false	6.14.0

ResetOptions

Prop	Type
toLastSuccessful	boolean

CurrentBundleResult

Prop	Type
bundle	BundleInfo
native	string

MultiDelayConditions

Prop	Type
delayConditions	DelayCondition[]

DelayCondition

Prop	Type	Description
kind	DelayUntilNext	Imposta le condizioni di ritardo in setMultiDelay
value	string

LatestVersion

Prop	Type	Description	Since
version	string	Risultato del metodo getLatest	4.0.0
checksum	string		6
major	boolean
message	string
sessionKey	string
error	string
old	string
url	string
manifest	ManifestEntry[]		6.1

GetLatestOptions

Prop	Type	Description	Default	Since
channel	string	Il canale per il quale ottenere la versione più recente Il canale deve consentire ‘self_assign’ per questo	undefined	6.8.0

ChannelRes

Prop	Type	Description	Since
status	string	Stato attuale del canale impostato	4.7.0
error	string
message	string

SetChannelOptions

Prop	Type
channel	string
triggerAutoUpdate	boolean

UnsetChannelOptions

Prop	Type
triggerAutoUpdate	boolean

GetChannelRes

Prop	Type	Description	Since
channel	string	Stato attuale del canale ottenuto	4.8.0
error	string
message	string
status	string
allowSet	boolean

ListChannelsResult

Prop	Type	Description	Since
channels	ChannelInfo[]	Elenco dei canali disponibili	7.5.0

ChannelInfo

Prop	Type	Description	Since
id	string	L’ID del canale	7.5.0
name	string	Il nome del canale	7.5.0
public	boolean	Se questo è un canale pubblico	7.5.0
allow_self_set	boolean	Se i dispositivi possono autoassegnarsi a questo canale	7.5.0

SetCustomIdOptions

Prop	Type
customId	string

BuiltinVersion

Prop	Type
version	string

DeviceId

Prop	Type
deviceId	string

PluginVersion

Prop	Type
version	string

AutoUpdateEnabled

Prop	Type
enabled	boolean

PluginListenerHandle

Prop	Type
remove	() => Promise<void>

DownloadEvent

Prop	Type	Description	Since
percent	number	Stato attuale del download, tra 0 e 100.	4.0.0
bundle	BundleInfo

NoNeedEvent

Prop	Type	Description	Since
bundle	BundleInfo	Stato attuale del download, tra 0 e 100.	4.0.0

UpdateAvailableEvent

Prop	Type	Description	Since
bundle	BundleInfo	Stato attuale del download, tra 0 e 100.	4.0.0

DownloadCompleteEvent

Prop	Type	Description	Since
bundle	BundleInfo	Emesso quando è disponibile un nuovo aggiornamento.	4.0.0

MajorAvailableEvent

Prop	Type	Description	Since
version	string	Emesso quando è disponibile un nuovo bundle importante.	4.0.0

UpdateFailedEvent

Prop	Type	Description	Since
bundle	BundleInfo	Emesso quando un aggiornamento non è riuscito a installarsi.	4.0.0

DownloadFailedEvent

Prop	Type	Description	Since
version	string	Emesso quando il download non riesce.	4.0.0

AppReadyEvent

Prop	Type	Description	Since
bundle	BundleInfo	Emesso quando l’app è pronta per l’uso.	5.2.0
status	string

AutoUpdateAvailable

Prop	Type
available	boolean

SetShakeMenuOptions

Prop	Type
enabled	boolean

ShakeMenuEnabled

Prop	Type
enabled	boolean

Alias di Tipo

BundleStatus

pending: Il bundle è in attesa di essere IMPOSTATO come bundle successivo. downloading: Il bundle è in corso di download. success: Il bundle è stato scaricato ed è pronto per essere IMPOSTATO come bundle successivo. error: Il bundle non ha scaricato.

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

DelayUntilNext

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