QChatSendSystemNotificationParam.java

浏览该文件的文档.

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

import android.util.Log;
import androidx.annotation.NonNull;
import com.netease.nimlib.BuildConfig;
import com.netease.nimlib.log.model.LogDesensitizationConfigHelper;
import com.netease.nimlib.qchat.model.QChatSystemNotificationImpl;
import com.netease.nimlib.sdk.qchat.enums.QChatSystemMessageToType;
import com.netease.nimlib.sdk.qchat.enums.QChatSystemNotificationType;
import com.netease.nimlib.sdk.qchat.model.QChatSystemNotification;
import com.netease.nimlib.util.StringUtil;
import java.util.ArrayList;
import java.util.List;
import java.util.Map;

/**
 * "发送系统通知"接口入参
 */
public class QChatSendSystemNotificationParam {

    private static final String TAG = "SendSystemNotification";

    /**
     * 通知所属的serverId
     */
    @NonNull
    private final Long serverId;
    /**
     * 通知所属的channelId
     */
    private final Long channelId;
    /**
     * 通知接收者账号列表
     */
    private final List<String> toAccids;
    /**
     * 通知内容
     */
    private String body;
    /**
     * 通知附件
     */
    private String attach;
    /**
     * 扩展字段，SDK会转成json字符串使用
     */
    private Map<String, Object> extension;
    /**
     * 状态，可以自定义(status>= 10000)
     */
    private Integer status;
    /**
     * 第三方自定义的推送属性，SDK会转成json字符串使用
     */
    private Map<String, Object> pushPayload;
    /**
     * 自定义推送文案
     */
    private String pushContent;
    /**
     * 是否存离线，只有toAccids不为空，才能设置为存离线，默认false
     * 设置为离线的消息，发送时如果接收方不在线，上线后可以通过同步接口获得
     */
    private boolean persistEnable = false;
    /**
     * 是否需要推送，默认false
     */
    private boolean pushEnable = false;
    /**
     * 是否需要消息计数，默认true
     */
    private boolean needBadge = true;
    /**
     * 是否需要推送昵称，默认true
     */
    private boolean needPushNick = true;

    /**
     * 是否需要抄送，默认true
     */
    private boolean isRouteEnable = true;

    /**
     * 环境变量,用户可以根据不同的env配置不同的抄送和回调地址
     */
    private String env;

    /**
     * 通知发送对象类型，对应下面四种情况，不需要主动设置
     * <p>
     * QChatSystemMsgToType.SERVER：如果只填了serverId，则发送给serverId下的所有人
     * QChatSystemMsgToType.CHANNEL: 如果填了serverId+channelId，则发送给serverId+channelId下的所有人
     * QChatSystemMsgToType.SERVER_ACCIDS: 如果填了serverId+toAccids，则发送给server下的指定账号列表
     * QChatSystemMsgToType.CHANNEL_ACCIDS: 如果填了serverId+channelId+toAccids，则发送给server下某个channel里的指定账号列表
     */
    private final Integer toType;

    /**
     * 系统通知的uuid
     * 不是重发的系统通知，uuid有客户端SDK自动生成
     * 重发的系统通知，复用被重发系统通知的uuid
     */
    @NonNull
    private final String uuid;

    // QChatSystemMsgToType.SERVER：如果只填了serverId，则发送给serverId下的所有人



    /**
     * 通知给服务器
     * @param serverId 服务器id
     */
    public QChatSendSystemNotificationParam(long serverId) {
        this(serverId, 0L, new ArrayList<>(), QChatSystemMessageToType.SERVER.getValue());
    }

    /**
     * 通知给频道
     * @param serverId 服务器id
     * @param channelId 频道id
     */
    public QChatSendSystemNotificationParam(long serverId, long channelId) {
        this(serverId, channelId, new ArrayList<>(), QChatSystemMessageToType.CHANNEL.getValue());
    }

    /**
     * 通知给服务器成员
     * @param serverId 服务器id
     * @param toAccids 通知的账号列表
     */
    public QChatSendSystemNotificationParam(long serverId, List<String> toAccids) {
        this(serverId, 0L, toAccids, QChatSystemMessageToType.SERVER_ACCIDS.getValue());
    }

    /**
     * 通知给频道成员
     * @param serverId 服务器id
     * @param channelId 频道id
     * @param toAccids 通知的账号列表
     */
    public QChatSendSystemNotificationParam(long serverId, long channelId, List<String> toAccids) {
        this(serverId, channelId, toAccids, QChatSystemMessageToType.CHANNEL_ACCIDS.getValue());
    }

    private QChatSendSystemNotificationParam(long serverId, long channelId, List<String> toAccids, int toType) {
        this.serverId = serverId;
        if (channelId > 0) {
            this.channelId = channelId;
        } else {
            this.channelId = null;
        }
        this.toAccids = toAccids;

        this.toType = toType;

        this.uuid = StringUtil.get32UUID();
    }

