Funzioni e impostazioni

Configurazione Plugin Updater

Consulta il Github Readme per maggiori informazioni.

CapacitorUpdater può essere configurato con queste opzioni:

Prop	Tipo	Descrizione	Predefinito	Da
appReadyTimeout	number	Configura i millisecondi di attesa del plugin nativo prima di considerare un aggiornamento come 'fallito'. Disponibile su Android, iOS ed Electron.	10000 // (10 seconds)
responseTimeout	number	Configura i millisecondi di attesa del plugin nativo prima di considerare il timeout di API. Disponibile su Android, iOS ed Electron.	20000 // (20 seconds)
autoDeleteFailed	boolean	Configura se il plugin deve eliminare automaticamente i bundle falliti. Disponibile su Android, iOS ed Electron.	true
autoDeletePrevious	boolean	Configura se il plugin deve eliminare automaticamente i bundle precedenti dopo un aggiornamento riuscito. Disponibile su Android, iOS ed Electron.	true
autoUpdate	boolean | ‘off’ | ‘atBackground’ | ‘atInstall’ | ‘onLaunch’ | ‘always’ | ‘onlyDownload’	Configura il comportamento dell'Auto Update tramite un server di aggiornamento. true equivale a “atBackground”; false equivale a “off”. - off: Disabilita l'Auto Update - atBackground: Controlla e scarica automaticamente, poi applica quando l'app va in background - atInstall: Applica immediatamente solo dopo una nuova installazione o un aggiornamento nativo, altrimenti usa atBackground - onLaunch: Applica immediatamente all'avvio, altrimenti usa atBackground dopo il controllo iniziale - always: Applica immediatamente ogni volta che l'Auto Update viene eseguito - onlyDownload: Controlla e scarica automaticamente, emette updateAvailable e non imposta mai il bundle successivo automaticamente. Le modalità di applicazione istantanea (“atInstall”, “onLaunch”, “always”) dovrebbero essere caricate con —delta per non rallentare l'esperienza utente. Su Android e iOS, queste modalità richiedono autoSplashscreen: true e @capacitor/splash-screen con launchAutoHide: false. Disponibile su Android, iOS ed Electron.	“atBackground” // true is still accepted
resetWhenUpdate	boolean	Elimina automaticamente i bundle scaricati in precedenza quando viene installato un nuovo bundle nativo sul dispositivo. Disponibile su Android, iOS ed Electron.	true
updateUrl	string	Configura l'URL o l'endpoint a cui vengono inviate le richieste di controllo aggiornamenti. Disponibile su Android, iOS ed Electron.	https://plugin.capgo.app/updates
channelUrl	string	Configura l'URL o l'endpoint per le operazioni sui channel. Disponibile su Android, iOS ed Electron.	https://plugin.capgo.app/channel_self
statsUrl	string	Configura l'URL o l'endpoint a cui vengono inviate le statistiche degli aggiornamenti. Disponibile su Android, iOS ed Electron. Imposta "" per disabilitare il reporting.	https://plugin.capgo.app/stats
publicKey	string	Configura la chiave pubblica per la crittografia end-to-end live update Version 2. Disponibile su Android, iOS ed Electron.	undefined	6.2.0
version	string	Configura la versione attuale dell'app. Verrà utilizzata per la prima richiesta di aggiornamento. Se non impostata, il plugin recupererà la versione dal code nativo. Disponibile su Android, iOS ed Electron.	undefined	4.17.48
directUpdate	boolean | ‘always’ | ‘atInstall’ | ‘onLaunch’	Deprecato. Usa le modalità stringa di autoUpdate: “atInstall”, “onLaunch” o “always”. Questa opzione è supportata per le app esistenti. L'applicazione istantanea va caricata con —delta per non rallentare l'esperienza utente. Su Android e iOS queste modalità richiedono autoSplashscreen: true e @capacitor/splash-screen con launchAutoHide: false. - false: Nessun aggiornamento diretto - atInstall: Come autoUpdate: “atInstall” - onLaunch: Come autoUpdate: “onLaunch” - always: Come autoUpdate: “always” - true: Come “always” per retrocompatibilità. Disponibile su Android, iOS ed Electron.	false	5.1.0
autoSplashscreen	boolean	Necessario quando si usano le modalità di applicazione istantanea (“atInstall”, “onLaunch” o “always”), inclusi i valori directUpdate ormai deprecati. @capacitor/splash-screen deve essere installato e configurato con launchAutoHide: false. Quando abilitato, il plugin nasconde la splashscreen dopo l'applicazione degli update o quando non è necessario alcun aggiornamento. Questo evita di dover ascoltare manualmente gli eventi appReady e chiamare SplashScreen.hide(). Disponibile su Android e iOS.	false	7.6.0
periodCheckDelay	number	Configura l'intervallo di tempo per il controllo periodico degli update. L'unità di misura è in secondi. Disponibile su Android, iOS ed Electron. Non può essere inferiore a 600 secondi (10 minuti).	600 // (10 minutes)
localS3	boolean	Configura CLI per usare un server locale per i test o un server di aggiornamento self-hosted.	undefined	4.17.48
localHost	string	Configura CLI per usare un server locale per i test o un server di aggiornamento self-hosted.	undefined	4.17.48
localWebHost	string	Configura CLI per usare un server locale per i test o un server di aggiornamento self-hosted.	undefined	4.17.48
localSupa	string	Configura CLI per usare un server locale per i test o un server di aggiornamento self-hosted.	undefined	4.17.48
localSupaAnon	string	Configura CLI per utilizzare un server locale per i test.	undefined	4.17.48
localApi	string	Configura CLI per utilizzare un api locale per i test.	undefined	6.3.3
localApiFiles	string	Configura CLI per utilizzare un file api locale per i test.	undefined	6.3.3
allowModifyUrl	boolean	Consente al plugin di modificare dinamicamente updateUrl, statsUrl e channelUrl dal lato JavaScript.	false	5.4.0
defaultChannel	string	Imposta il canale predefinito dell'app nella config. Case sensitive. Questa impostazione sovrascriverà il canale predefinito impostato nel cloud, ma rispetterà comunque gli override effettuati nel cloud.	undefined	5.5.0
appId	string	Configura l'app id dell'app nel file di configurazione.	undefined	6.0.0
keepUrlPathAfterReload	boolean	Configura il plugin per mantenere il percorso URL dopo un reload. AVVISO: Al trigger del reload, ‘window.history’ verrà svuotato.	false	6.8.0
disableJSLogging	boolean	Disabilita il logging JavaScript del plugin. Se true, il plugin non scriverà sulla console JavaScript; verranno generati solo i log nativi.	false	7.3.0
shakeMenu	boolean	Abilita il gesto dello shake per mostrare il menu degli update per debugging o 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 Capacitor Updater che il bundle corrente è funzionante (si verificherà un rollback se questo metodo non viene chiamato ad ogni avvio dell'app). Di default, questo metodo deve essere chiamato entro i primi 10 secondi dall'avvio, altrimenti verrà eseguito un rollback. Modifica questo comportamento con {@link appReadyTimeout}

Restituisce: Promise<AppReadyResult>

---

setUpdateUrl(…)

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

Imposta l'updateUrl per l'app; verrà utilizzato per controllare la presenza di aggiornamenti.

Parametro	Tipo	Descrizione
options	UpdateUrl	contiene l'URL da usare per verificare la presenza di aggiornamenti.

Dal: 5.4.0

---

setStatsUrl(…)

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

Imposta la statsUrl per l'app, che verrà usata per inviare le statistiche. Passando una stringa vuota, la raccolta delle statistiche viene disabilitata.

Parametro	Tipo	Descrizione
options	StatsUrl	contiene l'URL da usare per l'invio delle statistiche.

Dal: 5.4.0

---

setChannelUrl(…)

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

Imposta la channelUrl per l'app; verrà utilizzata per definire 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 dall'URL fornito; deve essere un file zip contenente i file o un ID univoco con tutti i file all'interno

Parametro	Tipo	Descrizione
options	DownloadOptions	L'{@link} DownloadOptions} per scaricare un nuovo file zip del bundle.

Restituisce: Promise<BundleInfo>

---

next(…)

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

Imposta il prossimo bundle da utilizzare al ricaricamento dell'app.

Parametro	Tipo	Descrizione
options	BundleId	Contiene l'ID del prossimo Bundle da impostare al prossimo avvio dell'app. {@link BundleInfo.id}

Restituisce: Promise<BundleInfo>

---

set(…)

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

Imposta il bundle corrente e ricarica immediatamente l'app.

Parametro	Tipo	Descrizione
options	BundleId	Un {@link BundleId} contenente il nuovo bundle id da impostare come corrente.

---

delete(…)

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

Elimina il bundle specificato dallo storage dell'app nativa. Usa {@link list} per ottenere i Bundle ID salvati.

Parametro	Tipo	Descrizione
options	BundleId	Un {@link BundleId} oggetto contenente l'ID del bundle da eliminare (nota: si tratta del bundle id, NON del nome della versione)

---

list(…)

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

Recupera tutti i bundle scaricati localmente nella tua app

Parametro	Tipo	Descrizione
options	ListOptions	Il {@link} ListOptions} per l'elenco dei bundle

