Funciones y ajustes

Plugin de Actualizador de Configuración

Consulte el Github Readme para obtener más información.

CapacitorUpdater se puede configurar con estas opciones:

Propiedad	Tipo	Descripción	Valor predeterminado	Desde
appReadyTimeout	number	Configure el número de milisegundos que el plugin nativo debe esperar antes de considerar una actualización como ‘fallida’. Disponible en Android, iOS y Electron.	10000 // (10 seconds)
responseTimeout	number	Configure el número de milisegundos que el plugin nativo debe esperar antes de considerar API como un tiempo de espera. Disponible en Android, iOS y Electron.	20000 // (20 seconds)
autoDeleteFailed	boolean	Configure si el plugin debe utilizar la eliminación automática de paquetes fallidos. Disponible en Android, iOS y Electron.	true
autoDeletePrevious	boolean	Configure si el plugin debe utilizar la eliminación automática de paquetes previos después de una actualización exitosa. Disponible en Android, iOS y Electron.	true
autoUpdate	boolean | ‘off’ | ‘atBackground’ | ‘atInstall’ | ‘onLaunch’ | ‘always’ | ‘onlyDownload’	Configure cómo el plugin utiliza la actualización automática a través de un servidor de actualizaciones. true es lo mismo que “en segundo plano”; false es lo mismo que “apagado”. - apagado: Deshabilita la actualización automática - en segundo plano: Verifica y descarga automáticamente, y luego aplica cuando la aplicación se mueve al segundo plano - en la instalación: Aplica inmediatamente solo después de una instalación fresca o actualización de la aplicación nativa, de lo contrario utilice en segundo plano - al arranque: Aplica inmediatamente al arranque, de lo contrario utilice en segundo plano después del chequeo de arranque - siempre: Aplica inmediatamente cada vez que se ejecuta la actualización automática - soloDescargar: Verifica y descarga automáticamente, emite actualización disponible y nunca establezca el paquete siguiente automáticamente. Disponible en Android, iOS y Electron.	”atBackground” // true is still accepted
resetWhenUpdate	boolean	Elimina automáticamente los paquetes descargados previos cuando se instala un paquete de aplicación nativa más nuevo en el dispositivo. Disponible en Android, iOS y Electron.	true
updateUrl	string	Configure la URL / punto final a la que se envían los chequeos de actualización. Disponible en Android, iOS y Electron.	https://plugin.capgo.app/updates
channelUrl	string	Configure la URL / punto final para las operaciones de canal. Disponible en Android, iOS y Electron.	https://plugin.capgo.app/channel_self
statsUrl	string	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.	https://plugin.capgo.app/stats
publicKey	string	Configure la clave pública para la cifrado de actualización en vivo de fin a fin. Versión 2. Disponible en Android, iOS y Electron.	undefined	6.2.0
version	string	Configure la versión actual de la aplicación. Se utilizará para la primera solicitud de actualización. Si no se establece, el plugin obtendrá la versión del nativo code. Disponible en Android, iOS y Electron.	undefined	4.17.48
directUpdate	boolean | ‘always’ | ‘atInstall’ | ‘onLaunch’	Obsoleto. Utilice en su lugar los modos de cadena de actualización automática: “atInstall”, “onLaunch” o “always”. Esta opción permanece soportada para aplicaciones existentes. - false: Nunca haga actualizaciones directas - atInstall: Lo mismo que autoUpdate: “atInstall” - onLaunch: Lo mismo que autoUpdate: “onLaunch” - siempre: Lo mismo que autoUpdate: “always” - true: Lo mismo que “siempre” para compatibilidad hacia atrás. Disponible en Android, iOS y Electron.	false	5.1.0
autoSplashscreen	boolean	Gestionar 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 necesita ninguna actualización. Esto elimina la necesidad de escuchar eventos de aplicación lista y llamar a SplashScreen.hide(). Solo funciona cuando autoUpdate está configurado en “atInstall”, “onLaunch” o “siempre”. Los valores de directUpdate legados todavía se admiten para compatibilidad hacia atrás. Requiere la instalación y configuración del plugin @capacitor/splash-screen con launchAutoHide: false. Requiere que la actualización automática esté habilitada. Disponible en Android e iOS.	false	7.6.0
periodCheckDelay	number	Configure el período de espera para la verificación de actualizaciones. El unidad es en segundos. Disponible en Android, iOS y Electron. No puede ser menor a 600 segundos (10 minutos).	600 // (10 minutes)
localS3	boolean	Configure el CLI para utilizar un servidor local para pruebas o servidor de actualizaciones autoalojado.	undefined	4.17.48
localHost	string	Configure el CLI para utilizar un servidor local para pruebas o servidor de actualizaciones autoalojado.	undefined	4.17.48
localWebHost	string	Configure el CLI para utilizar un servidor local para pruebas o servidor de actualizaciones autoalojado.	undefined	4.17.48
localSupa	string	Configure el CLI para utilizar un servidor local para pruebas o servidor de actualizaciones autoalojado.	undefined	4.17.48
localSupaAnon	string	Configure el CLI para utilizar un servidor local para pruebas.	undefined	4.17.48
localApi	string	Configure el CLI para utilizar un servidor local api para pruebas.	undefined	6.3.3
localApiFiles	string	Configure el CLI para utilizar un archivo local api para pruebas.	undefined	6.3.3
allowModifyUrl	boolean	Permitir al plugin modificar la URL de actualización, la URL de estadísticas y la URL de canal dinámicamente desde el lado de JavaScript.	false	5.4.0
defaultChannel	string	Establecer el canal predeterminado para la aplicación en la configuración. Sensible a mayúsculas y minúsculas. Esta configuración sobreescribirá el canal predeterminado establecido en la nube, pero aún respetará las sobrescripciones realizadas en la nube.	undefined	5.5.0
appId	string	Configure el ID de la aplicación para la aplicación en la configuración.	undefined	6.0.0
keepUrlPathAfterReload	boolean	Configure el plugin para mantener la ruta de la URL después de un recarga. ADVERTENCIA: Cuando se desencadena una recarga, ‘window.history’ se borrará.	false	6.8.0
disableJSLogging	boolean	Desactivar el registro de JavaScript del plugin. Si es verdadero, el plugin no registrará en la consola de JavaScript. Solo se hará el registro nativo	false	7.3.0
shakeMenu	boolean	Activar el gesto de sacudir para mostrar el menú de actualización para fines de depuración/pruebas	false	7.5.0

