@tencent-rtc/mcp 1.6.3 → 1.6.5

package/resource/knowledge/livekit/core-sdk/voice/ios/{voice-integration.md → integration.md}

@@ -40,7 +40,6 @@ Call `LoginStore.shared.login` in your project to complete authentication. **Thi
 
 > **Note：**
 >
-
 > We recommend calling LoginStore.shared.login only after your app's own user authentication is successful, to ensure clear and consistent login logic.
 >
 
@@ -121,7 +120,7 @@ class YourAnchorViewController: UIViewController {
 }
 ```
 
-#### **2. **Turn On Microphone
+#### **2.** Turn On Microphone
 
 Turn On Microphone by calling `openLocalMicrophone` from `DeviceStore`:
 ``` swift
@@ -200,7 +199,6 @@ class YourAnchorViewController: UIViewController {
 
 > **Note：**
 >
-
 > For seat UI logic and effects, refer to the open-source [SeatGridView.swift](https://github.com/Tencent-RTC/TUIKit_iOS/blob/main/live/Sources/Component/SeatGridview/SeatGridView.swift) in TUILiveKit.
 >
 
@@ -380,7 +378,6 @@ In voice chat rooms, it's common to show a wave animation over the avatar of use
 
 > **Note：**
 >
-
 > For a complete implementation of the speaking wave animation, refer to [SeatGridView.swift](https://github.com/Tencent-RTC/TUIKit_iOS/blob/main/live/Sources/Component/SeatGridview/SeatGridView.swift) in TUILiveKit.
 >
 

package/resource/knowledge/livekit/preset/live/vue/features/barrage.md

@@ -85,10 +85,8 @@ onMounted(async () => {
 
 > **Note:**
 >
-
 > Note: To directly learn about the custom details of the Barrage Message Component (BarrageList), quickly jump to the following link: Barrage Message Component Customization;
 >
-
 > Note: To directly learn about the custom details of the Message Sending Component (BarrageInput), quickly jump to the following link: Message Sending Component Customization.
 >
 

package/resource/knowledge/push/api-reference/android.md

@@ -0,0 +1,123 @@
+## TIMPush - TIMPushManager
+
+public abstract class TIMPushManager: Push Plugin Interface Class.
+
+### API overview
+
+#### Register/Unregister Push Service Interface
+
+|API|Description|
+|---------|---------|
+|registerPush|Register Push Service, push information reads the configuration file timpush-configs.json in the project (this interface must be called after the App user has agreed to the privacy policy to use the push service).|
+|unRegisterPush|Unregister and disable the push service.|
+|setRegistrationID|RegistrationID is the unique identifier ID of the push receiving device. By default, this ID is automatically generated when the push service is successfully registered, but you can also customize the setting. You can push messages to the specified device based on the RegistrationID. Note that uninstalling and reinstalling the device will change the RegistrationID, so you need to call the setRegistrationID interface before registering the push service.|
+|getRegistrationID|After successfully registering the push service, you can get the unique identifier ID of the push receiving device, that is, the RegistrationID, by calling the getRegistrationID interface. You can push messages to the specified device based on the RegistrationID.|
+
+#### Push global listening interface
+
+|API|Description|
+|---------|---------|
+|addPushListener|Add Push listener.|
+|removePushListener|Remove Push listener.|
+
+#### Custom Configuration Interface
+
+|API|Description|
+|---------|---------|
+|forceUseFCMPushChannel|Specify offline push to use the FCM channel for the device. This needs to be called before registering the push service.|
+|disablePostNotificationInForeground|Disable the notification bar when the app is in the foreground.|
+
+### Interface Details
+
+#### Static Public Member Functions
+
+static TIMPushManager getInstance(): Retrieves the TIMPushManager manager instance.
+
+#### Member Function Description
+
+##### abstract void registerPush(Context context, int sdkAppId, String appKey, TIMPushCallback callback)
+
+Register Push Service. Please correctly pass the parameters sdkAppId and appKey to register the push service.
+
+Parameter description:
+| Parameter | Description | Get Path |
+| --- | --- | --- |
+| sdkAppId | The application ID assigned to you by the Chat console. |  |
+| appKey | The client key assigned to you by the Chat console. |  |
+
+##### abstract void unRegisterPush(TIMPushCallback callback)
+
+Unregister and disable the push service.
+
+##### abstract void setRegistrationID(String registrationID, TIMPushCallback callback)
+
+Set the push ID identifier used for registering the push service, i.e., RegistrationID, which needs to be called before registering the push service.
+
+Parameter description:
+
+|Parameter|Description|
+|---------|---------|
+|registrationID|Unique ID for push notifications on the device, which may change if uninstalled and reinstalled.|
+
+##### abstract void getRegistrationID(TIMPushCallback callback)
+
+After successfully registering for the push service, obtain the push ID identifier, i.e., RegistrationID.
+
+##### abstract void addPushListener(TIMPushListener listener)
+
+Add Push listener
+
+##### abstract void removePushListener(TIMPushListener listener)
+
+Remove Push listener
+
+##### abstract void forceUseFCMPushChannel(boolean enable)
+
+Specify offline push to use the FCM channel for the device. This needs to be called before registering the push service.
+
+Parameter description:
+| Parameter | Description |
+| --- | --- |
+| enable | - true: Use FCM channel.<br>- false: use the native channel. |
+
+##### abstract void disablePostNotificationInForeground(boolean disable)
+
+Disable notification bar pop-ups when the app is in the foreground. When the Push SDK receives an online Push, it will automatically add a Notification to the notification bar. If you want to handle the online Push messages yourself, you can call this interface to disable the automatic notification bar pop-up feature.
+
+Parameter description:
+| Parameter | Description |
+| --- | --- |
+| disable | - true: disable<br>- false: enable |
+
+## TIMPush - TIMPushListener
+
+public abstract class TIMPushListener: Push Listener class
+
+### API overview
+
+|API|Description|
+|---------|---------|
+|onRecvPushMessage|Received Push message.|
+|onRevokePushMessage|Received a notification of Push message recall.|
+|onNotificationClicked|Notification bar message click callback.|
+
+### Interface Details
+
+#### Member Function Description
+
+##### void onRecvPushMessage(TIMPushMessage message)
+
+Received Push message, message content.
+
+##### void onRevokePushMessage(String messageID)
+
+Received a notification of Push message recall, messageID uniquely identifies the message.
+
+##### void onNotificationClicked(String ext)
+
+Notification bar message click callback.
+
+> **Note:**
+>
+> The push certificate in the console needs to be configured as "open a specific interface within the application" and use the default fill value to take effect.
+>

package/resource/knowledge/push/api-reference/flutter.md

@@ -0,0 +1,176 @@
+## TencentCloudChatPush
+
+class TencentCloudChatPush: Push Plugin Interface Class.
+
+## API overview
+
+### Register/Unregister Push Service Interface
+
+|API|Description|
+|---------|---------|
+|registerPush|Register Push Service, optionally override push information from interface parameter JSON.|
+|unRegisterPush|Unregister Push Service.|
+|setRegistrationID|RegistrationID is the unique identifier ID of the push receiving device. By default, this ID is automatically generated when the push service is successfully registered, but you can also customize the setting. You can push messages to the specified device based on the RegistrationID. Note that uninstalling and reinstalling the device will change the RegistrationID, so you need to call the setRegistrationID interface before registering the push service.|
+|getRegistrationID|After successfully registering the push service, you can get the unique identifier ID of the push receiving device, that is, the RegistrationID, by calling the getRegistrationID interface. You can push messages to the specified device based on the RegistrationID.|
+
+### Push global listening interface
+
+|API|Description|
+|---------|---------|
+|addPushListener|Add Push listener.|
+|removePushListener|Remove Push listener.|
+
+### Custom Configuration Interface
+
+|API|Description|
+|---------|---------|
+|forceUseFCMPushChannel|Specify offline push to use the FCM channel for the device. This needs to be called before registering the push service.|
+|disablePostNotificationInForeground|Disable the notification bar when the app is in the foreground.|
+
+## Interface Details
+
+### Push Plugin Class
+
+TencentCloudChatPush(): Get the TencentCloudChatPush plugin instance, which is a static singleton. Subsequent steps are performed through this singleton instance for method calls.
+
+### Member Function Description
+
+#### registerPush
+
+Register Push Service, to be called after Chat account login is successful.
+
+**Sample code:**
+``` java
+void _onNotificationClicked({required String ext, String? userID, String? groupID}) {
+  print("_onNotificationClicked: $ext, userID: $userID, groupID: $groupID");
+  /// Custom Processing
+}
+TencentCloudChatPush().registerPush(
+    onNotificationClicked: _onNotificationClicked,
+    sdkAppId: Your sdkAppId,
+    appKey: "client key",
+    apnsCertificateID: Your configured Certificate ID);
+```
+
+**Parameter description:**
+| Parameter | Type | Description |  |
+| --- | --- | --- | --- |
+| onNotificationClicked | ext | String | The complete ext information carried by the message is specified by the sender. If not specified, there is a default value. You can parse this field to navigate to the corresponding page. |
+| userID | String? | This parameter corresponds to userID. It automatically tries to parse the ext JSON String to obtain the userID of the other party in a single chat.<br><strong>Note:</strong><br>If you have not customized the ext field, which is specified by the SDK or UIKit by default, you can use the default parsing here. If the parsing attempt fails, it will be null. |  |
+| groupID | String? | This parameter corresponds to groupID. It automatically tries to parse the ext JSON String to obtain the groupID information for group chats.<br><strong>Note:</strong><br>If you have not customized the ext field, which is specified by the SDK or UIKit by default, you can use the default parsing here. If the parsing attempt fails, it will be null. |  |
+| sdkAppId | int? | The application ID assigned to you by the Chat console |  |
+| appKey | String? | Client key assigned to you by the Chat console |  |
+| apnsCertificateID | int? | This item can be omitted if the setApnsCertificateID method is already configured separately. |  |
+
+#### unRegisterPush
+
+Unregister offline push service.
+
+**Sample code:**
+``` java
+TencentCloudChatPush().unRegisterPush();
+```
+
+#### setRegistrationID
+
+Set the push ID used for registering the offline push service, that is, the RegistrationID, which needs to be called before registering the push service.
+
+Parameter description:
+
+|Parameter|Description|
+|---------|---------|
+|registrationID|Device push ID, which will change after uninstalling and reinstalling.|
+
+**Sample code:**
+``` java
+TencentCloudChatPush().setRegistrationID(registrationID: registrationID);
+```
+
+#### getRegistrationID
+
+After successfully registering for the offline push service, obtain the push ID, that is, the RegistrationID.
+
+**Sample code:**
+``` java
+TencentCloudChatPush().getRegistrationID();
+```
+
+#### addPushListener
+
+Add Push listener
+
+**Sample code:**
+``` java
+TIMPushListener timPushListener = TIMPushListener(
+  onRecvPushMessage: (TimPushMessage message) {
+      String messageLog = message.toLogString();
+      debugPrint(
+          "message: $messageLog");
+      },
+
+  onRevokePushMessage: (String messageId) {
+    debugPrint(
+        "message: $messageId");
+  },
+
+  onNotificationClicked: (String ext) {
+    debugPrint(
+        "ext: $ext");
+  }
+);
+TencentCloudChatPush.addPushListener(listener: timPushListener);
+```
+
+#### removePushListener
+
+Remove Push listener
+
+**Sample code:**
+``` java
+TIMPushListener timPushListener = TIMPushListener(
+  onRecvPushMessage: (TimPushMessage message) {
+      String messageLog = message.toLogString();
+      debugPrint(
+          "message: $messageLog");
+      },
+
+  onRevokePushMessage: (String messageId) {
+    debugPrint(
+        "message: $messageId");
+  },
+
+  onNotificationClicked: (String ext) {
+    debugPrint(
+        "ext: $ext");
+  }
+);
+TencentCloudChatPush.removePushListener(listener: timPushListener);
+```
+
+#### forceUseFCMPushChannel
+
+Specify offline push to use the FCM channel for the device. This needs to be called before registering the push service.
+
+Parameter description:
+| Parameter | Description |
+| --- | --- |
+| enable | - true: Use FCM channel.<br>- false: use the native channel. |
+
+**Sample code:**
+``` java
+TencentCloudChatPush.forceUseFCMPushChannel(enable: true);
+```
+
+#### disablePostNotificationInForeground
+
+Disable notification bar pop-ups when the app is in the foreground. When the Push SDK receives an online Push, it will automatically add a Notification to the notification bar. If you want to handle the online Push messages yourself, you can call this interface to disable the automatic notification bar pop-up feature.
+
+Parameter description:
+| Parameter | Description |
+| --- | --- |
+| disable | - true: disable<br>- false: enable |
+
+**Sample code:**
+``` java
+TencentCloudChatPush.disablePostNotificationInForeground(disable: true);
+```

package/resource/knowledge/push/api-reference/harmonyos.md

@@ -0,0 +1,138 @@
+## TIMPushManager API Overview
+| API | Description |
+| --- | --- |
+| registerPush | Register push service (call this API to use push service only after obtaining user consent for the privacy policy). |
+| unRegisterPush | Unregister and disable push service. |
+| setRegistrationID | - RegistrationID is the unique identifier of the push reception device.<br>- By default, it is system-generated when push service registration succeeds. You can also set custom registration ID.<br>- Based on RegistrationID, you can send push messages to specified devices.<br>- Note that uninstalling and reinstalling the device will change the RegistrationID, so you need to call the setRegistrationID API before registering the push service. |
+| getRegistrationID | After successfully registering the push service, call this API to get the unique identifier of the push reception device, namely RegistrationID. |
+| addPushListener | Add a Push Listener. |
+| removePushListener | Remove a Push Listener. |
+| disablePostNotificationInForeground | Enable/disable notification bar notifications when the app is in the foreground (default: enabled). |
+
+## API Detail
+
+### Register Push Service
+
+#### API
+``` tsx
+registerPush(
+  context: Context,
+  sdkAppId?: number,
+  appKey?: string,
+  businessId?: number
+): Promise<TIMPushResult>;
+```
+
+#### Parameter description:
+| Parameter | Type | Description | Access Path |
+| --- | --- | --- | --- |
+| context | Context | application context | - |
+| sdkAppId | number | Push Service SDKAppID. | <a href="https://console.trtc.io/chat/push-plugin-push-identifier">Chat > Push > Access Settings</a> page |
+| appKey | String | Push Service client key. |  |
+| businessId | number | Certificate ID assigned in the Chat console. |  |
+
+### Unregistering and Disabling Push Service
+
+#### API
+``` tsx
+unRegisterPush(): Promise<TIMPushResult>;
+```
+
+### Setting Push ID Identifier RegistrationID
+
+> **Note:**
+>
+> 1. If you call this API, ensure to call it before `registerPush`.
+
+#### API
+``` tsx
+setRegistrationID(registrationID: string): Promise<TIMPushResult>;
+```
+
+#### Parameter description:
+
+|Parameter|Type|Description|
+|---------|---------|---------|
+|registrationID|String|Custom push ID identifier.|
+
+### Getting Push ID Identifier RegistrationID
+
+> **Note:**
+>
+> Note: If you have called the `setRegistrationID` API to set an identifier ID, this API will return the identifier ID you have set. Otherwise, it will return a random value generated by the Push SDK.
+>
+
+#### API
+``` tsx
+getRegistrationID(): Promise<TIMPushResult>;
+```
+
+### Adding a Push Listener
+
+#### API
+``` tsx
+addPushListener(listener: TIMPushListener): void;
+```
+
+#### Parameter description:
+
+|Parameter|Type|Description|
+|---------|---------|---------|
+|listener|TIMPushListener|Push event processing method|
+
+### Removing a Push Listener
+
+#### API
+``` tsx
+removePushListener(listener: TIMPushListener): void;
+```
+
+#### Parameter description:
+
+|Parameter|Type|Description|
+|---------|---------|---------|
+|listener|TIMPushListener|Push event processing method|
+
+### Enabling/Disabling Notification Bar Notifications When the App Is in the Foreground
+
+#### API
+``` tsx
+disablePostNotificationInForeground(disable: boolean): void;
+```
+
+#### Parameter description:
+| Parameter | Type | Description |
+| --- | --- | --- |
+| disable | boolean | Enable/disable notification bar notifications when the app is in the foreground (default: off).<br>- Disable notification bar notifications when the app is in the foreground.<br>- false: Enable notification bar notifications when the app is in the foreground. |
+
+## TIMPushListener API Overview
+
+|API|Description|
+|---------|---------|
+|onRecvPushMessage|Received a Push message.|
+|onRevokePushMessage|Received a Push message recall notification.|
+|onNotificationClicked|Click the notification bar message Webhook.|
+
+### API Detail
+
+#### Member Function Description
+
+##### onMessageReceived(message: TIMPushMessage): void;
+
+Received a Push message. Received a message.
+
+##### onRevokePushMessage(messageID: string): void;
+
+Received a Push message recall notification with the unique message identifier messageID.
+
+##### onNotificationClicked(ext: string): void;
+
+Click the notification bar message Webhook.
+
+## TIMPushResult API Overview
+
+|Field|Description|Type|
+|---------|---------|---------|
+|code|Error code|number|
+|message|Error Description|string|
+|data|Return Values|unknown|

package/resource/knowledge/push/api-reference/ios.md

@@ -0,0 +1,176 @@
+## TIMPush - TIMPushManager
+
+@interface TIMPushManager : NSObject  :Push Plugin Interface Class.
+
+### API overview
+
+#### Register/Unregister Push Service Interface
+
+|API|Description|
+|---------|---------|
+|registerPush|Register Push Service (Must be called after the App user has agreed to the privacy policy to use the push service).|
+|unRegisterPush|Unregister and disable the push service.|
+|setRegistrationID|RegistrationID is the unique identifier ID of the push receiving device. By default, this ID is automatically generated when the push service is successfully registered, but you can also customize the setting. You can push messages to the specified device based on the RegistrationID. Note that uninstalling and reinstalling the device will change the RegistrationID, so you need to call the setRegistrationID interface before registering the push service.|
+|getRegistrationID|After successfully registering the push service, you can get the unique identifier ID of the push receiving device, that is, the RegistrationID, by calling the getRegistrationID interface. You can push messages to the specified device based on the RegistrationID.|
+
+#### Push global listening interface
+
+|API|Description|
+|---------|---------|
+|addPushListener|Add Push listener.|
+|removePushListener|Remove Push listener.|
+
+#### Custom Configuration Interface
+
+Set whether to display push notifications in the foreground of the app
+
+|API|Description|
+|---------|---------|
+|disablePostNotificationInForeground|Disable the notification bar when the app is in the foreground.|
+
+### Statistics for TIMPush's Push Arrival Rate
+
+If you need to track push arrival and click data, you need to proactively call this function in the Notification Service Extension.
+| API | Description |
+| --- | --- |
+| handleNotificationServiceRequest:appGroupID:callback: | - Only support calling in Notification Service Extension's '- didReceiveNotificationRequest:withContentHandler:' method.<br>- The appGroup identifies the App Group shared between the main app and the Extension. It needs to be configured in the App Groups capability of the main app's capability. |
+
+### Interface Details
+
+#### Function description
+
+##### + (void)registerPush:(int) sdkAppId appKey:(NSString *) appKey succ:(TIMPushSuccessCallback) successCallback fail:(TIMPushFailedCallback) failedCallback;
+
+Register Push Service. Please correctly pass the parameters sdkAppId and appKey to register the push service.
+- Parameter description:
+
+| Parameter | Description | Get Path |
+| --- | --- | --- |
+| sdkAppId | The application ID assigned to you by the Chat console. |  |
+| appKey | The client key assigned to you by the Chat console. |  |
+
+- Sample code:
+
+   ``` java
+    const int sdkAppId = your sdkAppId;
+    static const NSString *appKey = @"Client Key";
+
+    [TIMPushManager registerPush:sdkAppId appKey:appKey succ:^(NSData * _Nonnull deviceToken) {
+        //
+     } fail:^(int code, NSString * _Nonnull desc) {
+       //error
+    }];
+   ```
+
+##### + (void)unRegisterPush:(TIMPushCallback) successCallback fail:(TIMPushFailedCallback) failedCallback;
+
+Unregister and disable the push service
+- Sample code:
+
+   ``` java
+    [TIMPushManager unRegisterPush:^{
+         //success
+       } fail:^(int code, NSString * _Nonnull desc) {
+         //error
+     }];
+   ```
+
+##### + (void)setRegistrationID:(NSString *)registrationID callback: (TIMPushCallback) callback;
+
+Set the push ID identifier used for registering the push service, i.e., RegistrationID, which needs to be called before registering the push service.
+- Parameter description:
+
+   |Parameter|Description|
+   |---------|---------|
+   |registrationID|The device's push identifier ID will change if you uninstall and reinstall.|
+
+##### + (void)getRegistrationID:(TIMPushValueCallback) callback;
+
+After successfully registering the push service, obtain the push ID identifier, i.e., RegistrationID.
+
+##### + (void)addPushListener:(id<TIMPushListener>)listener
+
+Add Push listener.
+
+##### + (void)removePushListener:(id<TIMPushListener>)listener
+
+Remove Push listener.
+
+##### + (void)disablePostNotificationInForeground:(BOOL)disable;
+
+Disable notification bar pop-ups when the app is in the foreground. When the Push SDK receives an online Push, it will automatically add a Notification to the notification bar. If you want to handle the online Push messages yourself, you can call this interface to disable the automatic notification bar pop-up feature.
+- Parameter description:
+
+| Parameter | Description |
+| --- | --- |
+| disable | - true: disable<br>- false: enable |
+
+##### + (void)handleNotificationServiceRequest:(UNNotificationRequest *)request appGroupID:(NSString *)appGroupID callback:(TIMPushNotificationExtensionCallback)callback
+
+Statistics for TIMPush's Push Arrival Rate
+1. You need to implement the `- applicationGroupID` method in the AppDelegate.m file, returning the App Group ID.
+
+2. And call this function in the Notification Service Extension's '- didReceiveNotificationRequest:withContentHandler:' method.
+
+   > **Note:**
+   >
+   > The appGroup identifies the App Group shared between the main app and the Extension. It needs to be configured in the App Groups capability of the main app's capability.
+   >
+
+- Parameter description:
+
+| request | <a href="https://developer.apple.com/documentation/usernotifications/unnotificationserviceextension/1648229-didreceivenotificationrequest">Parameters carried by the UNNotificationServiceExtension callback</a> |
+| --- | --- |
+| appGroupID | The appGroup identifies the App Group shared between the main app and the Extension. It needs to be configured in the App Groups capability of the main app's capability. |
+| callback | typedef void(^TIMPushNotificationExtensionCallback)(UNNotificationContent *content) Statistics function callback, carrying content information |
+
+- Sample code:
+
+   ``` java
+
+   @implementation NotificationService
+
+   - (void)didReceiveNotificationRequest:(UNNotificationRequest *)request withContentHandler:(void (^)(UNNotificationContent * _Nonnull))contentHandler {
+       //The appGroup identifies the App Group shared between the main app and the Extension. It needs to be configured in the App Groups capability of the main app's capability.
+       //Format: group + [mainBundleID] + key
+       //E.g., group.com.tencent.im.pushkey
+       NSString * appGroupID = kTIMPushAppGorupKey;
+       __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
+   ```
+
+## TIMPush - TIMPushListener
+
+@protocol TIMPushListener <NSObject> :Push Listener Protocol
+
+### API overview
+
+|API|Description|
+|---------|---------|
+|onRecvPushMessage|Received Push message|
+|onRevokePushMessage|Received a notification of Push message recall|
+|onNotificationClicked|Notification bar message click callback|
+
+### Interface Details
+
+#### Member Function Description
+
+##### - (void)onRecvPushMessage:(TIMPushMessage *)message;
+
+Received Push message, message content.
+
+##### - (void)onRevokePushMessage:(NSString *)messageID;
+
+Received a notification of Push message recall, messageID uniquely identifies the message.
+
+##### - (void)onNotificationClicked:(NSString *)ext;
+
+Notification bar message click callback.