Configuraciones

Para tener un control más preciso sobre el sistema de actualización, puedes configurarlo con estas opciones:

Consejo

Cualquier cambio a estas configuraciones en el archivo Capacitor.config, requiere sincronizar la plataforma y lanzar a la tienda para que las aplicaciones en producción las reciban.

appReadyTimeout

Configura el número de milisegundos que el Plugin nativo debe esperar antes de considerar una actualización como ‘fallida’.

Solo disponible para Android e iOS.

Por defecto: 10000 (10 segundos)

capacitor.config.json

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

responseTimeout

Configura el número de milisegundos que el Plugin nativo debe esperar antes de considerar el timeout de la API.

Solo disponible para Android e iOS.

Por defecto: 20 (20 segundos)

capacitor.config.json

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

autoDeleteFailed

Configura si el Plugin debe eliminar automáticamente los Paquetes fallidos.

Solo disponible para Android e iOS.

Por defecto: true

capacitor.config.json

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

autoDeletePrevious

Configura si el Plugin debe eliminar automáticamente Paquetes anteriores después de una actualización exitosa.

Solo disponible para Android e iOS.

Por defecto: true

capacitor.config.json

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

autoUpdate

Configura si el Plugin debe usar Actualización Automática a través de un servidor de actualización.

Solo disponible para Android e iOS.

Por defecto: true

capacitor.config.json

{
  "plugins": {
    "CapacitorUpdater": {
      "autoUpdate": false
    }
  }
}

updateUrl

Configura la URL / endpoint a la cual se envían las verificaciones de actualización.

Solo disponible para Android e iOS.

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

capacitor.config.json

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

statsUrl

Configura la URL / endpoint a la cual se envían las estadísticas de actualización.

Solo disponible para Android e iOS. Establece como "" para deshabilitar el reporte de estadísticas.

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

capacitor.config.json

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

publicKey

Configura la clave pública para encriptación de actualización en vivo de extremo a extremo Versión 2.

Solo disponible para Android e iOS.

Por defecto: undefined

capacitor.config.json

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

directUpdate

Configura cuándo el Plugin debe instalar actualizaciones directamente. Solo para modo autoUpdate. Funciona bien para Aplicaciones menores a 10MB y con subidas hechas usando la bandera —partial. Zip o Aplicaciones de más de 10MB serán relativamente lentas para que los usuarios actualicen.

Opciones:

• false: Nunca hacer actualizaciones directas (usar comportamiento por defecto: descargar al iniciar, establecer al pasar a segundo plano)
• 'atInstall': Actualización directa solo cuando la Aplicación está instalada, actualizada desde la tienda, de lo contrario actuar como directUpdate = false
• 'onLaunch': Actualización directa solo en Aplicación instalada, actualizada desde la tienda o después de matar Aplicación, de lo contrario actuar como directUpdate = false
• 'always': Actualización directa en todos los casos anteriores (Aplicación instalada, actualizada desde la tienda, después de matar Aplicación o reanudar Aplicación), nunca actuar como directUpdate = false
• true: (obsoleto) Igual que “always” para compatibilidad hacia atrás

Solo disponible para Android e iOS.

Por defecto: false

capacitor.config.json

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

resetWhenUpdate

Eliminar automáticamente Paquetes descargados anteriormente cuando se instale un Paquete de Aplicación nativo más reciente en el dispositivo.

Solo disponible para Android e iOS.

Por defecto: true

capacitor.config.json

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

defaultChannel

Establece el canal por defecto para la Aplicación en la configuración. Sensible a mayúsculas. Esta configuración anulará el canal por defecto establecido en la nube, pero seguirá respetando las anulaciones hechas en la nube.

Solo disponible para Android e iOS.

Por defecto: undefined

capacitor.config.json

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

appId

Configura el id de la Aplicación en la configuración.

Solo disponible para Android e iOS.

Por defecto: undefined

capacitor.config.json

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

version

Configura la versión actual de la Aplicación. Esto se usará para la primera solicitud de actualización. Si no se establece, el Plugin obtendrá la versión del código nativo.

Solo disponible para Android e iOS.

Por defecto: undefined

capacitor.config.json

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

channelUrl

Configura la URL / endpoint para operaciones de canal.

Solo disponible para Android e iOS.

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

capacitor.config.json

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

autoSplashscreen

Manejar automáticamente el ocultamiento del splashscreen cuando se usa directUpdate. Cuando está habilitado, el Plugin ocultará automáticamente el splashscreen después de que se apliquen las actualizaciones o cuando no se necesite actualización. Esto elimina la necesidad de escuchar manualmente eventos appReady y llamar a SplashScreen.hide(). Solo funciona cuando directUpdate está establecido como “atInstall”, “always” o true. Requiere que el Plugin @Capacitor/splash-screen esté instalado y configurado con launchAutoHide: false. Requiere que autoUpdate y directUpdate estén habilitados.

Solo disponible para Android e iOS.

Por defecto: false

capacitor.config.json

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

periodCheckDelay

Configura el periodo de retraso para la verificación de actualización periódica. La unidad está en segundos. No puede ser menor a 600 segundos (10 minutos).

Solo disponible para Android e iOS.

Por defecto: 600 (10 minutos)

capacitor.config.json

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

allowModifyUrl

Permitir que el Plugin modifique updateUrl, statsUrl y channelUrl dinámicamente desde el lado de JavaScript.

Solo disponible para Android e iOS.

Por defecto: false

capacitor.config.json

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

keepUrlPathAfterReload

Configura el Plugin para mantener la ruta de URL después de una recarga.

Precaución

Cuando se activa una recarga, ‘window.history’ será borrado.

Solo disponible para Android e iOS.

Por defecto: false

capacitor.config.json

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

disableJSLogging

Deshabilitar el registro JavaScript del Plugin. Si es true, el Plugin no registrará en la consola JavaScript. Solo se hará el registro nativo.

Solo disponible para Android e iOS.

Por defecto: false

capacitor.config.json

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

shakeMenu

Habilitar gesto de sacudida para mostrar menú de actualización con propósitos de depuración/pruebas.

Solo disponible para Android e iOS.

Por defecto: false

capacitor.config.json

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

Configuraciones de Desarrollo

localHost

Configura el CLI para usar un servidor local para pruebas o servidor de actualización auto-hospedado.

Por defecto: undefined

capacitor.config.json

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

localWebHost

Configura el CLI para usar un servidor local para pruebas o servidor de actualización auto-hospedado.

Por defecto: undefined

capacitor.config.json

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

localSupa

Configura el CLI para usar un servidor local para pruebas o servidor de actualización auto-hospedado.

Por defecto: undefined

capacitor.config.json

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

localSupaAnon

Configura el CLI para usar un servidor local para pruebas.

Por defecto: undefined

capacitor.config.json

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

localApi

Configura el CLI para usar un API local para pruebas.

Por defecto: undefined

capacitor.config.json

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

localApiFiles

Configura el CLI para usar un API de archivos local para pruebas.

Por defecto: undefined

capacitor.config.json

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

Consejo

Hay configuraciones adicionales disponibles en la aplicación web de Capgo que se pueden configurar por canal sin requerir un lanzamiento de Aplicación nativa.