Funciones y ajustes

Configuración del plugin de actualizador

Ver el Github Lectura de pantalla para obtener más información.

CapacitorUpdater se puede configurar con estas opciones:

Propiedad	Tipo	Descripción	Valor predeterminado	Desde
appReadyTimeout	number	Configure el número de milisegundos que el plugin nativo debe esperar antes de considerar una actualización como ‘fallida’. Disponible en Android, iOS y Electron.	10000 // (10 seconds)
responseTimeout	number	Configure the number of milliseconds the native plugin should wait before considering API timeout. Available on Android, iOS, and 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: Deshabilitar la actualización automática - en segundo plano: Comprueba y descarga automáticamente, luego aplica cuando la aplicación se mueve al segundo plano - en 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 - en arranque: Aplica inmediatamente al arranque, de lo contrario utilice en segundo plano después del chequeo de arranque - siempre: Aplica inmediatamente cada vez que se ejecuta la actualización automática - solo descargar: Comprueba y descarga automáticamente, emite actualización disponible y nunca establezca el paquete siguiente automáticamente. Los modos de aplicación instantánea (“en instalación”, “en arranque”, “siempre”) deben subir con —delta para que la actualización no ralentice la experiencia del usuario. En Android y iOS, esos modos requieren autoSplashscreen: true y @capacitor/pantalla de bienvenida con launchAutoHide: false. Disponible en Android, iOS y Electron.	“atBackground” // true is still accepted
resetWhenUpdate	boolean	Elimina automáticamente los paquetes descargados previos cuando se instala un paquete de aplicación nativa más nuevo en el dispositivo. Disponible en Android, iOS y Electron.	true
updateUrl	string	Configure la URL / punto 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	Configure 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	Configure la URL / punto de conexión a la que se envían las estadísticas de actualización. Disponible en Android, iOS y Electron. Establezca a "" para deshabilitar el informe de estadísticas.	https://plugin.capgo.app/stats
publicKey	string	Configure la clave pública para la actualización en vivo con cifrado de extremo a extremo. Versión 2. Disponible en Android, iOS y Electron.	undefined	6.2.0
version	string	Configure la versión actual de la aplicación. Se utilizará para la primera solicitud de actualización. Si no se establece, el plugin obtendrá la versión del nativo code. Disponible en Android, iOS y Electron.	undefined	4.17.48
directUpdate	boolean | ‘always’ | ‘atInstall’ | ‘onLaunch’	Obsoleto. Utilice en su lugar los modos de actualización de cadena automática: “atInstall”, “onLaunch” o “siempre”. Esta opción permanece soportada para aplicaciones existentes. Aplicar instantáneamente debe subir con —delta para que la actualización no ralentice la experiencia del usuario. En Android e iOS, estos modos requieren autoSplashscreen: true y @capacitor/pantalla de bienvenida con launchAutoHide: false. - 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	Requerido cuando se utilizan modos de aplicación instantánea (“atInstall”, “onLaunch” o “siempre”), incluyendo los valores de actualización directa obsoletos. @capacitor/pantalla de bienvenida debe estar instalado y configurado con launchAutoHide: false. Cuando se habilita, el plugin oculta 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 aplicación lista y llamar a SplashScreen.hide(). Disponible en Android e iOS.	false	7.6.0
periodCheckDelay	number	Configure el período de espera 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	Configure el CLI para utilizar un servidor local para pruebas o servidor de actualizaciones autoalojado.	undefined	4.17.48
localHost	string	Configure el CLI para utilizar un servidor local para pruebas o servidor de actualizaciones autoalojado.	undefined	4.17.48
localWebHost	string	Configure el CLI para utilizar un servidor local para pruebas o servidor de actualizaciones autoalojado.	undefined	4.17.48
localSupa	string	Configure el CLI para utilizar un servidor local para pruebas o servidor de actualizaciones autoalojado.	undefined	4.17.48
localSupaAnon	string	Configure el CLI para utilizar un servidor local para pruebas.	undefined	4.17.48
localApi	string	Configure el CLI para utilizar un servidor local api para pruebas.	undefined	6.3.3
localApiFiles	string	Configure el CLI para utilizar un archivo local api para pruebas.	undefined	6.3.3
allowModifyUrl	boolean	Permitir al plugin modificar la URL de actualización, la URL de estadísticas y la URL de canal dinámicamente desde el lado de JavaScript.	false	5.4.0
defaultChannel	string	Establecer el canal predeterminado para la aplicación en la configuración. Sensible a mayúsculas y minúsculas. Esta configuración sobreescribirá el canal predeterminado establecido en la nube, pero aún respetará las sobrescripciones realizadas en la nube.	undefined	5.5.0
appId	string	Configure el ID de la aplicación para la aplicación en la configuración.	undefined	6.0.0
keepUrlPathAfterReload	boolean	Configure el plugin para mantener la ruta de la URL después de un recarga. ADVERTENCIA: Cuando se desencadena una recarga, ‘window.history’ se borrará.	false	6.8.0
disableJSLogging	boolean	Desactivar el registro de JavaScript del plugin. Si es verdadero, el plugin no registrará en la consola de JavaScript. Solo se realizará el registro nativo.	false	7.3.0
shakeMenu	boolean	Habilitar 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>

