codecamp

公共事件的能力

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

说明
  • 从API Version 9开始，该接口不再维护，推荐使用新接口@ohos.commonEventManager。
  • 本模块首批接口从API version 7开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。

导入模块

  1. import CommonEvent from '@ohos.commonEvent';

Support

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

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

CommonEvent.publish

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

发布公共事件（callback形式）。

系统能力： SystemCapability.Notification.CommonEvent

参数：

参数名

类型

必填

说明

event

string

是

表示要发送的公共事件。

callback

AsyncCallback<void>

是

表示被指定的回调方法。

示例：

  1. //发布公共事件回调
  2. function publishCallBack(err) {
  3.     if (err.code) {
  4.         console.error("publish failed " + JSON.stringify(err));
  5.     } else {
  6.         console.info("publish");
  7.     }
  8. }
  9. 

  10. //发布公共事件
  11. CommonEvent.publish("event", publishCallBack);

CommonEvent.publish

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

发布公共事件指定发布信息（callback形式）。

系统能力： SystemCapability.Notification.CommonEvent

参数：

参数名

类型

必填

说明

event

string

是

表示要发布的公共事件。

options

CommonEventPublishData

是

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

callback

syncCallback<void>

是

表示被指定的回调方法。

示例：

  1. //公共事件相关信息
  2. let options = {
  3.     code: 0,             //公共事件的初始代码
  4.     data: "initial data",//公共事件的初始数据
  5.     isOrdered: true     //有序公共事件
  6. }
  7. 

  8. //发布公共事件回调
  9. function publishCallBack(err) {
  10.     if (err.code) {
  11.         console.error("publish failed " + JSON.stringify(err));
  12.     } else {
  13.         console.info("publish");
  14.     }
  15. }
  16. 

  17. //发布公共事件
  18. CommonEvent.publish("event", options, publishCallBack);

CommonEvent.createSubscriber

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

创建订阅者（callback形式）。

系统能力： SystemCapability.Notification.CommonEvent

参数：

参数名

类型

必填

说明

subscribeInfo

CommonEventSubscribeInfo

是

表示订阅信息。

callback

AsyncCallback<CommonEventSubscriber>

是

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

示例：

  1. let subscriber; //用于保存创建成功的订阅者对象，后续使用其完成订阅及退订的动作
  2. 

  3. //订阅者信息
  4. let subscribeInfo = {
  5.     events: ["event"]
  6. };
  7. 

  8. //创建订阅者回调
  9. function createSubscriberCallBack(err, commonEventSubscriber) {
  10.     if (err.code) {
  11.         console.error("createSubscriber failed " + JSON.stringify(err));
  12.     } else {
  13.         console.info("createSubscriber");
  14.         subscriber = commonEventSubscriber;
  15.     }
  16. }
  17. 

  18. //创建订阅者
  19. CommonEvent.createSubscriber(subscribeInfo, createSubscriberCallBack);

CommonEvent.createSubscriber

createSubscriber(subscribeInfo: CommonEventSubscribeInfo): Promise<CommonEventSubscriber>

创建订阅者（Promise形式）。

系统能力： SystemCapability.Notification.CommonEvent

参数：

参数名

类型

必填

说明

subscribeInfo

CommonEventSubscribeInfo

是

表示订阅信息。

返回值：

类型

说明

Promise<CommonEventSubscriber>

返回订阅者对象。

示例：

  1. let subscriber; //用于保存创建成功的订阅者对象，后续使用其完成订阅及退订的动作
  2. 

  3. //订阅者信息
  4. let subscribeInfo = {
  5.     events: ["event"]
  6. };
  7. 

  8. //创建订阅者
  9. CommonEvent.createSubscriber(subscribeInfo).then((commonEventSubscriber) => {
  10.     console.info("createSubscriber");
  11.     subscriber = commonEventSubscriber;
  12. }).catch((err) => {
  13.     console.error("createSubscriber failed " + JSON.stringify(err));
  14. });

