修改消息

大约 3 分钟

修改消息

对于单聊或群组聊天会话中已经发送成功的文本消息,SDK 支持对这些消息的内容进行修改。

功能开通和版本支持

对于单聊、群组和聊天室聊天会话中已经发送成功的消息,SDK 支持对这些消息的内容进行修改。若使用该功能,需联系环信商务开通

SDK 版本描述
SDK 1.2.0 之前版本不支持消息修改功能。
SDK 1.2.0(包括)-1.4.0(不包括)仅支持修改单聊或群组会话中已经发送成功的文本消息聊天室会话不支该功能
SDK 1.4.0 及之后版本支持对单聊、群组和聊天室会话中 各类消息 进行修改:
- 文本/自定义消息:支持修改消息内容(body)和扩展字段 ext
- 文件/视频/音频/图片/位置/合并转发消息:只支持修改消息扩展字段 ext
- 命令消息:不支持修改。

技术原理

环信即时通讯 IM 通过 ChatManagerIChatManagerDelegate 实现消息修改。

消息修改流程

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

各类会话的消息修改权限

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

消息修改后的生命周期

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

前提条件

开始前,请确保满足以下条件:

  • 完成 SDK 初始化,并连接到服务器,详见 初始化连接 文档。
  • 了解环信即时通讯 IM API 的使用限制,详见 使用限制

实现方法

你可以调用 ChatManager#ModifyMessage 方法修改已经发送成功的消息。一条消息默认最多可修改 10 次。

示例代码如下:

TextBody tb = new TextBody("new content");

 // 创建 attributes 字典
Dictionary<string, AttributeValue> attributes = new Dictionary<string, AttributeValue>();
attributes["Key1"] = AttributeValue.Of("Value1");
attributes["Key2"] = AttributeValue.Of(100, AttributeValueType.INT32);

SDKClient.Instance.ChatManager.ModifyMessage("msgId", tb, attributes, new ValueCallBack<Message>(
onSuccess: (dmsg) =>
{
},
onError: (code, desc) =>
{
}
));

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

// 继承并实现 `IChatManagerDelegate`。
public class ChatManagerDelegate : IChatManagerDelegate {

    public void OnMessageContentChanged(Message msg, string operatorId, long operationTime)
    {
        // operatorId、operationTime也可通过以下方式来获取,数据与上述行参保持一致
        // string id = msg.Body.OperatorId;
        // long time = msg.Body.OperationTime;
    }
  }

// 注册监听器。
ChatManagerDelegate adelegate = new ChatManagerDelegate();
SDKClient.Instance.ChatManager.AddChatManagerDelegate(adelegate);

// 不使用监听器时需要移除监听器。
SDKClient.Instance.ChatManager.RemoveChatManagerDelegate(adelegate);
上次编辑于: