====== 消息管理–管理本地消息数据 ======

更新时间：2022-06-21

本文介绍环信即时通讯 IM Flutter SDK 如何管理本地消息数据。

除了发送和接收消息外，环信即时通讯 IM Flutter SDK 还支持以会话为单位对本地的消息数据进行管理，如获取与管理未读消息、搜索和删除历史消息等。其中，会话是一个单聊、群聊或者聊天室所有消息的集合。用户需在会话中发送消息以及查看或清空历史消息。

本文介绍如何使用环信即时通讯 IM Flutter SDK 在 app 中实现这些功能。

===== 技术原理 =====

环信即时通讯 IM Flutter SDK 通过 ''%%EMChatManager%%'' 和 ''%%EMConversation%%'' 类实现对本地消息的管理，其中核心方法如下：

  * ''%%EMChatManager.loadAllConversations%%'' 加载本地存储会话列表；
  * ''%%EMChatManager.deleteConversation%%'' 删除本地存储的会话；
  * ''%%EMConversation.getUnreadMessageCount%%'' 获取指定会话的未读消息数；
  * ''%%EMChatManager.getUnreadMessageCount%%'' 获取所有未读消息数；
  * ''%%EMChatManager.deleteRemoteConversation%%'' 删除服务端的会话及其历史消息；
  * ''%%EMChatManager.searchMsgFromDB%%'' 在本地存储的消息中搜索；
  * ''%%EMConversation.insertMessage%%'' 在指定会话中写入消息。

===== 前提条件 =====

开始前，请确保满足以下条件：

  * 完成 SDK 初始化，并连接到服务器，详见 [[https://docs-im.easemob.com/ccim/flutter/quickstart|快速开始]]。
  * 了解环信即时通讯 IM API 的使用限制，详见 [[https://docs-im.easemob.com/ccim/limitation|使用限制]]。

===== 实现方法 =====

==== 获取本地所有会话 ====

你可以获取本地所有的会话：

<code dart>
try {
  List<EMConversation> lists =
      await EMClient.getInstance.chatManager.loadAllConversations();
  // load conversions success
} on EMError catch (e) {
}
</code>

==== 读取指定会话的消息 ====

你可以根据会话 ID 和会话类型调用 API 获取本地会话：

<code dart>
// 会话 ID
String convId = "convId";
// 如果会话不存在是否创建。设置为 `true`，则会返回会话对象。
bool createIfNeed = true;
// 会话类型。详见 `EMConversationType` 枚举类型。
EMConversationType conversationType = EMConversationType.Chat;
// 执行操作
EMConversation? conversation =
    await EMClient.getInstance.chatManager.getConversation(
  convId,
  conversationType,
  true,
);
</code>

==== 获取指定会话的未读消息数 ====

你可以调用接口获取指定会话的未读消息数，示例代码如下：

<code dart>
int unreadCount = await conversation.unreadCount();
</code>

==== 获取所有会话的未读消息数 ====

你可以通过接口获取所有会话的未读消息数量，示例代码如下：

<code dart>
// 获取所有未读消息数
int unreadCount =
        await EMClient.getInstance.chatManager.getUnreadMessageCount();
</code>

==== 指定会话的未读消息数清零 ====

你可以调用接口对会话中的特定消息设置为已读，示例代码如下：

<code dart>
await conversation.markMessageAsRead(message.msgId);
</code>

标记指定会话的所有消息已读：

<code dart>
await conversation.markAllMessagesAsRead();
</code>

将所有消息设为已读：

<code dart>
await EMClient.getInstance.chatManager.markAllConversationsAsRead();
</code>

==== 删除会话及其历史消息 ====

SDK 提供两个接口，分别可以删除本地会话和历史消息或者删除当前用户在服务器端的会话和历史消息。

  * 删除本地会话和历史消息示例代码如下：

<code dart>
// 会话 ID
String conversationId = "conversationId";
// 删除会话时是否同时删除本地的历史消息
bool deleteMessage = true;
await EMClient.getInstance.chatManager
    .deleteConversation(conversationId, deleteMessage);
</code>

<code dart>
// 删除本地指定会话中的指定消息
EMConversation? conversation =
    await EMClient.getInstance.chatManager.getConversation(
  conversationId,
);
conversation?.deleteMessage(messageId);
</code>

  * 删除服务器端会话和历史消息，示例代码如下：

<code dart>
// 会话 ID
String conversationId = "conversationId";
// 删除会话时是否同时删除服务端的历史消息
bool deleteMessage = true;
EMConversationType conversationType = EMConversationType.Chat;
await EMClient.getInstance.chatManager.deleteRemoteConversation(
  conversationId,
  conversationType: conversationType,
  isDeleteMessage: deleteMessage,
);
</code>


==== 根据关键字搜索会话消息 ====

你可以根据关键字搜索会话消息，示例代码如下：

<code dart>
// 搜索关键字
String keywords = 'key';
// 搜索开始的 Unix 时间戳，单位为毫秒
int timestamp = 1653971593000;
// 搜索的最大消息数
int maxCount = 10;
// 消息发送者
String from = 'tom';
// 消息的搜索方向。详见 `EMSearchDirection` 枚举类型。
EMSearchDirection direction = EMSearchDirection.Up;
List<EMMessage> list =
    await EMClient.getInstance.chatManager.searchMsgFromDB(
  keywords,
  timeStamp: timestamp,
  maxCount: maxCount,
  from: from,
  direction: direction,
);
</code>

==== 批量导入消息到数据库 ====

如果你需要使用批量导入方式在本地会话中插入消息，可以使用下面的接口，构造 ''%%EMMessage%%'' 对象，将消息导入本地数据库。

示例代码如下：

<code dart>
// messages: 需要导入的消息。
await EMClient.getInstance.chatManager.importMessages(messages);
</code>

==== 更多操作 ====

你可以参考如下文档，在项目中实现更多的消息相关功能：

  * [[https://docs-im.easemob.com/ccim/flutter/message1|消息概述]]；
  * [[https://docs-im.easemob.com/ccim/flutter/message2|发送和接收消息]]；
  * [[https://docs-im.easemob.com/ccim/flutter/message4|从服务器获取会话和消息（消息漫游）]]；
  * [[https://docs-im.easemob.com/ccim/flutter/message5|获取消息的已读回执和送达回执]]；
  * [[https://docs-im.easemob.com/ccim/flutter/translation|实现翻译功能]]。