V2NIMMessageConfig.java

浏览该文件的文档.

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

import java.io.Serializable;

/**
 * 用于配置 V2NIM 消息的参数类
 */
public class V2NIMMessageConfig implements Serializable {

    /**
     * 是否需要消息已读回执信息
     */
    private final boolean readReceiptEnabled;

    /**
     * 是否需要更新消息所属的会话信息
     */
    private final boolean lastMessageUpdateEnabled;

    /**
     * 是否需要在服务端保存历史消息
     */
    private final boolean historyEnabled;

    /**
     * 是否需要漫游消息
     */
    private final boolean roamingEnabled;

    /**
     * 是否需要发送方多端在线同步消息
     */
    private final boolean onlineSyncEnabled;

    /**
     * 是否需要存离线消息
     */
    private final boolean offlineEnabled;

    /**
     * 是否需要计未读
     */
    private final boolean unreadEnabled;

    private V2NIMMessageConfig() {
        this(DEFAULT_READ_RECEIPT_ENABLED, DEFAULT_LAST_MESSAGE_UPDATE_ENABLED, DEFAULT_HISTORY_ENABLED, DEFAULT_ROAMING_ENABLED, DEFAULT_ONLINE_SYNC_ENABLED, DEFAULT_OFFLINE_ENABLED, DEFAULT_UNREAD_ENABLED);
    }

    private V2NIMMessageConfig(boolean readReceiptEnabled, boolean lastMessageUpdateEnabled, boolean historyEnabled, boolean roamingEnabled, boolean onlineSyncEnabled, boolean offlineEnabled, boolean unreadEnabled) {
        this.readReceiptEnabled = readReceiptEnabled;
        this.lastMessageUpdateEnabled = lastMessageUpdateEnabled;
        this.historyEnabled = historyEnabled;
        this.roamingEnabled = roamingEnabled;
        this.onlineSyncEnabled = onlineSyncEnabled;
        this.offlineEnabled = offlineEnabled;
        this.unreadEnabled = unreadEnabled;
    }

    /**
     * 是否需要消息已读回执信息
     * @return true 需要，false 不需要
     */
    public boolean isReadReceiptEnabled() {
        return readReceiptEnabled;
    }

    /**
     * 是否需要更新消息所属的会话信息
     * @return true 需要，false 不需要
     */
    public boolean isLastMessageUpdateEnabled() {
        return lastMessageUpdateEnabled;
    }

    /**
     * 是否需要在服务端保存历史消息
     * @return true 需要，false 不需要
     */
    public boolean isHistoryEnabled() {
        return historyEnabled;
    }

    /**
     * 是否需要漫游消息
     * @return true 需要，false 不需要
     */
    public boolean isRoamingEnabled() {
        return roamingEnabled;
    }

    /**
     * 是否需要发送方多端在线同步消息
     * @return true 需要，false 不需要
     */
    public boolean isOnlineSyncEnabled() {
        return onlineSyncEnabled;
    }

    /**
     * 是否需要存离线消息
     * @return true 需要，false 不需要
     */
    public boolean isOfflineEnabled() {
        return offlineEnabled;
    }

    /**
     * 是否需要计未读
     * @return true 需要，false 不需要
     */
    public boolean isUnreadEnabled() {
        return unreadEnabled;
    }

    @Override
    public String toString() {
        return "V2NIMMessageConfig{" +
                "readReceiptEnabled=" + readReceiptEnabled +
                ", conversationUpdateEnabled=" + lastMessageUpdateEnabled +
                ", historyEnabled=" + historyEnabled +
                ", roamingEnabled=" + roamingEnabled +
                ", onlineSyncEnabled=" + onlineSyncEnabled +
                ", offlineEnabled=" + offlineEnabled +
                ", unreadEnabled=" + unreadEnabled +
                '}';
    }

