HarmonyOS API：公共事件与通知

joytrian

发布于 2023-4-2 10:05

浏览

0收藏

版本：v3.1 Beta

@ohos.events.emitter (Emitter)

更新时间: 2023-02-17 09:19

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

说明

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

导入模块

import emitter from '@ohos.events.emitter'

权限列表

无

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);

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);

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	否	事件携带的数据

示例：

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

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	是	是	发送事件时传递的数据，数据类型支持字符串、整型和布尔型。

EventHub

更新时间: 2023-02-17 09:19

EventHub模块提供了事件中心，提供订阅、取消订阅、触发事件的能力。

说明

本模块首批接口从API version 9开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。
本模块接口仅可在Stage模型下使用。

使用说明

在使用eventHub的功能前，需要通过Ability实例的成员变量context获取。

import UIAbility from '@ohos.app.ability.UIAbility';
export default class MainAbility extends Ability {
    func1(){
        console.log("func1 is called");
    }
    onForeground() {
        this.context.eventHub.on("123", this.func1);
    }
}

EventHub.on

on(event: string, callback: Function): void;

订阅指定事件。

系统能力：SystemCapability.Ability.AbilityRuntime.Core

参数：

参数名	类型	必填	说明
event	string	是	事件名称。
callback	Function	是	事件回调，事件触发后运行。

示例：

import UIAbility from '@ohos.app.ability.UIAbility';

export default class MainAbility extends Ability {
    onForeground() {
        this.context.eventHub.on("123", this.func1);
        this.context.eventHub.on("123", () => {
            console.log("call anonymous func 1");
        });
        // 结果：
        // func1 is called
        // call anonymous func 1
        this.context.eventHub.emit("123"); 
    }
    func1() {
        console.log("func1 is called");
    }
}

EventHub.off

off(event: string, callback?: Function): void;

取消订阅指定事件。当callback传值时，取消订阅指定的callback；未传值时，取消订阅该事件下所有callback。

系统能力：SystemCapability.Ability.AbilityRuntime.Core

参数：

参数名	类型	必填	说明
event	string	是	事件名称。
callback	Function	否	事件回调。如果不传callback，则取消订阅该事件下所有callback。

示例：

import UIAbility from '@ohos.app.ability.UIAbility';

export default class MainAbility extends Ability {
    onForeground() {
        this.context.eventHub.on("123", this.func1);
        this.context.eventHub.off("123", this.func1); //取消订阅func1
        this.context.eventHub.on("123", this.func1);
        this.context.eventHub.on("123", this.func2);
        this.context.eventHub.off("123");  //取消订阅func1和func2
    }
    func1() {
        console.log("func1 is called");
    }
    func2() {
        console.log("func2 is called");
    }
}

EventHub.emit

emit(event: string, ...args: Object[]): void;

触发指定事件。

系统能力：SystemCapability.Ability.AbilityRuntime.Core

参数：

参数名	类型	必填	说明
event	string	是	事件名称。
...args	Object[]	是	可变参数，事件触发时，传递给回调函数的参数。

示例：

import UIAbility from '@ohos.app.ability.UIAbility';

export default class MainAbility extends Ability {
    onForeground() {
        this.context.eventHub.on("123", this.func1);
        // 结果：
        // func1 is called,undefined,undefined
        this.context.eventHub.emit("123");
        // 结果：
        // func1 is called,1,undefined
        this.context.eventHub.emit("123", 1);
        // 结果：
        // func1 is called,1,2
        this.context.eventHub.emit("123", 1, 2);
    }
    func1(a, b) {
        console.log("func1 is called," + a + "," + b);
    }
}

文章转载自：https://developer.harmonyos.com/cn/docs/documentation/doc-references-V3/js-apis-inner-application-eventhub-0000001477981377-V3?catalogVersion=V3#ZH-CN_TOPIC_0000001477981377__使用说明

分类

标签

已于2023-4-2 10:05:11修改