CommonEvent.subscribe

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

订阅公共事件（callback形式）。

系统能力： SystemCapability.Notification.CommonEvent

参数：

参数名

类型

必填

说明

subscriber

CommonEventSubscriber

是

表示订阅者对象。

callback

AsyncCallback<CommonEventData>

是

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

示例：

  1. let subscriber; //用于保存创建成功的订阅者对象，后续使用其完成订阅及退订的动作
  2. 

  3. //订阅者信息
  4. let subscribeInfo = {
  5.     events: ["event"]
  6. };
  7. 

  8. //订阅公共事件回调
  9. function subscribeCallBack(err, data) {
  10.     if (err.code) {
  11.         console.error("subscribe failed " + JSON.stringify(err));
  12.     } else {
  13.         console.info("subscribe " + JSON.stringify(data));
  14.     }
  15. }
  16. 

  17. //创建订阅者回调
  18. function createSubscriberCallBack(err, commonEventSubscriber) {
  19.     if (err.code) {
  20.         console.error("createSubscriber failed " + JSON.stringify(err));
  21.     } else {
  22.         console.info("createSubscriber");
  23.         subscriber = commonEventSubscriber;
  24.         //订阅公共事件
  25.         CommonEvent.subscribe(subscriber, subscribeCallBack);
  26.     }
  27. }
  28. 

  29. //创建订阅者
  30. CommonEvent.createSubscriber(subscribeInfo, createSubscriberCallBack);

CommonEvent.unsubscribe

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

取消订阅公共事件（callback形式）。

系统能力： SystemCapability.Notification.CommonEvent

参数：

参数名

类型

必填

说明

subscriber

CommonEventSubscriber

是

表示订阅者对象。

callback

AsyncCallback<void>

否

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

示例：

  1. let subscriber;    //用于保存创建成功的订阅者对象，后续使用其完成订阅及退订的动作
  2. 

  3. //订阅者信息
  4. let subscribeInfo = {
  5.     events: ["event"]
  6. };
  7. 

  8. //订阅公共事件回调
  9. function subscribeCallBack(err, data) {
  10.     if (err.code) {
  11.         console.info("subscribe failed " + JSON.stringify(err));
  12.     } else {
  13.         console.info("subscribe " + JSON.stringify(data));
  14.     }
  15. }
  16. 

  17. //创建订阅者回调
  18. function createSubscriberCallBack(err, commonEventSubscriber) {
  19.     if (err.code) {
  20.         console.info("createSubscriber failed " + JSON.stringify(err));
  21.     } else {
  22.         console.info("createSubscriber");
  23.         subscriber = commonEventSubscriber;
  24.         //订阅公共事件
  25.         CommonEvent.subscribe(subscriber, subscribeCallBack);
  26.     }
  27. }
  28. 

  29. //取消订阅公共事件回调
  30. function unsubscribeCallBack(err) {
  31.     if (err.code) {
  32.         console.info("unsubscribe failed " + JSON.stringify(err));
  33.     } else {
  34.         console.info("unsubscribe");
  35.     }
  36. }
  37. 

  38. //创建订阅者
  39. CommonEvent.createSubscriber(subscribeInfo, createSubscriberCallBack);
  40. 

  41. //取消订阅公共事件
  42. CommonEvent.unsubscribe(subscriber, unsubscribeCallBack);

CommonEventSubscriber

getCode

getCode(callback: AsyncCallback<number>): void

获取公共事件的结果代码（callback形式）。

系统能力：SystemCapability.Notification.CommonEvent

参数：

参数名

类型

必填

说明

callback

AsyncCallback<number>

是

公共事件的结果代码。

示例：

  1. let subscriber;    //创建成功的订阅者对象
  2. 

  3. //获取有序公共事件的结果代码回调
  4. function getCodeCallback(err, Code) {
  5.     if (err.code) {
  6.         console.error("getCode failed " + JSON.stringify(err));
  7.     } else {
  8.         console.info("getCode " + JSON.stringify(Code));
  9.     }
  10. }
  11. subscriber.getCode(getCodeCallback);

