Configuración
Copia un prompt de configuración con los pasos de instalación y la guía completa en markdown para este plugin.
Para tener un control más detallado sobre el sistema de actualizaciones, puedes configurarlo con estos ajustes:
Para usar tu propio hostname para updateUrl, statsUrl, y channelUrl, consulta Configuración de dominio personalizado.
allowModifyUrl
Sección titulada “allowModifyUrl”Permite que el plugin modifique dinámicamente updateUrl, statsUrl y channelUrl desde JavaScript.
Disponible en Android, iOS y Electron.
Por defecto: false
{ "plugins": { "CapacitorUpdater": { "allowModifyUrl": true } }}Configura el appId de la app en la configuración.
Disponible en Android, iOS y Electron.
Por defecto: undefined
{ "plugins": { "CapacitorUpdater": { "appId": "com.example.app" } }}appReadyTimeout
Sección titulada “appReadyTimeout”Configura 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.
Por defecto: 10000 (10 segundos)
{ "plugins": { "CapacitorUpdater": { "appReadyTimeout": 1000 } }}autoDeleteFailed
Sección titulada “autoDeleteFailed”Configura si el plugin debe eliminar automáticamente los bundles fallidos.
Disponible en Android, iOS y Electron.
Por defecto: true
{ "plugins": { "CapacitorUpdater": { "autoDeleteFailed": false } }}autoDeletePrevious
Sección titulada “autoDeletePrevious”Configura si el plugin debe eliminar automáticamente los bundles anteriores tras una actualización exitosa.
Disponible en Android, iOS y Electron.
Por defecto: true
{ "plugins": { "CapacitorUpdater": { "autoDeletePrevious": false } }}autoSplashscreen
Sección titulada “autoSplashscreen”Requerido al usar modos de aplicación instantánea (
"atInstall","onLaunch", o"always"), incluidos los valoresdirectUpdateobsoletos. Instala@capacitor/splash-screeny establecelaunchAutoHide: false. Al activarlo, el plugin oculta el splashscreen tras aplicar las actualizaciones o cuando no se necesita ninguna actualización. Esto evita tener que escuchar manualmente los eventos appReady y llamar a SplashScreen.hide().
Disponible en Android e iOS.
Por defecto: false
{ "plugins": { "CapacitorUpdater": { "autoUpdate": "atInstall", "autoSplashscreen": true }, "SplashScreen": { "launchAutoHide": false } }}autoUpdate
Sección titulada “autoUpdate”Configura cómo el plugin comprueba, descarga y aplica actualizaciones en vivo. El plugin comprueba si hay actualizaciones cuando la app pasa a primer plano y con un timer recurrente mientras la app sigue abierta.
periodCheckDelaycontroles ese intervalo del temporizador.\ Aún se admiten valores booleanos por compatibilidad con versiones anteriores:truees lo mismo que"atBackground"yfalsees lo mismo que"off"Los valores de cadena combinan la configuración previa de Auto Update y Direct Update.
Opciones:
"off"ofalse: Disable automatic update checks"atBackground"otrue: Comprueba y descarga automáticamente en cada chequeo de foreground, y aplica la actualización la próxima vez que la app pase a background"atInstall": Aplicar inmediatamente solo tras una instalación limpia o actualización de la tienda; de lo contrario, usar"atBackground"comportamiento"onLaunch": Se aplica inmediatamente solo cuando la app vuelve al primer plano desde un estado cerrado (cold start). Después de esa primera comprobación, recurre a"atBackground"comportamiento"always": Comprueba en cada transición al primer plano y aplica inmediatamente cuando haya una actualización disponible"onlyDownload": Comprueba y descarga automáticamente, emiteupdateAvailable, y nunca establece el siguiente bundle ni aplica una actualización automáticamente
Modos de aplicación instantánea ("atInstall", "onLaunch", "always") se aplican mientras el usuario espera. Sube con npx @capgo/cli@latest bundle upload --delta así solo se descargan los archivos modificados. Subir un 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.
Por defecto: "atBackground" (true sigue siendo aceptado)
{ "plugins": { "CapacitorUpdater": { "autoUpdate": "onlyDownload" } }}channelUrl
Sección titulada “channelUrl”Configura la URL / endpoint para las operaciones del canal.
Disponible en Android, iOS y Electron.
Por defecto: https://plugin.capgo.app/channel_self
{ "plugins": { "CapacitorUpdater": { "channelUrl": "https://example.com/api/channel" } }}defaultChannel
Sección titulada “defaultChannel”Configura el canal por defecto de la app en la configuración. Distingue entre mayúsculas y minúsculas. Este ajuste sobrescribirá el canal por defecto definido en la nube, pero seguirá respetando las sobrescrituras hechas en la nube.
Disponible en Android, iOS y Electron.
Por defecto: undefined
{ "plugins": { "CapacitorUpdater": { "defaultChannel": "production" } }}directUpdate
Sección titulada “directUpdate”Obsoleto. Usa
autoUpdatemodos de tipo string en su lugar:"atInstall","onLaunch", o"always". Esta opción sigue siendo compatible con las apps existentes. Instant apply debe subirse con--deltapara que la actualización no ralentice la experiencia del usuario. Estos modos requierenautoSplashscreen: truey@capacitor/splash-screenconlaunchAutoHide: false.
Opciones:
false: Nunca hacer actualizaciones directas'atInstall': Igual queautoUpdate: "atInstall"'onLaunch': Igual queautoUpdate: "onLaunch"'always': Igual queautoUpdate: "always"true: (obsoleto) Igual que"always"para compatibilidad con versiones anteriores
Disponible en Android, iOS y Electron.
Por defecto: false
{ "plugins": { "CapacitorUpdater": { "autoUpdate": "atInstall" } }}disableJSLogging
Sección titulada “disableJSLogging”Desactiva el logging de JavaScript del plugin. Si es true, el plugin no escribirá nada en la consola de JavaScript. Solo se hará el log nativo.
Disponible en Android, iOS y Electron.
Por defecto: false
{ "plugins": { "CapacitorUpdater": { "disableJSLogging": true } }}keepUrlPathAfterReload
Sección titulada “keepUrlPathAfterReload”Configura el plugin para mantener la ruta de la URL tras un reload.
Disponible en Android, iOS y Electron.
Por defecto: false
{ "plugins": { "CapacitorUpdater": { "keepUrlPathAfterReload": true } }}periodCheckDelay
Sección titulada “periodCheckDelay”Configura el período de espera para la comprobación de actualizaciones periódicas. La unidad es en segundos. No puede ser inferior a 600 segundos (10 minutos).
Disponible en Android, iOS y Electron.
Por defecto: 600 (10 minutos)
{ "plugins": { "CapacitorUpdater": { "periodCheckDelay": 600 // (10 minutes) } }}publicKey
Sección titulada “publicKey”Configura la clave pública para el cifrado de extremo a extremo live update Versión 2.
Disponible en Android, iOS y Electron.
Por defecto: undefined
{ "plugins": { "CapacitorUpdater": { "publicKey": "YOUR_PUBLIC_KEY" } }}resetWhenUpdate
Sección titulada “resetWhenUpdate”Elimina automáticamente los bundles descargados previamente cuando se instala en el dispositivo un bundle de app nativa más reciente.
Disponible en Android, iOS y Electron.
Por defecto: true
{ "plugins": { "CapacitorUpdater": { "resetWhenUpdate": false } }}responseTimeout
Sección titulada “responseTimeout”Configura cuántos milisegundos debe esperar el plugin nativo antes de considerar API como timeout.
Disponible en Android, iOS y Electron.
Por defecto: 20 (20 segundos)
{ "plugins": { "CapacitorUpdater": { "responseTimeout": 10 // (10 seconds) } }}shakeMenu
Sección titulada “shakeMenu”Activa el gesto de agitar para mostrar el menú de actualizaciones durante pruebas o debugging.
Disponible en Android, iOS y Electron.
Por defecto: false
{ "plugins": { "CapacitorUpdater": { "shakeMenu": true } }}statsUrl
Sección titulada “statsUrl”Configura la URL o endpoint al que se envían las estadísticas de actualizaciones.
Disponible en Android, iOS y Electron. Establece "" para deshabilitar el envío explícito de estadísticas a través de /stats.
Desactivar esto statsUrl no deshabilita todo el almacenamiento del dispositivo de Capgo. Si updateUrl permanece habilitado, /updates sigue almacenando la fila de MAU de facturación, el inventario de dispositivos y los datos de eventos de decisión de actualización necesarios para servir actualizaciones y contar MAU. Ver Cumplimiento para el desglose a nivel de campo.
Por defecto: https://plugin.capgo.app/stats
{ "plugins": { "CapacitorUpdater": { "statsUrl": "https://example.com/api/stats" } }}updateUrl
Sección titulada “updateUrl”Configura la URL / endpoint a la que se envían las comprobaciones de actualización.
Disponible en Android, iOS y Electron.
Por defecto: https://plugin.capgo.app/updates
{ "plugins": { "CapacitorUpdater": { "updateUrl": "https://example.com/api/auto_update" } }}version
Sección titulada “version”Configura la versión actual de la app. Se usará para la primera solicitud de actualización. Si no se establece, el plugin obtendrá la versión del code nativo.
Disponible en Android, iOS y Electron.
Por defecto: undefined
{ "plugins": { "CapacitorUpdater": { "version": "1.0.0" } }}Configuración de desarrollo
Sección titulada “Configuración de desarrollo”localApi
Sección titulada “localApi”Configura el CLI para usar un api local para pruebas.
Por defecto: undefined
{ "plugins": { "CapacitorUpdater": { "localApi": "http://localhost:54321/functions/v1" } }}localApiFiles
Sección titulada “localApiFiles”Configura el CLI para usar un archivo local api para pruebas.
Por defecto: undefined
{ "plugins": { "CapacitorUpdater": { "localApiFiles": "http://localhost:54321/functions/v1/files" } }}localHost
Sección titulada “localHost”Configura el CLI para usar un servidor local para pruebas o un servidor de actualizaciones autoalojado.
Por defecto: undefined
{ "plugins": { "CapacitorUpdater": { "localHost": "http://localhost:5173" } }}localSupa
Sección titulada “localSupa”Configura el CLI para usar un servidor local para pruebas o un servidor de actualizaciones autoalojado.
Por defecto: undefined
{ "plugins": { "CapacitorUpdater": { "localSupa": "http://localhost:54321" } }}localSupaAnon
Sección titulada “localSupaAnon”Configura CLI para usar un servidor local en pruebas.
Por defecto: undefined
{ "plugins": { "CapacitorUpdater": { "localSupaAnon": "YOUR_LOCAL_ANON_KEY" } }}localWebHost
Sección titulada “localWebHost”Configura el CLI para usar un servidor local para pruebas o un servidor de actualizaciones autoalojado.
Por defecto: undefined
{ "plugins": { "CapacitorUpdater": { "localWebHost": "http://localhost:5173" } }}Continúa desde Ajustes
Sección titulada “Continúa desde Ajustes”Si estás usando Configuración para planificar las operaciones del dashboard y de API, conéctalo con Al usar @capgo/capacitor-updater para la funcionalidad nativa al usar @capgo/capacitor-updater, Resumen de API para los detalles de implementación en API Overview, Introducción para los detalles de implementación en la Introducción, Claves de API para los detalles de implementación en las claves de API, y Dispositivos para el detalle de implementación en Devices.