NotificationHelper

java.lang.Object
- ohos.event.notification.NotificationHelper

```
public class NotificationHelper
extends Object
```
Manages notifications.
The methods provided by this class are all static and can be called without creating an object of this class.
Generally, only system applications have permissions on notification subscription and unsubscription. You can specify the content of a notification to be published and the content is carried by NotificationRequest. A notification ID is unique in an application and must be specified when using NotificationRequest to carry the notification content. If a notification with this ID has been published and you need to use this ID to publish another notification, the original notification will be updated. In addition, the notification ID can be used to cancel a notification by calling the cancelNotification(int) method.

从以下版本开始:

1

另请参阅:

NotificationRequest

SystemCapability

SystemCapability.Notification#ANS

方法概要

所有方法静态方法具体方法
限定符和类型	方法	说明
`static void`	`addNotificationSlot(NotificationSlot slot)`	Creates a notification slot.
`static void`	`addNotificationSlotGroup(NotificationSlotGroup slotGroup)`	Creates a notification slot group to which a `NotificationSlot` object can be bound by calling `NotificationSlot#setSlotGroup(String)`.
`static void`	`addNotificationSlotGroups(List<NotificationSlotGroup> slotGroups)`	Creates multiple notification slot groups.
`static void`	`addNotificationSlots(List<NotificationSlot> slots)`	Creates multiple notification slots.
`static boolean`	`areNotificationsSuspended()`	Checks whether this application is in the suspended state.
`static void`	`cancelAllNotifications()`	Cancels all the published notifications.
`static void`	`cancelNotification(int notificationId)`	Cancels a published notification.
`static void`	`cancelNotification(String label, int notificationId)`	Cancels a published notification matching the specified `label` and `notificationId`.
`static boolean`	`canPublishNotificationAsBundle(String representativeBundle)`	Checks whether your application has permission to publish notifications by calling `publishNotificationAsBundle(java.lang.String,ohos.event.notification.NotificationRequest)` in the name of another application indicated by the given `representativeBundle`.
`static int`	`getActiveNotificationNums()`	Obtains the number of active notifications of the current application in the system.
`static Set<NotificationRequest>`	`getActiveNotifications()`	Obtains active notifications of the current application in the system.
`static int`	`getBundleImportance()`	Obtains the importance level of this application.
`static NotificationSortingMap`	`getCurrentAppSorting()`	Obtains the map for sorting notifications of the current application.
`static String`	`getNotificationAgent()`	Obtains the name of the application bundle that can publish notifications in the name of your application.
`static NotificationSlot`	`getNotificationSlot(String slotId)`	Queries a created notification slot.
`static NotificationSlotGroup`	`getNotificationSlotGroup(String slotGroupId)`	Obtains a created notification slot group.
`static List<NotificationSlotGroup>`	`getNotificationSlotGroups()`	Obtains a list of created notification slot groups.
`static List<NotificationSlot>`	`getNotificationSlots()`	Obtains all notification slots of this application.
`static boolean`	`hasNotificationPolicyAccessPermission()`	Checks whether this application has permission to modify the Do Not Disturb (DND) notification policy.
`static boolean`	`isAllowedNotify()`	Checks whether this application has permission to publish notifications.
`static void`	`publishNotification(String label, NotificationRequest request)`	Publishes a notification with a specified label.
`static void`	`publishNotification(NotificationRequest request)`	Publishes a notification.
`static void`	`publishNotification(NotificationRequest request, String deviceId)`	Publishes a notification on a specified remote device.
`static void`	`publishNotificationAsBundle(String representativeBundle, NotificationRequest request)`	Publishes a notification in the name of a specified application bundle.
`static void`	`removeNotificationSlot(String slotId)`	Deletes a created notification slot based on the slot ID.
`static void`	`removeNotificationSlotGroup(String slotGroupId)`	Deletes a created notification slot group based on the slot group ID.
`static void`	`setNotificationAgent(String agent)`	Allows another application to act as an agent to publish notifications in the name of your application bundle.
`static void`	`setNotificationBadgeNum()`	Sets the number of active notifications of the current application as the number to be displayed on the notification badge.
`static void`	`setNotificationBadgeNum(int num)`	Sets the number to be displayed on the notification badge of the application.

