快速上手
本教程是为了让新手快速了解融云即时通讯界面库(IMKit)。在本教程中,您可以体验集成 IMKit SDK 的基本流程和 IMKit 提供的 UI 界面。
前置条件
-
注册开发者账号。注册成功后,控制台会默认自动创建您的首个应用,默认生成开发环境下的 App Key,使用国内数据中心。
-
获取开发环境的应用 App Key。如不使用默认应用,请参考 如何创建应用,并获取对应环境 App Key 和 App Secret。
提示每个应用具有两个不同的 App Key,分别对应开发环境与生产环境,两个环境之间数据隔离。在您的应用正式上线前,可切换到使用生产环境的 App Key,以便上线前进行测试和最终发布。
环境要求
- (SDK ≧ 5.6.3)使用 Android 5.0(API 21)或更高版本
- (SDK < 5.6.3)使用 Android 4.4(API 19)或更高版本
开始集成
IMKit 支持通过 Maven、本地 Module 、源码三种方式的方式集成。请提前在融云官网 SDK 下载页面或融云的 Maven 仓库查询最新版本。安装 IMKit 将同时集成即时通讯能力库 IMLib。其他插件可按需集成。
导入 SDK
本教程以在 Gradle 中添加远程依赖项为例,将 IMKit SDK 导入到您的应用工程中。请注意使用 融云的 Maven 仓库。
-
打开根目录下的
build.gradle
(Project 视图下),声明融云的 Maven 代码库。allprojects {
repositories {
...
//融云 maven 仓库地址
maven {url "https://maven.rongcloud.cn/repository/maven-releases/"}
}
} -
在应用的
build.gradle
中,添加融云即时通讯界面库(IMKit)为远程依赖项。dependencies {
...
//此处以集成 IMKit 库为例,您可以按需集成插件
api 'cn.rongcloud.sdk:im_kit:x.y.z'
}提示各个 SDK 的最新版本号可能不相同,还可能是 x.y.z.h,可前往 融云官网 SDK 下载页面 或 融云的 Maven 代码库 查询。
其他导入方式可参考导入 SDK。
使用 App Key 初始化
融云即时通讯客户端 SDK 核心类为 RongIM
和 IMCenter
。在 Application 的 onCreate()
方法中,调用初始化方法,传入生产或开发环境的 App Key。
如果 SDK 版本 ≧ 5.4.2,请使用以下初始化方法。
String appKey = "YourAppKey"; // example: bos9p5rlcm2ba
InitOption initOption = new InitOption.Builder().build();
IMCenter.init(this, appKey, initOption);
初始化配置(InitOption
)中封装了区域码(AreaCode),导航服务地址(naviServer
)、文件服务地址(fileServer
)、数据统计服务地址(statisticServer
)配置,以及是否开启推送的开关(enablePush
)和主进程开关(isMainProcess
)。不传入任何配置表示全部使用默认配置。SDK 默认连接北京数据中心。
如果 App Key 不属于中国(北京)数据中心,则必须传入有效的初始化配置。初始化详细说明参见初始化。