公共事件的能力

2024-01-23 12:58 更新

本模块提供了公共事件的能力,包括公共事件的权限列表,发布公共事件,订阅或取消订阅公共事件,获取或修改公共事件结果代码、结果数据等。

说明

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

导入模块

  1. import CommonEventManager from '@ohos.commonEventManager';

Support

系统公共事件是指由系统服务或系统应用发布的事件,订阅这些系统公共事件需要特定的权限。发布或订阅这些事件需要使用如下链接中的枚举定义。

全部系统公共事件枚举定义请参见系统公共事件定义

CommonEventManager.publish

publish(event: string, callback: AsyncCallback<void>): void

发布公共事件(callback形式)。

系统能力: SystemCapability.Notification.CommonEvent

参数:

参数名

类型

必填

说明

event

string

表示要发送的公共事件。

callback

AsyncCallback<void>

表示被指定的回调方法。

错误码:

以下错误码详细介绍请参考@ohos.commonEventManager(事件)

错误码ID

错误信息

1500004

not System services or System app

1500007

message send error

1500008

CEMS error

1500009

system error

示例:

  1. //发布公共事件回调
  2. function publishCallBack(err) {
  3. if (err) {
  4. console.error("publish failed " + JSON.stringify(err));
  5. } else {
  6. console.info("publish");
  7. }
  8. }
  9. //发布公共事件
  10. try {
  11. CommonEventManager.publish("event", publishCallBack);
  12. } catch(err) {
  13. console.error('publish failed, catch error' + JSON.stringify(err));
  14. }

CommonEventManager.publish

publish(event: string, options: CommonEventPublishData, callback: AsyncCallback<void>): void

发布公共事件指定发布信息(callback形式)。

系统能力: SystemCapability.Notification.CommonEvent

参数:

参数名

类型

必填

说明

event

string

表示要发布的公共事件。

options

CommonEventPublishData

表示发布公共事件的属性。

callback

syncCallback<void>

表示被指定的回调方法。

错误码:

错误码ID

错误信息

1500004

not System services or System app

1500007

message send error

1500008

CEMS error

1500009

system error

示例:

  1. //公共事件相关信息
  2. var options = {
  3. code: 0, //公共事件的初始代码
  4. data: "initial data",//公共事件的初始数据
  5. isOrdered: true //有序公共事件
  6. }
  7. //发布公共事件回调
  8. function publishCallBack(err) {
  9. if (err) {
  10. console.error("publish failed " + JSON.stringify(err));
  11. } else {
  12. console.info("publish");
  13. }
  14. }
  15. //发布公共事件
  16. try {
  17. CommonEventManager.publish("event", options, publishCallBack);
  18. } catch (err) {
  19. console.error('publish failed, catch error' + JSON.stringify(err));
  20. }

CommonEventManager.createSubscriber

createSubscriber(subscribeInfo: CommonEventSubscribeInfo, callback: AsyncCallback<CommonEventSubscriber>): void

创建订阅者(callback形式)。

系统能力: SystemCapability.Notification.CommonEvent

参数:

参数名

类型

必填

说明

subscribeInfo

CommonEventSubscribeInfo

表示订阅信息。

callback

AsyncCallback<CommonEventSubscriber>

表示创建订阅者的回调方法。

示例:

  1. var subscriber; //用于保存创建成功的订阅者对象,后续使用其完成订阅及退订的动作
  2. //订阅者信息
  3. var subscribeInfo = {
  4. events: ["event"]
  5. };
  6. //创建订阅者回调
  7. function createSubscriberCallBack(err, commonEventSubscriber) {
  8. if(!err) {
  9. console.info("createSubscriber");
  10. subscriber = commonEventSubscriber;
  11. } else {
  12. console.error("createSubscriber failed " + JSON.stringify(err));
  13. }
  14. }
  15. //创建订阅者
  16. try {
  17. CommonEventManager.createSubscriber(subscribeInfo, createSubscriberCallBack);
  18. } catch (err) {
  19. console.error('createSubscriber failed, catch error' + JSON.stringify(err));
  20. }

