# 添加到桌面（选接）

# 判断是否已添加到手机桌面

# 接口说明

用于判断小游戏快捷方式是否已添加到手机桌面上（2.1.0 版本新增）。

sdkInstance.checkShortcut(options);

最低基础库版本要求

当用户客户端基础库版本过低时，调用 sdkInstance.checkShortcut(options) 接口将直接触发失败回调函数，并在正式版环境下于控制台输出错误提示（非正式版环境下，以弹窗形式展示）！

# 参数说明

参数说明如下表所示：

选项	类型	必填	默认值	说明
success	function	否	--	接口调用成功的回调函数
fail	function	否	--	接口调用失败的回调函数
complete	function	否	--	接口调用完成的回调函数，成功或失败均会调用

# 返回值说明

WARNING

返回值格式：JSON 格式。

选项	类型	说明
code	number	响应状态码，为 `0` 时表示接口调用成功，其他非 `0` 状态码均表示接口调用失败
data	object / null	接口调用成功时返回确认结果，接口调用失败时返回 `null`
data.status	object	桌面快捷方式状态
data.status.exist	boolean	是否已添加到手机桌面上
message	string	接口调用成功或失败时的相应描述信息

# 示例代码

注：示例代码中的参数或选项均为演示数据，仅供参考，谢谢！

// 当用户客户端基础库版本过低时，调用此接口将直接触发失败回调函数，并在正式版环境下于控制台输出错误提示（非正式版环境下，以弹窗形式展示）
sdkInstance.checkShortcut({
  success: function(response) {
    console.log(response.data.status.exist); // 是否已添加到手机桌面上：true 表示已添加，false 表示未添加
  },
  fail: function(error) {
    sdkInstance.modal.message(error.message);
  },
  complete: function(result) {
    // do something here...
  }
});

# 添加到桌面

# 接口说明

用于将小游戏快捷方式添加到手机桌面上，目前仅支持快手或快手极速版，请在其它app中做屏蔽（2.1.0 版本新增）。

sdkInstance.addShortcut(options);

最低基础库版本要求

当用户客户端基础库版本过低时，调用 sdkInstance.addShortcut(options) 接口将中断用户当前操作并弹出升级提示，不会报错！

# 参数说明

参数说明如下表所示：

选项	类型	必填	默认值	说明
success	function	否	--	接口调用成功的回调函数
fail	function	否	--	接口调用失败的回调函数
complete	function	否	--	接口调用完成的回调函数，成功或失败均会调用

# 返回值说明

WARNING

返回值格式：JSON 格式。

选项	类型	说明
code	number	响应状态码，为 `0` 时表示接口调用成功，其他非 `0` 状态码均表示接口调用失败
data	object / null	接口调用失败时返回 `null`
message	string	接口调用成功或失败时的相应描述信息

# 示例代码

注：示例代码中的参数或选项均为演示数据，仅供参考，谢谢！

// 当用户客户端基础库版本过低时，调用此接口将中断用户当前操作并弹出升级提示，不会报错！
sdkInstance.addShortcut({
  success: function(response) {
    console.log(response);
  },
  fail: function(error) {
    sdkInstance.modal.message(error.message);
  },
  complete: function(result) {
    // do something here...
  }
});

# 是否从桌面快捷方式启动

# 接口说明

用于判断小游戏是否从桌面快捷方式启动（2.1.0 版本新增）。

sdkInstance.isLaunchFromShortcut();

最低基础库版本要求

当用户客户端基础库版本过低时，调用 sdkInstance.isLaunchFromShortcut() 接口将直接返回 false，并在正式版环境下于控制台输出错误提示（非正式版环境下，以弹窗形式展示）！

# 示例代码

注：示例代码中的参数或选项均为演示数据，仅供参考，谢谢！

// 当用户客户端基础库版本过低时，调用此接口将直接返回false，并在正式版环境下于控制台输出错误提示（非正式版环境下，以弹窗形式展示）
const bool = sdkInstance.isLaunchFromShortcut(); // 返回 true 或 false

← 侧边栏复访能力分享 →