在本教程中,您可以体验集成鸿蒙 IM SDK 的基本流程和 IMLib 的基础通信能力。
前置条件
- 注册开发者账号。注册成功后,控制台会默认自动创建您的首个应用,默认生成开发环境下的 App Key,使用国内数据中心。
- 获取开发环境的应用 App Key。如不使用默认应用,请参考 如何创建应用,并获取对应环境 App Key 和 App Secret。
- 创建鸿蒙应用
编译环境
- DevEco Studio 版本号:DevEco Studio NEXT Developer Beta1 5.0.3.403
- 手机系统版本号:NEXT.0.0.26
设备要求
开始集成
自动导入 SDK
- 在 DevEco Studio 中,点击左侧边栏的 Partner SDK。
- 选择 社交 或者 Social networking, 您可以看到 融云 IMLib SDK ,然后点击 Install 来安装融云 IMLib SDK。
- 安装 SDK 成功后,您可以在项目根目录的 oh_modules/.ohpm/ 中找到融云 IMLib SDK。
添加 SDK 依赖权限
需要添加如下权限:
- ohos.permission.GET_NETWORK_INFO
- ohos.permission.INTERNET
- ohos.permission.STORE_PERSISTENT_DATA
详情请参考 鸿蒙应用权限配置文档。
初始化 SDK
融云即时通讯客户端 SDK 核心类为 IMEngine
在 UIAbility 的 onCreate()
方法中,调用初始化方法,传入生产
或开发
环境的 App Key。
初始化配置 InitOption 中封装了区域码 AreaCode,导航服务地址 naviServer ,统计服务地址 statisticServer ,文件下载路径 mediaSavePath
SDK 默认连接北京数据中心
如果 App Key 不属于中国(北京)数据中心,则必须传入有效的初始化配置。初始化详细说明参见初始化
获取用户 Token
用户 Token 是与用户 ID 对应的身份验证令牌,是应用程序的用户在融云的唯一身份标识。应用客户端在使用融云即时通讯功能前必须与融云建立 IM 连接,连接时必须传入 Token。
在实际业务运行过程中,应用客户端需要通过应用的服务端调用 IM Server API 申请取得 Token。详见 Server API 文档 注册用户。
在本教程中,为了快速体验和测试 SDK,我们将使用控制台「北极星」开发者工具箱,从 API 调试页面调用 获取 Token 接口,获取到 userId 为 1 的用户的 Token。提交后,可在返回正文中取得 Token 字符串。
建立 IM 连接
- 监听 IM 连接状态的变化,以便 UI 上给用户以提示,提高体验。
- 使用以上步骤中获取的 Token, 模拟 userId 为 1 的用户连接到融云服务器。
SDK 已实现自动重连机制,请参见连接。
监听消息
设置消息接收监听器,用于接收所有类型的实时或者离线消息。
发送消息
向 userId 为 2 的用户发送一条消息。