QChatGetMessageHistoryParam.java

浏览该文件的文档.

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

import androidx.annotation.NonNull;

/**
 * "查询历史消息"接口入参
 */
public class QChatGetMessageHistoryParam {

    /**
     * 服务器Id
     */
    @NonNull
    private final Long serverId;
    /**
     * 频道Id
     */
    @NonNull
    private final Long channelId;
    /**
     * 起始时间
     */
    private Long fromTime;
    /**
     * 结束时间
     */
    private Long toTime;
    /**
     * excludeMsgId，排除消息id
     */
    private Long excludeMessageId;
    /**
     * limit，条数限制，默认100
     */
    private Integer limit;
    /**
     * reverse，是否反向
     */
    private Boolean reverse = false;
    /**
     * includeLocalMessages，是否包含本地发送失败的消息
     * 注意：如果设置为true后，以本地消息的时间戳作为查询边界时，该条消息可能会被重复查询。注意去重。
     */
    private Boolean includeLocalMessages = false;

    /**
     *
     * @param serverId 服务器Id
     * @param channelId 频道Id
     */
    public QChatGetMessageHistoryParam(long serverId, long channelId) {
        this.serverId = serverId;
        this.channelId = channelId;
    }

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

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

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

    /**
     * 设置起始时间
     * 如果要查最新的100条，则fromTime=0, toTime=0, limit=0, reverse=0
     * @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;
    }

    /**
     * 获取排除消息id
     * @return
     */
    public Long getExcludeMessageId() {
        return excludeMessageId;
    }

    /**
     * 设置排除消息id
     * @param excludeMsgId
     */
    public void setExcludeMessageId(Long excludeMsgId) {
        this.excludeMessageId = excludeMsgId;
    }

    /**
     * 获取条数限制
     * @return
     */
    public Integer getLimit() {
        return limit;
    }

    /**
     * 设置条数限制
     * @param limit
     */
    public void setLimit(Integer limit) {
        this.limit = limit;
    }

    /**
     * 是否反向
     * @return
     */
    public Boolean isReverse() {
        return reverse;
    }

    /**
     * 设置是否反向
     * @param reverse
     */
    public void setReverse(Boolean reverse) {
        this.reverse = reverse;
    }

    /**
     * 是否包含本地发送失败的消息
     * @return includeLocalMessages
     */
    public Boolean isIncludeLocalMessages() {
        return includeLocalMessages;
    }

    /**
     * 设置是否包含本地发送失败的消息
     * @param includeLocalMessages
     */
    public void setIncludeLocalMessages(Boolean includeLocalMessages) {
        this.includeLocalMessages = includeLocalMessages;
    }
}