Funzioni e impostazioni

Configurazione Plugin di Aggiornamento

Vedi il Github Leggi il __CAPGO_KEEP_0__ Per ulteriori informazioni.

CapacitorUpdater può essere configurato con queste opzioni:

Proprietà	Tipo	Descrizione	Predefinito	Da
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 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, quindi applica quando l'app si sposta in background - all'installazione: Applica immediatamente solo dopo un'installazione fresca o un 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 - scarica solo: Controlla e scarica automaticamente, emette updateAvailable e non imposta mai il bundle successivo automaticamente. Disponibile su Android, iOS e Electron.	”atBackground” // true is still accepted
resetWhenUpdate	boolean	Elimina automaticamente i bundle precedentemente scaricati 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 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. Impostalo su "" per disabilitare la registrazione delle statistiche.	https://plugin.capgo.app/stats
publicKey	string	Configura la chiave pubblica per la crittografia in tempo reale degli aggiornamenti 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. - 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	Gestisci automaticamente l'occultamento dello schermo di benvenuto quando si utilizzano modalità di applicazione istantanea. Abilitato, il plugin nasconderà automaticamente lo schermo di benvenuto dopo l'applicazione degli aggiornamenti o quando non è necessario alcun aggiornamento. Ciò elimina la necessità di ascoltare manualmente gli eventi appReady e di chiamare SplashScreen.hide(). Funziona solo quando autoUpdate è impostato su “atInstall”, “onLaunch” o “always”. I valori directUpdate legacy sono ancora supportati per la compatibilità con i sistemi precedenti. Richiede l'installazione e la configurazione del plugin @capacitor/splash-screen con launchAutoHide impostato su false. Richiede l'aggiornamento automatico abilitato. Disponibile su Android e iOS.	false	7.6.0
periodCheckDelay	number	Configura il periodo di ritardo per il controllo degli aggiornamenti periodici. 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. 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	Configura il plugin per mantenere la URL del percorso dopo un riavvio. AVVISO: 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. Sarà fatto solo il registro nativo.	false	7.3.0
shakeMenu	boolean	Abilita il gesto di scuotimento per visualizzare 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>

Avvisa Capacitor Aggiornatore che il bundle corrente è in esecuzione (si verificherà un rollback se non viene chiamato questo metodo con ogni avvio dell'app) Di default questo metodo dovrebbe essere chiamato entro i 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, che verrà utilizzato per controllare gli aggiornamenti.

Parametri	Tipo	Descrizione
options	UpdateUrl	contiene l'URL da utilizzare per controllare le nuove versioni.

Da: 5.4.0

---

setStatsUrl(…)

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

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

Parametri	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 momento in cui: 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

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

Restituisce: 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 avviatura dell'app. {@link} PacchettoInfo.id}

Restituisce: Promise<BundleInfo>

---

set(…)

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

Imposta il pacchetto corrente e riavvia immediatamente l'app.

Elenca	Tipo	Descrizione
options	BundleId	Elenca BundleId} object containing the new bundle id to set as current.

---

ID del bundle

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

Elimina il bundle specificato dallo storage dell'app nativa. Utilizza con {@link list} per ottenere gli ID dei Bundle memorizzati.

Elenca	Tipo	Descrizione
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>

Ottenere tutti i bundle scaricati localmente nell'app

Parametro	Tipo	Descrizione
options	ListOptions	L'oggetto {@link Opzioni della lista} per elencare i pacchetti

Restituisce: Promise<BundleListResult>

---

reset(…)

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

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

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

---

current()

current() => Promise<CurrentBundleResult>

Ottieni il bundle corrente, 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} date Imposta un array di condizioni di ritardo 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 ‘kind’, il valore dovrebbe essere una stringa di data in formato ISO 8601. Per il tipo ‘kind’, il valore dovrebbe essere un numero in millisecondi. Per il tipo ‘kind’, il valore dovrebbe essere il numero di versione. Per il tipo ‘kind’, 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 la successiva background come altre opzioni. Questo verrà risolto in una futura versione maggiore. background Parametro nativeVersion Ricarica la vista kill setMultiDelay(…)

Sottosezione intitolata “setMultiDelay(…)”	Tipo	Descrizione
options	MultiDelayConditions	Contenente l'array di condizioni {@link MultiDelayConditions} per impostare

Dal: 4.3.0

---

cancelDelay()

cancelDelay() => Promise<void>

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

Dal momento in cui: 4.0.0

---

getLatest(…)

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

