Configuración

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

Consejo

Cualquier cambio en estos ajustes del archivo capacitor.config requiere sincronizar la plataforma y publicar en la tienda para que las apps en producción los reciban.

Nota

Need EU data residency for Capgo Cloud? Set 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. Ubicación de datos.

Para usar tu propio hostname en updateUrl, statsUrl, y channelUrl, consulta la configuración de Custom Domain.

allowModifyUrl

Permite que el plugin modifique dinámicamente updateUrl, statsUrl y channelUrl desde JavaScript.

Disponible en Android, iOS y Electron.

Por defecto: false

archivo capacitor.config.json

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

appId

Configura el appId de la app en la configuración.

Disponible en Android, iOS y Electron.

Por defecto: undefined

archivo capacitor.config.json

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

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)

archivo capacitor.config.json

{
  "plugins": {
    "CapacitorUpdater": {
      "appReadyTimeout": 1000
    }
  }
}

autoDeleteFailed

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

Disponible en Android, iOS y Electron.

Por defecto: true

archivo capacitor.config.json

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

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

archivo capacitor.config.json

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

autoSplashscreen

Requerido al usar modos de instant apply ("atInstall", "onLaunch", o "always"), incluyendo los valores directUpdate obsoletos. Instala @capacitor/splash-screen y establece launchAutoHide: false. Cuando está activado, el plugin oculta el splashscreen tras aplicar las actualizaciones o si no es necesaria ninguna. Esto evita tener que escuchar manualmente los eventos appReady y llamar a SplashScreen.hide().

Disponible en Android e iOS.

Por defecto: false

archivo capacitor.config.json

{
  "plugins": {
    "CapacitorUpdater": {
      "autoUpdate": "atInstall",
      "autoSplashscreen": true
    },
    "SplashScreen": {
      "launchAutoHide": false
    }
  }
}

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. periodCheckDelay controles ese intervalo del temporizador.\ Aún se admiten valores booleanos por compatibilidad con versiones anteriores: true es lo mismo que "atBackground" y false es lo mismo que "off"Los valores de cadena combinan la configuración previa de Auto Update y Direct Update.

Opciones:

• "off" o false: Disable automatic update checks
• "atBackground" o true: 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": Se aplica inmediatamente solo tras una instalación limpia o actualización de la tienda; de lo contrario, usa "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, emite updateAvailable, 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)

archivo capacitor.config.json

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

channelUrl

Configura la URL o el endpoint para las operaciones del canal.

Disponible en Android, iOS y Electron.

Por defecto: https://plugin.capgo.app/channel_self

archivo capacitor.config.json

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

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

archivo capacitor.config.json

{
  "plugins": {
    "CapacitorUpdater": {
      "defaultChannel": "production"
    }
  }
}

directUpdate

Obsoleto. Usa autoUpdate modos 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 --delta para que la actualización no ralentice la experiencia del usuario. Estos modos requieren autoSplashscreen: true y @capacitor/splash-screen con launchAutoHide: false.

Opciones:

• false: Nunca realices actualizaciones directas
• 'atInstall': Igual que autoUpdate: "atInstall"
• 'onLaunch': Igual que autoUpdate: "onLaunch"
• 'always': Igual que autoUpdate: "always"
• true: (obsoleto) Igual que "always" para compatibilidad con versiones anteriores

Disponible en Android, iOS y Electron.

Por defecto: false

archivo capacitor.config.json

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

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

archivo capacitor.config.json

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

keepUrlPathAfterReload

Configura el plugin para mantener la ruta de la URL tras un reload.

Precaución

Cuando se dispare un reload, se limpiará ‘window.history’.

Disponible en Android, iOS y Electron.

Por defecto: false

archivo capacitor.config.json

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

periodCheckDelay

Configura el intervalo de tiempo para la comprobación de actualizaciones. 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)

archivo capacitor.config.json

{
  "plugins": {
    "CapacitorUpdater": {
      "periodCheckDelay": 600 // (10 minutes)
    }
  }
}

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

archivo capacitor.config.json

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

Precaución

publicKey configura Encryption V2 y debe coincidir con la clave privada usada durante el upload. Para actualizaciones Delta, usa Encryption V2 con partial encryption activado, y habilita encrypted-bundle enforcement si tu organización requiere que cada upload esté cifrado. No confíes solo en publicKey como una política del lado del servidor que impide publicar un Delta sin cifrar.

resetWhenUpdate

Elimina automáticamente los bundles descargados anteriormente cuando se instala un nuevo bundle de la app nativa en el dispositivo.

Disponible en Android, iOS y Electron.

Por defecto: true

archivo capacitor.config.json

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

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)

archivo capacitor.config.json

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

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

archivo capacitor.config.json

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

statsUrl

Configura la URL o el endpoint al que se envían las estadísticas de las actualizaciones.

Disponible en Android, iOS y Electron. Establece "" para desactivar el reporte de estadísticas mediante /stats.

Desactivar esto statsUrl no desactiva todo el almacenamiento de Capgo en el dispositivo. Si updateUrl permanece habilitado, /updates aún almacena 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 updates y contar MAU. Consulta Cumplimiento para el desglose a nivel de campo.

Por defecto: https://plugin.capgo.app/stats

archivo capacitor.config.json

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

updateUrl

Configura la URL o el endpoint donde se envían las comprobaciones de actualización.

Disponible en Android, iOS y Electron.

Por defecto: https://plugin.capgo.app/updates

archivo capacitor.config.json

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

version

Configura la versión actual de la app. Se usará para la primera solicitud de actualización. Si no se define, el plugin obtendrá la versión desde el code nativo.

Disponible en Android, iOS y Electron.

Por defecto: undefined

archivo capacitor.config.json

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

Configuración de desarrollo

localApi

Configura el CLI para usar un api local para pruebas.

Por defecto: undefined

archivo capacitor.config.json

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

localApiFiles

Configura el CLI para usar un archivo local api para pruebas.

Por defecto: undefined

archivo capacitor.config.json

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

localHost

Configura CLI para usar un servidor local de pruebas o un servidor de actualizaciones propio.

Por defecto: undefined

archivo capacitor.config.json

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

localSupa

Configura CLI para usar un servidor local de pruebas o un servidor de actualizaciones propio.

Por defecto: undefined

archivo capacitor.config.json

{
  "plugins": {
    "CapacitorUpdater": {
      "localSupa": "http://localhost:54321"
    }
  }
}

localSupaAnon

Configura el CLI para usar un servidor local en tus pruebas.

Por defecto: undefined

archivo capacitor.config.json

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

localWebHost

Configura el CLI para usar un servidor local o un servidor de actualizaciones propio.

Por defecto: undefined

archivo capacitor.config.json

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

Consejo

Hay ajustes adicionales disponibles en la web app de Capgo que puedes configurar por canal sin necesidad de lanzar una versión nativa de la app.

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.