目录

@ohos.notificationManager (NotificationManager)

This module provides notification management capabilities. Applications can use this module to implement the complete lifecycle management of notifications, including publishing, updating, and canceling notifications; creating and querying notification slots; querying and requesting the authorization status of the notification capability; setting app badges; and querying existing notifications in the notification center.

APIs used in combination:

The APIs of this module follow the following workflow of notifications: Authorization → Publishing → Cancellation → Channel Management. The APIs are designed to be used in combination with one another.

  1. Authorization query and request process: Before publishing a notification, first query the authorization status of the notification capability through isNotificationEnabled. If the notification capability is not authorized, guide the user to enable the notification permission through requestEnableNotification.

  2. Notification publishing and updating process: Publish a notification through publish, and specify the notification content through NotificationRequest. If the ID and label of the newly published notification are the same as those of an existing notification, the existing notification is automatically updated. If the ID or label of the newly published notification differs from those of an existing notification, a new notification is created.

  3. Notification cancellation process: Cancel a notification with a specified ID through cancel, cancel all notifications of this application through cancelAll, and cancel notifications under a specified group through cancelGroup.

  4. Notification slot management process: Create a notification slot through addSlot, query notification slot configurations through getSlot/getSlots, and delete notification slots through removeSlot/removeAllSlots. It is recommended to create the corresponding type of notification slot before publishing a notification. In addition to using addSlot to create a notification slot, you can also carry the notificationSlotType field in the NotificationRequest when publishing a notification. If a slot of the corresponding type does not exist, it will be automatically created.

  5. Badge management process: Set the badge number through setBadgeNumber, or when publishing a notification through the publish API, carry the number of badges to be incremented in the badgeNumber field in NotificationRequest.

  6. Existing notification query process: Obtain the number of existing notifications for this application in the notification center through getActiveNotificationCount, and obtain the details of existing notifications for this application in the notification center through getActiveNotifications.

The initial APIs of this module are supported since API version 9. Newly added APIs will be marked with a superscript to indicate their earliest API version.

Modules to Import

import { notificationManager } from '@kit.NotificationKit';

notificationManager.publish

publish(request: NotificationRequest, callback: AsyncCallback<void>): void

Publishes a notification. This API uses an asynchronous callback to return the result.

After a notification is published, it is displayed as a notification card in the notification center, status bar, and other locations on the device. If the ID and label of the newly published notification are the same as those of an already published notification, the new notification replaces the original notification, achieving the effect of updating the notification.

System capability: SystemCapability.Notification.Notification

Parameters

Name Type Mandatory Description
request NotificationRequest Yes Content and related configuration of the notification to publish.
callback AsyncCallback<void> Yes Callback used to return the result. If the operation is successful, err is undefined; otherwise, err is an error object.

Error codes

For details about the error codes, see Universal Error Codes, Notification Error Codes, and HTTP Error Codes.

ID Error Message
401 Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. 2. Incorrect parameter types. 3. Parameter verification failed.
1600001 Internal error.
1600002 Marshalling or unmarshalling error.
1600003 Failed to connect to the service.
1600004 Notification disabled.
1600005 Notification slot disabled.
1600007

The notification does not exist.

Applicable versions: 11+
1600009 The notification sending frequency reaches the upper limit.
1600012 No memory space.
1600014

No permission.

Applicable versions: 11+
1600015

The current notification status does not support duplicate configurations.

Applicable versions: 11+
1600016

The notification version for this update is too low.

Applicable versions: 11+
1600020

The application is not allowed to send notifications due to permission settings.

Applicable versions: 12+
1600029

The system failed to find the ExtensionAbility instance for the custom Live View widget template.

Applicable versions: 26.0.0+
2300007

Network unreachable.

Applicable versions: 11+

Example

import { BusinessError } from '@kit.BasicServicesKit';

// publish callback
let publishCallback = (err: BusinessError): void => {
  if (err) {
    console.error(`Failed to publish notification. Code is ${err.code}, message is ${err.message}`);
  } else {
    console.info(`Succeeded in publishing notification.`);
  }
}
// NotificationRequest object
let notificationRequest: notificationManager.NotificationRequest = {
  id: 1,
  content: {
    notificationContentType: notificationManager.ContentType.NOTIFICATION_CONTENT_BASIC_TEXT,
    normal: {
      title: 'test_title',
      text: 'test_text',
      additionalText: 'test_additionalText'
    }
  }
};
notificationManager.publish(notificationRequest, publishCallback);

notificationManager.publish

publish(request: NotificationRequest): Promise<void>

Publishes a notification. This API uses a promise to return the result.

After a notification is published, it is displayed as a notification card in the notification center, status bar, and other locations on the device. If the ID and label of the newly published notification are the same as those of an already published notification, the new notification replaces the original notification, achieving the effect of updating the notification.

System capability: SystemCapability.Notification.Notification

Parameters

Name Type Mandatory Description
request NotificationRequest Yes Content and related configuration of the notification to publish.

Return value

Type Description
Promise<void> Promise that returns no value.

Error codes

For details about the error codes, see Universal Error Codes, Notification Error Codes, and HTTP Error Codes.

ID Error Message
401 Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. 2. Incorrect parameter types. 3. Parameter verification failed.
1600001 Internal error.
1600002 Marshalling or unmarshalling error.
1600003 Failed to connect to the service.
1600004 Notification disabled.
1600005 Notification slot disabled.
1600007

The notification does not exist.

Applicable versions: 11+
1600009 The notification sending frequency reaches the upper limit.
1600012 No memory space.
1600014

No permission.

Applicable versions: 11+
1600015

The current notification status does not support duplicate configurations.

Applicable versions: 11+
1600016

The notification version for this update is too low.

Applicable versions: 11+
1600020

The application is not allowed to send notifications due to permission settings.

Applicable versions: 12+
1600029

The system failed to find the ExtensionAbility instance for the custom Live View widget template.

Applicable versions: 26.0.0+
2300007

Network unreachable.

Applicable versions: 11+

Example

import { BusinessError } from '@kit.BasicServicesKit';

// NotificationRequest object
let notificationRequest: notificationManager.NotificationRequest = {
  id: 1,
  content: {
    notificationContentType: notificationManager.ContentType.NOTIFICATION_CONTENT_BASIC_TEXT,
    normal: {
      title: 'test_title',
      text: 'test_text',
      additionalText: 'test_additionalText'
    }
  }
};
notificationManager.publish(notificationRequest).then(() => {
  console.info(`Succeeded in publishing notification.`);
}).catch((err: BusinessError) => {
  console.error(`Failed to publish notification. Code is ${err.code}, message is ${err.message}`);
});

notificationManager.cancel

cancel(id: number, label: string, callback: AsyncCallback<void>): void

Cancels a published notification based on the notification ID and label. This API uses an asynchronous callback to return the result.

After cancellation, the corresponding notification is removed from the notification center, status bar, and other locations, and is no longer visible to the user. This is suitable for scenarios where a specific notification with a particular label needs to be canceled precisely.

Compared with notificationManager.cancel(id, callback), which requires only the notification ID, this API additionally has the label parameter, allowing precise cancellation of notifications with the same ID but different labels.

System capability: SystemCapability.Notification.Notification

Parameters

Name Type Mandatory Description
id number Yes Notification ID, used to identify the target notification. This value is specified by the id field in NotificationRequest when a notification is published.
label string Yes

Notification label. This value is specified by the label field in NotificationRequest when a notification is published.

- If the label field is empty, the published notification that matches the specified notification ID and has an empty label is canceled.

- If the label field is not empty, the published notification that matches both the specified notification ID and label is canceled.
callback AsyncCallback<void> Yes Callback used to return the result. If the operation is successful, err is undefined; otherwise, err is an error object.

Error codes

For details about the error codes, see Universal Error Codes and Notification Error Codes.

ID Error Message
401 Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. 2. Incorrect parameter types. 3. Parameter verification failed.
1600001 Internal error.
1600002 Marshalling or unmarshalling error.
1600003 Failed to connect to the service.
1600007 The notification does not exist.

Example

import { BusinessError } from '@kit.BasicServicesKit';

// cancel callback
let cancelCallback = (err: BusinessError): void => {
  if (err) {
    console.error(`Failed to cancel notification. Code is ${err.code}, message is ${err.message}`);
  } else {
    console.info(`Succeeded in canceling notification.`);
  }
}
notificationManager.cancel(0, 'label', cancelCallback);

notificationManager.cancel

cancel(id: number, label?: string): Promise<void>

Cancels a published notification based on the notification ID and label. This API uses a promise to return the result.

After cancellation, the corresponding notification is removed from the notification center, status bar, and other locations, and is no longer visible to the user.

System capability: SystemCapability.Notification.Notification

Parameters

Name Type Mandatory Description
id number Yes Notification ID, used to identify the target notification. This value is specified by the id field in NotificationRequest when a notification is published.
label string No

Notification label. The default value is empty. This value is specified by the label field in NotificationRequest when a notification is published.

