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 |
文档相关
核心类 | 描述 | 版本 |
---|---|---|
KIMDocsModule | 文档模块类。提供文档数据接口及相关页面的 UI配置,通过 KIM.docsModule 访问。 | V1.30.0 |
KIMDocumentHomeFragment | 文档列表首页Fragment。页面展示最近打开文档列表,点击文档列表进入文档详情页,KIMDocumentHomeActivity,直接包含了 KIMDocumentHomeFragment 的 Activity 界面可直接使用,可以将该 Fragment 嵌入自己的 Activity。 | V1.30.0 |
KIMExpDocumentHome | 文档列表接口类。用于实现文档列表自定义扩展接口来完成文档列表界面的自定义。 | V1.30.0 |
KIMNoteHomeFragment | 笔记列表首页Fragment。页面展示最近打开文档列表,点击笔记列表进入笔记详情页,KIMNoteHomeActivity直接包含了 KIMNoteHomeFragment 的 Activity 界面可直接使用,接入方可以将该 Fragment 嵌入自己的 Activity。 | V1.30.0 |
KIMExpNoteHome | 笔记列表视图控制接口类。用于实现笔记列表的一系列自定义功能。 | V1.30.0 |
工作台相关
核心类 | 描述 | 版本 |
---|---|---|
KIMWorkSpaceModule | 工作台模块类。提供工作台数据接口及相关页面的 UI配置,通过 KIM.workSpaceModule 访问。 | V1.30.0 |
KIMWorkSpaceFragment | 工作台首页Fragment。页面展示工作台应用列表,千人千面工作台,点击工作台应用进入应用容器使用应用功能服务,KIMWorkSpaceActivity直接包含了该Fragment的Activity 界面可直接使用,接入方也可以将该 Fragment 嵌入自己的 Activity | V1.30.0 |
KIMExpWorkSpace | 工作台视图接口定义类。用于实现工作台页面的一系列自定义功能。 | V1.30.0 |
KIMWebAppFragment | 工作台应用容器Fragment。提供基础应用或企业自建应用功能,如邮箱应用、日历应用等基础应用及一系列企业自建应用。KIMWorkSpaceActivity直接包含了该Fragment的Activity 界面可直接使用,接入方也可以将该Fragment嵌入自己的Activity使用。 | V1.30.0 |
KIMExpWebApp | 工作台应用容器入口类。用于实现应用容器页面的创建。 | V1.30.0 |
用户相关
核心类 | 描述 | 版本 |
---|---|---|
KUserModule | 用户模块类。提供用户数据接口及相关页面的 UI配置,通过 KIM.userModule 访问。 | V1.30.0 |
KIMExpContacts | 接入外部通讯录代理。通过实现代理方法实现自研的通讯录页面替换 SDK 默认通讯录页面的场景需求。通过 KIM.userModule.contactsDelegate 设置。 | V1.30.0 |
KIMExpUserProfilePage | 接入外部个人详情页代理。通过实现代理方法实现自研的个人详情页面替换 SDK 默认个人详情页面的场景需求。通过 KIM.userModule.userProfileDelegate 设置。 | V1.30.0 |
KIMContactsFragment | 通讯录Fragment,KIMContactsActivity直接包含了该Fragment的Activity 界面可直接使用,接入方也可以将该Fragment嵌入自己的Activity使用面。 | V1.30.0 |
KIMContactPickerFragment | 通讯录选择器Fragment。可通过传入配置参数及回调参数,实现通过通讯录选择器选择会话的需求。KIMContactPickerActivity直接包含了该Fragment的Activity 界面可直接使用,接入方也可以将该Fragment嵌入自己的Activity使用。 | V1.30.0 |
搜索相关
核心类 | 描述 | 版本 |
---|---|---|
KIMSearchModule | 搜索模块类。提供搜索相关页面的 UI配置,通过 KIM.searchModule 访问。 | V1.30.0 |
KIMSearchConfig | 搜索页面配置类。提供搜索页面UI配置,通过 KIM.searchModule.searchConfig 访问。 | V1.30.0 |
KIMSearchFragment | 搜索页面Fragment。页面展示搜索功能,默认可搜索聊天消息,会话,文档,邮箱等,KIMSearchActivity直接包含了该Fragment的Activity 界面可直接使用,接入方也可以将该Fragment嵌入自己的Activity使用。 | V1.30.0 |
KIMExpSearchPage | 搜索页面接口类。用于实现搜索页面的一系列自定义功能,如插入自定义搜索分类。 | V1.30.0 |