有关此资源的方法列表,请参阅本页结尾。
资源表示
Bundle指的是书的封面。用户可以通过以下3种方式创建一本书:
- 创建一个“书封面”(也可理解为一本多章节书),新创建的书封面是没有章节的,可以在封面下添加多个章节(如2)。
- 创建新章节在书封面下。
- 也可单独创建一个章节(理解为一本单章节书),该新建的单章节书也会附带一个书封面(bundle)。
Note: 单章节书下不能新增章节。
Note: 无论是单章节书还是多章节书,有且仅有一个书封面(bundle)。
{
"category": Category,
"language": string,
"id": integer,
"type": enum,
"status": enum,
"is_multi_chapter": boolean,
"title": string,
"summary": string,
"create_time": string,
"last_modified": string,
"delete_time": string,
"user_id": integer,
"statistical": {
"age": nested object,
"education": nested object,
"industry": nested object,
"location": nested object,
},
"viewers_count": integer,
"cover_image": string,
"cover_images": {
"path": string,
"sizes": {
"cover_sm": {
"width": integer,
"height": integer,
"path": string
}
},
},
"apply_scenes": list,
"sn": string,
"original": integer,
"first_original": integer,
"copy_creator": integer
}
Property name | Value | Description | Notes |
---|---|---|---|
id | integer | 书的ID | Primary Key |
category | nested object | 书的分类 | Dimzou.category |
language | string | 书的语言 | Choices.LanguageLocale |
type | enum | 书的类型。有源版本的书和翻译版本的书。 | Bundle.Type |
status | enum | 书的状态。 | Bundle.Status |
is_multi_chapter | boolean | 是否是多章节 | |
title | string | 书的标题 | 纯文本 |
summary | string | 书的摘要 | 纯文本 |
create_time | string | 创建时间 | |
last_modified | string | 最后修改时间 | |
delete_time | string | 删除时间 | 没删除为null |
user_id | integer | 用户uid | |
statistical | nested object | 该用户创建的书籍的读者的阅读统计信息 | |
statistical.age[] | list | 读者年龄 | |
statistical.education[] | list | 读者的教育背景 | |
statistical.industry[] | list | 读者的从事行业 | |
statistical.location[] | list | 读者的所在区域 | |
viewers_count | integer | 读者总数量 | |
cover_image | string | 书的封面图 | |
cover_images | nested object | 书的封面图的缩略图 | |
cover_images.path | string | 封面图原url | |
cover_images.sizes | nested object | 缩略图的尺寸 | |
cover_images.sizes.{size}.path | string | 缩略图的url | |
apply_scenes[] | list | 书的应用场景 | User.ApplyScenes |
sn | string | 书的sn号,唯一 | 新创建书时系统自动生成 |
original | integer | 原本的bundle id | 在副本中用来记录原本的bundle id |
first_original | integer | 最初始的原本bundle id | 在副本中用来记录最初始的原本的bundle id |
copy_creator | integer | 副本的创建人 | 在副本中用来记录该副本的创建人。 User.Profile |
latest_version_bundle_id | bundle id | 同一个祖先的所有相同状态bundle里的最新版本id | 目前只有部分接口(如 target_user_related_draft user_related_draft user_created_draft)会返回这个属性。 不同状态分开计算,所以已出版和草稿是分开的。 |
Methods
create
创建一本书 / 翻译一本已出版的书。
update
更新该本书的属性。
delete
删除该本书。
list
返回用户的书的列表。
get
返回指定的书。
invitation
返回该本书下该章节的邀请码。
verifyInvitation
验证该章节的邀请码。
markShared
标记该reword被分享过。
nodeDetail
返回该章节的简要数据。
insertParagraph
插入一个段落。
editParagraph
编辑已存在的段落。
uploadCoverImg
上传章节封面图片。
check
(书的作者或管理员)审批用户提交的段落。
removeParagraph
移除该段落 / 删除该段落下的某个版本(reword)。
sortParagraph
调整段落序号。
selectReword
选择某个审批过的版本(reword)为该段落的当前被选中版本。
setApplyScenes
为该本书设置应用场景。
prePublish
出版书前的验证。
publish
出版该本书。
publishNodeSection
出版章节下的某个分片(各个分片以标题段落进行切分) 。
newChapter
为多章节书创建新章节。
updateChapter
更新该章节的属性。
removeChapter
删除该章节。
restoreChapter
恢复被删除的章节。
setChapterManuscript
设置章节的Manuscript属性。
setChapterVisibility
设置章节的visibility属性。章节的可见性(visibility)表示是否可以在已出版的多章书籍中看到未出版的章节。
setCoverChapter
设置一个普通章节为封面章节。
setGeneralChapter
设置一个封面章节为普通章节。
sortChapter
重新为该章节排序。
collaborator
添加合作者到该章节/ 更新该章节的合作者身份。
removeCollaborator
删除该章节的合作者。
listCollaborator
返回该章节的合作者列表。
createCopy
创建该本书的副本。
userRelatedBooks
返回用户参与过的bundle列表。
targetUserRelatedBooks
返回指定用户参与过的bundle列表。
userCreatedBooks
返回指定用户创建的bundle列表。
mergeBundle
合并一本单章节的书到一本多章节书中(单章节书作为一个其中一个新章节)。
separateChapter
分离多章节书中其中一个章节作为一本新的单章节书。