- If the label field is empty, the published notification that matches the specified notification ID and has an empty label is canceled.

- If the label field is not empty, the published notification that matches both the specified notification ID and label is canceled.

Return value

Type Description
Promise<void> Promise that returns no value.

Error codes

For details about the error codes, see Universal Error Codes and Notification Error Codes.

ID Error Message
401 Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. 2. Incorrect parameter types. 3. Parameter verification failed.
1600001 Internal error.
1600002 Marshalling or unmarshalling error.
1600003 Failed to connect to the service.
1600007 The notification does not exist.

Example

import { BusinessError } from '@kit.BasicServicesKit';

notificationManager.cancel(0).then(() => {
  console.info(`Succeeded in canceling notification.`);
}).catch((err: BusinessError) => {
  console.error(`Failed to cancel notification. Code is ${err.code}, message is ${err.message}`);
});

notificationManager.cancel

cancel(id: number, callback: AsyncCallback<void>): void

Cancels a notification with the specified ID. This API uses an asynchronous callback to return the result.

After cancellation, the corresponding notification is removed from the notification center, status bar, and other locations, and is no longer visible to the user.

Compared with notificationManager.cancel(id, label, callback), which includes the label parameter, this API does not pass in a label and will cancel the notification matching the specified ID. When a notification is published with a non-empty label, the notificationManager.cancel(id, label, callback) API must be used to cancel it.

System capability: SystemCapability.Notification.Notification

Parameters

Name Type Mandatory Description
id number Yes Notification ID, used to identify the target notification. This value is specified by the id field in NotificationRequest when a notification is published.
callback AsyncCallback<void> Yes Callback used to return the result. If the operation is successful, err is undefined; otherwise, err is an error object.

Error codes

For details about the error codes, see Universal Error Codes and Notification Error Codes.

ID Error Message
401 Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. 2. Incorrect parameter types. 3. Parameter verification failed.
1600001 Internal error.
1600002 Marshalling or unmarshalling error.
1600003 Failed to connect to the service.
1600007 The notification does not exist.

Example

import { BusinessError } from '@kit.BasicServicesKit';

// cancel callback
let cancelCallback = (err: BusinessError): void => {
  if (err) {
    console.error(`Failed to cancel notification. Code is ${err.code}, message is ${err.message}`);
  } else {
    console.info(`Succeeded in canceling notification.`);
  }
}
notificationManager.cancel(0, cancelCallback);

notificationManager.cancelAll

cancelAll(callback: AsyncCallback<void>): void

Cancels all notifications of this application. This API uses an asynchronous callback to return the result.

After cancellation, all notifications of the current application are removed from the notification center, status bar, and other locations, and are no longer visible to the user. This is suitable for scenarios where the application exits or the user manually clears all notifications.

System capability: SystemCapability.Notification.Notification

Parameters

Name Type Mandatory Description
callback AsyncCallback<void> Yes Callback used to return the result. If the operation is successful, err is undefined; otherwise, err is an error object.

Error codes

For details about the error codes, see Universal Error Codes and Notification Error Codes.

ID Error Message
401 Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. 2. Incorrect parameter types. 3. Parameter verification failed.
1600001 Internal error.
1600002 Marshalling or unmarshalling error.
1600003 Failed to connect to the service.

Example

import { BusinessError } from '@kit.BasicServicesKit';

// cancelAll callback.
let cancelAllCallback = (err: BusinessError): void => {
  if (err) {
    console.error(`Failed to cancel all notification. Code is ${err.code}, message is ${err.message}`);
  } else {
    console.info(`Succeeded in canceling all notification.`);
  }
}
notificationManager.cancelAll(cancelAllCallback);

notificationManager.cancelAll

cancelAll(): Promise<void>

Cancels all notifications of this application. This API uses a promise to return the result.

After cancellation, all notifications of the current application are removed from the notification center, status bar, and other locations, and are no longer visible to the user. This is suitable for scenarios where the application exits or the user manually clears all notifications.

System capability: SystemCapability.Notification.Notification

Return value

Type Description
Promise<void> Promise that returns no value.

Error codes

For details about the error codes, see Notification Error Codes.

ID Error Message
1600001 Internal error.
1600002 Marshalling or unmarshalling error.
1600003 Failed to connect to the service.

Example

import { BusinessError } from '@kit.BasicServicesKit';

notificationManager.cancelAll().then(() => {
  console.info(`Succeeded in canceling all notification.`);
}).catch((err: BusinessError) => {
  console.error(`Failed to cancel all notification. Code is ${err.code}, message is ${err.message}`);
});

notificationManager.addSlot

addSlot(type: SlotType, callback: AsyncCallback<void>): void

Creates a notification slot of the specified type. This API uses an asynchronous callback.

The notification slot NotificationSlot defines the reminder mode (such as alert sound, vibration, and banner) and level of a notification. Before publishing a notification, the application needs to create a corresponding type of notification slot first, or the system will automatically create a corresponding type of notification slot when the notification is published. Only one notification slot of the same type can be created.

System capability: SystemCapability.Notification.Notification

Parameters

Name Type Mandatory Description
type SlotType Yes Notification slot type to create. Different slot types correspond to different default SlotLevel values, which affect the notification reminder mode. For example, SOCIAL_COMMUNICATION corresponds to LEVEL_HIGH (status bar icon + banner + sound), and CONTENT_INFORMATION corresponds to LEVEL_MIN (no status bar icon + no banner + no sound).
callback AsyncCallback<void> Yes Callback used to return the result. If the operation is successful, err is undefined; otherwise, err is an error object.

Error codes

For details about the error codes, see Universal Error Codes and Notification Error Codes.

ID Error Message
401 Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. 2. Incorrect parameter types. 3. Parameter verification failed.
1600001 Internal error.
1600002 Marshalling or unmarshalling error.
1600003 Failed to connect to the service.
1600012 No memory space.

Example

import { BusinessError } from '@kit.BasicServicesKit';

// addSlot callback
let addSlotCallback = (err: BusinessError): void => {
  if (err) {
    console.error(`Failed to add slot. Code is ${err.code}, message is ${err.message}`);
  } else {
    console.info(`Succeeded in adding slot.`);
  }
}
notificationManager.addSlot(notificationManager.SlotType.SOCIAL_COMMUNICATION, addSlotCallback);

notificationManager.addSlot

addSlot(type: SlotType): Promise<void>

Creates a notification slot of a specified type. This API uses a promise to return the result.

The notification slot NotificationSlot defines the reminder mode (such as alert sound, vibration, and banner) and level of a notification. Before publishing a notification, the application needs to create a corresponding type of notification slot first, or the system will automatically create a corresponding type of notification slot when the notification is published. Only one notification slot of the same type can be created.

System capability: SystemCapability.Notification.Notification

Parameters

Name Type Mandatory Description
type SlotType Yes Notification slot type to create. Different slot types correspond to different default SlotLevel values, which affect the notification reminder mode. For example, SOCIAL_COMMUNICATION corresponds to LEVEL_HIGH (status bar icon + banner + sound), and CONTENT_INFORMATION corresponds to LEVEL_MIN (no status bar icon + no banner + no sound).

Return value

Type Description
Promise<void> Promise that returns no value.

Error codes

For details about the error codes, see Universal Error Codes and Notification Error Codes.

ID Error Message
401 Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. 2. Incorrect parameter types. 3. Parameter verification failed.
1600001 Internal error.
1600002 Marshalling or unmarshalling error.
1600003 Failed to connect to the service.
1600012 No memory space.

Example

import { BusinessError } from '@kit.BasicServicesKit';

notificationManager.addSlot(notificationManager.SlotType.SOCIAL_COMMUNICATION).then(() => {
  console.info(`Succeeded in adding slot.`);
}).catch((err: BusinessError) => {
  console.error(`Failed to add slot. Code is ${err.code}, message is ${err.message}`);
});

notificationManager.getSlot

getSlot(slotType: SlotType, callback: AsyncCallback<NotificationSlot>): void

Obtains a notification slot of a specified type. This API uses an asynchronous callback to return the result.

This API is used to query the detailed configuration information of a created notification slot, including settings such as reminder mode, level, and lock screen display. A corresponding type of notification slot must be created first through addSlot, otherwise the obtained result will be empty.

System capability: SystemCapability.Notification.Notification

Parameters

Name Type Mandatory Description
slotType SlotType Yes Type of a notification slot, such as social communication, service notification, content consultation, and so on.
callback AsyncCallback<NotificationSlot> Yes Callback used to return the result. If the notification slot is obtained successfully, err is undefined and data is the obtained NotificationSlot; otherwise, err is an error object.

Error codes

For details about the error codes, see Universal Error Codes and Notification Error Codes.

ID Error Message
401 Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. 2. Incorrect parameter types. 3. Parameter verification failed.
1600001 Internal error.
1600002 Marshalling or unmarshalling error.
1600003 Failed to connect to the service.

Example

import { BusinessError } from '@kit.BasicServicesKit';

