Funciones y ajustes

Configuración del plugin de actualizador

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

El actualizador de Capacitor se puede configurar con estas opciones:

Propiedad	Tipo	Descripción	Predeterminado	Desde
appReadyTimeout	number	Configura el número de milisegundos que el plugin nativo debe esperar antes de considerar una actualización ‘fallida’. Disponible en Android, iOS y Electron.	10000 // (10 seconds)
responseTimeout	number	Configura el número de milisegundos que el plugin nativo debe esperar antes de considerar API tiempo de espera. Disponible en Android, iOS y Electron.	20000 // (20 seconds)
autoDeleteFailed	boolean	Configura si el plugin debe usar automáticamente eliminar paquetes fallidos. Disponible en Android, iOS y Electron.	true
autoDeletePrevious	boolean	Configura si el plugin debe usar automáticamente eliminar paquetes previos después de una actualización exitosa. Disponible en Android, iOS y Electron.	true
autoUpdate	boolean | ‘off’ | ‘atBackground’ | ‘atInstall’ | ‘onLaunch’ | ‘always’ | ‘onlyDownload’	Configura cómo el plugin debe usar 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 Actualización Automática - en segundo plano: Comprueba y descarga automáticamente, 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 del arranque de la comprobación - siempre: Aplica inmediatamente siempre que se ejecute Actualización Automática - soloDescargar: Comprueba y descarga automáticamente, emite actualizaciónDisponible, y nunca establezca automáticamente el siguiente paquete. Disponible en Android, iOS y Electron.	”atBackground” // true is still accepted
resetWhenUpdate	boolean	Eliminar automáticamente paquetes descargados previos cuando se instala una versión más nueva del paquete de aplicación nativa 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 actualización. Disponible en Android, iOS y Electron.	https://plugin.capgo.app/updates
channelUrl	string	Configure la URL / punto de conexión para 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 estadísticas de actualización. Disponible en Android, iOS y Electron. Establezca a "" para deshabilitar la informe de estadísticas.	https://plugin.capgo.app/stats
publicKey	string	Configure 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	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 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 y llamar a SplashScreen.hide() manualmente. Solo funciona cuando autoUpdate está configurado en “atInstall”, “onLaunch” o “siempre”. Los valores de directUpdate legados todavía se admiten por compatibilidad hacia atrás. 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 retardo para la verificación de actualizaciones periódicas. El unidad es en segundos. Disponible en Android, iOS y Electron. No puede ser menor que 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 URL de actualización, la URL de estadísticas y la URL de canal dinámicamente desde el lado del JavaScript.	false	5.4.0
defaultChannel	string	Establecer el canal predeterminado para la aplicación en la configuración. Sensible a mayúsculas. Esta configuración reemplazará el canal predeterminado establecido en la nube, pero aún respetará las sobrescripciones realizadas en la nube.	undefined	5.5.0
appId	string	Configurar el identificador de la aplicación para la aplicación en la configuración.	undefined	6.0.0
keepUrlPathAfterReload	boolean	Configurar 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	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	Activar 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

notificarAplicaciónPreparada()

notifyAppReady() => Promise<AppReadyResult>

Notificar al actualizador de Capacitor que la actual bundle está funcionando (se producirá un reenvío si no se llama a este método en cada arranque de la aplicación) Por defecto, este método debe llamarse en las primeras 10 seg después del arranque de la aplicación, de lo contrario se producirá un reenvío. Cambie este comportamiento con {@link appReadyTimeout}

Devuelve: Promise<AppReadyResult>

---

establecerUrlDeActualización(…)

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

Establecer la url de actualización para la aplicación, esta será utilizada 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>

Establecer la URL 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	Las opciones de descarga para un nuevo paquete zip: {@link DownloadOptions}

Devuelve: Promise<BundleInfo>

---

next(…)

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

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

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

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 el ID de una paquete para eliminar (nota, este es el ID del paquete, NO el nombre de la versión) list(…)Sección titulada “list(…)

---

Copiar a portapapeles

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

Tipo

Descripción	El {@link}	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>

Reinicia la aplicación a la builtin paquetería (la que se envía a Apple App Store / Google Play Store ) o la última paquetería cargada con éxito.

Parámetro	Tipo	Descripción
options	ResetOptions	Conteniendo {@link} ResetOptions.toLastSuccessful}, true se resetea al bundle incorporado y false se reseteará al último bundle cargado con éxito.

---

current()

current() => Promise<CurrentBundleResult>

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

Devuelve: Promise<CurrentBundleResult>

---

reload()

reload() => Promise<void>

Recargar la vista

---

__CAPGO_KEEP_0__

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 al cerrar 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 cierre y no después del siguiente segundo plano como otras opciones. Esto se corregirá en una futura versión mayor.

Parámetro	Tipo	Descripción
options	MultiDelayConditions	Contiene el 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 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, 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 consola de Capgo. Solo se muestran las asignaciones creadas desde la consola o desde el Public API en la interfaz de usuario de override de dispositivo.

Notas importantes:

• No utilice este método para establecer el canal en el arranque. Use el defaultChannel en su configuración de Capacitor en su 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. Si un canal está marcado como public, llamar a setChannel() devolverá un error. Para usar un canal público, llame a unsetChannel() en su lugar - el dispositivo automáticamente caerá en el canal público correspondiente.
• Utilice para descubrir qué canales están disponibles y si permiten la autoasignación. listChannels() Param

Tipo	Descripción	¿Es el canal {@link SetChannelOptions} a establecer?
options	SetChannelOptions	Devuelve: Desde:unsetChannel(…)

