MDClubJavaScript 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

参数名 类型 说明
code number

无任何错误时，状态码为 0
data Comment[]
pagination Pagination

Comment models.ts:285

参数名 类型 说明
comment_id number

评论ID
commentable_id number

评论目标的ID
commentable_type string

评论目标类型

取值范围包括：article、question、answer、comment
content string

评论内容
create_time number

发表时间
delete_time number

🔐删除时间
relationships CommentRelationship
update_time number

修改时间
user_id number

用户ID
vote_count number

投票数（赞成票 - 反对票，可能为负数）
vote_down_count number

反对票总数
vote_up_count number

赞成票总数

Pagination models.ts:1426

参数名 类型 说明
next number

下一页页码，为 null 表示没有下一页
page number

当前页码
pages number

总页数
per_page number

每页条数
previous number

上一页页码，为 null 表示没有上一页
total number

数据总数

CommentRelationship models.ts:361

参数名 类型 说明
user UserInRelationship
voting string

当前登录用户的投票类型（up、down），未投过票则为空字符串

取值范围包括：up、down、

UserInRelationship models.ts:2162

参数名 类型 说明
avatar UserAvatar
headline string

一句话介绍
user_id number

用户ID
username string

用户名

UserAvatar models.ts:2094

参数名 类型 说明
large string

大头像地址
middle string

中头像地址
original string

头像原图地址
small string

小头像地址