Funzioni e impostazioni

Configurazione del plugin di aggiornamento

Vedi il Github Readme per ulteriori informazioni.

CapacitorUpdater può essere configurato con queste opzioni:

Proprietà	Tipo	Descrizione	Predefinito	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	Configura il numero di millisecondi che il plugin nativo dovrebbe attendere prima di considerare API timeout. Disponibile su Android, iOS e Electron.	20000 // (20 seconds)
autoDeleteFailed	boolean	Configura se il plugin dovrebbe utilizzare l'eliminazione automatica delle bundle fallite. Disponibile su Android, iOS e Electron.	true
autoDeletePrevious	boolean	Configura se il plugin dovrebbe utilizzare l'eliminazione automatica delle 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 di 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 automaticamente il prossimo bundle. Disponibile su Android, iOS e Electron.	”atBackground” // true is still accepted
resetWhenUpdate	boolean	Elimina automaticamente le bundle precedenti scaricate 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 degli aggiornamenti. 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 degli aggiornamenti. 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 l'encryption degli aggiornamenti in tempo reale 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 viene 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 auto: “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à a ritroso. Disponibile su Android, iOS e Electron.	false	5.1.0
autoSplashscreen	boolean	Gestisci automaticamente la rimozione dello schermo di benvenuto quando si utilizzano modalità di applicazione istantanea. Quando abilitato, il plugin nasconderà automaticamente 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(). Funziona solo quando autoUpdate è impostato su “atInstall”, “onLaunch” o “sempre”. I valori directUpdate legacy sono ancora supportati per la compatibilità a ritroso. Richiede l'installazione e la configurazione del plugin @capacitor/splash-screen con launchAutoHide: false. Richiede l'aggiornamento auto abilitato. Disponibile su Android e iOS.	false	7.6.0
periodCheckDelay	number	Configura il periodo di ritardo per la verifica degli aggiornamenti periodici. L'unità è in secondi. Non può essere inferiore a 600 secondi (10 minuti). Disponibile su Android, iOS e Electron.	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 dei dati statistici e l'URL del canale dal lato JavaScript.	false	5.4.0
defaultChannel	string	Imposta il canale predefinito per l'app nella configurazione. La casella è sensibile. 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 strada URL dopo un riavvio. AVVERTENZA: quando viene attivato un riavvio, ‘window.history’ verrà cancellato.	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à eseguita.	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

notifyAppReady()

notifyAppReady() => Promise<AppReadyResult>

Notifica l'aggiornatore Capacitor che il bundle corrente è attivo (verrà eseguito il rollback se non viene chiamata questa funzione ad ogni avvio dell'app)

Chiamare questa funzione per impostazione predefinita dovrebbe avvenire entro i primi 10 secondi dopo l'avvio dell'app, altrimenti verrà eseguito il rollback. Promise<AppReadyResult>

---

Modifica questo comportamento con {@link appReadyTimeout}

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

Sezione intitolata “setUpdateUrl(…)

Copia negli appunti	Imposta l'URL di aggiornamento per l'app, che verrà utilizzato per controllare le nuove versioni.	Parametro
options	UpdateUrl	Tipo di dati (Type)

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 l'invio delle statistiche.

Da: 5.4.0

---

setChannelUrl(…)

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

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

Parametro	Tipo	Descrizione
options	ChannelUrl	contiene l'indirizzo 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

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

Ritorna: Promise<BundleInfo>

---

next(…)

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

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

Parametro	Tipo	Descrizione
options	BundleId	Contiene l'ID del prossimo Bundle da impostare alla prossima avviatura dell'applicazione. Ritorna:}

set(…) Promise<BundleInfo>

---

Sezione intitolata “set(…)

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

Parametro

