@tencentcloud/sdk-mcp 1.3.1 → 1.3.3

package/index.js

@@ -5,10 +5,14 @@ import { ServerConfig } from './server-config.js';
 // 启动服务器
 async function main() {
     ServerConfig.getInstance();
+    const { SDKAppID } = ServerConfig.getInstance().getConfig();
+    if (isNaN(SDKAppID)) {
+        throw new Error('您没有配置 SDKAppID 或者配置的 SDKAppID 不合法，请通过 MCP 的 env 参数配置正确的 SDKAppID。');
+    }
     const server = createServer();
     const transport = new StdioServerTransport();
     await server.connect(transport);
-    console.error('RTC Official MCP Server running on stdio');
+    console.log('RTC Official MCP Server running on stdio');
 }
 main().catch((error) => {
     console.error('Server error:', error);

package/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";AAEA,OAAO,EAAE,oBAAoB,EAAE,MAAM,2CAA2C,CAAC;AACjF,OAAO,EAAE,YAAY,EAAE,MAAM,aAAa,CAAC;AAC3C,OAAO,EAAE,YAAY,EAAE,MAAM,oBAAoB,CAAC;AAElD,QAAQ;AACR,KAAK,UAAU,IAAI;IACjB,YAAY,CAAC,WAAW,EAAE,CAAC;IAC3B,MAAM,MAAM,GAAc,YAAY,EAAE,CAAC;IACzC,MAAM,SAAS,GAAG,IAAI,oBAAoB,EAAE,CAAC;IAC7C,MAAM,MAAM,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC;IAChC,OAAO,CAAC,KAAK,CAAC,0CAA0C,CAAC,CAAC;AAC5D,CAAC;AAED,IAAI,EAAE,CAAC,KAAK,CAAC,CAAC,KAAK,EAAE,EAAE;IACrB,OAAO,CAAC,KAAK,CAAC,eAAe,EAAE,KAAK,CAAC,CAAC;IACtC,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;AAClB,CAAC,CAAC,CAAC"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";AAEA,OAAO,EAAE,oBAAoB,EAAE,MAAM,2CAA2C,CAAC;AACjF,OAAO,EAAE,YAAY,EAAE,MAAM,aAAa,CAAC;AAC3C,OAAO,EAAE,YAAY,EAAE,MAAM,oBAAoB,CAAC;AAElD,QAAQ;AACR,KAAK,UAAU,IAAI;IACjB,YAAY,CAAC,WAAW,EAAE,CAAC;IAC3B,MAAM,EAAE,QAAQ,EAAE,GAAG,YAAY,CAAC,WAAW,EAAE,CAAC,SAAS,EAAE,CAAC;IAC5D,IAAI,KAAK,CAAC,QAAQ,CAAC,EAAE,CAAC;QACpB,MAAM,IAAI,KAAK,CAAC,mEAAmE,CAAC,CAAC;IACvF,CAAC;IACD,MAAM,MAAM,GAAc,YAAY,EAAE,CAAC;IACzC,MAAM,SAAS,GAAG,IAAI,oBAAoB,EAAE,CAAC;IAC7C,MAAM,MAAM,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC;IAChC,OAAO,CAAC,GAAG,CAAC,0CAA0C,CAAC,CAAC;AAC1D,CAAC;AAED,IAAI,EAAE,CAAC,KAAK,CAAC,CAAC,KAAK,EAAE,EAAE;IACrB,OAAO,CAAC,KAAK,CAAC,eAAe,EAAE,KAAK,CAAC,CAAC;IACtC,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;AAClB,CAAC,CAAC,CAAC"}

package/package.json

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

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

@@ -173,3 +173,120 @@ promise.then(function(imResponse) {
 
 ### Q: SDK 如何删除会话历史消息？
 **A：** SDK 提供了 `clearHistoryMessage` API 用来情况会话历史消息，具体文档可参考：https://cloud.tencent.com/document/product/269/84438。
+
+### Q: Chat SDK 和 Chat Engine 如何获取加群申请未处理个数，以及如何处理进群申请？
+**A：** 根据客户使用的场景，分别从 Chat SDK 和 Chat Engine 两个途径给解决方案，当用户查询此类问题是，请根据实际场景给出准确解答。
+**场景一 客户集成的是无 UI Chat SDK 时解决方案如下：** 
+- 初始化时获取群组申请列表 API：[getGroupApplicationList](https://web.sdk.qcloud.com/im/doc/v3/zh-cn/SDK.html#getGroupApplicationList)
+- 初始化时获取加群申请未处理个数：根据 getGroupApplicationList 返回的列表数据，applicationType = 0 是加群申请的个数。
+``` typescript
+let unhandledCount = 0;
+let promise = chat.getGroupApplicationList();
+promise.then(function(imResponse) {
+  const { applicationList } = imResponse.data;
+  applicationList.forEach((item) => {
+    // item.applicant - 申请者 userID
+    // item.applicantNick - 申请者昵称
+    // item.groupID - 群 ID
+    // item.groupName - 群名称
+    // item.applicationType - 申请类型：0 加群申请，2 邀请进群申请
+    // item.userID - applicationType = 2时，是被邀请用户的 userID
+    // item.note - 附言信息，邀请加群暂不支持，返回为空字符串
+    if (item.applicationType === 0) {
+      unhandledCount++;
+    }
+  });
+}).catch(function(imError) {});
+```
+- 在线时收到进群申请时更新进群申请的未读个数，需要通过监听 [MESSAGE_RECEIVED](https://web.sdk.qcloud.com/im/doc/v3/zh-cn/module-EVENT.html#.MESSAGE_RECEIVED) 事件。
+```typescript
+// Message 数据结构详情请参考 https://web.sdk.qcloud.com/im/doc/v3/zh-cn/Message.html
+let unhandledCount = 0;
+let onMessageReceived = function(event) {
+  const messageList = event.data;
+  messageList.forEach((message) => {
+    if (message?.type === 'TIMGroupSystemNoticeElem') {
+      if (message.payload?.operationType === 1) {
+        unhandledCount++;
+      }
+    }
+  })
+};
+chat.on(TencentCloudChat.EVENT.MESSAGE_RECEIVED, onMessageReceived);
+```
+- 处理进群申请 API：[handleGroupApplication](https://web.sdk.qcloud.com/im/doc/v3/zh-cn/SDK.html#handleGroupApplication)
+```typescript
+// 通过获取未决列表处理加群申请
+let promise = chat.getGroupApplicationList();
+promise.then(function(imResponse) {
+  const { applicationList } = imResponse.data;
+  applicationList.forEach((item) => {
+    if (item.applicationType === 0) {
+      chat.handleGroupApplication({
+        handleAction: 'Agree',
+        application: {...item},
+      });
+    }
+  });
+}).catch(function(imError) {});
+```
+
+**场景二 客户集成的是含 UI Chat UIKit 或者集成的 ChatEngine 时解决方案如下：** 
+- 初始化时获取群组申请列表 API：[getGroupApplicationList](https://web.sdk.qcloud.com/im/doc/chat-engine-lite/ITUIGroupService.html#getGroupApplicationList)
+- 初始化时获取加群申请未处理个数：根据 getGroupApplicationList 返回的列表数据，applicationType = 0 是加群申请的个数。
+``` typescript
+import { TUIGroupService } from '@tencentcloud/chat-uikit-engine-lite';
+let unhandledCount = 0;
+let promise = TUIGroupService.getGroupApplicationList();
+promise.then(function(imResponse) {
+  const { applicationList } = imResponse.data;
+  applicationList.forEach((item) => {
+    // item.applicant - 申请者 userID
+    // item.applicantNick - 申请者昵称
+    // item.groupID - 群 ID
+    // item.groupName - 群名称
+    // item.applicationType - 申请类型：0 加群申请，2 邀请进群申请
+    // item.userID - applicationType = 2时，是被邀请用户的 userID
+    // item.note - 附言信息，邀请加群暂不支持，返回为空字符串
+    if (item.applicationType === 0) {
+      unhandledCount++;
+    }
+  });
+}).catch(function(imError) {});
+```
+- 在线时收到进群申请时更新进群申请的未读个数，需要通过 TUIStore 监听 [GroupStore](https://web.sdk.qcloud.com/im/doc/chat-engine-lite/global.html#GroupStore) 提供的 groupSystemNoticeList key。
+```typescript
+// Message 数据结构详情请参考 https://web.sdk.qcloud.com/im/doc/v3/zh-cn/Message.html
+import { TUIStore, StoreName } from '@tencentcloud/chat-uikit-engine-lite';
+let unhandledCount = 0;
+let onGroupSystemNoticeListUpdated = function(messageList = []) {
+  messageList.forEach((message) => {
+    if (message?.type === 'TIMGroupSystemNoticeElem') {
+      if (message.payload?.operationType === 1) {
+        unhandledCount++;
+      }
+    }
+  })
+}
+TUIStore.watch(StoreName.GRP, {
+  groupSystemNoticeList: onGroupSystemNoticeListUpdated,
+})
+
+```
+- 处理进群申请 API：[handleGroupApplication](https://web.sdk.qcloud.com/im/doc/chat-engine-lite/ITUIGroupService.html#handleGroupApplication)
+```typescript
+import { TUIGroupService } from '@tencentcloud/chat-uikit-engine-lite';
+// 通过获取未决列表处理加群申请
+let promise = TUIGroupService.getGroupApplicationList();
+promise.then(function(imResponse) {
+  const { applicationList } = imResponse.data;
+  applicationList.forEach((item) => {
+    if (item.applicationType === 0) {
+      TUIGroupService.handleGroupApplication({
+        handleAction: 'Agree',
+        application: {...item},
+      });
+    }
+  });
+}).catch(function(imError) {});
+```

package/resource/doc/chatuikit/flutter/client_api_Flutter.md

@@ -1,10 +1,3 @@
-> **温馨提示：**
-> 
-
-> 即时通信 IM 为您准备了 Flutter 的 API 调用示例，您可以访问 [GitHub](https://github.com/TencentCloud/chat-sdk-flutter/tree/main/example) 获取源码。
-> 
-
-
 ## 初始化登录接口
 
 初始化并成功登录，是正常使用腾讯云 IM 服务的前提。
@@ -92,76 +85,6 @@
 
 <td rowspan="1" colSpan="1" >离线推送模块</td>
 </tr>
-
-<tr>
-<td rowspan="1" colSpan="1" >[getSignalingManager](https://pub.dev/documentation/tencent_cloud_chat_sdk/latest/manager_v2_tim_manager/V2TIMManager/getSignalingManager.html)</td>
-
-<td rowspan="1" colSpan="1" >信令模块</td>
-</tr>
-</table>
-
-
-## 信令接口
-<table>
-<tr>
-<td rowspan="1" colSpan="1" >API</td>
-
-<td rowspan="1" colSpan="1" >描述</td>
-</tr>
-
-<tr>
-<td rowspan="1" colSpan="1" >[addSignalingListener](https://pub.dev/documentation/tencent_cloud_chat_sdk/latest/manager_v2_tim_signaling_manager/V2TIMSignalingManager/addSignalingListener.html)</td>
-
-<td rowspan="1" colSpan="1" >添加信令监听</td>
-</tr>
-
-<tr>
-<td rowspan="1" colSpan="1" >[removeSignalingListener](https://pub.dev/documentation/tencent_cloud_chat_sdk/latest/manager_v2_tim_signaling_manager/V2TIMSignalingManager/removeSignalingListener.html)</td>
-
-<td rowspan="1" colSpan="1" >移除信令监听</td>
-</tr>
-
-<tr>
-<td rowspan="1" colSpan="1" >[invite](https://pub.dev/documentation/tencent_cloud_chat_sdk/latest/manager_v2_tim_signaling_manager/V2TIMSignalingManager/invite.html)</td>
-
-<td rowspan="1" colSpan="1" >邀请某个人</td>
-</tr>
-
-<tr>
-<td rowspan="1" colSpan="1" >[inviteInGroup](https://pub.dev/documentation/tencent_cloud_chat_sdk/latest/manager_v2_tim_signaling_manager/V2TIMSignalingManager/inviteInGroup.html)</td>
-
-<td rowspan="1" colSpan="1" >邀请群内的某些人</td>
-</tr>
-
-<tr>
-<td rowspan="1" colSpan="1" >[cancel](https://pub.dev/documentation/tencent_cloud_chat_sdk/latest/manager_v2_tim_signaling_manager/V2TIMSignalingManager/cancel.html)</td>
-
-<td rowspan="1" colSpan="1" >邀请方取消邀请</td>
-</tr>
-
-<tr>
-<td rowspan="1" colSpan="1" >[accept](https://pub.dev/documentation/tencent_cloud_chat_sdk/latest/manager_v2_tim_signaling_manager/V2TIMSignalingManager/accept.html)</td>
-
-<td rowspan="1" colSpan="1" >接收方接受邀请</td>
-</tr>
-
-<tr>
-<td rowspan="1" colSpan="1" >[reject](https://pub.dev/documentation/tencent_cloud_chat_sdk/latest/manager_v2_tim_signaling_manager/V2TIMSignalingManager/reject.html)</td>
-
-<td rowspan="1" colSpan="1" >接收方拒绝邀请</td>
-</tr>
-
-<tr>
-<td rowspan="1" colSpan="1" >[getSignalingInfo](https://pub.dev/documentation/tencent_cloud_chat_sdk/latest/manager_v2_tim_signaling_manager/V2TIMSignalingManager/getSignalingInfo.html)</td>
-
-<td rowspan="1" colSpan="1" >获取信令信息</td>
-</tr>
-
-<tr>
-<td rowspan="1" colSpan="1" >[addInvitedSignaling](https://pub.dev/documentation/tencent_cloud_chat_sdk/latest/manager_v2_tim_signaling_manager/V2TIMSignalingManager/addInvitedSignaling.html)</td>
-
-<td rowspan="1" colSpan="1" >创建一个信令请求</td>
-</tr>
 </table>
 
 
@@ -429,6 +352,72 @@
 </table>
 
 
+## 会话列表相关接口
+
+会话列表，即登录微信或 QQ 后首屏看到的列表，亦被称作消息列表，包含会话节点、会话名称、群名称、最后一条消息以及未读消息数等元素。
+<table>
+<tr>
+<td rowspan="1" colSpan="1" >API</td>
+
+<td rowspan="1" colSpan="1" >描述</td>
+</tr>
+
+<tr>
+<td rowspan="1" colSpan="1" >[addConversationListener](https://pub.dev/documentation/tencent_cloud_chat_sdk/latest/manager_v2_tim_conversation_manager/V2TIMConversationManager/addConversationListener.html)</td>
+
+<td rowspan="1" colSpan="1" >添加关系链监听器</td>
+</tr>
+
+<tr>
+<td rowspan="1" colSpan="1" >[removeConversationListener](https://pub.dev/documentation/tencent_cloud_chat_sdk/latest/manager_v2_tim_conversation_manager/V2TIMConversationManager/removeConversationListener.html)</td>
+
+<td rowspan="1" colSpan="1" >移除关系链监听器</td>
+</tr>
+
+<tr>
+<td rowspan="1" colSpan="1" >[getConversationList](https://pub.dev/documentation/tencent_cloud_chat_sdk/latest/manager_v2_tim_conversation_manager/V2TIMConversationManager/getConversationList.html)</td>
+
+<td rowspan="1" colSpan="1" >获取会话列表</td>
+</tr>
+
+<tr>
+<td rowspan="1" colSpan="1" >[getConversationListByConversationIds](https://pub.dev/documentation/tencent_cloud_chat_sdk/latest/manager_v2_tim_conversation_manager/V2TIMConversationManager/getConversationListByConversationIds.html)</td>
+
+<td rowspan="1" colSpan="1" >通过会话ID获取指定会话列表</td>
+</tr>
+
+<tr>
+<td rowspan="1" colSpan="1" >[pinConversation](https://pub.dev/documentation/tencent_cloud_chat_sdk/latest/manager_v2_tim_conversation_manager/V2TIMConversationManager/pinConversation.html)</td>
+
+<td rowspan="1" colSpan="1" >会话置顶</td>
+</tr>
+
+<tr>
+<td rowspan="1" colSpan="1" >[getTotalUnreadMessageCount](https://pub.dev/documentation/tencent_cloud_chat_sdk/latest/manager_v2_tim_conversation_manager/V2TIMConversationManager/getTotalUnreadMessageCount.html)</td>
+
+<td rowspan="1" colSpan="1" >获取会话未读总数</td>
+</tr>
+
+<tr>
+<td rowspan="1" colSpan="1" >[getConversation](https://pub.dev/documentation/tencent_cloud_chat_sdk/latest/manager_v2_tim_conversation_manager/V2TIMConversationManager/getConversation.html)</td>
+
+<td rowspan="1" colSpan="1" >获取指定会话</td>
+</tr>
+
+<tr>
+<td rowspan="1" colSpan="1" >[deleteConversation](https://pub.dev/documentation/tencent_cloud_chat_sdk/latest/manager_v2_tim_conversation_manager/V2TIMConversationManager/deleteConversation.html)</td>
+
+<td rowspan="1" colSpan="1" >删除会话</td>
+</tr>
+
+<tr>
+<td rowspan="1" colSpan="1" >[setConversationDraft](https://pub.dev/documentation/tencent_cloud_chat_sdk/latest/manager_v2_tim_conversation_manager/V2TIMConversationManager/setConversationDraft.html)</td>
+
+<td rowspan="1" colSpan="1" >设置会话草稿</td>
+</tr>
+</table>
+
+
 ## 群组相关接口
 
 腾讯云 IM SDK 支持五种预设的群组类型，每种类型都有其适用场景：
@@ -649,72 +638,6 @@
 </table>
 
 
-## 会话列表相关接口
-
-会话列表，即登录微信或 QQ 后首屏看到的列表，包含会话节点、会话名称、群名称、最后一条消息以及未读消息数等元素。
-<table>
-<tr>
-<td rowspan="1" colSpan="1" >API</td>
-
-<td rowspan="1" colSpan="1" >描述</td>
-</tr>
-
-<tr>
-<td rowspan="1" colSpan="1" >[addConversationListener](https://pub.dev/documentation/tencent_cloud_chat_sdk/latest/manager_v2_tim_conversation_manager/V2TIMConversationManager/addConversationListener.html)</td>
-
-<td rowspan="1" colSpan="1" >添加关系链监听器</td>
-</tr>
-
-<tr>
-<td rowspan="1" colSpan="1" >[removeConversationListener](https://pub.dev/documentation/tencent_cloud_chat_sdk/latest/manager_v2_tim_conversation_manager/V2TIMConversationManager/removeConversationListener.html)</td>
-
-<td rowspan="1" colSpan="1" >移除关系链监听器</td>
-</tr>
-
-<tr>
-<td rowspan="1" colSpan="1" >[getConversationList](https://pub.dev/documentation/tencent_cloud_chat_sdk/latest/manager_v2_tim_conversation_manager/V2TIMConversationManager/getConversationList.html)</td>
-
-<td rowspan="1" colSpan="1" >获取会话列表</td>
-</tr>
-
-<tr>
-<td rowspan="1" colSpan="1" >[getConversationListByConversationIds](https://pub.dev/documentation/tencent_cloud_chat_sdk/latest/manager_v2_tim_conversation_manager/V2TIMConversationManager/getConversationListByConversationIds.html)</td>
-
-<td rowspan="1" colSpan="1" >通过会话ID获取指定会话列表</td>
-</tr>
-
-<tr>
-<td rowspan="1" colSpan="1" >[pinConversation](https://pub.dev/documentation/tencent_cloud_chat_sdk/latest/manager_v2_tim_conversation_manager/V2TIMConversationManager/pinConversation.html)</td>
-
-<td rowspan="1" colSpan="1" >会话置顶</td>
-</tr>
-
-<tr>
-<td rowspan="1" colSpan="1" >[getTotalUnreadMessageCount](https://pub.dev/documentation/tencent_cloud_chat_sdk/latest/manager_v2_tim_conversation_manager/V2TIMConversationManager/getTotalUnreadMessageCount.html)</td>
-
-<td rowspan="1" colSpan="1" >获取会话未读总数</td>
-</tr>
-
-<tr>
-<td rowspan="1" colSpan="1" >[getConversation](https://pub.dev/documentation/tencent_cloud_chat_sdk/latest/manager_v2_tim_conversation_manager/V2TIMConversationManager/getConversation.html)</td>
-
-<td rowspan="1" colSpan="1" >获取指定会话</td>
-</tr>
-
-<tr>
-<td rowspan="1" colSpan="1" >[deleteConversation](https://pub.dev/documentation/tencent_cloud_chat_sdk/latest/manager_v2_tim_conversation_manager/V2TIMConversationManager/deleteConversation.html)</td>
-
-<td rowspan="1" colSpan="1" >删除会话</td>
-</tr>
-
-<tr>
-<td rowspan="1" colSpan="1" >[setConversationDraft](https://pub.dev/documentation/tencent_cloud_chat_sdk/latest/manager_v2_tim_conversation_manager/V2TIMConversationManager/setConversationDraft.html)</td>
-
-<td rowspan="1" colSpan="1" >设置会话草稿</td>
-</tr>
-</table>
-
-
 ## 用户资料相关接口
 
 包含查询用户资料、修改个人资料以及屏蔽某人消息（即把某用户加入黑名单中）的相关接口。
@@ -769,42 +692,6 @@
 </table>
 
 
-## 离线推送相关接口
-
-如果想要在 App 切后台时依然能够实时收到 IM 消息，可以使用离线推送服务。由于大陆境内尚没有统一的推送服务，Android 的离线推送需要针对不同厂商的手机进行 [逐一适配](https://cloud.tencent.com/document/product/269/75428)。
-<table>
-<tr>
-<td rowspan="1" colSpan="1" >API</td>
-
-<td rowspan="1" colSpan="1" >描述</td>
-</tr>
-
-<tr>
-<td rowspan="1" colSpan="1" >[setAPNSListener](https://pub.dev/documentation/tencent_cloud_chat_sdk/latest/manager_v2_tim_manager/V2TIMManager/setAPNSListener.html)</td>
-
-<td rowspan="1" colSpan="1" >设置苹果系统离线推送专用监听器</td>
-</tr>
-
-<tr>
-<td rowspan="1" colSpan="1" >[doBackground](https://pub.dev/documentation/tencent_cloud_chat_sdk/latest/manager_v2_tim_offline_push_manager/V2TIMOfflinePushManager/doBackground.html)</td>
-
-<td rowspan="1" colSpan="1" >设置离线推送配置信息</td>
-</tr>
-
-<tr>
-<td rowspan="1" colSpan="1" >[doForeground](https://pub.dev/documentation/tencent_cloud_chat_sdk/latest/manager_v2_tim_offline_push_manager/V2TIMOfflinePushManager/doForeground.html)</td>
-
-<td rowspan="1" colSpan="1" >设置离线推送配置信息</td>
-</tr>
-
-<tr>
-<td rowspan="1" colSpan="1" >[setOfflinePushConfig](https://pub.dev/documentation/tencent_cloud_chat_sdk/latest/manager_v2_tim_offline_push_manager/V2TIMOfflinePushManager/setOfflinePushConfig.html)</td>
-
-<td rowspan="1" colSpan="1" >设置离线推送配置信息</td>
-</tr>
-</table>
-
-
 ## 好友管理相关接口
 
 腾讯云 IM 在收发消息时默认不检查是不是好友关系，您可以在 [**控制台**](https://console.cloud.tencent.com/im) > **功能配置 **> **登录与消息 **> **好友关系检查**中开启"发送单聊消息检查关系链"开关，并使用如下接口增删好友和管理好友列表。
@@ -937,3 +824,37 @@
 </table>
 
 
+## 离线推送相关接口
+
+如果您希望应用切到后台时依然能够稳定接收 IM 消息，建议您使用 [推送服务（Push）](https://cloud.tencent.com/document/product/269/100621)，其全面覆盖主流厂商通道、最快3分钟即可实现一键式集成，支持丰富多样的推送方式和消息全链路统计分析能力，保障精准送达、服务安全稳定，助您轻松提升用户留存和互动活跃度。若您希望自行实现离线推送能力，也可参考 [自集成推送](https://cloud.tencent.com/document/product/269/75428) 指引逐一适配每个设备厂商的推送服务，将用到以下接口。
+<table>
+<tr>
+<td rowspan="1" colSpan="1" >API</td>
+
+<td rowspan="1" colSpan="1" >描述</td>
+</tr>
+
+<tr>
+<td rowspan="1" colSpan="1" >[setAPNSListener](https://pub.dev/documentation/tencent_cloud_chat_sdk/latest/manager_v2_tim_manager/V2TIMManager/setAPNSListener.html)</td>
+
+<td rowspan="1" colSpan="1" >设置苹果系统离线推送专用监听器</td>
+</tr>
+
+<tr>
+<td rowspan="1" colSpan="1" >[doBackground](https://pub.dev/documentation/tencent_cloud_chat_sdk/latest/manager_v2_tim_offline_push_manager/V2TIMOfflinePushManager/doBackground.html)</td>
+
+<td rowspan="1" colSpan="1" >设置离线推送配置信息</td>
+</tr>
+
+<tr>
+<td rowspan="1" colSpan="1" >[doForeground](https://pub.dev/documentation/tencent_cloud_chat_sdk/latest/manager_v2_tim_offline_push_manager/V2TIMOfflinePushManager/doForeground.html)</td>
+
+<td rowspan="1" colSpan="1" >设置离线推送配置信息</td>
+</tr>
+
+<tr>
+<td rowspan="1" colSpan="1" >[setOfflinePushConfig](https://pub.dev/documentation/tencent_cloud_chat_sdk/latest/manager_v2_tim_offline_push_manager/V2TIMOfflinePushManager/setOfflinePushConfig.html)</td>
+
+<td rowspan="1" colSpan="1" >设置离线推送配置信息</td>
+</tr>
+</table>

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

@@ -1,117 +1,22 @@
-### TUIKit 源码是否支持 Androidx？
+---
+product: 'Chat'
+tech_stack: 'flutter_native_sdk'
+framework: 'flutter'
+title: 'flutter uikit 集成和常见问题解决方案'
+keywords: ['flutter', '初始化', '组件', '集成', 'TUIKit']
+---
+**重要提醒**：
+- Agent 必须严格按照接口的示例代码输出结果
 
-TUIKit 最新源码已经支持 Androidx。
+# Flutter TUIKit 集成与常见问题解决方案
 
-### 登录报错 6012 或  TLSSDK exchange ticket fail ？
+## 模块一：常见问题解决方案 (Topic: Question)
 
-如果您当前是即时通信 IM 体验版，需要升级为专业版，升级后可正常登录，可以到 [即时通信 IM 购买页面](https://buy.cloud.tencent.com/avc) 进行购买升级，详细价格说明请参阅 [产品价格](https://cloud.tencent.com/document/product/269/11673)。
+### Q: flutter chat sdk 或 uikit 中如何设置消息免打扰？
 
-### 出现 6013 SDK 未初始化错误？
+**A:** flutter chat 中消息免打扰相关的API:
+- 设置单聊消息免打扰选项 [setC2CReceiveMessageOpt](https://pub.dev/documentation/tencent_cloud_chat_sdk/latest/manager_v2_tim_message_manager/V2TIMMessageManager/setC2CReceiveMessageOpt.html)。
+- 查询单聊消息免打扰选项 [getC2CReceiveMessageOpt](https://pub.dev/documentation/tencent_cloud_chat_sdk/latest/manager_v2_tim_message_manager/V2TIMMessageManager/setC2CReceiveMessageOpt.html)。
+- 设置群聊消息免打扰选项 [setGroupReceiveMessageOpt](https://pub.dev/documentation/tencent_cloud_chat_sdk/latest/manager_v2_tim_message_manager/V2TIMMessageManager/setGroupReceiveMessageOpt.html)。
 
-如果出现 6013 SDK 未初始化错误，您可以尝试以下方式排查：
-1. 查看是否没有登录成功就进行收发消息等其他操作；
-
-2. 查看是否登录时被其它终端踢掉，IM SDK 默认一个账号仅能在一个终端上登录。处理方式请参考 [多终端同时登录](https://cloud.tencent.com/document/product/269/3665#.E5.A4.9A.E7.AB.AF.E7.99.BB.E5.BD.95) 文档；
-
-3. Android 请关注库文件是否未能全部加载，或是使用过程中被系统回收。
-
-
-### code: 6205 desc: QALSERVICE not ready？
-
-在初始化后调用了 `stopQALService` 导致此错误，可以参考客户分享的 [配置方法](https://blog.csdn.net/qq_16131393/article/details/54895733)。
-
-### 发送表情，消息列表显示为空、或者乱码?
-
-即时通信 IM 不提供表情包，具体的解析需要自己对齐。
-表情使用方式有两种方式：
-- 一种是使用 TIMFaceElem 中的 index，标识表情的索引，例如 Android 和 iOS 两端都有同一套表情图，索引2为笑脸，index=2 就表示笑脸，两端发送和接收都显示同一张索引表情图片即可。
-
-- 另一种是使用 TIMFaceElem 中的 data，例如表情图片是由字符串命名，smile 表示笑脸，可在 data 中存储 smile，iOS 和 Android 两端都通过 data 作为 key 找到对应表情图片进行显示。
-
-
-   另外也可以两个字段都使用，如 data 表示哪一套表情，index 表示这套表情的哪个索引，可以实现类似 QQ 的多种不同表情效果。甚至可以在 data 数据中存储更为复杂的数据结构，只要多端解析规则一致即可。
-
-
-### 有时进行操作时返回错误码：10002?
-
-在需要进行服务端验证的操作时，如果网络异常、超时或者票据切换失败，就会返回此状态码，遇到此状态码时稍后重试即可。
-
-### 收发消息时，收到错误码 6200 或 6201？
-
-返回此状态码时，是客户端在网络离线、超时或无网络访问时出现，6200 的定义为请求时没有网络，6201 的定义为响应时没有网络，遇到此状态码时，请检查网络或等待网络恢复后重试。
-
-### 收发消息时返回错误码：20003？
-
-请检查用户账号（UserID）是否已在腾讯云导入，当 UserID 无效或 UserID 未导入腾讯即时通信 IM 时，会返回此错误码。
-
-### 语音消息播放语音时返回错误码：6010？
-
-通常情况是语音消息超过了漫游保存有效期，请求失败导致，可 [延长漫游消息时间](https://cloud.tencent.com/document/product/269/38656#.E5.8E.86.E5.8F.B2.E6.B6.88.E6.81.AF.E5.AD.98.E5.82.A8.E6.97.B6.E9.95.BF.E9.85.8D.E7.BD.AE) 或获取语音文件到本地播放（已过期的文件无法恢复）。但不同版本的 SDK 支持延长历史消息存储时长的消息类型不同，详情请参见 [消息存储](https://cloud.tencent.com/document/product/269/3571#MsgType)。
-
-### 账号鉴权时返回错误码 70001 或 70003 或 70009 或 70013？
-
-这些状态码对应的原因是 UserID 与 UserSig 不匹配，请检查 UserID 及 UserSig 的有效性。其中，70001 定义为 UserSig 已过期，70003 定义为 UserSig 被截断导致校验失败，70009 定义为 UserSig 验证失败（可能是因为生成 UserSig 时混用了其他 SDKAppID 的密钥或私钥导致），70013 定义为 UserID 不匹配。
-
-### Web 端使用 IM SDK 时返回错误码-2或-5？
-- -2：Web 端请求服务器失败，通常为网络问题，Web 端使用 HTTP Long Polling 方式向服务端请求，网络存在问题时会返回此状态码，请检查网络或重试。
-
-- -5：登录操作未完成，SDK 未获取到服务器返回的 a2key 和 tinyID 时，直接调用其它接口会出现“tinyid或a2为空”的错误提示信息和-5的错误码。
-
-
-### 在 armeabi 平台上 SDK 报"java.lang.UnsatisfiedLinkError: No implementation found for"错误该如何处理？
-
-拷贝 imsdk 的 aar 里面的 jni/armeabi-v7a/libImSDK.so 到源码工程的 src/main/jniLibs/armeabi 目录里，并在 build.gradle 中加载即可。
-
-### 上架 App Store 时，出现 x86_64, i386 架构错误该如何解决？
-
-该问题是由于 App Store 不支持 x86_64, i386 架构引起的，具体解决方法如下：
-1. 清空项目编译缓存：
- 选择**Product**>**clean**，按住Alt变成 clean build Folder...，等待操作完成。
-
-2. 剔除 App Store 不支持的 x86_64 和 i386 架构：
- a. 选择**TARGETS**>**Build Phases**。
- b. 单击加号，选择**New Run Script Phase**。
- c. 添加如下代码：
-
-   ``` bash
-   APP_PATH="${TARGET_BUILD_DIR}/${WRAPPER_NAME}"  
-   
-   # This script loops through the frameworks embedded in the application and  
-   
-   # removes unused architectures.  
-   
-    find "$APP_PATH" -name '*.framework' -type d | while read -r FRAMEWORK  
-    do  
-    FRAMEWORK_EXECUTABLE_NAME=$(defaults read "$FRAMEWORK/Info.plist" CFBundleExecutable)  
-    FRAMEWORK_EXECUTABLE_PATH="$FRAMEWORK/$FRAMEWORK_EXECUTABLE_NAME"  
-    echo "Executable is $FRAMEWORK_EXECUTABLE_PATH"  
-   
-    EXTRACTED_ARCHS=()  
-   
-    for ARCH in $ARCHS  
-    do  
-    echo "Extracting $ARCH from $FRAMEWORK_EXECUTABLE_NAME"  
-    lipo -extract "$ARCH" "$FRAMEWORK_EXECUTABLE_PATH" -o "$FRAMEWORK_EXECUTABLE_PATH-$ARCH"  
-    EXTRACTED_ARCHS+=("$FRAMEWORK_EXECUTABLE_PATH-$ARCH")  
-    done  
-   
-    echo "Merging extracted architectures: ${ARCHS}"  
-    lipo -o "$FRAMEWORK_EXECUTABLE_PATH-merged" -create "${EXTRACTED_ARCHS[@]}"  
-    rm "${EXTRACTED_ARCHS[@]}"  
-   
-    echo "Replacing original executable with thinned version"  
-    rm "$FRAMEWORK_EXECUTABLE_PATH"  
-    mv "$FRAMEWORK_EXECUTABLE_PATH-merged" "$FRAMEWORK_EXECUTABLE_PATH"  
-   
-    done
-   ```
-   ![](https://write-document-release-1258344699.cos.ap-guangzhou.tencentcos.cn/100025598411/f7592364ceda11edb580525400088f3a.png)
-
-3. 重新打包上传。
-
-
-### IM 各端 Demo/TUIKit 工程中演示用的表情包，开发者是否可以直接使用？
-
-为了尊重版权，IM Demo/TUIKit 工程中默认不包含大表情元素切图。在正式上线商用前，请您替换为自己设计或拥有版权的其他表情包。请注意，下图所示的**默认小黄脸表情包版权属于腾讯云**，您可以通过升级至 [IM 企业版套餐](https://buy.cloud.tencent.com/avc) 免费使用该表情包。
-
-![](https://write-document-release-1258344699.cos.ap-guangzhou.tencentcos.cn/100027937867/7e1754a0391611ef9c9c525400d5f8ef.png)
+消息免打扰无 UI 文档： https://cloud.tencent.com/document/product/269/75355