@tencentcloud/sdk-mcp 1.3.4 → 1.3.5

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@tencentcloud/sdk-mcp",
-  "version": "1.3.4",
+  "version": "1.3.5",
   "description": "Tencent Cloud MCP Server for SDK",
   "type": "module",
   "main": "index.js",

package/resource/doc/chatuikit/android/features/theme.md

@@ -0,0 +1,363 @@
+TUIKit Compose 提供了强大的外观定制能力，支持自定义应用的主题模式（浅色/深色/跟随系统）和主题色。通过简单的配置，开发者可以轻松实现应用级别的主题切换和品牌色定制。
+
+以消息列表为例，自定义主题模式和主题色的效果如下图所示：
+<table>
+<tr>
+<td rowspan="1" colSpan="1" >**浅色 + 默认颜色**</td>
+
+<td rowspan="1" colSpan="1" >**浅色 + 橘黄色**</td>
+
+<td rowspan="1" colSpan="1" >**深色 + 默认颜色**</td>
+
+<td rowspan="1" colSpan="1" >**深色 + 绿色主题**</td>
+</tr>
+
+<tr>
+<td rowspan="1" colSpan="1" ><br>![](https://write-document-release-1258344699.cos.ap-guangzhou.tencentcos.cn/100027983637/1dcc10b9bee511f08863525400e889b2.png)</td>
+
+<td rowspan="1" colSpan="1" ><br>![](https://write-document-release-1258344699.cos.ap-guangzhou.tencentcos.cn/100027983637/34013fd4bee511f0a808525400bf7822.png)</td>
+
+<td rowspan="1" colSpan="1" ><br>![](https://write-document-release-1258344699.cos.ap-guangzhou.tencentcos.cn/100027983637/4d036798bee511f0b4c35254001c06ec.png)</td>
+
+<td rowspan="1" colSpan="1" ><br>![](https://write-document-release-1258344699.cos.ap-guangzhou.tencentcos.cn/100027983637/61fff637bee511f08863525400e889b2.png)</td>
+</tr>
+</table>
+
+
+## 核心能力
+
+**模式切换**
+- 浅色模式（Light）：适合日间使用的明亮界面。
+
+- 深色模式（Dark）：适合夜间使用的暗色界面。
+
+- 跟随系统（System）：自动跟随系统外观设置。
+
+
+   **主题色定制**
+
+- 预设主题色：提供蓝、绿、红、橙等标准色。
+
+- 自定义主题色：支持任意 Hex 格式颜色。
+
+- 智能色板生成：自动生成 10 个色阶的完整色板。
+
+- 清除自定义：一键恢复默认主题色。
+
+
+## API 说明
+
+以上功能基于 `ThemeState` 提供的一组简洁的 API，用于主题配置和信息查询。
+
+### 设置主题模式
+<table>
+<tr>
+<td rowspan="1" colSpan="1" >方法</td>
+
+<td rowspan="1" colSpan="1" >参数</td>
+
+<td rowspan="1" colSpan="1" >返回值</td>
+
+<td rowspan="1" colSpan="1" >说明</td>
+</tr>
+
+<tr>
+<td rowspan="1" colSpan="1" >`setThemeMode`</td>
+
+<td rowspan="1" colSpan="1" >`ThemeMode`</td>
+
+<td rowspan="1" colSpan="1" >`Unit`</td>
+
+<td rowspan="1" colSpan="1" >设置显示模式，自动保存并刷新。<br>• `ThemeMode.SYSTEM`：跟随系统外观。<br>• `ThemeMode.LIGHT`：强制使用浅色模式。<br>• `ThemeMode.DARK`：强制使用深色模式。</td>
+</tr>
+</table>
+
+
+### 设置主题色
+<table>
+<tr>
+<td rowspan="1" colSpan="1" >方法</td>
+
+<td rowspan="1" colSpan="1" >参数</td>
+
+<td rowspan="1" colSpan="1" >返回值</td>
+
+<td rowspan="1" colSpan="1" >说明</td>
+</tr>
+
+<tr>
+<td rowspan="1" colSpan="1" >`setPrimaryColor`</td>
+
+<td rowspan="1" colSpan="1" >`String`</td>
+
+<td rowspan="1" colSpan="1" >`Unit`</td>
+
+<td rowspan="1" colSpan="1" >设置主题色，需要 Hex 格式（例如 "#1C66E5"）。</td>
+</tr>
+
+<tr>
+<td rowspan="1" colSpan="1" >`clearPrimaryColor`</td>
+
+<td rowspan="1" colSpan="1" >无</td>
+
+<td rowspan="1" colSpan="1" >`Unit`</td>
+
+<td rowspan="1" colSpan="1" >清除自定义主题色，恢复默认蓝色。</td>
+</tr>
+</table>
+
+
+> **说明：**
+> 
+> - 调用 `setThemeMode` 或 `setPrimaryColor` 后，配置会自动保存到持久化存储，无需手动保存。下次启动应用时会自动加载。
+> - 修改主题配置时会自动清除缓存，确保色彩方案实时更新。开发者无需关心缓存管理。
+> - 使用设置 API 时需避免频繁切换主题（例如在循环中调用）。
+
+
+### 查询 ThemeState 信息
+
+通过以下只读属性可以查询当前的主题配置状态和信息：
+<table>
+<tr>
+<td rowspan="1" colSpan="1" >属性</td>
+
+<td rowspan="1" colSpan="1" >类型</td>
+
+<td rowspan="1" colSpan="1" >说明</td>
+</tr>
+
+<tr>
+<td rowspan="1" colSpan="1" >`currentMode`</td>
+
+<td rowspan="1" colSpan="1" >`ThemeMode`</td>
+
+<td rowspan="1" colSpan="1" >当前主题模式。</td>
+</tr>
+
+<tr>
+<td rowspan="1" colSpan="1" >`currentPrimaryColor`</td>
+
+<td rowspan="1" colSpan="1" >`String?`</td>
+
+<td rowspan="1" colSpan="1" >当前主题色（Hex 格式）。</td>
+</tr>
+
+<tr>
+<td rowspan="1" colSpan="1" >`hasCustomPrimaryColor`</td>
+
+<td rowspan="1" colSpan="1" >`Boolean`</td>
+
+<td rowspan="1" colSpan="1" >是否设置了自定义主题色。</td>
+</tr>
+
+<tr>
+<td rowspan="1" colSpan="1" >`isDarkMode`</td>
+
+<td rowspan="1" colSpan="1" >`Boolean`</td>
+
+<td rowspan="1" colSpan="1" >当前是否为深色模式。</td>
+</tr>
+</table>
+
+
+## 使用方式
+
+本章节介绍如何在您的应用中集成和使用主题、主题色定制功能，按照从简单到复杂的顺序提供三种方式。
+
+### 方式一：使用 AppBuilder 配置（推荐）
+
+AppBuilder是一个便捷式功能及 UI 自定义配置工具，通过 JSON 配置文件统一管理，适用于 Web + Native 双端应用需要保持统一外观的场景。
+
+您可以在 [Chat Web 体验馆](https://trtc.io/demo/homepage/#/detail?scene=messenger) 体验 AppBuilder 功能，体验入口：
+
+![](https://write-document-release-1258344699.cos.ap-guangzhou.tencentcos.cn/100027983637/321d5873b88211f09a6b525400454e06.png)
+
+
+虽然 Chat Web 体验馆上暂时无法实时观看移动端的配置效果，但移动端已经预先支持了 AppBuilder 的配置能力。
+
+接下来为您介绍在 Web 体验馆设置 AppBuilder 后，如何在移动端项目中应用该自定义配置。操作步骤比较简单，只有 2 步：
+1. 下载配置文件。
+
+2. 将配置文件 appConfig.json 拖入您的 Android 项目中。
+
+
+####  1. 下载配置文件
+
+访问 [Chat Web 体验馆](https://trtc.io/demo/homepage/#/detail?scene=messenger)，下载配置文件 appConfig.json。下载路径为：
+
+![](https://write-document-release-1258344699.cos.ap-guangzhou.tencentcos.cn/100027983637/3205aa68b88211f0a808525400bf7822.png)
+
+
+`appConfig.json`文件内容如下所示，与 AppBuilder 页面的配置项一一对应，与定义外观相关的配置是 `theme`及其子字段：
+``` json
+{
+  "theme": {
+    "mode": "light", // 主题模式，light-浅色模式，dark-深色模式，system-自动跟随系统
+    "primaryColor": "#E65100" // 主色调，16 进制颜色值
+  },
+  "messageList": {
+    "alignment": "two-sided",
+    "enableReadReceipt": false,
+    "messageActionList": [
+        "copy",
+        "recall",
+        "quote",
+        "forward",
+        "delete"
+    ]
+  },
+  "conversationList": {
+    "enableCreateConversation": true,
+    "conversationActionList": [
+      "delete",
+      "mute",
+      "pin",
+      "markUnread"
+    ]
+  },
+  "messageInput": {
+    "hideSendButton": false,
+    "attachmentPickerMode": "collapsed"
+  },
+  "search": {
+    "hideSearch": false
+  },
+  "avatar": {
+    "shape": "circular"
+  }
+}
+```
+
+**配置选项说明**
+<table>
+<tr>
+<td rowspan="1" colSpan="1" >参数说明</td>
+
+<td rowspan="1" colSpan="1" >类型</td>
+
+<td rowspan="1" colSpan="1" >可选值</td>
+
+<td rowspan="1" colSpan="1" >说明</td>
+</tr>
+
+<tr>
+<td rowspan="1" colSpan="1" >`mode`</td>
+
+<td rowspan="1" colSpan="1" >String</td>
+
+<td rowspan="1" colSpan="1" >`"system"`、`"light"`、`"dark"`</td>
+
+<td rowspan="1" colSpan="1" >主题模式</td>
+</tr>
+
+<tr>
+<td rowspan="1" colSpan="1" >`primaryColor`</td>
+
+<td rowspan="1" colSpan="1" >String</td>
+
+<td rowspan="1" colSpan="1" >Hex 颜色值，例如 `"#0ABF77"`</td>
+
+<td rowspan="1" colSpan="1" >主题色</td>
+</tr>
+</table>
+
+
+#### 2. 将配置文件拖入项目中
+
+将 appConfig.json 拖入您的项目中。以 Github 开源 Demo [TUIKit Android Compose](https://github.com/Tencent-RTC/TUIKit_Android_Compose/blob/main/chat/demo/app/src/main/assets/appConfig.json) 项目为例，appConfig.json 位于 demo/app 的 assets 文件夹下：
+
+![](https://write-document-release-1258344699.cos.ap-guangzhou.tencentcos.cn/100027983637/ce0dba6fb88a11f0a808525400bf7822.png)
+
+
+至此，无需编写额外代码，启动 App 后，TUIKit Compose 组件的模式和主题色会自动显示成您在 appConfig.json 中设置的值。
+
+### 方式二：代码设置主题模式
+
+您可以通过 API `setThemeMode` 直接设置主题模式。示例代码如下所示：
+``` swift
+val themeState = ThemeState.shared
+Column {
+    Button(onClick = {
+        themeState.setThemeMode(ThemeMode.SYSTEM)
+    }) { Text(text = "跟随系统") }
+    Button(onClick = {
+        themeState.setThemeMode(ThemeMode.LIGHT)
+    }) { Text(text = "浅色模式") }
+    Button(onClick = {
+        themeState.setThemeMode(ThemeMode.DARK)
+    }) { Text(text = "深色模式") }
+}
+```
+
+### 方式三：代码设置主题色
+
+您可以通过 API `setPrimaryColor` 设置主题色，只需要传入一个主颜色值，整个 TUIKit Compose 组件会自动根据该主颜色值，为不同的组件适配出一组相同色系里的相似色值渲染界面，您无需再手动适配界面 UI。示例代码如下所示：
+``` swift
+Column {
+    var text: String by remember { mutableStateOf("#1C66E5") }
+
+    fun isValidHexColor(): Boolean {
+        return text.matches(Regex("^#[0-9A-Fa-f]{6}$"))
+    }
+    BasicTextField(
+        value = text,
+        onValueChange = { text = it },
+        modifier = Modifier
+            .fillMaxWidth()
+            .padding(16.dp)
+    )
+    Button(
+        enabled = isValidHexColor(),
+        onClick = {
+            themeState.setPrimaryColor(text)
+        }) {
+        Text("应用主题色")
+    }
+}
+```
+
+> **使用建议：**
+> 
+> - 对于大多数应用，推荐使用 JSON 配置文件的方式，简单可靠且支持多端统一。
+> - 在整个应用中统一使用 `themeState.colors` 中的颜色，确保主题切换时界面保持一致。
+
+
+## 常见问题
+
+### **如何判断当前是否为深色模式？**
+``` java
+if themeState.isDarkMode {
+    // 当前是深色模式
+} else {
+    // 当前是浅色模式
+}
+```
+
+### **可以设置透明度吗？**
+
+不支持。主题色只支持 6 位 Hex 格式（RGB），不支持 8 位格式（RGBA）。
+
+### **如何恢复默认主题？**
+``` swift
+themeState.clearPrimaryColor()  // 清除自定义主题色
+themeState.setThemeMode(ThemeMode.SYSTEM)  // 恢复跟随系统
+```
+
+### **主题配置存储在哪里？**
+
+存储在应用的持久化存储中。应用卸载后会丢失，重新安装后恢复默认配置。
+
+### **如何获取当前主题的完整配置？**
+``` swift
+val config = themeState.currentTheme
+print("模式: ${config.mode}")
+print("主题色: ${config.primaryColor ?: "默认"}")
+```
+
+### **可以同时设置模式和主题色吗？**
+
+可以分别调用两个方法，系统会自动合并配置：
+``` swift
+themeState.setThemeMode(ThemeMode.DARK)
+themeState.setPrimaryColor("#0ABF77")
+```

package/resource/doc/chatuikit/{android/client_api_android.md → faq/android_sdk/client-api.md}

@@ -1374,4 +1374,3 @@
 </tr>
 </table>
 
-

package/resource/doc/chatuikit/faq/{native_sdk/faq.md → common/product.md}

@@ -1,3 +1,11 @@
+---
+product: 'Chat'
+tech_stack: 'prouduct'
+framework: 'common'
+title: '产品策略相关的通用知识库'
+keywords: ['购买计费', '消息/群组相关', '推送相关', '智能客服']
+---
+
 ## 购买计费相关
 - [即时通信 IM 如何计费？](https://cloud.tencent.com/document/product/269/11673)
 

package/resource/doc/chatuikit/faq/flutter_sdk/faq.md

@@ -0,0 +1,54 @@
+---
+product: 'Chat'
+tech_stack: 'flutter_sdk'
+framework: 'sdk'
+title: 'flutter sdk 常见问题'
+keywords: ['sdk 集成', '登录 API', '创建群组','发送消息','接收消息']
+---
+
+# Flutter SDK 常见问题
+
+## Flutter SDK 常见问题解决方案 (Topic: SDK FAQ)
+
+### Q: SDK 怎么实现消息回应？
+**A：** SDK 支持消息回应能力，您需要购买旗舰版或企业版套餐，具体 API 有3个：
+- 添加消息回应 [addMessageReaction](https://pub.dev/documentation/tencent_cloud_chat_sdk/latest/manager_v2_tim_message_manager/V2TIMMessageManager/addMessageReaction.html) 
+- 获取消息回应 [getMessageReactions](https://pub.dev/documentation/tencent_cloud_chat_sdk/latest/manager_v2_tim_message_manager/V2TIMMessageManager/getMessageReactions.html)
+- 删除消息回应 [removeMessageReaction](https://pub.dev/documentation/tencent_cloud_chat_sdk/latest/manager_v2_tim_message_manager/V2TIMMessageManager/removeMessageReaction.html)
+
+### Q: 单聊消息怎么标记已读？
+**A：** 如果您需要标记单聊消息已读同时清空会话未读数，可以使用 [markC2CMessageAsRead](https://pub.dev/documentation/tencent_cloud_chat_sdk/latest/manager_v2_tim_message_manager/V2TIMMessageManager/markC2CMessageAsRead.html)。
+
+### Q: 群聊消息怎么清空未读数？
+**A：** 如果您需要清空群聊会话未读数，可以使用 [markGroupMessageAsRead](https://pub.dev/documentation/tencent_cloud_chat_sdk/latest/manager_v2_tim_message_manager/V2TIMMessageManager/markGroupMessageAsRead.html)。
+
+### Q: 单聊和群聊消息怎么实现单条消息已读？
+**A：** 如果您需要实现单条消息已读功能，需要使用消息已读回执能力。 如何开启已读回执、如何发送已读回执等详细信息可以参考：https://cloud.tencent.com/document/product/269/75345。
+
+### Q: SDK 怎么发送图片消息？
+**A：** 可以使用 [createImageMessage](https://pub.dev/documentation/tencent_cloud_chat_sdk/latest/manager_v2_tim_message_manager/V2TIMMessageManager/createImageMessage.html) 创建图片消息实例，然后使用 [sendMessage](https://pub.dev/documentation/tencent_cloud_chat_sdk/latest/manager_v2_tim_message_manager/V2TIMMessageManager/sendMessage.html) 发送图片消息。
+
+### Q: SDK 怎么发送视频消息？
+**A：** 可以使用 [createVideoMessage](https://pub.dev/documentation/tencent_cloud_chat_sdk/latest/manager_v2_tim_message_manager/V2TIMMessageManager/createVideoMessage.html) 创建视频消息实例，然后使用 [sendMessage](https://pub.dev/documentation/tencent_cloud_chat_sdk/latest/manager_v2_tim_message_manager/V2TIMMessageManager/sendMessage.html) 发送视频消息。
+
+### Q: SDK 怎么发送语音消息？
+**A：** 可以使用 [createSoundMessage](https://pub.dev/documentation/tencent_cloud_chat_sdk/latest/manager_v2_tim_message_manager/V2TIMMessageManager/createSoundMessage.html) 创建语音消息实例，然后使用 [sendMessage](https://pub.dev/documentation/tencent_cloud_chat_sdk/latest/manager_v2_tim_message_manager/V2TIMMessageManager/sendMessage.html) 发送语音消息。
+
+### Q: SDK 怎么发送文件消息？
+**A：** 可以使用 [createFileMessage](https://pub.dev/documentation/tencent_cloud_chat_sdk/latest/manager_v2_tim_message_manager/V2TIMMessageManager/createFileMessage.html) 创建文件消息实例，然后使用 [sendMessage](https://pub.dev/documentation/tencent_cloud_chat_sdk/latest/manager_v2_tim_message_manager/V2TIMMessageManager/sendMessage.html) 发送文件消息。
+
+### Q: SDK 如何删除会话？
+**A：** 删除会话仅支持单向删除，SDK 删除会话 API `deleteConversation`，参考文档：https://cloud.tencent.com/document/product/269/75380
+
+### Q: SDK 如何删除会话历史消息？
+**A：** SDK 清空消息分为两种：清空单聊消息、清空群聊消息。清空消息会同时清空当前会话内所有的消息，包含本地和云端消息，但不会删除会话本身，且清空的是单向的，不会把对方会话中的消息也情况。
+- 清空单聊消息 [clearC2CHistoryMessage](https://cloud.tencent.com/document/product/269/75336)
+- 清空群聊消息 [clearGroupHistoryMessage](https://cloud.tencent.com/document/product/269/75336)
+
+### Q: SDK 怎么获取用户在线状态功能？
+**A：** 
+1. SDK 提供了**用户状态查询、订阅、取消订阅 API 和状态变更事件通知**，详情可参考：https://cloud.tencent.com/document/product/269/105469
+2. 服务端**在线状态变更回调**可参考：https://cloud.tencent.com/document/product/269/2570
+
+### Q: SDK 怎么获取好友列表？
+**A：** SDK 支持好友的管理，用户可以主动添加、删除好友，也可以设置仅针对好友才能发送消息。详情可参考：https://cloud.tencent.com/document/product/269/75421

package/resource/doc/chatuikit/faq/web_sdk/faq.md

@@ -117,7 +117,7 @@ promise.then(function(imResponse) {
 ### Q: Taro 开发的微信小程序如何集成 Chat SDK？
 **A：** Chat SDK v4 `@tencentcloud/lite-chat` 同时支持在 web 浏览器和微信小程序环境运行，Taro 开发的微信小程序需要实现聊天功能可直接集成 `@tencentcloud/lite-chat`, 详情可参考：https://cloud.tencent.com/document/product/269/117335。
 
-### Q: CHat 怎么实现用户在线状态功能？
+### Q: Chat 怎么实现用户在线状态功能？
 **A：** 
 1. Chat SDK 提供了**用户状态查询、订阅、取消订阅 API 和状态变更事件通知**，详情可参考：https://cloud.tencent.com/document/product/269/78125。
 2. 服务端**在线状态变更回调**可参考：https://cloud.tencent.com/document/product/269/2570。