Flutter

获取频道最后一条消息

更新时间: 2024/11/21 17:18:39

网易云信 NIM SDK 的QChatMessageService类提供getLastMessageOfChannels方法,用于获取多个频道的最后一条消息,该方法的响应QChatGetLastMessageOfChannelsResult返回的结果为 map, key 值对应每一个channelId,value 值是消息体QChatMessage。基于该方法的调用,您可通过在应用上层自行开发相关业务逻辑,实现频道列表动态更新各频道的最后一条消息。

UI 示例

频道列表显示最后一条消息的简易 UI 示例如下:

频道最后一条消息UI示例.png

前提条件

已登录圈组,并已创建圈组服务器和频道。

实现流程

API 调用时序

频道最后一条消息动态更新的业务场景可分为如下两种。

场景1:事件回调触发更新

sequenceDiagram



note over NIM SDK: 初始化 SDK 并登录 IM
note over NIM SDK: 注册监听并登录圈组
用户A ->> NIM SDK: 监听消息接收事件&<br>消息撤回事件&<br>消息更新事件&<br>消息删除事件
用户A ->> NIM SDK: 登录圈组
其他用户 ->> NIM SDK: 登录圈组
note over NIM SDK: 双方都成为同一服务器的成员
note over NIM SDK: 双方都能访问同一频道
note over NIM SDK: 频道内收发消息
note over NIM SDK: 获取初始数据
用户A ->> NIM SDK: 获取频道列表<br>(getChannelsByPage)
用户A ->> NIM SDK: 获取多个频道的最后一条消息<br>(getLastMessageOfChannels)
note over NIM SDK: 事件回调触发最后一条消息更新
其他用户 ->> NIM SDK: 发送或重发消息
NIM SDK ->> 用户A: 消息接收事件
用户A ->> NIM SDK: 更新频道最后一条消息
note left of 用户A: 需应用层<br>自行实现
其他用户 ->> NIM SDK: 撤回、更新或删除消息
NIM SDK ->> 用户A: 消息撤回、更新或删除事件
用户A ->> NIM SDK: 判断被撤回、更新或删除的消息<br>是否为最后一条消息
note left of 用户A: 需应用层<br>自行实现
用户A ->> NIM SDK: 如果为最后一条消息,<br>则更新为频道最后一条消息
note left of 用户A: 需应用层<br>自行实现

场景2:自己发送或变更消息触发更新

sequenceDiagram



note over NIM SDK: 初始化 SDK 并登录 IM
note over NIM SDK: 登录圈组
note over NIM SDK: 获取初始数据
用户A ->> NIM SDK: 获取频道列表<br>(getChannelsByPage)
用户A ->> NIM SDK: 获取多个频道的最后一条消息<br>(getLastMessageOfChannels)
note over NIM SDK: 用户自动发送或变更消息<br>触发最后一条消息更新
用户A ->> NIM SDK: 发送、重发或更新消息
用户A ->> 用户A: 更新频道最后一条消息
note left of 用户A: 需应用层<br>自行实现
用户A ->> NIM SDK: 撤回或删除自己的消息
用户A ->> 用户A: 判断撤回或删除的消息<br>是否为最后一条消息
note left of 用户A: 需应用层<br>自行实现
用户A ->> 用户A: 若为最后一条消息<br>则置空该消息
note left of 用户A: 需应用层<br>自行实现

流程说明

本节仅对上图中标为部分的流程补充说明。

  1. 登录圈组前,注册如下事件流:

    • 调用onReceiveMessage方法注册消息接收事件流,监听消息接收事件。
    • 调用onMessageRevoke方法注册消息撤回状态变化事件流,监听消息撤回事件。
    • 调用onMessageUpdate方法注册消息更新事件流,监听消息更新事件。
    • 调用onMessageDelete方法注册消息删除事件流,监听消息删除事件。

    示例代码如下:

    监听消息接收
    dartNimCore.instance.qChatObserver.onReceiveMessage.listen((event) {
      // 收到消息QChatMessages
      for (var qChatMessage in event) {
        // 处理消息
      }
    });
    
    监听消息撤回
    dartNimCore.instance.qChatObserver.onMessageRevoke.listen((event) {
      // 收到撤回后的消息QChatMessage
      var message = event.message;
    });
    
    监听消息更新
    dartNimCore.instance.qChatObserver.onMessageUpdate.listen((event) {
      // 收到更新后的消息QChatMessage
      var message = event.message;
    });
    
    监听消息删除
    dartNimCore.instance.qChatObserver.onMessageDelete.listen((event) {
      // 收到删除后的消息QChatMessage
      var message = event.message;
    });
    
  2. 获取频道最后一条消息的初始数据。

    1. 调用getChannelsByPage拉取频道列表。

    2. 调用getLastMessageOfChannels方法获取若干个频道的最后一条消息。

      • 最多只能传入 20 个频道 ID 获取它们的最后一条消息。
      • 您需自行维护调用该方法返回的结果。
      • 被撤回的消息仍能通过调用该方法查到,但被删除的消息无法查到。如果最后一条消息是撤回消息,推荐把对应的最后一条消息置空,并给出提示表明“撤回消息”。
    3. 在您的应用内存中维护相关频道的最后一条消息。

    示例代码如下:

    dartfinal param = QChatGetChannelsByPageParam(
      serverId: serverId, 
      timeTag: DateTime.now().millisecond, 
      limit: 100);
    NimCore.instance.qChatChannelService.getChannelsByPage(param).then((value) {
      if (value.isSuccess) {
        //查询Channel列表成功
        var channels = value.data?.channels;
        if (channels != null && channels.isNotEmpty) {
          var channelIds = <int>[];
          for (var channel in channels) {
            channelIds.add(channel.channelId);
          }
          //获取频道最后一条消息
          NimCore.instance.qChatMessageService
            .getLastMessageOfChannels(QChatGetLastMessageOfChannelsParam(
              serverId: serverId, channelIds: channelIds))
            .then((messageValue) {
              if (messageValue.isSuccess) {
                // 查询成功,返回频道最后一条消息map,key为channelId
                var channelMsgMap = messageValue.data?.channelMsgMap;
              } else {
                // 查询失败
              }
            });
        }
      } else {
        // 查询Channel列表失败
      }
    });
    
  3. 参照下表,在应用层自行开发,实现后续频道最后一条消息在不同场景下的动态更新。

    场景
    场景说明 推荐处理方法
    事件回调触发更新 频道内,其他用户发送消息或重发消息,触发消息接收回调 更新频道最后一条消息
    频道内,其他用户撤回、更新或删除消息,触发消息更新回调 判断撤回、更新、删除的消息是否为频道最后一条消息,若非最后一条消息,则忽略;若为最后一条消息,且:
    • 为撤回或删除消息,则把最后一条消息置空
    • 为更新消息,则更新频道最后一条消息
    自己发送或变更消息触发更新 自己在频道内发送、重发或更新消息 更新频道内最后一条消息
    自己在频道内撤回或删除消息 判断撤回或删除的消息是否为频道最后一条消息,若非最后一条消息,则忽略;若为最后一条消息,则把最后一条消息置空
此文档是否对你有帮助?
有帮助
去反馈
  • UI 示例
  • 前提条件
  • 实现流程
  • API 调用时序
  • 流程说明