CommonEventManager.createSubscriber

createSubscriber(subscribeInfo: CommonEventSubscribeInfo): Promise<CommonEventSubscriber>

创建订阅者(Promise形式)。

系统能力: SystemCapability.Notification.CommonEvent

参数:

参数名

类型

必填

说明

subscribeInfo

CommonEventSubscribeInfo

表示订阅信息。

返回值:

类型

说明

Promise<CommonEventSubscriber>

返回订阅者对象。

示例:

  1. var subscriber; //用于保存创建成功的订阅者对象,后续使用其完成订阅及退订的动作
  2. //订阅者信息
  3. var subscribeInfo = {
  4. events: ["event"]
  5. };
  6. //创建订阅者
  7. try {
  8. CommonEventManager.createSubscriber(subscribeInfo).then((commonEventSubscriber) => {
  9. console.info("createSubscriber");
  10. subscriber = commonEventSubscriber;
  11. }).catch((err) => {
  12. console.error("createSubscriber failed " + JSON.stringify(err));
  13. });
  14. } catch(err) {
  15. console.error('createSubscriber failed, catch error' + JSON.stringify(err));
  16. }

CommonEventManager.subscribe

subscribe(subscriber: CommonEventSubscriber, callback: AsyncCallback<CommonEventData>): void

订阅公共事件(callback形式)。

系统能力: SystemCapability.Notification.CommonEvent

参数:

参数名

类型

必填

说明

subscriber

CommonEventSubscriber

表示订阅者对象。

callback

AsyncCallback<CommonEventData>

表示接收公共事件数据的回调函数。

示例:

  1. //订阅者信息
  2. var subscriber; //用于保存创建成功的订阅者对象,后续使用其完成订阅及退订的动作
  3. //订阅者信息
  4. var subscribeInfo = {
  5. events: ["event"]
  6. };
  7. //订阅公共事件回调
  8. function SubscribeCallBack(err, data) {
  9. if (err) {
  10. console.error("subscribe failed " + JSON.stringify(err));
  11. } else {
  12. console.info("subscribe ");
  13. }
  14. }
  15. //创建订阅者回调
  16. function createSubscriberCallBack(err, commonEventSubscriber) {
  17. if(!err) {
  18. console.info("createSubscriber");
  19. subscriber = commonEventSubscriber;
  20. //订阅公共事件
  21. try {
  22. CommonEventManager.subscribe(subscriber, SubscribeCallBack);
  23. } catch (err) {
  24. console.error("createSubscriber failed " + JSON.stringify(err));
  25. }
  26. } else {
  27. console.error("createSubscriber failed " + JSON.stringify(err));
  28. }
  29. }
  30. //创建订阅者
  31. try {
  32. CommonEventManager.createSubscriber(subscribeInfo, createSubscriberCallBack);
  33. } catch (err) {
  34. console.error('createSubscriber failed, catch error' + JSON.stringify(err));
  35. }

CommonEventManager.unsubscribe

unsubscribe(subscriber: CommonEventSubscriber, callback?: AsyncCallback<void>): void

取消订阅公共事件(callback形式)。

系统能力: SystemCapability.Notification.CommonEvent

参数:

参数名

类型

必填

说明

subscriber

CommonEventSubscriber

表示订阅者对象。

callback

AsyncCallback<void>

表示取消订阅的回调方法。

