本模块提供进程内线程间或线程内事件的发送与处理能力。开发者可以使用本模块的 API,订阅事件(持续订阅或单次订阅)、取消订阅事件,发送事件到事件队列中,以及查询事件的订阅数量,从而实现同一进程内不同线程之间、以及同一线程内的事件通信。适用于跨线程通信、模块解耦、事件驱动等场景,能够帮助开发者实现轻量级的发布-订阅模式,降低组件间的耦合度,提升代码的可维护性和可扩展性。
提供两种事件处理入口,开发者可根据隔离需求选择:
API 组合使用关系说明:
本模块的事件通信遵循"订阅 → 发布 → 处理 → 取消订阅"的组合调用模式。无论是命名空间级 API 还是实例级 API,均需先订阅事件,再由其他线程或同一线程发布事件,收到事件后执行回调处理;当不再需要接收事件时,应取消订阅以释放资源。同时,事件订阅具有明确的生命周期,开发者应注意资源管理:
本模块首批接口从API version 7开始支持。后续版本新增接口,采用上角标单独标记接口的起始版本。
on(event: InnerEvent, callback: Callback<EventData>): void
持续订阅指定的事件,并在接收到该事件时,执行对应的回调处理函数。
元服务API: 从API version 11开始,该接口支持在元服务中使用。
系统能力: SystemCapability.Notification.Emitter
参数:
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| event | InnerEvent | 是 | 持续订阅的事件,其中EventPriority在订阅事件时无需指定,也不生效。 |
| callback | Callback<EventData> | 是 | 回调函数,返回发送事件时传递的数据对象。 |
示例:
import { Callback } from '@kit.BasicServicesKit';
let innerEvent: emitter.InnerEvent = {
eventId: 1
};
let callback: Callback<emitter.EventData> = (eventData: emitter.EventData) => {
console.info(`eventData: ${JSON.stringify(eventData)}`);
};
// 收到eventId为1的事件后执行回调处理函数
emitter.on(innerEvent, callback); on(eventId: string, callback: Callback<EventData>): void
持续订阅指定的事件,并在接收到该事件时,执行对应的回调处理函数。
元服务API: 从API version 11开始,该接口支持在元服务中使用。
系统能力: SystemCapability.Notification.Emitter
参数:
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| eventId | string | 是 | 持续订阅的事件ID。 不可为空字符串,大小不超过10240字节,超出部分会被截断。 |
| callback | Callback<EventData> | 是 | 回调函数,返回发送事件时传递的数据对象。 |
示例:
import { Callback } from '@kit.BasicServicesKit';
let callback: Callback<emitter.EventData> = (eventData: emitter.EventData) => {
console.info(`eventData: ${JSON.stringify(eventData)}`);
};
// 收到eventId为"eventId"的事件后执行回调处理函数
emitter.on('eventId', callback); on<T>(eventId: string, callback: Callback<GenericEventData<T>>): void
持续订阅指定的事件,并在接收到该事件时,执行对应的回调处理函数。
元服务API: 从API version 12开始,该接口支持在元服务中使用。
系统能力: SystemCapability.Notification.Emitter
参数:
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| eventId | string | 是 | 持续订阅的事件ID。 不可为空字符串,大小不超过10240字节,超出部分会被截断。 |
| callback | Callback<GenericEventData<T>> | 是 | 回调函数,返回发送事件时传递的泛型数据对象。 |
示例:
import { Callback } from '@kit.BasicServicesKit';
@Sendable
class Sample {
constructor() {
this.count = 100;
}
printCount() {
console.info('Print count : ' + this.count);
}
count: number;
}
let callback: Callback<emitter.GenericEventData<Sample>> = (eventData: emitter.GenericEventData<Sample>): void => {
console.info(`eventData: ${JSON.stringify(eventData?.data)}`);
if (eventData?.data instanceof Sample) {
eventData?.data?.printCount();
}
};
// 收到eventId为"eventId"的事件后执行回调函数
emitter.on('eventId', callback); once(event: InnerEvent, callback: Callback<EventData>): void
单次订阅指定的事件,在接收到该事件且执行完对应的回调处理函数后,自动取消订阅。
元服务API: 从API version 11开始,该接口支持在元服务中使用。
系统能力: SystemCapability.Notification.Emitter
参数:
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| event | InnerEvent | 是 | 单次订阅的事件,其中EventPriority在订阅事件时无需指定,也不生效。 |
| callback | Callback<EventData> | 是 | 回调函数,返回发送事件时传递的数据对象。 |
示例:
import { Callback } from '@kit.BasicServicesKit';
let innerEvent: emitter.InnerEvent = {
eventId: 1
};
let callback: Callback<emitter.EventData> = (eventData: emitter.EventData) => {
console.info(`eventData: ${JSON.stringify(eventData)}`);
};
// 收到eventId为1的事件后执行该回调处理函数
emitter.once(innerEvent, callback); once(eventId: string, callback: Callback<EventData>): void
单次订阅指定的事件,在接收到该事件且执行完对应的回调处理函数后,自动取消订阅。
元服务API: 从API version 11开始,该接口支持在元服务中使用。
系统能力: SystemCapability.Notification.Emitter
参数:
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| eventId | string | 是 | 单次订阅的事件ID。 不可为空字符串,大小不超过10240字节,超出部分会被截断。 |
| callback | Callback<EventData> | 是 | 回调函数,返回发送事件时传递的数据对象。 |
示例:
import { Callback } from '@kit.BasicServicesKit';
let callback: Callback<emitter.EventData> = (eventData: emitter.EventData) => {
console.info(`eventData: ${JSON.stringify(eventData)}`);
};
// 收到eventId为"eventId"的事件后执行该回调函数
emitter.once('eventId', callback); once<T>(eventId: string, callback: Callback<GenericEventData<T>>): void
单次订阅指定的事件,在接收到该事件且执行完对应的回调处理函数后,自动取消订阅。
元服务API: 从API version 12开始,该接口支持在元服务中使用。
系统能力: SystemCapability.Notification.Emitter
参数:
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| eventId | string | 是 | 单次订阅的事件ID。 不可为空字符串,大小不超过10240字节,超出部分会被截断。 |
| callback | Callback<GenericEventData<T>> | 是 | 回调函数,返回发送事件时传递的泛型数据对象。 |
示例:
import { Callback } from '@kit.BasicServicesKit';
@Sendable
class Sample {
constructor() {
this.count = 100;
}
printCount() {
console.info('Print count : ' + this.count);
}
count: number;
}
let callback: Callback<emitter.GenericEventData<Sample>> = (eventData: emitter.GenericEventData<Sample>): void => {
console.info(`eventData: ${JSON.stringify(eventData?.data)}`);
if (eventData?.data instanceof Sample) {
eventData?.data?.printCount();
}
};
// 收到eventId为"eventId"的事件后执行回调函数
emitter.once('eventId', callback); off(eventId: number): void
取消事件ID为eventId的所有订阅。
使用该接口取消某个事件订阅后,已通过emit接口发布但尚未被执行的事件将被取消。
元服务API: 从API version 11开始,该接口支持在元服务中使用。
系统能力: SystemCapability.Notification.Emitter
参数:
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| eventId | number | 是 | 事件ID,由开发者定义,用于辨别事件。 |
示例:
// 取消eventId为1的所有事件回调处理函数 emitter.off(1);
off(eventId: string): void
取消事件ID为eventId的所有订阅。
使用该接口取消某个事件订阅后,已通过emit接口发布但尚未被执行的事件将被取消。
元服务API: 从API version 11开始,该接口支持在元服务中使用。
系统能力: SystemCapability.Notification.Emitter
参数:
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| eventId | string | 是 | 事件ID。 不可为空字符串,大小不超过10240字节,超出部分会被截断。 |
示例:
// 取消eventId为"eventId1"的所有事件回调处理函数
emitter.off('eventId1'); off(eventId: number, callback: Callback<EventData>): void
取消事件ID为eventId且回调处理函数为callback的订阅。仅当已使用on或once接口订阅callback时,该接口才生效。
使用该接口取消某个事件订阅后,已通过emit接口发布但尚未被执行的事件将被取消。
元服务API: 从API version 11开始,该接口支持在元服务中使用。
系统能力: SystemCapability.Notification.Emitter
参数:
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| eventId | number | 是 | 事件ID,由开发者定义,用于辨别事件。 |
| callback | Callback<EventData> | 是 | 回调函数,返回发送事件时传递的数据对象,需与订阅时使用的callback一致。 |
示例:
import { Callback } from '@kit.BasicServicesKit';
let callback: Callback<emitter.EventData> = (eventData: emitter.EventData) => {
console.info(`eventData: ${JSON.stringify(eventData)}`);
};
// 取消eventId为1的事件回调处理函数,callback对象应使用订阅时的对象
// 如果该回调处理函数没有被订阅,则不做任何处理
emitter.off(1, callback); off(eventId: string, callback: Callback<EventData>): void
取消事件ID为eventId且回调处理函数为callback的订阅。仅当已使用on或once接口订阅callback时,该接口才生效。
使用该接口取消某个事件订阅后,已通过emit接口发布但尚未被执行的事件将被取消。
元服务API: 从API version 11开始,该接口支持在元服务中使用。
系统能力: SystemCapability.Notification.Emitter
参数:
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| eventId | string | 是 | 事件ID。 不可为空字符串,大小不超过10240字节,超出部分会被截断。 |
| callback | Callback<EventData> | 是 | 回调函数,返回发送事件时传递的数据对象,需与订阅时使用的callback一致。 |
示例:
import { Callback } from '@kit.BasicServicesKit';
let callback: Callback<emitter.EventData> = (eventData: emitter.EventData) => {
console.info(`eventData: ${JSON.stringify(eventData)}`);
};
// 取消eventId为"eventId1"的事件回调处理函数,callback对象应使用订阅时的对象
// 如果该回调处理函数没有被订阅,则不做任何处理
emitter.off('eventId1', callback); off<T>(eventId: string, callback: Callback<GenericEventData<T>>): void
取消事件ID为eventId且回调处理函数为callback的订阅。仅当已使用on或once接口订阅callback时,该接口才生效。
使用该接口取消某个事件订阅后,已通过emit接口发布但尚未被执行的事件将被取消。
元服务API: 从API version 12开始,该接口支持在元服务中使用。
系统能力: SystemCapability.Notification.Emitter
参数:
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| eventId | string | 是 | 事件ID。 不可为空字符串,大小不超过10240字节,超出部分会被截断。 |
| callback | Callback<GenericEventData<T>> | 是 | 回调函数,返回发送事件时传递的泛型数据对象,需与订阅时使用的callback一致。 |
示例:
import { Callback } from '@kit.BasicServicesKit';
@Sendable
class Sample {
constructor() {
this.count = 100;
}
printCount() {
console.info('Print count : ' + this.count);
}
count: number;
}
let callback: Callback<emitter.GenericEventData<Sample>> = (eventData: emitter.GenericEventData<Sample>): void => {
console.info(`eventData: ${JSON.stringify(eventData?.data)}`);
if (eventData?.data instanceof Sample) {
eventData?.data?.printCount();
}
};
// 取消eventId为"eventId1"的事件回调处理函数,callback对象应使用订阅时的对象
// 如果该回调处理函数没有被订阅,则不做任何处理
emitter.off('eventId1', callback); emit(event: InnerEvent, data?: EventData): void
发送指定事件。
该接口支持跨线程传输数据对象,需要遵循数据跨线程传输的规格约束,详见线程间通信对象。目前不支持使用@State装饰器、@Observed装饰器等装饰器修饰的复杂类型数据。
该接口发布某个事件后,不保证该事件立刻执行,执行时间取决于事件队列里面的事件数量以及各事件的执行效率。
元服务API: 从API version 11开始,该接口支持在元服务中使用。
系统能力: SystemCapability.Notification.Emitter
参数:
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| event | InnerEvent | 是 | 发送的事件,其中EventPriority用于指定事件被发送的优先级。 |
| data | EventData | 否 | 事件携带的数据,默认为空。 |
示例:
let eventData: emitter.EventData = {
data: {
"content": "content",
"id": 1,
}
};
let innerEvent: emitter.InnerEvent = {
eventId: 1,
priority: emitter.EventPriority.HIGH
};
emitter.emit(innerEvent, eventData); emit(eventId: string, data?: EventData): void
发送指定事件。
该接口支持跨线程传输数据对象,需要遵循数据跨线程传输的规格约束,详见线程间通信对象。目前不支持使用@State装饰器、@Observed装饰器等装饰器修饰的复杂类型数据。
该接口发布某个事件后,不保证该事件立刻执行,执行时间取决于事件队列里面的事件数量以及各事件的执行效率。
元服务API: 从API version 11开始,该接口支持在元服务中使用。
系统能力: SystemCapability.Notification.Emitter
参数:
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| eventId | string | 是 | 发送的事件ID。 不可为空字符串,大小不超过10240字节,超出部分会被截断。 |
| data | EventData | 否 | 事件携带的数据,默认为空。 |
示例:
let eventData: emitter.EventData = {
data: {
"content": "content",
"id": 1,
}
};
emitter.emit('eventId', eventData); emit<T>(eventId: string, data?: GenericEventData<T>): void
发送指定事件。
该接口支持跨线程传输数据对象,需要遵循数据跨线程传输的规格约束,详见线程间通信对象。目前不支持使用@State装饰器、@Observed装饰器等装饰器修饰的复杂类型数据。
该接口发布某个事件后,不保证该事件立刻执行,执行时间取决于事件队列里面的事件数量以及各事件的执行效率。
元服务API: 从API version 12开始,该接口支持在元服务中使用。
系统能力: SystemCapability.Notification.Emitter
参数:
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| eventId | string | 是 | 发送的事件ID。 不可为空字符串,大小不超过10240字节,超出部分会被截断。 |
| data | GenericEventData<T> | 否 | 事件携带的数据,默认为空。 |
示例:
@Sendable
class Sample {
constructor() {
this.count = 100;
}
printCount() {
console.info('Print count : ' + this.count);
}
count: number;
}
let eventData: emitter.GenericEventData<Sample> = {
data: new Sample()
};
emitter.emit('eventId', eventData); emit(eventId: string, options: Options, data?: EventData): void
发送指定优先级事件。
该接口支持跨线程传输数据对象,需要遵循数据跨线程传输的规格约束,详见线程间通信对象。目前不支持使用@State装饰器、@Observed装饰器等装饰器修饰的复杂类型数据。
该接口发布某个事件后,不保证该事件立刻执行,执行时间取决于事件队列里面的事件数量以及各事件的执行效率。
元服务API: 从API version 11开始,该接口支持在元服务中使用。
系统能力: SystemCapability.Notification.Emitter
参数:
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| eventId | string | 是 | 发送的事件ID。 不可为空字符串,大小不超过10240字节,超出部分会被截断。 |
| options | Options | 是 | 事件优先级。 |
| data | EventData | 否 | 事件携带的数据,默认为空。 |
示例:
let eventData: emitter.EventData = {
data: {
"content": "content",
"id": 1,
}
};
let options: emitter.Options = {
priority: emitter.EventPriority.HIGH
};
emitter.emit('eventId', options, eventData); emit<T>(eventId: string, options: Options, data?: GenericEventData<T>): void
发送指定优先级事件。
该接口支持跨线程传输数据对象,需要遵循数据跨线程传输的规格约束,详见线程间通信对象。目前不支持使用@State装饰器、@Observed装饰器等装饰器修饰的复杂类型数据。
该接口发布某个事件后,不保证该事件立刻执行,执行时间取决于事件队列里面的事件数量以及各事件的执行效率。
元服务API: 从API version 12开始,该接口支持在元服务中使用。
系统能力: SystemCapability.Notification.Emitter
参数:
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| eventId | string | 是 | 发送的事件ID。 不可为空字符串,大小不超过10240字节,超出部分会被截断。 |
| options | Options | 是 | 事件优先级。 |
| data | GenericEventData<T> | 否 | 事件携带的数据,默认为空。 |
示例:
@Sendable
class Sample {
constructor() {
this.count = 100;
}
printCount() {
console.info('Print count : ' + this.count);
}
count: number;
}
let options: emitter.Options = {
priority: emitter.EventPriority.HIGH
};
let eventData: emitter.GenericEventData<Sample> = {
data: new Sample()
};
emitter.emit('eventId', options, eventData); getListenerCount(eventId: number | string): number
获取指定事件的订阅数。
元服务API: 从API version 11开始,该接口支持在元服务中使用。
系统能力: SystemCapability.Notification.Emitter
参数:
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| eventId | number | string | 是 | 事件ID,由开发者定义,用于辨别事件。 string类型:不可为空字符串,大小不超过10240字节,超出部分会被截断。 |
返回值:
| 类型 | 说明 |
|---|---|
| number | 指定事件的订阅数。 |
示例:
let count: number = emitter.getListenerCount('eventId'); 表示事件的优先级。
元服务API: 从API version 11开始,该接口支持在元服务中使用。
系统能力: SystemCapability.Notification.Emitter
| 名称 | 值 | 说明 |
|---|---|---|
| IMMEDIATE | 0 | 表示事件先于HIGH优先级投递。 |
| HIGH | 1 | 表示事件先于LOW优先级投递。 |
| LOW | 2 | 表示事件先于IDLE优先级投递,事件的默认优先级是LOW。 |
| IDLE | 3 | 表示在没有其他事件的情况下,才投递该事件。 |
订阅或发送的事件,订阅事件时EventPriority不生效。
元服务API: 从API version 11开始,该接口支持在元服务中使用。
系统能力: SystemCapability.Notification.Emitter
| 名称 | 类型 | 只读 | 可选 | 说明 |
|---|---|---|---|---|
| eventId | number | 否 | 否 | 事件ID,由开发者定义,用于辨别事件。 |
| priority | EventPriority | 否 | 是 | 事件的优先级,默认值为EventPriority.LOW。 |
发送事件时传递的数据。
元服务API: 从API version 11开始,该接口支持在元服务中使用。
系统能力: SystemCapability.Notification.Emitter
| 名称 | 类型 | 只读 | 可选 | 说明 |
|---|---|---|---|---|
| data | { [key: string]: any } | 否 | 是 | 发送事件时传递的数据,支持数据类型包括Array、ArrayBuffer、Boolean、DataView、Date、Error、Map、Number、Object、Primitive(除了symbol)、RegExp、Set、String、TypedArray,数据大小最大为16MB,超出限制时事件发送失败。 |
发送事件的优先级。
元服务API: 从API version 12开始,该接口支持在元服务中使用。
系统能力: SystemCapability.Notification.Emitter
| 名称 | 类型 | 只读 | 可选 | 说明 |
|---|---|---|---|---|
| priority | EventPriority | 否 | 是 | 事件的优先级,默认值为EventPriority.LOW。 |
发送事件时传递的泛型数据。
元服务API: 从API version 12开始,该接口支持在元服务中使用。
系统能力: SystemCapability.Notification.Emitter
| 名称 | 类型 | 只读 | 可选 | 说明 |
|---|---|---|---|---|
| data | T | 否 | 是 | 发送事件时传递的数据。T:泛型类型,由开发者根据业务需要自定义具体的数据类型。 |
该功能支持在同一进程的同一Emitter类实例中,跨不同线程或同一线程内发送和处理事件。它能够实现持续订阅事件、单次订阅事件、取消订阅事件以及将事件发送到事件队列,适用于需要基于独立实例进行线程间通信和事件管理的场景,不同Emitter实例类之间相互隔离,互不影响。
元服务API: 从API version 22开始,该接口支持在元服务中使用。
系统能力: SystemCapability.Notification.Emitter
constructor()
构造函数。
元服务API: 从API version 22开始,该接口支持在元服务中使用。
系统能力: SystemCapability.Notification.Emitter
示例:
let emitter1: emitter.Emitter = new emitter.Emitter();
on(eventId: string, callback: Callback<EventData>): void
持续订阅当前Emitter类实例指定的事件,并在接收到该事件时,使用callback异步回调。
元服务API: 从API version 22开始,该接口支持在元服务中使用。
系统能力: SystemCapability.Notification.Emitter
参数:
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| eventId | string | 是 | 持续订阅的事件ID。 不可为空字符串,大小不超过10240字节,超出部分会被截断。 |
| callback | Callback<EventData> | 是 | 回调函数,返回发送事件时传递的数据对象。 |
示例:
import { Callback } from '@kit.BasicServicesKit';
let emitter1: emitter.Emitter = new emitter.Emitter();
let callback: Callback<emitter.EventData> = (eventData: emitter.EventData) => {
console.info(`eventData: ${JSON.stringify(eventData)}`);
};
emitter1.on('eventId', callback); on<T>(eventId: string, callback: Callback<GenericEventData<T>>): void
持续订阅当前Emitter类实例指定的事件,并在接收到该事件时,使用callback异步回调。
元服务API: 从API version 22开始,该接口支持在元服务中使用。
系统能力: SystemCapability.Notification.Emitter
参数:
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| eventId | string | 是 | 持续订阅的事件ID。 不可为空字符串,大小不超过10240字节,超出部分会被截断。 |
| callback | Callback<GenericEventData<T>> | 是 | 回调函数,返回发送事件时传递的泛型数据对象。 |
示例:
import { Callback } from '@kit.BasicServicesKit';
let emitter1: emitter.Emitter = new emitter.Emitter();
@Sendable
class Sample {
constructor() {
this.count = 100;
}
printCount() {
console.info('Print count : ' + this.count);
}
count: number;
}
let callback: Callback<emitter.GenericEventData<Sample>> = (eventData: emitter.GenericEventData<Sample>): void => {
console.info(`eventData: ${JSON.stringify(eventData?.data)}`);
if (eventData?.data instanceof Sample) {
eventData?.data?.printCount();
}
};
emitter1.on('eventId', callback); once(eventId: string, callback: Callback<EventData>): void
单次订阅当前Emitter类实例指定的事件,在接收到该事件且执行完对应的回调处理函数后,自动取消订阅。使用callback异步回调。
元服务API: 从API version 22开始,该接口支持在元服务中使用。
系统能力: SystemCapability.Notification.Emitter
参数:
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| eventId | string | 是 | 单次订阅的事件ID。 不可为空字符串,大小不超过10240字节,超出部分会被截断。 |
| callback | Callback<EventData> | 是 | 回调函数,返回发送事件时传递的数据对象。 |
示例:
import { Callback } from '@kit.BasicServicesKit';
let emitter1: emitter.Emitter = new emitter.Emitter();
let callback: Callback<emitter.EventData> = (eventData: emitter.EventData) => {
console.info(`eventData: ${JSON.stringify(eventData)}`);
};
emitter1.once('eventId', callback); once<T>(eventId: string, callback: Callback<GenericEventData<T>>): void
单次订阅当前Emitter类实例指定的事件,在接收到该事件且执行完对应的回调处理函数后,自动取消订阅。使用callback异步回调。
元服务API: 从API version 22开始,该接口支持在元服务中使用。
系统能力: SystemCapability.Notification.Emitter
参数:
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| eventId | string | 是 | 单次订阅的事件ID。 不可为空字符串,大小不超过10240字节,超出部分会被截断。 |
| callback | Callback<GenericEventData<T>> | 是 | 回调函数,返回发送事件时传递的泛型数据对象。 |
示例:
import { Callback } from '@kit.BasicServicesKit';
let emitter1: emitter.Emitter = new emitter.Emitter();
@Sendable
class Sample {
constructor() {
this.count = 100;
}
printCount() {
console.info('Print count : ' + this.count);
}
count: number;
}
let callback: Callback<emitter.GenericEventData<Sample>> = (eventData: emitter.GenericEventData<Sample>): void => {
console.info(`eventData: ${JSON.stringify(eventData?.data)}`);
if (eventData?.data instanceof Sample) {
eventData?.data?.printCount();
}
};
emitter1.once('eventId', callback); off(eventId: string): void
取消当前Emitter类实例事件ID为eventId的所有订阅。
使用该接口取消某个事件订阅后,已通过emit接口发布但尚未被执行的事件将被取消。
元服务API: 从API version 22开始,该接口支持在元服务中使用。
系统能力: SystemCapability.Notification.Emitter
参数:
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| eventId | string | 是 | 事件ID。 不可为空字符串,大小不超过10240字节,超出部分会被截断。 |
示例:
let emitter1: emitter.Emitter = new emitter.Emitter();
emitter1.off('eventId'); off(eventId: string, callback: Callback<EventData>): void
取消订阅当前Emitter类实例的事件。仅当已使用on或once接口订阅了事件ID为eventId且回调处理函数为callback的事件时,该接口才生效。
使用该接口取消事件订阅后,已通过emit接口发布但尚未被执行的事件将被取消。
元服务API: 从API version 22开始,该接口支持在元服务中使用。
系统能力: SystemCapability.Notification.Emitter
参数:
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| eventId | string | 是 | 事件ID。 不可为空字符串,大小不超过10240字节,超出部分会被截断。 |
| callback | Callback<EventData> | 是 | 回调函数,返回发送事件时传递的数据对象。 |
示例:
import { Callback } from '@kit.BasicServicesKit';
let emitter1: emitter.Emitter = new emitter.Emitter();
let callback: Callback<emitter.EventData> = (eventData: emitter.EventData) => {
console.info(`eventData: ${JSON.stringify(eventData)}`);
};
emitter1.off('eventId', callback); off<T>(eventId: string, callback: Callback<GenericEventData<T>>): void
取消订阅当前Emitter类实例的事件。仅当已使用on或once接口订阅了事件ID为eventId且回调处理函数为callback的事件时,该接口才生效。
使用该接口取消事件订阅后,已通过emit接口发布但尚未被执行的事件将被取消。
元服务API: 从API version 22开始,该接口支持在元服务中使用。
系统能力: SystemCapability.Notification.Emitter
参数:
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| eventId | string | 是 | 事件ID。 不可为空字符串,大小不超过10240字节,超出部分会被截断。 |
| callback | Callback<GenericEventData<T>> | 是 | 回调函数,返回发送事件时传递的泛型数据对象。 |
示例:
import { Callback } from '@kit.BasicServicesKit';
@Sendable
class Sample {
constructor() {
this.count = 100;
}
printCount() {
console.info('Print count : ' + this.count);
}
count: number;
}
let emitter1: emitter.Emitter = new emitter.Emitter();
let callback: Callback<emitter.GenericEventData<Sample>> = (eventData: emitter.GenericEventData<Sample>): void => {
console.info(`eventData: ${JSON.stringify(eventData?.data)}`);
if (eventData?.data instanceof Sample) {
eventData?.data?.printCount();
}
};
emitter1.off('eventId', callback); emit(eventId: string, data?: EventData): void
发送指定事件到当前Emitter类实例。
该接口支持跨线程传输数据对象,需要遵循数据跨线程传输的规格约束,详见线程间通信对象。目前不支持使用@State装饰器、@Observed装饰器等装饰器修饰的复杂类型数据。
该接口发布某个事件后,不保证该事件立刻执行,执行时间取决于事件队列里面的事件数量以及各事件的执行效率。
元服务API: 从API version 22开始,该接口支持在元服务中使用。
系统能力: SystemCapability.Notification.Emitter
参数:
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| eventId | string | 是 | 发送的事件ID。 不可为空字符串,大小不超过10240字节,超出部分会被截断。 |
| data | EventData | 否 | 事件携带的数据,默认为空。 |
示例:
let emitter1: emitter.Emitter = new emitter.Emitter();
let eventData: emitter.EventData = {
data: {
"content": "content",
"id": 1,
}
};
emitter1.emit('eventId', eventData); emit<T>(eventId: string, data?: GenericEventData<T>): void
发送指定事件到当前Emitter类实例。
该接口支持跨线程传输数据对象,需要遵循数据跨线程传输的规格约束,详见线程间通信对象。目前不支持使用@State装饰器、@Observed装饰器等装饰器修饰的复杂类型数据。
该接口发布某个事件后,不保证该事件立刻执行,执行时间取决于事件队列里面的事件数量以及各事件的执行效率。
元服务API: 从API version 22开始,该接口支持在元服务中使用。
系统能力: SystemCapability.Notification.Emitter
参数:
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| eventId | string | 是 | 发送的事件ID。 不可为空字符串,大小不超过10240字节,超出部分会被截断。 |
| data | GenericEventData<T> | 否 | 事件携带的数据,默认为空。 |
示例:
@Sendable
class Sample {
constructor() {
this.count = 100;
}
printCount() {
console.info('Print count : ' + this.count);
}
count: number;
}
let emitter1: emitter.Emitter = new emitter.Emitter();
let eventData: emitter.GenericEventData<Sample> = {
data: new Sample()
};
emitter1.emit('eventId', eventData); emit(eventId: string, options: Options, data?: EventData): void
发送指定优先级事件到当前Emitter类实例。
该接口支持跨线程传输数据对象,需要遵循数据跨线程传输的规格约束,详见线程间通信对象。目前不支持使用@State装饰器、@Observed装饰器等装饰器修饰的复杂类型数据。
该接口发布某个事件后,不保证该事件立刻执行,执行时间取决于事件队列里面的事件数量以及各事件的执行效率。
元服务API: 从API version 22开始,该接口支持在元服务中使用。
系统能力: SystemCapability.Notification.Emitter
参数:
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| eventId | string | 是 | 发送的事件ID。 不可为空字符串,大小不超过10240字节,超出部分会被截断。 |
| options | Options | 是 | 事件优先级。 |
| data | EventData | 否 | 事件携带的数据,默认为空。 |
示例:
let emitter1: emitter.Emitter = new emitter.Emitter();
let options: emitter.Options = {
priority: emitter.EventPriority.HIGH
};
let eventData: emitter.EventData = {
data: {
"content": "content",
"id": 1,
}
};
emitter1.emit('eventId', options, eventData); emit<T>(eventId: string, options: Options, data?: GenericEventData<T>): void
发送指定优先级事件到当前Emitter类实例。
该接口支持跨线程传输数据对象,需要遵循数据跨线程传输的规格约束,详见线程间通信对象。目前不支持使用@State装饰器、@Observed装饰器等装饰器修饰的复杂类型数据。
该接口发布某个事件后,不保证该事件立刻执行,执行时间取决于事件队列里面的事件数量以及各事件的执行效率。
元服务API: 从API version 22开始,该接口支持在元服务中使用。
系统能力: SystemCapability.Notification.Emitter
参数:
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| eventId | string | 是 | 发送的事件ID。 不可为空字符串,大小不超过10240字节,超出部分会被截断。 |
| options | Options | 是 | 事件优先级。 |
| data | GenericEventData<T> | 否 | 事件携带的数据,默认为空。 |
示例:
@Sendable
class Sample {
constructor() {
this.count = 100;
}
printCount() {
console.info('Print count : ' + this.count);
}
count: number;
}
let emitter1: emitter.Emitter = new emitter.Emitter();
let options: emitter.Options = {
priority: emitter.EventPriority.HIGH
};
let eventData: emitter.GenericEventData<Sample> = {
data: new Sample()
};
emitter1.emit('eventId', options, eventData); getListenerCount(eventId: string): number
获取当前Emitter类实例指定事件的订阅数。
元服务API: 从API version 22开始,该接口支持在元服务中使用。
系统能力: SystemCapability.Notification.Emitter
参数:
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| eventId | string | 是 | 事件ID。 不可为空字符串,大小不超过10240字节,超出部分会被截断。 |
返回值:
| 类型 | 说明 |
|---|---|
| number | 指定事件的订阅数。 |
示例:
let emitter1: emitter.Emitter = new emitter.Emitter();
let count: number = emitter1.getListenerCount('eventId');