V2NIMMessageSearchExParams.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.V2NIMSearchDirection;
import com.netease.nimlib.sdk.v2.message.enums.V2NIMSearchKeywordMathType;
import com.netease.nimlib.sdk.v2.message.enums.V2NIMSearchStrategy;
import java.util.List;

public class V2NIMMessageSearchExParams {
    /**
     * 搜索 “全部会话” 还是搜索 “指定的会话”
     * conversationID 为空（null），搜索全部会话；
     * conversationID 不为空，搜索指定会话。
     */
    private final String conversationId;
    /**
     * 关键字列表，
     * 最多支持 5 个。当消息发送者以及消息类型均未指定时，必须设置关键字列表；否则，关键字列表可以为空。
     */
    private final List<String> keywordList;
    /**
     * 指定关键字列表匹配类型
     * 可设置为 “或” 关系搜索，或 “与” 关系搜索。取值分别为 V2TIM_KEYWORD_MATCH_TYPE_OR 和 V2TIM_KEYWORD_MATCH_TYPE_AND。默认为 “或” 关系搜索。
     *  关键字列表为空或为数量为1，该字段无效
     */
    private final V2NIMSearchKeywordMathType keywordMatchType;
    /**
     * 指定消息发送者，
     *  最多支持 5 个。
     *  超过返回参数错误， accountid默认只检查数量， 不检查是否重复
     *  null 和size==0 都表示没有指定人数
     */
    private final List<String> senderAccountIds;
    /**
     * 指定消息类型，
     *  为null或空列表， 则表示查询所有消息类型
     *  关键字不为空时， 不支持检索通知类消息
     *  非文本消息，只检索对应检索字段，如果检索字段为空则该消息不回被检索到
     */
    private final List<V2NIMMessageType> messageTypes;
    /**
     * 指定消息子类型，
     *  为null或空列表， 则表示查询所有消息子类型
     *  关键字不为空时， 不支持检索通知类消息
     *  非文本消息，只检索对应检索字段，如果检索字段为空则该消息不回被检索到
     */
    private final List<Integer>          messageSubtypes;
    /**
     * 搜索的起始时间点，
     *  默认为 0（从现在开始搜索）。UTC 时间戳，单位：毫秒。
     */
    private final long                   searchStartTime;
    /**
     * 从起始时间点开始的过去时间范围，
     *  默认为 0（不限制时间范围）。24 x 60 x 60 x 1000 代表过去一天，单位：毫秒。
     */
    private final long searchTimePeriod;
    /**
     * 搜索的数量限制，
     *  最大100
     */
    private final int limit;
    /**
     * 检索方向
     */
    private final V2NIMSearchDirection direction;
    /**
     * 消息检索的策略
     */
    private final V2NIMSearchStrategy strategy;
    /**
     * 搜索的起始位置，第一次填写空字符串，续拉时填写上一次返回的 V2NIMMessageSearchResult 中的 nextPageToken。
     *  两次查询参数必须一致
     */
    private final String pageToken;

    private V2NIMMessageSearchExParams() {
        this(null, null, V2NIMSearchKeywordMathType.V2NIM_SEARCH_KEYWORD_MATH_TYPE_OR, null, null,null, 0, 0, LIMIT_DEFAULT, DIRECTION_DEFAULT, STRATEGY_DEFAULT, null);
    }

    private V2NIMMessageSearchExParams(String conversationId, List<String> keywordList, V2NIMSearchKeywordMathType keywordMatchType, List<String> senderAccountIds, List<V2NIMMessageType> messageTypes, List<Integer> messageSubtypes, long searchStartTime, long searchTimePeriod, int limit, V2NIMSearchDirection direction, V2NIMSearchStrategy strategy, String pageToken) {
        this.conversationId = conversationId;
        this.keywordList = keywordList;
        this.keywordMatchType = keywordMatchType;
        this.senderAccountIds = senderAccountIds;
        this.messageTypes = messageTypes;
        this.messageSubtypes = messageSubtypes;
        this.searchStartTime = searchStartTime;
        this.searchTimePeriod = searchTimePeriod;
        this.limit = limit;
        this.direction = direction;
        this.strategy = strategy;
        this.pageToken = pageToken;
    }

