swan.insertBookshelf
基础库 3.190.1 开始支持,低版本需做兼容处理。
解释:添加内容到宿主书架(需宿主支持书架入口)。
Web 态说明:Web 态不支持添加内容到宿主书架,调用会执行失败回调。
方法参数
Object object
object 参数说明
参数名 | 类型 | 是否必填 | 默认值 | 说明 |
---|---|---|---|---|
category | String | 是 | - | 添加的内容分类:article(专栏模板)、doc(文档模板)、cartoon(动漫模板)、av(影音模板),并跳转到对应的分类。详细模板说明请参见书架同步功能介绍 |
contentIds | Array.<string> | 是 | - | 要添加到书架内容的 id,支持传多个,最多 100 条;注释:contentId 为内容 id,内容的唯一标识,自定义,最长 22 字符(不能含有空格、中文字符) |
success | Function | 否 | - | 接口调用成功的回调函数 |
fail | Function | 否 | - | 接口调用失败的回调函数 |
complete | Function | 否 | - | 接口调用结束的回调函数(调用成功、失败都会执行) |
success 返回参数说明
参数名 | 类型 | 说明 |
---|---|---|
list | Array.<object> | 添加到书架的结果列表 |
list 参数说明
参数 | 类型 | 说明 |
---|---|---|
contentId | String | 内容的唯一标识 |
status | Number | 添加状态:值为 0 时是失败,为 1 时是成功 |
msg | String | 添加信息 |
代码示例
- JS
swan.insertBookshelf({
category: 'doc',
contentIds: ['test1', 'test2'],
success(res) {
swan.showModal({
title: 'success',
content: JSON.stringify(res)
});
},
fail(err) {
swan.showModal({
title: 'fail',
content: JSON.stringify(err)
});
}
})