@tencentcloud/sdk-mcp 1.6.4 → 1.6.6

package/resource/integration/chat/preset/ios/integration.md

@@ -24,7 +24,6 @@ TUIKit SwiftUI 提供了一套完整的即时通信 UI 组件，向下依赖 Ato
 
       > **说明：**
       >
-
       > 本项目当前仅支持手动集成，暂不支持通过 CocoaPods、SPM 等包管理器集成。
       >
 
@@ -116,8 +115,8 @@ chat/
 
    > **注意：**
    >
->   - 使用本地集成方案时，如需升级时需要从 GitHub 获取最新的组件代码，覆盖您本地项目的 TUIKit SwiftUI 目录。
->   - 当私有化修改和远端有冲突时，需要手动合并，处理冲突。
+   > - 使用本地集成方案时，如需升级时需要从 GitHub 获取最新的组件代码，覆盖您本地项目的 TUIKit SwiftUI 目录。
+   > - 当私有化修改和远端有冲突时，需要手动合并，处理冲突。
 
 ### 配置项目
 1. **配置 Build Settings**
@@ -168,7 +167,6 @@ LoginStore.shared.login(sdkAppID: sdkAppID, userID: userID, userSig: userSig, co
 
 > **警告：**
 >
-
 > 在正式的生产环境中，请在您的服务端生成 UserSig，在需要 UserSig 时由您的 App 向业务服务器发起请求获取动态 UserSig 来进行鉴权。详见 服务端生成 UserSig。
 >
 
@@ -266,7 +264,7 @@ LoginStore.shared.login(sdkAppID: sdkAppID, userID: userID, userSig: userSig, co
 
 ### 步骤4：构建聊天界面
 
-您可以基于 TUIKit SwiftUI 中的 MessageList、MessageInput  组件，构建一个聊天页面。
+您可以基于 TUIKit SwiftUI 中的 MessageList、MessageInput 组件，构建一个聊天页面。
 - MessageList 内建的功能是：
 
   - 展示单聊或群聊消息列表。
@@ -277,7 +275,7 @@ LoginStore.shared.login(sdkAppID: sdkAppID, userID: userID, userSig: userSig, co
 
   - 支持用户组建并发送多种类型的消息：文本、表情、图片、语音、视频、文件等。
 
-      您可以将 MessageList 和  MessageInput 直接集成到现有的 App 页面中，也可以新构建一个完整的聊天页，组装后的一种 UI 效果如下图所示：
+      您可以将 MessageList 和 MessageInput 直接集成到现有的 App 页面中，也可以新构建一个完整的聊天页，组装后的一种 UI 效果如下图所示：
 
       将 MessageList 和 MessageInput 组装为聊天页，可参考 `chat/uikit/ChatPage.swift` 文件里的实现，`ChatPage` 主要做了以下工作：
 
@@ -559,6 +557,44 @@ ChatNavPage(
 
 您可以参考上述回调说明及参考代码，实现 Page 之间交互逻辑。
 
+### 步骤7：接入智能客服 Desk 用户端（可选）
+
+若需同时集成智能客服 Desk 用户端，请先 [开通智能客服 Desk 服务](https://cloud.tencent.com/document/product/269/96059)，并根据 [iOS 接入智能客服用户端](https://cloud.tencent.com/document/product/269/110808) 文档完成 `TencentCloudAIDeskCustomer` 包引入和配置，即可在您的应用中引入客服会话能力。
+``` objectivec
+#import <TencentCloudAIDeskCustomer/TencentCloudCustomerManager.h>
+
+int SDKAppID = 0; // 开通了智能客服 Desk 的应用 ID
+NSString *userID = @"";
+NSString *userSig = @"";
+
+// 上述三个参数, 可以和您登录腾讯云 IM 的保持一致, 也可以使用不同的应用和用户
+
+// 用户昵称。设置后，用户端转人工成功时，人工客服在工作台可见。您可将用户手机号，用户来源等信息写入昵称，长度限制500字节
+// 注意！设置后，即时通信 IM 同 userID 的昵称也会被更新
+// 如您不希望变更，请设置为 @"" 或 nil
+NSString *nickName = @"";
+
+// 用户头像。设置后，用户端转人工成功时，人工客服在工作台可见
+// 注意！设置后，即时通信 IM 同 userID 的头像也会被更新
+// 如您不希望变更，请设置为 @"" 或 nil
+NSString *avatar = @"";
+
+[[TencentCloudCustomerManager sharedManager]
+    initWithProfile:SDKAppID
+    userID:userID
+    userSig:userSig
+    nickName:nickName
+    avatar:avatar
+    completion:^(NSError *error) {
+        if (error) {
+            NSLog(@"login failed. error:%@", error);
+        }
+    }];
+
+// 点击打开智能客服会话页面
+[[TencentCloudCustomerManager sharedManager] pushCustomerServiceChatFromController:self];
+```
+
 ## 常见问题
 
 ### 功能常见问题

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

@@ -2,13 +2,7 @@ TUIKit 是基于腾讯云 Chat SDK 的一款 React 组件库，它提供了一
 
 > **AI 助手使用说明：**
 >
-> - **IM 知识咨询**
-
-> Skill 提供** IM 知识咨询**能力，您可以用 Skill 在 IDE 中直接查询 SDK、UIKit、服务端 API、产品计费等内容，[点击这里，立即体验 AI 咨询助手](https://cloud.tencent.com/document/product/269/125822)。
->
-> - **AI 集成**
-
-> MCP 提供全新的 AI 集成方式，只需要简单描述您的需求，即可**自动生成集成代码**，大幅提升开发效率，[点击这里，立即体验 AI 集成助手](https://cloud.tencent.com/document/product/269/124481)。
+> MCP 提供了 **IM 知识咨询**和**含 UI 集成**的 AI 解决方案，您可以通过 MCP 查询 IM 相关的知识和集成 UIKit，[点击这里，立即体验 AI 助手](https://cloud.tencent.com/document/product/269/126983)。
 >
 
 ## 关键概念
@@ -37,10 +31,32 @@ chat-uikit-react 主要分为 ConversationList、Chat、MessageList、ChatHeader
 
 - TypeScript@^5.0.0
 
+## 快速体验完整示例项目
+
+如果您希望先快速跑通完整效果，或在接入过程中对照最终代码结构，可以直接克隆我们已经完成接入的示例项目。示例项目已完成 Chat UIKit 相关依赖安装、组件引入、初始化配置和基础页面接入，适合作为接入参考。
+``` bash
+git clone https://gitee.com/tencent-cloud-uikit/rtc-chat-web.git
+cd chat-desktop-react
+npm install
+npm run dev
+```
+
+> **说明：**
+>
+> 示例项目地址：[点击查看 Gitee 示例项目](https://gitee.com/tencent-cloud-uikit/rtc-chat-web)。
+>
+> 示例项目用于帮助您快速体验和对照接入流程。若您需要在已有项目中集成，建议继续阅读下方步骤，按文档逐步完成接入。
+>
+
 ## 创建项目
 
 创建一个新的名为 **chat-integration-react** 的 React 项目，并按照脚手架的步骤提示完成项目的初始化。
 
+> **注意：**
+>
+> 1. 建议使用 npm 进行安装，npm 会主动下载所需的 peerDependencies 依赖。
+> 2. `npm create vite@latest` 会使用最新的 vite 版本，最新版本的 vite 可能会与低版本的 node.js 冲突，请检查您电脑上的相关环境配置。
+
 【shell】
 ``` bash
 npm create vite@latest
@@ -65,13 +81,7 @@ npm create vite@latest
 
 ### 步骤 1. 安装依赖
 
-通过 npm 方式下载 [chat-uikit-react](https://www.npmjs.com/package/@tencentcloud/chat-uikit-react) 并在项目中使用。
-
-> **说明：**
->
-
-> 建议使用 npm 进行安装，npm 会主动下载所需的 peerDependencies 依赖。
->
+通过 npm 方式下载 [chat-uikit-react](https://www.npmjs.com/package/@tencentcloud/chat-uikit-react) 并在项目中使用（建议使用 npm 进行安装，npm 会主动下载所需的 peerDependencies 依赖）。
 
 【shell】
 ``` bash
@@ -82,7 +92,6 @@ npm i @tencentcloud/chat-uikit-react
 
 > **说明：**
 >
-
 > 以下代码中未填入 `SDKAppID`、`userID` 和 `userSig`，需在 步骤3 中获取相关信息后进行替换。
 >
 
@@ -343,7 +352,6 @@ const { status } = useLoginState({
 
 > **注意：**
 >
-
 > 本文示例代码采用从 [即时通信 IM 控制台](https://console.cloud.tencent.com/im) 获取 UserSig 的方案，**该方法仅适合本地跑通功能调试**。 正确的 UserSig 签发方式请参见 [服务端生成 UserSig](https://cloud.tencent.com/document/product/269/32688)。
 >
 
@@ -351,7 +359,7 @@ const { status } = useLoginState({
 
 - userID：单击 [即时通信 IM 控制台 > 消息服务 Chat > 账号管理](https://console.cloud.tencent.com/im/account-management)，切换至目标应用所在账号，您可以创建 2～3 个账号用于体验单聊、群聊的功能。
 
-- userSig：单击 [即时通信 IM 控制台 > 开发工具 > UserSig生成校验](https://console.cloud.tencent.com/im/tool-usersig)，切换至目标应用所在账号，填写创建的 userID，即可生成 userSig。
+- userSig：单击 [即时通信 IM 控制台 > 开发工具 > UserSig 生成校验](https://console.cloud.tencent.com/im/tool-usersig)，切换至目标应用所在账号，填写创建的 userID，即可生成 userSig。
 
 ## 运行和测试
 
@@ -364,8 +372,8 @@ npm run dev
 
 > **注意：**
 >
-> - 请确保 步骤3 代码中  SDKAppID、userID 和 userSig 均已成功替换，如未替换将会导致项目表现异常。
-> - userID 和 userSig  为一一对应关系，具体参见 生成 UserSig（用户鉴权）。
+> - 请确保 步骤3 代码中 SDKAppID、userID 和 userSig 均已成功替换，如未替换将会导致项目表现异常。
+> - userID 和 userSig 为一一对应关系，具体参见 生成 UserSig（用户鉴权）。
 > - 如遇到项目启动失败，请检查 开发环境要求 是否满足。
 
 ## 集成更多高级特性
@@ -374,10 +382,8 @@ npm run dev
 
 > **说明：**
 >
-
 > TUICallKit 是腾讯云推出一款音视频通话 UI 组件，通过集成该组件，您只需要编写几行代码就可以在聊天应用中体验音视频通话功能。
 >
-
 > 更多详细信息可参考：音视频通话-开通服务。
 >
 
@@ -415,13 +421,10 @@ npm run dev
 
 > **说明：**
 >
-
 > 搜索，在客服、社交、在线教育、在线医疗、OA 等场景下是刚需功能，可帮助用户快速查找群组、用户、消息，提升产品使用体验和用户粘性。
 >
-
-> 由于 Web 平台本地存储特殊性等原因，Vue **无法实现本地搜索**，为了更好的满足对于搜索能力的需求，推出了**云端搜索能力**。**云端搜索功能支持全局搜索和会话内搜索，同时支持搜索群组、用户和消息。**
+> 由于 Web 平台本地存储特殊性等原因，Vue **无法实现本地搜索**，为了更好地满足对于搜索能力的需求，推出了**云端搜索能力**。**云端搜索功能支持全局搜索和会话内搜索，同时支持搜索群组、用户和消息。**
 >
-
 > 此功能属于增值服务，需要您购买云端搜索插件，请点击 [购买](https://console.cloud.tencent.com/im/plugin/TUICloudSearch)。
 >
 
@@ -459,17 +462,16 @@ npm run dev
 
 ### 什么是 UserSig？如何生成 UserSig？
 
-UserSig 是用户登录即时通信 IM 的密码，其本质是对 UserID 等信息加密后得到的密文。UserSig 签发方式是需将 UserSig 的计算代码集成到您的服务端，并提供面向项目的接口，在需要 UserSig 时由您的项目向业务服务器发起请求获取动态 UserSig。更多详情请参见 [服务端生成 UserSig](https://cloud.tencent.com/document/product/269/32688)。
+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)。
 >
 
 ### 是否支持 react 17 版本？
 
-目前不支持 React v17.x，仅支持 React v18.2+ 以上的版本。
+目前不支持 React v17.x，仅支持 React v18.2+ 版本。
 
 ### 我能不能使用第三方组件库，例如 Ant-Design？
 

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

@@ -14,26 +14,26 @@ TUIKit 是一款基于腾讯云 IM SDK 和 UTS 原生渲染技术的 uni-app UI
 
 - **支持平台**： 仅支持打包为 Android / iOS App，不支持 H5 和小程序。
 
+- **支持项目**： uni-app 项目、uni-app x 项目。
+
    > **说明：**
    >
-
    > H5 和小程序项目，如有需要请参考以下替代方案：
    >
->   - 打包 Web H5，可参考：Web H5（Vue3）。
->   - 打包小程序，可参考：uni-app 完整版（Vue3/Vue2）。
->   - 接入过程中遇到任何卡点或有改进建议，欢迎通过 [UniApp Atomicx 接入体验反馈](https://wj.qq.com/s2/26120470/621d/) 反馈，官方会及时跟进处理。
+   > - 打包 Web H5，可参考：Web H5（Vue3）。
+   > - 打包小程序，可参考：uni-app 完整版（Vue3/Vue2）。
+   > - 接入过程中遇到任何卡点或有改进建议，欢迎通过 [UniApp Atomicx 接入体验反馈](https://wj.qq.com/s2/26120470/621d/) 反馈，官方会及时跟进处理。
 
 ## 集成步骤
 
 > **说明：**
 >
-
-> **Demo： **[GitHub 完整 Demo](https://github.com/Tencent-RTC/TUIKit_uni-app)开箱即用，5 分钟跑通聊天 + 音视频通话全功能。
+> **Demo：** [GitHub 完整 Demo](https://github.com/Tencent-RTC/TUIKit_uni-app) 开箱即用，5 分钟跑通聊天 + 音视频通话全功能。
 >
 
 ### 步骤1：创建项目
 
-打开 HBuilderX，在菜单栏中选择 “**文件 > 新建 > 项目**”，创建一个名为 `chat-example` 的 uni-app 项目。
+打开 HBuilderX，在菜单栏中选择 “**文件 > 新建 > 项目**”，创建一个名为 `chat-example` 的 uni-app / uni-app x 项目。
 
 ### 步骤2：安装 TUIKit 插件
 
@@ -41,28 +41,40 @@ TUIKit 是一款基于腾讯云 IM SDK 和 UTS 原生渲染技术的 uni-app UI
 
 ### 步骤3：配置原生模块与 Android 权限
 
+【uni-app 项目】
+
 > **说明：**
 >
-
-> `Camera` 、`Record`**、**`VideoPlayer` 模块用于聊天中的拍照、录音、视频播放功能。Android 权限用于录音、网络访问和文件存储。
+> `Camera` 、`Record`**、** `VideoPlayer` 模块用于聊天中的拍照、录音、视频播放功能。Android 权限用于录音、网络访问和文件存储。
 >
 
-1. **模块配置**。点击 `manifest.json` > 点击**安卓 / iOS 模块配置 **>  勾选 **Camera&Gallery（相机和相册）、Record（录音）、 VideoPlayer（视频播放）**。如图所示：
+1. **模块配置**。点击 `manifest.json` > 点击**安卓 / iOS 模块配置** >  勾选 **Camera&Gallery（相机和相册）、Record（录音）、 VideoPlayer（视频播放）**。如图所示：
 
-2. **配置 Android 相关权限**。点击 `manifest.json`> 点击**安卓 / iOS权限配置 **>  Android 云打包配置中配置如下权限。如图所示：
+2. **配置 Android 相关权限**。点击 `manifest.json`> 点击**安卓 / iOS权限配置** >  Android 云打包配置中配置如下权限。如图所示：
 
-   ``` bash
-   <uses-permission android:name="android.permission.RECORD_AUDIO" />
-   <uses-permission android:name="android.permission.INTERNET" />
-   <uses-permission android:name="android.permission.WRITE_EXTERNAL_STORAGE" />
-   <uses-permission android:name="android.permission.SYSTEM_ALERT_WINDOW"/>
-   <uses-permission android:name="android.permission.VIBRATE"/>
-   ```
+``` bash
+<uses-permission android:name="android.permission.RECORD_AUDIO" />
+<uses-permission android:name="android.permission.INTERNET" />
+<uses-permission android:name="android.permission.WRITE_EXTERNAL_STORAGE" />
+<uses-permission android:name="android.permission.SYSTEM_ALERT_WINDOW"/>
+<uses-permission android:name="android.permission.VIBRATE"/>
+```
+
+【uni-app x 项目】
+
+**配置 Android 相关权限**。点击 `manifest.json`> 点击**安卓 App 配置** >  权限配置中配置如下权限。如图所示：
+``` bash
+<uses-permission android:name="android.permission.RECORD_AUDIO" />
+<uses-permission android:name="android.permission.INTERNET" />
+<uses-permission android:name="android.permission.WRITE_EXTERNAL_STORAGE" />
+<uses-permission android:name="android.permission.SYSTEM_ALERT_WINDOW"/>
+<uses-permission android:name="android.permission.VIBRATE"/>
+```
 
 ### 步骤4：集成 TUIKit
-1. 根据项目 `manifest.json` > **基础配置** > **Vue 版本，**集成 TUIKit**。**
+1. **集成 TUIKit**：uni-app 项目根据 `manifest.json` > **基础配置** > **Vue 版本，**集成 TUIKit**。uni-app x 不区分 vue 版本。**
 
-【Vue3】
+【uni-app Vue3 项目】
 
 **拷贝 TUIKit 页面及静态资源**：将 `⁠uni_modules/tuikit-atomic-x/quickstart/`⁠下的`⁠pages/*⁠` 拷贝到项目 `page`⁠ 目录，⁠`static/*⁠` 拷贝到项目 `static` 目录下。
 
@@ -76,14 +88,13 @@ cp -r uni_modules/tuikit-atomic-x/quickstart/static/* static/ && cp -r uni_modul
 xcopy /E /I /Y "uni_modules\tuikit-atomic-x\quickstart\static\*" "static\" && xcopy /E /I /Y "uni_modules\tuikit-atomic-x\quickstart\pages\*" "pages\"
 ```
 
-【Vue2】
+【uni-app  Vue2 项目】
 1. **转换兼容模式：**仅 Vue2 项目，Vue3 项目可忽略**。**
 
-> **说明：**
->
-
-> 该脚本用于将插件源码中 Vue3 的 Composition API 写法自动转换为 Vue2 的 Options API 写法，以确保在 Vue2 项目中正常运行。
->
+   > **说明：**
+   >
+   > 该脚本用于将插件源码中 Vue3 的 Composition API 写法自动转换为 Vue2 的 Options API 写法，以确保在 Vue2 项目中正常运行。
+   >
 
 ``` bash
 node ./uni_modules/tuikit-atomic-x/scripts/switch-to-compatible-mode.js
@@ -100,7 +111,30 @@ cp -r uni_modules/tuikit-atomic-x/quickstart/static/* static/ && cp -r uni_modul
 xcopy /E /I /Y "uni_modules\tuikit-atomic-x\quickstart\static\*" "static\" && xcopy /E /I /Y "uni_modules\tuikit-atomic-x\quickstart\pages\*" "pages\"
 ```
 
-3. **配置页面路由：**替换 `pages.json` 内容，注册所需页面路由：
+【uni-app x 项目】
+1. **转换 uniappx 模式：**仅 uni-app x 项目，uni-app 项目可忽略**。**
+
+   > **说明：**
+   >
+   > 该脚本用于将插件中 nvue 组件转化为 uvue 组件。
+   >
+
+``` bash
+node ./uni_modules/tuikit-atomic-x/scripts/switch-to-uniappx-mode.js
+```
+2. **拷贝 TUIKit 页面及静态资源**：将 `⁠uni_modules/tuikit-atomic-x/quickstart/` ⁠下的 `⁠pages/*⁠` 拷贝到项目 `page`⁠ 目录，⁠`static/*⁠` 拷贝到项目 `static` 目录下。
+
+【Mac 端】
+``` bash
+cp -r uni_modules/tuikit-atomic-x/quickstart/static/* static/ && cp -r uni_modules/tuikit-atomic-x/quickstart/pages/* pages/
+```
+
+【Windows 端】
+``` bash
+xcopy /E /I /Y "uni_modules\tuikit-atomic-x\quickstart\static\*" "static\" && xcopy /E /I /Y "uni_modules\tuikit-atomic-x\quickstart\pages\*" "pages\"
+```
+
+2. **配置页面路由：**替换 `pages.json` 内容，注册所需页面路由：
 
    ``` json
    {
@@ -315,7 +349,6 @@ xcopy /E /I /Y "uni_modules\tuikit-atomic-x\quickstart\static\*" "static\" && xc
 
    > **说明：**
    >
-
    > 如需调整页面路由，请同步修改页面和 `uni_modules/tuikit-atomic-x/components` 中路由跳转逻辑。
    >
 
@@ -323,28 +356,26 @@ xcopy /E /I /Y "uni_modules\tuikit-atomic-x\quickstart\static\*" "static\" && xc
 
 > **说明：**
 >
-
 > 接入过程中遇到任何卡点或有改进建议，欢迎通过 [UniApp Atomicx 接入体验反馈](https://wj.qq.com/s2/26120470/621d/) 反馈，官方会及时跟进处理。
 >
 
-1. **制作自定义基座。**点击**运行 **> **运行到手机或模拟器 **> **制作自定义调试基座：**
+1. **制作自定义基座。**点击**运行** > **运行到手机或模拟器** > **制作自定义调试基座：**
 
    > **说明：**
    >
-
-   > 首次制作自定义基座需要下载 Gradle 依赖，Android 通常需要 10～20 分钟，iOS 需要 5～10 分钟，请耐心等待，请勿中断。
+   > 首次制作自定义基座需要下载 Gradle 依赖，Android 通常需要 10～20 分钟，iOS 需要 5～10 分钟。过程中请勿中断。
    >
 
-2. **登录。**在 `pages/login/login.vue` 中，填入 `SDKAppID`、 `SecretKey`，在登录页面输入 `userID`，点击登录。
+2. **登录。**在 `pages/login/login.vue` 中，填入 `SDKAppID`、 `userID`、`userSig`，点击登录。
 
 | 参数 | 类型 | 说明 |
 | --- | --- | --- |
 | SDKAppID | Number | SDKAppID 是腾讯云 IM 客户应用的唯一标识。您可以在 <a href="https://console.cloud.tencent.com/im">即时通信 IM 控制台</a> 创建新应用获取 。<br><strong>说明：</strong><br>SDKAppID 是腾讯云 IM 客户应用的唯一标识。我们建议每一个独立的 App 都申请一个新的 SDKAppID。不同 SDKAppID 之间的消息是天然隔离的，不能互通。 |
 | SecretKey | String | SecretKey 是腾讯云 IM 客户应用的密钥。您可以在 <a href="https://console.cloud.tencent.com/im">即时通信 IM 控制台</a> 对应应用获取。 |
 | userID | String | 用户的唯一标识符，由您定义，只能包含大小写字母（a-z，A-Z）、数字（0-9）、下划线和连字符。 |
-| userSig | String | 用户登录即时通信 IM 的密码，其本质是对 UserID 等信息加密后得到的密文。<br><strong>安全提示：</strong><br>- 本文示例代码通过 <code>genTestUserSig</code> 函数生成 <code>userSig</code>。该方法中 <code>SecretKey</code> 很容易被反编译逆向破解，一旦您的密钥泄露，攻击者就可以盗用您的腾讯云流量。<strong>该方法仅适合本地跑通功能调试</strong>。 正确的 UserSig 签发方式请参见 <a href="https://cloud.tencent.com/document/product/269/32688">服务端生成 UserSig</a>。<br>- 示例代码中的 UserSig 仅供测试使用，生产环境请通过 服务端生成。<br>- 敏感信息（UserSig/SecretKey）仅用于 Demo 测试，不可提交到代码仓库或用于生产环境。 |
+| userSig | String | 用户登录即时通信 IM 的密码，其本质是对 UserID 等信息加密后得到的密文。您可以在 <a href="https://console.cloud.tencent.com/im">即时通信 IM 控制台</a> 生成。<br><strong>安全提示：</strong><br>- uni-app Vue3、uni-app Vue2 项目示例支持通过 <code>genTestUserSig</code> 函数生成 <code>userSig</code>。该方法中 <code>SecretKey</code> 很容易被反编译逆向破解，一旦您的密钥泄露，攻击者就可以盗用您的腾讯云流量。<strong>该方法仅适合本地跑通功能调试</strong>。 正确的 UserSig 签发方式请参见 <a href="https://cloud.tencent.com/document/product/269/32688">服务端生成 UserSig</a>。<br>- uni-app x 项目不支持通过 <code>genTestUserSig</code> 函数生成 <code>userSig</code>。您可以在 <a href="https://console.cloud.tencent.com/im">即时通信 IM 控制台</a> 或者通过 服务端生成自行生成 userSig。<br>- 示例代码中的 UserSig 仅供测试使用，生产环境请通过 服务端生成。<br>- 敏感信息（UserSig/SecretKey）仅用于 Demo 测试，不可提交到代码仓库或用于生产环境。 |
 
-【vue3】
+【uni-app  vue3 项目】
 ``` typescript
 import { ref } from 'vue'
 import { useLoginState } from '@/uni_modules/tuikit-atomic-x/state/LoginState';
@@ -373,7 +404,7 @@ login({
 })
 ```
 
-【vue2】
+【uni-app vue2 项目】
 ``` typescript
 import { useLoginState } from '@/uni_modules/tuikit-atomic-x/state/LoginState'
 import { genTestUserSig } from '@/uni_modules/tuikit-atomic-x/debug/GenerateTestUserSig'
@@ -410,11 +441,41 @@ export default {
 }
 ```
 
-3. **运行项目。**点击**运行 **> **运行到手机或模拟器 **> **运行到 Android/iOS 基座**，使用制作好的**自定义基座**运行到手机。
+【uni-app x 项目】
+``` typescript
+import { useLoginState } from '@/uni_modules/tuikit-atomic-x/state/LoginState';
+const { login } = useLoginState();
+
+const sdkAppId = 0; // SDKAppID
+const userId = ref(''); // userID
+const userSig = ''; // userSig
+
+// 登录
+login({
+  sdkAppID: sdkAppId,
+  userID: userId.value,
+  userSig: userSig,
+  success: () => {
+    uni.reLaunch({ url: '/pages/scenes/chat/conversationList/conversationList' })
+  },
+  fail: (code: number, msg: string) => {
+    uni.showToast({ title: msg || '登录失败', icon: 'none' })
+  }
+})
+
+```
+
+3. **运行项目。**点击**运行** > **运行到手机或模拟器** > **运行到 Android/iOS 基座**，使用制作好的**自定义基座**运行到手机。
 
 ## 集成音视频通话（推荐）
 
 **初始化 TUICallKit 服务。**在根目录下的 `App.vue` 中引入如下代码。
+
+> **说明：**
+>
+> TUICallKit 暂不支持 uni-app x 项目**，仅支持 uni-app 项目。**
+>
+
 ``` typescript
 import { initCallService } from '@/uni_modules/tuikit-atomic-x/server/callService';
 initCallService();
@@ -432,7 +493,7 @@ A：**不支持。**由于新版 TUIKit 基于 **UTS (Uni-app Type Script)** 插
 
 A：**不支持。**新版 TUIKit 基于 **UTS（Uni-app Type Script）**插件架构开发，其底层为**原生 SDK**，数据通过 hybridApi 进行交互，因此无法获取 **Chat 实例**。
 
-#### **Q：我的现有项目全是 **`.vue`** 页面（Webview 渲染），能直接集成吗？**
+#### **Q：我的现有项目全是** `.vue` **页面（Webview 渲染），能直接集成吗？**
 
 A：**可以混用，但需要注意页面模式。**
 
@@ -454,7 +515,7 @@ nvue 页面中：
 
 3. 不支持简写属性（例如 `margin: 10px 20px`），必须写全（`margin-top`, `margin-left` 等）。
 
-4. 更多参考信息：[uni-app-nvue 开发与 vue 开发的常见区别](https://uniapp.dcloud.net.cn/tutorial/page.html#nvue-%E5%BC%80%E5%8F%91%E4%B8%8E-vue-%E5%BC%80%E5%8F%91%E7%9A%84%E5%B8%B8%E8%A7%81%E5%8C%BA%E5%88%AB)。
+4. 更多参考信息：[uni-app-nvue 开发与 Vue 开发的常见区别](https://uniapp.dcloud.net.cn/tutorial/page.html#nvue-%E5%BC%80%E5%8F%91%E4%B8%8E-vue-%E5%BC%80%E5%8F%91%E7%9A%84%E5%B8%B8%E8%A7%81%E5%8C%BA%E5%88%AB)。
 
 ### 集成与构建类
 
@@ -463,7 +524,7 @@ nvue 页面中：
 A：请检查是否制作并使用了**自定义调试基座**。
 
 由于插件包含原生代码（Java/Objective-C），标准基座不包含这些原生库。
-- **解决步骤：** 请严格按照文档“运行和测试-步骤2”操作，在 HBuilderX 中点击 **运行 **> **运行到手机或模拟器 **> **制作自定义调试基座**。制作完成后，运行时请务必选择**运行到 Android/iOS 基座**，并勾选“使用自定义基座”。
+- **解决步骤：** 请严格按照文档“运行和测试-步骤2”操作，在 HBuilderX 中点击 **运行** > **运行到手机或模拟器** > **制作自定义调试基座**。制作完成后，运行时请务必选择**运行到 Android/iOS 基座**，并勾选“使用自定义基座”。
 
 #### **Q：制作自定义基座时一直失败或卡顿怎么办？**