连接监听

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

平台调用风格

双语言同契约: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 个在本平台绑定中声明了方法签名。

跨端方法名​

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

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

addEventListener​

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

func addEventListener(_ event: IMPEvent, listener: IMPEventListener) -> Void
本地幂等since 1.0.0
参数
参数类型说明
eventstring必填;事件名(capabilityModel.events 之一)
handlerfunction必填;事件处理函数;同一 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
本地幂等since 1.0.0
参数
参数类型说明
eventstring必填;事件名(capabilityModel.events 之一)
handlerfunction必填;事件处理函数;同一 handler 重复注册只生效一次
返回

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

示例(Swift / Objective-C)​

client.removeEventListener(.messages, listener: listener)
[client removeEventListener:listenerToken];   // token 来自 addEventListener

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

getCurrentUserId​

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

func getCurrentUserId() -> String
本地since 1.0.0
返回

string 字符串

示例(Swift / Objective-C)​

let res = client.getCurrentUserId()
NSString *userId = [client getCurrentUserId];

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

相关文档​