OpenIM HarmonyOS SDK 概览

OpenIM HarmonyOS SDK 专为鸿蒙生态打造，提供类型安全的 ArkTS 原生 API，底层通过 N-API 高效调用核心跨平台引擎。开发者仅需引入 HAR 包，即可轻松实现用户与关系链、会话列表、群组管理、消息收发、本地持久化存储、音视频通话信令及实时事件监听等全套 IM 能力。

适用范围

HarmonyOS SDK 支持以下设备类型与原生架构：

三类设备均使用 Platform.HarmonyOS，不需要维护不同的业务 API。窗口较多的 2in1 应用应由进程统一持有 SDK 实例和数据库目录，关闭单个窗口不等于销毁 SDK。

HarmonyOS SDK 属于商业版交付能力。具体发行包、授权范围和商业能力以实际取得的 HAR 与商业协议为准。

接入 SDK

SDK 默认导出一个进程级实例：

import sdk, { OpenIMSDKEvent } from '@openimsdk/imsdk';

• 异步 API 返回 Promise，成功后直接得到声明中的响应对象，不包含额外的 { data } 外层。
• 调用失败时 Promise 会被拒绝，并携带 errCode 与 errMsg，可据此区分参数、连接和服务端错误。
• sdk.on() 返回取消订阅函数。通过查询接口拉取初始数据快照，通过事件监听实时合并增量变更；在弱网重连或状态异常时，可再次主动查询进行数据对齐与校准。
• 本地数据库、日志和媒体文件必须使用应用沙盒内真实、可写或可读的路径。

推荐接入顺序

1. 按开始之前准备 OpenIMServer、登录凭据和 DevEco Studio 环境。
2. 按工程与平台接入安装 HAR、声明权限并初始化 SDK。
3. 在登录前注册连接和同步事件，再按认证与管理登录会话登录。
4. 等待连接成功与服务端同步完成后，按发送第一条消息验证消息收发。

推荐运行顺序为：初始化 SDK（参考工程与平台接入） → 注册事件 → 登录（参考认证与管理登录会话） → 等待连接成功和服务端同步完成 → 调用业务 API。