openharmony/interface_sdk-js
1
0
Fork 0
mirror of https://gitee.com/openharmony/interface_sdk-js synced 2024-10-07 14:13:45 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

add emitter supports string id

Browse Source 
Signed-off-by: xinking129 <xinxin13@huawei.com>
This commit is contained in:
xinking129 2023-11-30 19:49:11 +08:00
parent 76ffc50758
commit c881589ea2
1 changed files with 97 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

97
api/@ohos.events.emitter.d.ts vendored
View File

@ -50,6 +50,17 @@ declare namespace emitter {
*/
function on(event: InnerEvent, callback: Callback<EventData>): void;
/**
* Subscribe to a event by specific id in persistent manner and receives the event callback.
*
* @param { string } eventId - indicate ID of the event to subscribe to.
* @param { Callback<EventData> } callback - indicate callback used to receive the event.
* @syscap SystemCapability.Notification.Emitter
* @atomicservice
* @since 11
*/
function on(eventId: string, callback: Callback<EventData>): void;
/**
* Subscribe to a certain event in one-shot manner and unsubscribe from it
* after the event callback is received.
@ -71,6 +82,18 @@ declare namespace emitter {
*/
function once(event: InnerEvent, callback: Callback<EventData>): void;
/**
* Subscribe to a event by specific id in one-shot manner and unsubscribe from it
* after the event callback is received.
*
* @param { string } eventId - indicate ID of the event to subscribe to in one shot.
* @param { Callback<EventData> } callback - indicate callback used to receive the event.
* @syscap SystemCapability.Notification.Emitter
* @atomicservice
* @since 11
*/
function once(eventId: string, callback: Callback<EventData>): void;
/**
* Unsubscribe from an event.
*
@ -88,6 +111,16 @@ declare namespace emitter {
*/
function off(eventId: number): void;
/**
* Unsubscribe from an event.
*
* @param { string } eventId - indicate ID of the event to unsubscribe from.
* @syscap SystemCapability.Notification.Emitter
* @atomicservice
* @since 11
*/
function off(eventId: string): void;
/**
* Unsubscribe from an event.
*
@ -107,6 +140,17 @@ declare namespace emitter {
*/
function off(eventId: number, callback: Callback<EventData>): void;
/**
* Unsubscribe from an event.
*
* @param { string } eventId - indicates ID of the event to unsubscribe from.
* @param { Callback<EventData> } callback - indicates callback used to receive the event.
* @syscap SystemCapability.Notification.Emitter
* @atomicservice
* @since 11
*/
function off(eventId: string, callback: Callback<EventData>): void;
/**
* Emits an event to the event queue.
*
@ -126,6 +170,40 @@ declare namespace emitter {
*/
function emit(event: InnerEvent, data?: EventData): void;
/**
* Emits an event by specific id to the event queue.
*
* @param { string } eventId - indicate ID of the event to emit.
* @param { EventData } [data] - indicate data carried by the event.
* @syscap SystemCapability.Notification.Emitter
* @atomicservice
* @since 11
*/
function emit(eventId: string, data?: EventData): void;
/**
* Emits an event by specific id to the event queue.
*
* @param { string } eventId - indicate ID of the event to emit.
* @param { Options } options - Indicates the {@link Options} option of the emit priority of the event.
* @param { EventData } [data] - indicate data carried by the event.
* @syscap SystemCapability.Notification.Emitter
* @atomicservice
* @since 11
*/
function emit(eventId: string, options: Options, data?: EventData): void;
/**
* Obtains the number of subscribe listener count.
*
* @param { number | string } eventId - indicates ID of the event to unsubscribe from.
* @returns { number } Returns the number of listener count.
* @syscap SystemCapability.Notification.Emitter
* @atomicservice
* @since 11
*/
function getListenerCount(eventId: number | string): number;
/**
* Describes data passed in the event.
*
@ -287,6 +365,25 @@ declare namespace emitter {
*/
IDLE,
}
/**
* Describe the optional arguments of emit operation.
*
* @typedef Options
* @syscap SystemCapability.Notification.Emitter
* @since 11
*/
export interface Options {
/**
* Emit priority of the event. The default priority is {@link EventPriority.LOW}.
*
* @type { ?EventPriority }
* @syscap SystemCapability.Notification.Emitter
* @atomicservice
* @since 11
*/
priority?: EventPriority;
}
}
export default emitter;