Saltare al contenuto

Impostazioni

GitHub

Per avere un controllo più fine sulla gestione degli aggiornamenti, puoi configurarla con questi impostazioni:

Consenti al plugin di modificare dinamicamente updateUrl, statsUrl e channelUrl da parte del lato JavaScript.

Disponibile su Android, iOS e Electron.

Predefinito: false

capacitor.config.json
{
"plugins": {
"CapacitorUpdater": {
"allowModifyUrl": true
}
}
}

Configura l'ID dell'app per l'app nel config.

Disponibile su Android, iOS e Electron.

Predefinito: undefined

capacitor.config.json
{
"plugins": {
"CapacitorUpdater": {
"appId": "com.example.app"
}
}
}

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)

capacitor.config.json
{
"plugins": {
"CapacitorUpdater": {
"appReadyTimeout": 1000
}
}
}

Configura se il plugin dovrebbe cancellare automaticamente i bundle falliti.

Disponibile su Android, iOS e Electron.

Predefinito: true

capacitor.config.json
{
"plugins": {
"CapacitorUpdater": {
"autoDeleteFailed": false
}
}
}

Configura se il plugin dovrebbe eliminare automaticamente i bundle precedenti dopo un aggiornamento riuscito.

Disponibile su Android, iOS e Electron.

Predefinito: true

capacitor.config.json
{
"plugins": {
"CapacitorUpdater": {
"autoDeletePrevious": false
}
}
}

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

capacitor.config.json
{
"plugins": {
"CapacitorUpdater": {
"autoUpdate": "atInstall",
"autoSplashscreen": true
}
}
}

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. periodCheckDelay Controlla l'intervallo di quel timer. I valori booleani sono ancora supportati per la compatibilità con le versioni precedenti: true è lo stesso di "atBackground" e false è lo stesso di "off". I valori di stringa uniscono le configurazioni precedenti di Aggiornamento Automatico e Aggiornamento Diretto.

Opzioni:

  • "off" o false: Disabilita le verifiche di aggiornamento automatiche
  • "atBackground" o true: 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, emette updateAvailable, e non impostare mai il prossimo pacchetto o applicare un aggiornamento automaticamente

Disponibile su Android, iOS e Electron.

Predefinito: "atBackground" (true è ancora accettato)

capacitor.config.json
{
"plugins": {
"CapacitorUpdater": {
"autoUpdate": "onlyDownload"
}
}
}

Configura l'URL / endpoint per le operazioni di canale.

Disponibile su Android, iOS e Electron.

Predefinito: https://plugin.capgo.app/channel_self

capacitor.config.json
{
"plugins": {
"CapacitorUpdater": {
"channelUrl": "https://example.com/api/channel"
}
}
}

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

capacitor.config.json
{
"plugins": {
"CapacitorUpdater": {
"defaultChannel": "production"
}
}
}

Obsoleto. Utilizza autoUpdate modi 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 di autoUpdate: "atInstall"
  • 'onLaunch': Lo stesso autoUpdate: "onLaunch"
  • 'always': Lo stesso autoUpdate: "always"
  • true: (deprecated) Lo stesso "always" per compatibilità con il passato

Disponibile su Android, iOS e Electron.

Predefinito: false

capacitor.config.json
{
"plugins": {
"CapacitorUpdater": {
"autoUpdate": "atInstall"
}
}
}

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

capacitor.config.json
{
"plugins": {
"CapacitorUpdater": {
"disableJSLogging": true
}
}
}

Configura il plugin per mantenere la strada URL dopo un riavvio.

Disponibile su Android, iOS e Electron.

Predefinito: false

capacitor.config.json
{
"plugins": {
"CapacitorUpdater": {
"keepUrlPathAfterReload": true
}
}
}

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)

capacitor.config.json
{
"plugins": {
"CapacitorUpdater": {
"periodCheckDelay": 600 // (10 minutes)
}
}
}

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

capacitor.config.json
{
"plugins": {
"CapacitorUpdater": {
"publicKey": "YOUR_PUBLIC_KEY"
}
}
}

Elimina automaticamente i bundle scaricati precedentemente quando viene installato un bundle nativo più recente sul dispositivo.

Disponibile su Android, iOS e Electron.

Predefinito: true

capacitor.config.json
{
"plugins": {
"CapacitorUpdater": {
"resetWhenUpdate": false
}
}
}

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)

capacitor.config.json
{
"plugins": {
"CapacitorUpdater": {
"responseTimeout": 10 // (10 seconds)
}
}
}

Abilita il gesto di scuotimento per visualizzare il menu di aggiornamento per scopi di debug/test.

Disponibile su Android, iOS e Electron.

Predefinito: false

capacitor.config.json
{
"plugins": {
"CapacitorUpdater": {
"shakeMenu": true
}
}
}

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

capacitor.config.json
{
"plugins": {
"CapacitorUpdater": {
"statsUrl": "https://example.com/api/stats"
}
}
}

Configura l'URL / endpoint a cui vengono inviate le verifiche degli aggiornamenti.

Disponibile su Android, iOS e Electron.

Predefinito: https://plugin.capgo.app/updates

capacitor.config.json
{
"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

capacitor.config.json
{
"plugins": {
"CapacitorUpdater": {
"version": "1.0.0"
}
}
}

Configura il CLI per utilizzare un api locale per le prove.

Predefinito: undefined

Impostazioni del file di configurazione `capacitor.config.json`
{
"plugins": {
"CapacitorUpdater": {
"localApi": "http://localhost:54321/functions/v1"
}
}
}

Configura il `CLI` per utilizzare un file locale `api` per le prove.

Predefinito: undefined

Impostazioni del file di configurazione `capacitor.config.json`
{
"plugins": {
"CapacitorUpdater": {
"localApiFiles": "http://localhost:54321/functions/v1/files"
}
}
}

Configura il `CLI` per utilizzare un server locale per le prove o per un aggiornamento auto-hosted.

Predefinito: undefined

Impostazioni del file di configurazione `capacitor.config.json`
{
"plugins": {
"CapacitorUpdater": {
"localHost": "http://localhost:5173"
}
}
}

Configura il CLI per utilizzare un server locale per le prove o un server di aggiornamento auto-hosted.

Default: undefined

capacitor.config.json
{
"plugins": {
"CapacitorUpdater": {
"localSupa": "http://localhost:54321"
}
}
}

Configura il CLI per utilizzare un server locale per le prove.

Default: undefined

capacitor.config.json
{
"plugins": {
"CapacitorUpdater": {
"localSupaAnon": "YOUR_LOCAL_ANON_KEY"
}
}
}

Configura il CLI per utilizzare un server locale per le prove o un server di aggiornamento auto-hosted.

Default: undefined

capacitor.config.json
{
"plugins": {
"CapacitorUpdater": {
"localWebHost": "http://localhost:5173"
}
}
}

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.