): void|Calls a custom API.|
## How to Develop
@@ -55,6 +55,7 @@ Example URIs:
The following code snippet shows how to create a Data ability:
```javascript
+ import featureAbility from '@ohos.ability.featureAbility'
import dataAbility from '@ohos.data.dataAbility'
import dataRdb from '@ohos.data.rdb'
@@ -66,7 +67,8 @@ Example URIs:
export default {
onInitialized(abilityInfo) {
console.info('DataAbility onInitialized, abilityInfo:' + abilityInfo.bundleName)
- dataRdb.getRdbStore(STORE_CONFIG, 1, (err, store) => {
+ let context = featureAbility.getContext()
+ dataRdb.getRdbStore(context, STORE_CONFIG, 1, (err, store) => {
console.info('DataAbility getRdbStore callback')
store.executeSql(SQL_CREATE_TABLE, [])
rdbStore = store
diff --git a/en/application-dev/ability/fa-formability.md b/en/application-dev/ability/fa-formability.md
index c1cadebe652dbd9f195e96ed1dec221df0eff849..377d5e4b8faeda387f4eda5a6506d103c3d76395 100644
--- a/en/application-dev/ability/fa-formability.md
+++ b/en/application-dev/ability/fa-formability.md
@@ -1,49 +1,49 @@
# FA Widget Development
## Widget Overview
-A widget is a set of UI components used to display important information or operations for an application. It provides users with direct access to a desired application service, without requiring them to open the application.
+A widget is a set of UI components that display important information or operations specific to an application. It provides users with direct access to a desired application service, without the need to open the application first.
-A widget displays brief information about an application on the UI of another application (host application, currently system applications only) and provides basic interactive functions such as opening a UI page or sending a message.
+A widget usually appears as a part of the UI of another application (which currently can only be a system application) and provides basic interactive features such as opening a UI page or sending a message.
-Basic concepts:
-- Widget provider: an atomic service that controls what and how content is displayed in a widget and interacts with users.
-- Widget host: an application that displays the widget content and controls the position where the widget is displayed in the host application.
-- Widget Manager: a resident agent that manages widgets added to the system and provides functions such as periodic widget update.
+Before you get started, it would be helpful if you have a basic understanding of the following concepts:
+- Widget provider: an atomic service that provides the widget content to display and controls how widget components are laid out and how they interact with users.
+- Widget host: an application that displays the widget content and controls the widget location.
+- Widget Manager: a resident agent that provides widget management features such as periodic widget updates.
> **NOTE**
>
-> The widget host and provider do not keep running all the time. The Widget Manager starts the widget provider to obtain widget information when a widget is added, deleted, or updated.
+> The widget host and provider do not need to be running all the time. The Widget Manager will start the widget provider to obtain widget information when a widget is added, deleted, or updated.
-You only need to develop widget content as the widget provider. The system automatically handles the work done by the widget host and Widget Manager.
+You only need to develop the widget provider. The system automatically handles the work of the widget host and Widget Manager.
-The widget provider controls the widget content to display, component layout, and click events bound to components.
+The widget provider controls the widget content to display, the layout of components used in the widget, and click events bound to the components.
## Development Overview
-In FA widget development, you need to carry out the following operations as a widget provider based on the [Feature Ability (FA) model](fa-brief.md).
+Carry out the following operations to develop the widget provider based on the [FA model](fa-brief.md):
-- Develop the lifecycle callbacks in **LifecycleForm**.
-- Create a **FormBindingData** instance.
-- Update a widget through **FormProvider**.
-- Develop the widget UI pages.
+1. Implement lifecycle callbacks by using the **LifecycleForm** APIs.
+2. Create a **FormBindingData** instance.
+3. Update a widget by using the **FormProvider** APIs.
+4. Develop the widget UI pages.
## Available APIs
-The table below describes the lifecycle callbacks provided in **LifecycleForm**.
+The table below describes the **LifecycleForm** APIs, which represent the lifecycle callbacks of a widget (known as a **Form** instance).
**Table 1** LifecycleForm APIs
| API | Description |
| :----------------------------------------------------------- | :------------------------------------------- |
-| onCreate(want: Want): formBindingData.FormBindingData | Called to notify the widget provider that a **Form** instance (widget) has been created. |
+| onCreate(want: Want): formBindingData.FormBindingData | Called to notify the widget provider that a widget has been created. |
| onCastToNormal(formId: string): void | Called to notify the widget provider that a temporary widget has been converted to a normal one.|
| onUpdate(formId: string): void | Called to notify the widget provider that a widget has been updated. |
| onVisibilityChange(newStatus: { [key: string]: number }): void | Called to notify the widget provider of the change in widget visibility. |
| onEvent(formId: string, message: string): void | Called to instruct the widget provider to receive and process a widget event. |
-| onDestroy(formId: string): void | Called to notify the widget provider that a **Form** instance (widget) has been destroyed. |
-| onAcquireFormState?(want: Want): formInfo.FormState | Called when the widget provider receives the status query result of a widget. |
+| onDestroy(formId: string): void | Called to notify the widget provider that a widget has been destroyed. |
+| onAcquireFormState?(want: Want): formInfo.FormState | Called to instruct the widget provider to receive the status query result of a widget. |
-For details about the **FormProvider** APIs, see [FormProvider](../reference/apis/js-apis-formprovider.md).
+The table below describes the **FormProvider** APIs. For details, see [FormProvider](../reference/apis/js-apis-formprovider.md).
**Table 2** FormProvider APIs
@@ -56,9 +56,9 @@ For details about the **FormProvider** APIs, see [FormProvider](../reference/api
## How to Develop
-### Creating LifecycleForm
+### Implementing Lifecycle Callbacks
-To create a widget in the FA model, you need to implement the lifecycles of **LifecycleForm**. The sample code is as follows:
+To create an FA widget, you need to implement lifecycle callbacks using the **LifecycleForm** APIs. The sample code is as follows:
1. Import the required modules.
@@ -68,7 +68,7 @@ To create a widget in the FA model, you need to implement the lifecycles of **Li
import formProvider from '@ohos.application.formProvider'
```
-2. Implement the lifecycle callbacks of **LifecycleForm**.
+2. Implement lifecycle callbacks for the widget.
```javascript
export default {
@@ -87,7 +87,7 @@ To create a widget in the FA model, you need to implement the lifecycles of **Li
console.log('FormAbility onCastToNormal');
},
onUpdate(formId) {
- // To support scheduled update, periodic update, or update requested by the widget host, override this method for widget data update.
+ // Override this method to support scheduled updates, periodic updates, or updates requested by the widget host.
console.log('FormAbility onUpdate');
let obj = {
"title": "titleOnUpdate",
@@ -119,19 +119,19 @@ To create a widget in the FA model, you need to implement the lifecycles of **Li
### Configuring the Widget Configuration File
-Configure the **config.json** file for the widget.
+The widget configuration file is named **config.json**. Find the **config.json** file for the widget and edit the file depending on your need.
-- The **js** module in the **config.json** file provides the JavaScript resources of the widget. The internal structure is described as follows:
+- The **js** module in the **config.json** file provides JavaScript resources of the widget. The internal structure is described as follows:
| Field| Description | Data Type| Default |
| -------- | ------------------------------------------------------------ | -------- | ------------------------ |
| name | Name of a JavaScript component. The default value is **default**. | String | No |
| pages | Route information about all pages in the JavaScript component, including the page path and page name. The value is an array, in which each element represents a page. The first element in the array represents the home page of the JavaScript FA.| Array | No |
| window | Window-related configurations. | Object | Yes |
- | type | Type of the JavaScript component. Available values are as follows:
@@ -284,7 +284,7 @@ You can use HML, CSS, and JSON to develop the UI page for a JavaScript-programme
```
- - In the CSS file:
+ - CSS file:
```css
.container {
@@ -325,7 +325,7 @@ You can use HML, CSS, and JSON to develop the UI page for a JavaScript-programme
}
```
- - In the JSON file:
+ - JSON file:
```json
{
"data": {
@@ -352,18 +352,18 @@ Now you've got a widget shown below.
You can set router and message events for components on a widget. The router event applies to ability redirection, and the message event applies to custom click events. The key steps are as follows:
-1. Set **onclick** in the HML file to **routerEvent** or **messageEvent**, depending on the **actions** settings in the JSON file.
+1. Set the **onclick** field in the HML file to **routerEvent** or **messageEvent**, depending on the **actions** settings in the JSON file.
2. For the router event, set the following attributes:
- - **action**: **"router"**.
+ - **action**: **router**, which indicates a router event.
- **abilityName**: target ability name, for example, **com.example.entry.MainAbility**, which is the default main ability name in DevEco Studio for the FA model.
- **params**: custom parameters of the target ability. Set them as required. The value can be obtained from **parameters** in **want** used for starting the target ability. For example, in the lifecycle function **onCreate** of the main ability in the FA model, **featureAbility.getWant()** can be used to obtain **want** and its **parameters** field.
3. For the message event, set the following attributes:
- - **action**: **"message"**.
+ - **action**: **message**, which indicates a message event.
- **params**: custom parameters of the message event. Set them as required. The value can be obtained from **message** in the widget lifecycle function **onEvent**.
The code snippet is as follows:
- - In the HML file:
+ - HML file:
```html
@@ -378,7 +378,7 @@ The code snippet is as follows:
```
- - In the JSON file:
+ - JSON file:
```json
{
"data": {
diff --git a/en/application-dev/ability/fa-serviceability.md b/en/application-dev/ability/fa-serviceability.md
index 3bafb0bc097f0277f88ff4489c2731afdad6569e..3cd2620cfdde502f879e1321e782f2d872e0a77d 100644
--- a/en/application-dev/ability/fa-serviceability.md
+++ b/en/application-dev/ability/fa-serviceability.md
@@ -1,64 +1,69 @@
# Service Ability Development
## When to Use
-A Service ability is used to run tasks in the background, such as playing music or downloading files. It does not provide a UI for user interaction. Service abilities can be started by other applications or abilities and can remain running in the background even after the user switches to another application.
+A Service ability is used to run tasks in the background, such as playing music or downloading files. It does not provide a UI for user interaction. Service abilities can be started by other applications or abilities and can keep running in the background even after the user switches to another application.
-## Available APIs
+## Lifecycle APIs
**Table 1** Service ability lifecycle APIs
|API|Description|
|:------|:------|
-|onStart?(): void|Called to initialize a Service ability being created. This callback is invoked only once in the entire lifecycle of a Service ability. The **Want** object passed to this callback must be null.|
-|onCommand?(want: Want, startId: number): void|Called every time a Service ability is created on a client. You can collect calling statistics and perform initialization operations in this callback.|
+|onStart?(): void|Called to initialize a Service ability when the Service ability is being created. This callback is invoked only once in the entire lifecycle of a Service ability.|
+|onCommand?(want: Want, startId: number): void|Called every time a Service ability is created on the client. You can collect calling statistics and perform initialization operations in this callback.|
|onConnect?(want: Want): rpc.RemoteObject|Called when another ability is connected to the Service ability.|
|onDisconnect?(want: Want): void|Called when another ability is disconnected from the Service ability.|
|onStop?(): void|Called when the Service ability is being destroyed. You should override this callback for your Service ability to clear its resources, such as threads and registered listeners.|
+The differences between **onCommand()** and **onConnect()** are as follows:
+ - The **onCommand()** callback is triggered each time the client starts the Service ability by calling **startAbility** or **startAbilityForResult**.
+ - The **onConnect()** callback is triggered each time the client establishes a new connection with the Service ability by calling **connectAbility**.
+
## How to Develop
### Creating and Registering a Service Ability
-1. Override the Service ability-related lifecycle callbacks to implement your own logic for processing interaction requests.
+1. Override the Service ability-related lifecycle callbacks to implement your own logic for processing interaction requests.
- ```javascript
- export default {
- onStart() {
- console.log('ServiceAbility onStart');
- },
- onCommand(want, startId) {
- console.log('ServiceAbility onCommand');
- },
- onConnect(want) {
- console.log('ServiceAbility OnConnect');
- return new FirstServiceAbilityStub('test');
- },
- onDisconnect(want) {
- console.log('ServiceAbility OnDisConnect');
- },
- onStop() {
- console.log('ServiceAbility onStop');
- },
- }
+ ```ts
+ export default {
+ onStart() {
+ console.log('ServiceAbility onStart');
+ },
+ onCommand(want, startId) {
+ console.log('ServiceAbility onCommand');
+ },
+ onConnect(want) {
+ console.log('ServiceAbility OnConnect');
+ // Below lists the implementation of ServiceAbilityStub.
+ return new ServiceAbilityStub('test');
+ },
+ onDisconnect(want) {
+ console.log('ServiceAbility OnDisConnect');
+ },
+ onStop() {
+ console.log('ServiceAbility onStop');
+ }
+ }
```
2. Register a Service ability.
Declare the Service ability in the **config.json** file by setting its **type** attribute to **service**.
- ```javascript
+ ```json
{
- "module": {
- "abilities": [
- {
- "name": ".ServiceAbility",
- "type": "service",
- "visible": true
- ...
- }
- ]
+ "module": {
+ "abilities": [
+ {
+ "name": ".ServiceAbility",
+ "type": "service",
+ "visible": true
...
- }
+ }
+ ]
...
+ }
+ ...
}
```
@@ -68,333 +73,261 @@ A Service ability is used to run tasks in the background, such as playing music
The **Ability** class provides the **startAbility()** API for you to start another Service ability by passing a **Want** object.
-To set information about the target Service ability, you can first construct a **Want** object with the **bundleName** and **abilityName** parameters specified. The meanings of the parameters are as follows:
+To set information about the target Service ability, you can first construct a **Want** object with the **bundleName** and **abilityName** parameters specified.
-- **bundleName** indicates the name of the bundle to which the target ability belongs.
-- **abilityName** indicates the target ability name.
+- **bundleName** specifies the bundle name of the target application.
+- **abilityName** specifies the target ability name.
The following code snippet shows how to start a Service ability running on the local device:
-```javascript
-import featureAbility from '@ohos.ability.featureAbility';
-let promise = featureAbility.startAbility(
+```ts
+import featureAbility from '@ohos.ability.featureAbility'
+
+featureAbility.startAbility(
{
want:
{
bundleName: "com.jstest.service",
- abilityName: "com.jstest.service.ServiceAbility",
- },
+ abilityName: "com.jstest.service.ServiceAbility"
+ }
}
-);
+).then((err) => {
+ console.log("startService success");
+}).catch (err => {
+ console.log("startService FAILED");
+});
```
-After the preceding code is executed, the **startAbility()** API is called to start the Service ability.
-- If the Service ability is not running, the system calls **onStart()** to initialize the Service ability, and then calls **onCommand()** on the Service ability.
+In the preceding code, the **startAbility()** API is used to start the Service ability.
+- If the Service ability is not running, the system initializes the Service ability, and calls **onStart()** and **onCommand()** on the Service ability in sequence.
- If the Service ability is running, the system directly calls **onCommand()** on the Service ability.
-The following code snippet shows how to start a Service ability running on the remote device. For details about **getRemoteDeviceId()**, see [Connecting to a Remote Service Ability](#connecting-to-a-remote-service-ability).
+The following code snippet shows how to start a Service ability running on the remote device. For details, see [Connecting to a Remote Service Ability](#connecting-to-a-remote-service-ability).
+
+```ts
+import featureAbility from '@ohos.ability.featureAbility'
-```javascript
-import featureAbility from '@ohos.ability.featureAbility';
-let promise = featureAbility.startAbility(
+featureAbility.startAbility(
{
want:
{
- deviceId: getRemoteDeviceId(), // Remote device ID
+ deviceId: remoteDeviceId, // Remote device ID.
bundleName: "com.jstest.service",
- abilityName: "com.jstest.service.ServiceAbility",
- },
+ abilityName: "com.jstest.service.ServiceAbility"
+ }
}
-);
+).then((err) => {
+ console.log("startService success");
+}).catch (err => {
+ console.log("startService FAILED");
+});
```
### Stopping a Service Ability
-Once created, the Service ability keeps running in the background. The system does not stop or destroy it unless memory resources must be reclaimed.
+ In normal cases, a Service ability can be stopped by itself or by the system.
+ - The Service ability can call **particleAbility.terminateSelf()** to stop itself.
+ - If the application process where the Service ability is located exits, the Service ability is reclaimed along with the process.
+ - If the Service ability is only accessed through **connectAbility()** (the **onCommand()** callback has never been triggered), the system stops the Service ability when the last connection to the Service ability is disconnected.
### Connecting to a Local Service Ability
-If you need to connect a Service ability to a Page ability or to a Service ability in another application, you must first implement the **IAbilityConnection** API for the connection. A Service ability allows other abilities to connect to it through **connectAbility()**.
+If a Service ability wants to interact with a Page ability or a Service ability in another application, you must first create a connection. A Service ability allows other abilities to connect to it through **connectAbility()**.
You can use either of the following methods to connect to a Service ability:
1. Using the IDL to automatically generate code
- Use OpenHarmony Interface Definition Language (IDL) to automatically generate the corresponding client, server, and **IRemoteObject** code. For details, see “Development Using TS" in [OpenHarmony IDL Specifications and User Guide](../IDL/idl-guidelines.md).
+ Use OpenHarmony Interface Definition Language (IDL) to automatically generate the corresponding client, server, and **IRemoteObject** code. For details, see [Development Using TS](../IDL/idl-guidelines.md#development-using-ts).
2. Writing code in the corresponding file
- When calling **connectAbility()**, you should pass a **Want** object containing information about the target Service ability and an **IAbilityConnection** object to the API. **IAbilityConnection** provides the following callbacks that you should implement: **onConnect()**, **onDisconnect()**, and **onFailed()**. The **onConnect()** callback is invoked when a Service ability is connected, **onDisconnect()** is invoked when a Service ability is unexpectedly disconnected, and **onFailed()** is invoked when a connection to a Service ability fails.
+ When using **connectAbility()**, pass the **Want** and **ConnectOptions** objects of the target Service ability, where **ConnectOptions** encapsulates the following three callbacks that need to be implemented.
+ - **onConnect()**: callback used for processing when the Service ability is connected.
+ - **onDisconnect()**: callback used for processing when the Service ability is disconnected.
+ - **onFailed()**: callback used for processing when the connection to the Service ability fails.
The following code snippet shows how to implement the callbacks:
- ```javascript
+ ```ts
import prompt from '@system.prompt'
var option = {
onConnect: function onConnectCallback(element, proxy) {
- console.log(`onConnectLocalService onConnectDone`)
+ console.log(`onConnectLocalService onConnectDone`);
if (proxy === null) {
prompt.showToast({
message: "Connect service failed"
- })
- return
+ });
+ return;
}
- let data = rpc.MessageParcel.create()
- let reply = rpc.MessageParcel.create()
- let option = new rpc.MessageOption()
- data.writeInterfaceToken("connect.test.token")
- proxy.sendRequest(0, data, reply, option)
+ // After obtaining the proxy of the Service ability, the calling ability can communicate with the Service ability.
+ let data = rpc.MessageParcel.create();
+ let reply = rpc.MessageParcel.create();
+ let option = new rpc.MessageOption();
+ data.writeString("InuptString");
+ proxy.sendRequest(0, data, reply, option);
prompt.showToast({
message: "Connect service success"
- })
+ });
},
onDisconnect: function onDisconnectCallback(element) {
- console.log(`onConnectLocalService onDisconnectDone element:${element}`)
+ console.log(`onConnectLocalService onDisconnectDone element:${element}`);
prompt.showToast({
message: "Disconnect service success"
- })
+ });
},
onFailed: function onFailedCallback(code) {
- console.log(`onConnectLocalService onFailed errCode:${code}`)
+ console.log(`onConnectLocalService onFailed errCode:${code}`);
prompt.showToast({
message: "Connect local service onFailed"
- })
+ });
}
- }
+ };
```
The following code snippet shows how to connect to a local Service ability:
- ```javascript
- import featureAbility from '@ohos.ability.featureAbility';
- let connId = featureAbility.connectAbility(
- {
- bundleName: "com.jstest.service",
- abilityName: "com.jstest.service.ServiceAbility",
- },
- {
- onConnect: onConnectCallback,
- onDisconnect: onDisconnectCallback,
- onFailed: onFailedCallback,
- },
- );
+ ```ts
+ import featureAbility from '@ohos.ability.featureAbility'
+
+ let want = {
+ bundleName: "com.jstest.service",
+ abilityName: "com.jstest.service.ServiceAbility"
+ };
+ let connectId = featureAbility.connectAbility(want, option);
```
- When a Service ability is connected, the **onConnect()** callback is invoked and returns an **IRemoteObject** defining the proxy used for communicating with the Service ability. OpenHarmony provides a default implementation of **IRemoteObject**. You can extend **rpc.RemoteObject** to implement your own class of **IRemoteObject**.
+ When a Service ability is connected, the **onConnect()** callback is invoked and returns an **IRemoteObject** defining the proxy used for communicating with the Service ability. OpenHarmony provides the default implementation of **IRemoteObject**. You can inherit **rpc.RemoteObject** to create a custom implementation class for interaction with the Service ability. For details, see the [RPC API Reference](..\reference\apis\js-apis-rpc.md).
- The following code snippet shows how the Service ability instance returns itself to the calling ability:
+ The following code snippet shows how the Service ability returns itself to the calling ability:
- ```javascript
- import rpc from "@ohos.rpc";
+ ```ts
+ import rpc from "@ohos.rpc"
- class FirstServiceAbilityStub extends rpc.RemoteObject {
- constructor(des: any) {
- if (typeof des === 'string') {
- super(des)
- } else {
- return
+ class ServiceAbilityStub extends rpc.RemoteObject {
+ constructor(des: any) {
+ if (typeof des === 'string') {
+ super(des);
+ } else {
+ console.log("Error, the input param is not string");
+ return;
+ }
+ }
+
+ onRemoteRequest(code: number, data: any, reply: any, option: any) {
+ console.log("onRemoteRequest called");
+ // Execute the service logic.
+ if (code === 1) {
+ // Sort the input strings.
+ let string = data.readString();
+ console.log(`Input string = ${string}`);
+ let result = Array.from(string).sort().join('');
+ console.log(`Output result = ${result}`);
+ reply.writeString(result);
+ } else {
+ console.log(`Unknown request code`);
+ }
+ return true;
}
}
- onRemoteRequest(code: number, data: any, reply: any, option: any) {
- console.log(printLog + ` onRemoteRequest called`)
- if (code === 1) {
- let string = data.readString()
- console.log(printLog + ` string=${string}`)
- let result = Array.from(string).sort().join('')
- console.log(printLog + ` result=${result}`)
- reply.writeString(result)
- } else {
- console.log(printLog + ` unknown request code`)
+ export default {
+ onStart() {
+ console.log('ServiceAbility onStart');
+ },
+ onCommand(want, startId) {
+ console.log('ServiceAbility onCommand');
+ },
+ onConnect(want) {
+ console.log('ServiceAbility OnConnect');
+ return new ServiceAbilityStub('ServiceAbilityRemoteObject');
+ },
+ onDisconnect(want) {
+ console.log('ServiceAbility OnDisConnect');
+ },
+ onStop() {
+ console.log('ServiceAbility onStop');
}
- return true;
}
```
### Connecting to a Remote Service Ability
->**NOTE**
->
->This feature applies only to system applications, since the **getTrustedDeviceListSync** API of the **DeviceManager** class is open only to system applications.
-
-If you need to connect a Service ability to a Page ability or another Service ability on a remote device, you must first implement the **IAbilityConnection** interface for the connection. A Service ability allows abilities on another device to connect to it through **connectAbility()**.
-
-When calling **connectAbility()**, you should pass a **Want** object containing information about the target Service ability and an **IAbilityConnection** object to the API. **IAbilityConnection** provides the following callbacks that you should implement: **onConnect()**, **onDisconnect()**, and **onFailed()**. The **onConnect()** callback is invoked when a Service ability is connected, **onDisconnect()** is invoked when a Service ability is unexpectedly disconnected, and **onFailed()** is invoked when a connection to a Service ability fails.
+This feature applies only to system applications. The method of creating a **ConnectOptions** object for connecting to a remote Service ability is similar to that for connecting to a local Service ability. The differences are as follows:
+ - The application must apply for the data synchronization permission from the user.
+ - **Want** of the target Service ability must contain the remote device ID.
-The following code snippet shows how to implement the callbacks:
-
-```ts
-import prompt from '@system.prompt'
-
-var option = {
- onConnect: function onConnectCallback(element, proxy) {
- console.log(`onConnectRemoteService onConnectDone`)
- if (proxy === null) {
- prompt.showToast({
- message: "Connect service failed"
- })
- return
- }
- let data = rpc.MessageParcel.create()
- let reply = rpc.MessageParcel.create()
- let option = new rpc.MessageOption()
- data.writeInterfaceToken("connect.test.token")
- proxy.sendRequest(0, data, reply, option)
- prompt.showToast({
- message: "Connect service success"
- })
- },
- onDisconnect: function onDisconnectCallback(element) {
- console.log(`onConnectRemoteService onDisconnectDone element:${element}`)
- prompt.showToast({
- message: "Disconnect service success"
- })
- },
- onFailed: function onFailedCallback(code) {
- console.log(`onConnectRemoteService onFailed errCode:${code}`)
- prompt.showToast({
- message: "Connect local service onFailed"
- })
- }
+> **NOTE**
+>
+> The **getTrustedDeviceList** API of **DeviceManager** is open only to system applications. Currently, only system applications can connect to a remote Service ability.
+>
+> For details about the API definition, see [Device Management](..\reference\apis\js-apis-device-manager.md).
+
+The data synchronization permission is required in the cross-device scenario. Configure the permission in the **config.json** file.
+
+```json
+{
+ ...
+ "module": {
+ ...
+ "reqPermissions": [{
+ "name": "ohos.permission.DISTRIBUTED_DATASYNC"
+ }]
+ }
}
```
-The **Want** of the target Service ability must contain the remote **deviceId**, which can be obtained from **DeviceManager**. The sample code is as follows:
+The **DISTRIBUTED_DATASYNC** permission is user granted. Therefore, your application, when being started, must display a dialog box to request the permission. The sample code is as follows:
```ts
-import deviceManager from '@ohos.distributedHardware.deviceManager';
+import abilityAccessCtrl from "@ohos.abilityAccessCtrl"
+import bundle from '@ohos.bundle'
-// For details about the implementation of dmClass, see the implementation in Distributed Demo in Samples.
-let dmClass;
-
-function getRemoteDeviceId() {
- if (typeof dmClass === 'object' && dmClass != null) {
- let list = dmClass.getTrustedDeviceListSync();
- if (typeof (list) == 'undefined' || typeof (list.length) == 'undefined') {
- console.log("MainAbility onButtonClick getRemoteDeviceId err: list is null");
- return;
+async function RequestPermission() {
+ console.info('RequestPermission begin');
+ let array: Array = ["ohos.permission.DISTRIBUTED_DATASYNC"];
+ let bundleFlag = 0;
+ let tokenID = undefined;
+ let userID = 100;
+ let appInfo = await bundle.getApplicationInfo('ohos.samples.etsDemo', bundleFlag, userID);
+ tokenID = appInfo.accessTokenId;
+ let atManager = abilityAccessCtrl.createAtManager();
+ let requestPermissions: Array = [];
+ for (let i = 0;i < array.length; i++) {
+ let result = await atManager.verifyAccessToken(tokenID, array[i]);
+ console.info("verifyAccessToken result:" + JSON.stringify(result));
+ if (result != abilityAccessCtrl.GrantStatus.PERMISSION_GRANTED) {
+ requestPermissions.push(array[i]);
}
- console.log("MainAbility onButtonClick getRemoteDeviceId success:" + list[0].deviceId);
- return list[0].deviceId;
- } else {
- console.log("MainAbility onButtonClick getRemoteDeviceId err: dmClass is null");
}
-}
-```
-
-The following code snippet shows how to connect to a remote Service ability:
-
-```ts
-import featureAbility from '@ohos.ability.featureAbility';
-let connId = featureAbility.connectAbility(
- {
- deviceId: getRemoteDeviceId(),
- bundleName: "ohos.samples.etsDemo",
- abilityName: "ohos.samples.etsDemo.ServiceAbility",
- },
- {
- onConnect: onConnectCallback,
- onDisconnect: onDisconnectCallback,
- onFailed: onFailedCallback,
- },
-);
-```
-In the cross-device scenario, the application must also apply for the data synchronization permission from end users. The sample code is as follows:
-
-```ts
-import abilityAccessCtrl from "@ohos.abilityAccessCtrl";
-import bundle from '@ohos.bundle';
-async function RequestPermission() {
- console.info('RequestPermission begin');
- let array: Array = ["ohos.permission.DISTRIBUTED_DATASYNC"];
- let bundleFlag = 0;
- let tokenID = undefined;
- let userID = 100;
- let appInfo = await bundle.getApplicationInfo('ohos.samples.etsDemo', bundleFlag, userID);
- tokenID = appInfo.accessTokenId;
- let atManager = abilityAccessCtrl.createAtManager();
- let requestPermissions: Array = [];
- for (let i = 0;i < array.length; i++) {
- let result = await atManager.verifyAccessToken(tokenID, array[i]);
- console.info("verifyAccessToken result:" + JSON.stringify(result));
- if (result == abilityAccessCtrl.GrantStatus.PERMISSION_GRANTED) {
- } else {
- requestPermissions.push(array[i]);
+ console.info("requestPermissions:" + JSON.stringify(requestPermissions));
+ if (requestPermissions.length == 0 || requestPermissions == []) {
+ return;
}
- }
- console.info("requestPermissions:" + JSON.stringify(requestPermissions));
- if (requestPermissions.length == 0 || requestPermissions == []) {
- return;
- }
- let context = featureAbility.getContext();
- context.requestPermissionsFromUser(requestPermissions, 1, (data)=>{
- console.info("data:" + JSON.stringify(data));
- });
- console.info('RequestPermission end');
+ let context = featureAbility.getContext();
+ context.requestPermissionsFromUser(requestPermissions, 1, (data)=>{
+ console.info("data:" + JSON.stringify(data));
+ });
+ console.info('RequestPermission end');
}
```
-When a Service ability is connected, the **onConnect()** callback is invoked and returns an **IRemoteObject** defining the proxy used for communicating with the Service ability. OpenHarmony provides a default implementation of **IRemoteObject**. You can extend **rpc.RemoteObject** to implement your own class of **IRemoteObject**.
+To obtain the device ID, import the **@ohos.distributedHardware.deviceManager** module, which provides **getTrustedDeviceList** to obtain the remote device ID. For details about how to use the API, see [Device Management](..\reference\apis\js-apis-device-manager.md).
-The following code snippet shows how the Service ability instance returns itself to the calling ability:
+To connect to a remote Service ability, you only need to define **deviceId** in **Want**. The sample code is as follows:
```ts
-import rpc from "@ohos.rpc";
-
-class FirstServiceAbilityStub extends rpc.RemoteObject {
- constructor(des: any) {
- if (typeof des === 'string') {
- super(des)
- } else {
- return
- }
- }
-
- onRemoteRequest(code: number, data: any, reply: any, option: any) {
- console.log(printLog + ` onRemoteRequest called`)
- if (code === 1) {
- let string = data.readString()
- console.log(printLog + ` string=${string}`)
- let result = Array.from(string).sort().join('')
- console.log(printLog + ` result=${result}`)
- reply.writeString(result)
- } else {
- console.log(printLog + ` unknown request code`)
- }
- return true;
- }
-}
+import featureAbility from '@ohos.ability.featureAbility'
-export default {
- onStart() {
- console.info('ServiceAbility onStart');
- },
- onStop() {
- console.info('ServiceAbility onStop');
- },
- onConnect(want) {
- console.log("ServiceAbility onConnect");
- try {
- let value = JSON.stringify(want);
- console.log("ServiceAbility want:" + value);
- } catch(error) {
- console.log("ServiceAbility error:" + error);
- }
- return new FirstServiceAbilityStub("first ts service stub");
- },
- onDisconnect(want) {
- console.log("ServiceAbility onDisconnect");
- let value = JSON.stringify(want);
- console.log("ServiceAbility want:" + value);
- },
- onCommand(want, startId) {
- console.info('ServiceAbility onCommand');
- let value = JSON.stringify(want);
- console.log("ServiceAbility want:" + value);
- console.log("ServiceAbility startId:" + startId);
- }
+let want = {
+ deviceId: remoteDeviceId,
+ bundleName: "com.jstest.service",
+ abilityName: "com.jstest.service.ServiceAbility"
};
+let connectId = featureAbility.connectAbility(want, option);
```
+
+The other implementations are the same as those for the connection to a local Service ability. For details, see the sample code provided under [Connecting to a Local Service Ability](#connecting-to-a-local-service-ability).
diff --git a/en/application-dev/ability/figures/favsstage.png b/en/application-dev/ability/figures/favsstage.png
index 13b1766da57d89f206068dbb03741ba1f0ae96ff..4e5980fc1df4634d4ea1ff23158e79d62637f8ba 100644
Binary files a/en/application-dev/ability/figures/favsstage.png and b/en/application-dev/ability/figures/favsstage.png differ
diff --git a/en/application-dev/ability/stage-ability.md b/en/application-dev/ability/stage-ability.md
index 3457aa29249a7c569053a09b6374cf03ce0d8868..d09585b25531556cfbee2ab5cbd45c72191aa8a4 100644
--- a/en/application-dev/ability/stage-ability.md
+++ b/en/application-dev/ability/stage-ability.md
@@ -1,6 +1,6 @@
# Ability Development
## When to Use
-Ability development in the [stage model](stage-brief.md) is significantly different from that in the FA model. The stage model requires you to declare the application package structure in the `module.json5` and `app.json5` files during application development. For details about the configuration file, see [Application Package Structure Configuration File](../quick-start/stage-structure.md). To develop an ability based on the stage model, implement the following logic:
+Ability development in the [stage model](stage-brief.md) is significantly different from that in the FA model. The stage model requires you to declare the application package structure in the **module.json5** and **app.json5** files during application development. For details about the configuration file, see [Application Package Structure Configuration File](../quick-start/stage-structure.md). To develop an ability based on the stage model, implement the following logic:
- Create an ability that supports screen viewing and human-machine interaction. You must implement the following scenarios: ability lifecycle callbacks, obtaining ability configuration, requesting permissions, and notifying environment changes.
- Start an ability. You need to implement ability startup on the same device, on a remote device, or with a specified UI page.
- Call abilities. For details, see [Call Development](stage-call.md).
@@ -8,15 +8,15 @@ Ability development in the [stage model](stage-brief.md) is significantly differ
- Continue the ability on another device. For details, see [Ability Continuation Development](stage-ability-continuation.md).
### Launch Type
-An ability can be launched in the **standard**, **singleton**, or **specified** mode, as configured by `launchType` in the `module.json5` file. Depending on the launch type, the action performed when the ability is started differs, as described below.
+An ability can be launched in the **standard**, **singleton**, or **specified** mode, as configured by **launchType** in the **module.json5** file. Depending on the launch type, the action performed when the ability is started differs, as described below.
| Launch Type | Description |Action |
| ----------- | ------- |---------------- |
-| standard | Standard mode. | A new instance is started each time an ability starts.|
-| singleton | Singleton mode. | The ability has only one instance in the system. If an instance already exists when an ability is started, that instance is reused.|
+| standard | Standard mode | A new instance is started each time an ability starts.|
+| singleton | Singleton mode | The ability has only one instance in the system. If an instance already exists when an ability is started, that instance is reused.|
| specified | Instance-specific| The internal service of an ability determines whether to create multiple instances during running.|
-By default, the singleton mode is used. The following is an example of the `module.json5` file:
+By default, the singleton mode is used. The following is an example of the **module.json5** file:
```json
{
"module": {
@@ -30,7 +30,7 @@ By default, the singleton mode is used. The following is an example of the `modu
```
## Creating an Ability
### Available APIs
-The table below describes the APIs provided by the `AbilityStage` class, which has the `context` attribute. For details about the APIs, see [AbilityStage](../reference/apis/js-apis-application-abilitystage.md).
+The table below describes the APIs provided by the **AbilityStage** class, which has the **context** attribute. For details about the APIs, see [AbilityStage](../reference/apis/js-apis-application-abilitystage.md).
**Table 1** AbilityStage APIs
|API|Description|
@@ -39,7 +39,7 @@ The table below describes the APIs provided by the `AbilityStage` class, which h
|onAcceptWant(want: Want): string|Called when a specified ability is started.|
|onConfigurationUpdated(config: Configuration): void|Called when the global configuration is updated.|
-The table below describes the APIs provided by the `Ability` class. For details about the APIs, see [Ability](../reference/apis/js-apis-application-ability.md).
+The table below describes the APIs provided by the **Ability** class. For details about the APIs, see [Ability](../reference/apis/js-apis-application-ability.md).
**Table 2** Ability APIs
@@ -47,19 +47,19 @@ The table below describes the APIs provided by the `Ability` class. For details
|:------|:------|
|onCreate(want: Want, param: AbilityConstant.LaunchParam): void|Called when an ability is created.|
|onDestroy(): void|Called when the ability is destroyed.|
-|onWindowStageCreate(windowStage: window.WindowStage): void|Called when a `WindowStage` is created for the ability. You can use the `window.WindowStage` APIs to implement operations such as page loading.|
-|onWindowStageDestroy(): void|Called when the `WindowStage` is destroyed for the ability.|
+|onWindowStageCreate(windowStage: window.WindowStage): void|Called when a **WindowStage** is created for the ability. You can use the **window.WindowStage** APIs to implement operations such as page loading.|
+|onWindowStageDestroy(): void|Called when the **WindowStage** is destroyed for the ability.|
|onForeground(): void|Called when the ability is switched to the foreground.|
|onBackground(): void|Called when the ability is switched to the background.|
-|onNewWant(want: Want, launchParams: AbilityConstant.LaunchParam): void|Called when the ability launch type is set to `singleton`.|
+|onNewWant(want: Want, launchParams: AbilityConstant.LaunchParam): void|Called when the ability launch type is set to **singleton**.|
|onConfigurationUpdated(config: Configuration): void|Called when the configuration of the environment where the ability is running is updated.|
### Implementing AbilityStage and Ability Lifecycle Callbacks
-To create Page abilities for an application in the stage model, you must implement the `AbilityStage` class and ability lifecycle callbacks, and use the `Window` APIs to set the pages. The sample code is as follows:
-1. Import the `AbilityStage` module.
+To create Page abilities for an application in the stage model, you must implement the **AbilityStage** class and ability lifecycle callbacks, and use the **Window** class to set the pages. The sample code is as follows:
+1. Import the **AbilityStage** module.
```
import AbilityStage from "@ohos.application.AbilityStage"
```
-2. Implement the `AbilityStage` class. The default relative path generated by the APIs is **entry\src\main\ets\Application\AbilityStage.ts**.
+2. Implement the **AbilityStage** class. The default relative path generated by the APIs is **entry\src\main\ets\Application\AbilityStage.ts**.
```ts
export default class MyAbilityStage extends AbilityStage {
onCreate() {
@@ -67,13 +67,13 @@ To create Page abilities for an application in the stage model, you must impleme
}
}
```
-3. Import the `Ability` module.
+3. Import the **Ability** module.
```js
import Ability from '@ohos.application.Ability'
```
-4. Implement the lifecycle callbacks of the `Ability` class. The default relative path generated by the APIs is **entry\src\main\ets\MainAbility\MainAbility.ts**.
+4. Implement the lifecycle callbacks of the **Ability** class. The default relative path generated by the APIs is **entry\src\main\ets\MainAbility\MainAbility.ts**.
- In the `onWindowStageCreate(windowStage)` API, use `loadContent` to set the application page to be loaded. For details about how to use the `Window` APIs, see [Window Development](../windowmanager/application-window-stage.md).
+ In the **onWindowStageCreate(windowStage)** API, use **loadContent** to set the application page to be loaded. For details about how to use the **Window** APIs, see [Window Development](../windowmanager/application-window-stage.md).
```ts
export default class MainAbility extends Ability {
onCreate(want, launchParam) {
@@ -108,9 +108,9 @@ To create Page abilities for an application in the stage model, you must impleme
}
```
### Obtaining AbilityStage and Ability Configurations
-Both the `AbilityStage` and `Ability` classes have the `context` attribute. An application can obtain the context of an `Ability` instance through `this.context` to obtain the configuration details.
+Both the **AbilityStage** and **Ability** classes have the **context** attribute. An application can obtain the context of an **Ability** instance through **this.context** to obtain the configuration details.
-The following example shows how an application obtains the bundle code directory, HAP file name, ability name, and system language through the `context` attribute in the `AbilityStage` class. The sample code is as follows:
+The following example shows how an application obtains the bundle code directory, HAP file name, ability name, and system language through the **context** attribute in the **AbilityStage** class. The sample code is as follows:
```ts
import AbilityStage from "@ohos.application.AbilityStage"
@@ -130,7 +130,7 @@ export default class MyAbilityStage extends AbilityStage {
}
```
-The following example shows how an application obtains the bundle code directory, HAP file name, ability name, and system language through the `context` attribute in the `Ability` class. The sample code is as follows:
+The following example shows how an application obtains the bundle code directory, HAP file name, ability name, and system language through the **context** attribute in the **Ability** class. The sample code is as follows:
```ts
import Ability from '@ohos.application.Ability'
export default class MainAbility extends Ability {
@@ -149,9 +149,9 @@ export default class MainAbility extends Ability {
}
```
### Requesting Permissions
-If an application needs to obtain user privacy information or use system capabilities, for example, obtaining location information or using the camera to take photos or record videos, it must request the respective permission from consumers. During application development, you need to specify the involved sensitive permissions, declare the required permissions in `module.json5`, and use the `requestPermissionsFromUser` API to request the permission from consumers in the form of a dialog box. The following uses the permission for calendar access as an example.
+If an application needs to obtain user privacy information or use system capabilities, for example, obtaining location information or using the camera to take photos or record videos, it must request the respective permission from consumers. During application development, you need to specify the involved sensitive permissions, declare the required permissions in **module.json5**, and use the **requestPermissionsFromUser** API to request the permission from consumers in the form of a dialog box. The following uses the permission for calendar access as an example.
-Declare the required permission in the `module.json5` file.
+Declare the required permission in the **module.json5** file.
```json
"requestPermissions": [
{
@@ -170,13 +170,13 @@ context.requestPermissionsFromUser(permissions).then((data) => {
})
```
### Notifying of Environment Changes
-Environment changes include changes of global configurations and ability configurations. Currently, the global configurations include the system language and color mode. The change of global configurations is generally triggered by configuration items in **Settings** or icons in **Control Panel**. The ability configuration is specific to a single `Ability` instance, including the display ID, screen resolution, and screen orientation. The configuration is related to the display where the ability is located, and the change is generally triggered by the window. For details on the configuration, see [Configuration](../reference/apis/js-apis-configuration.md).
+Environment changes include changes of global configurations and ability configurations. Currently, the global configurations include the system language and color mode. The change of global configurations is generally triggered by configuration items in **Settings** or icons in **Control Panel**. The ability configuration is specific to a single **Ability** instance, including the display ID, screen resolution, and screen orientation. The configuration is related to the display where the ability is located, and the change is generally triggered by the window. For details on the configuration, see [Configuration](../reference/apis/js-apis-configuration.md).
-For an application in the stage model, when the configuration changes, its abilities are not restarted, but the `onConfigurationUpdated(config: Configuration)` callback is triggered. If the application needs to perform processing based on the change, you can overwrite `onConfigurationUpdated`. Note that the `Configuration` object in the callback contains all the configurations of the current ability, not only the changed configurations.
+For an application in the stage model, when the configuration changes, its abilities are not restarted, but the **onConfigurationUpdated(config: Configuration)** callback is triggered. If the application needs to perform processing based on the change, you can overwrite **onConfigurationUpdated**. Note that the **Configuration** object in the callback contains all the configurations of the current ability, not only the changed configurations.
-The following example shows the implementation of the `onConfigurationUpdated` callback in the `AbilityStage` class. The callback is triggered when the system language and color mode are changed.
+The following example shows the implementation of the **onConfigurationUpdated** callback in the **AbilityStage** class. The callback is triggered when the system language and color mode are changed.
```ts
-import Ability from '@ohos.application.Ability'
+import AbilityStage from '@ohos.application.AbilityStage'
import ConfigurationConstant from '@ohos.application.ConfigurationConstant'
export default class MyAbilityStage extends AbilityStage {
@@ -188,7 +188,7 @@ export default class MyAbilityStage extends AbilityStage {
}
```
-The following example shows the implementation of the `onConfigurationUpdated` callback in the `Ability` class. The callback is triggered when the system language, color mode, or display parameters (such as the direction and density) change.
+The following example shows the implementation of the **onConfigurationUpdated** callback in the **Ability** class. The callback is triggered when the system language, color mode, or display parameters (such as the direction and density) change.
```ts
import Ability from '@ohos.application.Ability'
import ConfigurationConstant from '@ohos.application.ConfigurationConstant'
@@ -209,7 +209,7 @@ export default class MainAbility extends Ability {
```
## Starting an Ability
### Available APIs
-The `Ability` class has the `context` attribute, which belongs to the `AbilityContext` class. The `AbilityContext` class has the `abilityInfo`, `currentHapModuleInfo`, and other attributes as well as the APIs used for starting abilities. For details, see [AbilityContext](../reference/apis/js-apis-ability-context.md).
+The **Ability** class has the **context** attribute, which belongs to the **AbilityContext** class. The **AbilityContext** class has the **abilityInfo**, **currentHapModuleInfo**, and other attributes as well as the APIs used for starting abilities. For details, see [AbilityContext](../reference/apis/js-apis-ability-context.md).
**Table 3** AbilityContext APIs
|API|Description|
@@ -223,7 +223,7 @@ The `Ability` class has the `context` attribute, which belongs to the `AbilityCo
|startAbilityForResultWithAccount(want: Want, accountId: number, callback: AsyncCallback\): void|Starts an ability with the execution result and account ID.|
|startAbilityForResultWithAccount(want: Want, accountId: number, options?: StartOptions): Promise\|Starts an ability with the execution result and account ID.|
### Starting an Ability on the Same Device
-An application can obtain the context of an `Ability` instance through `this.context` and then use the `startAbility` API in the `AbilityContext` class to start the ability. The ability can be started by specifying `Want`, `StartOptions`, and `accountId`, and the operation result can be returned using a callback or `Promise` instance. The sample code is as follows:
+An application can obtain the context of an **Ability** instance through **this.context** and then use the **startAbility** API in the **AbilityContext** class to start the ability. The ability can be started by specifying **Want**, **StartOptions**, and **accountId**, and the operation result can be returned using a callback or **Promise** instance. The sample code is as follows:
```ts
let context = this.context
var want = {
@@ -239,7 +239,7 @@ context.startAbility(want).then(() => {
```
### Starting an Ability on a Remote Device
->This feature applies only to system applications, since the `getTrustedDeviceListSync` API of the `DeviceManager` class is open only to system applications.
+>This feature applies only to system applications, since the **getTrustedDeviceListSync** API of the **DeviceManager** class is open only to system applications.
In the cross-device scenario, you must specify the ID of the remote device. The sample code is as follows:
```ts
let context = this.context
@@ -254,7 +254,7 @@ context.startAbility(want).then(() => {
console.error("Failed to start remote ability with error: " + JSON.stringify(error))
})
```
-Obtain the ID of a specified device from `DeviceManager`. The sample code is as follows:
+Obtain the ID of a specified device from **DeviceManager**. The sample code is as follows:
```ts
import deviceManager from '@ohos.distributedHardware.deviceManager';
function getRemoteDeviceId() {
@@ -271,11 +271,11 @@ function getRemoteDeviceId() {
}
}
```
-Request the permission `ohos.permission.DISTRIBUTED_DATASYNC` from consumers. This permission is used for data synchronization. For details about the sample code for requesting the permission, see [Requesting Permissions](##requesting-permissions).
+Request the permission **ohos.permission.DISTRIBUTED_DATASYNC** from consumers. This permission is used for data synchronization. For details about the sample code for requesting the permission, see [Requesting Permissions](#requesting-permissions).
### Starting an Ability with the Specified Page
-If the launch type of an ability is set to `singleton` and the ability has been started, the `onNewWant` callback is triggered when the ability is started again. You can pass start options through the `want`. For example, to start an ability with the specified page, use the `uri` or `parameters` parameter in the `want` to pass the page information. Currently, the ability in the stage model cannot directly use the `router` capability. You must pass the start options to the custom component and invoke the `router` method to display the specified page during the custom component lifecycle management. The sample code is as follows:
+If the launch type of an ability is set to **singleton** and the ability has been started, the **onNewWant** callback is triggered when the ability is started again. You can pass start options through the **want**. For example, to start an ability with the specified page, use the **uri** or **parameters** parameter in the **want** to pass the page information. Currently, the ability in the stage model cannot directly use the **router** capability. You must pass the start options to the custom component and invoke the **router** method to display the specified page during the custom component lifecycle management. The sample code is as follows:
-When using `startAbility` to start an ability again, use the `uri` parameter in the `want` to pass the page information.
+When using **startAbility** to start an ability again, use the **uri** parameter in the **want** to pass the page information.
```ts
async function reStartAbility() {
try {
@@ -291,7 +291,7 @@ async function reStartAbility() {
}
```
-Obtain the `want` parameter that contains the page information from the `onNewWant` callback of the ability.
+Obtain the **want** parameter that contains the page information from the **onNewWant** callback of the ability.
```ts
import Ability from '@ohos.application.Ability'
@@ -302,7 +302,7 @@ export default class MainAbility extends Ability {
}
```
-Obtain the `want` parameter that contains the page information from the custom component and process the route based on the URI.
+Obtain the **want** parameter that contains the page information from the custom component and process the route based on the URI.
```ts
import router from '@ohos.router'
@@ -315,7 +315,7 @@ struct Index {
console.info('Index onPageShow')
let newWant = globalThis.newWant
if (newWant.hasOwnProperty("uri")) {
- router.push({ uri: newWant.uri });
+ router.push({ url: newWant.uri });
globalThis.newWant = undefined
}
}
diff --git a/en/application-dev/ability/stage-brief.md b/en/application-dev/ability/stage-brief.md
index 427495774aa06066f6fd38c972ef59eafb102cf3..2cf186f82db342e02523ee4645521ea72fbd1f6f 100644
--- a/en/application-dev/ability/stage-brief.md
+++ b/en/application-dev/ability/stage-brief.md
@@ -2,7 +2,7 @@
## Design Ideas
-The stage model is designed to make it easier to develop complex applications in the distributed environment.
+The stage model is designed to provide a better application development mode in the distributed environment.
The following figure shows the design ideas of the stage model.
@@ -10,18 +10,17 @@ The following figure shows the design ideas of the stage model.
The stage model is designed based on the following considerations:
-- **Balance between application capabilities and overall system power consumption**
+- Efficient management of application processes
- On a running device, resources are preferentially guaranteed for foreground applications, on the prerequisites that the overall power consumption requirements of the system are met. The stage model balances the application capabilities and overall system power consumption through ability and UI separation, strict background control, scenario-based service mechanism, and single-process model.
+ As the device memory becomes larger, the number of processes concurrently running in the system increases. If the number of concurrent processes reaches several hundreds, the overall power consumption and performance of the system will be adversely affected without effective management measures. To restrict the behavior of background processes, the stage model uses four measures: transient task, continuous task, agent task, and Work Scheduler task. With these measures, foreground processes will obtain guaranteed resources, thereby delivering a better user experience.
-- **Native support for component continuation and collaboration**
+- Native support for cross-device migration and multi-device collaboration
- OpenHarmony natively supports distributed deployment. Therefore, its application framework must be designed for easier component migration and collaboration. The stage model achieves this design objective by providing features such as separation between ability and UI as well as integration of UI display and service capabilities.
+ OpenHarmony is a native distributed OS. Its application framework must be designed for easier component migration and collaboration across devices. The stage model achieves this design objective by providing features such as separation between ability and UI as well as integration of UI display and service capabilities.
-- **Support for multiple device types and window forms**
-
- To support multiple device types and facilitate the implementation of different window forms, the component manager and window manager must be decoupled at the architecture layer for easier tailoring. To achieve this goal, the stage model redefines the ability lifecycle and implements unidirectional dependency for the component manager and window manager.
+- Different window forms for various device types
+ The stage model redefines the ability lifecycle. In terms of architecture, the component manager and window manager are decoupled. This facilitates adaptation between window forms and device types.
## Basic Concepts
@@ -29,40 +28,42 @@ The following figure shows the basic concepts in the stage model.
-- **HAP**: Harmony Ability Package, also called module, which is the basic unit for building, distributing, and loading OpenHarmony applications. Each HAP has a unique name, which is called **moduleName**, in an application.
+- **HAP**: basic unit for building, distributing, and loading OpenHarmony applications. Each HAP corresponds to a module in the development state. In an application, **moduleName** uniquely identifies a module.
- **Bundle**: an OpenHarmony application identified by **appid**. A bundle can contain multiple HAP files. Each application has a **bundleName**. However, **bundleName** must be used together with **appid** and other information to uniquely identify an application.
-- **AbilityStage**: runtime class of an HAP. It is created when the HAP is loaded to the process for the first time and is visible to developers in the runtime.
-- **Application**: runtime class of a bundle, which is invisible to developers in the runtime.
-- **Context**: base class that the context classes of **Ability** and **ExtensionAbility** classes inherit. This class provides various capabilities that can be invoked by developers in the runtime, and various information such as the bundle name, module name, and path.
-- **Ability**: class that provides lifecycle callbacks, holds the **AbilityContext** class, and supports component continuation and collaboration.
-- **ExtensionAbility**: general name of scenario-based service extension abilities. The system defines multiple scenario-based **ExtensionAbility** classes, each of which has its own **ExtensionContext**.
+- **AbilityStage**: runtime object of an HAP. It is created when the HAP is loaded to the process for the first time and is visible to developers in the runtime.
+- **Application**: runtime object of a bundle. It is invisible to developers in the runtime.
+- **Context**: base class that provides APIs in the runtime to obtain information such as the bundle name, module name, and path. The **Context** classes of the Ability and ExtensionAbility components inherit from this class.
+- **Ability**: provides lifecycle callbacks, holds the ability context, and supports cross-device component migration and multi-device collaboration.
+- **ExtensionAbility**: general name of scenario-based Extension abilities. The system defines multiple scenario-based **ExtensionAbility** classes, each of which has its own **ExtensionContext**.
- **WindowStage**: local window manager.
-- **Window**: basic unit managed by the window manager. It has an ArkUI engine instance.
-- **ArkUI Page**: ArkUI development framework page.
+- **Window**: application window, which holds an ArkUI engine instance.
+- **ArkUI Page**: UI developed based on ArkUI.
## Lifecycle
-The ability and ability stage lifecycles are the rudiments of the basic process of an application. For details about how these lifecycles differ from those in the FA model, see [Ability Framework Overview](ability-brief.md). This section focuses on the ability lifecycle transition and the scheduling relationships between the ability, ability stage, and window stage.
+The ability and ability stage are key objects in the application lifecycle.
+
+For details about the lifecycle differences between the stage model and FA model, see [Ability Framework Overview](ability-brief.md). This section focuses on the ability lifecycle transition and the scheduling relationships between the ability, ability stage, and window stage.
-To implement device-specific tailoring and multi-window scalability, OpenHarmony decouples the component manager from the window manager. The ability lifecycle defined in the stage model includes only the creation, destruction, foreground, and background states. The gain focus and lose focus states that are closely related to UI content are defined in the window stage. This implements weak coupling between the abilities and windows. On the service side, the window manager notifies the component manager of the foreground and background changes, so the component manager only senses the foreground and background changes but not the focus changes.
+To implement device adaptation and multi-window scalability, OpenHarmony decouples the component manager from the window manager.
-There are two lifecycle states related to **WindowStage** in **Ability**: **onWindowStageCreate** and **onWindowStageDestroy**. They are valid only for devices with the window display capability. **onWindowStageCreate** is invoked when a window stage is created, where you can call **loadContent** to set pages to be loaded for the ability. **onWindowStageDestroy** is invoked when the window stage is destroyed, where you can release resources.
+The ability lifecycle defined in the stage model includes only the creation, destruction, foreground, and background states. The gain focus and lose focus states that are closely related to UI are defined in the window stage. This implements weak coupling between the abilities and windows. On the service side, the window manager notifies the component manager of the foreground and background state changes, so the component manager only senses the foreground and background state changes but not the focus changes.
+
+There are two lifecycle states related to the window stage in **Ability**: **onWindowStageCreate** and **onWindowStageDestroy**. They are valid only for devices with the display capability. **onWindowStageCreate** is invoked when a window stage is created, where you can call **loadContent** to set pages to be loaded for the ability. **onWindowStageDestroy** is invoked when the window stage is destroyed, where you can release resources.
## Ability Instances and Missions
Abilities can be started in any of the following modes:
-+ **Singleton**: For each type of ability, only one instance exists in the application process. **Ability1** in the figure below is started in singleton mode.
-
-+ **Standard**: Each time **startAbility** is called, an instance of the specified ability type is created in the application process. **Ability2** in the figure below is started in standard mode.
+* **Singleton**: For each type of ability, only one instance exists in the application process. **Ability1** in the figure below is started in singleton mode.
+* **Standard**: Each time **startAbility** is called, an instance of the specified ability type is created in the application process. **Ability2** in the figure below is started in standard mode.
+* **Specified**: Before creating an **Ability** instance, you can create a key for the instance. Each time **startAbility** is called, the system asks the application which ability instance (corresponding to a key) will be used. **Ability3** in the figure below is started in specified mode.
-+ **Specified**: Before creating an **Ability** instance, you can create a key for the instance. Each time **startAbility** is called, the system asks the application which ability instance (corresponding to a key) will be used. **Ability3** in the figure below is started in specified mode.
-
-Each ability instance corresponds to a mission in **Launcher Recent**.
+Each **Ability** instance corresponds to a mission in **Recents**.
The mission corresponding to an ability instance has a snapshot of the ability instance. After the ability instance is destroyed, the ability class information and snapshot are retained in the mission until the user deletes the information or the storage space reaches the upper limit.
@@ -70,33 +71,37 @@ The mission corresponding to an ability instance has a snapshot of the ability i
## ExtensionAbility Mechanism
-Different from the ability used for page display, the extension ability provides a restricted service running environment. It has the following features:
+Different from the ability used for UI display, ExtensionAbility provides a restricted running environment.
+
+ExtensionAbility has the following features:
-- Its process runs independently from the main process and shares the same storage sandbox with the main process. There is no inter-process communication (IPC) between the process and the main process.
+- Its process runs independently from the main process but shares the same storage sandbox with the main process. There is no inter-process communication (IPC) between the ExtensionAbility process and the main process.
- It has an independent context that provides scenario-specific APIs.
- It is created by the system, rather than by applications.
-- The lifecycles of the extension ability and process are managed by the system.
+- The lifecycles of the ExtensionAbility component and process are managed by the system.
-The following figure uses the widget scenario as an example. You can inherit from the **FormExtensionAbility** base class to provide the widget details. The lifecycle of the **FormExtensionAbility** instance and that of the extension ability process where the instance is located are managed by **FormManagerService**, which is a system service.
+The following figure uses the widget an example. **FormExtensionAbility** is the base class. You can inherit from this class to provide widget information. The lifecycle of the **FormExtensionAbility** instance and that of the ExtensionAbility process where the instance is located are managed by a system service named **FormManagerService**.
## Process Model
-All OpenHarmony applications are designed to meet the single-process model. In the single-process model, all processes in the application are created and managed by the system. Each application supports a maximum of three types of processes:
+OpenHarmony forces strong control policies on application processes. No APIs are provided to configure multiple processes. All application processes are created and managed by the system.
+
+The processes of an application can be classified into three types:
-- Main process: runs all ability components, pages, and service logic.
+- Main process: runs the **UIAbility** component, UI, and service logic.
- Extension process: runs classes derived from **ExtensionAbility** in the application. The lifecycle of this process is managed by a scenario-specific system service.
- Render process: created for the WebView and used to load the WebView rendering library.
-The following figure shows the process model of an application.
+ The following figure shows the process model of an application.
-
+ 
## Application Package Structure
diff --git a/en/application-dev/ability/stage-call.md b/en/application-dev/ability/stage-call.md
index 390e1b6c3ce5393956d0a7801f362ab7f49578a4..5c29001e5c62f4059121247e9a044474111527c3 100644
--- a/en/application-dev/ability/stage-call.md
+++ b/en/application-dev/ability/stage-call.md
@@ -2,9 +2,9 @@
## When to Use
Ability call is an extension of the ability capability. It enables an ability to be invoked by and communicate with external systems. The ability invoked can be either started in the foreground or created and run in the background. You can use the ability call to implement data sharing between two abilities (caller ability and callee ability) through inter-process communication (IPC).
-The core API used for the ability call is `startAbilityByCall`, which differs from `startAbility` in the following ways:
- - `startAbilityByCall` supports ability startup in the foreground and background, whereas `startAbility` supports ability startup in the foreground only.
- - The caller ability can use the `Caller` object returned by `startAbilityByCall` to communicate with the callee ability, but `startAbility` does not provide the communication capability.
+The core API used for the ability call is **startAbilityByCall**, which differs from **startAbility** in the following ways:
+ - **startAbilityByCall** supports ability startup in the foreground and background, whereas **startAbility** supports ability startup in the foreground only.
+ - The caller ability can use the **Caller** object returned by **startAbilityByCall** to communicate with the callee ability, but **startAbility** does not provide the communication capability.
Ability call is usually used in the following scenarios:
- Communicating with the callee ability
@@ -15,17 +15,17 @@ Ability call is usually used in the following scenarios:
|:------|:------|
|Caller ability|Ability that triggers the ability call.|
|Callee ability|Ability invoked by the ability call.|
-|Caller |Object returned by `startAbilityByCall` and used by the caller ability to communicate with the callee ability.|
+|Caller |Object returned by **startAbilityByCall** and used by the caller ability to communicate with the callee ability.|
|Callee |Object held by the callee ability to communicate with the caller ability.|
|IPC |Inter-process communication.|
The ability call process is as follows:
- - The caller ability uses `startAbilityByCall` to obtain a `Caller` object and uses `call()` of the `Caller` object to send data to the callee ability.
- - The callee ability, which holds a `Callee` object, uses `on()` of the `Callee` object to register a callback. This callback is invoked when the callee ability receives data from the caller ability.
+ - The caller ability uses **startAbilityByCall** to obtain a **Caller** object and uses **call()** of the **Caller** object to send data to the callee ability.
+ - The callee ability, which holds a **Callee** object, uses **on()** of the **Callee** object to register a callback. This callback is invoked when the callee ability receives data from the caller ability.
> **NOTE**|Starts an ability in the foreground (through the `want` configuration) or background (default) and obtains the `Caller` object for communication with the ability. For details, see [AbilityContext](../reference/apis/js-apis-ability-context.md#abilitycontextstartabilitybycall) or [ServiceExtensionContext](../reference/apis/js-apis-service-extension-context.md#serviceextensioncontextstartabilitybycall).|
+|startAbilityByCall(want: Want): Promise\|Starts an ability in the foreground (through the **want** configuration) or background (default) and obtains the **Caller** object for communication with the ability. For details, see [AbilityContext](../reference/apis/js-apis-ability-context.md#abilitycontextstartabilitybycall) or [ServiceExtensionContext](../reference/apis/js-apis-service-extension-context.md#serviceextensioncontextstartabilitybycall).|
|on(method: string, callback: CalleeCallBack): void|Callback invoked when the callee ability registers a method.|
|off(method: string): void|Callback invoked when the callee ability deregisters a method.|
|call(method: string, data: rpc.Sequenceable): Promise\|Sends agreed sequenceable data to the callee ability.|
|callWithResult(method: string, data: rpc.Sequenceable): Promise\|Sends agreed sequenceable data to the callee ability and obtains the agreed sequenceable data returned by the callee ability.|
-|release(): void|Releases the `Caller` object.|
-|onRelease(callback: OnReleaseCallBack): void|Callback invoked when the `Caller` object is released.|
+|release(): void|Releases the **Caller** object.|
+|on(type: "release", callback: OnReleaseCallback): void|Callback invoked when the **Caller** object is released.|
## How to Develop
The procedure for developing the ability call is as follows:
1. Create a callee ability.
+
2. Access the callee ability.
-> **NOTE**
->
-> The code snippets provided in the **How to Develop** section are used to show specific development steps. They may not be able to run independently.
+
### Creating a Callee Ability
-For the callee ability, implement the callback to receive data and the methods to marshal and unmarshal data. When data needs to be received, use `on()` to register a listener. When data does not need to be received, use `off()` to deregister the listener.
+For the callee ability, implement the callback to receive data and the methods to marshal and unmarshal data. When data needs to be received, use **on()** to register a listener. When data does not need to be received, use **off()** to deregister the listener.
**1. Configure the ability launch type.**
- Set `launchType` of the callee ability to `singleton` in the `module.json5` file.
+ Set **launchType** of the callee ability to **singleton** in the **module.json5** file.
|JSON Field|Description|
|:------|:------|
-|"launchType"|Ability launch type. Set this parameter to `singleton`.|
+|"launchType"|Ability launch type. Set this parameter to **singleton**.|
An example of the ability configuration is as follows:
```json
@@ -73,7 +72,7 @@ An example of the ability configuration is as follows:
```
**2. Import the Ability module.**
```ts
-import Ability from '@ohos.application.Ability'
+import Ability from '@ohos.app.ability.UIAbility'
```
**3. Define the agreed sequenceable data.**
@@ -101,9 +100,9 @@ export default class MySequenceable {
}
}
```
-**4. Implement `Callee.on` and `Callee.off`.**
+**4. Implement Callee.on and Callee.off.**
- The time to register a listener for the callee ability depends on your application. The data sent and received before the listener is registered and that after the listener is deregistered are not processed. In the following example, the `MSG_SEND_METHOD` listener is registered in `onCreate` of the ability and deregistered in `onDestroy`. After receiving sequenceable data, the application processes the data and returns the data result. You need to implement processing based on service requirements. The code snippet is as follows:
+ The time to register a listener for the callee ability depends on your application. The data sent and received before the listener is registered and that after the listener is deregistered are not processed. In the following example, the **MSG_SEND_METHOD** listener is registered in **onCreate** of the ability and deregistered in **onDestroy**. After receiving sequenceable data, the application processes the data and returns the data result. You need to implement processing based on service requirements. The code snippet is as follows:
```ts
const TAG: string = '[CalleeAbility]'
const MSG_SEND_METHOD: string = 'CallSendMsg'
@@ -143,16 +142,16 @@ export default class CalleeAbility extends Ability {
### Accessing the Callee Ability
**1. Import the Ability module.**
```ts
-import Ability from '@ohos.application.Ability'
+import Ability from '@ohos.app.ability.UIAbility'
```
-**2. Obtain the `Caller` object.**
+**2. Obtain the Caller object.**
- The `context` attribute of the ability implements `startAbilityByCall` to obtain the `Caller` object for communication. The following example uses `this.context` to obtain the `context` attribute of the ability, uses `startAbilityByCall` to start the callee ability, obtain the `Caller` object, and register the `onRelease` listener of the caller ability. You need to implement processing based on service requirements. The code snippet is as follows:
+ The **context** attribute of the ability implements **startAbilityByCall** to obtain the **Caller** object for communication. The following example uses **this.context** to obtain the **context** attribute of the ability, uses **startAbilityByCall** to start the callee ability, obtain the **Caller** object, and register the **onRelease** listener of the caller ability. You need to implement processing based on service requirements. The code snippet is as follows:
```ts
// Register the onRelease listener of the caller ability.
private regOnRelease(caller) {
try {
- caller.onRelease((msg) => {
+ caller.on("release", (msg) => {
console.log(`caller onRelease is called ${msg}`)
})
console.log('caller register OnRelease succeed')
@@ -193,7 +192,7 @@ async onButtonGetRemoteCaller() {
caller = data
console.log('get remote caller success')
// Register the onRelease listener of the caller ability.
- caller.onRelease((msg) => {
+ caller.on("release", (msg) => {
console.log(`remote caller onRelease is called ${msg}`)
})
console.log('remote caller register OnRelease succeed')
@@ -203,7 +202,7 @@ async onButtonGetRemoteCaller() {
})
}
```
- Obtain the ID of the peer device from `DeviceManager`. Note that the `getTrustedDeviceListSync` API is open only to system applications. The code snippet is as follows:
+ Obtain the ID of the peer device from **DeviceManager**. Note that the **getTrustedDeviceListSync** API is open only to system applications. The code snippet is as follows:
```ts
import deviceManager from '@ohos.distributedHardware.deviceManager';
var dmClass;
@@ -248,7 +247,7 @@ async onButtonCall() {
}
```
- In the following, `CallWithResult` is used to send data `originMsg` to the callee ability and assign the data processed by the `CallSendMsg` method to `backMsg`. The code snippet is as follows:
+ In the following, **CallWithResult** is used to send data **originMsg** to the callee ability and assign the data processed by the **CallSendMsg** method to **backMsg**. The code snippet is as follows:
```ts
const MSG_SEND_METHOD: string = 'CallSendMsg'
originMsg: string = ''
@@ -268,9 +267,9 @@ async onButtonCallWithResult(originMsg, backMsg) {
}
}
```
-**4. Release the `Caller` object.**
+**4. Release the Caller object.**
- When the `Caller` object is no longer required, use `release()` to release it. The code snippet is as follows:
+ When the **Caller** object is no longer required, use **release()** to release it. The code snippet is as follows:
```ts
releaseCall() {
try {
diff --git a/en/application-dev/connectivity/Readme-EN.md b/en/application-dev/connectivity/Readme-EN.md
index 16bf40cf8467bc805d3b485ca46d6f0fa295b3bc..578e2a3c56c8a1f6cce377eb39ef9a7756d74491 100755
--- a/en/application-dev/connectivity/Readme-EN.md
+++ b/en/application-dev/connectivity/Readme-EN.md
@@ -1,11 +1,11 @@
# Connectivity
- Network Management
- - [Network Management Overview](net-mgmt-overview.md)
- - [HTTP Data Request](http-request.md)
- - [WebSocket Connection](websocket-connection.md)
- - [Socket Connection](socket-connection.md)
+ - [Network Management Overview](net-mgmt-overview.md)
+ - [HTTP Data Request](http-request.md)
+ - [WebSocket Connection](websocket-connection.md)
+ - [Socket Connection](socket-connection.md)
- IPC & RPC
- - [IPC & RPC Overview](ipc-rpc-overview.md)
- - [IPC & RPC Development](ipc-rpc-development-guideline.md)
- - [Subscribing to State Changes of a Remote Object](subscribe-remote-state.md)
+ - [IPC & RPC Overview](ipc-rpc-overview.md)
+ - [IPC & RPC Development](ipc-rpc-development-guideline.md)
+ - [Subscribing to State Changes of a Remote Object](subscribe-remote-state.md)
diff --git a/en/application-dev/database/database-mdds-guidelines.md b/en/application-dev/database/database-mdds-guidelines.md
index 8cec5ca111cd814d599d159ab7b333259f669ea8..73f785de4ddccaa1e10c6049066a5f3908d85fc6 100644
--- a/en/application-dev/database/database-mdds-guidelines.md
+++ b/en/application-dev/database/database-mdds-guidelines.md
@@ -6,20 +6,20 @@ The Distributed Data Service (DDS) implements synchronization of application dat
## Available APIs
-For details about the APIs, see [Distributed Data Management](../reference/apis/js-apis-distributed-data.md).
+For details about the APIs, see [Distributed KV Store](../reference/apis/js-apis-distributedKVStore.md).
**Table 1** APIs provided by the DDS
-| API | Description |
-| ------------------------------------------------------------ | ----------------------------------------------- |
-| createKVManager(config: KVManagerConfig, callback: AsyncCallback<KVManager>): void | Obtains a **Preferences** instance.|
-### Accessing Data
+### Processing Data
-Call the **put()** method to add or modify data in a **Preferences** instance.
+Call **put()** to add or modify data in a **Preferences** instance.
-Call the **get()** method to read data from a **Preferences** instance.
+Call **get()** to read data from a **Preferences** instance.
Call **getAll()** to obtain an **Object** instance that contains all KV pairs in a **Preferences** instance.
-**Table 2** APIs for accessing **Preferences** data
+Call **delete()** to delete the KV pair of the specified key from the **Preferences** instance.
+
+**Table 2** APIs for processing **Preferences** data
| Class | API | Description |
| ----------- | ---------------------------------------------------------- | ------------------------------------------------------------ |
| Preferences | put(key: string, value: ValueType): Promise\ | Writes data to the **Preferences** instance. The value to write can be a number, a string, a Boolean value, or an array of numbers, strings, or Boolean values.|
| Preferences | get(key: string, defValue: ValueType): Promise\ | Obtains data from the **Preferences** instance. The value to read can be a number, a string, a Boolean value, or an array of numbers, strings, or Boolean values.|
-| Preferences | getAll(): Promise | Obtains an **Object** instance that contains all KV pairs in the **Preferences** instance. |
+| Preferences | getAll(): Promise\ | Obtains an **Object** instance that contains all KV pairs in the **Preferences** instance. |
+| Preferences | delete(key: string): Promise\ | Deletes the KV pair of the specified key from the **Preferences** instance. |
### Storing Data Persistently
-Call the **flush()** method to write the cached data back to its text file for persistent storage.
+Call **flush()** to write the cached data back to its text file for persistent storage.
**Table 4** API for data persistence
@@ -68,7 +71,7 @@ You can subscribe to data changes. When the value of the subscribed key is chang
### Deleting Data
-Use the following APIs to delete a **Preferences** instance or data file.
+You can use the following APIs to delete a **Preferences** instance or data file.
**Table 6** APIs for deleting **Preferences**
@@ -130,7 +133,7 @@ Use the following APIs to delete a **Preferences** instance or data file.
3. Write data.
- Use the **preferences.put()** method to write data to the **Preferences** instance.
+ Use **preferences.put()** to write data to the **Preferences** instance.
```js
let putPromise = preferences.put('startup', 'auto');
@@ -143,7 +146,7 @@ Use the following APIs to delete a **Preferences** instance or data file.
4. Read data.
- Use the **preferences.get()** method to read data.
+ Use **preferences.get()** to read data.
```js
let getPromise = preferences.get('startup', 'default');
@@ -156,7 +159,7 @@ Use the following APIs to delete a **Preferences** instance or data file.
5. Store data persistently.
- Use the **flush()** method to flush data from the **Preferences** instance to its file.
+ Use **flush()** to flush data from the **Preferences** instance to its file.
```js
preferences.flush();
@@ -177,7 +180,7 @@ Use the following APIs to delete a **Preferences** instance or data file.
console.info("Failed to put the value of 'startup'. Cause: " + err);
return;
}
- console.info("Put the value of 'startup' successfully.");
+ console.info("Put the value of 'startup' successfully.");
preferences.flush(function (err) {
if (err) {
console.info("Failed to flush data. Cause: " + err);
@@ -190,7 +193,7 @@ Use the following APIs to delete a **Preferences** instance or data file.
7. Delete the specified file.
- Use the **deletePreferences** method to delete the **Preferences** instance and its persistent file and backup and corrupted files. After the specified files are deleted, the application cannot use that instance to perform any data operation. Otherwise, data inconsistency will be caused. The deleted data and files cannot be restored.
+ Use **deletePreferences()** to delete the **Preferences** instance and its persistent file and backup and corrupted files. After the specified files are deleted, the application cannot use that instance to perform any data operation. Otherwise, data inconsistency will be caused. The deleted data and files cannot be restored.
```js
let proDelete = data_preferences.deletePreferences(context, 'mystore');
diff --git a/en/application-dev/database/database-relational-guidelines.md b/en/application-dev/database/database-relational-guidelines.md
index 70fb8cbbee58dd51b8edacf8f7d6bc58e874859d..53e3ca5aeaa25ecea55f3e27272043e6b533e594 100644
--- a/en/application-dev/database/database-relational-guidelines.md
+++ b/en/application-dev/database/database-relational-guidelines.md
@@ -11,14 +11,14 @@ Most of the RDB store APIs are asynchronous interfaces, which can use a callback
### Creating or Deleting an RDB Store
-The table below describes the APIs available for creating and deleting an RDB store.
+The following table describes the APIs for creating and deleting an RDB store.
**Table 1** APIs for creating and deleting an RDB store
| API | Description |
| ------------------------------------------------------------ | ------------------------------------------------------------ |
-| getRdbStore(context: Context, config: StoreConfig, version: number): Promise<RdbStore> | Obtains an RDB store. This API uses a promise to return the result. You can set parameters for the RDB store based on service requirements and call APIs to perform data operations.): Promise\ | Sets distributed tables. This API uses a promise to return the result.): Promise\ | Sets distributed tables. This API uses a promise to return the result. | Obtains the distributed table name for a remote device based on the local table name. The distributed table name is required when the RDB store of a remote device is queried. This API uses a promise to return the result. | Obtains the distributed table name for a remote device based on the local table name. The distributed table name is required when the RDB store of a remote device is queried. This API uses a promise to return the result.> | Synchronizes data between devices. This API uses a promise to return the result.> | Synchronizes data between devices. This API uses a promise to return the result.>): void | Registers an observer for this RDB store to subscribe to distributed data changes. When data in the RDB store changes, a callback will be invoked to return the data changes.>): void | Registers an observer for this RDB store to subscribe to distributed data changes. When data in the RDB store changes, a callback will be invoked to return the data changes.>): void; | Unregisters the observer of the specified type from the RDB store. This API uses an asynchronous callback to return the result.>): void; | Unregisters the observer of the specified type from the RDB store. This API uses an asynchronous callback to return the result. | Requests the temporary permission for a given application to access the USB device. |
+| removeRight(deviceName: string): boolean | Removes the permission for a given application to access the USB device. |
| connectDevice(device: USBDevice): Readonly\ | Connects to the USB device based on the device information returned by `getDevices()`. |
| getDevices(): Array> | Obtains the USB device list. |
| setConfiguration(pipe: USBDevicePipe, config: USBConfig): number | Sets the USB device configuration. |
diff --git a/en/application-dev/dfx/hiappevent-guidelines.md b/en/application-dev/dfx/hiappevent-guidelines.md
index afda67ee6fdf21b3d91d525d397c956d98167e82..067b9b8c915417b93340ab55bf34a74bca422a3d 100644
--- a/en/application-dev/dfx/hiappevent-guidelines.md
+++ b/en/application-dev/dfx/hiappevent-guidelines.md
@@ -8,7 +8,7 @@ The event logging function helps applications log various information generated
JS application event logging APIs are provided by the **hiAppEvent** module.
-The following table provides only a brief description of related APIs. For details, see [HiAppEvent](../reference/apis/js-apis-hiappevent.md).
+The following table provides only a brief description of related APIs. For details, see [HiAppEvent](../reference/apis/js-apis-hiviewdfx-hiappevent.md).
**Table 1** APIs for application event logging
@@ -17,17 +17,11 @@ The following table provides only a brief description of related APIs. For detai
| write(AppEventInfo info, AsyncCallback\ callback): void | Logs application events in asynchronous mode. This API uses an asynchronous callback to return the result.|
| write(AppEventInfo info): Promise\ | Logs application events in asynchronous mode. This API uses a promise to return the result. |
-When an asynchronous callback is used, the return value can be processed directly in the callback.
-
-If a promise is used, the return value can also be processed in the promise in a similar way.
-
-For details about the result codes, see [Event Verification Result Codes](#event-verification-result-codes).
-
**Table 2** APIs for event logging configuration
-| API | Description |
-| --------------------------------------- | ---------------------------------------------------- |
-| configure(ConfigOption config): boolean | Sets the configuration options for application event logging.|
+| API | Description |
+| ------------------------------------ | ---------------------------------------------------- |
+| configure(ConfigOption config): void | Sets the configuration options for application event logging.|
**Table 3** APIs for watcher management
@@ -42,32 +36,14 @@ For details about the result codes, see [Event Verification Result Codes](#event
| ----------------- | -------------------- |
| clearData(): void | Clears local logging data.|
-### Event Verification Result Codes
-
-| Result Code| Cause | Verification Rules | Handling Method |
-| ------ | ----------------------------- | ------------------------------------------------------------ | ---------------------------------------------------------- |
-| 0 | N/A | Event verification is successful. | Event logging is normal. No action is required. |
-| -1 | Invalid event name | The name is not empty and contains a maximum of 48 characters.** component to control the shadow size.
+
+## How do I set the widget background to transparent?
+
+Applicable to: OpenHarmony SDK 3.2.5.5
+
+1. Create the **widget/resources/styles/default.json** file in the root directory of the widget.
+
+2. Add the following code to the **default.json** file:
+
+```
+{
+ "style": {
+ "app_background": "#00000000"
+ }
+}
+```
+
+## How do I pass parameters for FA widgets?
+
+Applicable to: OpenHarmony SDK 3.2.5.5
+
+Use **featureAbility.getWant()** and **featureAbility.getContext()** to send data through **router** in the JSON file and use **featureAbility** to receive data in the JS file.
+
+## How do I trigger router.disableAlertBeforeBackPage and router.enableAlertBeforeBackPage?
+
+Applicable to: OpenHarmony SDK 3.2.5.5
+
+The following conditions must be met:
+
+1. Before the redirection to the previous page, a confirm dialog box will be displayed. Note that **router.disableAlertBeforeBackPage** is used to disable the display of a confirm dialog box before returning to the previous page (default), and **router.enableAlertBeforeBackPage** is used to enable the display.
+
+2. The system return key is used.
diff --git a/en/application-dev/faqs/faqs-bundle.md b/en/application-dev/faqs/faqs-bundle.md
new file mode 100644
index 0000000000000000000000000000000000000000..61a5277c6d4a1493d0281fdd66b88a99a07141ae
--- /dev/null
+++ b/en/application-dev/faqs/faqs-bundle.md
@@ -0,0 +1,31 @@
+# Bundle Management Development
+
+## How do I obtain the version code and version name of an application?
+
+Applicable to: OpenHarmony SDK 3.2.3.5, stage model of API version 9
+
+Use **bundle.getBundleInfo()** to obtain the bundle information, which contains the version code and version name.
+
+Reference: [Bundle](../reference/apis/js-apis-Bundle.md#bundlegetbundleinfo)
+
+## How do I obtain the bundle name of an application?
+
+Applicable to: OpenHarmony SDK 3.2.3.5, stage model of API version 9
+
+Obtain the bundle name through **context.abilityInfo.bundleName**.
+
+Reference: [AbilityContext](../reference/apis/js-apis-ability-context.md) and [AbilityInfo](../reference/apis/js-apis-bundle-AbilityInfo.md)
+
+## How do I obtain an application icon?
+
+Applicable to: OpenHarmony SDK 3.2.3.5, stage model of API version 9
+
+Use **bundle.getAbilityIcon** to obtain the application icon. To use this API, you must configure the permission **ohos.permission.GET_BUNDLE_INFO**.
+
+Reference: [Bundle](../reference/apis/js-apis-Bundle.md#bundlegetbundleinfo)
+
+## How do I determine whether an application is a system application?
+
+Applicable to: OpenHarmony SDK 3.2.5.5, stage model of API version 9
+
+Use **bundle.getApplicationInfo** to obtain the application information, and then check the value of **systemApp** in the information. The application is a system application if the value is **true**.
diff --git a/en/application-dev/faqs/faqs-development-board.md b/en/application-dev/faqs/faqs-development-board.md
index 4766d4f5271dec2e5ec937477cf1ce1b7946eef6..79e5fc390f934f82eb3d70468f9ed41faed68947 100644
--- a/en/application-dev/faqs/faqs-development-board.md
+++ b/en/application-dev/faqs/faqs-development-board.md
@@ -1,6 +1,4 @@
-# Development Board
-
-
+# Development Board Usage
## How do I take screenshots on a development board?
@@ -29,8 +27,8 @@ Applicable to: DevEco Studio 3.0.0.991
1. Create a profile in Previewer.
-2. Set the profile parameters as follows:
+2. Set the profile parameters as follows:
Device type : default
Resolution: 720\*1280
diff --git a/en/application-dev/faqs/faqs-device-management.md b/en/application-dev/faqs/faqs-device-management.md
index 5bb748f758a4636fb40ae5d7fb741eccfb5306fe..dd836eb11abfbee3979f5a604eb5aa734d0d9112 100644
--- a/en/application-dev/faqs/faqs-device-management.md
+++ b/en/application-dev/faqs/faqs-device-management.md
@@ -1,12 +1,10 @@
# Device Management Development
-
-
## How do I obtain the DPI of a device?
Applicable to: OpenHarmony SDK 3.2.2.5, stage model of API version 9
-Import the **@ohos.display** module and call the **getDefaultDisplay** API.
+Import the **\@ohos.display** module and call the **getDefaultDisplay** API.
Example:
@@ -20,5 +18,33 @@ display.getDefaultDisplay((err, data) => {
}
console.info('Test Succeeded in obtaining the default display object. Data:' + JSON.stringify(data));
console.info('Test densityDPI:' + JSON.stringify(data.densityDPI));
-});https://gitee.com/openharmony/docs/blob/master/zh-cn/application-dev/reference/apis/js-apis-device-info.md)
+});
```
+
+## How do I obtain the type of the device where the application is running?
+
+Applicable to: OpenHarmony SDK 3.2.2.5, stage model of API version 9
+
+Import the **\@ohos.deviceInfo** module and call the **deviceInfo.deviceType** API.
+
+For details, see [Device Information](../reference/apis/js-apis-device-info.md).
+
+## How do I obtain the system version of a device?
+
+Applicable to: OpenHarmony SDK 3.2.5.5, stage model of API version 9
+
+Use the **osFullName** attribute of the [deviceInfo](../reference/apis/js-apis-device-info.md) object.
+
+## How do I obtain the UDID of an OpenHarmony device?
+
+Applicable to: OpenHarmony SDK3.0, stage model of API version 9
+
+- To obtain the UDID of the connected device, run the **hdc shell bm get --udid** command.
+
+- For details about how to obtain the UDID from code, see [udid](../reference/apis/js-apis-device-info.md).
+
+## How do I develop a shortcut key function?
+
+Applicable to: OpenHarmony SDK 3.2.6.5, stage model of API version 9
+
+To develop a shortcut key function, use the APIs in [Input Consumer](../reference/apis/js-apis-inputconsumer.md).
diff --git a/en/application-dev/faqs/faqs-graphics.md b/en/application-dev/faqs/faqs-graphics.md
index c4e151559b547b2cdb4f8d7cb19b35318203674a..7752d9d746fc3cfe3d8b7028ada2c4d3c5af2136 100644
--- a/en/application-dev/faqs/faqs-graphics.md
+++ b/en/application-dev/faqs/faqs-graphics.md
@@ -11,3 +11,80 @@ In effect, the **isStatusBarLightIcon** and **isNavigationBarLightIcon** attribu
Applicable to: OpenHarmony SDK 3.2.3.5, stage model of API version 9
Import the **\@ohos.window** module, and call **window.setSystemBarProperties()**.
+
+## How do I hide the status bar to get the immersive effect?
+
+Applicable to: OpenHarmony SDK 3.2.6.3, stage model of API version 9
+
+1. Use the **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 SDK 3.2.3.5, stage model of API version 9
+
+Use **window.getProperties()** to obtain the window properties. The **windowRect** field in the properties specifies the window width and height.
+
+Example:
+
+
+```
+let promise = windowClass.getProperties();
+promise.then((data)=> {
+ console.info('Succeeded in obtaining the window properties. Data: ' + JSON.stringify(data.windowRect));
+}).catch((err)=>{
+ console.error('Failed to obtain the window properties. Cause: ' + JSON.stringify(err));
+});
+```
+
+## How do I set the color of the system bar?
+
+Applicable to: OpenHarmony SDK 3.2.5.5, stage model of API version 9
+
+Refer to the following code:
+
+
+```
+window.getTopWindow(globalThis.mainContext).then(win => {
+ var systemBarProperties = {
+ statusBarColor: '#19B6FF', // Set the background color of the status bar.
+ navigationBarColor: '#19B6FF', // Set the background color of the navigation bar.
+ isStatusBarLightIcon: false, // Set the icon on the status bar not to be highlighted.
+ isNavigationBarLightIcon: true, // Set the icon on the navigation bar to be highlighted.
+ statusBarContentColor: '#0D0500', // Set the text color of the status bar.
+ navigationBarContentColor: '#FFA500' // Set the text color of the navigation bar.
+ };
+ win.setSystemBarProperties(systemBarProperties).catch(err => {
+ INDEX_LOGGER.info(`set System Bar Properties failed:${err}`)
+ })
+})
+.catch(err => {
+ INDEX_LOGGER.info(`get top window failed:${err}`)
+})
+```
diff --git a/en/application-dev/faqs/faqs-media.md b/en/application-dev/faqs/faqs-media.md
new file mode 100644
index 0000000000000000000000000000000000000000..9f465834a0951246f822ef2b5f8a5bf619ec1c5a
--- /dev/null
+++ b/en/application-dev/faqs/faqs-media.md
@@ -0,0 +1,128 @@
+# Media Development
+
+## How do I set a front camera?
+
+Applicable to: OpenHarmony SDK 3.2.3.5, stage model of API version 9
+
+1. Set the camera position to **camera.CameraPosition.CAMERA_POSITION_FRONT**.
+
+2. Create a **CameraInput** instance based on the camera position and type.
+
+Reference: [Camera Management](../reference/apis/js-apis-camera.md)
+
+Example:
+
+```
+// The rear camera is set by default. You can use **isFrontCamera** to switch to the rear camera.
+let cameraId
+let cameraInput
+for(let cameraIndex = 0; cameraIndex < this.cameraArray.length; cameraIndex++) {
+ let faceType = this.cameraArray[cameraIndex].cameraPosition
+ switch(faceType) {
+ case camera.CameraPosition.CAMERA_POSITION_FRONT: // Front camera
+ if(this.isFrontCamera){
+ cameraId = this.cameraArray[cameraIndex].cameraId
+ }
+ break
+ case camera.CameraPosition.CAMERA_POSITION_BACK: // Rear camera
+ if(!this.isFrontCamera){
+ cameraId = this.cameraArray[cameraIndex].cameraId
+ }
+ break
+ case camera.CameraPosition.CAMERA_POSITION_UNSPECIFIED:
+ default:
+ break
+ }
+}
+cameraInput = await this.cameraManager.createCameraInput(cameraId)
+```
+
+## How do I crop an image?
+
+Applicable to: OpenHarmony SDK 3.2.5.6, stage model of API version 9
+
+1. Create an **ImageSource** instance based on the input URI.
+
+ ```
+ let path = this.context.getApplicationContext().fileDirs + "test.jpg";
+ const imageSourceApi = image.createImageSource(path);
+ ```
+
+2. Set decoding parameters and decode the image to obtain a **PixelMap** object. Image processing is supported during decoding.
+ - Set **desiredSize** to specify the target size after scaling. If the values are all set to **0**, scaling will not be performed.
+ - Set **desiredRegion** to specify the target rectangular area after cropping. If the values are all set to **0**, cropping will not be performed.
+ - Set **rotateDegrees** to specify the rotation angle. The image will be rotated clockwise at the center.
+
+ ```
+ const decodingOptions = {
+ desiredSize: {
+ height:0,
+ width:0
+ },
+ // Crop a rectangular area.
+ desiredRegion: {
+ size: {
+ height:100,
+ width:100
+ },
+ x:0,
+ y:0
+ },
+ // Rotate the image by 90 degrees.
+ rotate:90
+ }
+ imageSourceApi.createPixelMap(decodingOptions).then(pixelMap => {
+ this.handlePixelMap(pixelMap)
+ })
+ ```
+
+3. Process the obtained **PixelMap** object. For example, render and display the image.
+
+## How do I apply for the media read/write permission on a device?
+
+Applicable to: OpenHarmony SDK 3.2.5.5, stage model of API version 9
+
+1. Configure the permissions **ohos.permission.READ_MEDIA** and **ohos.permission.WRITE_MEDIA** in the **module.json5** file.
+ Example:
+
+
+ ```
+ {
+ "module" : {
+ "requestPermissions":[
+ {
+ "name" : "ohos.permission.READ_MEDIA",
+ "reason": "$string:reason"
+ },
+ {
+ "name" : "ohos.permission.WRITE_MEDIA",
+ "reason": "$string:reason"
+ }
+ ]
+ }
+ }
+ ```
+
+2. Call **requestPermissionsFromUser** to request the permissions from end users in the form of a dialog box. This operation is required because the grant mode of both permissions is **user_grant**.
+
+ ```
+ let permissions: Array = ['ohos.permission.READ_MEDIA','ohos.permission.WRITE_MEDIA']
+ context.requestPermissionsFromUser(permissions).then((data) => {
+ console.log("Succeed to request permission from user with data: " + JSON.stringify(data))
+ }).catch((error) => {
+ console.log("Failed to request permission from user with error: " + JSON.stringify(error))
+ })
+ ```
+
+## Why can't I play MP4 videos?
+
+Applicable to: OpenHarmony SDK 3.2.7.5, stage model of API version 9
+
+Currently, the system does not support the playback of MP4 videos in H.265 format.
+
+
+## Why can't I play a new video or even encounters a crash after creating more than 10 videos?
+
+Applicable to: OpenHarmony SDK 3.2.7.5, stage model of API version 9
+
+A maximum of 13 media player instances can be created.
diff --git a/en/application-dev/faqs/faqs-native.md b/en/application-dev/faqs/faqs-native.md
index da00895e4a5b5a532e67f9f709dd84c25abe3205..ef5700bb0ec1e3c903fd758d644779856f0ce681 100644
--- a/en/application-dev/faqs/faqs-native.md
+++ b/en/application-dev/faqs/faqs-native.md
@@ -1,12 +1,30 @@
# Native API Usage
+## Is there a native API that provides functions similar to Canvas?
+
+Applicable to: OpenHarmony SDK 3.2.5.3, stage model of API version 9
+
+Yes. The native API **Drawing** provides similar functions. It can be used for 2D drawing.
+
## When a native HAP is running, the error message "Obj is not a valid object" is displayed for the imported namespace. What should I do?
Applicable to: OpenHarmony SDK 3.2.5.3, stage model of API version 9
Check the **abiFilters** parameter value in the **build-profile.json5** file in the root directory of the module (not the root directory of the project). If the device is 32-bit, the value must be **armeabi-v7a**. If the device is 64-bit, the value must be **arm64-v8a**.
-## How do I obtain the value of version in the package.json file of a module in the C++ code developed using native APIs?
+## What should I do when the error message "install parse profile prop check error" is displayed during the running of a native HAP?
+
+Applicable to: OpenHarmony SDK 3.2.6.3, stage model of API version 9
+
+Check the **abiFilters** parameter value in the **build-profile.json5** file in the root directory of the module (not the root directory of the project). If the device is 32-bit, the value must be **armeabi-v7a**. If the device is 64-bit, the value must be **arm64-v8a**.
+
+## What should I do when the error message "undefined symbol: OH_LOG_Print" is displayed during log printing by **OH_LOG_Print**?
+
+Applicable to: OpenHarmony SDK 3.2.6.3, stage model of API version 9
+
+Modify the **CMakeLists.txt** file by adding **libhilog_ndk.z.so** to the end of **target_link_libraries**.
+
+## How do I obtain the value of version in the package.json file of a module?
Applicable to: OpenHarmony SDK 3.2.5.3, stage model of API version 9
@@ -53,3 +71,9 @@ static napi_value Add(napi_env env, napi_callback_info info)
return fixed_version_value;
}
```
+
+## How do I traverse files in rawfile?
+
+Applicable to: OpenHarmony SDK 3.2 or later, stage model of API version 9
+
+Use the native API **OH_ResourceManager_OpenRawDir()** to obtain the root directory of **rawfile** and traverse the root directory.
diff --git a/en/application-dev/faqs/faqs-third-party-library.md b/en/application-dev/faqs/faqs-third-party-library.md
index 323269c5e0a4d8c84e9adbb39c4184bba9a00b5e..898055cd200805d8df549b33bb2c5f3b4b05bca6 100644
--- a/en/application-dev/faqs/faqs-third-party-library.md
+++ b/en/application-dev/faqs/faqs-third-party-library.md
@@ -1,7 +1,74 @@
# Usage of Third- and Fourth-Party Libraries
-## What does the following error message mean : "Stage model module... does not support including OpenHarmony npm packages or modules in FA model. OpenHarmony build tasks will not be executed, and OpenHarmony resources will not be packed."
+## What does the following error message mean: "Stage model module... does not support including OpenHarmony npm packages or modules in FA model. OpenHarmony build tasks will not be executed, and OpenHarmony resources will not be packed."
Applicable to: OpenHarmony SDK 3.2.5.3, stage model of API version 9
The third- and fourth-party libraries are not yet compatible with the stage model of API version 9 and cannot be used.
+
+## Can I transfer project-level dependencies?
+
+Applicable to: OpenHarmony SDK 3.2.5.3, stage model of API version 9
+
+For example, if project A depends on project B and project B depends on project C, can project A directly use the APIs provided by project C?
+
+No. Project A cannot directly use the APIs provided by project C. The project packing tool NPM does not support dependency transfer. To use the APIs provided by project C, you can add the dependency of project C to project A.
+
+## How do I obtain available third-party libraries?
+
+Applicable to: OpenHarmony SDK 3.2.6.5, stage model of API version 9
+
+For details, see [Third-Party Components That Can Be Directly Used on OpenHarmony](https://gitee.com/openharmony-sig/third_party_app_libs).
+
+## Which third-party libraries are related to network requests?
+
+Applicable to: OpenHarmony SDK 3.2.6.5, stage model of API version 9
+
+The [Axios](https://gitee.com/openharmony-sig/axios) library is related to network requests.
+
+## How do I use NPM to import third- and fourth-party libraries?
+
+Applicable to: OpenHarmony SDK 3.2.5.5, stage model of API version 9
+- Method 1:
+ 1. Open the **Terminal** window and run the following command to go to the **entry** directory:
+
+ ```
+ cd entry
+ ```
+ 2. Run the following command to install a third-party package, for example, **dayjs**:
+
+ ```
+ npm install dayjs --save
+ ```
+ 3. Add the following statement in the .js file to import the package:
+
+ ```
+ import dayjs from 'dayjs';
+ ```
+
+- Method 2:
+ 1. Enter the **entry** directory of the project and open the **package.json** file.
+ 2. Write the third-party NPM package to be installed (for example, **dayjs**) in the **package.json** file.
+
+ ```
+ {
+ "dependencies": {
+ "dayjs": "^1.10.4",
+ }
+ }
+ ```
+ 3. Open the **Terminal** window and run the following command to go to the **entry** directory:
+
+ ```
+ cd entry
+ ```
+ 4. Run the following command to install NPM:
+
+ ```
+ npm install
+ ```
+ 5. Add the following statement in the .js file to import the package:
+
+ ```
+ import dayjs from 'dayjs';
+ ```
diff --git a/en/application-dev/faqs/faqs-ui-ets.md b/en/application-dev/faqs/faqs-ui-ets.md
index 86a05c91851d6844dcc08e368d81b936b7d1b8ac..3ec2b755e3e99db07930d5f8a6d01975985f4948 100644
--- a/en/application-dev/faqs/faqs-ui-ets.md
+++ b/en/application-dev/faqs/faqs-ui-ets.md
@@ -1,4 +1,4 @@
-# ArkUI (eTS) Development
+# ArkUI (ArkTS) Development
@@ -72,7 +72,7 @@ Applicable to: OpenHarmony SDK 3.2.2.5, stage model of API version 9
2. Convert data in Uint8Array format to the string type by calling the **String.fromCharCode** API.
-Reference: [Resource Management](https://gitee.com/openharmony/docs/blob/master/en/application-dev/reference/apis/js-apis-resource-manager.md)
+Reference: [Resource Management](../reference/apis/js-apis-resource-manager.md)
Example:
@@ -94,7 +94,7 @@ Applicable to: OpenHarmony SDK 3.2.3.5, stage model of API version 9
Use the **resourceManager.getString()** API of the **\@ohos.resourceManager** module.
-Reference: [Resource Management](https://gitee.com/openharmony/docs/blob/master/en/application-dev/reference/apis/js-apis-resource-manager.md#getstring)
+Reference: [Resource Management](../reference/apis/js-apis-resource-manager.md#getstring)
## What should I do if the global static variables of a class do not work?
@@ -102,8 +102,6 @@ Applicable to: OpenHarmony SDK 3.2.3.5, stage model of API version 9
Objects imported to abilities and pages are packaged into two different closures, that is, two global objects. In this case, a static variable referenced by the abilities is not the same object as that referenced by the pages. Therefore, global variables cannot be defined by defining static variables in the class. You are advised to use AppStorage to manage global variables.
-Reference: [AppStorage](https://docs.openharmony.cn/pages/v3.2Beta/en/application-dev/ui/ts-application-states-appstorage.md/)
-
## How do I obtain resources in the stage model?
Applicable to: OpenHarmony SDK 3.2.3.5, stage model of API version 9
@@ -154,9 +152,9 @@ build() {
Applicable to: OpenHarmony SDK 3.2.2.5, stage model of API version 9
-No. Currently, **CustomDialog** can be used only on eTS pages.
+No. Currently, **CustomDialog** can be used only on ArkTS pages.
-Reference: [Custom Dialog Box](https://gitee.com/openharmony/docs/blob/master/en/application-dev/reference/arkui-ts/ts-methods-custom-dialog-box.md)
+Reference: [Custom Dialog Box](../reference/arkui-ts/ts-methods-custom-dialog-box.md)
## How do I transfer variables in CustomDialog to variables on pages?
@@ -210,7 +208,7 @@ Applicable to: OpenHarmony SDK 3.2.5.3, stage model of API version 9
By default, child components in a **\** are horizontally aligned to the left. To center them, perform the following steps:
-Nest a **\** component and set it to **justifyContent(FlexAlign.Center)**. For details, see [Grid Layout](https://gitee.com/openharmony/docs/blob/master/zh-cn/application-dev/ui/ui-ts-layout-grid-container.md).
+Nest a **\** component and set it to **justifyContent(FlexAlign.Center)**. For details, see [Grid Layout](../reference/arkui-ts/ts-container-gridcontainer.md).
Example:
@@ -267,13 +265,13 @@ export default class MainAbility extends Ability {
}
```
-## How do I execute JavaScript functions in the \ component in eTS code?
+## How do I execute JavaScript functions in the \ component in ArkTS code?
Applicable to: OpenHarmony SDK 3.2.3.5, stage model of API version 9
Call the **runJavaScript** API in the **WebController** to asynchronously execute JavaScript scripts. This API uses a callback to return the execution result. Note: **runJavaScript** can only be called after **loadUrl** has been completed. For example, it can be called in **onPageEnd**.
-Reference: [Web](https://gitee.com/openharmony/docs/blob/master/en/application-dev/reference/arkui-ts/ts-basic-components-web.md)
+Reference: [Web](../reference/arkui-ts/ts-basic-components-web.md)
## How do I fix misidentification of the pan gesture where container nesting is involved?
diff --git a/en/application-dev/faqs/faqs-ui-js.md b/en/application-dev/faqs/faqs-ui-js.md
index 7d4ae1dcb80b63a4632e3a30627ff53f37e63c37..c60ff729eae773a356a50da1b9197c1de2b9c120 100644
--- a/en/application-dev/faqs/faqs-ui-js.md
+++ b/en/application-dev/faqs/faqs-ui-js.md
@@ -1,7 +1,5 @@
# ArkUI (JavaScript) Development
-
-
## How do I convert the fields in an XML file into JavaScript objects?
Applicable to: OpenHarmony SDK 3.2.3.5, stage model of API version 9
@@ -13,38 +11,37 @@ Example:
```
import convertxml from '@ohos.convertxml';
-// Code snippet
-xml =
+// XML strings
+let xml =
'' +
'' +
' Happy ' +
' Work ' +
' Play ' +
' ';
-let conv = new convertxml.ConvertXML();
+let conv = new convertxml.ConvertXML();
// Options for conversion. For details, see the reference document.
-let options = {trim : false, declarationKey:"_declaration",
- instructionKey : "_instruction", attributesKey : "_attributes",
- textKey : "_text", cdataKey:"_cdata", doctypeKey : "_doctype",
- commentKey : "_comment", parentKey : "_parent", typeKey : "_type",
- nameKey : "_name", elementsKey : "_elements"}
-let result:any = conv.convert(xml, options) // Convert fields in the XML file into JavaScript objects.
+let options = {
+ trim: false,
+ declarationKey: "_declaration",
+ instructionKey: "_instruction",
+ attributesKey: "_attributes",
+ textKey: "_text",
+ cdataKey: "_cdata",
+ doctypeKey: "_doctype",
+ commentKey: "_comment",
+ parentKey: "_parent",
+ typeKey: "_type",
+ nameKey: "_name",
+ elementsKey: "_elements"
+}
+let result: any = conv.convert(xml, options) // Convert fields in the XML file into JavaScript objects.
console.log('Test: ' + JSON.stringify(result))
-console.log('Test: ' + result._declaration._attributes.version) // version field in XML file
-console.log('Test: ' + result._elements[0]._elements[0]._elements[0]._text) // title field in XML file
+console.log('Test: ' + result._declaration._attributes.version) // version field in the XML file
+console.log('Test: ' + result._elements[0]._elements[0]._elements[0]._text) // title field in the XML file
```
-Reference: [XML-to-JavaScript Conversion](https://gitee.com/openharmony/docs/blob/master/en/application-dev/reference/apis/js-apis-convertxml.md)
-
-## What are the differences between JavaScript, TypeScript, and eTS?
-
-Applicable to: OpenHarmony SDK 3.2.3.5, stage model of API version 9
-
-- JavaScript: a lightweight, weakly-typed programming language, most commonly known as the scripting language for web pages.
-
-- TypeScript: a superset of JavaScript, with additions of static typing and more object-oriented APIs, enums, etc.
-
-- eTS: a superset of TypeScript and the programming language for OpenHarmony ArkUI development, which powers UI development through a declarative development paradigm.
+For details, see [XML-to-JavaScript Conversion](../reference/apis/js-apis-convertxml.md).
## How do I convert the time to the HHMMSS format?
@@ -93,4 +90,5 @@ export default class DateTimeUtil{
return `${this.fill(hours)}${this.fill(minutes)}${this.fill(seconds)}`
}
}
+
```
diff --git a/en/application-dev/file-management/medialibrary-album-guidelines.md b/en/application-dev/file-management/medialibrary-album-guidelines.md
index 322e596ef6a0776291ab36529fb10760c09b4c51..fccb8446d5309dbbff0d0687aae8be5ceaf958c8 100644
--- a/en/application-dev/file-management/medialibrary-album-guidelines.md
+++ b/en/application-dev/file-management/medialibrary-album-guidelines.md
@@ -12,9 +12,9 @@ To ensure the application running efficiency, most **MediaLibrary** API calls ar
You can obtain images and videos in an album in either of the following ways:
-- Call [MediaLibrary.getFileAssets](../reference/apis/js-apis-medialibrary.md#getfileassets7-1) with an album specified to obtain the media assets. For details, see [Querying Media Assets with the Specified Album Name](medialibrary-resource-guidelines#querying-media-assets-with-the-specified-album-name).
+- Call [MediaLibrary.getFileAssets](../reference/apis/js-apis-medialibrary.md#getfileassets7-1) with an album specified to obtain the media assets. For details, see [Querying Media Assets with the Specified Album Name](medialibrary-resource-guidelines.md#querying-media-assets-with-the-specified-album-name).
-- Call [Album.getFileAssets](../reference/apis/js-apis-medialibrary.md#getfileassets7-3) to obtain an **Album** instance, so as to obtain the media assets in it. For details, see [Obtaining Images and Videos in an Album](medialibrary-resource-guidelines#obtaining-images-and-videos-in-an-album).
+- Call [Album.getFileAssets](../reference/apis/js-apis-medialibrary.md#getfileassets7-3) to obtain an **Album** instance, so as to obtain the media assets in it. For details, see [Obtaining Images and Videos in an Album](medialibrary-resource-guidelines.md#obtaining-images-and-videos-in-an-album).
## Creating an Album
diff --git a/en/application-dev/file-management/medialibrary-resource-guidelines.md b/en/application-dev/file-management/medialibrary-resource-guidelines.md
index 737ea4e48fa24c38f47fe7595e9df6e1370ab69a..d3ca37dc5be9163a4de8c303aa81704d95056bc1 100644
--- a/en/application-dev/file-management/medialibrary-resource-guidelines.md
+++ b/en/application-dev/file-management/medialibrary-resource-guidelines.md
@@ -6,7 +6,7 @@ Your applications can use the APIs provided by the **mediaLibrary** module to pe
>
> Before developing features, read [MediaLibrary Overview](medialibrary-overview.md) to learn how to obtain a **MediaLibrary** instance and request the permissions to call the APIs of **MediaLibrary**.
-To ensure the application running efficiency, most **MediaLibrary** API calls are asynchronous, and both callback and promise modes are provided for these APIs. The following code samples use the promise mode. For details about the APIs, see [MediaLibrary API Reference](../reference/apis/js-apis-medialibrary.md).
+To maximize the application running efficiency, most **MediaLibrary** API calls are asynchronous in callback or promise mode. The following code samples use the promise mode. For details about the APIs, see [MediaLibrary API Reference](../reference/apis/js-apis-medialibrary.md).
## Querying Media Assets
@@ -215,7 +215,7 @@ async function getCameraImagePromise() {
## Obtaining the Thumbnail of an Image or a Video
-You can call [FileAsset.getThumbnail](../reference/apis/js-apis-medialibrary.md#getthumbnail8-2) with the thumbnail size passed in to obtain the thumbnail of an image or a video. Thumbnails are usually displayed on the UI.
+You can call [FileAsset.getThumbnail](../reference/apis/js-apis-medialibrary.md#getthumbnail8-2) with the thumbnail size passed in to obtain the thumbnail of an image or a video. Your application can use thumbnails to offer a quick preview on images and videos.
**Prerequisites**
@@ -224,8 +224,6 @@ You can call [FileAsset.getThumbnail](../reference/apis/js-apis-medialibrary.md#
### Obtaining the Thumbnail of an Image
-Your application may need to obtain the thumbnail of an image for preview purposes.
-
The following describes how to obtain the thumbnail (size: 720 x 720) of the first image in the album.
**How to Develop**
@@ -273,7 +271,7 @@ You can call [MediaLibrary.createAsset](../reference/apis/js-apis-medialibrary.m
- You have obtained a **MediaLibrary** instance.
- You have granted the permission **ohos.permission.WRITE_MEDIA**.
-- [Obtain the public directory](medialibrary-filepath-guidelines.md).
+- [You have obtained a public directory](medialibrary-filepath-guidelines.md).
The following describes how to create a file of the **MediaType.FILE** type.
@@ -296,7 +294,7 @@ async function example() {
You can use [FileAsset.trash](../reference/apis/js-apis-medialibrary.md#trash8) to move a media asset to the recycle bin.
-By default, files in the recycle bin will be stored for 30 days. During this period, you can set **isTrash** in **trash** to **false** to recover the files from the recycle bin. Application users can also recover the files through the system applications **Files** or **Gallery**.
+By default, files in the recycle bin will be stored for 30 days before being permanently removed. During this period, you can set **isTrash** in **trash** to **false** to recover the files. Application users can also recover the files through the system applications **Files** or **Gallery**.
**Prerequisites**
@@ -339,11 +337,9 @@ async function example() {
## Renaming a Media Asset
-Renaming modifies the **FileAsset.displayName** attribute of a file, that is, the displayed file name, including the file name extension.
-
-After the modification, call [FileAsset.commitModify](../reference/apis/js-apis-medialibrary.md#commitmodify8-1) to commit the modification to the database.
+To rename a media asset, modify the **FileAsset.displayName** attribute (which specifies the displayed file name, including the file name extension) and commit the modification through [FileAsset.commitModify](../reference/apis/js-apis-medialibrary.md#commitmodify8-1).
-Before renaming a file, you must call [FetchFileResult](../reference/apis/js-apis-medialibrary.md#fetchfileresult7) to obtain the file.
+Before renaming a file, you must obtain the file, for example, by calling [FetchFileResult](../reference/apis/js-apis-medialibrary.md#fetchfileresult7).
**Prerequisites**
@@ -358,7 +354,7 @@ The following describes how to rename the first file in the result set as **newt
2. Call **getFileAssets** to obtain the images in the target album.
3. Call **getFirstObject** to obtain the first image among all the images obtained.
4. Rename the image as **newImage.jpg**.
-5. Call **FileAsset.commitModify** to commit the modification of the attributes to the database.
+5. Call **FileAsset.commitModify** to commit the modification to the database.
```ts
async function example() {
diff --git a/en/application-dev/media/Readme-EN.md b/en/application-dev/media/Readme-EN.md
index 07f3425ff5ab3c10beeac312740ff6e756c3cd85..d65c0d9dbe51f963385afaac0b75deccc6b21d2b 100755
--- a/en/application-dev/media/Readme-EN.md
+++ b/en/application-dev/media/Readme-EN.md
@@ -10,11 +10,16 @@
- [OpenSL ES Audio Playback Development](opensles-playback.md)
- [OpenSL ES Audio Recording Development](opensles-capture.md)
- [Audio Interruption Mode Development](audio-interruptmode.md)
+ - [Volume Management Development](audio-volume-manager.md)
+ - [Audio Routing and Device Management Development](audio-routing-manager.md)
- Video
- [Video Playback Development](video-playback.md)
- [Video Recording Development](video-recorder.md)
+- AVSession
+ - [AVSession Overview](avsession-overview.md)
+ - [AVSession Development](avsession-guidelines.md)
- Image
- [Image Development](image.md)
diff --git a/en/application-dev/media/audio-playback.md b/en/application-dev/media/audio-playback.md
index 92aa1cd4fc35a4b64ad9b1044c1a7bd59f24453d..bbdb993ecdb9a1289a939af43db0e670ec10f98f 100644
--- a/en/application-dev/media/audio-playback.md
+++ b/en/application-dev/media/audio-playback.md
@@ -2,11 +2,11 @@
## Introduction
-You can use audio playback APIs to convert audio data into audible analog signals and play the signals using output devices. You can also manage playback tasks. For example, you can start, suspend, stop playback, release resources, set the volume, seek to a playback position, and obtain track information.
+You can use audio playback APIs to convert audio data into audible analog signals and play the signals using output devices. You can also manage playback tasks. For example, you can control the playback and volume, obtain track information, and release resources.
## Working Principles
-The following figures show the audio playback status changes and the interaction with external modules for audio playback.
+The following figures show the audio playback state transition and the interaction with external modules for audio playback.
**Figure 1** Audio playback state transition
@@ -28,7 +28,7 @@ For details about the APIs, see [AudioPlayer in the Media API](../reference/apis
> **NOTE**
>
-> The method for obtaining the path in the FA model is different from that in the stage model. **pathDir** used in the sample code below is an example. You need to obtain the path based on project requirements. For details about how to obtain the path, see [Application Sandbox Path Guidelines](../reference/apis/js-apis-fileio.md#guidelines).
+> The method for obtaining the path in the FA model is different from that in the stage model. For details about how to obtain the path, see [Application Sandbox Path Guidelines](../reference/apis/js-apis-fileio.md#guidelines).
### Full-Process Scenario
@@ -109,7 +109,7 @@ async function audioPlayerDemo() {
setCallBack(audioPlayer); // Set the event callbacks.
// 2. Set the URI of the audio file.
let fdPath = 'fd://'
- let pathDir = "/data/storage/el2/base/haps/entry/files" // The method for obtaining pathDir in the FA model is different from that in the stage model. For details, see NOTE just below How to Develop. You need to obtain pathDir based on project requirements.
+ let pathDir = "/data/storage/el2/base/haps/entry/files" // The path used here is an example. Obtain the path based on project requirements.
// The stream in the path can be pushed to the device by running the "hdc file send D:\xxx\01.mp3 /data/app/el2/100/base/ohos.acts.multimedia.audio.audioplayer/haps/entry/files" command.
let path = pathDir + '/01.mp3'
await fileIO.open(path).then((fdNumber) => {
@@ -151,7 +151,7 @@ export class AudioDemo {
let audioPlayer = media.createAudioPlayer(); // Create an AudioPlayer instance.
this.setCallBack(audioPlayer); // Set the event callbacks.
let fdPath = 'fd://'
- let pathDir = "/data/storage/el2/base/haps/entry/files" // The method for obtaining pathDir in the FA model is different from that in the stage model. For details, see NOTE just below How to Develop. You need to obtain pathDir based on project requirements.
+ let pathDir = "/data/storage/el2/base/haps/entry/files" // The path used here is an example. Obtain the path based on project requirements.
// The stream in the path can be pushed to the device by running the "hdc file send D:\xxx\01.mp3 /data/app/el2/100/base/ohos.acts.multimedia.audio.audioplayer/haps/entry/files" command.
let path = pathDir + '/01.mp3'
await fileIO.open(path).then((fdNumber) => {
@@ -199,7 +199,7 @@ export class AudioDemo {
async nextMusic(audioPlayer) {
this.isNextMusic = true;
let nextFdPath = 'fd://'
- let pathDir = "/data/storage/el2/base/haps/entry/files" // The method for obtaining pathDir in the FA model is different from that in the stage model. For details, see NOTE just below How to Develop. You need to obtain pathDir based on project requirements.
+ let pathDir = "/data/storage/el2/base/haps/entry/files" // The path used here is an example. Obtain the path based on project requirements.
// The stream in the path can be pushed to the device by running the "hdc file send D:\xxx\02.mp3 /data/app/el2/100/base/ohos.acts.multimedia.audio.audioplayer/haps/entry/files" command.
let nextpath = pathDir + '/02.mp3'
await fileIO.open(nextpath).then((fdNumber) => {
@@ -217,7 +217,7 @@ export class AudioDemo {
let audioPlayer = media.createAudioPlayer(); // Create an AudioPlayer instance.
this.setCallBack(audioPlayer); // Set the event callbacks.
let fdPath = 'fd://'
- let pathDir = "/data/storage/el2/base/haps/entry/files" // The method for obtaining pathDir in the FA model is different from that in the stage model. For details, see NOTE just below How to Develop. You need to obtain pathDir based on project requirements.
+ let pathDir = "/data/storage/el2/base/haps/entry/files" // The path used here is an example. Obtain the path based on project requirements.
// The stream in the path can be pushed to the device by running the "hdc file send D:\xxx\01.mp3 /data/app/el2/100/base/ohos.acts.multimedia.audio.audioplayer/haps/entry/files" command.
let path = pathDir + '/01.mp3'
await fileIO.open(path).then((fdNumber) => {
@@ -256,7 +256,7 @@ export class AudioDemo {
let audioPlayer = media.createAudioPlayer(); // Create an AudioPlayer instance.
this.setCallBack(audioPlayer); // Set the event callbacks.
let fdPath = 'fd://'
- let pathDir = "/data/storage/el2/base/haps/entry/files" // The method for obtaining pathDir in the FA model is different from that in the stage model. For details, see NOTE just below How to Develop. You need to obtain pathDir based on project requirements.
+ let pathDir = "/data/storage/el2/base/haps/entry/files" // The path used here is an example. Obtain the path based on project requirements.
// The stream in the path can be pushed to the device by running the "hdc file send D:\xxx\01.mp3 /data/app/el2/100/base/ohos.acts.multimedia.audio.audioplayer/haps/entry/files" command.
let path = pathDir + '/01.mp3'
await fileIO.open(path).then((fdNumber) => {
diff --git a/en/application-dev/media/audio-routing-manager.md b/en/application-dev/media/audio-routing-manager.md
new file mode 100644
index 0000000000000000000000000000000000000000..55febdca0fad968d946601fce4faed99bc148dd2
--- /dev/null
+++ b/en/application-dev/media/audio-routing-manager.md
@@ -0,0 +1,111 @@
+# Audio Routing and Device Management Development
+
+## Overview
+
+The **AudioRoutingManager** module provides APIs for audio routing and device management. You can use the APIs to obtain the current input and output audio devices, listen for connection status changes of audio devices, and activate communication devices.
+
+## Working Principles
+
+The figure below shows the common APIs provided by the **AudioRoutingManager** module.
+
+**Figure 1** Common APIs of AudioRoutingManager
+
+
+
+You can use these APIs to obtain the device list, subscribe to or unsubscribe from device connection status changes, activate communication devices, and obtain their activation status. For details, see [Audio Management](../reference/apis/js-apis-audio.md).
+
+
+## How to Develop
+
+For details about the APIs, see [AudioRoutingManager in Audio Management](../reference/apis/js-apis-audio.md#audioroutingmanager9).
+
+1. Obtain an **AudioRoutingManager** instance.
+
+ Before using an API in **AudioRoutingManager**, you must use **getRoutingManager()** to obtain an **AudioRoutingManager** instance.
+
+ ```js
+ import audio from '@ohos.multimedia.audio';
+ async loadAudioRoutingManager() {
+ var audioRoutingManager = await audio.getAudioManager().getRoutingManager();
+ console.info('audioRoutingManager------create-------success.');
+ }
+
+ ```
+
+2. (Optional) Obtain the device list and subscribe to device connection status changes.
+
+ To obtain the device list (such as input, output, distributed input, and distributed output devices) or listen for connection status changes of audio devices, refer to the following code:
+
+ ```js
+ import audio from '@ohos.multimedia.audio';
+ // Obtain an AudioRoutingManager instance.
+ async loadAudioRoutingManager() {
+ var audioRoutingManager = await audio.getAudioManager().getRoutingManager();
+ console.info('audioRoutingManager------create-------success.');
+ }
+ // Obtain information about all audio devices. (You can set DeviceFlag as required.)
+ async getDevices() {
+ await loadAudioRoutingManager();
+ await audioRoutingManager.getDevices(audio.DeviceFlag.ALL_DEVICES_FLAG).then((data) => {
+ console.info(`getDevices success and data is: ${JSON.stringify(data)}.`);
+ });
+ }
+ // Subscribe to connection status changes of audio devices.
+ async onDeviceChange() {
+ await loadAudioRoutingManager();
+ await audioRoutingManager.on('deviceChange', audio.DeviceFlag.ALL_DEVICES_FLAG, (deviceChanged) => {
+ console.info('on device change type : ' + deviceChanged.type);
+ console.info('on device descriptor size : ' + deviceChanged.deviceDescriptors.length);
+ console.info('on device change descriptor : ' + deviceChanged.deviceDescriptors[0].deviceRole);
+ console.info('on device change descriptor : ' + deviceChanged.deviceDescriptors[0].deviceType);
+ });
+ }
+ // Unsubscribe from the connection status changes of audio devices.
+ async offDeviceChange() {
+ await loadAudioRoutingManager();
+ await audioRoutingManager.off('deviceChange', (deviceChanged) => {
+ console.info('off device change type : ' + deviceChanged.type);
+ console.info('off device descriptor size : ' + deviceChanged.deviceDescriptors.length);
+ console.info('off device change descriptor : ' + deviceChanged.deviceDescriptors[0].deviceRole);
+ console.info('off device change descriptor : ' + deviceChanged.deviceDescriptors[0].deviceType);
+ });
+ }
+ // Complete process: Call APIs to obtain all devices and subscribe to device changes, then manually change the connection status of a device (for example, wired headset), and finally call APIs to obtain all devices and unsubscribe from the device changes.
+ async test(){
+ await getDevices();
+ await onDeviceChange()();
+ // Manually disconnect or connect devices.
+ await getDevices();
+ await offDeviceChange();
+ }
+ ```
+
+3. (Optional) Activate a communication device and obtain its activation status.
+
+ ```js
+ import audio from '@ohos.multimedia.audio';
+ // Obtain an AudioRoutingManager instance.
+ async loadAudioRoutingManager() {
+ var audioRoutingManager = await audio.getAudioManager().getRoutingManager();
+ console.info('audioRoutingManager------create-------success.');
+ }
+ // Activate a communication device.
+ async setCommunicationDevice() {
+ await loadAudioRoutingManager();
+ await audioRoutingManager.setCommunicationDevice(audio.CommunicationDeviceType.SPEAKER, true).then(() => {
+ console.info('setCommunicationDevice true is success.');
+ });
+ }
+ // Obtain the activation status of the communication device.
+ async isCommunicationDeviceActive() {
+ await loadAudioRoutingManager();
+ await audioRoutingManager.isCommunicationDeviceActive(audio.CommunicationDeviceType.SPEAKER).then((value) => {
+ console.info(`CommunicationDevice state is: ${value}.`);
+ });
+ }
+ // Complete process: Activate a device and obtain the activation status.
+ async test(){
+ await setCommunicationDevice();
+ await isCommunicationDeviceActive();
+ }
+ ```
diff --git a/en/application-dev/media/audio-volume-manager.md b/en/application-dev/media/audio-volume-manager.md
new file mode 100644
index 0000000000000000000000000000000000000000..2063e831f886ae3e6e1fe0a5bd428da194d00227
--- /dev/null
+++ b/en/application-dev/media/audio-volume-manager.md
@@ -0,0 +1,126 @@
+# Volume Management Development
+
+## Overview
+
+The **AudioVolumeManager** module provides APIs for volume management. You can use the APIs to obtain the volume of a stream, listen for ringer mode changes, and mute a microphone.
+
+## Working Principles
+
+The figure below shows the common APIs provided by the **AudioVolumeManager** module.
+
+**Figure 1** Common APIs of AudioVolumeManager
+
+
+
+**AudioVolumeManager** provides the APIs for subscribing to system volume changes and obtaining the audio volume group manager (an **AudioVolumeGroupManager** instance). Before calling any API in **AudioVolumeGroupManager**, you must call **getVolumeGroupManager** to obtain an **AudioVolumeGroupManager** instance. You can use the APIs provided by **AudioVolumeGroupManager** to obtain the volume of a stream, mute a microphone, and listen for microphone state changes. For details, see [Audio Management](../reference/apis/js-apis-audio.md).
+
+## Constraints
+
+Before developing a microphone management application, configure the permission **ohos.permission.MICROPHONE** for the application. To set the microphone state, configure the permission **ohos.permission.MANAGE_AUDIO_CONFIG** (a system permission). For details about the permission configuration, see [Permission Application Guide](../security/accesstoken-guidelines.md).
+
+## How to Develop
+
+For details about the APIs, see [AudioVolumeManager in Audio Management](../reference/apis/js-apis-audio.md#audiovolumemanager9)
+
+1. Obtain an **AudioVolumeGroupManager** instance.
+
+ Before using an API in **AudioVolumeGroupManager**, you must use **getVolumeGroupManager()** to obtain an **AudioStreamManager** instance.
+
+ ```js
+ import audio from '@ohos.multimedia.audio';
+ async loadVolumeGroupManager() {
+ const groupid = audio.DEFAULT_VOLUME_GROUP_ID;
+ var audioVolumeGroupManager = await audio.getAudioManager().getVolumeManager().getVolumeGroupManager(groupid);
+ console.error('audioVolumeGroupManager create success.');
+ }
+
+ ```
+
+2. (Optional) Obtain the volume information and ringer mode.
+
+ To obtain the volume information (such as the ringtone, voice call, media, and voice assistant) of an audio stream or obtain the ringer mode (silent, vibration, or normal) of the current device, refer to the code below. For more details, see [Audio Management](../reference/apis/js-apis-audio.md).
+
+ ```js
+ import audio from '@ohos.multimedia.audio';
+ async loadVolumeGroupManager() {
+ const groupid = audio.DEFAULT_VOLUME_GROUP_ID;
+ var audioVolumeGroupManager = await audio.getAudioManager().getVolumeManager().getVolumeGroupManager(groupid);
+ console.info('audioVolumeGroupManager create success.');
+ }
+
+ // Obtain the volume of a stream. The value ranges from 0 to 15.
+ async getVolume() {
+ await loadVolumeGroupManager();
+ await audioVolumeGroupManager.getVolume(audio.AudioVolumeType.MEDIA).then((value) => {
+ console.info(`getVolume success and volume is: ${value}.`);
+ });
+ }
+ // Obtain the minimum volume of a stream.
+ async getMinVolume() {
+ await loadVolumeGroupManager();
+ await audioVolumeGroupManager.getMinVolume(audio.AudioVolumeType.MEDIA).then((value) => {
+ console.info(`getMinVolume success and volume is: ${value}.`);
+ });
+ }
+ // Obtain the maximum volume of a stream.
+ async getMaxVolume() {
+ await loadVolumeGroupManager();
+ await audioVolumeGroupManager.getMaxVolume(audio.AudioVolumeType.MEDIA).then((value) => {
+ console.info(`getMaxVolume success and volume is: ${value}.`);
+ });
+ }
+ // Obtain the ringer mode in use: silent (0) | vibrate (1) | normal (2).
+ async getRingerMode() {
+ await loadVolumeGroupManager();
+ await audioVolumeGroupManager.getRingerMode().then((value) => {
+ console.info(`getRingerMode success and RingerMode is: ${value}.`);
+ });
+ }
+ ```
+
+3. (Optional) Obtain and set the microphone state, and subscribe to microphone state changes.
+
+ To obtain and set the microphone state or subscribe to microphone state changes, refer to the following code:
+
+ ```js
+ import audio from '@ohos.multimedia.audio';
+ async loadVolumeGroupManager() {
+ const groupid = audio.DEFAULT_VOLUME_GROUP_ID;
+ var audioVolumeGroupManager = await audio.getAudioManager().getVolumeManager().getVolumeGroupManager(groupid);
+ console.info('audioVolumeGroupManager create success.');
+ }
+
+ async on() { // Subscribe to microphone state changes.
+ await loadVolumeGroupManager();
+ await audioVolumeGroupManager.audioVolumeGroupManager.on('micStateChange', (micStateChange) => {
+ console.info(`Current microphone status is: ${micStateChange.mute} `);
+ });
+ }
+
+ async isMicrophoneMute() { // Check whether the microphone is muted.
+ await audioVolumeGroupManager.audioVolumeGroupManager.isMicrophoneMute().then((value) => {
+ console.info(`isMicrophoneMute is: ${value}.`);
+ });
+ }
+
+ async setMicrophoneMuteTrue() { // Mute the microphone.
+ await loadVolumeGroupManager();
+ await audioVolumeGroupManager.audioVolumeGroupManager.setMicrophoneMute(true).then(() => {
+ console.info('setMicrophoneMute to mute.');
+ });
+ }
+
+ async setMicrophoneMuteFalse() { // Unmute the microphone.
+ await loadVolumeGroupManager();
+ await audioVolumeGroupManager.audioVolumeGroupManager.setMicrophoneMute(false).then(() => {
+ console.info('setMicrophoneMute to not mute.');
+ });
+ }
+ async test(){ // Complete process: Subscribe to microphone state changes, obtain the microphone state, mute the microphone, obtain the microphone state, and unmute the microphone.
+ await on();
+ await isMicrophoneMute();
+ await setMicrophoneMuteTrue();
+ await isMicrophoneMute();
+ await setMicrophoneMuteFalse();
+ }
+ ```
diff --git a/en/application-dev/media/avsession-guidelines.md b/en/application-dev/media/avsession-guidelines.md
new file mode 100644
index 0000000000000000000000000000000000000000..6106509fbfe30a7b437ec574843f50cd7bf1aceb
--- /dev/null
+++ b/en/application-dev/media/avsession-guidelines.md
@@ -0,0 +1,629 @@
+# AVSession Development
+
+## Development for the Session Access End
+
+### Basic Concepts
+- **AVMetadata**: media data related attributes, including the IDs of the current media asset, previous media asset, and next media asset, title, author, album, writer, and duration.
+- **AVSessionDescriptor**: descriptor about a media session, including the session ID, session type (audio/video), custom session name (**sessionTag**), and information about the corresponding application (**elementName**).
+- **AVPlaybackState**: information related to the media playback state, including the playback state, position, speed, buffered time, loop mode, and whether the media asset is favorited (**isFavorite**).
+
+### Available APIs
+The table below lists the APIs available for the development of the session access end. The APIs use either a callback or promise to return the result. The APIs listed below use a callback, which provide the same functions as their counterparts that use a promise. For details, see [AVSession Management](../reference/apis/js-apis-avsession.md).
+
+Table 1 Common APIs for session access end development
+
+| API | Description |
+|----------------------------------------------------------------------------------|-------------|
+| createAVSession(context: Context, tag: string, type: AVSessionType, callback: AsyncCallback\): void | Creates a session.|
+| setAVMetadata(data: AVMetadata, callback: AsyncCallback\): void | Sets session metadata. |
+| setAVPlaybackState(state: AVPlaybackState, callback: AsyncCallback\): void | Sets the playback state information. |
+| setLaunchAbility(ability: WantAgent, callback: AsyncCallback\): void | Sets the launcher ability.|
+| getController(callback: AsyncCallback\): void | Obtains the controller of this session.|
+| getOutputDevice(callback: AsyncCallback\): void | Obtains the output device information. |
+| activate(callback: AsyncCallback\): void | Activates this session. |
+| destroy(callback: AsyncCallback\): void | Destroys this session. |
+
+### How to Develop
+1. Import the modules.
+
+```js
+import avSession from '@ohos.multimedia.avsession';
+import wantAgent from '@ohos.wantAgent';
+import featureAbility from '@ohos.ability.featureAbility';
+```
+
+2. Create and activate a session.
+```js
+// Define global variables.
+let mediaFavorite = false;
+let currentSession = null;
+let context = featureAbility.getContext();
+
+// Create an audio session.
+avSession.createAVSession(context, "AudioAppSample", 'audio').then((session) => {
+ currentSession = session;
+ currentSession.activate(); // Activate the session.
+}).catch((err) => {
+ console.info(`createAVSession : ERROR : ${err.message}`);
+});
+```
+
+3. Set the session information, including:
+- Session metadata. In addition to the current media asset ID (mandatory), you can set the title, album, author, duration, and previous/next media asset ID. For details about the session metadata, see **AVMetadata** in the API document.
+- Launcher ability, which is implemented by calling an API of **WantAgent**. Generally, **WantAgent** is used to encapsulate want information. For more information, see [wantAgent](../reference/apis/js-apis-wantAgent.md).
+- Playback state information.
+```js
+// Set the session metadata.
+let metadata = {
+ assetId: "121278",
+ title: "lose yourself",
+ artist: "Eminem",
+ author: "ST",
+ album: "Slim shady",
+ writer: "ST",
+ composer: "ST",
+ duration: 2222,
+ mediaImage: "https://www.example.com/example.jpg", // Set it based on your project requirements.
+ subtitle: "8 Mile",
+ description: "Rap",
+ lyric: "https://www.example.com/example.lrc", // Set it based on your project requirements.
+ previousAssetId: "121277",
+ nextAssetId: "121279",
+};
+currentSession.setAVMetadata(metadata).then(() => {
+ console.info('setAVMetadata successfully');
+}).catch((err) => {
+ console.info(`setAVMetadata : ERROR : ${err.message}`);
+});
+```
+
+```js
+// Set the launcher ability.
+let wantAgentInfo = {
+ wants: [
+ {
+ bundleName: "com.neu.setResultOnAbilityResultTest1",
+ abilityName: "com.example.test.MainAbility",
+ }
+ ],
+ operationType: wantAgent.OperationType.START_ABILITIES,
+ requestCode: 0,
+ wantAgentFlags:[wantAgent.WantAgentFlags.UPDATE_PRESENT_FLAG]
+}
+
+wantAgent.getWantAgent(wantAgentInfo).then((agent) => {
+ currentSession.setLaunchAbility(agent).then(() => {
+ console.info('setLaunchAbility successfully');
+ }).catch((err) => {
+ console.info(`setLaunchAbility : ERROR : ${err.message}`);
+ });
+});
+```
+
+```js
+// Set the playback state information.
+let PlaybackState = {
+ state: avSession.PlaybackState.PLAYBACK_STATE_STOP,
+ speed: 1.0,
+ position:{elapsedTime: 0, updateTime: (new Date()).getTime()},
+ bufferedTime: 1000,
+ loopMode: avSession.LoopMode.LOOP_MODE_SEQUENCE,
+ isFavorite: false,
+};
+currentSession.setAVPlaybackState(PlaybackState).then(() => {
+ console.info('setAVPlaybackState successfully');
+}).catch((err) => {
+ console.info(`setAVPlaybackState : ERROR : ${err.message}`);
+});
+```
+
+```js
+// Obtain the controller of this session.
+currentSession.getController().then((selfController) => {
+ console.info('getController successfully');
+}).catch((err) => {
+ console.info(`getController : ERROR : ${err.message}`);
+});
+```
+
+```js
+// Obtain the output device information.
+currentSession.getOutputDevice().then((outputInfo) => {
+ console.info(`getOutputDevice successfully, deviceName : ${outputInfo.deviceName}`);
+}).catch((err) => {
+ console.info(`getOutputDevice : ERROR : ${err.message}`);
+});
+```
+
+4. Subscribe to control command events.
+```js
+// Subscribe to the 'play' command event.
+currentSession.on('play', () => {
+ console.log ("Call AudioPlayer.play.");
+ // Set the playback state information.
+ currentSession.setAVPlaybackState({state: avSession.PlaybackState.PLAYBACK_STATE_PLAY}).then(() => {
+ console.info('setAVPlaybackState successfully');
+ }).catch((err) => {
+ console.info(`setAVPlaybackState : ERROR : ${err.message}`);
+ });
+});
+
+
+// Subscribe to the 'pause' command event.
+currentSession.on('pause', () => {
+ console.log ("Call AudioPlayer.pause.");
+ // Set the playback state information.
+ currentSession.setAVPlaybackState({state: avSession.PlaybackState.PLAYBACK_STATE_PAUSE}).then(() => {
+ console.info('setAVPlaybackState successfully');
+ }).catch((err) => {
+ console.info(`setAVPlaybackState : ERROR : ${err.message}`);
+ });
+});
+
+// Subscribe to the 'stop' command event.
+currentSession.on('stop', () => {
+ console.log ("Call AudioPlayer.stop.");
+ // Set the playback state information.
+ currentSession.setAVPlaybackState({state: avSession.PlaybackState.PLAYBACK_STATE_STOP}).then(() => {
+ console.info('setAVPlaybackState successfully');
+ }).catch((err) => {
+ console.info(`setAVPlaybackState : ERROR : ${err.message}`);
+ });
+});
+
+// Subscribe to the 'playNext' command event.
+currentSession.on('playNext', () => {
+ // When the media file is not ready, download and cache the media file, and set the 'PREPARE' state.
+ currentSession.setAVPlaybackState({state: avSession.PlaybackState.PLAYBACK_STATE_PREPARE}).then(() => {
+ console.info('setAVPlaybackState successfully');
+ }).catch((err) => {
+ console.info(`setAVPlaybackState : ERROR : ${err.message}`);
+ });
+ // The media file is obtained.
+ currentSession.setAVMetadata({assetId: '58970105', title: 'See you tomorrow'}).then(() => {
+ console.info('setAVMetadata successfully');
+ }).catch((err) => {
+ console.info(`setAVMetadata : ERROR : ${err.message}`);
+ });
+ console.log ("Call AudioPlayer.play.");
+ // Set the playback state information.
+ let time = (new Data()).getTime();
+ currentSession.setAVPlaybackState({state: avSession.PlaybackState.PLAYBACK_STATE_PLAY, position: {elapsedTime: 0, updateTime: time}, bufferedTime:2000}).then(() => {
+ console.info('setAVPlaybackState successfully');
+ }).catch((err) => {
+ console.info(`setAVPlaybackState : ERROR : ${err.message}`);
+ });
+});
+
+// Subscribe to the 'fastForward' command event.
+currentSession.on('fastForward', () => {
+ console.log("Call AudioPlayer for fast forwarding.");
+ // Set the playback state information.
+ currentSession.setAVPlaybackState({speed: 2.0}).then(() => {
+ console.info('setAVPlaybackState successfully');
+ }).catch((err) => {
+ console.info(`setAVPlaybackState : ERROR : ${err.message}`);
+ });
+});
+
+// Subscribe to the 'seek' command event.
+currentSession.on('seek', (time) => {
+ console.log("Call AudioPlayer.seek.");
+ // Set the playback state information.
+ currentSession.setAVPlaybackState({position: {elapsedTime: time, updateTime: (new Data()).getTime()}}).then(() => {
+ console.info('setAVPlaybackState successfully');
+ }).catch((err) => {
+ console.info(`setAVPlaybackState : ERROR : ${err.message}`);
+ });
+});
+
+// Subscribe to the 'setSpeed' command event.
+currentSession.on('setSpeed', (speed) => {
+ console.log(`Call AudioPlayer to set the speed to ${speed}`);
+ // Set the playback state information.
+ currentSession.setAVPlaybackState({speed: speed}).then(() => {
+ console.info('setAVPlaybackState successfully');
+ }).catch((err) => {
+ console.info(`setAVPlaybackState : ERROR : ${err.message}`);
+ });
+});
+
+// Subscribe to the 'setLoopMode' command event.
+currentSession.on('setLoopMode', (mode) => {
+ console.log(`The application switches to the loop mode ${mode}`);
+ // Set the playback state information.
+ currentSession.setAVPlaybackState({loopMode: mode}).then(() => {
+ console.info('setAVPlaybackState successfully');
+ }).catch((err) => {
+ console.info(`setAVPlaybackState : ERROR : ${err.message}`);
+ });
+});
+
+// Subscribe to the 'toggleFavorite' command event.
+currentSession.on('toggleFavorite', (assetId) => {
+ console.log(`The application favorites ${assetId}.`);
+ // Perform the switch based on the last status.
+ let favorite = mediaFavorite == false ? true : false;
+ currentSession.setAVPlaybackState({isFavorite: favorite}).then(() => {
+ console.info('setAVPlaybackState successfully');
+ }).catch((err) => {
+ console.info(`setAVPlaybackState : ERROR : ${err.message}`);
+ });
+ mediaFavorite = favorite;
+});
+
+// Subscribe to the key event.
+currentSession.on('handleKeyEvent', (event) => {
+ console.log(`User presses the key ${event.keyCode}`);
+});
+
+// Subscribe to output device changes.
+currentSession.on('outputDeviceChange', (device) => {
+ console.log(`Output device changed to ${device.deviceName}`);
+});
+```
+
+5. Release resources.
+```js
+// Unsubscribe from the events.
+currentSession.off('play');
+currentSession.off('pause');
+currentSession.off('stop');
+currentSession.off('playNext');
+currentSession.off('playPrevious');
+currentSession.off('fastForward');
+currentSession.off('rewind');
+currentSession.off('seek');
+currentSession.off('setSpeed');
+currentSession.off('setLoopMode');
+currentSession.off('toggleFavorite');
+currentSession.off('handleKeyEvent');
+currentSession.off('outputDeviceChange');
+
+// Deactivate the session and destroy the object.
+currentSession.deactivate().then(() => {
+ currentSession.destory();
+});
+```
+
+### Verification
+Touch the play, pause, or next button on the media application. Check whether the media playback state changes accordingly.
+
+### FAQs
+
+1. Session Service Exception
+- Symptoms
+
+ The session service is abnormal, and the application cannot obtain a response from the session service. For example, the session service is not running or the communication with the session service fails. The error message "Session service exception" is displayed.
+
+- Possible causes
+
+ The session service is killed during session restart.
+
+- Solution
+
+ (1) The system retries the operation automatically. If the error persists for 3 seconds or more, stop the operation on the session or controller.
+
+ (2) Destroy the current session or session controller and re-create it. If the re-creation fails, stop the operation on the session.
+
+2. Session Does Not Exist
+- Symptoms
+
+ Parameters are set for or commands are sent to the session that does not exist. The error message "The session does not exist" is displayed.
+
+- Possible causes
+
+ The session has been destroyed, and no session record exists on the server.
+
+- Solution
+
+ (1) If the error occurs on the application, re-create the session. If the error occurs on Media Controller, stop sending query or control commands to the session.
+
+ (2) If the error occurs on the session service, query the current session record and pass the correct session ID when creating the controller.
+
+3. Session Not Activated
+- Symptoms
+
+ A control command or event is sent to the session when it is not activated. The error message "The session not active" is displayed.
+
+- Possible causes
+
+ The session is in the inactive state.
+
+- Solution
+
+ Stop sending the command or event. Subscribe to the session activation status, and resume the sending when the session is activated.
+
+## Development for the Session Control End (Media Controller)
+
+### Basic Concepts
+- Remote projection: A local media session is projected to a remote device. The local controller sends commands to control media playback on the remote device.
+- Sending key events: The controller controls media playback by sending key events.
+- Sending control commands: The controller controls media playback by sending control commands.
+- Sending system key events: A system application calls APIs to send system key events to control media playback.
+- Sending system control commands: A system application calls APIs to send system control commands to control media playback.
+
+### Available APIs
+
+The table below lists the APIs available for the development of the session control end. The APIs use either a callback or promise to return the result. The APIs listed below use a callback, which provide the same functions as their counterparts that use a promise. For details, see [AVSession Management](../reference/apis/js-apis-avsession.md).
+
+Table 2 Common APIs for session control end development
+
+| API | Description |
+| ------------------------------------------------------------------------------------------------ | ----------------- |
+| getAllSessionDescriptors(callback: AsyncCallback\>>): void | Obtains the descriptors of all sessions. |
+| createController(sessionId: string, callback: AsyncCallback\): void | Creates a controller. |
+| sendAVKeyEvent(event: KeyEvent, callback: AsyncCallback\): void | Sends a key event. |
+| getLaunchAbility(callback: AsyncCallback\): void | Obtains the launcher ability. |
+| sendControlCommand(command: AVControlCommand, callback: AsyncCallback\): void | Sends a control command. |
+| sendSystemAVKeyEvent(event: KeyEvent, callback: AsyncCallback\): void | Send a system key event. |
+| sendSystemControlCommand(command: AVControlCommand, callback: AsyncCallback\): void | Sends a system control command. |
+| castAudio(session: SessionToken \| 'all', audioDevices: Array\, callback: AsyncCallback\): void | Casts the media session to a remote device.|
+
+### How to Develop
+1. Import the modules.
+```js
+import avSession from '@ohos.multimedia.avsession';
+import {Action, KeyEvent} from '@ohos.multimodalInput.KeyEvent';
+import wantAgent from '@ohos.wantAgent';
+import audio from '@ohos.multimedia.audio';
+```
+
+2. Obtain the session descriptors and create a controller.
+```js
+// Define global variables.
+let g_controller = new Array();
+let g_centerSupportCmd:Set = new Set(['play', 'pause', 'playNext', 'playPrevious', 'fastForward', 'rewind', 'seek','setSpeed', 'setLoopMode', 'toggleFavorite']);
+let g_validCmd:Set;
+
+// Obtain the session descriptors and create a controller.
+avSession.getAllSessionDescriptors().then((descriptors) => {
+ descriptors.forEach((descriptor) => {
+ avSession.createController(descriptor.sessionId).then((controller) => {
+ g_controller.push(controller);
+ }).catch((err) => {
+ console.error('createController error');
+ });
+ });
+}).catch((err) => {
+ console.error('getAllSessionDescriptors error');
+});
+
+// Subscribe to the 'sessionCreate' event and create a controller.
+avSession.on('sessionCreate', (session) => {
+ // After a session is added, you must create a controller.
+ avSession.createController(session.sessionId).then((controller) => {
+ g_controller.push(controller);
+ }).catch((err) => {
+ console.info(`createController : ERROR : ${err.message}`);
+ });
+});
+```
+
+3. Subscribe to the session state and service changes.
+```js
+// Subscribe to the 'activeStateChange' event.
+controller.on('activeStateChange', (isActive) => {
+ if (isActive) {
+ console.log ("The widget corresponding to the controller is highlighted.");
+ } else {
+ console.log("The widget corresponding to the controller is invalid.");
+ }
+});
+
+// Subscribe to the 'sessionDestroy' event to enable Media Controller to get notified when the session dies.
+controller.on('sessionDestroy', () => {
+ console.info('on sessionDestroy : SUCCESS ');
+ controller.destroy().then(() => {
+ console.info('destroy : SUCCESS ');
+ }).catch((err) => {
+ console.info(`destroy : ERROR :${err.message}`);
+ });
+});
+
+// Subscribe to the 'sessionDestroy' event to enable the application to get notified when the session dies.
+avSession.on('sessionDestroy', (session) => {
+ let index = g_controller.findIndex((controller) => {
+ return controller.sessionId == session.sessionId;
+ });
+ if (index != 0) {
+ g_controller[index].destroy();
+ g_controller.splice(index, 1);
+ }
+});
+
+// Subscribe to the 'topSessionChange' event.
+avSession.on('topSessionChange', (session) => {
+ let index = g_controller.findIndex((controller) => {
+ return controller.sessionId == session.sessionId;
+ });
+ // Place the session on the top.
+ if (index != 0) {
+ g_controller.sort((a, b) => {
+ return a.sessionId == session.sessionId ? -1 : 0;
+ });
+ }
+});
+
+// Subscribe to the 'sessionServiceDie' event.
+avSession.on('sessionServiceDie', () => {
+ // The server is abnormal, and the application clears resources.
+ console.log("Server exception");
+})
+```
+
+4. Subscribe to media session information changes.
+```js
+// Subscribe to metadata changes.
+let metaFilter = ['assetId', 'title', 'description'];
+controller.on('metadataChange', metaFilter, (metadata) => {
+ console.info(`on metadataChange assetId : ${metadata.assetId}`);
+});
+
+// Subscribe to playback state changes.
+let playbackFilter = ['state', 'speed', 'loopMode'];
+controller.on('playbackStateChange', playbackFilter, (playbackState) => {
+ console.info(`on playbackStateChange state : ${playbackState.state}`);
+});
+
+// Subscribe to supported command changes.
+controller.on('validCommandChange', (cmds) => {
+ console.info(`validCommandChange : SUCCESS : size : ${cmds.size}`);
+ console.info(`validCommandChange : SUCCESS : cmds : ${cmds.values()}`);
+ g_validCmd.clear();
+ for (let c of g_centerSupportCmd) {
+ if (cmds.has(c)) {
+ g_validCmd.add(c);
+ }
+ }
+});
+
+// Subscribe to output device changes.
+controller.on('outputDeviceChange', (device) => {
+ console.info(`on outputDeviceChange device isRemote : ${device.isRemote}`);
+});
+```
+
+5. Control the session behavior.
+```js
+// When the user touches the play button, the control command 'play' is sent to the session.
+if (g_validCmd.has('play')) {
+ controller.sendControlCommand({command:'play'}).then(() => {
+ console.info('sendControlCommand successfully');
+ }).catch((err) => {
+ console.info(`sendControlCommand : ERROR : ${err.message}`);
+ });
+}
+
+// When the user selects the single loop mode, the corresponding control command is sent to the session.
+if (g_validCmd.has('setLoopMode')) {
+ controller.sendControlCommand({command: 'setLoopMode', parameter: avSession.LoopMode.LOOP_MODE_SINGLE}).then(() => {
+ console.info('sendControlCommand successfully');
+ }).catch((err) => {
+ console.info(`sendControlCommand : ERROR : ${err.message}`);
+ });
+}
+
+// Send a key event.
+let keyItem = {code: 0x49, pressedTime: 123456789, deviceId: 0};
+let event = {action: 2, key: keyItem, keys: [keyItem]};
+controller.sendAVKeyEvent(event).then(() => {
+ console.info('sendAVKeyEvent Successfully');
+}).catch((err) => {
+ console.info(`sendAVKeyEvent : ERROR : ${err.message}`);
+});
+
+// The user touches the blank area on the widget to start the application.
+controller.getLaunchAbility().then((want) => {
+ console.log("Starting the application in the foreground");
+}).catch((err) => {
+ console.info(`getLaunchAbility : ERROR : ${err.message}`);
+});
+
+// Send the system key event.
+let keyItem = {code: 0x49, pressedTime: 123456789, deviceId: 0};
+let event = {action: 2, key: keyItem, keys: [keyItem]};
+avSession.sendSystemAVKeyEvent(event).then(() => {
+ console.info('sendSystemAVKeyEvent Successfully');
+}).catch((err) => {
+ console.info(`sendSystemAVKeyEvent : ERROR : ${err.message}`);
+});
+
+// Send a system control command to the top session.
+let avcommand = {command: 'toggleFavorite', parameter: "false"};
+avSession.sendSystemControlCommand(avcommand).then(() => {
+ console.info('sendSystemControlCommand successfully');
+}).catch((err) => {
+ console.info(`sendSystemControlCommand : ERROR : ${err.message}`);
+});
+
+// Cast the session to another device.
+let audioManager = audio.getAudioManager();
+let audioDevices;
+await audioManager.getDevices(audio.DeviceFlag.OUTPUT_DEVICES_FLAG).then((data) => {
+ audioDevices = data;
+ console.info('Promise returned to indicate that the device list is obtained.');
+}).catch((err) => {
+ console.info(`getDevices : ERROR : ${err.message}`);
+});
+
+avSession.castAudio('all', audioDevices).then(() => {
+ console.info('createController : SUCCESS');
+}).catch((err) => {
+ console.info(`createController : ERROR : ${err.message}`);
+});
+```
+
+6. Release resources.
+```js
+// Unsubscribe from the events.
+ controller.off('metadataChange');
+ controller.off('playbackStateChange');
+ controller.off('sessionDestroy');
+ controller.off('activeStateChange');
+ controller.off('validCommandChange');
+ controller.off('outputDeviceChange');
+
+ // Destroy the controller.
+ controller.destroy().then(() => {
+ console.info('destroy : SUCCESS ');
+ }).catch((err) => {
+ console.info(`destroy : ERROR : ${err.message}`);
+ });
+```
+
+### Verification
+When you touch the play, pause, or next button in Media Controller, the playback state of the application changes accordingly.
+
+### FAQs
+1. Controller Does Not Exist
+- Symptoms
+
+ A control command or an event is sent to the controller that does not exist. The error message "The session controller does not exist" is displayed.
+
+- Possible causes
+
+ The controller has been destroyed.
+
+- Solution
+
+ Query the session record and create the corresponding controller.
+
+2. Remote Session Connection Failure
+- Symptoms
+
+ The communication between the local session and the remote session fails. The error information "The remote session connection failed" is displayed.
+
+- Possible causes
+
+ The communication between devices is interrupted.
+
+- Solution
+
+ Stop sending control commands to the session. Subscribe to output device changes, and resume the sending when the output device is changed.
+
+3. Invalid Session Command
+- Symptoms
+
+ The control command or event sent to the session is not supported. The error message "Invalid session command" is displayed.
+
+- Possible causes
+
+ The session does not support this command.
+
+- Solution
+
+ Stop sending the command or event. Query the commands supported by the session, and send a command supported.
+
+4. Too Many Commands or Events
+- Symptoms
+
+ The session client sends too many messages or commands to the server in a period of time, causing the server to be overloaded. The error message "Command or event overload" is displayed.
+
+- Possible causes
+
+ The server is overloaded with messages or events.
+
+- Solution
+
+ Control the frequency of sending commands or events.
diff --git a/en/application-dev/media/avsession-overview.md b/en/application-dev/media/avsession-overview.md
new file mode 100644
index 0000000000000000000000000000000000000000..761483bf5052ef48cd9313261ead681b295d6604
--- /dev/null
+++ b/en/application-dev/media/avsession-overview.md
@@ -0,0 +1,52 @@
+# AVSession Overview
+
+## Overview
+
+ AVSession, short for audio and video session, is also known as media session.
+ - Application developers can use the APIs provided by the **AVSession** module to connect their audio and video applications to the system's Media Controller.
+ - System developers can use the APIs provided by the **AVSession** module to display media information of system audio and video applications and carry out unified playback control.
+
+ You can implement the following features through the **AVSession** module:
+
+ 1. Unified playback control entry
+
+ If there are multiple audio and video applications on the device, users need to switch to and access different applications to control media playback. With AVSession, a unified playback control entry of the system (such as Media Controller) is used for playback control of these audio and video applications. No more switching is required.
+
+ 2. Better background application management
+
+ When an application running in the background automatically starts audio playback, it is difficult for users to locate the application. With AVSession, users can quickly find the application that plays the audio clip in Media Controller.
+
+## Basic Concepts
+
+- AVSession
+
+ A channel used for information exchange between applications and Media Controller. For AVSession, one end is the media application under control, and the other end is Media Controller. Through AVSession, an application can transfer the media playback information to Media Controller and receive control commands from Media Controller.
+
+- AVSessionController
+
+ Object that controls media sessions and thereby controls the playback behavior of applications. Through AVSessionController, Media Controller can control the playback behavior of applications, obtain playback information, and send control commands. It can also monitor the playback state of applications to ensure synchronization of the media session information.
+
+- Media Controller
+
+ Holder of AVSessionController. Through AVSessionController, Media Controller sends commands to control media playback of applications.
+
+## Implementation Principle
+
+The **AVSession** module provides two classes: **AVSession** and **AVSessionController**.
+
+**Figure 1** AVSession interaction
+
+
+
+- Interaction between the application and Media Controller: First, an audio application creates an **AVSession** object and sets session information, including media metadata, launcher ability, and playback state information. Then, Media Controller creates an **AVSessionController** object to obtain session-related information and send the 'play' command to the audio application. Finally, the audio application responds to the command and updates the playback state.
+
+- Distributed projection: When a connected device creates a local session, Media Controller or the audio application can select another device to be projected based on the device list, synchronize the local session to the remote device, and generate a controllable remote session. The remote session is controlled by sending control commands to the remote device's application through its AVSessionController.
+
+## Constraints
+
+- The playback information displayed in Media Controller is the media information proactively written by the media application to AVSession.
+- Media Controller controls the playback of a media application based on the responses of the media application to control commands.
+- AVSession can transmit media playback information and control commands. It does not display information or execute control commands.
+- Do not develop Media Controller for common applications. For common audio and video applications running on OpenHarmony, the default control end is Media Controller, which is a system application. You do not need to carry out additional development for Media Controller.
+- If you want to develop your own system running OpenHarmony, you can develop your own Media Controller.
+- For better background management of audio and video applications, the **AVSession** module enforces background control for third-party applications. Only third-party applications that have accessed AVSession can play audio in the background. Otherwise, the system forcibly pauses the playback when a third-party application switches to the background.
diff --git a/en/application-dev/media/figures/en-us_image_audio_routing_manager.png b/en/application-dev/media/figures/en-us_image_audio_routing_manager.png
new file mode 100644
index 0000000000000000000000000000000000000000..710679f6cac0c30d06dffa97b0e80b3cebe80f79
Binary files /dev/null and b/en/application-dev/media/figures/en-us_image_audio_routing_manager.png differ
diff --git a/en/application-dev/media/figures/en-us_image_audio_state_machine.png b/en/application-dev/media/figures/en-us_image_audio_state_machine.png
index 7497edd0edbdcfccbc448e9f2f48268ebb75e72e..22b7aeaa1db5b369d3daf44854d7f7f9a00f775b 100644
Binary files a/en/application-dev/media/figures/en-us_image_audio_state_machine.png and b/en/application-dev/media/figures/en-us_image_audio_state_machine.png differ
diff --git a/en/application-dev/media/figures/en-us_image_audio_volume_manager.png b/en/application-dev/media/figures/en-us_image_audio_volume_manager.png
new file mode 100644
index 0000000000000000000000000000000000000000..0d47fbfacce9c1ff48811e1cf5d764231bdb596b
Binary files /dev/null and b/en/application-dev/media/figures/en-us_image_audio_volume_manager.png differ
diff --git a/en/application-dev/media/figures/en-us_image_avsession.png b/en/application-dev/media/figures/en-us_image_avsession.png
new file mode 100644
index 0000000000000000000000000000000000000000..3289bc4ca3c54eb3e99c9230c821380f8f7c0c5b
Binary files /dev/null and b/en/application-dev/media/figures/en-us_image_avsession.png differ
diff --git a/en/application-dev/media/image.md b/en/application-dev/media/image.md
index f3bb5fc9b59c8b290692e877033e78a5d9d4edef..048716dfdcd76d0e35f4ed3ad70a5eeb266ac8cc 100644
--- a/en/application-dev/media/image.md
+++ b/en/application-dev/media/image.md
@@ -21,23 +21,27 @@ let opts = { alphaType: 0, editable: true, pixelFormat: 4, scaleMode: 1, size: {
// Create a PixelMap object.
const color = new ArrayBuffer(96);
let opts = { alphaType: 0, editable: true, pixelFormat: 4, scaleMode: 1, size: { height: 2, width: 3 } }
-image.createPixelMap(color, opts, pixelmap => {
+image.createPixelMap(color, opts, (err, pixelmap) => {
console.log('Succeeded in creating pixelmap.');
})
// Read pixels.
-pixelmap.readPixels(area,(data) => {
- if(data !== null) {
- var bufferArr = new Uint8Array(area.pixels);
- var res = true;
- for (var i = 0; i < bufferArr.length; i++) {
- console.info(' buffer ' + bufferArr[i]);
- if(res) {
- if(bufferArr[i] == 0) {
- res = false;
- console.log('readPixels end.');
- break;
- }
+const area = {
+ pixels: new ArrayBuffer(8),
+ offset: 0,
+ stride: 8,
+ region: { size: { height: 1, width: 2 }, x: 0, y: 0 }
+}
+pixelmap.readPixels(area,() => {
+ var bufferArr = new Uint8Array(area.pixels);
+ var res = true;
+ for (var i = 0; i < bufferArr.length; i++) {
+ console.info(' buffer ' + bufferArr[i]);
+ if(res) {
+ if(bufferArr[i] == 0) {
+ res = false;
+ console.log('readPixels end.');
+ break;
}
}
}
@@ -96,7 +100,7 @@ pixelmap.writeBufferToPixels(writeColor).then(() => {
})
// Obtain image information.
-pixelmap.getImageInfo( imageInfo => {
+pixelmap.getImageInfo((error, imageInfo) => {
if (imageInfo !== null) {
console.log('Succeeded in getting imageInfo');
}
@@ -128,7 +132,7 @@ imageSourceApi.release(() => {
const imagePackerApi = image.createImagePacker();
const imageSourceApi = image.createImageSource(0);
let packOpts = { format:"image/jpeg", quality:98 };
-imagePackerApi.packing(imageSourceApi, packOpts, data => {
+imagePackerApi.packing(imageSourceApi, packOpts, (err, data) => {
console.log('Succeeded in packing');
})
@@ -156,7 +160,7 @@ let decodingOptions = {
};
// Create a pixel map in callback mode.
-imageSourceApi.createPixelMap(decodingOptions, pixelmap => {
+imageSourceApi.createPixelMap(decodingOptions, (err, pixelmap) => {
console.log('Succeeded in creating pixelmap.');
})
@@ -171,17 +175,13 @@ catch(error => {
})
// Obtain the number of bytes in each line of pixels.
-pixelmap.getBytesNumberPerRow( num => {
- console.log('Succeeded in getting BytesNumber PerRow.');
-})
+var num = pixelmap.getBytesNumberPerRow();
// Obtain the total number of pixel bytes.
-pixelmap.getPixelBytesNumber(num => {
- console.log('Succeeded in getting PixelBytesNumber.');
-})
+var pixelSize = pixelmap.getPixelBytesNumber();
// Obtain the pixel map information.
-pixelmap.getImageInfo( imageInfo => {})
+pixelmap.getImageInfo().then( imageInfo => {});
// Release the PixelMap object.
pixelmap.release(()=>{
@@ -229,7 +229,7 @@ imagePackerApi.packing(imageSourceApi, packOpts)
imagePackerApi.release();
// Obtain the image source information.
-imageSourceApi.getImageInfo(imageInfo => {
+imageSourceApi.getImageInfo((err, imageInfo) => {
console.log('Succeeded in getting imageInfo');
})
@@ -249,8 +249,9 @@ public async init(surfaceId: any) {
var receiver = image.createImageReceiver(8 * 1024, 8, image.ImageFormat.JPEG, 1);
// Obtain the surface ID.
- var surfaceId = await receiver.getReceivingSurfaceId();
-
+ receiver.getReceivingSurfaceId((err, surfaceId) => {
+ console.info("receiver getReceivingSurfaceId success");
+ });
// Register a surface listener, which is triggered after the buffer of the surface is ready.
receiver.on('imageArrival', () => {
// Obtain the latest buffer of the surface.
diff --git a/en/application-dev/napi/drawing-guidelines.md b/en/application-dev/napi/drawing-guidelines.md
index 7cbf0e3d9e10bb6d8d346e8f6a9910771c523434..1355a27dcf7fb5e54a283ccd5c39a4f1b19de381 100644
--- a/en/application-dev/napi/drawing-guidelines.md
+++ b/en/application-dev/napi/drawing-guidelines.md
@@ -4,11 +4,11 @@
The Native Drawing module provides APIs for drawing 2D graphics and text. The following scenarios are common for drawing development:
* Drawing 2D graphics
-* Drawing and painting text
+* Drawing text drawing
## Available APIs
-| API| Description|
+| API| Description|
| -------- | -------- |
| OH_Drawing_BitmapCreate (void) | Creates a bitmap object.|
| OH_Drawing_BitmapBuild (OH_Drawing_Bitmap *, const uint32_t width, const uint32_t height, const OH_Drawing_BitmapFormat *) | Initializes the width and height of a bitmap object and sets the pixel format for the bitmap.|
@@ -19,7 +19,7 @@ The Native Drawing module provides APIs for drawing 2D graphics and text. The fo
| OH_Drawing_CanvasDrawPath (OH_Drawing_Canvas *, const OH_Drawing_Path *) | Draws a path.|
| OH_Drawing_PathCreate (void) | Creates a path object.|
| OH_Drawing_PathMoveTo (OH_Drawing_Path *, float x, float y) | Sets the start point of a path.|
-| OH_Drawing_PathLineTo (OH_Drawing_Path *, float x, float y) | Draws a line segment from the last point of a path to the target point. |
+| OH_Drawing_PathLineTo (OH_Drawing_Path *, float x, float y) | Draws a line segment from the last point of a path to the target point.|
| OH_Drawing_PathClose (OH_Drawing_Path *) | Closes a path. A line segment from the start point to the last point of the path is added.|
| OH_Drawing_PenCreate (void) | Creates a pen object.|
| OH_Drawing_PenSetAntiAlias (OH_Drawing_Pen *, bool) | Checks whether anti-aliasing is enabled for a pen. If anti-aliasing is enabled, edges will be drawn with partial transparency.|
@@ -138,7 +138,7 @@ The following steps describe how to use the canvas and brush of the Native Drawi
OH_Drawing_BitmapDestory(cBitmap);
```
-## Development Procedure for Text Drawing and Display
+## Development Procedure for Text Drawing
The following steps describe how to use the text drawing and display feature of the Native Drawing module.
1. **Create a canvas and a bitmap.**
@@ -196,7 +196,8 @@ The following steps describe how to use the text drawing and display feature of
// Set the maximum width.
double maxWidth = 800.0;
OH_Drawing_TypographyLayout(typography, maxWidth);
- // Set the start position for text display.
+ // Set the start position for drawing the text on the canvas.
double position[2] = {10.0, 15.0};
+ // Draw the text on the canvas.
OH_Drawing_TypographyPaint(typography, cCanvas, position[0], position[1]);
```
diff --git a/en/application-dev/napi/native-window-guidelines.md b/en/application-dev/napi/native-window-guidelines.md
index b92ccc54234c9162dad4b35242dcf9d992e5eeec..a71a261c8d2dc6cee74e79deff99d50814a00007 100644
--- a/en/application-dev/napi/native-window-guidelines.md
+++ b/en/application-dev/napi/native-window-guidelines.md
@@ -1,107 +1,99 @@
-# NativeWindow Development
+# Native Window Development
## When to Use
-`NativeWindow` is a local platform window of OpenHarmony. It provides APIs for you to create a native window from `Surface`, create a native window buffer from `SurfaceBuffer`, and request and flush a buffer.
+**NativeWindow** is a local platform-based window of OpenHarmony that represents the producer of a graphics queue. It provides APIs for you to create a native window from **Surface**, create a native window buffer from **SurfaceBuffer**, and request and flush a buffer.
The following scenarios are common for native window development:
-* Drawing content using native C++ code and displaying the content on the screen
-* Requesting and flushing a buffer when adapting to EGL `eglswapbuffer`
+* Request a graphics buffer by using the NAPI provided by **NativeWindow**, write the produced graphics content to the buffer, and flush the buffer to the graphics queue.
+* Request and flush a buffer when adapting to the **eglswapbuffer** interface at the EGL.
## Available APIs
| API| Description|
| -------- | -------- |
-| OH_NativeWindow_CreateNativeWindowFromSurface (void \*pSurface) | Creates a `NativeWindow` instance. A new `NativeWindow` instance is created each time this function is called.|
-| OH_NativeWindow_DestroyNativeWindow (struct NativeWindow \*window) | Decreases the reference count of a `NativeWindow` instance by 1 and, when the reference count reaches 0, destroys the instance.|
-| OH_NativeWindow_CreateNativeWindowBufferFromSurfaceBuffer (void \*pSurfaceBuffer) | Creates a `NativeWindowBuffer` instance. A new `NativeWindowBuffer` instance is created each time this function is called.|
-| OH_NativeWindow_DestroyNativeWindowBuffer (struct NativeWindowBuffer \*buffer) | Decreases the reference count of a `NativeWindowBuffer` instance by 1 and, when the reference count reaches 0, destroys the instance.|
-| OH_NativeWindow_NativeWindowRequestBuffer (struct NativeWindow \*window struct NativeWindowBuffer \*\*buffer, int \*fenceFd) | Requests a `NativeWindowBuffer` through a `NativeWindow` instance for content production.|
-| OH_NativeWindow_NativeWindowFlushBuffer (struct NativeWindow \*window, struct NativeWindowBuffer \*buffer, int fenceFd, Region region) | Flushes the `NativeWindowBuffer` filled with the content to the buffer queue through a `NativeWindow` instance for content consumption.|
-| OH_NativeWindow_NativeWindowCancelBuffer (struct NativeWindow \*window, struct NativeWindowBuffer \*buffer) | Returns the `NativeWindowBuffer` to the buffer queue through a `NativeWindow` instance, without filling in any content. The `NativeWindowBuffer` can be used for another request.|
-| OH_NativeWindow_NativeWindowHandleOpt (struct NativeWindow \*window, int code,...) | Sets or obtains the attributes of a native window, including the width, height, and content format.|
-| OH_NativeWindow_GetBufferHandleFromNative (struct NativeWindowBuffer \*buffer) | Obtains the pointer to a `BufferHandle` of a `NativeWindowBuffer` instance.|
+| OH_NativeWindow_CreateNativeWindowFromSurface (void \*pSurface) | Creates a **NativeWindow** instance. A new **NativeWindow** instance is created each time this function is called.|
+| OH_NativeWindow_DestroyNativeWindow (OHNativeWindow \*window) | Decreases the reference count of a **NativeWindow** instance by 1 and, when the reference count reaches 0, destroys the instance.|
+| OH_NativeWindow_CreateNativeWindowBufferFromSurfaceBuffer (void \*pSurfaceBuffer) | Creates a **NativeWindowBuffer** instance. A new **NativeWindowBuffer** instance is created each time this function is called.|
+| OH_NativeWindow_DestroyNativeWindowBuffer (OHNativeWindowBuffer \*buffer) | Decreases the reference count of a **NativeWindowBuffer** instance by 1 and, when the reference count reaches 0, destroys the instance.|
+| OH_NativeWindow_NativeWindowRequestBuffer (OHNativeWindow \*window, OHNativeWindowBuffer \*\*buffer, int \*fenceFd) | Requests a **NativeWindowBuffer** through a **NativeWindow** instance for content production.|
+| OH_NativeWindow_NativeWindowFlushBuffer (OHNativeWindow \*window, OHNativeWindowBuffer \*buffer, int fenceFd, Region region) | Flushes the **NativeWindowBuffer** filled with the content to the buffer queue through a **NativeWindow** instance for content consumption.|
+| OH_NativeWindow_NativeWindowAbortBuffer (OHNativeWindow \*window, OHNativeWindowBuffer \*buffer) | Returns the **NativeWindowBuffer** to the buffer queue through a **NativeWindow** instance, without filling in any content. The **NativeWindowBuffer** can be used for another request.|
+| OH_NativeWindow_NativeWindowHandleOpt (OHNativeWindow \*window, int code,...) | Sets or obtains the attributes of a native window, including the width, height, and content format.|
+| OH_NativeWindow_GetBufferHandleFromNative (OHNativeWindowBuffer \*buffer) | Obtains the pointer to a **BufferHandle** of a **NativeWindowBuffer** instance.|
| OH_NativeWindow_NativeObjectReference (void \*obj) | Adds the reference count of a native object.|
| OH_NativeWindow_NativeObjectUnreference (void \*obj) | Decreases the reference count of a native object and, when the reference count reaches 0, destroys this object.|
| OH_NativeWindow_GetNativeObjectMagic (void \*obj) | Obtains the magic ID of a native object.|
-
+| OH_NativeWindow_NativeWindowSetScalingMode (OHNativeWindow \*window, uint32_t sequence, OHScalingMode scalingMode) | Sets the scaling mode of the native window.|
+| OH_NativeWindow_NativeWindowSetMetaData(OHNativeWindow \*window, uint32_t sequence, int32_t size, const OHHDRMetaData \*metaData) | Sets the HDR static metadata of the native window.|
+| OH_NativeWindow_NativeWindowSetMetaDataSet(OHNativeWindow \*window, uint32_t sequence, OHHDRMetadataKey key, int32_t size, const uint8_t \*metaData) | Sets the HDR static metadata set of the native window.|
+| OH_NativeWindow_NativeWindowSetTunnelHandle(OHNativeWindow \*window, const OHExtDataHandle \*handle) | Sets the tunnel handle to the native window.|
## How to Develop
-The following steps describe how to use `OH_NativeXComponent` in OpenHarmony to draw content using native C++ code and display the content on the screen.
-
-1. Define an `XComponent` of the `texture` type in `index.ets` for content display.
- ```js
- XComponent({ id: 'xcomponentId', type: 'texture', libraryname: 'nativerender'})
- .borderColor(Color.Red)
- .borderWidth(5)
- .onLoad(() => {})
- .onDestroy(() => {})
- ```
-
-2. Obtain an `OH_NativeXComponent` instance (named `nativeXComponent` in this example) by calling `napi_get_named_property`, and obtain a `NativeWindow` instance by registering the callback of the `OH_NativeXComponent` instance.
+The following describes how to use the NAPI provided by **NativeWindow** to request a graphics buffer, write the produced graphics content to the buffer, and flush the buffer to the graphics queue.
+1. Obtain a **NativeWindow** instance. For example, use **Surface** to create a **NativeWindow** instance.
```c++
- // Define a NAPI instance.
- napi_value exportInstance = nullptr;
- // Define an OH_NativeXComponent instance.
- OH_NativeXComponent *nativeXComponent = nullptr;
- // Use the OH_NATIVE_XCOMPONENT_OBJ export instance.
- napi_getname_property(env, exports, OH_NATIVE_XCOMPONENT_OBJ, &exportInstance);
- // Convert the NAPI instance to the OH_NativeXComponent instance.
- napi_unwarp(env, exportInstance, reinterpret_cast(&nativeXComponent));
+ sptr cSurface = Surface::CreateSurfaceAsConsumer();
+ sptr listener = new BufferConsumerListenerTest();
+ cSurface->RegisterConsumerListener(listener);
+ sptr producer = cSurface->GetProducer();
+ sptr pSurface = Surface::CreateSurfaceAsProducer(producer);
+ OHNativeWindow* nativeWindow = OH_NativeWindow_CreateNativeWindow(&pSurface);
```
-3. Define the callback `OnSurfaceCreated`. During the creation of a `Surface`, the callback is used to initialize the rendering environment, for example, the `Skia` rendering environment, and write the content to be displayed to `NativeWindow`.
-
+2. Set the attributes of a native window buffer by using **OH_NativeWindow_NativeWindowHandleOpt**.
```c++
- void OnSurfaceCreatedCB(NativeXComponent* component, void* window) {
- // Obtain the width and height of the native window.
- uint64_t width_ = 0, height_ = 0;
- OH_NativeXComponent_GetXComponentSize(nativeXComponent, window, &width_, &height_);
- // Convert void* into a NativeWindow instance. NativeWindow is defined in native_window/external_window.h.
- NativeWindow* nativeWindow_ = (NativeWindow*)(window);
-
- // Set or obtain the NativeWindow attributes by calling OH_NativeWindow_NativeWindowHandleOpt.
- // 1. Use SET_USAGE to set the usage attribute of the native window, for example, to HBM_USE_CPU_READ.
- OH_NativeWindow_NativeWindowHandleOpt(nativeWindow_, SET_USAGE, HBM_USE_CPU_READ | HBM_USE_CPU_WRITE |HBM_USE_MEM_DMA);
- // 2. Use SET_BUFFER_GEOMETRY to set the width and height attributes of the native window.
- OH_NativeWindow_NativeWindowHandleOpt(nativeWindow_, SET_BUFFER_GEOMETRY, width_, height_);
- // 3. Use SET_FORMAT to set the format attribute of the native window, for example, to PIXEL_FMT_RGBA_8888.
- OH_NativeWindow_NativeWindowHandleOpt(nativeWindow_, SET_FORMAT, PIXEL_FMT_RGBA_8888);
- // 4. Use SET_STRIDE to set the stride attribute of the native window.
- OH_NativeWindow_NativeWindowHandleOpt(nativeWindow_, SET_STRIDE, 0x8);
-
- // Obtain the NativeWindowBuffer instance by calling OH_NativeWindow_NativeWindowRequestBuffer.
- struct NativeWindowBuffer* buffer = nullptr;
- int fenceFd;
- OH_NativeWindow_NativeWindowRequestBuffer(nativeWindow_, &buffer, &fenceFd);
-
- // Obtain the buffer handle by calling OH_NativeWindow_GetNativeBufferHandleFromNative.
- BufferHandle* bufferHandle = OH_NativeWindow_GetNativeBufferHandleFromNative(buffer);
+ // Set the read and write scenarios of the native window buffer.
+ int code = SET_USAGE;
+ int32_t usage = BUFFER_USAGE_CPU_READ | BUFFER_USAGE_CPU_WRITE | BUFFER_USAGE_MEM_DMA;
+ int32_t ret = OH_NativeWindow_NativeWindowHandleOpt(nativeWindow, code, usage);
+ // Set the width and height of the native window buffer.
+ code = SET_BUFFER_GEOMETRY;
+ int32_t width = 0x100;
+ int32_t height = 0x100;
+ ret = OH_NativeWindow_NativeWindowHandleOpt(nativeWindow, code, width, height);
+ // Set the step of the native window buffer.
+ code = SET_STRIDE;
+ int32_t stride = 0x8;
+ ret = OH_NativeWindow_NativeWindowHandleOpt(nativeWindow, code, stride);
+ // Set the format of the native window buffer.
+ code = SET_FORMAT;
+ int32_t format = PIXEL_FMT_RGBA_8888;
+ ret = OH_NativeWindow_NativeWindowHandleOpt(nativeWindow, code, format);
+ ```
- // Create a Skia bitmap using BufferHandle.
- SkBitmap bitmap;
- SkImageInfo imageInfo = ...
- bitmap.setInfo(imageInfo, bufferHandle->stride);
- bitmap.setPixels(bufferHandle->virAddr);
- // Create Skia Canvas and write the content to the native window.
- ...
+3. Request a native window buffer from the graphics queue.
+ ```c++
+ struct NativeWindowBuffer* buffer = nullptr;
+ int fenceFd;
+ // Obtain the NativeWindowBuffer instance by calling OH_NativeWindow_NativeWindowRequestBuffer.
+ OH_NativeWindow_NativeWindowRequestBuffer(nativeWindow_, &buffer, &fenceFd);
+ // Obtain the buffer handle by calling OH_NativeWindow_GetNativeBufferHandleFromNative.
+ BufferHandle* bufferHandle = OH_NativeWindow_GetNativeBufferHandleFromNative(buffer);
+ ```
- // After the write operation is complete, flush the buffer by using OH_NativeWindow_NativeWindowFlushBuffer so that the data is displayed on the screen.
- Region region{nullptr, 0};
- OH_NativeWindow_NativeWindowFlushBuffer(nativeWindow_, buffer, fenceFd, region)
+4. Write the produced content to the native window buffer.
+ ```c++
+ auto image = static_cast(buffer->sfbuffer->GetVirAddr());
+ static uint32_t value = 0x00;
+ value++;
+
+ uint32_t *pixel = static_cast(image);
+ for (uint32_t x = 0; x < width; x++) {
+ for (uint32_t y = 0; y < height; y++) {
+ *pixel++ = value;
+ }
}
```
-4. Register the callback `OnSurfaceCreated` by using `OH_NativeXComponent_RegisterCallback`.
+5. Flush the native window buffer to the graphics queue.
```c++
- OH_NativeXComponent_Callback &callback_;
- callback_->OnSurfaceCreated = OnSurfaceCreatedCB;
- callback_->OnSurfaceChanged = OnSurfaceChangedCB;
- callback_->OnSurfaceDestoryed = OnSurfaceDestoryedCB;
- callback_->DispatchTouchEvent = DispatchTouchEventCB;
- OH_NativeXComponent_RegisterCallback(nativeXComponent, callback_)
+ // Set the refresh region. If Rect in Region is a null pointer or rectNumber is 0, all contents in the native window buffer 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);
```
diff --git a/en/application-dev/notification/background-agent-scheduled-reminder-guide.md b/en/application-dev/notification/background-agent-scheduled-reminder-guide.md
index b789e20218f1d8508ce5dbf1b515179e6f23b9ef..71ffeb0b07acfb088988163a68f72882d267f49b 100644
--- a/en/application-dev/notification/background-agent-scheduled-reminder-guide.md
+++ b/en/application-dev/notification/background-agent-scheduled-reminder-guide.md
@@ -37,7 +37,7 @@ For details about the APIs, see [reminderAgent](../reference/apis/js-apis-remind
import reminderAgent from '@ohos.reminderAgent';
import notification from '@ohos.notification';
export default {
- // eTS project:
+ // ArkTS project:
let timer : reminderAgent.ReminderRequestTimer = {
reminderType: reminderAgent.ReminderType.REMINDER_TYPE_TIMER,
triggerTimeInSeconds: 10,
@@ -67,7 +67,7 @@ For details about the APIs, see [reminderAgent](../reference/apis/js-apis-remind
Sample code for defining a reminder agent for a calendar event:
```js
- // eTS project:
+ // ArkTS project:
let calendar : reminderAgent.ReminderRequestCalendar = {
reminderType: reminderAgent.ReminderType.REMINDER_TYPE_CALENDAR,
dateTime: {
@@ -113,7 +113,7 @@ For details about the APIs, see [reminderAgent](../reference/apis/js-apis-remind
Sample code for defining a reminder agent for an alarm:
```js
- // eTS project:
+ // ArkTS project:
let alarm : reminderAgent.ReminderRequestAlarm = {
reminderType: reminderAgent.ReminderType.REMINDER_TYPE_ALARM,
hour: 11,
diff --git a/en/application-dev/quick-start/Readme-EN.md b/en/application-dev/quick-start/Readme-EN.md
index 0a7533ea2389f74866ced1742937daeffe134fcc..9b89cfd83f8a3af29bda3fe76016d269561282cb 100644
--- a/en/application-dev/quick-start/Readme-EN.md
+++ b/en/application-dev/quick-start/Readme-EN.md
@@ -1,12 +1,22 @@
# Quick Start
-
- Getting Started
- - [Preparations](start-overview.md)
- - [Getting Started with eTS in Stage Model](start-with-ets-stage.md)
- - [Getting Started with eTS in FA Model](start-with-ets-fa.md)
- - [Getting Started with JavaScript in FA Model](start-with-js-fa.md)
+ - [Before You Start](start-overview.md)
+ - [Getting Started with ArkTS in Stage Model](start-with-ets-stage.md)
+ - [Getting Started with ArkTS in FA Model](start-with-ets-fa.md)
+ - [Getting Started with JavaScript in FA Model](start-with-js-fa.md)
- Development Fundamentals
- [Application Package Structure Configuration File (FA Model)](package-structure.md)
- [Application Package Structure Configuration File (Stage Model)](stage-structure.md)
- [SysCap](syscap.md)
- - [HarmonyAppProvision Configuration File](app-provision-structure.md)
+ - [Resource Categories and Access](resource-categories-and-access.md)
+ - Learning ArkTS
+ - [Getting Started with ArkTS](arkts-get-started.md)
+ - ArkTS Syntax (Declarative UI)
+ - [Basic UI Description](arkts-basic-ui-description.md)
+ - State Management
+ - [Basic Concepts](arkts-state-mgmt-concepts.md)
+ - [State Management with Page-level Variables](arkts-state-mgmt-page-level.md)
+ - [State Management with Application-level Variables](arkts-state-mgmt-application-level.md)
+ - [Dynamic UI Element Building](arkts-dynamic-ui-elememt-building.md)
+ - [Rendering Control](arkts-rendering-control.md)
+ - [Restrictions and Extensions](arkts-restrictions-and-extensions.md)
\ No newline at end of file
diff --git a/en/application-dev/quick-start/arkts-basic-ui-description.md b/en/application-dev/quick-start/arkts-basic-ui-description.md
new file mode 100644
index 0000000000000000000000000000000000000000..d20efe12859e944d9d78fb71688dc4aada729228
--- /dev/null
+++ b/en/application-dev/quick-start/arkts-basic-ui-description.md
@@ -0,0 +1,205 @@
+# Basic UI Description
+
+In ArkTS, you define a custom component by using decorators **@Component** and **@Entry** to decorate a data structure declared with the **struct** keyword. A custom component provides a **build** function, where you must write the basic UI description in chain call mode. For details about the UI description, see [UI Description Specifications](#ui-description-specifications).
+
+## Basic Concepts
+
+- struct: a data structure that can be used to implement custom components and cannot have inheritance. The **new** keyword can be omitted when initializing a struct.
+
+- Decorator: a special type of declaration that can be applied to classes, structures, or class attributes to add new functionality to them. Multiple decorators can be applied to the same target element and defined on a single line or multiple lines. It is recommended that the decorators be defined on multiple lines.
+
+ ```ts
+ @Entry
+ @Component
+ struct MyComponent {
+ }
+ ```
+
+- **build** function: a function that complies with the **Builder** API definition and is used to define the declarative UI description of components. A **build** function must be defined for custom components, and custom constructors are prohibited for custom components.
+
+ ```ts
+ interface Builder {
+ build: () => void
+ }
+ ```
+
+- **@Component**: a decorator applied to a struct to equip it with the component-based capability. The **build** method must be implemented for UI creation.
+
+- **@Entry**: a decorator applied to a struct to make it the entry to a page, which is rendered and displayed when the page is loaded.
+
+- **@Preview**: a decorator applied to struct to make it previewable in the DevEco Studio Previewer. The decorated component is created and displayed when the residing page is loaded.
+
+ > **NOTE**
+ >
+ > In a single source file, you can use up to 10 **@Preview** decorators to decorate custom components. For details, see [Previewing ArkTS Components](https://developer.harmonyos.com/en/docs/documentation/doc-guides/ohos-previewing-app-service-0000001218760596#section146052489820).
+
+- Chain call: a syntax for configuring the attribute methods, event methods, and more of UI components by using the dot notation.
+
+## UI Description Specifications
+
+### Structs Without Parameters
+
+A struct without parameters is a component whose API definition has empty parentheses. No parameter needs to be passed to this type of component, for example, the **Divider** component in the following snippet:
+
+```ts
+Column() {
+ Text('item 1')
+ Divider()
+ Text('item 2')
+}
+```
+
+### Structs with Mandatory Parameters
+
+A struct with mandatory parameters is a component whose API definition expects parameters enclosed in the parentheses. You can use constants to assign values to the parameters.
+
+Sample code:
+
+- Set the mandatory parameter **src** of the **\** component as follows:
+
+ ```ts
+ Image('https://xyz/test.jpg')
+ ```
+
+- Set the mandatory parameter **content** of the **\** component as follows:
+
+ ```ts
+ Text('test')
+ ```
+
+You can use variables or expressions to assign values to parameters. The result type returned by an expression must meet the parameter type requirements. For details about the variables, see [State Management with Page-level Variables](arkts-state-mgmt-page-level.md) and [State Management with Application-level Variables](arkts-state-mgmt-application-level.md). For example, set a variable or expression to construct the **\** and **\** components:
+
+```ts
+Image(this.imagePath)
+Image('https://' + this.imageUrl)
+Text(`count: ${this.count}`)
+```
+
+### Attribute Configuration
+
+Component attributes are configured using an attribute method, which follows the corresponding component and is bound to the component using the "**.**" operator.
+
+- Example of configuring the font size attribute of the **\** component:
+
+ ```ts
+ Text('test')
+ .fontSize(12)
+ ```
+
+- Example of configuring multiple attributes at the same time by using the "**.**" operator to implement chain call:
+
+ ```ts
+ Image('test.jpg')
+ .alt('error.jpg')
+ .width(100)
+ .height(100)
+ ```
+
+- Example of passing variables or expressions in addition to constants:
+
+ ```ts
+ Text('hello')
+ .fontSize(this.size)
+ Image('test.jpg')
+ .width(this.count % 2 === 0 ? 100 : 200)
+ .height(this.offset + 100)
+ ```
+
+- For attributes of built-in components, ArkUI also provides some predefined [enumeration types](../reference/arkui-ts/ts-appendix-enums.md), which you can pass as parameters to methods if they meet the parameter type requirements. For example, you can configure the font color and weight attributes of the **\** component as follows:
+
+ ```ts
+ Text('hello')
+ .fontSize(20)
+ .fontColor(Color.Red)
+ .fontWeight(FontWeight.Bold)
+ ```
+
+### Event Configuration
+
+Events supported by components are configured using event methods, which each follow the corresponding component and are bound to the component using the "**.**" operator.
+
+- Example of using a lambda expression to configure the event of a component:
+
+ ```ts
+ Button('add counter')
+ .onClick(() => {
+ this.counter += 2
+ })
+ ```
+
+- Example of using an anonymous function expression to configure the event of a component (**bind** must be used to ensure that the contained components are referenced by **this** in the function body):
+
+ ```ts
+ Button('add counter')
+ .onClick(function () {
+ this.counter += 2
+ }.bind(this))
+ ```
+
+- Example of using a component's member function to configure the event of the component:
+
+ ```ts
+ myClickHandler(): void {
+ this.counter += 2
+ }
+
+ ...
+
+ Button('add counter')
+ .onClick(this.myClickHandler)
+ ```
+
+### Child Component Configuration
+
+For a component that supports child components, for example, a container component, add the UI descriptions of the child components inside parentheses. The **\**, **\**, **\**, **\**, and **\** components are all container components.
+
+- Simple example of the **\** component:
+
+ ```ts
+ Column() {
+ Text('Hello')
+ .fontSize(100)
+ Divider()
+ Text(this.myText)
+ .fontSize(100)
+ .fontColor(Color.Red)
+ }
+ ```
+
+- Example of nesting multiple child components in the **\** component:
+
+ ```ts
+ Column() {
+ Row() {
+ Image('test1.jpg')
+ .width(100)
+ .height(100)
+ Button('click +1')
+ .onClick(() => {
+ console.info('+1 clicked!')
+ })
+ }
+
+ Divider()
+ Row() {
+ Image('test2.jpg')
+ .width(100)
+ .height(100)
+ Button('click +2')
+ .onClick(() => {
+ console.info('+2 clicked!')
+ })
+ }
+
+ Divider()
+ Row() {
+ Image('test3.jpg')
+ .width(100)
+ .height(100)
+ Button('click +3')
+ .onClick(() => {
+ console.info('+3 clicked!')
+ })
+ }
+ }
+ ```
diff --git a/en/application-dev/quick-start/arkts-dynamic-ui-elememt-building.md b/en/application-dev/quick-start/arkts-dynamic-ui-elememt-building.md
new file mode 100644
index 0000000000000000000000000000000000000000..a781f1d81c83a306c135b412b14ded55d032cb02
--- /dev/null
+++ b/en/application-dev/quick-start/arkts-dynamic-ui-elememt-building.md
@@ -0,0 +1,385 @@
+# Dynamic UI Element Building
+
+After you've created a custom component (as described in [Basic UI Description](arkts-basic-ui-description.md)), you can customize the internal UI structure for the component, by drawing on the capability of dynamic UI element building.
+
+## @Builder
+
+The **@Builder** decorator is used to decorate a function for quickly generating multiple layouts in a custom component. This function can be declared outside the **build** function and used in the **build** function or other **@Builder** decorated functions. The following example shows how to use **@Builder**.
+
+```ts
+// xxx.ets
+@Component
+struct CompB {
+ @State CompValue: string = ''
+
+ aboutToAppear() {
+ console.info('CompB aboutToAppear.')
+ }
+
+ aboutToDisappear() {
+ console.info('CompB aboutToDisappear.')
+ }
+
+ build() {
+ Column() {
+ Button(this.CompValue)
+ .margin(5)
+ }
+ }
+}
+
+@Entry
+@Component
+struct CompA {
+ size1: number = 100
+ @State CompValue1: string = "Hello,CompValue1"
+ @State CompValue2: string = "Hello,CompValue2"
+ @State CompValue3: string = "Hello,CompValue3"
+
+ // Use the custom component CompB in the @Builder decorated function CompC.
+ @Builder CompC(value: string) {
+ CompB({ CompValue: value })
+ }
+
+ @Builder SquareText(label: string) {
+ Text(label)
+ .fontSize(18)
+ .width(1 * this.size1)
+ .height(1 * this.size1)
+ }
+
+ // Use the @Builder decorated function SquareText in the @Builder decorated function RowOfSquareTexts.
+ @Builder RowOfSquareTexts(label1: string, label2: string) {
+ Row() {
+ this.SquareText(label1)
+ this.SquareText(label2)
+ }
+ .width(2 * this.size1)
+ .height(1 * this.size1)
+ }
+
+ build() {
+ Column() {
+ Row() {
+ this.SquareText("A")
+ this.SquareText("B")
+ }
+ .width(2 * this.size1)
+ .height(1 * this.size1)
+
+ this.RowOfSquareTexts("C", "D")
+ Column() {
+ // Use the @Builder decorated custom components three times.
+ this.CompC(this.CompValue1)
+ this.CompC(this.CompValue2)
+ this.CompC(this.CompValue3)
+ }
+ .width(2 * this.size1)
+ .height(2 * this.size1)
+ }
+ .width(2 * this.size1)
+ .height(2 * this.size1)
+ }
+}
+```
+
+
+## @BuilderParam8+
+
+The **@BuilderParam** decorator is used to decorate the function type attributes (for example, **@BuilderParam noParam: () => void**) in a custom component. When the custom component is initialized, the attributes decorated by **@BuilderParam** must be assigned values.
+
+### Background
+
+In certain circumstances, you may need to add a specific function, such as a click-to-jump action, to a custom component. However, embedding an event method directly inside of the component will add the function to all places where the component is imported. This is where the **@BuilderParam** decorator comes into the picture. When initializing a custom component, you can assign a **@Builder** decorated method to the **@BuilderParam** decorated attribute, thereby adding the specific function to the custom component.
+
+### Component Initialization Through Parameters
+
+When initializing a custom component through parameters, assign a **@Builder** decorated method to the **@BuilderParam** decorated attribute — **content**, and call the value of **content** in the custom component. If no parameter is passed when assigning a value to the **@BuilderParam** decorated attribute (for example, **noParam: this.specificNoParam**), define the type of the attribute as a function without a return value (for example, **@BuilderParam noParam: () => void**). If any parameter is passed when assigning a value to the **@BuilderParam** decorated attribute (for example, **withParam: this.SpecificWithParam('WithParamA')**), define the type of the attribute as **any** (for example, **@BuilderParam withParam: any**).
+
+```ts
+// xxx.ets
+@Component
+struct CustomContainer {
+ header: string = ''
+ @BuilderParam noParam: () => void
+ @BuilderParam withParam: any
+ footer: string = ''
+
+ build() {
+ Column() {
+ Text(this.header)
+ .fontSize(30)
+ this.noParam()
+ this.withParam()
+ Text(this.footer)
+ .fontSize(30)
+ }
+ }
+}
+
+@Entry
+@Component
+struct CustomContainerUser {
+ @Builder specificNoParam() {
+ Column() {
+ Text('noParam').fontSize(30)
+ }
+ }
+
+ @Builder SpecificWithParam(label: string) {
+ Column() {
+ Text(label).fontSize(30)
+ }
+ }
+
+ build() {
+ Column() {
+ CustomContainer({
+ header: 'HeaderA',
+ noParam: this.specificNoParam,
+ withParam: this.SpecificWithParam('WithParamA'),
+ footer: 'FooterA'
+ })
+ Divider()
+ .strokeWidth(3)
+ .margin(10)
+ CustomContainer({
+ header: 'HeaderB',
+ noParam: this.specificNoParam,
+ withParam: this.SpecificWithParam('WithParamB'),
+ footer: 'FooterB'
+ })
+ }
+ }
+}
+```
+
+
+
+### Component Initialization Through Trailing Closure
+
+In a custom component, the **@BuilderParam** decorated attribute can be initialized using a trailing closure. During initialization, the component name is followed by a pair of braces ({}) to form a trailing closure (**CustomContainer(){}**). You can consider a trailing closure as a container and add content to it. For example, you can add a component (**{Column(){...}**) to the closure. The syntax of the closure is the same as that of **build**. In this scenario, the custom component has one and only one **@BuilderParam** decorated attribute.
+
+Example: Add a **\** component and a click event to the closure, and call the **specificParam** method decorated by **@Builder** in the new **\** component. After the **\** component is clicked, the value of the **CustomContainer** component's **header** attribute will change from **header** to **changeHeader**. When the component is initialized, the content of the trailing closure will be assigned to the **closer** attribute decorated by **@BuilderParam**.
+
+```ts
+// xxx.ets
+@Component
+struct CustomContainer {
+ header: string = ''
+ @BuilderParam closer: () => void
+
+ build() {
+ Column() {
+ Text(this.header)
+ .fontSize(30)
+ this.closer()
+ }
+ }
+}
+
+@Builder function specificParam(label1: string, label2: string) {
+ Column() {
+ Text(label1)
+ .fontSize(30)
+ Text(label2)
+ .fontSize(30)
+ }
+}
+
+@Entry
+@Component
+struct CustomContainerUser {
+ @State text: string = 'header'
+
+ build() {
+ Column() {
+ CustomContainer({
+ header: this.text,
+ }) {
+ Column() {
+ specificParam('testA', 'testB')
+ }.backgroundColor(Color.Yellow)
+ .onClick(() => {
+ this.text = 'changeHeader'
+ })
+ }
+ }
+ }
+}
+```
+
+
+
+## @Styles
+
+The **@Styles** decorator helps avoid repeated style setting, by extracting multiple style settings into one method. When declaring a component, you can invoke this method and use the **@Styles** decorator to quickly define and reuse the custom styles of a component. **@Styles** supports only universal attributes.
+
+**@Styles** can be defined inside or outside a component declaration. When it is defined outside a component declaration, the component name must be preceded by the keyword **function**.
+
+```ts
+// xxx.ets
+@Styles function globalFancy () {
+ .width(150)
+ .height(100)
+ .backgroundColor(Color.Pink)
+}
+
+@Entry
+@Component
+struct FancyUse {
+ @Styles componentFancy() {
+ .width(100)
+ .height(200)
+ .backgroundColor(Color.Yellow)
+ }
+
+ build() {
+ Column({ space: 10 }) {
+ Text('FancyA')
+ .globalFancy()
+ .fontSize(30)
+ Text('FancyB')
+ .globalFancy()
+ .fontSize(20)
+ Text('FancyC')
+ .componentFancy()
+ .fontSize(30)
+ Text('FancyD')
+ .componentFancy()
+ .fontSize(20)
+ }
+ }
+}
+```
+
+
+
+**@Styles** can also be used inside the **[StateStyles](../reference/arkui-ts/ts-universal-attributes-polymorphic-style.md)** attribute declaration of a component, to assign state-specific attributes to the component.
+
+In **StateStyles**, **@Styles** decorated methods defined outside the component can be directly called, while those defined inside can be called only with the keyword **this**.
+
+```ts
+// xxx.ets
+@Styles function globalFancy () {
+ .width(120)
+ .height(120)
+ .backgroundColor(Color.Green)
+}
+
+@Entry
+@Component
+struct FancyUse {
+ @Styles componentFancy() {
+ .width(80)
+ .height(80)
+ .backgroundColor(Color.Red)
+ }
+
+ build() {
+ Row({ space: 10 }) {
+ Button('Fancy')
+ .stateStyles({
+ normal: {
+ .width(100)
+ .height(100)
+ .backgroundColor(Color.Blue)
+ },
+ disabled: this.componentFancy,
+ pressed: globalFancy
+ })
+ }
+ }
+}
+```
+
+
+
+## @Extend
+
+The **@Extend** decorator adds new attribute methods to built-in components, such as **\**, **\**, and **\**. In this way, the built-in components are extended instantly.
+
+```ts
+// xxx.ets
+@Extend(Text) function fancy (fontSize: number) {
+ .fontColor(Color.Red)
+ .fontSize(fontSize)
+ .fontStyle(FontStyle.Italic)
+ .fontWeight(600)
+}
+
+@Entry
+@Component
+struct FancyUse {
+ build() {
+ Row({ space: 10 }) {
+ Text("Fancy")
+ .fancy(16)
+ Text("Fancy")
+ .fancy(24)
+ Text("Fancy")
+ .fancy(32)
+ }
+ }
+}
+
+```
+
+> **NOTE**
+>
+> - The **@Extend** decorator cannot be defined inside the struct of a custom component.
+> - The **@Extend** decorator supports only attribute methods.
+
+
+
+## @CustomDialog
+
+The **@CustomDialog** decorator is used to decorate custom dialog boxes, enabling their content and styles to be dynamically set.
+
+```ts
+// xxx.ets
+@CustomDialog
+struct DialogExample {
+ controller: CustomDialogController
+ action: () => void
+
+ build() {
+ Row() {
+ Button('Close CustomDialog')
+ .onClick(() => {
+ this.controller.close()
+ this.action()
+ })
+ }.padding(20)
+ }
+}
+
+@Entry
+@Component
+struct CustomDialogUser {
+ dialogController: CustomDialogController = new CustomDialogController({
+ builder: DialogExample({ action: this.onAccept }),
+ cancel: this.existApp,
+ autoCancel: true
+ });
+
+ onAccept() {
+ console.info('onAccept');
+ }
+
+ existApp() {
+ console.info('Cancel dialog!');
+ }
+
+ build() {
+ Column() {
+ Button('Click to open Dialog')
+ .onClick(() => {
+ this.dialogController.open()
+ })
+ }
+ }
+}
+```
+
+
diff --git a/en/application-dev/quick-start/arkts-get-started.md b/en/application-dev/quick-start/arkts-get-started.md
new file mode 100644
index 0000000000000000000000000000000000000000..3535650f871975be76fe4b24d9471a8d7895a255
--- /dev/null
+++ b/en/application-dev/quick-start/arkts-get-started.md
@@ -0,0 +1,30 @@
+# Getting Started with ArkTS
+
+As its name implies, ArkTS is a superset of TypeScript. It is the preferred, primary programming language for application development in OpenHarmony.
+
+- ArkTS offers all the features of TS.
+
+- ArkTS extends TS mainly by adding [declarative UI](arkts-basic-ui-description.md) capabilities, which allow you to develop high-performance applications in a more natural and intuitive manner.
+
+ The declarative UI capabilities offered by ArkTS include the following:
+
+ - [Basic UI description](arkts-basic-ui-description.md): A wide variety of decorators, custom components, and UI description mechanisms work with the built-in components, event methods, and attribute methods in ArkUI, jointly underpinning UI development.
+ - [State management](arkts-state-mgmt-page-level.md): In the multi-dimensional state management mechanism for ArkUI, UI-related data can be used not only within a component, but also be transferred between different component levels (for example, between parent and child components, between grandparent and grandchild components, or globally) in a device or even across devices. In addition, data transfer can be classified as one-way (read-only) or two-way (mutable). You can use these capabilities at your disposal to implement linkage between data and the UI.
+ - [Dynamic UI element building](arkts-dynamic-ui-elememt-building.md): In ArkTS, you can dynamically build UI elements, customizing the internal UI structure of components or extending the native components with custom component styles.
+ - [Rendering control](arkts-rendering-control.md): ArkTS provides conditional rendering and loop rendering. Conditional rendering can render state-specific content based on the application status. Loop rendering iteratively obtains data from the data source and creates the corresponding component during each iteration.
+ - [Restrictions and extensions](arkts-restrictions-and-extensions.md): ArkTS provides extensions, such as two-way binding. However, it is not without its restrictions.
+
+- ArkTS will continue to evolve to accommodate changing application development and running requirements, and gradually adds more features, such as parallelism and concurrency enhancement, typed system enhancement, and distributed development paradigm.
+
+Below is sample code to illustrate the building blocks of ArkTS. It implements a simple UI with two text segments, one divider, and one button. When the user clicks the button, the text content changes from "Hello World" to "Hello ArkUI".
+
+
+
+As shown above, ArkTS has the following building blocks:
+
+- Decorators: used to decorate classes, structures, methods, and variables for custom definitions. In the preceding sample code, **@Entry**, **@Component**, and **@State** are decorators. Specifically, **@Component** indicates a custom component, **@Entry** indicates an entry component, and **@State** indicates a state variable in the component, whose change will trigger re-rendering of the UI.
+- Custom components: reusable UI units that can be used in flexible combinations. In the preceding sample code, the structure **Hello** decorated by **@Component** is a custom component.
+- UI description: declarative description of the UI structure, such as the code block of the **build()** method.
+- Built-in components: basic, container, media, drawing, and canvas components preset in ArkTS. You can directly invoke such components as **\**, **\**, **\**, and **\** components in the sample code.
+- Attribute methods: methods used to configure component attributes, such as **fontSize()**, **width()**, **height()**, and **color()**. You can configure multiple attributes of a component in method chaining mode.
+- Event methods: methods used to add the logic for a component to respond to an event. In the sample code, **onClick()** following **Button** is an event method. You can configure response logic for multiple events in method chaining mode.
diff --git a/en/application-dev/quick-start/arkts-rendering-control.md b/en/application-dev/quick-start/arkts-rendering-control.md
index 06862c299448fea4052c690ac45eb29caae1c636..dff2cda50c02afabc15d0f5c8bb576218cab316e 100644
--- a/en/application-dev/quick-start/arkts-rendering-control.md
+++ b/en/application-dev/quick-start/arkts-rendering-control.md
@@ -125,8 +125,8 @@ interface DataChangeListener {
| Name | Type | Mandatory| Description |
| ------------- | --------------------- | ---- | ------------------------------------------------------------ |
| dataSource | IDataSource | Yes | Object used to implement the **IDataSource** API. You need to implement related APIs. |
-| itemGenerator | (item: any) => void | Yes | A lambda function used to generate one or more child components for each data item in an array. A single child component or a list of child components must be included in parentheses.|
-| keyGenerator | (item: any) => string | No | An anonymous function used to generate a unique and fixed key value for each data item in an array. This key value must remain unchanged for the data item even when the item is relocated in the array. When the item is replaced by a new item, the key value of the new item must be different from that of the existing item. This key-value generator is optional. However, for performance reasons, it is strongly recommended that the key-value generator be provided, so that the development framework can better identify array changes. For example, if no key-value generator is provided, a reverse of an array will result in rebuilding of all nodes in **LazyForEach**.|
+| 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. A single child component or a list of child components must be included in parentheses.|
+| keyGenerator | (item: any, index?: number) => string | No | An anonymous function used to generate a unique and fixed key value for each data item in an array. This key value must remain unchanged for the data item even when the item is relocated in the array. When the item is replaced by a new item, the key value of the new item must be different from that of the existing item. This key-value generator is optional. However, for performance reasons, it is strongly recommended that the key-value generator be provided, so that the development framework can better identify array changes. For example, if no key-value generator is provided, a reverse of an array will result in rebuilding of all nodes in **LazyForEach**.|
### Description of IDataSource
@@ -142,14 +142,14 @@ interface DataChangeListener {
| Name | Description |
| -------------------------------------------------------- | -------------------------------------- |
| onDataReloaded(): void | Invoked when all data is reloaded. |
-| onDataAdded(index: number): void (deprecated) | Invoked when data is added to the position indicated by the specified index. |
-| onDataMoved(from: number, to: number): void (deprecated) | Invoked when data is moved from the **from** position to the **to** position.|
-| onDataDeleted(index: number): void (deprecated) | Invoked when data is deleted from the position indicated by the specified index. |
-| onDataChanged(index: number): void (deprecated) | Invoked when data in the position indicated by the specified index is changed. |
-| onDataAdd(index: number): void 8+ | Invoked when data is added to the position indicated by the specified index. |
-| onDataMove(from: number, to: number): void 8+ | Invoked when data is moved from the **from** position to the **to** position.|
-| onDataDelete(index: number): void 8+ | Invoked when data is deleted from the position indicated by the specified index. |
-| onDataChange(index: number): void 8+ | Invoked when data in the position indicated by the specified index is changed. |
+| onDataAdded(index: number): voiddeprecated | Invoked when data is added to the position indicated by the specified index. This API is deprecated since API version 8. You are advised to use **onDataAdd**. |
+| onDataMoved(from: number, to: number): voiddeprecated | Invoked when data is moved from the **from** position to the **to** position. This API is deprecated since API version 8. You are advised to use **onDataMove**.|
+| onDataDeleted(index: number): voiddeprecated | Invoked when data is deleted from the position indicated by the specified index. This API is deprecated since API version 8. You are advised to use **onDataDelete**. |
+| onDataChanged(index: number): voiddeprecated | Invoked when data in the position indicated by the specified index is changed. This API is deprecated since API version 8. You are advised to use **onDataChange**. |
+| onDataAdd(index: number): void8+ | Invoked when data is added to the position indicated by the specified index. |
+| onDataMove(from: number, to: number): void8+ | Invoked when data is moved from the **from** position to the **to** position.|
+| onDataDelete(index: number): void8+ | Invoked when data is deleted from the position indicated by the specified index. |
+| onDataChange(index: number): void8+ | Invoked when data in the position indicated by the specified index is changed. |
## Example
diff --git a/en/application-dev/quick-start/arkts-restrictions-and-extensions.md b/en/application-dev/quick-start/arkts-restrictions-and-extensions.md
new file mode 100644
index 0000000000000000000000000000000000000000..1cb3b0fa04aedd8df61a660993e7f67e48c03c98
--- /dev/null
+++ b/en/application-dev/quick-start/arkts-restrictions-and-extensions.md
@@ -0,0 +1,135 @@
+# Restrictions and Extensions
+
+## Restrictions on Using ArkTS in Generators
+
+ArkTS has the following restrictions on generators:
+
+- Expressions can be used only in character strings (${expression}), **if/else** statements, **ForEach** parameters, and component parameters.
+
+- No expressions should cause any application state variables (that is, variables decorated by **@State**, **@Link**, and **@Prop**) to change. Otherwise, undefined and potentially unstable framework behavior may occur.
+
+- The generator function cannot contain local variables.
+
+None of the above restrictions applies to anonymous function implementations of event methods (such as **onClick**).
+
+## Two-Way Binding of Variables
+
+ArkTS supports two-way binding through **$$**, which is usually used for variables whose state values change frequently.
+
+- **$$** supports variables of primitive types and variables decorated by **@State**, **@Link**, or **@Prop**.
+- **$$** supports only the **show** parameter of the **[bindPopup](../reference/arkui-ts/ts-universal-attributes-popup.md)** attribute method, the **checked** attribute of the **[\](../reference/arkui-ts/ts-basic-components-radio.md)** component, and the **refreshing** parameter of the **[\](../reference/arkui-ts/ts-container-refresh.md)** component.
+- When the variable bound to **$$** changes, only the current component is rendered, which improves the rendering speed.
+
+```ts
+// xxx.ets
+@Entry
+@Component
+struct bindPopupPage {
+ @State customPopup: boolean = false
+
+ build() {
+ Column() {
+ Button('Popup')
+ .margin(20)
+ .onClick(() => {
+ this.customPopup = !this.customPopup
+ })
+ .bindPopup($$this.customPopup, {
+ message: "showPopup"
+ })
+ }
+ }
+}
+```
+
+
+
+## Restrictions on Data Type Declarations of State Variables
+
+The data type declaration of the **@State**, **@Provide**, **@Link**, or **@Consume** decorated state variables can consist of only one of the primitive data types or reference data types.
+
+Example:
+
+```ts
+// xxx.ets
+@Entry
+@Component
+struct IndexPage {
+ // Incorrect: @State message: string | Resource = 'Hello World'
+ @State message: string = 'Hello World'
+
+ build() {
+ Row() {
+ Column() {
+ Text(`${this.message}`)
+ .fontSize(50)
+ .fontWeight(FontWeight.Bold)
+ }
+ .width('100%')
+ }
+ .height('100%')
+ }
+}
+```
+
+
+
+## Initialization and Restrictions of Custom Components' Member Variables
+
+The member variables of a component can be initialized in either of the following ways:
+
+- Local initialization:
+
+ ```ts
+ @State counter: Counter = new Counter()
+ ```
+- Initialization using constructor parameters:
+
+ ```ts
+ MyComponent({counter: $myCounter})
+ ```
+
+The allowed method depends on the decorator of the state variable, as shown in the following table.
+
+| Decorator | Local Initialization| Initialization Using Constructor Parameters|
+| ------------ | ----- | ----------- |
+| @State | Mandatory | Optional |
+| @Prop | Forbidden | Mandatory |
+| @Link | Forbidden | Mandatory |
+| @StorageLink | Mandatory | Forbidden |
+| @StorageProp | Mandatory | Forbidden |
+| @Provide | Mandatory | Optional |
+| @Consume | Forbidden | Forbidden |
+| @ObjectLink | Forbidden | Mandatory |
+| Normal member variable | Recommended | Optional |
+
+As indicated by the preceding table:
+
+- The **@State** decorated variables must be initialized locally. Their initial values can be overwritten by the constructor parameters.
+
+- The **@Prop** and **@Link** decorated variables must be initialized only by constructor parameters.
+
+Comply with the following rules when using constructors to initialize member variables:
+
+| From the Variable in the Parent Component (Below) to the Variable in the Child Component (Right)| @State | @Link | @Prop | Normal Variable|
+| -------------------------------------------- | ------ | ------ | ------ | -------- |
+| @State | Not allowed| Allowed | Allowed | Allowed |
+| @Link | Not allowed| Allowed | Not recommended| Allowed |
+| @Prop | Not allowed| Not allowed| Allowed | Allowed |
+| @StorageLink | Not allowed| Allowed | Not allowed| Not allowed |
+| @StorageProp | Not allowed| Not allowed| Not allowed| Allowed |
+| Normal variable | Allowed | Not allowed| Not allowed| Allowed |
+
+As indicated by the preceding table:
+
+- The normal variables of the parent component can be used to initialize the **@State** decorated variables of the child component, but not the **@Link** or **@Prop** decorated variables.
+
+- The **@State** decorated variable of the parent component can be used to initialize the **@Prop**, **@Link** (using **$**), or normal variables of the child component, but not the **@State** decorated variables of the child component.
+
+- The **@Link** decorated variables of the parent component can be used to initialize the **@Link** decorated or normal variables of the child component. However, initializing the **@State** decorated members of the child component can result in a syntax error. In addition, initializing the **@Prop** decorated variables is not recommended.
+
+- The **@Prop** decorated variables of the parent component can be used to initialize the normal variables or **@Prop** decorated variables of the child component, but not the **@State** or **@Link** decorated variables.
+
+- Passing **@StorageLink** and **@StorageProp** from the parent component to the child component is prohibited.
+
+- In addition to the preceding rules, the TypeScript strong type rules need to be followed.
diff --git a/en/application-dev/quick-start/arkts-state-mgmt-application-level.md b/en/application-dev/quick-start/arkts-state-mgmt-application-level.md
new file mode 100644
index 0000000000000000000000000000000000000000..145827cd820399e5078b7e395b3c23b3719e1a03
--- /dev/null
+++ b/en/application-dev/quick-start/arkts-state-mgmt-application-level.md
@@ -0,0 +1,285 @@
+# State Management with Application-level Variables
+
+This topic covers how to manage the application status with application-level variables. For details about the APIs, see [State Management with Application-level Variables](../reference/arkui-ts/ts-state-management.md).
+
+## AppStorage
+
+The [AppStorage](../reference/arkui-ts/ts-state-management.md#appstorage) is a singleton object in an application that provides central storage for changing state attributes of an application. It is created by the UI framework when the application is started and destroyed when the application exits.
+
+The **AppStorage** contains all the state attributes that need to be accessed throughout the application. It retains all attributes and their values as long as the application remains running, and the attribute values can be accessed through unique key values.
+
+Components can synchronize the application state data with the **AppStorage** through decorators. The application service logic can also be implemented by accessing the **AppStorage** through APIs.
+
+The selection state attribute of the **AppStorage** can be synchronized with different data sources or data sinks. These data sources and data sinks can be local or remote devices and provide different functions, such as data persistence. Such data sources and data sinks can be implemented independently of the UI in the service logic.
+
+By default, the attributes in the **AppStorage** are mutable. If needed, **AppStorage** can also use immutable (read-only) attributes.
+
+> **NOTE**
+>
+> [Worker](../reference/apis/js-apis-worker.md) can interact with the main thread only through [postMessage](../reference/apis/js-apis-worker.md#postmessage).
+
+### @StorageLink Decorator
+
+Two-way data binding can be established between components and the **AppStorage** through state variables decorated by **@StorageLink(*key*)**. Wherein, **key** is the attribute key value in the **AppStorage**. When a component containing the **@StorageLink** decorated variable is created, the variable is initialized using the value in the **AppStorage**. Changes made to this variable in the component will be first synchronized to the **AppStorage**, and then to other bound instances, such as **PersistentStorage** or other bound UI components.
+
+### @StorageProp Decorator
+
+One-way data binding can be established between components and the **AppStorage** through state variables decorated by **@StorageProp(*key*)**. Wherein, **key** is the attribute key value in the **AppStorage**. When a component containing the **@StorageProp** decorated variable is created, the variable is initialized using the value in the **AppStorage**. Changes made to the value in the **AppStorage** will cause the bound UI component to update the state.
+
+### Example
+
+Each time the user clicks the **Count** button, the value of **this.varA** will increase by 1. This variable is synchronized with **varA** in the **AppStorage**. Each time the user clicks the language button, the value of **languageCode** in the **AppStorage** will be changed, and the change is synchronized to the **this.languageCode** variable.
+
+```ts
+// xxx.ets
+@Entry
+@Component
+struct ComponentA {
+ @StorageLink('varA') varA: number = 2
+ @StorageProp('languageCode') languageCode: string = 'en'
+ private label: string = 'count'
+
+ aboutToAppear() {
+ this.label = (this.languageCode === 'en') ? 'Number' : 'Count'
+ }
+
+ build() {
+ Column() {
+ Row({ space: 20 }) {
+ Button(`${this.label}: ${this.varA}`)
+ .onClick(() => {
+ AppStorage.Set('varA', AppStorage.Get('varA') + 1)
+ })
+ Button(`language: ${this.languageCode}`)
+ .onClick(() => {
+ if (AppStorage.Get('languageCode') === 'zh') {
+ AppStorage.Set('languageCode', 'en')
+ } else {
+ AppStorage.Set('languageCode', 'zh')
+ }
+ this.label = (this.languageCode === 'en') ? 'Number' : 'Count'
+ })
+ }
+ .margin({ bottom: 50 })
+
+ Row() {
+ Button (`Change @StorageLink decorated variable: ${this.varA}`).height(40).fontSize(14)
+ .onClick(() => {
+ this.varA++
+ })
+ }.margin({ bottom: 50 })
+
+ Row() {
+ Button (`Change @StorageProp decorated variable: ${this.languageCode}`).height(40).fontSize(14)
+ .onClick(() => {
+ if (this.languageCode === 'zh') {
+ this.languageCode = 'en'
+ } else {
+ this.languageCode = 'zh'
+ }
+ })
+ }
+ }
+ }
+}
+```
+
+
+
+## LocalStorage
+
+> **NOTE**
+>
+> This API is supported since API version 9. Updates will be marked with a superscript to indicate their earliest API version.
+
+The **LocalStorage** is a storage unit in an application. Its lifecycle follows its associated ability. In the stage model, the **LocalStorage** provides global data isolation between abilities and applies to where a data sharing scope smaller than that provided by the **AppStorage** is required. The **LocalStorage** also provides storage for application-wide mutable and immutable state attributes, which are used for building part of the application UI, such as an ability UI. The **LocalStorage** resolves the data interference between the application and the abilities and, in multi-instance scenarios, data interference between different **Ability** instances under the same **Ability** class. In distributed migration scenarios, **Ability**, as the minimum unit for the system to schedule applications, allows for easier component data migration when working with the **LocalStorage**.
+
+At the application layer, multiple **LocalStorage** instances can be created for an application, each corresponding to an ability of the application.
+
+An application can have multiple abilities. At most one **LocalStorage** instance can be allocated to the components in an ability. In addition, all components in the ability inherit access to the objects stored in the **LocalStorage** instance.
+
+A component can access a maximum of one **LocalStorage** instance, and one **LocalStorage** instance can be assigned to multiple components.
+
+### @LocalStorageLink Decorator
+
+Two-way data binding can be established between a component and the **LocalStorage** through the component's state variable decorated by **@LocalStorageLink(*key*)**. Wherein, **key** is the attribute key value in the **LocalStorage**. When a component that contains a **@LocalStorageLink** decorated state variable is created, the state variable is initialized with the initial value in the **LocalStorage**. If no initial value is assigned in the **LocalStorage**, the state variable will use the value defined by **@LocalStorageLink**. Changes made to the **@LocalStorageLink** decorated variable in a component will be first synchronized to the **LocalStorage**, and then to other bound UI components under the same ability.
+
+### @LocalStorageProp Decorator
+
+One-way data binding can be established between a component and the **LocalStorage** through the component's state variable decorated by **@LocalStorageProp(*key*)**. Wherein, **key** is the attribute key value in the **LocalStorage**. When a component that contains a **@LocalStorageProp** decorated state variable is created, the state variable is initialized with the initial value in the **LocalStorage**. Changes made to the value in the **LocalStorage** will cause all UI components under the current ability to update the state.
+
+> **NOTE**
+>
+> If a **LocalStorage** instance has initial values assigned when being created, these values will be used for the **@LocalStorageLink** and **@LocalStorageProp** decorated state variables in the component. Otherwise, the initial values assigned for **@LocalStorageLink** and **@LocalStorageProp** will be used instead.
+
+### Example 1: Creating a LocalStorage Instance in an Ability
+
+The **LocalStorage** is loaded through the **loadContent** API. For details, see [loadContent](../reference/apis/js-apis-window.md#loadcontent9-1).
+
+```ts
+// MainAbility.ts
+import Ability from '@ohos.application.Ability'
+
+export default class MainAbility extends Ability {
+ storage: LocalStorage
+
+ onCreate() {
+ this.storage = new LocalStorage()
+ this.storage.setOrCreate('storageSimpleProp', 121)
+ console.info('[Demo MainAbility onCreate]')
+ }
+
+ onDestroy() {
+ console.info('[Demo MainAbility onDestroy]')
+ }
+
+ onWindowStageCreate(windowStage) {
+ // storage is passed to the loadContent API as a parameter.
+ windowStage.loadContent('pages/index', this.storage)
+ }
+
+ onWindowStageDestroy() {
+ console.info('[Demo] MainAbility onWindowStageDestroy')
+ }
+
+ onForeground() {
+ console.info('[Demo] MainAbility onForeground')
+ }
+
+ onBackground() {
+ console.info('[Demo] MainAbility onBackground')
+ }
+}
+```
+
+The **@Component** decorated component obtains data.
+
+```ts
+// index.ets
+let storage = LocalStorage.GetShared()
+
+@Entry(storage)
+@Component
+struct LocalStorageComponent {
+ @LocalStorageLink('storageSimpleProp') simpleVarName: number = 0
+
+ build() {
+ Column() {
+ Button(`LocalStorageLink: ${this.simpleVarName.toString()}`)
+ .margin(20)
+ .onClick(() => {
+ this.simpleVarName += 1
+ })
+ Text(JSON.stringify(this.simpleVarName))
+ .fontSize(50)
+ LocalStorageComponentProp()
+ }.width('100%')
+ }
+}
+
+@Component
+struct LocalStorageComponentProp {
+ @LocalStorageProp('storageSimpleProp') simpleVarName: number = 0
+
+ build() {
+ Column() {
+ Button(`LocalStorageProp: ${this.simpleVarName.toString()}`)
+ .margin(20)
+ .onClick(() => {
+ this.simpleVarName += 1
+ })
+ Text(JSON.stringify(this.simpleVarName))
+ .fontSize(50)
+ }.width('100%')
+ }
+}
+```
+
+
+
+### Example 2: Defining LocalStorage on the Entry Page
+
+```ts
+// xxx.ets
+let storage = new LocalStorage({ "PropA": 47 })
+
+@Entry(storage)
+@Component
+struct ComA {
+ @LocalStorageLink("PropA") storageLink: number = 1
+
+ build() {
+ Column() {
+ Text(`Parent from LocalStorage ${this.storageLink}`)
+ .fontSize(18)
+ .margin(20)
+ .onClick(() => this.storageLink += 1)
+ Child()
+ }
+ }
+}
+
+@Component
+struct Child {
+ @LocalStorageLink("PropA") storageLink: number = 1
+
+ build() {
+ Text(`Child from LocalStorage ${this.storageLink}`)
+ .fontSize(18)
+ .margin(20)
+ .onClick(() => this.storageLink += 1)
+ }
+}
+```
+
+
+
+## PersistentStorage
+
+[PersistentStorage](../reference/arkui-ts/ts-state-management.md#persistentstorage) provides a set of static methods for managing persistent data of applications. Persistent data with specific tags can be linked to the **AppStorage**, and then the persistent data can be accessed through the **AppStorage** APIs. Alternatively, the **@StorageLink** decorator can be used to access the variable that matches the specific key.
+
+> **NOTE**
+>
+> - When using the **PersistProp** API in **PersistentStorage**, ensure that the input key exists in the **AppStorage**.
+> - The **DeleteProp** API in **PersistentStorage** takes effect only for the data that has been linked during the current application startup.
+
+```ts
+// xxx.ets
+PersistentStorage.PersistProp('highScore', '0')
+
+@Entry
+@Component
+struct PersistentComponent {
+ @StorageLink('highScore') highScore: string = '0'
+ @State currentScore: number = 0
+
+ build() {
+ Column() {
+ if (this.currentScore === Number(this.highScore)) {
+ Text(`new highScore : ${this.highScore}`).fontSize(18)
+ }
+ Button(`goal!, currentScore : ${this.currentScore}`)
+ .margin(20)
+ .onClick(() => {
+ this.currentScore++
+ if (this.currentScore > Number(this.highScore)) {
+ this.highScore = this.currentScore.toString()
+ }
+ })
+ }.width('100%')
+ }
+}
+```
+
+
+
+## Environment
+
+[Environment](../reference/arkui-ts/ts-state-management.md#environment) is a singleton object created by the framework when the application is started. It provides the **AppStorage** with an array of environment state attributes required by the application. These attributes, such as the system language and color mode, describe the device environment where the application runs. **Environment** and its attributes are immutable, and all attribute values are of simple types. The following example shows how to obtain whether accessibility is enabled from **Environment**:
+
+```ts
+Environment.EnvProp('accessibilityEnabled', 'default')
+var enable = AppStorage.Get('accessibilityEnabled')
+```
+
+**accessibilityEnabled** is the default system variable identifier provided by **Environment**. You need to bind the corresponding system attribute to the **AppStorage**. Then, you can use the methods or decorators in the **AppStorage** to access the corresponding system attribute data.
diff --git a/en/application-dev/quick-start/arkts-state-mgmt-concepts.md b/en/application-dev/quick-start/arkts-state-mgmt-concepts.md
new file mode 100644
index 0000000000000000000000000000000000000000..d3f1002dca22fe4522134d662d4c640742d86952
--- /dev/null
+++ b/en/application-dev/quick-start/arkts-state-mgmt-concepts.md
@@ -0,0 +1,29 @@
+# Basic Concepts
+
+In the multi-dimensional state management mechanism for ArkUI, UI-related data can be used not only within a component, but also be transferred between different component levels (for example, between parent and child components, between grandparent and grandchild components, or globally). In addition, data transfer can be classified as one-way (read-only) or two-way (mutable). You can use these capabilities at your disposal to implement linkage between data and the UI.
+
+
+
+
+
+## State Management with Page-level Variables
+
+| Decorator | Decorates... | Description |
+| ----------- | ------------------------- | ------------------------------------------------------------ |
+| @State | Primitive data types, classes, and arrays | If the decorated state data is modified, the **build** method of the component will be called to update the UI. |
+| @Prop | Primitive data types | This decorator is used to establish one-way data binding between the parent and child components. When the data associated with the parent component is modified, the UI of the current component is re-rendered.|
+| @Link | Primitive data types, classes, and arrays | This decorator is used to establish two-way data binding between the parent and child components. The internal state data of the parent component is used as the data source. Any changes made to one component will be reflected to the other.|
+| @Observed | Class | This decorator is used to indicate that the data changes in the class will be managed by the UI page. |
+| @ObjectLink | Objects of **@Observed** decorated classes| When the decorated state variable is modified, the parent and sibling components that have the state variable will be notified for UI re-rendering.|
+| @Consume | Primitive data types, classes, and arrays | When the **@Consume** decorated variable detects the update of the **@Provide** decorated variable, the re-rendering of the current custom component is triggered.|
+| @Provide | Primitive data types, classes, and arrays | As the data provider, **@Provide** can update the data of child nodes and trigger page re-rendering.|
+
+## State Management with Application-level Variables
+
+**AppStorage** is the central store of the application states in the entire UI. ArkUI creates a singleton **AppStorage** object for the application and provides the corresponding decorators and APIs for the application.
+
+- **@StorageLink**: works in a way similar to that of **@Consume**. The difference is that the target object is obtained from the **AppStorage** based on the given name. **@StorageLink** establishes two-way binding between the decorated UI component and **AppStorage** to synchronize data.
+- **@StorageProp**: synchronizes UI component attributes with the **AppStorage** unidirectionally. That is, the value change in the **AppStorage** will trigger an update of the corresponding UI component, but the change of the UI component will not cause an update of the attribute value in the **AppStorage**.
+- Service logic implementation API: adds, reads, modifies, or deletes the state data of applications. The changes made by this API will be synchronized to the UI component for UI update.
+- **PersistentStorage**: provides a set of static methods for managing persistent data of applications. Persistent data with specific tags can be linked to the **AppStorage**, and then the persistent data can be accessed through the **AppStorage** APIs. Alternatively, the **@StorageLink** decorator can be used to access the variable that matches the specific key.
+- **Environment**: provides the **AppStorage** with an array of environment state attributes that are required by the application and describe the device environment where the application runs. It is a singleton object created by the framework when the application is started.
diff --git a/en/application-dev/quick-start/arkts-state-mgmt-page-level.md b/en/application-dev/quick-start/arkts-state-mgmt-page-level.md
new file mode 100644
index 0000000000000000000000000000000000000000..accda367a04ab0c77bdce7557bf47cc73f48c8a3
--- /dev/null
+++ b/en/application-dev/quick-start/arkts-state-mgmt-page-level.md
@@ -0,0 +1,521 @@
+# State Management with Page-level Variables
+
+This topic covers how to manage the states with page-level variables with the **@State**, **@Prop**, **@Link**, **@Provide**, **@Consume**, **@ObjectLink**, **@Observed**, and **@Watch** decorators.
+
+For details about the constraints of the **@State**, **@Provide**, **@Link**, and **@Consume** decorated state variables, see [Restrictions on Data Type Declarations of State Variables](./arkts-restrictions-and-extensions.md).
+
+## @State
+
+The **@State** decorated variable is the internal state data of the component. When the state data is modified, the **build** method of the component is called to refresh the UI.
+
+The **@State** data has the following features:
+
+- Support for multiple types: The following types are supported: strong types by value and by reference, including **class**, **number**, **boolean**, **string**, as well as arrays of these types, that is, **Array\**, **Array\**, **Array\**, and **Array\**. **object** and **any** are not supported.
+- Support for multiple instances: Multiple instances can coexist in a component. The internal state data of different instances is independent.
+- **Private**: An attribute marked with **@State** can only be accessed within the component.
+- Local initialization required: Initial values must be allocated to all **@State** decorated variables. Uninitialized variables may cause undefined framework exceptions.
+- Support for setting of initial attribute values based on the state variable name: When creating a component instance, you can explicitly specify the initial value of the **@State** decorated attribute based on the variable name.
+
+**Example**
+
+In the following example:
+
+- Two **@State** decorated variables, **count** and **title**, have been defined for **MyComponent**. If the value of **count** or **title** changes, the **build** method of **MyComponent** needs to be called to render the component again.
+
+- The **EntryComponent** has multiple **MyComponent** instances. The internal status change of the first **MyComponent** instance does not affect the second **MyComponent** instance.
+
+- When creating a **MyComponent** instance, initialize the variables in the component based on the variable name. For example:
+
+ ```ts
+ MyComponent({ title: { value: 'Hello World 2' }, count: 7 })
+ ```
+
+```ts
+// xxx.ets
+class Model {
+ value: string
+
+ constructor(value: string) {
+ this.value = value
+ }
+}
+
+@Entry
+@Component
+struct EntryComponent {
+ build() {
+ Column() {
+ MyComponent ({ count: 1,increaseBy:2 }) // First MyComponent instance
+ MyComponent({ title: { value:'Hello World 2' }, count: 7 }) // Second MyComponent instance
+ }
+ }
+}
+
+@Component
+struct MyComponent {
+ @State title: Model = { value: 'Hello World' }
+ @State count: number = 0
+ private toggle: string = 'Hello World'
+ private increaseBy: number = 1
+
+ build() {
+ Column() {
+ Text(`${this.title.value}`).fontSize(30)
+ Button('Click to change title')
+ .margin(20)
+ .onClick(() => {
+ // Change the value of the internal status variable title.
+ this.title.value = (this.toggle == this.title.value) ? 'Hello World' : 'Hello ArkUI'
+ })
+
+ Button(`Click to increase count=${this.count}`)
+ .margin(20)
+ .onClick(() => {
+ // Change the value of the internal status variable count.
+ this.count += this.increaseBy
+ })
+ }
+ }
+}
+```
+
+
+## @Prop
+
+**@Prop** and **@State** have the same semantics but different initialization modes. Variables decorated by **@Prop** must be initialized using the **@State** decorated variable provided by their parent components. The **@Prop** decorated variable can be modified in the component, but the modification is not updated to the parent component; that is, **@Prop** uses one-way data binding.
+
+The **@Prop** decorated state variable has the following features:
+
+- Support for simple types: The number, string, and boolean types are supported.
+- Private: Data is accessed only within the component.
+- Support for multiple instances: A component can have multiple attributes decorated by **@Prop**.
+- Support for initialization with a value passed to the @Prop decorated variable: When a new instance of the component is created, all **@Prop** decorated variables must be initialized. Initialization inside the component is not supported.
+
+**Example**
+
+In the preceding example, when the user presses **+1** or **-1**, the status of the parent component changes and the **build** method is executed again. In this case, a new **CountDownComponent** instance is created. The **countDownStartValue** attribute of the parent component is used to initialize the **@Prop** decorated variable of the child component. When the **count - costOfOneAttempt** button of the child component is touched, the value of the **@Prop** decorated variable **count** is changed. As a result, the **CountDownComponent** is rendered again. However, the change of the **count** value does not affect the **countDownStartValue** value of the parent component.
+
+```ts
+// xxx.ets
+@Entry
+@Component
+struct ParentComponent {
+ @State countDownStartValue: number = 10 // Initialize countDownStartValue
+
+ build() {
+ Column() {
+ Text(`Grant ${this.countDownStartValue} nuggets to play.`).fontSize(18)
+ Button('+1 - Nuggets in New Game')
+ .margin(15)
+ .onClick(() => {
+ this.countDownStartValue += 1
+ })
+
+ Button('-1 - Nuggets in New Game')
+ .margin(15)
+ .onClick(() => {
+ this.countDownStartValue -= 1
+ })
+ // When creating a child component, you must provide the initial value of its @Prop decorated variable count in the constructor parameter and initialize the regular variable costOfOneAttempt (not @Prop decorated).
+ CountDownComponent({ count: this.countDownStartValue, costOfOneAttempt: 2 })
+ }
+ }
+}
+
+@Component
+struct CountDownComponent {
+ @Prop count: number
+ private costOfOneAttempt: number
+
+ build() {
+ Column() {
+ if (this.count > 0) {
+ Text(`You have ${this.count} Nuggets left`).fontSize(18)
+ } else {
+ Text('Game over!').fontSize(18)
+ }
+
+ Button('count - costOfOneAttempt')
+ .margin(15)
+ .onClick(() => {
+ this.count -= this.costOfOneAttempt
+ })
+ }
+ }
+}
+```
+
+
+## @Link
+
+Two-way binding can be established between the **@Link** decorated variable and the **@State** decorated variable of the parent component. The **@Link** data has the following features:
+
+- Support for multiple types: The **@Link** decorated variables support the data types the same as the **@State** decorated variables; that is, the value can be of the following types: class, number, string, boolean, or arrays of these types.
+- Private: Data is accessed only within the component.
+- Single data source: The variable of the parent component used for initializing the **@Link** decorated variable must be a **@State** decorated variable.
+- **Two-way binding**: When a child component changes the **@Link** decorated variable, the **@State** decorated variable of its parent component is also changed.
+- Support for initialization with the variable reference passed to the @Link decorated variable: When creating an instance of the component, you must use the naming parameter to initialize all **@Link** decorated variables. **@Link** decorated variables can be initialized by using the reference of the **@State** or **@Link** decorated variable. Wherein, the **@State** decorated variables can be referenced using the **'$'** operator.
+
+> **NOTE**
+>
+> **@Link** decorated variables cannot be initialized within the component.
+
+**Simple Type Example**
+
+The **@Link** semantics are derived from the '**$**' operator. In other words, **$isPlaying** is the two-way binding of the internal state **this.isPlaying**. When the button in the **PlayButton** child component is touched, the value of the **@Link** decorated variable is changed, and **PlayButton** together with the **\** and **\** components of the parent component is refreshed. Similarly, when the button in the parent component is touched, the value of **this.isPlaying** is changed, and **PlayButton** together with the **\** and **\** components of the parent component is refreshed.
+
+```ts
+// xxx.ets
+@Entry
+@Component
+struct Player {
+ @State isPlaying: boolean = false
+
+ build() {
+ Column() {
+ PlayButton({ buttonPlaying: $isPlaying })
+ Text(`Player is ${this.isPlaying ? '' : 'not'} playing`).fontSize(18)
+ Button('Parent:' + this.isPlaying)
+ .margin(15)
+ .onClick(() => {
+ this.isPlaying = !this.isPlaying
+ })
+ }
+ }
+}
+
+@Component
+struct PlayButton {
+ @Link buttonPlaying: boolean
+
+ build() {
+ Column() {
+ Button(this.buttonPlaying ? 'pause' : 'play')
+ .margin(20)
+ .onClick(() => {
+ this.buttonPlaying = !this.buttonPlaying
+ })
+ }
+ }
+}
+```
+
+**Complex Type Example**
+
+```ts
+// xxx.ets
+@Entry
+@Component
+struct Parent {
+ @State arr: number[] = [1, 2, 3]
+
+ build() {
+ Column() {
+ Child({ items: $arr })
+ Button('Parent Button: splice')
+ .margin(10)
+ .onClick(() => {
+ this.arr.splice(0, 1, 60)
+ })
+ ForEach(this.arr, item => {
+ Text(item.toString()).fontSize(18).margin(10)
+ }, item => item.toString())
+ }
+ }
+}
+
+
+@Component
+struct Child {
+ @Link items: number[]
+
+ build() {
+ Column() {
+ Button('Child Button1: push')
+ .margin(15)
+ .onClick(() => {
+ this.items.push(100)
+ })
+ Button('Child Button2: replace whole item')
+ .margin(15)
+ .onClick(() => {
+ this.items = [100, 200, 300]
+ })
+ }
+ }
+}
+```
+
+**Example of Using @Link, @State, and @Prop Together**
+
+In the following example, **ParentView** contains two child components: **ChildA** and **ChildB**. The **counter** state variable of **ParentView** is used to initialize the **@Prop** decorated variable of **ChildA** and the **@Link** decorated variable of **ChildB**.
+
+- **@Link** establishes two-way binding between **ChildB** and **ParentView**.Value changes of the **counterRef** state variable in **ChildB** will be synchronized to **ParentView** and **ChildA**.
+- **@Prop** establishes one-way binding between **ChildA** and **ParentView**. Value changes of the **counterVal** state variable in **ChildA** will trigger a re-render of **ChildA**, but will not be synchronized to **ParentView** or **ChildB**.
+
+```ts
+// xxx.ets
+@Entry
+@Component
+struct ParentView {
+ @State counter: number = 0
+
+ build() {
+ Column() {
+ ChildA({ counterVal: this.counter })
+ ChildB({ counterRef: $counter })
+ }
+ }
+}
+
+@Component
+struct ChildA {
+ @Prop counterVal: number
+
+ build() {
+ Button(`ChildA: (${this.counterVal}) + 1`)
+ .margin(15)
+ .onClick(() => {
+ this.counterVal += 1
+ })
+ }
+}
+
+@Component
+struct ChildB {
+ @Link counterRef: number
+
+ build() {
+ Button(`ChildB: (${this.counterRef}) + 1`)
+ .margin(15)
+ .onClick(() => {
+ this.counterRef += 1
+ })
+ }
+}
+```
+
+## @Observed and @ObjectLink
+
+When you need to set up bidirectional synchronization for a parent variable (**parent_a**) between the parent and child components, you can use **@State** to decorate the variable (**parent_a**) in the parent component and use **@Link** to decorate the corresponding variable (**child_a**) in the child component. In this way, data can be synchronized between the parent component and the specific child component, and between the parent component and its other child components. As shown below, bidirectional synchronization is configured for variables of **ClassA** in the parent and child components. If attribute **c** of the variable in child component 1 has its value changed, the parent component will be notified to synchronize the change. If attribute **c** in the parent component has its value changed, all child components will be notified to synchronize the change.
+
+
+
+In the preceding example, full synchronization is performed for a data object. If you want to synchronize partial information of a data object in a parent component, and if the information is a class object, use **@ObjectLink** and **@Observed** instead, as shown below.
+
+
+
+### Configuration Requirements
+
+- **@Observed** applies to classes, and **@ObjectLink** applies to variables.
+
+- The variables decorated by **@ObjectLink** must be of the class type.
+ - The classes must be decorated by **@Observed**.
+ - Parameters of the simple types are not supported. You can use **@Prop** to perform unidirectional synchronization.
+
+- **@ObjectLink** decorated variables are immutable.
+ - Attribute changes are allowed. If an object is referenced by multiple **@ObjectLink** decorated variables, all custom components that have these variables will be notified for re-rendering.
+
+- Default values cannot be set for **@ObjectLink** decorated variables.
+ - The parent component must be initialized with a TypeScript expression that involves variables decorated by **@State**, **@Link**, **@StorageLink**, **@Provide**, or **@Consume**.
+
+- **@ObjectLink** decorated variables are private variables and can be accessed only within the component.
+
+
+### Example
+
+```ts
+// xxx.ets
+// Use @ObjectLink and @Observed to set up bidirectional synchronization for the class object ClassA between the parent component ViewB and the child component ViewA. In this way, changes made to ClassA in ViewA will be synchronized to ViewB and other child components bound to ClassA.
+var nextID: number = 0
+
+@Observed
+class ClassA {
+ public name: string
+ public c: number
+ public id: number
+
+ constructor(c: number, name: string = 'OK') {
+ this.name = name
+ this.c = c
+ this.id = nextID++
+ }
+}
+
+@Component
+struct ViewA {
+ label: string = 'ViewA1'
+ @ObjectLink a: ClassA
+
+ build() {
+ Row() {
+ Button(`ViewA [${this.label}] this.a.c= ${this.a.c} +1`)
+ .onClick(() => {
+ this.a.c += 1
+ })
+ }.margin({ top: 10 })
+ }
+}
+
+@Entry
+@Component
+struct ViewB {
+ @State arrA: ClassA[] = [new ClassA(0), new ClassA(0)]
+
+ build() {
+ Column() {
+ ForEach(this.arrA, (item) => {
+ ViewA({ label: `#${item.id}`, a: item })
+ }, (item) => item.id.toString())
+ ViewA({ label: `this.arrA[first]`, a: this.arrA[0] })
+ ViewA({ label: `this.arrA[last]`, a: this.arrA[this.arrA.length - 1] })
+
+ Button(`ViewB: reset array`)
+ .margin({ top: 10 })
+ .onClick(() => {
+ this.arrA = [new ClassA(0), new ClassA(0)]
+ })
+ Button(`ViewB: push`)
+ .margin({ top: 10 })
+ .onClick(() => {
+ this.arrA.push(new ClassA(0))
+ })
+ Button(`ViewB: shift`)
+ .margin({ top: 10 })
+ .onClick(() => {
+ this.arrA.shift()
+ })
+ }.width('100%')
+ }
+}
+```
+
+
+## @Consume and @Provide
+
+As the data provider, **@Provide** can update the data of child nodes and trigger page rendering. After **@Consume** detects that the **@Provide** decorated variable is updated, it will initiate re-rendering of the current custom component.
+
+> **NOTE**
+>
+> To avoid infinite loops caused by circular reference, exercise caution when using **@Provide** and **@Consume**.
+
+### @Provide
+
+| Name | Description |
+| -------------- | ------------------------------------------------------------ |
+| Decorator parameter | A constant of the string type, which is used to set an alias for a decorated variable. If an alias is specified, implement the data update for this alias. If there is no alias, use the variable name as the alias. **@Provide(*'alias'*)** is recommended.|
+| Synchronization mechanism | The **@Provide** decorated variable is similar to the **@State** decorated variable. You can change the value of the variable to trigger a re-render. You can also modify the **@Consume** decorated variable to modify the **@State** decorated variable reversely.|
+| Initial value | The initial value must be set. |
+| Page re-rendering scenarios| Page re-rendering is triggered in the following scenarios: = [7, 12, 47, 3]
+ @State totalPurchase: number = 0
+ @State addPurchase: number = 0
+
+ aboutToAppear() {
+ this.updateTotal()
+ }
+
+ updateTotal(): number {
+ let sum = 0;
+ this.shopBasket.forEach((i) => {
+ sum += i
+ })
+ // Calculate the total amount of items in the shopping basket. If the amount exceeds 100, the specified discount will be applied.
+ this.totalPurchase = (sum < 100) ? sum : 0.9 * sum
+ return this.totalPurchase
+ }
+
+ // This method is triggered when the value of shopBasket is changed.
+ onBasketUpdated(propName: string): void {
+ this.updateTotal()
+ }
+
+ build() {
+ Column() {
+ Button('add to basket ' + this.addPurchase)
+ .margin(15)
+ .onClick(() => {
+ this.addPurchase = Math.round(100 * Math.random())
+ this.shopBasket.push(this.addPurchase)
+ })
+ Text(`${this.totalPurchase}`)
+ .fontSize(30)
+ }
+ }
+}
+```
diff --git a/en/application-dev/quick-start/deveco-studio-user-guide-for-openharmony.md b/en/application-dev/quick-start/deveco-studio-user-guide-for-openharmony.md
index 71cc213f3ba56b31af7c5f1b4dc7bc9bb924b1fd..686f31abb33cb3f08bc4660198e1590325622dbf 100644
--- a/en/application-dev/quick-start/deveco-studio-user-guide-for-openharmony.md
+++ b/en/application-dev/quick-start/deveco-studio-user-guide-for-openharmony.md
@@ -13,4 +13,4 @@ HUAWEI DevEco Studio For OpenHarmony (DevEco Studio for short) is a one-stop int
- **One-stop information acquisition**: A one-stop information acquisition platform that takes into account the developer journey of learning, development, and help seeking, in order to facilitate developer activities.
- **Efficient code debugging**: Various debugging capabilities such as TS, JS, and C/C++ code breakpoint setting, single-step execution, and variable viewing, improving the efficiency of analyzing application/service issues.
-For more information, see [DevEco Studio (OpenHarmony) User Guide](https://developer.harmonyos.com/en/docs/documentation/doc-guides/ohos-deveco-studio-overview-0000001263280421).
+For more information, see [DevEco Studio User Guide (OpenHarmony)](https://developer.harmonyos.com/en/docs/documentation/doc-guides/ohos-deveco-studio-overview-0000001263280421).
diff --git a/en/application-dev/quick-start/figures/01.png b/en/application-dev/quick-start/figures/01.png
index cb9ddd68fc3ee2e6e15700a6a7a5d9e6ff1f4cc7..8342856ec6643e20a941187852e6aef3ead11010 100644
Binary files a/en/application-dev/quick-start/figures/01.png and b/en/application-dev/quick-start/figures/01.png differ
diff --git a/en/application-dev/quick-start/figures/02.png b/en/application-dev/quick-start/figures/02.png
index 4fd0a6d3e60c0a22a9b69ea9f46fe62050d37a7e..19dd76ca232282b19883dde63075c5d155e7db70 100644
Binary files a/en/application-dev/quick-start/figures/02.png and b/en/application-dev/quick-start/figures/02.png differ
diff --git a/en/application-dev/quick-start/figures/04.png b/en/application-dev/quick-start/figures/04.png
index 2d66f7513893e83e4e897ed63319316d9f5bd40e..cf23d17c7ee8552e30a5b234c97862b51981dcf8 100644
Binary files a/en/application-dev/quick-start/figures/04.png and b/en/application-dev/quick-start/figures/04.png differ
diff --git a/en/application-dev/quick-start/figures/07.png b/en/application-dev/quick-start/figures/07.png
index 1a232454b8485269d473611b126489c87d2f82d9..0f34d01d824ae1780c73cade9a39fff5f4b9b84e 100644
Binary files a/en/application-dev/quick-start/figures/07.png and b/en/application-dev/quick-start/figures/07.png differ
diff --git a/en/application-dev/quick-start/figures/09.png b/en/application-dev/quick-start/figures/09.png
index ac6dbbab11846274c42bfdd61f7bd5dfe0ace99f..2c08d85c610336a71b06407800603ed5c101606d 100644
Binary files a/en/application-dev/quick-start/figures/09.png and b/en/application-dev/quick-start/figures/09.png differ
diff --git a/en/application-dev/ui/figures/en-us_image_0000001222967768.png b/en/application-dev/quick-start/figures/CoreSpec_figures_state-mgmt-overview.png
similarity index 100%
rename from en/application-dev/ui/figures/en-us_image_0000001222967768.png
rename to en/application-dev/quick-start/figures/CoreSpec_figures_state-mgmt-overview.png
diff --git a/en/application-dev/quick-start/figures/appstorage.gif b/en/application-dev/quick-start/figures/appstorage.gif
new file mode 100644
index 0000000000000000000000000000000000000000..c500542314c4d9182155122729e6b7b15e3abc16
Binary files /dev/null and b/en/application-dev/quick-start/figures/appstorage.gif differ
diff --git a/en/application-dev/quick-start/figures/appstorage1.gif b/en/application-dev/quick-start/figures/appstorage1.gif
new file mode 100644
index 0000000000000000000000000000000000000000..1b61274beda905c252825ad7e821aec92b93cdc0
Binary files /dev/null and b/en/application-dev/quick-start/figures/appstorage1.gif differ
diff --git a/en/application-dev/quick-start/figures/appstorage2.gif b/en/application-dev/quick-start/figures/appstorage2.gif
new file mode 100644
index 0000000000000000000000000000000000000000..c56396af8365fd8fcf8b5d019c25d628828303fc
Binary files /dev/null and b/en/application-dev/quick-start/figures/appstorage2.gif differ
diff --git a/en/application-dev/quick-start/figures/appstorage3.gif b/en/application-dev/quick-start/figures/appstorage3.gif
new file mode 100644
index 0000000000000000000000000000000000000000..1538d1218f4f0ed987e50b4bb97d9abdb56781dc
Binary files /dev/null and b/en/application-dev/quick-start/figures/appstorage3.gif differ
diff --git a/en/application-dev/quick-start/figures/arkts-get-started.png b/en/application-dev/quick-start/figures/arkts-get-started.png
new file mode 100644
index 0000000000000000000000000000000000000000..8858c1d09bc4624ad9ace341b8d4aff2f2c4f2fa
Binary files /dev/null and b/en/application-dev/quick-start/figures/arkts-get-started.png differ
diff --git a/en/application-dev/quick-start/figures/builder.PNG b/en/application-dev/quick-start/figures/builder.PNG
new file mode 100644
index 0000000000000000000000000000000000000000..2f7d50693ba58a78fb0c42b12cf4d924d398dcd4
Binary files /dev/null and b/en/application-dev/quick-start/figures/builder.PNG differ
diff --git a/en/application-dev/quick-start/figures/builder1.PNG b/en/application-dev/quick-start/figures/builder1.PNG
new file mode 100644
index 0000000000000000000000000000000000000000..4b78a289a0878cd120370ce1eaae8ef66c56a591
Binary files /dev/null and b/en/application-dev/quick-start/figures/builder1.PNG differ
diff --git a/en/application-dev/quick-start/figures/builder2.gif b/en/application-dev/quick-start/figures/builder2.gif
new file mode 100644
index 0000000000000000000000000000000000000000..9b79d29ea8d25e4838f7bf798b00e7162d9ed3e7
Binary files /dev/null and b/en/application-dev/quick-start/figures/builder2.gif differ
diff --git a/en/application-dev/quick-start/figures/create-resource-file-1.png b/en/application-dev/quick-start/figures/create-resource-file-1.png
new file mode 100644
index 0000000000000000000000000000000000000000..0bb0d4933957d0f0ef984e47e71851bf4bb0c307
Binary files /dev/null and b/en/application-dev/quick-start/figures/create-resource-file-1.png differ
diff --git a/en/application-dev/quick-start/figures/create-resource-file-2.png b/en/application-dev/quick-start/figures/create-resource-file-2.png
new file mode 100644
index 0000000000000000000000000000000000000000..d8231462cb4cab37469b25608952425981e4f77a
Binary files /dev/null and b/en/application-dev/quick-start/figures/create-resource-file-2.png differ
diff --git a/en/application-dev/quick-start/figures/create-resource-file-3.png b/en/application-dev/quick-start/figures/create-resource-file-3.png
new file mode 100644
index 0000000000000000000000000000000000000000..10ab868a26bf23e9fc4680cc010ae875e3113ca9
Binary files /dev/null and b/en/application-dev/quick-start/figures/create-resource-file-3.png differ
diff --git a/en/application-dev/quick-start/figures/customDialog.gif b/en/application-dev/quick-start/figures/customDialog.gif
new file mode 100644
index 0000000000000000000000000000000000000000..e3788315f506df46d95b321a910cf81092677202
Binary files /dev/null and b/en/application-dev/quick-start/figures/customDialog.gif differ
diff --git a/en/application-dev/quick-start/figures/en-us_image_0000001206450834.png b/en/application-dev/quick-start/figures/en-us_image_0000001206450834.png
new file mode 100644
index 0000000000000000000000000000000000000000..09f645d7cb10a3b1a2ab1c6fd96977fa09e998d9
Binary files /dev/null and b/en/application-dev/quick-start/figures/en-us_image_0000001206450834.png differ
diff --git a/en/application-dev/quick-start/figures/en-us_image_0000001251090821.png b/en/application-dev/quick-start/figures/en-us_image_0000001251090821.png
new file mode 100644
index 0000000000000000000000000000000000000000..a5cbcc41016469693a6a7316f5c54efd34f7cd1a
Binary files /dev/null and b/en/application-dev/quick-start/figures/en-us_image_0000001251090821.png differ
diff --git a/en/application-dev/quick-start/figures/en-us_image_0000001311175120.png b/en/application-dev/quick-start/figures/en-us_image_0000001311175120.png
deleted file mode 100644
index 12978dc861aaa1f826404d9c6838bb8628381615..0000000000000000000000000000000000000000
Binary files a/en/application-dev/quick-start/figures/en-us_image_0000001311175120.png and /dev/null differ
diff --git a/en/application-dev/quick-start/figures/en-us_image_0000001311175132.png b/en/application-dev/quick-start/figures/en-us_image_0000001311175132.png
index 2f401b2f8aa84e89bdef25bcf615ff1a621ab6d6..5eb654b04cbb85cda6e910949cd6312db6e1f969 100644
Binary files a/en/application-dev/quick-start/figures/en-us_image_0000001311175132.png and b/en/application-dev/quick-start/figures/en-us_image_0000001311175132.png differ
diff --git a/en/application-dev/quick-start/figures/en-us_image_0000001311334944.png b/en/application-dev/quick-start/figures/en-us_image_0000001311334944.png
index 9ce82237297b06c04113d0368d7145661de0d997..9f98b8a28700b08b1bbed0c7a42bdb827fd64667 100644
Binary files a/en/application-dev/quick-start/figures/en-us_image_0000001311334944.png and b/en/application-dev/quick-start/figures/en-us_image_0000001311334944.png differ
diff --git a/en/application-dev/quick-start/figures/en-us_image_0000001311334972.png b/en/application-dev/quick-start/figures/en-us_image_0000001311334972.png
deleted file mode 100644
index 6499d0b2de7ee290b958059d13d9d19995e0e511..0000000000000000000000000000000000000000
Binary files a/en/application-dev/quick-start/figures/en-us_image_0000001311334972.png and /dev/null differ
diff --git a/en/application-dev/quick-start/figures/en-us_image_0000001311334976.png b/en/application-dev/quick-start/figures/en-us_image_0000001311334976.png
index 7891c03e8fab1eaaf6159964fc338e0be9bb080a..fbbde9923a131d3ab69257b28cfe33ca2a1040cf 100644
Binary files a/en/application-dev/quick-start/figures/en-us_image_0000001311334976.png and b/en/application-dev/quick-start/figures/en-us_image_0000001311334976.png differ
diff --git a/en/application-dev/quick-start/figures/en-us_image_0000001311494580.png b/en/application-dev/quick-start/figures/en-us_image_0000001311494580.png
deleted file mode 100644
index 6c1ea01d448434e7cfd94e174474e72b57d3b4cc..0000000000000000000000000000000000000000
Binary files a/en/application-dev/quick-start/figures/en-us_image_0000001311494580.png and /dev/null differ
diff --git a/en/application-dev/quick-start/figures/en-us_image_0000001311494592.png b/en/application-dev/quick-start/figures/en-us_image_0000001311494592.png
index a88a2ec512c0fa4f374d1e9ac03a27c717aeab58..a8fac2a024e51aeb0439463dab83f2763fa3fa76 100644
Binary files a/en/application-dev/quick-start/figures/en-us_image_0000001311494592.png and b/en/application-dev/quick-start/figures/en-us_image_0000001311494592.png differ
diff --git a/en/application-dev/quick-start/figures/en-us_image_0000001311494604.png b/en/application-dev/quick-start/figures/en-us_image_0000001311494604.png
deleted file mode 100644
index 6c1ea01d448434e7cfd94e174474e72b57d3b4cc..0000000000000000000000000000000000000000
Binary files a/en/application-dev/quick-start/figures/en-us_image_0000001311494604.png and /dev/null differ
diff --git a/en/application-dev/quick-start/figures/en-us_image_0000001363934577.png b/en/application-dev/quick-start/figures/en-us_image_0000001363934577.png
deleted file mode 100644
index 6499d0b2de7ee290b958059d13d9d19995e0e511..0000000000000000000000000000000000000000
Binary files a/en/application-dev/quick-start/figures/en-us_image_0000001363934577.png and /dev/null differ
diff --git a/en/application-dev/quick-start/figures/en-us_image_0000001363934589.png b/en/application-dev/quick-start/figures/en-us_image_0000001363934589.png
deleted file mode 100644
index 2f401b2f8aa84e89bdef25bcf615ff1a621ab6d6..0000000000000000000000000000000000000000
Binary files a/en/application-dev/quick-start/figures/en-us_image_0000001363934589.png and /dev/null 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
index a69b0c6f3b047e5961b05b40b663ce972a90b459..bcc45efdddb87a39201661c5f6d3ccbce9bfd3e6 100644
Binary files a/en/application-dev/quick-start/figures/en-us_image_0000001364054489.png and b/en/application-dev/quick-start/figures/en-us_image_0000001364054489.png differ
diff --git a/en/application-dev/quick-start/figures/en-us_image_0000001364173989.png b/en/application-dev/quick-start/figures/en-us_image_0000001364173989.png
deleted file mode 100644
index f4b6f516a8340914c41600ef24012dd3699648b6..0000000000000000000000000000000000000000
Binary files a/en/application-dev/quick-start/figures/en-us_image_0000001364173989.png and /dev/null differ
diff --git a/en/application-dev/quick-start/figures/en-us_image_0000001364174013.png b/en/application-dev/quick-start/figures/en-us_image_0000001364174013.png
deleted file mode 100644
index 12978dc861aaa1f826404d9c6838bb8628381615..0000000000000000000000000000000000000000
Binary files a/en/application-dev/quick-start/figures/en-us_image_0000001364174013.png and /dev/null differ
diff --git a/en/application-dev/quick-start/figures/en-us_image_0000001364254729.png b/en/application-dev/quick-start/figures/en-us_image_0000001364254729.png
index 7fba7aab32a92752b341af024ef97e5acfe3d73d..164371727ee8a351e2c42f4b3ecab9175e088e7c 100644
Binary files a/en/application-dev/quick-start/figures/en-us_image_0000001364254729.png and b/en/application-dev/quick-start/figures/en-us_image_0000001364254729.png differ
diff --git a/en/application-dev/quick-start/figures/en-us_image_0000001364254741.png b/en/application-dev/quick-start/figures/en-us_image_0000001364254741.png
deleted file mode 100644
index fbbde9923a131d3ab69257b28cfe33ca2a1040cf..0000000000000000000000000000000000000000
Binary files a/en/application-dev/quick-start/figures/en-us_image_0000001364254741.png and /dev/null differ
diff --git a/en/application-dev/quick-start/figures/en-us_image_0000001364254773.png b/en/application-dev/quick-start/figures/en-us_image_0000001364254773.png
deleted file mode 100644
index 6499d0b2de7ee290b958059d13d9d19995e0e511..0000000000000000000000000000000000000000
Binary files a/en/application-dev/quick-start/figures/en-us_image_0000001364254773.png and /dev/null differ
diff --git a/en/application-dev/quick-start/figures/en-us_image_0000001384652328.png b/en/application-dev/quick-start/figures/en-us_image_0000001384652328.png
new file mode 100644
index 0000000000000000000000000000000000000000..e1ece174d44626d95ded4be698531937bde650a3
Binary files /dev/null and b/en/application-dev/quick-start/figures/en-us_image_0000001384652328.png differ
diff --git a/en/application-dev/quick-start/figures/en-us_image_0000001435376433.png b/en/application-dev/quick-start/figures/en-us_image_0000001435376433.png
new file mode 100644
index 0000000000000000000000000000000000000000..45a608777708de9a4e8fbe6148974b489aa0388d
Binary files /dev/null and b/en/application-dev/quick-start/figures/en-us_image_0000001435376433.png differ
diff --git a/en/application-dev/quick-start/figures/extend.PNG b/en/application-dev/quick-start/figures/extend.PNG
new file mode 100644
index 0000000000000000000000000000000000000000..cf1c87c65db58084c8a62124c1f41f2b829c90cb
Binary files /dev/null and b/en/application-dev/quick-start/figures/extend.PNG differ
diff --git a/en/application-dev/quick-start/figures/hello.PNG b/en/application-dev/quick-start/figures/hello.PNG
new file mode 100644
index 0000000000000000000000000000000000000000..8098a2fc4ae0322c1a5b5a12d7cc0eb72ad073f5
Binary files /dev/null and b/en/application-dev/quick-start/figures/hello.PNG differ
diff --git a/en/application-dev/quick-start/figures/popup.gif b/en/application-dev/quick-start/figures/popup.gif
new file mode 100644
index 0000000000000000000000000000000000000000..35c61c38947aea3c09c49e240fcc19bdb91e943f
Binary files /dev/null and b/en/application-dev/quick-start/figures/popup.gif differ
diff --git a/en/application-dev/quick-start/figures/styles.PNG b/en/application-dev/quick-start/figures/styles.PNG
new file mode 100644
index 0000000000000000000000000000000000000000..46e3c761e72854f16a78e7cb3a0518a3d39e79e5
Binary files /dev/null and b/en/application-dev/quick-start/figures/styles.PNG differ
diff --git a/en/application-dev/quick-start/figures/styles1.gif b/en/application-dev/quick-start/figures/styles1.gif
new file mode 100644
index 0000000000000000000000000000000000000000..7b72040aeaea3260bf9ccfdce0495d911d5752be
Binary files /dev/null and b/en/application-dev/quick-start/figures/styles1.gif differ
diff --git a/en/application-dev/quick-start/full-sdk-switch-guide.md b/en/application-dev/quick-start/full-sdk-switch-guide.md
index a687d69b739e12893aff91fb2e6939eb1b32aad0..818249975bfd00cd582414549237f955fec1fcb8 100644
--- a/en/application-dev/quick-start/full-sdk-switch-guide.md
+++ b/en/application-dev/quick-start/full-sdk-switch-guide.md
@@ -16,7 +16,7 @@ Manually download the system-specific full SDK package from the mirror. For deta
## Checking the Local SDK Location
-In this example, an eTS project is used. For a JS project, replace **ets** with **js**.
+In this example, an ArkTS project is used. For a JS project, replace **ets** with **js**.
In DevEco Studio, choose **Tools** > **OpenHarmony SDK Manager** to check the location of the local SDK.
diff --git a/en/application-dev/quick-start/resource-categories-and-access.md b/en/application-dev/quick-start/resource-categories-and-access.md
new file mode 100644
index 0000000000000000000000000000000000000000..d1d342fe74eaed80516a7ca554cbe84f84ad927c
--- /dev/null
+++ b/en/application-dev/quick-start/resource-categories-and-access.md
@@ -0,0 +1,287 @@
+# Resource Categories and Access
+
+During application development, you may need to use different resources, such as colors, fonts, spacing, and images, based on the device or configuration. Depending on the resource type, you can achieve this using the following methods:
+
+- Application resources: Configure device- or configuration-specific resources in the resource files.
+
+- System resources: Use the preset resource definitions.
+
+## Resource Categories
+
+### resources Directory
+
+Resource files used during application development must be stored in specified directories for management. The **resources** directory consists of three types of subdirectories: the **base** subdirectory, qualifiers subdirectories, and the **rawfile** subdirectory. The common resource files used across projects in the stage model are stored in the **resources** directory under **AppScope**.
+
+The **base** subdirectory is provided by default, and the qualifiers subdirectories are created on your own. When your application needs to use a resource, the system preferentially searches the qualifiers subdirectories that match the current device state. The system searches the **base** subdirectory for the target resource only when the **resources** directory does not contain any qualifiers subdirectories that match the current device state or the target resource is not found in the qualifiers subdirectories. The **rawfile** directory is not searched for resources.
+
+Example of the **resources** directory:
+
+```
+resources
+|---base // Default directory
+| |---element
+| | |---string.json
+| |---media
+| | |---icon.png
+|---en_GB-vertical-car-mdpi // Example of a qualifiers subdirectory, which needs to be created on your own
+| |---element
+| | |---string.json
+| |---media
+| | |---icon.png
+|---rawfile
+```
+
+**Table 1** Classification of the resources directory
+
+| Category | base Subdirectory | Qualifiers Subdirectory | rawfile Subdirectory |
+| ---- | ---------------------------------------- | ---------------------------------------- | ---------------------------------------- |
+| Structure| The **base** subdirectory is a default directory. If no qualifiers subdirectories in the **resources** directory of the application match the device status, the resource file in the **base** subdirectory will be automatically referenced.** component.
After the project synchronization is complete, choose **entry** > **src** > **main** > **ets** > **MainAbility** > **pages** in the **Project** window and open the **index.ets** file. You can see that the file contains a **\** component. The sample code in the **index.ets** file is shown below:
-
```ts
// index.ets
@@ -78,7 +79,6 @@
2. Add a **\** component.
On the default page, add a **\** component to respond to user clicks and implement redirection to another page. The sample code in the **index.ets** file is shown below:
-
```ts
// index.ets
@@ -116,18 +116,18 @@
3. On the toolbar in the upper right corner of the editing window, click **Previewer**. Below is how the first page looks in the Previewer.
- 
+ 
## Building the Second Page
1. Create the second page.
- - Create the second page file: In the **Project** window, choose **entry** > **src** > **main** > **ets** > **MainAbility**. Right-click the **pages** folder, choose **New** > **eTS File**, name the page **second**, and click **Finish**. Below is the structure of the **second** folder.
-
+ - Create the second page file: In the **Project** window, choose **entry** > **src** > **main** > **ets** > **MainAbility**. Right-click the **pages** folder, choose **New** > **ArkTS File**, name the page **second**, and click **Finish**. Below is the structure of the **second** folder.
> **NOTE**
+ >
> You can also right-click the **pages** folder and choose **New** > **Page** from the shortcut menu. In this scenario, you do not need to manually configure page routes.
- Configure the route for the second page, by setting **pages/second** under **module - js - pages** in the **config.json** The sample code is as follows: The sample code is as follows:
@@ -149,7 +149,6 @@
2. Add **\** and **\** components.
Add **\** and **\** components and set their styles, as you do for the first page. The sample code in the **second.ets** file is shown below:
-
```ts
// second.ets
@@ -187,15 +186,15 @@
## Implementing Page Redirection
-You can implement page redirection through the [page router](../reference/apis/js-apis-router.md#routerpush), which finds the target page based on the page URL. Import the **router** module and then perform the steps below:
+You can implement page redirection through the [page router](../reference/apis/js-apis-router.md), which finds the target page based on the page URL. Import the **router** module and then perform the steps below:
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:
-
```ts
// index.ets
+ // Import the router module.
import router from '@ohos.router';
@Entry
@@ -237,10 +236,10 @@ You can implement page redirection through the [page router](../reference/apis/j
2. Implement redirection from the second page to the first page.
In the **second.ets** file of the second page, bind the **onClick** event to the **Back** button so that clicking the button redirects the user back to the first page. The sample code in the **second.ets** file is shown below:
-
```ts
// second.ets
+ // Import the router module.
import router from '@ohos.router';
@Entry
@@ -278,9 +277,9 @@ You can implement page redirection through the [page router](../reference/apis/j
}
```
-3. Open the **index.ets** file and click  in the Previewer to refresh the file. The display effect is shown in the figure below.
+3. Open the **index.ets** file and click  in the Previewer to refresh the file. The display effect is shown in the figure below.
- 
+ 
## Running the Application on a Real Device
@@ -291,8 +290,8 @@ You can implement page redirection through the [page router](../reference/apis/j
-3. On the toolbar in the upper right corner of the editing window, click . The display effect is shown in the figure below.
+3. On the toolbar in the upper right corner of the editing window, click . The display effect is shown in the figure below.
- 
+ 
-Congratulations! You have finished developing your OpenHarmony application in eTS in the FA model. To learn more about OpenHarmony application development, see [Application Development Overview](../application-dev-guide.md).
+Congratulations! You have finished developing your OpenHarmony application in ArkTS in the FA model. To learn more about OpenHarmony application development, see [Application Development Overview](../application-dev-guide.md).
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 b6b8cd11b8ba18b59931c1bf0244d4af3d7ec888..a37eb8d3da42490bfc4027ecadbf401f21982444 100644
--- a/en/application-dev/quick-start/start-with-ets-stage.md
+++ b/en/application-dev/quick-start/start-with-ets-stage.md
@@ -1,14 +1,14 @@
-# Getting Started with eTS in Stage Model
+# Getting Started with ArkTS in Stage Model
> **NOTE**
->
-> To use eTS, your DevEco Studio must be V3.0.0.900 Beta3 or later.
->
-> For best possible results, use [DevEco Studio V3.0.0.993](https://developer.harmonyos.com/cn/develop/deveco-studio#download) for your development.
+>
+> To use ArkTS, your DevEco Studio must be V3.0.0.900 Beta3 or later.
+>
+> For best possible results, use [DevEco Studio V3.1.0.100](https://developer.harmonyos.com/cn/develop/deveco-studio) for your development.
-## Creating an eTS Project
+## Creating an ArkTS Project
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. On the **OpenHarmony** tab of the **Choose Your Ability Template** page, select **Empty Ability** and click **Next**.
@@ -29,37 +29,32 @@
3. Click **Finish**. DevEco Studio will automatically generate the sample code and resources that match your project type. Wait until the project is created.
-## eTS Project Directory Structure
+## ArkTS Project Directory Structure (Stage Model)
-- **AppScope > app.json5**: application-level configuration information.
-
- **entry**: OpenHarmony project module, which can be built into an OpenHarmony Ability Package ([HAP](../../glossary.md#hap)).
- **src > main > ets**: a collection of eTS source code.
- - **src > main > ets > Application > AbilityStage.ts**: implementation of AbilityStage APIs.
- - **src > main > ets > MainAbility**: entry to your application/service.
- - **src > main > ets > MainAbility > MainAbility.ets**: ability lifecycle file.
- - **src > main > ets > pages**: pages contained in **MainAbility**.
- - **src > main > resources**: a collection of resource files used by your application/service, such as graphics, multimedia, character strings, and layout files. For details about resource files, see [Resource File Categories](../ui/ui-ts-basic-resource-file-categories.md).
+ - **src > main > ets > entryability**: entry to your application/service.
+ - **src > main > ets > pages**: pages included in your application/service.
+ - **src > main > resources**: a collection of resource files used by your application/service, such as graphics, multimedia, character strings, and layout files. For details about resource files, see [Resource Categories and Access](resource-categories-and-access.md#resource-categories).
- **src > main > module.json5**: module configuration file. This file describes the global configuration information of the application/service, the device-specific configuration information, and the configuration information of the HAP file. For details about the configuration file, see [Application Package Structure Configuration File (Stage Model)](stage-structure.md).
- **build-profile.json5**: current module information and build configuration options, including **buildOption** and **targets**.
- - **hvigorfile.js**: module-level compilation and build task script. You can customize related tasks and code implementation.
+ - **hvigorfile.ts**: module-level build script. You can customize related tasks and code implementation.
- **build-profile.json5**: application-level configuration information, including the signature and product configuration.
-- **hvigorfile.js**: application-level compilation and build task script.
+- **hvigorfile.ts**: application-level build script.
## Building the First Page
1. Use the **\** component.
- After the project synchronization is complete, choose **entry** > **src** > **main** > **ets** > **MainAbility** > **pages** in the **Project** window and open the **index.ets** file. You can see that the file contains a **\** component. The sample code in the **index.ets** file is shown below:
-
+ After the project synchronization is complete, choose **entry** > **src** > **main** > **ets** > **pages** in the **Project** window and open the **Index.ets** file. You can see that the file contains a **\** component. The sample code in the **Index.ets** file is shown below:
```ts
- // index.ets
+ // Index.ets
@Entry
@Component
struct Index {
@@ -81,11 +76,10 @@
2. Add a **\** component.
- On the default page, add a **\** component to respond to user clicks and implement redirection to another page. The sample code in the **index.ets** file is shown below:
-
+ On the default page, add a **\** component to respond to user clicks and implement redirection to another page. The sample code in the **Index.ets** file is shown below:
```ts
- // index.ets
+ // Index.ets
@Entry
@Component
struct Index {
@@ -127,30 +121,30 @@
1. Create the second page.
- - Create the second page file: In the **Project** window, choose **entry** > **src** > **main** > **ets**. Right-click the **pages** folder, choose **New** > **eTS File**, name the page **second**, and click **Finish**. Below is the structure of the **second** folder.
+ - Create the second page file: In the **Project** window, choose **entry** > **src** > **main** > **ets**. Right-click the **pages** folder, choose **New** > **ArkTS File**, name the page **Second**, and click **Finish**. Below is the structure of the **Second** folder.
> **NOTE**
+ >
> You can also right-click the **pages** folder and choose **New** > **Page** from the shortcut menu. In this scenario, you do not need to manually configure page routes.
- - Configure the route for the second page: In the **Project** window, choose **entry** > **src** > **main** > **resources** > **base** > **profile**. In the **main_pages.json** file, set **pages/second** under **src**. The sample code is as follows:
+ - Configure the route for the second page: In the **Project** window, choose **entry** > **src** > **main** > **resources** > **base** > **profile**. In the **main_pages.json** file, set **pages/Second** under **src**. The sample code is as follows:
```json
{
"src": [
- "pages/index",
- "pages/second"
+ "pages/Index",
+ "pages/Second"
]
}
```
2. Add **\** and **\** components.
- Add **\** and **\** components and set their styles, as you do for the first page. The sample code in the **second.ets** file is shown below:
-
+ Add **\** and **\** components and set their styles, by referring to the first page. The sample code in the **Second.ets** file is shown below:
```ts
- // second.ets
+ // Second.ets
@Entry
@Component
struct Second {
@@ -185,15 +179,15 @@
## Implementing Page Redirection
-You can implement page redirection through the [page router](../reference/apis/js-apis-router.md#routerpush), which finds the target page based on the page URL. Import the **router** module and then perform the steps below:
+You can implement page redirection through the [page router](../reference/apis/js-apis-router.md), which finds the target page based on the page URL. Import the **router** module and then perform the steps below:
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
+ // Index.ets
+ // Import the router module.
import router from '@ohos.router';
@Entry
@@ -222,7 +216,7 @@ You can implement page redirection through the [page router](../reference/apis/j
.height('5%')
// Bind the onClick event to the Next button so that clicking the button redirects the user to the second page.
.onClick(() => {
- router.push({ url: 'pages/second' })
+ router.push({ url: 'pages/Second' })
})
}
.width('100%')
@@ -234,11 +228,11 @@ You can implement page redirection through the [page router](../reference/apis/j
2. Implement redirection from the second page to the first page.
- In the **second.ets** file of the second page, bind the **onClick** event to the **Back** button so that clicking the button redirects the user back to the first page. The sample code in the **second.ets** file is shown below:
-
+ In the **Second.ets** file of the second page, bind the **onClick** event to the **Back** button so that clicking the button redirects the user back to the first page. The sample code in the **Second.ets** file is shown below:
```ts
- // second.ets
+ // Second.ets
+ // Import the router module.
import router from '@ohos.router';
@Entry
@@ -276,9 +270,9 @@ You can implement page redirection through the [page router](../reference/apis/j
}
```
-3. Open the **index.ets** file and click  in the Previewer to refresh the file. The display effect is shown in the figure below.
+3. Open the **Index.ets** file and click  in the Previewer to refresh the file. The display effect is shown in the figure below.
- 
+ 
## Running the Application on a Real Device
@@ -291,6 +285,6 @@ You can implement page redirection through the [page router](../reference/apis/j
3. On the toolbar in the upper right corner of the editing window, click . The display effect is shown in the figure below.
- 
+ 
-Congratulations! You have finished developing your OpenHarmony application in eTS in the stage model. To learn more about OpenHarmony application development, see [Application Development Overview](../application-dev-guide.md).
+Congratulations! You have finished developing your OpenHarmony application in ArkTS in the stage model. To learn more about OpenHarmony application development, see [Application Development Overview](../application-dev-guide.md).
diff --git a/en/application-dev/quick-start/start-with-js-fa.md b/en/application-dev/quick-start/start-with-js-fa.md
index 03b037aeb529dcf7d481caf56db32625943c055b..e0b43711caa931013ca581c40f588fd6f6cfe070 100644
--- a/en/application-dev/quick-start/start-with-js-fa.md
+++ b/en/application-dev/quick-start/start-with-js-fa.md
@@ -17,11 +17,11 @@
> **NOTE**
- >
+ >
> If you are using DevEco Studio V2.2 Beta1 or later, you can use the [low-code development](https://developer.harmonyos.com/en/docs/documentation/doc-guides/ohos-low-code-development-0000001218440652) 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.
3. Click **Finish**. DevEco Studio will automatically generate the sample code and resources that match your project type. Wait until the project is created.
@@ -29,6 +29,8 @@
## JavaScript Project Directory Structure
+
+
- **entry**: OpenHarmony project module, which can be built into an OpenHarmony Ability Package ([HAP](../../glossary.md#hap)).
- **src > main > js**: a collection of JavaScript source code.
- **src > main > js > MainAbility**: entry to your application/service.
@@ -39,11 +41,11 @@
- **src > main > resources**: a collection of resource files used by your application/service, such as graphics, multimedia, character strings, and layout files. For details about resource files, see [Resource Limitations and Access](../ui/js-framework-resource-restriction.md).
- **src > main > config.json**: module configuration file. This file describes the global configuration information of the application/service, the device-specific configuration information, and the configuration information of the HAP file. For details about the configuration file, see [Application Package Structure Configuration File (FA Model)](package-structure.md).
- **build-profile.json5**: current module information and build configuration options, including **buildOption** and **targets**.
- - **hvigorfile.js**: module-level compilation and build task script. You can customize related tasks and code implementation.
+ - **hvigorfile.ts**: module-level build script. You can customize related tasks and code implementation.
- **build-profile.json5**: application-level configuration information, including the signature and product configuration.
-- **hvigorfile.js**: application-level compilation and build task script.
+- **hvigorfile.ts**: application-level build script.
## Building the First Page
@@ -51,7 +53,6 @@
1. Use the **\** component.
After the project synchronization is complete, choose **entry** > **src** > **main** > **js** > **MainAbility** > **pages** > **index** in the **Project** window and open the **index.hml** file. You can see that the file contains a **** component. The sample code in the **index.hml** file is shown below:
-
```html
@@ -65,7 +66,6 @@
2. Add a button and bind the **onclick** method to this button.
On the default page, add a **\** component to respond to user clicks and implement redirection to another page. The sample code in the **index.hml** file is shown below:
-
```html
@@ -82,7 +82,6 @@
3. Set the page style in the **index.css** file.
From the **Project** window, choose **entry** > **src** > **main** > **js** > **MainAbility** > **pages** > **index**, open the **index.css** file, and set the page styles, such as the width, height, font size, and spacing. The sample code in the **index.css** file is shown below:
-
```css
/* index.css */
@@ -131,7 +130,6 @@
2. Add **\** and **\** components.
Add **\** and **\** components and set their styles, as you do for the first page. The sample code in the **second.hml** file is shown below:
-
```html
@@ -181,15 +179,15 @@
## Implementing Page Redirection
-You can implement page redirection through the [page router](../reference/apis/js-apis-router.md#routerpush), which finds the target page based on the page URL. Import the **router** module and then perform the steps below:
+You can implement page redirection through the [page router](../reference/apis/js-apis-router.md), which finds the target page based on the page URL. Import the **router** module and then perform the steps below:
1. Implement redirection from the first page to the second page.
In the **index.js** file of the first page, bind the **onclick** method to the button so that clicking the button redirects the user to the second page. The sample code in the **index.js** file is shown below:
-
```js
// index.js
+ // Import the router module.
import router from '@ohos.router';
export default {
@@ -204,10 +202,10 @@ You can implement page redirection through the [page router](../reference/apis/j
2. Implement redirection from the second page to the first page.
In the **second.ets** file of the second page, bind the **back** method to the **Back** button so that clicking the button redirects the user back to the first page. The sample code in the **second.js** file is shown below:
-
```js
// second.js
+ // Import the router module.
import router from '@ohos.router';
export default {
@@ -217,7 +215,7 @@ You can implement page redirection through the [page router](../reference/apis/j
}
```
-3. Open any file in the **index** folder and click  in the Previewer to refresh the file. The display effect is shown in the figure below.
+3. Open any file in the **index** folder and click  in the Previewer to refresh the file. The display effect is shown in the figure below.
@@ -230,8 +228,8 @@ You can implement page redirection through the [page router](../reference/apis/j
-3. On the toolbar in the upper right corner of the editing window, click . The display effect is shown in the figure below.
+3. On the toolbar in the upper right corner of the editing window, click . The display effect is shown in the figure below.
- 
+ 
Congratulations! You have finished developing your OpenHarmony application in JavaScript in the FA model. To learn more about OpenHarmony application development, see [Application Development Overview](../application-dev-guide.md).
diff --git a/en/application-dev/reference/apis/Readme-EN.md b/en/application-dev/reference/apis/Readme-EN.md
index a9d34533736558a48cb9415f19e6175b458aee94..322ef9541956a428f36cb624f10f05d4df804bd6 100644
--- a/en/application-dev/reference/apis/Readme-EN.md
+++ b/en/application-dev/reference/apis/Readme-EN.md
@@ -1,110 +1,177 @@
# APIs
- [API Reference Document Description](development-intro.md)
+
- Ability Framework
- - FA Model
- - [@ohos.ability.featureAbility](js-apis-featureAbility.md)
- - [@ohos.ability.particleAbility](js-apis-particleAbility.md)
- - ability/[dataAbilityHelper](js-apis-dataAbilityHelper.md)
- - app/[context](js-apis-Context.md)
- - Stage Model
- - [@ohos.application.Ability](js-apis-application-ability.md)
- - [@ohos.application.AbilityConstant](js-apis-application-abilityConstant.md)
- - [@ohos.application.AbilityStage](js-apis-application-abilitystage.md)
- - [@ohos.application.abilityLifecycleCallback](js-apis-application-abilityLifecycleCallback.md)
+ - Stage Model (Recommended)
+ - [@ohos.app.ability.Ability](js-apis-app-ability-ability.md)
+ - [@ohos.app.ability.AbilityConstant](js-apis-app-ability-abilityConstant.md)
+ - [@ohos.app.ability.abilityLifecycleCallback](js-apis-app-ability-abilityLifecycleCallback.md)
+ - [@ohos.app.ability.AbilityStage](js-apis-app-ability-abilityStage.md)
+ - [@ohos.app.ability.common](js-apis-app-ability-common.md)
+ - [@ohos.app.ability.contextConstant](js-apis-app-ability-contextConstant.md)
+ - [@ohos.app.ability.EnvironmentCallback](js-apis-app-ability-environmentCallback.md)
+ - [@ohos.app.ability.ExtensionAbility](js-apis-app-ability-extensionAbility.md)
+ - [@ohos.app.ability.ServiceExtensionAbility](js-apis-app-ability-serviceExtensionAbility.md)
+ - [@ohos.app.ability.StartOptions](js-apis-app-ability-startOptions.md)
+ - [@ohos.app.ability.UIAbility](js-apis-app-ability-uiAbility.md)
+ - [@ohos.app.form.FormExtensionAbility](js-apis-app-form-formExtensionAbility.md)
- [@ohos.application.DataShareExtensionAbility](js-apis-application-DataShareExtensionAbility.md)
- - [@ohos.application.FormExtension](js-apis-formextension.md)
- - [@ohos.application.ServiceExtensionAbility](js-apis-service-extension-ability.md)
- - [@ohos.application.StartOptions](js-apis-application-StartOptions.md)
- [@ohos.application.StaticSubscriberExtensionAbility](js-apis-application-staticSubscriberExtensionAbility.md)
- - [@ohos.application.WindowExtensionAbility](js-apis-application-WindowExtensionAbility.md)
- - application/[AbilityContext](js-apis-ability-context.md)
- - application/[ApplicationContext](js-apis-application-applicationContext.md)
- - application/[AbilityStageContext](js-apis-abilitystagecontext.md)
- - application/[Context](js-apis-application-context.md)
- - application/[ExtensionContext](js-apis-extension-context.md)
- - application/[FormExtensionContext](js-apis-formextensioncontext.md)
- - application/[PermissionRequestResult](js-apis-permissionrequestresult.md)
- - application/[ServiceExtensionContext](js-apis-service-extension-context.md)
- - FA and Stage Models
- - [@ohos.ability.dataUriUtils](js-apis-DataUriUtils.md)
+ - Stage Model (To Be Deprecated Soon)
+ - [@ohos.application.Ability](js-apis-application-ability.md)
+ - [@ohos.application.AbilityConstant](js-apis-application-abilityConstant.md)
+ - [@ohos.application.AbilityLifecycleCallback](js-apis-application-abilityLifecycleCallback.md)
+ - [@ohos.application.AbilityStage](js-apis-application-abilityStage.md)
+ - [@ohos.application.context](js-apis-application-context.md)
+ - [@ohos.application.EnvironmentCallback](js-apis-application-environmentCallback.md)
+ - [@ohos.application.ExtensionAbility](js-apis-application-extensionAbility.md)
+ - [@ohos.application.FormExtension](js-apis-application-formExtension.md)
+ - [@ohos.application.ServiceExtensionAbility](js-apis-application-serviceExtensionAbility.md)
+ - [@ohos.application.StartOptions](js-apis-application-startOptions.md)
+ - FA Model
+ - [@ohos.ability.ability](js-apis-ability-ability.md)
+ - [@ohos.ability.featureAbility](js-apis-ability-featureAbility.md)
+ - [@ohos.ability.particleAbility](js-apis-ability-particleAbility.md)
+ - Both Models (Recommended)
+ - [@ohos.app.ability.abilityDelegatorRegistry](js-apis-app-ability-abilityDelegatorRegistry.md)
+ - [@ohos.app.ability.abilityManager](js-apis-app-ability-abilityManager.md)
+ - [@ohos.app.ability.appManager](js-apis-app-ability-appManager.md)
+ - [@ohos.app.ability.appRecovery](js-apis-app-ability-appRecovery.md)
+ - [@ohos.app.ability.Configuration](js-apis-app-ability-configuration.md)
+ - [@ohos.app.ability.ConfigurationConstant](js-apis-app-ability-configurationConstant.md)
+ - [@ohos.app.ability.dataUriUtils](js-apis-app-ability-dataUriUtils.md)
+ - [@ohos.app.ability.errorManager](js-apis-app-ability-errorManager.md)
+ - [@ohos.app.ability.missionManager](js-apis-app-ability-missionManager.md)
+ - [@ohos.app.ability.quickFixManager](js-apis-app-ability-quickFixManager.md)
+ - [@ohos.app.ability.Want](js-apis-app-ability-want.md)
+ - [@ohos.app.ability.wantAgent](js-apis-app-ability-wantAgent.md)
+ - [@ohos.app.ability.wantConstant](js-apis-app-ability-wantConstant.md)
+ - [@ohos.app.form.formBindingData](js-apis-app-form-formBindingData.md)
+ - [@ohos.app.form.formHost](js-apis-app-form-formHost.md)
+ - [@ohos.app.form.formInfo](js-apis-app-form-formInfo.md)
+ - [@ohos.app.form.formProvider](js-apis-app-form-formProvider.md)
+ - Both Models (To Be Deprecated Soon)
+ - [@ohos.ability.dataUriUtils](js-apis-ability-dataUriUtils.md)
- [@ohos.ability.errorCode](js-apis-ability-errorCode.md)
- [@ohos.ability.wantConstant](js-apis-ability-wantConstant.md)
- - [@ohos.application.abilityDelegatorRegistry](js-apis-abilityDelegatorRegistry.md)
+ - [@ohos.application.abilityDelegatorRegistry](js-apis-application-abilityDelegatorRegistry.md)
- [@ohos.application.abilityManager](js-apis-application-abilityManager.md)
- - [@ohos.application.AccessibilityExtensionAbility](js-apis-accessibility-extension-context.md)
- - [@ohos.application.AccessibilityExtensionAbility](js-apis-application-AccessibilityExtensionAbility.md)
- - [@ohos.application.appManager](js-apis-appmanager.md)
- - [@ohos.application.Configuration](js-apis-configuration.md)
- - [@ohos.application.ConfigurationConstant](js-apis-configurationconstant.md)
- - [@ohos.application.EnvironmentCallback](js-apis-application-EnvironmentCallback.md)
- - [@ohos.application.errorManager](js-apis-errorManager.md)
- - [@ohos.application.formBindingData](js-apis-formbindingdata.md)
- - [@ohos.application.formError](js-apis-formerror.md)
- - [@ohos.application.formHost](js-apis-formhost.md)
- - [@ohos.application.formInfo](js-apis-formInfo.md)
- - [@ohos.application.formProvider](js-apis-formprovider.md)
- - [@ohos.application.missionManager](js-apis-missionManager.md)
- - [@ohos.application.quickFixManager](js-apis-application-quickFixManager.md)
- - [@ohos.application.Want](js-apis-application-Want.md)
- - [@ohos.continuation.continuationManager](js-apis-continuation-continuationExtraParams.md)
- - [@ohos.continuation.continuationManager](js-apis-continuation-continuationManager.md)
+ - [@ohos.application.appManager](js-apis-application-appManager.md)
+ - [@ohos.application.Configuration](js-apis-application-configuration.md)
+ - [@ohos.application.ConfigurationConstant](js-apis-application-configurationConstant.md)
+ - [@ohos.application.errorManager)](js-apis-application-errorManager.md)
+ - [@ohos.application.formBindingData](js-apis-application-formBindingData.md)
+ - [@ohos.application.formError](js-apis-application-formError.md)
+ - [@ohos.application.formHost](js-apis-application-formHost.md)
+ - [@ohos.application.formInfo](js-apis-application-formInfo.md)
+ - [@ohos.application.formProvider](js-apis-application-formProvider.md)
+ - [@ohos.application.missionManager](js-apis-application-missionManager.md)
+ - [@ohos.application.Want](js-apis-application-want.md)
- [@ohos.wantAgent](js-apis-wantAgent.md)
- - application/[abilityDelegator](js-apis-application-abilityDelegator.md)
- - application/[abilityDelegatorArgs](js-apis-application-abilityDelegatorArgs.md)
- - application/[abilityMonitor](js-apis-application-abilityMonitor.md)
- - application/[AbilityRunningInfo](js-apis-abilityrunninginfo.md)
- - application/[ExtensionRunningInfo](js-apis-extensionrunninginfo.md)
- - application/[MissionSnapshot](js-apis-application-MissionSnapshot.md)
- - application/[ProcessRunningInfo](js-apis-processrunninginfo.md)
- - application/[ProcessRunningInformation](js-apis-processrunninginformation.md)
- - application/[shellCmdResult](js-apis-application-shellCmdResult.md)
- - continuation/[ContinuationResult](js-apis-continuation-continuationResult.md)
+ - Dependent Elements and Definitions
+ - ability
+ - [abilityResult](js-apis-inner-ability-abilityResult.md)
+ - [connectOptions](js-apis-inner-ability-connectOptions.md)
+ - [dataAbilityHelper](js-apis-inner-ability-dataAbilityHelper.md)
+ - [dataAbilityOperation](js-apis-inner-ability-dataAbilityOperation.md)
+ - [dataAbilityResult](js-apis-inner-ability-dataAbilityResult.md)
+ - [startAbilityParameter](js-apis-inner-ability-startAbilityParameter.md)
+ - [want](js-apis-inner-ability-want.md)
+ - app
+ - [appVersionInfo](js-apis-inner-app-appVersionInfo.md)
+ - [context](js-apis-inner-app-context.md)
+ - [processInfo](js-apis-inner-app-processInfo.md)
+ - application
+ - [AbilityContext](js-apis-ability-context.md)
+ - [abilityDelegator](js-apis-inner-application-abilityDelegator.md)
+ - [abilityDelegatorArgs](js-apis-inner-application-abilityDelegatorArgs.md)
+ - [abilityMonitor](js-apis-inner-application-abilityMonitor.md)
+ - [AbilityRunningInfo](js-apis-inner-application-abilityRunningInfo.md)
+ - [AbilityStageContext](js-apis-inner-application-abilityStageContext.md)
+ - [AbilityStateData](js-apis-inner-application-abilityStateData.md)
+ - [abilityStageMonitor](js-apis-inner-application-abilityStageMonitor.md)
+ - [ApplicationContext](js-apis-inner-application-applicationContext.md)
+ - [ApplicationStateObserver](js-apis-inner-application-applicationStateObserver.md)
+ - [AppStateData](js-apis-inner-application-appStateData.md)
+ - [BaseContext](js-apis-inner-application-baseContext.md)
+ - [Context](js-apis-inner-application-context.md)
+ - [ContinueCallback](js-apis-inner-application-continueCallback.md)
+ - [ContinueDeviceInfo](js-apis-inner-application-continueDeviceInfo.md)
+ - [ErrorObserver](js-apis-inner-application-errorObserver.md)
+ - [ExtensionContext](js-apis-inner-application-extensionContext.md)
+ - [ExtensionRunningInfo](js-apis-inner-application-extensionRunningInfo.md)
+ - [FormExtensionContext](js-apis-inner-application-formExtensionContext.md)
+ - [MissionCallbacks](js-apis-inner-application-missionCallbacks.md)
+ - [MissionDeviceInfo](js-apis-inner-application-missionDeviceInfo.md)
+ - [MissionInfo](js-apis-inner-application-missionInfo.md)
+ - [MissionListener](js-apis-inner-application-missionListener.md)
+ - [MissionParameter](js-apis-inner-application-missionParameter.md)
+ - [MissionSnapshot](js-apis-inner-application-missionSnapshot.md)
+ - [PermissionRequestResult](js-apis-inner-application-permissionRequestResult.md)
+ - [ProcessData](js-apis-inner-application-processData.md)
+ - [ProcessRunningInfo](js-apis-inner-application-processRunningInfo.md)
+ - [ProcessRunningInformation](js-apis-inner-application-processRunningInformation.md)
+ - [ServiceExtensionContext](js-apis-inner-application-serviceExtensionContext.md)
+ - [UIAbilityContext](js-apis-inner-application-uiAbilityContext.md)
+ - [shellCmdResult](js-apis-inner-application-shellCmdResult.md)
+ - wantAgent
+ - [triggerInfo](js-apis-inner-wantAgent-triggerInfo.md)
+ - [wantAgentInfo](js-apis-inner-wantAgent-wantAgentInfo.md)
+ - Continuation
+ - [@ohos.continuation.continuationManager (continuationManager)](js-apis-continuation-continuationManager.md)
+ - continuation
+ - [continuationExtraParams](js-apis-continuation-continuationExtraParams.md)
+ - [continuationResult](js-apis-continuation-continuationResult.md)
+
- Common Event and Notification
- - [@ohos.commonEvent](js-apis-commonEvent.md)
- [@ohos.events.emitter](js-apis-emitter.md)
- [@ohos.notification](js-apis-notification.md)
- - application/[EventHub](js-apis-eventhub.md)
- - Bundle Management
- - [@ohos.bundle](js-apis-Bundle.md)
- - [@ohos.bundle.defaultAppManager](js-apis-bundle-defaultAppManager.md)
- - [@ohos.bundle.innerBundleManager)](js-apis-Bundle-InnerBundleManager.md)
- - [@ohos.distributedBundle)](js-apis-Bundle-distributedBundle.md)
+ - application/[EventHub](js-apis-inner-application-eventHub.md)
+- Bundle Management
+ - [@ohos.bundle.appControl](js-apis-appControl.md)
+ - [@ohos.bundle.bundleManager](js-apis-bundleManager.md)
+ - [@ohos.bundle.bundleMonitor](js-apis-bundleMonitor.md)
+ - [@ohos.bundle.defaultAppManager](js-apis-defaultAppManager.md)
+ - [@ohos.bundle.distributedBundle](js-apis-distributedBundle.md)
+ - [@ohos.bundle.freeInstall](js-apis-freeInstall.md)
+ - [@ohos.bundle.installer](js-apis-installer.md)
+ - [@ohos.bundle.launcherBundleManager](js-apis-launcherBundleManager.md)
- [@ohos.zlib](js-apis-zlib.md)
- - bundle/[AbilityInfo](js-apis-bundle-AbilityInfo.md)
- - bundle/[ApplicationInfo](js-apis-bundle-ApplicationInfo.md)
- - bundle/[BundleInfo](js-apis-bundle-BundleInfo.md)
- - bundle/[BundleInstaller](js-apis-bundle-BundleInstaller.md)
- - bundle/[BundleStatusCallback](js-apis-Bundle-BundleStatusCallback.md)
- - bundle/[CustomizeData](js-apis-bundle-CustomizeData.md)
- - bundle/[DispatchInfo](js-apis-dispatchInfo.md)
- - bundle/[ElementName](js-apis-bundle-ElementName.md)
- - bundle/[ExtensionAbilityInfo](js-apis-bundle-ExtensionAbilityInfo.md)
- - bundle/[HapModuleInfo](js-apis-bundle-HapModuleInfo.md)
- - bundle/[LauncherAbilityInfo](js-apis-bundle-LauncherAbilityInfo.md)
- - bundle/[Metadata](js-apis-bundle-Metadata.md)
- - bundle/[ModuleInfo](js-apis-bundle-ModuleInfo.md)
- - bundle/[PermissionDef](js-apis-bundle-PermissionDef.md)
- - bundle/[RemoteAbilityInfo](js-apis-bundle-remoteAbilityInfo.md)
- - bundle/[ShortcutInfo(deprecated) ](js-apis-bundle-ShortcutInfo.md)
- - bundle/[PackInfo](js-apis-bundle-PackInfo.md)
+ - bundleManager
+ - [abilityInfo](js-apis-bundleManager-abilityInfo.md)
+ - [applicationInfo](js-apis-bundleManager-applicationInfo.md)
+ - [bundleInfo](js-apis-bundleManager-bundleInfo.md)
+ - [dispatchInfo](js-apis-bundleManager-dispatchInfo.md)
+ - [elementName](js-apis-bundleManager-elementName.md)
+ - [extensionAbilityInfo](js-apis-bundleManager-extensionAbilityInfo.md)
+ - [hapModuleInfo](js-apis-bundleManager-hapModuleInfo.md)
+ - [launcherAbilityInfo](js-apis-bundleManager-launcherAbilityInfo.md)
+ - [metadata](js-apis-bundleManager-metadata.md)
+ - [packInfo](js-apis-bundleManager-packInfo.md)
+ - [permissionDef](js-apis-bundleManager-permissionDef.md)
+ - [remoteAbilityInfo](js-apis-bundleManager-remoteAbilityInfo.md)
+ - [shortcutInfo](js-apis-bundleManager-shortcutInfo.md)
- UI Page
- [@ohos.animator](js-apis-animator.md)
- [@ohos.mediaquery](js-apis-mediaquery.md)
- [@ohos.promptAction](js-apis-promptAction.md)
- [@ohos.router](js-apis-router.md)
- - Graphics
+- Graphics
- [@ohos.animation.windowAnimationManager](js-apis-windowAnimationManager.md)
+ - [@ohos.application.WindowExtensionAbility](js-apis-application-windowExtensionAbility.md)
- [@ohos.display ](js-apis-display.md)
- [@ohos.effectKit](js-apis-effectKit.md)
- [@ohos.graphics.colorSpaceManager](js-apis-colorSpaceManager.md)
- [@ohos.screen](js-apis-screen.md)
- [@ohos.screenshot](js-apis-screenshot.md)
- [@ohos.window](js-apis-window.md)
- - [webgl](js-apis-webgl.md)
- - [webgl2](js-apis-webgl2.md)
+ - webgl
+ - [webgl](js-apis-webgl.md)
+ - [webgl2](js-apis-webgl2.md)
- Media
- [@ohos.multimedia.audio](js-apis-audio.md)
+ - [@ohos.multimedia.avsession](js-apis-avsession.md)
- [@ohos.multimedia.camera](js-apis-camera.md)
- [@ohos.multimedia.image](js-apis-image.md)
- [@ohos.multimedia.media](js-apis-media.md)
@@ -112,28 +179,22 @@
- [@ohos.i18n](js-apis-i18n.md)
- [@ohos.intl](js-apis-intl.md)
- [@ohos.resourceManager](js-apis-resource-manager.md)
-- Resource Scheduling
- - [@ohos.backgroundTaskManager](js-apis-backgroundTaskManager.md)
+- Resource Scheduling
- [@ohos.distributedMissionManager](js-apis-distributedMissionManager.md)
- - [@ohos.workScheduler ](js-apis-workScheduler.md)
+ - [@ohos.reminderAgentManager](js-apis-reminderAgentManager.md)
+ - [@ohos.resourceschedule.backgroundTaskManager](js-apis-resourceschedule-backgroundTaskManager.md)
+ - [@ohos.resourceschedule.workScheduler](js-apis-resourceschedule-workScheduler.md)
+ - [@ohos.resourceschedule.usageStatistics](js-apis-resourceschedule-deviceUsageStatistics.md)
- [@ohos.WorkSchedulerExtensionAbility](js-apis-WorkSchedulerExtensionAbility.md)
-- Custom Management
- - [@ohos.configPolicy](js-apis-config-policy.md)
- - [@ohos.EnterpriseAdminExtensionAbility](js-apis-EnterpriseAdminExtensionAbility.md)
- - [@ohos.enterpriseDeviceManager](js-apis-enterprise-device-manager.md)
- - enterpriseDeviceManager/[DeviceSettingsManager](js-apis-enterpriseDeviceManager-DeviceSettingsManager.md)
- Security
- [@ohos.abilityAccessCtrl](js-apis-abilityAccessCtrl.md)
- [@ohos.privacyManager](js-apis-privacyManager.md)
- - [@ohos.security.cert](js-apis-cert.md)
- - [@ohos.security.cryptoFramework]js-apis-cryptoFramework.md)
+ - [@ohos.security.cryptoFramework](js-apis-cryptoFramework.md)
- [@ohos.security.huks ](js-apis-huks.md)
- [@ohos.userIAM.faceAuth](js-apis-useriam-faceauth.md)
- [@ohos.userIAM.userAuth ](js-apis-useriam-userauth.md)
- [@system.cipher](js-apis-system-cipher.md)
-
- Data Management
-
- [@ohos.data.dataAbility ](js-apis-data-ability.md)
- [@ohos.data.dataShare](js-apis-data-dataShare.md)
- [@ohos.data.dataSharePredicates](js-apis-data-dataSharePredicates.md)
@@ -143,9 +204,7 @@
- [@ohos.data.rdb](js-apis-data-rdb.md)
- [@ohos.data.ValuesBucket](js-apis-data-ValuesBucket.md)
- data/rdb/[resultSet](js-apis-data-resultset.md)
-
- File Management
-
- [@ohos.document](js-apis-document.md)
- [@ohos.environment](js-apis-environment.md)
- [@ohos.data.fileAccess](js-apis-fileAccess.md)
@@ -169,11 +228,8 @@
- [@ohos.net.connection](js-apis-net-connection.md)
- [@ohos.net.ethernet](js-apis-net-ethernet.md)
- [@ohos.net.http](js-apis-http.md)
- - [@ohos.net.policy](js-apis-net-policy.md)
- [@ohos.net.sharing](js-apis-net-sharing.md)
- [@ohos.net.socket](js-apis-socket.md)
- - [@ohos.net.statistics](js-apis-net-statistics.md)
- - [@ohos.net.tlsSocket](js-apis-tlsSocket.md)
- [@ohos.net.webSocket](js-apis-webSocket.md)
- [@ohos.request](js-apis-request.md)
- Connectivity
@@ -190,14 +246,15 @@
- Basic Features
- [@ohos.accessibility](js-apis-accessibility.md)
- [@ohos.accessibility.config](js-apis-accessibility-config.md)
+ - [@ohos.application.AccessibilityExtensionAbility](js-apis-application-accessibilityExtensionAbility.md)
- [@ohos.faultLogger](js-apis-faultLogger.md)
- - [@ohos.hiAppEvent](js-apis-hiappevent.md)
- [@ohos.hichecker](js-apis-hichecker.md)
- [@ohos.hidebug](js-apis-hidebug.md)
- [@ohos.hilog](js-apis-hilog.md)
- [@ohos.hiSysEvent](js-apis-hisysevent.md)
- [@ohos.hiTraceChain](js-apis-hitracechain.md)
- [@ohos.hiTraceMeter](js-apis-hitracemeter.md)
+ - [@ohos.hiviewdfx.hiAppEvent](js-apis-hiviewdfx-hiappevent.md)
- [@ohos.inputMethod](js-apis-inputmethod.md)
- [@ohos.inputMethodEngine](js-apis-inputmethodengine.md)
- [@ohos.inputmethodextensionability](js-apis-inputmethod-extension-ability.md)
@@ -207,16 +264,15 @@
- [@ohos.systemTime](js-apis-system-time.md)
- [@ohos.systemTimer](js-apis-system-timer.md)
- [@ohos.wallpaper](js-apis-wallpaper.md)
+ - [@ohos.web.webview](js-apis-webview.md)
- [console](js-apis-logs.md)
- [Timer](js-apis-timer.md)
-
+ - application/[AccessibilityExtensionContext](js-apis-accessibility-extension-context.md)
- Device Management
-
- [@ohos.batteryInfo ](js-apis-battery-info.md)
- [@ohos.brightness](js-apis-brightness.md)
- [@ohos.deviceInfo](js-apis-device-info.md)
- [@ohos.distributedHardware.deviceManager](js-apis-device-manager.md)
- - [@ohos.geolocation](js-apis-geolocation.md)
- [@ohos.multimodalInput.inputConsumer](js-apis-inputconsumer.md)
- [@ohos.multimodalInput.inputDevice](js-apis-inputdevice.md)
- [@ohos.multimodalInput.inputDeviceCooperate](js-apis-cooperate.md)
@@ -232,15 +288,18 @@
- [@ohos.runningLock](js-apis-runninglock.md)
- [@ohos.sensor](js-apis-sensor.md)
- [@ohos.settings](js-apis-settings.md)
- - [@ohos.systemParameter](js-apis-system-parameter.md)
+ - [@ohos.systemParameterV9](js-apis-system-parameterV9.md)
- [@ohos.thermal](js-apis-thermal.md)
- [@ohos.update](js-apis-update.md)
- [@ohos.usb](js-apis-usb.md)
- [@ohos.vibrator](js-apis-vibrator.md)
-- Account Management
+- Account Management
- [@ohos.account.appAccount](js-apis-appAccount.md)
- [@ohos.account.distributedAccount](js-apis-distributed-account.md)
- [@ohos.account.osAccount](js-apis-osAccount.md)
+- Custom Management
+ - [@ohos.configPolicy](js-apis-configPolicy.md)
+ - [@ohos.EnterpriseAdminExtensionAbility](js-apis-EnterpriseAdminExtensionAbility.md)
- Language Base Class Library
- [@ohos.buffer](js-apis-buffer.md)
- [@ohos.convertxml](js-apis-convertxml.md)
@@ -265,15 +324,25 @@
- [@ohos.worker](js-apis-worker.md)
- [@ohos.xml](js-apis-xml.md)
- Test
- - [@ohos.application.testRunner](js-apis-testRunner.md)
+ - [@ohos.application.testRunner](js-apis-application-testRunner.md)
- [@ohos.uitest](js-apis-uitest.md)
-- APIs No Longer Maintained
+- APIs No Longer Maintained
+ - [@ohos.backgroundTaskManager](js-apis-backgroundTaskManager.md)
+ - [@ohos.bundle](js-apis-Bundle.md)
+ - [@ohos.bundle.innerBundleManager](js-apis-Bundle-InnerBundleManager.md)
- [@ohos.bundleState](js-apis-deviceUsageStatistics.md)
- [@ohos.bytrace](js-apis-bytrace.md)
- [@ohos.data.storage](js-apis-data-storage.md)
- [@ohos.data.distributedData](js-apis-distributed-data.md)
+ - [@ohos.distributedBundle](js-apis-Bundle-distributedBundle.md)
+ - [@ohos.document](js-apis-document.md)
+ - [@ohos.geolocation](js-apis-geolocation.md)
+ - [@ohos.hiAppEvent](js-apis-hiappevent.md)
- [@ohos.prompt](js-apis-prompt.md)
- [@ohos.reminderAgent](js-apis-reminderAgent.md)
+ - [@ohos.systemParameter](js-apis-system-parameter.md)
+ - [@ohos.usb](js-apis-usb-deprecated.md)
+ - [@ohos.workScheduler](js-apis-workScheduler.md)
- [@system.app](js-apis-system-app.md)
- [@system.battery](js-apis-system-battery.md)
- [@system.bluetooth](js-apis-system-bluetooth.md)
@@ -293,4 +362,17 @@
- [@system.sensor](js-apis-system-sensor.md)
- [@system.storage](js-apis-system-storage.md)
- [@system.vibrator](js-apis-system-vibrate.md)
- - [console](js-apis-logs.md)
+ - bundle
+ - [abilityInfo](js-apis-bundle-AbilityInfo.md)
+ - [applicationInfo](js-apis-bundle-ApplicationInfo.md)
+ - [bundleInfo](js-apis-bundle-BundleInfo.md)
+ - [bundleInstaller](js-apis-bundle-BundleInstaller.md)
+ - [bundleStatusCallback](js-apis-Bundle-BundleStatusCallback.md)
+ - [customizeData](js-apis-bundle-CustomizeData.md)
+ - [elementName](js-apis-bundle-ElementName.md)
+ - [hapModuleInfo](js-apis-bundle-HapModuleInfo.md)
+ - [launcherAbilityInfo](js-apis-bundle-LauncherAbilityInfo.md)
+ - [moduleInfo](js-apis-bundle-ModuleInfo.md)
+ - [PermissionDef](js-apis-bundle-PermissionDef.md)
+ - [remoteAbilityInfo](js-apis-bundle-remoteAbilityInfo.md)
+ - [shortcutInfo](js-apis-bundle-ShortcutInfo.md)
diff --git a/en/application-dev/reference/apis/development-intro.md b/en/application-dev/reference/apis/development-intro.md
index f1cc73aa8437b7cb20bf5fe16b284da2a788d570..aaeab2f2961f4254f4bbd8d634ee0f773f996ab4 100644
--- a/en/application-dev/reference/apis/development-intro.md
+++ b/en/application-dev/reference/apis/development-intro.md
@@ -53,5 +53,5 @@ The following description is provided for each API in the reference document to
OpenHarmony supports two development languages: JS and TS.
-- When a code block is labeled with `js`, the sample code can be used in the JS and eTS projects.
-- When a code block is labeled with `ts`, the sample code can be used only in the eTS project.
+- When a code block is labeled with `js`, the sample code can be used in the JS and ArkTS projects.
+- When a code block is labeled with `ts`, the sample code can be used only in the ArkTS project.
diff --git a/en/application-dev/reference/apis/figures/en-us_image_0000001164217678.png b/en/application-dev/reference/apis/figures/en-us_image_0000001164217678.png
deleted file mode 100644
index 2128f0852380b2895198ab725a2f9d299c480d84..0000000000000000000000000000000000000000
Binary files a/en/application-dev/reference/apis/figures/en-us_image_0000001164217678.png and /dev/null differ
diff --git a/en/application-dev/reference/apis/figures/en-us_image_Add_Blur.png b/en/application-dev/reference/apis/figures/en-us_image_Add_Blur.png
new file mode 100644
index 0000000000000000000000000000000000000000..e3b0acfef7bffa4e6a8c9f9ab6a7dc9b809fa467
Binary files /dev/null and b/en/application-dev/reference/apis/figures/en-us_image_Add_Blur.png differ
diff --git a/en/application-dev/reference/apis/figures/en-us_image_Add_Brightness.png b/en/application-dev/reference/apis/figures/en-us_image_Add_Brightness.png
new file mode 100644
index 0000000000000000000000000000000000000000..997602e7d7c8ea440a4f344f6a480ea66022fabf
Binary files /dev/null and b/en/application-dev/reference/apis/figures/en-us_image_Add_Brightness.png differ
diff --git a/en/application-dev/reference/apis/figures/en-us_image_Add_Grayscale.png b/en/application-dev/reference/apis/figures/en-us_image_Add_Grayscale.png
new file mode 100644
index 0000000000000000000000000000000000000000..69990adea571b907fabd854eb531528d7a60dc8f
Binary files /dev/null and b/en/application-dev/reference/apis/figures/en-us_image_Add_Grayscale.png differ
diff --git a/en/application-dev/reference/apis/figures/en-us_image_Main_Color.png b/en/application-dev/reference/apis/figures/en-us_image_Main_Color.png
new file mode 100644
index 0000000000000000000000000000000000000000..25e130fcf37fc3654592f619c8a93b703a085e9a
Binary files /dev/null and b/en/application-dev/reference/apis/figures/en-us_image_Main_Color.png differ
diff --git a/en/application-dev/reference/apis/figures/log.png b/en/application-dev/reference/apis/figures/log.png
deleted file mode 100644
index 6eb89772d315b440636e8ceeda928e5db6b34e40..0000000000000000000000000000000000000000
Binary files a/en/application-dev/reference/apis/figures/log.png and /dev/null differ
diff --git a/en/application-dev/reference/apis/js-apis-Bundle-BundleStatusCallback.md b/en/application-dev/reference/apis/js-apis-Bundle-BundleStatusCallback.md
index 2f601b14073d922a6b5812dc0d0368e16024a751..b3476c86cce52d57a0d54c6b01c1fbed71076ef9 100644
--- a/en/application-dev/reference/apis/js-apis-Bundle-BundleStatusCallback.md
+++ b/en/application-dev/reference/apis/js-apis-Bundle-BundleStatusCallback.md
@@ -4,16 +4,18 @@ The **BundleStatusCallback** module provides bundle callback information, which
> **NOTE**
>
-> The initial APIs of this module are supported since API version 8. Newly added APIs will be marked with a superscript to indicate their earliest API version.
+> This module is deprecated since API version 9. You are advised to use [bundleMonitor](js-apis-bundleMonitor.md) instead.
-## BundleStatusCallback
+
+## BundleStatusCallback(deprecated)
+> This API is deprecated since API version 9. You are advised to use [bundleMonitor](js-apis-bundleMonitor.md) instead.
**System API**: This is a system API and cannot be called by third-party applications.
**System capability**: SystemCapability.BundleManager.BundleFramework
-| Name | Type | Description |
+| Type | Callback | Description |
| ------ | --------------------------------------------- | -------------------------------------- |
-| add | (bundleName : string, userId: number) => void | Callback invoked when a **launcherStatusCallback** is added.|
-| update | (bundleName : string, userId: number) => void | Callback invoked when a **launcherStatusCallback** is updated.|
-| remove | (bundleName : string, userId: number) => void | Callback invoked when a **launcherStatusCallback** is removed.|
+| add | (bundleName : string, userId: number) => void | Used to obtain information when a bundle is installed.|
+| update | (bundleName : string, userId: number) => void | Used to obtain information when a bundle is updated.|
+| remove | (bundleName : string, userId: number) => void | Used to obtain information when a bundle is uninstalled.|
diff --git a/en/application-dev/reference/apis/js-apis-Bundle-InnerBundleManager.md b/en/application-dev/reference/apis/js-apis-Bundle-InnerBundleManager.md
index 8beab3711f2933ce0701e5cdb79319c4d0bfdfcd..9d023410fff66869318fca78d3cae361ff71217b 100644
--- a/en/application-dev/reference/apis/js-apis-Bundle-InnerBundleManager.md
+++ b/en/application-dev/reference/apis/js-apis-Bundle-InnerBundleManager.md
@@ -1,14 +1,14 @@
-# innerBundleManager
+# innerBundleManager(deprecated)
-The **innerBundleManager** module manages internal bundles.
+The **innerBundleManager** module provides APIs for the **Home Screen** application.
-> **NOTE**
>
> The initial APIs of this module are supported since API version 8. Newly added APIs will be marked with a superscript to indicate their earliest API version.
+> This module is deprecated since API version 9. You are advised to use [launcherBundleManager](js-apis-launcherBundleManager.md) and [bundleMonitor](js-apis-bundleMonitor.md) instead.
## Modules to Import
-```
+```typescript
import innerBundleManager from '@ohos.bundle.innerBundleManager';
```
@@ -16,20 +16,13 @@ import innerBundleManager from '@ohos.bundle.innerBundleManager';
SystemCapability.BundleManager.BundleFramework
-## Required Permissions
-
-| Permission | Permission Level | Description |
-| ------------------------------------------ | ------------ | ---------------------------- |
-| ohos.permission.GET_BUNDLE_INFO_PRIVILEGED | system_basic | Permission to query information about all applications. |
-| ohos.permission.LISTEN_BUNDLE_CHANGE | system_grant | Permission to listen for application changes.|
-
-For details, see [Permission Levels](../../security/accesstoken-overview.md#permission-levels).
-## innerBundleManager.getLauncherAbilityInfos
+## innerBundleManager.getLauncherAbilityInfos(deprecated)
getLauncherAbilityInfos(bundleName: string, userId: number, callback: AsyncCallback<Array<LauncherAbilityInfo>>) : void;
Obtains the launcher ability information based on a given bundle name. This API uses an asynchronous callback to return the result.
+> This API is deprecated since API version 9. You are advised to use [launcherBundleManager#getLauncherAbilityInfo](js-apis-launcherBundleManager.md) instead.
**Required permissions**
@@ -45,19 +38,19 @@ This is a system API and cannot be called by third-party applications.
**Parameters**
-| Name | Type | Mandatory| Description |
+| Name | Type | Mandatory| Description |
| ---------- | ------------------------------------------------------------ | ---- | ----------------------------------------------------- |
| bundleName | string | Yes | Bundle name of an application. |
| userId | number | Yes | User ID. The default value is the user ID of the caller. The value must be greater than or equal to 0.|
| callback | AsyncCallback\> | Yes | Callback used to return an array of the launcher ability information. |
-
-## innerBundleManager.getLauncherAbilityInfos
+## innerBundleManager.getLauncherAbilityInfos(deprecated)
getLauncherAbilityInfos(bundleName: string, userId: number) : Promise<Array<LauncherAbilityInfo>>
Obtains the launcher ability information based on a given bundle name. This API uses a promise to return the result.
+> This API is deprecated since API version 9. You are advised to use [launcherBundleManager#getLauncherAbilityInfo](js-apis-launcherBundleManager.md) instead.
**Required permissions**
@@ -73,7 +66,7 @@ This is a system API and cannot be called by third-party applications.
**Parameters**
-| Name | Type | Mandatory| Description |
+| Name | Type | Mandatory| Description |
| ---------- | ------ | ---- | ----------------------------------------------------- |
| bundleName | string | Yes | Bundle name of an application. |
| userId | number | Yes | User ID. The default value is the user ID of the caller. The value must be greater than or equal to 0.|
@@ -84,11 +77,12 @@ This is a system API and cannot be called by third-party applications.
| ------------------------------------------------------------ | ------------------------- |
| Promise\> | Promise used to return an array of the launcher ability information.|
-## innerBundleManager.on
+## innerBundleManager.on(deprecated)
on(type:"BundleStatusChange", bundleStatusCallback : BundleStatusCallback, callback: AsyncCallback<string>) : void;
Registers a callback to receive bundle status changes. This API uses an asynchronous callback to return the result.
+> This API is deprecated since API version 9. You are advised to use [bundleMonitor#on](js-apis-bundleMonitor.md) instead.
**Required permissions**
@@ -104,17 +98,18 @@ This is a system API and cannot be called by third-party applications.
**Parameters**
-| Name | Type | Mandatory| Description |
+| Name | Type | Mandatory| Description |
| -------------------- | --------------------- | ---- | ---------------------------------------------------- |
| type | string | Yes | Event type. Only **BundleStatusChange** is supported. |
| bundleStatusCallback | [BundleStatusCallback](js-apis-Bundle-BundleStatusCallback.md) | Yes | Callback to register. |
| callback | AsyncCallback\ | Yes | Callback used to return a successful result or error information.|
-## innerBundleManager.on
+## innerBundleManager.on(deprecated)
-on(type:"BundleStatusChange", bundleStatusCallback : BundleStatusCallback): Promise<string>
+on(type:"BundleStatusChange", bundleStatusCallback : BundleStatusCallback) : Promise<string>
Registers a callback to receive bundle status changes. This API uses a promise to return the result.
+> This API is deprecated since API version 9. You are advised to use [bundleMonitor#on](js-apis-bundleMonitor.md) instead.
**Required permissions**
@@ -130,7 +125,7 @@ This is a system API and cannot be called by third-party applications.
**Parameters**
-| Name | Type | Mandatory| Description |
+| Name | Type | Mandatory| Description |
| -------------------- | ------------------------------------------------------------ | ---- | ------------------------------------------ |
| type | string | Yes | Event type. Only **BundleStatusChange** is supported.|
| bundleStatusCallback | [BundleStatusCallback](js-apis-Bundle-BundleStatusCallback.md) | Yes | Callback to register. |
@@ -141,11 +136,12 @@ This is a system API and cannot be called by third-party applications.
| --------------- | ----------------------------------- |
| Promise\ | Promise used to return a successful result or error information.|
-## innerBundleManager.off
+## innerBundleManager.off(deprecated)
off(type:"BundleStatusChange", callback: AsyncCallback<string>) : void;
Deregisters the callback that receives bundle status changes. This API uses an asynchronous callback to return the result.
+> This API is deprecated since API version 9. You are advised to use [bundleMonitor#off](js-apis-bundleMonitor.md) instead.
**Required permissions**
@@ -161,16 +157,17 @@ This is a system API and cannot be called by third-party applications.
**Parameters**
-| Name | Type | Mandatory| Description |
+| Name | Type | Mandatory| Description |
| -------- | --------------------- | ---- | ---------------------------------------------------- |
| type | string | Yes | Event type. Only **BundleStatusChange** is supported. |
| callback | AsyncCallback\ | Yes | Callback used to return a successful result or error information.|
-## innerBundleManager.off
+## innerBundleManager.off(deprecated)
-off(type:"BundleStatusChange"): Promise<string>
+off(type:"BundleStatusChange") : Promise<string>
Deregisters the callback that receives bundle status changes. This API uses a promise to return the result.
+> This API is deprecated since API version 9. You are advised to use [bundleMonitor#off](js-apis-bundleMonitor.md) instead.
**Required permissions**
@@ -187,8 +184,8 @@ This is a system API and cannot be called by third-party applications.
**Parameters**
| Name| Type | Mandatory| Description |
-| ---- | ------ | ---- | ------------------------------------------ |
-| type | string | Yes | Event type. Only **BundleStatusChange** is supported.|
+| ------ | ------ | ---- | ------------------------------------------ |
+| type | string | Yes | Event type. Only **BundleStatusChange** is supported.|
**Return value**
@@ -196,11 +193,12 @@ This is a system API and cannot be called by third-party applications.
| --------------- | ----------------------------------- |
| Promise\ | Promise used to return a successful result or error information.|
-## innerBundleManager.getAllLauncherAbilityInfos
+## innerBundleManager.getAllLauncherAbilityInfos(deprecated)
getAllLauncherAbilityInfos(userId: number, callback: AsyncCallback<Array<LauncherAbilityInfo>>) : void;
Obtains the information about all launcher abilities. This API uses an asynchronous callback to return the result.
+> This API is deprecated since API version 9. You are advised to use [launcherBundleManager#getAllLauncherAbilityInfo](js-apis-launcherBundleManager.md) instead.
**Required permissions**
@@ -216,16 +214,17 @@ This is a system API and cannot be called by third-party applications.
**Parameters**
-| Name | Type | Mandatory| Description |
+| Name | Type | Mandatory| Description |
| -------- | ------------------------------------------------------------ | ---- | ----------------------------------------------------- |
| userId | number | Yes | User ID. The default value is the user ID of the caller. The value must be greater than or equal to 0.|
| callback | AsyncCallback\> | Yes | Callback used to return an array of the launcher ability information. |
-## innerBundleManager.getAllLauncherAbilityInfos
+## innerBundleManager.getAllLauncherAbilityInfos(deprecated)
getAllLauncherAbilityInfos(userId: number) : Promise<Array<LauncherAbilityInfo>>
Obtains the information about all launcher abilities. This API uses a promise to return the result.
+> This API is deprecated since API version 9. You are advised to use [launcherBundleManager#getAllLauncherAbilityInfo](js-apis-launcherBundleManager.md) instead.
**Required permissions**
@@ -241,7 +240,7 @@ This is a system API and cannot be called by third-party applications.
**Parameters**
-| Name | Type | Mandatory| Description |
+| Name| Type | Mandatory| Description |
| ------ | ------ | ---- | ----------------------------------------------------- |
| userId | number | Yes | User ID. The default value is the user ID of the caller. The value must be greater than or equal to 0.|
@@ -251,11 +250,12 @@ This is a system API and cannot be called by third-party applications.
| ------------------------------------------------------------ | ------------------------- |
| Promise\> | Promise used to return an array of the launcher ability information.|
-## innerBundleManager.getShortcutInfos
+## innerBundleManager.getShortcutInfos(deprecated)
getShortcutInfos(bundleName :string, callback: AsyncCallback<Array<ShortcutInfo>>) : void;
Obtains the shortcut information based on a given bundle name. This API uses an asynchronous callback to return the result.
+> This API is deprecated since API version 9. You are advised to use [launcherBundleManager#getShortcutInfo](js-apis-launcherBundleManager.md) instead.
**Required permissions**
@@ -271,16 +271,17 @@ This is a system API and cannot be called by third-party applications.
**Parameters**
-| Name | Type | Mandatory| Description |
+| Name | Type | Mandatory| Description |
| ---------- | ------------------------------------------------------------ | ---- | ---------------------------------------------- |
| bundleName | string | Yes | Bundle name of an application. |
| callback | AsyncCallback\> | Yes | Callback used to return an array of the shortcut information.|
-## innerBundleManager.getShortcutInfos
+## innerBundleManager.getShortcutInfos(deprecated)
getShortcutInfos(bundleName : string) : Promise<Array<ShortcutInfo>>
Obtains the shortcut information based on a given bundle name. This API uses a promise to return the result.
+> This API is deprecated since API version 9. You are advised to use [launcherBundleManager#getShortcutInfo](js-apis-launcherBundleManager.md) instead.
**Required permissions**
@@ -296,7 +297,7 @@ This is a system API and cannot be called by third-party applications.
**Parameters**
-| Name | Type | Mandatory| Description |
+| Name | Type | Mandatory| Description |
| ---------- | ------ | ---- | ------------------------ |
| bundleName | string | Yes | Bundle name of an application.|
diff --git a/en/application-dev/reference/apis/js-apis-Bundle-distributedBundle.md b/en/application-dev/reference/apis/js-apis-Bundle-distributedBundle.md
index 8701a6b80d7d54dc8bf6a30850c3551a741e77ed..493b263bd25d74fa7cfa5d9c59a45659fb4b5740 100644
--- a/en/application-dev/reference/apis/js-apis-Bundle-distributedBundle.md
+++ b/en/application-dev/reference/apis/js-apis-Bundle-distributedBundle.md
@@ -46,7 +46,7 @@ This is a system API and cannot be called by third-party applications.
**Parameters**
-| Name | Type | Mandatory| Description |
+| Name | Type | Mandatory| Description |
| ----------- | ------------------------------------------------------------ | ---- | -------------------------------------------------- |
| elementName | [ElementName](js-apis-bundle-ElementName.md) | Yes | **ElementName**. |
| callback | AsyncCallback<[RemoteAbilityInfo](js-apis-bundle-remoteAbilityInfo.md)> | Yes | Callback used to return the remote ability information.|
@@ -75,7 +75,7 @@ This is a system API and cannot be called by third-party applications.
**Parameters**
-| Name | Type | Mandatory| Description |
+| Name | Type | Mandatory| Description |
| ----------- | -------------------------------------------- | ---- | ----------------------- |
| elementName | [ElementName](js-apis-bundle-ElementName.md) | Yes | **ElementName**.|
@@ -107,10 +107,10 @@ This is a system API and cannot be called by third-party applications.
**Parameters**
-| Name | Type | Mandatory| Description |
+| Name | Type | Mandatory| Description |
| ------------ | ------------------------------------------------------------ | ---- | -------------------------------------------------- |
| elementNames | Array<[ElementName](js-apis-bundle-ElementName.md)> | Yes | **ElementName** array, whose maximum length is 10. |
-| callback | AsyncCallback< Array<[RemoteAbilityInfo](js-apis-bundle-remoteAbilityInfo.md)>> | Yes | Callback used to return the remote ability information.|
+| callback | AsyncCallback< Array<[RemoteAbilityInfo](js-apis-bundle-remoteAbilityInfo.md)>> | Yes | Callback used to return an array of the remote ability information.|
@@ -136,7 +136,7 @@ This is a system API and cannot be called by third-party applications.
**Parameters**
-| Name | Type | Mandatory| Description |
+| Name | Type | Mandatory| Description |
| ------------ | --------------------------------------------------- | ---- | ----------------------- |
| elementNames | Array<[ElementName](js-apis-bundle-ElementName.md)> | Yes | **ElementName** array, whose maximum length is 10.|
diff --git a/en/application-dev/reference/apis/js-apis-Bundle.md b/en/application-dev/reference/apis/js-apis-Bundle.md
index ca3b0873ab187379e62b7640c55bb650f84d4850..52a10b74d2346bc15d2fc17ce196b190bfbfa521 100644
--- a/en/application-dev/reference/apis/js-apis-Bundle.md
+++ b/en/application-dev/reference/apis/js-apis-Bundle.md
@@ -3,9 +3,8 @@
The **Bundle** module provides APIs for querying the information about bundles, applications, abilities, Extension abilities, and application states.
> **NOTE**
->
+>
> The initial APIs of this module are supported since API version 7. Newly added APIs will be marked with a superscript to indicate their earliest API version.
-> API version 9 is a canary version for trial use. The APIs of this version may be unstable.
## Modules to Import
```js
@@ -21,9 +20,11 @@ import bundle from '@ohos.bundle';
| ohos.permission.INSTALL_BUNDLE | system_core | Permission to install or uninstall applications. |
| ohos.permission.MANAGE_DISPOSED_APP_STATUS | system_core | Permission to set and query the application disposal status. |
-For details, see "Permission Levels" in [Access Control Overview](../../security/accesstoken-overview.md).
+For details, see [Permission Levels](../../security/accesstoken-overview.md#permission-levels).
-## bundle.getApplicationInfo
+## bundle.getApplicationInfodeprecated
+
+> This API is deprecated since API version 9. You are advised to use [bundleManager.getApplicationInfo](js-apis-bundleManager.md#bundlemanagergetapplicationinfo) instead.
getApplicationInfo(bundleName: string, bundleFlags: number, userId?: number): Promise\
@@ -39,7 +40,7 @@ SystemCapability.BundleManager.BundleFramework
**Parameters**
-| Name | Type | Mandatory| Description |
+| Name | Type | Mandatory| Description |
| ----------- | ------ | ---- | ------------------------------------------------------------ |
| bundleName | string | Yes | Bundle name of an application. |
| bundleFlags | number | Yes | Type of information that will be returned. The default value is **0**. For details on the available enumerated values, see the application information flags in [BundleFlag](#bundleflag).|
@@ -65,7 +66,9 @@ bundle.getApplicationInfo(bundleName, bundleFlags, userId)
})
```
-## bundle.getApplicationInfo
+## bundle.getApplicationInfodeprecated
+
+> This API is deprecated since API version 9. You are advised to use [bundleManager.getApplicationInfo](js-apis-bundleManager.md#bundlemanagergetapplicationinfo) instead.
getApplicationInfo(bundleName: string, bundleFlags: number, userId: number, callback: AsyncCallback\): void
@@ -81,7 +84,7 @@ SystemCapability.BundleManager.BundleFramework
**Parameters**
-| Name | Type | Mandatory| Description |
+| Name | Type | Mandatory| Description |
| ----------- | ------------------------------------------------------------ | ---- | ------------------------------------------------------------ |
| bundleName | string | Yes | Bundle name of an application. |
| bundleFlags | number | Yes | Type of information that will be returned. The default value is **0**. For details on the available enumerated values, see the application information flags in [BundleFlag](#bundleflag).|
@@ -103,7 +106,10 @@ bundle.getApplicationInfo(bundleName, bundleFlags, userId, (err, data) => {
})
```
-## bundle.getApplicationInfo
+## bundle.getApplicationInfodeprecated
+
+> This API is deprecated since API version 9. You are advised to use [bundleManager.getApplicationInfo](js-apis-bundleManager.md#bundlemanagergetapplicationinfo) instead.
+
getApplicationInfo(bundleName: string, bundleFlags: number, callback: AsyncCallback\): void
@@ -119,7 +125,7 @@ SystemCapability.BundleManager.BundleFramework
**Parameters**
-| Name | Type | Mandatory| Description |
+| Name | Type | Mandatory| Description |
| ----------- | ------------------------------------------------------------ | ---- | ------------------------------------------------------------ |
| bundleName | string | Yes | Bundle name of an application. |
| bundleFlags | number | Yes | Type of information that will be returned. The default value is **0**. For details on the available enumerated values, see the application information flags in [BundleFlag](#bundleflag).|
@@ -139,81 +145,10 @@ bundle.getApplicationInfo(bundleName, bundleFlags, (err, data) => {
})
```
-## bundle.getApplicationInfoSync9+
-
-getApplicationInfoSync(bundleName: string, bundleFlags: number, userId: number): ApplicationInfo;
-
-Obtains the application information of the specified user based on a given bundle name. This API returns the result synchronously.
-
-**Required permissions**
-
-ohos.permission.GET_BUNDLE_INFO_PRIVILEGED or ohos.permission.GET_BUNDLE_INFO
-
-**System capability**
-
-SystemCapability.BundleManager.BundleFramework
-
-**Parameters**
-
-| Name | Type | Mandatory| Description |
-| ----------- | ------ | ---- | ------------------------------------------------------------ |
-| bundleName | string | Yes | Bundle name of an application. |
-| bundleFlags | number | Yes | Type of information that will be returned. The default value is **0**. For details on the available enumerated values, see the application information flags in [BundleFlag](#bundleflag).|
-| userId | number | Yes | User ID. The default value is the user ID of the caller. The value must be greater than or equal to 0. |
-
-**Return value**
-
-| Type | Description |
-| ---------------------------------------------------- | ------------------- |
-| [ApplicationInfo](js-apis-bundle-ApplicationInfo.md) | **ApplicationInfo** object.|
-
-**Example**
-
-```js
-let bundleName = "com.example.myapplication";
-let bundleFlags = 0;
-let userId = 100;
-var applicationInfo = bundle.getApplicationInfoSync(bundleName, bundleFlags, userId);
-console.info('Operation successful. Name:' + applicationInfo.name);
-```
-
-## bundle.getApplicationInfoSync9+
-getApplicationInfoSync(bundleName: string, bundleFlags: number) : ApplicationInfo;
+## bundle.getAllBundleInfodeprecated
-Obtains the application information based on a given bundle name. This API returns the result synchronously.
-
-**Required permissions**
-
-ohos.permission.GET_BUNDLE_INFO_PRIVILEGED or ohos.permission.GET_BUNDLE_INFO
-
-**System capability**
-
-SystemCapability.BundleManager.BundleFramework
-
-**Parameters**
-
-| Name | Type | Mandatory| Description |
-| ----------- | ------ | ---- | ------------------------------------------------------------ |
-| bundleName | string | Yes | Bundle name of an application. |
-| bundleFlags | number | Yes | Type of information that will be returned. The default value is **0**. For details on the available enumerated values, see the application information flags in [BundleFlag](#bundleflag).|
-
-**Return value**
-
-| Type | Description |
-| ---------------------------------------------------- | ------------------- |
-| [ApplicationInfo](js-apis-bundle-ApplicationInfo.md) | **ApplicationInfo** object.|
-
-**Example**
-
-```js
-let bundleName = "com.example.myapplication";
-let bundleFlags = 0;
-var applicationInfo = bundle.getApplicationInfoSync(bundleName, bundleFlags);
-console.info('Operation successful. Name:' + applicationInfo.name);
-```
-
-## bundle.getAllBundleInfo
+> This API is deprecated since API version 9. You are advised to use [bundleManager.getAllBundleInfo](js-apis-bundleManager.md#bundlemanagergetallbundleinfo) instead.
getAllBundleInfo(bundleFlag: BundleFlag, userId?: number): Promise>
@@ -229,7 +164,7 @@ SystemCapability.BundleManager.BundleFramework
**Parameters**
-| Name | Type | Mandatory| Description |
+| Name | Type | Mandatory| Description |
| ---------- | ---------- | ---- | ------------------------------------------------------------ |
| bundleFlag | BundleFlag | Yes | Type of information that will be returned. The default value is **0**. For details on the available enumerated values, see the bundle information flags in [BundleFlag](#bundleflag).|
| userId | number | No | User ID. The default value is the user ID of the caller. The value must be greater than or equal to 0. |
@@ -253,7 +188,10 @@ bundle.getAllBundleInfo(bundleFlag, userId)
})
```
-## bundle.getAllBundleInfo
+## bundle.getAllBundleInfodeprecated
+
+> This API is deprecated since API version 9. You are advised to use [bundleManager.getAllBundleInfo](js-apis-bundleManager.md#bundlemanagergetallbundleinfo) instead.
+
getAllBundleInfo(bundleFlag: BundleFlag, callback: AsyncCallback>): void
@@ -269,7 +207,7 @@ SystemCapability.BundleManager.BundleFramework
**Parameters**
-| Name | Type | Mandatory| Description |
+| Name | Type | Mandatory| Description |
| ---------- | ------------------------------------------------------------ | ---- | ------------------------------------------------------------ |
| bundleFlag | BundleFlag | Yes | Type of information that will be returned. The default value is **0**. For details on the available enumerated values, see the bundle information flags in [BundleFlag](#bundleflag).|
| callback | AsyncCallback> | Yes | Callback used to return the information of all available bundles. |
@@ -287,7 +225,10 @@ bundle.getAllBundleInfo(bundleFlag, (err, data) => {
})
```
-## bundle.getAllBundleInfo
+## bundle.getAllBundleInfodeprecated
+
+> This API is deprecated since API version 9. You are advised to use [bundleManager.getAllBundleInfo](js-apis-bundleManager.md#bundlemanagergetallbundleinfo) instead.
+
getAllBundleInfo(bundleFlag: BundleFlag, userId: number, callback: AsyncCallback>): void
@@ -303,7 +244,7 @@ SystemCapability.BundleManager.BundleFramework
**Parameters**
-| Name | Type | Mandatory| Description |
+| Name | Type | Mandatory| Description |
| ---------- | ------------------------------------------------------------ | ---- | ------------------------------------------------------------ |
| bundleFlag | BundleFlag | Yes | Type of information that will be returned. The default value is **0**. For details on the available enumerated values, see the bundle information flags in [BundleFlag](#bundleflag).|
| userId | number | Yes | User ID. The default value is the user ID of the caller. The value must be greater than or equal to 0. |
@@ -323,7 +264,10 @@ bundle.getAllBundleInfo(bundleFlag, userId, (err, data) => {
})
```
-## bundle.getBundleInfo
+## bundle.getBundleInfodeprecated
+
+> This API is deprecated since API version 9. You are advised to use [bundleManager.getBundleInfo](js-apis-bundleManager.md#bundlemanagergetbundleinfo) instead.
+
getBundleInfo(bundleName: string, bundleFlags: number, options?: BundleOptions): Promise\
@@ -339,7 +283,7 @@ SystemCapability.BundleManager.BundleFramework
**Parameters**
-| Name | Type | Mandatory | Description |
+| Name | Type | Mandatory | Description |
| ----------- | ------------- | ---- | --------------------------------------- |
| bundleName | string | Yes | Bundle name of an application. |
| bundleFlags | number | Yes | Type of information that will be returned. The default value is **0**. For details on the available enumerated values, see the bundle information flags in [BundleFlag](#bundleflag).|
@@ -367,7 +311,9 @@ bundle.getBundleInfo(bundleName, bundleFlags, options)
})
```
-## bundle.getBundleInfo
+## bundle.getBundleInfodeprecated
+
+> This API is deprecated since API version 9. You are advised to use [bundleManager.getBundleInfo](js-apis-bundleManager.md#bundlemanagergetbundleinfo) instead.
getBundleInfo(bundleName: string, bundleFlags: number, callback: AsyncCallback\): void
@@ -383,7 +329,7 @@ SystemCapability.BundleManager.BundleFramework
**Parameters**
-| Name | Type | Mandatory| Description |
+| Name | Type | Mandatory| Description |
| ----------- | ---------------------------------------------------------- | ---- | ------------------------------------------------------------ |
| bundleName | string | Yes | Bundle name of an application. |
| bundleFlags | number | Yes | Type of information that will be returned. The default value is **0**. For details on the available enumerated values, see the bundle information flags in [BundleFlag](#bundleflag).|
@@ -404,7 +350,9 @@ bundle.getBundleInfo(bundleName, bundleFlags, (err, data) => {
```
-## bundle.getBundleInfo
+## bundle.getBundleInfodeprecated
+
+> This API is deprecated since API version 9. You are advised to use [bundleManager.getBundleInfo](js-apis-bundleManager.md#bundlemanagergetbundleinfo) instead.
getBundleInfo(bundleName: string, bundleFlags: number, options: BundleOptions, callback: AsyncCallback\): void
@@ -420,7 +368,7 @@ SystemCapability.BundleManager.BundleFramework
**Parameters**
-| Name | Type | Mandatory| Description |
+| Name | Type | Mandatory| Description |
| ----------- | ---------------------------------------------------------- | ---- | ------------------------------------------------------------ |
| bundleName | string | Yes | Bundle name of an application. |
| bundleFlags | number | Yes | Type of information that will be returned. The default value is **0**. For details on the available enumerated values, see the bundle information flags in [BundleFlag](#bundleflag).|
@@ -444,83 +392,11 @@ bundle.getBundleInfo(bundleName, bundleFlags, options, (err, data) => {
})
```
-## bundle.getBundleInfoSync9+
-getBundleInfoSync(bundleName: string, bundleFlags: number, options: BundleOptions): BundleInfo;
-Obtains the bundle information based on a given bundle name and bundle options. This API returns the result synchronously.
+## bundle.getBundleInstallerdeprecated
-**Required permissions**
-
-ohos.permission.GET_BUNDLE_INFO_PRIVILEGED or ohos.permission.GET_BUNDLE_INFO
-
-**System capability**
-
-SystemCapability.BundleManager.BundleFramework
-
-**Parameters**
-
-| Name | Type | Mandatory| Description |
-| ----------- | ------------------------------- | ---- | ------------------------------------------------------------ |
-| bundleName | string | Yes | Bundle name of an application. |
-| bundleFlags | number | Yes | Type of information that will be returned. The default value is **0**. For details on the available enumerated values, see the bundle information flags in [BundleFlag](#bundleflag).|
-| options | [BundleOptions](#bundleoptions) | Yes | Options of the bundle. |
-
-**Return value**
-
-| Type | Description |
-| ------------------------------------------ | -------------- |
-| [BundleInfo](js-apis-bundle-BundleInfo.md) | **BundleInfo** object.|
-
-**Example**
-
-```js
-let bundleName = "com.example.myapplication";
-let bundleFlags = 1;
-let options = {
- "userId" : 100
-};
-var bundleInfo = bundle.getBundleInfoSync(bundleName, bundleFlags, options);
-console.info('Operation successful. Name:' + bundleInfo.name);
-```
-
-## bundle.getBundleInfoSync9+
-
-getBundleInfoSync(bundleName: string, bundleFlags: number): BundleInfo;
-
-Obtains the bundle information based on a given bundle name. This API returns the result synchronously.
-
-**Required permissions**
-
-ohos.permission.GET_BUNDLE_INFO_PRIVILEGED or ohos.permission.GET_BUNDLE_INFO
-
-**System capability**
-
-SystemCapability.BundleManager.BundleFramework
-
-**Parameters**
-
-| Name | Type | Mandatory| Description |
-| ----------- | ------ | ---- | ------------------------------------------------------------ |
-| bundleName | string | Yes | Bundle name of an application. |
-| bundleFlags | number | Yes | Type of information that will be returned. The default value is **0**. For details on the available enumerated values, see the bundle information flags in [BundleFlag](#bundleflag).|
-
-**Return value**
-
-| Type | Description |
-| ------------------------------------------ | -------------- |
-| [BundleInfo](js-apis-bundle-BundleInfo.md) | **BundleInfo** object.|
-
-**Example**
-
-```js
-let bundleName = "com.example.myapplication";
-let bundleFlags = 1;
-var bundleInfo = bundle.getBundleInfoSync(bundleName, bundleFlags);
-console.info('Operation successful. Name:' + bundleInfo.name);
-```
-
-## bundle.getBundleInstaller
+> This API is deprecated since API version 9. You are advised to use [installer.getBundleInstaller](js-apis-installer.md#bundleinstallergetbundleinstaller) instead.
getBundleInstaller(): Promise<BundleInstaller>;
@@ -544,7 +420,9 @@ This is a system API and cannot be called by third-party applications.
| ------------------------------------------------------------ | -------------------------------------------- |
| Promise<[BundleInstaller](js-apis-bundle-BundleInstaller.md)> | Promise used to return the installation package information.|
-## bundle.getBundleInstaller
+## bundle.getBundleInstallerdeprecated
+
+> This API is deprecated since API version 9. You are advised to use [installer.getBundleInstaller](js-apis-installer.md#bundleinstallergetbundleinstaller) instead.
getBundleInstaller(callback: AsyncCallback<BundleInstaller>): void;
@@ -564,11 +442,13 @@ This is a system API and cannot be called by third-party applications.
**Parameters**
-| Name | Type | Mandatory| Description |
+| Name | Type | Mandatory| Description |
| -------- | ------------------------------------------------------------ | ---- | ---------------- |
| callback | AsyncCallback<[BundleInstaller](js-apis-bundle-BundleInstaller.md)> | Yes | Callback used to return the installation package information.|
-## bundle.cleanBundleCacheFiles8+
+## bundle.cleanBundleCacheFiles8+ deprecated
+
+> This API is deprecated since API version 9. You are advised to use [bundleManager.cleanBundleCacheFiles](js-apis-bundleManager.md#bundlemanagercleanbundlecachefiles) instead.
cleanBundleCacheFiles(bundleName: string, callback: AsyncCallback<void>): void;
@@ -588,12 +468,14 @@ This is a system API and cannot be called by third-party applications.
**Parameters**
-| Name | Type | Mandatory| Description |
+| Name | Type | Mandatory| Description |
| ---------- | ------------------- | ---- | ------------------------------------- |
| bundleName | string | Yes | Bundle name of an application.|
| callback | AsyncCallback\ | Yes | Callback used to return the result. |
-## bundle.cleanBundleCacheFiles8+
+## bundle.cleanBundleCacheFiles8+ deprecated
+
+> This API is deprecated since API version 9. You are advised to use [bundleManager.cleanBundleCacheFiles](js-apis-bundleManager.md#bundlemanagercleanbundlecachefiles) instead.
cleanBundleCacheFiles(bundleName: string): Promise<void>
@@ -613,7 +495,7 @@ This is a system API and cannot be called by third-party applications.
**Parameters**
-| Name | Type | Mandatory| Description |
+| Name | Type | Mandatory| Description |
| ---------- | ------ | ---- | ------------------------------------- |
| bundleName | string | Yes | Bundle name of an application.|
@@ -623,7 +505,9 @@ This is a system API and cannot be called by third-party applications.
| ------------- | ------------------------------------ |
| Promise\ | Promise that returns no value.|
-## bundle.setApplicationEnabled8+
+## bundle.setApplicationEnabled8+ deprecated
+
+> This API is deprecated since API version 9. You are advised to use [bundleManager.setApplicationEnabled](js-apis-bundleManager.md#bundlemanagersetapplicationenabled) instead.
setApplicationEnabled(bundleName: string, isEnable: boolean, callback: AsyncCallback<void>): void;
@@ -643,13 +527,15 @@ This is a system API and cannot be called by third-party applications.
**Parameters**
-| Name | Type | Mandatory| Description |
+| Name | Type | Mandatory| Description |
| ---------- | ------------------- | ---- | ----------------------------------------------- |
| bundleName | string | Yes | Bundle name of an application. |
| isEnable | boolean | Yes | Whether to enable the application. The value **true** means to enable the application, and **false** means the opposite.|
| callback | AsyncCallback\ | Yes | Callback used to return the result. |
-## bundle.setApplicationEnabled8+
+## bundle.setApplicationEnabled8+ deprecated
+
+> This API is deprecated since API version 9. You are advised to use [bundleManager.setApplicationEnabled](js-apis-bundleManager.md#bundlemanagersetapplicationenabled) instead.
setApplicationEnabled(bundleName: string, isEnable: boolean): Promise<void>
@@ -669,7 +555,7 @@ This is a system API and cannot be called by third-party applications.
**Parameters**
-| Name | Type | Mandatory| Description |
+| Name | Type | Mandatory| Description |
| ---------- | ------- | ---- | ----------------------------------------------- |
| bundleName | string | Yes | Bundle name of an application. |
| isEnable | boolean | Yes | Whether to enable the application. The value **true** means to enable the application, and **false** means the opposite.|
@@ -680,7 +566,9 @@ This is a system API and cannot be called by third-party applications.
| ------------- | ------------------------------------ |
| Promise\ | Promise that returns no value.|
-## bundle.setAbilityEnabled8+
+## bundle.setAbilityEnabled8+ deprecated
+
+> This API is deprecated since API version 9. You are advised to use [bundleManager.setAbilityEnabled](js-apis-bundleManager.md#bundlemanagersetabilityenabled) instead.
setAbilityEnabled(info: AbilityInfo, isEnable: boolean, callback: AsyncCallback<void>): void;
@@ -700,13 +588,15 @@ This is a system API and cannot be called by third-party applications.
**Parameters**
-| Name | Type | Mandatory| Description |
+| Name | Type | Mandatory| Description |
| -------- | -------------------------------------------- | ---- | ----------------------------------------------- |
| info | [AbilityInfo](js-apis-bundle-AbilityInfo.md) | Yes | Ability information. |
-| isEnable | boolean | Yes | Whether to enable the ability. The value **true** means to enable the ability, and **false** means the opposite.|
-| callback | AsyncCallback\ | Yes | Callback used to return the result. |
+| isEnable | boolean | Yes | Whether to enable the application. The value **true** means to enable the application, and **false** means the opposite.|
+| callback | AsyncCallback\ | Yes | Callback used to return the result. |
+
+## bundle.setAbilityEnabled8+ deprecated
-## bundle.setAbilityEnabled8+
+> This API is deprecated since API version 9. You are advised to use [bundleManager.setAbilityEnabled](js-apis-bundleManager.md#bundlemanagersetabilityenabled) instead.
setAbilityEnabled(info: AbilityInfo, isEnable: boolean): Promise<void>
@@ -726,10 +616,10 @@ This is a system API and cannot be called by third-party applications.
**Parameters**
-| Name | Type | Mandatory| Description |
+| Name | Type | Mandatory| Description |
| -------- | -------------------------------------------- | ---- | ----------------------------------------------- |
| info | [AbilityInfo](js-apis-bundle-AbilityInfo.md) | Yes | Ability information. |
-| isEnable | boolean | Yes | Whether to enable the ability. The value **true** means to enable the ability, and **false** means the opposite.|
+| isEnable | boolean | Yes | Whether to enable the application. The value **true** means to enable the application, and **false** means the opposite.|
**Return value**
@@ -737,7 +627,9 @@ This is a system API and cannot be called by third-party applications.
| ------------- | ------------------------------------ |
| Promise\ | Promise that returns no value.|
-## bundle.getPermissionDef8+
+## bundle.getPermissionDef8+ deprecated
+
+> This API is deprecated since API version 9. You are advised to use [bundleManager.getPermissionDef](js-apis-bundleManager.md#bundlemanagergetpermissiondef) instead.
getPermissionDef(permissionName: string, callback: AsyncCallback<PermissionDef>): void;
@@ -757,12 +649,14 @@ This is a system API and cannot be called by third-party applications.
**Parameters**
-| Name | Type | Mandatory| Description |
+| Name | Type | Mandatory| Description |
| -------------- | ------------------------------------------------------------ | ---- | ------------------------------------------------ |
| permissionName | string | Yes | Name of the permission. |
| callback | AsyncCallback<[PermissionDef](js-apis-bundle-PermissionDef)> | Yes | Callback used to return the permission details.|
-## bundle.getPermissionDef8+
+## bundle.getPermissionDef8+ deprecated
+
+> This API is deprecated since API version 9. You are advised to use [bundleManager.getPermissionDef](js-apis-bundleManager.md#bundlemanagergetpermissiondef) instead.
getPermissionDef(permissionName: string): Promise<PermissionDef>
@@ -782,7 +676,7 @@ This is a system API and cannot be called by third-party applications.
**Parameters**
-| Name | Type | Mandatory| Description |
+| Name | Type | Mandatory| Description |
| -------------- | ------ | ---- | ---------------- |
| permissionName | string | Yes | Name of the permission.|
@@ -792,196 +686,10 @@ This is a system API and cannot be called by third-party applications.
| ------------------------------------------------------ | ------------------------------------------------------ |
| Promise<[PermissionDef](js-apis-bundle-PermissionDef)> | Promise used to return the permission details.|
-## bundle.setModuleUpgradeFlag9+
-
-setModuleUpgradeFlag(bundleName: string, moduleName: string, upgradeFlag: UpgradeFlag, callback: AsyncCallback<void>):void;
-
-Sets whether the module needs an upgrade. This API uses an asynchronous callback to return the result.
-
-**System capability**
-
-SystemCapability.BundleManager.BundleFramework
-
-**System API**
-
-This is a system API and cannot be called by third-party applications.
-
-**Parameters**
-
-| Name | Type | Mandatory| Description |
-| ----------- | --------------------------- | ---- | ---------------------------- |
-| bundleName | string | Yes | Bundle name of an application. |
-| moduleName | string | Yes | Module name of the application. |
-| upgradeFlag | [UpgradeFlag](#upgradeflag) | Yes | Upgrade flag, which is used only by the internal system. |
-| callback | AsyncCallback\ | Yes | Callback used to return the result.|
-
-## bundle.setModuleUpgradeFlag9+
-
-setModuleUpgradeFlag(bundleName: string, moduleName: string, upgradeFlag: UpgradeFlag): Promise<void>
-
-Sets whether the module needs an upgrade. This API uses a promise to return the result.
-
-**System capability**
-
-SystemCapability.BundleManager.BundleFramework
-
-**System API**
-
-This is a system API and cannot be called by third-party applications.
-
-**Parameters**
-
-| Name | Type | Mandatory| Description |
-| ----------- | --------------------------- | ---- | ---------------------- |
-| bundleName | string | Yes | Bundle name of an application. |
-| moduleName | string | Yes | Module name of the application. |
-| upgradeFlag | [UpgradeFlag](#upgradeflag) | Yes | Upgrade flag, which is for internal use only.|
-
-**Return value**
-
-| Type | Description |
-| ------------- | ------------------------------------ |
-| Promise\ | Promise that returns no value.|
-
-## bundle.isModuleRemovable9+
-
-isModuleRemovable(bundleName: string, moduleName: string, callback: AsyncCallback<boolean>): void;
-
-Checks whether a module is removable. This API uses an asynchronous callback to return the result.
-
-**System capability**
-
-SystemCapability.BundleManager.BundleFramework
-
-**System API**
-
-This is a system API and cannot be called by third-party applications.
-
-**Parameters**
-
-| Name | Type | Mandatory| Description |
-| ---------- | ---------------------- | ---- | --------------------------------------------- |
-| bundleName | string | Yes | Bundle name of an application. |
-| moduleName | string | Yes | Module name of the application. |
-| callback | AsyncCallback\ | Yes | Callback used to return the result. If the module is removable, **true** is returned. Otherwise, **false** is returned.|
-
-## bundle.isModuleRemovable9+
-
-isModuleRemovable(bundleName: string, moduleName: string): Promise<boolean>
-
-Checks whether a module is removable. This API uses a promise to return the result.
-
-**System capability**
-
-SystemCapability.BundleManager.BundleFramework
-
-**System API**
-
-This is a system API and cannot be called by third-party applications.
-
-**Parameters**
-
-| Name | Type | Mandatory| Description |
-| ---------- | ------ | ---- | ------------------ |
-| bundleName | string | Yes | Bundle name of an application. |
-| moduleName | string | Yes | Module name of the application.|
-
-**Return value**
-
-| Type | Description |
-| ---------------- | ---------------------------- |
-| Promise\ | Promise used to return the result. If the module is removable, **true** is returned. Otherwise, **false** is returned.|
-
-## bundle.getBundlePackInfo9+
-
-getBundlePackInfo(bundleName: string, bundlePackFlag : pack.BundlePackFlag, callback: AsyncCallback<pack.BundlePackInfo>): void;
-
-Obtains the bundle package information based on a given bundle name and bundle flags. This API uses an asynchronous callback to return the result.
-
-**System capability**
-
-SystemCapability.BundleManager.BundleFramework
-
-**System API**
-
-This is a system API and cannot be called by third-party applications.
-
-**Parameters**
-
-| Name | Type | Mandatory| Description |
-| -------------- | ------------------------------------------------------------ | ---- | ---------------------------------------------------- |
-| bundleName | string | Yes | Bundle name of an application. |
-| bundlePackFlag | pack.BundlePackFlag | Yes | Flags of the bundle package. |
-| callback | AsyncCallback | Yes | Callback used to return the bundle package information.|
-
-## bundle.getBundlePackInfo9+
-
-getBundlePackInfo(bundleName: string, bundlePackFlag : pack.BundlePackFlag): Promise<pack.BundlePackInfo>;
-
-Obtains the bundle package information based on a given bundle name and bundle flags. This API uses a promise to return the result.
-
-**System capability**
-
-SystemCapability.BundleManager.BundleFramework
-
-**System API**
-
-This is a system API and cannot be called by third-party applications.
-
-**Parameters**
-
-| Name | Type | Mandatory| Description |
-| -------------- | ------------------------------------------------- | ---- | ---------------------- |
-| bundleName | string | Yes | Bundle name of an application. |
-| bundlePackFlag | pack.BundlePackFlag | Yes | Flags of the bundle package.|
-
-**Return value**
-
-| Type | Description |
-| ---------------------------- | ------------------------------------------------------ |
-| Promise | Promise used to return the bundle package information. |
-
-## bundle.getDispatcherVersion9+
-
-getDispatcherVersion(callback: AsyncCallback<DispatchInfo>): void;
-
-Obtains the dispatcher version. This API uses an asynchronous callback to return the result.
-
-**System capability**
-
-SystemCapability.BundleManager.BundleFramework
-**System API**
-
-This is a system API and cannot be called by third-party applications.
-
-**Parameters**
-
-| Name | Type | Mandatory| Description |
-| -------- | ------------------------------------------------------ | ---- | ------------------------------------------------------------ |
-| callback | AsyncCallback<[DispatchInfo](js-apis-dispatchInfo.md)> | Yes | Callback used to return the [DispatchInfo](js-apis-dispatchInfo.md).|
-
-## bundle.getDispatcherVersion9+
-
-getDispatcherVersion(): Promise<DispatchInfo>;
-
-Obtains the dispatcher version. This API uses a promise to return the result.
-
-**System capability**
-
-SystemCapability.BundleManager.BundleFramework
-
-**System API**
-
-This is a system API and cannot be called by third-party applications.
-
-**Return value**
-
-| Type | Description |
-| ------------------------------------------------ | ------------------------------------------------------------ |
-| Promise<[DispatchInfo](js-apis-dispatchInfo.md)> | Promise used to return the [DispatchInfo](js-apis-dispatchInfo.md).|
+## bundle.getAllApplicationInfodeprecated
-## bundle.getAllApplicationInfo
+> This API is deprecated since API version 9. You are advised to use [bundleManager.getAllApplicationInfo](js-apis-bundleManager.md#bundlemanagergetallapplicationinfo) instead.
getAllApplicationInfo(bundleFlags: number, userId?: number): Promise>
@@ -997,10 +705,10 @@ SystemCapability.BundleManager.BundleFramework
**Parameters**
-| Name | Type | Mandatory| Description |
+| Name | Type | Mandatory| Description |
| ----------- | ------ | ---- | ------------------------------------------------------------ |
| bundleFlags | number | Yes | Type of information that will be returned. The default value is **0**. For details on the available enumerated values, see the application information flags in [BundleFlag](#bundleflag).|
-| userId | number | No | User ID. The default value is the user ID of the caller. The value must be greater than or equal to 0. |
+| userId | number | Yes | User ID. The default value is the user ID of the caller. The value must be greater than or equal to 0. |
**Return value**
@@ -1021,9 +729,9 @@ bundle.getAllApplicationInfo(bundleFlags, userId)
})
```
+## bundle.getAllApplicationInfodeprecated
-
-## bundle.getAllApplicationInfo
+> This API is deprecated since API version 9. You are advised to use [bundleManager.getAllApplicationInfo](js-apis-bundleManager.md#bundlemanagergetallapplicationinfo) instead.
getAllApplicationInfo(bundleFlags: number, userId: number, callback: AsyncCallback>): void
@@ -1039,10 +747,10 @@ SystemCapability.BundleManager.BundleFramework
**Parameters**
-| Name | Type | Mandatory| Description |
+| Name | Type | Mandatory| Description |
| ----------- | ------------------------------------------------------------ | ---- | ------------------------------------------------------------ |
| bundleFlags | number | Yes | Type of information that will be returned. The default value is **0**. For details on the available enumerated values, see the application information flags in [BundleFlag](#bundleflag).|
-| userId | number | No | User ID. The default value is the user ID of the caller. The value must be greater than or equal to 0. |
+| userId | number | Yes | User ID. The default value is the user ID of the caller. The value must be greater than or equal to 0. |
| callback | AsyncCallback> | Yes | Callback used to return the application information. |
**Example**
@@ -1060,7 +768,9 @@ bundle.getAllApplicationInfo(bundleFlags, userId, (err, data) => {
```
-## bundle.getAllApplicationInfo
+## bundle.getAllApplicationInfodeprecated
+
+> This API is deprecated since API version 9. You are advised to use [bundleManager.getAllApplicationInfo](js-apis-bundleManager.md#bundlemanagergetallapplicationinfo) instead.
getAllApplicationInfo(bundleFlags: number, callback: AsyncCallback>) : void;
@@ -1076,7 +786,7 @@ SystemCapability.BundleManager.BundleFramework
**Parameters**
-| Name | Type | Mandatory| Description |
+| Name | Type | Mandatory| Description |
| ----------- | ------------------------------------------------------------ | ---- | ------------------------------------------------------------ |
| bundleFlags | number | Yes | Type of information that will be returned. The default value is **0**. For details on the available enumerated values, see the application information flags in [BundleFlag](#bundleflag).|
| callback | AsyncCallback> | Yes | Callback used to return the application information. |
@@ -1094,7 +804,9 @@ bundle.getAllApplicationInfo(bundleFlags, (err, data) => {
})
```
-## bundle.getBundleArchiveInfo
+## bundle.getBundleArchiveInfodeprecated
+
+> This API is deprecated since API version 9. You are advised to use [bundleManager.getBundleArchiveInfo](js-apis-bundleManager.md#bundlemanagergetbundlearchiveinfo) instead.
getBundleArchiveInfo(hapFilePath: string, bundleFlags: number) : Promise\
@@ -1106,7 +818,7 @@ SystemCapability.BundleManager.BundleFramework
**Parameters**
-| Name | Type | Mandatory | Description |
+| Name | Type | Mandatory | Description |
| ---------- | ------ | ---- | ------------ |
| hapFilePath | string | Yes | Path where the HAP file is stored. The path should point to the relative directory of the current application's data directory.|
| bundleFlags | number | Yes | Flags used to specify information contained in the **BundleInfo** object that will be returned. The default value is **0**. For details on the available enumerated values, see the bundle information flags in [BundleFlag](#bundleflag).|
@@ -1129,7 +841,9 @@ bundle.getBundleArchiveInfo(hapFilePath, bundleFlags)
})
```
-## bundle.getBundleArchiveInfo
+## bundle.getBundleArchiveInfodeprecated
+
+> This API is deprecated since API version 9. You are advised to use [bundleManager.getBundleArchiveInfo](js-apis-bundleManager.md#bundlemanagergetbundlearchiveinfo) instead.
getBundleArchiveInfo(hapFilePath: string, bundleFlags: number, callback: AsyncCallback\) : void
@@ -1141,7 +855,7 @@ SystemCapability.BundleManager.BundleFramework
**Parameters**
-| Name | Type | Mandatory | Description |
+| Name | Type | Mandatory | Description |
| ---------- | ------ | ---- | ------------ |
| hapFilePath | string | Yes | Path where the HAP file is stored. The path should point to the relative directory of the current application's data directory.|
| bundleFlags | number | Yes | Flags used to specify information contained in the **BundleInfo** object that will be returned. The default value is **0**. For details on the available enumerated values, see the bundle information flags in [BundleFlag](#bundleflag).|
@@ -1162,7 +876,9 @@ bundle.getBundleArchiveInfo(hapFilePath, bundleFlags, (err, data) => {
```
-## bundle.getAbilityInfo
+## bundle.getAbilityInfodeprecated
+
+> This API is deprecated since API version 9. You are advised to use [bundleManager.queryAbilityInfo](js-apis-bundleManager.md#bundlemanagerqueryabilityinfo) instead.
getAbilityInfo(bundleName: string, abilityName: string): Promise\