MDClub JavaScript SDK 文档

NotificationApi.readMultiple

注意:该接口需要登陆后才能调用。

批量把通知标记为已读。

方法定义

NotificationApi.readMultiple(param: ReadMultipleParams): Promise<NotificationsResponse>

参数

ReadMultipleParams NotificationApi.ts:131

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

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

notification_ids 是 string

多个用 , 分隔的通知ID,最多提供 100 个 ID

响应

NotificationsResponse models.ts:693

参数名 类型 说明
code number

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

data Notification[]
pagination Pagination

Notification models.ts:573

参数名 类型 说明
answer_id number

相关回答ID

article_id number

相关文章ID

comment_id number

相关评论ID

content_deleted Question|Article|Answer|Comment

已删除的数据,包含以下对象之一,数据中不包含 relationships

取值范围包括:Question、Article、Answer、Comment

create_time number

通知发送时间

notification_id number

通知ID

question_id number

相关提问ID

read_time number

通知阅读时间

receiver_id number

通知接收者ID

relationships NotificationRelationship
reply_id number

相关回复ID

sender_id number

通知发送者ID

type string

通知类型:

  • question_answered:有人对提问发表了回答。此时会包含 question_id、answer_id
  • question_commented:有人对提问发表了评论。此时会包含 question_id、comment_id
  • question_deleted:提问被删除。此时会包含 question_id,但 relationships 中将不存在 question,可从 content_deleted 字段中获取被删除的提问内容
  • article_commented:有人对文章发表了评论。此时会包含 article_id、comment_id
  • article_deleted:文章被删除。此时会包含 article_id,但 relationships 中将不存在 article,可从 content_deleted 字段中获取被删除的文章内容
  • answer_commented:有人对回答发表了评论。此时会包含 question_id、answer_id、comment_id
  • answer_deleted:回答被删除。此时会包含 answer_id、question_id,但 relationships 中将不包含 answer,可从 content_deleted 字段中获取被删除的回答内容
  • comment_replied:有人对评论发表了回复。此时会包含 reply_id、comment_id,额外的,评论属于提问时会包含 question_id,属于文章时会包含 article_id,属于回答时会包含 answer_id、question_id
  • comment_deleted:评论被删除。此时会包含 comment_id,但 relationships 中将不包含 comment,可从 content_deleted 字段中获取被删除的评论内容;额外的,评论属于提问时会包含 question_id,属于文章时会包含 article_id,属于回答时会包含 answer_id、question_id

取值范围包括:question_answered、question_commented、question_deleted、article_commented、article_deleted、answer_commented、answer_deleted、comment_replied、comment_deleted

Pagination models.ts:1426

参数名 类型 说明
next number

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

page number

当前页码

pages number

总页数

per_page number

每页条数

previous number

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

total number

数据总数

Question models.ts:1453

参数名 类型 说明
answer_count number

回答数量

comment_count number

评论数量

content_markdown string

Markdown 格式的提问内容

content_rendered string

HTML 格式的提问内容

create_time number

创建时间

delete_time number

🔐删除时间

follower_count number

关注者数量

last_answer_time number

最后回答时间

question_id number

提问ID

relationships QuestionRelationship
title string

提问标题

update_time number

更新时间(更新提问本身,或在提问下发表回答,都会更新该字段)

user_id number

用户ID

vote_count number

投票数(赞成票 - 反对票,可能为负数)

vote_down_count number

反对票总数

vote_up_count number

赞成票总数

Article models.ts:118

参数名 类型 说明
article_id number

文章ID

comment_count number

评论数量

content_markdown string

Markdown 格式的文章内容

content_rendered string

HTML 格式的文章内容

create_time number

创建时间

delete_time number

🔐删除时间

follower_count number

关注者数量

relationships ArticleRelationship
title string

文章标题

update_time number

更新时间(用户可以更新自己的文章)

user_id number

用户ID

vote_count number

投票数(赞成票 - 反对票,可能为负数)

vote_down_count number

反对票总数

vote_up_count number

赞成票总数

Answer models.ts:1

参数名 类型 说明
answer_id number

回答ID

comment_count number

评论数量

content_markdown string

markdown 格式的内容

content_rendered string

html 格式的内容

create_time number

创建时间

delete_time number

🔐删除时间

question_id number

提问ID

relationships AnswerRelationship
update_time number

更新时间

user_id number

用户ID

vote_count number

投票数(赞成票 - 反对票,可能为负数)

vote_down_count number

反对票总数

vote_up_count number

赞成票总数

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

赞成票总数

NotificationRelationship models.ts:675

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

QuestionRelationship models.ts:1555

参数名 类型 说明
is_following boolean

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

topics TopicInRelationship[]
user UserInRelationship
voting string

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

取值范围包括:up、down、

ArticleRelationship models.ts:212

参数名 类型 说明
is_following boolean

当前登录用户是否已关注该文章

topics TopicInRelationship[]
user UserInRelationship
voting string

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

取值范围包括:up、down、

AnswerRelationship models.ts:76

参数名 类型 说明
question QuestionInRelationship
user UserInRelationship
voting string

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

取值范围包括:up、down、

CommentRelationship models.ts:361

参数名 类型 说明
user UserInRelationship
voting string

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

取值范围包括:up、down、

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

用户名

CommentInRelationship models.ts:342

参数名 类型 说明
comment_id number

评论ID

content_summary string

内容摘要

create_time number

发布时间

update_time number

更新时间

UserInRelationship models.ts:2162

参数名 类型 说明
avatar UserAvatar
headline string

一句话介绍

user_id number

用户ID

username string

用户名

TopicInRelationship models.ts:1933

参数名 类型 说明
cover TopicCover
name string

话题名称

topic_id number

话题 ID

UserInRelationship models.ts:2162

参数名 类型 说明
avatar UserAvatar
headline string

一句话介绍

user_id number

用户ID

username string

用户名

TopicInRelationship models.ts:1933

参数名 类型 说明
cover TopicCover
name string

话题名称

topic_id number

话题 ID

UserInRelationship models.ts:2162

参数名 类型 说明
avatar UserAvatar
headline string

一句话介绍

user_id number

用户ID

username string

用户名

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

用户名

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

小头像地址

UserAvatar models.ts:2094

参数名 类型 说明
large string

大头像地址

middle string

中头像地址

original string

头像原图地址

small string

小头像地址

TopicCover models.ts:1899

参数名 类型 说明
large string

大型封面地址

middle string

中型封面地址

original string

封面原图地址

small string

小型封面地址

UserAvatar models.ts:2094

参数名 类型 说明
large string

大头像地址

middle string

中头像地址

original string

头像原图地址

small string

小头像地址

TopicCover models.ts:1899

参数名 类型 说明
large string

大型封面地址

middle string

中型封面地址

original string

封面原图地址

small string

小型封面地址

UserAvatar models.ts:2094

参数名 类型 说明
large string

大头像地址

middle string

中头像地址

original string

头像原图地址

small string

小头像地址

UserAvatar models.ts:2094

参数名 类型 说明
large string

大头像地址

middle string

中头像地址

original string

头像原图地址

small string

小头像地址

UserAvatar models.ts:2094

参数名 类型 说明
large string

大头像地址

middle string

中头像地址

original string

头像原图地址

small string

小头像地址