Restituisce: Promise<BundleListResult>

---

reset(…)

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

Ripristina l'app al builtin bundle (quello inviato ad Apple App Store / Google Play Store) o all'ultimo bundle caricato con successo.

Parametro	Tipo	Descrizione
options	ResetOptions	Contenente {@link ResetOptions.toLastSuccessful}, true ripristina al bundle integrato e false tornerà all'ultimo bundle caricato con successo.

---

current()

current() => Promise<CurrentBundleResult>

Ottieni il bundle corrente; se non ne è impostato nessuno, restituisce builtin. currentNative è il bundle originale installato sul dispositivo

Restituisce: Promise<CurrentBundleResult>

---

reload()

reload() => Promise<void>

Ricarica la view

---

setMultiDelay(…)

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

Imposta un array {@link} DelayConditioncontenente le condizioni che il Plugin userà per ritardare l'update. Una volta soddisfatte tutte le condizioni, il processo di update ripartirà normalmente, quindi l'aggiornamento verrà installato dopo aver messo l'app in background o averla chiusa. Per il tipo date il valore deve essere una stringa di data ISO8601. Per il tipo background il valore deve essere un numero in millisecondi. Per il tipo nativeVersion il valore deve essere il numero di versione. Per il tipo kill il valore non viene utilizzato. La funzione presenta un comportamento inconsistente: l'opzione kill avvia l'update dopo la prima chiusura e non dopo il successivo background come le altre opzioni. Questo verrà corretto in un prossimo major release.

