发送和处理进程内事件的能力

2024-01-23 12:58 更新

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

说明

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

导入模块

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

权限列表

emitter.on

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

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

系统能力: SystemCapability.Notification.Emitter

参数:

参数名

类型

必填

说明

event

InnerEvent

持续订阅的事件,其中EventPriority,在订阅事件时无需指定,也不生效

callback

Callback<EventData>

接收订阅事件时的回调处理

示例:

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

emitter.once

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

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

系统能力: SystemCapability.Notification.Emitter

参数:

参数名

类型

必填

说明

event

InnerEvent

单次订阅的事件,其中EventPriority,在订阅事件时无需指定,也不生效

callback

Callback<EventData>

接收订阅事件时的回调处理

示例:

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

emitter.off

off(eventId: number): void

取消订阅某个事件。

系统能力: SystemCapability.Notification.Emitter

参数:

参数名

类型

必填

说明

eventId

number

事件ID

示例:

  1. emitter.off(1);

emitter.emit

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

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

系统能力: SystemCapability.Notification.Emitter

参数:

参数名

类型

必填

说明

event

InnerEvent

发送的事件

data

EventData

事件携带的数据

示例:

  1. let eventData = {
  2. data: {
  3. "content": "c",
  4. "id": 1,
  5. }};
  6. let innerEvent = {
  7. eventId: 1,
  8. priority: emitter.EventPriority.HIGH
  9. };
  10. 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

发送事件时传递的数据,数据类型支持字符串、整型和布尔型。

其中字符串长度最大为10240字节。

以上内容是否对您有帮助:
在线笔记
App下载
App下载

扫描二维码

下载编程狮App

公众号
微信公众号

编程狮公众号