Notificar Capacitor Actualizador 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)

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

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	El {@link} DownloadOptions} para descargar un nuevo archivo zip de paquete.

Devuelve: Promise<BundleInfo>

---

next(…)

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

Establecer el próximo paquete a utilizar cuando la aplicación se recargue.

Parámetro	Tipo	Descripción
options	BundleId	Contiene la ID del siguiente Bundle para establecer en la próxima lanzamiento 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 id de paquete para establecer como actual. BundleId} objeto.

---

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.

Param	Tipo	Descripción
options	BundleId	Un objeto {@link} BundleIdobjeto 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(…)

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

Obtener todos los paquetes descargados localmente en tu aplicación

Parametro	Tipo	Descripción
options	ListOptions	Los {@link} ListOptions} para listar paquetes

Devuelve: Promise<BundleListResult>

---

reset(…)

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

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

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

---

actual()

current() => Promise<CurrentBundleResult>

Obtenga la versión actualizada del paquete, si no hay ninguna establecida devuelve builtincurrentNative es la versión original instalada en el dispositivo

Devuelve: Promise<CurrentBundleResult>

---

recargar()

reload() => Promise<void>

Recargar la vista

---

setMultiDelay(…)

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

Establece un arreglo {@link} DelayCondition} que contiene condiciones que el Plugin utilizará para retrasar la actualización. Después de que se cumplan todas las condiciones, el proceso de actualización se reanudará como de costumbre, por lo que la actualización se instalará después de haber ejecutado el programa en segundo plano o haberlo matado. 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 active después de la primera matanza y no después de la siguiente ejecución en segundo plano como otras opciones. Esto se corregirá en una futura versión mayor.

Parámetro	Tipo	Descripción
options	MultiDelayConditions	Conteniendo el {@link} MultiRetrasoCondiciones} un array de condiciones para establecer

Desde: 4.3.0

---

cancelarRetraso()

cancelDelay() => Promise<void>

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

Desde: 4.0.0

---

getLatest(…)

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

Obtiene 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 de plugin administrado local para este dispositivo. El canal debe estar allow_device_self_set habilitado para que esto funcione.

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

Notas importantes:

• No utilice este método para establecer el canal en el arranque. Utilice el defaultChannel in your Capacitor config instead.
• en lugar.
• Este método está destinado a usarse 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 ser asignados por sí mismos. publicSi un canal está marcado como setChannel() , llamando unsetChannel() devolverá un error. Para usar un canal público, llame
• en su lugar - el dispositivo caerá automáticamente en el canal público correspondiente. listChannels() Use

para descubrir qué canales están disponibles y si permiten la asignación por sí mismos.	Tipo	Descripción
options	SetChannelOptions	¿Es el {@link SetChannelOptions} canal para establecer

Devuelve: Promise<ChannelRes>

Desde: 4.7.0

---

unsetChannel(…)

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

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

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

Esto es útil cuando:

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

Parámetro	Tipo
options	UnsetChannelOptions

Desde: 4.7.0

---

getChannel()

getChannel() => Promise<GetChannelRes>

Obtén el canal para este dispositivo

Devuelve: Promise<GetChannelRes>

Desde: 4.8.0

---

listarCanales()

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 asignación automática.

Cada canal en el resultado incluye:

• publicSi true, este es un canales predeterminados. No puedes asignarte a él mismo 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, esto es un canal autoasignable. Puede asignar explícitamente el dispositivo a este canal utilizando setChannel().

Returns: Promise<ListChannelsResult>

Since: 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} opciones de identificador personalizado para establecer

Desde: 4.9.0

---

getBuiltinVersion()

getBuiltinVersion() => Promise<BuiltinVersion>

Obtiene la versión del app nativa o la versión incorporada si se ha establecido 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.

Regresa: Promise<AutoUpdateEnabled>

---

removeAllListeners()

removeAllListeners() => Promise<void>

Elimine todos los oyentes para este plugin.

Desde: 1.0.0

---

addListener(‘download’, …)

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

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

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

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

