About 11 min

CommonEvent模块(JS端SDK接口)

支持设备

API 手机 平板 智慧屏 智能穿戴 轻量级智能穿戴
CommonEvent.publish(event: string, callback: AsyncCallback) 支持 支持 支持 支持 不支持
CommonEvent.publish(event: string, options: CommonEventPublishData, callback: AsyncCallback) 支持 支持 支持 支持 不支持
CommonEvent.createSubscriber(subscribeInfo: CommonEventSubscribeInfo, callback: AsyncCallback) 支持 支持 支持 支持 不支持
CommonEvent.createSubscriber(subscribeInfo: CommonEventSubscribeInfo) 支持 支持 支持 支持 不支持
CommonEvent.subscribe(subscriber: CommonEventSubscriber, callback: AsyncCallback) 支持 支持 支持 支持 不支持
CommonEvent.unsubscribe(subscriber: CommonEventSubscriber, callback?: AsyncCallback) 支持 支持 支持 支持 不支持

权限列表

系统公共事件宏 系统公共事件名称 订阅者所需权限
COMMON_EVENT_BOOT_COMPLETED usual.event.BOOT_COMPLETED ohos.permission.RECEIVER_STARTUP_COMPLETED
COMMON_EVENT_LOCKED_BOOT_COMPLETED usual.event.LOCKED_BOOT_COMPLETED ohos.permission.RECEIVER_STARTUP_COMPLETED
COMMON_EVENT_SHUTDOWN usual.event.SHUTDOWN
COMMON_EVENT_BATTERY_CHANGED usual.event.BATTERY_CHANGED
COMMON_EVENT_BATTERY_LOW usual.event.BATTERY_LOW
COMMON_EVENT_BATTERY_OKAY usual.event.BATTERY_OKAY
COMMON_EVENT_POWER_CONNECTED usual.event.POWER_CONNECTED
COMMON_EVENT_POWER_DISCONNECTED usual.event.POWER_DISCONNECTED
COMMON_EVENT_SCREEN_OFF usual.event.SCREEN_OFF
COMMON_EVENT_SCREEN_ON usual.event.SCREEN_ON
COMMON_EVENT_USER_PRESENT usual.event.USER_PRESENT
COMMON_EVENT_TIME_TICK usual.event.TIME_TICK
COMMON_EVENT_TIME_CHANGED usual.event.TIME_CHANGED
COMMON_EVENT_DATE_CHANGED usual.event.DATE_CHANGED
COMMON_EVENT_TIMEZONE_CHANGED usual.event.TIMEZONE_CHANGED
COMMON_EVENT_CLOSE_SYSTEM_DIALOGS usual.event.CLOSE_SYSTEM_DIALOGS
COMMON_EVENT_PACKAGE_ADDED usual.event.PACKAGE_ADDED
COMMON_EVENT_PACKAGE_REPLACED usual.event.PACKAGE_REPLACED
COMMON_EVENT_MY_PACKAGE_REPLACED usual.event.MY_PACKAGE_REPLACED
COMMON_EVENT_PACKAGE_REMOVED usual.event.PACKAGE_REMOVED
COMMON_EVENT_PACKAGE_FULLY_REMOVED usual.event.PACKAGE_FULLY_REMOVED
COMMON_EVENT_PACKAGE_CHANGED usual.event.PACKAGE_CHANGED
COMMON_EVENT_PACKAGE_RESTARTED usual.event.PACKAGE_RESTARTED
COMMON_EVENT_PACKAGE_DATA_CLEARED usual.event.PACKAGE_DATA_CLEARED
COMMON_EVENT_PACKAGES_SUSPENDED usual.event.PACKAGES_SUSPENDED
COMMON_EVENT_PACKAGES_UNSUSPENDED usual.event.PACKAGES_UNSUSPENDED
COMMON_EVENT_MY_PACKAGE_SUSPENDED usual.event.MY_PACKAGE_SUSPENDED
COMMON_EVENT_MY_PACKAGE_UNSUSPENDED usual.event.MY_PACKAGE_UNSUSPENDED
COMMON_EVENT_UID_REMOVED usual.event.UID_REMOVED
COMMON_EVENT_PACKAGE_FIRST_LAUNCH usual.event.PACKAGE_FIRST_LAUNCH
COMMON_EVENT_PACKAGE_NEEDS_VERIFICATION usual.event.PACKAGE_NEEDS_VERIFICATION
COMMON_EVENT_PACKAGE_VERIFIED usual.event.PACKAGE_VERIFIED
COMMON_EVENT_EXTERNAL_APPLICATIONS_AVAILABLE usual.event.EXTERNAL_APPLICATIONS_AVAILABLE
COMMON_EVENT_EXTERNAL_APPLICATIONS_UNAVAILABLE usual.event.EXTERNAL_APPLICATIONS_UNAVAILABLE
COMMON_EVENT_CONFIGURATION_CHANGED usual.event.CONFIGURATION_CHANGED
COMMON_EVENT_LOCALE_CHANGED usual.event.LOCALE_CHANGED
COMMON_EVENT_MANAGE_PACKAGE_STORAGE usual.event.MANAGE_PACKAGE_STORAGE
COMMON_EVENT_DRIVE_MODE common.event.DRIVE_MODE
COMMON_EVENT_HOME_MODE common.event.HOME_MODE
COMMON_EVENT_OFFICE_MODE common.event.OFFICE_MODE
COMMON_EVENT_USER_STARTED usual.event.USER_STARTED
COMMON_EVENT_USER_BACKGROUND usual.event.USER_BACKGROUND
COMMON_EVENT_USER_FOREGROUND usual.event.USER_FOREGROUND
COMMON_EVENT_USER_SWITCHED usual.event.USER_SWITCHED ohos.permission.MANAGE_USERS
COMMON_EVENT_USER_STARTING usual.event.USER_STARTING ohos.permission.INTERACT_ACROSS_USERS
COMMON_EVENT_USER_UNLOCKED usual.event.USER_UNLOCKED
COMMON_EVENT_USER_STOPPING usual.event.USER_STOPPING ohos.permission.INTERACT_ACROSS_USERS
COMMON_EVENT_USER_STOPPED usual.event.USER_STOPPED
COMMON_EVENT_HWID_LOGIN common.event.HWID_LOGIN
COMMON_EVENT_HWID_LOGOUT common.event.HWID_LOGOUT
COMMON_EVENT_HWID_TOKEN_INVALID common.event.HWID_TOKEN_INVALID
COMMON_EVENT_HWID_LOGOFF common.event.HWID_LOGOFF
COMMON_EVENT_WIFI_POWER_STATE usual.event.wifi.POWER_STATE
COMMON_EVENT_WIFI_SCAN_FINISHED usual.event.wifi.SCAN_FINISHED ohos.permission.LOCATION
COMMON_EVENT_WIFI_RSSI_VALUE usual.event.wifi.RSSI_VALUE ohos.permission.GET_WIFI_INFO
COMMON_EVENT_WIFI_CONN_STATE usual.event.wifi.CONN_STATE
COMMON_EVENT_WIFI_HOTSPOT_STATE usual.event.wifi.HOTSPOT_STATE
COMMON_EVENT_WIFI_AP_STA_JOIN usual.event.wifi.WIFI_HS_STA_JOIN ohos.permission.GET_WIFI_INFO
COMMON_EVENT_WIFI_AP_STA_LEAVE usual.event.wifi.WIFI_HS_STA_LEAVE ohos.permission.GET_WIFI_INFO
COMMON_EVENT_WIFI_MPLINK_STATE_CHANGE usual.event.wifi.mplink.STATE_CHANGE ohos.permission.MPLINK_CHANGE_STATE
COMMON_EVENT_WIFI_P2P_CONN_STATE usual.event.wifi.p2p.CONN_STATE_CHANGE ohos.permission.GET_WIFI_INFO and ohos.permission.LOCATION
COMMON_EVENT_WIFI_P2P_STATE_CHANGED usual.event.wifi.p2p.STATE_CHANGE ohos.permission.GET_WIFI_INFO
COMMON_EVENT_WIFI_P2P_PEERS_STATE_CHANGED usual.event.wifi.p2p.DEVICES_CHANGE ohos.permission.GET_WIFI_INFO
COMMON_EVENT_WIFI_P2P_PEERS_DISCOVERY_STATE_CHANGED usual.event.wifi.p2p.PEER_DISCOVERY_STATE_CHANGE ohos.permission.GET_WIFI_INFO
COMMON_EVENT_WIFI_P2P_CURRENT_DEVICE_STATE_CHANGED usual.event.wifi.p2p.CURRENT_DEVICE_CHANGE ohos.permission.GET_WIFI_INFO
COMMON_EVENT_WIFI_P2P_GROUP_STATE_CHANGED usual.event.wifi.p2p.GROUP_STATE_CHANGED ohos.permission.GET_WIFI_INFO
COMMON_EVENT_BLUETOOTH_HANDSFREE_AG_CONNECT_STATE_UPDATE usual.event.bluetooth.handsfree.ag.CONNECT_STATE_UPDATE ohos.permission.USE_BLUETOOTH
COMMON_EVENT_BLUETOOTH_HANDSFREE_AG_CURRENT_DEVICE_UPDATE usual.event.bluetooth.handsfree.ag.CURRENT_DEVICE_UPDATE ohos.permission.USE_BLUETOOTH
COMMON_EVENT_BLUETOOTH_HANDSFREE_AG_AUDIO_STATE_UPDATE usual.event.bluetooth.handsfree.ag.AUDIO_STATE_UPDATE ohos.permission.USE_BLUETOOTH
COMMON_EVENT_BLUETOOTH_A2DPSOURCE_CONNECT_STATE_UPDATE usual.event.bluetooth.a2dpsource.CONNECT_STATE_UPDATE ohos.permission.USE_BLUETOOTH
COMMON_EVENT_BLUETOOTH_A2DPSOURCE_CURRENT_DEVICE_UPDATE usual.event.bluetooth.a2dpsource.CURRENT_DEVICE_UPDATE ohos.permission.USE_BLUETOOTH
COMMON_EVENT_BLUETOOTH_A2DPSOURCE_PLAYING_STATE_UPDATE usual.event.bluetooth.a2dpsource.PLAYING_STATE_UPDATE" ohos.permission.USE_BLUETOOTH
COMMON_EVENT_BLUETOOTH_A2DPSOURCE_AVRCP_CONNECT_STATE_UPDATE usual.event.bluetooth.a2dpsource.AVRCP_CONNECT_STATE_UPDATE ohos.permission.USE_BLUETOOTH
COMMON_EVENT_BLUETOOTH_A2DPSOURCE_CODEC_VALUE_UPDATE usual.event.bluetooth.a2dpsource.CODEC_VALUE_UPDATE ohos.permission.USE_BLUETOOTH
COMMON_EVENT_BLUETOOTH_REMOTEDEVICE_DISCOVERED usual.event.bluetooth.remotedevice.DISCOVERED ohos.permission.USE_BLUETOOTH and ohos.permission.LOCATION
COMMON_EVENT_BLUETOOTH_REMOTEDEVICE_CLASS_VALUE_UPDATE usual.event.bluetooth.remotedevice.CLASS_VALUE_UPDATE ohos.permission.USE_BLUETOOTH
COMMON_EVENT_BLUETOOTH_REMOTEDEVICE_ACL_CONNECTED usual.event.bluetooth.remotedevice.ACL_CONNECTED ohos.permission.USE_BLUETOOTH
COMMON_EVENT_BLUETOOTH_REMOTEDEVICE_ACL_DISCONNECTED usual.event.bluetooth.remotedevice.ACL_DISCONNECTED ohos.permission.USE_BLUETOOTH
COMMON_EVENT_BLUETOOTH_REMOTEDEVICE_NAME_UPDATE usual.event.bluetooth.remotedevice.NAME_UPDATE ohos.permission.USE_BLUETOOTH
COMMON_EVENT_BLUETOOTH_REMOTEDEVICE_PAIR_STATE usual.event.bluetooth.remotedevice.PAIR_STATE ohos.permission.USE_BLUETOOTH
COMMON_EVENT_BLUETOOTH_REMOTEDEVICE_BATTERY_VALUE_UPDATE usual.event.bluetooth.remotedevice.BATTERY_VALUE_UPDATE ohos.permission.USE_BLUETOOTH
COMMON_EVENT_BLUETOOTH_REMOTEDEVICE_SDP_RESULT usual.event.bluetooth.remotedevice.SDP_RESULT
COMMON_EVENT_BLUETOOTH_REMOTEDEVICE_UUID_VALUE usual.event.bluetooth.remotedevice.UUID_VALUE ohos.permission.DISCOVER_BLUETOOTH
COMMON_EVENT_BLUETOOTH_REMOTEDEVICE_PAIRING_REQ usual.event.bluetooth.remotedevice.PAIRING_REQ ohos.permission.DISCOVER_BLUETOOTH
COMMON_EVENT_BLUETOOTH_REMOTEDEVICE_PAIRING_CANCEL usual.event.bluetooth.remotedevice.PAIRING_CANCEL
COMMON_EVENT_BLUETOOTH_REMOTEDEVICE_CONNECT_REQ usual.event.bluetooth.remotedevice.CONNECT_REQ
COMMON_EVENT_BLUETOOTH_REMOTEDEVICE_CONNECT_REPLY usual.event.bluetooth.remotedevice.CONNECT_REPLY
COMMON_EVENT_BLUETOOTH_REMOTEDEVICE_CONNECT_CANCEL usual.event.bluetooth.remotedevice.CONNECT_CANCEL
COMMON_EVENT_BLUETOOTH_HANDSFREEUNIT_CONNECT_STATE_UPDATE usual.event.bluetooth.handsfreeunit.CONNECT_STATE_UPDATE
COMMON_EVENT_BLUETOOTH_HANDSFREEUNIT_AUDIO_STATE_UPDATE usual.event.bluetooth.handsfreeunit.AUDIO_STATE_UPDATE
COMMON_EVENT_BLUETOOTH_HANDSFREEUNIT_AG_COMMON_EVENT usual.event.bluetooth.handsfreeunit.AG_COMMON_EVENT
COMMON_EVENT_BLUETOOTH_HANDSFREEUNIT_AG_CALL_STATE_UPDATE usual.event.bluetooth.handsfreeunit.AG_CALL_STATE_UPDATE
COMMON_EVENT_BLUETOOTH_HOST_STATE_UPDATE usual.event.bluetooth.host.STATE_UPDATE
COMMON_EVENT_BLUETOOTH_HOST_REQ_DISCOVERABLE usual.event.bluetooth.host.REQ_DISCOVERABLE
COMMON_EVENT_BLUETOOTH_HOST_REQ_ENABLE usual.event.bluetooth.host.REQ_ENABLE ohos.permission.USE_BLUETOOTH
COMMON_EVENT_BLUETOOTH_HOST_REQ_DISABLE usual.event.bluetooth.host.REQ_DISABLE ohos.permission.USE_BLUETOOTH
COMMON_EVENT_BLUETOOTH_HOST_SCAN_MODE_UPDATE usual.event.bluetooth.host.SCAN_MODE_UPDATE ohos.permission.USE_BLUETOOTH
COMMON_EVENT_BLUETOOTH_HOST_DISCOVERY_STARTED usual.event.bluetooth.host.DISCOVERY_STARTED ohos.permission.USE_BLUETOOTH
COMMON_EVENT_BLUETOOTH_HOST_DISCOVERY_FINISHED usual.event.bluetooth.host.DISCOVERY_FINISHED ohos.permission.USE_BLUETOOTH
COMMON_EVENT_BLUETOOTH_HOST_NAME_UPDATE usual.event.bluetooth.host.NAME_UPDATE ohos.permission.USE_BLUETOOTH
COMMON_EVENT_BLUETOOTH_A2DPSINK_CONNECT_STATE_UPDATE usual.event.bluetooth.a2dpsink.CONNECT_STATE_UPDATE ohos.permission.USE_BLUETOOTH
COMMON_EVENT_BLUETOOTH_A2DPSINK_PLAYING_STATE_UPDATE usual.event.bluetooth.a2dpsink.PLAYING_STATE_UPDATE ohos.permission.USE_BLUETOOTH
COMMON_EVENT_BLUETOOTH_A2DPSINK_AUDIO_STATE_UPDATE usual.event.bluetooth.a2dpsink.AUDIO_STATE_UPDATE ohos.permission.USE_BLUETOOTH
COMMON_EVENT_NFC_ACTION_ADAPTER_STATE_CHANGED usual.event.nfc.action.ADAPTER_STATE_CHANGED
COMMON_EVENT_NFC_ACTION_RF_FIELD_ON_DETECTED usual.event.nfc.action.RF_FIELD_ON_DETECTED ohos.permission.MANAGE_SECURE_SETTINGS
COMMON_EVENT_NFC_ACTION_RF_FIELD_OFF_DETECTED usual.event.nfc.action.RF_FIELD_OFF_DETECTED ohos.permission.MANAGE_SECURE_SETTINGS
COMMON_EVENT_DISCHARGING usual.event.DISCHARGING
COMMON_EVENT_CHARGING usual.event.CHARGING
COMMON_EVENT_DEVICE_IDLE_MODE_CHANGED usual.event.DEVICE_IDLE_MODE_CHANGED
COMMON_EVENT_POWER_SAVE_MODE_CHANGED usual.event.POWER_SAVE_MODE_CHANGED
COMMON_EVENT_USER_ADDED usual.event.USER_ADDED ohos.permission.MANAGE_USERS
COMMON_EVENT_USER_REMOVED usual.event.USER_REMOVED ohos.permission.MANAGE_USERS
COMMON_EVENT_ABILITY_ADDED common.event.ABILITY_ADDED ohos.permission.LISTEN_BUNDLE_CHANGE
COMMON_EVENT_ABILITY_REMOVED common.event.ABILITY_REMOVED ohos.permission.LISTEN_BUNDLE_CHANGE
COMMON_EVENT_ABILITY_UPDATED common.event.ABILITY_UPDATED ohos.permission.LISTEN_BUNDLE_CHANGE
COMMON_EVENT_LOCATION_MODE_STATE_CHANGED usual.event.location.MODE_STATE_CHANGED
COMMON_EVENT_IVI_SLEEP common.event.IVI_SLEEP
COMMON_EVENT_IVI_PAUSE common.event.IVI_PAUSE
COMMON_EVENT_IVI_STANDBY common.event.IVI_STANDBY
COMMON_EVENT_IVI_LASTMODE_SAVE common.event.IVI_LASTMODE_SAVE
COMMON_EVENT_IVI_VOLTAGE_ABNORMAL common.event.IVI_VOLTAGE_ABNORMAL
COMMON_EVENT_IVI_HIGH_TEMPERATURE common.event.IVI_HIGH_TEMPERATURE
COMMON_EVENT_IVI_EXTREME_TEMPERATURE common.event.IVI_EXTREME_TEMPERATURE
COMMON_EVENT_IVI_TEMPERATURE_ABNORMAL common.event.IVI_TEMPERATURE_ABNORMAL
COMMON_EVENT_IVI_VOLTAGE_RECOVERY common.event.IVI_VOLTAGE_RECOVERY
COMMON_EVENT_IVI_TEMPERATURE_RECOVERY common.event.IVI_TEMPERATURE_RECOVERY
COMMON_EVENT_IVI_ACTIVE common.event.IVI_ACTIVE
COMMON_EVENT_USB_DEVICE_ATTACHED usual.event.hardware.usb.action.USB_DEVICE_ATTACHED
COMMON_EVENT_USB_DEVICE_DETACHED usual.event.hardware.usb.action.USB_DEVICE_DETACHED
COMMON_EVENT_USB_ACCESSORY_ATTACHED usual.event.hardware.usb.action.USB_ACCESSORY_ATTACHED
COMMON_EVENT_USB_ACCESSORY_DETACHED usual.event.hardware.usb.action.USB_ACCESSORY_DETACHED
COMMON_EVENT_DISK_REMOVED usual.event.data.DISK_REMOVED ohos.permission.WRITE_USER_STORAGE or ohos.permission.READ_USER_STORAGE
COMMON_EVENT_DISK_UNMOUNTED usual.event.data.DISK_UNMOUNTED ohos.permission.WRITE_USER_STORAGEor ohos.permission.READ_USER_STORAGE
COMMON_EVENT_DISK_MOUNTED usual.event.data.DISK_MOUNTED ohos.permission.WRITE_USER_STORAGEor ohos.permission.READ_USER_STORAGE
COMMON_EVENT_DISK_BAD_REMOVAL usual.event.data.DISK_BAD_REMOVAL ohos.permission.WRITE_USER_STORAGEor ohos.permission.READ_USER_STORAGE
COMMON_EVENT_DISK_UNMOUNTABLE usual.event.data.DISK_UNMOUNTABLE ohos.permission.WRITE_USER_STORAGEor ohos.permission.READ_USER_STORAGE
COMMON_EVENT_DISK_EJECT usual.event.data.DISK_EJECT ohos.permission.WRITE_USER_STORAGEor ohos.permission.READ_USER_STORAGE
COMMON_EVENT_VISIBLE_ACCOUNTS_UPDATED usual.event.data.VISIBLE_ACCOUNTS_UPDATED ohos.permission.GET_APP_ACCOUNTS
COMMON_EVENT_ACCOUNT_DELETED usual.event.data.ACCOUNT_DELETED ohos.permission.INTERACT_ACROSS_LOCAL_ACCOUNTS
COMMON_EVENT_FOUNDATION_READY common.event.FOUNDATION_READY ohos.permission.RECEIVER_STARTUP_COMPLETED
COMMON_EVENT_AIRPLANE_MODE_CHANGED usual.event.AIRPLANE_MODE

