V2NIMMessageInsertParams.java

浏览该文件的文档.

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

/**
 * 本地消息插入参数类
 * 用于 insertMessageToLocalEx 接口
 */
public class V2NIMMessageInsertParams {

    /**
     * 会话ID（必填）
     */
    private String conversationId;

    /**
     * 消息发送者账号
     * 传空表示当前用户
     */
    private String senderId;

    /**
     * 指定插入消息时间
     * 传 0 则 sdk 使用当前 ntp 时间插入
     */
    private long createTime;

    /**
     * 是否需要更新会话的最后一条信息
     * 默认为 true
     */
    private boolean lastMessageUpdateEnabled = true;

    public V2NIMMessageInsertParams() {
    }

    /**
     * 构造函数
     *
     * @param conversationId          会话ID
     * @param senderId                消息发送者账号，传空表示当前用户
     * @param createTime              指定插入消息时间，传 0 则 sdk 使用当前 ntp 时间插入
     * @param lastMessageUpdateEnabled 是否需要更新会话的最后一条信息
     */
    public V2NIMMessageInsertParams(String conversationId, String senderId, long createTime, boolean lastMessageUpdateEnabled) {
        this.conversationId = conversationId;
        this.senderId = senderId;
        this.createTime = createTime;
        this.lastMessageUpdateEnabled = lastMessageUpdateEnabled;
    }

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

    /**
     * 设置会话ID
     *
     * @param conversationId 会话ID
     */
    public void setConversationId(String conversationId) {
        this.conversationId = conversationId;
    }

    /**
     * 获取消息发送者账号
     *
     * @return 消息发送者账号，可能为 null
     */
    public String getSenderId() {
        return senderId;
    }

    /**
     * 设置消息发送者账号
     *
     * @param senderId 消息发送者账号，传空表示当前用户
     */
    public void setSenderId(String senderId) {
        this.senderId = senderId;
    }

    /**
     * 获取指定插入消息时间
     *
     * @return 插入消息时间
     */
    public long getCreateTime() {
        return createTime;
    }

    /**
     * 设置指定插入消息时间
     *
     * @param createTime 指定插入消息时间，传 0 则 sdk 使用当前 ntp 时间插入
     */
    public void setCreateTime(long createTime) {
        this.createTime = createTime;
    }

    /**
     * 获取是否需要更新会话的最后一条信息
     *
     * @return 是否需要更新会话的最后一条信息
     */
    public boolean isLastMessageUpdateEnabled() {
        return lastMessageUpdateEnabled;
    }

    /**
     * 设置是否需要更新会话的最后一条信息
     *
     * @param lastMessageUpdateEnabled true: 需要，false: 不需要
     */
    public void setLastMessageUpdateEnabled(boolean lastMessageUpdateEnabled) {
        this.lastMessageUpdateEnabled = lastMessageUpdateEnabled;
    }

    /**
     * Builder 模式构建器，用于链式创建 V2NIMMessageInsertParams 实例
     */
    public static class V2NIMMessageInsertParamsBuilder {
        private String conversationId;
        private String senderId;
        private long createTime = 0;
        private boolean lastMessageUpdateEnabled = true;

        private V2NIMMessageInsertParamsBuilder() {}

        public static V2NIMMessageInsertParamsBuilder builder() {
            return new V2NIMMessageInsertParamsBuilder();
        }

        /**
         * 设置会话ID（必填）
         *
         * @param conversationId 会话ID
         * @return Builder 自身实例
         */
        public V2NIMMessageInsertParamsBuilder withConversationId(String conversationId) {
            this.conversationId = conversationId;
            return this;
        }

        /**
         * 设置消息发送者账号
         *
         * @param senderId 消息发送者账号，传空表示当前用户
         * @return Builder 自身实例
         */
        public V2NIMMessageInsertParamsBuilder withSenderId(String senderId) {
            this.senderId = senderId;
            return this;
        }

        /**
         * 设置指定插入消息时间
         *
         * @param createTime 指定插入消息时间，传 0 则 sdk 使用当前 ntp 时间插入
         * @return Builder 自身实例
         */
        public V2NIMMessageInsertParamsBuilder withCreateTime(long createTime) {
            this.createTime = createTime;
            return this;
        }

        /**
         * 设置是否需要更新会话的最后一条信息
         *
         * @param lastMessageUpdateEnabled true: 需要，false: 不需要
         * @return Builder 自身实例
         */
        public V2NIMMessageInsertParamsBuilder withLastMessageUpdateEnabled(boolean lastMessageUpdateEnabled) {
            this.lastMessageUpdateEnabled = lastMessageUpdateEnabled;
            return this;
        }

        /**
         * 构建最终的 V2NIMMessageInsertParams 对象
         *
         * @return 构造完成的对象
         */
        public V2NIMMessageInsertParams build() {
            return new V2NIMMessageInsertParams(conversationId, senderId, createTime, lastMessageUpdateEnabled);
        }
    }
}