diff --git a/en/application-dev/reference/apis/js-apis-commonEvent.md b/en/application-dev/reference/apis/js-apis-commonEvent.md
index 50c4228a23727b230a2ffab82dcf077be5f6682b..81cb2e1cd87419d4f3ea03c12cd90be69f703685 100644
--- a/en/application-dev/reference/apis/js-apis-commonEvent.md
+++ b/en/application-dev/reference/apis/js-apis-commonEvent.md
@@ -1,161 +1,10 @@
# CommonEvent
-> **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.
+The **CommonEvent** module provides common event capabilities, including the capabilities to publish, subscribe to, and unsubscribe from common events, as well obtaining and setting the common event result code and result data.
-## Required Permissions
-
-| Common Event Macro | Common Event Name | Subscriber Permissions |
-| ------------ | ------------------ | ---------------------- |
-| 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_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 | - |
-| 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.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 | - |
-| 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 | ohos.permission.USE_BLUETOOTH |
-| 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 | 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 | - |
-| 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|
-| COMMON_EVENT_DISK_BAD_REMOVAL | usual.event.data.DISK_BAD_REMOVAL | ohos.permission.WRITE_USER_STORAGE or ohos.permission.READ_USER_STORAGE|
-| COMMON_EVENT_DISK_UNMOUNTABLE | usual.event.data.DISK_UNMOUNTABLE | ohos.permission.WRITE_USER_STORAGE or ohos.permission.READ_USER_STORAGE|
-| COMMON_EVENT_DISK_EJECT | usual.event.data.DISK_EJECT | ohos.permission.WRITE_USER_STORAGE or ohos.permission.READ_USER_STORAGE|
-| COMMON_EVENT_VOLUME_REMOVED | usual.event.data.VOLUME_REMOVED | ohos.permission.WRITE_USER_STORAGE or ohos.permission.READ_USER_STORAGE|
-| COMMON_EVENT_VOLUME_UNMOUNTED | usual.event.data.VOLUME_UNMOUNTED | ohos.permission.WRITE_USER_STORAGE or ohos.permission.READ_USER_STORAGE|
-| COMMON_EVENT_VOLUME_MOUNTED | usual.event.data.VOLUME_MOUNTED | ohos.permission.WRITE_USER_STORAGE or ohos.permission.READ_USER_STORAGE|
-| COMMON_EVENT_VOLUME_BAD_REMOVAL | usual.event.data.VOLUME_BAD_REMOVAL | ohos.permission.WRITE_USER_STORAGE or ohos.permission.READ_USER_STORAGE|
-| COMMON_EVENT_VOLUME_EJECT | usual.event.data.VOLUME_EJECT | ohos.permission.WRITE_USER_STORAGE or 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 | usual.event.data.FOUNDATION_READY | ohos.permission.RECEIVER_STARTUP_COMPLETED |
-| COMMON_EVENT_AIRPLANE_MODE_CHANGED | usual.event.AIRPLANE_MODE | - |
-| COMMON_EVENT_SPLIT_SCREEN | usual.event.SPLIT_SCREEN | ohos.permission.RECEIVER_SPLIT_SCREEN |
+> **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.
## Modules to Import
@@ -163,6 +12,168 @@
import CommonEvent from '@ohos.commonEvent';
```
+## Support
+
+Provides the event types supported by the **CommonEvent** module. The name and value indicate the macro and name of a common event, respectively.
+
+**System capability**: SystemCapability.Notification.CommonEvent
+
+| Name | Value | Subscriber Permissions | Description |
+| ------------ | ------------------ | ---------------------- | -------------------- |
+| COMMON_EVENT_BOOT_COMPLETED | usual.event.BOOT_COMPLETED | ohos.permission.RECEIVER_STARTUP_COMPLETED | Indicates the common event that the user has finished booting and the system has been loaded. |
+| COMMON_EVENT_LOCKED_BOOT_COMPLETED | usual.event.LOCKED_BOOT_COMPLETED | ohos.permission.RECEIVER_STARTUP_COMPLETED | Indicates the common event that the user has finished booting and the system has been loaded but the screen is still locked. |
+| COMMON_EVENT_SHUTDOWN | usual.event.SHUTDOWN | - | Indicates the common event that the device is being shut down and the final shutdown will proceed. |
+| COMMON_EVENT_BATTERY_CHANGED | usual.event.BATTERY_CHANGED | - | Indicates the common event that the charging state, level, and other information about the battery have changed. |
+| COMMON_EVENT_BATTERY_LOW | usual.event.BATTERY_LOW | - | Indicates the common event that the battery level is low. |
+| COMMON_EVENT_BATTERY_OKAY | usual.event.BATTERY_OKAY | - | Indicates the common event that the battery exits the low state. |
+| COMMON_EVENT_POWER_CONNECTED | usual.event.POWER_CONNECTED | - | Indicates the common event that the device is connected to an external power supply. |
+| COMMON_EVENT_POWER_DISCONNECTED | usual.event.POWER_DISCONNECTED | - | Indicates the common event that the device is disconnected from the external power supply. |
+| COMMON_EVENT_SCREEN_OFF | usual.event.SCREEN_OFF | - | Indicates the common event that the device screen is off and the device is sleeping. |
+| COMMON_EVENT_SCREEN_ON | usual.event.SCREEN_ON | - | Indicates the common event that the device screen is on and the device is in interactive state. |
+| COMMON_EVENT_THERMAL_LEVEL_CHANGED8+ | usual.event.THERMAL_LEVEL_CHANGED | - | Indicates the common event that the device's thermal level has changed. |
+| COMMON_EVENT_USER_PRESENT | usual.event.USER_PRESENT | - | Indicates the common event that the user unlocks the device. |
+| COMMON_EVENT_TIME_TICK | usual.event.TIME_TICK | - | Indicates the common event that the system time has changed. |
+| COMMON_EVENT_TIME_CHANGED | usual.event.TIME_CHANGED | - | Indicates the common event that the system time is set. |
+| COMMON_EVENT_DATE_CHANGED | usual.event.DATE_CHANGED | - | Indicates the common event that the system time has changed. |
+| COMMON_EVENT_TIMEZONE_CHANGED | usual.event.TIMEZONE_CHANGED | - | Indicates the common event that the system time zone has changed. |
+| COMMON_EVENT_CLOSE_SYSTEM_DIALOGS | usual.event.CLOSE_SYSTEM_DIALOGS | - | Indicates the common event that a user closes a temporary system dialog box. |
+| COMMON_EVENT_PACKAGE_ADDED | usual.event.PACKAGE_ADDED | - | Indicates the common event that a new application package has been installed on the device. |
+| COMMON_EVENT_PACKAGE_REPLACED | usual.event.PACKAGE_REPLACED | - | Indicates the common event that a later version of an installed application package has replaced the previous one on the device. |
+| COMMON_EVENT_MY_PACKAGE_REPLACED | usual.event.MY_PACKAGE_REPLACED | - | Indicates the common event that a later version of your application package has replaced the previous one. |
+| COMMON_EVENT_PACKAGE_REMOVED | usual.event.PACKAGE_REMOVED | - | Indicates the common event that an installed application has been uninstalled from the device with the application data retained. |
+| COMMON_EVENT_BUNDLE_REMOVED | usual.event.BUNDLE_REMOVED | - | Indicates the common event that an installed bundle has been uninstalled from the device with the application data retained. |
+| COMMON_EVENT_PACKAGE_FULLY_REMOVED | usual.event.PACKAGE_FULLY_REMOVED | - | Indicates the common event that an installed application, including both the application data and code, has been completely uninstalled from the device. |
+| COMMON_EVENT_PACKAGE_CHANGED | usual.event.PACKAGE_CHANGED | - | Indicates the common event that an application package has been changed (for example, a component in the package has been enabled or disabled). |
+| COMMON_EVENT_PACKAGE_RESTARTED | usual.event.PACKAGE_RESTARTED | - | Indicates the common event that the user has restarted the application package and killed all its processes. |
+| COMMON_EVENT_PACKAGE_DATA_CLEARED | usual.event.PACKAGE_DATA_CLEARED | - | Indicates the common event that the user has cleared the application package data. |
+| COMMON_EVENT_PACKAGE_CACHE_CLEARED9+ | usual.event.PACKAGE_CACHE_CLEARED | - | Indicates the common event that the user clears the application package cache. |
+| COMMON_EVENT_PACKAGES_SUSPENDED | usual.event.PACKAGES_SUSPENDED | - | Indicates the common event that application packages have been suspended. |
+| COMMON_EVENT_PACKAGES_UNSUSPENDED | usual.event.PACKAGES_UNSUSPENDED | - | Indicates the common event that application packages have not been suspended. |
+| COMMON_EVENT_MY_PACKAGE_SUSPENDED | usual.event.MY_PACKAGE_SUSPENDED | - | Indicates the common event that an application package has been suspended. |
+| COMMON_EVENT_MY_PACKAGE_UNSUSPENDED | usual.event.MY_PACKAGE_UNSUSPENDED | - | Indicates the common event that application package has not been suspended. |
+| COMMON_EVENT_UID_REMOVED | usual.event.UID_REMOVED | - | Indicates the common event that a user ID has been removed from the system. |
+| COMMON_EVENT_PACKAGE_FIRST_LAUNCH | usual.event.PACKAGE_FIRST_LAUNCH | - | Indicates the common event that an installed application is started for the first time. |
+| COMMON_EVENT_PACKAGE_NEEDS_VERIFICATION | usual.event.PACKAGE_NEEDS_VERIFICATION | - | Indicates the common event that an application requires system verification. |
+| COMMON_EVENT_PACKAGE_VERIFIED | usual.event.PACKAGE_VERIFIED | - | Indicates the common event that an application has been verified by the system. |
+| COMMON_EVENT_EXTERNAL_APPLICATIONS_AVAILABLE | usual.event.EXTERNAL_APPLICATIONS_AVAILABLE | - | Indicates the common event that applications installed on the external storage become available for the system. |
+| COMMON_EVENT_EXTERNAL_APPLICATIONS_UNAVAILABLE | usual.event.EXTERNAL_APPLICATIONS_UNAVAILABLE | - | Indicates the common event that applications installed on the external storage become unavailable for the system. |
+| COMMON_EVENT_CONFIGURATION_CHANGED | usual.event.CONFIGURATION_CHANGED | - | Indicates the common event that the device state (for example, orientation and locale) has changed. |
+| COMMON_EVENT_LOCALE_CHANGED | usual.event.LOCALE_CHANGED | - | Indicates the common event that the device locale has changed. |
+| COMMON_EVENT_MANAGE_PACKAGE_STORAGE | usual.event.MANAGE_PACKAGE_STORAGE | - | Indicates the common event that the device storage is insufficient. |
+| COMMON_EVENT_DRIVE_MODE | common.event.DRIVE_MODE | - | Indicates the common event that the system is in driving mode. |
+| COMMON_EVENT_HOME_MODE | common.event.HOME_MODE | - | Indicates the common event that the system is in home mode. |
+| COMMON_EVENT_OFFICE_MODE | common.event.OFFICE_MODE | - | Indicates the common event that the system is in office mode. |
+| COMMON_EVENT_USER_STARTED | usual.event.USER_STARTED | - | Indicates the common event that the user has been started. |
+| COMMON_EVENT_USER_BACKGROUND | usual.event.USER_BACKGROUND | - | Indicates the common event that the user has been brought to the background. |
+| COMMON_EVENT_USER_FOREGROUND | usual.event.USER_FOREGROUND | - | Indicates the common event that the user has been brought to the foreground. |
+| COMMON_EVENT_USER_SWITCHED | usual.event.USER_SWITCHED | ohos.permission.MANAGE_USERS | Indicates the common event that user switching is happening. |
+| COMMON_EVENT_USER_STARTING | usual.event.USER_STARTING | ohos.permission.INTERACT_ACROSS_USERS | Indicates the common event that the user is going to be started. |
+| COMMON_EVENT_USER_UNLOCKED | usual.event.USER_UNLOCKED | - | Indicates the common event that the credential-encrypted storage has been unlocked for the current user when the device is unlocked after being restarted. |
+| COMMON_EVENT_USER_STOPPING | usual.event.USER_STOPPING | ohos.permission.INTERACT_ACROSS_USERS | Indicates the common event that the user is going to be stopped. |
+| COMMON_EVENT_USER_STOPPED | usual.event.USER_STOPPED | - | Indicates the common event that the user has been stopped. |
+| COMMON_EVENT_HWID_LOGIN | common.event.HWID_LOGIN | - | Indicates the common event about a HUAWEI ID login. |
+| COMMON_EVENT_HWID_LOGOUT | common.event.HWID_LOGOUT | - | Indicates the common event about a HUAWEI ID logout. |
+| COMMON_EVENT_HWID_TOKEN_INVALID | common.event.HWID_TOKEN_INVALID | - | Indicates the common event that the HUAWEI ID is invalid. |
+| COMMON_EVENT_HWID_LOGOFF | common.event.HWID_LOGOFF | - | Indicates the common event about a HUAWEI ID logoff. |
+| COMMON_EVENT_WIFI_POWER_STATE | usual.event.wifi.POWER_STATE | - | Indicates the common event about the Wi-Fi network state, such as enabled and disabled. |
+| COMMON_EVENT_WIFI_SCAN_FINISHED | usual.event.wifi.SCAN_FINISHED | ohos.permission.LOCATION | Indicates the common event that the Wi-Fi access point has been scanned and proven to be available. |
+| COMMON_EVENT_WIFI_RSSI_VALUE | usual.event.wifi.RSSI_VALUE | ohos.permission.GET_WIFI_INFO | Indicates the common event that the Wi-Fi signal strength (RSSI) has changed. |
+| COMMON_EVENT_WIFI_CONN_STATE | usual.event.wifi.CONN_STATE | - | Indicates the common event that the Wi-Fi connection state has changed. |
+| COMMON_EVENT_WIFI_HOTSPOT_STATE | usual.event.wifi.HOTSPOT_STATE | - | Indicates the common event about the Wi-Fi hotspot state, such as enabled or disabled. |
+| COMMON_EVENT_WIFI_AP_STA_JOIN | usual.event.wifi.WIFI_HS_STA_JOIN | ohos.permission.GET_WIFI_INFO | Indicates the common event that a client has joined the Wi-Fi hotspot of the current device. |
+| COMMON_EVENT_WIFI_AP_STA_LEAVE | usual.event.wifi.WIFI_HS_STA_LEAVE | ohos.permission.GET_WIFI_INFO |Indicates the common event that a client has disconnected from the Wi-Fi hotspot of the current device. |
+| COMMON_EVENT_WIFI_MPLINK_STATE_CHANGE | usual.event.wifi.mplink.STATE_CHANGE | ohos.permission.MPLINK_CHANGE_STATE | Indicates the common event that the state of MPLINK (an enhanced Wi-Fi feature) has changed. |
+| COMMON_EVENT_WIFI_P2P_CONN_STATE | usual.event.wifi.p2p.CONN_STATE_CHANGE | ohos.permission.GET_WIFI_INFO and ohos.permission.LOCATION | Indicates the common event that the Wi-Fi P2P connection state has changed. |
+| COMMON_EVENT_WIFI_P2P_STATE_CHANGED | usual.event.wifi.p2p.STATE_CHANGE | ohos.permission.GET_WIFI_INFO | Indicates the common event about the Wi-Fi P2P state, such as enabled and disabled. |
+| COMMON_EVENT_WIFI_P2P_PEERS_STATE_CHANGED | usual.event.wifi.p2p.DEVICES_CHANGE | ohos.permission.GET_WIFI_INFO | Indicates the common event about the status change of Wi-Fi P2P peer devices. |
+| COMMON_EVENT_WIFI_P2P_PEERS_DISCOVERY_STATE_CHANGED | usual.event.wifi.p2p.PEER_DISCOVERY_STATE_CHANGE | ohos.permission.GET_WIFI_INFO | Indicates the common event about the Wi-Fi P2P discovery status change. |
+| COMMON_EVENT_WIFI_P2P_CURRENT_DEVICE_STATE_CHANGED | usual.event.wifi.p2p.CURRENT_DEVICE_CHANGE | ohos.permission.GET_WIFI_INFO | Indicates the common event about the status change of the Wi-Fi P2P local device. |
+| COMMON_EVENT_WIFI_P2P_GROUP_STATE_CHANGED | usual.event.wifi.p2p.GROUP_STATE_CHANGED | ohos.permission.GET_WIFI_INFO | Indicates the common event that the Wi-Fi P2P group information has changed. |
+| COMMON_EVENT_BLUETOOTH_HANDSFREE_AG_CONNECT_STATE_UPDATE | usual.event.bluetooth.handsfree.ag.CONNECT_STATE_UPDATE | ohos.permission.USE_BLUETOOTH | Indicates the common event about the connection state of Bluetooth handsfree communication. |
+| COMMON_EVENT_BLUETOOTH_HANDSFREE_AG_CURRENT_DEVICE_UPDATE | usual.event.bluetooth.handsfree.ag.CURRENT_DEVICE_UPDATE | ohos.permission.USE_BLUETOOTH | Indicates the common event that the device connected to the Bluetooth handsfree is active. |
+| COMMON_EVENT_BLUETOOTH_HANDSFREE_AG_AUDIO_STATE_UPDATE | usual.event.bluetooth.handsfree.ag.AUDIO_STATE_UPDATE | ohos.permission.USE_BLUETOOTH | Indicates the common event that the connection state of Bluetooth A2DP has changed. |
+| COMMON_EVENT_BLUETOOTH_A2DPSOURCE_CONNECT_STATE_UPDATE | usual.event.bluetooth.a2dpsource.CONNECT_STATE_UPDATE | ohos.permission.USE_BLUETOOTH | Indicates the common event about the connection state of Bluetooth A2DP. |
+| COMMON_EVENT_BLUETOOTH_A2DPSOURCE_CURRENT_DEVICE_UPDATE | usual.event.bluetooth.a2dpsource.CURRENT_DEVICE_UPDATE | ohos.permission.USE_BLUETOOTH | Indicates the common event that the device connected using Bluetooth A2DP is active. |
+| COMMON_EVENT_BLUETOOTH_A2DPSOURCE_PLAYING_STATE_UPDATE | usual.event.bluetooth.a2dpsource.PLAYING_STATE_UPDATE | ohos.permission.USE_BLUETOOTH | Indicates the common event that the playing state of Bluetooth A2DP has changed. |
+| COMMON_EVENT_BLUETOOTH_A2DPSOURCE_AVRCP_CONNECT_STATE_UPDATE | usual.event.bluetooth.a2dpsource.AVRCP_CONNECT_STATE_UPDATE | ohos.permission.USE_BLUETOOTH | Indicates the common event that the AVRCP connection state of Bluetooth A2DP has changed. |
+| COMMON_EVENT_BLUETOOTH_A2DPSOURCE_CODEC_VALUE_UPDATE | usual.event.bluetooth.a2dpsource.CODEC_VALUE_UPDATE | ohos.permission.USE_BLUETOOTH | Indicates the common event that the audio codec state of Bluetooth A2DP has changed. |
+| COMMON_EVENT_BLUETOOTH_REMOTEDEVICE_DISCOVERED | usual.event.bluetooth.remotedevice.DISCOVERED | ohos.permission.LOCATION and ohos.permission.USE_BLUETOOTH | Indicates the common event that a remote Bluetooth device is discovered. |
+| COMMON_EVENT_BLUETOOTH_REMOTEDEVICE_CLASS_VALUE_UPDATE | usual.event.bluetooth.remotedevice.CLASS_VALUE_UPDATE | ohos.permission.USE_BLUETOOTH | Indicates the common event that the Bluetooth class of a remote Bluetooth device has changed. |
+| COMMON_EVENT_BLUETOOTH_REMOTEDEVICE_ACL_CONNECTED | usual.event.bluetooth.remotedevice.ACL_CONNECTED | ohos.permission.USE_BLUETOOTH | Indicates the common event that a low-ACL connection has been established with a remote Bluetooth device. |
+| COMMON_EVENT_BLUETOOTH_REMOTEDEVICE_ACL_DISCONNECTED | usual.event.bluetooth.remotedevice.ACL_DISCONNECTED | ohos.permission.USE_BLUETOOTH | Indicates the common event that a low-ACL connection has been disconnected from a remote Bluetooth device. |
+| COMMON_EVENT_BLUETOOTH_REMOTEDEVICE_NAME_UPDATE | usual.event.bluetooth.remotedevice.NAME_UPDATE | ohos.permission.USE_BLUETOOTH | Indicates the common event that the friendly name of a remote Bluetooth device is retrieved for the first time or is changed since the last retrieval. |
+| COMMON_EVENT_BLUETOOTH_REMOTEDEVICE_PAIR_STATE | usual.event.bluetooth.remotedevice.PAIR_STATE | ohos.permission.USE_BLUETOOTH | Indicates the common event that the connection state of a remote Bluetooth device has changed. |
+| COMMON_EVENT_BLUETOOTH_REMOTEDEVICE_BATTERY_VALUE_UPDATE | usual.event.bluetooth.remotedevice.BATTERY_VALUE_UPDATE | ohos.permission.USE_BLUETOOTH | Indicates the common event that the battery level of a remote Bluetooth device is retrieved for the first time or is changed since the last retrieval. |
+| COMMON_EVENT_BLUETOOTH_REMOTEDEVICE_SDP_RESULT | usual.event.bluetooth.remotedevice.SDP_RESULT | - | Indicates the common event about the SDP state of a remote Bluetooth device. |
+| COMMON_EVENT_BLUETOOTH_REMOTEDEVICE_UUID_VALUE | usual.event.bluetooth.remotedevice.UUID_VALUE | ohos.permission.DISCOVER_BLUETOOTH | Indicates the common event about the UUID connection state of a remote Bluetooth device. |
+| COMMON_EVENT_BLUETOOTH_REMOTEDEVICE_PAIRING_REQ | usual.event.bluetooth.remotedevice.PAIRING_REQ | ohos.permission.DISCOVER_BLUETOOTH | Indicates the common event about the pairing request from a remote Bluetooth device. |
+| COMMON_EVENT_BLUETOOTH_REMOTEDEVICE_PAIRING_CANCEL | usual.event.bluetooth.remotedevice.PAIRING_CANCEL | - | Indicates the common event that Bluetooth pairing is canceled. |
+| COMMON_EVENT_BLUETOOTH_REMOTEDEVICE_CONNECT_REQ | usual.event.bluetooth.remotedevice.CONNECT_REQ | - | Indicates the common event about the connection request from a remote Bluetooth device. |
+| COMMON_EVENT_BLUETOOTH_REMOTEDEVICE_CONNECT_REPLY | usual.event.bluetooth.remotedevice.CONNECT_REPLY | - | Indicates the common event about the response to the connection request from a remote Bluetooth device. |
+| COMMON_EVENT_BLUETOOTH_REMOTEDEVICE_CONNECT_CANCEL | usual.event.bluetooth.remotedevice.CONNECT_CANCEL | - | Indicates the common event that the connection to a remote Bluetooth device has been canceled. |
+| COMMON_EVENT_BLUETOOTH_HANDSFREEUNIT_CONNECT_STATE_UPDATE | usual.event.bluetooth.handsfreeunit.CONNECT_STATE_UPDATE | - | Indicates the common event that the connection state of a Bluetooth handsfree has changed. |
+| COMMON_EVENT_BLUETOOTH_HANDSFREEUNIT_AUDIO_STATE_UPDATE | usual.event.bluetooth.handsfreeunit.AUDIO_STATE_UPDATE | - | Indicates the common event that the audio state of a Bluetooth handsfree has changed. |
+| COMMON_EVENT_BLUETOOTH_HANDSFREEUNIT_AG_COMMON_EVENT | usual.event.bluetooth.handsfreeunit.AG_COMMON_EVENT | - | Indicates the common event that the audio gateway state of a Bluetooth handsfree has changed. |
+| COMMON_EVENT_BLUETOOTH_HANDSFREEUNIT_AG_CALL_STATE_UPDATE | usual.event.bluetooth.handsfreeunit.AG_CALL_STATE_UPDATE | - | Indicates the common event that the calling state of a Bluetooth handsfree has changed. |
+| COMMON_EVENT_BLUETOOTH_HOST_STATE_UPDATE | usual.event.bluetooth.host.STATE_UPDATE | ohos.permission.USE_BLUETOOTH | Indicates the common event that the state of a Bluetooth adapter has been changed, for example, Bluetooth has been enabled or disabled. |
+| COMMON_EVENT_BLUETOOTH_HOST_REQ_DISCOVERABLE | usual.event.bluetooth.host.REQ_DISCOVERABLE | - | Indicates the common event about the request for the user to allow Bluetooth device scanning. |
+| COMMON_EVENT_BLUETOOTH_HOST_REQ_ENABLE | usual.event.bluetooth.host.REQ_ENABLE | ohos.permission.USE_BLUETOOTH | Indicates the common event about the request for the user to enable Bluetooth. |
+| COMMON_EVENT_BLUETOOTH_HOST_REQ_DISABLE | usual.event.bluetooth.host.REQ_DISABLE | ohos.permission.USE_BLUETOOTH | Indicates the common event about the request for the user to disable Bluetooth. |
+| COMMON_EVENT_BLUETOOTH_HOST_SCAN_MODE_UPDATE | usual.event.bluetooth.host.SCAN_MODE_UPDATE | ohos.permission.USE_BLUETOOTH | Indicates the common event that the Bluetooth scanning mode of a device has changed. |
+| COMMON_EVENT_BLUETOOTH_HOST_DISCOVERY_STARTED | usual.event.bluetooth.host.DISCOVERY_STARTED | ohos.permission.USE_BLUETOOTH | Indicates the common event that the Bluetooth scanning has been started on the device. |
+| COMMON_EVENT_BLUETOOTH_HOST_DISCOVERY_FINISHED | usual.event.bluetooth.host.DISCOVERY_FINISHED | ohos.permission.USE_BLUETOOTH | Indicates the common event that the Bluetooth scanning is finished on the device. |
+| COMMON_EVENT_BLUETOOTH_HOST_NAME_UPDATE | usual.event.bluetooth.host.NAME_UPDATE | ohos.permission.USE_BLUETOOTH | Indicates the common event that the Bluetooth adapter name of the device has changed. |
+| COMMON_EVENT_BLUETOOTH_A2DPSINK_CONNECT_STATE_UPDATE | usual.event.bluetooth.a2dpsink.CONNECT_STATE_UPDATE | ohos.permission.USE_BLUETOOTH | Indicates the common event that the connection state of Bluetooth A2DP Sink has changed. |
+| COMMON_EVENT_BLUETOOTH_A2DPSINK_PLAYING_STATE_UPDATE | usual.event.bluetooth.a2dpsink.PLAYING_STATE_UPDATE | ohos.permission.USE_BLUETOOTH | Indicates the common event that the playing state of Bluetooth A2DP Sink has changed. |
+| COMMON_EVENT_BLUETOOTH_A2DPSINK_AUDIO_STATE_UPDATE | usual.event.bluetooth.a2dpsink.AUDIO_STATE_UPDATE | ohos.permission.USE_BLUETOOTH | Indicates the common event that the audio state of Bluetooth A2DP Sink has changed. |
+| COMMON_EVENT_NFC_ACTION_ADAPTER_STATE_CHANGED | usual.event.nfc.action.ADAPTER_STATE_CHANGED | - | Indicates the common event that the state of the device's NFC adapter has changed. |
+| COMMON_EVENT_NFC_ACTION_RF_FIELD_ON_DETECTED | usual.event.nfc.action.RF_FIELD_ON_DETECTED | ohos.permission.MANAGE_SECURE_SETTINGS | Indicates the common event that the NFC RF field is detected to be in the enabled state. |
+| COMMON_EVENT_NFC_ACTION_RF_FIELD_OFF_DETECTED | usual.event.nfc.action.RF_FIELD_OFF_DETECTED | ohos.permission.MANAGE_SECURE_SETTINGS | Indicates the common event that the NFC RF field is detected to be in the disabled state. |
+| COMMON_EVENT_DISCHARGING | usual.event.DISCHARGING | - | Indicates the common event that the system stops charging the battery. |
+| COMMON_EVENT_CHARGING | usual.event.CHARGING | - | Indicates the common event that the system starts charging the battery. |
+| COMMON_EVENT_DEVICE_IDLE_MODE_CHANGED | usual.event.DEVICE_IDLE_MODE_CHANGED | - | Indicates the common event that the system idle mode has changed. |
+| COMMON_EVENT_POWER_SAVE_MODE_CHANGED | usual.event.POWER_SAVE_MODE_CHANGED | - | Indicates the common event that the power saving mode of the system has changed. |
+| COMMON_EVENT_USER_ADDED | usual.event.USER_ADDED | ohos.permission.MANAGE_USERS | Indicates the common event that a user has been added to the system. |
+| COMMON_EVENT_USER_REMOVED | usual.event.USER_REMOVED | ohos.permission.MANAGE_USERS | Indicates the common event that a user has been removed from the system. |
+| COMMON_EVENT_ABILITY_ADDED | usual.event.ABILITY_ADDED | ohos.permission.LISTEN_BUNDLE_CHANGE | Indicates the common event that an ability has been added. |
+| COMMON_EVENT_ABILITY_REMOVED | usual.event.ABILITY_REMOVED | ohos.permission.LISTEN_BUNDLE_CHANGE | Indicates the common event that an ability has been removed. |
+| COMMON_EVENT_ABILITY_UPDATED | usual.event.ABILITY_UPDATED | ohos.permission.LISTEN_BUNDLE_CHANGE | Indicates the common event that an ability has been updated. |
+| COMMON_EVENT_LOCATION_MODE_STATE_CHANGED | usual.event.location.MODE_STATE_CHANGED | - | Indicates the common event that the location mode of the system has changed. |
+| COMMON_EVENT_IVI_SLEEP | common.event.IVI_SLEEP | - | Indicates the common event that the in-vehicle infotainment (IVI) system of a vehicle is sleeping. |
+| COMMON_EVENT_IVI_PAUSE | common.event.IVI_PAUSE | - | Indicates the common event that the IVI system of a vehicle has entered sleep mode and the playing application is instructed to stop playback. |
+| COMMON_EVENT_IVI_STANDBY | common.event.IVI_STANDBY | - | Indicates the common event that a third-party application is instructed to pause the current work. |
+| COMMON_EVENT_IVI_LASTMODE_SAVE | common.event.IVI_LASTMODE_SAVE | - | Indicates the common event that a third-party application is instructed to save its last mode. |
+| COMMON_EVENT_IVI_VOLTAGE_ABNORMAL | common.event.IVI_VOLTAGE_ABNORMAL | - | Indicates the common event that the voltage of the vehicle's power system is abnormal. |
+| COMMON_EVENT_IVI_HIGH_TEMPERATURE | common.event.IVI_HIGH_TEMPERATURE | - | Indicates the common event that the temperature of the IVI system is high. |
+| COMMON_EVENT_IVI_EXTREME_TEMPERATURE | common.event.IVI_EXTREME_TEMPERATURE | - | Indicates the common event that the temperature of the IVI system is extremely high. |
+| COMMON_EVENT_IVI_TEMPERATURE_ABNORMAL | common.event.IVI_TEMPERATURE_ABNORMAL | - | Indicates the common event that the IVI system has an extreme temperature. |
+| COMMON_EVENT_IVI_VOLTAGE_RECOVERY | common.event.IVI_VOLTAGE_RECOVERY | - | Indicates the common event that the voltage of the vehicle's power system is restored to normal. |
+| COMMON_EVENT_IVI_TEMPERATURE_RECOVERY | common.event.IVI_TEMPERATURE_RECOVERY | - | Indicates the common event that the temperature of the IVI system is restored to normal. |
+| COMMON_EVENT_IVI_ACTIVE | common.event.IVI_ACTIVE | - | Indicates the common event that the battery service is active. |
+| COMMON_EVENT_USB_DEVICE_ATTACHED | usual.event.hardware.usb.action.USB_DEVICE_ATTACHED | - | Indicates the common event that a USB device has been attached when the user device functions as a USB host. |
+| COMMON_EVENT_USB_DEVICE_DETACHED | usual.event.hardware.usb.action.USB_DEVICE_DETACHED | - | Indicates the common event that a USB device has been detached when the user device functions as a USB host. |
+| COMMON_EVENT_USB_ACCESSORY_ATTACHED | usual.event.hardware.usb.action.USB_ACCESSORY_ATTACHED | - | Indicates the common event that a USB accessory was attached. |
+| COMMON_EVENT_USB_ACCESSORY_DETACHED | usual.event.hardware.usb.action.USB_ACCESSORY_DETACHED | - | Indicates the common event that a USB accessory was detached. |
+| COMMON_EVENT_DISK_REMOVED | usual.event.data.DISK_REMOVED | ohos.permission.WRITE_USER_STORAGE or ohos.permission.READ_USER_STORAGE| Indicates the common event that an external storage device was removed. |
+| COMMON_EVENT_DISK_UNMOUNTED | usual.event.data.DISK_UNMOUNTED | ohos.permission.WRITE_USER_STORAGE or ohos.permission.READ_USER_STORAGE| Indicates the common event that an external storage device was unmounted. |
+| COMMON_EVENT_DISK_MOUNTED | usual.event.data.DISK_MOUNTED | ohos.permission.WRITE_USER_STORAGE or ohos.permission.READ_USER_STORAGE| Indicates the common event that an external storage device was mounted. |
+| COMMON_EVENT_DISK_BAD_REMOVAL | usual.event.data.DISK_BAD_REMOVAL | ohos.permission.WRITE_USER_STORAGE or ohos.permission.READ_USER_STORAGE| Indicates the common event that an external storage device was removed without being unmounted. |
+| COMMON_EVENT_DISK_UNMOUNTABLE | usual.event.data.DISK_UNMOUNTABLE | ohos.permission.WRITE_USER_STORAGE or ohos.permission.READ_USER_STORAGE| Indicates the common event that an external storage device becomes unmountable. |
+| COMMON_EVENT_DISK_EJECT | usual.event.data.DISK_EJECT | ohos.permission.WRITE_USER_STORAGE or ohos.permission.READ_USER_STORAGE| Indicates the common event that an external storage device was ejected. |
+| COMMON_EVENT_VOLUME_REMOVED9+ | usual.event.data.VOLUME_REMOVED | ohos.permission.WRITE_USER_STORAGE or ohos.permission.READ_USER_STORAGE| Indicates the common event that an external storage device was removed. |
+| COMMON_EVENT_VOLUME_UNMOUNTED9+ | usual.event.data.VOLUME_UNMOUNTED | ohos.permission.WRITE_USER_STORAGE or ohos.permission.READ_USER_STORAGE| Indicates the common event that an external storage device was unmounted. |
+| COMMON_EVENT_VOLUME_MOUNTED9+ | usual.event.data.VOLUME_MOUNTED | ohos.permission.WRITE_USER_STORAGE or ohos.permission.READ_USER_STORAGE| Indicates the common event that an external storage device was mounted. |
+| COMMON_EVENT_VOLUME_BAD_REMOVAL9+ | usual.event.data.VOLUME_BAD_REMOVAL | ohos.permission.WRITE_USER_STORAGE or ohos.permission.READ_USER_STORAGE| Indicates the common event that an external storage device was removed without being unmounted. |
+| COMMON_EVENT_VOLUME_EJECT9+ | usual.event.data.VOLUME_EJECT | ohos.permission.WRITE_USER_STORAGE or ohos.permission.READ_USER_STORAGE| Indicates the common event that an external storage device was ejected. |
+| COMMON_EVENT_VISIBLE_ACCOUNTS_UPDATED | usual.event.data.VISIBLE_ACCOUNTS_UPDATED | ohos.permission.GET_APP_ACCOUNTS | Indicates the common event that the account visibility changed. |
+| COMMON_EVENT_ACCOUNT_DELETED | usual.event.data.ACCOUNT_DELETED | ohos.permission.INTERACT_ACROSS_LOCAL_ACCOUNTS | Indicates the common event that the account was deleted. |
+| COMMON_EVENT_FOUNDATION_READY | usual.event.data.FOUNDATION_READY | ohos.permission.RECEIVER_STARTUP_COMPLETED | Indicates the common event that the foundation is ready. |
+| COMMON_EVENT_AIRPLANE_MODE_CHANGED | usual.event.AIRPLANE_MODE | - | Indicates the common event that the airplane mode of the device has changed. |
+| COMMON_EVENT_SPLIT_SCREEN8+ | usual.event.SPLIT_SCREEN | ohos.permission.RECEIVER_SPLIT_SCREEN | Indicates the common event of screen splitting. |
+| COMMON_EVENT_SLOT_CHANGE9+ | usual.event.SLOT_CHANGE | ohos.permission.NOTIFICATION_CONTROLLER | Indicates the common event that the notification slot has changed. |
+| COMMON_EVENT_SPN_INFO_CHANGED9+ | usual.event.SPN_INFO_CHANGED | - | Indicates the common event that the SPN displayed has been updated. |
+
+
## CommonEvent.publish
publish(event: string, callback: AsyncCallback\): void
@@ -181,7 +192,7 @@ Publishes a common event. This API uses a callback to return the result.
**Example**
```js
-// Callback for common event publication.
+// Callback for common event publication
function PublishCallBack(err) {
if (err.code) {
console.error("publish failed " + JSON.stringify(err));
@@ -218,8 +229,8 @@ Publishes a common event with given attributes. This API uses a callback to retu
```js
// Attributes of a common event.
var options = {
- code: 0, // Result code of the common event
- data: "initial data",// Result data of the common event
+ code: 0, // Result code of the common event.
+ data: "initial data";// Result data of the common event.
isOrdered: true // The common event is an ordered one.
}
@@ -246,6 +257,8 @@ Publishes a common event to a specific user. This API uses a callback to return
**System capability**: SystemCapability.Notification.CommonEvent
+**System API**: This is a system API and cannot be called by third-party applications.
+
**Parameters**
| Name | Readable/Writable| Type | Mandatory| Description |
@@ -257,7 +270,7 @@ Publishes a common event to a specific user. This API uses a callback to return
**Example**
```js
-// Callback for common event publication.
+// Callback for common event publication
function PublishAsUserCallBack(err) {
if (err.code) {
console.error("publishAsUser failed " + JSON.stringify(err));
@@ -283,6 +296,8 @@ Publishes a common event with given attributes to a specific user. This API uses
**System capability**: SystemCapability.Notification.CommonEvent
+**System API**: This is a system API and cannot be called by third-party applications.
+
**Parameters**
| Name | Readable/Writable| Type | Mandatory| Description |
@@ -298,8 +313,8 @@ Publishes a common event with given attributes to a specific user. This API uses
```js
// Attributes of a common event.
var options = {
- code: 0, // Result code of the common event
- data: "initial data",// Result data of the common event
+ code: 0, // Result code of the common event.
+ data: "initial data";// Result data of the common event
}
// Callback for common event publication
@@ -560,7 +575,7 @@ Obtains the result code of this common event. This API uses a promise to return
| Type | Description |
| ---------------- | -------------------- |
-| Promise\ | Promise used to return the result code.|
+| Promise\ | Promise used to return the result.|
**Example**
@@ -623,7 +638,7 @@ Sets the result code for this common event. This API uses a promise to return th
| Type | Description |
| ---------------- | -------------------- |
-| Promise\ | Promise used to return the result code.|
+| Promise\ | Promise used to return the result.|
**Example**
@@ -742,7 +757,7 @@ Sets the result data for this common event. This API uses a promise to return th
| Type | Description |
| ---------------- | -------------------- |
-| Promise\ | Promise used to return the result data.|
+| Promise\ | Promise used to return the result.|
**Example**
diff --git a/en/application-dev/reference/apis/js-apis-emitter.md b/en/application-dev/reference/apis/js-apis-emitter.md
index fa54f6739279745a1f7538fd32abf0fca6402711..6398b87f685e5f91c59dacb1da97b4ad993e5afa 100644
--- a/en/application-dev/reference/apis/js-apis-emitter.md
+++ b/en/application-dev/reference/apis/js-apis-emitter.md
@@ -1,6 +1,9 @@
# Emitter
-> **NOTE**
+The **Emitter** module provides APIs for sending and processing in-process events, including the APIs for processing events that are subscribed to in persistent or one-shot manner, unsubscribing from events, and emitting events to the event queue.
+
+> **NOTE**
+>
> The initial APIs of this module are supported since API version 7.
## Modules to Import
@@ -17,12 +20,14 @@ None
Enumerates the event emit priority levels.
- | Name | Value | Description |
- | --------- | ---- | ------------------------------------------------- |
- | IMMEDIATE | 0 | The event will be emitted immediately. **System capability**: SystemCapability.Notification.Emitter |
- | HIGH | 1 | The event will be emitted before low-priority events. **System capability**: SystemCapability.Notification.Emitter |
- | LOW | 2 | The event will be emitted before idle-priority events. By default, an event is in LOW priority. **System capability**: SystemCapability.Notification.Emitter |
- | IDLE | 3 | The event will be emitted after all the other events. **System capability**: SystemCapability.Notification.Emitter |
+**System capability**: SystemCapability.Notification.Emitter
+
+| Name | Value | Description |
+| --------- | ---- | ------------------------------------------------- |
+| IMMEDIATE | 0 | The event will be emitted immediately. |
+| HIGH | 1 | The event will be emitted before low-priority events. |
+| LOW | 2 | The event will be emitted before idle-priority events. By default, an event is in LOW priority. |
+| IDLE | 3 | The event will be emitted after all the other events. |
## emitter.on
@@ -34,10 +39,10 @@ Subscribes to an event in persistent manner. This API uses a callback to return
**Parameters**
- | Name | Type | Mandatory | Description |
- | -------- | ----------------------------------- | ---- | ------------------------ |
- | event | [InnerEvent](#innerevent) | Yes | Event to subscribe to in persistent manner. |
- | callback | Callback\<[EventData](#eventdata)\> | Yes | Callback used to return the event. |
+| Name | Type | Mandatory| Description |
+| -------- | ----------------------------------- | ---- | ------------------------ |
+| event | [InnerEvent](#innerevent) | Yes | Event to subscribe to in persistent manner. |
+| callback | Callback\<[EventData](#eventdata)\> | Yes | Callback used to return the event.|
**Example**
@@ -61,10 +66,10 @@ Subscribes to an event in one-shot manner and unsubscribes from it after the eve
**Parameters**
- | Name | Type | Mandatory | Description |
- | -------- | ----------------------------------- | ---- | ------------------------ |
- | event | [InnerEvent](#innerevent) | Yes | Event to subscribe to in one-shot manner. |
- | callback | Callback\<[EventData](#eventdata)\> | Yes | Callback used to return the event. |
+| Name | Type | Mandatory| Description |
+| -------- | ----------------------------------- | ---- | ------------------------ |
+| event | [InnerEvent](#innerevent) | Yes | Event to subscribe to in one-shot manner. |
+| callback | Callback\<[EventData](#eventdata)\> | Yes | Callback used to return the event.|
**Example**
@@ -88,9 +93,9 @@ Unsubscribes from an event.
**Parameters**
- | Name | Type | Mandatory | Description |
- | ------- | ------ | ---- | ------ |
- | eventId | number | Yes | Event ID. |
+| Name | Type | Mandatory| Description |
+| ------- | ------ | ---- | ------ |
+| eventId | number | Yes | Event ID.|
**Example**
@@ -108,10 +113,10 @@ Emits an event to the event queue.
**Parameters**
- | Name | Type | Mandatory | Description |
- | ------ | ------------------------- | ---- | -------------- |
- | event | [InnerEvent](#innerevent) | Yes | Event to emit. |
- | data | [EventData](#eventdata) | No | Data carried by the event. |
+| Name| Type | Mandatory| Description |
+| ------ | ------------------------- | ---- | -------------- |
+| event | [InnerEvent](#innerevent) | Yes | Event to emit. |
+| data | [EventData](#eventdata) | No | Data carried by the event.|
**Example**
@@ -130,17 +135,21 @@ emitter.emit(innerEvent, eventData);
## InnerEvent
-Describes an intra-process event.
+Describes an in-process event.
- | Name | Type | Readable | Writable | Description |
- | -------- | ------------------------------- | ---- | ---- | ---------------------------------- |
- | eventId | number | Yes | Yes | Event ID, which is used to identify an event. **System capability**: SystemCapability.Notification.Emitter |
- | priority | [EventPriority](#eventpriority) | Yes | Yes | Emit priority of the event. **System capability**: SystemCapability.Notification.Emitter |
+**System capability**: SystemCapability.Notification.Emitter
+
+| Name | Type | Readable| Writable| Description |
+| -------- | ------------------------------- | ---- | ---- | ---------------------------------- |
+| eventId | number | Yes | Yes | Event ID, which is used to identify an event.|
+| priority | [EventPriority](#eventpriority) | Yes | Yes | Emit priority of the event. |
## EventData
Describes the data passed in the event.
- | Name | Type | Readable | Writable | Description |
- | ---- | ------------------ | ---- | ---- | -------------- |
- | data | [key: string]: any | Yes | Yes | Data carried by the event. The data type can be String, Integer, or Boolean. **System capability**: SystemCapability.Notification.Emitter |
+**System capability**: SystemCapability.Notification.Emitter
+
+| Name| Type | Readable| Writable| Description |
+| ---- | ------------------ | ---- | ---- | -------------- |
+| data | [key: string]: any | Yes | Yes | Data carried by the event. The data type can be String, Integer, or Boolean.|
diff --git a/en/application-dev/reference/apis/js-apis-inputmethod.md b/en/application-dev/reference/apis/js-apis-inputmethod.md
index 0b7fc7a4e6e20b0cbd760c85d4ac3ee120b6a6cf..be9cc1cb4ea2882c109046df2f373cf4defac9e8 100644
--- a/en/application-dev/reference/apis/js-apis-inputmethod.md
+++ b/en/application-dev/reference/apis/js-apis-inputmethod.md
@@ -1,6 +1,8 @@
# Input Method Framework
-> **NOTE**
+The **inputMethod** module provides an input method framework, which can be used to hide the keyboard, obtain the list of installed input methods, display the dialog box for input method selection, and more.
+
+> **NOTE**
>
> The initial APIs of this module are supported since API version 6. Newly added APIs will be marked with a superscript to indicate their earliest API version.
@@ -8,14 +10,14 @@
## Modules to Import
```
-import inputMethod from '@ohos.inputMethod';
+import inputMethod from '@ohos.inputmethod';
```
## inputMethod8+
Provides the constants.
-**System capability**: SystemCapability.Miscservices.InputMethodFramework
+**System capability**: SystemCapability.MiscServices.InputMethodFramework
| Name| Type| Readable| Writable| Description|
| -------- | -------- | -------- | -------- | -------- |
@@ -26,7 +28,7 @@ Provides the constants.
Describes the input method application attributes.
-**System capability**: SystemCapability.Miscservices.InputMethodFramework
+**System capability**: SystemCapability.MiscServices.InputMethodFramework
| Name| Type| Readable| Writable| Description|
| -------- | -------- | -------- | -------- | -------- |
@@ -37,15 +39,15 @@ Describes the input method application attributes.
getInputMethodController(): InputMethodController
-Obtains an [InputMethodController](#InputMethodController) instance.
+Obtains an **[InputMethodController](#inputmethodcontroller)** instance.
-**System capability**: SystemCapability.Miscservices.InputMethodFramework
+**System capability**: SystemCapability.MiscServices.InputMethodFramework
**Return value**
-| Type| Description|
-| -------- | -------- |
-| [InputMethodController](#InputMethodController) | Returns the current **InputMethodController** instance.|
+| Type | Description |
+| ----------------------------------------- | ---------------------------- |
+| [InputMethodController](#inputmethodcontroller) | Returns the current **InputMethodController** instance.|
**Example**
@@ -57,25 +59,74 @@ Obtains an [InputMethodController](#InputMethodController) instance.
getInputMethodSetting(): InputMethodSetting
-Obtains an [InputMethodSetting](#InputMethodSetting) instance.
+Obtains an **[InputMethodSetting](#inputmethodsetting8)** instance.
-**System capability**: SystemCapability.Miscservices.InputMethodFramework
+**System capability**: SystemCapability.MiscServices.InputMethodFramework
**Return value**
| Type | Description |
| ----------------------------------------- | ---------------------------- |
-| [InputMethodSetting](#InputMethodSetting) | Returns the current **InputMethodSetting** instance.|
+| [InputMethodSetting](#inputmethodsetting8) | Returns the current **InputMethodSetting** instance.|
+
**Example**
```js
var InputMethodSetting = inputMethod.getInputMethodSetting();
```
+## inputMethod.switchInputMethod9+
+
+switchInputMethod(target: InputmethodProperty, callback: AsyncCallback<boolean>): void;
+
+Switches to another input method. This API uses an asynchronous callback to return the result. This API can be used only in the stage model.
+
+**System capability**: SystemCapability.MiscServices.InputMethodFramework
+
+**Parameters**
+
+| Name| Type| Mandatory| Description|
+| -------- | -------- | -------- | -------- |
+|target | [InputmethodProperty](#inputmethodproperty8) | Yes| Input method to switch to.|
+| callback | AsyncCallback<boolean> | Yes| Callback used to return the execution result. |
+
+
+**Example**
+
+```js
+ inputMethod.switchInputMethod({packageName:"com.ohos.inputApp", methodId:"InputDemoService"}).then(res => {
+ prompt.showToast({message:"Input method switched." + this.imeList[this.flag].packageName, duration: 200});
+ });
+```
+## inputMethod.switchInputMethod9+
+switchInputMethod(target: InputmethodProperty): Promise<boolean>
+
+Switches to another input method. This API uses a promise to return the result. This API can be used only in the stage model.
+**System capability**: SystemCapability.MiscServices.InputMethodFramework
+
+**Parameters**
+
+| Name| Type| Mandatory| Description|
+| -------- | -------- | -------- | -------- |
+|target | [InputmethodProperty](#inputmethodproperty8)| Yes| Input method to switch to.|
+
+**Return value**
+| Type | Description |
+| ----------------------------------------- | ---------------------------- |
+| Promise\ | Promise used to return the execution result. |
+
+**Example**
+
+
+```js
+ inputMethod.switchInputMethod({packageName:"com.ohos.inputApp", methodId:"InputDemoService"}).then(res => {
+ prompt.showToast({message:"Input method switched." + this.imeList[this.flag].packageName, duration: 200});
+ });
+```
## InputMethodController
-In the following API examples, you must first use [getInputMethodController](#getInputMethodController) to obtain an **InputMethodController** instance, and then call the APIs using the obtained instance.
+In the following API examples, you must first use **[getInputMethodController](#inputmethodgetinputmethodcontroller)** to obtain an **InputMethodController** instance, and then call the APIs using the obtained instance.
### stopInput
@@ -83,7 +134,7 @@ stopInput(callback: AsyncCallback<boolean>): void
Hides the keyboard. This API uses an asynchronous callback to return the result.
-**System capability**: SystemCapability.Miscservices.InputMethodFramework
+**System capability**: SystemCapability.MiscServices.InputMethodFramework
**Parameters**
@@ -105,13 +156,13 @@ stopInput(): Promise<boolean>
Hides the keyboard. This API uses an asynchronous callback to return the result.
-**System capability**: SystemCapability.Miscservices.InputMethodFramework
+**System capability**: SystemCapability.MiscServices.InputMethodFramework
**Return value**
| Type| Description|
| -------- | -------- |
-| Promise<boolean> | Promise used to return whether the keyboard is successfully hidden.|
+| Promise<boolean> | Promise used to return whether the keyboard is successfully hidden. |
**Example**
@@ -123,7 +174,7 @@ Hides the keyboard. This API uses an asynchronous callback to return the result.
## InputMethodSetting8+
-In the following API examples, you must first use [getInputMethodSetting](#getInputMethodSetting) to obtain an **InputMethodSetting** instance, and then call the APIs using the obtained instance.
+In the following API examples, you must first use **[getInputMethodSetting](#inputmethodgetinputmethodsetting8)** to obtain an **InputMethodSetting** instance, and then call the APIs using the obtained instance.
### listInputMethod
@@ -131,13 +182,12 @@ listInputMethod(callback: AsyncCallback<Array<InputMethodProperty>>)
Obtains the list of installed input methods. This API uses an asynchronous callback to return the result.
-**System capability**: SystemCapability.Miscservices.InputMethodFramework
+**System capability**: SystemCapability.MiscServices.InputMethodFramework
**Parameters**
-
| Name | Type | Mandatory| Description |
| -------- | -------------------------------------------------- | ---- | ---------------------- |
-| callback | Array<[InputMethodProperty](#InputMethodProperty)> | Yes | Callback used to return the list of installed input methods.|
+| callback | Array<[InputMethodProperty](#inputmethodproperty8)> | Yes | Callback used to return the list of installed input methods.|
**Example**
@@ -156,13 +206,12 @@ listInputMethod(): Array<InputMethodProperty>
Obtains the list of installed input methods. This API uses an asynchronous callback to return the result.
-**System capability**: SystemCapability.Miscservices.InputMethodFramework
+**System capability**: SystemCapability.MiscServices.InputMethodFramework
**Return value**
-
| Type | Description |
| ----------------------------------------------------------- | ---------------------- |
-| Promise> | Promise used to return the list of installed input methods.|
+| Promise> | Promise used to return the list of installed input methods. |
**Example**
@@ -180,15 +229,16 @@ displayOptionalInputMethod(callback: AsyncCallback<void>): void
Displays a dialog box for selecting an input method. This API uses an asynchronous callback to return the result.
-**System capability**: SystemCapability.Miscservices.InputMethodFramework
+**System capability**: SystemCapability.MiscServices.InputMethodFramework
-- Parameters
+**Parameters**
| Name| Type| Mandatory| Description|
| -------- | -------- | -------- | -------- |
| callback | AsyncCallback<void> | Yes| Callback used to return the execution result.|
**Example**
+
```js
InputMethodSetting.displayOptionalInputMethod(()=>{
console.info('displayOptionalInputMethod is called');
@@ -197,20 +247,20 @@ Displays a dialog box for selecting an input method. This API uses an asynchrono
### displayOptionalInputMethod
- displayOptionalInputMethod(): Promise<void>
+displayOptionalInputMethod(): Promise<void>
Displays a dialog box for selecting an input method. This API uses an asynchronous callback to return the result.
-**System capability**: SystemCapability.Miscservices.InputMethodFramework
+**System capability**: SystemCapability.MiscServices.InputMethodFramework
**Return value**
| Type| Description|
| -------- | -------- |
-| Promise<void> | Promise used to return the execution result.|
+| Promise<void> | Promise used to return the execution result. |
**Example**
```js
InputMethodSetting.displayOptionalInputMethod();
-```
\ No newline at end of file
+```
diff --git a/en/application-dev/reference/apis/js-apis-inputmethodengine.md b/en/application-dev/reference/apis/js-apis-inputmethodengine.md
index 60c6c8a4ce2d0caad26c838e6353cdc21bcbc785..55e702cd0501af092bbc7e0420f410ff81ed90c6 100644
--- a/en/application-dev/reference/apis/js-apis-inputmethodengine.md
+++ b/en/application-dev/reference/apis/js-apis-inputmethodengine.md
@@ -1,19 +1,22 @@
# Input Method Engine
->  **NOTE** The initial APIs of this module are supported since API version 8. Newly added APIs will be marked with a superscript to indicate their earliest API version.
+The **inputMethodEngine** module streamlines the interaction between applications and input methods. By calling APIs of this module, applications can accept text input through the input methods, be bound to input method services, request the keyboard to display or hide, listen for the input method status, and much more.
+
+> **NOTE**
>
+> The initial APIs of this module are supported since API version 8. Newly added APIs will be marked with a superscript to indicate their earliest API version.
## Modules to Import
```
-import inputMethodEngine from '@ohos.inputMethodEngine';
+import inputMethodEngine from '@ohos.inputmethodengine';
```
## inputMethodEngine
-Defines constant values.
+Provides the constants.
-**System capability**: SystemCapability.Miscservices.InputMethodFramework
+**System capability**: SystemCapability.MiscServices.InputMethodFramework
| Name| Type| Readable| Writable| Description|
| -------- | -------- | -------- | -------- | -------- |
@@ -50,7 +53,7 @@ getInputMethodEngine(): InputMethodEngine
Obtains an **InputMethodEngine** instance.
-**System capability**: SystemCapability.Miscservices.InputMethodFramework
+**System capability**: SystemCapability.MiscServices.InputMethodFramework
**Return value**
@@ -60,9 +63,9 @@ Obtains an **InputMethodEngine** instance.
**Example**
-```js
-var InputMethodEngine = inputMethodEngine.getInputMethodEngine();
-```
+ ```js
+ var InputMethodEngine = inputMethodEngine.getInputMethodEngine();
+ ```
## inputMethodEngine.createKeyboardDelegate
@@ -70,7 +73,7 @@ createKeyboardDelegate(): KeyboardDelegate
Obtains a **KeyboardDelegate** instance.
-**System capability**: SystemCapability.Miscservices.InputMethodFramework
+**System capability**: SystemCapability.MiscServices.InputMethodFramework
**Return value**
@@ -80,9 +83,9 @@ Obtains a **KeyboardDelegate** instance.
**Example**
-```js
-var KeyboardDelegate = inputMethodEngine.createKeyboardDelegate();
-```
+ ```js
+ var KeyboardDelegate = inputMethodEngine.createKeyboardDelegate();
+ ```
## InputMethodEngine
@@ -94,7 +97,7 @@ on(type: 'inputStart', callback: (kbController: KeyboardController, textInputCli
Listens for the input method binding event. This API uses a callback to return the result.
-**System capability**: SystemCapability.Miscservices.InputMethodFramework
+**System capability**: SystemCapability.MiscServices.InputMethodFramework
**Parameters**
@@ -105,12 +108,12 @@ Listens for the input method binding event. This API uses a callback to return t
**Example**
-```js
-InputMethodEngine.on('inputStart', (kbController, textInputClient) => {
- KeyboardController = kbController;
- TextInputClient = textInputClient;
-});
-```
+ ```js
+ InputMethodEngine.on('inputStart', (kbController, textInputClient) => {
+ KeyboardController = kbController;
+ TextInputClient = textInputClient;
+ });
+ ```
### off('inputStart')
@@ -118,7 +121,7 @@ off(type: 'inputStart', callback?: (kbController: KeyboardController, textInputC
Cancels listening for the input method binding event.
-**System capability**: SystemCapability.Miscservices.InputMethodFramework
+**System capability**: SystemCapability.MiscServices.InputMethodFramework
**Parameters**
@@ -127,11 +130,13 @@ Cancels listening for the input method binding event.
| type | string | Yes | Listening type. Set it to **'inputStart'**, which indicates listening for the input method binding event.|
| callback | [KeyboardController](#KeyboardController), [TextInputClient](#TextInputClient) | No| Callback used to return the result.|
+
+
**Example**
-```js
-InputMethodEngine.off('inputStart');
-```
+ ```js
+ InputMethodEngine.off('inputStart');
+ ```
### on('keyboardShow'|'keyboardHide')
@@ -139,22 +144,22 @@ on(type: 'keyboardShow'|'keyboardHide', callback: () => void): void
Listens for an input method event.
-**System capability**: SystemCapability.Miscservices.InputMethodFramework
+**System capability**: SystemCapability.MiscServices.InputMethodFramework
**Parameters**
| Name | Type | Mandatory| Description |
| -------- | ------ | ---- | ------------------------------------------------------------ |
-| type | string | Yes | Listening type. - The value **'keyboardShow'** means to listen for displaying of the input method. - The value **'keyboardHide'** means to listen for hiding of the input method.|
+| type | string | Yes | Listening type. - The value **'keyboardShow'** means to listen for displaying of the input method. - The value **'keyboardHide'** means to listen for hiding of the input method.|
| callback | void | No | Callback used to return the result. |
**Example**
-```js
-InputMethodEngine.on('keyboardShow', (err) => {
- console.info('keyboardShow');
-});
-```
+ ```js
+ InputMethodEngine.on('keyboardShow', (err) => {
+ console.info('keyboardShow');
+ });
+ ```
### off('keyboardShow'|'keyboardHide')
@@ -162,20 +167,21 @@ off(type: 'keyboardShow'|'keyboardHide', callback?: () => void): void
Cancels listening for an input method event.
-**System capability**: SystemCapability.Miscservices.InputMethodFramework
+**System capability**: SystemCapability.MiscServices.InputMethodFramework
**Parameters**
| Name | Type | Mandatory| Description |
| -------- | ------ | ---- | ------------------------------------------------------------ |
-| type | string | Yes | Listening type. - The value **'keyboardShow'** means to listen for displaying of the input method. - The value **'keyboardHide'** means to listen for hiding of the input method.|
+| type | string | Yes | Listening type. - The value **'keyboardShow'** means to listen for displaying of the input method. - The value **'keyboardHide'** means to listen for hiding of the input method.|
| callback | void | No | Callback used to return the result. |
**Example**
-```js
-InputMethodEngine.off('keyboardShow');
-```
+ ```js
+ InputMethodEngine.off('keyboardShow');
+ ```
+
## KeyboardDelegate
@@ -187,22 +193,24 @@ on(type: 'keyDown'|'keyUp', callback: (event: KeyEvent) => boolean): void
Listens for a hard keyboard even. This API uses a callback to return the key information.
-**System capability**: SystemCapability.Miscservices.InputMethodFramework
+**System capability**: SystemCapability.MiscServices.InputMethodFramework
**Parameters**
| Name | Type | Mandatory| Description |
| -------- | ------------------------------- | ---- | ------------------------------------------------------------ |
-| type | string | Yes | Listening type. - The value **'keyDown'** means to listen for pressing of a key. - The value **'keyUp'** means to listen for releasing of a key.|
+| type | string | Yes | Listening type. - The value **'keyDown'** means to listen for pressing of a key. - The value **'keyUp'** means to listen for releasing of a key.|
| callback | [KeyEvent](#KeyEvent) | Yes| Callback used to return the key information.|
+
+
**Example**
-```js
-KeyboardDelegate.on('keyDown', (event) => {
- console.info('keyDown');
-});
-```
+ ```js
+ KeyboardDelegate.on('keyDown', (event) => {
+ console.info('keyDown');
+ });
+ ```
### off('keyDown'|'keyUp')
@@ -210,20 +218,20 @@ off(type: 'keyDown'|'keyUp', callback?: (event: KeyEvent) => boolean): void
Cancels listening for a hard keyboard even.
-**System capability**: SystemCapability.Miscservices.InputMethodFramework
+**System capability**: SystemCapability.MiscServices.InputMethodFramework
**Parameters**
| Name | Type | Mandatory| Description |
| -------- | --------------------- | ---- | ------------------------------------------------------------ |
-| type | string | Yes | Listening type. - The value **'keyDown'** means to listen for pressing of a key. - The value **'keyUp'** means to listen for releasing of a key.|
+| type | string | Yes | Listening type. - The value **'keyDown'** means to listen for pressing of a key. - The value **'keyUp'** means to listen for releasing of a key.|
| callback | [KeyEvent](#KeyEvent) | No | Callback used to return the key information. |
**Example**
-```js
-KeyboardDelegate.off('keyDown');
-```
+ ```js
+ KeyboardDelegate.off('keyDown');
+ ```
### on('cursorContextChange')
@@ -231,21 +239,25 @@ on(type: 'cursorContextChange', callback: (x: number, y:number, height:number) =
Listens for cursor context changes. This API uses a callback to return the cursor information.
-**System capability**: SystemCapability.Miscservices.InputMethodFramework
+ **System capability**: SystemCapability.MiscServices.InputMethodFramework
-**Parameters**
+ **Parameters**
| Name | Type | Mandatory| Description |
| -------- | ------ | ---- | ------------------------------------------------------------ |
| type | string | Yes | Listening type. Set it to **'cursorContextChange'**, which indicates listening for cursor context changes.|
| callback | number | Yes | Callback used to return the cursor information. |
-**Example**
+
+
+ **Example**
```js
+
KeyboardDelegate.on('cursorContextChange', (x, y, height) => {
console.info('cursorContextChange');
});
+
```
### off('cursorContextChange')
@@ -254,42 +266,46 @@ off(type: 'cursorContextChange', callback?: (x: number, y:number, height:number)
Cancels listening for cursor context changes.
-**System capability**: SystemCapability.Miscservices.InputMethodFramework
+**System capability**: SystemCapability.MiscServices.InputMethodFramework
-**Parameters**
+ **Parameters**
-| Name | Type | Mandatory| Description |
-| -------- | -------------------- | ---- | ------------------------ |
-| type | string | Yes | Listening type. Set it to **'cursorContextChange'**, which indicates listening for cursor context changes.|
-| callback | number | No| Callback used to return the cursor information.|
+| Name | Type | Mandatory| Description |
+| -------- | ------ | ---- | ------------------------------------------------------------ |
+| type | string | Yes | Listening type. Set it to **'cursorContextChange'**, which indicates listening for cursor context changes.|
+| callback | number | No | Callback used to return the cursor information. |
-**Example**
+
+ **Example**
```js
+
KeyboardDelegate.off('cursorContextChange');
-```
+```
### on('selectionChange')
on(type: 'selectionChange', callback: (oldBegin: number, oldEnd: number, newBegin: number, newEnd: number) => void): void
Listens for text selection changes. This API uses a callback to return the text selection information.
-**System capability**: SystemCapability.Miscservices.InputMethodFramework
+**System capability**: SystemCapability.MiscServices.InputMethodFramework
-**Parameters**
+ **Parameters**
| Name | Type | Mandatory| Description |
| -------- | ------ | ---- | ------------------------------------------------------------ |
| type | string | Yes | Listening type. Set it to **'selectionChange'**, which indicates listening for text selection changes.|
| callback | number | Yes | Callback used to return the text selection information. |
-**Example**
+ **Example**
```js
+
KeyboardDelegate.on('selectionChange', (oldBegin, oldEnd, newBegin, newEnd) => {
console.info('selectionChange');
});
+
```
### off('selectionChange')
@@ -298,19 +314,21 @@ off(type: 'selectionChange', callback?: (oldBegin: number, oldEnd: number, newBe
Cancels listening for text selection changes.
-**System capability**: SystemCapability.Miscservices.InputMethodFramework
+**System capability**: SystemCapability.MiscServices.InputMethodFramework
-**Parameters**
+ **Parameters**
-| Name | Type | Mandatory| Description |
-| -------- | -------------------- | ---- | ------------------------ |
-| type | string | Yes | Listening type. Set it to **'selectionChange'**, which indicates listening for text selection changes.|
-| callback | number | No| Callback used to return the text selection information.|
+| Name | Type | Mandatory| Description |
+| -------- | ------ | ---- | ------------------------------------------------------------ |
+| type | string | Yes | Listening type. Set it to **'selectionChange'**, which indicates listening for text selection changes.|
+| callback | number | No | Callback used to return the text selection information. |
-**Example**
+ **Example**
```js
+
KeyboardDelegate.off('selectionChange');
+
```
@@ -320,21 +338,23 @@ on(type: 'textChange', callback: (text: string) => void): void
Listens for text changes. This API uses a callback to return the current text content.
-**System capability**: SystemCapability.Miscservices.InputMethodFramework
+**System capability**: SystemCapability.MiscServices.InputMethodFramework
-**Parameters**
+ **Parameters**
-| Name | Type | Mandatory| Description |
-| -------- | ------------------------------- | ---- | ------------------------------------------------------------ |
-| type | string | Yes | Listening type. Set it to **'textChange'**, which indicates listening for text changes.|
-| callback | string | Yes| Callback used to return the current text content.|
+| Name | Type | Mandatory| Description |
+| -------- | ------ | ---- | ------------------------------------------------------------ |
+| type | string | Yes | Listening type. Set it to **'textChange'**, which indicates listening for text changes.|
+| callback | string | Yes | Callback used to return the current text content. |
-**Example**
+ **Example**
```js
+
KeyboardDelegate.on('textChange', (text) => {
console.info('textChange');
});
+
```
### off('textChange')
@@ -343,16 +363,16 @@ off(type: 'textChange', callback?: (text: string) => void): void
Cancels listening for text changes.
-**System capability**: SystemCapability.Miscservices.InputMethodFramework
+**System capability**: SystemCapability.MiscServices.InputMethodFramework
-**Parameters**
+ **Parameters**
-| Name | Type | Mandatory| Description |
-| -------- | -------------------- | ---- | ------------------------ |
-| type | string | Yes | Listening type. Set it to **'textChange'**, which indicates listening for text changes.|
-| callback | string | No| Callback used to return the current text content.|
+| Name | Type | Mandatory| Description |
+| -------- | ------ | ---- | ------------------------------------------------------------ |
+| type | string | Yes | Listening type. Set it to **'textChange'**, which indicates listening for text changes.|
+| callback | string | No | Callback used to return the current text content. |
-**Example**
+ **Example**
```js
KeyboardDelegate.off('textChange');
@@ -368,7 +388,7 @@ hideKeyboard(callback: AsyncCallback<void>): void
Hides the keyboard. This API uses an asynchronous callback to return the result.
-**System capability**: SystemCapability.Miscservices.InputMethodFramework
+**System capability**: SystemCapability.MiscServices.InputMethodFramework
**Parameters**
@@ -388,19 +408,18 @@ Hides the keyboard. This API uses an asynchronous callback to return the result.
hideKeyboard(): Promise<void>
-Hides the keyboard. This API uses a promise to return the result.
+Hides the keyboard. This API uses an asynchronous callback to return the result.
-**System capability**: SystemCapability.Miscservices.InputMethodFramework
+**System capability**: SystemCapability.MiscServices.InputMethodFramework
**Return value**
-| Type | Description: |
+| Type | Description |
| ---------------- | -------- |
| Promise<void> | Promise used to return the result.|
**Example**
-
```js
KeyboardController.hideKeyboard();
```
@@ -415,30 +434,30 @@ getForward(length:number, callback: AsyncCallback<string>): void
Obtains the specific-length text before the cursor. This API uses an asynchronous callback to return the result.
-**System capability**: SystemCapability.Miscservices.InputMethodFramework
+**System capability**: SystemCapability.MiscServices.InputMethodFramework
**Parameters**
| Name| Type| Mandatory| Description|
| -------- | -------- | -------- | -------- |
| length | number | Yes| Text length.|
-| callback | AsyncCallback<string> | Yes| Text returned.|
+| callback | AsyncCallback<string> | Yes| Callback used to return the text.|
**Example**
-```js
- TextInputClient.getForward(5,(text) =>{
- console.info("text = " + text);
- });
-```
+ ```js
+ TextInputClient.getForward(5,(text) =>{
+ console.info("text = " + text);
+ });
+ ```
### getForward
getForward(length:number): Promise<string>
-Obtains the specific-length text before the cursor. This API uses a promise to return the result.
+Obtains the specific-length text before the cursor. This API uses an asynchronous callback to return the result.
-**System capability**: SystemCapability.Miscservices.InputMethodFramework
+**System capability**: SystemCapability.MiscServices.InputMethodFramework
**Parameters**
@@ -450,14 +469,14 @@ Obtains the specific-length text before the cursor. This API uses a promise to r
| Type | Description |
| ------------------------------- | ------------------------------------------------------------ |
-| Promise<string> | Text returned. |
+| Promise<string> | Promise used to return the text. |
**Example**
-```js
- var text = TextInputClient.getForward(5);
- console.info("text = " + text);
-```
+ ```js
+ var text = TextInputClient.getForward(5);
+ console.info("text = " + text);
+ ```
### getBackward
@@ -465,30 +484,30 @@ getBackward(length:number, callback: AsyncCallback<string>): void
Obtains the specific-length text after the cursor. This API uses an asynchronous callback to return the result.
-**System capability**: SystemCapability.Miscservices.InputMethodFramework
+**System capability**: SystemCapability.MiscServices.InputMethodFramework
**Parameters**
| Name| Type| Mandatory| Description|
| -------- | -------- | -------- | -------- |
| length | number | Yes| Text length.|
-| callback | AsyncCallback<string> | Yes| Text returned.|
+| callback | AsyncCallback<string> | Yes| Callback used to return the text.|
**Example**
-```js
- TextInputClient.getBackward(5,(text)=>{
- console.info("text = " + text);
-});
-```
+ ```js
+ TextInputClient.getBackward(5,(text)=>{
+ console.info("text = " + text);
+ });
+ ```
### getBackward
getBackward(length:number): Promise<string>
-Obtains the specific-length text after the cursor. This API uses a promise to return the result.
+Obtains the specific-length text after the cursor. This API uses an asynchronous callback to return the result.
-**System capability**: SystemCapability.Miscservices.InputMethodFramework
+**System capability**: SystemCapability.MiscServices.InputMethodFramework
**Parameters**
@@ -500,14 +519,14 @@ Obtains the specific-length text after the cursor. This API uses a promise to re
| Type | Description |
| ------------------------------- | ------------------------------------------------------------ |
-| Promise<string> | Text returned. |
+| Promise<string> | Promise used to return the text. |
**Example**
-```js
- var text = TextInputClient.getBackward(5);
- console.info("text = " + text);
-```
+ ```js
+ var text = TextInputClient.getBackward(5);
+ console.info("text = " + text);
+ ```
### deleteForward
@@ -515,47 +534,46 @@ deleteForward(length:number, callback: AsyncCallback<boolean>): void
Deletes the fixed-length text before the cursor. This API uses an asynchronous callback to return the result.
-**System capability**: SystemCapability.Miscservices.InputMethodFramework
+**System capability**: SystemCapability.MiscServices.InputMethodFramework
**Parameters**
| Name| Type| Mandatory| Description|
| -------- | -------- | -------- | -------- |
| length | number | Yes| Text length.|
-| callback | AsyncCallback<boolean> | Yes| Returns whether the operation is successful.|
+| callback | AsyncCallback<boolean> | Yes| Callback used to return the result.|
**Example**
-```js
-TextInputClient.deleteForward(5,(isSuccess)=>{
- console.info("isSuccess = " + isSuccess);
-});
-```
-
+ ```js
+ TextInputClient.deleteForward(5,(isSuccess)=>{
+ console.info("isSuccess = " + isSuccess);
+ });
+ ```
### deleteForward
deleteForward(length:number): Promise<boolean>
-Deletes the fixed-length text before the cursor. This API uses a promise to return the result.
+Deletes the fixed-length text before the cursor. This API uses an asynchronous callback to return the result.
-**System capability**: SystemCapability.Miscservices.InputMethodFramework
+**System capability**: SystemCapability.MiscServices.InputMethodFramework
**Parameters**
-| Name| Type| Mandatory| Description|
-| -------- | -------- | -------- | -------- |
-| length | number | Yes| Text length.|
+| Name| Type | Mandatory| Description |
+| ------ | ------ | ---- | ---------- |
+| length | number | Yes | Text length.|
**Return value**
-| Type | Description |
-| ------------------------------- | ------------------------------------------------------------ |
-| Promise<boolean> | Returns whether the operation is successful. |
+| Type | Description |
+| ---------------------- | -------------- |
+| Promise<boolean> | Promise used to return the result.|
**Example**
```js
- var isSuccess = TextInputClient.deleteForward(5);
+var isSuccess = TextInputClient.deleteForward(5);
console.info("isSuccess = " + isSuccess);
```
@@ -565,33 +583,34 @@ deleteBackward(length:number, callback: AsyncCallback<boolean>): void
Deletes the fixed-length text after the cursor. This API uses an asynchronous callback to return the result.
-**System capability**: SystemCapability.Miscservices.InputMethodFramework
+**System capability**: SystemCapability.MiscServices.InputMethodFramework
-**Parameters**
+ **Parameters**
-| Name| Type| Mandatory| Description|
-| -------- | -------- | -------- | -------- |
-| length | number | Yes| Text length.|
-| callback | AsyncCallback<boolean> | Yes| Returns whether the operation is successful.|
+| Name | Type | Mandatory| Description |
+| -------- | ---------------------------- | ---- | -------------- |
+| length | number | Yes | Text length. |
+| callback | AsyncCallback<boolean> | Yes | Callback used to return the result.|
-**Example**
+ **Example**
```js
+
TextInputClient.deleteBackward(5, (isSuccess)=>{
console.info("isSuccess = " + isSuccess);
});
+
```
### deleteBackward
deleteBackward(length:number): Promise<boolean>
-Deletes the fixed-length text after the cursor. This API uses a promise to return the result.
+Deletes the fixed-length text after the cursor. This API uses an asynchronous callback to return the result.
-**System capability**: SystemCapability.Miscservices.InputMethodFramework
+**System capability**: SystemCapability.MiscServices.InputMethodFramework
**Parameters**
-
| Name| Type| Mandatory| Description|
| -------- | -------- | -------- | -------- |
| length | number | Yes| Text length.|
@@ -600,45 +619,48 @@ Deletes the fixed-length text after the cursor. This API uses a promise to retur
| Type | Description |
| ------------------------------- | ------------------------------------------------------------ |
-| Promise<boolean> | Returns whether the operation is successful. |
+| Promise<boolean> | Promise used to return the result. |
**Example**
```js
-var isSuccess = TextInputClient.deleteBackward(5);
-console.info("isSuccess = " + isSuccess);
-```
+ var isSuccess = TextInputClient.deleteBackward(5);
+ console.info("isSuccess = " + isSuccess);
+
+```
### sendKeyFunction
sendKeyFunction(action:number, callback: AsyncCallback<boolean>): void
Sets the Enter key to send the text to its target. This API uses an asynchronous callback to return the result.
-**System capability**: SystemCapability.Miscservices.InputMethodFramework
+**System capability**: SystemCapability.MiscServices.InputMethodFramework
-**Parameters**
+ **Parameters**
| Name| Type| Mandatory| Description|
| -------- | -------- | -------- | -------- |
| action | number | Yes| Edit box attribute.|
-| callback | AsyncCallback<boolean> | Yes| Returns whether the operation is successful.|
+| callback | AsyncCallback<boolean> | Yes| Callback used to return the result.|
-**Example**
+ **Example**
```js
+
TextInputClient.sendKeyFunction(inputMethod.ENTER_KEY_TYPE_NEXT,(isSuccess)=>{
console.info("isSuccess = " + isSuccess);
});
+
```
### sendKeyFunction
sendKeyFunction(action:number): Promise<boolean>
-Sets the Enter key to send the text to its target. This API uses a promise to return the result.
+Sets the Enter key to send the text to its target. This API uses an asynchronous callback to return the result.
-**System capability**: SystemCapability.Miscservices.InputMethodFramework
+**System capability**: SystemCapability.MiscServices.InputMethodFramework
**Parameters**
@@ -650,14 +672,14 @@ Sets the Enter key to send the text to its target. This API uses a promise to re
| Type | Description |
| ------------------------------- | ------------------------------------------------------------ |
-| Promise<boolean> | Returns whether the operation is successful. |
+| Promise<boolean> | Promise used to return the result. |
**Example**
-```js
-var isSuccess = TextInputClient.sendKeyFunction(inputMethod.ENTER_KEY_TYPE_NEXT);
-console.info("isSuccess = " + isSuccess);
-```
+ ```js
+ var isSuccess = TextInputClient.sendKeyFunction(inputMethod.ENTER_KEY_TYPE_NEXT);
+ console.info("isSuccess = " + isSuccess);
+ ```
### insertText
@@ -665,30 +687,32 @@ insertText(text:string, callback: AsyncCallback<boolean>): void
Inserts text. This API uses an asynchronous callback to return the result.
-**System capability**: SystemCapability.Miscservices.InputMethodFramework
+**System capability**: SystemCapability.MiscServices.InputMethodFramework
**Parameters**
| Name| Type| Mandatory| Description|
| -------- | -------- | -------- | -------- |
| text | string | Yes| Text to insert.|
-| callback | AsyncCallback<boolean> | Yes| Returns whether the operation is successful.|
+| callback | AsyncCallback<boolean> | Yes| Callback used to return the result.|
**Example**
```js
+
TextInputClient.insertText("test", (isSuccess)=>{
console.info("isSuccess = " + isSuccess);
});
+
```
### insertText
insertText(text:string): Promise<boolean>
-Inserts text. This API uses a promise to return the result.
+Inserts text. This API uses an asynchronous callback to return the result.
-**System capability**: SystemCapability.Miscservices.InputMethodFramework
+**System capability**: SystemCapability.MiscServices.InputMethodFramework
**Parameters**
@@ -696,18 +720,18 @@ Inserts text. This API uses a promise to return the result.
| -------- | -------- | -------- | -------- |
| text | string | Yes| Text to insert.|
-**Return value**
+**Return value**
| Type | Description |
| ------------------------------- | ------------------------------------------------------------ |
-| Promise<boolean> | Returns whether the operation is successful. |
+| Promise<boolean> | Promise used to return the result. |
**Example**
-```js
-var isSuccess = TextInputClient.insertText("test");
-console.info("isSuccess = " + isSuccess);
-```
+ ```js
+ var isSuccess = TextInputClient.insertText("test");
+ console.info("isSuccess = " + isSuccess);
+ ```
### getEditorAttribute
@@ -715,7 +739,7 @@ getEditorAttribute(callback: AsyncCallback<EditorAttribute>): void
Obtains the attribute of the edit box. This API uses an asynchronous callback to return the result.
-**System capability**: SystemCapability.Miscservices.InputMethodFramework
+**System capability**: SystemCapability.MiscServices.InputMethodFramework
**Parameters**
@@ -725,36 +749,36 @@ Obtains the attribute of the edit box. This API uses an asynchronous callback to
**Example**
-```js
- TextInputClient.getEditorAttribute((EditorAttribute)=>{
- });
-```
+ ```js
+ TextInputClient.getEditorAttribute((EditorAttribute)=>{
+ });
+ ```
### getEditorAttribute
getEditorAttribute(): EditorAttribute
-Obtains the attribute of the edit box. This API uses a promise to return the result.
+Obtains the attribute of the edit box. This API uses an asynchronous callback to return the result.
-**System capability**: SystemCapability.Miscservices.InputMethodFramework
+**System capability**: SystemCapability.MiscServices.InputMethodFramework
**Return value**
| Type | Description |
| ------------------------------- | ------------------------------------------------------------ |
-| Promise<[EditorAttribute](#EditorAttribute)> | Returns the attribute of the edit box. |
+| Promise<[EditorAttribute](#EditorAttribute)> | Promise used to return the attribute of the edit box. |
**Example**
-```js
-var EditorAttribute = TextInputClient.getEditorAttribute();
-```
+ ```js
+ var EditorAttribute = TextInputClient.getEditorAttribute();
+ ```
## EditorAttribute
Describes the attribute of the edit box.
-**System capability**: SystemCapability.Miscservices.InputMethodFramework
+**System capability**: SystemCapability.MiscServices.InputMethodFramework
| Name | Type| Readable| Writable| Description |
| ------------ | -------- | ---- | ---- | ------------------ |
@@ -765,7 +789,7 @@ Describes the attribute of the edit box.
Describes the attribute of a key.
-**System capability**: SystemCapability.Miscservices.InputMethodFramework
+**System capability**: SystemCapability.MiscServices.InputMethodFramework
| Name | Type| Readable| Writable| Description |
| --------- | -------- | ---- | ---- | ------------ |
diff --git a/en/application-dev/reference/apis/js-apis-notification.md b/en/application-dev/reference/apis/js-apis-notification.md
index 7912809087579d64ca726be1b9ada1c8ea0129fb..1e9fa33963ed6eb07302ddfbb9db44973e9be4d4 100644
--- a/en/application-dev/reference/apis/js-apis-notification.md
+++ b/en/application-dev/reference/apis/js-apis-notification.md
@@ -1,6 +1,11 @@
# Notification
+The **Notification** module provides notification management capabilities, covering notifications, notification slots, notification subscription, notification enabled status, and notification badge status.
+
+Generally, only system applications have the permission to subscribe to and unsubscribe from notifications.
+
> **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.
## Modules to Import
@@ -21,7 +26,7 @@ Publishes a notification. This API uses an asynchronous callback to return the r
| Name | Readable| Writable| Type | Mandatory| Description |
| -------- | ---- | ---- | ------------------------------------------- | ---- | ------------------------------------------- |
-| request | Yes | No |[NotificationRequest](#notificationrequest) | Yes | Notification to publish.|
+| request | Yes | No |[NotificationRequest](#notificationrequest) | Yes | **NotificationRequest** object.|
| callback | Yes | No |AsyncCallback\ | Yes | Callback used to return the result. |
**Example**
@@ -85,13 +90,15 @@ Publishes a notification. This API uses an asynchronous callback to return the r
**System capability**: SystemCapability.Notification.Notification
+**Required permissions**: ohos.permission.NOTIFICATION_CONTROLLER
+
**System API**: This is a system API and cannot be called by third-party applications.
**Parameters**
| Name | Readable| Writable| Type | Mandatory| Description |
| -------- | ---- | ---- | ----------------------------------------- | ---- | ------------------------------------------- |
-| request | Yes | No |[NotificationRequest](#notificationrequest) | Yes | Notification to publish.|
+| request | Yes | No |[NotificationRequest](#notificationrequest) | Yes | **NotificationRequest** object.|
| userId | Yes | No |number | Yes | ID of the user who receives the notification. |
| callback | Yes | No |AsyncCallback\ | Yes | Callback used to return the result. |
@@ -127,13 +134,15 @@ Publishes a notification. This API uses a promise to return the result.
**System capability**: SystemCapability.Notification.Notification
+**Required permissions**: ohos.permission.NOTIFICATION_CONTROLLER
+
**System API**: This is a system API and cannot be called by third-party applications.
**Parameters**
| Name | Readable| Writable| Type | Mandatory| Description |
| -------- | ---- | ---- | ----------------------------------------- | ---- | ------------------------------------------- |
-| request | Yes | No |[NotificationRequest](#notificationrequest) | Yes | Notification to publish.|
+| request | Yes | No |[NotificationRequest](#notificationrequest) | Yes | **NotificationRequest** object.|
| userId | Yes | No |number | Yes | ID of the user who receives the notification. |
**Example**
@@ -291,6 +300,8 @@ Adds a notification slot. This API uses an asynchronous callback to return the r
**System capability**: SystemCapability.Notification.Notification
+**Required permissions**: ohos.permission.NOTIFICATION_CONTROLLER
+
**System API**: This is a system API and cannot be called by third-party applications.
**Parameters**
@@ -324,6 +335,8 @@ Adds a notification slot. This API uses a promise to return the result.
**System capability**: SystemCapability.Notification.Notification
+**Required permissions**: ohos.permission.NOTIFICATION_CONTROLLER
+
**System API**: This is a system API and cannot be called by third-party applications.
**Parameters**
@@ -405,6 +418,8 @@ Adds multiple notification slots. This API uses an asynchronous callback to retu
**System capability**: SystemCapability.Notification.Notification
+**Required permissions**: ohos.permission.NOTIFICATION_CONTROLLER
+
**System API**: This is a system API and cannot be called by third-party applications.
**Parameters**
@@ -442,6 +457,8 @@ Adds multiple notification slots. This API uses a promise to return the result.
**System capability**: SystemCapability.Notification.Notification
+**Required permissions**: ohos.permission.NOTIFICATION_CONTROLLER
+
**System API**: This is a system API and cannot be called by third-party applications.
**Parameters**
@@ -681,6 +698,8 @@ Subscribes to a notification with the subscription information specified. This A
**System capability**: SystemCapability.Notification.Notification
+**Required permissions**: ohos.permission.NOTIFICATION_CONTROLLER
+
**System API**: This is a system API and cannot be called by third-party applications.
**Parameters**
@@ -720,6 +739,8 @@ Subscribes to a notification with the subscription information specified. This A
**System capability**: SystemCapability.Notification.Notification
+**Required permissions**: ohos.permission.NOTIFICATION_CONTROLLER
+
**System API**: This is a system API and cannot be called by third-party applications.
**Parameters**
@@ -754,6 +775,8 @@ Subscribes to a notification with the subscription information specified. This A
**System capability**: SystemCapability.Notification.Notification
+**Required permissions**: ohos.permission.NOTIFICATION_CONTROLLER
+
**System API**: This is a system API and cannot be called by third-party applications.
**Parameters**
@@ -787,6 +810,8 @@ Unsubscribes from a notification. This API uses an asynchronous callback to retu
**System capability**: SystemCapability.Notification.Notification
+**Required permissions**: ohos.permission.NOTIFICATION_CONTROLLER
+
**System API**: This is a system API and cannot be called by third-party applications.
**Parameters**
@@ -821,6 +846,8 @@ Unsubscribes from a notification. This API uses a promise to return the result.
**System capability**: SystemCapability.Notification.Notification
+**Required permissions**: ohos.permission.NOTIFICATION_CONTROLLER
+
**System API**: This is a system API and cannot be called by third-party applications.
**Parameters**
@@ -853,6 +880,8 @@ Sets whether to enable notification for a specified bundle. This API uses an asy
**System capability**: SystemCapability.Notification.Notification
+**Required permissions**: ohos.permission.NOTIFICATION_CONTROLLER
+
**System API**: This is a system API and cannot be called by third-party applications.
**Parameters**
@@ -885,6 +914,8 @@ Sets whether to enable notification for a specified bundle. This API uses a prom
**System capability**: SystemCapability.Notification.Notification
+**Required permissions**: ohos.permission.NOTIFICATION_CONTROLLER
+
**System API**: This is a system API and cannot be called by third-party applications.
**Parameters**
@@ -917,6 +948,8 @@ Checks whether notification is enabled for a specified bundle. This API uses an
**System API**: This is a system API and cannot be called by third-party applications.
+**Required permissions**: ohos.permission.NOTIFICATION_CONTROLLER
+
**Parameters**
| Name | Readable| Writable| Type | Mandatory| Description |
@@ -946,6 +979,8 @@ Checks whether notification is enabled for a specified bundle. This API uses a p
**System capability**: SystemCapability.Notification.Notification
+**Required permissions**: ohos.permission.NOTIFICATION_CONTROLLER
+
**System API**: This is a system API and cannot be called by third-party applications.
**Parameters**
@@ -981,6 +1016,8 @@ Checks whether notification is enabled for this application. This API uses an as
**System capability**: SystemCapability.Notification.Notification
+**Required permissions**: ohos.permission.NOTIFICATION_CONTROLLER
+
**System API**: This is a system API and cannot be called by third-party applications.
**Parameters**
@@ -1009,6 +1046,8 @@ Checks whether notification is enabled for this application. This API uses a pro
**System capability**: SystemCapability.Notification.Notification
+**Required permissions**: ohos.permission.NOTIFICATION_CONTROLLER
+
**System API**: This is a system API and cannot be called by third-party applications.
**Parameters**
@@ -1041,6 +1080,8 @@ Sets whether to enable the notification badge for a specified bundle. This API u
**System capability**: SystemCapability.Notification.Notification
+**Required permissions**: ohos.permission.NOTIFICATION_CONTROLLER
+
**System API**: This is a system API and cannot be called by third-party applications.
**Parameters**
@@ -1073,6 +1114,8 @@ Sets the notification slot for a specified bundle. This API uses a promise to re
**System capability**: SystemCapability.Notification.Notification
+**Required permissions**: ohos.permission.NOTIFICATION_CONTROLLER
+
**System API**: This is a system API and cannot be called by third-party applications.
**Parameters**
@@ -1103,6 +1146,8 @@ Checks whether the notification badge is enabled for a specified bundle. This AP
**System capability**: SystemCapability.Notification.Notification
+**Required permissions**: ohos.permission.NOTIFICATION_CONTROLLER
+
**System API**: This is a system API and cannot be called by third-party applications.
**Parameters**
@@ -1134,6 +1179,8 @@ Checks whether the notification badge is enabled for a specified bundle. This AP
**System capability**: SystemCapability.Notification.Notification
+**Required permissions**: ohos.permission.NOTIFICATION_CONTROLLER
+
**System API**: This is a system API and cannot be called by third-party applications.
**Parameters**
@@ -1169,6 +1216,8 @@ Sets the notification slot for a specified bundle. This API uses an asynchronous
**System capability**: SystemCapability.Notification.Notification
+**Required permissions**: ohos.permission.NOTIFICATION_CONTROLLER
+
**System API**: This is a system API and cannot be called by third-party applications.
**Parameters**
@@ -1204,6 +1253,8 @@ Sets the notification slot for a specified bundle. This API uses a promise to re
**System capability**: SystemCapability.Notification.Notification
+**Required permissions**: ohos.permission.NOTIFICATION_CONTROLLER
+
**System API**: This is a system API and cannot be called by third-party applications.
**Parameters**
@@ -1237,6 +1288,8 @@ Obtains the notification slots of a specified bundle. This API uses an asynchron
**System capability**: SystemCapability.Notification.Notification
+**Required permissions**: ohos.permission.NOTIFICATION_CONTROLLER
+
**System API**: This is a system API and cannot be called by third-party applications.
**Parameters**
@@ -1268,6 +1321,8 @@ Obtains the notification slots of a specified bundle. This API uses a promise to
**System capability**: SystemCapability.Notification.Notification
+**Required permissions**: ohos.permission.NOTIFICATION_CONTROLLER
+
**System API**: This is a system API and cannot be called by third-party applications.
**Parameters**
@@ -1303,6 +1358,8 @@ Obtains the number of notification slots of a specified bundle. This API uses an
**System capability**: SystemCapability.Notification.Notification
+**Required permissions**: ohos.permission.NOTIFICATION_CONTROLLER
+
**System API**: This is a system API and cannot be called by third-party applications.
**Parameters**
@@ -1334,6 +1391,8 @@ Obtains the number of notification slots of a specified bundle. This API uses a
**System capability**: SystemCapability.Notification.Notification
+**Required permissions**: ohos.permission.NOTIFICATION_CONTROLLER
+
**System API**: This is a system API and cannot be called by third-party applications.
**Parameters**
@@ -1369,6 +1428,8 @@ Removes a notification for a specified bundle. This API uses an asynchronous cal
**System capability**: SystemCapability.Notification.Notification
+**Required permissions**: ohos.permission.NOTIFICATION_CONTROLLER
+
**System API**: This is a system API and cannot be called by third-party applications.
**Parameters**
@@ -1405,6 +1466,8 @@ Removes a notification for a specified bundle. This API uses a promise to return
**System capability**: SystemCapability.Notification.Notification
+**Required permissions**: ohos.permission.NOTIFICATION_CONTROLLER
+
**System API**: This is a system API and cannot be called by third-party applications.
**Parameters**
@@ -1439,6 +1502,8 @@ Removes a notification for a specified bundle. This API uses an asynchronous cal
**System capability**: SystemCapability.Notification.Notification
+**Required permissions**: ohos.permission.NOTIFICATION_CONTROLLER
+
**System API**: This is a system API and cannot be called by third-party applications.
**Parameters**
@@ -1470,6 +1535,8 @@ Removes a notification for a specified bundle. This API uses a promise to return
**System capability**: SystemCapability.Notification.Notification
+**Required permissions**: ohos.permission.NOTIFICATION_CONTROLLER
+
**System API**: This is a system API and cannot be called by third-party applications.
**Parameters**
@@ -1500,6 +1567,8 @@ Removes all notifications for a specified bundle. This API uses an asynchronous
**System API**: This is a system API and cannot be called by third-party applications.
+**Required permissions**: ohos.permission.NOTIFICATION_CONTROLLER
+
**Parameters**
| Name | Readable| Writable| Type | Mandatory| Description |
@@ -1529,6 +1598,8 @@ Removes all notifications. This API uses an asynchronous callback to return the
**System capability**: SystemCapability.Notification.Notification
+**Required permissions**: ohos.permission.NOTIFICATION_CONTROLLER
+
**System API**: This is a system API and cannot be called by third-party applications.
**Parameters**
@@ -1557,6 +1628,8 @@ Removes all notifications for a specified user. This API uses a promise to retur
**System capability**: SystemCapability.Notification.Notification
+**Required permissions**: ohos.permission.NOTIFICATION_CONTROLLER
+
**System API**: This is a system API and cannot be called by third-party applications.
**Parameters**
@@ -1581,6 +1654,8 @@ Removes all notifications for a specified user. This API uses an asynchronous ca
**System capability**: SystemCapability.Notification.Notification
+**Required permissions**: ohos.permission.NOTIFICATION_CONTROLLER
+
**System API**: This is a system API and cannot be called by third-party applications.
**Parameters**
@@ -1610,6 +1685,8 @@ Removes all notifications for a specified user. This API uses a promise to retur
**System capability**: SystemCapability.Notification.Notification
+**Required permissions**: ohos.permission.NOTIFICATION_CONTROLLER
+
**System API**: This is a system API and cannot be called by third-party applications.
**Parameters**
@@ -1639,6 +1716,8 @@ Obtains all active notifications. This API uses an asynchronous callback to retu
**System capability**: SystemCapability.Notification.Notification
+**Required permissions**: ohos.permission.NOTIFICATION_CONTROLLER
+
**System API**: This is a system API and cannot be called by third-party applications.
**Parameters**
@@ -1667,7 +1746,9 @@ Obtains all active notifications. This API uses a promise to return the result.
**System capability**: SystemCapability.Notification.Notification
-**System API**: This is a system API and cannot be called by third-party applications.
+**Required permissions**: ohos.permission.NOTIFICATION_CONTROLLER
+
+**System API**: This is a system API and cannot be called by third-party applications.removeGroupByBundle
**Return value**
@@ -1847,6 +1928,8 @@ Removes a notification group for a specified bundle. This API uses an asynchrono
**System capability**: SystemCapability.Notification.Notification
+**Required permissions**: ohos.permission.NOTIFICATION_CONTROLLER
+
**System API**: This is a system API and cannot be called by third-party applications.
**Parameters**
@@ -1880,6 +1963,8 @@ Removes a notification group for a specified bundle. This API uses a promise to
**System capability**: SystemCapability.Notification.Notification
+**Required permissions**: ohos.permission.NOTIFICATION_CONTROLLER
+
**System API**: This is a system API and cannot be called by third-party applications.
**Parameters**
@@ -1909,6 +1994,8 @@ Sets the DND time. This API uses an asynchronous callback to return the result.
**System capability**: SystemCapability.Notification.Notification
+**Required permissions**: ohos.permission.NOTIFICATION_CONTROLLER
+
**System API**: This is a system API and cannot be called by third-party applications.
**Parameters**
@@ -1944,6 +2031,8 @@ Sets the DND time. This API uses a promise to return the result.
**System capability**: SystemCapability.Notification.Notification
+**Required permissions**: ohos.permission.NOTIFICATION_CONTROLLER
+
**System API**: This is a system API and cannot be called by third-party applications.
**Parameters**
@@ -1974,6 +2063,8 @@ Sets the DND time for a specified user. This API uses an asynchronous callback t
**System capability**: SystemCapability.Notification.Notification
+**Required permissions**: ohos.permission.NOTIFICATION_CONTROLLER
+
**System API**: This is a system API and cannot be called by third-party applications.
**Parameters**
@@ -2012,6 +2103,8 @@ Sets the DND time for a specified user. This API uses a promise to return the re
**System capability**: SystemCapability.Notification.Notification
+**Required permissions**: ohos.permission.NOTIFICATION_CONTROLLER
+
**System API**: This is a system API and cannot be called by third-party applications.
**Parameters**
@@ -2046,6 +2139,8 @@ Obtains the DND time. This API uses an asynchronous callback to return the resul
**System capability**: SystemCapability.Notification.Notification
+**Required permissions**: ohos.permission.NOTIFICATION_CONTROLLER
+
**System API**: This is a system API and cannot be called by third-party applications.
**Parameters**
@@ -2074,6 +2169,8 @@ Obtains the DND time. This API uses a promise to return the result.
**System capability**: SystemCapability.Notification.Notification
+**Required permissions**: ohos.permission.NOTIFICATION_CONTROLLER
+
**System API**: This is a system API and cannot be called by third-party applications.
**Return value**
@@ -2099,6 +2196,10 @@ Obtains the DND time of a specified user. This API uses an asynchronous callback
**System capability**: SystemCapability.Notification.Notification
+**Required permissions**: ohos.permission.NOTIFICATION_CONTROLLER
+
+**System API**: This is a system API and cannot be called by third-party applications.
+
**Parameters**
| Name | Readable| Writable| Type | Mandatory| Description |
@@ -2128,6 +2229,10 @@ Obtains the DND time of a specified user. This API uses a promise to return the
**System capability**: SystemCapability.Notification.Notification
+**Required permissions**: ohos.permission.NOTIFICATION_CONTROLLER
+
+**System API**: This is a system API and cannot be called by third-party applications.
+
**Parameters**
| Name | Readable| Writable| Type | Mandatory| Description |
@@ -2159,6 +2264,8 @@ Checks whether the DND mode is supported. This API uses an asynchronous callback
**System capability**: SystemCapability.Notification.Notification
+**Required permissions**: ohos.permission.NOTIFICATION_CONTROLLER
+
**System API**: This is a system API and cannot be called by third-party applications.
**Parameters**
@@ -2187,6 +2294,8 @@ Checks whether the DND mode is supported. This API uses a promise to return the
**System capability**: SystemCapability.Notification.Notification
+**Required permissions**: ohos.permission.NOTIFICATION_CONTROLLER
+
**System API**: This is a system API and cannot be called by third-party applications.
**Return value**
@@ -2317,6 +2426,8 @@ Sets whether this device supports distributed notifications. This API uses an as
**System capability**: SystemCapability.Notification.Notification
+**Required permissions**: ohos.permission.NOTIFICATION_CONTROLLER
+
**System API**: This is a system API and cannot be called by third-party applications.
**Parameters**
@@ -2348,6 +2459,8 @@ Sets whether this device supports distributed notifications. This API uses a pro
**System capability**: SystemCapability.Notification.Notification
+**Required permissions**: ohos.permission.NOTIFICATION_CONTROLLER
+
**System API**: This is a system API and cannot be called by third-party applications.
**Parameters**
@@ -2426,6 +2539,8 @@ Sets whether an application supports distributed notifications based on the bund
**System capability**: SystemCapability.Notification.Notification
+**Required permissions**: ohos.permission.NOTIFICATION_CONTROLLER
+
**System API**: This is a system API and cannot be called by third-party applications.
**Parameters**
@@ -2456,12 +2571,14 @@ Notification.enableDistributedByBundle(bundle, enable, enableDistributedByBundle
## Notification.enableDistributedByBundle8+
-bundleenableDistributedByBundle(bundle: BundleOption, enable: boolean): Promise\
+enableDistributedByBundle(bundle: BundleOption, enable: boolean): Promise\
Sets whether an application supports distributed notifications based on the bundle. This API uses a promise to return the result.
**System capability**: SystemCapability.Notification.Notification
+**Required permissions**: ohos.permission.NOTIFICATION_CONTROLLER
+
**System API**: This is a system API and cannot be called by third-party applications.
**Parameters**
@@ -2494,6 +2611,8 @@ Obtains whether an application supports distributed notifications based on the b
**System capability**: SystemCapability.Notification.Notification
+**Required permissions**: ohos.permission.NOTIFICATION_CONTROLLER
+
**System API**: This is a system API and cannot be called by third-party applications.
**Parameters**
@@ -2527,6 +2646,8 @@ Obtains whether an application supports distributed notifications based on the b
**System capability**: SystemCapability.Notification.Notification
+**Required permissions**: ohos.permission.NOTIFICATION_CONTROLLER
+
**System API**: This is a system API and cannot be called by third-party applications.
**Parameters**
@@ -2563,6 +2684,8 @@ Obtains the notification reminder type. This API uses an asynchronous callback t
**System capability**: SystemCapability.Notification.Notification
+**Required permissions**: ohos.permission.NOTIFICATION_CONTROLLER
+
**System API**: This is a system API and cannot be called by third-party applications.
**Parameters**
@@ -2591,6 +2714,8 @@ Obtains the notification reminder type. This API uses a promise to return the re
**System capability**: SystemCapability.Notification.Notification
+**Required permissions**: ohos.permission.NOTIFICATION_CONTROLLER
+
**System API**: This is a system API and cannot be called by third-party applications.
**Return value**
@@ -2608,6 +2733,7 @@ Notification.getDeviceRemindType()
});
```
+
## Notification.publishAsBundle9+
publishAsBundle(request: NotificationRequest, representativeBundle: string, userId: number, callback: AsyncCallback\): void
@@ -2616,14 +2742,15 @@ Publishes an agent-powered notification. This API uses an asynchronous callback
**System capability**: SystemCapability.Notification.Notification
+**Required permissions**: ohos.permission.NOTIFICATION_CONTROLLER, ohos.permission.NOTIFICATION_AGENT_CONTROLLER
+
**System API**: This is a system API and cannot be called by third-party applications.
**Parameters**
-
| Name | Type | Mandatory| Description |
| -------------------- | ------------------------------------------- | ---- | --------------------------------------------- |
-| request | [NotificationRequest](#notificationrequest) | Yes | Notification to publish.|
+| request | [NotificationRequest](#notificationrequest) | Yes | **NotificationRequest** object.|
| representativeBundle | string | Yes | Bundle name of the application whose notification function is taken over by the reminder agent. |
| userId | number | Yes | ID of the user who receives the notification. |
| callback | AsyncCallback | Yes | Callback used to return the result. |
@@ -2663,6 +2790,8 @@ Publishes a notification through the reminder agent. This API uses a promise to
**System capability**: SystemCapability.Notification.Notification
+**Required permissions**: ohos.permission.NOTIFICATION_CONTROLLER, ohos.permission.NOTIFICATION_AGENT_CONTROLLER
+
**System API**: This is a system API and cannot be called by third-party applications.
**Parameters**
@@ -2670,7 +2799,7 @@ Publishes a notification through the reminder agent. This API uses a promise to
| Name | Type | Mandatory| Description |
| -------------------- | ------------------------------------------- | ---- | --------------------------------------------- |
-| request | [NotificationRequest](#notificationrequest) | Yes | Notification to publish.|
+| request | [NotificationRequest](#notificationrequest) | Yes | **NotificationRequest** object.|
| representativeBundle | string | Yes | Bundle name of the application whose notification function is taken over by the reminder agent. |
| userId | number | Yes | ID of the user who receives the notification. |
@@ -2707,6 +2836,8 @@ Cancels a notification published by the reminder agent. This API uses an asynchr
**System capability**: SystemCapability.Notification.Notification
+**Required permissions**: ohos.permission.NOTIFICATION_CONTROLLER, ohos.permission.NOTIFICATION_AGENT_CONTROLLER
+
**Parameters**
@@ -2740,6 +2871,8 @@ Publishes a notification through the reminder agent. This API uses a promise to
**System capability**: SystemCapability.Notification.Notification
+**Required permissions**: ohos.permission.NOTIFICATION_CONTROLLER, ohos.permission.NOTIFICATION_AGENT_CONTROLLER
+
**Parameters**
@@ -2762,9 +2895,9 @@ Notification.cancelAsBundle(0, representativeBundle, userId).then(() => {
});
```
-## Notification.enableNotificationSlot9+
+## Notification.enableNotificationSlot 9+
-enableNotificationSlot(bundle: BundleOption, type: SlotType, enable: boolean, callback: AsyncCallback): void
+enableNotificationSlot(bundle: BundleOption, type: SlotType, enable: boolean, callback: AsyncCallback\): void
Sets the enabled status for a notification slot of a specified type. This API uses an asynchronous callback to return the result.
@@ -2772,6 +2905,8 @@ Sets the enabled status for a notification slot of a specified type. This API us
**System API**: This is a system API and cannot be called by third-party applications.
+**Required permissions**: ohos.permission.NOTIFICATION_CONTROLLER
+
**Parameters**
| Name | Type | Mandatory| Description |
@@ -2791,14 +2926,14 @@ function enableSlotCallback(err) {
Notification.enableNotificationSlot(
{ bundle: "ohos.samples.notification", },
- notify.SlotType.SOCIAL_COMMUNICATION,
+ Notification.SlotType.SOCIAL_COMMUNICATION,
true,
enableSlotCallback);
```
-## Notification.enableNotificationSlot9+
+## Notification.enableNotificationSlot 9+
-enableNotificationSlot(bundle: BundleOption, type: SlotType, enable: boolean): Promise
+enableNotificationSlot(bundle: BundleOption, type: SlotType, enable: boolean): Promise\
Sets the enabled status for a notification slot of a specified type. This API uses a promise to return the result.
@@ -2806,6 +2941,8 @@ Sets the enabled status for a notification slot of a specified type. This API us
**System API**: This is a system API and cannot be called by third-party applications.
+**Required permissions**: ohos.permission.NOTIFICATION_CONTROLLER
+
**Parameters**
| Name| Type | Mandatory| Description |
@@ -2820,29 +2957,31 @@ Sets the enabled status for a notification slot of a specified type. This API us
//enableNotificationSlot
Notification.enableNotificationSlot(
{ bundle: "ohos.samples.notification", },
- notify.SlotType.SOCIAL_COMMUNICATION,
+ Notification.SlotType.SOCIAL_COMMUNICATION,
true).then(() => {
console.log('====================>enableNotificationSlot====================>');
});
```
-## Notification.isNotificationSlotEnabled9+
+## Notification.isNotificationSlotEnabled 9+
-isNotificationSlotEnabled(bundle: BundleOption, type: SlotType, callback: AsyncCallback): void
+isNotificationSlotEnabled(bundle: BundleOption, type: SlotType, callback: AsyncCallback\): void
-Obtains the enabled status of a notification slot of a specified type. This API uses an asynchronous callback to return the result.
+Obtains the enabled status of the notification slot of a specified type. This API uses an asynchronous callback to return the result.
**System capability**: SystemCapability.Notification.Notification
**System API**: This is a system API and cannot be called by third-party applications.
+**Required permissions**: ohos.permission.NOTIFICATION_CONTROLLER
+
**Parameters**
| Name | Type | Mandatory| Description |
| -------- | ----------------------------- | ---- | ---------------------- |
| bundle | [BundleOption](#bundleoption) | Yes | Bundle information. |
| type | [SlotType](#slottype) | Yes | Notification slot type. |
-| callback | AsyncCallback\ | Yes | Callback used to return the result.|
+| callback | AsyncCallback\ | Yes | Callback used to return the result.|
**Example**
@@ -2854,20 +2993,22 @@ function getEnableSlotCallback(err, data) {
Notification.isNotificationSlotEnabled(
{ bundle: "ohos.samples.notification", },
- notify.SlotType.SOCIAL_COMMUNICATION,
+ Notification.SlotType.SOCIAL_COMMUNICATION,
getEnableSlotCallback);
```
-## Notification.isNotificationSlotEnabled9+
+## Notification.isNotificationSlotEnabled 9+
-isNotificationSlotEnabled(bundle: BundleOption, type: SlotType): Promise
+isNotificationSlotEnabled(bundle: BundleOption, type: SlotType): Promise\
-Obtains the enabled status of a notification slot of a specified type. This API uses a promise to return the result.
+Obtains the enabled status of the notification slot of a specified type. This API uses a promise to return the result.
**System capability**: SystemCapability.Notification.Notification
**System API**: This is a system API and cannot be called by third-party applications.
+**Required permissions**: ohos.permission.NOTIFICATION_CONTROLLER
+
**Parameters**
| Name| Type | Mandatory| Description |
@@ -2875,30 +3016,180 @@ Obtains the enabled status of a notification slot of a specified type. This API
| bundle | [BundleOption](#bundleoption) | Yes | Bundle information. |
| type | [SlotType](#slottype) | Yes | Notification slot type.|
+**Return value**
+
+| Type | Description |
+| ----------------------------------------------------------- | ------------------------------------------------------------ |
+| Promise\ | Promise used to return the enabled status of the notification slot of the specified type.|
+
**Example**
```js
//isNotificationSlotEnabled
Notification.isNotificationSlotEnabled(
{ bundle: "ohos.samples.notification", },
- notify.SlotType.SOCIAL_COMMUNICATION,
- true).then((data) => {
+ Notification.SlotType.SOCIAL_COMMUNICATION
+ ).then((data) => {
console.log('====================>isNotificationSlotEnabled====================>');
});
```
+
+## Notification.setSyncNotificationEnabledForUninstallApp9+
+
+setSyncNotificationEnabledForUninstallApp(userId: number, enable: boolean, callback: AsyncCallback\): void
+
+Sets whether to sync notifications to devices where the application is not installed. This API uses an asynchronous callback to return the result.
+
+**System capability**: SystemCapability.Notification.Notification
+
+**System API**: This is a system API and cannot be called by third-party applications.
+
+**Required permissions**: ohos.permission.NOTIFICATION_CONTROLLER
+
+**Parameters**
+
+| Name| Type | Mandatory| Description |
+| ------ | ----------------------------- | ---- | -------------- |
+| userId | number | Yes | User ID. |
+| enable | boolean | Yes | Whether to sync notifications to devices where the application is not installed. The value **true** means to sync notifications to devices where the application is not installed, and **false** means the opposite.|
+| callback | AsyncCallback\ | Yes | Callback used to return the result.|
+
+**Example**
+
+```js
+let userId = 100;
+let enable = true;
+
+function setSyncNotificationEnabledForUninstallAppCallback(err) {
+ console.log('setSyncNotificationEnabledForUninstallAppCallback');
+}
+
+Notification.setSyncNotificationEnabledForUninstallApp(userId, enable, setSyncNotificationEnabledForUninstallAppCallback);
+```
+
+
+## Notification.setSyncNotificationEnabledForUninstallApp9+
+
+setSyncNotificationEnabledForUninstallApp(userId: number, enable: boolean): Promise\
+
+Sets whether to sync notifications to devices where the application is not installed. This API uses a promise to return the result.
+
+**System capability**: SystemCapability.Notification.Notification
+
+**System API**: This is a system API and cannot be called by third-party applications.
+
+**Required permissions**: ohos.permission.NOTIFICATION_CONTROLLER
+
+**Parameters**
+
+| Name| Type | Mandatory| Description |
+| ------ | ----------------------------- | ---- | -------------- |
+| userId | number | Yes | User ID. |
+| enable | boolean | Yes | Whether to sync notifications to devices where the application is not installed. The value **true** means to sync notifications to devices where the application is not installed, and **false** means the opposite.|
+
+**Example**
+
+```js
+let userId = 100;
+let enable = true;
+
+Notification.setSyncNotificationEnabledForUninstallApp(userId, enable)
+ .then((data) => {
+ console.log('setSyncNotificationEnabledForUninstallApp, data:', data);
+ })
+ .catch((err) => {
+ console.log('setSyncNotificationEnabledForUninstallApp, err:', err);
+ });
+```
+
+
+## Notification.getSyncNotificationEnabledForUninstallApp9+
+
+getSyncNotificationEnabledForUninstallApp(userId: number, callback: AsyncCallback\): void
+
+Checks whether notifications are synced to devices where the application is not installed. This API uses an asynchronous callback to return the result.
+
+**System capability**: SystemCapability.Notification.Notification
+
+**System API**: This is a system API and cannot be called by third-party applications.
+
+**Required permissions**: ohos.permission.NOTIFICATION_CONTROLLER
+
+**Parameters**
+
+| Name| Type | Mandatory| Description |
+| ------ | ----------------------------- | ---- | -------------- |
+| userId | number | Yes | User ID. |
+| callback | AsyncCallback\ | Yes | Callback used to return the result. The value **true** means that notifications are synced to devices where the application is not installed, and **false** means the opposite.|
+
+**Example**
+
+```js
+let userId = 100;
+
+function getSyncNotificationEnabledForUninstallAppCallback(err, data) {
+ console.log('getSyncNotificationEnabledForUninstallAppCallback, data: ', data);
+}
+
+Notification.getSyncNotificationEnabledForUninstallApp(userId, getSyncNotificationEnabledForUninstallAppCallback);
+```
+
+
+## Notification.getSyncNotificationEnabledForUninstallApp9+
+
+getSyncNotificationEnabledForUninstallApp(userId: number): Promise\
+
+Checks whether notifications are synced to devices where the application is not installed. This API uses a promise to return the result.
+
+**System capability**: SystemCapability.Notification.Notification
+
+**System API**: This is a system API and cannot be called by third-party applications.
+
+**Required permissions**: ohos.permission.NOTIFICATION_CONTROLLER
+
+**Parameters**
+
+| Name| Type | Mandatory| Description |
+| ------ | ----------------------------- | ---- | -------------- |
+| userId | number | Yes | User ID. |
+
+**Return value**
+
+| Type | Description |
+| ----------------------------------------------------------- | ------------------------------------------------------------ |
+| Promise\ | Promise used to return the result. The value **true** means that notifications are synced to devices where the application is not installed, and **false** means the opposite.|
+
+**Example**
+
+```js
+let userId = 100;
+
+Notification.getSyncNotificationEnabledForUninstallApp(userId)
+ .then((data) => {
+ console.log('getSyncNotificationEnabledForUninstallApp, data: ', data);
+ })
+ .catch((err) => {
+ console.log('getSyncNotificationEnabledForUninstallApp, err: ', err);
+ });
+```
+
+
+
## NotificationSubscriber
**System API**: This is a system API and cannot be called by third-party applications.
### onConsume
-onConsume?:(data: [SubscribeCallbackData](#subscribecallbackdata))
+onConsume?: (data: [SubscribeCallbackData](#subscribecallbackdata)) => void
Callback for receiving notifications.
**System capability**: SystemCapability.Notification.Notification
+**System API**: This is a system API and cannot be called by third-party applications.
+
**Parameters**
| Name| Type| Mandatory| Description|
@@ -2940,12 +3231,14 @@ Notification.subscribe(subscriber, subscribeCallback);
### onCancel
-onCancel?:(data: [SubscribeCallbackData](#subscribecallbackdata))
+onCancel?:(data: [SubscribeCallbackData](#subscribecallbackdata)) => void
Callback for removing notifications.
**System capability**: SystemCapability.Notification.Notification
+**System API**: This is a system API and cannot be called by third-party applications.
+
**Parameters**
| Name| Type| Mandatory| Description|
@@ -2978,12 +3271,14 @@ Notification.subscribe(subscriber, subscribeCallback);
### onUpdate
-onUpdate?:(data: [NotificationSortingMap](#notificationsortingmap))
+onUpdate?:(data: [NotificationSortingMap](#notificationsortingmap)) => void
Callback for notification sorting updates.
**System capability**: SystemCapability.Notification.Notification
+**System API**: This is a system API and cannot be called by third-party applications.
+
**Parameters**
| Name| Type| Mandatory| Description|
@@ -3014,12 +3309,14 @@ Notification.subscribe(subscriber, subscribeCallback);
### onConnect
-onConnect?:void
+onConnect?:() => void
Callback for subscription.
**System capability**: SystemCapability.Notification.Notification
+**System API**: This is a system API and cannot be called by third-party applications.
+
**Example**
```javascript
@@ -3044,12 +3341,14 @@ Notification.subscribe(subscriber, subscribeCallback);
### onDisconnect
-onDisconnect?:void
+onDisconnect?:() => void
Callback for unsubscription.
**System capability**: SystemCapability.Notification.Notification
+**System API**: This is a system API and cannot be called by third-party applications.
+
**Example**
```javascript
@@ -3074,12 +3373,14 @@ Notification.subscribe(subscriber, subscribeCallback);
### onDestroy
-onDestroy?:void
+onDestroy?:() => void
Callback for service disconnection.
**System capability**: SystemCapability.Notification.Notification
+**System API**: This is a system API and cannot be called by third-party applications.
+
**Example**
```javascript
@@ -3104,17 +3405,19 @@ Notification.subscribe(subscriber, subscribeCallback);
### onDoNotDisturbDateChange8+
-onDoNotDisturbDateChange?:(mode: Notification.[DoNotDisturbDate](#donotdisturbdate8))
+onDoNotDisturbDateChange?:(mode: notification.[DoNotDisturbDate](#donotdisturbdate8)) => void
Callback for DND time setting updates.
**System capability**: SystemCapability.Notification.Notification
+**System API**: This is a system API and cannot be called by third-party applications.
+
**Parameters**
| Name| Type| Mandatory| Description|
| ------------ | ------------------------ | ---- | -------------------------- |
-| mode | Notification.[DoNotDisturbDate](#donotdisturbdate8) | Yes| DND time setting updates.|
+| mode | notification.[DoNotDisturbDate](#donotdisturbdate8) | Yes| DND time setting updates.|
**Example**
```javascript
@@ -3140,12 +3443,14 @@ Notification.subscribe(subscriber, subscribeCallback);
### onEnabledNotificationChanged8+
-onEnabledNotificationChanged?:(callbackData: [EnabledNotificationCallbackData](#enablednotificationcallbackdata8))
+onEnabledNotificationChanged?:(callbackData: [EnabledNotificationCallbackData](#enablednotificationcallbackdata8)) => void
Listens for the notification enable status changes. This API uses an asynchronous callback to return the result.
**System capability**: SystemCapability.Notification.Notification
+**System API**: This is a system API and cannot be called by third-party applications.
+
**Parameters**
| Name| Type| Mandatory| Description|
@@ -3201,7 +3506,7 @@ Notification.subscribe(subscriber, subscribeCallback);
| ------ | ---- | --- | ------- | ---- | ---------------- |
| bundle | Yes | No | string | Yes | Bundle name of the application. |
| uid | Yes | No | number | Yes | UID of the application. |
-| enable | Yes | No | boolean | Yes | Notification enable status of the application.|
+| enable | Yes | No | boolean | Yes | Notification enabled status of the application.|
## DoNotDisturbDate8+
@@ -3300,7 +3605,7 @@ Notification.subscribe(subscriber, subscribeCallback);
| title | Yes | Yes | string | Yes | Button title. |
| wantAgent | Yes | Yes | WantAgent | Yes | **WantAgent** of the button.|
| extras | Yes | Yes | { [key: string]: any } | No | Extra information of the button. |
-| userInput9+ | Yes | Yes | [NotificationUserInput](#notificationuserinput8) | No | User input object. |
+| userInput8+ | Yes | Yes | [NotificationUserInput](#notificationuserinput8) | No | User input object. |
## NotificationBasicContent
@@ -3425,14 +3730,16 @@ Notification.subscribe(subscriber, subscribeCallback);
| creatorPid | Yes | No | number | No | PID used for creating the notification. |
| creatorUserId8+| Yes | No | number | No | ID of the user who creates the notification. |
| hashCode | Yes | No | string | No | Unique ID of the notification. |
-| classification | Yes | Yes | string | No | Notification category. |
+| classification | Yes | Yes | string | No | Notification category. **System API**: This is a system API and cannot be called by third-party applications. |
| groupName8+| Yes | Yes | string | No | Group notification name. |
| template8+ | Yes | Yes | [NotificationTemplate](#notificationtemplate8) | No | Notification template. |
-| isRemoveAllowed8+ | Yes | No | boolean | No | Whether the notification can be removed. |
-| source8+ | Yes | No | number | No | Notification source. |
+| isRemoveAllowed8+ | Yes | No | boolean | No | Whether the notification can be removed. **System API**: This is a system API and cannot be called by third-party applications. |
+| source8+ | Yes | No | number | No | Notification source. **System API**: This is a system API and cannot be called by third-party applications. |
| distributedOption8+ | Yes | Yes | [DistributedOptions](#distributedoptions8) | No | Option of distributed notification. |
-| deviceId8+ | Yes | No | string | No | Device ID of the notification source. |
+| deviceId8+ | Yes | No | string | No | Device ID of the notification source. **System API**: This is a system API and cannot be called by third-party applications. |
| notificationFlags8+ | Yes | No | [NotificationFlags](#notificationflags8) | No | Notification flags. |
+| removalWantAgent9+ | Yes | Yes | WantAgent | No | **WantAgent** instance to which the notification will be redirected when it is removed. |
+| badgeNumber9+ | Yes | Yes | number | No | Number of notifications displayed on the application icon. |
## DistributedOptions8+
@@ -3444,7 +3751,7 @@ Notification.subscribe(subscriber, subscribeCallback);
| isDistributed | Yes | Yes | boolean | No | Whether the notification is a distributed notification. |
| supportDisplayDevices | Yes | Yes | Array\ | Yes | Types of the devices to which the notification can be synchronized. |
| supportOperateDevices | Yes | Yes | Array\ | No | Devices on which notification can be enabled. |
-| remindType | Yes | No | number | No | Notification reminder type. |
+| remindType | Yes | No | number | No | Notification reminder type. **System API**: This is a system API and cannot be called by third-party applications. |
## NotificationSlot
@@ -3535,3 +3842,16 @@ Notification.subscribe(subscriber, subscribeCallback);
| IDLE_REMIND | 1 | The device is not in use. |
| ACTIVE_DONOT_REMIND | 2 | The device is in use. No notification is required. |
| ACTIVE_REMIND | 3 | The device is in use. |
+
+
+## SourceType8+
+
+**System capability**: SystemCapability.Notification.Notification
+
+**System API**: This is a system API and cannot be called by third-party applications.
+
+| Name | Value | Description |
+| -------------------- | --- | -------------------- |
+| TYPE_NORMAL | 0 | Normal notification. |
+| TYPE_CONTINUOUS | 1 | Continuous notification. |
+| TYPE_TIMER | 2 | Timed notification. |
diff --git a/en/application-dev/reference/apis/js-apis-request.md b/en/application-dev/reference/apis/js-apis-request.md
index 50c50f574bbcad706077725e3b4c6f69f3334b1c..1142a8bfae09c8dc3fb65868a8e71dafd260236c 100644
--- a/en/application-dev/reference/apis/js-apis-request.md
+++ b/en/application-dev/reference/apis/js-apis-request.md
@@ -17,9 +17,9 @@ import request from '@ohos.request';
## Constraints
-HTTPS is supported by default. To support HTTP, you need to add **network** to the **config.json** file and set the **cleartextTraffic** attribute to **true**.
+HTTPS is supported by default in the FA model. To support HTTP, add **network** to the **config.json** file and set the **cleartextTraffic** attribute to **true**.
-```
+```js
var config = {
"deviceConfig": {
"default": {
@@ -32,6 +32,9 @@ var config = {
}
```
+The **cleartextTraffic** attribute is not involved during the development of applications in the stage model.
+
+
## Constants
@@ -39,28 +42,28 @@ var config = {
**System capability**: SystemCapability.MiscServices.Download
-| Name | Type | Readable | Writable | Description |
+| Name| Type| Readable| Writable| Description|
| -------- | -------- | -------- | -------- | -------- |
-| NETWORK_MOBILE | number | Yes | No | Whether download is allowed when the cellular network is used. |
-| NETWORK_WIFI | number | Yes | No | Whether download is allowed on a WLAN. |
-| ERROR_CANNOT_RESUME7+ | number | Yes | No | Failure to resume the download due to an error. |
-| ERROR_DEVICE_NOT_FOUND7+ | number | Yes | No | Failure to find a storage device such as a memory card. |
-| ERROR_FILE_ALREADY_EXISTS7+ | number | Yes | No | Failure to download the file because it already exists. |
-| ERROR_FILE_ERROR7+ | number | Yes | No | File operation failure. |
-| ERROR_HTTP_DATA_ERROR7+ | number | Yes | No | HTTP transmission failure. |
-| ERROR_INSUFFICIENT_SPACE7+ | number | Yes | No | Insufficient storage space. |
-| ERROR_TOO_MANY_REDIRECTS7+ | number | Yes | No | Error caused by too many network redirections. |
-| ERROR_UNHANDLED_HTTP_CODE7+ | number | Yes | No | Unidentified HTTP code. |
-| ERROR_UNKNOWN7+ | number | Yes | No | Unknown error. |
-| PAUSED_QUEUED_FOR_WIFI7+ | number | Yes | No | Download paused and queuing for a WLAN connection, because the file size exceeds the maximum value allowed by a cellular network session. |
-| PAUSED_UNKNOWN7+ | number | Yes | No | Download paused due to unknown reasons. |
-| PAUSED_WAITING_FOR_NETWORK7+ | number | Yes | No | Download paused due to a network connection problem, for example, network disconnection. |
-| PAUSED_WAITING_TO_RETRY7+ | number | Yes | No | Download paused and then retried. |
-| SESSION_FAILED7+ | number | Yes | No | Download failure without retry. |
-| SESSION_PAUSED7+ | number | Yes | No | Download paused. |
-| SESSION_PENDING7+ | number | Yes | No | Download pending. |
-| SESSION_RUNNING7+ | number | Yes | No | Download in progress. |
-| SESSION_SUCCESSFUL7+ | number | Yes | No | Successful download. |
+| NETWORK_MOBILE | number | Yes| No| Whether download is allowed on a mobile network.|
+| NETWORK_WIFI | number | Yes| No| Whether download is allowed on a WLAN.|
+| ERROR_CANNOT_RESUME7+ | number | Yes| No| Failure to resume the download due to an error.|
+| ERROR_DEVICE_NOT_FOUND7+ | number | Yes| No| Failure to find a storage device such as a memory card.|
+| ERROR_FILE_ALREADY_EXISTS7+ | number | Yes| No| Failure to download the file because it already exists.|
+| ERROR_FILE_ERROR7+ | number | Yes| No| File operation failure.|
+| ERROR_HTTP_DATA_ERROR7+ | number | Yes| No| HTTP transmission failure.|
+| ERROR_INSUFFICIENT_SPACE7+ | number | Yes| No| Insufficient storage space.|
+| ERROR_TOO_MANY_REDIRECTS7+ | number | Yes| No| Error caused by too many network redirections.|
+| ERROR_UNHANDLED_HTTP_CODE7+ | number | Yes| No| Unidentified HTTP code.|
+| ERROR_UNKNOWN7+ | number | Yes| No| Unknown error.|
+| PAUSED_QUEUED_FOR_WIFI7+ | number | Yes| No| Download paused and queuing for a WLAN connection, because the file size exceeds the maximum value allowed by a mobile network session.|
+| PAUSED_UNKNOWN7+ | number | Yes| No| Download paused due to unknown reasons.|
+| PAUSED_WAITING_FOR_NETWORK7+ | number | Yes| No| Download paused due to a network connection problem, for example, network disconnection.|
+| PAUSED_WAITING_TO_RETRY7+ | number | Yes| No| Download paused and then retried.|
+| SESSION_FAILED7+ | number | Yes| No| Download failure without retry.|
+| SESSION_PAUSED7+ | number | Yes| No| Download paused.|
+| SESSION_PENDING7+ | number | Yes| No| Download pending.|
+| SESSION_RUNNING7+ | number | Yes| No| Download in progress.|
+| SESSION_SUCCESSFUL7+ | number | Yes| No| Successful download.|
## request.upload
@@ -69,30 +72,36 @@ upload(config: UploadConfig): Promise<UploadTask>
Uploads files. This API uses a promise to return the result.
+This API can be used only in the FA model.
+
**Required permissions**: ohos.permission.INTERNET
**System capability**: SystemCapability.MiscServices.Upload
**Parameters**
-| Name | Type | Mandatory | Description |
+| Name| Type| Mandatory| Description|
| -------- | -------- | -------- | -------- |
-| config | [UploadConfig](#uploadconfig) | Yes | Configurations of the upload. |
+| config | [UploadConfig](#uploadconfig) | Yes| Upload configurations.|
**Return value**
-| Type | Description |
+| Type| Description|
| -------- | -------- |
-| Promise<[UploadTask](#uploadtask)> | Promise used to return the **UploadTask** object. |
+| Promise<[UploadTask](#uploadtask)> | Promise used to return the **UploadTask** object.|
**Example**
```js
- let file1 = { filename: "test", name: "test", uri: "internal://cache/test.jpg", type: "jpg" };
- let data = { name: "name123", value: "123" };
- let header = { key1: "value1", key2: "value2" };
let uploadTask;
- request.upload({ url: 'https://patch', header: header, method: "POST", files: [file1], data: [data] }).then((data) => {
+ let uploadConfig = {
+ url: 'https://patch',
+ header: { key1: "value1", key2: "value2" },
+ method: "POST",
+ files: [{ filename: "test", name: "test", uri: "internal://cache/test.jpg", type: "jpg" }],
+ data: [{ name: "name123", value: "123" }],
+ };
+ request.upload(uploadConfig).then((data) => {
uploadTask = data;
}).catch((err) => {
console.error('Failed to request the upload. Cause: ' + JSON.stringify(err));
@@ -106,25 +115,31 @@ upload(config: UploadConfig, callback: AsyncCallback<UploadTask>): void
Uploads files. This API uses an asynchronous callback to return the result.
+This API can be used only in the FA model.
+
**Required permissions**: ohos.permission.INTERNET
**System capability**: SystemCapability.MiscServices.Upload
**Parameters**
-| Name | Type | Mandatory | Description |
+| Name| Type| Mandatory| Description|
| -------- | -------- | -------- | -------- |
-| config | [UploadConfig](#uploadconfig) | Yes | Configurations of the upload. |
-| callback | AsyncCallback<[UploadTask](#uploadtask)> | No | Callback used to return the **UploadTask** object. |
+| config | [UploadConfig](#uploadconfig) | Yes| Upload configurations.|
+| callback | AsyncCallback<[UploadTask](#uploadtask)> | No| Callback used to return the **UploadTask** object.|
**Example**
```js
- let file1 = { filename: "test", name: "test", uri: "internal://cache/test.jpg", type: "jpg" };
- let data = { name: "name123", value: "123" };
- let header = { key1: "value1", key2: "value2" };
let uploadTask;
- request.upload({ url: 'https://patch', header: header, method: "POST", files: [file1], data: [data] }, (err, data) => {
+ let uploadConfig = {
+ url: 'https://patch',
+ header: { key1: "value1", key2: "value2" },
+ method: "POST",
+ files: [{ filename: "test", name: "test", uri: "internal://cache/test.jpg", type: "jpg" }],
+ data: [{ name: "name123", value: "123" }],
+ };
+ request.upload(uploadConfig, (err, data) => {
if (err) {
console.error('Failed to request the upload. Cause: ' + JSON.stringify(err));
return;
@@ -132,7 +147,86 @@ Uploads files. This API uses an asynchronous callback to return the result.
uploadTask = data;
});
```
+## request.upload9+
+
+upload(context: BaseContext, config: UploadConfig): Promise<UploadTask>
+
+Uploads files. This API uses a promise to return the result.
+
+**Required permissions**: ohos.permission.INTERNET
+
+**System capability**: SystemCapability.MiscServices.Upload
+
+**Parameters**
+
+| Name| Type| Mandatory| Description|
+| -------- | -------- | -------- | -------- |
+| context | BaseContext | Yes| Application-based context.|
+| config | [UploadConfig](#uploadconfig) | Yes| Upload configurations.|
+
+
+**Return value**
+
+| Type| Description|
+| -------- | -------- |
+| Promise<[UploadTask](#uploadtask)> | Promise used to return the **UploadTask** object.|
+
+**Example**
+
+ ```js
+ let uploadTask;
+ let uploadConfig = {
+ url: 'https://patch',
+ header: { key1: "value1", key2: "value2" },
+ method: "POST",
+ files: { filename: "test", name: "test", uri: "internal://cache/test.jpg", type: "jpg" },
+ data: { name: "name123", value: "123" },
+ };
+ request.upload(globalThis.abilityContext, uploadConfig).then((data) => {
+ uploadTask = data;
+ }).catch((err) => {
+ console.error('Failed to request the upload. Cause: ' + JSON.stringify(err));
+ });
+ ```
+
+
+## request.upload9+
+
+upload(context: BaseContext, config: UploadConfig, callback: AsyncCallback<UploadTask>): void
+
+Uploads files. This API uses an asynchronous callback to return the result.
+
+**Required permissions**: ohos.permission.INTERNET
+**System capability**: SystemCapability.MiscServices.Upload
+
+**Parameters**
+
+| Name| Type| Mandatory| Description|
+| -------- | -------- | -------- | -------- |
+| context | BaseContext | Yes| Application-based context.|
+| config | [UploadConfig](#uploadconfig) | Yes| Upload configurations.|
+| callback | AsyncCallback<[UploadTask](#uploadtask)> | No| Callback used to return the **UploadTask** object.|
+
+**Example**
+
+ ```js
+ let uploadTask;
+ let uploadConfig = {
+ url: 'https://patch',
+ header: { key1: "value1", key2: "value2" },
+ method: "POST",
+ files: [{ filename: "test", name: "test", uri: "internal://cache/test.jpg", type: "jpg" }],
+ data: [{ name: "name123", value: "123" }],
+ };
+ request.upload(globalThis.abilityContext, uploadConfig, (err, data) => {
+ if (err) {
+ console.error('Failed to request the upload. Cause: ' + JSON.stringify(err));
+ return;
+ }
+ uploadTask = data;
+ });
+ ```
## UploadTask
@@ -143,7 +237,7 @@ Implements file uploads. Before using any APIs of this class, you must obtain an
on(type: 'progress', callback:(uploadedSize: number, totalSize: number) => void): void
-Subscribes to the upload progress event. This API uses an asynchronous callback to return the result.
+Subscribes to an upload event. This API uses an asynchronous callback to return the result.
**Required permissions**: ohos.permission.INTERNET
@@ -151,17 +245,17 @@ Subscribes to the upload progress event. This API uses an asynchronous callback
**Parameters**
-| Name | Type | Mandatory | Description |
+| Name| Type| Mandatory| Description|
| -------- | -------- | -------- | -------- |
-| type | string | Yes | Type of the event to subscribe to. The value is **progress** (upload progress). |
-| callback | function | Yes | Callback for the upload progress event. |
+| type | string | Yes| Type of the event to subscribe to. The value is **'progress'** (upload progress).|
+| callback | function | Yes| Callback for the upload progress event.|
-**callback** parameters
+Parameters of the callback function
-| Name | Type | Mandatory | Description |
+| Name| Type| Mandatory| Description|
| -------- | -------- | -------- | -------- |
-| uploadedSize | number | Yes | Size of the uploaded files, in KB. |
-| totalSize | number | Yes | Total size of the files to upload, in KB. |
+| uploadedSize | number | Yes| Size of the uploaded files, in KB.|
+| totalSize | number | Yes| Total size of the files to upload, in KB.|
**Example**
@@ -177,7 +271,7 @@ Subscribes to the upload progress event. This API uses an asynchronous callback
on(type: 'headerReceive', callback: (header: object) => void): void
-Subscribes to the **headerReceive** event, which is triggered when an HTTP response header is received. This API uses an asynchronous callback to return the result.
+Subscribes to an upload event. This API uses an asynchronous callback to return the result.
**Required permissions**: ohos.permission.INTERNET
@@ -185,16 +279,16 @@ Subscribes to the **headerReceive** event, which is triggered when an HTTP respo
**Parameters**
-| Name | Type | Mandatory | Description |
+| Name| Type| Mandatory| Description|
| -------- | -------- | -------- | -------- |
-| type | string | Yes | Type of the event to subscribe to. The value is **'headerReceive'** (response header). |
-| callback | function | Yes | Callback for the HTTP Response Header event. |
+| type | string | Yes| Type of the event to subscribe to. The value is **'headerReceive'** (response header).|
+| callback | function | Yes| Callback for the HTTP Response Header event.|
-**callback** parameters
+Parameters of the callback function
-| Name | Type | Mandatory | Description |
+| Name| Type| Mandatory| Description|
| -------- | -------- | -------- | -------- |
-| header | object | Yes | HTTP Response Header. |
+| header | object | Yes| HTTP Response Header.|
**Example**
@@ -210,7 +304,7 @@ Subscribes to the **headerReceive** event, which is triggered when an HTTP respo
off(type: 'progress', callback?: (uploadedSize: number, totalSize: number) => void): void
-Unsubscribes from the upload progress event. This API uses an asynchronous callback to return the result.
+Unsubscribes from an upload event. This API uses an asynchronous callback to return the result.
**Required permissions**: ohos.permission.INTERNET
@@ -218,17 +312,17 @@ Unsubscribes from the upload progress event. This API uses an asynchronous callb
**Parameters**
-| Name | Type | Mandatory | Description |
+| Name| Type| Mandatory| Description|
| -------- | -------- | -------- | -------- |
-| type | string | Yes | Type of the event to unsubscribe from. The value is **'progress'** (upload progress). |
-| callback | function | No | Callback for the upload progress event. |
+| type | string | Yes| Type of the event to unsubscribe from. The value is **'progress'** (upload progress).|
+| callback | function | No| Callback for the upload progress event.|
-**callback** parameters
+Parameters of the callback function
-| Name | Type | Mandatory | Description |
+| Name| Type| Mandatory| Description|
| -------- | -------- | -------- | -------- |
-| uploadedSize | number | Yes | Size of the uploaded files, in KB. |
-| totalSize | number | Yes | Total size of the files to upload, in KB. |
+| uploadedSize | number | Yes| Size of the uploaded files, in KB.|
+| totalSize | number | Yes| Total size of the files to upload, in KB.|
**Example**
@@ -244,7 +338,7 @@ Unsubscribes from the upload progress event. This API uses an asynchronous callb
off(type: 'headerReceive', callback?: (header: object) => void): void
-Unsubscribes from the **headerReceive** event. This API uses an asynchronous callback to return the result.
+Unsubscribes from an upload event. This API uses an asynchronous callback to return the result.
**Required permissions**: ohos.permission.INTERNET
@@ -252,16 +346,16 @@ Unsubscribes from the **headerReceive** event. This API uses an asynchronous cal
**Parameters**
-| Name | Type | Mandatory | Description |
+| Name| Type| Mandatory| Description|
| -------- | -------- | -------- | -------- |
-| type | string | Yes | Type of the event to unsubscribe from. The value is **'headerReceive'** (response header). |
-| callback | function | No | Callback for the HTTP Response Header event. |
+| type | string | Yes| Type of the event to unsubscribe from. The value is **'headerReceive'** (response header).|
+| callback | function | No| Callback for the HTTP Response Header event.|
-**callback** parameters
+Parameters of the callback function
-| Name | Type | Mandatory | Description |
+| Name| Type| Mandatory| Description|
| -------- | -------- | -------- | -------- |
-| header | object | Yes | HTTP Response Header. |
+| header | object | Yes| HTTP Response Header.|
**Example**
@@ -277,7 +371,7 @@ Unsubscribes from the **headerReceive** event. This API uses an asynchronous cal
remove(): Promise<boolean>
-Removes this upload task. This API uses a promise to return the result.
+Removes this upload task. This API uses a promise to return the result.
**Required permissions**: ohos.permission.INTERNET
@@ -285,9 +379,9 @@ Removes this upload task. This API uses a promise to return the result.
**Return value**
-| Type | Description |
+| Type| Description|
| -------- | -------- |
-| Promise<boolean> | Promise used to return the task removal result. If **true** is returned, the task is removed. If **false** is returned, the task fails to be removed. |
+| Promise<boolean> | Promise used to return the task removal result. If **true** is returned, the task is removed. If **false** is returned, the task fails to be removed.|
**Example**
@@ -308,7 +402,7 @@ Removes this upload task. This API uses a promise to return the result.
remove(callback: AsyncCallback<boolean>): void
-Removes this upload task. This API uses an asynchronous callback to return the result.
+Removes this upload task. This API uses an asynchronous callback to return the result.
**Required permissions**: ohos.permission.INTERNET
@@ -316,9 +410,9 @@ Removes this upload task. This API uses an asynchronous callback to return the r
**Parameters**
-| Name | Type | Mandatory | Description |
+| Name| Type| Mandatory| Description|
| -------- | -------- | -------- | -------- |
-| callback | AsyncCallback<boolean> | Yes | Callback used to return the result. |
+| callback | AsyncCallback<boolean> | Yes| Callback used to return the result.|
**Example**
@@ -339,37 +433,42 @@ Removes this upload task. This API uses an asynchronous callback to return the r
## UploadConfig
+**Required permissions**: ohos.permission.INTERNET
+
**System capability**: SystemCapability.MiscServices.Upload
-| Name | Type | Mandatory | Description |
+| Name| Type| Mandatory| Description|
| -------- | -------- | -------- | -------- |
-| url | string | Yes | Resource URL. |
-| header | object | Yes | HTTP or HTTPS header added to an upload request. |
-| method | string | Yes | Request method, which can be **POST** or **PUT**. The default value is **POST**. |
-| files | Array<[File](#file)> | Yes | List of files to upload, which is submitted through **multipart/form-data**. |
-| data | Array<[RequestData](#requestdata)> | Yes | Form data in the request body. |
+| url | string | Yes| Resource URL.|
+| header | object | Yes| HTTP or HTTPS header added to an upload request.|
+| method | string | Yes| Request method, which can be **'POST'** or **'PUT'**. The default value is **'POST'**.|
+| files | Array<[File](#file)> | Yes| List of files to upload, which is submitted through **multipart/form-data**.|
+| data | Array<[RequestData](#requestdata)> | Yes| Form data in the request body.|
## File
-**System capability**: SystemCapability.MiscServices.Upload
+**Required permissions**: ohos.permission.INTERNET
+
+**System capability**: SystemCapability.MiscServices.Download
-| Name | Type | Mandatory | Description |
+| Name| Type| Mandatory| Description|
| -------- | -------- | -------- | -------- |
-| filename | string | No | File name in the header when **multipart** is used. |
-| name | string | No | Name of a form item when **multipart** is used. The default value is **file**. |
-| uri | string | Yes | Local path for storing files. The **dataability** and **internal** protocol types are supported. However, the **internal** protocol type supports only temporary directories. Below are examples: dataability:///com.domainname.dataability.persondata/person/10/file.txt internal://cache/path/to/file.txt |
-| type | string | No | Type of the file content. By default, the type is obtained based on the extension of the file name or URI. |
+| filename | string | No| File name in the header when **multipart** is used.|
+| name | string | No| Name of a form item when **multipart** is used. The default value is **file**.|
+| uri | string | Yes| Local path for storing files. The **dataability** and **internal** protocol types are supported. However, the **internal** protocol type supports only temporary directories. Below are examples: dataability:///com.domainname.dataability.persondata/person/10/file.txt
internal://cache/path/to/file.txt |
+| type | string | No| Type of the file content. By default, the type is obtained based on the extension of the file name or URI.|
## RequestData
-**System capability**: SystemCapability.MiscServices.Upload
+**Required permissions**: ohos.permission.INTERNET
-| Name | Type | Mandatory | Description |
+**System capability**: SystemCapability.MiscServices.Download
+| Name| Type| Mandatory| Description|
| -------- | -------- | -------- | -------- |
-| name | string | Yes | Name of a form element. |
-| value | string | Yes | Value of a form element. |
+| name | string | Yes| Name of a form element.|
+| value | string | Yes| Value of a form element.|
## request.download
@@ -378,21 +477,23 @@ download(config: DownloadConfig): Promise<DownloadTask>
Downloads files. This API uses a promise to return the result.
+This API can be used only in the FA model.
+
**Required permissions**: ohos.permission.INTERNET
**System capability**: SystemCapability.MiscServices.Download
**Parameters**
-| Name | Type | Mandatory | Description |
+| Name| Type| Mandatory| Description|
| -------- | -------- | -------- | -------- |
-| config | [DownloadConfig](#downloadconfig) | Yes | Configurations of the download. |
+| config | [DownloadConfig](#downloadconfig) | Yes| Download configurations.|
**Return value**
-| Type | Description |
+| Type| Description|
| -------- | -------- |
-| Promise<[DownloadTask](#downloadtask)> | Promise used to return the result. |
+| Promise<[DownloadTask](#downloadtask)> | Promise used to return the result.|
**Example**
@@ -412,16 +513,18 @@ download(config: DownloadConfig, callback: AsyncCallback<DownloadTask>): v
Downloads files. This API uses an asynchronous callback to return the result.
+This API can be used only in the FA model.
+
**Required permissions**: ohos.permission.INTERNET
**System capability**: SystemCapability.MiscServices.Download
**Parameters**
-| Name | Type | Mandatory | Description |
+| Name| Type| Mandatory| Description|
| -------- | -------- | -------- | -------- |
-| config | [DownloadConfig](#downloadconfig) | Yes | Configurations of the download. |
-| callback | AsyncCallback<[DownloadTask](#downloadtask)> | No | Callback used to return the result. |
+| config | [DownloadConfig](#downloadconfig) | Yes| Download configurations.|
+| callback | AsyncCallback<[DownloadTask](#downloadtask)> | No| Callback used to return the result.|
**Example**
@@ -437,7 +540,72 @@ Downloads files. This API uses an asynchronous callback to return the result.
});
```
+## request.download9+
+
+download(context: BaseContext, config: DownloadConfig): Promise<DownloadTask>
+
+Downloads files. This API uses a promise to return the result.
+
+**Required permissions**: ohos.permission.INTERNET
+
+**System capability**: SystemCapability.MiscServices.Download
+
+**Parameters**
+
+| Name| Type| Mandatory| Description|
+| -------- | -------- | -------- | -------- |
+| context | BaseContext | Yes| Application-based context.|
+| config | [DownloadConfig](#downloadconfig) | Yes| Download configurations.|
+
+**Return value**
+
+| Type| Description|
+| -------- | -------- |
+| Promise<[DownloadTask](#downloadtask)> | Promise used to return the result.|
+
+**Example**
+
+ ```js
+ let downloadTask;
+ request.download(globalThis.abilityContext, { url: 'https://xxxx/xxxx.hap' }).then((data) => {
+ downloadTask = data;
+ }).catch((err) => {
+ console.error('Failed to request the download. Cause: ' + JSON.stringify(err));
+ })
+ ```
+
+## request.download9+
+
+download(context: BaseContext, config: DownloadConfig, callback: AsyncCallback<DownloadTask>): void;
+
+Downloads files. This API uses an asynchronous callback to return the result.
+
+**Required permissions**: ohos.permission.INTERNET
+
+**System capability**: SystemCapability.MiscServices.Download
+
+**Parameters**
+
+| Name| Type| Mandatory| Description|
+| -------- | -------- | -------- | -------- |
+| context | BaseContext | Yes| Application-based context.|
+| config | [DownloadConfig](#downloadconfig) | Yes| Download configurations.|
+| callback | AsyncCallback<[DownloadTask](#downloadtask)> | No| Callback used to return the result.|
+
+**Example**
+
+ ```js
+ let downloadTask;
+ request.download(globalThis.abilityContext, { url: 'https://xxxx/xxxxx.hap',
+ filePath: 'xxx/xxxxx.hap'}, (err, data) => {
+ if (err) {
+ console.error('Failed to request the download. Cause: ' + JSON.stringify(err));
+ return;
+ }
+ downloadTask = data;
+ });
+ ```
## DownloadTask
Implements file downloads.
@@ -447,7 +615,7 @@ Implements file downloads.
on(type: 'progress', callback:(receivedSize: number, totalSize: number) => void): void
-Subscribes to the download progress event. This API uses an asynchronous callback to return the result.
+Subscribes to a download event. This API uses an asynchronous callback to return the result.
**Required permissions**: ohos.permission.INTERNET
@@ -455,17 +623,17 @@ Subscribes to the download progress event. This API uses an asynchronous callbac
**Parameters**
-| Name | Type | Mandatory | Description |
+| Name| Type| Mandatory| Description|
| -------- | -------- | -------- | -------- |
-| type | string | Yes | Type of the event to subscribe to. The value is **'progress'** (download progress). |
-| callback | function | Yes | Callback for the download progress event. |
+| type | string | Yes| Type of the event to subscribe to. The value is **'progress'** (download progress).|
+| callback | function | Yes| Callback for the download progress event.|
-**callback** parameters
+Parameters of the callback function
-| Name | Type | Mandatory | Description |
+| Name| Type| Mandatory| Description|
| -------- | -------- | -------- | -------- |
-| receivedSize | number | Yes | Size of the downloaded files, in KB. |
-| totalSize | number | Yes | Total size of the files to download, in KB. |
+| receivedSize | number | Yes| Size of the downloaded files, in KB.|
+| totalSize | number | Yes| Total size of the files to download, in KB.|
**Example**
@@ -481,7 +649,7 @@ Subscribes to the download progress event. This API uses an asynchronous callbac
off(type: 'progress', callback?: (receivedSize: number, totalSize: number) => void): void
-Unsubscribes from the download progress event. This API uses an asynchronous callback to return the result.
+Unsubscribes from a download event. This API uses an asynchronous callback to return the result.
**Required permissions**: ohos.permission.INTERNET
@@ -489,17 +657,17 @@ Unsubscribes from the download progress event. This API uses an asynchronous cal
**Parameters**
-| Name | Type | Mandatory | Description |
+| Name| Type| Mandatory| Description|
| -------- | -------- | -------- | -------- |
-| type | string | Yes | Type of the event to unsubscribe from. The value is **'progress'** (download progress). |
-| callback | function | No | Callback for the download progress event. |
+| type | string | Yes| Type of the event to unsubscribe from. The value is **'progress'** (download progress).|
+| callback | function | No| Callback for the download progress event.|
-**callback** parameters
+Parameters of the callback function
-| Name | Type | Mandatory | Description |
+| Name| Type| Mandatory| Description|
| -------- | -------- | -------- | -------- |
-| receivedSize | number | Yes | Size of the downloaded files, in KB. |
-| totalSize | number | Yes | Total size of the files to download, in KB. |
+| receivedSize | number | Yes| Size of the downloaded files.|
+| totalSize | number | Yes| Total size of the files to download.|
**Example**
@@ -523,10 +691,10 @@ Subscribes to a download event. This API uses an asynchronous callback to return
**Parameters**
-| Name | Type | Mandatory | Description |
+| Name| Type| Mandatory| Description|
| -------- | -------- | -------- | -------- |
-| type | string | Yes | Event type. - **'complete'**: download task completion event. - **'pause'**: download task pause event. - **'remove'**: download task removal event. |
-| callback | function | Yes | Callback used to return the result. |
+| type | string | Yes| Type of the event to subscribe to. - **'complete'**: download task completion event. - **'pause'**: download task pause event. - **'remove'**: download task removal event.|
+| callback | function | Yes| Callback used to return the result.|
**Example**
@@ -542,7 +710,7 @@ Subscribes to a download event. This API uses an asynchronous callback to return
off(type: 'complete'|'pause'|'remove', callback?:() => void): void
-Unsubscribes from the download event. This API uses an asynchronous callback to return the result.
+Unsubscribes from a download event. This API uses an asynchronous callback to return the result.
**Required permissions**: ohos.permission.INTERNET
@@ -550,10 +718,10 @@ Unsubscribes from the download event. This API uses an asynchronous callback to
**Parameters**
-| Name | Type | Mandatory | Description |
+| Name| Type| Mandatory| Description|
| -------- | -------- | -------- | -------- |
-| type | string | Yes | Event type. - **'complete'**: download task completion event. - **'pause'**: download task pause event. - **'remove'**: download task removal event. |
-| callback | function | No | Callback used to return the result. |
+| type | string | Yes| Type of the event to unsubscribe from. - **'complete'**: download task completion event. - **'pause'**: download task pause event. - **'remove'**: download task removal event.|
+| callback | function | No| Callback used to return the result.|
**Example**
@@ -577,16 +745,16 @@ Subscribes to the download task failure event. This API uses an asynchronous cal
**Parameters**
-| Name | Type | Mandatory | Description |
+| Name| Type| Mandatory| Description|
| -------- | -------- | -------- | -------- |
-| type | string | Yes | Type of the subscribed event. The value is **'fail'** (download failure). |
-| callback | function | Yes | Callback for the download task failure event. |
+| type | string | Yes| Type of the event to subscribe to. The value is **'fail'** (download failure).|
+| callback | function | Yes| Callback for the download task failure event.|
-**callback** parameters
+Parameters of the callback function
-| Name | Type | Mandatory | Description |
+| Name| Type| Mandatory| Description|
| -------- | -------- | -------- | -------- |
-| err | number | Yes | Error code of the download failure. For details about the error cause, see [ERROR_*](#constants). |
+| err | number | Yes| Error code of the download failure. For details about the error codes, see [ERROR_*](#constants).|
**Example**
@@ -602,7 +770,7 @@ Subscribes to the download task failure event. This API uses an asynchronous cal
off(type: 'fail', callback?: (err: number) => void): void
-Unsubscribes from the download task failure event. This API uses an asynchronous callback to return the result.
+Unsubscribes from the download task failure event. This API uses an asynchronous callback to return the result.
**Required permissions**: ohos.permission.INTERNET
@@ -610,16 +778,16 @@ Unsubscribes from the download task failure event. This API uses an asynchronous
**Parameters**
-| Name | Type | Mandatory | Description |
+| Name| Type| Mandatory| Description|
| -------- | -------- | -------- | -------- |
-| type | string | Yes | Type of the event to unsubscribe from. The value is **'fail'** (download failure). |
-| callback | function | No | Callback for the download task failure event. |
+| type | string | Yes| Type of the event to unsubscribe from. The value is **'fail'** (download failure).|
+| callback | function | No| Callback for the download task failure event.|
-**callback** parameters
+Parameters of the callback function
-| Name | Type | Mandatory | Description |
+| Name| Type| Mandatory| Description|
| -------- | -------- | -------- | -------- |
-| err | number | Yes | Error code of the download failure. For details about the error cause, see [ERROR_*](#constants). |
+| err | number | Yes| Error code of the download failure. For details about the error codes, see [ERROR_*](#constants).|
**Example**
@@ -643,9 +811,9 @@ Removes this download task. This API uses a promise to return the result.
**Return value**
-| Type | Description |
+| Type| Description|
| -------- | -------- |
-| Promise<boolean> | Promise used to return the task removal result. |
+| Promise<boolean> | Promise used to return the task removal result.|
**Example**
@@ -674,9 +842,9 @@ Removes this download task. This API uses an asynchronous callback to return the
**Parameters**
-| Name | Type | Mandatory | Description |
+| Name| Type| Mandatory| Description|
| -------- | -------- | -------- | -------- |
-| callback | AsyncCallback<boolean> | Yes | Callback used to return the task removal result. |
+| callback | AsyncCallback<boolean> | Yes| Callback used to return the task removal result.|
**Example**
@@ -706,10 +874,9 @@ Queries this download task. This API uses a promise to return the result.
**System capability**: SystemCapability.MiscServices.Download
**Parameters**
-
-| Type | Description |
+| Type| Description|
| -------- | -------- |
-| Promise<[DownloadInfo](#downloadinfo7)> | Promise used to return the download task information. |
+| Promise<[DownloadInfo](#downloadinfo7)> | Promise used to return the download task information.|
**Example**
@@ -734,9 +901,9 @@ Queries this download task. This API uses an asynchronous callback to return the
**Parameters**
-| Name | Type | Mandatory | Description |
+| Name| Type| Mandatory| Description|
| -------- | -------- | -------- | -------- |
-| callback | AsyncCallback<[DownloadInfo](#downloadinfo7)> | Yes | Callback used to return the download task information. |
+| callback | AsyncCallback<[DownloadInfo](#downloadinfo7)> | Yes| Callback used to return the download task information.|
**Example**
@@ -755,7 +922,7 @@ Queries this download task. This API uses an asynchronous callback to return the
queryMimeType(): Promise<string>
-Queries **MimeType** of this download task. This API uses a promise to return the result.
+Queries the **MimeType** of this download task. This API uses a promise to return the result.
**Required permissions**: ohos.permission.INTERNET
@@ -763,9 +930,9 @@ Queries **MimeType** of this download task. This API uses a promise to return th
**Return value**
-| Type | Description |
+| Type| Description|
| -------- | -------- |
-| Promise<string> | Promise used to return **MimeType** of the download task. |
+| Promise<string> | Promise used to return the **MimeType** of the download task.|
**Example**
@@ -782,7 +949,7 @@ Queries **MimeType** of this download task. This API uses a promise to return th
queryMimeType(callback: AsyncCallback<string>): void;
-Queries **MimeType** of this download task. This API uses an asynchronous callback to return the result.
+Queries the **MimeType** of this download task. This API uses an asynchronous callback to return the result.
**Required permissions**: ohos.permission.INTERNET
@@ -790,9 +957,9 @@ Queries **MimeType** of this download task. This API uses an asynchronous callba
**Parameters**
-| Name | Type | Mandatory | Description |
+| Name| Type| Mandatory| Description|
| -------- | -------- | -------- | -------- |
-| callback | AsyncCallback<string> | Yes | Callback used to return **MimeType** of the download task. |
+| callback | AsyncCallback<string> | Yes| Callback used to return the **MimeType** of the download task.|
**Example**
@@ -819,9 +986,9 @@ Pauses this download task. This API uses a promise to return the result.
**Return value**
-| Type | Description |
+| Type| Description|
| -------- | -------- |
-| Promise<void> | Promise used to return the download task pause result. |
+| Promise<void> | Promise used to return the download task pause result.|
**Example**
@@ -850,9 +1017,9 @@ Pauses this download task. This API uses an asynchronous callback to return the
**Parameters**
-| Name | Type | Mandatory | Description |
+| Name| Type| Mandatory| Description|
| -------- | -------- | -------- | -------- |
-| callback | AsyncCallback<void> | Yes | Callback used to return the result. |
+| callback | AsyncCallback<void> | Yes| Callback used to return the result.|
**Example**
@@ -883,9 +1050,9 @@ Resumes this download task. This API uses a promise to return the result.
**Parameters**
-| Type | Description |
+| Type| Description|
| -------- | -------- |
-| Promise<void> | Promise used to return the result. |
+| Promise<void> | Promise used to return the result.|
**Example**
@@ -915,9 +1082,9 @@ Resumes this download task. This API uses an asynchronous callback to return the
**Parameters**
-| Name | Type | Mandatory | Description |
+| Name| Type| Mandatory| Description|
| -------- | -------- | -------- | -------- |
-| callback | AsyncCallback<void> | Yes | Callback used to return the result. |
+| callback | AsyncCallback<void> | Yes| Callback used to return the result.|
**Example**
@@ -938,34 +1105,38 @@ Resumes this download task. This API uses an asynchronous callback to return the
## DownloadConfig
+**Required permissions**: ohos.permission.INTERNET
+
**System capability**: SystemCapability.MiscServices.Download
-| Name | Type | Mandatory | Description |
+| Name| Type| Mandatory| Description|
| -------- | -------- | -------- | -------- |
-| url | string | Yes | Resource URL. |
-| header | object | No | HTTP or HTTPS header added to a download request. |
-| enableMetered | boolean | No | Download allowed in metered connections. |
-| enableRoaming | boolean | No | Download allowed on a roaming network. |
-| description | string | No | Description of the download session. |
-| filePath7+ | string | No | Download path. (The default path is **'internal://cache/'**. - filePath:'workspace/test.txt': The **workspace** directory is created in the default path to store files. - filePath:'test.txt': Files are stored in the default path. - filePath:'workspace/': The **workspace** directory is created in the default path to store files. |
-| networkType | number | No | Network type allowed for download. |
-| title | string | No | Title of the download session. |
+| url | string | Yes| Resource URL.|
+| header | object | No| HTTP or HTTPS header added to a download request.|
+| enableMetered | boolean | No| Download allowed in metered connections.|
+| enableRoaming | boolean | No| Download allowed on a roaming network.|
+| description | string | No| Description of the download session.|
+| filePath7+ | string | No| Download path. (The default path is **'internal://cache/'**.) - filePath:'workspace/test.txt': The **workspace** directory is created in the default path to store files. - filePath:'test.txt': Files are stored in the default path. - filePath:'workspace/': The **workspace** directory is created in the default path to store files.|
+| networkType | number | No| Network type allowed for download.|
+| title | string | No| Title of the download session.|
## DownloadInfo7+
+**Required permissions**: ohos.permission.INTERNET
+
**System capability**: SystemCapability.MiscServices.Download
-| Name | Type | Mandatory | Description |
-| -------- | -------- | -------- | -------- |
-| downloadId | number | Yes | ID of the downloaded file. |
-| failedReason | number | No | Download failure cause, which can be any constant of [ERROR_*](#constants). |
-| fileName | string | Yes | Name of the downloaded file. |
-| filePath | string | Yes | URI of the saved file. |
-| pausedReason | number | No | Reason for session pause, which can be any constant of [PAUSED_*](#constants). |
-| status | number | Yes | Download status code, which can be any constant of [SESSION_*](#constants). |
-| targetURI | string | Yes | URI of the downloaded file. |
-| downloadTitle | string | Yes | Title of the downloaded file. |
-| downloadTotalBytes | number | Yes | Total size of the downloaded file (int bytes). |
-| description | string | Yes | Description of the file to download. |
-| downloadedBytes | number | Yes | Size of the files downloaded (int bytes). |
+| Name| Type| Mandatory| Description|
+| -------- | -------- | -------- | -------- |
+| downloadId | number | Yes| ID of the downloaded file.|
+| failedReason | number | No| Download failure cause, which can be any constant of [ERROR_*](#constants).|
+| fileName | string | Yes| Name of the downloaded file.|
+| filePath | string | Yes| URI of the saved file.|
+| pausedReason | number | No| Reason for session pause, which can be any constant of [PAUSED_*](#constants).|
+| status | number | Yes| Download status code, which can be any constant of [SESSION_*](#constants).|
+| targetURI | string | Yes| URI of the downloaded file.|
+| downloadTitle | string | Yes| Title of the downloaded file.|
+| downloadTotalBytes | number | Yes| Total size of the files to download (int bytes).|
+| description | string | Yes| Description of the file to download.|
+| downloadedBytes | number | Yes| Size of the files downloaded (int bytes).|
diff --git a/en/application-dev/reference/arkui-ts/ts-basic-components-button.md b/en/application-dev/reference/arkui-ts/ts-basic-components-button.md
index 42ac10339280af072effe49c7850c0a5fc1087d3..5f7d75d5406fd705e5a0716ff9d94fd3dd73de22 100644
--- a/en/application-dev/reference/arkui-ts/ts-basic-components-button.md
+++ b/en/application-dev/reference/arkui-ts/ts-basic-components-button.md
@@ -1,13 +1,12 @@
# Button
+The **\