连接监听

订阅连接状态、消息、会话、好友与聊天室事件;同一事件可注册多个监听器,销毁页面时务必移除监听。

rev25:设备级投递游标(deviceId)

本端 SDK 首次连接自动生成随机 deviceId(≤128)并持久化到 localStorage["imkit:deviceId"];断线重连/重新 init 复用,disconnect() 不清除。业务无需传参。

建连时 SDK 把它放进 WS query(服务端 hello 回显);离线补收与 hello.syncState 按该设备游标计算。清缓存/换设备 = 新设备,首次会补收全部未 ack 消息。

完整语义见 多设备投递游标 与 deviceId 持久化与排障;C04 收口见 C04 多设备能力收口。

平台调用风格

异步风格:Promise<RcResult<T>>({ code, data?, msg? });业务错误通过 res.code !== 0 判断,不抛异常。

接口一览​

操作语义传输返回
addEventListener注册事件监听;同一 handler 重复注册只生效一次。本地null
removeEventListener移除事件监听。本地null
getCurrentUserId当前登录 userId;未登录返回空串。本地string

本页 3 个操作,其中 3 个在本平台绑定中声明了方法签名。

跨端方法名​

操作AndroidWebElectronmacOSFlutterNative (C ABI)iOS
addEventListeneraddEventListeneraddEventListeneraddEventListeneraddEventListeneraddEventListenerim_client_set_event_callbackfunc
removeEventListenerremoveEventListenerremoveEventListenerremoveEventListenerremoveEventListenerremoveEventListener—func
getCurrentUserIdgetCurrentUserIdgetCurrentUserIdgetCurrentUserIdgetCurrentUserIdgetCurrentUserIdim_client_current_user_idfunc

方法名在 GA 平台之间保持一致(规则 A);Native C ABI 只覆盖部分操作,其余操作以 — 标注。

addEventListener​

注册事件监听;同一 handler 重复注册只生效一次。

addEventListener(event, handler)
本地幂等since 1.0.0
参数
参数类型说明
eventstring必填;事件名(capabilityModel.events 之一)
handlerfunction必填;事件处理函数;同一 handler 重复注册只生效一次
返回

null 无返回数据;成功与否通过错误码判断

示例
JavaScript
const handler = (payload) => console.log('MESSAGES', payload.messages);
client.addEventListener(Events.MESSAGES, handler); // 返回取消函数,可用于移除

该操作未声明专属错误码;失败时按 SDK 通用错误处理,见 状态码。

removeEventListener​

移除事件监听。

removeEventListener(event, handler)
本地幂等since 1.0.0
参数
参数类型说明
eventstring必填;事件名(capabilityModel.events 之一)
handlerfunction必填;事件处理函数;同一 handler 重复注册只生效一次
返回

null 无返回数据;成功与否通过错误码判断

示例
JavaScript
client.removeEventListener(Events.MESSAGES, handler);

该操作未声明专属错误码;失败时按 SDK 通用错误处理,见 状态码。

getCurrentUserId​

当前登录 userId;未登录返回空串。

getCurrentUserId()
本地since 1.0.0
返回

string 字符串

示例
JavaScript
const userId = client.getCurrentUserId();

该操作未声明专属错误码;失败时按 SDK 通用错误处理,见 状态码。

相关文档​