NotificationRequest

The NotificationRequest module describes the notification request.

NOTE

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

System capability: SystemCapability.Notification.Notification

Name	Type	Readable	Writable	Description
content	NotificationContent	Yes	Yes	Notification content.
id	number	Yes	Yes	Notification ID.
slotType	SlotType	Yes	Yes	Notification slot type.
isOngoing	boolean	Yes	Yes	Whether the notification is an ongoing notification.
isUnremovable	boolean	Yes	Yes	Whether the notification can be removed.
deliveryTime	number	Yes	Yes	Time when the notification is sent.
tapDismissed	boolean	Yes	Yes	Whether the notification is automatically cleared.
autoDeletedTime	number	Yes	Yes	Time when the notification is automatically cleared.
wantAgent	WantAgent	Yes	Yes	WantAgent instance to which the notification will be redirected after being clicked.
extraInfo	{[key: string]: any}	Yes	Yes	Extended parameters.
color	number	Yes	Yes	Background color of the notification. Not supported currently.
colorEnabled	boolean	Yes	Yes	Whether the notification background color can be enabled. Not supported currently.
isAlertOnce	boolean	Yes	Yes	Whether the notification triggers an alert only once.
isStopwatch	boolean	Yes	Yes	Whether to display the stopwatch.
isCountDown	boolean	Yes	Yes	Whether to display the countdown time.
isFloatingIcon	boolean	Yes	Yes	Whether the notification is displayed as a floating icon in the status bar.
label	string	Yes	Yes	Notification label.
badgeIconStyle	number	Yes	Yes	Notification badge type.
showDeliveryTime	boolean	Yes	Yes	Whether to display the time when the notification is delivered.
actionButtons	Array<NotificationActionButton>	Yes	Yes	Buttons in the notification. Up to three buttons are allowed.
smallIcon	image.PixelMap	Yes	Yes	Small notification icon. This field is optional, and the icon size cannot exceed 30 KB.
largeIcon	image.PixelMap	Yes	Yes	Large notification icon. This field is optional, and the icon size cannot exceed 30 KB.
creatorBundleName	string	Yes	No	Name of the bundle that creates the notification.
creatorUid⁸⁺	number	Yes	No	UID used for creating the notification.
creatorPid	number	Yes	No	PID used for creating the notification.
creatorUserId	number	Yes	No	ID of the user who creates the notification.
hashCode	string	Yes	No	Unique ID of the notification.
classification	string	Yes	Yes	Notification category. System API: This is a system API and cannot be called by third-party applications.
groupName⁸⁺	string	Yes	Yes	Notification group name.
template⁸⁺	NotificationTemplate	Yes	Yes	Notification template.
isRemoveAllowed⁸⁺	boolean	Yes	No	Whether the notification can be removed. System API: This is a system API and cannot be called by third-party applications.
source⁸⁺	number	Yes	No	Notification source. System API: This is a system API and cannot be called by third-party applications.
distributedOption⁸⁺	DistributedOptions	Yes	Yes	Distributed notification options.
deviceId⁸⁺	string	Yes	No	Device ID of the notification source. System API: This is a system API and cannot be called by third-party applications.
notificationFlags⁸⁺	NotificationFlags	Yes	No	Notification flags.
removalWantAgent⁹⁺	WantAgent	Yes	Yes	WantAgent instance to which the notification will be redirected when it is removed.
badgeNumber⁹⁺	number	Yes	Yes	Number of notifications displayed on the application icon.

DistributedOptions

Describes distributed notification options.

System capability: SystemCapability.Notification.Notification

Name	Type	Readable	Writable	Description
isDistributed⁸⁺	boolean	Yes	Yes	Whether the notification is a distributed notification.
supportDisplayDevices⁸⁺	Array<string>	Yes	Yes	List of the devices to which the notification can be synchronized.
supportOperateDevices⁸⁺	Array<string>	Yes	Yes	List of the devices on which the notification can be opened.
remindType⁸⁺	number	Yes	No	Notification reminder type. System API: This is a system API and cannot be called by third-party applications.