@tencentcloud/sdk-mcp 1.0.2 → 1.0.4

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

@@ -0,0 +1,344 @@
+## 常见问题
+
+### 1. 音视频相关问题如何解决？
+
+请单击 [音视频通话 > 常见问题](https://write.woa.com/document/174907394083565568) 查看解决方案。
+
+### **2. **我只想集成聊天窗口，如何单独集成 TUIChat？如果直接打开指定单聊/群聊会话？
+
+独立集成聊天窗口，请参见 [TUIChat 独立集成方案](https://cloud.tencent.com/document/product/269/96740)。
+
+### 3. js 工程如何接入 TUIKit 组件?
+
+TUIKit 仅支持 ts 环境运行，您可以通过渐进式配置 typescript 来使您项目中已有的 js 代码 与 TUIKit 中 ts 代码共存。
+
+
+
+【vue-cli】
+
+请在您 vue-cli 脚手架创建的工程根目录执行：
+``` bash
+vue add typescript
+```
+
+之后按照如下进行配置项进行选择（为了保证能同时支持原有 js 代码 与 TUIKit 中 ts 代码，请您务必严格按照以下五个选项进行配置）
+
+![](https://write-document-release-1258344699.cos.ap-guangzhou.tencentcos.cn/100027119864/cf35699a9fdd11ef992f52540075b605.png)
+
+
+> **注意：**
+> 
+
+> 完成以上步骤后，请重新运行项目！
+> 
+
+
+【vite】
+
+请在您 vite 创建的工程根目录执行：
+``` bash
+npm install -D typescript
+```
+
+### 4. 什么是 UserSig？如何生成 UserSig？
+
+UserSig 是用户登录即时通信 IM 的密码，其本质是对 UserID 等信息加密后得到的密文。
+
+UserSig 签发方式是将 UserSig 的计算代码集成到您的服务端，并提供面向项目的接口，在需要 UserSig 时由您的项目向业务服务器发起请求获取动态 UserSig。更多详情请参见 [服务端生成 UserSig](https://cloud.tencent.com/document/product/269/32688#console)。
+
+> **注意**
+> 
+
+> 本文示例代码采用的获取 UserSig 的方案是在客户端代码中配置 SECRETKEY，该方法中 SECRETKEY 很容易被反编译逆向破解，一旦您的密钥泄露，攻击者就可以盗用您的腾讯云流量，因此**该方法仅适合本地跑通功能调试**。 正确的 UserSig 签发方式请参见上文。
+> 
+
+
+### 5. 运行时报错："TypeError: Cannot read properties of undefined (reading "getFriendList")"
+
+若按照上述步骤接入后，运行时出现以下错误，请您务必**删除 TUIKit 目录下的 node_modules 目录**，以保证 TUIKit 的依赖唯一性，避免 TUIKit 多份依赖造成问题。
+
+![](https://write-document-release-1258344699.cos.ap-guangzhou.tencentcos.cn/100027119864/cf4284fc9fdd11efa04c5254002693fd.png)
+
+
+### 6. 运行时报错：/chat-example/src/TUIKit/components/TUIChat /message-input/message-input-editor.vue .ts（8，23）TS1005: expected.
+
+![](https://write-document-release-1258344699.cos.ap-guangzhou.tencentcos.cn/100027119864/cf40e8b09fdd11ef820f525400d5f8ef.png)
+
+
+出现以上报错信息，是因为您安装的 @vue/cli 版本过低导致，**请您务必保证您的 @vue/cli 版本在 5.0.0 及以上**。升级方式如下：
+``` javascript
+npm install -g @vue/cli@5.0.8
+```
+
+### 7. 运行时报错: Failed to resolve loader: sass-loader
+
+![](https://write-document-release-1258344699.cos.ap-guangzhou.tencentcos.cn/100027119864/cf36f9819fdd11efa646525400329841.png)
+
+
+出现以上报错信息，是因为您未安装 `sass` 环境导致，请执行以下命令进行 `sass`环境安装:
+``` javascript
+npm i -D sass sass-loader@10.1.1
+```
+
+### 8.  ESLint 报错：error  'withDefaults' is not defined  no-undef? 'defineProps' is not defined   no-undef? 以及 ESLint 其他报错？
+
+![](https://write-document-release-1258344699.cos.ap-guangzhou.tencentcos.cn/100027119864/cf44d4f59fdd11efa646525400329841.png)
+
+
+**若 chat-uikit-vue 拷贝到 src 目录汇总与您本地项目代码风格不一致导致报错，可将本组件目录屏蔽，如在项目根目录增加 .eslintignore 文件：**
+``` javascript
+# .eslintignore
+src/TUIKit
+```
+
+### 9. vue/cli 如何关闭 dev 模式下，webpack 全屏 overlay error 报错信息提示？
+
+可以在您项目根目录的 vue.config.js 中进行关闭：
+
+
+
+【webpack4】
+``` javascript
+module.exports = defineConfig({
+  ...
+  devServer: {
+    client: {
+      overlay: false,
+    },
+  },
+});
+```
+
+【webpack3】
+``` javascript
+module.exports = {
+  ...
+  devServer: {
+    overlay: false,
+  },
+};
+```
+
+### 10. 出现 Component name "XXXX" should always be multi-word 怎么办？
+- IM TUIKit web 所使用的 ESLint 版本为 v6.7.2 ，对于模块名的驼峰式格式并不进行严格校验。
+
+- 如果您出现此问题，您可以在 .eslintrc.js 文件中进行如下配置：
+
+   
+   
+   【shell】
+   ``` bash
+     module.exports = {
+       ...
+       rules: {
+           ...
+           'vue/multi-word-component-names': 'warn',
+       },
+     };
+   ```
+
+### 11. 出现 ERESOLVE unable to resolve dependency tree 怎么办？
+
+npm install 的时候如果出现 ERESOLVE unable to resolve dependency tree ，表示依赖安装冲突，可采用以下方式进行安装：
+
+
+【shell】
+``` bash
+npm install --legacy-peer-deps
+```
+
+### 12. 运行报错如下'vue packages version mismatch',如何解决？
+- 如果您是 vue2.7 项目，请在您项目根目录执行：
+
+   ``` bash
+     npm i vue@2.7.9 vue-template-compiler@2.7.9
+   ```
+- 如果您是 vue2.6 项目，请在您项目根目录执行：
+
+   ``` bash
+   npm i vue@2.6.14 vue-template-compiler@2.6.14
+   ```
+
+### 13. vite 项目 npm run build 之后 ts 报错?
+
+![](https://write-document-release-1258344699.cos.ap-guangzhou.tencentcos.cn/100027119864/cf4ddd8c9fdd11efa04c52540055f650.png)
+
+
+**原因**：package.json script 下 "build": "vue-tsc && vite build" 中的 vue-tsc 命令导致。
+
+![](https://write-document-release-1258344699.cos.ap-guangzhou.tencentcos.cn/100027119864/cf42f0769fdd11efa0b3525400bdab9d.png)
+
+
+**解决方案**: 删除 vue-tsc 即可。 "build": "vite build"
+
+![](https://write-document-release-1258344699.cos.ap-guangzhou.tencentcos.cn/100027119864/cf34e0079fdd11efa0b3525400bdab9d.png)
+
+
+### 14. 使用 pnpm 下载缺少依赖?
+
+`pnpm` 安装 `@tencentcloud/chat-uikit-vue` 后拷贝到 TUIKit 目录使用会存在内部依赖缺失问题，建议您优先选择 `npm` / `yarn` 方式安装。
+
+若您确实需要使用 pnpm 安装依赖，请在进行完上文接入步骤后：
+1. 将 `node_modules/@tencentcloud/chat-uikit-vue/package.json` 中的依赖项拷贝到您自身项目根目录 `package.json` 中。
+
+2. 运行 `pnpm i` ， 进行内部缺失依赖安装。
+
+
+### 15. H5 页面 iOS 低版本机型出现白屏?
+
+您可以通过配置 polyfill 兼容低机型版本。（什么是 polyfill？polyfill 是一种用于解决浏览器兼容问题的技术。它用于模拟某些浏览器不支持的新特性，使得这些特性能在不支持的浏览器中正常工作。更多详情请参见 [babel-polyfill](https://babeljs.io/docs/babel-polyfill)。）
+1. 安装 babel-polyfill：
+
+   ``` bash
+   npm i @babel/polyfill
+   ```
+2. 入口文件引入 'babel-polyfill'：
+
+   ``` javascript
+   import 'babel-polyfill';
+   ```
+3. 新增 babel.config.js 配置
+
+   ``` javascript
+   module.exports = {
+     presets: [
+       [
+         '@vue/cli-plugin-babel/preset',
+         {
+           useBuiltIns: 'entry',
+           corejs: 3,
+         },
+       ],
+       [
+         '@babel/preset-env',
+         {
+           targets: {
+             browsers: ['iOS >= 11'],
+           },
+           useBuiltIns: 'entry',
+           corejs: 3,
+         },
+       ],
+     ],
+   };
+   ```
+
+### 
+
+### 16. 运行报错：Uncaught TypeError: marked__WEBPACK_IMPORTED_MODULE_0_ Marked is not a constructor，如何处理？
+
+如果您运行过程中出现如下错误，说明您当前 Vue CLI构建的项目环境版本较低，需要降低 uikit 中使用的 marked 版本至 5.1.2。
+
+![](https://write-document-release-1258344699.cos.ap-guangzhou.tencentcos.cn/100027119864/6acef150b3b911ef8b1b525400f69702.png)
+
+
+请在您项目的**根目录**使用以下脚本降低 marked 版本：
+``` bash
+npm i marked@5.1.2 --legacy-peer-deps
+```
+
+### 
+
+### 17. 编译报错 node_modules/marked/lib/marked.esm.js: Class private methods are not enabled，如何处理？
+
+如果您运行过程中出现如下错误，说明您当前使用的 marked 版本过低，请升级 marked 版本至 6.0.0。
+
+![](https://write-document-release-1258344699.cos.ap-guangzhou.tencentcos.cn/100027119864/6ac6f829b3b911ef9d2952540055f650.png)
+
+请在您项目的** 根目录 **使用以下脚本降低 marked 版本：
+``` bash
+npm i marked@6.0.0 --legacy-peer-deps
+```
+
+### 
+
+### 18. 运行报错 Uncaught SyntaxError: The requested module xxx does not provide an export named 'Friend'
+
+如果您的 vite 项目运行过程中出现以下报错，请参见以下方案：
+
+![](https://write-document-release-1258344699.cos.ap-guangzhou.tencentcos.cn/100027119864/38586a0ec72711efb8ca5254007c27c5.png)
+
+
+在根目录文件 `tsconfig.json` 下增加以下编译规则，分为以下两种情况：
+1. 如果您的 `tsconfig.json` 没有 `references` 配置，直接在 tsconfig.json 中配置如下规则：
+
+
+   
+
+
+【typescript ≥ 5.0.0】
+``` json
+{
+  ...
+  "compilerOptions": {
+    ...
+    "verbatimModuleSyntax": false,
+  }
+}
+```
+
+
+【typescript < 5.0.0】
+``` json
+{
+  ...
+  "compilerOptions": {
+    ...
+    "importsNotUsedAsValues": "preserve",
+  }
+}
+```
+
+2. 如果您的 `tsconfig.json` 已有 `references` 配置，比如 vite 官方自动配置的 `"./tsconfig.app.json"`，`"./tsconfig.node.json" `等，由于 `references` 的特性，导致 `tsconfig.json `本身只是规则的引用文件，此时直接在 `tsconfig.json` 中配置以下规则无效。需要将规则添加至实际的`references`对应的文件中。以下是具体示例：
+
+<table>
+<tr>
+<td rowspan="1" colSpan="1" >错误写法</td>
+
+<td rowspan="1" colSpan="1" >正确写法</td>
+</tr>
+
+<tr>
+<td rowspan="1" colSpan="1" >当 tsconfig.json 文件中已有 references 相关配置时，直接在 tsconfig.json 中声明以下规则无效</td>
+
+<td rowspan="1" colSpan="1" >当 tsconfig.json 文件中已有 references 相关配置时，需要在对应的 references 内部文件中声明以下规则。下文中是在  references  中配置的根目录 `tsconfig.app.json` 文件中配置以下规则。</td>
+</tr>
+
+<tr>
+<td rowspan="1" colSpan="1" >![](https://write-document-release-1258344699.cos.ap-guangzhou.tencentcos.cn/100027119864/38631967c72711efb8ca5254007c27c5.png)</td>
+
+<td rowspan="1" colSpan="1" >![](https://write-document-release-1258344699.cos.ap-guangzhou.tencentcos.cn/100027119864/38641d65c72711efb8ca5254007c27c5.png)</td>
+</tr>
+</table>
+
+
+### 
+
+### 19. 编译后 Sass waring：Deprecation Warning: The legacy JS API is deprecated and will be removed in Dart Sass 2.0.0.
+
+如果您在运行后出现如下提示，请不要担心，这是 sass 大版本规则更新后的 warning 提示；该提醒并不会影响您的正常运行。
+
+如果您想去除此类 warning 提示，请将 sass 版本降级至 1.77.4 及以下。
+
+![](https://write-document-release-1258344699.cos.ap-guangzhou.tencentcos.cn/100027119864/38574a57c72711ef82565254005ef0f7.png)
+
+``` bash
+npm i -D sass@1.77.0 sass-loader@10.1.1
+```
+
+## 相关文档
+
+#### Vue2 & Vue3 UIKit 相关：
+- [集成音视频通话](https://cloud.tencent.com/document/product/269/79861)
+
+- [chat-uikit-vue npm](https://www.npmjs.com/package/@tencentcloud/chat-uikit-vue)
+
+- [Vue2 Demo源码及跑通示例](https://github.com/TencentCloud/chat-uikit-vue/tree/main/Vue2/Demo)
+
+- [Vue3 Demo源码及跑通示例](https://github.com/TencentCloud/chat-uikit-vue/tree/main/Vue3/Demo)
+
+
+#### Vue2 & Vue3 UIKit 逻辑层: engine 相关
+- [chat-uikit-engine npm 仓库](https://www.npmjs.com/package/@tencentcloud/chat-uikit-engine)
+
+- [chat-uikit-engine 接口文档](https://web.sdk.qcloud.com/im/doc/chat-engine/index.html)

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

@@ -0,0 +1,118 @@
+### 用 Taro 开发项目，集成 WebIM v2.x，为什么一直收不到 TIM.EVENT.SDK_READY 事件？
+
+WebIM v2.x 不需要被 Taro 编译。如果您通过 `npm i` 的方式集成了 WebIM，请手动将文件 `node_modules/tim-js-sdk/tim-js.js` 或 `node_modules/tim-wx-sdk/tim-wx.js` 拷贝到您项目的 src 目录下，并在配置文件中配置（更详细的请参见 [编译配置详情](https://nervjs.github.io/taro/docs/config-detail.html#weappcompileexclude)）。
+示例：
+
+
+【js】
+``` bash
+weapp: {
+  compile: {
+    exclude: ['src/tencent-webim/tim-wx.js']
+  }
+}
+
+```
+
+### 为什么调用 off 接口取消监听事件后，仍然能监听到 SDK 派发的事件？
+
+对于同一个事件，如 [TIM.EVENT.MESSAGE_RECEIVED](https://web.sdk.qcloud.com/im/doc/zh-cn/module-EVENT.html#.MESSAGE_RECEIVED)，调用 [on](https://web.sdk.qcloud.com/im/doc/zh-cn/SDK.html#on) 接口监听事件和调用 [off](https://web.sdk.qcloud.com/im/doc/zh-cn/SDK.html#off) 接口取消监听事件，handler 参数应当指向同一个 function，避免以下写法：
+
+
+【js】
+``` bash
+// 注意！以下代码有 bug，无法取消监听 TIM.EVENT.MESSAGE_RECEIVED，因为 bind() 方法每次会返回一个新的函数
+tim.on(TIM.EVENT.MESSAGE_RECEIVED, this.onMessageReceived.bind(this));
+tim.off(TIM.EVENT.MESSAGE_RECEIVED, this.onMessageReceived.bind(this));
+
+// 建议写法
+tim.on(TIM.EVENT.MESSAGE_RECEIVED, onMessageReceived, this);
+tim.off(TIM.EVENT.MESSAGE_RECEIVED, onMessageReceived);
+
+```
+
+> **说明**
+> 
+
+> bind() 方法的详细说明请参见 [Function.prototype.bind()](https://developer.mozilla.org/zh-CN/docs/Web/JavaScript/Reference/Global_Objects/Function/bind)
+> 
+
+
+### 调用 logout 接口，SDK 会自动取消监听接入侧通过调用 on 接口已监听的事件吗？
+
+不会。取消监听事件，需接入侧主动调用 [off](https://web.sdk.qcloud.com/im/doc/zh-cn/SDK.html#off) 接口。
+
+### 登录时遇到 Err_TLS_Third_Sig_Check_Session_Key_Too_Long 的提示？
+
+密钥问题导致生成的 UserSig 鉴权失败。请参见 [生成 UserSig](https://cloud.tencent.com/document/product/269/32688)。
+
+### 登录时遇到 TypeError: wx.$app.ready is not a function？
+
+请通过监听事件 [TIM.EVENT.SDK_READY](https://web.sdk.qcloud.com/im/doc/zh-cn/module-EVENT.html#.SDK_READY) 代替直接使用 ready 函数，后者已经废弃。
+
+### 登录成功后不能发送消息，提示接口调用时机不合理？
+
+请监听事件 [TIM.EVENT.SDK_READY](https://web.sdk.qcloud.com/im/doc/zh-cn/module-EVENT.html#.SDK_READY)，待 SDK ready 后再调用发送消息等需要鉴权的接口。
+
+### WebIM v2.x 怎样拉取历史消息？没有 getC2CHistoryMsgs 接口了吗？
+
+WebIM v2.x 没有 getC2CHistoryMsgs 接口，[getMessageList](https://web.sdk.qcloud.com/im/doc/zh-cn/SDK.html#getMessageList) 接口可用于"拉取历史消息"。
+
+### 我想在音视频聊天室实现点赞，送鲜花的功能，请问该怎么办？
+
+可以通过 [createCustomMessage](https://web.sdk.qcloud.com/im/doc/zh-cn/SDK.html#createCustomMessage) 和 [sendMessage](https://web.sdk.qcloud.com/im/doc/zh-cn/SDK.html#sendMessage) 接口实现。
+
+### WebIM v2.x 和 WebIM v1.7.x 消息是互通的吗？
+
+互通。如果条件允许，建议接入使用最新的 WebIM，获得更好的体验和维护。
+
+### WebIM v2.x 如何兼容 REST API 或 旧版 IM 发送的组合消息？
+
+请升级 SDK 版本至 2.1.3 或更高版本。组合消息的内容存储在 Message 实例的 _elements 属性，接入侧需自主解析，解析请参见 [消息格式](https://cloud.tencent.com/document/product/269/2720)。
+非组合消息，请使用推荐做法：使用 [Message](https://web.sdk.qcloud.com/im/doc/zh-cn/Message.html) 实例的 type 和 payload 属性。
+
+### 为什么 WebIM v2.x 调用 sendMessage发消息成功后，未收到 TIM.EVENT.MESSAGE_RECEIVED 事件？
+
+[sendMessage](https://web.sdk.qcloud.com/im/doc/zh-cn/SDK.html#sendMessage) 接口返回 `Promise`，接入侧请通过 `Promise.then` 或 `Promise.catch` 处理发送消息成功或失败后的业务逻辑。
+此时 SDK 不会派发 [TIM.EVENT.MESSAGE_RECEIVED](https://web.sdk.qcloud.com/im/doc/zh-cn/module-EVENT.html#.MESSAGE_RECEIVED) 事件，避免消息重复。
+
+### 通过 getMessageList 拉取到的消息列表和通过监听 TIM.EVENT.MESSAGE_RECEIVED 事件收到的消息合并后，发现有时会消息乱序，为什么？
+
+接入侧维护会话的消息列表时，请注意保证消息入列的顺序正确，若消息列表从旧到新排列，则通过 [getMessageList](https://web.sdk.qcloud.com/im/doc/zh-cn/SDK.html#getMessageList) 拉取到的历史消息应该从头部入列，通过监听 [TIM.EVENT.MESSAGE_RECEIVED](https://web.sdk.qcloud.com/im/doc/zh-cn/module-EVENT.html#.MESSAGE_RECEIVED) 事件收到的实时消息应该从尾部入列。
+
+### 调用 createGroup 接口创建音视频聊天室后，收不到消息？
+
+调用 [createGroup](https://web.sdk.qcloud.com/im/doc/zh-cn/SDK.html#createGroup) 接口创建音视频聊天室后，需调用 [joinGroup](https://web.sdk.qcloud.com/im/doc/zh-cn/SDK.html#joinGroup) 接口加入群组（必须带上类型 TIM.TYPES.GRP_AVCHATROOM），才能进行消息收发流程。
+
+
+【js】
+``` bash
+let promise = tim.joinGroup({ groupID: 'group1', type: TIM.TYPES.GRP_AVCHATROOM });
+promise.then(function(imResponse) {
+  switch (imResponse.data.status) {
+    case TIM.TYPES.JOIN_STATUS_WAIT_APPROVAL: // 等待管理员同意
+      break;
+    case TIM.TYPES.JOIN_STATUS_SUCCESS: // 加群成功
+      console.log(imResponse.data.group); // 加入的群组资料
+      break;
+    case TIM.TYPES.JOIN_STATUS_ALREADY_IN_GROUP: // 已经在群中
+      break;
+    default:
+      break;
+    }
+  }).catch(function(imError){
+    console.warn('joinGroup error:', imError); // 申请加群失败的相关信息
+});
+
+```
+
+### 音视频聊天室怎么没有未读消息计数？为什么拉取不到历史消息？
+
+已定的产品策略：音视频聊天室不支持未读消息计数，也不支持查看入群前历史消息，详细请参见 [群组系统](https://cloud.tencent.com/document/product/269/1502)。
+**旗舰版或企业版**支持直播群新成员查看入群前历史消息（SDK 请升级到v2.16.0或更高版本）。
+
+### 可以同时加入两个或多个音视频聊天室吗？
+
+目前不可以。同一用户同时只能加入一个音视频聊天室。
+**示例**：用户已在音视频聊天室 A 中，再加入音视频聊天室 B，SDK 会先退出音视频聊天室 A，然后加入音视频聊天室 B。
+详细请参见 [joinGroup](https://web.sdk.qcloud.com/im/doc/zh-cn/SDK.html#joinGroup)。