Funciones y ajustes

Configuración del plugin de actualizador

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

CapacitorUpdater se puede configurar con estas opciones:

Propiedad	Tipo	Descripción	Default	Desde
appReadyTimeout	number	Configura el número de milisegundos que el plugin nativo debe esperar antes de considerar una actualización ‘fallida’. Disponible en Android, iOS, y Electron.	10000 // (10 seconds)
responseTimeout	number	Configura el número de milisegundos que el plugin nativo debe esperar antes de considerar API tiempo de espera. Disponible en Android, iOS, y Electron.	20000 // (20 seconds)
autoDeleteFailed	boolean	Configura si el plugin debe usar automáticamente eliminar paquetes fallidos. Disponible en Android, iOS, y Electron.	true
autoDeletePrevious	boolean	Configura si el plugin debe usar automáticamente eliminar paquetes anteriores después de una actualización exitosa. Disponible en Android, iOS, y Electron.	true
autoUpdate	boolean	Configura si el plugin debe usar Actualización automática a través de un servidor de actualizaciones. Disponible en Android, iOS, y Electron.	true
resetWhenUpdate	boolean	Eliminar automáticamente paquetes descargados previos cuando se instala una aplicación nativa más reciente en el dispositivo. Disponible en Android, iOS, y Electron.	true
updateUrl	string	Configura la URL / punto de conexión a la que se envían las comprobaciones de actualización. Disponible en Android, iOS, y Electron.	https://plugin.capgo.app/updates
channelUrl	string	Configura la URL / punto de conexión para operaciones de canal. Disponible en Android, iOS, y Electron.	https://plugin.capgo.app/channel_self
statsUrl	string	Configura 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	Configura 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 del app. Esta será utilizada 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’	Configure cuándo el plugin debería instalar actualizaciones directamente. Solo para el modo de actualización automática. Funciona bien para aplicaciones menores a 10MB y con subidas realizadas utilizando la bandera —delta. Archivos zip o aplicaciones mayores a 10MB serán relativamente lentas para los usuarios para actualizar. - falso: Nunca haga actualizaciones directas (utilice el comportamiento predeterminado: descargar al inicio, establecer cuando se esté en segundo plano) - enInstalación: Actualizar directamente solo cuando la app se instale, se actualice desde la tienda, de lo contrario actúe como directUpdate = falso - enArranque: Actualizar directamente solo cuando la app se instale, se actualice desde la tienda o después de que la app se haya detenido, de lo contrario actúe como directUpdate = falso - siempre: Actualizar directamente en todos los casos anteriores (app instalada, actualizada desde la tienda, después de que la app se haya detenido o la app se haya reanudado), nunca actúe como directUpdate = falso - verdadero: (obsoleto) Lo mismo que “siempre” para compatibilidad hacia atrás. Disponible en Android, iOS y Electron.	false	5.1.0
autoSplashscreen	boolean	Automáticamente se ocultará la pantalla de bienvenida cuando se utilice directUpdate. Cuando está habilitado, el plugin ocultará automáticamente la pantalla de bienvenida después de aplicar actualizaciones o cuando no se necesite ninguna actualización. Esto elimina la necesidad de escuchar eventos de appReady y llamar a SplashScreen.hide() manualmente. Solo funciona cuando directUpdate está configurado en “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. Disponible en Android y iOS.	false	7.6.0
periodCheckDelay	number	Configura el período de espera para la verificación de actualizaciones periódicas. La unidad es en segundos. Disponible en Android, iOS y Electron. No puede ser menor a 600 segundos (10 minutos).	600 // (10 minutes)
localS3	boolean	Configura CLI para utilizar un servidor local para pruebas o un servidor de actualizaciones autoalojado.	undefined	4.17.48
localHost	string	Configura CLI para utilizar un servidor local para pruebas o un servidor de actualizaciones autoalojado.	undefined	4.17.48
localWebHost	string	Configura CLI para utilizar un servidor local para pruebas o un servidor de actualizaciones autoalojado.	undefined	4.17.48
localSupa	string	Configura CLI para utilizar un servidor local para pruebas.	undefined	4.17.48
localSupaAnon	string	Configura CLI para utilizar un servidor local __CAPGO_KEEP_1__ para pruebas.	undefined	4.17.48
localApi	string	Configura CLI para utilizar un archivo local api para pruebas.	undefined	6.3.3
localApiFiles	string	Configure the CLI to use a local file api for testing.	undefined	6.3.3
allowModifyUrl	boolean	Establece 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 seguirá respetando las sobrescripciones realizadas en la nube.	false	5.4.0
defaultChannel	string	Configura __CAPGO_KEEP_0__ para utilizar un servidor local para pruebas o un servidor de actualizaciones autoalojado.	undefined	5.5.0
appId	string	Configure el identificador de la aplicación para la aplicación en la configuración.	undefined	6.0.0
keepUrlPathAfterReload	boolean	Configure el complemento para mantener el camino de la ruta URL después de un recarga. ADVERTENCIA: Cuando se active una recarga, ‘window.history’ se borrará.	false	6.8.0
disableJSLogging	boolean	Deshabilitar el registro de JavaScript del complemento. Si es verdadero, el complemento no registrará en la consola de JavaScript. Solo se realizará el registro nativo.	false	7.3.0
shakeMenu	boolean	Habilitar el gesto de sacudir para mostrar el menú de actualización con 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": false,
      "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: false,
      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 Capacitor que el paquete 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.

