NIMSDK-AOS  9.15.0
Public 成员函数 | 所有成员列表
com.netease.nimlib.sdk.msg.SystemMessageService接口 参考

系统通知消息接口
处理系统通知消息,如入群申请,入群邀请等 更多...

Public 成员函数

InvocationFuture< List< SystemMessage > > querySystemMessages (int offset, int limit)
 查询系统通知列表(异步版本) 更多...
 
List< SystemMessagequerySystemMessagesBlock (int offset, int limit)
 查询系统通知列表(同步版本) 更多...
 
InvocationFuture< List< SystemMessage > > querySystemMessageByType (List< SystemMessageType > types, int offset, int limit)
 根据类型查询系统通知列表(异步版本) 更多...
 
List< SystemMessagequerySystemMessageByTypeBlock (List< SystemMessageType > types, int offset, int limit)
 根据类型查询系统通知列表(同步版本) 更多...
 
InvocationFuture< List< SystemMessage > > querySystemMessageUnread ()
 获取所有未读系统通知 更多...
 
void setSystemMessageStatus (long messageId, SystemMessageStatus status)
 设置系统通知状态。在用户处理过系统通知之后,可调用此函数更新 更多...
 
void deleteSystemMessage (long messageId)
 删除一条系统通知 更多...
 
void clearSystemMessages ()
 删除所有系统通知 更多...
 
void clearSystemMessagesByType (List< SystemMessageType > types)
 删除指定类型的系统通知 更多...
 
InvocationFuture< Integer > querySystemMessageUnreadCount ()
 查询系统通知未读数总和(异步版本) 更多...
 
int querySystemMessageUnreadCountBlock ()
 查询系统通知未读数总和(同步版本) 更多...
 
int querySystemMessageUnreadCountByType (List< SystemMessageType > types)
 查询指定类型的系统通知未读数总和(同步版本) 更多...
 
void resetSystemMessageUnreadCount ()
 将所有系统通知设为已读,系统通知的未读消息总数将清零。 更多...
 
void resetSystemMessageUnreadCountByType (List< SystemMessageType > types)
 将指定类型的系统通知设为已读 更多...
 
void setSystemMessageRead (long messageId)
 设置单条系统通知为已读 更多...
 

详细描述

系统通知消息接口
处理系统通知消息,如入群申请,入群邀请等

在文件 SystemMessageService.java14 行定义.

成员函数说明

◆ clearSystemMessages()

void com.netease.nimlib.sdk.msg.SystemMessageService.clearSystemMessages ( )

删除所有系统通知

◆ clearSystemMessagesByType()

void com.netease.nimlib.sdk.msg.SystemMessageService.clearSystemMessagesByType ( List< SystemMessageType types)

删除指定类型的系统通知

参数
types系统通知类型集合

◆ deleteSystemMessage()

void com.netease.nimlib.sdk.msg.SystemMessageService.deleteSystemMessage ( long  messageId)

删除一条系统通知

参数
messageId指定的系统通知ID

◆ querySystemMessageByType()

InvocationFuture<List<SystemMessage> > com.netease.nimlib.sdk.msg.SystemMessageService.querySystemMessageByType ( List< SystemMessageType types,
int  offset,
int  limit 
)

根据类型查询系统通知列表(异步版本)

参数
types待查询的系统通知类型集合
offset数据库查询offset
limit数据库查询limit
返回
InvocationFuture, 可设置回调函数,参数为指定类型的系统通知集合

◆ querySystemMessageByTypeBlock()

List<SystemMessage> com.netease.nimlib.sdk.msg.SystemMessageService.querySystemMessageByTypeBlock ( List< SystemMessageType types,
int  offset,
int  limit 
)

根据类型查询系统通知列表(同步版本)

参数
types待查询的系统通知类型集合
offset数据库查询offset
limit数据库查询limit
返回
指定类型的系统通知集合

◆ querySystemMessages()

InvocationFuture<List<SystemMessage> > com.netease.nimlib.sdk.msg.SystemMessageService.querySystemMessages ( int  offset,
int  limit 
)

查询系统通知列表(异步版本)

参数
offset数据库查询offset
limit数据库查询limit
返回
InvocationFuture, 可设置回调函数,参数为系统通知列表

◆ querySystemMessagesBlock()

List<SystemMessage> com.netease.nimlib.sdk.msg.SystemMessageService.querySystemMessagesBlock ( int  offset,
int  limit 
)

查询系统通知列表(同步版本)

参数
offset数据库查询offset
limit数据库查询limit
返回
系统通知列表

◆ querySystemMessageUnread()

InvocationFuture<List<SystemMessage> > com.netease.nimlib.sdk.msg.SystemMessageService.querySystemMessageUnread ( )

获取所有未读系统通知

返回
InvocationFuture, 可设置回调函数,参数为所有未读的系统通知集合

◆ querySystemMessageUnreadCount()

InvocationFuture<Integer> com.netease.nimlib.sdk.msg.SystemMessageService.querySystemMessageUnreadCount ( )

查询系统通知未读数总和(异步版本)

返回
InvocationFuture, 可设置回调函数,参数为系统通知未读数总和
弃用:
使用同步版本 querySystemMessageUnreadCountBlock,开销更小,也不会阻塞UI

◆ querySystemMessageUnreadCountBlock()

int com.netease.nimlib.sdk.msg.SystemMessageService.querySystemMessageUnreadCountBlock ( )

查询系统通知未读数总和(同步版本)

返回
系统通知未读总数

◆ querySystemMessageUnreadCountByType()

int com.netease.nimlib.sdk.msg.SystemMessageService.querySystemMessageUnreadCountByType ( List< SystemMessageType types)

查询指定类型的系统通知未读数总和(同步版本)

参数
types系统通知类型集合
返回
指定类型的系统通知未读数总和

◆ resetSystemMessageUnreadCount()

void com.netease.nimlib.sdk.msg.SystemMessageService.resetSystemMessageUnreadCount ( )

将所有系统通知设为已读,系统通知的未读消息总数将清零。

◆ resetSystemMessageUnreadCountByType()

void com.netease.nimlib.sdk.msg.SystemMessageService.resetSystemMessageUnreadCountByType ( List< SystemMessageType types)

将指定类型的系统通知设为已读

参数
types系统通知类型集合

◆ setSystemMessageRead()

void com.netease.nimlib.sdk.msg.SystemMessageService.setSystemMessageRead ( long  messageId)

设置单条系统通知为已读

参数
messageId系统通知ID

◆ setSystemMessageStatus()

void com.netease.nimlib.sdk.msg.SystemMessageService.setSystemMessageStatus ( long  messageId,
SystemMessageStatus  status 
)

设置系统通知状态。在用户处理过系统通知之后,可调用此函数更新

参数
messageId系统通知ID
status待更新的状态

该接口的文档由以下文件生成: