@tencentcloud/sdk-mcp 1.7.2 → 1.7.4

package/resource/integration/chat/preset/flutter/integration.md

@@ -49,14 +49,15 @@ TUIKit 提供了一套完整的即时通信 UI 组件，向下依赖 AtomicXCore
 ## 集成并引入组件
 
 > **说明：**
-> **Demo**：[GitHub 完整 Demo](https://github.com/Tencent-RTC/TUIKit_Flutter) 开箱即用，5 分钟跑通聊天 + 音视频通话全功能。
+> **Demo**：[CNB 完整 Demo（国内）](https://cnb.cool/tencent/cloud/trtc/TUIKit_Flutter) 或者 [GitHub 完整 Demo](https://github.com/Tencent-RTC/TUIKit_Flutter) 开箱即用，5 分钟跑通聊天 + 音视频通话全功能。
 >
 
 ### 下载源码
 
-1. 从 GitHub 下载 [TUIKit Flutter](https://github.com/Tencent-RTC/TUIKit_Flutter) 源码：
+从 CNB 下载 [TUIKit Flutter](https://cnb.cool/tencent/cloud/trtc/TUIKit_Flutter) 源码或者 GitHub 下载 [TUIKit Flutter](https://github.com/Tencent-RTC/TUIKit_Flutter) 源码：
 ``` xml
-git clone https://github.com/Tencent-RTC/TUIKit_Flutter.git
+git clone https://cnb.cool/tencent/cloud/trtc/TUIKit_Flutter
+// 或者 git clone https://github.com/Tencent-RTC/TUIKit_Flutter.git
 ```
 
 项目目录结构说明：
@@ -107,7 +108,7 @@ call/
 
 ### 配置项目
 
-#### iOS
+【iOS】
 
 在 iOS 端添加必要的权限配置。请打开 ios/Podfile ，在文件末尾新增如下权限代码：
 ``` objectivec
@@ -132,13 +133,13 @@ end
 
 ```
 
-#### Android
+【Android】
 - **清理 Gradle 全局配置：**如果您本地存在 `~/.gradle/init.gradle`，运行如下命令：
 
-   ``` bash
-   # 或者直接删除：rm -f ~/.gradle/init.gradle
-   mv ~/.gradle/init.gradle ~/.gradle/init.gradle.backup
-   ```
+``` bash
+# 或者直接删除：rm -f ~/.gradle/init.gradle
+mv ~/.gradle/init.gradle ~/.gradle/init.gradle.backup
+```
 
    > **说明：**
    >
@@ -147,101 +148,101 @@ end
 
 - **配置 JDK 17：**在项目例如 `chat/demo` 目录下的 `gradle.properties` 里增加一条 `org.gradle.java.home`，用来配置 JDK 17 路径，请替换成您实际的 JDK 17 的完整路径。参考如下：
 
-   ``` bash
-   # 请替换为您本地 JDK 17 的真实完整路径
-   org.gradle.java.home=xx/Java/JavaVirtualMachines/jdk-17.0.6.jdk/Contents/Home
-   ```
+``` bash
+# 请替换为您本地 JDK 17 的真实完整路径
+org.gradle.java.home=xx/Java/JavaVirtualMachines/jdk-17.0.6.jdk/Contents/Home
+```
 
-#### HarmonyOS
+【HarmonyOS】
 - 参考 [鸿蒙 Flutter 仓库文档](https://gitcode.com/CPF-Flutter/flutter_flutter/tree/oh-3.35.7-release) 的开发指南搭建环境。
 
 - 在您项目的 `pubspec.yaml` 文件中依赖重写（dependency_overrides）鸿蒙适配的第三方库，参考 `chat/demo/pubspec.yaml` 文件：
 
-   ``` javascript
-   dependency_overrides:
-     # ... 已有的 override 保持不变 ...
-     # HarmonyOS 专用(仅在使用 Flutter-OH 构建时启用,构建 Android/iOS 时请注释掉)
-
-     path_provider:
-       git:
-         url: "https://gitcode.com/openharmony-tpc/flutter_packages.git"
-         path: "packages/path_provider/path_provider"
-         ref: "provider-v2.1.5-ohos-1.0.0"
-     shared_preferences:
-       git:
-         url: "https://gitcode.com/openharmony-tpc/flutter_packages.git"
-         path: "packages/shared_preferences/shared_preferences"
-         ref: "shared_preferences-v2.5.4-ohos-1.0.0"
-     url_launcher:
-       git:
-         url: "https://gitcode.com/openharmony-tpc/flutter_packages.git"
-         path: "packages/url_launcher/url_launcher"
-         ref: "url_launcher_v6.3.2-ohos-1.0.0"
+``` javascript
+dependency_overrides:
+  # ... 已有的 override 保持不变 ...
+  # HarmonyOS 专用(仅在使用 Flutter-OH 构建时启用,构建 Android/iOS 时请注释掉)
+
+  path_provider:
+    git:
+      url: "https://gitcode.com/openharmony-tpc/flutter_packages.git"
+      path: "packages/path_provider/path_provider"
+      ref: "provider-v2.1.5-ohos-1.0.0"
+  shared_preferences:
+    git:
+      url: "https://gitcode.com/openharmony-tpc/flutter_packages.git"
+      path: "packages/shared_preferences/shared_preferences"
+      ref: "shared_preferences-v2.5.4-ohos-1.0.0"
+  url_launcher:
+    git:
+      url: "https://gitcode.com/openharmony-tpc/flutter_packages.git"
+      path: "packages/url_launcher/url_launcher"
+      ref: "url_launcher_v6.3.2-ohos-1.0.0"
 
-   ```
+```
 - 声明 HarmonyOS 权限，参考 `chat/demo/ohos/entry/src/main/module.json5` 在 `requestPermissions` 数组中加入所需权限。
 
-   ``` java
-   {
-     "module": {
-       "requestPermissions": [
-         // ===== system_grant(声明即得) =====
-         { "name": "ohos.permission.INTERNET" },
-         { "name": "ohos.permission.GET_NETWORK_INFO" },
-         { "name": "ohos.permission.VIBRATE" },
-         // ===== user_grant(需运行时申请,必须提供 reason 和 usedScene) =====
-         {
-           "name": "ohos.permission.CAMERA",
-           "reason": "$string:permission_reason_camera",
-           "usedScene": {
-             "abilities": [ "EntryAbility" ],
-             "when": "inuse"
-           }
-         },
-         {
-           "name": "ohos.permission.MICROPHONE",
-           "reason": "$string:permission_reason_microphone",
-           "usedScene": {
-             "abilities": [ "EntryAbility" ],
-             "when": "inuse"
-           }
-         },
-         {
-           "name": "ohos.permission.WRITE_IMAGEVIDEO",
-           "reason": "$string:permission_reason_write_media",
-           "usedScene": {
-             "abilities": [ "EntryAbility" ],
-             "when": "inuse"
-           }
-         },
-         {
-           "name": "ohos.permission.READ_PASTEBOARD",
-           "reason": "$string:permission_reason_read_pasteboard",
-           "usedScene": {
-             "abilities": [ "EntryAbility" ],
-             "when": "inuse"
-           }
-         }
-       ]
-     }
-   }
+``` java
+{
+  "module": {
+    "requestPermissions": [
+      // ===== system_grant(声明即得) =====
+      { "name": "ohos.permission.INTERNET" },
+      { "name": "ohos.permission.GET_NETWORK_INFO" },
+      { "name": "ohos.permission.VIBRATE" },
+      // ===== user_grant(需运行时申请,必须提供 reason 和 usedScene) =====
+      {
+        "name": "ohos.permission.CAMERA",
+        "reason": "$string:permission_reason_camera",
+        "usedScene": {
+          "abilities": [ "EntryAbility" ],
+          "when": "inuse"
+        }
+      },
+      {
+        "name": "ohos.permission.MICROPHONE",
+        "reason": "$string:permission_reason_microphone",
+        "usedScene": {
+          "abilities": [ "EntryAbility" ],
+          "when": "inuse"
+        }
+      },
+      {
+        "name": "ohos.permission.WRITE_IMAGEVIDEO",
+        "reason": "$string:permission_reason_write_media",
+        "usedScene": {
+          "abilities": [ "EntryAbility" ],
+          "when": "inuse"
+        }
+      },
+      {
+        "name": "ohos.permission.READ_PASTEBOARD",
+        "reason": "$string:permission_reason_read_pasteboard",
+        "usedScene": {
+          "abilities": [ "EntryAbility" ],
+          "when": "inuse"
+        }
+      }
+    ]
+  }
+}
 
-   ```
+```
 - 在项目根目录 `ohos/build-profile.json5` 里启用 `useNormalizedOHMUrl`，否则会报“Bytecode HARs not supported when useNormalizedOHMUrl is not true”的错误。
 
-   ``` java
-   {
-     "app": {
-       "products": [{
-         "name": "default",
-         "buildOption": {
-           "arkOptions": { "useNormalizedOHMUrl": true }
-         }
-       }]
-     }
-   }
+``` java
+{
+  "app": {
+    "products": [{
+      "name": "default",
+      "buildOption": {
+        "arkOptions": { "useNormalizedOHMUrl": true }
+      }
+    }]
+  }
+}
 
-   ```
+```
 
 ## 接入步骤
 
@@ -260,6 +261,7 @@ final result = await LoginStore.shared.login(
     );
 if (result.errorCode == 0) {
     // 登录成功，可跳转聊天或会话页
+    TUICallKit.instance.login(SDKAPPID, userID, userSig);
 } else {
     // 登录失败，可弹框报错
 }
@@ -269,63 +271,7 @@ if (result.errorCode == 0) {
 > 在正式的生产环境中，请在您的服务端生成 UserSig，在需要 UserSig 时由您的 App 向业务服务器发起请求获取动态 UserSig 来进行鉴权。详见 [服务端生成 UserSig](https://cloud.tencent.com/document/product/269/32688)。
 >
 
-### 步骤3：构建会话列表界面
-
-您可以基于 TUIKit Flutter 中的 ConversationList 组件，构建一个会话列表页面。ConversationList 内建的功能是：
-- 展示用户的会话列表，包含单聊和群聊会话
-
-- 支持用户操作单个会话：置顶、删除、清空会话消息等
-
-   将 ConversationList 封装为会话列表页，可参考 `chat/uikit/lib/src/pages/conversations_page.dart` 文件里的实现，`ConversationsPage` 主要做了以下工作：
-
-1. 在 ConversationList 上方添加了 AppBar。
-
-2. 实现点击会话列表 cell 事件。
-
-3. 支持创建会话和群组功能：
-
-  1. 点击右上角按钮可以创建新会话或群组
-
-  2. 支持从联系人列表选择好友创建单聊
-
-  3. 支持选择多个好友创建群聊
-
-      核心示例代码如下所示：
-
-      ``` java
-        @override
-        Widget build(BuildContext context) {
-          return Scaffold(
-            appBar: AppBar(
-              backgroundColor: colorsTheme.bgColorOperate,
-              title: Text(atomicLocale.chat, style: TextStyle(fontSize: 34, fontWeight: FontWeight.w600)),
-              centerTitle: false,
-              scrolledUnderElevation: 0,
-              actions: [],
-            ),
-            body: Column(
-              children: [
-                Expanded(
-                  child: ConversationList(
-                    onConversationClick: (conversation) {
-                      Navigator.push(
-                        context,
-                        MaterialPageRoute(
-                          builder: (context) => ChatPage(
-                            conversation: conversation,
-                          ),
-                        ),
-                      );
-                    },
-                  ),
-                ),
-              ],
-            ),
-          );
-        }
-      ```
-
-### 步骤4：构建聊天界面
+### 步骤3：构建聊天界面
 
 您可以基于 TUIKit Flutter 中的 MessageList、MessageInput 组件，构建一个聊天页面。
 
@@ -401,82 +347,14 @@ MessageList 内建的功能是：
      }
    ```
 
-### 步骤5：构建联系人界面
-
-您可以基于 TUIKit Flutter 中的 ContactList 组件，构建一个联系人页面。ContactList 内建的功能是：
-- 查看好友申请列表。
-
-- 查看已加入的群列表。
-
-- 处理群组邀请和申请。
-
-- 管理黑名单列表。
-
-- 查看好友。
-
-   将 ContactList 封装为联系人列表页，可参考 `chat/uikit/lib/src/pages/contacts_page.dart` 文件里的实现，`ContactsPage` 主要做了以下工作：
-
-1. 在 ContactList 上方添加了 AppBar。
-
-2. 实现点击联系人列表 cell 事件。
-
-3. 支持添加联系人和添加群组：
-
-  1. 点击右上角 "+" 按钮可以添加联系人或群组
-
-  2. 支持根据 UserID 搜索目标联系人
+### 步骤4：音视频通话
 
-  3. 支持根据 GroupID 搜索目标群组
-
-      核心示例代码如下所示：
-
-      ``` java
-        @override
-        Widget build(BuildContext context) {
-          AtomicLocalizations atomicLocale = AtomicLocalizations.of(context);
-          SemanticColorScheme colorsScheme = BaseThemeProvider.colorsOf(context);
-          return Scaffold(
-            appBar: AppBar(
-              backgroundColor: colorsScheme.bgColorOperate,
-              title: Text(atomicLocale.contact, style: TextStyle(fontSize: 34, fontWeight: FontWeight.w600),),
-              centerTitle: false,
-              scrolledUnderElevation: 0,
-              actions: [],
-            ),
-            body: ContactList(
-              onGroupClick: (ContactInfo contactInfo) {
-                _onGroupClick(context, contactInfo);
-              },
-              onContactClick: (ContactInfo contactInfo) {
-                _onContactClick(context, contactInfo);
-              },
-            ),
-          );
-        }
-      ```
-
-### 步骤6：完善界面间的跳转逻辑
-
-ConversationsPage、ChatPage、ContactsPage 中实现了默认的用户点击事件，您可以自定义事件来实现页面间的交互：
-| Page | 回调 | 建议跳转逻辑 |
-| --- | --- | --- |
-| <strong>ConversationsPage</strong> | <code>onConversationClick: (conversation) {}</code> | 点击会话列表中的会话时触发，建议跳转到聊天页面（ChatPage）。 |
-| <strong>ContactsPage</strong> | <code>onContactClick: (ContactInfo contactInfo) {}</code> | 点击联系人 cell 时触发，建议跳转到用户信息页（C2CChatSetting）。 |
-| <code>onGroupClick: (ContactInfo contactInfo) {}</code> | 点击群组 cell 时触发，建议跳转到群聊页面（ChatPage）。 |  |
-| <strong>ChatPage</strong> | <code>onUserClick: (String userID) {}</code> | 点击消息中的用户头像或昵称时触发，建议跳转到用户信息页（C2CChatSetting）。 |
-| <code>onChatHeaderClick: () {}</code> | 点击导航栏中的头像时触发，建议跳转到用户信息页（C2CChatSetting）或群聊信息页（GroupChatSetting） |  |
-| <code>onBackClick: () {}</code> | 点击返回按钮时触发，建议返回上一级页面。 |  |
-
-您可以参考上述回调说明及代码，实现 Page 之间交互逻辑。
-
-### 步骤7：音视频通话（推荐）
-
-在聊天中支持音视频通话，请先 [开通音视频服务](https://console.cloud.tencent.com/im)，登录后即可在 Chat 组件中正常使用该功能。
+在 `LoginStore` 登录成功后，登录 `TUICallKit` 即可在 Chat 组件中正常使用该功能。如需开通音视频通话服务，
 ``` javascript
 TUICallKit.instance.login(SDKAPPID, userID, userSig);
 ```
 
-### 步骤8：接入智能客服 Desk 用户端（可选）
+### 步骤5：接入智能客服 Desk 用户端
 
 若需同时集成智能客服 Desk 用户端，请先 [开通智能客服 Desk 服务](https://cloud.tencent.com/document/product/269/96059)，并根据 [Flutter 接入智能客服用户端](https://cloud.tencent.com/document/product/269/113293) 文档完成 `tencentcloud_ai_desk_customer` 包引入和配置，即可在您的应用中引入客服会话能力。
 ``` java
@@ -508,3 +386,18 @@ TencentCloudAIDeskCustomer.navigate(
 
 请检查 SDKAppID 和 UserSig 是否正确，UserSig 是否已过期。可以参考上文 配置用户鉴权 重新生成 UserSig。
 
+### **如何移除音视频通话功能？**
+
+如果您不需要集成音视频通话功能，请在 `pubspec.yaml` 文件中移除 `tencent_calls_uikit` 依赖，并在 步骤3 构建聊天界面 中关闭音视频通话开关，代码如下所示：
+``` javascript
+ChatMessageInputConfig messageInputConfig = const ChatMessageInputConfig(
+  isShowAudioCall: false,
+  isShowVideoCall: false,
+);
+MessageInput(
+  key: _messageInputKey,
+  conversationID: widget.conversation.conversationID,
+  config: widget.messageInputConfig,
+),
+```
+