Funzioni e impostazioni

Configurazione Plugin Aggiornatore

Vedi il Github Leggi il Readme per ulteriori informazioni.

CapacitorUpdater può essere configurato con queste opzioni:

Proprietà	Tipo	Descrizione	Predefinito	Dal momento in cui
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 il timeout API. 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	Configura se il plugin dovrebbe utilizzare l'aggiornamento automatico tramite un server di aggiornamento. Disponibile su Android, iOS e Electron.	true
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. Imposta 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. Questo verrà utilizzato per la prima richiesta di aggiornamento. Se non viene impostato, il plugin otterrà la versione dal code nativo. Disponibile su Android, iOS e Electron.	undefined	4.17.48
directUpdate	boolean | ‘always’ | ‘atInstall’ | ‘onLaunch’	Configura quando il plugin dovrebbe eseguire l'installazione diretta degli aggiornamenti. Funziona solo per il modo di aggiornamento automatico. Funziona bene per le app con un peso inferiore a 10MB e con upload effettuati utilizzando la flag —delta. Le app zip o con un peso superiore a 10MB saranno relativamente lente per gli utenti durante l'aggiornamento. - false: Mai eseguire aggiornamenti diretti (utilizzare il comportamento predefinito: scaricare all'avvio, impostare quando l'app è in background) - atInstall: Eseguire l'aggiornamento diretto solo quando l'app è installata, aggiornata dal negozio, altrimenti agire come se directUpdate = false - onLaunch: Eseguire l'aggiornamento diretto solo quando l'app è installata, aggiornata dal negozio o dopo che l'app è stata chiusa, altrimenti agire come se directUpdate = false - sempre: Eseguire l'aggiornamento diretto in tutti i casi precedenti (app installata, aggiornata dal negozio, dopo che l'app è stata chiusa o l'app è stata riavviata), mai agire come se directUpdate = false - vero: (deprecated) Lo stesso di “sempre” per compatibilità con i sistemi precedenti Disponibile su Android, iOS e Electron.	false	5.1.0
autoSplashscreen	boolean	Tratta automaticamente la rimozione dello schermo di benvenuto quando si utilizza l'aggiornamento diretto. 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 directUpdate è impostato su “atInstall”, “sempre” o vero. Richiede l'installazione e la configurazione del plugin @capacitor/splash-screen con launchAutoHide impostato su false. Richiede l'abilitazione di autoUpdate e directUpdate. Disponibile su Android e iOS.	false	7.6.0
periodCheckDelay	number	Configura il periodo di ritardo per il controllo di aggiornamento. La 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	Consenti al plugin di mantenere la struttura delle URL dopo un reload. AVVISO: quando viene attivato un reload, ‘window.history’ verrà resettato.	false	6.8.0
disableJSLogging	boolean	Disabilita la registrazione del 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": false,
      "resetWhenUpdate": false,
      "updateUrl": https://example.com/api/auto_update,
      "channelUrl": https://example.com/api/channel,
      "statsUrl": https://example.com/api/stats,
      "publicKey": undefined,
      "version": undefined,
      "directUpdate": undefined,
      "autoSplashscreen": undefined,
      "periodCheckDelay": undefined,
      "localS3": undefined,
      "localHost": undefined,
      "localWebHost": undefined,
      "localSupa": undefined,
      "localSupaAnon": undefined,
      "localApi": undefined,
      "localApiFiles": undefined,
      "allowModifyUrl": undefined,
      "defaultChannel": undefined,
      "appId": undefined,
      "keepUrlPathAfterReload": undefined,
      "disableJSLogging": undefined,
      "shakeMenu": undefined
    }
  }
}

In capacitor.config.ts:

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

const config: CapacitorConfig = {
  plugins: {
    CapacitorUpdater: {
      appReadyTimeout: 1000 // (1 second),
      responseTimeout: 10 // (10 second),
      autoDeleteFailed: false,
      autoDeletePrevious: false,
      autoUpdate: false,
      resetWhenUpdate: false,
      updateUrl: https://example.com/api/auto_update,
      channelUrl: https://example.com/api/channel,
      statsUrl: https://example.com/api/stats,
      publicKey: undefined,
      version: undefined,
      directUpdate: undefined,
      autoSplashscreen: undefined,
      periodCheckDelay: undefined,
      localS3: undefined,
      localHost: undefined,
      localWebHost: undefined,
      localSupa: undefined,
      localSupaAnon: undefined,
      localApi: undefined,
      localApiFiles: undefined,
      allowModifyUrl: undefined,
      defaultChannel: undefined,
      appId: undefined,
      keepUrlPathAfterReload: undefined,
      disableJSLogging: undefined,
      shakeMenu: undefined,
    },
  },
};

