Settings

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

Suggerimento

Qualsiasi modifica a queste impostazioni nel file condensatore.config richiede la sincronizzazione della piattaforma e il rilascio nello store affinché le app di produzione possano riceverle.

allowModifyUrl

Consenti al plug-in 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’ID app per l’app nel file config.

Disponibile su Android, iOS ed Electron.

Predefinito: undefined

capacitor.config.json

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

appReadyTimeout

Configura il numero di millisecondi che il plugin nativo deve attendere prima di considerare un aggiornamento ‘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 pacchetti non riusciti.

Disponibile su Android, iOS ed Electron.

Predefinito: true

capacitor.config.json

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

autoDeletePrevious

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

Disponibile su Android, iOS ed Electron.

Predefinito: true

capacitor.config.json

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

autoSplashscreen

Gestisci automaticamente l’occultamento della schermata iniziale quando si utilizza directUpdate. Se abilitato, il plug-in nasconderà automaticamente la schermata iniziale dopo l’applicazione degli aggiornamenti o quando non è necessario alcun aggiornamento. Ciò elimina la necessità di ascoltare manualmente gli eventi appReady e chiamare SplashScreen.hide(). Funziona solo quando directUpdate è impostato su “atInstall”, “always” o true. Richiede l’installazione e la configurazione del plugin @capacitor/splash-screen con launchAutoHide: false. Richiede l’abilitazione di autoUpdate e directUpdate.

Disponibile su Android, iOS ed Electron.

Predefinito: false

capacitor.config.json

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

autoUpdate

Configura se il plugin deve utilizzare l’aggiornamento automatico tramite un server di aggiornamento.

Disponibile su Android, iOS ed Electron.

Predefinito: true

capacitor.config.json

{
  "plugins": {
    "CapacitorUpdater": {
      "autoUpdate": false
    }
  }
}

channelUrl

Configura l’URL/endpoint per le operazioni sul 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 per l’app nel file config. Maiuscole e minuscole. Questa impostazione sovrascriverà il canale predefinito impostato nel cloud, ma rispetterà comunque le sostituzioni effettuate nel cloud.

Disponibile su Android, iOS ed Electron.

Predefinito: undefined

capacitor.config.json

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

directUpdate

Configura quando il plugin deve dirigere l’installazione degli aggiornamenti. Solo per la modalità di aggiornamento automatico. Funziona bene per app di dimensioni inferiori a 10 MB e con caricamenti eseguiti utilizzando il flag —delta. Zip o app di dimensioni superiori a 10 MB saranno relativamente lenti da aggiornare per gli utenti.Opzioni:

• false: non eseguire mai aggiornamenti diretti (utilizza il comportamento predefinito: download all’avvio, impostato in background)
• 'atInstall': aggiornamento diretto solo quando l’app è installata, aggiornata dallo store, altrimenti agisce come directUpdate = false
• 'onLaunch': aggiornamento diretto solo sull’app installata, aggiornata dallo store o dopo l’uccisione dell’app, altrimenti agisce come directUpdate = false
• 'sempre': aggiornamento diretto in tutti i casi precedenti (app installata, aggiornata dallo store, dopo l’interruzione dell’app o il ripristino dell’app), non agire mai come directUpdate = false
• true: (deprecato) Uguale a “sempre” per compatibilità con le versioni precedenti

Disponibile su Android, iOS ed Electron.

Predefinito: false

capacitor.config.json

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

disableJSLogging

Disabilita la registrazione JavaScript del plugin. Se vero, il plugin non registrerà la console JavaScript. Verrà eseguito solo il registro nativo.

Disponibile su Android, iOS ed Electron.

Predefinito: false

capacitor.config.json

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

keepUrlPathAfterReload

Configura il plugin per mantenere il percorso dell’URL dopo un ricaricamento.

Attenzione

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

Disponibile su Android, iOS ed Electron.

Predefinito: false

capacitor.config.json

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

periodCheckDelay

Configurare il periodo di ritardo per il controllo dell’aggiornamento del periodo. 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 degli aggiornamenti live end-to-end Versione 2.

Disponibile su Android, iOS ed Electron.

Predefinito: undefined

capacitor.config.json

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

resetWhenUpdate

Elimina automaticamente i pacchetti scaricati in precedenza quando sul dispositivo viene installato un pacchetto di app native più recente.

Disponibile su Android, iOS ed Electron.

Predefinito: true

capacitor.config.json

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

responseTimeout

Configura il numero di millisecondi che il plugin nativo deve attendere 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 di scuotimento per mostrare il menu di aggiornamento a scopo di debug/test.

Disponibile su Android, iOS ed Electron.

Predefinito: false

capacitor.config.json

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

statsUrl

Configurare l’URL/endpoint a cui vengono inviate le statistiche degli aggiornamenti.

Disponibile su Android, iOS ed Electron. Imposta su "" per disabilitare il reporting delle statistiche.

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

capacitor.config.json

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

updateUrl

Configurare l’URL/endpoint a cui vengono inviati i controlli degli 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 corrente dell’app. Questo verrà utilizzato per la prima richiesta di aggiornamento. Se non impostato, il plugin otterrà la versione dal codice 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 utilizzare un’API locale per i test.

Predefinito: undefined

capacitor.config.json

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

localApiFiles

Configura CLI per utilizzare un’API di file locale per i test.

Predefinito: undefined

capacitor.config.json

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

localHost

Configurare CLI per utilizzare un server locale per il test o un server di aggiornamento self-hosted.

Predefinito: undefined

capacitor.config.json

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

localSupa

Configurare CLI per utilizzare un server locale per il test o un server di aggiornamento self-hosted.

Predefinito: undefined

capacitor.config.json

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

localSupaAnon

Configura CLI per utilizzare un server locale per i test.

Predefinito: undefined

capacitor.config.json

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

localWebHost

Configurare CLI per utilizzare un server locale per il test o un server di aggiornamento self-hosted.

Predefinito: undefined

capacitor.config.json

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

Suggerimento

Nell’Capgo app web sono disponibili impostazioni aggiuntive che possono essere configurate per canale senza richiedere una versione nativa dell’app.