// getSlot callback
let getSlotCallback = (err: BusinessError, data: notificationManager.NotificationSlot): void => {
  if (err) {
    console.error(`Failed to get slot. Code is ${err.code}, message is ${err.message}`);
  } else {
    console.info(`Succeeded in getting slot, data is ${JSON.stringify(data)}`);
  }
}
let slotType: notificationManager.SlotType = notificationManager.SlotType.SOCIAL_COMMUNICATION;
notificationManager.getSlot(slotType, getSlotCallback);

notificationManager.getSlot

getSlot(slotType: SlotType): Promise<NotificationSlot>

Obtains a notification slot of a specified type. This API uses a promise to return the result.

This API is used to query the detailed configuration information of a created notification slot, including settings such as reminder mode, level, and lock screen display. A corresponding type of notification slot must be created first through addSlot, otherwise the obtained result will be empty.

System capability: SystemCapability.Notification.Notification

Parameters

Name Type Mandatory Description
slotType SlotType Yes Type of a notification slot, such as social communication, service notification, content consultation, and so on.

Return value

Type Description
Promise<NotificationSlot> Promise used to return the result.

Error codes

For details about the error codes, see Universal Error Codes and Notification Error Codes.

ID Error Message
401 Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. 2. Incorrect parameter types. 3. Parameter verification failed.
1600001 Internal error.
1600002 Marshalling or unmarshalling error.
1600003 Failed to connect to the service.

Example

import { BusinessError } from '@kit.BasicServicesKit';

let slotType: notificationManager.SlotType = notificationManager.SlotType.SOCIAL_COMMUNICATION;
notificationManager.getSlot(slotType).then((data: notificationManager.NotificationSlot) => {
  console.info(`Succeeded in getting slot, data is ${JSON.stringify(data)}`);
}).catch((err: BusinessError) => {
  console.error(`Failed to get slot. Code is ${err.code}, message is ${err.message}`);
});

notificationManager.getSlots

getSlots(callback: AsyncCallback<Array<NotificationSlot>>): void

Obtains all notification slots of the current application. This API uses an asynchronous callback to return the result.

This API is used to batch query the configuration information of all notification slots created by the current application, including settings such as the type, reminder mode, and level of each slot. This is suitable for scenarios where all slot configurations need to be viewed. The corresponding notification slots must be created through addSlot first; otherwise, the obtained result will be empty.

System capability: SystemCapability.Notification.Notification

Parameters

Name Type Mandatory Description
callback AsyncCallback<Array<NotificationSlot>> Yes Callback used to return the result. If the notification slots are obtained successfully, err is undefined and data is the obtained NotificationSlot array. Otherwise, err is an error object.

Error codes

For details about the error codes, see Universal Error Codes and Notification Error Codes.

ID Error Message
401 Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. 2. Incorrect parameter types. 3. Parameter verification failed.
1600001 Internal error.
1600002 Marshalling or unmarshalling error.
1600003 Failed to connect to the service.

Example

import { BusinessError } from '@kit.BasicServicesKit';

// getSlots callback
let getSlotsCallback = (err: BusinessError, data: Array<notificationManager.NotificationSlot>): void => {
  if (err) {
    console.error(`Failed to get slots. Code is ${err.code}, message is ${err.message}`);
  } else {
    console.info(`Succeeded in getting slots, data is ${JSON.stringify(data)}`);
  }
}
notificationManager.getSlots(getSlotsCallback);

notificationManager.getSlots

getSlots(): Promise<Array<NotificationSlot>>

Obtains all notification slots of the current application. This API uses a promise to return the result.

This API is used to batch query the configuration information of all notification slots created by the current application, including settings such as the type, reminder mode, and level of each slot. This is suitable for scenarios where all slot configurations need to be viewed. The corresponding notification slots must be created through addSlot first; otherwise, the obtained result will be empty.

System capability: SystemCapability.Notification.Notification

Return value

Type Description
Promise<Array<NotificationSlot>> Promise used to return the notification slot object array.

Error codes

For details about the error codes, see Notification Error Codes.

ID Error Message
1600001 Internal error.
1600002 Marshalling or unmarshalling error.
1600003 Failed to connect to the service.

Example

import { BusinessError } from '@kit.BasicServicesKit';

notificationManager.getSlots().then((data: Array<notificationManager.NotificationSlot>) => {
  console.info(`Succeeded in getting slots, data is ${JSON.stringify(data)}`);
}).catch((err: BusinessError) => {
  console.error(`Failed to get slots. Code is ${err.code}, message is ${err.message}`);
});

notificationManager.removeSlot

removeSlot(slotType: SlotType, callback: AsyncCallback<void>): void

Removes a notification slot of a specified type for the current application. This API uses an asynchronous callback to return the result.

After deletion, the corresponding type of notification slot and its configuration will be permanently removed. When a notification of this type is published subsequently, the system will automatically create a default slot. Notifications already published through this slot are not affected and can still be viewed in the notification center. This is applicable to scenarios where the slot needs to be deleted and then re-created for reconfiguration.

System capability: SystemCapability.Notification.Notification

Parameters

Name Type Mandatory Description
slotType SlotType Yes Notification slot type, for example, social communication, service reminder, content consultation, and so on. The slot type to be passed in must have been created; otherwise, the deletion operation does not take effect.
callback AsyncCallback<void> Yes Callback used to return the result. If the operation is successful, err is undefined; otherwise, err is an error object.

Error codes

For details about the error codes, see Universal Error Codes and Notification Error Codes.

ID Error Message
401 Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. 2. Incorrect parameter types. 3. Parameter verification failed.
1600001 Internal error.
1600002 Marshalling or unmarshalling error.
1600003 Failed to connect to the service.

Example

import { BusinessError } from '@kit.BasicServicesKit';

// removeSlot callback
let removeSlotCallback = (err: BusinessError): void => {
  if (err) {
    console.error(`Failed to remove slot. Code is ${err.code}, message is ${err.message}`);
  } else {
    console.info(`Succeeded in removing slot.`);
  }
}
let slotType: notificationManager.SlotType = notificationManager.SlotType.SOCIAL_COMMUNICATION;
notificationManager.removeSlot(slotType, removeSlotCallback);

notificationManager.removeSlot

removeSlot(slotType: SlotType): Promise<void>

Removes a notification slot of a specified type for the current application. This API uses a promise to return the result.

After deletion, the corresponding type of notification slot and its configuration will be permanently removed. When a notification of this type is published subsequently, the system will automatically create a default slot. Notifications already published through this slot are not affected and can still be viewed in the notification center. This is applicable to scenarios where the slot needs to be deleted and then re-created for reconfiguration.

System capability: SystemCapability.Notification.Notification

Parameters

Name Type Mandatory Description
slotType SlotType Yes Notification slot type, for example, social communication, service reminder, content consultation, and so on. The slot type to be passed in must have been created; otherwise, the deletion operation does not take effect.

Return value

Type Description
Promise<void> Promise that returns no value.

Error codes

For details about the error codes, see Universal Error Codes and Notification Error Codes.

ID Error Message
401 Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. 2. Incorrect parameter types. 3. Parameter verification failed.
1600001 Internal error.
1600002 Marshalling or unmarshalling error.
1600003 Failed to connect to the service.

Example

import { BusinessError } from '@kit.BasicServicesKit';

let slotType: notificationManager.SlotType = notificationManager.SlotType.SOCIAL_COMMUNICATION;
notificationManager.removeSlot(slotType).then(() => {
  console.info(`Succeeded in removing slot.`);
}).catch((err: BusinessError) => {
  console.error(`Failed to remove slot. Code is ${err.code}, message is ${err.message}`);
});

notificationManager.removeAllSlots

removeAllSlots(callback: AsyncCallback<void>): void

Removes all notification slots of the current application. This API uses an asynchronous callback to return the result.

After deletion, all notification slots and their configurations of the current application will be permanently removed. When notifications are published subsequently, the system will automatically create slots of the corresponding type. Notifications already published through these slots are not affected and can still be viewed in the notification center. This API is suitable for scenarios where all slot configurations need to be cleared at once.

System capability: SystemCapability.Notification.Notification

Parameters

Name Type Mandatory Description
callback AsyncCallback<void> Yes Callback used to return the result. If the operation is successful, err is undefined; otherwise, err is an error object.

Error codes

For details about the error codes, see Universal Error Codes and Notification Error Codes.

ID Error Message
401 Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. 2. Incorrect parameter types. 3. Parameter verification failed.
1600001 Internal error.
1600002 Marshalling or unmarshalling error.
1600003 Failed to connect to the service.

Example

import { BusinessError } from '@kit.BasicServicesKit';

let removeAllSlotsCallback = (err: BusinessError): void => {
  if (err) {
    console.error(`Failed to remove all slots. Code is ${err.code}, message is ${err.message}`);
  } else {
    console.info(`Succeeded in removing all slots.`);
  }
}
notificationManager.removeAllSlots(removeAllSlotsCallback);

notificationManager.removeAllSlots

removeAllSlots(): Promise<void>

