获取聊天室历史消息
更新时间:2024-02-21
PDF
开通服务
使用获取聊天室远端历史记录功能要求开通 聊天室消息云端存储服务。使用前请确认已开通服务。开通后聊天室历史消息保存在云端，默认保存 2 个月。
获取聊天室远端历史记录
当退出聊天室时，会清除本地聊天室历史消息。当再次加入聊天室时，如需获取之前的历史消息，可调用此接口。
方法
Future<int> getChatRoomMessages(String targetId, int timestamp, RCIMIWTimeOrder order, int count, {IRCIMIWGetChatRoomMessagesCallback? callback});
已复制
1
参数说明
| 参数名 | 参数类型 | 描述 |
|---|---|---|
| targetId | String | 聊天室会话 ID |
| timestamp | int | 起始的消息发送时间戳 |
| order | RCIMIWTimeOrder | 拉取顺序 0:倒序，1:正序 |
| count | int | 要获取的消息数量，0 < count <= 50。 |
| callback | IRCIMIWGetChatRoomMessagesCallback | 事件回调。SDK 从 5.3.1 版本开始支持 callback 方式回调。从 5.4.0 版本废弃该接口的其他回调方式。如果传入了 callback 参数，仅触发 callback 回调。 |
返回值
| 返回值 | 描述 |
|---|---|
| Future<int> | 当次接口操作的状态码。0 代表调用成功 具体结果需要实现接口回调，非 0 代表当前接口调用操作失败，不会触发接口回调，详细错误参考错误码 |
代码示例
IRCIMIWGetChatRoomMessagesCallback? callback = IRCIMIWGetChatRoomMessagesCallback(onSuccess: (List<RCIMIWMessage>? t) {
//...
}, onError: (int? code) {
//...
});
int? ret = await engine?.getChatRoomMessages(targetId, timestamp, order, count, callback:callback);
已复制
1
2
3
4
5
6
7
回调方法
- onChatRoomMessagesLoaded
Function(int? code, String? targetId, List<RCIMIWMessage>? messages, int? syncTime)? onChatRoomMessagesLoaded;
已复制
1
参数说明
| 参数名 | 参数类型 | 描述 |
|---|---|---|
| code | int | 接口回调的状态码，0 代表成功，非 0 代表出现异常 |
| targetId | String | 会话 ID |
| messages | List<RCIMIWMessage> | 加载到的消息 |
| syncTime | int | 下次拉取的时间戳 |
代码示例
engine?.onChatRoomMessagesLoaded = (int? code, String? targetId, List<RCIMIWMessage>? messages, int? syncTime) {
//...
};
已复制
1
2
3
131 6185 6839