跳到主要内容
版本:5.X

获取历史消息(Electron)

本文档仅适用于 Electron 解决方案,仅限于配合 Electron 模块 (@rongcloud/electron@rongcloud/electron-renderer)使用。

开通服务

从远端获取单群聊历史消息是指从融云服务端获取历史消息,该功能要求 App Key 已启用融云提供的单群聊消息云端存储服务。您可以在控制台 IM 服务管理页面为当前使用的 App Key 开启服务。如果使用生产环境的 App Key,请注意仅 IM 旗舰版IM 尊享版可开通该服务。具体功能与费用以融云官方价格说明页面及计费说明文档为准。

提示:请注意区分历史消息记录与离线消息?。融云针对单聊、群聊、系统消息默认提供最多 7 天(可调整)的离线消息缓存服务。客户端上线时 SDK 会自动收取离线期间的消息,无需 App 层调用 API。详见管理离线消息存储配置

从本地数据库中获取消息

获取会话中所有类型的消息

调用 getHistoryMessages 可以拉取指定某个会话的历史消息记录。

const conversation = {
conversationType: RongIMLib.ConversationType.PRIVATE,
targetId: "<目标用户Id>"
}

// 从当前时间开始向前查询
const option = {
timestamp: 0,
count: 20,
order: 0
}

RongIMLib.getHistoryMessages(conversation, option).then(res => {
if (res.code === 0) {
console.log(res.data.list)
console.log(res.data.hasMore)
} else {
console.log(res.code, res.msg)
}
})

参数类型说明
conversationIConversationOption获取消息所指定的会话
optionsGetHistoryMessageOption参数配置。详见下方 GetHistoryMessageOption 说明
  • GetHistoryMessageOption 说明

    参数类型说明
    timestampnumber(可选项)用于控制分页查询消息的边界。查询以此时间戳为基准,根据 order 决定查询早于或晚于该时间戳的消息。timestamp0 表示从当前时间开始获取。
    countnumber(可选项)获取消息的数量。如果 SDK < 5.7.4,范围为 [1-20];如果 SDK ≧ 5.7.4,范围为 [1-100]。默认值 20
    ordernumber(可选项)查询消息的方向,值为 010 表示降序,即按消息发送时间(timestamp)递减的顺序,获取发送时间早于 timestamp 的消息。1 表示升序,即按消息发送时间(timestamp)递增的顺序,获取发送时间晚于 timestamp 的消息。

获取会话中指定类型的消息

调用 electronExtension.getHistoryMessagesByMessageTypes 可以拉取指定某个会话指定消息类型的历史消息记录。

const conversation = {
conversationType: RongIMLib.ConversationType.PRIVATE,
targetId: "<目标用户Id>"
}

// 从当前时间开始向前查询
const options = {
timestamp: 0,
count: 20,
order: 0,
messageTypes: ['RC:TxtMsg']
}

RongIMLib.electronExtension.getHistoryMessagesByMessageTypes(conversation, option).then(res => {
if (res.code === 0) {
// res.data.messages 从 5.6.1 开始废弃,5.6.1 及之后版本请使用 res.data.list
console.log(res.data.list)
console.log(res.data.hasMore)
} else {
console.log(res.code, res.msg)
}
})

参数类型说明
conversationIConversationOption获取消息所指定的会话
optionsIGetHistoryMessagesByTypesOption参数配置

获取远端历史消息

调用 getRemoteHistoryMessages 可以拉取指定某个会话的远端历史消息记录。

const conversation = {
conversationType: RongIMLib.ConversationType.PRIVATE,
targetId: "<目标用户Id>"
}

// 从当前时间开始向前查询
const option = {
timestamp: 0,
count: 20,
order: 0
}

RongIMLib.getRemoteHistoryMessages(conversation, option).then(res => {
if (res.code === 0) {
console.log(res.data.list)
console.log(res.data.hasMore)
} else {
console.log(res.code, res.msg)
}
})

参数类型说明
conversationIConversationOption获取消息所指定的会话
optionsGetHistoryMessageOption参数配置

获取本地与远端历史消息

getContinuousMessages 方法与 getRemoteHistoryMessages 的区别是 getContinuousMessages 会先查询指定会话存储本地数据库的消息,当本地消息无法满足查询条件时,再查询在单群聊消息云端存储中的历史消息,以返回连续且相邻的消息对象列表。

const conversation = {
conversationType: RongIMLib.ConversationType.PRIVATE,
targetId: "<目标用户Id>"
}

// 从当前时间开始向前查询
const option = {
timestamp: 0,
count: 20,
order: 0
}

RongIMLib.electronExtension.getContinuousMessages(conversation, option).then(res => {
if (res.code === 0) {
console.log(res.data.list)
console.log(res.data.hasMore)
// 如果您想继续查询更多历史消息,建议使用 res.data.timestamp 作为下次调用的 option.timestamp
console.log(res.data.timestamp)
} else {
console.log(res.code, res.msg)
}
})

参数类型说明
conversationIConversationOption获取消息所指定的会话
optionsGetHistoryMessageOption参数配置