Impostazioni

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

Suggerimento

Qualsiasi modifica a queste impostazioni nel file capacitor.config richiede la sincronizzazione della piattaforma e la rilascio sullo store per gli app di produzione riceverle.

Nota

Hai bisogno di risidenza dei dati 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. Vedi Posizione dei dati.

allowModifyUrl

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
    }
  }
}

appId

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

Disponibile su Android, iOS e Electron.

Predefinito: undefined

capacitor.config.json

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

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)

capacitor.config.json

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

autoDeleteFailed

Configura se il plugin dovrebbe cancellare automaticamente le bundle fallite.

Disponibile su Android, iOS e Electron.

Predefinito: true

capacitor.config.json

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

autoDeletePrevious

Configura se il plugin dovrebbe cancellare automaticamente le bundle precedenti dopo un aggiornamento riuscito.

Disponibile su Android, iOS e Electron.

Predefinito: true

capacitor.config.json

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

autoSplashscreen

Gestisci automaticamente la rimozione dello schermo di benvenuto quando si utilizzano modalità di applicazione istantanea. Se 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
    }
  }
}

autoUpdate

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 pacchetto automaticamente

Disponibile su Android, iOS e Electron.

Predefinito: "atBackground" (true è ancora accettato)

capacitor.config.json

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

channelUrl

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

Disponibile su Android, iOS e Electron.

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

capacitor.config.json

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

defaultChannel

Imposta il canale predefinito per l'app nella config. La casella è sensibile. Questa impostazione sovrascriverà il canale predefinito impostato in cloud, ma rispetterà comunque gli override fatti in cloud.

Disponibile su Android, iOS e Electron.

Default: undefined

capacitor.config.json

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

directUpdate

Obsoleto. Utilizza autoUpdate stringhe di modalità invece: "atInstall", "onLaunch"o oppure "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 di autoUpdate: "onLaunch"
• 'always': Lo stesso di autoUpdate: "always"
• true: (deprecated) Lo stesso di “sempre” per compatibilità con il passato

Disponibile su Android, iOS e Electron.

Predefinito: false

capacitor.config.json

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

disableJSLogging

Disabilita la registrazione del logging 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
    }
  }
}

keepUrlPathAfterReload

Configura il plugin per mantenere il percorso URL dopo una ricarica.

Attenzione

Quando viene attivata una ricarica, ‘window.history’ verrà resettato.

Disponibile su Android, iOS e Electron.

Predefinito: false

capacitor.config.json

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

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)

capacitor.config.json

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

publicKey

Configura la chiave pubblica per l'encryption end-to-end degli aggiornamenti in tempo reale, versione 2.

Disponibile su Android, iOS e Electron.

Predefinito: undefined

capacitor.config.json

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

resetWhenUpdate

Elimina automaticamente le versioni precedenti dei bundle scaricati quando viene installato un bundle nativo più recente sull'apparecchio.

Disponibile su Android, iOS e Electron.

Predefinito: true

capacitor.config.json

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

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)

capacitor.config.json

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

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

capacitor.config.json

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

statsUrl

Configura l'URL / endpoint a cui vengono inviate le statistiche di aggiornamento.

Disponibile su Android, iOS e Electron. Imposta su "" per disabilitare la registrazione delle statistiche.

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 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"
    }
  }
}

version

Configura la versione corrente dell'app. Questo verrà utilizzato per la prima richiesta di aggiornamento. Se non impostato, 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"
    }
  }
}

Impostazioni di sviluppo

localApi

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

Predefinito: undefined

capacitor.config.json

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

localApiFiles

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"
    }
  }
}

localHost

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": {
      "localHost": "http://localhost:5173"
    }
  }
}

localSupa

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": {
      "localSupa": "http://localhost:54321"
    }
  }
}

localSupaAnon

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

Predefinito: undefined

capacitor.config.json

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

localWebHost

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

Predefinito: undefined

capacitor.config.json

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

Suggerimento

Ci sono ulteriori impostazioni disponibili nell'applicazione web Capgo che possono essere configurate per canale senza richiedere una rilascio dell'app nativa.

Continua da Impostazioni

Se stai utilizzando Impostazioni per pianificare dashboard e API operazioni, connettilo con Utilizzando @capgo/capacitor-aggiornatore per la capacità nativa in Utilizzo di @capgo/capacitor-aggiornatore, API Panoramica per il dettaglio di implementazione in API Panoramica, Introduzione per il dettaglio di implementazione in Introduzione, API Chiavi per il dettaglio di implementazione in API Chiavi, e Dispositivi per il dettaglio di implementazione in Dispositivi.