Impostazioni

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

Consiglio

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

Nota

Hai bisogno di una residenza dati UE per Capgo Cloud? Imposta updateUrl a https://plugin.eu.capgo.app/updates, statsUrl per https://plugin.eu.capgo.app/stats, e channelUrl per https://plugin.eu.capgo.app/channel_self. Vedi Posizione dei dati.

Per utilizzare il tuo proprio hostname per updateUrl, statsUrl, e channelUrl, vedi Configurazione del dominio personalizzato.

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 nel 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 eliminare automaticamente i bundle falliti.

Disponibile su Android, iOS e Electron.

Predefinito: true

capacitor.config.json

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

autoDeletePrevious

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

autoSplashscreen

Required when using instant apply modes ("atInstall", "onLaunch", o "always"), compreso il valore deprecato directUpdate valori. Installa @capacitor/splash-screen e impostalo launchAutoHide: false. Quando abilitato, il plugin nasconde lo schermo di splash dopo le applicazioni degli aggiornamenti o quando non è necessario alcun aggiornamento. Ciò elimina la necessità di ascoltare manualmente gli eventi appReady e di 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 le aggiornamenti in tempo reale, scarica e applica. Il plugin controlla gli aggiornamenti quando l'app si sposta in primo piano e su un timer ripetuto mentre l'app rimane aperta. periodCheckDelay Controlli che intervallano il timer.\Valori booleani sono ancora supportati per compatibilità con il passato. true è lo stesso come "atBackground" e false è lo stesso come "off". I valori di stringa uniscono le configurazioni precedenti di Aggiornamento Automatico e Aggiornamento Diretto.

Opzioni:

• "off" o false: Disabilita gli aggiornamenti automatici.
• "atBackground" : O trueControlla e scarica automaticamente ad ogni 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" behavior
• "onLaunch"Applica immediatamente solo quando l'app viene riportata in primo piano da uno stato di morte (avvio freddo). Dopo il primo controllo, ricadere su "atBackground" behavior
• "always"Controlla ogni volta che si passa a un'altra applicazione e applica immediatamente l'aggiornamento disponibile
• "onlyDownload"Controlla e scarica automaticamente, emetti updateAvailableE non impostare mai l'aggiornamento del prossimo bundle o l'aggiornamento automatico.

Modalità di applicazione istantanea (""atInstall", "onLaunch", "always"Caricare mentre l'utente è in attesa. npx @capgo/cli@latest bundle upload --delta così solo i file modificati vengono scaricati. L'upload di un file zip completo rallenta l'esperienza utente. Su Android e iOS questi modi richiedono autoSplashscreen: true e @capacitor/splash-screen con launchAutoHide: false.

Disponibile su Android, iOS e Electron.

Predefinito: "atBackground" (true è ancora accettato)

capacitor.config.json

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

channelUrl

Configura l'URL/punto di accesso 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"
    }
  }
}

defaultChannel

Imposta il canale predefinito per l'app nella configurazione. La casella è sensibile alle maiuscole. 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"
    }
  }
}

directUpdate

Obsoleto. Utilizza autoUpdate modalità di stringa invece: "atInstall", "onLaunch", o "always". Questa opzione rimane supportata per le app esistenti. L'applicazione istantanea dovrebbe essere caricata con --delta così l'aggiornamento non rallenta l'esperienza dell'utente. Questi modi richiedono autoSplashscreen: true e @capacitor/splash-screen con launchAutoHide: false.

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 "always" per compatibilità con le versioni precedenti

Disponibile su Android, iOS e Electron.

Predefinito: false

capacitor.config.json

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

disableJSLogging

Disabilita la registrazione JavaScript del plugin. Se true, il plugin non registrerà nella console JavaScript. Sarà fatto solo il registro nativo.

Disponibile su Android, iOS e Electron.

Predefinito: false

capacitor.config.json

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

keepUrlPathAfterReload

Configura il plugin per mantenere la path URL dopo il ricarico.

Attenzione

Quando viene attivato il reload, ‘window.history’ verrà cancellato.

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 la crittografia end-to-end live update di Versione 2.

Disponibile su Android, iOS e Electron.

Predefinito: undefined

capacitor.config.json

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

Attenzione

publicKey configures Encryption V2 and must match the private key used during upload. For Delta updates, use V2 encryption with partial encryption enabled, and enable encrypted-bundle enforcement if your organization requires every upload to be encrypted. Do not rely on publicKey senza alcun server-side policy che impedisca la pubblicazione di un Delta non crittografato.

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

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 ai fini di debug/test.

Disponibile su Android, iOS e Electron.

Predefinito: false

capacitor.config.json

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

statsUrl

Configura l'URL/punto di accesso a cui sono 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 Capgo storage dei dispositivi. Se updateUrl rimane abilitato, /updates still stores the billing MAU row, device inventory, and update-decision event data needed to serve updates and count MAU. See Conformità per la suddivisione dettagliata per campo.

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

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 self-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 auto-hosted.

Predefinito: undefined

capacitor.config.json

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

Tip

Esistono ulteriori impostazioni disponibili nell' Capgo web app 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 Utilizzando @capgo/capacitor-aggiornatore, Panoramica di @API per il dettaglio di implementazione in Panoramica di @API, Introduzione per il dettaglio di implementazione in Introduzione, Chiavi di @API per il dettaglio di implementazione in Chiavi di @API, e Dispositivi per il dettaglio di implementazione in Dispositivi.