# 添加到桌面
# 判断是否已添加到手机桌面
# 接口说明
用于判断小游戏快捷方式是否已添加到手机桌面上。
sdkInstance.checkShortcut(options);
# 参数说明
参数说明如下表所示：
| 选项 | 类型 | 必填 | 默认值 | 说明 |
|---|---|---|---|---|
| success | function | 否 | -- | 接口调用成功的回调函数 |
| fail | function | 否 | -- | 接口调用失败的回调函数 |
| complete | function | 否 | -- | 接口调用完成的回调函数，成功或失败均会调用 |
# 返回值说明
WARNING
返回值格式：JSON 格式。
| 选项 | 类型 | 说明 |
|---|---|---|
| code | number | 响应状态码，为 0 时表示接口调用成功，其他非 0 状态码均表示接口调用失败 |
| data | object / null | 接口调用成功时返回确认结果，失败时返回 null |
| data.isExist | boolean | 是否已添加到手机桌面上 |
| message | string | 接口调用成功或失败时的相应描述信息 |
# 示例代码
注：示例代码中的参数或选项均为演示数据，仅供参考，谢谢！
//
sdkInstance.checkShortcut({
success: function(response) {
console.log(response.data.isExist); // 是否已添加到手机桌面上：true 表示已添加，false 表示未添加
},
fail: function(error) {
sdkInstance.modal.message(error.message);
},
complete: function(result) {
// do something here...
}
});
# 添加到桌面
# 接口说明
用于将小游戏快捷方式添加到手机桌面上，注意，只有发布上线的小游戏才支持！。
sdkInstance.addShortcut(options);
# 参数说明
参数说明如下表所示：
| 选项 | 类型 | 必填 | 默认值 | 说明 |
|---|---|---|---|---|
| description | string | 否 | -- | 用于向用户解释为什么要创建桌面图标 |
| 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(options);
# 参数说明
参数说明如下表所示：
| 选项 | 类型 | 必填 | 默认值 | 说明 |
|---|---|---|---|---|
| success | function | 否 | -- | 接口调用成功的回调函数 |
| fail | function | 否 | -- | 接口调用失败的回调函数 |
| complete | function | 否 | -- | 接口调用完成的回调函数，成功或失败均会调用 |
# 返回值说明
WARNING
返回值格式：JSON 格式。
| 选项 | 类型 | 说明 |
|---|---|---|
| code | number | 响应状态码，为 0 时表示接口调用成功，其他非 0 状态码均表示接口调用失败 |
| data | bool | 是否从桌面快捷方式启动， true 是 |
| message | string | 接口调用成功或失败时的相应描述信息 |
# 示例代码
注：示例代码中的参数或选项均为演示数据，仅供参考，谢谢！
//
sdkInstance.isLaunchFromShortcut({
success: function(response) {
console.log(response.data); // 是否从桌面快捷方式启动：true 表示是，false 表示否
},
fail: function(error) {
sdkInstance.modal.message(error.message);
},
complete: function(result) {
// do something here...
}
});