Funzioni e impostazioni

Configurazione del Plugin di Aggiornamento

Vedi il Github Leggi il file Readme per ulteriori informazioni.

CapacitorUpdater può essere configurato con queste opzioni:

Proprietà	Tipo	Descrizione	Impostazione predefinita	Dal
appReadyTimeout	number	Configura il numero di millisecondi che il plugin nativo dovrebbe attendere prima di considerare un aggiornamento ‘fallito’. Disponibile su Android, iOS e Electron.	10000 // (10 seconds)
responseTimeout	number	Configure the number of milliseconds the native plugin should wait before considering API timeout. Available on Android, iOS, and Electron.	20000 // (20 seconds)
autoDeleteFailed	boolean	Configura se il plugin dovrebbe utilizzare l'eliminazione automatica dei pacchetti falliti. Disponibile su Android, iOS e Electron.	true
autoDeletePrevious	boolean	Configura se il plugin dovrebbe utilizzare l'eliminazione automatica dei pacchetti precedenti dopo un aggiornamento riuscito. Disponibile su Android, iOS e Electron.	true
autoUpdate	boolean | ‘off’ | ‘atBackground’ | ‘atInstall’ | ‘onLaunch’ | ‘always’ | ‘onlyDownload’	Configura come il plugin dovrebbe utilizzare l'aggiornamento automatico tramite un server di aggiornamento. true è lo stesso di “in background”; false è lo stesso di “disabilitato”. - disabilitato: Disabilita l'aggiornamento automatico - in background: Controlla e scarica automaticamente, quindi applica quando l'app si sposta in background - all'installazione: Applica immediatamente solo dopo un installazione fresca o un aggiornamento di app nativa, altrimenti utilizza in background - all'avvio: Applica immediatamente all'avvio, altrimenti utilizza in background dopo il controllo di avvio - sempre: Applica immediatamente ogni volta che l'aggiornamento automatico viene eseguito - solo download: Controlla e scarica automaticamente, emette updateAvailable e non imposta mai il prossimo bundle automaticamente. Le modalità di applicazione istantanea (“all'installazione”, “all'avvio”, “sempre”) dovrebbero essere caricati con —delta affinché l'aggiornamento non rallenti l'esperienza dell'utente. Su Android e iOS quelle modalità richiedono autoSplashscreen: true e @capacitor/splash-screen con launchAutoHide: false. Disponibile su Android, iOS e Electron.	“atBackground” // true is still accepted
resetWhenUpdate	boolean	Elimina automaticamente i bundle scaricati precedenti quando viene installato un bundle di app nativa più recente sul dispositivo. Disponibile su Android, iOS e Electron.	true
updateUrl	string	Configura l'URL / endpoint a cui vengono inviate le richieste di controllo dell'aggiornamento. Disponibile su Android, iOS e Electron.	https://plugin.capgo.app/updates
channelUrl	string	Configura l'URL / endpoint per le operazioni di canale. Disponibile su Android, iOS e Electron.	https://plugin.capgo.app/channel_self
statsUrl	string	Configura l'URL / endpoint a cui vengono inviate le statistiche di aggiornamento. Disponibile su Android, iOS e Electron. Imposta su "" per disabilitare la registrazione delle statistiche.	https://plugin.capgo.app/stats
publicKey	string	Configura la chiave pubblica per l'encryption in tempo reale fine a fine Versione 2. Disponibile su Android, iOS e Electron.	undefined	6.2.0
version	string	Configura la versione corrente dell'app. Questo verrà utilizzato per la prima richiesta di aggiornamento. Se non impostato, il plugin otterrà la versione dal nativo code. Disponibile su Android, iOS e Electron.	undefined	4.17.48
directUpdate	boolean | ‘always’ | ‘atInstall’ | ‘onLaunch’	Obsoleto. Utilizza invece le modalità di aggiornamento di stringa autoUpdate: “atInstall”, “onLaunch” o “always”. Questa opzione rimane supportata per le app esistenti. L'applicazione istantanea dovrebbe essere caricata con —delta per evitare di rallentare l'esperienza dell'utente. Su Android e iOS queste modalità richiedono autoSplashscreen: true e @capacitor/splash-screen con launchAutoHide: false. - false: Mai fare aggiornamenti diretti - atInstall: Lo stesso di autoUpdate: “atInstall” - onLaunch: Lo stesso di autoUpdate: “onLaunch” - sempre: Lo stesso di autoUpdate: “always” - true: Lo stesso di “sempre” per compatibilità di retroterra. Disponibile su Android, iOS e Electron.	false	5.1.0
autoSplashscreen	boolean	Richiesto quando si utilizzano modalità di applicazione istantanea (“atInstall”, “onLaunch” o “always”), inclusi i valori obsoleti di directUpdate. @capacitor/splash-screen deve essere installato e configurato con launchAutoHide: false. Quando abilitato, il plugin nasconde lo schermo di benvenuto dopo gli aggiornamenti sono stati applicati o quando non è necessario alcun aggiornamento. Ciò elimina la necessità di ascoltare manualmente gli eventi appReady e di chiamare SplashScreen.hide(). Disponibile su Android e iOS.	false	7.6.0
periodCheckDelay	number	Configura il periodo di attesa per il controllo delle aggiornamenti. L'unità è in secondi. Disponibile su Android, iOS e Electron. Non può essere inferiore a 600 secondi (10 minuti).	600 // (10 minutes)
localS3	boolean	Configura il CLI per utilizzare un server locale per le prove o un server di aggiornamento auto-hosted.	undefined	4.17.48
localHost	string	Configura il CLI per utilizzare un server locale per le prove o un server di aggiornamento auto-hosted.	undefined	4.17.48
localWebHost	string	Configura il CLI per utilizzare un server locale per le prove o un server di aggiornamento auto-hosted.	undefined	4.17.48
localSupa	string	Configura il CLI per utilizzare un server locale per le prove o un server di aggiornamento auto-hosted.	undefined	4.17.48
localSupaAnon	string	Configura il CLI per utilizzare un server locale per le prove.	undefined	4.17.48
localApi	string	Configura il CLI per utilizzare un server locale api per le prove.	undefined	6.3.3
localApiFiles	string	Configura il CLI per utilizzare un file locale api per le prove.	undefined	6.3.3
allowModifyUrl	boolean	Consenti al plugin di modificare dinamicamente l'URL di aggiornamento, l'URL di statistiche e l'URL di canale dal lato JavaScript.	false	5.4.0
defaultChannel	string	Imposta il canale predefinito per l'app nella configurazione. Sensitive al caso. Questa impostazione sovrascriverà il canale predefinito impostato nel cloud, ma rispetterà comunque le sovrascritture 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 la URL del percorso dopo un reload. AVVERTENZA: Quando viene attivato un reload, ‘window.history’ verrà resettato.	false	6.8.0
disableJSLogging	boolean	Disabilita la registrazione del logging JavaScript del plugin. Se true, il plugin non registrerà nella console JavaScript. Sarà fatto solo il log nativo.	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 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()
• Interfacce
• Alias di tipo

