Funciones y configuraciones

Configuración del Plugin Updater

Consulta el Readme de Github para más información.

CapacitorUpdater puede configurarse con estas opciones:

Prop	Tipo	Descripción	Por defecto	Desde
appReadyTimeout	number	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.	10000 // (10 segundos)
responseTimeout	number	Configura el número de milisegundos que el plugin nativo debe esperar antes de considerar un timeout de API. Solo disponible para Android e iOS.	20 // (20 segundos)
autoDeleteFailed	boolean	Configura si el plugin debe eliminar automáticamente los bundles fallidos. Solo disponible para Android e iOS.	true
autoDeletePrevious	boolean	Configura si el plugin debe eliminar automáticamente los bundles anteriores después de una actualización exitosa. Solo disponible para Android e iOS.	true
autoUpdate	boolean	Configura si el plugin debe usar Actualización Automática a través de un servidor de actualizaciones. Solo disponible para Android e iOS.	true
resetWhenUpdate	boolean	Elimina automáticamente los bundles descargados anteriores cuando se instala un nuevo bundle de aplicación nativa en el dispositivo. Solo disponible para Android e iOS.	true
updateUrl	string	Configura la URL / endpoint al que se envían las verificaciones de actualización. Solo disponible para Android e iOS.	https://plugin.capgo.app/updates
channelUrl	string	Configura la URL / endpoint para operaciones de canal. Solo disponible para Android e iOS.	https://plugin.capgo.app/channel_self
statsUrl	string	Configura la URL / endpoint al que se envían las estadísticas de actualización. Solo disponible para Android e iOS. Establece en "" para deshabilitar el reporte de estadísticas.	https://plugin.capgo.app/stats
publicKey	string	Configura la clave pública para cifrado de actualizaciones en vivo de extremo a extremo Versión 2 Solo disponible para Android e iOS.	undefined	6.2.0
version	string	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.	undefined	4.17.48
directUpdate	boolean | ‘always’ | ‘atInstall’ | ‘onLaunch’	Configura cuándo el plugin debe realizar instalación directa de actualizaciones. Solo para modo autoUpdate. Funciona bien para aplicaciones menores a 10MB y con cargas realizadas usando el flag —partial. Zip o aplicaciones mayores a 10MB serán relativamente lentas para que los usuarios actualicen. - false: Nunca hacer actualizaciones directas (usar comportamiento predeterminado: descargar al inicio, establecer cuando se pone en segundo plano) - atInstall: Actualización directa solo cuando la aplicación está instalada, actualizada desde la tienda, de lo contrario actúa como directUpdate = false - onLaunch: Actualización directa solo al instalar la aplicación, actualizarla desde la tienda o después de cerrar la aplicación, de lo contrario actúa como directUpdate = false - always: Actualización directa en todos los casos anteriores (aplicación instalada, actualizada desde la tienda, después de cerrar la aplicación o reanudar la aplicación), nunca actúa como directUpdate = false - true: (obsoleto) Lo mismo que “always” para retrocompatibilidad Solo disponible para Android e iOS.	false	5.1.0
autoSplashscreen	boolean	Maneja automáticamente el ocultamiento de la pantalla de bienvenida cuando se usa directUpdate. Cuando está habilitado, el plugin ocultará automáticamente la pantalla de bienvenida después de aplicar las actualizaciones o cuando no se necesite actualización. Esto elimina la necesidad de escuchar manualmente los eventos appReady y llamar a SplashScreen.hide(). Solo funciona cuando directUpdate está establecido 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. Solo disponible para Android e iOS.	false	7.6.0
periodCheckDelay	number	Configura el período de retraso para la verificación periódica de actualizaciones. La unidad es en segundos. Solo disponible para Android e iOS. No puede ser menor a 600 segundos (10 minutos).	600 // (10 minutos)
localS3	boolean	Configura el CLI para usar un servidor local para pruebas o servidor de actualizaciones auto-hospedado.	undefined	4.17.48
localHost	string	Configura el CLI para usar un servidor local para pruebas o servidor de actualizaciones auto-hospedado.	undefined	4.17.48
localWebHost	string	Configura el CLI para usar un servidor local para pruebas o servidor de actualizaciones auto-hospedado.	undefined	4.17.48
localSupa	string	Configura el CLI para usar un servidor local para pruebas o servidor de actualizaciones auto-hospedado.	undefined	4.17.48
localSupaAnon	string	Configura el CLI para usar un servidor local para pruebas.	undefined	4.17.48
localApi	string	Configura el CLI para usar una api local para pruebas.	undefined	6.3.3
localApiFiles	string	Configura el CLI para usar una api de archivos local para pruebas.	undefined	6.3.3
allowModifyUrl	boolean	Permite que el plugin modifique dinámicamente updateUrl, statsUrl y channelUrl desde el lado de JavaScript.	false	5.4.0
defaultChannel	string	Establece el canal predeterminado para la aplicación en la configuración. Sensible a mayúsculas. Esta configuración anulará el canal predeterminado establecido en la nube, pero aún respetará las anulaciones hechas en la nube.	undefined	5.5.0
appId	string	Configura el id de la aplicación en la configuración.	undefined	6.0.0
keepUrlPathAfterReload	boolean	Configura el plugin para mantener la ruta de URL después de una recarga. ADVERTENCIA: Cuando se activa una recarga, ‘window.history’ se borrará.	false	6.8.0
disableJSLogging	boolean	Deshabilita el registro de JavaScript del plugin. Si es true, el plugin no registrará en la consola de JavaScript. Solo se realizará el registro nativo	false	7.3.0
shakeMenu	boolean	Habilita el gesto de sacudir para mostrar el menú de actualización para propósitos de depuración/prueba	false	7.5.0

