NotificationRequest (系统接口)

描述通知的请求。

说明：

本模块首批接口从API version 7开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。

当前界面仅包含本模块的系统接口，其他公开接口参见NotificationRequest。

NotificationRequest

系统能力：SystemCapability.Notification.Notification

名称	类型	只读	可选	说明
trigger23+	Trigger	否	是	条件对象。默认为空。 系统接口：此接口为系统接口。
overlayIcon11+	image.PixelMap	否	是	通知重叠图标，默认为空。图像像素的总字节数不超过192KB。 系统接口：此接口为系统接口。
classification	string	否	是	通知分类。 系统接口：此接口为系统接口。预留能力，暂未支持。
isRemoveAllowed8+	boolean	否	是	通知是否能被移除（点击通知下方删除按钮无法删除，左滑不出现删除按钮）。默认为true。 - true：是。 - false：否。 系统接口：此接口为系统接口。 需要权限：ohos.permission.SET_UNREMOVABLE_NOTIFICATION
source8+	number	是	是	通知源。 系统接口：此接口为系统接口。预留能力，暂未支持。
deviceId8+	string	是	是	通知源的deviceId。 系统接口：此接口为系统接口。预留能力，暂未支持。
representativeBundle12+	BundleOption	否	是	被代理的包信息。默认为空。 系统接口：此接口为系统接口。
notificationControlFlags12+	number	否	是	通知提醒方式管控。默认值为0。 可以通过此接口减少当前通知的提醒方式。与NotificationControlFlagStatus的枚举进行按位或运算得到该参数。 系统接口：此接口为系统接口。
unifiedGroupInfo12+	UnifiedGroupInfo	否	是	消息智能聚合信息字段。默认为空。 系统接口：此接口为系统接口。
creatorInstanceKey(deprecated)	number	是	是	创建者实例键值。 从API version 12开始支持，从API version 15开始废弃，建议使用appInstanceKey替代。 系统接口：此接口为系统接口。
agentBundle12+	BundleOption	是	是	创建通知的代理包信息。默认为空。 系统接口：此接口为系统接口。
appInstanceKey15+	string	是	是	应用实例键值。默认为空。 系统接口：此接口为系统接口。
notDistributed18+	boolean	否	是	通知是否不进行全场景跨设备协同显示，默认为false。 说明: 该字段与forceDistributed字段互斥，当两者同时为true时，仅notDistributed字段生效。 - 设置为true时：通知仅在本设备上显示。 - 设置为false时：通知将在所有协同设备上显示。 系统接口: 此接口为系统接口。
forceDistributed18+	boolean	否	是	通知是否强制进行全场景跨设备协同显示，默认为false。 说明: 仅当应用在跨设备协同管控名单中且notDistributed为false时，该字段才会生效。通过读取notification_config.json文件（文件配置路径见：notification_config_parse.h 中的NOTIFICATION_CONFIG_FILE属性）中的collaborationFilter字段，查看是否包含应用的UID或包名。如果包含，说明是在应用跨设备协同管控名单中。 - 设置为true时：通知将在所有协同设备上显示。 - 设置为false时：通知将按照协同管控名单显示。 系统接口: 此接口为系统接口。
extendInfo20+	Record<string, Object>	否	是	系统应用发布通知时的自定义扩展参数。默认为空。 系统接口: 此接口为系统接口。
groupInfo	GroupInfo	否	是	组通知定制信息。默认为空。 模型约束: 此接口仅可在Stage模型下使用。 起始版本：26.0.0 系统接口: 此接口为系统接口。

DistributedOptions⁸⁺

描述分布式选项。

系统能力：SystemCapability.Notification.Notification

名称	类型	只读	可选	说明
remindType	number	是	是	通知的提醒方式。 系统接口：此接口为系统接口。

NotificationFilter¹¹⁺

描述查询普通实况窗时的筛选条件。

系统能力：SystemCapability.Notification.Notification

系统接口：此接口为系统接口。