Metodi

notificaAppReady()

notifyAppReady() => Promise<AppReadyResult>

Notifica Capacitor Aggiornatore che il bundle corrente è in esecuzione (si verificherà un rollback se non viene chiamata questa funzione ad ogni avvio dell'app) Di default questa funzione dovrebbe essere chiamata entro i primi 10 sec 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'URL dell'aggiornamento per l'app, che verrà utilizzato per verificare gli aggiornamenti.

Parametro	Tipo	Descrizione
options	UpdateUrl	contiene l'URL da utilizzare per cercare aggiornamenti.

Dal momento in cui: 5.4.0

---

setStatsUrl(…)

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

Imposta l'URL delle statistiche per l'app, verrà utilizzato per inviare statistiche. Passando una stringa vuota disabilita la raccolta delle statistiche.

Parametro	Tipo	Descrizione
options	StatsUrl	contiene l'URL da utilizzare per inviare statistiche.

Dal momento in cui: 5.4.0

---

setChannelUrl(…)

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

Imposta l'URL del canale per l'app, verrà utilizzato per impostare il canale.

Parametro	Tipo	Descrizione
options	ChannelUrl	contiene l'URL da utilizzare per impostare il canale.

Dal: 5.4.0

---

download(…)

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

Scarica un nuovo bundle dal URL fornito, dovrebbe essere un file zip, con file all'interno o con un ID univoco all'interno con tutti i tuoi file

Parametri	Tipo	Descrizione
options	DownloadOptions	Il {@link} DownloadOptions} per il download di un nuovo pacchetto zip.