    /**
     * 获取会话ID
     * @return 会话ID
     */
    public String getConversationId() {
        return conversationId;
    }

    /**
     * 获取关键字列表
     * @return 关键字列表
     */
    public List<String> getKeywordList() {
        return keywordList;
    }

    /**
     * 获取关键字匹配类型
     * @return 关键字匹配类型
     */
    public V2NIMSearchKeywordMathType getKeywordMatchType() {
        return keywordMatchType;
    }

    /**
     * 获取发送者列表
     * @return 发送者列表
     */
    public List<String> getSenderAccountIds() {
        return senderAccountIds;
    }

    /**
     * 获取消息类型列表
     * @return 消息类型列表
     */
    public List<V2NIMMessageType> getMessageTypes() {
        return messageTypes;
    }

    /**
     * 获取消息子类型列表
     * @return 消息子类型列表
     */
    public List<Integer> getMessageSubtypes() {
        return messageSubtypes;
    }

    /**
     * 获取搜索起始时间
     * @return 搜索起始时间
     */
    public long getSearchStartTime() {
        return searchStartTime;
    }

    /**
     * 获取搜索时间范围
     * @return 搜索时间范围
     */
    public long getSearchTimePeriod() {
        return searchTimePeriod;
    }

    /**
     * 获取搜索数量限制
     * @return 搜索数量限制
     */
    public int getLimit() {
        return limit;
    }

    /**
     * 获取检索方向
     * @return 检索方向
     */
    public V2NIMSearchDirection getDirection() {
        return direction;
    }

    /**
     * 获取消息检索的策略
     * @return 消息检索的策略
     */
    public V2NIMSearchStrategy getStrategy() {
        return strategy;
    }

    /**
     * 获取搜索起始位置
     * @return 搜索起始位置
     */
    public String getPageToken() {
        return pageToken;
    }

    @Override
    public String toString() {
        return "V2NIMMessageSearchExParams{" +
                "conversationId='" + conversationId + '\'' +
                ", keywordList=" + keywordList +
                ", keywordMatchType=" + keywordMatchType +
                ", senderAccountIds=" + senderAccountIds +
                ", messageTypes=" + messageTypes +
                ", messageSubtypes=" + messageSubtypes +
                ", searchStartTime=" + searchStartTime +
                ", searchTimePeriod=" + searchTimePeriod +
                ", limit=" + limit +
                ", pageToken='" + pageToken + '\'' +
                '}';
    }

    public static final int LIMIT_DEFAULT = 20;
    public static final int LIMIT_MAX = 100;
    private static final V2NIMSearchDirection DIRECTION_DEFAULT = V2NIMSearchDirection.V2NIM_SEARCH_DIRECTION_BACKWARD;
    private static final V2NIMSearchStrategy  STRATEGY_DEFAULT = V2NIMSearchStrategy.V2NIM_SEARCH_STRATEGY_FTS;

    /**
     * V2NIMMessageSearchExParams 构造器
     */
    public static final class V2NIMMessageSearchExParamsBuilder {

