Funciones y ajustes

Configuración del plugin de actualizador

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

CapacitorUpdater se puede configurar con estas opciones:

Propiedad	Tipo	Descripción	Valor predeterminado	Desde
appReadyTimeout	number	Configure el número de milisegundos que el plugin nativo debe esperar antes de considerar una actualización ‘fallida’. Disponible en Android, iOS y Electron.	10000 // (10 seconds)
responseTimeout	number	Configure el número de milisegundos que el plugin nativo debe esperar antes de considerar API 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’	Configura cómo el plugin debe usar Auto Actualización a través de un servidor de actualización. true es lo mismo que “en segundo plano”; false es lo mismo que “apagado”. - apagado: Deshabilitar Auto Actualización - en segundo plano: Comprueba y descarga automáticamente, luego aplique cuando la aplicación se mueva al segundo plano - en la instalación: Aplicar 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: Aplicar inmediatamente al arranque, de lo contrario utilice en segundo plano después del arranque de la comprobación - siempre: Aplicar inmediatamente cada vez que se ejecute Auto Actualización - soloDescargar: Comprueba y descarga automáticamente, emite actualización disponible, y nunca establezca el paquete siguiente automáticamente. Disponible en Android, iOS, y Electron.	”atBackground” // true is still accepted
resetWhenUpdate	boolean	Eliminar automáticamente 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 final a la que se envían las comprobaciones de actualización. Disponible en Android, iOS, y Electron.	https://plugin.capgo.app/updates
channelUrl	string	Configura la URL / punto final para operaciones de canal. Disponible en Android, iOS, y Electron.	https://plugin.capgo.app/channel_self
statsUrl	string	Configura la URL / punto final a la 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 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 automática: “atInstall”, “onLaunch”, o “always”. 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: “always” - true: Lo mismo que “siempre” para compatibilidad hacia atrás. Disponible en Android, iOS, y Electron.	false	5.1.0
autoSplashscreen	boolean	Gestionar automáticamente la ocultación de la pantalla de bienvenida cuando se utilizan modos de aplicación instantánea. Cuando se habilita, 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 aplicación lista y llamar a SplashScreen.hide(). Solo funciona cuando autoUpdate está configurado en “atInstall”, “onLaunch”, o “siempre”. Los valores de directUpdate legados todavía se soportan para compatibilidad hacia atrás. Requiere la instalación y configuración del plugin @capacitor/splash-screen con launchAutoHide: false. Requiere que se habilite la actualización automática. Disponible en Android e iOS.	false	7.6.0
periodCheckDelay	number	Configure el período de retraso para la verificación de actualizaciones periódicas. La unidad es en segundos. No puede ser menor que 600 segundos (10 minutos). Disponible en Android, iOS, y Electron.	600 // (10 minutes)
localS3	boolean	Configure CLI para utilizar un servidor local para pruebas o servidor de actualizaciones autoalojado.	undefined	4.17.48
localHost	string	Configure CLI para utilizar un servidor local para pruebas o servidor de actualizaciones autoalojado.	undefined	4.17.48
localWebHost	string	Configure CLI para utilizar un servidor local para pruebas o servidor de actualizaciones autoalojado.	undefined	4.17.48
localSupa	string	Configure CLI para utilizar un servidor local para pruebas o servidor de actualizaciones autoalojado.	undefined	4.17.48
localSupaAnon	string	Configure CLI para utilizar un servidor local para pruebas.	undefined	4.17.48
localApi	string	Configure CLI para utilizar un servidor local api para pruebas.	undefined	6.3.3
localApiFiles	string	Configure CLI para utilizar un archivo local api para pruebas.	undefined	6.3.3
allowModifyUrl	boolean	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. 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 identificador 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	Deshabilitar el registro de JavaScript del plugin. Si es verdadero, el plugin no registrará en la consola de JavaScript. Solo se hará el registro nativo.	false	7.3.0
shakeMenu	boolean	Habilite el gesto de sacudir para mostrar el menú de actualización para fines de depuración/pruebas	false	7.5.0

Ejemplos

En capacitor.config.json:

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

En capacitor.config.ts:

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

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