Ritorna: Promise<BundleInfo>

---

next(…)

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

Imposta il prossimo pacchetto da utilizzare quando l'app viene riavviata.

Parametri	Tipo	Descrizione
options	BundleId	Contiene l'ID del prossimo Bundle da impostare alla prossima avviatura dell'applicazione. {@link} BundleInfo.id}

Restituisce: Promise<BundleInfo>

---

set(…)

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

Imposta il bundle corrente e carica immediatamente l'applicazione.

Parametro	Tipo	Descrizione
options	BundleId	Un {@link} BundleId} oggetto contenente l'ID del pacchetto nuovo da impostare come attuale.

---

delete(…)

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

Elimina il pacchetto specificato dallo storage dell'app nativa. Utilizzare con {@link list} per ottenere gli ID dei pacchetti memorizzati.

Param	Tipo	Descrizione
options	BundleId	Un {@link} BundleIdoggetto 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 nell'app

Parametro	Tipo	Descrizione
options	ListOptions	Le {@link} Opzioni di lista per i bundleRitorna:

Le opzioni di lista per i bundle Promise<BundleListResult>

---

reset(…)

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

Ripristina l'applicazione al builtin bundle (quello inviato a Apple App Store / Google Play Store ) o al bundle caricato con successo più recente.

Parametro	Tipo	Descrizione
options	ResetOptions	Contenente {@link ResetOptions.toLastSuccessful}, true ripristina al bundle predefinito e false si ripristinerà al bundle caricato con successo più recente.

---

current()

current() => Promise<CurrentBundleResult>

Ottieni l'attuale bundle, se non sono impostati restituisce builtin. currentNative è il bundle originale installato sul dispositivo

Ritorna: Promise<CurrentBundleResult>

---

reload()

reload() => Promise<void>

Ricarica la vista

---

setMultiDelay(…)

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

Imposta un array {@link} Condizione di ritardo} contenente le condizioni che il Plugin utilizzerà per ritardare l'aggiornamento. Dopo che tutte le condizioni sono state soddisfatte, il processo di aggiornamento riprenderà come di consueto, quindi l'aggiornamento verrà installato dopo un backgrounding o la chiusura dell'app. Per il tipo date il valore dovrebbe essere una stringa di data in formato 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 presenta comportamento non coerente con l'opzione kill che attiva l'aggiornamento dopo la prima chiusura e non dopo il successivo background come altre opzioni. Questo verrà risolto in una futura versione maggiore.

Parametro	Tipo	Descrizione
options	MultiDelayConditions	Contenente il {@link} MultiDelayConditionsUn array di condizioni da impostare

Dal momento in cui: 4.3.0

---

cancelDelay()

cancelDelay() => Promise<void>

Annulla una {@link} DelayCondition} per eseguire un aggiornamento immediatamente.

Dal momento in cui: 4.0.0

---

getLatest(…)

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

Ottieni l'ultima versione disponibile dal URL di aggiornamento

Parametro	Tipo
options	GetLatestOptions

Ritorna: Promise<LatestVersion>

Dal: 4.0.0

---

setChannel(…)

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

