| 登录页 | 会话列表页 | 聊天页 |
| | | |
一、快速体验
你可以前往该页面体验各端 Chat Demo：体验 Demo。
二、开通服务
1. 登录 即时通信 IM 控制台。如果你已有应用，请记录其 SDKAppID 和密钥信息。
2. 在应用管理页面，单击创建新应用。
3. 输入应用名称、选择适用的数据中心，单击确定即可完成应用的创建。
4. 在应用管理页面的 SDKAppID 列获取 SDKAppID 和密钥信息。
三、环境准备
·Flutter >= 3.29.0 版本，Dart >= 3.7.0 版本
·Android Studio Ladybug | 2024.2.1 及以上版本，Android Gradle plugin 7.3.1 以上版本，JDK 17 版本。
·Xcode 12.0 及以上版本
注意：版本兼容性说明：
注意：为确保构建环境稳定，请严格遵循兼容性要求进行配置：
注意：我们建议你根据上述指南，选择与项目要求完全匹配的版本组合。
四、获取 Demo
1. 从 CNB 或者 GitHub 下载即时通信 Flutter Chat UIKit 工程。
2. 使用 Android Studio 打开下载的 chat/demo 项目，Android Studio > File > Open > 选择 demo 根目录，找到对应的 login_page 文件，路径为 lib/login_page.dart。
3. 设置 login_page 文件中的相关参数：
·SDKAPPID: 请设置为前文中获取的实际应用 SDKAppID。
·SECRETKEY: 请设置为前文中获取的实际密钥信息 。
注意：禁止：
注意：这篇提到的获取 UserSig 的方案是在客户端代码中配置 SECRETKEY，该方法中 SECRETKEY 很容易被反编译逆向破解，一旦你的密钥泄露，攻击者就可以盗用你的腾讯云流量，因此该方法仅适合本地跑通 Demo 和功能调试。正确的 UserSig 签发方式是将 UserSig 的计算代码集成到你的服务端，并提供面向 App 的接口，在需要 UserSig 时由你的 App 向业务服务器发起请求获取动态 UserSig。更多详情请参见 服务端生成 UserSig。
五、编译并运行 Demo
·用 Android Studio 导入工程，并安装 Flutter 和 Dart 插件。
·在项目根目录执行如下命令安装依赖。
flutter pub get
·以运行 Android 设备为例：
·将 Android 设备连接至电脑，在 Android 设备上打开开发者模式，启用 USB 调试，并且在 Android 设备上选择 USB 用于传输文件（如有）。
·在 Android Studio 界面顶部的 Running devices 选项中选择你用来测试的 Android 设备。
·点击运行按钮开始编译。编译成功后，你的设备上会自动安装好腾讯云 IM App。
·打开 App，输入任意 UserID 即可创建并登录用户账号。
·为方便测试消息互通，你可以创建两个不同的用户账号，添加好友后互相发送消息。
| 添加好友 | 搜索好友 | 通讯录新增好友 | 与好友聊天 |
| | | | |
开通内容审核功能
在消息发送、资料修改等场景中，可能会扩散不合适的内容，特别是与敏感事件/人物相关、黄色不良内容等令人反感的内容，不仅严重损害了用户们的身心健康，还有可能违法并导致业务被监管部门查封。
即时通信 IM 支持 云端审核（反垃圾信息）功能，可针对不安全、不适宜的内容进行自动识别、处理，为你的产品体验和业务安全保驾护航。你可直接前往 云端审核控制台 开通免费试用，规则详见 免费试用说明。
六、iOS 端 Pods 依赖无法安装成功的问题
方案一：手动删除 ios/Pods 文件夹，及 ios/Podfile.lock 文件，并执行如下命令，重新安装依赖。
cd iossudo gem install ffipod install –repo-update
方案二：配置运行后，如果报错，可以单击 Product > Clean Build Folder，清除产物后重新运行 pod install 或 flutter run
七、Flutter 环境的问题
如你需得知 Flutter 的环境是否存在问题，请运行 Flutter doctor 检测 Flutter 环境是否装好。
八、使用 Flutter 自动生成的项目，引入 TUIKit 后，运行 Android 端报错的问题
1. 打开 android\\app\\src\\main\\AndroidManifest.xml，根据如下，补全 xmlns:tools="http://schemas.android.com/tools" / android:label="@string/android_label" 及 tools:replace="android:label"。
<manifest xmlns:android="http://schemas.android.com/apk/res/android" package="替换成你的 Android 端包名" xmlns:tools="http://schemas.android.com/tools"> <application android:label="@string/android_label" tools:replace="android:label" android:icon="@mipmap/ic_launcher" // 指定一个 icon 路径 android:usesCleartextTraffic="true" android:requestLegacyExternalStorage="true">
2. 打开 android\\app\\build.gradle，补全 defaultConfig 中 minSdkVersion 及 targetSdkVersion。
defaultConfig { applicationId "" // 替换成你的Android端包名 minSdkVersion 21 targetSdkVersion 30}
九、错误码查询
IM SDK 的 API 层面错误码，请查看 错误码。
十、Demo 中语音转文字支持的数据中心
目前语音转文字仅支持中国数据中心的 SDKAppID 体验。
十一、表情包的使用
为了尊重版权，IM Demo/TUIKit 工程中默认不包含大表情元素切图。在正式上线商用前，请你替换为自己设计或拥有版权的其他表情包。请注意，下图所示的默认小黄脸表情包版权属于腾讯云，你可以通过升级至 IM 企业版套餐 免费使用该表情包。