开发者中心
IM 即时通讯 UIKit
视频教程知识库工单
中文
新手入门资源下载了解产品集成开发客户端 API常见问题
在线咨询微信咨询电话咨询
iOS
快速开始
IM Demo 体验
圈组 Demo 体验
跑通 IM Demo 源码
跑通圈组 Demo 源码
IM UIKit（V10）
集成 IM UIKit
组件导入
初始化
界面跳转
AI 数字人
AI 数字人概述
与 AI 数字人聊天
实现多国语言翻译
实现划词搜索
会话列表相关
集成会话列表界面
自定义会话列表 UI
消息相关
集成会话消息界面
实现地理位置消息功能
实现音视频通话功能
实现自定义消息收发
自定义会话消息 UI
通讯录相关
集成通讯录界面
自定义通讯录 UI
全局配置
UIKit 功能实现方案
消息回复实现方案
圈组 UIKit
集成圈组 UIKit
组件导入
初始化与登录
集成圈组界面
实现公告频道
实现圈组广场
IM UIKit（V9）
集成 IM UIKit
组件导入
初始化
界面跳转
用户相关
自定义用户信息
会话列表相关
集成会话列表界面
自定义会话列表 UI
消息相关
集成会话消息界面
实现地理位置消息功能
实现音视频通话功能
实现自定义消息收发
自定义会话消息 UI
通讯录相关
集成通讯录界面
自定义通讯录 UI
全局配置
UIKit 功能实现方案
消息回复实现方案
SDK 开发文档（V9）
SDK 开发文档（V10）
开发者中心IM 即时通讯 UIKit集成开发集成圈组 UIKit

集成圈组 UIKit

更新时间： 2024/07/26 13:39:23

网易云信圈组 UIKit（QChat UIKit）是基于 NetEase Instant Messaging SDK（以下简称 NIM SDK）中的圈组模块开发的一款圈组 UI 组件库。本文介绍如何集成圈组 UIKit 到您的即时通讯项目中。

前提条件

在开始集成圈组 UIKit 前，请确保：

实现流程

uml diagram

步骤1：按需导入组件

  1. 根据业务需要，在 “Podfile” 文件中，以添加依赖的形式添加相应的圈组 UIKit 组件。同时，你也可以引入 IM UIKit 的组件库（比如需要通讯录功能和会话列表功能，可添加 NEContactUIKit 和 NEConversationUIKit）各组件相互独立，添加或删除均不影响项目编译。

    导入 UI 组件时，需要指定相同版本的基础 Kit 库引入，否则可能导致后续出现报错。具体可参见下文的常见问题排查。

    不指定 NIM SDK 版本
    swift# Uncomment the next line to define a global platform for your project
platform :ios, '11.0'

# 请使用您的真实项目名称替换 your project name
target 'your project name' do
# Comment the next line if you don't want to use dynamic frameworks
use_frameworks!

# 圈组组件
pod 'NEQChatUIKit', '9.5.3' 
# 通讯录组件（可选）       
pod 'NEContactUIKit', '9.6.5'   
# 会话列表组件（可选）    
pod 'NEConversationUIKit', '9.6.5'  
# 会话（聊天）组件（可选）
pod 'NEChatUIKit', '9.6.5'  
# 群相关设置组件（可选）        
pod 'NETeamUIKit', '9.6.5'          

# 基础 Kit 库
pod 'NECoreKit', '9.6.5'
pod 'NECoreIMKit', '9.6.5'
pod 'NECoreQChatKit', '9.6.5'
pod 'NEQChatKit', '9.5.3'
pod 'NECommonKit', '9.6.4'
pod 'NECommonUIKit', '9.6.5'

# 扩展库-地理位置组件
pod 'NEMapKit', '9.6.5'         

# 扩展库-呼叫组件
pod 'NIMSDK_LITE','9.14.0'
pod 'NERtcCallKit/NOS_Special', '2.2.0'
pod 'NERtcCallUIKit/NOS_Special', '2.2.0'

