消息引用

大约 5 分钟

消息引用

消息引用是指用户可以引用一条已发送的消息。消息引用可以帮助用户回复特定的消息，或强调特定的信息。

除了透传消息，各类发送成功的消息均支持该功能，发送失败的消息不支持该功能。

对引用的消息进行回复时，你可以发送各种类型（除透传消息外）的消息。

提示

消息引用时，回复消息的长度为默认的消息长度限制，即消息内容和扩展字段的总和不超过 5 KB。

Android/iOS 端各类型的消息引用的 UI 展示示例如下表所示：

消息类型	原消息存在	原消息不存在
文本消息
图片消息
语音消息
视频消息
文件消息
名片消息
合并消息

Web 端各类型的消息引用的 UI 展示示例如下表所示：

消息类型	原消息存在	原消息不存在
文本消息
图片消息
语音消息
视频消息
文件消息
名片消息
合并消息

前提条件

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

完成 SDK 初始化，详见各端快速开始。
了解即时通讯 IM 的使用限制，详见使用限制。

实现过程

为展示原消息的引用，需要在发送消息时，将原消息的信息传入新消息的拓展字段中。

以下为扩展字段的数据结构的示例：

"msgQuote": {
   "msgID": 原消息的 ID，字符串类型。
   "msgPreview": 本地找不到原消息时的默认文本展示，字符串类型。
   "msgSender": 原消息的发送方的用户 ID，字符串类型。
   "msgType": 原消息类型，字符串类型。
}

在消息列表中展示时，可从新消息的拓展字段中提取上述 JSON 信息，拼接展示 "${msgSender}: ${messageAbstract}"。

如需支持点击展示引用消息的区域，跳转至被引用的原消息。可根据上述 JSON 中的 msgID 字段，在消息列表中找到该消息进行跳转。

如果被引用消息已经删除，可以提示 引用内容不存在。

发送引用的消息

以回复文本消息为例，发送引用消息的过程如下：

Android 代码


EMMessage msg = EMMessage.createTextSendMessage("hi", conversationId);
 JSONObject jsonObject = new JSONObject();
 try {
     jsonObject.put("msgID","quoted messageId");
     jsonObject.put("msgPreview","quoted message text");
     jsonObject.put("msgSender","quoted message senderId");
     jsonObject.put("msgType","txt");
 } catch (JSONException e) {
     throw new RuntimeException(e);
 }
 msg.setAttribute("msgQuote",jsonObject);
 EMClient.getInstance().chatManager().sendMessage(msg);


 val msg = EMMessage.createTextSendMessage("hi", conversationId)
 val jsonObject = JSONObject()
 try {
     jsonObject.put("msgID", "quoted messageId")
     jsonObject.put("msgPreview", "quoted message text")
     jsonObject.put("msgSender", "quoted message senderId")
     jsonObject.put("msgType", "txt")
 } catch (e: JSONException) {
     throw RuntimeException(e)
 }
 msg.setAttribute("msgQuote", jsonObject)
 EMClient.getInstance().chatManager().sendMessage(msg)

iOS/Web 代码

let textBody = EMTextMessageBody(text: "hi")
        let ext = ["msgQuote": [
            "msgID": <#quoted messageId#>
            "msgPreview": <#quoted message text#>
            "msgSender": <#quoted message senderId#>
            "msgType": "txt"
            ]
        ]
        let message = EMChatMessage(conversationID: "userId", body: textBody, ext: ext)
        EMClient.shared().chatManager?.send(message, progress: nil, completion: { msg, err in
            
        })

sendMessage(message){
   // 若引用消息存在，则将该消息到要发送的消息扩展中。
    if (
      repliedMessage != null &&
      message.type != 'read' &&
      message.type != 'delivery' &&
      message.type != 'channel' &&
      message.type != 'cmd'
    ){
      let ext = message.ext || {};
      let msgPreview = '';
      switch (repliedMessage.type) {
        case 'txt':
          msgPreview = repliedMessage.msg;
          break;
        case 'img':
          msgPreview = '[Image]';
          break;
        case 'audio':
          msgPreview = '[Voice]';
          break;
        case 'video':
          msgPreview = '[Video]';
          break;
        case 'file':
          msgPreview = '[File]';
          break;
        case 'custom':
          msgPreview = '[Custom]';
          break;
        default:
          msgPreview = '[unknown]';
          break;
      }
      ext.msgQuote = {
        msgID: repliedMessage.mid || repliedMessage.id,
        msgPreview: msgPreview,
        msgSender: repliedMessage.from,
        msgType: repliedMessage.type,
      };
      message.ext = ext;
    }

    client.send(message)
}

接收方解析收到的消息

接收方收到消息时，通过解析 ext，检查消息是否是引用消息。

Android 代码