导入模块

import CommonEvent from '@ohos.commonevent';
1

CommonEvent.publish(event: string, callback: AsyncCallback)

  • 接口说明

    发布公共事件(callback形式)

  • publish参数描述

    名称 读写属性 类型 必填 描述
    event 只读 string 表示要发送的公共事件
    callback 只读 AsyncCallback 表示被指定的回调方法
  • 返回值

    void

  • 示例

//发布公共事件回调
function PublishCallBack(err) {
	console.info("==========================>PublishCallBack=======================>");
    console.info("==========================>err:=======================>", err.code);
}
//发布公共事件
CommonEvent.publish("publish_event", PublishCallBack);
1
2
3
4
5
6
7

CommonEvent.publish(event: string, options: CommonEventPublishData, callback: AsyncCallback)

  • 接口说明

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

  • publish参数描述

    名称 读写属性 类型 必填 描述
    event 只读 string 表示要发布的公共事件
    options 只读 CommonEventPublishData 表示发布公共事件的属性
    callback 只读 AsyncCallback 表示被指定的回调方法
  • CommonEventPublishData类型说明

    名称 读写属性 类型 必填 描述
    bundleName 只读 string 表示包名称
    code 只读 int 表示公共事件的结果代码
    data 只读 string 表示公共事件的自定义结果数据
    subscriberPermissions 只读 Array 表示订阅者的权限
    isOrdered 只读 bool 表示是否是有序事件
    parameters 只读 {[key: string]: any} 表示公共事件的附加信息
  • 返回值

    void

  • 示例

