@tencent-rtc/mcp 1.6.4 → 1.6.5

package/resource/knowledge/push/api-reference/react-native.md

@@ -0,0 +1,147 @@
+## API Overview
+| API | Description |
+| --- | --- |
+| <code>registerPush</code> | Register for push service (must be called after the App user agrees to the Privacy Policy to use the push service). |
+| <code>unRegisterPush</code> | Unregister to disable push service. |
+| <code>setRegistrationID</code> | Set Push Device ID.<br>- RegistrationID is the unique identification ID of the push receiving device. By default, this ID is automatically generated when the push service is successfully registered, but you can also set it manually. <strong>Note! If you call this API, make sure to call it before</strong> <code>registerPush</code><strong>.</strong><br>- Use cases:<br>If you have integrated both the Chat message service and the Push service on a device, and the user login Chat userID is assumed to be "user123", if you want to push messages to "user123", you need to call this interface to set the device identification ID as follows:<br><code>Push.setRegistrationID("user123", () => {});</code> |
+| <code>getRegistrationID</code> | After successfully registering the push service, you can call this interface to obtain the unique identification ID of the push receiving device, which is the RegistrationID. |
+| <code>getNotificationExtInfo</code> | Upon receiving offline push notifications, click the notification bar to pull up the App, and call this interface to get the push extension information. |
+| <code>addPushListener</code> | Add a Push listener. |
+| <code>removePushListener</code> | Remove a Push listener. |
+| <code>disablePostNotificationInForeground</code> | When the app is in the foreground, turn on/off notification bar notifications (default is on). |
+| <code>createNotificationChannel</code> | Create a client notification channel. This API can implement custom ringtone feature on the Android platform. |
+
+## Interface details
+
+### Registering Push Service
+
+#### API
+``` javascript
+registerPush(SDKAppID, appKey, onSuccess, onError)
+```
+
+#### Parameter description:
+| Parameters | Type | Description | Access Path |
+| --- | --- | --- | --- |
+| SDKAppID | Number | SDKAppID for Push Service Push. | <a href="https://console.trtc.io/chat/push-plugin-push-identifier">Chat Console</a> |
+| appKey | String | Client key for Push Service Push. |  |
+| onSuccess | Function | Callback for successful push registration. | - |
+| onError | Function ｜undefined | Callback for failed push registration. | - |
+
+### Unregister to disable push service
+
+#### API
+``` javascript
+unRegisterPush(onSuccess, onError)
+```
+
+#### Parameter description:
+
+|Parameters|Type|Description|
+|---------|---------|---------|
+|onSuccess|Function|Callback for successful push unregistration.|
+|onError|Function ｜undefined|Callback for failed push unregistration.|
+
+### Set push ID identifier RegistrationID
+
+> **Note:**
+>
+> 1. If you call this API, make sure to call it before `registerPush`.
+
+#### API
+``` javascript
+setRegistrationID(registrationID, onSuccess)
+```
+
+#### Parameter description:
+
+|Parameters|Type|Description|
+|---------|---------|---------|
+|registrationID|String|Customized push ID identifier.|
+|onSuccess|Function|Callback after successfully setting the customized push ID identifier.|
+
+### Get push ID identifier RegistrationID
+
+> **Note:**
+>
+> 1. If you have called the `setRegistrationID` interface to set the identifier ID, this interface will return the identifier ID you set, otherwise, it will return a random value generated by the Push SDK.
+
+#### API
+``` javascript
+getRegistrationID(onSuccess)
+```
+
+#### Parameter description:
+
+|Parameters|Type|Description|
+|---------|---------|---------|
+|onSuccess|Function|Callback for successfully obtaining the push ID.|
+
+### Getting Push Extension Information
+
+#### API
+``` javascript
+getNotificationExtInfo(onSuccess)
+```
+
+#### Parameter description:
+
+|Parameters|Type|Description|
+|---------|---------|---------|
+|onSuccess|Function|Callback for successfully getting the clicked pass-through content.|
+
+### Adding a Push Listener
+
+#### API
+``` javascript
+addPushListener(eventName: string, listener: (data: any) => void);
+```
+
+#### Parameter description:
+
+|Parameters|Type|Description|
+|---------|---------|---------|
+|eventName|String|Push Event Type.|
+|listener|Function|Push Event Handling Method.|
+
+### Removing a Push Listener
+
+#### API
+``` javascript
+removePushListener(eventName: string, listener?: (data: any) => void);
+```
+
+#### Parameter description:
+
+|Parameters|Type|Description|
+|---------|---------|---------|
+|eventName|String|Push Event Type.|
+|listener|Function \| undefined|Push Event Handling Method.|
+
+### Turning On/Off Notification Bar Notifications When the App is in the Foreground
+
+#### API
+``` javascript
+disablePostNotificationInForeground(disable: boolean);
+```
+
+#### Parameter description:
+| Parameters | Type | Description |
+| --- | --- | --- |
+| disable | boolean | Turning On/Off Notification Bar Notifications When the App is in the Foreground, Default On:<br>- true: Turning off notification bar notifications when the app is in the foreground<br>- false: Turning on notification bar notifications when the app is in the foreground |
+
+### Creating a Client Notification Channel
+
+#### API
+``` javascript
+createNotificationChannel(options: any, onSuccess: (data: any) => void);
+```
+
+#### Parameter description:
+| Parameters | Type | Description |
+| --- | --- | --- |
+| options.channelID | String | The ID of the custom channel.<br>OPPO: The channelID in <a href="https://console.trtc.io/chat/push-plugin-push-identifier">Console -> Access Configuration</a>. |
+| options.channelName | String | The name of the custom channel. |
+| options.channelDesc | String \\| undefined | The description of the custom channel. |
+| options.channelSound | String \\| undefined | The alert tone of the custom channel, audio file name without suffix. The audio file needs to be placed in <code>MyReactNativeApp/android/app/src/main/res/raw</code>.<br>For example:<br><code>options.channelSound = private_ring</code>, which sets <code>MyReactNativeApp/android/app/src/main/res/raw/private_ring.mp3</code> as the custom alert tone. |
+| onSuccess | Function | Callback function for successful API invocation. |

