V2NIMLastMessage.java

浏览该文件的文档.

package com.netease.nimlib.sdk.v2.conversation.model;

import com.netease.nimlib.sdk.v2.conversation.enums.V2NIMLastMessageState;
import com.netease.nimlib.sdk.v2.message.V2NIMMessageRefer;
import com.netease.nimlib.sdk.v2.message.attachment.V2NIMMessageAttachment;
import com.netease.nimlib.sdk.v2.message.enums.V2NIMMessageRevokeType;
import com.netease.nimlib.sdk.v2.message.enums.V2NIMMessageSendingState;
import com.netease.nimlib.sdk.v2.message.enums.V2NIMMessageType;
import java.io.Serializable;

/**
 * 会话最新一条消息
 * <p>
 * 包含最后一条消息的引用，以及最后一条消息的状态
 */
public interface V2NIMLastMessage extends Serializable {
    /**
     * 获取会话最新一条消息状态，云端会话有效，本地会话状态只有V2NIM_MESSAGE_STATE_DEFAULT
     * @return 会话最新一条消息状态
     */
    V2NIMLastMessageState getLastMessageState();

    /**
     * 获取最后一条消息的引用
     * @return 最后一条消息的引用
     */
    V2NIMMessageRefer getMessageRefer();

    /**
     * 获取消息类型，状态为消息时有效
     * @return 消息类型
     */
    V2NIMMessageType getMessageType();

    /**
     * 消息子类型，0：表示没有子类型，状态为消息时有效
     * @return 消息子类型
     */
    int getSubType();

    /**
     * 获取消息发送状态，状态为消息时有效
     * @return 消息发送状态
     */
    V2NIMMessageSendingState getSendingState();

    /**
     * 撤回时为撤回附言
     * 消息时消息文本内容
     * @return 撤回时为撤回附言，消息时消息文本内容
     */
    String getText();

    /**
     * 消息附件，状态为消息时有效
     * @return 消息附件
     */
    V2NIMMessageAttachment getAttachment();

    /**
     * 消息撤回者账号，状态为撤回时有效
     * @return 消息撤回者账号
     */
    String getRevokeAccountId();

    /**
     * 消息撤回类型，状态为撤回时有效
     * @return 消息撤回类型
     */
    V2NIMMessageRevokeType getRevokeType();

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

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

    /**
     * 获取消息发送者名称
     * @return
     */
    String getSenderName();
}