com.netease.nimlib.sdk.msg

接口 SystemMessageService

public interface SystemMessageService

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

方法概要

限定符和类型	方法和说明
void	clearSystemMessages() 删除所有系统通知
void	clearSystemMessagesByType(java.util.List<SystemMessageType> types) 删除指定类型的系统通知
void	deleteSystemMessage(long messageId) 删除一条系统通知
InvocationFuture<java.util.List<SystemMessage>>	querySystemMessageByType(java.util.List<SystemMessageType> types, int offset, int limit) 根据类型查询系统通知列表（异步版本）
java.util.List<SystemMessage>	querySystemMessageByTypeBlock(java.util.List<SystemMessageType> types, int offset, int limit) 根据类型查询系统通知列表（同步版本）
InvocationFuture<java.util.List<SystemMessage>>	querySystemMessages(int offset, int limit) 查询系统通知列表（异步版本）
java.util.List<SystemMessage>	querySystemMessagesBlock(int offset, int limit) 查询系统通知列表（同步版本）
InvocationFuture<java.util.List<SystemMessage>>	querySystemMessageUnread() 获取所有未读系统通知
InvocationFuture<java.lang.Integer>	querySystemMessageUnreadCount() 已过时。 使用同步版本 querySystemMessageUnreadCountBlock()，开销更小，也不会阻塞UI
int	querySystemMessageUnreadCountBlock() 查询系统通知未读数总和（同步版本）
int	querySystemMessageUnreadCountByType(java.util.List<SystemMessageType> types) 查询指定类型的系统通知未读数总和（同步版本）
void	resetSystemMessageUnreadCount() 将所有系统通知设为已读，系统通知的未读消息总数将清零。
void	resetSystemMessageUnreadCountByType(java.util.List<SystemMessageType> types) 将指定类型的系统通知设为已读
void	setSystemMessageRead(long messageId) 设置单条系统通知为已读
void	setSystemMessageStatus(long messageId, SystemMessageStatus status) 设置系统通知状态。

方法详细资料

querySystemMessages

InvocationFuture<java.util.List<SystemMessage>> querySystemMessages(int offset,
                                                                    int limit)

查询系统通知列表（异步版本）

参数:

offset - 数据库查询offset

limit - 数据库查询limit

返回:

InvocationFuture, 可设置回调函数，参数为系统通知列表

querySystemMessagesBlock

java.util.List<SystemMessage> querySystemMessagesBlock(int offset,
                                                       int limit)

查询系统通知列表（同步版本）

参数:

offset - 数据库查询offset

limit - 数据库查询limit

返回:

系统通知列表

querySystemMessageByType

InvocationFuture<java.util.List<SystemMessage>> querySystemMessageByType(java.util.List<SystemMessageType> types,
                                                                         int offset,
                                                                         int limit)

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

参数:

types - 待查询的系统通知类型集合

offset - 数据库查询offset

limit - 数据库查询limit

返回:

InvocationFuture, 可设置回调函数，参数为指定类型的系统通知集合

querySystemMessageByTypeBlock

java.util.List<SystemMessage> querySystemMessageByTypeBlock(java.util.List<SystemMessageType> types,
                                                            int offset,
                                                            int limit)

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

参数:

types - 待查询的系统通知类型集合

offset - 数据库查询offset

limit - 数据库查询limit

返回:

指定类型的系统通知集合

querySystemMessageUnread

InvocationFuture<java.util.List<SystemMessage>> querySystemMessageUnread()

获取所有未读系统通知

返回:

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

setSystemMessageStatus

void setSystemMessageStatus(long messageId,
                            SystemMessageStatus status)

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

参数:

messageId - 系统通知ID

status - 待更新的状态

deleteSystemMessage

void deleteSystemMessage(long messageId)

删除一条系统通知

参数:

messageId - 指定的系统通知ID

clearSystemMessages

void clearSystemMessages()

删除所有系统通知

clearSystemMessagesByType

void clearSystemMessagesByType(java.util.List<SystemMessageType> types)

删除指定类型的系统通知

参数:

types - 系统通知类型集合

querySystemMessageUnreadCount

InvocationFuture<java.lang.Integer> querySystemMessageUnreadCount()

已过时。 使用同步版本 querySystemMessageUnreadCountBlock()，开销更小，也不会阻塞UI

查询系统通知未读数总和（异步版本）

返回:

InvocationFuture, 可设置回调函数，参数为系统通知未读数总和

querySystemMessageUnreadCountBlock

int querySystemMessageUnreadCountBlock()

查询系统通知未读数总和（同步版本）

返回:

系统通知未读总数

querySystemMessageUnreadCountByType

int querySystemMessageUnreadCountByType(java.util.List<SystemMessageType> types)

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

参数:

types - 系统通知类型集合

返回:

指定类型的系统通知未读数总和

resetSystemMessageUnreadCount

void resetSystemMessageUnreadCount()

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

resetSystemMessageUnreadCountByType

void resetSystemMessageUnreadCountByType(java.util.List<SystemMessageType> types)

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

参数:

types - 系统通知类型集合

setSystemMessageRead

void setSystemMessageRead(long messageId)

设置单条系统通知为已读

参数:

messageId - 系统通知ID