Param	Tipo	Descripción
options	UpdateUrl	contiene la URL a utilizar para verificar actualizaciones.

Desde: 5.4.0

---

setStatsUrl(…)

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

Establecer 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 a utilizar para enviar estadísticas.

Desde: 5.4.0

---

setChannelUrl(…)

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

Establece la dirección del canal para la aplicación, se utilizará para establecer el canal.

Parametro	Tipo	Descripción
options	ChannelUrl	contiene la URL a utilizar para establecer el canal.

Desde: 5.4.0

---

download(…)

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

Descargar una nueva colección 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	Las opciones de descarga para obtener una nueva colección zip: {@link DownloadOptions}

Devuelve: Promise<BundleInfo>

---

next(…)

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

Establezca el siguiente paquete para utilizar cuando la aplicación se recargue.

Parametro	Tipo	Descripción
options	BundleId	Contiene el ID del siguiente paquete para establecer en la próxima apertura de la aplicación. {@link}

BundleInfo.id Promise<BundleInfo>

---

Devuelve:

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

Copiar a portapapeles

Establezca el paquete actual y recargue la aplicación inmediatamente.	Tipo	Descripción
options	BundleId	Un objeto {@link BundleId} que contiene el nuevo id de paquete para establecer como actual.

---

delete(…)

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

Elimina el paquete especificado desde el almacenamiento de la aplicación nativa. Utilice con {@link list} para obtener los IDs de paquetes almacenados.

Parámetro	Tipo	Descripción
options	BundleId	Un objeto {@link BundleId} que contiene el ID de un paquete para eliminar (tenga en cuenta, este es el ID del paquete, NO el nombre de la versión) list(…)Sección titulada “list(…)

---

Copiar a portapapeles

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

Tipo

Descripción	El {@link ListOptions}	Copy to clipboard
options	ListOptions	Get all locally downloaded bundles in your app Section titled “list(…)} para listar paquetes

Devuelve: Promise<BundleListResult>

---

reset(…)

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

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

Parámetro	Tipo	Descripción
options	ResetOptions	Conteniendo {@link ResetOptions.toLastSuccessful}}, true regresa a la bundle predeterminada y false se restablecerá a la última bundle cargada con éxito.

---

current()

current() => Promise<CurrentBundleResult>

Obtiene la bundle actual, si no hay ninguna configurada devuelve builtin. currentNative es la bundle original instalada en el dispositivo

Devuelve: Promise<CurrentBundleResult>

---

reload()

reload() => Promise<void>

Recarga la vista

---

setMultiDelay(…)

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 date kind, el valor debe ser una cadena de fecha en formato iso8601. Para el background kind, el valor debe ser un número en milisegundos. Para el nativeVersion kind, el valor debe ser el número de versión. Para el kill 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 corregirá en una futura versión mayor.

Parámetro	Tipo	Descripción
options	MultiDelayConditions	Contiene el arreglo de condiciones {@link MultiDelayConditions} para establecer

Desde: 4.3.0

---

cancelDelay()

cancelDelay() => Promise<void>

Cancela un {@link DelayCondition} para procesar una actualización de inmediato.

Desde: 4.0.0

---

getLatest(…)

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 para este dispositivo. El canal debe tener allow_device_self_set habilitado para que esto funcione.

Importantes notas:

• 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 beta).
• Los canales públicos no pueden asignarse automáticamente. Si un canal está marcado como public, llamar setChannel() devolverá un error. Para utilizar un canal público, llame 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.

Parámetro	Tipo	Descripción
options	SetChannelOptions	¿Es el canal {@link SetChannelOptions} a establecer

Devuelve: Promise<ChannelRes>

Desde: 4.7.0

---

unsetChannel(…)

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

Deshacer el canal de sobrealimentación para este dispositivo. Después de llamar a este método, el dispositivo recibirá automáticamente actualizaciones desde canales públicos que coincida con sus condiciones (plataforma, tipo de dispositivo, tipo de compilación).

Esto es útil cuando:

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

Param	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 trueeste es un canales predeterminado. No puedes autoasignarte a él usando setChannel()En su lugar, si eliminaste tu asignación de canal usando unsetChannel(), el dispositivo recibirá automáticamente actualizaciones de este canal público.
• allow_self_set: Si true, este es un canal autoasignable. Puede asignar explícitamente el dispositivo a este canal utilizando setChannel().

Returns: Promise<ListChannelsResult>

Desde: 7.5.0

---

setCustomId(…)

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

Establecer un ID personalizado para este dispositivo

