RecentContact.java

浏览该文件的文档.

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

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

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


/**
 * 最近联系人数据接口
 */
public interface RecentContact extends Serializable {

    /**
     * 获取最近联系人的ID（好友帐号，群ID等）
     *
     * @return 最近联系人帐号
     */
    public String getContactId();

    /**
     * 获取与该联系人的最后一条消息的发送方的帐号
     *
     * @return 发送者帐号
     */
    public String getFromAccount();

    /**
     * 获取与该联系人的最后一条消息的发送方的昵称
     *
     * @return 发送者昵称
     */
    public String getFromNick();

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

    /**
     * 最近一条消息的消息ID @see {@link IMMessage#getUuid()} ()}
     *
     * @return 最近一条消息的UUID
     */
    public String getRecentMessageId();

    /**
     * 获取最近一条消息的消息类型
     *
     * @return 消息类型
     */
    public MsgTypeEnum getMsgType();

    /**
     * 获取最近一条消息状态
     *
     * @return 最近一条消息的状态
     */
    public MsgStatusEnum getMsgStatus();

    /**
     * 设置最近一条消息的状态
     *
     * @param msgStatus 消息状态
     */
    public void setMsgStatus(MsgStatusEnum msgStatus);

    /**
     * 获取该联系人的未读消息条数
     *
     * @return 未读数
     */
    public int getUnreadCount();

    /**
     * 获取最近一条消息的缩略内容。<br>
     *     对于文本消息，返回文本内容。<br>
     *     对于其他消息，返回一个简单的说明内容。如需展示更详细，或其他需求，可根据{@link #getAttachment()}生成。
     *
     * @return 缩略内容
     */
    public String getContent();

    /**
     * 获取最近一条消息的时间，单位为ms
     *
     * @return 时间
     */
    public long getTime();

    /**
     * 如果最近一条消息是扩展消息类型，获取消息的附件内容. <br>
     *     在最近消息列表，第三方app可据此自主定义显示的缩略语
     *
     * @return 附件内容
     */
    public MsgAttachment getAttachment();

    /**
     * 设置一个标签，用于做联系人置顶、最近会话列表排序等扩展用途。<br>
     *     SDK不关心tag的意义。第三方app需要事先规划好可能的用途。<br>
     *     设置过后，需要调用{@link com.netease.nimlib.sdk.msg.MsgService#updateRecent(RecentContact)}保存到数据库
     * @param tag 标签值
     */
    public void setTag(long tag);

    /**
     * 获取标签
     * @return 标签值
     */
    public long getTag();

    /**
     * 获取扩展字段
     * @return 扩展字段Map
     */
    public Map<String, Object> getExtension();

    /**
     * 设置扩展字段
     * @param extension 扩展字段Map
     */
    public void setExtension(Map<String, Object> extension);

    /**
     * 设置最后一条消息
     *
     * @param message 最后一条消息
     * @return 是否设置成功，如果消息为空，或者会话信息不对，则会设置失败
     */
    public boolean setLastMsg(IMMessage message);
}