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

    错误码

    errorCodeerrMsgerrorType说明最低支持版本
    999987feature is not supported in appD
    2.46.0
    100601check shortcut failF
    小游戏框架内部错误,有需要请创建工单咨询
    2.46.0
    999993internal errorF
    小游戏框架内部错误,有需要请创建工单咨询
    2.46.0
    999988context environment errorD
    2.46.0

    代码示例

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