抖音开放平台Logo
控制台

tt.addShortcut
收藏
我的收藏

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

可以将小游戏快捷方式添加到手机桌面上。

前提条件
业务背景
使用限制
目前仅支持抖音和抖 lite,请在其它 app 做屏蔽。
注意事项
该 API 必须要由用户点击触发,也就是只能在tt.onTouchEnd的回调里面同步调用该 API。
相关教程

语法

tt.addShortcut(options)

参数说明

options 为 object 类型,属性如下:

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

回调成功

object 类型,属性如下:

属性名类型说明最低支持版本
errMsgstring
"addShortcut:ok"
2.46.0

回调失败

object 类型,属性如下:

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

代码示例

tt.addShortcut({
  success() {
    console.log("添加桌面成功");
  },
  fail(err) {
    console.log("添加桌面失败", err.errMsg);
  },
});