@tencentcloud/sdk-mcp 1.6.7 → 1.6.8

package/resource/knowledge/push/integration/unreal-engine.md

@@ -1,30 +1,25 @@
+## 前提条件
+
+开始接入前，请先完成对应原生平台的推送前提配置：请参见 [iOS 前提条件](https://cloud.tencent.com/document/product/269/100627#.E5.89.8D.E6.8F.90.E6.9D.A1.E4.BB.B6) 和 [Android 前提条件](https://cloud.tencent.com/document/product/269/100626#.E5.89.8D.E6.8F.90.E6.9D.A1.E4.BB.B6)。
+
 ## 操作步骤
 
 ### 步骤1: 集成 TIMPush
 
-完成 [厂商配置](https://cloud.tencent.com/document/product/269/123436) 后集成推送插件，下载 [TIMPush](https://github.com/TencentCloud/TIMSDK/tree/master/UE5/Push/pushdemo/Plugins/TIMPush) 并拷贝到项目的 `Plugins` 目录下，在项目主模块的 Build.cs 文件中，引入 TIMPush。
-| 拷贝目录 | 引入插件 |
-| --- | --- |
-|  |  |
+各原生平台厂商配置后集成推送插件，下载 [TIMPush](https://github.com/TencentCloud/TIMSDK/tree/master/UE5/Push/pushdemo/Plugins/TIMPush) 并拷贝到项目的 `Plugins` 目录下，在项目主模块的 Build.cs 文件中，引入 TIMPush。
 
 ### 步骤2: 推送参数配置
 
 【iOS】
 
-请将您在厂商配置步骤中，获取到的 iOS APNs 推送证书， 上传至 IM 控制台。
-
-IM 控制台会为您分配一个证书 ID，见下图：
+2. 设置 `businessID`：请在 UE4 Editor 中打开“项目设置”，搜索查找 `Additional Plist Data` 并将下面文本修改后复制进入文本框中，其中 `YourBusinessID` 是必填项，而 `YourGroupID` 是当您需要统计推送的抵达和点击数据时需要修改的值
 
-设置 businessID：
-
-请在 UE4 Editor 中打开“项目设置”，搜索查找 `Additional Plist Data` 并将下面文本修改后复制进入文本框中，其中 `YourBusinessID` 是必填项，而 `YourGroupID` 是当您需要统计推送的抵达和点击数据时需要修改的值
 ``` plaintext
 <key>businessID</key><string>YourBusinessID</string><key>TIMPushAppGroupID</key><string>YourGroupID</string>
 ```
 
-开启远程推送能力：
+3. 开启远程推送能力。完成证书 ID 配置之后，您需要开启应用的 Push Notifications 能力：
 
-完成证书 ID 配置之后，您需要开启应用的 Push Notifications 能力：
 - 如果您的 UE 引擎是从源代码自行编译构建的，您可以通过 “项目设置 > iOS 中勾选 Enable Remote Notifications Support” 来开启对应能力；
 
 - 如果您的 UE 引擎是从 Epic Game 下载的，您可以通过打开 “`<proj_dir>/Config/DefaultEngine.ini`” ，在脚本的 `IOSRuntimeSettings` 中添加：
@@ -37,11 +32,7 @@ bEnableRemoteNotificationsSupport=True
 - 或者，您也可以选择在项目根目录中使用 Xcode 打开 UE 生成的 YourProject.xcworkspace，在 Project > Target 中，点击 Signing & Capabilities 选项，点击左上角 Capability，搜索添加 Push Notifications 能力到您的项目中
 
 【Android】
-
-完成控制台厂商推送信息填写后，下载并添加配置文件到工程。将下载的 `timpush-configs.json` 文件添加到 TIMPush 的 `Source/ThirdParty/TIMPushLibrary/Android/TIMPush/Assets` 目录下。
-| 下载配置文件 | 拷贝路径 |
-| --- | --- |
-|  |  |
+1. 完成厂商配置后，在 [腾讯云即时通信 IM 控制台](https://console.cloud.tencent.com/im/push-plugin-push-identifier) 下载并添加配置文件到工程。将下载的 `timpush-configs.json` 文件添加到 TIMPush 的 `Source/ThirdParty/TIMPushLibrary/Android/TIMPush/Assets` 目录下。
 
 ### 步骤3: 客户端厂商配置
 
@@ -99,7 +90,6 @@ APL 相关配置 TIMPush 已配置好，只需要替换成应用自己的配置
 按照厂商方法，集成对应的 plugin 和 json 配置文件。
 
 > **注意：**
->
 > 以下荣耀的适配仅 7.7.5283 及以上版本需要配置。
 >
 
@@ -161,13 +151,6 @@ APL 相关配置 TIMPush 已配置好，只需要替换成应用自己的配置
 ### 步骤4：处理消息点击回调，并解析参数
 
 如果您需要自定义解析收到的远程推送，您可按照如下方法实现：
-
-> **注意：**
->
-> 1. 注册回调时机必须放在程序入口函数中。
-> 2. 控制台配置点击后续动作按如下配置，选择:**打开应用内指定界面，**请勿修改使用默认值。
->
-
 ``` cpp
 class DemoPushListener: public PushListener {
 public:
@@ -219,6 +202,11 @@ listener.SetCallback(
 PushManager::GetInstance()->AddPushListener(&listener);
 ```
 
+> **注意：**
+> 1. 注册回调时机必须放在程序入口函数中。
+> 2. 控制台配置点击后续动作按如下配置，选择: **打开应用内指定界面，**请勿修改使用默认值。
+>
+
 ### 步骤5：注册推送插件
 
 调用接口推送注册成功后，就可以收到离线推送通知了。
@@ -269,83 +257,36 @@ PushManager::GetInstance()->RegisterPush(您的 sdkAppId, "您的 appKey", callb
 
 ### 步骤6：消息推送触达统计
 
-如果您需要统计触达数据，请按照如下完成配置：
-
-【华为】
-
-回执地址：`https://api.im.qcloud.com/v3/offline_push_report/huawei`
-
-> **注意：**
->
-> 华为推送证书 ID <= 11344时，使用华为推送 v2 版本接口，不支持触达和点击回执，请重新生成更新证书 ID。
->
-
-【荣耀】
-
-回执地址：`https://api.im.qcloud.com/v3/offline_push_report/honor`
-
-【vivo】
-
-|回调地址配置|回执 ID 配置到 IM 控制台|
-|---------|---------|
-|<br>回执地址：`https://api.im.qcloud.com/v3/offline_push_report/vivo`||
-
-【魅族】
-
-|打开回执开关|配置回执地址|
-|---------|---------|
-|||
+如果你需要统计 Android 设备触达数据，请按照 华为/荣耀/vivo/魅族 配置。
 
-回执地址：`https://api.im.qcloud.com/v3/offline_push_report/meizu`
+1. 在上文的推送参数配置章节中，将“YourGroupID”修改为自己的 App Group ID。
 
-> **注意：**
->
-> 打开回执开关后，请务必确保回执地址正确配置。不配置或者配置地址错误，都会影响推送功能。
->
-
-【iOS】
-1. 如果您需要统计推送的抵达和点击数据，您需要在上文的 “项目设置” 中将“YourGroupID”修改为您自己的 App Group ID （生成方式可参见 厂商配置-生成 App GroupID）。
+2. 参考 iOS 配置消息触达统计 完成 App Group ID、Notification Service Extension 和 mutable-content 配置。
 
-2. 在完成 App Group ID 的配置后，您需要使用 Xcode 打开 UE 在项目目录生成的 xcworkspace 文件，并参考 厂商配置-生成 App GroupID-步骤四 中的方法配置您的 App Group ID。之后，请在 Xcode 项目中的 `Editor - Add Target` 中开启 Notification Service Extension Target。
+3. 将项目根目录的 Plugins-TIMPush-Source-ThirdParty-TIMPushLibrary-iOS 路径中的两个 framework 压缩包解压缩，并在 Xcode 项目中将内部的 .framework 文件夹添加到您的 pushservice target 之中。
 
-3. 您还需要将项目根目录的 `Plugins-TIMPush-Source-ThirdParty-TIMPushLibrary-iOS` 路径中的两个 framework 压缩包解压缩，并在 Xcode 项目中将内部的 .framework 文件夹添加到您的 pushservice target 之中。
+4. 在 Notification Service Extension 的 -didReceiveNotificationRequest:withContentHandler: 方法中调用推送抵达率统计函数:
 
-4. 您现在可以在 [Notification Service Extension](https://github.com/TencentCloud/TIMSDK/blob/master/iOS/Demo/pushservice/NotificationService.m) 的 `-didReceiveNotificationRequest:withContentHandler:` 方法中调用推送抵达率统计函数:
+   ``` objectivec
+   @implementation NotificationService
 
-``` objectivec
-@implementation NotificationService
+   - (void)didReceiveNotificationRequest:(UNNotificationRequest *)request withContentHandler:(void (^)(UNNotificationContent * _Nonnull))contentHandler {
+       //appGroup 标识当前主 APP 和 Extension 之间共享的 APP Group，需要在主 APP 的 Capability 中配置 App Groups 能力。
+       //格式为group + [主bundleID]+ key
+       //如group.com.tencent.im.pushkey
+       NSString * appGroupID = kTIMPushAppGroupKey;
+       __weak typeof(self) weakSelf = self;
+       [TIMPushManager handleNotificationServiceRequest:request appGroupID:appGroupID callback:^(UNNotificationContent *content) {
+           weakSelf.bestAttemptContent = [content mutableCopy];
+           // Modify the notification content here...
+           // self.bestAttemptContent.title = [NSString stringWithFormat:@"%@ [modified]", self.bestAttemptContent.title];
+           weakSelf.contentHandler(weakSelf.bestAttemptContent);
+       }];
+   }
 
-- (void)didReceiveNotificationRequest:(UNNotificationRequest *)request withContentHandler:(void (^)(UNNotificationContent * _Nonnull))contentHandler {
-    //appGroup 标识当前主 APP 和 Extension 之间共享的 APP Group，需要在主 APP 的 Capability 中配置 App Groups 能力。
-    //格式为group + [主bundleID]+ key
-    //如group.com.tencent.im.pushkey
-    NSString * appGroupID = kTIMPushAppGroupKey;
-    __weak typeof(self) weakSelf = self;
-    [TIMPushManager handleNotificationServiceRequest:request appGroupID:appGroupID callback:^(UNNotificationContent *content) {
-        weakSelf.bestAttemptContent = [content mutableCopy];
-        // Modify the notification content here...
-        // self.bestAttemptContent.title = [NSString stringWithFormat:@"%@ [modified]", self.bestAttemptContent.title];
-        weakSelf.contentHandler(weakSelf.bestAttemptContent);
-    }];
-}
+   @end
+   ```
 
-@end
-```
-
-   > **注意：**
-   >
-   > 1. 上报推送触达数据，需要开启 mutable-content 开关来支持 iOS 10 的 Extension 功能。
-   >
-   > 2. 数据详情可在推送数据页面查看，推送数据页面仅限 [购买推送插件](https://console.cloud.tencent.com/im/plugin/TIMPush)  后使用。
-
-其余支持厂商不需要配置，FCM 暂不支持推送统计功能。
+   其余支持厂商不需要配置，FCM 暂不支持推送统计功能。
 
-恭喜您已经完成了推送插件的接入，需要提醒您：推送插件**试用或购买到期后，将自动停止提供推送服务（包括普通消息离线推送、全员/标签推送等服务）**。为避免影响您业务正常使用，请提前 [购买](https://buy.cloud.tencent.com/avc)/[续费](https://console.cloud.tencent.com/account/renewal)。
-
-> **说明：**
->
-> 1. 厂商离线通道都有 [消息分类机制](https://cloud.tencent.com/document/product/269/100649)，不同类型也会有不同的推送策略。
-> - 如果推送需求属于 IM 类型推送，想要推送及时触达，需要按照厂商规则设置自己应用为对应的推送类型，会归类为高优先级的系统消息类型或者重要消息类型。
-> - 反之，离线推送会有数量和频次的限制，可能不会及时推送到设备。
-> 2. 接入完成收不到推送，请先自助使用 [排查工具](https://cloud.tencent.com/document/product/269/100629) 查看下具体原因。推送指标数据查看，请使用 [数据统计](https://cloud.tencent.com/document/product/269/100628) 查询。
-> 3. 全员/标签推送功能请参见：[REST API 接口 - 发起全员/标签推送](https://cloud.tencent.com/document/product/269/100634)。
+   接入完成收不到推送，请使用 [排查工具](https://cloud.tencent.com/document/product/269/100629) 查看具体原因。

package/resource/knowledge/roomkit/core-sdk/android/call-user-to-room.md

@@ -21,8 +21,6 @@
 
 ### 步骤1：组件集成
 
-请参考 接入概览 集成 **AtomicXCore SDK**，并已完成 实现登录逻辑 部分接入。
-
 ### 步骤2：呼叫方功能
 
 #### **1. 发起呼叫**

package/resource/knowledge/roomkit/core-sdk/android/room-participant-state.md

@@ -27,8 +27,6 @@
 
 ### 步骤1：组件集成
 
-请参考 接入概览 集成 **AtomicXCore SDK**，并已完成 实现登录逻辑 部分接入。
-
 ### 步骤2：获取参与者列表
 
 在加入房间后，调用 `RoomParticipantStore` 的 `getParticipantList` 接口获取到房间内参与者列表。

package/resource/knowledge/roomkit/core-sdk/android/room-state.md

@@ -27,8 +27,6 @@
 
 ### 步骤1：组件集成
 
-请参考 接入概览 集成 **AtomicXCore SDK**，并已完成 实现登录逻辑 部分接入。
-
 ### 步骤2：**创建并加入房间**
 
 #### *实现*方式：
@@ -81,7 +79,7 @@ fun createAndJoinRoom() {
 | --- | --- | --- | --- |
 | <code>roomID</code> | <code>String</code> | 是 | - 字符串类型的房间唯一标识符。<br>- 限制长度为 0-48 字节。<br>-  建议仅包含数字、英文字母（区分大小写）、下划线（_）和连字符（-）。避免使用空格和中文字符。 |
 | <code>roomType</code> | <code>RoomType</code> | 是 | 房间类型<br>- <code>STANDARD</code>：标准房间（默认值）。<br>- <code>WEBINAR</code>：大型研讨会房间。<br>多人会议场景这里填写 <code>STANDARD</code> 房间类型。 |
-| <code>options</code> | <code>CreateRoomOptions</code> | 是 | - 创建房间配置对象。<br>- 详细用法请参考：CreateRoomOptions 结构体详细说明 |
+| <code>options</code> | <code>CreateRoomOptions</code> | 是 | - 创建房间配置对象。<br>- 详细用法
 | <code>completion</code> | <code>CompletionHandler</code> | 否 | 操作完成回调，用于返回创建和加入房间的结果。若创建失败则会返回错误码和错误信息。 |
 
 ##### CreateRoomOptions 结构体详细说明
@@ -227,8 +225,8 @@ fun updateRoomInfo() {
 | 参数名 | 类型 | 必填 | 说明 |
 | --- | --- | --- | --- |
 | <code>roomID</code> | <code>String</code> | 是 | - 字符串类型的房间唯一标识符。<br>- 限制长度为 0-48 字节。<br>- 建议仅包含数字、英文字母（区分大小写）、下划线（_）和连字符（-）。避免使用空格和中文字符。 |
-| <code>options</code> | <code>UpdateRoomOptions</code> | 是 | - 更新房间属性配置对象。<br>- 详细用法请参考：UpdateRoomOptions 结构体详细说明 |
-| <code>modifyFlagList</code> | <code>List<UpdateRoomOptions.ModifyFlag></code> | 是 | - 更新房间属性修改标志位。目前支持更新<strong>房间名称</strong>、<strong>房间密码</strong>。<br>- 详细用法请参考：UpdateRoomOptions.ModifyFlag 详细说明。 |
+| <code>options</code> | <code>UpdateRoomOptions</code> | 是 | - 更新房间属性配置对象。<br>- 详细用法
+| <code>modifyFlagList</code> | <code>List<UpdateRoomOptions.ModifyFlag></code> | 是 | - 更新房间属性修改标志位。目前支持更新<strong>房间名称</strong>、<strong>房间密码</strong>。<br>- 详细用法。 |
 | <code>completion</code> | <code>CompletionHandler</code> | 否 | 操作完成回调，用于返回更新房间信息的结果。若更新失败则会返回错误码和错误信息。 |
 
 **UpdateRoomOptions 结构体详细说明**

package/resource/knowledge/roomkit/core-sdk/android/schedule-room.md

@@ -26,8 +26,6 @@
 
 ### 步骤1：组件集成
 
-请参考 接入概览 集成 **AtomicXCore SDK**，并已完成 实现登录逻辑 部分接入。
-
 ### 步骤2：预定房间功能
 
 #### **1. 预定房间**
@@ -80,7 +78,7 @@ fun scheduleRoom() {
 | 参数名 | 类型 | 必填 | 说明 |
 | --- | --- | --- | --- |
 | <code>roomID</code> | <code>String</code> | 是 | - 字符串类型的房间唯一标识符。<br>- 限制长度为 0-48 字节。<br>- 建议仅包含数字、英文字母（区分大小写）、下划线（_）和连字符（-）。避免使用空格和中文字符。 |
-| <code>options</code> | <code>ScheduleRoomOptions</code> | 是 | - 创建房间配置对象。<br>- 详细用法请参考：ScheduleRoomOptions 结构体详细说明。 |
+| <code>options</code> | <code>ScheduleRoomOptions</code> | 是 | - 创建房间配置对象。<br>- 详细用法。 |
 | <code>completion</code> | <code>CompletionHandler</code> | 否 | 操作完成回调，用于返回预定房间的结果。若预定失败则会返回错误码和错误信息。 |
 
 ##### ScheduleRoomOptions 结构体详细说明
@@ -91,7 +89,7 @@ fun scheduleRoom() {
 | <code>scheduleStartTime</code> | <code>Long</code> | 是 | - 预定的房间开始时间（Unix 时间戳，单位：秒）。<br>- 取值必须大于当前时间。<br>- 推荐设置为未来的整分时间。例如：1736164800（代表 2025-01-06 20:00:00）。 |
 | <code>scheduleEndTime</code> | <code>Long</code> | 是 | - 预定的房间结束时间（Unix 时间戳，单位：秒）。<br>- 取值必须大于 <code>scheduleStartTime</code>。<br>- 建议根据预期时长设置。例如：<code>scheduleStartTime</code> + 3600（预定 1 小时时长的房间）。 |
 | <code>reminderSecondsBeforeStart</code> | <code>Int</code> | 否 | - 房间开始前的提醒时间（单位：秒）。用于系统触发开始提醒。<br>- 推荐设置为 300（5分钟）或 900（15分钟），用于在 App 端触发本地通知。 |
-| <code>scheduleAttendees</code> | <code>List<String></code> | 否 | - 预定参与者的用户 ID 列表，在预定房间时设置，系统将向这些用户发送预定邀请。<br>- 获取方式请参考 获取指定预定房间的参与成员列表。 |
+| <code>scheduleAttendees</code> | <code>List<String></code> | 否 | - 预定参与者的用户 ID 列表，在预定房间时设置，系统将向这些用户发送预定邀请。<br>- 获取方式。 |
 | <code>isAllMicrophoneDisabled</code> | <code>Boolean</code> | 否 | 是否全员禁止打开麦克风。开启后，除房主/管理员外，普通参与者默认禁止打开麦克风。<br>- true : 禁止。<br>- false ：取消禁止 （默认值）。 |
 | <code>isAllCameraDisabled</code> | <code>Boolean</code> | 否 | 是否全员禁止打开摄像头。开启后，除房主/管理员外，普通参与者默认禁止打开摄像头。<br>- true : 禁止。<br>- false ：取消禁止（默认值）。 |
 | <code>isAllScreenShareDisabled</code> | <code>Boolean</code> | 否 | 是否全员禁止发起屏幕共享。开启后，仅房主/管理员可进行屏幕共享。<br>- true : 禁止。<br>- false ：取消禁止（默认值）。 |
@@ -161,8 +159,8 @@ fun updateScheduledRoom() {
 | 参数名 | 类型 | 必填 | 说明 |
 | --- | --- | --- | --- |
 | <code>roomID</code> | <code>String</code> | 是 | 字符串类型的房间唯一标识符。<br>限制长度为 0-48 字节。<br>建议仅包含数字、英文字母（区分大小写）、下划线（_）和连字符（-）。避免使用空格和中文字符。 |
-| <code>options</code> | <code>ScheduleRoomOptions</code> | 是 | 预定房间配置对象。<br>详细用法请参考：ScheduleRoomOptions 结构体详细说明。 |
-| <code>modifyFlagList</code> | <code>List<ScheduleRoomOptions.ModifyFlag></code> | 是 | 更新房间属性修改标志位。目前支持更新<strong>房间名称</strong>、<strong>开始时间</strong>、<strong>结束时间。</strong><br>详细用法请参考：ScheduleRoomOptions.ModifyFlag 详细说明。 |
+| <code>options</code> | <code>ScheduleRoomOptions</code> | 是 | 预定房间配置对象。<br>详细用法。 |
+| <code>modifyFlagList</code> | <code>List<ScheduleRoomOptions.ModifyFlag></code> | 是 | 更新房间属性修改标志位。目前支持更新<strong>房间名称</strong>、<strong>开始时间</strong>、<strong>结束时间。</strong><br>详细用法。 |
 | <code>completion</code> | <code>CompletionHandler</code> | 否 | 操作完成回调，用于返回更新预定房间的结果。若更新失败则会返回错误码和错误信息。 |
 
 **ScheduleRoomOptions.ModifyFlag 详细说明**

package/resource/knowledge/roomkit/core-sdk/flutter/call-user-to-room.md

@@ -21,8 +21,6 @@
 
 ### 步骤1：组件集成
 
-请参考 接入概览 集成 **AtomicXCore SDK**，并已完成 实现登录逻辑 部分接入。
-
 ### 步骤2：呼叫方功能
 
 #### **1. 发起呼叫**

package/resource/knowledge/roomkit/core-sdk/flutter/room-participant-state.md

@@ -57,8 +57,6 @@
 
 ### 步骤1：组件集成
 
-请参考 接入概览 集成 **AtomicXCore SDK**，并已完成 实现登录逻辑 部分接入。
-
 ### 步骤2：获取参与者列表
 
 在加入房间后，调用`RoomParticipantStore`的`getParticipantList`接口获取到房间内参与者列表。

package/resource/knowledge/roomkit/core-sdk/flutter/room-state.md

@@ -27,8 +27,6 @@
 
 ### 步骤1：组件集成
 
-请参考 接入概览 集成 **AtomicXCore SDK**，并已完成 实现登录逻辑 部分接入。
-
 ### 步骤2：**创建并加入房间**
 
 ##### 实现方式：
@@ -207,8 +205,8 @@ Future<void> updateRoomInfo() async {
 | 参数名 | 类型 | 必填 | 说明 |
 | --- | --- | --- | --- |
 | <code>roomID</code> | <code>String</code> | 是 | - 字符串类型的房间唯一标识符。<br>- 限制长度为 0-48 字节。<br>- 建议仅包含数字、英文字母（区分大小写）、下划线（_）和连字符（-）。避免使用空格和中文字符。 |
-| <code>options</code> | <code>UpdateRoomOptions</code> | 是 | - 更新房间属性配置对象。<br>- 详细用法请参考：UpdateRoomOptions 结构体详细说明 |
-| <code>modifyFlag</code> | <code>UpdateRoomOptionsModifyFlag</code> | 是 | - 更新房间属性修改标志位。目前支持更新<strong>房间名称</strong>、<strong>房间密码</strong>。<br>- 详细用法请参考：UpdateRoomOptionsModifyFlag 详细说明。 |
+| <code>options</code> | <code>UpdateRoomOptions</code> | 是 | - 更新房间属性配置对象。<br>- 详细用法
+| <code>modifyFlag</code> | <code>UpdateRoomOptionsModifyFlag</code> | 是 | - 更新房间属性修改标志位。目前支持更新<strong>房间名称</strong>、<strong>房间密码</strong>。<br>- 详细用法。 |
 
 **UpdateRoomOptions 结构体详细说明**
 | 参数名 | 类型 | 必填 | 说明 |

package/resource/knowledge/roomkit/core-sdk/flutter/schedule-room.md

@@ -26,8 +26,6 @@
 
 ### 步骤1：组件集成
 
-请参考 接入概览 集成 **AtomicXCore SDK**，并已完成 实现登录逻辑 部分接入。
-
 ### 步骤2：预定房间功能
 
 #### **一、预定房间**
@@ -79,7 +77,7 @@ Future<void> scheduleRoom() async {
 | 参数名 | 类型 | 必填 | 说明 |
 | --- | --- | --- | --- |
 | <code>roomID</code> | <code>String</code> | 是 | - 字符串类型的房间唯一标识符。<br>- 限制长度为 0-48 字节。<br>- 建议仅包含数字、英文字母（区分大小写）、下划线（_）和连字符（-）。避免使用空格和中文字符。 |
-| <code>options</code> | <code>ScheduleRoomOptions</code> | 是 | - 创建房间配置对象。<br>- 详细用法请参考：ScheduleRoomOptions 结构体详细说明 |
+| <code>options</code> | <code>ScheduleRoomOptions</code> | 是 | - 创建房间配置对象。<br>- 详细用法
 
 ##### ScheduleRoomOptions 结构体详细说明
 | 参数名 | 类型 | 必填 | 说明 |
@@ -89,7 +87,7 @@ Future<void> scheduleRoom() async {
 | scheduleStartTime | int | 是 | - 预定的房间开始时间（Unix 时间戳，单位：秒）。<br>- 取值必须大于当前时间。<br>- 推荐设置为未来的整分时间。例如：1736164800（代表 2025-01-06 20:00:00）。 |
 | scheduleEndTime | int | 是 | - 预定的房间结束时间（Unix 时间戳，单位：秒）。<br>- 取值必须大于 scheduleStartTime。<br>- 建议根据预期时长设置。例如：scheduleStartTime + 3600（预定 1 小时时长的房间）。 |
 | reminderSecondsBeforeStart | int | 否 | - 房间开始前的提醒时间（单位：秒）。用于系统触发开始提醒。<br>- 推荐设置为 300（5分钟）或 900（15分钟），用于在 App 端触发本地通知。 |
-| scheduleAttendees | List<String> | 否 | - 预定参与者的用户 ID 列表，在预定房间时设置，系统将向这些用户发送预定邀请。<br>- 获取方式请参考 获取指定预定房间的参与成员列表。 |
+| scheduleAttendees | List<String> | 否 | - 预定参与者的用户 ID 列表，在预定房间时设置，系统将向这些用户发送预定邀请。<br>- 获取方式。 |
 | isAllMicrophoneDisabled | bool | 否 | - 是否全员禁止打开麦克风。开启后，除房主/管理员外，普通参与者默认禁止打开麦克风。<br>- 参数含义：<br>- true : 禁止。<br>- false ：取消禁止 （默认值）。 |
 | isAllCameraDisabled | bool | 否 | - 是否全员禁止打开摄像头。开启后，除房主/管理员外，普通参与者默认禁止打开摄像头。<br>- 参数含义：<br>- true : 禁止。<br>- false ：取消禁止（默认值）。 |
 | isAllScreenShareDisabled | bool | 否 | - 是否全员禁止发起屏幕共享。开启后，仅房主/管理员可进行屏幕共享。<br>- 参数含义：<br>- true : 禁止。<br>- false ：取消禁止（默认值）。 |
@@ -152,8 +150,8 @@ Future<void> scheduleRoom() async {
 | 参数名 | 类型 | 必填 | 说明 |
 | --- | --- | --- | --- |
 | roomID | String | 是 | - 字符串类型的房间唯一标识符。<br>- 限制长度为 0-48 字节。<br>- 建议仅包含数字、英文字母（区分大小写）、下划线（_）和连字符（-）。避免使用空格和中文字符。 |
-| options | ScheduleRoomOptions | 是 | - 预定房间配置对象。<br>- 详细用法请参考：ScheduleRoomOptions 结构体详细说明 |
-| modifyFlagList | List<ScheduleRoomOptionsModifyFlag> | 是 | - 更新房间属性修改标志位。目前支持更新<strong>房间名称</strong>、<strong>开始时间</strong>、<strong>结束时间。</strong><br>- 详细用法请参考：ScheduleRoomOptionsModifyFlag 详细说明。 |
+| options | ScheduleRoomOptions | 是 | - 预定房间配置对象。<br>- 详细用法
+| modifyFlagList | List<ScheduleRoomOptionsModifyFlag> | 是 | - 更新房间属性修改标志位。目前支持更新<strong>房间名称</strong>、<strong>开始时间</strong>、<strong>结束时间。</strong><br>- 详细用法。 |
 
 **ScheduleRoomOptionsModifyFlag 详细说明**
 | 参数名 | 说明 |

package/resource/knowledge/roomkit/core-sdk/ios/call-user-to-room.md

@@ -21,8 +21,6 @@
 
 ### 步骤1：组件集成
 
-请参考 接入概览 集成 **AtomicXCore SDK**，并已完成 实现登录逻辑 部分接入。
-
 ### 步骤2：呼叫方功能
 
 #### **1. 发起呼叫**

package/resource/knowledge/roomkit/core-sdk/ios/room-participant-state.md

@@ -27,8 +27,6 @@
 
 ### 步骤1：组件集成
 
-请参考 接入概览 集成 **AtomicXCore SDK**，并已完成 实现登录逻辑 部分的接入。
-
 ### 步骤2：获取参与者列表
 
 在加入房间后，调用 `RoomParticipantStore` 的 `getParticipantList` 接口获取到房间内参与者列表。

package/resource/knowledge/roomkit/core-sdk/ios/room-state.md

@@ -27,8 +27,6 @@
 
 ### 步骤1：组件集成
 
-请参考 接入概览 集成 **AtomicXCore SDK** ，并已完成 实现登录逻辑 部分接入。
-
 ### 步骤2：**创建并加入房间**
 
 ##### 实现方式：
@@ -74,7 +72,7 @@ func createAndJoinRoom() {
 | --- | --- | --- | --- |
 | <code>roomID</code> | <code>String</code> | 是 | - 字符串类型的房间唯一标识符。<br>- 限制长度为 0-48 字节。<br>- 建议仅包含数字、英文字母（区分大小写）、下划线（_）和连字符（-）。避免使用空格和中文字符。 |
 | <code>roomType</code> | <code>RoomType</code> | 是 | 房间类型：<br>- <code>standard</code>：标准房间，所有成员可自由音视频互动。<br>- <code>webinar</code>：大型研讨会房间，区分嘉宾和观众角色，观众默认无上麦权限。<br>多人会议场景这里填写 <code>standard</code> 房间类型。 |
-| <code>options</code> | <code>CreateRoomOptions</code> | 是 | - 创建房间配置对象。<br>- 详细用法请参考：CreateRoomOptions 结构体详细说明。 |
+| <code>options</code> | <code>CreateRoomOptions</code> | 是 | - 创建房间配置对象。<br>- 详细用法。 |
 | <code>completion</code> | <code>CompletionClosure</code> | 否 | 操作完成回调，用于返回创建和加入房间的结果。若创建失败则会返回错误码和错误信息。 |
 
 ##### CreateRoomOptions 结构体详细说明
@@ -205,8 +203,8 @@ func updateRoomInfo() {
 | 参数名 | 类型 | 必填 | 说明 |
 | --- | --- | --- | --- |
 | <code>roomID</code> | <code>String</code> | 是 | - 字符串类型的房间唯一标识符。<br>- 限制长度为 0-48 字节。<br>- 建议仅包含数字、英文字母（区分大小写）、下划线（_）和连字符（-）。避免使用空格和中文字符。 |
-| <code>options</code> | <code>UpdateRoomOptions</code> | 是 | - 更新房间属性配置对象。<br>- 详细用法请参考：UpdateRoomOptions 结构体详细说明。 |
-| <code>modifyFlag</code> | <code>UpdateRoomOptions.ModifyFlag</code> | 是 | - 更新房间属性修改标志位。目前支持更新<strong>房间名称</strong>、<strong>房间密码</strong>。<br>- 详细用法请参考：UpdateRoomOptions.ModifyFlag 详细说明。 |
+| <code>options</code> | <code>UpdateRoomOptions</code> | 是 | - 更新房间属性配置对象。<br>- 详细用法。 |
+| <code>modifyFlag</code> | <code>UpdateRoomOptions.ModifyFlag</code> | 是 | - 更新房间属性修改标志位。目前支持更新<strong>房间名称</strong>、<strong>房间密码</strong>。<br>- 详细用法。 |
 | <code>completion</code> | <code>CompletionClosure</code> | 否 | 操作完成回调，用于返回更新房间信息的结果。若更新失败则会返回错误码和错误信息。 |
 
 **UpdateRoomOptions 结构体详细说明**

package/resource/knowledge/roomkit/core-sdk/ios/schedule-room.md

@@ -26,8 +26,6 @@
 
 ### 步骤1：组件集成
 
-请参考 接入概览 集成 **AtomicXCore SDK**，并已完成 实现登录逻辑 部分接入。
-
 ### 步骤2：预定房间功能
 
 #### **一、预定房间**
@@ -78,7 +76,7 @@ func scheduleRoom() {
 | 参数名 | 类型 | 必填 | 说明 |
 | --- | --- | --- | --- |
 | <code>roomID</code> | <code>String</code> | 是 | - 字符串类型的房间唯一标识符。<br>- 限制长度为 0-48 字节。<br>- 建议仅包含数字、英文字母（区分大小写）、下划线（_）和连字符（-）。避免使用空格和中文字符。 |
-| <code>options</code> | <code>ScheduleRoomOptions</code> | 是 | - 创建房间配置对象。<br>- 详细用法请参考：ScheduleRoomOptions 结构体详细说明 |
+| <code>options</code> | <code>ScheduleRoomOptions</code> | 是 | - 创建房间配置对象。<br>- 详细用法
 | <code>completion</code> | <code>CompletionClosure</code> | 否 | 操作完成回调，用于返回预定房间的结果。若预定失败则会返回错误码和错误信息。 |
 
 ##### ScheduleRoomOptions 结构体详细说明
@@ -89,7 +87,7 @@ func scheduleRoom() {
 | <code>scheduleStartTime</code> | <code>Int</code> | 是 | - 预定的房间开始时间（Unix 时间戳，单位：秒）。<br>- 取值必须大于当前时间。<br>- 推荐设置为未来的整分时间。例如：1736164800（代表 2025-01-06 20:00:00）。 |
 | <code>scheduleEndTime</code> | <code>Int</code> | 是 | - 预定的房间结束时间（Unix 时间戳，单位：秒）。<br>- 取值必须大于 <code>scheduleStartTime</code>。<br>- 建议根据预期时长设置。例如：<code>scheduleStartTime</code> + 3600（预定 1 小时时长的房间）。 |
 | <code>reminderSecondsBeforeStart</code> | <code>Int</code> | 否 | - 房间开始前的提醒时间（单位：秒）。用于系统触发开始提醒。<br>- 推荐设置为 300（5分钟）或 900（15分钟），用于在 App 端触发本地通知。 |
-| <code>scheduleAttendees</code> | <code>[String]</code> | 否 | - 预定参与者的用户 ID 列表，在预定房间时设置，系统将向这些用户发送预约邀请。<br>- 获取请参考获取指定预定房间的参与成员列表。 |
+| <code>scheduleAttendees</code> | <code>[String]</code> | 否 | - 预定参与者的用户 ID 列表，在预定房间时设置，系统将向这些用户发送预约邀请。<br>- 获取。 |
 | <code>isAllMicrophoneDisabled</code> | <code>Bool</code> | 否 | 是否全员禁止打开麦克风。开启后，除房主/管理员外，普通参与者默认禁止打开麦克风。<br>- true : 禁止<br>- false ：取消禁止 （默认值） |
 | <code>isAllCameraDisabled</code> | <code>Bool</code> | 否 | 是否全员禁止打开摄像头。开启后，除房主/管理员外，普通参与者默认禁止打开摄像头。<br>- true : 禁止<br>- false ：取消禁止（默认值） |
 | <code>isAllScreenShareDisabled</code> | <code>Bool</code> | 否 | 是否全员禁止发起屏幕共享。开启后，仅房主/管理员可进行屏幕共享。<br>- true : 禁止<br>- false ：取消禁止（默认值） |
@@ -152,8 +150,8 @@ func updateScheduledRoom() {
 | 参数名 | 类型 | 必填 | 说明 |
 | --- | --- | --- | --- |
 | <code>roomID</code> | <code>String</code> | 是 | - 字符串类型的房间唯一标识符。<br>- 限制长度为 0-48 字节。<br>- 建议仅包含数字、英文字母（区分大小写）、下划线（_）和连字符（-）。避免使用空格和中文字符。 |
-| <code>options</code> | <code>ScheduleRoomOptions</code> | 是 | - 预定房间配置对象。<br>- 详细用法请参考：ScheduleRoomOptions 结构体详细说明 |
-| <code>modifyFlag</code> | <code>ScheduleRoomOptions.ModifyFlag</code> | 是 | - 更新房间属性修改标志位。目前支持更新<strong>房间名称</strong>、<strong>开始时间</strong>、<strong>结束时间。</strong><br>- 详细用法请参考：ScheduleRoomOptions.ModifyFlag 详细说明。 |
+| <code>options</code> | <code>ScheduleRoomOptions</code> | 是 | - 预定房间配置对象。<br>- 详细用法
+| <code>modifyFlag</code> | <code>ScheduleRoomOptions.ModifyFlag</code> | 是 | - 更新房间属性修改标志位。目前支持更新<strong>房间名称</strong>、<strong>开始时间</strong>、<strong>结束时间。</strong><br>- 详细用法。 |
 | <code>completion</code> | <code>CompletionClosure</code> | 否 | 操作完成回调，用于返回更新预定房间的结果。若更新失败则会返回错误码和错误信息。 |
 
 **ScheduleRoomOptions.ModifyFlag 详细说明**

package/resource/knowledge/roomkit/core-sdk/vue/device-state.md

@@ -38,7 +38,6 @@
 会前检测用于在用户入会前确认摄像头、麦克风和扬声器是否可用，常见于会议预览页、入会设置页和设备检测页。
 
 > **注意：**
->
 > 会前设备检测用于确认设备是否可用，不代表用户已经在房间中发布音视频。用户入会后，仍需调用对应的设备控制接口，摄像头或麦克风才会被打开并在房间中发布音视频。
 >
 
@@ -380,7 +379,6 @@ function CameraControl() {
 会议中推荐使用“进房后预采集 + 默认静音”：先调用 `muteMicrophone`，再调用 `openLocalMicrophone` 打开采集，避免采集开启但尚未静音导致漏音。用户开麦时调用 `unmuteMicrophone`，闭麦时调用 `muteMicrophone`。
 
 > **说明：**
->
 > 1. 麦克风控制推荐采用“进房后预采集 + 默认静音”的方式有两个好处：
 > - 用户点击打开麦克风时，不需要重新处理物理设备采集，响应速度更快。
 > - 业务层可以持续检测本地麦克风音量。当用户正在说话但音频未上行时，可以提示“您正在说话，是否打开麦克风？”。
@@ -626,7 +624,6 @@ function AudioSettings() {
 ```
 
 > **说明：**
->
 > 扬声器设备切换依赖浏览器能力。部分浏览器可能无法获取扬声器列表或无法切换播放设备，建议在列表为空或切换失败时提示用户使用系统声音设置切换输出设备。
 >
 
@@ -1173,7 +1170,6 @@ function AdminDeviceRequestHandler() {
 管理员也可以邀请指定成员开启麦克风、摄像头或屏幕分享。邀请不是强制开启，成员接受后才会打开本地设备。
 
 > **说明：**
->
 > 邀请开启设备需要尊重用户授权。即使用户接受邀请，浏览器仍可能弹出系统权限确认；如果用户拒绝授权，设备仍无法打开。
 >
 
@@ -1319,7 +1315,6 @@ function DeviceInvitationHandler() {
 使用 `useDeviceState` 中的 [networkInfo](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#networkInfo) 获取本地用户网络状态。
 
 > **说明：**
->
 > 仅当本地用户通过 `joinRoom` 或 `createAndJoinRoom` 加入房间，并且打开麦克风或摄像头后，`networkInfo` 中才可以拿到有效数据。未入会或未开启音视频采集时，建议展示“未知”或不展示网络状态。
 >
 

package/resource/knowledge/roomkit/core-sdk/vue/free-beauty-panel.md

@@ -38,7 +38,6 @@ import { FreeBeautyPanel } from 'tuikit-atomicx-vue3/room';
 **以下示例展示了如何实现一个点击按钮弹出美颜设置的完整交互：**
 
 > **注意：**
->
 > 所有 TUIKit 组件必须包裹在 UIKitProvider 内部，否则将无法获取上下文依赖，导致样式异常。
 >
 
@@ -117,7 +116,6 @@ const openBeautySettings = () => {
 在用户调节美颜参数（例如拖动滑块）时，使用 [setFreeBeauty](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#setFreeBeauty) 进行实时预览。此时效果仅本地可见，不会传输给远端用户。
 
 > **注意：**
->
 > 参数取值范围为 0-100。
 >
 
@@ -142,7 +140,6 @@ const updatePreview = async (beauty: number, white: number, ruddy: number) => {
 用户确认预览效果满意后，调用 [saveBeautySetting](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#saveBeautySetting) 将当前配置应用到视频流中。此时远端用户可以看到美颜效果。
 
 > **注意：**
->
 > 虚拟背景功能依赖摄像头设备。可使用 [useDeviceState](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#module-DeviceState) 检查设备状态。
 >
 > - [cameraList](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#cameraList)：当前可用的摄像头设备列表，如果列表为空，说明未检测到摄像头或摄像头权限被禁止。

package/resource/knowledge/roomkit/core-sdk/vue/room-chat.md

@@ -35,7 +35,6 @@
 在用户加入房间成功后，需要调用 [setActiveConversation](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#setActiveConversation) 接口初始化聊天数据。Vue 3 中建议使用 `watch` 监听 `currentRoom` 的变化；React 中使用 `useEffect`。
 
 > **说明：**
->
 > - `GROUP` 为固定前缀，`setActiveConversation` 参数必须为 ``GROUP${roomId}``，否则无法正常收发消息。
 > - `GROUP` 为 IM SDK 群组会话的固定前缀（参考 [IM 会话类型](https://web.sdk.qcloud.com/im/doc/zh-cn/Conversation.html)）。房间聊天基于 IM 群组实现，因此会话 ID 必须为 ``GROUP${roomId}`` 格式。
 
@@ -99,7 +98,6 @@ function useChatConversationSync() {
 在您的页面中，可以直接组合使用这两个组件。同时结合 [useRoomParticipantState](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#module-RoomParticipantState) 获取当前用户的禁言状态，控制输入框的可用性。
 
 > **注意：**
->
 > 所有 TUIKit 组件必须包裹在 UIKitProvider 内部，否则将无法获取上下文依赖，导致样式异常。
 >
 
@@ -273,7 +271,6 @@ function useChatUnreadCount(isChatPanelOpen: boolean) {
 与方案一步骤1相同，同样需要先调用 [setActiveConversation](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#setActiveConversation) 接口激活对应的 IM 群组会话。在退房时建议清空活跃会话，避免消息错发。
 
 > **说明：**
->
 > - `GROUP` 为固定前缀，`setActiveConversation` 参数必须为 ``GROUP${roomId}``，否则无法正常收发消息。
 > - 在房间切换或退房时，建议重置或清空活跃会话，避免消息错发至错误会话。
 
@@ -430,7 +427,6 @@ function MessageListPanel({ roomId }: { roomId: string }) {
 使用对应框架的 Hook 管理输入框内容并发送消息。两者底层均调用相同的 `MessageInputStore.sendMessage(payload)`。
 
 > **注意：**
->
 > `MessageInputStore` 是纯命令式 Store，不持有输入框内容状态。需由业务层自行管理输入内容，发送时将内容通过 `sendMessage({ type: 'textMessage', text })` 传入。
 >
 
@@ -504,7 +500,6 @@ function MessageInputPanel({ roomId }: { roomId: string }) {
 分页拉取历史消息，通常在滚动到列表顶部时触发。Vue 3 和 React 均使用 `loadOlderMessages()`（底层均对应 `MessageListStore.loadOlderMessages()`）。
 
 > **注意：**
->
 > 在加载历史消息后，通常需要手动调整滚动条位置，以保持当前浏览视角不发生跳变。
 >
 

package/resource/knowledge/roomkit/core-sdk/vue/room-participant-state.md

@@ -34,7 +34,6 @@
 | 申请开启媒体设备 | - | - | 支持 |  |
 
 > **说明：**
->
 > 房主和管理员权限应同时在 UI 层和接口调用层做校验。UI 层可隐藏当前成员不可见的管理入口；接口调用层仍需通过 `try/catch` 处理无权限错误。
 >
 
@@ -75,7 +74,6 @@ export default function ParticipantPanel() {
 ```
 
 > **说明：**
->
 > - 如果使用内置成员列表组件 `RoomParticipantList`，需要在应用根节点配置 `UIKitProvider`，请参考 接入概览 > 配置全局 UIKitProvider。
 > - `RoomParticipantList` 会自动占满父容器的高度和宽度，请确保父容器具备明确尺寸。如果您需要完全自定义成员列表样式、操作按钮或业务信息展示，建议改用 `useRoomParticipantState` 自行渲染。
 
@@ -1013,7 +1011,6 @@ async function inviteUserToOpenCamera(userId: string) {
 |`RoomParticipantEvent.onDeviceInvitationDeclined`|成员拒绝邀请。|管理员侧展示拒绝结果。|
 
 > **说明：**
->
 > 设备申请和邀请的完整设备打开流程请参考设备管理文档。成员管理文档主要说明成员之间的权限协作关系。
 >