插入消息

插入单条消息

• 通过该功能在本地会话中插入一条消息。
• 插入的消息必须是可存储消息，否则报参数错误异常。
• 消息插入功能插入的消息仅支持配置会话类型、会话 ID、频道 ID、消息的发送方向、消息的发送时间以及各类消息独有的可访问属性。
• 默认不配置的情况下插入的是一条发送方的已经发送成功的消息

方法

TypeScript

insertMessage(
  message: RCIMIWMessage,
  callback: IRCIMIWInsertMessageCallback
): Promise<number>;

参数说明

参数名	参数类型	描述
message	RCIMIWMessage	插入的消息
callback	IRCIMIWInsertMessageCallback	事件回调。SDK 从 5.3.1 版本开始支持 callback 方式回调。从 5.4.0 版本废弃该接口的其他回调方式。如果传入了 callback 参数，仅触发 callback 回调。

返回值

返回值	描述
Promise<number>	当次接口操作的状态码。0 代表调用成功 具体结果需要实现接口回调，非 0 代表当前接口调用操作失败，不会触发接口回调，详细错误参考状态码文档。

代码示例

TypeScript

let callback = {
onMessageInserted:(res) => {
//...
}};
let code = await engine.insertMessage(message, callback);

回调方法

• setOnMessageInsertedListener

  接口调用结果的监听

TypeScript

setOnMessageInsertedListener(listener?: ({code, message}) => void): void;

参数说明

参数名	参数类型	描述
code	number	接口回调的状态码，0 代表成功，非 0 代表出现异常
message	RCIMIWMessage	插入的消息

代码示例

TypeScript

engine.setOnMessageInsertedListener((res) => {
    //...
});

插入多条消息

• 通过该功能在本地会话中插入多条消息。
• 插入的消息必须是可存储消息，否则报参数错误异常。
• 消息插入功能插入的消息仅支持配置会话类型、会话 ID、频道 ID、消息的发送方向、消息的发送时间以及各类消息独有的可访问属性。
• 默认不配置的情况下插入的是一条发送方的已经发送成功的消息
• 建议每次最多传入 10 条，当有一条失败时，所有的消息都会插入失败

方法

TypeScript

insertMessages(
  messages: Array<RCIMIWMessage>,
  callback: IRCIMIWInsertMessagesCallback
): Promise<number>;

参数说明

参数名	参数类型	描述
messages	Array<RCIMIWMessage>	插入的消息集合
callback	IRCIMIWInsertMessagesCallback	事件回调。SDK 从 5.3.1 版本开始支持 callback 方式回调。从 5.4.0 版本废弃该接口的其他回调方式。如果传入了 callback 参数，仅触发 callback 回调。

返回值

返回值	描述
Promise<number>	当次接口操作的状态码。0 代表调用成功 具体结果需要实现接口回调，非 0 代表当前接口调用操作失败，不会触发接口回调，详细错误参考状态码文档。

代码示例

TypeScript

let callback = {
onMessagesInserted:(res) => {
//...
}};
let code = await engine.insertMessages(messages, callback);

回调方法

• setOnMessagesInsertedListener

  接口调用结果的监听

TypeScript

setOnMessagesInsertedListener(listener?: ({code, messages}) => void): void;

参数说明

参数名	参数类型	描述
code	number	接口回调的状态码，0 代表成功，非 0 代表出现异常
messages	Array<RCIMIWMessage>	插入的消息集合

代码示例

TypeScript

engine.setOnMessagesInsertedListener((res) => {
    //...
});