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

!9603 更新emitter文档

Merge pull request !9603 from FangJinliang/pr_0826
...@@ -16,19 +16,6 @@ import emitter from '@ohos.events.emitter' ...@@ -16,19 +16,6 @@ import emitter from '@ohos.events.emitter'
## EventPriority
用于表示事件被投递的优先级。
**系统能力**: 以下各项对应的系统能力均为 SystemCapability.Notification.Emitter
| 名称 | 值 | 说明 |
| --------- | ---- | ------------------------------------------------- |
| IMMEDIATE | 0 | 表示事件被立即投递。 |
| HIGH | 1 | 表示事件先于LOW优先级投递。 |
| LOW | 2 | 表示事件优于IDLE优先级投递,事件的默认优先级是LOW。 |
| IDLE | 3 | 表示在没有其他事件的情况下,才投递该事件。 |
## emitter.on ## emitter.on
on(event: [InnerEvent](#innerevent), callback: Callback\<[EventData](#eventdata)\>): void on(event: [InnerEvent](#innerevent), callback: Callback\<[EventData](#eventdata)\>): void
...@@ -47,13 +34,13 @@ on(event: [InnerEvent](#innerevent), callback: Callback\<[EventData](#eventdata) ...@@ -47,13 +34,13 @@ on(event: [InnerEvent](#innerevent), callback: Callback\<[EventData](#eventdata)
**示例:** **示例:**
```javascript ```javascript
var innerEvent = { let innerEvent = {
eventId: 1 eventId: 1
}; };
var callback = (eventData) => { function EmitterCallback(eventData) {
console.info('callback'); console.info('callback');
}; }
emitter.on(innerEvent, callback); emitter.on(innerEvent, EmitterCallback);
``` ```
## emitter.once ## emitter.once
...@@ -74,13 +61,13 @@ once(event: [InnerEvent](#innerevent), callback: Callback\<[EventData](#eventdat ...@@ -74,13 +61,13 @@ once(event: [InnerEvent](#innerevent), callback: Callback\<[EventData](#eventdat
**示例:** **示例:**
```javascript ```javascript
var innerEvent = { let innerEvent = {
eventId: 1 eventId: 1
}; };
var callback = (eventData) => { function EmitterCallback(eventData) {
console.info('once callback'); console.info('once callback');
}; };
emitter.once(innerEvent, callback); emitter.once(innerEvent, EmitterCallback);
``` ```
## emitter.off ## emitter.off
...@@ -121,18 +108,31 @@ emit(event: InnerEvent, data?: EventData): void ...@@ -121,18 +108,31 @@ emit(event: InnerEvent, data?: EventData): void
**示例:** **示例:**
```javascript ```javascript
var eventData = { let eventData = {
data: { data: {
"content": "c", "content": "c",
"id": 1, "id": 1,
}}; }};
var innerEvent = { let innerEvent = {
eventId: 1, eventId: 1,
priority: emitter.EventPriority.HIGH priority: emitter.EventPriority.HIGH
}; };
emitter.emit(innerEvent, eventData); emitter.emit(innerEvent, eventData);
``` ```
## EventPriority
用于表示事件被投递的优先级。
**系统能力**: 以下各项对应的系统能力均为 SystemCapability.Notification.Emitter
| 名称 | 值 | 说明 |
| --------- | ---- | --------------------------------------------------- |
| IMMEDIATE | 0 | 表示事件被立即投递。 |
| HIGH | 1 | 表示事件先于LOW优先级投递。 |
| LOW | 2 | 表示事件优于IDLE优先级投递,事件的默认优先级是LOW。 |
| IDLE | 3 | 表示在没有其他事件的情况下,才投递该事件。 |
## InnerEvent ## InnerEvent
进程内的事件。 进程内的事件。
......
Markdown is supported
0% .
You are about to add 0 people to the discussion. Proceed with caution.
先完成此消息的编辑!
想要评论请 注册