Configuración

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

Consejo

Cualquier cambio en estos ajustes en el archivo capacitor.config requiere sincronizar la plataforma y publicar en la tienda para que las aplicaciones de producción las reciban.

Nota

¿Necesita residencia de datos en la UE para Capgo Cloud? Establezca updateUrl a https://plugin.eu.capgo.app/updates, statsUrl a https://plugin.eu.capgo.app/stats, y channelUrl a https://plugin.eu.capgo.app/channel_self. Consulte Ubicación de datos.

allowModifyUrl

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

Disponible en Android, iOS y Electron.

Predeterminado: false

capacitor.config.json

{
  "plugins": {
    "CapacitorUpdater": {
      "allowModifyUrl": true
    }
  }
}

appId

Configurar el id de la aplicación para la aplicación en la configuración.

Disponible en Android, iOS y Electron.

Predeterminado: undefined

capacitor.config.json

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

appReadyTimeout

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

autoDeleteFailed

Configure si el plugin debe eliminar automáticamente los bundles fallidos.

Disponible en Android, iOS, y Electron.

Predeterminado: true

capacitor.config.json

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

autoDeletePrevious

Configura si el plugin debe eliminar automáticamente los bundles previos después de una actualización exitosa.

Disponible en Android, iOS y Electron.

Predeterminado: true

capacitor.config.json

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

autoSplashscreen

Automáticamente gestiona la ocultación de la pantalla de bienvenida cuando se utilizan modos de aplicación instantánea. Cuando está habilitado, el plugin ocultará automáticamente la pantalla de bienvenida después de aplicar actualizaciones o cuando no se necesite ninguna actualización. Esto elimina la necesidad de escuchar manualmente eventos de aplicación lista y llamar a SplashScreen.hide(). Solo funciona cuando autoUpdate está configurado en "atInstall", "onLaunch", o "always". Los valores legados todavía se admiten para compatibilidad hacia atrás. Requiere que el plugin @__CAPGO_KEEP_0__/splash-screen esté instalado y configurado con launchAutoHide: false. Requiere que la actualización automática esté habilitada. directUpdate values are still supported for backward compatibility. Requires the @capacitor/splash-screen plugin to be installed and configured with launchAutoHide: false. Requires Auto Update to be enabled.

Disponible en Android, iOS y Electron.

Predeterminado: false

capacitor.config.json

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

autoUpdate

Configure cómo el complemento verifica, descarga y aplica actualizaciones en vivo. El complemento verifica actualizaciones cuando la aplicación se mueve al primer plano y en un temporizador repetido mientras la aplicación permanece abierta. periodCheckDelay Controla el intervalo de ese temporizador. Los valores booleanos todavía se admiten para compatibilidad hacia atrás: true es lo mismo que "atBackground" y false es lo mismo que "off". Los valores de cadena fusionan la configuración de actualizaciones automáticas y directas previas.

Opciones:

• "off" o false: Deshabilitar las comprobaciones de actualizaciones automáticas
• "atBackground" o true: Comprueba y descarga automáticamente en cada comprobación de primer plano, luego aplica la actualización la próxima vez que la aplicación se mueva al segundo plano
• "atInstall": Aplica inmediatamente solo después de una instalación fresca o actualización de tienda de aplicaciones nativa; en caso contrario, utilice "atBackground" comportamiento
• "onLaunch": Aplica inmediatamente solo cuando la aplicación se trae al primer plano desde un estado de muerte (inicio frío). Después de la primera comprobación, regrese a "atBackground" comportamiento
• "always": Comprueba en cada transición de primer plano y aplica inmediatamente siempre que esté disponible una actualización
• "onlyDownload": Comprueba y descarga automáticamente, emite updateAvailable, y nunca establezca el siguiente paquete o aplique una actualización automáticamente

Disponible en Android, iOS y Electron.

Default: "atBackground" (true se sigue aceptando)

capacitor.config.json

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

channelUrl

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

Disponible en Android, iOS y Electron.

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

capacitor.config.json

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

defaultChannel

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

directUpdate

Obsoleto. Utilice autoUpdate modos de cadena en su lugar: "atInstall", "onLaunch", o "always". Esta opción permanece soportada para aplicaciones existentes.

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

disableJSLogging

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

Disponible en Android, iOS y Electron.

Predeterminado: false

capacitor.config.json

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

keepUrlPathAfterReload

Configure el plugin para mantener el camino de URL después de un recarga.

Cuidado

Cuando se desencadena una recarga, ‘window.history’ se borrará.

Disponible en Android, iOS y Electron.

Predeterminado: false

capacitor.config.json

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

periodCheckDelay

Configure el período de espera para la verificación de actualizaciones periódicas. 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)
    }
  }
}

publicKey

Configure la clave pública para la cifrado de actualizaciones en vivo de fin a fin, versión 2.

Disponible en Android, iOS y Electron.

Predeterminado: undefined

capacitor.config.json

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

resetWhenUpdate

Eliminar automáticamente los bundles descargados previos cuando se instale una versión más nueva del bundle nativo en el dispositivo.

Disponible en Android, iOS y Electron.

Predeterminado: true

capacitor.config.json

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

responseTimeout

Configurar el número de milisegundos que el plugin nativo debe esperar antes de considerar a API como timeout.

Disponible en Android, iOS y Electron.

Predeterminado: 20 (20 segundos)

capacitor.config.json

{
  "plugins": {
    "CapacitorUpdater": {
      "responseTimeout": 10 // (10 seconds)
    }
  }
}

shakeMenu

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

Disponible en Android, iOS y Electron.

Predeterminado: false

capacitor.config.json

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

statsUrl

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.

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

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

capacitor.config.json

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

updateUrl

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

Diseñado para Android, iOS y Electron.

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

capacitor.config.json

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

version

Configure la versión actual de la aplicación. Se utilizará 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"
    }
  }
}

Configuración de Desarrollo

localApi

Configure el CLI para utilizar un api local para pruebas.

Predeterminado: undefined

capacitor.config.json

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

localApiFiles

Configure CLI para utilizar un archivo local api para pruebas.

Predeterminado: undefined

capacitor.config.json

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

localHost

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

Predeterminado: undefined

capacitor.config.json

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

localSupa

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

localSupaAnon

Configure el CLI para utilizar un servidor local para pruebas.

Predeterminado: undefined

capacitor.config.json

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

localWebHost

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

Consejo

Hay ajustes adicionales disponibles en la Capgo aplicación web que se pueden configurar por canal sin requerir una versión nativa de la aplicación.

Sigue adelante desde Configuración

Si estás utilizando Configuración para planificar la consola de dashboard y API operaciones, conectarlo 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.