SystemMessage.java

浏览该文件的文档.

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

import android.text.TextUtils;

import com.netease.nimlib.log.NimLog;
import com.netease.nimlib.sdk.msg.constant.SystemMessageStatus;
import com.netease.nimlib.sdk.msg.constant.SystemMessageType;

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

import java.io.Serializable;

/**
 * 系统通知数据结构
 */
public class SystemMessage implements Serializable {

    private static final String TAG = "SystemMessage";
    private long messageId;

    private SystemMessageType type;

    private String fromAccount;

    private String targetId;

    private long time;

    private SystemMessageStatus status;

    private String content;

    private String attach;

    private Object attachObject;

    private boolean unread;

    private String customInfo;

    /**
     * 获取系统通知ID
     *
     * @return 消息ID
     */
    public long getMessageId() {
        return messageId;
    }

    /**
     * 设置系统通知ID
     *
     * @param messageId 消息ID
     */
    public void setMessageId(long messageId) {
        this.messageId = messageId;
    }

    /**
     * 获取系统通知类型
     *
     * @return 系统通知类型
     */
    public SystemMessageType getType() {
        return type;
    }

    /**
     * 设置系统通知类型
     *
     * @param type 类型
     */
    public void setType(int type) {
        this.type = SystemMessageType.typeOfValue(type);
    }

    /**
     * 该系统通知的发起方帐号。<br>
     * 例如：申请加入群的申请者，同意入群邀请的同意者
     *
     * @return 发起方帐号
     */
    public String getFromAccount() {
        return fromAccount;
    }

    /**
     * 设置发起方帐号
     *
     * @param fromAccount 发起方帐号
     */
    public void setFromAccount(String fromAccount) {
        this.fromAccount = fromAccount;
    }

    /**
     * 获取系统通知的目标ID.<br>
     * 例如：申请入群，被拒绝申请的群ID，
     *
     * @return 目标ID
     */
    public String getTargetId() {
        return targetId;
    }

    /**
     * 设置系统通知的目标ID
     *
     * @param targetId 目标ID
     */
    public void setTargetId(String targetId) {
        this.targetId = targetId;
    }

    /**
     * 获取系统通知的发出时间，单位为ms
     *
     * @return 发出时间
     */
    public long getTime() {
        return time;
    }

    /**
     * 设置系统通知的发出时间
     *
     * @param time 发出时间
     */
    public void setTime(long time) {
        this.time = time;
    }

    /**
     * 获取系统通知的处理状态
     *
     * @return 状态
     */
    public SystemMessageStatus getStatus() {
        return status;
    }

    /**
     * 设置系统通知的处理状态
     *
     * @param status 状态
     */
    public void setStatus(SystemMessageStatus status) {
        this.status = status;
    }

    /**
     * 获取系统通知的内容。 <br>
     * 例如：申请附言，拒绝理由
     *
     * @return 内容
     */
    public String getContent() {
        return content;
    }

    /**
     * 设置系统通知的内容
     *
     * @param content 内容
     */
    public void setContent(String content) {
        this.content = content;
    }

    /**
     * 获取系统通知的附件内容。<br>
     * 该字段用于日后扩展
     *
     * @return 附件
     */
    public String getAttach() {
        return attach;
    }

    /**
     * 设置系统通知的附件内容。
     *
     * @param attach 附件
     */
    public void setAttach(String attach) {
        if (!TextUtils.isEmpty(attach)) {
            try {
                JSONObject object = new JSONObject(attach);
                customInfo = object.optString("attach");
            } catch (JSONException e) {
                e.printStackTrace();
                NimLog.e(TAG, "get custom info err , attach = " + attach, e);
            }
        }
        this.attach = attach;
    }

    /**
     * 获取系统通知附件内容解析后的对象。<br>
     * 对于第三方app自定义消息类型，该域可自行解析。<br>
     * 对于内置的系统通知类型，该域的返回值定义见{@link com.netease.nimlib.sdk.msg.constant.SystemMessageType}
     *
     * @return 附件对象
     */
    public Object getAttachObject() {
        return attachObject;
    }

    /**
     * 设置解析后的附件对象。<br>
     * 该字段和attach是独立的，以便第三方app缓存自己的附件对象。
     *
     * @param object 附件对象
     */
    public void setAttachObject(Object object) {
        this.attachObject = object;
    }

    /**
     * 判断该系统通知是否已读
     *
     * @return true表示未读，false表示已读
     */
    public boolean isUnread() {
        return unread;
    }

    /**
     * 设置改系统通知已读/未读
     *
     * @param unread true表示未读，false表示已读
     */
    public void setUnread(boolean unread) {
        this.unread = unread;
    }


    /**
     * 获取自定义信息，目前只有拉人入群时可以设置
     *
     * @return customInfo
     */
    public String getCustomInfo() {

        return customInfo;
    }
}