Saltar al contenido

Ajustes

GitHub

Para tener un control más fino sobre el sistema de actualizaciones, puede configurarlo con estas configuraciones:

Para usar su propio hostname para updateUrl, statsUrl, y channelUrl, consulte Configuración de dominio personalizado.

Permitir que el complemento modifique updateUrl, statsUrl y channelUrl dinámicamente desde el lado del lado del JavaScript.

Disponible en Android, iOS y Electron.

Predeterminado: false

capacitor.config.json
{
"plugins": {
"CapacitorUpdater": {
"allowModifyUrl": true
}
}
}

Configura el id de la aplicación en la configuración.

Disponible en Android, iOS y Electron.

Predeterminado: undefined

capacitor.config.json
{
"plugins": {
"CapacitorUpdater": {
"appId": "com.example.app"
}
}
}

Configure el número de milisegundos que el plugin nativo debe esperar antes de considerar una actualización ‘fallida’.

Disponible en Android, iOS y Electron.

Predeterminado: 10000 (10 segundos)

capacitor.config.json
{
"plugins": {
"CapacitorUpdater": {
"appReadyTimeout": 1000
}
}
}

Configurar si el complemento debe eliminar automáticamente los paquetes fallidos.

Disponible en Android, iOS y Electron.

Predeterminado: true

capacitor.config.json
{
"plugins": {
"CapacitorUpdater": {
"autoDeleteFailed": false
}
}
}

Configurar si el complemento debe eliminar automáticamente los paquetes previos después de una actualización exitosa.

Disponible en Android, iOS y Electron.

Predeterminado: true

capacitor.config.json
{
"plugins": {
"CapacitorUpdater": {
"autoDeletePrevious": false
}
}
}

Requerido cuando se utilizan modos de aplicación instantánea."atInstall", "onLaunch", o "always"), incluyendo el valor deprecado directUpdate valores. Instálalo @capacitor/splash-screen y establecer launchAutoHide: false. Cuando está habilitado, el plugin oculta la pantalla de bienvenida después de aplicar actualizaciones o cuando no se necesita ninguna actualización. Esto elimina la necesidad de escuchar eventos de aplicación lista y llamar a SplashScreen.hide().

Disponible en Android e iOS.

Predeterminado: false

capacitor.config.json
{
"plugins": {
"CapacitorUpdater": {
"autoUpdate": "atInstall",
"autoSplashscreen": true
},
"SplashScreen": {
"launchAutoHide": false
}
}
}

Configure cómo el plugin verifica, descarga y aplica actualizaciones en vivo. El plugin verifica actualizaciones cuando la aplicación se mueve al primer plano y en un temporizador repetido mientras la aplicación permanece abierta. periodCheckDelay controles que intervalo del temporizador. Los valores booleanos todavía están soportados por compatibilidad hacia atrás: true es lo mismo que "atBackground" y false es lo mismo que "off". Los valores de cadena combinan la configuración de actualización automática y directa previa.

Opciones:

  • "off" o false: Disable automatic update checks
  • "atBackground" o trueVerifica y descarga automáticamente en cada verificación de primer plano, luego aplica la actualización la próxima vez que la aplicación se mueva al segundo plano
  • "atInstall"¿Qué alternativas tenemos? ¿Por qué elegir Capgo en lugar de otras opciones? "atBackground" behavior
  • "onLaunch"Aplicar inmediatamente solo cuando la aplicación se active desde un estado de muerte (inicio frío). Después de ese primer chequeo, recaer en "atBackground" behavior
  • "always"¿Qué alternativas tenemos? ¿Por qué elegir Capgo en lugar de otras opciones?
  • "onlyDownload": Verificar y descargar automáticamente, emitir updateAvailable¿Qué alternativas tenemos? ¿Por qué elegir Capgo en lugar de otras opciones?

Aplicar instantáneamente"atInstall", "onLaunch", "always"Aplicar mientras el usuario espera. Subir con npx @capgo/cli@latest bundle upload --delta Sólo se descargan archivos modificados. Un archivo zip completo ralentiza la experiencia del usuario. En Android e iOS, estos modos requieren autoSplashscreen: true y @capacitor/splash-screen con launchAutoHide: false.

Disponible en Android, iOS y Electron.

Predeterminado: "atBackground" (true se acepta aún)

capacitor.config.json
{
"plugins": {
"CapacitorUpdater": {
"autoUpdate": "onlyDownload"
}
}
}

Configure la URL / punto de conexión para operaciones de canal.

Disponible en Android, iOS y Electron.

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

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

Establecer el canal predeterminado para la aplicación en la configuración. Sensible a mayúsculas y minúsculas. Esta configuración sobreescribirá el canal predeterminado establecido en la nube, pero aún respetará las sobrescripciones realizadas en la nube.

Disponible en Android, iOS y Electron.

Predeterminado: undefined

capacitor.config.json
{
"plugins": {
"CapacitorUpdater": {
"defaultChannel": "production"
}
}
}

Obsoleto. Utilice autoUpdate modos de cadena en su lugar: "atInstall", "onLaunch", o "always"Esta opción sigue siendo compatible con aplicaciones existentes. Aplicar instantáneamente debe ser subido con --delta así el update no ralentice la experiencia del usuario. Estos modos requieren autoSplashscreen: true y @capacitor/splash-screen con launchAutoHide: false.

Opciones:

  • false: Nunca haga actualizaciones directas
  • 'atInstall': Igual que autoUpdate: "atInstall"
  • 'onLaunch': Igual que autoUpdate: "onLaunch"
  • 'always': Igual que autoUpdate: "always"
  • true: (obsoleto) Igual que "always" para compatibilidad hacia atrás

