diff --git a/zh-cn/application-dev/reference/apis/js-apis-commonEventManager.md b/zh-cn/application-dev/reference/apis/js-apis-commonEventManager.md index 53ef04cd6fb5d3041ea39dad65ad46909ff1e436..7cb58125b8042d6a8d188749c7fa6a6a1344c665 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-commonEventManager.md +++ b/zh-cn/application-dev/reference/apis/js-apis-commonEventManager.md @@ -70,7 +70,7 @@ publish(event: string, options: CommonEventPublishData, callback: AsyncCallback\ 以回调的形式发布公共事件。 -**系统能力：**SystemCapability.Notification.CommonEvent +**系统能力：** SystemCapability.Notification.CommonEvent **参数：** diff --git a/zh-cn/application-dev/reference/apis/js-apis-inner-commonEvent-commonEventData.md b/zh-cn/application-dev/reference/apis/js-apis-inner-commonEvent-commonEventData.md index 3fc9c0588ec58f4c0d5db27eb4cfade3d0607c32..3b4d46703ddca8e42ff725a4ac8b5cf82d974cdb 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-inner-commonEvent-commonEventData.md +++ b/zh-cn/application-dev/reference/apis/js-apis-inner-commonEvent-commonEventData.md @@ -1,11 +1,12 @@ # CommonEventData +公共通知的数据。 + > **说明：** > > 本模块首批接口从API version 7开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。 - -**系统能力：** `SystemCapability.Notification.CommonEvent` +**系统能力：** 以下各项对应的系统能力均为SystemCapability.Notification.CommonEvent | 名称 | 类型 | 可读 | 可写 | 说明 | | ---------- |-------------------- | ---- | ---- | ------------------------------------------------------- | diff --git a/zh-cn/application-dev/reference/apis/js-apis-inner-commonEvent-commonEventPublishData.md b/zh-cn/application-dev/reference/apis/js-apis-inner-commonEvent-commonEventPublishData.md index 70df6286eb1bf1877f40b9c37239522f9bc8d6b1..97cee6d5e1bbd48ea8b1fa750473118422ff3e50 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-inner-commonEvent-commonEventPublishData.md +++ b/zh-cn/application-dev/reference/apis/js-apis-inner-commonEvent-commonEventPublishData.md @@ -1,10 +1,12 @@ # CommonEventPublishData +包含公共事件内容和属性。 + > **说明：** > > 本模块首批接口从API version 7开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。 -**系统能力：** `SystemCapability.Notification.CommonEvent` +**系统能力：** 以下各项对应的系统能力均为SystemCapability.Notification.CommonEvent | 名称 | 类型 | 可读 | 可写 | 说明 | | --------------------- | -------------------- | ---- | ---- | ---------------------------- | diff --git a/zh-cn/application-dev/reference/apis/js-apis-inner-notification-notificationActionButton.md b/zh-cn/application-dev/reference/apis/js-apis-inner-notification-notificationActionButton.md index be9c2739273588cdf154fe67e15c2934bde3253b..c1665c7279a43f28d761a7c95b5bb801c73fdc92 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-inner-notification-notificationActionButton.md +++ b/zh-cn/application-dev/reference/apis/js-apis-inner-notification-notificationActionButton.md @@ -6,7 +6,7 @@ > > 本模块首批接口从API version 7开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。 -**系统能力**：以下各项对应的系统能力均为SystemCapability.Notification.Notification +**系统能力：** 以下各项对应的系统能力均为SystemCapability.Notification.Notification | 名称 | 类型 | 只读 | 必填 | 说明 | | --------- | ----------------------------------------------- | --- | ---- | ------------------------- | diff --git a/zh-cn/application-dev/reference/apis/js-apis-inner-notification-notificationCommonDef.md b/zh-cn/application-dev/reference/apis/js-apis-inner-notification-notificationCommonDef.md index 8a16b02de6fc69db232f0d446dbf7c989f2d185d..bf63991b7f61dd39a9a1b0a24d81a97de8f952d7 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-inner-notification-notificationCommonDef.md +++ b/zh-cn/application-dev/reference/apis/js-apis-inner-notification-notificationCommonDef.md @@ -10,8 +10,8 @@ BundleOption模块为指定应用的包信息。 **系统能力**：以下各项对应的系统能力均为SystemCapability.Notification.Notification -| 名称 | 类型 | 可读 | 可写 | 必填 | 说明 | -| ------ | ------ | ---- | ---- | ------ | ------ | -| bundle | string | 是 | 是 | 是 | 应用的包信息。 | -| uid | number | 是 | 是 | 否 | 用户ID。 | +| 名称 | 类型 | 必填 | 说明 | +| ------ | ------ | ------ | ------ | +| bundle | string | 是 | 应用的包信息。 | +| uid | number | 否 | 用户ID。 | diff --git a/zh-cn/application-dev/reference/apis/js-apis-inner-notification-notificationContent.md b/zh-cn/application-dev/reference/apis/js-apis-inner-notification-notificationContent.md index a8d6d31263f2ca8ea3ebc530856d3a5336b4ab80..32105e1fd43ddba2d547f464e199b6cf1c7439f8 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-inner-notification-notificationContent.md +++ b/zh-cn/application-dev/reference/apis/js-apis-inner-notification-notificationContent.md @@ -6,6 +6,8 @@ > > 本模块首批接口从API version 7开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。 +## NotificationContent + **系统能力**：以下各项对应的系统能力均为SystemCapability.Notification.Notification | 名称 | 类型 | 只读 | 必填 | 说明 | @@ -22,11 +24,11 @@ **系统能力**：以下各项对应的系统能力均为SystemCapability.Notification.Notification -| 名称 | 类型 | 只读 | 必填 | 说明 | -| -------------- | ------ | ---- | ---- | ---------------------------------- | -| title | string | 否 | 是 | 通知标题。 | -| text | string | 否 | 是 | 通知内容。 | -| additionalText | string | 否 | 否 | 通知附加内容，是对通知内容的补充。 | +| 名称 | 类型 | 必填 | 说明 | +| -------------- | ------ | ---- | ---------------------------------- | +| title | string | 是 | 通知标题。 | +| text | string | 是 | 通知内容。 | +| additionalText | string | 否 | 通知附加内容，是对通知内容的补充。 | ## NotificationLongTextContent @@ -35,14 +37,14 @@ **系统能力**：以下各项对应的系统能力均为SystemCapability.Notification.Notification -| 名称 | 类型 | 只读 | 必填 | 说明 | -| -------------- | ------ | ---- | --- | -------------------------------- | -| title | string | 否 | 是 | 通知标题。 | -| text | string | 否 | 是 | 通知内容。 | -| additionalText | string | 否 | 否 | 通知附加内容，是对通知内容的补充。 | -| longText | string | 否 | 是 | 通知的长文本。 | -| briefText | string | 否 | 是 | 通知概要内容，是对通知内容的总结。 | -| expandedTitle | string | 否 | 是 | 通知展开时的标题。 | +| 名称 | 类型 | 必填 | 说明 | +| -------------- | ------ | --- | -------------------------------- | +| title | string | 是 | 通知标题。 | +| text | string | 是 | 通知内容。 | +| additionalText | string | 否 | 通知附加内容，是对通知内容的补充。 | +| longText | string | 是 | 通知的长文本。 | +| briefText | string | 是 | 通知概要内容，是对通知内容的总结。 | +| expandedTitle | string | 是 | 通知展开时的标题。 | ## NotificationMultiLineContent diff --git a/zh-cn/application-dev/reference/apis/js-apis-inner-notification-notificationFlags.md b/zh-cn/application-dev/reference/apis/js-apis-inner-notification-notificationFlags.md index ba8870be4249237fda3ceb64b1ccb3f0b934c97d..425315a5b1f831992ae6052d2acf2c8d54d6f8f6 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-inner-notification-notificationFlags.md +++ b/zh-cn/application-dev/reference/apis/js-apis-inner-notification-notificationFlags.md @@ -8,10 +8,10 @@ **系统能力**：以下各项对应的系统能力均为SystemCapability.Notification.Notification -| 名称 | 类型 | 只读 | 必填 | 说明 | -| ---------------- | ---------------------- | ---- | ---- | --------------------------------- | -| soundEnabled | [NotificationFlagStatus](#notificationflagstatus) | 是 | 否 | 是否启用声音提示。 | -| vibrationEnabled | [NotificationFlagStatus](#notificationflagstatus) | 是 | 否 | 是否启用振动提醒功能。 | +| 名称 | 类型 | 必填 | 说明 | +| ---------------- | ---------------------- | ---- | --------------------------------- | +| soundEnabled | [NotificationFlagStatus](#notificationflagstatus) | 否 | 是否启用声音提示。 | +| vibrationEnabled | [NotificationFlagStatus](#notificationflagstatus) | 否 | 是否启用振动提醒功能。 | ## NotificationFlagStatus diff --git a/zh-cn/application-dev/reference/apis/js-apis-inner-notification-notificationRequest.md b/zh-cn/application-dev/reference/apis/js-apis-inner-notification-notificationRequest.md index a4faf72799f3871cbbf2451742c8338773d2adf7..92cdce972693dbd4daede417f8e5097eceb60958 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-inner-notification-notificationRequest.md +++ b/zh-cn/application-dev/reference/apis/js-apis-inner-notification-notificationRequest.md @@ -6,47 +6,49 @@ > > 本模块首批接口从API version 7开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。 +## NotificationRequest + **系统能力**：以下各项对应的系统能力均为SystemCapability.Notification.Notification -| 名称 | 类型 | 只读 | 必填 | 说明 | -| --------------------- | --------------------------------------------- | ---- | --- | -------------------------- | -| content | [NotificationContent](js-apis-inner-notification-notificationContent.md#notificationcontent) | 否 | 是 | 通知内容。 | -| id | number | 否 | 否 | 通知ID。 | -| slotType | [SlotType](js-apis-notificationManager.md#slottype) | 是 | 否 | 通道类型。 | -| isOngoing | boolean | 否 | 否 | 是否进行时通知。 | -| isUnremovable | boolean | 否 | 否 | 是否可移除。 | -| deliveryTime | number | 否 | 否 | 通知发送时间。 | -| tapDismissed | boolean | 否 | 否 | 通知是否自动清除。 | -| autoDeletedTime | number | 否 | 否 | 自动清除的时间。 | -| wantAgent | [WantAgent](js-apis-app-ability-wantAgent.md) | 否 | 否 | 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](js-apis-inner-notification-notificationActionButton.md)\> | 否 | 否 | 通知按钮，最多三个按钮。 | -| smallIcon | [image.PixelMap](js-apis-image.md#pixelmap7) | 否 | 否 | 通知小图标。可选字段，大小不超过30KB。 | -| largeIcon | [image.PixelMap](js-apis-image.md#pixelmap7) | 否 | 否 | 通知大图标。可选字段，大小不超过30KB。 | -| creatorBundleName | string | 是 | 否 | 创建通知的包名。 | -| creatorUid8+ | number | 是 | 否 | 创建通知的UID。 | -| creatorPid | number | 是 | 否 | 创建通知的PID。 | -| creatorUserId | number | 是 | 否 | 创建通知的UserId。 | -| hashCode | string | 是 | 否 | 通知唯一标识。 | -| classification | string | 否 | 否 | 通知分类。
**系统API**: 此接口为系统接口，三方应用不支持调用。 | -| groupName8+ | string | 否 | 否 | 组通知名称。 | -| template8+ | [NotificationTemplate](./js-apis-inner-notification-notificationTemplate.md) | 否 | 否 | 通知模板。 | -| isRemoveAllowed8+ | boolean | 是 | 否 | 通知是否能被移除。
**系统API**: 此接口为系统接口，三方应用不支持调用。 | -| source8+ | number | 是 | 否 | 通知源。
**系统API**: 此接口为系统接口，三方应用不支持调用。 | -| distributedOption8+ | [DistributedOptions](#distributedoptions) | 否 | 否 | 分布式通知的选项。 | -| deviceId8+ | string | 是 | 否 | 通知源的deviceId。
**系统API**: 此接口为系统接口，三方应用不支持调用。 | -| notificationFlags8+ | [NotificationFlags](js-apis-inner-notification-notificationFlags.md#notificationflags) | 是 | 否 | 获取NotificationFlags。 | -| removalWantAgent9+ | [WantAgent](js-apis-app-ability-wantAgent.md) | 否 | 否 | 当移除通知时，通知将被重定向到的WantAgent实例。 | -| badgeNumber9+ | number | 否 | 否 | 应用程序图标上显示的通知数。 | +| 名称 | 类型 | 必填 | 说明 | +| --------------------- | --------------------------------------------- | --- | -------------------------- | +| content | [NotificationContent](js-apis-inner-notification-notificationContent.md#notificationcontent) | 是 | 通知内容。 | +| id | number | 否 | 通知ID。 | +| slotType | [SlotType](js-apis-notificationManager.md#slottype) | 否 | 通道类型。 | +| isOngoing | boolean | 否 | 是否进行时通知。 | +| isUnremovable | boolean | 否 | 是否可移除。 | +| deliveryTime | number | 否 | 通知发送时间。 | +| tapDismissed | boolean | 否 | 通知是否自动清除。 | +| autoDeletedTime | number | 否 | 自动清除的时间。 | +| wantAgent | [WantAgent](js-apis-app-ability-wantAgent.md) | 否 | 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](js-apis-inner-notification-notificationActionButton.md)\> | 否 | 通知按钮，最多三个按钮。 | +| smallIcon | [image.PixelMap](js-apis-image.md#pixelmap7) | 否 | 通知小图标。可选字段，大小不超过30KB。 | +| largeIcon | [image.PixelMap](js-apis-image.md#pixelmap7) | 否 | 通知大图标。可选字段，大小不超过30KB。 | +| creatorBundleName | string | 否 | 创建通知的包名。 | +| creatorUid8+ | number | 否 | 创建通知的UID。 | +| creatorPid | number | 否 | 创建通知的PID。 | +| creatorUserId | number | 否 | 创建通知的UserId。 | +| hashCode | string | 否 | 通知唯一标识。 | +| classification | string | 否 | 通知分类。
**系统API**: 此接口为系统接口，三方应用不支持调用。 | +| groupName8+ | string | 否 | 组通知名称。 | +| template8+ | [NotificationTemplate](./js-apis-inner-notification-notificationTemplate.md) | 否 | 通知模板。 | +| isRemoveAllowed8+ | boolean | 否 | 通知是否能被移除。
**系统API**: 此接口为系统接口，三方应用不支持调用。 | +| source8+ | number | 否 | 通知源。
**系统API**: 此接口为系统接口，三方应用不支持调用。 | +| distributedOption8+ | [DistributedOptions](#distributedoptions) | 否 | 分布式通知的选项。 | +| deviceId8+ | string | 否 | 通知源的deviceId。
**系统API**: 此接口为系统接口，三方应用不支持调用。 | +| notificationFlags8+ | [NotificationFlags](js-apis-inner-notification-notificationFlags.md#notificationflags) | 否 | 获取NotificationFlags。 | +| removalWantAgent9+ | [WantAgent](js-apis-app-ability-wantAgent.md) | 否 | 当移除通知时，通知将被重定向到的WantAgent实例。 | +| badgeNumber9+ | number | 否 | 应用程序图标上显示的通知数。 | ## DistributedOptions @@ -55,9 +57,9 @@ **系统能力**：以下各项对应的系统能力均为SystemCapability.Notification.Notification -| 名称 | 类型 | 只读 | 必填 | 说明 | -| ---------------------- | -------------- | ---- | ---- | ---------------------------------- | -| isDistributed8+ | boolean | 否 | 否 | 是否为分布式通知。 | -| supportDisplayDevices8+ | Array\ | 否 | 否 | 可以同步通知到的设备列表。 | -| supportOperateDevices8+ | Array\ | 否 | 否 | 可以打开通知的设备列表。 | -| remindType8+ | number | 是 | 否 | 通知的提醒方式。
**系统API**: 此接口为系统接口，三方应用不支持调用。 | +| 名称 | 类型 | 必填 | 说明 | +| ---------------------- | -------------- | ---- | ---------------------------------- | +| isDistributed8+ | boolean | 否 | 是否为分布式通知。 | +| supportDisplayDevices8+ | Array\ | 否 | 可以同步通知到的设备列表。 | +| supportOperateDevices8+ | Array\ | 否 | 可以打开通知的设备列表。 | +| remindType8+ | number | 否 | 通知的提醒方式。
**系统API**: 此接口为系统接口，三方应用不支持调用。 | diff --git a/zh-cn/application-dev/reference/apis/js-apis-inner-notification-notificationSlot.md b/zh-cn/application-dev/reference/apis/js-apis-inner-notification-notificationSlot.md index b0ff35c59d2014fbd8b1565ea4436d58c7c6c58f..b4b773ad2092567bd887c547b74ec672ceb580ff 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-inner-notification-notificationSlot.md +++ b/zh-cn/application-dev/reference/apis/js-apis-inner-notification-notificationSlot.md @@ -1,24 +1,26 @@ # NotificationSlot -描述通知槽 +描述通知槽。 > **说明：** > > 本模块首批接口从API version 7开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。 -**系统能力**：以下各项对应的系统能力均为SystemCapability.Notification.Notification +## NotificationSlot -| 名称 | 类型 | 只读 | 必填 | 说明 | -| -------------------- | --------------------- | ---- | --- | ------------------------------------------ | -| type | [SlotType](js-apis-notificationManager.md#slottype) | 否 | 是 | 通道类型。 | -| level | number | 否 | 否 | 通知级别，不设置则根据通知渠道类型有默认值。 | -| desc | string | 否 | 否 | 通知渠道描述信息。 | -| badgeFlag | boolean | 否 | 否 | 是否显示角标。 | -| bypassDnd | boolean | 否 | 否 | 置是否在系统中绕过免打扰模式。 | -| lockscreenVisibility | number | 否 | 否 | 在锁定屏幕上显示通知的模式。 | -| vibrationEnabled | boolean | 否 | 否 | 是否可振动。 | -| sound | string | 否 | 否 | 通知提示音。 | -| lightEnabled | boolean | 否 | 否 | 是否闪灯。 | -| lightColor | number | 否 | 否 | 通知灯颜色。 | -| vibrationValues | Array\ | 否 | 否 | 通知振动样式。 | -| enabled9+ | boolean | 是 | 否 | 此通知插槽中的启停状态。 | +**系统能力：** 以下各项对应的系统能力均为SystemCapability.Notification.Notification + +| 名称 | 类型 | 必填 | 说明 | +| -------------------- | --------------------- | --- | ------------------------------------------ | +| type | [SlotType](js-apis-notificationManager.md#slottype) | 是 | 通道类型。 | +| level | number | 否 | 通知级别，不设置则根据通知渠道类型有默认值。 | +| desc | string | 否 | 通知渠道描述信息。 | +| badgeFlag | boolean | 否 | 是否显示角标。 | +| bypassDnd | boolean | 否 | 置是否在系统中绕过免打扰模式。 | +| lockscreenVisibility | number | 否 | 在锁定屏幕上显示通知的模式。 | +| vibrationEnabled | boolean | 否 | 是否可振动。 | +| sound | string | 否 | 通知提示音。 | +| lightEnabled | boolean | 否 | 是否闪灯。 | +| lightColor | number | 否 | 通知灯颜色。 | +| vibrationValues | Array\ | 否 | 通知振动样式。 | +| enabled9+ | boolean | 否 | 此通知插槽中的启停状态。 | diff --git a/zh-cn/application-dev/reference/apis/js-apis-inner-notification-notificationSorting.md b/zh-cn/application-dev/reference/apis/js-apis-inner-notification-notificationSorting.md index 70f9c43710d183ff680304f7622b0b17cd771c67..163138c33f3a3bd21fc3a283e316fd9bea61bdc1 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-inner-notification-notificationSorting.md +++ b/zh-cn/application-dev/reference/apis/js-apis-inner-notification-notificationSorting.md @@ -6,12 +6,14 @@ > > 本模块首批接口从API version 7开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。 +# NotificationSorting + **系统能力**：以下各项对应的系统能力均为SystemCapability.Notification.Notification **系统接口**: 以下为系统接口，三方应用不支持调用。 -| 名称 | 类型 | 只读 | 必填 | 说明 | -| -------------------- | --------------------- | ---- | --- | ------------------------------------------ | -| slot | [NotificationSlot](js-apis-inner-notification-notificationSlot.md) | 是 | 是 | 通道类型。 | -| level | number | 是 | 是 | 通知级别，不设置则根据通知渠道类型有默认值。 | -| desc | string | 是 | 是 | 通知渠道描述信息。 | +| 名称 | 类型 | 必填 | 说明 | +| -------------------- | --------------------- | --- | ------------------------------------------ | +| slot | [NotificationSlot](js-apis-inner-notification-notificationSlot.md) | 是 | 通道类型。 | +| level | number | 是 | 通知级别，不设置则根据通知渠道类型有默认值。 | +| desc | string | 是 | 通知渠道描述信息。 | diff --git a/zh-cn/application-dev/reference/apis/js-apis-inner-notification-notificationSortingMap.md b/zh-cn/application-dev/reference/apis/js-apis-inner-notification-notificationSortingMap.md index 83a7e9c793a22fad440c7fac7568cb20c50aa5cb..a754e3aa064774ecebe40aaf5271b9a84b5e988b 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-inner-notification-notificationSortingMap.md +++ b/zh-cn/application-dev/reference/apis/js-apis-inner-notification-notificationSortingMap.md @@ -6,11 +6,13 @@ > > 本模块首批接口从API version 7开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。 +# NotificationSortingMap + **系统能力**：以下各项对应的系统能力均为SystemCapability.Notification.Notification **系统接口**: 以下为系统接口，三方应用不支持调用。 -| 名称 | 类型 | 只读 | 必填 | 说明 | -| -------------------- | --------------------- | ---- | --- | ------------------------------------------ | -| sortings | { [key: string]: [NotificationSorting](js-apis-inner-notification-notificationSorting.md) } | 是 | 是 | 通知排序信息。 | -| sortedHashCode | Array | 是 | 是 | 通知排序的HashCode。 | +| 名称 | 类型 | 必填 | 说明 | +| -------------------- | --------------------- | --- | ------------------------------------------ | +| sortings | { [key: string]: [NotificationSorting](js-apis-inner-notification-notificationSorting.md) } | 是 | 通知排序信息。 | +| sortedHashCode | Array | 是 | 通知排序的HashCode。 | diff --git a/zh-cn/application-dev/reference/apis/js-apis-inner-notification-notificationSubscribeInfo.md b/zh-cn/application-dev/reference/apis/js-apis-inner-notification-notificationSubscribeInfo.md index 58977595bb7fa9e3713dd56d4783fa951716cc2d..b7a1391c203f3e8365cd728168f869d73a6e0638 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-inner-notification-notificationSubscribeInfo.md +++ b/zh-cn/application-dev/reference/apis/js-apis-inner-notification-notificationSubscribeInfo.md @@ -6,11 +6,13 @@ > > 本模块首批接口从API version 7开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。 +## NotificationSubscribeInfo + **系统能力**：以下各项对应的系统能力均为SystemCapability.Notification.Notification **系统接口**: 以下为系统接口，三方应用不支持调用。 -| 名称 | 类型 | 只读 | 必填 | 说明 | -| -------------------- | --------------------- | ---- | --- | ------------------------------------------ | -| bundleNames | Array | 否 | 否 | 应用Bundle名称。 | -| userId | number | 否 | 否 | 用户ID。 | +| 名称 | 类型 | 必填 | 说明 | +| -------------------- | --------------------- | --- | ------------------------------------------ | +| bundleNames | Array | 否 | 应用Bundle名称。 | +| userId | number | 否 | 用户ID。 | diff --git a/zh-cn/application-dev/reference/apis/js-apis-inner-notification-notificationSubscriber.md b/zh-cn/application-dev/reference/apis/js-apis-inner-notification-notificationSubscriber.md index bfbd35379f5867e2e5c28f90a9b1cb45e0b693a0..e53daa7e49a115865817dcf383f1fbeb106278b9 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-inner-notification-notificationSubscriber.md +++ b/zh-cn/application-dev/reference/apis/js-apis-inner-notification-notificationSubscriber.md @@ -367,9 +367,9 @@ notificationSubscribe.subscribe(subscriber, subscribeCallback); **系统API**：此接口为系统接口，三方应用不支持调用。 -| 名称 | 类型 | 只读 | 必传 | 说明 | +| 名称 | 类型 | 可读 | 可写 | 说明 | | --------------- | ------------------------------------------------- | ---- | --- | -------- | -| request | [NotificationRequest](js-apis-inner-notification-notificationRequest#notificationrequest) | 是 | 是 | 通知内容。 | +| request | [NotificationRequest](js-apis-inner-notification-notificationRequest#notificationrequest) | 是 | 否 | 通知内容。 | | sortingMap | [NotificationSortingMap](js-apis-inner-notification-notificationSortingMap.md) | 是 | 否 | 通知排序信息。 | | reason | number | 是 | 否 | 删除原因。 | | sound | string | 是 | 否 | 通知声音。 | @@ -382,11 +382,11 @@ notificationSubscribe.subscribe(subscriber, subscribeCallback); **系统API**：此接口为系统接口，三方应用不支持调用。 -| 名称 | 类型 | 只读 | 必传 | 说明 | +| 名称 | 类型 | 可读 | 可写 | 说明 | | ------ | ------- | ---- | --- | ---------------- | -| bundle | string | 是 | 是 | 应用的包名。 | -| uid | number | 是 | 是 | 应用的uid。 | -| enable | boolean | 是 | 是 | 应用通知使能状态。 | +| bundle | string | 是 | 否 | 应用的包名。 | +| uid | number | 是 | 否 | 应用的uid。 | +| enable | boolean | 是 | 否 | 应用通知使能状态。 | ## BadgeNumberCallbackData10+ @@ -395,9 +395,9 @@ notificationSubscribe.subscribe(subscriber, subscribeCallback); **系统API**：此接口为系统接口，三方应用不支持调用。 -| 名称 | 类型 | 只读 | 必传 | 描述 | +| 名称 | 类型 | 可读 | 可写 | 描述 | | ----------- | ------ | ---- | ---- | ------------ | -| bundle | string | 是 | 是 | 应用的包名。 | -| uid | number | 是 | 是 | 应用的uid。 | -| badgeNumber | number | 是 | 是 | 角标个数。 | +| bundle | string | 是 | 否 | 应用的包名。 | +| uid | number | 是 | 否 | 应用的uid。 | +| badgeNumber | number | 是 | 否 | 角标个数。 | diff --git a/zh-cn/application-dev/reference/apis/js-apis-inner-notification-notificationTemplate.md b/zh-cn/application-dev/reference/apis/js-apis-inner-notification-notificationTemplate.md index bd1c262c5417cd745f0ea0d711a09bc93141f2c5..fc001cf0c7274e472b9143fdc5b410bfcde0e939 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-inner-notification-notificationTemplate.md +++ b/zh-cn/application-dev/reference/apis/js-apis-inner-notification-notificationTemplate.md @@ -6,9 +6,11 @@ > > 本模块首批接口从API version 8开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。 +# NotificationTemplate + **系统能力**：以下各项对应的系统能力均为SystemCapability.Notification.Notification -| 名称 | 类型 | 只读 | 必填 | 说明 | -| ---- | ---------------------- | ---- | ---- | ---------- | -| name | string | 否 | 是 | 模板名称。 | -| data | {[key:string]: Object} | 否 | 是 | 模板数据。 | +| 名称 | 类型 | 必填 | 说明 | +| ---- | ---------------------- | ---- | ---------- | +| name | string | 是 | 模板名称。 | +| data | {[key:string]: Object} | 是 | 模板数据。 | diff --git a/zh-cn/application-dev/reference/apis/js-apis-inner-notification-notificationUserInput.md b/zh-cn/application-dev/reference/apis/js-apis-inner-notification-notificationUserInput.md index 6623fad27f64660cfadff9e79813f152e3f01f72..6fad9713bf7b1619a0398e74f22cd86aadd197fa 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-inner-notification-notificationUserInput.md +++ b/zh-cn/application-dev/reference/apis/js-apis-inner-notification-notificationUserInput.md @@ -6,8 +6,10 @@ > > 本模块首批接口从API version 8开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。 +## NotificationUserInput + **系统能力**：SystemCapability.Notification.Notification -| 名称 | 类型 | 只读 | 必填 | 说明 | -| -------- | ------ | --- | ---- | ----------------------------- | -| inputKey | string | 否 | 是 | 用户输入时用于标识此输入的key。 | +| 名称 | 类型 | 必填 | 说明 | +| -------- | ------ | ---- | ----------------------------- | +| inputKey | string | 是 | 用户输入时用于标识此输入的key。 | diff --git a/zh-cn/application-dev/reference/apis/js-apis-notification.md b/zh-cn/application-dev/reference/apis/js-apis-notification.md index 001fa804788478def8c2c0b0c7215eece24413fe..12d12966b90dbc4b7901324066251e1ecfd2152e 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-notification.md +++ b/zh-cn/application-dev/reference/apis/js-apis-notification.md @@ -1460,7 +1460,7 @@ remove(bundle: BundleOption, notificationKey: NotificationKey, reason: RemoveRea | --------------- | ----------------------------------| ---- | -------------------- | | bundle | [BundleOption](#bundleoption) | 是 | 指定应用的包信息。 | | notificationKey | [NotificationKey](#notificationkeydeprecated) | 是 | 通知键值。 | -| reason | [RemoveReason](#removereason9) | 是 | 通知删除原因。 | +| reason | [RemoveReason](#removereason-deprecated) | 是 | 通知删除原因。 | | callback | AsyncCallback\ | 是 | 删除指定通知回调函数。 | **示例：** @@ -1502,7 +1502,7 @@ remove(bundle: BundleOption, notificationKey: NotificationKey, reason: RemoveRea | --------------- | --------------- | ---- | ---------- | | bundle | [BundleOption](#bundleoption) | 是 | 指定应用的包信息。 | | notificationKey | [NotificationKey](#notificationkeydeprecated) | 是 | 通知键值。 | -| reason | [RemoveReason](#removereason9) | 是 | 通知删除原因。 | +| reason | [RemoveReason](#removereason-deprecated) | 是 | 通知删除原因。 | **示例：** @@ -1537,7 +1537,7 @@ remove(hashCode: string, reason: RemoveReason, callback: AsyncCallback\): | 参数名 | 类型 | 必填 | 说明 | | -------- | --------------------- | ---- | -------------------- | | hashCode | string | 是 | 通知唯一ID。可以通过[onConsume](js-apis-inner-notification-notificationSubscriber.md#onconsume)回调的入参[SubscribeCallbackData](#subscribecallbackdata)获取其内部[NotificationRequest](#notificationrequest)对象中的hashCode。 | -| reason | [RemoveReason](#removereason9) | 是 | 通知删除原因。 | +| reason | [RemoveReason](#removereason-deprecated) | 是 | 通知删除原因。 | | callback | AsyncCallback\ | 是 | 删除指定通知回调函数。 | **示例：** @@ -1573,7 +1573,7 @@ remove(hashCode: string, reason: RemoveReason): Promise\ | 参数名 | 类型 | 必填 | 说明 | | -------- | ---------- | ---- | ---------- | | hashCode | string | 是 | 通知唯一ID。 | -| reason | [RemoveReason](#removereason9) | 是 | 通知删除原因。 | +| reason | [RemoveReason](#removereason-deprecated) | 是 | 通知删除原因。 | **示例：** @@ -2869,10 +2869,10 @@ Notification.getDeviceRemindType().then((data) => { > **说明：** > 从 API version 7开始支持，从API version 9开始废弃。建议使用[notificationManager.BundleOption](js-apis-inner-notification-notificationCommonDef.md#bundleoption)替代 -| 名称 | 类型 | 只读 | 必填 | 说明 | -| ------ | ------ |---- | --- | ------ | -| bundle | string | 否 | 是 | 应用的包信息。 | -| uid | number | 否 | 否 | 用户ID。 | +| 名称 | 类型 | 必填 | 说明 | +| ------ | ------ | --- | ------ | +| bundle | string | 是 | 应用的包信息。 | +| uid | number | 否 | 用户ID。 | ## NotificationKeydeprecated @@ -3055,7 +3055,7 @@ Notification.getDeviceRemindType().then((data) => { | classification | string | 是 | 是 | 通知分类。
**系统API**: 此接口为系统接口，三方应用不支持调用。 | | groupName8+| string | 是 | 是 | 组通知名称。 | | template8+ | [NotificationTemplate](#notificationtemplate8) | 是 | 是 | 通知模板。 | -| isRemoveAllowed8+ | boolean | 是 | 否 | 通知是否能被移除。
**系统API**: 此接口为系统接口，三方应用不支持调用。 | +| isRemoveAllowed10+ | boolean | 是 | 否 | 通知是否能被移除。
**系统API**: 此接口为系统接口，三方应用不支持调用。 | | source8+ | number | 是 | 否 | 通知源。
**系统API**: 此接口为系统接口，三方应用不支持调用。 | | distributedOption8+ | [DistributedOptions](#distributedoptions8) | 是 | 是 | 分布式通知的选项。 | | deviceId8+ | string | 是 | 否 | 通知源的deviceId。
**系统API**: 此接口为系统接口，三方应用不支持调用。 | @@ -3197,16 +3197,16 @@ Notification.getDeviceRemindType().then((data) => { | TYPE_CONTINUOUS | 1 | 连续通知。 | | TYPE_TIMER | 2 | 计划通知。 | -## RemoveReason9+ deprecated +## RemoveReason deprecated **系统能力**：SystemCapability.Notification.Notification **系统API**: 此接口为系统接口，三方应用不支持调用。 > **说明：** -> 从 API version 9开始支持，从API version 9开始废弃。建议使用[notificationManager.RemoveReason](js-apis-notificationSubscribe.md#removereason)替代 +> 从 API version 7开始支持，从API version 9开始废弃。建议使用[notificationManager.RemoveReason](js-apis-notificationSubscribe.md#removereason)替代 | 名称 | 值 | 说明 | | -------------------- | --- | -------------------- | -| CLICK_REASON_REMOVE9+ | 1 | 点击通知后删除通知。 | -| CANCEL_REASON_REMOVE9+ | 2 | 用户删除通知。 | \ No newline at end of file +| CLICK_REASON_REMOVE | 1 | 点击通知后删除通知。 | +| CANCEL_REASON_REMOVE | 2 | 用户删除通知。 | \ No newline at end of file diff --git a/zh-cn/application-dev/reference/apis/js-apis-notificationManager.md b/zh-cn/application-dev/reference/apis/js-apis-notificationManager.md index 37edea2416e7572c536f71ba81f91f4c3d6242e7..c74762d2d42d9ff53abdc8178db48023e7838c52 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-notificationManager.md +++ b/zh-cn/application-dev/reference/apis/js-apis-notificationManager.md @@ -100,7 +100,7 @@ publish(request: NotificationRequest): Promise\ ```ts // 通知Request对象 let notificationRequest: notificationManager.NotificationRequest = { - notificationId: 1, + id: 1, content: { contentType: notificationManager.ContentType.NOTIFICATION_CONTENT_BASIC_TEXT, normal: { @@ -217,7 +217,7 @@ publish(request: NotificationRequest, userId: number): Promise\ ```ts let notificationRequest: notificationManager.NotificationRequest = { - notificationId: 1, + id: 1, content: { contentType: notificationManager.ContentType.NOTIFICATION_CONTENT_BASIC_TEXT, normal: { @@ -3947,11 +3947,11 @@ try{ **系统API**：此接口为系统接口，三方应用不支持调用。 -| 名称 | 类型 | 可读 | 可写 | 必填 | 说明 | -| ----- | ------------------------------------- | ---- | ---- | ---- | ---------------------- | -| type | [DoNotDisturbType](#donotdisturbtype) | 是 | 是 | 是 | 免打扰设置的时间类型。 | -| begin | Date | 是 | 是 | 是 | 免打扰设置的起点时间。 | -| end | Date | 是 | 是 | 是 | 免打扰设置的终点时间。 | +| 名称 | 类型 | 必填 | 说明 | +| ----- | ------------------------------------- | ---- | ---------------------- | +| type | [DoNotDisturbType](#donotdisturbtype) | 是 | 免打扰设置的时间类型。 | +| begin | Date | 是 | 免打扰设置的起点时间。 | +| end | Date | 是 | 免打扰设置的终点时间。 | ## DoNotDisturbType @@ -4041,11 +4041,11 @@ try{ **需要权限**：ohos.permission.NOTIFICATION_CONTROLLER 和 ohos.permission.NOTIFICATION_AGENT_CONTROLLER -| 名称 | 类型 | 可读 | 可写 | 必填 | 说明 | -| ----- | ------------------------------------- | ---- | ---- | ---------------------- | ---------------------- | -| bundleName | string | 是 | 是 | 是 | bundle名称。 | -| notificationId | number | 是 | 是 | 是 | 通知Id。 | -| contentType | [ContentType](#contenttype) | 是 | 是 | 是 | 通知类型。 | +| 名称 | 类型 | 必填 | 说明 | +| ----- | ------------------------------------- | --- | ---------------------- | +| bundleName | string | 是 | bundle名称。 | +| notificationId | number | 是 | 通知Id。 | +| contentType | [ContentType](#contenttype) | 是 | 通知类型。 | ## NotificationCheckResult10+ @@ -4055,7 +4055,7 @@ try{ **需要权限**：ohos.permission.NOTIFICATION_CONTROLLER 和 ohos.permission.NOTIFICATION_AGENT_CONTROLLER -| 名称 | 类型 | 可读 | | 必填 | 说明 | -| ----- | ------------------------------------- | ---- | ---- | ---------------------- | ---------------------- | -| code | number | 是 | 是 | 是 | 0-display, 1-no display。 | -| message | string | 是 | 是 | 是 | 结果信息。 | +| 名称 | 类型 | 必填 | 说明 | +| ------- | ------------------------------------ | ---- | ---------------------- | +| code | number | 是 | 0-display, 1-no display。 | +| message | string | 是 | 结果信息。 | diff --git a/zh-cn/application-dev/reference/apis/js-apis-notificationSubscribe.md b/zh-cn/application-dev/reference/apis/js-apis-notificationSubscribe.md index f9cfaf6a1bcd09ea16026699fa29b71d7a6d8ab7..07245ceba265a5abdb9fe5de0d046419b91704d9 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-notificationSubscribe.md +++ b/zh-cn/application-dev/reference/apis/js-apis-notificationSubscribe.md @@ -667,10 +667,10 @@ notificationSubscribe.removeAll(userId, removeAllCallback); **系统API**: 此接口为系统接口，三方应用不支持调用。 -| 名称 | 类型 | 可读 | | 必填 | 说明 | -| ----- | ------ | ---- | --- | -------- | -------- | -| id | number | 是 | 是 | 是 | 通知ID。 | -| label | string | 是 | 是 | 否 | 通知标签。 | +| 名称 | 类型 | 必填 | 说明 | +| ----- | ------ | --- | -------- | +| id | number | 是 | 通知ID。 | +| label | string | 否 | 通知标签。 | ## RemoveReason