export default config;

• notifyAppReady()
• setUpdateUrl(...)
• setStatsUrl(...)
• setChannelUrl(...)
• download(...)
• next(...)
• set(...)
• delete(...)
• list(...)
• reset(...)
• current()
• reload()
• setMultiDelay(...)
• cancelDelay()
• getLatest(...)
• setChannel(...)
• unsetChannel(...)
• getChannel()
• listChannels()
• setCustomId(...)
• getBuiltinVersion()
• getDeviceId()
• getPluginVersion()
• isAutoUpdateEnabled()
• removeAllListeners()
• addListener('download', ...)
• addListener('noNeedUpdate', ...)
• addListener('updateAvailable', ...)
• addListener('downloadComplete', ...)
• addListener('majorAvailable', ...)
• addListener('updateFailed', ...)
• addListener('downloadFailed', ...)
• addListener('appReloaded', ...)
• addListener('appReady', ...)
• isAutoUpdateAvailable()
• getNextBundle()
• setShakeMenu(...)
• isShakeMenuEnabled()
• Interfacce
• Alias di tipo

Metodi

notifyAppReady()

notifyAppReady() => Promise<AppReadyResult>

Notifica all'aggiornatore Capacitor che il bundle corrente è attivo (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 di aggiornamento per l'app, questo verrà utilizzato per controllare le nuove versioni.

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

Dal: 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: 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 riferimento a { 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. {@link BundleInfo.id}

Ritorna: Promise<BundleInfo>

---

set(…)

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

Imposta il bundle corrente e ricarica immediatamente l'applicazione.

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

---

Sezione intitolata “Elimina (…)

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

Param

Tipo	Descrizione	Un oggetto {@link BundleId}
options	BundleId	delete(…) Copy to clipboardoggetto contenente l'ID di un bundle da eliminare (nota, questo è l'ID del bundle, NON il nome della versione)

---

elenco(…)

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

Ottieni tutti i bundle scaricati localmente nell'app

