Skip to content

D
Docs

OpenHarmony / Docs
大约 1 年 前同步成功

通知 159
Star 292
Fork 28
D
Docs
未验证 提交 09f815f8 编写于 作者: O openharmony_ci 提交者： Gitee
浏览文件
操作

!2767 2600 处理完成：补齐系统公共事件 

Merge pull request !2767 from ester.zhou/TR1-2600
上级 04195efb 958994e2
隐藏空白更改
内联 并排
Showing with 291 addition and 152 deletion
en/application-dev/reference/apis/js-apis-commonEvent.md
浏览文件 @ 09f815f8
# CommonEvent
> **Note:**
> ![icon-note.gif](public_sys-resources/icon-note.gif) **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.
## Required Permissions
......@@ -9,62 +9,63 @@
| ------------ | ------------------ | ---------------------- |
| 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 | N/A |
| COMMON_EVENT_BATTERY_CHANGED | usual.event.BATTERY_CHANGED | N/A |
| COMMON_EVENT_BATTERY_LOW | usual.event.BATTERY_LOW | N/A |
| COMMON_EVENT_BATTERY_OKAY | usual.event.BATTERY_OKAY | N/A |
| COMMON_EVENT_POWER_CONNECTED | usual.event.POWER_CONNECTED | N/A |
| COMMON_EVENT_POWER_DISCONNECTED | usual.event.POWER_DISCONNECTED | N/A |
| COMMON_EVENT_SCREEN_OFF | usual.event.SCREEN_OFF | N/A |
| COMMON_EVENT_SCREEN_ON | usual.event.SCREEN_ON | N/A |
| COMMON_EVENT_THERMAL_LEVEL_CHANGED | usual.event.THERMAL_LEVEL_CHANGED | N/A |
| COMMON_EVENT_USER_PRESENT | usual.event.USER_PRESENT | N/A |
| COMMON_EVENT_TIME_TICK | usual.event.TIME_TICK | N/A |
| COMMON_EVENT_TIME_CHANGED | usual.event.TIME_CHANGED | N/A |
| COMMON_EVENT_DATE_CHANGED | usual.event.DATE_CHANGED | N/A |
| COMMON_EVENT_TIMEZONE_CHANGED | usual.event.TIMEZONE_CHANGED | N/A |
| COMMON_EVENT_CLOSE_SYSTEM_DIALOGS | usual.event.CLOSE_SYSTEM_DIALOGS | N/A |
| COMMON_EVENT_PACKAGE_ADDED | usual.event.PACKAGE_ADDED | N/A |
| COMMON_EVENT_PACKAGE_REPLACED | usual.event.PACKAGE_REPLACED | N/A |
| COMMON_EVENT_MY_PACKAGE_REPLACED | usual.event.MY_PACKAGE_REPLACED | N/A |
| COMMON_EVENT_PACKAGE_REMOVED | usual.event.PACKAGE_REMOVED | N/A |
| COMMON_EVENT_PACKAGE_FULLY_REMOVED | usual.event.PACKAGE_FULLY_REMOVED | N/A |
| COMMON_EVENT_PACKAGE_CHANGED | usual.event.PACKAGE_CHANGED | N/A |
| COMMON_EVENT_PACKAGE_RESTARTED | usual.event.PACKAGE_RESTARTED | N/A |
| COMMON_EVENT_PACKAGE_DATA_CLEARED | usual.event.PACKAGE_DATA_CLEARED | N/A |
| COMMON_EVENT_PACKAGES_SUSPENDED | usual.event.PACKAGES_SUSPENDED | N/A |
| COMMON_EVENT_PACKAGES_UNSUSPENDED | usual.event.PACKAGES_UNSUSPENDED | N/A |
| COMMON_EVENT_MY_PACKAGE_SUSPENDED | usual.event.MY_PACKAGE_SUSPENDED | N/A |
| COMMON_EVENT_MY_PACKAGE_UNSUSPENDED | usual.event.MY_PACKAGE_UNSUSPENDED | N/A |
| COMMON_EVENT_UID_REMOVED | usual.event.UID_REMOVED | N/A |
| COMMON_EVENT_PACKAGE_FIRST_LAUNCH | usual.event.PACKAGE_FIRST_LAUNCH | N/A |
| COMMON_EVENT_PACKAGE_NEEDS_VERIFICATION | usual.event.PACKAGE_NEEDS_VERIFICATION | N/A |
| COMMON_EVENT_PACKAGE_VERIFIED | usual.event.PACKAGE_VERIFIED | N/A |
| COMMON_EVENT_EXTERNAL_APPLICATIONS_AVAILABLE | usual.event.EXTERNAL_APPLICATIONS_AVAILABLE | N/A |
| COMMON_EVENT_EXTERNAL_APPLICATIONS_UNAVAILABLE | usual.event.EXTERNAL_APPLICATIONS_UNAVAILABLE | N/A |
| COMMON_EVENT_CONFIGURATION_CHANGED | usual.event.CONFIGURATION_CHANGED | N/A |
| COMMON_EVENT_LOCALE_CHANGED | usual.event.LOCALE_CHANGED | N/A |
| COMMON_EVENT_MANAGE_PACKAGE_STORAGE | usual.event.MANAGE_PACKAGE_STORAGE | N/A |
| COMMON_EVENT_DRIVE_MODE | common.event.DRIVE_MODE | N/A |
| COMMON_EVENT_HOME_MODE | common.event.HOME_MODE | N/A |
| COMMON_EVENT_OFFICE_MODE | common.event.OFFICE_MODE | N/A |
| COMMON_EVENT_USER_STARTED | usual.event.USER_STARTED | N/A |
| COMMON_EVENT_USER_BACKGROUND | usual.event.USER_BACKGROUND | N/A |
| COMMON_EVENT_USER_FOREGROUND | usual.event.USER_FOREGROUND | N/A |
| 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_THERMAL_LEVEL_CHANGED | usual.event.THERMAL_LEVEL_CHANGED | - |
| 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_BUNDLE_REMOVED | usual.event.BUNDLE_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 | N/A |
| 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 | N/A |
| COMMON_EVENT_HWID_LOGIN | common.event.HWID_LOGIN | N/A |
| COMMON_EVENT_HWID_LOGOUT | common.event.HWID_LOGOUT | N/A |
| COMMON_EVENT_HWID_TOKEN_INVALID | common.event.HWID_TOKEN_INVALID | N/A |
| COMMON_EVENT_HWID_LOGOFF | common.event.HWID_LOGOFF | N/A |
| COMMON_EVENT_WIFI_POWER_STATE | usual.event.wifi.POWER_STATE | N/A |
| 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 | N/A |
| COMMON_EVENT_WIFI_HOTSPOT_STATE | usual.event.wifi.HOTSPOT_STATE | N/A |
| 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 |
......@@ -82,26 +83,26 @@
| 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.LOCATION |
| COMMON_EVENT_BLUETOOTH_REMOTEDEVICE_DISCOVERED | usual.event.bluetooth.remotedevice.DISCOVERED | ohos.permission.LOCATION and ohos.permission.USE_BLUETOOTH |
| 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 | N/A |
| 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 | N/A |
| COMMON_EVENT_BLUETOOTH_REMOTEDEVICE_CONNECT_REQ | usual.event.bluetooth.remotedevice.CONNECT_REQ | N/A |
| COMMON_EVENT_BLUETOOTH_REMOTEDEVICE_CONNECT_REPLY | usual.event.bluetooth.remotedevice.CONNECT_REPLY | N/A |
| COMMON_EVENT_BLUETOOTH_REMOTEDEVICE_CONNECT_CANCEL | usual.event.bluetooth.remotedevice.CONNECT_CANCEL | N/A |
| COMMON_EVENT_BLUETOOTH_HANDSFREEUNIT_CONNECT_STATE_UPDATE | usual.event.bluetooth.handsfreeunit.CONNECT_STATE_UPDATE | N/A |
| COMMON_EVENT_BLUETOOTH_HANDSFREEUNIT_AUDIO_STATE_UPDATE | usual.event.bluetooth.handsfreeunit.AUDIO_STATE_UPDATE | N/A |
| COMMON_EVENT_BLUETOOTH_HANDSFREEUNIT_AG_COMMON_EVENT | usual.event.bluetooth.handsfreeunit.AG_COMMON_EVENT | N/A |
| COMMON_EVENT_BLUETOOTH_HANDSFREEUNIT_AG_CALL_STATE_UPDATE | usual.event.bluetooth.handsfreeunit.AG_CALL_STATE_UPDATE | N/A |
| 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 | ohos.permission.USE_BLUETOOTH |
| COMMON_EVENT_BLUETOOTH_HOST_REQ_DISCOVERABLE | usual.event.bluetooth.host.REQ_DISCOVERABLE | N/A |
| 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 |
......@@ -111,34 +112,34 @@
| 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 | N/A |
| 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 | N/A |
| COMMON_EVENT_CHARGING | usual.event.CHARGING | N/A |
| COMMON_EVENT_DEVICE_IDLE_MODE_CHANGED | usual.event.DEVICE_IDLE_MODE_CHANGED | N/A |
| COMMON_EVENT_POWER_SAVE_MODE_CHANGED | usual.event.POWER_SAVE_MODE_CHANGED | N/A |
| 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 | usual.event.ABILITY_ADDED | ohos.permission.LISTEN_BUNDLE_CHANGE |
| COMMON_EVENT_ABILITY_REMOVED | usual.event.ABILITY_REMOVED | ohos.permission.LISTEN_BUNDLE_CHANGE |
| COMMON_EVENT_ABILITY_UPDATED | usual.event.ABILITY_UPDATED | ohos.permission.LISTEN_BUNDLE_CHANGE |
| COMMON_EVENT_LOCATION_MODE_STATE_CHANGED | usual.event.location.MODE_STATE_CHANGED | N/A |
| COMMON_EVENT_IVI_SLEEP | common.event.IVI_SLEEP | N/A |
| COMMON_EVENT_IVI_PAUSE | common.event.IVI_PAUSE | N/A |
| COMMON_EVENT_IVI_STANDBY | common.event.IVI_STANDBY | N/A |
| COMMON_EVENT_IVI_LASTMODE_SAVE | common.event.IVI_LASTMODE_SAVE | N/A |
| COMMON_EVENT_IVI_VOLTAGE_ABNORMAL | common.event.IVI_VOLTAGE_ABNORMAL | N/A |
| COMMON_EVENT_IVI_HIGH_TEMPERATURE | common.event.IVI_HIGH_TEMPERATURE | N/A |
| COMMON_EVENT_IVI_EXTREME_TEMPERATURE | common.event.IVI_EXTREME_TEMPERATURE | N/A |
| COMMON_EVENT_IVI_TEMPERATURE_ABNORMAL | common.event.IVI_TEMPERATURE_ABNORMAL | N/A |
| COMMON_EVENT_IVI_VOLTAGE_RECOVERY | common.event.IVI_VOLTAGE_RECOVERY | N/A |
| COMMON_EVENT_IVI_TEMPERATURE_RECOVERY | common.event.IVI_TEMPERATURE_RECOVERY | N/A |
| COMMON_EVENT_IVI_ACTIVE | common.event.IVI_ACTIVE | N/A |
| COMMON_EVENT_USB_DEVICE_ATTACHED | usual.event.hardware.usb.action.USB_DEVICE_ATTACHED | N/A |
| COMMON_EVENT_USB_DEVICE_DETACHED | usual.event.hardware.usb.action.USB_DEVICE_DETACHED | N/A |
| COMMON_EVENT_USB_ACCESSORY_ATTACHED | usual.event.hardware.usb.action.USB_ACCESSORY_ATTACHED | N/A |
| COMMON_EVENT_USB_ACCESSORY_DETACHED | usual.event.hardware.usb.action.USB_ACCESSORY_DETACHED | N/A |
| 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_STORAGE or ohos.permission.READ_USER_STORAGE|
| COMMON_EVENT_DISK_MOUNTED | usual.event.data.DISK_MOUNTED | ohos.permission.WRITE_USER_STORAGE or ohos.permission.READ_USER_STORAGE|
......@@ -153,7 +154,7 @@
| 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 | usual.event.data.FOUNDATION_READY | ohos.permission.RECEIVER_STARTUP_COMPLETED |
| COMMON_EVENT_AIRPLANE_MODE_CHANGED | usual.event.AIRPLANE_MODE | N/A |
| COMMON_EVENT_AIRPLANE_MODE_CHANGED | usual.event.AIRPLANE_MODE | - |
| COMMON_EVENT_SPLIT_SCREEN | usual.event.SPLIT_SCREEN | ohos.permission.RECEIVER_SPLIT_SCREEN |
## Modules to Import
......@@ -174,8 +175,8 @@ Publishes a common event. This API uses a callback to return the result.
| Name | Readable/Writable| Type | Mandatory| Description |
| -------- | -------- | -------------------- | ---- | ---------------------- |
| event | Read-only | string | Yes | Name of the common event to publish.|
| callback | Read-only | AsyncCallback\<void> | Yes | Callback used to return the result.|
| event | Read only | string | Yes | Name of the common event to publish.|
| callback | Read only | AsyncCallback\<void> | Yes | Callback used to return the result.|
**Example**
......@@ -207,9 +208,9 @@ Publishes a common event with given attributes. This API uses a callback to retu
| Name | Readable/Writable| Type | Mandatory| Description |
| -------- | -------- | ---------------------- | ---- | ---------------------- |
| event | Read-only | string | Yes | Name of the common event to publish. |
| options | Read-only | [CommonEventPublishData](#commoneventpublishdata) | Yes | Attributes of the common event to publish.|
| callback | Read-only | AsyncCallback\<void> | Yes | Callback used to return the result. |
| event | Read only | string | Yes | Name of the common event to publish. |
| options | Read only | [CommonEventPublishData](#commoneventpublishdata) | Yes | Attributes of the common event to publish.|
| callback | Read only | AsyncCallback\<void> | Yes | Callback used to return the result. |
**Example**
......@@ -249,9 +250,9 @@ Publishes a common event to a specific user. This API uses a callback to return
| Name | Readable/Writable| Type | Mandatory| Description |
| -------- | -------- | -------------------- | ---- | ---------------------------------- |
| event | Read-only | string | Yes | Name of the common event to publish. |
| userId | Read-only | number | Yes | User ID.|
| callback | Read-only | AsyncCallback\<void> | Yes | Callback used to return the result. |
| event | Read only | string | Yes | Name of the common event to publish. |
| userId | Read only | number | Yes | User ID.|
| callback | Read only | AsyncCallback\<void> | Yes | Callback used to return the result. |
**Example**
......@@ -286,10 +287,10 @@ Publishes a common event with given attributes to a specific user. This API uses
| Name | Readable/Writable| Type | Mandatory| Description |
| -------- | -------- | ---------------------- | ---- | ---------------------- |
| event | Read-only | string | Yes | Name of the common event to publish. |
| userId | Read-only| number | Yes| User ID.|
| options | Read-only | [CommonEventPublishData](#commoneventpublishdata) | Yes | Attributes of the common event to publish.|
| callback | Read-only | AsyncCallback\<void> | Yes | Callback used to return the result. |
| event | Read only | string | Yes | Name of the common event to publish. |
| userId | Read only| number | Yes| User ID.|
| options | Read only | [CommonEventPublishData](#commoneventpublishdata) | Yes | Attributes of the common event to publish.|
| callback | Read only | AsyncCallback\<void> | Yes | Callback used to return the result. |
**Example**
......@@ -331,8 +332,8 @@ Creates a subscriber. This API uses a callback to return the result.
| Name | Readable/Writable| Type | Mandatory| Description |
| ------------- | -------- | ------------------------------------------------------------ | ---- | -------------------------- |
| subscribeInfo | Read-only | [CommonEventSubscribeInfo](#commoneventsubscribeinfo) | Yes | Subscriber information. |
| callback | Read-only | AsyncCallback\<[CommonEventSubscriber](#commoneventsubscriber)> | Yes | Callback used to return the result.|
| subscribeInfo | Read only | [CommonEventSubscribeInfo](#commoneventsubscribeinfo) | Yes | Subscriber information. |
| callback | Read only | AsyncCallback\<[CommonEventSubscriber](#commoneventsubscriber)> | Yes | Callback used to return the result.|
**Example**
......@@ -373,7 +374,7 @@ Creates a subscriber. This API uses a promise to return the result.
| Name | Readable/Writable| Type | Mandatory| Description |
| ------------- | -------- | ----------------------------------------------------- | ---- | -------------- |
| subscribeInfo | Read-only | [CommonEventSubscribeInfo](#commoneventsubscribeinfo) | Yes | Subscriber information.|
| subscribeInfo | Read only | [CommonEventSubscribeInfo](#commoneventsubscribeinfo) | Yes | Subscriber information.|
**Return value**
| Type | Description |
......@@ -413,8 +414,8 @@ Subscribes to common events. This API uses a callback to return the result.
| Name | Readable/Writable| Type | Mandatory| Description |
| ---------- | -------- | --------------------------------------------------- | ---- | -------------------------------- |
| subscriber | Read-only | [CommonEventSubscriber](#commoneventsubscriber) | Yes | Subscriber object. |
| callback | Read-only | AsyncCallback\<[CommonEventData](#commoneventdata)> | Yes | Callback used to return the result.|
| subscriber | Read only | [CommonEventSubscriber](#commoneventsubscriber) | Yes | Subscriber object. |
| callback | Read only | AsyncCallback\<[CommonEventData](#commoneventdata)> | Yes | Callback used to return the result.|
**Example**
......@@ -451,7 +452,7 @@ function CreateSubscriberCallBack(err, commonEventSubscriber) {
CommonEvent.createSubscriber(subscribeInfo, CreateSubscriberCallBack);
```
## CommonEvent.unsubscribe
......@@ -463,10 +464,10 @@ Unsubscribes from common events. This API uses a callback to return the result.
**Parameters**
| Name | Readable/Writable| Type | Mandatory| Description |
| ---------- | -------- | --------------------- | ---- | ------------------------ |
| subscriber | Read-only | CommonEventSubscriber | Yes | Subscriber object. |
| callback | Read-only | AsyncCallback\<void> | Yes | Callback used to return the result.|
| Name | Readable/Writable| Type | Mandatory| Description |
| ---------- | -------- | ----------------------------------------------- | ---- | ------------------------ |
| subscriber | Read only | [CommonEventSubscriber](#commoneventsubscriber) | Yes | Subscriber object. |
| callback | Read only | AsyncCallback\<void> | No | Callback used to return the result.|
**Example**
......@@ -515,43 +516,6 @@ CommonEvent.createSubscriber(subscribeInfo, CreateSubscriberCallBack);
CommonEvent.unsubscribe(subscriber, UnsubscribeCallBack);
```
## CommonEventPublishData
**System capability**: SystemCapability.Notification.CommonEvent
| Name | Readable/Writable| Type | Mandatory| Description |
| --------------------- | -------- | -------------------- | ---- | ---------------------------- |
| bundleName | Read-only | string | No | Bundle name. |
| code | Read-only | number | No | Result code of the common event. |
| data | Read-only | string | No | Custom result data of the common event.|
| subscriberPermissions | Read-only | Array\<string> | No | Permissions required for subscribers to receive the common event. |
| isOrdered | Read-only | boolean | No | Whether the common event is an ordered one. |
| parameters | Read-only | {[key: string]: any} | No | Additional information about the common event. |
## CommonEventSubscribeInfo
**System capability**: SystemCapability.Notification.CommonEvent
| Name | Readable/Writable| Type | Mandatory| Description |
| ------------------- | -------- | -------------- | ---- | ------------------------------------------------------------ |
| events | Read-only | Array\<string> | Yes | Common events to subscribe to. |
| publisherPermission | Read-only | string | No | Permission required for the publisher. |
| publisherDeviceId | Read-only | string | No | Device ID. The value must be the ID of an existing device on the same network. |
| userId | Read-only | number | No | User ID. The default value is the ID of the current user. If this parameter is specified, the value must be an existing user ID in the system.|
| priority | Read-only | number | No | Subscriber priority. The value ranges from -100 to 1000. |
## CommonEventData
**System capability**: SystemCapability.Notification.CommonEvent
| Name | Readable/Writable| Type | Mandatory| Description |
| ---------- | -------- | -------------------- | ---- | ------------------------------------------------------- |
| event | Read-only | string | Yes | Name of the common event to subscribe to. |
| bundleName | Read-only | string | No | Bundle name. |
| code | Read-only | number | No | Result code of the common event, which is used to transfer data of the int type. |
| data | Read-only | string | No | Custom result data of the common event, which is used to transfer data of the string type.|
| parameters | Read-only | {[key: string]: any} | No | Additional information about the common event. |
## CommonEventSubscriber
### getCode
......@@ -574,7 +538,6 @@ Obtains the result code of this common event. This API uses a callback to return
var subscriber; // Subscriber object successfully created.
// Callback for result data setting of an ordered common event
getCode() {
function getCodeCallback(err, Code) {
if (err.code) {
console.error("getCode failed " + JSON.stringify(err));
......@@ -654,7 +617,13 @@ Sets the result code for this common event. This API uses a promise to return th
| Name| Type | Mandatory| Description |
| ------ | ------ | ---- | ------------------ |
| code | number | Yes | Callback used to return the result code.|
| code | number | Yes | Result code of the common event.|
**Return value**
| Type | Description |
| ---------------- | -------------------- |
| Promise\<void> | Promise used to return the result code.|
**Example**
......@@ -680,7 +649,7 @@ Obtains the result data of this common event. This API uses a callback to return
| Name | Type | Mandatory| Description |
| -------- | ---------------------- | ---- | -------------------- |
| callback | AsyncCallback\<string> | Yes | Callback used to return the result data.|
| callback | AsyncCallback\<string> | Yes | Result data of the common event.|
**Example**
......@@ -710,7 +679,7 @@ Obtains the result data of this common event. This API uses a promise to return
| Type | Description |
| ---------------- | ------------------ |
| Promise\<string> | Promise used to return the result data.|
| Promise\<string> | Result data of the common event.|
**Example**
......@@ -767,7 +736,13 @@ Sets the result data for this common event. This API uses a promise to return th
| Name| Type | Mandatory| Description |
| ------ | ------ | ---- | -------------------- |
| data | string | Yes | Callback used to return the result data.|
| data | string | Yes | Result data of the common event.|
**Return value**
| Type | Description |
| ---------------- | -------------------- |
| Promise\<void> | Promise used to return the result.|
**Example**
......@@ -826,7 +801,13 @@ Sets the result code and result data for this common event. This API uses a prom
| Name| Type | Mandatory| Description |
| ------ | ------ | ---- | -------------------- |
| code | number | Yes | Result code of the common event.|
| data | string | Yes | Callback used to return the result data.|
| data | string | Yes | Result data of the common event.|
**Return value**
| Type | Description |
| ---------------- | -------------------- |
| Promise\<void> | Promise used to return the result.|
**Example**
......@@ -896,6 +877,62 @@ subscriber.isOrderedCommonEvent().then((isOrdered) => {
});
```
### isStickyCommonEvent
isStickyCommonEvent(callback: AsyncCallback\<boolean>): void
Checks whether this common event is a sticky one. This API uses a callback to return the result.
**System capability**: SystemCapability.Notification.CommonEvent
**Parameters**
| Name | Type | Mandatory| Description |
| -------- | ----------------------- | ---- | ---------------------------------- |
| callback | AsyncCallback\<boolean> | Yes | Returns **true** if the common event is a sticky one; returns **false** otherwise.|
**Example**
```js
var subscriber; // Subscriber object successfully created.
// Callback for result data setting of an ordered common event
function isStickyCallback(err, isSticky) {
if (err.code) {
console.error("isStickyCommonEvent failed " + JSON.stringify(err));
} else {
console.info("isSticky " + JSON.stringify(isSticky));
}
}
subscriber.isStickyCommonEvent(isStickyCallback);
```
### isStickyCommonEvent
isStickyCommonEvent(): Promise\<boolean>
Checks whether this 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> | Returns **true** if the common event is a sticky one; returns **false** otherwise.|
**Example**
```js
var subscriber; // Subscriber object successfully created.
subscriber.isStickyCommonEvent().then((isSticky) => {
console.info("isSticky " + JSON.stringify(isSticky));
}).catch((err) => {
console.error("isSticky failed " + JSON.stringify(err));
});
```
### abortCommonEvent
abortCommonEvent(callback: AsyncCallback\<void>): void
......@@ -934,6 +971,12 @@ Aborts this common event. After the abort, the common event is not sent to the n
**System capability**: SystemCapability.Notification.CommonEvent
**Return value**
| Type | Description |
| ---------------- | -------------------- |
| Promise\<void> | Promise used to return the result.|
**Example**
```js
......@@ -984,6 +1027,12 @@ Clears the aborted state of this common event. This API takes effect only for or
**System capability**: SystemCapability.Notification.CommonEvent
**Return value**
| Type | Description |
| ---------------- | -------------------- |
| Promise\<void> | Promise used to return the result.|
**Example**
```js
......@@ -1028,7 +1077,7 @@ subscriber.getAbortCommonEvent(getAbortCallback);
### getAbortCommonEvent
getAbortCommonEvent(): Promise\<void>
getAbortCommonEvent(): Promise\<boolean>
Checks whether this common event is in the aborted state. This API takes effect only for ordered common events. It uses a promise to return the result.
......@@ -1064,7 +1113,7 @@ Obtains the subscriber information. This API uses a callback to return the resul
| Name | Type | Mandatory| Description |
| -------- | ------------------------------------------------------------ | ---- | ---------------------- |
| callback | AsyncCallback\<[CommonEventSubscribeInfo](#commoneventsubscribeinfo)> | Yes | Callback used to return the subscriber information.|
| callback | AsyncCallback\<[CommonEventSubscribeInfo](#commoneventsubscribeinfo)> | Yes | Promise used to return the subscriber information.|
**Example**
......@@ -1107,3 +1156,93 @@ subscriber.getSubscribeInfo().then((SubscribeInfo) => {
console.error("getSubscribeInfo failed " + JSON.stringify(err));
});
```
### finishCommonEvent
finishCommonEvent(callback: AsyncCallback\<void\>): void
Ends the sorted common events. This API uses a 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.|
**Example**
```js
var subscriber; // Subscriber object successfully created.
function finishCommonEventCallback() {
console.log("--------- finishCommonEventCallback ----------");
}
subscriber.finishCommonEvent(finishCommonEventCallback);
```
### finishCommonEvent
finishCommonEvent(): Promise\<void\>
Ends the sorted common events. This API uses a promise to return the result.
**System capability**: SystemCapability.Notification.CommonEvent
**Return value**
| Type | Description |
| ---------------- | -------------------- |
| Promise\<void> | Promise used to return the result.|
**Example**
```js
var subscriber; // Subscriber object successfully created.
subscriber.finishCommonEvent()
.then(() => {
console.info("--------- finishCommonEventCallback ----------");
})
```
## CommonEventData
**System capability**: SystemCapability.Notification.CommonEvent
| Name | Readable/Writable| Type | Mandatory| Description |
| ---------- | -------- | -------------------- | ---- | ------------------------------------------------------- |
| event | Read only | string | Yes | Name of the common event that is being received. |
| bundleName | Read only | string | No | Bundle name. |
| code | Read only | number | No | Result code of the common event, which is used to transfer data of the int type. |
| data | Read only | string | No | Custom result data of the common event, which is used to transfer data of the string type.|
| parameters | Read only | {[key: string]: any} | No | Additional information about the common event. |
## CommonEventPublishData
**System capability**: SystemCapability.Notification.CommonEvent
| Name | Readable/Writable| Type | Mandatory| Description |
| --------------------- | -------- | -------------------- | ---- | ---------------------------- |
| bundleName | Read only | string | No | Bundle name. |
| code | Read only | number | No | Result code of the common event. |
| data | Read only | string | No | Custom result data of the common event.|
| subscriberPermissions | Read only | Array\<string> | No | Permissions required for subscribers to receive the common event. |
| isOrdered | Read only | boolean | No | Whether the common event is an ordered one. |
| isSticky | Read only | boolean | No | Whether the common event is a sticky one. |
| parameters | Read only | {[key: string]: any} | No | Additional information about the common event. |
## CommonEventSubscribeInfo
**System capability**: SystemCapability.Notification.CommonEvent
| Name | Readable/Writable| Type | Mandatory| Description |
| ------------------- | -------- | -------------- | ---- | ------------------------------------------------------------ |
| events | Read only | Array\<string> | Yes | Name of the common event to publish. |
| publisherPermission | Read only | string | No | Permissions required for publishers to publish the common event. |
| publisherDeviceId | Read only | string | No | Device ID. The value must be the ID of an existing device on the same network. |
| userId | Read only | number | No | User ID. The default value is the ID of the current user. If this parameter is specified, the value must be an existing user ID in the system.|
| priority | Read only | number | No | Subscriber priority. The value ranges from -100 to 1000. |
Markdown is supported
0% 或 .
You are about to add 0 people to the discussion. Proceed with caution.
先完成此消息的编辑！
想要评论请 注册 或