Emitter


Emitter

本模块提供发送和处理进程内事件的能力,包括对持续订阅事件或单次订阅事件的处理,取消订阅事件,发送事件到事件队列。

说明:

本模块首批接口从API version 7开始支持。

导入模块

import emitter from '@ohos.events.emitter'
1

权限列表

emitter.on

on(event: InnerEvent, callback: Callback<EventData>): void

持续订阅某个事件以及接收事件的回调处理。

系统能力: SystemCapability.Notification.Emitter

参数:

参数名 类型 必填 说明
event InnerEvent 持续订阅的事件,其中EventPriority不生效
callback Callback<EventData> 接收订阅事件时的回调处理

示例:

let innerEvent = {
    eventId: 1
};
function EmitterCallback(eventData) {
    console.info('callback');
}
emitter.on(innerEvent, EmitterCallback);
1
2
3
4
5
6
7

emitter.once

once(event: InnerEvent, callback: Callback<EventData>): void

单次订阅某个事件以及接收事件的回调处理,接收到回调处理后自动取消订阅。

系统能力: SystemCapability.Notification.Emitter

参数:

参数名 类型 必填 说明
event InnerEvent 单次订阅的事件,其中EventPriority不生效
callback Callback<EventData> 接收订阅事件时的回调处理

示例:

let innerEvent = {
    eventId: 1
};
function EmitterCallback(eventData) {
    console.info('once callback');
};
emitter.once(innerEvent, EmitterCallback);
1
2
3
4
5
6
7

emitter.off

off(eventId: number): void

取消订阅某个事件。

系统能力: SystemCapability.Notification.Emitter

参数:

参数名 类型 必填 说明
eventId number 事件ID

示例:

emitter.off(1);
1

emitter.emit

emit(event: InnerEvent, data?: EventData): void

发送一个事件到事件队列。

系统能力: SystemCapability.Notification.Emitter

参数:

参数名 类型 必填 说明
event InnerEvent 发送的事件
data EventData 事件携带的数据

示例:

let eventData = {
    data: {
        "content": "c",
        "id": 1,
    }};
let innerEvent = {
    eventId: 1,
    priority: emitter.EventPriority.HIGH
};
emitter.emit(innerEvent, eventData);
1
2
3
4
5
6
7
8
9
10

EventPriority

用于表示事件被投递的优先级。

系统能力: 以下各项对应的系统能力均为 SystemCapability.Notification.Emitter

名称 说明
IMMEDIATE 0 表示事件被立即投递。
HIGH 1 表示事件先于LOW优先级投递。
LOW 2 表示事件优于IDLE优先级投递,事件的默认优先级是LOW。
IDLE 3 表示在没有其他事件的情况下,才投递该事件。

InnerEvent

进程内的事件。

系统能力: 以下各项对应的系统能力均为 SystemCapability.Notification.Emitter

名称 参数类型 可读 可写 说明
eventId number 事件的ID,由开发者定义用来辨别事件。
priority EventPriority 事件被投递的优先级。

EventData

发送事件时传递的数据。

系统能力: 以下各项对应的系统能力均为 SystemCapability.Notification.Emitter

名称 参数类型 可读 可写 说明
data [key: string]: any 发送事件时传递的数据,数据类型支持字符串、整型和布尔型。