未验证 提交 8739efbd 编写于 作者: O openharmony_ci 提交者: Gitee

!21017 事件通知资料仓一致性整改

Merge pull request !21017 from xuzhihao/master
......@@ -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 |
| callback<sup>10+</sup> | 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.off<sup>10+<sup>
off(eventId: number,callback: Callback\<[EventData](#eventdata)\>): void
取消针对该事件ID的订阅,传入可选参数callback,并且该callback已经通过on或者once接口订阅,则取消该订阅;否则,不做任何处理。
**系统能力**: `SystemCapability.Notification.Emitter`
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| ------- | ------ | ---- | ------ |
| eventId | number | 是 | 事件ID |
| callback<sup>10+</sup> | Callback\<[EventData](#eventdata)\> | 是 | API version 10 新增取消该事件的回调处理函数。 |
**示例:**
```javascript
// 取消eventID为1的事件回调处理函数 emitterCallback
// 如果该回调处理函数没有被订阅,则不做任何处理
......
......@@ -6,6 +6,8 @@
>
> 本模块首批接口从API version 7开始支持。后续版本的新增接口,采用上角标单独标记接口的起始版本。
## 属性
**系统能力:** 以下各项对应的系统能力均为SystemCapability.Notification.CommonEvent
| 名称 | 类型 | 可读 | 可写 | 说明 |
......
......@@ -6,6 +6,8 @@
>
> 本模块首批接口从API version 7开始支持。后续版本的新增接口,采用上角标单独标记接口的起始版本。
## 属性
**系统能力:** 以下各项对应的系统能力均为SystemCapability.Notification.CommonEvent
| 名称 | 类型 | 可读 | 可写 | 说明 |
......
......@@ -4,6 +4,8 @@
>
> 本模块首批接口从API version 7开始支持。后续版本的新增接口,采用上角标单独标记接口的起始版本。
## 属性
**系统能力:** `SystemCapability.Notification.CommonEvent`
| 名称 | 类型 | 可读 | 可写 | 说明 |
......
......@@ -6,6 +6,8 @@
>
> 本模块首批接口从API version 7开始支持。后续版本的新增接口,采用上角标单独标记接口的起始版本。
## 属性
**系统能力:** 以下各项对应的系统能力均为SystemCapability.Notification.Notification
| 名称 | 类型 | 只读 | 必填 | 说明 |
......
......@@ -35,14 +35,14 @@
| smallIcon | [image.PixelMap](js-apis-image.md#pixelmap7) | 否 | 通知小图标。可选字段,大小不超过30KB。 |
| largeIcon | [image.PixelMap](js-apis-image.md#pixelmap7) | 否 | 通知大图标。可选字段,大小不超过30KB。 |
| creatorBundleName | string | 否 | 创建通知的包名。 |
| creatorUid<sup>8+<sup> | number | 否 | 创建通知的UID。 |
| creatorUid | number | 否 | 创建通知的UID。 |
| creatorPid | number | 否 | 创建通知的PID。 |
| creatorUserId | number | 否 | 创建通知的UserId。 |
| creatorUserId<sup>8+<sup> | number | 否 | 创建通知的UserId。 |
| hashCode | string | 否 | 通知唯一标识。 |
| classification | string | 否 | 通知分类。<br>**系统API**: 此接口为系统接口,三方应用不支持调用。 |
| groupName<sup>8+<sup> | string | 否 | 组通知名称。 |
| template<sup>8+<sup> | [NotificationTemplate](./js-apis-inner-notification-notificationTemplate.md) | 否 | 通知模板。 |
| isRemoveAllowed<sup>8+<sup> | boolean | 否 | 通知是否能被移除。<br>**系统API**: 此接口为系统接口,三方应用不支持调用。 |
| isRemoveAllowed<sup>10+<sup> | boolean | 否 | 通知是否能被移除。<br>**系统API**: 此接口为系统接口,三方应用不支持调用。 |
| source<sup>8+<sup> | number | 否 | 通知源。<br>**系统API**: 此接口为系统接口,三方应用不支持调用。 |
| distributedOption<sup>8+<sup> | [DistributedOptions](#distributedoptions) | 否 | 分布式通知的选项。 |
| deviceId<sup>8+<sup> | string | 否 | 通知源的deviceId。<br>**系统API**: 此接口为系统接口,三方应用不支持调用。 |
......
......@@ -6,7 +6,7 @@
>
> 本模块首批接口从API version 7开始支持。后续版本的新增接口,采用上角标单独标记接口的起始版本。
# NotificationSorting
## 属性
**系统能力**:以下各项对应的系统能力均为SystemCapability.Notification.Notification
......
......@@ -6,7 +6,7 @@
>
> 本模块首批接口从API version 7开始支持。后续版本的新增接口,采用上角标单独标记接口的起始版本。
# NotificationSortingMap
## 属性
**系统能力**:以下各项对应的系统能力均为SystemCapability.Notification.Notification
......
......@@ -395,7 +395,7 @@ notificationSubscribe.subscribe(subscriber, subscribeCallback);
**系统API**:此接口为系统接口,三方应用不支持调用。
| 名称 | 类型 | 可读 | 可写 | 描述 |
| 名称 | 类型 | 可读 | 可写 | 说明 |
| ----------- | ------ | ---- | ---- | ------------ |
| bundle | string | 是 | 否 | 应用的包名。 |
| uid | number | 是 | 否 | 应用的uid。 |
......
......@@ -6,7 +6,7 @@
>
> 本模块首批接口从API version 8开始支持。后续版本的新增接口,采用上角标单独标记接口的起始版本。
# NotificationTemplate
## 属性
**系统能力**:以下各项对应的系统能力均为SystemCapability.Notification.Notification
......
Markdown is supported
0% .
You are about to add 0 people to the discussion. Proceed with caution.
先完成此消息的编辑!
想要评论请 注册