CommonEventSubscriber

The CommonEventSubscriber module provides APIs for describing the common event subscriber.

NOTE

The initial APIs of this module are supported since API version 7. Newly added APIs will be marked with a superscript to indicate their earliest API version.

How to Use

Before using the CommonEventSubscriber module, you must obtain a subscriber object by calling CommonEvent.createSubscriber.

import CommonEvent from '@ohos.commonEvent';
import CommonEventManager from '@ohos.commonEventManager';
import Base from '@ohos.base';
let subscriber:CommonEventManager.CommonEventSubscriber; // Used to save the created subscriber object for subsequent subscription and unsubscription.

// Subscriber information.
let subscribeInfo:CommonEventManager.CommonEventSubscribeInfo = {
	events: ["event"]
};

// Callback for subscriber creation.
function createCB(err:Base.BusinessError, commonEventSubscriber:CommonEventManager.CommonEventSubscriber) {
    if (err.code !== undefined && err.code != null) {
        console.error(`createSubscriber failed, code is ${err.code}`);
    } else {
        console.info("createSubscriber success");
        subscriber = commonEventSubscriber;
    }
}

// Create a subscriber.
CommonEvent.createSubscriber(subscribeInfo, createCB);

getCode

getCode(callback: AsyncCallback<number>): void

Obtains the result code of an ordered common event. This API uses an asynchronous callback to return the result.

System capability: SystemCapability.Notification.CommonEvent

Parameters

Name	Type	Mandatory	Description
callback	AsyncCallback<number>	Yes	Common event code.

Example

// Callback for result code obtaining of an ordered common event.
function getCodeCallback(err:Base.BusinessError, code:number) {
    if (err.code !== undefined && err.code != null) {
        console.error(`getCode failed, code is ${err.code}, message is ${err.message}`);
    } else {
        console.info("getCode " + JSON.stringify(code));
    }
}
subscriber.getCode(getCodeCallback);

getCode

getCode(): Promise<number>

Obtains the result code of an ordered common event. This API uses a promise to return the result.

System capability: SystemCapability.Notification.CommonEvent

Return value

Type	Description
Promise<number>	Common event code.

Example

subscriber.getCode().then((code:number) => {
    console.info("getCode " + JSON.stringify(code));
}).catch((err:Base.BusinessError) => {
    console.error(`getCode failed, code is ${err.code}, message is ${err.message}`);
});

getCodeSync¹⁰⁺

getCodeSync(): number

Obtains the result code of an ordered common event.

System capability: SystemCapability.Notification.CommonEvent

Return value

Type	Description
number	Common event code.

Example

let code = subscriber.getCodeSync();
console.info("getCodeSync " + JSON.stringify(code));

setCode

setCode(code: number, callback: AsyncCallback<void>): void

Sets the result code of an ordered common event. This API uses an asynchronous callback to return the result.

System capability: SystemCapability.Notification.CommonEvent

Parameters

Name	Type	Mandatory	Description
code	number	Yes	Common event code.
callback	AsyncCallback<void>	Yes	Callback used to return the result.

Example

// Callback for result code setting of an ordered common event.
function setCodeCallback(err:Base.BusinessError) {
    if (err.code !== undefined && err.code != null) {
        console.error(`setCode failed, code is ${err.code}, message is ${err.message}`);
    } else {
        console.info("setCode success");
    }
}
subscriber.setCode(1, setCodeCallback);

setCode

setCode(code: number): Promise<void>

Sets the result code of an ordered common event. This API uses a promise to return the result.

System capability: SystemCapability.Notification.CommonEvent

Parameters

Name	Type	Mandatory	Description
code	number	Yes	Common event code.

Return value

Type	Description
Promise<void>	Promise used to return the result.

Example

subscriber.setCode(1).then(() => {
    console.info("setCode success");
}).catch((err:Base.BusinessError) => {
    console.error(`setCode failed, code is ${err.code}, message is ${err.message}`);
});

setCodeSync¹⁰⁺

setCodeSync(code: number): void

Sets the result code of an ordered common event.

System capability: SystemCapability.Notification.CommonEvent

Parameters

Name	Type	Mandatory	Description
code	number	Yes	Common event code.

Example

try {
    subscriber.setCodeSync(1);
} catch (error) {
    let err:Base.BusinessError = error as Base.BusinessError;
    console.error(`setCodeSync failed, code is ${err.code}, message is ${err.message}`);
}

getData

