插入消息
SDK 支持在本地数据库中插入消息。本地插入的消息不会实际发送给服务器和对方。
- 请确保所有插入消息均为可存储消息,否则会报错。
- 插入消息的接口仅将消息插入本地数据库,所以 App 卸载重装或者换端登录时插入的消息不会从远端同步到本地数据库。
插入单条消息
- 通过该功能在本地会话中插入一条消息。
- 插入的消息必须是可存储消息,否则报参数错误异常。
- 消息插入功能插入的消息仅支持配置会话类型、会话 ID、频道 ID、消息的发送方向、消息的发送时间以及各类消息独有的可访问属性。
- 默认不配置的情况下插入的是一条发送方的已经发送成功的消息
方法
insertMessage(
message: RCIMIWMessage,
callback: IRCIMIWInsertMessageCallback
): Promise<number>;
参数说明
参数名 | 参数类型 | 描述 |
---|---|---|
message | RCIMIWMessage | 插入的消息 |
callback | IRCIMIWInsertMessageCallback | 接口调用结果回调。 |
返回值
返回值 | 描述 |
---|---|
number | 当次接口操作的状态码。0 代表调用成功 具体结果需要实现接口回调,非 0 代表当前接口调用操作失败,不会触发接口回调,详细错误参考错误码 |
代码示例
const callback = {
onMessageInserted: (code: number, message: RCIMIWMessage) => {
//...
},
};
let code = await engine.insertMessage(message, callback);
插入多条消息
- 通过该功能在本地会话中插入多条消息。
- 插入的消息必须是可存储消息,否则报参数错误异常。
- 消息插入功能插入的消息仅支持配置会话类型、会话 ID、频道 ID、消息的发送方向、消息的发送时间以及各类消息独有的可访问属性。
- 默认不配置的情况下插入的是一条发送方的已经发送成功的消息
- 建议每次最多传入 10 条,当有一条失败时,所有的消息都会插入失败
方法
insertMessages(
messages: Array<RCIMIWMessage>,
callback: IRCIMIWInsertMessagesCallback
): Promise<number>;
参数说明
参数名 | 参数类型 | 描述 |
---|---|---|
messages | Array<RCIMIWMessage> | 插入的消息集合 |
callback | IRCIMIWInsertMessagesCallback | 接口调用结果回调。 |
返回值
返回值 | 描述 |
---|---|
number | 当次接口操作的状态码。0 代表调用成功 具体结果需要实现接口回调,非 0 代表当前接口调用操作失败,不会触发接口回调,详细错误参考错误码 |
代码示例
const callback = {
onMessagesInserted: (code: number, messages: Array<RCIMIWMessage>) => {
//...
},
};
let code = await engine.insertMessages(messages, callback);