//公共事件相关信息
var options = {
	code: 0;			//公共事件的初始代码
	data: "initial data";//公共事件的初始数据
	isOrdered: true;	//有序公共事件
}
//发布公共事件回调
function PublishCallBack(err) {
	console.info("==========================>PublishCallBack=======================>");
}
//发布公共事件
CommonEvent.publish("publish_event", options, PublishCallBack);
1
2
3
4
5
6
7
8
9
10
11
12

CommonEvent.createSubscriber(subscribeInfo: CommonEventSubscribeInfo, callback: AsyncCallback)

  • 接口说明

    创建订阅者(callback形式)

  • createSubscriber参数描述

    名称 读写属性 类型 必填 描述
    subscribeInfo 只读 CommonEventSubscribeInfo 表示订阅信息
    callback 只读 AsyncCallback 表示创建订阅者的回调方法
  • CommonEventSubscriber 类说明

    名称 参数 返回值 描述
    getCode callback: AsyncCallback void 获取公共事件的结果代码(callback形式)
    getCode void Promise 获取公共事件的结果代码(Promise形式)
    setCode code: number, callback: AsyncCallback void 设置公共事件的结果代码(callback形式)
    setCode code: number Promise 设置公共事件的结果代码(Promise形式)
    getData callback: AsyncCallback void 获取公共事件的结果数据(callback形式)
    getData void Promise 获取公共事件的结果数据(Promise形式)
    setData data: string, callback: AsyncCallback void 设置公共事件的结果数据(callback形式)
    setData data: string Promise 设置公共事件的结果数据(Promise形式)
    setCodeAndData code: number, data: string, callback: AsyncCallback void 设置公共事件的结果代码和结果数据(callback形式)
    setCodeAndData code: number, data: string Promise 设置公共事件的结果代码和结果数据(Promise形式)
    isOrderedCommonEvent callback: AsyncCallback void 查询当前公共事件的是否为有序公共事件,返回true代表是有序公共事件,false代表不是有序公共事件(callback形式)
    isOrderedCommonEvent void Promise 查询当前公共事件的是否为有序公共事件,返回true代表是有序公共事件,false代表不是有序公共事件(Promise形式)
    abortCommonEvent callback: AsyncCallback void 取消当前的公共事件,仅对有序公共事件有效,取消后,公共事件不再向下一个订阅者传递(callback形式)
    abortCommonEvent void Promise 取消当前的公共事件,仅对有序公共事件有效,取消后,公共事件不再向下一个订阅者传递(Promise形式)
    clearAbortCommonEvent callback: AsyncCallback void 清除当前有序公共事件abort状态(callback形式)
    clearAbortCommonEvent void Promise 清除当前有序公共事件abort状态(Promise形式)
    getAbortCommonEvent callback: AsyncCallback void 获取当前有序公共事件是否取消的状态(callback形式)
    getAbortCommonEvent void Promise 获取当前有序公共事件是否取消的状态Promise形式)
    getSubscribeInfo callback: AsyncCallback void 获取订阅者的订阅信息(callback形式)
    getSubscribeInfo void Promise 获取订阅者的订阅信息(Promise形式)
  • CommonEventSubscribeInfo类型说明

    名称 读写属性 类型 必填 描述
    events 只读 Array 表示要订阅的公共事件
    publisherPermission 只读 string 表示发布者的权限
    publisherDeviceId 只读 int 表示设备ID,该值必须是同一ohos网络上的现有设备ID
    userId 只读 int 表示用户ID。此参数是可选的,默认值当前用户的ID。如果指定了此参数,则该值必须是系统中现有的用户ID。
    priority 只读 int 表示订阅者的优先级,范围为-100~1000。
  • 返回值

    void

  • 示例

