Skip to content

D
Docs

OpenHarmony / Docs
1 年多 前同步成功

通知 159
Star 292
Fork 28
D
Docs
未验证 提交 884002ba 编写于 作者: O openharmony_ci 提交者： Gitee
浏览文件
操作

!20587 fix notification issues 

Merge pull request !20587 from xuzhihao/master
上级 67bf717c db380861
显示空白变更内容
内联 并排
Showing with 169 addition and 150 deletion
zh-cn/application-dev/reference/apis/js-apis-commonEventManager.md
浏览文件 @ 884002ba
...@@ -70,7 +70,7 @@ publish(event: string, options: CommonEventPublishData, callback: AsyncCallback\ ...@@ -70,7 +70,7 @@ publish(event: string, options: CommonEventPublishData, callback: AsyncCallback\
以回调的形式发布公共事件。 以回调的形式发布公共事件。
**系统能力：**SystemCapability.Notification.CommonEvent **系统能力：** SystemCapability.Notification.CommonEvent
**参数：** **参数：**
......
zh-cn/application-dev/reference/apis/js-apis-inner-commonEvent-commonEventData.md
浏览文件 @ 884002ba
# CommonEventData # CommonEventData
公共通知的数据。
> **说明：** > **说明：**
> >
> 本模块首批接口从API version 7开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。 > 本模块首批接口从API version 7开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。
**系统能力：** 以下各项对应的系统能力均为SystemCapability.Notification.CommonEvent
**系统能力：** `SystemCapability.Notification.CommonEvent`
| 名称 | 类型 | 可读 | 可写 | 说明 | | 名称 | 类型 | 可读 | 可写 | 说明 |
| ---------- |-------------------- | ---- | ---- | ------------------------------------------------------- | | ---------- |-------------------- | ---- | ---- | ------------------------------------------------------- |
......
zh-cn/application-dev/reference/apis/js-apis-inner-commonEvent-commonEventPublishData.md
浏览文件 @ 884002ba
# CommonEventPublishData # CommonEventPublishData
包含公共事件内容和属性。
> **说明：** > **说明：**
> >
> 本模块首批接口从API version 7开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。 > 本模块首批接口从API version 7开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。
**系统能力：** `SystemCapability.Notification.CommonEvent` **系统能力：** 以下各项对应的系统能力均为SystemCapability.Notification.CommonEvent
| 名称 | 类型 | 可读 | 可写 | 说明 | | 名称 | 类型 | 可读 | 可写 | 说明 |
| --------------------- | -------------------- | ---- | ---- | ---------------------------- | | --------------------- | -------------------- | ---- | ---- | ---------------------------- |
......
zh-cn/application-dev/reference/apis/js-apis-inner-notification-notificationActionButton.md
浏览文件 @ 884002ba
...@@ -6,7 +6,7 @@ ...@@ -6,7 +6,7 @@
> >
> 本模块首批接口从API version 7开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。 > 本模块首批接口从API version 7开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。
**系统能力**：以下各项对应的系统能力均为SystemCapability.Notification.Notification **系统能力：** 以下各项对应的系统能力均为SystemCapability.Notification.Notification
| 名称 | 类型 | 只读 | 必填 | 说明 | | 名称 | 类型 | 只读 | 必填 | 说明 |
| --------- | ----------------------------------------------- | --- | ---- | ------------------------- | | --------- | ----------------------------------------------- | --- | ---- | ------------------------- |
......
zh-cn/application-dev/reference/apis/js-apis-inner-notification-notificationCommonDef.md
浏览文件 @ 884002ba
...@@ -10,8 +10,8 @@ BundleOption模块为指定应用的包信息。 ...@@ -10,8 +10,8 @@ BundleOption模块为指定应用的包信息。
**系统能力**：以下各项对应的系统能力均为SystemCapability.Notification.Notification **系统能力**：以下各项对应的系统能力均为SystemCapability.Notification.Notification
| 名称 | 类型 | 可读 | 可写 | 必填 | 说明 | | 名称 | 类型 | 必填 | 说明 |
| ------ | ------ | ---- | ---- | ------ | ------ | | ------ | ------ | ------ | ------ |
| bundle | string | 是 | 是 | 是 | 应用的包信息。 | | bundle | string | 是 | 应用的包信息。 |
| uid | number | 是 | 是 | 否 | 用户ID。 | | uid | number | 否 | 用户ID。 |
zh-cn/application-dev/reference/apis/js-apis-inner-notification-notificationContent.md
浏览文件 @ 884002ba
...@@ -6,6 +6,8 @@ ...@@ -6,6 +6,8 @@
> >
> 本模块首批接口从API version 7开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。 > 本模块首批接口从API version 7开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。
## NotificationContent
**系统能力**：以下各项对应的系统能力均为SystemCapability.Notification.Notification **系统能力**：以下各项对应的系统能力均为SystemCapability.Notification.Notification
| 名称 | 类型 | 只读 | 必填 | 说明 | | 名称 | 类型 | 只读 | 必填 | 说明 |
...@@ -22,11 +24,11 @@ ...@@ -22,11 +24,11 @@
**系统能力**：以下各项对应的系统能力均为SystemCapability.Notification.Notification **系统能力**：以下各项对应的系统能力均为SystemCapability.Notification.Notification
| 名称 | 类型 | 只读 | 必填 | 说明 | | 名称 | 类型 | 必填 | 说明 |
| -------------- | ------ | ---- | ---- | ---------------------------------- | | -------------- | ------ | ---- | ---------------------------------- |
| title | string | 否 | 是 | 通知标题。 | | title | string | 是 | 通知标题。 |
| text | string | 否 | 是 | 通知内容。 | | text | string | 是 | 通知内容。 |
| additionalText | string | 否 | 否 | 通知附加内容，是对通知内容的补充。 | | additionalText | string | 否 | 通知附加内容，是对通知内容的补充。 |
## NotificationLongTextContent ## NotificationLongTextContent
...@@ -35,14 +37,14 @@ ...@@ -35,14 +37,14 @@
**系统能力**：以下各项对应的系统能力均为SystemCapability.Notification.Notification **系统能力**：以下各项对应的系统能力均为SystemCapability.Notification.Notification
| 名称 | 类型 | 只读 | 必填 | 说明 | | 名称 | 类型 | 必填 | 说明 |
| -------------- | ------ | ---- | --- | -------------------------------- | | -------------- | ------ | --- | -------------------------------- |
| title | string | 否 | 是 | 通知标题。 | | title | string | 是 | 通知标题。 |
| text | string | 否 | 是 | 通知内容。 | | text | string | 是 | 通知内容。 |
| additionalText | string | 否 | 否 | 通知附加内容，是对通知内容的补充。 | | additionalText | string | 否 | 通知附加内容，是对通知内容的补充。 |
| longText | string | 否 | 是 | 通知的长文本。 | | longText | string | 是 | 通知的长文本。 |
| briefText | string | 否 | 是 | 通知概要内容，是对通知内容的总结。 | | briefText | string | 是 | 通知概要内容，是对通知内容的总结。 |
| expandedTitle | string | 否 | 是 | 通知展开时的标题。 | | expandedTitle | string | 是 | 通知展开时的标题。 |
## NotificationMultiLineContent ## NotificationMultiLineContent
......
zh-cn/application-dev/reference/apis/js-apis-inner-notification-notificationFlags.md
浏览文件 @ 884002ba
...@@ -8,10 +8,10 @@ ...@@ -8,10 +8,10 @@
**系统能力**：以下各项对应的系统能力均为SystemCapability.Notification.Notification **系统能力**：以下各项对应的系统能力均为SystemCapability.Notification.Notification
| 名称 | 类型 | 只读 | 必填 | 说明 | | 名称 | 类型 | 必填 | 说明 |
| ---------------- | ---------------------- | ---- | ---- | --------------------------------- | | ---------------- | ---------------------- | ---- | --------------------------------- |
| soundEnabled | [NotificationFlagStatus](#notificationflagstatus) | 是 | 否 | 是否启用声音提示。 | | soundEnabled | [NotificationFlagStatus](#notificationflagstatus) | 否 | 是否启用声音提示。 |
| vibrationEnabled | [NotificationFlagStatus](#notificationflagstatus) | 是 | 否 | 是否启用振动提醒功能。 | | vibrationEnabled | [NotificationFlagStatus](#notificationflagstatus) | 否 | 是否启用振动提醒功能。 |
## NotificationFlagStatus ## NotificationFlagStatus
......
zh-cn/application-dev/reference/apis/js-apis-inner-notification-notificationRequest.md
浏览文件 @ 884002ba
...@@ -6,47 +6,49 @@ ...@@ -6,47 +6,49 @@
> >
> 本模块首批接口从API version 7开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。 > 本模块首批接口从API version 7开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。
## NotificationRequest
**系统能力**：以下各项对应的系统能力均为SystemCapability.Notification.Notification **系统能力**：以下各项对应的系统能力均为SystemCapability.Notification.Notification
| 名称 | 类型 | 只读 | 必填 | 说明 | | 名称 | 类型 | 必填 | 说明 |
| --------------------- | --------------------------------------------- | ---- | --- | -------------------------- | | --------------------- | --------------------------------------------- | --- | -------------------------- |
| content | [NotificationContent](js-apis-inner-notification-notificationContent.md#notificationcontent) | 否 | 是 | 通知内容。 | | content | [NotificationContent](js-apis-inner-notification-notificationContent.md#notificationcontent) | 是 | 通知内容。 |
| id | number | 否 | 否 | 通知ID。 | | id | number | 否 | 通知ID。 |
| slotType | [SlotType](js-apis-notificationManager.md#slottype) | 是 | 否 | 通道类型。 | | slotType | [SlotType](js-apis-notificationManager.md#slottype) | 否 | 通道类型。 |
| isOngoing | boolean | 否 | 否 | 是否进行时通知。 | | isOngoing | boolean | 否 | 是否进行时通知。 |
| isUnremovable | boolean | 否 | 否 | 是否可移除。 | | isUnremovable | boolean | 否 | 是否可移除。 |
| deliveryTime | number | 否 | 否 | 通知发送时间。 | | deliveryTime | number | 否 | 通知发送时间。 |
| tapDismissed | boolean | 否 | 否 | 通知是否自动清除。 | | tapDismissed | boolean | 否 | 通知是否自动清除。 |
| autoDeletedTime | number | 否 | 否 | 自动清除的时间。 | | autoDeletedTime | number | 否 | 自动清除的时间。 |
| wantAgent | [WantAgent](js-apis-app-ability-wantAgent.md) | 否 | 否 | WantAgent封装了应用的行为意图，点击通知时触发该行为。 | | wantAgent | [WantAgent](js-apis-app-ability-wantAgent.md) | 否 | WantAgent封装了应用的行为意图，点击通知时触发该行为。 |
| extraInfo | {[key: string]: any} | 否 | 否 | 扩展参数。 | | extraInfo | {[key: string]: any} | 否 | 扩展参数。 |
| color | number | 否 | 否 | 通知背景颜色。预留能力，暂未支持。 | | color | number | 否 | 通知背景颜色。预留能力，暂未支持。 |
| colorEnabled | boolean | 否 | 否 | 通知背景颜色是否使能。预留能力，暂未支持。 | | colorEnabled | boolean | 否 | 通知背景颜色是否使能。预留能力，暂未支持。 |
| isAlertOnce | boolean | 否 | 否 | 设置是否仅有一次此通知提醒。 | | isAlertOnce | boolean | 否 | 设置是否仅有一次此通知提醒。 |
| isStopwatch | boolean | 否 | 否 | 是否显示已用时间。 | | isStopwatch | boolean | 否 | 是否显示已用时间。 |
| isCountDown | boolean | 否 | 否 | 是否显示倒计时时间。 | | isCountDown | boolean | 否 | 是否显示倒计时时间。 |
| isFloatingIcon | boolean | 否 | 否 | 是否显示状态栏图标。 | | isFloatingIcon | boolean | 否 | 是否显示状态栏图标。 |
| label | string | 否 | 否 | 通知标签。 | | label | string | 否 | 通知标签。 |
| badgeIconStyle | number | 否 | 否 | 通知角标类型。预留能力，暂未支持。 | | badgeIconStyle | number | 否 | 通知角标类型。预留能力，暂未支持。 |
| showDeliveryTime | boolean | 否 | 否 | 是否显示分发时间。 | | showDeliveryTime | boolean | 否 | 是否显示分发时间。 |
| actionButtons | Array\<[NotificationActionButton](js-apis-inner-notification-notificationActionButton.md)\> | 否 | 否 | 通知按钮，最多三个按钮。 | | actionButtons | Array\<[NotificationActionButton](js-apis-inner-notification-notificationActionButton.md)\> | 否 | 通知按钮，最多三个按钮。 |
| smallIcon | [image.PixelMap](js-apis-image.md#pixelmap7) | 否 | 否 | 通知小图标。可选字段，大小不超过30KB。 | | smallIcon | [image.PixelMap](js-apis-image.md#pixelmap7) | 否 | 通知小图标。可选字段，大小不超过30KB。 |
| largeIcon | [image.PixelMap](js-apis-image.md#pixelmap7) | 否 | 否 | 通知大图标。可选字段，大小不超过30KB。 | | largeIcon | [image.PixelMap](js-apis-image.md#pixelmap7) | 否 | 通知大图标。可选字段，大小不超过30KB。 |
| creatorBundleName | string | 是 | 否 | 创建通知的包名。 | | creatorBundleName | string | 否 | 创建通知的包名。 |
| creatorUid<sup>8+<sup> | number | 是 | 否 | 创建通知的UID。 | | creatorUid<sup>8+<sup> | number | 否 | 创建通知的UID。 |
| creatorPid | number | 是 | 否 | 创建通知的PID。 | | creatorPid | number | 否 | 创建通知的PID。 |
| creatorUserId | number | 是 | 否 | 创建通知的UserId。 | | creatorUserId | number | 否 | 创建通知的UserId。 |
| hashCode | string | 是 | 否 | 通知唯一标识。 | | hashCode | string | 否 | 通知唯一标识。 |
| classification | string | 否 | 否 | 通知分类。<br>**系统API**: 此接口为系统接口，三方应用不支持调用。 | | classification | string | 否 | 通知分类。<br>**系统API**: 此接口为系统接口，三方应用不支持调用。 |
| groupName<sup>8+<sup> | string | 否 | 否 | 组通知名称。 | | groupName<sup>8+<sup> | string | 否 | 组通知名称。 |
| template<sup>8+<sup> | [NotificationTemplate](./js-apis-inner-notification-notificationTemplate.md) | 否 | 否 | 通知模板。 | | template<sup>8+<sup> | [NotificationTemplate](./js-apis-inner-notification-notificationTemplate.md) | 否 | 通知模板。 |
| isRemoveAllowed<sup>8+<sup> | boolean | 是 | 否 | 通知是否能被移除。<br>**系统API**: 此接口为系统接口，三方应用不支持调用。 | | isRemoveAllowed<sup>8+<sup> | boolean | 否 | 通知是否能被移除。<br>**系统API**: 此接口为系统接口，三方应用不支持调用。 |
| source<sup>8+<sup> | number | 是 | 否 | 通知源。<br>**系统API**: 此接口为系统接口，三方应用不支持调用。 | | source<sup>8+<sup> | number | 否 | 通知源。<br>**系统API**: 此接口为系统接口，三方应用不支持调用。 |
| distributedOption<sup>8+<sup> | [DistributedOptions](#distributedoptions) | 否 | 否 | 分布式通知的选项。 | | distributedOption<sup>8+<sup> | [DistributedOptions](#distributedoptions) | 否 | 分布式通知的选项。 |
| deviceId<sup>8+<sup> | string | 是 | 否 | 通知源的deviceId。<br>**系统API**: 此接口为系统接口，三方应用不支持调用。 | | deviceId<sup>8+<sup> | string | 否 | 通知源的deviceId。<br>**系统API**: 此接口为系统接口，三方应用不支持调用。 |
| notificationFlags<sup>8+<sup> | [NotificationFlags](js-apis-inner-notification-notificationFlags.md#notificationflags) | 是 | 否 | 获取NotificationFlags。 | | notificationFlags<sup>8+<sup> | [NotificationFlags](js-apis-inner-notification-notificationFlags.md#notificationflags) | 否 | 获取NotificationFlags。 |
| removalWantAgent<sup>9+<sup> | [WantAgent](js-apis-app-ability-wantAgent.md) | 否 | 否 | 当移除通知时，通知将被重定向到的WantAgent实例。 | | removalWantAgent<sup>9+<sup> | [WantAgent](js-apis-app-ability-wantAgent.md) | 否 | 当移除通知时，通知将被重定向到的WantAgent实例。 |
| badgeNumber<sup>9+<sup> | number | 否 | 否 | 应用程序图标上显示的通知数。 | | badgeNumber<sup>9+<sup> | number | 否 | 应用程序图标上显示的通知数。 |
## DistributedOptions ## DistributedOptions
...@@ -55,9 +57,9 @@ ...@@ -55,9 +57,9 @@
**系统能力**：以下各项对应的系统能力均为SystemCapability.Notification.Notification **系统能力**：以下各项对应的系统能力均为SystemCapability.Notification.Notification
| 名称 | 类型 | 只读 | 必填 | 说明 | | 名称 | 类型 | 必填 | 说明 |
| ---------------------- | -------------- | ---- | ---- | ---------------------------------- | | ---------------------- | -------------- | ---- | ---------------------------------- |
| isDistributed<sup>8+<sup> | boolean | 否 | 否 | 是否为分布式通知。 | | isDistributed<sup>8+<sup> | boolean | 否 | 是否为分布式通知。 |
| supportDisplayDevices<sup>8+<sup> | Array\<string> | 否 | 否 | 可以同步通知到的设备列表。 | | supportDisplayDevices<sup>8+<sup> | Array\<string> | 否 | 可以同步通知到的设备列表。 |
| supportOperateDevices<sup>8+<sup> | Array\<string> | 否 | 否 | 可以打开通知的设备列表。 | | supportOperateDevices<sup>8+<sup> | Array\<string> | 否 | 可以打开通知的设备列表。 |
| remindType<sup>8+<sup> | number | 是 | 否 | 通知的提醒方式。<br>**系统API**: 此接口为系统接口，三方应用不支持调用。 | | remindType<sup>8+<sup> | number | 否 | 通知的提醒方式。<br>**系统API**: 此接口为系统接口，三方应用不支持调用。 |
zh-cn/application-dev/reference/apis/js-apis-inner-notification-notificationSlot.md
浏览文件 @ 884002ba
# NotificationSlot # NotificationSlot
描述通知槽 描述通知槽。
> **说明：** > **说明：**
> >
> 本模块首批接口从API version 7开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。 > 本模块首批接口从API version 7开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。
**系统能力**：以下各项对应的系统能力均为SystemCapability.Notification.Notification ## NotificationSlot
| 名称 | 类型 | 只读 | 必填 | 说明 | **系统能力：** 以下各项对应的系统能力均为SystemCapability.Notification.Notification
| -------------------- | --------------------- | ---- | --- | ------------------------------------------ |
| type | [SlotType](js-apis-notificationManager.md#slottype) | 否 | 是 | 通道类型。 | | 名称 | 类型 | 必填 | 说明 |
| level | number | 否 | 否 | 通知级别，不设置则根据通知渠道类型有默认值。 | | -------------------- | --------------------- | --- | ------------------------------------------ |
| desc | string | 否 | 否 | 通知渠道描述信息。 | | type | [SlotType](js-apis-notificationManager.md#slottype) | 是 | 通道类型。 |
| badgeFlag | boolean | 否 | 否 | 是否显示角标。 | | level | number | 否 | 通知级别，不设置则根据通知渠道类型有默认值。 |
| bypassDnd | boolean | 否 | 否 | 置是否在系统中绕过免打扰模式。 | | desc | string | 否 | 通知渠道描述信息。 |
| lockscreenVisibility | number | 否 | 否 | 在锁定屏幕上显示通知的模式。 | | badgeFlag | boolean | 否 | 是否显示角标。 |
| vibrationEnabled | boolean | 否 | 否 | 是否可振动。 | | bypassDnd | boolean | 否 | 置是否在系统中绕过免打扰模式。 |
| sound | string | 否 | 否 | 通知提示音。 | | lockscreenVisibility | number | 否 | 在锁定屏幕上显示通知的模式。 |
| lightEnabled | boolean | 否 | 否 | 是否闪灯。 | | vibrationEnabled | boolean | 否 | 是否可振动。 |
| lightColor | number | 否 | 否 | 通知灯颜色。 | | sound | string | 否 | 通知提示音。 |
| vibrationValues | Array\<number\> | 否 | 否 | 通知振动样式。 | | lightEnabled | boolean | 否 | 是否闪灯。 |
| enabled<sup>9+</sup> | boolean | 是 | 否 | 此通知插槽中的启停状态。 | | lightColor | number | 否 | 通知灯颜色。 |
| vibrationValues | Array\<number\> | 否 | 通知振动样式。 |
| enabled<sup>9+</sup> | boolean | 否 | 此通知插槽中的启停状态。 |
zh-cn/application-dev/reference/apis/js-apis-inner-notification-notificationSorting.md
浏览文件 @ 884002ba
...@@ -6,12 +6,14 @@ ...@@ -6,12 +6,14 @@
> >
> 本模块首批接口从API version 7开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。 > 本模块首批接口从API version 7开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。
# NotificationSorting
**系统能力**：以下各项对应的系统能力均为SystemCapability.Notification.Notification **系统能力**：以下各项对应的系统能力均为SystemCapability.Notification.Notification
**系统接口**: 以下为系统接口，三方应用不支持调用。 **系统接口**: 以下为系统接口，三方应用不支持调用。
| 名称 | 类型 | 只读 | 必填 | 说明 | | 名称 | 类型 | 必填 | 说明 |
| -------------------- | --------------------- | ---- | --- | ------------------------------------------ | | -------------------- | --------------------- | --- | ------------------------------------------ |
| slot | [NotificationSlot](js-apis-inner-notification-notificationSlot.md) | 是 | 是 | 通道类型。 | | slot | [NotificationSlot](js-apis-inner-notification-notificationSlot.md) | 是 | 通道类型。 |
| level | number | 是 | 是 | 通知级别，不设置则根据通知渠道类型有默认值。 | | level | number | 是 | 通知级别，不设置则根据通知渠道类型有默认值。 |
| desc | string | 是 | 是 | 通知渠道描述信息。 | | desc | string | 是 | 通知渠道描述信息。 |
zh-cn/application-dev/reference/apis/js-apis-inner-notification-notificationSortingMap.md
浏览文件 @ 884002ba
...@@ -6,11 +6,13 @@ ...@@ -6,11 +6,13 @@
> >
> 本模块首批接口从API version 7开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。 > 本模块首批接口从API version 7开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。
# NotificationSortingMap
**系统能力**：以下各项对应的系统能力均为SystemCapability.Notification.Notification **系统能力**：以下各项对应的系统能力均为SystemCapability.Notification.Notification
**系统接口**: 以下为系统接口，三方应用不支持调用。 **系统接口**: 以下为系统接口，三方应用不支持调用。
| 名称 | 类型 | 只读 | 必填 | 说明 | | 名称 | 类型 | 必填 | 说明 |
| -------------------- | --------------------- | ---- | --- | ------------------------------------------ | | -------------------- | --------------------- | --- | ------------------------------------------ |
| sortings | { [key: string]: [NotificationSorting](js-apis-inner-notification-notificationSorting.md) } | 是 | 是 | 通知排序信息。 | | sortings | { [key: string]: [NotificationSorting](js-apis-inner-notification-notificationSorting.md) } | 是 | 通知排序信息。 |
| sortedHashCode | Array<string> | 是 | 是 | 通知排序的HashCode。 | | sortedHashCode | Array<string> | 是 | 通知排序的HashCode。 |
zh-cn/application-dev/reference/apis/js-apis-inner-notification-notificationSubscribeInfo.md
浏览文件 @ 884002ba
...@@ -6,11 +6,13 @@ ...@@ -6,11 +6,13 @@
> >
> 本模块首批接口从API version 7开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。 > 本模块首批接口从API version 7开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。
## NotificationSubscribeInfo
**系统能力**：以下各项对应的系统能力均为SystemCapability.Notification.Notification **系统能力**：以下各项对应的系统能力均为SystemCapability.Notification.Notification
**系统接口**: 以下为系统接口，三方应用不支持调用。 **系统接口**: 以下为系统接口，三方应用不支持调用。
| 名称 | 类型 | 只读 | 必填 | 说明 | | 名称 | 类型 | 必填 | 说明 |
| -------------------- | --------------------- | ---- | --- | ------------------------------------------ | | -------------------- | --------------------- | --- | ------------------------------------------ |
| bundleNames | Array<string> | 否 | 否 | 应用Bundle名称。 | | bundleNames | Array<string> | 否 | 应用Bundle名称。 |
| userId | number | 否 | 否 | 用户ID。 | | userId | number | 否 | 用户ID。 |
zh-cn/application-dev/reference/apis/js-apis-inner-notification-notificationSubscriber.md
浏览文件 @ 884002ba
...@@ -367,9 +367,9 @@ notificationSubscribe.subscribe(subscriber, subscribeCallback); ...@@ -367,9 +367,9 @@ notificationSubscribe.subscribe(subscriber, subscribeCallback);
**系统API**：此接口为系统接口，三方应用不支持调用。 **系统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) | 是 | 否 | 通知排序信息。 | | sortingMap | [NotificationSortingMap](js-apis-inner-notification-notificationSortingMap.md) | 是 | 否 | 通知排序信息。 |
| reason | number | 是 | 否 | 删除原因。 | | reason | number | 是 | 否 | 删除原因。 |
| sound | string | 是 | 否 | 通知声音。 | | sound | string | 是 | 否 | 通知声音。 |
...@@ -382,11 +382,11 @@ notificationSubscribe.subscribe(subscriber, subscribeCallback); ...@@ -382,11 +382,11 @@ notificationSubscribe.subscribe(subscriber, subscribeCallback);
**系统API**：此接口为系统接口，三方应用不支持调用。 **系统API**：此接口为系统接口，三方应用不支持调用。
| 名称 | 类型 | 只读 | 必传 | 说明 | | 名称 | 类型 | 可读 | 可写 | 说明 |
| ------ | ------- | ---- | --- | ---------------- | | ------ | ------- | ---- | --- | ---------------- |
| bundle | string | 是 | 是 | 应用的包名。 | | bundle | string | 是 | 否 | 应用的包名。 |
| uid | number | 是 | 是 | 应用的uid。 | | uid | number | 是 | 否 | 应用的uid。 |
| enable | boolean | 是 | 是 | 应用通知使能状态。 | | enable | boolean | 是 | 否 | 应用通知使能状态。 |
## BadgeNumberCallbackData<sup>10+</sup> ## BadgeNumberCallbackData<sup>10+</sup>
...@@ -395,9 +395,9 @@ notificationSubscribe.subscribe(subscriber, subscribeCallback); ...@@ -395,9 +395,9 @@ notificationSubscribe.subscribe(subscriber, subscribeCallback);
**系统API**：此接口为系统接口，三方应用不支持调用。 **系统API**：此接口为系统接口，三方应用不支持调用。
| 名称 | 类型 | 只读 | 必传 | 描述 | | 名称 | 类型 | 可读 | 可写 | 描述 |
| ----------- | ------ | ---- | ---- | ------------ | | ----------- | ------ | ---- | ---- | ------------ |
| bundle | string | 是 | 是 | 应用的包名。 | | bundle | string | 是 | 否 | 应用的包名。 |
| uid | number | 是 | 是 | 应用的uid。 | | uid | number | 是 | 否 | 应用的uid。 |
| badgeNumber | number | 是 | 是 | 角标个数。 | | badgeNumber | number | 是 | 否 | 角标个数。 |
zh-cn/application-dev/reference/apis/js-apis-inner-notification-notificationTemplate.md
浏览文件 @ 884002ba
...@@ -6,9 +6,11 @@ ...@@ -6,9 +6,11 @@
> >
> 本模块首批接口从API version 8开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。 > 本模块首批接口从API version 8开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。
# NotificationTemplate
**系统能力**：以下各项对应的系统能力均为SystemCapability.Notification.Notification **系统能力**：以下各项对应的系统能力均为SystemCapability.Notification.Notification
| 名称 | 类型 | 只读 | 必填 | 说明 | | 名称 | 类型 | 必填 | 说明 |
| ---- | ---------------------- | ---- | ---- | ---------- | | ---- | ---------------------- | ---- | ---------- |
| name | string | 否 | 是 | 模板名称。 | | name | string | 是 | 模板名称。 |
| data | {[key:string]: Object} | 否 | 是 | 模板数据。 | | data | {[key:string]: Object} | 是 | 模板数据。 |
zh-cn/application-dev/reference/apis/js-apis-inner-notification-notificationUserInput.md
浏览文件 @ 884002ba
...@@ -6,8 +6,10 @@ ...@@ -6,8 +6,10 @@
> >
> 本模块首批接口从API version 8开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。 > 本模块首批接口从API version 8开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。
## NotificationUserInput
**系统能力**：SystemCapability.Notification.Notification **系统能力**：SystemCapability.Notification.Notification
| 名称 | 类型 | 只读 | 必填 | 说明 | | 名称 | 类型 | 必填 | 说明 |
| -------- | ------ | --- | ---- | ----------------------------- | | -------- | ------ | ---- | ----------------------------- |
| inputKey | string | 否 | 是 | 用户输入时用于标识此输入的key。 | | inputKey | string | 是 | 用户输入时用于标识此输入的key。 |
zh-cn/application-dev/reference/apis/js-apis-notification.md
浏览文件 @ 884002ba
...@@ -1460,7 +1460,7 @@ remove(bundle: BundleOption, notificationKey: NotificationKey, reason: RemoveRea ...@@ -1460,7 +1460,7 @@ remove(bundle: BundleOption, notificationKey: NotificationKey, reason: RemoveRea
| --------------- | ----------------------------------| ---- | -------------------- | | --------------- | ----------------------------------| ---- | -------------------- |
| bundle | [BundleOption](#bundleoption) | 是 | 指定应用的包信息。 | | bundle | [BundleOption](#bundleoption) | 是 | 指定应用的包信息。 |
| notificationKey | [NotificationKey](#notificationkeydeprecated) | 是 | 通知键值。 | | notificationKey | [NotificationKey](#notificationkeydeprecated) | 是 | 通知键值。 |
| reason | [RemoveReason](#removereason9) | 是 | 通知删除原因。 | | reason | [RemoveReason](#removereason-deprecated) | 是 | 通知删除原因。 |
| callback | AsyncCallback\<void\> | 是 | 删除指定通知回调函数。 | | callback | AsyncCallback\<void\> | 是 | 删除指定通知回调函数。 |
**示例：** **示例：**
...@@ -1502,7 +1502,7 @@ remove(bundle: BundleOption, notificationKey: NotificationKey, reason: RemoveRea ...@@ -1502,7 +1502,7 @@ remove(bundle: BundleOption, notificationKey: NotificationKey, reason: RemoveRea
| --------------- | --------------- | ---- | ---------- | | --------------- | --------------- | ---- | ---------- |
| bundle | [BundleOption](#bundleoption) | 是 | 指定应用的包信息。 | | bundle | [BundleOption](#bundleoption) | 是 | 指定应用的包信息。 |
| notificationKey | [NotificationKey](#notificationkeydeprecated) | 是 | 通知键值。 | | notificationKey | [NotificationKey](#notificationkeydeprecated) | 是 | 通知键值。 |
| reason | [RemoveReason](#removereason9) | 是 | 通知删除原因。 | | reason | [RemoveReason](#removereason-deprecated) | 是 | 通知删除原因。 |
**示例：** **示例：**
...@@ -1537,7 +1537,7 @@ remove(hashCode: string, reason: RemoveReason, callback: AsyncCallback\<void\>): ...@@ -1537,7 +1537,7 @@ remove(hashCode: string, reason: RemoveReason, callback: AsyncCallback\<void\>):
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | --------------------- | ---- | -------------------- | | -------- | --------------------- | ---- | -------------------- |
| hashCode | string | 是 | 通知唯一ID。可以通过[onConsume](js-apis-inner-notification-notificationSubscriber.md#onconsume)回调的入参[SubscribeCallbackData](#subscribecallbackdata)获取其内部[NotificationRequest](#notificationrequest)对象中的hashCode。 | | 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\<void\> | 是 | 删除指定通知回调函数。 | | callback | AsyncCallback\<void\> | 是 | 删除指定通知回调函数。 |
**示例：** **示例：**
...@@ -1573,7 +1573,7 @@ remove(hashCode: string, reason: RemoveReason): Promise\<void\> ...@@ -1573,7 +1573,7 @@ remove(hashCode: string, reason: RemoveReason): Promise\<void\>
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | ---------- | ---- | ---------- | | -------- | ---------- | ---- | ---------- |
| hashCode | string | 是 | 通知唯一ID。 | | hashCode | string | 是 | 通知唯一ID。 |
| reason | [RemoveReason](#removereason9) | 是 | 通知删除原因。 | | reason | [RemoveReason](#removereason-deprecated) | 是 | 通知删除原因。 |
**示例：** **示例：**
...@@ -2869,10 +2869,10 @@ Notification.getDeviceRemindType().then((data) => { ...@@ -2869,10 +2869,10 @@ Notification.getDeviceRemindType().then((data) => {
> **说明：** > **说明：**
> 从 API version 7开始支持，从API version 9开始废弃。建议使用[notificationManager.BundleOption](js-apis-inner-notification-notificationCommonDef.md#bundleoption)替代 > 从 API version 7开始支持，从API version 9开始废弃。建议使用[notificationManager.BundleOption](js-apis-inner-notification-notificationCommonDef.md#bundleoption)替代
| 名称 | 类型 | 只读 | 必填 | 说明 | | 名称 | 类型 | 必填 | 说明 |
| ------ | ------ |---- | --- | ------ | | ------ | ------ | --- | ------ |
| bundle | string | 否 | 是 | 应用的包信息。 | | bundle | string | 是 | 应用的包信息。 |
| uid | number | 否 | 否 | 用户ID。 | | uid | number | 否 | 用户ID。 |
## NotificationKey<sup>deprecated</sup> ## NotificationKey<sup>deprecated</sup>
...@@ -3055,7 +3055,7 @@ Notification.getDeviceRemindType().then((data) => { ...@@ -3055,7 +3055,7 @@ Notification.getDeviceRemindType().then((data) => {
| classification | string | 是 | 是 | 通知分类。<br>**系统API**: 此接口为系统接口，三方应用不支持调用。 | | classification | string | 是 | 是 | 通知分类。<br>**系统API**: 此接口为系统接口，三方应用不支持调用。 |
| groupName<sup>8+</sup>| string | 是 | 是 | 组通知名称。 | | groupName<sup>8+</sup>| string | 是 | 是 | 组通知名称。 |
| template<sup>8+</sup> | [NotificationTemplate](#notificationtemplate8) | 是 | 是 | 通知模板。 | | template<sup>8+</sup> | [NotificationTemplate](#notificationtemplate8) | 是 | 是 | 通知模板。 |
| isRemoveAllowed<sup>8+</sup> | boolean | 是 | 否 | 通知是否能被移除。<br>**系统API**: 此接口为系统接口，三方应用不支持调用。 | | isRemoveAllowed<sup>10+</sup> | boolean | 是 | 否 | 通知是否能被移除。<br>**系统API**: 此接口为系统接口，三方应用不支持调用。 |
| source<sup>8+</sup> | number | 是 | 否 | 通知源。<br>**系统API**: 此接口为系统接口，三方应用不支持调用。 | | source<sup>8+</sup> | number | 是 | 否 | 通知源。<br>**系统API**: 此接口为系统接口，三方应用不支持调用。 |
| distributedOption<sup>8+</sup> | [DistributedOptions](#distributedoptions8) | 是 | 是 | 分布式通知的选项。 | | distributedOption<sup>8+</sup> | [DistributedOptions](#distributedoptions8) | 是 | 是 | 分布式通知的选项。 |
| deviceId<sup>8+</sup> | string | 是 | 否 | 通知源的deviceId。<br>**系统API**: 此接口为系统接口，三方应用不支持调用。 | | deviceId<sup>8+</sup> | string | 是 | 否 | 通知源的deviceId。<br>**系统API**: 此接口为系统接口，三方应用不支持调用。 |
...@@ -3197,16 +3197,16 @@ Notification.getDeviceRemindType().then((data) => { ...@@ -3197,16 +3197,16 @@ Notification.getDeviceRemindType().then((data) => {
| TYPE_CONTINUOUS | 1 | 连续通知。 | | TYPE_CONTINUOUS | 1 | 连续通知。 |
| TYPE_TIMER | 2 | 计划通知。 | | TYPE_TIMER | 2 | 计划通知。 |
## RemoveReason<sup>9+</sup> <sup>deprecated</sup> ## RemoveReason <sup>deprecated</sup>
**系统能力**：SystemCapability.Notification.Notification **系统能力**：SystemCapability.Notification.Notification
**系统API**: 此接口为系统接口，三方应用不支持调用。 **系统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_REMOVE<sup>9+</sup> | 1 | 点击通知后删除通知。 | | CLICK_REASON_REMOVE | 1 | 点击通知后删除通知。 |
| CANCEL_REASON_REMOVE<sup>9+</sup> | 2 | 用户删除通知。 | | CANCEL_REASON_REMOVE | 2 | 用户删除通知。 |
\ No newline at end of file \ No newline at end of file
zh-cn/application-dev/reference/apis/js-apis-notificationManager.md
浏览文件 @ 884002ba
...@@ -100,7 +100,7 @@ publish(request: NotificationRequest): Promise\<void\> ...@@ -100,7 +100,7 @@ publish(request: NotificationRequest): Promise\<void\>
```ts ```ts
// 通知Request对象 // 通知Request对象
let notificationRequest: notificationManager.NotificationRequest = { let notificationRequest: notificationManager.NotificationRequest = {
notificationId: 1, id: 1,
content: { content: {
contentType: notificationManager.ContentType.NOTIFICATION_CONTENT_BASIC_TEXT, contentType: notificationManager.ContentType.NOTIFICATION_CONTENT_BASIC_TEXT,
normal: { normal: {
...@@ -217,7 +217,7 @@ publish(request: NotificationRequest, userId: number): Promise\<void\> ...@@ -217,7 +217,7 @@ publish(request: NotificationRequest, userId: number): Promise\<void\>
```ts ```ts
let notificationRequest: notificationManager.NotificationRequest = { let notificationRequest: notificationManager.NotificationRequest = {
notificationId: 1, id: 1,
content: { content: {
contentType: notificationManager.ContentType.NOTIFICATION_CONTENT_BASIC_TEXT, contentType: notificationManager.ContentType.NOTIFICATION_CONTENT_BASIC_TEXT,
normal: { normal: {
...@@ -3947,11 +3947,11 @@ try{ ...@@ -3947,11 +3947,11 @@ try{
**系统API**：此接口为系统接口，三方应用不支持调用。 **系统API**：此接口为系统接口，三方应用不支持调用。
| 名称 | 类型 | 可读 | 可写 | 必填 | 说明 | | 名称 | 类型 | 必填 | 说明 |
| ----- | ------------------------------------- | ---- | ---- | ---- | ---------------------- | | ----- | ------------------------------------- | ---- | ---------------------- |
| type | [DoNotDisturbType](#donotdisturbtype) | 是 | 是 | 是 | 免打扰设置的时间类型。 | | type | [DoNotDisturbType](#donotdisturbtype) | 是 | 免打扰设置的时间类型。 |
| begin | Date | 是 | 是 | 是 | 免打扰设置的起点时间。 | | begin | Date | 是 | 免打扰设置的起点时间。 |
| end | Date | 是 | 是 | 是 | 免打扰设置的终点时间。 | | end | Date | 是 | 免打扰设置的终点时间。 |
## DoNotDisturbType ## DoNotDisturbType
...@@ -4041,11 +4041,11 @@ try{ ...@@ -4041,11 +4041,11 @@ try{
**需要权限**：ohos.permission.NOTIFICATION_CONTROLLER 和 ohos.permission.NOTIFICATION_AGENT_CONTROLLER **需要权限**：ohos.permission.NOTIFICATION_CONTROLLER 和 ohos.permission.NOTIFICATION_AGENT_CONTROLLER
| 名称 | 类型 | 可读 | 可写 | 必填 | 说明 | | 名称 | 类型 | 必填 | 说明 |
| ----- | ------------------------------------- | ---- | ---- | ---------------------- | ---------------------- | | ----- | ------------------------------------- | --- | ---------------------- |
| bundleName | string | 是 | 是 | 是 | bundle名称。 | | bundleName | string | 是 | bundle名称。 |
| notificationId | number | 是 | 是 | 是 | 通知Id。 | | notificationId | number | 是 | 通知Id。 |
| contentType | [ContentType](#contenttype) | 是 | 是 | 是 | 通知类型。 | | contentType | [ContentType](#contenttype) | 是 | 通知类型。 |
## NotificationCheckResult<sup>10+</sup> ## NotificationCheckResult<sup>10+</sup>
...@@ -4055,7 +4055,7 @@ try{ ...@@ -4055,7 +4055,7 @@ try{
**需要权限**：ohos.permission.NOTIFICATION_CONTROLLER 和 ohos.permission.NOTIFICATION_AGENT_CONTROLLER **需要权限**：ohos.permission.NOTIFICATION_CONTROLLER 和 ohos.permission.NOTIFICATION_AGENT_CONTROLLER
| 名称 | 类型 | 可读 | | 必填 | 说明 | | 名称 | 类型 | 必填 | 说明 |
| ----- | ------------------------------------- | ---- | ---- | ---------------------- | ---------------------- | | ------- | ------------------------------------ | ---- | ---------------------- |
| code | number | 是 | 是 | 是 | 0-display, 1-no display。 | | code | number | 是 | 0-display, 1-no display。 |
| message | string | 是 | 是 | 是 | 结果信息。 | | message | string | 是 | 结果信息。 |
zh-cn/application-dev/reference/apis/js-apis-notificationSubscribe.md
浏览文件 @ 884002ba
...@@ -667,10 +667,10 @@ notificationSubscribe.removeAll(userId, removeAllCallback); ...@@ -667,10 +667,10 @@ notificationSubscribe.removeAll(userId, removeAllCallback);
**系统API**: 此接口为系统接口，三方应用不支持调用。 **系统API**: 此接口为系统接口，三方应用不支持调用。
| 名称 | 类型 | 可读 | | 必填 | 说明 | | 名称 | 类型 | 必填 | 说明 |
| ----- | ------ | ---- | --- | -------- | -------- | | ----- | ------ | --- | -------- |
| id | number | 是 | 是 | 是 | 通知ID。 | | id | number | 是 | 通知ID。 |
| label | string | 是 | 是 | 否 | 通知标签。 | | label | string | 否 | 通知标签。 |
## RemoveReason ## RemoveReason
......
Markdown is supported
0% 或 .
You are about to add 0 people to the discussion. Proceed with caution.
先完成此消息的编辑！
想要评论请 注册 或