Imposta il canale locale gestito dal plugin per questo dispositivo. Il canale deve essere allow_device_self_set verificato con il backend, quindi memorizzato localmente sul dispositivo. Non crea o aggiorna un dispositivo di sovrascrittura nel backend, quindi il dispositivo non apparirà come sovrascritto nel __CAPGO_KEEP_0__ dashboard. Sono mostrati solo gli assegnamenti creati dal dashboard o dal Public __CAPGO_KEEP_1__ nella UI di sovrascrittura del dispositivo.

setChannel() validates the channel with the backend, then stores the selected channel locally on the device. It does not create or update a backend Device Override, so the device will not appear as overridden in the Capgo dashboard. Only assignments created from the dashboard or the Public API are shown in the Device Override UI.

Nota importante:

• Non utilizzare questo metodo per impostare il canale al boot. Utilizzare invece il defaultChannel in your Capacitor config instead.
• I canali pubblici non possono essere assegnati automaticamente.
• Se un canale è contrassegnato come , chiamando public restituirà un errore. Per utilizzare un canale pubblico, chiamare setChannel() invece - il dispositivo si ricadrà automaticamente sul canale pubblico corrispondente. unsetChannel() Utilizzare
• per scoprire quali canali sono disponibili e se consentono l'assegnazione automatica. listChannels() Parametro

__CAPGO_KEEP_0__	Tipo	Descrizione
options	SetChannelOptions	Is il {@link SetChannelOptions} canale per impostare

Ritorna: Promise<ChannelRes>

Da: 4.7.0

---

unsetChannel(…)

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

Annulla il canale locale gestito dal plugin per questo dispositivo. Questo cancella solo il canale memorizzato localmente da setChannel(); non cancella i record di Override dispositivo Dashboard o pubblico API

Dopo aver chiamato questo metodo, la precedenza normale del canale si applica: un Dashboard o un dispositivo pubblico API Override esistente ancora vince; altrimenti il dispositivo può cadere indietro sul canale pubblico/di default per le sue condizioni (piattaforma, tipo di dispositivo, tipo di costruzione).

Questo è utile quando:

• Vuoi spostare un dispositivo di nuovo sulla pista di aggiornamento predefinita
• Vuoi utilizzare un canale pubblico (poiché i canali pubblici non possono essere assegnati automaticamente tramite setChannel())

Param	Tipo
options	UnsetChannelOptions

Da: 4.7.0

---

getChannel()

getChannel() => Promise<GetChannelRes>

Ottieni il canale per questo dispositivo

Restituisce: Promise<GetChannelRes>

Dal momento in cui: 4.8.0

---

listChannels()

listChannels() => Promise<ListChannelsResult>

Elencare tutti i canali disponibili per questo dispositivo. Restituisce i canali che sono compatibili con l'ambiente corrente del dispositivo (piattaforma, emulatore/dispositivo reale, build di sviluppo/produttivo) e sono pubblici o consentono l'assegnazione auto.

Ogni canale nella risposta include:

• publicSe: true, questo è un canale predefinitoNon puoi assegnarti a questo canale utilizzando setChannel()Invece, se rimuovi l'assegnazione del tuo canale utilizzando unsetChannel()Il dispositivo riceverà automaticamente gli aggiornamenti da questo canale pubblico.
• allow_self_set: Se true, questo è un canale assegnabile da parte del dispositivo. Puoi assegnare esplicitamente il dispositivo a questo canale utilizzando setChannel().

Ritorna: Promise<ListChannelsResult>

Dal: 7.5.0

---

setCustomId(…)

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

Imposta un ID personalizzato per questo dispositivo

Parametro	Tipo	Descrizione
options	SetCustomIdOptions	è il {@link} SetCustomIdOptions} per impostare l'ID personalizzato

Da: 4.9.0

---

getBuiltinVersion()

getBuiltinVersion() => Promise<BuiltinVersion>

Ottieni la versione dell'app nativa o la versione integrata se impostata nella configurazione

Restituisce: Promise<BuiltinVersion>

Da: 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 nativa del plugin Updater Capacitor (inviata al server di aggiornamento automatico)