Parametro	Tipo	Descrizione
options	MultiDelayConditions	Contiene l'array {@link} MultiDelayConditions} di condizioni per impostare

Dal: 4.3.0

---

cancelDelay()

cancelDelay() => Promise<void>

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

Dal: 4.0.0

---

getLatest(…)

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

Ottieni l'ultimo bundle disponibile dall'URL di update

Parametro	Tipo
options	GetLatestOptions

Restituisce: Promise<LatestVersion>

Dal: 4.0.0

---

setChannel(…)

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

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

setChannel() valida il canale con il backend e poi salva il canale selezionato localmente sul dispositivo. Non crea né aggiorna un Device Override sul backend, quindi il dispositivo non apparirà come sovrascritto nella dashboard di Capgo. Solo le assegnazioni create dalla dashboard o dal API pubblico sono visibili nella UI Device Override.

Note importanti:

• Non usare questo metodo per impostare il canale all'avvio. Usa invece il defaultChannel nella tua configurazione Capacitor.
• Questo metodo è pensato per l'uso dopo che l'app è pronta e l'utente ha interagito (ad esempio, iscrivendosi a un programma beta).
• Non è possibile assegnare i canali pubblici manualmente. Se un canale è contrassegnato come public, chiamare setChannel() restituirà un errore. Per usare un canale pubblico, chiama unsetChannel() invece: il dispositivo passerà automaticamente al canale pubblico corrispondente.
• Usa listChannels() per scoprire quali canali sono disponibili e se permettono l'assegnazione autonoma.

