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 commonEventManager.createSubscriber.

import { commonEventManager } from '@kit.BasicServicesKit';
import { BusinessError } from '@kit.BasicServicesKit';

// Define a subscriber to save the created subscriber object for subsequent subscription and unsubscription.
let subscriber: commonEventManager.CommonEventSubscriber;
// Subscriber information.
let subscribeInfo: commonEventManager.CommonEventSubscribeInfo = {
	events: ["event"]
};
// Callback for subscriber creation.
function createCB(err: BusinessError, commonEventSubscriber: commonEventManager.CommonEventSubscriber) {
  if (err != null) {
    console.error(`Failed to create subscriber. Code is ${err.code}, message is ${err.message}`);
  } else {
    console.info(`Succeeded in creating subscriber`);
    subscriber = commonEventSubscriber;
  }
}
// Create a subscriber.
commonEventManager.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.

Atomic service API: This API can be used in atomic services since API version 11.

System capability: SystemCapability.Notification.CommonEvent

Parameters

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

Error codes

For details about the error codes, see Universal Error Codes.

ID	Error Message
401	Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. 2. Incorrect parameter types. 3.Parameter verification failed.

Example

// Callback for result code obtaining of an ordered common event.
function getCodeCallback(err: BusinessError, code: number) {
  if (err != null) {
    console.error(`Failed to get code. Code is ${err.code}, message is ${err.message}`);
  } else {
    console.info(`Succeeded in getting code, code is ` + 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.

Atomic service API: This API can be used in atomic services since API version 11.

System capability: SystemCapability.Notification.CommonEvent

Return value

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

Example

subscriber.getCode().then((code: number) => {
  console.info(`Succeeded in getting code, code is ` + JSON.stringify(code));
}).catch((err: BusinessError) => {
  console.error(`Failed to get code. Code is ${err.code}, message is ${err.message}`);
});

getCodeSync¹⁰⁺

getCodeSync(): number

Obtains the result code of an ordered common event.

Atomic service API: This API can be used in atomic services since API version 11.

System capability: SystemCapability.Notification.CommonEvent

Return value

Type	Description
number	Common event code.

Example

let code = subscriber.getCodeSync();
console.info(`Succeeded in getting code, code is ` + 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.

Atomic service API: This API can be used in atomic services since API version 11.

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.

Error codes

For details about the error codes, see Universal Error Codes.

ID	Error Message
401	Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. 2. Incorrect parameter types. 3.Parameter verification failed.

Example

// Callback for result code setting of an ordered common event.
function setCodeCallback(err: BusinessError) {
  if (err != null) {
    console.error(`Failed to set code. Code is ${err.code}, message is ${err.message}`);
  } else {
    console.info(`Succeeded in setting code.`);
  }
}
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.

Atomic service API: This API can be used in atomic services since API version 11.

System capability: SystemCapability.Notification.CommonEvent

Parameters

Name	Type	Mandatory	Description
code	number	Yes	Common event code.

Return value

Type	Description
Promise<void>	Promise that returns no value.

Error codes

For details about the error codes, see Universal Error Codes.

ID	Error Message
401	Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. 2. Incorrect parameter types. 3.Parameter verification failed.

Example

subscriber.setCode(1).then(() => {
  console.info(`Succeeded in setting code.`);
}).catch((err: BusinessError) => {
  console.error(`Failed to set code. Code is ${err.code}, message is ${err.message}`);
});

setCodeSync¹⁰⁺

setCodeSync(code: number): void

Sets the result code of an ordered common event.

Atomic service API: This API can be used in atomic services since API version 11.

System capability: SystemCapability.Notification.CommonEvent

Parameters

Name	Type	Mandatory	Description
code	number	Yes	Common event code.

Error codes

For details about the error codes, see Universal Error Codes.

ID	Error Message
401	Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. 2. Incorrect parameter types. 3. Parameter verification failed.

Example

try {
  subscriber.setCodeSync(1);
} catch (error) {
  let err: BusinessError = error as BusinessError;
  console.error(`Failed to set code. 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.

Atomic service API: This API can be used in atomic services since API version 11.

System capability: SystemCapability.Notification.CommonEvent

Parameters

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

Error codes

For details about the error codes, see Universal Error Codes.

ID	Error Message
401	Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. 2. Incorrect parameter types. 3.Parameter verification failed.

Example

// Callback for result data obtaining of an ordered common event.
function getDataCallback(err: BusinessError, data: string) {
  if (err != null) {
    console.error(`Failed to get data. Code is ${err.code}, message is ${err.message}`);
  } else {
    console.info(`Succeeded in getting data, data is ` + 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.

Atomic service API: This API can be used in atomic services since API version 11.

System capability: SystemCapability.Notification.CommonEvent

Return value

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

Example

subscriber.getData().then((data: string) => {
  console.info(`Succeeded in getting data, data is ` + JSON.stringify(data));
}).catch((err: BusinessError) => {
  console.error(`Failed to get data. Code is ${err.code}, message is ${err.message}`);
});

getDataSync¹⁰⁺

getDataSync(): string

Obtains the result data of an ordered common event.

Atomic service API: This API can be used in atomic services since API version 11.

System capability: SystemCapability.Notification.CommonEvent

Return value

Type	Description
string	Common event data.

Example

let data = subscriber.getDataSync();
console.info(`Succeeded in getting data, data is ${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.

Atomic service API: This API can be used in atomic services since API version 11.

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.

Error codes

For details about the error codes, see Universal Error Codes.

ID	Error Message
401	Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. 2. Incorrect parameter types. 3.Parameter verification failed.

Example

// Callback for result data setting of an ordered common event
function setDataCallback(err: BusinessError) {
  if (err != null) {
    console.error(`Failed to set data. Code is ${err.code}, message is ${err.message}`);
  } else {
    console.info(`Succeeded in setting code.`);
  }
}
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.

Atomic service API: This API can be used in atomic services since API version 11.

System capability: SystemCapability.Notification.CommonEvent

Parameters

Name	Type	Mandatory	Description
data	string	Yes	Common event data.

Return value

Type	Description
Promise<void>	Promise that returns no value.

Error codes

For details about the error codes, see Universal Error Codes.

ID	Error Message
401	Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. 2. Incorrect parameter types. 3.Parameter verification failed.

Example

subscriber.setData("publish_data_changed").then(() => {
  console.info(`Succeeded in setting data.`);
}).catch((err: BusinessError) => {
  console.error(`Failed to set data. Code is ${err.code}, message is ${err.message}`);
});

setDataSync¹⁰⁺

setDataSync(data: string): void

Sets the result data for an ordered common event.

Atomic service API: This API can be used in atomic services since API version 11.

System capability: SystemCapability.Notification.CommonEvent

Parameters

Name	Type	Mandatory	Description
data	string	Yes	Common event data.

Error codes

For details about the error codes, see Universal Error Codes.

ID	Error Message
401	Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. 2. Incorrect parameter types. 3. Parameter verification failed.

Example

try {
  subscriber.setDataSync("publish_data_changed");
} catch (error) {
  let err: BusinessError = error as BusinessError;
  console.error(`Failed to set data. 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.

Atomic service API: This API can be used in atomic services since API version 11.

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.

Error codes

For details about the error codes, see Universal Error Codes.

ID	Error Message
401	Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. 2. Incorrect parameter types. 3.Parameter verification failed.

Example

// Callback for code and data setting of an ordered common event.
function setCodeAndDataCallback(err: BusinessError) {
  if (err != null) {
    console.error(`Failed to set code and data. Code is ${err.code}, message is ${err.message}`);
  } else {
    console.info(`Succeeded in setting code and data.`);
  }
}
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.

Atomic service API: This API can be used in atomic services since API version 11.

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 that returns no value.

Error codes

For details about the error codes, see Universal Error Codes.

ID	Error Message
401	Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. 2. Incorrect parameter types. 3.Parameter verification failed.

Example

subscriber.setCodeAndData(1, "publish_data_changed").then(() => {
  console.info(`Succeeded in setting code and data.`);
}).catch((err: BusinessError) => {
  console.error(`Failed to set code and data. 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.

Atomic service API: This API can be used in atomic services since API version 11.

System capability: SystemCapability.Notification.CommonEvent

Parameters

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

Error codes

For details about the error codes, see Universal Error Codes.

ID	Error Message
401	Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. 2. Incorrect parameter types. 3. Parameter verification failed.

Example

try {
  subscriber.setCodeAndDataSync(1, "publish_data_changed");
} catch (error) {
  let err: BusinessError = error as BusinessError;
  console.error(`Failed to set code and data. 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	Callback used to return the result. Returns true if the common event is an ordered one; returns false otherwise.

Error codes

For details about the error codes, see Universal Error Codes.

ID	Error Message
401	Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. 2. Incorrect parameter types. 3.Parameter verification failed.

Example

// Callback for checking whether the current common event is an ordered one.
function isOrderedCommonEventCallback(err: BusinessError, isOrdered:boolean) {
  if (err != 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>	Promise used to return the result. 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: 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	Callback used to return the result. Returns true if the common event is a sticky one; returns false otherwise.

Error codes

For details about the error codes, see Universal Error Codes.

ID	Error Message
401	Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. 2. Incorrect parameter types. 3.Parameter verification failed.

Example

// Callback for checking whether the current common event is a sticky one.
function isStickyCommonEventCallback(err: BusinessError, isSticky:boolean) {
  if (err != 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>	Promise used to return the result. 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: 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 an ordered common event when used with finishCommonEvent. After the abort, the common event is not sent to the next subscriber. 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.

Error codes

For details about the error codes, see Universal Error Codes.

ID	Error Message
401	Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. 2. Incorrect parameter types. 3.Parameter verification failed.

Example

// Callback for ordered common event aborting.
function abortCommonEventCallback(err: BusinessError) {
  if (err != null) {
    console.error(`Failed to abort common event. Code is ${err.code}, message is ${err.message}`);
  } else {
    console.info(`Succeeded in aborting common event.`);
  }
}
function finishCommonEventCallback(err: BusinessError) {
  if (err != null) {
    console.error(`Failed to finish common event. Code is ${err.code}, message is ${err.message}`);
  } else {
    console.info(`Succeeded in finishing common event.`);
  }
}
subscriber.abortCommonEvent(abortCommonEventCallback);
subscriber.finishCommonEvent(finishCommonEventCallback);

abortCommonEvent

abortCommonEvent(): Promise<void>

Aborts an ordered common event when used with finishCommonEvent. After the abort, the common event is not sent to the next subscriber. This API uses a promise to return the result.

System capability: SystemCapability.Notification.CommonEvent

Return value

Type	Description
Promise<void>	Promise that returns no value.

Example

subscriber.abortCommonEvent().then(() => {
  console.info(`Succeeded in aborting common event.`);
}).catch((err: BusinessError) => {
  console.error(`Failed to abort common event. Code is ${err.code}, message is ${err.message}`);
});
subscriber.finishCommonEvent().then(() => {
  console.info(`Succeeded in finishing common event.`);
}).catch((err: BusinessError) => {
  console.error(`Failed to finish common event. Code is ${err.code}, message is ${err.message}`);
});

abortCommonEventSync¹⁰⁺

abortCommonEventSync(): void

Aborts an ordered common event when used with finishCommonEvent. After the abort, the common event is not sent to the next subscriber.

System capability: SystemCapability.Notification.CommonEvent

Example

subscriber.abortCommonEventSync();
subscriber.finishCommonEvent().then(() => {
  console.info(`Succeeded in finishing common event.`);
}).catch((err: BusinessError) => {
  console.error(`Failed to finish common event. Code is ${err.code}, message is ${err.message}`);
});

clearAbortCommonEvent

clearAbortCommonEvent(callback: AsyncCallback<void>): void

Clears the aborted state of an ordered common event when used with finishCommonEvent. After the clearance, the common event is sent to the next subscriber. 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.

Error codes

For details about the error codes, see Universal Error Codes.

ID	Error Message
401	Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. 2. Incorrect parameter types. 3.Parameter verification failed.

Example

// Callback for clearing the aborted state of the current common event.
function clearAbortCommonEventCallback(err: BusinessError) {
  if (err != null) {
    console.error(`Failed to clear abort common event. Code is ${err.code}, message is ${err.message}`);
  } else {
    console.info(`Succeeded in clearing abort common event.`);
  }
}
function finishCommonEventCallback(err: BusinessError) {
  if (err != null) {
    console.error(`Failed to finish common event. Code is ${err.code}, message is ${err.message}`);
  } else {
    console.info(`Succeeded in finishing common event.`);
  }
}
subscriber.clearAbortCommonEvent(clearAbortCommonEventCallback);
subscriber.finishCommonEvent(finishCommonEventCallback);

clearAbortCommonEvent

clearAbortCommonEvent(): Promise<void>

Clears the aborted state of an ordered common event when used with finishCommonEvent. After the clearance, the common event is sent to the next subscriber. This API uses a promise to return the result.

System capability: SystemCapability.Notification.CommonEvent

Return value

Type	Description
Promise<void>	Promise that returns no value.

Example

subscriber.clearAbortCommonEvent().then(() => {
  console.info(`Succeeded in clearing abort common event.`);
}).catch((err: BusinessError) => {
  console.error(`Failed to clear abort common event. Code is ${err.code}, message is ${err.message}`);
});
subscriber.finishCommonEvent().then(() => {
  console.info(`Succeeded in finishing common event.`);
}).catch((err: BusinessError) => {
  console.error(`Failed to finish common event. Code is ${err.code}, message is ${err.message}`);
});

clearAbortCommonEventSync¹⁰⁺

clearAbortCommonEventSync(): void

Clears the aborted state of an ordered common event when used with finishCommonEvent. After the clearance, the common event is sent to the next subscriber.

System capability: SystemCapability.Notification.CommonEvent

Example

subscriber.clearAbortCommonEventSync();
subscriber.finishCommonEvent().then(() => {
  console.info(`Succeeded in finishing common event.`);
}).catch((err: BusinessError) => {
  console.error(`Failed to finish common event. Code is ${err.code}, message is ${err.message}`);
});

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	Callback used to return the result. Returns true if the ordered common event is in the aborted state; returns false otherwise.

Error codes

For details about the error codes, see Universal Error Codes.

ID	Error Message
401	Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. 2. Incorrect parameter types. 3.Parameter verification failed.

Example

// Callback for checking whether the ordered common event is in the aborted state.
function getAbortCommonEventCallback(err: BusinessError, abortEvent: boolean) {
  if (err != null) {
    console.error(`Failed to get abort common event. Code is ${err.code}, message is ${err.message}`);
  } else {
    console.info(`Succeeded in getting abort common event, abortEvent is ` + 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>	Promise used to return the result. Returns true if the ordered common event is in the aborted state; returns false otherwise.

Example

subscriber.getAbortCommonEvent().then((abortEvent: boolean) => {
  console.info(`Succeeded in getting abort common event, abortEvent is ` + JSON.stringify(abortEvent));
}).catch((err: BusinessError) => {
  console.error(`Failed to get abort common event. 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(`Succeeded in getting abort common event, abortEvent is ` + JSON.stringify(abortEvent));

getSubscribeInfo

getSubscribeInfo(callback: AsyncCallback<CommonEventSubscribeInfo>): void

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

Atomic service API: This API can be used in atomic services since API version 11.

System capability: SystemCapability.Notification.CommonEvent

Parameters

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

Error codes

For details about the error codes, see Universal Error Codes.

ID	Error Message
401	Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. 2. Incorrect parameter types. 3.Parameter verification failed.

Example

// Callback for subscriber information obtaining.
function getSubscribeInfoCallback(err: BusinessError, subscribeInfo: commonEventManager.CommonEventSubscribeInfo) {
  if (err != null) {
    console.error(`Failed to get subscribe info. Code is ${err.code}, message is ${err.message}`);
  } else {
    console.info(`Succeeded in getting subscribe info, subscribe info is ` + JSON.stringify(subscribeInfo));
  }
}
subscriber.getSubscribeInfo(getSubscribeInfoCallback);

getSubscribeInfo

getSubscribeInfo(): Promise<CommonEventSubscribeInfo>

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

Atomic service API: This API can be used in atomic services since API version 11.

System capability: SystemCapability.Notification.CommonEvent

Return value

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

Example

subscriber.getSubscribeInfo().then((subscribeInfo: commonEventManager.CommonEventSubscribeInfo) => {
  console.info(`Succeeded in getting subscribe info, subscribe info is ` + JSON.stringify(subscribeInfo));
}).catch((err: BusinessError) => {
  console.error(`Failed to get subscribe info. Code is ${err.code}, message is ${err.message}`);
});

getSubscribeInfoSync¹⁰⁺

getSubscribeInfoSync(): CommonEventSubscribeInfo

Obtains the subscriber information.

Atomic service API: This API can be used in atomic services since API version 11.

System capability: SystemCapability.Notification.CommonEvent

Return value

Type	Description
CommonEventSubscribeInfo	Subscriber information.

Example

let subscribeInfo = subscriber.getSubscribeInfoSync();
console.info(`Succeeded in getting subscribe info, subscribe info is ` + 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 used to return the result.

Error codes

For details about the error codes, see Universal Error Codes.

ID	Error Message
401	Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. 2. Incorrect parameter types. 3.Parameter verification failed.

Example

// Callback for ordered common event finishing.
function finishCommonEventCallback(err: BusinessError) {
  if (err != null) {
    console.error(`Failed to finish common event. Code is ${err.code}, message is ${err.message}`);
  } else {
    console.info(`Succeeded in finishing common event.`);
  }
}
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 that returns no value.

Example

subscriber.finishCommonEvent().then(() => {
  console.info(`Succeeded in finishing common event.`);
}).catch((err: BusinessError) => {
  console.error(`Failed to finish common event. Code is ${err.code}, message is ${err.message}`);
});