Configuración

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

Consejo

Cualquier cambio en estas opciones 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 de 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 al plugin modificar la 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.

Valor 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.

Valor predeterminado: true

capacitor.config.json

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

autoDeletePrevious

Configurar 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

Manejar automáticamente 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 necesitan actualizaciones. Esto elimina la necesidad de escuchar eventos de aplicación lista y llamar a SplashScreen.hide(). Solo funciona cuando autoUpdate está configurado en "atInstall", "onLaunch", o "always"Legacy valores aún están soportados para compatibilidad hacia atrás. Requiere la instalación y configuración del plugin @__CAPGO_KEEP_0__/splash-screen con launchAutoHide: false. Requiere que se active la actualización automática. 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.

Predeterminado:

__CAPGO_KEEP_0__.config.json false

capacitor.config.json

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

autoUpdate

controla el intervalo de ese temporizador. Los valores booleanos aún están soportados para compatibilidad hacia atrás: periodCheckDelay es lo mismo que true y "atBackground" es lo mismo que false Available on Android, iOS, and Electron. "off". Valores de cadena combinan la configuración de actualización automática y directa anterior.

Opciones:

• "off" o false: Deshabilitar las comprobaciones de actualización automática
• "atBackground" o true: Comprobar y descargar automáticamente en cada comprobación de primer plano, luego aplicar la actualización la próxima vez que la aplicación se mueva al segundo plano
• "atInstall": Aplicar inmediatamente solo después de una instalación fresca o actualización de tienda de aplicaciones nativa; en caso contrario, usar "atBackground" comportamiento
• "onLaunch": Aplicar 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, caer en "atBackground" comportamiento
• "always": Comprobar en cada transición de primer plano y aplicar inmediatamente siempre que esté disponible una actualización
• "onlyDownload": Comprobar y descargar automáticamente, emitir updateAvailabley nunca establezca el siguiente paquete o aplique una actualización automáticamente

Disponible en Android, iOS y Electron.

Predeterminado: "atBackground" (true todavía se acepta)

capacitor.config.json

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

channelUrl

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

defaultChannel

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

directUpdate

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

Opciones:

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

Disponible en Android, iOS y Electron.

Predeterminado: false

capacitor.config.json

{
  "plugins": {
    "CapacitorUpdater": {
      "autoUpdate": "atInstall"
    }
  }
}

disableJSLogging

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

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 retraso para la comprobació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 paquetes descargados previos cuando se instale una versión más nueva del paquete 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 Durante (20 segundos)

capacitor.config.json

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

shakeMenu

Habilite el 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.

Desactivar no desactiva todos los __CAPGO_KEEP_0__ almacenamiento de dispositivo. statsUrl Si Capgo permanece habilitado, updateUrl sigue almacenando la fila de facturación MAU, inventario de dispositivo y datos de evento de decisión de actualización necesarios para servir actualizaciones y contar MAU. /updates 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 de conexión al que se envían las comprobaciones de actualización.

Disponible en Android, iOS y Electron.

Default: 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.

Default: undefined

capacitor.config.json

{
  "plugins": {
    "CapacitorUpdater": {
      "version": "1.0.0"
    }
  }
}

Configuración de desarrollo

localApi

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

Predeterminado: undefined

capacitor.config.json

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

localApiFiles

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

localSupa

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

localSupaAnon

Configure 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 del aplicativo.

Sigue adelante desde Configuración

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