V2NIMImportMessagesToLocalOption.java

浏览该文件的文档.

package com.netease.nimlib.sdk.v2.message.option;
/**
 * V2NIMImportMessagesToLocalOption类
 * <p>
 * 此类用于设置导入消息到本地的选项。
 */
public final class V2NIMImportMessagesToLocalOption {

    /**
     * 是否创建会话, 默认为true
     * true：触发会话变更，如果会话入口不存在，则同步创建会话
     * false：不触发会话变更，不会主动创建会话入口， 依赖于后续收发消息后产生
     */
    private final boolean shouldUpdateConversation;

    /**
     * 默认构造方法
     * <p>
     * 创建一个新的V2NIMImportMessagesToLocalOption实例，默认会创建会话。
     */
    public V2NIMImportMessagesToLocalOption() {
        this.shouldUpdateConversation = true;
    }

    /**
     * 构造方法
     *
     * @param shouldUpdateConversation 是否创建会话, 默认为true
     *                                   true：如果会话入口不存在，则同步创建会话
     *                                   false：则不会主动创建会话入口， 依赖于后续收发消息后产生
     */
    public V2NIMImportMessagesToLocalOption(boolean shouldUpdateConversation) {
        this.shouldUpdateConversation = shouldUpdateConversation;
    }

    /**
     * 获取是否更新会话的标志
     * <p>
     * true：触发会话变更，如果会话入口不存在，则同步创建会话
     * false：不触发会话变更，不会主动创建会话入口， 依赖于后续收发消息后产生
     *
     * @return 是否更新会话的标志
     */
    public boolean isShouldUpdateConversation() {
        return shouldUpdateConversation;
    }

    /**
     * 重写toString方法
     *
     * @return 返回对象的字符串表示
     */
    @Override
    public String toString() {
        return "V2NIMImportMessagesToLocalOption [shouldUpdateConversation=" + shouldUpdateConversation + "]";
    }

    /**
     * V2NIMImportMessagesToLocalOption构建器
     */
    public static final class V2NIMImportMessagesToLocalOptionBuilder {

        private boolean shouldUpdateConversation = true;

        /**
         * 私有构造方法，防止外部实例化
         */
        private V2NIMImportMessagesToLocalOptionBuilder() {
        }

        /**
         * 创建V2NIMImportMessagesToLocalOption构建器
         * @return 返回V2NIMImportMessagesToLocalOption构建器对象
         */
        public static V2NIMImportMessagesToLocalOptionBuilder builder() {
            return new V2NIMImportMessagesToLocalOptionBuilder();
        }

        /**
         * 设置是否更新会话的标志
         * @param shouldUpdateConversation 是否更新会话的标志
         * @return
         */
        public V2NIMImportMessagesToLocalOptionBuilder shouldUpdateConversation(boolean shouldUpdateConversation) {
            this.shouldUpdateConversation = shouldUpdateConversation;
            return this;
        }

        /**
         * 构建V2NIMImportMessagesToLocalOption对象
         *
         * @return 返回构建好的V2NIMImportMessagesToLocalOption对象
         */
        public V2NIMImportMessagesToLocalOption build() {
            return new V2NIMImportMessagesToLocalOption(shouldUpdateConversation);
        }
    }
}