From b16429bcf98a006244ad7638db5a3acc84bcd561 Mon Sep 17 00:00:00 2001 From: xuzhihao Date: Tue, 18 Jul 2023 14:54:45 +0800 Subject: [PATCH] =?UTF-8?q?BugFix:=20=E4=BF=AE=E5=A4=8D=E8=B5=84=E6=96=99?= =?UTF-8?q?=E4=B8=80=E8=87=B4=E6=80=A7=E9=97=AE=E9=A2=98?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Signed-off-by: xuzhihao --- .../reference/apis/js-apis-emitter.md | 23 +++++++++++++++---- ...-apis-inner-commonEvent-commonEventData.md | 2 ++ ...nner-commonEvent-commonEventPublishData.md | 2 ++ ...er-commonEvent-commonEventSubscribeInfo.md | 2 ++ ...r-notification-notificationActionButton.md | 2 ++ ...-inner-notification-notificationRequest.md | 6 ++--- ...-inner-notification-notificationSorting.md | 2 +- ...ner-notification-notificationSortingMap.md | 2 +- ...ner-notification-notificationSubscriber.md | 2 +- ...inner-notification-notificationTemplate.md | 2 +- 10 files changed, 34 insertions(+), 11 deletions(-) diff --git a/zh-cn/application-dev/reference/apis/js-apis-emitter.md b/zh-cn/application-dev/reference/apis/js-apis-emitter.md index 5de818ecbf..88d4b90c88 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-emitter.md +++ b/zh-cn/application-dev/reference/apis/js-apis-emitter.md @@ -78,10 +78,9 @@ emitter.once(innerEvent, emitterCallback); ## emitter.off -off(eventId: number,callback?: Callback\<[EventData](#eventdata)\>): void +off(eventId: number): void -取消针对该事件ID的订阅。如果不传入可选参数callback,则取消针对该事件ID的所有订阅。 -如果传入可选参数callback,并且该callback已经通过on或者once接口订阅,则取消该订阅;否则,不做任何处理。 +取消针对该事件ID的订阅。 **系统能力**: `SystemCapability.Notification.Emitter` @@ -90,7 +89,6 @@ off(eventId: number,callback?: Callback\<[EventData](#eventdata)\>): void | 参数名 | 类型 | 必填 | 说明 | | ------- | ------ | ---- | ------ | | eventId | number | 是 | 事件ID | -| callback10+ | Callback\<[EventData](#eventdata)\> | 否 | API version 10 新增取消该事件的回调处理函数。该参数可选,不影响API version 9 及更早版本的接口兼容性 | **示例:** @@ -99,6 +97,23 @@ off(eventId: number,callback?: Callback\<[EventData](#eventdata)\>): void emitter.off(1); ``` +## emitter.off10+ + +off(eventId: number,callback: Callback\<[EventData](#eventdata)\>): void + +取消针对该事件ID的订阅,传入可选参数callback,并且该callback已经通过on或者once接口订阅,则取消该订阅;否则,不做任何处理。 + +**系统能力**: `SystemCapability.Notification.Emitter` + +**参数:** + +| 参数名 | 类型 | 必填 | 说明 | +| ------- | ------ | ---- | ------ | +| eventId | number | 是 | 事件ID | +| callback10+ | Callback\<[EventData](#eventdata)\> | 是 | API version 10 新增取消该事件的回调处理函数。 | + +**示例:** + ```javascript // 取消eventID为1的事件回调处理函数 emitterCallback // 如果该回调处理函数没有被订阅,则不做任何处理 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 3b4d46703d..7c9d9b3d0c 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 @@ -6,6 +6,8 @@ > > 本模块首批接口从API version 7开始支持。后续版本的新增接口,采用上角标单独标记接口的起始版本。 +## 属性 + **系统能力:** 以下各项对应的系统能力均为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 97cee6d5e1..faea7e4664 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 @@ -6,6 +6,8 @@ > > 本模块首批接口从API version 7开始支持。后续版本的新增接口,采用上角标单独标记接口的起始版本。 +## 属性 + **系统能力:** 以下各项对应的系统能力均为SystemCapability.Notification.CommonEvent | 名称 | 类型 | 可读 | 可写 | 说明 | diff --git a/zh-cn/application-dev/reference/apis/js-apis-inner-commonEvent-commonEventSubscribeInfo.md b/zh-cn/application-dev/reference/apis/js-apis-inner-commonEvent-commonEventSubscribeInfo.md index 7d9f8bdc53..b9889d4001 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-inner-commonEvent-commonEventSubscribeInfo.md +++ b/zh-cn/application-dev/reference/apis/js-apis-inner-commonEvent-commonEventSubscribeInfo.md @@ -4,6 +4,8 @@ > > 本模块首批接口从API version 7开始支持。后续版本的新增接口,采用上角标单独标记接口的起始版本。 +## 属性 + **系统能力:** `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 c1665c7279..40a2e17669 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,6 +6,8 @@ > > 本模块首批接口从API version 7开始支持。后续版本的新增接口,采用上角标单独标记接口的起始版本。 +## 属性 + **系统能力:** 以下各项对应的系统能力均为SystemCapability.Notification.Notification | 名称 | 类型 | 只读 | 必填 | 说明 | 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 92cdce9726..f7fdc512d9 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 @@ -35,14 +35,14 @@ | smallIcon | [image.PixelMap](js-apis-image.md#pixelmap7) | 否 | 通知小图标。可选字段,大小不超过30KB。 | | largeIcon | [image.PixelMap](js-apis-image.md#pixelmap7) | 否 | 通知大图标。可选字段,大小不超过30KB。 | | creatorBundleName | string | 否 | 创建通知的包名。 | -| creatorUid8+ | number | 否 | 创建通知的UID。 | +| creatorUid | number | 否 | 创建通知的UID。 | | creatorPid | number | 否 | 创建通知的PID。 | -| creatorUserId | number | 否 | 创建通知的UserId。 | +| creatorUserId8+ | number | 否 | 创建通知的UserId。 | | hashCode | string | 否 | 通知唯一标识。 | | classification | string | 否 | 通知分类。
**系统API**: 此接口为系统接口,三方应用不支持调用。 | | groupName8+ | string | 否 | 组通知名称。 | | template8+ | [NotificationTemplate](./js-apis-inner-notification-notificationTemplate.md) | 否 | 通知模板。 | -| isRemoveAllowed8+ | boolean | 否 | 通知是否能被移除。
**系统API**: 此接口为系统接口,三方应用不支持调用。 | +| isRemoveAllowed10+ | boolean | 否 | 通知是否能被移除。
**系统API**: 此接口为系统接口,三方应用不支持调用。 | | source8+ | number | 否 | 通知源。
**系统API**: 此接口为系统接口,三方应用不支持调用。 | | distributedOption8+ | [DistributedOptions](#distributedoptions) | 否 | 分布式通知的选项。 | | deviceId8+ | string | 否 | 通知源的deviceId。
**系统API**: 此接口为系统接口,三方应用不支持调用。 | 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 163138c33f..70dd4d279f 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,7 +6,7 @@ > > 本模块首批接口从API version 7开始支持。后续版本的新增接口,采用上角标单独标记接口的起始版本。 -# NotificationSorting +## 属性 **系统能力**:以下各项对应的系统能力均为SystemCapability.Notification.Notification 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 a754e3aa06..6b81d338f5 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,7 +6,7 @@ > > 本模块首批接口从API version 7开始支持。后续版本的新增接口,采用上角标单独标记接口的起始版本。 -# NotificationSortingMap +## 属性 **系统能力**:以下各项对应的系统能力均为SystemCapability.Notification.Notification 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 e53daa7e49..2cb55dac5c 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 @@ -395,7 +395,7 @@ notificationSubscribe.subscribe(subscriber, subscribeCallback); **系统API**:此接口为系统接口,三方应用不支持调用。 -| 名称 | 类型 | 可读 | 可写 | 描述 | +| 名称 | 类型 | 可读 | 可写 | 说明 | | ----------- | ------ | ---- | ---- | ------------ | | bundle | string | 是 | 否 | 应用的包名。 | | uid | number | 是 | 否 | 应用的uid。 | 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 fc001cf0c7..21ca8d18e7 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,7 +6,7 @@ > > 本模块首批接口从API version 8开始支持。后续版本的新增接口,采用上角标单独标记接口的起始版本。 -# NotificationTemplate +## 属性 **系统能力**:以下各项对应的系统能力均为SystemCapability.Notification.Notification -- GitLab