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

!1209 modify emitter relative_install_dir

Merge pull request !1209 from zengsiyu/master
# Emitter
> 说明:本模块首批接口从API version 7开始支持。
## 导入模块
```javascript
import emitter from '@ohos.events.emitter'
```
## 权限列表
## EventPriority
用于表示事件被投递的优先级。
| 名称 | 值 | 说明 |
| --------- | ---- | ------------------------------------------------- |
| IMMEDIATE | 0 | 表示事件被立即投递 |
| HIGH | 1 | 表示事件先于LOW优先级投递 |
| LOW | 2 | 表示事件优于IDLE优先级投递,事件的默认优先级是LOW |
| IDLE | 3 | 表示在没有其他事件的情况下,才投递该事件 |
## emitter.on
on(event: [InnerEvent](#InnerEvent), callback: Callback\<[EventData](#EventData)\>): void
持续订阅某个事件以及接收事件的回调处理。
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ----------------------------------- | ---- | ------------------------ |
| event | [InnerEvent](#InnerEvent) | 是 | 持续订阅的事件 |
| callback | Callback\<[EventData](#EventData)\> | 是 | 接收订阅事件时的回调处理 |
**示例:**
```javascript
var innerEvent = {
eventId : 1
};
var callback = (eventData) => {
console.info('callback');
};
emitter.on(innerEvent, callback);
```
## emitter.once
once(event: [InnerEvent](#InnerEvent), callback: Callback\<[EventData](#EventData)\>): void
单次订阅某个事件以及接收事件的回调处理,接收到回调处理后自动取消订阅。
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ----------------------------------- | ---- | ------------------------ |
| event | [InnerEvent](#InnerEvent) | 是 | 单次订阅的事件 |
| callback | Callback\<[EventData](#EventData)\> | 是 | 接收订阅事件时的回调处理 |
**示例:**
```javascript
var innerEvent = {
eventId : 1
};
var callback = (eventData) => {
console.info('once callback');
};
emitter.once(innerEvent, callback);
```
## emitter.off
off(eventId: number): void
取消订阅某个事件。
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| ------- | ------ | ---- | -------------- |
| eventId | number | 是 | 单次订阅的事件 |
**示例:**
```javascript
emitter.off(1);
```
## emitter.emit
emit(event: InnerEvent, data?: EventData): void
发送一个事件到事件队列。
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| ------ | ------------------------- | ---- | -------------- |
| event | [InnerEvent](#InnerEvent) | 是 | 发送的事件 |
| data | [EventData](#EventData) | 否 | 事件携带的数据 |
**示例:**
```javascript
var eventData = {
data: {
1:"t",
'content':"c",
"id":1,
}};
var innerEvent = {
eventId : 1,
priority: emitter.EventPriority.HIGH
};
emitter.emit(innerEvent, eventData);
```
## InnerEvent
进程内的事件。
### 属性
| 名称 | 参数类型 | 可读 | 可写 | 说明 |
| -------- | ------------------------------- | ---- | ---- | ---------------------------------- |
| eventId | number | 是 | 是 | 事件的ID,由开发者定义用来辨别事件 |
| priority | [EventPriority](#EventPriority) | 是 | 是 | 事件被投递的优先级 |
## EventData
发送事件时传递的数据。
### 属性
| 名称 | 参数类型 | 可读 | 可写 | 说明 |
| ---- | ------------------ | ---- | ---- | -------------- |
| data | [key: string]: any | 是 | 是 | 事件携带的数据 |
Markdown is supported
0% .
You are about to add 0 people to the discussion. Proceed with caution.
先完成此消息的编辑!
想要评论请 注册