QChatSystemNotification.java

浏览该文件的文档.

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

import com.netease.nimlib.sdk.qchat.enums.QChatSystemMessageToType;
import com.netease.nimlib.sdk.qchat.enums.QChatSystemNotificationType;
import com.netease.nimlib.sdk.qchat.model.systemnotification.QChatSystemNotificationAttachment;
import java.io.Serializable;
import java.util.List;

/**
 * 系统通知
 */
public interface QChatSystemNotification extends Serializable {

    /**
     * 通知所属的serverId
     */
    long getServerId();

    /**
     * 通知所属的channelId
     */
    long getChannelId();

    /**
     * 通知接收者账号列表
     */
    List<String> getToAccids();

    /**
     * 通知发送者的accid
     */
    String getFromAccount();

    /**
     * 通知发送对象类型
     */
    QChatSystemMessageToType getToType();

    /**
     * 通知发送者这的客户端类型
     */
    int getFromClientType();

    /**
     * 发送方设备id
     */
    String getFromDeviceId();

    /**
     * 发送方昵称
     */
    String getFromNick();

    /**
     * 消息发送时间
     */
    long getTime();

    /**
     * 通知更新时间
     */
    long getUpdateTime();

    /**
     * 通知类型, 参考QChatSystemMsgType
     * @return
     */
    QChatSystemNotificationType getType();

    /**
     * 获取通知类型裸数据，int类型，可能是新增通知类型，但是SDK还未更新，枚举还未添加
     * @return
     */
    int getRawType();

    /**
     * 客户端生成的消息id, 会用于去重
     */
    String getMsgIdClient();

    /**
     * 服务器生成的通知id，全局唯一
     */
    long getMsgIdServer();

    /**
     * 通知内容
     */
    String getBody();

    /**
     * 通知附件
     */
    String getAttach();

    /**
     * 通知附件字符串解析后的结构
     */
    QChatSystemNotificationAttachment getAttachment();

    /**
     * 扩展字段
     */
    String getExtension();


    /**
     * 状态，参考QChatSystemMsgStatus，可以自定义
     * @return
     */
    int getStatus();

    /**
     * 第三方自定义的推送属性，限制使用json格式
     */
    String getPushPayload();

    /**
     * 自定义推送文案
     */
    String getPushContent();

    /**
     * 是否存离线，只有toAccids不为空，才能设置为存离线
     */
    boolean isPersistEnable();

    /**
     * 是否需要推送，默认false
     */
    boolean isPushEnable();

    /**
     * 是否需要消息计数
     */
    boolean isNeedBadge();

    /**
     * 是否需要推送昵称
     */
    boolean isNeedPushNick();

    /**
     * 是否需要抄送,默认true
     * @return
     */
    boolean isRouteEnable();

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

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

    /**
     * 获取第三方回调回来的自定义扩展字段
     *
     * @return 第三方回调回来的自定义扩展字段
     */
    String getCallbackExtension();

}