ConnectionStatus 枚举(HarmonyOS IMLib)
连接状态枚举:共 4 个取值,定义来自 domain.json → enums.ConnectionStatus。
契约预留平台
HarmonyOS 当前为契约预留:本页的类、方法签名、枚举与示例全部来自冻结 IDL 与 sdk-bindings.json,SDK 尚未交付;实现后签名不会变化。
基本信息
| 项 | 值 |
|---|---|
| 枚举 | ConnectionStatus |
| 取值数 | 4 |
| 本平台常量名 | ConnectionStatus |
| IDL 来源 | domain.json → enums.ConnectionStatus |
| 跨端一致性 | 取值跨端一致;常量名与成员名按平台绑定 |
| 平台状态 | 契约预留 |
枚举常量摘要
| 名称 | 值 | 说明 |
|---|---|---|
CONNECTED | 0 | 已连接(收到 hello 之后) |
CONNECTING | 1 | 正在建连 / 重连 |
DISCONNECTED | 2 | 未连接(初始、主动断开、鉴权失败或放弃重连) |
SUSPEND | 3 | 连接中断,SDK 正在指数退避重连(异常断开) |
使用说明
getConnectionStatus() 的返回值;状态变化通过 CONNECTING / CONNECTED / DISCONNECT / SUSPEND / KICKED 事件通知。
示例
TypeScript
if (client.getConnectionStatus() === ConnectionStatus.CONNECTED) {
// 可以发送消息
}