Funciones y ajustes

Copiar una solicitud de configuración con los pasos de instalación y la guía de markdown completa para este plugin.

Configuración del plugin de actualizador

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

CapacitorUpdater se puede configurar con estas opciones:

Propiedad	Tipo	Descripción	Valor por defecto	Desde
`appReadyTimeout`	`number`	Configure 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`	Configure el número de milisegundos que el plugin nativo debe esperar antes de considerar API como tiempo de espera. Disponible en Android, iOS y Electron.	`20000 // (20 seconds)`
`autoDeleteFailed`	`boolean`	Configure si el plugin debe usar automáticamente eliminar paquetes fallidos. Disponible en Android, iOS y Electron.	`true`
`autoDeletePrevious`	`boolean`	Configure 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 \| ‘off’ \| ‘atBackground’ \| ‘atInstall’ \| ‘onLaunch’ \| ‘always’ \| ‘onlyDownload’`	Configure cómo el plugin debe usar 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”. - off: Deshabilitar la actualización automática - atBackground: Comprueba y descarga automáticamente, luego aplica cuando la aplicación se mueve al segundo plano - atInstall: Aplica inmediatamente solo después de una instalación fresca o actualización de aplicación nativa, en caso contrario utilice atBackground - onLaunch: Aplica inmediatamente al iniciar, en caso contrario utilice atBackground después de la verificación de inicio - siempre: Aplica inmediatamente siempre que se ejecute la actualización automática - soloDescargar: Comprueba y descarga automáticamente, emite updateAvailable y nunca establezca el siguiente paquete automáticamente. Disponible en Android, iOS y Electron.	`”atBackground” // true is still accepted`
`resetWhenUpdate`	`boolean`	Automáticamente elimina los paquetes descargados previos cuando se instala una versión nativa más nueva del paquete de la aplicación en el dispositivo. Disponible en Android, iOS y Electron.	`true`
`updateUrl`	`string`	Configura la URL / punto de conexión al que se envían las comprobaciones de actualizaciones. Disponible en Android, iOS y Electron.	`https://plugin.capgo.app/updates`
`channelUrl`	`string`	Configura la URL / punto de conexión para las operaciones de canal. Disponible en Android, iOS y Electron.	`https://plugin.capgo.app/channel_self`
`statsUrl`	`string`	Configura la URL / punto de conexión al que se envían las estadísticas de actualizaciones. 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 actualizaciones en vivo de fin a fin, versión 2. Disponible en Android, iOS y Electron.	`undefined`	6.2.0
`version`	`string`	Configura 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 actualización de cadena autoUpdate: “atInstall”, “onLaunch” o “siempre”. 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: “siempre” - true: 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 los 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 necesite ninguna actualización. Esto elimina la necesidad de escuchar eventos de appReady manualmente y llamar a SplashScreen.hide(). Solo funciona cuando autoUpdate está configurado en “atInstall”, “onLaunch” o “always”. Los valores directUpdate de legado todavía se admiten por compatibilidad con versiones anteriores. Requiere que el plugin @capacitor/splash-screen esté instalado y configurado con launchAutoHide: false. Requiere que la actualización automática esté habilitada. Disponible en Android y iOS.	`false`	7.6.0
`periodCheckDelay`	`number`	Configura el período de retraso para la verificación de actualizaciones periódicas. 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`	Configura el CLI para utilizar un servidor local para pruebas o servidor de actualizaciones autoalojado.	`undefined`	4.17.48
`localHost`	`string`	Configura el CLI para utilizar un servidor local para pruebas o servidor de actualizaciones autoalojado.	`undefined`	4.17.48
`localWebHost`	`string`	Configura el CLI para utilizar un servidor local para pruebas o servidor de actualizaciones autoalojado.	`undefined`	4.17.48
`localSupa`	`string`	Configura el CLI para utilizar un servidor local para pruebas o servidor de actualizaciones autoalojado.	`undefined`	4.17.48
`localSupaAnon`	`string`	Configura el CLI para utilizar un servidor local para pruebas.	`undefined`	4.17.48
`localApi`	`string`	Configura el CLI para utilizar un servidor local api para pruebas.	`undefined`	6.3.3
`localApiFiles`	`string`	Configura el CLI para utilizar un archivo local api para pruebas.	`undefined`	6.3.3
`allowModifyUrl`	`boolean`	Permite que el plugin modifique la actualizaciónUrl, statsUrl y channelUrl dinámicamente desde el lado de JavaScript.	`false`	5.4.0
`defaultChannel`	`string`	Establezca el canal predeterminado para la aplicación en la configuración. Sensible a mayúsculas. Esta configuración sobrescribirá 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 identificador de la aplicación para la aplicación en la configuración.	`undefined`	6.0.0
`keepUrlPathAfterReload`	`boolean`	Configure el plugin para mantener el camino de la URL después de un recarga. ADVERTENCIA: Cuando se active una recarga, ‘window.history’ se borrará.	`false`	6.8.0
`disableJSLogging`	`boolean`	Desactive 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`	Habilite 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 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 dentro de los primeros 10 segundos después del arranque de la aplicación, de lo contrario se producirá un reenvío. Cambiar este comportamiento con {@link appReadyTimeout}

