跳到主要内容

获取聊天室历史消息

开通服务

使用获取聊天室远端历史记录功能要求开通 聊天室消息云端存储服务。使用前请确认已开通服务。开通后聊天室历史消息保存在云端,默认保存 2 个月。

获取聊天室远端历史记录

当退出聊天室时,会清除本地聊天室历史消息。当再次加入聊天室时,如需获取之前的历史消息,可调用此接口。

方法

getChatRoomMessages(
targetId: string,
timestamp: number,
order: RCIMIWTimeOrder,
count: number,
callback: IRCIMIWGetChatRoomMessagesCallback
): Promise<number>;

参数说明

参数名参数类型描述
targetIdstring聊天室会话 ID
timestampnumber起始的消息发送时间戳
orderRCIMIWTimeOrder拉取顺序 0:倒序,1:正序
countnumber要获取的消息数量,count 大于 0,小于等于 50。
callbackIRCIMIWGetChatRoomMessagesCallback事件回调。SDK 从 5.3.1 版本开始支持 callback 方式回调。从 5.4.0 版本废弃该接口的其他回调方式。如果传入了 callback 参数,仅触发 callback 回调。

返回值

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

代码示例

let callback = {
onSuccess:(res) => {
//...
},
onError:(res) => {
//...
}};
let code = await engine.getChatRoomMessages(targetId, timestamp, order, count, callback);

回调方法

  • setOnChatRoomMessagesLoadedListener
setOnChatRoomMessagesLoadedListener(listener?: ({code, targetId, messages, syncTime}) => void): void;

参数说明

参数名参数类型描述
codenumber接口回调的状态码,0 代表成功,非 0 代表出现异常
targetIdstring会话 ID
messagesArray<RCIMIWMessage>加载到的消息
syncTimenumber下次拉取的时间戳

代码示例

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