Saltar al contenido

@capgo/capacitor-updater

Live update para apps de capacitor.

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

@capgo/capacitor-updater incluye Actualizaciones de bundle de JavaScript a apps de Capacitor en producción sin esperar la revisión de la tienda. Descarga bundles firmados en segundo plano, controla el despliegue con canales y reglas de retraso, y revierte si notifyAppReady() is not called within the configured appReadyTimeout.

Usos típicos: hotfix de bugs en producción, betas escalonadas por canal, experimentos A/B de UI 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 alojados

Los clientes de Cordova y Electron usan plugins hermanos vinculados arriba con el mismo backend de 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 canal 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 canal de la app dinámicamente en runtime.
downloadDescarga un nuevo bundle desde la URL proporcionada para su instalación posterior.
nextEstablece el próximo bundle que se activará cuando la app pase a segundo plano o se reinicie.
setEstablece el bundle actual y recarga la app inmediatamente.
deleteElimina un bundle del almacenamiento local para liberar espacio en disco.
setBundleErrorMarca manualmente un bundle como fallido/errored en modo de actualización manual.
listObtén todos los bundles descargados localmente y almacenados en tu app.
resetRestablece la app a un bundle conocido y estable.
currentObtén información sobre el bundle actualmente activo.
reloadRecarga manualmente la app para aplicar una actualización pendiente.
setMultiDelayConfigura las condiciones que deben cumplirse antes de aplicar una actualización pendiente.
cancelDelayCancela todas las condiciones de retraso y aplica la actualización pendiente de inmediato.
getLatestConsulta el servidor de actualizaciones para obtener la última versión de bundle disponible.
setChannelEstablece un canal de actualización de runtime local para este dispositivo. No crea una superposición de dispositivo en el dashboard/API.
unsetChannelElimina la asignación de canal del dispositivo y vuelve al canal predeterminado.
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 integrado (la versión original incluida con tu app nativa).
getDeviceIdObtén el identificador único y respetuoso con la privacidad de este dispositivo.
getPluginVersionObtén la versión del plugin Capacitor Updater instalado en tu app.
isAutoUpdateEnabledComprueba si las actualizaciones automáticas están activadas actualmente.
removeAllListenersElimina todos los listeners de eventos registrados para este plugin.
addListenerEscucha el evento de descarga de bundle en la App. Se dispara una vez que comienza la descarga, durante la misma y al finalizar. Esto te devolverá el porcentaje de descarga durante el proceso.
addListenerEscucha el evento de no necesidad de actualización, útil cuando quieres forzar la comprobación cada vez que se lanza la app.
addListenerEscucha el evento de actualización disponible, útil cuando quieres forzar la comprobación cada vez que se lanza la app.
addListenerEscucha los eventos de downloadComplete.
addListenerEscucha eventos de actualización incompatible cuando el backend marca una actualización como no compatible con la app actual. Emite el mismo payload que el legacy majorAvailable listener manual.
addListenerEscucha el evento de Major update en la App, te avisa cuando una major update está bloqueada por la configuración disableAutoUpdateBreaking.
addListenerEscucha el evento de fallo de actualización en la App para saber cuándo la instalación falla al iniciar la aplicación.
addListenerEscucha el evento set en la App, te avisa cuando un bundle se ha aplicado correctamente. Este evento se retiene nativamente hasta que JavaScript lo consume, por lo que si la app se recarga antes de que se adjunte tu listener, el último pendiente set se entrega una vez que el listener se suscribe.
addListenerEscucha el evento set next en la App, te avisa cuando un bundle se ha encolado como el siguiente bundle a instalar.
addListenerEscucha el evento de fallo de descarga en la App, te avisa cuando la descarga de un bundle ha fallado.
addListenerEscucha el evento reload en la App, te avisa cuando ha ocurrido 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 aún puede entregarse después de un reload incluso si el listener se adjunta más tarde en el inicio de la app.
addListenerEscucha el evento channel private, se dispara al intentar establecer un channel que no permite la autoasignación del dispositivo.
addListenerEscucha cambios en el estado de actualización flexible en Android.
isAutoUpdateAvailableComprueba si la función de actualización automática está disponible (no deshabilitada por la configuración del servidor).
getNextBundleObtén información sobre el bundle en cola para activarse en la próxima recarga.
getFailedUpdateRecupera información sobre el bundle más reciente que falló al cargar.
setShakeMenuActiva o desactiva el menú de gesto de sacudida para depuración y pruebas.
isShakeMenuEnabledComprueba si el menú de depuración por gesto de sacudida está actualmente activado.
setShakeChannelSelectorActiva o desactiva el selector de canal por sacudida en tiempo de ejecución.
isShakeChannelSelectorEnabledComprueba si el selector de canal por sacudida está actualmente activado.
getAppIdObtén el App ID configurado actualmente para la comunicación con el servidor de actualizaciones.
setAppIdCambia dinámicamente el App ID usado para la comunicación con el servidor de actualizaciones.
getAppUpdateInfoObtén información sobre la disponibilidad de la app en App Store o Play Store.
openAppStoreAbre la página de la app en 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.

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.