从类继承的方法 java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- 方法详细资料
  - publishNotification
```
public static void publishNotification(NotificationRequest request)
                                throws RemoteException
```
    Publishes a notification.
    If a notification with the same ID has been published by the current application and has not been deleted, this method will update the notification.
    
    参数:
    
    request - Indicates the NotificationRequest object for setting the notification content. This parameter must be specified.
    
    抛出:
    
    RemoteException - Throws this exception if an IPC exception occurs.
    
    IllegalArgumentException - Throws this exception if request is null.
    
    从以下版本开始:
    
    1
  - publishNotification
```
public static void publishNotification(String label,
                                       NotificationRequest request)
                                throws RemoteException
```
    Publishes a notification with a specified label.
    If a notification with the same ID has been published by the current application and has not been deleted, this method will update the notification.
    
    参数:
    
    label - Indicates the label of the notification to publish.
    
    request - Indicates the NotificationRequest object for setting the notification content. This parameter must be specified.
    
    抛出:
    
    RemoteException - Throws this exception if an IPC exception occurs.
    
    IllegalArgumentException - Throws this exception if request is null.
    
    从以下版本开始:
    
    1
  - publishNotification
```
public static void publishNotification(NotificationRequest request,
                                       String deviceId)
                                throws RemoteException
```
    Publishes a notification on a specified remote device.
    If a notification with the same ID has been published by the current application and has not been deleted, this method will update the notification.
    
    参数:
    
    request - Indicates the NotificationRequest object for setting the notification content. This parameter must be specified.
    
    deviceId - Indicates the ID of the remote device. If this parameter is null or an empty string, the notification will be published on the local device.
    
    抛出:
    
    RemoteException - Throws this exception if an IPC exception occurs.
    
    IllegalArgumentException - Throws this exception if request is null.
    
    从以下版本开始:
    
    3
  - cancelNotification
```
public static void cancelNotification(int notificationId)
                               throws RemoteException
```
    Cancels a published notification.
    
    参数:
    
    notificationId - Indicates the unique notification ID in the application. The value must be the ID of a published notification. Otherwise, this method does not take effect.
    
    抛出:
    
    RemoteException - Throws this exception if an IPC exception occurs.
    
    从以下版本开始:
    
    1
  - cancelAllNotifications
```
public static void cancelAllNotifications()
                                   throws RemoteException
```
    Cancels all the published notifications. To cancel a specified notification, see cancelNotification(int).
    
    抛出:
    
    RemoteException - Throws this exception if an IPC exception occurs.
    
    从以下版本开始:
    
    1
  - addNotificationSlot
```
public static void addNotificationSlot(NotificationSlot slot)
                                throws RemoteException
```
    Creates a notification slot. You can call the NotificationRequest#setSlotId(String) method to bind the slot for publishing.
    A NotificationSlot instance cannot be used directly after being initialized. Instead, you have to call this method to create a notification slot and bind the slot ID to a NotificationRequest object so that the notification published can have all the characteristics set in the NotificationSlot.
    After a notification slot is created by using this method, only the name and description of the notification slot can be changed. Changes to the other attributes, such as the vibration status and notification tone, will no longer take effect.
    
    参数:
    
    slot - Indicates the notification slot to be created, which is set by NotificationSlot. This parameter must be specified.
    
    抛出:
    
    RemoteException - Throws this exception if an IPC exception occurs.
    
    IllegalArgumentException - Throws this exception if slot is null.
    
    从以下版本开始:
    
    1
  - removeNotificationSlot