package/resource/knowledge/push/api-reference/uni-app.md

@@ -0,0 +1,147 @@
+## API Overview
+| API | Description |
+| --- | --- |
+| <code>registerPush</code> | Register for push service (must be called after the App user agrees to the Privacy Policy to use the push service). |
+| <code>unRegisterPush</code> | Unregister to disable push service. |
+| <code>setRegistrationID</code> | Set Push Device ID.<br>- RegistrationID is the unique identification ID of the push receiving device. By default, this ID is automatically generated when the push service is successfully registered, but you can also set it manually. <strong>Note! If you call this API, make sure to call it before</strong> <code>registerPush</code><strong>.</strong><br>- Use cases:<br>If you have integrated both the Chat message service and the Push service on a device, and the user login Chat userID is assumed to be "user123", if you want to push messages to "user123", you need to call this interface to set the device identification ID as follows:<br><code>Push.setRegistrationID("user123", () => {});</code> |
+| <code>getRegistrationID</code> | After successfully registering the push service, you can call this interface to obtain the unique identification ID of the push receiving device, which is the RegistrationID. |
+| <code>getNotificationExtInfo</code> | Upon receiving offline push notifications, click the notification bar to pull up the App, and call this interface to get the push extension information. |
+| <code>addPushListener</code> | Add a Push listener. |
+| <code>removePushListener</code> | Remove a Push listener. |
+| <code>disablePostNotificationInForeground</code> | When the app is in the foreground, turn on/off notification bar notifications (default is on). |
+| <code>createNotificationChannel</code> | Create a client notification channel. This API can implement custom ringtone feature on the Android platform. |
+
+## Interface details
+
+### Registering Push Service
+
+#### API
+``` javascript
+registerPush(SDKAppID, appKey, onSuccess, onError)
+```
+
+#### Parameter description:
+| Parameters | Type | Description | Access Path |
+| --- | --- | --- | --- |
+| SDKAppID | Number | SDKAppID for Push Service Push. | <a href="https://console.trtc.io/chat/push-plugin-push-identifier">Chat Console</a> |
+| appKey | String | Client key for Push Service Push. |  |
+| onSuccess | Function | Callback for successful push registration. | - |
+| onError | Function ｜undefined | Callback for failed push registration. | - |
+
+### Unregister to disable push service
+
+#### API
+``` javascript
+unRegisterPush(onSuccess, onError)
+```
+
+#### Parameter description:
+
+|Parameters|Type|Description|
+|---------|---------|---------|
+|onSuccess|Function|Callback for successful push unregistration.|
+|onError|Function ｜undefined|Callback for failed push unregistration.|
+
+### Set push ID identifier RegistrationID
+
+> **Note:**
+>
+> 1. If you call this API, make sure to call it before `registerPush`.
+
+#### API
+``` javascript
+setRegistrationID(registrationID, onSuccess)
+```
+
+#### Parameter description:
+
+|Parameters|Type|Description|
+|---------|---------|---------|
+|registrationID|String|Customized push ID identifier.|
+|onSuccess|Function|Callback after successfully setting the customized push ID identifier.|
+
+### Get push ID identifier RegistrationID
+
+> **Note:**
+>
+> 1. If you have called the `setRegistrationID` interface to set the identifier ID, this interface will return the identifier ID you set, otherwise, it will return a random value generated by the Push SDK.
+
+#### API
+``` javascript
+getRegistrationID(onSuccess)
+```
+
+#### Parameter description:
+
+|Parameters|Type|Description|
+|---------|---------|---------|
+|onSuccess|Function|Callback for successfully obtaining the push ID.|
+
+### Getting Push Extension Information
+
+#### API
+``` javascript
+getNotificationExtInfo(onSuccess)
+```
+
+#### Parameter description:
+
+|Parameters|Type|Description|
+|---------|---------|---------|
+|onSuccess|Function|Callback for successfully getting the clicked pass-through content.|
+
+### Adding a Push Listener
+
+#### API
+``` javascript
+addPushListener(eventName: string, listener: (data: any) => void);
+```
+
+#### Parameter description:
+
+|Parameters|Type|Description|
+|---------|---------|---------|
+|eventName|String|Push Event Type.|
+|listener|Function|Push Event Handling Method.|
+
+### Removing a Push Listener
+
+#### API
+``` javascript
+removePushListener(eventName: string, listener?: (data: any) => void);
+```
+
+#### Parameter description:
+
+|Parameters|Type|Description|
+|---------|---------|---------|
+|eventName|String|Push Event Type.|
+|listener|Function \| undefined|Push Event Handling Method.|
+
+### Turning On/Off Notification Bar Notifications When the App is in the Foreground
+
+#### API
+``` javascript
+disablePostNotificationInForeground(disable: boolean);
+```
+
+#### Parameter description:
+| Parameters | Type | Description |
+| --- | --- | --- |
+| disable | boolean | Turning On/Off Notification Bar Notifications When the App is in the Foreground, Default On:<br>- true: Turning off notification bar notifications when the app is in the foreground<br>- false: Turning on notification bar notifications when the app is in the foreground |
+
+### Creating a Client Notification Channel
+
+#### API
+``` javascript
+createNotificationChannel(options: any, listener: (data: any) => void);
+```
+
+#### Parameter description:
+| Parameters | Type | Description |
+| --- | --- | --- |
+| options.channelID | String | The ID of the custom channel.<br>OPPO: The channelID in <a href="https://console.trtc.io/chat/push-plugin-push-identifier">Console -> Access Configuration</a>. |
+| options.channelName | String | The name of the custom channel. |
+| options.channelDesc | String \\| undefined | The description of the custom channel. |
+| options.channelSound | String \\| undefined | The alert tone of the custom channel, audio file name without suffix. The audio file needs to be placed in <code>xxx/nativeResources/android/res/raw</code>.<br>For example:<br><code>options.channelSound = private_ring</code>, which sets <code>xxx/nativeResources/android/res/raw/private_ring.mp3</code> as the custom alert tone. |
+| listener | Function | Callback function for successful API invocation. |

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