        /**
         * 搜索 “全部会话” 还是搜索 “指定的会话”
         * conversationID 为空（null），搜索全部会话；
         * conversationID 不为空，搜索指定会话。
         */
        private String conversationId;
        /**
         * 关键字列表，
         * 最多支持 5 个。当消息发送者以及消息类型均未指定时，必须设置关键字列表；否则，关键字列表可以为空。
         */
        private List<String> keywordList;
        /**
         * 指定关键字列表匹配类型
         * 可设置为 “或” 关系搜索，或 “与” 关系搜索。取值分别为 V2TIM_KEYWORD_MATCH_TYPE_OR 和 V2TIM_KEYWORD_MATCH_TYPE_AND。默认为 “或” 关系搜索。
         * 关键字列表为空或为数量为1，该字段无效
         */
        private V2NIMSearchKeywordMathType keywordMatchType = V2NIMSearchKeywordMathType.V2NIM_SEARCH_KEYWORD_MATH_TYPE_OR;
        /**
         * 指定消息发送者，
         * 最多支持 5 个。
         * 超过返回参数错误， accountid默认只检查数量， 不检查是否重复
         * null 和size==0 都表示没有指定人数
         */
        private List<String> senderAccountIds;
        /**
         * 指定消息类型，
         * 为null或空列表， 则表示查询所有消息类型
         * 关键字不为空时， 不支持检索通知类消息
         * 非文本消息，只检索对应检索字段，如果检索字段为空则该消息不回被检索到
         */
        private List<V2NIMMessageType> messageTypes;
        /**
         * 指定消息子类型，
         *  为null或空列表， 则表示查询所有消息子类型
         *  关键字不为空时， 不支持检索通知类消息
         *  非文本消息，只检索对应检索字段，如果检索字段为空则该消息不回被检索到
         */
        private List<Integer>          messageSubtypes;
        /**
         * 搜索的起始时间点，
         * 默认为 0（从现在开始搜索）。UTC 时间戳，单位：毫秒。
         */
        private long                   searchStartTime;
        /**
         * 搜索的过去时间范围，
         * 默认为 0（不限制时间范围）。24 x 60 x 60 x 1000 代表过去一天，单位：毫秒。
         */
        private long searchTimePeriod;
        /**
         * 搜索的数量限制，
         * 最大100
         */
        private int limit = LIMIT_DEFAULT;
        /**
         * 检索方向
         */
        private V2NIMSearchDirection direction = DIRECTION_DEFAULT;
        /**
         * 消息检索的策略
         */
        private V2NIMSearchStrategy strategy = STRATEGY_DEFAULT;
        /**
         * 搜索的起始位置，第一次填写空字符串，续拉时填写上一次返回的 V2NIMMessageSearchResult 中的 nextPageToken。
         * 两次查询参数必须一致
         */
        private String pageToken;

        private V2NIMMessageSearchExParamsBuilder() {
        }

        /**
         * 构建 V2NIMMessageSearchExParamsBuilder 实例
         * @return V2NIMMessageSearchExParamsBuilder 实例
         */
        public static V2NIMMessageSearchExParamsBuilder builder() {
            return new V2NIMMessageSearchExParamsBuilder();
        }

        /**
         * 设置会话ID
         * conversationID 为空（null），搜索全部会话；
         * conversationID 不为空，搜索指定会话。
         * @param conversationId 会话ID
         * @return  V2NIMMessageSearchExParamsBuilder 实例
         */
        public V2NIMMessageSearchExParamsBuilder withConversationId(String conversationId) {
            this.conversationId = conversationId;
            return this;
        }

        /**
         * 设置关键字列表，
         * 最多支持 5 个。当消息发送者以及消息类型均未指定时，必须设置关键字列表；否则，关键字列表可以为空。
         * @param keywordList 关键字列表
         * @return  V2NIMMessageSearchExParamsBuilder 实例
         */
        public V2NIMMessageSearchExParamsBuilder withKeywordList(List<String> keywordList) {
            this.keywordList = keywordList;
            return this;
        }

        /**
         * 设置关键字匹配类型
         * 可设置为 “或” 关系搜索，或 “与” 关系搜索。取值分别为 V2TIM_KEYWORD_MATCH_TYPE_OR 和 V2TIM_KEYWORD_MATCH_TYPE_AND。默认为 “或” 关系搜索。
         * @param keywordMatchType 关键字匹配类型
         * @return  V2NIMMessageSearchExParamsBuilder 实例
         */
        public V2NIMMessageSearchExParamsBuilder withKeywordMatchType(V2NIMSearchKeywordMathType keywordMatchType) {
            this.keywordMatchType = keywordMatchType;
            return this;
        }