getData(callback: AsyncCallback<string>): void

Obtains the result data of an ordered common event. This API uses an asynchronous callback to return the result.

System capability: SystemCapability.Notification.CommonEvent

Parameters

Name	Type	Mandatory	Description
callback	AsyncCallback<string>	Yes	Common event data.

Example

// Callback for result data obtaining of an ordered common event.
function getDataCallback(err:Base.BusinessError, data:string) {
    if (err.code !== undefined && err.code != null) {
        console.error(`getData failed, code is ${err.code}, message is ${err.message}`);
    } else {
        console.info("getData " + JSON.stringify(data));
    }
}
subscriber.getData(getDataCallback);

getData

getData(): Promise<string>

Obtains the result data of an ordered common event. This API uses a promise to return the result.

System capability: SystemCapability.Notification.CommonEvent

Return value

Type	Description
Promise<string>	Common event data.

Example

subscriber.getData().then((data:string) => {
    console.info("getData " + JSON.stringify(data));
}).catch((err:Base.BusinessError) => {
    console.error(`getData failed, code is ${err.code}, message is ${err.message}`);
});

getDataSync¹⁰⁺

getDataSync(): string

Obtains the result data of an ordered common event.

System capability: SystemCapability.Notification.CommonEvent

Return value

Type	Description
string	Common event data.

Example

let data = subscriber.getDataSync();
console.info("getDataSync " + JSON.stringify(data));

setData

setData(data: string, callback: AsyncCallback<void>): void

Sets the result data for an ordered common event. This API uses an asynchronous callback to return the result.

System capability: SystemCapability.Notification.CommonEvent

Parameters

Name	Type	Mandatory	Description
data	string	Yes	Common event data.
callback	AsyncCallback<void>	Yes	Callback used to return the result.

Example

// Callback for result data setting of an ordered common event
function setDataCallback(err:Base.BusinessError) {
    if (err.code !== undefined && err.code != null) {
        console.error(`setData failed, code is ${err.code}, message is ${err.message}`);
    } else {
        console.info("setData success");
    }
}
subscriber.setData("publish_data_changed", setDataCallback);

setData

setData(data: string): Promise<void>

Sets the result data for an ordered common event. This API uses a promise to return the result.

System capability: SystemCapability.Notification.CommonEvent

Parameters

Name	Type	Mandatory	Description
data	string	Yes	Common event data.

Return value

Type	Description
Promise<void>	Promise used to return the result.

Example

subscriber.setData("publish_data_changed").then(() => {
    console.info("setData success");
}).catch((err:Base.BusinessError) => {
    console.error(`setData failed, code is ${err.code}, message is ${err.message}`);
});

setDataSync¹⁰⁺

setDataSync(data: string): void

Sets the result data for an ordered common event.

System capability: SystemCapability.Notification.CommonEvent

Parameters

Name	Type	Mandatory	Description
data	string	Yes	Common event data.

Example

try {
    subscriber.setDataSync("publish_data_changed");
} catch (error) {
    let err:Base.BusinessError = error as Base.BusinessError;
    console.error(`setDataSync failed, code is ${err.code}, message is ${err.message}`);
}

setCodeAndData

setCodeAndData(code: number, data: string, callback:AsyncCallback<void>): void

Sets the result code and data of an ordered common event. This API uses an asynchronous callback to return the result.

System capability: SystemCapability.Notification.CommonEvent

Parameters

Name	Type	Mandatory	Description
code	number	Yes	Common event code.
data	string	Yes	Common event data.
callback	AsyncCallback<void>	Yes	Callback used to return the result.

Example

// Callback for code and data setting of an ordered common event.
function setCodeAndDataCallback(err:Base.BusinessError) {
    if (err.code !== undefined && err.code != null) {
        console.error(`setCodeAndData failed, code is ${err.code}, message is ${err.message}`);
    } else {
        console.info("setCodeAndData success");
    }
}
subscriber.setCodeAndData(1, "publish_data_changed", setCodeAndDataCallback);

setCodeAndData

setCodeAndData(code: number, data: string): Promise<void>

Sets the result code and data of an ordered common event. This API uses a promise to return the result.

System capability: SystemCapability.Notification.CommonEvent

Parameters

Name	Type	Mandatory	Description
code	number	Yes	Common event code.
data	string	Yes	Common event data.

Return value

Type	Description
Promise<void>	Promise used to return the result.

Example