@@ -0,0 +1,119 @@
+PushManager
+
+public class PushManager: Push Plugin Interface Class
+
+### API Overview
+
+#### Register/Unregister Push Service API
+
+|API|Description|
+|---------|---------|
+|RegisterPush|Register push service (The API must be called to use push service after obtaining user consent for the privacy policy).|
+|UnRegisterPush|Disable push service.|
+|SetRegistrationID|RegistrationID is the unique identifier of a push reception device. By default, it is automatically generated when push service registration succeeds. You can also customize settings. Based on the RegistrationID, you can push messages to specified devices. Notably, uninstalling and reinstalling the device will change the RegistrationID, so you need to call the setRegistrationID API before registering the push service.|
+|GetRegistrationID|After successful push service registration, you can obtain the unique identifier ID of the push reception device, namely RegistrationID, by calling the getRegistrationID API. Based on the RegistrationID, you can push messages to specified devices.|
+
+#### Push Global Listening Interface
+
+|API|Description|
+|---------|---------|
+|AddPushListener|Add a Push Listener.|
+|RemovePushListener|Remove a Push Listener.|
+
+#### Custom Configuration API
+
+|API|Description|
+|---------|---------|
+|ForceUseFCMPushChannel|Assign device offline push to use FCM channel, need to register push service before calling.|
+|DisablePostNotificationInForeground|Disable pop-up notifications when the App is in the foreground.|
+
+### API Detail
+
+#### Member Function Description
+
+##### abstract void RegisterPush(Context context, int sdkAppId, String appKey, PushCallback callback)
+
+Register push service. Just transmit both sdkAppId and appKey to complete push service registration.
+
+Parameter description:
+| Parameter | Description | Access Path |
+| --- | --- | --- |
+| sdkAppId | The app ID assigned to you in the IM console. |  |
+| appKey | The client key assigned to you in the IM console. |  |
+
+##### abstract void UnRegisterPush(PushCallback callback)
+
+Unregister and disable push service.
+
+##### abstract void SetRegistrationID(String registrationID, PushCallback callback)
+
+Set the push ID (RegistrationID) used for push service registration, which needs to be called before registering the push service.
+
+Parameter description:
+
+|Parameter|Description|
+|---------|---------|
+|registrationID|The push unique identifier ID of the device will change after uninstall reinstall.|
+
+##### abstract void GetRegistrationID(PushCallback callback)
+
+After successful registration of push service, obtain the push ID (RegistrationID).
+
+##### abstract void AddPushListener(PushListener listener)
+
+Add a Push Listener.
+
+##### abstract void RemovePushListener(PushListener listener)
+
+Remove a Push Listener
+
+##### abstract void ForceUseFCMPushChannel(boolean enable)
+
+Assign device offline push to use FCM channel, need to register push service before calling.
+
+Parameter description:
+| Parameter | Description |
+| --- | --- |
+| enable | - true: Use FCM channel.<br>- false: Use local machine channel. |
+
+##### abstract void DisablePostNotificationInForeground(boolean disable)
+
+Disable the pop-up Notification bar when the App is in the foreground. When the Push SDK receives an online push, it automatically adds a Notification to the Notification bar. If you want to handle the online push message yourself, you can call this API to disable the automatic pop-up Notification bar feature.
+
+Parameter description:
+| Parameter | Description |
+| --- | --- |
+| disable | - true: It is disabled.<br>- false: enable |
+
+## PushListener
+
+public class PushListener: Push Listener Class
+
+### 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
+
+##### void onRecvPushMessage(TIMPushMessage message)
+
+Received a Push message. Received a message.
+
+##### void onRevokePushMessage(string messageID)
+
+Received a Push message recall notification, messageID unique message identifier.
+
+##### void onNotificationClicked(String ext)
+
+Click the notification bar message Webhook.
+
+> **Note:**
+>
+> Configure the console Push Certificate to "open specified in-app page" and use the default populated value to take effect.
+>

