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.

Usage

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");
        subscriber = commonEventSubscriber;
    }
}

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

getCode

getCode(callback: AsyncCallback<number>): void

Obtains the code of this 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 getCodeCB(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(getCodeCB);

getCode

getCode(): Promise<number>

Obtains the code of this 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}`);
});

getCodeSync10+

getCodeSync(): number

Obtains the code of this common event. This API returns the result synchronously.

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 code for this 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 setCodeCB(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");
    }
}
subscriber.setCode(1, setCodeCB);

setCode

setCode(code: number): Promise<void>

Sets the code for this 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");
}).catch((err:Base.BusinessError) => {
    console.error(`setCode failed, code is ${err.code}, message is ${err.message}`);
});

setCodeSync10+

setCodeSync(code: number): void

Sets the code for this common event. This API returns the result synchronously.

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 data of this 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 getDataCB(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(getDataCB);

getData

getData(): Promise<string>

Obtains the data of this 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}`);
});

getDataSync10+

getDataSync(): string

Obtains the data of this common event. This API returns the result synchronously.

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 data for this 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 setDataCB(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("setData");
    }
}
subscriber.setData("publish_data_changed", setDataCB);

setData

setData(data: string): Promise<void>

Sets the data for this 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");
}).catch((err:Base.BusinessError) => {
    console.error(`setCode failed, code is ${err.code}, message is ${err.message}`);
});

setDataSync10+

setDataSync(data: string): void

Sets the data for this common event. This API returns the result synchronously.

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 code and data for this 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 setCodeDataCB(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("setCodeDataCallback");
    }
}
subscriber.setCodeAndData(1, "publish_data_changed", setCodeDataCB);

setCodeAndData

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

Sets the code and data for this 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");
}).catch((err:Base.BusinessError) => {
    console.error(`setCodeAndData failed, code is ${err.code}, message is ${err.message}`);
});

setCodeAndDataSync10+

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

Sets the code and data for this common event. This API returns the result synchronously.

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(`setCodeAndData failed, code is ${err.code}, message is ${err.message}`);
}

isOrderedCommonEvent

isOrderedCommonEvent(callback: AsyncCallback<boolean>): void

Checks whether this common event is an ordered 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 an ordered one; returns false otherwise.

Example

// Callback for checking whether the current common event is an ordered one.
function isOrderedCB(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("isOrdered " + JSON.stringify(isOrdered));
    }
}
subscriber.isOrderedCommonEvent(isOrderedCB);

isOrderedCommonEvent

isOrderedCommonEvent(): Promise<boolean>

Checks whether this common event is an ordered 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 an ordered one; returns false otherwise.

Example

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

isOrderedCommonEventSync10+

isOrderedCommonEventSync(): boolean

Checks whether this common event is an ordered one. This API returns the result synchronously.

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("isOrdered " + JSON.stringify(isOrdered));

isStickyCommonEvent

isStickyCommonEvent(callback: AsyncCallback<boolean>): void

Checks whether this 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 isStickyCB(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("isSticky " + JSON.stringify(isSticky));
    }
}
subscriber.isStickyCommonEvent(isStickyCB);

isStickyCommonEvent

isStickyCommonEvent(): Promise<boolean>

Checks whether this 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("isSticky " + JSON.stringify(isSticky));
}).catch((err:Base.BusinessError) => {
    console.error(`isSticky failed, code is ${err.code}, message is ${err.message}`);
});

isStickyCommonEventSync10+

isStickyCommonEventSync(): boolean

Checks whether this common event is a sticky one. This API returns the result synchronously.

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("isSticky " + 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. It 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 abortCB(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");
    }
}
subscriber.abortCommonEvent(abortCB);

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. It 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");
}).catch((err:Base.BusinessError) => {
    console.error(`abortCommonEvent failed, code is ${err.code}, message is ${err.message}`);
});

abortCommonEventSync10+

abortCommonEventSync(): void

Aborts this common event. After the abort, the common event is not sent to the next subscriber. This API returns the result synchronously.

System capability: SystemCapability.Notification.CommonEvent

Example

subscriber.abortCommonEventSync();

clearAbortCommonEvent

clearAbortCommonEvent(callback: AsyncCallback<void>): void

Clears the aborted state of this common event. This API takes effect only for ordered common events. It 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 clearAbortCB(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");
    }
}
subscriber.clearAbortCommonEvent(clearAbortCB);

clearAbortCommonEvent

clearAbortCommonEvent(): Promise<void>

Clears the aborted state of this common event. This API takes effect only for ordered common events. It 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");
}).catch((err:Base.BusinessError) => {
    console.error(`clearAbortCommonEvent failed, code is ${err.code}, message is ${err.message}`);
});

clearAbortCommonEventSync10+

clearAbortCommonEventSync(): void

Clears the aborted state of this common event. This API returns the result synchronously.

System capability: SystemCapability.Notification.CommonEvent

Example

subscriber.clearAbortCommonEventSync();

getAbortCommonEvent

getAbortCommonEvent(callback: AsyncCallback<boolean>): void

Checks whether this common event is in the aborted state. This API takes effect only for ordered common events. It 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 getAbortCB(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("abortCommonEvent " + abortEvent)
    }
}
subscriber.getAbortCommonEvent(getAbortCB);

getAbortCommonEvent

getAbortCommonEvent(): Promise<boolean>

Checks whether this common event is in the aborted state. This API takes effect only for ordered common events. It 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("abortCommonEvent " + JSON.stringify(abortEvent));
}).catch((err:Base.BusinessError) => {
    console.error(`getAbortCommonEvent failed, code is ${err.code}, message is ${err.message}`);
});

getAbortCommonEventSync10+

getAbortCommonEventSync(): boolean

Checks whether this common event is in the aborted state. This API returns the result synchronously.

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 Callback used to return the subscriber information.

Example

// Callback for subscriber information obtaining.
function getCB(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("subscribeInfo " + JSON.stringify(subscribeInfo));
    }
}
subscriber.getSubscribeInfo(getCB);

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> Promise used to return the subscriber information.

Example

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

getSubscribeInfoSync10+

getSubscribeInfoSync(): CommonEventSubscribeInfo

Obtains the subscriber information. This API returns the result synchronously.

System capability: SystemCapability.Notification.CommonEvent

Return value

Type Description
CommonEventSubscribeInfo Callback used to return the subscriber information.

Example

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

finishCommonEvent9+

finishCommonEvent(callback: AsyncCallback<void>): void

Finishes this common event. This API takes effect only for ordered common events. It 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 finishCB(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");
  }
}

subscriber.finishCommonEvent(finishCB);

finishCommonEvent9+

finishCommonEvent(): Promise<void>

Finishes this common event. This API takes effect only for ordered common events. It 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");
}).catch((err:Base.BusinessError) => {
    console.error(`finishCommonEvent failed, code is ${err.code}, message is ${err.message}`);
});