Restituisce: Promise<PluginVersion>

---

isAutoUpdateEnabled()

isAutoUpdateEnabled() => Promise<AutoUpdateEnabled>

Ottieni lo stato della configurazione di aggiornamento automatico.

Ritorna: Promise<AutoUpdateEnabled>

---

removeAllListeners()

removeAllListeners() => Promise<void>

Elimina tutti gli ascoltatori per questo plugin.

Dal: 1.0.0

---

addListener(‘download’, …)

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

Ascolta l'evento di download del pacchetto nell'applicazione. Si attiva una volta iniziato il download, durante il download e quando terminato. Questo restituirà tutti i percentuali di download durante il download

Parametro	Tipo
eventName	‘download’
listenerFunc	(state: DownloadEvent) => void

Restituisce: Promise<PluginListenerHandle>

Dal: 2.0.11

---

addListener('noNeedUpdate', …)

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

Ascolta l'evento di non aggiornamento necessario, utile quando desideri eseguire il controllo ogni volta che l'applicazione viene avviata

Parametro	Tipo
eventName	‘noNeedUpdate’
listenerFunc	(state: NoNeedEvent) => void

Restituisce: Promise<PluginListenerHandle>

Dal: 4.0.0

---

addListener('updateAvailable', …)

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

Ascolta l'evento di aggiornamento disponibile, utile quando desideri eseguire una verifica ogni volta che l'applicazione viene avviata

Parametro	Tipo
eventName	‘updateAvailable’
listenerFunc	(state: UpdateAvailableEvent) => void

Restituisce: Promise<PluginListenerHandle>

Dal: 4.0.0

---

addListener(‘download completo’, …)

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

Ascolta gli eventi di download completo.

Parametro	Tipo
eventName	‘downloadComplete’
listenerFunc	(state: DownloadCompleteEvent) => void

Restituisce: Promise<PluginListenerHandle>

Da: 4.0.0

---

addListener('aggiornamentoMaggioreDisponibile', …)

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

Ascolta per l'evento di aggiornamento maggiore nell'applicazione, ti avvisa quando l'aggiornamento maggiore è bloccato impostando disableAutoUpdateBreaking

Parametro	Tipo
eventName	‘majorAvailable’
listenerFunc	(state: MajorAvailableEvent) => void

Restituisce: Promise<PluginListenerHandle>

Da: 2.3.0

---

addListener('aggiornamentoFallito', …)

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

Ascolta l'evento di fallimento dell'aggiornamento nell'App, ti informa quando l'aggiornamento non è stato installato correttamente alla prossima partenza dell'app

Parametro	Tipo
eventName	‘updateFailed’
listenerFunc	(state: UpdateFailedEvent) => void

Restituisce: Promise<PluginListenerHandle>

Dal: 2.3.0

---

addListener(‘downloadFallito’, …)

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

Ascolta l'evento di fallimento del download nell'App, ti informa quando un download di pacchetto ha avuto esito negativo

Parametro	Tipo
eventName	‘downloadFailed’
listenerFunc	(state: DownloadFailedEvent) => void

Restituisce: Promise<PluginListenerHandle>

Dal: 4.0.0

---

addListener(‘appReloaded’, …)

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

Ascolta l'evento di ricarica dell'App, ti informa quando la ricarica è avvenuta

Parametro	Tipo
eventName	‘appReloaded’
listenerFunc	() => void

Restituisce: Promise<PluginListenerHandle>

Dal: 4.3.0

---

addListener(‘appReady’, …)

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

Ascolta l'evento di app pronto nell'App, ti informa quando l'app è pronta all'uso

Parametro	Tipo
eventName	‘appReady’
listenerFunc	(state: AppReadyEvent) => void

Restituisce: Promise<PluginListenerHandle>

Da: 5.1.0

---

isAutoUpdateAvailable()

isAutoUpdateAvailable() => Promise<AutoUpdateAvailable>