Devuelve: Promise<AppReadyResult>

setUpdateUrl(…)

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

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

Parámetro	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>

Establecer la URL del canal para la aplicación, esto se utilizará para establecer el canal.

Parámetro	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 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`	Las opciones de descarga para obtener un nuevo paquete zip. Devuelve:next(…)

Sección titulada “next(…)” Promise<BundleInfo>

The {@link

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

Establecer el siguiente paquete para que se utilice 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}

Devuelve: Promise<BundleInfo>

set(…)

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

Establecer el paquete actual y recargar la aplicación inmediatamente.

Parámetro	Tipo	Descripción
`options`	`BundleId`	Un objeto {@link BundleId} que contiene el nuevo identificador 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 identificadores de paquetes almacenados.

Parámetro	Tipo	Descripción
`options`	`BundleId`	Un objeto {@link} que contiene la ID de un paquete para eliminar (nota, esta es la 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}	Copy to clipboard
`options`	`ListOptions`	Get all locally downloaded bundles in your app Opciones de lista} para listar paquetes

Devuelve: Promise<BundleListResult>

reset(…)

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

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

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

current()

current() => Promise<CurrentBundleResult>

Obtén la biblioteca actual, si no hay ninguna configurada devuelve builtin. currentNative es la biblioteca original instalada en el dispositivo

Devuelve: Promise<CurrentBundleResult>

reload()

reload() => Promise<void>

Recargar la vista

setMultiDelay(…)

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

Establece un arreglo de condiciones {@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 estar allow_device_self_set habilitado para que esto funcione.

Importantes notas:

No utilice este método para establecer el canal en el arranque. Use 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 usar un canal público, llame unsetChannel() en su lugar - el dispositivo caerá automáticamente en el canal público correspondiente.
Utilice listChannels() para descubrir qué canales están disponibles y si permiten autoasignación.

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>

Deshabilitar la sobrescritura del canal para este dispositivo. Después de llamar a este método, el dispositivo recibirá automáticamente actualizaciones del canal público que coincida con sus condiciones (plataforma, tipo de dispositivo, tipo de compilación).

Esto es útil cuando:

Quieres mover un dispositivo de regreso 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())

Parámetro	Tipo
`options`	`UnsetChannelOptions`

Desde: 4.7.0

getChannel()

getChannel() => Promise<GetChannelRes>

Obtenga el canal para este dispositivo

Devuelve: Promise<GetChannelRes>

Desde: 4.8.0

listChannels()

listChannels() => Promise<ListChannelsResult>

Muestra 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 autoasignación.

Cada canal en el resultado incluye:

publicSi trueeste es un canal predeterminadoNo puedes autoasignarte a él utilizando setChannel(). En su lugar, si elimina la asignación de su canal utilizando 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

Parámetro	Tipo	Descripción
`options`	`SetCustomIdOptions`	es el {@link Opciones para establecer un identificador personalizadoDesde:

Copiar a portapapeles 4.9.0

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

getBuiltinVersion() => Promise<BuiltinVersion>

Sección titulada “getBuiltinVersion()”

is the {@link Promise<BuiltinVersion>

Desde: 5.2.0

getDeviceId()

getDeviceId() => Promise<DeviceId>

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

Devuelve: Promise<DeviceId>

getPluginVersion()

getPluginVersion() => Promise<PluginVersion>

Obtén 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>

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

Devuelve: Promise<AutoUpdateEnabled>

removeAllListeners()

removeAllListeners() => Promise<void>

Eliminar todos los listeners para este plugin.

Desde: 1.0.0

addListener('descargar', …)

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

Escuchar el evento de descarga de paquete en la aplicación. Dispara una vez que ha comenzado la descarga, durante la descarga y cuando se ha completado. Esto te devolverá todos los porcentajes de descarga durante la descarga

Parametro	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 el evento de no necesidad de actualizar, útil cuando deseas forzar la comprobación cada vez que se lanza la aplicación

Parametro	Tipo
`eventName`	`’noNeedUpdate’`
`listenerFunc`	`(state: NoNeedEvent) => void`

Devuelve: Promise<PluginListenerHandle>

Desde: 4.0.0

addListener('actualización_disponible', …)

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('descarga_completada', …)

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

Escucha eventos de descarga completada.

__CAPGO_KEEP_0__	__CAPGO_KEEP_0__
`eventName`	`’downloadComplete’`
`listenerFunc`	`(state: DownloadCompleteEvent) => void`

__CAPGO_KEEP_0__: Promise<PluginListenerHandle>

Desde: 4.0.0

Agregar un oyente para el evento ‘majorAvailable’, …

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

Escucha el evento de actualización mayor en la aplicación, te informa cuando una actualización mayor está bloqueada al establecer disableAutoUpdateBreaking

__CAPGO_KEEP_0__	__CAPGO_KEEP_0__
`eventName`	`’majorAvailable’`
`listenerFunc`	`(state: MajorAvailableEvent) => void`

__CAPGO_KEEP_0__ Promise<PluginListenerHandle>

Desde: 2.3.0

addListener('actualización fallida', …)

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

Escucha el evento de falla de actualización en la App, te informa cuando la actualización ha fallado al instalar en la próxima apertura de la app

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

Devuelve: Promise<PluginListenerHandle>

Desde: 2.3.0

addListener('descarga fallida', …)

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

Escucha el evento de falla de descarga en la App, te informa cuando una descarga de paquete ha fallado

Parametro	Tipo
`eventName`	`’downloadFailed’`
`listenerFunc`	`(state: DownloadFailedEvent) => void`

Devuelve: Promise<PluginListenerHandle>

Desde: 4.0.0

Agregar un escuchador para el evento ‘appReloaded’, …

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

Escucha el evento de recarga en la App, te informa cuando ha ocurrido una recarga

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

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>

Habilitar o deshabilitar 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 sacudida

Desde: 7.5.0

isShakeMenuEnabled()

isShakeMenuEnabled() => Promise<ShakeMenuEnabled>

Obtenga el estado actual del menú de sacudida

Devuelve: Promise<ShakeMenuEnabled>

Desde: 7.5.0

Interfaces

Resultado de la aplicación lista

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`

