@tencentcloud/sdk-mcp 1.4.7 → 1.6.0-beta.2

package/resource/{doc/chatkit → integration/chat/preset}/android/integration.md

@@ -246,7 +246,7 @@ android {
 
 ### 步骤2：用户登录
 
-登录鉴权后才能正常使用组件的功能。您可以调用 login 接口，传入上文获取的 SDKAPPID、userSig 用于登录鉴权:
+登录鉴权后才能正常使用组件的功能。您可以调用 login 接口，传入上文获取的 SDKAPPID、userSig 用于登录鉴权。可参考 `chat/demo/app/src/main/java/io/trtc/tuikit/chat/login/LoginActivity.kt` 文件里实现：
 ``` swift
 // 用户登录
 LoginStore.shared.login(context, SDKAPPID, userID, userSig,
@@ -260,13 +260,13 @@ LoginStore.shared.login(context, SDKAPPID, userID, userSig,
     })
 ```
 
-> **注意：**
+> **警告：**
 >
 
-> 在正式的生产环境中，建议在您的服务端生成 UserSig，在需要 UserSig 时由您的 App 向业务服务器发起请求获取动态 UserSig 来进行鉴权。详见 [服务端生成 UserSig](https://cloud.tencent.com/document/product/269/32688)。
+> 在正式的生产环境中，请在您的服务端生成 UserSig，在需要 UserSig 时由您的 App 向业务服务器发起请求获取动态 UserSig 来进行鉴权。详见 [服务端生成 UserSig](https://cloud.tencent.com/document/product/269/32688)。
 >
 
-### 步骤3： 构建会话列表界面
+### 步骤3：构建会话列表界面
 
 您可以基于 TUIKit Compose 中的 ConversationList 组件，构建一个会话列表页面。ConversationList 内建的功能是：
 - 展示用户的会话列表，包含单聊和群聊会话
@@ -444,12 +444,12 @@ MessageList 内建的功能是：
 ConversationsPage、ChatPage、ContactsPage 中暴露了一些用户点击事件，您可以自定义事件来实现页面间的交互：
 | Page | 回调 | 建议跳转逻辑 |
 | --- | --- | --- |
-| **ConversationsPage** | `onConversationClick: (ConversationInfo) -> Unit` | 点击会话列表中的会话时触发，建议跳转到聊天页面（ChatPage）。 |
-| **ContactsPage** | `onContactClick: (ContactInfo) -> Unit` | 点击联系人 cell 时触发，建议跳转用户信息页（C2CChatSetting）。 |
-| `onGroupClick: (ContactInfo) -> Unit` | 点击群组 cell 时触发，建议跳转群聊页面（ChatPage）。 |  |
-| **ChatPage** | `onUserClick: (String) -> Unit` | 点击消息中的用户头像或昵称时触发，建议跳转用户信息页（C2CChatSetting）。 |
-| `onChatHeaderClick: (String) -> Unit` | 点击导航栏中的头像时触发，建议跳转用户信息页（C2CChatSetting）或群聊信息页（GroupChatSetting） |  |
-| `onBackClick: () -> Unit` | 点击返回按钮时触发，建议返回上一级页面。 |  |
+| <strong>ConversationsPage</strong> | <code>onConversationClick: (ConversationInfo) -> Unit</code> | 点击会话列表中的会话时触发，建议跳转到聊天页面（ChatPage）。 |
+| <strong>ContactsPage</strong> | <code>onContactClick: (ContactInfo) -> Unit</code> | 点击联系人 cell 时触发，建议跳转用户信息页（C2CChatSetting）。 |
+| <code>onGroupClick: (ContactInfo) -> Unit</code> | 点击群组 cell 时触发，建议跳转群聊页面（ChatPage）。 |  |
+| <strong>ChatPage</strong> | <code>onUserClick: (String) -> Unit</code> | 点击消息中的用户头像或昵称时触发，建议跳转用户信息页（C2CChatSetting）。 |
+| <code>onChatHeaderClick: (String) -> Unit</code> | 点击导航栏中的头像时触发，建议跳转用户信息页（C2CChatSetting）或群聊信息页（GroupChatSetting） |  |
+| <code>onBackClick: () -> Unit</code> | 点击返回按钮时触发，建议返回上一级页面。 |  |
 
 **chat/demo/app/src/main/java/io/trtc/tuikit/chat/MainActivity.kt **和 **chat/demo/app/src/main/java/io/trtc/tuikit/chat/chat/ChatActivity.kt** 作为上述 Page 的粘合层，实现了各个 Page 的回调事件，核心示例代码如下：
 ``` java
@@ -493,6 +493,6 @@ ChatPage(
 
 ### 功能常见问题
 
-**登录失败，提示签名错误**
+#### **登录失败，提示签名错误？**
 
 请检查 SDKAppID 和 UserSig 是否正确，UserSig 是否已过期。可以参考上文 配置用户鉴权 重新生成 UserSig。

package/resource/{doc/chatkit → integration/chat/preset}/flutter/integration.md

@@ -3,16 +3,16 @@ TUIKit Flutter 是基于腾讯云 IM SDK 的一套 Flutter UI 组件库，提供
 ## 关键概念
 
 TUIKit 提供了一套完整的即时通信 UI 组件，向下依赖 AtomicXCore 数据层，向上可构建各种功能性 Page。
-- Page 层：基于 TUIKit 组件封装的完整功能页面：ChatPage、ContactsPage、ConversationsPage，您可以直接使用。
+- Chat 组件层：基于基础组件和 AtomicXCore 封装的功能组件，您可将其嵌套到自己已有的 App 页面中。
 
-- TUIKit Flutter（UI 组件层）：基于 AtomicXCore 构建的 Flutter 组件，您可将其嵌套到自己已有的 App 页面中。
+- 基础组件层：通用 UI 能力和基础交互组件，为 Chat 组件层及业务 App 提供稳定、可复用的界面基础能力。
 
 - AtomicXCore（数据层）：提供数据管理和业务逻辑，包含各种 Store 和 Manager。
 
 ## 前提条件
 - Flutter >= 3.29.0 版本，Dart >= 3.7.0 版本，Kotlin >= 1.9版本。
 
-- Android Studio Ladybug | 2024.2.1 及以上版本，Android Gradle plugin 7.3.1 以上版本，JDK 17 版本。
+- Android Studio Ladybug 2024.2.1 及以上版本，Android Gradle Plugin 7.3.1 以上版本，JDK 17 版本。
 
 - Xcode 12.0 及以上版本。
 
@@ -45,37 +45,40 @@ git clone https://github.com/Tencent-RTC/TUIKit_Flutter.git
 项目目录结构说明：
 ``` bash
 atomic-x/
-├── lib/                  # UI 组件源码（必需集成）
-│   ├── messagelist/      # 消息列表组件
-│   ├── messageinput/     # 消息输入组件
-│   ├── conversationlist/ # 会话列表组件
-│   ├── contactlist/      # 联系人列表组件
-│   ├── basecomponent/    # 基础组件
-│   └── ...               # 其他 UI 组件
-├── call_assets/          # call 资源文件（必需集成）
-├── chat_assets/          # chat 资源文件（必需集成）
+├── lib/                            # UI 组件源码（必需集成）
+│   ├── album_picker/               # 相册选择器
+│   ├── base_component/             # 基础组件
+│   └── ...                         # 其他组件
+├── assets/                         # 资源文件（必需集成）
+├── ...                             # 其他
 chat/
-├── uikit/                # Page 组件（参考实现）
-│   ├── lib/
-│      ├── chat_page.dart
-│      ├── contacts_page.dart
-│      └── conversations_page.dart
-└── demo/                 # 示例应用（可选参考）
+├── uikit/lib/src/                  # 功能组件
+│   ├── messagelist/                # 消息列表组件
+│   ├── messageinput/               # 消息输入组件
+│   ├── conversationlist/           # 会话列表组件
+│   ├── contactlist/                # 联系人列表组件
+│   ├── pages/                      # page 组件（参考实现）
+│       ├── chat_page.dart
+│       ├── contacts_page.dart
+│       ├── conversations_page.dart
+│   └── ...                         # 其他 UI 组件
+└── demo/                           # 示例应用（可选参考）
 ```
 
 ### 集成组件
 1. 将组件目录完整复制到您的 Flutter 项目中，如下图所示，其中 flutter_demo 是示例项目，TUIKit_Flutter 是从 GitHub 上下载的组件源码：
 
-2. 在您的 pubspec.yaml 文件中添加 TUIKit Flutter 组件。注意，TUIKit_Flutter 可以放在任何位置，只要在 pubspec.yaml 中正确设置相对路径即可：
+2. 在您项目的 `pubspec.yaml` 文件中添加组件：
 
    ``` bash
-     tuikit_atomic_x:
-       path: ../TUIKit_Flutter/atomic-x
+     tencent_chat_uikit:
+       path: ../TUIKit_Flutter/chat/uikit
    ```
 
    > **注意：**
    >
->   - 使用本地集成方案时，如需升级，您需要从 GitHub 获取最新的组件代码，覆盖您本地项目的 TUIKit_Flutter 目录。
+>   - 可以修改 `chat/uikit/pubspec.yaml `文件里的 tuikit_atomic_x 依赖，改为依赖 pub 的线上版本。
+>   - 如需升级，您需要从 GitHub 获取最新的组件代码，覆盖您本地项目的 TUIKit_Flutter 目录。
 >   - 当私有化修改和远端有冲突时，需要手动合并，处理冲突。
 
 ### 配置项目
@@ -102,6 +105,25 @@ post_install do |installer|
 end
 
 ```
+- **清理 Gradle 全局配置（仅 Android 需要）：**如果您本地存在 `~/.gradle/init.gradle`，运行如下命令：
+
+   ``` bash
+   # 或者直接删除：rm -f ~/.gradle/init.gradle
+   mv ~/.gradle/init.gradle ~/.gradle/init.gradle.backup
+   ```
+
+   > **说明：**
+   >
+
+   > 如果您本地不存在 Gradle 全局配置文件 `~/.gradle/init.gradle`，请忽略。如果存在，并且该文件里配置有 `allprojects.repositories`，可以删除 `allprojects.repositories` 相关内容，或者删除 `~/.gradle/init.gradle`（建议备份文件），以免引起运行报错。
+   >
+
+- **配置 JDK 17（仅 Android 需要）：**在项目例如 `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
+   ```
 
 ## 接入步骤
 
@@ -125,10 +147,10 @@ if (result.errorCode == 0) {
 }
 ```
 
-> **注意：**
+> **警告：**
 >
 
-> 在正式的生产环境中，建议在您的服务端生成 UserSig，在需要 UserSig 时由您的 App 向业务服务器发起请求获取动态 UserSig 来进行鉴权。详见 [服务端生成 UserSig](https://cloud.tencent.com/document/product/269/32688)。
+> 在正式的生产环境中，请在您的服务端生成 UserSig，在需要 UserSig 时由您的 App 向业务服务器发起请求获取动态 UserSig 来进行鉴权。详见 [服务端生成 UserSig](https://cloud.tencent.com/document/product/269/32688)。
 >
 
 ### 步骤3：构建会话列表界面
@@ -140,7 +162,7 @@ if (result.errorCode == 0) {
 
    您可以将 ConversationList 直接集成到现有的 App 页面中，也可以新构建一个完整的会话列表页，组装后的一种 UI 效果如下图所示：
 
-   将 ConversationList 封装为会话列表页，可参考 `chat/uikit/lib/conversations_page.dart` 文件里的实现，`ConversationsPage` 主要做了以下工作：
+   将 ConversationList 封装为会话列表页，可参考 `chat/uikit/lib/src/pages/conversations_page.dart` 文件里的实现，`ConversationsPage` 主要做了以下工作：
 
 1. 在 ConversationList 上方添加了 AppBar。
 
@@ -191,7 +213,7 @@ if (result.errorCode == 0) {
 
 ### 步骤4：构建聊天界面
 
-您可以基于 TUIKit Flutter 中的 MessageList、MessageInput  组件，构建一个聊天页面。
+您可以基于 TUIKit Flutter 中的 MessageList、MessageInput 组件，构建一个聊天页面。
 
 MessageList 内建的功能是：
 - 展示单聊或群聊消息列表。
@@ -202,9 +224,9 @@ MessageList 内建的功能是：
 
 - 支持用户组建并发送多种类型的消息：文本、表情、图片、语音、视频、文件等。
 
-   您可以将 MessageList 和  MessageInput 直接集成到现有的 App 页面中，也可以新构建一个完整的聊天页，组装后的一种 UI 效果如下图所示：
+   您可以将 MessageList 和 MessageInput 直接集成到现有的 App 页面中，也可以新构建一个完整的聊天页，组装后的一种 UI 效果如下图所示：
 
-   将 MessageList 和 MessageInput 组装为聊天页，可参考  `chat/uikit/lib/chat_page.dart` 文件里的实现，`ChatPage` 主要做了以下工作：
+   将 MessageList 和 MessageInput 组装为聊天页，可参考 `chat/uikit/lib/src/pages/chat_page.dart` 文件里的实现，`ChatPage` 主要做了以下工作：
 
 1. 在最上方添加了 AppBar，展示会话的名称。
 
@@ -282,7 +304,7 @@ MessageList 内建的功能是：
 
    您可以将 ContactList 直接集成到现有的 App 中，也可以新构建一个完整的联系人列表页，组装后的一种 UI 效果如下图所示：
 
-   将 ContactList 封装为联系人列表页，可参考 `chat/uikit/lib/contacts_page.dart `文件里的实现，`ContactsPage` 主要做了以下工作：
+   将 ContactList 封装为联系人列表页，可参考 `chat/uikit/lib/src/pages/contacts_page.dart `文件里的实现，`ContactsPage` 主要做了以下工作：
 
 1. 在 ContactList 上方添加了 AppBar。
 
@@ -328,14 +350,14 @@ MessageList 内建的功能是：
 ConversationsPage、ChatPage、ContactsPage 中实现了默认的用户点击事件，您可以自定义事件来实现页面间的交互：
 | Page | 回调 | 建议跳转逻辑 |
 | --- | --- | --- |
-| **ConversationsPage** | `onConversationClick: (conversation) {}` | 点击会话列表中的会话时触发，建议跳转到聊天页面（ChatPage）。 |
-| **ContactsPage** | `onContactClick: (ContactInfo contactInfo) {}` | 点击联系人 cell 时触发，建议跳转到用户信息页（C2CChatSetting）。 |
-| `onGroupClick: (ContactInfo contactInfo) {}` | 点击群组 cell 时触发，建议跳转群聊页面（ChatPage）。 |  |
-| **ChatPage** | `onUserClick: (String userID) {}` | 点击消息中的用户头像或昵称时触发，建议跳转用户信息页（C2CChatSetting）。 |
-| `onChatHeaderClick: () {}` | 点击导航栏中的头像时触发，建议跳转用户信息页（C2CChatSetting）或群聊信息页（GroupChatSetting） |  |
-| `onBackClick: () {}` | 点击返回按钮时触发，建议返回上一级页面。 |  |
-
-您可以参考上述回调说明及参考代码，实现 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 之间交互逻辑。
 
 ## 常见问题