a73c0570创建于 2025年2月6日历史提交

@ohos.events.emitter (Emitter)

本模块提供了在同一进程不同线程间，或同一进程同一线程内，发送和处理事件的能力，包括持续订阅事件、单次订阅事件、取消订阅事件，以及发送事件到事件队列的能力。

说明：

本模块首批接口从API version 7开始支持。后续版本新增接口，采用上角标单独标记接口的起始版本。

导入模块

import { emitter } from '@kit.BasicServicesKit';

权限列表

无权限要求。

emitter.on

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

持续订阅指定的事件，并在接收到该事件时，执行对应的回调处理函数。

原子化服务API： 从API version 11开始，该接口支持在原子化服务中使用。

系统能力: SystemCapability.Notification.Emitter

参数：

参数名	类型	必填	说明
event	InnerEvent	是	持续订阅的事件，其中EventPriority，在订阅事件时无需指定，也不生效。
callback	Callback<EventData>	是	接收到该事件时需要执行的回调处理函数。

示例：

let innerEvent: emitter.InnerEvent = {
  eventId: 1
};

// 收到eventId为1的事件后执行回调函数
emitter.on(innerEvent, () => {
  console.info('callback');
});

emitter.on¹¹⁺

on(eventId: string, callback: Callback<EventData>): void

持续订阅指定事件，并在接收到该事件时，执行对应的回调处理函数。

原子化服务API： 从API version 11开始，该接口支持在原子化服务中使用。

系统能力: SystemCapability.Notification.Emitter

参数：

参数名	类型	必填	说明
eventId	string	是	持续订阅的事件。长度不超过10240字节的自定义字符串，且不可为空字符。
callback	Callback<EventData>	是	接收到该事件时需要执行的回调处理函数。

示例：

// 收到eventId为"eventId"的事件后执行回调函数
emitter.on("eventId", () => {
  console.info('callback');
});

emitter.on¹²⁺

on<T>(eventId: string, callback: Callback<GenericEventData<T>>): void

持续订阅指定事件，并在接收到该事件时，执行对应的回调处理函数。

原子化服务API： 从API version 12开始，该接口支持在原子化服务中使用。

系统能力: SystemCapability.Notification.Emitter

参数：

参数名	类型	必填	说明
eventId	string	是	持续订阅的事件。长度不超过10240字节的自定义字符串，且不可为空字符。
callback	Callback<GenericEventData<T>>	是	接收到该事件时需要执行的回调处理函数。

示例：

@Sendable
class Sample {
    constructor() {
        this.count = 100;
    }
    printCount() {
        console.info('Print count : ' + this.count);
    }
    count: number;
}

let callback = (eventData: emitter.GenericEventData<Sample>): void => {
   let storage: Sample = eventData.data!;
   storage.printCount();
}
// 收到eventId为"eventId"的事件后执行回调函数
emitter.on("eventId", callback);

emitter.once

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

单次订阅指定的事件，并在接收到该事件并执行完相应的回调函数后，自动取消订阅。

原子化服务API： 从API version 11开始，该接口支持在原子化服务中使用。

系统能力: SystemCapability.Notification.Emitter

参数：

参数名	类型	必填	说明
event	InnerEvent	是	单次订阅的事件，其中EventPriority，在订阅事件时无需指定，也不生效。
callback	Callback<EventData>	是	接收到该事件时需要执行的回调处理函数。

示例：

let innerEvent: emitter.InnerEvent = {
    eventId: 1
};

// 收到eventId为1的事件后执行该回调函数
emitter.once(innerEvent, () => {
    console.info('once callback');
});

emitter.once¹¹⁺

once(eventId: string, callback: Callback<EventData>): void

单次订阅指定事件，并在接收到该事件并执行完相应的回调函数后，自动取消订阅。

原子化服务API： 从API version 11开始，该接口支持在原子化服务中使用。

系统能力: SystemCapability.Notification.Emitter

参数：

参数名	类型	必填	说明
eventId	string	是	单次订阅的事件。长度不超过10240字节的自定义字符串，且不可为空字符。
callback	Callback<EventData>	是	接收到该事件时需要执行的回调处理函数。

示例：

// 收到eventId为"eventId"的事件后执行该回调函数
emitter.once("eventId", () => {
    console.info('once callback');
});