示例:

  1. var subscriber; //用于保存创建成功的订阅者对象,后续使用其完成订阅及退订的动作
  2. //订阅者信息
  3. var subscribeInfo = {
  4. events: ["event"]
  5. };
  6. //订阅公共事件回调
  7. function subscribeCallBack(err, data) {
  8. if (err) {
  9. console.info("subscribe failed " + JSON.stringify(err));
  10. } else {
  11. console.info("subscribe");
  12. }
  13. }
  14. //创建订阅者回调
  15. function createSubscriberCallBack(err, commonEventSubscriber) {
  16. if (err) {
  17. console.info("createSubscriber failed " + JSON.stringify(err));
  18. } else {
  19. console.info("createSubscriber");
  20. subscriber = commonEventSubscriber;
  21. //订阅公共事件
  22. try {
  23. CommonEventManager.subscribe(subscriber, subscribeCallBack);
  24. } catch(err) {
  25. console.info("subscribe failed " + JSON.stringify(err));
  26. }
  27. }
  28. }
  29. //取消订阅公共事件回调
  30. function unsubscribeCallBack(err) {
  31. if (err) {
  32. console.info("unsubscribe failed " + JSON.stringify(err));
  33. } else {
  34. console.info("unsubscribe");
  35. }
  36. }
  37. //创建订阅者
  38. try {
  39. CommonEventManager.createSubscriber(subscribeInfo, createSubscriberCallBack);
  40. } catch (err) {
  41. console.info("createSubscriber failed " + JSON.stringify(err));
  42. }
  43. //取消订阅公共事件
  44. try {
  45. CommonEventManager.unsubscribe(subscriber, unsubscribeCallBack);
  46. } catch (err) {
  47. console.info("unsubscribe failed " + JSON.stringify(err));
  48. }
  49. <<<<<<< HEAD

CommonEventSubscriber

getCode

getCode(callback: AsyncCallback<number>): void

获取公共事件的结果代码(callback形式)。

系统能力:SystemCapability.Notification.CommonEvent

参数:

参数名

类型

必填

说明

callback

AsyncCallback<number>

公共事件的结果代码。

示例:

  1. var subscriber; //创建成功的订阅者对象
  2. //获取有序公共事件的结果代码回调
  3. function getCodeCallback(err, Code) {
  4. if (err) {
  5. console.error("getCode failed " + JSON.stringify(err));
  6. } else {
  7. console.info("getCode " + JSON.stringify(Code));
  8. }
  9. }
  10. subscriber.getCode(getCodeCallback);

getCode

getCode(): Promise<number>

获取公共事件的结果代码(Promise形式)。

系统能力:SystemCapability.Notification.CommonEvent

返回值:

类型

说明

Promise<number>

公共事件的结果代码。

示例:

  1. var subscriber; //创建成功的订阅者对象
  2. subscriber.getCode().then((Code) => {
  3. console.info("getCode " + JSON.stringify(Code));
  4. }).catch((err) => {
  5. console.error("getCode failed " + JSON.stringify(err));
  6. });

setCode

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

设置公共事件的结果代码(callback形式)。

系统能力:SystemCapability.Notification.CommonEvent

参数:

参数名

类型

必填

说明

code

number

公共事件的结果代码。

callback

AsyncCallback<void>

表示被指定的回调方法。

示例:

  1. var subscriber; //创建成功的订阅者对象
  2. //设置有序公共事件的结果代码回调
  3. function setCodeCallback(err) {
  4. if (err) {
  5. console.error("setCode failed " + JSON.stringify(err));
  6. } else {
  7. console.info("setCode");
  8. }
  9. }
  10. subscriber.setCode(1, setCodeCallback);

setCode

setCode(code: number): Promise<void>

设置公共事件的结果代码(Promise形式)。

系统能力:SystemCapability.Notification.CommonEvent

参数:

参数名

类型

必填

说明

code

number

公共事件的结果代码。

返回值:

类型

说明

Promise<void>

返回一个Promise的结果。

示例:

  1. var subscriber; //创建成功的订阅者对象
  2. subscriber.setCode(1).then(() => {
  3. console.info("setCode");
  4. }).catch((err) => {
  5. console.error("setCode failed " + JSON.stringify(err));
  6. });

getData

getData(callback: AsyncCallback<string>): void

获取公共事件的结果数据(callback形式)。

系统能力:SystemCapability.Notification.CommonEvent

