Impostazioni

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

Suggerimento

Qualsiasi modifica a questi impostazioni nel file capacitor.config richiede la sincronizzazione della piattaforma e la pubblicazione sullo store per gli app di produzione che ne ricevano il beneficio.

Nota

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

allowModifyUrl

Consenti al plugin di modificare dinamicamente 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 configurazione.

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

Disponibile su Android, iOS e Electron.

Predefinito: true

capacitor.config.json

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

autoDeletePrevious

Configura se il plugin dovrebbe cancellare automaticamente i 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. Quando abilitato, il plugin nasconderà automaticamente lo schermo di benvenuto dopo gli aggiornamenti sono stati applicati 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". Eredità directUpdate i valori sono ancora supportati per la compatibilità all'indietro. Richiede il plugin @capacitor/splash-screen di essere installato e configurato con launchAutoHide: false. Richiede l'aggiornamento automatico di essere abilitato.

Disponibile su Android, iOS e Electron.

Predefinito: false

capacitor.config.json

{
  "plugins": {
    "CapacitorUpdater": {
      "autoUpdate": "atInstall",
      "autoSplashscreen": true
    }
  }
}

autoUpdate

Configura come il plugin controlla, scarica e applica gli aggiornamenti in tempo reale. Il plugin controlla gli aggiornamenti quando l'app si sposta in primo piano e su un timer ripetitore mentre l'app rimane aperta. periodCheckDelay controlla l'intervallo di quel timer. I valori booleani sono ancora supportati per la compatibilità all'indietro: true è lo stesso di "atBackground" e false è lo stesso di "off". Valori di stringa uniscono la configurazione di aggiornamento automatico e di aggiornamento diretto precedente.

Opzioni:

• "off" o false: Disabilita le verifiche di aggiornamento automatiche
• "atBackground" o true: Verifica 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" 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 ad ogni transizione in primo piano e applica immediatamente ogni volta che è disponibile un aggiornamento
• "onlyDownload": Verifica e scarica automaticamente, emette updateAvailableEsegui mai automaticamente il prossimo bundle o l'aggiornamento

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.

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. Questa impostazione sovrascriverà il canale predefinito impostato in cloud, ma rispetterà comunque gli override fatti in cloud.

Disponibile su Android, iOS e Electron.

Predefinito: undefined

capacitor.config.json

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

directUpdate

Obsoleto. Utilizza autoUpdate modi di stringa invece: "atInstall", "onLaunch", o "always" Questa opzione rimane supportata per le app esistenti.

Opzioni:

• false: Mai fare 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 log 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 un reload.

Attenzione

Quando viene attivato un 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 l'encryption di aggiornamento in tempo reale end-to-end Versione 2.

Disponibile su Android, iOS e Electron.

Predefinito: undefined

capacitor.config.json

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

Attenzione

publicKey configura la crittografia V2 e deve corrispondere alla chiave privata utilizzata durante l'upload. Per le aggiornamenti Delta, utilizzare la crittografia V2 con crittografia parziale abilitata, e abilitare l'enforcement del pacchetto crittografato se la tua organizzazione richiede che ogni upload sia crittografato. Non affidarti publicKey da solo come politica server-side per prevenire un Delta non crittografato da essere pubblicato.

resetWhenUpdate

Elimina automaticamente i bundle precedentemente scaricati quando viene installato un bundle di app nativa 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 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. Impostalo su "" per disabilitare la registrazione esplicita delle statistiche. /stats.

Disabilitare statsUrl Non disabilita tutti i dati di archiviazione del dispositivo Capgo. Se updateUrl rimane abilitato, /updates continua a memorizzare i dati di fatturazione della riga 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 a livello di 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 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.

Default: 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.

Default: undefined

capacitor.config.json

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

Suggerimento

Sono disponibili ulteriori impostazioni nella sezione App web Capgo che può essere configurato per canale senza richiedere una rilascio dell'app nativa.

Continua da Impostazioni

Se stai utilizzando Impostazioni per pianificare il dashboard e le operazioni API, collega il tuo account con Utilizzando @capgo/capacitor-aggiornatore per la capacità nativa in Utilizzando @capgo/capacitor-aggiornatore, Panoramica API per i dettagli di implementazione in Panoramica API, 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.