bl.showAddToDesktopGuide(Object object)
基础库 3.8.0 开始支持,端低版本需做兼容处理
iOS 暂不支持
创建添加到桌⾯的按钮,返回⼀个单例对象,⽤户在点击按钮上⾯的添加可以将游戏添加到桌⾯
参数
Object object
属性 | 类型 | 默认值 | 必填 | 说明 |
---|---|---|---|---|
type | String | bar | 否 | 引导组件类型,有效值:bar /barautohide |
content | String | ⼀键添加到我的桌⾯ | 否 | 引导组件文案 |
success | function | 否 | 添加成功的回调函数 | |
fail | function | 否 | 添加失败的回调函数 | |
complete | function | 否 | 接⼝调⽤完成的回调函数(添加成功、失败都会执⾏) |
返回值
success
回调函数
形如 function(res){...}
, 其中:
属性 | 类型 | 描述 |
---|---|---|
res.errCode | String | 成功代码 |
res.errMsg | String | 成功信息 |
fail 回调函数
形如 function(res){...}
, 其中:
属性 | 类型 | 描述 |
---|---|---|
res.errCode | String | 错误代码 |
res.errMsg | String | 错误信息 |
errCode与对应的描述信息:
状态码 | 描述 |
---|---|
1 | 已在桌⾯存在 |
2 | 添加成功 |
3 | 已执⾏添加,状态未知 |
-1 | 调起失败 |
-3 | 取消添加(到时间⾃动取消,⽤户点击取消按钮,界⾯跳转) |
-4 | 添加失败 |
展现形式
一直展示
⽤户点击引导组件旁边的关闭按钮才能关闭,点击添加按钮可直接添加到我的桌⾯。
bl.showAddToDesktopGuide({
type: 'bar',
content: '⼀键添加到我的桌⾯',
success: res => {
console.log('添加成功:', res);
},
fail: err => {
console.log('添加失败:', err);
}
})
⾃动消失
引导组件 3s 后⾃动消失,点击添加按钮可直接添加到我的桌⾯。
bl.showAddToDesktopGuide({
type: 'bar-autohide',
content: '⼀键添加到我的桌⾯',
success: res => {
console.log('添加成功:', res);
},
fail: err => {
console.log('添加失败:', err);
}
})