export default config;

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

Métodos

notifyAppReady()

notifyAppReady() => Promise<AppReadyResult>

Notificar al actualizador de Capacitor que el paquete actual está funcionando (se producirá un reenvío si no se llama a este método en cada lanzamiento de la aplicación) Por defecto, este método debe llamarse en las primeras 10 seg después del lanzamiento 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, se utilizará para verificar actualizaciones.

Parámetro	Tipo	Descripción
options	UpdateUrl	contiene la URL a utilizar para verificar actualizaciones.

Desde: 5.4.0

---

setStatsUrl(…)

setStatsUrl(options: StatsUrl) => Promise<void>

Establecer la URL de estadísticas para la aplicación, se utilizará para enviar estadísticas. Pasar una cadena vacía deshabilitará la recopilación de estadísticas.

Parámetro	Tipo	Descripción
options	StatsUrl	contiene la URL a utilizar para enviar estadísticas.

Desde: 5.4.0

---

setChannelUrl(…)

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

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

Parametro	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

Parametro	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 siguiente paquete a utilizar cuando la aplicación se recargue.

Param	Tipo	Descripción
options	BundleId	Contiene la ID del siguiente Bundle para establecer en la próxima apertura de la aplicación. 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	Un {@link} Id de paqueteObjeto que contiene el nuevo id de paquete para establecer como actual.

---

delete(…)

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

Elimina el paquete especificado desde el almacenamiento del app nativo. Utilice con {@link list} para obtener los IDs de paquetes almacenados.

Parámetro	Tipo	Descripción
options	BundleId	Un objeto {@link BundleId} 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) delete(…)BundleId

---

list(…)

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

Obtenga todos los paquetes descargados localmente en su aplicación

Parámetro	Tipo	Descripción
options	ListOptions	Las opciones para listar paquetes {@link ListOptions}

Devuelve: Promise<BundleListResult>

---

reset(…)

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

Restablecer 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 restablece a la paquetería predeterminada y false se restablecerá a la última paquetería cargada con éxito.

---

actual()

current() => Promise<CurrentBundleResult>

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

Devuelve: Promise<CurrentBundleResult>

---

reload()

reload() => Promise<void>

Recargar la vista

---

setMultiDelay(…)

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

Establece un array {@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 ejecutará de nuevo como de costumbre, por lo que la actualización se instalará después de haber realizado una tarea de fondo o haber matado la aplicación.Para el tipo "kind", el valor debe ser una cadena de fecha en formato ISO 8601. date Para el tipo "kind", el valor debe ser un número en milisegundos. background Para el tipo "kind", el valor debe ser el número de versión. nativeVersion Para el tipo "kind", el valor no se utiliza. kill La función tiene comportamiento inconsistente, ya que la opción "kill" hace que la actualización se ejecute después del primer kill y no después del siguiente background, como otras opciones. Esto se corregirá en una futura versión mayor.

Parámetro	Tipo	Descripción
options	MultiDelayConditions	Conteniendo el {@link MultiDelayConditions} Establece un array {@link DelayCondition} que contiene condiciones que el Plugin utilizará para retrasar la actualización.arreglo de condiciones para establecer

Desde: 4.3.0

---

cancelDelay()

cancelDelay() => Promise<void>

Cancela una {@link DelayCondition} para procesar una actualización de inmediato. Desde:getLatest(…)

Sección titulada “getLatest(…)” 4.0.0

---

Copiar a portapapeles

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

Obtenga el paquete más reciente disponible desde la URL de actualización

Parámetro	Tipo
options	GetLatestOptions

Devuelve: Promise<LatestVersion>

Desde: 4.0.0

---

setChannel(…)

setChannel(options: SetChannelOptions) => Promise<ChannelRes>

Establece el canal para este dispositivo. El canal debe estar allow_device_self_set habilitado para que esto funcione.

Importantes notas:

• No utilice este método para establecer el canal en el arranque. Use el defaultChannel en su Capacitor configuración en lugar de.
• Este método está destinado para su uso después de que la aplicación esté lista y el usuario haya interactuado (por ejemplo, optando por un programa de beta).
• Los canales públicos no pueden asignarse automáticamente. Si un canal está marcado como public, llamar setChannel() devolverá un error. Para usar un canal público, llame unsetChannel() en su lugar - el dispositivo caerá automáticamente en el canal público correspondiente.
• Utilice listChannels() para descubrir qué canales están disponibles y si permiten la asignación automática.

Parámetro	Tipo	Descripción
options	SetChannelOptions	¿Está el canal {@link } para establecer} channel to set