Parametro	Tipo	Descrizione
options	SetChannelOptions	Il canale {@link} SetChannelOptions} serve per impostare

Ritorna: Promise<ChannelRes>

Dal: 4.7.0

---

unsetChannel(…)

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

Rimuove il canale locale gestito dal plugin per questo dispositivo. Questo cancella solo il canale salvato localmente da setChannel(); non elimina i record di Dashboard o di Public API Device Override.

Dopo la chiamata, si applica la precedenza standard del canale: un eventuale Dashboard o Public API Device Override ha ancora la priorità; altrimenti, il dispositivo può tornare al canale pubblico/default corrispondente alle sue condizioni (piattaforma, tipo di dispositivo, tipo di build).

È utile quando:

• Vuoi riportare un dispositivo al track di aggiornamento predefinito
• Vuoi usare un canale pubblico (dato che i canali pubblici non possono essere assegnati tramite setChannel())

Parametro	Tipo
options	UnsetChannelOptions

Dal: 4.7.0

---

getChannel()

getChannel() => Promise<GetChannelRes>

Ottieni il canale per questo dispositivo

Restituisce: Promise<GetChannelRes>

Dal: 4.8.0

---

listChannels()

listChannels() => Promise<ListChannelsResult>

Elenca tutti i canali disponibili per questo dispositivo. Restituisce i canali compatibili con l'ambiente attuale del dispositivo (piattaforma, emulatore/dispositivo reale, build dev/prod) che sono pubblici o che consentono l'auto-assegnazione.

Ogni canale nel risultato include:

• public: Se true, questo è un canale di default. Non è possibile auto-assegnarsi tramite setChannel(). Invece, se rimuovi l'assegnazione del tuo canale usando unsetChannel(), il dispositivo riceverà automaticamente gli aggiornamenti da questo canale pubblico.
• allow_self_set: Se true, questo è un canale auto-assegnabile. Puoi assegnare esplicitamente il dispositivo a questo canale usando setChannel().

Restituisce: Promise<ListChannelsResult>

Dal: 7.5.0

---

setCustomId(…)

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

Imposta un ID personalizzato per questo dispositivo

Parametro	Tipo	Descrizione
options	SetCustomIdOptions	è il {@link} SetCustomIdOptionscustomId per impostare

Dal: 4.9.0

---

getBuiltinVersion()

getBuiltinVersion() => Promise<BuiltinVersion>

Ottieni la versione dell'app nativa o la versione builtin se impostata nella config

Restituisce: Promise<BuiltinVersion>

Dal: 5.2.0

---

getDeviceId()

getDeviceId() => Promise<DeviceId>

Ottieni l'ID univoco usato per identificare il dispositivo (inviato al server di auto update)

Restituisce: Promise<DeviceId>

---

getPluginVersion()

getPluginVersion() => Promise<PluginVersion>

Ottieni la versione del plugin nativo Capacitor Updater (inviata al server di auto update)

Restituisce: Promise<PluginVersion>

---

isAutoUpdateEnabled()

isAutoUpdateEnabled() => Promise<AutoUpdateEnabled>

Ottieni lo stato della configurazione di auto update.

Restituisce: Promise<AutoUpdateEnabled>

---

removeAllListeners()

removeAllListeners() => Promise<void>

Rimuovi tutti i listener di questo plugin.

Dal: 1.0.0

---

addListener(‘download’, …)

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

Ascolta l'evento di download del bundle nell'App. Viene emesso all'inizio del download, durante il download e al termine. Restituisce la percentuale 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 "no need to update", utile quando vuoi forzare un controllo ogni volta che l'app viene avviata

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

Restituisce: Promise<PluginListenerHandle>

Dal: 4.0.0

---

addListener(‘updateAvailable’, …)

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

