menu MDClub JavaScript SDK 文档

QuestionApi.getList

获取提问列表。

方法定义

QuestionApi.getList(param: GetListParams): Promise<QuestionsResponse>

参数

GetListParams QuestionApi.ts:215

参数名必选类型说明
includestring

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

orderstring

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

取值范围包括:vote_countcreate_timeupdate_timedelete_time-vote_count-create_time-update_time-delete_time

pagenumber

当前页数,默认为 1

per_pagenumber

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

question_idnumber

提问ID

topic_idnumber

话题ID

trashedboolean

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

user_idnumber

用户ID

响应

QuestionsResponse models.ts:1600

参数名类型说明
codenumber

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

dataQuestion[]
paginationPagination

Question models.ts:1453

参数名类型说明
answer_countnumber

回答数量

comment_countnumber

评论数量

content_markdownstring

Markdown 格式的提问内容

content_renderedstring

HTML 格式的提问内容

create_timenumber

创建时间

delete_timenumber

🔐删除时间

follower_countnumber

关注者数量

last_answer_timenumber

最后回答时间

question_idnumber

提问ID

relationshipsQuestionRelationship
titlestring

提问标题

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

数据总数

QuestionRelationship models.ts:1555

参数名类型说明
is_followingboolean

当前登录用户是否已关注该提问

topicsTopicInRelationship[]
userUserInRelationship
votingstring

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

取值范围包括:updown

TopicInRelationship models.ts:1933

参数名类型说明
coverTopicCover
namestring

话题名称

topic_idnumber

话题 ID

UserInRelationship models.ts:2162

参数名类型说明
avatarUserAvatar
headlinestring

一句话介绍

user_idnumber

用户ID

usernamestring

用户名

TopicCover models.ts:1899

参数名类型说明
largestring

大型封面地址

middlestring

中型封面地址

originalstring

封面原图地址

smallstring

小型封面地址

UserAvatar models.ts:2094

参数名类型说明
largestring

大头像地址

middlestring

中头像地址

originalstring

头像原图地址

smallstring

小头像地址