名称	类型	只读	可选	说明
bundle	BundleOption	否	否	实况通知的包信息。
notificationKey	notificationSubscribe.NotificationKey	否	否	通知信息，包含通知ID和通知标签。
extraInfoKeys	Array<string>	否	是	筛选附加信息的键值列表。不填表示查询所有的附加信息。

NotificationCheckRequest¹¹⁺

描述通知的鉴权信息。

系统能力：SystemCapability.Notification.Notification

系统接口：此接口为系统接口。

名称	类型	只读	可选	说明
contentType	notificationManager.ContentType	否	否	通知类型。
slotType	notificationManager.SlotType	否	否	渠道类型。
extraInfoKeys	Array<string>	否	否	实况通知的附加信息。

UnifiedGroupInfo¹²⁺

描述通知智能聚合信息字段。

系统能力：SystemCapability.Notification.Notification

系统接口：此接口为系统接口。

名称	类型	只读	可选	说明
key	string	否	是	聚合组ID。
title	string	否	是	聚合组标题。
content	string	否	是	聚合组摘要正文。
sceneName	string	否	是	聚合场景名称。
extraInfo	{[key: string]: any}	否	是	其他聚合信息。

MonitorEvent²³⁺

表示地理围栏的监控事件类型的枚举。

系统能力：SystemCapability.Notification.Notification

系统接口：此接口为系统接口。

名称	值	说明
MONITOR_TYPE_ENTRY	1	进入地理围栏。
MONITOR_TYPE_LEAVE	2	退出地理围栏。

CoordinateSystemType²³⁺

表示地理围栏坐标系类型的枚举。

系统能力：SystemCapability.Notification.Notification

系统接口：此接口为系统接口。

名称	值	说明
COORDINATE_TYPE_WGS84	1	WGS84坐标系。
COORDINATE_TYPE_GCJ02	2	GCJ02坐标系。

TriggerType²³⁺

表示触发条件的事件类型的枚举。

系统能力：SystemCapability.Notification.Notification

系统接口：此接口为系统接口。

名称	值	说明
TRIGGER_TYPE_GEOFENCE	1	地理围栏触发类型。

Geofence²³⁺

地理围栏的配置信息。

系统能力：SystemCapability.Notification.Notification

系统接口：此接口为系统接口。

名称	类型	只读	可选	说明
longitude	number	否	否	地理围栏中心点经度，取值范围：[-180, 180]。
latitude	number	否	否	地理围栏中心点纬度，取值范围：[-90, 90]。
radius	number	否	否	围栏半径，单位米，取值范围：[200, 2000]。
delayTime	number	否	是	围栏延迟时间，单位秒，进入围栏后触发围栏的延迟时间，取值范围：[0, 300]。默认值为0。
coordinateSystemType	CoordinateSystemType	否	否	中心点坐标系类型。
monitorEvent	MonitorEvent	否	否	围栏触发条件类型。

Trigger²³⁺

触发条件的具体信息。

系统能力：SystemCapability.Notification.Notification

系统接口：此接口为系统接口。

名称	类型	只读	可选	说明
type	TriggerType	否	否	条件类型。
condition	Geofence	否	否	条件具体描述。
displayTime	number	否	是	条件触发实况的展示时间，单位：秒，取值范围：[15, 1800]，默认值为900。

GroupInfo

组通知信息。

起始版本：26.0.0

系统能力：SystemCapability.Notification.Notification

模型约束： 此接口仅可在Stage模型下使用。

系统接口：此接口为系统接口。

名称	类型	只读	可选	说明
isGroupIcon	boolean	否	是	是否使用该通知NotificationRequest中的smallIcon字段作为通知成组后展示的组图标。当该通知是通知组中最新的一条通知，且开发者传入smallIcon时，是否使用smallIcon作为组图标。默认值为false。 - true：使用smallIcon作为组通知的图标。 - false：不使用smallIcon作为组通知的图标。
groupTitle	string	否	是	通知成组后展示的组标题。当该通知是通知组中最新的一条通知时，该字段生效。默认为空。