Disponible en Android, iOS y Electron.

Predeterminado: false

capacitor.config.json
{
"plugins": {
"CapacitorUpdater": {
"autoUpdate": "atInstall"
}
}
}

No activar el registro de JavaScript del plugin. Si es verdadero, el plugin no registrará en la consola de JavaScript. Solo se hará el registro nativo.

Disponible en Android, iOS y Electron.

Predeterminado: false

capacitor.config.json
{
"plugins": {
"CapacitorUpdater": {
"disableJSLogging": true
}
}
}

Configurar el plugin para mantener la ruta de URL después de recargar.

Disponible en Android, iOS y Electron.

Predeterminado: false

capacitor.config.json
{
"plugins": {
"CapacitorUpdater": {
"keepUrlPathAfterReload": true
}
}
}

Configura el período de espera para la comprobación periódica de actualizaciones. La unidad es en segundos. No puede ser menor a 600 segundos (10 minutos).

Disponible en Android, iOS y Electron.

Predeterminado: 600 10 minutos

capacitor.config.json
{
"plugins": {
"CapacitorUpdater": {
"periodCheckDelay": 600 // (10 minutes)
}
}
}

Configure la clave pública para la cifrado de fin a fin live update de versión 2.

Disponible en Android, iOS y Electron.

Predeterminado: undefined

capacitor.config.json
{
"plugins": {
"CapacitorUpdater": {
"publicKey": "YOUR_PUBLIC_KEY"
}
}
}

Elimina automáticamente los paquetes descargados previos cuando se instala una nueva versión nativa del paquete de la aplicación en el dispositivo.

Disponible en Android, iOS y Electron.

Predeterminado: true

capacitor.config.json
{
"plugins": {
"CapacitorUpdater": {
"resetWhenUpdate": false
}
}
}

Configure el número de milisegundos que el plugin nativo debe esperar antes de considerar que API ha caducado.

Disponible en Android, iOS y Electron.

Predeterminado: 20 (20 segundos)

capacitor.config.json
{
"plugins": {
"CapacitorUpdater": {
"responseTimeout": 10 // (10 seconds)
}
}
}

Habilitar gesto de sacudir para mostrar el menú de actualización con fines de depuración/pruebas.

Disponible en Android, iOS y Electron.

Predeterminado: false

capacitor.config.json
{
"plugins": {
"CapacitorUpdater": {
"shakeMenu": true
}
}
}

Configure la URL/punto final al que se envían estadísticas de actualización.

Disponible en Android, iOS y Electron. Establezca a "" para deshabilitar el informe explícito de estadísticas a través de /stats.

Disabling statsUrl No deshabilita todos los almacenamientos de dispositivo Capgo. Si updateUrl se mantiene habilitado, /updates Todavía almacena la fila de facturación MAU, inventario de dispositivos y datos de eventos de decisión de actualización necesarios para servir actualizaciones y contar MAU. Ver Cumplimiento para la desglose por campo.

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

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

Configure la URL / punto final a la que se envían las comprobaciones de actualización.

Disponible en Android, iOS y Electron.

Predeterminado: https://plugin.capgo.app/updates

capacitor.config.json
{
"plugins": {
"CapacitorUpdater": {
"updateUrl": "https://example.com/api/auto_update"
}
}
}

Configure la versión actual de la aplicación. Esta será utilizada para la primera solicitud de actualización. Si no se establece, el complemento obtendrá la versión del nativo code.

Disponible en Android, iOS y Electron.

Predeterminado: undefined

capacitor.config.json
{
"plugins": {
"CapacitorUpdater": {
"version": "1.0.0"
}
}
}

Configure el CLI para utilizar un api local para pruebas.

Predeterminado: undefined

capacitor.config.json
{
"plugins": {
"CapacitorUpdater": {
"localApi": "http://localhost:54321/functions/v1"
}
}
}

Configure el CLI para utilizar un archivo de archivo local api para pruebas.

Predeterminado: undefined

capacitor.config.json
{
"plugins": {
"CapacitorUpdater": {
"localApiFiles": "http://localhost:54321/functions/v1/files"
}
}
}

Configure el CLI para utilizar un servidor local para pruebas o servidor de actualizaciones autoalojado.

Predeterminado: undefined

capacitor.config.json
{
"plugins": {
"CapacitorUpdater": {
"localHost": "http://localhost:5173"
}
}
}

Configure el CLI para utilizar un servidor local para pruebas o servidor de actualizaciones autoalojado.

Predeterminado: undefined

capacitor.config.json
{
"plugins": {
"CapacitorUpdater": {
"localSupa": "http://localhost:54321"
}
}
}

Configure el CLI para utilizar un servidor local para pruebas.

Predeterminado: undefined

capacitor.config.json
{
"plugins": {
"CapacitorUpdater": {
"localSupaAnon": "YOUR_LOCAL_ANON_KEY"
}
}
}

Configure el CLI para utilizar un servidor local para pruebas o servidor de actualizaciones autoalojado.

Predeterminado: undefined

capacitor.config.json
{
"plugins": {
"CapacitorUpdater": {
"localWebHost": "http://localhost:5173"
}
}
}

Configuración Settings planificar el panel de control y las API operaciones, conecte con Usando @capgo/capacitor-actualizador para la capacidad nativa en Usando @capgo/capacitor-actualizador, API Resumen para el detalle de implementación en API Resumen, Introducción para el detalle de implementación en Introducción, API Claves para el detalle de implementación en API Claves, y Dispositivos para el detalle de implementación en Dispositivos.