Funzioni e impostazioni

Configurazione Plugin di Aggiornamento

Vedi il Github Readme per ulteriori informazioni.

CapacitorUpdater può essere configurato con queste opzioni:

Proprietà	Tipo	Description	Descrizione	Since
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	Configura il numero di millisecondi che il plugin nativo dovrebbe attendere prima di considerare API come timeout. Disponibile su Android, iOS e Electron.	20000 // (20 seconds)
autoDeleteFailed	boolean	Configura se il plugin dovrebbe utilizzare l'eliminazione automatica dei bundle falliti. Disponibile su Android, iOS e Electron.	true
autoDeletePrevious	boolean	Configura se il plugin dovrebbe utilizzare l'eliminazione automatica dei bundle 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, poi applica quando l'app si sposta in background - all'installazione: Applica immediatamente solo dopo un installazione fresca o aggiornamento dell'app nativa, altrimenti utilizza in background - al lancio: Applica immediatamente al lancio, altrimenti utilizza in background dopo il controllo di lancio - sempre: Applica immediatamente ogni volta che l'aggiornamento automatico viene eseguito - solo download: Controlla e scarica automaticamente, emette updateAvailable e non imposta mai il bundle successivo automaticamente. I modi di applicazione immediata (“all'installazione”, “al lancio”, “sempre”) dovrebbero essere caricati con —delta per evitare di rallentare l'esperienza dell'utente. Su Android e iOS questi modi 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 precedenti scaricati quando un bundle nativo più recente viene installato sul dispositivo. Disponibile su Android, iOS e Electron.	true
updateUrl	string	Configura l'URL / endpoint a cui sono inviate le richieste di 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 sono inviate le statistiche di aggiornamento. Disponibile su Android, iOS e Electron. Impostalo su "" per disabilitare la registrazione delle statistiche.	https://plugin.capgo.app/stats
publicKey	string	Configura la chiave pubblica per la crittografia end-to-end live update di versione 2. Disponibile su Android, iOS e Electron.	undefined	6.2.0
version	string	Configura la versione corrente dell'app. Questa verrà utilizzata per la prima richiesta di aggiornamento. Se non viene impostata, il plugin ottiene 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 autoUpdate: “atInstall”, “onLaunch” o “always”. Questa opzione rimane supportata per le app esistenti. L'aggiornamento istantaneo dovrebbe essere caricato con —delta per evitare di rallentare l'esperienza dell'utente. Su Android e iOS queste modalità richiedono autoSplashscreen: true e @capacitor/schermo di splash con launchAutoHide: false. - false: Mai eseguire 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à con le versioni precedenti. Disponibile su Android, iOS e Electron.	false	5.1.0
autoSplashscreen	boolean	Richiesto quando si utilizza i modi di applicazione istantanea (“atInstall”, “onLaunch” o “always”), incluso i valori di aggiornamento directUpdate deprecati. @capacitor/schermo di attesa deve essere installato e configurato con launchAutoHide: false. Quando abilitato, il plugin nasconde lo schermo di attesa dopo gli aggiornamenti sono stati applicati o quando non è necessario alcun aggiornamento. Ciò elimina la necessità di ascoltare manualmente gli eventi appReady e chiamare SplashScreen.hide(). Disponibile su Android e iOS.	false	7.6.0
periodCheckDelay	number	Configura il periodo di ritardo per il controllo di aggiornamento periodico. 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'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 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	Esegui la configurazione del plugin per mantenere la URL del percorso dopo un riavvio. AVVERTENZA: quando viene attivato un riavvio, ‘window.history’ verrà resettato.	false	6.8.0
disableJSLogging	boolean	Disabilita la registrazione JavaScript del plugin. se true, il plugin non registrerà nella console JavaScript. solo la registrazione nativa sarà effettuata	false	7.3.0
shakeMenu	boolean	Abilita il gesto di scuotimento per visualizzare il menu di aggiornamento ai fini 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 è funzionante (si verificherà un rollback se non viene chiamata questa funzione ad ogni avvio dell'app) Di default questa funzione dovrebbe essere chiamata nei primi 10 sec dopo l'avvio dell'app, altrimenti si verificherà un rollback. Modifica questo comportamento con {@link appReadyTimeout}

Ritorna: Promise<AppReadyResult>

---

setUpdateUrl(…)

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

Imposta l'URL dell'aggiornamento per l'app, verrà utilizzato per controllare gli aggiornamenti.

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

Da: 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.

Da: 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	Description
options	ChannelUrl	contiene l'URL da utilizzare per impostare il canale.

Since: 5.4.0

---

Da:

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

Estrarre un nuovo pacchetto dal URL fornito, dovrebbe essere un file zip, con file all'interno o con un id univoco all'interno con tutti i tuoi file

Param	Tipo	Descrizione
options	DownloadOptions	Le {@link} DownloadOptions} per l'estrazione 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.

