diff --git a/en/application-dev/reference/apis/js-apis-Bundle.md b/en/application-dev/reference/apis/js-apis-Bundle.md index f97cfdbebe1ae0cc37229bb77117627472b1ad5a..e62395b2437a0f24917a3f7356b353dad2c8dd67 100644 --- a/en/application-dev/reference/apis/js-apis-Bundle.md +++ b/en/application-dev/reference/apis/js-apis-Bundle.md @@ -1,6 +1,6 @@ # Bundle Module (JavaScript SDK APIs) -> ![icon-note.gif](public_sys-resources/icon-note.gif) **NOTE**
+> **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. > API version 9 is a canary version for trial use. The APIs of this version may be unstable. ## Modules to Import @@ -17,8 +17,8 @@ SystemCapability.BundleManager.BundleFramework | Required Permissions | Permission Level | Description | | ---------------------------------------- | ------------ | --------- | -| ohos.permission.GET_BUNDLE_INFO | normal | Permission to query information about the current application.| -| ohos.permission.GET_BUNDLE_INFO_PRIVILEGED| system_basic | Permission to query information about all applications.| +| ohos.permission.GET_BUNDLE_INFO | normal | Permission to query information about the current application. | +| ohos.permission.GET_BUNDLE_INFO_PRIVILEGED| system_basic | Permission to query information about all applications. | | ohos.permission.INSTALL_BUNDLE | system_core | Permission to install or uninstall applications. | ## bundle.getApplicationInfo @@ -37,17 +37,17 @@ SystemCapability.BundleManager.BundleFramework **Parameters** -| Name | Type | Mandatory | Description | +| Name | Type | Mandatory | Description | | ----------- | ------ | ---- | --------------------------------------- | -| bundleName | string | Yes | Bundle name of the application. | -| bundleFlags | number | Yes | Type of information that will be returned. The default value is **0**. The value must be greater than or equal to 0.| -| userId | number | No | User ID. The default value is the user ID of the caller. The value must be greater than or equal to 0. | +| bundleName | string | Yes | Bundle name of the application. | +| bundleFlags | number | Yes | Type of information that will be returned. The default value is **0**. The value must be greater than or equal to 0. | +| userId | number | No | User ID. The default value is the user ID of the caller. The value must be greater than or equal to 0. | **Return value** | Type | Description | | ------------------------- | ------------------ | -| Promise\ | Promise used to return the application information.| +| Promise\ | Promise used to return the application information. | **Example** @@ -84,7 +84,7 @@ SystemCapability.BundleManager.BundleFramework | Name | Type | Mandatory | Description | | ----------- | ------------------------------- | ---- | --------------------------------------- | | bundleName | string | Yes | Bundle name of the application. | -| bundleFlags | number | Yes | Type of information that will be returned. The default value is **0**. The value must be greater than or equal to 0.| +| bundleFlags | number | Yes | Type of information that will be returned. The default value is **0**. The value must be greater than or equal to 0. | | userId | number | Yes | User ID. The default value is the user ID of the caller. The value must be greater than or equal to 0. | | callback | AsyncCallback\ | Yes | Callback used to return the application information. | @@ -123,7 +123,7 @@ SystemCapability.BundleManager.BundleFramework | Name | Type | Mandatory | Description | | ----------- | ------------------------------- | ---- | --------------------------------------- | | bundleName | string | Yes | Bundle name of the application. | -| bundleFlags | number | Yes | Type of information that will be returned. The default value is **0**. The value must be greater than or equal to 0.| +| bundleFlags | number | Yes | Type of information that will be returned. The default value is **0**. The value must be greater than or equal to 0. | | callback | AsyncCallback\ | Yes | Callback used to return the application information. | **Example** @@ -159,14 +159,14 @@ SystemCapability.BundleManager.BundleFramework | Name | Type | Mandatory | Description | | ---------- | ---------- | ---- | --------------------------------------- | -| bundleFlag | BundleFlag | Yes | Type of information that will be returned. The default value is **0**. The value must be greater than or equal to 0.| +| bundleFlag | BundleFlag | Yes | Type of information that will be returned. The default value is **0**. The value must be greater than or equal to 0. | | userId | number | No | User ID. The default value is the user ID of the caller. The value must be greater than or equal to 0. | **Return value** | Type | Description | | --------------------------- | -------------------------- | -| Promise> | Promise used to return the information of all available bundles.| +| Promise> | Promise used to return the information of all available bundles. | **Example** @@ -201,7 +201,7 @@ SystemCapability.BundleManager.BundleFramework | Name | Type | Mandatory | Description | | ---------- | --------------------------------- | ---- | --------------------------------------- | -| bundleFlag | BundleFlag | Yes | Type of information that will be returned. The default value is **0**. The value must be greater than or equal to 0.| +| bundleFlag | BundleFlag | Yes | Type of information that will be returned. The default value is **0**. The value must be greater than or equal to 0. | | callback | AsyncCallback> | Yes | Callback used to return the information of all available bundles. | **Example** @@ -236,7 +236,7 @@ SystemCapability.BundleManager.BundleFramework | Name | Type | Mandatory | Description | | ---------- | --------------------------------- | ---- | --------------------------------------- | -| bundleFlag | BundleFlag | Yes | Type of information that will be returned. The default value is **0**. The value must be greater than or equal to 0.| +| bundleFlag | BundleFlag | Yes | Type of information that will be returned. The default value is **0**. The value must be greater than or equal to 0. | | userId | number | Yes | User ID. The default value is the user ID of the caller. The value must be greater than or equal to 0. | | callback | AsyncCallback> | Yes | Callback used to return the information of all available bundles. | @@ -275,14 +275,14 @@ SystemCapability.BundleManager.BundleFramework | Name | Type | Mandatory | Description | | ----------- | ------------- | ---- | --------------------------------------- | | bundleName | string | Yes | Bundle name. | -| bundleFlags | number | Yes | Type of information that will be returned. The default value is **0**. The value must be greater than or equal to 0.| +| bundleFlags | number | Yes | Type of information that will be returned. The default value is **0**. The value must be greater than or equal to 0. | | options | BundleOptions | No | Includes **userId**. | **Return value** | Type | Description | | -------------------- | ---------------------------- | -| Promise\ | Promise used to return the bundle information.| +| Promise\ | Promise used to return the bundle information. | **Example** @@ -321,7 +321,7 @@ SystemCapability.BundleManager.BundleFramework | Name | Type | Mandatory | Description | | ----------- | -------------------------- | ---- | --------------------------------------- | | bundleName | string | Yes | Bundle name. | -| bundleFlags | number | Yes | Type of information that will be returned. The default value is **0**. The value must be greater than or equal to 0.| +| bundleFlags | number | Yes | Type of information that will be returned. The default value is **0**. The value must be greater than or equal to 0. | | callback | AsyncCallback\ | Yes | Callback used to return the bundle information. | **Example** @@ -358,7 +358,7 @@ SystemCapability.BundleManager.BundleFramework | Name | Type | Mandatory | Description | | ----------- | -------------------------- | ---- | --------------------------------------- | | bundleName | string | Yes | Bundle name. | -| bundleFlags | number | Yes | Type of information that will be returned. The default value is **0**. The value must be greater than or equal to 0.| +| bundleFlags | number | Yes | Type of information that will be returned. The default value is **0**. The value must be greater than or equal to 0. | | options | BundleOptions | Yes | Includes **userId**. | | callback | AsyncCallback\ | Yes | Callback used to return the bundle information. | @@ -398,14 +398,14 @@ SystemCapability.BundleManager.BundleFramework | Name | Type | Mandatory | Description | | ----------- | ------ | ---- | --------------------------------------- | -| bundleFlags | number | Yes | Type of information that will be returned. The default value is **0**. The value must be greater than or equal to 0.| +| bundleFlags | number | Yes | Type of information that will be returned. The default value is **0**. The value must be greater than or equal to 0. | | userId | number | No | User ID. The default value is the user ID of the caller. The value must be greater than or equal to 0. | **Return value** | Type | Description | | -------------------------------- | ------------------------------- | -| Promise> | Promise used to return the application information.| +| Promise> | Promise used to return the application information. | **Example** @@ -440,7 +440,7 @@ SystemCapability.BundleManager.BundleFramework | Name | Type | Mandatory | Description | | ----------- | -------------------------------------- | ---- | --------------------------------------- | -| bundleFlags | number | Yes | Type of information that will be returned. The default value is **0**. The value must be greater than or equal to 0.| +| bundleFlags | number | Yes | Type of information that will be returned. The default value is **0**. The value must be greater than or equal to 0. | | userId | number | No | User ID. The default value is the user ID of the caller. The value must be greater than or equal to 0. | | callback | AsyncCallback> | Yes | Callback used to return the application information. | @@ -477,7 +477,7 @@ SystemCapability.BundleManager.BundleFramework | Name | Type | Mandatory | Description | | ----------- | -------------------------------------- | ---- | --------------------------------------- | -| bundleFlags | number | Yes | Type of information that will be returned. The default value is **0**. The value must be greater than or equal to 0.| +| bundleFlags | number | Yes | Type of information that will be returned. The default value is **0**. The value must be greater than or equal to 0. | | callback | AsyncCallback> | Yes | Callback used to return the application information. | **Example** @@ -512,13 +512,13 @@ SystemCapability.BundleManager.BundleFramework | Name | Type | Mandatory | Description | | ----------- | ------ | ---- | ---------------- | | bundleName | string | Yes | Bundle name of the application. | -| abilityName | string | Yes | Ability name.| +| abilityName | string | Yes | Ability name. | **Return value** | Type | Description | | --------------------- | --------------------- | -| Promise\ | Promise used to return the ability information.| +| Promise\ | Promise used to return the ability information. | **Example** @@ -552,8 +552,8 @@ SystemCapability.BundleManager.BundleFramework | Name | Type | Mandatory | Description | | ----------- | ------------ | ---- | ---------------- | | bundleName | string | Yes | Bundle name of the application. | -| abilityName | string | Yes | Ability name.| -| callback | AsyncCallback\ | Yes | Callback used to return the ability information.| +| abilityName | string | Yes | Ability name. | +| callback | AsyncCallback\ | Yes | Callback used to return the ability information. | **Example** @@ -588,13 +588,13 @@ SystemCapability.BundleManager.BundleFramework | Name | Type | Mandatory | Description | | ----------- | ------ | ---- | ---------------- | | bundleName | string | Yes | Bundle name of the application. | -| abilityName | string | Yes | Ability name.| +| abilityName | string | Yes | Ability name. | **Return value** | Type | Description | | ---------------- | ------------------ | -| Promise\ | Promise used to return the application name.| +| Promise\ | Promise used to return the application name. | **Example** @@ -628,7 +628,7 @@ SystemCapability.BundleManager.BundleFramework | Name | Type | Mandatory | Description | | ----------- | ---------------------- | ---- | ---------------- | | bundleName | string | Yes | Bundle name of the application. | -| abilityName | string | Yes | Ability name.| +| abilityName | string | Yes | Ability name. | | callback | AsyncCallback\ | Yes | Callback used to return the application name. | **Example** @@ -663,13 +663,13 @@ SystemCapability.BundleManager.BundleFramework | Name | Type | Mandatory | Description | | ---- | ----------- | ---- | ------------ | -| info | AbilityInfo | Yes | Ability information.| +| info | AbilityInfo | Yes | Ability information. | **Return value** | Type | Description | | ----------------- | ------------------------- | -| Promise\ | Promise used to return whether the ability is enabled. If the ability is enabled, **true** will be returned; otherwise, **false** will be returned.| +| Promise\ | Promise used to return whether the ability is enabled. If the ability is enabled, **true** will be returned; otherwise, **false** will be returned. | **Example** @@ -705,7 +705,7 @@ SystemCapability.BundleManager.BundleFramework | Name | Type | Mandatory | Description | | -------- | ----------------------- | ---- | --------------- | | info | AbilityInfo | Yes | Ability information. | -| callback | AsyncCallback\ | Yes | Callback used to return whether the ability is enabled. If the ability is enabled, **true** will be returned; otherwise, **false** will be returned.| +| callback | AsyncCallback\ | Yes | Callback used to return whether the ability is enabled. If the ability is enabled, **true** will be returned; otherwise, **false** will be returned. | **Example** @@ -741,13 +741,13 @@ SystemCapability.BundleManager.BundleFramework | Name | Type | Mandatory | Description | | ---------- | ------ | ---- | ------------ | -| bundleName | string | Yes | Bundle name of the application.| +| bundleName | string | Yes | Bundle name of the application. | **Return value** | Type | Description | | ----------------- | ------------------------- | -| Promise\ | Promise used to return whether the ability is enabled. If the ability is enabled, **true** will be returned; otherwise, **false** will be returned.| +| Promise\ | Promise used to return whether the ability is enabled. If the ability is enabled, **true** will be returned; otherwise, **false** will be returned. | **Example** @@ -780,7 +780,7 @@ SystemCapability.BundleManager.BundleFramework | Name | Type | Mandatory | Description | | ---------- | ----------------------- | ---- | --------------- | | bundleName | string | Yes | Bundle name of the application. | -| callback | AsyncCallback\ | Yes | Callback used to return whether the ability is enabled. If the ability is enabled, **true** will be returned; otherwise, **false** will be returned.| +| callback | AsyncCallback\ | Yes | Callback used to return whether the ability is enabled. If the ability is enabled, **true** will be returned; otherwise, **false** will be returned. | **Example** @@ -814,14 +814,14 @@ SystemCapability.BundleManager.BundleFramework | Name | Type | Mandatory | Description | | ----------- | ------ | ---- | ------------------------------------- | | want | Want | Yes | Want that contains the bundle name. | -| bundleFlags | number | Yes | Ability information to be returned. The default value is **0**. The value must be greater than or equal to 0.| +| bundleFlags | number | Yes | Ability information to be returned. The default value is **0**. The value must be greater than or equal to 0. | | userId | number | No | User ID. The default value is the user ID of the caller. The value must be greater than or equal to 0. | **Return value** | Type | Description | | ---------------------------- | --------------------- | -| Promise\>| Promise used to return the ability information.| +| Promise\>| Promise used to return the ability information. | **Example** @@ -934,12 +934,12 @@ SystemCapability.BundleManager.BundleFramework | Name | Type | Mandatory | Description | | ---------- | ------ | ---- | ------------ | -| bundleName | string | Yes | Bundle name of the application.| +| bundleName | string | Yes | Bundle name of the application. | **Return value** | Type | Description | | -------------- | -------------------------------------- | -| Promise\ | Promise used to return the **Want** object.| +| Promise\ | Promise used to return the **Want** object. | **Example** @@ -972,7 +972,7 @@ SystemCapability.BundleManager.BundleFramework | Name | Type | Mandatory | Description | | ---------- | -------------------- | ---- | ------------------------------ | | bundleName | string | Yes | Bundle name of the application. | -| callback | AsyncCallback\ | Yes | Callback used to return the **Want** object.| +| callback | AsyncCallback\ | Yes | Callback used to return the **Want** object. | **Example** @@ -1002,12 +1002,12 @@ SystemCapability.BundleManager.BundleFramework | Name | Type | Mandatory | Description | | ---- | ------ | ---- | -------- | -| uid | number | Yes | UID based on which the bundle name is to obtain.| +| uid | number | Yes | UID based on which the bundle name is to obtain. | **Return value** | Type | Description | | ---------------- | --------------------------------- | -| Promise\ | Promise used to return the bundle name.| +| Promise\ | Promise used to return the bundle name. | **Example** @@ -1036,7 +1036,7 @@ SystemCapability.BundleManager.BundleFramework | Name | Type | Mandatory | Description | | -------- | ---------------------- | ---- | ------------------------- | | uid | number | Yes | UID based on which the bundle name is to obtain. | -| callback | AsyncCallback\ | Yes | Callback used to return the bundle name.| +| callback | AsyncCallback\ | Yes | Callback used to return the bundle name. | **Example** @@ -1076,7 +1076,7 @@ SystemCapability.BundleManager.BundleFramework **Return value** | Type | Description | | --------------------- | ------------------------------------------------------------ | -| Promise\ | Promise used to return the [PixelMap](https://gitee.com/openharmony/docs/blob/master/en/application-dev/reference/apis/js-apis-image.md)>.| +| Promise\ | Promise used to return the [PixelMap](https://gitee.com/openharmony/docs/blob/master/en/application-dev/reference/apis/js-apis-image.md)>. | **Example** @@ -1111,7 +1111,7 @@ SystemCapability.BundleManager.BundleFramework | ----------- | ---------------------------------------- | ---- | ---------------------------------------- | | bundleName | string | Yes | Bundle name based on which the pixel map is to obtain. | | abilityName | string | Yes | Ability name based on which the pixel map is to obtain. | -| callback | AsyncCallback\ | Yes | Callback used to return the [PixelMap](https://gitee.com/openharmony/docs/blob/master/en/application-dev/reference/apis/js-apis-image.md)>.| +| callback | AsyncCallback\ | Yes | Callback used to return the [PixelMap](https://gitee.com/openharmony/docs/blob/master/en/application-dev/reference/apis/js-apis-image.md)>. | **Example** @@ -1147,14 +1147,14 @@ SystemCapability.BundleManager.BundleFramework | Name | Type | Mandatory | Description | | -------------- | ------ | ---- | ---------------------------------------- | | want | Want | Yes | Want that contains the bundle name. | -| extensionFlags | number | Yes | Extension ability information to be returned. The default value is **0**. The value must be greater than or equal to 0.| +| extensionFlags | number | Yes | Extension ability information to be returned. The default value is **0**. The value must be greater than or equal to 0. | | userId | number | No | User ID. The default value is the user ID of the caller. The value must be greater than or equal to 0. | **Return value** | Type | Description | | ------------------------------------- | ------------------------------ | -| Promise> | Promise used to return the Extension ability information.| +| Promise> | Promise used to return the Extension ability information. | **Example** @@ -1194,7 +1194,7 @@ SystemCapability.BundleManager.BundleFramework | Name | Type | Mandatory | Description | | -------------- | ---------------------------------------- | ---- | ---------------------------------------- | | want | Want | Yes | Want that contains the bundle name. | -| extensionFlags | number | Yes | Extension ability information to be returned. The default value is **0**. The value must be greater than or equal to 0.| +| extensionFlags | number | Yes | Extension ability information to be returned. The default value is **0**. The value must be greater than or equal to 0. | | userId | number | Yes | User ID. The default value is the user ID of the caller. The value must be greater than or equal to 0. | | callback | AsyncCallback> | Yes | Callback used to return the Extension ability information. | @@ -1235,7 +1235,7 @@ SystemCapability.BundleManager.BundleFramework | Name | Type | Mandatory | Description | | -------------- | ---------------------------------------- | ---- | ---------------------------------------- | | want | Want | Yes | Want that contains the bundle name. | -| extensionFlags | number | Yes | Extension ability information to be returned. The default value is **0**. The value must be greater than or equal to 0.| +| extensionFlags | number | Yes | Extension ability information to be returned. The default value is **0**. The value must be greater than or equal to 0. | | callback | AsyncCallback> | Yes | Callback used to return the Extension ability information. | **Example** @@ -1262,8 +1262,8 @@ bundle.queryExtensionAbilityInfosByWant(want, extensionFlags, (err, data) => { | Name | Readable/Writable| Type | Mandatory | Description | | ----------- | ---- | ------ | ---- | ---------------------------------------- | | deviceId | Read-only | string | No | ID of the device that runs the ability. | -| bundleName | Read-only | string | Yes | Bundle name of the ability. If both **bundleName** and **abilityName** are specified in a **Want**, the **Want** can directly match the specified ability.| -| abilityName | Read-only | string | Yes | Name of the ability. If both **bundleName** and **abilityName** are specified in a **Want**, the **Want** can directly match the specified ability.| +| bundleName | Read-only | string | Yes | Bundle name of the ability. If both **bundleName** and **abilityName** are specified in a **Want**, the **Want** can directly match the specified ability. | +| abilityName | Read-only | string | Yes | Name of the ability. If both **bundleName** and **abilityName** are specified in a **Want**, the **Want** can directly match the specified ability. | | uri | Read-only | string | No | Resource ID. | | shortName | Read-only | string | No | Short name of the **ElementName**. | @@ -1309,7 +1309,7 @@ Enumerates bundle flags. | GET_APPLICATION_INFO_WITH_PERMISSION | 0x00000008 | Obtains the application information with the permission information. | | GET_BUNDLE_WITH_REQUESTED_PERMISSION | 0x00000010 | Obtains the bundle information with the information about the required permissions. | | GET_ABILITY_INFO_WITH_METADATA8+ | 0x00000020 | Obtains the ability metadata information. | -| GET_BUNDLE_WITH_EXTENSION_ABILITY9+ | 0x00000020 | Obtains the bundle information with the Extension ability information.| +| GET_BUNDLE_WITH_EXTENSION_ABILITY9+ | 0x00000020 | Obtains the bundle information with the Extension ability information. | | GET_APPLICATION_INFO_WITH_METADATA8+ | 0x00000040 | Obtains the application metadata information. | | GET_ABILITY_INFO_SYSTEMAPP_ONLY8+ | 0x00000080 | Obtains the ability information of system applications.| | GET_ABILITY_INFO_WITH_DISABLE8+ | 0x00000100 | Obtains information about disabled abilities. | @@ -1324,7 +1324,7 @@ Describes the bundle options. | Name | Type | Readable | Writable | Description | | ------ | ------ | ---- | ---- | ---------------------------- | -| userId | number | Yes | Yes | User ID. The default value is the user ID of the caller. The value must be greater than or equal to 0.| +| userId | number | Yes | Yes | User ID. The default value is the user ID of the caller. The value must be greater than or equal to 0. | ## BundleInfo @@ -1343,7 +1343,7 @@ Describes the application bundle information. | appInfo | ApplicationInfo | Yes | No | Application configuration information. | | abilityInfos | Array\ | Yes | No | Ability configuration information. | | reqPermissions | Array\ | Yes | No | Array of the permissions to request from the system. | -| reqPermissionDetails | Array\ | Yes | No | Detailed information of the permissions to request from the system.| +| reqPermissionDetails | Array\ | Yes | No | Detailed information of the permissions to request from the system. | | vendor | string | Yes | No | Vendor of the bundle. | | versionCode | number | Yes | No | Version number of the bundle. | | versionName | string | Yes | No | Version description of the bundle. | @@ -1398,8 +1398,8 @@ Describes the module information of the application. | Name | Type | Readable | Writable | Description | | --------------- | ------ | ---- | ---- | ---- | -| moduleName | string | Yes | No | Module name.| -| moduleSourceDir | string | Yes | No | Installation directory.| +| moduleName | string | Yes | No | Module name. | +| moduleSourceDir | string | Yes | No | Installation directory. | ## CustomizeData @@ -1409,7 +1409,7 @@ Describes the custom metadata. | Name | Type | Readable | Writable | Description | | ------------------ | ------ | ---- | ---- | -------- | -| name | string | Yes | Yes | Custom metadata name.| +| name | string | Yes | Yes | Custom metadata name. | | value | string | Yes | Yes | Custom metadata value. | | extra8+ | string | Yes | Yes | Custom resources. | @@ -1438,7 +1438,7 @@ Describes the HAP module information. | mainAbilityName | string | Yes | No | Name of the entry ability. | | installationFree | boolean | Yes | No | Whether installation-free is supported. | | mainElementName9+ | string | Yes | No | Information about the entry ability. | -| extensionAbilityInfo9+ | Array\ | Yes | No | Extension ability information.| +| extensionAbilityInfo9+ | Array\ | Yes | No | Extension ability information. | | metadata9+ | Array\ | Yes | No | Metadata of the ability. | ## ReqPermissionDetail @@ -1451,7 +1451,7 @@ Describes the detailed information of the permissions to request from the system | --------- | --------- | ---- | ---- | ---------- | | name | string | Yes | Yes | Name of the permission to request. | | reason | string | Yes | Yes | Reason for requesting the permission. | -| usedScene | UsedScene | Yes | Yes | Application scenario and timing for using the permission.| +| usedScene | UsedScene | Yes | Yes | Application scenario and timing for using the permission. | ## UsedScene @@ -1461,7 +1461,7 @@ Describes the application scenario and timing for using the permission. | Name | Type | Readable | Writable | Description | | --------- | -------------- | ---- | ---- | ---------------- | -| abilities | Array\ | Yes | Yes | Abilities that use the permission.| +| abilities | Array\ | Yes | Yes | Abilities that use the permission. | | when | string | Yes | Yes | Time when the permission is used. | @@ -1481,7 +1481,7 @@ Describes the ability information. | descriptionId | number | Yes | No | Ability description ID. | | iconId | number | Yes | No | Ability icon ID. | | moduleName | string | Yes | No | Name of the HAP file to which the ability belongs. | -| process | string | Yes | No | Process in which this ability runs. If this parameter is not set, the bundle name is used by default.| +| process | string | Yes | No | Process in which this ability runs. If this parameter is not set, the bundle name is used by default. | | targetAbility | string | Yes | No | Target ability that the ability alias points to. | | backgroundModes | number | Yes | No | Background service mode of the ability. | | isVisible | boolean | Yes | No | Whether the ability can be called by other applications. | @@ -1489,7 +1489,7 @@ Describes the ability information. | type | AbilityType | Yes | No | Ability type. | | orientation | DisplayOrientation | Yes | No | Ability display orientation. | | launchMode | LaunchMode | Yes | No | Ability launch mode. | -| permissions | Array\ | Yes | No | Permissions required for other applications to call the ability.| +| permissions | Array\ | Yes | No | Permissions required for other applications to call the ability. | | deviceTypes | Array\ | Yes | No | Device types supported by the ability. | | deviceCapabilities | Array\ | Yes | No | Device capabilities required for the ability. | | readPermission | string | Yes | No | Permission required for reading the ability data. | @@ -1513,7 +1513,7 @@ Enumerates ability types. | UNKNOWN | None | Unknown ability type. | | PAGE | None | Ability that has a UI. | | SERVICE | None | Ability that does not have a UI. | -| DATA | None | Ability that is used to provide data access services.| +| DATA | None | Ability that is used to provide data access services. | ## DisplayOrientation @@ -1526,7 +1526,7 @@ Enumerates display orientations. | UNSPECIFIED | None | The system automatically determines the display orientation. | | LANDSCAPE | None | Landscape orientation. | | PORTRAIT | None | Portrait orientation. | -| FOLLOW_RECENT | None | The page ability orientation is the same as that of the nearest ability in the stack.| +| FOLLOW_RECENT | None | The page ability orientation is the same as that of the nearest ability in the stack. | ## LaunchMode @@ -1536,7 +1536,7 @@ Enumerates launch modes. | Name | Type | Description | | --------- | ---- | ------------- | -| SINGLETON | 0 | The ability has only one instance.| +| SINGLETON | 0 | The ability has only one instance. | | STANDARD | 1 | The ability can have multiple instances. | ## AbilitySubType @@ -1548,7 +1548,7 @@ Enumerates ability subtypes. | Name | Type | Description | | ----------- | ---- | -------------------- | | UNSPECIFIED | 0 | Undefined ability subtype. | -| CA | 1 | Ability that has a UI.| +| CA | 1 | Ability that has a UI. | ## ExtensionAbilityType9+ @@ -1560,12 +1560,12 @@ Enumerates Extension ability types. | Name | Type | Description | | ------------------------------ | ---- | ------------------------- | | FORM9+ | 0 | Form included. | -| WORK_SCHEDULER9+ | 1 | Work scheduler included.| +| WORK_SCHEDULER9+ | 1 | Work scheduler included. | | INPUT_METHOD9+ | 2 | Input method included. | | SERVICE9+ | 3 | Service included. | | ACCESSIBILITY9+ | 4 | Accessibility included. | -| DATA_SHARE9+ | 5 | Data sharing included.| -| FILE_SHARE9+ | 6 | File sharing included.| +| DATA_SHARE9+ | 5 | Data sharing included. | +| FILE_SHARE9+ | 6 | File sharing included. | | STATIC_SUBSCRIBER9+ | 7 | Subscribers included. | | WALLPAPER9+ | 8 | Wallpaper included. | | UNSPECIFIED9+ | 9 | Unspecified type. | @@ -1581,7 +1581,7 @@ Enumerates Extension flags. | GET_EXTENSION_INFO_DEFAULT9+ | 0x00000000 | Obtains the default Extension ability information. | | GET_EXTENSION_INFO_WITH_PERMISSION9+ | 0x00000002 | Obtains the Extension ability information that carries permission information. | | GET_EXTENSION_INFO_WITH_APPLICATION9+ | 0x00000004 | Obtains the Extension ability information that carries application information. | -| GET_EXTENSION_INFO_WITH_METADATA9+ | 0x00000020 | Obtains the Extension ability information that carries metadata information.| +| GET_EXTENSION_INFO_WITH_METADATA9+ | 0x00000020 | Obtains the Extension ability information that carries metadata information. | ## ColorMode @@ -1592,9 +1592,9 @@ Enumerates color modes. | Name | Type | Description | | ---------- | ---- | ---- | -| AUTO_MODE | -1 | Automatic mode.| -| DARK_MODE | 0 | Dark mode.| -| LIGHT_MODE | 1 | Light mode.| +| AUTO_MODE | -1 | Automatic mode. | +| DARK_MODE | 0 | Dark mode. | +| LIGHT_MODE | 1 | Light mode. | ## GrantStatus @@ -1605,7 +1605,7 @@ Enumerates permission grant states. | Name | Type | Description | | ------------------ | ---- | ---- | -| PERMISSION_DENIED | -1 | Permission denied.| +| PERMISSION_DENIED | -1 | Permission denied. | | PERMISSION_GRANTED | 0 | Permission granted. | @@ -1625,7 +1625,7 @@ Describes the Extension ability information. | iconId9+ | number | Yes | No | Icon ID of the Extension ability. | | isVisible9+ | boolean | Yes | No | Whether the Extension ability can be called by other applications. | | extensionAbilityType9+ | bundle.ExtensionAbilityType | Yes | No | Type of the Extension ability. | -| permissions9+ | Array\ | Yes | No | Permissions required for other applications to call the Extension ability.| +| permissions9+ | Array\ | Yes | No | Permissions required for other applications to call the Extension ability. | | applicationInfo9+ | ApplicationInfo | Yes | No | Application configuration information. | | metaData9+ | Array\ | Yes | No | Metadata of the Extension ability. | | enabled9+ | boolean | Yes | No | Whether the Extension ability is enabled. | @@ -1641,6 +1641,6 @@ Describes the metadata information. | Name | Type | Readable | Writable | Description | | --------------------- | ------ | ---- | ---- | ----- | -| name9+ | string | Yes | Yes | Metadata name.| +| name9+ | string | Yes | Yes | Metadata name. | | value9+ | string | Yes | Yes | Metadata value. | -| resource9+ | string | Yes | Yes | Metadata resource.| +| resource9+ | string | Yes | Yes | Metadata resource. | diff --git a/en/application-dev/reference/apis/js-apis-Context.md b/en/application-dev/reference/apis/js-apis-Context.md index bc7b0afa88f6e9ee253b8cd8af3a5ba6633ce8b6..62ab1faf7ec09a0323252ce17873d1aca9ba13f1 100644 --- a/en/application-dev/reference/apis/js-apis-Context.md +++ b/en/application-dev/reference/apis/js-apis-Context.md @@ -1,6 +1,6 @@ # Context Module -> ![icon-note.gif](public_sys-resources/icon-note.gif) **NOTE**
+> **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. ## Modules to Import @@ -30,9 +30,9 @@ If this API is called for the first time, a root directory will be created. **Parameters** -| Name | Type | Mandatory| Description | +| Name | Type | Mandatory | Description | | -------- | ---------------------- | ---- | -------------------------- | -| callback | AsyncCallback\ | Yes | Callback used to return the local root directory.| +| callback | AsyncCallback\ | Yes | Callback used to return the local root directory. | **Example** @@ -58,9 +58,9 @@ If this API is called for the first time, a root directory will be created. **Return value** -| Type | Description | +| Type | Description | | ---------------- | ---------------------- | -| Promise\ | Promise used to return the local root directory.| +| Promise\ | Promise used to return the local root directory. | **Example** @@ -84,11 +84,11 @@ Verifies whether a specific PID and UID have the given permission. This API uses **Parameters** -| Name | Type | Mandatory| Description | +| Name | Type | Mandatory | Description | | ---------- | --------------------------------------- | ---- | ------------------------------------- | -| permission | string | Yes | Name of the permission to verify. | -| options | [PermissionOptions](#permissionoptions) | Yes | Permission options. | -| callback | AsyncCallback\ | Yes | Callback used to return the permission verification result. The value **0** indicates that the PID and UID have the given permission, and the value **-1** indicates that the PID and UID do not have the given permission.| +| permission | string | Yes | Name of the permission to verify. | +| options | [PermissionOptions](#permissionoptions) | Yes | Permission options. | +| callback | AsyncCallback\ | Yes | Callback used to return the permission verification result. The value **0** indicates that the PID and UID have the given permission, and the value **-1** indicates that the PID and UID do not have the given permission. | **Example** @@ -113,10 +113,10 @@ Verifies whether the current PID and UID have the given permission. This API use **Parameters** -| Name | Type | Mandatory| Description | +| Name | Type | Mandatory | Description | | ---------- | ---------------------- | ---- | ------------------------------------- | -| permission | string | Yes | Name of the permission to verify. | -| callback | AsyncCallback\ | Yes | Callback used to return the permission verification result. The value **0** indicates that the PID and UID have the given permission, and the value **-1** indicates that the PID and UID do not have the given permission.| +| permission | string | Yes | Name of the permission to verify. | +| callback | AsyncCallback\ | Yes | Callback used to return the permission verification result. The value **0** indicates that the PID and UID have the given permission, and the value **-1** indicates that the PID and UID do not have the given permission. | **Example** @@ -136,16 +136,16 @@ Verifies whether a specific PID and UID have the given permission. This API uses **Parameters** -| Name | Type | Mandatory| Description | +| Name | Type | Mandatory | Description | | ---------- | --------------------------------------- | ---- | ---------------- | -| permission | string | Yes | Name of the permission to verify.| -| options | [PermissionOptions](#permissionoptions) | No | Permission options. | +| permission | string | Yes | Name of the permission to verify. | +| options | [PermissionOptions](#permissionoptions) | No | Permission options. | **Return value** -| Type | Description | +| Type | Description | | ---------------- | ----------------------------------------------------------- | -| Promise\ | Promise used to return the permission verification result. The value **0** indicates that the PID and UID have the given permission, and the value **-1** indicates that the PID and UID do not have the given permission.| +| Promise\ | Promise used to return the permission verification result. The value **0** indicates that the PID and UID have the given permission, and the value **-1** indicates that the PID and UID do not have the given permission. | **Example** @@ -171,11 +171,11 @@ Requests certain permissions from the system. This API uses an asynchronous call **Parameters** -| Name | Type | Mandatory| Description | +| Name | Type | Mandatory | Description | | -------------- | ------------------------------------------------------------ | ---- | ----------------------------------------------- | -| permissions | Array\ | Yes | Permissions to request. This parameter cannot be **null**. | -| requestCode | number | Yes | Request code to be passed to **PermissionRequestResult**.| -| resultCallback | AsyncCallback<[PermissionRequestResult](#permissionrequestresult)> | Yes | Permission request result. | +| permissions | Array\ | Yes | Permissions to request. This parameter cannot be **null**. | +| requestCode | number | Yes | Request code to be passed to **PermissionRequestResult**. | +| resultCallback | AsyncCallback<[PermissionRequestResult](#permissionrequestresult)> | Yes | Permission request result. | **Example** @@ -207,9 +207,9 @@ Obtains information about the current application. This API uses an asynchronous **Parameters** -| Name | Type | Mandatory| Description | +| Name | Type | Mandatory | Description | | -------- | ------------------------------- | ---- | ------------------------ | -| callback | AsyncCallback\ | Yes | Callback used to return the application information.| +| callback | AsyncCallback\ | Yes | Callback used to return the application information. | **Example** @@ -231,9 +231,9 @@ Obtains information about the current application. This API uses a promise to re **Return value** -| Type | Description | +| Type | Description | | ------------------------- | ------------------ | -| Promise\ | Promise used to return the application information.| +| Promise\ | Promise used to return the application information. | **Example** @@ -258,9 +258,9 @@ Obtains the bundle name of the current ability. This API uses an asynchronous ca **Parameters** -| Name | Type | Mandatory| Description | +| Name | Type | Mandatory | Description | | -------- | ---------------------- | ---- | ----------------------------- | -| callback | AsyncCallback\ | Yes | Callback used to return the bundle name.| +| callback | AsyncCallback\ | Yes | Callback used to return the bundle name. | **Example** @@ -282,9 +282,9 @@ Obtains the bundle name of the current ability. This API uses a promise to retur **Return value** -| Type | Description | +| Type | Description | | ---------------- | ------------------------- | -| Promise\ | Promise used to return the bundle name.| +| Promise\ | Promise used to return the bundle name. | **Example** @@ -309,9 +309,9 @@ Obtains information about the current process, including the PID and process nam **Parameters** -| Name | Type | Mandatory| Description | +| Name | Type | Mandatory | Description | | -------- | --------------------------- | ---- | -------------------- | -| callback | AsyncCallback\ | Yes | Callback used to return the process information.| +| callback | AsyncCallback\ | Yes | Callback used to return the process information. | **Example** @@ -333,9 +333,9 @@ Obtains information about the current process, including the PID and process nam **Return value** -| Type | Description | +| Type | Description | | --------------------- | -------------- | -| Promise\ | Promise used to return the process information.| +| Promise\ | Promise used to return the process information. | **Example** @@ -362,9 +362,9 @@ This API is available only to Page abilities. **Parameters** -| Name | Type | Mandatory| Description | +| Name | Type | Mandatory | Description | | -------- | --------------------------- | ---- | ---------------------------------------------- | -| callback | AsyncCallback\ | Yes | Callback used to return the **ohos.bundle.ElementName** object.| +| callback | AsyncCallback\ | Yes | Callback used to return the **ohos.bundle.ElementName** object. | **Example** @@ -388,9 +388,9 @@ This API is available only to Page abilities. **Return value** -| Type | Description | +| Type | Description | | --------------------- | ------------------------------------------ | -| Promise\ | Promise used to return the **ohos.bundle.ElementName** object.| +| Promise\ | Promise used to return the **ohos.bundle.ElementName** object. | **Example** @@ -413,9 +413,9 @@ Obtains the name of the current process. This API uses an asynchronous callback **Parameters** -| Name | Type | Mandatory| Description | +| Name | Type | Mandatory | Description | | -------- | ---------------------- | ---- | -------------------- | -| callback | AsyncCallback\ | Yes | Callback used to return the process name.| +| callback | AsyncCallback\ | Yes | Callback used to return the process name. | **Example** @@ -437,9 +437,9 @@ Obtains the name of the current process. This API uses a promise to return the r **Return value** -| Type | Description | +| Type | Description | | ---------------- | -------------------- | -| Promise\ | Promise used to return the process name.| +| Promise\ | Promise used to return the process name. | **Example** @@ -464,9 +464,9 @@ Obtains the bundle name of the calling ability. This API uses an asynchronous ca **Parameters** -| Name | Type | Mandatory| Description | +| Name | Type | Mandatory | Description | | -------- | ---------------------- | ---- | ------------------------- | -| callback | AsyncCallback\ | Yes | Callback used to return the bundle name.| +| callback | AsyncCallback\ | Yes | Callback used to return the bundle name. | **Example** @@ -488,9 +488,9 @@ Obtains the bundle name of the calling ability. This API uses a promise to retur **Return value** -| Type | Description | +| Type | Description | | --------------- | ------------------------- | -| Promise\ | Promise used to return the bundle name.| +| Promise\ | Promise used to return the bundle name. | **Example** @@ -513,9 +513,9 @@ Obtains the cache directory of the application on the internal storage. This API **Parameters** -| Name | Type | Mandatory| Description | +| Name | Type | Mandatory | Description | | -------- | ---------------------- | ---- | ------------------------- | -| callback | AsyncCallback\ | Yes | Callback used to return the cache directory.| +| callback | AsyncCallback\ | Yes | Callback used to return the cache directory. | **Example** @@ -541,9 +541,9 @@ Obtains the cache directory of the application on the internal storage. This API **Return value** -| Type | Description | +| Type | Description | | --------------- | ------------------------- | -| Promise\ | Promise used to return the cache directory.| +| Promise\ | Promise used to return the cache directory. | **Example** @@ -566,9 +566,9 @@ Obtains the file directory of the application on the internal storage. This API **Parameters** -| Name | Type | Mandatory| Description | +| Name | Type | Mandatory | Description | | -------- | ---------------------- | ---- | ------------------------- | -| callback | AsyncCallback\ | Yes | Callback used to return the file directory.| +| callback | AsyncCallback\ | Yes | Callback used to return the file directory. | **Example** @@ -594,9 +594,9 @@ Obtains the file directory of the application on the internal storage. This API **Return value** -| Type | Description | +| Type | Description | | --------------- | ------------------------- | -| Promise\ | Promise used to return the file directory.| +| Promise\ | Promise used to return the file directory. | **Example** @@ -621,9 +621,9 @@ If the distributed file path does not exist, the system will create one and retu **Parameters** -| Name | Type | Mandatory| Description | +| Name | Type | Mandatory | Description | | -------- | ---------------------- | ---- | ------------------------- | -| callback | AsyncCallback\ | Yes | Callback used to return the distributed file path. If the distributed file path does not exist, the system will create one and return the created path.| +| callback | AsyncCallback\ | Yes | Callback used to return the distributed file path. If the distributed file path does not exist, the system will create one and return the created path. | **Example** @@ -651,9 +651,9 @@ If the distributed file path does not exist, the system will create one and retu **Return value** -| Type | Description | +| Type | Description | | --------------- | ------------------------- | -| Promise\ | Promise used to return the distributed file path. If this API is called for the first time, a new path will be created.| +| Promise\ | Promise used to return the distributed file path. If this API is called for the first time, a new path will be created. | **Example** @@ -675,9 +675,9 @@ Obtains the application type. This API uses an asynchronous callback to return t **Parameters** -| Name | Type | Mandatory| Description | +| Name | Type | Mandatory | Description | | -------- | ---------------------- | ---- | ------------------------- | -| callback | AsyncCallback\ | Yes | Callback used to return the application type.| +| callback | AsyncCallback\ | Yes | Callback used to return the application type. | **Example** @@ -703,9 +703,9 @@ Obtains the application type. This API uses a promise to return the result. **Return value** -| Type | Description | +| Type | Description | | --------------- | ------------------------- | -| Promise\ | Promise used to return the application type.| +| Promise\ | Promise used to return the application type. | **Example** @@ -727,9 +727,9 @@ Obtains the **ModuleInfo** object of the application. This API uses an asynchron **Parameters** -| Name | Type | Mandatory| Description | +| Name | Type | Mandatory | Description | | -------- | ---------------------- | ---- | ------------------------- | -| callback | AsyncCallback\<[HapModuleInfo](#hapmoduleinfo)> | Yes | Callback used to return the **ModuleInfo** object.| +| callback | AsyncCallback\<[HapModuleInfo](#hapmoduleinfo)> | Yes | Callback used to return the **ModuleInfo** object. | **Example** @@ -755,9 +755,9 @@ Obtains the **ModuleInfo** object of the application. This API uses a promise to **Return value** -| Type | Description | +| Type | Description | | --------------- | ------------------------- | -| Promise\<[HapModuleInfo](#hapmoduleinfo)> | Promise used to return the **ModuleInfo** object.| +| Promise\<[HapModuleInfo](#hapmoduleinfo)> | Promise used to return the **ModuleInfo** object. | **Example** @@ -779,9 +779,9 @@ Obtains the version information of the application. This API uses an asynchronou **Parameters** -| Name | Type | Mandatory| Description | +| Name | Type | Mandatory | Description | | -------- | ---------------------- | ---- | ------------------------- | -| callback | AsyncCallback\<[AppVersionInfo](#appversioninfo)> | Yes | Callback used to return the version information.| +| callback | AsyncCallback\<[AppVersionInfo](#appversioninfo)> | Yes | Callback used to return the version information. | **Example** @@ -807,9 +807,9 @@ Obtains the version information of the application. This API uses a promise to r **Return value** -| Type | Description | +| Type | Description | | --------------- | ------------------------- | -| Promise\<[AppVersionInfo](#appversioninfo)> | Promise used to return the version information.| +| Promise\<[AppVersionInfo](#appversioninfo)> | Promise used to return the version information. | **Example** @@ -831,9 +831,9 @@ Obtains information of the current ability. This API uses an asynchronous callba **Parameters** -| Name | Type | Mandatory| Description | +| Name | Type | Mandatory | Description | | -------- | ---------------------- | ---- | ------------------------- | -| callback | AsyncCallback\<[AbilityInfo](#abilityInfo)> | Yes |Callback used to return the ability information.| +| callback | AsyncCallback\<[AbilityInfo](#abilityInfo)> | Yes |Callback used to return the ability information. | **Example** @@ -859,9 +859,9 @@ Obtains information of the current ability. This API uses a promise to return th **Return value** -| Type | Description | +| Type | Description | | --------------- | ------------------------- | -| Promise\<[AbilityInfo](#abilityInfo)> | Promise used to return the ability information.| +| Promise\<[AbilityInfo](#abilityInfo)> | Promise used to return the ability information. | **Example** @@ -883,9 +883,9 @@ Obtains the context of the application. **Return value** -| Type | Description | +| Type | Description | | --------- |------ | -| Context |Application context.| +| Context |Application context. | **Example** @@ -898,48 +898,48 @@ var context = featureAbility.getContext().getApplicationContext(); **System capability**: SystemCapability.Ability.AbilityRuntime.Core -| Name| Readable/Writable| Type | Mandatory| Description | +| Name| Readable/Writable | Type | Mandatory | Description | | ---- | -------- | ------ | ---- | ------ | -| pid | Read-only | number | No | Process ID.| -| uid | Read-only | number | No | User ID.| +| pid | Read-only | number | No | Process ID. | +| uid | Read-only | number | No | User ID. | ## PermissionRequestResult7+ **System capability**: SystemCapability.Ability.AbilityRuntime.Core -| Name | Readable/Writable| Type | Mandatory| Description | +| Name | Readable/Writable | Type | Mandatory | Description | | ----------- | -------- | -------------- | ---- | ------------------ | -| requestCode | Read-only | number | Yes | Request code passed.| -| permissions | Read-only | Array\ | Yes | Permissions requested. | -| authResults | Read-only | Array\ | Yes | Permission request result. | +| requestCode | Read-only | number | Yes | Request code passed. | +| permissions | Read-only | Array\ | Yes | Permissions requested. | +| authResults | Read-only | Array\ | Yes | Permission request result. | ## HapModuleInfo7+ Describes the HAP module information. -| Name | Type| Readable| Writable| Description| +| Name | Type| Readable | Writable | Description | | ------ | ------ | ------ | ------ | ------ | -| name | string | Yes | No | Module name. | -| description | string | Yes | No | Module description. | -| descriptionId | number | Yes | No | Module description ID. | -| icon | string | Yes | No | Module icon. | -| label | string | Yes | No | Module label. | -| labelId | number | Yes | No | Module label ID. | -| iconId | number | Yes | No | Module icon ID. | -| backgroundImg | string | Yes | No | Module background image. | -| supportedModes | number | Yes | No | Modes supported by the module. | -| reqCapabilities | Array | Yes | No | Capabilities required for module running.| -| deviceTypes | Array | Yes | No | An array of supported device types.| -| abilityInfo | Array | Yes | No | Ability information. | -| moduleName | string | Yes | No | Module name. | -| mainAbilityName | string | Yes | No | Name of the entrance ability. | -| installationFree | boolean | Yes | No | When installation-free is supported. | -| mainElementName | string | Yes| No| Information about the entry ability.| +| name | string | Yes | No | Module name. | +| description | string | Yes | No | Module description. | +| descriptionId | number | Yes | No | Module description ID. | +| icon | string | Yes | No | Module icon. | +| label | string | Yes | No | Module label. | +| labelId | number | Yes | No | Module label ID. | +| iconId | number | Yes | No | Module icon ID. | +| backgroundImg | string | Yes | No | Module background image. | +| supportedModes | number | Yes | No | Modes supported by the module. | +| reqCapabilities | Array | Yes | No | Capabilities required for module running. | +| deviceTypes | Array | Yes | No | An array of supported device types. | +| abilityInfo | Array | Yes | No | Ability information. | +| moduleName | string | Yes | No | Module name. | +| mainAbilityName | string | Yes | No | Name of the entrance ability. | +| installationFree | boolean | Yes | No | When installation-free is supported. | +| mainElementName | string | Yes| No| Information about the entry ability. | ## AppVersionInfo7+ -| Name | Type| Readable | Writable | Description| -| ------ | ------ | ------| ------ | ------ | -| appName | string | Yes | No | Module name. | -| versionCode | number | Yes | No | Module description. | -| versionName | string | Yes | No | Module description ID. | +| Name | Type| Readable | Writable | Description | +| ------ | ------ | ------| ------ | ------ | +| appName | string | Yes | No | Module name. | +| versionCode | number | Yes | No | Module description. | +| versionName | string | Yes | No | Module description ID. | diff --git a/en/application-dev/reference/apis/js-apis-DataUriUtils.md b/en/application-dev/reference/apis/js-apis-DataUriUtils.md index 267ba0d27b3fbf9e3b35a8dbb884da04286f5729..1434ebb8d645af7ae531374769b8534bd5de0910 100644 --- a/en/application-dev/reference/apis/js-apis-DataUriUtils.md +++ b/en/application-dev/reference/apis/js-apis-DataUriUtils.md @@ -1,6 +1,6 @@ # DataUriUtils Module -> ![icon-note.gif](public_sys-resources/icon-note.gif) **NOTE** +> **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 @@ -19,15 +19,15 @@ Obtains the ID attached to the end of a given URI. **Parameters** -| Name| Type | Mandatory| Description | +| Name | Type | Mandatory | Description | | ---- | ------ | ---- | --------------------------- | -| uri | string | Yes | URI object from which the ID is to be obtained.| +| uri | string | Yes | URI object from which the ID is to be obtained. | **Return value** -| Type | Description | +| Type | Description | | ------ | ------------------------ | -| number | ID obtained from the URI object.| +| number | ID obtained from the URI object. | **Example** @@ -47,16 +47,16 @@ Attaches an ID to the end of a given URI. **Parameters** -| Name| Type | Mandatory| Description | +| Name | Type | Mandatory | Description | | ---- | ------ | ---- | --------------------------- | -| uri | string | Yes | URI object to which an ID is to be attached.| -| id | number | Yes | ID to be attached. | +| uri | string | Yes | URI object to which an ID is to be attached. | +| id | number | Yes | ID to be attached. | **Return value** -| Type | Description | +| Type | Description | | ------ | --------------------- | -| string | URI object with the ID attached.| +| string | URI object with the ID attached. | **Example** @@ -80,15 +80,15 @@ Deletes the ID from the end of a given URI. **Parameters** -| Name| Type | Mandatory| Description | +| Name | Type | Mandatory | Description | | ---- | ------ | ---- | --------------------------- | -| uri | string | Yes | URI object from which the ID is to be deleted.| +| uri | string | Yes | URI object from which the ID is to be deleted. | **Return value** -| Type | Description | +| Type | Description | | ------ | ------------------- | -| string | URI object with the ID deleted.| +| string | URI object with the ID deleted. | **Example** @@ -108,16 +108,16 @@ Updates the ID in a given URI. **Parameters** -| Name| Type | Mandatory| Description | +| Name | Type | Mandatory | Description | | ---- | ------ | ---- | ------------------- | -| uri | string | Yes | URI object to be updated.| -| id | number | Yes | New ID. | +| uri | string | Yes | URI object to be updated. | +| id | number | Yes | New ID. | **Return value** -| Type | Description | +| Type | Description | | ------ | --------------- | -| string | URI object with the new ID.| +| string | URI object with the new ID. | **Example** diff --git a/en/application-dev/reference/apis/js-apis-WorkSchedulerExtensionAbility.md b/en/application-dev/reference/apis/js-apis-WorkSchedulerExtensionAbility.md index 9db4123736ac6f7a03605c931713076e13f7d2c6..59f2b5f535283e04d6f1b499ee4e9e733f204da8 100644 --- a/en/application-dev/reference/apis/js-apis-WorkSchedulerExtensionAbility.md +++ b/en/application-dev/reference/apis/js-apis-WorkSchedulerExtensionAbility.md @@ -1,6 +1,6 @@ # Work Scheduler Callbacks -> ![icon-note.gif](public_sys-resources/icon-note.gif) **NOTE**
+> **NOTE**
> The initial APIs of this module are supported since API version 9. API version 9 is a canary version for trial use. The APIs of this version may be unstable. @@ -20,9 +20,9 @@ Triggered when the Work Scheduler task starts. **Parameters** -| Name | Type | Mandatory | Description | +| Name | Type | Mandatory | Description | | ---- | --------------------- | ---- | -------------- | -| work | [workScheduler.WorkInfo](js-apis-workScheduler.md#workinfo) | Yes | Task to be added to the execution queue.| +| work | [workScheduler.WorkInfo](js-apis-workScheduler.md#workinfo) | Yes | Task to be added to the execution queue.| **Example** @@ -44,9 +44,9 @@ Triggered when the Work Scheduler task stops. **Parameters** -| Name | Type | Mandatory | Description | +| Name | Type | Mandatory | Description | | ---- | --------------------- | ---- | -------------- | -| work | [workScheduler.WorkInfo](js-apis-workScheduler.md#workinfo) | Yes | Task to be added to the execution queue.| +| work | [workScheduler.WorkInfo](js-apis-workScheduler.md#workinfo) | Yes | Task to be added to the execution queue.| **Example** diff --git a/en/application-dev/reference/apis/js-apis-ability-context.md b/en/application-dev/reference/apis/js-apis-ability-context.md index efab6fdd1273d247e6b95c5c5f6bc422abfcef96..b938552925150af55ec98375d48af7d9c4a78e54 100644 --- a/en/application-dev/reference/apis/js-apis-ability-context.md +++ b/en/application-dev/reference/apis/js-apis-ability-context.md @@ -1,6 +1,6 @@ # AbilityContext -> ![icon-note.gif](public_sys-resources/icon-note.gif) **NOTE**
+> **NOTE**
> The initial APIs of this module are supported since API version 9. Newly added APIs will be marked with a superscript to indicate their earliest API version. @@ -28,7 +28,7 @@ class MainAbility extends Ability { **System capability**: SystemCapability.Ability.AbilityRuntime.Core -| Name| Type| Readable| Writable| Description| +| Name | Type | Readable | Writable | Description | | -------- | -------- | -------- | -------- | -------- | | abilityInfo | AbilityInfo | Yes| No| Ability information.| | currentHapModuleInfo | HapModuleInfo | Yes| No| Information about the current HAP.| @@ -44,7 +44,7 @@ Starts an ability. This API uses a callback to return the result. **Parameters** - | Name| Type| Mandatory| Description| + | Name | Type | Mandatory | Description | | -------- | -------- | -------- | -------- | | want | [Want](js-apis-application-Want.md) | Yes| Information about the **Want** used for starting an ability.| | callback | AsyncCallback<void> | Yes| Callback used to return the result.| @@ -73,7 +73,7 @@ Starts an ability. This API uses a callback to return the result. **Parameters** - | Name| Type| Mandatory| Description| + | Name | Type | Mandatory | Description | | -------- | -------- | -------- | -------- | | want | [Want](js-apis-application-Want.md) | Yes| Information about the **Want** used for starting an ability.| | options | StartOptions | Yes| Parameters used for starting the ability.| @@ -106,14 +106,14 @@ Starts an ability. This API uses a promise to return the result. **Parameters** - | Name| Type| Mandatory| Description| + | Name | Type | Mandatory | Description | | -------- | -------- | -------- | -------- | | want | [Want](js-apis-application-Want.md) | Yes| Information about the **Want** used for starting an ability.| | options | StartOptions | No| Parameters used for starting the ability.| **Return value** - | Type| Description| + | Type | Description | | -------- | -------- | | Promise<void> | Promise used to return the result.| @@ -147,7 +147,7 @@ Starts an ability. This API uses a callback to return the execution result when **Parameters** - | Name| Type| Mandatory| Description| + | Name | Type | Mandatory | Description | | -------- | -------- | -------- | -------- | | want |[Want](js-apis-application-Want.md) | Yes| Information about the **Want** used for starting an ability.| | callback | AsyncCallback<[AbilityResult](js-apis-featureAbility.md#abilityresult)> | Yes| Callback used to return the result.| @@ -175,7 +175,7 @@ Starts an ability. This API uses a callback to return the execution result when **Parameters** - | Name| Type| Mandatory| Description| + | Name | Type | Mandatory | Description | | -------- | -------- | -------- | -------- | | want |[Want](js-apis-application-Want.md) | Yes| Information about the **Want** used for starting an ability.| | options | StartOptions | Yes| Parameters used for starting the ability.| @@ -208,7 +208,7 @@ Starts an ability. This API uses a promise to return the execution result when t **Parameters** - | Name| Type| Mandatory| Description| + | Name | Type | Mandatory | Description | | -------- | -------- | -------- | -------- | | want | [Want](js-apis-application-Want.md) | Yes| Information about the **Want** used for starting an ability.| | options | StartOptions | No| Parameters used for starting the ability.| @@ -216,7 +216,7 @@ Starts an ability. This API uses a promise to return the execution result when t **Return value** - | Type| Description| + | Type | Description | | -------- | -------- | | Promise<[AbilityResult](js-apis-featureAbility.md#abilityresult)> | Promise used to return the result.| @@ -244,7 +244,7 @@ Terminates this ability. This API uses a callback to return the result. **Parameters** - | Name| Type| Mandatory| Description| + | Name | Type | Mandatory | Description | | -------- | -------- | -------- | -------- | | callback | AsyncCallback<void> | Yes| Callback used to return the result indicating whether the API is successfully called.| @@ -267,7 +267,7 @@ Terminates this ability. This API uses a promise to return the result. **Return value** - | Type| Description| + | Type | Description | | -------- | -------- | | Promise<void> | Promise used to return the result indicating whether the API is successfully called.| @@ -292,7 +292,7 @@ Terminates this ability. This API uses a callback to return the information to t **Parameters** - | Name| Type| Mandatory| Description| + | Name | Type | Mandatory | Description | | -------- | -------- | -------- | -------- | | parameter | [AbilityResult](js-apis-featureAbility.md#abilityresult) | Yes| Information returned to the caller.| | callback | AsyncCallback<void> | Yes| Callback used to return the result.| @@ -321,13 +321,13 @@ Terminates this ability. This API uses a promise to return information to the ca **Parameters** - | Name| Type| Mandatory| Description| + | Name | Type | Mandatory | Description | | -------- | -------- | -------- | -------- | | parameter | [AbilityResult](js-apis-featureAbility.md#abilityresult) | Yes| Information returned to the caller.| **Return value** - | Type| Description| + | Type | Description | | -------- | -------- | | Promise<void> | Promise used to return the result.| @@ -355,13 +355,13 @@ Obtains the caller interface of the specified ability, and if the specified abil **Parameters** - | Name| Type| Mandatory| Description| + | Name | Type | Mandatory | Description | | -------- | -------- | -------- | -------- | | want | [Want](js-apis-application-Want.md) | Yes| Information about the ability to start, including the ability name, bundle name, and device ID. If the device ID is left blank or the default value is used, the local ability will be started.| **Return value** - | Type| Description| + | Type | Description | | -------- | -------- | | Promise<Caller> | Promise used to return the caller object to communicate with.| @@ -397,7 +397,7 @@ Requests permissions from the user by displaying a pop-up window. This API uses **Parameters** - | Name| Type| Mandatory| Description| + | Name | Type | Mandatory | Description | | -------- | -------- | -------- | -------- | | permissions | Array<string> | Yes| Permissions to request.| | callback | AsyncCallback<[PermissionRequestResult](js-apis-permissionrequestresult.md)> | Yes| Callback used to return the result indicating whether the API is successfully called.| @@ -421,13 +421,13 @@ Requests permissions from the user by displaying a pop-up window. This API uses **Parameters** - | Name| Type| Mandatory| Description| + | Name | Type | Mandatory | Description | | -------- | -------- | -------- | -------- | | permissions | Array<string> | Yes| Permissions to request.| **Return value** - | Type| Description| + | Type | Description | | -------- | -------- | | Promise<[PermissionRequestResult](js-apis-permissionrequestresult.md)> | Promise used to return the result indicating whether the API is successfully called.| @@ -452,7 +452,7 @@ Sets the label of the ability displayed in the task. This API uses a callback to **Parameters** - | Name| Type| Mandatory| Description| + | Name | Type | Mandatory | Description | | -------- | -------- | -------- | -------- | | label | string | Yes| Label of the ability to set.| | callback | AsyncCallback<void> | Yes| Callback used to return the result indicating whether the API is successfully called.| @@ -476,13 +476,13 @@ Sets the label of the ability displayed in the task. This API uses a promise to **Parameters** - | Name| Type| Mandatory| Description| + | Name | Type | Mandatory | Description | | -------- | -------- | -------- | -------- | | label | string | Yes| Label of the ability to set.| **Return value** - | Type| Description| + | Type | Description | | -------- | -------- | | Promise<void> | Promise used to return the result indicating whether the API is successfully called.| diff --git a/en/application-dev/reference/apis/js-apis-ability-errorCode.md b/en/application-dev/reference/apis/js-apis-ability-errorCode.md index e81e9d60f6bcf0d1b5f0376057f577c2b467f45d..d882c9b5ce0870438d9372a8470efcf5c5dad5b8 100644 --- a/en/application-dev/reference/apis/js-apis-ability-errorCode.md +++ b/en/application-dev/reference/apis/js-apis-ability-errorCode.md @@ -1,7 +1,7 @@ # ErrorCode -> ![icon-note.gif](public_sys-resources/icon-note.gif) **NOTE** +> **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. @@ -17,9 +17,9 @@ Defines the error code used when the ability is started. **System capability**: SystemCapability.Ability.AbilityRuntime.Core -| Name | Value | Description | +| Name | Value | Description | | ------------------------------ | ---- | ---------------------------------------- | -| NO_ERROR | 0 | No error occurs. | -| INVALID_PARAMETER | -1 | Invalid parameter.| -| ABILITY_NOT_FOUND | -2 | The ability is not found.| -| PERMISSION_DENY | -3 | Permission denied. | +| NO_ERROR | 0 | No error occurs. | +| INVALID_PARAMETER | -1 | Invalid parameter. | +| ABILITY_NOT_FOUND | -2 | The ability is not found. | +| PERMISSION_DENY | -3 | Permission denied. | diff --git a/en/application-dev/reference/apis/js-apis-ability-wantConstant.md b/en/application-dev/reference/apis/js-apis-ability-wantConstant.md index ef6e3e60018a4124ef5d917217599b520d550fe1..1190acad72e203ec1d42e7f2c4979938156bad50 100644 --- a/en/application-dev/reference/apis/js-apis-ability-wantConstant.md +++ b/en/application-dev/reference/apis/js-apis-ability-wantConstant.md @@ -1,7 +1,7 @@ # wantConstant -> ![icon-note.gif](public_sys-resources/icon-note.gif) **NOTE** +> **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. @@ -20,32 +20,32 @@ Lists the permissions. | Common Event Macro | Common Event Name | Subscriber Permission | | ------------ | ------------------ | ---------------------- | -| ACTION_HOME | ohos.want.action.home | None | -| ACTION_DIAL | ohos.want.action.dial | None | -| ACTION_SEARCH | ohos.want.action.search | None | -| ACTION_WIRELESS_SETTINGS | ohos.settings.wireless | None | -| ACTION_MANAGE_APPLICATIONS_SETTINGS | ohos.settings.manage.applications | None | -| ACTION_APPLICATION_DETAILS_SETTINGS | ohos.settings.application.details | None | -| ACTION_SET_ALARM | ohos.want.action.setAlarm | None | -| ACTION_SHOW_ALARMS | ohos.want.action.showAlarms | None | -| ACTION_SNOOZE_ALARM | ohos.want.action.snoozeAlarm | None | -| ACTION_DISMISS_ALARM | ohos.want.action.dismissAlarm | None | -| ACTION_DISMISS_TIMER | ohos.want.action.dismissTimer | None | -| ACTION_SEND_SMS | ohos.want.action.sendSms | None | -| ACTION_CHOOSE | ohos.want.action.choose | None | -| ACTION_IMAGE_CAPTURE8+ | ohos.want.action.imageCapture | None | -| ACTION_VIDEO_CAPTUR8+ | ohos.want.action.videoCapture | None | -| ACTION_SELECT | ohos.want.action.select | None | -| ACTION_SEND_DATA | ohos.want.action.sendData | None | -| ACTION_SEND_MULTIPLE_DATA | ohos.want.action.sendMultipleData | None | -| ACTION_SCAN_MEDIA_FILE | ohos.want.action.scanMediaFile | None | -| ACTION_VIEW_DATA | ohos.want.action.viewData | None | -| ACTION_EDIT_DATA | ohos.want.action.editData | None | -| INTENT_PARAMS_INTENT | ability.want.params.INTENT | None | -| INTENT_PARAMS_TITLE | ability.want.params.TITLE | None | -| ACTION_FILE_SELECT7+ | ohos.action.fileSelect | None | -| PARAMS_STREAM7+ | ability.params.stream | None | -| ACTION_APP_ACCOUNT_OAUTH 8+ | ohos.account.appAccount.action.oauth | None | +| ACTION_HOME | ohos.want.action.home | None | +| ACTION_DIAL | ohos.want.action.dial | None | +| ACTION_SEARCH | ohos.want.action.search | None | +| ACTION_WIRELESS_SETTINGS | ohos.settings.wireless | None | +| ACTION_MANAGE_APPLICATIONS_SETTINGS | ohos.settings.manage.applications | None | +| ACTION_APPLICATION_DETAILS_SETTINGS | ohos.settings.application.details | None | +| ACTION_SET_ALARM | ohos.want.action.setAlarm | None | +| ACTION_SHOW_ALARMS | ohos.want.action.showAlarms | None | +| ACTION_SNOOZE_ALARM | ohos.want.action.snoozeAlarm | None | +| ACTION_DISMISS_ALARM | ohos.want.action.dismissAlarm | None | +| ACTION_DISMISS_TIMER | ohos.want.action.dismissTimer | None | +| ACTION_SEND_SMS | ohos.want.action.sendSms | None | +| ACTION_CHOOSE | ohos.want.action.choose | None | +| ACTION_IMAGE_CAPTURE8+ | ohos.want.action.imageCapture | None | +| ACTION_VIDEO_CAPTUR8+ | ohos.want.action.videoCapture | None | +| ACTION_SELECT | ohos.want.action.select | None | +| ACTION_SEND_DATA | ohos.want.action.sendData | None | +| ACTION_SEND_MULTIPLE_DATA | ohos.want.action.sendMultipleData | None | +| ACTION_SCAN_MEDIA_FILE | ohos.want.action.scanMediaFile | None | +| ACTION_VIEW_DATA | ohos.want.action.viewData | None | +| ACTION_EDIT_DATA | ohos.want.action.editData | None | +| INTENT_PARAMS_INTENT | ability.want.params.INTENT | None | +| INTENT_PARAMS_TITLE | ability.want.params.TITLE | None | +| ACTION_FILE_SELECT7+ | ohos.action.fileSelect | None | +| PARAMS_STREAM7+ | ability.params.stream | None | +| ACTION_APP_ACCOUNT_OAUTH 8+ | ohos.account.appAccount.action.oauth | None | ## wantConstant.Entity @@ -56,12 +56,12 @@ Lists the permissions. | Common Event Macro | Common Event Name | Subscriber Permission | | ------------ | ------------------ | ---------------------- | -| ENTITY_DEFAULT | entity.system.default | None | -| ENTITY_HOME | entity.system.homel | None | -| ENTITY_VOICE | ENTITY_VOICE | None | -| ENTITY_BROWSABLE | entity.system.browsable | None | -| ENTITY_VIDEO | entity.system.video | None | -| ACTION_APPLICATION_DETAILS_SETTINGS | ohos.settings.application.details | None | +| ENTITY_DEFAULT | entity.system.default | None | +| ENTITY_HOME | entity.system.homel | None | +| ENTITY_VOICE | ENTITY_VOICE | None | +| ENTITY_BROWSABLE | entity.system.browsable | None | +| ENTITY_VIDEO | entity.system.video | None | +| ACTION_APPLICATION_DETAILS_SETTINGS | ohos.settings.application.details | None | ## flags @@ -70,19 +70,19 @@ Lists the permissions. | Name | Value | Description | | ------------------------------------ | ---------- | ------------------------------------------------------------ | -| FLAG_AUTH_READ_URI_PERMISSION | 0x00000001 | Indicates the permission to read the URI. | -| FLAG_AUTH_WRITE_URI_PERMISSION | 0x00000002 | Indicates the permission to write the URI. | -| FLAG_ABILITY_FORWARD_RESULT | 0x00000004 | Returns the result to the ability. | -| FLAG_ABILITY_CONTINUATION | 0x00000008 | Indicates whether the ability on the local device can be continued on a remote device. | -| FLAG_NOT_OHOS_COMPONENT | 0x00000010 | Indicates that a component does not belong to OHOS. | -| FLAG_ABILITY_FORM_ENABLED | 0x00000020 | Indicates that an ability is enabled. | -| FLAG_AUTH_PERSISTABLE_URI_PERMISSION | 0x00000040 | Indicates the permission to make the URI persistent. | -| FLAG_AUTH_PREFIX_URI_PERMISSION | 0x00000080 | Indicates the permission to verify URIs by prefix matching. | -| FLAG_ABILITYSLICE_MULTI_DEVICE | 0x00000100 | Supports cross-device startup in a distributed scheduler. | -| FLAG_START_FOREGROUND_ABILITY | 0x00000200 | Indicates that the Service ability is started regardless of whether the host application has been started. | -| FLAG_ABILITY_CONTINUATION_REVERSIBLE | 0x00000400 | Indicates that ability continuation is reversible. | -| FLAG_INSTALL_ON_DEMAND | 0x00000800 | Indicates that the specific ability will be installed if it has not been installed. | -| FLAG_INSTALL_WITH_BACKGROUND_MODE | 0x80000000 | Indicates that the specific ability will be installed in the background if it has not been installed. | -| FLAG_ABILITY_CLEAR_MISSION | 0x00008000 | Clears other operation missions. This flag can be set for the **Want** object in the **startAbility** API passed to [ohos.app.Context](js-apis-ability-context.md) and must be used together with **flag_ABILITY_NEW_MISSION**.| -| FLAG_ABILITY_NEW_MISSION | 0x10000000 | Indicates the operation of creating a mission on the history mission stack. | -| FLAG_ABILITY_MISSION_TOP | 0x20000000 | Starts the mission on the top of the existing mission stack; creates an ability instance if no mission exists.| +| FLAG_AUTH_READ_URI_PERMISSION | 0x00000001 | Indicates the permission to read the URI. | +| FLAG_AUTH_WRITE_URI_PERMISSION | 0x00000002 | Indicates the permission to write the URI. | +| FLAG_ABILITY_FORWARD_RESULT | 0x00000004 | Returns the result to the ability. | +| FLAG_ABILITY_CONTINUATION | 0x00000008 | Indicates whether the ability on the local device can be continued on a remote device. | +| FLAG_NOT_OHOS_COMPONENT | 0x00000010 | Indicates that a component does not belong to OHOS. | +| FLAG_ABILITY_FORM_ENABLED | 0x00000020 | Indicates that an ability is enabled. | +| FLAG_AUTH_PERSISTABLE_URI_PERMISSION | 0x00000040 | Indicates the permission to make the URI persistent. | +| FLAG_AUTH_PREFIX_URI_PERMISSION | 0x00000080 | Indicates the permission to verify URIs by prefix matching. | +| FLAG_ABILITYSLICE_MULTI_DEVICE | 0x00000100 | Supports cross-device startup in a distributed scheduler.| +| FLAG_START_FOREGROUND_ABILITY | 0x00000200 | Indicates that the Service ability is started regardless of whether the host application has been started. | +| FLAG_ABILITY_CONTINUATION_REVERSIBLE | 0x00000400 | Indicates that ability continuation is reversible. | +| FLAG_INSTALL_ON_DEMAND | 0x00000800 | Indicates that the specific ability will be installed if it has not been installed. | +| FLAG_INSTALL_WITH_BACKGROUND_MODE | 0x80000000 | Indicates that the specific ability will be installed in the background if it has not been installed. | +| FLAG_ABILITY_CLEAR_MISSION | 0x00008000 | Clears other operation missions. This flag can be set for the **Want** object in the **startAbility** API passed to [ohos.app.Context](js-apis-ability-context.md) and must be used together with **flag_ABILITY_NEW_MISSION**. | +| FLAG_ABILITY_NEW_MISSION | 0x10000000 | Indicates the operation of creating a mission on the history mission stack. | +| FLAG_ABILITY_MISSION_TOP | 0x20000000 | Starts the mission on the top of the existing mission stack; creates an ability instance if no mission exists. |