NotificationRequest
描述通知的请求。
说明:
本模块首批接口从API version 7开始支持。后续版本的新增接口,采用上角标单独标记接口的起始版本。
系统能力:以下各项对应的系统能力均为SystemCapability.Notification.Notification
名称 | 类型 | 只读 | 必填 | 说明 |
---|---|---|---|---|
content | NotificationContent | 否 | 是 | 通知内容。 |
id | number | 否 | 否 | 通知ID。 |
slotType | SlotType | 是 | 否 | 通道类型。 |
isOngoing | boolean | 否 | 否 | 是否进行时通知。 |
isUnremovable | boolean | 否 | 否 | 是否可移除。 |
deliveryTime | number | 否 | 否 | 通知发送时间。 |
tapDismissed | boolean | 否 | 否 | 通知是否自动清除。 |
autoDeletedTime | number | 否 | 否 | 自动清除的时间。 |
wantAgent | WantAgent | 否 | 否 | WantAgent封装了应用的行为意图,点击通知时触发该行为。 |
extraInfo | {[key: string]: any} | 否 | 否 | 扩展参数。 |
color | number | 否 | 否 | 通知背景颜色。预留能力,暂未支持。 |
colorEnabled | boolean | 否 | 否 | 通知背景颜色是否使能。预留能力,暂未支持。 |
isAlertOnce | boolean | 否 | 否 | 设置是否仅有一次此通知提醒。 |
isStopwatch | boolean | 否 | 否 | 是否显示已用时间。 |
isCountDown | boolean | 否 | 否 | 是否显示倒计时时间。 |
isFloatingIcon | boolean | 否 | 否 | 是否显示状态栏图标。 |
label | string | 否 | 否 | 通知标签。 |
badgeIconStyle | number | 否 | 否 | 通知角标类型。预留能力,暂未支持。 |
showDeliveryTime | boolean | 否 | 否 | 是否显示分发时间。 |
actionButtons | Array<NotificationActionButton> | 否 | 否 | 通知按钮,最多三个按钮。 |
smallIcon | image.PixelMap | 否 | 否 | 通知小图标。可选字段,大小不超过30KB。 |
largeIcon | image.PixelMap | 否 | 否 | 通知大图标。可选字段,大小不超过30KB。 |
creatorBundleName | string | 是 | 否 | 创建通知的包名。 |
creatorUid8+ | number | 是 | 否 | 创建通知的UID。 |
creatorPid | number | 是 | 否 | 创建通知的PID。 |
creatorUserId | number | 是 | 否 | 创建通知的UserId。 |
hashCode | string | 是 | 否 | 通知唯一标识。 |
classification | string | 否 | 否 | 通知分类。 系统API: 此接口为系统接口,三方应用不支持调用。 |
groupName8+ | string | 否 | 否 | 组通知名称。 |
template8+ | NotificationTemplate | 否 | 否 | 通知模板。 |
isRemoveAllowed8+ | boolean | 是 | 否 | 通知是否能被移除。 系统API: 此接口为系统接口,三方应用不支持调用。 |
source8+ | number | 是 | 否 | 通知源。 系统API: 此接口为系统接口,三方应用不支持调用。 |
distributedOption8+ | DistributedOptions | 否 | 否 | 分布式通知的选项。 |
deviceId8+ | string | 是 | 否 | 通知源的deviceId。 系统API: 此接口为系统接口,三方应用不支持调用。 |
notificationFlags8+ | NotificationFlags | 是 | 否 | 获取NotificationFlags。 |
removalWantAgent9+ | WantAgent | 否 | 否 | 当移除通知时,通知将被重定向到的WantAgent实例。 |
badgeNumber9+ | number | 否 | 否 | 应用程序图标上显示的通知数。 |
DistributedOptions
描述分布式选项。
系统能力:以下各项对应的系统能力均为SystemCapability.Notification.Notification
名称 | 类型 | 只读 | 必填 | 说明 |
---|---|---|---|---|
isDistributed8+ | boolean | 否 | 否 | 是否为分布式通知。 |
supportDisplayDevices8+ | Array<string> | 否 | 否 | 可以同步通知到的设备列表。 |
supportOperateDevices8+ | Array<string> | 否 | 否 | 可以打开通知的设备列表。 |
remindType8+ | number | 是 | 否 | 通知的提醒方式。 系统API: 此接口为系统接口,三方应用不支持调用。 |