getCode

getCode(): Promise<number>

获取公共事件的结果代码（Promise形式）。

系统能力：SystemCapability.Notification.CommonEvent

返回值：

类型

说明

Promise<number>

公共事件的结果代码。

示例：

  1. let subscriber;    //创建成功的订阅者对象
  2. 

  3. subscriber.getCode().then((Code) => {
  4.     console.info("getCode " + JSON.stringify(Code));
  5. }).catch((err) => {
  6.     console.error("getCode failed " + JSON.stringify(err));
  7. });

setCode

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

设置公共事件的结果代码（callback形式）。

系统能力：SystemCapability.Notification.CommonEvent

参数：

参数名

类型

必填

说明

code

number

是

公共事件的结果代码。

callback

AsyncCallback<void>

是

表示被指定的回调方法。

示例：

  1. let subscriber;    //创建成功的订阅者对象
  2. 

  3. //设置有序公共事件的结果代码回调
  4. function setCodeCallback(err) {
  5.     if (err.code) {
  6.         console.error("setCode failed " + JSON.stringify(err));
  7.     } else {
  8.         console.info("setCode");
  9.     }
  10. }
  11. subscriber.setCode(1, setCodeCallback);

setCode

setCode(code: number): Promise<void>

设置公共事件的结果代码（Promise形式）。

系统能力：SystemCapability.Notification.CommonEvent

参数：

参数名

类型

必填

说明

code

number

是

公共事件的结果代码。

返回值：

类型

说明

Promise<void>

返回一个Promise的结果。

示例：

  1. let subscriber;    //创建成功的订阅者对象
  2. 

  3. subscriber.setCode(1).then(() => {
  4.     console.info("setCode");
  5. }).catch((err) => {
  6.     console.error("setCode failed " + JSON.stringify(err));
  7. });

getData

getData(callback: AsyncCallback<string>): void

获取公共事件的结果数据（callback形式）。

系统能力：SystemCapability.Notification.CommonEvent

参数：

参数名

类型

必填

说明

callback

AsyncCallback<string>

是

公共事件的结果数据。

示例：

  1. let subscriber;    //创建成功的订阅者对象
  2. 

  3. //获取有序公共事件的结果数据回调
  4. function getDataCallback(err, Data) {
  5.     if (err.code) {
  6.         console.error("getData failed " + JSON.stringify(err));
  7.     } else {
  8.         console.info("getData " + JSON.stringify(Data));
  9.     }
  10. }
  11. subscriber.getData(getDataCallback);

getData

getData(): Promise<string>

获取公共事件的结果数据（Promise形式）。

系统能力：SystemCapability.Notification.CommonEvent

返回值：

类型

说明

Promise<string>

公共事件的结果数据。

示例：

  1. let subscriber;    //创建成功的订阅者对象
  2. 

  3. subscriber.getData().then((Data) => {
  4.     console.info("getData " + JSON.stringify(Data));
  5. }).catch((err) => {
  6.     console.error("getData failed " + JSON.stringify(err));
  7. });

setData

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

设置公共事件的结果数据（callback形式）。

系统能力：SystemCapability.Notification.CommonEvent

参数：

参数名

类型

必填

说明

data

string

是

公共事件的结果数据。

callback

AsyncCallback<void>

是

表示被指定的回调方法。

示例：

  1. let subscriber;    //创建成功的订阅者对象
  2. 

  3. //设置有序公共事件的结果数据回调
  4. function setDataCallback(err) {
  5.     if (err.code) {
  6.         console.error("setData failed " + JSON.stringify(err));
  7.     } else {
  8.         console.info("setData");
  9.     }
  10. }
  11. subscriber.setData("publish_data_changed", setDataCallback);

setData

setData(data: string): Promise<void>