Ejemplos

En capacitor.config.json:

{
  "plugins": {
    "CapacitorUpdater": {
      "appReadyTimeout": 1000 // (1 second),
      "responseTimeout": 10 // (10 second),
      "autoDeleteFailed": false,
      "autoDeletePrevious": false,
      "autoUpdate": "onlyDownload",
      "resetWhenUpdate": false,
      "updateUrl": https://example.com/api/auto_update,
      "channelUrl": https://example.com/api/channel,
      "statsUrl": https://example.com/api/stats,
      "publicKey": undefined,
      "version": undefined,
      "directUpdate": undefined,
      "autoSplashscreen": undefined,
      "periodCheckDelay": undefined,
      "localS3": undefined,
      "localHost": undefined,
      "localWebHost": undefined,
      "localSupa": undefined,
      "localSupaAnon": undefined,
      "localApi": undefined,
      "localApiFiles": undefined,
      "allowModifyUrl": undefined,
      "defaultChannel": undefined,
      "appId": undefined,
      "keepUrlPathAfterReload": undefined,
      "disableJSLogging": undefined,
      "shakeMenu": undefined
    }
  }
}

En capacitor.config.ts:

import { CapacitorConfig } from '@capacitor/cli';

const config: CapacitorConfig = {
  plugins: {
    CapacitorUpdater: {
      appReadyTimeout: 1000 // (1 second),
      responseTimeout: 10 // (10 second),
      autoDeleteFailed: false,
      autoDeletePrevious: false,
      autoUpdate: 'onlyDownload',
      resetWhenUpdate: false,
      updateUrl: https://example.com/api/auto_update,
      channelUrl: https://example.com/api/channel,
      statsUrl: https://example.com/api/stats,
      publicKey: undefined,
      version: undefined,
      directUpdate: undefined,
      autoSplashscreen: undefined,
      periodCheckDelay: undefined,
      localS3: undefined,
      localHost: undefined,
      localWebHost: undefined,
      localSupa: undefined,
      localSupaAnon: undefined,
      localApi: undefined,
      localApiFiles: undefined,
      allowModifyUrl: undefined,
      defaultChannel: undefined,
      appId: undefined,
      keepUrlPathAfterReload: undefined,
      disableJSLogging: undefined,
      shakeMenu: undefined,
    },
  },
};

