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 nella store per gli app di produzione riceveranno queste modifiche.

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'applicazione 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 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

Tratta automaticamente la rimozione dello schermata di benvenuto quando si utilizza l'aggiornamento diretto. Quando abilitato, il plugin nasconderà automaticamente lo schermata di benvenuto dopo l'applicazione degli aggiornamenti o quando non sono necessari aggiornamenti. Questo elimina la necessità di ascoltare manualmente gli eventi appReady e di chiamare SplashScreen.hide(). Funziona solo quando l'aggiornamento diretto è impostato su “atInstall”, “always” o true. Richiede l'installazione e la configurazione del plugin @capacitor/schermata di benvenuto con launchAutoHide: false. Richiede l'abilitazione di autoUpdate e directUpdate.

Disponibile su Android, iOS e Electron.

Predefinito: false

capacitor.config.json

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

autoUpdate

Configura se il plugin dovrebbe utilizzare l'aggiornamento automatico tramite un server di aggiornamento.

Disponibile su Android, iOS e Electron.

Predefinito: true

capacitor.config.json

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

channelUrl

Configura l'URL / endpoint per le operazioni del 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. Attenzione: la casella è sensibile.

Questa impostazione sovrascriverà il canale predefinito impostato nel cloud, ma rispetterà comunque le sovrascritture effettuate nel cloud.

Disponibile su Android, iOS e Electron. undefined

capacitor.config.json

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

directUpdate

Configura quando il plugin dovrebbe eseguire l'aggiornamento diretto. Solo per il modo di aggiornamento automatico. Funziona bene per le app con un peso inferiore a 10MB e con upload eseguiti utilizzando la flag --delta. Gli archivi zip o le app con un peso superiore a 10MB saranno relativamente lenti per gli utenti durante l'aggiornamento.

Opzioni:

• false: Mai eseguire aggiornamenti diretti (utilizzare il comportamento predefinito: scaricare all'avvio, impostare quando l'app è in background)
• 'atInstall': Eseguire l'aggiornamento diretto solo quando l'app è installata, aggiornata dal negozio, altrimenti agire come se directUpdate = false
• 'onLaunch': Eseguire l'aggiornamento diretto solo in tutti i casi precedenti (app installata, aggiornata dal negozio, dopo aver ucciso l'app o dopo aver ripristinato l'app), mai agire come se directUpdate = false
• 'always': (deprecated) Lo stesso di “sempre” per compatibilità con i sistemi precedenti
• trueDisponibile su Android, iOS e Electron.

Predefinito:

__CAPGO_KEEP_0__.config.json false

capacitor.config.json

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

disableJSLogging

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

keepUrlPathAfterReload

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

Attenzione

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

Disponibile su Android, iOS e Electron.

Predefinito: false

capacitor.config.json

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

periodCheckDelay

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

publicKey

Configura la chiave pubblica per l'encryption 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"
    }
  }
}

resetWhenUpdate

Elimina automaticamente i bundle scaricati precedenti 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 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

Configure the current version of the app. This will be used for the first update request. If not set, the plugin will get the version from the native 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 per un 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 per un 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.