获取会话
IMLib SDK 会根据用户收发的消息，在本地数据库中生成对应会话，并维护会话列表。应用程序可以获取本地数据库中的会话列表。自 5.20.0 版本起，SDK 支持在获取会话列表中返回超级群会话信息，您可根据业务需求对单聊、群聊、超级群会话列表进行混合排序展示。该功能需提交工单申请开通。
获取指定单个会话
您可以使用 getConversation:targetId:completion: 获取某个会话的详细信息。
接口原型
- (void)getConversation:(RCConversationType)conversationType
targetId:(NSString *)targetId
completion:(nullable void(^)(RCConversation *_Nullable conversation))completion;
参数说明
| 参数 | 类型 | 说明 |
|---|---|---|
| conversationType | RCConversationType | 会话类型，单聊传入 ConversationType_PRIVATE |
| targetId | NSString | 会话 targetId |
| completion | Block | 结果回调，返回 RCConversation 对象 |
示例代码
[[RCCoreClient sharedCoreClient] getConversation:ConversationType_PRIVATE
targetId:@"targetId"
completion:^(RCConversation *conversation) {
}];
批量获取会话信息
除了单个获取会话信息外，您还可以通过 IMLib SDK 批量获取会话的详细信息。
- 客户端 SDK 从 5.8.2 版本开始支持批量获取会话信息。
- 支持的会话类型：单聊、群聊、系统。
使用 getConversations:success:error: 方法查询多个会话的详细信息。如果本地数据库中只有部分会话信息，successBlock 结果只返回本地存在的会话；如果查询的多个会话信息在本地都查不到，将触发 errorBlock 回调。
接口原型
- (void)getConversations:(NSArray<RCConversationIdentifier *> *)conversationIdentifiers
success:(nullable void(^)(NSArray<RCConversation *> * conversations))successBlock
error:(nullable void (^)(RCErrorCode status))errorBlock;
参数说明
| 参数 | 类型 | 说明 |
|---|---|---|
| conversationIdentifiers | NSArray | 需要查询的会话标识符数组，每次获取会话个数最大为 100。 |
| success | Block | 获取会话信息成功的回调，返回包含会话信息的数组。 |
| error | Block | 获取会话信息失败的错误回调，返回错误码。 |
示例代码
// 假设我们有会话标识 conIden1 和 conIden2，它们代表想要查询的会话。
RCConversationIdentifier *conIden1 = [[RCConversationIdentifier alloc] initWithConversationIdentifier:ConversationType_PRIVATE targetId:@"tId1"];
RCConversationIdentifier *conIden2 = [[RCConversationIdentifier alloc] initWithConversationIdentifier:ConversationType_PRIVATE targetId:@"tId2"];
// 创建包含会话标识符的数组。
NSArray *conversationIdentifiers = @[
conIden1,
conIden2
// 如果有更多的会话标识符，可以继续添加到这个数组中。
];
// 使用 getConversations:success:error: 方法批量获取会话信息
[[RCCoreClient sharedCoreClient] getConversations:conversationIdentifiers
success:^(NSArray<RCConversation *> * _Nonnull conversations) {
// 成功获取会话信息的处理逻辑。
}
error:^(RCErrorCode status) {
// 错误处理逻辑，status 为错误码。
// 根据 status 进行相应的错误处理。
NSLog(@"Error fetching conversations: %@", @(status));
}];
同步服务端会话信息到本地
SDK 从 5.20.0 版本开始提供该接口。您可提交工单开通此功能。
针对更端设备登录或卸载重新安装应用的情况下，您可通过 getRemoteConversationListWithSuccess:error: 接口可以将服务端的会话信息同步到本地，最多可同步 1000 条会话。
该接口只触发拉取操作，会话同步完成后，通过 RCConversationDelegate 代理监听同步结果 。当收到 remoteConversationListDidSync: 回调后，表示远端会话信息已经同步到本地。
// 发起拉取远端会话请求。
[[RCCoreClient sharedCoreClient] getRemoteConversationListWithSuccess:^{
// get success.
} error:^(RCErrorCode errorCode) {
// get failed.
}];
| 参数 | 类型 | 说明 |
|---|---|---|
| success | Block | 成功回调 |
| error | Block | 错误回调 |
// 注册接口会话同步代理
[[RCCoreClient sharedCoreClient] setRCConversationDelegate:self];
// 会话同步完成回调。
- (void)remoteConversationListDidSync:(RCErrorCode)code {
if (RC_SUCCESS == code ) {
// conversation sync complete.
}
}
获取会话列表
会话列表是 IMLib SDK 在本地生成和维护的。如果未发生卸载重载或换设备登录，您可以获取本地设备 上存储的所有历史消息生成的会话列表。
分页获取会话列表
使用 getConversationList:count:startTime:completion: 分页获取 SDK 在本地数据库生成的会话列表。返回的会话列表按照时间倒序排列。如果返回结果含有被设置为置顶状态的会话，则置顶会话默认排在最前。
时间戳（startTime）首次可传 0，后续可以使用返回的 RCConversation 对象的 operationTime 属性值为下一次查询的 startTime。
从 5.6.8 版本开始，需要使用会话的 operationTime；5.6.8 之前的版本，还需使用会话的 sentTime。
接口原型
- (void)getConversationList:(NSArray<NSNumber *> *)conversationTypeList
count:(int)count
startTime:(long long)startTime
completion:(nullable void(^)(NSArray<RCConversation *> *_Nullable conversationList))completion;
如果您希望返回的会话列表严格按照时间倒序排列，请使用带 topPriority 参数的方法，并将该参数设置为 NO。该方法仅在 5.6.9 及之后版本提供。
- (void)getConversationList:(NSArray<NSNumber *> *)conversationTypeList
count:(int)count
startTime:(long long)startTime
topPriority:(BOOL)topPriority
completion:(nullable void(^)(NSArray<RCConversation *> *_Nullable conversationList))completion;
参数说明
| 参数 | 类型 | 说明 |
|---|---|---|
| conversationTypeList | NSArray | 会话类型的数组，需要将 RCConversationType 转为 NSNumber 构建 Array。 |
| count | int | 获取的数量 |
| startTime | long long | 指定时间戳，以获取早于这个时间戳的会话列表。首次可传 0，表示从最新开始获取。后续使用真实时间戳。 |
| topPriority | boolean | 是否优先显示置顶消息。要求 SDK 版本 ≧ 5.6.9。 |
| completion | Block | 获取会话列表成功的回调 |
示例代码
[[RCCoreClient sharedCoreClient] getConversationList:@[@(ConversationType_PRIVATE)]
count:100
startTime:0
completion:^(NSArray<RCConversation *> *conversationList) {
}];
[[RCCoreClient sharedCoreClient] getConversationList:@[@(ConversationType_PRIVATE)]
count:100
startTime:0
topPriority:NO
completion:^(NSArray<RCConversation *> *conversationList) {
}];
获取未读会话列表
IMLib SDK 从 5.3.2 版本开始提供该接口。
您可以使用 getUnreadConversationList:completion: 获取指定类型的含有未读消息的会话列表，支持单聊、群聊、系统会话，返回 RCConversation 列表，获取到的会话列表按照时间倒序排列，置顶会话会排在最前。
接口原型
- (void)getUnreadConversationList:(NSArray<NSNumber *> *)conversationTypeList
completion:(nullable void(^)(NSArray<RCConversation *> *_Nullable conversationList))completion;
参数说明
| 参数 | 类型 | 说明 |
|---|---|---|
| conversationTypeList | NSArray | 会话类型的数组，需要将 RCConversationType 转为 NSNumber 构建 Array |
| completion | Block | 获取会话列表成功的回调 |
按会话类型获取会话列表
SDK 从 5.20.0 版本开始提供该接口。
使用 getConversationListByFilters:option:completion: 接口按会话类型获取会 话列表。
RCConversationTypeFilter *filter = [[RCConversationTypeFilter alloc] initWithType:ConversationType_GROUP];
RCConversationListOption *option = [[RCConversationListOption alloc] init];
option.startTime = 0;
option.count = 20;
option.topPriority = YES;
[[RCChannelClient sharedChannelManager] getConversationListByFilters:@[filter]
option:option
completion:^(NSArray<RCConversation *> *conversations, RCErrorCode code) {
// get conversations.
}];
| 参数 | 类型 | 说明 |
|---|---|---|
| filter | NSArray | 过滤条件 |
| option | RCConversationListOption | 列表配置 |
| completion | Block | 获取会话列表成功的回调 |
示例代码
[[RCCoreClient sharedCoreClient] getUnreadConversationList:@[@(ConversationType_GROUP),@(ConversationType_SYSTEM),@(ConversationType_PRIVATE)]
completion:^(NSArray<RCConversation *> * _Nullable conversationList) {
}];
卸载重装或换设备登录后的处理方案
如果您的用户卸载重装或换设备登录，可能会发现会话列表为空，或者有部分会话没有显示。
原因如下：
- 在卸载的时候会删除本地数据库，本地没有任何历史消息，导致重新安装后会话列表为空。
- 如果换设备登录，可能本地没有历史消息数据，导致会话列表为空。
- 如果您的 App Key 开启了多设备消息同步 功能，服务端会同时启用离线消息补偿功能。服务端会在 SDK 连接成功后自动同步当天 0 点后的消息，客户端 SDK 接收到服务端补偿的消息后，可生成部分会话 和会话列表。与卸载前或换设备前比较，可能会有部分会话丢失的错觉。
如果您希望在卸载重装或换设备登录后，获取到之前的会话列表，可以参考如下方案：
- 申请增加离线消息补偿的天数，最大可修改为 7 天。注意，设置时间过长，当单用户消息量超大时，可能会因为补偿消息量过大，造成端上处理压力的问题。如有需要，请提交工单。
- 在您的服务器中自行维护会话列表，并通过 API 向服务端获取需要展示的历史消息。