Impostazioni

Per avere un controllo più granulare sul sistema di aggiornamento, puoi configurarlo con queste impostazioni:

Tip

Qualsiasi modifica a queste impostazioni nel file capacitor.config richiede il sync della piattaforma e il rilascio sullo store affinché le app in produzione le ricevano.

Nota

Ti serve la data residency UE per Capgo Cloud? Imposta updateUrl a https://plugin.eu.capgo.app/updates, statsUrl a https://plugin.eu.capgo.app/stats, e channelUrl a https://plugin.eu.capgo.app/channel_self. Consulta Ubicazione dati.

Per usare il tuo hostname per updateUrl, statsUrl, e channelUrl, vedi Configurazione Custom Domain.

allowModifyUrl

Consente al plugin di modificare dinamicamente updateUrl, statsUrl e channelUrl dal lato JavaScript.

Disponibile su Android, iOS ed Electron.

Predefinito: false

capacitor.config.json

{
  "plugins": {
    "CapacitorUpdater": {
      "allowModifyUrl": true
    }
  }
}

appId

Configura l'app id per l'app nella config.

Disponibile su Android, iOS ed Electron.

Predefinito: undefined

capacitor.config.json

{
  "plugins": {
    "CapacitorUpdater": {
      "appId": "com.example.app"
    }
  }
}

appReadyTimeout

Configura i millisecondi di attesa del plugin nativo prima di considerare un aggiornamento come ‘fallito’.

Disponibile su Android, iOS ed Electron.

Predefinito: 10000 (10 secondi)

capacitor.config.json

{
  "plugins": {
    "CapacitorUpdater": {
      "appReadyTimeout": 1000
    }
  }
}

autoDeleteFailed

Configura se il plugin deve eliminare automaticamente i bundle falliti.

Disponibile su Android, iOS ed Electron.

Predefinito: true

capacitor.config.json

{
  "plugins": {
    "CapacitorUpdater": {
      "autoDeleteFailed": false
    }
  }
}

autoDeletePrevious

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

Disponibile su Android, iOS ed Electron.

Predefinito: true

capacitor.config.json

{
  "plugins": {
    "CapacitorUpdater": {
      "autoDeletePrevious": false
    }
  }
}

autoSplashscreen

Obbligatorio con le modalità instant apply ("atInstall", "onLaunch", o "always"), inclusi i valori directUpdate deprecati. Installa @capacitor/splash-screen e imposta launchAutoHide: 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

capacitor.config.json

{
  "plugins": {
    "CapacitorUpdater": {
      "autoUpdate": "atInstall",
      "autoSplashscreen": true
    },
    "SplashScreen": {
      "launchAutoHide": false
    }
  }
}

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. periodCheckDelay controlla l'intervallo del timer. I valori booleani sono ancora supportati per retrocompatibilità: true è equivalente a "atBackground" e false è equivalente a "off". I valori stringa combinano la configurazione precedente di Auto Update e Direct Update.

Opzioni:

• "off" o false: Disable automatic update checks
• "atBackground" o true: 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 degli store; altrimenti usa il "atBackground" comportamento
• "onLaunch": Applica immediatamente solo quando l'app viene riportata in primo piano da uno stato di chiusura (cold start). Dopo il primo controllo, passa a "atBackground" comportamento
• "always": Controlla ad ogni transizione in foreground e applica immediatamente quando un aggiornamento è disponibile
• "onlyDownload": Controlla e scarica automaticamente, emette updateAvailable, e non imposta mai il prossimo bundle o applica 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 dello zip rallenta l'esperienza utente. Su Android e iOS questi modi richiedono autoSplashscreen: true e @capacitor/splash-screen con launchAutoHide: false.

Disponibile su Android, iOS ed Electron.

Predefinito: "atBackground" (true è ancora accettato)

capacitor.config.json

{
  "plugins": {
    "CapacitorUpdater": {
      "autoUpdate": "onlyDownload"
    }
  }
}

channelUrl

Configura l'URL o l'endpoint per le operazioni del canale.

Disponibile su Android, iOS ed Electron.

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

capacitor.config.json

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

defaultChannel

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.

Disponibile su Android, iOS ed Electron.

Predefinito: undefined

capacitor.config.json

{
  "plugins": {
    "CapacitorUpdater": {
      "defaultChannel": "production"
    }
  }
}

directUpdate

Deprecato. Usa autoUpdate le modalità stringa invece: "atInstall", "onLaunch", o "always". Questa opzione rimane supportata per le app esistenti. L'applicazione istantanea deve essere caricata con --delta per evitare che l'update rallenti l'esperienza utente. Queste modalità richiedono autoSplashscreen: true e @capacitor/splash-screen con launchAutoHide: false.

Opzioni:

• false: Non fare mai aggiornamenti diretti
• 'atInstall': Uguale a autoUpdate: "atInstall"
• 'onLaunch': Uguale a autoUpdate: "onLaunch"
• 'always': Uguale a autoUpdate: "always"
• true: (deprecato) Uguale a "always" per la retrocompatibilità

