diff --git a/en/application-dev/IDL/idl-guidelines.md b/en/application-dev/IDL/idl-guidelines.md
index 102992de24a2879f9b08a5274058c2cdf4c0a280..7753e85d309ebbf350b7825a9ad3f76e3a3fcddf 100644
--- a/en/application-dev/IDL/idl-guidelines.md
+++ b/en/application-dev/IDL/idl-guidelines.md
@@ -62,7 +62,7 @@ sequenceable a.b..C.D
The preceding statement is parsed into the following code in the C++ header file:
```cpp
-#include "a/b/d.h"
+#include "a/b/d.h"
using C::D;
```
@@ -347,11 +347,10 @@ export default {
#### Calling Methods from the Client for IPC
-When the client calls **connectAbility()** to connect to a Service ability, the **onConnect** callback in **onAbilityConnectDone** of the client receives the **IRemoteObject** instance returned by the **onConnect()** method of the Service ability. The client and Service ability are in different applications. Therefore, the directory of the client application must contain a copy of the .idl file (the SDK automatically generates the proxy class). The **onConnect** callback then uses the **IRemoteObject** instance to create the **testProxy** instance of the **IdlTestServiceProxy** class and calls the related IPC method. The sample code is as follows:
+When the client calls **connectServiceExtensionAbility()** to connect to a Service ability, the **onConnect** callback in **onAbilityConnectDone** of the client receives the **IRemoteObject** instance returned by the **onConnect()** method of the Service ability. The client and Service ability are in different applications. Therefore, the directory of the client application must contain a copy of the .idl file (the SDK automatically generates the proxy class). The **onConnect** callback then uses the **IRemoteObject** instance to create the **testProxy** instance of the **IdlTestServiceProxy** class and calls the related IPC method. The sample code is as follows:
```ts
import IdlTestServiceProxy from './idl_test_service_proxy'
-import featureAbility from '@ohos.ability.featureAbility';
function callbackTestIntTransaction(result: number, ret: number): void {
if (result == 0 && ret == 124) {
@@ -396,13 +395,13 @@ var onAbilityConnectDone = {
}
};
-function connectAbility: void {
+function connectAbility(): void {
let want = {
bundleName: 'com.example.myapplicationidl',
abilityName: 'com.example.myapplicationidl.ServiceAbility'
};
let connectionId = -1;
- connectionId = featureAbility.connectAbility(want, onAbilityConnectDone);
+ connectionId = this.context.connectServiceExtensionAbility(want, onAbilityConnectDone);
}
diff --git a/en/application-dev/application-models/Readme-EN.md b/en/application-dev/application-models/Readme-EN.md
index ab82a4abae17e667670a2587b4016eee669abd26..7c320ef8068cd15bd0694f454c054b425d9841fd 100644
--- a/en/application-dev/application-models/Readme-EN.md
+++ b/en/application-dev/application-models/Readme-EN.md
@@ -61,7 +61,7 @@
- [Component Startup Rules (Stage Model)](component-startup-rules.md)
- Inter-Device Application Component Interaction (Continuation)
- [Continuation Overview](inter-device-interaction-hop-overview.md)
- - [Cross-Device Migration (for System Applications Only)](hop-cross-device-migration.md)
+ - [Cross-Device Migration](hop-cross-device-migration.md)
- [Multi-device Collaboration (for System Applications Only)](hop-multi-device-collaboration.md)
- [Subscribing to System Environment Variable Changes](subscribe-system-environment-variable-changes.md)
- Process Model
diff --git a/en/application-dev/application-models/accessibilityextensionability.md b/en/application-dev/application-models/accessibilityextensionability.md
index a76742c142bfccdd015665478aadbaedf19ff39e..94c4429c5b2a4b49ba4dbae48f813dce16bba68a 100644
--- a/en/application-dev/application-models/accessibilityextensionability.md
+++ b/en/application-dev/application-models/accessibilityextensionability.md
@@ -118,7 +118,12 @@ After developing the custom logic for an accessibility extension service, you mu
```
## Enabling or Disabling a Custom Accessibility Extension Service
-To enable or disable an accessibility extension service, run the following command:
+You can enable or disable a custom accessibility extension service through the command line interface or the device settings.
+
+**Method 1**: through the command line interface
+
+Run the **hdc shell** command, then the following system command:
+
- To enable the service: **accessibility enable -a AccessibilityExtAbility -b com.example.demo -c rg**
- To disable the service: **accessibility disable -a AccessibilityExtAbility -b com.example.demo**
@@ -126,3 +131,9 @@ In the preceding commands, **AccessibilityExtAbility** indicates the name of the
If the service is enabled or disabled successfully, the message "enable ability successfully" or "disable ability successfully" is displayed.
+
+ **Method 2**: through the device settings
+- From the device settings screen, access the list of installed extended services under accessibility.
+If an extended service is not installed, it is grayed out, and "No service" is displayed.
+- Select the target extended service, and toggle on or off the switch to enable or disable it.
+- If you opt to enable a service, a security reminder is displayed. Wait until the countdown ends and then select the check box indicating that you are aware of and willing to assume the listed risks.
diff --git a/en/application-dev/application-models/arkts-ui-widget-configuration.md b/en/application-dev/application-models/arkts-ui-widget-configuration.md
index ea9832f92d32dfe0c2a4160f3ac6f8e904d323fa..d86c3b6991460a25c0ea6a177a8aec8c4607364c 100644
--- a/en/application-dev/application-models/arkts-ui-widget-configuration.md
+++ b/en/application-dev/application-models/arkts-ui-widget-configuration.md
@@ -54,7 +54,7 @@ Widget-related configuration includes **FormExtensionAbility** configuration and
| formVisibleNotify | Whether the widget is allowed to use the widget visibility notification.| String| Yes (initial value: left empty)|
| metadata | Metadata of the widget. This field contains the array of the **customizeData** field.| Object| Yes (initial value: left empty)|
| dataProxyEnabled | Whether the widget supports the [update-through-proxy](./arkts-ui-widget-update-by-proxy.md) feature.) => void, thisArg?: Object)** to traverse the elements in this container.|
+| Accessing elements| Use **forEach(callbackFn: (value?: T, key?: T, set?: HashSet\) => void, thisArg?: Object)** to traverse the elements in this container.|
| Accessing elements| Use **\[Symbol.iterator]():IterableIterator<T>** for data access.|
-| Modifying elements| Use **forEach(callbackFn: (value?: T, key?: T, set?: HashSet) => void, thisArg?: Object)** to change a value in this container.|
+| Modifying elements| Use **forEach(callbackFn: (value?: T, key?: T, set?: HashSet\) => void, thisArg?: Object)** to change a value in this container.|
| Deleting elements| Use **remove(value: T)** to remove a value.|
| Deleting elements| Use **clear()** to clear this container.|
@@ -109,9 +109,9 @@ You are advised to use **TreeSet** when you need to store data in sorted order.
| Accessing elements| Use **entries()** to return an iterator that contains all the elements in this container.|
| Accessing elements| Use **getFirstValue()** to obtain the first value in this container.|
| Accessing elements| Use **getLastValue()** to obtain the last value in this container.|
-| Accessing elements| Use **forEach(callbackFn: (value?: T, key?: T, set?: TreeSet) => void, thisArg?: Object)** to traverse the elements in this container.|
+| Accessing elements| Use **forEach(callbackFn: (value?: T, key?: T, set?: TreeSet\) => void, thisArg?: Object)** to traverse the elements in this container.|
| Accessing elements| Use **\[Symbol.iterator]():IterableIterator<T>** for data access.|
-| Modifying elements| Use **forEach(callbackFn: (value?: T, key?: T, set?: TreeSet) => void, thisArg?: Object)** to change a value in this container.|
+| Modifying elements| Use **forEach(callbackFn: (value?: T, key?: T, set?: TreeSet\) => void, thisArg?: Object)** to change a value in this container.|
| Deleting elements| Use **remove(value: T)** to remove a value.|
| Deleting elements| Use **clear()** to clear this container.|
@@ -169,9 +169,9 @@ You are advised to use **LightWeightSet** when you need a set that has only uniq
| Accessing elements| Use **values()** to return an iterator that contains all the values in this container.|
| Accessing elements| Use **entries()** to return an iterator that contains all the elements in this container.|
| Accessing elements| Use **getValueAt(index: number)** to obtain the value of an element at a given position (specified by **index**).|
-| Accessing elements| Use **forEach(callbackFn: (value?: T, key?: T, set?: LightWeightSet) => void, thisArg?: Object)** to traverse the elements in this container.|
+| Accessing elements| Use **forEach(callbackFn: (value?: T, key?: T, set?: LightWeightSet\) => void, thisArg?: Object)** to traverse the elements in this container.|
| Accessing elements| Use **\[Symbol.iterator]():IterableIterator<T>** for data access.|
-| Modifying elements| Use **forEach(callbackFn: (value?: T, key?: T, set?: LightWeightSet) => void, thisArg?: Object)** to change a value in this container.|
+| Modifying elements| Use **forEach(callbackFn: (value?: T, key?: T, set?: LightWeightSet\) => void, thisArg?: Object)** to change a value in this container.|
| Deleting elements| Use **remove(key: K)** to remove an element with the specified key.|
| Deleting elements| Use **removeAt(index: number)** to remove an element at a given position (specified by **index**).|
| Deleting elements| Use **clear()** to clear this container.|
@@ -197,10 +197,10 @@ You are advised to use PlainArray when you need to store KV pairs whose keys are
| Accessing elements| Use **getIndexOfValue(value: T)** to obtain the index of the specified value.|
| Accessing elements| Use **getKeyAt(index: number)** to obtain the key of an element at a given position (specified by **index**).|
| Accessing elements| Use **getValueAt(index: number)** to obtain the value of an element at a given position (specified by **index**).|
-| Accessing elements| Use **forEach(callbackFn: (value: T, index?: number, PlainArray?: PlainArray) => void, thisArg?: Object)** to traverse the elements in this container.|
+| Accessing elements| Use **forEach(callbackFn: (value: T, index?: number, PlainArray?: PlainArray\) => void, thisArg?: Object)** to traverse the elements in this container.|
| Accessing elements| Use **\[Symbol.iterator]():IterableIterator<[number, T]>** for data access.|
| Modifying elements| Use **setValueAt(index:number, value: T)** to change the value of an element at a given position (specified by **index**).|
-| Modifying elements| Use **forEach(callbackFn: (value: T, index?: number, PlainArray?: PlainArray) => void, thisArg?: Object)** to modify an element in this container.|
+| Modifying elements| Use **forEach(callbackFn: (value: T, index?: number, PlainArray?: PlainArray\) => void, thisArg?: Object)** to modify an element in this container.|
| Deleting elements| Use **remove(key: number)** to remove an element with the specified key.|
| Deleting elements| Use **removeAt(index: number)** to remove an element at a given position (specified by **index**).|
| Deleting elements| Use **removeRangeFrom(index: number, size: number)** to remove elements in a specified range.|
diff --git a/en/application-dev/arkts-utils/xml-parsing.md b/en/application-dev/arkts-utils/xml-parsing.md
index dd3e46517b3eec6aafce6d6566a2da982bbd8d6c..89ed22585be75803b281517d390f400ceeda9d4d 100644
--- a/en/application-dev/arkts-utils/xml-parsing.md
+++ b/en/application-dev/arkts-utils/xml-parsing.md
@@ -4,7 +4,7 @@
Data transferred in XML format must be parsed in actual use. Generally, three types of elements need to be parsed, as described in [Parsing XML Tags and Tag Values](#parsing-xml-tags-and-tag-values), [Parsing XML Attributes and Attribute Values](#parsing-xml-attributes-and-attribute-values), and [Parsing XML Event Types and Element Depths](#parsing-xml-event-types-and-element-depths).
-The **xml** module provides the **XmlPullParser** class to parse XML files. The input is an object of the ArrayBufffer or DataView type containing XML text, and the output is the parsed information.
+The **xml** module provides the **XmlPullParser** class to parse XML files. The input is an object of the ArrayBuffer or DataView type containing XML text, and the output is the parsed information.
**Table 1** XML parsing options
diff --git a/en/application-dev/connectivity/Readme-EN.md b/en/application-dev/connectivity/Readme-EN.md
index c09ca21b6d0814bd1cd2cecb95b0d2896fada8c4..1a391bd7af03ae3c5d01eb01e14b66efd1f0c565 100755
--- a/en/application-dev/connectivity/Readme-EN.md
+++ b/en/application-dev/connectivity/Readme-EN.md
@@ -9,6 +9,8 @@
- [Ethernet Connection](net-ethernet.md)
- [Network Connection Management](net-connection-manager.md)
- [mDNS Management](net-mdns.md)
+ - [Traffic Management](net-statistics.md)
+ - [VPN Management](net-vpn.md)
- IPC & RPC
- [IPC & RPC Overview](ipc-rpc-overview.md)
- [IPC & RPC Development](ipc-rpc-development-guideline.md)
diff --git a/en/application-dev/connectivity/http-request.md b/en/application-dev/connectivity/http-request.md
index 1bb784cf96fb1d74dcbafed54498435f505814b6..a0fa4102864ba2403e7a6826f3ca3b872b5a80dd 100644
--- a/en/application-dev/connectivity/http-request.md
+++ b/en/application-dev/connectivity/http-request.md
@@ -1,6 +1,6 @@
# HTTP Data Request
-## When to Use
+## Overview
An application can initiate a data request over HTTP. Common HTTP methods include **GET**, **POST**, **OPTIONS**, **HEAD**, **PUT**, **DELETE**, **TRACE**, and **CONNECT**.
@@ -18,7 +18,7 @@ The following table provides only a simple description of the related APIs. For
| ----------------------------------------- | ----------------------------------- |
| createHttp() | Creates an HTTP request. |
| request() | Initiates an HTTP request to a given URL. |
-| request2()10+ | Initiates an HTTP network request based on the URL and returns a streaming response.|
+| requestInStream()10+ | Initiates an HTTP network request to a given URL and returns a streaming response.|
| destroy() | Destroys an HTTP request. |
| on(type: 'headersReceive') | Registers an observer for HTTP Response Header events. |
| off(type: 'headersReceive') | Unregisters the observer for HTTP Response Header events.|
@@ -27,8 +27,8 @@ The following table provides only a simple description of the related APIs. For
| off\('dataReceive'\)10+ | Unregisters the observer for events indicating receiving of HTTP streaming responses. |
| on\('dataEnd'\)10+ | Registers an observer for events indicating completion of receiving HTTP streaming responses. |
| off\('dataEnd'\)10+ | Unregisters the observer for events indicating completion of receiving HTTP streaming responses.|
-| on\('dataProgress'\)10+ | Registers an observer for events indicating progress of receiving HTTP streaming responses. |
-| off\('dataProgress'\)10+ | Unregisters the observer for events indicating progress of receiving HTTP streaming responses.|
+| on\('dataReceiveProgress'\)10+ | Registers an observer for events indicating progress of receiving HTTP streaming responses. |
+| off\('dataReceiveProgress'\)10+ | Unregisters the observer for events indicating progress of receiving HTTP streaming responses.|
## How to Develop request APIs
@@ -53,6 +53,7 @@ httpRequest.on('headersReceive', (header) => {
});
httpRequest.request(
// Customize EXAMPLE_URL in extraData on your own. It is up to you whether to add parameters to the URL.
+ "EXAMPLE_URL",
{
method: http.RequestMethod.POST, // Optional. The default value is http.RequestMethod.GET.
// You can add header fields based on service requirements.
@@ -81,7 +82,7 @@ httpRequest.request(
// Call the destroy() method to release resources after HttpRequest is complete.
httpRequest.destroy();
} else {
- console.info('error:' + JSON.stringify(err));
+ console.error('error:' + JSON.stringify(err));
// Unsubscribe from HTTP Response Header events.
httpRequest.off('headersReceive');
// Call the destroy() method to release resources after HttpRequest is complete.
@@ -91,12 +92,12 @@ httpRequest.request(
);
```
-## How to Develop request2 APIs
+## How to Develop requestInStream APIs
1. Import the **http** namespace from **@ohos.net.http.d.ts**.
2. Call **createHttp()** to create an **HttpRequest** object.
3. Depending on your need, call **on()** of the **HttpRequest** object to subscribe to HTTP response header events as well as events indicating receiving of HTTP streaming responses, progress of receiving HTTP streaming responses, and completion of receiving HTTP streaming responses.
-4. Call **request2()** to initiate a network request. You need to pass in the URL and optional parameters of the HTTP request.
+4. Call **requestInStream()** to initiate a network request. You need to pass in the URL and optional parameters of the HTTP request.
5. Parse the returned response code as needed.
6. Call **off()** of the **HttpRequest** object to unsubscribe from the related events.
7. Call **httpRequest.destroy()** to release resources after the request is processed.
@@ -122,11 +123,11 @@ httpRequest.on('dataEnd', () => {
console.info('No more data in response, data receive end');
});
// Subscribe to events indicating progress of receiving HTTP streaming responses.
-httpRequest.on('dataProgress', (data) => {
- console.log("dataProgress receiveSize:" + data.receiveSize + ", totalSize:" + data.totalSize);
+httpRequest.on('dataReceiveProgress', (data) => {
+ console.log("dataReceiveProgress receiveSize:" + data.receiveSize + ", totalSize:" + data.totalSize);
});
-httpRequest.request2(
+httpRequest.requestInStream(
// Customize EXAMPLE_URL in extraData on your own. It is up to you whether to add parameters to the URL.
"EXAMPLE_URL",
{
@@ -146,14 +147,14 @@ httpRequest.request2(
readTimeout: 60000, // Optional. The default value is 60000, in ms. If a large amount of data needs to be transmitted, you are advised to set this parameter to a larger value to ensure normal data transmission.
usingProtocol: http.HttpProtocol.HTTP1_1, // Optional. The default protocol type is automatically specified by the system.
}, (err, data) => {
- console.info('error:' + JSON.stringify(err));
+ console.error('error:' + JSON.stringify(err));
console.info('ResponseCode :' + JSON.stringify(data));
// Unsubscribe from HTTP Response Header events.
httpRequest.off('headersReceive');
// Unregister the observer for events indicating receiving of HTTP streaming responses.
httpRequest.off('dataReceive');
// Unregister the observer for events indicating progress of receiving HTTP streaming responses.
- httpRequest.off('dataProgress');
+ httpRequest.off('dataReceiveProgress');
// Unregister the observer for events indicating completion of receiving HTTP streaming responses.
httpRequest.off('dataEnd');
// Call the destroy() method to release resources after HttpRequest is complete.
@@ -161,10 +162,3 @@ httpRequest.request2(
}
);
```
-
-## Samples
-
-The following sample is provided to help you better understand how to develop the HTTP data request feature:
-
-- [`Http`: Data Request (ArkTS) (API9)](https://gitee.com/openharmony/applications_app_samples/tree/master/code/BasicFeature/Connectivity/Http)
-- [HTTP Communication (ArkTS) (API9)](https://gitee.com/openharmony/codelabs/tree/master/NetworkManagement/SmartChatEtsOH)
diff --git a/en/application-dev/connectivity/ipc-rpc-development-guideline.md b/en/application-dev/connectivity/ipc-rpc-development-guideline.md
index b9bbb0608dfb83ba6d2198b063e68c4b324bbd88..14016ef5da297361bd4a17a3d278357060590784 100644
--- a/en/application-dev/connectivity/ipc-rpc-development-guideline.md
+++ b/en/application-dev/connectivity/ipc-rpc-development-guideline.md
@@ -1,6 +1,6 @@
# IPC & RPC Development Guidelines
-## When to Use
+## Overview
IPC/RPC enables a proxy and a stub that run on different processes to communicate with each other, regardless of whether they run on the same or different devices.
diff --git a/en/application-dev/connectivity/net-connection-manager.md b/en/application-dev/connectivity/net-connection-manager.md
index c443c93759caddbc5203b65022426882c0bb960b..f3b945ab0970786000ab8b04adfe90592a11e0d1 100644
--- a/en/application-dev/connectivity/net-connection-manager.md
+++ b/en/application-dev/connectivity/net-connection-manager.md
@@ -1,10 +1,11 @@
# Network Connection Management
-## Introduction
+## Overview
The Network Connection Management module provides basic network management capabilities, including management of Wi-Fi/cellular/Ethernet connection priorities, network quality evaluation, subscription to network connection status changes, query of network connection information, and DNS resolution.
> **NOTE**
+>
> To maximize the application running efficiency, most API calls are called asynchronously in callback or promise mode. The following code examples use the callback mode. For details about the APIs, see [sms API Reference](../reference/apis/js-apis-net-connection.md).
## Basic Concepts
@@ -107,7 +108,7 @@ conn.on('netAvailable', (data => {
// Listen to network status change events. If the network is unavailable, an on_netUnavailable event is returned.
conn.on('netUnavailable', (data => {
- console.log("net is unavailable, netId is " + data.netId);
+ console.log("net is unavailable, data is " + JSON.stringify(data));
}));
// Register an observer for network status changes.
diff --git a/en/application-dev/connectivity/net-ethernet.md b/en/application-dev/connectivity/net-ethernet.md
index 18f20a7fd7e1a4c9516386c543c9521522df5f66..76ae1ee28078520b9d70796f71fd2b9236f47959 100644
--- a/en/application-dev/connectivity/net-ethernet.md
+++ b/en/application-dev/connectivity/net-ethernet.md
@@ -1,10 +1,11 @@
# Ethernet Connection
-## Introduction
+## Overview
The Ethernet Connection module allows a device to access the Internet through a network cable. After a device is connected to the Ethernet through a network cable, the device can obtain a series of network attributes, such as the dynamically allocated IP address, subnet mask, gateway, and DNS. You can manually configure and obtain the network attributes of the device in static mode.
> **NOTE**
+>
> To maximize the application running efficiency, most API calls are called asynchronously in callback or promise mode. The following code examples use the callback mode. For details about the APIs, see [sms API Reference](../reference/apis/js-apis-net-ethernet.md).
## **Constraints**
diff --git a/en/application-dev/connectivity/net-mdns.md b/en/application-dev/connectivity/net-mdns.md
index de7982a5c03908a70e4005bdc5fbea3584c435f5..75da959da8c4b1fc55aa0afca1cf0dcd945b86bb 100644
--- a/en/application-dev/connectivity/net-mdns.md
+++ b/en/application-dev/connectivity/net-mdns.md
@@ -1,6 +1,6 @@
# MDNS Management
-## Introduction
+## Overview
Multicast DNS (mDNS) provides functions such as adding, removing, discovering, and resolving local services on a LAN.
- Local service: a service provider on a LAN, for example, a printer or scanner.
diff --git a/en/application-dev/connectivity/net-sharing.md b/en/application-dev/connectivity/net-sharing.md
index 4072217d9ced5d99b2052b5db8ccb8333fcb7023..f2b2e6ac21362691ede111db8b16316fa9fd32cb 100644
--- a/en/application-dev/connectivity/net-sharing.md
+++ b/en/application-dev/connectivity/net-sharing.md
@@ -1,10 +1,11 @@
# Network Sharing
-## Introduction
+## Overview
The Network Sharing module allows you to share your device's Internet connection with other connected devices by means of Wi-Fi hotspot, Bluetooth, and USB sharing. It also allows you to query the network sharing state and shared mobile data volume.
> **NOTE**
+>
> To maximize the application running efficiency, most API calls are called asynchronously in callback or promise mode. The following code examples use the callback mode. For details about the APIs, see [sms API Reference](../reference/apis/js-apis-net-sharing.md).
## Basic Concepts
diff --git a/en/application-dev/connectivity/net-statistics.md b/en/application-dev/connectivity/net-statistics.md
index 47ec62ff156448b3214885176c30b2f76d77b76c..6df8800dd479b48c32619514b8e6b90d5c776330 100644
--- a/en/application-dev/connectivity/net-statistics.md
+++ b/en/application-dev/connectivity/net-statistics.md
@@ -1,6 +1,6 @@
# Traffic Management
-## Introduction
+## Overview
The traffic management module allows you to query real-time or historical data traffic by the specified network interface card (NIC) or user ID (UID).
@@ -11,6 +11,7 @@ Its functions include:
- Subscribing to traffic change events by NIC or UID
> **NOTE**
+>
> To maximize the application running efficiency, most API calls are called asynchronously in callback or promise mode. The following code examples use the callback mode. For details about the APIs, see [Traffic Management](../reference/apis/js-apis-net-statistics.md).
The following describes the development procedure specific to each application scenario.
diff --git a/en/application-dev/connectivity/net-vpn.md b/en/application-dev/connectivity/net-vpn.md
new file mode 100644
index 0000000000000000000000000000000000000000..a93b00b932bdec33de7cb45764474c163ed456ce
--- /dev/null
+++ b/en/application-dev/connectivity/net-vpn.md
@@ -0,0 +1,363 @@
+# VPN Management
+
+## Overview
+
+A virtual private network (VPN) is a dedicated network established on a public network. On a VPN, the connection between any two nodes does not have an end-to-end physical link required by the traditional private network. Instead, user data is transmitted over a logical link because a VPN is a logical network deployed over the network platform (such as the Internet) provided by the public network service provider.
+
+> **NOTE**
+>
+> To maximize the application running efficiency, most API calls are called asynchronously in callback or promise mode. The following code examples use the callback mode. For details about the APIs, see [Traffic Management](../reference/apis/js-apis-net-vpn.md).
+
+The following describes the development procedure specific to each application scenario.
+
+## Available APIs
+
+For the complete list of APIs and example code, see [VPN Management](../reference/apis/js-apis-net-vpn.md).
+
+| Type| API| Description|
+| ---- | ---- | ---- |
+| ohos.net.vpn | setUp(config: VpnConfig, callback: AsyncCallback\): void | Establishes a VPN. This API uses an asynchronous callback to return the result.|
+| ohos.net.vpn | protect(socketFd: number, callback: AsyncCallback\): void | Enables VPN tunnel protection. This API uses an asynchronous callback to return the result.|
+| ohos.net.vpn | destroy(callback: AsyncCallback\): void | Destroys a VPN. This API uses an asynchronous callback to return the result.|
+
+## Starting a VPN
+
+1. Establish a VPN tunnel. The following uses the UDP tunnel as an example.
+2. Enable protection for the UDP tunnel.
+3. Establish a VPN.
+4. Process data of the virtual network interface card (vNIC), such as reading or writing data.
+5. Destroy the VPN.
+
+This example shows how to develop an application using native C++ code. For details, see [Simple Native C++ Example (ArkTS) (API9)] (https://gitee.com/openharmony/codelabs/tree/master/NativeAPI/NativeTemplateDemo).
+
+The sample application consists of two parts: JS code and C++ code.
+
+## JS Code
+The JS code is used to implement the service logic, such as creating a tunnel, establishing a VPN, enabling VPN protection, and destroying a VPN.
+
+```js
+import hilog from '@ohos.hilog';
+import vpn from '@ohos.net.vpn';
+import UIAbility from '@ohos.app.ability.UIAbility';
+import vpn_client from "libvpn_client.so"
+
+class EntryAbility extends UIAbility {
+ onWindowStageCreate(windowStage) {
+ globalThis.context = this.context;
+ }
+}
+
+let TunnelFd = -1
+let VpnConnection = vpn.createVpnConnection(globalThis.context)
+
+@Entry
+@Component
+struct Index {
+ @State message: string = 'Test VPN'
+
+ //1. Establish a VPN tunnel. The following uses the UDP tunnel as an example.
+ CreateTunnel() {
+ TunnelFd = vpn_client.udpConnect("192.168.43.208", 8888)
+ }
+
+ // 2. Enable protection for the UDP tunnel.
+ Protect() {
+ VpnConnection.protect(TunnelFd).then(function () {
+ console.info("vpn Protect Success.")
+ }).catch(function (err) {
+ console.info("vpn Protect Failed " + JSON.stringify(err))
+ })
+ }
+
+ SetupVpn() {
+ let config = {
+ addresses: [{
+ address: {
+ address: "10.0.0.5",
+ family: 1
+ },
+ prefixLength: 24,
+ }],
+ routes: [],
+ mtu: 1400,
+ dnsAddresses: [
+ "114.114.114.114"
+ ],
+ acceptedApplications: [],
+ refusedApplications: []
+ }
+
+ try {
+ // 3. Create a VPN.
+ VpnConnection.setUp(config, (error, data) => {
+ console.info("tunfd: " + JSON.stringify(data));
+ // 4. Process data of the virtual vNIC, such as reading or writing data.
+ vpn_client.startVpn(data, TunnelFd)
+ })
+ } catch (error) {
+ console.info("vpn setUp fail " + JSON.stringify(error));
+ }
+ }
+
+ // 5. Destroy the VPN.
+ Destroy() {
+ vpn_client.stopVpn(TunnelFd)
+ VpnConnection.destroy().then(function () {
+ console.info("vpn Destroy Success.")
+ }).catch(function (err) {
+ console.info("vpn Destroy Failed " + JSON.stringify(err))
+ })
+ }
+
+ build() {
+ Row() {
+ Column() {
+ Text(this.message)
+ .fontSize(50)
+ .fontWeight(FontWeight.Bold)
+ .onClick(() => {
+ console.info("vpn Client")
+ })
+ Button('CreateTunnel').onClick(() => {
+ this.CreateTunnel()
+ }).fontSize(50)
+ Button('Protect').onClick(() => {
+ this.Protect()
+ }).fontSize(50)
+ Button('SetupVpn').onClick(() => {
+ this.SetupVpn()
+ }).fontSize(50)
+ Button('Destroy').onClick(() => {
+ this.Destroy()
+ }).fontSize(50)
+ }
+ .width('100%')
+ }
+ .height('100%')
+ }
+}
+```
+
+## C++ Code
+The C++ code is used for underlying service implementation, such as UDP tunnel client implementation and vNIC data read and write.
+
+```c++
+#include "napi/native_api.h"
+#include "hilog/log.h"
+
+#include
+#include
+#include
+#include
+#include
+#include
+#include
+#include
+#include
+
+#include
+#include
+#include
+
+#define BUFFER_SIZE 2048
+
+#define VPN_LOG_TAG "NetMgrVpn"
+#define VPN_LOG_DOMAIN 0x15b0
+#define MAKE_FILE_NAME (strrchr(__FILE__, '/') + 1)
+
+#define NETMANAGER_VPN_LOGE(fmt, ...) \
+ OH_LOG_Print(LOG_APP, LOG_ERROR, VPN_LOG_DOMAIN, VPN_LOG_TAG, "vpn [%{public}s %{public}d] " fmt, MAKE_FILE_NAME, \
+ __LINE__, ##__VA_ARGS__)
+
+#define NETMANAGER_VPN_LOGI(fmt, ...) \
+ OH_LOG_Print(LOG_APP, LOG_INFO, VPN_LOG_DOMAIN, VPN_LOG_TAG, "vpn [%{public}s %{public}d] " fmt, MAKE_FILE_NAME, \
+ __LINE__, ##__VA_ARGS__)
+
+#define NETMANAGER_VPN_LOGD(fmt, ...) \
+ OH_LOG_Print(LOG_APP, LOG_DEBUG, VPN_LOG_DOMAIN, VPN_LOG_TAG, "vpn [%{public}s %{public}d] " fmt, MAKE_FILE_NAME, \
+ __LINE__, ##__VA_ARGS__)
+
+struct FdInfo {
+ int32_t tunFd = 0;
+ int32_t tunnelFd = 0;
+ struct sockaddr_in serverAddr;
+};
+
+static FdInfo fdInfo;
+static bool threadRunF = false;
+static std::thread threadt1;
+static std::thread threadt2;
+
+// Obtain the IP address of the UDP server.
+static constexpr const int MAX_STRING_LENGTH = 1024;
+std::string GetStringFromValueUtf8(napi_env env, napi_value value) {
+ std::string result;
+ char str[MAX_STRING_LENGTH] = {0};
+ size_t length = 0;
+ napi_get_value_string_utf8(env, value, str, MAX_STRING_LENGTH, &length);
+ if (length > 0) {
+ return result.append(str, length);
+ }
+ return result;
+}
+
+void HandleReadTunfd(FdInfo fdInfo) {
+ uint8_t buffer[BUFFER_SIZE] = {0};
+ while (threadRunF) {
+ int ret = read(fdInfo.tunFd, buffer, sizeof(buffer));
+ if (ret <= 0) {
+ if (errno != 11) {
+ NETMANAGER_VPN_LOGE("read tun device error: %{public}d, tunfd: %{public}d", errno, fdInfo.tunFd);
+ }
+ continue;
+ }
+
+ // Read data from the vNIC and send the data to the UDP server through the UDP tunnel.
+ NETMANAGER_VPN_LOGD("buffer: %{public}s, len: %{public}d", buffer, ret);
+ ret = sendto(fdInfo.tunnelFd, buffer, ret, 0, (struct sockaddr *)&fdInfo.serverAddr, sizeof(fdInfo.serverAddr));
+ if (ret <= 0) {
+ NETMANAGER_VPN_LOGE("send to server[%{public}s:%{public}d] failed, ret: %{public}d, error: %{public}s",
+ inet_ntoa(fdInfo.serverAddr.sin_addr), ntohs(fdInfo.serverAddr.sin_port), ret,
+ strerror(errno));
+ continue;
+ }
+ }
+}
+
+void HandleTcpReceived(FdInfo fdInfo) {
+ int addrlen = sizeof(struct sockaddr_in);
+ uint8_t buffer[BUFFER_SIZE] = {0};
+ while (threadRunF) {
+ int length = recvfrom(fdInfo.tunnelFd, buffer, sizeof(buffer), 0, (struct sockaddr *)&fdInfo.serverAddr,
+ (socklen_t *)&addrlen);
+ if (length < 0) {
+ if (errno != 11) {
+ NETMANAGER_VPN_LOGE("read tun device error: %{public}d, tunnelfd: %{public}d", errno, fdInfo.tunnelFd);
+ }
+ continue;
+ }
+
+ // Receive data from the UDP server and write the data to the vNIC.
+ NETMANAGER_VPN_LOGD("from [%{public}s:%{public}d] data: %{public}s, len: %{public}d",
+ inet_ntoa(fdInfo.serverAddr.sin_addr), ntohs(fdInfo.serverAddr.sin_port), buffer, length);
+ int ret = write(fdInfo.tunFd, buffer, length);
+ if (ret <= 0) {
+ NETMANAGER_VPN_LOGE("error Write To Tunfd, errno: %{public}d", errno);
+ }
+ }
+}
+
+static napi_value UdpConnect(napi_env env, napi_callback_info info) {
+ size_t argc = 2;
+ napi_value args[2] = {nullptr};
+ napi_get_cb_info(env, info, &argc, args, nullptr, nullptr);
+
+ int32_t port = 0;
+ napi_get_value_int32(env, args[1], &port);
+ std::string ipAddr = GetStringFromValueUtf8(env, args[0]);
+
+ NETMANAGER_VPN_LOGI("ip: %{public}s port: %{public}d", ipAddr.c_str(), port);
+
+ // Establish a UDP tunnel.
+ int32_t sockFd = socket(AF_INET, SOCK_DGRAM, 0);
+ if (sockFd == -1) {
+ NETMANAGER_VPN_LOGE("socket() error");
+ return 0;
+ }
+
+ struct timeval timeout = {1, 0};
+ setsockopt(sockFd, SOL_SOCKET, SO_RCVTIMEO, (char *)&timeout, sizeof(struct timeval));
+
+ memset(&fdInfo.serverAddr, 0, sizeof(fdInfo.serverAddr));
+ fdInfo.serverAddr.sin_family = AF_INET;
+ fdInfo.serverAddr.sin_addr.s_addr = inet_addr(ipAddr.c_str()); // server's IP addr
+ fdInfo.serverAddr.sin_port = htons(port); // port
+
+ NETMANAGER_VPN_LOGI("Connection successful");
+
+ napi_value tunnelFd;
+ napi_create_int32(env, sockFd, &tunnelFd);
+ return tunnelFd;
+}
+
+static napi_value StartVpn(napi_env env, napi_callback_info info) {
+ size_t argc = 2;
+ napi_value args[2] = {nullptr};
+ napi_get_cb_info(env, info, &argc, args, nullptr, nullptr);
+
+ napi_get_value_int32(env, args[0], &fdInfo.tunFd);
+ napi_get_value_int32(env, args[1], &fdInfo.tunnelFd);
+
+ if (threadRunF) {
+ threadRunF = false;
+ threadt1.join();
+ threadt2.join();
+ }
+
+ // Start two threads. One is used to read data from the vNIC, and the other is used to receive data from the server.
+ threadRunF = true;
+ std::thread tt1(HandleReadTunfd, fdInfo);
+ std::thread tt2(HandleTcpReceived, fdInfo);
+
+ threadt1 = std::move(tt1);
+ threadt2 = std::move(tt2);
+
+ NETMANAGER_VPN_LOGI("StartVpn successful");
+
+ napi_value retValue;
+ napi_create_int32(env, 0, &retValue);
+ return retValue;
+}
+
+static napi_value StopVpn(napi_env env, napi_callback_info info) {
+ size_t argc = 1;
+ napi_value args[1] = {nullptr};
+ napi_get_cb_info(env, info, &argc, args, nullptr, nullptr);
+
+ int32_t tunnelFd;
+ napi_get_value_int32(env, args[0], &tunnelFd);
+ if (tunnelFd) {
+ close(tunnelFd);
+ tunnelFd = 0;
+ }
+
+ // Stop the two threads.
+ if (threadRunF) {
+ threadRunF = false;
+ threadt1.join();
+ threadt2.join();
+ }
+
+ NETMANAGER_VPN_LOGI("StopVpn successful");
+
+ napi_value retValue;
+ napi_create_int32(env, 0, &retValue);
+ return retValue;
+}
+
+EXTERN_C_START
+static napi_value Init(napi_env env, napi_value exports) {
+ napi_property_descriptor desc[] = {
+ {"udpConnect", nullptr, UdpConnect, nullptr, nullptr, nullptr, napi_default, nullptr},
+ {"startVpn", nullptr, StartVpn, nullptr, nullptr, nullptr, napi_default, nullptr},
+ {"stopVpn", nullptr, StopVpn, nullptr, nullptr, nullptr, napi_default, nullptr},
+ };
+ napi_define_properties(env, exports, sizeof(desc) / sizeof(desc[0]), desc);
+ return exports;
+}
+EXTERN_C_END
+
+static napi_module demoModule = {
+ .nm_version = 1,
+ .nm_flags = 0,
+ .nm_filename = nullptr,
+ .nm_register_func = Init,
+ .nm_modname = "entry",
+ .nm_priv = ((void *)0),
+ .reserved = {0},
+};
+
+extern "C" __attribute__((constructor)) void RegisterEntryModule(void) {
+ napi_module_register(&demoModule);
+}
+```
diff --git a/en/application-dev/connectivity/socket-connection.md b/en/application-dev/connectivity/socket-connection.md
index 9dda8b4e4c0ac6931ea75ad706fef76c9fb3c0a3..fe8ab1f141e3525de46985ba113eee364adac723 100644
--- a/en/application-dev/connectivity/socket-connection.md
+++ b/en/application-dev/connectivity/socket-connection.md
@@ -1,6 +1,6 @@
# Socket Connection
-## Introduction
+## Overview
The Socket Connection module allows an application to transmit data over a socket connection through the TCP, UDP, or TLS protocol.
diff --git a/en/application-dev/connectivity/subscribe-remote-state.md b/en/application-dev/connectivity/subscribe-remote-state.md
index 5b21750ba8b56fefcb10a5fff653d7512765c279..d23385e44752cb0945217eddc74117202ca38c5f 100755
--- a/en/application-dev/connectivity/subscribe-remote-state.md
+++ b/en/application-dev/connectivity/subscribe-remote-state.md
@@ -1,5 +1,7 @@
# Subscribing to State Changes of a Remote Object
+## Overview
+
IPC/RPC allows you to subscribe to the state changes of a remote stub object. When the remote stub object dies, a death notification will be sent to your local proxy object. Such subscription and unsubscription are controlled by APIs. To be specific, you need to implement the **DeathRecipient** interface and the **onRemoteDied** API to clear resources. This callback is invoked when the process accommodating the remote stub object dies, or the device accommodating the remote stub object leaves the network. It is worth noting that these APIs should be called in the following order: The proxy object must first subscribe to death notifications of the stub object. If the stub object is in the normal state, the proxy object can cancel the subscription as required. If the process of the stub object exits or the device hosting the stub object goes offline, subsequent operations customized by the proxy object will be automatically triggered.
## When to Use
diff --git a/en/application-dev/connectivity/websocket-connection.md b/en/application-dev/connectivity/websocket-connection.md
index 4c373011c45be18183e4c622c3e7e35b97198a24..1b162256db5cad28aa50ca6989625f9191fb2257 100644
--- a/en/application-dev/connectivity/websocket-connection.md
+++ b/en/application-dev/connectivity/websocket-connection.md
@@ -1,6 +1,6 @@
# WebSocket Connection
-## When to Use
+## Overview
You can use WebSocket to establish a bidirectional connection between a server and a client. Before doing this, you need to use the **createWebSocket()** API to create a **WebSocket** object and then use the **connect()** API to connect to the server. If the connection is successful, the client will receive a callback of the **open** event. Then, the client can communicate with the server using the **send()** API. When the server sends a message to the client, the client will receive a callback of the **message** event. If the client no longer needs this connection, it can call the **close()** API to disconnect from the server. Then, the client will receive a callback of the **close** event.
diff --git a/en/application-dev/database/data-persistence-by-preferences.md b/en/application-dev/database/data-persistence-by-preferences.md
index e37c12369d59d2165220c8d8f5bbaa85029c37df..553050a55a585dc34e620623eb187a0365b8488e 100644
--- a/en/application-dev/database/data-persistence-by-preferences.md
+++ b/en/application-dev/database/data-persistence-by-preferences.md
@@ -68,7 +68,7 @@ The following table lists the APIs used for persisting user preference data. For
return;
}
console.info('Succeeded in getting preferences.');
- // Perform related data operations.
+ // Before performing related data operations, obtain a Preferences instance.
})
} catch (err) {
console.error(`Failed to get preferences. Code:${err.code},message:${err.message}`);
@@ -93,7 +93,7 @@ The following table lists the APIs used for persisting user preference data. For
return;
}
console.info('Succeeded in getting preferences.');
- // Perform related data operations.
+ // Before performing related data operations, obtain a Preferences instance.
})
} catch (err) {
console.error(`Failed to get preferences. Code is ${err.code},message:${err.message}`);
@@ -220,4 +220,4 @@ The following table lists the APIs used for persisting user preference data. For
} catch (err) {
console.error(`Failed to delete preferences. Code:${err.code}, message:${err.message}`);
}
- ```
+ ```
\ No newline at end of file
diff --git a/en/application-dev/database/data-sync-of-kv-store.md b/en/application-dev/database/data-sync-of-kv-store.md
index eb8994570f04b0d6690c2b91b1b1745602e980fb..b23dd91ed1a7b4ea0cd13f6d9b49de82e1821190 100644
--- a/en/application-dev/database/data-sync-of-kv-store.md
+++ b/en/application-dev/database/data-sync-of-kv-store.md
@@ -171,7 +171,7 @@ The following uses a single KV store as an example to describe how to implement
return;
}
console.info('Succeeded in getting KVStore.');
- // Perform related data operations.
+ // Before performing related data operations, obtain a KV store instance.
});
} catch (e) {
console.error(`An unexpected error occurred. Code:${e.code},message:${e.message}`);
@@ -275,4 +275,4 @@ The following uses a single KV store as an example to describe how to implement
}
}
});
- ```
+ ```
\ No newline at end of file
diff --git a/en/application-dev/dfx/Readme-EN.md b/en/application-dev/dfx/Readme-EN.md
index 5a1b6326bae1ecb94ef7fe8d9e4cfe2cdf2c6c56..c40f752d8f85e8894eb725965f50a7614dddef36 100644
--- a/en/application-dev/dfx/Readme-EN.md
+++ b/en/application-dev/dfx/Readme-EN.md
@@ -1,7 +1,6 @@
# DFX
- [Development of Application Event Logging](hiappevent-guidelines.md)
-- [Development of Performance Tracing](hitracemeter-guidelines.md)
- [Development of Distributed Call Chain Tracing](hitracechain-guidelines.md)
- [HiLog Development (Native)](hilog-guidelines.md)
- Performance Tracing
diff --git a/en/application-dev/dfx/appfreeze-guidelines.md b/en/application-dev/dfx/appfreeze-guidelines.md
index 05b52c4d8070386ec350701cefb2c6b63ef67d55..4984c95e215fe832f59abc3306bf777c6c313818 100644
--- a/en/application-dev/dfx/appfreeze-guidelines.md
+++ b/en/application-dev/dfx/appfreeze-guidelines.md
@@ -1,6 +1,6 @@
# Application Freeze (appfreeze) Log Analysis
-## Introduction
+## Overview
Application freeze (appfreeze) means that an application does not respond to user operations (for example, clicking) within a given period of time. OpenHarmony provides a mechanism for detecting appfreeze faults and generates appfreeze logs for fault analysis.
diff --git a/en/application-dev/dfx/apprecovery-guidelines.md b/en/application-dev/dfx/apprecovery-guidelines.md
index 284de5ca6d5f6027f2cce975a29b3259b2778021..9548404b3b359ad3f6fbe6778e0ddaeb374cc2ec 100644
--- a/en/application-dev/dfx/apprecovery-guidelines.md
+++ b/en/application-dev/dfx/apprecovery-guidelines.md
@@ -1,6 +1,6 @@
# Application Recovery Development
-## When to Use
+## Overview
During application running, some unexpected behaviors are inevitable. For example, unprocessed exceptions and errors are thrown, and the call or running constraints of the recovery framework are violated.
@@ -99,9 +99,12 @@ import AbilityConstant from '@ohos.app.ability.AbilityConstant'
- Define and register the [ErrorObserver](../reference/apis/js-apis-inner-application-errorObserver.md) callback. For details about its usage, see [errorManager](../reference/apis/js-apis-app-ability-errorManager.md).
```ts
- var registerId = -1;
- var callback = {
- onUnhandledException(errMsg) {
+ export let abilityWant : Want // file1
+
+ import * as G form "../file1"
+ let registerId = -1;
+ let callback: Callback = {
+ onUnhandledException(errMsg: string): void {
console.log(errMsg);
appRecovery.saveAppState();
appRecovery.restartApp();
@@ -112,7 +115,7 @@ import AbilityConstant from '@ohos.app.ability.AbilityConstant'
// Main window is created, set main page for this ability
console.log("[Demo] MainAbility onWindowStageCreate")
- globalThis.registerObserver = (() => {
+ G.registerObserver = (() => {
registerId = errorManager.on('error', callback);
})
@@ -138,13 +141,16 @@ After the callback triggers **appRecovery.saveAppState()**, **onSaveState(state,
After the callback triggers **appRecovery.restartApp()**, the application is restarted. After the restart, **onCreate(want, launchParam)** of **MainAbility** is called, and the saved data is in **parameters** of **want**.
```ts
+export let abilityWant : Want // file1
+
+import * as GlobalWant form "../file1"
storage: LocalStorage
onCreate(want, launchParam) {
console.log("[Demo] MainAbility onCreate")
- globalThis.abilityWant = want;
+ GlobalWant.abilityWant = want;
if (launchParam.launchReason == AbilityConstant.LaunchReason.APP_RECOVERY) {
this.storage = new LocalStorage();
- let recoveryData = want.parameters["myData"];
+ let recoveryData: string = want.parameters["myData"];
this.storage.setOrCreate("myData", recoveryData);
this.context.restoreWindowStage(this.storage);
}
@@ -154,12 +160,15 @@ onCreate(want, launchParam) {
- Unregister the **ErrorObserver** callback.
```ts
+export let abilityWant : Want // file1
+
+import * as G form "../file1"
onWindowStageDestroy() {
// Main window is destroyed, release UI related resources
console.log("[Demo] MainAbility onWindowStageDestroy")
- globalThis.unRegisterObserver = (() => {
- errorManager.off('error', registerId, (err) => {
+ G.unRegisterObserver = (() => {
+ errorManager.off(type: 'error', registerId: number, (err:Error) => {
console.error("[Demo] err:", err);
});
})
@@ -171,20 +180,22 @@ onWindowStageDestroy() {
This is triggered by the recovery framework. You do not need to register an **ErrorObserver** callback. You only need to implement **onSaveState** for application state saving and **onCreate** for data restore.
```ts
+export let abilityWant : Want // file1
+
+import * as GlobalWant form "../file1"
export default class MainAbility extends Ability {
- storage: LocalStorage
- onCreate(want, launchParam) {
+ onCreate(want: Want, launchParam:AbilityConstant.LaunchParam):void {
console.log("[Demo] MainAbility onCreate")
- globalThis.abilityWant = want;
+ GlobalWant.abilityWant = want;
if (launchParam.launchReason == AbilityConstant.LaunchReason.APP_RECOVERY) {
this.storage = new LocalStorage();
- let recoveryData = want.parameters["myData"];
- this.storage.setOrCreate("myData", recoveryData);
+ let recoveryData: string = want.parameters["myData"];
+ this.storage.setOrCreate("myData", recoveryData);
this.context.restoreWindowStage(this.storage);
}
}
- onSaveState(state, wantParams) {
+ onSaveState(state: AbilityConstant.StateType, wantParams: { [key: string]: Object }) : AbilityConstant.OnSaveResult{
// Ability has called to save app data
console.log("[Demo] MainAbility onSaveState")
wantParams["myData"] = "my1234567";
diff --git a/en/application-dev/dfx/cppcrash-guidelines.md b/en/application-dev/dfx/cppcrash-guidelines.md
index 4454422fe4f3aec6c781090a2e833ee103488dab..15136518788324e23ac46c8c8b5bba327c03ea7a 100644
--- a/en/application-dev/dfx/cppcrash-guidelines.md
+++ b/en/application-dev/dfx/cppcrash-guidelines.md
@@ -1,6 +1,6 @@
-# cppcrash Log Analysis
+# Process Crash (cppcrash) Log Analysis
-## Introduction
+## Overview
A process crash refers to a C/C++ runtime crash. The FaultLogger module of OpenHarmony provides capabilities such as process crash detection, log collection, log storage, and log reporting, helping you to locate faults more effectively.
@@ -23,7 +23,7 @@ Process crash detection is implemented based on the Linux signal mechanism. Curr
## Crash Log Collection
-Process crash log is the fault log managed together with the app freeze and JS application crash logs by the FaultLogger module. You can collect process crash logs in any of the following ways:
+Process crash log is a type of fault logs managed together with the app freeze and JS application crash logs by the FaultLogger module. You can collect process crash logs in any of the following ways:
### Collecting Logs by Using Shell
@@ -72,17 +72,14 @@ Thread name:crasher <- Abnormal thread
### Locating Faults Through Logs
-1. Determine the faulty module and fault type based on fault logs.
-
- Generally, you can identify the faulty module based on the crash process name and identify the crash cause based on the signal. Besides, you can restore the function call chain of the crash stack based on the method name in the stack.
-
- In the example, **SIGSEGV** is thrown by the Linux kernel because of access to an invalid memory address. The problem occurs in the **TriggerSegmentFaultException** function.
-
- In most scenarios, a crash is caused by the top layer of the crash stack, such as null pointer access and proactive program abort.
+- Determine the faulty module and fault type based on fault logs.
+ Generally, you can identify the faulty module based on the crash process name and identify the crash cause based on the signal. Besides, you can restore the function call chain of the crash stack based on the method name in the stack.\
+ In the example, **SIGSEGV** is thrown by the Linux kernel because of access to an invalid memory address. The problem occurs in the **TriggerSegmentFaultException** function.\
+ In most scenarios, a crash is caused by the top layer of the crash stack, such as null pointer access and proactive program abort.\
If the cause cannot be located through the call stack, you need to check for other faults, for example, memory corruption or stack overflow.
-2. Use the addr2line tool of Linux to parse the code line number to restore the call stack at the time of process crash.
+- Use the addr2line tool of Linux to parse the code line number to restore the call stack at the time of process crash.
When using the addr2line tool to parse the code line number of the crash stack, make sure that binary files with debugging information is used. Generally, such files are generated during version build or application build.
@@ -94,17 +91,17 @@ Thread name:crasher <- Abnormal thread
\code root directory\out\product\exe.unstripped
```
- You can run `apt-get install addr2line` to install the addr2line tool on Linux.
-
+ You can run `apt-get install addr2line` to install the addr2line tool on Linux.\
On On DevEco Studio, you can also use the llvm-addr2line tool archived in the SDK to parse code line numbers. The usage method is the same.
- The following example shows how to use the addr2line tool to parse the code line number based on the offset address:
+ The following example shows how to use the addr2line tool to parse the code line number based on the offset address.
+
+ **[product name]** indicates the device name.
```
- root:~/OpenHarmony/out/rk3568/exe.unstripped/hiviewdfx/faultloggerd$ addr2line -e crasher 0000332c
+ root:~/OpenHarmony/out/[product name]/exe.unstripped/hiviewdfx/faultloggerd$ addr2line -e crasher 0000332c
base/hiviewdfx/faultloggerd/tools/crasher/dfx_crasher.c:57
```
- In this example, the crash is caused by assignment of a value to an unwritable area. It is in code line 57 in the **dfx_crasher.c** file. You can modify it to avoid the crash.
-
+ In this example, the crash is caused by assignment of a value to an unwritable area. It is in code line 57 in the **dfx_crasher.c** file. You can modify it to avoid the crash.\
If the obtained code line number is seemingly incorrect, you can fine-tune the address (for example, subtract the address by 1) or disable some compilation optimization items. It is known that the obtained code line number may be incorrect when Link Time Optimization (LTO) is enabled.
diff --git a/en/application-dev/dfx/errormanager-guidelines.md b/en/application-dev/dfx/errormanager-guidelines.md
index 4679cfcfc78893590fe73eab770e49fc68a1a828..14d7735d731d0fb2eb3fc41f61de58f5de7f4e02 100644
--- a/en/application-dev/dfx/errormanager-guidelines.md
+++ b/en/application-dev/dfx/errormanager-guidelines.md
@@ -1,6 +1,6 @@
# Development of Error Manager
-## When to Use
+## Overview
If coding specification issues or errors exist in the code of an application, the application may encounter unexpected errors, for example, uncaught exceptions or application lifecycle timeouts, while it is running. In such a case, the application may exit unexpectedly. Error logs, however, are usually stored on users' local storage, making it inconvenient to locate faults. With the APIs provided by the **errorManager** module, your application will be able to report related errors and logs to your service platform for fault locating before it exits.
diff --git a/en/application-dev/dfx/hiappevent-guidelines.md b/en/application-dev/dfx/hiappevent-guidelines.md
index d21d4e3fa9e0fa0b795c82e7157cd6215eab5e0c..6b0f4dd1cb8ec36288514e3f8767770f4e30105b 100644
--- a/en/application-dev/dfx/hiappevent-guidelines.md
+++ b/en/application-dev/dfx/hiappevent-guidelines.md
@@ -1,6 +1,6 @@
# Development of Application Event Logging
-## Introduction
+## Overview
A traditional log system aggregates log information generated by all applications running on the entire device, making it difficult to identify key information in the log. Therefore, an effective logging mechanism is needed to evaluate mission-critical information, for example, number of visits, number of daily active users, user operation habits, and key factors that affect application usage.
diff --git a/en/application-dev/dfx/hilog-guidelines.md b/en/application-dev/dfx/hilog-guidelines.md
index 25b4a7f9cc5c92d9f20ed6582299d5dd65b937d0..45d46c01fb4c601241120ce9cf5d249bd0bc893f 100644
--- a/en/application-dev/dfx/hilog-guidelines.md
+++ b/en/application-dev/dfx/hilog-guidelines.md
@@ -1,6 +1,6 @@
# HiLog Development (Native)
-## Introduction
+## Overview
HiLog is the log system of OpenHarmony that provides logging for the system framework, services, and applications to record information on user operations and system running status.
diff --git a/en/application-dev/dfx/hitracechain-guidelines.md b/en/application-dev/dfx/hitracechain-guidelines.md
index affd260b0503f3c4f4c4b748d5911d94f7fef9e3..44e2da92dfbf985f27a275ac6e02e61a934d199e 100644
--- a/en/application-dev/dfx/hitracechain-guidelines.md
+++ b/en/application-dev/dfx/hitracechain-guidelines.md
@@ -1,6 +1,6 @@
# Development of Distributed Call Chain Tracing
-## Introduction
+## Overview
The hiTraceChain module provides APIs to implement call chain tracing throughout a service process. This can help you quickly obtain the run log for the call chain of a specified service process and locate faults in inter-device, inter-process, or inter-thread communications.
diff --git a/en/application-dev/dfx/hitracemeter-guidelines.md b/en/application-dev/dfx/hitracemeter-guidelines.md
index ed99e4e89d5b6fce3d5bd50ef8dedcfc32b04fb1..195aae4b2d98dd1ab950613c6c97ed07cfcfe98e 100644
--- a/en/application-dev/dfx/hitracemeter-guidelines.md
+++ b/en/application-dev/dfx/hitracemeter-guidelines.md
@@ -1,6 +1,6 @@
# Development of Performance Tracing (ArkTS)
-## Introduction
+## Overview
hiTraceMeter provides APIs for system performance tracing. You can call the APIs provided by the hiTraceMeter module in your own service logic to effectively track service processes and check the system performance.
@@ -21,7 +21,7 @@ hiTraceMeter provides APIs for system performance tracing. You can call the APIs
## Available APIs
-The performance tracing APIs are provided by the **hiTraceMeter** module. For details, see [API Reference](../reference/apis/js-apis-hitracemeter.md).
+The performance tracing APIs are provided by the **hiTraceMeter** module. For details, see [API Reference]( ../reference/apis/js-apis-hitracemeter.md).
**APIs for performance tracing**
@@ -35,60 +35,16 @@ The performance tracing APIs are provided by the **hiTraceMeter** module. For de
In this example, distributed call chain tracing begins when the application startup execution page is loaded and stops when the service usage is completed.
-1. Create a JS application project. In the displayed **Project** window, choose **entry** > **src** > **main** > **js** > **default** > **pages** > **index**, and double-click **index.js**. Add the code to implement performance tracing upon page loading. The sample code is as follows:
-
- ```js
- import hiTraceMeter from '@ohos.hiTraceMeter'
-
- export default {
- data: {
- title: ""
- },
- onInit() {
- this.title = this.$t('strings.world');
-
- // Start trace tasks with the same name concurrently.
- hiTraceMeter.startTrace("business", 1);
- // Keep the service process running.
- console.log(`business running`);
- hiTraceMeter.startTrace("business", 2); // Start the second trace task with the same name while the first task is still running. The tasks are running concurrently and therefore their taskId must be different.
- // Keep the service process running.
- console.log(`business running`);
- hiTraceMeter.finishTrace("business", 1);
- // Keep the service process running.
- console.log(`business running`);
- hiTraceMeter.finishTrace("business", 2);
-
- // Start trace tasks with the same name in serial mode.
- hiTraceMeter.startTrace("business", 1);
- // Keep the service process running.
- console.log(`business running`);
- hiTraceMeter.finishTrace("business", 1); // End the first trace task.
- // Keep the service process running.
- console.log(`business running`);
- hiTraceMeter.startTrace("business", 1); // Start the second trace task with the same name in serial mode.
- // Keep the service process running.
- console.log(`business running`);
-
- let traceCount = 3;
- hiTraceMeter.traceByValue("myTestCount", traceCount);
- traceCount = 4;
- hiTraceMeter.traceByValue("myTestCount", traceCount);
- hiTraceMeter.finishTrace("business", 1);
- }
- }
- ```
-
-2. Create an ArkTs application project. In the displayed **Project** window, choose **entry** > **src** > **main** > **ets** > **pages** > **index**, and double-click **index.js**. Add the code to implement performance tracing upon page loading. For example, if the name of the trace task is **HITRACE\_TAG\_APP**, the sample code is as follows:
-
+1. Create an ArkTS application project. In the displayed **Project** window, choose **entry** > **src** > **main** > **ets** > **pages** > **index**, and double-click **index.js**. Add the code to implement performance tracing upon page loading. For example, if the name of the trace task is **HITRACE\_TAG\_APP**, the sample code is as follows:
+
```ts
import hitrace from '@ohos.hiTraceMeter';
-
+
@Entry
@Component
struct Index {
@State message: string = 'Hello World';
-
+
build() {
Row() {
Column() {
@@ -97,7 +53,7 @@ In this example, distributed call chain tracing begins when the application star
.fontWeight(FontWeight.Bold)
.onClick(() => {
this.message = 'Hello ArkUI';
-
+
// Start trace tasks with the same name concurrently.
hitrace.startTrace("HITRACE_TAG_APP", 1001);
// Keep the service process running.
@@ -107,7 +63,7 @@ In this example, distributed call chain tracing begins when the application star
hitrace.startTrace("HITRACE_TAG_APP", 1002);
// Keep the service process running.
console.log(`HITRACE_TAG_APP running`);
-
+
hitrace.finishTrace("HITRACE_TAG_APP", 1001);
hitrace.finishTrace("HITRACE_TAG_APP", 1002);
@@ -143,7 +99,7 @@ In this example, distributed call chain tracing begins when the application star
```
3. Click the run button on the application page. Then, run the following commands in sequence in shell:
-
+
```shell
hdc shell
hitrace --trace_begin app
diff --git a/en/application-dev/dfx/hitracemeter-native-guidelines.md b/en/application-dev/dfx/hitracemeter-native-guidelines.md
index bb0274f7c4077b016061430250e7a949cf826864..912ec1c5f87b6ebfdd6f14cb4da568e251501af2 100644
--- a/en/application-dev/dfx/hitracemeter-native-guidelines.md
+++ b/en/application-dev/dfx/hitracemeter-native-guidelines.md
@@ -1,6 +1,6 @@
# Development of Performance Tracing (Native)
-## Introduction
+## Overview
hiTraceMeter provides APIs for system performance tracing. You can call the APIs provided by the hiTraceMeter module in your own service logic to effectively track service processes and check the system performance.
> **NOTE**
diff --git a/en/application-dev/faqs/faqs-arkui-animation-interactive-event.md b/en/application-dev/faqs/faqs-arkui-animation-interactive-event.md
index 56c1f44dfd74cec442e94b6116a0bab8965cbc66..cc07a581e4fb9a271b566928e8a5c991185c42c8 100644
--- a/en/application-dev/faqs/faqs-arkui-animation-interactive-event.md
+++ b/en/application-dev/faqs/faqs-arkui-animation-interactive-event.md
@@ -36,10 +36,11 @@ You can use [attribute animation](../reference/arkui-ts/ts-animatorproperty.md)
Applicable to: OpenHarmony 3.2 Beta 5 (API version 9)
-**Solution**
+**Solution**
-- Add **focusable\(true\)** to the list item to enable it to obtain focus.
+ Use either of the following:
+- Add **focusable\(true\)** to the list item to enable it to obtain focus.
- Nest a focusable component, for example, **\**, at the outer layer of each item.
## Why is the click event not triggered for the focused component upon the press of the Enter key after keyboard navigation?
@@ -139,6 +140,8 @@ Currently, the menu is displayed when the bound component is clicked or long pre
Applicable to: OpenHarmony 3.2 Beta5 (API version 9)
+**Solution**
+
Set the **focusable** attribute of the **\** component to **false**. In this way, the component is not focusable and therefore will not bring up the keyboard.
## How do I implement the slide up and slide down effect for page transition?
@@ -199,7 +202,7 @@ Applicable to: OpenHarmony 3.2 Beta5 (API version 9)
**Symptom**
-Custom components A and B need to deliver the following effects: When custom component A, displayed at the bottom of the screen by default, is touched, it is hidden, and custom component B slides in from the bottom. When custom component B is touched, it is hidden, and custom component A slides in from the bottom.
+Custom components A and B need to deliver the following effects: When custom component A, displayed at the bottom of the screen by default, is touched, it is hidden, and custom component B slides in from the bottom; when custom component B is touched, it is hidden, and custom component A slides in from the bottom.
**Solution**
@@ -266,4 +269,4 @@ struct ComponentChild2 {
**Reference**
-[Transition Animation Within the Component](../ui/arkts-enter-exit-transition.md)
+[Enter/Exit Transition](../ui/arkts-enter-exit-transition.md)
diff --git a/en/application-dev/faqs/faqs-graphics.md b/en/application-dev/faqs/faqs-graphics.md
index 345cbf83c5b2976c810e78237cb2587eaa4b1404..4cc8b196d5b8210e2360a598c1b24fdc0edb891b 100644
--- a/en/application-dev/faqs/faqs-graphics.md
+++ b/en/application-dev/faqs/faqs-graphics.md
@@ -21,42 +21,6 @@ try {
}
```
-## How do I hide the status bar to get the immersive effect?
-
-Applicable to: OpenHarmony 3.2 Beta5 (API version 9)
-
-**Solution**
-
-1. Use **onWindowStageCreate** to obtain a **windowClass** object.
-
- ```
- onWindowStageCreate(windowStage) {
- // When the main window is created, set the main page for this ability.
- console.log("[Demo] MainAbility onWindowStageCreate")
- windowStage.getMainWindow((err, data) => {
- if (err.code) {
- console.error('Failed to obtain the main window.')
- return;
- }
- // Obtain a windowClass object.
- globalThis.windowClass = data;
- })
- }
- ```
-
-2. Enable the full-screen mode for the window and hide the status bar.
-
- ```
- globalThis.windowClass.setFullScreen(isFullScreen, (err, data) => {
- if (err.code) {
- console.error('Failed to enable the full-screen mode. Cause:' + JSON.stringify(err));
- return;
- }
- console.info('Succeeded in enabling the full-screen mode. Data: ' + JSON.stringify(data));
- });
- ```
-
-
## How do I obtain the window width and height?
Applicable to: OpenHarmony 3.2 Beta5 (API version 9, stage model)
diff --git a/en/application-dev/napi/Readme-EN.md b/en/application-dev/napi/Readme-EN.md
index 43049f368af41f388e6c618f3375d6a72c88d897..f2012a21898bb8c38e6b78e1dd65ab617bb6e0b5 100644
--- a/en/application-dev/napi/Readme-EN.md
+++ b/en/application-dev/napi/Readme-EN.md
@@ -18,3 +18,6 @@
- [Purgeable Memory Development](purgeable-memory-guidelines.md)
- Device Management
- [USB DDK Development](usb-ddk-guidelines.md)
+- Data Management
+ - [RelationalStore Development](native-relational-store-guidelines.md)
+
diff --git a/en/application-dev/napi/native-buffer-guidelines.md b/en/application-dev/napi/native-buffer-guidelines.md
index b45c43f77e6d63aac676327bc971d9eeb0609259..fae8927caa9563c9fd459906d9fb9ecf2e166297 100644
--- a/en/application-dev/napi/native-buffer-guidelines.md
+++ b/en/application-dev/napi/native-buffer-guidelines.md
@@ -26,6 +26,13 @@ For details about the APIs, see [native_buffer](../reference/native-apis/_o_h___
The following describes how to use the native APIs provided by **NativeBuffer** to create an **OH_NativeBuffer** instance, obtain memory properties, and map the corresponding ION memory to the process address space.
+**Adding Dynamic Link Libraries**
+
+Add the following library to **CMakeLists.txt**:
+```txt
+libnative_buffer.so
+```
+
**Header File**
```c++
#include
@@ -51,14 +58,14 @@ The following describes how to use the native APIs provided by **NativeBuffer**
if (ret != 0) {
std::cout << "OH_NativeBuffer_Map Failed" << std::endl;
}
-
- // Unmap the ION memory from the process address space when it is no longer needed.
+
+// Unmap the ION memory from the process address space when it is no longer needed.
ret = OH_NativeBuffer_Unmap(buffer);
if (ret != 0) {
std::cout << "OH_NativeBuffer_Unmap Failed" << std::endl;
}
```
-
+
3. Obtain the memory properties.
```c++
// Obtain the properties of the OH_NativeBuffer instance.
diff --git a/en/application-dev/napi/native-image-guidelines.md b/en/application-dev/napi/native-image-guidelines.md
index 10142f438059908cef4320b5d01e2029cf6cfe16..46518e0985b2b8ab8403456fced4d16f69b1fcb9 100644
--- a/en/application-dev/napi/native-image-guidelines.md
+++ b/en/application-dev/napi/native-image-guidelines.md
@@ -27,6 +27,17 @@ For details about the APIs, see [native_image](../reference/native-apis/_o_h___n
The following steps describe how to use the native APIs provided by **NativeImage** to create an **OH_NativeImage** instance as the consumer and update the data to a OpenGL external texture.
+**Adding Dynamic Link Libraries**
+
+Add the following libraries to **CMakeLists.txt**:
+```txt
+libEGL.so
+libGLESv3.so
+libnative_image.so
+libnative_window.so
+libnative_buffer.so
+```
+
**Header File**
```c++
#include
@@ -159,41 +170,48 @@ The following steps describe how to use the native APIs provided by **NativeImag
4. Write the produced content to a **NativeWindowBuffer** instance.
1. Obtain a NativeWindowBuffer instance from the NativeWindow instance.
- ```c++
- OHNativeWindowBuffer* buffer = nullptr;
- int fenceFd;
- // Obtain a NativeWindowBuffer instance by calling OH_NativeWindow_NativeWindowRequestBuffer.
- OH_NativeWindow_NativeWindowRequestBuffer(nativeWindow, &buffer, &fenceFd);
- BufferHandle *handle = OH_NativeWindow_GetBufferHandleFromNative(buffer);
- int code = SET_BUFFER_GEOMETRY;
- int32_t width = 0x100;
- int32_t height = 0x100;
- ret = OH_NativeWindow_NativeWindowHandleOpt(nativeWindow, code, width, height);
- ```
- 3. Write the produced content to the **NativeWindowBuffer** instance.
- ```c++
- static uint32_t value = 0x00;
- value++;
- uint32_t *pixel = static_cast(handle->virAddr);
- for (uint32_t x = 0; x < width; x++) {
- for (uint32_t y = 0; y < height; y++) {
- *pixel++ = value;
- }
- }
- ```
- 4. Flush the **NativeWindowBuffer** to the **NativeWindow**.
- ```c++
- // Set the refresh region. If Rect in Region is a null pointer or rectNumber is 0, all contents in the NativeWindowBuffer are changed.
- Region region{nullptr, 0};
- // Flush the buffer to the consumer through OH_NativeWindow_NativeWindowFlushBuffer, for example, by displaying it on the screen.
- OH_NativeWindow_NativeWindowFlushBuffer(nativeWindow, buffer, fenceFd, region);
- ```
- 5. Destroy the **NativeWindow** instance when it is no longer needed.
- ```c++
- OH_NativeWindow_DestroyNativeWindow(nativeWindow);
- ```
-
+ ```c++
+ OHNativeWindowBuffer* buffer = nullptr;
+ int fenceFd;
+ // Obtain a NativeWindowBuffer instance by calling OH_NativeWindow_NativeWindowRequestBuffer.
+ OH_NativeWindow_NativeWindowRequestBuffer(nativeWindow, &buffer, &fenceFd);
+
+ BufferHandle *handle = OH_NativeWindow_GetBufferHandleFromNative(buffer);
+ int code = SET_BUFFER_GEOMETRY;
+ int32_t width = 0x100;
+ int32_t height = 0x100;
+ ret = OH_NativeWindow_NativeWindowHandleOpt(nativeWindow, code, width, height);
+ ```
+
+ 2. Write the produced content to the **NativeWindowBuffer** instance.
+
+ ```c++
+ static uint32_t value = 0x00;
+ value++;
+ uint32_t *pixel = static_cast(handle->virAddr);
+ for (uint32_t x = 0; x < width; x++) {
+ for (uint32_t y = 0; y < height; y++) {
+ *pixel++ = value;
+ }
+ }
+ ```
+
+ 3. Flush the **NativeWindowBuffer** to the **NativeWindow**.
+
+ ```c++
+ // Set the refresh region. If Rect in Region is a null pointer or rectNumber is 0, all contents in the NativeWindowBuffer are changed.
+ Region region{nullptr, 0};
+ // Flush the buffer to the consumer through OH_NativeWindow_NativeWindowFlushBuffer, for example, by displaying it on the screen.
+ OH_NativeWindow_NativeWindowFlushBuffer(nativeWindow, buffer, fenceFd, region);
+ ```
+
+ 4. Destroy the **NativeWindow** instance when it is no longer needed.
+
+ ```c++
+ OH_NativeWindow_DestroyNativeWindow(nativeWindow);
+ ```
+
5. Update the content to the OpenGL texture.
```c++
// Update the content to the OpenGL texture.
diff --git a/en/application-dev/napi/native-relational-store-guidelines.md b/en/application-dev/napi/native-relational-store-guidelines.md
new file mode 100644
index 0000000000000000000000000000000000000000..b2f545c5c9989e1e1cf63e6a6ab0030b09bceed4
--- /dev/null
+++ b/en/application-dev/napi/native-relational-store-guidelines.md
@@ -0,0 +1,182 @@
+# RelationalStore Development Guide
+
+
+## When to Use
+
+RelationalStore provides a complete mechanism for local database management. It offers a series of interfaces for adding, deleting, modifying, and querying data in an RDB store. To satisfy different needs in complicated scenarios, RelationalStore also supports direct execution of SQL statements.
+
+
+## Basic concepts
+
+- **OH_Predicates**: A representation of the property or feature of a data entity, or the relationship between data entities. It is used to define operation conditions.
+
+- **OH_Cursor**: A set of query results, which allows access to the required data in flexible modes.
+
+
+## Restrictions
+
+- The default logging mode is Write Ahead Log (WAL), and the default flushing mode is **FULL** mode.
+
+- RelationalStore supports a maximum of four connection pools to manage read and write operations.
+
+- To ensure data accuracy, only one write operation is allowed at a time.
+
+- Once an application is uninstalled, related database files and temporary files on the device are automatically deleted.
+
+
+## Available APIs
+
+For details about the APIs, see [RDB](../reference/native-apis/_r_d_b.md).
+
+| API| Description|
+| -------- | -------- |
+| OH_Rdb_GetOrOpen(const OH_Rdb_Config *config, int *errCode) | Obtains an OH_Rdb_Store instance for RDB store operations.|
+| OH_Rdb_Execute(OH_Rdb_Store *store, const char *sql) | Executes an SQL statement that contains specified arguments but returns no value.|
+| OH_Rdb_Insert(OH_Rdb_Store *store, const char *table, OH_VBucket *valuesBucket) | Inserts a row of data into a table.|
+| OH_Rdb_Update(OH_Rdb_Store *store, OH_VBucket *valuesBucket, OH_Predicates *predicates); | Updates data in the RDB store based on the specified OH_Predicates instance.|
+| OH_Rdb_Delete(OH_Rdb_Store *store, OH_Predicates *predicates) | Deletes data from the RDB store based on the specified OH_Predicates instance.|
+| OH_Rdb_Query(OH_Rdb_Store *store, OH_Predicates *predicates, const char *const *columnNames, int length) | Queries data in the RDB store based on specified conditions.|
+| OH_Rdb_DeleteStore(const OH_Rdb_Config *config) | Deletes an RDB store.|
+
+
+## How to Develop
+
+1. Obtain the OH_Rdb_Store instance and create a database file.
+
+ Example:
+
+ ```c
+ // Create an OH_Rdb_Config object.
+ OH_Rdb_Config config;
+ // The path is the application sandbox path.
+ config.dataBaseDir = "xxx";
+ // Database file name.
+ config.storeName = "RdbTest.db";
+ // Application bundle name.
+ config.bundleName = "xxx";
+ // Module name.
+ config.moduleName = "xxx";
+ // Security level of the database file.
+ config.securityLevel = OH_Rdb_SecurityLevel::S1;
+ // Whether the database is encrypted.
+ config.isEncrypt = false;
+ // Memory size occupied by config.
+ config.selfSize = sizeof(OH_Rdb_Config);
+
+ int errCode = 0;
+ // Obtain the OH_Rdb_Store instance.
+ OH_Rdb_Store *store_ = OH_Rdb_GetOrOpen(&config, &errCode);
+ ```
+
+2. After obtaining the OH_Rdb_Store instance, call **OH_Rdb_Execute** to create a table and call **OH_Rdb_Insert** to insert data to the table created.
+
+ Example:
+
+ ```c
+ char createTableSql[] = "CREATE TABLE IF NOT EXISTS EMPLOYEE (ID INTEGER PRIMARY KEY AUTOINCREMENT, NAME TEXT NOT NULL, "
+ "AGE INTEGER, SALARY REAL, CODES BLOB)";
+ // Create a table.
+ OH_Rdb_Execute(store_, createTableSql);
+
+ // Create a key-value pair instance.
+ OH_VBucket *valueBucket = OH_Rdb_CreateValuesBucket();
+ valueBucket->putText(valueBucket, "NAME", "Lisa");
+ valueBucket->putInt64(valueBucket, "AGE", 18);
+ valueBucket->putReal(valueBucket, "SALARY", 100.5);
+ uint8_t arr[] = {1, 2, 3, 4, 5};
+ int len = sizeof(arr) / sizeof(arr[0]);
+ valueBucket->putBlob(valueBucket, "CODES", arr, len);
+ // Insert data.
+ int rowId = OH_Rdb_Insert(store_, "EMPLOYEE", valueBucket);
+ // Destroy the KV pair instance.
+ valueBucket->destroy(valueBucket);
+ ```
+
+ > **NOTE**
+ >
+ > **RelationalStore** does not provide explicit flush operations for data persistence. **insert()** stores data in a file persistently.
+
+3. Modify or delete data based on the specified **Predicates** instance.
+
+ Call **OH_Rdb_Update** to modify data and call **OH_Rdb_Delete** to delete data.
+
+ Example:
+
+ ```c
+ // Modify data.
+ OH_VBucket *valueBucket = OH_Rdb_CreateValuesBucket();
+ valueBucket->putText(valueBucket, "NAME", "Rose");
+ valueBucket->putInt64(valueBucket, "AGE", 22);
+ valueBucket->putReal(valueBucket, "SALARY", 200.5);
+ uint8_t arr[] = {1, 2, 3, 4, 5};
+ int len = sizeof(arr) / sizeof(arr[0]);
+ valueBucket->putBlob(valueBucket, "CODES", arr, len);
+
+ OH_Predicates *predicates = OH_Rdb_CreatePredicates("EMPLOYEE");
+ OH_VObject *valueObject = OH_Rdb_CreateValueObject();
+ const char *name = "Lisa";
+ valueObject->putText(valueObject, name);
+ predicates->equalTo(predicates, "NAME", valueObject)->andOperate(predicates);
+ uint32_t count = 1;
+ double salary = 100.5;
+ valueObject->putDouble(valueObject, &salary, count);
+ predicates->equalTo(predicates, "SALARY", valueObject);
+
+ int changeRows = OH_Rdb_Update(store_, valueBucket, predicates);
+ valueObject->destroy(valueObject);
+ valueBucket->destroy(valueBucket);
+ predicates->destroy(predicates);
+ ```
+
+ ```c
+ // Delete data.
+ OH_Predicates *predicates = OH_Rdb_CreatePredicates("EMPLOYEE");
+ OH_VObject *valueObject = OH_Rdb_CreateValueObject();
+ const char *name = "Lisa";
+ valueObject->putText(valueObject, name);
+ predicates->equalTo(predicates, "NAME", valueObject);
+ int deleteRows = OH_Rdb_Delete(store_, predicates);
+ valueObject->destroy(valueObject);
+ predicates->destroy(predicates);
+ ```
+
+4. Query data based on the conditions specified by **Predicates**.
+
+ Call **OH_Rdb_Query** to query data. The data obtained is returned in a **OH_Cursor** object.
+
+ Example:
+
+ ```c
+ OH_Predicates *predicates = OH_Rdb_CreatePredicates("EMPLOYEE");
+
+ const char *columnNames[] = {"NAME", "AGE"};
+ int len = sizeof(columnNames) / sizeof(columnNames[0]);
+ OH_Cursor *cursor = OH_Rdb_Query(store_, predicates, columnNames, len);
+
+ int columnCount = 0;
+ cursor->getColumnCount(cursor, &columnCount);
+
+ // OH_Cursor is a cursor of a data set. By default, the cursor points to the -1st record. Valid data starts from 0.
+ int64_t age;
+ while (cursor->goToNextRow(cursor) == OH_Rdb_ErrCode::RDB_OK) {
+ cursor->getInt64(cursor, 1, &age);
+ }
+
+ // Destroy the Predicates instance.
+ predicates->destroy(predicates);
+ // Destroy the result set.
+ cursor->destroy(cursor);
+ ```
+
+5. Delete the database.
+
+ Call **OH_Rdb_DeleteStore** to delete an RDB store and related database files.
+
+ Example:
+
+ ```c
+ // Close the database instance.
+ OH_Rdb_CloseStore(store_);
+ // Delete the database file.
+ OH_Rdb_DeleteStore(&config);
+ ```
diff --git a/en/application-dev/napi/native-vsync-guidelines.md b/en/application-dev/napi/native-vsync-guidelines.md
index 548a791e97ee75a1ee4ad83123893c5495181b59..f43495857483fc529ce03b565011a59e98fc07a7 100644
--- a/en/application-dev/napi/native-vsync-guidelines.md
+++ b/en/application-dev/napi/native-vsync-guidelines.md
@@ -6,12 +6,12 @@ The **NativeVSync** module is used to obtain virtual synchronization (VSync) sig
## Available APIs
-| API| Description:|
+| API| Description|
| -------- | -------- |
-| OH_NativeVSync_Create (const char \*name, unsigned int length) | Creates an **OH_NativeVSync** instance. A new **OH_NativeVSync** instance is created each time this function is called.|
-| OH_NativeVSync_Destroy (OH_NativeVSync \*nativeVsync) | Destroys an **OH_NativeVSync** instance.|
-| OH_NativeVSync_FrameCallback (long long timestamp, void \*data) | Sets a callback function. **timestamp** indicates the timestamp, and **data** indicates the input parameter of the callback function. |
-| OH_NativeVSync_RequestFrame (OH_NativeVSync \*nativeVsync, OH_NativeVSync_FrameCallback callback, void \*data) | Requests the next VSync signal. When the signal arrives, a callback function is invoked.|
+| OH_NativeVSync_Create (const char \*name, unsigned int length) | Creates an **OH_NativeVSync** instance. A new **OH_NativeVSync** instance is created each time this function is called.|
+| OH_NativeVSync_Destroy (OH_NativeVSync \*nativeVsync) | Destroys an **OH_NativeVSync** instance.|
+| OH_NativeVSync_FrameCallback (long long timestamp, void \*data) | Sets a callback function. **timestamp** indicates the timestamp, and **data** indicates the input parameter of the callback function.|
+| OH_NativeVSync_RequestFrame (OH_NativeVSync \*nativeVsync, OH_NativeVSync_FrameCallback callback, void \*data) | Requests the next VSync signal. When the signal arrives, a callback function is invoked.|
For details about the APIs, see [native_vsync](../reference/native-apis/_native_vsync.md).
@@ -19,6 +19,13 @@ For details about the APIs, see [native_vsync](../reference/native-apis/_native_
The following steps describe how to use the native APIs provided by **NativeVSync** to create and destroy an **OH_NativeVSync** instance and set the VSync callback function.
+**Adding Dynamic Link Libraries**
+
+Add the following library to **CMakeLists.txt**:
+```txt
+libnative_vsync.so
+```
+
**Header File**
```c++
#include
@@ -33,12 +40,12 @@ The following steps describe how to use the native APIs provided by **NativeVSyn
std::cout << "OnVSync: " << timestamp << std::endl;
}
OH_NativeVSync_FrameCallback callback = OnVSync; // The callback function must be of the OH_NativeVSync_FrameCallback type.
- ```
+ ```
2. Create an **OH_NativeVSync** instance.
```c++
char name[] = "hello_vsync";
OH_NativeVSync* nativeVSync = OH_NativeVSync_Create(name, strlen(name));
- ```
+ ```
3. Set the VSync callback function through the **OH_NativeVSync** instance.
```c++
diff --git a/en/application-dev/napi/native-window-guidelines.md b/en/application-dev/napi/native-window-guidelines.md
index f6f4e44b5edd8f40757105b4c050d4c9b2b0363d..5c5a62ab3d256689d1d467595797e3f2c605b679 100644
--- a/en/application-dev/napi/native-window-guidelines.md
+++ b/en/application-dev/napi/native-window-guidelines.md
@@ -11,11 +11,11 @@ The following scenarios are common for NativeWindow development:
## Available APIs
-| API| Description|
+| API| Description|
| -------- | -------- |
-| OH_NativeWindow_NativeWindowRequestBuffer (OHNativeWindow \*window, OHNativeWindowBuffer \*\*buffer, int \*fenceFd) | Requests an **OHNativeWindowBuffer** through an **OHNativeWindow** instance for content production.|
-| OH_NativeWindow_NativeWindowFlushBuffer (OHNativeWindow \*window, OHNativeWindowBuffer \*buffer, int fenceFd, Region region) | Flushes the **OHNativeWindowBuffer** filled with the content to the buffer queue through an **OHNativeWindow** instance for content consumption.|
-| OH_NativeWindow_NativeWindowHandleOpt (OHNativeWindow \*window, int code,...) | Sets or obtains the attributes of an **OHNativeWindow**, including the width, height, and content format.|
+| OH_NativeWindow_NativeWindowRequestBuffer (OHNativeWindow \*window, OHNativeWindowBuffer \*\*buffer, int \*fenceFd) | Requests an **OHNativeWindowBuffer** through an **OHNativeWindow** instance for content production.|
+| OH_NativeWindow_NativeWindowFlushBuffer (OHNativeWindow \*window, OHNativeWindowBuffer \*buffer, int fenceFd, Region region) | Flushes the **OHNativeWindowBuffer** filled with the content to the buffer queue through an **OHNativeWindow** instance for content consumption.|
+| OH_NativeWindow_NativeWindowHandleOpt (OHNativeWindow \*window, int code,...) | Sets or obtains the attributes of an **OHNativeWindow**, including the width, height, and content format.|
For details about the APIs, see [native_window](../reference/native-apis/_native_window.md).
@@ -37,7 +37,7 @@ libnative_window.so
#include
```
-1. Obtain an **OHNativeWindow** instance.
+1. Obtain an **OHNativeWindow** instance.
You can call the APIs provided by [OH_NativeXComponent_Callback](../reference/native-apis/_o_h___native_x_component___callback.md) to obtain an **OHNativeWindow** instance. An example code snippet is provided below. For details about how to use the **\**, see [XComponent Development](xcomponent-guidelines.md).
1. Add an **\** to the .ets file.
@@ -159,5 +159,3 @@ libnative_window.so
// munmap failed
}
```
-
-
\ No newline at end of file
diff --git a/en/application-dev/napi/neural-network-runtime-guidelines.md b/en/application-dev/napi/neural-network-runtime-guidelines.md
index 344ae4f1d623f67fcd3b093e8dec6653b806c4f2..974ccc5bafbfe7169034924ba27d0eb3c91606a8 100644
--- a/en/application-dev/napi/neural-network-runtime-guidelines.md
+++ b/en/application-dev/napi/neural-network-runtime-guidelines.md
@@ -1,4 +1,4 @@
-# Connecting the Neural Network Runtime to an AI Inference Framework
+# Development Guide for Connecting the Neural Network Runtime to an AI Inference Framework
## When to Use
@@ -19,8 +19,7 @@ The environment requirements for the Neural Network Runtime are as follows:
- Development environment: Ubuntu 18.04 or later.
- Access device: a standard device running OpenHarmony. The built-in hardware accelerator driver has been connected to the Neural Network Runtime through an HDI API.
-The Neural Network Runtime is opened to external systems through OpenHarmony Native APIs. Therefore, you need to use the Native development suite of the OpenHarmony to compile Neural Network Runtime applications.
-
+The Neural Network Runtime is opened to external systems through OpenHarmony Native APIs. Therefore, you need to use the Native development suite of the OpenHarmony to compile Neural Network Runtime applications.
### Environment Setup
@@ -33,7 +32,6 @@ unzip native-linux-{version number}.zip
```
The directory structure after decompression is as follows. The content in the directory may vary depending on version iteration. Use the Native APIs of the latest version.
-
```text
native/
─ ─ build // Cross-compilation toolchain
@@ -488,4 +486,4 @@ The development process of the Neural Network Runtime consists of three phases:
```shell
rm /data/local/tmp/*nncache
- ```
\ No newline at end of file
+ ```
diff --git a/en/application-dev/napi/vulkan-guidelines.md b/en/application-dev/napi/vulkan-guidelines.md
index e55b53cd38d44fb5d5a893cdbc21d175b9b0c8df..6ce31b8e1339633bcaa45f47637204f3b4ecef84 100644
--- a/en/application-dev/napi/vulkan-guidelines.md
+++ b/en/application-dev/napi/vulkan-guidelines.md
@@ -18,6 +18,15 @@ For details about the APIs, see [Vulkan](../reference/native-lib/third_party_vul
The following steps illustrate how to create a **VkSurfaceKHR** instance.
+**Adding Dynamic Link Libraries**
+
+Add the following libraries to **CMakeLists.txt**:
+```txt
+libace_ndk.z.so
+libnative_window.so
+libvulkan.so
+```
+
**Header File**
```c++
#include
diff --git a/en/application-dev/quick-start/arkts-appstorage.md b/en/application-dev/quick-start/arkts-appstorage.md
index 50cbcf6aa0854fc901eb6bbf80b41da7c990eaa1..c1ebb9c91252d5b75a96b837e6f07bd2f1053a56 100644
--- a/en/application-dev/quick-start/arkts-appstorage.md
+++ b/en/application-dev/quick-start/arkts-appstorage.md
@@ -23,8 +23,7 @@ Selected state attributes of AppStorage can be synced with different data source
As mentioned above, if you want to establish a binding between AppStorage and a custom component, you'll need the \@StorageProp and \@StorageLink decorators. Use \@StorageProp(key) or \@StorageLink(key) to decorate variables in the component, where **key** identifies the attribute in AppStorage.
-When a custom component is initialized, the \@StorageProp(key)/\@StorageLink(key) decorated variable is initialized with the value of the attribute with the given key in AppStorage. Local initialization is mandatory. If an attribute with the given key is missing from AppStorage, it will be added with the stated initializing value. (Whether the attribute with the given key exists in AppStorage depends on the application logic.)
-
+When a custom component is initialized, the \@StorageProp(key)/\@StorageLink(key) decorated variable is initialized with the value of the attribute with the given key in AppStorage. Whether the attribute with the given key exists in AppStorage depends on the application logic. This means that the attribute with the given key may be missing from AppStorage. In light of this, local initialization is mandatory for the \@StorageProp(key)/\@StorageLink(key) decorated variable.
By decorating a variable with \@StorageProp(key), a one-way data synchronization is established with the attribute with the given key in AppStorage. A local change can be made, but it will not be synchronized to AppStorage. An update to the attribute with the given key in AppStorage will overwrite local changes.
@@ -193,9 +192,85 @@ struct CompA {
}
```
-### Persistent Subscription and Callback
+### Unrecommended: Using @StorageLink to Implement Event Notification
+
+Compared with the common mechanism for event notification, the two-way synchronization mechanism of @StorageLink and AppStorage is far less cost efficient and therefore not recommended. This is because AppStorage stores UI-related data, and its changes will cause costly UI refresh.
+
+In the following example, any tap event in the **TapImage** component will trigger a change of the **tapIndex** attribute. As @StorageLink establishes a two-way data synchronization with AppStorage, the local change is synchronized to AppStorage. As a result, all visible custom components owning the **tapIndex** attribute bound to AppStorage are notified to refresh the UI.
+
+
+```ts
+// xxx.ets
+class ViewData {
+ title: string;
+ uri: Resource;
+ color: Color = Color.Black;
+
+ constructor(title: string, uri: Resource) {
+ this.title = title;
+ this.uri = uri
+ }
+}
+
+@Entry
+@Component
+struct Gallery2 {
+ dataList: Array = [new ViewData('flower', $r('app.media.icon')), new ViewData('OMG', $r('app.media.icon')), new ViewData('OMG', $r('app.media.icon'))]
+ scroller: Scroller = new Scroller()
+
+ build() {
+ Column() {
+ Grid(this.scroller) {
+ ForEach(this.dataList, (item: ViewData, index?: number) => {
+ GridItem() {
+ TapImage({
+ uri: item.uri,
+ index: index
+ })
+ }.aspectRatio(1)
+
+ }, (item: ViewData, index?: number) => {
+ return JSON.stringify(item) + index;
+ })
+ }.columnsTemplate('1fr 1fr')
+ }
+
+ }
+}
+
+@Component
+export struct TapImage {
+ @StorageLink('tapIndex') @Watch('onTapIndexChange') tapIndex: number = -1;
+ @State tapColor: Color = Color.Black;
+ private index: number;
+ private uri: Resource;
+
+ // Check whether the component is selected.
+ onTapIndexChange() {
+ if (this.tapIndex >= 0 && this.index === this.tapIndex) {
+ console.info(`tapindex: ${this.tapIndex}, index: ${this.index}, red`)
+ this.tapColor = Color.Red;
+ } else {
+ console.info(`tapindex: ${this.tapIndex}, index: ${this.index}, black`)
+ this.tapColor = Color.Black;
+ }
+ }
-The persistent subscription and callback can help reduce overhead and enhance code readability.
+ build() {
+ Column() {
+ Image(this.uri)
+ .objectFit(ImageFit.Cover)
+ .onClick(() => {
+ this.tapIndex = this.index;
+ })
+ .border({ width: 5, style: BorderStyle.Dotted, color: this.tapColor })
+ }
+
+ }
+}
+```
+
+To implement event notification with less overhead and higher code readability, use **emit** instead, with which you can subscribe to an event and receive event callback.
```ts
@@ -294,10 +369,9 @@ export struct TapImage {
}
```
-The following example uses the message mechanism to subscribe to events. Because this mechanism can result in a large number of nodes to listen for and a long implementation time, it is not recommended.
-
+The preceding notification logic is simple. It can be simplified into a ternary expression as follows:
-```ts
+```
// xxx.ets
class ViewData {
title: string;
@@ -338,22 +412,11 @@ struct Gallery2 {
@Component
export struct TapImage {
- @StorageLink('tapIndex') @Watch('onTapIndexChange') tapIndex: number = -1;
+ @StorageLink('tapIndex') tapIndex: number = -1;
@State tapColor: Color = Color.Black;
private index: number;
private uri: Resource;
- // Check whether the component is selected.
- onTapIndexChange() {
- if (this.tapIndex >= 0 && this.index === this.tapIndex) {
- console.info(`tapindex: ${this.tapIndex}, index: ${this.index}, red`)
- this.tapColor = Color.Red;
- } else {
- console.info(`tapindex: ${this.tapIndex}, index: ${this.index}, black`)
- this.tapColor = Color.Black;
- }
- }
-
build() {
Column() {
Image(this.uri)
@@ -361,14 +424,18 @@ export struct TapImage {
.onClick(() => {
this.tapIndex = this.index;
})
- .border({ width: 5, style: BorderStyle.Dotted, color: this.tapColor })
+ .border({
+ width: 5,
+ style: BorderStyle.Dotted,
+ color: (this.tapIndex >= 0 && this.index === this.tapIndex) ? Color.Red : Color.Black
+ })
}
-
}
}
```
+
## Restrictions
When using AppStorage together with [PersistentStorage](arkts-persiststorage.md) and [Environment](arkts-environment.md), pay attention to the following:
@@ -377,5 +444,5 @@ When using AppStorage together with [PersistentStorage](arkts-persiststorage.md)
- A call to **Environment.EnvProp()** after creating the attribute in AppStorage will fail. This is because AppStorage already has an attribute with the same name, and the environment variable will not be written into AppStorage. Therefore, you are advised not to use the preset environment variable name in AppStorage.
-- Changes to the variables decorated by state decorators will cause UI re-render. If the changes are for message communication, rather than for UI re-render, the emitter mode is recommended. For the example, see [Persistent Subscription and Callback](#persistent-subscription-and-callback).
+- Changes to the variables decorated by state decorators will cause UI re-render. If the changes are for message communication, rather than for UI re-render, the emitter mode is recommended. For the example, see [Unrecommended: Using @StorageLink to Implement Event Notification](#unrecommended-using-storagelink-to-implement-event-notification).
diff --git a/en/application-dev/quick-start/arkts-builder.md b/en/application-dev/quick-start/arkts-builder.md
index 80a262fcd97a0dcf6808bf8cdb84bf78849cb0e1..ab1c53b103db98c49fa42a21f69adff6ea32b86b 100644
--- a/en/application-dev/quick-start/arkts-builder.md
+++ b/en/application-dev/quick-start/arkts-builder.md
@@ -21,14 +21,14 @@ Syntax:
```ts
-@Builder myBuilderFunction({ ... })
+@Builder MyBuilderFunction({ ... })
```
Usage:
```ts
-this.myBuilderFunction({ ... })
+this.MyBuilderFunction({ ... })
```
- Defining one or more custom builder (\@Builder decorated) functions inside a custom component is allowed. Such a custom builder function can be considered as a private, special type of member functions of that component.
@@ -66,7 +66,7 @@ There are two types of parameter passing for custom builder functions: [by-value
- The parameter type must be the same as the declared parameter type. The **undefined** or **null** constants as well as expressions evaluating to these values are not allowed.
-- All parameters are immutable inside the custom builder function. If mutability and synchronization of the mutation is required, the custom builder should be replaced by a custom component with a [@Link](arkts-link.md) decorated variable.
+- All parameters are immutable inside the@Builder decorated function.
- The \@Builder function body follows the same [syntax rules](arkts-create-custom-components.md#build-function) as the **build** function.
diff --git a/en/application-dev/quick-start/arkts-create-custom-components.md b/en/application-dev/quick-start/arkts-create-custom-components.md
index 9548ad942cbd5ba3a24e4bcfe57ab71a0fb37043..45efde654b917c333e52d1f0d294282569622c45 100644
--- a/en/application-dev/quick-start/arkts-create-custom-components.md
+++ b/en/application-dev/quick-start/arkts-create-custom-components.md
@@ -70,8 +70,6 @@ To fully understand the preceding example, a knowledge of the following concepts
- [Universal Style of a Custom Component](#universal-style-of-a-custom-component)
-- [Custom Attribute Methods](#custom-attribute-methods)
-
## Basic Structure of a Custom Component
@@ -106,6 +104,8 @@ To fully understand the preceding example, a knowledge of the following concepts
> **NOTE**
>
> Since API version 9, this decorator is supported in ArkTS widgets.
+ >
+ > Since API version 10, the \@Entry decorator accepts an optional parameter of type [LocalStorage](arkts-localstorage.md) or type [EntryOptions](#entryoptions10).
```ts
@Entry
@@ -114,6 +114,23 @@ To fully understand the preceding example, a knowledge of the following concepts
}
```
+ ### EntryOptions10+
+
+ Describes the named route options.
+
+ | Name | Type | Mandatory| Description |
+ | ------ | ------ | ---- | ------------------------------------------------------------ |
+ | routeName | string | No| Name of the target named route.|
+ | storage | [LocalStorage](arkts-localstorage.md) | No| Storage of page-level UI state.|
+
+ ```ts
+ @Entry({ routeName : 'myPage' })
+ @Component
+ struct MyComponent {
+ }
+ ```
+
+
- \@Recycle: A custom component decorated with \@Recycle can be reused.
> **NOTE**
@@ -328,68 +345,4 @@ struct MyComponent {
>
> When ArkUI sets styles for custom components, an invisible container component is set for **MyComponent2**. These styles are set on the container component instead of the **\** component of **MyComponent2**. As seen from the rendering result, the red background color is not directly applied to the button. Instead, it is applied to the container component that is invisible to users where the button is located.
-
-## Custom Attribute Methods
-
-Custom components do not support custom attribute methods. You can use the Controller capability to implement custom APIs.
-
-
-```ts
-// Custom controller
-export class MyComponentController {
- item: MyComponent = null;
-
- setItem(item: MyComponent) {
- this.item = item;
- }
-
- changeText(value: string) {
- this.item.value = value;
- }
-}
-
-// Custom component
-@Component
-export default struct MyComponent {
- public controller: MyComponentController = null;
- @State value: string = 'Hello World';
-
- build() {
- Column() {
- Text(this.value)
- .fontSize(50)
- }
- }
-
- aboutToAppear() {
- if (this.controller)
- this.controller.setItem (this); // Link to the controller.
- }
-}
-
-// Processing logic
-@Entry
-@Component
-struct StyleExample {
- controller = new MyComponentController();
-
- build() {
- Column() {
- MyComponent({ controller: this.controller })
- }
- .onClick(() => {
- this.controller.changeText('Text');
- })
- }
-}
-```
-
-In the preceding example:
-
-1. The **aboutToAppear** method of the **MyComponent** child component passes the current **this** pointer to the **item** member variable of **MyComponentController**.
-
-2. The **StyleExample** parent component holds a **Controller** instance and with which calls the **changeText** API of **Controller**. That is, the value of the state variable **value** of **MyComponent** is changed through the **this** pointer of the **MyComponent** child component held by the controller.
-
-Through the encapsulation of the controller, **MyComponent** exposes the **changeText** API. All instances that hold the controller can call the **changeText** API to change the value of the **MyComponent** state variable **value**.
-
diff --git a/en/application-dev/quick-start/arkts-environment.md b/en/application-dev/quick-start/arkts-environment.md
index 2f0718290460508c4510acc298fa85c855bbec26..ac80bd54590b0dffdfa6b3bf82351d27f09917a1 100644
--- a/en/application-dev/quick-start/arkts-environment.md
+++ b/en/application-dev/quick-start/arkts-environment.md
@@ -15,12 +15,11 @@ Environment is a singleton object created by the ArkUI framework at application
- Use **Environment.EnvProp** to save the environment variables of the device to AppStorage.
```ts
- // Save the language code of the device to AppStorage. The default value is en.
- // Whenever its value changes in the device environment, it will update its value in AppStorage.
+ // Save languageCode to AppStorage. The default value is en.
Environment.EnvProp('languageCode', 'en');
```
-- To keep a component variable updated with changes in the device environment, this variable should be decorated with \@StorageProp.
+- Decorate the variables with \@StorageProp to link them with components.
```ts
@StorageProp('languageCode') lang : string = 'en';
@@ -29,6 +28,7 @@ Environment is a singleton object created by the ArkUI framework at application
The chain of updates is as follows: Environment > AppStorage > Component.
> **NOTE**
+>
> An \@StorageProp decorated variable can be locally modified, but the change will not be updated to AppStorage. This is because the environment variable parameters are read-only to the application.
@@ -69,3 +69,29 @@ if (lang.get() === 'en') {
console.info('Hello!');
}
```
+
+
+## Restrictions
+
+
+Environment can be called only when the [UIContext](../reference/apis/js-apis-arkui-UIContext.md#uicontext), which can be obtained through [runScopedTask](../reference/apis/js-apis-arkui-UIContext.md#runscopedtask), is specified. If Environment is called otherwise, no device environment data can be obtained.
+
+
+```ts
+// EntryAbility.ts
+import UIAbility from '@ohos.app.ability.UIAbility';
+import window from '@ohos.window';
+
+export default class EntryAbility extends UIAbility {
+ onWindowStageCreate(windowStage: window.WindowStage) {
+ windowStage.loadContent('pages/Index');
+ let window = windowStage.getMainWindow()
+ window.then(window => {
+ let uicontext = window.getUIContext()
+ uicontext.runScopedTask(() => {
+ Environment.EnvProp('languageCode', 'en');
+ })
+ })
+ }
+}
+```
diff --git a/en/application-dev/quick-start/arkts-localstorage.md b/en/application-dev/quick-start/arkts-localstorage.md
index 0116d2e18f9023d5769b6b0b67b561b41bb0e149..392dda8432319b5695c593de178c5193fcf2a976 100644
--- a/en/application-dev/quick-start/arkts-localstorage.md
+++ b/en/application-dev/quick-start/arkts-localstorage.md
@@ -36,7 +36,7 @@ LocalStorage provides two decorators based on the synchronization type of the co
## Restrictions
- Once created, the type of a named attribute cannot be changed. Subsequent calls to **Set** must set a value of same type.
-- LocalStorage provides page-level storage. The [GetShared](../reference/arkui-ts/ts-state-management.md#getshared9) API can only obtain the LocalStorage instance transferred through [windowStage.loadContent](../reference/apis/js-apis-window.md#loadcontent9) in the current stage. Otherwise, **undefined** is returned. Example: [Sharing a LocalStorage Instance from UIAbility to One or More Pages](#sharing-a-localstorage-instance-from-uiability-to-one-or-more-pages).
+- LocalStorage provides page-level storage. The [GetShared](../reference/arkui-ts/ts-state-management.md#getshared10) API can only obtain the LocalStorage instance passed through [windowStage.loadContent](../reference/apis/js-apis-window.md#loadcontent9) in the current stage. If the instance is not available, **undefined** is returned. For the example, see [Example of Sharing a LocalStorage Instance from UIAbility to One or More Pages](#example-of-sharing-a-localstorage-instance-from-uiability-to-one-or-more-pages).
## \@LocalStorageProp
@@ -300,9 +300,9 @@ struct CompA {
```
-### State Variable Synchronization Between Sibling Nodes
+### Example of Syncing State Variable Between Sibling Components
-This example shows how to use \@LocalStorageLink to create a two-way synchronization for the state between sibling nodes.
+This example shows how to use \@LocalStorageLink to create a two-way synchronization for the state between sibling components.
Check the changes in the **Parent** custom component.
@@ -377,7 +377,7 @@ Changes in the **Child** custom component:
```
-### Sharing a LocalStorage Instance from UIAbility to One or More Pages
+### Example of Sharing a LocalStorage Instance from UIAbility to One or More Pages
In the preceding examples, the LocalStorage instance is shared only in an \@Entry decorated component and its owning child component (a page). To enable a LocalStorage instance to be shared across pages, you can create a LocalStorage instance in the owning UIAbility and call windowStage.[loadContent](../reference/apis/js-apis-window.md#loadcontent9).
diff --git a/en/application-dev/quick-start/arkts-observed-and-objectlink.md b/en/application-dev/quick-start/arkts-observed-and-objectlink.md
index 61f1bd8ae476f5984405eed97fb127161bb131e2..a7e47fb63e57896158a6a03aaa6896bea7ac644f 100644
--- a/en/application-dev/quick-start/arkts-observed-and-objectlink.md
+++ b/en/application-dev/quick-start/arkts-observed-and-objectlink.md
@@ -162,6 +162,26 @@ class ClassB {
this.a = a;
}
}
+
+@Observed
+class ClassD {
+ public c: ClassC;
+
+ constructor(c: ClassC) {
+ this.c = c;
+ }
+}
+
+@Observed
+class ClassC extends ClassA {
+ public k: number;
+
+ constructor(k: number) {
+ // Invoke the parent class method to process k.
+ super(k);
+ this.k = k;
+ }
+}
```
@@ -169,60 +189,64 @@ class ClassB {
```ts
@Component
-struct ViewA {
- label: string = 'ViewA1';
- @ObjectLink a: ClassA;
+struct ViewC {
+ label: string = 'ViewC1';
+ @ObjectLink c: ClassC;
build() {
Row() {
- Button(`ViewA [${this.label}] this.a.c=${this.a.c} +1`)
- .onClick(() => {
- this.a.c += 1;
- })
- }
+ Column() {
+ Text(`ViewC [${this.label}] this.a.c = ${this.c.c}`)
+ .fontColor('#ffffffff')
+ .backgroundColor('#ff3fc4c4')
+ .height(50)
+ .borderRadius(25)
+ Button(`ViewC: this.c.c add 1`)
+ .backgroundColor('#ff7fcf58')
+ .onClick(() => {
+ this.c.c += 1;
+ console.log('this.c.c:' + this.c.c)
+ })
+ }
+ .width(300)
}
}
+}
@Entry
@Component
struct ViewB {
@State b: ClassB = new ClassB(new ClassA(0));
-
+ @State child : ClassD = new ClassD(new ClassC(0));
build() {
Column() {
- ViewA({ label: 'ViewA #1', a: this.b.a })
- ViewA({ label: 'ViewA #2', a: this.b.a })
-
- Button(`ViewB: this.b.a.c+= 1`)
- .onClick(() => {
- this.b.a.c += 1;
- })
- Button(`ViewB: this.b.a = new ClassA(0)`)
+ ViewC({ label: 'ViewC #3', c: this.child.c})
+ Button(`ViewC: this.child.c.c add 10`)
+ .backgroundColor('#ff7fcf58')
.onClick(() => {
- this.b.a = new ClassA(0);
- })
- Button(`ViewB: this.b = new ClassB(ClassA(0))`)
- .onClick(() => {
- this.b = new ClassB(new ClassA(0));
+ this.child.c.c += 10
+ console.log('this.child.c.c:' + this.child.c.c)
})
}
}
}
```
+The @Observed decorated **ClassC** class can observe changes in attributes inherited from the base class.
+
Event handlers in **ViewB**:
-- this.b.a = new ClassA(0) and this.b = new ClassB(new ClassA(0)): Change to the \@State decorated variable **b** and its attributes.
+- this.child.c = new ClassA(0) and this.b = new ClassB(new ClassA(0)): Change to the \@State decorated variable **b** and its attributes.
-- this.b.a.c = ... : Change at the second layer. Though [@State](arkts-state.md#observed-changes) cannot observe the change at the second layer, the change of an attribute of \@Observed decorated ClassA, which is attribute **c** in this example, can be observed by \@ObjectLink.
+- this.child.c.c = ... : Change at the second layer. Though [@State](arkts-state.md#observed-changes) cannot observe the change at the second layer, the change of an attribute of \@Observed decorated ClassA, which is attribute **c** in this example, can be observed by \@ObjectLink.
-Event handlers in **ViewA**:
+Event handle in **ViewC**:
-- this.a.c += 1: Changes to the \@ObjectLink decorated variable cause the button label to be updated. Unlike \@Prop, \@ObjectLink does not have a copy of its source. Instead, \@ObjectLink creates a reference to its source.
+- this.c.c += 1: Changes to the \@ObjectLink decorated variable **a** cause the button label to be updated. Unlike \@Prop, \@ObjectLink does not have a copy of its source. Instead, \@ObjectLink creates a reference to its source.
- The \@ObjectLink decorated variable is read-only. Assigning **this.a = new ClassA(...)** is not allowed. Once value assignment occurs, the reference to the data source is reset and the synchronization is interrupted.
@@ -297,7 +321,7 @@ struct ViewB {
2. ViewA({ label: ViewA this.arrA[first], a: this.arrA[0] }): The preceding update changes the first element in the array. Therefore, the **ViewA** component instance bound to **this.arrA[0]** is updated.
- this.arrA.push(new ClassA(0)): The change of this state variable triggers two updates with different effects.
- 1. ForEach: The newly added Class A object is unknown to the **ForEach** [itemGenerator](arkts-rendering-control-foreach.md#api-description). The item builder of **ForEach** will be executed to create a **View A** component instance.
+ 1. ForEach: The newly added **ClassA** object is unknown to the **ForEach** [itemGenerator](arkts-rendering-control-foreach.md#api-description). The item builder of **ForEach** will be executed to create a **ViewA** component instance.
2. ViewA({ label: ViewA this.arrA[last], a: this.arrA[this.arrA.length-1] }): The last item of the array is changed. As a result, the second **View A** component instance is changed. For **ViewA({ label: ViewA this.arrA[first], a: this.arrA[0] })**, a change to the array does not trigger a change to the array item, so the first **View A** component instance is not refreshed.
- this.arrA[Math.floor (this.arrA.length/2)].c: [@State](arkts-state.md#observed-changes) cannot observe changes at the second layer. However, as **ClassA** is decorated by \@Observed, the change of its attributes will be observed by \@ObjectLink.
diff --git a/en/application-dev/quick-start/arkts-persiststorage.md b/en/application-dev/quick-start/arkts-persiststorage.md
index 303402ac5a2dffe2537fa4b252a21fcfe31631ad..21c854c26557e5fcd5027623b0429b625d6c9c91 100644
--- a/en/application-dev/quick-start/arkts-persiststorage.md
+++ b/en/application-dev/quick-start/arkts-persiststorage.md
@@ -24,7 +24,7 @@ Persistence of data is a relatively slow operation. Applications should avoid th
The preceding situations may overload the change process of persisted data. As a result, the PersistentStorage implementation may limit the change frequency of persisted attributes.
-PersistentStorage is associated with UIContext and can be called to persist data only when [UIContext](../reference/apis/js-apis-arkui-UIContext.md#uicontext) is specified. The context can be identified in [runScopedTask](../reference/apis/js-apis-arkui-UIContext.md#runscopedtask).
+PersistentStorage can be called to persist data only when the [UIContext](../reference/apis/js-apis-arkui-UIContext.md#uicontext), which can be obtained through [runScopedTask](../reference/apis/js-apis-arkui-UIContext.md#runscopedtask), is specified.
## Application Scenarios
@@ -92,7 +92,7 @@ struct Index {
1. The state variable **\@StorageLink('aProp') aProp** is updated, triggering the **\** component to be re-rendered.
2. The two-way synchronization between the \@StorageLink decorated variable and AppStorage results in the change of the **\@StorageLink('aProp') aProp** being synchronized back to AppStorage.
3. The change of the **aProp** attribute in AppStorage triggers any other one-way or two-way bound variables to be updated. (In this example, there are no such other variables.)
- 4. Because the attribute corresponding to **aProp** has been persisted, the change of the **aProp** attribute in AppStorage triggers PersistentStorage to write the attribute and its changed value to the device disk.
+ 4. Because the attribute corresponding to **aProp** has been persisted, the change of the **aProp** attribute in AppStorage triggers PersistentStorage to write the attribute and its new value to the device disk.
- Subsequent application running:
1. **PersistentStorage.PersistProp('aProp', 47)** is called. A search for the **aProp** attribute on the PersistentStorage disk succeeds.
diff --git a/en/application-dev/quick-start/arkts-prop.md b/en/application-dev/quick-start/arkts-prop.md
index 968673943256251a8d35a842663d2976ee5b5019..9838e932ff4288d0ce385f50a89492136439b058 100644
--- a/en/application-dev/quick-start/arkts-prop.md
+++ b/en/application-dev/quick-start/arkts-prop.md
@@ -528,11 +528,11 @@ struct MyComponent {
}
Row() {
- Button('Click to change locally !').width(480).height(60).margin({ top: 10 })
+ Button('Click to change locally !').width(180).height(60).margin({ top: 10 })
.onClick(() => {
this.customCounter2++
})
- }.height(100).width(480)
+ }.height(100).width(180)
Row() {
Text(`Custom Local: ${this.customCounter2}`).width(90).height(40).fontColor('#FF0010')
@@ -563,7 +563,7 @@ struct MainProgram {
MyComponent({ customCounter: this.mainCounter })
// customCounter2 of the child component can also be initialized from the parent component. The value from the parent component overwrites the locally assigned value of customCounter2 during initialization.
MyComponent({ customCounter: this.mainCounter, customCounter2: this.mainCounter })
- }.width('40%')
+ }
}
}
}
diff --git a/en/application-dev/quick-start/arkts-rendering-control-foreach.md b/en/application-dev/quick-start/arkts-rendering-control-foreach.md
index 4c916bec86f9c9d22b9bdb60ca476f9cbdcd4846..dc6ae173f51df82fbc48f26df56368450fa6fa79 100644
--- a/en/application-dev/quick-start/arkts-rendering-control-foreach.md
+++ b/en/application-dev/quick-start/arkts-rendering-control-foreach.md
@@ -3,6 +3,9 @@
**ForEach** enables repeated content based on array-type data.
+> **NOTE**
+>
+> Since API version 9, this API is supported in ArkTS widgets.
## API Description
@@ -19,15 +22,15 @@ ForEach(
| Name | Type | Mandatory | Description |
| ------------- | ---------------------------------------- | ---- | ---------------------------------------- |
| arr | Array | Yes | An array, which can be empty, in which case no child component is created. The functions that return array-type values are also allowed, for example, **arr.slice (1, 3)**. The set functions cannot change any state variables including the array itself, such as **Array.splice**, **Array.sort**, and **Array.reverse**.|
-| itemGenerator | (item: any, index?: number) => void | Yes | A lambda function used to generate one or more child components for each data item in an array. Each component and its child component list must be contained in parentheses.** child component is allowed only when the parent container component of **ForEach** is **\**.** child component is allowed only when the parent container component of **ForEach** is **\**.(deprecated) | number | Invoked when data is added to the position indicated by the specified index.(deprecated) | from: number,(deprecated) | number | Invoked when data is deleted from the position indicated by the specified index. LazyForEach will update the displayed content accordingly.(deprecated) | number | Invoked when data in the position indicated by the specified index is changed.8+ | number | Invoked when data is added to the position indicated by the specified index.8+ | from: number,8+ | number | Invoked when data is added to the position indicated by the specified index.8+ | from: number,8+ | number | Invoked when data is deleted from the position indicated by the specified index. LazyForEach will update the displayed content accordingly.8+ | number | Invoked when data in the position indicated by the specified index is changed.8+ | number | Invoked when data in the position indicated by the specified index is changed.(deprecated) | number | Invoked when data is added to the position indicated by the specified index.(deprecated) | from: number,(deprecated) | number | Invoked when data is deleted from the position indicated by the specified index. LazyForEach will update the displayed content accordingly.(deprecated) | number | Invoked when data in the position indicated by the specified index is changed.**, **\**, and **\** components support lazy loading (that is, only the visible part and a small amount of data before and after the visible part are loaded for caching). For other components, all data is loaded at the same time.
+- LazyForEach must be used in the container component. Only the [\](../reference/arkui-ts/ts-container-list.md), [\](../reference/arkui-ts/ts-container-grid.md), and [\](../reference/arkui-ts/ts-container-swiper.md) components support lazy loading (that is, only the visible part and a small amount of data before and after the visible part are loaded for caching). For other components, all data is loaded at the same time.
- **LazyForEach** must create one and only one child component in each iteration.
@@ -177,7 +177,7 @@ class BasicDataSource implements IDataSource {
}
class MyDataSource extends BasicDataSource {
- private dataArray: string[] = ['/path/image0', '/path/image1', '/path/image2', '/path/image3'];
+ private dataArray: string[] = [];
public totalCount(): number {
return this.dataArray.length;
@@ -201,6 +201,12 @@ class MyDataSource extends BasicDataSource {
@Entry
@Component
struct MyComponent {
+ aboutToAppear() {
+ for (var i = 100; i >= 80; i--) {
+ this.data.pushData(`Hello ${i}`)
+ }
+ }
+
private data: MyDataSource = new MyDataSource();
build() {
@@ -208,15 +214,17 @@ struct MyComponent {
LazyForEach(this.data, (item: string) => {
ListItem() {
Row() {
- Image(item).width('30%').height(50)
- Text(item).fontSize(20).margin({ left: 10 })
+ Text(item).fontSize(50)
+ .onAppear(() => {
+ console.info("appear:" + item)
+ })
}.margin({ left: 10, right: 10 })
}
.onClick(() => {
- this.data.pushData('/path/image' + this.data.totalCount());
+ this.data.pushData(`Hello ${this.data.totalCount()}`);
})
}, item => item)
- }
+ }.cachedCount(5)
}
}
```
diff --git a/en/application-dev/quick-start/arkts-state.md b/en/application-dev/quick-start/arkts-state.md
index be3260d6855bdb72a8e38fbaea31307117ec091b..ccbf348f847f61efc034d2a6347f7390d4b6f558 100644
--- a/en/application-dev/quick-start/arkts-state.md
+++ b/en/application-dev/quick-start/arkts-state.md
@@ -25,21 +25,21 @@ An @State decorated variable, like all other decorated variables in the declarat
## Rules of Use
-| \@State Decorator| Description |
-| ------------ | ---------------------------------------- |
-| Decorator parameters | None. |
-| Synchronization type | Does not synchronize with any type of variable in the parent component. |
-| Allowed variable types | Object, class, string, number, Boolean, enum, and array of these types. For details about the scenarios of nested types, see [Observed Changes](#observed-changes).** component.
+In this example, \@State is used to decorate the **count** variable of the simple type, turning it into a state variable. The change of **count** causes the update of the **\** component.
-- When the state variable **count** changes, the framework searches for components that depend on this state variable, which include only the **\** component in this example.
+- When **count** changes, the framework searches for components bound to it, which include only the **\** component in this example.
- The framework executes the update method of the **\** component to implement on-demand update.
diff --git a/en/application-dev/quick-start/figures/chooseStageModel.png b/en/application-dev/quick-start/figures/chooseStageModel.png
index b7dd96b6b7c5d2afd241e0c6fd9ee91977692115..dffb66f40999c09e20edfa1b094aee8e62952f61 100644
Binary files a/en/application-dev/quick-start/figures/chooseStageModel.png and b/en/application-dev/quick-start/figures/chooseStageModel.png differ
diff --git a/en/application-dev/quick-start/figures/deleteRuntimeOS.png b/en/application-dev/quick-start/figures/deleteRuntimeOS.png
index 8087b03be057d646ae6e3348abae73c1e840b781..c75770635cb1bb3ab927968afe97664ff8c2ebde 100644
Binary files a/en/application-dev/quick-start/figures/deleteRuntimeOS.png and b/en/application-dev/quick-start/figures/deleteRuntimeOS.png differ
diff --git a/en/application-dev/quick-start/figures/en-us_image_0000001364054489.png b/en/application-dev/quick-start/figures/en-us_image_0000001364054489.png
deleted file mode 100644
index bcc45efdddb87a39201661c5f6d3ccbce9bfd3e6..0000000000000000000000000000000000000000
Binary files a/en/application-dev/quick-start/figures/en-us_image_0000001364054489.png and /dev/null differ
diff --git a/en/application-dev/quick-start/figures/project.png b/en/application-dev/quick-start/figures/project.png
new file mode 100644
index 0000000000000000000000000000000000000000..e1f2db2da30489fa3c4b64587db203a2ef173533
Binary files /dev/null and b/en/application-dev/quick-start/figures/project.png differ
diff --git a/en/application-dev/quick-start/figures/secondPage.png b/en/application-dev/quick-start/figures/secondPage.png
index 2c08d85c610336a71b06407800603ed5c101606d..efca1a48d38136c2a09c3d36e6b4a8b54785cf70 100644
Binary files a/en/application-dev/quick-start/figures/secondPage.png and b/en/application-dev/quick-start/figures/secondPage.png differ
diff --git a/en/application-dev/quick-start/har-package.md b/en/application-dev/quick-start/har-package.md
index 4d54bb1a139eb2c42b3feab8fe3f5d20ce5d0b7d..1ba7b3402a34a40b7a01c7df261b9362852b55ff 100644
--- a/en/application-dev/quick-start/har-package.md
+++ b/en/application-dev/quick-start/har-package.md
@@ -2,7 +2,17 @@
A Harmony Archive (HAR) is a static shared package that can contain code, C++ libraries, resources, and configuration files. It enables modules and projects to share code related to ArkUI components, resources, and more. Unlike a Harmony Ability Package (HAP), a HAR cannot be independently installed on a device. Instead, it can be referenced only as the dependency of an application module.
## Creating a HAR Module
-You can [create a HAR module in DevEco Studio](https://developer.harmonyos.com/cn/docs/documentation/doc-guides-V3/creating_har_api9-0000001518082393-V3#section143510369612). To better protect your source code, enable obfuscation for the HAR module so that DevEco Studio compiles, obfuscates, and compresses code during HAR building. To enable obfuscation, open the **build-profile.json5** file of the HAR module and set **artifactType** to **obfuscation** as follows:
+You can [create a HAR module in DevEco Studio](https://developer.harmonyos.com/cn/docs/documentation/doc-guides-V3/creating_har_api9-0000001518082393-V3#section143510369612).
+
+To better protect your source code, enable obfuscation for the HAR module so that DevEco Studio compiles, obfuscates, and compresses code during HAR building.
+
+> **NOTE**
+>
+> Obfuscation is only available for ArkTS projects in the stage model.
+
+### Obfuscation in API Version 9
+
+In API version 9, obfuscation is disabled by default, and can be enabled by setting **artifactType** to **obfuscation** in the **build-profile.json5** file of the HAR module. The configuration is as follows:
```json
{
@@ -16,9 +26,43 @@ The value options of **artifactType** are as follows, with the default value bei
- **original**: Code is not obfuscated.
- **obfuscation**: Code is obfuscated using Uglify.
-> **NOTE**
->
-> Obfuscation is available only in the stage model. Therefore, if **artifactType** is set to **obfuscation**, **apiType** must be set to **stageMode**.
+### Obfuscation in API Version 10
+
+In API version 10, obfuscation is enabled by default, and can be set through the **enable** field under **ruleOptions** in the **build-profile.json5** file of the HAR module. The configuration is as follows:
+
+```json
+{
+ "apiType": "stageMode",
+ "buildOption": {
+ },
+ "buildOptionSet": [
+ {
+ "name": "release",
+ "arkOptions": {
+ "obfuscation": {
+ "ruleOptions": {
+ "enable": true,
+ "files": [
+ "./obfuscation-rules.txt"
+ ]
+ },
+ "consumerFiles": [
+ "./consumer-rules.txt"
+ ]
+ }
+ }
+ },
+ ],
+ "targets": [
+ {
+ "name": "default"
+ }
+ ]
+}
+```
+### Adaptation Guide
+
+The **artifactType** field is forward compatible, and the original function is not affected. Yet, it is deprecated since API version 10, and you are advised to use the substitute as soon as possible.
## Precautions for HAR Development
- The HAR does not support the declaration of **abilities** and **extensionAbilities** in its configuration file.
@@ -95,7 +139,7 @@ To start with, [configure dependency](https://developer.harmonyos.com/cn/docs/do
### Reference ArkUI Components in the HAR
-After configuring the dependency on the HAR, you can reference ArkUI components exported from the HAR by using **import**. The sample code is as follows:
+After configuring the dependency on the HAR, you can reference ArkUI components exported from the HAR by using **import**. The code snippet is as follows:
```js
// entry/src/main/ets/pages/index.ets
import { MainPage } from "library"
diff --git a/en/application-dev/quick-start/start-with-ets-stage.md b/en/application-dev/quick-start/start-with-ets-stage.md
index 789f4c05e28730d4f2851fc507af6bc4a8af1d9b..2205e71621f27e3c779dbe27d4f0bca4efc9cbaf 100644
--- a/en/application-dev/quick-start/start-with-ets-stage.md
+++ b/en/application-dev/quick-start/start-with-ets-stage.md
@@ -1,11 +1,11 @@
# Building the First ArkTS Application in Stage Model
-> **NOTE**
->
-> To use ArkTS, your DevEco Studio must be V3.0.0.900 Beta3 or later.
->
-> In this document, DevEco Studio 4.0 Beta1 is used. You can download it [here](../../release-notes/OpenHarmony-v4.0-beta1.md#version-mapping).
+> **NOTE**
+>
+> To use ArkTS, your DevEco Studio must be V3.0.0.900 Beta3 or later.
+>
+> In this document, DevEco Studio 4.0 Beta2 is used. You can download it [here](../../release-notes/OpenHarmony-v4.0-beta2.md#version-mapping).
## Creating an ArkTS Project
@@ -21,16 +21,18 @@ The following describes how to create the OpenHarmony projects of API 10 and API
-3. On the project configuration page, set **Compile SDK** to **3.1.0(API 9** and retain the default values for other parameters.
+3. On the project configuration page, set **Compile SDK** to **3.1.0(API 9)** and retain the default values for other parameters.
+
+ The **Node** parameter sets the Node.js version to use for the project. You can use an existing version or download a new one.
> **NOTE**
>
> You can use the low-code development mode apart from the traditional coding approach.
- >
+ >
> On the low-code development pages, you can design your application UI in an efficient, intuitive manner, with a wide array of UI editing features.
- >
+ >
> To use the low-code development mode, turn on **Enable Super Visual** on the page shown above.
4. Click **Finish**. DevEco Studio will automatically generate the sample code and resources that match your project type. Wait until the project is created.
@@ -43,12 +45,13 @@ The following describes how to create the OpenHarmony projects of API 10 and API
-7. Delete the **runtimeOS** configuration from the **targets** field in all module-level **build-profile.json5** files.
+7. Delete the **runtimeOS** configuration from the **targets** field in the module-level **build-profile.json5** files.
8. Click **Sync Now** and wait until the synchronization is complete. A project of API version 10 is now created.
+
### Creating a Project of API Version 9
1. If you are opening DevEco Studio for the first time, click **Create Project**. If a project is already open, choose **File** > **New** > **Create Project** from the menu bar.
@@ -57,16 +60,18 @@ The following describes how to create the OpenHarmony projects of API 10 and API
-3. On the project configuration page, set **Compile SDK** to **3.1.0(API 9** and retain the default values for other parameters.
+3. On the project configuration page, set **Compile SDK** to **3.1.0(API 9)** and retain the default values for other parameters.
+
+ The **Node** parameter sets the Node.js version to use for the project. You can use an existing version or download a new one.
> **NOTE**
>
> You can use the low-code development mode apart from the traditional coding approach.
- >
+ >
> On the low-code development pages, you can design your application UI in an efficient, intuitive manner, with a wide array of UI editing features.
- >
+ >
> To use the low-code development mode, turn on **Enable Super Visual** on the page shown above.
4. Click **Finish**. DevEco Studio will automatically generate the sample code and resources that match your project type. Wait until the project is created.
@@ -78,11 +83,11 @@ The following describes how to create the OpenHarmony projects of API 10 and API
## ArkTS Project Directory Structure (Stage Model, API Version 10)
-
+
- **AppScope > app.json5**: application-level configuration information.
-- **entry**: OpenHarmony project module, which can be built into an OpenHarmony Ability Package ([HAP](../../glossary.md#hap)).
+- **entry**: OpenHarmony project module, which can be built into an ability package (HAP).
- **src > main > ets**: a collection of ArkTS source code.
- **src > main > ets > entryability**: entry to your application/service.
@@ -99,17 +104,18 @@ The following describes how to create the OpenHarmony projects of API 10 and API
- **oh_modules**: third-party library dependency information. For details about how to adapt a historical npm project to ohpm, see [Manually Migrating Historical Projects](https://developer.harmonyos.com/cn/docs/documentation/doc-guides-V3/project_overview-0000001053822398-V3#section108143331212).
-- **build-profile.json5**: application-level configuration options, including **signingConfigs** and **products**. The **runtimeOS** field in **products** indicates the runtime OS. Its default value is **HarmonyOS**. If you are developing an OpenHarmony application, change the value to **OpenHarmony**.
+- **build-profile.json5**: application-level configuration information, including the **signingConfigs** and **products** configuration. The **runtimeOS** field in **products** indicates the runtime OS. Its default value is **HarmonyOS**. If you are developing an OpenHarmony application, change the value to **OpenHarmony**.
- **hvigorfile.ts**: application-level build script.
+
## ArkTS Project Directory Structure (Stage Model, API Version 9)
-
+
- **AppScope > app.json5**: application-level configuration information.
-- **entry**: OpenHarmony project module, which can be built into an OpenHarmony Ability Package ([HAP](../../glossary.md#hap)).
+- **entry**: OpenHarmony project module, which can be built into an ability package (HAP).
- **src > main > ets**: a collection of ArkTS source code.
- **src > main > ets > entryability**: entry to your application/service.
@@ -267,7 +273,7 @@ You can implement page redirection through the [page router](../reference/apis/j
1. Implement redirection from the first page to the second page.
- In the **index.ets** file of the first page, bind the **onClick** event to the **Next** button so that clicking the button redirects the user to the second page. The sample code in the **Index.ets** file is shown below:
+ In the **Index.ets** file of the first page, bind the **onClick** event to the **Next** button so that clicking the button redirects the user to the second page. The sample code in the **Index.ets** file is shown below:
```ts
// Index.ets
diff --git a/en/application-dev/reference/apis/Readme-EN.md b/en/application-dev/reference/apis/Readme-EN.md
index 4fc3fb5005d7ac0208b083be1a084bd5c66b4865..e1f64b915980aa23b9c1154f435a500a34922938 100644
--- a/en/application-dev/reference/apis/Readme-EN.md
+++ b/en/application-dev/reference/apis/Readme-EN.md
@@ -16,6 +16,8 @@
- [@ohos.app.ability.ServiceExtensionAbility (ServiceExtensionAbility)](js-apis-app-ability-serviceExtensionAbility.md)
- [@ohos.app.ability.StartOptions (StartOptions)](js-apis-app-ability-startOptions.md)
- [@ohos.app.ability.UIAbility (UIAbility)](js-apis-app-ability-uiAbility.md)
+ - [@ohos.app.ability.UIExtensionAbility (Base Class for ExtensionAbilities with UI)](js-apis-app-ability-uiExtensionAbility.md)
+ - [@ohos.app.ability.UIExtensionContentSession (UI Operation Class for ExtensionAbilities with UI)](js-apis-app-ability-uiExtensionContentSession.md)
- [@ohos.app.form.FormExtensionAbility (FormExtensionAbility)](js-apis-app-form-formExtensionAbility.md)
- [@ohos.application.DataShareExtensionAbility (DataShareExtensionAbility)](js-apis-application-dataShareExtensionAbility.md)
- [@ohos.application.StaticSubscriberExtensionAbility (StaticSubscriberExtensionAbility)](js-apis-application-staticSubscriberExtensionAbility.md)
@@ -42,6 +44,7 @@
- [@ohos.app.form.formBindingData (formBindingData)](js-apis-app-form-formBindingData.md)
- [@ohos.app.form.formHost (FormHost)](js-apis-app-form-formHost.md)
- [@ohos.app.form.formInfo (FormInfo)](js-apis-app-form-formInfo.md)
+ - [@ohos.app.form.formObserver (formObserver)](js-apis-app-form-formObserver.md)
- [@ohos.app.form.formProvider (FormProvider)](js-apis-app-form-formProvider.md)
- [@ohos.application.uriPermissionManager (URI Permission Management)](js-apis-uripermissionmanager.md)
- Both Models (To Be Deprecated Soon)
@@ -106,6 +109,7 @@
- [ProcessInformation](js-apis-inner-application-processInformation.md)
- [ServiceExtensionContext](js-apis-inner-application-serviceExtensionContext.md)
- [UIAbilityContext](js-apis-inner-application-uiAbilityContext.md)
+ - [UIExtensionContext](js-apis-inner-application-uiExtensionContext.md)
- [shellCmdResult](js-apis-inner-application-shellCmdResult.md)
- [WindowExtensionContext](js-apis-inner-application-windowExtensionContext.md)
- wantAgent
@@ -198,6 +202,7 @@
- UI Page
- [@ohos.animator (Animator)](js-apis-animator.md)
- [@ohos.arkui.componentSnapshot (Component Snapshot)](js-apis-arkui-componentSnapshot.md)
+ - [@ohos.arkui.componentUtils (componentUtils)](js-apis-arkui-componentUtils.md)
- [@ohos.arkui.dragController (DragController)](js-apis-arkui-dragController.md)
- [@ohos.arkui.drawableDescriptor (DrawableDescriptor)](js-apis-arkui-drawableDescriptor.md)
- [@ohos.arkui.inspector (Layout Callback)](js-apis-arkui-inspector.md)
@@ -205,12 +210,13 @@
- [@ohos.curves (Interpolation Calculation)](js-apis-curve.md)
- [@ohos.font (Custom Font Registration)](js-apis-font.md)
- [@ohos.matrix4 (Matrix Transformation)](js-apis-matrix4.md)
+ - [@ohos.measure (Text Measurement)](js-apis-measure.md)
- [@ohos.mediaquery (Media Query)](js-apis-mediaquery.md)
- [@ohos.pluginComponent (PluginComponentManager)](js-apis-plugincomponent.md)
- [@ohos.promptAction (Prompt)](js-apis-promptAction.md)
- [@ohos.router (Page Routing)](js-apis-router.md)
- - [@ohos.measure (Text Measurement)](js-apis-measure.md)
- [@ohos.uiAppearance (UI Appearance)](js-apis-uiappearance.md)
+
- Graphics
- [@ohos.animation.windowAnimationManager (Window Animation Management)](js-apis-windowAnimationManager.md)
- [@ohos.application.WindowExtensionAbility (WindowExtensionAbility)](js-apis-application-windowExtensionAbility.md)
@@ -225,12 +231,15 @@
- [WebGL2](js-apis-webgl2.md)
- Multimedia
+ - [@ohos.app.ability.MediaControlExtensionAbility (ExtensionAbility for Media Playback Control)](js-apis-app-ability-MediaControlExtensionAbility.md)
- [@ohos.multimedia.audio (Audio Management)](js-apis-audio.md)
- [@ohos.multimedia.avsession (AVSession Management)](js-apis-avsession.md)
- [@ohos.multimedia.camera (Camera Management)](js-apis-camera.md)
- [@ohos.multimedia.image (Image Processing)](js-apis-image.md)
- [@ohos.multimedia.media (Media)](js-apis-media.md)
- [@ohos.multimedia.systemSoundManager (System Sound Management)](js-apis-systemSoundManager.md)
+ - application
+ - [MediaControlExtensionContext (ExtensionAbility Context for Media Playback Control)](js-apis-inner-application-MediaControlExtensionContext.md)
- multimedia
- [ringtonePlayer (Ringtone Player)](js-apis-inner-multimedia-ringtonePlayer.md)
@@ -313,20 +322,21 @@
- [@ohos.net.sharing (Network Sharing)](js-apis-net-sharing.md)
- [@ohos.net.socket (Socket Connection)](js-apis-socket.md)
- [@ohos.net.statistics (Traffic Management)](js-apis-net-statistics.md)
+ - [@ohos.net.vpn (VPN Management)](js-apis-net-vpn.md)
- [@ohos.net.webSocket (WebSocket Connection)](js-apis-webSocket.md)
- [@ohos.request (Upload and Download)](js-apis-request.md)
- Connectivity
- - [@ohos.bluetooth.a2dp (Bluetooth a2dp Module)(Recommended)](js-apis-bluetooth-a2dp.md)
- - [@ohos.bluetooth.access (Bluetooth access Module)(Recommended)](js-apis-bluetooth-access.md)
- - [@ohos.bluetooth.baseProfile (Bluetooth baseProfile Module)(Recommended)](js-apis-bluetooth-baseProfile.md)
- - [@ohos.bluetooth.ble (Bluetooth ble Module)(Recommended)](js-apis-bluetooth-ble.md)
- - [@ohos.bluetooth.connection (Bluetooth connection Module)(Recommended)](js-apis-bluetooth-connection.md)
- - [@ohos.bluetooth.constant (Bluetooth constant Module)(Recommended)](js-apis-bluetooth-constant.md)
- - [@ohos.bluetooth.hfp (Bluetooth hfp Module)(Recommended)](js-apis-bluetooth-hfp.md)
- - [@ohos.bluetooth.hid (Bluetooth hid Module)(Recommended)(js-apis-bluetooth-hid.md)
- - [@ohos.bluetooth.pan (Bluetooth pan Module)(Recommended)](js-apis-bluetooth-pan.md)
- - [@ohos.bluetooth.socket (Bluetooth socket Module)(Recommended)](js-apis-bluetooth-socket.md)
+ - [@ohos.bluetooth.a2dp (Bluetooth A2DP Module) (Recommended)](js-apis-bluetooth-a2dp.md)
+ - [@ohos.bluetooth.access (Bluetooth Access Module) (Recommended)](js-apis-bluetooth-access.md)
+ - [@ohos.bluetooth.baseProfile (Bluetooth baseProfile Module) (Recommended)](js-apis-bluetooth-baseProfile.md)
+ - [@ohos.bluetooth.ble (Bluetooth BLE Module) (Recommended)](js-apis-bluetooth-ble.md)
+ - [@ohos.bluetooth.connection (Bluetooth connection Module) (Recommended)](js-apis-bluetooth-connection.md)
+ - [@ohos.bluetooth.constant (Bluetooth constant Module) (Recommended)](js-apis-bluetooth-constant.md)
+ - [@ohos.bluetooth.hfp (Bluetooth hfp Module) (Recommended)](js-apis-bluetooth-hfp.md)
+ - [@ohos.bluetooth.hid (Bluetooth hid Module) (Recommended)](js-apis-bluetooth-hid.md)
+ - [@ohos.bluetooth.pan (Bluetooth pan Module) (Recommended)](js-apis-bluetooth-pan.md)
+ - [@ohos.bluetooth.socket (Bluetooth socket Module) (Recommended)](js-apis-bluetooth-socket.md)
- [@ohos.bluetooth (Bluetooth) (To Be Deprecated Soon)](js-apis-bluetooth.md)
- [@ohos.bluetoothManager (Bluetooth) (To Be Deprecated Soon)](js-apis-bluetoothManager.md)
- [@ohos.connectedTag (Active Tags)](js-apis-connectedTag.md)
@@ -385,6 +395,7 @@
- [@ohos.charger (Charging Type)](js-apis-charger.md)
- [@ohos.cooperate (Screen Hopping)](js-apis-devicestatus-cooperate.md)
- [@ohos.deviceAttest (Device Attestation)](js-apis-deviceAttest.md)
+ - [@ohos.deviceStatus.dragInteraction (Drag)](js-apis-devicestatus-draginteraction.md)
- [@ohos.deviceInfo (Device Information)](js-apis-device-info.md)
- [@ohos.distributedDeviceManager (Device Management)](js-apis-distributedDeviceManager.md)
- [@ohos.distributedHardware.deviceManager (Device Management)](js-apis-device-manager.md)
@@ -405,6 +416,7 @@
- [@ohos.multimodalInput.touchEvent (Touch Event)](js-apis-touchevent.md)
- [@ohos.multimodalInput.shortKey (Shortcut Key)](js-apis-shortKey.md)
- [@ohos.power (System Power Management)](js-apis-power.md)
+ - [@ohos.resourceschedule.deviceStandby (Device Standby)](js-apis-resourceschedule-deviceStandby.md)
- [@ohos.runningLock (Runninglock)](js-apis-runninglock.md)
- [@ohos.sensor (Sensor)](js-apis-sensor.md)
- [@ohos.settings (Data Item Settings)](js-apis-settings.md)
@@ -420,10 +432,9 @@
- Account Management
- [@ohos.account.appAccount (App Account Management)](js-apis-appAccount.md)
- - [@ohos.account.appAccount.AuthorizationExtensionAbility (App AuthorizationExtensionAbility)](js-apis-appAccount-authorizationExtensionAbility.md)
- [@ohos.account.distributedAccount (Distributed Account Management)](js-apis-distributed-account.md)
- [@ohos.account.osAccount (OS Account Management)](js-apis-osAccount.md)
-
+
- Customization
- [@ohos.configPolicy (Configuration Policy)](js-apis-configPolicy.md)
diff --git a/en/application-dev/reference/apis/js-apis-WorkSchedulerExtensionAbility.md b/en/application-dev/reference/apis/js-apis-WorkSchedulerExtensionAbility.md
index b717abf0ad082e4ea7586cc8713596a08e7b3740..de2f146c7226f3a1ef3d61dad588c84b6cc2a1ab 100644
--- a/en/application-dev/reference/apis/js-apis-WorkSchedulerExtensionAbility.md
+++ b/en/application-dev/reference/apis/js-apis-WorkSchedulerExtensionAbility.md
@@ -1,15 +1,13 @@
# @ohos.WorkSchedulerExtensionAbility (Deferred Task Scheduling Callbacks)
-The **WorkSchedulerExtensionAbility** module provides callbacks for deferred task scheduling.
-
-When developing an application, you can override the APIs of this module and add your own task logic to the APIs.
+The **WorkSchedulerExtensionAbility** module provides callbacks for deferred task scheduling. You can override the APIs provided by this module. When a deferred task is triggered, the system calls back the application through the APIs and processes the task logic in the callback.
> **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.
+>
> - The APIs of this module can be used only in the stage model.
-
## Modules to Import
```ts
@@ -36,7 +34,7 @@ Called when the system starts scheduling the deferred task.
| Name | Type | Mandatory | Description |
| ---- | ---------------------------------------- | ---- | -------------- |
-| work | [workScheduler.WorkInfo](js-apis-resourceschedule-workScheduler.md#workinfo) | Yes | Target task.|
+| work | [workScheduler.WorkInfo](js-apis-resourceschedule-workScheduler.md#workinfo) | Yes | Deferred task that starts.|
**Example**
@@ -60,7 +58,7 @@ Called when the system stops scheduling the deferred task.
| Name | Type | Mandatory | Description |
| ---- | ---------------------------------------- | ---- | -------------- |
-| work | [workScheduler.WorkInfo](js-apis-resourceschedule-workScheduler.md#workinfo) | Yes | Target task.|
+| work | [workScheduler.WorkInfo](js-apis-resourceschedule-workScheduler.md#workinfo) | Yes | Deferred task that stops.|
**Example**
diff --git a/en/application-dev/reference/apis/js-apis-animator.md b/en/application-dev/reference/apis/js-apis-animator.md
index 1818bfc13dd6859894cf122f96b2171d0ce70e47..829355f9eecdfd2ccc9a889a478a9c8c575ee52a 100644
--- a/en/application-dev/reference/apis/js-apis-animator.md
+++ b/en/application-dev/reference/apis/js-apis-animator.md
@@ -257,7 +257,7 @@ Defines animator options.
| Name | Type | Mandatory| Description |
| ---------- | ----------------------------------------------------------- | ---- | ------------------------------------------------------------ |
| duration | number | Yes | Duration for playing the animation, in milliseconds. |
-| easing | string | Yes | Animation interpolation curve. Only the following values are supported:10+
-
-getRunningFormInfos(callback: AsyncCallback<Array<formInfo.RunningFormInfo>>, hostBundleName?: string): void
-
-Obtains information about all non-temporary widgets running on the device. This API uses an asynchronous callback to return the result.
-
-**Required permissions**: ohos.permission.REQUIRE_FORM
-
-**System capability**: SystemCapability.Ability.Form
-
-**Parameters**
-
-| Name| Type | Mandatory| Description |
-| ------ | ------ | ---- | ------- |
-| callback | AsyncCallback<Array<formInfo.RunningFormInfo>> | Yes| Callback used to return the result. If the widget information is obtained, **error** is undefined and **data** is the information obtained.|
-| hostBundleName | string | No| Name of the bundle that functions as the widget host. If this parameter is specified, only the information about the non-temporary widgets that are running under the widget host is returned.10+
-
-getRunningFormInfos(hostBundleName?: string): Promise<Array<formInfo.RunningFormInfo>>
-
-Obtains information about all non-temporary widgets running on the device. This API uses a promise to return the result.
-
-**Required permissions**: ohos.permission.REQUIRE_FORM
-
-**System capability**: SystemCapability.Ability.Form
-
-**Parameters**
-
-| Name| Type | Mandatory| Description |
-| ------ | ------ | ---- | ------- |
-| hostBundleName | string | No| Name of the bundle that functions as the widget host. If this parameter is specified, only the information about the non-temporary widgets that are running under the widget host is returned.10+
-
- on(type: 'formAdd', observerCallback: Callback<formInfo.RunningFormInfo>, bundleName?: string): void
-
-Subscribes to widget addition events. This API uses an asynchronous callback to return the result.
-
-**Required permissions**: ohos.permission.REQUIRE_FORM
-
-**System capability**: SystemCapability.Ability.Form
-
-**Parameters**
-
-| Name| Type | Mandatory| Description |
-| ------ | ------ | ---- | ------- |
-| type | string | Yes | Event type. The value **'formAdd'** indicates a widget addition event.|
-| callback | Callback<formInfo.RunningFormInfo> | Yes| Callback used to return **RunningFormInfo** of the new widget.|
-| bundleName | string | No| Name of the bundle that functions as the widget host. By default, widget addition events of all widget hosts are subscribed to.|
-
-**Example**
-
-```ts
-import formHost from '@ohos.app.form.formHost';
-let bundleName = 'ohos.samples.FormApplication';
-let callback = function(data) {
- console.log('a new form added, data: ${JSON.stringify(data)');
-}
-
-formHost.on('formAdd', callback);
-formHost.on('formAdd', callback, bundleName);
-```
-
-## off('formAdd')10+
-
- off(type: "formAdd", observerCallback?: Callback<formInfo.RunningFormInfo>, bundleName?: string): void
-
-Unsubscribes from widget addition events. This API uses an asynchronous callback to return the result.
-
-**Required permissions**: ohos.permission.REQUIRE_FORM
-
-**System capability**: SystemCapability.Ability.Form
-
-**Parameters**
-
-| Name| Type | Mandatory| Description |
-| ------ | ------ | ---- | ------- |
-| type | string | Yes | Event type. The value **'formAdd'** indicates a widget addition event.|
-| callback | Callback<formInfo.RunningFormInfo> | No| Callback used to return **RunningFormInfo**. By default, all the subscriptions to the specified event are canceled.10+
-
- on(type: 'formRemove', observerCallback: Callback<formInfo.RunningFormInfo>, bundleName?: string): void
-
-Subscribes to widget removal events. This API uses an asynchronous callback to return the result.
-
-**Required permissions**: ohos.permission.REQUIRE_FORM
-
-**System capability**: SystemCapability.Ability.Form
-
-**Parameters**
-
-| Name| Type | Mandatory| Description |
-| ------ | ------ | ---- | ------- |
-| type | string | Yes | Event type. The value **'formRemove'** indicates a widget removal event.|
-| callback | Callback<formInfo.RunningFormInfo> | Yes| Callback used to return **RunningFormInfo** of the removed widget.|
-| bundleName | string | No| Name of the bundle that functions as the widget host. By default, widget removal events of all widget hosts are subscribed to.|
-
-**Example**
-
-```ts
-import formHost from '@ohos.app.form.formHost';
-let bundleName = 'ohos.samples.FormApplication';
-let callback = function(data) {
- console.log('a new form added, data: ${JSON.stringify(data)');
-}
-
-formHost.on('formRemove', callback);
-formHost.on('formRemove', callback, bundleName);
-```
-
-## off('formRemove')10+
-
-off(type: "formRemove", observerCallback?: Callback<formInfo.RunningFormInfo>, bundleName?: string): void
-
-Unsubscribes from widget removal events. This API uses an asynchronous callback to return the result.
-
-**Required permissions**: ohos.permission.REQUIRE_FORM
-
-**System capability**: SystemCapability.Ability.Form
-
-**Parameters**
-
-| Name| Type | Mandatory| Description |
-| ------ | ------ | ---- | ------- |
-| type | string | Yes | Event type. The value **'formRemove'** indicates a widget removal event.|
-| callback | Callback<formInfo.RunningFormInfo> | No| Callback used to return **RunningFormInfo**. By default, all the subscriptions to the specified event are canceled.10+
-
-getRunningFormInfosByFilter(formProviderFilter: formInfo.FormProviderFilter): Promise<Array<formInfo.RunningFormInfo>>
-
-Obtains the information about widget hosts based on the widget provider information. This API uses a promise to return the result.
-
-**Required permissions**: ohos.permission.REQUIRE_FORM
-
-**System capability**: SystemCapability.Ability.Form
-
-**Parameters**
-
-| Name | Type | Mandatory| Description |
-| ----------- | --------------- | ---- | -------------------------------- |
-| formProviderFilter | [formInfo.FormProviderFilter](js-apis-app-form-formInfo.md#formProviderFilter) | Yes | Information about the widget provider.|
-
-**Return value**
-
-| Type | Description |
-| ------------------- | ------------------------- |
-| Promise<Array<[formInfo.RunningFormInfo](js-apis-app-form-formInfo.md#RunningFormInfo)>> | Promise used to return the widget host information obtained.|
-
-**Error codes**
-
-For details about the error codes, see [Form Error Codes](../errorcodes/errorcode-form.md).
-
-| Error Code ID| Error Message|
-| -------- | -------- |
-| 201 | Permissions denied. |
-| 202 | The application is not a system application. |
-| 401 | If the input parameter is not valid parameter. |
-| 16500050 | An IPC connection error happened. |
-| 16500100 | Failed to obtain the configuration information. |
-| 16501000 | An internal functional error occurred. |
-
-
-```ts
-import formHost from '@ohos.app.form.formHost';
-
-let formInstanceFilter = {
- bundleName: "com.example.formprovide",
- abilityName: "EntryFormAbility",
- formName: "widget",
- moduleName: "entry"
-}
-try {
- formHost.getRunningFormInfosByFilter(formInstanceFilter).then(data1 => {
- console.info('formHost getRunningFormInfosByFilter return err :');
- }).catch((error) => {
- console.error(`error, code: ${error.code}, message: ${error.message}`);
- });
-} catch(error) {
- console.error(`catch error, code: ${error.code}, message: ${error.message}`);
-}
-```
-
-## getRunningFormInfosByFilter10+
-
-getRunningFormInfosByFilter(formProviderFilter: formInfo.FormProviderFilter, callback: AsyncCallback<Array<formInfo.RunningFormInfo>>): void
-
-Obtains the information about widget hosts based on the widget provider information. This API uses an asynchronous callback to return the result.
-
-**Required permissions**: ohos.permission.REQUIRE_FORM
-
-**System capability**: SystemCapability.Ability.Form
-
-**Parameters**
-
-| Name | Type | Mandatory| Description |
-| ----------- | --------------- | ---- | -------------------------------- |
-| formProviderFilter | [formInfo.FormProviderFilter](js-apis-app-form-formInfo.md#formProviderFilter) | Yes | Information about the widget provider.|
-| callback | AsyncCallback<Array<[formInfo.RunningFormInfo](js-apis-app-form-formInfo.md)>> | Yes| Callback used to return the result. If the widget host information is obtained, **error** is **undefined** and **data** is the information obtained; otherwise, **error** is an error object.|
-
-**Error codes**
-
-For details about the error codes, see [Form Error Codes](../errorcodes/errorcode-form.md).
-
-| Error Code ID| Error Message|
-| -------- | -------- |
-| 201 | Permissions denied. |
-| 202 | The application is not a system application. |
-| 401 | If the input parameter is not valid parameter. |
-| 16500050 | An IPC connection error happened. |
-| 16500100 | Failed to obtain the configuration information. |
-| 16501000 | An internal functional error occurred. |
-
-
-```ts
-import formHost from '@ohos.app.form.formHost';
-
-let formInstanceFilter = {
- bundleName: "com.example.formprovide",
- abilityName: "EntryFormAbility",
- formName: "widget",
- moduleName: "entry"
-}
-try {
- formHost.getRunningFormInfosByFilter(formInstanceFilter,(error, data) => {
- if (error) {
- console.error(`error, code: ${error.code}, message: ${error.message}`);
- } else {
- console.log('formHost getRunningFormInfosByFilter, data: ${JSON.stringify(data)}');
- }
- });
-} catch(error) {
- console.error(`catch error, code: ${error.code}, message: ${error.message}`);
-}
-```
-
-## getRunningFormInfoById10+
-
-getRunningFormInfoById(formId: string): Promise<formInfo.RunningFormInfo>
-
-
-Obtains the information about widget hosts based on the widget ID. This API uses a promise to return the result.
-
-**Required permissions**: ohos.permission.REQUIRE_FORM
-
-**System capability**: SystemCapability.Ability.Form
-
-**Parameters**
-
-| Name | Type | Mandatory| Description |
-| ----------- | --------------- | ---- | -------------------------------- |
-| formId | string | Yes | Widget ID.|
-
-**Return value**
-
-| Type | Description |
-| ------------------- | ------------------------- |
-| Promise<[formInfo.RunningFormInfo](js-apis-app-form-formInfo.md)> | Promise used to return the widget host information obtained.|
-
-**Error codes**
-
-For details about the error codes, see [Form Error Codes](../errorcodes/errorcode-form.md).
-
-| Error Code ID| Error Message|
-| -------- | -------- |
-| 201 | Permissions denied. |
-| 202 | The application is not a system application. |
-| 401 | If the input parameter is not valid parameter. |
-| 16500050 | An IPC connection error happened. |
-| 16500100 | Failed to obtain the configuration information. |
-| 16501000 | An internal functional error occurred. |
-
-
-```ts
-import formHost from '@ohos.app.form.formHost';
-let formId = '12400633174999288';
-try {
- formHost.getRunningFormInfoById(formId).then(data1 => {
- console.info('formHost getRunningFormInfoById return err :');
- }).catch((error) => {
- console.error(`error, code: ${error.code}, message: ${error.message}`);
- });
-} catch(error) {
- console.error(`catch error, code: ${error.code}, message: ${error.message}`);
-}
-```
-
-## getRunningFormInfoById10+
-
-getRunningFormInfoById(formId: string, callback: AsyncCallback<formInfo.RunningFormInfo>): void
-
-Obtains the information about widget hosts based on the widget ID. This API uses an asynchronous callback to return the result.
-
-**Required permissions**: ohos.permission.REQUIRE_FORM
-
-**System capability**: SystemCapability.Ability.Form
-
-**Parameters**
-
-| Name | Type | Mandatory| Description |
-| ----------- | --------------- | ---- | -------------------------------- |
-| formId | string | Yes | Widget ID.|
-| callback | AsyncCallback<[formInfo.RunningFormInfo](js-apis-app-form-formInfo.md)> | Yes| Callback used to return the result. If the widget host information is obtained, **error** is **undefined** and **data** is the information obtained; otherwise, **error** is an error object.|
-
-**Error codes**
-
-For details about the error codes, see [Form Error Codes](../errorcodes/errorcode-form.md).
-
-| Error Code ID| Error Message|
-| -------- | -------- |
-| 201 | Permissions denied. |
-| 202 | The application is not a system application. |
-| 401 | If the input parameter is not valid parameter. |
-| 16500050 | An IPC connection error happened. |
-| 16500100 | Failed to obtain the configuration information. |
-| 16501000 | An internal functional error occurred. |
-
-```ts
-import formHost from '@ohos.app.form.formHost';
-
-let formId = '12400633174999288';
-try {
- formHost.getRunningFormInfoById(formId,(error, data) => {
- if (error) {
- console.error(`error, code: ${error.code}, message: ${error.message}`);
- } else {
- console.log('formHost getRunningFormInfoById, data: ${JSON.stringify(data)}');
- }
- });
-} catch(error) {
- console.error(`catch error, code: ${error.code}, message: ${error.message}`);
-}
-```
-
-## on('notifyVisible')10+
-
- on(type: 'notifyVisible', observerCallback: Callback<Array<[formInfo.RunningFormInfo](js-apis-app-form-formInfo.md)>>, bundleName?: string): void
-
-Subscribes to events indicating that a widget becomes visible.
-
-This event is triggered when **notifyVisibleForms** is called to make a widget visible.
-
-**Required permissions**: ohos.permission.REQUIRE_FORM
-
-**System capability**: SystemCapability.Ability.Form
-
-**Parameters**
-
-| Name | Type | Mandatory| Description |
-| ---------- | ------------------------------------------------------------ | ---- | ------------------------------------------------------------ |
-| type | string | Yes | Event type. This value **'notifyVisible'** indicates a widget visibility event. |
-| callback | Callback <Array<[formInfo.RunningFormInfo](js-apis-app-form-formInfo.md)>> | Yes | Callback used to return **RunningFormInfo** of the widget. |
-| bundleName | string | No | Name of the bundle that functions as the widget host, on which the widget visibility state changes are subscribed.|
-
-**Example**
-
-```ts
-import formHost from '@ohos.app.form.formHost';
-let bundleName = 'ohos.samples.FormApplication';
-let callback = function(data) {
- console.log('form change visibility, data: ${JSON.stringify(data)');
-}
-
-formHost.on('notifyVisible', callback);
-formHost.on('notifyVisible', callback, bundleName);
-```
-
-## off('notifyVisible')10+
-
- off(type: "notifyVisible", observerCallback?: Callback<Array<[formInfo.RunningFormInfo](js-apis-app-form-formInfo.md)>>, bundleName?: string): void
-
-Unsubscribes from events indicating that a widget becomes visible.
-
-**Required permissions**: ohos.permission.REQUIRE_FORM
-
-**System capability**: SystemCapability.Ability.Form
-
-**Parameters**
-
-| Name | Type | Mandatory| Description |
-| ---------- | ------------------------------------------------------------ | ---- | ------------------------------------------------------------ |
-| type | string | Yes | Event type. This value **'notifyVisible'** indicates a widget visibility event.|
-| callback | Callback <Array<[formInfo.RunningFormInfo](js-apis-app-form-formInfo.md)>> | No | Callback registered during the subscription. By default, all the subscriptions to the specified event are canceled.10+
-
- on(type: 'notifyInvisible', observerCallback: Callback<Array<[formInfo.RunningFormInfo](js-apis-app-form-formInfo.md)>>, bundleName?: string): void
-
-Subscribes to events indicating that a widget becomes invisible.
-
-This event is triggered when **notifyInvisibleForms** is called to make a widget invisible.
-
-**Required permissions**: ohos.permission.REQUIRE_FORM
-
-**System capability**: SystemCapability.Ability.Form
-
-**Parameters**
-
-| Name | Type | Mandatory| Description |
-| ---------- | ------------------------------------------------------------ | ---- | ------------------------------------------------------------ |
-| type | string | Yes | Event type. This value **'notifyInvisible'** indicates a widget invisibility event. |
-| callback | Callback <Array<[formInfo.RunningFormInfo](js-apis-app-form-formInfo.md)>> | Yes | Callback used to return **RunningFormInfo** of the widget. |
-| bundleName | string | No | Name of the bundle that functions as the widget host, on which the widget visibility state changes are subscribed.|
-
-**Example**
-
-```ts
-import formHost from '@ohos.app.form.formHost';
-let bundleName = 'ohos.samples.FormApplication';
-let callback = function(data) {
- console.log('form change invisibility, data: ${JSON.stringify(data)');
-}
-
-formHost.on('notifyInvisible', callback);
-formHost.on('notifyInvisible', callback, bundleName);
-```
-
-## off('notifyInvisible')10+
-
- off(type: "notifyInvisible", observerCallback?: Callback<Array<[formInfo.RunningFormInfo](js-apis-app-form-formInfo.md)>>, bundleName?: string): void
-
-Unsubscribes from events indicating that a widget becomes invisible.
-
-**Required permissions**: ohos.permission.REQUIRE_FORM
-
-**System capability**: SystemCapability.Ability.Form
-
-**Parameters**
-
-| Name | Type | Mandatory| Description |
-| ---------- | ------------------------------------------------------------ | ---- | ------------------------------------------------------------ |
-| type | string | Yes | Event type. This value **'notifyInvisible'** indicates a widget invisibility event. |
-| callback | Callback <Array<[formInfo.RunningFormInfo](js-apis-app-form-formInfo.md)>> | No | Callback registered during the subscription. By default, all the subscriptions to the specified event are canceled.10+ | 15 | PrintExtensionAbility: provides APIs for printing images. Printing documents is not supported yet.|
| PUSH10+ | 17 | PushExtensionAbility: provides APIs for pushing scenario-specific messages. This ability is reserved.|
| DRIVER10+ | 18 | DriverExtensionAbility: provides APIs for the peripheral driver. This type of ability is not supported yet.|
-| APP_ACCOUNT_AUTHORIZATION10+ | 19 | [AuthorizationExtensionAbility](js-apis-appAccount-authorizationExtensionAbility.md): provides APIs to process authorization requests for application accounts and allow account authorization from a third-party (relative to the operating system vendor) ecosystem platform.|
| UNSPECIFIED | 255 | No type is specified. It is used together with **queryExtensionAbilityInfo** to query all types of Extension abilities.|
diff --git a/en/application-dev/reference/apis/js-apis-camera.md b/en/application-dev/reference/apis/js-apis-camera.md
index cc36a78a7fa2c6f1e729b664bebf5269528c0bc6..8877fff44a94b34057a4daebb158fa8fd80dbe80 100644
--- a/en/application-dev/reference/apis/js-apis-camera.md
+++ b/en/application-dev/reference/apis/js-apis-camera.md
@@ -32,7 +32,7 @@ Obtains a **CameraManager** instance. This API returns the result synchronously.
**Error codes**
-For details about the error codes, see [CameraErrorCode](#cameraerrorcode).
+For details about the error codes, see [Camera Error Codes](../errorcodes/errorcode-camera.md).
| ID | Error Message |
| --------------- | --------------- |
@@ -267,7 +267,7 @@ Creates a **CameraInput** instance with the specified **CameraDevice** object. T
**Error codes**
-For details about the error codes, see [CameraErrorCode](#cameraerrorcode).
+For details about the error codes, see [Camera Error Codes](../errorcodes/errorcode-camera.md).
| ID | Error Message |
| --------------- | --------------- |
@@ -311,7 +311,7 @@ Creates a **CameraInput** instance with the specified camera position and type.
**Error codes**
-For details about the error codes, see [CameraErrorCode](#cameraerrorcode).
+For details about the error codes, see [Camera Error Codes](../errorcodes/errorcode-camera.md).
| ID | Error Message |
| --------------- | --------------- |
@@ -355,7 +355,7 @@ Creates a **PreviewOutput** instance. This API returns the result synchronously.
**Error codes**
-For details about the error codes, see [CameraErrorCode](#cameraerrorcode).
+For details about the error codes, see [Camera Error Codes](../errorcodes/errorcode-camera.md).
| ID | Error Message |
| --------------- | --------------- |
@@ -397,7 +397,7 @@ Creates a **PhotoOutput** instance. This API returns the result synchronously.
**Error codes**
-For details about the error codes, see [CameraErrorCode](#cameraerrorcode).
+For details about the error codes, see [Camera Error Codes](../errorcodes/errorcode-camera.md).
| ID | Error Message |
| --------------- | --------------- |
@@ -439,7 +439,7 @@ Creates a **VideoOutput** instance. This API returns the result synchronously.
**Error codes**
-For details about the error codes, see [CameraErrorCode](#cameraerrorcode).
+For details about the error codes, see [Camera Error Codes](../errorcodes/errorcode-camera.md).
| ID | Error Message |
| --------------- | --------------- |
@@ -480,7 +480,7 @@ Creates a **MetadataOutput** instance. This API returns the result synchronously
**Error codes**
-For details about the error codes, see [CameraErrorCode](#cameraerrorcode).
+For details about the error codes, see [Camera Error Codes](../errorcodes/errorcode-camera.md).
| ID | Error Message |
| --------------- | --------------- |
@@ -515,7 +515,7 @@ Creates a **CaptureSession** instance. This API returns the result synchronously
**Error codes**
-For details about the error codes, see [CameraErrorCode](#cameraerrorcode).
+For details about the error codes, see [Camera Error Codes](../errorcodes/errorcode-camera.md).
| ID | Error Message |
| --------------- | --------------- |
@@ -606,7 +606,7 @@ Checks whether a camera supports prelaunch. This API is called in prior to **set
**Error codes**
-For details about the error codes, see [CameraErrorCode](#cameraerrorcode).
+For details about the error codes, see [Camera Error Codes](../errorcodes/errorcode-camera.md).
| ID | Error Message |
| --------------- | --------------- |
@@ -640,7 +640,7 @@ setPrelaunchConfig(prelaunchConfig: PrelaunchConfig): void
**Error codes**
-For details about the error codes, see [CameraErrorCode](#cameraerrorcode).
+For details about the error codes, see [Camera Error Codes](../errorcodes/errorcode-camera.md).
| ID | Error Message |
| --------------- | --------------- |
@@ -706,7 +706,7 @@ Creates a deferred **PreviewOutput** instance and adds it to the data stream ins
**Error codes**
-For details about the error codes, see [CameraErrorCode](#cameraerrorcode).
+For details about the error codes, see [Camera Error Codes](../errorcodes/errorcode-camera.md).
| ID | Error Message |
| --------------- | --------------- |
@@ -868,7 +868,7 @@ Opens this camera. This API uses an asynchronous callback to return the result.
**Error codes**
-For details about the error codes, see [CameraErrorCode](#cameraerrorcode).
+For details about the error codes, see [Camera Error Codes](../errorcodes/errorcode-camera.md).
| ID | Error Message |
| --------------- | --------------- |
@@ -904,7 +904,7 @@ Opens this camera. This API uses a promise to return the result.
**Error codes**
-For details about the error codes, see [CameraErrorCode](#cameraerrorcode).
+For details about the error codes, see [Camera Error Codes](../errorcodes/errorcode-camera.md).
| ID | Error Message |
| --------------- | --------------- |
@@ -938,7 +938,7 @@ Closes this camera. This API uses an asynchronous callback to return the result.
**Error codes**
-For details about the error codes, see [CameraErrorCode](#cameraerrorcode).
+For details about the error codes, see [Camera Error Codes](../errorcodes/errorcode-camera.md).
| ID | Error Message |
| --------------- | --------------- |
@@ -972,7 +972,7 @@ Closes this camera. This API uses a promise to return the result.
**Error codes**
-For details about the error codes, see [CameraErrorCode](#cameraerrorcode).
+For details about the error codes, see [Camera Error Codes](../errorcodes/errorcode-camera.md).
| ID | Error Message |
| --------------- | --------------- |
@@ -1096,7 +1096,7 @@ Starts configuration for the session.
**Error codes**
-For details about the error codes, see [CameraErrorCode](#cameraerrorcode).
+For details about the error codes, see [Camera Error Codes](../errorcodes/errorcode-camera.md).
| ID | Error Message |
| --------------- | --------------- |
@@ -1129,7 +1129,7 @@ Commits the configuration for this **CaptureSession** instance. This API uses an
**Error codes**
-For details about the error codes, see [CameraErrorCode](#cameraerrorcode).
+For details about the error codes, see [Camera Error Codes](../errorcodes/errorcode-camera.md).
| ID | Error Message |
| --------------- | --------------- |
@@ -1164,7 +1164,7 @@ Commits the configuration for this **CaptureSession** instance. This API uses a
**Error codes**
-For details about the error codes, see [CameraErrorCode](#cameraerrorcode).
+For details about the error codes, see [Camera Error Codes](../errorcodes/errorcode-camera.md).
| ID | Error Message |
| --------------- | --------------- |
@@ -1204,7 +1204,7 @@ Adds a [CameraInput](#camerainput) instance to the session.
**Error codes**
-For details about the error codes, see [CameraErrorCode](#cameraerrorcode).
+For details about the error codes, see [Camera Error Codes](../errorcodes/errorcode-camera.md).
| ID | Error Message |
| --------------- | --------------- |
@@ -1244,7 +1244,7 @@ Removes a [CameraInput](#camerainput) instance from the session.
**Error codes**
-For details about the error codes, see [CameraErrorCode](#cameraerrorcode).
+For details about the error codes, see [Camera Error Codes](../errorcodes/errorcode-camera.md).
| ID | Error Message |
| --------------- | --------------- |
@@ -1284,7 +1284,7 @@ Adds a [CameraOutput](#cameraoutput) instance to the session.
**Error codes**
-For details about the error codes, see [CameraErrorCode](#cameraerrorcode).
+For details about the error codes, see [Camera Error Codes](../errorcodes/errorcode-camera.md).
| ID | Error Message |
| --------------- | --------------- |
@@ -1324,7 +1324,7 @@ Removes a [CameraOutput](#cameraoutput) instance from the session.
**Error codes**
-For details about the error codes, see [CameraErrorCode](#cameraerrorcode).
+For details about the error codes, see [Camera Error Codes](../errorcodes/errorcode-camera.md).
| ID | Error Message |
| --------------- | --------------- |
@@ -1358,7 +1358,7 @@ Starts this **CaptureSession**. This API uses an asynchronous callback to return
**Error codes**
-For details about the error codes, see [CameraErrorCode](#cameraerrorcode).
+For details about the error codes, see [Camera Error Codes](../errorcodes/errorcode-camera.md).
| ID | Error Message |
| --------------- | --------------- |
@@ -1393,7 +1393,7 @@ Starts this **CaptureSession**. This API uses a promise to return the result.
**Error codes**
-For details about the error codes, see [CameraErrorCode](#cameraerrorcode).
+For details about the error codes, see [Camera Error Codes](../errorcodes/errorcode-camera.md).
| ID | Error Message |
| --------------- | --------------- |
@@ -1426,7 +1426,7 @@ Stops this **CaptureSession**. This API uses an asynchronous callback to return
**Error codes**
-For details about the error codes, see [CameraErrorCode](#cameraerrorcode).
+For details about the error codes, see [Camera Error Codes](../errorcodes/errorcode-camera.md).
| ID | Error Message |
| --------------- | --------------- |
@@ -1460,7 +1460,7 @@ Stops this **CaptureSession**. This API uses a promise to return the result.
**Error codes**
-For details about the error codes, see [CameraErrorCode](#cameraerrorcode).
+For details about the error codes, see [Camera Error Codes](../errorcodes/errorcode-camera.md).
| ID | Error Message |
| --------------- | --------------- |
@@ -1492,7 +1492,7 @@ Releases this **CaptureSession**. This API uses an asynchronous callback to retu
**Error codes**
-For details about the error codes, see [CameraErrorCode](#cameraerrorcode).
+For details about the error codes, see [Camera Error Codes](../errorcodes/errorcode-camera.md).
| ID | Error Message |
| --------------- | --------------- |
@@ -1526,7 +1526,7 @@ Releases this **CaptureSession**. This API uses a promise to return the result.
**Error codes**
-For details about the error codes, see [CameraErrorCode](#cameraerrorcode).
+For details about the error codes, see [Camera Error Codes](../errorcodes/errorcode-camera.md).
| ID | Error Message |
| --------------- | --------------- |
@@ -1558,7 +1558,7 @@ Checks whether the device has flash. This API uses an asynchronous callback to r
**Error codes**
-For details about the error codes, see [CameraErrorCode](#cameraerrorcode).
+For details about the error codes, see [Camera Error Codes](../errorcodes/errorcode-camera.md).
| ID | Error Message |
| --------------- | --------------- |
@@ -1597,7 +1597,7 @@ Checks whether a flash mode is supported.
**Error codes**
-For details about the error codes, see [CameraErrorCode](#cameraerrorcode).
+For details about the error codes, see [Camera Error Codes](../errorcodes/errorcode-camera.md).
| ID | Error Message |
| --------------- | --------------- |
@@ -1641,7 +1641,7 @@ Before the setting, do the following checks:
**Error codes**
-For details about the error codes, see [CameraErrorCode](#cameraerrorcode).
+For details about the error codes, see [Camera Error Codes](../errorcodes/errorcode-camera.md).
| ID | Error Message |
| --------------- | --------------- |
@@ -1674,7 +1674,7 @@ Obtains the flash mode in use.
**Error codes**
-For details about the error codes, see [CameraErrorCode](#cameraerrorcode).
+For details about the error codes, see [Camera Error Codes](../errorcodes/errorcode-camera.md).
| ID | Error Message |
| --------------- | --------------- |
@@ -1713,7 +1713,7 @@ Checks whether an exposure mode is supported.
**Error codes**
-For details about the error codes, see [CameraErrorCode](#cameraerrorcode).
+For details about the error codes, see [Camera Error Codes](../errorcodes/errorcode-camera.md).
| ID | Error Message |
| --------------- | --------------- |
@@ -1746,7 +1746,7 @@ Obtains the exposure mode in use.
**Error codes**
-For details about the error codes, see [CameraErrorCode](#cameraerrorcode).
+For details about the error codes, see [Camera Error Codes](../errorcodes/errorcode-camera.md).
| ID | Error Message |
| --------------- | --------------- |
@@ -1785,7 +1785,7 @@ Sets an exposure mode for the device.
**Error codes**
-For details about the error codes, see [CameraErrorCode](#cameraerrorcode).
+For details about the error codes, see [Camera Error Codes](../errorcodes/errorcode-camera.md).
| ID | Error Message |
| --------------- | --------------- |
@@ -1818,7 +1818,7 @@ Obtains the metering point of the device.
**Error codes**
-For details about the error codes, see [CameraErrorCode](#cameraerrorcode).
+For details about the error codes, see [Camera Error Codes](../errorcodes/errorcode-camera.md).
| ID | Error Message |
| --------------- | --------------- |
@@ -1859,7 +1859,7 @@ The coordinate system is based on the horizontal device direction with the devic
**Error codes**
-For details about the error codes, see [CameraErrorCode](#cameraerrorcode).
+For details about the error codes, see [Camera Error Codes](../errorcodes/errorcode-camera.md).
| ID | Error Message |
| --------------- | --------------- |
@@ -1893,7 +1893,7 @@ Obtains the exposure compensation values of the device.
**Error codes**
-For details about the error codes, see [CameraErrorCode](#cameraerrorcode).
+For details about the error codes, see [Camera Error Codes](../errorcodes/errorcode-camera.md).
| ID | Error Message |
| --------------- | --------------- |
@@ -1928,7 +1928,7 @@ Before the setting, you are advised to use **[getExposureBiasRange](#getexposure
**Error codes**
-For details about the error codes, see [CameraErrorCode](#cameraerrorcode).
+For details about the error codes, see [Camera Error Codes](../errorcodes/errorcode-camera.md).
| ID | Error Message |
| --------------- | --------------- |
@@ -1962,7 +1962,7 @@ Obtains the exposure value in use.
**Error codes**
-For details about the error codes, see [CameraErrorCode](#cameraerrorcode).
+For details about the error codes, see [Camera Error Codes](../errorcodes/errorcode-camera.md).
| ID | Error Message |
| --------------- | --------------- |
@@ -2001,7 +2001,7 @@ Checks whether a focus mode is supported.
**Error codes**
-For details about the error codes, see [CameraErrorCode](#cameraerrorcode).
+For details about the error codes, see [Camera Error Codes](../errorcodes/errorcode-camera.md).
| ID | Error Message |
| --------------- | --------------- |
@@ -2042,7 +2042,7 @@ Before the setting, use **[isFocusModeSupported](#isfocusmodesupported)** to che
**Error codes**
-For details about the error codes, see [CameraErrorCode](#cameraerrorcode).
+For details about the error codes, see [Camera Error Codes](../errorcodes/errorcode-camera.md).
| ID | Error Message |
| --------------- | --------------- |
@@ -2075,7 +2075,7 @@ Obtains the focus mode in use.
**Error codes**
-For details about the error codes, see [CameraErrorCode](#cameraerrorcode).
+For details about the error codes, see [Camera Error Codes](../errorcodes/errorcode-camera.md).
| ID | Error Message |
| --------------- | --------------- |
@@ -2116,7 +2116,7 @@ The coordinate system is based on the horizontal device direction with the devic
**Error codes**
-For details about the error codes, see [CameraErrorCode](#cameraerrorcode).
+For details about the error codes, see [Camera Error Codes](../errorcodes/errorcode-camera.md).
| ID | Error Message |
| --------------- | --------------- |
@@ -2150,7 +2150,7 @@ Obtains the focal point of the device.
**Error codes**
-For details about the error codes, see [CameraErrorCode](#cameraerrorcode).
+For details about the error codes, see [Camera Error Codes](../errorcodes/errorcode-camera.md).
| ID | Error Message |
| --------------- | --------------- |
@@ -2183,7 +2183,7 @@ Obtains the focal length of the device.
**Error codes**
-For details about the error codes, see [CameraErrorCode](#cameraerrorcode).
+For details about the error codes, see [Camera Error Codes](../errorcodes/errorcode-camera.md).
| ID | Error Message |
| --------------- | --------------- |
@@ -2216,7 +2216,7 @@ Obtains the supported zoom ratio range.
**Error codes**
-For details about the error codes, see [CameraErrorCode](#cameraerrorcode).
+For details about the error codes, see [Camera Error Codes](../errorcodes/errorcode-camera.md).
| ID | Error Message |
| --------------- | --------------- |
@@ -2255,7 +2255,7 @@ Sets a zoom ratio, with a maximum precision of two decimal places.
**Error codes**
-For details about the error codes, see [CameraErrorCode](#cameraerrorcode).
+For details about the error codes, see [Camera Error Codes](../errorcodes/errorcode-camera.md).
| ID | Error Message |
| --------------- | --------------- |
@@ -2289,7 +2289,7 @@ Obtains the zoom ratio in use.
**Error codes**
-For details about the error codes, see [CameraErrorCode](#cameraerrorcode).
+For details about the error codes, see [Camera Error Codes](../errorcodes/errorcode-camera.md).
| ID | Error Message |
| --------------- | --------------- |
@@ -2328,7 +2328,7 @@ Checks whether the specified video stabilization mode is supported.
**Error codes**
-For details about the error codes, see [CameraErrorCode](#cameraerrorcode).
+For details about the error codes, see [Camera Error Codes](../errorcodes/errorcode-camera.md).
| ID | Error Message |
| --------------- | --------------- |
@@ -2361,7 +2361,7 @@ Obtains the video stabilization mode in use.
**Error codes**
-For details about the error codes, see [CameraErrorCode](#cameraerrorcode).
+For details about the error codes, see [Camera Error Codes](../errorcodes/errorcode-camera.md).
| ID | Error Message |
| --------------- | --------------- |
@@ -2400,7 +2400,7 @@ Sets a video stabilization mode for the device.
**Error codes**
-For details about the error codes, see [CameraErrorCode](#cameraerrorcode).
+For details about the error codes, see [Camera Error Codes](../errorcodes/errorcode-camera.md).
| ID | Error Message |
| --------------- | --------------- |
@@ -2487,7 +2487,7 @@ Starts to output preview streams. This API uses an asynchronous callback to retu
**Error codes**
-For details about the error codes, see [CameraErrorCode](#cameraerrorcode).
+For details about the error codes, see [Camera Error Codes](../errorcodes/errorcode-camera.md).
| ID | Error Message |
| --------------- | --------------- |
@@ -2521,7 +2521,7 @@ Starts to output preview streams. This API uses a promise to return the result.
**Error codes**
-For details about the error codes, see [CameraErrorCode](#cameraerrorcode).
+For details about the error codes, see [Camera Error Codes](../errorcodes/errorcode-camera.md).
| ID | Error Message |
| --------------- | --------------- |
@@ -2603,7 +2603,7 @@ Releases output resources. This API uses an asynchronous callback to return the
**Error codes**
-For details about the error codes, see [CameraErrorCode](#cameraerrorcode).
+For details about the error codes, see [Camera Error Codes](../errorcodes/errorcode-camera.md).
| ID | Error Message |
| --------------- | --------------- |
@@ -2637,7 +2637,7 @@ Releases output resources. This API uses a promise to return the result.
**Error codes**
-For details about the error codes, see [CameraErrorCode](#cameraerrorcode).
+For details about the error codes, see [Camera Error Codes](../errorcodes/errorcode-camera.md).
| ID | Error Message |
| --------------- | --------------- |
@@ -2740,7 +2740,7 @@ Adds a surface for delayed preview. This API can run after **session.commitConfi
**Error codes**
-For details about the error codes, see [CameraErrorCode](#cameraerrorcode).
+For details about the error codes, see [Camera Error Codes](../errorcodes/errorcode-camera.md).
| ID | Error Message |
| --------------- | --------------- |
@@ -2836,7 +2836,7 @@ Captures a photo with the default shooting parameters. This API uses an asynchro
**Error codes**
-For details about the error codes, see [CameraErrorCode](#cameraerrorcode).
+For details about the error codes, see [Camera Error Codes](../errorcodes/errorcode-camera.md).
| ID | Error Message |
| --------------- | --------------- |
@@ -2871,7 +2871,7 @@ Captures a photo with the default shooting parameters. This API uses a promise t
**Error codes**
-For details about the error codes, see [CameraErrorCode](#cameraerrorcode).
+For details about the error codes, see [Camera Error Codes](../errorcodes/errorcode-camera.md).
| ID | Error Message |
| --------------- | --------------- |
@@ -2905,7 +2905,7 @@ Captures a photo with the specified shooting parameters. This API uses an asynch
**Error codes**
-For details about the error codes, see [CameraErrorCode](#cameraerrorcode).
+For details about the error codes, see [Camera Error Codes](../errorcodes/errorcode-camera.md).
| ID | Error Message |
| --------------- | --------------- |
@@ -2958,7 +2958,7 @@ Captures a photo with the specified shooting parameters. This API uses a promise
**Error codes**
-For details about the error codes, see [CameraErrorCode](#cameraerrorcode).
+For details about the error codes, see [Camera Error Codes](../errorcodes/errorcode-camera.md).
| ID | Error Message |
| --------------- | --------------- |
@@ -3023,7 +3023,7 @@ Releases output resources. This API uses an asynchronous callback to return the
**Error codes**
-For details about the error codes, see [CameraErrorCode](#cameraerrorcode).
+For details about the error codes, see [Camera Error Codes](../errorcodes/errorcode-camera.md).
| ID | Error Message |
| --------------- | --------------- |
@@ -3057,7 +3057,7 @@ Releases output resources. This API uses a promise to return the result.
**Error codes**
-For details about the error codes, see [CameraErrorCode](#cameraerrorcode).
+For details about the error codes, see [Camera Error Codes](../errorcodes/errorcode-camera.md).
| ID | Error Message |
| --------------- | --------------- |
@@ -3187,7 +3187,7 @@ This API takes effect after **CaptureSession.addOutput** and **CaptureSession.ad
**Error codes**
-For details about the error codes, see [CameraErrorCode](#cameraerrorcode).
+For details about the error codes, see [Camera Error Codes](../errorcodes/errorcode-camera.md).
| ID | Error Message |
| --------------- | --------------- |
@@ -3233,7 +3233,7 @@ This API takes effect after **CaptureSession.addOutput** and **CaptureSession.ad
**Error codes**
-For details about the error codes, see [CameraErrorCode](#cameraerrorcode).
+For details about the error codes, see [Camera Error Codes](../errorcodes/errorcode-camera.md).
| ID | Error Message |
| --------------- | --------------- |
@@ -3356,7 +3356,7 @@ Starts video recording. This API uses an asynchronous callback to return the res
**Error codes**
-For details about the error codes, see [CameraErrorCode](#cameraerrorcode).
+For details about the error codes, see [Camera Error Codes](../errorcodes/errorcode-camera.md).
| ID | Error Message |
| --------------- | --------------- |
@@ -3391,7 +3391,7 @@ Starts video recording. This API uses a promise to return the result.
**Error codes**
-For details about the error codes, see [CameraErrorCode](#cameraerrorcode).
+For details about the error codes, see [Camera Error Codes](../errorcodes/errorcode-camera.md).
| ID | Error Message |
| --------------- | --------------- |
@@ -3474,7 +3474,7 @@ Releases output resources. This API uses an asynchronous callback to return the
**Error codes**
-For details about the error codes, see [CameraErrorCode](#cameraerrorcode).
+For details about the error codes, see [Camera Error Codes](../errorcodes/errorcode-camera.md).
| ID | Error Message |
| --------------- | --------------- |
@@ -3508,7 +3508,7 @@ Releases output resources. This API uses a promise to return the result.
**Error codes**
-For details about the error codes, see [CameraErrorCode](#cameraerrorcode).
+For details about the error codes, see [Camera Error Codes](../errorcodes/errorcode-camera.md).
| ID | Error Message |
| --------------- | --------------- |
@@ -3613,7 +3613,7 @@ Starts to output metadata. This API uses an asynchronous callback to return the
**Error codes**
-For details about the error codes, see [CameraErrorCode](#cameraerrorcode).
+For details about the error codes, see [Camera Error Codes](../errorcodes/errorcode-camera.md).
| ID | Error Message |
| --------------- | --------------- |
@@ -3648,7 +3648,7 @@ Starts to output metadata. This API uses a promise to return the result.
**Error codes**
-For details about the error codes, see [CameraErrorCode](#cameraerrorcode).
+For details about the error codes, see [Camera Error Codes](../errorcodes/errorcode-camera.md).
| ID | Error Message |
| --------------- | --------------- |
diff --git a/en/application-dev/reference/apis/js-apis-cert.md b/en/application-dev/reference/apis/js-apis-cert.md
index bd2479de2399427cab87c95afe13d1d71e4d5956..a8676acc561469bdb3c7ea89d7e28c195db290c2 100644
--- a/en/application-dev/reference/apis/js-apis-cert.md
+++ b/en/application-dev/reference/apis/js-apis-cert.md
@@ -553,12 +553,16 @@ cryptoCert.createX509Cert(encodingBlob, function (error, x509Cert) {
});
```
-### getSerialNumber
+### getSerialNumber(deprecated)
getSerialNumber() : number
Obtains the X.509 certificate serial number.
+> **NOTE**
+>
+> This API is supported since API version 9 and deprecated since API version 10. You are advised to use [getCertSerialNumber](#getcertserialnumber10).
+
**System capability**: SystemCapability.Security.Cert
**Return value**
@@ -589,6 +593,48 @@ cryptoCert.createX509Cert(encodingBlob, function (error, x509Cert) {
});
```
+### getCertSerialNumber10+
+
+getCertSerialNumber() : bigint
+
+Obtains the X.509 certificate serial number.
+
+**System capability**: SystemCapability.Security.Cert
+
+**Return value**
+
+| Type | Description |
+| ------ | ------------------ |
+| bigint | X.509 certificate serial number obtained.|
+
+**Error codes**
+
+| ID| Error Message |
+| -------- | ------------------------------------------------- |
+| 19020002 | runtime error. |
+
+**Example**
+
+```js
+import cryptoCert from '@ohos.security.cert';
+
+// Certificate binary data, which must be set based on the service.
+let encodingData = null;
+let encodingBlob = {
+ data: encodingData,
+ // Set the encoding format, which can be FORMAT_PEM or FORMAT_DER.
+ encodingFormat: cryptoCert.EncodingFormat.FORMAT_PEM
+};
+cryptoCert.createX509Cert(encodingBlob, function (error, x509Cert) {
+ if (error != null) {
+ console.log("createX509Cert failed, errCode: " + error.code + ", errMsg: " + error.message);
+ } else {
+ console.log("createX509Cert success");
+ let serialNumber = x509Cert.getCertSerialNumber();
+ }
+});
+```
+
### getIssuerName
getIssuerName() : DataBlob
diff --git a/en/application-dev/reference/apis/js-apis-componentUtils.md b/en/application-dev/reference/apis/js-apis-componentUtils.md
deleted file mode 100644
index ed08051817ea9e1bf74c3f2377c507f597aacb9e..0000000000000000000000000000000000000000
--- a/en/application-dev/reference/apis/js-apis-componentUtils.md
+++ /dev/null
@@ -1,210 +0,0 @@
-# @ohos.componentUtils (componentUtils)
-
-The **componentUtils** module provides API for obtaining the coordinates and size of the drawing area of a component.
-
-> **NOTE**
->
-> The APIs of this module are supported since API version 10. Updates will be marked with a superscript to indicate their earliest API version.
->
-> The functionality of this module depends on UI context. This means that the APIs of this module cannot be used where the UI context is unclear. For details, see [UIContext](./js-apis-arkui-UIContext.md#uicontext).
->
-> Since API version 10, you can use the [getComponentUtils](./js-apis-arkui-UIContext.md#getcomponentutils) API in **UIContext** to obtain the **ComponentUtils** object associated with the current UI context. For this API to work correctly, call it after the notification indicating completion of component layout is received through [@ohos.arkui.inspector (layout callback)](js-apis-arkui-inspector.md).
-
-## Modules to Import
-
-```js
-import componentUtils from '@ohos.componentUtils'
-```
-## componentUtils.getRectangleById
-
-getRectangleById(id: string): ComponentInfo
-
-Obtains a **ComponentInfo** object based on the component ID.
-
-**System capability**: SystemCapability.ArkUI.ArkUI.Full
-
-**Parameters**
-
-| Name| Type | Mandatory| Description |
-| ------ | ------ | ---- | ---------- |
-| id | string | Yes | Component ID.|
-
-**Return value**
-
-| Type | Description |
-| ------ | ---------- |
-| [ComponentInfo](#componentinfo) | **ComponentInfo** object, which provides the size, position, translation, scaling, rotation, and affine matrix information of the component.|
-
-**Example**
-
-```js
-let modePosition = componentUtils.getRectangleById("onClick");
-```
-
-## ComponentInfo
-
-| Name | Type | Description |
-| ---------------|------------ | -----------------------------|
-| size | [Size](#size) | Component size. |
-| localOffset | [Offset](#offset) | Offset of the component relative to the parent component. |
-| windowOffset | [Offset](#offset) | Offset of the component relative to the window. |
-| screenOffset | [Offset](#offset) | Offset of the component relative to the screen. |
-| translate | [TranslateResult](#translateresult) | Translation of the component. |
-| scale | [ScaleResult](#scaleresult) | Scaling of the component. |
-| rotate | [RotateResult](#rotateresult) | Rotation of the component. |
-| transform | [Matrix4Result](#matrix4result) | Affine matrix of the component, which is a 4x4 matrix object created based on the input parameter. |
-
-### Size
-
-| Name | Type| Description |
-| -------- | ---- | ----------------------------------|
-| width | number | Component width. |
-| height | number | Component height. |
-
-### Offset
-
-| Name | Type| Description |
-| --------| ---- | -----------------------------------|
-| x | number | X coordinate. |
-| y | number | Y coordinate. |
-
-### TranslateResult
-
-| Name | Type| Description |
-| --------| ---- | -----------------------------------|
-| x | number | Translation distance along the x-axis. |
-| y | number | Translation distance along the y-axis. |
-| z | number | Translation distance along the z-axis. |
-
-### ScaleResult
-
-| Name | Type| Description |
-| --------| ---- | -----------------------------------|
-| x | number | Scale factor along the x-axis. |
-| y | number | Scale factor along the y-axis. |
-| z | number | Scale factor along the z-axis. |
-| centerX | number | X coordinate of the center point. |
-| centerY | number | Y coordinate of the center point. |
-
-### RotateResult
-
-| Name | Type| Description |
-| --------| ---- | -----------------------------------|
-| x | number | X coordinate of the rotation vector. |
-| y | number | Y coordinate of the rotation vector. |
-| z | number | Z coordinate of the rotation vector. |
-| angle | number | Rotation angle. |
-| centerX | number | X coordinate of the center point. |
-| centerY | number | Y coordinate of the center point. |
-
-### Matrix4Result
-
-| Name | Type| Description |
-| --------| ---- | -----------------------------------|
-| number | number | Scale factor along the x-axis. Defaults to **1** for the identity matrix. |
-| number | number | The second value, which is affected by the rotation of the x, y, and z axes.|
-| number | number | The third value, which is affected by the rotation of the x, y, and z axes.|
-| number | number | Meaningless value. |
-| number | number | The fifth value, which is affected by the rotation of the x, y, and z axes.|
-| number | number | Scale factor along the y-axis. Defaults to **1** for the identity matrix. |
-| number | number | The seventh value, which is affected by the rotation of the x, y, and z axes.|
-| number | number | Meaningless value. |
-| number | number | The ninth value, which is affected by the rotation of the x, y, and z axes.|
-| number | number | The tenth value, which is affected by the rotation of the x, y, and z axes.|
-| number | number | Scale factor along the z-axis. Defaults to **1** for the identity matrix. |
-| number | number | Meaningless value. |
-| number | number | Translation distance along the x-axis. Defaults to **0** for the identity matrix. |
-| number | number | Translation distance along the y-axis. Defaults to **0** for the identity matrix.|
-| number | number | Translation distance along the z-axis. Defaults to **0** for the identity matrix.|
-| number | number | Valid in homogeneous coordinates, presenting the perspective projection effect. |
-
-**Example**
-
- ```js
-import matrix4 from '@ohos.matrix4';
-import componentUtils from '@ohos.componentUtils';
-
-@Entry
-@Component
-struct Utils{
- private getComponentRect(key) {
- console.info("Mode Key: " + key);
- let modePosition = componentUtils.getRectangleById(key);
-
- let localOffsetWidth = modePosition.size.width;
- let localOffsetHeight = modePosition.size.height;
- let localOffsetX = modePosition.localOffset.x;
- let localOffsetY = modePosition.localOffset.y;
-
- let windowOffsetX = modePosition.windowOffset.x;
- let windowOffsetY = modePosition.windowOffset.y;
-
- let screenOffsetX = modePosition.screenOffset.x;
- let screenOffsetY = modePosition.screenOffset.y;
-
- let translateX = modePosition.translate.x;
- let translateY = modePosition.translate.y;
- let translateZ = modePosition.translate.z;
-
- let scaleX = modePosition.scale.x;
- let scaleY = modePosition.scale.y;
- let scaleZ = modePosition.scale.z;
- let scaleCenterX = modePosition.scale.centerX;
- let scaleCenterY = modePosition.scale.centerY;
-
- let rotateX = modePosition.rotate.x;
- let rotateY = modePosition.rotate.y;
- let rotateZ = modePosition.rotate.z;
- let rotateCenterX = modePosition.rotate.centerX;
- let rotateCenterY = modePosition.rotate.centerY;
- let rotateAngle = modePosition.rotate.angle;
-
- let Matrix4_1 = modePosition.transform[0];
- let Matrix4_2 = modePosition.transform[1];
- let Matrix4_3 = modePosition.transform[2];
- let Matrix4_4 = modePosition.transform[3];
- let Matrix4_5 = modePosition.transform[4];
- let Matrix4_6 = modePosition.transform[5];
- let Matrix4_7 = modePosition.transform[6];
- let Matrix4_8 = modePosition.transform[7];
- let Matrix4_9 = modePosition.transform[8];
- let Matrix4_10 = modePosition.transform[9];
- let Matrix4_11 = modePosition.transform[10];
- let Matrix4_12 = modePosition.transform[11];
- let Matrix4_13 = modePosition.transform[12];
- let Matrix4_14 = modePosition.transform[13];
- let Matrix4_15 = modePosition.transform[14];
- let Matrix4_16 = modePosition.transform[15];
- console.info("[getRectangleById] current component obj is: " + modePosition );
- }
- @State x: number = 120;
- @State y: number = 10;
- @State z: number = 100;
- private matrix1 = matrix4.identity().translate({ x: this.x, y: this.y, z: this.z });
- build() {
- Column() {
- Image($r("app.media.icon"))
- .transform(this.matrix1)
- .translate({ x: 100, y: 10, z: 50})
- .scale({ x: 2, y: 0.5, z: 1 })
- .rotate({
- x: 1,
- y: 1,
- z: 1,
- centerX: '50%',
- centerY: '50%',
- angle: 300
- })
- .width("40%")
- .height(100)
- .key("image_01")
- Button() {
- Text('getRectangleById').fontSize(40).fontWeight(FontWeight.Bold);
- }.margin({ top: 20 })
- .onClick(() => {
- this.getComponentRect("image_01");
- }).id('onClick');
- }
- }
-}
- ```
diff --git a/en/application-dev/reference/apis/js-apis-curve.md b/en/application-dev/reference/apis/js-apis-curve.md
index 235f7014246488fcc9a4b6d936a4e5bf16faf52e..ffc902f8eda9f2a5d5d0c55a4f6b6ceeabc1c031 100644
--- a/en/application-dev/reference/apis/js-apis-curve.md
+++ b/en/application-dev/reference/apis/js-apis-curve.md
@@ -78,7 +78,7 @@ Creates a step curve.
| Name| Type | Mandatory| Description |
| ------ | ------- | ----| ------------------------------------------------------------ |
-| count | number | Yes | Number of steps. The value must be a positive integer.MissionCallback | Yes | Callback to register.|
**Return value**
| Type | Description |
| ------------------- | ---------------- |
-| Promise<void> | Promise used to return the result.|
+| Promise<void> | Promise that returns no value.|
**Example**
@@ -123,7 +122,6 @@ Registers a mission status listener. This API uses a promise to return the resul
}
```
-
## distributedMissionManager.unRegisterMissionListener
unRegisterMissionListener(parameter: MissionDeviceInfo, callback: AsyncCallback<void>): void;
@@ -138,8 +136,8 @@ Deregisters a mission status listener. This API uses an asynchronous callback to
| Name | Type | Mandatory | Description |
| --------- | --------------------------------------- | ---- | --------- |
-| parameter | [MissionDeviceInfo](#missiondeviceinfo) | Yes | Information about the device to listen for. |
-| callback | AsyncCallback<void> | Yes | Callback used to return the result.|
+| parameter | [MissionDeviceInfo](#missiondeviceinfo) | Yes | Information about the device to listen for. |
+| callback | AsyncCallback<void> | Yes | Callback used to return the result. If the listener is deregistered, **err** is **undefined**. Otherwise, **err** is an error object.|
**Example**
@@ -159,7 +157,6 @@ Deregisters a mission status listener. This API uses an asynchronous callback to
}
```
-
## distributedMissionManager.unRegisterMissionListener
unRegisterMissionListener(parameter: MissionDeviceInfo): Promise<void>
@@ -180,7 +177,7 @@ Deregisters a mission status listener. This API uses a promise to return the res
| Type | Description |
| ------------------- | ---------------- |
-| Promise<void> | Promise used to return the result.|
+| Promise<void> |Promise that returns no value.|
**Example**
@@ -215,7 +212,7 @@ Starts to synchronize the remote mission list. This API uses an asynchronous cal
| Name | Type | Mandatory | Description |
| --------- | ------------------------------------- | ---- | --------- |
| parameter | [MissionParameter](#missionparameter) | Yes | Parameters required for synchronization. |
-| callback | AsyncCallback<void> | Yes | Callback used to return the result.|
+| callback | AsyncCallback<void> | Yes | Callback used to return the result. If the synchronization is started, **err** is **undefined**. Otherwise, **err** is an error object.|
**Example**
@@ -257,7 +254,7 @@ Starts to synchronize the remote mission list. This API uses a promise to return
| Type | Description |
| ------------------- | ---------------- |
-| Promise<void> | Promise used to return the result.|
+| Promise<void> | Promise that returns no value.|
**Example**
@@ -294,7 +291,7 @@ Stops synchronizing the remote mission list. This API uses an asynchronous callb
| Name | Type | Mandatory | Description |
| --------- | --------------------------------------- | ---- | --------- |
| parameter | [MissionDeviceInfo](#missiondeviceinfo) | Yes | Parameters required for synchronization. |
-| callback | AsyncCallback<void> | Yes | Callback used to return the result.|
+| callback | AsyncCallback<void> | Yes | Callback used to return the result. If the synchronization is stopped, **err** is **undefined**. Otherwise, **err** is an error object.|
**Example**
@@ -334,7 +331,7 @@ Stops synchronizing the remote mission list. This API uses a promise to return t
| Type | Description |
| ------------------- | ---------------- |
-| Promise<void> | Promise used to return the result.|
+| Promise<void> | Promise that returns no value.|
**Example**
@@ -358,7 +355,7 @@ Stops synchronizing the remote mission list. This API uses a promise to return t
continueMission(parameter: ContinueDeviceInfo, options: ContinueCallback, callback: AsyncCallback<void>): void;
-Continues a mission on a remote device. This API uses an asynchronous callback to return the result.
+Continues a mission on a remote device, with the mission ID specified. This API uses an asynchronous callback to return the result.
**Required permissions**: ohos.permission.MANAGE_MISSIONS and ohos.permission.DISTRIBUTED_DATASYNC
@@ -370,7 +367,7 @@ Continues a mission on a remote device. This API uses an asynchronous callback t
| --------- | --------------------------------------- | ---- | ----- |
| parameter | [ContinueDeviceInfo](js-apis-inner-application-continueDeviceInfo.md) | Yes | Parameters required for mission continuation.|
| options | [ContinueCallback](js-apis-inner-application-continueCallback.md) | Yes | Callback invoked when the mission continuation is complete.|
-| callback | AsyncCallback<void> | Yes | Callback used to return the result.|
+| callback | AsyncCallback<void> | Yes | Callback used to return the result. If the mission is continued, **err** is **undefined**. Otherwise, **err** is an error object.|
**Error codes**
@@ -416,7 +413,7 @@ For details about the error codes, see [Distributed Scheduler Error Codes](../er
continueMission(parameter: ContinueDeviceInfo, options: ContinueCallback): Promise<void>
-Continues a mission on a remote device. This API uses a promise to return the result.
+Continues a mission on a remote device, with the mission ID specified. This API uses a promise to return the result.
**Required permissions**: ohos.permission.MANAGE_MISSIONS and ohos.permission.DISTRIBUTED_DATASYNC
@@ -433,7 +430,7 @@ Continues a mission on a remote device. This API uses a promise to return the re
| Type | Description |
| ------------------- | ---------------- |
-| Promise<void> | Promise used to return the result.|
+| Promise<void> |Promise that returns no value.|
**Error codes**
@@ -490,7 +487,7 @@ Continues a mission on a remote device, with the bundle name specified. This API
| Name | Type | Mandatory | Description |
| --------- | --------------------------------------- | ---- | ----- |
| parameter | [ContinueMissionInfo](./js-apis-inner-application-continueMissionInfo.md) | Yes | Parameters required for mission continuation.|
-| callback | AsyncCallback<void> | Yes | Callback invoked when the mission continuation is complete.|
+| callback | AsyncCallback<void> | Yes | Callback used to return the result. If the mission is continued, **err** is **undefined**. Otherwise, **err** is an error object.|
**Error codes**
@@ -546,7 +543,7 @@ Continues a mission on a remote device, with the bundle name specified. This API
| Type | Description |
| ------------------- | ---------------- |
-| Promise<void> | Promise used to return the result.|
+| Promise<void> | Promise that returns no value.|
**Error codes**
@@ -586,7 +583,7 @@ For details about the error codes, see [Distributed Scheduler Error Codes](../er
on(type: 'continueStateChange', callback: Callback<{ state: ContinueState, info: ContinuableInfo }>): void
-Registers a listener for the mission continuation state of the current application.
+Subscribes to continuation state change events of the current mission.
**Required permissions**: ohos.permission.MANAGE_MISSIONS
@@ -596,8 +593,8 @@ Registers a listener for the mission continuation state of the current applicati
| Name | Type | Mandatory | Description |
| --------- | ---------------------------------------- | ---- | -------- |
-| type | string | Yes | Type of the listener. The value is fixed at **'continueStateChange'**. |
-| callback | Callback<{ state: [ContinueState](#continuestate10), info: [ContinuableInfo](./js-apis-inner-application-continuableInfo.md) }> | Yes | Callback used to return the mission continuation state and information. |
+| type | string | Yes | Event type. The value **'continueStateChange'** indicates the continuation state change event of the current mission. |
+| callback | Callback<{ state: [ContinueState](#continuestate10), info: [ContinuableInfo](./js-apis-inner-application-continuableInfo.md) }> | Yes | Callback used to return the continuation state and information of the current mission. |
**Example**
@@ -615,7 +612,7 @@ Registers a listener for the mission continuation state of the current applicati
off(type: 'continueStateChange', callback?: Callback<{ state: ContinueState, info: ContinuableInfo }>): void
-Deregisters a listener for the mission continuation state of the current application.
+Unsubscribes from continuation state change events of the current mission.
**Required permissions**: ohos.permission.MANAGE_MISSIONS
@@ -625,8 +622,8 @@ Deregisters a listener for the mission continuation state of the current applica
| Name | Type | Mandatory | Description |
| --------- | ---------------------------------------- | ---- | -------- |
-| type | string | Yes | Type of the listener. The value is fixed at **'continueStateChange'**. |
-| callback | Callback<{ state: [ContinueState](#continuestate10), info: [ContinuableInfo](./js-apis-inner-application-continuableInfo.md) }> | No | Callback used for the listener to be deregistered. |
+| type | string | Yes | Event type. The value **'continueStateChange'** indicates the continuation state change event of the current mission. |
+| callback | Callback<{ state: [ContinueState](#continuestate10), info: [ContinuableInfo](./js-apis-inner-application-continuableInfo.md) }> | No | Callback used to return the continuation state and information of the current mission.10+
+
+authorizeAdmin(admin: Want, bundleName: string, callback: AsyncCallback<void>): void
+
+Authorizes the administrator rights to an application through the specified device administrator application. This API uses an asynchronous callback to return the result.
+
+**Required permissions**: ohos.permission.MANAGE_ENTERPRISE_DEVICE_ADMIN
+
+**System capability**: SystemCapability.Customization.EnterpriseDeviceManager
+
+**System API**: This is a system API.
+
+**Parameters**
+
+| Name | Type | Mandatory | Description |
+| ----- | ----------------------------------- | ---- | ------- |
+| admin | [Want](js-apis-app-ability-want.md) | Yes | Device administrator application.|
+| bundleName | string | Yes| Bundle name of the application to be authorized with the administrator rights.|
+| callback | AsyncCallback<void> | Yes| Callback invoked to return the result. If the operation is successful, **err** is **null**. Otherwise, **err** is an error object.|
+
+**Error codes**
+
+For details about the error codes, see [Enterprise Device Management Error Codes](../errorcodes/errorcode-enterpriseDeviceManager.md).
+
+| ID| Error Message |
+| ------- | ----------------------------------------------------- |
+| 9200001 | the application is not an administrator of the device. |
+| 9200002 | the administrator application does not have permission to manage the device. |
+| 9200009 | authorize permission to the application failed. |
+
+**Example**
+
+```js
+let wantTemp = {
+ bundleName: 'bundleName',
+ abilityName: 'abilityName',
+};
+let bundleName: string = "com.example.application";
+adminManager.authorizeAdmin(wantTemp, bundleName, (err) => {
+ if (err) {
+ console.error(`Failed to authorize permission to the application. Code: ${err.code}, message: ${err.message}`);
+ return;
+ }
+ console.info('Successfully authorized permission to the application');
+});
+```
+
+## adminManager.authorizeAdmin10+
+
+authorizeAdmin(admin: Want, bundleName: string): Promise<void>
+
+Authorizes the administrator rights to an application through the specified device administrator application. This API uses a promise to return the result.
+
+**Required permissions**: ohos.permission.MANAGE_ENTERPRISE_DEVICE_ADMIN
+
+**System capability**: SystemCapability.Customization.EnterpriseDeviceManager
+
+**System API**: This is a system API.
+
+**Parameters**
+
+| Name | Type | Mandatory | Description |
+| ----- | ----------------------------------- | ---- | ------- |
+| admin | [Want](js-apis-app-ability-want.md) | Yes | Device administrator application.|
+| bundleName | string | Yes| Bundle name of the application to be authorized with the administrator rights.|
+
+**Return value**
+
+| Type | Description |
+| ----- | ----------------------------------- |
+| Promise<void> | Promise that returns no value. If the operation fails, an error object will be thrown.|
+
+**Error codes**
+
+For details about the error codes, see [Enterprise Device Management Error Codes](../errorcodes/errorcode-enterpriseDeviceManager.md).
+
+| ID| Error Message |
+| ------- | ----------------------------------------------------- |
+| 9200001 | the application is not an administrator of the device. |
+| 9200002 | the administrator application does not have permission to manage the device. |
+| 9200009 | authorize permission to the application failed. |
+
+**Example**
+
+```js
+let wantTemp = {
+ bundleName: 'bundleName',
+ abilityName: 'abilityName',
+};
+let bundleName: string = "com.example.application";
+adminManager.authorizeAdmin(wantTemp, bundleName).then(() => {
+}).catch((err) => {
+ console.error(`Failed to authorize permission to the application. Code: ${err.code}, message: ${err.message}`);
+})
+```
+
## EnterpriseInfo
Represents the enterprise information of a device administrator application.
diff --git a/en/application-dev/reference/apis/js-apis-file-fs.md b/en/application-dev/reference/apis/js-apis-file-fs.md
index 5effa68ff47127104f00d7d9113104470f027b91..3e783a185818183eb33d3419cf5bbb6f0d47cfa2 100644
--- a/en/application-dev/reference/apis/js-apis-file-fs.md
+++ b/en/application-dev/reference/apis/js-apis-file-fs.md
@@ -2687,7 +2687,7 @@ Represents detailed file information. Before calling any API of the **Stat()** c
| Name | Type | Readable | Writable | Description |
| ------ | ------ | ---- | ---- | ---------------------------------------- |
| ino | number | Yes | No | File ID. Different files on the same device have different **ino**s.| |
-| mode | number | Yes | No | File permissions. The meaning of each bit is as follows:10+
**System capability**: SystemCapability.ArkUI.ArkUI.Full
@@ -170,7 +170,7 @@ struct FontExample {
Column() {
Button("getFontByName")
.onClick(() => {
- this.fontInfo = font.getFontByName('HarmonyOS Sans Italic')
+ this.fontInfo = font.getFontByName('Sans Italic')
console.log("getFontByName(): path = " + this.fontInfo.path)
console.log("getFontByName(): postScriptName = " + this.fontInfo.postScriptName)
console.log("getFontByName(): fullName = " + this.fontInfo.fullName)
diff --git a/en/application-dev/reference/apis/js-apis-geoLocationManager.md b/en/application-dev/reference/apis/js-apis-geoLocationManager.md
index 263a1a525e0fa1dffcbd9e79703d2d359ac49dcc..647a3cb04a224a8ac0f0ca828ab79297f8d8ead8 100644
--- a/en/application-dev/reference/apis/js-apis-geoLocationManager.md
+++ b/en/application-dev/reference/apis/js-apis-geoLocationManager.md
@@ -53,7 +53,7 @@ Defines a reverse geocoding request.
| locale | string | Yes| Yes| Language used for the location description. **zh** indicates Chinese, and **en** indicates English.|
| latitude | number | Yes| Yes| Latitude information. A positive value indicates north latitude, and a negative value indicates south latitude. The value ranges from **-90** to **90**.|
| longitude | number | Yes| Yes| Longitude information. A positive value indicates east longitude , and a negative value indicates west longitude . The value ranges from **-180** to **180**.|
-| maxItems | number | Yes| Yes| Maximum number of location records to be returned. The value must be greater than or equal to **0**. A value smaller than **10** is recommended.|
+| maxItems | number | Yes| Yes| Maximum number of location records to be returned. The specified value must be greater than or equal to **0**. A value smaller than **10** is recommended.|
## GeoCodeRequest
@@ -66,7 +66,7 @@ Defines a geocoding request.
| -------- | -------- | -------- | -------- | -------- |
| locale | string | Yes| Yes| Language used for the location description. **zh** indicates Chinese, and **en** indicates English.|
| description | string | Yes| Yes| Location description, for example, **No. xx, xx Road, Pudong New District, Shanghai**.|
-| maxItems | number | Yes| Yes| Maximum number of location records to be returned. The value must be greater than or equal to **0**. A value smaller than **10** is recommended.|
+| maxItems | number | Yes| Yes| Maximum number of location records to be returned. The specified value must be greater than or equal to **0**. A value smaller than **10** is recommended.|
| minLatitude | number | Yes| Yes| Minimum latitude. This parameter is used with **minLongitude**, **maxLatitude**, and **maxLongitude** to specify the latitude and longitude ranges. The value ranges from **-90** to **90**.|
| minLongitude | number | Yes| Yes| Minimum longitude. The value ranges from **-180** to **180**.|
| maxLatitude | number | Yes| Yes| Maximum latitude. The value ranges from **-90** to **90**.|
@@ -98,7 +98,7 @@ Defines a geographic location.
| phoneNumber | string | Yes| No| Phone number.|
| addressUrl | string | Yes| No| Website URL.|
| descriptions | Array<string> | Yes| No| Additional descriptions.|
-| descriptionsSize | number | Yes| No| Total number of additional descriptions. The value must be greater than or equal to **0**. A value smaller than **10** is recommended.|
+| descriptionsSize | number | Yes| No| Total number of additional descriptions. The specified value must be greater than or equal to **0**. A value smaller than **10** is recommended.|
| isFromMock | Boolean | Yes| No| Whether the geographical name is from the mock reverse geocoding function.10+
+
+Defines the configuration for obtaining the required data of the location service.
+
+**System capability**: SystemCapability.Location.Location.Core
+
+**System API**: This is a system API.
+
+| Name| Type| Readable|Writable| Description|
+| -------- | -------- | -------- | -------- | -------- |
+| type | [LocatingRequiredDataType](#locatingrequireddatatype10) | Yes| Yes| Type of the required data.|
+| needStartScan | boolean | Yes| Yes| Whether to initiate scanning.|
+| scanInterval | number | Yes| Yes| Scanning interval, in milliseconds. The specified value must be greater than **0**. The default value is **10000**.|
+| scanTimeout | number | Yes| Yes| Scanning timeout interval, in milliseconds. The value ranges from **0** to **600000**. The default value is **10000**.|
+
+
+## LocatingRequiredData10+
+
+Defines the required data of the location service, including the Wi-Fi or Bluetooth scanning result. After obtaining the data, an application can use the data for services such as network positioning.
+
+**System capability**: SystemCapability.Location.Location.Core
+
+**System API**: This is a system API.
+
+| Name| Type| Readable|Writable| Description|
+| -------- | -------- | -------- | -------- | -------- |
+| wifiData | [WifiScanInfo](#wifiscaninfo10) | Yes| No| Wi-Fi scanning result.|
+| bluetoothData | [BluetoothScanInfo](#bluetoothscaninfo10) | Yes| No| Bluetooth scanning result.|
+
+
+## WifiScanInfo10+
+
+Defines the Wi-Fi scanning information, including the SSID, BSSID, and RSSI of the scanned Wi-Fi hotspot.
+
+**System capability**: SystemCapability.Location.Location.Core
+
+**System API**: This is a system API.
+
+| Name| Type| Readable|Writable| Description|
+| -------- | -------- | -------- | -------- | -------- |
+| ssid | string | Yes| No| Service set identifier (SSID) of a Wi-Fi hotspot, in UTF-8 format.|
+| bssid | string | Yes| No| Base station subsystem identifier (BSSID) of a Wi-Fi hotspot.|
+| rssi | number | Yes| No| Received signal strength indicator (RSSI) of a Wi-Fi hotspot, in dBm.|
+| frequency | number | Yes| No| Frequency of a Wi-Fi hotspot.|
+| timestamp | number | Yes| No| Scanning timestamp.|
+
+
+## BluetoothScanInfo10+
+
+Defines the Bluetooth scanning information.
+
+**System capability**: SystemCapability.Location.Location.Core
+
+**System API**: This is a system API.
+
+| Name| Type| Readable|Writable| Description|
+| -------- | -------- | -------- | -------- | -------- |
+| deviceName | string | Yes| No| Name of a Bluetooth device.|
+| macAddress | string | Yes| No| MAC address of a Bluetooth device.|
+| rssi | number | Yes| No| Signal strength of a Bluetooth device, in dBm.|
+| timestamp | number | Yes| No| Scanning timestamp.|
+
+
## LocationRequestPriority
Sets the priority of the location request.
@@ -294,7 +357,7 @@ Defines the privacy statement type.
**System capability**: SystemCapability.Location.Location.Core
-**System API**: This is a system API and cannot be called by third-party applications.
+**System API**: This is a system API.
| Name| Value| Description|
| -------- | -------- | -------- |
@@ -305,7 +368,7 @@ Defines the privacy statement type.
## CountryCodeType
-Represents the country code source type.
+Defines the country code source type.
**System capability**: SystemCapability.Location.Location.Core
@@ -317,11 +380,25 @@ Represents the country code source type.
| COUNTRY_CODE_FROM_NETWORK | 4 | Country code obtained from the cellular network registration information.|
+## LocatingRequiredDataType10+
+
+Defines the type of the required data of the location service.
+
+**System capability**: SystemCapability.Location.Location.Core
+
+**System API**: This is a system API.
+
+| Name| Value| Description|
+| -------- | -------- | -------- |
+| WIFI | 1 | Wi-Fi scanning information.|
+| BLUETOOTH | 2 | Bluetooth scanning information.|
+
+
## geoLocationManager.on('locationChange')
on(type: 'locationChange', request: LocationRequest, callback: Callback<Location>): void
-Registers a listener for location changes with a location request initiated.
+Subscribes to location change events with a location request initiated.
**Permission required**: ohos.permission.APPROXIMATELY_LOCATION
@@ -331,13 +408,13 @@ Registers a listener for location changes with a location request initiated.
| Name| Type| Mandatory| Description|
| -------- | -------- | -------- | -------- |
- | type | string | Yes| Event type. The value **locationChange** indicates a location change event.|
+ | type | string | Yes| Event type. The value **locationChange** indicates a location change.|
| request | [LocationRequest](#locationrequest) | Yes| Location request.|
- | callback | Callback<[Location](#location)> | Yes| Callback used to return the location change event.|
+ | callback | Callback<[Location](#location)> | Yes| Callback used to receive location change events.|
**Error codes**
-For details about the following error codes, see [Location Error Codes](../errorcodes/errorcode-geoLocationManager.md).
+For details about the error codes, see [Location Error Codes](../errorcodes/errorcode-geoLocationManager.md).
| ID| Error Message|
| -------- | ---------------------------------------- |
@@ -349,7 +426,7 @@ For details about the following error codes, see [Location Error Codes](../error
```ts
import geoLocationManager from '@ohos.geoLocationManager';
- let requestInfo = {'priority': 0x203, 'scenario': 0x300, 'timeInterval': 0, 'distanceInterval': 0, 'maxAccuracy': 0};
+ let requestInfo = {'priority': geoLocationManager.LocationRequestPriority.FIRST_FIX, 'scenario': geoLocationManager.LocationRequestScenario.UNSET, 'timeInterval': 1, 'distanceInterval': 0, 'maxAccuracy': 0};
let locationChange = (location) => {
console.log('locationChanger: data: ' + JSON.stringify(location));
};
@@ -366,7 +443,7 @@ For details about the following error codes, see [Location Error Codes](../error
off(type: 'locationChange', callback?: Callback<Location>): void
-Unregisters the listener for location changes with the corresponding location request deleted.
+Unsubscribes from location change events with the corresponding location request deleted.
**Permission required**: ohos.permission.APPROXIMATELY_LOCATION
@@ -376,12 +453,12 @@ Unregisters the listener for location changes with the corresponding location re
| Name| Type| Mandatory| Description|
| -------- | -------- | -------- | -------- |
- | type | string | Yes| Event type. The value **locationChange** indicates a location change event.|
+ | type | string | Yes| Event type. The value **locationChange** indicates a location change.|
| callback | Callback<[Location](#location)> | No| Callback to unregister. If this parameter is not specified, all callbacks of the specified event type are unregistered.|
**Error codes**
-For details about the following error codes, see [Location Error Codes](../errorcodes/errorcode-geoLocationManager.md).
+For details about the error codes, see [Location Error Codes](../errorcodes/errorcode-geoLocationManager.md).
| ID| Error Message|
| -------- | ---------------------------------------- |
@@ -393,7 +470,7 @@ For details about the following error codes, see [Location Error Codes](../error
```ts
import geoLocationManager from '@ohos.geoLocationManager';
- let requestInfo = {'priority': 0x203, 'scenario': 0x300, 'timeInterval': 0, 'distanceInterval': 0, 'maxAccuracy': 0};
+ let requestInfo = {'priority': geoLocationManager.LocationRequestPriority.FIRST_FIX, 'scenario': geoLocationManager.LocationRequestScenario.UNSET, 'timeInterval': 1, 'distanceInterval': 0, 'maxAccuracy': 0};
let locationChange = (location) => {
console.log('locationChanger: data: ' + JSON.stringify(location));
};
@@ -410,7 +487,7 @@ For details about the following error codes, see [Location Error Codes](../error
on(type: 'locationEnabledChange', callback: Callback<boolean>): void
-Registers a listener for location service status change events.
+Subscribes to location service status change events.
**System capability**: SystemCapability.Location.Location.Core
@@ -418,12 +495,12 @@ Registers a listener for location service status change events.
| Name| Type| Mandatory| Description|
| -------- | -------- | -------- | -------- |
- | type | string | Yes| Event type. The value **locationEnabledChange** indicates a location service status change event.|
- | callback | Callback<boolean> | Yes| Callback used to return the location service status change event.|
+ | type | string | Yes| Event type. The value **locationEnabledChange** indicates a location service status change.|
+ | callback | Callback<boolean> | Yes| Callback used to receive location service status change events.|
**Error codes**
-For details about the following error codes, see [Location Error Codes](../errorcodes/errorcode-geoLocationManager.md).
+For details about the error codes, see [Location Error Codes](../errorcodes/errorcode-geoLocationManager.md).
| ID| Error Message|
| -------- | ---------------------------------------- |
@@ -448,7 +525,7 @@ For details about the following error codes, see [Location Error Codes](../error
off(type: 'locationEnabledChange', callback?: Callback<boolean>): void;
-Unregisters the listener for location service status change events.
+Unsubscribes from location service status change events.
**System capability**: SystemCapability.Location.Location.Core
@@ -456,12 +533,12 @@ Unregisters the listener for location service status change events.
| Name| Type| Mandatory| Description|
| -------- | -------- | -------- | -------- |
- | type | string | Yes| Event type. The value **locationEnabledChange** indicates a location service status change event.|
+ | type | string | Yes| Event type. The value **locationEnabledChange** indicates a location service status change.|
| callback | Callback<boolean> | No| Callback to unregister. If this parameter is not specified, all callbacks of the specified event type are unregistered.|
**Error codes**
-For details about the following error codes, see [Location Error Codes](../errorcodes/errorcode-geoLocationManager.md).
+For details about the error codes, see [Location Error Codes](../errorcodes/errorcode-geoLocationManager.md).
| ID| Error Message|
| -------- | ---------------------------------------- |
@@ -487,7 +564,7 @@ For details about the following error codes, see [Location Error Codes](../error
on(type: 'cachedGnssLocationsChange', request: CachedGnssLocationsRequest, callback: Callback<Array<Location>>): void;
-Registers a listener for cached GNSS location reports.
+Subscribes to cached GNSS location reports.
**Permission required**: ohos.permission.APPROXIMATELY_LOCATION
@@ -499,11 +576,11 @@ Registers a listener for cached GNSS location reports.
| -------- | -------- | -------- | -------- |
| type | string | Yes| Event type. The value **cachedGnssLocationsChange** indicates reporting of cached GNSS locations.|
| request | [CachedGnssLocationsRequest](#cachedgnsslocationsrequest) | Yes| Request for reporting cached GNSS location.|
- | callback | Callback<boolean> | Yes| Callback used to return cached GNSS locations.|
+ | callback | Callback<boolean> | Yes| Callback used to receive cached GNSS locations.|
**Error codes**
-For details about the following error codes, see [Location Error Codes](../errorcodes/errorcode-geoLocationManager.md).
+For details about the error codes, see [Location Error Codes](../errorcodes/errorcode-geoLocationManager.md).
| ID| Error Message|
| -------- | ---------------------------------------- |
@@ -531,7 +608,7 @@ For details about the following error codes, see [Location Error Codes](../error
off(type: 'cachedGnssLocationsChange', callback?: Callback<Array<Location>>): void;
-Unregisters the listener for cached GNSS location reports.
+Unsubscribes from cached GNSS location reports.
**Permission required**: ohos.permission.APPROXIMATELY_LOCATION
@@ -546,7 +623,7 @@ Unregisters the listener for cached GNSS location reports.
**Error codes**
-For details about the following error codes, see [Location Error Codes](../errorcodes/errorcode-geoLocationManager.md).
+For details about the error codes, see [Location Error Codes](../errorcodes/errorcode-geoLocationManager.md).
| ID| Error Message|
| -------- | ---------------------------------------- |
@@ -575,7 +652,7 @@ For details about the following error codes, see [Location Error Codes](../error
on(type: 'satelliteStatusChange', callback: Callback<SatelliteStatusInfo>): void;
-Registers a listener for GNSS satellite status change events.
+Subscribes to GNSS satellite status change events.
**Permission required**: ohos.permission.APPROXIMATELY_LOCATION
@@ -585,12 +662,12 @@ Registers a listener for GNSS satellite status change events.
| Name| Type| Mandatory| Description|
| -------- | -------- | -------- | -------- |
- | type | string | Yes| Event type. The value **satelliteStatusChange** indicates a GNSS satellite status change event.|
- | callback | Callback<[SatelliteStatusInfo](#satellitestatusinfo)> | Yes| Callback used to return GNSS satellite status changes.|
+ | type | string | Yes| Event type. The value **satelliteStatusChange** indicates a GNSS satellite status change.|
+ | callback | Callback<[SatelliteStatusInfo](#satellitestatusinfo)> | Yes| Callback used to receive GNSS satellite status change events.|
**Error codes**
-For details about the following error codes, see [Location Error Codes](../errorcodes/errorcode-geoLocationManager.md).
+For details about the error codes, see [Location Error Codes](../errorcodes/errorcode-geoLocationManager.md).
| ID| Error Message|
| -------- | ---------------------------------------- |
@@ -617,7 +694,7 @@ For details about the following error codes, see [Location Error Codes](../error
off(type: 'satelliteStatusChange', callback?: Callback<SatelliteStatusInfo>): void;
-Unregisters the listener for GNSS satellite status change events.
+Unsubscribes from GNSS satellite status change events.
**Permission required**: ohos.permission.APPROXIMATELY_LOCATION
@@ -627,12 +704,12 @@ Unregisters the listener for GNSS satellite status change events.
| Name| Type| Mandatory| Description|
| -------- | -------- | -------- | -------- |
- | type | string | Yes| Event type. The value **satelliteStatusChange** indicates a GNSS satellite status change event.|
+ | type | string | Yes| Event type. The value **satelliteStatusChange** indicates a GNSS satellite status change.|
| callback | Callback<[SatelliteStatusInfo](#satellitestatusinfo)> | No| Callback to unregister. If this parameter is not specified, all callbacks of the specified event type are unregistered.|
**Error codes**
-For details about the following error codes, see [Location Error Codes](../errorcodes/errorcode-geoLocationManager.md).
+For details about the error codes, see [Location Error Codes](../errorcodes/errorcode-geoLocationManager.md).
| ID| Error Message|
| -------- | ---------------------------------------- |
@@ -660,7 +737,7 @@ For details about the following error codes, see [Location Error Codes](../error
on(type: 'nmeaMessage', callback: Callback<string>): void;
-Registers a listener for GNSS NMEA message change events.
+Subscribes to GNSS NMEA message change events.
**Required permissions**: ohos.permission.LOCATION and ohos.permission.APPROXIMATELY_LOCATION
@@ -670,12 +747,12 @@ Registers a listener for GNSS NMEA message change events.
| Name| Type| Mandatory| Description|
| -------- | -------- | -------- | -------- |
- | type | string | Yes| Event type. The value **nmeaMessage** indicates a GNSS NMEA message change event.|
- | callback | Callback<string> | Yes| Callback used to return GNSS NMEA message changes.|
+ | type | string | Yes| Event type. The value **nmeaMessage** indicates a GNSS NMEA message change.|
+ | callback | Callback<string> | Yes| Callback used to receive GNSS NMEA message change events.|
**Error codes**
-For details about the following error codes, see [Location Error Codes](../errorcodes/errorcode-geoLocationManager.md).
+For details about the error codes, see [Location Error Codes](../errorcodes/errorcode-geoLocationManager.md).
| ID| Error Message|
| -------- | ---------------------------------------- |
@@ -703,7 +780,7 @@ For details about the following error codes, see [Location Error Codes](../error
off(type: 'nmeaMessage', callback?: Callback<string>): void;
-Unregisters the listener for GNSS NMEA message change events.
+Unsubscribes from GNSS NMEA message change events.
**Required permissions**: ohos.permission.LOCATION and ohos.permission.APPROXIMATELY_LOCATION
@@ -713,12 +790,12 @@ Unregisters the listener for GNSS NMEA message change events.
| Name| Type| Mandatory| Description|
| -------- | -------- | -------- | -------- |
- | type | string | Yes| Event type. The value **nmeaMessage** indicates a GNSS NMEA message change event.|
+ | type | string | Yes| Event type. The value **nmeaMessage** indicates a GNSS NMEA message change.|
| callback | Callback<string> | No| Callback to unregister. If this parameter is not specified, all callbacks of the specified event type are unregistered.|
**Error codes**
-For details about the following error codes, see [Location Error Codes](../errorcodes/errorcode-geoLocationManager.md).
+For details about the error codes, see [Location Error Codes](../errorcodes/errorcode-geoLocationManager.md).
| ID| Error Message|
| -------- | ---------------------------------------- |
@@ -747,7 +824,7 @@ For details about the following error codes, see [Location Error Codes](../error
on(type: 'gnssFenceStatusChange', request: GeofenceRequest, want: WantAgent): void;
-Registers a listener for status change events of the specified geofence.
+Subscribes to status change events of the specified geofence.
**Permission required**: ohos.permission.APPROXIMATELY_LOCATION
@@ -757,13 +834,13 @@ Registers a listener for status change events of the specified geofence.
| Name| Type| Mandatory| Description|
| -------- | -------- | -------- | -------- |
- | type | string | Yes| Event type. The value **gnssFenceStatusChange** indicates a geofence status change event.|
+ | type | string | Yes| Event type. The value **gnssFenceStatusChange** indicates a geofence status change.|
| request | [GeofenceRequest](#geofencerequest) | Yes| Geofencing request.|
- | want | [WantAgent](js-apis-app-ability-wantAgent.md) | Yes| **WantAgent** used to return geofence (entrance or exit) events.|
+ | want | [WantAgent](js-apis-app-ability-wantAgent.md) | Yes| **WantAgent** used to receive geofence (entrance or exit) events.|
**Error codes**
-For details about the following error codes, see [Location Error Codes](../errorcodes/errorcode-geoLocationManager.md).
+For details about the error codes, see [Location Error Codes](../errorcodes/errorcode-geoLocationManager.md).
| ID| Error Message|
| -------- | ---------------------------------------- |
@@ -805,7 +882,7 @@ For details about the following error codes, see [Location Error Codes](../error
off(type: 'gnssFenceStatusChange', request: GeofenceRequest, want: WantAgent): void;
-Unregisters the listener for status change events of the specified geofence.
+Unsubscribes from status change events of the specified geofence.
**Permission required**: ohos.permission.APPROXIMATELY_LOCATION
@@ -815,13 +892,13 @@ Unregisters the listener for status change events of the specified geofence.
| Name| Type| Mandatory| Description|
| -------- | -------- | -------- | -------- |
- | type | string | Yes| Event type. The value **gnssFenceStatusChange** indicates a geofence status change event.|
+ | type | string | Yes| Event type. The value **gnssFenceStatusChange** indicates a geofence status change.|
| request | [GeofenceRequest](#geofencerequest) | Yes| Geofencing request.|
- | want | [WantAgent](js-apis-app-ability-wantAgent.md) | Yes| **WantAgent** used to return geofence (entrance or exit) events.|
+ | want | [WantAgent](js-apis-app-ability-wantAgent.md) | Yes| **WantAgent** used to receive geofence (entrance or exit) events.|
**Error codes**
-For details about the following error codes, see [Location Error Codes](../errorcodes/errorcode-geoLocationManager.md).
+For details about the error codes, see [Location Error Codes](../errorcodes/errorcode-geoLocationManager.md).
| ID| Error Message|
| -------- | ---------------------------------------- |
@@ -864,7 +941,7 @@ For details about the following error codes, see [Location Error Codes](../error
on(type: 'countryCodeChange', callback: Callback<CountryCode>): void;
-Registers a listener for country code change events.
+Subscribes to country code change events.
**System capability**: SystemCapability.Location.Location.Core
@@ -872,12 +949,12 @@ Registers a listener for country code change events.
| Name| Type| Mandatory| Description|
| -------- | -------- | -------- | -------- |
- | type | string | Yes| Event type. The value **countryCodeChange** indicates a country code change event.|
- | callback | Callback<[CountryCode](#countrycode)> | Yes| Callback used to return the country code change event.|
+ | type | string | Yes| Event type. The value **countryCodeChange** indicates a country code change.|
+ | callback | Callback<[CountryCode](#countrycode)> | Yes| Callback used to receive country code change events.|
**Error codes**
-For details about the following error codes, see [Location Error Codes](../errorcodes/errorcode-geoLocationManager.md).
+For details about the error codes, see [Location Error Codes](../errorcodes/errorcode-geoLocationManager.md).
| ID| Error Message|
| -------- | ---------------------------------------- |
@@ -905,7 +982,7 @@ For details about the following error codes, see [Location Error Codes](../error
off(type: 'countryCodeChange', callback?: Callback<CountryCode>): void;
-Unregisters the listener for country code change events.
+Unsubscribes from country code change events.
**System capability**: SystemCapability.Location.Location.Core
@@ -913,12 +990,12 @@ Unregisters the listener for country code change events.
| Name| Type| Mandatory| Description|
| -------- | -------- | -------- | -------- |
- | type | string | Yes| Event type. The value **countryCodeChange** indicates a country code change event.|
+ | type | string | Yes| Event type. The value **countryCodeChange** indicates a country code change.|
| callback | Callback<[CountryCode](#countrycode)> | No| Callback to unregister. If this parameter is not specified, all callbacks of the specified event type are unregistered.|
**Error codes**
-For details about the following error codes, see [Location Error Codes](../errorcodes/errorcode-geoLocationManager.md).
+For details about the error codes, see [Location Error Codes](../errorcodes/errorcode-geoLocationManager.md).
| ID| Error Message|
| -------- | ---------------------------------------- |
@@ -942,6 +1019,89 @@ For details about the following error codes, see [Location Error Codes](../error
```
+## geoLocationManager.on('locatingRequiredDataChange')10+
+
+on(type: 'locatingRequiredDataChange', config: LocatingRequiredDataConfig, callback: Callback<Array<LocatingRequiredData>>): void;
+
+Subscribes to changes in the required data of the location service, including Wi-Fi and Bluetooth scanning information. An application can then determine whether to enable Wi-Fi and Bluetooth scanning based on the return result.
+
+**Required permissions**: ohos.permission.LOCATION and ohos.permission.APPROXIMATELY_LOCATION
+
+**System capability**: SystemCapability.Location.Location.Core
+
+**System API**: This is a system API.
+
+**Parameters**
+
+ | Name| Type| Mandatory| Description|
+ | -------- | -------- | -------- | -------- |
+ | type | string | Yes| Event type. The value **locatingRequiredDataChange** indicates a change in the required data of the location service.|
+ | config | [LocatingRequiredDataConfig](#locatingrequireddataconfig10) | Yes| Configuration for obtaining the required data of the location service.|
+ | callback | Callback<Array<[LocatingRequiredData](#locatingrequireddata10)>> | Yes| Callback used to receive the required data of the location service.|
+
+**Error codes**
+
+For details about the error codes, see [Location Error Codes](../errorcodes/errorcode-geoLocationManager.md).
+
+| ID| Error Message|
+| -------- | ---------------------------------------- |
+|3301800 | Failed to start WiFi or Bluetooth scanning. |
+
+**Example**
+
+ ```ts
+ import geoLocationManager from '@ohos.geoLocationManager';
+ let callback = (code) => {
+ console.log('locatingRequiredDataChange: ' + JSON.stringify(code));
+ }
+ let config = {'type': 1, 'needStartScan': true, 'scanInterval': 10000};
+ try {
+ geoLocationManager.on('locatingRequiredDataChange', config, callback);
+ } catch (err) {
+ console.error("errCode:" + err.code + ",errMessage:" + err.message);
+ }
+ ```
+
+
+## geoLocationManager.off('locatingRequiredDataChange')10+
+
+off(type: 'locatingRequiredDataChange', callback?: Callback<Array<LocatingRequiredData>>): void;
+
+Unsubscribes from changes in the required data of the location service and stops Wi-Fi and Bluetooth scanning.
+
+**Required permissions**: ohos.permission.LOCATION and ohos.permission.APPROXIMATELY_LOCATION
+
+**System capability**: SystemCapability.Location.Location.Core
+
+**System API**: This is a system API.
+
+**Parameters**
+
+ | Name| Type| Mandatory| Description|
+ | -------- | -------- | -------- | -------- |
+ | type | string | Yes| Event type. The value **locatingRequiredDataChange** indicates a change in the required data of the location service.|
+ | callback | Callback<Array<[LocatingRequiredData](#locatingrequireddata10)>> | No| Callback to unregister. If this parameter is not specified, all callbacks of the specified event type are unregistered.|
+
+**Error codes**
+
+For details about the error codes, see [Location Error Codes](../errorcodes/errorcode-geoLocationManager.md).
+
+**Example**
+
+ ```ts
+ import geoLocationManager from '@ohos.geoLocationManager';
+ let callback = (code) => {
+ console.log('locatingRequiredDataChange: ' + JSON.stringify(code));
+ }
+ let config = {'type': 1, 'needStartScan': true, 'scanInterval': 10000};
+ try {
+ geoLocationManager.on('locatingRequiredDataChange', config, callback);
+ geoLocationManager.off('locatingRequiredDataChange', callback);
+ } catch (err) {
+ console.error("errCode:" + err.code + ",errMessage:" + err.message);
+ }
+ ```
+
## geoLocationManager.getCurrentLocation
@@ -958,11 +1118,11 @@ Obtains the current location. This API uses an asynchronous callback to return t
| Name| Type| Mandatory| Description|
| -------- | -------- | -------- | -------- |
| request | [CurrentLocationRequest](#currentlocationrequest) | Yes| Location request.|
- | callback | AsyncCallback<[Location](#location)> | Yes| Callback used to return the current location.|
+ | callback | AsyncCallback<[Location](#location)> | Yes| Callback used to receive the current location.|
**Error codes**
-For details about the following error codes, see [Location Error Codes](../errorcodes/errorcode-geoLocationManager.md).
+For details about the error codes, see [Location Error Codes](../errorcodes/errorcode-geoLocationManager.md).
| ID| Error Message|
| -------- | ---------------------------------------- |
@@ -974,7 +1134,7 @@ For details about the following error codes, see [Location Error Codes](../error
```ts
import geoLocationManager from '@ohos.geoLocationManager';
- let requestInfo = {'priority': 0x203, 'scenario': 0x300,'maxAccuracy': 0};
+ let requestInfo = {'priority': geoLocationManager.LocationRequestPriority.FIRST_FIX, 'scenario': geoLocationManager.LocationRequestScenario.UNSET,'maxAccuracy': 0};
let locationChange = (err, location) => {
if (err) {
console.log('locationChanger: err=' + JSON.stringify(err));
@@ -1005,11 +1165,11 @@ Obtains the current location. This API uses an asynchronous callback to return t
| Name| Type| Mandatory| Description|
| -------- | -------- | -------- | -------- |
- | callback | AsyncCallback<[Location](#location)> | Yes| Callback used to return the current location.|
+ | callback | AsyncCallback<[Location](#location)> | Yes| Callback used to receive the current location.|
**Error codes**
-For details about the following error codes, see [Location Error Codes](../errorcodes/errorcode-geoLocationManager.md).
+For details about the error codes, see [Location Error Codes](../errorcodes/errorcode-geoLocationManager.md).
| ID| Error Message|
| -------- | ---------------------------------------- |
@@ -1061,7 +1221,7 @@ Obtains the current location. This API uses a promise to return the result.
**Error codes**
-For details about the following error codes, see [Location Error Codes](../errorcodes/errorcode-geoLocationManager.md).
+For details about the error codes, see [Location Error Codes](../errorcodes/errorcode-geoLocationManager.md).
| ID| Error Message|
| -------- | ---------------------------------------- |
@@ -1073,7 +1233,7 @@ For details about the following error codes, see [Location Error Codes](../error
```ts
import geoLocationManager from '@ohos.geoLocationManager';
- let requestInfo = {'priority': 0x203, 'scenario': 0x300,'maxAccuracy': 0};
+ let requestInfo = {'priority': geoLocationManager.LocationRequestPriority.FIRST_FIX, 'scenario': geoLocationManager.LocationRequestScenario.UNSET,'maxAccuracy': 0};
try {
geoLocationManager.getCurrentLocation(requestInfo).then((result) => {
console.log('current location: ' + JSON.stringify(result));
@@ -1105,7 +1265,7 @@ Obtains the last location.
**Error codes**
-For details about the following error codes, see [Location Error Codes](../errorcodes/errorcode-geoLocationManager.md).
+For details about the error codes, see [Location Error Codes](../errorcodes/errorcode-geoLocationManager.md).
| ID| Error Message|
| -------- | ---------------------------------------- |
@@ -1141,7 +1301,7 @@ Checks whether the location service is enabled.
**Error codes**
-For details about the following error codes, see [Location Error Codes](../errorcodes/errorcode-geoLocationManager.md).
+For details about the error codes, see [Location Error Codes](../errorcodes/errorcode-geoLocationManager.md).
| ID| Error Message|
| -------- | ---------------------------------------- |
@@ -1165,7 +1325,7 @@ enableLocation(callback: AsyncCallback<void>): void;
Enables the location service. This API uses an asynchronous callback to return the result.
-**System API**: This is a system API and cannot be called by third-party applications.
+**System API**: This is a system API.
**Required permissions**: ohos.permission.MANAGE_SECURE_SETTINGS
@@ -1175,11 +1335,11 @@ Enables the location service. This API uses an asynchronous callback to return t
| Name| Type| Mandatory| Description|
| -------- | -------- | -------- | -------- |
- | callback | AsyncCallback<void> | Yes| Callback used to return the error message.|
+ | callback | AsyncCallback<void> | Yes| Callback used to receive the error message.|
**Error codes**
-For details about the following error codes, see [Location Error Codes](../errorcodes/errorcode-geoLocationManager.md).
+For details about the error codes, see [Location Error Codes](../errorcodes/errorcode-geoLocationManager.md).
| ID| Error Message|
| -------- | ---------------------------------------- |
@@ -1207,7 +1367,7 @@ enableLocation(): Promise<void>
Enables the location service. This API uses a promise to return the result.
-**System API**: This is a system API and cannot be called by third-party applications.
+**System API**: This is a system API.
**Required permissions**: ohos.permission.MANAGE_SECURE_SETTINGS
@@ -1221,7 +1381,7 @@ Enables the location service. This API uses a promise to return the result.
**Error codes**
-For details about the following error codes, see [Location Error Codes](../errorcodes/errorcode-geoLocationManager.md).
+For details about the error codes, see [Location Error Codes](../errorcodes/errorcode-geoLocationManager.md).
| ID| Error Message|
| -------- | ---------------------------------------- |
@@ -1249,7 +1409,7 @@ disableLocation(): void;
Disables the location service.
-**System API**: This is a system API and cannot be called by third-party applications.
+**System API**: This is a system API.
**Required permissions**: ohos.permission.MANAGE_SECURE_SETTINGS
@@ -1257,7 +1417,7 @@ Disables the location service.
**Error codes**
-For details about the following error codes, see [Location Error Codes](../errorcodes/errorcode-geoLocationManager.md).
+For details about the error codes, see [Location Error Codes](../errorcodes/errorcode-geoLocationManager.md).
| ID| Error Message|
| -------- | ---------------------------------------- |
@@ -1275,7 +1435,6 @@ For details about the following error codes, see [Location Error Codes](../error
```
-
## geoLocationManager.getAddressesFromLocation
getAddressesFromLocation(request: ReverseGeoCodeRequest, callback: AsyncCallback<Array<GeoAddress>>): void
@@ -1289,11 +1448,11 @@ Converts coordinates into geographic description through reverse geocoding. This
| Name| Type| Mandatory| Description|
| -------- | -------- | -------- | -------- |
| request | [ReverseGeoCodeRequest](#reversegeocoderequest) | Yes| Reverse geocoding request.|
- | callback | AsyncCallback<Array<[GeoAddress](#geoaddress)>> | Yes| Callback used to return the reverse geocoding result.|
+ | callback | AsyncCallback<Array<[GeoAddress](#geoaddress)>> | Yes| Callback used to receive the reverse geocoding result.|
**Error codes**
-For details about the following error codes, see [Location Error Codes](../errorcodes/errorcode-geoLocationManager.md).
+For details about the error codes, see [Location Error Codes](../errorcodes/errorcode-geoLocationManager.md).
| ID| Error Message|
| -------- | ---------------------------------------- |
@@ -1342,7 +1501,7 @@ Converts coordinates into geographic description through reverse geocoding. This
**Error codes**
-For details about the following error codes, see [Location Error Codes](../errorcodes/errorcode-geoLocationManager.md).
+For details about the error codes, see [Location Error Codes](../errorcodes/errorcode-geoLocationManager.md).
| ID| Error Message|
| -------- | ---------------------------------------- |
@@ -1380,11 +1539,11 @@ Converts geographic description into coordinates through geocoding. This API use
| Name| Type| Mandatory| Description|
| -------- | -------- | -------- | -------- |
| request | [GeoCodeRequest](#geocoderequest) | Yes| Geocoding request.|
- | callback | AsyncCallback<Array<[GeoAddress](#geoaddress)>> | Yes| Callback used to return the geocoding result.|
+ | callback | AsyncCallback<Array<[GeoAddress](#geoaddress)>> | Yes| Callback used to receive the geocoding result.|
**Error codes**
-For details about the following error codes, see [Location Error Codes](../errorcodes/errorcode-geoLocationManager.md).
+For details about the error codes, see [Location Error Codes](../errorcodes/errorcode-geoLocationManager.md).
| ID| Error Message|
| -------- | ---------------------------------------- |
@@ -1433,7 +1592,7 @@ Converts geographic description into coordinates through geocoding. This API use
**Error codes**
-For details about the following error codes, see [Location Error Codes](../errorcodes/errorcode-geoLocationManager.md).
+For details about the error codes, see [Location Error Codes](../errorcodes/errorcode-geoLocationManager.md).
| ID| Error Message|
| -------- | ---------------------------------------- |
@@ -1473,7 +1632,7 @@ Obtains the (reverse) geocoding service status.
**Error codes**
-For details about the following error codes, see [Location Error Codes](../errorcodes/errorcode-geoLocationManager.md).
+For details about the error codes, see [Location Error Codes](../errorcodes/errorcode-geoLocationManager.md).
| ID| Error Message|
| -------- | ---------------------------------------- |
@@ -1505,11 +1664,11 @@ Obtains the number of cached GNSS locations.
| Name| Type| Mandatory| Description|
| -------- | -------- | -------- | -------- |
- | callback | AsyncCallback<number> | Yes| Callback used to return the number of cached GNSS locations. |
+ | callback | AsyncCallback<number> | Yes| Callback used to receive the number of cached GNSS locations. |
**Error codes**
-For details about the following error codes, see [Location Error Codes](../errorcodes/errorcode-geoLocationManager.md).
+For details about the error codes, see [Location Error Codes](../errorcodes/errorcode-geoLocationManager.md).
| ID| Error Message|
| -------- | ---------------------------------------- |
@@ -1553,7 +1712,7 @@ Obtains the number of cached GNSS locations.
**Error codes**
-For details about the following error codes, see [Location Error Codes](../errorcodes/errorcode-geoLocationManager.md).
+For details about the error codes, see [Location Error Codes](../errorcodes/errorcode-geoLocationManager.md).
| ID| Error Message|
| -------- | ---------------------------------------- |
@@ -1591,11 +1750,11 @@ Obtains all cached GNSS locations and clears the GNSS cache queue.
| Name| Type| Mandatory| Description|
| -------- | -------- | -------- | -------- |
- | callback | AsyncCallback<void> | Yes| Callback used to return the error message.|
+ | callback | AsyncCallback<void> | Yes| Callback used to receive the error message.|
**Error codes**
-For details about the following error codes, see [Location Error Codes](../errorcodes/errorcode-geoLocationManager.md).
+For details about the error codes, see [Location Error Codes](../errorcodes/errorcode-geoLocationManager.md).
| ID| Error Message|
| -------- | ---------------------------------------- |
@@ -1633,11 +1792,11 @@ Obtains all cached GNSS locations and clears the GNSS cache queue.
| Name| Type| Mandatory| Description|
| -------- | -------- | -------- | -------- |
- | Promise<void> | void | NA | Promise used to return the error code.|
+ | Promise<void> | void | NA | Promise used to receive the error code.|
**Error codes**
-For details about the following error codes, see [Location Error Codes](../errorcodes/errorcode-geoLocationManager.md).
+For details about the error codes, see [Location Error Codes](../errorcodes/errorcode-geoLocationManager.md).
| ID| Error Message|
| -------- | ---------------------------------------- |
@@ -1675,11 +1834,11 @@ Sends an extended command to the location subsystem.
| Name| Type| Mandatory| Description|
| -------- | -------- | -------- | -------- |
| command | [LocationCommand](#locationcommand) | Yes| Extended command (string) to be sent.|
- | callback | AsyncCallback<void> | Yes| Callback used to return the error code.|
+ | callback | AsyncCallback<void> | Yes| Callback used to receive the error code.|
**Error codes**
-For details about the following error codes, see [Location Error Codes](../errorcodes/errorcode-geoLocationManager.md).
+For details about the error codes, see [Location Error Codes](../errorcodes/errorcode-geoLocationManager.md).
| ID| Error Message|
| -------- | ---------------------------------------- |
@@ -1720,11 +1879,11 @@ Sends an extended command to the location subsystem.
| Name| Type| Mandatory| Description|
| -------- | -------- | -------- | -------- |
- | Promise<void> | void | NA | Promise used to return the error code.|
+ | Promise<void> | void | NA | Promise used to receive the error code.|
**Error codes**
-For details about the following error codes, see [Location Error Codes](../errorcodes/errorcode-geoLocationManager.md).
+For details about the error codes, see [Location Error Codes](../errorcodes/errorcode-geoLocationManager.md).
| ID| Error Message|
| -------- | ---------------------------------------- |
@@ -1760,11 +1919,11 @@ Obtains the current country code.
| Name| Type| Mandatory| Description|
| -------- | -------- | -------- | -------- |
- | callback | AsyncCallback<[CountryCode](#countrycode)> | Yes| Callback used to return the country code.|
+ | callback | AsyncCallback<[CountryCode](#countrycode)> | Yes| Callback used to receive the country code.|
**Error codes**
-For details about the following error codes, see [Location Error Codes](../errorcodes/errorcode-geoLocationManager.md).
+For details about the error codes, see [Location Error Codes](../errorcodes/errorcode-geoLocationManager.md).
| ID| Error Message|
| -------- | ---------------------------------------- |
@@ -1802,11 +1961,11 @@ Obtains the current country code.
| Name| Type| Mandatory| Description|
| -------- | -------- | -------- | -------- |
- | Promise<[CountryCode](#countrycode)> | [CountryCode](#countrycode) | NA | Promise used to return the country code.|
+ | Promise<[CountryCode](#countrycode)> | [CountryCode](#countrycode) | NA | Promise used to receive the country code.|
**Error codes**
-For details about the following error codes, see [Location Error Codes](../errorcodes/errorcode-geoLocationManager.md).
+For details about the error codes, see [Location Error Codes](../errorcodes/errorcode-geoLocationManager.md).
| ID| Error Message|
| -------- | ---------------------------------------- |
@@ -1839,11 +1998,11 @@ Enables the mock location function.
**System capability**: SystemCapability.Location.Location.Core
-**System API**: This is a system API and cannot be called by third-party applications.
+**System API**: This is a system API.
**Error codes**
-For details about the following error codes, see [Location Error Codes](../errorcodes/errorcode-geoLocationManager.md).
+For details about the error codes, see [Location Error Codes](../errorcodes/errorcode-geoLocationManager.md).
| ID| Error Message|
| -------- | ---------------------------------------- |
@@ -1870,11 +2029,11 @@ Disables the mock location function.
**System capability**: SystemCapability.Location.Location.Core
-**System API**: This is a system API and cannot be called by third-party applications.
+**System API**: This is a system API.
**Error codes**
-For details about the following error codes, see [Location Error Codes](../errorcodes/errorcode-geoLocationManager.md).
+For details about the error codes, see [Location Error Codes](../errorcodes/errorcode-geoLocationManager.md).
| ID| Error Message|
| -------- | ---------------------------------------- |
@@ -1903,7 +2062,7 @@ This API can be invoked only after [geoLocationManager.enableLocationMock](#geol
**System capability**: SystemCapability.Location.Location.Core
-**System API**: This is a system API and cannot be called by third-party applications.
+**System API**: This is a system API.
**Parameters**
@@ -1913,7 +2072,7 @@ This API can be invoked only after [geoLocationManager.enableLocationMock](#geol
**Error codes**
-For details about the following error codes, see [Location Error Codes](../errorcodes/errorcode-geoLocationManager.md).
+For details about the error codes, see [Location Error Codes](../errorcodes/errorcode-geoLocationManager.md).
| ID| Error Message|
| -------- | ---------------------------------------- |
@@ -1949,11 +2108,11 @@ Enables the mock reverse geocoding function.
**System capability**: SystemCapability.Location.Location.Core
-**System API**: This is a system API and cannot be called by third-party applications.
+**System API**: This is a system API.
**Error codes**
-For details about the following error codes, see [Location Error Codes](../errorcodes/errorcode-geoLocationManager.md).
+For details about the error codes, see [Location Error Codes](../errorcodes/errorcode-geoLocationManager.md).
| ID| Error Message|
| -------- | ---------------------------------------- |
@@ -1979,11 +2138,11 @@ Disables the mock geocoding function.
**System capability**: SystemCapability.Location.Location.Core
-**System API**: This is a system API and cannot be called by third-party applications.
+**System API**: This is a system API.
**Error codes**
-For details about the following error codes, see [Location Error Codes](../errorcodes/errorcode-geoLocationManager.md).
+For details about the error codes, see [Location Error Codes](../errorcodes/errorcode-geoLocationManager.md).
| ID| Error Message|
| -------- | ---------------------------------------- |
@@ -2011,7 +2170,7 @@ This API can be invoked only after [geoLocationManager.enableReverseGeocodingMoc
**System capability**: SystemCapability.Location.Location.Core
-**System API**: This is a system API and cannot be called by third-party applications.
+**System API**: This is a system API.
**Parameters**
@@ -2021,7 +2180,7 @@ This API can be invoked only after [geoLocationManager.enableReverseGeocodingMoc
**Error codes**
-For details about the following error codes, see [Location Error Codes](../errorcodes/errorcode-geoLocationManager.md).
+For details about the error codes, see [Location Error Codes](../errorcodes/errorcode-geoLocationManager.md).
| ID| Error Message|
| -------- | ---------------------------------------- |
@@ -2053,7 +2212,7 @@ isLocationPrivacyConfirmed(type: LocationPrivacyType): boolean;
Checks whether a user agrees with the privacy statement of the location service. This API can only be called by system applications.
-**System API**: This is a system API and cannot be called by third-party applications.
+**System API**: This is a system API.
**System capability**: SystemCapability.Location.Location.Core
@@ -2067,11 +2226,11 @@ Checks whether a user agrees with the privacy statement of the location service.
| Name| Type| Mandatory| Description|
| -------- | -------- | -------- | -------- |
- | boolean | boolean | NA | Callback used to return the result, which indicates whether the user agrees with the privacy statement.|
+ | boolean | boolean | NA | Whether the user agrees with the privacy statement.|
**Error codes**
-For details about the following error codes, see [Location Error Codes](../errorcodes/errorcode-geoLocationManager.md).
+For details about the error codes, see [Location Error Codes](../errorcodes/errorcode-geoLocationManager.md).
| ID| Error Message|
| -------- | ---------------------------------------- |
@@ -2095,7 +2254,7 @@ setLocationPrivacyConfirmStatus(type: LocationPrivacyType, isConfirmed: boolean)
Sets the user confirmation status for the privacy statement of the location service. This API can only be called by system applications.
-**System API**: This is a system API and cannot be called by third-party applications.
+**System API**: This is a system API.
**Required permissions**: ohos.permission.MANAGE_SECURE_SETTINGS
@@ -2106,11 +2265,11 @@ Sets the user confirmation status for the privacy statement of the location serv
| Name| Type| Mandatory| Description|
| -------- | -------- | -------- | -------- |
| type | [LocationPrivacyType](#locationprivacytype) | Yes| Privacy statement type, for example, privacy statement displayed in the startup wizard or privacy statement displayed when the location service is enabled.|
- | isConfirmed | boolean | Yes| Callback used to return the result, which indicates whether the user agrees with the privacy statement.|
+ | isConfirmed | boolean | Yes| Whether the user agrees with the privacy statement.|
**Error codes**
-For details about the following error codes, see [Location Error Codes](../errorcodes/errorcode-geoLocationManager.md).
+For details about the error codes, see [Location Error Codes](../errorcodes/errorcode-geoLocationManager.md).
| ID| Error Message|
| -------- | ---------------------------------------- |
@@ -2126,3 +2285,53 @@ For details about the following error codes, see [Location Error Codes](../error
console.error("errCode:" + err.code + ",errMessage:" + err.message);
}
```
+
+
+## geoLocationManager.getLocatingRequiredData10+
+
+getLocatingRequiredData(config: LocatingRequiredDataConfig): Promise<Array<LocatingRequiredData>>;
+
+Obtains the required data of the location service. This API uses a promise to return the result.
+
+**Required permissions**: ohos.permission.LOCATION and ohos.permission.APPROXIMATELY_LOCATION
+
+**System capability**: SystemCapability.Location.Location.Core
+
+**System API**: This is a system API.
+
+**Parameters**
+
+ | Name| Type| Mandatory| Description|
+ | -------- | -------- | -------- | -------- |
+ | config | [LocatingRequiredDataConfig](#locatingrequireddataconfig10) | Yes| Configuration for obtaining the required data of the location service.|
+
+**Return value**
+
+ | Name| Type| Mandatory| Description|
+ | -------- | -------- | -------- | -------- |
+ | Promise<Array<[LocatingRequiredData](#locatingrequireddata10)>> | [LocatingRequiredData](#locatingrequireddata10) | NA | Promise used to receive the required data of the location service, such as the Wi-Fi and Bluetooth scanning information.|
+
+**Error codes**
+
+For details about the error codes, see [Location Error Codes](../errorcodes/errorcode-geoLocationManager.md).
+
+| ID| Error Message|
+| -------- | ---------------------------------------- |
+|3301800 | Failed to start WiFi or Bluetooth scanning. |
+
+**Example**
+
+ ```ts
+ import geoLocationManager from '@ohos.geoLocationManager';
+ let config = {'type': 1, 'needStartScan': true, 'scanInterval': 10000};
+ try {
+ geoLocationManager.getLocatingRequiredData(config).then((result) => {
+ console.log('getLocatingRequiredData return: ' + JSON.stringify(result));
+ })
+ .catch((error) => {
+ console.log('promise, getLocatingRequiredData: error=' + JSON.stringify(error));
+ });
+ } catch (err) {
+ console.error("errCode:" + err.code + ",errMessage:" + err.message);
+ }
+ ```
diff --git a/en/application-dev/reference/apis/js-apis-hiappevent.md b/en/application-dev/reference/apis/js-apis-hiappevent.md
index e2ff3f6fa98d46577475cdaa86222b0eb3522b1f..ed0fdfc9c2f1a1d9e58683f19d11f7d2e9194f48 100644
--- a/en/application-dev/reference/apis/js-apis-hiappevent.md
+++ b/en/application-dev/reference/apis/js-apis-hiappevent.md
@@ -4,7 +4,7 @@ The **hiAppEvent** module provides the application event logging functions, such
> **NOTE**
>
-> - The APIs provided by this module are deprecated since API version 9. You are advised to use [`@ohos.hiviewdfx.hiAppEvent`](js-apis-hiviewdfx-hiappevent.md) instead.
+> - The APIs provided by this module are deprecated since API version 9. You are advised to use [`@ohos.hiviewdfx.hiAppEvent`](js-apis-hiviewdfx-hiappevent.md).
> - 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.
@@ -20,7 +20,7 @@ Before using application event logging, you need to understand the requirements
**Event Name**
-An event name is a string that contains a maximum of 48 characters, including digits (0 to 9), letters (a to z), and underscores (\_). It must start with a lowercase letter and cannot end with an underscore (\_).
+An event name is a string that contains a maximum of 48 characters, including digits (0 to 9), letters (a to z), and underscores (\_). It must start with a letter or dollar sign ($) and cannot end with an underscore (_).
**Event Type**
@@ -30,8 +30,8 @@ An event type is an enumerated value of [EventType](#eventtype).
An event parameter is an object in key-value pair format, where the key is the parameter name and the value is the parameter value. The requirements are as follows:
-- A parameter name is a string that contains a maximum of 16 characters, including digits (0 to 9), letters (a to z), and underscores (\_). It must start with a lowercase letter and cannot end with an underscore (\_).
-- The parameter value can be of the string, number, boolean, or array type.
+- A parameter name is a string that contains a maximum of 16 characters, including digits (0 to 9), letters (a to z), and underscores (\_). It must start with a letter or dollar sign ($) and cannot end with an underscore (_).
+- A parameter value can be of the string, number, boolean, or array type.
- If the parameter value is a string, its maximum length is 8*1024 characters. If this limit is exceeded, excess characters will be discarded.
- If the parameter value is a number, the value must be within the range of **Number.MIN_SAFE_INTEGER** to **Number.MAX_SAFE_INTEGER**. Otherwise, uncertain values may be generated.
- If the parameter value is an array, the elements in the array must be of the same type, which can only be string, number, or boolean. In addition, the number of elements must be less than 100. If this limit is exceeded, excess elements will be discarded.
@@ -156,12 +156,12 @@ Provides the configuration items for application event logging.
| Name | Type | Mandatory| Description |
| ---------- | ------- | ---- | ------------------------------------------------------------ |
| disable | boolean | No | Application event logging switch. The value **true** means to disable the application event logging function, and the value **false** means the opposite.|
-| maxStorage | string | No | Maximum size of the event file storage directory. The default value is 10M . If the specified size is exceeded, the oldest event logging files in the directory will be deleted to free up space.|
+| maxStorage | string | No | Maximum size of the event file storage directory. The default value is **10M**. If the specified size is exceeded, the oldest event logging files in the directory will be deleted to free up space.|
## EventType
-Enumerates event types.
+Enumerates the event types.
**System capability**: SystemCapability.HiviewDFX.HiAppEvent
diff --git a/en/application-dev/reference/apis/js-apis-hidebug.md b/en/application-dev/reference/apis/js-apis-hidebug.md
index 896cee276b582a87806745accf135f74a38c057a..7eee03067795a058c83cfaac77e97cb26fbb4dfe 100644
--- a/en/application-dev/reference/apis/js-apis-hidebug.md
+++ b/en/application-dev/reference/apis/js-apis-hidebug.md
@@ -175,23 +175,30 @@ Obtains system service information.
```js
import fs from '@ohos.file.fs'
import hidebug from '@ohos.hidebug'
-import featureAbility from '@ohos.ability.featureAbility'
-
-let context = featureAbility.getContext();
-context.getFilesDir().then((data) => {
- var path = data + "/serviceInfo.txt";
- console.info("output path: " + path);
- let file = fs.openSync(path, fs.OpenMode.READ_WRITE | fs.OpenMode.CREATE);
- var serviceId = 10;
- var args = new Array("allInfo");
- try {
- hidebug.getServiceDump(serviceId, file.fd, args);
- } catch (error) {
- console.info(error.code);
- console.info(error.message);
- }
- fs.closeSync(file);
-})
+import common from '@ohos.app.ability.common'
+
+let applicationContext: common.Context;
+try {
+ applicationContext = this.context.getApplicationContext();
+} catch (error) {
+ console.info(error.code);
+ console.info(error.message);
+}
+
+var filesDir = applicationContext.filesDir;
+var path = filesDir + "/serviceInfo.txt";
+console.info("output path: " + path);
+let file = fs.openSync(path, fs.OpenMode.READ_WRITE | fs.OpenMode.CREATE);
+var serviceId = 10;
+var args = new Array("allInfo");
+
+try {
+ hidebug.getServiceDump(serviceId, file.fd, args);
+} catch (error) {
+ console.info(error.code);
+ console.info(error.message);
+}
+fs.closeSync(file);
```
## hidebug.startJsCpuProfiling9+
diff --git a/en/application-dev/reference/apis/js-apis-hiviewdfx-hiappevent.md b/en/application-dev/reference/apis/js-apis-hiviewdfx-hiappevent.md
index 03cad26cfecb5295b611d48fbc9f69862895ddb0..41d5566ed0ffaa6a9327f3da04e2c92c6a31465b 100644
--- a/en/application-dev/reference/apis/js-apis-hiviewdfx-hiappevent.md
+++ b/en/application-dev/reference/apis/js-apis-hiviewdfx-hiappevent.md
@@ -122,10 +122,10 @@ Defines parameters for an **AppEventInfo** object.
| Name | Type | Mandatory| Description |
| --------- | ----------------------- | ---- | ------------------------------------------------------------ |
-| domain | string | Yes | Event domain. Event domain name, which is a string of up to 32 characters, including digits (0 to 9), letters (a to z), and underscores (\_). It must start with a lowercase letter and cannot end with an underscore (_).|
-| name | string | Yes | Event name. Event name, which is a string of up to 48 characters, including digits (0 to 9), letters (a to z), and underscores (\_). It must start with a lowercase letter and cannot end with an underscore (_).|
+| domain | string | Yes | Event domain. The value is a string of up to 32 characters, including digits (0 to 9), letters (a to z), and underscores (\_). It must start with a lowercase letter and cannot end with an underscore (_).|
+| name | string | Yes | Event name. The value is a string of up to 48 characters, including digits (0 to 9), letters (a to z), and underscores (\_). It must start with a lowercase letter or dollar sign ($) and cannot end with an underscore (_).|
| eventType | [EventType](#eventtype) | Yes | Event type. |
-| params | object | Yes | Event parameter object, which consists of a parameter name and a parameter value. The specifications are as follows:10+
+### requestInStream10+
-request2(url: string, callback: AsyncCallback\): void
+requestInStream(url: string, callback: AsyncCallback\): void
Initiates an HTTP request containing specified options to a given URL. This API uses an asynchronous callback to return the result, which is a streaming response.
@@ -424,18 +424,18 @@ Initiates an HTTP request containing specified options to a given URL. This API
**Example**
```js
-httpRequest.request2("EXAMPLE_URL", (err, data) => {
+httpRequest.requestInStream("EXAMPLE_URL", (err, data) => {
if (!err) {
- console.info("request2 OK! ResponseCode is " + JSON.stringify(data));
+ console.info("requestInStream OK! ResponseCode is " + JSON.stringify(data));
} else {
- console.info("request2 ERROR : err = " + JSON.stringify(err));
+ console.info("requestInStream ERROR : err = " + JSON.stringify(err));
}
})
```
-### request210+
+### requestInStream10+
-request2(url: string, options: HttpRequestOptions, callback: AsyncCallback\): void
+requestInStream(url: string, options: HttpRequestOptions, callback: AsyncCallback\): void
Initiates an HTTP request containing specified options to a given URL. This API uses an asynchronous callback to return the result, which is a streaming response.
@@ -494,7 +494,7 @@ Initiates an HTTP request containing specified options to a given URL. This API
**Example**
```js
-httpRequest.request2("EXAMPLE_URL",
+httpRequest.requestInStream("EXAMPLE_URL",
{
method: http.RequestMethod.GET,
header: {
@@ -504,16 +504,16 @@ httpRequest.request2("EXAMPLE_URL",
connectTimeout: 60000
}, (err, data) => {
if (!err) {
- console.info("request2 OK! ResponseCode is " + JSON.stringify(data));
+ console.info("requestInStream OK! ResponseCode is " + JSON.stringify(data));
} else {
- console.info("request2 ERROR : err = " + JSON.stringify(err));
+ console.info("requestInStream ERROR : err = " + JSON.stringify(err));
}
})
```
-### request210+
+### requestInStream10+
-request2(url: string, options? : HttpRequestOptions): Promise\
+requestInStream(url: string, options? : HttpRequestOptions): Promise\
Initiates an HTTP request containing specified options to a given URL. This API uses a promise to return the result, which is a streaming response.
@@ -577,7 +577,7 @@ Initiates an HTTP request containing specified options to a given URL. This API
**Example**
```js
-let promise = httpRequest.request2("EXAMPLE_URL", {
+let promise = httpRequest.requestInStream("EXAMPLE_URL", {
method: http.RequestMethod.GET,
connectTimeout: 60000,
readTimeout: 60000,
@@ -586,9 +586,9 @@ let promise = httpRequest.request2("EXAMPLE_URL", {
}
});
promise.then((data) => {
- console.info("request2 OK!" + JSON.stringify(data));
+ console.info("requestInStream OK!" + JSON.stringify(data));
}).catch((err) => {
- console.info("request2 ERROR : err = " + JSON.stringify(err));
+ console.info("requestInStream ERROR : err = " + JSON.stringify(err));
});
```
@@ -815,9 +815,9 @@ Unregisters the observer for events indicating completion of receiving HTTP stre
httpRequest.off('dataEnd');
```
-### on('dataProgress')10+
+### on('dataReceiveProgress')10+
-on(type: 'dataProgress', callback: Callback\<{ receiveSize: number, totalSize: number }\>): void
+on(type: 'dataReceiveProgress', callback: Callback\<{ receiveSize: number, totalSize: number }\>): void
Registers an observer for events indicating progress of receiving HTTP streaming responses.
@@ -830,20 +830,20 @@ Registers an observer for events indicating progress of receiving HTTP streaming
| Name | Type | Mandatory| Description |
| -------- | ----------------------- | ---- | --------------------------------- |
-| type | string | Yes | Event type. The value is **dataProgress**.|
+| type | string | Yes | Event type. The value is **dataReceiveProgress**.|
| callback | AsyncCallback\<{ receiveSize: number, totalSize: number }\> | Yes | Callback used to return the result.10+
+### off('dataReceiveProgress')10+
-off(type: 'dataProgress', callback?: Callback\<{ receiveSize: number, totalSize: number }\>): void
+off(type: 'dataReceiveProgress', callback?: Callback\<{ receiveSize: number, totalSize: number }\>): void
Unregisters the observer for events indicating progress of receiving HTTP streaming responses.
@@ -856,13 +856,13 @@ Unregisters the observer for events indicating progress of receiving HTTP stream
| Name | Type | Mandatory| Description |
| -------- | ------------------ | ---- | -------------------------------------- |
-| type | string | Yes | Event type. The value is **dataProgress**.|
+| type | string | Yes | Event type. The value is **dataReceiveProgress**.|
| callback | Callback\<{ receiveSize: number, totalSize: number }\> | No | Callback used to return the result. |
**Example**
```js
-httpRequest.off('dataProgress');
+httpRequest.off('dataReceiveProgress');
```
## HttpRequestOptions6+
diff --git a/en/application-dev/reference/apis/js-apis-inner-application-MediaControlExtensionContext.md b/en/application-dev/reference/apis/js-apis-inner-application-MediaControlExtensionContext.md
new file mode 100644
index 0000000000000000000000000000000000000000..8bddcb5adb58f3968494957ae8fd494fbe5c7467
--- /dev/null
+++ b/en/application-dev/reference/apis/js-apis-inner-application-MediaControlExtensionContext.md
@@ -0,0 +1,11 @@
+# MediaControlExtensionContext (ExtensionAbility Context for Media Playback Control)
+
+**MediaControlExtensionContext**, inherited from [UIExtensionContext](js-apis-inner-application-uiExtensionContext.md), provides the context environment for [MediaControlExtensionAbility](js-apis-app-ability-MediaControlExtensionAbility.md). It provides MediaControlExtensionAbility-related configuration and APIs for operating the MediaControlExtensionAbility. For example, you can use the APIs to start a MediaControlExtensionAbility.
+
+**System capability**: SystemCapability.Multimedia.AVSession.Core
+
+> **NOTE**
+>
+> - The initial APIs of this module are supported since API version 10. Newly added APIs will be marked with a superscript to indicate their earliest API version.
+> - The APIs of this module can be used only in the stage model.
+> - The APIs provided by this module are system APIs.
diff --git a/en/application-dev/reference/apis/js-apis-matrix4.md b/en/application-dev/reference/apis/js-apis-matrix4.md
index 67864b311bd4fbf30b87e17abb84db12e24889be..7aea13609e2d96615d36668eddbd275960916133 100644
--- a/en/application-dev/reference/apis/js-apis-matrix4.md
+++ b/en/application-dev/reference/apis/js-apis-matrix4.md
@@ -27,7 +27,7 @@ Matrix constructor, which is used to create a 4 x 4 matrix by using the input pa
| Name| Type | Mandatory| Description |
| ------ | ------------------------------------------------------------ | ---- | ------------------------------------------------------------ |
-| option | [number,number,number,number,10+ | number \| string \| [Resource](../arkui-ts/ts-types.md#resource) | No | Layout width of the measured text.10+ | number \| [TextAlign](../arkui-ts/ts-appendix-enums.md#textalign) | No | Horizontal alignment mode of the measured text.** component can be used to render and display local and online images.
+> - This API is deprecated since API version 9. You are advised to use the **\<[Image](../arkui-ts/ts-basic-components-image.md)>** component instead. ** component can be used to render and display local and online images.
**System capability**: SystemCapability.Multimedia.MediaLibrary.Core
@@ -771,7 +778,7 @@ Starts image preview, with the first image to preview specified. This API can be
| Name | Type | Mandatory | Description |
| -------- | ------------------------- | ---- | ---------------------------------------- |
-| images | Array<string> | Yes | URIs of the images to preview. The value can start with either **'https://'** or **'datashare://'**.|
+| images | Array<string> | Yes | Images to preview. You can preview a local image (**file://**) or all online images (**https://**).|
| index | number | Yes | Index of the first image to preview. |
| callback | AsyncCallback<void> | Yes | Callback that returns no value. |
@@ -802,12 +809,12 @@ mediaLibrary.getMediaLibrary().startImagePreview(images, index, (error) => {
startImagePreview(images: Array<string>, callback: AsyncCallback<void>): void
-Starts image preview. This API can be used to preview local images whose URIs start with **datashare://** or online images whose URIs start with **https://**. It uses an asynchronous callback to return the result.
+Starts image preview. This API can be used to preview the first local image (**file://**) or all online images (**https://**). It uses an asynchronous callback to return the result.
> **NOTE**
>
> - This API is supported since API version 6 and can be used only in the FA model.
-> - This API is deprecated since API Version 9. You are advised to use the **\<[Image](../arkui-ts/ts-basic-components-image.md)>** component instead. ** component can be used to render and display local and online images.
+> - This API is deprecated since API version 9. You are advised to use the **\<[Image](../arkui-ts/ts-basic-components-image.md)>** component instead. ** component can be used to render and display local and online images.
**System capability**: SystemCapability.Multimedia.MediaLibrary.Core
@@ -815,7 +822,7 @@ Starts image preview. This API can be used to preview local images whose URIs st
| Name | Type | Mandatory | Description |
| -------- | ------------------------- | ---- | ---------------------------------------- |
-| images | Array<string> | Yes | URIs of the images to preview. The value can start with either **'https://'** or **'datashare://'**.|
+| images | Array<string> | Yes | Images to preview. You can preview a local image (**file://**) or all online images (**https://**).|
| callback | AsyncCallback<void> | Yes | Callback that returns no value. |
**Example**
@@ -844,12 +851,12 @@ mediaLibrary.getMediaLibrary().startImagePreview(images, (error) => {
startImagePreview(images: Array<string>, index?: number): Promise<void>
-Starts image preview, with the first image to preview specified. This API can be used to preview local images whose URIs start with **datashare://** or online images whose URIs start with **https://**. It uses a promise to return the execution result.
+Starts image preview, with the first image to preview specified. This API can be used to preview a local image with the specified index (**file://**) or all online images (**https://**). It uses a promise to return the execution result.
> **NOTE**
>
> - This API is supported since API version 6 and can be used only in the FA model.
-> - This API is deprecated since API Version 9. You are advised to use the **\<[Image](../arkui-ts/ts-basic-components-image.md)>** component instead. ** component can be used to render and display local and online images.
+> - This API is deprecated since API version 9. You are advised to use the **\<[Image](../arkui-ts/ts-basic-components-image.md)>** component instead. ** component can be used to render and display local and online images.
**System capability**: SystemCapability.Multimedia.MediaLibrary.Core
@@ -857,7 +864,7 @@ Starts image preview, with the first image to preview specified. This API can be
| Name | Type | Mandatory | Description |
| ------ | ------------------- | ---- | ---------------------------------------- |
-| images | Array<string> | Yes | URIs of the images to preview. The value can start with either **'https://'** or **'datashare://'**.|
+| images | Array<string> | Yes | Images to preview. You can preview a local image (**file://**) or all online images (**https://**).|
| index | number | No | Index of the first image to preview. If this parameter is not specified, the default value **0** is used. |
**Return value**
@@ -896,7 +903,7 @@ Starts media selection. This API uses an asynchronous callback to return the URI
> **NOTE**
>
> - This API is supported since API version 6 and can be used only in the FA model.
-> - This API is deprecated since API Version 9. Use [select](js-apis-file-picker.md#select-1) instead.
+> - This API is deprecated since API version 9. Use [select](js-apis-file-picker.md#select-1) instead.
**System capability**: SystemCapability.Multimedia.MediaLibrary.Core
@@ -933,7 +940,7 @@ Starts media selection. This API uses a promise to return the URIs of the select
> **NOTE**
>
> - This API is supported since API version 6 and can be used only in the FA model.
-> - This API is deprecated since API Version 9. Use [select](js-apis-file-picker.md#select) instead.
+> - This API is deprecated since API version 9. Use [select](js-apis-file-picker.md#select) instead.
**System capability**: SystemCapability.Multimedia.MediaLibrary.Core
@@ -971,7 +978,8 @@ getActivePeers(): Promise\>;
Obtains information about online peer devices. This API uses a promise to return the result.
> **NOTE**
-> This API is deprecated since API Version 9. There is no substitute API.
+>
+> This API is deprecated since API version 9. There is no substitute API.
**System API**: This is a system API.
@@ -1008,7 +1016,8 @@ getActivePeers(callback: AsyncCallback\>): void;
Obtains information about online peer devices. This API uses an asynchronous callback to return the result.
> **NOTE**
-> This API is deprecated since API Version 9. There is no substitute API.
+>
+> This API is deprecated since API version 9. There is no substitute API.
**System API**: This is a system API.
@@ -1043,7 +1052,8 @@ getAllPeers(): Promise\>;
Obtains information about all peer devices. This API uses a promise to return the result.
> **NOTE**
-> This API is deprecated since API Version 9. There is no substitute API.
+>
+> This API is deprecated since API version 9. There is no substitute API.
**System API**: This is a system API.
@@ -1080,7 +1090,8 @@ getAllPeers(callback: AsyncCallback\>): void;
Obtains information about all peer devices. This API uses an asynchronous callback to return the result.
> **NOTE**
-> This API is deprecated since API Version 9. There is no substitute API.
+>
+> This API is deprecated since API version 9. There is no substitute API.
**System API**: This is a system API.
@@ -1116,7 +1127,7 @@ Provides APIs for encapsulating file asset attributes.
>
> - The system attempts to parse the file content if the file is an audio or video file. The actual field values will be restored from the passed values during scanning on some devices.
> - Some devices may not support the modification of **orientation**. You are advised to use [ModifyImageProperty](js-apis-image.md#modifyimageproperty9) of the **image** module.
-> - This API is deprecated since API Version 9. Use [PhotoAsset](js-apis-photoAccessHelper.md#photoasset) instead.
+> - This API is deprecated since API version 9. Use [PhotoAsset](js-apis-photoAccessHelper.md#photoasset) instead.
### Attributes
@@ -1153,7 +1164,8 @@ isDirectory(callback: AsyncCallback<boolean>): void
Checks whether this file asset is a directory. This API uses an asynchronous callback to return the result.
> **NOTE**
-> This API is deprecated since API Version 9. There is no substitute API.
+>
+> This API is deprecated since API version 9. There is no substitute API.
**Required permissions**: ohos.permission.READ_MEDIA
@@ -1196,7 +1208,8 @@ isDirectory():Promise<boolean>
Checks whether this file asset is a directory. This API uses a promise to return the result.
> **NOTE**
-> This API is deprecated since API Version 9. There is no substitute API.
+>
+> This API is deprecated since API version 9. There is no substitute API.
**Required permissions**: ohos.permission.READ_MEDIA
@@ -1238,7 +1251,7 @@ Commits the modification on the file metadata to the database. This API uses an
> **NOTE**
>
-> - This API is deprecated since API Version 9. Use [commitModify](js-apis-photoAccessHelper.md#commitmodify) instead.
+> - This API is deprecated since API version 9. Use [commitModify](js-apis-photoAccessHelper.md#commitmodify) instead.
> - Since the SDK of API version 10, **audio** does not have the **orientation** attribute. Therefore, the **orientation** attribute of the audio resource cannot be modified by **commitModify()**. For details, see [changelogs-mediaLibrary.md](../../../release-notes/changelogs/OpenHarmony_4.0.8.2/changelogs-mediaLibrary.md).
**Required permissions**: ohos.permission.READ_MEDIA and ohos.permission.WRITE_MEDIA
@@ -1280,7 +1293,7 @@ Commits the modification on the file asset to the database. This API uses a prom
> **NOTE**
>
-> - This API is deprecated since API Version 9. Use [commitModify](js-apis-photoAccessHelper.md#commitmodify-1) instead.
+> - This API is deprecated since API version 9. Use [commitModify](js-apis-photoAccessHelper.md#commitmodify-1) instead.
> Since the SDK of API version 10, **audio** does not have the **orientation** attribute. Therefore, the **orientation** attribute of the audio resource cannot be modified by **commitModify()**. For details, see [changelogs-mediaLibrary.md](../../../release-notes/changelogs/OpenHarmony_4.0.8.2/changelogs-mediaLibrary.md).
**Required permissions**: ohos.permission.READ_MEDIA and ohos.permission.WRITE_MEDIA
@@ -1319,9 +1332,11 @@ open(mode: string, callback: AsyncCallback<number>): void
Opens this file asset. This API uses an asynchronous callback to return the result.
> **NOTE**
-> This API is deprecated since API Version 9. Use [open](js-apis-photoAccessHelper.md#open) instead.
-
-**NOTE**7+
@@ -2000,7 +2030,8 @@ getCount(): number
Obtains the total number of files in the result set.
> **NOTE**
-> This API is deprecated since API Version 9. Use [getCount](js-apis-photoAccessHelper.md#getcount) instead.
+>
+> This API is deprecated since API version 9. Use [getCount](js-apis-photoAccessHelper.md#getcount) instead.
**System capability**: SystemCapability.Multimedia.MediaLibrary.Core
@@ -2035,7 +2066,8 @@ isAfterLast(): boolean
Checks whether the cursor is in the last row of the result set.
> **NOTE**
-> This API is deprecated since API Version 9. Use [isAfterLast](js-apis-photoAccessHelper.md#isafterlast) instead.
+>
+> This API is deprecated since API version 9. Use [isAfterLast](js-apis-photoAccessHelper.md#isafterlast) instead.
**System capability**: SystemCapability.Multimedia.MediaLibrary.Core
@@ -2078,7 +2110,8 @@ close(): void
Releases and invalidates this **FetchFileResult** instance. After this instance is released, the APIs in this instance cannot be invoked.
> **NOTE**
-> This API is deprecated since API Version 9. Use [close](js-apis-photoAccessHelper.md#close) instead.
+>
+> This API is deprecated since API version 9. Use [close](js-apis-photoAccessHelper.md#close) instead.
**System capability**: SystemCapability.Multimedia.MediaLibrary.Core
@@ -2105,7 +2138,8 @@ getFirstObject(callback: AsyncCallback<FileAsset>): void
Obtains the first file asset in the result set. This API uses an asynchronous callback to return the result.
> **NOTE**
-> This API is deprecated since API Version 9. Use [getFirstObject](js-apis-photoAccessHelper.md#getfirstobject) instead.
+>
+> This API is deprecated since API version 9. Use [getFirstObject](js-apis-photoAccessHelper.md#getfirstobject) instead.
**System capability**: SystemCapability.Multimedia.MediaLibrary.Core
@@ -2145,7 +2179,8 @@ getFirstObject(): Promise<FileAsset>
Obtains the first file asset in the result set. This API uses a promise to return the result.
> **NOTE**
-> This API is deprecated since API Version 9. Use [getFirstObject](js-apis-photoAccessHelper.md#getfirstobject-1) instead.
+>
+> This API is deprecated since API version 9. Use [getFirstObject](js-apis-photoAccessHelper.md#getfirstobject-1) instead.
**System capability**: SystemCapability.Multimedia.MediaLibrary.Core
@@ -2185,7 +2220,7 @@ Obtains the next file asset in the result set. This API uses an asynchronous cal
> **NOTE**
>
> - Before using this API, you must use [getFirstObject](#getfirstobject7) to obtain the first file asset and then use [isAfterLast](#isafterlast7) to check that the cursor does not point to the last file asset in the result set.
-> - This API is deprecated since API Version 9. Use [getNextObject](js-apis-photoAccessHelper.md#getnextobject) instead.
+> - This API is deprecated since API version 9. Use [getNextObject](js-apis-photoAccessHelper.md#getnextobject) instead.
**System capability**: SystemCapability.Multimedia.MediaLibrary.Core
@@ -2232,7 +2267,7 @@ Obtains the next file asset in the result set. This API uses a promise to return
> **NOTE**
>
> - Before using this API, you must use [getFirstObject](#getfirstobject7) to obtain the first file asset and then use [isAfterLast](#isafterlast7) to check that the cursor does not point to the last file asset in the result set.
-> - This API is deprecated since API Version 9. Use [getNextObject](js-apis-photoAccessHelper.md#getnextobject-1) instead.
+> - This API is deprecated since API version 9. Use [getNextObject](js-apis-photoAccessHelper.md#getnextobject-1) instead.
**System capability**: SystemCapability.Multimedia.MediaLibrary.Core
@@ -2274,7 +2309,8 @@ getLastObject(callback: AsyncCallback<FileAsset>): void
Obtains the last file asset in the result set. This API uses an asynchronous callback to return the result.
> **NOTE**
-> This API is deprecated since API Version 9. Use [getLastObject](js-apis-photoAccessHelper.md#getlastobject) instead.
+>
+> This API is deprecated since API version 9. Use [getLastObject](js-apis-photoAccessHelper.md#getlastobject) instead.
**System capability**: SystemCapability.Multimedia.MediaLibrary.Core
@@ -2314,7 +2350,8 @@ getLastObject(): Promise<FileAsset>
Obtains the last file asset in the result set. This API uses a promise to return the result.
> **NOTE**
-> This API is deprecated since API Version 9. Use [getLastObject](js-apis-photoAccessHelper.md#getlastobject-1) instead.
+>
+> This API is deprecated since API version 9. Use [getLastObject](js-apis-photoAccessHelper.md#getlastobject-1) instead.
**System capability**: SystemCapability.Multimedia.MediaLibrary.Core
@@ -2352,7 +2389,8 @@ getPositionObject(index: number, callback: AsyncCallback<FileAsset>): void
Obtains a file asset with the specified index in the result set. This API uses an asynchronous callback to return the result.
> **NOTE**
-> This API is deprecated since API Version 9. Use [getObjectByPosition](js-apis-photoAccessHelper.md#getobjectbyposition) instead.
+>
+> This API is deprecated since API version 9. Use [getObjectByPosition](js-apis-photoAccessHelper.md#getobjectbyposition) instead.
**System capability**: SystemCapability.Multimedia.MediaLibrary.Core
@@ -2393,7 +2431,8 @@ getPositionObject(index: number): Promise<FileAsset>
Obtains a file asset with the specified index in the result set. This API uses a promise to return the result.
> **NOTE**
-> This API is deprecated since API Version 9. Use [getObjectByPosition](js-apis-photoAccessHelper.md#getobjectbyposition-1) instead.
+>
+> This API is deprecated since API version 9. Use [getObjectByPosition](js-apis-photoAccessHelper.md#getobjectbyposition-1) instead.
**System capability**: SystemCapability.Multimedia.MediaLibrary.Core
@@ -2437,7 +2476,8 @@ getAllObject(callback: AsyncCallback<Array<FileAsset>>): void
Obtains all the file assets in the result set. This API uses an asynchronous callback to return the result.
> **NOTE**
-> This API is deprecated since API Version 9. Use [getAllObjects](js-apis-photoAccessHelper.md#getallobjects) instead.
+>
+> This API is deprecated since API version 9. Use [getAllObjects](js-apis-photoAccessHelper.md#getallobjects) instead.
**System capability**: SystemCapability.Multimedia.MediaLibrary.Core
@@ -2479,7 +2519,8 @@ getAllObject(): Promise<Array<FileAsset>>
Obtains all the file assets in the result set. This API uses a promise to return the result.
> **NOTE**
-> This API is deprecated since API Version 9. Use [getAllObjects](js-apis-photoAccessHelper.md#getallobjects-1) instead.
+>
+> This API is deprecated since API version 9. Use [getAllObjects](js-apis-photoAccessHelper.md#getallobjects-1) instead.
**System capability**: SystemCapability.Multimedia.MediaLibrary.Core
@@ -2517,7 +2558,8 @@ async function example() {
Provides APIs to manage albums.
> **NOTE**
-> This API is deprecated since API Version 9. Use [Album](js-apis-photoAccessHelper.md#album) instead.
+>
+> This API is deprecated since API version 9. Use [Album](js-apis-photoAccessHelper.md#album) instead.
### Attributes
@@ -2540,7 +2582,8 @@ commitModify(callback: AsyncCallback<void>): void
Commits the modification on the album attributes to the database.
> **NOTE**
-> This API is deprecated since API Version 9. Use [commitModify](js-apis-photoAccessHelper.md#commitmodify-2) instead.
+>
+> This API is deprecated since API version 9. Use [commitModify](js-apis-photoAccessHelper.md#commitmodify-2) instead.
**Required permissions**: ohos.permission.READ_MEDIA and ohos.permission.WRITE_MEDIA
@@ -2581,7 +2624,8 @@ commitModify(): Promise<void>
Commits the modification on the album attributes to the database.
> **NOTE**
-> This API is deprecated since API Version 9. Use [commitModify](js-apis-photoAccessHelper.md#commitmodify-3) instead.
+>
+> This API is deprecated since API version 9. Use [commitModify](js-apis-photoAccessHelper.md#commitmodify-3) instead.
**Required permissions**: ohos.permission.READ_MEDIA and ohos.permission.WRITE_MEDIA
@@ -2620,7 +2664,8 @@ getFileAssets(callback: AsyncCallback<FetchFileResult>): void
Obtains the file assets in this album. This API uses an asynchronous callback to return the result.
> **NOTE**
-> This API is deprecated since API Version 9. Use [getAssets](js-apis-photoAccessHelper.md#getassets) instead.
+>
+> This API is deprecated since API version 9. Use [getAssets](js-apis-photoAccessHelper.md#getassets) instead.
**Required permissions**: ohos.permission.READ_MEDIA
@@ -2664,7 +2709,8 @@ getFileAssets(options: MediaFetchOptions, callback: AsyncCallback<FetchFileRe
Obtains the file assets in this album based on specified conditions. This API uses an asynchronous callback to return the result.
> **NOTE**
-> This API is deprecated since API Version 9. Use [getAssets](js-apis-photoAccessHelper.md#getassets) instead.
+>
+> This API is deprecated since API version 9. Use [getAssets](js-apis-photoAccessHelper.md#getassets) instead.
**Required permissions**: ohos.permission.READ_MEDIA
@@ -2713,7 +2759,8 @@ async function example() {
Obtains the file assets in this album based on specified conditions. This API uses a promise to return the result.
> **NOTE**
-> This API is deprecated since API Version 9. Use [getAssets](js-apis-photoAccessHelper.md#getassets-1) instead.
+>
+> This API is deprecated since API version 9. Use [getAssets](js-apis-photoAccessHelper.md#getassets-1) instead.
**Required permissions**: ohos.permission.READ_MEDIA
@@ -2763,7 +2810,8 @@ async function example() {
Defines information about a registered device.
> **NOTE**
-> This API is deprecated since API Version 9. There is no substitute API.
+>
+> This API is deprecated since API version 9. There is no substitute API.
**System API**: This is a system API.
@@ -2781,7 +2829,8 @@ Defines information about a registered device.
Enumerates media types.
> **NOTE**
-> This API is deprecated since API Version 9. Use [PhotoType](js-apis-photoAccessHelper.md#phototype) instead.
+>
+> This API is deprecated since API version 9. Use [PhotoType](js-apis-photoAccessHelper.md#phototype) instead.
**System capability**: SystemCapability.Multimedia.MediaLibrary.Core
@@ -2799,7 +2848,7 @@ Enumerates key file information.
> **NOTE**
>
> - The **bucket_id** field may change after file rename or movement. Therefore, you must obtain the field again before using it.
-> - This API is deprecated since API Version 9. Use [PhotoKeys](js-apis-photoAccessHelper.md#photokeys) instead.
+> - This API is deprecated since API version 9. Use [PhotoKeys](js-apis-photoAccessHelper.md#photokeys) instead.
**System capability**: SystemCapability.Multimedia.MediaLibrary.Core
@@ -2830,7 +2879,8 @@ Enumerates key file information.
Enumerates directory types.
> **NOTE**
-> This API is deprecated since API Version 9. There is no substitute API.
+>
+> This API is deprecated since API version 9. There is no substitute API.
**System capability**: SystemCapability.Multimedia.MediaLibrary.Core
@@ -2848,7 +2898,8 @@ Enumerates directory types.
Enumerates the device types.
> **NOTE**
-> This API is deprecated since API Version 9. There is no substitute API.
+>
+> This API is deprecated since API version 9. There is no substitute API.
**System API**: This is a system API.
@@ -2869,15 +2920,16 @@ Enumerates the device types.
Defines the options for fetching media files.
> **NOTE**
-> This API is deprecated since API Version 9. Use [FetchOptions](js-apis-photoAccessHelper.md#fetchoptions) instead.
+>
+> This API is deprecated since API version 9. Use [FetchOptions](js-apis-photoAccessHelper.md#fetchoptions) instead.
**System capability**: SystemCapability.Multimedia.MediaLibrary.Core
| Name | Type | Readable| Writable| Description |
| ----------------------- | ------------------- | ---- | ---- | ------------------------------------------------------------ |
-| selections | string | Yes | Yes | Conditions for fetching files. The enumerated values in [FileKey](#filekey8) are used as the column names when files are fetched. Example:8+ | string | Yes | Yes | URI of the file. |
| networkId8+ | string | Yes | Yes | Network ID of the registered device. |
| extendArgs8+ | string | Yes | Yes | Extended parameters for fetching the files. Currently, no extended parameters are available. |
@@ -2887,7 +2939,8 @@ Defines the options for fetching media files.
Defines the image size.
> **NOTE**
-> This API is deprecated since API Version 9. Use [image.Size](js-apis-image.md#size) instead.
+>
+> This API is deprecated since API version 9. Use [image.Size](js-apis-image.md#size) instead.
**System capability**: SystemCapability.Multimedia.MediaLibrary.Core
@@ -2901,26 +2954,28 @@ Defines the image size.
Defines the media asset option.
> **NOTE**
-> This API is deprecated since API Version 9. There is no substitute API.
+>
+> This API is deprecated since API version 9. There is no substitute API.
**System capability**: SystemCapability.Multimedia.MediaLibrary.Core
| Name | Type | Readable| Writable| Description |
| ------------ | ------ | ---- | ---- | ------------------------------------------------------------ |
| src | string | Yes | Yes | Application sandbox oath of the local file. |
-| mimeType | string | Yes | Yes | Multipurpose Internet Mail Extensions (MIME) type of the media. | Yes | Callback used to return the result. If the global HTTP proxy configuration of the network is set successfully, **error** is **undefined**. Otherwise, **error** is an error object.|
**Error codes**
@@ -274,7 +274,7 @@ Sets the global HTTP proxy configuration of the network. This API uses a promise
| Name | Type | Mandatory| Description |
| --------- | ------------------------------------------------------------ | ---- | ---------------- |
-| httpProxy | [HttpProxy](#httpproxy) | Yes | Global HTTP proxy configuration of the network.|
+| httpProxy | [HttpProxy](#httpproxy10) | Yes | Global HTTP proxy configuration of the network.|
**Return value**
@@ -324,7 +324,7 @@ This API uses an asynchronous callback to return the result.
| Name | Type | Mandatory| Description |
| -------- | -------------------------------------- | ---- | ------------------------------------------------------------ |
-| callback | AsyncCallback<[HttpProxy](#httpproxy)> | Yes | Callback used to return the result. If the global HTTP proxy configuration of the network is obtained successfully, **error** is **undefined** and **data** is the global HTTP proxy configuration. Otherwise, **error** is an error object.|
+| callback | AsyncCallback<[HttpProxy](#httpproxy10)> | Yes | Callback used to return the result. If the global HTTP proxy configuration of the network is obtained successfully, **error** is **undefined** and **data** is the global HTTP proxy configuration. Otherwise, **error** is an error object.|
**Error codes**
@@ -347,7 +347,7 @@ connection.getDefaultHttpProxy((error, data) => {
getDefaultHttpProxy(): Promise\;
Obtains the default proxy configuration of the network.
-If the global proxy is set, the global proxy configuration is returned. If [setAppNet](#connectionsetappnet) is used to bind the application to the network specified by [NetHandle](#nethandle), the proxy configuration of this network is returned. In other cases, the HTTP proxy configuration of the default network is returned.
+If the global proxy is set, the global HTTP proxy configuration is returned. If [setAppNet](#connectionsetappnet) is used to bind the application to the network specified by [NetHandle](#nethandle), the HTTP proxy configuration of this network is returned. In other cases, the HTTP proxy configuration of the default network is returned.
This API uses a promise to return the result.
**System capability**: SystemCapability.Communication.NetManager.Core
@@ -356,7 +356,7 @@ This API uses a promise to return the result.
| Type | Description |
| -------------------------------- | ----------------------------------------- |
-| Promise<[HttpProxy](#httpproxy)> | Promise used to return the result.|
+| Promise<[HttpProxy](#httpproxy10)> | Promise used to return the result.|
**Error codes**
diff --git a/en/application-dev/reference/apis/js-apis-net-ethernet.md b/en/application-dev/reference/apis/js-apis-net-ethernet.md
index 21fdb44e402a4a0cb4a6f39d883522ab84513217..e7aae4ef5ef646af82499c8d3fdfd2bfd53cf905 100644
--- a/en/application-dev/reference/apis/js-apis-net-ethernet.md
+++ b/en/application-dev/reference/apis/js-apis-net-ethernet.md
@@ -486,7 +486,7 @@ Defines the network configuration for the Ethernet connection.
| gateway | string | Yes| Gateway of the Ethernet connection. The value must be an IPv4 address, which is a 32-bit number displayed in dotted decimal notation and each 8-bit field ranges from 0 to 255. This parameter does not need to be configured in DHCP mode.|
| netMask | string | Yes| Subnet mask of the Ethernet connection. The value must be an IPv4 address, which is a 32-bit number displayed in dotted decimal notation and each 8-bit field ranges from 0 to 255. This parameter does not need to be configured in DHCP mode.|
| dnsServers | string | Yes| DNS server addresses of the Ethernet connection. The value must be an IPv4 address. This parameter does not need to be configured in DHCP mode. Multiple addresses are separated by commas (,).|
-| httpProxy10+ | [HttpProxy](js-apis-net-connection.md#httpproxy) | No| HTTP proxy of the Ethernet connection. By default, no proxy is configured.|
+| httpProxy10+ | [HttpProxy](js-apis-net-connection.md#httpproxy10) | No| HTTP proxy of the Ethernet connection. By default, no proxy is configured.|
## IPSetMode9+
diff --git a/en/application-dev/reference/apis/js-apis-net-policy.md b/en/application-dev/reference/apis/js-apis-net-policy.md
index 295332057ba4042e12ff1c0009efe8a54acec759..1c1bb3adecc5c67136b722cbc9de1eacdf87f462 100644
--- a/en/application-dev/reference/apis/js-apis-net-policy.md
+++ b/en/application-dev/reference/apis/js-apis-net-policy.md
@@ -89,9 +89,11 @@ Specifies whether background applications are allowed to access the network. Thi
**Example**
```js
-policy.setBackgroundAllowed(true).then(function (error) {
- console.log(JSON.stringify(error))
-})
+policy.setBackgroundAllowed(true).then(() => {
+ console.log("setBackgroundAllowed success");
+}).catch(error => {
+ console.log(JSON.stringify(error));
+});
```
## policy.isBackgroundAllowed10+
@@ -164,10 +166,11 @@ Checks whether the current application is allowed to access the network when run
**Example**
```js
-policy.isBackgroundAllowed().then(function (error, data) {
- console.log(JSON.stringify(error))
- console.log(JSON.stringify(data))
-})
+policy.isBackgroundAllowed().then((data) => {
+ console.log(JSON.stringify(data));
+}).catch(error => {
+ console.log(JSON.stringify(error));
+});
```
## policy.setPolicyByUid10+
@@ -248,9 +251,11 @@ Sets the metered network access policy for the application specified by a given
**Example**
```js
-policy.setPolicyByUid(11111, policy.NetUidPolicy.NET_POLICY_NONE).then(function (error) {
- console.log(JSON.stringify(error))
-})
+policy.setPolicyByUid(11111, policy.NetUidPolicy.NET_POLICY_NONE).then(() => {
+ console.log("setPolicyByUid success");
+}).catch(error => {
+ console.log(JSON.stringify(error));
+});
```
## policy.getPolicyByUid10+
@@ -329,10 +334,11 @@ Obtains the network access policy for the application specified by a given UID.
**Example**
```js
-policy.getPolicyByUid(11111).then(function (error, data) {
- console.log(JSON.stringify(error))
- console.log(JSON.stringify(data))
-})
+policy.getPolicyByUid(11111).then((data) => {
+ console.log(JSON.stringify(data));
+}).catch(error => {
+ console.log(JSON.stringify(error));
+});
```
## policy.getUidsByPolicy10+
@@ -412,10 +418,11 @@ Obtains all UIDs that match the specified network policy. This API uses a promis
**Example**
```js
-policy.getUidsByPolicy(11111).then(function (error, data) {
- console.log(JSON.stringify(error))
- console.log(JSON.stringify(data))
-})
+policy.getUidsByPolicy(11111).then((data) => {
+ console.log(JSON.stringify(data));
+}).catch(error => {
+ console.log(JSON.stringify(error));
+});
```
## policy.getNetQuotaPolicies10+
@@ -487,11 +494,11 @@ Obtains the network quota policies. This API uses a promise to return the result
**Example**
```js
-policy.getNetQuotaPolicies().then(function (error, data) {
- console.log(JSON.stringify(error))
- console.log(JSON.stringify(data))
-})
-
+policy.getNetQuotaPolicies().then((data) => {
+ console.log(JSON.stringify(data));
+}).catch(error => {
+ console.log(JSON.stringify(error));
+});
```
## policy.setNetQuotaPolicies10+
@@ -608,9 +615,11 @@ let netquotapolicy = {
netQuotaPolicyList.push(netquotapolicy);
-policy.setNetQuotaPolicies(netQuotaPolicyList).then(function (error) {
- console.log(JSON.stringify(error))
-})
+policy.setNetQuotaPolicies(netQuotaPolicyList).then(() => {
+ console.log("setNetQuotaPolicies success");
+}).catch(error => {
+ console.log(JSON.stringify(error));
+});
```
## policy.isUidNetAllowed10+
@@ -692,10 +701,11 @@ Checks whether the application specified by a given UID is allowed to access a m
**Example**
```js
-policy.isUidNetAllowed(11111, true).then(function (error, data) {
- console.log(JSON.stringify(error))
- console.log(JSON.stringify(data))
-})
+policy.isUidNetAllowed(11111, true).then((data) => {
+ console.log(JSON.stringify(data));
+}).catch(error => {
+ console.log(JSON.stringify(error));
+});
```
## policy.isUidNetAllowed10+
@@ -777,10 +787,11 @@ Checks whether the application specified by a given UID is allowed to access the
**Example**
```js
-policy.isUidNetAllowed(11111, 'wlan0').then(function (error, data) {
- console.log(JSON.stringify(error))
- console.log(JSON.stringify(data))
-})
+policy.isUidNetAllowed(11111, 'wlan0').then((data) => {
+ console.log(JSON.stringify(data));
+}).catch(error => {
+ console.log(JSON.stringify(error));
+});
```
## policy.setDeviceIdleTrustlist10+
@@ -861,9 +872,11 @@ Adds applications specified by given UIDs to the device idle allowlist. This API
**Example**
```js
-policy.setDeviceIdleTrustlist([11111,22222], true).then(function (error) {
- console.log(JSON.stringify(error))
-})
+policy.setDeviceIdleTrustlist([11111,22222], true).then(() => {
+ console.log("setDeviceIdleTrustlist success");
+}).catch(error => {
+ console.log(JSON.stringify(error));
+});
```
## policy.getDeviceIdleTrustlist10+
@@ -934,10 +947,11 @@ Obtains the UIDs of applications that are on the device idle allowlist. This API
**Example**
```js
-policy.getDeviceIdleTrustlist().then(function (error, data) {
- console.log(JSON.stringify(error))
- console.log(JSON.stringify(data))
-})
+policy.getDeviceIdleTrustlist().then((data) => {
+ console.log(JSON.stringify(data));
+}).catch(error => {
+ console.log(JSON.stringify(error));
+});
```
## policy.getBackgroundPolicyByUid10+
@@ -1017,10 +1031,11 @@ Obtains the background network policy for the application specified by a given U
**Example**
```js
-policy.getBackgroundPolicyByUid(11111).then(function (error, data) {
- console.log(JSON.stringify(error))
- console.log(JSON.stringify(data))
-})
+policy.getBackgroundPolicyByUid(11111).then((data) => {
+ console.log(JSON.stringify(data));
+}).catch(error => {
+ console.log(JSON.stringify(error));
+});
```
## policy.resetPolicies10+
@@ -1099,9 +1114,11 @@ Restores all the policies (cellular network, background network, firewall, and a
**Example**
```js
-policy.resetPolicies('1').then(function (error) {
- console.log(JSON.stringify(error))
-})
+policy.resetPolicies('1').then(() => {
+ console.log("resetPolicies success");
+}).catch(error => {
+ console.log(JSON.stringify(error));
+});
```
## policy.updateRemindPolicy10+
@@ -1186,9 +1203,11 @@ Updates a reminder policy. This API uses a promise to return the result.
```js
import connection from '@ohos.net.connection';
-policy.updateRemindPolicy(connection.NetBearType.BEARER_CELLULAR, '1', policy.RemindType.REMIND_TYPE_WARNING).then(function (error) {
- console.log(JSON.stringify(error))
-})
+policy.updateRemindPolicy(connection.NetBearType.BEARER_CELLULAR, '1', policy.RemindType.REMIND_TYPE_WARNING).then(() => {
+ console.log("updateRemindPolicy success");
+}).catch(error => {
+ console.log(JSON.stringify(error));
+});
```
## policy.setPowerSaveTrustlist10+
@@ -1269,9 +1288,11 @@ Sets whether to add the application specified by a given UID to the power-saving
**Example**
```js
-policy.setPowerSaveTrustlist([11111,22222], true).then(function (error) {
- console.log(JSON.stringify(error))
-})
+policy.setPowerSaveTrustlist([11111,22222], true).then(() => {
+ console.log("setPowerSaveTrustlist success");
+}).catch(error => {
+ console.log(JSON.stringify(error));
+});
```
## policy.getPowerSaveTrustlist10+
@@ -1343,10 +1364,11 @@ Obtains the UID array of applications that are on the device idle allowlist. Thi
**Example**
```js
-policy.getPowerSaveTrustlist().then(function (error, data) {
- console.log(JSON.stringify(error))
- console.log(JSON.stringify(data))
-})
+policy.getPowerSaveTrustlist().then((data) => {
+ console.log(JSON.stringify(data));
+}).catch(error => {
+ console.log(JSON.stringify(error));
+});
```
## policy.on
diff --git a/en/application-dev/reference/apis/js-apis-net-vpn.md b/en/application-dev/reference/apis/js-apis-net-vpn.md
new file mode 100644
index 0000000000000000000000000000000000000000..9fbca9235ee22b561d8ed5f414ac37be7454767f
--- /dev/null
+++ b/en/application-dev/reference/apis/js-apis-net-vpn.md
@@ -0,0 +1,406 @@
+# @ohos.net.vpn (VPN Management)
+
+The **vpn** module implements virtual private network (VPN) management, such as starting and stopping a VPN.
+
+> **NOTE**
+> The initial APIs of this module are supported since API version 10. Newly added APIs will be marked with a superscript to indicate their earliest API version.
+
+## Modules to Import
+
+```js
+import vpn from '@ohos.net.vpn';
+```
+
+## vpn.createVpnConnection
+
+createVpnConnection(context: AbilityContext): VpnConnection
+
+Creates a VPN connection.
+
+**System capability**: SystemCapability.Communication.NetManager.Vpn
+
+**Parameters**
+
+| Name | Type | Mandatory| Description |
+| ------------ | ----------------------------- | ---- | ------------------------------------------------------------ |
+| context | [AbilityContext](js-apis-inner-application-uiAbilityContext.md#uiabilitycontext) | Yes | Specified context. |
+
+**Return value**
+
+| Type | Description |
+| :--------------------------------- | :---------------------- |
+| [VpnConnection](#vpnconnection) | VPN connection object.|
+
+**Error codes**
+
+For details about the error codes, see [VPN Error Codes](../errorcodes/errorcode-net-vpn.md).
+
+| ID| Error Message |
+| ------- | ----------------------------- |
+| 401 | Parameter error. |
+
+**Example**
+Stage model:
+
+```ts
+// Obtain the context.
+import UIAbility from '@ohos.app.ability.UIAbility';
+class EntryAbility extends UIAbility {
+ onWindowStageCreate(windowStage){
+ globalThis.context = this.context;
+ }
+}
+let context = globalThis.context;
+VpnConnection = vpn.createVpnConnection(context);
+console.info("vpn onInit: " + JSON.stringify(VpnConnection));
+```
+
+## VpnConnection
+
+Defines a VPN connection object. Before calling **VpnConnection** APIs, you need to create a VPN connection object by calling [vpn.createVpnConnection](#vpncreatevpnconnection).
+
+### setUp
+
+setUp(config: VpnConfig, callback: AsyncCallback\): void
+
+Creates a VPN based on the specified configuration. This API uses an asynchronous callback to return the result.
+
+**System API**: This is a system API.
+
+**Required permissions**: ohos.permission.MANAGE_VPN
+
+**System capability**: SystemCapability.Communication.NetManager.Vpn
+
+**Parameters**
+
+| Name | Type | Mandatory| Description |
+| ------------ | ----------------------------- | ---- | ------------------------------------------------------------ |
+| config | [VpnConfig](#vpnconfig) | Yes | VPN configuration. |
+| callback | AsyncCallback\ | Yes | Callback used to return the result. If a VPN is created successfully, **error** is **undefined** and **data** is the file descriptor of the vNIC. Otherwise, **error** is an error object.|
+
+**Error codes**
+
+For details about the error codes, see [VPN Error Codes](../errorcodes/errorcode-net-vpn.md).
+
+| ID| Error Message |
+| ------- | ----------------------------- |
+| 201 | Permission denied. |
+| 202 | Non-system applications use system APIs. |
+| 401 | Parameter error. |
+| 2200001 | Invalid parameter value. |
+| 2200002 | Operation failed. Cannot connect to service. |
+| 2200003 | System internal error. |
+| 2203001 | VPN creation denied, please check the user type. |
+| 2203002 | VPN exist already, please execute destroy first. |
+
+**Example**
+
+```js
+ let config = {
+ addresses: [{
+ address: {
+ address: "10.0.0.5",
+ family: 1
+ },
+ prefixLength: 24,
+ }],
+ routes: [],
+ mtu: 1400,
+ dnsAddresses:[
+ "114.114.114.114"
+ ],
+ trustedApplications:[],
+ blockedApplications:[]
+ }
+ VpnConnection.setUp(config, (error, data) => {
+ console.info(JSON.stringify(error));
+ console.info("tunfd: " + JSON.stringify(data));
+ })
+```
+
+### setUp
+
+setUp(config: VpnConfig): Promise\
+
+Creates a VPN based on the specified configuration. This API uses a promise to return the result.
+
+**System API**: This is a system API.
+
+**Required permissions**: ohos.permission.MANAGE_VPN
+
+**System capability**: SystemCapability.Communication.NetManager.Vpn
+
+**Parameters**
+
+| Name | Type | Mandatory| Description |
+| ------------ | ----------------------------- | ---- | ------------------------------------------------------------ |
+| config | [VpnConfig](#vpnconfig) | Yes | VPN configuration. |
+
+**Return value**
+
+| Type | Description |
+| --------------------------------- | ------------------------------------- |
+| Promise\ | The obtaining result is returned in Promise format. The file descriptor fd of the specified virtual network adapter is returned.|
+
+**Error codes**
+
+For details about the error codes, see [VPN Error Codes](../errorcodes/errorcode-net-vpn.md).
+
+| ID| Error Message |
+| ------- | ----------------------------- |
+| 201 | Permission denied. |
+| 202 | Non-system applications use system APIs. |
+| 401 | Parameter error. |
+| 2200001 | Invalid parameter value. |
+| 2200002 | Operation failed. Cannot connect to service. |
+| 2200003 | System internal error. |
+| 2203001 | VPN creation denied, please check the user type. |
+| 2203002 | VPN exist already, please execute destroy first. |
+
+**Example**
+
+```js
+ let config = {
+ addresses: [{
+ address: {
+ address: "10.0.0.5",
+ family: 1
+ },
+ prefixLength: 24,
+ }],
+ routes: [],
+ mtu: 1400,
+ dnsAddresses:[
+ "114.114.114.114"
+ ],
+ trustedApplications:[],
+ blockedApplications:[]
+ }
+ VpnConnection.setUp(config).then((data) => {
+ console.info(TAG + "setUp success, tunfd: " + JSON.stringify(data))
+ }).catch(err => {
+ console.info(TAG + "setUp fail" + JSON.stringify(err))
+ })
+```
+
+### protect
+
+protect(socketFd: number, callback: AsyncCallback\): void
+
+Protects sockets against a VPN connection. The data sent through sockets is directly transmitted over the physical network and therefore the traffic does not traverse through the VPN. This API uses an asynchronous callback to return the result.
+
+**System API**: This is a system API.
+
+**Required permissions**: ohos.permission.MANAGE_VPN
+
+**System capability**: SystemCapability.Communication.NetManager.Vpn
+
+**Parameters**
+
+| Name | Type | Mandatory| Description |
+| ------------ | ----------------------------- | ---- | ------------------------------------------------------------ |
+| socketFd | number | Yes | Socket file descriptor. It can be obtained through [getSocketFd](js-apis-socket.md#getsocketfd10). |
+| callback | AsyncCallback\ | Yes | Callback used to return the result. If the operation is successful, **error** is **undefined**. If the operation fails, an error message is returned.|
+
+**Error codes**
+
+For details about the error codes, see [VPN Error Codes](../errorcodes/errorcode-net-vpn.md).
+
+| ID| Error Message |
+| ------- | ----------------------------- |
+| 201 | Permission denied. |
+| 202 | Non-system applications use system APIs. |
+| 401 | Parameter error. |
+| 2200001 | Invalid parameter value. |
+| 2200002 | Operation failed. Cannot connect to service. |
+| 2200003 | System internal error. |
+| 2203004 | Invalid socket file descriptor. |
+
+**Example**
+
+```js
+ import socket from "@ohos.net.socket";
+ var tcp = socket.constructTCPSocketInstance();
+ tcp.bind({
+ address: "0.0.0.0",
+ family: 1
+ })
+ let connectAddress = {
+ address: "192.168.1.11",
+ port: 8888,
+ family: 1
+ };
+ tcp.connect({
+ address: connectAddress, timeout: 6000
+ })
+ tcp.getSocketFd().then((tunnelfd) => {
+ console.info("tunenlfd: " + tunnelfd);
+ VpnConnection.protect(tunnelfd, (error) => {
+ console.info(JSON.stringify(error));
+ })
+ })
+```
+
+### protect
+
+protect(socketFd: number): Promise\
+
+Protects sockets against a VPN connection. The data sent through sockets is directly transmitted over the physical network and therefore traffic does not traverse through the VPN. This API uses a promise to return the result.
+
+**System API**: This is a system API.
+
+**Required permissions**: ohos.permission.MANAGE_VPN
+
+**System capability**: SystemCapability.Communication.NetManager.Vpn
+
+**Parameters**
+
+| Name | Type | Mandatory| Description |
+| ------------ | ----------------------------- | ---- | ------------------------------------------------------------ |
+| socketFd | number | Yes | Socket file descriptor. It can be obtained through [getSocketFd](js-apis-socket.md#getsocketfd10-1). |
+
+**Return value**
+
+| Type | Description |
+| --------------------------------- | ------------------------------------- |
+| Promise\ | Promise used to return the result. If the operation is successful, the operation result is returned. If the operation fails, an error message is returned.|
+
+**Error codes**
+
+For details about the error codes, see [VPN Error Codes](../errorcodes/errorcode-net-vpn.md).
+
+| ID| Error Message |
+| ------- | ----------------------------- |
+| 201 | Permission denied. |
+| 202 | Non-system applications use system APIs. |
+| 401 | Parameter error. |
+| 2200001 | Invalid parameter value. |
+| 2200002 | Operation failed. Cannot connect to service. |
+| 2200003 | System internal error. |
+| 2203004 | Invalid socket file descriptor. |
+
+**Example**
+
+```js
+ import socket from "@ohos.net.socket";
+ var tcp = socket.constructTCPSocketInstance();
+ tcp.bind({
+ address: "0.0.0.0",
+ family: 1
+ })
+ let connectAddress = {
+ address: "192.168.1.11",
+ port: 8888,
+ family: 1
+ };
+ tcp.connect({
+ address: connectAddress, timeout: 6000
+ })
+ tcp.getSocketFd().then((tunnelfd) => {
+ console.info("tunenlfd: " + tunnelfd);
+ VpnConnection.protect(tunnelfd).then(() => {
+ console.info("protect success.")
+ }).catch(err => {
+ console.info("protect fail" + JSON.stringify(err))
+ })
+ })
+```
+
+### destroy
+
+destroy(callback: AsyncCallback\): void
+
+Destroys a VPN. This API uses an asynchronous callback to return the result.
+
+**System API**: This is a system API.
+
+**Required permissions**: ohos.permission.MANAGE_VPN
+
+**System capability**: SystemCapability.Communication.NetManager.Vpn
+
+**Parameters**
+
+| Name | Type | Mandatory| Description |
+| ------------ | ----------------------------- | ---- | ------------------------------------------------------------ |
+| callback | AsyncCallback\ | Yes | Callback used to return the result. If the operation is successful, **error** is **undefined**. If the operation fails, an error message is returned.|
+
+**Error codes**
+
+For details about the error codes, see [VPN Error Codes](../errorcodes/errorcode-net-vpn.md).
+
+| ID| Error Message |
+| ------- | ----------------------------- |
+| 201 | Permission denied. |
+| 202 | Non-system applications use system APIs. |
+| 401 | Parameter error. |
+| 2200002 | Operation failed. Cannot connect to service. |
+| 2200003 | System internal error. |
+
+**Example**
+
+```js
+ VpnConnection.destroy((error) => {
+ console.info(JSON.stringify(error));
+ })
+```
+
+### destroy
+
+destroy(): Promise\
+
+Destroys a VPN. This API uses a promise to return the result.
+
+**System API**: This is a system API.
+
+**Required permissions**: ohos.permission.MANAGE_VPN
+
+**System capability**: SystemCapability.Communication.NetManager.Vpn
+
+**Return value**
+
+| Type | Description |
+| --------------------------------- | ------------------------------------- |
+| Promise\ | Promise used to return the result. If the operation is successful, the operation result is returned. If the operation fails, an error message is returned.|
+
+**Error codes**
+
+For details about the error codes, see [VPN Error Codes](../errorcodes/errorcode-net-vpn.md).
+
+| ID| Error Message |
+| ------- | ----------------------------- |
+| 201 | Permission denied. |
+| 202 | Non-system applications use system APIs. |
+| 2200002 | Operation failed. Cannot connect to service. |
+| 2200003 | System internal error. |
+
+**Example**
+
+```js
+ VpnConnection.destroy().then(() => {
+ console.info("destroy success.")
+ }).catch(err => {
+ console.info("destroy fail" + JSON.stringify(err))
+ });
+```
+
+## VpnConfig
+
+Defines the VPN configuration.
+
+**System API**: This is a system API.
+
+**System capability**: SystemCapability.Communication.NetManager.Vpn
+
+| Name| Type| Mandatory| Description|
+| ------- | ------ | -- |------------------------------ |
+| addresses | Array\<[LinkAddress](js-apis-net-connection.md#linkaddress8)\> | Yes| IP address of the vNIC.|
+| routes | Array\<[RouteInfo](js-apis-net-connection.md#routeinfo8)\> | No| Route information of the vNIC.|
+| dnsAddresses | Array\ | No| IP address of the DNS server.|
+| searchDomains | Array\ | No| List of DNS search domains.|
+| mtu | number | No| Maximum transmission unit (MTU), in bytes.|
+| isIPv4Accepted | boolean | No| Whether IPv4 is supported. The default value is **true**.|
+| isIPv6Accepted | boolean | No| Whether IPv6 is supported. The default value is **false**.|
+| isLegacy | boolean | No| Whether the built-in VPN is supported. The default value is **false**.|
+| isBlocking | boolean | No| Whether the blocking mode is used. The default value is **false**.|
+| trustedApplications | Array\ | No| List of trusted applications, which are represented by bundle names of the string type.|
+| blockedApplications | Array\ | No| List of blocked applications, which are represented by bundle names of the string type.|
diff --git a/en/application-dev/reference/apis/js-apis-nfcTag.md b/en/application-dev/reference/apis/js-apis-nfcTag.md
index 9aeadd303e320824c99d7eb58148274bbb537e9b..07e68bebed8fd58bbf29a1bb6d800b8a5710821c 100644
--- a/en/application-dev/reference/apis/js-apis-nfcTag.md
+++ b/en/application-dev/reference/apis/js-apis-nfcTag.md
@@ -23,20 +23,18 @@ Before developing applications related to tag read and write, you must declare N
// Add the nfc tag action.
"ohos.nfc.tag.action.TAG_FOUND"
+ ],
+ "uris": [
+ {
+ "type":"tag-tech/NfcA"
+ },
+ {
+ "type":"tag-tech/IsoDep"
+ }
+ // Add other technology if neccessary,
+ // such as NfcB, NfcF, NfcV, Ndef, MifareClassic, MifareUL, and NdefFormatable.
]
}
- ],
- "metadata": [
- {
- "name": "tag-tech",
- "value": "NfcA"
- },
- {
- "name": "tag-tech",
- "value": "IsoDep"
- }
- // Add other technologies,
- // such as NfcB, NfcF, NfcV, Ndef, MifareClassic, MifareUL, and NdefFormatable.
]
}
],
@@ -49,13 +47,11 @@ Before developing applications related to tag read and write, you must declare N
}
}
```
-> **CAUTION** | Yes | Callback used to return the result.|
**Example**
@@ -1502,7 +1502,7 @@ Removes a notification for a specified bundle. This API uses a promise to return
| --------------- | --------------- | ---- | ---------- |
| bundle | [BundleOption](#bundleoptiondeprecated) | Yes | Bundle information of the application.|
| notificationKey | [NotificationKey](#notificationkeydeprecated) | Yes | Notification key. |
-| reason | [RemoveReason](#removereason9-deprecated) | Yes | Reason for deleting the notification. |
+| reason | [RemoveReason](#removereason-deprecated) | Yes | Reason for deleting the notification. |
**Example**
@@ -1536,8 +1536,8 @@ Removes a notification for a specified bundle. This API uses an asynchronous cal
| Name | Type | Mandatory| Description |
| -------- | --------------------- | ---- | -------------------- |
-| hashCode | string | Yes | Unique notification ID. It is the **hashCode** in the [NotificationRequest](#notificationrequest) object of [SubscribeCallbackData](#subscribecallbackdata) of the [onConsume](js-apis-inner-notification-notificationSubscriber.md#onconsume) callback. |
-| reason | [RemoveReason](#removereason9-deprecated) | Yes | Indicates the reason for deleting a notification. |
+| hashCode | string | Yes | Unique notification ID. It is the **hashCode** in the [NotificationRequest](#notificationrequest) object of [SubscribeCallbackData](#subscribecallbackdata) of the [onConsume](js-apis-inner-notification-notificationSubscriber.md#onconsume) callback.|
+| reason | [RemoveReason](#removereason-deprecated) | Yes | Reason for deleting a notification. |
| callback | AsyncCallback\ | Yes | Callback used to return the result.|
**Example**
@@ -1573,7 +1573,7 @@ Removes a notification for a specified bundle. This API uses a promise to return
| Name | Type | Mandatory| Description |
| -------- | ---------- | ---- | ---------- |
| hashCode | string | Yes | Unique notification ID.|
-| reason | [RemoveReason](#removereason9-deprecated) | Yes | Reason for deleting the notification. |
+| reason | [RemoveReason](#removereason-deprecated) | Yes | Reason for deleting the notification. |
**Example**
@@ -2872,10 +2872,10 @@ Notification.getDeviceRemindType().then((data) => {
>
> This API is supported since API version 7 and deprecated since API version 9. You are advised to use [notificationManager.BundleOption](js-apis-inner-notification-notificationCommonDef.md#bundleoption) instead.
-| Name | Type | Read-only| Mandatory| Description |
-| ------ | ------ |---- | --- | ------ |
-| bundle | string | No | Yes | Bundle information of the application.|
-| uid | number | No | No | User ID.|
+| Name | Type | Mandatory| Description |
+| ------ | ------ | --- | ------ |
+| bundle | string | Yes | Bundle information of the application.|
+| uid | number | No | User ID.|
## NotificationKeydeprecated
@@ -3059,7 +3059,7 @@ Describes the notification request.
| classification | string | Yes | Yes | Notification category.8+ | string | Yes | Yes | Notification group name. |
| template8+ | [NotificationTemplate](#notificationtemplate8) | Yes | Yes | Notification template. |
-| isRemoveAllowed8+ | boolean | Yes | No | Whether the notification can be removed.10+ | boolean | Yes | No | Whether the notification can be removed.8+ | number | Yes | No | Notification source.8+ | [DistributedOptions](#distributedoptions8) | Yes | Yes | Distributed notification options. |
| deviceId8+ | string | Yes | No | Device ID of the notification source.9+ deprecated
+## RemoveReason deprecated
**System capability**: SystemCapability.Notification.Notification
@@ -3211,9 +3211,9 @@ Provides the notification user input.
> **NOTE**
>
-> This API is supported since API version 9 and deprecated since API version 9. You are advised to use [notificationManager.RemoveReason](js-apis-notificationSubscribe.md#removereason) instead.
+> This API is supported since API version 7 and deprecated since API version 9. You are advised to use [notificationManager.RemoveReason](js-apis-notificationSubscribe.md#removereason) instead.
| Name | Value | Description |
| -------------------- | --- | -------------------- |
-| CLICK_REASON_REMOVE9+ | 1 | The notification is removed after a click on it. |
-| CANCEL_REASON_REMOVE9+ | 2 | The notification is removed by the user. |
+| CLICK_REASON_REMOVE | 1 | The notification is removed after a click on it. |
+| CANCEL_REASON_REMOVE | 2 | The notification is removed by the user. |
diff --git a/en/application-dev/reference/apis/js-apis-notificationSubscribe.md b/en/application-dev/reference/apis/js-apis-notificationSubscribe.md
index 1ca3f7833aadfde7058e24f8231d0e0360d82122..10a7091a75c1e9354921fe46bdbc1ce4bccb1a2e 100644
--- a/en/application-dev/reference/apis/js-apis-notificationSubscribe.md
+++ b/en/application-dev/reference/apis/js-apis-notificationSubscribe.md
@@ -443,6 +443,90 @@ notificationSubscribe.remove(hashCode, reason).then(() => {
console.info("remove success");
});
```
+## NotificationSubscribe.remove
+
+remove(hashCodes: Array\, reason: RemoveReason, callback: AsyncCallback\): void
+
+Removes specified notifications. 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**
+
+| Name | Type | Mandatory| Description |
+|-----------|-------------------------------| ---- |-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
+| hashCodes | Array\ | Yes | Array of unique notification IDs. It is the **hashCode** in the [NotificationRequest](js-apis-inner-notification-notificationRequest.md#notificationrequest) object of [SubscribeCallbackData](js-apis-notification.md#subscribecallbackdata) of the [onConsume](js-apis-inner-notification-notificationSubscriber.md#onConsume) callback.|
+| reason | [RemoveReason](#removereason) | Yes | Reason for removing the notification. |
+| callback | AsyncCallback\ | Yes | Callback used to return the result. |
+
+**Error codes**
+
+For details about the error codes, see [Notification Error Codes](../errorcodes/errorcode-notification.md).
+
+| ID| Error Message |
+| -------- | ----------------------------------- |
+| 1600001 | Internal error. |
+| 1600002 | Marshalling or unmarshalling error. |
+| 1600003 | Failed to connect service. |
+
+**Example**
+
+```js
+let hashCodes = ['hashCode1', 'hashCode2'];
+
+function removeCallback(err) {
+ if (err) {
+ console.error(`remove failed, code is ${err.code}, message is ${err.message}`);
+ } else {
+ console.info("remove success");
+ }
+}
+let reason = notificationSubscribe.RemoveReason.CANCEL_REASON_REMOVE;
+notificationSubscribe.remove(hashCodes, reason, removeCallback);
+```
+
+## NotificationSubscribe.remove
+
+remove(hashCodes: Array\, reason: RemoveReason): Promise\
+
+Removes specified notifications. 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 | Type | Mandatory| Description |
+|-----------|-------------------------------| ---- |-------------|
+| hashCodes | Array\ | Yes | Array of unique notification IDs.|
+| reason | [RemoveReason](#removereason) | Yes | Reason for removing the notification. |
+
+**Error codes**
+
+For details about the error codes, see [Notification Error Codes](../errorcodes/errorcode-notification.md).
+
+| ID| Error Message |
+| -------- | ----------------------------------- |
+| 1600001 | Internal error. |
+| 1600002 | Marshalling or unmarshalling error. |
+| 1600003 | Failed to connect service. |
+
+**Example**
+
+```js
+let hashCodes = ['hashCode1','hashCode2'];
+let reason = notificationSubscribe.RemoveReason.CLICK_REASON_REMOVE;
+notificationSubscribe.remove(hashCodes, reason).then(() => {
+ console.info("remove success");
+});
+```
## NotificationSubscribe.removeAll
diff --git a/en/application-dev/reference/apis/js-apis-photoAccessHelper.md b/en/application-dev/reference/apis/js-apis-photoAccessHelper.md
index 808334727bbbf917dad8a7f801bcc7896ad12ee3..aae05347c5a05bdcb5e6bcae488fe53fa89602f4 100644
--- a/en/application-dev/reference/apis/js-apis-photoAccessHelper.md
+++ b/en/application-dev/reference/apis/js-apis-photoAccessHelper.md
@@ -1275,6 +1275,151 @@ async function example() {
}
```
+### getPhotoIndex
+
+getPhotoIndex(photoUri: string, albumUri: string, options: FetchOptions, callback: AsyncCallback<number>): void
+
+Obtains the index of an image or video in an album. This API uses an asynchronous callback to return the result.
+
+**System API**: This is a system API.
+
+**Required permissions**: ohos.permission.READ_IMAGEVIDEO
+
+**System capability**: SystemCapability.FileManagement.PhotoAccessHelper.Core
+
+**Parameters**
+
+| Name | Type | Mandatory| Description |
+| -------- | ------------------------- | ---- | ---------- |
+| photoUri | string | Yes | URI of the media asset whose index is to be obtained.|
+| albumUri | string | Yes | Album URI, which can be an empty string. If it is an empty string, all the media assets in the Gallery are obtained by default. |
+| options | [FetchOptions](#fetchoptions) | Yes | Fetch options. Only one search condition or sorting mode must be set in **predicates**. If no value is set or multiple search conditions or sorting modes are set, the API cannot be called successfully. |
+
+**Return value**
+
+| Type | Description |
+| --------------------------------------- | ----------------- |
+| AsyncCallback<number>| Promise used to return the index obtained.|
+
+**Error codes**
+
+For details about the error codes, see [Universal Error Codes](../errorcodes/errorcode-universal.md).
+
+| ID| Error Message|
+| -------- | ---------------------------------------- |
+| 401 | if parameter is invalid. |
+
+**Example**
+
+```ts
+import dataSharePredicates from '@ohos.data.dataSharePredicates';
+
+async function example() {
+ console.info('getPhotoIndexDemo');
+ let predicatesForGetAsset = new dataSharePredicates.DataSharePredicates();
+ let fetchOp = {
+ fetchColumns: [],
+ predicates: predicatesForGetAsset
+ };
+ //Obtain the uri of the album
+ let albumFetchResult = await helper.getAlbums(photoAccessHelper.AlbumType.SYSTEM, photoAccessHelper.AlbumSubtype.FAVORITE, fetchOp);
+ let album = await albumFetchResult.getFirstObject();
+
+ let predicates = new dataSharePredicates.DataSharePredicates();
+ predicates.orderByAsc("add_modified");
+ let fetchOptions = {
+ fetchColumns: [],
+ predicates: predicates
+ };
+ let photoFetchResult = await album.getAssets(fetchOptions);
+ let expectIndex = 1;
+ //Obtain the uri of the second file
+ let photoAsset = await photoFetchResult.getObjectByPosition(expectIndex);
+
+ photoAccessHelper.getPhotoIndex(photoAsset.uri, album.albumUri, fetchOptions, (err, index) => {
+ try {
+ if (err == undefined) {
+ console.info(`getPhotoIndex successfully and index is : ${index}`);
+ } else {
+ console.info(`getPhotoIndex failed;`);
+ }
+ } catch (error) {
+ console.info(`getPhotoIndex failed; error: ${error}`);
+ }
+ }
+}
+```
+
+### getPhotoIndex
+
+getPhotoIndex(photoUri: string, albumUri: string, options: FetchOptions): Promise<number>
+
+Obtains the index of an image or video in an album. This API uses a promise to return the result.
+
+**System API**: This is a system API.
+
+**Required permissions**: ohos.permission.READ_IMAGEVIDEO
+
+**System capability**: SystemCapability.FileManagement.PhotoAccessHelper.Core
+
+**Parameters**
+
+| Name | Type | Mandatory| Description |
+| -------- | ------------------------- | ---- | ---------- |
+| photoUri | string | Yes | URI of the media asset whose index is to be obtained.|
+| albumUri | string | Yes | Album URI, which can be an empty string. If it is an empty string, all the media assets in the Gallery are obtained by default. |
+| options | [FetchOptions](#fetchoptions) | Yes | Fetch options. Only one search condition or sorting mode must be set in **predicates**. If no value is set or multiple search conditions or sorting modes are set, the API cannot be called successfully. |
+
+**Return value**
+
+| Type | Description |
+| --------------------------------------- | ----------------- |
+| Promise<number>| Promise used to return the index obtained.|
+
+**Error codes**
+
+For details about the error codes, see [Universal Error Codes](../errorcodes/errorcode-universal.md).
+
+| ID| Error Message|
+| -------- | ---------------------------------------- |
+| 401 | if parameter is invalid. |
+
+**Example**
+
+```ts
+import dataSharePredicates from '@ohos.data.dataSharePredicates';
+
+async function example() {
+ console.info('getPhotoIndexDemo');
+ let predicatesForGetAsset = new dataSharePredicates.DataSharePredicates();
+ let fetchOp = {
+ fetchColumns: [],
+ predicates: predicatesForGetAsset
+ };
+ //Obtain the uri of the album
+ let albumFetchResult = await helper.getAlbums(photoAccessHelper.AlbumType.SYSTEM, photoAccessHelper.AlbumSubtype.FAVORITE, fetchOp);
+ let album = await albumFetchResult.getFirstObject();
+
+ let predicates = new dataSharePredicates.DataSharePredicates();
+ predicates.orderByAsc("add_modified");
+ let fetchOptions = {
+ fetchColumns: [],
+ predicates: predicates
+ };
+ let photoFetchResult = await album.getAssets(fetchOptions);
+ let expectIndex = 1;
+ //Obtain the uri of the second file
+ let photoAsset = await photoFetchResult.getObjectByPosition(expectIndex);
+
+ photoAccessHelper.getPhotoIndex(photoAsset.uri, album.albumUri, fetchOptions)
+ .then((index) => {
+ console.info(`getPhotoIndex successfully and index is : ${index}`);
+ }).catch((err) => {
+ console.info(`getPhotoIndex failed; error: ${err}`);
+ })
+}
+```
+
### release
release(callback: AsyncCallback<void>): void
@@ -1360,7 +1505,7 @@ Provides APIs for encapsulating file asset attributes.
| Name | Type | Readable| Writable| Description |
| ------------------------- | ------------------------ | ---- | ---- | ------------------------------------------------------ |
-| uri | string | Yes | No | File asset URI, for example, **file://media/image/2**. |
+| uri | string | Yes | No | File asset URI, for example, **file://media/Photo/1/IMG_datetime_0001/displayName.jpg**. |
| photoType | [PhotoType](#phototype) | Yes | No | Type of the file. |
| displayName | string | Yes | No | File name, including the file name extension, to display. |
@@ -2243,6 +2388,282 @@ async function example() {
}
```
+### getExif10+
+
+getExif(): Promise<string>
+
+Obtains a JSON string consisting of the EXIF tags of this JPG image. This API uses a promise to return the result.
+
+**CAUTION**10+
+
+getExif(callback: AsyncCallback<string>): void
+
+Obtains a JSON string consisting of the EXIF tags of this JPG image. This API uses an asynchronous callback to return the result.
+
+**CAUTION**10+
+
+setUserComment(userComment: string): Promise<void>
+
+Sets user comment information of an image or video. This API uses a promise to return the result.
+
+**NOTE**10+
+
+setUserComment(userComment: string, callback: AsyncCallback<void>): void
+
+Sets user comment information of an image or video. This API uses an asynchronous callback to return the result.
+
+**NOTE**10+ | 'user_comment' | User comment information. **System API**: This is a system API. |
## AlbumKeys
diff --git a/en/application-dev/reference/apis/js-apis-reminderAgentManager.md b/en/application-dev/reference/apis/js-apis-reminderAgentManager.md
index 644759435975c722de9fd274b704ecd01804d2fd..de1e1e04ddfc51d5e24ef783f022ab2f400f09dc 100644
--- a/en/application-dev/reference/apis/js-apis-reminderAgentManager.md
+++ b/en/application-dev/reference/apis/js-apis-reminderAgentManager.md
@@ -1,8 +1,6 @@
-# @ohos.reminderAgentManager (reminderAgentManager)
+# @ohos.reminderAgentManager (Agent-Powered Reminders)
-The **reminderAgentManager** module provides APIs for publishing scheduled reminders through the reminder agent.
-
-You can use the APIs to create scheduled reminders for countdown timers, calendar events, and alarm clocks. When the created reminders are published, the timing and pop-up notification functions of your application will be taken over by the reminder agent in the background when your application is frozen or exits.
+The **reminderAgentManager** module provides APIs related to agent-powered reminders. When your application is frozen or exits, the timing and notification functions of your application will be taken over by a system service running in the background. You can use the APIs to create scheduled reminders for countdown timers, calendar events, and alarm clocks.
> **NOTE**
>
@@ -15,12 +13,15 @@ You can use the APIs to create scheduled reminders for countdown timers, calenda
import reminderAgentManager from'@ohos.reminderAgentManager';
```
-
## reminderAgentManager.publishReminder
publishReminder(reminderReq: ReminderRequest, callback: AsyncCallback\): void
-Publishes a reminder through the reminder agent. This API uses an asynchronous callback to return the result. It can be called only when notification is enabled for the application through [Notification.requestEnableNotification](js-apis-notification.md#notificationrequestenablenotification8).
+Publishes a reminder. This API uses an asynchronous callback to return the result.
+
+> **NOTE**
+>
+> This API can be called only after the [Notification.requestEnableNotification](js-apis-notification.md#notificationrequestenablenotification8) permission is obtained.
**Required permissions**: ohos.permission.PUBLISH_AGENT_REMINDER
@@ -28,10 +29,10 @@ Publishes a reminder through the reminder agent. This API uses an asynchronous c
**Parameters**
- | Name| Type| Mandatory| Description|
- | -------- | -------- | -------- | -------- |
- | reminderReq | [ReminderRequest](#reminderrequest) | Yes| Reminder to be published.|
- | callback | AsyncCallback\ | Yes| Callback used to return the published reminder's ID.|
+| Name| Type| Mandatory| Description|
+| -------- | -------- | -------- | -------- |
+| reminderReq | [ReminderRequest](#reminderrequest) | Yes| Request used for publishing the reminder.|
+| callback | AsyncCallback\ | Yes| Callback used to return the published reminder's ID.|
**Error codes**
@@ -62,26 +63,29 @@ try {
};
```
-
## reminderAgentManager.publishReminder
publishReminder(reminderReq: ReminderRequest): Promise\
-Publishes a reminder through the reminder agent. This API uses a promise to return the result. It can be called only when notification is enabled for the application through [Notification.requestEnableNotification](js-apis-notification.md#notificationrequestenablenotification8).
+Publishes a reminder. This API uses a promise to return the result.
+
+> **NOTE**
+>
+> This API can be called only after the [Notification.requestEnableNotification](js-apis-notification.md#notificationrequestenablenotification8) permission is obtained.
**Required permissions**: ohos.permission.PUBLISH_AGENT_REMINDER
**System capability**: SystemCapability.Notification.ReminderAgent
**Parameters**
- | Name| Type| Mandatory| Description|
- | -------- | -------- | -------- | -------- |
- | reminderReq | [ReminderRequest](#reminderrequest) | Yes| Reminder to be published.|
+| Name| Type| Mandatory| Description|
+| -------- | -------- | -------- | -------- |
+| reminderReq | [ReminderRequest](#reminderrequest) | Yes| Request used for publishing the reminder.|
**Return value**
- | Type| Description|
- | -------- | -------- |
- | Promise\ | Promise used to return the published reminder's ID.|
+| Type| Description|
+| -------- | -------- |
+| Promise\ | Promise used to return the published reminder's ID.|
**Error codes**
@@ -115,7 +119,7 @@ try {
cancelReminder(reminderId: number, callback: AsyncCallback\): void
-Cancels the reminder with the specified ID. This API uses an asynchronous callback to return the cancellation result.
+Cancels a reminder published. This API uses an asynchronous callback to return the result.
**System capability**: SystemCapability.Notification.ReminderAgent
@@ -124,7 +128,7 @@ Cancels the reminder with the specified ID. This API uses an asynchronous callba
| Name| Type| Mandatory| Description|
| -------- | -------- | -------- | -------- |
| reminderId | number | Yes| ID of the reminder to cancel.|
-| callback | AsyncCallback\ | Yes| Callback used to return the result.|
+| callback | AsyncCallback\ | Yes| Callback used to return the result. If the reminder is canceled, **err** is **undefined**. Otherwise, **err** is an error object.|
**Error codes**
@@ -151,12 +155,11 @@ try {
};
```
-
## reminderAgentManager.cancelReminder
cancelReminder(reminderId: number): Promise\
-Cancels the reminder with the specified ID. This API uses a promise to return the cancellation result.
+Cancels a reminder published. This API uses a promise to return the result.
**System capability**: SystemCapability.Notification.ReminderAgent
@@ -170,7 +173,7 @@ Cancels the reminder with the specified ID. This API uses a promise to return th
| Type| Description|
| -------- | -------- |
-| Promise\ | Promise used to return the result.|
+| Promise\ | Promise that returns no value.|
**Error codes**
@@ -199,8 +202,7 @@ try {
getValidReminders(callback: AsyncCallback>): void
-
-Obtains all valid (not yet expired) reminders set by the current application. This API uses an asynchronous callback to return the reminders.
+Obtains all valid (not yet expired) reminders set by the current application. This API uses an asynchronous callback to return the result.
**System capability**: SystemCapability.Notification.ReminderAgent
@@ -208,7 +210,7 @@ Obtains all valid (not yet expired) reminders set by the current application. Th
| Name| Type| Mandatory| Description|
| -------- | -------- | -------- | -------- |
-| callback | AsyncCallback\> | Yes| Asynchronous callback used to return an array of all valid reminders set by the current application.|
+| callback | AsyncCallback\> | Yes| Callback used to return all the valid reminders.|
**Error codes**
@@ -259,7 +261,7 @@ try {
getValidReminders(): Promise\>
-Obtains all valid (not yet expired) reminders set by the current application. This API uses a promise to return the reminders.
+Obtains all valid (not yet expired) reminders set by the current application. This API uses a promise to return the result.
**System capability**: SystemCapability.Notification.ReminderAgent
@@ -267,7 +269,7 @@ Obtains all valid (not yet expired) reminders set by the current application. Th
| Type| Description|
| -------- | -------- |
-| Promise\> | Promise used to return an array of all valid reminders set by the current application.|
+| Promise\> | Promise used to return all the valid reminders.|
**Error codes**
@@ -312,12 +314,11 @@ try {
};
```
-
## reminderAgentManager.cancelAllReminders
cancelAllReminders(callback: AsyncCallback\): void
-Cancels all reminders set by the current application. This API uses an asynchronous callback to return the cancellation result.
+Cancels all reminders set by the current application. This API uses an asynchronous callback to return the result.
**System capability**: SystemCapability.Notification.ReminderAgent
@@ -325,7 +326,7 @@ Cancels all reminders set by the current application. This API uses an asynchron
| Name| Type| Mandatory| Description|
| -------- | -------- | -------- | -------- |
-| callback | AsyncCallback\ | Yes| Callback used to return the result.|
+| callback | AsyncCallback\ | Yes| Callback used to return the result. If all the reminders are canceled, **err** is **undefined**. Otherwise, **err** is an error object. |
**Error codes**
@@ -351,12 +352,11 @@ try {
};
```
-
## reminderAgentManager.cancelAllReminders
cancelAllReminders(): Promise\
-Cancels all reminders set by the current application. This API uses a promise to return the cancellation result.
+Cancels all reminders set by the current application. This API uses a promise to return the result.
**System capability**: SystemCapability.Notification.ReminderAgent
@@ -364,7 +364,7 @@ Cancels all reminders set by the current application. This API uses a promise to
| Type| Description|
| -------- | -------- |
-| Promise\ | Promise used to return the result.|
+| Promise\ | Promise that returns no value.|
**Error codes**
@@ -401,8 +401,8 @@ Adds a notification slot. This API uses an asynchronous callback to return the r
| Name| Type| Mandatory| Description|
| -------- | -------- | -------- | -------- |
-| slot | [NotificationSlot](js-apis-notification.md#notificationslot) | Yes| Notification slot, whose type can be set.|
-| callback | AsyncCallback\ | Yes| Callback used to return the result.|
+| slot | [NotificationSlot](js-apis-notification.md#notificationslot) | Yes| Notification slot. Only the type can be set.|
+| callback | AsyncCallback\ | Yes| Callback used to return the result. If the notification slot is added, **err** is **undefined**. Otherwise, **err** is an error object.|
**Example**
@@ -438,13 +438,13 @@ Adds a notification slot. This API uses a promise to return the result.
| Name| Type| Mandatory| Description|
| -------- | -------- | -------- | -------- |
-| slot | [NotificationSlot](js-apis-notification.md#notificationslot) | Yes| Notification slot, whose type can be set.|
+| slot | [NotificationSlot](js-apis-notification.md#notificationslot) | Yes| Notification slot. Only the type can be set.|
**Return value**
| Type| Description|
| -------- | -------- |
-| Promise\ | Promise used to return the result.|
+| Promise\ | Promise that returns no value.|
**Example**
@@ -470,7 +470,7 @@ try {
removeNotificationSlot(slotType: notification.SlotType, callback: AsyncCallback\): void
-Removes a notification slot of a specified type. This API uses an asynchronous callback to return the result.
+Removes a notification slot. This API uses an asynchronous callback to return the result.
**System capability**: SystemCapability.Notification.ReminderAgent
@@ -479,7 +479,7 @@ Removes a notification slot of a specified type. This API uses an asynchronous c
| Name| Type| Mandatory| Description|
| -------- | -------- | -------- | -------- |
| slotType | [notification.SlotType](js-apis-notification.md#slottype) | Yes| Type of the notification slot to remove.|
-| callback | AsyncCallback\ | Yes| Callback used to return the result.|
+| callback | AsyncCallback\ | Yes| Callback used to return the result. If the notification slot is removed, **err** is **undefined**. Otherwise, **err** is an error object.|
**Example**
@@ -504,7 +504,7 @@ try {
removeNotificationSlot(slotType: notification.SlotType): Promise\
-Removes a notification slot of a specified type. This API uses a promise to return the result.
+Removes a notification slot. This API uses a promise to return the result.
**System capability**: SystemCapability.Notification.ReminderAgent
@@ -518,7 +518,7 @@ Removes a notification slot of a specified type. This API uses a promise to retu
| Type| Description|
| -------- | -------- |
-| Promise\ | Promise used to return the result.|
+| Promise\ | Promise that returns no value.|
**Example**
@@ -538,7 +538,7 @@ try {
## ActionButtonType
-Enumerates button types.
+Enumerates the button types.
**System capability**: SystemCapability.Notification.ReminderAgent
@@ -551,7 +551,7 @@ Enumerates button types.
## ReminderType
-Enumerates reminder types.
+Enumerates the reminder types.
**System capability**: SystemCapability.Notification.ReminderAgent
@@ -564,8 +564,7 @@ Enumerates reminder types.
## ActionButton
-Defines a button displayed for the reminder in the notification panel.
-
+Defines the button on the reminder displayed.
**System capability**: SystemCapability.Notification.ReminderAgent
@@ -573,7 +572,7 @@ Defines a button displayed for the reminder in the notification panel.
| -------- | -------- | -------- | -------- |
| title | string | Yes| Text on the button.|
| type | [ActionButtonType](#actionbuttontype) | Yes| Button type.|
-| wantAgent10+ | [WantAgent](#wantagent) | No| Ability information that is displayed after the button is clicked.10+ | [WantAgent](#wantagent) | No| Information about the ability that is displayed after the button is clicked.10+ | boolean | No| Whether the notification is automatically cleared. The value is the same as that of [NotificationRequest.tapDismissed](js-apis-inner-notification-notificationRequest.md#notificationrequest).|
-| autoDeletedTime10+ | number | No| Time when the notification is automatically cleared. The value is the same as that of [NotificationRequest.autoDeletedTime](js-apis-inner-notification-notificationRequest.md#notificationrequest).|
+| tapDismissed10+ | boolean | No| Whether the reminder is automatically cleared. For details, see [NotificationRequest.tapDismissed](js-apis-inner-notification-notificationRequest.md#notificationrequest). |
+| autoDeletedTime10+ | number | No| Time when the reminder is automatically cleared. For details, see [NotificationRequest.autoDeletedTime](js-apis-inner-notification-notificationRequest.md#notificationrequest).|
## ReminderRequestCalendar
diff --git a/en/application-dev/reference/apis/js-apis-request.md b/en/application-dev/reference/apis/js-apis-request.md
index f2eb1a5fff829317cf67affa7980deaee7c67158..9acb13cab11b2ff8458554a3bf32f67fab291f75 100644
--- a/en/application-dev/reference/apis/js-apis-request.md
+++ b/en/application-dev/reference/apis/js-apis-request.md
@@ -286,6 +286,10 @@ on(type: 'progress', callback:(uploadedSize: number, totalSize: number) => vo
Subscribes to upload progress events. This API uses a callback to return the result synchronously.
+> **NOTE**
+>
+> To maintain a balance between power consumption and performance, this API cannot be called when the application is running in the background.
+
**Required permissions**: ohos.permission.INTERNET
**System capability**: SystemCapability.MiscServices.Upload
@@ -851,6 +855,10 @@ on(type: 'progress', callback:(receivedSize: number, totalSize: number) => vo
Subscribes to download progress events. This API uses a callback to return the result synchronously.
+> **NOTE**
+>
+> To maintain a balance between power consumption and performance, this API cannot be called when the application is running in the background.
+
**Required permissions**: ohos.permission.INTERNET
**System capability**: SystemCapability.MiscServices.Download
diff --git a/en/application-dev/reference/apis/js-apis-resourceschedule-backgroundTaskManager.md b/en/application-dev/reference/apis/js-apis-resourceschedule-backgroundTaskManager.md
index d61b8272edee9b2b522139a9976df17027be98a5..99eb42bd5720fa12a833abcc030b45d02c7aefaf 100644
--- a/en/application-dev/reference/apis/js-apis-resourceschedule-backgroundTaskManager.md
+++ b/en/application-dev/reference/apis/js-apis-resourceschedule-backgroundTaskManager.md
@@ -1,16 +1,9 @@
# @ohos.resourceschedule.backgroundTaskManager (Background Task Management)
-The **BackgroundTaskManager** module provides APIs to manage background tasks.
-
-If a service needs to be continued when the application or service module is running in the background (not visible to users), the application or service module can request a transient task to delay the suspension or a continuous task to prevent the suspension.
-
-If an application has a task that needs to be continued when the application is switched to the background and can be completed within a short period of time, the application can request a transient task. For example, if a user chooses to clear junk files in the **Files** application and exits the application, the application can request a transient task to complete the cleanup.
-
-If an application has a service that can be intuitively perceived by users and needs to run in the background for a long period of time (for example, music playback in the background), the application can request a continuous task.
-
-If a privileged system application needs to use certain system resources (for example, it wants to receive common events when suspended), it can request efficiency resources.
+The **backgroundTaskManager** module provides APIs to request background tasks. You can use the APIs to request transient tasks, continuous tasks, or efficiency resources to prevent the application process from being terminated or suspended when your application is switched to the background.
> **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.
@@ -24,9 +17,11 @@ import backgroundTaskManager from '@ohos.resourceschedule.backgroundTaskManager'
requestSuspendDelay(reason: string, callback: Callback<void>): DelaySuspendInfo
-Requests delayed suspension after the application switches to the background.
+Requests a transient task.
-The default duration of delayed suspension is 3 minutes when the battery level is higher than or equal to the broadcast low battery level and 1 minute when the battery level is lower than the broadcast low battery level.
+> **NOTE**
+>
+> The maximum duration of a transient task is 3 minutes in normal cases. In the case of a [low battery](js-apis-battery-info.md), the maximum duration is decreased to 1 minute.
**System capability**: SystemCapability.ResourceSchedule.BackgroundTaskManager.TransientTask
@@ -34,14 +29,14 @@ The default duration of delayed suspension is 3 minutes when the battery level i
| Name | Type | Mandatory | Description |
| -------- | -------------------- | ---- | ------------------------------ |
-| reason | string | Yes | Reason for delayed transition to the suspended state. |
-| callback | Callback<void> | Yes | Invoked when a delay is about to time out. Generally, this callback is used to notify the application 6 seconds before the delay times out.|
+| reason | string | Yes | Reason for requesting the transient task. |
+| callback | Callback<void> | Yes | Callback used to notify the application that the transient task is about to time out. Generally, the callback is invoked 6 seconds before the timeout.|
**Return value**
| Type | Description |
| ------------------------------------- | --------- |
-| [DelaySuspendInfo](#delaysuspendinfo) | Information about the suspension delay.|
+| [DelaySuspendInfo](#delaysuspendinfo) | Information about the transient task.|
**Error codes**
@@ -80,7 +75,7 @@ For details about the error codes, see [backgroundTaskManager Error Codes](../er
getRemainingDelayTime(requestId: number, callback: AsyncCallback<number>): void
-Obtains the remaining duration before the application is suspended. This API uses an asynchronous callback to return the result.
+Obtains the remaining time of a transient task. This API uses an asynchronous callback to return the result.
**System capability**: SystemCapability.ResourceSchedule.BackgroundTaskManager.TransientTask
@@ -88,8 +83,8 @@ Obtains the remaining duration before the application is suspended. This API use
| Name | Type | Mandatory | Description |
| --------- | --------------------------- | ---- | ---------------------------------------- |
-| requestId | number | Yes | ID of the suspension delay request. |
-| callback | AsyncCallback<number> | Yes | Callback used to return the remaining duration before the application is suspended, in milliseconds.|
+| requestId | number | Yes | Request ID of the transient task. |
+| callback | AsyncCallback<number> | Yes | Callback used to return the remaining time, in milliseconds.|
**Error codes**
@@ -129,9 +124,7 @@ For details about the error codes, see [backgroundTaskManager Error Codes](../er
getRemainingDelayTime(requestId: number): Promise<number>
-Obtains the remaining duration before the application is suspended. This API uses a promise to return the result.
-
-
+Obtains the remaining time of a transient task. This API uses a promise to return the result.
**System capability**: SystemCapability.ResourceSchedule.BackgroundTaskManager.TransientTask
@@ -139,13 +132,13 @@ Obtains the remaining duration before the application is suspended. This API use
| Name | Type | Mandatory | Description |
| --------- | ------ | ---- | ---------- |
-| requestId | number | Yes | ID of the suspension delay request.|
+| requestId | number | Yes | Request ID of the transient task.|
**Return value**
| Type | Description |
| --------------------- | ---------------------------------------- |
-| Promise<number> | Promise used to return the remaining duration before the application is suspended, in milliseconds.|
+| Promise<number> | Promise used to return the remaining time, in milliseconds.|
**Error codes**
@@ -182,7 +175,7 @@ For details about the error codes, see [backgroundTaskManager Error Codes](../er
cancelSuspendDelay(requestId: number): void
-Cancels the suspension delay.
+Cancels a transient task.
**System capability**: SystemCapability.ResourceSchedule.BackgroundTaskManager.TransientTask
@@ -190,7 +183,7 @@ Cancels the suspension delay.
| Name | Type | Mandatory | Description |
| --------- | ------ | ---- | ---------- |
-| requestId | number | Yes | ID of the suspension delay request.|
+| requestId | number | Yes | Request ID of the transient task.|
**Error codes**
@@ -218,12 +211,11 @@ For details about the error codes, see [backgroundTaskManager Error Codes](../er
}
```
-
## backgroundTaskManager.startBackgroundRunning
startBackgroundRunning(context: Context, bgMode: BackgroundMode, wantAgent: WantAgent, callback: AsyncCallback<void>): void
-Requests a continuous task from the system. This API uses an asynchronous callback to return the result.
+Requests a continuous task. This API uses an asynchronous callback to return the result.
**Required permissions**: ohos.permission.KEEP_BACKGROUND_RUNNING
@@ -234,9 +226,9 @@ Requests a continuous task from the system. This API uses an asynchronous callba
| Name | Type | Mandatory | Description |
| --------- | ---------------------------------- | ---- | ---------------------------------------- |
| context | Context | Yes | Application context. | Promise used to return the result.|
+| Promise\ | Promise that returns no value.|
**Error codes**
@@ -380,7 +372,7 @@ export default class EntryAbility extends UIAbility {
stopBackgroundRunning(context: Context, callback: AsyncCallback<void>): void
-Requests to cancel a continuous task. This API uses an asynchronous callback to return the result.
+Cancels a continuous task. This API uses an asynchronous callback to return the result.
**System capability**: SystemCapability.ResourceSchedule.BackgroundTaskManager.ContinuousTask
@@ -389,7 +381,7 @@ Requests to cancel a continuous task. This API uses an asynchronous callback to
| Name | Type | Mandatory | Description |
| -------- | ------------------------- | ---- | ---------------------------------------- |
| context | Context | Yes | Application context. | Promise used to return the result.|
+| Promise\ | Promise that returns no value.|
**Error codes**
@@ -489,10 +479,9 @@ export default class EntryAbility extends UIAbility {
## backgroundTaskManager.applyEfficiencyResources
-applyEfficiencyResources(request: [EfficiencyResourcesRequest](#efficiencyresourcesrequest)): void
+applyEfficiencyResources(request: EfficiencyResourcesRequest): void
-Requests efficiency resources from the system.
-A process and its application can request the same type of resources at the same time, for example, CPU resources. When the application releases the resources, the same type of resources requested by the process are also released.
+Requests efficiency resources.
**System capability**: SystemCapability.ResourceSchedule.BackgroundTaskManager.EfficiencyResourcesApply
@@ -502,7 +491,7 @@ A process and its application can request the same type of resources at the same
| Name | Type | Mandatory | Description |
| ------- | ------- | ---- | ---------------------------------------- |
-| request | [EfficiencyResourcesRequest](#efficiencyresourcesrequest) | Yes | Necessary information carried in the request, including the resource type and timeout interval. For details, see [EfficiencyResourcesRequest](#efficiencyresourcesrequest).|
+| request | [EfficiencyResourcesRequest](#efficiencyresourcesrequest) | Yes | Necessary information carried in the request, including the resource type and timeout interval.|
**Error codes**
@@ -542,7 +531,7 @@ try {
resetAllEfficiencyResources(): void
-Releases all resources that have been requested.
+Releases all efficiency resources.
**System capability**: SystemCapability.ResourceSchedule.BackgroundTaskManager.EfficiencyResourcesApply
@@ -574,18 +563,19 @@ try {
## DelaySuspendInfo
-Provides the information about the suspension delay.
+Defines the information about the transient task.
**System capability**: SystemCapability.ResourceSchedule.BackgroundTaskManager.TransientTask
| Name | Type | Mandatory | Description |
| --------------- | ------ | ---- | ---------------------------------------- |
-| requestId | number | Yes | ID of the suspension delay request. |
-| actualDelayTime | number | Yes | Actual suspension delay duration of the application, in milliseconds.10+ | 128 | RUNNING_LOCK resources are not proxied when the application is suspended.|
| SENSOR10+ | 256 | Sensor callbacks are not intercepted.|
diff --git a/en/application-dev/reference/apis/js-apis-resourceschedule-workScheduler.md b/en/application-dev/reference/apis/js-apis-resourceschedule-workScheduler.md
index 85c085f6fb9ef65fb711aecbfe3610ab3d17f5d9..5fad64915cde48a0fe0150e83f1661bc0abb1aaa 100644
--- a/en/application-dev/reference/apis/js-apis-resourceschedule-workScheduler.md
+++ b/en/application-dev/reference/apis/js-apis-resourceschedule-workScheduler.md
@@ -1,15 +1,12 @@
# @ohos.resourceschedule.workScheduler (Deferred Task Scheduling)
-The **workScheduler** module provides the APIs for registering, canceling, and querying deferred tasks.
-
-The system schedules and executes deferred tasks at an appropriate time, subject to the storage space, power consumption, temperature, and more.
+The **workScheduler** module provides the APIs for registering, canceling, and querying deferred tasks. You can use the APIs to register tasks that do not have high requirements on real-time performance as deferred tasks. The system schedules and executes the deferred tasks at an appropriate time, subject to the storage space, power consumption, and more.
> **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.
+>
> - The APIs of this module can be used only in the stage model.
-> - For details about the constraints on deferred task scheduling, see [Constraints](../../task-management/work-scheduler.md#constraints).
-
## Modules to Import
@@ -18,9 +15,10 @@ import workScheduler from '@ohos.resourceschedule.workScheduler';
```
## workScheduler.startWork
+
startWork(work: WorkInfo): void
-Instructs the WorkSchedulerService to add a task to the execution queue.
+Starts a deferred task.
**System capability**: SystemCapability.ResourceSchedule.WorkScheduler
@@ -28,7 +26,7 @@ Instructs the WorkSchedulerService to add a task to the execution queue.
| Name | Type | Mandatory | Description |
| ---- | --------------------- | ---- | -------------- |
-| work | [WorkInfo](#workinfo) | Yes | Task to be added to the execution queue.|
+| work | [WorkInfo](#workinfo) | Yes | Deferred task to start.|
**Error codes**
@@ -42,7 +40,6 @@ For details about the error codes, see [workScheduler Error Codes](../errorcodes
| 9700004 | Check workInfo failed. |
| 9700005 | StartWork failed. |
-
**Example**
```js
@@ -69,9 +66,10 @@ For details about the error codes, see [workScheduler Error Codes](../errorcodes
```
## workScheduler.stopWork
+
stopWork(work: WorkInfo, needCancel?: boolean): void
-Instructs the WorkSchedulerService to stop a task.
+Stops a deferred task.
**System capability**: SystemCapability.ResourceSchedule.WorkScheduler
@@ -79,8 +77,8 @@ Instructs the WorkSchedulerService to stop a task.
| Name | Type | Mandatory | Description |
| ---------- | --------------------- | ---- | ---------- |
-| work | [WorkInfo](#workinfo) | Yes | Task to stop. |
-| needCancel | boolean | No | Whether to cancel the task. The default value is **false**.|
+| work | [WorkInfo](#workinfo) | Yes | Deferred task to stop.|
+| needCancel | boolean | No | Whether to clear the task while stopping it.): void
-Obtains the latest task status. This API uses an asynchronous callback to return the result.
+Obtains the information a deferred task. This API uses an asynchronous callback to return the result.
**System capability**: SystemCapability.ResourceSchedule.WorkScheduler
@@ -129,8 +128,8 @@ Obtains the latest task status. This API uses an asynchronous callback to return
| Name | Type | Mandatory | Description |
| -------- | ------------------------------------- | ---- | ---------------------------------------- |
-| workId | number | Yes | Task ID. |
-| callback | AsyncCallback\<[WorkInfo](#workinfo)> | Yes | Callback used to return the result. If the specified task ID is valid, the task status obtained from the WorkSchedulerService is returned. Otherwise, an exception is thrown.|
+| workId | number | Yes | ID of the deferred task. |
+| callback | AsyncCallback\<[WorkInfo](#workinfo)> | Yes | Callback used to return the result. If **workId** is valid, the task information obtained from WorkSchedulerService is returned. Otherwise, an exception is thrown.|
**Error codes**
@@ -162,9 +161,10 @@ For details about the error codes, see [workScheduler Error Codes](../errorcodes
```
## workScheduler.getWorkStatus
+
getWorkStatus(workId: number): Promise\
-Obtains the latest task status. This API uses a promise to return the result.
+Obtains the information a deferred task. This API uses a promise to return the result.
**System capability**: SystemCapability.ResourceSchedule.WorkScheduler
@@ -172,13 +172,13 @@ Obtains the latest task status. This API uses a promise to return the result.
| Name | Type | Mandatory | Description |
| ------ | ------ | ---- | -------- |
-| workId | number | Yes | Task ID.|
+| workId | number | Yes | ID of the deferred task.|
**Return value**
| Type | Description |
| ------------------------------- | ---------------------------------------- |
-| Promise\<[WorkInfo](#workinfo)> | Promise used to return the result. If the specified task ID is valid, the task status obtained from the WorkSchedulerService is returned. Otherwise, an exception is thrown.|
+| Promise\<[WorkInfo](#workinfo)> | Promise used to return the result. If **workId** is valid, the task information obtained from WorkSchedulerService is returned.|
**Error codes**
@@ -208,9 +208,10 @@ For details about the error codes, see [workScheduler Error Codes](../errorcodes
```
## workScheduler.obtainAllWorks
+
obtainAllWorks(callback : AsyncCallback\): Array\
-Obtains all tasks associated with the application. This API uses an asynchronous callback to return the result.
+Obtains all the deferred tasks. This API uses an asynchronous callback to return the result.
**System capability**: SystemCapability.ResourceSchedule.WorkScheduler
@@ -218,13 +219,13 @@ Obtains all tasks associated with the application. This API uses an asynchronous
| Name | Type | Mandatory | Description |
| -------- | -------------------- | ---- | ------------------------------- |
-| callback | AsyncCallback\ | Yes | Callback used to return the result. |
+| callback | AsyncCallback\ | Yes | Callback used to return the result. If all the deferred tasks are obtained, **err** is **undefined**. Otherwise, **err** is an error object.|
**Return value**
| Type | Description |
| ----------------------------- | --------------- |
-| Array\<[WorkInfo](#workinfo)> | All tasks associated with the application.|
+| Array\<[WorkInfo](#workinfo)> | All the deferred tasks.|
**Error codes**
@@ -253,9 +254,10 @@ For details about the error codes, see [workScheduler Error Codes](../errorcodes
```
## workScheduler.obtainAllWorks
+
obtainAllWorks(): Promise\>
-Obtains all tasks associated with the application. This API uses a promise to return the result.
+Obtains all the deferred tasks. This API uses a promise to return the result.
**System capability**: SystemCapability.ResourceSchedule.WorkScheduler
@@ -263,7 +265,7 @@ Obtains all tasks associated with the application. This API uses a promise to re
| Type | Description |
| -------------------------------------- | ------------------------------ |
-| Promise> | Promise used to return all tasks associated with the application.|
+| Promise> | Promise used to return all the deferred tasks.|
**Error codes**
@@ -290,9 +292,10 @@ For details about the error codes, see [workScheduler Error Codes](../errorcodes
```
## workScheduler.stopAndClearWorks
+
stopAndClearWorks(): void
-Stops and cancels all tasks associated with the application.
+Stops and clears all the deferred tasks.
**System capability**: SystemCapability.ResourceSchedule.WorkScheduler
@@ -318,6 +321,7 @@ For details about the error codes, see [workScheduler Error Codes](../errorcodes
```
## workScheduler.isLastWorkTimeOut
+
isLastWorkTimeOut(workId: number, callback : AsyncCallback\): boolean
Checks whether the last execution of a task timed out. This API uses an asynchronous callback to return the result.
@@ -328,14 +332,14 @@ Checks whether the last execution of a task timed out. This API uses an asynchro
| Name | Type | Mandatory | Description |
| -------- | -------------------- | ---- | ---------------------------------------- |
-| workId | number | Yes | Task ID. |
-| callback | AsyncCallback\ | Yes | Callback used to return the result. |
+| workId | number | Yes | ID of the deferred task. |
+| callback | AsyncCallback\ | Yes | Callback used to return the result.|
**Return value**
| Type | Description |
| ------- | ---------------------------------------- |
-| boolean | Returns **true** if the last execution of the task timed out; returns **false** otherwise.|
+| boolean | The value **true** means that the last execution of the specified task times out, and **false** means the opposite.|
**Error codes**
@@ -365,6 +369,7 @@ For details about the error codes, see [workScheduler Error Codes](../errorcodes
```
## workScheduler.isLastWorkTimeOut
+
isLastWorkTimeOut(workId: number): Promise\
Checks whether the last execution of a task timed out. This API uses a promise to return the result.
@@ -375,13 +380,13 @@ Checks whether the last execution of a task timed out. This API uses a promise t
| Name | Type | Mandatory | Description |
| ------ | ------ | ---- | -------- |
-| workId | number | Yes | Task ID.|
+| workId | number | Yes | ID of the deferred task.|
**Return value**
| Type | Description |
| ----------------- | ---------------------------------------- |
-| Promise\ | Promise used to return the result. If the last execution of the task timed out, **true** is returned. Otherwise, **false** is returned.|
+| Promise\ | Promise used to return the result. The value **true** means that the last execution of the specified task times out, and **false** means the opposite.|
**Error codes**
@@ -411,31 +416,33 @@ For details about the error codes, see [workScheduler Error Codes](../errorcodes
```
## WorkInfo
-Provides detailed information about the task. For details about the constraints on setting the **WorkInfo** parameter, see [Constraints](../../task-management/work-scheduler.md#constraints).
+
+Defines the information about the deferred task.
**System capability**: SystemCapability.ResourceSchedule.WorkScheduler
| Name | Type | Mandatory | Description |
| --------------- | --------------------------------- | ---- | ---------------- |
-| workId | number | Yes | Task ID. |
+| workId | number | Yes | ID of the deferred task. |
| bundleName | string | Yes | Bundle name of the application that requests the task. |
| abilityName | string | Yes | Name of the component to be notified by a deferred task scheduling callback.|
| networkType | [NetworkType](#networktype) | No | Network type. |
-| isCharging | boolean | No | Whether the device is charging. |
+| isCharging | boolean | No | Whether the device needs to enter the charging state to trigger deferred task scheduling.
-This API uses an asynchronous callback to return the result. This API uses a promise to return the result.
+Checks whether SMS is supported on IMS. This API uses a promise to return the result.
**System API**: This is a system API.
diff --git a/en/application-dev/reference/apis/js-apis-socket.md b/en/application-dev/reference/apis/js-apis-socket.md
index 76c7829cf8fdadad378305ba795212ac10f621ea..f193ed010e3b0eb1ba6a87fad70f81b19bf9b732 100644
--- a/en/application-dev/reference/apis/js-apis-socket.md
+++ b/en/application-dev/reference/apis/js-apis-socket.md
@@ -1691,7 +1691,7 @@ listen(address: NetAddress, callback: AsyncCallback\): void
Binds the IP address and port number. The port number can be specified or randomly allocated by the system. The server listens to and accepts TCP socket connections established over the socket. Multiple threads are used to process client data concurrently. This API uses an asynchronous callback to return the result.
-> **NOTE**
+> **NOTE**
Binds the IP address and port number. The port number can be specified or randomly allocated by the system. The server listens to and accepts TCP socket connections established over the socket. Multiple threads are used to process client data concurrently. This API uses a promise to return the result.
-> **NOTE**
+> **NOTE**7+
-requestFullWindow(options?: RequestFullWindowOptions): void
-
-Requests the application to run in full window. You can call this API when the FA runs in a non-full window, for example, semi-modal FA. This API is invalid for an application already in full-window mode.
-
-You are advised to use [@ohos.window](js-apis-window.md) since API version 7.
-
-**System capability**: SystemCapability.ArkUI.ArkUI.Full
-
-**Parameters**
-
-| Name| Type| Mandatory| Description|
-| -------- | -------- | -------- | -------- |
-| options | [RequestFullWindowOptions](#requestfullwindowoptions) | No| Duration for transition from the non-full window to the full window, in milliseconds. By default, the value is in direct proportion to the distance between the non-full window and the full window.|
-
-**Example**
-
-```ts
-export default {
- requestFullWindow() {
- app.requestFullWindow({
- duration: 200
- })
- }
-}
-```
-
-## app.setImageCacheCount7+
-
-setImageCacheCount(value: number): void
+static setImageCacheCount(value: number): void
Sets the maximum number of decoded images that can be cached in the memory to speed up the loading of images from the same sources. If the input parameter is not set, the default value **0** is used, indicating that images are not cached. The built-in Least Recently Used (LRU) policy is used for caching. If the maximum number is exceeded, the images that have not been updated for the longest time will be removed. You are advised to set the parameter based on the application memory requirements. If the number of images is too large, the memory usage may be too high.
@@ -120,9 +91,9 @@ export default {
}
```
-## app.setImageRawDataCacheSize7+
+### setImageRawDataCacheSize7+
-setImageRawDataCacheSize(value: number): void
+static setImageRawDataCacheSize(value: number): void
Sets the maximum size (in bytes) of the image data cached in the memory before decoding to speed up the loading of images from the same sources. If the input parameter is not set, the default value **0** is used, indicating that images are not cached. The LRU policy is used for caching. If the maximum size is exceeded, the images that have not been updated for the longest time will be removed. You are advised to set the parameter based on the application memory requirements. If the image cache is too large, the memory usage may be too high.
@@ -152,9 +123,9 @@ export default {
}
```
-## app.setImageFileCacheSize7+
+### setImageFileCacheSize7+
-setImageFileCacheSize(value: number): void
+static setImageFileCacheSize(value: number): void
Sets the maximum size of the image file cache (in bytes) to speed up the loading of images from the same sources, especially online image sources and thumbnails. If the input parameter is not set, the default value 100 MB is used. The LRU policy is used for caching. If the maximum size is exceeded, the images that have not been updated for the longest time will be removed. You are advised to set the parameter based on the application memory requirements. If the image cache is too large, the disk usage may be too high.
@@ -184,32 +155,60 @@ export default {
}
```
-## AppResponse
+### ScreenOnVisible(deprecated)
-Defines the application response information.
+static screenOnVisible(options?: ScreenOnVisibleOptions): void
-**System capability**: The items in the table below require different system capabilities. For details, see the table.
+Defines whether to keep the application visible when the screen is woken up.
-| Name| Type| Mandatory| Description|
-| -------- | -------- | -------- |-------- |
-| appID6+ | string | Yes| Bundle name of an application. It uniquely identifies the application.(deprecated)
+**System capability**: SystemCapability.ArkUI.ArkUI.Full
-screenOnVisible(options?: ScreenOnVisibleOptions): void
+| Name | Type | Mandatory| Description |
+| ------- | ------------------------------------------------- | ---- | ------------------------------------------------------------ |
+| options | [ScreenOnVisibleOptions](#screenonvisibleoptions) | No | With keep-alive, the system is prevented from returning to the home screen when the screen is locked, so that the application is visible when the screen is woken up.|
-Defines whether to keep the application visible when the screen is woken up.
+### requestFullWindow(deprecated)
-This API is deprecated since API Version 8.
+static requestFullWindow(options?: RequestFullWindowOptions): void
+
+Requests the application to run in full window. You can call this API when the FA runs in a non-full window, for example, semi-modal FA. This API is invalid for an application already in full-window mode.
+
+You are advised to use [@ohos.window](js-apis-window.md) since API version 7.
**System capability**: SystemCapability.ArkUI.ArkUI.Full
+**Parameters**
+
+| Name | Type | Mandatory| Description |
+| ------- | ----------------------------------------------------- | ---- | ------------------------------------------------------------ |
+| options | [RequestFullWindowOptions](#requestfullwindowoptions) | No | Duration for transition from the non-full window to the full window, in milliseconds. By default, the value is in direct proportion to the distance between the non-full window and the full window.|
+
+**Example**
+
+```ts
+export default {
+ requestFullWindow() {
+ app.requestFullWindow({
+ duration: 200
+ })
+ }
+}
+```
+
+## AppResponse
+
+Defines the application response information.
+
+**System capability**: The items in the table below require different system capabilities. For details, see the table.
+
| Name| Type| Mandatory| Description|
| -------- | -------- | -------- |-------- |
-| options | ScreenOnVisibleOptions | No| With keep-alive, the system is prevented from returning to the home screen when the screen is locked, so that the application is visible when the screen is woken up. |
+| appID6+ | string | Yes| Bundle name of an application. It uniquely identifies the application.10+
+
+getPhotoIndex(photoUri: string, albumUri: string, options: FetchOptions, callback: AsyncCallback<number>): void
+
+Obtains the index of an image or video in an album. This API uses an asynchronous callback to return the result.
+
+**System API**: This is a system API.
+
+**Required permissions**: ohos.permission.READ_IMAGEVIDEO
+
+**System capability**: SystemCapability.FileManagement.UserFileManager.Core
+
+**Parameters**
+
+| Name | Type | Mandatory| Description |
+| -------- | ------------------------- | ---- | ---------- |
+| photoUri | string | Yes | URI of the media asset whose index is to be obtained.|
+| albumUri | string | Yes | Album URI, which can be an empty string. If it is an empty string, all the media assets in the Gallery are obtained by default. |
+| options | [FetchOptions](#fetchoptions) | Yes | Fetch options. Only one search condition or sorting mode must be set in **predicates**. If no value is set or multiple search conditions or sorting modes are set, the API cannot be called successfully. |
+
+**Return value**
+
+| Type | Description |
+| --------------------------------------- | ----------------- |
+| AsyncCallback<number>| Callback invoked to return the index obtained.|
+
+**Error codes**
+
+For details about the error codes, see [Universal Error Codes](../errorcodes/errorcode-universal.md).
+
+| ID| Error Message|
+| -------- | ---------------------------------------- |
+| 401 | if parameter is invalid. |
+
+**Example**
+
+```ts
+import dataSharePredicates from '@ohos.data.dataSharePredicates';
+
+async function example() {
+ console.info('getPhotoIndexDemo');
+ let predicatesForGetAsset = new dataSharePredicates.DataSharePredicates();
+ let fetchOp = {
+ fetchColumns: [],
+ predicates: predicatesForGetAsset
+ };
+ //Obtain the uri of the album
+ let albumFetchResult = await mgr.getAlbums(userFileManager.AlbumType.SYSTEM, userFileManager.AlbumSubtype.FAVORITE, fetchOp);
+ let album = await albumFetchResult.getFirstObject();
+
+ let predicates = new dataSharePredicates.DataSharePredicates();
+ predicates.orderByAsc("add_modified");
+ let fetchOptions = {
+ fetchColumns: [],
+ predicates: predicates
+ };
+ let photoFetchResult = await album.getPhotoAssets(fetchOptions);
+ let expectIndex = 1;
+ //Obtain the uri of the second file
+ let photoAsset = await photoFetchResult.getPositionObject(expectIndex);
+
+ mgr.getPhotoIndex(photoAsset.uri, album.albumUri, fetchOptions, (err, index) => {
+ try {
+ if (err == undefined) {
+ console.info(`getPhotoIndex successfully and index is : ${index}`);
+ } else {
+ console.info(`getPhotoIndex failed;`);
+ }
+ } catch (error) {
+ console.info(`getPhotoIndex failed; error: ${error}`);
+ }
+ }
+}
+```
+
+### getPhotoIndex10+
+
+getPhotoIndex(photoUri: string, albumUri: string, options: FetchOptions): Promise<number>
+
+Obtains the index of an image or video in an album. This API uses a promise to return the result.
+
+**System API**: This is a system API.
+
+**Required permissions**: ohos.permission.READ_IMAGEVIDEO
+
+**System capability**: SystemCapability.FileManagement.UserFileManager.Core
+
+**Parameters**
+
+| Name | Type | Mandatory| Description |
+| -------- | ------------------------- | ---- | ---------- |
+| photoUri | string | Yes | URI of the media asset whose index is to be obtained.|
+| albumUri | string | Yes | Album URI, which can be an empty string. If it is an empty string, all the media assets in the Gallery are obtained by default. |
+| options | [FetchOptions](#fetchoptions) | Yes | Fetch options. Only one search condition or sorting mode must be set in **predicates**. If no value is set or multiple search conditions or sorting modes are set, the API cannot be called successfully. |
+
+**Return value**
+
+| Type | Description |
+| --------------------------------------- | ----------------- |
+| Promise<number>| Promise used to return the index obtained.|
+
+**Error codes**
+
+For details about the error codes, see [Universal Error Codes](../errorcodes/errorcode-universal.md).
+
+| ID| Error Message|
+| -------- | ---------------------------------------- |
+| 401 | if parameter is invalid. |
+
+**Example**
+
+```ts
+import dataSharePredicates from '@ohos.data.dataSharePredicates';
+
+async function example() {
+ console.info('getPhotoIndexDemo');
+ let predicatesForGetAsset = new dataSharePredicates.DataSharePredicates();
+ let fetchOp = {
+ fetchColumns: [],
+ predicates: predicatesForGetAsset
+ };
+ //Obtain the uri of the album
+ let albumFetchResult = await mgr.getAlbums(userFileManager.AlbumType.SYSTEM, userFileManager.AlbumSubtype.FAVORITE, fetchOp);
+ let album = await albumFetchResult.getFirstObject();
+
+ let predicates = new dataSharePredicates.DataSharePredicates();
+ predicates.orderByAsc("add_modified");
+ let fetchOptions = {
+ fetchColumns: [],
+ predicates: predicates
+ };
+ let photoFetchResult = await album.getPhotoAssets(fetchOptions);
+ let expectIndex = 1;
+ //Obtain the uri of the second file
+ let photoAsset = await photoFetchResult.getPositionObject(expectIndex);
+
+ mgr.getPhotoIndex(photoAsset.uri, album.albumUri, fetchOptions)
+ .then((index) => {
+ console.info(`getPhotoIndex successfully and index is : ${index}`);
+ }).catch((err) => {
+ console.info(`getPhotoIndex failed; error: ${err}`);
+ })
+}
+```
+
### release
release(callback: AsyncCallback<void>): void
@@ -1684,7 +1829,7 @@ Provides APIs for encapsulating file asset attributes.
| Name | Type | Readable| Writable| Description |
| ------------------------- | ------------------------ | ---- | ---- | ------------------------------------------------------ |
-| uri | string | Yes | No | File asset URI, for example, **file://media/image/2**. |
+| uri | string | Yes | No | File asset URI, for example, **file://media/Photo/1/IMG_datetime_0001/displayName.jpg**. |
| fileType | [FileType](#filetype) | Yes | No | Type of the file. |
| displayName | string | Yes | Yes | File name, including the file name extension, to display. |
@@ -2350,6 +2495,282 @@ async function example() {
}
```
+### getExif10+
+
+getExif(): Promise<string>
+
+Obtains a JSON string consisting of the exchangeable image file format (EXIF) tags of this JPG image. This API uses a promise to return the result.
+
+**CAUTION**10+
+
+getExif(callback: AsyncCallback<string>): void
+
+Obtains a JSON string consisting of the EXIF tags of this JPG image. This API uses an asynchronous callback to return the result.
+
+**CAUTION**10+
+
+setUserComment(userComment: string): Promise<void>
+
+Sets user comment information of an image or video. This API uses a promise to return the result.
+
+**NOTE**10+
+
+setUserComment(userComment: string, callback: AsyncCallback<void>): void
+
+Sets user comment information of an image or video. This API uses an asynchronous callback to return the result.
+
+**NOTE**10+ | date_trashed | Date when the file was deleted. The value is the number of seconds between the time when the file is deleted and January 1, 1970. |
| HIDDEN10+ | hidden | Whether the file is hidden. |
| CAMERA_SHOT_KEY10+ | camera_shot_key | Key for the Untra Snamshot feature, which allows the camera to take photos or record videos with the screen off. (This parameter is available only for the system camera, and the key value is defined by the system camera.) |
+| USER_COMMENT10+ | user_comment | User comment information. |
## AlbumKey
diff --git a/en/application-dev/reference/apis/js-apis-useriam-userauth.md b/en/application-dev/reference/apis/js-apis-useriam-userauth.md
index a5771cf5e7764cb73b3f8184b52306b40bbe07bc..84dacee24d644d4f87ecf5eb41ba3b0befaf811d 100644
--- a/en/application-dev/reference/apis/js-apis-useriam-userauth.md
+++ b/en/application-dev/reference/apis/js-apis-useriam-userauth.md
@@ -1054,7 +1054,7 @@ Checks whether the specified authentication capability is supported.
| Name | Type | Mandatory| Description |
| -------------- | ---------------------------------- | ---- | -------------------------- |
-| authType | [UserAuthType](#userauthtype8) | Yes | Authentication type. Only **FACE** is supported.|
+| authType | [UserAuthType](#userauthtype8) | Yes | Authentication type.|
| authTrustLevel | [AuthTrustLevel](#authtrustlevel8) | Yes | Authentication trust level. |
**Error codes**
diff --git a/en/application-dev/reference/apis/js-apis-webview.md b/en/application-dev/reference/apis/js-apis-webview.md
index adea4c22a9473f43b8092d0314918537ecaa98b6..d0b51d00e6ddb980ac95cdeeb8a20de3db84c1a7 100644
--- a/en/application-dev/reference/apis/js-apis-webview.md
+++ b/en/application-dev/reference/apis/js-apis-webview.md
@@ -254,20 +254,20 @@ struct WebComponent {
.onClick(() => {
// Use the local port to send messages to HTML5.
try {
- console.log("In eTS side send true start");
+ console.log("In ArkTS side send true start");
if (this.nativePort) {
this.message.setString("helloFromEts");
this.nativePort.postMessageEventExt(this.message);
}
}
catch (error) {
- console.log("In eTS side send message catch error:" + error.code + ", msg:" + error.message);
+ console.log("In ArkTS side send message catch error:" + error.code + ", msg:" + error.message);
}
})
Web({ src: $rawfile('index.html'), controller: this.controller })
.onPageEnd((e)=>{
- console.log("In eTS side message onPageEnd init mesaage channel");
+ console.log("In ArkTS side message onPageEnd init mesaage channel");
// 1. Create a message port.
this.ports = this.controller.createWebMessagePorts(true);
// 2. Send port 1 to HTML5.
@@ -276,10 +276,10 @@ struct WebComponent {
this.nativePort = this.ports[0];
// 4. Set the callback.
this.nativePort.onMessageEventExt((result) => {
- console.log("In eTS side got message");
+ console.log("In ArkTS side got message");
try {
var type = result.getType();
- console.log("In eTS side getType:" + type);
+ console.log("In ArkTS side getType:" + type);
switch (type) {
case web_webview.WebMessageType.STRING: {
this.msg1 = "result type:" + typeof (result.getString());
@@ -652,71 +652,71 @@ struct WebComponent {
There are three methods for loading local resource files:
1. Using $rawfile
- ```ts
- // xxx.ets
- import web_webview from '@ohos.web.webview'
-
- @Entry
- @Component
- struct WebComponent {
- controller: web_webview.WebviewController = new web_webview.WebviewController();
-
- build() {
- Column() {
- Button('loadUrl')
- .onClick(() => {
- try {
- // Load a local resource file through $rawfile.
- this.controller.loadUrl($rawfile('index.html'));
- } catch (error) {
- console.error(`ErrorCode: ${error.code}, Message: ${error.message}`);
- }
- })
- Web({ src: 'www.example.com', controller: this.controller })
- }
- }
- }
- ```
+```ts
+// xxx.ets
+import web_webview from '@ohos.web.webview'
+
+@Entry
+@Component
+struct WebComponent {
+ controller: web_webview.WebviewController = new web_webview.WebviewController();
+
+ build() {
+ Column() {
+ Button('loadUrl')
+ .onClick(() => {
+ try {
+ // Load a local resource file through $rawfile.
+ this.controller.loadUrl($rawfile('index.html'));
+ } catch (error) {
+ console.error(`ErrorCode: ${error.code}, Message: ${error.message}`);
+ }
+ })
+ Web({ src: 'www.example.com', controller: this.controller })
+ }
+ }
+}
+```
2. Using the resources protocol
- ```ts
- // xxx.ets
- import web_webview from '@ohos.web.webview'
-
- @Entry
- @Component
- struct WebComponent {
- controller: web_webview.WebviewController = new web_webview.WebviewController();
-
- build() {
- Column() {
- Button('loadUrl')
- .onClick(() => {
- try {
- // Load a local resource file through the resource protocol.
- this.controller.loadUrl("resource://rawfile/index.html");
- } catch (error) {
- console.error(`ErrorCode: ${error.code}, Message: ${error.message}`);
- }
- })
- Web({ src: 'www.example.com', controller: this.controller })
- }
- }
- }
- ```
+```ts
+// xxx.ets
+import web_webview from '@ohos.web.webview'
+
+@Entry
+@Component
+struct WebComponent {
+ controller: web_webview.WebviewController = new web_webview.WebviewController();
+
+ build() {
+ Column() {
+ Button('loadUrl')
+ .onClick(() => {
+ try {
+ // Load local resource files through the resource protocol.
+ this.controller.loadUrl("resource://rawfile/index.html");
+ } catch (error) {
+ console.error(`ErrorCode: ${error.code}, Message: ${error.message}`);
+ }
+ })
+ Web({ src: 'www.example.com', controller: this.controller })
+ }
+ }
+}
+```
3. Using a sandbox path. For details, see the example of loading local resource files in the sandbox in [Web](../arkui-ts/ts-basic-components-web.md#web).
- HTML file to be loaded:
- ```html
-
-
-
-
- Hello World
-
-
- ```
+HTML file to be loaded:
+```html
+
+
+
+
+ Hello World
+
+
+```
### loadData
@@ -4320,6 +4320,107 @@ export default class EntryAbility extends UIAbility {
}
```
+### setCustomUserAgent10+
+
+setCustomUserAgent(userAgent: string): void
+
+Set a custom user agent.
+
+**System capability**: SystemCapability.Web.Webview.Core
+
+**Parameters**
+
+| Name | Type | Mandatory | Description |
+| ---------------| ------- | ---- | ------------- |
+| userAgent | string | Yes | Information about the custom user agent.|
+
+**Error codes**
+
+For details about the error codes, see [Webview Error Codes](../errorcodes/errorcode-webview.md).
+
+| ID | Error Message |
+| -------- | ------------------------------------------------------------ |
+| 17100001 | Init error. The WebviewController must be associated with a Web component. |
+
+**Example**
+
+```ts
+// xxx.ets
+import web_webview from '@ohos.web.webview'
+
+@Entry
+@Component
+struct WebComponent {
+ controller: web_webview.WebviewController = new web_webview.WebviewController();
+ @State userAgent: string = 'test'
+
+ build() {
+ Column() {
+ Button('setCustomUserAgent')
+ .onClick(() => {
+ try {
+ this.controller.setCustomUserAgent(this.userAgent);
+ } catch (error) {
+ console.error(`ErrorCode: ${error.code}, Message: ${error.message}`);
+ }
+ })
+ Web({ src: 'www.example.com', controller: this.controller })
+ }
+ }
+}
+```
+
+### getCustomUserAgent10+
+
+getCustomUserAgent(): string
+
+Obtains a custom user agent.
+
+**System capability**: SystemCapability.Web.Webview.Core
+
+**Return value**
+
+| Type | Description |
+| ------ | ------------------------- |
+| string | Information about the custom user agent.|
+
+**Error codes**
+
+For details about the error codes, see [Webview Error Codes](../errorcodes/errorcode-webview.md).
+
+| ID | Error Message |
+| -------- | ------------------------------------------------------------ |
+| 17100001 | Init error. The WebviewController must be associated with a Web component. |
+
+**Example**
+
+```ts
+// xxx.ets
+import web_webview from '@ohos.web.webview'
+
+@Entry
+@Component
+struct WebComponent {
+ controller: web_webview.WebviewController = new web_webview.WebviewController();
+ @State userAgent: string = ''
+
+ build() {
+ Column() {
+ Button('getCustomUserAgent')
+ .onClick(() => {
+ try {
+ this.userAgent = this.controller.getCustomUserAgent();
+ console.log("userAgent: " + this.userAgent);
+ } catch (error) {
+ console.error(`ErrorCode: ${error.code}, Message: ${error.message}`);
+ }
+ })
+ Web({ src: 'www.example.com', controller: this.controller })
+ }
+ }
+}
+```
+
## WebCookieManager
Implements a **WebCookieManager** instance to manage behavior of cookies in **\** components. All **\** components in an application share a **WebCookieManager** instance.
diff --git a/en/application-dev/reference/apis/js-apis-wifiManager.md b/en/application-dev/reference/apis/js-apis-wifiManager.md
index d0a5734d47b2ada35e5d4dae36770cd58873769f..3b5ccb266a60c098525e6690e1dce15e3c1e137b 100644
--- a/en/application-dev/reference/apis/js-apis-wifiManager.md
+++ b/en/application-dev/reference/apis/js-apis-wifiManager.md
@@ -15,7 +15,7 @@ import wifiManager from '@ohos.wifiManager';
enableWifi(): void
-Enables WLAN.
+Enables WLAN. This API is an asynchronous interface. The **wifiStateChange** callback must be registered and listened for.
**System API**: This is a system API.
@@ -47,7 +47,7 @@ For details about the error codes, see [Wi-Fi Error Codes](../errorcodes/errorco
disableWifi(): void
-Disables WLAN.
+Disables WLAN. This API is an asynchronous interface. The **wifiStateChange** callback must be registered and listened for.
**System API**: This is a system API.
@@ -583,7 +583,7 @@ Adds network configuration. This API uses a promise to return the result.
| **Type**| **Description**|
| -------- | -------- |
-| Promise<number> | Promise used to return the ID of the added network configuration. If **-1** is returned, the network configuration fails to be added.|
+ | Promise<number> | Promise used to return the ID of the added network configuration. If **-1** is returned, the network configuration fails to be added.|
**Error codes**
@@ -959,7 +959,7 @@ Removes the configuration of a candidate network. This API uses an asynchronous
| **Name**| **Type**| **Mandatory**| **Description**|
| -------- | -------- | -------- | -------- |
| networkId | number | Yes| ID of the network configuration to remove.|
-| callback | AsyncCallback<void> | Yes| Callback invoked to return the result. If the operation is successful, the value of **err** is **0**. If **err** is not **0**, an error has occurred.|
+ | callback | AsyncCallback<void> | Yes| Callback invoked to return the result. If the operation is successful, the value of **err** is **0**. If **err** is not **0**, an error has occurred.|
**Error codes**
@@ -2082,7 +2082,7 @@ Enumerates the Wi-Fi disconnection reasons.
enableHotspot(): void
-Enables this hotspot.
+Enables this hotspot. This API is an asynchronous interface. The **hotspotStateChange** callback must be registered and listened for.
**System API**: This is a system API.
@@ -2113,7 +2113,7 @@ For details about the error codes, see [Wi-Fi Error Codes](../errorcodes/errorco
disableHotspot(): void
-Disables this hotspot.
+Disables this hotspot. This API is an asynchronous interface. The **hotspotStateChange** callback must be registered and listened for.
**System API**: This is a system API.
diff --git a/en/application-dev/reference/arkui-js-lite/Readme-EN.md b/en/application-dev/reference/arkui-js-lite/Readme-EN.md
index 4dbc7b08dbed8356f7cb907c3dbebff5c5b09bf5..82d21c003828d6a374fa9aeef402169fe4c0d0d5 100644
--- a/en/application-dev/reference/arkui-js-lite/Readme-EN.md
+++ b/en/application-dev/reference/arkui-js-lite/Readme-EN.md
@@ -1,37 +1,38 @@
# JavaScript-compatible Web-like Development Paradigm (ArkUI.Lite)
- Framework Overview
- - [File Organization](js-framework-file.md)
- - ["js" Tag](js-framework-js-tag.md)
- - [app.js](js-framework-js-file.md)
- - Syntax
- - [HML](js-framework-syntax-hml.md)
- - [CSS](js-framework-syntax-css.md)
- - [JavaScript](js-framework-syntax-js.md)
+ - [File Organization](js-framework-file.md)
+ - ["js" Tag](js-framework-js-tag.md)
+ - [app.js](js-framework-js-file.md)
+
+ - Syntax
+ - [HML](js-framework-syntax-hml.md)
+ - [CSS](js-framework-syntax-css.md)
+ - [JavaScript](js-framework-syntax-js.md)
- Universal Component Information
- - [Universal Events](js-common-events.md)
- - [Universal Attributes](js-common-attributes.md)
- - [Universal Styles](js-common-styles.md)
- - [Animation Styles](js-components-common-animation.md)
- - [Media Query](js-components-common-mediaquery.md)
+ - [Universal Events](js-common-events.md)
+ - [Universal Attributes](js-common-attributes.md)
+ - [Universal Styles](js-common-styles.md)
+ - [Animation Styles](js-components-common-animation.md)
+ - [Media Query](js-components-common-mediaquery.md)
- Container Components
- - [div](js-components-container-div.md)
- - [list](js-components-container-list.md)
- - [list-item](js-components-container-list-item.md)
- - [stack](js-components-container-stack.md)
- - [swiper](js-components-container-swiper.md)
+ - [div](js-components-container-div.md)
+ - [list](js-components-container-list.md)
+ - [list-item](js-components-container-list-item.md)
+ - [stack](js-components-container-stack.md)
+ - [swiper](js-components-container-swiper.md)
- Basic Components
- - [chart](js-components-basic-chart.md)
- - [image](js-components-basic-image.md)
- - [image-animator](js-components-basic-image-animator.md)
- - [input](js-components-basic-input.md)
- - [marquee](js-components-basic-marquee.md)
- - [picker-view](js-components-basic-picker-view.md)
- - [progress](js-components-basic-progress.md)
- - [qrcode](js-components-basic-qrcode.md)
- - [slider](js-components-basic-slider.md)
- - [switch](js-components-basic-switch.md)
- - [text](js-components-basic-text.md)
+ - [chart](js-components-basic-chart.md)
+ - [image](js-components-basic-image.md)
+ - [image-animator](js-components-basic-image-animator.md)
+ - [input](js-components-basic-input.md)
+ - [marquee](js-components-basic-marquee.md)
+ - [picker-view](js-components-basic-picker-view.md)
+ - [progress](js-components-basic-progress.md)
+ - [qrcode](js-components-basic-qrcode.md)
+ - [slider](js-components-basic-slider.md)
+ - [switch](js-components-basic-switch.md)
+ - [text](js-components-basic-text.md)
- Canvas Components
- - [canvas](js-components-canvas-canvas.md)
- - [CanvasRenderingContext2D](js-components-canvas-canvasrenderingcontext2d.md)
+ - [canvas](js-components-canvas-canvas.md)
+ - [CanvasRenderingContext2D](js-components-canvas-canvasrenderingcontext2d.md)
\ No newline at end of file
diff --git a/en/application-dev/reference/arkui-js-lite/js-framework-syntax-js.md b/en/application-dev/reference/arkui-js-lite/js-framework-syntax-js.md
index e9d71fc2ff680dfba5b95e7bae676854a1e68a28..8d1153d3bdaec49a99abcf0512613b3bb5f9b03c 100644
--- a/en/application-dev/reference/arkui-js-lite/js-framework-syntax-js.md
+++ b/en/application-dev/reference/arkui-js-lite/js-framework-syntax-js.md
@@ -33,7 +33,7 @@ The ECMAScript 6.0 syntax is supported. Lite wearables only support the followin
```
- import router from '@system.router';
+ import router from '@ohos.router';
```
- Code reference
@@ -51,7 +51,7 @@ The ECMAScript 6.0 syntax is supported. Lite wearables only support the followin
| Attribute | Type | Description |
| ----- | --------------- | ---------------------------------------- |
| data | Object/Function | Data model of the page. If the attribute is of the function type, the return value must be of the object type. The name cannot start with a dollar sign ($) or underscore (_). Do not use reserved words (**for**, **if**, **show**, and **tid**).9+ | No | Animation curve. The default curve is linear.9+ | No | Animation curve.10+ | Called when the navigation destination page is displayed. **param**: parameter information of the navigation destination page.10+ | Called when the navigation destination page is hidden.|
-| onBackPressed(callback: () => boolean)10+ | Called when the back button is pressed.10+ | Called when the navigation destination page is displayed. |
+| onHidden(callback: () => void)10+ | Called when the navigation destination page is hidden. |
+| onBackPressed(callback: () => boolean)10+ | Called when the back button is pressed.](ts-basic-components-navrouter.md)** component.
-
## APIs
-**API 1**: Navigation()
+### Navigation
+
+Navigation()
+
+### Navigation10+
-**API 2**: Navigation(pathInfos: NavPathStack)10+
+Navigation(pathInfos: NavPathStack)10+
Binds a navigation stack to the **\** component.
**Parameters**
-| Name | Type | Mandatory | Description |
-| ------- | ----------------------------------- | ---- | ------------- |
-| pathInfos | [NavPathStack](#navpathstack10) | No | Information about the navigation stack.|
+| Name | Type | Mandatory | Description |
+| --------- | ------------------------------- | ---- | ------ |
+| pathInfos | [NavPathStack](#navpathstack10) | No | Information about the navigation stack.|
## Attributes
In addition to the [universal attributes](ts-universal-attributes-size.md), the following attributes are supported.
-| Name | Type | Description |
-| ----------------------------- | ---------------------------------------- | ---------------------------------------- |
-| title | [ResourceStr](ts-types.md#resourcestr)10+ \| [CustomBuilder](ts-types.md#custombuilder8)8+ \| [NavigationCommonTitle](#navigationcommontitle)9+ \| [NavigationCustomTitle](#navigationcustomtitle)9+ | Page title.(deprecated) | string | Subtitle of the page. If this attribute is not set, no subtitle is displayed. This attribute is deprecated since API version 9. You are advised to use **title** instead.|
-| menus | Array<[NavigationMenuItem](#navigationmenuitem)> \| [CustomBuilder](ts-types.md#custombuilder8)8+ | Menu items in the upper right corner of the page. If this attribute is not set, no menu item is displayed. When the value type is Array\<[NavigationMenuItem](#navigationmenuitem)>, the menu shows a maximum of three icons in portrait mode and a maximum of five icons in landscape mode, with excess icons (if any) placed under the automatically generated **More** icon.|
-| titleMode | [NavigationTitleMode](#navigationtitlemode) | Display mode of the page title bar.(deprecated) | [object](#object) \| [CustomBuilder](ts-types.md#custombuilder8)8+ | Content of the toolbar. If this attribute is not set, no toolbar is displayed.10+ \| [CustomBuilder](ts-types.md#custombuilder8)8+ \| [NavigationCommonTitle](#navigationcommontitle)9+ \| [NavigationCustomTitle](#navigationcustomtitle)9+ | Page title.(deprecated) | string | Subtitle of the page. If this attribute is not set, no subtitle is displayed. This attribute is deprecated since API version 9. You are advised to use **title** instead.|
+| menus | Array<[NavigationMenuItem](#navigationmenuitem)> \| [CustomBuilder](ts-types.md#custombuilder8)8+ | Menu items in the upper right corner of the page. If this attribute is not set, no menu item is displayed. When the value type is Array<[NavigationMenuItem](#navigationmenuitem)>, the menu shows a maximum of three icons in portrait mode and a maximum of five icons in landscape mode, with excess icons (if any) placed under the automatically generated **More** icon.|
+| titleMode | [NavigationTitleMode](#navigationtitlemode) | Display mode of the page title bar.(deprecated) | [object](#object) \| [CustomBuilder](ts-types.md#custombuilder8)8+ | Content of the toolbar. If this attribute is not set, no toolbar is displayed.10+ | Array<[ToolbarItem](#toolbaritem10)10+ > \| [CustomBuilder](ts-types.md#custombuilder8)8+ | Content of the toolbar. If this attribute is not set, no toolbar is displayed.** component cannot be hidden.9+ | [Length](ts-types.md#length) | Width of the navigation bar.** component is split.|
-| navBarPosition9+ | [NavBarPosition](#navbarposition) | Position of the navigation bar.** component is split.|
-| mode9+ | [NavigationMode](#navigationmode) | Display mode of the navigation bar.9+ | string \| [PixelMap](../apis/js-apis-image.md#pixelmap7) \| [Resource](ts-types.md#resource) | Back button icon on the navigation bar. The back button in the title bar of the **\** component cannot be hidden.|
-| hideNavBar9+ | boolean | Whether to hide the navigation bar. This attribute is valid only when **mode** is set to **NavigationMode.Split**.|
-| navDestination10+ | builder: (name: string, param: unknown) => void | Creates a **\** component.** component. However, no attributes or events can be set for the custom components. Otherwise, only blank components are displayed.|
-| navBarWidthRange10+ | [[Dimension](ts-types.md#dimension10), [Dimension](ts-types.md#dimension10)] | Minimum and maximum widths of the navigation bar (valid in dual-column mode).10+ | [Dimension](ts-types.md#dimension10) | Minimum width of the navigation bar content area (valid in dual-column mode).** component cannot be hidden.9+ | [Length](ts-types.md#length) | Width of the navigation bar.** component is split.|
+| navBarPosition9+ | [NavBarPosition](#navbarposition) | Position of the navigation bar.** component is split.|
+| mode9+ | [NavigationMode](#navigationmode) | Display mode of the navigation bar.9+ | string \| [PixelMap](../apis/js-apis-image.md#pixelmap7) \| [Resource](ts-types.md#resource) | Back button icon on the navigation bar. The back button in the title bar of the **\** component cannot be hidden.|
+| hideNavBar9+ | boolean | Whether to hide the navigation bar. This attribute is valid only when **mode** is set to **NavigationMode.Split**.|
+| navDestination10+ | builder: (name: string, param: unknown) => void | Creates a **\** component.** component. However, no attributes or events can be set for the custom components. Otherwise, only blank components are displayed.|
+| navBarWidthRange10+ | [[Dimension](ts-types.md#dimension10), [Dimension](ts-types.md#dimension10)] | Minimum and maximum widths of the navigation bar (valid in dual-column mode).10+ | [Dimension](ts-types.md#dimension10) | Minimum width of the navigation bar content area (valid in dual-column mode).10+
@@ -64,9 +74,9 @@ Pushes the NavDestination page information specified by **info** to the stack.
**Parameters**
-| Name | Type | Mandatory | Description |
-| ------ | ----------------------- | ---- | --------------- |
-| info | [NavPathInfo](#navpathinfo10) | Yes | Information about the navigation destination page. |
+| Name | Type | Mandatory | Description |
+| ---- | ----------------------------- | ---- | -------------------- |
+| info | [NavPathInfo](#navpathinfo10) | Yes | Information about the navigation destination page.|
### pushPathByName10+
@@ -76,10 +86,10 @@ Pushes the navigation destination page specified by **name** to the navigation s
**Parameters**
-| Name | Type | Mandatory | Description |
-| ------ | ----------------------- | ---- | --------------- |
-| name | string | Yes | Name of the navigation destination page. |
-| param | unknown | Yes | Parameter information of the navigation destination page. |
+| Name | Type | Mandatory | Description |
+| ----- | ------- | ---- | --------------------- |
+| name | string | Yes | Name of the navigation destination page. |
+| param | unknown | Yes | Parameter information of the navigation destination page.|
### pop10+
@@ -89,10 +99,10 @@ Pops the top element out of the navigation stack.
**Return value**
-| Type | Description |
-| ------ | -------- |
+| Type | Description |
+| ----------- | ------------------------ |
| NavPathInfo | Returns the information about the navigation destination page at the top of the stack.|
-| undefined | Returns **undefined** if the navigation stack is empty.|
+| undefined | Returns **undefined** if the navigation stack is empty. |
### popToName10+
@@ -102,14 +112,14 @@ Returns the navigation stack to the first navigation destination page that match
**Parameters**
-| Name | Type | Mandatory | Description |
-| ------ | ----------------------- | ---- | --------------- |
-| name | string | Yes | Name of the navigation destination page. |
+| Name | Type | Mandatory | Description |
+| ---- | ------ | ---- | ------------------- |
+| name | string | Yes | Name of the navigation destination page.|
**Return value**
-| Type | Description |
-| ------ | -------- |
+| Type | Description |
+| ------ | ---------------------------------------- |
| number | Returns the index of the first navigation destination page that matches the value of **name** if it exists in the navigation stack; returns **-1** otherwise.|
### popToIndex10+
@@ -120,9 +130,9 @@ Returns the navigation stack to the navigation destination page that matches the
**Parameters**
-| Name | Type | Mandatory | Description |
-| ------ | ----------------------- | ---- | --------------- |
-| index | number | Yes | Index of the navigation destination page. |
+| Name | Type | Mandatory | Description |
+| ----- | ------ | ---- | ---------------------- |
+| index | number | Yes | Index of the navigation destination page.|
### moveToTop10+
@@ -132,14 +142,14 @@ Moves to the top of the navigation stack the first navigation destination page t
**Parameters**
-| Name | Type | Mandatory | Description |
-| ------ | ----------------------- | ---- | --------------- |
-| name | string | Yes | Name of the navigation destination page. |
+| Name | Type | Mandatory | Description |
+| ---- | ------ | ---- | ------------------- |
+| name | string | Yes | Name of the navigation destination page.|
**Return value**
-| Type | Description |
-| ------ | -------- |
+| Type | Description |
+| ------ | ---------------------------------------- |
| number | Returns the index of the first navigation destination page that matches the value of **name** if it exists in the navigation stack; returns **-1** otherwise.|
### moveIndexToTop10+
@@ -150,9 +160,9 @@ Moves to the top of the navigation stack the navigation destination page that ma
**Parameters**
-| Name | Type | Mandatory | Description |
-| ------ | ----------------------- | ---- | --------------- |
-| index | number | Yes | Index of the navigation destination page. |
+| Name | Type | Mandatory | Description |
+| ----- | ------ | ---- | ---------------------- |
+| index | number | Yes | Index of the navigation destination page.|
### clear10+
@@ -168,8 +178,8 @@ Obtains the names of all navigation destination pages in the navigation stack.
**Return value**
-| Type | Description |
-| ------ | -------- |
+| Type | Description |
+| -------------- | -------------------------- |
| Array | Names of all navigation destination pages in the navigation stack.|
### getParamByIndex10+
@@ -180,16 +190,16 @@ Obtains the parameter information of the navigation destination page that matche
**Parameters**
-| Name | Type | Mandatory | Description |
-| ------ | ----------------------- | ---- | --------------- |
-| index | number | Yes | Index of the navigation destination page. |
+| Name | Type | Mandatory | Description |
+| ----- | ------ | ---- | ---------------------- |
+| index | number | Yes | Index of the navigation destination page.|
**Return value**
-| Type | Description |
-| ------ | -------- |
-| unknown | Returns the parameter information of the matching navigation destination page.|
-| undefined | Returns **undefined** if the passed index is invalid.|
+| Type | Description |
+| --------- | -------------------------- |
+| unknown | Returns the parameter information of the matching navigation destination page.|
+| undefined | Returns **undefined** if the passed index is invalid. |
### getParamByName10+
@@ -199,15 +209,15 @@ Obtains the parameter information of all the navigation destination pages that m
**Parameters**
-| Name | Type | Mandatory | Description |
-| ------ | ----------------------- | ---- | --------------- |
-| name | string | Yes | Name of the navigation destination page. |
+| Name | Type | Mandatory | Description |
+| ---- | ------ | ---- | ------------------- |
+| name | string | Yes | Name of the navigation destination page.|
**Return value**
-| Type | Description |
-| ------ | -------- |
-| Array | Parameter information of all the matching navigation destination pages.|
+| Type | Description |
+| --------------- | --------------------------------- |
+| Array | Parameter information of all the matching navigation destination pages.|
### getIndexByName10+
@@ -217,15 +227,15 @@ Obtains the indexes information of all the navigation destination pages that mat
**Parameters**
-| Name | Type | Mandatory | Description |
-| ------ | ----------------------- | ---- | --------------- |
-| name | string | Yes | Name of the navigation destination page. |
+| Name | Type | Mandatory | Description |
+| ---- | ------ | ---- | ------------------- |
+| name | string | Yes | Name of the navigation destination page.|
**Return value**
-| Type | Description |
-| ------ | -------- |
-| Array | Indexes of all the matching navigation destination pages.|
+| Type | Description |
+| -------------- | --------------------------------- |
+| Array | Indexes of all the matching navigation destination pages.|
### size10+
@@ -235,9 +245,9 @@ Obtains the stack size.
**Return value**
-| Type | Description |
-| ------ | -------- |
-| number | Stack size.|
+| Type | Description |
+| ------ | ------ |
+| number | Stack size.|
## NavPathInfo10+
@@ -249,52 +259,52 @@ constructor(name: string, param: unknown)
**Parameters**
-| Name | Type | Mandatory | Description |
-| ------ | ----------------------- | ---- | --------------- |
-| name | string | Yes | Name of the navigation destination page. |
-| param | unknown | No | Parameter information of the navigation destination page. |
+| Name | Type | Mandatory | Description |
+| ----- | ------- | ---- | --------------------- |
+| name | string | Yes | Name of the navigation destination page. |
+| param | unknown | No | Parameter information of the navigation destination page.|
## NavigationMenuItem
-| Name | Type | Mandatory | Description |
-| ------ | ----------------------- | ---- | --------------- |
-| value | string | Yes | Text of a menu item. |
-| icon | string | No | Icon path of a menu item.|
+| Name | Type | Mandatory | Description |
+| ------ | ------------- | ---- | --------------- |
+| value | string | Yes | Text of a menu item. |
+| icon | string | No | Icon path of a menu item.|
| action | () => void | No | Callback invoked when a menu item is selected. |
## object
-| Name | Type | Mandatory | Description |
-| ------ | ----------------------- | ---- | --------------- |
-| value | string | Yes | Text of a toolbar item. |
-| icon | string | No | Icon path of a toolbar item.|
+| Name | Type | Mandatory | Description |
+| ------ | ------------- | ---- | --------------- |
+| value | string | Yes | Text of a toolbar item. |
+| icon | string | No | Icon path of a toolbar item.|
| action | () => void | No | Callback invoked when a toolbar item is selected. |
## ToolbarItem10+
-| Name | Type | Mandatory| Description |
-| ---------- | ------------------------------------------------- | ---- | ----------------------------------------------------------- |
-| value | ResourceStr | Yes | Text of a toolbar item. |
-| icon | ResourceStr | No | Icon path of a toolbar item. |
-| action | () => void | No | Callback invoked when a toolbar item is selected. |
-| status | [ToolbarItemStatus](#toolbaritemstatus10) | No | Status of a toolbar item.10+
-| Name | Description |
-| -------- | ------------------------------------------------------------ |
+| Name | Description |
+| -------- | ---------------------------------------- |
| NORMAL | Normal state. In this state, the toolbar item takes on the default style and can switch to another state-specific style by responding to the hover, press, and focus events.|
| DISABLED | Disabled state. In this state, the toolbar item is disabled and does not allow for user interactions.|
| ACTIVE | Active state. In this state, the toolbar item can update its icon to the one specified by **activeIcon** by responding to a click event.|
## NavigationTitleMode
-| Name| Description |
-| ---- | ------------------------------------------------------------ |
-| Free | When the content is a scrollable component, the main title shrinks as the content scrolls down (the subtitle fades out with its size remaining unchanged) and restores when the content scrolls up to the top.** is supported.
-## Events
-
-| Name | Description |
-| ---------------------------------------- | ---------------------------------------- |
-| onTitleModeChange(callback: (titleMode: NavigationTitleMode) => void) | Called when **titleMode** is set to **NavigationTitleMode.Free** and the title bar mode changes as content scrolls.|
-| onNavBarStateChange(callback: (isVisible: boolean) => void) | Called when the navigation bar visibility status changes. The value **true** means that the navigation bar is displayed, and **false** means the opposite.|
-
-
## Example
```ts
diff --git a/en/application-dev/reference/arkui-ts/ts-basic-components-richeditor.md b/en/application-dev/reference/arkui-ts/ts-basic-components-richeditor.md
index 23d1dd164423c71f692e07fe8600a791f94466e7..b492893437d12229d84e45fe345b23bb5a506839 100644
--- a/en/application-dev/reference/arkui-ts/ts-basic-components-richeditor.md
+++ b/en/application-dev/reference/arkui-ts/ts-basic-components-richeditor.md
@@ -27,6 +27,15 @@ RichEditor(value: RichEditorOptions)
The [universal attributes](ts-universal-attributes-size.md) are supported.
+> **NOTE**
+>
+> The default value of the **clip** attribute is **true**.
+
+| Name | Type | Description |
+| ------------------------- | ------------------------------------------------------------ | ------------------------------------------------------------ |
+| customKeyboard10+ | [CustomBuilder](ts-types.md#custombuilder8) | Custom keyboard.10+ | No | Text displayed when there is no input. |
-| icon | string | No | Path to the search icon. By default, the system search icon is used.** component. |
## Attributes
@@ -41,11 +41,13 @@ In addition to the [universal attributes](ts-universal-attributes-size.md), the
| caretStyle10+ | [CaretStyle](#caretstyle10) | Caret style.10+ | boolean | Whether to enable the input method when the component obtains focus.10+ | boolean | Whether to display the text selection menu when the text box is long-pressed or right-clicked.10+ | [CustomBuilder](ts-types.md#custombuilder8) | Custom keyboard.10+
| Name| Type | Mandatory| Description |
| ------ | ------------------------------------------ | ---- | ----------- |
-| size | [Length](ts-types.md#length) | No | Icon size. |
+| size | [Length](ts-types.md#length) | No | Icon size. It cannot be set in percentage. |
| color | [ResourceColor](ts-types.md#resourcecolor) | No | Icon color. |
| src | [ResourceStr](ts-types.md#resourcestr) | No | Image source of the icon.|
@@ -60,7 +62,7 @@ In addition to the [universal attributes](ts-universal-attributes-size.md), the
| Name | Type | Mandatory| Description |
| --------- | ------------------------------------------ | ---- | ---------------- |
-| fontSize | [Length](ts-types.md#length) | No | Font size of the button.|
+| fontSize | [Length](ts-types.md#length) | No | Font size of the button. It cannot be set in percentage.|
| fontColor | [ResourceColor](ts-types.md#resourcecolor) | No | Font color of the button.|
## CancelButtonStyle10+
@@ -235,3 +237,46 @@ struct SearchButtoonExample {
```
+
+
+### Example 3
+
+```ts
+// xxx.ets
+@Entry
+@Component
+struct SearchExample {
+ controller: SearchController = new SearchController()
+ @State inputValue: string = ""
+
+ // Create a custom keyboard component.
+ @Builder CustomKeyboardBuilder() {
+ Column() {
+ Button('x').onClick(() => {
+ // Disable the custom keyboard.
+ this.controller.stopEditing()
+ })
+ Grid() {
+ ForEach([1, 2, 3, 4, 5, 6, 7, 8, 9, '*', 0, '#'], (item) => {
+ GridItem() {
+ Button(item + "")
+ .width(110).onClick(() => {
+ this.inputValue += item
+ })
+ }
+ })
+ }.maxCount(3).columnsGap(10).rowsGap(10).padding(5)
+ }.backgroundColor(Color.Gray)
+ }
+
+ build() {
+ Column() {
+ Search({ controller: this.controller, value: this.inputValue})
+ // Bind the custom keyboard.
+ .customKeyboard(this.CustomKeyboardBuilder()).margin(10).border({ width: 1 })
+ }
+ }
+}
+````
+
+
diff --git a/en/application-dev/reference/arkui-ts/ts-basic-components-stepperitem.md b/en/application-dev/reference/arkui-ts/ts-basic-components-stepperitem.md
index 07b043411ed7ce7658cb575490e559e0dbd3aab0..daf26e98a24a303138f9f79c88c4340c73ba629a 100644
--- a/en/application-dev/reference/arkui-ts/ts-basic-components-stepperitem.md
+++ b/en/application-dev/reference/arkui-ts/ts-basic-components-stepperitem.md
@@ -26,6 +26,11 @@ StepperItem()
| nextLabel | string | Text label of the button on the right. The default value is **Start** for the last page and **Next** for the other pages.|
| status | [ItemState](#itemstate) | Display status of **nextLabel** in the stepper. Optional.** component does not support setting of the universal width attribute. By default, its width is the same as that of the parent **\** component.
+> - The **\** component does not support setting of the universal height attribute. Its height is the height of the parent **\** component minus the height of the label button.
+> - The **\** component does not support setting of the **aspectRadio** or **constrainSize** attribute, which may affect the length and width.
## ItemState
| Name | Description|
diff --git a/en/application-dev/reference/arkui-ts/ts-basic-components-textinput.md b/en/application-dev/reference/arkui-ts/ts-basic-components-textinput.md
index f8a2a0cba6a7b5dd36ff165a3df05cfd11dfede2..61accc536e8ad4a8a06ed06e879a8de4ca4028ae 100644
--- a/en/application-dev/reference/arkui-ts/ts-basic-components-textinput.md
+++ b/en/application-dev/reference/arkui-ts/ts-basic-components-textinput.md
@@ -40,7 +40,7 @@ Among the [universal attributes](ts-universal-attributes-size.md) and [universal
| inputFilter8+ | {9+ | [CopyOptions](ts-appendix-enums.md#copyoptions9) | Whether copy and paste is allowed.9+ | boolean | Whether to display the password icon at the end of the password text box.9+ | [TextInputStyle](#textinputstyle9) \| [TextContentStyle](ts-appendix-enums.md#textcontentstyle10) | Text input style.9+ | [TextInputStyle](#textinputstyle9) \| [TextContentStyle](ts-appendix-enums.md#textcontentstyle10) | Text input style.9+ | [TextAlign](ts-appendix-enums.md#textalign) | Horizontal alignment of the text.10+ | [ResourceColor](ts-types.md#resourcecolor) | Background color of the selected text.10+ | {** component lays out child components vertically and inserts a horizontal divider between components.
+The **\** component lays out child components vertically and inserts a horizontal divider between every two child components.
> **NOTE**
>
> This component is supported since API version 7. Updates will be marked with a superscript to indicate their earliest API version.
-
-
## Child Components
Supported
-
## APIs
ColumnSplit()
@@ -20,17 +17,24 @@ ColumnSplit()
## Attributes
-| Name| Type| Description|
-| -------- | -------- | -------- |
-| resizeable | boolean | Whether the divider can be dragged.10+ | [ColumnSplitDividerStyle](#columnsplitdividerstyle10) \| null | Margin of the divider.10+
+
+| Name | Type | Mandatory| Description |
+| ----------- | ------------- | ---- |--------------------------|
+| startMargin | [Dimension](ts-types.md#dimension10) | No | Distance between the divider and the child component above it.**, the divider of **\** can be dragged to a position that just fully holds a component.
->
-> Dragging is not supported in the Previewer. Check the drag effect on a real device.
+> Similar to **\**, the divider of **\** can change the height of the upper and lower child components, but only to the extent that the resultant height falls within the maximum and minimum heights of the child components.
>
-> The universal attributes **clip** and **margin** are not supported.
+> Universal attributes such as **clip** and **margin** are supported. If **clip** is not set, the default value **true** is used.
+
## Example
diff --git a/en/application-dev/reference/arkui-ts/ts-container-grid.md b/en/application-dev/reference/arkui-ts/ts-container-grid.md
index 6726cf4455e448bc64f7a54af59d4d2fb9477c6a..23e98d39e0f0eed4b1b6f9549ca1d28d283213be 100644
--- a/en/application-dev/reference/arkui-ts/ts-container-grid.md
+++ b/en/application-dev/reference/arkui-ts/ts-container-grid.md
@@ -63,6 +63,7 @@ In addition to the [universal attributes](ts-universal-attributes-size.md), the
| edgeEffect10+ | [EdgeEffect](ts-appendix-enums.md#edgeeffect) | Scroll effect. The spring effect and shadow effect are supported.10+ | boolean | Whether to support scroll gestures. When this attribute is set to **false**, scrolling by finger or mouse is not supported, but the scrolling controller API is not affected.10+ | [NestedScrollOptions](ts-container-scroll.md#nestedscrolloptions10) | Nested scrolling options. You can set the nested scrolling mode in the forward and backward directions to implement scrolling linkage with the parent component.|
+| friction10+ | number \| [Resource](ts-types.md#resource) | Friction coefficient. It applies only to gestures in the scrolling area, and it affects only indirectly the scroll chaining during the inertial scrolling process.** component supports the following layout modes:
@@ -111,7 +112,7 @@ In addition to the [universal events](ts-universal-events-click.md), the followi
| Name| Description|
| -------- | -------- |
| onScrollIndex(event: (first: number) => void) | Triggered when the first item displayed in the grid changes. It is triggered once when the grid is initialized.(deprecated) | boolean | Whether to enter editing mode.10+ | [ChainAnimationOptions](#chainanimationoptions10) | Chained animation settings.8+ | boolean | Whether to enable mouse frame selection.9+ | number \| [LengthConstrain](ts-types.md#lengthconstrain),10+ ?:[Dimension](ts-types.md#dimension10) | In the following description, **listDirection** is set to **Axis.Vertical**:** component by the specified number.** component, ensuring that the width respects the {minLength, maxLength} constraints during adaptation. The **minLength** constraint is prioritized.9+ | [ListItemAlign](#listitemalign9) | Alignment mode of list items along the cross axis when: Cross-axis width of the **\** component > Cross-axis width of list items x Value of **lanes**.9+ | [StickyStyle](#stickystyle9) | Whether to pin the header to the top or the footer to the bottom in the **\** component. This attribute is used together with the **[\](ts-container-listitemgroup.md)** component.10+ | [ScrollSnapAlign](#scrollsnapalign10) | Alignment mode of list items when scrolling ends.10+ | boolean | Whether to support scroll gestures. When this attribute is set to **false**, scrolling by finger or mouse is not supported, but the scrolling controller API is not affected.10+ | [NestedScrollOptions](ts-container-scroll.md#nestedscrolloptions10) | Nested scrolling options. You can set the nested scrolling mode in the forward and backward directions to implement scrolling linkage with the parent component.|
+| Name | Type | Description |
+| ------------------------------------- | ---------------------------------------- | ---------------------------------------- |
+| listDirection | [Axis](ts-appendix-enums.md#axis) | Direction in which the list items are arranged.(deprecated) | boolean | Whether to enter editing mode.10+ | [ChainAnimationOptions](#chainanimationoptions10) | Chained animation settings.8+ | boolean | Whether to enable mouse frame selection.9+ | number \| [LengthConstrain](ts-types.md#lengthconstrain),10+ ?:[Dimension](ts-types.md#dimension10) | In the following description, **listDirection** is set to **Axis.Vertical**:** component by the specified number.** component, ensuring that the width respects the {minLength, maxLength} constraints during adaptation. The **minLength** constraint is prioritized.9+ | [ListItemAlign](#listitemalign9) | Alignment mode of list items along the cross axis when: Cross-axis width of the **\** component > Cross-axis width of list items x Value of **lanes**.9+ | [StickyStyle](#stickystyle9) | Whether to pin the header to the top or the footer to the bottom in the **\** component. This attribute is used together with the **[\](ts-container-listitemgroup.md)** component.10+ | [ScrollSnapAlign](#scrollsnapalign10) | Alignment mode of list items when scrolling ends.10+ | boolean | Whether to support scroll gestures. When this attribute is set to **false**, scrolling by finger or mouse is not supported, but the scrolling controller API is not affected.10+ | [NestedScrollOptions](ts-container-scroll.md#nestedscrolloptions10) | Nested scrolling options. You can set the nested scrolling mode in the forward and backward directions to implement scrolling linkage with the parent component. |
+| friction10+ | number \| [Resource](ts-types.md#resource) | Friction coefficient. It applies only to gestures in the scrolling area, and it affects only indirectly the scroll chaining during the inertial scrolling process.9+
@@ -126,9 +127,9 @@ When list items are left-, right-, top-, or bottom-aligned, the items at the end
This API is available only when the heights of list items are the same.
-| Name | Description |
-| ------ | ------------------------------------------------------------ |
-| NONE | No alignment. This is the default value. When scrolling ends, the list items are not aligned. |
+| Name | Description |
+| ------ | ---------------------------------------- |
+| NONE | No alignment. This is the default value. When scrolling ends, the list items are not aligned. |
| START | The first item in the view is aligned at the start of the list.** lays out child components horizontally and inserts a vertical divider between child components.
+The **\** lays out child components horizontally and inserts a vertical divider between every two child components.
> **NOTE**
>
@@ -19,15 +19,13 @@ RowSplit()
| Name| Type| Description|
| -------- | -------- | -------- |
-| resizeable | boolean | Whether the divider can be dragged.**, the divider of **\** can be dragged to a position that just fully holds a component.
->
-> Dragging is not supported in the Previewer. Check the drag effect on a real device.
+> The divider of **\** can change the width of the left and right child components, but only to the extent that the resultant width falls within the maximum and minimum widths of the child components.
>
-> The universal attributes **clip** and **margin** are not supported.
+> Universal attributes such as **clip** and **margin** are supported. If **clip** is not set, the default value **true** is used.
## Example
@@ -54,4 +52,4 @@ struct RowSplitExample {
}
```
-
+
diff --git a/en/application-dev/reference/arkui-ts/ts-container-scroll.md b/en/application-dev/reference/arkui-ts/ts-container-scroll.md
index 8c13e893b7a6ceea454cfbef8511153c5eda4bfb..b6eda086a1bde6b6a2b6d3f0ab5ec3e2a752f1f5 100644
--- a/en/application-dev/reference/arkui-ts/ts-container-scroll.md
+++ b/en/application-dev/reference/arkui-ts/ts-container-scroll.md
@@ -37,6 +37,7 @@ In addition to the [universal attributes](ts-universal-attributes-size.md), the
| edgeEffect | [EdgeEffect](ts-appendix-enums.md#edgeeffect) | Scroll effect. For details, see **EdgeEffect**.10+ | boolean | Whether to support scroll gestures. When this attribute is set to **false**, scrolling by finger or mouse is not supported, but the scrolling controller API is not affected.10+ | [NestedScrollOptions](#nestedscrolloptions10) | Nested scrolling options. You can set the nested scrolling mode in the forward and backward directions to implement scrolling linkage with the parent component.|
+| friction10+ | number \| [Resource](ts-types.md#resource) | Friction coefficient. It applies only to gestures in the scrolling area, and it affects only indirectly the scroll chaining during the inertial scrolling process.10+ } \| boolean10+ | No | Animation configuration, which includes the following:**, **\**, **\**, and **\** support the **Boolean** type and **ICurve**.|
@@ -243,6 +244,7 @@ struct ScrollExample {
.scrollBar(BarState.On) // The scrollbar is always displayed.
.scrollBarColor(Color.Gray) // Color of the scrollbar.
.scrollBarWidth(10) // The scrollbar width is 10.
+ .friction(0.6)
.edgeEffect(EdgeEffect.None)
.onScroll((xOffset: number, yOffset: number) => {
console.info(xOffset + ' ' + yOffset)
@@ -325,6 +327,7 @@ struct NestedScroll {
.width("100%")
.height("50%")
.edgeEffect(EdgeEffect.None)
+ .friction(0.6)
.onReachStart(() => {
this.listPosition = 0
})
@@ -399,6 +402,7 @@ struct StickyNestedScroll {
}.width("100%")
}
.edgeEffect(EdgeEffect.Spring)
+ .friction(0.6)
.backgroundColor('#DCDCDC')
.scrollBar(BarState.Off)
.width('100%')
diff --git a/en/application-dev/reference/arkui-ts/ts-container-swiper.md b/en/application-dev/reference/arkui-ts/ts-container-swiper.md
index 52263bc0068469f680c269d4599c281394ca34c9..0756ef290138140a62b2602cd7860d03da07929c 100644
--- a/en/application-dev/reference/arkui-ts/ts-container-swiper.md
+++ b/en/application-dev/reference/arkui-ts/ts-container-swiper.md
@@ -134,12 +134,12 @@ Describes the left and right arrow attributes.
| Name | Type | Mandatory. | Description |
| ---------------- | ---------------------------------------- | ---- | ---------------------------------------- |
-| isShowBackground | boolean | No | Whether to show the background for the arrow.10+
@@ -219,7 +219,7 @@ struct SwiperExample {
.duration(1000)
.itemSpace(0)
.displayArrow({
- isShowBackground:true,
+ showBackground:true,
isSidebarMiddle:true,
backgroundSize:24,
backgroundColor:Color.White,
diff --git a/en/application-dev/reference/arkui-ts/ts-container-waterflow.md b/en/application-dev/reference/arkui-ts/ts-container-waterflow.md
index 70e392f7164156d01da02d69b9b0e6fdb3f77903..122157b3c8e51e1d26d141d66892d3d3b12c3454 100644
--- a/en/application-dev/reference/arkui-ts/ts-container-waterflow.md
+++ b/en/application-dev/reference/arkui-ts/ts-container-waterflow.md
@@ -46,6 +46,7 @@ In addition to the [universal attributes](ts-universal-attributes-size.md), the
| layoutDirection | [FlexDirection](ts-appendix-enums.md#flexdirection) |Main axis direction of the layout.10+ | boolean | Whether to support scroll gestures. When this attribute is set to **false**, scrolling by finger or mouse is not supported, but the scrolling controller API is not affected.10+ | [NestedScrollOptions](ts-container-scroll.md#nestedscrolloptions10) | Nested scrolling options. You can set the nested scrolling mode in the forward and backward directions to implement scrolling linkage with the parent component.|
+| friction10+ | number \| [Resource](ts-types.md#resource) | Friction coefficient. It applies only to gestures in the scrolling area, and it affects only indirectly the scroll chaining during the inertial scrolling process.8+ | number | Swipe gesture speed, that is, the average swipe speed of all fingers. The unit is vp/s. This attribute is used for the **SwipeGesture** event.|
| fingerList8+ | [FingerInfo](#fingerinfo)[] | Information about all fingers that trigger the event. This attribute is used for the **LongPressGesture** and **TapGesture** events.|
| timestamp8+ | number | Timestamp of the event.|
@@ -80,10 +80,10 @@ The component binds gesture objects of different **GestureType**s through gestur
| Name| Type| Description|
| -------- | -------- | -------- |
| id | number | Index of a finger.|
-| globalX | number | X-coordinate relative to the upper left corner of the application window.|
-| globalY | number | Y-coordinate relative to the upper left corner of the application window.|
-| localX | number | X-coordinate relative to the upper left corner of the current component.|
-| localY | number | Y-coordinate relative to the upper left corner of the current component.|
+| globalX | number | X coordinate relative to the upper left corner of the application window.|
+| globalY | number | Y coordinate relative to the upper left corner of the application window.|
+| localX | number | X coordinate relative to the upper left corner of the current component.|
+| localY | number | Y coordinate relative to the upper left corner of the current component.|
## SourceTool
| Name| Description|
diff --git a/en/application-dev/reference/arkui-ts/ts-methods-timepicker-dialog.md b/en/application-dev/reference/arkui-ts/ts-methods-timepicker-dialog.md
index bbb16d3d03209f0b955b5c47092e280ef45950db..77fa5b3113ea4d9885d7771460488b2294e75459 100644
--- a/en/application-dev/reference/arkui-ts/ts-methods-timepicker-dialog.md
+++ b/en/application-dev/reference/arkui-ts/ts-methods-timepicker-dialog.md
@@ -46,6 +46,9 @@ struct TimePickerDialogExample {
.onClick(() => {
TimePickerDialog.show({
selected: this.selectTime,
+ disappearTextStyle: {color: Color.Red, font: {size: 15, weight: FontWeight.Lighter}},
+ textStyle: {color: Color.Black, font: {size: 20, weight: FontWeight.Normal}},
+ selectedTextStyle: {color: Color.Blue, font: {size: 30, weight: FontWeight.Bolder}},
onAccept: (value: TimePickerResult) => {
// Set selectTime to the time when the OK button is clicked. In this way, when the dialog box is displayed again, the selected time is the time when the operation was confirmed last time.
this.selectTime.setHours(value.hour, value.minute)
@@ -65,6 +68,9 @@ struct TimePickerDialogExample {
TimePickerDialog.show({
selected: this.selectTime,
useMilitaryTime: true,
+ disappearTextStyle: {color: Color.Red, font: {size: 15, weight: FontWeight.Lighter}},
+ textStyle: {color: Color.Black, font: {size: 20, weight: FontWeight.Normal}},
+ selectedTextStyle: {color: Color.Blue, font: {size: 30, weight: FontWeight.Bolder}},
onAccept: (value: TimePickerResult) => {
this.selectTime.setHours(value.hour, value.minute)
console.info("TimePickerDialog:onAccept()" + JSON.stringify(value))
diff --git a/en/application-dev/reference/arkui-ts/ts-motion-path-animation.md b/en/application-dev/reference/arkui-ts/ts-motion-path-animation.md
index fd98aadd3525b1d6d37262125bdc544833e9d129..7220808c63086d39e8fbc37bfad65281a19d4615 100644
--- a/en/application-dev/reference/arkui-ts/ts-motion-path-animation.md
+++ b/en/application-dev/reference/arkui-ts/ts-motion-path-animation.md
@@ -9,9 +9,9 @@ The motion path animation is used to animate a component along a custom path.
## Attributes
-| Name| Type| Default Value| Description|
-| -------- | -------- | -------- | -------- |
-| motionPath | {**, **\**, or **\** container, the cross axis size of the child components and the margins add up to the total size of the container.** container is 100, the width of the child component is 50, the left margin is 10, and the right margin is 20, then the actual horizontal offset of the child component is 20.|
+| [oh_cursor.h](oh__cursor_8h.md) | Defines the APIs for accessing the result set obtained by querying the RDB store. |
| [oh_predicates.h](oh__predicates_8h.md) | Defines the predicates for RDB stores.|
-| [oh_value_object.h](oh__value__object_8h.md) | Provides type conversion methods.|
+| [oh_value_object.h](oh__value__object_8h.md) | Defines type conversion methods. |
| [oh_values_bucket.h](oh__values__bucket_8h.md) | Defines the types of the key and value in a key-value (KV) pair.|
-| [relational_store.h](relational__store_8h.md) | Provides APIs to manage an RDB store.|
+| [relational_store.h](relational__store_8h.md) | Defines the APIs for managing an RDB store. |
| [relational_store_error_code.h](relational__store__error__code_8h.md) | Declares the error codes used for RDB stores.|
@@ -43,10 +43,13 @@ The relational database (RDB) store manages data based on relational models. The
| Name| Description|
| -------- | -------- |
+| [OH_ColumnType](#oh_columntype) | Enumerates the field types in an RDB store.|
| [OH_Cursor](#oh_cursor) | Indicates a result set.|
+| [OH_OrderType](#oh_ordertype) | Enumerates the sorting types.|
| [OH_Predicates](#oh_predicates) | Indicates a **predicates** object.|
| [OH_VObject](#oh_vobject) | Indicates the allowed data field types.|
| [OH_VBucket](#oh_vbucket) | Indicates the types of the key and value in a KV pair.|
+| [OH_Rdb_SecurityLevel](#oh_rdb_securitylevel) | Enumerates the RDB store security levels.|
| [OH_Rdb_ErrCode](#oh_rdb_errcode) | Indicates error codes.|
@@ -69,7 +72,7 @@ The relational database (RDB) store manages data based on relational models. The
| [OH_Rdb_CreatePredicates](#oh_rdb_createpredicates) (const char \*table) | Creates an [OH_Predicates](_o_h___predicates.md) instance.|
| [OH_Rdb_GetOrOpen](#oh_rdb_getoropen) (const [OH_Rdb_Config](_o_h___rdb___config.md) \*config, int \*errCode) | Obtains an [OH_Rdb_Store](_o_h___rdb___store.md) instance for RDB store operations.|
| [OH_Rdb_CloseStore](#oh_rdb_closestore) ([OH_Rdb_Store](_o_h___rdb___store.md) \*store) | Destroys an [OH_Rdb_Store](_o_h___rdb___store.md) object and reclaims the memory occupied by the object.|
-| [OH_Rdb_DeleteStore](#oh_rdb_deletestore) (const char \*path) | Deletes an RDB store with the specified database file configuration.|
+| [OH_Rdb_DeleteStore](#oh_rdb_deletestore) (const [OH_Rdb_Config](_o_h___rdb___config.md) \*config) | Deletes an RDB store with the specified database file configuration.|
| [OH_Rdb_Insert](#oh_rdb_insert) ([OH_Rdb_Store](_o_h___rdb___store.md) \*store, const char \*table, [OH_VBucket](_o_h___v_bucket.md) \*valuesBucket) | Inserts a row of data into a table.|
| [OH_Rdb_Update](#oh_rdb_update) ([OH_Rdb_Store](_o_h___rdb___store.md) \*store, [OH_VBucket](_o_h___v_bucket.md) \*valuesBucket, [OH_Predicates](_o_h___predicates.md) \*predicates) | Updates data in an RDB store based on specified conditions.|
| [OH_Rdb_Delete](#oh_rdb_delete) ([OH_Rdb_Store](_o_h___rdb___store.md) \*store, [OH_Predicates](_o_h___predicates.md) \*predicates) | Deletes data from an RDB store based on specified conditions.|
@@ -102,7 +105,7 @@ The relational database (RDB) store manages data based on relational models. The
| [OH_Cursor::getReal](#getreal) | Pointer to the function used to obtain the value of the double type based on the specified column and the current row.|
| [OH_Cursor::getBlob](#getblob) | Pointer to the function used to obtain the value in the form of a byte array based on the specified column and the current row.|
| [OH_Cursor::isNull](#isnull-12) | Pointer to the function used to check whether the value in the specified column is null.|
-| [OH_Cursor::close](#close) | Pointer to the function used to close a result set. |
+| [OH_Cursor::destroy](#destroy-14) | Pointer to the function used to close the result set.|
| [OH_Predicates::id](#id-14) | Unique identifier of the **OH_Predicates** struct.|
| [OH_Predicates::equalTo](#equalto) | Pointer to the function used to set a predicates object to match the field whose value is equal to the specified value.|
| [OH_Predicates::notEqualTo](#notequalto) | Pointer to the function used to set a predicates object to match the field whose value is not equal to the specified value.|
@@ -127,13 +130,13 @@ The relational database (RDB) store manages data based on relational models. The
| [OH_Predicates::in](#in) | Pointer to the function used to set a predicates object to match the field with the value within the specified range.|
| [OH_Predicates::notIn](#notin) | Pointer to the function used to set a predicates object to match the field with the value out of the specified range.|
| [OH_Predicates::clear](#clear-12) | Pointer to the function used to clear a predicates instance.|
-| [OH_Predicates::destroyPredicates](#destroypredicates) | Destroys an [OH_Predicates](_o_h___predicates.md) object and reclaims the memory occupied.|
+| [OH_Predicates::destroy](#destroy-24) | Destroys an [OH_Predicates](_o_h___predicates.md) object and reclaims the memory occupied.|
| [OH_VObject::id](#id-24) | Unique identifier of the **OH_VObject** struct.|
| [OH_VObject::putInt64](#putint64-22) | Converts a single parameter or an array of the int64 type into a value of the [OH_VObject](_o_h___v_object.md) type.|
| [OH_VObject::putDouble](#putdouble) | Converts a single parameter or an array of the double type into a value of the [OH_VObject](_o_h___v_object.md) type.|
| [OH_VObject::putText](#puttext-22) | Converts a character array of the char type to a value of the [OH_VObject](_o_h___v_object.md) type.|
| [OH_VObject::putTexts](#puttexts) | Converts a string array of the char type to a value of the [OH_VObject](_o_h___v_object.md) type.|
-| [OH_VObject::destroyValueObject](#destroyvalueobject) | Destroys an [OH_VObject](_o_h___v_object.md) object and reclaims the memory occupied.|
+| [OH_VObject::destroy](#destroy-44) | Destroys an [OH_VObject](_o_h___v_object.md) object and reclaims the memory occupied.|
| [OH_VBucket::id](#id-34) | Unique identifier of the **OH_VBucket** struct.|
| [OH_VBucket::capability](#capability) | Number of the KV pairs in the struct.|
| [OH_VBucket::putText](#puttext-12) | Puts a char value into the [OH_VBucket](_o_h___v_bucket.md) object in the given column.|
@@ -142,18 +145,31 @@ The relational database (RDB) store manages data based on relational models. The
| [OH_VBucket::putBlob](#putblob) | Puts a const uint8_t value into the [OH_VBucket](_o_h___v_bucket.md) object in the given column.|
| [OH_VBucket::putNull](#putnull) | Puts a null value into the [OH_VBucket](_o_h___v_bucket.md) object in the given column.|
| [OH_VBucket::clear](#clear-22) | Clears an [OH_VBucket](_o_h___v_bucket.md) object.|
-| [OH_VBucket::destroyValuesBucket](#destroyvaluesbucket) | Destroys an [OH_VBucket](_o_h___v_bucket.md) object and reclaims the memory occupied.|
-| [OH_Rdb_Config::path](#path) | Path of the database file.|
+| [OH_VBucket::destroy](#destroy-34) | Destroys an [OH_VBucket](_o_h___v_bucket.md) object and reclaims the memory occupied.|
+| [OH_Rdb_Config::selfSize](#selfsize) | Size of the struct.|
+| [OH_Rdb_Config::dataBaseDir](#databasedir) | Path of the database file.|
+| [OH_Rdb_Config::bundleName](#bundlename) | Bundle name.|
+| [OH_Rdb_Config::moduleName](#modulename) | Module name. |
| [OH_Rdb_Config::isEncrypt](#isencrypt) | Whether to encrypt the RDB store.|
-| [OH_Rdb_Config::securityLevel](#securitylevel) | Set the RDB store security level [OH_Rdb_SecurityLevel](#oh_rdb_securitylevel).|
+| [OH_Rdb_Config::securityLevel](#securitylevel) | Sets the RDB store security level [OH_Rdb_SecurityLevel](#oh_rdb_securitylevel). |
| [OH_Rdb_Store::id](#id-44) | Unique identifier of the **OH_Rdb_Store** struct.|
## Type Description
-### OH_Cursor
+### OH_ColumnType
+
+```
+typedef enum OH_ColumnType OH_ColumnType
+```
+**Description**
+
+Enumerates the field types in an RDB store.
+
+
+### OH_Cursor
```
typedef struct OH_Cursor OH_Cursor
@@ -166,8 +182,18 @@ Indicates a result set.
It provides APIs to access the result set obtained by querying the RDB store.
-### OH_Predicates
+### OH_OrderType
+
+```
+typedef enum OH_OrderType OH_OrderType
+```
+**Description**
+
+Enumerates the sorting types.
+
+
+### OH_Predicates
```
typedef struct OH_Predicates OH_Predicates
@@ -180,7 +206,6 @@ Indicates a **predicates** object.
### OH_Rdb_ErrCode
-
```
typedef enum OH_Rdb_ErrCode OH_Rdb_ErrCode
```
@@ -190,8 +215,18 @@ typedef enum OH_Rdb_ErrCode OH_Rdb_ErrCode
Indicates an error code.
-### OH_VBucket
+### OH_Rdb_SecurityLevel
+```
+typedef enum OH_Rdb_SecurityLevel OH_Rdb_SecurityLevel
+```
+
+**Description**
+
+Enumerates the RDB store security levels.
+
+
+### OH_VBucket
```
typedef struct OH_VBucket OH_VBucket
@@ -204,7 +239,6 @@ Indicates the types of the key and value in a KV pair.
### OH_VObject
-
```
typedef struct OH_VObject OH_VObject
```
@@ -219,7 +253,6 @@ Indicates the allowed data field types.
### OH_ColumnType
-
```
enum OH_ColumnType
```
@@ -239,7 +272,6 @@ Enumerates the field types in an RDB store.
### OH_OrderType
-
```
enum OH_OrderType
```
@@ -256,7 +288,6 @@ Enumerates the sorting types.
### OH_Rdb_ErrCode
-
```
enum OH_Rdb_ErrCode
```
@@ -323,7 +354,6 @@ Enumerates the error codes.
### OH_Rdb_SecurityLevel
-
```
enum OH_Rdb_SecurityLevel
```
@@ -345,7 +375,6 @@ Enumerates the RDB store security levels.
### OH_Rdb_Backup()
-
```
int OH_Rdb_Backup (OH_Rdb_Store * store, const char * databasePath )
```
@@ -372,7 +401,6 @@ Returns **RDB_OK** is the operation is successful; returns an error code otherwi
### OH_Rdb_BeginTransaction()
-
```
int OH_Rdb_BeginTransaction (OH_Rdb_Store * store)
```
@@ -398,7 +426,6 @@ Returns **RDB_OK** is the operation is successful; returns an error code otherwi
### OH_Rdb_CloseStore()
-
```
int OH_Rdb_CloseStore (OH_Rdb_Store * store)
```
@@ -424,7 +451,6 @@ Returns **RDB_OK** is the operation is successful; returns an error code otherwi
### OH_Rdb_Commit()
-
```
int OH_Rdb_Commit (OH_Rdb_Store * store)
```
@@ -450,7 +476,6 @@ Returns **RDB_OK** is the operation is successful; returns an error code otherwi
### OH_Rdb_CreatePredicates()
-
```
OH_Predicates* OH_Rdb_CreatePredicates (const char * table)
```
@@ -476,9 +501,8 @@ Returns the pointer to the [OH_Predicates](_o_h___predicates.md) instance create
### OH_Rdb_CreateValueObject()
-
```
-OH_VObject* OH_Rdb_CreateValueObject (void )
+OH_VObject* OH_Rdb_CreateValueObject (void)
```
**Description**
@@ -496,9 +520,8 @@ Returns the pointer to the [OH_VObject](_o_h___v_object.md) instance created if
### OH_Rdb_CreateValuesBucket()
-
```
-OH_VBucket* OH_Rdb_CreateValuesBucket (void )
+OH_VBucket* OH_Rdb_CreateValuesBucket (void)
```
**Description**
@@ -516,7 +539,6 @@ Returns the pointer to the [OH_VBucket](_o_h___v_bucket.md) instance created if
### OH_Rdb_Delete()
-
```
int OH_Rdb_Delete (OH_Rdb_Store * store, OH_Predicates * predicates )
```
@@ -543,9 +565,8 @@ Returns the number of affected rows if the operation is successful; returns an e
### OH_Rdb_DeleteStore()
-
```
-int OH_Rdb_DeleteStore (const char * path)
+int OH_Rdb_DeleteStore (const OH_Rdb_Config * config)
```
**Description**
@@ -565,7 +586,6 @@ Returns **RDB_OK** is the operation is successful; returns an error code otherwi
### OH_Rdb_Execute()
-
```
int OH_Rdb_Execute (OH_Rdb_Store * store, const char * sql )
```
@@ -592,7 +612,6 @@ Returns **RDB_OK** is the operation is successful; returns an error code otherwi
### OH_Rdb_ExecuteQuery()
-
```
OH_Cursor* OH_Rdb_ExecuteQuery (OH_Rdb_Store * store, const char * sql )
```
@@ -619,7 +638,6 @@ Returns the pointer to the [OH_Cursor](_o_h___cursor.md) instance if the operati
### OH_Rdb_GetOrOpen()
-
```
OH_Rdb_Store* OH_Rdb_GetOrOpen (const OH_Rdb_Config * config, int * errCode )
```
@@ -646,7 +664,6 @@ Returns the pointer to the [OH_Rdb_Store](_o_h___rdb___store.md) instance create
### OH_Rdb_GetVersion()
-
```
int OH_Rdb_GetVersion (OH_Rdb_Store * store, int * version )
```
@@ -673,7 +690,6 @@ Returns **RDB_OK** is the operation is successful; returns an error code otherwi
### OH_Rdb_Insert()
-
```
int OH_Rdb_Insert (OH_Rdb_Store * store, const char * table, OH_VBucket * valuesBucket )
```
@@ -701,7 +717,6 @@ Returns the row ID if the operation is successful; returns an error code otherwi
### OH_Rdb_Query()
-
```
OH_Cursor* OH_Rdb_Query (OH_Rdb_Store * store, OH_Predicates * predicates, const char *const * columnNames, int length )
```
@@ -730,7 +745,6 @@ Returns the pointer to the [OH_Cursor](_o_h___cursor.md) instance if the operati
### OH_Rdb_Restore()
-
```
int OH_Rdb_Restore (OH_Rdb_Store * store, const char * databasePath )
```
@@ -744,7 +758,7 @@ Restores an RDB store from the specified database backup file.
| Name| Description|
| -------- | -------- |
| store | Pointer to the [OH_Rdb_Store](_o_h___rdb___store.md) instance.|
-| databasePath | Pointer to the path of the RDB store backup file.|
+| databasePath | Pointer to the destination directory in which the RDB store is backed up.|
**Returns**
@@ -757,7 +771,6 @@ Returns **RDB_OK** is the operation is successful; returns an error code otherwi
### OH_Rdb_RollBack()
-
```
int OH_Rdb_RollBack (OH_Rdb_Store * store)
```
@@ -783,7 +796,6 @@ Returns **RDB_OK** is the operation is successful; returns an error code otherwi
### OH_Rdb_SetVersion()
-
```
int OH_Rdb_SetVersion (OH_Rdb_Store * store, int version )
```
@@ -797,7 +809,7 @@ Sets the RDB store version.
| Name| Description|
| -------- | -------- |
| store | Pointer to the [OH_Rdb_Store](_o_h___rdb___store.md) instance.|
-| version | Version number to set.|
+| version | Pointer to the version number.|
**Returns**
@@ -810,7 +822,6 @@ Returns **RDB_OK** is the operation is successful; returns an error code otherwi
### OH_Rdb_Update()
-
```
int OH_Rdb_Update (OH_Rdb_Store * store, OH_VBucket * valuesBucket, OH_Predicates * predicates )
```
@@ -841,7 +852,6 @@ Returns the number of affected rows if the operation is successful; returns an e
### andOperate
-
```
OH_Predicates*(* OH_Predicates::andOperate) (OH_Predicates *predicates)
```
@@ -869,7 +879,6 @@ Returns the predicates with the AND operator.
### beginWrap
-
```
OH_Predicates*(* OH_Predicates::beginWrap) (OH_Predicates *predicates)
```
@@ -897,7 +906,6 @@ Returns the predicates with a left parenthesis.
### between
-
```
OH_Predicates*(* OH_Predicates::between) (OH_Predicates *predicates, const char *field, OH_VObject *valueObject)
```
@@ -925,9 +933,19 @@ Returns the predicates created.
[OH_Predicates](_o_h___predicates.md), [OH_VObject](_o_h___v_object.md).
-### capability
+### bundleName
+
+```
+const char* OH_Rdb_Config::bundleName
+```
+
+**Description**
+
+Application bundle name.
+### capability
+
```
uint16_t OH_VBucket::capability
```
@@ -939,7 +957,6 @@ Number of the KV pairs in the struct.
### clear [1/2]
-
```
OH_Predicates*(* OH_Predicates::clear) (OH_Predicates *predicates)
```
@@ -965,7 +982,6 @@ Returns the cleared predicates.
### clear [2/2]
-
```
int(* OH_VBucket::clear) (OH_VBucket *bucket)
```
@@ -989,16 +1005,26 @@ Returns **RDB_OK** is the operation is successful; returns an error code otherwi
[OH_VBucket](_o_h___v_bucket.md).
-### close
+### dataBaseDir
+```
+const char* OH_Rdb_Config::dataBaseDir
+```
+
+**Description**
+
+Path of the database file.
+
+
+### destroy [1/4]
```
-int(* OH_Cursor::close) (OH_Cursor *cursor)
+int(* OH_Cursor::destroy) (OH_Cursor *cursor)
```
**Description**
-Pointer to the function used to close a result set.
+Pointer to the function used to close the result set.
**Parameters**
@@ -1015,11 +1041,10 @@ Returns **RDB_OK** is the operation is successful; returns an error code otherwi
[OH_Cursor](_o_h___cursor.md).
-### destroyPredicates
-
+### destroy [2/4]
```
-int(* OH_Predicates::destroyPredicates) (OH_Predicates *predicates)
+int(* OH_Predicates::destroy) (OH_Predicates *predicates)
```
**Description**
@@ -1041,22 +1066,21 @@ Returns **RDB_OK** is the operation is successful; returns an error code otherwi
[OH_Predicates](_o_h___predicates.md).
-### destroyValueObject
-
+### destroy [3/4]
```
-int(* OH_VObject::destroyValueObject) (OH_VObject *valueObject)
+int(* OH_VBucket::destroy) (OH_VBucket *bucket)
```
**Description**
-Destroys an [OH_VObject](_o_h___v_object.md) object and reclaims the memory occupied.
+Destroys an [OH_VBucket](_o_h___v_bucket.md) object and reclaims the memory occupied.
**Parameters**
| Name| Description|
| -------- | -------- |
-| valueObject | Pointer to the [OH_VObject](_o_h___v_object.md) instance.|
+| bucket | Pointer to the [OH_VBucket](_o_h___v_bucket.md) instance.|
**Returns**
@@ -1064,25 +1088,24 @@ Returns **RDB_OK** is the operation is successful; returns an error code otherwi
**See**
-[OH_VObject](_o_h___v_object.md).
-
+[OH_VBucket](_o_h___v_bucket.md).
-### destroyValuesBucket
+### destroy [4/4]
```
-int(* OH_VBucket::destroyValuesBucket) (OH_VBucket *bucket)
+int(* OH_VObject::destroy) (OH_VObject *valueObject)
```
**Description**
-Destroys an [OH_VBucket](_o_h___v_bucket.md) object and reclaims the memory occupied.
+Destroys an [OH_VObject](_o_h___v_object.md) object and reclaims the memory occupied.
**Parameters**
| Name| Description|
| -------- | -------- |
-| bucket | Pointer to the [OH_VBucket](_o_h___v_bucket.md) instance.|
+| valueObject | Pointer to the [OH_VObject](_o_h___v_object.md) instance.|
**Returns**
@@ -1090,12 +1113,11 @@ Returns **RDB_OK** is the operation is successful; returns an error code otherwi
**See**
-[OH_VBucket](_o_h___v_bucket.md).
+[OH_VObject](_o_h___v_object.md).
### distinct
-
```
OH_Predicates*(* OH_Predicates::distinct) (OH_Predicates *predicates)
```
@@ -1123,7 +1145,6 @@ Returns the predicates created.
### endWrap
-
```
OH_Predicates*(* OH_Predicates::endWrap) (OH_Predicates *predicates)
```
@@ -1151,7 +1172,6 @@ Returns the predicates object with a right parenthesis.
### equalTo
-
```
OH_Predicates*(* OH_Predicates::equalTo) (OH_Predicates *predicates, const char *field, OH_VObject *valueObject)
```
@@ -1181,7 +1201,6 @@ Returns the predicates created.
### getBlob
-
```
int(* OH_Cursor::getBlob) (OH_Cursor *cursor, int32_t columnIndex, unsigned char *value, int length)
```
@@ -1210,7 +1229,6 @@ Returns **RDB_OK** is the operation is successful; returns an error code otherwi
### getColumnCount
-
```
int(* OH_Cursor::getColumnCount) (OH_Cursor *cursor, int *count)
```
@@ -1237,7 +1255,6 @@ Returns **RDB_OK** is the operation is successful; returns an error code otherwi
### getColumnIndex
-
```
int(* OH_Cursor::getColumnIndex) (OH_Cursor *cursor, const char *name, int *columnIndex)
```
@@ -1265,7 +1282,6 @@ Returns **RDB_OK** is the operation is successful; returns an error code otherwi
### getColumnName
-
```
int(* OH_Cursor::getColumnName) (OH_Cursor *cursor, int32_t columnIndex, char *name, int length)
```
@@ -1294,7 +1310,6 @@ Returns **RDB_OK** is the operation is successful; returns an error code otherwi
### getColumnType
-
```
int(* OH_Cursor::getColumnType) (OH_Cursor *cursor, int32_t columnIndex, OH_ColumnType *columnType)
```
@@ -1322,7 +1337,6 @@ Returns **RDB_OK** is the operation is successful; returns an error code otherwi
### getInt64
-
```
int(* OH_Cursor::getInt64) (OH_Cursor *cursor, int32_t columnIndex, int64_t *value)
```
@@ -1350,7 +1364,6 @@ Returns **RDB_OK** is the operation is successful; returns an error code otherwi
### getReal
-
```
int(* OH_Cursor::getReal) (OH_Cursor *cursor, int32_t columnIndex, double *value)
```
@@ -1378,7 +1391,6 @@ Returns **RDB_OK** is the operation is successful; returns an error code otherwi
### getRowCount
-
```
int(* OH_Cursor::getRowCount) (OH_Cursor *cursor, int *count)
```
@@ -1405,7 +1417,6 @@ Returns **RDB_OK** is the operation is successful; returns an error code otherwi
### getSize
-
```
int(* OH_Cursor::getSize) (OH_Cursor *cursor, int32_t columnIndex, size_t *size)
```
@@ -1433,7 +1444,6 @@ Returns **RDB_OK** is the operation is successful; returns an error code otherwi
### getText
-
```
int(* OH_Cursor::getText) (OH_Cursor *cursor, int32_t columnIndex, char *value, int length)
```
@@ -1462,7 +1472,6 @@ Returns **RDB_OK** is the operation is successful; returns an error code otherwi
### goToNextRow
-
```
int(* OH_Cursor::goToNextRow) (OH_Cursor *cursor)
```
@@ -1488,7 +1497,6 @@ Returns **RDB_OK** is the operation is successful; returns an error code otherwi
### greaterThan
-
```
OH_Predicates*(* OH_Predicates::greaterThan) (OH_Predicates *predicates, const char *field, OH_VObject *valueObject)
```
@@ -1518,7 +1526,6 @@ Returns the predicates created.
### greaterThanOrEqualTo
-
```
OH_Predicates*(* OH_Predicates::greaterThanOrEqualTo) (OH_Predicates *predicates, const char *field, OH_VObject *valueObject)
```
@@ -1548,7 +1555,6 @@ Returns the predicates created.
### groupBy
-
```
OH_Predicates*(* OH_Predicates::groupBy) (OH_Predicates *predicates, char const *const *fields, int length)
```
@@ -1578,7 +1584,6 @@ Returns the predicates created.
### id [1/4]
-
```
int64_t OH_Predicates::id
```
@@ -1590,7 +1595,6 @@ Unique identifier of the **OH_Predicates** struct.
### id [2/4]
-
```
int64_t OH_VObject::id
```
@@ -1602,7 +1606,6 @@ Unique identifier of the **OH_VObject** struct.
### id [3/4]
-
```
int64_t OH_VBucket::id
```
@@ -1614,7 +1617,6 @@ Unique identifier of the **OH_VBucket** struct.
### id [4/4]
-
```
int64_t OH_Rdb_Store::id
```
@@ -1626,7 +1628,6 @@ Unique identifier of the **OH_Rdb_Store** struct.
### in
-
```
OH_Predicates*(* OH_Predicates::in) (OH_Predicates *predicates, const char *field, OH_VObject *valueObject)
```
@@ -1656,7 +1657,6 @@ Returns the predicates created.
### isEncrypt
-
```
bool OH_Rdb_Config::isEncrypt
```
@@ -1668,7 +1668,6 @@ Whether to encrypt the RDB store.
### isNotNull
-
```
OH_Predicates*(* OH_Predicates::isNotNull) (OH_Predicates *predicates, const char *field)
```
@@ -1697,7 +1696,6 @@ Returns the predicates created.
### isNull [1/2]
-
```
int(* OH_Cursor::isNull) (OH_Cursor *cursor, int32_t columnIndex, bool *isNull)
```
@@ -1725,7 +1723,6 @@ Returns **RDB_OK** is the operation is successful; returns an error code otherwi
### isNull [2/2]
-
```
OH_Predicates*(* OH_Predicates::isNull) (OH_Predicates *predicates, const char *field)
```
@@ -1754,7 +1751,6 @@ Returns the predicates created.
### lessThan
-
```
OH_Predicates*(* OH_Predicates::lessThan) (OH_Predicates *predicates, const char *field, OH_VObject *valueObject)
```
@@ -1784,7 +1780,6 @@ Returns the predicates created.
### lessThanOrEqualTo
-
```
OH_Predicates*(* OH_Predicates::lessThanOrEqualTo) (OH_Predicates *predicates, const char *field, OH_VObject *valueObject)
```
@@ -1814,7 +1809,6 @@ Returns the predicates created.
### like
-
```
OH_Predicates*(* OH_Predicates::like) (OH_Predicates *predicates, const char *field, OH_VObject *valueObject)
```
@@ -1844,7 +1838,6 @@ Returns the predicates created.
### limit
-
```
OH_Predicates*(* OH_Predicates::limit) (OH_Predicates *predicates, unsigned int value)
```
@@ -1871,9 +1864,19 @@ Returns the predicates created.
[OH_Predicates](_o_h___predicates.md).
-### notBetween
+### moduleName
+
+```
+const char* OH_Rdb_Config::moduleName
+```
+
+**Description**
+
+Module name.
+### notBetween
+
```
OH_Predicates*(* OH_Predicates::notBetween) (OH_Predicates *predicates, const char *field, OH_VObject *valueObject)
```
@@ -1903,7 +1906,6 @@ Returns the predicates created.
### notEqualTo
-
```
OH_Predicates*(* OH_Predicates::notEqualTo) (OH_Predicates *predicates, const char *field, OH_VObject *valueObject)
```
@@ -1933,7 +1935,6 @@ Returns the predicates created.
### notIn
-
```
OH_Predicates*(* OH_Predicates::notIn) (OH_Predicates *predicates, const char *field, OH_VObject *valueObject)
```
@@ -1963,7 +1964,6 @@ Returns the predicates created.
### offset
-
```
OH_Predicates*(* OH_Predicates::offset) (OH_Predicates *predicates, unsigned int rowOffset)
```
@@ -1992,7 +1992,6 @@ Returns the predicates created.
### orderBy
-
```
OH_Predicates*(* OH_Predicates::orderBy) (OH_Predicates *predicates, const char *field, OH_OrderType type)
```
@@ -2022,7 +2021,6 @@ Returns the predicates created.
### orOperate
-
```
OH_Predicates*(* OH_Predicates::orOperate) (OH_Predicates *predicates)
```
@@ -2048,21 +2046,8 @@ Returns the predicates with the OR operator.
[OH_Predicates](_o_h___predicates.md).
-### path
-
-
-```
-const char* OH_Rdb_Config::path
-```
-
-**Description**
-
-Path of the database file.
-
-
### putBlob
-
```
int(* OH_VBucket::putBlob) (OH_VBucket *bucket, const char *field, const uint8_t *value, uint32_t size)
```
@@ -2091,7 +2076,6 @@ Returns **RDB_OK** is the operation is successful; returns an error code otherwi
### putDouble
-
```
int(* OH_VObject::putDouble) (OH_VObject *valueObject, double *value, uint32_t count)
```
@@ -2119,7 +2103,6 @@ Returns **RDB_OK** is the operation is successful; returns an error code otherwi
### putInt64 [1/2]
-
```
int(* OH_VBucket::putInt64) (OH_VBucket *bucket, const char *field, int64_t value)
```
@@ -2147,7 +2130,6 @@ Returns **RDB_OK** is the operation is successful; returns an error code otherwi
### putInt64 [2/2]
-
```
int(* OH_VObject::putInt64) (OH_VObject *valueObject, int64_t *value, uint32_t count)
```
@@ -2175,7 +2157,6 @@ Returns **RDB_OK** is the operation is successful; returns an error code otherwi
### putNull
-
```
int(* OH_VBucket::putNull) (OH_VBucket *bucket, const char *field)
```
@@ -2202,14 +2183,13 @@ Returns **RDB_OK** is the operation is successful; returns an error code otherwi
### putReal
-
```
int(* OH_VBucket::putReal) (OH_VBucket *bucket, const char *field, double value)
```
**Description**
-Puts the double value into the {OH_VBucket} object of the given column name.
+Puts a double value into the [OH_VBucket](_o_h___v_bucket.md) object in the given column.
**Parameters**
@@ -2230,7 +2210,6 @@ Returns **RDB_OK** is the operation is successful; returns an error code otherwi
### putText [1/2]
-
```
int(* OH_VBucket::putText) (OH_VBucket *bucket, const char *field, const char *value)
```
@@ -2245,7 +2224,7 @@ Puts a char value into the [OH_VBucket](_o_h___v_bucket.md) object in the given
| -------- | -------- |
| bucket | Pointer to the [OH_VBucket](_o_h___v_bucket.md) instance.|
| field | Pointer to the column name in the database table.|
-| value | Pointer to the char value to put.|
+| value | Pointer to the value to put.|
**Returns**
@@ -2258,7 +2237,6 @@ Returns **RDB_OK** is the operation is successful; returns an error code otherwi
### putText [2/2]
-
```
int(* OH_VObject::putText) (OH_VObject *valueObject, const char *value)
```
@@ -2285,7 +2263,6 @@ Returns **RDB_OK** is the operation is successful; returns an error code otherwi
### putTexts
-
```
int(* OH_VObject::putTexts) (OH_VObject *valueObject, const char **value, uint32_t count)
```
@@ -2313,11 +2290,21 @@ Returns **RDB_OK** is the operation is successful; returns an error code otherwi
### securityLevel
-
```
-enum OH_Rdb_SecurityLevel OH_Rdb_Config::securityLevel
+int OH_Rdb_Config::securityLevel
```
**Description**
Set the RDB store security level [OH_Rdb_SecurityLevel](#oh_rdb_securitylevel).
+
+
+### selfSize
+
+```
+int OH_Rdb_Config::selfSize
+```
+
+**Description**
+
+Size of the struct.
diff --git a/en/application-dev/reference/native-apis/context_8h.md b/en/application-dev/reference/native-apis/context_8h.md
index 743fdbc9dbfe3d3d4b3b464b0301999631980790..2445e715d0d08dd3d6442848e33a8f6487722788 100644
--- a/en/application-dev/reference/native-apis/context_8h.md
+++ b/en/application-dev/reference/native-apis/context_8h.md
@@ -52,15 +52,17 @@ Provides **Context** APIs for configuring runtime information.
| [OH_AI_DeviceInfoSetFrequency](_mind_spore.md#oh_ai_deviceinfosetfrequency) ([OH_AI_DeviceInfoHandle](_mind_spore.md#oh_ai_deviceinfohandle) device_info, int frequency) | Sets the NPU frequency type. This function is available only for NPU devices.|
| [OH_AI_DeviceInfoGetFrequency](_mind_spore.md#oh_ai_deviceinfogetfrequency) (const [OH_AI_DeviceInfoHandle](_mind_spore.md#oh_ai_deviceinfohandle) device_info) | Obtains the NPU frequency type. This function is available only for NPU devices.|
| [OH_AI_GetAllNNRTDeviceDescs](_mind_spore.md#oh_ai_getallnnrtdevicedescs) (size_t \*num) | Obtains the descriptions of all NNRt devices in the system.|
-| [OH_AI_DestroyAllNNRTDeviceDescs](_mind_spore.md#oh_ai_destroyallnnrtdevicedescs) ([NNRTDeviceDesc](_mind_spore.md#nnrtdevicedesc) \*\*desc) | Destroys the array of NNRT descriptions obtained by [OH_AI_GetAllNNRTDeviceDescs](_mind_spore.md#oh_ai_getallnnrtdevicedescs).|
+| [OH_AI_GetElementOfNNRTDeviceDescs](_mind_spore.md#oh_ai_getelementofnnrtdevicedescs) (NNRTDeviceDesc \*descs, size_t index) | Obtains the pointer to an element in the NNRt device description array.|
+| [OH_AI_DestroyAllNNRTDeviceDescs](_mind_spore.md#oh_ai_destroyallnnrtdevicedescs) ([NNRTDeviceDesc](_mind_spore.md#nnrtdevicedesc) \*\*desc) | Destroys the NNRt device description array obtained by [OH_AI_GetAllNNRTDeviceDescs](_mind_spore.md#oh_ai_getallnnrtdevicedescs).|
| [OH_AI_GetDeviceIdFromNNRTDeviceDesc](_mind_spore.md#oh_ai_getdeviceidfromnnrtdevicedesc) (const [NNRTDeviceDesc](_mind_spore.md#nnrtdevicedesc) \*desc) | Obtains the NNRt device ID from the specified NNRt device description. Note that this ID is valid only for NNRt devices.|
| [OH_AI_GetNameFromNNRTDeviceDesc](_mind_spore.md#oh_ai_getnamefromnnrtdevicedesc) (const [NNRTDeviceDesc](_mind_spore.md#nnrtdevicedesc) \*desc) | Obtains the NNRt device name from the specified NNRt device description.|
| [OH_AI_GetTypeFromNNRTDeviceDesc](_mind_spore.md#oh_ai_gettypefromnnrtdevicedesc) (const [NNRTDeviceDesc](_mind_spore.md#nnrtdevicedesc) \*desc) | Obtains the NNRt device type from the specified NNRt device description.|
| [OH_AI_CreateNNRTDeviceInfoByName](_mind_spore.md#oh_ai_creatennrtdeviceinfobyname) (const char \*name) | Searches for the NNRt device with the specified name and creates the NNRt device information based on the information about the first found NNRt device.|
| [OH_AI_CreateNNRTDeviceInfoByType](_mind_spore.md#oh_ai_creatennrtdeviceinfobytype) ([OH_AI_NNRTDeviceType](_mind_spore.md#oh_ai_nnrtdevicetype) type) | Searches for the NNRt device with the specified type and creates the NNRt device information based on the information about the first found NNRt device.|
-| [OH_AI_DeviceInfoSetDeviceId](_mind_spore.md#oh_ai_deviceinfosetdeviceid) ([OH_AI_DeviceInfoHandle](_mind_spore.md#oh_ai_deviceinfohandle) device_info, size_t device_id) | Sets the ID of an NNRt device. This API is available only for NNRt devices.|
-| [OH_AI_DeviceInfoGetDeviceId](_mind_spore.md#oh_ai_deviceinfogetdeviceid) (const [OH_AI_DeviceInfoHandle](_mind_spore.md#oh_ai_deviceinfohandle) device_info) | Obtains the ID of an NNRt device. This API is available only for NNRt devices.|
-| [OH_AI_DeviceInfoSetPerformanceMode](_mind_spore.md#oh_ai_deviceinfosetperformancemode) ([OH_AI_DeviceInfoHandle](_mind_spore.md#oh_ai_deviceinfohandle) device_info, [OH_AI_PerformanceMode](_mind_spore.md#oh_ai_performancemode) mode) | Sets the performance mode of an NNRt device. This API is available only for NNRt devices.|
-| [OH_AI_DeviceInfoGetPerformanceMode](_mind_spore.md#oh_ai_deviceinfogetperformancemode) (const [OH_AI_DeviceInfoHandle](_mind_spore.md#oh_ai_deviceinfohandle) device_info) | Obtains the performance mode of an NNRt device. This API is available only for NNRt devices.|
-| [OH_AI_DeviceInfoSetPriority](_mind_spore.md#oh_ai_deviceinfosetpriority) ([OH_AI_DeviceInfoHandle](_mind_spore.md#oh_ai_deviceinfohandle) device_info, [OH_AI_Priority](_mind_spore.md#oh_ai_priority) priority) | Sets the priority of an NNRT task. This API is available only for NNRt devices.|
-| [OH_AI_DeviceInfoGetPriority](_mind_spore.md#oh_ai_deviceinfogetpriority) (const [OH_AI_DeviceInfoHandle](_mind_spore.md#oh_ai_deviceinfohandle) device_info) | Obtains the priority of an NNRT task. This API is available only for NNRt devices.|
+| [OH_AI_DeviceInfoSetDeviceId](_mind_spore.md#oh_ai_deviceinfosetdeviceid) ([OH_AI_DeviceInfoHandle](_mind_spore.md#oh_ai_deviceinfohandle) device_info, size_t device_id) | Sets the ID of an NNRt device. This function is available only for NNRt devices.|
+| [OH_AI_DeviceInfoGetDeviceId](_mind_spore.md#oh_ai_deviceinfogetdeviceid) (const [OH_AI_DeviceInfoHandle](_mind_spore.md#oh_ai_deviceinfohandle) device_info) | Obtains the ID of an NNRt device. This function is available only for NNRt devices.|
+| [OH_AI_DeviceInfoSetPerformanceMode](_mind_spore.md#oh_ai_deviceinfosetperformancemode) ([OH_AI_DeviceInfoHandle](_mind_spore.md#oh_ai_deviceinfohandle) device_info, [OH_AI_PerformanceMode](_mind_spore.md#oh_ai_performancemode) mode) | Sets the performance mode of an NNRt device. This function is available only for NNRt devices.|
+| [OH_AI_DeviceInfoGetPerformanceMode](_mind_spore.md#oh_ai_deviceinfogetperformancemode) (const [OH_AI_DeviceInfoHandle](_mind_spore.md#oh_ai_deviceinfohandle) device_info) | Obtains the performance mode of an NNRt device. This function is available only for NNRt devices.|
+| [OH_AI_DeviceInfoSetPriority](_mind_spore.md#oh_ai_deviceinfosetpriority) ([OH_AI_DeviceInfoHandle](_mind_spore.md#oh_ai_deviceinfohandle) device_info, [OH_AI_Priority](_mind_spore.md#oh_ai_priority) priority) | Sets the priority of an NNRt task. This function is available only for NNRt devices.|
+| [OH_AI_DeviceInfoGetPriority](_mind_spore.md#oh_ai_deviceinfogetpriority) (const [OH_AI_DeviceInfoHandle](_mind_spore.md#oh_ai_deviceinfohandle) device_info) | Obtains the priority of an NNRt task. This function is available only for NNRt devices.|
+| [OH_AI_DeviceInfoAddExtension](_mind_spore.md#oh_ai_deviceinfoaddextension) ([OH_AI_DeviceInfoHandle](_mind_spore.md#oh_ai_deviceinfohandle) device_info, const char \*name, const char \*value, size_t value_size) | Adds extended configuration in the form of key/value pairs to the device information. This function is available only for NNRt device information.|
diff --git a/en/application-dev/reference/native-apis/oh__cursor_8h.md b/en/application-dev/reference/native-apis/oh__cursor_8h.md
index d51368c059814c2f7e4f0daa34e7cc0e6484254b..16c0e0bd4e097d4570c9ff93fa2b26b11bb13488 100644
--- a/en/application-dev/reference/native-apis/oh__cursor_8h.md
+++ b/en/application-dev/reference/native-apis/oh__cursor_8h.md
@@ -30,6 +30,7 @@ A result set is a set of results returned by **query()**.
| Name| Description|
| -------- | -------- |
+| [OH_ColumnType](_r_d_b.md#oh_columntype) | Enumerates the field types in an RDB store.|
| [OH_Cursor](_r_d_b.md#oh_cursor) | Indicates a result set.|
@@ -37,4 +38,4 @@ A result set is a set of results returned by **query()**.
| Name| Description|
| -------- | -------- |
-| [OH_ColumnType](_r_d_b.md#oh_columntype) {10+ | Obtains the certificate serial number.|
| X509Cert | getIssuerName() : DataBlob | Obtains the certificate issuer. |
| X509Cert | getSubjectName() : DataBlob | Obtains the certificate subject. |
| X509Cert | getNotBeforeTime() : string | Obtains the time from which the certificate takes effect. |
@@ -489,7 +489,7 @@ function certChainValidatorSample() {
data: encodingData,
// Number of certificates. It is 2 in this example.
count: 2,
- // Certificate format. PEM and DER are supported. In this example, the certificate is in PEM format.
+ // Certificate format. Only PEM and DER are supported. In this example, the certificate is in PEM format.
encodingFormat: cryptoCert.EncodingFormat.FORMAT_PEM
};
@@ -572,4 +572,4 @@ function crlEntrySample() {
}
});
}
-```
+```
\ No newline at end of file
diff --git a/en/application-dev/security/permission-group-list.md b/en/application-dev/security/permission-group-list.md
index 79e1b286ea5a95be65b379aaad212868d878bc77..321da782b1120c6394cd01d9563dc32197b561dc 100644
--- a/en/application-dev/security/permission-group-list.md
+++ b/en/application-dev/security/permission-group-list.md
@@ -86,3 +86,7 @@ The following lists the permission groups supported currently. For details about
## Installed Bundle List
- ohos.permission.GET_INSTALLED_BUNDLE_LIST
+
+## Bluetooth
+
+- ohos.permission.ACCESS_BLUETOOTH
diff --git a/en/application-dev/security/permission-list.md b/en/application-dev/security/permission-list.md
index 138f98bd08423c303fe73489104251f7638f0102..2b46db1e6555e0e408b026deb7ff35d54d789fdc 100644
--- a/en/application-dev/security/permission-list.md
+++ b/en/application-dev/security/permission-list.md
@@ -2520,7 +2520,7 @@ Allows an application to manage the upload sessions.
## ohos.permission.PREPARE_APP_TERMINATE
-Allows an application to perform customized pre-termination actions before being terminated.
+Allows an application to perform customized actions before being terminated.
**Permission level**: normal
@@ -2731,3 +2731,15 @@ Allows an application to restore pre-installed applications.
**Enable via ACL**: TRUE
**Start version**: 10
+
+## ohos.permission.GET_DOMAIN_ACCOUNTS
+
+Allows an application to obtain domain account information.
+
+**Permission level**: system_basic
+
+**Authorization mode**: system_grant
+
+**Enable via ACL**: TRUE
+
+**Start version**: 10
diff --git a/en/application-dev/security/userauth-guidelines.md b/en/application-dev/security/userauth-guidelines.md
index f2bac259a83a5b595b69875cd99f47afda0b27e2..a245754fbf8432cdb018300a780f9c101d22267d 100644
--- a/en/application-dev/security/userauth-guidelines.md
+++ b/en/application-dev/security/userauth-guidelines.md
@@ -1,11 +1,12 @@
# User Authentication Development
->  **NOTE**** tag to mark its earliest version. The format is **versionNumber+ **, for example, **7+ **.** tag to the new attribute name, for example, **newAttribute7+ **.** tag to the method name, for example, **sim.getSimIccId7+ **. The same rule applies to new interfaces, classes, and enums.|
| 7 | Deprecated API description | Do not delete the deprecated content from the document. Instead, suffix **deprecated** as a superscript to the content, and use the greater-than sign (**>**) to introduce the initial version and deprecated version.(deprecated) **, the reference file name is `ts-basic-component-text.md`.**, the reference file name is `js-container-component-list.md`. |
-| 4 | Directory update | After uploading a TS component reference document, update the `Readme-EN.md` file in `docs/en/application-dev/reference/arkui-ts`. |
-| 5 | Document structure | - Component description` tag to mark its initial version. The format is `versionNumber+ `, for example, `7+ `.` tag to mark its initial version. The format is `newAttributeversionNumber+ `, for example, `newAttribute7+ `. |
+| 2 | Upload path | Upload markdown files to `docs/en/application-dev/reference/arkui-ts`.**, the reference file name is `ts-basic-component-text.md`.**, the reference file name is `js-container-component-list.md`.|
+| 4 | Directory update | After uploading a TS component reference document, update the `Readme-EN.md` file in `docs/en/application-dev/reference/arkui-ts`.|
+| 5 | Document structure | - Component description` tag to mark its initial version. The format is `versionNumber+ `, for example, `7+ `.` tag to mark its initial version. The format is `newAttributeversionNumber+ `, for example, `newAttribute7+ `.|
| 7 | Deprecated API description | Do not delete the deprecated content from the document. Instead, suffix `deprecated` as a superscript to the content, and use the greater-than sign (`>`) to introduce the substitute API plus a link to the API description.(deprecated) 7+ ]\(#xxxa7). The text in the intra-topic link must be the same as the title to be linked. In the link, all letters must be in lowercase, and no special character (except the hyphen) or tag is included.|
diff --git a/en/device-dev/device-test/Readme-EN.md b/en/device-dev/device-test/Readme-EN.md
index 4ca9e2c13290f008cf73f231874cf598cb1edc0b..f7fd5978e51c8f2d17c636952239539af78b7c9f 100644
--- a/en/device-dev/device-test/Readme-EN.md
+++ b/en/device-dev/device-test/Readme-EN.md
@@ -2,5 +2,5 @@
- [Development Self-Test Framework User Guide](developer_test.md)
- [xDevice User Guide](xdevice.md)
+- [Smartperf-Host User Guide](smartperf-host.md)
- [XTS Test Case Development Guide](xts.md)
-
diff --git a/en/device-dev/device-test/developer_test.md b/en/device-dev/device-test/developer_test.md
index a3d699e62c32a222ab10d8a8c24cf0babd48267d..d31659033970f2d9750776724a54e3857dbb5172 100644
--- a/en/device-dev/device-test/developer_test.md
+++ b/en/device-dev/device-test/developer_test.md
@@ -95,7 +95,7 @@ Click [here](https://gitee.com/openharmony/docs/blob/master/en/device-dev/get-co
6. Install the NFS server if the device outputs results only through the serial port.
- >  **NOTE**
+ > **NOTE**
>
> This operation applies to small-system or mini-system devices, not standard-system devices.
@@ -260,7 +260,7 @@ The test framework supports multiple types of tests and provides different test
{
// Set a teardown function, which will be called after all test cases.
}
- ```
+ ```
5. Add implementation of the test cases, including test case comments and logic.
```
@@ -279,11 +279,11 @@ The test framework supports multiple types of tests and provides different test
EXPECT_EQ(4, actual);
}
```
- >  **NOTE**
- >
- > The value of **@tc.require** must start with AR/SR or issue, for example, **issueI56WJ7**.
+ > **NOTE**
+ >
+ > The value of **@tc.require** must start with AR/SR or issue, for example, **issueI56WJ7**.
-- The following uses base_object_test.cpp as an example to describe how to compile a multi-thread test case:
+- The following uses **base_object_test.cpp** as an example to describe how to compile a multi-thread test case:
```
// The test case file header comment and test case comment are the same as those in the single-thread test case example.
@@ -345,16 +345,17 @@ The test framework supports multiple types of tests and provides different test
The procedure is as follows:
1. Add comment information to the test case file header.
- > **NOTE**
#include
#include
using namespace testing::ext;
- using namespace testing::mt;
- ```
+ using namespace testing::mt;
+ ```
3. Add the header file of the test class.
```
#include "base_object.h"
@@ -364,9 +365,11 @@ The test framework supports multiple types of tests and provides different test
class AAFwkBaseObjectTest : public testing::Test {......}
```
- > **NOTE**D:\Test\testcase\tests
```
- >  **NOTE**
+ > **NOTE**
>
> **\** indicates whether to build test cases. **\** indicates the path for searching for test cases.
@@ -1206,7 +1211,7 @@ To enable test cases to be executed on a remote Linux server or a Linux VM, map
hdc_std kill
hdc_std -m -s 0.0.0.0:8710
```
- >  **NOTE**
+ > **NOTE**
>
> The IP address and port number are default values.
@@ -1214,7 +1219,7 @@ To enable test cases to be executed on a remote Linux server or a Linux VM, map
```
hdc_std -s xx.xx.xx.xx:8710 list targets
```
- >  **NOTE**
+ > **NOTE**
>
> Enter the IP address of the device to test.
@@ -1347,7 +1352,7 @@ You can obtain the test result in the following directory:
```
test/developertest/reports/xxxx_xx_xx_xx_xx_xx
```
->  **NOTE**
+> **NOTE**
>
> The test report folder is automatically generated.
@@ -1355,9 +1360,9 @@ The folder contains the following files:
| Type | Description |
| ------------------------------------ | ------------------ |
| result/ | Test cases in standard format.|
-| log/plan_log_xxxx_xx_xx_xx_xx_xx.log | Test case logs. |
-| summary_report.html | Test report summary. |
-| details_report.html | Detailed test report. |
+| log/plan_log_xxxx_xx_xx_xx_xx_xx.log | Test case logs. |
+| summary_report.html | Test report summary. |
+| details_report.html | Detailed test report. |
@@ -1372,6 +1377,7 @@ When GCDA data is available, you can execute the test cases as follows for subsy
run -tp partname
run -tp partname1 partname2
+
2. Before compiling the version, modify the compilation options. Add **-- coverage** to the **cflags**, **cflags_cc**, and **ldflags** options in the **build.gn** file of the involved subsystem.
ldflags = [ "--coverage" ]
@@ -1379,6 +1385,7 @@ When GCDA data is available, you can execute the test cases as follows for subsy
C++: cflags_cc = [ "--coverage" ]
**Recommended**: You can also refer to the mode for the window subsystem. For details, see the files in this [pull request](https://gitee.com/openharmony/window_window_manager/pulls/1274/files).
+
3. To execute coverage test cases, perform the following to install the dependencies:
1. Run the **sudo apt install lcov** command to install lcov.
@@ -1403,7 +1410,9 @@ When GCDA data is available, you can execute the test cases as follows for subsy
run -t UT -ss *Subsystem name* -tp **Part name** -cov coverage
run -t UT MST ST -tp *Part name* -cov coverage
- Note: The **-cov coverage** parameter must be added to the preceding commands.
+ > **NOTE**
+ >
+ > The **-cov coverage** parameter must be added to the preceding commands.
6. Obtain the coverage report from the following paths:
diff --git a/en/device-dev/get-code/sourcecode-acquire.md b/en/device-dev/get-code/sourcecode-acquire.md
index bda7306a445adef5ce83ea0195fc0d0f5a18bd8e..6d6555dfe4cd4bca3e46256d83618917bafc071d 100644
--- a/en/device-dev/get-code/sourcecode-acquire.md
+++ b/en/device-dev/get-code/sourcecode-acquire.md
@@ -201,12 +201,12 @@ The table below provides only the sites for downloading the latest OpenHarmony L
| Hi3516 solution-Linux (binary)| 3.0 | [Download](https://repo.huaweicloud.com/openharmony/os/3.0/hispark_taurus_linux.tar.gz)| [Download](https://repo.huaweicloud.com/openharmony/os/3.0/hispark_taurus_linux.tar.gz.sha256) | 418.1 MB |
| RELEASE-NOTES | 3.0 | [Download](https://gitee.com/openharmony/docs/blob/OpenHarmony-3.0-LTS/en/release-notes/OpenHarmony-v3.0-LTS.md)| - | - |
| **Source Code of the Latest Release**| **Version**| **Site**| **SHA-256 Checksum**| **Software Package Size**|
-| Full code base (for mini, small, and standard systems) | 4.0 Beta1 | [Download](https://repo.huaweicloud.com/openharmony/os/4.0-Beta1/code-v4.0-Beta1.tar.gz)| [Download](https://repo.huaweicloud.com/openharmony/os/4.0-Beta1/code-v4.0-Beta1.tar.gz.sha256)| 26.2 GB |
-| Hi3861 solution (binary) | 4.0 Beta1 | [Download](https://repo.huaweicloud.com/openharmony/os/4.0-Beta1/hispark_pegasus.tar.gz) | [Download](https://repo.huaweicloud.com/openharmony/os/4.0-Beta1/hispark_pegasus.tar.gz.sha256)| 25.1 MB |
-| Hi3516 solution-LiteOS (binary)| 4.0 Beta1 | [Download](https://repo.huaweicloud.com/openharmony/os/4.0-Beta1/hispark_taurus_LiteOS.tar.gz)| [Download](https://repo.huaweicloud.com/openharmony/os/4.0-Beta1/hispark_taurus_LiteOS.tar.gz.sha256)| 287.6 MB |
-| Hi3516 solution-Linux (binary) | 4.0 Beta1 | [Download](https://repo.huaweicloud.com/openharmony/os/4.0-Beta1/hispark_taurus_Linux.tar.gz)| [Download](https://repo.huaweicloud.com/openharmony/os/4.0-Beta1/hispark_taurus_Linux.tar.gz.sha256)| 186.4 MB |
-| RK3568 standard system solution (binary) | 4.0 Beta1 | [Download](https://repo.huaweicloud.com/openharmony/os/4.0-Beta1/dayu200_standard_arm32.tar.gz)| [Download](https://repo.huaweicloud.com/openharmony/os/4.0-Beta1/dayu200_standard_arm32.tar.gz.sha256)| 4.5 GB |
-| RELEASE-NOTES | 4.0 Beta1 | [Download](../../release-notes/OpenHarmony-v4.0-beta1.md)| - | - |
+| Full code base (for mini, small, and standard systems) | 4.0 Beta2 | [Download](https://repo.huaweicloud.com/openharmony/os/4.0-Beta2/code-v4.0-Beta2.tar.gz)| [Download](https://repo.huaweicloud.com/openharmony/os/4.0-Beta2/code-v4.0-Beta2.tar.gz.sha256)| 27.7 GB |
+| Hi3861 solution (binary) | 4.0 Beta2 | [Download](https://repo.huaweicloud.com/openharmony/os/4.0-Beta2/hispark_pegasus.tar.gz)| [Download](https://repo.huaweicloud.com/openharmony/os/4.0-Beta2/hispark_pegasus.tar.gz.sha256)| 27.5 MB |
+| Hi3516 solution-LiteOS (binary)| 4.0 Beta2 | [Download](https://repo.huaweicloud.com/openharmony/os/4.0-Beta2/hispark_taurus_LiteOS.tar.gz)| [Download](https://repo.huaweicloud.com/openharmony/os/4.0-Beta2/hispark_taurus_LiteOS.tar.gz.sha256)| 300.9 MB |
+| Hi3516 solution-Linux (binary) | 4.0 Beta2 | [Download](https://repo.huaweicloud.com/openharmony/os/4.0-Beta2/hispark_taurus_Linux.tar.gz)| [Download](https://repo.huaweicloud.com/openharmony/os/4.0-Beta2/hispark_taurus_Linux.tar.gz.sha256)| 192.4 MB |
+| RK3568 standard system solution (binary) | 4.0 Beta2 | [Download](https://repo.huaweicloud.com/openharmony/os/4.0-Beta2/dayu200_standard_arm32.tar.gz)| [Download](https://repo.huaweicloud.com/openharmony/os/4.0-Beta2/dayu200_standard_arm32.tar.gz.sha256)| 5.2 GB |
+| RELEASE-NOTES | 4.0 Beta1 | [Download](../../release-notes/OpenHarmony-v4.0-beta2.md) | - | - |
| **Compiler Toolchain**| **Version**| **Site**| **SHA-256 Checksum**| **Software Package Size**|
| Compiler toolchain| - | [Download](https://repo.huaweicloud.com/openharmony/os/2.0/tool_chain/)| - | - |
diff --git a/en/device-dev/subsystems/Readme-EN.md b/en/device-dev/subsystems/Readme-EN.md
index 996d167977dbd065df2c730b565bcfa7790cb3ba..b523ddf6c05fe9da6f17719966cdf5b4e3c01675 100644
--- a/en/device-dev/subsystems/Readme-EN.md
+++ b/en/device-dev/subsystems/Readme-EN.md
@@ -24,8 +24,6 @@
- [Using Cargo2gn](subsys-build-cargo2gn-guide.md)
- [FAQs](subsys-build-FAQ.md)
- [ArkCompiler Development](subsys-arkcompiler-guide.md)
-- Graphics
- - [Graphics Overview](subsys-graphics-overview.md)
- ArkUI
- [Custom Window Title Bar Development](subsys-arkui-customize_titlebar.md)
- Small-System Graphics
diff --git a/en/device-dev/subsystems/subsys-boot-overview.md b/en/device-dev/subsystems/subsys-boot-overview.md
index 2636bc078baedad412e0e96ab6fcf022bf0328b0..24e184b3dbe611885e1c697d33621ea13fd70dc1 100644
--- a/en/device-dev/subsystems/subsys-boot-overview.md
+++ b/en/device-dev/subsystems/subsys-boot-overview.md
@@ -11,45 +11,45 @@ The following figure shows the context structure of the Startup subsystem.
When the system is powered on, the kernel loads and starts services and applications as follows:
-1. The kernel loads the init process, which is specified by **cmdline** of the kernel when the bootloader starts the kernel.
-2. After the init process is started, **tmpfs** and **procfs** are mounted and basic **dev** nodes are created to establish a basic root file system.
-3. The init process starts the ueventd process to listen for device hot-swap events in the kernel and creates **dev** nodes for related devices as well as partitions for the block device.
-4. After mounting partitions (**system** and **vendor**) of the block device, the init process scans for the init startup script of each system service and starts the respective system ability (SA).
+1. The kernel loads the init process, which is specified by `cmdline` of the kernel when the bootloader starts the kernel.
+2. After the init process is started, `tmpfs` and `procfs` are mounted and basic `dev` nodes are created to establish a basic root file system.
+3. The init process starts the ueventd process to listen for device hot-swap events in the kernel and creates `dev` nodes for related devices as well as partitions for the block device.
+4. After mounting partitions (`system` and `vendor`) of the block device, the init process scans for the init startup script of each system service and starts the respective system ability (SA).
5. Each SA registers with the samgr process, which serves as the service registration center. The samgr process assigns each SA with an ID, which will be used by an application to access the desired SA.
-6. The foundation process sends the application startup request to the appspawn process. The foundation implements application lifecycle management. It is a special SA service process that provides the user program management framework and basic services.
-7. The appspawn process directly spawns the application process, eliminating the need for the application to load the JS runtime environment. This reduces the application startup time.
+6. The foundation process implements application lifecycle management. It is a special SA service process that provides the user program management framework and basic services.
+7. For an application, loading of the JS running environment involves a great deal of preparations. To reduce the application startup time, the appspawn process directly spawns an application process once receiving an application startup request from the foundation process.
The Startup subsystem consists of the following modules:
-- init module
+- init Module
- This module corresponds to the init process, which is the first user-mode process started after the kernel is initialized. After the init process starts, it reads and parses the **init.cfg** file. Based on the parsing result, the init module executes the commands listed in Table 2 in [Job Management](../subsystems/subsys-boot-init-jobs.md) and starts the key system service processes in sequence with corresponding permissions granted.
+ This module corresponds to the init process, which is the first user-space process started after the kernel is initialized. After the init process starts, it reads and parses the `init.cfg` file. Based on the parsing result, the init module executes the commands listed in Table 2 in [Job Management](../subsystems/subsys-boot-init-jobs.md#available-apis) and starts the key system service processes in sequence with corresponding permissions granted.
- ueventd module
- This module listens for **netlink** events about hot swap of kernel device drivers and dynamically manages the **dev** node of the corresponding device based on the event type.
+ This module listens for **netlink** events about hot plug of kernel device drivers and dynamically manages the `dev` node of the corresponding device based on the event type.
-- appspawn module
+- appspawn Module
This module spawns application processes upon receiving commands from the foundation, configures permissions for new processes, and calls the entry function of the application framework.
-- bootstrap module
+- bootstrap Module
- This module provides entry identifiers for starting services and features. When SAMGR is started, the entry function identified by bootstrap is called and system services are started.
+ This module provides entry identifiers for starting services and features. When samgr is started, the entry function identified by bootstrap is called and system services are started.
-- syspara module
+- syspara
This module provides APIs for obtaining device information, such as the product name, brand name, and manufacturer name, based on the OpenHarmony Product Compatibility Specifications (PCS). It also provides APIs for setting and obtaining system attributes.
## Constraints
- The source code directory of the Startup subsystem varies according to the platform.
+ The source code directory of the Startup subsystem varies according to the platform.
- **Table 1** Directories and applicable platforms of the Startup subsystem
+ **Table 1** Directories and applicable platforms of the Startup subsystem
-| Source Code Directory| Applicable Platform|
+| Name| Applicable Platform|
| -------- | -------- |
| base/startup/appspawn_lite | Small-system devices (reference memory ≥ 1 MiB), for example, Hi3516D V300 and Hi3518E V300|
| base/startup/bootstrap_lite | Mini-system devices (reference memory ≥ 128 KiB), for example, Hi3861 V100|
@@ -57,14 +57,14 @@ The Startup subsystem consists of the following modules:
| base/startup/syspara_lite | - Mini-system devices (reference memory ≥ 128 KiB), for example, Hi3861 V100
-
- class DemoListener : public OHOS::HiviewDFX::HiSysEventListener {
- public:
- explicit DemoListener() : HiSysEventListener() {}
- virtual ~DemoListener() {}
-
- public:
- void OnEvent(std::shared_ptr sysEvent);
- void OnServiceDied();
- };
-
- #endif // DEMO_LISTENER_H
- ```
-
- Create the **DemoListener.cpp** file, and add the implementation logic of the custom event callback API in the **DemoListener** class.
-
- ```
- #include "demo_listener.h"
-
- #include
-
- void DemoListener::OnEvent(std::shared_ptr sysEvent)
- {
- if (sysEvent == nullptr) {
- return;
+|std::string HiSysEventRecord::AsJson()|Obtains the content of a system event. record)
+ {
+ if (record == nullptr) {
+ return;
+ }
+ std::cout << record->AsJson() << std::endl;
+ }
+
+ void OnServiceDied()
+ {
+ std::cout << std::string("service disconnect, exit") << std::endl;
+ exit(0);
+ }
+ };
+ ```
+
+3. Call the listening API while passing in parameters such as **listener** and **rules**. When the service ends, disable event listening.
+
+ ```c++
+ auto testListener = std::make_shared();
+ // Add a ListenerRule object based on the event tag, with RuleType left unspecified (in this case, ruleType is defaulted to WHOLE_WORD).
+ ListenerRule tagRule("dfx");
+ // Add a ListenerRule object based on the event tag, with RuleType set as REGULAR.
+ ListenerRule regRule("dfx.*", RuleType::REGULAR);
+ // Add a ListenerRule object based on the event domain and event name, with RuleType set as PREFIX.
+ ListenerRule domainNameRule("HIVIEWDFX", "APP_USAGE", RuleType::PREFIX);
+ std::vector sysRules;
+ sysRules.push_back(tagRule);
+ sysRules.push_back(regRule);
+ sysRules.push_back(domainNameRule);
+ // Start event listening.
+ auto ret = HiSysEventManager::AddEventListener(testListener, sysRules);
+ // Remove the listener when the service ends.
+ if (ret == 0) {
+ HiSysEventManager::RemoveListener(testListener);
+ }
+ ```
+
+#### C HiSysEvent Listening
+
+1. Import the corresponding header file.
+
+ ```c++
+ #include "hisysevent_manager_c.h"
+ ```
+
+2. Implement the callback API for the service domain.
+
+ ```c++
+ void OnEventTest(HiSysEventRecord record)
+ {
+ printf("OnEventTest: event=%s", record.jsonStr);
+ }
+
+ void OnServiceDiedTest()
+ {
+ printf("OnServiceDied");
+ }
+ ```
+
+3. Call the listening API while passing in parameters such as **watcher** and **rules**. When the service ends, disable event listening.
+
+ ```c++
+ HiSysEventWatcher watcher;
+ watcher.OnEvent = OnEventTest;
+ watcher.OnServiceDied = OnServiceDiedTest;
+ // Add a HiSysEventWatchRule object based on the event tag, with RuleType left unspecified (in this case, ruleType is defaulted to WHOLE_WORD).
+ constexpr char DFX_TAG[] = "dfx";
+ HiSysEventWatchRule tagRule;
+ (void)strcpy_s(tagRule.tag, strlen(DFX_TAG) + 1, DFX_TAG);
+ tagRule.ruleType = 1;
+ tagRule.eventType = 0;
+ // Add a HiSysEventWatchRule object based on the event tag, with RuleType set as REGULAR.
+ constexpr char DFX_PATTERN_TAG[] = "dfx.*";
+ HiSysEventWatchRule regRule;
+ (void)strcpy_s(regRule.tag, strlen(DFX_PATTERN_TAG) + 1, DFX_PATTERN_TAG);
+ regRule.ruleType = 3;
+ regRule.eventType = 0;
+ // Add a HiSysEventWatchRule object based on the event domain and event name, with RuleType set as PREFIX.
+ constexpr char DOMAIN[] = "HIVIEWDFX";
+ constexpr char NAME[] = "APP_USAGE";
+ HiSysEventWatchRule domainNameRule;
+ (void)strcpy_s(domainNameRule.domain, strlen(DOMAIN) + 1, DOMAIN);
+ (void)strcpy_s(domainNameRule.name, strlen(NAME) + 1, NAME);
+ domainNameRule.ruleType = 2;
+ domainNameRule.eventType = 0;
+ // Start event listening.
+ HiSysEventWatchRule rules[] = {tagRule, regRule, domainNameRule};
+ int ret = OH_HiSysEvent_Add_Watcher(&watcher, rules, sizeof(rules) / sizeof(HiSysEventWatchRule));
+ // Remove the watcher when the service ends.
+ if (ret == 0) {
+ ret = OH_HiSysEvent_Remove_Watcher(&watcher);
+ }
+ ```
+
+### Development Examples
+
+#### C++ HiSysEvent Listening
+
+Suppose you want to enable listening for all events whose domain is **HIVIEWDFX** and name is **PLUGIN_LOAD**. The sample code is as follows:
+
+1. Add the **libhisysevent** and **libhisyseventmanager** dependencies of the **hisysevent** component to the **BUILD.gn** file of the service module.
+
+ ```c++
+ external_deps = [
+ "hisysevent:libhisysevent",
+ "hisysevent:libhisyseventmanager",
+ ]
+ ```
+
+2. Call the listening API in the **TestEventListening()** function. When the service ends, disable event listening.
+
+ ```c++
+ #include
+
+ #include "hisysevent_manager.h"
+
+ using namespace OHOS::HiviewDFX;
+
+ class TestListener : public HiSysEventQueryCallback {
+ public:
+ void OnEvent(std::shared_ptr record)
+ {
+ if (record == nullptr) {
+ return;
+ }
+ std::cout << record->AsJson() << std::endl;
+ }
+
+ void OnServiceDied()
+ {
+ std::cout << std::string("service disconnect, exit") << std::endl;
+ exit(0);
+ }
+ };
+
+ void TestEventListening()
+ {
+ auto testListener = std::make_shared();
+ ListenerRule domainNameRule("HIVIEWDFX", "PLUGIN_LOAD", RuleType::WHOLE_WORD);
+ std::vector