输入关键字搜索
开发者能力认证
鸿蒙高校创新赛
HarmonyOS 7
animation
HarmonyOS行业解决方案
layoutWeight
HarmonyOS模板&组件
bindPopup
bindsheet
CTRL+K
文档管理中心

HarmonyOS

输入关键字搜索
开发者能力认证
鸿蒙高校创新赛
HarmonyOS 7
animation
HarmonyOS行业解决方案
layoutWeight
HarmonyOS模板&组件
bindPopup
bindsheet
CTRL+K
API参考
高级筛选
API version全部版本
设备全部
元服务API集不筛选
您当前正在浏览HarmonyOS最新文档，覆盖已发布的所有API版本，可在API参考中筛选您使用的API版本。详细的版本配套关系请参考版本说明。
API参考系统基础功能Basic Services Kit（基础服务）ArkTS API已停止维护的接口@ohos.commonEvent (公共事件模块)

@ohos.commonEvent (公共事件模块)

Phone12+PC/2in113+Tablet12+TV19+Wearable18+
更新时间: 2026-08-29 09:41
本文导读
展开章节

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

说明

从API version 7 开始支持，从API version 9 开始废弃，建议使用@ohos.commonEventManager替代。

导入模块

收起
自动换行
深色代码主题
复制
  1. import commonEvent from '@ohos.commonEvent';

Support

Phone12+PC/2in113+Tablet12+TV19+Wearable18+

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

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

commonEvent.publish(deprecated)

Phone12+PC/2in113+Tablet12+TV19+Wearable18+

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

以回调形式发布公共事件。

说明

从API version 7 开始支持，从API version 9 开始废弃，建议使用commonEventManager.publish替代。

系统能力： SystemCapability.Notification.CommonEvent

参数：

展开
参数名 类型 必填 说明
event string 是 表示要发布的公共事件。
callback AsyncCallback<void> 是 表示发布公共事件的回调方法。

示例：

收起
自动换行
深色代码主题
复制
  1. import Base from '@ohos.base';
  2. 

  3. // 发布公共事件回调
  4. let publishCallBack = (err: Base.BusinessError) => {
  5.     if (err.code) {
  6.         console.error(`publish failed, code is ${err.code}, message is ${err.message}`);
  7.     } else {
  8.         console.info('publish');
  9.     }
  10. }
  11. 

  12. // 发布公共事件
  13. commonEvent.publish("event", publishCallBack);

commonEvent.publish(deprecated)

Phone12+PC/2in113+Tablet12+TV19+Wearable18+

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

以回调形式发布公共事件。

说明

从API version 7 开始支持，从API version 9 开始废弃，建议使用commonEventManager.publish替代。

系统能力： SystemCapability.Notification.CommonEvent

参数：

展开
参数名 类型 必填 说明
event string 是 表示要发布的公共事件。
options CommonEventPublishData 是 表示发布公共事件的属性。
callback AsyncCallback<void> 是 表示发布公共事件的回调方法。

示例：

收起
自动换行
深色代码主题
复制
  1. import Base from '@ohos.base';
  2. import CommonEventManager from '@ohos.commonEventManager';
  3. 

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

  11. // 发布公共事件回调
  12. let publishCallBack = (err: Base.BusinessError) => {
  13.     if (err.code) {
  14.         console.error(`publish failed, code is ${err.code}, message is ${err.message}`);
  15.     } else {
  16.         console.info("publish");
  17.     }
  18. }
  19. 

  20. // 发布公共事件
  21. commonEvent.publish("event", options, publishCallBack);

commonEvent.createSubscriber(deprecated)

Phone12+PC/2in113+Tablet12+TV19+Wearable18+

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

以回调形式创建订阅者。

说明

从API version 7 开始支持，从API version 9 开始废弃，建议使用commonEventManager.createSubscriber替代。

系统能力： SystemCapability.Notification.CommonEvent

参数：

展开
参数名 类型 必填 说明
subscribeInfo CommonEventSubscribeInfo 是 表示订阅信息。
callback AsyncCallback<CommonEventSubscriber> 是 表示创建订阅者的回调方法。

示例：