Tipo	Descrizione	Un {@link
options	BundleId	A {@link BundleIdOggetto contenente l'ID del bundle da impostare come attuale.

---

delete(…)

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

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

Param	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) __CAPGO_KEEP_0____CAPGO_KEEP_1__

---

elenco(…)

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

Ottieni tutti i bundle scaricati localmente nell'app

Parametro	Tipo	Descrizione
options	ListOptions	Le opzioni {@link ListOptions} per elencare i bundle

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 l'ultima volta.

Parametro	Tipo	Descrizione
options	ResetOptions	Contenente {@link ResetOptions.toLastSuccessful}, true ripristina al bundle predefinito e false sarà ripristinato al bundle caricato con successo l'ultima volta.

---

current()}

current() => Promise<CurrentBundleResult>

Restituisce 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 DelayCondition} contenente le condizioni che il Plugin utilizzerà per ritardare l'aggiornamento. Dopo che tutte le condizioni sono state soddisfatte, il processo di aggiornamento verrà eseguito di nuovo come di consueto, quindi l'aggiornamento verrà installato dopo un backgrounding o la chiusura dell'app. Per il kind, il valore dovrebbe essere una stringa di data in formato iso8601. Per ilkind, il valore dovrebbe essere un numero in millisecondi. Per il date kind, il valore dovrebbe essere il numero di versione. Per il background kind, il valore non viene utilizzato. La funzione presenta comportamento non coerente: l'opzione kill attiva l'aggiornamento dopo la prima chiusura e non dopo il successivo background come altre opzioni. Ciò verrà risolto in una futura versione maggiore. nativeVersion Param kill Tipo

Descrizione	Contenente il {@link MultiDelayConditions}	Setta un array {@link DelayCondition} contenente le condizioni che il Plugin utilizzerà per ritardare l'aggiornamento. Dopo che tutte le condizioni sono state soddisfatte, il processo di aggiornamento verrà eseguito di nuovo come di consueto, quindi l'aggiornamento verrà installato dopo un backgrounding o la chiusura dell'app. Per il
options	MultiDelayConditions	kind, il valore dovrebbe essere una stringa di data in formato iso8601. Per il kind, il valore dovrebbe essere un numero in millisecondi. Per il"kind, il valore dovrebbe essere il numero di versione. Per il"kind, il valore non viene utilizzato. La funzione presenta comportamento non coerente: l'opzione kill attiva l'aggiornamento dopo la prima chiusura e non dopo il successivo background come altre opzioni. Ciò verrà risolto in una futura versione maggiore.array di condizioni da impostare

Dal: 4.3.0

---

cancelDelay()

cancelDelay() => Promise<void>

Annulla una {@link Condizione di ritardo} per eseguire un aggiornamento immediatamente.

Dal: 4.0.0

---

getLatest(…)

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

Ottieni l'ultima bundle disponibile dall'URL di aggiornamento

Parametro	Tipo
options	GetLatestOptions

Restituisce: Promise<LatestVersion>

Da: 4.0.0

---

setChannel(…)

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

Imposta il canale per questo dispositivo. Il canale deve essere allow_device_self_set abilitato per far funzionare questo.

Note importanti:

• Non utilizzare questo metodo per impostare il canale al boot. Utilizzare il defaultChannel in your Capacitor config invece.
• Questo metodo è destinato all'uso dopo che l'app è pronta e l'utente ha interagito (ad esempio, accettando un programma beta).
• I canali pubblici non possono essere assegnati automaticamente. Se un canale è contrassegnato come public, chiamare setChannel() porterà a un errore. Per utilizzare un canale pubblico, chiamare unsetChannel() invece - il dispositivo si ricadrà automaticamente sul canale pubblico corrispondente.
• Usare listChannels() per scoprire quali canali sono disponibili e se consentono l'assegnazione automatica.

Parametro	Tipo	Descrizione
options	SetChannelOptions	È il canale {@link SetChannelOptions} da impostare

Ritorna: Promise<ChannelRes>

Dal: 4.7.0

---

unsetChannel(…)

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

Annulla l'override del canale per questo dispositivo. Dopo aver chiamato questo metodo, il dispositivo riceverà automaticamente aggiornamenti dal canale pubblico che corrisponde alle sue condizioni (piattaforma, tipo di dispositivo, tipo di build).

