修改消息

你是否有过这样的经历：发送消息后发觉消息内容中包含错别字、遗漏了的关键、内容不够完善清晰、甚至临时想更改自己的想法。为解决这些需求，环信即时通讯 IM 提供修改消息功能，提高沟通效率和准确性。

对于单聊、群组和聊天室聊天会话中已经发送成功的消息，SDK 支持对这些消息的内容进行修改。

若使用该功能，需联系环信商务开通。SDK 1.6.0 之前的版本仅支持对单聊和群组聊天中的发送后的文本消息进行修改，SDK 1.6.0 及之后的版本中新增修改各类会话中各类消息：

• 文本/自定义消息：支持修改消息内容（body）和扩展字段 ext。
• 文件/视频/音频/图片/位置/合并转发消息：只支持修改消息扩展字段 ext。
• 命令消息：不支持修改。

技术原理

环信即时通讯 IM 通过 ChatManager 和 ChatMessageListener 实现消息修改。

消息修改流程

1. 用户调用 SDK 的 API 修改一条消息。
2. 服务端存储的该条消息，修改成功后回调给 SDK。
3. SDK 修改客户端上的该条消息。成功后，SDK 将修改后的消息回调给用户。

各类会话的消息修改权限

• 对于单聊会话，只有消息发送方才能对消息进行修改。
• 对于群组/聊天室会话，普通成员只能修改自己发送的消息。群主/聊天室所有者和管理员除了可以修改自己发送的消息，还可以修改普通成员发送的消息。这种情况下，消息的发送方不变，消息体中的修改者的用户 ID 属性为群主/聊天室所有者或管理员的用户 ID。

消息修改后的生命周期

修改消息没有时间限制，即只要这条消息仍在服务端存储就可以修改。消息修改后，消息生命周期（在服务端的保存时间）会重新计算，例如，消息可在服务器上保存 180 天，用户在消息发送后的第 30 天（服务器上的保存时间剩余 150 天）修改了消息，修改成功后该消息还可以在服务器上保存 180 天。

对于修改后的消息，消息体中除了内容或扩展字段变化，还新增了修改者的用户 ID、修改时间和修改次数属性。除消息体外，该消息的其他信息（例如，消息发送方、接收方）均不会发生变化。

前提条件

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

• 完成 SDK 初始化，并连接到服务器，详见 快速开始 及 初始化文档。
• 了解环信即时通讯 IM API 的使用限制，详见 使用限制。
• 联系环信商务开通消息修改功能。

实现方法

你可以调用 ChatManager#modifyMessage 方法修改已经发送成功的消息。该方法会同时更新服务器和本地的消息。对于修改后的消息，消息体中除了内容变化，还新增了修改者的用户 ID、修改时间和修改次数属性。除消息体和消息扩展属性 ext 外，该消息的其他信息（例如，消息 ID、消息发送方、接收方）均不会发生变化。

一条消息默认最多可修改 10 次。

// 文本消息：可同时修改消息体和消息扩展属性
let textBody = new TextMessageBody('new content');
// 如果想完全替换 ext，可以 new 一个 Map 出来
let ext: Map<string, MessageExtType> = message.ext();
ext.set('newkey', {
  nickname: 'nickname',
  gender: Gender.MALE
} as UserInfo);
// textBody 和 ext 不能同时不传或者同时为 null
ChatClient.getInstance().chatManager()?.modifyMessage(this.messageId, textBody, ext)
  .then((msg: ChatMessage) => {
    // 修改成功
  })
  .catch((e: ChatError) => {
    // 修改失败
  });


// 自定义消息：可同时修改消息体和消息扩展属性
let customBody = new CustomMessageBody('new action');
let newExt: Map<string, MessageExtType> = new Map();
newExt.set('newkey1', 'newkey1');
newExt.set('newkey2', 123);
// customBody 和 newExt 不能同时不传或者同时为 null
ChatClient.getInstance().chatManager()?.modifyMessage(this.messageId, customBody, newExt)
  .then((msg: ChatMessage) => {
    // 修改成功
  })
  .catch((e: ChatError) => {
    // 修改失败
  });

// 文件/视频/音频/图片/位置/合并转发消息：只能修改消息扩展属性
let newExt: Map<string, MessageExtType> = new Map();
newExt.set('newkey1', false);
newExt.set('newkey2', {
  nickname: 'nickname',
  gender: Gender.UNKNOWN
} as UserInfo);
ChatClient.getInstance().chatManager()?.modifyMessage(this.messageId, null, newExt)
  .then((msg: ChatMessage) => {
    // 修改成功
  })
  .catch((e: ChatError) => {
    // 修改失败
  });

消息修改后，消息的接收方会收到 ChatMessageListener#onMessageContentChanged 事件，该事件中会携带修改后的消息对象、最新一次修改消息的用户以及消息的最新修改时间。对于群组和聊天室会话，除了修改消息的用户，群组/聊天室内的其他成员均会收到该事件。

提示

若通过 RESTful API 修改自定义消息，消息的接收方也通过 ChatMessageListener#onMessageContentChanged 事件接收修改后的自定义消息。

ChatClient.getInstance().chatManager().addMessageListener({
    onMessageReceived: (messages: ChatMessage[]) => {},
    
    onMessageContentChanged: (messageModified: ChatMessage, operatorId: string, operationTime: number) => {
              let operationCount = messageModified.getBody()?.operationCount();
              // operatorId、operationTime也可通过以下方式来获取,数据与上述行参保持一致
              let id = messageModified.getBody()?.operatorId();
              let time = messageModified.getBody()?.operationTime();
              // 消息修改后的扩展字段，可通过以下方式获取
              let newExt = messageModified.ext();
              newExt.forEach((value, key) => {
                ChatLog.d("onMessageContentChanged onSuccess key:" + key + " value:" + value);
              })
    }
});