参数:

参数名

类型

必填

说明

callback

AsyncCallback<string>

公共事件的结果数据。

示例:

  1. var subscriber; //创建成功的订阅者对象
  2. //获取有序公共事件的结果数据回调
  3. function getDataCallback(err, Data) {
  4. if (err) {
  5. console.error("getData failed " + JSON.stringify(err));
  6. } else {
  7. console.info("getData " + JSON.stringify(Data));
  8. }
  9. }
  10. subscriber.getData(getDataCallback);

getData

getData(): Promise<string>

获取公共事件的结果数据(Promise形式)。

系统能力:SystemCapability.Notification.CommonEvent

返回值:

类型

说明

Promise<string>

公共事件的结果数据。

示例:

  1. var subscriber; //创建成功的订阅者对象
  2. subscriber.getData().then((Data) => {
  3. console.info("getData " + JSON.stringify(Data));
  4. }).catch((err) => {
  5. console.error("getData failed " + JSON.stringify(err));
  6. });

setData

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

设置公共事件的结果数据(callback形式)。

系统能力:SystemCapability.Notification.CommonEvent

参数:

参数名

类型

必填

说明

data

string

公共事件的结果数据。

callback

AsyncCallback<void>

表示被指定的回调方法。

示例:

  1. var subscriber; //创建成功的订阅者对象
  2. //设置有序公共事件的结果数据回调
  3. function setDataCallback(err) {
  4. if (err) {
  5. console.error("setData failed " + JSON.stringify(err));
  6. } else {
  7. console.info("setData");
  8. }
  9. }
  10. subscriber.setData("publish_data_changed", setDataCallback);

setData

setData(data: string): Promise<void>

设置公共事件的结果数据(Promise形式)。

系统能力:SystemCapability.Notification.CommonEvent

参数:

参数名

类型

必填

说明

data

string

公共事件的结果数据。

返回值:

类型

说明

Promise<void>

返回一个Promise的结果。

示例:

  1. var subscriber; //创建成功的订阅者对象
  2. subscriber.setData("publish_data_changed").then(() => {
  3. console.info("setData");
  4. }).catch((err) => {
  5. console.error("setData failed " + JSON.stringify(err));
  6. });

setCodeAndData

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

设置公共事件的结果代码和结果数据(callback形式)。

系统能力:SystemCapability.Notification.CommonEvent

参数:

参数名

类型

必填

说明

code

number

公共事件的结果代码。

data

string

公共事件的结果数据。

callback

AsyncCallback<void>

表示被指定的回调方法。

示例:

  1. var subscriber; //创建成功的订阅者对象
  2. //设置有序公共事件的结果代码和结果数据回调
  3. function setCodeDataCallback(err) {
  4. if (err) {
  5. console.error("setCodeAndData failed " + JSON.stringify(err));
  6. } else {
  7. console.info("setCodeDataCallback");
  8. }
  9. }
  10. subscriber.setCodeAndData(1, "publish_data_changed", setCodeDataCallback);

setCodeAndData

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

设置公共事件的结果代码和结果数据(Promise形式)。

系统能力:SystemCapability.Notification.CommonEvent

参数:

参数名

类型

必填

说明

code

number

公共事件的结果代码。

data

string

公共事件的结果数据。

返回值:

类型

说明

Promise<void>

返回一个Promise的结果。

示例:

  1. var subscriber; //创建成功的订阅者对象
  2. subscriber.setCodeAndData(1, "publish_data_changed").then(() => {
  3. console.info("setCodeAndData");
  4. }).catch((err) => {
  5. console.info("setCodeAndData failed " + JSON.stringify(err));
  6. });

isOrderedCommonEvent

isOrderedCommonEvent(callback: AsyncCallback<boolean>): void

查询当前公共事件的是否为有序公共事件(callback形式)。

返回true代表是有序公共事件,false代表不是有序公共事件。

系统能力:SystemCapability.Notification.CommonEvent

