获取会话

客户端 SDK 会根据收发的消息在本地数据库中生成对应会话。您可以从本地数据库获取 SDK 生成的会话列表。

获取会话列表

通过以下接口分页获取 SDK 在本地数据库生成的会话列表。获取到的会话列表按照时间倒序排列，置顶会话会排在最前。

方法

Dart

Future<int> getConversations(List<RCIMIWConversationType> conversationTypes, String? channelId, int startTime, int count, {IRCIMIWGetConversationsCallback? callback});

参数说明

参数名	参数类型	描述
conversationTypes	List<RCIMIWConversationType>	会话类型
channelId	String	频道 ID，仅支持超级群使用，其他会话类型传 null 即可
startTime	int	时间戳（毫秒），获取小于此时间戳的会话，传 0 为查询最新数据。在分页获取会话时，传入回调结果中最后一条会话数据的 operationTime，来获取下一页数据。
count	int	查询的数量， 0 < count ≤ 50
callback	IRCIMIWGetConversationsCallback	获取会话列表事件回调。SDK 从 5.3.1 版本开始支持 callback 方式回调。从 5.4.0 版本废弃该接口的其他回调方式。如果传入了 callback 参数，仅触发 callback 回调。

返回值

返回值	描述
Future<int>	当次接口操作的状态码。0 代表接口调用成功，具体业务结果需要从接口回调获取；非 0 代表当前接口调用操作失败，不会触发接口回调。详细错误参考错误码。

代码示例

Dart

IRCIMIWGetConversationsCallback? callback = IRCIMIWGetConversationsCallback(
onSuccess: (List<RCIMIWConversation>? t) {
//...
},
onError: (int? code) {
//...
});

int? ret = await engine?.getConversations(conversationTypesInt, channelId, startTime, count, callback:callback);

获取指定会话

获取某个会话的详细信息。

方法

Dart

Future<int> getConversation(RCIMIWConversationType type, String targetId, String? channelId, {IRCIMIWGetConversationCallback? callback});

参数说明

参数名	参数类型	描述
type	RCIMIWConversationType	会话类型
targetId	String	会话 ID
channelId	String	频道 ID，仅支持超级群使用，其他会话类型传 null 即可
callback	IRCIMIWGetConversationCallback	获取会话事件回调。SDK 从 5.3.1 版本开始支持 callback 方式回调。从 5.4.0 版本废弃该接口的其他回调方式。如果传入了 callback 参数，仅触发 callback 回调。

返回值

返回值	描述
Future<int>	当次接口操作的状态码。0 代表接口调用成功，具体业务结果需要从接口回调获取；非 0 代表当前接口调用操作失败，不会触发接口回调。详细错误参考错误码。

代码示例

Dart

IRCIMIWGetConversationCallback? callback = IRCIMIWGetConversationCallback(
onSuccess: (RCIMIWConversation? t) {
//...
}, onError: (int? code) {
//...
});

int? ret = await engine?.getConversation(type, targetId, channelId, callback:callback);

同步服务端会话信息到本地

提示

SDK 从 5.32.1 版本开始提供该接口。您可提交工单申请开通远程会话列表同步功能。

针对更换设备登录或卸载重新安装应用的情况下，使用 getRemoteConversationList() 接口可以将服务端的会话信息同步到本地。该接口只触发拉取操作，会话同步完成后，通过 onRemoteConversationListSynced 监听同步结果。

方法

Dart

Future<int> getRemoteConversationList({IRCIMIWOperationCallback? callback});

参数说明

参数名	参数类型	描述
callback	IRCIMIWOperationCallback	操作回调

返回值

返回值	描述
Future<int>	当次接口操作的状态码。0 代表接口调用成功，具体业务结果需要从接口回调获取；非 0 代表当前接口调用操作失败，不会触发接口回调。详细错误参考错误码。

代码示例

Dart

// 发起拉取远端会话请求
IRCIMIWOperationCallback? callback = IRCIMIWOperationCallback(
onSuccess: () {
//...
},
onError: (int? code) {
//...
});

int? ret = await engine?.getRemoteConversationList(callback: callback);

Dart

// 监听远端会话列表同步完成
engine?.onRemoteConversationListSynced = (int? code) {
//...
};

获取未读列表

获取指定类型的含有未读消息的会话列表，支持单聊、群聊、系统会话。获取到的会话列表按照时间倒序排列，置顶会话会排在最前。

方法

Dart

Future<int> getUnreadConversations(List<RCIMIWConversationType> conversationTypes, {IRCIMIWGetUnreadConversationsCallback? callback});

参数说明

参数名	参数类型	描述
conversationTypes	List<RCIMIWConversationType>	支持单聊、群聊、系统会话
callback	IRCIMIWGetUnreadConversationsCallback	获取会话列表事件回调。

返回值

返回值	描述
Future<int>	当次接口操作的状态码。0 代表接口调用成功，具体业务结果需要从接口回调获取；非 0 代表当前接口调用操作失败，不会触发接口回调，详细错误参考错误码。

代码示例

Dart

IRCIMIWGetUnreadConversationsCallback? callback = IRCIMIWGetUnreadConversationsCallback(
onSuccess: (List<RCIMIWConversation>? t) {
//...
},
onError: (int? code) {
//...
});

int? ret = await engine?.getUnreadConversations(conversationTypesInt, callback:callback);

常见问题

Q1: 当用户卸载重新安装后发现会话列表为空或者部分会话丢失

A1: 由于会话列表是从本地数据库获取的,是在 SDK 内部数据库存储的,所以当用户在卸载的时候会删除本地数据库,导致重新安装后会话列表为空。而会出现部分会话的原因是因为开启了消息补偿功能,具体操作是在需先按控制台内嵌指南嵌入到管理后台的 IM 服务功能配置页面（page_code: im_service_config）中，进入 多端 > 多设备消息同步，开启该功能。这个功能里默认涵盖了当天(当天 0 点)的消息补偿,所以当用户在新设备登录会触发消息补偿功能,从而获取到部分会话,造成部分会话丢失的错觉。如果想要更多天的消息补偿,可提交工单修改,最多支持 7 天。设置时间过长,当单用户消息量超大时,可能会因为补偿消息量过大,造成端上处理压力的问题。