桌面图标更新时间:2026-06-11 15:39:00
小米已接入快游戏联盟(OVMR)标准,通过新标准进行导出。近期小米小游戏已经停止Cocos导出,为避免影响您的游戏正常打包,请尽快迁移至快游戏联盟标准。
qg.getShortcut
基础信息说明
功能概述:获取全局桌面图标管理对象,通过该对象可查询桌面图标是否已创建,以及创建桌面图标。
| 项目 | 说明 |
| 版本要求 | 框架版本号10301001开始支持本方法 |
| 前提条件 | 本文档的方法适用于小米标准打包的小游戏,仅用于小米平台创建桌面图标的场景,调用前请先通过 qg.getProvider() 判断当前平台,非小米平台请勿调用,否则可能报错 |
| 使用限制 | 多次调用均返回同一全局单例实例,无需重复获取 |
| 相关教程 | 无 |
参数说明
qg.getShortcut() 无需传入参数。
返回值说明
同步返回:Shortcut 对象实例(全局单例)。
Shortcut 对象方法
| 方法名 | 说明 |
| hasInstalled(Object) | 查询桌面图标是否已创建 |
| install(Object) | 创建桌面图标 |
shortcut.hasInstalled(Object)
查询用户设备桌面是否已创建当前快游戏的快捷方式。
| 属性名 | 类型 | 必填 | 说明 |
| success | Function | 否 | 接口调用成功的回调函数。参数:true 已创建,false 未创建 |
| fail | Function | 否 | 接口调用失败的回调函数 |
| complete | Function | 否 | 接口调用结束的回调函数(调用成功、失败都会执行) |
回调结果说明
- success(result):查询成功时触发。result 为布尔值,true 表示已创建桌面图标,false 表示未创建。
- fail(err):调用失败时触发,err 内通常包含 errMsg、errCode。
- complete():调用流程结束都会执行。
shortcut.install(Object)
创建桌面图标,在用户设备桌面添加快游戏快捷方式。
| 属性名 | 类型 | 必填 | 说明 |
| message | String | 否 | 显示在权限弹窗上的说明文字,用于向用户解释创建桌面图标的原因。弹窗文案每行最多 18 个字,最多 3 行 |
| success | Function | 否 | 接口调用成功的回调函数 |
| fail | Function | 否 | 接口调用失败的回调函数 |
| complete | Function | 否 | 接口调用结束的回调函数(调用成功、失败都会执行) |
回调结果说明
- success():宿主完成创建流程,且图标创建成功时触发。
- fail(err):调用失败、参数异常或用户取消/拒绝授权时触发,err 内通常包含 errMsg、errCode。
- complete():调用流程结束都会执行。
失败错误码
| 错误码 | 说明 |
| 201 | 用户拒绝创建。若用户勾选“7天内不再提醒”并点击“取消”,也会返回此错误码;建议保存该状态,避免后续调用时弹窗不再弹出、看似无响应 |
示例代码
查询桌面图标状态并按需创建
const shortcut = qg.getShortcut()
shortcut.hasInstalled({
success: function(res) {
if (res) {
// 已创建桌面图标,可提示"看视频复活"
console.log('桌面图标已创建')
} else {
// 未创建,引导用户"保存桌面复活"
shortcut.install({
//自定义弹窗文案
message: '添加到桌面,下次可快速启动游戏',
success: function() {
console.log('桌面图标创建成功')
},
fail: function(err) {
if (err.errCode === 201) {
// 用户拒绝创建,记录状态避免重复弹窗
console.log('用户拒绝创建桌面图标')
}
console.error('创建桌面图标失败', err)
},
complete: () => {
console.log('创建桌面图标操作结束')
}
})
}
},
fail: function(err) {
console.error('查询桌面图标状态失败', err)
}
})注意事项
- 弹窗文案支持自定义,每行最多 18 个字,最多显示 3 行,填写后请先进行预览,确认显示效果符合预期
- 请勿滥用接口,项目正式上线将进行审核,一经发现滥用行为,将予以驳回
上一篇:rpk导流到apk
下一篇:隐私协议
文档内容是否有帮助?
有帮助
无帮助