参数:

参数名

类型

必填

说明

callback

AsyncCallback<boolean>

当前公共事件的是否为有序公共事件。

示例:

  1. var subscriber; //创建成功的订阅者对象
  2. //获取当前公共事件是否为有序事件的回调
  3. function isOrderedCallback(err, isOrdered) {
  4. if (err) {
  5. console.error("isOrderedCommonEvent failed " + JSON.stringify(err));
  6. } else {
  7. console.info("isOrdered " + JSON.stringify(isOrdered));
  8. }
  9. }
  10. subscriber.isOrderedCommonEvent(isOrderedCallback);

isOrderedCommonEvent

isOrderedCommonEvent(): Promise<boolean>

查询当前公共事件的是否为有序公共事件(Promise形式)。

返回true代表是有序公共事件,false代表不是有序公共事件。

系统能力:SystemCapability.Notification.CommonEvent

返回值:

类型

说明

Promise<boolean>

当前公共事件的是否为有序公共事件。

示例:

  1. var subscriber; //创建成功的订阅者对象
  2. subscriber.isOrderedCommonEvent().then((isOrdered) => {
  3. console.info("isOrdered " + JSON.stringify(isOrdered));
  4. }).catch((err) => {
  5. console.error("isOrdered failed " + JSON.stringify(err));
  6. });

isStickyCommonEvent

isStickyCommonEvent(callback: AsyncCallback<boolean>): void

检查当前公共事件是否为一个粘性事件(callback形式)。

返回true代表是粘性公共事件,false代表不是粘性公共事件。

系统能力:SystemCapability.Notification.CommonEvent

参数:

参数名

类型

必填

说明

callback

AsyncCallback<boolean>

当前公共事件的是否为粘性公共事件。

示例:

  1. var subscriber; //创建成功的订阅者对象
  2. //获取当前公共事件是否为粘性事件的回调
  3. function isStickyCallback(err, isSticky) {
  4. if (err) {
  5. console.error("isStickyCommonEvent failed " + JSON.stringify(err));
  6. } else {
  7. console.info("isSticky " + JSON.stringify(isSticky));
  8. }
  9. }
  10. subscriber.isStickyCommonEvent(isStickyCallback);

isStickyCommonEvent

isStickyCommonEvent(): Promise<boolean>

检查当前公共事件是否为一个粘性事件(Promise形式)。

返回true代表是粘性公共事件,false代表不是粘性公共事件。

系统能力:SystemCapability.Notification.CommonEvent

返回值:

类型

说明

Promise<boolean>

当前公共事件的是否为粘性公共事件。

示例:

  1. var subscriber; //创建成功的订阅者对象
  2. subscriber.isStickyCommonEvent().then((isSticky) => {
  3. console.info("isSticky " + JSON.stringify(isSticky));
  4. }).catch((err) => {
  5. console.error("isSticky failed " + JSON.stringify(err));
  6. });

abortCommonEvent

abortCommonEvent(callback: AsyncCallback<void>): void

取消当前的公共事件,仅对有序公共事件有效,取消后,公共事件不再向下一个订阅者传递(callback形式)。

系统能力:SystemCapability.Notification.CommonEvent

参数:

参数名

类型

必填

说明

callback

AsyncCallback<void>

取消当前的公共事件。

示例:

  1. var subscriber; //创建成功的订阅者对象
  2. //取消当前有序公共事件的回调
  3. function abortCallback(err) {
  4. if (err) {
  5. console.error("abortCommonEvent failed " + JSON.stringify(err));
  6. } else {
  7. console.info("abortCommonEvent");
  8. }
  9. }
  10. subscriber.abortCommonEvent(abortCallback);

abortCommonEvent

abortCommonEvent(): Promise<void>

取消当前的公共事件,仅对有序公共事件有效,取消后,公共事件不再向下一个订阅者传递(Promise形式)。

系统能力:SystemCapability.Notification.CommonEvent

