淘宝开放平台

登录
文档中心 > API

API

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

更新时间：2025/05/23 访问次数：37

功能描述

该方法用于查询当前小游戏是否已经添加到用户的手机桌面上。是一个异步方法。

注意：该方法只适用于高性能模式，请先确认完成高性能模式接入。

示例

const sdk = my.tb.getInteractiveSDK();
sdk.checkShortcut({
  success({ status, msg }) {
    console.log('查询成功，结果信息', msg)
    if (status.support) {
      console.log('当前环境支持添加桌面快捷方式')
    }
    if (status.exist) {
      console.log('该用户已添加小游戏的桌面快捷方式')
    }
  },
  fail(err) {
    console.log('查询失败，错误原因：', err)
  }
});

入参

对象，属性如下

属性名

类型

是否必填

说明

success

function

否

接口调用成功的回调

fail

function

否

接口调用失败的回调

complete

function

否

接口调用结束的回调（无论成功、失败都会执行）

回调成功参数说明

字段

类型

说明

msg

string

检查结果详细信息

status

status.support

boolean

是否支持添加，true为支持

status.exist

boolean

是否已存在，true为已存在，该参数只会在android系统下返回

场景示例

调用checkShortcut，返回结果中，msg是检查结果详细信息，status是一个对象，support: boolean表示是否支持添加，支持添加=true。

FAQ

关于此文档暂时还没有FAQ
有用(0) 我要提问
返回
顶部