var subscriber; //用于保存创建成功的订阅者对象,后续使用其完成订阅及退订的动作
//订阅者信息
var subscribeInfo = {
	events: ["event"]
};
//创建订阅者回调
function CreateSubscriberCallBack(err, data) {
    console.info("==========================>CreateSubscriberCallBack=======================>");
    subscriber = data;
}
//创建订阅者
CommonEvent.createSubscriber(subscribeInfo, CreateSubscriberCallBack);
1
2
3
4
5
6
7
8
9
10
11
12

CommonEvent.createSubscriber(subscribeInfo: CommonEventSubscribeInfo)

  • 接口说明

    创建订阅者(Promise形式)

  • createSubscriber参数描述

    名称 读写属性 类型 必填 描述
    subscribeInfo 只读 CommonEventSubscribeInfo 表示订阅信息
  • CommonEventSubscribeInfo类型说明

    名称 读写属性 类型 必填 描述
    events 只读 Array 表示要发送的公共事件
    publisherPermission 只读 string 表示发布者的权限
    publisherDeviceId 只读 int 表示设备ID,该值必须是同一ohos网络上的现有设备ID
    userId 只读 int 表示用户ID。此参数是可选的,默认值当前用户的ID。如果指定了此参数,则该值必须是系统中现有的用户ID。
    priority 只读 int 表示订阅者的优先级。值的范围是-100到1000
  • 返回值

    Promise

  • 示例