# 扩展库，依次为 RTC 音视频基础组件、RTC 音视频神经网络组件（使用背景虚化功能需要集成）、RTC 音视频背景分割组件（使用背景虚化功能需要集成）
pod 'NERtcSDK/RtcBasic', '5.5.2'        
pod 'NERtcSDK/Nenn'                    
pod 'NERtcSDK/Segment'   
end
    指定 NIM SDK 版本
    swift# Uncomment the next line to define a global platform for your project
platform :ios, '11.0'

# 请使用您的真实项目名称替换 your project name
target 'your project name' do
# Comment the next line if you don't want to use dynamic frameworks
use_frameworks!

# 指定 NIM SDK 版本，以9.16.0 为例
pod 'NIMSDK_LITE','9.16.0'

# 圈组组件 
pod 'NEQChatUIKit/NOS_Special', '9.5.3' 
# 通讯录组件（可选）       
pod 'NEContactUIKit/NOS_Special', '9.6.5'   
# 会话列表组件（可选）    
pod 'NEConversationUIKit/NOS_Special', '9.6.5'  
# 会话（聊天）组件（可选） 
pod 'NEChatUIKit/NOS_Special', '9.6.5'  
# 群相关设置组件（可选）        
pod 'NETeamUIKit/NOS_Special', '9.6.5'          

# 基础 Kit 库
pod 'NECoreKit', '9.6.5'
pod 'NECoreIMKit/NOS_Special', '9.6.5'
pod 'NECoreQChatKit/NOS_Special', '9.6.5'
pod 'NEQChatKit/NOS_Special', '9.5.3'    
pod 'NECommonKit', '9.6.4'
pod 'NECommonUIKit', '9.6.5'

# 扩展库-地理位置组件
pod 'NEMapKit/NOS_Special', '9.6.5'         

# 扩展库-呼叫组件
pod 'NERtcCallKit/NOS_Special', '2.2.0'
pod 'NERtcCallUIKit/NOS_Special', '2.2.0'

# 扩展库，依次为 RTC 音视频基础组件、RTC 音视频神经网络组件（使用背景虚化功能需要集成）、RTC 音视频背景分割组件（使用背景虚化功能需要集成）
pod 'NERtcSDK/RtcBasic', '5.5.2'        
pod 'NERtcSDK/Nenn'                    
pod 'NERtcSDK/Segment'   
end
    （海外数据中心）不指定 NIM SDK 版本
    swift# Uncomment the next line to define a global platform for your project
platform :ios, '11.0'

# 请使用您的真实项目名称替换 your project name
target 'your project name' do
# Comment the next line if you don't want to use dynamic frameworks
use_frameworks!

# 圈组组件
pod 'NEQChatUIKit/FCS', '9.5.3' 
# 通讯录组件（可选）       
pod 'NEContactUIKit/FCS', '9.6.5'   
# 会话列表组件（可选）    
pod 'NEConversationUIKit/FCS', '9.6.5'  
# 会话（聊天）组件（可选）
pod 'NEChatUIKit/FCS', '9.6.5'  
# 群相关设置组件（可选）        
pod 'NETeamUIKit/FCS', '9.6.5'          

# 基础 Kit 库
pod 'NECoreKit', '9.6.5'
pod 'NECoreIMKit/FCS', '9.6.5'
pod 'NECoreQChatKit/FCS', '9.6.5'
pod 'NEQChatKit/FCS', '9.5.3'
pod 'NECommonKit', '9.6.4'
pod 'NECommonUIKit', '9.6.5'

# 扩展库-地理位置组件
pod 'NEMapKit/FCS', '9.6.5'         

# 扩展库-呼叫组件
pod 'NIMSDK_LITE/FCS','9.14.0'
pod 'NERtcCallKit/FCS_Special', '2.2.0'
pod 'NERtcCallUIKit/FCS_Special', '2.2.0'

# 扩展库，依次为 RTC 音视频基础组件、RTC 音视频神经网络组件（使用背景虚化功能需要集成）、RTC 音视频背景分割组件（使用背景虚化功能需要集成）
pod 'NERtcSDK/RtcBasic', '5.5.2'        
pod 'NERtcSDK/Nenn'                    
pod 'NERtcSDK/Segment'   
end
    （海外数据中心）指定 NIM SDK 版本
    swift# Uncomment the next line to define a global platform for your project