        /**
         * 设置消息发送者，
         * 最多支持 5 个。
         * @param senderAccountIds 消息发送者
         * @return  V2NIMMessageSearchExParamsBuilder 实例
         */
        public V2NIMMessageSearchExParamsBuilder withSenderAccountIds(List<String> senderAccountIds) {
            this.senderAccountIds = senderAccountIds;
            return this;
        }

        /**
         * 设置消息类型，
         * 为null或空列表， 则表示查询所有消息类型
         * @param messageTypes 消息类型
         * @return  V2NIMMessageSearchExParamsBuilder 实例
         */
        public V2NIMMessageSearchExParamsBuilder withMessageTypes(List<V2NIMMessageType> messageTypes) {
            this.messageTypes = messageTypes;
            return this;
        }
        /**
         * 设置消息子类型，
         * 为null或空列表， 则表示查询所有消息子类型
         * @param messageSubtypes 消息子类型
         * @return V2NIMMessageSearchExParamsBuilder实例
         */
        public V2NIMMessageSearchExParamsBuilder withMessageSubtypes(List<Integer> messageSubtypes) {
            this.messageSubtypes = messageSubtypes;
            return this;
        }
        /**
         * 设置搜索的起始时间点，
         * 默认为 0（从现在开始搜索）。UTC 时间戳，单位：毫秒。
         * @param searchStartTime 搜索的起始时间点
         * @return V2NIMMessageSearchExParamsBuilder实例
         */
        public V2NIMMessageSearchExParamsBuilder withSearchStartTime(long searchStartTime) {
            this.searchStartTime = searchStartTime;
            return this;
        }

        /**
         * 设置搜索的过去时间范围，
         * 默认为 0（不限制时间范围）。24 x 60 x 60 x 1000 代表过去一天，单位：毫秒。
         * @param searchTimePeriod 搜索的过去时间范围
         * @return  V2NIMMessageSearchExParamsBuilder 实例
         */
        public V2NIMMessageSearchExParamsBuilder withSearchTimePeriod(long searchTimePeriod) {
            this.searchTimePeriod = searchTimePeriod;
            return this;
        }
        /**
         * 设置搜索的数量限制，
         * 最大100
         * @param limit 搜索的数量限制
         * @return V2NIMMessageSearchExParamsBuilder实例
         */
        public V2NIMMessageSearchExParamsBuilder withLimit(int limit) {
            this.limit = limit;
            return this;
        }

        /**
         * 设置检索方向
         * @param direction 检索方向
         * @return  V2NIMMessageSearchExParamsBuilder 实例
         */
        public V2NIMMessageSearchExParamsBuilder withSearchDirection(V2NIMSearchDirection direction) {
            if(direction == null){
                return this;
            }
            this.direction = direction;
            return this;
        }

        /**
         * 设置消息检索的策略
         * @param strategy 消息检索的策略
         * @return  V2NIMMessageSearchExParamsBuilder 实例
         */
        public V2NIMMessageSearchExParamsBuilder withSearchStrategy(V2NIMSearchStrategy strategy) {
            this.strategy = strategy;
            return this;
        }

        /**
         * 设置搜索的起始位置，第一次填写空字符串，续拉时填写上一次返回的 V2NIMMessageSearchResult 中的 nextPageToken。
         * @param pageToken 搜索的起始位置
         * @return V2NIMMessageSearchExParamsBuilder实例
         */
        public V2NIMMessageSearchExParamsBuilder withPageToken(String pageToken) {
            this.pageToken = pageToken;
            return this;
        }

        /**
         * 构建 V2NIMMessageSearchExParams 实例
         * @return V2NIMMessageSearchExParams 实例
         */
        public V2NIMMessageSearchExParams build() {
            return new V2NIMMessageSearchExParams(conversationId, keywordList, keywordMatchType, senderAccountIds, messageTypes, messageSubtypes, searchStartTime, searchTimePeriod, limit, direction, strategy, pageToken);
        }
    }
}