Configuración
Copie un prompt de configuración con los pasos de instalación y la guía de markdown completa para este plugin.
Para tener un control más fino sobre el sistema de actualizaciones, puede configurarlo con estas configuraciones:
allowModifyUrl
Sección titulada “allowModifyUrl”Permitir al plugin modificar la URL de actualización, la URL de estadísticas y la URL de canal dinámicamente desde el lado del JavaScript.
Disponible en Android, iOS y Electron.
Predeterminado: false
{ "plugins": { "CapacitorUpdater": { "allowModifyUrl": true } }}Configure el identificador de la aplicación en la configuración.
Disponible en Android, iOS y Electron.
Predeterminado: undefined
{ "plugins": { "CapacitorUpdater": { "appId": "com.example.app" } }}appReadyTimeout
Sección titulada “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)
{ "plugins": { "CapacitorUpdater": { "appReadyTimeout": 1000 } }}autoDeleteFailed
Sección titulada “autoDeleteFailed”Configura si el complemento debe eliminar automáticamente los paquetes fallidos.
Disponible en Android, iOS y Electron.
Predeterminado: true
{ "plugins": { "CapacitorUpdater": { "autoDeleteFailed": false } }}autoDeletePrevious
Sección titulada “autoDeletePrevious”Configura si el complemento debe eliminar automáticamente los paquetes anteriores después de una actualización exitosa.
Disponible en Android, iOS y Electron.
Predeterminado: true
{ "plugins": { "CapacitorUpdater": { "autoDeletePrevious": false } }}autoSplashscreen
Sección titulada “autoSplashscreen”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. Esto elimina la necesidad de escuchar manualmente eventos de aplicación lista y llamar a SplashScreen.hide(). Solo funciona cuando
autoUpdateestá configurado en"atInstall","onLaunch", o"always". Valores de legado todavía se admiten para compatibilidad hacia atrás. Requiere que el complemento @__CAPGO_KEEP_0__/splash-screen esté instalado y configurado con launchAutoHide: false. Requiere que la actualización automática esté habilitada.directUpdatevalues 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
{ "plugins": { "CapacitorUpdater": { "autoUpdate": "atInstall", "autoSplashscreen": true } }}autoUpdate
Copiar a portapapelesConfigura cómo el plugin verifica, descarga y aplica actualizaciones en vivo.
periodCheckDelayEl plugin verifica actualizaciones cuando la aplicación se mueve al primer plano y en un temporizador repetido mientras la aplicación permanece abierta.truecontrola el intervalo de ese temporizador."atBackground"Los valores booleanos todavía se admiten por compatibilidad hacia atrás:falsees lo mismo que"off"y
es lo mismo que
"off"Opciones:falseo"atBackground"Configura cómo el plugin verifica, descarga y aplica actualizaciones en vivo.trueOpciones:"atInstall"o"atBackground"comportamiento"onLaunch": Aplicar inmediatamente solo cuando la aplicación se trae a primer plano desde un estado de muerte (inicio frío). Después de la primera comprobación, regresar a"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, emitirupdateAvailable, y nunca establecer el siguiente paquete o aplicar una actualización automáticamente
Disponible en Android, iOS y Electron.
Predeterminado: "atBackground" (true todavía se acepta)
{ "plugins": { "CapacitorUpdater": { "autoUpdate": "onlyDownload" } }}channelUrl
Título de la sección “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
{ "plugins": { "CapacitorUpdater": { "channelUrl": "https://example.com/api/channel" } }}defaultChannel
Sección titulada “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
{ "plugins": { "CapacitorUpdater": { "defaultChannel": "production" } }}directUpdate
Sección titulada “directUpdate”Obsoleto. Utilice
autoUpdatemodos de cadena en lugar de:"atInstall","onLaunch"o"always". Esta opción permanece soportada para aplicaciones existentes.
Opciones:
false: Nunca haga actualizaciones directas'atInstall': Igual queautoUpdate: "atInstall"'onLaunch': Igual queautoUpdate: "onLaunch"'always': Igual queautoUpdate: "always"true: (obsoleto) Igual que"always"por compatibilidad hacia atrás
Disponible en Android, iOS y Electron.
Predeterminado: false
{ "plugins": { "CapacitorUpdater": { "autoUpdate": "atInstall" } }}disableJSLogging
Sección titulada “desactivar registro de JavaScript”Desactivar 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
{ "plugins": { "CapacitorUpdater": { "disableJSLogging": true } }}keepUrlPathAfterReload
Sección titulada “mantener ruta de URL después de recargar”Configurar el plugin para mantener la ruta de URL después de recargar.
Disponible en Android, iOS y Electron.
Predeterminado: false
{ "plugins": { "CapacitorUpdater": { "keepUrlPathAfterReload": true } }}periodCheckDelay
Sección titulada “periodCheckDelay”Configura el período de retraso 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)
{ "plugins": { "CapacitorUpdater": { "periodCheckDelay": 600 // (10 minutes) } }}publicKey
Sección titulada “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
{ "plugins": { "CapacitorUpdater": { "publicKey": "YOUR_PUBLIC_KEY" } }}resetWhenUpdate
Sección titulada “resetWhenUpdate”Automáticamente eliminar los bundles descargados previos cuando se instala una versión más nueva del bundle de aplicación nativa en el dispositivo.
Disponible en Android, iOS y Electron.
Predeterminado: true
{ "plugins": { "CapacitorUpdater": { "resetWhenUpdate": false } }}responseTimeout
Sección titulada “responseTimeout”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)
{ "plugins": { "CapacitorUpdater": { "responseTimeout": 10 // (10 seconds) } }}shakeMenu
Sección titulada “shakeMenu”Habilite 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
{ "plugins": { "CapacitorUpdater": { "shakeMenu": true } }}statsUrl
Sección titulada “statsUrl”Configure la URL/punto de conexión a la 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, inventario de dispositivos y datos de eventos de decisión de actualización necesarios para servir actualizaciones y contar MAU. Consulte Cumplimiento para la desglose por campo.
Predeterminado: https://plugin.capgo.app/stats
{ "plugins": { "CapacitorUpdater": { "statsUrl": "https://example.com/api/stats" } }}updateUrl
Título de sección “updateUrl”Configure la URL / punto de conexión al que se envían las comprobaciones de actualización.
Diseñado para Android, iOS y Electron.
Predeterminado: https://plugin.capgo.app/updates
{ "plugins": { "CapacitorUpdater": { "updateUrl": "https://example.com/api/auto_update" } }}version
Sección titulada “versión”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
{ "plugins": { "CapacitorUpdater": { "version": "1.0.0" } }}Ajustes de Desarrollo
Sección titulada “Ajustes de Desarrollo”localApi
Sección titulada “localApi”Configure el CLI para utilizar un api local para pruebas.
Predeterminado: undefined
{ "plugins": { "CapacitorUpdater": { "localApi": "http://localhost:54321/functions/v1" } }}localApiFiles
Sección titulada “localApiFiles”Configure CLI para utilizar un archivo local api para pruebas.
Predeterminado: undefined
{ "plugins": { "CapacitorUpdater": { "localApiFiles": "http://localhost:54321/functions/v1/files" } }}localHost
Sección titulada “localHost”Configure CLI para utilizar un servidor local para pruebas o servidor de actualizaciones autoalojado.
Predeterminado: undefined
{ "plugins": { "CapacitorUpdater": { "localHost": "http://localhost:5173" } }}localSupa
Sección titulada “localSupa”Configure el CLI para utilizar un servidor local para pruebas o servidor de actualizaciones autoalojado.
Predeterminado: undefined
{ "plugins": { "CapacitorUpdater": { "localSupa": "http://localhost:54321" } }}localSupaAnon
Título de la sección “localSupaAnon”Configure el CLI para utilizar un servidor local para pruebas.
Predeterminado: undefined
{ "plugins": { "CapacitorUpdater": { "localSupaAnon": "YOUR_LOCAL_ANON_KEY" } }}localWebHost
Título de la sección “localWebHost”Configure el CLI para utilizar un servidor local para pruebas o servidor de actualizaciones autoalojado.
Predeterminado: undefined
{ "plugins": { "CapacitorUpdater": { "localWebHost": "http://localhost:5173" } }}Sigue adelante desde Configuración
Sección titulada “Sigue adelante desde Configuración”Si estás utilizando Configuración para planificar tablero 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.