抖音开放平台Logo
开发者文档
“/”唤起搜索
控制台
  • JavaScript API
  • API 概览
  • 基础
  • 界面
  • 渲染
  • 数据缓存
  • 文件
  • 位置
  • 设备
  • 网络
  • 媒体
  • Worker
  • 数据分析
  • 支付
  • 广告
  • 开放能力
  • 登录
  • 侧边栏能力
  • 设置
  • 授权
  • 添加到桌面
  • tt.addShortcut
  • tt.checkShortcut
  • 游戏排行榜
  • 订阅消息
  • 开放数据域
  • 开放数据
  • 开放数据分组
  • 客服消息
  • 直播能力
  • 推荐流直出游戏能力
  • 社交互动能力
  • 公会群能力
  • 意见反馈
  • 游戏站
  • 转发
  • 关注
  • 群聊
  • 收藏
  • C# API
  • 基础库 2.46.0 开始支持本方法,这是一个异步方法。

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

    前提条件无
    业务背景无
    使用限制
    目前仅支持抖音,抖音极速版和抖音火山,请在其它 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

    错误码

    errNoerrMsg说明最低支持版本
    10301feature is not supported in app
    2.46.0
    21301system auth deny
    2.46.0
    21302get results timed out
    小游戏框架内部错误,有需要请创建工单咨询
    2.46.0
    21304update deny
    2.46.0
    21303add shortcut fail
    小游戏框架内部错误,有需要请创建工单咨询
    2.46.0
    21305user cancel
    2.46.0
    20000internal error
    小游戏框架内部错误,有需要请创建工单咨询
    2.46.0
    21500must be invoked by user gesture
    2.46.0

    扫码体验

    请使用字节宿主APP扫码

    代码示例

    开发者工具中预览

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