V2NIMMessageSearchParams.java

浏览该文件的文档.

package com.netease.nimlib.sdk.v2.message.params;

import com.netease.nimlib.sdk.v2.message.enums.V2NIMMessageType;
import com.netease.nimlib.sdk.v2.message.enums.V2NIMSortOrder;
import java.util.List;

// 消息检索参数
public class V2NIMMessageSearchParams {

    // 检索的关键字
    private final String keyword;
    // 查询开始时间，小于endTime
    private final long beginTime;
    // 查询结束时间，如果为0，表示当前时间
    private final long endTime;
    // 检索的会话条数
    // 如果>0： 按会话分组
    // 否则：按时间排序，不按会话分组
    // note：协议 7-26   7-27
    private final int conversationLimit;
    // 返回的消息条数
    // 最多不超过X， 跟当前版本对齐
    // 默认 20
    private final int messageLimit;
    // 消息排序规则
    // 默认 V2NIMSortOrder.V2NIM_SORT_ORDER_DESC
    private final V2NIMSortOrder sortOrder;
    // P2P账号列表， 最大20个，超过20个返回参数错误
    private final List<String> p2pAccountIds;
    // 高级群账号列表， 最大20个， 超过20个返回参数错误
    // 不支持超大群
    private final List<String> teamIds;
    // 检索的发送账号列表，最大20个， 超过20个返回参数错误
    private final List<String> senderAccountIds;
    // 根据消息类型检索消息， 为null或空列表， 则表示查询所有消息类型
    private final List<V2NIMMessageType> messageTypes;
    // 根据消息子类型检索消息， 为null或空列表， 则表示查询所有消息子类型
    private final List<Integer> messageSubtypes;

    private V2NIMMessageSearchParams() {
        this("", 0, 0, 0, DEFAULT_CONVERSATION_LIMIT, DEFAULT_SORT_ORDER, null, null, null, null, null);
    }

    private V2NIMMessageSearchParams(String keyword, long beginTime, long endTime, int conversationLimit, int messageLimit, V2NIMSortOrder sortOrder, List<String> p2pAccountIds, List<String> teamIds, List<String> senderAccountIds, List<V2NIMMessageType> messageTypes, List<Integer> messageSubtypes) {
        this.keyword = keyword;
        this.beginTime = beginTime;
        this.endTime = endTime;
        this.conversationLimit = conversationLimit;
        this.messageLimit = messageLimit;
        this.sortOrder = sortOrder;
        this.p2pAccountIds = p2pAccountIds;
        this.teamIds = teamIds;
        this.senderAccountIds = senderAccountIds;
        this.messageTypes = messageTypes;
        this.messageSubtypes = messageSubtypes;
    }

    public String getKeyword() {
        return keyword;
    }

    public long getBeginTime() {
        return beginTime;
    }

    public long getEndTime() {
        return endTime;
    }

    public int getConversationLimit() {
        return conversationLimit;
    }

    public int getMessageLimit() {
        return messageLimit;
    }

    public V2NIMSortOrder getSortOrder() {
        if (sortOrder == null) {
            return V2NIMSortOrder.V2NIM_SORT_ORDER_DESC;
        } else {
            return sortOrder;
        }
    }

    public List<String> getP2pAccountIds() {
        return p2pAccountIds;
    }

    public List<String> getTeamIds() {
        return teamIds;
    }

    public List<String> getSenderAccountIds() {
        return senderAccountIds;
    }

    public List<V2NIMMessageType> getMessageTypes() {
        return messageTypes;
    }

    public List<Integer> getMessageSubtypes() {
        return messageSubtypes;
    }

    @Override
    public String toString() {
        return "V2NIMMessageSearchParams{" +
                "keyword='" + keyword + '\'' +
                ", beginTime=" + beginTime +
                ", endTime=" + endTime +
                ", conversationLimit=" + conversationLimit +
                ", messageLimit=" + messageLimit +
                ", sortOrder=" + sortOrder +
                ", p2pAccountIds=" + p2pAccountIds +
                ", teamIds=" + teamIds +
                ", senderAccountIds=" + senderAccountIds +
                ", messageTypes=" + messageTypes +
                ", messageSubtypes=" + messageSubtypes +
                '}';
    }

    private static final int DEFAULT_CONVERSATION_LIMIT = 10;
    private static final V2NIMSortOrder DEFAULT_SORT_ORDER = V2NIMSortOrder.V2NIM_SORT_ORDER_DESC;

    public static final class V2NIMMessageSearchParamsBuilder {
        private final String keyword;
        private long beginTime = 0;
        private long endTime = 0;
        private int conversationLimit = 0;
        private int messageLimit = DEFAULT_CONVERSATION_LIMIT;
        private V2NIMSortOrder sortOrder = DEFAULT_SORT_ORDER;
        private List<String> p2pAccountIds;
        private List<String> teamIds;
        private List<String> senderAccountIds;
        private List<V2NIMMessageType> messageTypes;
        private List<Integer> messageSubtypes;

        private V2NIMMessageSearchParamsBuilder(String keyword) {
            this.keyword = keyword;
        }

        public static V2NIMMessageSearchParamsBuilder builder(String keyword) {
            return new V2NIMMessageSearchParamsBuilder(keyword);
        }

        public V2NIMMessageSearchParamsBuilder withBeginTime(long beginTime) {
            this.beginTime = beginTime;
            return this;
        }

        public V2NIMMessageSearchParamsBuilder withEndTime(long endTime) {
            this.endTime = endTime;
            return this;
        }

        public V2NIMMessageSearchParamsBuilder withConversationLimit(int conversationLimit) {
            this.conversationLimit = conversationLimit;
            return this;
        }

        public V2NIMMessageSearchParamsBuilder withMessageLimit(int messageLimit) {
            this.messageLimit = messageLimit;
            return this;
        }

        public V2NIMMessageSearchParamsBuilder withSortOrder(V2NIMSortOrder sortOrder) {
            this.sortOrder = sortOrder;
            return this;
        }

        public V2NIMMessageSearchParamsBuilder withP2pAccountIds(List<String> p2pAccountIds) {
            this.p2pAccountIds = p2pAccountIds;
            return this;
        }

        public V2NIMMessageSearchParamsBuilder withTeamIds(List<String> teamIds) {
            this.teamIds = teamIds;
            return this;
        }

        public V2NIMMessageSearchParamsBuilder withSenderAccountIds(List<String> senderAccountIds) {
            this.senderAccountIds = senderAccountIds;
            return this;
        }

        public V2NIMMessageSearchParamsBuilder withMessageTypes(List<V2NIMMessageType> messageTypes) {
            this.messageTypes = messageTypes;
            return this;
        }

        public V2NIMMessageSearchParamsBuilder withMessageSubtypes(List<Integer> messageSubtypes) {
            this.messageSubtypes = messageSubtypes;
            return this;
        }

        public V2NIMMessageSearchParams build() {
            return new V2NIMMessageSearchParams(keyword, beginTime, endTime, conversationLimit, messageLimit, sortOrder, p2pAccountIds, teamIds, senderAccountIds, messageTypes, messageSubtypes);
        }
    }
}