XuqmGroup-RNSDK/README.md

44 行
1.2 KiB
Markdown

# XuqmGroup React Native SDK
2026-04-21 22:25:34 +08:00
`rn-sdk` 的稳定入口是 `src/index.ts`,统一登录/登出层在 `src/sdk.ts`
旧的 `src/core`、`src/im`、`src/push`、`src/update` 目录已清理,避免继续引用废弃实现。
2026-04-21 22:25:34 +08:00
## 当前结构
2026-04-21 22:25:34 +08:00
```text
XuqmGroup-RNSDK/
├── src/
│ ├── index.ts # 对外聚合入口
│ └── sdk.ts # 统一登录 / 登出封装
├── packages/
│ ├── common/ # 初始化、网络、设备、Token、基础组件
│ ├── im/ # IM、会话、历史、群组、关系链
│ ├── push/ # 推送设备注册
2026-05-07 19:39:41 +08:00
│ ├── update/ # App 更新 / RN 热更新
│ └── xwebview/ # 内置 WebView 浏览器
└── README.md
2026-04-21 22:25:34 +08:00
```
## 安装
2026-04-21 22:25:34 +08:00
```bash
yarn add @xuqm/rn-sdk
yarn add @react-native-async-storage/async-storage
2026-04-21 22:25:34 +08:00
# 如需按模块拆分接入,也可以直接安装
2026-05-07 19:39:41 +08:00
yarn add @xuqm/rn-common @xuqm/rn-im @xuqm/rn-push @xuqm/rn-update @xuqm/rn-xwebview
2026-04-21 22:25:34 +08:00
```
## 入口
2026-04-21 22:25:34 +08:00
- `XuqmSDK.initialize({ appKey, logLevel })`
- `XuqmSDK.login({ userId, userSig })`
- `XuqmSDK.logout()`
- `ImSDK`
- `PushSDK`
- `UpdateSDK`
2026-05-07 19:39:41 +08:00
- `XWebViewScreen`
- `XWebViewView`
2026-04-21 22:25:34 +08:00
详细用法见 [docs/rn-sdk/README.md](../docs/rn-sdk/README.md)。