Ascolta l'evento di aggiornamento disponibile, utile se vuoi forzare un 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>

Dal: 4.0.0

---

addListener(‘majorAvailable’, …)

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

Ascolta l'evento di Major update nell'App; ti avvisa quando un major update è bloccato impostando disableAutoUpdateBreaking

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

Restituisce: Promise<PluginListenerHandle>

Dal: 2.3.0

---

addListener(‘updateFailed’, …)

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

Ascolta l'evento di fallimento dell'update nell'App per sapere se l'installazione non è andata a buon fine al prossimo avvio

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 l'evento di fallimento del download nell'App per sapere se il download di un bundle è 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 reload nell'App, ti fa sapere quando il reload è avvenuto

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 l'evento app ready nell'App per sapere quando è pronta all'uso

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

Restituisce: Promise<PluginListenerHandle>

Dal: 5.1.0

---

isAutoUpdateAvailable()

isAutoUpdateAvailable() => Promise<AutoUpdateAvailable>

Verifica se l'auto update è disponibile (non disabilitato da serverUrl).

Restituisce: Promise<AutoUpdateAvailable>

---

getNextBundle()

getNextBundle() => Promise<BundleInfo | null>

Ottieni il prossimo bundle che verrà utilizzato al ricaricamento dell'app. Restituisce null se non è impostato alcun bundle successivo.

Restituisce: Promise<BundleInfo | null>

Dal: 6.8.0

---

setShakeMenu(…)

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

Abilita o disabilita il menu shake per scopi di debugging o testing

Parametro	Tipo	Descrizione
options	SetShakeMenuOptions	Contiene un booleano per abilitare o disabilitare lo shake menu

Dal: 7.5.0

---

isShakeMenuEnabled()

isShakeMenuEnabled() => Promise<ShakeMenuEnabled>

Ottieni lo stato attuale dello shake menu

Restituisce: Promise<ShakeMenuEnabled>

Dal: 7.5.0

---

Interfacce

AppReadyResult

Prop	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

ChannelUrl

Prop	Tipo
url	string

DownloadOptions

Questo URL e le versioni servono per scaricare il bundle dal server. Se usi un backend, tutte le informazioni saranno fornite dal metodo getLatest. Se non usi un backend, devi fornire l'URL e la versione del bundle. I SessionKey sono necessari se hai criptato il bundle con il comando CLI encrypt; dovresti riceverli come risultato del comando.

Prop	Tipo	Descrizione	Predefinito	Da
url	string	L'URL del file zip del bundle da scaricare (es: dist.zip). (Può essere qualsiasi URL. Es: Amazon S3, un tag GitHub, o qualsiasi altro posto in cui hai ospitato il bundle.)
version	string	La versione code/nome di questo bundle/versione
sessionKey	string	La session key per l'update, se il bundle è criptato con una session key	undefined	4.0.0
checksum	string	Il checksum per l'update; deve essere in sha256 e criptato con una private key se il bundle è criptato	undefined	4.0.0
manifest	ManifestEntry[]	Il manifest per i download multi-file di Delta (manifest)	undefined	6.1.0

ManifestEntry

Prop	Tipo
file_name	string | null
file_hash	string | null
download_url	string | null

BundleId

Prop	Tipo
id	string

BundleListResult

Prop	Tipo
bundles	BundleInfo[]

ListOptions

Prop	Tipo	Descrizione	Predefinito	Da
raw	boolean	Se restituire l'elenco raw dei bundle o il manifest. Se true, l'elenco proverà a leggere il database interno invece dei file su disco.	false	6.14.0

ResetOptions

Prop	Tipo
toLastSuccessful	boolean

CurrentBundleResult

Prop	Tipo
bundle	BundleInfo
native	string

MultiDelayConditions

Prop	Tipo
delayConditions	DelayCondition[]

DelayCondition

Prop	Tipo	Descrizione
kind	DelayUntilNext	Configura le condizioni di delay in setMultiDelay
value	string

LatestVersion

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

Prop	Tipo	Descrizione	Predefinito	Da
channel	string	Il canale per ottenere l'ultima versione. Il canale deve consentire 'self_assign' per il corretto funzionamento	undefined	6.8.0

