Funciones y ajustes

Configuración del complemento de actualizador

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

CapacitorUpdater puede ser configurado con estas opciones:

Propiedad	Tipo	Descripción	Default	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 como timeout. 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 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 ser subidos 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	Configura la URL / punto de conexión al que se envían las comprobaciones de actualizaciones. Disponible para Android, iOS y Electron.	https://plugin.capgo.app/updates
channelUrl	string	Configure la URL / punto de conexión para operaciones de canal. Disponible para Android, iOS y Electron.	https://plugin.capgo.app/channel_self
statsUrl	string	Configure la URL / punto de conexión 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	Configure la clave pública para la live update 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 code nativo. Disponible en Android, iOS y Electron.	undefined	4.17.48
directUpdate	boolean | ‘always’ | ‘atInstall’ | ‘onLaunch’	Obsoleto. Utilice los modos de actualización de cadena autoUpdate en su lugar: “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 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 comprobació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 del 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 seguirá respetando las sobrescripciones realizadas en la nube.	undefined	5.5.0
appId	string	Configura el id de la aplicación en la configuración.	undefined	6.0.0
keepUrlPathAfterReload	boolean	Configure el plugin para mantener la ruta de la URL después de un recarga. ADVERTENCIA: Cuando se desencadena una recarga, ‘window.history’ se eliminará.	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 hará 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

Dentro de 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
    }
  }
}

Dentro de capacitor.config.ts:

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

const config: CapacitorConfig = {
  plugins: {
    CapacitorUpdater: {
      appReadyTimeout: 1000 // (1 second),
      responseTimeout: 10 // (10 second),
      autoDeleteFailed: false,
      autoDeletePrevious: false,
      autoUpdate: 'onlyDownload',
      resetWhenUpdate: false,
      updateUrl: https://example.com/api/auto_update,
      channelUrl: https://example.com/api/channel,
      statsUrl: https://example.com/api/stats,
      publicKey: undefined,
      version: undefined,
      directUpdate: undefined,
      autoSplashscreen: undefined,
      periodCheckDelay: undefined,
      localS3: undefined,
      localHost: undefined,
      localWebHost: undefined,
      localSupa: undefined,
      localSupaAnon: undefined,
      localApi: undefined,
      localApiFiles: undefined,
      allowModifyUrl: undefined,
      defaultChannel: undefined,
      appId: undefined,
      keepUrlPathAfterReload: undefined,
      disableJSLogging: undefined,
      shakeMenu: undefined,
    },
  },
};

export default config;

• notifyAppReady()
• setUpdateUrl(...)
• setStatsUrl(...)
• setChannelUrl(...)
• download(...)
• next(...)
• set(...)
• delete(...)
• list(...)
• reset(...)
• current()
• reload()
• setMultiDelay(...)
• cancelDelay()
• getLatest(...)
• setChannel(...)
• unsetChannel(...)
• getChannel()
• listChannels()
• setCustomId(...)
• getBuiltinVersion()
• getDeviceId()
• getPluginVersion()
• isAutoUpdateEnabled()
• removeAllListeners()
• addListener('download', ...)
• addListener('noNeedUpdate', ...)
• addListener('updateAvailable', ...)
• addListener('downloadComplete', ...)
• addListener('majorAvailable', ...)
• addListener('updateFailed', ...)
• addListener('downloadFailed', ...)
• addListener('appReloaded', ...)
• addListener('appReady', ...)
• isAutoUpdateAvailable()
• getNextBundle()
• setShakeMenu(...)
• isShakeMenuEnabled()
• Interfaces
• Alias de tipo

Métodos

notifyAppReady()

notifyAppReady() => Promise<AppReadyResult>

Notificar al actualizador de Capacitor que la actualización actual está funcionando (se producirá un reenvío si no se llama a este método en cada arranque de la aplicación) Por defecto, este método debe llamarse 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>

---

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 para 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	Description
options	ChannelUrl	contiene la URL a utilizar para configurar el canal.

Since: 5.4.0

---

Desde:

download(options: DownloadOptions) => Promise<BundleInfo>

Download a new bundle from the provided URL, it should be a zip file, with files inside or with a unique id inside with all your files

Parámetro	Tipo	Descripción
options	DownloadOptions	El {@link} DownloadOptionspara descargar un nuevo archivo zip de paquete.

Returns: Promise<BundleInfo>

---

next(…)

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

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

