V2NIMMessage.java

浏览该文件的文档.

package com.netease.nimlib.sdk.v2.message;

import com.netease.nimlib.sdk.v2.auth.enums.V2NIMLoginClientType;
import com.netease.nimlib.sdk.v2.conversation.enums.V2NIMConversationType;
import com.netease.nimlib.sdk.v2.message.attachment.V2NIMMessageAttachment;
import com.netease.nimlib.sdk.v2.message.config.V2NIMMessageAIConfig;
import com.netease.nimlib.sdk.v2.message.config.V2NIMMessageAntispamConfig;
import com.netease.nimlib.sdk.v2.message.config.V2NIMMessageConfig;
import com.netease.nimlib.sdk.v2.message.config.V2NIMMessagePushConfig;
import com.netease.nimlib.sdk.v2.message.config.V2NIMMessageRobotConfig;
import com.netease.nimlib.sdk.v2.message.config.V2NIMMessageRouteConfig;
import com.netease.nimlib.sdk.v2.message.config.V2NIMMessageStreamConfig;
import com.netease.nimlib.sdk.v2.message.enums.V2NIMMessageAttachmentUploadState;
import com.netease.nimlib.sdk.v2.message.enums.V2NIMMessageSendingState;
import com.netease.nimlib.sdk.v2.message.enums.V2NIMMessageSource;
import com.netease.nimlib.sdk.v2.message.enums.V2NIMMessageType;
import com.netease.nimlib.sdk.v2.message.model.V2NIMMessageStatus;
import com.netease.nimlib.sdk.v2.message.result.V2NIMMessageInner;
import com.netease.nimlib.sdk.v2.topic.V2NIMTopicRefer;
import java.io.Serializable;

public interface V2NIMMessage extends V2NIMMessageRefer, V2NIMMessageInner, Serializable {
    /**
     * 获取客户端消息ID
     * @return 客户端消息ID
     */
    String getMessageClientId();

    /**
     * 获取服务器消息ID
     * @return 服务器消息ID
     */
    String getMessageServerId();

    /**
     * 获取消息时间，服务器器时间
     * @return 消息时间
     */
    long getCreateTime();

    /**
     * 获取消息发送者账号
     * @return 消息发送者账号
     */
    String getSenderId();

    /**
     * 获取消息所属会话类型
     * @return 消息会话类型
     */
    V2NIMConversationType getConversationType();

    /**
     * 获取消息接收者账号
     * @return 消息接收者账号
     */
    String getReceiverId();

    /**
     * 获取消息类型
     * @return 消息类型
     */
    V2NIMMessageType getMessageType();

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

    /**
     * 获取消息内容
     * @return 消息内容
     */
    String getText();

    /**
     * 获取消息附属附件
     * @return 消息附属附件
     */
    V2NIMMessageAttachment getAttachment();

    /**
     * 获取消息服务端扩展
     * @return 消息服务端扩展
     */
    String getServerExtension();

    /**
     * 获取消息本地扩展
     * @return 消息本地扩展
     */
    String getLocalExtension();

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

    /**
     * 获取消息相关配置
     * @return 消息相关配置
     */
    V2NIMMessageConfig getMessageConfig();

    /**
     * 获取离线推送配置相关
     * @return 离线推送配置相关
     */
    V2NIMMessagePushConfig getPushConfig();

    /**
     * 获取路由抄送相关配置
     * @return 路由抄送相关配置
     */
    V2NIMMessageRouteConfig getRouteConfig();

    /**
     * 获取反垃圾相关配置
     * @return 反垃圾相关配置
     */
    V2NIMMessageAntispamConfig getAntispamConfig();

    /**
     * 获取机器人相关配置
     * @return 机器人相关配置
     */
    V2NIMMessageRobotConfig getRobotConfig();

    /**
     * 获取Tread消息引用
     * @return Tread消息引用
     */
    V2NIMMessageRefer getThreadRoot();

    /**
     * 获取回复消息引用
     * @return 回复消息引用
     */
    V2NIMMessageRefer getThreadReply();

        /**
         * 消息状态
         * @return 消息状态
         */
        V2NIMMessageStatus getMessageStatus();

    /**
     * 获取会话ID
     * @return 会话ID
     */
    String getConversationId();

    /**
     * 获取消息关联的 Topic 引用信息。
     *
     * <p>返回非空表示当前消息是一条 Topic 消息；返回空表示当前消息不是 Topic 消息。</p>
     *
     * @return Topic 引用信息，不存在时返回 {@code null}
     */
    V2NIMTopicRefer getTopicRefer();

    /**
     * 检查是否自己发送的消息
     * @return 是否自己发送的消息
     */
    boolean isSelf();

    /**
     * 获取附件上传状态
     * @return 附件上传状态
     */
    V2NIMMessageAttachmentUploadState getAttachmentUploadState();

    /**
     * 获取发送状态
     * @return 发送状态
     */
    V2NIMMessageSendingState getSendingState();

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

    /**
     * 设置消息内容
     * @param text 消息内容
     */
    void setText(String text);

    /**
     * 设置消息附属附件
     * @param attachment 消息附属附件
     */
    void setAttachment(V2NIMMessageAttachment attachment);

    /**
     * 设置消息服务端扩展
     * @param serverExtension 消息服务端扩展
     */
    void setServerExtension(String serverExtension);

    /**
     * 设置消息本地扩展
     * @param localExtension 消息本地扩展
     */
    void setLocalExtension(String localExtension);

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

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

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

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


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

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

    /**
     * 消息是否被删除或者撤回
     * @return 消息是否被删除或者撤回
     */
    boolean isDeleted();

    /**
     * 获取消息来源
     * @return 消息来源
     */
    @V2NIMMessageSource int getMessageSource();

    /**
     * 获取发送端类型
     * @return 发送端类型
     */
    V2NIMLoginClientType getFromClientType();
}