Ottenere se l'aggiornamento automatico è disponibile (non disabilitato da serverUrl).

Restituisce: Promise<AutoUpdateAvailable>

---

Esegui il prossimo bundle()

getNextBundle() => Promise<BundleInfo | null>

Esegui il prossimo bundle che verrà utilizzato quando l'app si ricaricherà. Restituisce null se non è impostato un prossimo bundle.

Restituisce: Promise<BundleInfo | null>

Da: 6.8.0

---

setShakeMenu(…)

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

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

Parametro	Tipo	Descrizione
options	SetShakeMenuOptions	Contiene booleano abilitato per abilitare o disabilitare il menu di scuotimento

Dal: 7.5.0

---

isShakeMenuEnabled()

isShakeMenuEnabled() => Promise<ShakeMenuEnabled>

Ottieni lo stato corrente del menu di scuotimento

Ritorna: Promise<ShakeMenuEnabled>

Dal: 7.5.0

---

Interfacce

AppReadyResult

Proprietà	Tipo
bundle	BundleInfo

Informazioni sull'aggiornamento

Proprietà	Tipo
id	string
version	string
downloaded	string
checksum	string
status	BundleStatus

URL dell'aggiornamento

Proprietà	Tipo
url	string

URL delle statistiche

Proprietà	Tipo
url	string

UrlCanale

Proprietà	Tipo
url	string

OpzioniDownload

This URL and versions are used to download the bundle from the server, If you use backend all information will be given by the method getLatest. If you don’t use backend, you need to provide the URL and version of the bundle. SessionKey are required if you encrypted the bundle with the CLI command encrypt, you should receive them as result of the command.

Tipo	OpzioniDownload	Descrizione	Predefinito	Dal
url	string	L'URL del file zip del bundle (ad esempio: dist.zip) da scaricare. (Questo può essere qualsiasi URL. Ad esempio: Amazon S3, un tag GitHub, qualsiasi altro posto in cui hai ospitato il tuo bundle.)
version	string	L'identificativo della versione code/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	La firma di crittografia per l'aggiornamento, dovrebbe essere in sha256 e crittografata con la chiave privata se il bundle è crittografato	undefined	4.0.0
manifest	ManifestEntry[]	Il manifesto per le download multi-file Delta (manifesto)	undefined	6.1.0

Manifesto di ingresso

Proprietà	Tipo
file_name	string | null
file_hash	string | null
download_url	string | null

ID del pacchetto

Proprietà	Tipo
id	string

Risultato della lista del pacchetto

Proprietà	Tipo
bundles	BundleInfo[]

Opzioni della lista

Proprietà	Tipo	Descrizione	Impostazione predefinita	Dal
raw	boolean	Se true, il elenco dei bundle cercherà di leggere la database interna anziché i file sul disco.	false	6.14.0

ResetOptions

Proprietà	Tipo
toLastSuccessful	boolean

RisultatoBundleAttuale

Proprietà	Tipo
bundle	BundleInfo
native	string

MultiDelayConditions

Proprietà	Tipo
delayConditions	DelayCondition[]

Condizione di ritardo

Proprietà	Tipo	Descrizione
kind	DelayUntilNext	Configura le condizioni di ritardo in setMultiDelay
value	string

Versione più recente

Proprietà	Tipo	Descrizione	Da
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

Proprietà	Tipo	Descrizione	Predefinito	Da
channel	string	Il canale per ottenere la versione più recente per Il canale deve consentire ‘self_assign’ per far funzionare questo	undefined	6.8.0

ChannelRes

Prop	Tipo	Descrizione	Dal
status	string	Stato attuale del canale impostato	4.7.0
error	string
message	string

SetChannelOptions

Prop	Tipo
channel	string
triggerAutoUpdate	boolean

ImpostazioniCanaleDisabilitate

Proprietà	Tipo
triggerAutoUpdate	boolean

GetChannelRes

Proprietà	Tipo	Descrizione	Dal
channel	string	Stato corrente di get channel	4.8.0
error	string
message	string
status	string
allowSet	boolean