Removes all notification slots for this application. This API uses a promise to return the result.

After deletion, all notification slots and their configurations of the current application will be permanently removed. When notifications are published subsequently, the system will automatically create slots of the corresponding type. Notifications already published through these slots are not affected and can still be viewed in the notification center. This API is suitable for scenarios where all slot configurations need to be cleared at once.

System capability: SystemCapability.Notification.Notification

Return value

Type Description
Promise<void> Promise that returns no value.

Error codes

For details about the error codes, see Notification Error Codes.

ID Error Message
1600001 Internal error.
1600002 Marshalling or unmarshalling error.
1600003 Failed to connect to the service.

Example

import { BusinessError } from '@kit.BasicServicesKit';

notificationManager.removeAllSlots().then(() => {
  console.info(`Succeeded in removing all slots.`);
}).catch((err: BusinessError) => {
  console.error(`Failed to remove all slots. Code is ${err.code}, message is ${err.message}`);
});

notificationManager.isNotificationEnabled11+

isNotificationEnabled(callback: AsyncCallback<boolean>): void

Checks the notification authorization status of the current application. This API uses an asynchronous callback to return the result.

This API is used to check whether the current application is allowed to send notifications before publishing, preventing publish failures when notification authorization is disabled.

System capability: SystemCapability.Notification.Notification

Parameters

Name Type Mandatory Description
callback AsyncCallback<boolean> Yes Callback used to return the result. The value true means that the notification can be published; false means the opposite. If this API call fails, an error object is returned.

Error codes

For details about the error codes, see Universal Error Codes, Notification Error Codes, and Bundle Error Codes.

ID Error Message
401 Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. 2. Incorrect parameter types. 3. Parameter verification failed.
1600001 Internal error.
1600002 Marshalling or unmarshalling error.
1600003 Failed to connect to the service.
1600008 The user does not exist.
17700001 The specified bundle name was not found.

Example

import { BusinessError } from '@kit.BasicServicesKit';

let isNotificationEnabledCallback = (err: BusinessError, data: boolean): void => {
  if (err) {
    console.error(`isNotificationEnabled failed, code is ${err.code}, message is ${err.message}`);
  } else {
    console.info(`isNotificationEnabled success, data is ${JSON.stringify(data)}`);
  }
}

notificationManager.isNotificationEnabled(isNotificationEnabledCallback);

notificationManager.isNotificationEnabled11+

isNotificationEnabled(): Promise<boolean>

Checks the notification authorization status of the current application. This API uses a promise to return the result.

This API is used to check whether the current application is allowed to send notifications before publishing, preventing publish failures when notification authorization is disabled.

System capability: SystemCapability.Notification.Notification

Return value

Type Description
Promise<boolean> Promise used to return the result. The value true means that the notification is enabled, and false means the opposite.

Error codes

For details about the error codes, see Notification Error Codes and Bundle Error Codes.

ID Error Message
1600001 Internal error.
1600002 Marshalling or unmarshalling error.
1600003 Failed to connect to the service.
1600008 The user does not exist.
17700001 The specified bundle name was not found.

Example

import { BusinessError } from '@kit.BasicServicesKit';

notificationManager.isNotificationEnabled().then((data: boolean) => {
  console.info(`isNotificationEnabled success, data: ${JSON.stringify(data)}`);
}).catch((err: BusinessError) => {
  console.error(`isNotificationEnabled failed, code is ${err.code}, message is ${err.message}`);
});

notificationManager.isNotificationEnabledSync12+

isNotificationEnabledSync(): boolean

Synchronously checks the notification authorization status of the current application.

This API is used to quickly check whether the current application is allowed to send notifications before publishing. It is synchronous and returns the result immediately after being called, suitable for scenarios where the notification authorization status needs to be obtained in a synchronous code flow.

System capability: SystemCapability.Notification.Notification

Return value

Type Description
boolean Result of the notification authorization status. The value true means that publishing notifications is allowed, and false means that publishing notifications is prohibited.

Error codes

For details about the error codes, see Notification Error Codes.

ID Error Message
1600001 Internal error.
1600002 Marshalling or unmarshalling error.
1600003 Failed to connect to the service.

Example

let enabled: boolean = notificationManager.isNotificationEnabledSync();
console.info(`isNotificationEnabledSync success, data is : ${JSON.stringify(enabled)}`);

notificationManager.setBadgeNumber10+

setBadgeNumber(badgeNumber: number): Promise<void>

Sets the notification badge number. This API uses a promise to return the result.

A badge is a numeric identifier displayed in the upper right corner of an application's home-screen icon, used to prompt the user about the number of unprocessed notifications. After the badge number is set, the home-screen icon will display the corresponding badge number. This is suitable for scenarios where the number of pending messages needs to be prompted on the home-screen icon, such as the number of unread messages and to-do items.

System capability: SystemCapability.Notification.Notification

Device behavior differences: This API can be properly called on devices other than wearables. If it is called on wearables, error code 801 is returned.

Parameters

Name Type Mandatory Description
badgeNumber number Yes Number of badges. When the badge number is less than or equal to 0, the badge is cleared. When the value is greater than 99, the notification badge displays 99+.

Return value

Type Description
Promise<void> Promise that returns no value.

Error codes

For details about the error codes, see Universal Error Codes and Notification Error Codes.

ID Error Message
401 Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. 2. Incorrect parameter types. 3. Parameter verification failed.
801

Capability not supported.

Applicable versions: 18+
1600001 Internal error.
1600002 Marshalling or unmarshalling error.
1600003 Failed to connect to the service.
1600012 No memory space.

Example

import { BusinessError } from '@kit.BasicServicesKit';

let badgeNumber: number = 10;
notificationManager.setBadgeNumber(badgeNumber).then(() => {
  console.info(`Succeeded in setting badge number.`);
}).catch((err: BusinessError) => {
  console.error(`Failed to set badge number. Code is ${err.code}, message is ${err.message}`);
});

notificationManager.setBadgeNumber10+

setBadgeNumber(badgeNumber: number, callback: AsyncCallback<void>): void

Sets the notification badge number. This API uses an asynchronous callback to return the result.

A badge is a numeric identifier displayed in the upper right corner of an application's home-screen icon, used to prompt the user about the number of unprocessed notifications. After the badge number is set, the home-screen icon will display the corresponding badge number. This is suitable for scenarios where the number of pending messages needs to be prompted on the home-screen icon, such as the number of unread messages and to-do items.

System capability: SystemCapability.Notification.Notification

Device behavior differences: This API can be properly called on devices other than wearables. If it is called on wearables, error code 801 is returned.

Parameters

Name Type Mandatory Description
badgeNumber number Yes Number of badges. When the badge number is less than or equal to 0, the badge is cleared. When the value is greater than 99, the notification badge displays 99+.
callback AsyncCallback<void> Yes Callback used to return the result. If the operation is successful, err is undefined; otherwise, err is an error object.

Error codes

For details about the error codes, see Universal Error Codes and Notification Error Codes.

ID Error Message
401 Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. 2. Incorrect parameter types. 3. Parameter verification failed.
801

Capability not supported.

Applicable versions: 18+
1600001 Internal error.
1600002 Marshalling or unmarshalling error.
1600003 Failed to connect to the service.
1600012 No memory space.

Example

import { BusinessError } from '@kit.BasicServicesKit';

let setBadgeNumberCallback = (err: BusinessError): void => {
  if (err) {
    console.error(`Failed to set badge number. Code is ${err.code}, message is ${err.message}`);
  } else {
    console.info(`Succeeded in setting badge number.`);
  }
}
let badgeNumber: number = 10;
notificationManager.setBadgeNumber(badgeNumber, setBadgeNumberCallback);

notificationManager.getBadgeNumber22+

getBadgeNumber(): Promise<number>

Obtains the badge number of this application. This API uses a promise to return the result.

This API is used to query the badge number displayed on the current application's home-screen icon.

System capability: SystemCapability.Notification.Notification

Return value

Type Description
Promise<number> Promise used to return the badge number. (The value is irrelevant to whether notifications and home-screen badges of this application are enabled.)

Error codes

For details about the error codes, see Notification Error Codes.

ID Error Message
1600001 Internal error.
1600002 Marshalling or unmarshalling error.
1600003 Failed to connect to the service.

Example

import { BusinessError } from '@kit.BasicServicesKit';

notificationManager.getBadgeNumber().then((badgeNumber: number) => {
  console.info(`Succeeded in getting badge number, badgeNumber is ${JSON.stringify(badgeNumber)}`);
}).catch((err: BusinessError) => {
  console.error(`Failed to get badge number. Code is ${err.code}, message is ${err.message}`);
});

notificationManager.getActiveNotificationCount

getActiveNotificationCount(callback: AsyncCallback<number>): void

Obtains the number of active notifications of this application. This API uses an asynchronous callback to return the result.

This API is used to query the number of existing notifications published by the current application in the notification center. This API is suitable for scenarios where the unread notification count needs to be displayed.

System capability: SystemCapability.Notification.Notification

