快速入门
本教程是为了让新手快速了解融云即时通讯能力库(IMLib)。在本教程中,您可以体验集成 SDK 的基本流程和 IMLib 的基础通信能力。
前置条件
-
注册开发者账号。注册成功后,控制台会默认自动创建您的首个应用,默认生成开发环境下的 App Key,使用国内数据中心。
-
获取开发环境的应用 App Key。如不使用默认应用,请参考 如何创建应用,并获取对应环境 App Key 和 App Secret。
提示每个应用具有两个不同 的 App Key,分别对应开发环境与生产环境,两个环境之间数据隔离。在您的应用正式上线前,可切换到使用生产环境的 App Key,以便上线前进行测试和最终发布。
编译环境
- DevEco Studio 版本号:DevEco Studio NEXT Developer Beta1 5.0.3.502
- 手机系统版本号:NEXT.0.0.31
设备要求
开始集成
自动导入 SDK
-
在 DevEco Studio 中,View > Tool Windows 找到 Partner SDK。
-
在 DevEco Studio 中,点击左侧边栏的 Partner SDK。
-
选择 社交 或者 Social networking, 您可以看到 融云 IMLib SDK ,然后点击 Install 来安装融云 IMLib SDK。
-
安装 SDK 成功后,您可以在项目根目录的 oh_modules/.ohpm/ 中找到融云 IMLib SDK。
添加 SDK 依赖权限
需要添加如下权限:
权限名称 | 权限说明 | 使用目的 |
---|---|---|
ohos.permission.GET_NETWORK_INFO | 获取网络信息 | 网络变化之后获取网络信息,进行 IM 重连 |
ohos.permission.INTERNET | 使用网络 | 连接 IM 、收发消息需要网络连接 |
ohos.permission.STORE_PERSISTENT_DATA | 数据存储 | 消息数据库需要本地存储 |
详情请参考鸿蒙应用权限配置文档。
配置 useNormalizedOHMUrl
1.0.3 版本开始 SDK 支持字节码,为了支持字节码,app 需要在项目根路径配置 useNormalizedOHMUrl。
// app 根路径下的 build-profile.json5
{
"app": {
"products": [
{
"buildOption": {
"strictMode": {
"useNormalizedOHMUrl": true
}
}
}
]
}
}
详细信息请参考 FAQ
初始化 SDK
融云即时通讯客户端 SDK 核心类为 IMEngine
在 UIAbility 的 onCreate()
方法中,调用初始化方法,传入生产
或开发
环境的 App Key。
// 在 UIAbility 中获取 context
let context = this.context
let initOption = new InitOption();
let appKey = "从融云后台获取的 appKey";
IMEngine.getInstance().init(context, appKey, initOption);
初始化配置 InitOption 中封装了区域码 AreaCode,导航服务地址 naviServer ,统计服务地址 statisticServer ,文件下载路径 mediaSavePath
SDK 默认连接北京数据中心
如果 App Key 不属于中国(北京)数据中心,则必须传入有效的初始化配置。初始化详细说明参见初始化
获取用户 Token
用户 Token 是与用户 ID 对应的身份验证令牌,是应用程序的用户在融云的唯一身份标识。应用客户端在使用融云即时通讯功能前必须与融云建立 IM 连接,连接时必须传入 Token。
在实际业务运行过程中,应用客户端需要通过应用的服务端调用 IM Server API 申请取得 Token。详见 Server API 文档