bl.internal.addToDesktop(Object object)
基础库版本 >=
3.27.0支持，低版本做兼容处理
通过指定参数创建桌面快捷方式，用户可以通过点击桌面快捷唤起配置对应的小程序页面。
参数
Object object
| 属性 | 类型 | 默认值 | 必填 | 说明 | 版本 |
|---|---|---|---|---|---|
| name | string | 否 | 桌面快捷方式的名称，最长 24 个字符，不区分中英文，默认为小程序名称 | 3.27.0 | |
| image | string | 否 | 桌面快捷方式图标地址， 默认为小程序图标 ，仅支持网络图片 | 3.27.0 | |
| url | string | 否 | 桌面快捷方式对应的小程序路径，默认为小程序首页，路径后可以带参数。参数与路径之间使用 ? 分隔，参数键与参数值用 = 相连，不同参数用 & 分隔；如 path?key=value&key2=value2 | 3.27.0 | |
| success | function | 否 | 添加成功的回调函数 | 3.27.0 | |
| fail | function | 否 | 添加失败的回调函数 | 3.27.0 | |
| complete | function | 否 | 接⼝调⽤完成的回调函数（添加成功、失败都会执⾏） | 3.27.0 |
fail 回调函数
object.res
| 属性 | 类型 | 描述 |
|---|---|---|
| errCode | string | 错误代码 |
| errMsg | string | 错误信息 |
errCode 合法值
| 状态码 | 描述 |
|---|---|
| 1 | 已在桌⾯存在 (仅 Android) |
| 2 | 添加成功 (仅 Android) |
| 3 | 已执⾏添加，状态未知 |
| -1 | 调起失败 (仅 Android) |
| -4 | 添加失败 (仅 Android) |
| -5 | 参数填写错误 |
示例代码
bl.internal.addToDesktop({
name: '测试小程序签到',
image: 'https://just/for/test.png',
url: '/sign-in?open-from=shortcut&ts=xxx',
success() {
console.log('添加快捷方式成功');
},
fail(res) {
console.log('添加快捷方式失败', res);
}
});