IMMessage.java

浏览该文件的文档.

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

import com.netease.nimlib.sdk.msg.constant.SessionTypeEnum;
import java.io.Serializable;

/**
 * NIM消息实体数据结构。
 * 第三方APP不要调用设置类接口，调用之后不会被持久化
 */
public interface IMMessage extends NIMMessage {
    /**
     * 获取聊天对象的Id（好友帐号，群ID等）。
     *
     * @return 聊天对象ID
     */
    String getSessionId();

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

    /**
     * 获取消息的机器人信息
     *
     * @return MessageRobotInfo
     */
    MessageRobotInfo getRobotInfo();

    /**
     * 设置消息的机器人信息
     *
     * @param robotInfo 消息的机器人信息
     */
    void setRobotInfo(MessageRobotInfo robotInfo);

    /**
     * 获取真实消息对象
     * 如果是圈组消息，可强转为QChatMessage对象；
     * 如果是其他消息，可强转为IMMessage对象,即当前对象本身。
     * @return 真实消息对象
     */
    Serializable getRealMsgObj();

    /**
     * 获取AI 数字人相关信息
     * @return AI 数字人相关信息
     */
    NIMMessageAIConfig getAIConfig();

    /**
     * 设置AI 数字人相关信息
     * @param aiConfig AI 数字人相关信息
     */
    void setAIConfig(NIMMessageAIConfig aiConfig);

    /**
     * 获取流式消息配置
     *
     * @return 流式消息配置
     */
    NIMMessageStreamConfig getStreamConfig();

    /**
     * 设置流式消息配置
     * @param streamConfig 流式消息配置
     */
    void setStreamConfig(NIMMessageStreamConfig streamConfig);

    /**
     * 获取AI数字人消息错误码
     * @return
     */
    int getAIMessageErrorCode();

    /**
     * 消息接收者id
     * @return
     */
    String getReceiverId();

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

    /**
     * 获取消息更新者账号
     * @return 消息更新者账号
     */
    String getModifyAccountId();
}