收起
自动换行
深色代码主题
复制
  1. import Base from '@ohos.base';
  2. import CommonEventManager from '@ohos.commonEventManager';
  3. 

  4. let subscriber:CommonEventManager.CommonEventSubscriber; // 用于保存创建成功的订阅者对象，后续使用其完成订阅及取消订阅的动作
  5. 

  6. // 订阅者信息
  7. let subscribeInfo:CommonEventManager.CommonEventSubscribeInfo = {
  8.     events: ["event"]
  9. };
  10. 

  11. // 创建订阅者回调
  12. let createCallBack = (err:Base.BusinessError, commonEventSubscriber:CommonEventManager.CommonEventSubscriber) => {
  13.     if (err.code) {
  14.         console.error(`createSubscriber failed, code is ${err.code}, message is ${err.message}`);
  15.     } else {
  16.         console.info("createSubscriber");
  17.         subscriber = commonEventSubscriber;
  18.     }
  19. }
  20. 

  21. // 创建订阅者
  22. commonEvent.createSubscriber(subscribeInfo, createCallBack);

commonEvent.createSubscriber(deprecated)

Phone12+PC/2in113+Tablet12+TV19+Wearable18+

createSubscriber(subscribeInfo: CommonEventSubscribeInfo): Promise<CommonEventSubscriber>

以Promise形式创建订阅者。

说明

从API version 7 开始支持，从API version 9 开始废弃，建议使用commonEventManager.createSubscriber替代。

系统能力： SystemCapability.Notification.CommonEvent

参数：

展开
参数名 类型 必填 说明
subscribeInfo CommonEventSubscribeInfo 是 表示订阅信息。

返回值：

展开
类型 说明
Promise<CommonEventSubscriber> 返回订阅者对象。

示例：

收起
自动换行
深色代码主题
复制
  1. import Base from '@ohos.base';
  2. import CommonEventManager from '@ohos.commonEventManager';
  3. 

  4. let subscriber:CommonEventManager.CommonEventSubscriber; // 用于保存创建成功的订阅者对象，后续使用其完成订阅及取消订阅的动作
  5. 

  6. // 订阅者信息
  7. let subscribeInfo:CommonEventManager.CommonEventSubscribeInfo = {
  8.     events: ["event"]
  9. };
  10. 

  11. // 创建订阅者
  12. commonEvent.createSubscriber(subscribeInfo).then((commonEventSubscriber:CommonEventManager.CommonEventSubscriber) => {
  13.     console.info("createSubscriber");
  14.     subscriber = commonEventSubscriber;
  15. }).catch((err:Base.BusinessError) => {
  16.     console.error(`createSubscriber failed, code is ${err.code}, message is ${err.message}`);
  17. });

commonEvent.subscribe(deprecated)

Phone12+PC/2in113+Tablet12+TV19+Wearable18+

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

以回调形式订阅公共事件。

说明

从API version 7 开始支持，从API version 9 开始废弃，建议使用commonEventManager.subscribe替代。

系统能力： SystemCapability.Notification.CommonEvent

参数：

展开
参数名 类型 必填 说明
subscriber CommonEventSubscriber 是 表示订阅者对象。
callback AsyncCallback<CommonEventData> 是 表示接收公共事件数据的回调方法。

示例：

收起
自动换行
深色代码主题
复制
  1. import Base from '@ohos.base';
  2. import CommonEventManager from '@ohos.commonEventManager';
  3. 

  4. let subscriber:CommonEventManager.CommonEventSubscriber; // 用于保存创建成功的订阅者对象，后续使用其完成订阅及取消订阅的动作
  5. 

  6. // 订阅者信息
  7. let subscribeInfo:CommonEventManager.CommonEventSubscribeInfo = {
  8.     events: ["event"]
  9. };
  10. 

  11. // 订阅公共事件回调
  12. let subscribeCallBack = (err:Base.BusinessError, data:CommonEventManager.CommonEventData) => {
  13.     if (err.code) {
  14.         console.error(`subscribe failed, code is ${err.code}, message is ${err.message}`);
  15.     } else {
  16.         console.info("subscribe " + JSON.stringify(data));
  17.     }
  18. }
  19. 

  20. // 创建订阅者回调
  21. let createCallBack = (err:Base.BusinessError, commonEventSubscriber:CommonEventManager.CommonEventSubscriber) => {
  22.     if (err.code) {
  23.         console.error(`createSubscriber failed, code is ${err.code}, message is ${err.message}`);
  24.     } else {
  25.         console.info("createSubscriber");
  26.         subscriber = commonEventSubscriber;
  27.          // 订阅公共事件
  28.         commonEvent.subscribe(subscriber, subscribeCallBack);
  29.     }
  30. }
  31. 

  32. // 创建订阅者
  33. commonEvent.createSubscriber(subscribeInfo, createCallBack);

