Funzioni e impostazioni

Configurazione Plugin Aggiornatore

Vedi il Github Readme per ulteriori informazioni.

CapacitorUpdater può essere configurato con queste opzioni:

Prop	Type	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 falliti. 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 “atBackground”; false è lo stesso di “off”. - off: Disabilita l'aggiornamento automatico - atBackground: Controlla e scarica automaticamente, quindi applica quando l'app si sposta in background - atInstall: Applica immediatamente solo dopo un installazione fresca o aggiornamento di app nativa, altrimenti utilizza atBackground - onLaunch: Applica immediatamente all'avvio, altrimenti utilizza atBackground dopo il controllo di avvio - sempre: Applica immediatamente ogni volta che l'aggiornamento automatico viene eseguito - onlyDownload: 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 scaricati precedentemente quando viene installato un bundle nativo più recente sul dispositivo. Disponibile su Android, iOS e Electron.	true
updateUrl	string	Configura l'URL / endpoint a cui vengono inviate le verifiche 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. Questo verrà utilizzato per la prima richiesta di aggiornamento. Se non viene impostato, 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 i modi 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 app esistenti. Disponibile su Android, iOS e Electron.	false	5.1.0
autoSplashscreen	boolean	Gestisci automaticamente la rimozione dello schermo di caricamento quando si utilizzano modalità di applicazione istantanea. Quando abilitato, il plugin nasconderà automaticamente lo schermo di caricamento dopo le 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 “always”. I valori di directUpdate legacy sono ancora supportati per compatibilità con i sistemi precedenti. Richiede l'installazione e la configurazione del plugin @capacitor/splash-screen con launchAutoHide impostato su false. Richiede l'abilitazione dell'aggiornamento automatico. 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. 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 da parte del lato JavaScript.	false	5.4.0
defaultChannel	string	Imposta il canale predefinito per l'app nella configurazione. Sensitive al caso. Questa impostazione sovrascriverà il canale predefinito impostato in cloud, ma rispetterà comunque gli override fatti in cloud.	undefined	5.5.0
appId	string	Configura l'ID dell'app per l'app nella configurazione.	undefined	6.0.0
keepUrlPathAfterReload	boolean	Configura il plugin per mantenere la URL del percorso dopo un reload. AVVERTENZA: Quando viene attivato un reload, ‘window.history’ verrà resettato.	false	6.8.0
disableJSLogging	boolean	Disabilita la registrazione del 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>

Notifica al Capacitor Updater 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 secondi 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'updateUrl per l'app, verrà utilizzato per controllare le aggiornamenti.

Parametro	Tipo	Descrizione
options	UpdateUrl	__CAPGO_KEEP_0__

Da: 5.4.0

---

setStatsUrl(…)

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

Imposta l'indirizzo URL per l'app, verrà utilizzato per inviare statistiche. Passando una stringa vuota disabilita la raccolta di 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'URL del canale per l'app, verrà utilizzato per impostare il canale.

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

Dal: 5.4.0

---

download(…)

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

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

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

Ritorna: Promise<BundleInfo>

---

next(…)

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

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

Parametro	Tipo	Descrizione
options	BundleId	Contiene l'ID del prossimo Pacchetto da impostare alla prossima avviatura dell'app. {@link}

BundleInfo.id Promise<BundleInfo>

---

Ritorna:

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

Copia negli appunti

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

---

Copia negli appunti

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

Tipo

Descrizione	Un oggetto {@link} contenente l'ID del pacchetto nuovo da impostare come attuale.	Descrizione
options	BundleId	Un oggetto {@link} contenente l'ID di un bundle da eliminare (nota, questo è l'ID del bundle, NON il nome della versione) list(…)Sezione intitolata “list(…)

---

Copia negli appunti

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

Tipo

Descrizione	L'oggetto {@link}	Copy to clipboard
options	ListOptions	Get all locally downloaded bundles in your app Opzioni di lista} per elencare i pacchetti

Restituisce: Promise<BundleListResult>

---

reset(…)

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

