search
开发文档
开发文档/小游戏开发/API/平台能力/桌面图标
桌面图标更新时间:2025-12-22 20:01:01

qg.installShortcut

基础信息说明

功能概述:创建桌面图标,在用户设备桌面添加小游戏快捷方式。每次创建都需要用户授权,创建桌面icon前会弹出权限请求弹窗。

项目说明
版本要求框架版本号1030开始支持本方法
前提条件
使用限制每次创建图标到桌面都需要用户授权
相关教程

参数说明

qg.installShortcut(option)

属性名类型必填说明
messageString加桌弹窗的引导文案
successFunction接口调用成功的回调
failFunction接口调用失败的回调函数
completeFunction接口调用结束的回调函数(调用成功、失败都会执行)

返回值说明

通过 success / fail / complete 回调获取

回调结果说明

  • success():完成创建流程,且图标创建成功时触发。
  • fail(err):调用失败、参数异常或用户取消/拒绝授权时触发,err 内通常包含 errMsg、errCode。
  • complete():调用流程结束都会执行。

示例代码

qg.installShortcut({
message: '创建桌面图标,方便下次快速启动游戏',
success: () => {
console.log('桌面图标已创建')
},
fail: err => {
console.error('创建桌面图标失败或用户取消', err)
},
complete: () => {
console.log('创建桌面图标操作结束')
}
})

注意事项

  • 不建议在玩家进入游戏后立即弹出加桌弹窗,建议在通关、结算等合适节点调用。

qg.hasShortcutInstalled

基础信息说明

功能概述:查询用户设备桌面是否已创建当前小游戏的快捷方式。

项目说明
版本要求
前提条件
使用限制
相关教程

参数说明

qg.hasShortcutInstalled(option)

属性名类型必填说明
successFunction接口调用成功的回调函数。参数:true 已创建,false 未创建
failFunction接口调用失败的回调函数
completeFunction接口调用结束的回调函数(调用成功、失败都会执行)

返回值说明

通过 success / fail / complete 回调获取

回调结果说明

  • success(result):查询接口调用成功时触发。result 为布尔值,true 表示已创建桌面图标,false 表示未创建。
  • fail(err):调用失败时触发,err 内通常包含 errMsg、errCode。
  • complete():调用流程结束都会执行。

示例代码

qg.hasShortcutInstalled({
success: function(res) {
// res 为 true 表示已创建,false 表示未创建
if (res) {
console.log('桌面图标已创建')
} else {
console.log('桌面图标未创建')
}
},
fail: function(err) {
console.error('查询桌面图标状态失败', err)
},
complete: function() {
console.log('查询操作结束')
}
})

注意事项

  • 建议在调用 qg.installShortcut() 创建图标前,先通过此接口判断是否已存在,避免重复弹窗打扰用户
上一篇:rpk导流到apk
下一篇:隐私协议
文档内容是否有帮助?
有帮助
无帮助