emitter.once¹²⁺

once<T>(eventId: string, callback: Callback<GenericEventData<T>>): void

单次订阅指定事件，并在接收到该事件并执行完相应的回调函数后，自动取消订阅。

原子化服务API： 从API version 12开始，该接口支持在原子化服务中使用。

系统能力: SystemCapability.Notification.Emitter

参数：

参数名	类型	必填	说明
eventId	string	是	单次订阅的事件。长度不超过10240字节的自定义字符串，且不可为空字符。
callback	Callback<GenericEventData<T>>	是	接收到该事件时需要执行的回调处理函数。

示例：

@Sendable
class Sample {
    constructor() {
        this.count = 100;
    }
    printCount() {
        console.info('Print count : ' + this.count);
    }
    count: number;
}

let callback = (eventData: emitter.GenericEventData<Sample>): void => {
   let storage: Sample = eventData.data!;
   storage.printCount();
}
// 收到eventId为"eventId"的事件后执行回调函数
emitter.once("eventId", callback);

emitter.off

off(eventId: number): void

取消针对该事件ID的订阅。

原子化服务API： 从API version 11开始，该接口支持在原子化服务中使用。

系统能力: SystemCapability.Notification.Emitter

参数：

参数名	类型	必填	说明
eventId	number	是	事件ID。

示例：

// 取消eventID为1的所有事件回调处理函数
emitter.off(1);

emitter.off¹¹⁺

off(eventId: string): void

取消订阅指定事件。

原子化服务API： 从API version 11开始，该接口支持在原子化服务中使用。

系统能力: SystemCapability.Notification.Emitter

参数：

参数名	类型	必填	说明
eventId	string	是	事件ID。长度不超过10240字节的自定义字符串，且不可为空字符。

示例：

// 取消eventID为"eventId"的所有事件回调处理函数
emitter.off("eventId");

emitter.off¹⁰⁺

off(eventId: number, callback: Callback<EventData>): void

取消针对该事件ID的订阅，传入可选参数Callback<EventData>，并且该Callback<EventData>已经通过on或者once接口订阅，则取消该订阅；否则，不做任何处理。

原子化服务API： 从API version 11开始，该接口支持在原子化服务中使用。

系统能力: SystemCapability.Notification.Emitter

参数：

参数名	类型	必填	说明
eventId	number	是	事件ID。
callback	Callback<EventData>	是	取消该事件的回调处理函数。

示例：

// 取消eventID为1的事件回调处理函数
// 如果该回调处理函数没有被订阅，则不做任何处理
emitter.off(1, () => {
  console.info('callback');
});

emitter.off¹¹⁺

off(eventId: string, callback: Callback<EventData>): void

取消针对该事件ID的订阅，传入可选参数Callback<EventData>，并且该Callback<EventData>已经通过on或者once接口订阅，则取消该订阅；否则，不做任何处理。

原子化服务API： 从API version 11开始，该接口支持在原子化服务中使用。

系统能力: SystemCapability.Notification.Emitter

参数：

参数名	类型	必填	说明
eventId	string	是	事件ID。长度不超过10240字节的自定义字符串，且不可为空字符。
callback	Callback<EventData>	是	取消该事件的回调处理函数。

示例：

// 取消eventID为"eventId"的事件回调处理函数
// 如果该回调处理函数没有被订阅，则不做任何处理
emitter.off("eventId", () => {
  console.info('callback');
});

emitter.off¹²⁺

off<T>(eventId: string, callback: Callback<GenericEventData<T>>): void

取消针对该事件ID的订阅，传入可选参数Callback<GenericEventData<T>>，如果该Callback<GenericEventData<T>>已经通过on或者once接口订阅，则取消该订阅；否则，不做任何处理。

原子化服务API： 从API version 12开始，该接口支持在原子化服务中使用。

系统能力: SystemCapability.Notification.Emitter

参数：

参数名	类型	必填	说明
eventId	string	是	事件ID。长度不超过10240字节的自定义字符串，且不可为空字符。
callback	Callback<GenericEventData<T>>	是	取消该事件的回调处理函数。

示例：

@Sendable
class Sample {
    constructor() {
        this.count = 100;
    }
    printCount() {
        console.info('Print count : ' + this.count);
    }
    count: number;
}