Parámetro	Tipo	Descripción
options	BundleId	Contiene el ID del próximo Bundle a 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 inmediatamente.

Parámetro	Tipo	Descripción
options	BundleId	A {@link} BundleId} objeto 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.

Param	Tipo	Descripción
options	BundleId	A {@link} BundleIdObjeto que contiene el ID de un paquete para eliminar (tenga en cuenta que este es el ID del paquete, NO el nombre de la versión).

---

list(…)

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

Obtener todas las colecciones descargadas localmente en tu aplicación

Parametro	Tipo	Descripción
options	ListOptions	La {@link Opciones de lista} para listar colecciones

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.

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

---

actual()

current() => Promise<CurrentBundleResult>

Obtenga el paquete actual, si no hay ninguno establecido devuelve builtin. actualNative es el paquete original instalado en el dispositivo

Devuelve: Promise<CurrentBundleResult>

---

recargar()

reload() => Promise<void>

Recargar la vista

---

setMultiDelay(…)

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

Establece un arreglo {@link} Condición de retraso} 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 fondo o matar 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 desencadena la actualización después del primer kill y no después del siguiente fondo como otras opciones. Esto se arreglará en una futura versión mayor.

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

Desde: 4.3.0

---

cancelarRetraso()

cancelDelay() => Promise<void>

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

Desde: 4.0.0

---

getLatest(…)

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

Get Latest bundle available from update Url

Parámetro	Tipo
options	GetLatestOptions

Returns: Promise<LatestVersion>

Devuelve: 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() validates the channel with the backend, then stores the selected channel locally on the device. It does not create or update a backend Device Override, so the device will not appear as overridden in the Capgo dashboard. Only assignments created from the dashboard or the Public API are shown in the Device Override UI.

Observaciones importantes:

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

Parámetro	Tipo	Descripción
options	SetChannelOptions	Es el canal a establecer SetChannelOptionscanal para establecer

unsetChannel(…) Promise<ChannelRes>

Since: 4.7.0

---

Copiar a portapapeles

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

Desactiva el canal de plugin administrado local para este dispositivo. Esto elimina solo el canal almacenado localmente por setChannel(); it does not delete Dashboard or Public API Device Override records.

Después de llamar a este método, la precedencia normal del canal se aplica: un Dashboard o una configuración de dispositivo público existente API todavía gana; de lo contrario, el dispositivo puede caer hacia 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 utilizar 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

Since: 4.7.0

---

getChannel()

getChannel() => Promise<GetChannelRes>

Obtenga el canal para este dispositivo

Returns: Promise<GetChannelRes>

Desde: 4.8.0

---

listChannels()

listChannels() => Promise<ListChannelsResult>

Lista todos los canales disponibles para este dispositivo. Devuelve los canales que son compatibles con el entorno actual del dispositivo (plataforma, emulador/dispositivo real, compilación de desarrollo/producción) y que son públicos o permiten la autoasignación.

Cada canal en el resultado incluye:

• publicSi true, este es un canales predeterminadosNo puedes autoasignarte a él 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, 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 establece en la configuración

Devuelve: Promise<BuiltinVersion>

Desde: 5.2.0

---

getDeviceId()

getDeviceId() => Promise<DeviceId>

Get unique ID used to identify device (sent to auto update server)

Devuelve: Promise<DeviceId>

---

getPluginVersion()

getPluginVersion() => Promise<PluginVersion>

Obtenga la versión nativa del plugin de actualizador Capacitor (enviado al servidor de actualización automática)

Devuelve: Promise<PluginVersion>

---

isAutoUpdateEnabled()

isAutoUpdateEnabled() => Promise<AutoUpdateEnabled>

Get the state of auto update config.

Regresa: Promise<AutoUpdateEnabled>

---

removeAllListeners()

removeAllListeners() => Promise<void>

Quitar todos los escuchadores para este plugin.

Desde: 1.0.0

---

addListener('descargar', …)

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

Escuchar el evento de descarga de paquete en la aplicación. Dispara una vez que 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>

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

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

Returns: Promise<PluginListenerHandle>

Devuelve: 4.0.0

---

addListener('descargaCompleta', …)

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

Escucha eventos de descarga completada.

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 permite saber 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>

Listen for update fail event in the App, let you know when update has fail to install at next app start

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

Returns: Promise<PluginListenerHandle>

Devuelve: 2.3.0

---

agregarEscuchador('descargaFallida', …)

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