export default config;

• notifyAppReady()
• setUpdateUrl(...)
• setStatsUrl(...)
• setChannelUrl(...)
• download(...)
• next(...)
• set(...)
• delete(...)
• list(...)
• reset(...)
• current()
• reload()
• setMultiDelay(...)
• cancelDelay()
• getLatest(...)
• setChannel(...)
• unsetChannel(...)
• getChannel()
• listChannels()
• setCustomId(...)
• getBuiltinVersion()
• getDeviceId()
• getPluginVersion()
• isAutoUpdateEnabled()
• removeAllListeners()
• addListener('download', ...)
• addListener('noNeedUpdate', ...)
• addListener('updateAvailable', ...)
• addListener('downloadComplete', ...)
• addListener('majorAvailable', ...)
• addListener('updateFailed', ...)
• addListener('downloadFailed', ...)
• addListener('appReloaded', ...)
• addListener('appReady', ...)
• isAutoUpdateAvailable()
• getNextBundle()
• setShakeMenu(...)
• isShakeMenuEnabled()
• Interfaces
• Alias de tipo

Métodos

notifyAppReady()

notifyAppReady() => Promise<AppReadyResult>

Notificar al actualizador de Capacitor que la actualización actual está funcionando (se producirá un reenvío si no se llama a este método en cada arranque de la aplicación) Por defecto, este método debe llamarse en las primeras 10 seg después del arranque de la aplicación, de lo contrario se producirá un reenvío. Cambie este comportamiento con {@link appReadyTimeout}

Devuelve: Promise<AppReadyResult>

---

setUpdateUrl(…)

setUpdateUrl(options: UpdateUrl) => Promise<void>

Establecer la URL de actualización para la aplicación, se utilizará para verificar actualizaciones.

Parámetro	Tipo	Descripción
options	UpdateUrl	contiene la URL para usar para verificar actualizaciones.

Desde: 5.4.0

---

setStatsUrl(…)

setStatsUrl(options: StatsUrl) => Promise<void>

Establece la URL de estadísticas para la aplicación, se utilizará para enviar estadísticas. Pasar una cadena vacía deshabilitará la recopilación de estadísticas.

Parámetro	Tipo	Descripción
options	StatsUrl	contiene la URL para usar para enviar estadísticas.

Desde: 5.4.0

---

setChannelUrl(…)

setChannelUrl(options: ChannelUrl) => Promise<void>

Establecer el canalUrl para la aplicación, esto se usará para establecer el canal.

Parámetro	Tipo	Descripción
options	ChannelUrl	contiene la URL a usar para establecer el canal.

Desde: 5.4.0

---

download(…)

download(options: DownloadOptions) => Promise<BundleInfo>

Descargar un nuevo paquete desde la URL proporcionada, debe ser un archivo zip, con archivos dentro o con un id único dentro con todos tus archivos

