Impostazioni
Copiare un prompt di configurazione con i passaggi di installazione e la guida markdown completa per questo plugin.
Per avere un controllo più fine sulla gestione degli aggiornamenti, puoi configurarla con questi impostazioni:
allowModifyUrl
Sezione intitolata “allowModifyUrl”Consenti al plugin di modificare dinamicamente updateUrl, statsUrl e channelUrl da parte del lato JavaScript.
Disponibile su Android, iOS e Electron.
Predefinito: false
{ "plugins": { "CapacitorUpdater": { "allowModifyUrl": true } }}Configura l'ID dell'app per l'app nel config.
Disponibile su Android, iOS e Electron.
Predefinito: undefined
{ "plugins": { "CapacitorUpdater": { "appId": "com.example.app" } }}appReadyTimeout
Sezione intitolata “appReadyTimeout”Configura il numero di millisecondi che il plugin nativo dovrebbe attendere prima di considerare un aggiornamento ‘fallito’.
Disponibile su Android, iOS e Electron.
Predefinito: 10000 (10 secondi)
{ "plugins": { "CapacitorUpdater": { "appReadyTimeout": 1000 } }}autoDeleteFailed
Sezione intitolata “autoDeleteFailed”Configura se il plugin dovrebbe cancellare automaticamente i bundle falliti.
Disponibile su Android, iOS e Electron.
Predefinito: true
{ "plugins": { "CapacitorUpdater": { "autoDeleteFailed": false } }}autoDeletePrevious
Sezione intitolata “eliminaPrecedenti”Configura se il plugin dovrebbe eliminare automaticamente i bundle precedenti dopo un aggiornamento riuscito.
Disponibile su Android, iOS e Electron.
Predefinito: true
{ "plugins": { "CapacitorUpdater": { "autoDeletePrevious": false } }}autoSplashscreen
Sezione intitolata “schermoDiBenvenuto”Gestisci automaticamente la rimozione dello schermo di benvenuto quando si utilizzano modalità di applicazione istantanea. Quando abilitato, il plugin eliminerà automaticamente lo schermo di benvenuto dopo gli aggiornamenti sono stati applicati o quando non è necessario alcun aggiornamento. Ciò elimina la necessità di ascoltare manualmente gli eventi appReady e di chiamare SplashScreen.hide(). Funziona solo quando
autoUpdateè impostato su"atInstall","onLaunch", o"always". Valori legacy sono ancora supportati per la compatibilità con le versioni precedenti. Richiede l'installazione e la configurazione del plugin @__CAPGO_KEEP_0__/splash-screen con launchAutoHide impostato su false. Richiede l'abilitazione dell'aggiornamento automatico.directUpdatevalues are still supported for backward compatibility. Requires the @capacitor/splash-screen plugin to be installed and configured with launchAutoHide: false. Requires Auto Update to be enabled.
Disponibile su Android, iOS e Electron.
Predefinito: false
{ "plugins": { "CapacitorUpdater": { "autoUpdate": "atInstall", "autoSplashscreen": true } }}autoUpdate
Sottosezione intitolata “autoUpdate”Configura come il plugin controlla le nuove versioni, le scarica e le applica in tempo reale. Il plugin controlla le nuove versioni quando l'app si sposta in primo piano e su un timer ripetuto mentre l'app rimane aperta.
periodCheckDelayControlla l'intervallo di quel timer. I valori booleani sono ancora supportati per la compatibilità con le versioni precedenti:trueè lo stesso di"atBackground"efalseè lo stesso di"off". I valori di stringa uniscono le configurazioni precedenti di Aggiornamento Automatico e Aggiornamento Diretto.
Opzioni:
"off"ofalse: Disabilita le verifiche di aggiornamento automatiche"atBackground"otrue: Verifica e scarica automaticamente ogni volta che si esegue il controllo in primo piano, quindi applica l'aggiornamento la prossima volta che l'app si sposta in background"atInstall": Applica immediatamente solo dopo un installazione fresca o un aggiornamento dell'applicazione nativa; altrimenti utilizza"atBackground"comportamento"onLaunch": Applica immediatamente solo quando l'app viene riportata in primo piano da uno stato ucciso (avvio freddo). Dopo il primo controllo, ricade su"atBackground"comportamento"always": Verifica ogni volta che si esegue il controllo in primo piano e applica immediatamente ogni volta che è disponibile un aggiornamento"onlyDownload": Verifica e scarica automaticamente, emetteupdateAvailable, e non impostare mai il prossimo pacchetto o applicare un aggiornamento automaticamente
Disponibile su Android, iOS e Electron.
Predefinito: "atBackground" (true è ancora accettato)
{ "plugins": { "CapacitorUpdater": { "autoUpdate": "onlyDownload" } }}channelUrl
Sezione intitolata “canaleUrl”Configura l'URL / endpoint per le operazioni di canale.
Disponibile su Android, iOS e Electron.
Predefinito: https://plugin.capgo.app/channel_self
{ "plugins": { "CapacitorUpdater": { "channelUrl": "https://example.com/api/channel" } }}defaultChannel
Sezione intitolata “canalePredefinito”Imposta il canale predefinito per l'app nella configurazione. Sensitive al caso. Questa impostazione sovrascriverà il canale predefinito impostato nel cloud, ma rispetterà comunque gli override fatti nel cloud.
Disponibile su Android, iOS e Electron.
Predefinito: undefined
{ "plugins": { "CapacitorUpdater": { "defaultChannel": "production" } }}directUpdate
Sezione intitolata “directUpdate”Obsoleto. Utilizza
autoUpdatemodi di stringa invece:"atInstall","onLaunch", o"always". Questa opzione rimane supportata per le app esistenti.
Opzioni:
false: Non eseguire mai aggiornamenti diretti'atInstall': Lo stesso diautoUpdate: "atInstall"'onLaunch': Lo stessoautoUpdate: "onLaunch"'always': Lo stessoautoUpdate: "always"true: (deprecated) Lo stesso"always"per compatibilità con il passato
Disponibile su Android, iOS e Electron.
Predefinito: false
{ "plugins": { "CapacitorUpdater": { "autoUpdate": "atInstall" } }}disableJSLogging
Sottosezione intitolata “disableJSLogging”Disabilita la registrazione JavaScript del plugin. Se true, il plugin non registrerà nella console JavaScript. Sarà fatto solo il log nativo.
Disponibile su Android, iOS e Electron.
Predefinito: false
{ "plugins": { "CapacitorUpdater": { "disableJSLogging": true } }}keepUrlPathAfterReload
Sezione intitolata “keepUrlPathAfterReload”Configura il plugin per mantenere la strada URL dopo un riavvio.
Disponibile su Android, iOS e Electron.
Predefinito: false
{ "plugins": { "CapacitorUpdater": { "keepUrlPathAfterReload": true } }}periodCheckDelay
Sezione intitolata “periodCheckDelay”Configura il periodo di attesa per il controllo di aggiornamento periodico. L'unità è in secondi. Non può essere inferiore a 600 secondi (10 minuti).
Disponibile su Android, iOS e Electron.
Predefinito: 600 (10 minuti)
{ "plugins": { "CapacitorUpdater": { "periodCheckDelay": 600 // (10 minutes) } }}publicKey
Sezione intitolata “publicKey”Configura la chiave pubblica per l'aggiornamento in tempo reale end-to-end con crittografia Versione 2.
Disponibile su Android, iOS e Electron.
Predefinito: undefined
{ "plugins": { "CapacitorUpdater": { "publicKey": "YOUR_PUBLIC_KEY" } }}resetWhenUpdate
Sezione intitolata “resetWhenUpdate”Elimina automaticamente i bundle scaricati precedentemente quando viene installato un bundle nativo più recente sul dispositivo.
Disponibile su Android, iOS e Electron.
Predefinito: true
{ "plugins": { "CapacitorUpdater": { "resetWhenUpdate": false } }}responseTimeout
Sezione intitolata “responseTimeout”Configura il numero di millisecondi che il plugin nativo dovrebbe attendere prima di considerare API come timeout.
Disponibile su Android, iOS e Electron.
Predefinito: 20 (20 secondi)
{ "plugins": { "CapacitorUpdater": { "responseTimeout": 10 // (10 seconds) } }}shakeMenu
Sezione intitolata “shakeMenu”Abilita il gesto di scuotimento per visualizzare il menu di aggiornamento per scopi di debug/test.
Disponibile su Android, iOS e Electron.
Predefinito: false
{ "plugins": { "CapacitorUpdater": { "shakeMenu": true } }}statsUrl
Sezione intitolata “statsUrl”Configura l'URL/punto di accesso a cui vengono inviate le statistiche di aggiornamento.
Disponibile su Android, iOS e Electron. Impostalo su "" per disabilitare la registrazione esplicita delle statistiche tramite /stats.
Disabilitare statsUrl non disabilita tutti i dati di archiviazione del dispositivo Capgo. updateUrl rimane abilitato, /updates immagazzina ancora la riga di fatturazione MAU, l'inventario dei dispositivi e i dati degli eventi di aggiornamento necessari per servire gli aggiornamenti e conteggiare MAU. Vedi Conformità per il dettaglio per campo.
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 verifiche degli aggiornamenti.
Disponibile su Android, iOS e Electron.
Predefinito: https://plugin.capgo.app/updates
{ "plugins": { "CapacitorUpdater": { "updateUrl": "https://example.com/api/auto_update" } }}Configura la versione corrente dell'app. Questa verrà utilizzata per la prima richiesta di aggiornamento. Se non impostata, il plugin otterrà la versione dal nativo code.
Disponibile su Android, iOS e Electron.
Predefinito: undefined
{ "plugins": { "CapacitorUpdater": { "version": "1.0.0" } }}Impostazioni di sviluppo
Sottosezione intitolata “Impostazioni di sviluppo”Configura il CLI per utilizzare un api locale per le prove.
Predefinito: undefined
{ "plugins": { "CapacitorUpdater": { "localApi": "http://localhost:54321/functions/v1" } }}localApiFiles
Sezione intitolata “localApiFiles”Configura il `CLI` per utilizzare un file locale `api` per le prove.
Predefinito: undefined
{ "plugins": { "CapacitorUpdater": { "localApiFiles": "http://localhost:54321/functions/v1/files" } }}localHost
Sezione intitolata “localHost”Configura il `CLI` per utilizzare un server locale per le prove o per un aggiornamento auto-hosted.
Predefinito: undefined
{ "plugins": { "CapacitorUpdater": { "localHost": "http://localhost:5173" } }}localSupa
Sezione intitolata “localSupa”Configura il CLI per utilizzare un server locale per le prove o un server di aggiornamento auto-hosted.
Default: undefined
{ "plugins": { "CapacitorUpdater": { "localSupa": "http://localhost:54321" } }}localSupaAnon
Sezione intitolata “localSupaAnon”Configura il CLI per utilizzare un server locale per le prove.
Default: undefined
{ "plugins": { "CapacitorUpdater": { "localSupaAnon": "YOUR_LOCAL_ANON_KEY" } }}localWebHost
Sezione intitolata “localWebHost”Configura il CLI per utilizzare un server locale per le prove o un server di aggiornamento auto-hosted.
Default: undefined
{ "plugins": { "CapacitorUpdater": { "localWebHost": "http://localhost:5173" } }}Continua da Impostazioni
Sezione intitolata “Continua da Impostazioni”Se stai utilizzando Impostazioni per pianificare il dashboard e le API operazioni, connettilo con Utilizza @capgo/capacitor-aggiornatore per la capacità nativa in Utilizza @capgo/capacitor-aggiornatore, API Panoramica per i dettagli di implementazione in API Panoramica, Introduzione per i dettagli di implementazione in Introduzione, API Chiavi per i dettagli di implementazione in API Chiavi, e Dispositivi per i dettagli di implementazione in Dispositivi.