@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 Updater 插件在您的应用中安装的版本。
isAutoUpdateEnabled	检查是否已启用自动更新功能。
removeAllListeners	移除此插件注册的所有事件监听器。
addListener	监听App下载包事件。在下载开始、下载中以及下载完成时触发一次。该事件将返回下载百分比。
addListener	监听无需更新事件，适用于每次启动App时强制检查更新。
addListener	监听可用更新事件，适用于每次启动App时强制检查更新。
addListener	监听下载完成事件。
addListener	监听破坏性更新事件，当后端标记更新为与当前App不兼容时触发。该事件的payload与旧版 majorAvailable 监听App中的重大更新事件，通知您重大更新是否被禁用。
addListener	监听App中的更新失败事件，通知您更新安装失败的下一次App启动。
addListener	监听App中的设置事件，通知您一个包已成功应用。该事件在JavaScript消费之前在本地保留，因此如果App在您的监听器订阅之前重新加载，则最后一个待处理
addListener	监听App中的设置下一个事件，通知您一个包已排队作为下一个要安装的包。 set __CAPGO_KEEP_0__
addListener	__CAPGO_KEEP_1__
addListener	在 App 中监听下载失败事件，告诉你哪个 bundle 下载失败了。
addListener	在 App 中监听重载事件，告诉你什么时候发生了重载。
addListener	在 App 中监听 app ready 事件，告诉你 app 准备好使用了。这事件在 JavaScript 消费它之前会被原生保留，所以即使监听器在 app 启动过程中较晚添加，也可以在重载后仍然收到事件。
addListener	在 App 中监听 channel 私有事件，触发时尝试设置不允许设备自行分配的 channel。
addListener	在 Android 上监听可伸缩更新状态的变化。
isAutoUpdateAvailable	检查自定义服务器配置是否禁用了自动更新功能（如果禁用了则不可用）。
getNextBundle	获取下一次重载时即将激活的 bundle 的信息。
getFailedUpdate	获取最近一次无法加载的 bundle 的信息。
setShakeMenu	在调试和测试中启用或禁用震动手势菜单。
isShakeMenuEnabled	检查震动手势调试菜单是否当前启用。
setShakeChannelSelector	在运行时启用或禁用震动 channel 选择器。
isShakeChannelSelectorEnabled	检查震动 channel 选择器是否当前启用。
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.