swan.insertBookshelf

基础库 3.190.1 开始支持,低版本需做兼容处理。

解释:添加内容到宿主书架(需宿主支持书架入口)。
Web 态说明:Web 态不支持添加内容到宿主书架,调用会执行失败回调。

方法参数

Object object

object 参数说明

参数名类型是否必填默认值说明
categoryString-添加的内容分类:article(专栏模板)、doc(文档模板)、cartoon(动漫模板)、av(影音模板),并跳转到对应的分类。详细模板说明请参见书架同步功能介绍
contentIdsArray.<string>-要添加到书架内容的 id,支持传多个,最多 100 条;注释:contentId 为内容 id,内容的唯一标识,自定义,最长 22 字符(不能含有空格、中文字符)
successFunction-接口调用成功的回调函数
failFunction-接口调用失败的回调函数
completeFunction-接口调用结束的回调函数(调用成功、失败都会执行)

success 返回参数说明

参数名类型说明
listArray.<object>添加到书架的结果列表

list 参数说明

参数类型说明
contentIdString内容的唯一标识
statusNumber添加状态:值为 0 时是失败,为 1 时是成功
msgString添加信息

代码示例

  • JS
  1. swan.insertBookshelf({
  2. category: 'doc',
  3. contentIds: ['test1', 'test2'],
  4. success(res) {
  5. swan.showModal({
  6. title: 'success',
  7. content: JSON.stringify(res)
  8. });
  9. },
  10. fail(err) {
  11. swan.showModal({
  12. title: 'fail',
  13. content: JSON.stringify(err)
  14. });
  15. }
  16. })