```
public static void removeNotificationSlot(String slotId)
                                   throws RemoteException
```
    Deletes a created notification slot based on the slot ID.
    
    参数:
    
    slotId - Indicates the ID of the slot, which is created by addNotificationSlot(ohos.event.notification.NotificationSlot). This parameter must be specified.
    
    抛出:
    
    RemoteException - Throws this exception if slotId is null or an empty string, or if an IPC exception occurs.
    
    从以下版本开始:
    
    1
  - getNotificationSlot
```
public static NotificationSlot getNotificationSlot(String slotId)
                                            throws RemoteException
```
    Queries a created notification slot.
    
    参数:
    
    slotId - Indicates the ID of the slot, which is created by addNotificationSlot(ohos.event.notification.NotificationSlot). This parameter must be specified.
    
    返回:
    
    Returns the created NotificationSlot.
    
    抛出:
    
    RemoteException - Throws this exception if slotId is null or an empty string, or if an IPC exception occurs.
    
    从以下版本开始:
    
    1
  - getActiveNotifications
```
public static Set<NotificationRequest> getActiveNotifications()
                                                       throws RemoteException
```
    Obtains active notifications of the current application in the system.
    
    返回:
    
    Returns active NotificationRequest objects of the current application.
    
    抛出:
    
    RemoteException - Throws this exception if an IPC exception occurs.
    
    从以下版本开始:
    
    1
  - getActiveNotificationNums
```
public static int getActiveNotificationNums()
                                     throws RemoteException
```
    Obtains the number of active notifications of the current application in the system.
    
    返回:
    
    Returns the number of active notifications of the current application.
    
    抛出:
    
    RemoteException - Throws this exception if an IPC exception occurs.
    
    从以下版本开始:
    
    1
  - setNotificationBadgeNum
```
public static void setNotificationBadgeNum(int num)
                                    throws RemoteException
```
    Sets the number to be displayed on the notification badge of the application.
    
    参数:
    
    num - Indicates the number to display. A negative number indicates that the badge setting remains unchanged. The value 0 indicates that no badge is displayed on the application icon. If the value is greater than 99, 99+ will be displayed.
    
    抛出:
    
    RemoteException - Throws this exception if an IPC exception occurs.
    
    从以下版本开始:
    
    3
  - setNotificationBadgeNum
```
public static void setNotificationBadgeNum()
                                    throws RemoteException
```
    Sets the number of active notifications of the current application as the number to be displayed on the notification badge.
    
    抛出:
    
    RemoteException - Throws this exception if an IPC exception occurs.
    
    从以下版本开始:
    
    1
  - getCurrentAppSorting
```
public static NotificationSortingMap getCurrentAppSorting()
                                                   throws RemoteException
```
    Obtains the map for sorting notifications of the current application.
    
    返回:
    
    Returns the NotificationSortingMap object for the current application.
    
    抛出:
    
    RemoteException - Throws this exception if an IPC exception occurs.
    
    从以下版本开始:
    
    2
  - addNotificationSlotGroup
```
public static void addNotificationSlotGroup(NotificationSlotGroup slotGroup)
                                     throws RemoteException
```
    Creates a notification slot group to which a NotificationSlot object can be bound by calling NotificationSlot#setSlotGroup(String).
    A NotificationSlotGroup instance cannot be used directly after being initialized. Instead, you have to call this method to create a notification slot group so that you can bind NotificationSlot objects to it.
    
    参数:
    
    slotGroup - Indicates the notification slot group to be created, which is set by NotificationSlotGroup. This parameter must be specified.
    
    抛出:
    
    RemoteException - Throws this exception if an IPC exception occurs.
    
    IllegalArgumentException - Throws this exception if slotGroup is null.
    
    从以下版本开始:
    
    3
  - addNotificationSlotGroups
```
public static void addNotificationSlotGroups(List<NotificationSlotGroup> slotGroups)
                                      throws RemoteException
```
    Creates multiple notification slot groups.
    The precautions for using this method are similar to those for addNotificationSlotGroup(ohos.event.notification.NotificationSlotGroup).
    
    参数:
    
    slotGroups - Indicates a list of NotificationSlotGroup objects to create. This parameter cannot be null.
    
    抛出:
    
    RemoteException - Throws this exception if an IPC exception occurs.
    
    IllegalArgumentException - Throws this exception if slotGroups is null.
    
    从以下版本开始:
    
    3
  - removeNotificationSlotGroup