Param	Tipo	Descrizione
options	BundleId	Contiene l'ID del prossimo Pacchetto da impostare alla prossima avviamento dell'applicazione. {@link PacchettoInfo.id}

Restituisce: Promise<BundleInfo>

---

set(…)

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

Imposta il pacchetto corrente e ricarica immediatamente l'applicazione.

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

---

delete(…)

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

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

Parametro	Tipo	Descrizione
options	BundleId	Un {@link} ID del pacchettooggetto contenente l'ID di un pacchetto da eliminare (nota, questo è l'ID del pacchetto, NON il nome della versione)

---

list(…)

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

Otteni tutti i pacchetti scaricati localmente nell'app

Parametro	Tipo	Descrizione
options	ListOptions	I {@link Opzioni di lista} per elencare i pacchetti

Restituisce: 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	Description
options	ResetOptions	Contenente {@link} ResetOptions.toLastSuccessful}, true resetta al bundle predefinito e false si resettarebbe alla bundle caricata con successo l'ultima volta.

---

current()

current() => Promise<CurrentBundleResult>

Ottieni la bundle corrente, se non sono impostate restituisce builtincurrentNative è la bundle originale installata sul dispositivo

Ritorna: Promise<CurrentBundleResult>

---

reload()

reload() => Promise<void>

Ricarica la vista

---

setMultiDelay(…)

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