let callback = (eventData: emitter.GenericEventData<Sample>): void => {
   let storage: Sample = eventData.data!;
   storage.printCount();
}
// 取消eventID为"eventId"的事件回调处理函数
// 如果该回调处理函数没有被订阅，则不做任何处理
emitter.off("eventId", callback);

emitter.emit

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

发送指定的事件。

原子化服务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);

emitter.emit¹¹⁺

emit(eventId: string, data?: EventData): void

发送指定事件。

原子化服务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);

emitter.emit¹²⁺

emit<T>(eventId: string, data?: GenericEventData<T>): void

发送指定事件。

原子化服务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;
}

class SelfEventData implements emitter.EventData {
    data: Sample = new Sample();
}

let eventData = new SelfEventData();
emitter.emit("eventId", eventData);

emitter.emit¹¹⁺

emit(eventId: string, options: Options, data?: EventData): void

发送指定优先级事件。

原子化服务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);

emitter.emit¹²⁺

emit<T>(eventId: string, options: Options, data?: GenericEventData<T>): void

发送指定优先级事件。

原子化服务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;
}

class SelfEventData implements emitter.EventData {
    data: Sample = new Sample();
}

let options: emitter.Options = {
    priority: emitter.EventPriority.HIGH
};

let eventData = new SelfEventData();
emitter.emit("eventId", options, eventData);

emitter.getListenerCount¹¹⁺

getListenerCount(eventId: number | string): number

获取指定事件的订阅数。

原子化服务API： 从API version 11开始，该接口支持在原子化服务中使用。

系统能力: SystemCapability.Notification.Emitter

参数：

参数名	类型	必填	说明
eventId	number \| string	是	事件ID，string类型的eventId不支持空字符串。

示例：

let count = emitter.getListenerCount("eventId");

EventPriority

用于表示事件被发送的优先级。

原子化服务API： 从API version 11开始，该接口支持在原子化服务中使用。

系统能力: SystemCapability.Notification.Emitter

名称	值	说明
IMMEDIATE	0	表示事件被立即投递。
HIGH	1	表示事件先于LOW优先级投递。
LOW	2	表示事件优于IDLE优先级投递，事件的默认优先级是LOW。
IDLE	3	表示在没有其他事件的情况下，才投递该事件。

InnerEvent

订阅或发送的事件，订阅事件时EventPriority不生效。

原子化服务API： 从API version 11开始，该接口支持在原子化服务中使用。

系统能力: SystemCapability.Notification.Emitter

名称	类型	只读	可选	说明
eventId	number	否	否	事件ID，由开发者定义用来辨别事件。
priority	EventPriority	否	是	事件被投递的优先级。

EventData

发送事件时传递的数据。

原子化服务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，数据大小最大为16M。

Options¹¹⁺

发送事件的优先级。

原子化服务API： 从API version 11开始，该接口支持在原子化服务中使用。

系统能力: SystemCapability.Notification.Emitter

名称	类型	只读	可选	说明
priority	EventPriority	否	是	事件的优先级。

GenericEventData<T>¹²⁺

发送事件时传递的泛型数据。

原子化服务API： 从API version 12开始，该接口支持在原子化服务中使用。

系统能力: SystemCapability.Notification.Emitter

名称	类型	只读	可选	说明
data	T	否	是	发送事件时传递的数据。T：泛型类型。

@ohos.events.emitter (Emitter)

导入模块

权限列表

emitter.on

emitter.on11+

emitter.on12+

emitter.once

emitter.once11+

emitter.once12+

emitter.off

emitter.off11+

emitter.off10+

emitter.off11+

emitter.off12+

emitter.emit

emitter.emit11+

emitter.emit12+

emitter.emit11+

emitter.emit12+

emitter.getListenerCount11+

EventPriority

InnerEvent

EventData

Options11+

GenericEventData<T>12+

emitter.on¹¹⁺

emitter.on¹²⁺

emitter.once¹¹⁺

emitter.once¹²⁺

emitter.off¹¹⁺

emitter.off¹⁰⁺

emitter.off¹¹⁺

emitter.off¹²⁺

emitter.emit¹¹⁺

emitter.emit¹²⁺

emitter.emit¹¹⁺

emitter.emit¹²⁺

emitter.getListenerCount¹¹⁺

Options¹¹⁺

GenericEventData<T>¹²⁺