@tencent-rtc/mcp 1.6.4 → 1.6.6

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.

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.
+>