IM 即时通讯
Web
产品介绍
简介
主要功能
产品优势
海外数据中心
IM平滑迁移方案
接口及业务限制
功能介绍
帐号集成与登录
基础消息功能
群组功能
聊天室功能
聊天室标签功能
多端登录与互踢策略
质量数据监控台
体验 Demo
下载 SDK 与 Demo 源码
更新日志
IM UIKit 更新日志
NIM SDK 开发版更新日志
NIM SDK 稳定版更新日志
快速开始
跑通 IM Demo 源码
实现 IM 文本消息收发(不含 UI)
含 UI 集成
什么是 IM UIKit
IM UIKit 功能概览
快速集成 IM UIKit
非React框架集成 IM UIKit
组件导入
初始化
全局上下文
登录相关
实现消息收发及界面自定义
集成会话列表界面
集成会话消息界面
集成用户资料组件
集成通讯录界面
集成搜索组件
非 React 框架自定义渲染
主题样式设置
语言设置
初始化(兼容 NIM SDK)
不含 UI 集成
集成 SDK
浏览器环境集成
Node.js集成
初始化与登录相关
初始化与登录 IM
IM 连接相关
多端登录与互踢
消息相关
消息概述
消息收发
消息配置选项
广播消息收发
消息已读回执
消息撤回
消息重发与转发
本地消息
通知消息
群通知消息
超大群通知消息
历史消息
最近会话
用户资料托管
好友关系托管
用户关系托管
在线状态订阅
群组功能
群组概述
群组管理
群成员管理
群消息管理
超大群功能
系统通知
系统通知概述
内置系统通知管理
内置系统通知未读数
自定义系统通知收发
开通聊天室功能
聊天室
反垃圾(内容审核)
域名高可用
融合存储方案
扩展功能
工具方法
最佳实践
聊天室重要消息投递
API参考
SDK API (Web)
IM UIKit Store API
状态码
IM 控制台指南
创建应用
注册 IM 账号
升级服务
开通聊天室功能
配置应用客户端标识
常见问题
FAQ
服务协议

获取频道最后一条消息

更新时间: 2022/12/21 15:55:40

网易云信 IM 的圈组模块支持在频道列表显示当前各频道的最后一条消息,且开发者可通过在应用上层自行开发相关业务逻辑,实现频道列表动态更新各频道的最后一条消息。

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

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

技术原理

网易云信 QChat Web SDK 的QChatMsgServiceInterface接口提供getLastMessageOfChannels方法,用于获取多个频道的最后一条消息的初始数据。

  • 该方法的接口原型如下:
/**
 * 获取若干个频道的最后一条消息
 * 注:被撤回的消息仍旧能被查到,而被删除的消息无法查到
 */
getLastMessageOfChannels(options: QChatGetLastMessageOfChannelsOptions): Promise<QChatGetLastMessageOfChannelsResult>
  • 该方法的响应QChatGetLastMessageOfChannelsResult返回的结果为 map, key 值对应每一个channelId,value 值是消息体QChatMessage
type QChatGetLastMessageOfChannelsResult = {
  /**
   * 其中 key 为 channelId
   */
  [key: string]: QChatMessage
}

实现方法

前提条件

接入圈组,并已创建圈组服务器和频道。

