鸿蒙开发接口公共事件与通知:【@ohos.events.emitter (Emitter)】
Emitter
导入模块
import emitter from '@ohos.events.emitter'
权限列表
无
开发前请熟悉鸿蒙开发指导文档:[gitee.com/li-shizhen-skin/harmony-os/blob/master/README.md
]
EventPriority
用于表示事件被投递的优先级。
系统能力: 以下各项对应的系统能力均为 SystemCapability.Notification.Emitter
名称 |
值 |
说明 |
---|---|---|
IMMEDIATE |
0 |
表示事件被立即投递。 |
HIGH |
1 |
表示事件先于LOW优先级投递。 |
LOW |
2 |
表示事件优于IDLE优先级投递,事件的默认优先级是LOW。 |
IDLE |
3 |
表示在没有其他事件的情况下,才投递该事件。 |
emitter.on
on(event: [InnerEvent], callback: Callback<[EventData]>): void
持续订阅某个事件以及接收事件的回调处理。
系统能力: SystemCapability.Notification.Emitter
参数:
参数名 |
类型 |
必填 |
说明 |
---|---|---|---|
event |
[InnerEvent] |
是 |
持续订阅的事件 |
callback |
Callback<[EventData]> |
是 |
接收订阅事件时的回调处理 |
示例:
var innerEvent = {
eventId: 1
};
var callback = (eventData) = > {
console.info('callback');
};
emitter.on(innerEvent, callback);
emitter.once
once(event: [InnerEvent], callback: Callback<[EventData]>): void
单次订阅某个事件以及接收事件的回调处理,接收到回调处理后自动取消订阅。
系统能力: SystemCapability.Notification.Emitter
参数:
参数名 |
类型 |
必填 |
说明 |
---|---|---|---|
event |
[InnerEvent] |
是 |
单次订阅的事件 |
callback |
Callback<[EventData]> |
是 |
接收订阅事件时的回调处理 |
示例:
var innerEvent = {
eventId: 1
};
var callback = (eventData) = > {
console.info('once callback');
};
emitter.once(innerEvent, callback);
emitter.off
off(eventId: number): void
取消订阅某个事件。
系统能力: SystemCapability.Notification.Emitter
参数:
参数名 |
类型 |
必填 |
说明 |
---|---|---|---|
eventId |
number |
是 |
事件ID |
示例:
emitter.off(1);
emitter.emit
emit(event: InnerEvent, data?: EventData): void
发送一个事件到事件队列。
系统能力: SystemCapability.Notification.Emitter
参数:
参数名 |
类型 |
必填 |
说明 |
---|---|---|---|
event |
[InnerEvent] |
是 |
发送的事件 |
data |
[EventData] |
否 |
事件携带的数据 |
示例:
var eventData = {
data: {
"content": "c",
"id": 1,
}};var innerEvent = {
eventId: 1,
priority: emitter.EventPriority.HIGH
};
emitter.emit(innerEvent, eventData);
InnerEvent
进程内的事件。
系统能力: 以下各项对应的系统能力均为 SystemCapability.Notification.Emitter
名称 |
参数类型 |
可读 |
可写 |
说明 |
---|---|---|---|---|
eventId |
number |
是 |
是 |
事件的ID,由开发者定义用来辨别事件。 |
priority |
[EventPriority] |
是 |
是 |
事件被投递的优先级。 HarmonyOS与OpenHarmony鸿蒙文档籽料:mau123789是v直接拿
|
EventData
发送事件时传递的数据。
系统能力: 以下各项对应的系统能力均为 SystemCapability.Notification.Emitter
名称 |
参数类型 |
可读 |
可写 |
说明 |
---|---|---|---|---|
data |
[key: string]: any |
是 |
是 |
发送事件时传递的数据,数据类型支持字符串、整型和布尔型。 |
审核编辑 黄宇
- 接口
- 鸿蒙
评论
发布评论请先 登录
相关推荐