Imposta un array di condizioni {@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 kind, il valore dovrebbe essere una stringa di data in formato iso8601. Per il 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	Description
options	MultiDelayConditions	Contiene l'array di condizioni {@link} MultiDelayConditions} di condizioni da impostare

Since: 4.3.0

---

cancelDelay()

cancelDelay() => Promise<void>

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

Since: 4.0.0

---

getLatest(…)

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

Ottieni l'ultima versione disponibile dal URL di aggiornamento

Parametro	Tipo
options	GetLatestOptions

Returns: Promise<LatestVersion>

Restituisce: 4.0.0

---

setChannel(…)

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

Imposta il canale locale gestito dal plugin per questo dispositivo. Il canale deve avere allow_device_self_set abilitato per funzionare.

setChannel() verifica il canale con il backend, quindi memorizza il canale selezionato localmente sul dispositivo. Non crea o aggiorna un dispositivo Override backend, quindi il dispositivo non apparirà come sovrascritto nel Capgo dashboard. Sono mostrati solo gli assegnamenti creati dal dashboard o dal Public API nella UI del dispositivo Override.

Nota importante:

• Non utilizzare questo metodo per impostare il canale al boot. Utilizzare invece il defaultChannel in il tuo Capacitor config invece.
• Questo metodo è destinato all'uso dopo che l'app è pronta e l'utente ha interagito (ad esempio, optando per un programma beta).
• Se un canale è contrassegnato come Se un canale è contrassegnato come public, calling setChannel() Ritornerà un errore. Per utilizzare un canale pubblico, chiamate unsetChannel() invece - il dispositivo si ricadrà automaticamente sul canale pubblico corrispondente.
• Use listChannels() scoprire quali canali sono disponibili e se consentono l'auto-assegnazione.

Param	Tipo	Descrizione
options	SetChannelOptions	Imposta le opzioni del canale SetChannelOptionscanale per impostare

unsetChannel(…) Promise<ChannelRes>

Since: 4.7.0

---

Copia negli appunti

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

Disabilita il canale locale gestito dal plugin per questo dispositivo. Ciò cancella solo il canale memorizzato localmente dal plugin. 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 Override dispositivo Dashboard o pubblico API esistente ancora vince; altrimenti il dispositivo può cadere indietro sul canale pubblico/di default per le sue condizioni (piattaforma, tipo dispositivo, tipo di costruzione).

Ciò è utile quando:

• Vuoi spostare un dispositivo sul tracciato di aggiornamento predefinito
• Vuoi utilizzare un canale pubblico (poiché i canali pubblici non possono essere assegnati automaticamente tramite setChannel())

Param	Tipo
options	UnsetChannelOptions

Since: 4.7.0

---

getChannel()

getChannel() => Promise<GetChannelRes>

Ottieni il canale per questo dispositivo

Ritorna: Promise<GetChannelRes>

Da: 4.8.0

---

listChannels()

listChannels() => Promise<ListChannelsResult>

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

Ogni canale nel risultato include:

• publicSe: true, questo è un canale predefinito. Non è possibile assegnarsi a esso utilizzando setChannel(). Invece, se si rimuove l'assegnazione del canale utilizzando unsetChannel(), il dispositivo riceverà automaticamente gli aggiornamenti da questo canale pubblico.
• allow_self_set: Se true, questo è un canale assegnabile da parte dell'utente. Puoi assegnare esplicitamente il dispositivo a questo canale utilizzando setChannel().

Returns: Promise<ListChannelsResult>

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

Get unique ID used to identify device (sent to auto update server)

Restituisce: Promise<DeviceId>

---

getPluginVersion()

getPluginVersion() => Promise<PluginVersion>

Restituisce la versione nativa del plugin Updater Capacitor (inviata al server di aggiornamento automatico)

Restituisce: Promise<PluginVersion>

---

isAutoUpdateEnabled()

isAutoUpdateEnabled() => Promise<AutoUpdateEnabled>

Get the state of auto update config.

Ritorna: Promise<AutoUpdateEnabled>

---

removeAllListeners()

removeAllListeners() => Promise<void>

Elimina tutti gli ascoltatori per questo plugin.

Dal: 1.0.0

---

AggiungiAscoltatore('download', …)

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

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

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

Restituisce: Promise<PluginListenerHandle>

Dal: 2.0.11

---

aggiungiAscoltatore('nessunaAggiornamentoNecessario', …)

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

Ascolta l'evento di non aggiornamento, utile quando desideri forzare la verifica ogni volta che l'app viene lanciata

Param	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 il controllo ogni volta che l'app viene avviata

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

Dal: Promise<PluginListenerHandle>

Since: 4.0.0

---

AggiungiAscoltatore('downloadComplete', …)

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

Ascolta gli eventi di download completato.

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

Restituisce: Promise<PluginListenerHandle>

Da: 4.0.0

---

Aggiungi ascoltatore (‘aggiornamento maggiore disponibile’, …)

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

Ascolta l'evento di aggiornamento maggiore nell'app, ti informa quando l'aggiornamento maggiore è bloccato impostando la disabilitazione dell'aggiornamento automatico con rotture.

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

Restituisce: Promise<PluginListenerHandle>

Da: 2.3.0

---

Aggiungi ascoltatore(‘aggiornamento fallito’, …)

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

Ascolta l'evento di fallimento dell'aggiornamento nell'App, ti informa quando l'aggiornamento non riesce ad installarsi alla prossima partenza dell'app

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

context Promise<PluginListenerHandle>

Tipo 2.3.0

---

addListener('downloadFailed', …)

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

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

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

Ritorna: Promise<PluginListenerHandle>

Da: 4.0.0

---

Aggiungi ascoltatore('appReloaded', …)

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

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

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

Ritorna: Promise<PluginListenerHandle>

Da: 4.3.0

---

Aggiungi ascoltatore (‘appReady’, …)

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

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

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

Returns: Promise<PluginListenerHandle>

Restituisce: 5.1.0

---

isAutoUpdateAvailable()

isAutoUpdateAvailable() => Promise<AutoUpdateAvailable>

Sezione intitolata “isAutoUpdateAvailable()”

Restituisce: Promise<AutoUpdateAvailable>

---

getNextBundle()

getNextBundle() => Promise<BundleInfo | null>

Ottieni il prossimo pacchetto che verrà utilizzato quando l'app si ricarica. Restituisce null se non è impostato un prossimo pacchetto.

Restituisce: Promise<BundleInfo | null>

Da: 6.8.0

---

setShakeMenu(…)

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

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

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

Dal: 7.5.0

---

isShakeMenuEnabled()

isShakeMenuEnabled() => Promise<ShakeMenuEnabled>

Restituisce lo stato corrente del menu a scuotimento

Ritorna: Promise<ShakeMenuEnabled>

Dal: 7.5.0

---

Interfacce

RisultatoAppPronto

Proprietà	Tipo
bundle	BundleInfo

InformazioniBundle

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

URLAggiornamento

Proprietà	Tipo
url	string

StatsUrl

Prop	Tipo
url	string

CanaleUrl

Prop	Tipo
url	string

Opzioni di download

Questa URL e versione vengono utilizzate per scaricare il bundle dal server. Se si utilizza il backend, tutte le informazioni saranno fornite dal metodo getLatest. Se non si utilizza il backend, è necessario fornire l'URL e la versione del bundle. Sono richiesti i chiavi di sessione se si è crittografato il bundle con il comando CLI encrypt, si dovrebbero riceverle come risultato del comando.

Prop	Tipo	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	La 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	Il checksum per l'aggiornamento, dovrebbe essere in sha256 e crittografato con la chiave privata se il bundle è crittografato	undefined	4.0.0
manifest	ManifestEntry[]	Il manifesto per Delta (manifesto) download multi-file	undefined	6.1.0

ManifestoEntry

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

__CAPGO_KEEP_0__

Proprietà	Tipo
id	string

__CAPGO_KEEP_0__

Proprietà	Tipo
bundles	BundleInfo[]

ListOptions

Proprietà	Tipo	Descrizione	Predefinito	Dal
raw	boolean	Se restituire la lista dei bundle in forma cruda o il manifesto. Se true, la lista cercherà di leggere il database interno al posto dei file sul disco.	false	6.14.0

ResetOptions

Prop	Tipo
toLastSuccessful	boolean

RisultatoBundleCorrente

Prop	Tipo
bundle	BundleInfo
native	string

MultiCondizioniDiRitardo

Proprietà	Tipo
delayConditions	DelayCondition[]

CondizioneDiRitardo

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

UltimaVersione

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

Opzioni per getLatest

Proprietà	Tipo	Descrizione	Default	Since
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	Since
status	string	Stato corrente del canale impostato	4.7.0
error	string
message	string

SetChannelOptions

Prop	Tipo
channel	string
triggerAutoUpdate	boolean

__CAPGO_KEEP_0__

Proprietà	Tipo
triggerAutoUpdate	boolean

GetChannelRes

Proprietà	Tipo	Descrizione	Dal
channel	string	Stato corrente del canale	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

InformazioniCanale

Proprietà	Tipo	Descrizione	Da
id	number	L'ID del canale numerico	7.5.0
name	string	Nome del canale	7.5.0
public	boolean	Se vero, questo è un canale predefinito/fallback. I dispositivi non possono assegnarsi automaticamente ai canali pubblici. Invece, quando un dispositivo elimina l'override del canale (utilizzando __CAPGO_KEEP_0__) unsetChannel()), riceverà automaticamente 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

Il comando del canale utilizza il canale name, non questo ID numerico id.

SetCustomIdOptions

Proprietà	Tipo
customId	string

__CAPGO_KEEP_0__

Proprietà	Tipo
version	string

ID Dispositivo

Proprietà	Tipo
deviceId	string

Versione Integrata

Proprietà	Tipo
version	string

__CAPGO_KEEP_0__

Proprietà	Tipo
enabled	boolean

Maniglia Ascoltatore Plugin

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

Evento Download

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

NoNeedEvent

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

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	Emitto quando è disponibile un aggiornamento nuovo.	4.0.0

MajorAvailableEvent

Proprietà	Tipo	Descrizione	Dal
version	string	Emitto quando è disponibile un nuovo bundle maggiore.	4.0.0

UpdateFailedEvent

Proprietà	Tipo	Descrizione	Da
bundle	BundleInfo	Emit when a update failed to install.	4.0.0

DownloadFailedEvent

Prop	Tipo	Descrizione	Da
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

AutoUpdateAvailable

Proprietà	Tipo
available	boolean

SetShakeMenuOptions

Proprietà	Tipo
enabled	boolean

ShakeMenuEnabled

Proprietà	Tipo
enabled	boolean

Alias di tipo

BundleStatus

in attesa: Il bundle è in attesa di essere SET Scarica il prossimo pacchetto. scaricando: Il pacchetto sta per essere scaricato. completato: Il pacchetto è stato scaricato e pronto per essere IMPOSTA come il prossimo pacchetto. errore: il pacchetto non è stato scaricato con successo.

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

DelayUntilNext

‘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 Panoramica per i dettagli 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 nei dispositivi.