连接监听
订阅连接状态、消息、会话、好友与聊天室事件;同一事件可注册多个监听器,销毁页面时务必移除监听。
平台调用风格
C ABI 约定:im_client_* 返回 int(0 成功,非 0 为 IDL 错误码);char** out_json 由库分配、调用方用 im_string_free 释放;char* out + size_t cap 为调用方缓冲区(0 成功 / -1 参数非法 / -2 缓冲区不足)。
接口一览
| 操作 | 语义 | 传输 | 返回 |
|---|---|---|---|
addEventListener | 注册事件监听;同一 handler 重复注册只生效一次。 | 本地 | null |
removeEventListener | 移除事件监听。 | 本地 | null |
getCurrentUserId | 当前登录 userId;未登录返回空串。 | 本地 | string |
本页 3 个操作,其中 2 个在本平台绑定中声明了方法签名,其余为 C ABI 未暴露(见对应小节)。
跨端方法名
| 操作 | 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 重复注册只生效一次。
im_client_set_event_callback(im_client_t*, im_event_cb cb, void* user_data)参数
| 参数 | 类型 | 说明 |
|---|---|---|
event | string | 必填;事件名(capabilityModel.events 之一) |
handler | function | 必填;事件处理函数;同一 handler 重复注册只生效一次 |
返回
null 无返回数据;成功与否通过错误码判断
示例
C
static void on_event(void* user_data, const char* event_json) {
/* event_json 为协议帧 JSON,按 type 字段分发 */
}
im_client_set_event_callback(client, on_event, NULL);该操作未声明专属错误码;失败时按 SDK 通用错误处理,见 状态码。
removeEventListener
移除事件监听。
本平台 C ABI 未暴露该方法
本操作未在 native C ABI(include/im_sdk.h)暴露;如需该能力,请使用 Web / Electron / Flutter / Android 绑定,或通过服务端 Open API 完成。
参数
| 参数 | 类型 | 说明 |
|---|---|---|
event | string | 必填;事件名(capabilityModel.events 之一) |
handler | function | 必填;事件处理函数;同一 handler 重复注册只生效一次 |
返回
null 无返回数据;成功与否通过错误码判断
示例
C
im_client_set_event_callback(client, NULL, NULL); /* 取消事件回调 */该操作未声明专属错误码;失败时按 SDK 通用错误处理,见 状态码。
getCurrentUserId
当前登录 userId;未登录返回空串。
im_client_current_user_id(im_client_t*, char* out, size_t out_len)返回
string 字符串
示例
C
char user_id[64];
if (im_client_current_user_id(client, user_id, sizeof(user_id)) != 0) {
/* 未连接或缓冲区不足 */
}该操作未声明专属错误码;失败时按 SDK 通用错误处理,见 状态码。
相关文档
- 功能列表:103 个操作与签名
- 状态码:错误码与重试策略
- API 参考:类与成员
- IMLib 集成指南