快速入门
本文介绍在鸿蒙平台下如何快速集成云信 NIMSDK 到项目中: github 地址
- 环境要求
- SDK 接入流程
- Demo 使用
通过以上步骤,您可以基本了解鸿蒙NIMSDK 的接入与使用。
1 环境要求
1.1 编译环境
-
DevEco Studio NEXT Developer Preview1(4.1.3.500) 及以上。
-
HarmonyOS SDK API 11 及以上。
1.2 设备要求
-
真机华为 Mate 系列
-
操作系统 HarnomyOS NEXT 2.1.2.5 (Canary1) 以上
1.3 操作步骤
步骤1 :创建应用
创建应用,详情官方文档:点这里
步骤 2:编译运行
打开 NIMAPIDemo 配置签名:当前 NIMAPIDemo 已经配置好 Huawei Phone 模拟器与部分网易内部 HarmonyOS NEXT 真机的安装证书与 Profile,支持所有模拟器安装应用。若期望将证书移动到私有华为开发者账号体系下,需要按照一下步骤自动生成。更详细步骤详见 [华为-创建 HarmonyOS 应用]
2 SDK 接入流程
2.1. 拷贝 SDK har
拷贝 sdk har 包产物至项目文件夹中,例如:entry/libs。产物成果可由 NIMApiDemo/entry/libs 获取
2.2 配置 har 包本地依赖
DEMO 工程下 oh-package.json5 配置 har 包依赖。即将 har 包路径配置在 entry/oh-package.json5 的 "dependencies" 字段下:
{
"name": "entry",
"version": "1.0.0",
"description": "Please describe the basic information.",
"main": "",
"author": "",
"license": "",
"dependencies": {
"nim": "file:./libs/nim.har",
"base": "file:./libs/base.har",
"database": "file:./libs/database.har",
"friend": "file:./libs/friend.har",
"logger": "file:./libs/logger.har",
"notification": "file:./libs/notification.har",
"message": "file:./libs/message.har",
"user": "file:./libs/user.har",
"push": "file:./libs/push.har",
"team": "file:./libs/team.har",
"http": "file:./libs/http.har",
"sync": "file:./libs/sync.har",
"setting": "file:./libs/setting.har",
"login": "file:./libs/login.har",
"conversation": "file:./libs/conversation.har",
"vendor": "file:./libs/vendor.har",
"WebSocket": "file:./libs/WebSocket.har"
}
}
2.3 安装本地 har 包依赖
鼠标移动至红色波浪线位置停滞片刻,将会弹出提示框。点击 Run 'ohpm install',即刻安装本地 har 包依赖
2.4 同步项目工程
点击 Sync Now,同步项目工程
2.5 创建 SDK 实例 SampleCode
引入 SDK SampleCode,创建SDK实例。使用 import 引入 NIMInterface,NIMInitializeOptions,NIMServiceOptions,NIMSdk
import { NIMInterface, NIMInitializeOptions, NIMServiceOptions } from 'base'
import { NIMSdk } from 'nim'
初始化
2.6 通过SDK实例获取各业务service,通过业务service进行功能开发
3 DEMO 使用
demo 提供 IM 个业务模块 API 的调用事例,便于开发者快速了解 api 的使用方式,下载 demo 代码后,可以直接运行
demo 运行进入登陆界面进行登陆:
体验 demo 可以将 用户名:cjl 秘密: 123456 输入进行登陆:
Demo 功能模块
登陆界面
see loginService
会话接口
see conversationService
消息接口
see messageService
群接口
see teamService
用户&好友接口
see userService, friendService
离线推送
see pushService
以上界面对应的功能接口,都有单独的功能页面进行实现,在接入sdk 时,可以找的对应的接口,进行参考使用。
4 问题反馈
如果您在使用过程中,有任何疑问都可以直接在本工程上提交 issue,或者在云信官网进行咨询。