```
public static void removeNotificationSlotGroup(String slotGroupId)
                                        throws RemoteException
```
    Deletes a created notification slot group based on the slot group ID.
    
    参数:
    
    slotGroupId - Indicates the ID of the notification slot group, which is created by addNotificationSlotGroup(ohos.event.notification.NotificationSlotGroup). This parameter must be specified.
    
    抛出:
    
    RemoteException - Throws this exception if slotGroupId is null or an empty string, or if an IPC exception occurs.
    
    从以下版本开始:
    
    3
  - getNotificationSlotGroup
```
public static NotificationSlotGroup getNotificationSlotGroup(String slotGroupId)
                                                      throws RemoteException
```
    Obtains a created notification slot group.
    
    参数:
    
    slotGroupId - Indicates the ID of the notification slot group, which is created by addNotificationSlotGroup(ohos.event.notification.NotificationSlotGroup). This parameter must be specified.
    
    返回:
    
    Returns the created NotificationSlotGroup.
    
    抛出:
    
    RemoteException - Throws this exception if slotGroupId is null or an empty string, or if an IPC exception occurs.
    
    从以下版本开始:
    
    3
  - hasNotificationPolicyAccessPermission
```
public static boolean hasNotificationPolicyAccessPermission()
                                                     throws RemoteException
```
    Checks whether this application has permission to modify the Do Not Disturb (DND) notification policy.
    
    返回:
    
    Returns true if this application has the permission; returns false otherwise.
    
    抛出:
    
    RemoteException - Throws this exception if an IPC exception occurs.
    
    从以下版本开始:
    
    3
  - addNotificationSlots
```
public static void addNotificationSlots(List<NotificationSlot> slots)
                                 throws RemoteException
```
    Creates multiple notification slots.
    
    参数:
    
    slots - Indicates the notification slots to create.
    
    抛出:
    
    RemoteException - Throws this exception if an IPC exception occurs.
    
    IllegalArgumentException - Throws this exception if slots is null.
    
    从以下版本开始:
    
    3
  - getNotificationSlots
```
public static List<NotificationSlot> getNotificationSlots()
                                                   throws RemoteException
```
    Obtains all notification slots of this application.
    
    返回:
    
    Returns all notification slots of this application.
    
    抛出:
    
    RemoteException - Throws this exception if an IPC exception occurs.
    
    从以下版本开始:
    
    3
  - publishNotificationAsBundle
```
public static void publishNotificationAsBundle(String representativeBundle,
                                               NotificationRequest request)
                                        throws RemoteException
```
    Publishes a notification in the name of a specified application bundle. If the notification to be published has the same ID as a published notification that has not been canceled, the existing notification will be replaced by the new one.
    
    参数:
    
    representativeBundle - Indicates the name of the application bundle that allows your application to publish notifications for it by calling setNotificationAgent(java.lang.String).
    
    request - Indicates the NotificationRequest object to be published.
    
    抛出:
    
    RemoteException - Throws this exception if an IPC exception occurs.
    
    IllegalArgumentException - Throws this exception if request or representativeBundle is null or if representativeBundle is an empty string.
    
    从以下版本开始:
    
    3
  - setNotificationAgent
```
public static void setNotificationAgent(String agent)
                                 throws RemoteException
```
    Allows another application to act as an agent to publish notifications in the name of your application bundle. You can revoke this authorization by passing null to this method.
    
    参数:
    
    agent - Indicates the name of the application bundle that can publish notifications for your application.
    
    抛出:
    
    RemoteException - Throws this exception if an IPC exception occurs.
    
    从以下版本开始:
    
    3
  - getNotificationAgent
