快速上手(Swift)
前置条件
-
注册开发者账号。注册成功后,控制台会默认自动创建您的首个应用,默认生成开发环境下的 App Key,使用国内数据中心。
-
获取开发环境的应用 App Key。如不使用默认应用,请参考 如何创建应用,并获取对应环境 App Key 和 App Secret。
提示每个应用具有两个不同的 App Key,分别对应开发环境与生产环境,两个环境之间数据隔离。在您的应用正式上线前,可切换到使用生产环境的 App Key,以便上线前进行测试和最终发布。
环境要求
名称 | 版本 |
---|---|
Xcode | 11 + |
iOS | 9.0 + |
Swift | 5.0 + |
CocoaPods | 1.10.0 + |
SDK 5.1.1 及其以后要求使用 CocoaPods 1.10.0 +,具体请参见知识库文档。
开始集成
IMKit 支持通过 CocoaPods 或手动导入的方式集成。请提前在融云官网 SDK 下载页面或 CocoaPods 仓库查询最新版本。安装 IMKit 将同时集成即时通讯能力库 IMLib。其他插件可按需集成。
要求使用 5.4.2 或更高版本。
步骤 1 创建一个项目
打开 Xcode 并创建一个新项目。RongCloudIM/IMKit
支持 swift。
步骤 2 安装 IMKit
您可以通过 CocoaPods 来安装 iOS 版本的 IMKit (含 UI SDK)。
-
在
podfile
中添加如下内容:pod 'RongCloudIM/IMKit', '~> x.y.z'
提示x.y.z
代表具体版本,请在融云官网 SDK 下载页面或 CocoaPods 仓库查询最新版本。 -
请在终端中运行以下命令:
pod install
提示如果出现找不到相关版本的问题,可先执行
pod repo update
,再执行pod install
。 -
上一步完成后,CocoaPods 会在您的工程根目录下生成一个
xcworkspace
文件,只需通过 XCode 打开该文件即可加载工程。
步骤 3 用 App Key 初始化
要在您的应用中集成和运行 Rongcloud IMKit (含 UI SDK),您需要首先引入 RongIMKit
然后通过 AppDelegate 初始化 RCIM
。
import RongIMKit
func application(_ application: UIApplication, didFinishLaunchingWithOptions launchOptions: [UIApplication.LaunchOptionsKey: Any]?) -> Bool {
let appKey: String = "Your_AppKey" // example: bos9p5rlcm2ba
let option: RCInitOption? = nil
RCIM.shared().initWithAppKey(appKey, option: option)
return true
}
即使您不使用 AppDelegate
,您仍然应该在启动聊天服务之前初始化 RCIM
。
步骤 4 获取用户 Token
用户 Token 是与用户 ID 对应的身份验证令牌,是应用程序的用户在融云的唯一身份标识。应用客户端在使用融云即时通讯功能前必须与融云建立 IM 连接,连接时必须传入 Token。
在实际业务运行过程中,应用客户端需要通过应用的服务端调用 IM Server API 申请取得 Token。详见 Server API 文档 注册用户。