tencent cloud

即时通信 IM

动态与公告
产品动态
公告
产品简介
产品概述
基本概念
应用场景
功能介绍
账号系统
用户资料与关系链
消息管理
群组相关
公众号系统
音视频通话 Call
使用限制
购买指南
计费概述
价格说明
购买指引
续费指引
停服说明
退费说明
开发指引
Demo 专区
开通服务
体验 Demo
快速跑通
下载中心
SDK & Demo 源码
更新日志
聊天互动(含 UI)
TUIKit 组件介绍
快速开始
全功能接入
单功能接入
AI 集成
构建基础界面
更多特性
定义外观
国际化界面语言
推送服务(Push)
服务概述
名词解释
开通服务
快速跑通
厂商通道
数据统计
排查工具
客户端 API
服务端 API
推送回调
高级功能
更新日志
错误码
常见问题
智能客服
功能概述
快速入门
集成指引
管理员操作手册
客服操作手册
更多实践
直播间搭建
AI 聊天机器人方案
超大娱乐协作社群
Discord 实现指南
游戏内集成 Chat 指南
类 WhatsApp Channel 搭建方案
发送红包
Chat 应对防火墙限制相关
无 UI 集成
快速开始
集成 SDK
初始化
登录登出
消息相关
会话相关
群组相关
社群话题
用户管理
离线推送
云端搜索
本地搜索
公众号
客户端 API
JavaScript
Android
iOS & macOS
Swift
Flutter
Electron
Unity
React Native
C 接口
C++
服务端 API
生成 UserSig
REST API
第三方回调
控制台指南
新版控制台介绍
创建并升级应用
基本配置
功能配置
账号管理
群组管理
公众号管理
回调配置
用量统计
资源包查看指南
实时监控
开发辅助工具
访问管理
高级功能
常见问题
uni-app 常见问题
购买相关问题
SDK 相关问题
账号鉴权相关问题
用户资料与关系链相关问题
消息相关问题
群组相关问题
直播群相关问题
昵称头像相关问题
协议与认证
服务等级协议
安全合规认证
IM 政策
隐私政策
数据隐私和安全协议
平滑迁移方案
平滑迁移完整版
平滑迁移简化版
错误码
联系我们

iOS

PDF
聚焦模式
字号
最后更新时间: 2025-06-12 10:00:53
本文主要介绍如何快速将 Chat SDK 集成到您的 iOS 项目中。

开发环境要求

Xcode 9.0+。
iOS 8.0 以上的 iPhone 或者 iPad 真机。
项目已配置有效的开发者签名。

集成 SDK

您可以选择使用 CocoaPods 自动加载的方式,或者先 下载 SDK,再将其导入到您当前的工程项目中。

CocoaPods 自动加载

1. 安装 CocoaPods

在终端窗口中输入如下命令(需要提前在 Mac 中安装 Ruby 环境):
sudo gem install cocoapods

2. 创建 Podfile 文件

进入项目所在路径输入以下命令行,之后项目路径下会出现一个 Podfile 文件。
pod init

3. 编辑 Podfile 文件

请您按照如下方式设置 Podfile 文件:
platform :ios, '8.0'
source 'https://github.com/CocoaPods/Specs.git'

target 'App' do
# 添加 Chat SDK
pod 'TXIMSDK_Plus_iOS'
# pod 'TXIMSDK_Plus_iOS_XCFramework'
# pod 'TXIMSDK_Plus_Swift_iOS_XCFramework'


# 如果您需要添加 Quic 插件,请取消下一行的注释
# 注意:
# - 这个插件必须搭配 TXIMSDK_Plus_iOS 或 TXIMSDK_Plus_iOS_XCFramework 版本的 Chat SDK 使用,并且插件版本号必须和 Chat SDK 版本号相同
# pod 'TXIMSDK_Plus_QuicPlugin_XCFramework'
end

4. 更新并安装 SDK

