MDClub JavaScript SDK 文档

ReportApi.getList

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

获取被举报的内容列表。

方法定义

ReportApi.getList(param: GetListParams): Promise<ReportGroupsResponse>

参数

GetListParams ReportApi.ts:49

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

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

page 否 number

当前页数,默认为 1

per_page 否 number

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

reportable_type 否 string

目标类型

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

响应

ReportGroupsResponse models.ts:1687

参数名 类型 说明
code number

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

data ReportGroup[]
pagination Pagination

ReportGroup models.ts:1653

参数名 类型 说明
relationships ReportGroupRelationship
reportable_id number

举报目标的ID

reportable_type string

举报目标类型

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

reporter_count number

指定对象的被举报数量

Pagination models.ts:1426

参数名 类型 说明
next number

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

page number

当前页码

pages number

总页数

per_page number

每页条数

previous number

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

total number

数据总数

ReportGroupRelationship models.ts:1679

参数名 类型 说明
answer AnswerInRelationship
article ArticleInRelationship
comment CommentInRelationship
question QuestionInRelationship
user UserInRelationship

AnswerInRelationship models.ts:53

参数名 类型 说明
answer_id number

回答ID

content_summary string

内容摘要

create_time number

发布时间

question_id number

提问ID

update_time number

更新时间

ArticleInRelationship models.ts:193

参数名 类型 说明
article_id number

文章ID

create_time number

发布时间

title string

文章标题

update_time number

更新时间

CommentInRelationship models.ts:342

参数名 类型 说明
comment_id number

评论ID

content_summary string

内容摘要

create_time number

发布时间

update_time number

更新时间

QuestionInRelationship models.ts:1536

参数名 类型 说明
create_time number

发布时间

question_id number

提问ID

title string

提问标题

update_time number

更新时间

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

小头像地址