Parameters

Name Type Mandatory Description
callback AsyncCallback<number> Yes Callback used to return the result. If the operation is successful, err is undefined and data is the obtained number of active notifications; otherwise, err is an error object.

Error codes

For details about the error codes, see Universal Error Codes and Notification Error Codes.

ID Error Message
401 Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. 2. Incorrect parameter types. 3. Parameter verification failed.
1600001 Internal error.
1600002 Marshalling or unmarshalling error.
1600003 Failed to connect to the service.

Example

import { BusinessError } from '@kit.BasicServicesKit';

let getActiveNotificationCountCallback = (err: BusinessError, data: number): void => {
  if (err) {
    console.error(`Failed to get active notification count. Code is ${err.code}, message is ${err.message}`);
  } else {
    console.info(`Succeeded in getting active notification count, data is ${JSON.stringify(data)}`);
  }
}

notificationManager.getActiveNotificationCount(getActiveNotificationCountCallback);

notificationManager.getActiveNotificationCount

getActiveNotificationCount(): Promise<number>

Obtains the number of active notifications of this application. This API uses a promise to return the result.

This API is used to query the number of existing notifications published by the current application in the notification center. This API is suitable for scenarios where the unread notification count needs to be displayed.

System capability: SystemCapability.Notification.Notification

Return value

Type Description
Promise<number> Promise used to return the number of existing notifications of the current application in the notification center.

Error codes

For details about the error codes, see Notification Error Codes.

ID Error Message
1600001 Internal error.
1600002 Marshalling or unmarshalling error.
1600003 Failed to connect to the service.

Example

import { BusinessError } from '@kit.BasicServicesKit';

notificationManager.getActiveNotificationCount().then((data: number) => {
  console.info(`Succeeded in getting active notification count, data is ${JSON.stringify(data)}`);
}).catch((err: BusinessError) => {
  console.error(`Failed to get active notification count. Code is ${err.code}, message is ${err.message}`);
});

notificationManager.getActiveNotifications

getActiveNotifications(callback: AsyncCallback<Array<NotificationRequest>>): void

Obtains the active notifications of this application. This API uses an asynchronous callback to return the result.

This API is used to query the detailed information list of all existing notifications of the current application in the notification center, including the ID, label, content, and creation time of each notification.

System capability: SystemCapability.Notification.Notification

Parameters

Name Type Mandatory Description
callback AsyncCallback<Array<NotificationRequest>> Yes Callback used to return the result. If the operation is successful, err is undefined and data is the obtained NotificationRequest array; otherwise, err is an error object.

Error codes

For details about the error codes, see Universal Error Codes and Notification Error Codes.

ID Error Message
401 Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. 2. Incorrect parameter types. 3. Parameter verification failed.
1600001 Internal error.
1600002 Marshalling or unmarshalling error.
1600003 Failed to connect to the service.

Example

import { BusinessError } from '@kit.BasicServicesKit';

let getActiveNotificationsCallback = (err: BusinessError, data: Array<notificationManager.NotificationRequest>): void => {
  if (err) {
    console.error(`Failed to get active notifications. Code is ${err.code}, message is ${err.message}`);
  } else {
    console.info(`Succeeded in getting active notifications, data is ${JSON.stringify(data)}`);
  }
}
notificationManager.getActiveNotifications(getActiveNotificationsCallback);

notificationManager.getActiveNotifications

getActiveNotifications(): Promise<Array<NotificationRequest>>

Obtains the active notifications of this application. This API uses a promise to return the result.

This API is used to query the detailed information list of all existing notifications of the current application in the notification center, including the ID, label, content, and creation time of each notification.

System capability: SystemCapability.Notification.Notification

Return value

Type Description
Promise<Array<NotificationRequest>> Promise used to return the list of undeleted notifications of the current application, including detailed information of each notification.

Error codes

For details about the error codes, see Notification Error Codes.

ID Error Message
1600001 Internal error.
1600002 Marshalling or unmarshalling error.
1600003 Failed to connect to the service.

Example

import { BusinessError } from '@kit.BasicServicesKit';

notificationManager.getActiveNotifications().then((data: Array<notificationManager.NotificationRequest>) => {
  console.info(`Succeeded in getting active notifications, data is ${JSON.stringify(data)}`);
}).catch((err: BusinessError) => {
  console.error(`Failed to get active notifications. Code is ${err.code}, message is ${err.message}`);
});

notificationManager.getNotificationParameters24+

getNotificationParameters(id: number, label?: string): Promise<NotificationParameters>

Obtains some information about the wantAgent field in NotificationRequest. This API uses a promise to return the result.

Model restriction: This API can be used only in the stage model.

System capability: SystemCapability.Notification.Notification

Parameters

Name Type Mandatory Description
id number Yes Notification ID, used to identify the target notification. This value is specified by the id field in NotificationRequest when a notification is published.
label string No

Notification label. The default value is empty. This value is specified by the label field in NotificationRequest when a notification is published.

- If the label field is empty, some information about the published notification that matches the specified notification ID and has an empty label is obtained.

- If the label field is not empty, some information about the published notification that matches both the specified notification ID and label is obtained.

Return value

Type Description
Promise<NotificationParameters> Promise used to return some information about wantAgent.

Error codes

For details about the error codes, see Notification Error Codes.

ID Error Message
1600001 Internal error.
1600002 Marshalling or unmarshalling error.
1600003 Failed to connect to the service.
1600007 The notification does not exist.

Example

import { BusinessError } from '@kit.BasicServicesKit';

let id: number = 0;
let label: string = '';
notificationManager.getNotificationParameters(id, label).then((data: notificationManager.NotificationParameters) => {
  console.info(`Succeeded in getting notification parameters, data is ${JSON.stringify(data)}`);
}).catch((err: BusinessError) => {
  console.error(`Failed to get notification parameters. Code is ${err.code}, message is ${err.message}`);
});

notificationManager.cancelGroup

cancelGroup(groupName: string, callback: AsyncCallback<void>): void

Cancels notifications under a notification group of this application. This API uses an asynchronous callback to return the result.

The notification group groupName is the group identifier specified by the groupName field in NotificationRequest when publishing a notification. After cancellation, all notifications under this group are removed from the notification center. This is suitable for scenarios where notifications need to be canceled in batches by business group.

System capability: SystemCapability.Notification.Notification

Parameters

Name Type Mandatory Description
groupName string Yes

Name of the notification group, which is specified through NotificationRequest when the notification is published.

The size cannot exceed 202 bytes, and the excess part will be truncated.
callback AsyncCallback<void> Yes Callback used to return the result. If the operation is successful, err is undefined; otherwise, err is an error object.

Error codes

For details about the error codes, see Universal Error Codes and Notification Error Codes.

ID Error Message
401 Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. 2. Incorrect parameter types. 3. Parameter verification failed.
1600001 Internal error.
1600002 Marshalling or unmarshalling error.
1600003 Failed to connect to the service.

Example

import { BusinessError } from '@kit.BasicServicesKit';

let cancelGroupCallback = (err: BusinessError): void => {
  if (err) {
    console.error(`Failed to cancel group. Code is ${err.code}, message is ${err.message}`);
  } else {
    console.info(`Succeeded in canceling group.`);
  }
}
let groupName: string = 'GroupName';
notificationManager.cancelGroup(groupName, cancelGroupCallback);

notificationManager.cancelGroup

cancelGroup(groupName: string): Promise<void>

Cancels notifications under a notification group of this application. This API uses a promise to return the result.

The notification group groupName is the group identifier specified by the groupName field in NotificationRequest when publishing a notification. After cancellation, all notifications under this group are removed from the notification center. This is suitable for scenarios where notifications need to be canceled in batches by business group.

System capability: SystemCapability.Notification.Notification

Parameters

Name Type Mandatory Description
groupName string Yes

Name of the notification group, which is specified through NotificationRequest when the notification is published.

The size cannot exceed 202 bytes, and the excess part will be truncated.

Return value

Type Description
Promise<void> Promise that returns no value.

Error codes

For details about the error codes, see Universal Error Codes and Notification Error Codes.

ID Error Message
401 Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. 2. Incorrect parameter types. 3. Parameter verification failed.
1600001 Internal error.
1600002 Marshalling or unmarshalling error.
1600003 Failed to connect to the service.

Example

import { BusinessError } from '@kit.BasicServicesKit';

let groupName: string = 'GroupName';
notificationManager.cancelGroup(groupName).then(() => {
  console.info(`Succeeded in canceling group.`);
}).catch((err: BusinessError) => {
  console.error(`Failed to cancel group. Code is ${err.code}, message is ${err.message}`);
});

notificationManager.isSupportTemplate

isSupportTemplate(templateName: string, callback: AsyncCallback<boolean>): void

Checks whether a specified template is supported before using NotificationTemplate to publish a notification. This API uses an asynchronous callback to return the result.

System capability: SystemCapability.Notification.Notification

Parameters

