XuqmGroup-Web/docs-site/docs/ios/setup.md
XuqmGroup bb52b8e0b7 docs: 更新文档站各平台集成指南(BugCollect/配置文件/setUserInfo)
- android/setup.md: 新增 sdk-bugcollect、配置文件、BugCollect 章节
- ios/setup.md: 新增配置文件章节、setUserInfo
- rn/setup.md: withXuqmConfig Metro 插件、@xuqm/rn-bugcollect
- flutter/setup.md: 新增配置文件章节
- harmony/setup.md: 新增配置文件章节
- guide/quickstart.md: 更新配置文件获取流程
- guide/concepts.md: 新增 BugCollect 服务概念
- guide/flow.md: 更新服务流程

Co-Authored-By: Claude <noreply@anthropic.com>
2026-06-18 15:35:13 +08:00

2.3 KiB

iOS 安装配置

版本0.2.0 · 最低 iOS 版本iOS 16 · 语言Swift 5.9+


Swift Package Manager推荐

SDK 已发布到 Gitea,在 Xcode → File → Add Package Dependencies 中输入:

https://xuqinmin.com/xuqinmin12/XuqmGroup-iOSSDK

或在 Package.swift 中添加:

// swift-tools-version: 5.9
import PackageDescription

let package = Package(
    name: "MyApp",
    platforms: [.iOS(.v16)],
    dependencies: [
        .package(url: "https://xuqinmin.com/xuqinmin12/XuqmGroup-iOSSDK", from: "0.2.0")
    ],
    targets: [
        .target(
            name: "MyApp",
            dependencies: [
                .product(name: "XuqmSDK", package: "XuqmGroup-iOSSDK")
            ]
        )
    ]
)

目前 iOS SDK 以单模块 XuqmSDK 发布,内部包含 Core、IM、Push、Update 子模块。


最低 iOS 版本

  • iOS 16.0+
  • macOS 13.0+(如需 Mac Catalyst
  • Xcode 16.0+

权限声明

根据业务需要,在 Info.plist 中添加以下权限:

Camera拍照/视频通话)

<key>NSCameraUsageDescription</key>
<string>需要访问相机以发送图片或进行视频通话</string>

Photo Library发送图片/视频)

<key>NSPhotoLibraryUsageDescription</key>
<string>需要访问相册以发送图片和视频</string>

Microphone语音消息/语音通话)

<key>NSMicrophoneUsageDescription</key>
<string>需要访问麦克风以发送语音消息或进行通话</string>

配置文件

从平台控制台下载应用的 .xuqmconfig 配置文件(例如 识校宝.xuqmconfig),放入 App Bundle 的 xuqm/ 目录中,随 App 一起打包。SDK 启动时会自动扫描 Bundle 中的 xuqm/ 目录并读取配置,无需手动指定路径。


用户信息

SDK 提供用户信息管理接口,用于标识当前用户:

// 登录后设置用户信息
XuqmSDK.shared.setUserInfo(userId: "user_001")

// 登出时清除
XuqmSDK.shared.clearUserInfo()

初始化

AppDelegateSceneDelegate 中:

import XuqmSDK

XuqmSDK.shared.initialize(config: config)

下一步