设置公共事件的结果数据（Promise形式）。

系统能力：SystemCapability.Notification.CommonEvent

参数：

参数名

类型

必填

说明

data

string

是

公共事件的结果数据。

返回值：

类型

说明

Promise<void>

返回一个Promise的结果。

示例：

  1. let subscriber;    //创建成功的订阅者对象
  2. 

  3. subscriber.setData("publish_data_changed").then(() => {
  4.     console.info("setData");
  5. }).catch((err) => {
  6.     console.error("setData failed " + JSON.stringify(err));
  7. });

setCodeAndData

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

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

系统能力：SystemCapability.Notification.CommonEvent

参数：

参数名

类型

必填

说明

code

number

是

公共事件的结果代码。

data

string

是

公共事件的结果数据。

callback

AsyncCallback<void>

是

表示被指定的回调方法。

示例：

  1. let subscriber;    //创建成功的订阅者对象
  2. 

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

  3. subscriber.setCodeAndData(1, "publish_data_changed").then(() => {
  4.     console.info("setCodeAndData");
  5. }).catch((err) => {
  6.     console.info("setCodeAndData failed " + JSON.stringify(err));
  7. });

isOrderedCommonEvent

isOrderedCommonEvent(callback: AsyncCallback<boolean>): void

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

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

系统能力：SystemCapability.Notification.CommonEvent

参数：

参数名

类型

必填

说明

callback

AsyncCallback<boolean>

是

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

示例：

  1. let subscriber;    //创建成功的订阅者对象
  2. 

  3. //获取当前公共事件是否为有序事件的回调
  4. function isOrderedCallback(err, isOrdered) {
  5.     if (err.code) {
  6.         console.error("isOrderedCommonEvent failed " + JSON.stringify(err));
  7.     } else {
  8.         console.info("isOrdered " + JSON.stringify(isOrdered));
  9.     }
  10. }
  11. subscriber.isOrderedCommonEvent(isOrderedCallback);

isOrderedCommonEvent

isOrderedCommonEvent(): Promise<boolean>

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

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

系统能力：SystemCapability.Notification.CommonEvent

返回值：

类型

说明

Promise<boolean>

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

示例：

  1. let subscriber;    //创建成功的订阅者对象
  2. 

  3. subscriber.isOrderedCommonEvent().then((isOrdered) => {
  4.     console.info("isOrdered " + JSON.stringify(isOrdered));
  5. }).catch((err) => {
  6.     console.error("isOrdered failed " + JSON.stringify(err));
  7. });

isStickyCommonEvent

isStickyCommonEvent(callback: AsyncCallback<boolean>): void

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

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

系统能力：SystemCapability.Notification.CommonEvent

参数：

参数名

类型

必填

说明

callback

AsyncCallback<boolean>

是

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

示例：

  1. let subscriber;    //创建成功的订阅者对象
  2. 

  3. //获取当前公共事件是否为粘性事件的回调
  4. function isStickyCallback(err, isSticky) {
  5.     if (err.code) {
  6.         console.error("isStickyCommonEvent failed " + JSON.stringify(err));
  7.     } else {
  8.         console.info("isSticky " + JSON.stringify(isSticky));
  9.     }
  10. }
  11. subscriber.isStickyCommonEvent(isStickyCallback);

isStickyCommonEvent

isStickyCommonEvent(): Promise<boolean>

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

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

系统能力：SystemCapability.Notification.CommonEvent

返回值：

类型

说明

Promise<boolean>

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

示例：

  1. let subscriber;    //创建成功的订阅者对象
  2. 

  3. subscriber.isStickyCommonEvent().then((isSticky) => {
  4.     console.info("isSticky " + JSON.stringify(isSticky));
  5. }).catch((err) => {
  6.     console.error("isSticky failed " + JSON.stringify(err));
  7. });

abortCommonEvent

abortCommonEvent(callback: AsyncCallback<void>): void

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

系统能力：SystemCapability.Notification.CommonEvent

