menu MDClub JavaScript SDK 文档

CommentApi.getList

注意:该接口需要管理员权限才能调用。

获取所有评论。

方法定义

CommentApi.getList(param: GetListParams): Promise<CommentsResponse>

参数

GetListParams CommentApi.ts:75

参数名必选类型说明
comment_id否number

评论ID

commentable_id否number

评论目标的ID

commentable_type否string

评论目标类型

取值范围包括:article、question、answer、comment

include否string

响应中需要包含的关联数据,用 , 分隔。可以为 user, voting

order否string

排序方式。在字段前加 - 表示倒序排列。 可排序字段包括 vote_count、create_time、delete_time。默认为 -create_time。其中 delete_time 值仅管理员使用有效。

取值范围包括:vote_count、create_time、delete_time、-vote_count、-create_time、-delete_time

page否number

当前页数,默认为 1

per_page否number

每页条数,默认为 15(最大为 100)

trashed否boolean

🔐是否仅获取回收站中的数据

user_id否number

用户ID

响应

CommentsResponse models.ts:389

参数名类型说明
codenumber

无任何错误时,状态码为 0

dataComment[]
paginationPagination

Comment models.ts:285

参数名类型说明
comment_idnumber

评论ID

commentable_idnumber

评论目标的ID

commentable_typestring

评论目标类型

取值范围包括:article、question、answer、comment

contentstring

评论内容

create_timenumber

发表时间

delete_timenumber

🔐删除时间

relationshipsCommentRelationship
update_timenumber

修改时间

user_idnumber

用户ID

vote_countnumber

投票数(赞成票 - 反对票,可能为负数)

vote_down_countnumber

反对票总数

vote_up_countnumber

赞成票总数

Pagination models.ts:1426

参数名类型说明
nextnumber

下一页页码,为 null 表示没有下一页

pagenumber

当前页码

pagesnumber

总页数

per_pagenumber

每页条数

previousnumber

上一页页码,为 null 表示没有上一页

totalnumber

数据总数

CommentRelationship models.ts:361

参数名类型说明
userUserInRelationship
votingstring

当前登录用户的投票类型(up、down),未投过票则为空字符串

取值范围包括:up、down、

UserInRelationship models.ts:2162

参数名类型说明
avatarUserAvatar
headlinestring

一句话介绍

user_idnumber

用户ID

usernamestring

用户名

UserAvatar models.ts:2094

参数名类型说明
largestring

大头像地址

middlestring

中头像地址

originalstring

头像原图地址

smallstring

小头像地址