notification-subscription.md

# Notification Subscription (Open Only to System Applications)


To receive notifications, an application must subscribe to notifications first. The notification subsystem provides two types of subscription APIs, allowing applications to subscribe to notifications from all applications or notifications from a specific application.


You can use the **NotificationSubscriber** object to provide callbacks for subscription events, such as subscription success, notification reception, notification cancellation, and subscription cancellation.


## Available APIs

The major APIs for notification subscription are described as follows. For details about the APIs, see [@ohos.notificationSubscribe](../reference/apis/js-apis-notificationSubscribe.md).

**Table 1** Major APIs for notification subscription

| Name | Description|
| -------- | -------- |
| subscribe(subscriber: NotificationSubscriber, info: NotificationSubscribeInfo, callback: AsyncCallback<void>): void | Subscribes to notifications from a specific application.|
| subscribe(subscriber: NotificationSubscriber, callback: AsyncCallback<void>): void                                  | Subscribes to notifications from all applications.    |

**Table 2** Callbacks for notification subscription

| Name | Description|
| -------- | -------- |
| onConsume?:(data: SubscribeCallbackData) => void                                      | Callback for receiving notifications.              |
| onCancel?:(data: SubscribeCallbackData) => void                                       | Callback for canceling notifications.          |
| onUpdate?:(data: NotificationSortingMap) => void                                      | Callback for notification sorting updates.      |
| onConnect?:() => void;                                                                | Callback for subscription.          |
| onDisconnect?:() => void;                                                             | Callback for unsubscription.          |
| onDestroy?:() => void                                                                 | Callback for disconnecting from the notification subsystem.  |
| onDoNotDisturbDateChange?:(mode: notification.DoNotDisturbDate) => void               | Callback for the Do Not Disturb (DNT) time changes.|
| onEnabledNotificationChanged?:(callbackData: EnabledNotificationCallbackData) => void | Callback for notification switch changes.      |


## How to Develop

1. Request the **ohos.permission.NOTIFICATION_CONTROLLER** permission. For details, see [Permission Application Guide](../security/accesstoken-guidelines.md#declaring-permissions-in-the-configuration-file).

2. Import the **notificationSubscribe** module.
   
   ```ts
   import notificationSubscribe from '@ohos.notificationSubscribe';
   ```

3. Create a **subscriber** object.
   
   ```ts
   let subscriber = {
       onConsume: function (data) {
           let req = data.request;
           console.info('[ANS] onConsume callback req.id: ' + req.id);
       },
       onCancel: function (data) {
           let req = data.request;
           console.info('[ANS] onCancel callback req.id: : ' + req.id);
       },
       onUpdate: function (data) {
           console.info('[ANS] onUpdate in test');
       },
       onConnect: function () {
           console.info('[ANS] onConnect in test');
       },
       onDisconnect: function () {
           console.info('[ANS] onDisConnect in test');
       },
       onDestroy: function () {
           console.info('[ANS] onDestroy in test');
       },
   };
   ```

4. Initiate notification subscription.
   
   ```ts
   notificationSubscribe.subscribe(subscriber, (err, data) => { // This API uses an asynchronous callback to return the result.
     if (err) {
       console.error(`[ANS] failed to subscribe, error[${err}]`);
       return;
     }
     console.info(`[ANS] subscribeTest success : + ${data}`);
   });
   ```