@ohos.application.NotificationSubscriberExtensionAbility (ExtensionAbility for Notification Subscription)

NotificationSubscriberExtensionAbility is the base class for notification subscription extensions, providing the core functionality for subscribing to notifications.

NOTE

The initial APIs of this module are supported since API version 22. Newly added APIs will be marked with a superscript to indicate their earliest API version. The APIs of this module can be used only in the stage model.

Modules to Import

import { notificationExtensionSubscription, NotificationSubscriberExtensionAbility } from '@kit.NotificationKit';

NotificationSubscriberExtensionAbility

System capability: SystemCapability.Notification.Notification

Name	Type	Read-Only	Optional	Description
context	NotificationSubscriberExtensionContext	No	No	Context for the NotificationSubscriberExtensionAbility.

onDestroy

onDestroy(): void

Called when the notification subscription extension is destroyed.

System capability: SystemCapability.Notification.Notification

Example:

const TAG = 'NotificationSubscriberExtAbility';

export default class NotificationSubscriberExtAbility extends NotificationSubscriberExtensionAbility {
  onDestroy(): void {
    console.info(`${TAG} onDestroy`);
  }
}

onReceiveMessage

onReceiveMessage(notificationInfo: NotificationInfo): void

Called when a notification is received.

System capability: SystemCapability.Notification.Notification

Parameters

Name	Type	Mandatory	Description
notificationInfo	NotificationInfo	Yes	Notification information delivered to the onReceiveMessage callback of ExtensionAbility for notification subscriptions.

Example:

const TAG = 'NotificationSubscriberExtAbility';

export default class NotificationSubscriberExtAbility extends NotificationSubscriberExtensionAbility {
  onReceiveMessage(notificationInfo: notificationExtensionSubscription.NotificationInfo): void {
    console.info(`${TAG} onReceiveMessage. notificationInfo: ${JSON.stringify(notificationInfo)}`);
  }
}

onCancelMessages

onCancelMessages(hashCodes: Array<string>): void

Called when notifications are canceled.

System capability: SystemCapability.Notification.Notification

Parameters

Name	Type	Mandatory	Description
hashCodes	Array<string>	Yes	Array of hash codes representing the notifications to be canceled.

Example:

const TAG = 'NotificationSubscriberExtAbility';

export default class NotificationSubscriberExtAbility extends NotificationSubscriberExtensionAbility {
  onCancelMessages(hashCodes: Array<string>): void {
    console.info(`${TAG} onCancelMessages. hashCodes: ${JSON.stringify(hashCodes)}`);
  }
}