参数：

参数名

类型

必填

说明

callback

AsyncCallback<void>

是

取消当前的公共事件。

示例：

  1. let subscriber;    //创建成功的订阅者对象
  2. 

  3. //取消当前有序公共事件的回调
  4. function abortCallback(err) {
  5.     if (err.code) {
  6.         console.error("abortCommonEvent failed " + JSON.stringify(err));
  7.     } else {
  8.         console.info("abortCommonEvent");
  9.     }
  10. }
  11. subscriber.abortCommonEvent(abortCallback);

abortCommonEvent

abortCommonEvent(): Promise<void>

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

系统能力：SystemCapability.Notification.CommonEvent

返回值：

类型

说明

Promise<void>

返回一个Promise的结果。

示例：

  1. let subscriber;    //创建成功的订阅者对象
  2. 

  3. subscriber.abortCommonEvent().then(() => {
  4.     console.info("abortCommonEvent");
  5. }).catch((err) => {
  6.     console.error("abortCommonEvent failed " + JSON.stringify(err));
  7. });

clearAbortCommonEvent

clearAbortCommonEvent(callback: AsyncCallback<void>): void

清除当前公共事件的取消状态，仅对有序公共事件有效（callback形式）。

系统能力：SystemCapability.Notification.CommonEvent

参数：

参数名

类型

必填

说明

callback

AsyncCallback<void>

是

表示被指定的回调方法。

示例：

  1. let subscriber;    //创建成功的订阅者对象
  2. 

  3. //清除当前公共事件取消状态的回调
  4. function clearAbortCallback(err) {
  5.     if (err.code) {
  6.         console.error("clearAbortCommonEvent failed " + JSON.stringify(err));
  7.     } else {
  8.         console.info("clearAbortCommonEvent");
  9.     }
  10. }
  11. subscriber.clearAbortCommonEvent(clearAbortCallback);

clearAbortCommonEvent

clearAbortCommonEvent(): Promise<void>

清除当前公共事件的取消状态，仅对有序公共事件有效（Promise形式）。

系统能力：SystemCapability.Notification.CommonEvent

返回值：

类型

说明

Promise<void>

返回一个Promise的结果。

示例：

  1. let subscriber;    //创建成功的订阅者对象
  2. 

  3. subscriber.clearAbortCommonEvent().then(() => {
  4.     console.info("clearAbortCommonEvent");
  5. }).catch((err) => {
  6.     console.error("clearAbortCommonEvent failed " + JSON.stringify(err));
  7. });

getAbortCommonEvent

getAbortCommonEvent(callback: AsyncCallback<boolean>): void

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

系统能力：SystemCapability.Notification.CommonEvent

参数：

参数名

类型

必填

说明

callback

AsyncCallback<boolean>

是

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

示例：

  1. let subscriber;    //创建成功的订阅者对象
  2. 

  3. //获取当前有序公共事件是否取消的回调
  4. function getAbortCallback(err, AbortCommonEvent) {
  5.     if (err.code) {
  6.         console.error("getAbortCommonEvent failed " + JSON.stringify(err));
  7.     } else {
  8.         console.info("AbortCommonEvent " + AbortCommonEvent)
  9.     }
  10. }
  11. subscriber.getAbortCommonEvent(getAbortCallback);

getAbortCommonEvent

getAbortCommonEvent(): Promise<boolean>

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

系统能力：SystemCapability.Notification.CommonEvent

返回值：

类型

说明

Promise<boolean>

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

示例：

  1. let subscriber;    //创建成功的订阅者对象
  2. 

  3. subscriber.getAbortCommonEvent().then((AbortCommonEvent) => {
  4.     console.info("AbortCommonEvent " + JSON.stringify(AbortCommonEvent));
  5. }).catch((err) => {
  6.     console.error("getAbortCommonEvent failed " + JSON.stringify(err));
  7. });

getSubscribeInfo

