QChatMessageInternal.java

浏览该文件的文档.

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

import com.netease.nimlib.sdk.msg.attachment.MsgAttachment;
import com.netease.nimlib.sdk.msg.constant.AttachStatusEnum;
import com.netease.nimlib.sdk.msg.constant.MsgStatusEnum;
import com.netease.nimlib.sdk.msg.constant.MsgTypeEnum;
import com.netease.nimlib.sdk.qchat.enums.QChatNotifyReason;

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

/**
 * 圈组消息
 */
public interface QChatMessageInternal extends Serializable {

    /**
     * 获取消息所属的serverId
     * @return 消息所属的serverId
     */
    long getQChatServerId();

    /**
     * 获取消息所属的channelId
     * @return 消息所属的channelId
     */
    long getQChatChannelId();

    /**
     * 获取消息发送者的accid
     * @return 消息发送者的accid
     */
    String getFromAccount();

    /**
     * 获取消息发送者的客户端类型
     * @return 消息发送者的客户端类型
     */
    int getFromClientType();

    /**
     * 获取消息发送者设备id
     * @return 消息发送者设备id
     */
    String getFromDeviceId();

    /**
     * 获取消息发送者昵称
     * @return 消息发送者昵称
     */
    String getFromNick();

    /**
     * 获取消息发送时间
     * @return 消息发送时间
     */
    long getTime();

    /**
     * 获取消息更新时间
     * @return 消息更新时间
     */
    long getUpdateTime();

    /**
     * 获取消息类型
     * @return 消息类型
     */
    MsgTypeEnum getMsgType();

    /**
     * 获取消息body
     * @return 消息body
     */
    String getContent();

    /**
     * 设置消息body
     * @param content 消息body
     */
    void setContent(String content);

    /**
     * 获取消息attach
     * @return 消息attach
     */
    String getAttachStr();

    /**
     * 获取消息自定义ext
     * @return 消息自定义ext
     */
    Map<String, Object> getRemoteExtension();

    /**
     * 设置消息自定义ext
     * @param remoteExtension 消息自定义ext
     */
    void setRemoteExtension(Map<String, Object> remoteExtension);

    /**
     * 获取消息的uuid, 该域在生成消息时即会填上
     * @return 消息的uuid
     */
    String getUuid();

    /**
     * 获取消息服务端ID
     * @return 消息服务端ID
     */
    long getMsgIdServer();

    /**
     * 是否重发
     * @return 是否重发
     */
    boolean isResend();

//    /**
//     * 设置是否重发
//     * @param resend 是否重发
//     */
//    void setResend(boolean resend);
    /**
     * 获取服务器消息状态
     * @return 服务器消息状态
     */
    int getServerStatus();

    /**
     * 服务器消息状态
     */
    void setServerStatus(int status);


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

    /**
     * 获取自定义推送文案
     *
     * @return 自定义推送文案
     */
    String getPushContent();

    /**
     * 获取被@的人的accid列表
     * @return 被@的人的accid列表
     */
    List<String> getMentionedAccidList();

    /**
     * 是否@所有人
     * @return 是否@所有人结果
     */
    boolean isMentionedAll();

    /**
     * 该消息是否存储云端历史,默认true
     * @return 该消息是否存储云端历史
     */
    boolean isHistoryEnable();

    /**
     * 获取消息状态
     * @return
     */
    MsgStatusEnum getSendMsgStatus();

    /**
     * 设置消息状态
     * @param sendMsgStatus
     */
    void setSendMsgStatus(MsgStatusEnum sendMsgStatus);

    /**
     * 获取消息附件对象。仅当{@link #getMsgType()}返回为非text时有效
     */
    MsgAttachment getAttachment();
    /**
     * 设置消息附件对象。<br>
     * 如果附件内部包含状态，或是自定义附件类型，用户可自主更新，以便界面展现。<br>
     *
     * @param attachment
     */
    void setAttachment(MsgAttachment attachment);

    /**
     * 获取消息附件接收/发送状态
     */
    AttachStatusEnum getAttachStatus();

    /**
     * 设置消息附件状态
     */
    void setAttachStatus(AttachStatusEnum attachStatus);

    /**
     * 是否需要推送,默认true
     */
    boolean isPushEnable();

    /**
     * 是否需要消息计数,默认true
     */
    boolean isNeedBadge();

    /**
     * 是否需要推送昵称,默认true
     */
    boolean isNeedPushNick();

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

    /**
     * 下发通知的原因
     * @return
     */
    QChatNotifyReason getNotifyReason();

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

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

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

    /**
     * 获取被回复消息引用
     * @return
     */
    QChatMessageRefer getReplyRefer();

    /**
     * 获取根消息引用
     * @return
     */
    QChatMessageRefer getThreadRefer();

    /**
     * 是否是根消息
     * @return
     */
    boolean isRootThread();

    /**
     * 通过此消息的父消息设置消息的thread信息
     *
     * @param parent 当前消息的父消息，即当前消息的回复对象
     */
    void setMessageThread(QChatMessage parent);

    /**
     * 获取消息反垃圾配置选项
     * @return
     */
    QChatMessageAntiSpamOption getAntiSpamOption();

    /**
     * 获取反垃圾结果，此结果仅对文本和图片有效
     * @return
     */
    QChatMessageAntiSpamResult getAntiSpamResult();

    /**
     * 获取消息更新内容，消息被修改/撤回/删除 才有值，否则为null
     * @return
     */
    QChatMsgUpdateContent getUpdateContent();

    /**
     * 获取消息更新操作者的信息，消息被修改/撤回/删除 才有值，否则为null
     * @return
     */
    QChatMsgUpdateInfo getUpdateOperatorInfo();

    /**
     * 获取被@的身份组的roleid列表
     * @return
     */
    List<Long> getMentionedRoleIdList();

    /**
     * 获取消息子类型
     * @return
     */
    Integer getSubType();

    /**
     * 设置消息子类型
     * @param subType
     */
    public void setSubType(Integer subType);
}