获取会话列表

---

功能简介

会话，指只有在用户发送“单聊/群聊”消息（文本/富媒体消息，不包含信令消息）时，ZIM SDK 才会自动建立的逻辑关系。

ZIM SDK 支持用户监听会话变更，并从本地数据库拉取会话列表，也支持开发者从 ZIM 服务端获取指定用户的全量会话列表。

开发者可在社交聊天、游戏社区、在线咨询等场景中获取并展示单聊、群聊会话列表。

前提条件

在获取会话列表之前，请确保：

• 已在 ZEGO 控制台 创建项目，获取到了接入 ZIM SDK 服务所需的 AppID、AppSign。ZIM 服务权限不是默认开启的，使用前，请先在 ZEGO 控制台 自助开通 ZIM 服务（详情请参考控制台的 服务配置 - 即时通讯 - 开通服务），若无法开通 ZIM 服务，请联系 ZEGO 技术支持开通。
• 已集成 ZIM SDK，详情请参考 快速开始 - 实现基本收发消息 的 “2 集成 SDK”。

监听会话变更

在用户登录之前，请调用 setEventHandler 接口，监听 conversationChanged 回调，将会在如下情形时收到会话变更通知：

此时开发者可根据需求 获取会话列表。

// 注册 SDK 事件通知回调
[self.zim setEventHandler:self];

...

- (void)zim:(ZIM *)zim conversationChanged:(NSArray<ZIMConversationChangeInfo *> *)conversationChangeInfoList {
    // 获取会话变更列表
    for (ZIMConversationChangeInfo *info in conversationChangeInfoList) {
        if (info.event == ZIMConversationEventAdded) {
            // 添加到开发者自行维护的列表中，同时刷新 UI
        } else if (info.event == ZIMConversationEventUpdated) {
           // 修改会话属性，同时刷新 UI
        }
    }
}

获取会话列表

ZIM 支持开发者调用 SDK 接口从本地数据库获取当前用户的会话列表，也支持向 ZIM 服务端发起请求获取指定用户的全量会话列表。

拉取到会话列表后，开发者可以用于自定义会话列表的 UI 展示。

从本地数据库获取

用户登录后，如果想要查询自己参与过的会话记录，可以调用 queryConversationListWithConfig 接口，拉取会话数据列表。

由于本地会话可能数量较多，拉取会话时，开发者可以通过 ZIMConversationQueryConfig 对象，设置自定义分页拉取会话的数量，避免引起一次性拉取过多的会话导致耗时较久、会话界面加载较慢等问题。

ZIMConversationQueryConfig *config = [[ZIMConversationQueryConfig alloc] init];
// 会话锚点，传空则代表从最新开始查询
config.nextConversation = nil;
// 会话一次分页查询数
config.count = 20;

// 拉取会话列表
[self.zim queryConversationListWithConfig:config callback:^(NSArray<ZIMConversation *> * _Nonnull conversationList, ZIMError * _Nonnull errorInfo) {
    // 获取会话列表查询结果
    if(errorInfo.code == ZIMErrorCodeSuccess) {
      // 开发者需要保存和维护数组内的会话对象
    } else {
      // ......
    }
}];

从 ZIM 服务端获取

开发者可以通过调用服务端 API 获取用户的会话列表，详情请参考服务端 API 文档 查询会话列表。