subscriber.setCodeAndData(1, "publish_data_changed").then(() => {
    console.info("setCodeAndData success");
}).catch((err:Base.BusinessError) => {
    console.error(`setCodeAndData failed, code is ${err.code}, message is ${err.message}`);
});

setCodeAndDataSync¹⁰⁺

setCodeAndDataSync(code: number, data: string): void

Sets the result code and data of an ordered common event.

System capability: SystemCapability.Notification.CommonEvent

Parameters

Name	Type	Mandatory	Description
code	number	Yes	Common event code.
data	string	Yes	Common event data.

Example

try {
    subscriber.setCodeAndDataSync(1, "publish_data_changed");
} catch (error) {
    let err:Base.BusinessError = error as Base.BusinessError;
    console.error(`setCodeAndDataSync failed, code is ${err.code}, message is ${err.message}`);
}

isOrderedCommonEvent

isOrderedCommonEvent(callback: AsyncCallback<boolean>): void

Checks whether the current common event is an ordered common event. This API uses an asynchronous callback to return the result.

System capability: SystemCapability.Notification.CommonEvent

Parameters

Name	Type	Mandatory	Description
callback	AsyncCallback<boolean>	Yes	Returns true if the common event is an ordered one; returns false otherwise.

Example

// Callback for checking whether the current common event is an ordered one.
function isOrderedCommonEventCallback(err:Base.BusinessError, isOrdered:boolean) {
    if (err.code !== undefined && err.code != null) {
        console.error(`isOrderedCommonEvent failed, code is ${err.code}, message is ${err.message}`);
    } else {
        console.info("isOrderedCommonEvent " + JSON.stringify(isOrdered));
    }
}
subscriber.isOrderedCommonEvent(isOrderedCommonEventCallback);

isOrderedCommonEvent

isOrderedCommonEvent(): Promise<boolean>

Checks whether the current common event is an ordered common event. This API uses a promise to return the result.

System capability: SystemCapability.Notification.CommonEvent

Return value

Type	Description
Promise<boolean>	Returns true if the common event is an ordered one; returns false otherwise.

Example

subscriber.isOrderedCommonEvent().then((isOrdered:boolean) => {
    console.info("isOrderedCommonEvent " + JSON.stringify(isOrdered));
}).catch((err:Base.BusinessError) => {
    console.error(`isOrderedCommonEvent failed, code is ${err.code}, message is ${err.message}`);
});

isOrderedCommonEventSync¹⁰⁺

isOrderedCommonEventSync(): boolean

Checks whether the current common event is an ordered common event.

System capability: SystemCapability.Notification.CommonEvent

Return value

Type	Description
boolean	Returns true if the common event is an ordered one; returns false otherwise.

Example

let isOrdered  = subscriber.isOrderedCommonEventSync();
console.info("isOrderedCommonEventSync " + JSON.stringify(isOrdered));

isStickyCommonEvent

isStickyCommonEvent(callback: AsyncCallback<boolean>): void

Checks whether a common event is a sticky one. This API uses an asynchronous callback to return the result.

System capability: SystemCapability.Notification.CommonEvent

Parameters

Name	Type	Mandatory	Description
callback	AsyncCallback<boolean>	Yes	Returns true if the common event is a sticky one; returns false otherwise.

Example

// Callback for checking whether the current common event is a sticky one.
function isStickyCommonEventCallback(err:Base.BusinessError, isSticky:boolean) {
    if (err.code !== undefined && err.code != null) {
        console.error(`isStickyCommonEvent failed, code is ${err.code}, message is ${err.message}`);
    } else {
        console.info("isStickyCommonEvent " + JSON.stringify(isSticky));
    }
}
subscriber.isStickyCommonEvent(isStickyCommonEventCallback);

isStickyCommonEvent

isStickyCommonEvent(): Promise<boolean>

Checks whether a common event is a sticky one. This API uses a promise to return the result.

System capability: SystemCapability.Notification.CommonEvent

Return value

Type	Description
Promise<boolean>	Returns true if the common event is a sticky one; returns false otherwise.

Example

subscriber.isStickyCommonEvent().then((isSticky:boolean) => {
    console.info("isStickyCommonEvent " + JSON.stringify(isSticky));
}).catch((err:Base.BusinessError) => {
    console.error(`isStickyCommonEvent failed, code is ${err.code}, message is ${err.message}`);
});

isStickyCommonEventSync¹⁰⁺

isStickyCommonEventSync(): boolean

