快速上手
本教程是为了让新手快速了解融云即时通讯能力库(IMLib)。在本教程中,您可以体验集成 SDK 的基本流程和 IMLib 的基础通信能力。
前置条件
-
注册开发者账号。注册成功后,控制台会默认自动创建您的首个应用,默认生成开发环境下的 App Key,使用国内数据中心。
-
获取开发环境的应用 App Key。如不使用默认应用,请参考 如何创建应用,并获取对应环境 App Key 和 App Secret。
注意
每个应用具有两个不同的 App Key,分别对应开发环境与生产环境,两个环境之间数据隔离。在您的应用正式上线前,可切换到使用生产环境的 App Key,以便上线前进行测试和最终发布。
-
阅读 SDK 变更说明。SDK 在 5.2.4、5.4.0 均有较大变更,请确保您已充 分了解相关差异,例如接口回调的方式变更等。
Demo 项目
融云 IMLib for uni-app SDK 提供了一个不含任何聊天界面的 Demo 项目,集中演示了各个接口的调用方法。
https://github.com/rongcloud/im-uni-app-wrapper
安装插件
-
在 DCloud 插件市场 搜索并安装 RCUniIMV2原生插件,或者手动下载安装插件放入
nativeplugins
目录下。 -
在 manifest.json -> APP 原生插件配置 -> 加入原生插件
RCUniIMV2
。 -
运行 -> 运行到手机 -> 制作自定义调试基座。
-
安装即时通讯 Typescript 依赖项
请从 uni-app 插件市场安装 RongCloud-IMWrapper-V2
如果您曾使用 NPM 安装过即时通讯依赖项
@rongcloud/imlib-uni
,请在升级时替换为从插件市场安装的方式,并注意修改初始化代码。 -
在项目中集成引用
JavaScriptimport RCIMIWEngine from "@/uni_modules/RongCloud-IMWrapper-V2/js_sdk/RCIMEngine"
初始化
在使用 SDK 所有功能之前,必须先调用此方法初始化 SDK。
初始化时需要传入上文获取的 App Key。引擎配置请参见引擎配置。
let appKey = 'Your_AppKey'
let options = {};
// 可以将创建好的 engnie 保存到全局变量中,以便多页面使用
let engine = await RCIMIWEngine.create(appKey, options);