@capgo/capacitor-updater

概述

capacitor 应用的实时更新。

核心功能

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

API

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

真实来源

本参考资料是从源头同步的 src/definitions.ts 在 capacitor-updater.

从 @capgo/capacitor-updater 中继续

如果您正在使用 @capgo/capacitor-updater 来规划原生插件工作，连接它到 使用 @capgo/capacitor-updater 来规划原生能力在使用 @capgo/capacitor-updater 中 Capgo 插件目录 来规划产品工作流程在 Capgo 插件目录中 Capacitor 由 Capgo 提供的插件 for the implementation detail in Capacitor Plugins by Capgo, 添加或更新插件 关于在添加或更新插件中实现的细节 Ionic 企业插件替代品 关于Ionic 企业插件替代品的产品工作流程