@tencentcloud/sdk-mcp 1.2.8 → 1.3.0

package/package.json

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

package/resource/doc/chatuikit/faq/common/server.md

@@ -0,0 +1,54 @@
+---
+product: 'Chat'
+tech_stack: 'server'
+framework: 'common'
+title: '通用问题知识库'
+keywords: ['控制台', '服务端生成 usersig', 'restapi', '前回调', '后回调', 'nodejs/go/java/python 等服务端语言生成 userSig 示例代码 ']
+---
+
+# 通用问题知识库
+
+## userSig 解决方案
+
+### Q: 服务端如何生成 userSig ?
+**A：** 服务端生成 userSig 的具体方式可参考： https://cloud.tencent.com/document/product/269/32688， 文档中提供了多种服务端语言的解决方案。
+
+### Q: Chat 消息发送前回调和发送后回调的消息格式区别，如何区分系统消息和用户消息?
+**A：** 
+1. 群消息发言前回调内容没有 MsgSeq、MsgTime 等信息，具体的可以参考以下文档：
+- 单聊发言前回调：https://cloud.tencent.com/document/product/269/1632
+- 单聊发言后回调：https://cloud.tencent.com/document/product/269/2716
+- 群内发言前回调：https://cloud.tencent.com/document/product/269/1619
+- 群内发言后回调：https://cloud.tencent.com/document/product/269/2661
+2. 普通消息格式： https://cloud.tencent.com/document/product/269/2720
+
+### Q: 群消息优先级和群消息频控是怎样的？
+**A：** 群消息分为 3 个优先级（`High`,`Normal`,`Low`），如果某个群的消息超过了频率限制，后台会优先下发高优先级的消息。因此用户应根据消息的重要程度，来选择合适的优先级。总消息数频控是指单个群所有端接口累计每秒最多能发送的消息数限制，默认值为 40条/秒，采用每秒平均限频。消息数量超过限制后，后台优先下发优先级相对较高的消息，同等优先级的消息随机排序。详细内容可以参考文档：https://cloud.tencent.com/document/product/269/3663
+
+### Q: 有腾讯云图片消息内容安全审核的的最佳实践和使用方案吗？
+**A：** 云端审核功能，是一款在云端（服务端）进行内容智能识别和拦截的服务：
+- 支持对文本、图片内容同步审核，对音频、视频内容异步审核。
+- 支持分别针对单聊、群聊、资料三大 IM 场景中产生的不同类型 UGC 内容进行策略配置。
+- 支持配置特定终端用户产生/接收的消息不送审，支持对返回审核结果进行配置。
+- 支持自助创建自定义审核场景，对非 IM 场景的 UGC 内容或者终端消息有更灵活的送审选择。
+- 支持查看审核用量抵扣明细、审核结果明细，提供审核条数统计、审核类型统计、审核用户统计、违规用户排行等可视化数据。
+参考文档：https://cloud.tencent.com/document/product/269/79139
+
+### Q: 如何拦截用户发送的消息？
+**A：** 业务服务端可以通过消息前回调进行拦截，具体文档可参考：
+- 单聊发言前回调：https://cloud.tencent.com/document/product/269/1632
+- 群内发言前回调：https://cloud.tencent.com/document/product/269/1619
+
+### Q: 如何删除和管理账号？
+**A：** restapi 可以对账号进行删除、导入、查询，具体文档可参考：
+- 删除账号：https://cloud.tencent.com/document/product/269/36443
+- 导入单个账号：https://cloud.tencent.com/document/product/269/1608
+- 导入多个账号：https://cloud.tencent.com/document/product/269/4919
+- 查询账号：https://cloud.tencent.com/document/product/269/38417
+
+### Q: 账号数量超过限制如何处理？
+**A：** 导入账号时，如果账号数超限，如需创建多于100个账号，需要将应用升级为专业版，具体操作指引请参见：https://cloud.tencent.com/document/product/269/32458。
+
+### Q: 服务端如何删除会话？
+**A：** 服务端删除会话可以使用 restapi, 具体文档可参考：https://cloud.tencent.com/document/product/269/62119。
+

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