Devuelve: Promise<PluginListenerHandle>

Desde: 4.0.0

---

addListener('updateAvailable', …)

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

Escuchar el evento de actualización disponible, útil cuando deseas realizar una comprobación forzosa 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 completa’, …)

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

---

addListener('actualizaciónMayorDisponible', …)

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

Escucha el evento de actualización mayor en la aplicación, te informa cuando la 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('actualizaciónFallida', …)

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

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

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

Devuelve: Promise<PluginListenerHandle>

Desde: 4.0.0

---

addListener('appReloaded', …)

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

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

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

Devuelve: Promise<PluginListenerHandle>

Desde: 4.3.0

---

addListener('appReady', …)

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

Escuchar el evento de aplicación lista en la App, 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 la actualización automática está disponible (no deshabilitada por serverUrl).

Devuelve: Promise<AutoUpdateAvailable>

---

getNextBundle()

getNextBundle() => Promise<BundleInfo | null>

Obtenga el siguiente paquete que se utilizará cuando se recargue la aplicación. Devuelve null si no se ha establecido 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

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

Desde: 7.5.0

---

isShakeMenuEnabled()

isShakeMenuEnabled() => Promise<ShakeMenuEnabled>

Obtiene el estado actual del menú de sacudida

Devuelve: Promise<ShakeMenuEnabled>

Desde: 7.5.0

---

Interfaces

AppReadyResult

Propiedad	Tipo
bundle	BundleInfo

Información de paquete

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

URL de actualización

Propiedad	Tipo
url	string

URL de estadísticas

Propiedad	Tipo
url	string

Url del canal

Propiedad	Tipo
url	string

Opciones de descarga

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

Tipo	protectedTokens	Descripción	Valor predeterminado	Desde
url	string	La URL del archivo zip del paquete (por ejemplo: dist.zip) que se descargará. (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	El checksum para la actualización, debe ser en sha256 y cifrado con la clave privada si el paquete está cifrado	undefined	4.0.0
manifest	ManifestEntry[]	El manifiesto para las descargas de Delta (manifest) de múltiples archivos	undefined	6.1.0

Entrada del manifiesto

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

Id de la caja

Propiedad	Tipo
id	string

Resultado de la lista de cajas

Propiedad	Tipo
bundles	BundleInfo[]

Opciones de lista

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

MultiRetardoCondiciones

Propiedad	Tipo
delayConditions	DelayCondition[]

CondiciónDeRetardo

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

VersiónMásReciente

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	Valor por defecto	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

Opciones de configuración del canal

Propiedad	Tipo
channel	string
triggerAutoUpdate	boolean

Opciones del canal desestablecidas

Propiedad	Tipo
triggerAutoUpdate	boolean

Resultado del canal

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

Resultado de lista de canales

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

Info de canal

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 configuración de canal (utilizando unsetChannel()), recibirá automáticamente actualizaciones del canal público que coincida.	7.5.0
allow_self_set	boolean	Si es verdadero, los dispositivos pueden asignarse explícitamente a este canal utilizando setChannel() . Se utiliza típicamente para pruebas de beta, pruebas A/B o pistas de actualizaciones de opción.	7.5.0

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

Opciones de ID personalizado

Propiedad	Tipo
customId	string

Versión de construcción

Propiedad	Tipo
version	string

Id de dispositivo

Propiedad	Tipo
deviceId	string

Versión del plugin

Propiedad	Tipo
version	string

AutoActualizaciónHabilitada

Propiedad	Tipo
enabled	boolean

ManejadorDeEscuchaDelPlugin

Propiedad	Tipo
remove	() => Promise<void>

EventoDeDescarga

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

Evento de descarga completa

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

EventoDeMáquinaDisponible

Propiedad	Tipo	Descripción	Desde
version	string	Emite cuando está disponible una nueva máquina de bundle mayor.	4.0.0

EventoDeActualizaciónFallida

Propiedad	Tipo	Descripción	Desde
bundle	BundleInfo	Se emite cuando una actualización no se pudo instalar.	4.0.0

DownloadFailedEvent

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

AppReadyEvent

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

AutoActualizaciónDisponible

Propiedad	Tipo
available	boolean

Opciones del menú de sacudida

Propiedad	Tipo
enabled	boolean

HabilitarMenúDeSacudida

Propiedad	Tipo
enabled	boolean

Alias de tipo

EstadoDelPaquete

pendiente: El paquete está pendiente para ser ESTABLECER descargando: El paquete está siendo descargado. ESTABLECER como la próxima versión.

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

error: No se ha podido descargar la versión.

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

Sección titulada “DelayUntilNext”

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