实现流程

  1. 获取频道最后一条消息的初始数据。

    1. 调用getChannelsByPage拉取频道列表。
    2. 调用getLastMessageOfChannels获取若干个频道的最后一条消息。
    • 您需自行维护调用该方法返回的结果。
    • 被撤回的消息仍能通过调用该方法查到,但被删除的消息无法查到。如果最后一条消息是撤回消息,推荐把对应的最后一条消息置空,并给出提示表明“撤回消息”。
    1. 在您的应用内存中维护相关频道的最后一条消息。
  2. 监听消息接收事件(message)和消息更新事件(messageUpdate)。

  3. 参照下表,在您的应用层自行开发,实现后续频道最后一条消息在不同场景下的动态更新。

    场景
    场景说明 推荐处理方法
    事件触发更新最后一条消息 频道内,其他用户发送消息或重发消息,触发message事件 更新频道最后一条消息
    频道内,其他用户撤回、更新或删除消息,触发messageUpdate事件 判断撤回、更新、删除的消息是否为频道最后一条消息,若非最后一条消息,则忽略;若为最后一条消息,且:
    • 为撤回或删除消息,则把最后一条消息置空
    • 为更新消息,则更新频道最后一条消息
    用户自己调用 API 后触发更新最后一条消息 自己在频道内发送、重发或更新消息 更新频道内最后一条消息
    自己在频道内撤回或删除消息 判断撤回或删除的消息是否为频道最后一条消息,若非最后一条消息,则忽略;若为最后一条消息,则把最后一条消息置空

API调用时序示例

下图以用户A、用户B 和用户C 的消息交互为例,为您展示实现频道最后一条消息动态更新的 API 调用时序,供您参考。

频道最后一条消息.png

示例代码

获取初始数据

/* 初始数据获取,设置 lastMessage */
const channels = await qchat.qchatChannel.getChannelsByPage({
  serverId: 'YOUR_SERVER_ID',
  timetag: 0,
  limit: 100
})

if (channels.datas.length === 0) {
  return
}

const channelsMap = channels.datas.reduce((total, next) => {
  channelsMap[next.channelId] = next
  return channelsMap
}, {})
const serverId = channels.datas[0].serverId
const channelIds = channels.datas.map(item => item.channelId)
const lastMessageMap = await qchat.qchatMsg.getLastMessageOfChannels({
  serverId,
  channelIdList: channelIds
})
Object.keys(lastMessageMap).forEach(key => {
  channelsMap[key].lastMessage = lastMessageMap[key]
})

事件触发更新最后一条消息

/* 设置监听,触发的更新 */
qchat.on('message', function (msg) {
  channelsMap[msg.channelId].lastMessage = msg
})
qchat.on('messageUpdate', function (msg) {
  // 撤回,单向删除消息把 lastMessage 设置为空
  if (msg.status === 1 || msg.status === 2) {
    channelsMap[msg.channelId].lastMessage = null
  } else {
    channelsMap[msg.channelId].lastMessage = msg
  }
})

用户自己调用API后触发更新最后一条消息

/* 自己调用的 API 导致的 lastMessage 更新 */
// 发送消息
const theSendMessage = await qchat.qchatMsg.sendMessage({
  serverId: 'YOUR_SERVREID',
  channelId: 'YOUR_CHANNELID',
  type: 'text',
  body: 'This is a text message'
})
channelsMap[theSendMessage.channelId].lastMessage = theSendMessage

// 更新消息
const theUpdateMessage = await qchat.qchatMsg.updateMessage({
  message: {
    ...theSendMessage,
    body: 'This is a text message after update'
  }
})
channelsMap[theSendMessage.channelId].lastMessage = theUpdateMessage

// 重发消息
const theResendMessage = await qchat.qchatMsg.resendMessage(theSendMessage)
channelsMap[theResendMessage.channelId].lastMessage = theResendMessage

// 撤回消息
await qchat.qchatMsg.revokeMessage({
  message: theSendMessage
})
channelsMap[theSendMessage.channelId].lastMessage = null

// 删除消息
await qchat.qchatMsg.deleteMessage({
  message: theSendMessage
})
channelsMap[theSendMessage.channelId].lastMessage = null

API参考

API
说明
getLastMessageOfChannels 获取多个频道的最后一条消息
此文档是否对你有帮助?
有帮助
我要吐槽
  • 技术原理
  • 实现方法
  • 前提条件
  • 实现流程
  • API调用时序示例
  • 示例代码
  • 获取初始数据
  • 事件触发更新最后一条消息
  • 用户自己调用API后触发更新最后一条消息
  • API参考