@@ -113,3 +113,63 @@ promise.then(function(imResponse) {
 
 ### Q: Web SDK 怎么发送文件消息？
 **A：** 可以使用 [createFileMessage](https://cloud.tencent.com/document/product/269/75316#.E5.88.9B.E5.BB.BA.E6.96.87.E4.BB.B6.E6.B6.88.E6.81.AF) 创建文件消息实例，然后使用 [sendMessage](https://cloud.tencent.com/document/product/269/75316#.E5.8F.91.E9.80.81.E6.B6.88.E6.81.AF) 发送文件消息。
+
+### 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 怎么实现用户在线状态功能？
+**A：** 
+1. Chat SDK 提供了**用户状态查询、订阅、取消订阅 API 和状态变更事件通知**，详情可参考：https://cloud.tencent.com/document/product/269/78125。
+2. 服务端**在线状态变更回调**可参考：https://cloud.tencent.com/document/product/269/2570。
+
+### Q: Chat SDK 无 UI 如何实现消息列表功能？
+**A：** 无 UI 实现消息列表功能，需要结合 SDK `sendMessage`、`getMessageList` API 和 `MESSAGE_RECEIVED` 事件实现。
+
+### Q: Chat SDK 无 UI 如何实现 @ 全部和 @某人 的功能？
+**A：** SDK 提供了实现 @消息的 API `createTextAtMessage` ,详情可参考：https://cloud.tencent.com/document/product/269/112909。
+
+### Q: Chat SDK 如何实现搜索功能？
+**A：** SDK 提供了**云端搜索**能力，支持搜索消息、搜索用户、搜索群组、搜索群成员，API 详情可参考以下链接：
+- 搜索消息：https://cloud.tencent.com/document/product/269/114754
+- 搜索用户：https://cloud.tencent.com/document/product/269/114757
+- 搜索群组：https://cloud.tencent.com/document/product/269/114760
+- 搜索群成员：https://cloud.tencent.com/document/product/269/114763
+
+### Q: Chat SDK 如何创建群组、添加群成员、设置管理员？
+**A：** SDK 创建群组、添加群成员、设置管理员的具体信息可参考下面的文档内容：
+- 创建群组：https://cloud.tencent.com/document/product/269/75395#.E5.88.9B.E5.BB.BA.E7.BE.A4.E7.BB.84
+- 添加群成员：https://web.sdk.qcloud.com/im/doc/v3/zh-cn/SDK.html#addGroupMember
+- 修改群成员角色（可设置管理员）：https://cloud.tencent.com/document/product/269/75401#.E4.BF.AE.E6.94.B9.E7.BE.A4.E6.88.90.E5.91.98.E8.A7.92.E8.89.B2
+
+### Q: 如何创建一个 C2C 单聊会话？
+**A：** UI 层可以通过查询会话资料 `getConversationProfile` 创建一个单聊会话，`conversationID` 的规则：`C2C${userID}`,SDK 创建会话成功后会通过 `CONVERSATION_LIST_UPDATE` 事件通知会话列表更新。
+
+### Q: 如何获取消息未读总数和实时监听未读总数的变化？
+**A：** 消息未读总数的详细内容可参考文档：https://cloud.tencent.com/document/product/269/75373。
+1. 获取未读消息总数可以调用 `getTotalUnreadMessageCount` API。
+2. 未读总数变更可以监听 `TOTAL_UNREAD_MESSAGE_COUNT_UPDATED` 事件。
+注意：初始化时建议直接监听 `TOTAL_UNREAD_MESSAGE_COUNT_UPDATED` 事件获取未读消息总数，因为未读总数的计算依赖云端会话列表的同步，登录成功直接调用 `getTotalUnreadMessageCount`可能会因为云端会话列表还没同步完成，导致获取到的未读数为 0。
+
+### Q: SDK 图片消息如何获取原图和缩略图？
+**A：** 图片消息高清原图(type = 0)、缩略图(type = 1)、大图(type = 2)，获取方式可参考 Message 结构体说明：https://web.sdk.qcloud.com/im/doc/v3/zh-cn/Message.html#.ImagePayload。
+
+### Q: SDK 如何处理消息发送失败？
+**A：** SDK 消息发送失败时，`sendMessage` 接口会抛出 error，需要通过 `sendMessage().catch()` 捕获异常，error 中包含完整的 message 结构体， 其中 message.status 为 `fail`。可以通 `resendMessage` 重发失败的消息。
+
+### Q: 弱网环境下，SDK 如何保证 websocket 的稳定性以及如何重连的？
+**A：** 弱网环境下如果 ws 断开， SDK 会自动重连。ws 的状态变更可以通过监听 `NET_STATE_CHANGE` 事件（https://web.sdk.qcloud.com/im/doc/v3/zh-cn/module-EVENT.html#.NET_STATE_CHANGE）。
+
+### Q: SDK 如何删除会话？
+**A：** 删除会话仅支持单向删除，SDK 删除会话 API `deleteConversation`，参考文档：https://cloud.tencent.com/document/product/269/75379
+
+### Q: SDK 如何获取好友列表？
+**A：** 获取好友列表 API `getFriendList`，好友列表更新可监听 `FRIEND_LIST_UPDATED` 事件，参考文档：https://cloud.tencent.com/document/product/269/75420。
+
+### Q: SDK 如何监听好友在线状态更新？
+**A：** 好友在线状态变更可以通过以下两种方式实现：
+1. 如果您在 即时通信 IM 控制台 开启了好友状态自动通知，那么当好友的状态发生变更时，SDK 会派发 `USER_STATUS_UPDATED` 事件，您可以在其中获取到好友的最新状态。
+2. 如果您没有开启好友状态自动通知，并且仍然想感知好友的状态变更，您需要调用 `subscribeUserStatus` 主动订阅好友的状态。当好友的状态发生变更时，SDK 会派发 `USER_STATUS_UPDATED` 回调。
+具体的文档可参考：https://cloud.tencent.com/document/product/269/78125
+
+### Q: SDK 如何删除会话历史消息？
+**A：** SDK 提供了 `clearHistoryMessage` API 用来情况会话历史消息，具体文档可参考：https://cloud.tencent.com/document/product/269/84438。

package/resource/doc/livekit/vue/components/co-guest-panel.md

@@ -1,4 +1,4 @@
-本文对 TUILiveKit 组件中的**连麦管理面板（CoGuestPanel）**进行了详细的介绍，您可以在已有项目中直接参考本文示例集成我们开发好的组件，也可以根据您的需求按照文档中的组件定制化部分对样式和布局进行深度的定制。
+本文对**连麦管理面板（CoGuestPanel）**进行了详细的介绍，您可以在已有项目中直接参考本文示例集成我们开发好的组件，也可以根据您的需求按照文档中的组件定制化部分对样式和布局进行深度的定制。
 
 ![](https://write-document-release-1258344699.cos.ap-guangzhou.tencentcos.cn/100027862798/af6ace34975411f093df52540099c741.png)
 
@@ -35,7 +35,7 @@
 
 ### 步骤1：环境配置及开通服务
 
-在进行快速接入之前，您需要参考[准备工作](https://write.woa.com/document/185222107981008896)，满足相关环境配置及开通对应服务。
+在进行快速接入之前，您需要参考 [准备工作](https://write.woa.com/document/188228825253294080)，满足相关环境配置及开通对应服务。
 
 ### 步骤2：安装依赖
 
@@ -44,19 +44,19 @@
 
 【npm】
 ``` bash
-npm install tuikit-atomicx-vue3@latest @tencentcloud/uikit-base-component-vue3 --save
+npm install tuikit-atomicx-vue3 @tencentcloud/uikit-base-component-vue3 --save
 ```
 
 
 【pnpm】
 ``` bash
-pnpm add tuikit-atomicx-vue3@latest @tencentcloud/uikit-base-component-vue3
+pnpm add tuikit-atomicx-vue3 @tencentcloud/uikit-base-component-vue3
 ```
 
 
 【yarn】
 ``` bash
-yarn add tuikit-atomicx-vue3@latest @tencentcloud/uikit-base-component-vue3
+yarn add tuikit-atomicx-vue3 @tencentcloud/uikit-base-component-vue3
 ```
 
 ### 步骤3：集成连麦管理面板

package/resource/doc/livekit/vue/components/live-view.md

@@ -1,4 +1,4 @@
-本文对 TUILiveKit 组件中的 **直播视频组件（LiveView）** 进行了详细的介绍，您可以在已有项目中直接参考本文示例集成我们开发好的组件，也可以根据您的需求按照文档中的组件定制化部分对样式，布局进行深度的定制。
+本文对**直播视频组件（LiveView）**进行了详细的介绍，您可以在已有项目中直接参考本文示例集成我们开发好的组件，也可以根据您的需求按照文档中的组件定制化部分对样式，布局进行深度的定制。
 
 ![](https://write-document-release-1258344699.cos.ap-guangzhou.tencentcos.cn/100027862798/1b766277b00211f09e195254007c27c5.png)
 
@@ -38,19 +38,19 @@
 
 【npm】
 ``` bash
-npm install tuikit-atomicx-vue3@latest @tencentcloud/uikit-base-component-vue3 --save
+npm install tuikit-atomicx-vue3 @tencentcloud/uikit-base-component-vue3 --save
 ```
 
 
 【pnpm】
 ``` bash
-pnpm add tuikit-atomicx-vue3@latest @tencentcloud/uikit-base-component-vue3
+pnpm add tuikit-atomicx-vue3 @tencentcloud/uikit-base-component-vue3
 ```
 
 
 【yarn】
 ``` bash
-yarn add tuikit-atomicx-vue3@latest @tencentcloud/uikit-base-component-vue3
+yarn add tuikit-atomicx-vue3 @tencentcloud/uikit-base-component-vue3
 ```
 
 ### 步骤3：加入直播间并进行连麦
@@ -113,21 +113,21 @@ LiveView 提供了灵活的组件自定义插槽，该插槽支持您根据自
 </tr>
 
 <tr>
-<td rowspan="1" colSpan="1" >seatViewUI</td>
+<td rowspan="1" colSpan="1" >streamViewUI</td>
 
-<td rowspan="1" colSpan="1" >seatInfo: SeatInfo</td>
+<td rowspan="1" colSpan="1" >userInfo</td>
 
 <td rowspan="1" colSpan="1" >自定义麦位的显示 UI</td>
 </tr>
 </table>
 
-``` typescript
-// seatViewUI 插槽使用示例
+``` java
+// streamViewUI 插槽使用示例
 <LiveView>
   <CustomStreamViewUI #streamViewUI></CustomStreamViewUI>
 </LiveView>
 ```
-1. `SeatInfo` 定义了直播房间中每个麦位的基本信息和状态：
+1. `userInfo` 定义了直播房间中每个麦位的基本信息和状态：
 
 <table>
 <tr>
@@ -140,56 +140,23 @@ LiveView 提供了灵活的组件自定义插槽，该插槽支持您根据自
 <td rowspan="1" colSpan="1" >说明</td>
 </tr>
 
-<tr>
-<td rowspan="1" colSpan="1" >index</td>
-
-<td rowspan="1" colSpan="1" >number</td>
-
-<td rowspan="1" colSpan="1" >必填</td>
-
-<td rowspan="1" colSpan="1" >麦位的索引号，从0开始递增，用于标识麦位在房间中的位置。</td>
-</tr>
-
-<tr>
-<td rowspan="1" colSpan="1" >isLocked</td>
-
-<td rowspan="1" colSpan="1" >boolean</td>
-
-<td rowspan="1" colSpan="1" >必填</td>
-
-<td rowspan="1" colSpan="1" >麦位锁定状态，true 表示麦位被锁定，其他用户无法进入；false 表示麦位开放。</td>
-</tr>
-
 <tr>
 <td rowspan="1" colSpan="1" >userInfo</td>
 
-<td rowspan="1" colSpan="1" >SeatUserInfo</td>
+<td rowspan="1" colSpan="1" >userInfo</td>
 
 <td rowspan="1" colSpan="1" >非必填</td>
 
 <td rowspan="1" colSpan="1" >当前坐在该麦位上的用户信息，如果麦位为空则为 `undefined`。</td>
 </tr>
-
-<tr>
-<td rowspan="1" colSpan="1" >region</td>
-
-<td rowspan="1" colSpan="1" >RegionInfo</td>
-
-<td rowspan="1" colSpan="1" >非必填</td>
-
-<td rowspan="1" colSpan="1" >麦位在视频画布中的显示区域信息，用于多路视频布局。</td>
-</tr>
 </table>
 
    ``` typescript
-   interface SeatInfo {
-     index: number;           // 麦位索引
-     isLocked: boolean;       // 麦位是否被锁定
-     userInfo?: SeatUserInfo; // 麦位上的用户信息（可选）
-     region?: RegionInfo;     // 麦位在画布中的区域信息（可选）
+   interface userInfo {
+     userInfo: userInfo; // 麦位上的用户信息
    } 
    ```
-2. `SeatUserInfo` 定义了直播房间中每个麦位上的用户详细信息：
+2. `userInfo` 定义了直播房间中每个麦位上的用户详细信息：
 
 <table>
 <tr>
@@ -382,11 +349,11 @@ LiveView 提供了灵活的组件自定义插槽，该插槽支持您根据自
 
 #### 自定义插槽示例
 
-为了更好地让您体验及理解 LiveView 组件的 seatViewUI 插槽定制化能力，我们提供了**直播连麦场景**示例供您参考，您可以参考上述**步骤3**将如下代码增量复制至您的项目中实现类似场景的效果。
+为了更好地让您体验及理解 LiveView 组件的 streamViewUI 插槽定制化能力，我们提供了**直播连麦场景**示例供您参考，您可以参考上述**步骤3**将如下代码增量复制至您的项目中实现类似场景的效果。
 ``` typescript
 <template>
   <LiveView>
-    <template #seatViewUI="{ userInfo }">
+    <template #streamViewUI="{ userInfo }">
       <div 
         class="live-stream-view"
         :class="{ 'is-anchor': isAnchor(userInfo), 'is-guest': !isAnchor(userInfo) }"
@@ -424,4 +391,4 @@ const isAnchor = (userInfo: SeatUserInfo) => {
 </script>
 
 <style scoped>.live-stream-view{position:relative;width:100%;height:100%;border-radius:8px;overflow:hidden}.live-stream-view.is-anchor{border:3px solid #ff6b35;box-shadow:0 0 20px rgba(255,107,53,.3)}.live-stream-view.is-guest{border:1px solid #ddd}.video-area{width:100%;height:100%;background:#000}.user-overlay{position:absolute;bottom:0;left:0;right:0;background:linear-gradient(transparent,rgba(0,0,0,.8));padding:10px;color:#fff}.user-badge{display:inline-block;padding:2px 8px;border-radius:10px;font-size:12px;margin-bottom:5px;background:#666}.anchor-badge{background:#ff6b35;color:#fff}.user-name{font-weight:700;margin-bottom:5px}.device-status span{margin-right:5px;opacity:.8}.device-status .camera.Off,.device-status .mic.Off{opacity:.3}</style>
-```
+```

package/resource/doc/livekit/vue/{components/live-list.md → live-list-integration.md}

@@ -1,16 +1,21 @@
 ## 概述
-本文对 TUILiveKit 组件中的**直播列表页面**进行了详细的介绍，您可以在已有项目中直接参考本文档集成我们开发好的直播列表页面，也可以根据您的需求按照文档中的内容对页面的样式，布局以及功能项进行深度的定制。
+
+本文对 TUILiveKit Demo 中的**直播列表页面**进行了详细的介绍，您可以在已有项目中直接参考本文档集成我们开发好的直播列表页面，也可以根据您的需求按照文档中的内容对页面的样式，布局以及功能项进行深度的定制。
 
 ![](https://write-document-release-1258344699.cos.ap-guangzhou.tencentcos.cn/100027862798/f73d96db8c8611f0ae9d5254001c06ec.png)
 
 
+## 快速体验
+
+您可以在 [在线体验](https://write.woa.com/document/193874503063744512) 中使用 [在线开播网站](https://web.sdk.qcloud.com/trtc/livekit/pusher/index.html) 快速开启一场直播，同时您也可以使用 [在线观看网站](https://web.sdk.qcloud.com/trtc/livekit/player/index.html) 来查看账户下直播列表。
+
 ## 快速接入
 
 ### 步骤1：环境配置及开通服务
 
 在进行快速接入之前，您需要参见 [准备工作](https://write.woa.com/document/188228825253294080)，满足相关环境配置及开通对应服务。
 
-### 步骤2: 安装依赖
+### 步骤2：安装依赖
 
 您可以选择以下任一方式安装依赖：
 
@@ -19,25 +24,25 @@
 
 【npm】
 ``` bash
-npm install tuikit-atomicx-vue3@latest @tencentcloud/uikit-base-component-vue3 --save
+npm install tuikit-atomicx-vue3 @tencentcloud/uikit-base-component-vue3 --save
 ```
 
 
 【pnpm】
 ``` bash
-pnpm add tuikit-atomicx-vue3@latest @tencentcloud/uikit-base-component-vue3
+pnpm add tuikit-atomicx-vue3 @tencentcloud/uikit-base-component-vue3
 ```
 
 
 【yarn】
 ``` bash
-yarn add tuikit-atomicx-vue3@latest @tencentcloud/uikit-base-component-vue3
+yarn add tuikit-atomicx-vue3 @tencentcloud/uikit-base-component-vue3
 ```
 
 ### 步骤3: 直播列表页面接入
 
 在您的项目下创建 **live-list.vue **文件，可直接复制如下代码至您的项目中集成**直播列表页面**。
-``` vue
+``` javascript
 <template>
   <UIKitProvider language="zh-CN">
     <div class="container">
@@ -81,7 +86,7 @@ onMounted(async () => {
 > **注意：**
 > 
 
-> 若您需要实现直播列表到进入直播间的跳转逻辑，可参考本文中[指定直播间](https://write.woa.com/#61f1bbc9-1f23-4b69-aceb-7ab3f35a0ec2)部分内容。
+> 若您需要实现直播列表到进入直播间的跳转逻辑，可参考本文中 [指定直播间](https://write.woa.com/#61f1bbc9-1f23-4b69-aceb-7ab3f35a0ec2) 部分内容。
 > 
 
 
@@ -94,7 +99,7 @@ npm run dev
 
 ## 自由定制
 
-根据上述功能展示图，我们也支持您根据项目需求对直播列表页面进行 UI 定制能力。主要可供定制的能力如下表所示。
+根据上述功能展示图，我们也支持您根据项目需求对直播列表页面进行 UI 定制。主要可供定制的能力如下表所示。
 <table>
 <tr>
 <td rowspan="1" colSpan="1" >**类别**</td>
@@ -188,39 +193,3 @@ app.mount('#app');
 ### 更多资源
 
 [腾讯云实时音视频控制台](https://console.cloud.tencent.com/trtc)
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-#### 
-
-#### 
-
-#### 
-
-#### 
-
-####