Name Type Mandatory Description
templateName string Yes Template name. Currently, only downloadTemplate is supported.
callback AsyncCallback<boolean> Yes Callback used to return the result. The value true indicates that the template is supported, and false indicates the opposite. If this API call fails, an error object is returned.

Error codes

For details about the error codes, see Universal Error Codes and Notification Error Codes.

ID Error Message
401 Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. 2. Incorrect parameter types. 3. Parameter verification failed.
1600001 Internal error.
1600002 Marshalling or unmarshalling error.
1600003 Failed to connect to the service.

Example

import { BusinessError } from '@kit.BasicServicesKit';

let templateName: string = 'downloadTemplate';
let isSupportTemplateCallback = (err: BusinessError, data: boolean): void => {
  if (err) {
    console.error(`isSupportTemplate failed, code is ${err.code}, message is ${err.message}`);
  } else {
    console.info(`isSupportTemplate success, data: ${JSON.stringify(data)}`);
  }
}
notificationManager.isSupportTemplate(templateName, isSupportTemplateCallback);

notificationManager.isSupportTemplate

isSupportTemplate(templateName: string): Promise<boolean>

Checks whether a specified template is supported before using NotificationTemplate to publish a notification. This API uses a promise to return the result.

System capability: SystemCapability.Notification.Notification

Parameters

Name Type Mandatory Description
templateName string Yes Template name. Currently, only downloadTemplate is supported.

Return value

Type Description
Promise<boolean> Promise used to return the result. The value true means that the specified template is supported, and false means the opposite.

Error codes

For details about the error codes, see Universal Error Codes and Notification Error Codes.

ID Error Message
401 Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. 2. Incorrect parameter types. 3. Parameter verification failed.
1600001 Internal error.
1600002 Marshalling or unmarshalling error.
1600003 Failed to connect to the service.

Example

import { BusinessError } from '@kit.BasicServicesKit';

let templateName: string = 'downloadTemplate';
notificationManager.isSupportTemplate(templateName).then((data: boolean) => {
  console.info(`isSupportTemplate success, data: ${JSON.stringify(data)}`);
}).catch((err: BusinessError) => {
  console.error(`isSupportTemplate failed, code is ${err.code}, message is ${err.message}`);
});

notificationManager.requestEnableNotification10+

requestEnableNotification(context: UIAbilityContext, callback: AsyncCallback<void>): void

An application must obtain user authorization before it can send notifications. Calling this API before publishing a notification brings up the notification authorization dialog box, allowing the user to choose whether to allow notifications to be sent. This API uses an asynchronous callback to return the result.

  • This API can be called only after the application UI is loaded (that is, loadContent is successfully called).
  • When an application uses requestEnableNotification() to display a dialog box for notification authorization and the user rejects the authorization, the application cannot use this API to open the dialog box again. However, it can call openNotificationSettingsWithResult to open the notification management dialog box.

Model restriction: This API can be used only in the stage model.

System capability: SystemCapability.Notification.Notification

Parameters

Name Type Mandatory Description
context UIAbilityContext Yes Ability context bound to the notification dialog box.
callback AsyncCallback<void> Yes Callback used to return the result. If the operation is successful, err is undefined; otherwise, err is an error object.

Error codes

For details about the error codes, see Universal Error Codes and Notification Error Codes.

ID Error Message
401 Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. 2. Incorrect parameter types. 3. Parameter verification failed.
1600001 Internal error.
1600002 Marshalling or unmarshalling error.
1600003 Failed to connect to the service.
1600004

Notification disabled.

Applicable versions: 11+
1600013

A notification dialog box is already displayed.

Applicable versions: 11+

Example

import { BusinessError } from '@kit.BasicServicesKit';
import { UIAbility } from '@kit.AbilityKit';
import { window } from '@kit.ArkUI';
import { hilog } from '@kit.PerformanceAnalysisKit';

class MyAbility extends UIAbility {
  onWindowStageCreate(windowStage: window.WindowStage) {
    hilog.info(0x0000, 'testTag', '%{public}s', 'Ability onWindowStageCreate');
    windowStage.loadContent('pages/Index', (err, data) => {
      if (err.code) {
        hilog.error(0x0000, 'testTag', `Failed to load the content. Cause: ${JSON.stringify(err) ?? ''}`);
        return;
      }
      hilog.info(0x0000, 'testTag', `Succeeded in loading the content. Data: ${JSON.stringify(data) ?? ''}`);
      let requestEnableNotificationCallback = (err: BusinessError): void => {
        if (err) {
          hilog.error(0x0000, 'testTag', `[ANS] requestEnableNotification failed, code is ${err.code}, message is ${err.message}`);
        } else {
          hilog.info(0x0000, 'testTag', `[ANS] requestEnableNotification success`);
        }
      };
      notificationManager.requestEnableNotification(this.context, requestEnableNotificationCallback);
    });
  }
}

notificationManager.requestEnableNotification10+

requestEnableNotification(context: UIAbilityContext): Promise<void>

An application must obtain user authorization before it can send notifications. Calling this API before publishing a notification brings up the notification authorization dialog box, allowing the user to choose whether to allow notifications to be sent. This API uses a promise to return the result.

  • This API can be called only after the application UI is loaded (that is, loadContent is successfully called).
  • When an application uses requestEnableNotification() to display a dialog box for notification authorization and the user rejects the authorization, the application cannot use this API to open the dialog box again. However, it can call openNotificationSettingsWithResult to open the notification management dialog box.

Model restriction: This API can be used only in the stage model.

System capability: SystemCapability.Notification.Notification

Parameters

Name Type Mandatory Description
context UIAbilityContext Yes Ability context bound to the notification dialog box.

Return value

Type Description
Promise<void> Promise that returns no value.

Error codes

For details about the error codes, see Universal Error Codes and Notification Error Codes.

ID Error Message
401 Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. 2. Incorrect parameter types. 3. Parameter verification failed.
1600001 Internal error.
1600002 Marshalling or unmarshalling error.
1600003 Failed to connect to the service.
1600004

Notification disabled.

Applicable versions: 11+
1600013

A notification dialog box is already displayed.

Applicable versions: 11+

Example

import { BusinessError } from '@kit.BasicServicesKit';
import { UIAbility } from '@kit.AbilityKit';
import { window } from '@kit.ArkUI';
import { hilog } from '@kit.PerformanceAnalysisKit';

class MyAbility extends UIAbility {
  onWindowStageCreate(windowStage: window.WindowStage) {
    hilog.info(0x0000, 'testTag', '%{public}s', 'Ability onWindowStageCreate');
    windowStage.loadContent('pages/Index', (err, data) => {
      if (err.code) {
        hilog.error(0x0000, 'testTag', `Failed to load the content. Cause: ${JSON.stringify(err) ?? ''}`);
        return;
      }
      hilog.info(0x0000, 'testTag', `Succeeded in loading the content. Data: ${JSON.stringify(data) ?? ''}`);
      notificationManager.requestEnableNotification(this.context).then(() => {
        hilog.info(0x0000, 'testTag', `[ANS] requestEnableNotification success`);
      }).catch((err: BusinessError) => {
        hilog.error(0x0000, 'testTag', `[ANS] requestEnableNotification failed, code is ${err.code}, message is ${err.message}`);
      });
    });
  }
}

notificationManager.requestEnableNotification(deprecated)

requestEnableNotification(callback: AsyncCallback<void>): void

Requests notification authorization for this application. This API uses an asynchronous callback to return the result.

This API is supported since API version 9 and deprecated since API version 12. You are advised to use requestEnableNotification with context instead.

System capability: SystemCapability.Notification.Notification

Parameters

Name Type Mandatory Description
callback AsyncCallback<void> Yes Callback function. If the application successfully requests notification authorization, err is undefined; otherwise, err is an error object.

Error codes

For details about the error codes, see Universal Error Codes and Notification Error Codes.

ID Error Message
401 Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. 2. Incorrect parameter types. 3. Parameter verification failed.
1600001 Internal error.
1600002 Marshalling or unmarshalling error.
1600003 Failed to connect to the service.
1600004

Notification disabled.

Applicable versions: 11+
1600013

A notification dialog box is already displayed.

Applicable versions: 11+

Example

import { BusinessError } from '@kit.BasicServicesKit';

let requestEnableNotificationCallback = (err: BusinessError): void => {
  if (err) {
    console.error(`requestEnableNotification failed, code is ${err.code}, message is ${err.message}`);
  } else {
    console.info(`requestEnableNotification success`);
  }
};
notificationManager.requestEnableNotification(requestEnableNotificationCallback);

notificationManager.requestEnableNotification(deprecated)

requestEnableNotification(): Promise<void>

Requests notification authorization for this application. This API uses a promise to return the result.

This API is supported since API version 9 and deprecated since API version 12. You are advised to use requestEnableNotification with context instead.

System capability: SystemCapability.Notification.Notification

Return value

Type Description
Promise<void> Promise that returns no value.

Error codes

For details about the error codes, see Notification Error Codes.

