抖音开放平台Logo
开发者文档
控制台
  • API 概览
  • 开放能力
  • 登录
  • 社交转发裂变
  • 用户信息及授权
  • 小游戏收藏
  • 群聊
  • 关注
  • 游戏互推组件
  • 添加到桌面
  • tt.addShortcut
  • tt.checkShortcut
  • 游戏排行榜
  • 数据分析
  • 视频拍摄器
  • 订阅消息
  • 关系链
  • 客服能力
  • 侧边栏能力
  • 推荐流直出游戏能力
  • 基础
  • 渲染
  • 设备
  • 文件
  • 位置
  • 媒体
  • 网络
  • 游戏转发分享
  • 实时语音
  • 数据缓存
  • 系统
  • 广告
  • 界面
  • 支付
  • Worker
  • 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

    错误码

    errorCodeerrMsgerrorType说明最低支持版本
    999987feature is not supported in appD
    2.46.0
    999989system auth denyU
    2.46.0
    105202get results timed outF
    小游戏框架内部错误,有需要请创建工单咨询
    2.46.0
    999990update denyU
    2.46.0
    105201add shortcut failF
    小游戏框架内部错误,有需要请创建工单咨询
    2.46.0
    999995user cancelU
    2.46.0
    999993internal errorF
    小游戏框架内部错误,有需要请创建工单咨询
    2.46.0
    105201must be invoked by user gestureD
    2.46.0

    代码示例

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