RisultatiCanali

Proprietà	Tipo	Descrizione	Dal
channels	ChannelInfo[]	Elenco dei canali disponibili	7.5.0

Informazioni sul canale

Proprietà	Tipo	Descrizione	Dal
id	number	L'ID del canale numerico	7.5.0
name	string	Il nome del canale	7.5.0
public	boolean	Se vero, si tratta di un canale predefinito/fallback. Gli dispositivi non possono assegnarsi automaticamente a canali pubblici. Invece, quando un dispositivo elimina l'override del canale (utilizzando unsetChannel()), riceverà automaticamente gli aggiornamenti dal canale pubblico corrispondente.	7.5.0
allow_self_set	boolean	Se vero, gli dispositivi possono assegnarsi esplicitamente a questo canale utilizzando setChannel() . Ciò è tipicamente utilizzato per test di beta, test A/B o tracce di aggiornamento a richiesta.	7.5.0

I comandi del canale utilizzano il canale namee non questo ID numerico id.

Impostazioni per l'ID personalizzato

Proprietà	Tipo
customId	string

Version di sistema integrata

Proprietà	Tipo
version	string

Id dispositivo

Proprietà	Tipo
deviceId	string

Versione del plugin

Proprietà	Tipo
version	string

AutoUpdateAbilitato

Proprietà	Tipo
enabled	boolean

Handle dell'ascoltatore del plugin

Proprietà	Tipo
remove	() => Promise<void>

Evento di download

Proprietà	Tipo	Descrizione	Da
percent	number	Stato corrente del download, tra 0 e 100.	4.0.0
bundle	BundleInfo

NoNeedEvent

Proprietà	Tipo	Descrizione	Da
bundle	BundleInfo	Stato corrente del download, tra 0 e 100.	4.0.0

Sottosezione intitolata “UpdateAvailableEvent”

Proprietà	Tipo	Descrizione	Dal
bundle	BundleInfo	Stato corrente del download, tra 0 e 100.	4.0.0

DownloadCompleteEvent

Proprietà	Tipo	Descrizione	Dal
bundle	BundleInfo	Emesso quando è disponibile un nuovo aggiornamento.	4.0.0

MajorAvailableEvent

Prop	Tipo	Descrizione	Dal
version	string	Emit quando è disponibile una nuova versione maggiore del pacchetto.	4.0.0

UpdateFailedEvent

Prop	Tipo	Descrizione	Dal momento in cui
bundle	BundleInfo	Emitto quando un aggiornamento non riesce ad installarsi.	4.0.0

DownloadFailedEvent

Proprietà	Tipo	Descrizione	Dal momento in cui
version	string	Emitto quando un download fallisce.	4.0.0

AppReadyEvent

Proprietà	Tipo	Descrizione	Dal
bundle	BundleInfo	Emesso quando l'app è pronta per essere utilizzata.	5.2.0
status	string

Aggiornamento automatico disponibile

Proprietà	Tipo
available	boolean

Imposta opzioni del menu scuotimento

Proprietà	Tipo
enabled	boolean

AbilitaMenuShake

Proprietà	Tipo
enabled	boolean

Alias di tipo

StatoBundle

in attesa: Il bundle è in attesa di essere IMPOSTATO scaricato: Il bundle sta per essere scaricato. IMPOSTATO come il prossimo pacchetto. errore: Il pacchetto non è stato scaricato con successo.

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

Ritardi fino al prossimo

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

Continua da Funzioni e impostazioni

Se stai utilizzando Funzioni e impostazioni per pianificare dashboard e API operazioni, connettilo con Utilizzando @capgo/capacitor-aggiornatore per la capacità nativa in Utilizzando @capgo/capacitor-aggiornatore, API Overview per il dettaglio di implementazione in API Overview, Introduzione per i dettagli di implementazione in Introduzione API Chiavi per i dettagli di implementazione in API Chiavi, e Dispositivi per i dettagli di implementazione in Dispositivi.