会话介绍

大约 3 分钟

会话介绍

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

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

会话类

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

类/方法描述
ChatSearchDirection消息搜索方向枚举。
- UP:按照消息中的 Unix 时间戳的逆序搜索。
- DOWN:按照消息中的时间戳的正序搜索。
ChatConversationType会话类型枚举。
- PeerChat:单聊会话;
- GroupChat:群聊会话;
- RoomChat:聊天室会话。
convId会话 ID,取决于会话类型。
- 单聊:会话 ID 为对方的用户 ID;
- 群聊:会话 ID 为群组 ID;
- 聊天室:会话 ID 为聊天室的 ID。
convType会话类型。
- Chat:单聊会话;
- GroupChat:群聊会话;
- ChatRoom:聊天室会话。
- HelpDesk:客服会话。
isChatThread是否为 thread 会话。
ext会话扩展属性。
isPinned是否为置顶会话。
pinnedTime会话置顶的 UNIX 时间戳,单位为毫秒。未置顶时值为 0
name获取会话 ID。
getUnreadCount获取会话的未读消息数量。
getMessageCount获取会话中的消息数量。
getLatestMessage获取指定会话的最新消息。
getLatestReceivedMessage获取指定会话中最近接收到的消息。
setConversationExtension设置指定会话的自定义扩展信息。
markMessageAsRead标记指定消息为已读。
markAllMessagesAsRead标记所有消息为已读。
updateMessage更新本地数据库的指定消息。
deleteMessage删除本地数据库中的指定消息。
deleteMessagesWithTimestamp从本地数据库中删除指定时间段内的消息。
deleteAllMessages删除内存和本地数据库中的所有消息。
getMessagesWithMsgType从本地数据库获取会话中的指定用户发送的某些类型的消息。
getMessages从本地数据库获取指定会话中一定数量的消息。
getMessagesWithKeyword从本地数据库获取会话中的指定用户发送的一定数量的特定消息。
getMessageWithTimestamp从本地数据库获取指定会话在一段时间内的消息。
fetchHistoryMessages分页获取指定会话的历史消息。
fetchHistoryMessagesByOptions根据消息拉取参数配置从服务器分页获取指定会话的历史消息。
removeMessagesFromServerWithMsgIds根据消息 ID 单向删除漫游消息。
removeMessagesFromServerWithTimestamp根据消息时间戳单向删除漫游消息。
pinConversation置顶会话。

会话事件

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

示例代码如下:

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