Checks whether a common event is a sticky one.

System capability: SystemCapability.Notification.CommonEvent

Return value

Type	Description
boolean	Returns true if the common event is a sticky one; returns false otherwise.

Example

let isSticky  = subscriber.isStickyCommonEventSync();
console.info("isStickyCommonEventSync " + JSON.stringify(isSticky));

abortCommonEvent

abortCommonEvent(callback: AsyncCallback<void>): void

Aborts this common event. After the abort, the common event is not sent to the next subscriber. This API takes effect only for ordered common events. This API uses an asynchronous callback to return the result.

System capability: SystemCapability.Notification.CommonEvent

Parameters

Name	Type	Mandatory	Description
callback	AsyncCallback<void>	Yes	Callback used to return the result.

Example

// Callback for common event aborting.
function abortCommonEventCallback(err:Base.BusinessError) {
    if (err.code !== undefined && err.code != null) {
		console.error(`abortCommonEvent failed, code is ${err.code}, message is ${err.message}`);
    } else {
        console.info("abortCommonEvent success");
    }
}
subscriber.abortCommonEvent(abortCommonEventCallback);

abortCommonEvent

abortCommonEvent(): Promise<void>

Aborts this common event. After the abort, the common event is not sent to the next subscriber. This API takes effect only for ordered common events. This API uses a promise to return the result.

System capability: SystemCapability.Notification.CommonEvent

Return value

Type	Description
Promise<void>	Promise used to return the result.

Example

subscriber.abortCommonEvent().then(() => {
    console.info("abortCommonEvent success");
}).catch((err:Base.BusinessError) => {
    console.error(`abortCommonEvent failed, code is ${err.code}, message is ${err.message}`);
});

abortCommonEventSync¹⁰⁺

abortCommonEventSync(): void

Aborts this common event. After the abort, the common event is not sent to the next subscriber. This API takes effect only for ordered common events.

System capability: SystemCapability.Notification.CommonEvent

Example

subscriber.abortCommonEventSync();

clearAbortCommonEvent

clearAbortCommonEvent(callback: AsyncCallback<void>): void

Clears this ordered common event. This API uses an asynchronous callback to return the result.

System capability: SystemCapability.Notification.CommonEvent

Parameters

Name	Type	Mandatory	Description
callback	AsyncCallback<void>	Yes	Callback used to return the result.

Example

// Callback for clearing the aborted state of the current common event.
function clearAbortCommonEventCallback(err:Base.BusinessError) {
    if (err.code !== undefined && err.code != null) {
        console.error(`clearAbortCommonEvent failed, code is ${err.code}, message is ${err.message}`);
    } else {
        console.info("clearAbortCommonEvent success");
    }
}
subscriber.clearAbortCommonEvent(clearAbortCommonEventCallback);

clearAbortCommonEvent

clearAbortCommonEvent(): Promise<void>

Clears this ordered common event. This API uses a promise to return the result.

System capability: SystemCapability.Notification.CommonEvent

Return value

Type	Description
Promise<void>	Promise used to return the result.

Example

subscriber.clearAbortCommonEvent().then(() => {
    console.info("clearAbortCommonEvent success");
}).catch((err:Base.BusinessError) => {
    console.error(`clearAbortCommonEvent failed, code is ${err.code}, message is ${err.message}`);
});

clearAbortCommonEventSync¹⁰⁺

clearAbortCommonEventSync(): void

Clears this ordered common event.

System capability: SystemCapability.Notification.CommonEvent

Example

subscriber.clearAbortCommonEventSync();

getAbortCommonEvent

getAbortCommonEvent(callback: AsyncCallback<boolean>): void

Checks whether this ordered common event should be aborted. This API uses an asynchronous callback to return the result.

System capability: SystemCapability.Notification.CommonEvent

Parameters

Name	Type	Mandatory	Description
callback	AsyncCallback<boolean>	Yes	Returns true if the ordered common event is in the aborted state; returns false otherwise.

Example

// Callback for checking whether the current common event is in the aborted state.
function getAbortCommonEventCallback(err:Base.BusinessError, abortEvent:boolean) {
    if (err.code !== undefined && err.code != null) {
        console.error(`getAbortCommonEvent failed, code is ${err.code}, message is ${err.message}`);
    } else {
        console.info("getAbortCommonEvent " + JSON.stringify(abortEvent));
    }
}
subscriber.getAbortCommonEvent(getAbortCommonEventCallback);