Ripristina l'applicazione al builtin pacchetto (il pacchetto 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 resetta alla bundle predefinita e false si resettano le impostazioni per la bundle caricata con successo.

---

current()

current() => Promise<CurrentBundleResult>

Restituisce la bundle corrente, se non sono state impostate alcune restituisce builtin. currentNative è 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 DelayCondition} 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 date kind, il valore dovrebbe essere una stringa di data in formato ISO 8601. Per il background kind, il valore dovrebbe essere un numero in millisecondi. Per il nativeVersion kind, il valore dovrebbe essere il numero di versione. Per il kill 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 il successivo background come altre opzioni. Questo verrà risolto in una futura versione maggiore.

Param	Tipo	Descrizione
options	MultiDelayConditions	Contenente l'array di condizioni {@link MultiDelayConditions} per impostare

Dal: 4.3.0

---

cancelDelay()

cancelDelay() => Promise<void>

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

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

Nota importante:

• Non utilizzare questo metodo per impostare il canale al boot. Utilizza il defaultChannel invece il 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 dall'utente. 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.
• Utilizza listChannels() per scoprire quali canali sono disponibili e se consentono l'assegnazione auto.

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

Ritorna: Promise<ChannelRes>

Dal: 4.7.0

---

unsetChannel(…)

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

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

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

Param	Tipo
options	UnsetChannelOptions

Da: 4.7.0

---

getChannel()

getChannel() => Promise<GetChannelRes>

Ottieni il canale per questo dispositivo

Ritorna: Promise<GetChannelRes>

Dal: 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 auto

Ogni canale nel risultato include:

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

Returns: Promise<ListChannelsResult>

Dal: 7.5.0

---

setCustomId(…)

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

Imposta un ID personalizzato per questo dispositivo

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

Dal: 4.9.0

---

getBuiltinVersion()

getBuiltinVersion() => Promise<BuiltinVersion>

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

Ritorna: Promise<BuiltinVersion>

Dal: 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 Capacitor dell'aggiornamento del plugin (inviata al server di aggiornamento automatico)

Restituisce: Promise<PluginVersion>

---

isAutoUpdateEnabled()

isAutoUpdateEnabled() => Promise<AutoUpdateEnabled>

Ottenere 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 è finito. Questo ti restituirà tutti i percentuali di download durante il download

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

Restituisce: Promise<PluginListenerHandle>

Dal: 2.0.11

---

addListener('noNeedUpdate', …)

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

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

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

Restituisce: Promise<PluginListenerHandle>

Dal: 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'app viene lanciata

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

Restituisce: Promise<PluginListenerHandle>

Dal: 4.0.0

---

addListener('downloadCompleto', …)

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

Ascolta gli eventi di download completati.

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

__CAPGO_KEEP_0__ Promise<PluginListenerHandle>

__CAPGO_KEEP_0__ 4.0.0

---

Aggiungi l'ascoltatore per l'evento 'majorAvailable', ...

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

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

__CAPGO_KEEP_0__ 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 fallita del download nell'App, ti informa quando un bundle di download ha fallito

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

Ritorna: Promise<PluginListenerHandle>

Dal: 4.0.0

---

addListener('appReloaded', ...)

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

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

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

Ritorna: Promise<PluginListenerHandle>

Dal: 4.3.0

---

addListener('appReady', ...)

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

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

Ritorna: Promise<AutoUpdateAvailable>

---

getNextBundle()

getNextBundle() => Promise<BundleInfo | null>

Ottenere il prossimo pacchetto che verrà utilizzato quando l'app si ricarica. 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 di scuotimento per scopi di debug/test.

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

Dal: 7.5.0

---

isShakeMenuEnabled()

isShakeMenuEnabled() => Promise<ShakeMenuEnabled>

Ottieni lo stato corrente del menu scuotimento

Ritorna: Promise<ShakeMenuEnabled>

Dal: 7.5.0

---

Interface

__CAPGO_KEEP_0__

Proprietà	Tipo
bundle	BundleInfo