Devuelve: Promise<ChannelRes>

Since: 4.7.0

---

Desde:

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

Unset the channel override for this device. After calling this method, the device will automatically receive updates from the Título de la sección “unsetChannel(…) Copiar al portapapeles

Desestablecer el canal de sobrecarga para este dispositivo. Después de llamar a este método, el dispositivo recibirá automáticamente actualizaciones del canal público que coincida con sus condiciones (plataforma, tipo de dispositivo, tipo de compilación). Esto es útil cuando:

• Desea mover un dispositivo a la pista de actualización predeterminada
• Desea usar un canal público (ya que los canales públicos no pueden asignarse de forma autoasignada a través de setChannel())

Parámetro	Tipo
options	UnsetChannelOptions

Desde: 4.7.0

---

obtenerCanal()

getChannel() => Promise<GetChannelRes>

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

Cada canal en el resultado incluye:

• publicSi true, este es un canales por defecto. No 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_setSi true, este es un canal autoasignable. Puede asignar explícitamente el dispositivo a este canal utilizando setChannel().

Devuelve: Promise<ListChannelsResult>

Desde: 7.5.0

---

setCustomId(…)

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

Establecer un ID personalizado para este dispositivo

Parámetro	Tipo	Descripción
options	SetCustomIdOptions	es el {@link} Opciones de SetCustomId} para establecer el customId

Desde: 4.9.0

---

getBuiltinVersion()

getBuiltinVersion() => Promise<BuiltinVersion>

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

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

Devuelve: Promise<DeviceId>

---

getPluginVersion()

getPluginVersion() => Promise<PluginVersion>

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

Devuelve: Promise<PluginVersion>

---

isAutoUpdateEnabled()

isAutoUpdateEnabled() => Promise<AutoUpdateEnabled>

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

Devuelve: Promise<AutoUpdateEnabled>

---

removeAllListeners()

removeAllListeners() => Promise<void>

Eliminar todos los oyentes para este plugin.

Desde: 1.0.0

---

addListener(‘download’, …)

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

Escuchar el evento de descarga de paquetes 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 evento de no necesidad de actualizar, útil cuando deseas verificar 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 evento de actualización disponible, útil cuando deseas verificar cada vez que se lanza la aplicación

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

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

Devuelve: Promise<PluginListenerHandle>

Desde: 4.0.0

---

addListener('actualizado mayor', …)

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

Escuchar el evento de actualización mayor en la aplicación, le permite saber cuando una 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ón fallida', …)

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

Escuchar evento de falla de actualización en la Aplicación, te informa cuando la actualización ha fallado al instalar en la próxima apertura de la aplicación

Parametro	Tipo
eventName	’updateFailed’
listenerFunc	(state: UpdateFailedEvent) => void

Devuelve: Promise<PluginListenerHandle>

Desde: 2.3.0

---

addListener('descargaFallida', ...)

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

Escuchar evento de falla de descarga en la Aplicación, te informa cuando una descarga de paquete ha fallado

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

Parámetro	Tipo
eventName	’appReady’
listenerFunc	(state: AppReadyEvent) => void

Devuelve: Promise<PluginListenerHandle>

Desde: 5.1.0

---

isAutoUpdateAvailable()

isAutoUpdateAvailable() => Promise<AutoUpdateAvailable>

Obtener si hay actualización automática disponible (no deshabilitada por serverUrl).

Devuelve: Promise<AutoUpdateAvailable>

---

getNextBundle()

getNextBundle() => Promise<BundleInfo | null>

Obtiene el siguiente paquete que se utilizará cuando se recargue la aplicación. Devuelve null si no se ha establecido un paquete siguiente.

