Saltare al contenuto

Impostazioni

GitHub

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

Consenti al plugin di modificare dinamicamente l'updateUrl, statsUrl e channelUrl dal 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 nella configurazione.

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 eliminare 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 nasconderà automaticamente lo schermo di benvenuto dopo l'applicazione degli aggiornamenti o quando non è necessario alcun aggiornamento. Questo 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.

Predefinito:

__CAPGO_KEEP_0__.config.json false

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

Configura come il plugin dovrebbe utilizzare l'aggiornamento automatico tramite un server di aggiornamento. I valori booleani sono ancora supportati per la compatibilità con il passato: true è lo stesso di "atBackground" e false è lo stesso di "off".

Opzioni:

  • "off" o false: Disabilita l'aggiornamento automatico
  • "atBackground" o true: Controlla e scarica automaticamente, quindi applica quando l'app si sposta in background
  • "atInstall": Applica immediatamente solo dopo un installazione fresca o un aggiornamento dell'app nativa, altrimenti utilizza "atBackground"
  • "onLaunch": Applica immediatamente al lancio, altrimenti utilizza "atBackground" dopo il lancio controlla
  • "always": Applica immediatamente ogni volta che esegui l'aggiornamento automatico
  • "onlyDownload": Controlla e scarica automaticamente, emiti updateAvailable, e non impostare mai il prossimo bundle 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. La sensibilità di caso è importante. Questa impostazione sovrascriverà il canale predefinito impostato nel cloud, ma rispetterà comunque le sovrascritture effettuate nel cloud.

Disponibile su Android, iOS e Electron.

Predefinito: undefined

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

Obsoleto. Utilizza invece le modalità di stringa: autoUpdate string modes "atInstall", "onLaunch"o "always"Oppure

Opzioni:

  • false: Mai eseguire aggiornamenti diretti
  • 'atInstall': Uguale a autoUpdate: "atInstall"
  • 'onLaunch': Uguale a autoUpdate: "onLaunch"
  • 'always': Uguale a autoUpdate: "always"
  • true: (deprecated) Uguale a “sempre” per compatibilità con il passato

Disponibile su Android, iOS e Electron.

Predefinito: false

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

Disabilita il logging JavaScript del plugin. Se vero, il plugin non loggerà 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 il percorso URL dopo una ricarica.

Disponibile su Android, iOS e Electron.

Predefinito: false

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

Configura il periodo di ritardo 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'encryption degli aggiornamenti in tempo reale a fine a fine. Versione 2.

Disponibile su Android, iOS e Electron.

Predefinito: undefined

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

Elimina automaticamente le precedenti bundle scaricate 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 / endpoint a cui vengono inviate le statistiche di aggiornamento.

Disponibile su Android, iOS e Electron. Impostalo su "" per disabilitare la registrazione esplicita delle statistiche. /stats.

Disabilita statsUrl Non disabilita tutti i dati di archiviazione del dispositivo Capgo. Se updateUrl rimane abilitato, /updates continua a memorizzare la riga di fatturazione MAU, l'inventario dei dispositivi e i dati degli eventi di decisione 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 di aggiornamento.

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. Questo verrà utilizzato per la prima richiesta di aggiornamento. Se non viene impostato, il plugin ottiene 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

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

capacitor.config.json
{
"plugins": {
"CapacitorUpdater": {
"localApiFiles": "http://localhost:54321/functions/v1/files"
}
}
}

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": {
"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.

Predefinito: undefined

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

Se stai utilizzando Impostazioni per pianificare il dashboard e le operazioni API, collega il tuo account con Utilizza @capgo/capacitor-aggiornatore per la capacità nativa in Utilizza @capgo/capacitor-aggiornatore, Panoramica di API per i dettagli di implementazione in Panoramica di API, Introduzione per i dettagli di implementazione in Introduzione, Chiavi di API per i dettagli di implementazione in API Chiavi, e Dispositivi per i dettagli di implementazione in Dispositivi.