抖音开放平台Logo
控制台

tt.checkShortcut
收藏
我的收藏

基础库 2.46.0 开始支持本方法,这是一个异步方法。

检查小游戏快捷方式是否已添加到手机桌面上。

前提条件
业务背景
使用限制
仅在Android上支持
注意事项
相关教程

语法

tt.checkShortcut(options)

参数说明

options 为 object 类型,属性如下:

属性名类型默认值必填说明最低支持版本
successfunction
接口调用成功的回调函数
2.46.0
failfunction
接口调用失败的回调函数
2.46.0
completefunction
接口调用结束的回调函数(调用成功、失败都会执行)
2.46.0

回调成功

object 类型,属性如下:

属性名类型说明最低支持版本
statusobject
桌面快捷方式状态
2.46.0
errMsgstring
"checkShortcut:ok"
2.46.0

status 类型说明

object 类型,属性如下:

属性名类型说明最低支持版本
existboolean
是否已经添加了桌面快捷方式
2.46.0
needUpdateboolean
是否需要更新快捷方式
2.46.0

回调失败

object 类型,属性如下:

属性名类型说明最低支持版本
errMsgstring
"checkShortcut:fail " + 错误详情
2.46.0

代码示例

tt.checkShortcut({
  success(res) {
    console.log("检查快捷方式", res.status);
  },
  fail(res) {
    console.log("检查快捷方式失败", res.errMsg);
  },
});