NIMMessagePushConfig.java

浏览该文件的文档.

package com.netease.nimlib.sdk.msg.config;

import com.netease.nimlib.log.NimLog;
import com.netease.nimlib.util.EncryptUtil;
import java.io.Serializable;
import java.util.List;

/**
 * NIMMessagePushConfig 类
 * <p>
 * 该类用于配置网易云信消息推送的相关参数。
 * 它实现了 Serializable 接口，可以进行序列化。
 */
public class NIMMessagePushConfig implements Serializable {

    /**
     * 是否需要推送消息。
     */
    private final boolean pushEnabled;

    /**
     * 是否需要推送消息发送者昵称。
     */
    private final boolean pushNickEnabled;

    /**
     * 推送文案
     */
    private final String pushContent;

    /**
     * 推送数据
     */
    private final String pushPayload;

    /**
     * 强制推送，忽略用户消息提醒相关设置，只对消息类型有效
     */
    private final boolean forcePush;

    /**
     * 强制推送文案，只对消息类型有效
     */
    private final String forcePushContent;

    /**
     * 强制推送目标账号列表，只对消息类型有效
     */
    private final List<String> forcePushAccountIds;


    /**
     * 私有构造函数
     * 使用默认值初始化对象
     */
    private NIMMessagePushConfig() {
        this(DEFAULT_PUSH_ENABLE, DEFAULT_PUSH_NICK_ENABLE, null, null, false, null, null);
    }

    /**
     * 私有构造函数
     *
     * @param pushEnabled         是否启用推送
     * @param pushNickEnabled     是否推送发送者昵称
     * @param pushContent         推送内容
     * @param pushPayload         推送数据
     * @param forcePush           是否强制推送
     * @param forcePushContent    强制推送内容
     * @param forcePushAccountIds 强制推送目标账号列表
     */
    private NIMMessagePushConfig(boolean pushEnabled, boolean pushNickEnabled, String pushContent, String pushPayload, boolean forcePush,
            String forcePushContent, List<String> forcePushAccountIds) {
        this.pushEnabled = pushEnabled;
        this.pushNickEnabled = pushNickEnabled;
        this.pushContent = pushContent;
        this.pushPayload = pushPayload;
        this.forcePush = forcePush;
        this.forcePushContent = forcePushContent;
        this.forcePushAccountIds = forcePushAccountIds;
    }

    /**
     * 获取是否启用推送
     *
     * @return 是否启用推送
     */
    public boolean isPushEnabled() {
        return pushEnabled;
    }

    /**
     * 获取是否推送发送者昵称
     *
     * @return 是否推送发送者昵称
     */
    public boolean isPushNickEnabled() {
        return pushNickEnabled;
    }

    /**
     * 获取推送内容
     *
     * @return 推送内容
     */
    public String getPushContent() {
        return pushContent;
    }

    /**
     * 获取推送数据
     *
     * @return 推送数据
     */
    public String getPushPayload() {
        return pushPayload;
    }

    /**
     * 获取是否强制推送
     *
     * @return 是否强制推送
     */
    public boolean isForcePush() {
        return forcePush;
    }

    /**
     * 获取强制推送内容
     *
     * @return 强制推送内容
     */
    public String getForcePushContent() {
        return forcePushContent;
    }

    /**
     * 获取强制推送目标账号列表
     *
     * @return 强制推送目标账号列表
     */
    public List<String> getForcePushAccountIds() {
        return forcePushAccountIds;
    }

