From dead3153fc6bd113aecd1694542bd196fb236228 Mon Sep 17 00:00:00 2001 From: xuzhihao Date: Tue, 19 Jul 2022 16:08:00 +0800 Subject: [PATCH] Fix issue of Notification docs Signed-off-by: xuzhihao --- .../reference/apis/js-apis-commonEvent.md | 2 + .../reference/apis/js-apis-notification.md | 162 +++++++++++++++++- 2 files changed, 162 insertions(+), 2 deletions(-) diff --git a/zh-cn/application-dev/reference/apis/js-apis-commonEvent.md b/zh-cn/application-dev/reference/apis/js-apis-commonEvent.md index 496ec17ba4..c3d678537b 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-commonEvent.md +++ b/zh-cn/application-dev/reference/apis/js-apis-commonEvent.md @@ -169,6 +169,8 @@ CommonEvent模块支持的事件类型。名称指的是系统公共事件宏； | COMMON_EVENT_FOUNDATION_READY | usual.event.data.FOUNDATION_READY | ohos.permission.RECEIVER_STARTUP_COMPLETED | 表示foundation已准备好的公共事件的动作。 | | COMMON_EVENT_AIRPLANE_MODE_CHANGED | usual.event.AIRPLANE_MODE | 无 | 表示设备飞行模式已更改的公共事件的动作。 | | COMMON_EVENT_SPLIT_SCREEN8+ | usual.event.SPLIT_SCREEN | ohos.permission.RECEIVER_SPLIT_SCREEN | 表示分屏的公共事件的动作。 | +| COMMON_EVENT_SLOT_CHANGE9+ | usual.event.SLOT_CHANGE | ohos.permission.NOTIFICATION_CONTROLLER | 表示通知通道更新的动作。 | +| COMMON_EVENT_SPN_INFO_CHANGED 9+ | usual.event.SPN_INFO_CHANGED | 无 | 表示spn显示信息已更新的公共事件的动作。 | ## CommonEvent.publish 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 8d95c5db9e..c400b1af67 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-notification.md +++ b/zh-cn/application-dev/reference/apis/js-apis-notification.md @@ -2571,7 +2571,7 @@ Notification.enableDistributedByBundle(bundle, enable, enableDistributedByBundle ## Notification.enableDistributedByBundle8+ -bundleenableDistributedByBundle(bundle: BundleOption, enable: boolean): Promise\ +enableDistributedByBundle(bundle: BundleOption, enable: boolean): Promise\ 根据应用的包设置应用程序是否支持分布式通知（Promise形式）。 @@ -2905,6 +2905,8 @@ enableNotificationSlot(bundle: BundleOption, type: SlotType, enable: boolean, ca **系统API**：此接口为系统接口，三方应用不支持调用。 +**需要权限**：ohos.permission.NOTIFICATION_CONTROLLER + **参数：** | 参数名 | 类型 | 必填 | 说明 | @@ -2931,7 +2933,7 @@ Notification.enableNotificationSlot( ## Notification.enableNotificationSlot 9+ -enableNotificationSlot(bundle: BundleOption, type: SlotType, enable: boolean): Promise +enableNotificationSlot(bundle: BundleOption, type: SlotType, enable: boolean): Promise\ 设定指定类型的渠道使能状态（Promise形式）。 @@ -2939,6 +2941,8 @@ enableNotificationSlot(bundle: BundleOption, type: SlotType, enable: boolean): P **系统API**：此接口为系统接口，三方应用不支持调用。 +**需要权限**：ohos.permission.NOTIFICATION_CONTROLLER + **参数：** | 参数名 | 类型 | 必填 | 说明 | @@ -2969,6 +2973,8 @@ isNotificationSlotEnabled(bundle: BundleOption, type: SlotType, callback: AsyncC **系统API**：此接口为系统接口，三方应用不支持调用。 +**需要权限**：ohos.permission.NOTIFICATION_CONTROLLER + **参数：** | 参数名 | 类型 | 必填 | 说明 | @@ -3001,6 +3007,8 @@ isNotificationSlotEnabled(bundle: BundleOption, type: SlotType): Promise\ | 以Promise形式返回指定类型的渠道使能状态。 | + **示例：** ```js @@ -3020,6 +3034,148 @@ Notification.isNotificationSlotEnabled( }); ``` + +## Notification.setSyncNotificationEnabledForUninstallApp9+ + +setSyncNotificationEnabledForUninstallApp(userId: number, enable: boolean, callback: AsyncCallback\): void + +设置是否将通知同步到未安装应用程序的设备(callback形式)。 + +**系统能力**：SystemCapability.Notification.Notification + +**系统API**：此接口为系统接口，三方应用不支持调用。 + +**需要权限**：ohos.permission.NOTIFICATION_CONTROLLER + +**参数：** + +| 参数名 | 类型 | 必填 | 说明 | +| ------ | ----------------------------- | ---- | -------------- | +| userId | number | 是 | 用户Id。 | +| enable | boolean | 是 | 是否将通知同步到未安装应用程序的设备。true：是。false：否。 | +| callback | AsyncCallback\ | 是 | 设置是否将通知同步到未安装应用程序的设备的回调函数。 | + +**示例：** + +```js +let userId = 100; +let enable = true; + +function setSyncNotificationEnabledForUninstallAppCallback(err) { + console.log('setSyncNotificationEnabledForUninstallAppCallback'); +} + +Notification.setSyncNotificationEnabledForUninstallApp(userId, enable, setSyncNotificationEnabledForUninstallAppCallback); +``` + + +## Notification.setSyncNotificationEnabledForUninstallApp9+ + +setSyncNotificationEnabledForUninstallApp(userId: number, enable: boolean): Promise\ + +设置是否将通知同步到未安装应用程序的设备(Promise形式)。 + +**系统能力**：SystemCapability.Notification.Notification + +**系统API**：此接口为系统接口，三方应用不支持调用。 + +**需要权限**：ohos.permission.NOTIFICATION_CONTROLLER + +**参数：** + +| 参数名 | 类型 | 必填 | 说明 | +| ------ | ----------------------------- | ---- | -------------- | +| userId | number | 是 | 用户Id。 | +| enable | boolean | 是 | 是否将通知同步到未安装应用程序的设备。true：是。false：否。 | + +**示例：** + +```js +let userId = 100; +let enable = true; + +Notification.setSyncNotificationEnabledForUninstallApp(userId, enable) + .then((data) => { + console.log('setSyncNotificationEnabledForUninstallApp, data:', data); + }) + .catch((err) => { + console.log('setSyncNotificationEnabledForUninstallApp, err:', err); + }); +``` + + +## Notification.getSyncNotificationEnabledForUninstallApp9+ + +getSyncNotificationEnabledForUninstallApp(userId: number, callback: AsyncCallback\): void + +获取是否同步通知到未安装应用程序的设备的结果(callback形式)。 + +**系统能力**：SystemCapability.Notification.Notification + +**系统API**：此接口为系统接口，三方应用不支持调用。 + +**需要权限**：ohos.permission.NOTIFICATION_CONTROLLER + +**参数：** + +| 参数名 | 类型 | 必填 | 说明 | +| ------ | ----------------------------- | ---- | -------------- | +| userId | number | 是 | 用户Id。 | +| callback | AsyncCallback\ | 是 | 获取是否同步通知到未安装应用程序的设备的结果的回调函数。true：是。false：否。 | + +**示例：** + +```js +let userId = 100; + +function getSyncNotificationEnabledForUninstallAppCallback(err, data) { + console.log('getSyncNotificationEnabledForUninstallAppCallback, data: ', data); +} + +Notification.getSyncNotificationEnabledForUninstallApp(userId, getSyncNotificationEnabledForUninstallAppCallback); +``` + + +## Notification.getSyncNotificationEnabledForUninstallApp9+ + +getSyncNotificationEnabledForUninstallApp(userId: number): Promise\ + +获取是否同步通知到未安装应用程序的设备的结果(Promise形式)。 + +**系统能力**：SystemCapability.Notification.Notification + +**系统API**：此接口为系统接口，三方应用不支持调用。 + +**需要权限**：ohos.permission.NOTIFICATION_CONTROLLER + +**参数：** + +| 参数名 | 类型 | 必填 | 说明 | +| ------ | ----------------------------- | ---- | -------------- | +| userId | number | 是 | 用户Id。 | + +**返回值：** + +| 类型 | 说明 | +| ----------------------------------------------------------- | ------------------------------------------------------------ | +| Promise\ | 以Promise形式返回获取是否同步通知到未安装应用程序的设备的结果。true：是。false：否。 | + +**示例：** + +```js +let userId = 100; + +Notification.getSyncNotificationEnabledForUninstallApp(userId) + .then((data) => { + console.log('getSyncNotificationEnabledForUninstallApp, data: ', data); + }) + .catch((err) => { + console.log('getSyncNotificationEnabledForUninstallApp, err: ', err); + }); +``` + + + ## NotificationSubscriber **系统API**：此接口为系统接口，三方应用不支持调用。 @@ -3582,6 +3738,8 @@ Notification.subscribe(subscriber, subscribeCallback); | distributedOption8+ | 是 | 是 | [DistributedOptions](#distributedoptions8) | 否 | 分布式通知的选项。 | | deviceId8+ | 是 | 否 | string | 否 | 通知源的deviceId。
**系统API**: 此接口为系统接口，三方应用不支持调用。 | | notificationFlags8+ | 是 | 否 | [NotificationFlags](#notificationflags8) | 否 | 获取NotificationFlags。 | +| removalWantAgent9+ | 是 | 是 | WantAgent | 否 | 当移除通知时，通知将被重定向到的WantAgent实例。 | +| badgeNumber9+ | 是 | 是 | number | 否 | 应用程序图标上显示的通知数。 | ## DistributedOptions8+ -- GitLab