Sección titulada “unsetChannel(…) Promise<ChannelRes>

Sección titulada “unsetChannel(…) 4.7.0

---

Sección titulada “unsetChannel(…)

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

Deshabilita el canal local gestionado por el plugin para este dispositivo. Esto elimina solo el canal almacenado localmente por setChannel()no elimina los registros de dispositivo de la consola o público API.

Después de llamar a este método, la precedencia normal del canal se aplica: un canal de dispositivo de la consola o público API existente 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 a la pista de actualización 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>

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

Cada canal en el resultado incluye:

• publicSi trueeste es un canal por defecto. No puedes asignar a ti mismo a ella utilizando setChannel(). En su lugar, si eliminas tu asignación de canal utilizando unsetChannel(), el dispositivo recibirá automáticamente actualizaciones de este canal público.
• allow_self_set: Si true, este es un canal autoasignable. Puedes asignar explícitamente al dispositivo a este canal utilizando setChannel().

Returns: Promise<ListChannelsResult>

Desde: 7.5.0

---

setCustomId(…)

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

Establezca un ID personalizado para este dispositivo

Parametro	Tipo	Descripción
options	SetCustomIdOptions	es el {@link SetCustomIdOptions} el ID personalizado para establecer

Desde: 4.9.0

---

getBuiltinVersion()

getBuiltinVersion() => Promise<BuiltinVersion>

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

Devuelve: Promise<BuiltinVersion>

Desde: 5.2.0

---

getDeviceId()

getDeviceId() => Promise<DeviceId>

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 Capacitor del plugin de actualización (enviado al servidor de actualización automática)

Devuelve: Promise<PluginVersion>

---

¿Está habilitada la actualización automática()

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

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

Escuchar el evento de descarga de paquete en la aplicación. Se dispara una vez que se ha iniciado la descarga, durante la descarga y cuando se ha completado. Esto 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

---

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

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

Parámetro	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 se bloquea la actualización mayor al establecer disableAutoUpdateBreaking

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

Devuelve: Promise<PluginListenerHandle>

Desde: 2.3.0

---

addListener('actualización fallida', …)

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

Escuchar el evento de falla de actualización en la aplicación, le 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('descarga fallida', …)

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

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

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

Devuelve: Promise<PluginListenerHandle>

Desde: 4.0.0

---

Agregar escuchador a ‘appReloaded’, …

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

Escucha el evento de recarga en la aplicación, te informa cuando ha ocurrido una recarga

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

Returns: 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 Aplicación, te informa cuando la aplicación está lista para usar

Parametro	Tipo
eventName	’appReady’
listenerFunc	(state: AppReadyEvent) => void

Returns: Promise<PluginListenerHandle>

Desde: 5.1.0

---

isAutoUpdateAvailable()

isAutoUpdateAvailable() => Promise<AutoUpdateAvailable>

Obtener si hay actualizaciones automáticas disponibles (no deshabilitadas por serverUrl).

Returns: Promise<AutoUpdateAvailable>

---

getNextBundle()

getNextBundle() => Promise<BundleInfo | null>

Obtenga el siguiente paquete que se utilizará cuando se recargue la aplicación. Returns null si no hay un paquete siguiente configurado.

Returns: 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

Parametro	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

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

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. La clave de sesión es obligatoria 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. (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	El checksum para la actualización, debe estar en sha256 y cifrado 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

Entrada del manifiesto

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

Id de la Colección

Propiedad	Tipo
id	string

Resultado de la Lista de Colecciones

Propiedad	Tipo
bundles	BundleInfo[]

Opciones de Lista

Propiedad	Tipo	Descripción	Valor por defecto	Desde
raw	boolean	¿Devolver la lista de paquetes compilados crudos o el manifiesto? Si es verdadero, la lista intentará leer la base de datos interna en lugar de los archivos en disco.	false	6.14.0

ResetOptions

Propiedad	Tipo
toLastSuccessful	boolean

Resultado de paquete compilado actual

Propiedad	Tipo
bundle	BundleInfo
native	string

CondicionesDeRetrasoMultiples

Propiedad	Tipo
delayConditions	DelayCondition[]

CondiciónDeRetraso

Propiedad	Tipo	Descripción
kind	DelayUntilNext	Configurar 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 GetLatest

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

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 asignación de canal personalizada (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 beta, pruebas A/B o pistas de actualizaciones 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 Capgo

Propiedad	Tipo
version	string

Id del dispositivo

Propiedad	Tipo
deviceId	string

Versión del plugin

__CAPGO_KEEP_0__	__CAPGO_KEEP_0__
version	string

Actualización automática habilitada

__CAPGO_KEEP_0__	__CAPGO_KEEP_0__
enabled	boolean

Manejador de escucha del plugin

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

__CAPGO_KEEP_0__

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

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

Habilitar menú Shake

Propiedad	Tipo
enabled	boolean

Alias de tipo

Estado de la caja

pendiente: La caja está pendiente para ser ESTABLECER como el siguiente 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 al descargarse.

Sección titulada “Retrasar hasta el siguiente” Sigue adelante desde Funciones y ajustes to plan dashboard and API operations, connect it with Si estás utilizando Funciones y ajustes para planificar la consola y capgo operaciones, conecta con el servidor de Cloudflare para obtener actualizaciones de capacitor en tiempo real. Para obtener más información, consulta la documentación de GitHub para @capgo/capacitor-updater para la capacidad nativa en Usando @capgo/capacitor-actualizador, API Resumen para el detalle de implementación en API Resumen, 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.