返回值:

类型

说明

Promise<void>

返回一个Promise的结果。

示例:

  1. var subscriber; //创建成功的订阅者对象
  2. subscriber.abortCommonEvent().then(() => {
  3. console.info("abortCommonEvent");
  4. }).catch((err) => {
  5. console.error("abortCommonEvent failed " + JSON.stringify(err));
  6. });

clearAbortCommonEvent

clearAbortCommonEvent(callback: AsyncCallback<void>): void

清除当前公共事件的取消状态,仅对有序公共事件有效(callback形式)。

系统能力:SystemCapability.Notification.CommonEvent

参数:

参数名

类型

必填

说明

callback

AsyncCallback<void>

表示被指定的回调方法。

示例:

  1. var subscriber; //创建成功的订阅者对象
  2. //清除当前公共事件取消状态的回调
  3. function clearAbortCallback(err) {
  4. if (err) {
  5. console.error("clearAbortCommonEvent failed " + JSON.stringify(err));
  6. } else {
  7. console.info("clearAbortCommonEvent");
  8. }
  9. }
  10. subscriber.clearAbortCommonEvent(clearAbortCallback);

clearAbortCommonEvent

clearAbortCommonEvent(): Promise<void>

清除当前公共事件的取消状态,仅对有序公共事件有效(Promise形式)。

系统能力:SystemCapability.Notification.CommonEvent

返回值:

类型

说明

Promise<void>

返回一个Promise的结果。

示例:

  1. var subscriber; //创建成功的订阅者对象
  2. subscriber.clearAbortCommonEvent().then(() => {
  3. console.info("clearAbortCommonEvent");
  4. }).catch((err) => {
  5. console.error("clearAbortCommonEvent failed " + JSON.stringify(err));
  6. });

getAbortCommonEvent

getAbortCommonEvent(callback: AsyncCallback<boolean>): void

获取当前有序公共事件是否取消的状态(callback形式)。

系统能力:SystemCapability.Notification.CommonEvent

参数:

参数名

类型

必填

说明

callback

AsyncCallback<boolean>

表示当前有序公共事件是否取消的状态。

示例:

  1. var subscriber; //创建成功的订阅者对象
  2. //获取当前有序公共事件是否取消的回调
  3. function getAbortCallback(err, AbortCommonEvent) {
  4. if (err) {
  5. console.error("getAbortCommonEvent failed " + JSON.stringify(err));
  6. } else {
  7. console.info("AbortCommonEvent " + AbortCommonEvent)
  8. }
  9. }
  10. subscriber.getAbortCommonEvent(getAbortCallback);

getAbortCommonEvent

getAbortCommonEvent(): Promise<boolean>

获取当前有序公共事件是否取消的状态(Promise形式)。

系统能力:SystemCapability.Notification.CommonEvent

返回值:

类型

说明

Promise<boolean>

表示当前有序公共事件是否取消的状态。

示例:

  1. var subscriber; //创建成功的订阅者对象
  2. subscriber.getAbortCommonEvent().then((AbortCommonEvent) => {
  3. console.info("AbortCommonEvent " + JSON.stringify(AbortCommonEvent));
  4. }).catch((err) => {
  5. console.error("getAbortCommonEvent failed " + JSON.stringify(err));
  6. });

getSubscribeInfo

getSubscribeInfo(callback: AsyncCallback<CommonEventSubscribeInfo>): void

获取订阅者的订阅信息(callback形式)。

系统能力:SystemCapability.Notification.CommonEvent

参数:

参数名

类型

必填

说明

callback

AsyncCallback<CommonEventSubscribeInfo>

表示订阅者的订阅信息。

示例:

  1. var subscriber; //创建成功的订阅者对象
  2. //获取订阅者信息回调
  3. function getSubscribeInfoCallback(err, SubscribeInfo) {
  4. if (err) {
  5. console.error("getSubscribeInfo failed " + JSON.stringify(err));
  6. } else {
  7. console.info("SubscribeInfo " + JSON.stringify(SubscribeInfo));
  8. }
  9. }
  10. subscriber.getSubscribeInfo(getSubscribeInfoCallback);