在终端窗口中输入如下命令以更新本地库文件,并安装 Chat SDK:
pod install
或使用以下命令更新本地库版本:
pod update
pod 命令执行完后,会生成集成了 SDK 的 .xcworkspace 后缀的工程文件,双击打开即可。 若 pod 搜索失败,建议尝试更新 pod 的本地 repo 缓存。更新命令如下:
pod setup
pod repo update
rm ~/Library/Caches/CocoaPods/search_index.json
说明:
Quic 插件,提供 axp-quic 多路传输协议,弱网抗性更优,网络丢包率达到 70% 的条件下,仍然可以提供服务。仅对专业版、专业版plus和企业版用户开放,请 购买专业版 、专业版plus或企业版后可使用。为确保功能正常使用,请将终端 SDK 更新至 7.7.5282 及其以上的版本。
如果您需要在 Swift 版本的 Chat SDK 中使用 Quic 功能,请您通过 Telegram 技术交流群 联系我们。

手动集成

1. 下载 SDK

Github 下载最新版本 SDK。ImSDK_Plus.framework 是增强版 Chat SDK 的核心动态库文件。

2. 创建工程

创建一个新工程

填入工程名(例如 IMDemo):


3. 集成 SDK

添加依赖库:选中 IMDemo 的 Target,在 General 面板中的 Embedded Binaries 和 Linked Frameworks and Libraries 添加依赖库 ImSDK_Plus.framework。


设置链接参数:在 Build Setting>Other Linker Flags 添加 -ObjC
说明
手动集成需要在 TARGET > General > Frameworks > Libraries and Embedded Content,将 ImSDK_Plus.framework 修改为 Embed&Sign。
如果您需要添加 Quic 插件,请参考前面的步骤,手动下载集成 Quic 插件。

引用 Chat SDK

项目代码中使用 SDK 有两种方式:
方式 1,在 Xcode > Build Setting > Header Search Paths 设置 SDK 头文件的路径,然后在项目需要使用 SDK API 的文件里,引入具体的头文件。
#import "ImSDK_Plus.h"
方式 2,在项目需要使用 SDK API 的文件里,引入具体的头文件。
#import <ImSDK_Plus/ImSDK_Plus.h>

常见问题

[Xcodeproj] Unknown object version (60). (RuntimeError)



使用 Xcode15 创建新工程来集成 SDK 时,输入 pod install 后,可能会遇到此问题,原因是使用了较旧版本的 CocoaPods ,此时有两种解决办法:
解决方式一: 修改 Xcode 工程的 Project Format 版本。

解决方式二: 升级本地的 CocoaPods 版本,升级方式本文不再赘述。
您可以在终端输入 pod --version 查看当前的Pods版本。

Xcode 15 开发者沙盒选项问题
Sandbox: bash(xxx) deny(1) file-write-create

当您使用 Xcode 15 创建一个新工程时, 可能会因为此选项导致编译运行失败,建议您关闭此选项。

Xcode 16 不支持 Framework 开启 bitcode 问题
解决方案1:升级 SDK 如果您使用的是包含 Bitcode 的旧版本 SDK(如 TXIMSDK_iOS),建议您按照本文档的指引,将 SDK 升级至 TXIMSDK_Plus_iOS_XCFramework。 解决方式2: 修改 Podfile 配置
在您的 Podfile 末尾新增如下配置,重新 Pod install。
post_install do |installer|
bitcode_strip_path = 'xcrun --find bitcode_strip'.chop!
def strip_bitcode_from_framework(bitcode_strip_path, framework_relative_path)
framework_path = File.join(Dir.pwd, framework_relative_path)
command = "#{bitcode_strip_path} #{framework_path} -r -o #{framework_path}"
puts "Stripping bitcode: #{command}"
system(command)
end
framework_paths = [
"/Pods/TXIMSDK_iOS/ImSDK.framework/ImSDK",
]
framework_paths.each do |framework_relative_path|
strip_bitcode_from_framework(bitcode_strip_path, framework_relative_path)
end
end

帮助和支持

本页内容是否解决了您的问题?

填写满意度调查问卷,共创更好文档体验。

文档反馈