Ottieni il bundle più recente disponibile dall'URL di aggiornamento

Parametro	Tipo
options	GetLatestOptions

Restituisce: Promise<LatestVersion>

Dal momento in cui: 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 abilitato per far funzionare questo.

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

Note importanti:

• Non utilizzare questo metodo per impostare il canale al boot. Utilizza invece il defaultChannel in configurazione Capacitor del tuo progetto.
• Questo metodo è destinato all'uso dopo che l'app è pronta e l'utente ha interagito (ad esempio, optando per un programma beta).
• Il canale pubblico non può essere assegnato automaticamente. Se un canale è contrassegnato come publicchiamando setChannel() ritorna un errore. Per utilizzare un canale pubblico, chiama unsetChannel() che il dispositivo si auto-caschi automaticamente sul canale pubblico corrispondente.
• Usa listChannels() per scoprire quali canali sono disponibili e se consentono l'assegnazione automatica.

Param	Tipo	Descrizione
options	SetChannelOptions	È il {@link} impostare il canale di Restituisce:

Da: Promise<ChannelRes>

unsetChannel(…) 4.7.0

---

Sottosezione intitolata “unsetChannel(…)”

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

Disabilita il canale locale gestito dal plugin per questo dispositivo. Questo cancella solo il canale memorizzato localmente da setChannel()non cancella i record di sovrascrittura del dispositivo per Dashboard o Public API

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

Questo è utile quando:

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

Parametro	Tipo
options	UnsetChannelOptions

Da: 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 tutti i canali disponibili per questo dispositivo. Ritorna i canali che sono 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 puoi assegnarti a te stesso 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 te. Puoi assegnare esplicitamente il dispositivo a questo canale utilizzando setChannel().

Ritorna: Promise<ListChannelsResult>

Dal momento che: 7.5.0

---

setCustomId(…)

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

Imposta un ID personalizzato per questo dispositivo

Param	Tipo	Descrizione
options	SetCustomIdOptions	è l'opzione {@link} SetCustomIdOptions} l'ID personalizzato da impostare

Dal: 4.9.0

---

getBuiltinVersion()

getBuiltinVersion() => Promise<BuiltinVersion>

Ottieni la versione dell'applicazione 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>

Restituisce lo stato della configurazione dell'aggiornamento automatico.

Ritorna: Promise<AutoUpdateEnabled>

---

removeAllListeners()

removeAllListeners() => Promise<void>

Dal:

addListener(‘download’, …) 1.0.0

---

Sezione intitolata “addListener(‘download’, …)”

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

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

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

Ritorna: 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 la verifica ogni volta che l'app viene avviata

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

Restituisce: Promise<PluginListenerHandle>

Da: 4.0.0

---

addListener(‘aggiornamentoDisponibile’, …)

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'applicazione viene avviata

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

Restituisce: Promise<PluginListenerHandle>

Da: 4.0.0

---

addListener(‘downloadCompleto’, …)

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

Ascolta gli eventi di download completato.

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

Ritorna: Promise<PluginListenerHandle>

Dal: 4.0.0

---

addListener(‘majorAvailable’, …)

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

Ascolta l'evento di aggiornamento maggiore nell'applicazione, ti informa 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 riesce ad installarsi alla prossima partenza dell'app

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

Restituisce: Promise<PluginListenerHandle>

Da: 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 bundle ha avuto esito negativo

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

Ritorna: Promise<PluginListenerHandle>

Da: 4.0.0

---

addListener(‘appReloaded’, …)

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

Ascolta l'evento di reload nell'App, ti informa quando il reload è avvenuto

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

Restituisce: Promise<PluginListenerHandle>

Dal momento in cui: 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>

Dal momento in cui: 5.1.0

---

isAutoUpdateAvailable()

isAutoUpdateAvailable() => Promise<AutoUpdateAvailable>

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

Ritorna: Promise<AutoUpdateAvailable>

---

getNextBundle()

getNextBundle() => Promise<BundleInfo | null>

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

Ritorna: Promise<BundleInfo | null>

Da: 6.8.0

---

setShakeMenu(…)

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

Abilita o disabilita il menu a scuote per scopi di debug/test

Param	Tipo	Descrizione
options	SetShakeMenuOptions	Contiene booleano abilitato per abilitare o disabilitare il menu a scuote

Da: 7.5.0

---

isShakeMenuEnabled()

isShakeMenuEnabled() => Promise<ShakeMenuEnabled>

Ottieni lo stato corrente del menu a scuote