    /**
     * 重写toString方法
     *
     * @return 对象的字符串表示
     */
    @Override
    public String toString() {
        if (NimLog.isDebugLog()) {
            return "NIMMessagePushConfig{" + "pushEnabled=" + pushEnabled + ", pushNickEnabled=" + pushNickEnabled + ", content='" + pushContent + '\''
                    + ", payload='" + pushPayload + '\'' + ", forcePush=" + forcePush + ", forcePushContent='" + forcePushContent + '\''
                    + ", forcePushAccountIds=" + forcePushAccountIds + '}';
        }
        else {
            return "NIMMessagePushConfig{" + "pushEnabled=" + pushEnabled + ", pushNickEnabled=" + pushNickEnabled + ", content='"
                    + EncryptUtil.encryptBase64(pushContent) + '\'' + ", payload='" + EncryptUtil.encryptBase64(pushPayload) + '\'' + ", forcePush=" + forcePush
                    + ", forcePushContent='" + "*******" + '\'' + ", forcePushAccountIds=" + forcePushAccountIds + '}';
        }

    }

    public static final boolean DEFAULT_PUSH_ENABLE      = true;
    public static final boolean DEFAULT_PUSH_NICK_ENABLE = true;

    /**
     * NIMMessagePushConfigBuilder 内部类
     * <p>
     * 用于构建 NIMMessagePushConfig 对象的 Builder 类
     */
    public static final class NIMMessagePushConfigBuilder {

        private boolean      pushEnabled     = DEFAULT_PUSH_ENABLE;
        private boolean      pushNickEnabled = DEFAULT_PUSH_NICK_ENABLE;
        private String       content;
        private String       payload;
        private boolean      forcePush;
        private String       forcePushContent;
        private List<String> forcePushAccountIds;

        private NIMMessagePushConfigBuilder() {
        }

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

        /**
         * 设置是否启用推送
         *
         * @param pushEnabled 是否启用推送
         *
         * @return NIMMessagePushConfigBuilder 实例
         */
        public NIMMessagePushConfigBuilder withPushEnabled(boolean pushEnabled) {
            this.pushEnabled = pushEnabled;
            return this;
        }

        /**
         * 设置是否推送发送者昵称
         *
         * @param pushNickEnabled 是否推送发送者昵称
         *
         * @return NIMMessagePushConfigBuilder 实例
         */
        public NIMMessagePushConfigBuilder withPushNickEnabled(boolean pushNickEnabled) {
            this.pushNickEnabled = pushNickEnabled;
            return this;
        }

        /**
         * 设置推送内容
         *
         * @param content 推送内容
         *
         * @return NIMMessagePushConfigBuilder 实例
         */
        public NIMMessagePushConfigBuilder withContent(String content) {
            this.content = content;
            return this;
        }

        /**
         * 设置推送数据
         *
         * @param payload 推送数据
         *
         * @return NIMMessagePushConfigBuilder 实例
         */
        public NIMMessagePushConfigBuilder withPayload(String payload) {
            this.payload = payload;
            return this;
        }

        /**
         * 设置是否强制推送
         *
         * @param forcePush 是否强制推送
         *
         * @return NIMMessagePushConfigBuilder 实例
         */
        public NIMMessagePushConfigBuilder withForcePush(boolean forcePush) {
            this.forcePush = forcePush;
            return this;
        }

        /**
         * 设置强制推送内容
         *
         * @param forcePushContent 强制推送内容
         *
         * @return NIMMessagePushConfigBuilder 实例
         */
        public NIMMessagePushConfigBuilder withForcePushContent(String forcePushContent) {
            this.forcePushContent = forcePushContent;
            return this;
        }

        /**
         * 设置强制推送目标账号列表
         *
         * @param forcePushAccountIds 强制推送目标账号列表
         *
         * @return NIMMessagePushConfigBuilder 实例
         */
        public NIMMessagePushConfigBuilder withForcePushAccountIds(List<String> forcePushAccountIds) {
            this.forcePushAccountIds = forcePushAccountIds;
            return this;
        }

        /**
         * 构建 NIMMessagePushConfig 对象
         *
         * @return NIMMessagePushConfig 对象
         */
        public NIMMessagePushConfig build() {
            return new NIMMessagePushConfig(pushEnabled, pushNickEnabled, content, payload, forcePush, forcePushContent, forcePushAccountIds);
        }
    }
}