Informazioni sulla raccolta

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

URL di aggiornamento

Proprietà	Tipo
url	string

StatsUrl

Proprietà	Tipo
url	string

URL del Canale

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. Sono richiesti i SessionKey se si è criptato il bundle con il comando CLI encrypt, dovrebbero essere ricevuti come risultato del comando.

Proprietà	Tipo	Descrizione	Predefinito	Dal
url	string	L'URL del file zip del pacchetto (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 pacchetto.)
version	string	La versione code/nome di questo pacchetto/versione
sessionKey	string	La chiave di sessione per l'aggiornamento, quando il pacchetto è 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 pacchetto è crittografato	undefined	4.0.0
manifest	ManifestEntry[]	Il manifesto per Delta (manifesto) scarichi multi-file	undefined	6.1.0

Manifesto di ingresso

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

Id Bundle

Proprietà	Tipo
id	string

Risultato della lista Bundle

Proprietà	Tipo
bundles	BundleInfo[]

Opzioni della lista

Proprietà	Tipo	Descrizione	Impostazione predefinita	Dal
raw	boolean	Se vero, il elenco dei bundle cercherà di leggere la database interna al posto dei file sul disco.	false	6.14.0

Reset delle opzioni

Proprietà	Tipo
toLastSuccessful	boolean

Risultato Bundle Corrente

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

Ottenere l'Ultima Versione

Proprietà	Tipo	Descrizione	Impostazione predefinita	Dal momento che
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

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

Impostazioni per impostare il canale

Proprietà	Tipo
channel	string
triggerAutoUpdate	boolean

Impostazioni del canale non definite

Proprietà	Tipo
triggerAutoUpdate	boolean

Risultato del canale

Proprietà	Tipo	Descrizione	Da
channel	string	Stato corrente del canale di ricezione	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 momento in cui
id	string	L'ID 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(). Ciò è tipicamente utilizzato per test di beta, test A/B o tracce di aggiornamento a richiesta.	7.5.0

SetCustomIdOptions

Proprietà	Tipo
customId	string

__CAPGO_KEEP_0__

__CAPGO_KEEP_1__	Proprietà
version	string

__CAPGO_KEEP_2__

__CAPGO_KEEP_3__	ID dispositivo
deviceId	string

Sezione intitolata “ID dispositivo”

Proprietà	__CAPGO_KEEP_5__
version	string

Aggiornamento Automatico Abilitato

Proprietà	Tipo
enabled	boolean

Maniglia dell'Ascoltatore del Plugin

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

Evento di Download

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

NoNeedEvent

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

UpdateAvailableEvent

Proprietà	Tipo	Descrizione	Dal
bundle	BundleInfo	__CAPGO_KEEP_0__	4.0.0

DownloadCompleteEvent

Proprietà	Tipo	Descrizione	Dal
bundle	BundleInfo	__CAPGO_KEEP_0__	4.0.0

EventoVersioneMaggioreDisponibile

Proprietà	Tipo	Descrizione	Dal
version	string	Emette quando è disponibile una nuova versione bundle maggiore.	4.0.0

EventoAggiornamentoFallito

Proprietà	Tipo	Descrizione	Dal momento in cui
bundle	BundleInfo	__CAPGO_KEEP_0__	4.0.0

DownloadFailedEvent

Proprietà	Tipo	Descrizione	Dal momento in cui
version	string	__CAPGO_KEEP_0__	4.0.0

AppReadyEvent

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

Aggiornamento automatico disponibile

Proprietà	Tipo
available	boolean

Imposta opzioni del menu scuotimento

Proprietà	Tipo
enabled	boolean

ShakeMenuAbilitato

Proprietà	Tipo
enabled	boolean

Alias di tipo

Stato della raccolta

in attesa: La raccolta è in attesa di essere IMPOSTA scaricando: La raccolta sta per essere scaricata. IMPOSTA come il prossimo bundle. errore: Il bundle non è riuscito a scaricarsi.

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

Ritardi fino al prossimo

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