Saltar al contenido

@capgo/capacitor-updater

Live update para apps capacitor.

Las live updates de Capgo no se limitan a Capacitor. Usa el mismo backend y CLI con plugins cliente hermanos:

@capgo/capacitor-updater que impulsan Actualizaciones de bundles de JavaScript en apps de producción Capacitor sin esperar la revisión de la tienda. Descarga bundles firmados en segundo plano, controla el despliegue con canales y reglas de retraso, y haz rollback si notifyAppReady() no se llama dentro de la configuración de appReadyTimeout.

Usos típicos: hotfix de bugs en producción, betas escalonadas por canal, experimentos de UI A/B y rollback de emergencia al bundle integrado.

PlataformaSoporte
iOSSí
AndroidSí
WebLos bundles se aplican a la capa WebView en shells nativos, no a sitios estáticos

Los clientes de Cordova y Electron usan los plugins vinculados arriba con el mismo backend Capgo.

  • notifyAppReady - Notifica a la capa nativa que JavaScript se inicializó correctamente.
  • setUpdateUrl - Configura la URL de actualización de la app dinámicamente en runtime.
  • setStatsUrl - Configura la URL de estadísticas de la app dinámicamente en runtime.
  • setChannelUrl - Configura la URL del channel de la app dinámicamente en runtime.
MétodoDescripción
notifyAppReadyNotifica a la capa nativa que JavaScript se inicializó correctamente.
setUpdateUrlConfigura la URL de actualización de la app dinámicamente en runtime.
setStatsUrlConfigura la URL de estadísticas de la app dinámicamente en runtime.
setChannelUrlConfigura la URL del channel de la app dinámicamente en runtime.
downloadDescarga un nuevo bundle desde la URL para instalarlo después.
nextDefine el siguiente bundle para activarlo al pausar o reiniciar la app.
setEstablece el bundle actual y recarga la app inmediatamente.
deleteElimina un bundle del almacenamiento local para liberar espacio.
setBundleErrorMarca manualmente un bundle como fallido en modo de actualización manual.
listObtén todos los bundles descargados localmente en tu app.
resetRestablece la app a un bundle estable conocido.
currentObtén información sobre el bundle que está activo actualmente.
reloadRecarga la app manualmente para aplicar una actualización pendiente.
setMultiDelayConfigura las condiciones necesarias para aplicar una actualización pendiente.
cancelDelayCancela las condiciones de espera y aplica la actualización de inmediato.
getLatestConsulta el servidor de actualizaciones para ver la última versión disponible.
setChannelEstablece un canal de actualización local para este dispositivo. No crea un override de dispositivo en el dashboard de API.
unsetChannelElimina el canal asignado al dispositivo y vuelve al canal por defecto.
getChannelObtén el canal actual asignado a este dispositivo.
listChannelsObtén una lista de todos los canales disponibles para que este dispositivo se autoasigne.
setCustomIdSet a custom identifier for this device.
getBuiltinVersionObtén la versión del bundle integrada (la versión original incluida en tu Native Build).
getDeviceIdObtén el identificador único y privado de este dispositivo.
getPluginVersionObtén la versión del plugin Capacitor Updater instalada en tu app.
isAutoUpdateEnabledComprueba si las actualizaciones automáticas están habilitadas.
removeAllListenersElimina todos los event listeners registrados para este plugin.
addListenerEscucha el evento de descarga del bundle en la App. Se dispara al iniciar, durante y al finalizar la descarga, devolviendo el porcentaje de progreso.
addListenerEscucha el evento de 'no hay necesidad de actualizar', útil si quieres forzar la comprobación cada vez que se lanza la app.
addListenerEscucha el evento de actualización disponible, útil si quieres forzar una comprobación cada vez que se lanza la app.
addListenerEscucha los eventos de downloadComplete.
addListenerEscucha eventos de actualizaciones críticas cuando el backend marca una actualización como incompatible con la app actual. Emite el mismo payload que el majorAvailable listener.
addListenerEscucha el evento de actualización Major en la App; te avisa cuando una actualización importante se bloquea al configurar disableAutoUpdateBreaking.
addListenerEscucha el evento de fallo de actualización en la App; te avisa cuando una actualización no se pudo instalar al iniciar la app.
addListenerEscucha el evento set en la App; te avisa cuando un bundle se ha aplicado con éxito. Este evento se retiene nativamente hasta que JavaScript lo consume, por lo que si la app se recarga antes de conectar tu listener, el último set evento pendiente se entregará al suscribirse el listener.
addListenerEscucha el evento set next en la App; te avisa cuando un bundle se ha encolado como el próximo en instalarse.
addListenerEscucha el evento de fallo de descarga en la App; te avisa cuando la descarga de un bundle ha fallado.
addListenerEscucha el evento de reload en la App; te avisa cuando se ha producido un reload.
addListenerEscucha el evento app ready en la App; te avisa cuando la app está lista para usarse. Este evento se retiene nativamente hasta que JavaScript lo consume, por lo que puede entregarse tras un reload aunque el listener se conecte más tarde en el arranque.
addListenerEscucha el evento privado del canal, que se dispara al intentar establecer un canal que no permite la autoasignación del dispositivo.
addListenerEscucha los cambios de estado de las actualizaciones flexibles en Android.
isAutoUpdateAvailableComprueba si la función de auto-update está disponible (no desactivada por una configuración de servidor personalizada).
getNextBundleObtén información sobre el bundle en cola para activarse en el próximo reload.
getFailedUpdateRecupera información sobre el bundle más reciente que falló al cargar.
setShakeMenuActiva o desactiva el menú de gesto de sacudir (shake) para debugging y testing.
isShakeMenuEnabledComprueba si el menú de debug por gesto de sacudir está habilitado.
setShakeChannelSelectorActiva o desactiva el selector de canal por gesto de sacudir en runtime.
isShakeChannelSelectorEnabledComprueba si el selector de canal por gesto de sacudir está habilitado.
getAppIdObtén el App ID configurado actualmente para la comunicación con el servidor de updates.
setAppIdCambia dinámicamente el App ID usado para la comunicación con el servidor de updates.
getAppUpdateInfoObtén información sobre la disponibilidad de la app en la App Store o Play Store.
openAppStoreAbre la página de la app en la App Store o Play Store.
performImmediateUpdateRealiza una actualización inmediata en la app en Android.
startFlexibleUpdateInicia una actualización flexible en la app en Android.
completeFlexibleUpdateCompleta una actualización flexible en la app en Android.

Esta referencia se sincroniza desde src/definitions.ts en capacitor-updater.

Sigue avanzando con @capgo/capacitor-updater

Sección titulada “Sigue con @capgo/capacitor-updater”

Si estás usando @capgo/capacitor-updater para planificar el trabajo con plugins nativos, conéctalo con Al usar @capgo/capacitor-updater para la funcionalidad nativa al usar @capgo/capacitor-updater, Directorio de plugins de Capgo para el flujo de trabajo del producto en Capgo Plugin Directory, Plugins de Capacitor por Capgo para el detalle de implementación en los Plugins de Capacitor por Capgo, Añadir o actualizar plugins para el detalle de implementación en Agregar o actualizar plugins, y Alternativas a plugins de Ionic Enterprise para el flujo de trabajo del producto en Alternativas a plugins de Ionic Enterprise.