getSubscribeInfo(callback: AsyncCallback<CommonEventSubscribeInfo>): void

获取订阅者的订阅信息（callback形式）。

系统能力：SystemCapability.Notification.CommonEvent

参数：

参数名

类型

必填

说明

callback

AsyncCallback<CommonEventSubscribeInfo>

是

表示订阅者的订阅信息。

示例：

  1. let subscriber;    //创建成功的订阅者对象
  2. 

  3. //获取订阅者信息回调
  4. function getSubscribeInfoCallback(err, SubscribeInfo) {
  5.     if (err.code) {
  6.         console.error("getSubscribeInfo failed " + JSON.stringify(err));
  7.     } else {
  8.         console.info("SubscribeInfo " + JSON.stringify(SubscribeInfo));
  9.     }
  10. }
  11. subscriber.getSubscribeInfo(getSubscribeInfoCallback);

getSubscribeInfo

getSubscribeInfo(): Promise<CommonEventSubscribeInfo>

获取订阅者的订阅信息（Promise形式）。

系统能力：SystemCapability.Notification.CommonEvent

返回值：

类型

说明

Promise<CommonEventSubscribeInfo>

表示订阅者的订阅信息。

示例：

  1. let subscriber;    //创建成功的订阅者对象
  2. 

  3. subscriber.getSubscribeInfo().then((SubscribeInfo) => {
  4.     console.info("SubscribeInfo " + JSON.stringify(SubscribeInfo));
  5. }).catch((err) => {
  6.     console.error("getSubscribeInfo failed " + JSON.stringify(err));
  7. });

finishCommonEvent9+

finishCommonEvent(callback: AsyncCallback<void>): void

结束当前有序公共事件（callback形式）。

系统能力：SystemCapability.Notification.CommonEvent

参数：

参数名

类型

必填

说明

callback

AsyncCallback<void>

是

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

示例：

  1. let subscriber; //创建成功的订阅者对象
  2. 

  3. //结束当前有序公共事件的回调
  4. function finishCommonEventCallback(err) {
  5.   if (err.code) {
  6.     console.error("finishCommonEvent failed " + JSON.stringify(err));
  7. } else {
  8.     console.info("FinishCommonEvent");
  9. }
  10. }
  11. subscriber.finishCommonEvent(finishCommonEventCallback);

finishCommonEvent9+

finishCommonEvent(): Promise<void>

结束当前有序公共事件（Promise形式）。

系统能力：SystemCapability.Notification.CommonEvent

返回值：

类型

说明

Promise<void>

返回一个Promise的结果。

示例：

  1. let subscriber;    //创建成功的订阅者对象
  2. 

  3. subscriber.finishCommonEvent().then(() => {
  4.     console.info("FinishCommonEvent");
  5. }).catch((err) => {
  6.     console.error("finishCommonEvent failed " + JSON.stringify(err));
  7. });

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，免费阅读超1000+编程语言教程
取消
确定
目录

通用事件

通用属性

手势处理

基础组件

容器组件

媒体组件

绘制组件

画布组件

动画

弹窗

生命周期

状态管理

像素

枚举

类型

接口

错误码合集

关闭

 MIP.setData({ 'pageTheme' : getCookie('pageTheme') || {'day':true, 'night':false}, 'pageFontSize' : getCookie('pageFontSize') || 20 }); MIP.watch('pageTheme', function(newValue){ setCookie('pageTheme', JSON.stringify(newValue)) }); MIP.watch('pageFontSize', function(newValue){ setCookie('pageFontSize', newValue) }); function setCookie(name, value){ var days = 1; var exp = new Date(); exp.setTime(exp.getTime() + days*24*60*60*1000); document.cookie = name + '=' + value + ';expires=' + exp.toUTCString(); } function getCookie(name){ var reg = new RegExp('(^| )' + name + '=([^;]*)(;|$)'); return document.cookie.match(reg) ? JSON.parse(document.cookie.match(reg)[2]) : null; }