package/resource/knowledge/push/api-reference/unreal-engine.md

@@ -0,0 +1,123 @@
+## TIMPush - PushManager
+
+PushManager: Push Plugin Interface class
+
+### API Overview
+
+#### Register/Unregister Push Service API
+
+|API|Description|
+|---------|---------|
+|RegisterPush|Register push service (this API must be called to use push service only after the App user consents to the privacy policy).|
+|UnRegisterPush|Disable push service.|
+|SetRegistrationID|RegistrationID is the unique identifier of the push reception device. By default, it is automatically generated when push service registration succeeds, and you can also customize settings. Based on RegistrationID, you can push messages to the specified device. Notably, Uninstall and reinstall the device will change RegistrationID, so you need to call the setRegistrationID API before registering push service.|
+|GetRegistrationID|After successfully registering push service, you can obtain the unique identifier ID of the push reception device, namely RegistrationID, by calling the getRegistrationID API. Based on RegistrationID, you can push messages to the specified device.|
+
+#### Global Listening Interface for Push
+
+|API|Description|
+|---------|---------|
+|AddPushListener|Add a Push Listener.|
+|RemovePushListener|Remove a Push Listener.|
+
+#### Custom Configuration API
+
+|API|Description|
+|---------|---------|
+|ForceUseFCMPushChannel|Specify device offline push to use FCM channel, need to register push service before calling.|
+|DisablePostNotificationInForeground|Disable pop-up notifications when the App is in the foreground.|
+
+### API Detail
+
+#### Static Public Member Function
+
+static PushManager* GetInstance(): Get the PushManager manager instance.
+
+#### Member Function Description
+
+##### virtual void RegisterPush(int sdkAppId, const FString& appKey, PushValueCallback<FString>* callback) = 0;
+
+To register the push service, transmit both parameters sdkAppId and appKey, and just register the push service.
+
+Parameter description:
+| Parameter | Description | Access Path |
+| --- | --- | --- |
+| sdkAppId | The IM console assigned the app ID to you. |  |
+| appKey | The IM console assigned the client key to you. |  |
+
+##### virtual void UnRegisterPush(PushCallback* callback) = 0;
+
+Unregister and disable push service.
+
+##### virtual void SetRegistrationID(const FString& registrationID, PushCallback* callback) = 0;
+
+Set the push ID flag used for push service registration, i.e., RegistrationID, which needs to be called before registering the push service.
+
+Parameter description:
+
+|Parameter|Description|
+|---------|---------|
+|registrationID|The push unique identifier ID of the device may change after uninstall reinstall.|
+
+##### virtual void GetRegistrationID(PushValueCallback<FString>* callback) = 0;
+
+After successful registration of push service, obtain the push ID flag, i.e., RegistrationID.
+
+##### virtual void AddPushListener(PushListener* listener) = 0;
+
+Add a Push Listener
+
+##### virtual void RemovePushListener(PushListener* listener) = 0;
+
+Remove a Push Listener
+
+##### virtual void ForceUseFCMPushChannel(bool enable) = 0;
+
+Specify device offline push to use FCM channel, need to register push service before calling.
+
+Parameter description:
+| Parameter | Description |
+| --- | --- |
+| enable | - true: Use the FCM channel.<br>- false: Use the local machine channel. |
+
+##### virtual void DisablePostNotificationInForeground(bool disable) = 0;
+
+Disable pop-up notifications in the Notification bar when the App is in the foreground. When the Push SDK receives an online push, it automatically adds a Notification prompt to the Notification bar. If you want to handle online push messages yourself, you can call this API to disable the automatic pop-up Notification bar feature.
+
+Parameter description:
+| Parameter | Description |
+| --- | --- |
+| disable | - true: It is disabled.<br>- false: It is enabled. |
+
+## PushListener
+
+PushListener: Push Listener class
+
+### API Overview
+
+|API|Description|
+|---------|---------|
+|OnRecvPushMessage|Push message received.|
+|OnRevokePushMessage|Push message recall notification received.|
+|OnNotificationClicked|Click notification bar message Webhook.|
+
+### API Detail
+
+#### Member Function Description
+
+##### virtual void OnRecvPushMessage(const PushMessage& message) {}
+
+Push message received. Message received.
+
+##### virtual void OnRevokePushMessage(const FString& messageID) {}
+
+Push message recall notification received. messageID: unique message identifier.
+
+##### virtual void OnNotificationClicked(const FString& ext) {}
+
+Click notification bar message Webhook.
+
+> **Note:**
+>
+> Note: Push Certificate in the console need to configure "open specified in-app page" and use populate by default to take effect.
+>