getSubscribeInfo

getSubscribeInfo(): Promise<CommonEventSubscribeInfo>

获取订阅者的订阅信息(Promise形式)。

系统能力:SystemCapability.Notification.CommonEvent

返回值:

类型

说明

Promise<CommonEventSubscribeInfo>

表示订阅者的订阅信息。

示例:

  1. var subscriber; //创建成功的订阅者对象
  2. subscriber.getSubscribeInfo().then((SubscribeInfo) => {
  3. console.info("SubscribeInfo " + JSON.stringify(SubscribeInfo));
  4. }).catch((err) => {
  5. console.error("getSubscribeInfo failed " + JSON.stringify(err));
  6. });

finishCommonEvent9+

finishCommonEvent(callback: AsyncCallback<void>): void

结束当前有序公共事件(callback形式)。

系统能力:SystemCapability.Notification.CommonEvent

参数:

参数名

类型

必填

说明

callback

AsyncCallback<void>

表示有序公共事件结束后的回调函数。

示例:

  1. var subscriber; //创建成功的订阅者对象
  2. //结束当前有序公共事件的回调
  3. function finishCommonEventCallback(err) {
  4. if (err) {
  5. console.error("finishCommonEvent failed " + JSON.stringify(err));
  6. } else {
  7. console.info("FinishCommonEvent");
  8. }
  9. }
  10. subscriber.finishCommonEvent(finishCommonEventCallback);

finishCommonEvent9+

finishCommonEvent(): Promise<void>

结束当前有序公共事件(Promise形式)。

系统能力:SystemCapability.Notification.CommonEvent

返回值:

类型

说明

Promise<void>

返回一个Promise的结果。

示例:

  1. var subscriber; //创建成功的订阅者对象
  2. subscriber.finishCommonEvent().then(() => {
  3. console.info("FinishCommonEvent");
  4. }).catch((err) => {
  5. console.error("finishCommonEvent failed " + JSON.stringify(err));
  6. });

CommonEventData

系统能力: 以下各项对应的系统能力均为SystemCapability.Notification.CommonEvent

名称

类型

可读

可写

说明

event

string

表示当前接收的公共事件名称。

bundleName

string

表示包名称。

code

number

表示公共事件的结果代码,用于传递int类型的数据。

data

string

表示公共事件的自定义结果数据,用于传递string类型的数据。

parameters

{[key: string]: any}

表示公共事件的附加信息。

CommonEventPublishData

系统能力: 以下各项对应的系统能力均为SystemCapability.Notification.CommonEvent

名称

类型

可读

可写

说明

bundleName

string

表示包名称。

code

number

表示公共事件的结果代码。

data

string

表示公共事件的自定义结果数据。

subscriberPermissions

Array<string>

表示订阅者的权限。

isOrdered

boolean

表示是否是有序事件。

isSticky

boolean

表示是否是粘性事件。仅系统应用或系统服务允许发送粘性事件。

parameters

{[key: string]: any}

表示公共事件的附加信息。

CommonEventSubscribeInfo

系统能力: 以下各项对应的系统能力均为SystemCapability.Notification.CommonEvent

名称

类型

可读

可写

说明

events

Array<string>

表示要发送的公共事件。

publisherPermission

string

表示发布者的权限。

publisherDeviceId

string

表示设备ID,该值必须是同一ohos网络上的现有设备ID。

userId

number

表示用户ID。此参数是可选的,默认值当前用户的ID。如果指定了此参数,则该值必须是系统中现有的用户ID。

priority

number

表示订阅者的优先级。值的范围是-100到1000。

以上内容是否对您有帮助:
在线笔记
App下载
App下载

扫描二维码

下载编程狮App

公众号
微信公众号

编程狮公众号