Devuelve: Promise<BundleInfo | null>

Desde: 6.8.0

---

setShakeMenu(…)

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

Habilita o deshabilita el menú de sacudida para fines de depuración/pruebas

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

Desde: 7.5.0

---

isShakeMenuEnabled()

isShakeMenuEnabled() => Promise<ShakeMenuEnabled>

Obtenga el estado actual del menú de sacudida

Devuelve: Promise<ShakeMenuEnabled>

Desde: 7.5.0

---

Interfaces

AppReadyResult

Propiedad	Tipo
bundle	BundleInfo

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

ManifestEntry

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

Id del paquete

Propiedad	Tipo
id	string

Resultado de la lista de paquetes

Propiedad	Tipo
bundles	BundleInfo[]

Opciones de lista

Propiedad	Tipo	Descripción	Valor predeterminado	Dado que
raw	boolean	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

Resultado de la compilación actual

Propiedad	Tipo
bundle	BundleInfo
native	string

Condiciones de retardo múltiple

Propiedad	Tipo
delayConditions	DelayCondition[]

Condición de Retraso

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

Versión más Reciente

Propiedad	Tipo	Descripción	Desde
version	string	Resultado del método getLatest	4.0.0
checksum	string		6
major	boolean
message	string
sessionKey	string
error	string
old	string
url	string
manifest	ManifestEntry[]		6.1

GetLatestOptions

Propiedad	Tipo	Descripción	Valor por defecto	Desde
channel	string	El canal para obtener la versión más reciente. El canal debe permitir ‘self_assign’ para que esto funcione	undefined	6.8.0

CanalRes

Propiedad	Tipo	Descripción	Desde
status	string	Estado actual de establecer canal	4.7.0
error	string
message	string

Opciones de establecer canal

Propiedad	Tipo
channel	string
triggerAutoUpdate	boolean

Opciones de desestablecer canal

Propiedad	Tipo
triggerAutoUpdate	boolean

ObtenerCanalRes

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 listado de canales

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	If true, este es un canal por defecto/fallback. Los dispositivos no pueden asignarse automáticamente a canales públicos. En su lugar, cuando un dispositivo elimina su sobreescripción de canal (usando unsetChannel()), recibirá automáticamente actualizaciones del canal público que coincida con él.	7.5.0
allow_self_set	boolean	If true, los dispositivos pueden asignarse explícitamente a este canal usando 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 número id.

SetCustomIdOptions

Propiedad	Tipo
customId	string

Versión de Builtin

Propiedad	Tipo
version	string

Id de dispositivo

Propiedad	Tipo
deviceId	string

Versión del complemento

Propiedad	Tipo
version	string

Actualización automática habilitada

Propiedad	Tipo
enabled	boolean

Manejador de escucha de plugin

Propiedad	Tipo
remove	() => Promise<void>

Evento de descarga

Descripción	Desde	PluginListenerHandle	DownloadEvent
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

UpdateAvailableEvent

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

Evento de versión mayor

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

Evento de Actualización Fallida

Propiedad	Tipo	Descripción	Desde
bundle	BundleInfo	Se emite cuando falla la instalación de una actualización.	4.0.0

Evento de descarga fallida

Propiedad	Tipo	Descripción	Desde
version	string	Emite cuando una descarga falla.	4.0.0

Evento de aplicación lista

Propiedad	Tipo	Descripción	Desde
bundle	BundleInfo	Emitted when the app is ready to use.	5.2.0
status	string

Disponible para actualización automática

Propiedad	Tipo
available	boolean

Establecer opciones de menú de sacudida

Propiedad	Tipo
enabled	boolean

Habilitado para menú de sacudida

Propiedad	Tipo
enabled	boolean

Alias de tipo

Estado del paquete

pendiente: El paquete está pendiente de ser descargado. ESTABLECER como el siguiente paquete. descargando: El paquete está siendo descargado. success: El paquete ha sido descargado y está listo para ser ESTABLECER como el siguiente paquete. error: El paquete ha fallado al descargarse.

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

Retrasar hasta el siguiente

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

Continúa 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 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.