更新更新时间:2025-12-19 10:45:00
qg.getUpdateManager
基础信息说明
功能概述:获取全局唯一的版本更新管理器,用于管理小游戏更新
| 项目 | 说明 |
| 版本要求 | 框架版本号 1060+ 开始支持本方法 |
| 前提条件 | - |
| 使用限制 | - |
| 相关教程 | - |
参数说明
无
返回值
| 属性名 | 类型 | 说明 |
| updateManager | UpdateManager | UpdateManager 对象,用于管理小游戏更新 |
UpdateManager 对象方法
| 方法名 | 类型 | 说明 |
| applyUpdate() | Function | 主动触发应用新版本的同步方法,并不产生回调,强制小游戏重启并使用新版本。在小游戏新版本下载完成后(即收到 onUpdateReady 回调)调用 |
| onCheckForUpdate(callback) | Function | 监听请求检查更新结果事件。在程序冷启动时自动检查更新,不需由开发者主动触发 |
| onUpdateReady(callback) | Function | 监听版本更新事件。客户端主动触发下载(无需开发者触发),下载成功后回调 |
| onUpdateFailed(callback) | Function | 监听小游戏更新失败事件。小游戏有新版本,客户端主动触发下载(无需开发者触发),下载失败(可能是网络原因等)后回调 |
回调结果说明
回调均为异步事件回调。onCheckForUpdate、onUpdateReady、onUpdateFailed 方法用于注册回调函数,这些回调函数会在对应的异步事件发生时被触发,而不是在注册时立即执行。
UpdateManager 的回调均由底层 system.appupdate 模块在异步事件发生时触发。回调的触发时机如下:
onCheckForUpdate:程序冷启动时自动检查更新,检查完成后触发onUpdateReady:检测到新版本并下载成功后触发onUpdateFailed:检测到新版本但下载失败后触发
回调成功
onCheckForUpdate 回调
| 属性名 | 类型 | 说明 |
| hasUpdate | Boolean | 是否有新版本可用 |
// 获取更新管理器
const updateManager = qg.getUpdateManager()
// 监听检查更新结果
updateManager.onCheckForUpdate((res) => {
if (res.hasUpdate) {
console.log('发现新版本')
} else {
console.log('当前已是最新版本')
}
})
// 监听更新下载完成
updateManager.onUpdateReady(() => {
console.log('新版本下载完成')
// 应用新版本
updateManager.applyUpdate()
})
// 监听更新失败
updateManager.onUpdateFailed(() => {
console.log('更新失败,可能是网络原因')
})注意事项
- getUpdateManager() 返回的是全局唯一的 UpdateManager 实例,多次调用会返回同一个实例
- 更新检查在程序冷启动时自动进行,无需开发者主动触发
- 客户端会自动触发下载,无需开发者调用下载方法
- 只有在收到 onUpdateReady 回调后,才能调用 applyUpdate() 方法应用新版本
上一篇:触摸事件
下一篇:厂商标识
文档内容是否有帮助?
有帮助
无帮助