QChatSearchMsgByPageParam.java

浏览该文件的文档.

package com.netease.nimlib.sdk.qchat.param;

import androidx.annotation.NonNull;
import com.netease.nimlib.sdk.msg.constant.MsgTypeEnum;
import com.netease.nimlib.sdk.qchat.enums.QChatMessageSearchSortEnum;
import java.util.List;

/**
 * 检索消息的接口入参
 */
public class QChatSearchMsgByPageParam {

    /**
     * 检索关键字，目标检索消息名称
     */
    private String keyword;
    /**
     * 服务器ID
     */
    private final long serverId;

    /**
     * 频道ID
     */
    private Long channelId;

    /**
     * 消息发送者accid
     */
    private String fromAccount;

    /**
     * 查询时间范围的开始时间
     */
    private Long fromTime;

    /**
     * 查询时间范围的结束时间，要求比开始时间大
     */
    private Long toTime;

    /**
     * 搜索的消息类型列表，目前仅支持{@link MsgTypeEnum#text,MsgTypeEnum#image,MsgTypeEnum#video,MsgTypeEnum#file}
     */
    @NonNull
    private final List<MsgTypeEnum> msgTypes;
    /**
     * 搜索的消息子类型列表
     */
    private List<Integer> subTypes;
    /**
     * 是否包含自己的消息
     */
    private Boolean isIncludeSelf;

    /**
     * 排序规则 true：正序；false：倒序（默认）
     */
    private Boolean order;
    /**
     * 检索返回的最大记录数，最大和默认都是100
     */
    private Integer                    limit;
    /**
     * 排序条件
     */
    private QChatMessageSearchSortEnum sort;

    /**
     * 查询游标，下次查询的起始位置,第一页设置为null，查询下一页是传入上一页返回的cursor
     */
    private String cursor;


    /**
     *
     * @param serverId 服务器ID
     * @param msgTypes 搜索的消息类型列表
     */
    public QChatSearchMsgByPageParam(long serverId, @NonNull List<MsgTypeEnum> msgTypes) {
        this.serverId = serverId;
        this.msgTypes = msgTypes;
    }

    /**
     *
     * @param keyword 检索关键字
     * @param serverId 服务器Id
     * @param channelId 频道Id
     * @param fromAccount 消息发送者accid
     * @param fromTime 查询开始时间
     * @param toTime 查询结束时间
     * @param msgTypes 搜索的消息类型列表
     * @param subTypes 搜索的消息子类型列表
     * @param isIncludeSelf 是否包含自己发送的消息
     * @param order 排序规则 true：正序；false：倒序（默认）
     * @param limit 检索返回的最大记录数，最大和默认都是100
     * @param sort 排序条件
     * @param cursor 查询游标，下次查询的起始位置,第一页设置为null，查询下一页是传入上一页返回的cursor
     */
    public QChatSearchMsgByPageParam(String keyword, long serverId, Long channelId, String fromAccount, Long fromTime, Long toTime,
            @NonNull List<MsgTypeEnum> msgTypes, List<Integer> subTypes, Boolean isIncludeSelf, Boolean order, Integer limit,
            QChatMessageSearchSortEnum sort, String cursor) {
        this.keyword = keyword;
        this.serverId = serverId;
        this.channelId = channelId;
        this.fromAccount = fromAccount;
        this.fromTime = fromTime;
        this.toTime = toTime;
        this.msgTypes = msgTypes;
        this.subTypes = subTypes;
        this.isIncludeSelf = isIncludeSelf;
        this.order = order;
        this.limit = limit;
        this.sort = sort;
        this.cursor = cursor;
    }

    /**
     * 获取检索关键字
     * @return
     */
    public String getKeyword() {
        return keyword;
    }

    /**
     * 设置检索关键字
     * @param keyword
     */
    public void setKeyword(String keyword) {
        this.keyword = keyword;
    }

    /**
     * 获取服务器Id
     * @return
     */
    public long getServerId() {
        return serverId;
    }

    /**
     * 获取频道Id
     * @return
     */
    public Long getChannelId() {
        return channelId;
    }

    /**
     * 设置频道Id
     * @param channelId
     */
    public void setChannelId(Long channelId) {
        this.channelId = channelId;
    }

    /**
     * 获取消息发送者accid
     * @return
     */
    public String getFromAccount() {
        return fromAccount;
    }

    /**
     * 设置消息发送者accid
     * @param fromAccount
     */
    public void setFromAccount(String fromAccount) {
        this.fromAccount = fromAccount;
    }

    /**
     * 获取查询开始时间
     * @return
     */
    public Long getFromTime() {
        return fromTime;
    }

    /**
     * 设置查询开始时间
     * @param fromTime
     */
    public void setFromTime(Long fromTime) {
        this.fromTime = fromTime;
    }

    /**
     * 获取查询结束时间
     * @return
     */
    public Long getToTime() {
        return toTime;
    }

    /**
     * 设置查询结束时间
     * @param toTime
     */
    public void setToTime(Long toTime) {
        this.toTime = toTime;
    }

    /**
     *
     * 获取搜索的消息类型列表
     * @return
     */
    @NonNull
    public List<MsgTypeEnum> getMsgTypes() {
        return msgTypes;
    }

    /**
     * 获取搜索的消息子类型列表
     * @return
     */
    public List<Integer> getSubTypes() {
        return subTypes;
    }

    /**
     * 设置搜索的消息子类型列表
     * @param subTypes
     */
    public void setSubTypes(List<Integer> subTypes) {
        this.subTypes = subTypes;
    }

    /**
     * 获取是否包含自己发送的消息
     * @return
     */
    public Boolean isIncludeSelf() {
        return isIncludeSelf;
    }

    /**
     * 设置是否包含自己发送的消息
     * @param includeSelf
     */
    public void setIncludeSelf(Boolean includeSelf) {
        isIncludeSelf = includeSelf;
    }

    /**
     * 获取排序规则 true：正序；false：倒序（默认）
     * @return
     */
    public Boolean getOrder() {
        return order;
    }

    /**
     * 设置排序规则 true：正序；false：倒序（默认）
     * @param order
     */
    public void setOrder(Boolean order) {
        this.order = order;
    }

    /**
     * 获取检索返回的最大记录数，最大和默认都是100
     * @return
     */
    public Integer getLimit() {
        return limit;
    }

    /**
     * 设置检索返回的最大记录数，最大和默认都是100
     * @param limit
     */
    public void setLimit(Integer limit) {
        this.limit = limit;
    }

    /**
     * 获取排序条件
     * @return
     */
    public QChatMessageSearchSortEnum getSort() {
        return sort;
    }

    /**
     * 设置排序条件
     * @param sort
     */
    public void setSort(QChatMessageSearchSortEnum sort) {
        this.sort = sort;
    }

    /**
     * 获取查询游标，下次查询的起始位置,第一页设置为null，查询下一页是传入上一页返回的cursor
     * @return
     */
    public String getCursor() {
        return cursor;
    }

    /**
     * 设置查询游标，下次查询的起始位置,第一页设置为null，查询下一页是传入上一页返回的cursor
     * @param cursor
     */
    public void setCursor(String cursor) {
        this.cursor = cursor;
    }
}