@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	Set a local runtime update channel for this device. It does not create a dashboard/API device override.
unsetChannel	移除设备的频道分配并返回到默认频道。
getChannel	获取当前分配给本机设备的频道。
listChannels	获取本机设备可自行分配的所有频道列表。
setCustomId	为本机设备设置一个自定义标识符。
getBuiltinVersion	获取内置的 bundle 版本（原生应用内置的版本）。
getDeviceId	获取此设备的唯一、隐私友好的标识符。
getPluginVersion	获取安装在应用中的 Capacitor Updater 插件的版本。
isAutoUpdateEnabled	检查是否已启用自动更新。
removeAllListeners	移除此插件注册的所有事件监听器。
addListener	监听 App 中的 bundle 下载事件。该事件在下载开始、下载中和下载完成时触发。该事件将返回下载进度百分比。
addListener	监听无需更新事件，适用于每次启动应用时强制检查更新。
addListener	监听可用更新事件，适用于每次启动应用时强制检查更新。
addListener	监听下载完成事件。
addListener	监听破坏性更新事件，当后端标记更新为与当前应用不兼容时触发。该事件的 payload 与 legacy listener 相同。 majorAvailable 监听重大更新事件，在应用中让您知道重大更新是否被禁用（通过设置 disableAutoUpdateBreaking）。
addListener	获取内置的 bundle 版本（原生应用内置的版本）
addListener	在 App 中监听更新失败事件，知道下次启动时更新是否安装失败。
addListener	在 App 中监听设置事件，知道哪个 Bundle 已经成功应用。这事件在 JavaScript 消费它之前会原生保留，如果 App 重载之前你的监听器还没有附加，最后一个待处理的事件会在监听器订阅时被传递。 set 在 App 中监听下一个设置事件，知道哪个 Bundle 将作为下一个 Bundle 安装。
addListener	在 App 中监听下载失败事件，知道哪个 Bundle 下载失败。
addListener	在 App 中监听 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 “Keep going from @__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 提供 for the implementation detail in Capacitor Plugins by Capgo, 添加或更新插件 为添加或更新插件的实现细节,以及 Ionic 企业插件替代方案 为 Ionic 企业插件替代方案的产品工作流程