CustomNotification.java

浏览该文件的文档.

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

import com.netease.nimlib.sdk.msg.constant.SessionTypeEnum;

import org.json.JSONException;
import org.json.JSONObject;

import java.io.Serializable;
import java.util.Map;

/**
 * 自定义通知。<br>
 * 区别于IMMessage，SDK仅透传该类型消息，不负责解析和存储。消息内容由第三方APP自由扩展。<br>
 * 自定义通知消息可选择要不要发送给当前不在线的用户。<br>
 */
public class CustomNotification implements Serializable {

    private String sessionId;

    private SessionTypeEnum sessionType;

    private String fromAccount;

    private long time;

    private String content;

    private boolean sendToOnlineUserOnly = true;

    private String apnsText;

    private Map<String, Object> pushPayload;

    private CustomNotificationConfig config;

    private NIMAntiSpamOption antiSpamOption;

    private String env;
    /**
     * 获取聊天对象的Id（好友帐号，群ID等）。
     *
     * @return 聊天对象ID
     */
    public String getSessionId() {
        return sessionId;
    }

    /**
     * 设置聊天对象ID。
     *
     * @param sessionId 聊天对象ID
     */
    public void setSessionId(String sessionId) {
        this.sessionId = sessionId;
    }

    /**
     * 获取会话类型。
     *
     * @return 会话类型
     */
    public SessionTypeEnum getSessionType() {
        return sessionType;
    }

    /**
     * 设置会话类型。
     *
     * @param sessionType 会话类型
     */
    public void setSessionType(SessionTypeEnum sessionType) {
        this.sessionType = sessionType;
    }

    /**
     * 获取该通知的发出者帐号。
     *
     * @return 发出者帐号
     */
    public String getFromAccount() {
        return fromAccount;
    }

    /**
     * 设置该通知的发起者帐号
     *
     * @param fromAccount 发起者帐号
     */
    public void setFromAccount(String fromAccount) {
        this.fromAccount = fromAccount;
    }

    /**
     * 获取消息时间，单位为ms
     */
    public long getTime() {
        return time;
    }

    /**
     * 设置消息时间
     */
    public void setTime(long time) {
        this.time = time;
    }

    /**
     * 获取消息具体内容。
     */
    public String getContent() {
        return content;
    }

    /**
     * 设置消息内容。
     */
    public void setContent(String content) {
        this.content = content;
    }

    /**
     * 该消息是否只发送当前在线的用户/群组。
     */
    public boolean isSendToOnlineUserOnly() {
        return sendToOnlineUserOnly;
    }

    /**
     * 设置该消息是否只发送给当前在线的用户。<br>
     * 如果该值为true，只有接收方当前在线时，才能收到该消息。<br>
     * 如果该值为false，如果接收方当前在线，会立即收到该消息，如果不在线，会在下一次登录后收到该消息。
     * 设置为false后，该消息和普通IM消息一样保证必达。<br>
     *
     * @param sendToOnlineUserOnly 是否只发送给在线用户/群组，云信SDK 4.1版本开始支持群组离线自定义通知.
     */
    public void setSendToOnlineUserOnly(boolean sendToOnlineUserOnly) {
        this.sendToOnlineUserOnly = sendToOnlineUserOnly;
    }

    /**
     * 获取如果接收方是iOS设备登录，该消息的APNS推送文本内容
     *
     * @return apns推送文本设置
     */
    public String getApnsText() {
        return apnsText;
    }

    /**
     * 设置如果接收方是iOS设备登录，该消息的APNS推送文本内容
     *
     * @param apnsText apns推送文本设置
     */
    public void setApnsText(String apnsText) {
        this.apnsText = apnsText;
    }

    /**
     * 获取第三方自定义的推送属性
     *
     * @return 第三方自定义的推送属性Map
     */
    public Map<String, Object> getPushPayload() {
        return pushPayload;
    }

    /**
     * 设置第三方自定义的推送属性
     *
     * @param pushPayload 第三方自定义的推送属性Map，开发者需要保证此Map能够转换为JsonObject，属性内容最大长度2048字节
     */
    public void setPushPayload(Map<String, Object> pushPayload) {
        this.pushPayload = pushPayload;
    }

    public CustomNotificationConfig getConfig() {
        return config;
    }

    public void setConfig(CustomNotificationConfig config) {
        this.config = config;
    }

    /**
     * 获取反垃圾配置
     *
     * @return
     */
    public NIMAntiSpamOption getNIMAntiSpamOption() {
        return antiSpamOption;
    }

    /**
     *设置反垃圾配置项
     *
     * @param antiSpamOption
     */
    public void setNIMAntiSpamOption(NIMAntiSpamOption antiSpamOption) {
        this.antiSpamOption = antiSpamOption;
    }

    /**
     * 获取环境变量
     * 用于指向不同的抄送，第三方回调等配置
     *
     * @return 环境变量
     */
    public String getEnv() {
        return this.env;
    }

    /**
     * 设置环境变量
     * 用于指向不同的抄送，第三方回调等配置
     *
     * @param env 环境变量
     */
    public void setEnv(String env) {
        this.env = env;
    }

    public JSONObject toJsonObj() {
        JSONObject obj = new JSONObject();
        try {
            obj.putOpt("sessionId", sessionId);
            obj.putOpt("sessionType", sessionType);
            obj.putOpt("fromAccount", fromAccount);
            obj.putOpt("time", time);
            obj.putOpt("content", content);
            obj.putOpt("sendToOnlineUserOnly", sendToOnlineUserOnly);
            obj.putOpt("apnsText", apnsText);
            obj.putOpt("pushPayload", pushPayload);
            obj.putOpt("config", config);
            obj.putOpt("antiSpamOption", antiSpamOption);
            obj.putOpt("env", env);
        } catch (JSONException e) {
            e.printStackTrace();
        }
        return obj;
    }
}