会话介绍

大约 3 分钟

会话介绍

会话是一个单聊、群聊或者聊天室所有消息的集合。用户需在会话中发送消息、查看或清空历史消息等操作。

环信即时通讯 IM SDK 提供 EMChatManagerEMConversation 类以会话为单位对消息数据进行管理,如获取会话列表、置顶会话、添加会话标记、删除会话和管理未读消息等。

会话类

环信即时通讯 IM 提供会话类 EMConversation。该类定义了以下内容:

方法描述
id会话 ID,取决于会话类型。
- 单聊/help desk:会话 ID 为对方的用户 ID;
- 群聊:会话 ID 为群组 ID;
- 聊天室:会话 ID 为聊天室的 ID。
type会话类型枚举。
- Chat:单聊会话;
- GroupChat:群聊会话;
- ChatRoom:聊天室会话。
- HelpDesk:客服会话。
isChatThread是否为子区会话。
isPinned是否为置顶会话。
pinnedTime会话置顶的 UNIX 时间戳,单位为毫秒。未置顶时值为 0
setExt获取会话扩展属性。
latestMessage获取会话的最新一条消息。
lastReceivedMessage获取最近收到的一条消息。
unreadCount获取会话的消息未读数。
markMessageAsRead将消息标为已读。
markAllMessagesAsRead将所有消息标为已读。
insertMessage插入一条消息在 SDK 本地数据库,消息的 conversation ID 应该和会话的 conversation ID 一致,消息会根据消息里的时间戳被插入 SDK 本地数据库,并且更新会话的 latestMessage 等属性。
appendMessage插入一条消息到会话尾部。
updateMessage更新 SDK 本地数据库的消息。
deleteMessage(String messageId)删除会话中的一条消息,同时清除内存和数据库中的消息。
deleteAllMessages()同时从内存和本地数据库中删除会话中的所有消息。
deleteMessagesWithTs从本地数据库中删除指定时间段内的消息。
loadMessage获取指定 ID 的消息。优先从内存中加载,如果内存中没有则从数据库中加载,并将其插入到内存中。
loadMessagesWithMsgType根据消息类型、搜索消息的时间点、搜索结果的最大条数、搜索来源和搜索方向从 SDK 本地数据库中搜索指定数量的消息。
loadMessages从本地数据库加载消息。加载到的消息也会加入到当前会话的缓存中,通过 getAllMessages 方法将会返回所有加载的消息。
loadMessagesWithKeyword根据消息中的关键词、搜索消息的时间点、搜索结果的最大条数、搜索来源和搜索方向从 SDK 本地数据库中搜索指定数量的消息。
loadMessagesFromTime加载一个时间段内的消息,不超过 count 参数指定的最大数量。

会话事件

EMConversationListener 中提供会话事件的监听接口。开发者可以通过设置此监听,获取会话事件,并做出相应处理。如果不再使用该监听,需要移除,防止出现内存泄漏。

示例代码如下:


EMClient.getInstance.chatManager.addEventHandler(
      sdkEventKey,
      EMChatEventHandler(
      // 收到会话已读的事件。该事件在以下场景中触发:
       // 1. 当消息接收放调用 `sendConversationReadAck` 方法,SDK 会执行此回调,
       // 并将本地数据库中 `Message` 的 `hasReadAck` 置为 `true`.
       // 2. 多端多设备登录时,若一端发送会话已读回执(sendConversationReadAck),
       // 服务器端会将该会话的未读消息数置为 0,
       // 同时其他端会回调此方法,并将本地数据库中该会话中消息的 `hasRead` 属性置为 `true`。
        onConversationRead: (from, to) {}, 
      ),
);