连接监听
订阅连接状态、消息、会话、好友与聊天室事件;同一事件可注册多个监听器,销毁页面时务必移除监听。
平台调用风格
双语言同契约:Swift 用 async -> RcResult<T>(错误码在 RcResult.code,返回 null 的 op 用 RcResult<Void>);Objective-C 用 - (void)opWithParam:... completion:(void (^)(RcResult *))completion,回调在主线程投递。
接口一览
| 操作 | 语义 | 传输 | 返回 |
|---|---|---|---|
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 重复注册只生效一次。
func addEventListener(_ event: IMPEvent, listener: IMPEventListener) -> Void参数
| 参数 | 类型 | 说明 |
|---|---|---|
event | string | 必填;事件名(capabilityModel.events 之一) |
handler | function | 必填;事件处理函数;同一 handler 重复注册只生效一次 |
返回
null 无返回数据;成功与否通过错误码判断
示例(Swift / Objective-C)
final class MessageEventListener: IMPEventListener {
func onEvent(_ payload: IMPEventPayload) {
if case .messages(let messages) = payload {
for message in messages { /* 处理消息 */ }
}
}
}
let listener = MessageEventListener()
client.addEventListener(.messages, listener: listener)IMPOSListenerToken *listenerToken = [client addEventListener:@"messages" handler:^(IMPOSEvent *event) {
/* 处理事件载荷(event.type / event.payload) */
}];该操作未声明专属错误码;失败时按 SDK 通用错误处理,见 状态码。
removeEventListener
移除事件监听。
func removeEventListener(_ event: IMPEvent, listener: IMPEventListener) -> Void参数
| 参数 | 类型 | 说明 |
|---|---|---|
event | string | 必填;事件名(capabilityModel.events 之一) |
handler | function | 必填;事件处理函数;同一 handler 重复注册只生效一次 |
返回
null 无返回数据;成功与否通过错误码判断
示例(Swift / Objective-C)
client.removeEventListener(.messages, listener: listener)[client removeEventListener:listenerToken]; // token 来自 addEventListener该操作未声明专属错误码;失败时按 SDK 通用错误处理,见 状态码。
getCurrentUserId
当前登录 userId;未登录返回空串。
func getCurrentUserId() -> String返回
string 字符串
示例(Swift / Objective-C)
let res = client.getCurrentUserId()NSString *userId = [client getCurrentUserId];该操作未声明专属错误码;失败时按 SDK 通用错误处理,见 状态码。
相关文档
- 功能列表:103 个操作与签名
- 状态码:错误码与重试策略
- API 参考:类与成员
- IMLib 集成指南