事件概览

事件机制概览

OpenIM React Native SDK 通过 OpenIMEvent 定义事件名称，并使用统一的事件监听接口通知连接状态、数据变化和业务信令。

调用 OpenIMSDK.on() 设置监听，调用 OpenIMSDK.off() 取消监听。事件名称既可以使用 OpenIMEvent 中的枚举值，也可以直接传入对应的事件字符串，直接使用字符串时，必须与 SDK 定义的事件名完全一致。

function handleEvent(payload: unknown) {
  // 根据事件参数更新应用状态
}

// 设置监听
OpenIMSDK.on(OpenIMEvent.OnConversationChanged, handleEvent);
// 或者
OpenIMSDK.on("onConversationChanged", handleEvent);

// 取消监听
OpenIMSDK.off(OpenIMEvent.OnConversationChanged, handleEvent);
// 或者
OpenIMSDK.off("onConversationChanged", handleEvent);

每个事件的回调参数由 SDK 的事件声明决定，可能是实体对象、数组、进度值或错误信息。具体事件的参数格式和处理示例见对应功能页面。

事件分类

React Native SDK 的事件按业务领域分为以下类别：

注册时机与生命周期

React Native SDK 可以在任意时机注册全局事件监听。完成 initSDK() 并登录后，SDK 才会触发连接、同步及业务数据等事件回调；如果需要接收这些事件，应在对应操作前完成监听注册。

React Native SDK 支持对同一事件同时注册多个监听函数，事件触发时，所有监听函数都会收到回调，这与 Flutter 和 Android SDK 的单一 listener 机制不同。虽然 React Native SDK 允许同一事件注册多个监听，但仍建议在应用中集中注册和管理回调，避免页面渲染或组件重复进入时注册相同的业务处理逻辑。

监听函数应保持稳定引用。退出登录、切换账号或销毁相关状态时，使用注册时的同一事件名称和函数引用调用 off() 取消监听。

连接与初始化同步事件

连接事件用于反映 SDK 与服务端的连接状态：

登录后，SDK 通过以下事件通知初始化同步状态：

同步完成后，应用可重新查询当前界面需要的数据；后续用户、好友、会话、群组、消息和通话变化由对应业务事件通知。

按业务领域处理事件

各业务页面提供对应事件的完整参数说明和监听示例：