private void handleQuotedMessage(EMMessage message) {
  if(message.ext() != null && message.ext().containsKey("msgQuote")) {
      String msgQuote = message.getStringAttribute("msgQuote","");
      JSONObject jsonObject = null;
      try {
          if (!TextUtils.isEmpty(msgQuote)){
              try {
                  jsonObject = new JSONObject(msgQuote);
              } catch (JSONException e) {
                  e.printStackTrace();
              }
          }else {
              jsonObject = message.getJSONObjectAttribute("msgQuote");
          }
      } catch (ChatException e) {
          EMLog.e(TAG, "error message: "+e.getMessage());
      }

      if(jsonObject != null){
         try {
            // 读取 msgQuote 中的源消息信息
            String quoteMsgID = jsonObject.getString("msgID");
            String quoteSender = jsonObject.getString("msgSender");
            String quoteType = jsonObject.getString("msgType");
            String quoteContent = jsonObject.getString("msgPreview");
            //获取引用消息数据 更新 UI
        } catch (JSONException e) {
            e.printStackTrace();
        }
  }
}

@Override
 public void onMessageReceived(List<EMMessage> messages) {
    super.onMessageReceived(messages);
    for (EMMessage message : messages) {
       handleQuotedMessage(message)
    }
 }

    private fun handleMentionedMessage(message: EMMessage) {
        message.ext()?.let {
            if (it.containsKey("msgQuote")){
                val msgQuote = message.getStringAttribute("msgQuote","")
                var jsonObject:JSONObject? = null
                try {
                    if (!msgQuote.isNullOrEmpty()){
                        try {
                            jsonObject = JSONObject(msgQuote)
                        }catch (e:JSONException){
                            e.printStackTrace();
                        }
                    }else{
                        jsonObject = message.getJSONObjectAttribute("msgQuote")
                    }
                }catch (e:HyphenateException){
                    EMLog.e(TAG, "error message: "+e.getMessage());
                }
                jsonObject?.let {
                    try {
                        // 读取 msgQuote 中的源消息信息
                        val quoteMsgID = jsonObject.getString("msgID")
                        val quoteSender = jsonObject.getString("msgSender")
                        val quoteType = jsonObject.getString("msgType")
                        val quoteContent = jsonObject.getString("msgPreview")
                        //获取引用消息数据 更新 UI
                    }catch (e:JSONException){
                        e.printStackTrace();
                    }
                }
            }
        }
    }

    override fun onMessageReceived(messages: MutableList<EMMessage>?) {
        super.onMessageReceived(messages);
        messages?.forEach {
             handleMentionedMessage(it)
        }
    }

iOS/Web 代码

    func handleQuotedMessage(_ message: EMChatMessage) {
        if let ext = message.ext {
            if let quotedInfo = ext["msgQuote"] as? [String: AnyObject] {
                // 读取 msgQuote 中的源消息信息
                if let quotedMessageId = quotedInfo["msgID"] as? String,
                   let msgPreview = quotedInfo["msgPreview"] as? String,
                   let msgSender = quotedInfo["msgSender"] as? String,
                   let msgType = quotedInfo["msgType"] as? String {
                   // 消息引用了其他消息，需要更新 UI
                }
            }
        }
    }
func messagesDidReceive(_ aMessages: [EMChatMessage]) {
    for msg in aMessages {
         handleQuotedMessage(msg)
    }
}


receiveMessage(message){
   let msgQuote = message.ext.msgQuote;
      if(msgQuote){
      // 找到被引用的消息
      const quotedMessage = messages.filter(msg => {
         return msg.mid === msgQuote.msgID || msg.id === msgQuote.msgID;
      })

      if (quotedMessage[0]) {
        // 找到被引用消息的 dom 节点
        const messageDom = document.getElementById(quotedMessage[0].id);
      }
   }
}
// 点击引用的消息回滚到被引用消息的位置，并高亮显示。
const scrollToMsg = () => {
    messageDom?.scrollIntoView({ behavior: 'smooth' });
    messageDom?.classList.add('reply-message-twinkle');

    setTimeout(() => {
      messageDom?.classList.remove('reply-message-twinkle');
    }, 1500);
  };

常见问题

Q: 被引用消息不存在时，如何显示？ A: 可以显示 msgPreview 内容，也可以显示引用内容不存在。
Q: 对于 Android/iOS 端，跳转到被引用消息时，如果被引用消息加载到当前消息的条数太多，怎么办？ A: 这种情况下，将当前消息与被引用的消息之间的所有消息都展示到 UI 会导致内存占用太多，你需要设置一个加载消息数量的阈值，超过该阈值就不再跳转。

消息引用

# 消息引用

# 前提条件

# 实现过程

# 发送引用的消息

# Android 代码

# iOS/Web 代码

# 接收方解析收到的消息

# Android 代码

# iOS/Web 代码

# 常见问题

消息引用

前提条件

实现过程

发送引用的消息

Android 代码

iOS/Web 代码

接收方解析收到的消息

Android 代码

iOS/Web 代码

常见问题