var subscriber; //用于保存创建成功的订阅者对象,后续使用其完成订阅及退订的动作
//订阅者信息
var subscribeInfo = {
	events: ["event"]
};
//创建订阅者
CommonEvent.createSubscriber(subscribeInfo).then((data) => {
	console.info("==========================>createSubscriberPromise=======================>");
    subscriber = data;
});
1
2
3
4
5
6
7
8
9
10

CommonEvent.subscribe(subscriber: CommonEventSubscriber, callback: AsyncCallback)

  • 接口说明

    订阅公共事件(callback形式)

  • subscribe参数描述

    名称 读写属性 类型 必填 描述
    subscriber 只读 CommonEventSubscriber 表示订阅者对象
    callback 只读 AsyncCallback 表示接收公共事件数据的回调函数
  • CommonEventData类型说明

    名称 读写属性 类型 必填 描述
    event 只读 string 表示当前接收的公共事件名称
    bundleName 只读 string 表示包名称
    code 只读 int 表示公共事件的结果代码,用于传递int类型的数据
    data 只读 string 表示公共事件的自定义结果数据,用于传递string 类型的数据
    parameters 只读 {[key: string]: any} 表示公共事件的附加信息
  • 返回值

    void

  • 示例

    • 无序事件:

      var subscriber; //用于保存创建成功的订阅者对象,后续使用其完成订阅及退订的动作
      //订阅者信息
      var subscribeInfo = {
      	events: ["event"]
      };
      //订阅公共事件回调
      function SubscribeCallBack(err, data) {
          console.info("==========================>SubscribeCallBack=======================>");
      }
      //创建订阅者回调
      function CreateSubscriberCallBack(err, data) {
      	console.info("==========================>CreateSubscriberCallBack=======================>");
      	subscriber = data;
      	//订阅公共事件
      	CommonEvent.subscribe(subscriber, SubscribeCallBack);
      }
      //创建订阅者
      CommonEvent.createSubscriber(subscribeInfo, CreateSubscriberCallBack);
      
      1
      2
      3
      4
      5
      6
      7
      8
      9
      10
      11
      12
      13
      14
      15
      16
      17
      18
    • 有序事件

    var subscriber; //用于保存创建成功的订阅者对象,后续使用其完成订阅及退订的动作 //订阅者信息 var subscribeInfo = { events: ["event"] };

    //设置有序公共事件的结果代码回调 function SetCodeCallBack(err) { console.info("==========================>SetCodeCallBack=======================>"); } //设置有序公共事件的结果数据回调 function SetDataCallBack(err) { console.info("==========================>SetDataCallBack=======================>"); } //完成本次有序公共事件处理回调 function FinishCommonEventCallBack(err) { console.info("==========================>FinishCommonEventCallBack=======================>"); } //订阅公共事件回调 function SubscribeCallBack(err, data) { console.info("==========================>SubscribeCallBack=======================>"); //设置有序公共事件的结果代码 subscriber.setCode(0, SetCodeCallBack); //设置有序公共事件的结果数据 subscriber.setData("publish_data_changed", SetDataCallBack); //完成本次有序公共事件处理 subscriber.finishCommonEvent(FinishCommonEventCallBack) }

    //创建订阅者回调 function CreateSubscriberCallBack(err, data) { console.info("==========================>CreateSubscriberCallBack=======================>"); subscriber = data; //订阅公共事件 CommonEvent.subscribe(subscriber, SubscribeCallBack); }

    //创建订阅者 CommonEvent.createSubscriber(subscribeInfo, CreateSubscriberCallBack);

    
    
    
    
    1
    2
    3