StatsUrl

Propiedad	Tipo
`url`	`string`

URL del canal

Propiedad	Tipo
`url`	`string`

Opciones de descarga

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	Valor 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 las descargas de archivos múltiples de Delta (manifest)	`undefined`	6.1.0

ManifestEntry

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

Id de paquete

Propiedad	Tipo
`id`	`string`

Resultado de lista de paquetes

Opciones de lista	Sección titulada “Opciones de lista”
`bundles`	`BundleInfo[]`

Sección titulada “Opciones de lista”

Propiedad	Tipo	Descripción	Valor 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 paquete 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`

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

Propiedad	Tipo	Descripción	Predeterminado	Desde
`channel`	`string`	El canal para obtener la versión más reciente 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`

Opciones de configuración de canal

Propiedad	Tipo
`channel`	`string`
`triggerAutoUpdate`	`boolean`

Opciones de canal no configuradas

Propiedad	Tipo
`triggerAutoUpdate`	`boolean`

Resultado de canal

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

ListChannelsResult

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

Información del 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 sobreescripción 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 para establecer el ID personalizado

Propiedad	Tipo
`customId`	`string`

__CAPGO_KEEP_0__

__CAPGO_KEEP_1__	Tipo
`version`	`string`

__CAPGO_KEEP_0__

__CAPGO_KEEP_1__	Tipo
`deviceId`	`string`

__CAPGO_KEEP_0__

Versión del plugin	__CAPGO_KEEP_1__
`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

Actualización disponible

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`	Emite cuando está disponible una nueva actualización.	4.0.0

EventoDisponibleMayor

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

EventoActualizaciónFallida

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`

Establecer opciones de menú de sacudida

Propiedad	Tipo
`enabled`	`boolean`

ShakeMenuHabilitado

Propiedad	Tipo
`enabled`	`boolean`

Alias de tipo

Estado del paquete

pendiente: El paquete está pendiente de ser DESCARGANDO descargando: El paquete se está descargando. EXITO: El paquete ha sido descargado y está listo para ser como el siguiente paquete.

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

error: El paquete no ha podido descargarse.

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