ChannelRes

Prop	Tipo	Descrizione	Da
status	string	Stato attuale del canale impostato	4.7.0
error	string
message	string

SetChannelOptions

Prop	Tipo
channel	string
triggerAutoUpdate	boolean

UnsetChannelOptions

Prop	Tipo
triggerAutoUpdate	boolean

GetChannelRes

Prop	Tipo	Descrizione	Da
channel	string	Stato attuale di get channel	4.8.0
error	string
message	string
status	string
allowSet	boolean

ListChannelsResult

Prop	Tipo	Descrizione	Da
channels	ChannelInfo[]	Elenco dei canali disponibili	7.5.0

ChannelInfo

Prop	Tipo	Descrizione	Da
id	number	L'ID numerico del canale	7.5.0
name	string	Il nome del canale	7.5.0
public	boolean	Se true, è un canale di default/fallback. I dispositivi non possono auto-assegnarsi ai canali pubblici. Invece, quando un dispositivo rimuove l'override del canale (usando unsetChannel()), riceverà automaticamente gli update dal canale pubblico corrispondente.	7.5.0
allow_self_set	boolean	Se true, i dispositivi possono auto-assegnarsi esplicitamente a questo canale usando setChannel(). Viene tipicamente usato per beta testing, A/B testing o track di update opt-in.	7.5.0

I comandi del canale usano il canale name, non questo ID numerico id.

SetCustomIdOptions

Prop	Tipo
customId	string

BuiltinVersion

Prop	Tipo
version	string

DeviceId

Prop	Tipo
deviceId	string

PluginVersion

Prop	Tipo
version	string

AutoUpdateEnabled

Prop	Tipo
enabled	boolean

PluginListenerHandle

Prop	Tipo
remove	() => Promise<void>

DownloadEvent

Prop	Tipo	Descrizione	Da
percent	number	Stato attuale del download, tra 0 e 100.	4.0.0
bundle	BundleInfo

NoNeedEvent

Prop	Tipo	Descrizione	Da
bundle	BundleInfo	Stato attuale del download, tra 0 e 100.	4.0.0

UpdateAvailableEvent

Prop	Tipo	Descrizione	Da
bundle	BundleInfo	Stato attuale del download, tra 0 e 100.	4.0.0

DownloadCompleteEvent

Prop	Tipo	Descrizione	Da
bundle	BundleInfo	Emesso quando è disponibile un nuovo aggiornamento.	4.0.0

MajorAvailableEvent

Prop	Tipo	Descrizione	Da
version	string	Emesso quando è disponibile un nuovo bundle major.	4.0.0

UpdateFailedEvent

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

DownloadFailedEvent

Prop	Tipo	Descrizione	Da
version	string	Viene emesso quando il download fallisce.	4.0.0

AppReadyEvent

Prop	Tipo	Descrizione	Da
bundle	BundleInfo	Eseguito quando l'app è pronta all'uso.	5.2.0
status	string

AutoUpdateAvailable

Prop	Tipo
available	boolean

SetShakeMenuOptions

Prop	Tipo
enabled	boolean

ShakeMenuEnabled

Prop	Tipo
enabled	boolean

Alias di tipo

BundleStatus

pending: Il bundle è in attesa di essere SET come prossimo bundle. downloading: Il bundle è in fase di download. success: Il bundle è stato scaricato ed è pronto per essere IMPOSTA come prossimo bundle. errore: Il download del bundle è fallito.

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

DelayUntilNext

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

Continua da Functions e settings

Se stai usando Functions e settings per pianificare dashboard e operazioni API, collegalo a Utilizzo di @capgo/capacitor-updater per la funzionalità nativa in Utilizzo di @capgo/capacitor-updater, API Panoramica per i dettagli di implementazione in Panoramica di API, Introduzione per i dettagli implementativi nell'Introduzione, Chiavi API per i dettagli implementativi in API Keys, e Dispositivi per i dettagli implementativi in Dispositivi.