MDClubJavaScript SDK 文档

TopicApi.getList

获取全部话题。

方法定义

TopicApi.getList(param: GetListParams): Promise<TopicsResponse>

参数

GetListParams TopicApi.ts:121

参数名 必选 类型 说明
include 否 string

响应中需要包含的关联数据，用 , 分隔。可以为 is_following
name 否 string

话题名称
order 否 string

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

取值范围包括：topic_id、follower_count、delete_time、-topic_id、-follower_count、-delete_time
page 否 number

当前页数，默认为 1
per_page 否 number

每页条数，默认为 15（最大为 100）
topic_id 否 number

话题ID
trashed 否 boolean

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

响应

TopicsResponse models.ts:1975

参数名 类型 说明
code number

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

Topic models.ts:1866

参数名 类型 说明
article_count number

文章数量
cover TopicCover
delete_time number

🔐删除时间
description string

话题描述
follower_count number

关注者数量
name string

话题名称
question_count number

提问数量
relationships TopicRelationship
topic_id number

话题ID

Pagination models.ts:1426

参数名 类型 说明
next number

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

当前页码
pages number

总页数
per_page number

每页条数
previous number

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

数据总数

TopicCover models.ts:1899

参数名 类型 说明
large string

大型封面地址
middle string

中型封面地址
original string

封面原图地址
small string

小型封面地址

TopicRelationship models.ts:1945

参数名 类型 说明
is_following boolean

当前登录用户是否已关注该话题