@tencentcloud/sdk-mcp 1.7.2 → 1.7.4

package/resource/knowledge/chat/preset/android-view/integration.md

@@ -28,40 +28,51 @@ TUIKit 采用数据驱动的响应式架构与原生 Android View 体系（非 C
       > 我们建议您根据上述指南，选择与项目要求完全匹配的版本组合。
       >
 
-### 集成步骤
-1. 从 GitHub 仓库 [Tencent-RTC/TUIKit_Android](https://github.com/Tencent-RTC/TUIKit_Android) 下载源码，将仓库根目录下的 `chat`、`atomic_x`（以及可选的、用于音视频通话的 `call`）文件夹整体复制到您的工程根目录下。复制完成后的目录结构如下：
-
-   ``` text
-   YourApplication/
-   ├── app/                    # 您的应用模块
-   ├── atomic_x/               # 基础 UI 组件库（必要）
-   ├── call/                   # 音视频通话组件（可选）
-   │   └── tuicallkit-kt/
-   ├── chat/                   # Chat 源码
-   │   ├── demo/               # 示例工程（可参考，非必需）
-   │   └── uikit/              # Chat UIKit 组件库（必要）
-   ├── settings.gradle.kts
-   └── build.gradle.kts
-   ```
-
-   > **说明：**TUIKit_Android 是包含多个产品的开源仓库，Chat 的 UI 源码位于 `chat/` 目录下（`chat/uikit` 为 UIKit 组件库，`chat/demo` 为示例工程），其依赖的基础组件 `atomic_x` 与音视频通话组件 `call/tuicallkit-kt` 位于仓库根目录。模块目录可放在工程任意位置，只需在 `settings.gradle.kts` 中设置正确的相对路径即可。
-   >
-
-2. 在 `settings.gradle.kts` 中引入对应模块（请按源码实际存放位置调整相对路径）：
+### 集成并引入组件
+
+> **说明：**
+> Demo：[CNB 完整 Demo（国内）](https://cnb.cool/tencent/cloud/trtc/TUIKit_Android) 或者 [GitHub 完整 Demo](https://github.com/Tencent-RTC/TUIKit_Android) 开箱即用，5 分钟跑通聊天 + 音视频通话全功能。
+>
+
+### 下载源码
+
+从 CNB 下载 [TUIKit Android](https://cnb.cool/tencent/cloud/trtc/TUIKit_Android) 源码或者 GitHub 下载 [TUIKit Android](https://github.com/Tencent-RTC/TUIKit_Android) 源码：
+``` java
+git clone https://cnb.cool/tencent/cloud/trtc/TUIKit_Android
+// 或者 git clone https://github.com/Tencent-RTC/TUIKit_Android.git
+```
+
+将仓库根目录下的 `chat`、`call` 和 `atomic_x` 文件夹整体复制到您的工程根目录下。复制完成后的目录结构如下：
+``` text
+YourApplication/
+├── app/                    # 您的应用模块
+├── atomic_x/               # 基础 UI 组件库
+├── call/                   # 音视频通话组件
+│   └── tuicallkit-kt/
+├── chat/                   # Chat 源码
+│   ├── demo/               # 示例工程
+│   └── uikit/              # Chat UIKit 组件库
+├── settings.gradle.kts
+└── build.gradle.kts
+```
+
+> **说明：**
+> TUIKit_Android 是包含多个产品的开源仓库，Chat 的 UI 源码位于 `chat/` 目录下（`chat/uikit` 为 UIKit 组件库，`chat/demo` 为示例工程），其依赖的基础组件 `atomic_x` 与音视频通话组件 `call/tuicallkit-kt` 位于仓库根目录。模块目录可放在工程任意位置，只需在 `settings.gradle.kts` 中设置正确的相对路径即可。
+>
+
+### 集成组件
+1. 在 `settings.gradle.kts` 中引入对应模块（请按源码实际存放位置调整相对路径）：
 
 【Kotlin DSL】
 ``` kotlin
 // settings.gradle.kts
 
-// 引入 Chat UIKit 组件库（必要）
-include(":uikit")
-project(":uikit").projectDir = file("${settingsDir.path}/chat/uikit")
-
-// 引入 AtomicX 基础 UI 组件库（必要）
 include(":atomic_x")
 project(":atomic_x").projectDir = file("${settingsDir.path}/atomic_x")
 
-// 引入音视频通话组件（可选，集成音视频通话时需要）
+include(":uikit")
+project(":uikit").projectDir = file("${settingsDir.path}/chat/uikit")
+
 include(":tuicallkit-kt")
 project(":tuicallkit-kt").projectDir = file("${settingsDir.path}/call/tuicallkit-kt")
 ```
@@ -70,29 +81,24 @@ project(":tuicallkit-kt").projectDir = file("${settingsDir.path}/call/tuicallkit
 ``` groovy
 // settings.gradle
 
-// 引入 Chat UIKit 组件库（必要）
-include ':uikit'
-project(':uikit').projectDir = new File(settingsDir, 'chat/uikit')
-
-// 引入 AtomicX 基础 UI 组件库（必要）
 include ':atomic_x'
 project(':atomic_x').projectDir = new File(settingsDir, 'atomic_x')
 
-// 引入音视频通话组件（可选，集成音视频通话时需要）
+include ':uikit'
+project(':uikit').projectDir = new File(settingsDir, 'chat/uikit')
+
 include ':tuicallkit-kt'
 project(':tuicallkit-kt').projectDir = new File(settingsDir, 'call/tuicallkit-kt')
 ```
 
-3. 在 app 模块的 `build.gradle.kts` 中添加依赖：
+2. 在 app 模块的 `build.gradle.kts` 中添加依赖：
 
 【Kotlin DSL】
 ``` kotlin
 // app/build.gradle.kts
 dependencies {
-    // TUIKit 组件库（必要）
-    implementation(project(":uikit"))
     implementation(project(":atomic_x"))
-    // 音视频通话（可选）
+    implementation(project(":uikit"))
     implementation(project(":tuicallkit-kt"))
 }
 ```
@@ -101,10 +107,8 @@ dependencies {
 ``` groovy
 // app/build.gradle
 dependencies {
-    // TUIKit 组件库（必要）
-    implementation project(':uikit')
     implementation project(':atomic_x')
-    // 音视频通话（可选）
+    implementation project(':uikit')
     implementation project(':tuicallkit-kt')
 }
 ```
@@ -123,6 +127,8 @@ dependencies {
 ``` java
 import io.trtc.tuikit.atomicxcore.api.CompletionHandler
 import io.trtc.tuikit.atomicxcore.api.login.LoginStore
+import com.tencent.cloud.tuikit.engine.call.TUICallEngine
+import com.tencent.cloud.tuikit.engine.common.TUICommonDefine
 
 LoginStore.shared.login(
     context,
@@ -131,7 +137,19 @@ LoginStore.shared.login(
     userSig,  // String，控制台或服务端生成
     object : CompletionHandler {
         override fun onSuccess() {
-            // 登录成功，可跳转会话列表或聊天页
+            // 登录成功
+            TUICallEngine.createInstance(context).init(
+                sdkAppID, userID, userSig,
+                object : TUICommonDefine.Callback {
+                    override fun onSuccess() {
+                        // 初始化成功，可使用音视频通话能力
+                    }
+
+                    override fun onError(errCode: Int, errMsg: String) {
+                        // 初始化失败
+                    }
+                }
+            )
         }
         override fun onFailure(code: Int, desc: String) {
             // 登录失败，可弹框报错
@@ -144,37 +162,7 @@ LoginStore.shared.login(
 > 在正式的生产环境中，建议在您的服务端生成 UserSig，在需要时由 App 向业务服务器发起请求获取动态 UserSig 进行鉴权。详见 [服务端生成 UserSig](https://cloud.tencent.com/document/product/269/32688)。
 >
 
-#### 步骤3：构建会话列表界面
-
-会话列表只需创建 `ConversationsPageView` 并加入到您的布局即可。它会自动从本地读取最近会话，点击某个会话时通过 `onConversationClick` 回调返回该会话的 `conversationID`，您可据此跳转聊天界面。
-``` kotlin
-import android.os.Bundle
-import androidx.appcompat.app.AppCompatActivity
-import io.trtc.tuikit.chat.uikit.pages.ConversationsPageView
-
-class ConversationActivity : AppCompatActivity() {
-    override fun onCreate(savedInstanceState: Bundle?) {
-        super.onCreate(savedInstanceState)
-
-        val conversationsPage = ConversationsPageView(this)
-        conversationsPage.setHeaderTitle("消息")
-
-        // 点击会话回调，conversationID 已带 c2c_ / group_ 前缀
-        conversationsPage.onConversationClick = { conversationID ->
-            // 跳转到您的聊天界面，并将 conversationID 传入（可参考步骤4 的 ChatActivity）
-        }
-        // 可选：搜索、发起单聊、创建群聊等入口回调
-        conversationsPage.onSearchClick = { /* 跳转搜索页 */ }
-        conversationsPage.onStartChatClick = { /* 发起单聊 */ }
-        conversationsPage.onCreateGroupClick = { /* 创建群聊 */ }
-
-        // 将会话列表设置为页面内容
-        setContentView(conversationsPage)
-    }
-}
-```
-
-#### 步骤4：构建聊天界面
+#### 步骤3：构建聊天界面
 
 聊天界面使用 `ChatPageView` 展示和收发消息，通过 `setup` 传入 `conversationID` 即可。`conversationID` 的格式为：单聊 `c2c_<对方 UserID>`，群聊 `group_<群 GroupID>`。
 ``` kotlin
@@ -187,8 +175,6 @@ import io.trtc.tuikit.chat.uikit.pages.ChatPageView
 class ChatActivity : AppCompatActivity() {
 
     override fun onCreate(savedInstanceState: Bundle?) {
-        // 必须设置 Material Components 主题，否则 ChatPageView 运行时会 Crash
-        setTheme(com.google.android.material.R.style.Theme_MaterialComponents_Light_NoActionBar)
         super.onCreate(savedInstanceState)
 
         // conversationID 格式：单聊 "c2c_<对方 UserID>"，群聊 "group_<群 GroupID>"
@@ -209,62 +195,18 @@ class ChatActivity : AppCompatActivity() {
 }
 ```
 
-> **注意：**
-> 承载聊天页的 Activity **必须**设置 Material Components 主题（如 `setTheme(com.google.android.material.R.style.Theme_MaterialComponents_Light_NoActionBar)`），否则 `ChatPageView` 内部使用的 Material 控件会因缺少对应主题属性，在运行时直接 Crash。
->
-
-> **说明：**示例工程（demo）中提供了基于 `ChatPageView` 封装好的聊天页 `ChatActivity`（带标题栏、未读角标、群事件处理等），可直接复用或参考其实现进行自定义：`ChatActivity.start(context, conversationID)`。
+> **说明：**
+> 示例工程（demo）中提供了基于 `ChatPageView` 封装好的聊天页 `ChatActivity`（带标题栏、未读角标、群事件处理等），可直接复用或参考其实现进行自定义：`ChatActivity.start(context, conversationID)`。
 >
 
-#### 步骤5：构建联系人界面
-
-联系人界面使用 `ContactsPageView` 展示好友列表、群组列表等，通过 `setup` 设置点击回调。点击联系人或群组时跳转对应聊天界面。
-``` kotlin
-import android.os.Bundle
-import androidx.appcompat.app.AppCompatActivity
-import io.trtc.tuikit.chat.uikit.pages.ContactsPageView
-
-class ContactActivity : AppCompatActivity() {
-    override fun onCreate(savedInstanceState: Bundle?) {
-        super.onCreate(savedInstanceState)
-
-        val contactsPage = ContactsPageView(this)
-        contactsPage.setHeaderTitle("通讯录")
-        contactsPage.setup(
-            onContactClick = { contactInfo ->
-                // 跳转到您的聊天界面，单聊会话 ID 为 "c2c_" + contactInfo.userID（可参考步骤4 的 ChatActivity）
-            },
-            onGroupClick = { contactInfo ->
-                // 跳转到您的聊天界面，群聊会话 ID 为 "group_" + contactInfo.userID（可参考步骤4 的 ChatActivity）
-            }
-        )
-        setContentView(contactsPage)
-    }
-}
-```
-
-#### 步骤6：主题设置（可选）
-
-TUIKit 通过 `ThemeStore` 支持设置主题色与浅色 / 深色主题切换。
-``` kotlin
-import io.trtc.tuikit.atomicx.theme.Theme
-import io.trtc.tuikit.atomicx.theme.ThemeStore
-
-// 设置主题色
-ThemeStore.shared(context).setPrimaryColor("#1C66E5")
-
-// 切换浅色 / 深色主题
-ThemeStore.shared(context).setTheme(Theme.lightTheme(context))
-// ThemeStore.shared(context).setTheme(Theme.darkTheme(context))
-```
+#### 步骤4：音视频通话
 
-#### 步骤7：音视频通话（可选）
-
-若需在聊天中支持音视频通话，请先 [开通音视频服务](https://console.cloud.tencent.com/im)，并在集成步骤中引入 `:tuicallkit-kt` 组件。**登录成功后**初始化 `TUICallEngine，`即可在 Chat 组件中正常使用该功能。
+**登录成功后**初始化 `TUICallEngine，`即可在 Chat 组件中正常使用该功能。如需开通音视频通话服务，
 ``` kotlin
 import com.tencent.cloud.tuikit.engine.call.TUICallEngine
 import com.tencent.cloud.tuikit.engine.common.TUICommonDefine
 
+// 在步骤 2 的 LoginStore 登录成功回调中初始化 TUICallEngine
 TUICallEngine.createInstance(context).init(
     sdkAppID, userID, userSig,
     object : TUICommonDefine.Callback {
@@ -279,11 +221,10 @@ TUICallEngine.createInstance(context).init(
 )
 ```
 
-#### 步骤8：接入智能客服 Desk 用户端（可选）
+#### 步骤5：接入智能客服 Desk 用户端
 
 若需同时集成智能客服 Desk 用户端，请先 [开通智能客服 Desk 服务](https://cloud.tencent.com/document/product/269/96059)，并根据 [Android 接入智能客服用户端](https://cloud.tencent.com/document/product/269/110809) 文档完成 `com.tencentcloud.desk:aideskcustomer` 包引入和配置，即可在您的应用中引入客服会话能力。
 ``` java
-
 int SDKAppID = 0; // 开通了智能客服 Desk 的应用 ID
 String userID = "";
 String userSig = "";
@@ -311,6 +252,10 @@ TencentAiDeskCustomer.getInstance().initWithProfile(context, SDKAppID, userID, u
 });
 ```
 
+## AI 助手：知识咨询与代码集成
+
+在接入 IM SDK 过程中，您可以通过 MCP 使用 AI 助手，快速完成知识咨询、报错排查和 UIKit 集成代码生成。支持 Web/Android/iOS/Flutter/uni-app 等平台，答案基于官方文档。适用于查询 SDK API、UI 组件用法、服务端 API 与 IM 产品配置等场景，[立即体验，提出您的第一个问题](https://cloud.tencent.com/document/product/269/126983)。
+
 ## 常见问题
 
 ### 音视频常见问题
@@ -324,6 +269,21 @@ TencentAiDeskCustomer.getInstance().initWithProfile(context, SDKAppID, userID, u
 
 - 如果是群聊通话邀请，被邀请者离线再上线后会自动拉取最近 30 秒内的邀请，TUIKit 会自动唤起群通话界面。
 
+##### **如何移除音视频通话功能？**
+
+如果您不需要集成音视频通话功能，请在 `settings.gradle.kts`(或 `settings.gradle`) 和 `app` 模块的 `build.gradle.kts`(或 `build.gradle`) 文件中移除 `tuicallkit-kt` 依赖，并在步骤 3 创建聊天界面中关闭音视频通话开关，代码如下所示：
+``` java
+val messageInputConfig = ChatMessageInputConfig(
+    isShowAudioCall = false,  // 关闭语音通话
+    isShowVideoCall = false   // 关闭视频通话
+)
+val chatPageView = ChatPageView(this)
+chatPageView.setup(
+    conversationID = conversationID,
+    messageInputConfig = messageInputConfig
+）
+```
+
 ### 其他常见问题
 
 ##### 表情包的使用

package/resource/knowledge/chat/preset/ios/features/language.md

@@ -26,7 +26,7 @@ iOS 端 `TUIKit`默认自带 **简体中文、英语** 和 **阿拉伯语** 语
 
 > **说明**
 >
->  语言代码清单见 附录。
+>  语言代码清单见 [附录](#code)。
 >
 
 ## 使用更多语言/自定义翻译表述
@@ -37,7 +37,7 @@ iOS 端 `TUIKit`默认自带 **简体中文、英语** 和 **阿拉伯语** 语
 
 我们自带的所有语言包，以String文件模板的形式，存储于您项目里Pods中`TUICore`组件的`TUIKitLocalizable/Localizable/` 路径。
 
-请新建目录并命名为`{语言编码}.lproj`，在此目录下新增 `Localizable.strings`文件，其中，`${语言编码}` 需要替换为 ISO 639-1 语言代码。（可以直接复制您熟悉的语言文件，如zh-Hans.lproj，并直接修改目录名称）
+请新建目录并命名为`{语言编码}.lproj`，在此目录下新增 `Localizable.strings`文件，其中，`${语言编码}` 需要替换为 [ISO 639-1 语言代码](#code)。（可以直接复制您熟悉的语言文件，如zh-Hans.lproj，并直接修改目录名称）
 如果您需要兼容支持多个新语言，复制多份，并准确指定每一份的语言编码即可。
 
 以韩语为例，新增`ko.lproj/Localizable.strings`的语言资源文件：
@@ -52,17 +52,17 @@ iOS 端 `TUIKit`默认自带 **简体中文、英语** 和 **阿拉伯语** 语
 
 如果是其他语种，则需要在 `TUIGlobalization.m`中的`+ (NSString *)tk_localizableLanguageKey`
 
-新增的语言词条包命名需要 符合标准，组件内部会跟随系统语言自适应。
+新增的语言词条包命名需要 [符合标准](#code)，组件内部会跟随系统语言自适应。
 
 > **说明**
 >
->  语言代码清单见 ISO 639-1 语言代码。
+>  语言代码清单见 [ISO 639-1 语言代码](#code)。
 >
 
 ### 指定显示的语言
 
 如果您需要指定`TUIKit`界面语言，请在`[TUIGlobalization setPreferredLanguage:@""]`中传入需要的语言，指定语言后，组件内部不再跟随系统语言。
-语言可选项，取值为 ISO 639-1 语言代码
+语言可选项，取值为 [ISO 639-1 语言代码](#code)
 以韩语为例，传入`[TUIGlobalization setPreferredLanguage:@"ko"];`
 
 ## 附录：语言代码表