Skip to content
体验新版
项目
组织
正在加载...
登录
切换导航
打开侧边栏
CDL_LuFei
Docs
提交
c3fbfbf7
D
Docs
项目概览
CDL_LuFei
/
Docs
与 Fork 源项目一致
Fork自
OpenHarmony / Docs
通知
1
Star
0
Fork
0
代码
文件
提交
分支
Tags
贡献者
分支图
Diff
Issue
0
列表
看板
标记
里程碑
合并请求
0
Wiki
0
Wiki
分析
仓库
DevOps
项目成员
Pages
D
Docs
项目概览
项目概览
详情
发布
仓库
仓库
文件
提交
分支
标签
贡献者
分支图
比较
Issue
0
Issue
0
列表
看板
标记
里程碑
合并请求
0
合并请求
0
Pages
分析
分析
仓库分析
DevOps
Wiki
0
Wiki
成员
成员
收起侧边栏
关闭侧边栏
动态
分支图
创建新Issue
提交
Issue看板
体验新版 GitCode,发现更多精彩内容 >>
未验证
提交
c3fbfbf7
编写于
1月 17, 2022
作者:
O
openharmony_ci
提交者:
Gitee
1月 17, 2022
浏览文件
操作
浏览文件
下载
差异文件
!1209 modify emitter relative_install_dir
Merge pull request !1209 from zengsiyu/master
上级
bfd6ee38
f1e1e818
变更
1
显示空白变更内容
内联
并排
Showing
1 changed file
with
142 addition
and
0 deletion
+142
-0
zh-cn/application-dev/reference/apis/js-apis-emitter.md
zh-cn/application-dev/reference/apis/js-apis-emitter.md
+142
-0
未找到文件。
zh-cn/application-dev/reference/apis/js-apis-emitter.md
0 → 100644
浏览文件 @
c3fbfbf7
# 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.
先完成此消息的编辑!
取消
想要评论请
注册
或
登录