ID Error Message
1600001 Internal error.
1600002 Marshalling or unmarshalling error.
1600003 Failed to connect to the service.
1600004

Notification disabled.

Applicable versions: 11+
1600013

A notification dialog box is already displayed.

Applicable versions: 11+

Example

import { BusinessError } from '@kit.BasicServicesKit';

notificationManager.requestEnableNotification().then(() => {
  console.info(`requestEnableNotification success`);
}).catch((err: BusinessError) => {
  console.error(`requestEnableNotification failed, code is ${err.code}, message is ${err.message}`);
});

notificationManager.isDistributedEnabled(deprecated)

isDistributedEnabled(callback: AsyncCallback<boolean>): void

Checks whether the device supports cross-device collaboration notifications. This API uses an asynchronous callback to return the result.

This API is supported since API version 9 and deprecated since API version 26.0.0.

System capability: SystemCapability.Notification.Notification

Parameters

Name Type Mandatory Description
callback AsyncCallback<boolean> Yes Callback used to return the result. The value true means that the cross-device notification is supported; false means the opposite. If this API call fails, an error object is returned.

Error codes

For details about the error codes, see Universal Error Codes and Notification Error Codes.

ID Error Message
401 Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. 2. Incorrect parameter types. 3. Parameter verification failed.
801

Capability not supported.

Applicable versions: 26.0.0+
1600001 Internal error.
1600002 Marshalling or unmarshalling error.
1600003 Failed to connect to the service.
1600010 Distributed operation failed.

Example

import { BusinessError } from '@kit.BasicServicesKit';

let isDistributedEnabledCallback = (err: BusinessError, data: boolean): void => {
  if (err) {
    console.error(`isDistributedEnabled failed, code is ${err.code}, message is ${err.message}`);
  } else {
    console.info(`isDistributedEnabled success ${JSON.stringify(data)}`);
  }
};
notificationManager.isDistributedEnabled(isDistributedEnabledCallback);

notificationManager.isDistributedEnabled(deprecated)

isDistributedEnabled(): Promise<boolean>

Checks whether the device supports cross-device collaboration notifications. This API uses a promise to return the result.

This API is supported since API version 9 and deprecated since API version 26.0.0.

System capability: SystemCapability.Notification.Notification

Return value

Type Description
Promise<boolean> Promise used to return the result. The value true means that the cross-device notification is supported; false means the opposite.

Error codes

For details about the error codes, see Notification Error Codes.

ID Error Message
801

Capability not supported.

Applicable versions: 26.0.0+
1600001 Internal error.
1600002 Marshalling or unmarshalling error.
1600003 Failed to connect to the service.
1600010 Distributed operation failed.

Example

import { BusinessError } from '@kit.BasicServicesKit';

notificationManager.isDistributedEnabled().then((data: boolean) => {
  console.info(`isDistributedEnabled success, data: ${JSON.stringify(data)}`);
}).catch((err: BusinessError) => {
  console.error(`isDistributedEnabled failed, code is ${err.code}, message is ${err.message}`);
});

notificationManager.openNotificationSettings13+

openNotificationSettings(context: UIAbilityContext): Promise<void>

Brings up the notification setting page of the application. The page is presented in semi-modal form and can be used to set the notification switch, notification reminder mode, and so on. This API uses a promise to return the result.

This is suitable for scenarios where users need to manually modify notification settings, such as a secondary request after a user denies authorization, or when the notification reminder mode (vibration, ringtone, etc.) needs to be modified. When the requestEnableNotification dialog box is denied by the user, you can call this API to guide the user to the notification settings page to manually enable notifications.

Model restriction: This API can be used only in the stage model.

System capability: SystemCapability.Notification.NotificationSettings

Parameters

Name Type Mandatory Description
context UIAbilityContext Yes Ability context bound to the notification settings page.

Return value

Type Description
Promise<void> Promise that returns no value.

Error codes

For details about the error codes, see Universal Error Codes and Notification Error Codes.

ID Error Message
801

Capability not supported.

Applicable versions: 18+
1600001 Internal error.
1600003 Failed to connect to the service.
1600018 The notification settings window is already displayed.

Example

import { BusinessError } from '@kit.BasicServicesKit';
import { UIAbility } from '@kit.AbilityKit';
import { window } from '@kit.ArkUI';
import { hilog } from '@kit.PerformanceAnalysisKit';

class MyAbility extends UIAbility {
  onWindowStageCreate(windowStage: window.WindowStage) {
    hilog.info(0x0000, 'testTag', '%{public}s', 'Ability onWindowStageCreate');
    windowStage.loadContent('pages/Index', (err, data) => {
      if (err.code) {
        hilog.error(0x0000, 'testTag', `Failed to load the content. Cause: ${JSON.stringify(err) ?? ''}`);
        return;
      }
      hilog.info(0x0000, 'testTag', `Succeeded in loading the content. Data: ${JSON.stringify(data) ?? ''}`);
      notificationManager.openNotificationSettings(this.context).then(() => {
        hilog.info(0x0000, 'testTag', `[ANS] openNotificationSettings success`);
      }).catch((err: BusinessError) => {
        hilog.error(0x0000, 'testTag', `[ANS] openNotificationSettings failed, code is ${err.code}, message is ${err.message}`);
      });
    });
  }
}

notificationManager.openNotificationSettingsWithResult

openNotificationSettingsWithResult(context: UIAbilityContext): Promise<NotificationSetting>

Brings up the notification setting page of the application. The page is presented in semi-modal form and can be used to set the notification switch, notification reminder mode, and so on. This API uses a promise to return the result, and returns the status set by the user when the semi-modal window is closed.

Unlike openNotificationSettings, this API returns a NotificationSetting object when the semi-modal window is closed. You can determine whether the user has enabled the notification permission based on the returned result, thereby deciding subsequent logic.

Since: 26.0.0

Model restriction: This API can be used only in the stage model.

System capability: SystemCapability.Notification.NotificationSettings

Parameters

Name Type Mandatory Description
context UIAbilityContext Yes Ability context bound to the notification settings page.

Return value

Type Description
Promise<NotificationSetting> Promise used to return the notification settings of this application.

Error codes

For details about the error codes, see Universal Error Codes and Notification Error Codes.

ID Error Message
801 Capability not supported.
1600001 Internal error.
1600003 Failed to connect to the service.
1600018 The notification settings window is already displayed.

Example

import { BusinessError } from '@kit.BasicServicesKit';
import { UIAbility } from '@kit.AbilityKit';
import { window } from '@kit.ArkUI';
import { hilog } from '@kit.PerformanceAnalysisKit';

class MyAbility extends UIAbility {
  onWindowStageCreate(windowStage: window.WindowStage) {
    hilog.info(0x0000, 'testTag', '%{public}s', 'Ability onWindowStageCreate');
    windowStage.loadContent('pages/Index', (err, data) => {
      if (err.code) {
        hilog.error(0x0000, 'testTag', `Failed to load the content. Cause: ${JSON.stringify(err) ?? ''}`);
        return;
      }
      hilog.info(0x0000, 'testTag', `Succeeded in loading the content. Data: ${JSON.stringify(data) ?? ''}`);
      notificationManager.openNotificationSettingsWithResult(this.context).then((data) => {
        hilog.info(0x0000, 'testTag', `[ANS] openNotificationSettingsWithResult success, data: ${JSON.stringify(data)}`);
      }).catch((err: BusinessError) => {
        hilog.error(0x0000, 'testTag', `[ANS] openNotificationSettingsWithResult failed, code is ${err.code}, message is ${err.message}`);
      });
    });
  }
}

notificationManager.getNotificationSetting20+

getNotificationSetting(): Promise<NotificationSetting>

Obtains the notification setting of the application, including the switch states of lock screen notifications, banner notifications, home screen badges, vibration, ringtone, and so on. This API uses a promise to return the result.

System capability: SystemCapability.Notification.Notification

Return value

Type Description
Promise<NotificationSetting> Promise used to return the notification settings of this application.

Error codes

For details about the error codes, see Notification Error Codes.

ID Error Message
1600001 Internal error.
1600002 Marshalling or unmarshalling error.
1600003 Failed to connect to the service.

Example

import { BusinessError } from '@kit.BasicServicesKit';

notificationManager.getNotificationSetting().then((data: notificationManager.NotificationSetting) => {
    console.info(`getNotificationSetting success, data: ${JSON.stringify(data)}`);
}).catch((err: BusinessError) => {
    console.error(`getNotificationSetting failed, code is ${err.code}, message is ${err.message}`);
});

notificationManager.isGeofenceEnabled23+

isGeofenceEnabled(): Promise<boolean>

Checks whether the geofence feature is enabled. This API uses a promise to return the result.

System capability: SystemCapability.Notification.Notification

Return value

Type Description
Promise<boolean> Promise used to return the result. The value true indicates that geofencing is enabled, and the value false indicates the opposite.

Error codes:

For details about the error codes, see Notification Error Codes.

ID Error Message
1600001 Internal error.
1600002 Marshalling or unmarshalling error.
1600003 Failed to connect to the service.
1600012 No memory space.

