SystemMessageService.java

浏览该文件的文档.

package com.netease.nimlib.sdk.msg;

import com.netease.nimlib.sdk.InvocationFuture;
import com.netease.nimlib.sdk.msg.constant.SystemMessageStatus;
import com.netease.nimlib.sdk.msg.constant.SystemMessageType;
import com.netease.nimlib.sdk.msg.model.SystemMessage;

import java.util.List;

/**
 * 系统通知消息接口 <br>
 * 处理系统通知消息，如入群申请，入群邀请等
 */
public interface SystemMessageService {
    /**
     * 查询系统通知列表（异步版本）
     *
     * @param offset 数据库查询offset
     * @param limit  数据库查询limit
     * @return InvocationFuture, 可设置回调函数，参数为系统通知列表
     */
    public InvocationFuture<List<SystemMessage>> querySystemMessages(int offset, int limit);

    /**
     * 查询系统通知列表（同步版本）
     *
     * @param offset 数据库查询offset
     * @param limit  数据库查询limit
     * @return 系统通知列表
     */
    public List<SystemMessage> querySystemMessagesBlock(int offset, int limit);

    /**
     * 根据类型查询系统通知列表（异步版本）
     *
     * @param types  待查询的系统通知类型集合
     * @param offset 数据库查询offset
     * @param limit  数据库查询limit
     * @return InvocationFuture, 可设置回调函数，参数为指定类型的系统通知集合
     */
    public InvocationFuture<List<SystemMessage>> querySystemMessageByType(List<SystemMessageType> types, int offset, int limit);

    /**
     * 根据类型查询系统通知列表（同步版本）
     *
     * @param types  待查询的系统通知类型集合
     * @param offset 数据库查询offset
     * @param limit  数据库查询limit
     * @return 指定类型的系统通知集合
     */
    public List<SystemMessage> querySystemMessageByTypeBlock(List<SystemMessageType> types, int offset, int limit);

    /**
     * 获取所有未读系统通知
     * @return InvocationFuture, 可设置回调函数，参数为所有未读的系统通知集合
     */
    public InvocationFuture<List<SystemMessage>> querySystemMessageUnread();

    /**
     * 设置系统通知状态。在用户处理过系统通知之后，可调用此函数更新
     *
     * @param messageId 系统通知ID
     * @param status    待更新的状态
     */
    public void setSystemMessageStatus(long messageId, SystemMessageStatus status);

    /**
     * 删除一条系统通知
     *
     * @param messageId 指定的系统通知ID
     */
    public void deleteSystemMessage(long messageId);

    /**
     * 删除所有系统通知
     */
    public void clearSystemMessages();

    /**
     * 删除指定类型的系统通知
     *
     * @param types 系统通知类型集合
     */
    public void clearSystemMessagesByType(List<SystemMessageType> types);

    /**
     * 查询系统通知未读数总和（异步版本）
     *
     * @return InvocationFuture, 可设置回调函数，参数为系统通知未读数总和
     * @deprecated 使用同步版本 {@link #querySystemMessageUnreadCountBlock}，开销更小，也不会阻塞UI
     */
    public InvocationFuture<Integer> querySystemMessageUnreadCount();

    /**
     * 查询系统通知未读数总和（同步版本）
     *
     * @return 系统通知未读总数
     */
    public int querySystemMessageUnreadCountBlock();

    /**
     * 查询指定类型的系统通知未读数总和（同步版本）
     *
     * @param types 系统通知类型集合
     * @return 指定类型的系统通知未读数总和
     */
    public int querySystemMessageUnreadCountByType(List<SystemMessageType> types);

    /**
     * 将所有系统通知设为已读，系统通知的未读消息总数将清零。
     */
    public void resetSystemMessageUnreadCount();

    /**
     * 将指定类型的系统通知设为已读
     *
     * @param types 系统通知类型集合
     */
    public void resetSystemMessageUnreadCountByType(List<SystemMessageType> types);

    /**
     * 设置单条系统通知为已读
     *
     * @param messageId 系统通知ID
     */
    public void setSystemMessageRead(long messageId);
}