Restituisce: Promise<ShakeMenuEnabled>

Da: 7.5.0

---

Interfacce

AppReadyResult

Proprietà	Tipo
bundle	BundleInfo

Informazioni Bundle

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

URL Aggiornamento

Proprietà	Tipo
url	string

UrlStats

Proprietà	Tipo
url	string

UrlCanale

Proprietà	Tipo
url	string

Opzioni di download

Questa URL e versioni sono 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 SessionKey se si è criptato il bundle con il comando CLI encrypt, si dovrebbero ricevere come risultato del comando.

Proprietà	Tipo	Descrizione	Predefinito	Dal
url	string	L'URL del file zip del bundle (ad es. dist.zip) da scaricare. (Questo può essere qualsiasi URL. Ad esempio: Amazon S3, un GitHub tag, qualsiasi altro posto in cui si è ospitato il proprio bundle.)
version	string	La versione code/nome di questo bundle/versione
sessionKey	string	La chiave di sessione per l'aggiornamento, quando il bundle è criptato con una chiave di sessione	undefined	4.0.0
checksum	string	Il checksum per l'aggiornamento, che dovrebbe essere in sha256 e criptato con la chiave privata se il bundle è criptato	undefined	4.0.0
manifest	ManifestEntry[]	Il manifesto per Delta (manifesto) download multi-file	undefined	6.1.0

Manifesto di ingresso

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

IdBundle

Proprietà	Tipo
id	string

Risultato della lista Bundle

Proprietà	Tipo
bundles	BundleInfo[]

Opzioni della lista

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

Proprietà	Tipo
toLastSuccessful	boolean

Risultato Bundle corrente

Proprietà	Tipo
bundle	BundleInfo
native	string

CondizioniDiRitardoMultipla

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

GetLatestOptions

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

ChannelRes

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

SetChannelOptions

Proprietà	Tipo
channel	string
triggerAutoUpdate	boolean

Annulla le opzioni del canale

Proprietà	Tipo
triggerAutoUpdate	boolean

Ottieni le informazioni sul canale

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

ListChannelsResult

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

ChannelInfo

Proprietà	Tipo	Descrizione	Dal
id	number	L'ID numerico del canale	7.5.0
name	string	Il nome del canale	7.5.0
public	boolean	Se vero, questo è 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 aggiornamenti dal canale pubblico corrispondente.	7.5.0
allow_self_set	boolean	Se vero, gli dispositivi possono assegnarsi esplicitamente a questo canale utilizzando setChannel()Questo è 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.

Imposta le opzioni per l'ID personalizzato

Proprietà	Tipo
customId	string

Versione predefinita

Proprietà	Tipo
version	string

ID dispositivo

Proprietà	Tipo
deviceId	string

Versione plugin

Proprietà	Tipo
version	string

Aggiornamento automatico abilitato

Proprietà	Tipo
enabled	boolean

Handle dell'ascoltatore del plugin

Tipo	Evento di download
remove	() => Promise<void>

Eventi di 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

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

DownloadCompleteEvent

Prop	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	Dal
bundle	BundleInfo	Emitto quando un aggiornamento non riesce ad installarsi.	4.0.0

DownloadFailedEvent

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

AppReadyEvent

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

AutoUpdateAvailable

Proprietà	Tipo
available	boolean

ImpostaShakeMenuOptions

Proprietà	Tipo
enabled	boolean

ShakeMenuAbilitato

Proprietà	Tipo
enabled	boolean

Alias di tipo

Sezione intitolata “Stato del bundle”

__CAPGO_KEEP_0__ IMPOSTA impostalo come il prossimo pacchetto. download in corso: il pacchetto sta per essere scaricato. successo: il pacchetto è stato scaricato e è pronto per essere

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

IMPOSTA

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

errore: il pacchetto non è stato scaricato.

Sezione intitolata “Ritardi fino al prossimo” Continua da Funzioni e impostazioni to plan dashboard and API operations, connect it with Se stai utilizzando Funzioni e impostazioni per pianificare dashboard e capgo operazioni, connettilo con Funzioni e impostazioni @capgo/capacitor-aggiornatore per la capacità nativa in Utilizzo di @capgo/capacitor-aggiornatore, API Panoramica per il dettaglio di implementazione in API Panoramica, Introduzione per il dettaglio di implementazione in Introduzione, API Chiavi per il dettaglio di implementazione in API Chiavi, e Dispositivi per il dettaglio di implementazione in Dispositivi.