浏览 SDKs · React Native
平台
SDKsReact Native商业版

读取消息上下文

OpenIM React Native SDK 读取消息上下文。

复制

以一条已获取的锚点消息为基准,向前和向后读取其相邻的上下文消息记录。适合在用户从搜索结果、引用回复或特定跳转定位到某条消息时,还原当时完整的对话语境。

const { messageList } = await OpenIMSDK.fetchSurroundingMessages({
  startMessage: targetMessage,
  viewType: ViewType.Search,
  before: 20,
  after: 20,
});

参数说明

参数类型必填含义
startMessageMessageItem是作为基准的锚点消息对象。
viewTypeViewType是上下文查看场景类型;从搜索结果进入时传入 ViewType.Search。
beforenumber是锚点消息之前(更早产生)最多读取的消息条数。
afternumber是锚点消息之后(更新产生)最多读取的消息条数。

返回结果

调用成功后返回包含上下文消息数组的对象 { messageList: MessageItem[] }。

  • 列表中消息按发送时间升序排列,并包含锚点消息本身。
  • 实际返回的消息数量可能小于 before + after + 1(例如锚点处于会话开头、末尾,或临近消息已被删除)。
  • 客户端在渲染时应以 clientMsgID 为合并标识对消息列表进行去重,避免与当前已加载的消息重复。