menu MDClub JavaScript SDK 文档

ImageApi.getList

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

获取图片列表。

方法定义

ImageApi.getList(param: GetListParams): Promise<ImagesResponse>

参数

GetListParams ImageApi.ts:35

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

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

item_id否number

图片关联对象的ID

item_type否string

图片关联对象的类型

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

key否string

图片key

page否number

当前页数,默认为 1

per_page否number

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

user_id否number

用户ID

响应

ImagesResponse models.ts:564

参数名类型说明
codenumber

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

dataImage[]
paginationPagination

Image models.ts:478

参数名类型说明
create_timenumber

图片上传时间

filenamestring

图片原始文件名

heightnumber

原始图片高度

item_idnumber

图片关联对象ID

item_typestring

图片关联对象类型

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

keystring

图片的 key

relationshipsImageRelationship
urlsImageUrls
user_idnumber

图片上传者ID

widthnumber

原始图片宽度

Pagination models.ts:1426

参数名类型说明
nextnumber

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

pagenumber

当前页码

pagesnumber

总页数

per_pagenumber

每页条数

previousnumber

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

totalnumber

数据总数

ImageRelationship models.ts:520

参数名类型说明
answerAnswerInRelationship
articleArticleInRelationship
questionQuestionInRelationship
userUserInRelationship

ImageUrls models.ts:549

参数名类型说明
originalstring

原图地址

releasestring

宽度固定,高度自适应的图片地址

thumbstring

固定宽高的缩略图地址

AnswerInRelationship models.ts:53

参数名类型说明
answer_idnumber

回答ID

content_summarystring

内容摘要

create_timenumber

发布时间

question_idnumber

提问ID

update_timenumber

更新时间

ArticleInRelationship models.ts:193

参数名类型说明
article_idnumber

文章ID

create_timenumber

发布时间

titlestring

文章标题

update_timenumber

更新时间

QuestionInRelationship models.ts:1536

参数名类型说明
create_timenumber

发布时间

question_idnumber

提问ID

titlestring

提问标题

update_timenumber

更新时间

UserInRelationship models.ts:2162

参数名类型说明
avatarUserAvatar
headlinestring

一句话介绍

user_idnumber

用户ID

usernamestring

用户名

UserAvatar models.ts:2094

参数名类型说明
largestring

大头像地址

middlestring

中头像地址

originalstring

头像原图地址

smallstring

小头像地址