CommonEvent.unsubscribe(subscriber: CommonEventSubscriber, callback?: AsyncCallback)

  • 接口说明

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

  • unsubscribe参数描述

    名称 读写属性 类型 必填 描述
    subscriber 只读 CommonEventSubscriber 表示订阅者对象
    callback 只读 AsyncCallback 表示取消订阅的回调方法
  • 返回值

    void

  • 示例

var subscriber;	//用于保存创建成功的订阅者对象,后续使用其完成订阅及退订的动作
//订阅者信息
var subscribeInfo = {
	events: ["event"]
};
//订阅公共事件回调
function SubscribeCallBack(err, data) {
	console.info("==========================>SubscribeCallBack=======================>");
}
//创建订阅者回调
function CreateSubscriberCallBack(err, data) {
	console.info("==========================>CreateSubscriberCallBack=======================>");
	subscriber = data;
	//订阅公共事件
	CommonEvent.subscribe(subscriber, SubscribeCallBack);
}
//取消订阅公共事件回调
function UnsubscribeCallBack(err) {
	console.info("==========================>UnsubscribeCallBack=======================>");
}
//创建订阅者
CommonEvent.createSubscriber(subscribeInfo, CreateSubscriberCallBack);
//取消订阅公共事件
CommonEvent.unsubscribe(subscriber, UnsubscribeCallBack);
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24