Funciones y ajustes

Configuración del plugin de actualizador

Ver el Github Leer el manual 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 ‘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 el tiempo de espera ‘API’. Disponible en Android, iOS y Electron.	20000 // (20 seconds)
autoDeleteFailed	boolean	Configure si el plugin debe eliminar automáticamente los paquetes fallidos. Disponible en Android, iOS y Electron.	true
autoDeletePrevious	boolean	Configure si el plugin debe eliminar automáticamente los 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 utilizar 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 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 de la verificación 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 automáticamente el siguiente paquete. Disponible en Android, iOS y Electron.	”atBackground” // true is still accepted
resetWhenUpdate	boolean	Elimina automáticamente los paquetes descargados previos cuando se instala una versión nativa más reciente del paquete de la aplicación en el dispositivo. Disponible en Android, iOS y Electron.	true
updateUrl	string	Configura la URL / punto final 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 final para las operaciones de canal. Disponible en Android, iOS y Electron.	https://plugin.capgo.app/channel_self
statsUrl	string	Configura la URL / punto final al 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 en vivo de actualizaciones 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 cadena de actualización auto: “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 gestione el ocultamiento de la pantalla de bienvenida cuando se utilizan modos de aplicación instantánea. Cuando está habilitado, el complemento 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 manualmente eventos de appReady 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 hacia atrás. Requiere que el complemento @capacitor/pantalla-de-bienvenida 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	Configure el período de retraso para la verificación de actualizaciones periódicas. La unidad es en segundos. Disponible en Android, iOS y Electron. No puede ser menor que 600 segundos (10 minutos).	600 // (10 minutes)
localS3	boolean	Configure CLI para utilizar un servidor local para pruebas o servidor de actualizaciones autoalojado.	undefined	4.17.48
localHost	string	Configure CLI para utilizar un servidor local para pruebas o servidor de actualizaciones autoalojado.	undefined	4.17.48
localWebHost	string	Configure CLI para utilizar un servidor local para pruebas o servidor de actualizaciones autoalojado.	undefined	4.17.48
localSupa	string	Configure CLI para utilizar un servidor local para pruebas o servidor de actualizaciones autoalojado.	undefined	4.17.48
localSupaAnon	string	Configure CLI para utilizar un servidor local para pruebas.	undefined	4.17.48
localApi	string	Configure CLI para utilizar un servidor local api para pruebas.	undefined	6.3.3
localApiFiles	string	Configure CLI para utilizar un archivo local api para pruebas.	undefined	6.3.3
allowModifyUrl	boolean	Permita que el complemento modifique dinámicamente la URL de actualización, la URL de estadísticas y la URL de canal 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 sobreescribirá el canal predeterminado establecido en la nube, pero seguirá respetando las sobrescripciones realizadas en la nube.	undefined	5.5.0
appId	string	Configure el identificador de 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 vaciará.	false	6.8.0
disableJSLogging	boolean	Deshabilite el registro de JavaScript del plugin. Si es verdadero, el plugin no registrará en la consola de JavaScript. Solo se realizará el registro nativo.	false	7.3.0
shakeMenu	boolean	Habilite 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": "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>

Notify Capacitor Updater that the current bundle is working (a rollback will occur if this method is not called on every app launch) By default this method should be called in the first 10 sec after app launch, otherwise a rollback will occur. Change this behaviour with {@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>

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

Desde: 5.4.0

---

setChannelUrl(…)

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

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

Parámetro	Tipo	Descripción
options	ChannelUrl	contiene la URL para 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

Parametro	Tipo	Descripción
options	DownloadOptions	El {@link} DownloadOptions} para descargar una nueva colección zip.

Devuelve: Promise<BundleInfo>

---

next(…)

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

Establece el siguiente paquete a utilizar cuando se recargue la aplicación.

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

Devuelve: Promise<BundleInfo>

---

set(…)

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

Establece el paquete actual y recarga la aplicación de inmediato.

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

---

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} BundleId}

---

list(…)

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

Obtener todos los paquetes descargados localmente en tu aplicación

Parametro	Tipo	Descripción
options	ListOptions	El {@link} 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 último paquete cargado con éxito.

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

---

current()

current() => Promise<CurrentBundleResult>

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

Recargar la vista

---

setMultiDelay(…)

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

Establece un arreglo {@link} Condición de retraso} date Establece un arreglo de condiciones que el Plugin utilizará para retrasar la actualización. Después de que todas las condiciones se cumplan, el proceso de actualización se volverá a ejecutar como de costumbre, por lo que la actualización se instalará después de un segundo plano o de matar la aplicación. Para el background kind, el valor debe ser una cadena de fecha en formato iso8601. Para el nativeVersion kind, el valor debe ser un número en milisegundos. Para el kill 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 corregirá en una futura versión mayor.	Tipo	Descripción
options	MultiDelayConditions	Conteniendo el arreglo de condiciones {@link MultiDelayConditions} para establecer

Desde: 4.3.0

---

cancelDelay()

cancelDelay() => Promise<void>

