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

插入消息（Electron）

本文档仅适用于 Electron 解决方案，仅限于配合 Electron 模块 （@rongcloud/electron 与 @rongcloud/electron-renderer）使用。

SDK 支持在 Electron 的本地数据库中插入消息。本地插入的消息不会实际发送给服务器和对方。

插入单条消息​

在本地会话中插入一条发送方向或接收方向的消息。消息进入本地数据库，但不会发送给服务器和对方。不支持聊天室会话类型。以下示例使用 electronExtension.insertMessage 方法，插入 IAReceivedMessage。

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

const message = {
  senderUserId: '<userId>',
  messageType: RongIMLib.MessageType.TEXT,
  content: {
      content: '插入一条消息'
  },
  messageDirection: RongIMLib.MessageDirection.SEND
}

RongIMLib.electronExtension.insertMessage(conversation, message).then(res => {
  if (res.code === RongIMLib.ErrorCode.SUCCESS) {
    // 消息插入成功，返回 IAReceivedMessage 类型的消息数据。
    console.log('消息插入成功', res.data)
  } else {
    console.log('消息插入失败', res.code, res.msg)
  }
})
  • 插入 IAReceivedMessage 时，可通过 messageDirection 控制消息方向。
  • 从 5.6.1 开始，SDK 支持插入 BaseMessage。插入 BaseMessage 时不支持控制消息方向，SDK 默认插入发送方向的消息。
  • 插入本地数据库的消息如需支持消息扩展功能（详见消息扩展），必须使用 IAReceivedMessage，并打开消息的可扩展属性（canIncludeExpansion）。
参数类型说明
conversationIConversationOption会话
messageBaseMessage（推荐） 或 IAReceivedMessage插入的消息。从 5.6.1 开始支持插入 BaseMessage。
optionsIInsertOptions选项
  • options 定义发送行为中的一些可选配置。参见 IInsertOptions
参数类型说明
isUnreadboolean插入消息是否计入未读数: true 计数 false 不计数, 默认不计数
searchContentstring消息搜索关键字(可选参数)
disableUpdateLastMessageboolean禁止更新会话最后一条消息，默认为 false，从版本 5.12.2 开始支持。

批量插入消息​

提示
  • 从 5.7.2 版本开始支持该功能。
  • 每次最多插入 500 条消息，不支持聊天室和超级群。

在本地数据库批量插入消息。

js

const messages = [{
  conversationType: RongIMLib.ConversationType.PRIVATE,
  targetId: '<目标用户ID>'
  senderUserId: '<userId>',
  messageType: RongIMLib.MessageType.TEXT,
  content: {
      content: '插入一条消息'
  },
  messageDirection: RongIMLib.MessageDirection.SEND,
  messageUId: '<消息唯一值>',

}]

const checkDuplicate = false

RongIMLib.electronExtension.batchInsertMessage(messages, checkDuplicate).then(res => {
  if (res.code === RongIMLib.ErrorCode.SUCCESS) {
    // 消息插入成功
    console.log('批量插入成功', res.data)
  } else {
    // 如果消息格式不正确，res.msg 返回该消息在数组中的下标号
    console.log('批量插入失败', res.code, res.msg)
  }
})
参数类型说明
messagesIInsertMessage[]需要批量插入的消息数组
checkDuplicateBoolean消息是否排重
最后于 更新