277e8ed7c6
- 实现了聊天消息发送功能，支持文本、图片、视频、音频、文件等多种消息类型 - 集成了文件上传下载功能，支持多媒体文件的传输和管理 - 添加了群组管理功能，包括创建群组、成员管理、权限控制等操作 - 实现了好友系统，支持好友添加、删除、分组等功能 - 集成了黑名单管理，提供用户屏蔽和解除屏蔽功能 - 添加了会话管理功能，支持对话列表、未读消息统计等 - 实现了历史消息查询和搜索功能 - 添加了实时连接状态管理和自动重连机制
2.8 KiB
2.8 KiB
快速开始
5 分钟接入 XuqmGroup IM，实现消息收发。
1. 注册账号与创建应用
- 访问 XuqmGroup 控制台
- 注册开发者账号，创建应用
- 记录
appKey
2. 选择你的平台
| 平台 | 推荐接入方式 |
|---|---|
| Android | Android SDK → |
| iOS | iOS SDK → |
| React Native | RN SDK → |
| Vue3 / Web | Vue3 SDK → |
| HarmonyOS | HarmonyOS SDK → |
3. 接入流程
你的业务服务端
→ 持有 appSecret
→ 调用 IM 登录接口换取 IM Token（或签发 UserSig JWT）
→ 平台内部协议字段由 SDK 和后端自动处理，业务方无需感知
→ 返回 Token / UserSig 给客户端
客户端 SDK
→ 使用 appKey 初始化
→ 使用 Token / UserSig 登录 IM
→ 开始收发消息
安全提示：appSecret 应仅在你的服务端持有，不应下发给客户端。
4. Android Demo 运行说明
环境要求
- Android Studio Ladybug（2024.2.1）或更高版本
- JDK 21
- Android 模拟器或真机（API 24+）
运行步骤
- 打开
XuqmGroup-AndroidSDK目录为 Android Studio 项目 - 等待 Gradle Sync 完成（首次可能需要下载依赖）
- 在
sample-app/src/main/java/.../MainActivity.kt或对应配置中修改服务器地址（如需连接本地环境） - 选择模拟器或真机，点击 Run 'sample-app'
关键路径
APK 输出：XuqmGroup-AndroidSDK/sample-app/build/outputs/apk/debug/sample-app-debug.apk
主 Activity：com.xuqm.sdk.sample.MainActivity
包名：com.xuqm.demo
常用命令
# 构建全量 SDK + App
cd XuqmGroup-AndroidSDK && ./gradlew clean build
# 安装到指定设备
adb -s emulator-5556 install -r sample-app/build/outputs/apk/debug/sample-app-debug.apk
# 查看 IM 日志
adb -s emulator-5556 logcat -d "*:S" XuqmImSDK:D XuqmImClient:D 2>/dev/null | tail -30
5. iOS Demo 运行说明
环境要求
- Xcode 16.0 或更高版本
- iOS 18 模拟器或真机（最低支持 iOS 14）
- Swift 5.9+
运行步骤
- 打开
XuqmGroup-iOSSDK/XuqmDemo/XuqmDemo.xcodeproj（或.xcworkspace） - 等待 Swift Package Manager 依赖解析完成
- 在 Xcode 顶部选择目标模拟器（如 iPhone 16 Pro）或连接的真机
- 点击 Run（⌘+R）
关键路径
Demo 工程：XuqmGroup-iOSSDK/XuqmDemo/XuqmDemo.xcodeproj
SDK 源码：XuqmGroup-iOSSDK/Sources/XuqmSDK/
单元测试：XuqmGroup-iOSSDK/Tests/
常见问题
- SPM 依赖下载慢：检查网络或更换 Xcode → Preferences → Accounts → Git 配置
- 真机运行失败：确保 Apple Developer Account 已配置 Signing & Capabilities
- Push 测试：模拟器不支持 APNs，Push 功能需在真机测试
