Skip to main content
Version: 3.x

UpdateManager

UpdateManager 对象,用来管理更新,可通过 Taro.getUpdateManager 接口获取实例。

Tips

  • 微信开发者工具上可以通过「编译模式」下的「下次编译模拟更新」开关来调试
  • 小程序开发版/体验版没有「版本」概念,所以无法在开发版/体验版上测试更版本更新情况

支持情况:

参考文档

方法

applyUpdate

强制小程序重启并使用新版本。在小程序新版本下载完成后(即收到 onUpdateReady 回调)调用。

支持情况:

参考文档

() => void

onCheckForUpdate

监听向微信后台请求检查更新结果事件。微信在小程序冷启动时自动检查更新,不需由开发者主动触发。

支持情况:

参考文档

(callback: OnCheckForUpdateCallback) => void
参数类型说明
callbackOnCheckForUpdateCallback向微信后台请求检查更新结果事件的回调函数

onUpdateReady

监听小程序有版本更新事件。客户端主动触发下载(无需开发者触发),下载成功后回调

支持情况:

参考文档

(callback: (res: TaroGeneral.CallbackResult) => void) => void
参数类型说明
callback(res: TaroGeneral.CallbackResult) => void小程序有版本更新事件的回调函数

onUpdateFailed

监听小程序更新失败事件。小程序有新版本,客户端主动触发下载(无需开发者触发),下载失败(可能是网络原因等)后回调

支持情况:

参考文档

(callback: (res: TaroGeneral.CallbackResult) => void) => void
参数类型说明
callback(res: TaroGeneral.CallbackResult) => void小程序更新失败事件的回调函数

参数

OnCheckForUpdateCallback

向微信后台请求检查更新结果事件的回调函数

(result: OnCheckForUpdateResult) => void
参数类型
resultOnCheckForUpdateResult

OnCheckForUpdateResult

参数类型说明
hasUpdateboolean是否有新版本

示例代码

const updateManager = Taro.getUpdateManager()

updateManager.onCheckForUpdate(function (res) {
// 请求完新版本信息的回调
console.log(res.hasUpdate)
})

updateManager.onUpdateReady(function () {
wx.showModal({
title: '更新提示',
content: '新版本已经准备好,是否重启应用?',
success: function (res) {
if (res.confirm) {
// 新的版本已经下载好,调用 applyUpdate 应用新版本并重启
updateManager.applyUpdate()
}
}
})
})

updateManager.onUpdateFailed(function () {
// 新版本下载失败
})

API 支持度

API微信小程序H5React Native
UpdateManager✔️
UpdateManager.applyUpdate✔️
UpdateManager.onCheckForUpdate✔️
UpdateManager.onUpdateReady✔️
UpdateManager.onUpdateFailed✔️