HarmonyOS
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. By default, it is system-generated when push service registration succeeds. You can also customize settings. Based on RegistrationID, you can send 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 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
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. |  |
appKey | String | Push Service client key. | |
businessId | number | Certificate ID assigned in the Chat console. |  |
Unregistering and Disabling Push Service
API
unRegisterPush(): Promise<TIMPushResult>;
Setting Push ID Identifier RegistrationID
Note:
1. If you call this API, ensure to call it before
registerPush.API
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
getRegistrationID(): Promise<TIMPushResult>;
Adding a Push Listener
API
addPushListener(listener: TIMPushListener): void;
Parameter description:
Parameter | Type | Description |
listener | Push event processing method |
Removing a Push Listener
API
removePushListener(listener: TIMPushListener): void;
Parameter description:
Parameter | Type | Description |
listener | Push event processing method |
Enabling/Disabling Notification Bar Notifications When the App Is in the Foreground
API
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). Disable notification bar notifications when the app is in the foreground. 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.