Example

import { hilog } from '@kit.PerformanceAnalysisKit';
import { BusinessError } from '@kit.BasicServicesKit';

notificationManager.isGeofenceEnabled().then((data: boolean) => {
  hilog.info(0x0000, 'testTag', '%{public}s', `isGeofenceEnabled success, enabled:  ${JSON.stringify(data)}.`);
}).catch((err: BusinessError) => {
  hilog.error(0x0000, 'testTag', '%{public}s',`isGeofenceEnabled failed, code is ${err.code}, message is ${err.message}`);
});

ContentType

Enumerates the notification content types.

Atomic service API: This API can be used in atomic services since API version 12.

System capability: SystemCapability.Notification.Notification

Name Value Description
NOTIFICATION_CONTENT_BASIC_TEXT 0 Normal text notification.
NOTIFICATION_CONTENT_LONG_TEXT 1 Long text notification.
NOTIFICATION_CONTENT_PICTURE 2 Picture-attached notification.
NOTIFICATION_CONTENT_CONVERSATION 3 Conversation notification.
NOTIFICATION_CONTENT_MULTILINE 4 Multi-line text notification.
NOTIFICATION_CONTENT_SYSTEM_LIVE_VIEW11+ 5 System live view type notification. Third-party applications cannot directly create this type of notification. After the system agent creates a system live view type notification, a third-party application can publish a notification with the same ID to update the specified content.
NOTIFICATION_CONTENT_LIVE_VIEW11+ 6 Common live view notification. Available only to system applications.

SlotLevel

Enumerates the notification level.

This API is used to define the notification reminder behavior level of NotificationSlot, affecting how the notification is displayed in the status bar, whether to show banners and alert sounds, etc.

System capability: SystemCapability.Notification.Notification

Name Value Description
LEVEL_NONE 0 Notification is disabled.
LEVEL_MIN 1 Notification is enabled, but the notification icon is not displayed in the status bar, with no alert tone and banner.
LEVEL_LOW 2 Notification is enabled, and the notification icon is displayed in the status bar, with no alert tone and banner.
LEVEL_DEFAULT 3 Notification is enabled, and the notification icon is displayed in the status bar, with an alert tone but no banner.
LEVEL_HIGH 4 Notification is enabled, and the notification icon is displayed in the status bar, with an alert tone and banner.

SlotType

Enumerates the notification slot types.

Different types correspond to different SlotLevel values, determining the reminder behavior of the notification.

Atomic service API: This API can be used in atomic services since API version 12.

System capability: SystemCapability.Notification.Notification

Name Value Description
UNKNOWN_TYPE 0 Unknown type. This type corresponds to SlotLevel being LEVEL_MIN.
SOCIAL_COMMUNICATION 1 Social communication. This type corresponds to the SlotLevel of LEVEL_HIGH.
SERVICE_INFORMATION 2 Notification slot for service information. This type corresponds to SlotLevel being LEVEL_HIGH.
CONTENT_INFORMATION 3 Notification slot for content consultation. This type corresponds to SlotLevel being LEVEL_MIN.
LIVE_VIEW11+ 4 Live view. A third-party application cannot directly create a notification of this type. Instead, after the system proxy creates a notification, the third-party application can release the notification with the same ID to update the specified content. This type corresponds to SlotLevel being LEVEL_DEFAULT.
CUSTOMER_SERVICE11+ 5 Notification slot for customer service message. This type is used for messages between users and customer service providers. The messages must be initiated by users. This type corresponds to SlotLevel being LEVEL_DEFAULT.
OTHER_TYPES 0xFFFF Notification slot for other purposes. This type corresponds to SlotLevel being LEVEL_MIN.

NotificationSetting20+

Defines the setting status of the notification reminder mode switch.

System capability: SystemCapability.Notification.Notification

Name Type Read-Only Optional Description
vibrationEnabled boolean No No

Whether to enable vibration.

- true: enabled.

- false: disable.
soundEnabled boolean No No

Whether to enable the sound.

- true: enable.

- false: disable.
lockScreenEnabled boolean No Yes

Whether to enable lock screen notification.

Model restriction: This API can be used only in the stage model.

Since: 26.0.0

- true: enable.

- false: disable.
bannerEnabled boolean No Yes

Whether to enable banner notification.

Model restriction: This API can be used only in the stage model.

Since: 26.0.0

- true: enable.

- false: disable.
badgeNumberEnabled boolean No Yes

Whether to enable the numeric display of the notification badge.

Model restriction: This API can be used only in the stage model.

Since: 26.0.0

- true: enable.

- false: disable.
notificationEnabled boolean No Yes

Whether to enable the application notification.

Model restriction: This API can be used only in the stage model.

Since: 26.0.0

- true: enable.

- false: disable.

PriorityNotificationType23+

Describes the priority type of a notification.

System capability: SystemCapability.Notification.Notification

Name Value Description
OTHER 'OTHER' The notification priority type is default.
PRIMARY_CONTACT 'PRIMARY_CONTACT' The notification priority type is primary contact.
AT_ME 'AT_ME' The notification priority type is @me.
URGENT_MESSAGE 'URGENT_MESSAGE' The notification priority type is urgent message.
SCHEDULE_REMINDER 'SCHEDULE_REMINDER' The notification priority type is schedule reminder.

BundleOption

type BundleOption = _BundleOption

Describes the bundle information of an application.

System capability: SystemCapability.Notification.Notification

Type Description
_BundleOption Bundle information.

NotificationActionButton

type NotificationActionButton = _NotificationActionButton

Describes the operation button displayed in the notification.

System capability: SystemCapability.Notification.Notification

Type Description
_NotificationActionButton Operation button.

NotificationBasicContent

type NotificationBasicContent = _NotificationBasicContent

Describes the normal text notification.

System capability: SystemCapability.Notification.Notification

Type Description
_NotificationBasicContent Normal text notification.

NotificationContent

type NotificationContent = _NotificationContent

Notification content.

System capability: SystemCapability.Notification.Notification

Type Description
_NotificationContent Notification content.

NotificationLongTextContent

type NotificationLongTextContent = _NotificationLongTextContent

Describes the long text notification.

System capability: SystemCapability.Notification.Notification

Type Description
_NotificationLongTextContent Long text notification.

NotificationMultiLineContent

type NotificationMultiLineContent = _NotificationMultiLineContent

Describes the multi-line text notification.

System capability: SystemCapability.Notification.Notification

Type Description
_NotificationMultiLineContent Multi-line text notification.

NotificationPictureContent

type NotificationPictureContent = _NotificationPictureContent

Describes the picture-attached notification.

System capability: SystemCapability.Notification.Notification

Type Description
_NotificationPictureContent Picture-attached notification

NotificationSystemLiveViewContent11+

type NotificationSystemLiveViewContent = _NotificationSystemLiveViewContent

Defines the system live view notification content.

System capability: SystemCapability.Notification.Notification

Type Description
_NotificationSystemLiveViewContent System live view notification.

NotificationRequest

type NotificationRequest = _NotificationRequest

Defines the notification request.

System capability: SystemCapability.Notification.Notification

Type Description
_NotificationRequest Notification request.

NotificationParameters24+

type NotificationParameters = _NotificationParameters

Describes part of the information about the wantAgent in the notification request.

Model restriction: This API can be used only in the stage model.

System capability: SystemCapability.Notification.Notification

Type Description
_NotificationParameters Partial information about the wantAgent in the notification request.

DistributedOptions

type DistributedOptions = _DistributedOptions

Describes distributed notification options.

System capability: SystemCapability.Notification.Notification

Type Description
_DistributedOptions Distributed notification options.

NotificationSlot

type NotificationSlot = _NotificationSlot

Defines the notification slot.

System capability: SystemCapability.Notification.Notification

Type Description
_NotificationSlot Notification slot.

NotificationTemplate

type NotificationTemplate = _NotificationTemplate

Describes the notification template.

System capability: SystemCapability.Notification.Notification

Type Description
_NotificationTemplate Notification template.

NotificationUserInput

type NotificationUserInput = _NotificationUserInput

Describes the user input for the notification.

System capability: SystemCapability.Notification.Notification

Type Description
_NotificationUserInput User input.

NotificationCapsule11+

type NotificationCapsule = _NotificationCapsule

Defines the notification capsule.

System capability: SystemCapability.Notification.Notification

Type Description
_NotificationCapsule Notification capsule.

NotificationButton11+

type NotificationButton = _NotificationButton

Defines the notification button.

System capability: SystemCapability.Notification.Notification

Type Description
_NotificationButton Notification button.

NotificationTime11+

type NotificationTime = _NotificationTime

Describes the notification timing information.

System capability: SystemCapability.Notification.Notification

Type Description
_NotificationTime Notification timing information.

NotificationProgress11+

type NotificationProgress = _NotificationProgress

Defines the notification progress.

System capability: SystemCapability.Notification.Notification

Type Description
_NotificationProgress Notification progress.