获取聊天室历史消息

开通服务

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

获取聊天室远端历史记录

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

方法

TypeScript

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

参数说明

参数名	参数类型	描述
targetId	string	聊天室会话 ID
timestamp	number	起始的消息发送时间戳
order	RCIMIWTimeOrder	拉取顺序 0:倒序，1:正序
count	number	要获取的消息数量，0 < count ≤ 50。
callback	IRCIMIWGetChatRoomMessagesCallback	接口调用结果回调。

返回值

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

代码示例

TypeScript

const callback = {
    onSuccess: (t: Array<RCIMIWMessage>) => {
        //...
    },
    onError: (code: number) => {
        //...
    },
};
let code = await engine.getChatRoomMessages(targetId, timestamp, order, count, callback);