Ejemplos

En capacitor.config.json:

{
  "plugins": {
    "CapacitorUpdater": {
      "appReadyTimeout": 1000 // (1 segundo),
      "responseTimeout": 10 // (10 segundos),
      "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:

/// <reference types="@capgo/capacitor-updater" />

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

const config: CapacitorConfig = {
  plugins: {
    CapacitorUpdater: {
      appReadyTimeout: 1000 // (1 segundo),
      responseTimeout: 10 // (10 segundos),
      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 Tipos

Métodos

notifyAppReady()

notifyAppReady() => Promise<AppReadyResult>

Notifica a Capacitor Updater que el bundle actual está funcionando (ocurrirá un rollback si este método no se llama en cada inicio de aplicación) Por defecto, este método debe llamarse en los primeros 10 segundos después del inicio de la aplicación, de lo contrario ocurrirá un rollback. Cambia este comportamiento con {@link appReadyTimeout}

Retorna: Promise<AppReadyResult>

---

setUpdateUrl(…)

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

Establece la updateUrl para la aplicación, esto se usará para verificar actualizaciones.

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

Desde: 5.4.0

---

setStatsUrl(…)

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

Establece la statsUrl para la aplicación, esto se usará 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 usar para enviar estadísticas.

Desde: 5.4.0

---

setChannelUrl(…)

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

Establece la channelUrl 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>

Descarga un nuevo bundle 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 {@link DownloadOptions} para descargar un nuevo bundle zip.

Retorna: Promise<BundleInfo>

---

next(…)

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

Establece el siguiente bundle a usar cuando la aplicación se recarga.

Parámetro	Tipo	Descripción
options	BundleId	Contiene el ID del siguiente Bundle a establecer en el próximo inicio de la aplicación. {@link BundleInfo.id}

Retorna: Promise<BundleInfo>

---

set(…)

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

Establece el bundle actual e inmediatamente recarga la aplicación.

Parámetro	Tipo	Descripción
options	BundleId	Un objeto {@link BundleId} que contiene el nuevo id del bundle a establecer como actual.

---

delete(…)

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

Elimina el bundle especificado del almacenamiento de la aplicación nativa. Usa con {@link list} para obtener los IDs de Bundle almacenados.

Parámetro	Tipo	Descripción
options	BundleId	Un objeto {@link BundleId} que contiene el ID de un bundle a eliminar (nota, este es el id del bundle, NO el nombre de versión)

---

list(…)

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

Obtiene todos los bundles descargados localmente en tu aplicación

Parámetro	Tipo	Descripción
options	ListOptions	Las {@link ListOptions} para listar bundles

Retorna: Promise<BundleListResult>

---

reset(…)

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

Restablece la aplicación al bundle builtin (el enviado a Apple App Store / Google Play Store) o al último bundle cargado exitosamente.

Parámetro	Tipo	Descripción
options	ResetOptions	Contiene {@link ResetOptions.toLastSuccessful}, true restablece al bundle builtin y false restablecerá al último bundle cargado exitosamente.

---

current()

current() => Promise<CurrentBundleResult>

Obtiene el bundle actual, si no hay ninguno establecido retorna builtin. currentNative es el bundle original instalado en el dispositivo

Retorna: Promise<CurrentBundleResult>

---

reload()

reload() => Promise<void>

Recarga la vista

---

setMultiDelay(…)

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

Establece un array de {@link DelayCondition} que contiene condiciones que el Plugin usará para retrasar la actualización. Después de que se cumplan todas las condiciones, el proceso de actualización comenzará nuevamente como de costumbre, por lo que la actualización se instalará después de poner en segundo plano o cerrar la aplicación. Para el tipo date, el valor debe ser una cadena de fecha iso8601. Para el tipo background, el valor debe ser un número en milisegundos. Para el tipo nativeVersion, el valor debe ser el número de versión. Para el tipo kill, el valor no se usa. La función tiene comportamiento inconsistente, la opción kill activa la actualización después del primer cierre 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 array de {@link MultiDelayConditions} de condiciones a establecer

Desde: 4.3.0

---

cancelDelay()

cancelDelay() => Promise<void>

Cancela una {@link DelayCondition} para procesar una actualización inmediatamente.

Desde: 4.0.0

---

getLatest(…)

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

Obtiene el último bundle disponible desde la URL de actualización

Parámetro	Tipo
options	GetLatestOptions

Retorna: Promise<LatestVersion>

Desde: 4.0.0

---

setChannel(…)

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

Establece el canal para este dispositivo. El canal debe permitir auto-asignación para que esto funcione. No uses este método para establecer el canal al inicio. Este método es para establecer el canal después de que la aplicación esté lista, y el usuario haya interactuado. Si quieres establecer el canal al inicio, usa {@link PluginsConfig} para establecer el canal predeterminado. Este método envía al backend de Capgo una solicitud para vincular el ID del dispositivo al canal. Capgo puede aceptar o rechazar dependiendo de la configuración de tu canal.

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

Retorna: Promise<ChannelRes>

Desde: 4.7.0

---

unsetChannel(…)

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

Desestablece el canal para este dispositivo. El dispositivo volverá entonces al canal predeterminado

Parámetro	Tipo
options	UnsetChannelOptions

Desde: 4.7.0

---

getChannel()

getChannel() => Promise<GetChannelRes>

Obtiene el canal para este dispositivo

Retorna: Promise<GetChannelRes>

Desde: 4.8.0

---

listChannels()

listChannels() => Promise<ListChannelsResult>

Lista todos los canales disponibles para este dispositivo que permiten auto-asignación

Retorna: Promise<ListChannelsResult>

Desde: 7.5.0

---

setCustomId(…)

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

Establece un ID personalizado para este dispositivo

Parámetro	Tipo	Descripción
options	SetCustomIdOptions	es el {@link SetCustomIdOptions} customId a establecer

Desde: 4.9.0

---

getBuiltinVersion()

getBuiltinVersion() => Promise<BuiltinVersion>

Obtiene la versión de la aplicación nativa o la versión builtin si se estableció en la configuración

Retorna: Promise<BuiltinVersion>

Desde: 5.2.0

---

getDeviceId()

getDeviceId() => Promise<DeviceId>

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

Retorna: Promise<DeviceId>

---

getPluginVersion()

getPluginVersion() => Promise<PluginVersion>

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

Retorna: Promise<PluginVersion>

---

isAutoUpdateEnabled()

isAutoUpdateEnabled() => Promise<AutoUpdateEnabled>

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

Retorna: Promise<AutoUpdateEnabled>

---

removeAllListeners()

removeAllListeners() => Promise<void>

Elimina todos los listeners de este plugin.

Desde: 1.0.0

---

addListener(‘download’, …)

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

Escucha el evento de descarga de bundle en la Aplicación. Se activa una vez que comienza una descarga, durante la descarga y cuando termina. Esto te devolverá todos los porcentajes de descarga durante la descarga

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

Retorna: Promise<PluginListenerHandle>

Desde: 2.0.11

---

addListener(‘noNeedUpdate’, …)

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

Escucha el evento de no necesidad de actualización, útil cuando quieres forzar la verificación cada vez que se inicia la aplicación

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

Retorna: Promise<PluginListenerHandle>

Desde: 4.0.0

---

addListener(‘updateAvailable’, …)

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

Escucha el evento de actualización disponible, útil cuando quieres forzar la verificación cada vez que se inicia la aplicación

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

Retorna: Promise<PluginListenerHandle>

Desde: 4.0.0

---

addListener(‘downloadComplete’, …)

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

Escucha eventos de downloadComplete.

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

Retorna: Promise<PluginListenerHandle>

Desde: 4.0.0

---

addListener(‘majorAvailable’, …)

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

Escucha el evento de actualización Mayor en la Aplicación, te permite saber cuando una actualización mayor está bloqueada al establecer disableAutoUpdateBreaking

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

Retorna: Promise<PluginListenerHandle>

Desde: 2.3.0

---

addListener(‘updateFailed’, …)

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

Escucha el evento de fallo de actualización en la Aplicación, te permite saber cuando la actualización ha fallado al instalarse en el próximo inicio de la aplicación

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

Retorna: Promise<PluginListenerHandle>

Desde: 2.3.0

---

addListener(‘downloadFailed’, …)

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

Escucha el evento de fallo de descarga en la Aplicación, te permite saber cuando la descarga de un bundle ha fallado

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

Retorna: Promise<PluginListenerHandle>

Desde: 4.0.0

---

addListener(‘appReloaded’, …)

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

Escucha el evento de recarga en la Aplicación, te permite saber cuando ha ocurrido una recarga

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

Retorna: Promise<PluginListenerHandle>

Desde: 4.3.0

---

addListener(‘appReady’, …)

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

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

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

Retorna: Promise<PluginListenerHandle>

Desde: 5.1.0

---

isAutoUpdateAvailable()

isAutoUpdateAvailable() => Promise<AutoUpdateAvailable>

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

Retorna: Promise<AutoUpdateAvailable>

---

getNextBundle()

getNextBundle() => Promise<BundleInfo | null>

Obtiene el siguiente bundle que se usará cuando la aplicación se recargue. Retorna null si no hay un siguiente bundle establecido.

Retorna: Promise<BundleInfo | null>

Desde: 6.8.0

---

setShakeMenu(…)

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

Habilita o deshabilita el menú de sacudida para propósitos de depuración/prueba

Parámetro	Tipo	Descripción
options	SetShakeMenuOptions	Contiene el booleano enabled para habilitar o deshabilitar el menú de sacudida

Desde: 7.5.0

---

isShakeMenuEnabled()

isShakeMenuEnabled() => Promise<ShakeMenuEnabled>

Obtiene el estado actual del menú de sacudida

Retorna: Promise<ShakeMenuEnabled>

Desde: 7.5.0

---

Interfaces

AppReadyResult

Prop	Tipo
bundle	BundleInfo

BundleInfo

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

UpdateUrl

Prop	Tipo
url	string

StatsUrl

Prop	Tipo
url	string

ChannelUrl

Prop	Tipo
url	string

DownloadOptions

Esta URL y versiones se usan para descargar el bundle desde el servidor. Si usas backend, toda la información será proporcionada por el método getLatest. Si no usas backend, necesitas proporcionar la URL y versión del bundle. Checksum y sessionKey son requeridos si cifraste el bundle con el comando CLI encrypt, deberías recibirlos como resultado del comando.

Prop	Tipo	Descripción	Por defecto	Desde
url	string	La URL del archivo zip del bundle (ej: dist.zip) a descargar. (Puede ser cualquier URL. Ej: Amazon S3, una etiqueta de GitHub, cualquier otro lugar donde hayas alojado tu bundle.)
version	string	El código/nombre de versión de este bundle/versión
sessionKey	string	La clave de sesión para la actualización, cuando el bundle está cifrado con una clave de sesión	undefined	4.0.0
checksum	string	El checksum para la actualización, debe estar en sha256 y cifrado con clave privada si el bundle está cifrado	undefined	4.0.0
manifest	ManifestEntry[]	El manifiesto para descargas de múltiples archivos	undefined	6.1.0

ManifestEntry

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

BundleId

Prop	Tipo
id	string

BundleListResult

Prop	Tipo
bundles	BundleInfo[]

ListOptions

Prop	Tipo	Descripción	Por defecto	Desde
raw	boolean	Si retornar la lista de bundles sin procesar o el manifiesto. Si es true, la lista intentará leer la base de datos interna en lugar de archivos en disco.	false	6.14.0

ResetOptions

Prop	Tipo
toLastSuccessful	boolean

CurrentBundleResult

Prop	Tipo
bundle	BundleInfo
native	string

MultiDelayConditions

Prop	Tipo
delayConditions	DelayCondition[]

DelayCondition

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

LatestVersion

Prop	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

GetLatestOptions

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

ChannelRes

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

SetChannelOptions

Prop	Tipo
channel	string
triggerAutoUpdate	boolean

UnsetChannelOptions

Prop	Tipo
triggerAutoUpdate	boolean

GetChannelRes

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

ListChannelsResult

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

ChannelInfo

Prop	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 este es un canal público	7.5.0
allow_self_set	boolean	Si los dispositivos pueden auto-asignarse a este canal	7.5.0

SetCustomIdOptions

Prop	Tipo
customId	string

BuiltinVersion

Prop	Tipo
version	string

DeviceId

Prop	Tipo
deviceId	string

PluginVersion

Prop	Tipo
version	string

AutoUpdateEnabled

Prop	Tipo
enabled	boolean

PluginListenerHandle

Prop	Tipo
remove	() => Promise<void>

DownloadEvent

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

NoNeedEvent

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

UpdateAvailableEvent

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

DownloadCompleteEvent

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

MajorAvailableEvent

Prop	Tipo	Descripción	Desde
version	string	Se emite cuando un nuevo bundle mayor está disponible.	4.0.0

UpdateFailedEvent

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

DownloadFailedEvent

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

AppReadyEvent

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

AutoUpdateAvailable

Prop	Tipo
available	boolean

SetShakeMenuOptions

Prop	Tipo
enabled	boolean

ShakeMenuEnabled

Prop	Tipo
enabled	boolean

Alias de Tipos

BundleStatus

pending: El bundle está pendiente de ser ESTABLECIDO como el próximo bundle. downloading: El bundle se está descargando. success: El bundle se ha descargado y está listo para ser ESTABLECIDO como el próximo bundle. error: El bundle ha fallado al descargarse.

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

DelayUntilNext

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