npm - @tencentcloud/sdk-mcp - Versions diffs - 1.6.6 → 1.6.8 - Mend

@tencentcloud/sdk-mcp 1.6.6 → 1.6.8

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (272) hide show

package/resource/integration/chat/preset/react/integration.md CHANGED Viewed

@@ -42,7 +42,6 @@ npm run dev
 ```
 > **说明：**
->
 > 示例项目地址：[点击查看 Gitee 示例项目](https://gitee.com/tencent-cloud-uikit/rtc-chat-web)。
 >
 > 示例项目用于帮助您快速体验和对照接入流程。若您需要在已有项目中集成，建议继续阅读下方步骤，按文档逐步完成接入。
@@ -53,7 +52,6 @@ npm run dev
 创建一个新的名为 **chat-integration-react** 的 React 项目，并按照脚手架的步骤提示完成项目的初始化。
 > **注意：**
->
 > 1. 建议使用 npm 进行安装，npm 会主动下载所需的 peerDependencies 依赖。
 > 2. `npm create vite@latest` 会使用最新的 vite 版本，最新版本的 vite 可能会与低版本的 node.js 冲突，请检查您电脑上的相关环境配置。
@@ -91,7 +89,6 @@ npm i @tencentcloud/chat-uikit-react
 ### 步骤 2. 引入组件
 > **说明：**
->
 > 以下代码中未填入 `SDKAppID`、`userID` 和 `userSig`，需在 步骤3 中获取相关信息后进行替换。
 >
@@ -351,7 +348,6 @@ const { status } = useLoginState({
 | userSig | String | 用户登录即时通信 IM 的密码，其本质是对 UserID 等信息加密后得到的密文。<br><strong>说明：</strong><br>- 开发环境：快速跑通 Demo，可以通过 <a href="https://console.cloud.tencent.com/im">即时通信 IM 控制台</a> 获取 UserSig。<br>- 生产环境：将 UserSig 的计算代码集成到您的服务端，并提供面向项目的接口， 正确的 UserSig 签发方式请参见 <a href="https://cloud.tencent.com/document/product/269/32688">服务端生成 UserSig</a>。 |
 > **注意：**
->
 > 本文示例代码采用从 [即时通信 IM 控制台](https://console.cloud.tencent.com/im) 获取 UserSig 的方案，**该方法仅适合本地跑通功能调试**。 正确的 UserSig 签发方式请参见 [服务端生成 UserSig](https://cloud.tencent.com/document/product/269/32688)。
 >
@@ -371,7 +367,6 @@ npm run dev
 ```
 > **注意：**
->
 > - 请确保 步骤3 代码中 SDKAppID、userID 和 userSig 均已成功替换，如未替换将会导致项目表现异常。
 > - userID 和 userSig 为一一对应关系，具体参见 生成 UserSig（用户鉴权）。
 > - 如遇到项目启动失败，请检查 开发环境要求 是否满足。
@@ -381,7 +376,6 @@ npm run dev
 ### 音视频通话
 > **说明：**
->
 > TUICallKit 是腾讯云推出一款音视频通话 UI 组件，通过集成该组件，您只需要编写几行代码就可以在聊天应用中体验音视频通话功能。
 >
 > 更多详细信息可参考：音视频通话-开通服务。
@@ -420,7 +414,6 @@ npm run dev
 ### 云端搜索
 > **说明：**
->
 > 搜索，在客服、社交、在线教育、在线医疗、OA 等场景下是刚需功能，可帮助用户快速查找群组、用户、消息，提升产品使用体验和用户粘性。
 >
 > 由于 Web 平台本地存储特殊性等原因，Vue **无法实现本地搜索**，为了更好地满足对于搜索能力的需求，推出了**云端搜索能力**。**云端搜索功能支持全局搜索和会话内搜索，同时支持搜索群组、用户和消息。**