platform :ios, '11.0'

# 请使用您的真实项目名称替换 your project name
target 'your project name' do
# Comment the next line if you don't want to use dynamic frameworks
use_frameworks!

# 指定 NIM SDK 版本，以9.16.0 为例
pod 'NIMSDK_LITE/FCS','9.16.0'

# 圈组组件
pod 'NEQChatUIKit/FCS_Special', '9.5.3' 
# 通讯录组件（可选）       
pod 'NEContactUIKit/FCS_Special', '9.6.5'   
# 会话列表组件（可选）    
pod 'NEConversationUIKit/FCS_Special', '9.6.5'  
# 会话（聊天）组件（可选）
pod 'NEChatUIKit/FCS_Special', '9.6.5'  
# 群相关设置组件（可选）        
pod 'NETeamUIKit/FCS_Special', '9.6.5'          

# 基础 Kit 库
pod 'NECoreKit', '9.6.5'
pod 'NECoreIMKit/FCS_Special', '9.6.5'
pod 'NECoreQChatKit/FCS_Special', '9.6.5'
pod 'NEQChatKit/FCS_Special', '9.5.3'
pod 'NECommonKit', '9.6.4'
pod 'NECommonUIKit', '9.6.5'

# 扩展库-地理位置组件
pod 'NEMapKit/FCS_Special', '9.6.5'         

# 扩展库-呼叫组件
pod 'NERtcCallKit/FCS_Special', '2.2.0'
pod 'NERtcCallUIKit/FCS_Special', '2.2.0'

# 扩展库，依次为 RTC 音视频基础组件、RTC 音视频神经网络组件（使用背景虚化功能需要集成）、RTC 音视频背景分割组件（使用背景虚化功能需要集成）
pod 'NERtcSDK/RtcBasic', '5.5.2'        
pod 'NERtcSDK/Nenn'                    
pod 'NERtcSDK/Segment'   
end
    • 各 UI 组件相互独立，添加或删除均不影响项目编译。
    • 示例代码中的 9.5.3 为版本号，仅用于示例。建议使用最新版本。
    • 暂不支持 bitcode。

  2. 配置完 “Podfile” 文件后执行pod install命令导入组件。

步骤2：初始化

  1. 在项目中引入需要的组件。

    示例代码：

    Swift
    import NECoreKit
import NECoreIMKit
import NECoreQChatKit
import NEQChatUIKit
import NERtcCallUIKit
...
    Objective-C
    #import <NECoreKit/NECoreKit-Swift.h>
#import <NECoreIMKit/NECoreIMKit-Swift.h>
#import <NECoreQChatKit/NECoreQChatKit-Swift.h>
#import <NEQChatKit/NEQChatKit-Swift.h>
#import <NEQChatUIKit/NEQChatUIKit-Swift.h>
#import <NERtcCallUIKit/NERtcCallUIKit.h>
...

  2. 在应用启动后，调用 setupCoreKitQChat 方法进行初始化。

    option 参数 是否必传 说明
    appKey 是 云信控制台获取到的 App Key
    apnsCername 否 APNs 推送证书名，如不需要实现离线推送可不配置
    pkCername 否 PushKit 推送证书名，如不需要实现离线推送可不配置

    示例代码：

    Swift
    let option = NIMSDKOption()
option.appKey = "your app key"
option.apnsCername = "云信控制台配置的 APNS 推送证书名称"
option.pkCername = "云信控制台配置的 PushKit 推送证书名称"
QChatKitClient.instance.setupCoreKitQChat(option)
let _ = NEAtMessageManager.instance
    Objective-C
    NIMSDKOption *option = [NIMSDKOption optionWithAppKey:AppKey];
option.apnsCername = @"";
option.pkCername = @"";
[[QChatKitClient instance] setupCoreKitQChat:option];
NEAtMessageManager * _ = [NEAtMessageManager instance];

