Pular al contenido

Configuración

GitHub

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

Permitir que el complemento modifique la 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
}
}
}

Configure el identificador 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"
}
}
}

Configure el número de milisegundos que el plugin nativo debe esperar antes de considerar una actualización como ‘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 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 paquetes anteriores después de una actualización exitosa.

Disponible en Android, iOS y Electron.

Predeterminado: true

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

Automáticamente maneja la ocultación de la pantalla de bienvenida cuando se utilizan modos de aplicación instantánea. Cuando está habilitado, el complemento ocultará automáticamente la pantalla de bienvenida después de aplicar actualizaciones o cuando no se necesite ninguna actualización. Esta opción 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". Valores legados todavía se admiten por 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.

Valor predeterminado:

__CAPGO_KEEP_0__.config.json false

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

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 controla el intervalo de ese temporizador. Los valores booleanos todavía se admiten por compatibilidad hacia atrás: true es lo mismo que "atBackground" y false es lo mismo que "off"y

Opciones:

  • "off" o falseOpciones:
  • "atBackground" o true: Deshabilita las verificaciones de actualizaciones automáticas
  • "atInstall": Aplicar inmediatamente solo después de una instalación fresca o actualización de la tienda de aplicaciones nativa; en caso contrario, usar "atBackground" comportamiento
  • "onLaunch": Aplicar inmediatamente solo cuando la aplicación se trae a primer plano desde un estado asesinado (inicio frío). Después de ese primer chequeo, caer en el "atBackground" comportamiento
  • "always": Verificar en cada transición de primer plano y aplicar inmediatamente siempre que esté disponible una actualización
  • "onlyDownload": Verificar y descargar automáticamente, emitir updateAvailable, y nunca establecer el siguiente paquete o aplicar una actualización automáticamente

Disponible en Android, iOS y Electron.

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

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

Configure la URL / punto de conexión para las 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"
}
}
}

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

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

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

Disponible en Android, iOS y Electron.

Predeterminado: false

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

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

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

Eliminar automáticamente los paquetes descargados previos cuando se instale una versión más nueva del paquete de aplicación nativa en el dispositivo.

Disponible en Android, iOS y Electron.

Predeterminado: true

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

Configurar 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 el 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 a través del cual se envían estadísticas de actualización.

Disponible en Android, iOS y Electron. Establecer 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 sigue almacenando 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. Consulte Cumplimiento para obtener una desglose por campo.

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

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

Configure la URL / punto de conexión 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. 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"
}
}
}

Configure el CLI para utilizar una api local para pruebas.

Predeterminado: undefined

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

Configure CLI para utilizar un archivo local api para pruebas.

Predeterminado: undefined

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

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

Configure 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 CLI para utilizar un servidor local para pruebas.

Predeterminado: undefined

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

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

Predeterminado: undefined

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

Sección titulada “Continúa desde Configuración”

Si estás utilizando

Configuración Ajustes disponibles en la aplicación web de __CAPGO_KEEP_0__ para planificar la consola de dashboard y 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.