    public static final boolean DEFAULT_READ_RECEIPT_ENABLED        = false;
    public static final boolean DEFAULT_LAST_MESSAGE_UPDATE_ENABLED = true;
    public static final boolean DEFAULT_HISTORY_ENABLED             = true;
    public static final boolean DEFAULT_ROAMING_ENABLED = true;
    public static final boolean DEFAULT_ONLINE_SYNC_ENABLED = true;
    public static final boolean DEFAULT_OFFLINE_ENABLED = true;
    public static final boolean DEFAULT_UNREAD_ENABLED = true;

    /**
     * V2NIMMessageConfig 构建器
     */
    public static final class V2NIMMessageConfigBuilder {
        private boolean readReceiptEnabled = DEFAULT_READ_RECEIPT_ENABLED;
        private boolean lastMessageUpdateEnabled = DEFAULT_LAST_MESSAGE_UPDATE_ENABLED;
        private boolean historyEnabled = DEFAULT_HISTORY_ENABLED;
        private boolean roamingEnabled = DEFAULT_ROAMING_ENABLED;
        private boolean onlineSyncEnabled = DEFAULT_ONLINE_SYNC_ENABLED;
        private boolean offlineEnabled = DEFAULT_OFFLINE_ENABLED;
        private boolean unreadEnabled = DEFAULT_UNREAD_ENABLED;

        private V2NIMMessageConfigBuilder() {
        }

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

        /**
         * 设置是否需要消息已读回执信息
         * @param readReceiptEnabled true 需要，false 不需要
         * @return V2NIMMessageConfigBuilder 实例
         */
        public V2NIMMessageConfigBuilder withReadReceiptEnabled(boolean readReceiptEnabled) {
            this.readReceiptEnabled = readReceiptEnabled;
            return this;
        }
        /**
         * 设置是否需要更新消息所属的会话信息
         * @param lastMessageUpdateEnabled true 需要，false 不需要
         * @return V2NIMMessageConfigBuilder 实例
         */
        public V2NIMMessageConfigBuilder withLastMessageUpdateEnabled(boolean lastMessageUpdateEnabled) {
            this.lastMessageUpdateEnabled = lastMessageUpdateEnabled;
            return this;
        }

        /**
         * 设置是否需要在服务端保存历史消息
         * @param historyEnabled true 需要，false 不需要
         * @return V2NIMMessageConfigBuilder 实例
         */
        public V2NIMMessageConfigBuilder withHistoryEnabled(boolean historyEnabled) {
            this.historyEnabled = historyEnabled;
            return this;
        }
        /**
         * 设置是否需要漫游消息
         * @param roamingEnabled true 需要，false 不需要
         * @return V2NIMMessageConfigBuilder 实例
         */
        public V2NIMMessageConfigBuilder withRoamingEnabled(boolean roamingEnabled) {
            this.roamingEnabled = roamingEnabled;
            return this;
        }
        /**
         * 设置是否需要发送方多端在线同步消息
         * @param onlineSyncEnabled true 需要，false 不需要
         * @return V2NIMMessageConfigBuilder 实例
         */
        public V2NIMMessageConfigBuilder withOnlineSyncEnabled(boolean onlineSyncEnabled) {
            this.onlineSyncEnabled = onlineSyncEnabled;
            return this;
        }
        /**
         * 设置是否需要存离线消息
         * @param offlineEnabled true 需要，false 不需要
         * @return V2NIMMessageConfigBuilder 实例
         */
        public V2NIMMessageConfigBuilder withOfflineEnabled(boolean offlineEnabled) {
            this.offlineEnabled = offlineEnabled;
            return this;
        }
        /**
         * 设置是否需要计未读
         * @param unreadEnabled true 需要，false 不需要
         * @return V2NIMMessageConfigBuilder 实例
         */
        public V2NIMMessageConfigBuilder withUnreadEnabled(boolean unreadEnabled) {
            this.unreadEnabled = unreadEnabled;
            return this;
        }

        /**
         * 构建 V2NIMMessageConfig 实例
         * @return V2NIMMessageConfig 实例
         */
        public V2NIMMessageConfig build() {
            return new V2NIMMessageConfig(readReceiptEnabled, lastMessageUpdateEnabled, historyEnabled, roamingEnabled, onlineSyncEnabled, offlineEnabled, unreadEnabled);
        }
    }
}