@ohos.events.emitter (Emitter)

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

说明：

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

导入模块

import emitter from '@ohos.events.emitter'

权限列表

无

emitter.on

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

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

系统能力: SystemCapability.Notification.Emitter

参数：

示例：

let innerEvent = {
    eventId: 1
};
function EmitterCallback(eventData) {
    console.info('callback');
}
emitter.on(innerEvent, EmitterCallback);

emitter.once

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

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

系统能力: SystemCapability.Notification.Emitter

参数：

示例：

let innerEvent = {
    eventId: 1
};
function EmitterCallback(eventData) {
    console.info('once callback');
};
emitter.once(innerEvent, EmitterCallback);

emitter.off

off(eventId: number): void

取消订阅某个事件。

系统能力: SystemCapability.Notification.Emitter

参数：

示例：

emitter.off(1);

emitter.emit

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

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

系统能力: SystemCapability.Notification.Emitter

参数：

示例：

let eventData = {
    data: {
        "content": "c",
        "id": 1,
    }};
let innerEvent = {
    eventId: 1,
    priority: emitter.EventPriority.HIGH
};
emitter.emit(innerEvent, eventData);

EventPriority

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

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

InnerEvent

进程内的事件。

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

EventData

发送事件时传递的数据。

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