---

addListener('appReloaded', …)

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

Escucha 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

Returns: Promise<PluginListenerHandle>

Devuelve: 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. Devuelve null si no se ha establecido el siguiente paquete.

Devuelve: Promise<BundleInfo | null>

Desde: 6.8.0

---

setShakeMenu(…)

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

Habilitar o deshabilitar el menú de sacudida para fines de depuración/pruebas

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

Desde: 7.5.0

---

isShakeMenuEnabled()

isShakeMenuEnabled() => Promise<ShakeMenuEnabled>

Obtiene el estado actual del menú de sacudir

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

UpdateUrl

Propiedad	Tipo
url	string

StatsUrl

Propiedad	Tipo
url	string

URL del canal

Propiedad	Tipo
url	string

Opciones de descarga

Esta URL y versiones se utilizan para descargar el paquete desde el servidor. Si utiliza backend, toda la información se le proporcionará mediante el método getLatest. Si no utiliza backend, debe proporcionar la URL y la versión del paquete. Es necesario proporcionar la clave de sesión si ha cifrado el paquete con el comando CLI encrypt, debe recibirlos como resultado del comando.

Propiedad	Tipo	Descripción	Predeterminado	Desde
url	string	La URL del archivo zip del paquete (por ejemplo: dist.zip) para descargar. (Puede ser cualquier URL. Por ejemplo: Amazon S3, un 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 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

BundleId

Propiedad	Tipo
id	string

BundleListResult

Propiedad	Tipo
bundles	BundleInfo[]

Opciones de Lista

Propiedad	Tipo	Descripción	Predeterminado	Desde
raw	boolean	¿Devuelve 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

Reset de opciones

Propiedad	Tipo
toLastSuccessful	boolean

CurrentBundleResult

Propiedad	Tipo
bundle	BundleInfo
native	string

MultiRetrasosCondicionales

Propiedad	Tipo
delayConditions	DelayCondition[]

RetrasoCondicionado

Propiedad	Tipo	Descripción
kind	DelayUntilNext	Configura condiciones de retraso en setMultiRetraso
value	string

ÚltimaVersión

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 ú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	4.7.0
error	string
message	string

SetChannelOptions

Propiedad	Tipo
channel	string
triggerAutoUpdate	boolean

UnsetChannelOptions

Propiedad	Tipo
triggerAutoUpdate	boolean

GetChannelRes

Propiedad	Tipo	Description	Descripción
channel	string	Estado actual del canal	4.8.0
error	string
message	string
status	string
allowSet	boolean

ListChannelsResult

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

ChannelInfo

Propiedad	Tipo	Description	Descripción
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 sobrescritura 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 namey no este ID numérico id.

SetCustomIdOptions

Propiedad	Tipo
customId	string

BuiltinVersion

Propiedad	Tipo
version	string

DeviceId

Propiedad	Tipo
deviceId	string

Versión del plugin

Propiedad	Tipo
version	string

AutoUpdateEnabled

Propiedad	Tipo
enabled	boolean

Manejador de Escucha de Plugin

Propiedad	Tipo
remove	() => Promise<void>

Evento de Descarga

Propiedad	Tipo	Descripción	Desde
percent	number	Estado actual 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

EventoDescargaCompleta

Propiedad	Tipo	Descripción	Desde
bundle	BundleInfo	Emit when a new update is available.	4.0.0

MajorAvailableEvent

Propiedad	Tipo	Descripción	Desde
version	string	Emit when a new major bundle is available.	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

AppReadyEvent

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

AutoUpdateAvailable

Propiedad	Tipo
available	boolean

SetShakeMenuOptions

Propiedad	Tipo
enabled	boolean

ShakeMenuHabilitado

Propiedad	Tipo
enabled	boolean

Tipos de alias

Estado del paquete

pendiente: El paquete está pendiente de ser ESTABLECIDO descargando: El paquete está siendo descargado. éxito: El paquete ha sido descargado y está listo para ser ESTABLECIDO Siga como el próximo paquete. error: El paquete ha fallado al descargar.

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

DelayUntilNext

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

Siga desde Funciones y ajustes

Si estás utilizando Funciones y ajustes para planificar la consola y las operaciones API, conecta con Usando @capgo/capacitor-actualizador para la capacidad nativa en Usando @capgo/capacitor-actualizador, API Resumen para el detalle de implementación en 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 la implementación de detalles en dispositivos.