Emitter

說明：本模塊首批接口從API version 7開始支持。

導(dǎo)入模塊

import emitter from '@ohos.events.emitter'

權(quán)限列表

無

開發(fā)前請熟悉鴻蒙開發(fā)指導(dǎo)文檔 ：[gitee.com/li-shizhen-skin/harmony-os/blob/master/README.md]

EventPriority

用于表示事件被投遞的優(yōu)先級。

系統(tǒng)能力 : 以下各項對應(yīng)的系統(tǒng)能力均為 SystemCapability.Notification.Emitter

名稱	值	說明
IMMEDIATE	0	表示事件被立即投遞。
HIGH	1	表示事件先于LOW優(yōu)先級投遞。
LOW	2	表示事件優(yōu)于IDLE優(yōu)先級投遞，事件的默認(rèn)優(yōu)先級是LOW。
IDLE	3	表示在沒有其他事件的情況下，才投遞該事件。

emitter.on

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

持續(xù)訂閱某個事件以及接收事件的回調(diào)處理。

系統(tǒng)能力 : SystemCapability.Notification.Emitter

參數(shù)：

參數(shù)名	類型	必填	說明
event	[InnerEvent]	是	持續(xù)訂閱的事件
callback	Callback<[EventData]>	是	接收訂閱事件時的回調(diào)處理

示例：

var innerEvent = {
    eventId: 1
};
var callback = (eventData) = > {
    console.info('callback');
};
emitter.on(innerEvent, callback);

emitter.once

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

單次訂閱某個事件以及接收事件的回調(diào)處理，接收到回調(diào)處理后自動取消訂閱。

系統(tǒng)能力 : SystemCapability.Notification.Emitter

參數(shù)：

參數(shù)名	類型	必填	說明
event	[InnerEvent]	是	單次訂閱的事件
callback	Callback<[EventData]>	是	接收訂閱事件時的回調(diào)處理

示例：

var innerEvent = {
    eventId: 1
};
var callback = (eventData) = > {
    console.info('once callback');
};
emitter.once(innerEvent, callback);

emitter.off

off(eventId: number): void

取消訂閱某個事件。

系統(tǒng)能力 : SystemCapability.Notification.Emitter

參數(shù)：

參數(shù)名	類型	必填	說明
eventId	number	是	事件ID

示例：

emitter.off(1);

emitter.emit

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

發(fā)送一個事件到事件隊列。

系統(tǒng)能力 : SystemCapability.Notification.Emitter

參數(shù)：

參數(shù)名	類型	必填	說明
event	[InnerEvent]	是	發(fā)送的事件
data	[EventData]	否	事件攜帶的數(shù)據(jù)

示例：

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

InnerEvent

進(jìn)程內(nèi)的事件。

系統(tǒng)能力 : 以下各項對應(yīng)的系統(tǒng)能力均為 SystemCapability.Notification.Emitter

名稱	參數(shù)類型	可讀	可寫	說明
eventId	number	是	是	事件的ID，由開發(fā)者定義用來辨別事件。
priority	[EventPriority]	是	是	事件被投遞的優(yōu)先級。`HarmonyOS與OpenHarmony鴻蒙文檔籽料：mau123789是v直接拿`

搜狗高速瀏覽器截圖20240326151450.png

EventData

發(fā)送事件時傳遞的數(shù)據(jù)。

系統(tǒng)能力 : 以下各項對應(yīng)的系統(tǒng)能力均為 SystemCapability.Notification.Emitter

名稱	參數(shù)類型	可讀	可寫	說明
data	[key: string]: any	是	是	發(fā)送事件時傳遞的數(shù)據(jù)，數(shù)據(jù)類型支持字符串、整型和布爾型。

審核編輯黃宇

聲明：本文內(nèi)容及配圖由入駐作者撰寫或者入駐合作網(wǎng)站授權(quán)轉(zhuǎn)載。文章觀點僅代表作者本人，不代表電子發(fā)燒友網(wǎng)立場。文章及其配圖僅供工程師學(xué)習(xí)之用，如有內(nèi)容侵權(quán)或者其他違規(guī)問題，請聯(lián)系本站處理。舉報投訴