commonEvent.unsubscribe(deprecated)

Phone12+PC/2in113+Tablet12+TV19+Wearable18+

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

以回调形式取消订阅公共事件。

说明

从API version 7 开始支持，从API version 9 开始废弃，建议使用commonEventManager.unsubscribe替代。

系统能力： SystemCapability.Notification.CommonEvent

参数：

展开
参数名 类型 必填 说明
subscriber CommonEventSubscriber 是 表示订阅者对象。
callback AsyncCallback<void> 否 表示取消订阅的回调方法。

示例：

收起
自动换行
深色代码主题
复制
  1. import Base from '@ohos.base';
  2. import CommonEventManager from '@ohos.commonEventManager';
  3. 

  4. let subscriber:CommonEventManager.CommonEventSubscriber;    // 用于保存创建成功的订阅者对象，后续使用其完成订阅及取消订阅的动作
  5. 

  6. // 订阅者信息
  7. let subscribeInfo:CommonEventManager.CommonEventSubscribeInfo = {
  8.     events: ["event"]
  9. };
  10. 

  11. // 订阅公共事件回调
  12. let subscribeCallBack = (err:Base.BusinessError, data:CommonEventManager.CommonEventData) => {
  13.     if (err.code) {
  14.         console.error(`subscribe failed, code is ${err.code}, message is ${err.message}`);
  15.     } else {
  16.         console.info("subscribe " + JSON.stringify(data));
  17.     }
  18. }
  19. 

  20. // 创建订阅者回调
  21. let createCallBack = (err:Base.BusinessError, commonEventSubscriber:CommonEventManager.CommonEventSubscriber) => {
  22.     if (err.code) {
  23.         console.error(`createSubscriber failed, code is ${err.code}, message is ${err.message}`);
  24.     } else {
  25.         console.info("createSubscriber");
  26.         subscriber = commonEventSubscriber;
  27.          // 订阅公共事件
  28.         commonEvent.subscribe(subscriber, subscribeCallBack);
  29.     }
  30. }
  31. 

  32. // 取消订阅公共事件回调
  33. let unsubscribeCallback = (err: Base.BusinessError) => {
  34.     if (err.code) {
  35.         console.error(`unsubscribe failed, code is ${err.code}, message is ${err.message}`);
  36.     } else {
  37.         console.info("unsubscribe");
  38.     }
  39. }
  40. 

  41. // 创建订阅者
  42. commonEvent.createSubscriber(subscribeInfo, createCallBack);
  43. 

  44. // 取消订阅公共事件
  45. // 注意：需在subscriber创建成功后（即createCallBack回调执行后）调用，此处仅展示API用法
  46. commonEvent.unsubscribe(subscriber, unsubscribeCallback);
系统公共事件定义
@ohos.usb (USB管理)
相关推荐
文档OH_CommonEvent
文档系统公共事件定义
文档@ohos.commonEventManager (公共事件模块)
文档系统定义的公共事件
文档oh_commonevent.h
文档CommonEventPublishData
文档CommonEventData
文档CommonEventSubscribeInfo
文档CommonEventSubscriber
文档@ohos.notification (Notification模块)
简体中文
华为开发者联盟 版权所有 ©2026
问题反馈
使用条款
华为开发者联盟用户协议
关于华为开发者联盟与隐私的声明
Cookies
开源软件声明
在 API参考 中进行搜索
请输入您想要搜索的关键词