```
public static String getNotificationAgent()
                                   throws RemoteException
```
    Obtains the name of the application bundle that can publish notifications in the name of your application.
    
    返回:
    
    Returns the name of the application bundle that can publish notifications for your application if any; returns null otherwise.
    
    抛出:
    
    RemoteException - Throws this exception if an IPC exception occurs.
    
    从以下版本开始:
    
    3
  - canPublishNotificationAsBundle
```
public static boolean canPublishNotificationAsBundle(String representativeBundle)
                                              throws RemoteException
```
    Checks whether your application has permission to publish notifications by calling publishNotificationAsBundle(java.lang.String,ohos.event.notification.NotificationRequest) in the name of another application indicated by the given representativeBundle.
    
    参数:
    
    representativeBundle - Indicates the name of application bundle your application is representing.
    
    返回:
    
    Returns true if your application can publish notifications for the given representativeBundle; returns false otherwise.
    
    抛出:
    
    RemoteException - Throws this exception if an IPC exception occurs.
    
    IllegalArgumentException - Throws this exception if representativeBundle is null.
    
    从以下版本开始:
    
    3
  - getNotificationSlotGroups
```
public static List<NotificationSlotGroup> getNotificationSlotGroups()
                                                             throws RemoteException
```
    Obtains a list of created notification slot groups.
    
    返回:
    
    Returns a list of created notification slot groups.
    
    抛出:
    
    RemoteException - Throws this exception if an IPC exception occurs.
    
    从以下版本开始:
    
    3
  - isAllowedNotify
```
public static boolean isAllowedNotify()
                               throws RemoteException
```
    Checks whether this application has permission to publish notifications.
    
    返回:
    
    Returns true if this application has the permission; returns false otherwise.
    
    抛出:
    
    RemoteException - Throws this exception if an IPC exception occurs.
    
    从以下版本开始:
    
    3
  - areNotificationsSuspended
```
public static boolean areNotificationsSuspended()
                                         throws RemoteException
```
    Checks whether this application is in the suspended state. Applications in this state cannot publish notifications.
    
    返回:
    
    Returns true if this application is suspended; returns false otherwise.
    
    抛出:
    
    RemoteException - Throws this exception if an IPC exception occurs.
    
    从以下版本开始:
    
    3
  - getBundleImportance
```
public static int getBundleImportance()
                               throws RemoteException
```
    Obtains the importance level of this application.
    
    返回:
    
    Returns the importance level of this application, which can be NotificationSlot#LEVEL_NONE, NotificationSlot#LEVEL_MIN, NotificationSlot#LEVEL_LOW, NotificationSlot#LEVEL_DEFAULT, NotificationSlot#LEVEL_HIGH, or NotificationSlot#LEVEL_UNDEFINED.
    
    抛出:
    
    RemoteException - Throws this exception if an IPC exception occurs.
    
    从以下版本开始:
    
    3
  - cancelNotification
```
public static void cancelNotification(String label,
                                      int notificationId)
                               throws RemoteException
```
    Cancels a published notification matching the specified label and notificationId.
    
    参数:
    
    label - Indicates the label of the notification to cancel.
    
    notificationId - Indicates the ID of the notification to cancel.
    
    抛出:
    
    RemoteException - Throws this exception if an IPC exception occurs.
    
    从以下版本开始:
    
    3

类 NotificationHelper

方法概要

从类继承的方法 java.lang.Object

方法详细资料

publishNotification

publishNotification

publishNotification

cancelNotification

cancelAllNotifications

addNotificationSlot

removeNotificationSlot

getNotificationSlot

getActiveNotifications

getActiveNotificationNums

setNotificationBadgeNum

setNotificationBadgeNum

getCurrentAppSorting

addNotificationSlotGroup

addNotificationSlotGroups

removeNotificationSlotGroup

getNotificationSlotGroup

hasNotificationPolicyAccessPermission

addNotificationSlots

getNotificationSlots

publishNotificationAsBundle

setNotificationAgent

getNotificationAgent

canPublishNotificationAsBundle

getNotificationSlotGroups

isAllowedNotify

areNotificationsSuspended

getBundleImportance

cancelNotification