Skip to main content
Version: 3.x

Taro.insertBookshelf(option)

添加内容到宿主书架

支持情况:

百度小程序: (需宿主支持书架入口)

参考文档

类型

(option: Option) => void

参数

参数类型
optionOption

Option

参数类型必填说明
categorystring添加的内容分类
contentIdsstring[]要添加到书架内容的 id,支持传多个,最多 100 条;注释:contentId 为内容 id,内容的唯一标识,自定义,最长 22 字符(不能含有空格、中文字符)
complete(res: TaroGeneral.CallbackResult) => void接口调用结束的回调函数(调用成功、失败都会执行)
fail(res: TaroGeneral.CallbackResult) => void接口调用失败的回调函数
success(res: SuccessCallbackResult) => void接口调用成功的回调函数

Category

参数说明
article专栏模板
doc文档模板
cartoon动漫模板
av影音模板

SuccessCallbackResult

参数类型说明
listIListItem[]添加到书架的结果列表

IListItem

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

Status

参数说明
0失败
1成功

示例代码

Taro.insertBookshelf({
category: 'doc',
contentIds: ['test1', 'test2'],
success(res) {
Taro.showModal({
title: 'success',
content: JSON.stringify(res)
})
},
fail(err) {
Taro.showModal({
title: 'fail',
content: JSON.stringify(err)
})
}
})