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

Permita que el complemento modifique la updateUrl, statsUrl y channelUrl de manera dinámica desde el lado JavaScript.

Disponible en Android, iOS, y Electron.

Predeterminado: false

capacitor.config.json

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

appId

Configure el id de 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.

Predeterminado: 10000 (10 segundos)

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.

Predeterminado: true

capacitor.config.json

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

autoDeletePrevious

Configura si el plugin debe eliminar automáticamente los bundles anteriores después de una actualización exitosa.

Disponible en Android, iOS y Electron.

Predeterminado: true

capacitor.config.json

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

autoSplashscreen

Maneja 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 manualmente eventos de aplicación lista y llamar a SplashScreen.hide(). Solo funciona cuando autoUpdate se establece en "atInstall", "onLaunch", o "always". Los valores legados todavía se admiten para 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.

Predeterminado:

__CAPGO_KEEP_0__.config.json false

capacitor.config.json

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

autoUpdate

Configure cómo el plugin debe utilizar la actualización automática a través de un servidor de actualizaciones. Los valores booleanos todavía se admiten para compatibilidad hacia atrás: true es lo mismo que "atBackground" y false es lo mismo que "off".

Opciones:

• "off" o false: Deshabilitar la actualización automática
• "atBackground" o true: Comprueba y descarga automáticamente, luego aplica cuando la aplicación se mueve al fondo
• "atInstall": Aplica inmediatamente solo después de una instalación fresca o actualización de aplicación nativa, en caso contrario usa "atBackground"
• "onLaunch": Aplica inmediatamente al inicio, en caso contrario usa "atBackground" después del lanzamiento verificar
• "always"Aplicar inmediatamente cada vez que se ejecute Auto Actualizar
• "onlyDownload"Verificar y descargar automáticamente, emitir updateAvailabley nunca establecer el siguiente paquete automáticamente

Disponible en Android, iOS y Electron.

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

capacitor.config.json

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

channelUrl

Configurar la URL / punto de conexión para las operaciones de canal.

Disponible en Android, iOS y Electron.

Default: https://plugin.capgo.app/channel_self

capacitor.config.json

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

defaultChannel

Establece el canal por defecto para la aplicación en la configuración. Sensible a mayúsculas y minúsculas. Esta configuración sobreescribirá el canal por defecto establecido en la nube, pero aún respetará las sobrescripciones realizadas en la nube.

Disponible en Android, iOS y Electron.

Default: undefined

capacitor.config.json

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

directUpdate

Obsoleto. Utilice autoUpdate modos de cadena en su lugar: "atInstall", "onLaunch"o "always"Esta opción sigue siendo compatible con las 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 “siempre” para compatibilidad hacia atrás

Disponible en Android, iOS y Electron.

Predeterminado: false

capacitor.config.json

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

disableJSLogging

Deshabilitar 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

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

Cuidado

Al activar un 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 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)
    }
  }
}

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 (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 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 de estadísticas explícitas a través de /stats.

Desactivar statsUrl no desactiva todos los datos de almacenamiento de dispositivo Capgo. Si updateUrl se mantiene habilitado, /updates sigue almacenando la fila de facturación MAU, el inventario de dispositivos y los datos de eventos de decisión de actualización necesarios para servir actualizaciones y contar MAU. Consulte Cumplimiento para la desglose de nivel de campo.

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

capacitor.config.json

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

updateUrl

Configura la URL / punto de conexión a la que se envían las comprobaciones de actualizaciones.

Disponible en Android, iOS y Electron.

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

capacitor.config.json

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

version

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

Configuración de desarrollo

localApi

Configure el CLI para utilizar un api local 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

Configura 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

Configura el 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

Configura el CLI para utilizar un servidor local para pruebas.

Predeterminado: undefined

capacitor.config.json

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

localWebHost

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

Consejo

Hay ajustes adicionales disponibles en la aplicación web de __CAPGO_KEEP_0__ que pueden configurarse por canal sin requerir una actualización de la aplicación nativa. Capgo web app Consejo

Sigue adelante desde Configuración

Si estás utilizando Configuración para planificar la consola de dashboard y operaciones API, 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 los detalles de implementación en las API Claves, y Dispositivos para los detalles de implementación en Dispositivos.