package/resource/knowledge/push/config/android.md

@@ -17,7 +17,6 @@ Explanation of the **Subsequent Actions** option:
 
    > **Note：**
    >
-
    > Each vendor only supports the configuration of one certificate.
    >
 
@@ -68,13 +67,12 @@ For receipt configuration, please refer to: [Message Delivery Statistics Configu
 
    > **Note:**
    >
-
    > Regarding **Click for Subsequent Actions** supports the Report Statistics feature:
    >
->   1. If you choose to open an app or a web page, purchasing the plugin will by default support reporting statistics.
->   2. If you choose to open a specified interface within the application:
->   - For new certificate status, please directly use the auto-fill default value to support click statistics reporting.
->   - If there was a certificate configured previously, continue using the old certificate and modify it to the default value to support reporting statistics, or regenerate a new certificate.
+   > 1. If you choose to open an app or a web page, purchasing the plugin will by default support reporting statistics.
+   > 2. If you choose to open a specified interface within the application:
+   > - For new certificate status, please directly use the auto-fill default value to support click statistics reporting.
+   > - If there was a certificate configured previously, continue using the old certificate and modify it to the default value to support reporting statistics, or regenerate a new certificate.
 
 ### About FCM Data Messaging
 
@@ -87,6 +85,5 @@ FCM provides two push methods: Notification Message and Data Messaging.
 
    > **Note:**
    >
-
    > FCM data messaging capability only supports TIMPush version 7.8 and above on pixel phones. Other manufacturers' devices need to be tested for support.
    >

package/resource/knowledge/push/config/harmonyos.md

@@ -1,6 +1,5 @@
 > **Note:**
 >
-
 > Each vendor only supports the configuration of one certificate.
 >
 
@@ -22,7 +21,6 @@
 
       > **Note:**
       >
-
       > Certificate request file (CSR) need to be applied for in DevEco Studio. For details, see [generate certificate request file](https://developer.huawei.com/consumer/cn/doc/harmonyos-guides/ide-signing#section462703710326).
       >
 
@@ -38,7 +36,6 @@
 
       > **Note:**
       >
-
       > Note: For how to obtain UDID for different device types, please refer to [UDID Retrieval Method](https://developer.huawei.com/consumer/cn/doc/app/agc-help-add-device-0000001946142249#section67331926102911).
       >