NIMMessage.java

浏览该文件的文档.

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

import com.netease.nimlib.sdk.msg.attachment.MsgAttachment;
import com.netease.nimlib.sdk.msg.constant.AttachStatusEnum;
import com.netease.nimlib.sdk.msg.constant.MsgDirectionEnum;
import com.netease.nimlib.sdk.msg.constant.MsgStatusEnum;
import com.netease.nimlib.sdk.msg.constant.MsgTypeEnum;

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

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

    /**
     * 判断与参数message是否是同一条消息。<br>
     * 先比较数据库记录ID，如果没有数据库记录ID，则比较{@link #getUuid()}
     *
     * @param message 消息对象
     * @return 两条消息是否相同
     */
    boolean isTheSame(NIMMessage message);

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

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

    /**
     * 获取消息的子类型
     *
     * @return 子类型，小于等于0表示没有子类型
     */
    int getSubtype();

    /**
     * 设置消息的子类型。
     *
     * @param subtype 子类型，小于等于0表示没有子类型
     */
    void setSubtype(int subtype);

    /**
     * 获取消息接收/发送状态。
     *
     * @return 消息状态
     */
    MsgStatusEnum getStatus();

    /**
     * 设置消息状态
     *
     * @param status 消息状态
     */
    void setStatus(MsgStatusEnum status);

    /**
     * 设置消息方向
     *
     * @param direct 消息方向
     */
    void setDirect(MsgDirectionEnum direct);

    /**
     * 获取消息方向：发出去的消息还是接收到的消息
     *
     * @return 消息方向
     */
    MsgDirectionEnum getDirect();

    /**
     * 设置消息具体内容。<br>
     * 当消息类型{@link com.netease.nimlib.sdk.msg.constant.MsgTypeEnum#text}时，该域为消息内容。
     * 当为其他消息类型时，该域为可选项，如果设置，将作为iOS的apns推送文本以及android内置消息推送的显示文本。
     *
     * @param content 消息内容/推送文本
     */
    void setContent(String content);

    /**
     * 获取消息具体内容。<br>
     * 当消息类型{@link com.netease.nimlib.sdk.msg.constant.MsgTypeEnum#text}时，该域为消息内容。
     * 当为其他消息类型时，该域为可选项，如果设置，将作为iOS的apns推送文本以及android内置消息推送的显示文本（1.7.0及以上版本建议使用pushContent）。
     *
     * @return 消息内容/推送文本
     */
    String getContent();

    /**
     * 获取消息时间，单位为ms
     *
     * @return 时间
     */
    long getTime();

    /**
     * 设置说话方的帐号。消息方向{@link #getDirect()}根据改之
     *
     * @param account 帐号
     */
    void setFromAccount(String account);

    /**
     * 获取该条消息发送方的帐号
     */
    String getFromAccount();

    /**
     * 设置消息附件对象。<br>
     * 如果附件内部包含状态，或是自定义附件类型，用户可自主更新，以便界面展现。<br>
     * 注意：设置之后，如需持久化到数据库，需要调用{@link com.netease.nimlib.sdk.msg.MsgService#updateIMMessageStatus}更新
     *
     * @param attachment
     */
    void setAttachment(MsgAttachment attachment);

    /**
     * 获取消息附件对象。仅当{@link #getMsgType()}返回为非text时有效
     */
    MsgAttachment getAttachment();

    /**
     * 获取消息附件文本内容
     *
     * @return
     */
    String getAttachStr();

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

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

    /**
     * 获取消息配置
     *
     * @return 消息配置
     */
    CustomMessageConfig getConfig();

    /**
     * 设置消息配置
     *
     * @param config 消息配置
     */
    void setConfig(CustomMessageConfig config);

    /**
     * 获取扩展字段（该字段会发送到其他端）
     *
     * @return 扩展字段Map
     */
    Map<String, Object> getRemoteExtension();

    /**
     * 设置扩展字段（该字段会发送到其他端），最大长度1024字节。
     *
     * @param remoteExtension 扩展字段Map，开发者需要保证此Map能够转换为JsonObject
     */
    void setRemoteExtension(Map<String, Object> remoteExtension);

    /**
     * 获取本地扩展字段（仅本地有效）
     *
     * @return 扩展字段Map
     */
    Map<String, Object> getLocalExtension();

    /**
     * 设置本地扩展字段（该字段仅在本地使用有效，不会发送给其他端），最大长度1024字节
     *
     * @param localExtension
     */
    void setLocalExtension(Map<String, Object> localExtension);

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

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

    /**
     * 设置自定义推送文案（1.7.0及以上版本建议使用此字段，不要使用setContent来设置推送文案），目前长度限制为500字以内
     *
     * @param pushContent 自定义推送文案
     */
    void setPushContent(String pushContent);

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

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

    /**
     * 获取指定成员推送选项
     *
     * @return 指定成员推送选项
     */
    MemberPushOption getMemberPushOption();

    /**
     * 设置指定成员推送选项
     *
     * @param pushOption 指定成员推送选项
     */
    void setMemberPushOption(MemberPushOption pushOption);

    /**
     * 判断自己发送的消息对方是否已读
     *
     * @return true：对方已读；false：对方未读
     */
    boolean isRemoteRead();

    /**
     * 是否需要消息已读（主要针对群消息）
     *
     * @return 该消息是否需要发送已读确认
     */
    boolean needMsgAck();

    /**
     * 设置该消息为需要消息已读的
     */
    void setMsgAck();

    /**
     * 是否已经发送过群消息已读回执
     *
     * @return 是否已经发送过已读回执
     */
    boolean hasSendAck();

    /**
     * 返回群消息已读回执的已读数
     *
     * @return 群里多少人已读了该消息
     */
    int getTeamMsgAckCount();

    /**
     * 返回群消息已读回执的未读数
     *
     * @return 群里多少人还未读该消息
     */
    int getTeamMsgUnAckCount();

    /**
     * 获取消息发送方类型
     *
     * @return 发送方的客户端类型，与ClientType类比较
     */
    int getFromClientType();

    /**
     * 获取易盾反垃圾配置项
     *
     * @return NIMAntiSpamOption
     */
    NIMAntiSpamOption getNIMAntiSpamOption();

    /**
     * 设置易盾反垃圾选项
     *
     * @param nimAntiSpamOption
     */
    void setNIMAntiSpamOption(NIMAntiSpamOption nimAntiSpamOption);

    /**
     * 命中了客户端反垃圾，服务器处理
     *
     * @param hit
     */
    void setClientAntiSpam(boolean hit);


    /**
     * 如果服务器存在相同的附件文件，是否强制重新上传文件 ，默认false
     *
     * @param forceUpload
     */
    void setForceUploadFile(boolean forceUpload);


    /**
     * 发送消息给对方， 是不是被对方拉黑了（消息本身是发送成功的）
     *
     * @return
     */

    boolean isInBlackList();

    /**
     * 获取服务端消息id
     *
     * @return id
     */
    long getServerId();

    /**
     * 设置消息的选中状态
     *
     * @param isChecked true:被选中状态; false: 未被选中状态; null: 不在多选状态
     */
    void setChecked(Boolean isChecked);

    /**
     * 消息的选中状态
     *
     * @return true:被选中状态; false: 未被选中状态; null: 不在多选状态
     */
    Boolean isChecked();

    /**
     * 消息是否需要刷新到session服务
     * 只有消息存离线的情况下，才会判断该参数，默认：是
     *
     * @return true: 是; false: 否
     */
    boolean isSessionUpdate();

    /**
     * 设置消息是否需要刷新到session服务
     * 只有消息存离线的情况下，才会判断该参数
     */
    void setSessionUpdate(boolean sessionUpdate);

    /**
     * 获取消息的thread信息
     *
     * @return 消息的thread信息
     */
    MsgThreadOption getThreadOption();

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

    /**
     * 此消息是不是一条thread消息
     */
    boolean isThread();

    /**
     * 获取快捷评论的最后更新时间
     *
     * @return 快捷评论最后更新时间
     */
    long getQuickCommentUpdateTime();

    /**
     * 该消息是否已经被从服务端撤回或删除
     *
     * @return 是否已经被撤回或删除
     */
    boolean isDeleted();

    /**
     * 获取消息的关键信息
     *
     * @return 消息的关键信息
     */
    MessageKey getMessageKey();

    /**
     * 获取易盾反垃圾字段
     *
     * @return 反垃圾字段
     */
    String getYidunAntiCheating();

    /**
     * 设置易盾反垃圾字段，要求是Json格式
     *
     * @param yidunAntiCheating 反垃圾字段，要求是Json格式
     */
    void setYidunAntiCheating(String yidunAntiCheating);

    /**
     * 获取环境变量
     * 用于指向不同的抄送，第三方回调等配置
     * 注意：数据库不会保存此字段
     *
     * @return 环境变量
     */
    String getEnv();

    /**
     * 设置环境变量
     * 用于指向不同的抄送，第三方回调等配置
     * 注意：数据库不会保存此字段
     *
     * @param env 环境变量
     */
    void setEnv(String env);

    /**
     * 获取易盾反垃圾扩展字段
     * @return 易盾反垃圾扩展字段
     */
    String getYidunAntiSpamExt();

    /**
     * 设置易盾反垃圾扩展字段
     * @param yidunAntiSpamExt 易盾反垃圾扩展字段，限制json
     */
    void setYidunAntiSpamExt(String yidunAntiSpamExt);

    /**
     * 获取易盾反垃圾返回的结果
     * @return 易盾反垃圾返回的结果
     */
    String getYidunAntiSpamRes();
}