Parametro	Tipo	Descrizione
options	ListOptions	I {@link Opzioni per l'elenco dei bundleRitorna:

The {@link Promise<BundleListResult>

---

reset(…)

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

Resetta 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 riporta al bundle predefinito e false si riporterà al bundle caricato con successo l'ultima volta.

---

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 "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 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. ParamTipo date Descrizione background Contenente il {@link "DelayCondition"} nativeVersion Param kill Tipo

Descrizione	Contenente il {@link "DelayCondition"}	Param
options	MultiDelayConditions	Tipo (es. stringa, numero, ecc.) MultiDelayConditionsUn array di condizioni da impostare

Da: 4.3.0

---

annullaRitardo()

cancelDelay() => Promise<void>

Annulla una {@link DelayCondition} per elaborare un aggiornamento immediatamente. Da:ottieniUltimo(…)

Sottosezione intitolata “ottieniUltimo(…) 4.0.0

---

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

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

Ottieni l'ultima bundle disponibile dal URL di aggiornamento

Parametro	Tipo
options	GetLatestOptions

Restituisce: Promise<LatestVersion>

Dal: 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 funzionare correttamente.

Nota importante:

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

Param	Tipo	Descrizione
options	SetChannelOptions	È il {@link Imposta le opzioni del canale} per impostare il canale

Restituisce: Promise<ChannelRes>

Dal: 4.7.0

---

unsetChannel(…)

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

Disabilita 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 di nuovo sulla pista di aggiornamento predefinita
• Vuoi utilizzare un canale pubblico (poiché i canali pubblici non possono essere assegnati automaticamente tramite setChannel())

Parametro	Tipo
options	UnsetChannelOptions

Dal: 4.7.0

---

getChannel()

getChannel() => Promise<GetChannelRes>

Ottieni il canale per questo dispositivo

Ritorna: Promise<GetChannelRes>

Dal: 4.8.0

---

listCanali()

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:

• public: Se 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_set: Se true, questo è un canale assegnabile da parte dell'utente. Puoi 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 per questo dispositivo

Parametro	Tipo	Descrizione
options	SetCustomIdOptions	è il {@link SetCustomIdOptionsDal:

getBuiltinVersion() 4.9.0

---

Sezione intitolata “getBuiltinVersion()”

getBuiltinVersion() => Promise<BuiltinVersion>

Ritorna:

Dal: Promise<BuiltinVersion>

getDeviceId() 5.2.0

---

Sezione intitolata “getDeviceId()”

getDeviceId() => Promise<DeviceId>

Ottieni l'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 Capacitor Updater (inviata al server di aggiornamento automatico)

Ritorna: Promise<PluginVersion>

---

isAutoUpdateEnabled()

isAutoUpdateEnabled() => Promise<AutoUpdateEnabled>

Ottieni lo stato della configurazione di aggiornamento automatico

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

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

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

Restituisce: Promise<PluginListenerHandle>

Da: 4.0.0

---

addListener(‘updateAvailable’, …)

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

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

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>

Da: 4.0.0

---

addListener(‘majorAvailable’, …)

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

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

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

Restituisce: Promise<PluginListenerHandle>

Da: 2.3.0

---

addListener(‘updateFailed’, …)

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

Ascolta per l'evento di fallita di aggiornamento nell'app, ti informa quando l'aggiornamento non è stato installato con successo alla prossima partenza dell'app

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

Restituisce: Promise<PluginListenerHandle>

Dal: 2.3.0

---

addListener('downloadFailed', ...)

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

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

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 per l'evento di app pronto nell'App, ti informa quando l'app è pronta per l'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>

Ottieni il prossimo bundle che verrà utilizzato quando l'app si ricaricherà. Restituisce null se non è impostato un 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 boolean abilitato per abilitare o disabilitare il menu scuotimento

Da: 7.5.0

---

èShakeMenuEnabled()

isShakeMenuEnabled() => Promise<ShakeMenuEnabled>

Ottieni lo stato corrente del menu scuotimento

Ritorna: Promise<ShakeMenuEnabled>

Da: 7.5.0

---

Interfacce

AppReadyResult

Proprietà	Tipo
bundle	BundleInfo

Informazioni sull'archiviazione

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

URL di aggiornamento

Proprietà	Tipo
url	string

URL delle statistiche

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

Prop	Tipo	Descrizione	Default	Dal momento in cui
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) scarichi multi-file	undefined	6.1.0

ManifestoEntry

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

Id del Bundle

Proprietà	Tipo
id	string

BundleListResult

Proprietà	Tipo
bundles	BundleInfo[]

ListOptions

Proprietà	Tipo	Descrizione	Predefinito	Dal momento che
raw	boolean	Se vero, la lista cercherà di leggere il database interno al posto dei file sul disco.	false	6.14.0

Resetta le opzioni

Proprietà	Tipo
toLastSuccessful	boolean

Risultato Bundle Attuale

Proprietà	Tipo
bundle	BundleInfo
native	string

Condizioni di ritardo multipla

Proprietà	Tipo
delayConditions	DelayCondition[]

Condizione di ritardo

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

Ultima versione disponibile

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

CanaleRes

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

Opzioni per impostare il canale

Proprietà	Tipo
channel	string
triggerAutoUpdate	boolean

Opzioni per annullare il canale

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

ListChannelsResult

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

Informazioni sul canale

Proprietà	Tipo	Descrizione	Dal
id	string	L'ID del canale	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 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

SetCustomIdOptions

Proprietà	Tipo
customId	string

Versione predefinita

Proprietà	Tipo
version	string

Id dispositivo

Proprietà	Tipo
deviceId	string

Versione del plugin

Proprietà	Tipo
version	string

Aggiornamento automatico abilitato

Proprietà	Tipo
enabled	boolean

PluginListenerHandle

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

DownloadEvent

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 attuale del download, tra 0 e 100.	4.0.0

UpdateAvailableEvent

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

DownloadCompleteEvent

Proprietà	Tipo	Descrizione	Dal momento in cui
bundle	BundleInfo	Emesso quando è disponibile una nuova versione.	4.0.0

MajorAvailableEvent

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

UpdateFailedEvent

Proprietà	Tipo	Descrizione	Dal
bundle	BundleInfo	Emitto quando non riesco ad installare l'aggiornamento.	4.0.0

DownloadFailedEvent

Proprietà	Tipo	Descrizione	Dal
version	string	Emette 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 di scuotimento

Proprietà	Tipo
enabled	boolean

Menu di scuotimento abilitato

Proprietà	Tipo
enabled	boolean

Alias di tipo

Stato del pacchetto

__CAPGO_KEEP_0__: Il pacchetto è in attesa di essere __CAPGO_KEEP_1__. IMPOSTA come il prossimo pacchetto. download: Il pacchetto sta per essere scaricato. success: Il pacchetto è stato scaricato e è pronto per essere __CAPGO_KEEP_2__. come il prossimo pacchetto. __CAPGO_KEEP_3__: Il pacchetto non è riuscito a scaricarsi. Ritardi fino al prossimo Sezione intitolata “Ritardi fino al prossimo”

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

IMPOSTA

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