连接监听
订阅连接状态、消息、会话、好友与聊天室事件;同一事件可注册多个监听器,销毁页面时务必移除监听。
契约预留
本平台为 reserved:以下签名来自已冻结绑定,示例为契约样例,不承诺可运行。
平台调用风格
异步风格:Promise<RcResult<T>>(不 reject;错误码在 RcResult.code);uint64/int64 映射为 number,超出安全整数时由实现改用 string。
接口一览
| 操作 | 语义 | 传输 | 返回 |
|---|---|---|---|
addEventListener | 注册事件监听;同一 handler 重复注册只生效一次。 | 本地 | null |
removeEventListener | 移除事件监听。 | 本地 | null |
getCurrentUserId | 当前登录 userId;未登录返回空串。 | 本地 | string |
本页 3 个操作,其中 3 个在本平台绑定中声明了方法签名。
跨端方法名
| 操作 | Android | Web | Electron | macOS | Flutter | Native (C ABI) | iOS |
|---|---|---|---|---|---|---|---|
addEventListener | addEventListener | addEventListener | addEventListener | addEventListener | addEventListener | im_client_set_event_callback | func |
removeEventListener | removeEventListener | removeEventListener | removeEventListener | removeEventListener | removeEventListener | — | func |
getCurrentUserId | getCurrentUserId | getCurrentUserId | getCurrentUserId | getCurrentUserId | getCurrentUserId | im_client_current_user_id | func |
方法名在 GA 平台之间保持一致(规则 A);Native C ABI 只覆盖部分操作,其余操作以 — 标注。
addEventListener
注册事件监听;同一 handler 重复注册只生效一次。
addEventListener(event: IMClientEvent, listener: IMClientEventListener): void参数
| 参数 | 类型 | 说明 |
|---|---|---|
event | string | 必填;事件名(capabilityModel.events 之一) |
handler | function | 必填;事件处理函数;同一 handler 重复注册只生效一次 |
返回
null 无返回数据;成功与否通过错误码判断
示例
TypeScript
// HarmonyOS 绑定为契约预留,以下为声明样例
const handler = (payload: IMClientEventPayload) => { /* 处理事件载荷 */ };
client.addEventListener(IMClientEvent.MESSAGES, handler);该操作未声明专属错误码;失败时按 SDK 通用错误处理,见 状态码。
removeEventListener
移除事件监听。
removeEventListener(event: IMClientEvent, listener: IMClientEventListener): void参数
| 参数 | 类型 | 说明 |
|---|---|---|
event | string | 必填;事件名(capabilityModel.events 之一) |
handler | function | 必填;事件处理函数;同一 handler 重复注册只生效一次 |
返回
null 无返回数据;成功与否通过错误码判断
示例
TypeScript
// HarmonyOS 绑定为契约预留,以下为声明样例
client.removeEventListener(IMClientEvent.MESSAGES, handler);该操作未声明专属错误码;失败时按 SDK 通用错误处理,见 状态码。
getCurrentUserId
当前登录 userId;未登录返回空串。
getCurrentUserId(): string返回
string 字符串
示例
TypeScript
// HarmonyOS 绑定为契约预留,以下为声明样例
const userId = client.getCurrentUserId();该操作未声明专属错误码;失败时按 SDK 通用错误处理,见 状态码。
相关文档
- 功能列表:103 个操作与签名
- 状态码:错误码与重试策略
- API 参考:类与成员
- IMLib 集成指南