@@ -428,7 +421,7 @@ npm run dev
 > 此功能属于增值服务，需要您购买云端搜索插件，请点击 [购买](https://console.cloud.tencent.com/im/plugin/TUICloudSearch)。
 >
-云端搜索在“步骤 2”中已经默认集成，如果需要关闭云端搜索功能，请参考以下代码：
+云端搜索在“步骤 2”中已经默认集成，如果需要关闭云端搜索功能，
 1. 注释 `ChatHeader` 中 `ChatHeaderRight` 属性，和会话内搜索侧边栏相关的代码
    ``` typescript
@@ -465,7 +458,6 @@ npm run dev
 UserSig 是用户登录即时通信 IM 的密码，其本质是对 UserID 等信息加密后得到的密文。UserSig 的签发方式是需将 UserSig 的计算代码集成到您的服务端，并提供面向项目的接口，在需要 UserSig 时由您的项目向业务服务器发起请求获取动态 UserSig。更多详情请参见 [服务端生成 UserSig](https://cloud.tencent.com/document/product/269/32688)。
 > **注意：**
->
 > 本文示例代码采用在 [即时通信 IM 控制台](https://console.cloud.tencent.com/im) 获取 UserSig 的方案，**该方法仅适合本地跑通功能调试**。 正确的 UserSig 签发方式请参见[服务端生成 UserSig](https://cloud.tencent.com/document/product/269/32688)。
 >

package/resource/integration/chat/preset/uni-app/integration.md CHANGED Viewed

@@ -27,7 +27,6 @@ TUIKit 是一款基于腾讯云 IM SDK 和 UTS 原生渲染技术的 uni-app UI
 ## 集成步骤
 > **说明：**
->
 > **Demo：** [GitHub 完整 Demo](https://github.com/Tencent-RTC/TUIKit_uni-app) 开箱即用，5 分钟跑通聊天 + 音视频通话全功能。
 >
@@ -44,14 +43,9 @@ TUIKit 是一款基于腾讯云 IM SDK 和 UTS 原生渲染技术的 uni-app UI
 【uni-app 项目】
 > **说明：**
->
 > `Camera` 、`Record`**、** `VideoPlayer` 模块用于聊天中的拍照、录音、视频播放功能。Android 权限用于录音、网络访问和文件存储。
 >
-1. **模块配置**。点击 `manifest.json` > 点击**安卓 / iOS 模块配置** >  勾选 **Camera&Gallery（相机和相册）、Record（录音）、 VideoPlayer（视频播放）**。如图所示：
-2. **配置 Android 相关权限**。点击 `manifest.json`> 点击**安卓 / iOS权限配置** >  Android 云打包配置中配置如下权限。如图所示：
 ``` bash
 <uses-permission android:name="android.permission.RECORD_AUDIO" />
 <uses-permission android:name="android.permission.INTERNET" />
@@ -62,7 +56,6 @@ TUIKit 是一款基于腾讯云 IM SDK 和 UTS 原生渲染技术的 uni-app UI
 【uni-app x 项目】
-**配置 Android 相关权限**。点击 `manifest.json`> 点击**安卓 App 配置** >  权限配置中配置如下权限。如图所示：
 ``` bash
 <uses-permission android:name="android.permission.RECORD_AUDIO" />
 <uses-permission android:name="android.permission.INTERNET" />
@@ -355,7 +348,6 @@ xcopy /E /I /Y "uni_modules\tuikit-atomic-x\quickstart\static\*" "static\" && xc
 ## 运行和测试
 > **说明：**
->
 > 接入过程中遇到任何卡点或有改进建议，欢迎通过 [UniApp Atomicx 接入体验反馈](https://wj.qq.com/s2/26120470/621d/) 反馈，官方会及时跟进处理。
 >
@@ -472,7 +464,6 @@ login({
 **初始化 TUICallKit 服务。**在根目录下的 `App.vue` 中引入如下代码。
 > **说明：**
->
 > TUICallKit 暂不支持 uni-app x 项目**，仅支持 uni-app 项目。**
 >

package/resource/integration/chat/preset/vue/integration.md CHANGED Viewed

@@ -1,14 +1,13 @@
 TUIKit 是基于腾讯云 Chat SDK 的一款 Vue 3 UI 组件库，它提供了一些通用的 UI 组件，包含会话、聊天、群组等功能。本文介绍如何快速集成 TUIKit 并实现核心功能。
 > **说明：**
->
 > - **AI 助手使用说明**
 > MCP 提供了 **IM 知识咨询**和**含 UI 集成**的 AI 解决方案，您可以通过 MCP 查询 IM 相关的知识和集成 UIKit，[点击这里，立即体验 AI 助手](https://cloud.tencent.com/document/product/269/126983)。
 >
 |接入需求|桌面端|移动端 H5|
 |---------|---------|---------|
-|全新 Web Vue3 项目|请参考本文|全功能接入 > 移动端 > Vue3|
+|全新 Web Vue3 项目|
 |全新 Web React 项目|全功能接入 > 桌面端 > React|全功能接入 > 移动端 > React|
 |Web Vue2 项目|全功能接入 > 桌面端 > Vue2 & 旧版本 Vue3|全功能接入 > 桌面端 > Vue2 & 旧版本 Vue3|
@@ -49,7 +48,6 @@ npm run dev
 ```
 > **说明：**
->
 > 示例项目地址：[点击查看 Gitee 示例项目](https://gitee.com/tencent-cloud-uikit/rtc-chat-web)。
 >
 > 示例项目用于帮助您快速体验和对照接入流程。若您需要在已有项目中集成，建议继续阅读下方步骤，按文档逐步完成接入。
@@ -60,7 +58,6 @@ npm run dev
 使用 Vite 创建一个新的名称为 **chat-integration-vue3** 的 Vue3 项目。
 > **注意：**
->
 > 1. 建议使用 npm 进行安装，npm 会主动下载所需的 peerDependencies 依赖。
 > 2. `npm create vite@latest` 会使用最新的 vite 版本，最新版本的 vite 可能会与低版本的 node.js 冲突，请检查您电脑上的相关环境配置。
@@ -97,7 +94,6 @@ cd chat-integration-vue3
 ### 步骤1：安装依赖
 > **说明：**
->
 > 建议使用 npm 进行安装，npm 会主动下载所需的 peerDependencies 依赖。
 >
@@ -109,7 +105,6 @@ npm i @tencentcloud/chat-uikit-vue3@6 tuikit-atomicx-vue3@6
 ### 步骤2：引入组件
 > **注意：**
->
 > 以下代码中未填入 `SDKAppID`、`userID` 和 `userSig`，需在 步骤3 中获取相关信息后进行替换。
 >
@@ -356,7 +351,6 @@ login({
 | userSig | String | 用户登录即时通信 IM 的密码，其本质是对 UserID 等信息加密后得到的密文。<br><strong>说明：</strong><br>开发环境：快速跑通 Demo，可以通过 <a href="https://console.cloud.tencent.com/im">即时通信 IM 控制台</a> 获取 UserSig。<br>生产环境：将 UserSig 的计算代码集成到您的服务端，并提供面向项目的接口， 正确的 UserSig 签发方式请参见 <a href="https://cloud.tencent.com/document/product/269/32688">服务端生成 UserSig</a>。 |
 > **注意：**
->
 > 本文示例代码采用在[即时通信 IM 控制台](https://console.cloud.tencent.com/im) 获取 UserSig 的方案，**该方法仅适合本地跑通功能调试**。 正确的 UserSig 签发方式请参见[服务端生成 UserSig](https://cloud.tencent.com/document/product/269/32688)。
 >
@@ -376,7 +370,6 @@ npm run dev
 ```
 > **注意：**
->
 > - 请确保 步骤3 代码中 SDKAppID、userID 和 userSig 均已成功替换，如未替换将会导致项目表现异常。
 > - userID 和 userSig 为一一对应关系。
 > - 如遇到项目启动失败，请检查 开发环境要求 是否满足。
@@ -386,7 +379,6 @@ npm run dev
 ### 音视频通话
 > **说明：**
->
 > TUICallKit 是腾讯云推出一款音视频通话 UI 组件，通过集成该组件，您只需要编写几行代码就可以在聊天应用中体验音视频通话功能。
 >
 > 更多详细信息可参考：音视频通话-开通服务。
@@ -468,7 +460,6 @@ TUIRoomKit 是一款定位企业会议、网络研讨会、在线教育等多人
 ### 云端搜索
 > **说明：**
->
 > 搜索，在客服、社交、在线教育、在线医疗、OA 等场景下是刚需功能，可帮助用户快速查找群组、用户、消息，提升产品使用体验和用户粘性。
 >
 > 由于 Web 平台本地存储特殊性等原因，Vue **无法实现本地搜索**，为了更好的满足对于搜索能力的需求，推出了**云端搜索能力**。**云端搜索功能支持全局搜索和会话内搜索，同时支持搜索群组、用户和消息。**
@@ -478,7 +469,7 @@ TUIRoomKit 是一款定位企业会议、网络研讨会、在线教育等多人
 > 此功能属于增值服务，需要您购买云端搜索插件，请点击 [购买](https://console.cloud.tencent.com/im/plugin/TUICloudSearch)。
 >
-云端搜索在“步骤 2”中已经默认集成，如果需要关闭云端搜索功能，请参考以下代码：
+云端搜索在“步骤 2”中已经默认集成，如果需要关闭云端搜索功能，
 1. 设置 `ConversationList` 的 `enableSearch` 属性为 `false`：
    ``` typescript
@@ -509,7 +500,6 @@ TUIRoomKit 是一款定位企业会议、网络研讨会、在线教育等多人
 UserSig 是用户登录即时通信 IM 的密码，其本质是对 UserID 等信息加密后得到的密文。UserSig 签发方式是将 UserSig 的计算代码集成到您的服务端，并提供面向项目的接口，在需要 UserSig 时由您的项目向业务服务器发起请求获取动态 UserSig。更多详情请参见 [服务端生成 UserSig](https://cloud.tencent.com/document/product/269/32688)。
 > **注意：**
->
 > 本文示例代码采用在 [即时通信 IM 控制台](https://console.cloud.tencent.com/im) 获取 UserSig 的方案，**该方法仅适合本地跑通功能调试**。 正确的 UserSig 签发方式请参见 [服务端生成 UserSig](https://cloud.tencent.com/document/product/269/32688)。
 >
@@ -554,7 +544,7 @@ const isChatSettingShow = ref(false);
 ### NPM 包
-[chat-uikit-vue3 npm](https://www.npmjs.com/package/@tencentcloud/chat-uikit-vue3)
+[chat-uikit-vue3 npm](https://www.npmjs.com/package/@tencentcloud/chat-uikit-vue3)
 ### GitHub

package/resource/integration/livekit/preset/live/android/live-host-integration.md CHANGED Viewed

@@ -14,10 +14,6 @@
 - **直播间管理：**支持在线用户列表展示、以及直播间内的禁言、踢人等多种管理操作。
-| 开播前预览 | 连麦互动 | 观众互动 | 直播间管理 |
-| --- | --- | --- | --- |
-|  |  |  |  |
 ## 快速接入
 ### 步骤 1.  开通服务

package/resource/integration/livekit/preset/live/android/prepare-integration.md CHANGED Viewed

@@ -11,16 +11,8 @@ TUILiveKit UI 组件为您提供的是功能闭环、交互丰富的直播全链
 ### **视频直播**
-|**主播准备页**|**主播开播页**|**直播列表**|**观众观看页**|
-|---------|---------|---------|---------|
-|||||
 ### **语聊房**
-|**主播准备页**|**主播开播页**|**直播列表**|**观众观看页**|
-|---------|---------|---------|---------|
-|||||
 ## **准备工作**
 ### 开通服务
@@ -170,7 +162,6 @@ dependencies {
 代码集成完成后，您需要完成登录。这是**使用 TUILiveKit 的关键步骤**，因为只有在登录成功后才能正常使用 TUILiveKit 的各项功能，故请您耐心检查相关参数是否配置正确：
 > **说明：**
->
 > 在示例代码中，直接进行了登录接口的调用。但在实际项目场景下，强烈推荐**您在完成自己的用户身份验证等相关登录操作后，再调用 TUILiveKit 的登录服务**。这样可以避免因过早调用登录服务，导致业务逻辑混乱或数据不一致的问题，同时也能更好地适配您项目中现有的用户管理和权限控制体系。
 >
@@ -179,9 +170,9 @@ dependencies {
 // 1.导入依赖
 import io.trtc.tuikit.atomicxcore.api.CompletionHandler
 import io.trtc.tuikit.atomicxcore.api.login.LoginStore
 private const val TAG = "LoginStore"
 // 2.调用登录接口，推荐您在自己登录业务完成后再调用 LoginStore 登录
 LoginStore.shared.login(applicationContext,
   1400000001,      // 请替换为开通服务控制台的 SDKAppID
@@ -191,7 +182,7 @@ LoginStore.shared.login(applicationContext,
       override fun onSuccess() {
           Log.i(TAG, "LoginStore login success")
       }
       override fun onFailure(code: Int, desc: String) {
           Log.e(TAG, "LoginStore login failed, $code errorMessage:$desc")
       }
@@ -216,28 +207,28 @@ LoginStore.shared.login(applicationContext,
 ``` java
 import io.trtc.tuikit.atomicxcore.api.login.LoginListener
 import io.trtc.tuikit.atomicxcore.api.login.LoginStore
 class YourLoginService {
     // 实例化监听器
     private val loginListener = object : LoginListener() {
         // 用户被踢下线回调
         override fun onKickedOffline() {
             // 您的业务代码：UI 交互提示用户，然后重新登录
         }
         // 用户签名过期回调
         override fun onLoginExpired() {
             // 您的业务代码：如果当前用户在您后台的登录态依然有效，您可以让您的 app 向您的后台请求新的 userSig，
             // 并调用 LoginStore.shared.login 续签登录态。
         }
     }
     // 监听登录状态回调
     fun subscribeLoginStatus() {
         LoginStore.shared.addLoginListener(loginListener)
     }
     // 取消监听登录状态回调
     fun unsubscribeLoginStatus() {
         LoginStore.shared.removeLoginListener(loginListener)
@@ -260,12 +251,8 @@ class YourLoginService {
 不需要。通常您只需要完成一次 `TUILogin.login` 调用即可，我们建议您将 `TUILogin.login` 和 `TUILogin.logout` 与自己的登录业务关联。
-### 集成代码后产生如下图所示编译报错 allowBackup 异常，如何处理？
 - **问题原因**：多个模块的 `AndroidManifest.xml` 中都配置了 `allowBackup` 属性，造成冲突。
-- **解决方法**：您可以在您工程的 `AndroidManifest.xml` 文件中删除 `allowBackup` 属性或将该属性改为 `false`，表示关闭备份和恢复功能；并在 `AndroidManifest.xml` 文件的 application 节点中添加 `tools:replace="android:allowBackup"` 表示覆盖其他模块的设置，使用您自己的设置。修复示例如图所示：
 ### 集成代码后还需要添加摄像头麦克风等权限的声明吗？
 不需要，TUILiveKit 中已经内置了摄像头麦克风等权限的声明，在接入过程中您无需再关心这些权限的声明。

package/resource/integration/livekit/preset/live/ios/live-audience-integration.md CHANGED Viewed

@@ -176,7 +176,6 @@ present(audienceVC, animated: false)
 TUILiveKit 使用更为方便的 [Apple Strings Catalog](https://developer.apple.com/documentation/xcode/localizing-and-varying-text-with-a-string-catalog) 工具来管理 UI 所需的文案显示，您可以很直观的通过 Xcode 视图化管理工具修改需要调整的文案：
 > **说明：**
->
 > [Apple Strings Catalog](https://developer.apple.com/documentation/xcode/localizing-and-varying-text-with-a-string-catalog) (.xcstrings) 是在 Xcode 15 中引入的本地化格式。它增强了开发者管理本地化字符串的方式，支持处理复数、设备特定变体等的结构化格式。这种格式正成为管理 iOS 和 macOS 应用程序本地化的推荐方法。
 >

package/resource/integration/livekit/preset/live/ios/live-host-integration.md CHANGED Viewed

@@ -14,10 +14,6 @@ TUILiveKit 主播开播页为直播场景提供**开箱即用的全功能界面*
 - **直播间管理：**支持在线用户列表展示、以及直播间内的禁言、踢人等多种管理操作。
-| 开播前预览 | 连麦互动 | 观众互动 | 直播间管理 |
-| --- | --- | --- | --- |
-|  |  |  |  |
 ## 快速接入
 ### 步骤1：开通服务
@@ -330,7 +326,6 @@ class YourAnchorPrepareViewController: UIViewController {
 `TUILiveKit` 使用更为方便的 [Apple Strings Catalog](https://developer.apple.com/documentation/xcode/localizing-and-varying-text-with-a-string-catalog) 工具来管理 UI 所需的文案显示，您可以很直观的通过 Xcode 视图化管理工具修改需要调整的文案：
 > **说明：**
->
 > [Apple Strings Catalog](https://developer.apple.com/documentation/xcode/localizing-and-varying-text-with-a-string-catalog) (.xcstrings) 是在 Xcode 15 中引入的本地化格式。它增强了开发者管理本地化字符串的方式，支持处理复数、设备特定变体等的结构化格式。这种格式正成为管理 iOS 和 macOS 应用程序本地化的推荐方法。
 >

package/resource/integration/livekit/preset/live/ios/live-list-integration.md CHANGED Viewed

@@ -202,10 +202,6 @@ extension YourLiveListViewController: OnItemClickDelegate {
 }
 ```
-|**双列瀑布流直播列表转场动画**|**单列瀑布流转场动画**|
-|---------|---------|
-|||
 ## 下一步
 恭喜您，现在您已经成功集成了 **直播列表** 功能。接下来，您可以根据您的业务场景实现**主播开播、观众观看**等功能

package/resource/integration/livekit/preset/live/ios/prepare-integration.md CHANGED Viewed

@@ -11,16 +11,8 @@
 ### **视频直播**
-|**主播准备页**|**主播开播页**|**直播列表**|**观众观看页**|
-|---------|---------|---------|---------|
-|||||
 ### **语聊房**
-|**主播准备页**|**主播开播页**|**直播列表**|**观众观看页**|
-|---------|---------|---------|---------|
-|||||
 ## 准备工作
 ### 开通服务
@@ -101,7 +93,6 @@
 代码集成完成后，您需要完成登录，这是**使用 TUILiveKit 的关键步骤**，因为只有在登录成功后才能正常使用 TUILiveKit 的各项功能，故请您耐心检查相关参数是否配置正确：
 > **说明：**
->
 > 在示例代码中，登录操作是在 `didFinishLaunchingWithOptions` 方法内完成的。但在实际项目场景下，强烈推荐 **您在完成自己的用户身份验证等相关登录操作后，再调用 TUILiveKit 的登录服务**。这样可以避免因过早调用登录服务，导致业务逻辑混乱或数据不一致的问题，同时也能更好地适配您项目中现有的用户管理和权限控制体系。
 >

package/resource/integration/livekit/preset/live/vue/live-list-integration.md CHANGED Viewed

@@ -10,7 +10,7 @@
 ### 步骤1：环境配置及开通服务
-在进行快速接入之前，请参考 准备工作 集成组件并实现登录。
+在进行快速接入之前。
 ### 步骤2：安装依赖
@@ -36,7 +36,6 @@ yarn add tuikit-atomicx-vue3 @tencentcloud/uikit-base-component-vue3
 在您的项目下创建 **live-list.vue** 文件，可直接复制如下代码至您的项目中集成**直播列表页面**。
 > **注意：**
->
 > 您可以直接复制如下代码至您的工程中集成示例工程，也可以访问 [直播列表](https://github.com/Tencent-RTC/TUILiveKit/blob/main/Web/web-vite-vue3/src/TUILiveKit/LiveListView.vue) 地址，查看更加详细的源码内容。
 >
@@ -82,7 +81,6 @@ onMounted(async () => {
 ```
 > **注意：**
->
 > 若您需要实现直播列表到进入直播间的跳转逻辑，可参考本文中 指定直播间 部分内容。
 >
@@ -93,7 +91,6 @@ onMounted(async () => {
 通过下列命令启动成功后，通过访问本地地址打开直播列表页面。
 > **说明：**
->
 > 上述命令执行成功后，请在浏览器地址栏输入本地访问地址（您可以根据项目参考，例如 `http://localhost:5173/live-list`，具体端口号可能因您的项目配置而有所不同），即可看到直播列表页面。
 >
@@ -110,7 +107,6 @@ onMounted(async () => {
 请配置您的 Vue Router，将 `live-list.vue` 映射到直播列表页面。
 > **注意：**
->
 > - 如果您的业务项目中已有 `src/router/index.ts` 文件，请将以下内容合并到已有代码中。
 > - 如果尚未配置路由，请新建 `src/router/index.ts` 文件并添加以下配置。