Questo è utile quando:

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

Param	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>

Elencare 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 pubblici o consentono l'assegnazione a sé stessi.

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 aggiornamenti da questo canale pubblico.
• allow_self_setSe true, questo è un canale assegnabile da parte dell'utentePuoi assegnare esplicitamente il dispositivo a questo canale utilizzando setChannel().

Ritorna: Promise<ListChannelsResult>

Dal: 7.5.0

---

setCustomId(…)

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

Assegna un ID personalizzato a questo dispositivo

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

Dal: 4.9.0

---

getBuiltinVersion()

getBuiltinVersion() => Promise<BuiltinVersion>

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

Restituisce: Promise<BuiltinVersion>

Dal: 5.2.0

---

getDeviceId()

getDeviceId() => Promise<DeviceId>

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

Ritorna: Promise<DeviceId>

---

getPluginVersion()

getPluginVersion() => Promise<PluginVersion>

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

Ritorna: 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'app. Si attiva una volta iniziato 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

Restituisce: Promise<PluginListenerHandle>

Dal momento in cui: 2.0.11

---

addListener('noNeedUpdate', …)

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

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

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

Restituisce: Promise<PluginListenerHandle>

Dal momento in cui: 4.0.0

---

addListener('updateAvailable', …)

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

Ascolta per l'evento di aggiornamento disponibile, utile quando desideri controllare ogni volta che l'app viene lanciata

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

Restituisce: Promise<PluginListenerHandle>

Dal: 4.0.0

---

addListener('downloadComplete', …)

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

Ascolta gli eventi downloadComplete.

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

Restituisce: Promise<PluginListenerHandle>

Dal: 4.0.0

---

addListener('aggiornamentoMaggiore', …)

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

Ascolta l'evento di aggiornamento maggiore nell'app, informa quando l'aggiornamento maggiore è bloccato impostando disableAutoUpdateBreaking

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

Restituisce: Promise<PluginListenerHandle>

Dal: 2.3.0

---

addListener('aggiornamentoFallito', …)

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

Ascolta l'evento di fallita 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>

Dal momento in cui: 2.3.0

---

addListener('downloadFailed', …)

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

Ascolta l'evento di fallita del download nell'app, ti informa quando un download di bundle ha fallito

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

Restituisce: Promise<PluginListenerHandle>

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

---

isAutoUpdateAvailable()

isAutoUpdateAvailable() => Promise<AutoUpdateAvailable>

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

Restituisce: Promise<AutoUpdateAvailable>

---

getNextBundle()

getNextBundle() => Promise<BundleInfo | null>

Restituisce null se non è impostato il prossimo bundle.

Restituisce: Promise<BundleInfo | null>

Dal: 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 di scuotimento

Dal momento in cui: 7.5.0

---

isShakeMenuEnabled()

isShakeMenuEnabled() => Promise<ShakeMenuEnabled>

Ottieni lo stato corrente del menu scuotimento

Restituisce: Promise<ShakeMenuEnabled>

Dal momento in cui: 7.5.0

---

Interfacce

AppReadyResult

Proprietà	Tipo
bundle	BundleInfo

BundleInfo

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

UpdateUrl

Prop	Tipo
url	string

StatsUrl

Prop	Tipo
url	string

CanaleUrl

Proprietà	Tipo
url	string

Opzioni di download

Questa URL e versione vengono utilizzate per scaricare il bundle dal server. Se si utilizza un backend, tutte le informazioni saranno fornite dal metodo getLatest. Se non si utilizza un backend, è necessario fornire l'URL e la versione del bundle. Le chiavi di sessione sono richieste se si è criptato il bundle con il comando CLI encrypt, dovrebbero essere ricevute come risultato del comando.

Proprietà	Tipo	Descrizione	Predefinito	Poiché
url	string	La 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	La 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

Manifesto di ingresso

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