Parámetro	Tipo	Descripción
options	DownloadOptions	El {@link Opciones de descarga para descargar un nuevo archivo zip de paquetes.Devuelve:

Siguiente (…) Promise<BundleInfo>

---

Sección titulada “Siguiente (…)

next(options: BundleId) => Promise<BundleInfo>

Parámetro

Opciones de descarga para descargar un nuevo archivo zip de paquetes.	Tipo	Descripción
options	BundleId	Contiene la ID del siguiente Bundle para establecer en la próxima apertura de la aplicación. {@link BundleInfo.id}

Devuelve: Promise<BundleInfo>

---

set(…)

set(options: BundleId) => Promise<void>

Establece el paquete actual y recarga inmediatamente la aplicación.

Parámetro	Tipo	Descripción
options	BundleId	Un objeto {@link BundleId} que contiene el nuevo identificador de paquete para establecer como actual. BundleIdElimina (…)

---

Sección titulada “delete(…)”

delete(options: BundleId) => Promise<void>

Param

Tipo	Descripción	Un objeto {@link BundleId}
options	BundleId	A {@link BundleIdobjeto que contiene la ID de un paquete para eliminar (nota, esta es la ID del paquete, NO el nombre de la versión)

---

lista(…)

list(options?: ListOptions | undefined) => Promise<BundleListResult>

Obtener todos los paquetes descargados localmente en tu aplicación

Parámetro	Tipo	Descripción
options	ListOptions	Los {@link Opciones de lista para paquetes} para listar paquetes

Devuelve: Promise<BundleListResult>

---

reset(…)

reset(options?: ResetOptions | undefined) => Promise<void>

Restablecer la aplicación a la builtin paquete (el que se envía a Apple App Store / Google Play Store ) o el último paquete cargado con éxito.

Param	Tipo	Descripción
options	ResetOptions	Conteniendo {@link ResetOptions.toLastSuccessful}, true restablece a la paquete de inicio y false se restablecerá al último paquete cargado con éxito.

---

actual()

current() => Promise<CurrentBundleResult>

Obtenga el paquete actual, si no hay ninguno establecido devuelve builtin. actualNative es el paquete original instalado en el dispositivo

Devuelve: Promise<CurrentBundleResult>

---

recargar()

reload() => Promise<void>

Recargar la vista

---

establecerMultiRetraso(…)

setMultiDelay(options: MultiDelayConditions) => Promise<void>

Establece un arreglo de {@link "DelayCondition"} que el Plugin utilizará para retrasar la actualización. Después de que todas las condiciones se cumplan, el proceso de actualización se ejecutará de nuevo como de costumbre, por lo que la actualización se instalará después de un segundo plano o la eliminación de la aplicación. Para el "kind", el valor debe ser una cadena de fecha en formato iso8601. Para el "kind", el valor debe ser un número en milisegundos. Para el "kind", el valor debe ser el número de versión. Para el "kind", el valor no se utiliza. La función tiene comportamiento inconsistente con la opción "kill" que hace que la actualización se ejecute después del primer kill y no después del siguiente segundo plano como otras opciones. Esto se arreglará en una futura versión mayor. ParámetroTipo date Descripción background Conteniendo el {@link "DelayCondition"} nativeVersion Param kill Type

Description	Containing the {@link "DelayCondition"}	Copy to clipboard
options	MultiDelayConditions	Sets a {@link "DelayCondition"} array containing conditions that the Plugin will use to delay the update. After all conditions are met, the update process will run start again as usual, so update will be installed after a backgrounding or killing the app. For the "kind", the value should be an iso8601 date string. For the "kind", the value should be a number in milliseconds. For the "kind", the value should be the version number. For the "kind", the value is not used. The function has inconsistent behavior the option kill do trigger the update after the first kill and not after the next background like other options. This will be fixed in a future major release. MultiDelayConditions__CAPGO_KEEP_0__

Desde: 4.3.0

---

cancelDelay()

cancelDelay() => Promise<void>

Cancela una {@link DelayCondition} para procesar una actualización de inmediato. Desde:getLatest(…)

Sección titulada “getLatest(…) 4.0.0

---

Copiar a portapapeles

getLatest(options?: GetLatestOptions | undefined) => Promise<LatestVersion>

Obtener el paquete más reciente disponible desde la URL de actualización

Parámetro	Tipo
options	GetLatestOptions

Devuelve: Promise<LatestVersion>

Desde: 4.0.0

---

setChannel(…)

setChannel(options: SetChannelOptions) => Promise<ChannelRes>

Establece el canal local gestionado por el plugin para este dispositivo. El canal debe estar allow_device_self_set habilitado para que esto funcione.

setChannel() valida el canal con el servidor, luego almacena el canal seleccionado localmente en el dispositivo. No crea ni actualiza un Device Override en el servidor, por lo que el dispositivo no aparecerá como sobrescrito en el panel de control Capgo. Solo se muestran las asignaciones creadas desde el panel de control o desde el Public API en la interfaz de usuario de Device Override.

Notas importantes:

• No utilice este método para establecer el canal en el arranque. Utilice el defaultChannel en su Capacitor config en su lugar.
• Este método está destinado a su uso después de que la aplicación esté lista y el usuario haya interactuado (por ejemplo, optando por un programa de beta).
• Los canales públicos no pueden asignarse automáticamente. Si un canal está marcado como public, llamar a setChannel() devolverá un error. Para utilizar un canal público, llame a unsetChannel() en su lugar - el dispositivo caerá automáticamente en el canal público correspondiente.
• Use listChannels() para descubrir qué canales están disponibles y si permiten la asignación automática.

Param	Tipo	Descripción
options	SetChannelOptions	¿Es el canal {@link SetChannelOptions} para establecer

Devuelve: Promise<ChannelRes>

Desde: 4.7.0

---

unsetChannel(…)

unsetChannel(options: UnsetChannelOptions) => Promise<void>

Deshacer el canal local gestionado por el plugin para este dispositivo. Esto elimina solo el canal almacenado localmente por setChannel()no elimina registros de dispositivo público ni de la consola API

Después de llamar a este método, la precedencia normal de canal se aplica: un Dashboard o un dispositivo público existente API con Override todavía gana; de lo contrario, el dispositivo puede caer en el canal público/por defecto que coincide con sus condiciones (plataforma, tipo de dispositivo, tipo de compilación).

Esto es útil cuando:

• Quieres mover un dispositivo a la pista de actualización predeterminada
• Quieres usar un canal público (ya que los canales públicos no pueden ser asignados de forma autónoma mediante setChannel())

Parámetro	Tipo
options	UnsetChannelOptions

Desde: 4.7.0

---

getChannel()

getChannel() => Promise<GetChannelRes>

Obtén el canal para este dispositivo

Devuelve: Promise<GetChannelRes>

Desde: 4.8.0

---

listChannels()

listChannels() => Promise<ListChannelsResult>

Lista todos los canales disponibles para este dispositivo. Devuelve canales que sean compatibles con el entorno actual del dispositivo (plataforma, emulador/dispositivo real, compilación de desarrollo/producción) y que sean públicos o permitan la autoasignación.

Cada canal en el resultado incluye:

• publicSi true, este es un canales predeterminados. No puedes autoasignarte a él utilizando setChannel(). En su lugar, si eliminas tu asignación de canal utilizando unsetChannel()el dispositivo recibirá automáticamente actualizaciones de este canal público.
• allow_self_setIf: trueesta es una canal autoasignable. Puede asignar explícitamente el dispositivo a este canal utilizando setChannel().

Devuelve: Promise<ListChannelsResult>

Desde: 7.5.0

---

setCustomId(…)

setCustomId(options: SetCustomIdOptions) => Promise<void>

Establecer un ID personalizado para este dispositivo

Parámetro	Tipo	Descripción
options	SetCustomIdOptions	es el {@link SetCustomIdOptions} identificador personalizado para establecer

Desde: 4.9.0

---

getBuiltinVersion()

getBuiltinVersion() => Promise<BuiltinVersion>

Obtenga la versión del app nativa o la versión incorporada si se establece en la configuración

Devuelve: Promise<BuiltinVersion>

Desde: 5.2.0

---

getDeviceId()

getDeviceId() => Promise<DeviceId>

Obtiene el ID único utilizado para identificar el dispositivo (enviado al servidor de actualización automática)

Devuelve: Promise<DeviceId>

---

getPluginVersion()

getPluginVersion() => Promise<PluginVersion>

Obtiene la versión nativa del plugin de actualización Capacitor (enviado al servidor de actualización automática)

Devuelve: Promise<PluginVersion>

---

isAutoUpdateEnabled()

isAutoUpdateEnabled() => Promise<AutoUpdateEnabled>

Obtenga el estado de la configuración de actualización automática.

Devuelve: Promise<AutoUpdateEnabled>

---

removeAllListeners()

removeAllListeners() => Promise<void>

Elimine todos los oyentes para este plugin.

Desde: 1.0.0

---

addListener('descargar', …)

addListener(eventName: 'download', listenerFunc: (state: DownloadEvent) => void) => Promise<PluginListenerHandle>

Escuche el evento de descarga de paquete en la aplicación. Dispara una vez que se ha iniciado la descarga, durante la descarga y cuando se ha completado. Este devolverá todos los porcentajes de descarga durante la descarga

Param	Tipo
eventName	’download’
listenerFunc	(state: DownloadEvent) => void

Devuelve: Promise<PluginListenerHandle>

Desde: 2.0.11

---

addListener('noNeedUpdate', …)

addListener(eventName: 'noNeedUpdate', listenerFunc: (state: NoNeedEvent) => void) => Promise<PluginListenerHandle>

Escuchar evento de no necesidad de actualizar, útil cuando deseas forzar la comprobación cada vez que se lanza la aplicación

Parámetro	Tipo
eventName	’noNeedUpdate’
listenerFunc	(state: NoNeedEvent) => void

Devuelve: Promise<PluginListenerHandle>

Desde: 4.0.0

---

addListener('updateAvailable', …)

addListener(eventName: 'updateAvailable', listenerFunc: (state: UpdateAvailableEvent) => void) => Promise<PluginListenerHandle>

Escuchar el evento de actualización disponible, útil cuando deseas verificar cada vez que se lanza la aplicación

Parámetro	Tipo
eventName	’updateAvailable’
listenerFunc	(state: UpdateAvailableEvent) => void

Devuelve: Promise<PluginListenerHandle>

Desde: 4.0.0

---

addListener(‘downloadComplete’, …)

addListener(eventName: 'downloadComplete', listenerFunc: (state: DownloadCompleteEvent) => void) => Promise<PluginListenerHandle>

Escuchar eventos de descarga completa.

Parámetro	Tipo
eventName	’downloadComplete’
listenerFunc	(state: DownloadCompleteEvent) => void

Devuelve: Promise<PluginListenerHandle>

Desde: 4.0.0

---

Agregar un oyente para el evento de actualización mayor (‘majorAvailable’, …)

addListener(eventName: 'majorAvailable', listenerFunc: (state: MajorAvailableEvent) => void) => Promise<PluginListenerHandle>

Escuchar el evento de actualización mayor en la aplicación, le notifica cuando una actualización mayor está bloqueada al establecer disableAutoUpdateBreaking

Parámetro	Tipo
eventName	’majorAvailable’
listenerFunc	(state: MajorAvailableEvent) => void

Devuelve: Promise<PluginListenerHandle>

Desde: 2.3.0

---

Agregar un oyente para el evento de actualización fallida (‘updateFailed’, …)

addListener(eventName: 'updateFailed', listenerFunc: (state: UpdateFailedEvent) => void) => Promise<PluginListenerHandle>

Escuchar el evento de falla de actualización en la Aplicación, te informa cuando la actualización ha fallado al instalar en la próxima apertura de la aplicación

Parámetro	Tipo
eventName	’updateFailed’
listenerFunc	(state: UpdateFailedEvent) => void

Devuelve: Promise<PluginListenerHandle>

Desde: 2.3.0

---

addListener(‘downloadFailed’, …)

addListener(eventName: 'downloadFailed', listenerFunc: (state: DownloadFailedEvent) => void) => Promise<PluginListenerHandle>

Escuchar el evento de falla de descarga en la Aplicación, te informa cuando una descarga de paquete ha fallado

Parámetro	Tipo
eventName	’downloadFailed’
listenerFunc	(state: DownloadFailedEvent) => void

Devuelve: Promise<PluginListenerHandle>

Desde: 4.0.0

---

addListener('appReloaded', …)

addListener(eventName: 'appReloaded', listenerFunc: () => void) => Promise<PluginListenerHandle>

Escuchar el evento de recarga de la Aplicación, te informa cuando ha ocurrido la recarga

Parámetro	Tipo
eventName	’appReloaded’
listenerFunc	() => void

Devuelve: Promise<PluginListenerHandle>

Desde: 4.3.0

---

addListener('appReady', …)

addListener(eventName: 'appReady', listenerFunc: (state: AppReadyEvent) => void) => Promise<PluginListenerHandle>

Escuchar el evento de aplicación lista en la Aplicación, le permite saber cuando la aplicación está lista para usar

Parámetro	Tipo
eventName	’appReady’
listenerFunc	(state: AppReadyEvent) => void

Devuelve: Promise<PluginListenerHandle>

Desde: 5.1.0

---

isAutoUpdateAvailable()

isAutoUpdateAvailable() => Promise<AutoUpdateAvailable>

Obtener si la actualización automática está disponible (no deshabilitada por serverUrl).

Devuelve: Promise<AutoUpdateAvailable>

---

getNextBundle()

getNextBundle() => Promise<BundleInfo | null>

Obtenga el siguiente paquete que se utilizará cuando se recargue la aplicación. Devuelve null si no se ha establecido un paquete siguiente.

Devuelve: Promise<BundleInfo | null>

Desde: 6.8.0

---

setShakeMenu(…)

setShakeMenu(options: SetShakeMenuOptions) => Promise<void>

Habilite o deshabilite el menú de sacudida para fines de depuración/pruebas

Parámetro	Tipo	Descripción
options	SetShakeMenuOptions	Contiene una booleana habilitada para habilitar o deshabilitar el menú de sacudir

Desde: 7.5.0

---

isShakeMenuEnabled()

isShakeMenuEnabled() => Promise<ShakeMenuEnabled>

Obtenga el estado actual del menú de sacudir

Devuelve: Promise<ShakeMenuEnabled>

Desde: 7.5.0

---

Interfaces

Resultado de la aplicación listo

Propiedad	Tipo
bundle	BundleInfo

Información de paquete

Propiedad	Tipo
id	string
version	string
downloaded	string
checksum	string
status	BundleStatus

URL de actualización

Propiedad	Tipo
url	string

URL de estadísticas

Propiedad	Tipo
url	string

Url del canal

Propiedad	Tipo
url	string

Opciones de descarga

This URL and versions are used to download the bundle from the server, If you use backend all information will be given by the method getLatest. If you don’t use backend, you need to provide the URL and version of the bundle. SessionKey are required if you encrypted the bundle with the CLI command encrypt, you should receive them as result of the command.

Tipo	Opciones de descarga	Descripción	Predeterminado	Desde
url	string	La URL del archivo zip del paquete (por ejemplo: dist.zip) que se descargará. (Esta puede ser cualquier URL. Por ejemplo: Amazon S3, una etiqueta GitHub, cualquier otro lugar donde hayan alojado su paquete.)
version	string	La versión code/nombre de este paquete/versión
sessionKey	string	La clave de sesión para la actualización, cuando el paquete está cifrado con una clave de sesión	undefined	4.0.0
checksum	string	La suma de verificación para la actualización, debe estar en sha256 y cifrada con la clave privada si el paquete está cifrado	undefined	4.0.0
manifest	ManifestEntry[]	El manifiesto para Delta (manifest) descargas de archivos múltiples	undefined	6.1.0

ManifestEntry

Propiedad	Tipo
file_name	string | null
file_hash	string | null
download_url	string | null

Id de la aplicación

Propiedad	Tipo
id	string

Resultado de la lista de aplicaciones

Propiedad	Tipo
bundles	BundleInfo[]

Opciones de lista

Propiedad	Tipo	Descripción	Predeterminado	Desde
raw	boolean	¿Devolver la lista de paquetes de bundle crudos o el manifiesto? Si es verdadero, la lista intentará leer la base de datos interna en lugar de los archivos en disco.	false	6.14.0

Opciones de Reset

Propiedad	Tipo
toLastSuccessful	boolean

Resultado de Bundle Actual

Propiedad	Tipo
bundle	BundleInfo
native	string

Condiciones de Retraso Múltiple

Propiedad	Tipo
delayConditions	DelayCondition[]

Condiciones de Retraso

Propiedad	Tipo	Descripción
kind	DelayUntilNext	Configura condiciones de retraso en setMultiDelay
value	string

Versión más Reciente

Propiedad	Tipo	Descripción	Desde
version	string	Resultado del método getLatest	4.0.0
checksum	string		6
major	boolean
message	string
sessionKey	string
error	string
old	string
url	string
manifest	ManifestEntry[]		6.1

Opciones para GetLatest

Propiedad	Tipo	Descripción	Valor predeterminado	Desde
channel	string	El canal para obtener la última versión para El canal debe permitir ‘self_assign’ para que esto funcione	undefined	6.8.0

ChannelRes

Propiedad	Tipo	Descripción	Desde
status	string	Estado actual de establecer canal	4.7.0
error	string
message	string

Opciones de establecer canal

Propiedad	Tipo
channel	string
triggerAutoUpdate	boolean

Opciones de canal no configuradas

Propiedad	Tipo
triggerAutoUpdate	boolean

GetChannelRes

Propiedad	Tipo	Descripción	Desde
channel	string	Estado actual de obtener canal	4.8.0
error	string
message	string
status	string
allowSet	boolean

Resultado de lista de canales

Propiedad	Tipo	Descripción	Desde
channels	ChannelInfo[]	Lista de canales disponibles	7.5.0

ChannelInfo

Propiedad	Tipo	Descripción	Desde
id	number	El ID numérico del canal	7.5.0
name	string	El nombre del canal	7.5.0
public	boolean	Si es verdadero, este es un canal predeterminado/fallback. Los dispositivos no pueden asignarse automáticamente a los canales públicos. En su lugar, cuando un dispositivo elimina su sobrescritura de canal (utilizando unsetChannel()), recibirá automáticamente actualizaciones del canal público que coincida.	7.5.0
allow_self_set	boolean	Si es verdadero, los dispositivos pueden asignarse explícitamente a este canal utilizando setChannel(). Esto se utiliza típicamente para pruebas beta, pruebas A/B o pistas de actualizaciones de opción.	7.5.0

Los comandos de canal utilizan el canal name, no este ID numérico id.

SetCustomIdOptions

Propiedad	Tipo
customId	string

Versión Integrada

Propiedad	Tipo
version	string

Id de Dispositivo

Propiedad	Tipo
deviceId	string

Versión de Plugin

Propiedad	Tipo
version	string

Actualización automática habilitada

Propiedad	Tipo
enabled	boolean

Manejador de escucha de plugin

Propiedad	Tipo
remove	() => Promise<void>

Evento de descarga

Propiedad	Tipo	Descripción	Desde
percent	number	Estado actual de descarga, entre 0 y 100.	4.0.0
bundle	BundleInfo

NoNeedEvent

Propiedad	Tipo	Descripción	Desde
bundle	BundleInfo	Estado actual de descarga, entre 0 y 100.	4.0.0

UpdateAvailableEvent

Propiedad	Tipo	Descripción	Desde
bundle	BundleInfo	Estado actual de descarga, entre 0 y 100.	4.0.0

Evento de descarga completa

Propiedad	Tipo	Descripción	Desde
bundle	BundleInfo	Se emite cuando está disponible una nueva actualización.	4.0.0

EventoDisponibleMayor

Propiedad	Tipo	Descripción	Desde
version	string	Emite cuando está disponible una nueva versión principal del paquete.	4.0.0

EventoActualizaciónFallida

Propiedad	Tipo	Descripción	Desde
bundle	BundleInfo	Emite cuando una actualización falló de instalarse.	4.0.0

DownloadFailedEvent

Propiedad	Tipo	Descripción	Desde
version	string	Emite cuando una descarga falla.	4.0.0

AppReadyEvent

Propiedad	Tipo	Descripción	Desde
bundle	BundleInfo	Emite cuando la aplicación está lista para usar.	5.2.0
status	string

Actualización automática disponible

Propiedad	Tipo
available	boolean

Establecer opciones de menú de sacudir

Propiedad	Tipo
enabled	boolean

ShakeMenuHabilitado

Propiedad	Tipo
enabled	boolean

Alias de tipo

Estado de la cesta

pendiente: La cesta está pendiente de ser CONFIGURADO descargando: La cesta está siendo descargada. EXITO: La cesta ha sido descargada y está lista para ser como la próxima paquete.

‘success’ | ‘error’ | ‘pending’ | ‘downloading’

error: El paquete ha fallado al descargar.

‘background’ | ‘kill’ | ‘nativeVersion’ | ‘date’

Sección titulada “DelayUntilNext”

Sección titulada “Sigue adelante desde Funciones y ajustes” Si estás utilizando to plan dashboard and API operations, connect it with Using @capgo/capacitor-updater Usando @capgo/capacitor-actualizador para la capacidad nativa en Usando @API/__CAPGO_KEEP_1__-actualizador, Resumen de API Introducción para los detalles de implementación en Introducción, API Claves para los detalles de implementación en API Claves, y Dispositivos para los detalles de implementación en Dispositivos.