Disponibile su Android, iOS ed Electron.

Predefinito: false

capacitor.config.json

{
  "plugins": {
    "CapacitorUpdater": {
      "autoUpdate": "atInstall"
    }
  }
}

disableJSLogging

Disabilita il logging JavaScript del plugin. Se impostato su true, il plugin non scriverà sulla console JavaScript. Verrà eseguito solo il log nativo.

Disponibile su Android, iOS ed Electron.

Predefinito: false

capacitor.config.json

{
  "plugins": {
    "CapacitorUpdater": {
      "disableJSLogging": true
    }
  }
}

keepUrlPathAfterReload

Configura il plugin per mantenere il percorso URL dopo un reload.

Attenzione

Quando viene attivato un reload, ‘window.history’ verrà svuotato.

Disponibile su Android, iOS ed Electron.

Predefinito: false

capacitor.config.json

{
  "plugins": {
    "CapacitorUpdater": {
      "keepUrlPathAfterReload": true
    }
  }
}

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)

capacitor.config.json

{
  "plugins": {
    "CapacitorUpdater": {
      "periodCheckDelay": 600 // (10 minutes)
    }
  }
}

publicKey

Configura la chiave pubblica per la crittografia end-to-end live update Version 2.

Disponibile su Android, iOS ed Electron.

Predefinito: undefined

capacitor.config.json

{
  "plugins": {
    "CapacitorUpdater": {
      "publicKey": "YOUR_PUBLIC_KEY"
    }
  }
}

Attenzione

publicKey configura Encryption V2 e deve corrispondere alla chiave privata usata durante l'upload. Per gli aggiornamenti Delta, usa la crittografia V2 con partial encryption abilitata e attiva l'enforcement di encrypted-bundle se la tua organizzazione richiede che ogni upload sia criptato. Non affidarti solo a publicKey come policy lato server per impedire la pubblicazione di Delta non criptati.

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

capacitor.config.json

{
  "plugins": {
    "CapacitorUpdater": {
      "resetWhenUpdate": false
    }
  }
}

responseTimeout

Configura i millisecondi di attesa del plugin nativo prima di considerare il timeout di API.

Disponibile su Android, iOS ed Electron.

Predefinito: 20 (20 secondi)

capacitor.config.json

{
  "plugins": {
    "CapacitorUpdater": {
      "responseTimeout": 10 // (10 seconds)
    }
  }
}

shakeMenu

Abilita il gesto dello shake per mostrare il menu degli update per debugging o test.

Disponibile su Android, iOS ed Electron.

Predefinito: false

capacitor.config.json

{
  "plugins": {
    "CapacitorUpdater": {
      "shakeMenu": true
    }
  }
}

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

capacitor.config.json

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

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

capacitor.config.json

{
  "plugins": {
    "CapacitorUpdater": {
      "updateUrl": "https://example.com/api/auto_update"
    }
  }
}

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

capacitor.config.json

{
  "plugins": {
    "CapacitorUpdater": {
      "version": "1.0.0"
    }
  }
}

Impostazioni di Sviluppo

localApi

Configura CLI per usare un api locale per i test.

Predefinito: undefined

capacitor.config.json

{
  "plugins": {
    "CapacitorUpdater": {
      "localApi": "http://localhost:54321/functions/v1"
    }
  }
}

localApiFiles

Configura CLI per usare un file api locale per i test.

Predefinito: undefined

capacitor.config.json

{
  "plugins": {
    "CapacitorUpdater": {
      "localApiFiles": "http://localhost:54321/functions/v1/files"
    }
  }
}

localHost

Configura CLI per usare un server locale per i test o un server di update self-hosted.

Predefinito: undefined

capacitor.config.json

{
  "plugins": {
    "CapacitorUpdater": {
      "localHost": "http://localhost:5173"
    }
  }
}

localSupa

Configura CLI per usare un server locale per i test o un server di update self-hosted.

Predefinito: undefined

capacitor.config.json

{
  "plugins": {
    "CapacitorUpdater": {
      "localSupa": "http://localhost:54321"
    }
  }
}

localSupaAnon

Configura CLI per usare un server locale per i test.

Predefinito: undefined

capacitor.config.json

{
  "plugins": {
    "CapacitorUpdater": {
      "localSupaAnon": "YOUR_LOCAL_ANON_KEY"
    }
  }
}

localWebHost

Configura CLI per usare un server locale per i test o un server di update self-hosted.

Predefinito: undefined

capacitor.config.json

{
  "plugins": {
    "CapacitorUpdater": {
      "localWebHost": "http://localhost:5173"
    }
  }
}

Tip

Sono disponibili impostazioni aggiuntive nella web app Capgo configurabili per ogni canale senza dover rilasciare una nuova versione nativa.

Continua da 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.