React Native IMLib API 参考
本页列出 @ni-paas-im/react-native-im-wrapper 当前已实现的公开面(12/166 方法)。调用未实现方法会在 TypeScript 编译期报错。
与基线的差异
方法名/参数/枚举按 @rongcloud/react-native-im-wrapper 5.34.0 对齐;当前为骨架实现(12/166),未实现的方法会在 TypeScript 编译期报错,缺失清单随版本说明发布。
引擎方法
| 方法 | 签名 | 说明 |
|---|---|---|
| create | static create(appKey, options?, bridge?) | 进程内单例;返回 RCIMIWEngine |
| destroy | destroy(): Promise<number> | 幂等;释放原生资源 |
| connect | connect(token, timeout, callback?): Promise<number> | timeout 单位秒;返回 0 成功 |
| disconnect | disconnect(receivePush): Promise<number> | 断开连接;receivePush 控制是否继续接推送 |
| getConnectionStatus | getConnectionStatus(): Promise<RCIMIWConnectionStatus> | 当前连接状态 |
| getCurrentUserId | getCurrentUserId() | 当前登录 userId |
| createTextMessage | createTextMessage(type, targetId, channelId, text) | 构造文本消息(不发送) |
| sendMessage | sendMessage(message, callback?) | 发送消息;回调 onMessageSaved/onMessageSent |
| setOnMessageReceivedListener | setOnMessageReceivedListener(listener?) | 覆盖式注册;传 undefined 移除 |
| setOnConnectionStatusChangedListener | setOnConnectionStatusChangedListener(listener?) | 覆盖式注册;传 undefined 移除 |
| onMessageReceived | onMessageReceived(listener) | 别名:返回取消订阅函数(非基线) |
| onConnectionStatusChanged | onConnectionStatusChanged(listener) | 别名:返回取消订阅函数(非基线) |
枚举
| 枚举 | 取值(示例) | 说明 |
|---|---|---|
| RCIMIWConversationType | PRIVATE=1 / GROUP=2 / CHATROOM=3 / SYSTEM=4 / ULTRA_GROUP=5 | 会话类型 |
| RCIMIWConnectionStatus | NETWORK_UNAVAILABLE=0 / CONNECTED=1 / CONNECTING=2 / UNCONNECTED=3 … | 连接状态 |
| RCIMIWMessageType | TEXT 等(子集) | 消息类型 |
| RCIMIWMessageDirection | SEND / RECEIVE | 消息方向 |
| RCIMIWSentStatus / RCIMIWReceivedStatus | 子集 | 发送/接收状态 |
| RCIMIWErrorCode | SUCCESS=0 / PARAM_ERROR=1 / ENGINE_DESTROYED=2 … | 引擎错误码(业务码原样透传) |
| RCIMIWLogLevel | 子集 | 日志级别 |
事件
| 事件 | 注册方式 | 载荷 |
|---|---|---|
| 消息接收 | setOnMessageReceivedListener(fn) | RCIMIWMessage(messageId/conversationType/targetId/text…) |
| 连接状态变化 | setOnConnectionStatusChangedListener(fn) | RCIMIWConnectionStatus |