@capgo/capacitor-updater

也适用于 Cordova 和 Electron

Capgo 的实时更新不仅限于 Capacitor。使用相同的后端和 CLI 与兄弟客户端插件：

cordova 更新器 Cordova iOS 7+ 和 Android 13+ 的 OTA

Electron更新器 Desktop live updates with the same API.

概述

Live update for capacitor apps.

核心功能

• notifyAppReady - 通知本机层JavaScript初始化成功
• setUpdateUrl - 动态在运行时设置应用更新URL
• setStatsUrl - 动态在运行时设置应用统计URL
• setChannelUrl - 动态在运行时设置应用频道URL

Public API

方法	描述
notifyAppReady	通知本机层JavaScript已成功初始化。
setUpdateUrl	动态在运行时为应用程序设置更新URL。
setStatsUrl	动态在运行时为应用程序设置统计URL。
setChannelUrl	动态在运行时为应用程序设置频道URL。
download	从提供的URL下载一个新包，稍后安装。
next	设置下一次在应用程序后台或重启时激活的包。
set	设置当前包并立即重新加载应用程序。
delete	从本地存储中删除一个包以释放磁盘空间。
setBundleError	在手动更新模式下手动标记一个包为失败/错误。
list	获取本地下载的所有应用程序包。
reset	重置应用程序到已知的良好包。
current	获取当前活动包的信息。
reload	手动重新加载应用程序以应用待处理的更新。
setMultiDelay	配置必须在应用待处理更新之前满足的条件。
cancelDelay	取消所有延迟条件并立即应用待处理的更新。
getLatest	检查更新服务器以获取最新可用的包版本。
setChannel	为本地设备设置一个运行时更新通道。它不会创建一个仪表板/设备API覆盖。
unsetChannel	移除设备的通道分配并返回到默认通道。
getChannel	获取当前分配给本地设备的通道。
listChannels	获取本地设备可自行分配的所有通道列表。
setCustomId	为本地设备设置一个自定义标识符。
getBuiltinVersion	获取内置的bundle版本（原生应用中内置的版本）。
getDeviceId	获取此设备的唯一、隐私友好的标识符。
getPluginVersion	获取已安装在应用中的Capacitor Updater插件的版本。
isAutoUpdateEnabled	检查是否已启用自动更新。
removeAllListeners	移除此插件注册的所有事件监听器。
addListener	监听App中的bundle下载事件。触发一次下载开始、下载中和下载完成时。该事件将返回下载百分比。
addListener	监听无需更新事件，适用于每次启动应用时都强制检查更新。
addListener	监听可用更新事件，适用于每次启动应用时都强制检查更新。
addListener	监听下载完成事件。
addListener	监听破坏性更新事件，当后端标记更新为与当前应用不兼容时触发。该事件的载荷与旧版事件相同。 majorAvailable 监听重大更新事件，在应用中让您知道重大更新是否被禁用（通过设置disableAutoUpdateBreaking）。
addListener	获取内置的bundle版本（原生应用中内置的版本）
addListener	在 App 中监听更新失败事件，知道下次启动时更新是否安装失败。
addListener	在 App 中监听设置事件，知道哪个 Bundle 已经成功应用。这事件在 JavaScript 消费前会原生保留，如果 App 重载之前你的监听器还没有附加，最后一个待处理事件会在监听器订阅后被传递。 set 在 App 中监听设置下一个事件，知道哪个 Bundle 将作为下一个 Bundle 安装。
addListener	在 App 中监听下载失败事件，知道哪个 Bundle 下载失败。
addListener	在 App 中监听重载事件，知道 App 是否重载。
addListener	在 App 中监听 App 就绪事件，知道 App 是否准备就绪。这事件在 JavaScript 消费前会原生保留，如果监听器附加在 App 启动后，事件仍然可以在 App 重载后被传递。
addListener	在 App 中监听私有频道事件，尝试设置不允许设备自行分配的频道时触发。
addListener	在 Android 上监听灵活更新状态的变化。
addListener	检查自定义服务器配置是否禁用了自动更新功能（是否可用）。
isAutoUpdateAvailable	获取下次重载时将激活的 Bundle 的信息。
getNextBundle	获取最近一次无法加载的 Bundle 的信息。
getFailedUpdate	__CAPGO_KEEP_0__
setShakeMenu	启用或禁用shake手势菜单用于调试和测试。
isShakeMenuEnabled	检查是否启用了shake手势调试菜单。
setShakeChannelSelector	启用或禁用shake频道选择器在运行时。
isShakeChannelSelectorEnabled	检查是否启用了shake频道选择器。
getAppId	获取当前配置的App ID用于更新服务器通信。
setAppId	动态更改用于更新服务器通信的App ID。
getAppUpdateInfo	获取关于应用在App Store或Play Store中的可用性信息。
openAppStore	在App Store或Play Store中打开应用的页面。
performImmediateUpdate	在Android上立即进行应用内更新。
startFlexibleUpdate	在Android上启动灵活的应用内更新。
completeFlexibleUpdate	在Android上完成灵活的应用内更新。

真实数据源

This reference is synced from src/definitions.ts in capacitor-updater.

Keep going from @capgo/capacitor-updater

Section titled “从@__CAPGO_KEEP_0__/__CAPGO_KEEP_1__-updater继续” @capgo/capacitor-updater @__CAPGO_KEEP_0__/__CAPGO_KEEP_1__-updater Using @capgo/capacitor-updater 使用@capgo/capacitor-updater 为原生能力在使用@Capgo/__CAPGO_KEEP_1__-updater中使用的能力中使用Capgo插件目录 为 Capgo 产品工作流程中的插件目录 Capacitor 由 Capgo 提供的插件 为 Capacitor 插件由 Capgo 实现的细节 添加或更新插件 为添加或更新插件的实现细节,并 Ionic 企业插件替代品 为 Ionic 企业插件替代品中的产品工作流程