Param	Tipo	Descripción
options	SetCustomIdOptions	es el {@link SetCustomIdOptions} customId 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 Capacitor del plugin de actualización (enviado al servidor de actualización automática)

Devuelve: Promise<PluginVersion>

---

isAutoUpdateEnabled()

isAutoUpdateEnabled() => Promise<AutoUpdateEnabled>

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

Devuelve: Promise<AutoUpdateEnabled>

---

removeAllListeners()

removeAllListeners() => Promise<void>

Quitar todos los oyentes para este plugin.

Desde: 1.0.0

---

addListener(‘download’, …)

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

Escuchar 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

Parámetro	Tipo
eventName	’download’
listenerFunc	(state: DownloadEvent) => void

Devuelve: Promise<PluginListenerHandle>

Desde: 2.0.11

---

Agregar escuchador ('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(‘actualizadoDisponible’, …)

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

Escuchar 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(‘descargaCompleta’, …)

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 escuchador 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, notificar 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

---

addListener(‘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

---

Agregar un escuchador para el evento de recarga de la aplicación, te notificará cuando la recarga haya ocurrido

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

Escuchar el evento de recarga de la aplicación, te informará cuando la recarga haya ocurrido

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

Devuelve: Promise<PluginListenerHandle>

Desde: 4.3.0

---

Agregar escuchador (‘appReady’, …)

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

Escuchar el evento de app ready en la App, te informa cuando la app 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 hay actualizaciones automáticas disponibles (no deshabilitadas por serverUrl)

Devuelve: Promise<AutoUpdateAvailable>

---

getNextBundle()

getNextBundle() => Promise<BundleInfo | null>

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

Habilita o deshabilita el menú de sacudida para fines de depuración/pruebas

Param	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

Propiedad	Tipo
bundle	BundleInfo

Información de la Carga

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

URL de Actualización

Propiedad	Tipo
url	string

StatsUrl

Propiedad	Tipo
url	string

ChannelUrl

Propiedad	Tipo
url	string

DownloadOptions

Esta URL y versiones se utilizan para descargar el paquete desde el servidor. Si utiliza backend, toda la información se le proporcionará mediante el método getLatest. Si no utiliza backend, debe proporcionar la URL y la versión del paquete. Los claves de sesión son necesarias si ha cifrado el paquete con el comando CLI encrypt, debe recibirlos como resultado del comando.

Propiedad	Tipo	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 ser 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

Prop	Tipo
file_name	string | null
file_hash	string | null
download_url	string | null

BundleId

Propiedad	Tipo
id	string

Resultado de la lista de Bundle

Propiedad	Tipo
bundles	BundleInfo[]

Opciones de lista

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

Restablecer Opciones

Propiedad	Tipo
toLastSuccessful	boolean

Resultado de Bundle Actual

Propiedad	Tipo
bundle	BundleInfo
native	string

Condiciones de Retraso Múltiple

Propiedad	Tipo
delayConditions	DelayCondition[]

Condición de Retraso

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

Última Versión

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 obtener la versión más reciente

Tipo	Descripción	Valor predeterminado	Opciones para obtener la versión más reciente	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 del canal configurado	4.7.0
error	string
message	string

SetChannelOptions

Propiedad	Tipo
channel	string
triggerAutoUpdate	boolean

Opciones de canal no configuradas

Propiedad	Tipo
triggerAutoUpdate	boolean

Obtener resultados de canal

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

Resultados de lista de canales

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

Información de canal

Propiedad	Tipo	Descripción	Desde
id	string	El ID del canal	7.5.0
name	string	El nombre del canal	7.5.0
public	boolean	Si es verdadero, este es un canal por defecto/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 correspondiente.	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

Opciones de SetCustomId

Propiedad	Tipo
customId	string

Versión Builtin

Propiedad	Tipo
version	string

Id. del dispositivo

Propiedad	Tipo
deviceId	string

Versión del plugin

Propiedad	Tipo
version	string

Habilitado para actualizaciones automáticas

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 del descarga, entre 0 y 100.	4.0.0
bundle	BundleInfo

NoNeedEvent

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

UpdateAvailableEvent

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

DownloadCompleteEvent

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

MajorAvailableEvent

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

UpdateFailedEvent

Propiedad	Tipo	Descripción	Desde
bundle	BundleInfo	Se emite cuando una actualización falla de instalarse.	4.0.0

DownloadFailedEvent

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

AppReadyEvent

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

Actualización automática disponible

Propiedad	Tipo
available	boolean

Opciones de menú de sacudida

Propiedad	Tipo
enabled	boolean

Habilitar menú de sacudida

Propiedad	Tipo
enabled	boolean

Alias de tipo

Estado del paquete

pendiente: El paquete está pendiente de ser configurado como el próximo. CONFIGURAR descargando: El paquete está siendo descargado. CONFIGURAR como el próximo paquete. El paquete ha sido descargado y está listo para ser configurado como el próximo. error: El paquete ha fallado al descargar.

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

Retrasar hasta el próximo

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