HarmonyOS IMLib(契约预留)
HarmonyOS 端为契约预留:sdk/harmony 当前版本未创建源码,仅保留 ArkTS 签名映射(bindings.harmony.imlib.methodMap)。本页签名来自已冻结 IDL,示例标注为「契约样例」,不承诺可运行。
契约预留 · 未实现
HarmonyOS 绑定状态为 reserved:契约已备、未实现:本文件只有 ArkTS 签名映射,无源码、无构建、无运行证据。 无 DevEco Studio、无 HarmonyOS SDK、无真机或模拟器;ArkTS 与既有 Rust/Node 工具链不共享,实现工作量与 Android 同量级但无法通过「可运行证据」验收。 本页展示的是已冻结的契约面,不承诺可运行。
事件:16 类(来自 IDL eventPayloads),详见 连接监听。
环境与制品
| 项 | 值 |
|---|---|
| 语言 / 运行时 | ArkTS(TypeScript 超集,HarmonyOS ArkTS 1.1 语法) |
| 包 / 模块名 | @ni-paas-im/harmony(预留包名,当前版本未发布) |
| IMLib 制品 | src/main/ets/imlib(预留路径,当前版本未创建) |
| IMKit 制品 | src/main/ets/imkit(预留路径,当前版本未创建) |
| 类型 / 契约声明 | — |
| Demo / 示例 | — |
| 绑定状态 | reserved · 契约预留 |
API 风格
| 项 | 内容 |
|---|---|
| 客户端类 | IMClient(ArkTS class,单例由静态工厂返回) |
| 工厂 / 初始化 | IMClient.getInstance(options: IMClientOptions): IMClient |
| 命名规则 | camelCase,方法名与语义 op 同名(camelCase 原样);init 由静态工厂 getInstance 表达(对齐融云鸿蒙 IMEngine.getInstance() 惯例 + IDL 幂等语义) |
| 异步风格 | Promise<RcResult<T>>(不 reject;错误码在 RcResult.code;返回 null 的 op 用 Promise<RcResult<void>>) |
| 事件 API | addEventListener(event: IMClientEvent, listener: IMClientEventListener): void / removeEventListener(event: IMClientEvent, listener: IMClientEventListener): void |
| 事件对象 | IMClientEvent(16 值枚举)+ IMClientEventPayload(判别联合) |
常量
| 常量 / 枚举 | 说明 |
|---|---|
IMClientEvent | 绑定常量集(取值以绑定实现为准) |
ErrorCode | 绑定常量集(取值以绑定实现为准) |
ConversationType | PRIVATE=1,GROUP=2,CHATROOM=3,SYSTEM=4,SUPER_GROUP=10 |
ConnectionStatus | CONNECTED=0,CONNECTING=1,DISCONNECTED=2,SUSPEND=3 |
NotificationLevel | ALL=0,MENTION=1,MUTED=2 |
ContentType | text / image / file / voice / location / custom / recall / system / combine |
GroupType | NORMAL=normal,SUPER=super |
GroupRole | OWNER=owner,ADMIN=admin,MEMBER=member |
CONTENT_TYPE_COMBINE | 绑定常量集(取值以绑定实现为准) |
能力总览
| 能力域 | 操作数 | 功能页 |
|---|---|---|
| 连接与监听 | 7 | 建立连接、连接监听 |
| 消息 | 26 | 发送消息、接收消息、消息管理、已读回执、输入状态、消息进阶 |
| 会话 | 22 | 历史消息、会话列表、未读数、草稿、置顶与免打扰、会话标签与分组、会话删除与类型免打扰 |
| 用户 | 10 | 用户资料、在线状态、在线状态订阅与推送令牌 |
| 好友与黑名单 | 11 | 好友列表、好友请求、黑名单 |
| 群组 | 20 | 创建群组、群成员、群管理、超级群频道与用户组 |
| 聊天室 | 5 | 加入与退出、聊天室信息 |
| 系统通知 | 1 | 系统通知 |
| 文件上传 | 1 | 文件上传 |
共 103 个语义操作、9 个能力域、29 个功能页;方法名与签名逐项来自 sdk-bindings.json。
快速链接
- 快速开始:5 步完成接入
- 导入 SDK:依赖与制品说明
- 初始化:选项、工厂与幂等语义
- 功能列表:103 个操作分组表
- API 参考:类、枚举与成员签名
- 状态码:客户端与 SDK 错误码
- 更新日志:IDL 冻结修订历史
相关文档
- HarmonyOS IMKit:UI 组件层(只依赖 IMLib 公开接口)
- 客户端集成总览:IMLib / IMKit 两条路径
- 服务端 API:用户、Token、群组与消息管理
- SDK 体系总览