    /**
     * 获取通知内容
     * @return
     */
    public String getBody() {
        return body;
    }

    /**
     * 设置通知内容
     * @param body
     */
    public void setBody(String body) {
        this.body = body;
    }

    /**
     * 设置通知附件
     * @param attach
     */
    public void setAttach(String attach) {
        this.attach = attach;
    }

    /**
     * 设置扩展字段
     * @param extension
     */
    public void setExtension(Map<String, Object> extension) {
        this.extension = extension;
    }

    /**
     * 如果设置状态，状态只能设置成自定义的状态(status>= 10000)，否则提示414参数错误
     * @param status
     */
    public void setStatus(Integer status) {
        this.status = status;
    }

    /**
     * 设置推送payload
     * @param pushPayload
     */
    public void setPushPayload(Map<String, Object> pushPayload) {
        this.pushPayload = pushPayload;
    }

    /**
     * 设置推送内容
     * @param pushContent
     */
    public void setPushContent(String pushContent) {
        this.pushContent = pushContent;
    }

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

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

    /**
     * 获取通知的账号列表
     * @return
     */
    public List<String> getToAccids() {
        return toAccids;
    }

    /**
     * 获取附件字符串
     * @return
     */
    public String getAttach() {
        return attach;
    }

    /**
     * 获取扩展字段
     * @return
     */
    public Map<String, Object> getExtension() {
        return extension;
    }

    /**
     * 获取状态
     * @return
     */
    public Integer getStatus() {
        return status;
    }

    /**
     * 获取推送payload
     * @return
     */
    public Map<String, Object> getPushPayload() {
        return pushPayload;
    }

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

    /**
     * 是否存离线
     * @return
     */
    public boolean isPersistEnable() {
        return persistEnable;
    }

    /**
     * 设置是否存离线
     * @param persistEnable
     */
    public void setPersistEnable(boolean persistEnable) {
        if (persistEnable && (toAccids == null || toAccids.isEmpty())) {
            if (BuildConfig.DEBUG) {
                throw new IllegalArgumentException("set persistEnable = true only if toAccids is not null");
            } else {
                if (LogDesensitizationConfigHelper.printToLogcat()) {
                    Log.e(TAG, "set persistEnable = true only if toAccids is not null");
                }
            }
        }
        this.persistEnable = persistEnable;
    }

    /**
     * 获取通知发送对象类型
     * @return
     */
    @NonNull
    public Integer getToType() {
        return toType;
    }

    /**
     * 是否需要推送，默认true
     * @return
     */
    public boolean isPushEnable() {
        return pushEnable;
    }

    /**
     * 设置是否需要推送
     * @param pushEnable
     */
    public void setPushEnable(boolean pushEnable) {
        this.pushEnable = pushEnable;
    }

    /**
     * 是否需要消息计数，默认true
     * @return
     */
    public boolean isNeedBadge() {
        return needBadge;
    }

    /**
     * 设置是否需要消息计数
     * @param needBadge
     */
    public void setNeedBadge(boolean needBadge) {
        this.needBadge = needBadge;
    }

    /**
     * 是否需要推送昵称，默认true
     * @return
     */
    public boolean isNeedPushNick() {
        return needPushNick;
    }

    /**
     * 设置是否需要推送昵称
     * @param needPushNick
     */
    public void setNeedPushNick(boolean needPushNick) {
        this.needPushNick = needPushNick;
    }

    /**
     * 是否需要抄送，默认true
     * @return
     */
    public boolean isRouteEnable() {
        return isRouteEnable;
    }

    /**
     * 设置是否需要抄送
     * @param routeEnable
     */
    public void setRouteEnable(boolean routeEnable) {
        isRouteEnable = routeEnable;
    }

    /**
     * 获取环境变量
     * 用户可以根据不同的env配置不同的抄送和回调地址
     *
     * @return 环境变量
     */
    public String getEnv() {
        return env;
    }

    /**
     * 设置环境变量
     * 用户可以根据不同的env配置不同的抄送和回调地址
     *
     * @param env 环境变量
     */
    public void setEnv(String env) {
        this.env = env;
    }

    /**
     * 获取系统通知类型，用户发送的系统通知一定是 QChatSystemMsgType.CUSTOM
     * @return
     */
    public QChatSystemNotificationType getType() {
        return QChatSystemNotificationType.CUSTOM;
    }

    /**
     * 获取系统通知uuid
     * @return
     */
    @NonNull
    public String getUuid() {
        return uuid;
    }

    /**
     * 转换成QChatSystemNotification
     * @return
     */
    public QChatSystemNotification toSystemNotification() {
        return QChatSystemNotificationImpl.from(this);
    }
}