Cancela una {@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 local gestionado por el plugin para este dispositivo. El canal debe tener allow_device_self_set habilitado para que esto funcione.

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

Importantes notas:

• No utilice este método para establecer el canal al arrancar. Use en su lugar el defaultChannel in your Capacitor config instead.
• Los canales públicos no pueden ser asignados por sí mismos.
• Si un canal está marcado como llamando publicdevolverá un error. Para usar un canal público, llame en su lugar a setChannel() que hará que el dispositivo caiga automáticamente en el canal público correspondiente. unsetChannel() Important notes: Do not use this method to set the channel at boot. Use the
• Utilice listChannels() para descubrir qué canales están disponibles y si permiten la autoasignación.

Parametro	Tipo	Descripción
options	SetChannelOptions	¿Es el canal {@link} Configura el canalDevuelve:

Desde: Promise<ChannelRes>

unsetChannel(…) 4.7.0

---

Título de la sección “unsetChannel(…)”

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

Desestablecer el canal de plugin administrado local para este dispositivo. Esto elimina solo el canal almacenado localmente por setChannel()No elimina registros de dispositivo de Dashboard o Publico API

Después de llamar a este método, la precedencia normal del canal se aplica: un canal de dispositivo de Dashboard o Publico API aún gana; de lo contrario, el dispositivo puede caer en el canal público/por defecto 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 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

---

obtenerCanal()

getChannel() => Promise<GetChannelRes>

Obtener 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 sean públicos o permitan la autoasignación.

Cada canal en el resultado incluye:

• publicSi: true, este es un canal predeterminado. No puedes asignarte a ella usando setChannel(). En su lugar, si eliminas 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 asignable de forma explícita. Puedes asignar explícitamente el dispositivo a este canal usando 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 ID personalizado} el ID personalizado a establecer

Desde: 4.9.0

---

getBuiltinVersion()

getBuiltinVersion() => Promise<BuiltinVersion>

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

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

Devuelve: Promise<AutoUpdateEnabled>

---

removeAllListeners()

removeAllListeners() => Promise<void>

Elimine todos los listeners para este plugin.

Desde: 1.0.0

---

addListener(‘download’, …)

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

Escuchar evento de descarga de paquete en la App. Se dispara una vez que se ha iniciado la descarga, durante la descarga y cuando se ha completado. Este método te 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

---

addListener('noNeedUpdate', …)

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

Escuchar evento de no necesidad de actualizar, útil cuando deseas realizar una comprobación forzosa cada vez que se lanza la app

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

Devuelve: Promise<PluginListenerHandle>

Desde: 4.0.0

---

addListener('actualizaciónDisponible', …)

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

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

Escuchar eventos de descarga completada.

Parametro	Tipo
eventName	’downloadComplete’
listenerFunc	(state: DownloadCompleteEvent) => void

Devuelve: Promise<PluginListenerHandle>

Desde: 4.0.0

---

addListener(‘majorAvailable’, …)

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

Escuchar evento de actualización mayor en la aplicación, le permite saber cuando la actualización mayor está bloqueada al establecer disableAutoUpdateBreaking

Parametro	Tipo
eventName	’majorAvailable’
listenerFunc	(state: MajorAvailableEvent) => void

Devuelve: Promise<PluginListenerHandle>

Desde: 2.3.0

---

addListener('actualizaciónFallida', …)

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

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

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 en 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('aplicación lista', …)

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

Escuchar el evento de lista de la aplicación en la Aplicación, te informa 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 hay actualización automática 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 el siguiente paquete.

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

Param	Tipo	Descripción
options	SetShakeMenuOptions	Contiene booleano habilitado 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

AppReadyResult

Propiedad	Tipo
bundle	BundleInfo

BundleInfo

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

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 SessionKey son necesarios 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) a descargar. (Esta puede ser cualquier URL. Por ejemplo: Amazon S3, una GitHub etiqueta, cualquier otro lugar en el que haya 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

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

Id de paquete

Propiedad	Tipo
id	string

Resultado de la lista de paquetes

Tipo	Opciones de lista
bundles	BundleInfo[]

Propiedad

Propiedad	Tipo	Descripción	Valor predeterminado	Desde
raw	boolean	¿Devolver la lista de paquetes 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

CondicionesDeRetrasoMultiples

Propiedad	Tipo
delayConditions	DelayCondition[]

CondiciónDeRetraso

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 de getLatest

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

SetChannelOptions

Propiedad	Tipo
channel	string
triggerAutoUpdate	boolean

Deshabilitar opciones de canal

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

ListChannelsResult

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 por defecto/fallback. Los dispositivos no pueden asignarse automáticamente a los canales públicos. En su lugar, cuando un dispositivo elimina su canal de sobreescripción (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 de beta, pruebas A/B o pistas de actualización opt-in.	7.5.0

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

Establecer opciones de ID personalizado

Propiedad	Tipo
customId	string

Versión de la plataforma integrada

Propiedad	Tipo
version	string

Id. del dispositivo

Propiedad	Tipo
deviceId	string

Versión del plugin

Propiedad	Tipo
version	string

Actualización automática habilitada

Propiedad	Tipo
enabled	boolean

Manejador de escucha del plugin

Tipo	Evento de descarga
remove	() => Promise<void>

Versión del plugin

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

Sin necesidad de evento

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 importante 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 un descarga falla.	4.0.0

Evento de la aplicación lista

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

Actualización automática disponible

Propiedad	Tipo
available	boolean

Establecer opciones del menú de sacudida

Propiedad	Tipo
enabled	boolean

Habilitado para menú de sacudida

Propiedad	Tipo
enabled	boolean

Alias de tipo

Estado del paquete

pendiente: El paquete está pendiente para ser ESTABLECER como el próximo paquete. descargando: El paquete está siendo descargado. éxito: El paquete ha sido descargado y está listo para ser

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

ESTABLECER

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

error: El paquete ha fallado en la descarga.

Título de la sección “RetrasoHastaElPróximo” Sigue desde Funciones y ajustes to plan dashboard and API operations, connect it with Si estás utilizando Funciones y ajustes para planificar tableros y capgo operaciones, conecta con Utilizando @capgo/capacitor-actualizador para la capacidad nativa en Uso de @capgo/capacitor-actualizador API Vista general para el detalle de implementación en API Vista general Introducción para el detalle de implementación en Introducción API Claves para el detalle de implementación en API Claves, y Dispositivos para el detalle de implementación en Dispositivos.