API参考
下面对SDK API涉及到的核心类作一个简要的介绍。详细API文档见：
SDK入口
| 核心类 | 描述 | 版本 |
|---|---|---|
| KIM | WOASDK 入口类，提供SDK初始化，账号登录，获取版本信息等方法。除此之外还提供各模块入口类的获取，如可通过 KIM.chatModule 得到会话模块 KIMChatModule 对象。 | V1.30.0 |
全局配置
| 核心类 | 描述 | 版本 |
|---|---|---|
| KIMUIConfig | 全局UI配置类，UI主题相关配置声明在该类中。通过 KIM.uiConfig 访问。 | V1.30.0 |
| KIMSetting | 全局设置类，提供多语言设置、消息推送通知设置、文件缓存清理等全局设置方法。通过 KIM.setting 访问。 | V1.30.0 |
会话相关
| 核心类 | 描述 | 版本 |
|---|---|---|
| KIMCore | 定义在 KIMCore.xcframework 中，提供IM会话消息的核心数据接口，包括获取会话列表数据、获取消息列表数据，会话操作、发送消息、接收消息等。 | V1.30.0 |
| KIMChatModule | 会话模块类。提供部分会话业务数据接口及会话相关页面的 UI配置，通过 KIM.chatModule 访问。 | V1.30.0 |
| KIMChatListConfig | 会话列表页面配置类。提供会话列表页面UI配置，通过 KIM.chatModule.chatListConfig 访问。 | V1.30.0 |
| KIMChatMessageListConfig | 消息列表页面配置类。提供消息列表页面UI配置，通过 KIM.chatModule.chatMessageListConfig 访问。 | V1.30.0 |
| KIMChatListViewController | 会话列表视图控制器。主要负责会话列表页面展示及交互逻辑。可直接使用该类初始化或使用子类继承的方式进行集成会话列表页面。 | V1.30.0 |
| KIMChatListViewControllerDelegate | 会话列表视图控制器代理。用于实现会话列表的一系列自定义功能。 | V1.30.0 |
| KIMChatMessageViewController | 消息列表视图控制器。主要负责消息列表页面展示及交互逻辑。可直接使用该类初始化或使用子类继承的方式进行集成消息列表页面。 | V1.30.0 |
| KIMChatMessageViewControllerDelegate | 消息列表视图控制器代理。用于实现消息列表的一系列自定义功能。 | V1.30.0 |
| KIMCustomChatMessageManager | 自定义消息管理类。用于实现自定义消息需求场景，如：新增一种业务消息类型，自定义针对该消息类型的消息气泡展示。 | V1.30.0 |
文档相关
| 核心类 | 描述 | 版本 |
|---|---|---|
| KIMDocsModule | 文档模块类。提供文档数据接口及相关页面的 UI配置，通过 KIM.docsModule 访问。 | V1.30.0 |
| KIMDocumentHomeViewController | 文档列表首页视图控制器。页面展示最近打开文档列表，点击文档列表进入文档详情页，可直接使用该类初始化或使用子类继承的方式进行集成文档列表页面。 | V1.30.0 |
| KIMDocumentHomeViewControllerDelegate | 文档列表视图控制器代理。用于实现文档列表的一系列自定义功能。 | V1.30.0 |
| KIMNoteHomeViewController | 笔记列表首页视图控制器。页面展示最近打开文档列表，点击笔记列表进入笔记详情页，可直接使用该类初始化或使用子类继承的方式进行集成笔记列表页面。 | V1.30.0 |
| KIMNoteHomeViewControllerDelegate | 笔记列表视图控制器代理。用于实现笔记列表的一系列自定义功能。 | V1.30.0 |
工作台相关
| 核心类 | 描述 | 版本 |
|---|---|---|
| KIMWorkSpaceModule | 工作台模块类。提供工作台数据接口及相关页面的 UI配置，通过 KIM.workSpaceModule 访问。 | V1.30.0 |
| KIMWorkSpaceViewController | 工作台首页视图控制器。页面展示工作台应用列表，千人千面工作台，点击工作台应用进入应用容器使用应用功能服务，可直接使用该类初始化或使用子类继承的方式进行集成工作台页面。 | V1.30.0 |
| KIMWorkSpaceViewControllerDelegate | 工作台视图控制器代理。用于实现工作台页面的一系列自定义功能。 | V1.30.0 |
| KIMWebAppViewController | 工作台应用容器视图控制器。提供基础应用或企业自建应用功能，如邮箱应用、日历应用等基础应用及一系列企业自建应用。 | V1.30.0 |
| KIMWebAppViewControllerDelegate | 工作台应用容器视图控制器代理。用于实现应用容器页面的一系列自定义功能。 | V1.30.0 |
用户相关
| 核心类 | 描述 | 版本 |
|---|---|---|
| KIMUserModule | 用户模块类。提供用户数据接口及相关页面的 UI配置，通过 KIM.userModule 访问。 | V1.30.0 |
| KIMContactsDelegate | 接入外部通讯录代理。通过实现代理方法实现自研的通讯录页面替换 SDK 默认通讯录页面的场景需求。通过 KIM.userModule.contactsDelegate 设置。 | V1.30.0 |
| KIMUserProfileDelegate | 接入外部个人详情页代理。通过实现代理方法实现自研的个人详情页面替换 SDK 默认个人详情页面的场景需求。通过 KIM.userModule.userProfileDelegate 设置。 | V1.30.0 |
| KIMContactsViewController | 通讯录视图控制器。直接使用该类初的始化方法集成通讯录页面。 | V1.30.0 |
| KIMContactPickerViewController | 通讯录选择器视图控制器。可通过实例化通讯录视图控制器，传入配置参数及回调参数，实现通过通讯录选择器选择会话的需求。 | V1.30.0 |
搜索相关
| 核心类 | 描述 | 版本 |
|---|---|---|
| KIMSearchModule | 搜索模块类。提供搜索相关页面的 UI配置，通过 KIM.searchModule 访问。 | V1.30.0 |
| KIMSearchConfig | 搜索页面配置类。提供搜索页面UI配置，通过 KIM.searchModule.searchConfig 访问。 | V1.30.0 |
| KIMSearchViewController | 搜索页面视图控制器。页面展示搜索功能，默认可搜索聊天消息，会话，文档，邮箱等，可直接使用该类初始化或使用子类继承的方式进行集成搜索页面。 | V1.30.0 |
| KIMSearchViewControllerDelegate | 搜索页面视图控制器代理。用于实现搜索页面的一系列自定义功能，如插入自定义搜索分类。 | V1.30.0 |