QChatMessage.java

浏览该文件的文档.

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


import com.netease.nimlib.sdk.msg.constant.MsgDirectionEnum;
import com.netease.nimlib.sdk.msg.constant.MsgStatusEnum;
import java.util.Map;

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

    /**
     * 判断与参数message是否是同一条消息。
     *
     * @param message 消息对象
     * @return 两条消息是否相同
     */
    boolean isTheSame(QChatMessage message);
    /**
     * 获取消息方向：发出去的消息还是接收到的消息
     *
     * @return 消息方向
     */
    MsgDirectionEnum getDirect();
    /**
     * 设置消息方向
     *
     * @param direct 消息方向
     */
    void setDirect(MsgDirectionEnum direct);
    /**
     * 获取本地扩展字段（仅本地有效）
     *
     * @return 扩展字段Map
     */
    Map<String, Object> getLocalExtension();
    /**
     * 设置本地扩展字段（该字段仅在本地使用有效，不会发送给其他端
     *
     * @param localExtension
     */
    void setLocalExtension(Map<String, Object> localExtension);
    /**
     * 设置消息的选中状态
     *
     * @param isChecked true:被选中状态; false: 未被选中状态; null: 不在多选状态
     */
    void setChecked(Boolean isChecked);

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

    /**
     * @Deprecated QChat使用getServerStatus判断状态
     *
     * 该消息是否已经被从服务端撤回或删除
     *
     * @return 是否已经被撤回或删除
     */
    boolean isDeleted();
    /**
     * 设置消息状态
     *
     * @param status 消息状态
     */
    void setStatus(MsgStatusEnum status);
    /**
     * 获取消息接收/发送状态。
     *
     * @return 消息状态
     */
    MsgStatusEnum getStatus();
}