# NotificationRequest

> phone 12+ | 2in1 13+ | tablet 12+ | tv 19+ | wearable 18+

定义了[通知请求](https://developer.huawei.com/consumer/cn/doc/harmonyos-guides/notification-glossary#notification-request通知请求)的数据结构，用于描述一条通知的全部信息，包括[通知内容](https://developer.huawei.com/consumer/cn/doc/harmonyos-guides/notification-glossary#notification-content通知内容)、标识、展示样式、交互行为等。
> 说明
>
> 本模块首批接口从API version 7开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。

## NotificationRequest

定义了[通知请求](https://developer.huawei.com/consumer/cn/doc/harmonyos-guides/notification-glossary#notification-request通知请求)的数据结构，用于描述一条通知的全部信息，包括[通知内容](https://developer.huawei.com/consumer/cn/doc/harmonyos-guides/notification-glossary#notification-content通知内容)、标识、展示样式、交互行为等。

**系统能力**：SystemCapability.Notification.Notification

|名称|类型|只读|可选|说明|
|:----------------------------|:-----------------------------------------------------------------------------------------------------------------------------------------------------------------------|:-|:-|:-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|content|[NotificationContent](https://developer.huawei.com/consumer/cn/doc/harmonyos-references/js-apis-inner-notification-notificationcontent#notificationcontent-1)|否|否|通知展示内容。包括通知标题、正文等。|
|id|number|否|是|通知ID，默认值为0。若已存在相同ID的通知，则更新该通知；若不存在相同ID的通知，则创建新的通知。|
|updateOnly^18+^|boolean|否|是|是否仅更新通知，默认值为false。 - true：若已存在相同ID的通知，则更新该通知；若不存在相同ID的通知，则更新失败，并且不创建新的通知。 - false：若已存在相同ID的通知，则更新该通知；若不存在相同ID的通知，则创建新的通知。|
|appMessageId^12+^|string|否|是|应用发送通知携带的唯一标识字段，用于通知去重。如果同一应用通过本地和云端等不同途径发布携带相同appMessageId的通知，设备只展示一条消息，之后收到的重复通知会被静默去重，不展示、不提醒。去重标识仅在通知发布的24小时内有效，超过24小时或者设备重启失效。 大小不超过202字节，超出部分会被截断。默认为空。|
|notificationSlotType^11+^|[notificationManager.SlotType](https://developer.huawei.com/consumer/cn/doc/harmonyos-references/js-apis-notificationmanager#slottype)|否|是|[通知渠道](https://developer.huawei.com/consumer/cn/doc/harmonyos-guides/notification-glossary#notification-slot通知渠道)类型，默认值为OTHER_TYPES。不同渠道类型的[通知提醒方式](https://developer.huawei.com/consumer/cn/doc/harmonyos-guides/notification-glossary#notification-reminder-mode通知提醒方式)不同。|
|notificationFlags^8+^|[NotificationFlags](https://developer.huawei.com/consumer/cn/doc/harmonyos-references/js-apis-inner-notification-notificationflags)|否|是|[通知标志位](https://developer.huawei.com/consumer/cn/doc/harmonyos-guides/notification-glossary#notification-flags通知标志位)设置，默认为空。从API version 23开始成为可写参数，设置该参数可削减通知的提醒方式，当通知渠道类型为[LIVE_VIEW](https://developer.huawei.com/consumer/cn/doc/harmonyos-references/js-apis-notificationmanager#slottype)时，该参数设置不生效。|
|priorityNotificationType^23+^|[notificationManager.PriorityNotificationType](https://developer.huawei.com/consumer/cn/doc/harmonyos-references/js-apis-notificationmanager#prioritynotificationtype23)|否|是|通知优先级类型，默认值为OTHER。设置该参数可使通知置顶，并且在[通知中心](https://developer.huawei.com/consumer/cn/doc/harmonyos-guides/notification-glossary#notification-center通知中心)以突出方式显示。 仅当应用申请并获得[优先通知权益](https://developer.huawei.com/consumer/cn/doc/harmonyos-guides/priority-notification-permission-guidelines)后，该字段方可生效。实际显示效果依赖于设备能力和通知中心UI样式。 **模型约束：** 此接口仅可在Stage模型下使用。|
|isAlertOnce|boolean|否|是|发布或更新该通知时，是否只进行一次通知提醒，默认为false。 - true：仅首次发布通知时进行提醒，后续更新该通知时，提醒方式变更为[LEVEL_LOW](https://developer.huawei.com/consumer/cn/doc/harmonyos-references/js-apis-notificationmanager#slotlevel)。 - false：每次均按照配置的通知提醒方式进行提醒。|
|sound^12+^|string|否|是|应用通知[自定义铃声](https://developer.huawei.com/consumer/cn/doc/harmonyos-guides/notification-glossary#customized-ringtone自定义铃声)资源路径，默认为空。支持两种音频资源来源： - 资源文件：应用预置的音频文件，资源文件必须放在resources/rawfile目录下，使用时直接传入文件名。 - 沙箱文件：网络下载或者用户生成的音频文件，必须放在[沙箱文件目录](https://developer.huawei.com/consumer/cn/doc/harmonyos-guides/app-sandbox-directory#应用文件目录与应用文件路径)EL1区域的files目录或者其子目录下，传入格式为uri::{fileUri}，其中fileUri是通过[getUriFromPath](https://developer.huawei.com/consumer/cn/doc/harmonyos-references/js-apis-file-fileuri#fileurigeturifrompath)获取的路径。例如，应用将下载的音频资源demo.mp3传入沙箱文件目录/data/storage/el1/base/files/，通过getUriFromPath获取的路径为file://{bundleName}/data/storage/el1/base/files/demo.mp3，使用该路径发布通知即可播放应用下载的音频资源。 支持m4a、aac、mp3、ogg、wav、flac、amr等格式。|
|badgeNumber^9+^|number|否|是|应用图标上显示的通知数，该数量累计展示，默认值为0。 当badgeNumber取值小于或等于0时，将忽略本次角标设定。 当角标累加设定个数取值大于99时，[通知角标](https://developer.huawei.com/consumer/cn/doc/harmonyos-guides/notification-glossary#notification-badge通知角标)将显示99+。 例如，应用发布3条通知，badgeNumber依次设置为2、0、3，应用将依次展示为2、2、5。|
|wantAgent|[WantAgent](https://developer.huawei.com/consumer/cn/doc/harmonyos-references/js-apis-app-ability-wantagent)|否|是|封装了应用的行为意图，点击通知时触发该行为，默认为空。|
|actionButtons|Array<[NotificationActionButton](https://developer.huawei.com/consumer/cn/doc/harmonyos-references/js-apis-inner-notification-notificationactionbutton)>|否|是|[通知按钮](https://developer.huawei.com/consumer/cn/doc/harmonyos-guides/notification-glossary#notification-button通知按钮)，默认为空。一条通知中最多包含两个按钮。从API version 16开始，wearable设备一条通知最多包含三个按钮。|
|removalWantAgent^9+^|[WantAgent](https://developer.huawei.com/consumer/cn/doc/harmonyos-references/js-apis-app-ability-wantagent)|否|是|封装了应用的行为意图，移除通知时触发该行为，默认为空。 当前不支持跳转UIAbility，只支持发布公共事件（即[WantAgentInfo](https://developer.huawei.com/consumer/cn/doc/harmonyos-references/js-apis-inner-wantagent-wantagentinfo#wantagentinfo-1)的actionType字段取值为4）。|
|tapDismissed|boolean|否|是|点击通知携带的wantAgent或actionButtons时，该通知是否自动清除。当通知携带wantAgent或actionButtons时该字段生效。默认值为true。 - true：点击通知或按钮后，自动删除当前通知。 - false：点击通知或按钮后，保留当前通知。|
|autoDeletedTime|number|否|是|通知定时清除时间。设置该参数可使通知在指定时间后自动清除。默认值为0。传入小于0的值或过去的时间值，该参数不生效。 数据格式：时间戳。 单位：毫秒。 例如，希望某通知存留3秒（3000ms）后对其进行清除，则对应的清除时间为：new Date().getTime() + 3000。|
|deliveryTime|number|否|是|通知发送时间。系统自动生成，无需开发者配置。 数据格式：时间戳。 单位：毫秒。|
|label|string|否|是|通知标签。 label字段的功能类似于id，可以单独使用，也可与id结合共同作为通知的标识。优先推荐使用id。 如果发布通知时label不为空，那么在更新或删除该通知时，也需要指定相应的label。 大小不超过202字节，超出部分会被截断。默认为空。|
|smallIcon|[image.PixelMap](https://developer.huawei.com/consumer/cn/doc/harmonyos-references/arkts-apis-image-pixelmap)|否|是|通知左侧图标，默认为空。系统自动生成，无需开发者配置。 图标像素的总字节数不超过192KB（图标像素的总字节数通过[getPixelBytesNumber](https://developer.huawei.com/consumer/cn/doc/harmonyos-references/arkts-apis-image-pixelmap#getpixelbytesnumber7)获取），超出后设置不生效。建议图标像素长宽为128*128。实际显示效果依赖于设备能力和通知中心UI样式，详情请参考[单条通知](https://developer.huawei.com/consumer/cn/doc/design-guides/system-features-notification-0000001793074217#section16881184782819)中的通知图标。|
|largeIcon|[image.PixelMap](https://developer.huawei.com/consumer/cn/doc/harmonyos-references/arkts-apis-image-pixelmap)|否|是|通知右侧图标，默认为空。当content使用[NotificationPictureContent](https://developer.huawei.com/consumer/cn/doc/harmonyos-references/js-apis-inner-notification-notificationcontent#notificationpicturecontent)时，该参数设置不生效。 图标像素的总字节数不超过192KB（图标像素的总字节数通过[getPixelBytesNumber](https://developer.huawei.com/consumer/cn/doc/harmonyos-references/arkts-apis-image-pixelmap#getpixelbytesnumber7)获取），超出后设置不生效。建议图标像素长宽为128*128。实际显示效果依赖于设备能力和通知中心UI样式，详情请参考[图片预览通知](https://developer.huawei.com/consumer/cn/doc/design-guides/system-features-notification-0000001793074217#section16214134103817)。|
|overlayIcon^23+^|[image.PixelMap](https://developer.huawei.com/consumer/cn/doc/harmonyos-references/arkts-apis-image-pixelmap)|否|是|通知重叠图标，替换通知左侧图标，默认为空。此接口只在[notificationSlotType](#notificationrequest-1)类型设置为SOCIAL_COMMUNICATION时生效。 图标像素的总字节数不超过192KB（图标像素的总字节数通过[getPixelBytesNumber](https://developer.huawei.com/consumer/cn/doc/harmonyos-references/arkts-apis-image-pixelmap#getpixelbytesnumber7)获取），超出后设置不生效。建议图标像素长宽为128*128。实际显示效果依赖于设备能力和通知中心UI样式，详情请参考[通讯对话类通知](https://developer.huawei.com/consumer/cn/doc/design-guides/system-features-notification-0000001793074217#section158281459143810)。|
|groupName^8+^|string|否|是|通知所属组。当不同通知的groupName相同时，这些通知将成组展示。 大小不超过202字节，超出部分会被截断。默认为空。|
|template^8+^|[NotificationTemplate](https://developer.huawei.com/consumer/cn/doc/harmonyos-references/js-apis-inner-notification-notificationtemplate)|否|是|通知模板，默认为空。|
|extraInfo|{[key: string]: any}|否|是|扩展参数。为应用提供定制服务。默认为空。 以下Key由系统赋值，开发者手动修改也不会生效，系统在数据传递时会自动修改为实际值。 - 'ohos.notificationManager.wantUri'：用户点击通知时传递给应用的[Want](https://developer.huawei.com/consumer/cn/doc/harmonyos-references/js-apis-app-ability-want#want) 中的uri字段，使用[getActiveNotifications](https://developer.huawei.com/consumer/cn/doc/harmonyos-references/js-apis-notification#notificationgetactivenotifications)接口获取该信息。|
|slotType^(deprecated)^|[notification.SlotType](https://developer.huawei.com/consumer/cn/doc/harmonyos-references/js-apis-notification#slottype)|否|是|通知渠道类型，默认值为OTHER_TYPES。 从API version 7开始支持，从API version 11开始废弃，建议使用notificationSlotType替代。|
|hashCode|string|是|是|通知唯一标识。|
|creatorBundleName|string|是|是|创建通知的应用名称。|
|creatorUid|number|是|是|创建通知的应用UID。|
|creatorPid|number|是|是|创建通知的PID。|
|creatorUserId^8+^|number|是|是|创建通知的用户ID。|
|isOngoing|boolean|否|是|预留能力，暂未支持。|
|isUnremovable|boolean|否|是|预留能力，暂未支持。|
|color|number|否|是|通知背景颜色。预留能力，暂未支持。|
|colorEnabled|boolean|否|是|通知背景颜色是否使能。预留能力，暂未支持。|
|isStopwatch|boolean|否|是|是否显示已用时间。预留能力，暂未支持。|
|isCountDown|boolean|否|是|是否显示倒计时时间。预留能力，暂未支持。|
|isFloatingIcon|boolean|否|是|是否显示状态栏图标。预留能力，暂未支持。|
|distributedOption^8+^|[DistributedOptions](#distributedoptions8)|否|是|[分布式通知](https://developer.huawei.com/consumer/cn/doc/harmonyos-guides/notification-glossary#distributed-notification分布式通知)的选项。预留能力，暂未支持。|
|badgeIconStyle|number|否|是|通知角标类型。预留能力，暂未支持。|
|showDeliveryTime|boolean|否|是|是否显示分发时间。预留能力，暂未支持。|

## DistributedOptions^8+^

描述[跨设备协同](https://developer.huawei.com/consumer/cn/doc/harmonyos-guides/notification-glossary#cross-device-collaboration跨设备协同)选项。预留能力，暂未支持。

**系统能力**：SystemCapability.Notification.Notification

|名称|类型|只读|可选|说明|
|:--------------------|:------------|:-|:-|:---------------------------------------------------------|
|isDistributed|boolean|否|是|是否支持跨设备协同通知。默认为true。 - true：支持跨设备协同通知。 - false：不支持跨设备协同通知。|
|supportDisplayDevices|Array<string>|否|是|可以同步通知到的设备列表。|
|supportOperateDevices|Array<string>|否|是|可以打开通知的设备列表。|

## NotificationParameters^24+^

描述[NotificationRequest](#notificationrequest-1)中wantAgent的部分信息。

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

**系统能力**：SystemCapability.Notification.Notification

|名称|类型|只读|可选|说明|
|:-------------|:---------------------|:-|:-|:---------------------------------------------------------------------------------------------------------------------------------------------------------|
|wantAction|string|否|是|应用在创建wantAgent时，传入的want的action字段，具体含义请参考[action](https://developer.huawei.com/consumer/cn/doc/harmonyos-references/js-apis-app-ability-want#want)。|
|wantUri|string|否|是|应用在创建wantAgent时，传入的want的uri字段，具体含义请参考[uri](https://developer.huawei.com/consumer/cn/doc/harmonyos-references/js-apis-app-ability-want#want)。|
|wantParameters|Record<string, Object>|否|是|应用在创建wantAgent时，传入的want的parameters字段，具体含义请参考[parameters](https://developer.huawei.com/consumer/cn/doc/harmonyos-references/js-apis-app-ability-want#want)。|