XuqmGroup-RNSDK/README.md
XuqmGroup 9e11a63144 feat(sdk): 更新 SDK 设计文档和 API 重构
- 添加 expiresAt 和 refreshUserSig 参数支持自动续签
- 修改 PushSDK 初始化方式,自动完成设备注册和厂商初始化
- 调整过期续签策略,从提前 15 分钟改为提前 5 分钟触发
- 重构 RN SDK 文档结构,简化安装和使用方式
- 更新统一登录流程,支持 profile 信息传递
- 添加 IM 数据库自动隔离功能
- 修复 Android 群消息聚合问题
- 补充自动化测试验证和错误处理机制
2026-05-01 21:27:39 +08:00

41 行
1.1 KiB
Markdown

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