harperhpliu
9.9 KiB
English | 简体中文
本文介绍如何快速跑通即时通信 IM 的体验 Demo。
为尊重表情设计版权，IM Demo/TUIKit 工程中不包含大表情元素切图，正式上线商用前请您替换为自己设计或拥有版权的其他表情包。下图所示默认的小黄脸表情包版权归腾讯云所有，可有偿授权使用，如需获得授权可 提交工单 联系我们。
步骤1：创建应用
- 登录即时通信 IM 控制台。
如果您已有应用，请记录其 SDKAppID 并 配置应用。
- 在应用管理页面，单击创建新应用，在弹出的对话框中输入应用名称，选择合适的数据中心，单击确定。
- 创建完成后，可在应用管理页面查看、搜索、管理应用。请记录 SDKAppID 信息。
步骤2：获取密钥信息
- 在应用管理页面的操作中单击查看密钥。
- 在弹出的对话框中，单击显示密钥，复制并保存密钥信息。
请妥善保管密钥信息，谨防泄露。
步骤3：下载并配置 Demo 源码
- 从 Github 克隆即时通信 IM Demo 工程。
- 打开所属终端目录的工程，找到对应的
GenerateTestUserSig文件。
| 所属平台 | 文件相对路径 |
|---|---|
| Android | Android/Demo/app/src/main/java/com/tencent/qcloud/tim/demo/signature/GenerateTestUserSig.java |
| iOS | iOS/Demo/TUIKitDemo/Private/GenerateTestUserSig.h |
| Mac | Mac/Demo/TUIKitDemo/Debug/GenerateTestUserSig.h |
| Windows | Windows/Demo/IMApp/GenerateTestUserSig.h |
| Web（通用） | Web/Demo/public/debug/GenerateTestUserSig.js |
| 小程序 | MiniProgram/Demo/static/utils/GenerateTestUserSig.js |
- 设置
GenerateTestUserSig文件中的相关参数：
本文以使用 Android Studio 打开 Android 工程为例。
!本文提到的获取 UserSig 的方案是在客户端代码中配置 SECRETKEY，该方法中 SECRETKEY 很容易被反编译逆向破解，一旦您的密钥泄露，攻击者就可以盗用您的腾讯云流量，因此该方法仅适合本地跑通 Demo 和功能调试。 正确的 UserSig 签发方式是将 UserSig 的计算代码集成到您的服务端，并提供面向 App 的接口，在需要 UserSig 时由您的 App 向业务服务器发起请求获取动态 UserSig。更多详情请参见 服务端生成 UserSig。
步骤4：编译运行（全部功能）
- 终端执行以下命令，检查 pod 版本。
pod --version
如果提示 pod 不存在，或者 pod 版本小于 1.7.5，请执行以下命令安装最新 pod。
// 更换源
gem sources --remove https://rubygems.org/
gem sources --add https://gems.ruby-china.com/
// 安装 pod
sudo gem install cocoapods -n /usr/local/bin
// 如果安装了多个 Xcode ，请使用下面的命令选择 Xcode 版本（一般选择最新的 Xcode 版本）
sudo xcode-select -switch /Applications/Xcode.app/Contents/Developer
// 更新 pod 本地库
pod setup
- 终端执行以下命令，加载 ImSDK 库。
cd iOS/Demo
pod install
- 如果安装失败，运行以下命令更新本地的 CocoaPods 仓库列表
pod repo update
cd iOS/Demo
pod install （如果报错，执行 pod update）
- 进入 iOS/Demo 文件夹，打开
TUIKitDemo.xcworkspace编译运行。
注意：Demo 默认集成了音视频通话组件，由于音视频通话组件依赖的音视频 SDK 暂不支持模拟器，请使用真机调试/运行 Demo
步骤5：编译运行（移除音视频通话功能）
如果您不想集成音视频通话功能，可以按照下面的步骤移除:
- 进入 iOS/Demo 文件夹，修改
Podfile文件，屏蔽TUICallKit pod 集成，然后执行pod install` 命令。
# pod 'TUICallKit' （不需要再集成该库）
操作完后会发现，Demo 中的音频通话、视频通话入口均被隐藏。
会话界面屏蔽 TUICallKit 前后的效果：
联系人资料界面屏蔽 TUICallKit 前后的效果：
以上演示的仅仅是 Demo 对移除音视频通话功能的处理，开发者可以按照业务要求自定义。
步骤6：编译运行（移除搜索功能）
进入 iOS/Demo 文件夹，修改 Podfile 文件，屏蔽 TUISearch pod 集成，然后执行 pod install 命令。
# pod 'TUISearch' （不需要再集成该库）
操作完后会发现，Demo 中的消息搜索框被隐藏。
消息界面屏蔽 TUISearch 前后的效果：
以上演示的仅仅是 Demo 对移除搜索功能的处理，开发者可以按照业务要求自定义。