更多初始化说明，请参见初始化。

步骤3：登录

在完成初始化后，调用 loginQChat 方法登录 QChat，该方法会自动完成 IM 的登录。

示例代码：

Swift
    QChatKitClient.instance.loginQChat(accid, token) { error in
        if let err = error {
            print(" login error : ", err)
        }else {
            //在登录成功回调中初始化路由以及配置各个模块首页
            /*
             weakSelf?.setupTabbar()
             */
        }
    }
Objective-C
[[QChatKitClient instance] loginQChat:@"accid" :@"token" :^(NSError * _Nullable error) {
    if (error != nil) {
        NSLog(@" login error : %@", [error description]);
    } else {
        //在登录成功回调中初始化路由以及配置各个模块首页
        /*
        [weakSelf setupTabbar];
        */
    }
}];

调用登录方法时，将示例代码中的 accid 和 token 分别替换为您的云信账号 ID （即 accid）和 Token。

步骤4：界面搭建

以搭建圈组 home 页面为例，更多页面请参见界面集成详情。

示例代码：

Swift
swiftfunc qChatExample(){
    let qChatVC = QChatHomeViewController()
    qChatVC.delegate = self
}
Objective-C
- (void)qChatExample {
    QChatHomeViewController *qChatVC = [[QChatHomeViewController alloc] init];
    qChatVC.delegate = self;
}

界面效果参考如下：

后续步骤

为保障通信安全，如果您在调试环境中的使用的是云信控制台生成的测试用 IM 账号 和 token，请确保在后续的正式生产环境中，将其替换为通过 IM 服务端 API 生成的正式 IM 账号（accid）和 token。

相关参考

界面集成详情

圈组 UIKit 中提供的常用业务场景界面及相关集成说明如下：

页面 所属组件 描述
QChatSquareHomeViewController NEQChatUIKit 圈组广场页面，展示内容包括不同类型下的广场频道等。
QChatHomeViewController NEQChatUIKit 圈组 home 页面，展示内容包括加入的社区，每个社区中的话题等。
QChatViewController NEQChatUIKit 圈组会话页面（创建或者跳转到该界面需要传入参数）
QChatServerSettingViewController NEQChatUIKit 社区 设置页面（创建或者跳转到该界面需要设置社区参数）
QChatChannelSettingVC NEQChatUIKit 话题设置页面（创建或者跳转到该界面需要设置话题参数）

常见问题排查

pod 冲突报错

  • 问题原因

    如果执行步骤1导入组件时，只导入了圈组 UIKit 的 UI 组件，在特殊情况下可能出现库版本不一致导致的报错（UI 组件版本与其内部依赖的基础 kit 库的版本不一致）。

    例如导入的圈组 UIKit 的 UI 组件版本为 v9.5.3，但导入的基础 Kit 库版本为 v9.3.2。这会导致基础库用到日志库（alog)和 UI 组件用到的 alog 不一致，进而导致 pod 冲突报错。

  • 处理建议：

    导入 UI 组件时，同时也指定推荐版本的基础 Kit 库。

    以导入 v9.5.3 的 QChat UI 组件为例，推荐的基础 Kit 库版本为：

    #基础kit库
pod 'NECommonUIKit', '9.6.5'
pod 'NECommonKit', '9.6.4'
pod 'NECoreQChatKit', '9.6.5'
pod 'NECoreKit', '9.6.3'
在线咨询微信咨询电话咨询
此文档是否对你有帮助？
有帮助
去反馈
  • 前提条件
  • 实现流程
  • 步骤1：按需导入组件
  • 步骤2：初始化
  • 步骤3：登录
  • 步骤4：界面搭建
  • 后续步骤
  • 相关参考
  • 界面集成详情
  • 常见问题排查
  • pod 冲突报错
© 1997-2024 网易公司增值电信业务许可证B1-20180288浙B1.B2-20090185浙公网安备浙公网安备 33010802002218号浙ICP备17006647号-3工业和信息化部备案管理系统网站隐私政策