# 添加到桌面

# 判断有无桌面快捷方式权限

# 接口说明

用于判断有无桌面快捷方式权限。注意：支付宝小游戏的 checkShortcut 接口用于判断有无桌面快捷方式权限，而抖音、快手等其他渠道小游戏内的该接口则是用于判断小游戏快捷方式是否已添加到手机桌面上，含义不同。

若调用该接口检测结果为没有权限，可调用 sdkInstance.showAuthGuide(options)（入参 authType 传 "SHORTCUT"）接口引导用户开启创建桌面快捷方式的权限。

sdkInstance.checkShortcut(options);

最低基础库版本要求

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

# 参数说明

参数说明如下表所示：

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

# 返回值说明

WARNING

返回值格式：JSON 格式。

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

# 示例代码

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

// 当用户的客户端基础库版本过低时，调用此接口将直接触发失败回调函数，并在正式版环境下于控制台输出错误提示（非正式版环境下，以弹窗形式展示）
sdkInstance.checkShortcut({
  success: function(response) {
    // 是否有添加桌面快捷方式的权：true 表示有权限，false 表示无权限
    console.log(response.data.authStatus);

    // 若无权限，引导用户开启创建桌面快捷方式的权限
    if (!response.data.authStatus) {
      sdkInstance.showAuthGuide({
        authType: "SHORTCUT",
        success: function(res) {
          console.log(res);
        },
        fail: function(err) {
          sdkInstance.modal.message(err.message);
        },
        complete: function(res) {
          // do something here...
        }
      });
    }
  },
  fail: function(error) {
    sdkInstance.modal.message(error.message);
  },
  complete: function(result) {
    // do something here...
  }
});

# 添加到桌面

# 接口说明

用于将小游戏快捷方式添加到手机桌面上；建议先调用 sdkInstance.checkShortcut(options) 接口判断有无桌面快捷方式权限后再调用此接口。

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...
  }
});

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

# 接口说明

用于判断小游戏是否从桌面快捷方式启动。

sdkInstance.isLaunchFromShortcut();

# 示例代码

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

const bool = sdkInstance.isLaunchFromShortcut(); // 返回 true 或 false

# 引导用户开启桌面快捷方式权限

# 接口说明

用于引导用户开启创建桌面快捷方式的权限；若调用 sdkInstance.checkShortcut(options) 接口检测结果为没有权限，可调用此接口引导用户开启权限。

sdkInstance.showAuthGuide(options);

最低基础库版本要求

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

# 参数说明

参数说明如下表所示：

选项	类型	必填	默认值	说明
authType	string	是	--	权限类型，固定传入 `"SHORTCUT"`
success	function	否	--	接口调用成功的回调函数
fail	function	否	--	接口调用失败的回调函数
complete	function	否	--	接口调用完成的回调函数，成功或失败均会调用

# 返回值说明

WARNING

返回值格式：JSON 格式。

选项	类型	说明
code	number	响应状态码，为 `0` 时表示接口调用成功，其他非 `0` 状态码均表示接口调用失败
data	object / null	接口调用成功时返回操作结果，接口调用失败时返回 `null`
data.shown	boolean	是否已显示引导授权弹框，`true` 表示已显示，`false` 表示未显示
message	string	接口调用成功或失败时的相应描述信息

# 示例代码

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

// 当用户客户端基础库版本过低时，调用此接口将直接触发失败回调函数，并在正式版环境下于控制台输出错误提示（非正式版环境下，以弹窗形式展示）
sdkInstance.showAuthGuide({
  authType: "SHORTCUT",
  success: function(response) {
    // 是否已显示引导授权弹框：true 表示已显示，false 表示未显示
    console.log(response.data.shown);
  },
  fail: function(error) {
    sdkInstance.modal.message(error.message);
  },
  complete: function(result) {
    // do something here...
  }
});

← 添加到首页分享 →