Impostazioni
Copia un prompt di configurazione con i passaggi di installazione e la guida markdown completa per questo plugin.
Per avere un controllo più granulare sul sistema di aggiornamento, puoi configurarlo con queste impostazioni:
Per usare il tuo hostname per updateUrl, statsUrl, e channelUrl, vedi Configurazione Custom Domain.
allowModifyUrl
Sezione intitolata “allowModifyUrl”Consente al plugin di modificare dinamicamente updateUrl, statsUrl e channelUrl dal lato JavaScript.
Disponibile su Android, iOS ed Electron.
Predefinito: false
{ "plugins": { "CapacitorUpdater": { "allowModifyUrl": true } }}Configura l'app id per l'app nella config.
Disponibile su Android, iOS ed Electron.
Predefinito: undefined
{ "plugins": { "CapacitorUpdater": { "appId": "com.example.app" } }}appReadyTimeout
Sezione intitolata “appReadyTimeout”Configura il numero di millisecondi che il plugin nativo deve attendere prima di considerare un update come ‘fallito’.
Disponibile su Android, iOS ed Electron.
Predefinito: 10000 (10 secondi)
{ "plugins": { "CapacitorUpdater": { "appReadyTimeout": 1000 } }}autoDeleteFailed
Sezione intitolata “autoDeleteFailed”Configura se il plugin deve eliminare automaticamente i bundle falliti.
Disponibile su Android, iOS ed Electron.
Predefinito: true
{ "plugins": { "CapacitorUpdater": { "autoDeleteFailed": false } }}autoDeletePrevious
Sezione intitolata “autoDeletePrevious”Configura se il plugin deve eliminare automaticamente i bundle precedenti dopo un aggiornamento riuscito.
Disponibile su Android, iOS ed Electron.
Predefinito: true
{ "plugins": { "CapacitorUpdater": { "autoDeletePrevious": false } }}autoSplashscreen
Sezione intitolata “autoSplashscreen”Obbligatorio con le modalità instant apply (
"atInstall","onLaunch", o"always"), inclusi i valoridirectUpdatedeprecati. Installa@capacitor/splash-screene impostalaunchAutoHide: false. Quando è abilitato, il plugin nasconde lo splashscreen dopo l'applicazione degli aggiornamenti o quando non è necessario alcun aggiornamento. In questo modo non dovrai più ascoltare manualmente gli eventi appReady e chiamare SplashScreen.hide().
Disponibile su Android e iOS.
Predefinito: false
{ "plugins": { "CapacitorUpdater": { "autoUpdate": "atInstall", "autoSplashscreen": true }, "SplashScreen": { "launchAutoHide": false } }}autoUpdate
Sezione intitolata “autoUpdate”Configura come il plugin controlla, scarica e applica gli aggiornamenti live. Il plugin controlla gli aggiornamenti quando l'app passa in foreground e con un timer ricorrente mentre l'app resta aperta.
periodCheckDelaycontrolla l'intervallo del timer. I valori booleani sono ancora supportati per retrocompatibilità:trueè equivalente a"atBackground"efalseè equivalente a"off". I valori stringa combinano la configurazione precedente di Auto Update e Direct Update.
Opzioni:
"off"oppurefalse: Disable automatic update checks"atBackground"oppuretrue: Controlla e scarica automaticamente a ogni controllo in foreground, poi applica l'aggiornamento al prossimo passaggio in background"atInstall": Applica immediatamente solo dopo una nuova installazione o un aggiornamento dall'app store nativo; altrimenti usa"atBackground"comportamento"onLaunch": Applica immediatamente solo quando l'app viene riportata in primo piano da uno stato terminato (cold start). Dopo il primo controllo, passa a"atBackground"comportamento"always": Controlla a ogni transizione in primo piano e applica immediatamente quando è disponibile un aggiornamento"onlyDownload": Controlla e scarica automaticamente, emettiupdateAvailable, e non impostare mai il bundle successivo né applicare un aggiornamento automaticamente
Modalità di applicazione istantanea ("atInstall", "onLaunch", "always") applica mentre l'utente è in attesa. Carica con npx @capgo/cli@latest bundle upload --delta così vengono scaricati solo i file modificati. Un upload completo in zip rallenta 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.
Predefinito: "atBackground" (true è ancora accettata)
{ "plugins": { "CapacitorUpdater": { "autoUpdate": "onlyDownload" } }}channelUrl
Sezione intitolata “channelUrl”Configura l'URL / endpoint per le operazioni sul canale.
Disponibile su Android, iOS ed Electron.
Predefinito: https://plugin.capgo.app/channel_self
{ "plugins": { "CapacitorUpdater": { "channelUrl": "https://example.com/api/channel" } }}defaultChannel
Sezione intitolata “defaultChannel”Imposta il canale predefinito per l'app nella configurazione. Distingue tra maiuscole e minuscole. Questa impostazione sovrascrive il canale predefinito impostato nel cloud, ma rispetta comunque le sovrascritture effettuate nel cloud.
Disponibile su Android, iOS ed Electron.
Predefinito: undefined
{ "plugins": { "CapacitorUpdater": { "defaultChannel": "production" } }}directUpdate
Sezione intitolata “directUpdate”Deprecato. Usa
autoUpdatele modalità string invece:"atInstall","onLaunch", o"always". Questa opzione resta supportata per le app esistenti. Instant apply va caricato con--deltain modo che l'aggiornamento non rallenti l'esperienza utente. Queste modalità richiedonoautoSplashscreen: truee@capacitor/splash-screenconlaunchAutoHide: false.
Opzioni:
false: Non fare mai aggiornamenti diretti'atInstall': Uguale aautoUpdate: "atInstall"'onLaunch': Uguale aautoUpdate: "onLaunch"'always': Uguale aautoUpdate: "always"true: (deprecato) Uguale a"always"per la retrocompatibilità
Disponibile su Android, iOS ed Electron.
Predefinito: false
{ "plugins": { "CapacitorUpdater": { "autoUpdate": "atInstall" } }}disableJSLogging
Sezione intitolata “disableJSLogging”Disabilita il logging JavaScript del plugin. Se true, il plugin non scrive log nella console JavaScript. Verrà fatto solo il log nativo.
Disponibile su Android, iOS ed Electron.
Predefinito: false
{ "plugins": { "CapacitorUpdater": { "disableJSLogging": true } }}keepUrlPathAfterReload
Sezione intitolata “keepUrlPathAfterReload”Configura il plugin per mantenere il percorso dell'URL dopo un reload.
Disponibile su Android, iOS ed Electron.
Predefinito: false
{ "plugins": { "CapacitorUpdater": { "keepUrlPathAfterReload": true } }}periodCheckDelay
Sezione intitolata “periodCheckDelay”Configura il periodo di ritardo per il controllo periodico degli aggiornamenti. L'unità è in secondi. Non può essere inferiore a 600 secondi (10 minuti).
Disponibile su Android, iOS ed Electron.
Predefinito: 600 (10 minuti)
{ "plugins": { "CapacitorUpdater": { "periodCheckDelay": 600 // (10 minutes) } }}publicKey
Sezione intitolata “publicKey”Configura la chiave pubblica per la crittografia end-to-end live update Version 2.
Disponibile su Android, iOS ed Electron.
Predefinito: undefined
{ "plugins": { "CapacitorUpdater": { "publicKey": "YOUR_PUBLIC_KEY" } }}resetWhenUpdate
Sezione intitolata “resetWhenUpdate”Elimina automaticamente i bundle scaricati in precedenza quando sul dispositivo viene installato un bundle nativo dell'app più recente.
Disponibile su Android, iOS ed Electron.
Predefinito: true
{ "plugins": { "CapacitorUpdater": { "resetWhenUpdate": false } }}responseTimeout
Sezione “responseTimeout”Configura quanti millisecondi il plugin nativo deve attendere prima di considerare API in timeout.
Disponibile su Android, iOS ed Electron.
Predefinito: 20 (20 secondi)
{ "plugins": { "CapacitorUpdater": { "responseTimeout": 10 // (10 seconds) } }}shakeMenu
Sezione “shakeMenu”Abilita il gesto di shake per mostrare il menu degli aggiornamenti per debug e test.
Disponibile su Android, iOS ed Electron.
Predefinito: false
{ "plugins": { "CapacitorUpdater": { "shakeMenu": true } }}statsUrl
Sezione intitolata “statsUrl”Configura l'URL / endpoint a cui vengono inviate le statistiche degli aggiornamenti.
Disponibile su Android, iOS ed Electron. Imposta a "" per disabilitare l'invio esplicito delle statistiche tramite /stats.
Disabilitando statsUrl non disabiliti l'intero storage del dispositivo di Capgo. Se updateUrl resta abilitato, /updates continua a memorizzare la riga MAU di fatturazione, l'inventario dei dispositivi e i dati degli eventi di decisione degli update necessari per erogare gli update e contare i MAU. Vedi Conformità per il dettaglio dei singoli campi.
Predefinito: https://plugin.capgo.app/stats
{ "plugins": { "CapacitorUpdater": { "statsUrl": "https://example.com/api/stats" } }}updateUrl
Sezione intitolata “updateUrl”Configura l'URL / endpoint a cui vengono inviate le richieste di controllo aggiornamenti.
Disponibile su Android, iOS ed Electron.
Predefinito: https://plugin.capgo.app/updates
{ "plugins": { "CapacitorUpdater": { "updateUrl": "https://example.com/api/auto_update" } }}version
Sezione intitolata “version”Configura la versione attuale dell'app. Verrà usata per la prima richiesta di aggiornamento. Se non impostata, il plugin recupera la versione dal code nativo.
Disponibile su Android, iOS ed Electron.
Predefinito: undefined
{ "plugins": { "CapacitorUpdater": { "version": "1.0.0" } }}Impostazioni di sviluppo
Sezione intitolata “Impostazioni di sviluppo”localApi
Sezione intitolata “localApi”Configura CLI per usare un api locale per i test.
Predefinito: undefined
{ "plugins": { "CapacitorUpdater": { "localApi": "http://localhost:54321/functions/v1" } }}localApiFiles
Sezione intitolata “localApiFiles”Configura CLI per usare un file api locale per i test.
Predefinito: undefined
{ "plugins": { "CapacitorUpdater": { "localApiFiles": "http://localhost:54321/functions/v1/files" } }}localHost
Sezione intitolata “localHost”Configura CLI per usare un server locale per i test o un server di update self-hosted.
Predefinito: undefined
{ "plugins": { "CapacitorUpdater": { "localHost": "http://localhost:5173" } }}localSupa
Sezione intitolata “localSupa”Configura CLI per usare un server locale per i test o un server di update self-hosted.
Predefinito: undefined
{ "plugins": { "CapacitorUpdater": { "localSupa": "http://localhost:54321" } }}localSupaAnon
Sezione intitolata “localSupaAnon”Configura CLI per usare un server locale per i test.
Predefinito: undefined
{ "plugins": { "CapacitorUpdater": { "localSupaAnon": "YOUR_LOCAL_ANON_KEY" } }}localWebHost
Sezione intitolata “localWebHost”Configura CLI per usare un server locale per i test o un server di update self-hosted.
Predefinito: undefined
{ "plugins": { "CapacitorUpdater": { "localWebHost": "http://localhost:5173" } }}Continua dalle Impostazioni
Sezione intitolata “Continua dalle Impostazioni”Se stai usando Impostazioni per pianificare le operazioni della dashboard e di API, collegalo a Usando @capgo/capacitor-updater per la funzionalità nativa in Usando @capgo/capacitor-updater, Panoramica API per i dettagli di implementazione in Panoramica di API, Introduzione per i dettagli di implementazione in Introduzione, Chiavi API per i dettagli di implementazione in Chiavi API, e Dispositivi per i dettagli di implementazione in Dispositivi.