Configuración

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

Consejo

Cualquier cambio en estas configuraciones 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

Permitir al plugin modificar la updateUrl, statsUrl y channelUrl dinámicamente desde el lado del JavaScript.

Disponible en Android, iOS y Electron.

Predeterminado: false

capacitor.config.json

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

appId

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

Predeterminado: 10000 (10 segundos)

capacitor.config.json

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

autoDeleteFailed

Configurar si el complemento debe eliminar automáticamente los paquetes 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 previos después de una actualización exitosa.

Disponible en Android, iOS y Electron.

Predeterminado: true

capacitor.config.json

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

autoSplashscreen

Automáticamente gestiona la ocultación de la pantalla de bienvenida al utilizar 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 está configurado en "atInstall", "onLaunch", o "always". Valores legados todavía se admiten por 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.

Disponible en Android, iOS y Electron.

Predeterminado: false

capacitor.config.json

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

autoUpdate

Configure cómo el plugin debe utilizar Auto Actualización 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" o false es lo mismo que "off".

Opciones:

• "off" o false: Deshabilitar Auto Actualización
• "atBackground" o true: Verifique y descargue automáticamente, luego aplique cuando la aplicación se mueva al fondo
• "atInstall": Aplicar inmediatamente solo después de una instalación fresca o actualización de la aplicación nativa, en caso contrario utilice "atBackground"
• "onLaunch": Aplicar inmediatamente al inicio, en caso contrario utilice "atBackground" después de la verificación de inicio
• "always": Aplicar inmediatamente cada vez que se ejecute Auto Actualización
• "onlyDownload": Verifique y descargue automáticamente, emita updateAvailable, y nunca establezca el siguiente paquete 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 las 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 superará 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 "always". Esta opción permanece soportada para 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

Desactivar el registro de JavaScript del complemento. Si es verdadero, el complemento 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 complemento para mantener la ruta de URL después de recargar.

Cuidado

Cuando se activa 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 espera 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

Configura 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

Configure el número de milisegundos que el plugin nativo debe esperar antes de considerar API como tiempo de espera.

Disponible en Android, iOS y Electron.

Predeterminado: 20 (20 segundos)

capacitor.config.json

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

shakeMenu

Habilitar gesto de sacudir para mostrar 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 al que se envían estadísticas actualizadas.

Disponible en Android, iOS y Electron. Establezca a "" para deshabilitar la informe de estadísticas.

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

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

capacitor.config.json

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

Configuración de desarrollo

localApi

Configure el CLI para utilizar un api local para pruebas.

Default: undefined

capacitor.config.json

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

localApiFiles

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

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

Default: undefined

capacitor.config.json

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

localSupa

Configure 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

Configure el 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 de aplicación nativa.

Sigue adelante desde Configuración

Si estás utilizando Configuración to plan dashboard and API operations, connect it with Usando @capgo/capacitor-actualizador para la capacidad nativa en Usando @capgo/capacitor-actualizador, Resumen de API para el detalle de implementación en Resumen de API, Introducción para el detalle de implementación en Introducción, Claves de API para el detalle de implementación en Claves de API, y Dispositivos para el detalle de implementación en Dispositivos.