ID del bundle

Proprietà	Tipo
id	string

Risultato della lista dei bundle

Proprietà	Tipo
bundles	BundleInfo[]

Opzioni della lista

Descrizione	Valore predefinito	Prop	Proprietà	Se
raw	boolean	Scegliere di restituire l'elenco del pacchetto crudo o il manifesto. Se vero, l'elenco cercherà di leggere il database interno al posto dei file sul disco.	false	6.14.0

ResetOptions

Proprietà	Tipo
toLastSuccessful	boolean

RisultatoBundleCorrente

Proprietà	Tipo
bundle	BundleInfo
native	string

CondizioniDiRitardoMultipla

Proprietà	Tipo
delayConditions	DelayCondition[]

Condizione di ritardo

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

Ultima versione

Proprietà	Tipo	Descrizione	Dal momento in cui
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 momento in cui
channel	string	Il canale da cui ottenere la versione più recente Il canale deve consentire ‘self_assign’ per far funzionare questo	undefined	6.8.0

ChannelRes

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

SetChannelOptions

Proprietà	Tipo
channel	string
triggerAutoUpdate	boolean

UnsetChannelOptions

Proprietà	Tipo
triggerAutoUpdate	boolean

OttieniCanaleRes

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

ListChannelsResult

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

CanaleInfo

Proprietà	Tipo	Descrizione	Dal
id	number	L'ID numerico del canale	7.5.0
name	string	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 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 name, not this numeric id.

, non questo numero

Sezione intitolata “SetCustomIdOptions”	Prop
customId	string

Tipo

Proprietà	Tipo
version	string

Id dispositivo

Proprietà	Tipo
deviceId	string

Versione plugin

Proprietà	Tipo
version	string

Aggiornamento automatico abilitato

Propetto	Tipo
enabled	boolean

PluginListenerHandle

Prop	Tipo
remove	() => Promise<void>

DownloadEvent

Prop	Tipo	Descrizione	Dal momento in cui
percent	number	Stato corrente del download, tra 0 e 100.	4.0.0
bundle	BundleInfo

NoNeedEvent

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

UpdateAvailableEvent

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

DownloadCompleteEvent

Prop	Tipo	Descrizione	Dal momento in cui
bundle	BundleInfo	Emetti quando è disponibile una nuova versione.	4.0.0

MajorAvailableEvent

Proprietà	Tipo	Descrizione	Dal
version	string	Emesso quando è disponibile una nuova versione principale del pacchetto.	4.0.0

UpdateFailedEvent

Proprietà	Tipo	Descrizione	Dal
bundle	BundleInfo	Emesso quando non riesce l'installazione di un aggiornamento.	4.0.0

DownloadFailedEvent

Prop	Tipo	Descrizione	Dal
version	string	Emette quando un download fallisce.	4.0.0

AppReadyEvent

Prop	Tipo	Descrizione	Dal momento in cui
bundle	BundleInfo	Emesso quando l'app è pronta per essere utilizzata.	5.2.0
status	string

Disponibile l'aggiornamento automatico

Proprietà	Tipo
available	boolean

Imposta opzioni del menu di scuotimento

Proprietà	Tipo
enabled	boolean

Menu di scuotimento abilitato

Proprietà	Tipo
enabled	boolean

Alias di tipo

Stato della raccolta

in attesa: La raccolta è in attesa di essere SET come la prossima raccolta. download in corso: La raccolta sta per essere scaricata. successo: La raccolta è stata scaricata e è pronta per essere SET come la prossima raccolta. errore: La raccolta non è riuscita a scaricarsi.

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

Attendere la prossima raccolta

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

Continua da Funzioni e impostazioni

Se stai utilizzando Funzioni e impostazioni per pianificare il dashboard e le API operazioni, connettilo con Utilizza @capgo/capacitor-aggiornatore per la capacità nativa in Utilizza @capgo/capacitor-aggiornatore, API Panoramica per i dettagli di implementazione in API Panoramica, 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.