getAbortCommonEvent

getAbortCommonEvent(): Promise<boolean>

Checks whether this ordered common event should be aborted. This API uses a promise to return the result.

System capability: SystemCapability.Notification.CommonEvent

Return value

Type	Description
Promise<boolean>	Returns true if the ordered common event is in the aborted state; returns false otherwise.

Example

subscriber.getAbortCommonEvent().then((abortEvent:boolean) => {
    console.info("getAbortCommonEvent " + JSON.stringify(abortEvent));
}).catch((err:Base.BusinessError) => {
    console.error(`getAbortCommonEvent failed, code is ${err.code}, message is ${err.message}`);
});

getAbortCommonEventSync¹⁰⁺

getAbortCommonEventSync(): boolean

Checks whether this ordered common event should be aborted.

System capability: SystemCapability.Notification.CommonEvent

Return value

Type	Description
boolean	Returns true if the ordered common event is in the aborted state; returns false otherwise.

Example

let abortEvent = subscriber.getAbortCommonEventSync();
console.info("getAbortCommonEventSync " + JSON.stringify(abortEvent));

getSubscribeInfo

getSubscribeInfo(callback: AsyncCallback<CommonEventSubscribeInfo>): void

Obtains the subscriber information. This API uses an asynchronous callback to return the result.

System capability: SystemCapability.Notification.CommonEvent

Parameters

Name	Type	Mandatory	Description
callback	AsyncCallback<CommonEventSubscribeInfo>	Yes	Returns the subscriber information.

Example

// Callback for subscriber information obtaining.
function getSubscribeInfoCallback(err:Base.BusinessError, subscribeInfo:CommonEventManager.CommonEventSubscribeInfo) {
    if (err.code !== undefined && err.code != null) {
        console.error(`getSubscribeInfo failed, code is ${err.code}, message is ${err.message}`);
    } else {
        console.info("getSubscribeInfo " + JSON.stringify(subscribeInfo));
    }
}
subscriber.getSubscribeInfo(getSubscribeInfoCallback);

getSubscribeInfo

getSubscribeInfo(): Promise<CommonEventSubscribeInfo>

Obtains the subscriber information. This API uses a promise to return the result.

System capability: SystemCapability.Notification.CommonEvent

Return value

Type	Description
Promise<CommonEventSubscribeInfo>	Returns the subscriber information.

Example

subscriber.getSubscribeInfo().then((subscribeInfo:CommonEventManager.CommonEventSubscribeInfo) => {
    console.info("getSubscribeInfo " + JSON.stringify(subscribeInfo));
}).catch((err:Base.BusinessError) => {
    console.error(`getSubscribeInfo failed, code is ${err.code}, message is ${err.message}`);
});

getSubscribeInfoSync¹⁰⁺

getSubscribeInfoSync(): CommonEventSubscribeInfo

Obtains the subscriber information.

System capability: SystemCapability.Notification.CommonEvent

Return value

Type	Description
CommonEventSubscribeInfo	Returns the subscriber information.

Example

let subscribeInfo = subscriber.getSubscribeInfoSync();
console.info("getSubscribeInfoSync " + JSON.stringify(subscribeInfo));

finishCommonEvent⁹⁺

finishCommonEvent(callback: AsyncCallback<void>): void

Finishes this ordered common event. This API uses an asynchronous callback to return the result.

System capability: SystemCapability.Notification.CommonEvent

Parameters

Name	Type	Mandatory	Description
callback	AsyncCallback<void>	Yes	Callback returned after the ordered common event is finished.

Example

// Callback for ordered common event finishing.
function finishCommonEventCallback(err:Base.BusinessError) {
  if (err.code !== undefined && err.code != null) {
    console.error(`finishCommonEvent failed, code is ${err.code}, message is ${err.message}`);
  } else {
    console.info("finishCommonEvent success");
  }
}
subscriber.finishCommonEvent(finishCommonEventCallback);

finishCommonEvent⁹⁺

finishCommonEvent(): Promise<void>

Finishes this ordered common event. This API uses a promise to return the result.

System capability: SystemCapability.Notification.CommonEvent

Return value

Type	Description
Promise<void>	Promise used to return the result.

Example

subscriber.finishCommonEvent().then(() => {
    console.info("finishCommonEvent success");
}).catch((err:Base.BusinessError) => {
    console.error(`finishCommonEvent failed, code is ${err.code}, message is ${err.message}`);
});