Skip to content

D
Docs

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

通知 161
Star 293
Fork 28
D
Docs
提交 f7d7c3d4 编写于 作者: S shawn_he 提交者： Gitee
浏览文件
操作

Merge branch 'master' of gitee.com:openharmony/docs into 18387-d 

Signed-off-by: Nshawn_he <shawn.he@huawei.com>
上级 4074086a d206014f
展开全部 显示空白变更内容
内联 并排
Showing with 45336 addition and 16398 deletion
en/application-dev/application-models/Readme-EN.md
浏览文件 @ f7d7c3d4
...@@ -20,7 +20,7 @@ ...@@ -20,7 +20,7 @@
- [AccessibilityExtensionAbility](accessibilityextensionability.md) - [AccessibilityExtensionAbility](accessibilityextensionability.md)
- [EnterpriseAdminExtensionAbility](enterprise-extensionAbility.md) - [EnterpriseAdminExtensionAbility](enterprise-extensionAbility.md)
- [InputMethodExtensionAbility](inputmethodextentionability.md) - [InputMethodExtensionAbility](inputmethodextentionability.md)
- [WindowExtensionAbility](windowextensionability.md) - [WindowExtensionAbility (for System Applications Only)](windowextensionability.md)
- Service Widget Development in Stage Model - Service Widget Development in Stage Model
- [Service Widget Overview](service-widget-overview.md) - [Service Widget Overview](service-widget-overview.md)
- Developing an ArkTS Widget - Developing an ArkTS Widget
...@@ -36,9 +36,10 @@ ...@@ -36,9 +36,10 @@
- [Applying Custom Drawing in the Widget](arkts-ui-widget-page-custom-drawing.md) - [Applying Custom Drawing in the Widget](arkts-ui-widget-page-custom-drawing.md)
- Widget Event Development - Widget Event Development
- [Widget Event Capability Overview](arkts-ui-widget-event-overview.md) - [Widget Event Capability Overview](arkts-ui-widget-event-overview.md)
- [Redirecting to a Specified Page Through the Router Event](arkts-ui-widget-event-router.md) - [Redirecting to a UIAbility Through the router Event](arkts-ui-widget-event-router.md)
- [Updating Widget Content Through FormExtensionAbility](arkts-ui-widget-event-formextensionability.md) - [Launching a UIAbility in the Background Through the call Event](arkts-ui-widget-event-call.md)
- [Updating Widget Content Through UIAbility](arkts-ui-widget-event-uiability.md) - [Updating Widget Content Through the message Event](arkts-ui-widget-event-formextensionability.md)
- [Updating Widget Content Through the router or call Event](arkts-ui-widget-event-uiability.md)
- Widget Data Interaction - Widget Data Interaction
- [Widget Data Interaction Overview](arkts-ui-widget-interaction-overview.md) - [Widget Data Interaction Overview](arkts-ui-widget-interaction-overview.md)
- [Configuring a Widget to Update Periodically](arkts-ui-widget-update-by-time.md) - [Configuring a Widget to Update Periodically](arkts-ui-widget-update-by-time.md)
...@@ -52,7 +53,7 @@ ...@@ -52,7 +53,7 @@
- [Want Overview](want-overview.md) - [Want Overview](want-overview.md)
- [Matching Rules of Explicit Want and Implicit Want](explicit-implicit-want-mappings.md) - [Matching Rules of Explicit Want and Implicit Want](explicit-implicit-want-mappings.md)
- [Common action and entities Values](actions-entities.md) - [Common action and entities Values](actions-entities.md)
- [Using Explicit Want to Start an Ability](ability-startup-with-explicit-want.md) - [Using Explicit Want to Start an Application Component](ability-startup-with-explicit-want.md)
- [Using Implicit Want to Open a Website](ability-startup-with-implicit-want.md) - [Using Implicit Want to Open a Website](ability-startup-with-implicit-want.md)
- [Using Want to Share Data Between Applications](data-share-via-want.md) - [Using Want to Share Data Between Applications](data-share-via-want.md)
- [Component Startup Rules](component-startup-rules.md) - [Component Startup Rules](component-startup-rules.md)
...@@ -71,7 +72,7 @@ ...@@ -71,7 +72,7 @@
- [Subscribing to Common Events in Static Mode (for System Applications Only)](common-event-static-subscription.md) - [Subscribing to Common Events in Static Mode (for System Applications Only)](common-event-static-subscription.md)
- [Unsubscribing from Common Events](common-event-unsubscription.md) - [Unsubscribing from Common Events](common-event-unsubscription.md)
- [Publishing Common Events](common-event-publish.md) - [Publishing Common Events](common-event-publish.md)
- [Removing Sticky Common Events](common-event-remove-sticky.md) - [Removing Sticky Common Events (for System Applications Only)](common-event-remove-sticky.md)
- [Background Services](background-services.md) - [Background Services](background-services.md)
- Thread Model - Thread Model
- [Thread Model Overview](thread-model-stage.md) - [Thread Model Overview](thread-model-stage.md)
......
en/application-dev/application-models/ability-startup-with-explicit-want.md
浏览文件 @ f7d7c3d4
# Using Explicit Want to Start an Ability # Using Explicit Want to Start an Application Component
When a user touches a button in an application, the application often needs to start a UIAbility component to complete a specific task. If the **abilityName** and **bundleName** parameters are specified when starting a UIAbility, then the explicit Want is used. When a user touches a button in an application, the application often needs to start a UIAbility component to complete a specific task. If the **abilityName** and **bundleName** parameters are specified when starting a UIAbility, then the explicit Want is used.
......
en/application-dev/application-models/ability-startup-with-implicit-want.md
浏览文件 @ f7d7c3d4
...@@ -5,21 +5,21 @@ This section uses the operation of using a browser to open a website as an examp ...@@ -5,21 +5,21 @@ This section uses the operation of using a browser to open a website as an examp
```json ```json
{ {
"module": { "module": {
// ... ...
"abilities": [ "abilities": [
{ {
// ... ...
"skills": [ "skills": [
{ {
"entities": [ "entities": [
"entity.system.home", "entity.system.home",
"entity.system.browsable" "entity.system.browsable"
// ... ...
], ],
"actions": [ "actions": [
"action.system.home", "action.system.home",
"ohos.want.action.viewData" "ohos.want.action.viewData"
// ... ...
], ],
"uris": [ "uris": [
{ {
...@@ -31,9 +31,9 @@ This section uses the operation of using a browser to open a website as an examp ...@@ -31,9 +31,9 @@ This section uses the operation of using a browser to open a website as an examp
}, },
{ {
"scheme": "http", "scheme": "http",
// ... ...
} }
// ... ...
] ]
} }
] ]
...@@ -59,19 +59,18 @@ function implicitStartAbility() { ...@@ -59,19 +59,18 @@ function implicitStartAbility() {
'uri': 'https://www.test.com:8080/query/student' 'uri': 'https://www.test.com:8080/query/student'
} }
context.startAbility(wantInfo).then(() => { context.startAbility(wantInfo).then(() => {
// ... ...
}).catch((err) => { }).catch((err) => {
// ... ...
}) })
} }
``` ```
The matching process is as follows: The matching process is as follows:
1. If **action** in the passed **want** parameter is specified and is included in **actions** under **skills** of the ability to match, the matching is successful. 1. If **action** in the passed **want** parameter is specified and is included in **actions** under **skills** of the application component to match, the matching is successful.
2. If **entities** in the passed **want** parameter is specified and is included in **entities** under **skills** of the ability to match, the matching is successful. 2. If **entities** in the passed **want** parameter is specified and is included in **entities** under **skills** of the application component to match, the matching is successful.
3. If **uri** in the passed **want** parameter is included in **uris** under **skills** of the ability to match, which is concatenated into https://www.test.com:8080/query* (where * is a wildcard), the matching is successful. 3. If **uri** in the passed **want** parameter is included in **uris** under **skills** of the application component to match, which is concatenated into https://www.test.com:8080/query* (where * is a wildcard), the matching is successful.
4. If **type** in the passed **want** parameter is specified and is included in **type** under **skills** of the ability to match, the matching is successful.
If there are multiple matching applications, the system displays a dialog box for you to select one of them. The following figure shows an example. If there are multiple matching applications, the system displays a dialog box for you to select one of them. The following figure shows an example.
......
en/application-dev/application-models/abilitystage.md
浏览文件 @ f7d7c3d4
...@@ -24,7 +24,7 @@ AbilityStage is not automatically generated in the default project of DevEco Stu ...@@ -24,7 +24,7 @@ AbilityStage is not automatically generated in the default project of DevEco Stu
// When the HAP of the application is loaded for the first time, initialize the module. // When the HAP of the application is loaded for the first time, initialize the module.
} }
onAcceptWant(want) { onAcceptWant(want) {
// Triggered only for the ability with the specified launch type. // Triggered only for the UIAbility with the specified launch type.
return "MyAbilityStage"; return "MyAbilityStage";
} }
} }
...@@ -37,7 +37,7 @@ AbilityStage is not automatically generated in the default project of DevEco Stu ...@@ -37,7 +37,7 @@ AbilityStage is not automatically generated in the default project of DevEco Stu
"name": "entry", "name": "entry",
"type": "entry", "type": "entry",
"srcEntry": "./ets/myabilitystage/MyAbilityStage.ts", "srcEntry": "./ets/myabilitystage/MyAbilityStage.ts",
// ... ...
} }
} }
``` ```
......
en/application-dev/application-models/accessibilityextensionability.md
浏览文件 @ f7d7c3d4
...@@ -12,17 +12,31 @@ The **AccessibilityExtensionAbility** module provides accessibility extension ca ...@@ -12,17 +12,31 @@ The **AccessibilityExtensionAbility** module provides accessibility extension ca
This document is organized as follows: This document is organized as follows:
- [AccessibilityExtensionAbility Development](#accessibilityextensionability-development) - [AccessibilityExtensionAbility Overview](#accessibilityextensionability-overview)
- [Creating an Accessibility Extension Service](#creating-an-accessibility-extension-service) - [Creating an Accessibility Extension Service](#creating-an-accessibility-extension-service)
- [Creating a Project](#creating-a-project) - [Processing an Accessibility Event](#processing-an-accessibility-event)
- [Creating an AccessibilityExtAbility File](#creating-an-accessibilityextability-file) - [Declaring Capabilities of Accessibility Extension Services](#declaring-capabilities-of-accessibility-extension-services)
- [Processing an Accessibility Event](#processing-an-accessibility-event) - [Enabling a Custom Accessibility Extension Service](#enabling-a-custom-accessibility-extension-service)
- [Declaring Capabilities of Accessibility Extension Services](#declaring-capabilities-of-accessibility-extension-services)
- [Enabling a Custom Accessibility Extension Service](#enabling-a-custom-accessibility-extension-service) ## AccessibilityExtensionAbility Overview
Accessibility is about giving equal access to everyone so that they can access and use information equally and conveniently under any circumstances. It helps narrow the digital divide between people of different classes, regions, ages, and health status in terms of information understanding, information exchange, and information utilization, so that they can participate in social life more conveniently and enjoy the benefits of technological advances.
AccessibilityExtensionAbility is an accessibility extension service framework. It allows you to develop your own extension services and provides a standard mechanism for exchanging information between applications and extension services. You can make use of the provided capabilities and APIs to develop accessibility features for users with disabilities or physical limitations. For example, you can develop a screen reader for users with vision impairments.
Below shows the AccessibilityExtensionAbility framework.
![AccessibilityFramework](figures/AccessibilityFramework.png)
1. Accessibility app: extension service application developed based on the AccessibilityExtensionAbility framework, for example, a screen reader application.
2. Target app: application assisted by the accessibility app.
3. AccessibilityAbilityManagerService (AAMS): main service of the AccessibilityExtensionAbility framework, which is used to manage the lifecycle of accessibility apps and provide a bridge for information exchange between accessibility apps and target apps.
4. AccessibilityAbility (AAkit): ability that is used by the accessibility app to build an extension service ability operating environment and that provides interfaces for the accessibility app to query and operate the target app, including performing click/long press operations.
5. AccessibilitySystemAbilityClient (ASACkit): used by the target app to send accessibility events, such as content change events, to AAMS, and respond to the instructions (such as performing click/long press operations) sent by the accessibility app through AAMS.
## Creating an Accessibility Extension Service ## Creating an Accessibility Extension Service
You can create an accessibility extension service by creating a project from scratch or adding the service to an existing project. You can create an accessibility extension service by creating a project from scratch or adding the service to an existing project. Only one accessibility extension service can be created for a project.
### Creating a Project ### Creating a Project
...@@ -40,15 +54,15 @@ import AccessibilityExtensionAbility from '@ohos.application.AccessibilityExtens ...@@ -40,15 +54,15 @@ import AccessibilityExtensionAbility from '@ohos.application.AccessibilityExtens
class AccessibilityExtAbility extends AccessibilityExtensionAbility { class AccessibilityExtAbility extends AccessibilityExtensionAbility {
onConnect() { onConnect() {
console.log('AccessibilityExtAbility onConnect'); console.info('AccessibilityExtAbility onConnect');
} }
onDisconnect() { onDisconnect() {
console.log('AccessibilityExtAbility onDisconnect'); console.info('AccessibilityExtAbility onDisconnect');
} }
onAccessibilityEvent(accessibilityEvent) { onAccessibilityEvent(accessibilityEvent) {
console.log('AccessibilityExtAbility onAccessibilityEvent: ' + JSON.stringify(accessibilityEvent)); console.info('AccessibilityExtAbility onAccessibilityEvent: ' + JSON.stringify(accessibilityEvent));
} }
} }
...@@ -69,9 +83,9 @@ You can process the service logic for accessibility events in the **onAccessibil ...@@ -69,9 +83,9 @@ You can process the service logic for accessibility events in the **onAccessibil
```typescript ```typescript
onAccessibilityEvent(accessibilityEvent) { onAccessibilityEvent(accessibilityEvent) {
console.log('AccessibilityExtAbility onAccessibilityEvent: ' + JSON.stringify(accessibilityEvent)); console.info('AccessibilityExtAbility onAccessibilityEvent: ' + JSON.stringify(accessibilityEvent));
if (accessibilityEvent.eventType === 'pageStateUpdate') { if (accessibilityEvent.eventType === 'pageStateUpdate') {
console.log('AccessibilityExtAbility onAccessibilityEvent: pageStateUpdate'); console.info('AccessibilityExtAbility onAccessibilityEvent: pageStateUpdate');
// TODO: Develop custom logic. // TODO: Develop custom logic.
} }
} }
...@@ -119,3 +133,4 @@ To enable or disable an accessibility extension service, run the following comma ...@@ -119,3 +133,4 @@ To enable or disable an accessibility extension service, run the following comma
In the preceding commands, **AccessibilityExtAbility** indicates the name of the accessibility extension service, **com.example.demo** indicates the bundle name, and **rg** indicates the capabilities (**r** is short for retrieve). In the preceding commands, **AccessibilityExtAbility** indicates the name of the accessibility extension service, **com.example.demo** indicates the bundle name, and **rg** indicates the capabilities (**r** is short for retrieve).
If the service is enabled or disabled successfully, the message "enable ability successfully" or "disable ability successfully" is displayed. If the service is enabled or disabled successfully, the message "enable ability successfully" or "disable ability successfully" is displayed.
en/application-dev/application-models/actions-entities.md
浏览文件 @ f7d7c3d4
# Common action and entities Values # Common action and entities Values
**action**: Action to take, such as viewing, sharing, and application details, by the caller. In implicit Want, you can define this field and use it together with **uri** or **parameters** to specify the operation to be performed on the data, for example, viewing URI data. For example, if the URI is a website and the action is **ohos.want.action.viewData**, the ability that supports website viewing is matched. Declaring the **action** field in Want indicates that the invoked application should support the declared operation. The **actions** field under **skills** in the configuration file indicates the operations supported by the application. The **action** field specifies the common operation (such as viewing, sharing, and application details) to be performed by the caller. In implicit [Want](../reference/apis/js-apis-app-ability-want.md), you can define this field and use it together with **uri** or **parameters** to specify the operation to be performed on the data, for example, viewing URI data. For example, if the URI is a website and the action is **ohos.want.action.viewData**, the application component that supports website viewing is matched. Declaring the **action** field in [Want](../reference/apis/js-apis-app-ability-want.md) indicates that the invoked application is expected to support the declared operation. The **actions** field under **skills** in the configuration file indicates the operations supported by the application.
The following **action** values are available:
**Common action Values**
- **ACTION_HOME**: action of starting the application entry component. It must be used together with **ENTITY_HOME**. The application icon on the home screen is an explicit entry component. Users can touch the icon to start the entry component. Multiple entry components can be configured for an application. - **ACTION_HOME**: action of starting the application entry component. It must be used together with **ENTITY_HOME**. The application icon on the home screen is an explicit entry component. Users can touch the icon to start the entry component. Multiple entry components can be configured for an application.
...@@ -14,14 +13,13 @@ ...@@ -14,14 +13,13 @@
- **ACTION_VIEW_MULTIPLE_DATA**: action of launching the UI for sending multiple data records. - **ACTION_VIEW_MULTIPLE_DATA**: action of launching the UI for sending multiple data records.
**entities**: Category information (such as browser and video player) of the target ability. It is a supplement to **action** in implicit Want. You can define this field to filter application categories, for example, browser. Declaring the **entities** field in Want indicates that the invoked application should belong to the declared category. The **entities** field under **skills** in the configuration file indicates the categories supported by the application. The **entities** field specify the category information (such as browser and video player) of the target application component. It is a supplement to **action** in implicit Want. You can define this field to filter application categories, for example, browser. Declaring the **entities** field in Want indicates that the invoked application should belong to the declared category. The **entities** field under **skills** in the configuration file indicates the categories supported by the application.
**Common entities Values** The following **entities** values are available:
- **ENTITY_DEFAULT**: default category, which is meaningless. - **ENTITY_DEFAULT**: default category, which is meaningless.
- **ENTITY_HOME**: abilities with an icon displayed on the home screen. - **ENTITY_HOME**: application components with an icon displayed on the home screen.
- **ENTITY_BROWSABLE**: browser type. - **ENTITY_BROWSABLE**: browser type.
en/application-dev/application-models/app-deviceconfig-switch.md
浏览文件 @ f7d7c3d4
...@@ -22,7 +22,7 @@ OpenHarmony has reconstructed the [deviceConfig](../quick-start/deviceconfig-str ...@@ -22,7 +22,7 @@ OpenHarmony has reconstructed the [deviceConfig](../quick-start/deviceconfig-str
| deviceConfig in the FA Model| Description| Stage Model| Difference| | deviceConfig in the FA Model| Description| Stage Model| Difference|
| -------- | -------- | -------- | -------- | | -------- | -------- | -------- | -------- |
| deviceConfig| Device information.| / | This tag is no longer available in the stage model. In the stage model, device information is configured under the **app** tag.| | deviceConfig| Device information.| / | This tag is no longer available in the stage model. In the stage model, device information is configured under the **app** tag.|
| process | Name of the process running the application or ability. If the **process** attribute is configured in the **deviceConfig** tag, all abilities of the application run in this process. You can set the **process** attribute for a specific ability in the **abilities** attribute, so that the ability can run in the particular process.| / | The stage model does not support the configuration of process names.| | process | Name of the process running the application or UIAbility. If the **process** attribute is configured in the **deviceConfig** tag, all UIAbilities of the application run in this process. You can set the **process** attribute for a specific UIAbility in the **abilities** attribute, so that the UIAbility can run in the particular process.| / | The stage model does not support the configuration of process names.|
| keepAlive | Whether the application is always running. This attribute applies only to system applications and does not take effect for third-party applications.| / | The stage model does not support changing of the model control mode for system applications.| | keepAlive | Whether the application is always running. This attribute applies only to system applications and does not take effect for third-party applications.| / | The stage model does not support changing of the model control mode for system applications.|
| supportBackup | Whether the application supports data backup and restore.| / | This configuration is not supported in the stage model.| | supportBackup | Whether the application supports data backup and restore.| / | This configuration is not supported in the stage model.|
| compressNativeLibs | Whether the **libs** libraries are packaged in the HAP file after being compressed.| / | This configuration is not supported in the stage model.| | compressNativeLibs | Whether the **libs** libraries are packaged in the HAP file after being compressed.| / | This configuration is not supported in the stage model.|
......
en/application-dev/application-models/application-component-configuration-fa.md
浏览文件 @ f7d7c3d4
...@@ -22,7 +22,7 @@ When developing an application, you may need to configure certain tags to identi ...@@ -22,7 +22,7 @@ When developing an application, you may need to configure certain tags to identi
"actions": ["action.system.home"] "actions": ["action.system.home"]
} }
] ]
// ... ...
} }
``` ```
......
en/application-dev/application-models/application-component-configuration-stage.md
浏览文件 @ f7d7c3d4
# Application- or Component-Level Configuration (Stage Model) # Application- or Component-Level Configuration (Stage Model)
When developing an application, you may need to configure certain tags to identify the application, such as the bundle name and application icon. This topic describes key tags that need to be configured during application development.
When developing an application, you may need to configure certain tags to identify the application, such as the bundle name and application icon. This topic describes key tags that need to be configured during application development. Icons and labels are usually configured together. There is the application icon, application label, entry icon, and entry label, which correspond to the **icon** and **label** fields in the [app.json5 file](../quick-start/app-configuration-file.md) and [module.json5 file](../quick-start/module-configuration-file.md). The application icon and label are used in **Settings**. For example, they are displayed in the application list in **Settings**. The entry icon is displayed on the device's home screen after the application is installed. The entry icon maps to a [UIAbility](uiability-overview.md) component. Therefore, an application can have multiple entry icons and labels. When you touch one of them, the corresponding UIAbility page is displayed. Icons and labels are usually configured together. There is the application icon, application label, entry icon, and entry label, which correspond to the **icon** and **label** fields in the [app.json5 file](../quick-start/app-configuration-file.md) and [module.json5 file](../quick-start/module-configuration-file.md).
The application icon and label are used in **Settings**. For example, they are displayed in the application list in **Settings**. The entry icon is displayed on the device's home screen after the application is installed. The entry icon maps to a [UIAbility](uiability-overview.md) component. Therefore, an application can have multiple entry icons and entry labels. When you touch one of them, the corresponding UIAbility page is displayed.
**Figure 1** Icons and labels **Figure 1** Icons and labels
![application-component-configuration-stage](figures/application-component-configuration-stage.png) ![application-component-configuration-stage](figures/application-component-configuration-stage.png)
...@@ -26,7 +28,7 @@ When developing an application, you may need to configure certain tags to identi ...@@ -26,7 +28,7 @@ When developing an application, you may need to configure certain tags to identi
"app": { "app": {
"icon": "$media:app_icon", "icon": "$media:app_icon",
"label": "$string:app_name" "label": "$string:app_name"
// ... ...
} }
} }
``` ```
...@@ -40,7 +42,7 @@ When developing an application, you may need to configure certain tags to identi ...@@ -40,7 +42,7 @@ When developing an application, you may need to configure certain tags to identi
```json ```json
{ {
"module": { "module": {
// ... ...
"abilities": [ "abilities": [
{ {
// The information starting with $ is the resource value. // The information starting with $ is the resource value.
...@@ -61,6 +63,35 @@ When developing an application, you may need to configure certain tags to identi ...@@ -61,6 +63,35 @@ When developing an application, you may need to configure certain tags to identi
} }
} }
``` ```
OpenHarmony strictly controls applications without icons to prevent malicious applications from deliberately configuring no icon to block uninstall attempts.
To hide an application icon from the home screen, you must configure the **AllowAppDesktopIconHide** privilege. For details, see [Application Privilege Configuration Guide](../../device-dev/subsystems/subsys-app-privilege-config-guide.md). The rules for displaying the entry icon and entry label are as follows:
1. The HAP file contains UIAbility configuration.
* An entry icon is set in the **abilities** field of the **module.json5** file.
* The application does not have the privilege to hide its icon from the home screen.
* The system uses the icon configured for the UIAbility as the entry icon and displays it on the home screen. Touching this icon will direct the user to the home page of the UIAbility.
* The system uses the label configured for the UIAbility as the entry label and displays it on the home screen. If no label is configured, the system uses the label specified in the **app.json5** file as the entry label and displays it on the home screen.
* The application has the privilege to hide its icon from the home screen.
* The application information is not returned when the home screen queries the information, and the entry icon and label of the application are not displayed on the home screen.
* No entry icon is set in the **abilities** field of the **module.json5** file.
* The application does not have the privilege to hide its icon from the home screen.
* The system uses the icon specified in the **app.json5** file as the entry icon and displays it on the home screen. Touching this icon will direct the user to the application details page, as shown below.
* The system uses the label specified in the **app.json5** file as the entry label and displays it on the home screen.
* The application has the privilege to hide its icon from the home screen.
* The application information is not returned when the home screen queries the information, and the entry icon and label of the application are not displayed on the home screen.
2. The HAP file does not contain UIAbility configuration.
* The application does not have the privilege to hide its icon from the home screen.
* The system uses the icon specified in the **app.json5** file as the entry icon and displays it on the home screen. Touching this icon will direct the user to the application details page, as shown below.
* The system uses the label specified in the **app.json5** file as the entry label and displays it on the home screen.
* The application has the privilege to hide its icon from the home screen.
* The application information is not returned when the home screen queries the information, and the entry icon and label of the application are not displayed on the home screen.
**Figure 2** Application details page
![Application details page](figures/application_details.jpg)
- **Configuring application version declaration** - **Configuring application version declaration**
To declare the application version, configure the **versionCode** and **versionName** fields in the [app.json5 file](../quick-start/app-configuration-file.md) in the **AppScope** directory of the project. **versionCode** specifies the version number of the application. The value is a 32-bit non-negative integer. It is used only to determine whether a version is later than another version. A larger value indicates a later version. **versionName** provides the text description of the version number. To declare the application version, configure the **versionCode** and **versionName** fields in the [app.json5 file](../quick-start/app-configuration-file.md) in the **AppScope** directory of the project. **versionCode** specifies the version number of the application. The value is a 32-bit non-negative integer. It is used only to determine whether a version is later than another version. A larger value indicates a later version. **versionName** provides the text description of the version number.
......
en/application-dev/application-models/application-context-stage.md
浏览文件 @ f7d7c3d4
# Context (Stage Model) # Context (Stage Model)
## Overview ## Overview
[Context](../reference/apis/js-apis-inner-application-context.md) is the context of an object in an application. It provides basic information about the application, for example, **resourceManager**, **applicationInfo**, **dir** (application development path), and **area** (encryption level). It also provides basic methods such as **createBundleContext()** and **getApplicationContext()**. The UIAbility component and ExtensionAbility derived class components have their own **Context** classes, for example, the base class **Context**, **ApplicationContext**, **AbilityStageContext**, **UIAbilityContext**, **ExtensionContext**, and **ServiceExtensionContext**. [Context](../reference/apis/js-apis-inner-application-context.md) is the context of an object in an application. It provides basic information about the application, for example, **resourceManager**, **applicationInfo**, **dir** (application development path), and **area** (encrypted level). It also provides basic methods such as **createBundleContext()** and **getApplicationContext()**. The UIAbility component and ExtensionAbility derived class components have their own **Context** classes, for example, the base class **Context**, **ApplicationContext**, **AbilityStageContext**, **UIAbilityContext**, **ExtensionContext**, and **ServiceExtensionContext**.
- The figure below illustrates the inheritance relationship of contexts. - The figure below illustrates the inheritance relationship of contexts.
![context-inheritance](figures/context-inheritance.png) ![context-inheritance](figures/context-inheritance.png)
- The figure below illustrates the holding relationship of contexts. - The figure below illustrates the holding relationship of contexts.
![context-holding](figures/context-holding.png) ![context-holding](figures/context-holding.png)
- The following describes the information provided by different contexts. The following describes the information provided by different contexts.
- [UIAbilityContext](../reference/apis/js-apis-inner-application-uiAbilityContext.md): Each UIAbility has the **Context** attribute, which provides APIs to operate an application component, obtain the application component configuration, and more. - [UIAbilityContext](../reference/apis/js-apis-inner-application-uiAbilityContext.md): Each UIAbility has the **Context** attribute, which provides APIs to operate an application component, obtain the application component configuration, and more.
```ts ```ts
...@@ -21,7 +18,7 @@ ...@@ -21,7 +18,7 @@
export default class EntryAbility extends UIAbility { export default class EntryAbility extends UIAbility {
onCreate(want, launchParam) { onCreate(want, launchParam) {
let uiAbilityContext = this.context; let uiAbilityContext = this.context;
// ... ...
} }
} }
``` ```
...@@ -36,7 +33,7 @@ ...@@ -36,7 +33,7 @@
export default class MyService extends ServiceExtensionAbility { export default class MyService extends ServiceExtensionAbility {
onCreate(want) { onCreate(want) {
let serviceExtensionContext = this.context; let serviceExtensionContext = this.context;
// ... ...
} }
} }
``` ```
...@@ -47,7 +44,7 @@ ...@@ -47,7 +44,7 @@
export default class MyAbilityStage extends AbilityStage { export default class MyAbilityStage extends AbilityStage {
onCreate() { onCreate() {
let abilityStageContext = this.context; let abilityStageContext = this.context;
// ... ...
} }
} }
``` ```
...@@ -58,7 +55,7 @@ ...@@ -58,7 +55,7 @@
export default class EntryAbility extends UIAbility { export default class EntryAbility extends UIAbility {
onCreate(want, launchParam) { onCreate(want, launchParam) {
let applicationContext = this.context.getApplicationContext(); let applicationContext = this.context.getApplicationContext();
// ... ...
} }
} }
``` ```
...@@ -84,13 +81,13 @@ The following table describes the application development paths obtained from co ...@@ -84,13 +81,13 @@ The following table describes the application development paths obtained from co
| Name| Type| Readable| Writable| Description| | Name| Type| Readable| Writable| Description|
| -------- | -------- | -------- | -------- | -------- | | -------- | -------- | -------- | -------- | -------- |
| bundleCodeDir | string | Yes | No | Path for storing the application's installation package, that is, installation directory of the application on the internal storage. Do not access resource files by concatenating paths. Use [@ohos.resourceManager] instead. | | bundleCodeDir | string | Yes | No | Path for storing the application's installation package, that is, installation directory of the application on the internal storage. |
| cacheDir | string | Yes| No| Path for storing the application's cache files, that is, cache directory of the application on the internal storage.<br>It is the content of **Storage** of an application under **Settings > Apps & services > Apps**.| | cacheDir | string | Yes| No| Path for storing the cache files, that is, cache directory of the application on the internal storage.<br>It is the content of **Storage** of an application under **Settings > Apps & services > Apps**.|
| filesDir | string | Yes | No | Path for storing the application's common files, that is, file directory of the application on the internal storage.<br>Files in this directory may be synchronized to other directories during application migration or backup.| | filesDir | string | Yes | No | Path for storing the common files, that is, file directory of the application on the internal storage.<br>Files in this directory may be synchronized to other directories during application migration or backup.|
| preferencesDir | string | Yes | Yes | Path for storing the application's preference files, that is, preferences directory of the application. | | preferencesDir | string | Yes | Yes | Path for storing the preference files, that is, preferences directory of the application. |
| tempDir | string | Yes | No | Path for storing the application's temporary files.<br>Files in this directory are deleted after the application is uninstalled.| | tempDir | string | Yes | No | Path for storing the temporary files.<br>Files in this directory are deleted after the application is uninstalled.|
| databaseDir | string | Yes | No | Path for storing the application's database, that is, storage directory of the local database. | | databaseDir | string | Yes | No | Path for storing the application's database, that is, storage directory of the local database. |
| distributedFilesDir | string | Yes| No| Path for storing the application's distributed files.| | distributedFilesDir | string | Yes| No| Path for storing the distributed files.|
The capability of obtaining the application development path is provided by the base class **Context**. This capability is also provided by **ApplicationContext**, **AbilityStageContext**, **UIAbilityContext**, and **ExtensionContext**. However, the paths obtained from different contexts may differ, as shown below. The capability of obtaining the application development path is provided by the base class **Context**. This capability is also provided by **ApplicationContext**, **AbilityStageContext**, **UIAbilityContext**, and **ExtensionContext**. However, the paths obtained from different contexts may differ, as shown below.
...@@ -135,7 +132,7 @@ export default class EntryAbility extends UIAbility { ...@@ -135,7 +132,7 @@ export default class EntryAbility extends UIAbility {
let bundleCodeDir = this.context.bundleCodeDir; let bundleCodeDir = this.context.bundleCodeDir;
let distributedFilesDir = this.context.distributedFilesDir; let distributedFilesDir = this.context.distributedFilesDir;
let preferencesDir = this.context.preferencesDir; let preferencesDir = this.context.preferencesDir;
// ... ...
} }
} }
``` ```
...@@ -202,7 +199,7 @@ The base class **Context** provides [createBundleContext(bundleName:string)](../ ...@@ -202,7 +199,7 @@ The base class **Context** provides [createBundleContext(bundleName:string)](../
let bundleName2 = 'com.example.application'; let bundleName2 = 'com.example.application';
let context2 = this.context.createBundleContext(bundleName2); let context2 = this.context.createBundleContext(bundleName2);
let label2 = context2.applicationInfo.label; let label2 = context2.applicationInfo.label;
// ... ...
} }
} }
``` ```
...@@ -224,7 +221,7 @@ The base class **Context** provides [createBundleContext(bundleName:string)](../ ...@@ -224,7 +221,7 @@ The base class **Context** provides [createBundleContext(bundleName:string)](../
let bundleName2 = 'com.example.application'; let bundleName2 = 'com.example.application';
let moduleName2 = 'module1'; let moduleName2 = 'module1';
let context2 = this.context.createModuleContext(bundleName2, moduleName2); let context2 = this.context.createModuleContext(bundleName2, moduleName2);
// ... ...
} }
} }
``` ```
...@@ -238,7 +235,7 @@ The base class **Context** provides [createBundleContext(bundleName:string)](../ ...@@ -238,7 +235,7 @@ The base class **Context** provides [createBundleContext(bundleName:string)](../
onCreate(want, launchParam) { onCreate(want, launchParam) {
let moduleName2 = 'module1'; let moduleName2 = 'module1';
let context2 = this.context.createModuleContext(moduleName2); let context2 = this.context.createModuleContext(moduleName2);
// ... ...
} }
} }
``` ```
...@@ -266,53 +263,53 @@ export default class EntryAbility extends UIAbility { ...@@ -266,53 +263,53 @@ export default class EntryAbility extends UIAbility {
let abilityLifecycleCallback = { let abilityLifecycleCallback = {
// Called when a UIAbility is created. // Called when a UIAbility is created.
onAbilityCreate(uiAbility) { onAbilityCreate(uiAbility) {
console.log(TAG, `onAbilityCreate uiAbility.launchWant: ${JSON.stringify(uiAbility.launchWant)}`); console.info(TAG, `onAbilityCreate uiAbility.launchWant: ${JSON.stringify(uiAbility.launchWant)}`);
}, },
// Called when a window is created. // Called when a window is created.
onWindowStageCreate(uiAbility, windowStage: window.WindowStage) { onWindowStageCreate(uiAbility, windowStage: window.WindowStage) {
console.log(TAG, `onWindowStageCreate uiAbility.launchWant: ${JSON.stringify(uiAbility.launchWant)}`); console.info(TAG, `onWindowStageCreate uiAbility.launchWant: ${JSON.stringify(uiAbility.launchWant)}`);
console.log(TAG, `onWindowStageCreate windowStage: ${JSON.stringify(windowStage)}`); console.info(TAG, `onWindowStageCreate windowStage: ${JSON.stringify(windowStage)}`);
}, },
// Called when the window becomes active. // Called when the window becomes active.
onWindowStageActive(uiAbility, windowStage: window.WindowStage) { onWindowStageActive(uiAbility, windowStage: window.WindowStage) {
console.log(TAG, `onWindowStageActive uiAbility.launchWant: ${JSON.stringify(uiAbility.launchWant)}`); console.info(TAG, `onWindowStageActive uiAbility.launchWant: ${JSON.stringify(uiAbility.launchWant)}`);
console.log(TAG, `onWindowStageActive windowStage: ${JSON.stringify(windowStage)}`); console.info(TAG, `onWindowStageActive windowStage: ${JSON.stringify(windowStage)}`);
}, },
// Called when the window becomes inactive. // Called when the window becomes inactive.
onWindowStageInactive(uiAbility, windowStage: window.WindowStage) { onWindowStageInactive(uiAbility, windowStage: window.WindowStage) {
console.log(TAG, `onWindowStageInactive uiAbility.launchWant: ${JSON.stringify(uiAbility.launchWant)}`); console.info(TAG, `onWindowStageInactive uiAbility.launchWant: ${JSON.stringify(uiAbility.launchWant)}`);
console.log(TAG, `onWindowStageInactive windowStage: ${JSON.stringify(windowStage)}`); console.info(TAG, `onWindowStageInactive windowStage: ${JSON.stringify(windowStage)}`);
}, },
// Called when the window is destroyed. // Called when the window is destroyed.
onWindowStageDestroy(uiAbility, windowStage: window.WindowStage) { onWindowStageDestroy(uiAbility, windowStage: window.WindowStage) {
console.log(TAG, `onWindowStageDestroy uiAbility.launchWant: ${JSON.stringify(uiAbility.launchWant)}`); console.info(TAG, `onWindowStageDestroy uiAbility.launchWant: ${JSON.stringify(uiAbility.launchWant)}`);
console.log(TAG, `onWindowStageDestroy windowStage: ${JSON.stringify(windowStage)}`); console.info(TAG, `onWindowStageDestroy windowStage: ${JSON.stringify(windowStage)}`);
}, },
// Called when the UIAbility is destroyed. // Called when the UIAbility is destroyed.
onAbilityDestroy(uiAbility) { onAbilityDestroy(uiAbility) {
console.log(TAG, `onAbilityDestroy uiAbility.launchWant: ${JSON.stringify(uiAbility.launchWant)}`); console.info(TAG, `onAbilityDestroy uiAbility.launchWant: ${JSON.stringify(uiAbility.launchWant)}`);
}, },
// Called when the UIAbility is switched from the background to the foreground. // Called when the UIAbility is switched from the background to the foreground.
onAbilityForeground(uiAbility) { onAbilityForeground(uiAbility) {
console.log(TAG, `onAbilityForeground uiAbility.launchWant: ${JSON.stringify(uiAbility.launchWant)}`); console.info(TAG, `onAbilityForeground uiAbility.launchWant: ${JSON.stringify(uiAbility.launchWant)}`);
}, },
// Called when the UIAbility is switched from the foreground to the background. // Called when the UIAbility is switched from the foreground to the background.
onAbilityBackground(uiAbility) { onAbilityBackground(uiAbility) {
console.log(TAG, `onAbilityBackground uiAbility.launchWant: ${JSON.stringify(uiAbility.launchWant)}`); console.info(TAG, `onAbilityBackground uiAbility.launchWant: ${JSON.stringify(uiAbility.launchWant)}`);
}, },
// Called when UIAbility is continued on another device. // Called when UIAbility is continued on another device.
onAbilityContinue(uiAbility) { onAbilityContinue(uiAbility) {
console.log(TAG, `onAbilityContinue uiAbility.launchWant: ${JSON.stringify(uiAbility.launchWant)}`); console.info(TAG, `onAbilityContinue uiAbility.launchWant: ${JSON.stringify(uiAbility.launchWant)}`);
} }
} }
// Obtain the application context. // Obtain the application context.
let applicationContext = this.context.getApplicationContext(); let applicationContext = this.context.getApplicationContext();
// Register the application lifecycle callback. // Register the application lifecycle callback.
this.lifecycleId = applicationContext.on('abilityLifecycle', abilityLifecycleCallback); this.lifecycleId = applicationContext.on('abilityLifecycle', abilityLifecycleCallback);
console.log(TAG, `register callback number: ${this.lifecycleId}`); console.info(TAG, `register callback number: ${this.lifecycleId}`);
} }
// ... ...
onDestroy() { onDestroy() {
// Obtain the application context. // Obtain the application context.
......
en/application-dev/application-models/application-model-description.md
浏览文件 @ f7d7c3d4
...@@ -12,7 +12,6 @@ Along its evolution, OpenHarmony has provided two application models: ...@@ -12,7 +12,6 @@ Along its evolution, OpenHarmony has provided two application models:
The stage model is designed based on the following considerations, which make it become the recommended model: The stage model is designed based on the following considerations, which make it become the recommended model:
1. **Designed for complex applications** 1. **Designed for complex applications**
- In the stage model, multiple application components share an ArkTS engine (VM running the programming language ArkTS) instance, making it easy for application components to share objects and status while requiring less memory. - In the stage model, multiple application components share an ArkTS engine (VM running the programming language ArkTS) instance, making it easy for application components to share objects and status while requiring less memory.
- The object-oriented development mode makes the code of complex applications easy to read, maintain, and scale. - The object-oriented development mode makes the code of complex applications easy to read, maintain, and scale.
...@@ -38,7 +37,7 @@ The stage model is designed based on the following considerations, which make it ...@@ -38,7 +37,7 @@ The stage model is designed based on the following considerations, which make it
The stage model redefines the boundary of application capabilities to well balance application capabilities and system management costs. The stage model redefines the boundary of application capabilities to well balance application capabilities and system management costs.
- Diverse application components (such as widgets and input methods) for specific scenarios. - Diverse application components (such as service widgets and input methods) for specific scenarios.
- Standardized background process management. To deliver a better user experience, the stage model manages background application processes in a more orderly manner. Applications cannot reside in the background randomly, and their background behavior is strictly managed to minimize malicious behavior. - Standardized background process management. To deliver a better user experience, the stage model manages background application processes in a more orderly manner. Applications cannot reside in the background randomly, and their background behavior is strictly managed to minimize malicious behavior.
...@@ -52,8 +51,8 @@ The table below describes their differences in detail. ...@@ -52,8 +51,8 @@ The table below describes their differences in detail.
| Item| FA model| Stage model| | Item| FA model| Stage model|
| -------- | -------- | -------- | | -------- | -------- | -------- |
| **Application component**| 1. Component classification<br>![fa-model-component](figures/fa-model-component.png)<br/>- PageAbility: has the UI and supports user interaction For details, see [PageAbility Component Overview](pageability-overview.md).<br>- ServiceAbility: provides background services and has no UI. For details, see [ServiceAbility Component Overview](serviceability-overview.md).<br>- DataAbility: provides the data sharing capability and has no UI. For details, see [DataAbility Component Overview](dataability-overview.md).<br>2. Development mode<br>Application components are specified by exporting anonymous objects and fixed entry files. You cannot perform derivation. It is inconvenient for capability expansion. | 1. Component classification<br>![stage-model-component](figures/stage-model-component.png)<br/> - UIAbility: has the UI and supports user interaction. For details, see [UIAbility Component Overview](uiability-overview.md).<br>- ExtensionAbility: provides extension capabilities (such as widget and input methods) for specific scenarios. For details, see [ExtensionAbility Component Overview](extensionability-overview.md).<br>2. Development mode<br>The object-oriented mode is used to provide open application components as classes. You can derive application components for capability expansion. | | **Application component**| 1. Component classification<br>![fa-model-component](figures/fa-model-component.png)<br>- PageAbility: has the UI and supports user interaction For details, see [PageAbility Component Overview](pageability-overview.md).<br>- ServiceAbility: provides background services and has no UI. For details, see [ServiceAbility Component Overview](serviceability-overview.md).<br>- DataAbility: provides the data sharing capability and has no UI. For details, see [DataAbility Component Overview](dataability-overview.md).<br>2. Development mode<br>Application components are specified by exporting anonymous objects and fixed entry files. You cannot perform derivation. It is inconvenient for capability expansion.| 1. Component classification<br>![stage-model-component](figures/stage-model-component.png)<br>- UIAbility: has the UI and supports user interaction. For details, see [UIAbility Component Overview](uiability-overview.md).<br>- ExtensionAbility: provides extension capabilities (such as widget and input methods) for specific scenarios. For details, see [ExtensionAbility Component Overview](extensionability-overview.md).<br>2. Development mode<br>The object-oriented mode is used to provide open application components as classes. You can derive application components for capability expansion.|
| **Process model**| There are two types of processes:<br>1. Main process<br>2. Rendering process<br>For details, see [Process Model (FA Model)](process-model-fa.md).| There are three types of processes:<br>1. Main process<br>2. ExtensionAbility process<br>3. Rendering process<br>For details, see [Process Model (Stage Model)](process-model-stage.md).| | **Process model**| There are two types of processes:<br>1. Main process<br>2. Rendering process<br>For details, see [Process Model Overview (FA Model)](process-model-fa.md). | There are three types of processes:<br>1. Main process<br>2. ExtensionAbility process<br>3. Rendering process<br>For details, see [Process Model Overview (Stage Model)](process-model-stage.md). |
| **Thread model**| 1. ArkTS engine instance creation<br>A process can run multiple application component instances, and each application component instance runs in an independent ArkTS engine instance.<br>2. Thread model<br>Each ArkTS engine instance is created on an independent thread (non-main thread). The main thread does not have an ArkTS engine instance.<br>3. Intra-process object sharing: not supported.<br>For details, see [Thread Model (FA Model)](thread-model-fa.md).| 1. ArkTS engine instance creation<br>A process can run multiple application component instances, and all application component instances share one ArkTS engine instance.<br>2. Thread model<br>The ArkTS engine instance is created on the main thread.<br>3. Intra-process object sharing: supported.<br>For details, see [Thread Model (Stage Model)](thread-model-stage.md).| | **Thread model**| 1. ArkTS engine instance creation<br>A process can run multiple application component instances, and each application component instance runs in an independent ArkTS engine instance.<br>2. Thread model<br>Each ArkTS engine instance is created on an independent thread (non-main thread). The main thread does not have an ArkTS engine instance.<br>3. Intra-process object sharing: not supported.<br>For details, see [Thread Model Overview (FA Model)](thread-model-fa.md). | 1. ArkTS engine instance creation<br>A process can run multiple application component instances, and all application component instances share one ArkTS engine instance.<br>2. Thread model<br>The ArkTS engine instance is created on the main thread.<br>3. Intra-process object sharing: supported.<br>For details, see [Thread Model Overview (Stage Model)](thread-model-stage.md). |
| **Mission management model**| - A mission is created for each PageAbility component instance.<br>- Missions are stored persistently until the number of missions exceeds the maximum (customized based on the product configuration) or users delete missions.<br>- PageAbility components do not form a stack structure.<br>For details, see [Mission Management Scenarios](mission-management-overview.md).| - A mission is created for each UIAbility component instance.<br>- Missions are stored persistently until the number of missions exceeds the maximum (customized based on the product configuration) or users delete missions.<br>- UIAbility components do not form a stack structure.<br>For details, see [Mission Management Scenarios](mission-management-overview.md).| | **Mission management model**| - A mission is created for each PageAbility component instance.<br>- Missions are stored persistently until the number of missions exceeds the maximum (customized based on the product configuration) or users delete missions.<br>- PageAbility components do not form a stack structure.<br>For details, see [Mission Management Scenarios](mission-management-overview.md).| - A mission is created for each UIAbility component instance.<br>- Missions are stored persistently until the number of missions exceeds the maximum (customized based on the product configuration) or users delete missions.<br>- UIAbility components do not form a stack structure.<br>For details, see [Mission Management Scenarios](mission-management-overview.md).|
| **Application configuration file**| The **config.json** file is used to describe the application, HAP, and application component information.<br>For details, see [Application Configuration File Overview (FA Model)](../quick-start/application-configuration-file-overview-fa.md).| The **app.json5** file is used to describe the application information, and the **module.json5** file is used to describe the HAP and application component information.<br>For details, see [Application Configuration File Overview (Stage Model)](../quick-start/application-configuration-file-overview-stage.md).| | **Application configuration file**| The **config.json** file is used to describe the application, HAP, and application component information.<br>For details, see [Application Configuration File Overview (FA Model)](../quick-start/application-configuration-file-overview-fa.md).| The **app.json5** file is used to describe the application information, and the **module.json5** file is used to describe the HAP and application component information.<br>For details, see [Application Configuration File Overview (Stage Model)](../quick-start/application-configuration-file-overview-stage.md).|
en/application-dev/application-models/arkts-ui-widget-event-call.md 0 → 100644
浏览文件 @ f7d7c3d4
# Launching a UIAbility in the Background Through the call Event
There may be cases you want to provide in a widget access to features available in your application when it is running in the foreground, for example, the play, pause, and stop buttons in a music application widget. This is where the **call** capability of the **postCardAction** API comes in handy. This capability, when used in a widget, can start the specified UIAbility of the widget provider in the background. It also allows the widget to call the specified method of the application and transfer data so that the application, while in the background, can behave accordingly in response to touching of the buttons on the widget.
Generally, buttons are used to trigger the **call** event. Below is an example.
- In this example, two buttons are laid out on the widget page. When one button is clicked, the **postCardAction** API is called to send a **call** event to the target UIAbility. Note that the **method** parameter in the API indicates the method to call in the target UIAbility. It is mandatory and of the string type.
```ts
@Entry
@Component
struct WidgetCard {
build() {
Column() {
Button ('Feature A')
.margin('20%')
.onClick(() => {
console.info('call EntryAbility funA');
postCardAction(this, {
'action': 'call',
'abilityName': 'EntryAbility', // Only the UIAbility of the current application is allowed.
'params': {
'method': 'funA' // Set the name of the method to call in the EntryAbility.
}
});
})
Button ('Feature B')
.margin('20%')
.onClick(() => {
console.info('call EntryAbility funB');
postCardAction(this, {
'action': 'call',
'abilityName': 'EntryAbility', // Only the UIAbility of the current application is allowed.
'params': {
'method': 'funB', // Set the name of the method to call in the EntryAbility.
'num': 1 // Set other parameters to be transferred.
}
});
})
}
.width('100%')
.height('100%')
}
}
```
- The UIAbility receives the **call** event and obtains the transferred parameters. It then executes the target method specified by the **method** parameter. Other data can be obtained in readString mode. Listen for the method required by the **call** event in the **onCreate** callback of the UIAbility.
```ts
import UIAbility from '@ohos.app.ability.UIAbility';
function FunACall(data) {
// Obtain all parameters transferred in the call event.
console.info('FunACall param:' + JSON.stringify(data.readString()));
return null;
}
function FunBCall(data) {
console.info('FunACall param:' + JSON.stringify(data.readString()));
return null;
}
export default class CameraAbility extends UIAbility {
// If the UIAbility is started for the first time, the onCreate lifecycle callback is triggered after the call event is received.
onCreate(want, launchParam) {
try {
// Listen for the method required by the call event.
this.callee.on('funA', FunACall);
this.callee.on('funB', FunBCall);
} catch (error) {
console.error(`Failed to register callee on. Cause: ${JSON.stringify(err)}`);
}
}
// Deregister the listener when the process exits.
onDestroy() {
try {
this.callee.off('funA');
this.callee.off('funB');
} catch (err) {
console.error(`Failed to register callee off. Cause: ${JSON.stringify(err)}`);
}
}
};
```
en/application-dev/application-models/arkts-ui-widget-event-formextensionability.md
浏览文件 @ f7d7c3d4
# Updating Widget Content Through FormExtensionAbility # Updating Widget Content Through the message Event
On the widget page, the **postCardAction** API can be used to trigger a message event to the FormExtensionAbility, which then updates the widget content. The following is an example of this widget update mode. On the widget page, the **postCardAction** API can be used to trigger a message event to start a FormExtensionAbility, which then updates the widget content. The following is an example of this widget update mode.
- On the widget page, register the **onClick** event callback of the button and call the **postCardAction** API in the callback to trigger the event to the FormExtensionAbility. - On the widget page, register the **onClick** event callback of the button and call the **postCardAction** API in the callback to trigger the event to the FormExtensionAbility.
...@@ -57,7 +57,7 @@ On the widget page, the **postCardAction** API can be used to trigger a message ...@@ -57,7 +57,7 @@ On the widget page, the **postCardAction** API can be used to trigger a message
}) })
} }
// ... ...
} }
``` ```
......
en/application-dev/application-models/arkts-ui-widget-event-overview.md
浏览文件 @ f7d7c3d4
# Widget Event Capability Overview # Widget Event Capability Overview
The ArkTS widget provides the **postCardAction()** API for interaction between the widget internal and the provider application. Currently, this API supports the router, message, and call events and can be called only in the widget. The ArkTS widget provides the **postCardAction()** API for interaction between the widget internal and the provider application. Currently, this API supports the router, message, and call events and can be called only in the widget.
![WidgetPostCardAction](figures/WidgetPostCardAction.png) ![WidgetPostCardAction](figures/WidgetPostCardAction.png)
**Definition**: postCardAction(component: Object, action: Object): void
Definition: postCardAction(component: Object, action: Object): void **Parameters**
Parameters:
| Name| Type| Mandatory| Description| | Name| Type| Mandatory| Description|
| -------- | -------- | -------- | -------- | | -------- | -------- | -------- | -------- |
| component | Object | Yes| Instance of the current custom component. Generally, **this** is transferred.| | component | Object | Yes| Instance of the current custom component. Generally, **this** is transferred.|
| action | Object | Yes| Action description. For details, see the following table.| | action | Object | Yes| Action description. For details, see the following table.|
**Description of the action parameter**
Description of the action parameter | Key | Value | Description|
| **Key** | **Value** | Description|
| -------- | -------- | -------- | | -------- | -------- | -------- |
| "action" | string | Action type.<br>- **"router"**: application redirection. If this type of action is triggered, the corresponding UIAbility is displayed. Only the UIAbility of the current application can be displayed.<br>- **"message"**: custom message. If this type of action is triggered, the [onFormEvent()](../reference/apis/js-apis-app-form-formExtensionAbility.md#onformevent) lifecycle callback of the provider FormExtensionAbility is called.<br>- **"call"**: application startup in the background. If this type of action is triggered, the corresponding UIAbility is started but does not run in the foreground. The target application must have the permission to run in the background ([ohos.permission.KEEP_BACKGROUND_RUNNING](../security/permission-list.md#ohospermissionkeep_background_running)).| | "action" | string | Action type.<br>- **"router"**: redirection to the specified UIAbility of the widget provider.<br>- **"message"**: custom message. If this type of action is triggered, the [onFormEvent()](../reference/apis/js-apis-app-form-formExtensionAbility.md#onformevent) lifecycle callback of the provider FormExtensionAbility is called.<br>- **"call"**: launch of the widget provider in the background. If this type of action is triggered, the specified UIAbility of the widget provider is started in the background, but not displayed in the foreground. This action type requires that the widget provider should have the [ohos.permission.KEEP_BACKGROUND_RUNNING](../security/permission-list.md#ohospermissionkeep_background_running) permission.|
| "bundleName" | string | Name of the target bundle when **action** is **"router"** or **"call"**. This parameter is optional.| | "bundleName" | string | Name of the target bundle when **action** is **"router"** or **"call"**. This parameter is optional.|
| "moduleName" | string | Name of the target module when **action** is **"router"** or **"call"**. This parameter is optional.| | "moduleName" | string | Name of the target module when **action** is **"router"** or **"call"**. This parameter is optional.|
| "abilityName" | string | Name of the target UIAbility when **action** is **"router"** or **"call"**. This parameter is mandatory.| | "abilityName" | string | Name of the target UIAbility when **action** is **"router"** or **"call"**. This parameter is mandatory.|
| "params" | Object | Additional parameters carried in the current action. The value is a key-value pair in JSON format.| | "params" | Object | Additional parameters carried in the current action. The value is a key-value pair in JSON format. For the **"call"** action type, the **method** parameter must be set and its value type must be string. This parameter is mandatory.|
Sample code of the **postCardAction()** API: Sample code of the **postCardAction()** API:
```typescript ```typescript
Button ('Jump') Button ('Jump')
.width('40%') .width('40%')
...@@ -45,18 +36,26 @@ Button ('Jump') ...@@ -45,18 +36,26 @@ Button ('Jump')
'bundleName': 'com.example.myapplication', 'bundleName': 'com.example.myapplication',
'abilityName': 'EntryAbility', 'abilityName': 'EntryAbility',
'params': { 'params': {
'message': 'testForRouter' // Customize the message to be sent. 'message': 'testForRouter' // Customize the message to send.
} }
}); });
}) })
```
The following are typical widget development scenarios that can be implemented through widget events:
Button ('Start in Background')
.width('40%')
.height('20%')
.onClick(() => {
postCardAction(this, {
'action': 'call',
'bundleName': 'com.example.myapplication',
'abilityName': 'EntryAbility',
'params': {
'method': 'fun', // Set the name of the method to call. It is mandatory.
'message': 'testForcall' // Customize the message to send.
}
});
})
```
- [Updating Widget Content Through FormExtensionAbility](arkts-ui-widget-event-formextensionability.md)
- [Updating Widget Content Through UIAbility](arkts-ui-widget-event-uiability.md)
- [Redirecting to a Specified Page Through the Router Event](arkts-ui-widget-event-router.md) Read on to learn the typical widget development scenarios that can be implemented through widget events.
en/application-dev/application-models/arkts-ui-widget-event-router.md
浏览文件 @ f7d7c3d4
# Redirecting to a Specified Page Through the Router Event # Redirecting to a UIAbility Through the router Event
The **router** capability of the **postCardAction** API can be used in a widget to quickly start the widget provider application. An application can provide different buttons through the widget so that users can jump to different pages at the touch of a button. For example, a camera widget provides the buttons that direct the user to respective pages, such as the page for taking a photo and the page for recording a video.
The **router** capability of the **postCardAction** API can be used in a widget to quickly start a specific UIAbility of the widget provider. By leveraging this capability, an application can provide in the widget multiple buttons, each of which targets a different target UIAbility. For example, a camera widget can provide the buttons that redirect the user to the UIAbility for taking a photo and the UIAbility for recording a video.
![WidgerCameraCard](figures/WidgerCameraCard.png) ![WidgerCameraCard](figures/WidgerCameraCard.png)
......
en/application-dev/application-models/arkts-ui-widget-event-uiability.md
浏览文件 @ f7d7c3d4
# Updating Widget Content Through UIAbility # Updating Widget Content Through the router or call Event
On the widget page, the **postCardAction** API can be used to trigger a router or call event to start the UIAbility, which then updates the widget content. The following is an example of this widget update mode. On the widget page, the **postCardAction** API can be used to trigger a router or call event to start a UIAbility, which then updates the widget content. The following is an example of this widget update mode.
## Updating Widget Content Through the router Event
- On the widget page, register the **onClick** event callback of the button and call the **postCardAction** API in the callback to trigger the event to the FormExtensionAbility. - On the widget page, register the **onClick** event callback of the button and call the **postCardAction** API in the callback to trigger the **router** event to the FormExtensionAbility.
```ts ```ts
let storage = new LocalStorage(); let storage = new LocalStorage();
...@@ -84,3 +85,104 @@ On the widget page, the **postCardAction** API can be used to trigger a router o ...@@ -84,3 +85,104 @@ On the widget page, the **postCardAction** API can be used to trigger a router o
... ...
} }
``` ```
## Updating Widget Content Through the call Event
- When using the **call** event of the **postCardAction** API, the value of **formId** must be updated in the **onAddForm** callback of the FormExtensionAbility.
```ts
import formBindingData from '@ohos.app.form.formBindingData';
import FormExtensionAbility from '@ohos.app.form.FormExtensionAbility';
export default class EntryFormAbility extends FormExtensionAbility {
onAddForm(want) {
let formId = want.parameters["ohos.extra.param.key.form_identity"];
let dataObj1 = {
"formId": formId
};
let obj1 = formBindingData.createFormBindingData(dataObj1);
return obj1;
}
...
};
```
- On the widget page, register the **onClick** event callback of the button and call the **postCardAction** API in the callback to trigger the event to the UIAbility.
```ts
let storage = new LocalStorage();
@Entry(storage)
@Component
struct WidgetCard {
@LocalStorageProp('detail') detail: string = 'init';
@LocalStorageProp('formId') formId: string = '0';
build() {
Column() {
Button ('Start in Background')
.margin('20%')
.onClick(() => {
console.info('postCardAction to EntryAbility');
postCardAction(this, {
'action': 'call',
'abilityName': 'EntryAbility', // Only the UIAbility of the current application is allowed.
'params': {
'method': 'funA',
'formId': this.formId,
'detail': 'CallFromCard'
}
});
})
Text(`${this.detail}`).margin('20%')
}
.width('100%')
.height('100%')
}
}
```
- Listen for the method required by the **call** event in the **onCreate** callback of the UIAbility, and then call the [updateForm](../reference/apis/js-apis-app-form-formProvider.md#updateform) API in the corresponding method to update the widget.
```ts
import UIAbility from '@ohos.app.ability.UIAbility';
import formBindingData from '@ohos.app.form.formBindingData';
import formProvider from '@ohos.app.form.formProvider';
import formInfo from '@ohos.app.form.formInfo';
const MSG_SEND_METHOD: string = 'funA';
// After the call event is received, the method listened for by the callee is triggered.
function FunACall(data) {
// Obtain all parameters transferred in the call event.
let params = JSON.parse(data.readString())
if (params.formId !== undefined) {
let curFormId = params.formId;
let message = params.detail;
console.info(`UpdateForm formId: ${curFormId}, message: ${message}`);
let formData = {
"detail": message
};
let formMsg = formBindingData.createFormBindingData(formData)
formProvider.updateForm(curFormId, formMsg).then((data) => {
console.info('updateForm success.' + JSON.stringify(data));
}).catch((error) => {
console.error('updateForm failed:' + JSON.stringify(error));
})
}
return null;
}
export default class EntryAbility extends UIAbility {
// If the UIAbility is started for the first time, the onCreate lifecycle callback is triggered after the call event is received.
onCreate(want, launchParam) {
console.info('Want:' + JSON.stringify(want));
try {
// Listen for the method required by the call event.
this.callee.on(MSG_SEND_METHOD, FunACall);
} catch (error) {
console.info(`${MSG_SEND_METHOD} register failed with error ${JSON.stringify(error)}`)
}
}
...
}
```
en/application-dev/application-models/arkts-ui-widget-image-update.md
浏览文件 @ f7d7c3d4
# Updating Local and Online Images in the Widget # Updating Local and Online Images in the Widget
Generally, local images or online images downloaded from the network need to be displayed on a widget. To obtain local and online images, use the FormExtensionAbility. The following exemplifies how to show local and online images on a widget. Typically, a widget includes local images or online images downloaded from the network. To obtain local and online images, use the FormExtensionAbility. The following exemplifies how to show local and online images on a widget.
1. Internet access is required for downloading online images. Therefore, you need to apply for the **ohos.permission.INTERNET** permission. For details, see [Declaring Permissions in the Configuration File](../security/accesstoken-guidelines.md). 1. For the widget to download online images, declare the **ohos.permission.INTERNET** permission for the widget. For details, see [Declaring Permissions in the Configuration File](../security/accesstoken-guidelines.md).
2. Update local files in the **onAddForm** lifecycle callback of the EntryFormAbility. 2. Update local files in the **onAddForm** lifecycle callback of the EntryFormAbility.
...@@ -44,7 +44,7 @@ Generally, local images or online images downloaded from the network need to be ...@@ -44,7 +44,7 @@ Generally, local images or online images downloaded from the network need to be
} }
``` ```
3. Update online files in the onFormEvent lifecycle callback of the EntryFormAbility. 3. Update online images in the **onFormEvent** lifecycle callback of the EntryFormAbility.
```ts ```ts
import formBindingData from '@ohos.app.form.formBindingData'; import formBindingData from '@ohos.app.form.formBindingData';
...@@ -60,8 +60,8 @@ Generally, local images or online images downloaded from the network need to be ...@@ -60,8 +60,8 @@ Generally, local images or online images downloaded from the network need to be
'text': 'Updating...' 'text': 'Updating...'
}) })
formProvider.updateForm(formId, formInfo) formProvider.updateForm(formId, formInfo)
// Note: The FormExtensionAbility is started when the lifecycle callback is triggered. It can run in the background for only 5 seconds. // Note: After being started with the triggering of the lifecycle callback, the FormExtensionAbility can run in the background for only 5 seconds.
// When possible, limit the size of the image to download. If an image cannot be downloaded within 5 seconds, it cannot be updated to the widget page. // When possible, limit the size of the image to download. If an image cannot be downloaded within 5 seconds, it will not be updated to the widget page.
let netFile = 'https://xxxx/xxxx.png'; // Specify the URL of the image to download. let netFile = 'https://xxxx/xxxx.png'; // Specify the URL of the image to download.
let tempDir = this.context.getApplicationContext().tempDir; let tempDir = this.context.getApplicationContext().tempDir;
let fileName = 'file' + Date.now(); let fileName = 'file' + Date.now();
...@@ -161,6 +161,6 @@ Generally, local images or online images downloaded from the network need to be ...@@ -161,6 +161,6 @@ Generally, local images or online images downloaded from the network need to be
``` ```
> **NOTE** > **NOTE**
> - The **\<Image>** component displays images in the remote memory based on the **memory://** identifier in the input parameter (**memory://fileName**). The **fileName** value must be consistent with the key in the object (**'formImages': {key: fd}**) passed by the EntryFormAbility. > - The **\<Image>** component displays images in the remote memory based on the **memory://** identifier in the input parameter (**memory://fileName**). The value of **fileName** must be consistent with the key in the object (**'formImages': {key: fd}**) passed by the EntryFormAbility.
> >
> - The **\<Image>** component determines whether to update the image based on whether the input parameter is changed. Therefore, the value of **imgName** passed by the EntryFormAbility each time must be different. If the two values of **imgName** passed consecutively are identical, the image is not updated. > - The **\<Image>** component determines whether to update the image by comparing the values of **imgName** consecutively passed by the EntryFormAbility. It updates the image only when the values are different.
en/application-dev/application-models/arkts-ui-widget-lifecycle.md
浏览文件 @ f7d7c3d4
...@@ -92,4 +92,5 @@ When creating an ArkTS widget, you need to implement the [FormExtensionAbility]( ...@@ -92,4 +92,5 @@ When creating an ArkTS widget, you need to implement the [FormExtensionAbility](
> **NOTE** > **NOTE**
> The FormExtensionAbility cannot reside in the background. Therefore, continuous tasks cannot be processed in the widget lifecycle callbacks. The FormExtensionAbility persists for 5 seconds after the lifecycle callback is completed and will exit if no new lifecycle callback is invoked during this time frame. For the service logic that may take more than 5 seconds to complete, it is recommended that you [start the application](arkts-ui-widget-event-uiability.md). After the processing is complete, use the [updateForm](../reference/apis/js-apis-app-form-formProvider.md#updateform) to notify the widget of the update. >
> The FormExtensionAbility cannot reside in the background. It persists for 5 seconds after the lifecycle callback is completed and exist if no new lifecycle callback is invoked during this time frame. This means that continuous tasks cannot be processed in the widget lifecycle callbacks. For the service logic that may take more than 5 seconds to complete, it is recommended that you [start the application](arkts-ui-widget-event-uiability.md) for processing. After the processing is complete, use [updateForm()](../reference/apis/js-apis-app-form-formProvider.md#updateform) to notify the widget of the update.
en/application-dev/application-models/arkts-ui-widget-modules.md
浏览文件 @ f7d7c3d4
# ArkTS Widget Related Modules # ArkTS Widget Related Modules
**Figure 1** ArkTS widget related modules
**Figure 1** ArkTS widget related modules
![WidgetModules](figures/WidgetModules.png) ![WidgetModules](figures/WidgetModules.png)
...@@ -15,10 +15,10 @@ ...@@ -15,10 +15,10 @@
- [formBindingData](../reference/apis/js-apis-app-form-formBindingData.md): provides APIs for widget data binding. You can use the APIs to create a **FormBindingData** object and obtain related information. - [formBindingData](../reference/apis/js-apis-app-form-formBindingData.md): provides APIs for widget data binding. You can use the APIs to create a **FormBindingData** object and obtain related information.
- [Page Layout (Card.ets)](arkts-ui-widget-page-overview.md): provides APIs for a declarative paradigm UI. - [Page layout (Card.ets)](arkts-ui-widget-page-overview.md): provides APIs for a declarative paradigm UI.
- [ArkTS widget capabilities](arkts-ui-widget-event-overview.md): include the **postCardAction** API used for interaction between the widget internal and the provider application and can be called only in the widget. - [Capabilities exclusive to ArkTS widgets](arkts-ui-widget-event-overview.md): include the **postCardAction** API used for interaction between the widget internal and the provider application and can be called only in the widget.
- [ArkTS widget capability list](arkts-ui-widget-page-overview.md#page-capabilities-supported-by-arkts-widgets): lists the APIs, components, events, attributes, and lifecycle callbacks that can be used in ArkTS widgets. - [ArkTS widget capability list](arkts-ui-widget-page-overview.md#page-capabilities-supported-by-arkts-widgets): contain the APIs, components, events, attributes, and lifecycle callbacks that can be used in ArkTS widgets.
- [Widget configuration](arkts-ui-widget-configuration.md): includes FormExtensionAbility configuration and widget configuration. - [Widget configuration](arkts-ui-widget-configuration.md): includes FormExtensionAbility configuration and widget configuration.
- Configure FormExtensionAbility information under **extensionAbilities** in the [module.json5 file](../quick-start/module-configuration-file.md). - Configure the FormExtensionAbility information under **extensionAbilities** in the [module.json5 file](../quick-start/module-configuration-file.md).
- Configure the widget configuration information (**WidgetCard.ets**) in the [form_config.json](arkts-ui-widget-configuration.md) file in **resources/base/profile**. - Configure the widget configuration information (**WidgetCard.ets**) in the [form_config.json](arkts-ui-widget-configuration.md) file in **resources/base/profile**.
en/application-dev/application-models/arkts-ui-widget-page-animation.md
浏览文件 @ f7d7c3d4
# Using Animations in the Widget # Using Animations in the Widget
To make your ArkTS widget more engaging, you can apply animations to it, including [explicit animation](../reference/arkui-ts/ts-explicit-animation.md), [attribute animation](../reference/arkui-ts/ts-animatorproperty.md), and [component transition](../reference/arkui-ts/ts-transition-animation-component.md). Note the following restrictions when using the animations in ArkTS widgets. To make your ArkTS widget more engaging, you can apply animations to it, including [explicit animation](../reference/arkui-ts/ts-explicit-animation.md), [attribute animation](../reference/arkui-ts/ts-animatorproperty.md), and [component transition](../reference/arkui-ts/ts-transition-animation-component.md). Just note the following restrictions when using the animations in ArkTS widgets.
**Table 1** Restrictions on animation parameters **Table 1** Restrictions on animation parameters
| Name| Description| Description| | Name| Description| Description|
| -------- | -------- | -------- | | -------- | -------- | -------- |
...@@ -13,14 +13,10 @@ To make your ArkTS widget more engaging, you can apply animations to it, includi ...@@ -13,14 +13,10 @@ To make your ArkTS widget more engaging, you can apply animations to it, includi
| delay | Animation delay duration.| Do not set this parameter in the widget. Use the default value 0.| | delay | Animation delay duration.| Do not set this parameter in the widget. Use the default value 0.|
| iterations | Number of times that the animation is played.| Do not set this parameter in the widget. Use the default value 1.| | iterations | Number of times that the animation is played.| Do not set this parameter in the widget. Use the default value 1.|
The following sample code implements the animation effect of button rotation: The following sample code implements the animation effect of button rotation:
![WidgetAnimation](figures/WidgetAnimation.gif) ![WidgetAnimation](figures/WidgetAnimation.gif)
```ts ```ts
@Entry @Entry
@Component @Component
......
en/application-dev/application-models/arkts-ui-widget-page-custom-drawing.md
浏览文件 @ f7d7c3d4
# Applying Custom Drawing in the Widget # Applying Custom Drawing in the Widget
You can apply custom drawing in your ArkTS widget to create a more vibrant experience. Use the [Canvas](../reference/arkui-ts/ts-components-canvas-canvas.md) component to create a canvas on the widget, and then use the [CanvasRenderingContext2D](../reference/arkui-ts/ts-canvasrenderingcontext2d.md) object to draw custom graphics on the canvas. The following code shows how to draw a smiling face in the center of the canvas. You can apply custom drawing in your ArkTS widget to create a more vibrant experience. Use the [Canvas](../reference/arkui-ts/ts-components-canvas-canvas.md) component to create a canvas on the widget, and then use the [CanvasRenderingContext2D](../reference/arkui-ts/ts-canvasrenderingcontext2d.md) object to draw custom graphics on the canvas. The following code snippet draws a smiling face in the center of a canvas.
```typescript ```ts
@Entry @Entry
@Component @Component
struct Card { struct Card {
...@@ -30,41 +30,41 @@ struct Card { ...@@ -30,41 +30,41 @@ struct Card {
this.context.fillRect(0, 0, this.canvasWidth, this.canvasHeight); this.context.fillRect(0, 0, this.canvasWidth, this.canvasHeight);
// Draw a red circle in the center of the canvas. // Draw a red circle in the center of the canvas.
this.context.beginPath(); this.context.beginPath();
let radius = this.context.width / 3 let radius = this.context.width / 3;
let circleX = this.context.width / 2 let circleX = this.context.width / 2;
let circleY = this.context.height / 2 let circleY = this.context.height / 2;
this.context.moveTo(circleX - radius, circleY); this.context.moveTo(circleX - radius, circleY);
this.context.arc(circleX, circleY, radius, 2 * Math.PI, 0, true); this.context.arc(circleX, circleY, radius, 2 * Math.PI, 0, true);
this.context.closePath(); this.context.closePath();
this.context.fillStyle = 'red'; this.context.fillStyle = 'red';
this.context.fill(); this.context.fill();
// Draw the left eye of the smiling face. // Draw the left eye of the smiling face.
let leftR = radius / 4 let leftR = radius / 4;
let leftX = circleX - (radius / 2) let leftX = circleX - (radius / 2);
let leftY = circleY - (radius / 3.5) let leftY = circleY - (radius / 3.5);
this.context.beginPath(); this.context.beginPath();
this.context.arc(leftX, leftY, leftR, 0, Math.PI, true); this.context.arc(leftX, leftY, leftR, 0, Math.PI, true);
this.context.strokeStyle = '#ffff00' this.context.strokeStyle = '#ffff00';
this.context.lineWidth = 10 this.context.lineWidth = 10;
this.context.stroke() this.context.stroke();
// Draw the right eye of the smiling face. // Draw the right eye of the smiling face.
let rightR = radius / 4 let rightR = radius / 4;
let rightX = circleX + (radius / 2) let rightX = circleX + (radius / 2);
let rightY = circleY - (radius / 3.5) let rightY = circleY - (radius / 3.5);
this.context.beginPath(); this.context.beginPath();
this.context.arc(rightX, rightY, rightR, 0, Math.PI, true); this.context.arc(rightX, rightY, rightR, 0, Math.PI, true);
this.context.strokeStyle = '#ffff00' this.context.strokeStyle = '#ffff00';
this.context.lineWidth = 10 this.context.lineWidth = 10;
this.context.stroke() this.context.stroke();
// Draw the mouth of the smiling face. // Draw the mouth of the smiling face.
let mouthR = radius / 2.5 let mouthR = radius / 2.5;
let mouthX = circleX let mouthX = circleX;
let mouthY = circleY + (radius / 3) let mouthY = circleY + (radius / 3);
this.context.beginPath(); this.context.beginPath();
this.context.arc(mouthX, mouthY, mouthR, Math.PI, 0, true); this.context.arc(mouthX, mouthY, mouthR, Math.PI, 0, true);
this.context.strokeStyle = '#ffff00' this.context.strokeStyle = '#ffff00';
this.context.lineWidth = 10 this.context.lineWidth = 10;
this.context.stroke() this.context.stroke();
}) })
} }
}.height('100%').width('100%') }.height('100%').width('100%')
...@@ -72,8 +72,6 @@ struct Card { ...@@ -72,8 +72,6 @@ struct Card {
} }
``` ```
The figure below shows the effect. The figure below shows the effect.
![WidgetCanvasDemo](figures/WidgetCanvasDemo.png)
![WidgetCanvasDemo](figures/WidgetCanvasDemo.jpeg) \ No newline at end of file
en/application-dev/application-models/arkts-ui-widget-update-by-status.md
浏览文件 @ f7d7c3d4
# Updating Widget Content by State # Updating Widget Content by State
Multiple widgets of the same application can be configured to implement different features. For example, two weather widgets can be added to the home screen: one for displaying the weather of London, and the other Beijing. The widget is set to be updated at 07:00 every morning. It needs to detect the configured city, and then updates the city-specific weather information. The following example describes how to dynamically update the widget content based on the state. There are cases where multiple copies of the same widget are added to the home screen to accommodate different needs. In these cases, the widget content needs to be dynamically updated based on the state. This topic exemplifies how this is implemented. In the following example, two weather widgets are added to the home screen: one for displaying the weather of London, and the other Beijing, both configured to be updated at 07:00 every morning. The widget provider detects the target city, and then displays the city-specific weather information on the widgets.
- Widget configuration file: Configure the widget to be updated at 07:00 every morning. - Widget configuration file: Configure the widget to be updated at 07:00 every morning.
...@@ -74,7 +74,7 @@ Multiple widgets of the same application can be configured to implement differen ...@@ -74,7 +74,7 @@ Multiple widgets of the same application can be configured to implement differen
} }
Row() {// Content that is updated only in state A Row() {// Content that is updated only in state A
Text('State A: ') Text ('State A:')
Text(this.textA) Text(this.textA)
} }
...@@ -167,4 +167,5 @@ Multiple widgets of the same application can be configured to implement differen ...@@ -167,4 +167,5 @@ Multiple widgets of the same application can be configured to implement differen
> **NOTE** > **NOTE**
>
> When the local database is used for widget information persistence, it is recommended that [TEMPORARY_KEY](../reference/apis/js-apis-app-form-formInfo.md#formparam) be used to determine whether the currently added widget is a normal one in the [onAddForm](../reference/apis/js-apis-app-form-formExtensionAbility.md#onaddform) lifecycle callback. If the widget is a normal one, the widget information is directly persisted. If the widget is a temporary one, the widget information is persisted when the widget is converted to a normal one ([onCastToNormalForm](../reference/apis/js-apis-app-form-formExtensionAbility.md#oncasttonormalform)). In addition, the persistent widget information needs to be deleted when the widget is destroyed ([onRemoveForm](../reference/apis/js-apis-app-form-formExtensionAbility.md#onremoveform)), preventing the database size from continuously increasing due to repeated widget addition and deletion. > When the local database is used for widget information persistence, it is recommended that [TEMPORARY_KEY](../reference/apis/js-apis-app-form-formInfo.md#formparam) be used to determine whether the currently added widget is a normal one in the [onAddForm](../reference/apis/js-apis-app-form-formExtensionAbility.md#onaddform) lifecycle callback. If the widget is a normal one, the widget information is directly persisted. If the widget is a temporary one, the widget information is persisted when the widget is converted to a normal one ([onCastToNormalForm](../reference/apis/js-apis-app-form-formExtensionAbility.md#oncasttonormalform)). In addition, the persistent widget information needs to be deleted when the widget is destroyed ([onRemoveForm](../reference/apis/js-apis-app-form-formExtensionAbility.md#onremoveform)), preventing the database size from continuously increasing due to repeated widget addition and deletion.
en/application-dev/application-models/arkts-ui-widget-update-by-time.md
浏览文件 @ f7d7c3d4
...@@ -5,7 +5,7 @@ Before configuring a widget to update periodically, enable the periodic update f ...@@ -5,7 +5,7 @@ Before configuring a widget to update periodically, enable the periodic update f
The widget framework provides the following modes of updating widgets periodically: The widget framework provides the following modes of updating widgets periodically:
- Set the update interval: The widget will be updated at the specified interval. You can specify the interval by setting the [updateDuration](arkts-ui-widget-configuration.md) field in the **form_config.json** file. For example, you can configure the widget to update once an hour. - Set the update interval: The widget will be updated at the specified interval by calling [onUpdateForm](../reference/apis/js-apis-app-form-formExtensionAbility.md#onupdateform). You can specify the interval by setting the [updateDuration](arkts-ui-widget-configuration.md) field in the **form_config.json** file. For example, you can configure the widget to update once an hour.
> **NOTE** > **NOTE**
> >
......
en/application-dev/application-models/common-event-overview.md
浏览文件 @ f7d7c3d4
...@@ -7,8 +7,7 @@ OpenHarmony provides Common Event Service (CES) for applications to subscribe to ...@@ -7,8 +7,7 @@ OpenHarmony provides Common Event Service (CES) for applications to subscribe to
Common events are classified into system common events and custom common events. Common events are classified into system common events and custom common events.
- System common events: defined in CES. Only system applications and system services can publish system common events, such as HAP installation, update, and uninstall. For details about the supported system common events, see [Support](../reference/apis/js-apis-commonEventManager.md#support). - System common events: defined in CES. Currently, only system applications and system services can publish system common events, such as HAP installation, update, and uninstall. For details about the supported system common events, see [System Common Events](../reference/apis/commonEventManager-definitions.md).
- Custom common events: customized by applications to implement cross-process event communication. - Custom common events: customized by applications to implement cross-process event communication.
...@@ -16,9 +15,7 @@ Common events are also classified into unordered, ordered, and sticky common eve ...@@ -16,9 +15,7 @@ Common events are also classified into unordered, ordered, and sticky common eve
- Unordered common events: common events that CES forwards regardless of whether subscribers receive the events and when they subscribe to the events. - Unordered common events: common events that CES forwards regardless of whether subscribers receive the events and when they subscribe to the events.
- Ordered common events: common events that CES forwards based on the subscriber priority. CES preferentially forwards an ordered common event to the subscriber with higher priority, waits until the subscriber receives the event, and then forwards the events to the subscriber with lower priority. Subscribers with the same priority receive common events in a random order.
- Ordered common events: common events that CES forwards based on the subscriber priority. CES forwards common events to the subscriber with lower priority only after receiving a reply from the previous subscriber with higher priority. Subscribers with the same priority receive common events in a random order.
- Sticky common events: common events that can be sent to a subscriber before or after they initiate a subscription. Only system applications and system services can send sticky common events, which remain in the system after being sent. The sends must first request the **ohos.permission.COMMONEVENT_STICKY** permission. For details about the configuration, see [Permission Application Guide](../security/accesstoken-guidelines.md#declaring-permissions-in-the-configuration-file). - Sticky common events: common events that can be sent to a subscriber before or after they initiate a subscription. Only system applications and system services can send sticky common events, which remain in the system after being sent. The sends must first request the **ohos.permission.COMMONEVENT_STICKY** permission. For details about the configuration, see [Permission Application Guide](../security/accesstoken-guidelines.md#declaring-permissions-in-the-configuration-file).
......
en/application-dev/application-models/common-event-remove-sticky.md
浏览文件 @ f7d7c3d4
# Removing Sticky Common Events # Removing Sticky Common Events (for System Applications Only)
## When to Use ## When to Use
...@@ -16,21 +16,26 @@ For details, see [Common Event](../reference/apis/js-apis-commonEventManager.md) ...@@ -16,21 +16,26 @@ For details, see [Common Event](../reference/apis/js-apis-commonEventManager.md)
## How to Develop ## How to Develop
1. Import the module. 1. Request the **ohos.permission.COMMONEVENT_STICKY** permission. For details, see [Declaring Permissions in the Configuration File](../security/accesstoken-guidelines.md#declaring-permissions-in-the-configuration-file).
2. Import the module.
```ts ```ts
import commonEventManager from '@ohos.commonEventManager'; import commonEventManager from '@ohos.commonEventManager';
``` ```
2. The sticky common event to be removed must have been released by the application. For details about how to release sticky common events, see [Publishing Common Events](common-event-publish.md). 3. Call the [removeStickyCommonEvent()](../reference/apis/js-apis-commonEventManager.md#commoneventmanagerremovestickycommonevent10) API to remove the target sticky common event.
> **NOTE**
>
> The sticky common event to be removed must have been released by the application. For details about how to release sticky common events, see [Publishing Common Events](common-event-publish.md).
```ts ```ts
CommonEventManager.removeStickyCommonEvent("sticky_event", (err) => { // sticky_event indicates the name of the sticky common event to remove. commonEventManager.removeStickyCommonEvent("sticky_event", (err) => { // sticky_event indicates the name of the target sticky common event.
if (err) { if (err) {
console.info(`Remove sticky event AsyncCallback failed, errCode: ${err.code}, errMes: ${err.message}`); console.error(`Failed to remove sticky common event. Code is ${err.code}, message is ${err.message}`);
return; return;
} }
console.info(`Remove sticky event AsyncCallback success`); console.info(`Succeeded in removeing sticky event.`);
}
}); });
``` ```
en/application-dev/application-models/common-event-static-subscription.md
浏览文件 @ f7d7c3d4
...@@ -2,38 +2,46 @@ ...@@ -2,38 +2,46 @@
## When to Use ## When to Use
A static subscriber is started once it receives a target event published by the system or application. At the same time, the **onReceiveEvent** callback is triggered, in which you can implement the service logic. For example, if an application needs to execute some initialization tasks during device power-on, the application can subscribe to the power-on event in static mode. After receiving the power-on event, the application is started to execute the initialization tasks. Subscribing to a common event in static mode is achieved by configuring a declaration file and implementing a class that inherits from **StaticSubscriberExtensionAbility**. Note that this subscribing mode has negative impact on system power consumption. Therefore, exercise caution when using this mode. A static subscriber is started once it receives a target event published by the system or application. At the same time, the [onReceiveEvent()](../reference/apis/js-apis-application-staticSubscriberExtensionAbility.md#staticsubscriberextensionabilityonreceiveevent) callback is triggered.
You can implement the service logic in the [onReceiveEvent()](../reference/apis/js-apis-application-staticSubscriberExtensionAbility.md#staticsubscriberextensionabilityonreceiveevent) callback. For example, if an application needs to execute some initialization tasks during device power-on, the application can subscribe to the power-on event in static mode. After receiving the power-on event, the application is started to execute the initialization tasks.
Subscribing to a common event in static mode is achieved by configuring a declaration file and implementing a class that inherits from [StaticSubscriberExtensionAbility](../reference/apis/js-apis-application-staticSubscriberExtensionAbility.md).
> **NOTE**
>
> The static subscription mode has negative impact on system power consumption. Therefore, exercise caution when using this mode.
## How to Develop ## How to Develop
1. Declaring a Static Subscriber 1. Declaring a static subscriber.
To declare a static subscriber, create an ExtensionAbility, which is derived from the **StaticSubscriberExtensionAbility** class, in the project.
To declare a static subscriber, create an ExtensionAbility, which is derived from the **StaticSubscriberExtensionAbility** class, in the project. The sample code is as follows: You can implement service logic in the **onReceiveEvent()** callback.
```ts ```ts
import StaticSubscriberExtensionAbility from '@ohos.application.StaticSubscriberExtensionAbility' import StaticSubscriberExtensionAbility from '@ohos.application.StaticSubscriberExtensionAbility'
export default class StaticSubscriber extends StaticSubscriberExtensionAbility { export default class StaticSubscriber extends StaticSubscriberExtensionAbility {
onReceiveEvent(event) { onReceiveEvent(event) {
console.log('onReceiveEvent, event:' + event.event); console.info('onReceiveEvent, event: ' + event.event);
} }
} }
``` ```
You can implement service logic in the **onReceiveEvent** callback. 2. Configure static subscriber settings.
2. Project Configuration for a Static Subscriber After writing the static subscriber code, configure the subscriber in the [module.json5](../quick-start/module-configuration-file.md) file.
After writing the static subscriber code, configure the subscriber in the **module.json5** file. The configuration format is as follows:
```ts ```ts
{ {
"module": { "module": {
...... ...
"extensionAbilities": [ "extensionAbilities": [
{ {
"name": "StaticSubscriber", "name": "StaticSubscriber",
"srcEntry": "./ets/StaticSubscriber/StaticSubscriber.ts", "srcEntry": "./ets/staticsubscriber/StaticSubscriber.ts",
"description": "$string:StaticSubscriber_desc", "description": "$string:StaticSubscriber_desc",
"icon": "$media:icon", "icon": "$media:icon",
"label": "$string:StaticSubscriber_label", "label": "$string:StaticSubscriber_label",
...@@ -47,14 +55,14 @@ A static subscriber is started once it receives a target event published by the ...@@ -47,14 +55,14 @@ A static subscriber is started once it receives a target event published by the
] ]
} }
] ]
...... ...
} }
} }
``` ```
Pay attention to the following fields in the JSON file: Some fields in the file are described as follows:
- **srcEntry**: entry file path of the ExtensionAbility, that is, the file path of the static subscriber declared in Step 2. - **srcEntry **: entry file path of the ExtensionAbility, that is, the file path of the static subscriber declared in Step 2.
- **type**: ExtensionAbility type. For a static subscriber, set this field to **staticSubscriber**. - **type**: ExtensionAbility type. For a static subscriber, set this field to **staticSubscriber**.
...@@ -62,9 +70,10 @@ A static subscriber is started once it receives a target event published by the ...@@ -62,9 +70,10 @@ A static subscriber is started once it receives a target event published by the
- **name**: name of the ExtensionAbility. For a static subscriber, declare the name as **ohos.extension.staticSubscriber** for successful identification. - **name**: name of the ExtensionAbility. For a static subscriber, declare the name as **ohos.extension.staticSubscriber** for successful identification.
- **resource**: path that stores the ExtensionAbility configuration, which is customizable. In this example, the path is **resources/base/profile/subscribe.json**. - **resource**: path that stores the ExtensionAbility configuration, which is customizable. In this example, the path is **resources/base/profile/subscribe.json**.
A level-2 configuration file pointed to by **metadata** must be in the following format:
```ts 3. Configure the level-2 configuration file to which the metadata points.
```json
{ {
"commonEvents": [ "commonEvents": [
{ {
...@@ -78,26 +87,29 @@ A static subscriber is started once it receives a target event published by the ...@@ -78,26 +87,29 @@ A static subscriber is started once it receives a target event published by the
} }
``` ```
If the level-2 configuration file is not declared in this format, the file cannot be identified. The fields are described as follows: If the level-2 configuration file is not declared in this format, the file cannot be identified. Some fields in the file are described as follows:
- **name**: name of the ExtensionAbility, which must be the same as the name of **extensionAbility** declared in **module.json5**. - **name**: name of the ExtensionAbility, which must be the same as the name of **extensionAbility** declared in **module.json5**.
- **permission**: permission required for the publisher. If a publisher without the required permission attempts to publish an event, the event is regarded as invalid and will not be published. - **permission**: permission required for the publisher. If a publisher without the required permission attempts to publish an event, the event is regarded as invalid and will not be published.
- **events**: list of target events to subscribe to. - **events**: list of target events to subscribe to.
3. Device System Configuration 4. Modify the [preset configuration file](https://gitee.com/openharmony/vendor_hihope/blob/master/rk3568/preinstall-config/install_list_permissions.json) of the device, that is, the **/system/etc/app/install_list_permission.json** file on the device. When the device is started, this file is read. During application installation, the common event type specified by **allowCommonEvent** in the file is authorized. The **install_list_permission.json** file contains the following fields:
In the device system configuration file **/system/etc/app/install_list_capability.json**, add the bundle name of the static subscriber. - **bundleName**: bundle name of the application.
- **app_signature**: fingerprint information of the application. For details, see [Application Privilege Configuration Guide](../../device-dev/subsystems/subsys-app-privilege-config-guide.md#configuration-in-install_list_capabilityjson).
- **allowCommonEvent**: type of common event that can be started by static broadcast.
> **NOTE**
>
> The **install_list_permissions.json** file is available only for preinstalled applications.
```json ```json
[
{ {
"install_list": [ "bundleName": "com.example.myapplication",
{ "app_signature": ["****"],
"bundleName": "ohos.extension.staticSubscriber", "allowCommonEvent": ["usual.event.A", "usual.event.B"]
"allowCommonEvent": ["usual.event.A", "usual.event.B"],
} }
] ]
}
``` ```
en/application-dev/application-models/common-event-subscription-overview.md
浏览文件 @ f7d7c3d4
# Common Event Subscription Overview # Common Event Subscription Overview
​The common event service provides two subscription modes: dynamic and static. The biggest difference between these two modes is that dynamic subscription requires the application to be running, while static subscription does not. The common event service provides two subscription modes: dynamic and static. The biggest difference between these two modes is that dynamic subscription requires the application to be running, while static subscription does not.
- In dynamic subscription mode, a subscriber subscribes to common events by calling an API during the running period. For details, see [Subscribing to Common Events in Dynamic Mode](common-event-subscription.md). - In dynamic subscription mode, a subscriber subscribes to common events by calling an API during the running period. For details, see [Subscribing to Common Events in Dynamic Mode](common-event-subscription.md).
- In static subscription mode, a subscriber subscribes to common events by configuring a declaration file and implementing a class that inherits from StaticSubscriberExtensionAbility. For details, see [Subscribing to Common Events in Static Mode](common-event-static-subscription.md). - In static subscription mode, a subscriber subscribes to common events by configuring a declaration file and implementing a class that inherits from **StaticSubscriberExtensionAbility**. For details, see [Subscribing to Common Events in Static Mode](common-event-static-subscription.md).
en/application-dev/application-models/common-event-subscription.md
浏览文件 @ f7d7c3d4
...@@ -42,12 +42,12 @@ For details about the APIs, see [API Reference](../reference/apis/js-apis-common ...@@ -42,12 +42,12 @@ For details about the APIs, see [API Reference](../reference/apis/js-apis-common
// Callback for subscriber creation. // Callback for subscriber creation.
commonEventManager.createSubscriber(subscribeInfo, (err, data) => { commonEventManager.createSubscriber(subscribeInfo, (err, data) => {
if (err) { if (err) {
console.error(`[CommonEvent] CreateSubscriberCallBack err=${JSON.stringify(err)}`); console.error(`Failed to create subscriber. Code is ${err.code}, message is ${err.message}`);
} else { return;
console.info(`[CommonEvent] CreateSubscriber success`); }
console.info('Succeeded in creating subscriber.');
subscriber = data; subscriber = data;
// Callback for common event subscription. // Callback for common event subscription.
}
}) })
``` ```
...@@ -58,12 +58,11 @@ For details about the APIs, see [API Reference](../reference/apis/js-apis-common ...@@ -58,12 +58,11 @@ For details about the APIs, see [API Reference](../reference/apis/js-apis-common
if (subscriber !== null) { if (subscriber !== null) {
commonEventManager.subscribe(subscriber, (err, data) => { commonEventManager.subscribe(subscriber, (err, data) => {
if (err) { if (err) {
console.error(`[CommonEvent] SubscribeCallBack err=${JSON.stringify(err)}`); console.error(`Failed to subscribe common event. Code is ${err.code}, message is ${err.message}`);
} else { return;
console.info(`[CommonEvent] SubscribeCallBack data=${JSON.stringify(data)}`);
} }
}) })
} else { } else {
console.error(`[CommonEvent] Need create subscriber`); console.error(`Need create subscriber`);
} }
``` ```
en/application-dev/application-models/data-share-via-want.md
浏览文件 @ f7d7c3d4
...@@ -48,9 +48,9 @@ function implicitStartAbility() { ...@@ -48,9 +48,9 @@ function implicitStartAbility() {
} }
} }
context.startAbility(wantInfo).then(() => { context.startAbility(wantInfo).then(() => {
// ... ...
}).catch((err) => { }).catch((err) => {
// ... ...
}) })
} }
``` ```
...@@ -67,7 +67,6 @@ In the preceding code, under the custom field **parameters**, the following **ab ...@@ -67,7 +67,6 @@ In the preceding code, under the custom field **parameters**, the following **ab
- **ability.picker.fileNames** and **ability.picker.fileSizes** are arrays and have a one-to-one mapping. - **ability.picker.fileNames** and **ability.picker.fileSizes** are arrays and have a one-to-one mapping.
The following figure shows an example. The following figure shows an example.
![](figures/ability-startup-with-implicit-want2.png) ![](figures/ability-startup-with-implicit-want2.png)
## Shared Party ## Shared Party
...@@ -77,17 +76,17 @@ To enable the shared party to identify the shared content, configure **skills** ...@@ -77,17 +76,17 @@ To enable the shared party to identify the shared content, configure **skills**
```json ```json
{ {
"module": { "module": {
// ... ...
"abilities": [ "abilities": [
{ {
// ... ...
"skills": [ "skills": [
{ {
// ... ...
"actions": [ "actions": [
"action.system.home", "action.system.home",
"ohos.want.action.sendData" "ohos.want.action.sendData"
// ... ...
], ],
"uris": [ "uris": [
{ {
...@@ -102,7 +101,7 @@ To enable the shared party to identify the shared content, configure **skills** ...@@ -102,7 +101,7 @@ To enable the shared party to identify the shared content, configure **skills**
} }
``` ```
After the user selects an application, the Want nested in the **ability.want.params.INTENT** field is passed to that application. The UIAbility of the shared party, after being started, can call [onCreate()](../reference/apis/js-apis-app-ability-uiAbility.md#uiabilityoncreate) or [onNewWant()](../reference/apis/js-apis-app-ability-uiAbility.md#uiabilityonnewwant) to obtain the passed Want. After the user selects an application, the Want nested in the **ability.want.params.INTENT** field is passed to that application. After the UIAbility of the application starts, the application obtains **want** information from [**onCreate()**](../reference/apis/js-apis-app-ability-uiAbility.md#uiabilityoncreate) or [**onNewWant()**](../reference/apis/js-apis-app-ability-uiAbility.md#uiabilityonnewwant).
The following is an example of the Want obtained. You can use the FD of the shared file to perform required operations. The following is an example of the Want obtained. You can use the FD of the shared file to perform required operations.
......
en/application-dev/application-models/explicit-implicit-want-mappings.md
浏览文件 @ f7d7c3d4
# Matching Rules of Explicit Want and Implicit Want # Matching Rules of Explicit Want and Implicit Want
Both explicit Want and implicit Want can be used to match an ability to start based on certain rules. These rules determine how the parameters set in Want match the configuration file declared by the target ability. Both explicit [Want](../reference/apis/js-apis-app-ability-want.md) and implicit [Want](../reference/apis/js-apis-app-ability-want.md) can be used to match an application component to start based on certain rules. These rules determine how the parameters set in [want](../reference/apis/js-apis-app-ability-want.md) match the configuration file declared by the target application component.
## Matching Rules of Explicit Want ## Matching Rules of Explicit Want
The table below describes the matching rules of explicit Want. The table below describes the matching rules of explicit [Want](../reference/apis/js-apis-app-ability-want.md).
| Name| Type| Matching Item| Mandatory| Rule Description| | Name| Type| Matching Item| Mandatory| Rule Description|
| -------- | -------- | -------- | -------- | -------- | | -------- | -------- | -------- | -------- | -------- |
| deviceId | string | Yes| No| If this field is unspecified, only abilities on the local device are matched.| | deviceId | string | Yes| No| If this field is unspecified, only application components on the local device are matched.|
| bundleName | string | Yes| Yes| If **abilityName** is specified but **bundleName** is unspecified, the matching fails.| | bundleName | string | Yes| Yes| If **abilityName** is specified but **bundleName** is unspecified, the matching fails.|
| moduleName | string | Yes| No| If this field is unspecified and multiple modules with the same ability name exist in the application, the first ability is matched by default.| | moduleName | string | Yes| No| If this field is unspecified and multiple modules with the same ability name exist in the application, the first application component is matched by default.|
| abilityName | string | Yes| Yes| To use explicit Want, this field must be specified.| | abilityName | string | Yes| Yes| To use explicit Want, this field must be specified.|
| uri | string | No| No| This field is not used for matching. It is passed to the target ability as a parameter.| | uri | string | No| No| This field is not used for matching. It is passed to the target application component as a parameter.|
| type | string | No| No| This field is not used for matching. It is passed to the target ability as a parameter.| | type | string | No| No| This field is not used for matching. It is passed to the target application component as a parameter.|
| action | string | No| No| This field is not used for matching. It is passed to the target ability as a parameter.| | action | string | No| No| This field is not used for matching. It is passed to the target application component as a parameter.|
| entities | Array&lt;string&gt; | No| No| This field is not used for matching. It is passed to the target ability as a parameter.| | entities | Array&lt;string&gt; | No| No| This field is not used for matching. It is passed to the target application component as a parameter.|
| flags | number | No| No| This field is not used for matching and is directly transferred to the system for processing. It is generally used to set runtime information, such as URI data authorization.| | flags | number | No| No| This field is not used for matching and is directly transferred to the system for processing. It is generally used to set runtime information, such as URI data authorization.|
| parameters | {[key:&nbsp;string]:&nbsp;any} | No| No| This field is not used for matching. It is passed to the target ability as a parameter.| | parameters | {[key:&nbsp;string]:&nbsp;any} | No| No| This field is not used for matching. It is passed to the target application component as a parameter.|
## Matching Rules for Implicit Want ## Matching Rules for Implicit Want
The table below describes the matching rules of implicit Want. The table below describes the matching rules of implicit [Want](../reference/apis/js-apis-app-ability-want.md).
| Name | Type | Matching Item| Mandatory| Rule Description | | Name | Type | Matching Item| Mandatory| Rule Description |
| ----------- | ------------------------------ | ------ | ---- | ------------------------------------------------------------ | | ----------- | ------------------------------ | ------ | ---- | ------------------------------------------------------------ |
...@@ -35,30 +35,32 @@ The table below describes the matching rules of implicit Want. ...@@ -35,30 +35,32 @@ The table below describes the matching rules of implicit Want.
| action | string | Yes | No | | | action | string | Yes | No | |
| entities | Array&lt;string&gt; | Yes | No | | | entities | Array&lt;string&gt; | Yes | No | |
| flags | number | No | No | This field is not used for matching and is directly transferred to the system for processing. It is generally used to set runtime information, such as URI data authorization.| | flags | number | No | No | This field is not used for matching and is directly transferred to the system for processing. It is generally used to set runtime information, such as URI data authorization.|
| parameters | {[key:&nbsp;string]:&nbsp;any} | No | No | This field is not used for matching. It is passed to the target ability as a parameter. | | parameters | {[key:&nbsp;string]:&nbsp;any} | No | No | This field is not used for matching. It is passed to the target application component as a parameter. |
Get familiar with the following about implicit Want: Get familiar with the following about implicit Want:
- The **want** parameter passed by the caller indicates the operation to be performed by the caller. It also provides data and application type restrictions. - The **want** parameter passed by the caller indicates the operation to be performed by the caller. It also provides data and application type restrictions.
- The **skills** field declares the capabilities of the target ability. For details, see [the skills tag](../quick-start/module-configuration-file.md#skills) in the [module.json5 file](../quick-start/module-configuration-file.md). - The **skills** field declares the capabilities of the target application component. For details, see [the skills tag](../quick-start/module-configuration-file.md#skills) in the [module.json5 file](../quick-start/module-configuration-file.md).
The system matches the **want** parameter (including the **action**, **entities**, **uri**, and **type** attributes) passed by the caller against the **skills** configuration (including the **actions**, **entities**, **uris**, and **type** attributes) of the abilities one by one. When all the four attributes are matched, a dialog box is displayed for users to select a matched application. The system matches the **want** parameter (including the **action**, **entities**, **uri**, and **type** attributes) passed by the caller against the **skills** configuration (including the **actions**, **entities**, **uris**, and **type** attributes) of the application components one by one. When all the four attributes are matched, a dialog box is displayed for users to select a matched application.
### Matching Rules of action in the want Parameter ### Matching Rules of action in the want Parameter
The system matches the **action** attribute in the **want** parameter passed by the caller against **actions** under **skills** of the abilities. The system matches the **action** attribute in the **want** parameter passed by the caller against **actions** under **skills** of the application components.
- If **action** in the passed **want** parameter is specified but **actions** under **skills** of an ability is unspecified, the matching fails. - If **action** in the passed **want** parameter is unspecified and **actions** under **skills** of an application component is unspecified, the matching fails.
- If **action** in the passed **want** parameter is unspecified but **actions** under **skills** of an ability is specified, the matching is successful. - If **action** in the passed **want** parameter is specified but **actions** under **skills** of an application component is unspecified, the matching fails.
- If **action** in the passed **want** parameter is specified, and **actions** under **skills** of an ability is specified and contains **action** in the passed **want** parameter, the matching is successful. - If **action** in the passed **want** parameter is unspecified but **actions** under **skills** of an application component is specified, the matching is successful.
- If **action** in the passed **want** parameter is specified, and **actions** under **skills** of an ability is specified but does not contain **action** in the passed **want** parameter, the matching fails. - If **action** in the passed **want** parameter is specified, and **actions** under **skills** of an application component is specified and contains **action** in the passed **want** parameter, the matching is successful.
- If **action** in the passed **want** parameter is specified, and **actions** under **skills** of an application component is specified but does not contain **action** in the passed **want** parameter, the matching fails.
**Figure 1** Matching rules of action in the want parameter **Figure 1** Matching rules of action in the want parameter
...@@ -67,55 +69,56 @@ The system matches the **action** attribute in the **want** parameter passed by ...@@ -67,55 +69,56 @@ The system matches the **action** attribute in the **want** parameter passed by
### Matching Rules of entities in the want Parameter ### Matching Rules of entities in the want Parameter
The system matches the **entities** attribute in the **want** parameter passed by the caller against **entities** under **skills** of the abilities. The system matches the **entities** attribute in the **want** parameter passed by the caller against **entities** under **skills** of the application components.
- If **entities** in the passed **want** parameter is unspecified but **entities** under **skills** of an ability is specified, the matching is successful. - If **entities** in the passed **want** parameter is unspecified but **entities** under **skills** of an application component is specified, the matching is successful.
- If **entities** in the passed **want** parameter is unspecified but **entities** under **skills** of an ability is unspecified, the matching is successful. - If **entities** in the passed **want** parameter is unspecified but **entities** under **skills** of an application component is unspecified, the matching is successful.
- If **entities** in the passed **want** parameter is specified but **entities** under **skills** of an ability is unspecified, the matching fails. - If **entities** in the passed **want** parameter is specified but **entities** under **skills** of an application component is unspecified, the matching fails.
- If **entities** in the passed **want** parameter is specified, and **entities** under **skills** of an ability is specified and contains **entities** in the passed **want** parameter, the matching is successful. - If **entities** in the passed **want** parameter is specified, and **entities** under **skills** of an application component is specified and contains **entities** in the passed **want** parameter, the matching is successful.
- If **entities** in the passed **want** parameter is specified, and **entities** under **skills** of an ability is specified but does not contain **entities** in the passed **want** parameter, the matching fails. - If **entities** in the passed **want** parameter is specified, and **entities** under **skills** of an application component is specified but does not contain **entities** in the passed **want** parameter, the matching fails.
**Figure 2** Matching rule of entities in the want parameter **Figure 2** Matching rules of entities in the want parameter
![want-entities](figures/want-entities.png) ![want-entities](figures/want-entities.png)
### Matching Rules of uri and type in the want Parameter ### Matching Rules of uri and type in the want Parameter
When the **uri** and **type** parameters are specified in the **want** parameter to initiate a component startup request, the system traverses the list of installed components and matches the **uris** array under **skills** of the abilities one by one. If one of the **uris** arrays under **skills** matches the **uri** and **type** in the passed **want**, the matching is successful. When the **uri** and **type** parameters are specified in the **want** parameter to initiate an application component startup request, the system traverses the list of installed components and matches the **uris** array under **skills** of the application components one by one. If one of the **uris** arrays under **skills** matches the **uri** and **type** in the passed **want**, the matching is successful.
There are four combinations of **uri** and **type** settings. The matching rules are as follows: There are four combinations of **uri** and **type** settings. The matching rules are as follows:
- Neither **uri** or **type** is specified in the **want** parameter. - Neither **uri** or **type** is specified in the **want** parameter.
- If the **uris** array under **skills** of an ability is unspecified, the matching is successful. - If the **uris** array under **skills** of an application component is unspecified, the matching is successful.
- If the **uris** array under **skills** of an ability contains an URI element whose **scheme** and **type** are unspecified, the matching is successful. - If the **uris** array under **skills** of an application component contains an URI element whose **scheme** and **type** are unspecified, the matching is successful.
- In other cases, the matching fails. - In other cases, the matching fails.
- Only **uri** is specified in the **want** parameter. - Only **uri** is specified in the **want** parameter.
- If the **uris** array under **skills** of an ability is unspecified, the matching fails. - If the **uris** array under **skills** of an application component is unspecified, the matching fails.
- If the **uris** array under **skills** of an ability contains an element whose [uri is matched](#matching-rules-of-uri) and **type** is unspecified, the matching is successful. Otherwise, the matching fails. - If the **uris** array under **skills** of an application component contains an element whose [uri is matched](#matching-rules-of-uri) and **type** is unspecified, the matching is successful. Otherwise, the matching fails.
- Only **type** is specified in the **want** parameter. - Only **type** is specified in the **want** parameter.
- If the **uris** array under **skills** of an ability is unspecified, the matching fails. - If the **uris** array under **skills** of an application component is unspecified, the matching fails.
- If the **uris** array under **skills** of an ability contains an URI element whose **scheme** is unspecified and [type is matched](#matching-rules-of-type), the matching is successful. Otherwise, the matching fails. - If the **uris** array under **skills** of an application component contains an URI element whose **scheme** is unspecified and [type is matched](#matching-rules-of-type), the matching is successful. Otherwise, the matching fails.
- Both **uri** and **type** are specified in the **want** parameter, as shown in Figure 3. - Both **uri** and **type** are specified in the **want** parameter, as shown below.
- If the **uris** array under **skills** of an ability is unspecified, the matching fails. - If the **uris** array under **skills** of an application component is unspecified, the matching fails.
- If the **uris** array under **skills** of an ability contains an element whose [uri is matched](#matching-rules-of-uri) and [type is matched](#matching-rules-of-type), the matching is successful. Otherwise, the matching fails. - If the **uris** array under **skills** of an application component contains an element whose [uri is matched](#matching-rules-of-uri) and [type is matched](#matching-rules-of-type), the matching is successful. Otherwise, the matching fails.
Leftmost URI matching: When only **scheme**, a combination of **scheme** and **host**, or a combination of **scheme**, **host**, and **port** is configured in the **uris** array under **skills** of the ability, Leftmost URI matching: When only **scheme**, a combination of **scheme** and **host**, or a combination of **scheme**, **host**, and **port** is configured in the **uris** array under **skills** of the application component, the matching is successful only if the leftmost URI in the passed **want** parameter matches **scheme**, the combination of **scheme** and **host**, or the combination of **scheme**, **host**, and **port**.
the matching is successful only if the leftmost URI in the passed **want** parameter matches **scheme**, the combination of **scheme** and **host**, or the combination of **scheme**, **host**, and **port**.
**Figure 3** Matching rules when uri and type are specified in the want parameter **Figure 3** Matching rules when uri and type are specified in the want parameter
![want-uri-type1](figures/want-uri-type1.png) ![want-uri-type1](figures/want-uri-type1.png)
To simplify the description:
To simplify the description, **uri** and **type** passed in the **want** parameter are called **w_uri** and **w_type**, respectively; the **uris** array under **skills** of an ability to match is called **s_uris**; each element in the array is called **s_uri**. Matching is performed from top to bottom. - **uri** in the **want** parameter passed in by the caller is called **w_uri**; each element in the **uris** array under **skills** of the application component to match is called **s_uri**.
- **type** in the **want** parameter passed in by the caller is called **w_type**; the type in the **uris** array under **skills** of the application component to match is called **s_type**.
**Figure 4** Matching rules of uri and type in the want parameter **Figure 4** Matching rules of uri and type in the want parameter
...@@ -124,7 +127,7 @@ To simplify the description, **uri** and **type** passed in the **want** paramet ...@@ -124,7 +127,7 @@ To simplify the description, **uri** and **type** passed in the **want** paramet
### Matching Rules of uri ### Matching Rules of uri
To simplify the description, **uri** in the passed **want** parameter is called **w_uri**; **uri** under **skills** of an ability to match is called **s_uri**. The matching rules are as follows: The rules are as follows:
- If **scheme** of **s_uri** is unspecified and **w_uri** is unspecified, the matching is successful. Otherwise, the matching fails. - If **scheme** of **s_uri** is unspecified and **w_uri** is unspecified, the matching is successful. Otherwise, the matching fails.
...@@ -142,18 +145,15 @@ To simplify the description, **uri** in the passed **want** parameter is called ...@@ -142,18 +145,15 @@ To simplify the description, **uri** in the passed **want** parameter is called
> **NOTE** > **NOTE**
> >
> The **scheme**, **host**, **port**, **path**, **pathStartWith**, and **pathRegex** attributes of **uris** under **skills** of an ability are concatenated. If **path**, **pathStartWith**, and **pathRegex** are declared in sequence, **uris** can be concatenated into the following expressions: > The **scheme**, **host**, **port**, **path**, **pathStartWith**, and **pathRegex** attributes of **uris** under **skills** of an application component are concatenated. If **path**, **pathStartWith**, and **pathRegex** are declared in sequence, **uris** can be concatenated into the following expressions:
>
> - **Full path expression**: `scheme://host:port/path`
>
> - **Prefix expression**: `scheme://host:port/pathStartWith`
>
> - **Regular expression**: `scheme://host:port/pathRegex`
> >
> - **Prefix URI expression**: When only **scheme**, a combination of **scheme** and **host**, or a combination of **scheme**, **host**, and **port** is configured in the configuration file, the matching is successful if a URI prefixed with the configuration file is passed in. > - **Prefix URI expression**: When only **scheme**, a combination of **scheme** and **host**, or a combination of **scheme**, **host**, and **port** is configured in the configuration file, the matching is successful if a URI prefixed with the configuration file is passed in.
> * `scheme://` > * `scheme://`
> * `scheme://host` > * `scheme://host`
> * `scheme://host:port` > * `scheme://host:port`
> - **Full path expression**: `scheme://host:port/path`
> - **Prefix expression**: `scheme://host:port/pathStartWith`
> - **Regular expression**: `scheme://host:port/pathRegex`
### Matching Rules of type ### Matching Rules of type
...@@ -162,7 +162,7 @@ To simplify the description, **uri** in the passed **want** parameter is called ...@@ -162,7 +162,7 @@ To simplify the description, **uri** in the passed **want** parameter is called
> >
> The matching rules of **type** described in this section are based on the fact that **type** in the **want** parameter is specified. If **type** is unspecified, follow the [matching rules of uri and type in the want parameter](#matching-rules-of-uri-and-type-in-the-want-parameter). > The matching rules of **type** described in this section are based on the fact that **type** in the **want** parameter is specified. If **type** is unspecified, follow the [matching rules of uri and type in the want parameter](#matching-rules-of-uri-and-type-in-the-want-parameter).
To simplify the description, **uri** in the passed **want** parameter is called **w_type**, and **type** of **uris** under **skills** of an ability to match is called **s_type**. The matching rules are as follows: The matching rules are as follows:
- If **s_type** is unspecified, the matching fails. - If **s_type** is unspecified, the matching fails.
......
en/application-dev/application-models/extensionability-overview.md
浏览文件 @ f7d7c3d4
...@@ -11,17 +11,17 @@ An [ExtensionAbilityType](../reference/apis/js-apis-bundleManager.md#extensionab ...@@ -11,17 +11,17 @@ An [ExtensionAbilityType](../reference/apis/js-apis-bundleManager.md#extensionab
- [WorkSchedulerExtensionAbility](../reference/apis/js-apis-WorkSchedulerExtensionAbility.md): ExtensionAbility component of the work_scheduler type, which provides callbacks for Work Scheduler tasks. - [WorkSchedulerExtensionAbility](../reference/apis/js-apis-WorkSchedulerExtensionAbility.md): ExtensionAbility component of the work_scheduler type, which provides callbacks for Work Scheduler tasks.
- [InputMethodExtensionAbility](../reference/apis/js-apis-inputmethod.md): ExtensionAbility component of the input_method type, which provides an input method framework that can be used to hide the keyboard, obtain the list of installed input methods, display the dialog box for input method selection, and more. - [InputMethodExtensionAbility](../reference/apis/js-apis-inputmethod.md): ExtensionAbility component of the input_method type, which is used to develop input method applications.
- [ServiceExtensionAbility](../reference/apis/js-apis-app-ability-serviceExtensionAbility.md): ExtensionAbility component of the service type, which provides APIs related to background service scenarios. - [ServiceExtensionAbility](../reference/apis/js-apis-app-ability-serviceExtensionAbility.md): ExtensionAbility component of the service type, which provides APIs related to background service scenarios.
- [AccessibilityExtensionAbility](../reference/apis/js-apis-application-accessibilityExtensionAbility.md): ExtensionAbility component of the accessibility type, which provides APIs related to the accessibility feature. - [AccessibilityExtensionAbility](../reference/apis/js-apis-application-accessibilityExtensionAbility.md): ExtensionAbility component of the accessibility type, which provides APIs related to the accessibility feature.
- [DataShareExtensionAbility](../reference/apis/js-apis-application-dataShareExtensionAbility.md): ExtensionAbility component of the data_share type, which provides APIs for data sharing. - [DataShareExtensionAbility (for system applications only)](../reference/apis/js-apis-application-dataShareExtensionAbility.md): ExtensionAbility component of the data_share type, which provides APIs for data sharing.
- [StaticSubscriberExtensionAbility](../reference/apis/js-apis-application-staticSubscriberExtensionAbility.md): ExtensionAbility component of the static_subscriber type, which provides APIs for static broadcast. - [StaticSubscriberExtensionAbility](../reference/apis/js-apis-application-staticSubscriberExtensionAbility.md): ExtensionAbility component of the static_subscriber type, which provides APIs for static broadcast.
- [WindowExtensionAbility](../reference/apis/js-apis-application-windowExtensionAbility.md): ExtensionAbility component of the window type, which allows a system application to be embedded in and displayed over another application. - [WindowExtensionAbility (for system applications only)](../reference/apis/js-apis-application-windowExtensionAbility.md): ExtensionAbility component of the window type, which allows a system application to be embedded in and displayed over another application.
- [EnterpriseAdminExtensionAbility](../reference/apis/js-apis-EnterpriseAdminExtensionAbility.md): ExtensionAbility component of the enterprise_admin type, which provides APIs for processing enterprise management events, such as application installation events on devices and events indicating too many incorrect screen-lock password attempts. - [EnterpriseAdminExtensionAbility](../reference/apis/js-apis-EnterpriseAdminExtensionAbility.md): ExtensionAbility component of the enterprise_admin type, which provides APIs for processing enterprise management events, such as application installation events on devices and events indicating too many incorrect screen-lock password attempts.
...@@ -64,5 +64,3 @@ You do not need to care when to add or delete a widget. The lifecycle of the For ...@@ -64,5 +64,3 @@ You do not need to care when to add or delete a widget. The lifecycle of the For
> - The two FormExtensionAbility components run in an independent process. > - The two FormExtensionAbility components run in an independent process.
> >
> - The two ImeExtensionAbility components run in an independent process. > - The two ImeExtensionAbility components run in an independent process.
<!--no_check-->
\ No newline at end of file
en/application-dev/application-models/fa-model-development-overview.md
浏览文件 @ f7d7c3d4
...@@ -8,8 +8,8 @@ During application development based on the Feature Ability (FA) model, the foll ...@@ -8,8 +8,8 @@ During application development based on the Feature Ability (FA) model, the foll
| Task| Introduction| Guide| | Task| Introduction| Guide|
| -------- | -------- | -------- | | -------- | -------- | -------- |
| Application component development| Use the PageAbility, ServiceAbility, DataAbility, and widgets of the FA model to develop applications.| - [Application- or Component-Level Configuration](application-component-configuration-fa.md)<br>- [PageAbility Component](pageability-overview.md)<br>- [ServiceAbility Component](serviceability-overview.md)<br>- [DataAbility Component](dataability-overview.md)<br>- [Widget Development](Widget-development-fa.md)<br>- [Context](application-context-fa.md)<br>- [Want](want-fa.md) | | Application component development| Use the PageAbility, ServiceAbility, DataAbility, and widgets of the FA model to develop applications.| - [Application- or Component-Level Configuration](application-component-configuration-fa.md)<br>- [PageAbility Component](pageability-overview.md)<br>- [ServiceAbility Component](serviceability-overview.md)<br>- [DataAbility Component](dataability-overview.md)<br>- [Widget Development](widget-development-fa.md)<br>- [Context](application-context-fa.md)<br>- [Want](want-fa.md)|
| Inter-process communication (IPC)| Learn the process model and common IPC modes of the FA model.| [Common Events](common-event-fa.md)<br>[Background Services](rpc.md) | | Process model| Learn the process model and common IPC modes of the FA model.| [Common Events](common-event-fa.md)<br>[Background Services](rpc.md)|
| Inter-thread communication| Learn the thread model and common inter-thread communication modes of the FA model.| [Inter-Thread Communication](itc-fa-overview.md)| | Thread model| Learn the thread model and common inter-thread communication modes of the FA model.| [Inter-Thread Communication](itc-fa-overview.md)|
| Mission management| Learn the basic concepts and typical scenarios of mission management in the FA model.| [Mission Management](mission-management-fa.md)| | Mission management| Learn the basic concepts and typical scenarios of mission management in the FA model.| [Mission Management](mission-management-fa.md)|
| Application configuration file| Learn the requirements for developing application configuration files in the FA model.| [Application Configuration File](config-file-fa.md) | | Application configuration file| Learn the requirements for developing application configuration files in the FA model.| [Application Configuration File](config-file-fa.md)|
en/application-dev/application-models/hop-cross-device-migration.md
浏览文件 @ f7d7c3d4
...@@ -60,10 +60,10 @@ The table below describes the main APIs used for cross-device migration. For det ...@@ -60,10 +60,10 @@ The table below describes the main APIs used for cross-device migration. For det
```json ```json
{ {
"module": { "module": {
// ... ...
"abilities": [ "abilities": [
{ {
// ... ...
"continuable": true, "continuable": true,
} }
] ]
......
en/application-dev/application-models/hop-multi-device-collaboration.md
浏览文件 @ f7d7c3d4
...@@ -63,7 +63,7 @@ On device A, touch the **Start** button provided by the initiator application to ...@@ -63,7 +63,7 @@ On device A, touch the **Start** button provided by the initiator application to
// createDeviceManager is a system API. // createDeviceManager is a system API.
deviceManager.createDeviceManager('ohos.samples.demo', (err, dm) => { deviceManager.createDeviceManager('ohos.samples.demo', (err, dm) => {
if (err) { if (err) {
// ... ...
return return
} }
dmClass = dm dmClass = dm
...@@ -94,13 +94,13 @@ On device A, touch the **Start** button provided by the initiator application to ...@@ -94,13 +94,13 @@ On device A, touch the **Start** button provided by the initiator application to
} }
// context is the AbilityContext of the initiator UIAbility. // context is the AbilityContext of the initiator UIAbility.
this.context.startAbility(want).then(() => { this.context.startAbility(want).then(() => {
// ... ...
}).catch((err) => { }).catch((err) => {
// ... ...
}) })
``` ```
5. Call stopServiceExtensionAbility(../reference/apis/js-apis-inner-application-uiAbilityContext.md#uiabilitycontextstopserviceextensionability) to stop the ServiceExtensionAbility when it is no longer required on device B. (This API cannot be used to stop a UIAbility. Users must manually stop a UIAbility through task management.) 5. Call [stopServiceExtensionAbility](../reference/apis/js-apis-inner-application-uiAbilityContext.md#uiabilitycontextstopserviceextensionability) to stop the ServiceExtensionAbility when it is no longer required on device B. (This API cannot be used to stop a UIAbility. Users must manually stop a UIAbility through task management.)
```ts ```ts
let want = { let want = {
...@@ -150,9 +150,9 @@ On device A, touch the **Start** button provided by the initiator application to ...@@ -150,9 +150,9 @@ On device A, touch the **Start** button provided by the initiator application to
} }
// context is the AbilityContext of the initiator UIAbility. // context is the AbilityContext of the initiator UIAbility.
this.context.startAbilityForResult(want).then((data) => { this.context.startAbilityForResult(want).then((data) => {
// ... ...
}).catch((err) => { }).catch((err) => {
// ... ...
}) })
``` ```
...@@ -170,7 +170,7 @@ On device A, touch the **Start** button provided by the initiator application to ...@@ -170,7 +170,7 @@ On device A, touch the **Start** button provided by the initiator application to
} }
// context is the AbilityContext of the target UIAbility. // context is the AbilityContext of the target UIAbility.
this.context.terminateSelfWithResult(abilityResult, (err) => { this.context.terminateSelfWithResult(abilityResult, (err) => {
// ... ...
}); });
``` ```
...@@ -179,17 +179,17 @@ On device A, touch the **Start** button provided by the initiator application to ...@@ -179,17 +179,17 @@ On device A, touch the **Start** button provided by the initiator application to
```ts ```ts
const RESULT_CODE: number = 1001; const RESULT_CODE: number = 1001;
// ... ...
// context is the UIAbilityContext of the initiator UIAbility. // context is the UIAbilityContext of the initiator UIAbility.
this.context.startAbilityForResult(want).then((data) => { this.context.startAbilityForResult(want).then((data) => {
if (data?.resultCode === RESULT_CODE) { if (data?.resultCode === RESULT_CODE) {
// Parse the information returned by the target UIAbility. // Parse the information returned by the target UIAbility.
let info = data.want?.parameters?.info let info = data.want?.parameters?.info
// ... ...
} }
}).catch((err) => { }).catch((err) => {
// ... ...
}) })
``` ```
...@@ -444,10 +444,10 @@ The following describes how to implement multi-device collaboration through cros ...@@ -444,10 +444,10 @@ The following describes how to implement multi-device collaboration through cros
// Register the onRemoteStateChange listener of the CallerAbility. // Register the onRemoteStateChange listener of the CallerAbility.
try { try {
caller.onRemoteStateChange((str) => { caller.onRemoteStateChange((str) => {
console.log('Remote state changed ' + str); console.info('Remote state changed ' + str);
}); });
} catch (error) { } catch (error) {
console.log('Caller.onRemoteStateChange catch error, error.code: ${JSON.stringify(error.code)}, error.message: ${JSON.stringify(error.message)}'); console.info('Caller.onRemoteStateChange catch error, error.code: ${JSON.stringify(error.code)}, error.message: ${JSON.stringify(error.message)}');
} }
} }
}).catch((error) => { }).catch((error) => {
......
en/application-dev/application-models/inputmethodextentionability.md
浏览文件 @ f7d7c3d4
# InputMethodExtensionAbility Development # InputMethodExtensionAbility Development
[InputMethodExtensionAbility](../reference/apis/js-apis-inputmethod-extension-ability.md) is an ExtensionAbility component of the inputMethod type that provides extension capabilities for the input method framework. ## When to Use
[InputMethodExtensionAbility](../reference/apis/js-apis-inputmethod-extension-ability.md), inherited from [ExtensionAbility](extensionability-overview.md), is used for developing input method applications.
InputMethodExtensionAbility can be started or connected by other application components to process transactions in the background based on the request of the caller. The entire lifecycle of the [InputMethodExtensionAbility](../reference/apis/js-apis-inputmethod-extension-ability.md) instance and the owning ExtensionAbility process is scheduled and managed by the input method framework. The input method framework provides the [InputMethodExtensionAbility](../reference/apis/js-apis-inputmethod-extension-ability.md) base class. Derive this base class to implement initialization and resource clearing.
[InputMethodExtensionAbility](../reference/apis/js-apis-inputmethod-extension-ability.md) provides related capabilities through [InputMethodExtensionContext](../reference/apis/js-apis-inputmethod-extension-context.md).
InputMethodExtensionAbility provides related capabilities through the [InputMethodExtensionContext](../reference/apis/js-apis-inputmethod-extension-context.md).
## Implementing an Input Method Application ## Implementing an Input Method Application
...@@ -13,7 +13,6 @@ InputMethodExtensionAbility provides related capabilities through the [InputMeth ...@@ -13,7 +13,6 @@ InputMethodExtensionAbility provides related capabilities through the [InputMeth
InputMethodExtensionAbility provides the **onCreate()** and **onDestory()** callbacks, as described below. Override them as required. InputMethodExtensionAbility provides the **onCreate()** and **onDestory()** callbacks, as described below. Override them as required.
- **onCreate** - **onCreate**
This callback is triggered when a service is created for the first time. You can perform initialization operations, for example, registering a common event listener. This callback is triggered when a service is created for the first time. You can perform initialization operations, for example, registering a common event listener.
> **NOTE** > **NOTE**
...@@ -21,7 +20,6 @@ InputMethodExtensionAbility provides the **onCreate()** and **onDestory()** call ...@@ -21,7 +20,6 @@ InputMethodExtensionAbility provides the **onCreate()** and **onDestory()** call
> If a service has been created, starting it again does not trigger the **onCreate()** callback. > If a service has been created, starting it again does not trigger the **onCreate()** callback.
- **onDestroy** - **onDestroy**
This callback is triggered when the service is no longer used and the instance is ready for destruction. You can clear resources in this callback, for example, deregister the listener. This callback is triggered when the service is no longer used and the instance is ready for destruction. You can clear resources in this callback, for example, deregister the listener.
...@@ -29,7 +27,7 @@ InputMethodExtensionAbility provides the **onCreate()** and **onDestory()** call ...@@ -29,7 +27,7 @@ InputMethodExtensionAbility provides the **onCreate()** and **onDestory()** call
To implement an input method application, manually create an InputMethodExtensionAbility component in DevEco Studio. The procedure is as follows: To implement an input method application, manually create an InputMethodExtensionAbility component in DevEco Studio. The procedure is as follows:
In the **ets** directory of the target module, right-click and choose **New** > **Extention Ability** > **InputMethod** to a minimum template of InputMethodExtensionAbility. In the **ets** directory of the target module, right-click and choose **New** > **Extension Ability** > **InputMethod** to a minimum template of InputMethodExtensionAbility.
> **NOTE** > **NOTE**
> >
...@@ -70,7 +68,7 @@ The minimum template contains four files: **KeyboardController.ts**, **InputMeth ...@@ -70,7 +68,7 @@ The minimum template contains four files: **KeyboardController.ts**, **InputMeth
onDestroy() { onDestroy() {
console.log("onDestroy."); console.log("onDestroy.");
this.context.destroy(); this.keyboardController.onDestroy(); // Destroy the window and deregister the event listener.
} }
} }
``` ```
...@@ -109,7 +107,6 @@ The minimum template contains four files: **KeyboardController.ts**, **InputMeth ...@@ -109,7 +107,6 @@ The minimum template contains four files: **KeyboardController.ts**, **InputMeth
this.unRegisterListener(); // Deregister the event listener. this.unRegisterListener(); // Deregister the event listener.
let win = windowManager.findWindow(this.windowName); let win = windowManager.findWindow(this.windowName);
win.destroyWindow(); // Destroy the window. win.destroyWindow(); // Destroy the window.
this.mContext.terminateSelf(); // Terminate the InputMethodExtensionAbility service.
} }
private initWindow(): void // Initialize the window. private initWindow(): void // Initialize the window.
...@@ -159,7 +156,7 @@ The minimum template contains four files: **KeyboardController.ts**, **InputMeth ...@@ -159,7 +156,7 @@ The minimum template contains four files: **KeyboardController.ts**, **InputMeth
}) })
globalThis.inputAbility.on('inputStop', (imeId) => { globalThis.inputAbility.on('inputStop', (imeId) => {
if (imeId == "Bundle name/Ability name") { if (imeId == "Bundle name/Ability name") {
this.onDestroy(); this.mContext.destroy(); // Destroy the InputMethodExtensionAbility service.
} }
}); });
} }
...@@ -233,7 +230,7 @@ The minimum template contains four files: **KeyboardController.ts**, **InputMeth ...@@ -233,7 +230,7 @@ The minimum template contains four files: **KeyboardController.ts**, **InputMeth
Add the path to this file to the **src** field in the **resources/base/profile/main_pages.json** file. Add the path to this file to the **src** field in the **resources/base/profile/main_pages.json** file.
```ts ```ets
import { numberSourceListData, sourceListType } from './keyboardKeyData' import { numberSourceListData, sourceListType } from './keyboardKeyData'
@Component @Component
...@@ -342,12 +339,12 @@ The minimum template contains four files: **KeyboardController.ts**, **InputMeth ...@@ -342,12 +339,12 @@ The minimum template contains four files: **KeyboardController.ts**, **InputMeth
} }
``` ```
Register the InputMethodExtensionAbility in the [module.json5 file](../quick-start/module-configuration-file.md) corresponding to the target module. Set **type** to **"inputMethod"** and **srcEntry** to the code path of the InputMethodExtensionAbility component. 5. Register the InputMethodExtensionAbility in the [module.json5 file](../quick-start/module-configuration-file.md) corresponding to the **Module** project. Set **type** to **"inputMethod"** and **srcEntry** to the code path of the InputMethodExtensionAbility component.
```ts ```ts
{ {
"module": { "module": {
// ... ...
"extensionAbilities": [ "extensionAbilities": [
{ {
"description": "inputMethod", "description": "inputMethod",
...@@ -364,3 +361,47 @@ The minimum template contains four files: **KeyboardController.ts**, **InputMeth ...@@ -364,3 +361,47 @@ The minimum template contains four files: **KeyboardController.ts**, **InputMeth
## Restrictions
To reduce the risk of abuse of the InputMethodExtensionAbility by third-party applications, the invoking of APIs in the following modules is restricted in the InputMethodExtensionAbility:
> **NOTE**
>
> - If a restricted module is imported, no error is reported during compilation, but an incorrect value (**undefined**) is returned during running. As a result, the module does not take effect.
> - Currently, access to the [@ohos.multimedia.audio (Audio Management)](../reference/apis/js-apis-audio.md) module is allowed, with compliance with the following rules:
> - Users who deny the recording permission should still be allowed to use the non-voice-input features of the input method application.
> - Recording-related services are allowed only when the InputMethodExtensionAbility is in the foreground. For example, perform recording only when the soft keyboard is in the foreground and the user is proactively using the voice input method; stop recording when the application is switched to the background.
> - Applications will see increasingly stringent measures against violations with the preceding rules, and any violation may result in function exceptions.
**Restricted modules:**
- [@ohos.ability.featureAbility (FeatureAbility)](../reference/apis/js-apis-ability-featureAbility.md)
- [@ohos.ability.particleAbility (ParticleAbility)](../reference/apis/js-apis-ability-particleAbility.md)
- [@ohos.account.distributedAccount (Distributed Account Management)](../reference/apis/js-apis-distributed-account.md)
- [@ohos.backgroundTaskManager (Background Task Management)](../reference/apis/js-apis-backgroundTaskManager.md)
- [@ohos.bluetooth (Bluetooth)](../reference/apis/js-apis-bluetooth.md)
- [@ohos.bluetoothManager (Bluetooth)](../reference/apis/js-apis-bluetoothManager.md)
- [@ohos.connectedTag (Active Tags)](../reference/apis/js-apis-connectedTag.md)
- [@ohos.geolocation (Geolocation)](../reference/apis/js-apis-geolocation.md)
- [@ohos.geoLocationManager (Geolocation Manager)](../reference/apis/js-apis-geoLocationManager.md)
- [@ohos.nfc.cardEmulation (Standard NFC Card Emulation)](../reference/apis/js-apis-cardEmulation.md)
- [@ohos.nfc.controller (Standard NFC)](../reference/apis/js-apis-nfcController.md)
- [@ohos.nfc.tag (Standard NFC Tags)](../reference/apis/js-apis-nfcTag.md)
- [@ohos.reminderAgent (Reminder Agent)](../reference/apis/js-apis-reminderAgent.md)
- [@ohos.reminderAgentManager (reminderAgentManager)](../reference/apis/js-apis-reminderAgentManager.md)
- [@ohos.sensor (Sensor)](../reference/apis/js-apis-sensor.md)
- [@ohos.telephony.call (Call)](../reference/apis/js-apis-call.md)
- [@ohos.telephony.data (Cellular Data)](../reference/apis/js-apis-telephony-data.md)
- [@ohos.telephony.observer (observer)](../reference/apis/js-apis-observer.md)
- [@ohos.telephony.radio (Network Search)](../reference/apis/js-apis-radio.md)
- [@ohos.telephony.sim (SIM Management)](../reference/apis/js-apis-sim.md)
- [@ohos.telephony.sms (SMS)](../reference/apis/js-apis-sms.md)
- [@ohos.wallpaper (Wallpaper)](../reference/apis/js-apis-wallpaper.md)
- [@ohos.wifiext (WLAN Extension)](../reference/apis/js-apis-wifiext.md)
- [@ohos.wifiManager (WLAN)](../reference/apis/js-apis-wifiManager.md)
- [@ohos.wifiManagerExt (WLAN Extension Interface)](../reference/apis/js-apis-wifiManagerExt.md)
- [@system.geolocation (Geolocation)](../reference/apis/js-apis-system-location.md)
- [nfctech (Standard NFC Technologies)](../reference/apis/js-apis-nfctech.md)
- [tagSession (Standard NFC Tag Session)](../reference/apis/js-apis-tagSession.md)
en/application-dev/application-models/itc-with-worker.md
浏览文件 @ f7d7c3d4
...@@ -49,7 +49,7 @@ To develop the Worker mode, perform the following steps: ...@@ -49,7 +49,7 @@ To develop the Worker mode, perform the following steps:
console.info("message from worker: " + message) console.info("message from worker: " + message)
// Stop the worker thread based on service requirements. // Stop the worker thread based on service requirements.
wk.terminate() wk.terminate();
} }
``` ```
...@@ -68,12 +68,11 @@ To develop the Worker mode, perform the following steps: ...@@ -68,12 +68,11 @@ To develop the Worker mode, perform the following steps:
console.info("message from worker: " + message) console.info("message from worker: " + message)
// Stop the worker thread based on service requirements. // Stop the worker thread based on service requirements.
wk.terminate() wk.terminate();
} }
``` ```
> **NOTE** > **NOTE**
> >
> - If the relative path of **worker.ts** configured in **build-profile.json5** is **./src/main/ets/workers/worker.ts**, pass in the path **entry/ets/workers/worker.ts** when creating a worker thread in the stage model, and pass in the path **../workers/worker.ts** when creating a worker thread in the FA model. > - If the relative path of **worker.ts** configured in **build-profile.json5** is **./src/main/ets/workers/worker.ts**, pass in the path **entry/ets/workers/worker.ts** when creating a worker thread in the stage model, and pass in the path **../workers/worker.ts** when creating a worker thread in the FA model.
>
> - For details about the data types supported between the main thread and worker thread, see [Sequenceable Data Types](../reference/apis/js-apis-worker.md#sequenceable-data-types). > - For details about the data types supported between the main thread and worker thread, see [Sequenceable Data Types](../reference/apis/js-apis-worker.md#sequenceable-data-types).
en/application-dev/application-models/mission-set-icon-name-for-task-snapshot.md
浏览文件 @ f7d7c3d4
...@@ -21,8 +21,10 @@ Call [UIAbilityContext.setMissionIcon()](../reference/apis/js-apis-inner-applica ...@@ -21,8 +21,10 @@ Call [UIAbilityContext.setMissionIcon()](../reference/apis/js-apis-inner-applica
```ts ```ts
let imagePixelMap: PixelMap = undefined; // Obtain the PixelMap information. let imagePixelMap: PixelMap = undefined; // Obtain the PixelMap information.
this.context.setMissionIcon(imagePixelMap, (err) => { context.setMissionIcon(imagePixelMap, (err) => {
console.error(`setMissionLabel failed, code is ${err.code}, message is ${err.message}`); if (err.code) {
console.error(`Failed to set mission icon. Code is ${err.code}, message is ${err.message}`);
}
}) })
``` ```
...@@ -38,9 +40,9 @@ Call [UIAbilityContext.setMissionLabel()](../reference/apis/js-apis-inner-applic ...@@ -38,9 +40,9 @@ Call [UIAbilityContext.setMissionLabel()](../reference/apis/js-apis-inner-applic
```ts ```ts
this.context.setMissionLabel('test').then(() => { this.context.setMissionLabel('test').then(() => {
console.info('setMissionLabel succeeded.'); console.info('Succeeded in seting mission label.');
}).catch((err) => { }).catch((err) => {
console.error(`setMissionLabel failed, code is ${err.code}, message is ${err.message}`); console.error(`Failed to set mission label. Code is ${err.code}, message is ${err.message}`);
}); });
``` ```
......
en/application-dev/application-models/module-switch.md
浏览文件 @ f7d7c3d4
...@@ -3,7 +3,7 @@ ...@@ -3,7 +3,7 @@
When switching an application from the FA model to the stage model, you must migrate the configurations under the **module** tag in the **config.json** file to the **module** tag in the **module.json5** file. When switching an application from the FA model to the stage model, you must migrate the configurations under the **module** tag in the **config.json** file to the **module** tag in the **module.json5** file.
### Table 1 module Comparison **Table 1** module comparison
| Field Name in the FA Model| Field Description| Field Name in the Stage Model| Difference| | Field Name in the FA Model| Field Description| Field Name in the Stage Model| Difference|
| -------- | -------- | -------- | -------- | | -------- | -------- | -------- | -------- |
...@@ -15,8 +15,8 @@ When switching an application from the FA model to the stage model, you must mig ...@@ -15,8 +15,8 @@ When switching an application from the FA model to the stage model, you must mig
| moduleType in the distro object| Type of the HAP file. The value can be **entry** or **feature**. For the HAR type, set this field to **har**.| type | The field name is changed.| | moduleType in the distro object| Type of the HAP file. The value can be **entry** or **feature**. For the HAR type, set this field to **har**.| type | The field name is changed.|
| installationFree in the distro object| Whether the HAP file supports the installation-free feature.| installationFree | The field name is changed.| | installationFree in the distro object| Whether the HAP file supports the installation-free feature.| installationFree | The field name is changed.|
| deliveryWithInstall in the distro object| Whether the HAP file is installed with the application.| deliveryWithInstall | The field name is changed.| | deliveryWithInstall in the distro object| Whether the HAP file is installed with the application.| deliveryWithInstall | The field name is changed.|
| metaData | Metadata of the HAP file.| metadata | See [Table 2](#table-2-metadata-comparison).| | metaData | Metadata of the HAP file.| metadata | For details, see Table 2.|
| abilities | All abilities in the current module.| abilities | See [Table 5](#table-5-abilities-comparison).| | abilities | All abilities in the current module.| abilities | For details, see Table 5.|
| js | A set of JS modules developed using ArkUI. Each element in the set represents the information about a JS module.| pages | The stage model retains **pages** under the **module** tag. The window configuration is the lower level of **pages**.| | js | A set of JS modules developed using ArkUI. Each element in the set represents the information about a JS module.| pages | The stage model retains **pages** under the **module** tag. The window configuration is the lower level of **pages**.|
| shortcuts | Shortcuts of the application.| shortcut_config.json| In the stage model, the **shortcut_config.json** file is defined in **resources/base/profile** in the development view.| | shortcuts | Shortcuts of the application.| shortcut_config.json| In the stage model, the **shortcut_config.json** file is defined in **resources/base/profile** in the development view.|
| reqPermissions | Permissions that the application requests from the system when it is running.| requestPermissions | The field name is changed.| | reqPermissions | Permissions that the application requests from the system when it is running.| requestPermissions | The field name is changed.|
...@@ -27,38 +27,38 @@ When switching an application from the FA model to the stage model, you must mig ...@@ -27,38 +27,38 @@ When switching an application from the FA model to the stage model, you must mig
| entryTheme | Keyword of an OpenHarmony internal theme.| / | This configuration is not supported in the stage model.| | entryTheme | Keyword of an OpenHarmony internal theme.| / | This configuration is not supported in the stage model.|
### Table 2 metaData Comparison **Table 2** metaData comparison
| Field Name Under metaData in the FA Model| Field Description| Field Name Under metaData in the Stage Model| Difference| | Field Name in the FA Model| Field Description| Field Name in the Stage Model| Difference|
| -------- | -------- | -------- | -------- | | -------- | -------- | -------- | -------- |
| parameters | Metadata of the parameters to be passed for calling the ability.| / | This configuration is not supported in the stage model.| | parameters | Metadata of the parameters to be passed for calling the ability.| / | This configuration is not supported in the stage model.|
| results | Metadata of the ability return value.| / | This configuration is not supported in the stage model.| | results | Metadata of the ability return value.| / | This configuration is not supported in the stage model.|
| customizeData | Custom metadata of the parent component. **parameters** and **results** cannot be configured in **application**.| metadata | See [Table 3](#table-3-comparison-between-customizedata-under-metadata-in-the-fa-model-and-metadata-in-the-stage-model).| | customizeData | Custom metadata of the parent component. **parameters** and **results** cannot be configured in **application**.| metadata | **For details**, see Table 3.|
### Table 3 Comparison Between customizeData Under metaData in the FA Model and metadata in the Stage Model **Table 3** Comparison between customizeData under metaData in the FA model and metadata in the stage Model
| Field Name Under customizeData in metaData in the FA Model| Field Description| Field Name Under metaData in the Stage Model| Difference| | Field Name in the FA Model| Field Description| Field Name in the Stage Model| Difference|
| -------- | -------- | -------- | -------- | | -------- | -------- | -------- | -------- |
| name | Key name that identifies a data item. The value is a string with a maximum of 255 bytes.| name | None.| | name | Key name that identifies a data item. The value is a string with a maximum of 255 bytes.| name | None.|
| value | Value of the data item. The value is a string with a maximum of 255 bytes.| value | None.| | value | Value of the data item. The value is a string with a maximum of 255 bytes.| value | None.|
| extra | Format of the current custom data. The value is the resource value of **extra**.| resource | The field name is changed. For details, see [Table 4](#table 4-metadata-examples).| | extra | Format of the current custom data. The value is the resource value of **extra**.| resource | The field name is changed. For details, see Table 4.|
### Table 4 metaData Examples **Table 4** metaData examples
| Example in the FA Model| Example in the Stage Model| | Example in the FA Model| Example in the Stage Model|
| -------- | -------- | | -------- | -------- |
| "meteData": {<br> "customizeDate": [{<br> "name": "label",<br> "value": "string",<br> "extra": "$string:label",<br> }]<br>} | "meteData": [{<br> "name": "label",<br> "value": "string",<br> "resource": "$string:label",<br>}] | | "meteData": {<br> "customizeDate": [{<br> "name": "label",<br> "value": "string",<br> "extra": "$string:label",<br> }]<br>} | "meteData": [{<br> "name": "label",<br> "value": "string",<br> "resource": "$string:label",<br>}] |
### Table 5 abilities Comparison **Table 5** abilities comparison
| Field Name Under abilities in the FA Model| Field Description| Field Name Under abilities in the Stage Model| Difference| | Field Name Under abilities in the FA Model| Field Description| Field Name Under abilities in the Stage Model| Difference|
| -------- | -------- | -------- | -------- | | -------- | -------- | -------- | -------- |
| process | Name of the process running the application or ability.| / | The stage model does not support configuration of **process** under **abilities**. The configuration of **process** is available under the **module** tag.| | process | Name of the process running the application or ability.| / | The stage model does not support configuration of **process** under **abilities**. The configuration of **process** is available under the **module** tag.|
| uri | URI of the ability.| / | This configuration is not supported in the stage model.| | uri | URI of the ability.| / | This configuration is not supported in the stage model.|
| deviceCapability | Device capabilities required to run the ability.| / | This configuration is not supported in the stage model.| | deviceCapability | Device capabilities required to run the ability.| / | This configuration is not supported in the stage model.|
| metaData | Metadata of the ability.| metadata | See [Table 2](#table-2-metadata-comparison).| | metaData | Metadata of the ability.| metadata | For details, see Table 2.|
| type | Ability type.| / | This configuration is not supported in the stage model.| | type | Ability type.| / | This configuration is not supported in the stage model.|
| grantPermission | Whether permissions can be granted for any data in the ability.| / | The stage model does not support such a configuration under **abilities**.| | grantPermission | Whether permissions can be granted for any data in the ability.| / | The stage model does not support such a configuration under **abilities**.|
| readPermission | Permission required for reading data in the ability. This field applies only to the ability using the Data template.| / | In the stage model, this configuration is available under **extensionAbilities**, but not **abilities**.| | readPermission | Permission required for reading data in the ability. This field applies only to the ability using the Data template.| / | In the stage model, this configuration is available under **extensionAbilities**, but not **abilities**.|
......
en/application-dev/application-models/page-mission-stack.md
浏览文件 @ f7d7c3d4
...@@ -5,7 +5,8 @@ ...@@ -5,7 +5,8 @@
A single UIAbility component can implement multiple pages and redirection between these pages. The redirection relationship inside the UIAbility component is called page stack, which is managed by the ArkUI framework. For example, Page1 -&gt; Page2 -&gt; Page3 of UIAbility1 and PageA -&gt; PageB -&gt; PageC of UIAbility2 in the figure below are two page stacks. A single UIAbility component can implement multiple pages and redirection between these pages. The redirection relationship inside the UIAbility component is called page stack, which is managed by the ArkUI framework. For example, Page1 -&gt; Page2 -&gt; Page3 of UIAbility1 and PageA -&gt; PageB -&gt; PageC of UIAbility2 in the figure below are two page stacks.
**Figure 1** Page stack **Figure 1** Page stack
![mission-record](figures/mission-record.png) ![mission-record](figures/mission-record.png)
- A page stack is formed as follows (Steps 2, 3, 5, and 6 are page redirection and managed by ArkUI): - A page stack is formed as follows (Steps 2, 3, 5, and 6 are page redirection and managed by ArkUI):
......
en/application-dev/application-models/pageability-launch-type.md
浏览文件 @ f7d7c3d4
...@@ -5,7 +5,7 @@ Depending on the launch type, the action performed when the PageAbility starts d ...@@ -5,7 +5,7 @@ Depending on the launch type, the action performed when the PageAbility starts d
**Table 1** PageAbility launch types **Table 1** PageAbility launch types
| Launch Type| Meaning | Description| | Launch Type| Meaning| Description |
| -------- | -------- | -------- | | -------- | -------- | -------- |
| singleton | Singleton mode| Each time **startAbility()** is called, if an ability instance of this type already exists in the application process, the instance is reused. There is only one ability instance of this type in **Recents**.<br>A typical scenario is as follows: When a user opens a video playback application and watches a video, returns to the home screen, and opens the video playback application again, the video that the user watched before returning to the home screen is still played.| | singleton | Singleton mode| Each time **startAbility()** is called, if an ability instance of this type already exists in the application process, the instance is reused. There is only one ability instance of this type in **Recents**.<br>A typical scenario is as follows: When a user opens a video playback application and watches a video, returns to the home screen, and opens the video playback application again, the video that the user watched before returning to the home screen is still played.|
| standard | Multiton mode| Default type. Each time **startAbility()** is called, a new ability instance is created in the application process. Multiple ability instances of this type are displayed in **Recents**.<br>A typical scenario is as follows: When a user opens a document application and touches **New**, a new document task is created. Multiple new document missions are displayed in **Recents**.| | standard | Multiton mode| Default type. Each time **startAbility()** is called, a new ability instance is created in the application process. Multiple ability instances of this type are displayed in **Recents**.<br>A typical scenario is as follows: When a user opens a document application and touches **New**, a new document task is created. Multiple new document missions are displayed in **Recents**.|
...@@ -16,13 +16,13 @@ You can set **launchType** in the **config.json** file to configure the launch t ...@@ -16,13 +16,13 @@ You can set **launchType** in the **config.json** file to configure the launch t
```json ```json
{ {
"module": { "module": {
// ... ...
"abilities": [ "abilities": [
{ {
// singleton means the singleton mode. // singleton means the singleton mode.
// standard means the multiton mode. // standard means the multiton mode.
"launchType": "standard", "launchType": "standard",
// ... ...
} }
] ]
} }
......
en/application-dev/application-models/redirection-rules.md
浏览文件 @ f7d7c3d4
...@@ -21,11 +21,11 @@ To enable an ability to be called by any application, configure the **config.jso ...@@ -21,11 +21,11 @@ To enable an ability to be called by any application, configure the **config.jso
```ts ```ts
{ {
"module": { "module": {
// ... ...
"abilities": [ "abilities": [
{ {
"visible": "true", "visible": "true",
// ... ...
} }
] ]
} }
......
en/application-dev/application-models/service-widget-overview.md
浏览文件 @ f7d7c3d4
...@@ -6,7 +6,7 @@ A service widget (also called widget) is a set of UI components that display imp ...@@ -6,7 +6,7 @@ A service widget (also called widget) is a set of UI components that display imp
## Service Widget Architecture ## Service Widget Architecture
**Figure 1** Service widget architecture **Figure 1** Service widget architecture
![WidgetArchitecture](figures/WidgetArchitecture.png) ![WidgetArchitecture](figures/WidgetArchitecture.png)
...@@ -24,7 +24,7 @@ Before you get started, it would be helpful if you have a basic understanding of ...@@ -24,7 +24,7 @@ Before you get started, it would be helpful if you have a basic understanding of
Below is the typical procedure of using the widget: Below is the typical procedure of using the widget:
**Figure 2** Typical procedure of using the widget **Figure 2** Typical procedure of using the widget
![WidgetUse](figures/WidgetUse.png) ![WidgetUse](figures/WidgetUse.png)
...@@ -55,4 +55,4 @@ ArkTS widgets and JS widgets have different implementation principles and featur ...@@ -55,4 +55,4 @@ ArkTS widgets and JS widgets have different implementation principles and featur
| Custom drawing| Not supported| Supported| | Custom drawing| Not supported| Supported|
| Logic code execution (excluding the import capability)| Not supported| Supported| | Logic code execution (excluding the import capability)| Not supported| Supported|
As can be seen above, ArkTS widgets have more capabilities and use cases than JS widgets. Therefore, ArkTS widgets are always recommended, except for the case where the widget consists of only static pages. As can be seen above, ArkTS widgets provide more capabilities and use cases than JS widgets. Therefore, ArkTS widgets are always recommended, except for the case where the widget consists of only static pages.
en/application-dev/application-models/serviceextensionability.md
浏览文件 @ f7d7c3d4
...@@ -29,6 +29,7 @@ Note the following: ...@@ -29,6 +29,7 @@ Note the following:
[ServiceExtensionAbility](../reference/apis/js-apis-app-ability-serviceExtensionAbility.md) provides the callbacks **onCreate()**, **onRequest()**, **onConnect()**, **onDisconnect()**, and **onDestory()**. Override them as required. The following figure shows the lifecycle of ServiceExtensionAbility. [ServiceExtensionAbility](../reference/apis/js-apis-app-ability-serviceExtensionAbility.md) provides the callbacks **onCreate()**, **onRequest()**, **onConnect()**, **onDisconnect()**, and **onDestory()**. Override them as required. The following figure shows the lifecycle of ServiceExtensionAbility.
**Figure 1** ServiceExtensionAbility lifecycle **Figure 1** ServiceExtensionAbility lifecycle
![ServiceExtensionAbility-lifecycle](figures/ServiceExtensionAbility-lifecycle.png) ![ServiceExtensionAbility-lifecycle](figures/ServiceExtensionAbility-lifecycle.png)
- **onCreate** - **onCreate**
...@@ -61,7 +62,7 @@ Note the following: ...@@ -61,7 +62,7 @@ Note the following:
Only system applications can implement ServiceExtensionAbility. You must make the following preparations before development: Only system applications can implement ServiceExtensionAbility. You must make the following preparations before development:
- **Switching to the full SDK**: All APIs related to ServiceExtensionAbility are marked as system APIs and hidden by default. Therefore, you must manually obtain the full SDK from the mirror and switch to it in DevEco Studio. For details, see [Guide to Switching to Full SDK](../quick-start/full-sdk-switch-guide.md). - **Switching to the full SDK**: All APIs related to ServiceExtensionAbility are marked as system APIs and hidden by default. Therefore, you must manually obtain the full SDK from the mirror and switch to it in DevEco Studio. For details, see [Guide to Switching to Full SDK](../faqs/full-sdk-switch-guide.md).
- **Requesting the AllowAppUsePrivilegeExtension privilege**: Only applications with the **AllowAppUsePrivilegeExtension** privilege can develop ServiceExtensionAbility. For details about how to request the privilege, see [Application Privilege Configuration Guide](../../device-dev/subsystems/subsys-app-privilege-config-guide.md). - **Requesting the AllowAppUsePrivilegeExtension privilege**: Only applications with the **AllowAppUsePrivilegeExtension** privilege can develop ServiceExtensionAbility. For details about how to request the privilege, see [Application Privilege Configuration Guide](../../device-dev/subsystems/subsys-app-privilege-config-guide.md).
...@@ -109,7 +110,7 @@ export default class ServiceExtImpl extends IdlServiceExtStub { ...@@ -109,7 +110,7 @@ export default class ServiceExtImpl extends IdlServiceExtStub {
insertDataToMap(key: string, val: number, callback: insertDataToMapCallback): void { insertDataToMap(key: string, val: number, callback: insertDataToMapCallback): void {
// Implement service logic. // Implement service logic.
console.log(TAG, `insertDataToMap, key: ${key} val: ${val}`); console.info(TAG, `insertDataToMap, key: ${key} val: ${val}`);
callback(ERR_OK); callback(ERR_OK);
} }
} }
...@@ -175,7 +176,7 @@ To manually create a ServiceExtensionAbility in the DevEco Studio project, perfo ...@@ -175,7 +176,7 @@ To manually create a ServiceExtensionAbility in the DevEco Studio project, perfo
```json ```json
{ {
"module": { "module": {
// ... ...
"extensionAbilities": [ "extensionAbilities": [
{ {
"name": "ServiceExtAbility", "name": "ServiceExtAbility",
...@@ -201,41 +202,43 @@ A system application uses the [startServiceExtensionAbility()](../reference/apis ...@@ -201,41 +202,43 @@ A system application uses the [startServiceExtensionAbility()](../reference/apis
1. Start a new ServiceExtensionAbility in a system application. For details about how to obtain the context, see [Obtaining the Context of UIAbility](uiability-usage.md#obtaining-the-context-of-uiability). 1. Start a new ServiceExtensionAbility in a system application. For details about how to obtain the context, see [Obtaining the Context of UIAbility](uiability-usage.md#obtaining-the-context-of-uiability).
```ts ```ts
let context = ...; // UIAbilityContext
let want = { let want = {
"deviceId": "", "deviceId": "",
"bundleName": "com.example.myapplication", "bundleName": "com.example.myapplication",
"abilityName": "ServiceExtAbility" "abilityName": "ServiceExtAbility"
}; };
this.context.startServiceExtensionAbility(want).then(() => { context.startServiceExtensionAbility(want).then(() => {
console.info('startServiceExtensionAbility success'); console.info('Succeeded in starting ServiceExtensionAbility.');
}).catch((error) => { }).catch((err) => {
console.info('startServiceExtensionAbility failed'); console.error(`Failed to start ServiceExtensionAbility. Code is ${err.code}, message is ${err.message}`);
}) })
``` ```
2. Stop ServiceExtensionAbility in the system application. 2. Stop ServiceExtensionAbility in the system application.
```ts ```ts
let context = ...; // UIAbilityContext
let want = { let want = {
"deviceId": "", "deviceId": "",
"bundleName": "com.example.myapplication", "bundleName": "com.example.myapplication",
"abilityName": "ServiceExtAbility" "abilityName": "ServiceExtAbility"
}; };
this.context.stopServiceExtensionAbility(want).then(() => { context.stopServiceExtensionAbility(want).then(() => {
console.info('stopServiceExtensionAbility success'); console.info('Succeeded in stoping ServiceExtensionAbility.');
}).catch((error) => { }).catch((err) => {
console.info('stopServiceExtensionAbility failed'); console.error(`Failed to stop ServiceExtensionAbility. Code is ${err.code}, message is ${err.message}`);
}) })
``` ```
3. ServiceExtensionAbility stops itself. 3. ServiceExtensionAbility stops itself.
```ts ```ts
// this is the current ServiceExtensionAbility component. let context = ...; // ServiceExtensionContext
this.context.terminateSelf().then(() => { context.terminateSelf().then(() => {
console.info('terminateSelf success'); console.info('Succeeded in terminating self.');
}).catch((error) => { }).catch((err) => {
console.info('terminateSelf failed'); console.error(`Failed to terminate self. Code is ${err.code}, message is ${err.message}`);
}) })
``` ```
...@@ -314,10 +317,10 @@ After obtaining the [rpc.RemoteObject](../reference/apis/js-apis-rpc.md#iremoteo ...@@ -314,10 +317,10 @@ After obtaining the [rpc.RemoteObject](../reference/apis/js-apis-rpc.md#iremoteo
let serviceExtProxy = new IdlServiceExtProxy(remote); let serviceExtProxy = new IdlServiceExtProxy(remote);
// Communication is carried out by interface calling, without exposing RPC details. // Communication is carried out by interface calling, without exposing RPC details.
serviceExtProxy.processData(1, (errorCode, retVal) => { serviceExtProxy.processData(1, (errorCode, retVal) => {
console.log(`processData, errorCode: ${errorCode}, retVal: ${retVal}`); console.info(`processData, errorCode: ${errorCode}, retVal: ${retVal}`);
}); });
serviceExtProxy.insertDataToMap('theKey', 1, (errorCode) => { serviceExtProxy.insertDataToMap('theKey', 1, (errorCode) => {
console.log(`insertDataToMap, errorCode: ${errorCode}`); console.info(`insertDataToMap, errorCode: ${errorCode}`);
}) })
}, },
onDisconnect(elementName) { onDisconnect(elementName) {
...@@ -381,8 +384,8 @@ When ServiceExtensionAbility is used to provide sensitive services, the client i ...@@ -381,8 +384,8 @@ When ServiceExtensionAbility is used to provide sensitive services, the client i
```ts ```ts
import rpc from '@ohos.rpc'; import rpc from '@ohos.rpc';
import bundleManager from '@ohos.bundle.bundleManager'; import bundleManager from '@ohos.bundle.bundleManager';
import {processDataCallback} from './i_idl_service_ext'; import { processDataCallback } from './i_idl_service_ext';
import {insertDataToMapCallback} from './i_idl_service_ext'; import { insertDataToMapCallback } from './i_idl_service_ext';
import IdlServiceExtStub from './idl_service_ext_stub'; import IdlServiceExtStub from './idl_service_ext_stub';
const ERR_OK = 0; const ERR_OK = 0;
...@@ -409,7 +412,7 @@ When ServiceExtensionAbility is used to provide sensitive services, the client i ...@@ -409,7 +412,7 @@ When ServiceExtensionAbility is used to provide sensitive services, the client i
insertDataToMap(key: string, val: number, callback: insertDataToMapCallback): void { insertDataToMap(key: string, val: number, callback: insertDataToMapCallback): void {
// Implement service logic. // Implement service logic.
console.log(TAG, `insertDataToMap, key: ${key} val: ${val}`); console.info(TAG, `insertDataToMap, key: ${key} val: ${val}`);
callback(ERR_OK); callback(ERR_OK);
} }
} }
...@@ -449,7 +452,7 @@ When ServiceExtensionAbility is used to provide sensitive services, the client i ...@@ -449,7 +452,7 @@ When ServiceExtensionAbility is used to provide sensitive services, the client i
insertDataToMap(key: string, val: number, callback: insertDataToMapCallback): void { insertDataToMap(key: string, val: number, callback: insertDataToMapCallback): void {
// Implement service logic. // Implement service logic.
console.log(TAG, `insertDataToMap, key: ${key} val: ${val}`); console.info(TAG, `insertDataToMap, key: ${key} val: ${val}`);
callback(ERR_OK); callback(ERR_OK);
} }
} }
......
en/application-dev/application-models/stage-model-development-overview.md
浏览文件 @ f7d7c3d4
...@@ -12,7 +12,7 @@ The following figure shows the basic concepts used in the stage model. ...@@ -12,7 +12,7 @@ The following figure shows the basic concepts used in the stage model.
The stage model provides two types of application components: UIAbility and ExtensionAbility. Both have specific classes and support object-oriented development. The stage model provides two types of application components: UIAbility and ExtensionAbility. Both have specific classes and support object-oriented development.
- UIAbility has the UI and is mainly used for user interaction. For example, with UIAbility, the Gallery application can display images in the liquid layout. After a user selects an image, it uses a new UI to display the image details. The user can touch the **Back** button to return to the liquid layout. The lifecycle of the UIAbility component contains the creation, destruction, foreground, and background states. Display-related states are exposed through WindowStage events. - UIAbility is a type of application component that provides the UI for user interaction. For example, with UIAbility, the Gallery application can display images in the liquid layout. After a user selects an image, it uses a new UI to display the image details. The user can touch the **Back** button to return to the liquid layout. The lifecycle of the UIAbility component contains the creation, destruction, foreground, and background states. Display-related states are exposed through WindowStage events.
- ExtensionAbility is oriented to specific scenarios. You cannot derive directly from ExtensionAbility. Instead, use the derived classes of ExtensionAbility for your scenarios, such as FormExtensionAbility for widget scenarios, InputMethodExtensionAbility for input method scenarios, and WorkSchedulerExtensionAbility for Work Scheduled task scenarios. For example, to enable a user to create an application widget on the home screen, you must derive FormExtensionAbility, implement the callback functions, and configure the capability in the configuration file. The derived class instances are created by developers and their lifecycles are managed by the system. In the stage model, you must use the derived classes of ExtensionAbility to develop custom services based on your service scenarios. - ExtensionAbility is oriented to specific scenarios. You cannot derive directly from ExtensionAbility. Instead, use the derived classes of ExtensionAbility for your scenarios, such as FormExtensionAbility for widget scenarios, InputMethodExtensionAbility for input method scenarios, and WorkSchedulerExtensionAbility for Work Scheduled task scenarios. For example, to enable a user to create an application widget on the home screen, you must derive FormExtensionAbility, implement the callback functions, and configure the capability in the configuration file. The derived class instances are created by developers and their lifecycles are managed by the system. In the stage model, you must use the derived classes of ExtensionAbility to develop custom services based on your service scenarios.
- [WindowStage](../windowmanager/application-window-stage.md) - [WindowStage](../windowmanager/application-window-stage.md)
...@@ -37,7 +37,7 @@ During application development based on the stage model, the following tasks are ...@@ -37,7 +37,7 @@ During application development based on the stage model, the following tasks are
| Task| Introduction| Guide| | Task| Introduction| Guide|
| -------- | -------- | -------- | | -------- | -------- | -------- |
| Application component development| Use the UIAbility and ExtensionAbility components of the stage model to develop applications.| - [Application- or Component-Level Configuration](application-component-configuration-stage.md)<br>- [UIAbility Component](uiability-overview.md)<br>- [ExtensionAbility Component](extensionability-overview.md)<br>- [AbilityStage Container Component](abilitystage.md)<br>- [Context](application-context-stage.md)<br>- [Component Startup Rules](component-startup-rules.md)| | Application component development| Use the UIAbility and ExtensionAbility components of the stage model to develop applications.| - [Application- or Component-Level Configuration](application-component-configuration-stage.md)<br>- [UIAbility Component](uiability-overview.md)<br>- [ExtensionAbility Component](extensionability-overview.md)<br>- [AbilityStage Container Component](abilitystage.md)<br>- [Context](application-context-stage.md)<br>- [Component Startup Rules](component-startup-rules.md)|
| Inter-process communication (IPC)| Learn the process model and common IPC modes of the stage model.| - [Common Events](common-event-overview.md)<br>- [Background Services](background-services.md)| | Process model| Learn the process model and common IPC modes of the stage model.| - [Common Events](common-event-overview.md)<br>- [Background Services](background-services.md)|
| Inter-thread communication| Learn the thread model and common inter-thread communication modes of the stage model.| - [Emitter](itc-with-emitter.md)<br>- [Worker](itc-with-worker.md)| | Thread model| Learn the thread model and common inter-thread communication modes of the stage model.| - [Emitter](itc-with-emitter.md)<br>- [Worker](itc-with-worker.md)|
| Mission management| Learn the basic concepts and typical scenarios of mission management in the stage model.| - [Mission Management Scenarios](mission-management-overview.md)<br>- [Mission Management and Launch Type](mission-management-launch-type.md)<br>- [Page Stack and Mission List](page-mission-stack.md)| | Mission management| Learn the basic concepts and typical scenarios of mission management in the stage model.| - [Mission Management Scenarios](mission-management-overview.md)<br>- [Mission Management and Launch Type](mission-management-launch-type.md)<br>- [Page Stack and Mission List](page-mission-stack.md)|
| Application configuration file| Learn the requirements for developing application configuration files in the stage model.| [Application Configuration File](config-file-stage.md)| | Application configuration file| Learn the requirements for developing application configuration files in the stage model.| [Application Configuration File](config-file-stage.md)|
en/application-dev/application-models/start-page.md
浏览文件 @ f7d7c3d4
...@@ -83,7 +83,7 @@ struct Index { ...@@ -83,7 +83,7 @@ struct Index {
@State message: string = 'Hello World' @State message: string = 'Hello World'
build() { build() {
// ... ...
Button("startAbility") Button("startAbility")
.onClick(() => { .onClick(() => {
featureAbility.startAbility({ featureAbility.startAbility({
...@@ -98,7 +98,7 @@ struct Index { ...@@ -98,7 +98,7 @@ struct Index {
console.info("startAbility failed errcode:" + err.code) console.info("startAbility failed errcode:" + err.code)
}) })
}) })
// ... ...
Button("page2") Button("page2")
.onClick(() => { .onClick(() => {
featureAbility.startAbility({ featureAbility.startAbility({
...@@ -113,7 +113,7 @@ struct Index { ...@@ -113,7 +113,7 @@ struct Index {
console.info("startAbility failed errcode:" + err.code) console.info("startAbility failed errcode:" + err.code)
}) })
}) })
// ... ...
} }
} }
``` ```
...@@ -136,7 +136,7 @@ export default { ...@@ -136,7 +136,7 @@ export default {
}) })
}, },
onDestroy() { onDestroy() {
// ... ...
}, },
} }
``` ```
en/application-dev/application-models/start-pageability-from-stage.md
浏览文件 @ f7d7c3d4
...@@ -21,7 +21,7 @@ export default class EntryAbility extends UIAbility { ...@@ -21,7 +21,7 @@ export default class EntryAbility extends UIAbility {
onWindowStageCreate(windowStage) { onWindowStageCreate(windowStage) {
console.info("EntryAbility onWindowStageCreate") console.info("EntryAbility onWindowStageCreate")
windowStage.loadContent('pages/Index', (err, data) => { windowStage.loadContent('pages/Index', (err, data) => {
// ... ...
}); });
let want = { let want = {
bundleName: "com.ohos.fa", bundleName: "com.ohos.fa",
...@@ -66,7 +66,7 @@ export default class EntryAbility extends UIAbility { ...@@ -66,7 +66,7 @@ export default class EntryAbility extends UIAbility {
onWindowStageCreate(windowStage) { onWindowStageCreate(windowStage) {
console.info("EntryAbility onWindowStageCreate") console.info("EntryAbility onWindowStageCreate")
windowStage.loadContent('pages/Index', (err, data) => { windowStage.loadContent('pages/Index', (err, data) => {
// ... ...
}); });
let want = { let want = {
bundleName: "com.ohos.fa", bundleName: "com.ohos.fa",
......
en/application-dev/application-models/start-remote-pageability.md
浏览文件 @ f7d7c3d4
...@@ -84,7 +84,9 @@ The following sample code shows how to use **getTrustedDeviceListSync()** to obt ...@@ -84,7 +84,9 @@ The following sample code shows how to use **getTrustedDeviceListSync()** to obt
```ts ```ts
import deviceManager from '@ohos.distributedHardware.deviceManager'; import deviceManager from '@ohos.distributedHardware.deviceManager';
let dmClass; let dmClass;
function getDeviceManager() { function getDeviceManager() {
deviceManager.createDeviceManager('ohos.example.distributedService', (error, dm) => { deviceManager.createDeviceManager('ohos.example.distributedService', (error, dm) => {
if (error) { if (error) {
...@@ -93,6 +95,7 @@ function getDeviceManager() { ...@@ -93,6 +95,7 @@ function getDeviceManager() {
dmClass = dm; dmClass = dm;
}) })
} }
function getRemoteDeviceId() { function getRemoteDeviceId() {
if (typeof dmClass === 'object' && dmClass != null) { if (typeof dmClass === 'object' && dmClass != null) {
let list = dmClass.getTrustedDeviceListSync(); let list = dmClass.getTrustedDeviceListSync();
...@@ -116,6 +119,7 @@ The following sample code shows how to explicitly start a remote PageAbility thr ...@@ -116,6 +119,7 @@ The following sample code shows how to explicitly start a remote PageAbility thr
```ts ```ts
import featureAbility from '@ohos.ability.featureAbility'; import featureAbility from '@ohos.ability.featureAbility';
function onStartRemoteAbility() { function onStartRemoteAbility() {
console.info('onStartRemoteAbility begin'); console.info('onStartRemoteAbility begin');
let params; let params;
......
en/application-dev/application-models/subscribe-system-environment-variable-changes.md
浏览文件 @ f7d7c3d4
...@@ -54,7 +54,7 @@ In OpenHarmony, you can subscribe to system environment variable changes in the ...@@ -54,7 +54,7 @@ In OpenHarmony, you can subscribe to system environment variable changes in the
// Page display. // Page display.
build() { build() {
// ... ...
} }
} }
``` ```
...@@ -77,7 +77,7 @@ In OpenHarmony, you can subscribe to system environment variable changes in the ...@@ -77,7 +77,7 @@ In OpenHarmony, you can subscribe to system environment variable changes in the
// Page display. // Page display.
build() { build() {
// ... ...
} }
} }
``` ```
...@@ -145,7 +145,7 @@ export default class EntryAbility extends UIAbility { ...@@ -145,7 +145,7 @@ export default class EntryAbility extends UIAbility {
} }
} }
// ... ...
} }
``` ```
...@@ -167,6 +167,6 @@ export default class EntryFormAbility extends FormExtensionAbility { ...@@ -167,6 +167,6 @@ export default class EntryFormAbility extends FormExtensionAbility {
console.info(`newConfig is ${JSON.stringify(newConfig)}`); console.info(`newConfig is ${JSON.stringify(newConfig)}`);
} }
// ... ...
} }
``` ```
en/application-dev/application-models/thread-model-stage.md
浏览文件 @ f7d7c3d4
...@@ -17,5 +17,6 @@ Based on the OpenHarmony thread model, different services run on different threa ...@@ -17,5 +17,6 @@ Based on the OpenHarmony thread model, different services run on different threa
> **NOTE** > **NOTE**
> >
> - The stage model provides only the main thread and worker thread. Emitter is mainly used for event synchronization within the main thread or between the main thread and worker thread. > - The stage model provides only the main thread and worker thread. Emitter is mainly used for event synchronization within the worker thread or between the main thread and worker thread.
> - To view thread information about an application process, run the **hdc shell** command to enter the shell CLI of the device, and then run the **ps -p *<pid>* -T command**, where *<pid>* indicates the ID of the application process. > - The UIAbility and UI are in the main thread. For details about data synchronization between them, see [Data Synchronization Between UIAbility and UI](uiability-data-sync-with-ui.md).
> - To view thread information about an application process, run the **hdc shell** command to enter the shell CLI of the device, and then run the **ps -p *<pid>* -T command**, where *<pid>* indicates the [process ID](process-model-stage.md) of the application.
en/application-dev/application-models/uiability-data-sync-with-ui.md
浏览文件 @ f7d7c3d4
...@@ -62,7 +62,7 @@ Before using the APIs provided by **EventHub**, you must obtain an **EventHub** ...@@ -62,7 +62,7 @@ Before using the APIs provided by **EventHub**, you must obtain an **EventHub**
// Page display. // Page display.
build() { build() {
// ... ...
} }
} }
``` ```
...@@ -90,8 +90,7 @@ Before using the APIs provided by **EventHub**, you must obtain an **EventHub** ...@@ -90,8 +90,7 @@ Before using the APIs provided by **EventHub**, you must obtain an **EventHub**
**globalThis** is a global object inside the [ArkTS engine instance](thread-model-stage.md) and can be used by UIAbility, ExtensionAbility, and Page inside the engine. Therefore, you can use **globalThis** for data synchronization. **globalThis** is a global object inside the [ArkTS engine instance](thread-model-stage.md) and can be used by UIAbility, ExtensionAbility, and Page inside the engine. Therefore, you can use **globalThis** for data synchronization.
**Figure 1** Using globalThis for data synchronization **Figure 1** Using globalThis for data synchronization
![globalThis1](figures/globalThis1.png)
![globalThis1](figures/globalThis1.png)
The following describes how to use **globalThis** in three scenarios. Precautions are provided as well. The following describes how to use **globalThis** in three scenarios. Precautions are provided as well.
...@@ -105,7 +104,7 @@ The following describes how to use **globalThis** in three scenarios. Precaution ...@@ -105,7 +104,7 @@ The following describes how to use **globalThis** in three scenarios. Precaution
By binding attributes or methods to **globalThis**, you can implement data synchronization between the UIAbility component and UI. For example, if you bind the **want** parameter in the UIAbility component, you can use the **want** parameter information on the UI corresponding to the UIAbility component. By binding attributes or methods to **globalThis**, you can implement data synchronization between the UIAbility component and UI. For example, if you bind the **want** parameter in the UIAbility component, you can use the **want** parameter information on the UI corresponding to the UIAbility component.
1. When [startAbility()](../reference/apis/js-apis-inner-application-uiAbilityContext.md#uiabilitycontextstartability) is called to start a UIAbility instance, the **onCreate()** callback is invoked, and the **want** parameter can be passed in the callback. Therefore, you can bind the **want** parameter to **globalThis**. 1. When [startAbility()](../reference/apis/js-apis-inner-application-uiAbilityContext.md#uiabilitycontextstartability) is called to start a UIAbility instance, the [onCreate()](../reference/apis/js-apis-app-ability-uiAbility.md#uiabilityoncreate) callback is invoked, and the **want** parameter can be passed in the callback. Therefore, you can bind the **want** parameter to **globalThis**.
```ts ```ts
import UIAbility from '@ohos.app.ability.UIAbility'; import UIAbility from '@ohos.app.ability.UIAbility';
...@@ -113,10 +112,10 @@ By binding attributes or methods to **globalThis**, you can implement data synch ...@@ -113,10 +112,10 @@ By binding attributes or methods to **globalThis**, you can implement data synch
export default class EntryAbility extends UIAbility { export default class EntryAbility extends UIAbility {
onCreate(want, launch) { onCreate(want, launch) {
globalThis.entryAbilityWant = want; globalThis.entryAbilityWant = want;
// ... ...
} }
// ... ...
} }
``` ```
...@@ -134,7 +133,7 @@ By binding attributes or methods to **globalThis**, you can implement data synch ...@@ -134,7 +133,7 @@ By binding attributes or methods to **globalThis**, you can implement data synch
// Page display. // Page display.
build() { build() {
// ... ...
} }
} }
``` ```
...@@ -152,7 +151,7 @@ To implement data synchronization between two UIAbility components in the same a ...@@ -152,7 +151,7 @@ To implement data synchronization between two UIAbility components in the same a
export default class UIAbilityA extends UIAbility { export default class UIAbilityA extends UIAbility {
onCreate(want, launch) { onCreate(want, launch) {
globalThis.entryAbilityStr = 'UIAbilityA'; // UIAbilityA stores the string "UIAbilityA" to globalThis. globalThis.entryAbilityStr = 'UIAbilityA'; // UIAbilityA stores the string "UIAbilityA" to globalThis.
// ... ...
} }
} }
``` ```
...@@ -166,7 +165,7 @@ To implement data synchronization between two UIAbility components in the same a ...@@ -166,7 +165,7 @@ To implement data synchronization between two UIAbility components in the same a
onCreate(want, launch) { onCreate(want, launch) {
// UIAbilityB reads name from globalThis and outputs it. // UIAbilityB reads name from globalThis and outputs it.
console.info('name from entryAbilityStr: ' + globalThis.entryAbilityStr); console.info('name from entryAbilityStr: ' + globalThis.entryAbilityStr);
// ... ...
} }
} }
``` ```
...@@ -185,7 +184,7 @@ To implement data synchronization between the UIAbility and ExtensionAbility com ...@@ -185,7 +184,7 @@ To implement data synchronization between the UIAbility and ExtensionAbility com
onCreate(want, launch) { onCreate(want, launch) {
// UIAbilityA stores the string "UIAbilityA" to globalThis. // UIAbilityA stores the string "UIAbilityA" to globalThis.
globalThis.entryAbilityStr = 'UIAbilityA'; globalThis.entryAbilityStr = 'UIAbilityA';
// ... ...
} }
} }
``` ```
...@@ -199,7 +198,7 @@ To implement data synchronization between the UIAbility and ExtensionAbility com ...@@ -199,7 +198,7 @@ To implement data synchronization between the UIAbility and ExtensionAbility com
onCreate(want) { onCreate(want) {
/ / ServiceExtAbility reads name from globalThis and outputs it. / / ServiceExtAbility reads name from globalThis and outputs it.
console.info('name from entryAbilityStr: ' + globalThis.entryAbilityStr); console.info('name from entryAbilityStr: ' + globalThis.entryAbilityStr);
// ... ...
} }
} }
``` ```
...@@ -208,7 +207,6 @@ To implement data synchronization between the UIAbility and ExtensionAbility com ...@@ -208,7 +207,6 @@ To implement data synchronization between the UIAbility and ExtensionAbility com
### Precautions for Using globalThis ### Precautions for Using globalThis
**Figure 2** Precautions for globalThis **Figure 2** Precautions for globalThis
![globalThis2](figures/globalThis2.png) ![globalThis2](figures/globalThis2.png)
- In the stage model, all the UIAbility components in a process share one ArkTS engine instance. When using **globalThis**, do not store objects with the same name. For example, if UIAbilityA and UIAbilityB use **globalThis** to store two objects with the same name, the object stored earlier will be overwritten. - In the stage model, all the UIAbility components in a process share one ArkTS engine instance. When using **globalThis**, do not store objects with the same name. For example, if UIAbilityA and UIAbilityB use **globalThis** to store two objects with the same name, the object stored earlier will be overwritten.
...@@ -227,7 +225,7 @@ The following provides an example to describe the object overwritten problem in ...@@ -227,7 +225,7 @@ The following provides an example to describe the object overwritten problem in
export default class UIAbilityA extends UIAbility { export default class UIAbilityA extends UIAbility {
onCreate(want, launch) { onCreate(want, launch) {
globalThis.context = this.context; // UIAbilityA stores the context in globalThis. globalThis.context = this.context; // UIAbilityA stores the context in globalThis.
// ... ...
} }
} }
``` ```
...@@ -243,7 +241,7 @@ The following provides an example to describe the object overwritten problem in ...@@ -243,7 +241,7 @@ The following provides an example to describe the object overwritten problem in
} }
// Page display. // Page display.
build() { build() {
// ... ...
} }
} }
``` ```
...@@ -257,7 +255,7 @@ The following provides an example to describe the object overwritten problem in ...@@ -257,7 +255,7 @@ The following provides an example to describe the object overwritten problem in
onCreate(want, launch) { onCreate(want, launch) {
// UIAbilityB overwrites the context stored by UIAbilityA in globalThis. // UIAbilityB overwrites the context stored by UIAbilityA in globalThis.
globalThis.context = this.context; globalThis.context = this.context;
// ... ...
} }
} }
``` ```
...@@ -273,7 +271,7 @@ The following provides an example to describe the object overwritten problem in ...@@ -273,7 +271,7 @@ The following provides an example to describe the object overwritten problem in
} }
// Page display. // Page display.
build() { build() {
// ... ...
} }
} }
``` ```
...@@ -286,7 +284,7 @@ The following provides an example to describe the object overwritten problem in ...@@ -286,7 +284,7 @@ The following provides an example to describe the object overwritten problem in
export default class UIAbilityA extends UIAbility { export default class UIAbilityA extends UIAbility {
onCreate(want, launch) { // UIAbilityA will not enter this lifecycle. onCreate(want, launch) { // UIAbilityA will not enter this lifecycle.
globalThis.context = this.context; globalThis.context = this.context;
// ... ...
} }
} }
``` ```
...@@ -302,7 +300,7 @@ The following provides an example to describe the object overwritten problem in ...@@ -302,7 +300,7 @@ The following provides an example to describe the object overwritten problem in
} }
// Page display. // Page display.
build() { build() {
// ... ...
} }
} }
``` ```
...@@ -310,5 +308,3 @@ The following provides an example to describe the object overwritten problem in ...@@ -310,5 +308,3 @@ The following provides an example to describe the object overwritten problem in
## Using AppStorage or LocalStorage for Data Synchronization ## Using AppStorage or LocalStorage for Data Synchronization
ArkUI provides AppStorage and LocalStorage to implement application- and UIAbility-level data synchronization, respectively. Both solutions can be used to manage the application state, enhance application performance, and improve user experience. The AppStorage is a global state manager and is applicable when multiple UIAbilities share the same state data. The LocalStorage is a local state manager that manages state data used inside a single UIAbility. They help you control the application state more flexibly and improve the maintainability and scalability of applications. For details, see [State Management of Application-Level Variables](../quick-start/arkts-application-state-management-overview.md). ArkUI provides AppStorage and LocalStorage to implement application- and UIAbility-level data synchronization, respectively. Both solutions can be used to manage the application state, enhance application performance, and improve user experience. The AppStorage is a global state manager and is applicable when multiple UIAbilities share the same state data. The LocalStorage is a local state manager that manages state data used inside a single UIAbility. They help you control the application state more flexibly and improve the maintainability and scalability of applications. For details, see [State Management of Application-Level Variables](../quick-start/arkts-application-state-management-overview.md).
<!--no_check-->
\ No newline at end of file
en/application-dev/application-models/uiability-intra-device-interaction.md
浏览文件 @ f7d7c3d4
...@@ -32,20 +32,20 @@ Assume that your application has two UIAbility components: EntryAbility and Func ...@@ -32,20 +32,20 @@ Assume that your application has two UIAbility components: EntryAbility and Func
```ts ```ts
let context = ...; // UIAbilityContext let context = ...; // UIAbilityContext
let wantInfo = { let want = {
deviceId: '', // An empty deviceId indicates the local device. deviceId: '', // An empty deviceId indicates the local device.
bundleName: 'com.example.myapplication', bundleName: 'com.example.myapplication',
abilityName: 'FuncAbility', abilityName: 'FuncAbility',
moduleName: 'module1', // moduleName is optional. moduleName: 'func', // moduleName is optional.
parameters: {// Custom information. parameters: {// Custom information.
info: 'From the Index page of EntryAbility', info: 'From the Index page of EntryAbility',
}, },
} }
// context is the UIAbilityContext of the initiator UIAbility. // context is the UIAbilityContext of the initiator UIAbility.
context.startAbility(wantInfo).then(() => { context.startAbility(want).then(() => {
// ... console.info('Succeeded in starting ability.');
}).catch((err) => { }).catch((err) => {
// ... console.error(`Failed to start ability. Code is ${err.code}, message is ${err.message}`);
}) })
``` ```
...@@ -53,14 +53,13 @@ Assume that your application has two UIAbility components: EntryAbility and Func ...@@ -53,14 +53,13 @@ Assume that your application has two UIAbility components: EntryAbility and Func
```ts ```ts
import UIAbility from '@ohos.app.ability.UIAbility'; import UIAbility from '@ohos.app.ability.UIAbility';
import window from '@ohos.window';
export default class FuncAbility extends UIAbility { export default class FuncAbility extends UIAbility {
onCreate(want, launchParam) { onCreate(want, launchParam) {
// Receive the parameters passed by the initiator UIAbility. // Receive the parameters passed by the initiator UIAbility.
let funcAbilityWant = want; let funcAbilityWant = want;
let info = funcAbilityWant?.parameters?.info; let info = funcAbilityWant?.parameters?.info;
// ... ...
} }
} }
``` ```
...@@ -76,11 +75,14 @@ Assume that your application has two UIAbility components: EntryAbility and Func ...@@ -76,11 +75,14 @@ Assume that your application has two UIAbility components: EntryAbility and Func
// context is the UIAbilityContext of the UIAbility instance to stop. // context is the UIAbilityContext of the UIAbility instance to stop.
context.terminateSelf((err) => { context.terminateSelf((err) => {
// ... if (err.code) {
console.error(`Failed to terminate Self. Code is ${err.code}, message is ${err.message}`);
return;
}
}); });
``` ```
> **NOTE** > **NOTE**<br>
> >
> When [terminateSelf()](../reference/apis/js-apis-inner-application-uiAbilityContext.md#uiabilitycontextterminateself) is called to stop the **UIAbility** instance, the snapshot of the instance is retained by default. That is, the mission corresponding to the instance is still displayed in Recents. If you do not want to retain the snapshot, set **removeMissionAfterTerminate** under the [abilities](../quick-start/module-configuration-file.md#abilities) tag to **true** in the [module.json5 file](../quick-start/module-configuration-file.md) of the corresponding UIAbility. > When [terminateSelf()](../reference/apis/js-apis-inner-application-uiAbilityContext.md#uiabilitycontextterminateself) is called to stop the **UIAbility** instance, the snapshot of the instance is retained by default. That is, the mission corresponding to the instance is still displayed in Recents. If you do not want to retain the snapshot, set **removeMissionAfterTerminate** under the [abilities](../quick-start/module-configuration-file.md#abilities) tag to **true** in the [module.json5 file](../quick-start/module-configuration-file.md) of the corresponding UIAbility.
...@@ -95,20 +97,20 @@ When starting FuncAbility from EntryAbility, you want the result to be returned ...@@ -95,20 +97,20 @@ When starting FuncAbility from EntryAbility, you want the result to be returned
```ts ```ts
let context = ...; // UIAbilityContext let context = ...; // UIAbilityContext
let wantInfo = { let want = {
deviceId: '', // An empty deviceId indicates the local device. deviceId: '', // An empty deviceId indicates the local device.
bundleName: 'com.example.myapplication', bundleName: 'com.example.myapplication',
abilityName: 'FuncAbility', abilityName: 'FuncAbility',
moduleName: 'module1', // moduleName is optional. moduleName: 'func', // moduleName is optional.
parameters: {// Custom information. parameters: {// Custom information.
info: 'From the Index page of EntryAbility', info: 'From the Index page of EntryAbility',
}, },
} }
// context is the UIAbilityContext of the initiator UIAbility. // context is the UIAbilityContext of the initiator UIAbility.
context.startAbilityForResult(wantInfo).then((data) => { context.startAbilityForResult(want).then((data) => {
// ... ...
}).catch((err) => { }).catch((err) => {
// ... console.error(`Failed to start ability for result. Code is ${err.code}, message is ${err.message}`);
}) })
``` ```
...@@ -122,7 +124,7 @@ When starting FuncAbility from EntryAbility, you want the result to be returned ...@@ -122,7 +124,7 @@ When starting FuncAbility from EntryAbility, you want the result to be returned
want: { want: {
bundleName: 'com.example.myapplication', bundleName: 'com.example.myapplication',
abilityName: 'FuncAbility', abilityName: 'FuncAbility',
moduleName: 'module1', moduleName: 'func',
parameters: { parameters: {
info: 'From the Index page of FuncAbility', info: 'From the Index page of FuncAbility',
}, },
...@@ -130,7 +132,10 @@ When starting FuncAbility from EntryAbility, you want the result to be returned ...@@ -130,7 +132,10 @@ When starting FuncAbility from EntryAbility, you want the result to be returned
} }
// context is the AbilityContext of the target UIAbility. // context is the AbilityContext of the target UIAbility.
context.terminateSelfWithResult(abilityResult, (err) => { context.terminateSelfWithResult(abilityResult, (err) => {
// ... if (err.code) {
console.error(`Failed to terminate self with result. Code is ${err.code}, message is ${err.message}`);
return;
}
}); });
``` ```
...@@ -140,17 +145,17 @@ When starting FuncAbility from EntryAbility, you want the result to be returned ...@@ -140,17 +145,17 @@ When starting FuncAbility from EntryAbility, you want the result to be returned
let context = ...; // UIAbilityContext let context = ...; // UIAbilityContext
const RESULT_CODE: number = 1001; const RESULT_CODE: number = 1001;
// ... ...
// context is the UIAbilityContext of the initiator UIAbility. // context is the UIAbilityContext of the initiator UIAbility.
context.startAbilityForResult(wantInfo).then((data) => { context.startAbilityForResult(want).then((data) => {
if (data?.resultCode === RESULT_CODE) { if (data?.resultCode === RESULT_CODE) {
// Parse the information returned by the target UIAbility. // Parse the information returned by the target UIAbility.
let info = data.want?.parameters?.info; let info = data.want?.parameters?.info;
// ... ...
} }
}).catch((err) => { }).catch((err) => {
// ... console.error(`Failed to start ability for result. Code is ${err.code}, message is ${err.message}`);
}) })
``` ```
...@@ -174,15 +179,15 @@ This section describes how to start the UIAbility of another application through ...@@ -174,15 +179,15 @@ This section describes how to start the UIAbility of another application through
"module": { "module": {
"abilities": [ "abilities": [
{ {
// ... ...
"skills": [ "skills": [
{ {
"entities": [ "entities": [
// ... ...
"entity.system.default" "entity.system.default"
], ],
"actions": [ "actions": [
// ... ...
"ohos.want.action.viewData" "ohos.want.action.viewData"
] ]
} }
...@@ -197,7 +202,7 @@ This section describes how to start the UIAbility of another application through ...@@ -197,7 +202,7 @@ This section describes how to start the UIAbility of another application through
```ts ```ts
let context = ...; // UIAbilityContext let context = ...; // UIAbilityContext
let wantInfo = { let want = {
deviceId: '', // An empty deviceId indicates the local device. deviceId: '', // An empty deviceId indicates the local device.
// Uncomment the line below if you want to implicitly query data only in the specific bundle. // Uncomment the line below if you want to implicitly query data only in the specific bundle.
// bundleName: 'com.example.myapplication', // bundleName: 'com.example.myapplication',
...@@ -207,10 +212,10 @@ This section describes how to start the UIAbility of another application through ...@@ -207,10 +212,10 @@ This section describes how to start the UIAbility of another application through
} }
// context is the UIAbilityContext of the initiator UIAbility. // context is the UIAbilityContext of the initiator UIAbility.
context.startAbility(wantInfo).then(() => { context.startAbility(want).then(() => {
// ... console.info('Succeeded in starting ability.');
}).catch((err) => { }).catch((err) => {
// ... console.error(`Failed to start ability. Code is ${err.code}, message is ${err.message}`);
}) })
``` ```
...@@ -224,7 +229,10 @@ This section describes how to start the UIAbility of another application through ...@@ -224,7 +229,10 @@ This section describes how to start the UIAbility of another application through
// context is the UIAbilityContext of the UIAbility instance to stop. // context is the UIAbilityContext of the UIAbility instance to stop.
context.terminateSelf((err) => { context.terminateSelf((err) => {
// ... if (err.code) {
console.error(`Failed to terminate self. Code is ${err.code}, message is ${err.message}`);
return;
}
}); });
``` ```
...@@ -240,15 +248,15 @@ If you want to obtain the return result when using implicit Want to start the UI ...@@ -240,15 +248,15 @@ If you want to obtain the return result when using implicit Want to start the UI
"module": { "module": {
"abilities": [ "abilities": [
{ {
// ... ...
"skills": [ "skills": [
{ {
"entities": [ "entities": [
// ... ...
"entity.system.default" "entity.system.default"
], ],
"actions": [ "actions": [
// ... ...
"ohos.want.action.editData" "ohos.want.action.editData"
] ]
} }
...@@ -263,20 +271,20 @@ If you want to obtain the return result when using implicit Want to start the UI ...@@ -263,20 +271,20 @@ If you want to obtain the return result when using implicit Want to start the UI
```ts ```ts
let context = ...; // UIAbilityContext let context = ...; // UIAbilityContext
let wantInfo = { let want = {
deviceId: '', // An empty deviceId indicates the local device. deviceId: '', // An empty deviceId indicates the local device.
// Uncomment the line below if you want to implicitly query data only in the specific bundle. // Uncomment the line below if you want to implicitly query data only in the specific bundle.
// bundleName: 'com.example.myapplication', // bundleName: 'com.example.myapplication',
action: 'ohos.want.action.editData', action: 'ohos.want.action.editData',
// entities can be omitted. // entities can be omitted.
entities: ['entity.system.default'], entities: ['entity.system.default']
} }
// context is the UIAbilityContext of the initiator UIAbility. // context is the UIAbilityContext of the initiator UIAbility.
context.startAbilityForResult(wantInfo).then((data) => { context.startAbilityForResult(want).then((data) => {
// ... ...
}).catch((err) => { }).catch((err) => {
// ... console.error(`Failed to start ability for result. Code is ${err.code}, message is ${err.message}`);
}) })
``` ```
...@@ -298,7 +306,10 @@ If you want to obtain the return result when using implicit Want to start the UI ...@@ -298,7 +306,10 @@ If you want to obtain the return result when using implicit Want to start the UI
} }
// context is the AbilityContext of the target UIAbility. // context is the AbilityContext of the target UIAbility.
context.terminateSelfWithResult(abilityResult, (err) => { context.terminateSelfWithResult(abilityResult, (err) => {
// ... if (err.code) {
console.error(`Failed to terminate self with result. Code is ${err.code}, message is ${err.message}`);
return;
}
}); });
``` ```
...@@ -317,10 +328,10 @@ If you want to obtain the return result when using implicit Want to start the UI ...@@ -317,10 +328,10 @@ If you want to obtain the return result when using implicit Want to start the UI
if (data?.resultCode === RESULT_CODE) { if (data?.resultCode === RESULT_CODE) {
// Parse the information returned by the target UIAbility. // Parse the information returned by the target UIAbility.
let payResult = data.want?.parameters?.payResult; let payResult = data.want?.parameters?.payResult;
// ... ...
} }
}).catch((err) => { }).catch((err) => {
// ... console.error(`Failed to start ability for result. Code is ${err.code}, message is ${err.message}`);
}) })
``` ```
...@@ -352,27 +363,28 @@ For details about how to obtain the context, see [Obtaining the Context of UIAbi ...@@ -352,27 +363,28 @@ For details about how to obtain the context, see [Obtaining the Context of UIAbi
import AbilityConstant from '@ohos.app.ability.AbilityConstant'; import AbilityConstant from '@ohos.app.ability.AbilityConstant';
let context = ...; // UIAbilityContext let context = ...; // UIAbilityContext
let wantInfo = { let want = {
deviceId: '', // An empty deviceId indicates the local device. deviceId: '', // An empty deviceId indicates the local device.
bundleName: 'com.example.myapplication', bundleName: 'com.example.myapplication',
abilityName: 'FuncAbility', abilityName: 'FuncAbility',
moduleName: 'module1', // moduleName is optional. moduleName: 'func', // moduleName is optional.
parameters: {// Custom information. parameters: {// Custom information.
info: 'From the Index page of EntryAbility', info: 'From the Index page of EntryAbility',
}, },
} }
let options = { let options = {
windowMode: AbilityConstant.WindowMode.WINDOW_MODE_FLOATING windowMode: AbilityConstant.WindowMode.WINDOW_MODE_FLOATING
} };
// context is the UIAbilityContext of the initiator UIAbility. // context is the UIAbilityContext of the initiator UIAbility.
context.startAbility(wantInfo, options).then(() => { context.startAbility(want, options).then(() => {
// ... console.info('Succeeded in starting ability.');
}).catch((err) => { }).catch((err) => {
// ... console.error(`Failed to start ability. Code is ${err.code}, message is ${err.message}`);
}) })
``` ```
The display effect is shown below. The display effect is shown below.
![](figures/start-uiability-floating-window.png) ![](figures/start-uiability-floating-window.png)
## Starting a Specified Page of UIAbility ## Starting a Specified Page of UIAbility
...@@ -387,20 +399,20 @@ When the initiator UIAbility starts another UIAbility, it usually needs to redir ...@@ -387,20 +399,20 @@ When the initiator UIAbility starts another UIAbility, it usually needs to redir
```ts ```ts
let context = ...; // UIAbilityContext let context = ...; // UIAbilityContext
let wantInfo = { let want = {
deviceId: '', // An empty deviceId indicates the local device. deviceId: '', // An empty deviceId indicates the local device.
bundleName: 'com.example.myapplication', bundleName: 'com.example.myapplication',
abilityName: 'FuncAbility', abilityName: 'FuncAbility',
moduleName: 'module1', // moduleName is optional. moduleName: 'func', // moduleName is optional.
parameters: {// Custom parameter used to pass the page information. parameters: {// Custom parameter used to pass the page information.
router: 'funcA', router: 'funcA',
}, },
} }
// context is the UIAbilityContext of the initiator UIAbility. // context is the UIAbilityContext of the initiator UIAbility.
context.startAbility(wantInfo).then(() => { context.startAbility(want).then(() => {
// ... console.info('Succeeded in starting ability.');
}).catch((err) => { }).catch((err) => {
// ... console.error(`Failed to start ability. Code is ${err.code}, message is ${err.message}`);
}) })
``` ```
...@@ -431,7 +443,7 @@ export default class FuncAbility extends UIAbility { ...@@ -431,7 +443,7 @@ export default class FuncAbility extends UIAbility {
} }
} }
windowStage.loadContent(url, (err, data) => { windowStage.loadContent(url, (err, data) => {
// ... ...
}); });
} }
} }
...@@ -455,7 +467,7 @@ In summary, when a UIAbility instance of application A has been created and the ...@@ -455,7 +467,7 @@ In summary, when a UIAbility instance of application A has been created and the
onNewWant(want, launchParam) { onNewWant(want, launchParam) {
// Receive the parameters passed by the initiator UIAbility. // Receive the parameters passed by the initiator UIAbility.
globalThis.funcAbilityWant = want; globalThis.funcAbilityWant = want;
// ... ...
} }
} }
``` ```
...@@ -480,7 +492,7 @@ In summary, when a UIAbility instance of application A has been created and the ...@@ -480,7 +492,7 @@ In summary, when a UIAbility instance of application A has been created and the
// Page display. // Page display.
build() { build() {
// ... ...
} }
} }
``` ```
...@@ -494,11 +506,11 @@ In summary, when a UIAbility instance of application A has been created and the ...@@ -494,11 +506,11 @@ In summary, when a UIAbility instance of application A has been created and the
Call is an extension of the UIAbility capability. It enables the UIAbility to be invoked by and communicate with external systems. The UIAbility invoked can be either started in the foreground or created and run in the background. You can use the call to implement data sharing between two UIAbility instances (CallerAbility and CalleeAbility) through IPC. Call is an extension of the UIAbility capability. It enables the UIAbility to be invoked by and communicate with external systems. The UIAbility invoked can be either started in the foreground or created and run in the background. You can use the call to implement data sharing between two UIAbility instances (CallerAbility and CalleeAbility) through IPC.
The core API used for the call is **startAbilityByCall**, which differs from **startAbility** in the following ways: The core API used for the call is **startAbilityByCall()**, which differs from **startAbility()** in the following ways:
- **startAbilityByCall** supports UIAbility launch in the foreground and background, whereas **startAbility** supports UIAbility launch in the foreground only. - **startAbilityByCall()** supports UIAbility launch in the foreground and background, whereas **startAbility()** supports UIAbility launch in the foreground only.
- The CallerAbility can use the caller object returned by **startAbilityByCall** to communicate with the CalleeAbility, but **startAbility** does not provide the communication capability. - The CallerAbility can use the caller object returned by **startAbilityByCall()** to communicate with the CalleeAbility, but **startAbility()** does not provide the communication capability.
Call is usually used in the following scenarios: Call is usually used in the following scenarios:
...@@ -506,6 +518,7 @@ Call is usually used in the following scenarios: ...@@ -506,6 +518,7 @@ Call is usually used in the following scenarios:
- Starting the CalleeAbility in the background - Starting the CalleeAbility in the background
**Table 1** Terms used in the call **Table 1** Terms used in the call
| **Term**| Description| | **Term**| Description|
...@@ -517,9 +530,9 @@ Call is usually used in the following scenarios: ...@@ -517,9 +530,9 @@ Call is usually used in the following scenarios:
The following figure shows the call process. The following figure shows the call process.
Figure 1 Call process Figure 1 Call process
![call](figures/call.png) ![call](figures/call.png)
- The CallerAbility uses **startAbilityByCall** to obtain a caller object and uses **call()** of the caller object to send data to the CalleeAbility. - The CallerAbility uses **startAbilityByCall** to obtain a caller object and uses **call()** of the caller object to send data to the CalleeAbility.
...@@ -537,7 +550,7 @@ The following figure shows the call process. ...@@ -537,7 +550,7 @@ The following figure shows the call process.
The following table describes the main APIs used for the call. For details, see [AbilityContext](../reference/apis/js-apis-app-ability-uiAbility.md#caller). The following table describes the main APIs used for the call. For details, see [AbilityContext](../reference/apis/js-apis-app-ability-uiAbility.md#caller).
**Table 2** Call APIs **Table 2** Call APIs
| API| Description| | API| Description|
| -------- | -------- | | -------- | -------- |
...@@ -571,7 +584,6 @@ For the CalleeAbility, implement the callback to receive data and the methods to ...@@ -571,7 +584,6 @@ For the CalleeAbility, implement the callback to receive data and the methods to
``` ```
3. Define the agreed parcelable data. 3. Define the agreed parcelable data.
The data formats sent and received by the CallerAbility and CalleeAbility must be consistent. In the following example, the data formats are number and string. The data formats sent and received by the CallerAbility and CalleeAbility must be consistent. In the following example, the data formats are number and string.
...@@ -588,7 +600,7 @@ For the CalleeAbility, implement the callback to receive data and the methods to ...@@ -588,7 +600,7 @@ For the CalleeAbility, implement the callback to receive data and the methods to
marshalling(messageSequence) { marshalling(messageSequence) {
messageSequence.writeInt(this.num); messageSequence.writeInt(this.num);
messageSequence.writeString(this.str); messageSequence.writeString(this.str);
return true return true;
} }
unmarshalling(messageSequence) { unmarshalling(messageSequence) {
...@@ -625,16 +637,16 @@ For the CalleeAbility, implement the callback to receive data and the methods to ...@@ -625,16 +637,16 @@ For the CalleeAbility, implement the callback to receive data and the methods to
onCreate(want, launchParam) { onCreate(want, launchParam) {
try { try {
this.callee.on(MSG_SEND_METHOD, sendMsgCallback); this.callee.on(MSG_SEND_METHOD, sendMsgCallback);
} catch (error) { } catch (err) {
console.info(`${MSG_SEND_METHOD} register failed with error ${JSON.stringify(error)}`); console.error(`Failed to register. Code is ${err.code}, message is ${err.message}`);
} }
} }
onDestroy() { onDestroy() {
try { try {
this.callee.off(MSG_SEND_METHOD); this.callee.off(MSG_SEND_METHOD);
} catch (error) { } catch (err) {
console.error(TAG, `${MSG_SEND_METHOD} unregister failed with error ${JSON.stringify(error)}`); console.error(`Failed to unregister. Code is ${err.code}, message is ${err.message}`);
} }
} }
} }
...@@ -661,9 +673,9 @@ For the CalleeAbility, implement the callback to receive data and the methods to ...@@ -661,9 +673,9 @@ For the CalleeAbility, implement the callback to receive data and the methods to
caller.on('release', (msg) => { caller.on('release', (msg) => {
console.info(`caller onRelease is called ${msg}`); console.info(`caller onRelease is called ${msg}`);
}) })
console.info('caller register OnRelease succeed'); console.info('Succeeded in registering on release.');
} catch (error) { } catch (err) {
console.info(`caller register OnRelease failed with ${error}`); console.err(`Failed to caller register on release. Code is ${err.code}, message is ${err.message}`);
} }
} }
...@@ -672,15 +684,15 @@ For the CalleeAbility, implement the callback to receive data and the methods to ...@@ -672,15 +684,15 @@ For the CalleeAbility, implement the callback to receive data and the methods to
this.caller = await context.startAbilityByCall({ this.caller = await context.startAbilityByCall({
bundleName: 'com.samples.CallApplication', bundleName: 'com.samples.CallApplication',
abilityName: 'CalleeAbility' abilityName: 'CalleeAbility'
}) });
if (this.caller === undefined) { if (this.caller === undefined) {
console.info('get caller failed') console.info('get caller failed')
return return;
} }
console.info('get caller success') console.info('get caller success')
this.regOnRelease(this.caller) this.regOnRelease(this.caller)
} catch (error) { } (err) {
console.info(`get caller failed with ${error}`) console.err(`Failed to get caller. Code is ${err.code}, message is ${err.message}`);
} }
} }
``` ```
en/application-dev/application-models/uiability-launch-type.md
浏览文件 @ f7d7c3d4
...@@ -18,6 +18,7 @@ The launch type of the UIAbility component refers to the state of the UIAbility ...@@ -18,6 +18,7 @@ The launch type of the UIAbility component refers to the state of the UIAbility
Each time [startAbility()](../reference/apis/js-apis-inner-application-uiAbilityContext.md#uiabilitycontextstartability) is called, if a UIAbility instance of this type already exists in the application process, the instance is reused. Therefore, only one UIAbility instance of this type exists in the system, that is, displayed in **Recents**. Each time [startAbility()](../reference/apis/js-apis-inner-application-uiAbilityContext.md#uiabilitycontextstartability) is called, if a UIAbility instance of this type already exists in the application process, the instance is reused. Therefore, only one UIAbility instance of this type exists in the system, that is, displayed in **Recents**.
**Figure 1** Demonstration effect in singleton mode **Figure 1** Demonstration effect in singleton mode
![uiability-launch-type1](figures/uiability-launch-type1.gif) ![uiability-launch-type1](figures/uiability-launch-type1.gif)
> **NOTE** > **NOTE**
...@@ -30,11 +31,11 @@ To use the singleton mode, set **launchType** in the [module.json5 configuration ...@@ -30,11 +31,11 @@ To use the singleton mode, set **launchType** in the [module.json5 configuration
```json ```json
{ {
"module": { "module": {
// ... ...
"abilities": [ "abilities": [
{ {
"launchType": "singleton", "launchType": "singleton",
// ... ...
} }
] ]
} }
...@@ -56,11 +57,11 @@ To use the multiton mode, set **launchType** in the [module.json5 file](../quick ...@@ -56,11 +57,11 @@ To use the multiton mode, set **launchType** in the [module.json5 file](../quick
```json ```json
{ {
"module": { "module": {
// ... ...
"abilities": [ "abilities": [
{ {
"launchType": "multiton", "launchType": "multiton",
// ... ...
} }
] ]
} }
...@@ -73,6 +74,7 @@ To use the multiton mode, set **launchType** in the [module.json5 file](../quick ...@@ -73,6 +74,7 @@ To use the multiton mode, set **launchType** in the [module.json5 file](../quick
The **specified** mode is used in some special scenarios. For example, in a document application, you want a document instance to be created each time you create a document, but you want to use the same document instance when you repeatedly open an existing document. The **specified** mode is used in some special scenarios. For example, in a document application, you want a document instance to be created each time you create a document, but you want to use the same document instance when you repeatedly open an existing document.
**Figure 3** Demonstration effect in specified mode **Figure 3** Demonstration effect in specified mode
![uiability-launch-type3](figures/uiability-launch-type3.gif) ![uiability-launch-type3](figures/uiability-launch-type3.gif)
For example, there are two UIAbility components: EntryAbility and SpecifiedAbility (with the launch type **specified**). You are required to start SpecifiedAbility from EntryAbility. For example, there are two UIAbility components: EntryAbility and SpecifiedAbility (with the launch type **specified**). You are required to start SpecifiedAbility from EntryAbility.
...@@ -82,11 +84,11 @@ For example, there are two UIAbility components: EntryAbility and SpecifiedAbili ...@@ -82,11 +84,11 @@ For example, there are two UIAbility components: EntryAbility and SpecifiedAbili
```json ```json
{ {
"module": { "module": {
// ... ...
"abilities": [ "abilities": [
{ {
"launchType": "specified", "launchType": "specified",
// ... ...
} }
] ]
} }
...@@ -99,23 +101,24 @@ For example, there are two UIAbility components: EntryAbility and SpecifiedAbili ...@@ -99,23 +101,24 @@ For example, there are two UIAbility components: EntryAbility and SpecifiedAbili
// Configure an independent key for each UIAbility instance. // Configure an independent key for each UIAbility instance.
// For example, in the document usage scenario, use the document path as the key. // For example, in the document usage scenario, use the document path as the key.
function getInstance() { function getInstance() {
// ... ...
} }
let context =...; // context is the UIAbilityContext of the initiator UIAbility.
let want = { let want = {
deviceId: '', // An empty deviceId indicates the local device. deviceId: '', // An empty deviceId indicates the local device.
bundleName: 'com.example.myapplication', bundleName: 'com.example.myapplication',
abilityName: 'SpecifiedAbility', abilityName: 'SpecifiedAbility',
moduleName: 'module1', // moduleName is optional. moduleName: 'specified', // moduleName is optional.
parameters: {// Custom information. parameters: {// Custom information.
instanceKey: getInstance(), instanceKey: getInstance(),
}, },
} }
// context is the UIAbilityContext of the initiator UIAbility.
this.context.startAbility(want).then(() => { context.startAbility(want).then(() => {
// ... console.info('Succeeded in starting ability.');
}).catch((err) => { }).catch((err) => {
// ... console.error(`Failed to start ability. Code is ${err.code}, message is ${err.message}`);
}) })
``` ```
...@@ -154,4 +157,3 @@ For example, there are two UIAbility components: EntryAbility and SpecifiedAbili ...@@ -154,4 +157,3 @@ For example, there are two UIAbility components: EntryAbility and SpecifiedAbili
3. Return to the home screen and open file B. A new UIAbility instance is started, for example, UIAbility instance 3. 3. Return to the home screen and open file B. A new UIAbility instance is started, for example, UIAbility instance 3.
4. Return to the home screen and open file A again. UIAbility instance 2 is started. This is because the system automatically matches the key of the UIAbility instance and starts the UIAbility instance that has a matching key. In this example, UIAbility instance 2 has the same key as file A. Therefore, the system pulls back UIAbility instance 2 and focuses it without creating a new instance. 4. Return to the home screen and open file A again. UIAbility instance 2 is started. This is because the system automatically matches the key of the UIAbility instance and starts the UIAbility instance that has a matching key. In this example, UIAbility instance 2 has the same key as file A. Therefore, the system pulls back UIAbility instance 2 and focuses it without creating a new instance.
<!--no_check-->
\ No newline at end of file
en/application-dev/application-models/uiability-lifecycle.md
浏览文件 @ f7d7c3d4
...@@ -22,23 +22,24 @@ The **Create** state is triggered when the UIAbility instance is created during ...@@ -22,23 +22,24 @@ The **Create** state is triggered when the UIAbility instance is created during
```ts ```ts
import UIAbility from '@ohos.app.ability.UIAbility'; import UIAbility from '@ohos.app.ability.UIAbility';
import window from '@ohos.window';
export default class EntryAbility extends UIAbility { export default class EntryAbility extends UIAbility {
onCreate(want, launchParam) { onCreate(want, launchParam) {
// Initialize the application. // Initialize the application.
} }
// ... ...
} }
``` ```
> **NOTE**
>
> [Want](../reference/apis/js-apis-app-ability-want.md) is used as the carrier to transfer information between application components. For details, see [Want](want-overview.md).
### WindowStageCreate and WindowStageDestory ### WindowStageCreate and WindowStageDestory
After the UIAbility instance is created but before it enters the **Foreground** state, the system creates a WindowStage instance and triggers the **onWindowStageCreate()** callback. You can set UI loading and WindowStage event subscription in the callback. After the UIAbility instance is created but before it enters the **Foreground** state, the system creates a WindowStage instance and triggers the **onWindowStageCreate()** callback. You can set UI loading and WindowStage event subscription in the callback.
**Figure 2** WindowStageCreate and WindowStageDestory **Figure 2** WindowStageCreate and WindowStageDestory
![Ability-Life-Cycle-WindowStage](figures/Ability-Life-Cycle-WindowStage.png) ![Ability-Life-Cycle-WindowStage](figures/Ability-Life-Cycle-WindowStage.png)
In the **onWindowStageCreate()** callback, use [loadContent()](../reference/apis/js-apis-window.md#loadcontent9-2) to set the page to be loaded, and call [on('windowStageEvent')](../reference/apis/js-apis-window.md#onwindowstageevent9) to subscribe to [WindowStage events](../reference/apis/js-apis-window.md#windowstageeventtype9), for example, having or losing focus, or becoming visible or invisible. In the **onWindowStageCreate()** callback, use [loadContent()](../reference/apis/js-apis-window.md#loadcontent9-2) to set the page to be loaded, and call [on('windowStageEvent')](../reference/apis/js-apis-window.md#onwindowstageevent9) to subscribe to [WindowStage events](../reference/apis/js-apis-window.md#windowstageeventtype9), for example, having or losing focus, or becoming visible or invisible.
...@@ -48,29 +49,44 @@ import UIAbility from '@ohos.app.ability.UIAbility'; ...@@ -48,29 +49,44 @@ import UIAbility from '@ohos.app.ability.UIAbility';
import window from '@ohos.window'; import window from '@ohos.window';
export default class EntryAbility extends UIAbility { export default class EntryAbility extends UIAbility {
// ... ...
onWindowStageCreate(windowStage: Window.WindowStage) { onWindowStageCreate(windowStage: window.WindowStage) {
// Subscribe to the WindowStage events (having or losing focus, or becoming visible or invisible). // Subscribe to the WindowStage events (having or losing focus, or becoming visible or invisible).
try { try {
windowStage.on('windowStageEvent', (data) => { windowStage.on('windowStageEvent', (data) => {
console.info('Succeeded in enabling the listener for window stage event changes. Data: ' + let stageEventType: window.WindowStageEventType = data;
JSON.stringify(data)); switch (stageEventType) {
case window.WindowStageEventType.SHOWN: // Switch to the foreground.
console.info('windowStage foreground.');
break;
case window.WindowStageEventType.ACTIVE: // Gain focus.
console.info('windowStage active.');
break;
case window.WindowStageEventType.INACTIVE: // Lose focus.
console.info('windowStage inactive.');
break;
case window.WindowStageEventType.HIDDEN: // Switch to the background.
console.info('windowStage background.');
break;
default:
break;
}
}); });
} catch (exception) { } catch (exception) {
console.error('Failed to enable the listener for window stage event changes. Cause:' + console.error('Failed to enable the listener for window stage event changes. Cause:' +
JSON.stringify(exception)); JSON.stringify(exception));
}; }
// Set the UI loading. // Set UI loading.
windowStage.loadContent('pages/Index', (err, data) => { windowStage.loadContent('pages/Index', (err, data) => {
// ... ...
}); });
} }
} }
``` ```
> **NOTE** > **NOTE**<br>
> >
> For details about how to use WindowStage, see [Window Development](../windowmanager/application-window-stage.md). > For details about how to use WindowStage, see [Window Development](../windowmanager/application-window-stage.md).
...@@ -82,16 +98,21 @@ import UIAbility from '@ohos.app.ability.UIAbility'; ...@@ -82,16 +98,21 @@ import UIAbility from '@ohos.app.ability.UIAbility';
import window from '@ohos.window'; import window from '@ohos.window';
export default class EntryAbility extends UIAbility { export default class EntryAbility extends UIAbility {
// ... windowStage: window.WindowStage;
...
onWindowStageCreate(windowStage: window.WindowStage) {
this.windowStage = windowStage;
...
}
onWindowStageDestroy() { onWindowStageDestroy() {
// Release UI resources. // Release UIresources.
// Unsubscribe from the WindowStage events such as having or losing focus in the onWindowStageDestroy() callback. // Unsubscribe from the WindowStage events such as having or losing focus in the onWindowStageDestroy() callback.
try { try {
windowStage.off('windowStageEvent'); this.windowStage.off('windowStageEvent');
} catch (exception) { } catch (err) {
console.error('Failed to disable the listener for window stage event changes. Cause:' + console.error(`Failed to disable the listener for window stage event changes. Code is ${err.code}, message is ${err.message}`);
JSON.stringify(exception));
}; };
} }
} }
...@@ -115,7 +136,7 @@ When the application is switched to the background, you can disable positioning ...@@ -115,7 +136,7 @@ When the application is switched to the background, you can disable positioning
import UIAbility from '@ohos.app.ability.UIAbility'; import UIAbility from '@ohos.app.ability.UIAbility';
export default class EntryAbility extends UIAbility { export default class EntryAbility extends UIAbility {
// ... ...
onForeground() { onForeground() {
// Apply for the resources required by the system or re-apply for the resources released in onBackground(). // Apply for the resources required by the system or re-apply for the resources released in onBackground().
...@@ -137,10 +158,9 @@ The UIAbility instance is destroyed when **terminateSelf()** is called or the us ...@@ -137,10 +158,9 @@ The UIAbility instance is destroyed when **terminateSelf()** is called or the us
```ts ```ts
import UIAbility from '@ohos.app.ability.UIAbility'; import UIAbility from '@ohos.app.ability.UIAbility';
import window from '@ohos.window';
export default class EntryAbility extends UIAbility { export default class EntryAbility extends UIAbility {
// ... ...
onDestroy() { onDestroy() {
// Release system resources and save data. // Release system resources and save data.
......
en/application-dev/application-models/uiability-overview.md
浏览文件 @ f7d7c3d4
...@@ -11,7 +11,9 @@ The following design philosophy is behind UIAbility: ...@@ -11,7 +11,9 @@ The following design philosophy is behind UIAbility:
2. Support for multiple device types and window forms 2. Support for multiple device types and window forms
For details, see [Interpretation of the Application Model] (application-model-description.md). > **NOTE**
>
> For details, see [Interpretation of the Application Model](application-model-description.md).
The UIAbility division principles and suggestions are as follows: The UIAbility division principles and suggestions are as follows:
...@@ -33,7 +35,7 @@ To enable an application to properly use a UIAbility component, declare the UIAb ...@@ -33,7 +35,7 @@ To enable an application to properly use a UIAbility component, declare the UIAb
```json ```json
{ {
"module": { "module": {
// ... ...
"abilities": [ "abilities": [
{ {
"name": "EntryAbility", // Name of the UIAbility component. "name": "EntryAbility", // Name of the UIAbility component.
...@@ -43,7 +45,7 @@ To enable an application to properly use a UIAbility component, declare the UIAb ...@@ -43,7 +45,7 @@ To enable an application to properly use a UIAbility component, declare the UIAb
"label": "$string:EntryAbility_label", // Label of the UIAbility component. "label": "$string:EntryAbility_label", // Label of the UIAbility component.
"startWindowIcon": "$media:icon", // Index of the icon resource file. "startWindowIcon": "$media:icon", // Index of the icon resource file.
"startWindowBackground": "$color:start_window_background", // Index of the background color resource file. "startWindowBackground": "$color:start_window_background", // Index of the background color resource file.
// ... ...
} }
] ]
} }
......
en/application-dev/application-models/uiability-usage.md
浏览文件 @ f7d7c3d4
...@@ -17,11 +17,11 @@ export default class EntryAbility extends UIAbility { ...@@ -17,11 +17,11 @@ export default class EntryAbility extends UIAbility {
onWindowStageCreate(windowStage: window.WindowStage) { onWindowStageCreate(windowStage: window.WindowStage) {
// Main window is created. Set a main page for this ability. // Main window is created. Set a main page for this ability.
windowStage.loadContent('pages/Index', (err, data) => { windowStage.loadContent('pages/Index', (err, data) => {
// ... ...
}); });
} }
// ... ...
} }
``` ```
...@@ -43,8 +43,7 @@ The UIAbility class has its own context, which is an instance of the [UIAbilityC ...@@ -43,8 +43,7 @@ The UIAbility class has its own context, which is an instance of the [UIAbilityC
onCreate(want, launchParam) { onCreate(want, launchParam) {
// Obtain the context of the UIAbility instance. // Obtain the context of the UIAbility instance.
let context = this.context; let context = this.context;
...
// ...
} }
} }
``` ```
...@@ -68,7 +67,7 @@ The UIAbility class has its own context, which is an instance of the [UIAbilityC ...@@ -68,7 +67,7 @@ The UIAbility class has its own context, which is an instance of the [UIAbilityC
// Page display. // Page display.
build() { build() {
// ... ...
} }
} }
``` ```
...@@ -93,7 +92,7 @@ The UIAbility class has its own context, which is an instance of the [UIAbilityC ...@@ -93,7 +92,7 @@ The UIAbility class has its own context, which is an instance of the [UIAbilityC
// Page display. // Page display.
build() { build() {
// ... ...
} }
} }
``` ```
en/application-dev/application-models/want-overview.md
浏览文件 @ f7d7c3d4
...@@ -6,13 +6,15 @@ ...@@ -6,13 +6,15 @@
[Want](../reference/apis/js-apis-app-ability-want.md) is an object that transfers information between application components. It is often used as a parameter of [startAbility()](../reference/apis/js-apis-inner-application-uiAbilityContext.md#uiabilitycontextstartability). For example, when UIAbilityA needs to start UIAbilityB and transfer some data to UIAbilityB, it can use the **want** parameter in **startAbility()** to transfer the data. [Want](../reference/apis/js-apis-app-ability-want.md) is an object that transfers information between application components. It is often used as a parameter of [startAbility()](../reference/apis/js-apis-inner-application-uiAbilityContext.md#uiabilitycontextstartability). For example, when UIAbilityA needs to start UIAbilityB and transfer some data to UIAbilityB, it can use the **want** parameter in **startAbility()** to transfer the data.
**Figure 1** Want usage **Figure 1** Want usage
![usage-of-want](figures/usage-of-want.png) ![usage-of-want](figures/usage-of-want.png)
## Types of Want ## Types of Want
- **Explicit Want**: If **abilityName** and **bundleName** are specified when starting an ability, explicit Want is used. - **Explicit Want**: If **abilityName** and **bundleName** are specified in the **want** parameter when starting an an application component, explicit Want is used.
Explicit Want is usually used to start a known target ability in the same application. The target ability is started by specifying **bundleName** of the application where the target ability is located and **abilityName** in the **Want** object. When there is an explicit object to process the request, explicit Want is a simple and effective way to start the target ability.
Explicit Want is usually used to start a known target application component in the same application. The target application component is started by specifying **bundleName** of the application where the target application component is located and **abilityName** in the **Want** object. When there is an explicit object to process the request, explicit Want is a simple and effective way to start the target application component.
```ts ```ts
let wantInfo = { let wantInfo = {
...@@ -22,7 +24,8 @@ ...@@ -22,7 +24,8 @@
} }
``` ```
- **Implicit Want**: If **abilityName** is not specified when starting the ability, implicit Want is used. - **Implicit Want**: If **abilityName** is not specified in the **want** parameter when starting the an application component, implicit Want is used.
Implicit Want can be used when the object used to process the request is unclear and the current application wants to use a capability (defined by the [skills tag](../quick-start/module-configuration-file.md#skills)) provided by another application. The system matches all applications that declare to support the capability. For example, for a link open request, the system matches all applications that support the request and provides the available ones for users to select. Implicit Want can be used when the object used to process the request is unclear and the current application wants to use a capability (defined by the [skills tag](../quick-start/module-configuration-file.md#skills)) provided by another application. The system matches all applications that declare to support the capability. For example, for a link open request, the system matches all applications that support the request and provides the available ones for users to select.
...@@ -39,10 +42,10 @@ ...@@ -39,10 +42,10 @@
``` ```
> **NOTE** > **NOTE**
> - Depending on the ability matching result, the following cases may be possible when you attempt to use implicit Want to start the ability. > - Depending on the application component matching result, the following cases may be possible when you attempt to use implicit Want to start the application component.
> - No ability is matched. The startup fails. > - No application component is matched. The startup fails.
> - An ability that meets the conditions is matched. That ability is started. > - An application component that meets the conditions is matched. That application component is started.
> - Multiple abilities that meet the conditions are matched. A dialog box is displayed for users to select one of them. > - Multiple application components that meet the conditions are matched. A dialog box is displayed for users to select one of them.
> >
> - If the **want** parameter passed does not contain **abilityName** or **bundleName**, the ServiceExtensionAbility components of all applications cannot be started through implicit Want. > - If the **want** parameter passed does not contain **abilityName** or **bundleName**, the ServiceExtensionAbility components of all applications cannot be started through implicit Want.
> >
......
en/application-dev/application-models/widget-development-fa.md
浏览文件 @ f7d7c3d4
...@@ -275,7 +275,7 @@ async function storeFormInfo(formId: string, formName: string, tempFlag: boolean ...@@ -275,7 +275,7 @@ async function storeFormInfo(formId: string, formName: string, tempFlag: boolean
} }
} }
// ... ...
onCreate(want) { onCreate(want) {
console.info('FormAbility onCreate'); console.info('FormAbility onCreate');
...@@ -293,7 +293,7 @@ async function storeFormInfo(formId: string, formName: string, tempFlag: boolean ...@@ -293,7 +293,7 @@ async function storeFormInfo(formId: string, formName: string, tempFlag: boolean
let formData = formBindingData.createFormBindingData(obj); let formData = formBindingData.createFormBindingData(obj);
return formData; return formData;
} }
// ... ...
``` ```
You should override **onDestroy** to implement widget data deletion. You should override **onDestroy** to implement widget data deletion.
...@@ -313,14 +313,14 @@ async function deleteFormInfo(formId: string) { ...@@ -313,14 +313,14 @@ async function deleteFormInfo(formId: string) {
} }
} }
// ... ...
onDestroy(formId) { onDestroy(formId) {
console.info('FormAbility onDestroy'); console.info('FormAbility onDestroy');
// Delete the persistent widget instance data. // Delete the persistent widget instance data.
// Implement this API based on project requirements. // Implement this API based on project requirements.
deleteFormInfo(formId); deleteFormInfo(formId);
} }
// ... ...
``` ```
For details about how to implement persistent data storage, see [Application Data Persistence Overview](../database/app-data-persistence-overview.md). For details about how to implement persistent data storage, see [Application Data Persistence Overview](../database/app-data-persistence-overview.md).
...@@ -543,4 +543,3 @@ The following is an example: ...@@ -543,4 +543,3 @@ The following is an example:
} }
} }
``` ```
en/application-dev/application-models/windowextensionability.md
浏览文件 @ f7d7c3d4
...@@ -11,7 +11,7 @@ the context is [WindowExtensionContext](../reference/apis/js-apis-inner-applicat ...@@ -11,7 +11,7 @@ the context is [WindowExtensionContext](../reference/apis/js-apis-inner-applicat
> **NOTE** > **NOTE**
> >
> **WindowExtensionAbility** is a system API. To embed a third-party application in another application and display it over the application, switch to the full SDK by following the instructions provided in [Guide to Switching to Full SDK](../../application-dev/quick-start/full-sdk-switch-guide.md). > **WindowExtensionAbility** is a system API. To embed a third-party application in another application and display it over the application, switch to the full SDK by following the instructions provided in [Guide to Switching to Full SDK](../faqs/full-sdk-switch-guide.md).
> >
...@@ -43,7 +43,7 @@ To implement an embedded application, manually create a WindowExtensionAbility i ...@@ -43,7 +43,7 @@ To implement an embedded application, manually create a WindowExtensionAbility i
onWindowReady(window) { onWindowReady(window) {
window.loadContent('WindowExtAbility/pages/index1').then(() => { window.loadContent('WindowExtAbility/pages/index1').then(() => {
window.getProperties().then((pro) => { window.getProperties().then((pro) => {
console.log("WindowExtension " + JSON.stringify(pro)); console.info("WindowExtension " + JSON.stringify(pro));
}) })
window.show(); window.show();
}) })
...@@ -111,3 +111,4 @@ System applications can load the created WindowExtensionAbility through the Abil ...@@ -111,3 +111,4 @@ System applications can load the created WindowExtensionAbility through the Abil
} }
} }
``` ```
en/application-dev/connectivity/net-connection-manager.md
浏览文件 @ f7d7c3d4
...@@ -39,7 +39,7 @@ For the complete list of APIs and example code, see [Network Connection Manageme ...@@ -39,7 +39,7 @@ For the complete list of APIs and example code, see [Network Connection Manageme
| ---- | ---- | ---- | | ---- | ---- | ---- |
| ohos.net.connection | function getDefaultNet(callback: AsyncCallback\<NetHandle>): void; |Creates a **NetHandle** object that contains the **netId** of the default network. This API uses an asynchronous callback to return the result.| | ohos.net.connection | function getDefaultNet(callback: AsyncCallback\<NetHandle>): void; |Creates a **NetHandle** object that contains the **netId** of the default network. This API uses an asynchronous callback to return the result.|
| ohos.net.connection | function getGlobalHttpProxy<sup>10+</sup>(callback: AsyncCallback\<HttpProxy>): void;| Obtains the global HTTP proxy for the network. This API uses an asynchronous callback to return the result.| | ohos.net.connection | function getGlobalHttpProxy<sup>10+</sup>(callback: AsyncCallback\<HttpProxy>): void;| Obtains the global HTTP proxy for the network. This API uses an asynchronous callback to return the result.|
| ohos.net.connection | function setGlobalHttpProxy<sup>10+</sup>(httpProxy: HttpProxy, callback: AsyncCallback<void>): void;| Sets the global HTTP proxy for the network. This API uses an asynchronous callback to return the result.| | ohos.net.connection | function setGlobalHttpProxy<sup>10+</sup>(httpProxy: HttpProxy, callback: AsyncCallback\<void>): void;| Sets the global HTTP proxy for the network. This API uses an asynchronous callback to return the result.|
| ohos.net.connection | function getAppNet<sup>9+</sup>(callback: AsyncCallback\<NetHandle>): void;| Obtains a **NetHandle** object that contains the **netId** of the network bound to the application. This API uses an asynchronous callback to return the result.| | ohos.net.connection | function getAppNet<sup>9+</sup>(callback: AsyncCallback\<NetHandle>): void;| Obtains a **NetHandle** object that contains the **netId** of the network bound to the application. This API uses an asynchronous callback to return the result.|
| ohos.net.connection | function setAppNet<sup>9+</sup>(netHandle: NetHandle, callback: AsyncCallback\<void>): void;| Binds an application to the specified network. The application can access the external network only through this network. This API uses an asynchronous callback to return the result.| | ohos.net.connection | function setAppNet<sup>9+</sup>(netHandle: NetHandle, callback: AsyncCallback\<void>): void;| Binds an application to the specified network. The application can access the external network only through this network. This API uses an asynchronous callback to return the result.|
| ohos.net.connection | function getDefaultNetSync<sup>9+</sup>(): NetHandle; |Obtains the default active data network in synchronous mode. You can use **getNetCapabilities** to obtain information such as the network type and capabilities.| | ohos.net.connection | function getDefaultNetSync<sup>9+</sup>(): NetHandle; |Obtains the default active data network in synchronous mode. You can use **getNetCapabilities** to obtain information such as the network type and capabilities.|
...@@ -47,7 +47,7 @@ For the complete list of APIs and example code, see [Network Connection Manageme ...@@ -47,7 +47,7 @@ For the complete list of APIs and example code, see [Network Connection Manageme
| ohos.net.connection | function getAllNets(callback: AsyncCallback\<Array\<NetHandle>>): void;| Obtains the list of **NetHandle** objects of the connected network. This API uses an asynchronous callback to return the result.| | ohos.net.connection | function getAllNets(callback: AsyncCallback\<Array\<NetHandle>>): void;| Obtains the list of **NetHandle** objects of the connected network. This API uses an asynchronous callback to return the result.|
| ohos.net.connection | function getConnectionProperties(netHandle: NetHandle, callback: AsyncCallback\<ConnectionProperties>): void; |Obtains link information of the default network. This API uses an asynchronous callback to return the result.| | ohos.net.connection | function getConnectionProperties(netHandle: NetHandle, callback: AsyncCallback\<ConnectionProperties>): void; |Obtains link information of the default network. This API uses an asynchronous callback to return the result.|
| ohos.net.connection | function getNetCapabilities(netHandle: NetHandle, callback: AsyncCallback\<NetCapabilities>): void; |Obtains the capability set of the default network. This API uses an asynchronous callback to return the result.| | ohos.net.connection | function getNetCapabilities(netHandle: NetHandle, callback: AsyncCallback\<NetCapabilities>): void; |Obtains the capability set of the default network. This API uses an asynchronous callback to return the result.|
| ohos.net.connection | function isDefaultNetMetered<sup>9+</sup>(callback: AsyncCallback<boolean>): void; |Checks whether the data traffic usage on the current network is metered. This API uses an asynchronous callback to return the result.| | ohos.net.connection | function isDefaultNetMetered<sup>9+</sup>(callback: AsyncCallback\<boolean>): void; |Checks whether the data traffic usage on the current network is metered. This API uses an asynchronous callback to return the result.|
| ohos.net.connection | function reportNetConnected(netHandle: NetHandle, callback: AsyncCallback\<void>): void;| Reports a **netAavailable** event to NetManager. If this API is called, the application considers that its network status (ohos.net.connection.NetCap.NET_CAPABILITY_VAILDATED) is inconsistent with that of NetManager. This API uses an asynchronous callback to return the result.| | ohos.net.connection | function reportNetConnected(netHandle: NetHandle, callback: AsyncCallback\<void>): void;| Reports a **netAavailable** event to NetManager. If this API is called, the application considers that its network status (ohos.net.connection.NetCap.NET_CAPABILITY_VAILDATED) is inconsistent with that of NetManager. This API uses an asynchronous callback to return the result.|
| ohos.net.connection | function reportNetDisconnected(netHandle: NetHandle, callback: AsyncCallback\<void>): void;| Reports a **netAavailable** event to NetManager. If this API is called, the application considers that its network status (ohos.net.connection.NetCap.NET_CAPABILITY_VAILDATED) is inconsistent with that of NetManager. This API uses an asynchronous callback to return the result.| | ohos.net.connection | function reportNetDisconnected(netHandle: NetHandle, callback: AsyncCallback\<void>): void;| Reports a **netAavailable** event to NetManager. If this API is called, the application considers that its network status (ohos.net.connection.NetCap.NET_CAPABILITY_VAILDATED) is inconsistent with that of NetManager. This API uses an asynchronous callback to return the result.|
| ohos.net.connection | function getAddressesByName(host: string, callback: AsyncCallback\<Array\<NetAddress>>): void; |Obtains all IP addresses of the specified network by resolving the domain name. This API uses an asynchronous callback to return the result.| | ohos.net.connection | function getAddressesByName(host: string, callback: AsyncCallback\<Array\<NetAddress>>): void; |Obtains all IP addresses of the specified network by resolving the domain name. This API uses an asynchronous callback to return the result.|
......
en/application-dev/connectivity/net-mgmt-overview.md
浏览文件 @ f7d7c3d4
...@@ -5,7 +5,6 @@ Network management functions include: ...@@ -5,7 +5,6 @@ Network management functions include:
- [HTTP data request](http-request.md): initiates a data request through HTTP. - [HTTP data request](http-request.md): initiates a data request through HTTP.
- [WebSocket connection](websocket-connection.md): establishes a bidirectional connection between the server and client through WebSocket. - [WebSocket connection](websocket-connection.md): establishes a bidirectional connection between the server and client through WebSocket.
- [Socket connection](socket-connection.md): transmits data through Socket. - [Socket connection](socket-connection.md): transmits data through Socket.
- [Network policy management](net-policy-management.md): restricts network capabilities by setting network policies, including cellular network policy, sleep/power-saving mode policy, and background network policy, and resets network policies as needed.
- [Network sharing](net-sharing.md): shares a device's Internet connection with other connected devices by means of Wi-Fi hotspot, Bluetooth, and USB sharing, and queries the network sharing state and shared mobile data volume. - [Network sharing](net-sharing.md): shares a device's Internet connection with other connected devices by means of Wi-Fi hotspot, Bluetooth, and USB sharing, and queries the network sharing state and shared mobile data volume.
- [Ethernet connection](net-ethernet.md): provides wired network capabilities, which allow you to set the IP address, subnet mask, gateway, and Domain Name System (DNS) server of a wired network. - [Ethernet connection](net-ethernet.md): provides wired network capabilities, which allow you to set the IP address, subnet mask, gateway, and Domain Name System (DNS) server of a wired network.
- [Network connection management](net-connection-manager.md): provides basic network management capabilities, including management of Wi-Fi/cellular/Ethernet connection priorities, network quality evaluation, subscription to network connection status changes, query of network connection information, and DNS resolution. - [Network connection management](net-connection-manager.md): provides basic network management capabilities, including management of Wi-Fi/cellular/Ethernet connection priorities, network quality evaluation, subscription to network connection status changes, query of network connection information, and DNS resolution.
......
en/application-dev/device/usb-guidelines.md
浏览文件 @ f7d7c3d4
# USB Service Development # USB Service Development
## When to Use ## When to Use
In Host mode, you can obtain the list of connected USB devices, enable or disable the devices, manage device access permissions, and perform data transfer or control transfer. In Host mode, you can obtain the list of connected USB devices, enable or disable the devices, manage device access permissions, and perform data transfer or control transfer.
## APIs
## Available APIs
The USB service provides the following functions: query of USB device list, bulk data transfer, control transfer, and access permission management. The USB service provides the following functions: query of USB device list, bulk data transfer, control transfer, and access permission management.
...@@ -12,25 +14,28 @@ The following table lists the USB APIs currently available. For details, see the ...@@ -12,25 +14,28 @@ The following table lists the USB APIs currently available. For details, see the
**Table 1** Open USB APIs **Table 1** Open USB APIs
| API | Description | | Name | Description |
| ------------------------------------------------------------ | ------------------------------------------------------------ | | ------------------------------------------------------------ | ------------------------------------------------------------ |
| hasRight(deviceName: string): boolean | Checks whether the user has the device access permissions. | | hasRight(deviceName: string): boolean | Checks whether the user has the device access permissions.|
| requestRight(deviceName: string): Promise\<boolean> | Requests the temporary permission for a given application to access the USB device. This API uses a promise to return the result. | | requestRight(deviceName: string): Promise&lt;boolean&gt; | Requests the device access permissions for the application. This API uses a promise to return the result. |
| connectDevice(device: USBDevice): Readonly\<USBDevicePipe> | Connects to the USB device based on the device list returned by `getDevices()`. | | removeRight(deviceName: string): boolean | Revokes the device access permissions of the application.|
| getDevices(): Array<Readonly\<USBDevice>> | Obtains the list of USB devices connected to the USB host. If no USB device is connected, an empty list is returned. | | connectDevice(device: USBDevice): Readonly&lt;USBDevicePipe&gt; | Connects to the USB device based on the device information returned by `getDevices()`. |
| getDevices(): Array&lt;Readonly&lt;USBDevice&gt;&gt; | Obtains the list of USB devices connected to the host. If no device is connected, an empty list is returned. |
| setConfiguration(pipe: USBDevicePipe, config: USBConfiguration): number | Sets the USB device configuration. | | setConfiguration(pipe: USBDevicePipe, config: USBConfiguration): number | Sets the USB device configuration. |
| setInterface(pipe: USBDevicePipe, iface: USBInterface): number | Sets a USB interface. | | setInterface(pipe: USBDevicePipe, iface: USBInterface): number | Sets a USB interface. |
| claimInterface(pipe: USBDevicePipe, iface: USBInterface, force ?: boolean): number | Claims a USB interface. | | claimInterface(pipe: USBDevicePipe, iface: USBInterface, force ?: boolean): number | Claims a USB interface. |
| bulkTransfer(pipe: USBDevicePipe, endpoint: USBEndpoint, buffer: Uint8Array, timeout ?: number): Promise\<number> | Performs bulk transfer. | | bulkTransfer(pipe: USBDevicePipe, endpoint: USBEndpoint, buffer: Uint8Array, timeout ?: number): Promise&lt;number&gt; | Performs bulk transfer. |
| closePipe(pipe: USBDevicePipe): number | Closes a USB device pipe. | | closePipe(pipe: USBDevicePipe): number | Closes a USB device pipe. |
| releaseInterface(pipe: USBDevicePipe, iface: USBInterface): number | Releases a USB interface. | | releaseInterface(pipe: USBDevicePipe, iface: USBInterface): number | Releases a USB interface. |
| getFileDescriptor(pipe: USBDevicePipe): number | Obtains the file descriptor. | | getFileDescriptor(pipe: USBDevicePipe): number | Obtains the file descriptor. |
| getRawDescriptor(pipe: USBDevicePipe): Uint8Array | Obtains the raw USB descriptor. | | getRawDescriptor(pipe: USBDevicePipe): Uint8Array | Obtains the raw USB descriptor. |
| controlTransfer(pipe: USBDevicePipe, controlparam: USBControlParams, timeout ?: number): Promise&lt;number&gt; | Performs control transfer. | | controlTransfer(pipe: USBDevicePipe, controlparam: USBControlParams, timeout ?: number): Promise&lt;number&gt; | Performs control transfer. |
## How to Develop ## How to Develop
You can set a USB device as the USB host to connect to other USB devices for data transfer. The development procedure is as follows: You can set a USB device as a host to connect to a device for data transfer. The development procedure is as follows:
1. Obtain the USB device list. 1. Obtain the USB device list.
...@@ -40,7 +45,7 @@ You can set a USB device as the USB host to connect to other USB devices for dat ...@@ -40,7 +45,7 @@ You can set a USB device as the USB host to connect to other USB devices for dat
// Obtain the USB device list. // Obtain the USB device list.
let deviceList = usb.getDevices(); let deviceList = usb.getDevices();
/* /*
Example deviceList structure Example deviceList structure:
[ [
{ {
name: "1-1", name: "1-1",
...@@ -92,7 +97,6 @@ You can set a USB device as the USB host to connect to other USB devices for dat ...@@ -92,7 +97,6 @@ You can set a USB device as the USB host to connect to other USB devices for dat
*/ */
``` ```
2. Obtain the device operation permissions. 2. Obtain the device operation permissions.
```js ```js
...@@ -109,9 +113,10 @@ You can set a USB device as the USB host to connect to other USB devices for dat ...@@ -109,9 +113,10 @@ You can set a USB device as the USB host to connect to other USB devices for dat
```js ```js
// Open the device, and obtain the USB device pipe for data transfer. // Open the device, and obtain the USB device pipe for data transfer.
let pipe = usb.connectDevice(deviceList[0]);
let interface1 = deviceList[0].configs[0].interfaces[0]; let interface1 = deviceList[0].configs[0].interfaces[0];
/* /*
Claim the corresponding interface from deviceList. Claim the corresponding interface from **deviceList**.
interface1 must be one present in the device configuration. interface1 must be one present in the device configuration.
*/ */
usb.claimInterface(pipe, interface1, true); usb.claimInterface(pipe, interface1, true);
...@@ -151,6 +156,6 @@ You can set a USB device as the USB host to connect to other USB devices for dat ...@@ -151,6 +156,6 @@ You can set a USB device as the USB host to connect to other USB devices for dat
5. Release the USB interface, and close the USB device. 5. Release the USB interface, and close the USB device.
```js ```js
usb.releaseInterface(pipe, interface); usb.releaseInterface(pipe, interface1);
usb.closePipe(pipe); usb.closePipe(pipe);
``` ```
\ No newline at end of file
en/application-dev/internationalization/intl-guidelines.md
浏览文件 @ f7d7c3d4
...@@ -111,7 +111,7 @@ The [i18n](../reference/apis/js-apis-i18n.md) module provides enhanced I18N capa ...@@ -111,7 +111,7 @@ The [i18n](../reference/apis/js-apis-i18n.md) module provides enhanced I18N capa
let dateTimeFormat = new Intl.DateTimeFormat(); let dateTimeFormat = new Intl.DateTimeFormat();
``` ```
Alternatively, use your own locale and formatting parameters to create a **DateTimeFormat** object. Formatting parameters are optional. For a full list of formatting parameters, see [DateTimeOptions](../reference/apis/js-apis-intl.md#datetimeoptions9). Alternatively, use your own locale and formatting parameters to create a **DateTimeFormat** object. Formatting parameters are optional. For a full list of formatting parameters, see [DateTimeOptions](../reference/apis/js-apis-intl.md#datetimeoptions6).
```js ```js
let options = {dateStyle: "full", timeStyle: "full"}; let options = {dateStyle: "full", timeStyle: "full"};
...@@ -181,7 +181,7 @@ The [i18n](../reference/apis/js-apis-i18n.md) module provides enhanced I18N capa ...@@ -181,7 +181,7 @@ The [i18n](../reference/apis/js-apis-i18n.md) module provides enhanced I18N capa
let numberFormat = new Intl.NumberFormat(); let numberFormat = new Intl.NumberFormat();
``` ```
Alternatively, use your own locale and formatting parameters to create a **NumberFormat** object. Formatting parameters are optional. For a full list of formatting parameters, see [NumberOptions](../reference/apis/js-apis-intl.md#numberoptions9). Alternatively, use your own locale and formatting parameters to create a **NumberFormat** object. Formatting parameters are optional. For a full list of formatting parameters, see [NumberOptions](../reference/apis/js-apis-intl.md#numberoptions6).
```js ```js
let options = {compactDisplay: "short", notation: "compact"}; let options = {compactDisplay: "short", notation: "compact"};
...@@ -240,7 +240,7 @@ Users in different regions have different requirements for string sorting. [Coll ...@@ -240,7 +240,7 @@ Users in different regions have different requirements for string sorting. [Coll
let collator = new Intl.Collator(); let collator = new Intl.Collator();
``` ```
Alternatively, use your own locale and formatting parameters to create a **Collator** object. For a full list of parameters, see [CollatorOptions](../reference/apis/js-apis-intl.md#collatoroptions9). Alternatively, use your own locale and formatting parameters to create a **Collator** object. For a full list of parameters, see [CollatorOptions](../reference/apis/js-apis-intl.md#collatoroptions8).
The **sensitivity** parameter is used to specify the levels of differences that will be used for string comparison. The value **base** indicates that only characters are compared, but not the accent and capitalization. For example, 'a' != 'b', 'a' == '', 'a'=='A'. The value **accent** indicates that the accent is considered, but not the capitalization. For example, 'a' != 'b', 'a' == '', 'a'=='A'. The value **case** indicates that the capitalization is considered, but the accent. For example, 'a' != 'b', 'a' == '', 'a'=='A'. The value **variant** indicates that the accent and capitalization are considered. For example, 'a' != 'b', 'a' == '', 'a'=='A'. The **sensitivity** parameter is used to specify the levels of differences that will be used for string comparison. The value **base** indicates that only characters are compared, but not the accent and capitalization. For example, 'a' != 'b', 'a' == '', 'a'=='A'. The value **accent** indicates that the accent is considered, but not the capitalization. For example, 'a' != 'b', 'a' == '', 'a'=='A'. The value **case** indicates that the capitalization is considered, but the accent. For example, 'a' != 'b', 'a' == '', 'a'=='A'. The value **variant** indicates that the accent and capitalization are considered. For example, 'a' != 'b', 'a' == '', 'a'=='A'.
```js ```js
...@@ -301,7 +301,7 @@ According to grammars in certain languages, the singular or plural form of a nou ...@@ -301,7 +301,7 @@ According to grammars in certain languages, the singular or plural form of a nou
let pluralRules = new Intl.PluralRules(); let pluralRules = new Intl.PluralRules();
``` ```
Alternatively, use your own locale and formatting parameters to create a **PluralRules** object. For a full list of parameters, see [PluralRulesOptions](../reference/apis/js-apis-intl.md#pluralrulesoptions9). Alternatively, use your own locale and formatting parameters to create a **PluralRules** object. For a full list of parameters, see [PluralRulesOptions](../reference/apis/js-apis-intl.md#pluralrulesoptions8).
```js ```js
let pluralRules = new Intl.PluralRules("zh-CN", {localeMatcher: "best fit", type: "cardinal"}); let pluralRules = new Intl.PluralRules("zh-CN", {localeMatcher: "best fit", type: "cardinal"});
...@@ -349,7 +349,7 @@ According to grammars in certain languages, the singular or plural form of a nou ...@@ -349,7 +349,7 @@ According to grammars in certain languages, the singular or plural form of a nou
let relativeTimeFormat = new Intl.RelativeTimeFormat(); let relativeTimeFormat = new Intl.RelativeTimeFormat();
``` ```
Alternatively, use your own locale and formatting parameters to create a **RelativeTimeFormat** object. Formatting parameters are optional. For a full list of formatting parameters, see [RelativeTimeFormatInputOptions](../reference/apis/js-apis-intl.md#relativetimeformatinputoptions9). Alternatively, use your own locale and formatting parameters to create a **RelativeTimeFormat** object. Formatting parameters are optional. For a full list of formatting parameters, see [RelativeTimeFormatInputOptions](../reference/apis/js-apis-intl.md#relativetimeformatinputoptions8).
```js ```js
let relativeTimeFormat = new Intl.RelativeTimeFormat("zh-CN", {numeric: "always", style: "long"}); let relativeTimeFormat = new Intl.RelativeTimeFormat("zh-CN", {numeric: "always", style: "long"});
......
en/application-dev/notification/notification-enable.md
浏览文件 @ f7d7c3d4
# Enabling Notification # Enabling Notification
To publish a notification, you must have notification enabled for your application. You can call the [requestEnableNotification()](../reference/apis/js-apis-notificationManager.md#notificationrequestenablenotification) API to display a dialog box prompting the user to enable notification for your application. Note that the dialog box is displayed only when the API is called for the first time. To publish a notification, you must have notification enabled for your application. You can call the [requestEnableNotification()](../reference/apis/js-apis-notificationManager.md#notificationmanagerrequestenablenotification) API to display a dialog box prompting the user to enable notification for your application. Note that the dialog box is displayed only when the API is called for the first time.
**Figure 1** Dialog box prompting the user to enable notification **Figure 1** Dialog box prompting the user to enable notification
![en-us_image_0000001416585590](figures/en-us_image_0000001416585590.png) ![en-us_image_0000001416585590](figures/en-us_image_0000001416585590.png)
- Touching **allow** enables notification for the application, and touching **ban** keeps notification disabled. - Touching **allow** enables notification for the application, and touching **ban** keeps notification disabled.
- The dialog box will not be displayed again when [requestEnableNotification()](../reference/apis/js-apis-notificationManager.md#notificationrequestenablenotification) is called later. The user can manually enable notification as follows. - The dialog box will not be displayed again when [requestEnableNotification()](../reference/apis/js-apis-notificationManager.md#notificationmanagerrequestenablenotification) is called later. The user can manually enable notification as follows.
| 1. Swipe down from the upper left corner of the device screen to access the notification panel. | 2. Touch the **Settings** icon in the upper right corner. On the notification screen, locate the target application.| 3. Toggle on **Allow notifications**. | | 1. Swipe down from the upper left corner of the device screen to access the notification panel. | 2. Touch the **Settings** icon in the upper right corner. On the notification screen, locate the target application.| 3. Toggle on **Allow notifications**. |
| ------------------------------------------------------------ | ------------------------------------------------------------ | ------------------------------------------------------------ | | ------------------------------------------------------------ | ------------------------------------------------------------ | ------------------------------------------------------------ |
...@@ -19,7 +19,7 @@ To publish a notification, you must have notification enabled for your applicati ...@@ -19,7 +19,7 @@ To publish a notification, you must have notification enabled for your applicati
## Available APIs ## Available APIs
For details about the APIs, see [@ohos.notificationManager](../reference/apis/js-apis-notificationManager.md#notificationrequestenablenotification). For details about the APIs, see [@ohos.notificationManager](../reference/apis/js-apis-notificationManager.md#notificationmanagerrequestenablenotification).
**Table 1** Notification APIs **Table 1** Notification APIs
......
en/application-dev/notification/notification-overview.md
浏览文件 @ f7d7c3d4
...@@ -24,4 +24,5 @@ A notification is generated by the notification sender and sent to the notificat ...@@ -24,4 +24,5 @@ A notification is generated by the notification sender and sent to the notificat
System applications also support notification-related configuration options, such as switches. The system configuration initiates a configuration request and sends the request to the notification subsystem for storage in the memory and database. System applications also support notification-related configuration options, such as switches. The system configuration initiates a configuration request and sends the request to the notification subsystem for storage in the memory and database.
**Figure 1** Notification service process
![en-us_image_0000001466582017](figures/en-us_image_0000001466582017.png) ![en-us_image_0000001466582017](figures/en-us_image_0000001466582017.png)
en/application-dev/notification/notification-subscription.md
浏览文件 @ f7d7c3d4
...@@ -48,23 +48,24 @@ The major APIs for notification subscription are described as follows. For detai ...@@ -48,23 +48,24 @@ The major APIs for notification subscription are described as follows. For detai
let subscriber = { let subscriber = {
onConsume: function (data) { onConsume: function (data) {
let req = data.request; let req = data.request;
console.info('[ANS] onConsume callback req.id: ' + req.id); console.info(`onConsume callback. req.id: ${req.id}`);
}, },
onCancel: function (data) { onCancel: function (data) {
let req = data.request; let req = data.request;
console.info('[ANS] onCancel callback req.id: : ' + req.id); console.info(`onCancel callback. req.id: ${req.id}`);
}, },
onUpdate: function (data) { onUpdate: function (data) {
console.info('[ANS] onUpdate in test'); let req = data.request;
console.info(`onUpdate callback. req.id: ${req.id}`);
}, },
onConnect: function () { onConnect: function () {
console.info('[ANS] onConnect in test'); console.info(`onConnect callback.}`);
}, },
onDisconnect: function () { onDisconnect: function () {
console.info('[ANS] onDisConnect in test'); console.info(`onDisconnect callback.}`);
}, },
onDestroy: function () { onDestroy: function () {
console.info('[ANS] onDestroy in test'); console.info(`onDestroy callback.}`);
}, },
}; };
``` ```
...@@ -74,9 +75,9 @@ The major APIs for notification subscription are described as follows. For detai ...@@ -74,9 +75,9 @@ The major APIs for notification subscription are described as follows. For detai
```ts ```ts
notificationSubscribe.subscribe(subscriber, (err, data) => { // This API uses an asynchronous callback to return the result. notificationSubscribe.subscribe(subscriber, (err, data) => { // This API uses an asynchronous callback to return the result.
if (err) { if (err) {
console.error(`[ANS] subscribe failed, code is ${err.code}, message is ${err.message}`); console.error(`Failed to subscribe notification. Code is ${err.code}, message is ${err.message}`);
return; return;
} }
console.info(`[ANS] subscribeTest success : + ${data}`); console.info(`Succeeded in subscribing to notification. Data: ${data}`);
}); });
``` ```
en/application-dev/notification/notification-with-wantagent.md
浏览文件 @ f7d7c3d4
...@@ -4,7 +4,7 @@ A [WantAgent](../reference/apis/js-apis-app-ability-wantAgent.md) object encapsu ...@@ -4,7 +4,7 @@ A [WantAgent](../reference/apis/js-apis-app-ability-wantAgent.md) object encapsu
Below you can see the process of adding a **WantAgent** object to a notification. The notification publisher requests a **WantAgent** object from the Ability Manager Service (AMS), and then sends a notification carrying the **WantAgent** object to the home screen. When the user touches the notification from the notification panel on the home screen, the **WantAgent** object is triggered. Below you can see the process of adding a **WantAgent** object to a notification. The notification publisher requests a **WantAgent** object from the Ability Manager Service (AMS), and then sends a notification carrying the **WantAgent** object to the home screen. When the user touches the notification from the notification panel on the home screen, the **WantAgent** object is triggered.
**Figure 1** Publishing a notification with a WantAgent object **Figure 1** Publishing a notification with a WantAgent object
![notification-with-wantagent](figures/notification-with-wantagent.png) ![notification-with-wantagent](figures/notification-with-wantagent.png)
...@@ -15,11 +15,11 @@ For details about the APIs, see [@ohos.app.ability.wantAgent](../reference/apis/ ...@@ -15,11 +15,11 @@ For details about the APIs, see [@ohos.app.ability.wantAgent](../reference/apis/
| Name| Description| | Name| Description|
| -------- | -------- | | -------- | -------- |
|getWantAgent(info: WantAgentInfo, callback: AsyncCallback&lt;WantAgent&gt;): void | Creates a **WantAgent** object.| | getWantAgent(info: WantAgentInfo, callback: AsyncCallback&lt;WantAgent&gt;): void | Creates a **WantAgent** object.|
|trigger(agent: WantAgent, triggerInfo: TriggerInfo, callback?: Callback&lt;CompleteData&gt;): void | Triggers a **WantAgent** object.| | trigger(agent: WantAgent, triggerInfo: TriggerInfo, callback?: Callback&lt;CompleteData&gt;): void | Triggers a **WantAgent** object.|
|cancel(agent: WantAgent, callback: AsyncCallback&lt;void&gt;): void | Cancels a **WantAgent** object.| | cancel(agent: WantAgent, callback: AsyncCallback&lt;void&gt;): void | Cancels a **WantAgent** object.|
|getWant(agent: WantAgent, callback: AsyncCallback&lt;Want&gt;): void | Obtains a **WantAgent** object.| | getWant(agent: WantAgent, callback: AsyncCallback&lt;Want&gt;): void | Obtains a **WantAgent** object.|
|equal(agent: WantAgent, otherAgent: WantAgent, callback: AsyncCallback&lt;boolean&gt;): void | Checks whether two **WantAgent** objects are equal.| | equal(agent: WantAgent, otherAgent: WantAgent, callback: AsyncCallback&lt;boolean&gt;): void | Checks whether two **WantAgent** objects are equal.|
## How to Develop ## How to Develop
...@@ -75,7 +75,7 @@ For details about the APIs, see [@ohos.app.ability.wantAgent](../reference/apis/ ...@@ -75,7 +75,7 @@ For details about the APIs, see [@ohos.app.ability.wantAgent](../reference/apis/
operationType: wantAgent.OperationType.SEND_COMMON_EVENT, operationType: wantAgent.OperationType.SEND_COMMON_EVENT,
requestCode: 0, requestCode: 0,
wantAgentFlags: [wantAgent.WantAgentFlags.CONSTANT_FLAG], wantAgentFlags: [wantAgent.WantAgentFlags.CONSTANT_FLAG],
} };
``` ```
4. Invoke the [getWantAgent()](../reference/apis/js-apis-app-ability-wantAgent.md#wantagentgetwantagent) API to create a **WantAgent** object. 4. Invoke the [getWantAgent()](../reference/apis/js-apis-app-ability-wantAgent.md#wantagentgetwantagent) API to create a **WantAgent** object.
...@@ -84,10 +84,10 @@ For details about the APIs, see [@ohos.app.ability.wantAgent](../reference/apis/ ...@@ -84,10 +84,10 @@ For details about the APIs, see [@ohos.app.ability.wantAgent](../reference/apis/
// Create a WantAgent object. // Create a WantAgent object.
wantAgent.getWantAgent(wantAgentInfo, (err, data) => { wantAgent.getWantAgent(wantAgentInfo, (err, data) => {
if (err) { if (err) {
console.error('[WantAgent]getWantAgent err=' + JSON.stringify(err)); console.error(`Failed to get want agent. Code is ${err.code}, message is ${err.message}`);
return; return;
} }
console.info('[WantAgent]getWantAgent success'); console.info('Succeeded in geting want agent.');
wantAgentObj = data; wantAgentObj = data;
}); });
``` ```
...@@ -112,10 +112,10 @@ For details about the APIs, see [@ohos.app.ability.wantAgent](../reference/apis/ ...@@ -112,10 +112,10 @@ For details about the APIs, see [@ohos.app.ability.wantAgent](../reference/apis/
notificationManager.publish(notificationRequest, (err) => { notificationManager.publish(notificationRequest, (err) => {
if (err) { if (err) {
console.error(`[ANS] publish failed, code is ${err.code}, message is ${err.message}`); console.error(`Failed to publish notification. Code is ${err.code}, message is ${err.message}`);
return; return;
} }
console.info(`[ANS] publish success`); console.info('Succeeded in publishing notification.');
}); });
``` ```
......
en/application-dev/notification/progress-bar-notification.md
浏览文件 @ f7d7c3d4
...@@ -27,10 +27,11 @@ In the [NotificationTemplate](../reference/apis/js-apis-inner-notification-notif ...@@ -27,10 +27,11 @@ In the [NotificationTemplate](../reference/apis/js-apis-inner-notification-notif
```ts ```ts
notificationManager.isSupportTemplate('downloadTemplate').then((data) => { notificationManager.isSupportTemplate('downloadTemplate').then((data) => {
console.info(`[ANS] isSupportTemplate success`); console.info(`[ANS] isSupportTemplate success`);
console.info('Succeeded in supporting download template notification.');
let isSupportTpl: boolean = data; // The value true means that the template of the downloadTemplate type is supported, and false means the opposite. let isSupportTpl: boolean = data; // The value true means that the template of the downloadTemplate type is supported, and false means the opposite.
// ... // ...
}).catch((err) => { }).catch((err) => {
console.error(`[ANS] isSupportTemplate failed, code is ${err.code}, message is ${err.message}`); console.error(`Failed to support download template notification. Code is ${err.code}, message is ${err.message}`);
}); });
``` ```
...@@ -61,9 +62,9 @@ In the [NotificationTemplate](../reference/apis/js-apis-inner-notification-notif ...@@ -61,9 +62,9 @@ In the [NotificationTemplate](../reference/apis/js-apis-inner-notification-notif
// Publish the notification. // Publish the notification.
notificationManager.publish(notificationRequest, (err) => { notificationManager.publish(notificationRequest, (err) => {
if (err) { if (err) {
console.error(`[ANS] publish failed, code is ${err.code}, message is ${err.message}`); console.error(`Failed to publish notification. Code is ${err.code}, message is ${err.message}`);
return; return;
} }
console.info(`[ANS] publish success `); console.info('Succeeded in publishing notification.');
}); });
``` ```
en/application-dev/notification/text-notification.md
浏览文件 @ f7d7c3d4
...@@ -3,8 +3,7 @@ ...@@ -3,8 +3,7 @@
You can publish basic notifications to send SMS messages, prompt messages, and advertisements. Available content types of basic notifications include normal text, long text, multi-line text, and picture-attached. You can publish basic notifications to send SMS messages, prompt messages, and advertisements. Available content types of basic notifications include normal text, long text, multi-line text, and picture-attached.
**Table 1** Basic notification content types
**Table 1** Basic notification content types
| Type| Description| | Type| Description|
| -------- | -------- | | -------- | -------- |
...@@ -13,16 +12,16 @@ You can publish basic notifications to send SMS messages, prompt messages, and a ...@@ -13,16 +12,16 @@ You can publish basic notifications to send SMS messages, prompt messages, and a
| NOTIFICATION_CONTENT_MULTILINE | Multi-line text notification.| | NOTIFICATION_CONTENT_MULTILINE | Multi-line text notification.|
| NOTIFICATION_CONTENT_PICTURE | Picture-attached notification.| | NOTIFICATION_CONTENT_PICTURE | Picture-attached notification.|
Notifications are displayed in the notification panel, which is the only supported subscriber to notifications. Below you can see two examples of the basic notification.
Notifications are displayed in the notification panel, which is the only system subscriber to notifications. Below you can see two examples of the basic notification.
**Figure 1** Examples of the basic notification **Figure 1** Examples of the basic notification
![en-us_image_0000001466462305](figures/en-us_image_0000001466462305.png) ![en-us_image_0000001466462305](figures/en-us_image_0000001466462305.png)
## Available APIs ## Available APIs
The following table describes the APIs for notification publishing. You specify the notification type by setting the [NotificationRequest](../reference/apis/js-apis-notificationManager.md#notificationrequest) parameter in the APIs. The following table describes the APIs for notification publishing. You specify the notification type by setting the [NotificationRequest](../reference/apis/js-apis-inner-notification-notificationRequest.md#notificationrequest) parameter in the APIs.
| Name| Description| | Name| Description|
| -------- | -------- | | -------- | -------- |
...@@ -55,14 +54,14 @@ The following table describes the APIs for notification publishing. You specify ...@@ -55,14 +54,14 @@ The following table describes the APIs for notification publishing. You specify
additionalText: 'test_additionalText', additionalText: 'test_additionalText',
} }
} }
} };
notificationManager.publish(notificationRequest, (err) => { notificationManager.publish(notificationRequest, (err) => {
if (err) { if (err) {
console.error(`[ANS] publish failed, code is ${err.code}, message is ${err.message}`); console.error(`Failed to publish notification. Code is ${err.code}, message is ${err.message}`);
return; return;
} }
console.info(`[ANS] publish success.`); console.info('Succeeded in publishing notification.');
}); });
``` ```
...@@ -84,15 +83,15 @@ The following table describes the APIs for notification publishing. You specify ...@@ -84,15 +83,15 @@ The following table describes the APIs for notification publishing. You specify
expandedTitle: 'test_expandedTitle', expandedTitle: 'test_expandedTitle',
} }
} }
} };
// Publish the notification. // Publish the notification.
notificationManager.publish(notificationRequest, (err) => { notificationManager.publish(notificationRequest, (err) => {
if (err) { if (err) {
console.error(`[ANS] publish failed, code is ${err.code}, message is ${err.message}`); console.error(`Failed to publish notification. Code is ${err.code}, message is ${err.message}`);
return; return;
} }
console.info(`[ANS] publish success.`); console.info('Succeeded in publishing notification.');
}); });
``` ```
...@@ -113,15 +112,15 @@ The following table describes the APIs for notification publishing. You specify ...@@ -113,15 +112,15 @@ The following table describes the APIs for notification publishing. You specify
lines: ['line_01', 'line_02', 'line_03', 'line_04'], lines: ['line_01', 'line_02', 'line_03', 'line_04'],
} }
} }
} };
// Publish the notification. // Publish the notification.
notificationManager.publish(notificationRequest, (err) => { notificationManager.publish(notificationRequest, (err) => {
if (err) { if (err) {
console.error(`[ANS] publish failed, code is ${err.code}, message is ${err.message}`); console.error(`Failed to publish notification. Code is ${err.code}, message is ${err.message}`);
return; return;
} }
console.info(`[ANS] publish success`); console.info('Succeeded in publishing notification.');
}); });
``` ```
...@@ -144,15 +143,15 @@ The following table describes the APIs for notification publishing. You specify ...@@ -144,15 +143,15 @@ The following table describes the APIs for notification publishing. You specify
picture: imagePixelMap picture: imagePixelMap
} }
} }
} };
// Publish the notification. // Publish the notification.
notificationManager.publish(notificationRequest, (err) => { notificationManager.publish(notificationRequest, (err) => {
if (err) { if (err) {
console.error(`[ANS] publish failed, code is ${err.code}, message is ${err.message}`); console.error(`Failed to publish notification. Code is ${err.code}, message is ${err.message}`);
return; return;
} }
console.info(`[ANS] publish success.`); console.info('Succeeded in publishing notification.');
}); });
``` ```
......
en/application-dev/quick-start/arkts-observed-and-objectlink.md
浏览文件 @ f7d7c3d4
...@@ -316,7 +316,7 @@ class StringArray extends Array<String> { ...@@ -316,7 +316,7 @@ class StringArray extends Array<String> {
Declare a class that extends from** Array**: **class StringArray extends Array\<String> {}** and create an instance of **StringArray**. The use of the **new** operator is required for the \@Observed class decorator to work properly. Declare a class that extends from **Array**: **class StringArray extends Array\<String> {}** and create an instance of **StringArray**. The use of the **new** operator is required for the \@Observed class decorator to work properly.
```ts ```ts
......
en/application-dev/quick-start/arkts-page-custom-components-lifecycle.md
浏览文件 @ f7d7c3d4
...@@ -19,7 +19,7 @@ The following lifecycle callbacks are provided for the lifecycle of a page, that ...@@ -19,7 +19,7 @@ The following lifecycle callbacks are provided for the lifecycle of a page, that
- [onBackPress](../reference/arkui-ts/ts-custom-component-lifecycle.md#onbackpress): Invoked when the user clicks the Back button. - [onBackPress](../reference/arkui-ts/ts-custom-component-lifecycle.md#onbackpress): Invoked when the user clicks the Back button.
The following lifecycle callbacks are provided for the lifecycle of a custom component, which is one decorated with \@Component: The following lifecycle callbacks are provided for the lifecycle of a component, that is, the lifecycle of a custom component decorated with \@Component:
- [aboutToAppear](../reference/arkui-ts/ts-custom-component-lifecycle.md#abouttoappear): Invoked when the custom component is about to appear. Specifically, it is invoked after a new instance of the custom component is created and before its **build** function is executed. - [aboutToAppear](../reference/arkui-ts/ts-custom-component-lifecycle.md#abouttoappear): Invoked when the custom component is about to appear. Specifically, it is invoked after a new instance of the custom component is created and before its **build** function is executed.
...@@ -134,7 +134,7 @@ struct MyComponent { ...@@ -134,7 +134,7 @@ struct MyComponent {
Child() Child()
} }
// When this.showChild is false, the Child child component is deleted, and Child aboutToDisappear is invoked. // When this.showChild is false, the Child child component is deleted, and Child aboutToDisappear is invoked.
Button('create or delete Child').onClick(() => { Button('delete Child').onClick(() => {
this.showChild = false; this.showChild = false;
}) })
// Because of the pushing from the current page to Page2, onPageHide is invoked. // Because of the pushing from the current page to Page2, onPageHide is invoked.
......
en/application-dev/quick-start/arkts-rendering-control-lazyforeach.md
浏览文件 @ f7d7c3d4
...@@ -76,14 +76,16 @@ interface DataChangeListener { ...@@ -76,14 +76,16 @@ interface DataChangeListener {
``` ```
| Declaration | Parameter Type | Description | | Declaration | Parameter Type | Description |
| ---------------------------------------- | -------------------------------------- | ---------------------------------------- | | ------------------------------------------------------------ | -------------------------------------- | ------------------------------------------------------------ |
| onDataReloaded():&nbsp;void | - | Invoked when all data is reloaded. | | onDataReloaded():&nbsp;void | - | Invoked when all data is reloaded. |
| onDataAdded(index:&nbsp;number):void | number | Invoked when data is added to the position indicated by the specified index.<br>**index**: index of the position where data is added. | | onDataAdded(index:&nbsp;number):void<sup>(deprecated)</sup> | number | Invoked when data is added to the position indicated by the specified index.<br>This API is deprecated since API version 8. You are advised to use **onDataAdd** instead.<br>**index**: index of the position where data is added.|
| onDataMoved(from:&nbsp;number,&nbsp;to:&nbsp;number):&nbsp;void | from:&nbsp;number,<br>to:&nbsp;number | Invoked when data is moved.<br>**from**: original position of data; **to**: target position of data.<br>**NOTE**<br>The ID must remain unchanged before and after data movement. If the ID changes, APIs for deleting and adding data must be called.| | onDataMoved(from:&nbsp;number,&nbsp;to:&nbsp;number):&nbsp;void<sup>(deprecated)</sup> | from:&nbsp;number,<br>to:&nbsp;number | Invoked when data is moved.<br>This API is deprecated since API version 8. You are advised to use **onDataMove** instead.<br>**from**: original position of data; **to**: target position of data.<br>**NOTE**<br>The ID must remain unchanged before and after data movement. If the ID changes, APIs for deleting and adding data must be called.|
| onDataChanged(index:&nbsp;number):&nbsp;void | number | Invoked when data in the position indicated by the specified index is changed.<br>**index**: listener for data changes. | | onDataDeleted(index: number):void<sup>(deprecated)</sup> | number | Invoked when data is deleted from the position indicated by the specified index. LazyForEach will update the displayed content accordingly.<br>This API is deprecated since API version 8. You are advised to use **onDataDelete** instead.<br>**index**: index of the position where data is deleted.|
| onDataAdd(index:&nbsp;number):&nbsp;void | number | Invoked when data is added to the position indicated by the specified index.<br>**index**: index of the position where data is added. | | onDataChanged(index:&nbsp;number):&nbsp;void<sup>(deprecated)</sup> | number | Invoked when data in the position indicated by the specified index is changed.<br>This API is deprecated since API version 8. You are advised to use **onDataChange** instead.<br>**index**: listener for data changes.|
| onDataMove(from:&nbsp;number,&nbsp;to:&nbsp;number):&nbsp;void | from:&nbsp;number,<br>to:&nbsp;number | Invoked when data is moved.<br>**from**: original position of data; **to**: target position of data.<br>**NOTE**<br>The ID must remain unchanged before and after data movement. If the ID changes, APIs for deleting and adding data must be called.| | onDataAdd(index:&nbsp;number):&nbsp;void<sup>8+</sup> | number | Invoked when data is added to the position indicated by the specified index.<br>**index**: index of the position where data is added.|
| onDataChanged(index:&nbsp;number):&nbsp;void | number | Invoked when data in the position indicated by the specified index is changed.<br>**index**: index of the position where data is changed.| | onDataMove(from:&nbsp;number,&nbsp;to:&nbsp;number):&nbsp;void<sup>8+</sup> | from:&nbsp;number,<br>to:&nbsp;number | Invoked when data is moved.<br>**from**: original position of data; **to**: target position of data.<br>**NOTE**<br>The ID must remain unchanged before and after data movement. If the ID changes, APIs for deleting and adding data must be called.|
| onDataDelete(index: number):void<sup>8+</sup> | number | Invoked when data is deleted from the position indicated by the specified index. LazyForEach will update the displayed content accordingly.<br>**index**: index of the position where data is deleted.<br>**NOTE**<br>Before **onDataDelete** is called, ensure that the corresponding data in **dataSource** has been deleted. Otherwise, undefined behavior will occur during page rendering.|
| onDataChange(index:&nbsp;number):&nbsp;void<sup>8+</sup> | number | Invoked when data in the position indicated by the specified index is changed.<br>**index**: index of the position where data is changed.|
## Restrictions ## Restrictions
......
en/application-dev/quick-start/atomicService-aging.md
浏览文件 @ f7d7c3d4
...@@ -4,7 +4,7 @@ Space management for atomic services is necessary from two aspects. On the one h ...@@ -4,7 +4,7 @@ Space management for atomic services is necessary from two aspects. On the one h
## Managing Quota for Atomic Service Data Directories ## Managing Quota for Atomic Service Data Directories
Set a storage quota for the data sandbox directory of an atomic service. This quota can be obtained through the system parameter **persist.sys.bms.aging.policy.atomicservice.datasize.threshold**. The default value is 1024 MB. When the quota is used up, writing data will return an error message. Set a storage quota for the data sandbox directory of an atomic service. This quota can be obtained through the system parameter **persist.sys.bms.aging.policy.atomicservice.datasize.threshold**. The default value is 50 MB. When the quota is used up, writing data will return an error message.
You can run the [param get/set](../../device-dev/subsystems/subsys-boot-init-plugin.md) command to view and set system parameters. You can run the [param get/set](../../device-dev/subsystems/subsys-boot-init-plugin.md) command to view and set system parameters.
......
en/application-dev/quick-start/cross-app-hsp.md
浏览文件 @ f7d7c3d4
...@@ -17,34 +17,29 @@ An inter-application HSP works by combining the following parts: ...@@ -17,34 +17,29 @@ An inter-application HSP works by combining the following parts:
HSP: contains the actual implementation code, including the JS/TS code, C++ libraries, resources, and configuration files. It is either released to the application market or integrated into the system version. HSP: contains the actual implementation code, including the JS/TS code, C++ libraries, resources, and configuration files. It is either released to the application market or integrated into the system version.
### Integrating the HAR in an Inter-Application HSP ### Integrating the HAR in an Inter-Application HSP
Define the interfaces to be exported in the **index.d.ets** file in the HAR, which is the entry to the declaration file exported by the inter-application HSP. The path of the **index.d.ets** file is as follows: Define the interfaces to be exported in the **index.ets** file in the HAR, which is the entry to the declaration file exported by the inter-application HSP. The path to the **index.ets** file is as follows:
``` ```
src liba
├── main ├── src
| └── module.json5 │ └── main
├── index.d.ets │ ├── ets
│ │ ├── pages
│ │ └── index.ets
│ ├── resources
│ └── module.json5
└── oh-package.json5 └── oh-package.json5
``` ```
Below is an example of the **index.d.ets** file content: Below is an example of the **index.ets** file content:
```ts
@Component
export declare struct UIComponent {
build():void;
}
export declare function hello(): string;
export declare function foo1(): string;
export declare function foo2(): string; ```ts
// liba/src/main/ets/index.ets
export declare function nativeHello(): string; export { hello, foo1, foo2, nativeMulti, UIComponent } from './ui/MyUIComponent'
``` ```
In the example, **UIComponent** is an ArkUI component, **hello()**, **foo1()**, and **foo2()** are TS methods, and **nativeHello()** is a native method. Specific implementation is as follows: In the example, **UIComponent** is an ArkUI component, **hello()**, **foo1()**, and **foo2()** are TS methods, and **nativeMulti()** is a native method. Specific implementation is as follows:
#### ArkUI Components #### ArkUI Components
The following is an implementation example of ArkUI components in the HSP: The following is an implementation example of ArkUI components in the HSP:
```ts ```ts
// lib/src/main/ets/ui/MyUIComponent.ets // liba/src/main/ets/ui/MyUIComponent.ets
@Component @Component
export struct UIComponent { export struct UIComponent {
@State message: string = 'Hello World' @State message: string = 'Hello World'
...@@ -63,6 +58,7 @@ export struct UIComponent { ...@@ -63,6 +58,7 @@ export struct UIComponent {
#### **TS Methods** #### **TS Methods**
The following is an implementation example of TS methods in the HSP: The following is an implementation example of TS methods in the HSP:
```ts ```ts
// liba/src/main/ets/ui/MyUIComponent.ets
export function hello(name: string): string { export function hello(name: string): string {
return "hello + " + name; return "hello + " + name;
} }
...@@ -74,50 +70,22 @@ export function foo1() { ...@@ -74,50 +70,22 @@ export function foo1() {
export function foo2() { export function foo2() {
return "foo2"; return "foo2";
} }
``` ```
#### **Native Methods** #### **Native Methods**
The following is an implementation example of native methods in the HSP: The HSP can contain .so files compiled in C++. The HSP indirectly exports the native method in the .so file. In this example, the **multi** API in the **libnative.so** file is exported.
```C++
#include "napi/native_api.h"
#include <js_native_api.h>
#include <js_native_api_types.h>
#include <string>
const std::string libname = "liba";
const std::string version = "v10001";
static napi_value Hello(napi_env env, napi_callback_info info) {
napi_value ret;
std::string msg = libname + ":native hello, " + version;
napi_create_string_utf8(env, msg.c_str(), msg.length(), &ret);
return ret;
}
EXTERN_C_START ```ts
static napi_value Init(napi_env env, napi_value exports) { // liba/src/main/ets/ui/MyUIComponent.ets
napi_property_descriptor desc[] = { import native from "libnative.so"
{"nativeHello", nullptr, Hello, nullptr, nullptr, nullptr, napi_default, nullptr}};
napi_define_properties(env, exports, sizeof(desc) / sizeof(desc[0]), desc); export function nativeMulti(a: number, b: number) {
return exports; return native.multi(a, b);
}
EXTERN_C_END
static napi_module demoModule = {
.nm_version = 1,
.nm_flags = 0,
.nm_filename = nullptr,
.nm_register_func = Init,
.nm_modname = "liba",
.nm_priv = ((void *)0),
.reserved = {0},
};
extern "C" __attribute__((constructor)) void RegisterLibaModule(void) {
napi_module_register(&demoModule);
} }
``` ```
### Using the Capabilities Exported from the HAR ### Using the Capabilities Exported from the HAR
To start with, [configure dependency](https://developer.harmonyos.com/cn/docs/documentation/doc-guides/ohos-development-npm-package-0000001222578434#section89674298391) on the HAR. The dependency information will then be generated in the **module.json5** file of the corresponding module, as shown in the following: To start with, [configure dependency](https://developer.harmonyos.com/cn/docs/documentation/doc-guides-V3/creating_har_api9-0000001518082393-V3#section611662614153) on the HAR. The dependency information will then be generated in the **module.json5** file of the corresponding module, as shown in the following:
```json ```json
"dependencies": [ "dependencies": [
{ {
...@@ -180,7 +148,7 @@ struct Index { ...@@ -180,7 +148,7 @@ struct Index {
#### Referencing Native Methods in the HAR #### Referencing Native Methods in the HAR
To reference the native methods exported from the HAR, use **import** as follows: To reference the native methods exported from the HAR, use **import** as follows:
``` ts ``` ts
import { nativeHello } from 'liba' import { nativeMulti } from 'liba'
@Component @Component
struct Index { struct Index {
...@@ -190,7 +158,7 @@ struct Index { ...@@ -190,7 +158,7 @@ struct Index {
Button('Button') Button('Button')
.onClick(()=>{ .onClick(()=>{
// Reference the native method in the HAR. // Reference the native method in the HAR.
nativeHello(); nativeMulti();
}) })
} }
.width('100%') .width('100%')
...@@ -207,11 +175,6 @@ Inter-application HSPs are not completely integrated into an application. They a ...@@ -207,11 +175,6 @@ Inter-application HSPs are not completely integrated into an application. They a
### Inter-Application HSP Debugging Mode ### Inter-Application HSP Debugging Mode
You can debug an inter-application HSP after it is distributed to a device. If the aforementioned distribution methods are not applicable, you can distribute the HSP by running **bm** commands. The procedure is as follows: You can debug an inter-application HSP after it is distributed to a device. If the aforementioned distribution methods are not applicable, you can distribute the HSP by running **bm** commands. The procedure is as follows:
> **NOTE**
>
> Do not reverse steps 2 and 3. Otherwise, your application will fail to be installed due to a lack of the required inter-application HSP. For more information about the **bm** commands, see [Bundle Management](../../readme/bundle-management.md).
1. Obtain the inter-application HSP installation package. 1. Obtain the inter-application HSP installation package.
2. Run the following **bm** command to install the inter-application HSP. 2. Run the following **bm** command to install the inter-application HSP.
``` ```
...@@ -222,3 +185,7 @@ bm install -s sharebundle.hsp ...@@ -222,3 +185,7 @@ bm install -s sharebundle.hsp
bm install -p feature.hap bm install -p feature.hap
``` ```
4. Start your application and start debugging. 4. Start your application and start debugging.
> **NOTE**
>
> Do not reverse steps 2 and 3. Otherwise, your application will fail to be installed due to a lack of the required inter-application HSP. For more information about the **bm** commands, see [bm Commands](../../readme/bundle-management.md#bm-commands).
\ No newline at end of file
en/application-dev/quick-start/har-package.md
浏览文件 @ f7d7c3d4
...@@ -2,7 +2,7 @@ ...@@ -2,7 +2,7 @@
A Harmony Archive (HAR) is a static shared package that can contain code, C++ libraries, resources, and configuration files. It enables modules and projects to share code related to ArkUI components, resources, and more. Unlike a Harmony Ability Package (HAP), a HAR cannot be independently installed on a device. Instead, it can be referenced only as the dependency of an application module. A Harmony Archive (HAR) is a static shared package that can contain code, C++ libraries, resources, and configuration files. It enables modules and projects to share code related to ArkUI components, resources, and more. Unlike a Harmony Ability Package (HAP), a HAR cannot be independently installed on a device. Instead, it can be referenced only as the dependency of an application module.
## Creating a HAR Module ## Creating a HAR Module
You can kickstart your HAR module development with the module template of the **Library** type in DevEco Studio. By default, obfuscation is disabled for the HAR module. To enable this feature, set **artifactType** in the **build-profile.json5** file of the HAR module to **obfuscation** as follows: You can [create a HAR module in DevEco Studio](https://developer.harmonyos.com/cn/docs/documentation/doc-guides-V3/creating_har_api9-0000001518082393-V3#section143510369612). To better protect your source code, enable obfuscation for the HAR module so that DevEco Studio compiles, obfuscates, and compresses code during HAR building. To enable obfuscation, open the **build-profile.json5** file of the HAR module and set **artifactType** to **obfuscation** as follows:
```json ```json
{ {
...@@ -12,15 +12,13 @@ You can kickstart your HAR module development with the module template of the ** ...@@ -12,15 +12,13 @@ You can kickstart your HAR module development with the module template of the **
} }
} }
``` ```
The value options of **artifactType** are as follows, and the default value is **original**: The value options of **artifactType** are as follows, with the default value being **original**:
- **original**: Code is not obfuscated. - **original**: Code is not obfuscated.
- **obfuscation**: Code is obfuscated using Uglify. - **obfuscation**: Code is obfuscated using Uglify.
When obfuscation is enabled, DevEco Studio compiles, obfuscates, and compresses code during HAR building, thereby protecting your code assets.
> **NOTE** > **NOTE**
> >
> If **artifactType** is set to **obfuscation**, **apiType** must be set to **stageMode**, because obfuscation is available only in the stage model. > Obfuscation is available only in the stage model. Therefore, if **artifactType** is set to **obfuscation**, **apiType** must be set to **stageMode**.
## Precautions for HAR Development ## Precautions for HAR Development
- The HAR does not support the declaration of **abilities** and **extensionAbilities** in its configuration file. - The HAR does not support the declaration of **abilities** and **extensionAbilities** in its configuration file.
...@@ -88,12 +86,12 @@ export { func2 } from './src/main/ts/test' ...@@ -88,12 +86,12 @@ export { func2 } from './src/main/ts/test'
``` ```
### Resources ### Resources
Resources are packed into the HAR when it is being compiled and packaged. During compilation and building of a HAP, DevEco Studio collects resource files from the HAP module and its dependent modules. If the resource files of different modules have the same name, DevEco Studio overwrites the resource files based on the following priorities (in descending order): Resources are packed into the HAR when it is being compiled and packaged. During compilation and building of a HAP, DevEco Studio collects resource files from the HAP module and its dependent modules. If the resource files of different modules have the same name, DevEco Studio overwrites the resource files based on the following priorities (in descending order):
- AppScope (supported only by the stage model of API version 9) - AppScope (only for the stage model of API version 9)
- Modules in the HAP file - Modules in the HAP file
- If resource conflicts occur between dependent HAR modules, they are overwritten based on the dependency sequence. (The module that is higher in the dependency sequence list has higher priority.) - If resource conflicts occur between dependent HAR modules, they are overwritten based on the dependency sequence. (The module that is higher in the dependency sequence list has higher priority.)
## Referencing ArkUI Components, APIs, and Resources in the HAR ## Referencing ArkUI Components, APIs, and Resources in the HAR
To start with, [configure dependency](https://developer.harmonyos.com/cn/docs/documentation/doc-guides/ohos-development-npm-package-0000001222578434#section89674298391) on the HAR. To start with, [configure dependency](https://developer.harmonyos.com/cn/docs/documentation/doc-guides-V3/creating_har_api9-0000001518082393-V3#section611662614153) on the HAR.
### Reference ArkUI Components in the HAR ### Reference ArkUI Components in the HAR
...@@ -170,3 +168,7 @@ struct Index { ...@@ -170,3 +168,7 @@ struct Index {
} }
} }
``` ```
## Releasing a HAR
Follow the [instructions](https://developer.harmonyos.com/cn/docs/documentation/doc-guides-V3/creating_har_api9-0000001518082393-V3#section1213451811512) to release a HAR.
en/application-dev/quick-start/howto-migrate-cmake-with-ohosndk.md 0 → 100644
浏览文件 @ f7d7c3d4
# Using Native APIs (NDK) of the OHOS SDK in a CMake Project
## What Is Native API
For details, see [Native APIs](https://gitee.com/openharmony/docs/blob/master/en/application-dev/napi/Readme-EN.md).
## Downloading the NDK
You download the Native API Development Kit (NDK) by downloading the OHOS SDK, where the NDK is included. To download the OHOS SDK, use any of the following modes:
- (Recommended) Acquire source code from mirrors for an officially released version. For details, see [release notes](https://gitee.com/openharmony/docs/tree/master/en/release-notes#/openharmony/docs/blob/master/en/release-notes/OpenHarmony-v3.2-release.md).
- Download the SDK from the SDK Manager in DevEco Studio.
- Download the SDK from the [daily build](http://ci.openharmony.cn/dailys/dailybuilds), by clicking the download link to the ohos-sdk component.
![Download from Daily Build](figures/ci_download.png)
## Decompressing the NDK
Place the downloaded NDK in a folder you prefer and decompress it. Below shows the directory structure after decompression.
![SDK Directory Structure](figures/sdk-structure.png)
Configure the Linux environment as follows: (Skip this step if the NDK is downloaded from DevEco Studio.)
1. Add the CMake tool that comes with the NDK to the environment variables.
```
# Open the .bashrc file.
vim ~/.bashrc
# Append the custom CMake path to the file. Save the file and exit.
export PATH=~/ohos-sdk/ohos-sdk/linux/native/build-tools/cmake/bin:$PATH
# Run the source ~/.bashrc command to make the environment variables take effect.
source ~/.bashrc
```
2. Check the default CMake path.
```
# Run the which cmake command.
which cmake
# The result should be the same as the custom path previously appended to the file.
~/ohos-sdk/ohos-sdk/linux/native/build-tools/cmake/bin/cmake
```
## Using the NDK to Compile a Native Program
You can use the NDK to quickly develop a native program, including native dynamic libraries, static libraries, and executable files. The ArkUI application framework can call the native dynamic libraries through the NAPI framework. The following exemplifies how to use the NDK to compile a C/C++ dynamic library in a C/C++ demo project.
### Folders in the NDK
#### build Folder: ohos.toolchain.cmake file
The **ohos.toolchain.cmake** file contains the attributes of the CMake compilation target. Its path must be specified in the **CMAKE_TOOLCHAIN_FILE** parameter so that it can be located during CMake compilation. For details about the mandatory parameters in the **ohos.toolchain.cmake** file, see [Key Parameters in ohos.toolchain.cmake](#key-parameters-in-ohostoolchaincmake).
#### build-tools folder: Build Tool Provided by the NDK
```
# Run the following command to view the CMake version:
cmake -version
# Result
cmake version 3.16.5
CMake suite maintained and supported by Kitware (kitware.com/cmake).
```
#### llvm Folder: Compiler Provided by the NDK
![Compiler](figures/compiler.png)
### Demo Project for the NDK
#### Demo Project Directory
demo
├── CMakeLists.txt
├── include
└── sum.h
└── src
├── CMakeLists.txt
├── sum.cpp
└── hello.cpp
#### CMakeLists.txt in the demo Directory
```
# Specify the minimum CMake version.
CMAKE_MINIMUM_REQUIRED(VERSION 3.16)
# Set the project name, which is HELLO in this example.
PROJECT(HELLO)
# Add a subdirectory and build the subdirectory.
ADD_SUBDIRECTORY(src bin)
```
#### CMakeLists.txt in the src Directory
```
SET(LIBHELLO_SRC hello.cpp)
# Set compilation flags.
SET(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} -O0")
# Set the link parameter. The value below is only for exemplary purposes.
SET(CMAKE_EXE_LINKER_FLAGS "${CMAKE_EXE_LINKER_FLAGS} -Wl,--emit-relocs --verbose")
# Add a libsum dynamic library target. If the compilation is successful, a libsum.so file is generated.
ADD_LIBRARY(sum SHARED sum.cpp)
# Add the executable target called Hello. If the compilation is successful, a Hello executable is generated.
ADD_EXECUTABLE(Hello ${LIBHELLO_SRC})
# Specify the path to the include directory of the Hello target.
TARGET_INCLUDE_DIRECTORIES(Hello PUBLIC ../include)
# Specify the name of the library to be linked to the Hello target.
TARGET_LINK_LIBRARIES(Hello PUBLIC sum)
```
For details about CMake, see [CMake Tutorial](https://cmake.org/cmake/help/v3.16/guide/tutorial/).
#### Source Code
**hello.cpp** source code:
```
#include <iostream>
#include "sum.h"
int main(int argc,const char **argv)
{
std::cout<< "hello world!" <<std::endl;
int total = sum(1, 100);
std::cout<< "Sum 1 + 100=" << total << std::endl;
return 0;
}
```
**sum.h** source code:
```
int sum(int a, int b);
```
sum.cpp source code:
```
#include <iostream>
int sum(int a, int b)
{
return a + b;
}
```
### Key Parameters in ohos.toolchain.cmake
| Parameter | Type|Description|
|--------|------|------|
|OHOS_STL|c++\_shared/c++\_static|STL to use. The value must be consistent across the native libraries in the same application.<br>**c++\_shared** (default): The shared library of libc++, libc++\_shared.so, is used.<br>**c++\static**: The static library of libc++, libc++\_static.a, is used.|
|OHOS_ARCH|armeabi-v7a/arm64-v8a/x86_64|ABI to support. Currently, three types of ABI are supported.|
|OHOS_PLATFORM|OHOS|Target platform. Currently, only OHOS is supported.|
|CMAKE_TOOLCHAIN_FILE|Toolchain file|CMake toolchain file, that is, the aforementioned **ohos.toolchain.cmake** file.|
### Building from Command Line
In the project directory, create the **build** directory to store the intermediate files generated during CMake building.
> **NOTE**
>
> In the following commands, **ohos-sdk** is the root directory of the downloaded SDK. Replace it with the actual directory.
1. Use **OHOS_STL=c++_shared** for dynamic compilation.
```
>mkdir build && cd build
>cmake -DOHOS_STL=c++_shared -DOHOS_ARCH=armeabi-v7a -DOHOS_PLATFORM=OHOS -DCMAKE_TOOLCHAIN_FILE={ohos-sdk}/linux/native/build/cmake/ohos.toolchain.cmake ..
>cmake --build .
```
2. Use **OHOS_STL=c++_static** for static compilation.
```
>mkdir build && cd build
>cmake -DOHOS_STL=c++_static -DOHOS_ARCH=armeabi-v7a -DOHOS_PLATFORM=OHOS -DCMAKE_TOOLCHAIN_FILE={ohos-sdk}/linux/native/build/cmake/ohos.toolchain.cmake ..
>cmake --build .
```
<!--no_check-->
\ No newline at end of file
en/application-dev/quick-start/in-app-hsp.md
浏览文件 @ f7d7c3d4
...@@ -5,7 +5,7 @@ The in-application HSP is released with the Application Package (App Pack) of th ...@@ -5,7 +5,7 @@ The in-application HSP is released with the Application Package (App Pack) of th
## Developing an In-Application HSP ## Developing an In-Application HSP
You can kickstart your HSP development with the HSP template in DevEco Studio. In this example, an HSP module named **library** is created. The basic project directory structure is as follows: [Create an HSP module in DevEco Studio](https://developer.harmonyos.com/cn/docs/documentation/doc-guides-V3/hsp-0000001521396322-V3#section7717162312546). In this example, an HSP module named **library** is created. The basic project directory structure is as follows:
``` ```
library library
├── src ├── src
...@@ -88,7 +88,7 @@ if **Image("common/example.png")** is used in the HSP module, the **\<Image>** c ...@@ -88,7 +88,7 @@ if **Image("common/example.png")** is used in the HSP module, the **\<Image>** c
### Exporting Native Methods ### Exporting Native Methods
The HSP can contain .so files compiled in C++. The HSP indirectly exports the native method in the .so file. In this example, the **multi** method in the **libnative.so** file is exported. The HSP can contain .so files compiled in C++. The HSP indirectly exports the native method in the .so file. In this example, the **multi** method in the **libnative.so** file is exported.
```ts ```ts
// ibrary/src/main/ets/utils/nativeTest.ts // library/src/main/ets/utils/nativeTest.ts
import native from "libnative.so" import native from "libnative.so"
export function nativeMulti(a: number, b: number) { export function nativeMulti(a: number, b: number) {
...@@ -103,15 +103,9 @@ export { nativeMulti } from './utils/nativeTest' ...@@ -103,15 +103,9 @@ export { nativeMulti } from './utils/nativeTest'
``` ```
## Using the In-Application HSP ## Using the In-Application HSP
To use APIs in the HSP, first configure the dependency on the HSP in the **oh-package.json5** file of the module that needs to call the APIs (called the invoking module). If the HSP and the invoking module are in the same project, the APIs can be referenced locally. The sample code is as follows: To use APIs in the HSP, first [configure the dependency](https://developer.harmonyos.com/cn/docs/documentation/doc-guides-V3/hsp-0000001521396322-V3#section6161154819195) on the HSP in the **oh-package.json5** file of the module that needs to call the APIs (called the invoking module).
```json You can then call the external APIs of the HSP in the same way as calling the APIs in the HAR. In this example, the external APIs are the following ones exported from **library**:
// entry/oh-package.json5
"dependencies": {
"library": "file:../library"
}
```
You can now call the external APIs of the HSP in the same way as calling the APIs in the HAR.
In this example, the external APIs are the following ones exported from **library**:
```ts ```ts
// library/src/main/ets/index.ets // library/src/main/ets/index.ets
export { Log, add, minus } from './utils/test' export { Log, add, minus } from './utils/test'
......
en/application-dev/quick-start/module-configuration-file.md
浏览文件 @ f7d7c3d4
...@@ -309,7 +309,7 @@ Set **icon**, **label**, and **skills** under **abilities** in the **module.json ...@@ -309,7 +309,7 @@ Set **icon**, **label**, and **skills** under **abilities** in the **module.json
| [metadata](#metadata)| Metadata information of the UIAbility component.| Object array| Yes (initial value: left empty)| | [metadata](#metadata)| Metadata information of the UIAbility component.| Object array| Yes (initial value: left empty)|
| exported | Whether the UIAbility component can be called by other applications.<br>- **true**: The UIAbility component can be called by other applications.<br>- **false**: The UIAbility component cannot be called by other applications.| Boolean| Yes (initial value: **false**)| | exported | Whether the UIAbility component can be called by other applications.<br>- **true**: The UIAbility component can be called by other applications.<br>- **false**: The UIAbility component cannot be called by other applications.| Boolean| Yes (initial value: **false**)|
| continuable | Whether the UIAbility component can be [migrated](../application-models/hop-cross-device-migration.md).<br>- **true**: The UIAbility component can be migrated.<br>- **false**: The UIAbility component cannot be migrated.| Boolean| Yes (initial value: **false**)| | continuable | Whether the UIAbility component can be [migrated](../application-models/hop-cross-device-migration.md).<br>- **true**: The UIAbility component can be migrated.<br>- **false**: The UIAbility component cannot be migrated.| Boolean| Yes (initial value: **false**)|
| [skills](#skills) | Feature set of [wants](../application-models/want-overview.md) that can be received by the current UIAbility or ExtensionAbility component.<br>Configuring rule:<br>- For HAPs of the entry type, you can configure multiple **skills** attributes with the entry capability for an OpenHarmony application. (A **skills** attribute with the entry capability is the one that has **ohos.want.action.home** and **entity.system.home** configured.)<br>- For HAPs of the feature type, you can configure **skills** attributes with the entry capability for an OpenHarmony application, but not for an OpenHarmony service.| Object array| Yes (initial value: left empty)| | [skills](#skills) | Feature set of [wants](../application-models/want-overview.md) that can be received by the current UIAbility or ExtensionAbility component.<br>Configuration rules:<br>- For HAPs of the entry type, you can configure multiple **skills** attributes with the entry capability for an OpenHarmony application. (A **skills** attribute with the entry capability is the one that has **ohos.want.action.home** and **entity.system.home** configured.)<br>- For HAPs of the feature type, you can configure **skills** attributes with the entry capability for an OpenHarmony application, but not for an OpenHarmony service.| Object array| Yes (initial value: left empty)|
| backgroundModes | Continuous tasks of the UIAbility component. <br>Continuous tasks are classified into the following types:<br>- **dataTransfer**: service for downloading, backing up, sharing, or transferring data from the network or peer devices.<br>- **audioPlayback**: audio playback service.<br>- **audioRecording**: audio recording service.<br>- **location**: location and navigation services.<br>- **bluetoothInteraction**: Bluetooth scanning, connection, and transmission services (wearables).<br>- **multiDeviceConnection**: multi-device interconnection service.<br>- **wifiInteraction**: Wi-Fi scanning, connection, and transmission services (as used in the Multi-screen Collaboration and clone features)<br>- **voip**: voice/video call and VoIP services.<br>- **taskKeeping**: computing service.| String array| Yes (initial value: left empty)| | backgroundModes | Continuous tasks of the UIAbility component. <br>Continuous tasks are classified into the following types:<br>- **dataTransfer**: service for downloading, backing up, sharing, or transferring data from the network or peer devices.<br>- **audioPlayback**: audio playback service.<br>- **audioRecording**: audio recording service.<br>- **location**: location and navigation services.<br>- **bluetoothInteraction**: Bluetooth scanning, connection, and transmission services (wearables).<br>- **multiDeviceConnection**: multi-device interconnection service.<br>- **wifiInteraction**: Wi-Fi scanning, connection, and transmission services (as used in the Multi-screen Collaboration and clone features)<br>- **voip**: voice/video call and VoIP services.<br>- **taskKeeping**: computing service.| String array| Yes (initial value: left empty)|
| startWindowIcon | Index to the icon file of the UIAbility component startup page. Example: **$media:icon**.<br>The value is a string with a maximum of 255 bytes.| String| No| | startWindowIcon | Index to the icon file of the UIAbility component startup page. Example: **$media:icon**.<br>The value is a string with a maximum of 255 bytes.| String| No|
| startWindowBackground | Index to the background color resource file of the UIAbility component startup page. Example: **$color:red**.<br>The value is a string with a maximum of 255 bytes.| String| No| | startWindowBackground | Index to the background color resource file of the UIAbility component startup page. Example: **$color:red**.<br>The value is a string with a maximum of 255 bytes.| String| No|
......
en/application-dev/quick-start/quickfix-principles.md
浏览文件 @ f7d7c3d4
...@@ -10,7 +10,7 @@ Quick fix is a technical means provided by the OpenHarmony system for developers ...@@ -10,7 +10,7 @@ Quick fix is a technical means provided by the OpenHarmony system for developers
* The bundle name and application version number configured in the quick fix package must be the same as those of the installed application. Otherwise, the deployment will fail. * The bundle name and application version number configured in the quick fix package must be the same as those of the installed application. Otherwise, the deployment will fail.
* Make sure the version of the quick fix package to deploy is later than that of the one previously deployed. Otherwise, the deployment will fail. * Make sure the version of the quick fix package to deploy is later than that of the one previously deployed. Otherwise, the deployment will fail.
* The signature information of the quick fix package must be the same as that of the application to be fixed. Otherwise, the deployment will fail. * The signature information of the quick fix package must be the same as that of the application to be fixed. Otherwise, the deployment will fail.
* Installing an application update will delete quick fix package. * Installing an application update will delete the quick fix package.
## Structure of the Quick Fix Package ## Structure of the Quick Fix Package
...@@ -18,7 +18,7 @@ Quick fix is a technical means provided by the OpenHarmony system for developers ...@@ -18,7 +18,7 @@ Quick fix is a technical means provided by the OpenHarmony system for developers
<br>The preceding figure shows the structure of the quick fix package released by an OpenHarmony application. <br>The preceding figure shows the structure of the quick fix package released by an OpenHarmony application.
* As shown in the figure, the quick fix package comes in two formats: * As shown in the figure, the quick fix package comes in two formats:
* .appqf (Application Quick Fix) * .appqf (Application Quick Fix)
<br> There is a one-to-one mapping between the .appqf file and App Pack of an application. For details, see [Application Package Structure in Stage Model](application-package-structure-stage). <br> There is a one-to-one mapping between the .appqf file and App Pack of an application. For details, see [Application Package Structure in Stage Model](application-package-structure-stage.md).
* The .appqf file is used to release OpenHarmony applications to the application market and cannot be directly installed on devices. * The .appqf file is used to release OpenHarmony applications to the application market and cannot be directly installed on devices.
* An .appqf file consists of one or more .hqf (Harmony Ability Package Quick Fix) files, which are extracted from the .appqf file by the application market and then distributed to specific devices. * An .appqf file consists of one or more .hqf (Harmony Ability Package Quick Fix) files, which are extracted from the .appqf file by the application market and then distributed to specific devices.
* The .appqf file must contain the developer's signature information before being released to the application market. For details about how to sign the file, see [hapsigner Overview](../security/hapsigntool-overview.md). * The .appqf file must contain the developer's signature information before being released to the application market. For details about how to sign the file, see [hapsigner Overview](../security/hapsigntool-overview.md).
......
en/application-dev/quick-start/start-with-ets-fa.md
浏览文件 @ f7d7c3d4
...@@ -10,7 +10,7 @@ ...@@ -10,7 +10,7 @@
## Creating an ArkTS 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 **Choose Your Ability Template** page, select **Application** (or **Atomic Service**, depending on your project), select **Empty Ability** as the template, and click Next. 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 **Choose Your Ability Template** page, select **Application** (or **Atomic Service**, depending on your project), select **Empty Ability** as the template, and click **Next**.
![createProject](figures/createProject.png) ![createProject](figures/createProject.png)
......
en/application-dev/quick-start/start-with-ets-stage.md
浏览文件 @ f7d7c3d4
...@@ -10,7 +10,7 @@ ...@@ -10,7 +10,7 @@
## Creating an ArkTS 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 **Choose Your Ability Template** page, select **Application** (or **Atomic Service**, depending on your project), select **Empty Ability** as the template, and click Next. 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 **Choose Your Ability Template** page, select **Application** (or **Atomic Service**, depending on your project), select **Empty Ability** as the template, and click **Next**.
![createProject](figures/createProject.png) ![createProject](figures/createProject.png)
......
en/application-dev/quick-start/start-with-js-fa.md
浏览文件 @ f7d7c3d4
...@@ -8,7 +8,7 @@ ...@@ -8,7 +8,7 @@
## Creating a JavaScript Project ## Creating a JavaScript 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 **Choose Your Ability Template** page, select **Application** (or **Atomic Service**, depending on your project), select **Empty Ability** as the template, and click Next. 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 **Choose Your Ability Template** page, select **Application** (or **Atomic Service**, depending on your project), select **Empty Ability** as the template, and click **Next**.
![createProject](figures/createProject.png) ![createProject](figures/createProject.png)
......
en/application-dev/reference/apis/Readme-EN.md
浏览文件 @ f7d7c3d4
...@@ -120,6 +120,7 @@ ...@@ -120,6 +120,7 @@
- [@ohos.events.emitter (Emitter)](js-apis-emitter.md) - [@ohos.events.emitter (Emitter)](js-apis-emitter.md)
- [@ohos.notificationManager (NotificationManager) (Recommended)](js-apis-notificationManager.md) - [@ohos.notificationManager (NotificationManager) (Recommended)](js-apis-notificationManager.md)
- [@ohos.notificationSubscribe (NotificationSubscribe) (Recommended)](js-apis-notificationSubscribe.md) - [@ohos.notificationSubscribe (NotificationSubscribe) (Recommended)](js-apis-notificationSubscribe.md)
- [@ohos.application.StaticSubscriberExtensionContext (NotificationSubscribe) (Recommended)](js-apis-application-StaticSubscriberExtensionContext.md)
- [System Common Events (To Be Deprecated Soon)](commonEvent-definitions.md) - [System Common Events (To Be Deprecated Soon)](commonEvent-definitions.md)
- [@ohos.commonEvent (Common Event) (To Be Deprecated Soon)](js-apis-commonEvent.md) - [@ohos.commonEvent (Common Event) (To Be Deprecated Soon)](js-apis-commonEvent.md)
- [@ohos.notification (Notification) (To Be Deprecated Soon)](js-apis-notification.md) - [@ohos.notification (Notification) (To Be Deprecated Soon)](js-apis-notification.md)
...@@ -137,6 +138,10 @@ ...@@ -137,6 +138,10 @@
- [NotificationFlags](js-apis-inner-notification-notificationFlags.md) - [NotificationFlags](js-apis-inner-notification-notificationFlags.md)
- [NotificationRequest](js-apis-inner-notification-notificationRequest.md) - [NotificationRequest](js-apis-inner-notification-notificationRequest.md)
- [NotificationSlot](js-apis-inner-notification-notificationSlot.md) - [NotificationSlot](js-apis-inner-notification-notificationSlot.md)
- [NotificationSorting](js-apis-inner-notification-notificationSorting.md)
- [NotificationSortingMap](js-apis-inner-notification-notificationSortingMap.md)
- [NotificationSubscribeInfo](js-apis-inner-notification-notificationSubscribeInfo.md)
- [NotificationSubscriber](js-apis-inner-notification-notificationSubscriber.md)
- [NotificationTemplate](js-apis-inner-notification-notificationTemplate.md) - [NotificationTemplate](js-apis-inner-notification-notificationTemplate.md)
- [NotificationUserInput](js-apis-inner-notification-notificationUserInput.md) - [NotificationUserInput](js-apis-inner-notification-notificationUserInput.md)
- Common Events - Common Events
...@@ -320,7 +325,7 @@ ...@@ -320,7 +325,7 @@
- [@ohos.systemTimer (System Timer)](js-apis-system-timer.md) - [@ohos.systemTimer (System Timer)](js-apis-system-timer.md)
- [@ohos.wallpaper (Wallpaper)](js-apis-wallpaper.md) - [@ohos.wallpaper (Wallpaper)](js-apis-wallpaper.md)
- [@ohos.web.webview (Webview)](js-apis-webview.md) - [@ohos.web.webview (Webview)](js-apis-webview.md)
- [console (Log)](js-apis-logs.md) - [Console](js-apis-logs.md)
- [Timer](js-apis-timer.md) - [Timer](js-apis-timer.md)
- application - application
- [AccessibilityExtensionContext (Accessibility Extension Context)](js-apis-inner-application-accessibilityExtensionContext.md) - [AccessibilityExtensionContext (Accessibility Extension Context)](js-apis-inner-application-accessibilityExtensionContext.md)
...@@ -330,6 +335,7 @@ ...@@ -330,6 +335,7 @@
- [@ohos.batteryStatistics (Battery Statistics)](js-apis-batteryStatistics.md) - [@ohos.batteryStatistics (Battery Statistics)](js-apis-batteryStatistics.md)
- [@ohos.brightness (Screen Brightness)](js-apis-brightness.md) - [@ohos.brightness (Screen Brightness)](js-apis-brightness.md)
- [@ohos.charger (Charging Type)](js-apis-charger.md) - [@ohos.charger (Charging Type)](js-apis-charger.md)
- [@ohos.cooperate (Screen Hopping)](js-apis-devicestatus-cooperate.md)
- [@ohos.deviceInfo (Device Information)](js-apis-device-info.md) - [@ohos.deviceInfo (Device Information)](js-apis-device-info.md)
- [@ohos.distributedHardware.deviceManager (Device Management)](js-apis-device-manager.md) - [@ohos.distributedHardware.deviceManager (Device Management)](js-apis-device-manager.md)
- [@ohos.geoLocationManager (Geolocation Manager)](js-apis-geoLocationManager.md) - [@ohos.geoLocationManager (Geolocation Manager)](js-apis-geoLocationManager.md)
...@@ -366,6 +372,7 @@ ...@@ -366,6 +372,7 @@
- [@ohos.configPolicy (Configuration Policy)](js-apis-configPolicy.md) - [@ohos.configPolicy (Configuration Policy)](js-apis-configPolicy.md)
- [@ohos.enterprise.accountManager (Account Management)](js-apis-enterprise-accountManager.md) - [@ohos.enterprise.accountManager (Account Management)](js-apis-enterprise-accountManager.md)
- [@ohos.enterprise.adminManager (Enterprise Device Management)](js-apis-enterprise-adminManager.md) - [@ohos.enterprise.adminManager (Enterprise Device Management)](js-apis-enterprise-adminManager.md)
- [@ohos.enterprise.applicationManager (Application Management)](js-apis-enterprise-applicationManager.md)
- [@ohos.enterprise.bundleManager (Bundle Management)](js-apis-enterprise-bundleManager.md) - [@ohos.enterprise.bundleManager (Bundle Management)](js-apis-enterprise-bundleManager.md)
- [@ohos.enterprise.dateTimeManager (System Time Management)](js-apis-enterprise-dateTimeManager.md) - [@ohos.enterprise.dateTimeManager (System Time Management)](js-apis-enterprise-dateTimeManager.md)
- [@ohos.enterprise.deviceControl (Device Control Management)](js-apis-enterprise-deviceControl.md) - [@ohos.enterprise.deviceControl (Device Control Management)](js-apis-enterprise-deviceControl.md)
......
en/application-dev/reference/apis/js-apis-Bundle.md
浏览文件 @ f7d7c3d4
...@@ -904,7 +904,7 @@ bundle.getAllApplicationInfo(bundleFlags, userId, (err, data) => { ...@@ -904,7 +904,7 @@ bundle.getAllApplicationInfo(bundleFlags, userId, (err, data) => {
> This API is deprecated since API version 9. You are advised to use [bundleManager.getAllApplicationInfo](js-apis-bundleManager.md#bundlemanagergetallapplicationinfo) instead. > 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<Array\<ApplicationInfo>>) : void; getAllApplicationInfo(bundleFlags: number, callback: AsyncCallback\<Array\<ApplicationInfo\>\>): void;
Obtains the information about all applications of the current user. This API uses an asynchronous callback to return the result. Obtains the information about all applications of the current user. This API uses an asynchronous callback to return the result.
......
en/application-dev/reference/apis/js-apis-app-form-formExtensionAbility.md
浏览文件 @ f7d7c3d4
...@@ -25,7 +25,7 @@ import FormExtensionAbility from '@ohos.app.form.FormExtensionAbility'; ...@@ -25,7 +25,7 @@ import FormExtensionAbility from '@ohos.app.form.FormExtensionAbility';
onAddForm(want: Want): formBindingData.FormBindingData onAddForm(want: Want): formBindingData.FormBindingData
Called to notify the widget provider that a **Form** instance (widget) has been created. Called to notify the widget provider that a **Form** instance (widget) is being created.
**System capability**: SystemCapability.Ability.Form **System capability**: SystemCapability.Ability.Form
...@@ -49,7 +49,7 @@ import formBindingData from '@ohos.app.form.formBindingData'; ...@@ -49,7 +49,7 @@ import formBindingData from '@ohos.app.form.formBindingData';
export default class MyFormExtensionAbility extends FormExtensionAbility { export default class MyFormExtensionAbility extends FormExtensionAbility {
onAddForm(want) { onAddForm(want) {
console.log('FormExtensionAbility onAddForm, want: ${want.abilityName}'); console.log(`FormExtensionAbility onAddForm, want: ${want.abilityName}`);
let dataObj1 = { let dataObj1 = {
temperature: '11c', temperature: '11c',
'time': '11:00' 'time': '11:00'
...@@ -64,7 +64,7 @@ export default class MyFormExtensionAbility extends FormExtensionAbility { ...@@ -64,7 +64,7 @@ export default class MyFormExtensionAbility extends FormExtensionAbility {
onCastToNormalForm(formId: string): void onCastToNormalForm(formId: string): void
Called to notify the widget provider that a temporary widget has been converted to a normal one. Called to notify the widget provider that a temporary widget is being converted to a normal one.
**System capability**: SystemCapability.Ability.Form **System capability**: SystemCapability.Ability.Form
...@@ -81,7 +81,7 @@ import FormExtensionAbility from '@ohos.app.form.FormExtensionAbility'; ...@@ -81,7 +81,7 @@ import FormExtensionAbility from '@ohos.app.form.FormExtensionAbility';
export default class MyFormExtensionAbility extends FormExtensionAbility { export default class MyFormExtensionAbility extends FormExtensionAbility {
onCastToNormalForm(formId) { onCastToNormalForm(formId) {
console.log('FormExtensionAbility onCastToNormalForm, formId: ${formId}'); console.log(`FormExtensionAbility onCastToNormalForm, formId: ${formId}`);
} }
}; };
``` ```
...@@ -90,7 +90,7 @@ export default class MyFormExtensionAbility extends FormExtensionAbility { ...@@ -90,7 +90,7 @@ export default class MyFormExtensionAbility extends FormExtensionAbility {
onUpdateForm(formId: string): void onUpdateForm(formId: string): void
Called to notify the widget provider that a widget has been updated. After obtaining the latest data, your application should call [updateForm](js-apis-app-form-formProvider.md#updateform) of **formProvider** to update the widget data. Called to notify the widget provider that a widget is being updated. After obtaining the latest data, your application should call [updateForm](js-apis-app-form-formProvider.md#updateform) of **formProvider** to update the widget data.
**System capability**: SystemCapability.Ability.Form **System capability**: SystemCapability.Ability.Form
...@@ -109,15 +109,15 @@ import formProvider from '@ohos.app.form.formProvider'; ...@@ -109,15 +109,15 @@ import formProvider from '@ohos.app.form.formProvider';
export default class MyFormExtensionAbility extends FormExtensionAbility { export default class MyFormExtensionAbility extends FormExtensionAbility {
onUpdateForm(formId) { onUpdateForm(formId) {
console.log('FormExtensionAbility onUpdateForm, formId: ${formId}'); console.log(`FormExtensionAbility onUpdateForm, formId: ${formId}`);
let obj2 = formBindingData.createFormBindingData({ let obj2 = formBindingData.createFormBindingData({
temperature: '22c', temperature: '22c',
time: '22:00' time: '22:00'
}); });
formProvider.updateForm(formId, obj2).then((data) => { formProvider.updateForm(formId, obj2).then((data) => {
console.log('FormExtensionAbility context updateForm, data: ${data}'); console.log(`FormExtensionAbility context updateForm, data: ${data}`);
}).catch((error) => { }).catch((error) => {
console.error('Operation updateForm failed. Cause: ${error}'); console.error(`Operation updateForm failed. Cause: ${error}`);
}); });
} }
}; };
...@@ -127,7 +127,7 @@ export default class MyFormExtensionAbility extends FormExtensionAbility { ...@@ -127,7 +127,7 @@ export default class MyFormExtensionAbility extends FormExtensionAbility {
onChangeFormVisibility(newStatus: { [key: string]: number }): void onChangeFormVisibility(newStatus: { [key: string]: number }): void
Called to notify the widget provider of the change of visibility. Called to notify the widget provider that the widget visibility status is being changed.
**System capability**: SystemCapability.Ability.Form **System capability**: SystemCapability.Ability.Form
...@@ -146,18 +146,18 @@ import formProvider from '@ohos.app.form.formProvider'; ...@@ -146,18 +146,18 @@ import formProvider from '@ohos.app.form.formProvider';
export default class MyFormExtensionAbility extends FormExtensionAbility { export default class MyFormExtensionAbility extends FormExtensionAbility {
onChangeFormVisibility(newStatus) { onChangeFormVisibility(newStatus) {
console.log('FormExtensionAbility onChangeFormVisibility, newStatus: ${newStatus}'); console.log(`FormExtensionAbility onChangeFormVisibility, newStatus: ${newStatus}`);
let obj2 = formBindingData.createFormBindingData({ let obj2 = formBindingData.createFormBindingData({
temperature: '22c', temperature: '22c',
time: '22:00' time: '22:00'
}); });
for (let key in newStatus) { for (let key in newStatus) {
console.log('FormExtensionAbility onChangeFormVisibility, key: ${key}, value= ${newStatus[key]}'); console.log(`FormExtensionAbility onChangeFormVisibility, key: ${key}, value= ${newStatus[key]}`);
formProvider.updateForm(key, obj2).then((data) => { formProvider.updateForm(key, obj2).then((data) => {
console.log('FormExtensionAbility context updateForm, data: ${data}'); console.log(`FormExtensionAbility context updateForm, data: ${data}`);
}).catch((error) => { }).catch((error) => {
console.error('Operation updateForm failed. Cause: ${error}'); console.error(`Operation updateForm failed. Cause: ${error}`);
}); });
} }
} }
...@@ -168,7 +168,7 @@ export default class MyFormExtensionAbility extends FormExtensionAbility { ...@@ -168,7 +168,7 @@ export default class MyFormExtensionAbility extends FormExtensionAbility {
onFormEvent(formId: string, message: string): void onFormEvent(formId: string, message: string): void
Called to instruct the widget provider to receive and process the widget event. Called to instruct the widget provider to process the widget event.
**System capability**: SystemCapability.Ability.Form **System capability**: SystemCapability.Ability.Form
...@@ -186,7 +186,7 @@ import FormExtensionAbility from '@ohos.app.form.FormExtensionAbility'; ...@@ -186,7 +186,7 @@ import FormExtensionAbility from '@ohos.app.form.FormExtensionAbility';
export default class MyFormExtensionAbility extends FormExtensionAbility { export default class MyFormExtensionAbility extends FormExtensionAbility {
onFormEvent(formId, message) { onFormEvent(formId, message) {
console.log('FormExtensionAbility onFormEvent, formId: ${formId}, message: ${message}'); console.log(`FormExtensionAbility onFormEvent, formId: ${formId}, message: ${message}`);
} }
}; };
``` ```
...@@ -195,7 +195,7 @@ export default class MyFormExtensionAbility extends FormExtensionAbility { ...@@ -195,7 +195,7 @@ export default class MyFormExtensionAbility extends FormExtensionAbility {
onRemoveForm(formId: string): void onRemoveForm(formId: string): void
Called to notify the widget provider that a **Form** instance (widget) has been destroyed. Called to notify the widget provider that a **Form** instance (widget) is being destroyed.
**System capability**: SystemCapability.Ability.Form **System capability**: SystemCapability.Ability.Form
...@@ -212,7 +212,7 @@ import FormExtensionAbility from '@ohos.app.form.FormExtensionAbility'; ...@@ -212,7 +212,7 @@ import FormExtensionAbility from '@ohos.app.form.FormExtensionAbility';
export default class MyFormExtensionAbility extends FormExtensionAbility { export default class MyFormExtensionAbility extends FormExtensionAbility {
onRemoveForm(formId) { onRemoveForm(formId) {
console.log('FormExtensionAbility onRemoveForm, formId: ${formId}'); console.log(`FormExtensionAbility onRemoveForm, formId: ${formId}`);
} }
}; };
``` ```
...@@ -221,7 +221,7 @@ export default class MyFormExtensionAbility extends FormExtensionAbility { ...@@ -221,7 +221,7 @@ export default class MyFormExtensionAbility extends FormExtensionAbility {
onConfigurationUpdate(newConfig: Configuration): void; onConfigurationUpdate(newConfig: Configuration): void;
Called when the configuration of the environment where the ability is running is updated. Called when the configuration of the environment where the FormExtensionAbility is running is updated.
**System capability**: SystemCapability.Ability.Form **System capability**: SystemCapability.Ability.Form
...@@ -238,7 +238,7 @@ import FormExtensionAbility from '@ohos.app.form.FormExtensionAbility'; ...@@ -238,7 +238,7 @@ import FormExtensionAbility from '@ohos.app.form.FormExtensionAbility';
export default class MyFormExtensionAbility extends FormExtensionAbility { export default class MyFormExtensionAbility extends FormExtensionAbility {
onConfigurationUpdate(config) { onConfigurationUpdate(config) {
console.log('onConfigurationUpdate, config: ${JSON.stringify(config)}'); console.log(`onConfigurationUpdate, config: ${JSON.stringify(config)}`);
} }
}; };
``` ```
...@@ -247,7 +247,7 @@ export default class MyFormExtensionAbility extends FormExtensionAbility { ...@@ -247,7 +247,7 @@ export default class MyFormExtensionAbility extends FormExtensionAbility {
onAcquireFormState?(want: Want): formInfo.FormState; onAcquireFormState?(want: Want): formInfo.FormState;
Called when the widget provider receives the status query result of a widget. By default, the initial state is returned. Called to notify the widget provider that the widget host is requesting the widget state. By default, the initial state is returned.
**System capability**: SystemCapability.Ability.Form **System capability**: SystemCapability.Ability.Form
...@@ -265,7 +265,7 @@ import formInfo from '@ohos.app.form.formInfo'; ...@@ -265,7 +265,7 @@ import formInfo from '@ohos.app.form.formInfo';
export default class MyFormExtensionAbility extends FormExtensionAbility { export default class MyFormExtensionAbility extends FormExtensionAbility {
onAcquireFormState(want) { onAcquireFormState(want) {
console.log('FormExtensionAbility onAcquireFormState, want: ${want}'); console.log(`FormExtensionAbility onAcquireFormState, want: ${want}`);
return formInfo.FormState.UNKNOWN; return formInfo.FormState.UNKNOWN;
} }
}; };
...@@ -275,7 +275,7 @@ export default class MyFormExtensionAbility extends FormExtensionAbility { ...@@ -275,7 +275,7 @@ export default class MyFormExtensionAbility extends FormExtensionAbility {
onShareForm?(formId: string): { [key: string]: Object } onShareForm?(formId: string): { [key: string]: Object }
Called by the widget provider to receive shared widget data. Called to notify the widget provider that the widget host is sharing the widget data.
**System API**: This is a system API. **System API**: This is a system API.
...@@ -300,7 +300,46 @@ import FormExtensionAbility from '@ohos.app.form.FormExtensionAbility'; ...@@ -300,7 +300,46 @@ import FormExtensionAbility from '@ohos.app.form.FormExtensionAbility';
export default class MyFormExtensionAbility extends FormExtensionAbility { export default class MyFormExtensionAbility extends FormExtensionAbility {
onShareForm(formId) { onShareForm(formId) {
console.log('FormExtensionAbility onShareForm, formId: ${formId}'); console.log(`FormExtensionAbility onShareForm, formId: ${formId}`);
let wantParams = {
'temperature': '20',
'time': '2022-8-8 09:59',
};
return wantParams;
}
};
```
## onAcquireFormData<sup>10+</sup>
onAcquireFormData?(formId: string): { [key: string]: Object }
Called to notify the widget provider that the widget host is requesting the custom data.
**System API**: This is a system API.
**System capability**: SystemCapability.Ability.Form
**Parameters**
| Name| Type| Mandatory| Description|
| -------- | -------- | -------- | -------- |
| formId | string | Yes | Widget ID.|
**Return value**
| Type | Description |
| ------------------------------------------------------------ | ----------------------------------------------------------- |
| {[key: string]: any} | Custom data of the widget, in the form of key-value pairs.|
**Example**
```ts
import FormExtensionAbility from '@ohos.app.form.FormExtensionAbility';
export default class MyFormExtensionAbility extends FormExtensionAbility {
onAcquireFormData(formId) {
console.log('FormExtensionAbility onAcquireFormData, formId: ${formId}');
let wantParams = { let wantParams = {
'temperature': '20', 'temperature': '20',
'time': '2022-8-8 09:59', 'time': '2022-8-8 09:59',
......
en/application-dev/reference/apis/js-apis-app-form-formHost.md
浏览文件 @ f7d7c3d4
...@@ -2222,7 +2222,7 @@ try { ...@@ -2222,7 +2222,7 @@ try {
## getRunningFormInfosByFilter<sup>10+</sup> ## getRunningFormInfosByFilter<sup>10+</sup>
function getRunningFormInfosByFilter(formProviderFilter: formInfo.FormProviderFilter): Promise&lt;Array&lt;formInfo.RunningFormInfo&gt;&gt; getRunningFormInfosByFilter(formProviderFilter: formInfo.FormProviderFilter): Promise&lt;Array&lt;formInfo.RunningFormInfo&gt;&gt;
Obtains the information about widget hosts based on the widget provider information. This API uses a promise to return the result. Obtains the information about widget hosts based on the widget provider information. This API uses a promise to return the result.
...@@ -2273,7 +2273,7 @@ try { ...@@ -2273,7 +2273,7 @@ try {
## getRunningFormInfosByFilter<sup>10+</sup> ## getRunningFormInfosByFilter<sup>10+</sup>
function getRunningFormInfosByFilter(formProviderFilter: formInfo.FormProviderFilter, callback: AsyncCallback&lt;Array&lt;formInfo.FormInfo&gt;&gt;): void getRunningFormInfosByFilter(formProviderFilter: formInfo.FormProviderFilter, callback: AsyncCallback&lt;Array&lt;formInfo.FormInfo&gt;&gt;): void
Obtains the information about widget hosts based on the widget provider information. This API uses an asynchronous callback to return the result. Obtains the information about widget hosts based on the widget provider information. This API uses an asynchronous callback to return the result.
...@@ -2321,7 +2321,7 @@ try { ...@@ -2321,7 +2321,7 @@ try {
## getRunningFormInfoById<sup>10+</sup> ## getRunningFormInfoById<sup>10+</sup>
function getRunningFormInfoById(formId: string): Promise&lt;Array&lt;formInfo.RunningFormInfo&gt;&gt; getRunningFormInfoById(formId: string): Promise&lt;Array&lt;formInfo.RunningFormInfo&gt;&gt;
Obtains the information about widget hosts based on the widget ID. This API uses a promise to return the result. Obtains the information about widget hosts based on the widget ID. This API uses a promise to return the result.
...@@ -2366,7 +2366,7 @@ try { ...@@ -2366,7 +2366,7 @@ try {
## getRunningFormInfoById<sup>10+</sup> ## getRunningFormInfoById<sup>10+</sup>
function getRunningFormInfoById(formId: string, callback: AsyncCallback&lt;Array&lt;formInfo.FormInfo&gt;&gt;): void getRunningFormInfoById(formId: string, callback: AsyncCallback&lt;Array&lt;formInfo.FormInfo&gt;&gt;): void
Obtains the information about widget hosts based on the widget ID. This API uses an asynchronous callback to return the result. Obtains the information about widget hosts based on the widget ID. This API uses an asynchronous callback to return the result.
......
en/application-dev/reference/apis/js-apis-application-StaticSubscriberExtensionContext.md 0 → 100644
浏览文件 @ f7d7c3d4
# @ohos.application.StaticSubscriberExtensionContext (StaticSubscriberExtensionContext)
The **StaticSubscriberExtensionContext** module, inherited from **ExtensionContext**, provides context for StaticSubscriberExtensionAbilities.
You can use the APIs of this module to start StaticSubscriberExtensionAbilities.
> **NOTE**
>
> The initial APIs of this module are supported since API version 10. Newly added APIs will be marked with a superscript to indicate their earliest API version.
> The APIs of this module can be used only in the stage model.
## Usage
Before using the **StaticSubscriberExtensionContext** module, you must first obtain a **StaticSubscriberExtensionAbility** instance.
```ts
import StaticSubscriberExtensionAbility from '@ohos.application.StaticSubscriberExtensionAbility'
export default class MyStaticSubscriberExtensionAbility extends StaticSubscriberExtensionAbility {
context = this.context;
};
```
## StaticSubscriberExtensionContext.startAbility
startAbility(want: Want, callback: AsyncCallback&lt;void&gt;): void;
Starts an ability that belongs to the same application as this StaticSubscriberExtensionAbility. This API uses an asynchronous callback to return the result.
Observe the following when using this API:
- If an application running in the background needs to call this API to start an ability, it must have the **ohos.permission.START_ABILITIES_FROM_BACKGROUND** permission.
- If **visible** of the target ability is **false** in cross-application scenarios, the caller must have the **ohos.permission.START_INVISIBLE_ABILITY** permission.
**System capability**: SystemCapability.Ability.AbilityRuntime.Core
**System API**: This is a system API and cannot be called by third-party applications.
**Parameters**
| Name | Type | Mandatory| Description |
| -------- | ----------------------------------- | ---- | -------------------------- |
| want | [Want](js-apis-application-want.md) | Yes | Want information about the target ability. |
| callback | AsyncCallback&lt;void&gt; | Yes | Callback used to return the result.|
**Error codes**
For details about the error codes, see [Ability Error Codes](../errorcodes/errorcode-ability.md).
| ID| Error Message |
| -------- | ------------------------------------------------------------ |
| 16000001 | The specified ability does not exist. |
| 16000002 | Incorrect ability type. |
| 16000004 | Can not start invisible component. |
| 16000005 | The specified process does not have the permission. |
| 16000006 | Cross-user operations are not allowed. |
| 16000008 | The crowdtesting application expires. |
| 16000009 | An ability cannot be started or stopped in Wukong mode. |
| 16000011 | The context does not exist. |
| 16000050 | Internal error. |
| 16000053 | The ability is not on the top of the UI. |
| 16000055 | Installation-free timed out. |
| 16200001 | The caller has been released. |
| 16300003 | The target application is not self application. |
**Example**
```ts
let want = {
bundleName: "com.example.myapp",
abilityName: "MyAbility"
};
try {
this.context.startAbility(want, (error) => {
if (error) {
// Process service logic errors.
console.log('startAbility failed, error.code: ' + JSON.stringify(error.code) +
' error.message: ' + JSON.stringify(error.message));
return;
}
// Carry out normal service processing.
console.log('startAbility succeed');
});
} catch (paramError) {
// Process input parameter errors.
console.log('startAbility failed, error.code: ' + JSON.stringify(paramError.code) +
' error.message: ' + JSON.stringify(paramError.message));
}
```
## StaticSubscriberExtensionContext.startAbility
startAbility(want: Want): Promise&lt;void&gt;;
Starts an ability that belongs to the same application as this StaticSubscriberExtensionAbility. This API uses a promise to return the result.
Observe the following when using this API:
- If an application running in the background needs to call this API to start an ability, it must have the **ohos.permission.START_ABILITIES_FROM_BACKGROUND** permission.
- If **visible** of the target ability is **false** in cross-application scenarios, the caller must have the **ohos.permission.START_INVISIBLE_ABILITY** permission.
**System capability**: SystemCapability.Ability.AbilityRuntime.Core
**System API**: This is a system API and cannot be called by third-party applications.
**Parameters**
| Name| Type | Mandatory| Description |
| ------ | ----------------------------------- | ---- | ----------------------- |
| want | [Want](js-apis-application-want.md) | Yes | Want information about the target ability.|
**Return value**
| Type | Description |
| ------------------- | ------------------------- |
| Promise&lt;void&gt; | Promise used to return the result.|
**Error codes**
For details about the error codes, see [Ability Error Codes](../errorcodes/errorcode-ability.md).
| ID| Error Message |
| -------- | ------------------------------------------------------------ |
| 16000001 | The specified ability does not exist. |
| 16000002 | Incorrect ability type. |
| 16000004 | Can not start invisible component. |
| 16000005 | The specified process does not have the permission. |
| 16000006 | Cross-user operations are not allowed. |
| 16000008 | The crowdtesting application expires. |
| 16000009 | An ability cannot be started or stopped in Wukong mode. |
| 16000011 | The context does not exist. |
| 16000050 | Internal error. |
| 16000053 | The ability is not on the top of the UI. |
| 16000055 | Installation-free timed out. |
| 16200001 | The caller has been released. |
| 16300003 | The target application is not self application. |
**Example**
```ts
let want = {
bundleName: "com.example.myapp",
abilityName: "MyAbility"
};
try {
this.context.startAbility(want)
.then(() => {
// Carry out normal service processing.
console.log('startAbility succeed');
})
.catch((error) => {
// Process service logic errors.
console.log('startAbility failed, error.code: ' + JSON.stringify(error.code) +
' error.message: ' + JSON.stringify(error.message));
});
} catch (paramError) {
// Process input parameter errors.
console.log('startAbility failed, error.code: ' + JSON.stringify(paramError.code) +
' error.message: ' + JSON.stringify(paramError.message));
}
```
en/application-dev/reference/apis/js-apis-application-staticSubscriberExtensionAbility.md
浏览文件 @ f7d7c3d4
...@@ -13,6 +13,14 @@ The **StaticSubscriberExtensionAbility** module provides Extension abilities for ...@@ -13,6 +13,14 @@ The **StaticSubscriberExtensionAbility** module provides Extension abilities for
import StaticSubscriberExtensionAbility from '@ohos.application.StaticSubscriberExtensionAbility'; import StaticSubscriberExtensionAbility from '@ohos.application.StaticSubscriberExtensionAbility';
``` ```
## Attributes
**System capability**: SystemCapability.Ability.AbilityRuntime.AbilityCore
| Name | Type | Readable| Writable| Description |
| ------- | ------------------------------------------------------------ | ---- | ---- | -------- |
| context | [StaticSubscriberExtensionContext](js-apis-application-StaticSubscriberExtensionContext.md) | Yes | No | Context.|
## StaticSubscriberExtensionAbility.onReceiveEvent ## StaticSubscriberExtensionAbility.onReceiveEvent
onReceiveEvent(event: CommonEventData): void; onReceiveEvent(event: CommonEventData): void;
...@@ -30,7 +38,6 @@ Callback of the common event of a static subscriber. ...@@ -30,7 +38,6 @@ Callback of the common event of a static subscriber.
| event | [CommonEventData](js-apis-commonEventManager.md#commoneventdata) | Yes| Common event of a static subscriber.| | event | [CommonEventData](js-apis-commonEventManager.md#commoneventdata) | Yes| Common event of a static subscriber.|
**Example** **Example**
```ts ```ts
class MyStaticSubscriberExtensionAbility extends StaticSubscriberExtensionAbility { class MyStaticSubscriberExtensionAbility extends StaticSubscriberExtensionAbility {
onReceiveEvent(event) { onReceiveEvent(event) {
......
en/application-dev/reference/apis/js-apis-arkui-componentSnapshot.md
浏览文件 @ f7d7c3d4
# @ohos.arkui.componentSnapshot (Component Snapshot) # @ohos.arkui.componentSnapshot (Component Snapshot)
The **componentSnapshot** module provides APIs for obtaining component snapshots, including snapshots of components that have been loaded and snapshots of components that have not been loaded yet. The **componentSnapshot** module provides APIs for obtaining component snapshots, including snapshots of components that have been loaded and snapshots of components that have not been loaded yet. Note that a component snapshot does not contain content drawn outside of the area of the owning component or the parent component.
> **NOTE** > **NOTE**
> >
...@@ -8,6 +8,7 @@ The **componentSnapshot** module provides APIs for obtaining component snapshots ...@@ -8,6 +8,7 @@ The **componentSnapshot** module provides APIs for obtaining component snapshots
> >
> You can preview how this component looks on a real device. The preview is not yet available in the DevEco Studio Previewer. > You can preview how this component looks on a real device. The preview is not yet available in the DevEco Studio Previewer.
## Modules to Import ## Modules to Import
```js ```js
...@@ -20,12 +21,16 @@ get(id: string, callback: AsyncCallback<image.PixelMap>): void ...@@ -20,12 +21,16 @@ get(id: string, callback: AsyncCallback<image.PixelMap>): void
Obtains the snapshot of a component that has been loaded. This API uses an asynchronous callback to return the result. Obtains the snapshot of a component that has been loaded. This API uses an asynchronous callback to return the result.
> **NOTE**
>
> The snapshot captures content rendered in the last frame. If this API is called when the component triggers an update, the re-rendered content will not be included in the obtained snapshot.
**System capability**: SystemCapability.ArkUI.ArkUI.Full **System capability**: SystemCapability.ArkUI.ArkUI.Full
**Parameters** **Parameters**
| Name | Type | Mandatory| Description | | Name | Type | Mandatory | Description |
| -------- | ----------------------------------- | ---- | ------------------------------------------------------------------------------ | | -------- | ----------------------------------- | ---- | ---------------------------------------- |
| id | string | Yes | [ID](../arkui-ts/ts-universal-attributes-component-id.md) of the target component.| | id | string | Yes | [ID](../arkui-ts/ts-universal-attributes-component-id.md) of the target component.|
| callback | AsyncCallback&lt;image.PixelMap&gt; | Yes | Callback used to return the result. | | callback | AsyncCallback&lt;image.PixelMap&gt; | Yes | Callback used to return the result. |
...@@ -45,8 +50,8 @@ struct SnapshotExample { ...@@ -45,8 +50,8 @@ struct SnapshotExample {
Image(this.pixmap) Image(this.pixmap)
.width(300).height(300) .width(300).height(300)
// ...Component // ...Component
// ...Components // ...Component
// ...Components // ...Component
Button("click to generate UI snapshot") Button("click to generate UI snapshot")
.onClick(() => { .onClick(() => {
componentSnapshot.get("root", (error: Error, pixmap: image.PixelMap) => { componentSnapshot.get("root", (error: Error, pixmap: image.PixelMap) => {
...@@ -71,24 +76,28 @@ get(id: string): Promise<image.PixelMap> ...@@ -71,24 +76,28 @@ get(id: string): Promise<image.PixelMap>
Obtains the snapshot of a component that has been loaded. This API uses a promise to return the result. Obtains the snapshot of a component that has been loaded. This API uses a promise to return the result.
> **NOTE**
>
> The snapshot captures content rendered in the last frame. If this API is called when the component triggers an update, the re-rendered content will not be included in the obtained snapshot.
**System capability**: SystemCapability.ArkUI.ArkUI.Full **System capability**: SystemCapability.ArkUI.ArkUI.Full
**Parameters** **Parameters**
| Name | Type | Mandatory| Description | | Name | Type | Mandatory | Description |
| ------- | ------------------------------------------------------- | ---- | -------------------- | | ---- | ------ | ---- | ---------------------------------------- |
| id | string | Yes | [ID](../arkui-ts/ts-universal-attributes-component-id.md) of the target component.| | id | string | Yes | [ID](../arkui-ts/ts-universal-attributes-component-id.md) of the target component.|
**Return value** **Return value**
| Type | Description | | Type | Description |
| ----------------------------- | -------------- | | ----------------------------- | -------- |
| Promise&lt;image.PixelMap&gt; | Promise used to return the result.| | Promise&lt;image.PixelMap&gt; | Promise used to return the result.|
**Error codes** **Error codes**
| ID| Error Message | | ID | Error Message |
| -------- | ------------------- | | ------ | ------------------- |
| 100001 | if id is not valid. | | 100001 | if id is not valid. |
**Example** **Example**
...@@ -134,14 +143,21 @@ createFromBuilder(builder: CustomBuilder, callback: AsyncCallback<image.PixelMap ...@@ -134,14 +143,21 @@ createFromBuilder(builder: CustomBuilder, callback: AsyncCallback<image.PixelMap
Renders a custom component in the application background and outputs its snapshot. This API uses an asynchronous callback to return the result. Renders a custom component in the application background and outputs its snapshot. This API uses an asynchronous callback to return the result.
> **NOTE**
>
> To account for the time spent in awaiting component building and rendering, the callback of offscreen snapshots has a delay of less than 500 ms.
>
> If a component is on a time-consuming task, for example, an **\<Image>** or **\<Web>** component that is loading online images, its loading may be still in progress when this API is called. In this case, the output snapshot does not represent the component in the way it looks when the loading is successfully completed.
**System capability**: SystemCapability.ArkUI.ArkUI.Full **System capability**: SystemCapability.ArkUI.ArkUI.Full
**Parameters** **Parameters**
| Name | Type | Mandatory| Description | | Name | Type | Mandatory | Description |
| -------- | ------------------------------------------------------- | ---- | -------------------- | | -------- | ---------------------------------------- | ---- | ---------- |
| builder | [CustomBuilder](../arkui-ts/ts-types.md#custombuilder8) | Yes | Builder of the custom component.| | builder | [CustomBuilder](../arkui-ts/ts-types.md#custombuilder8) | Yes | Builder of the custom component.|
| callback | AsyncCallback&lt;image.PixelMap&gt; | Yes | Callback used to return the result. | | callback | AsyncCallback&lt;image.PixelMap&gt; | Yes | Callback used to return the result.|
**Example** **Example**
...@@ -194,24 +210,30 @@ createFromBuilder(builder: CustomBuilder): Promise<image.PixelMap> ...@@ -194,24 +210,30 @@ createFromBuilder(builder: CustomBuilder): Promise<image.PixelMap>
Renders a custom component in the application background and outputs its snapshot. This API uses a promise to return the result. Renders a custom component in the application background and outputs its snapshot. This API uses a promise to return the result.
> **NOTE**
>
> To account for the time spent in awaiting component building and rendering, the callback of offscreen snapshots has a delay of less than 500 ms.
>
> If a component is on a time-consuming task, for example, an **\<Image>** or **\<Web>** component that is loading online images, its loading may be still in progress when this API is called. In this case, the output snapshot does not represent the component in the way it looks when the loading is successfully completed.
**System capability**: SystemCapability.ArkUI.ArkUI.Full **System capability**: SystemCapability.ArkUI.ArkUI.Full
**Parameters** **Parameters**
| Name | Type | Mandatory| Description | | Name | Type | Mandatory | Description |
| ------- | ------------------------------------------------------- | ---- | -------------------- | | ------- | ---------------------------------------- | ---- | ---------- |
| builder | [CustomBuilder](../arkui-ts/ts-types.md#custombuilder8) | Yes | Builder of the custom component.| | builder | [CustomBuilder](../arkui-ts/ts-types.md#custombuilder8) | Yes | Builder of the custom component.|
**Return value** **Return value**
| Type | Description | | Type | Description |
| ----------------------------- | -------------- | | ----------------------------- | -------- |
| Promise&lt;image.PixelMap&gt; | Promise used to return the result.| | Promise&lt;image.PixelMap&gt; | Promise used to return the result.|
**Error codes** **Error codes**
| ID| Error Message | | ID | Error Message |
| -------- | ----------------------------------------- | | ------ | ---------------------------------------- |
| 100001 | if builder is not a valid build function. | | 100001 | if builder is not a valid build function. |
**Example** **Example**
......
en/application-dev/ui/arkts-layout-update-animation.md 0 → 100644
浏览文件 @ f7d7c3d4
此差异已折叠。
en/application-dev/ui/figures/2023022700701(1).jpg 0 → 100644
浏览文件 @ f7d7c3d4
此差异已折叠。
en/application-dev/ui/figures/2023022701120(1).jpg 0 → 100644
浏览文件 @ f7d7c3d4
此差异已折叠。
en/application-dev/ui/figures/2023022793003(1).jpg 0 → 100644
浏览文件 @ f7d7c3d4
此差异已折叠。
en/application-dev/ui/figures/2023022793350(1).jpg 0 → 100644
浏览文件 @ f7d7c3d4
此差异已折叠。
en/application-dev/ui/figures/2023022793719(1).jpg 0 → 100644
浏览文件 @ f7d7c3d4
此差异已折叠。
en/application-dev/ui/figures/2023022794031(1).jpg 0 → 100644
浏览文件 @ f7d7c3d4
此差异已折叠。
en/application-dev/ui/figures/2023022794521(1).jpg 0 → 100644
浏览文件 @ f7d7c3d4
此差异已折叠。
en/application-dev/ui/figures/2023022795105(1).jpg 0 → 100644
浏览文件 @ f7d7c3d4
此差异已折叠。
en/application-dev/ui/figures/2023032422159.jpg 0 → 100644
浏览文件 @ f7d7c3d4
此差异已折叠。
en/application-dev/ui/figures/drawimage.PNG 0 → 100644
浏览文件 @ f7d7c3d4
此差异已折叠。
en/application-dev/ui/figures/layoutChange1.gif 0 → 100644
浏览文件 @ f7d7c3d4
此差异已折叠。
en/application-dev/ui/figures/layoutChange2_animateTo.gif 0 → 100644
浏览文件 @ f7d7c3d4
此差异已折叠。
en/application-dev/ui/figures/onDestroy.png 0 → 100644
浏览文件 @ f7d7c3d4
此差异已折叠。
en/application-dev/ui/figures/onLoad.png 0 → 100644
浏览文件 @ f7d7c3d4
此差异已折叠。
en/application-dev/ui/figures/picture-1.png 0 → 100644
浏览文件 @ f7d7c3d4
此差异已折叠。
en/application-dev/ui/figures/size-change-animation.gif 0 → 100644
浏览文件 @ f7d7c3d4
此差异已折叠。
en/application-dev/website.md
浏览文件 @ f7d7c3d4
此差异已折叠。
zh-cn/application-dev/reference/apis/Readme-CN.md 100755 → 100644
浏览文件 @ f7d7c3d4
此差异已折叠。
zh-cn/application-dev/reference/apis/js-apis-syscap.md 0 → 100644
浏览文件 @ f7d7c3d4
此差异已折叠。
zh-cn/application-dev/reference/apis/js-apis-system-time.md 100644 → 100755
浏览文件 @ f7d7c3d4
此差异已折叠。
zh-cn/application-dev/reference/native-apis/init.md 0 → 100644
浏览文件 @ f7d7c3d4
此差异已折叠。
zh-cn/application-dev/website.md
浏览文件 @ f7d7c3d4
此差异已折叠。
zh-cn/device-dev/reference/hdi-apis/_activation.md 0 → 100644
浏览文件 @ f7d7c3d4
此差异已折叠。
zh-cn/device-dev/reference/hdi-apis/_add_fusion.md 0 → 100644
浏览文件 @ f7d7c3d4
此差异已折叠。
zh-cn/device-dev/reference/hdi-apis/_arg_max_fusion.md 0 → 100644
浏览文件 @ f7d7c3d4
此差异已折叠。
zh-cn/device-dev/reference/hdi-apis/_audio_event.md 0 → 100644
浏览文件 @ f7d7c3d4
此差异已折叠。
zh-cn/device-dev/reference/hdi-apis/_audio_info.md 0 → 100644
浏览文件 @ f7d7c3d4
此差异已折叠。
zh-cn/device-dev/reference/hdi-apis/_avg_pool_fusion.md 0 → 100644
浏览文件 @ f7d7c3d4
此差异已折叠。
zh-cn/device-dev/reference/hdi-apis/_bias_add.md 0 → 100644
浏览文件 @ f7d7c3d4
此差异已折叠。
zh-cn/device-dev/reference/hdi-apis/_c_b_config_info.md 0 → 100644
浏览文件 @ f7d7c3d4
此差异已折叠。
zh-cn/device-dev/reference/hdi-apis/_call_info.md 0 → 100644
浏览文件 @ f7d7c3d4
此差异已折叠。
zh-cn/device-dev/reference/hdi-apis/_call_info_list.md 0 → 100644
浏览文件 @ f7d7c3d4
此差异已折叠。
zh-cn/device-dev/reference/hdi-apis/_cast.md 0 → 100644
浏览文件 @ f7d7c3d4
此差异已折叠。
zh-cn/device-dev/reference/hdi-apis/_cdma_rssi.md 0 → 100644
浏览文件 @ f7d7c3d4
此差异已折叠。
zh-cn/device-dev/reference/hdi-apis/_cell_rat_cdma.md 0 → 100644
浏览文件 @ f7d7c3d4
此差异已折叠。
zh-cn/device-dev/reference/hdi-apis/_cell_rat_gsm.md 0 → 100644
浏览文件 @ f7d7c3d4
此差异已折叠。
zh-cn/device-dev/reference/hdi-apis/_cell_rat_lte.md 0 → 100644
浏览文件 @ f7d7c3d4
此差异已折叠。
zh-cn/device-dev/reference/hdi-apis/_cell_rat_nr.md 0 → 100644
浏览文件 @ f7d7c3d4
此差异已折叠。
zh-cn/device-dev/reference/hdi-apis/_cell_rat_wcdma.md 0 → 100644
浏览文件 @ f7d7c3d4
此差异已折叠。
zh-cn/device-dev/reference/hdi-apis/_cellfence_info.md 0 → 100644
浏览文件 @ f7d7c3d4
此差异已折叠。
zh-cn/device-dev/reference/hdi-apis/_cellfence_size.md 0 → 100644
浏览文件 @ f7d7c3d4
此差异已折叠。
zh-cn/device-dev/reference/hdi-apis/_concat.md 0 → 100644
浏览文件 @ f7d7c3d4
此差异已折叠。
zh-cn/device-dev/reference/hdi-apis/_conv2_d_fusion.md 0 → 100644
浏览文件 @ f7d7c3d4
此差异已折叠。
zh-cn/device-dev/reference/hdi-apis/_current_cell.md 0 → 100644
浏览文件 @ f7d7c3d4
此差异已折叠。
zh-cn/device-dev/reference/hdi-apis/_data_call_info.md 0 → 100644
浏览文件 @ f7d7c3d4
此差异已折叠。
zh-cn/device-dev/reference/hdi-apis/_data_sleep_info.md 0 → 100644
浏览文件 @ f7d7c3d4
此差异已折叠。
zh-cn/device-dev/reference/hdi-apis/_dial_info.md 0 → 100644
浏览文件 @ f7d7c3d4
此差异已折叠。
zh-cn/device-dev/reference/hdi-apis/_div_fusion.md 0 → 100644
浏览文件 @ f7d7c3d4
此差异已折叠。
zh-cn/device-dev/reference/hdi-apis/_dtmf_info.md 0 → 100644
浏览文件 @ f7d7c3d4
此差异已折叠。
zh-cn/device-dev/reference/hdi-apis/_eltwise.md 0 → 100644
浏览文件 @ f7d7c3d4
此差异已折叠。
zh-cn/device-dev/reference/hdi-apis/_emergency_call.md 0 → 100644
浏览文件 @ f7d7c3d4
此差异已折叠。
zh-cn/device-dev/reference/hdi-apis/_ex_data_handle.md 0 → 100644
浏览文件 @ f7d7c3d4
此差异已折叠。
zh-cn/device-dev/reference/hdi-apis/_expand_dims.md 0 → 100644
浏览文件 @ f7d7c3d4
此差异已折叠。
zh-cn/device-dev/reference/hdi-apis/_fill.md 0 → 100644
浏览文件 @ f7d7c3d4
此差异已折叠。
zh-cn/device-dev/reference/hdi-apis/_full_connection.md 0 → 100644
浏览文件 @ f7d7c3d4
此差异已折叠。
zh-cn/device-dev/reference/hdi-apis/_gather.md 0 → 100644
浏览文件 @ f7d7c3d4
此差异已折叠。
zh-cn/device-dev/reference/hdi-apis/_geofence_result.md 0 → 100644
浏览文件 @ f7d7c3d4
此差异已折叠。
zh-cn/device-dev/reference/hdi-apis/_geofence_size.md 0 → 100644
浏览文件 @ f7d7c3d4
此差异已折叠。
zh-cn/device-dev/reference/hdi-apis/_get_clip_result.md 0 → 100644
浏览文件 @ f7d7c3d4
此差异已折叠。
zh-cn/device-dev/reference/hdi-apis/_get_clir_result.md 0 → 100644
浏览文件 @ f7d7c3d4
此差异已折叠。
zh-cn/device-dev/reference/hdi-apis/_gsm_rssi.md 0 → 100644
浏览文件 @ f7d7c3d4
此差异已折叠。
zh-cn/device-dev/reference/hdi-apis/_i_o_tensor.md 0 → 100644
浏览文件 @ f7d7c3d4
此差异已折叠。
zh-cn/device-dev/reference/hdi-apis/_i_ril_8idl.md 0 → 100644
浏览文件 @ f7d7c3d4
此差异已折叠。
zh-cn/device-dev/reference/hdi-apis/_less_equal.md 0 → 100644
浏览文件 @ f7d7c3d4
此差异已折叠。
zh-cn/device-dev/reference/hdi-apis/_lte_rssi.md 0 → 100644
浏览文件 @ f7d7c3d4
此差异已折叠。
zh-cn/device-dev/reference/hdi-apis/_mat_mul_fusion.md 0 → 100644
浏览文件 @ f7d7c3d4
此差异已折叠。
zh-cn/device-dev/reference/hdi-apis/_max_pool_fusion.md 0 → 100644
浏览文件 @ f7d7c3d4
此差异已折叠。
zh-cn/device-dev/reference/hdi-apis/_maximum.md 0 → 100644
浏览文件 @ f7d7c3d4
此差异已折叠。
zh-cn/device-dev/reference/hdi-apis/_mode_data.md 0 → 100644
浏览文件 @ f7d7c3d4
此差异已折叠。
zh-cn/device-dev/reference/hdi-apis/_model.md 0 → 100644
浏览文件 @ f7d7c3d4
此差异已折叠。
zh-cn/device-dev/reference/hdi-apis/_model_config.md 0 → 100644
浏览文件 @ f7d7c3d4
此差异已折叠。
zh-cn/device-dev/reference/hdi-apis/_mul_fusion.md 0 → 100644
浏览文件 @ f7d7c3d4
此差异已折叠。
zh-cn/device-dev/reference/hdi-apis/_n_n_rt.md 0 → 100644
浏览文件 @ f7d7c3d4
此差异已折叠。
zh-cn/device-dev/reference/hdi-apis/_neighbor_cell.md 0 → 100644
浏览文件 @ f7d7c3d4
此差异已折叠。
zh-cn/device-dev/reference/hdi-apis/_nnrt_types_8idl.md 0 → 100644
浏览文件 @ f7d7c3d4
此差异已折叠。
zh-cn/device-dev/reference/hdi-apis/_node.md 0 → 100644
浏览文件 @ f7d7c3d4
此差异已折叠。
zh-cn/device-dev/reference/hdi-apis/_nr_rssi.md 0 → 100644
浏览文件 @ f7d7c3d4
此差异已折叠。
zh-cn/device-dev/reference/hdi-apis/_offline_db.md 0 → 100644
浏览文件 @ f7d7c3d4
此差异已折叠。
zh-cn/device-dev/reference/hdi-apis/_one_hot.md 0 → 100644
浏览文件 @ f7d7c3d4
此差异已折叠。
zh-cn/device-dev/reference/hdi-apis/_operator_info.md 0 → 100644
浏览文件 @ f7d7c3d4
此差异已折叠。
zh-cn/device-dev/reference/hdi-apis/_p_re_l_u_fusion.md 0 → 100644
浏览文件 @ f7d7c3d4
此差异已折叠。
zh-cn/device-dev/reference/hdi-apis/_pad_fusion.md 0 → 100644
浏览文件 @ f7d7c3d4
此差异已折叠。
zh-cn/device-dev/reference/hdi-apis/_point.md 0 → 100644
浏览文件 @ f7d7c3d4
此差异已折叠。
zh-cn/device-dev/reference/hdi-apis/_pow_fusion.md 0 → 100644
浏览文件 @ f7d7c3d4
此差异已折叠。
zh-cn/device-dev/reference/hdi-apis/_quant_param.md 0 → 100644
浏览文件 @ f7d7c3d4
此差异已折叠。
zh-cn/device-dev/reference/hdi-apis/_radio_protocol.md 0 → 100644
浏览文件 @ f7d7c3d4
此差异已折叠。
zh-cn/device-dev/reference/hdi-apis/_reduce_fusion.md 0 → 100644
浏览文件 @ f7d7c3d4
此差异已折叠。
zh-cn/device-dev/reference/hdi-apis/_request_cell_db.md 0 → 100644
浏览文件 @ f7d7c3d4
此差异已折叠。
zh-cn/device-dev/reference/hdi-apis/_reshape.md 0 → 100644
浏览文件 @ f7d7c3d4
此差异已折叠。
zh-cn/device-dev/reference/hdi-apis/_resize.md 0 → 100644
浏览文件 @ f7d7c3d4
此差异已折叠。
zh-cn/device-dev/reference/hdi-apis/_ril.md 0 → 100644
浏览文件 @ f7d7c3d4
此差异已折叠。
zh-cn/device-dev/reference/hdi-apis/_ril_types_8idl.md 0 → 100644
浏览文件 @ f7d7c3d4
此差异已折叠。
zh-cn/device-dev/reference/hdi-apis/_ringback_voice.md 0 → 100644
浏览文件 @ f7d7c3d4
此差异已折叠。
zh-cn/device-dev/reference/hdi-apis/_rsqrt.md 0 → 100644
浏览文件 @ f7d7c3d4
此差异已折叠。
zh-cn/device-dev/reference/hdi-apis/_rssi.md 0 → 100644
浏览文件 @ f7d7c3d4
此差异已折叠。
zh-cn/device-dev/reference/hdi-apis/_scale_fusion.md 0 → 100644
浏览文件 @ f7d7c3d4
此差异已折叠。
zh-cn/device-dev/reference/hdi-apis/_shape.md 0 → 100644
浏览文件 @ f7d7c3d4
此差异已折叠。
zh-cn/device-dev/reference/hdi-apis/_shared_buffer.md 0 → 100644
浏览文件 @ f7d7c3d4
此差异已折叠。
zh-cn/device-dev/reference/hdi-apis/_sim_lock_info.md 0 → 100644
浏览文件 @ f7d7c3d4
此差异已折叠。
zh-cn/device-dev/reference/hdi-apis/_slice_fusion.md 0 → 100644
浏览文件 @ f7d7c3d4
此差异已折叠。
zh-cn/device-dev/reference/hdi-apis/_softmax.md 0 → 100644
浏览文件 @ f7d7c3d4
此差异已折叠。
zh-cn/device-dev/reference/hdi-apis/_split.md 0 → 100644
浏览文件 @ f7d7c3d4
此差异已折叠。
zh-cn/device-dev/reference/hdi-apis/_sqrt.md 0 → 100644
浏览文件 @ f7d7c3d4
此差异已折叠。
zh-cn/device-dev/reference/hdi-apis/_squeeze.md 0 → 100644
浏览文件 @ f7d7c3d4
此差异已折叠。
zh-cn/device-dev/reference/hdi-apis/_srvcc_status.md 0 → 100644
浏览文件 @ f7d7c3d4
此差异已折叠。
zh-cn/device-dev/reference/hdi-apis/_ss_notice_info.md 0 → 100644
浏览文件 @ f7d7c3d4
此差异已折叠。
zh-cn/device-dev/reference/hdi-apis/_stack.md 0 → 100644
浏览文件 @ f7d7c3d4
此差异已折叠。
zh-cn/device-dev/reference/hdi-apis/_strided_slice.md 0 → 100644
浏览文件 @ f7d7c3d4
此差异已折叠。
zh-cn/device-dev/reference/hdi-apis/_sub_fusion.md 0 → 100644
浏览文件 @ f7d7c3d4
此差异已折叠。
zh-cn/device-dev/reference/hdi-apis/_sub_graph.md 0 → 100644
浏览文件 @ f7d7c3d4
此差异已折叠。
zh-cn/device-dev/reference/hdi-apis/_td_scdma_rssi.md 0 → 100644
浏览文件 @ f7d7c3d4
此差异已折叠。
zh-cn/device-dev/reference/hdi-apis/_tensor.md 0 → 100644
浏览文件 @ f7d7c3d4
此差异已折叠。
zh-cn/device-dev/reference/hdi-apis/_tile_fusion.md 0 → 100644
浏览文件 @ f7d7c3d4
此差异已折叠。
zh-cn/device-dev/reference/hdi-apis/_top_k_fusion.md 0 → 100644
浏览文件 @ f7d7c3d4
此差异已折叠。
zh-cn/device-dev/reference/hdi-apis/_transpose.md 0 → 100644
浏览文件 @ f7d7c3d4
此差异已折叠。
zh-cn/device-dev/reference/hdi-apis/_types_8idl.md 0 → 100644
浏览文件 @ f7d7c3d4
此差异已折叠。
zh-cn/device-dev/reference/hdi-apis/_uni_info.md 0 → 100644
浏览文件 @ f7d7c3d4
此差异已折叠。
zh-cn/device-dev/reference/hdi-apis/_unsqueeze.md 0 → 100644
浏览文件 @ f7d7c3d4
此差异已折叠。
zh-cn/device-dev/reference/hdi-apis/_wcdma_rssi.md 0 → 100644
浏览文件 @ f7d7c3d4
此差异已折叠。
zh-cn/device-dev/reference/hdi-apis/_wififence_size.md 0 → 100644
浏览文件 @ f7d7c3d4
此差异已折叠。
zh-cn/device-dev/reference/hdi-apis/_yuv_desc_info.md 0 → 100644
浏览文件 @ f7d7c3d4
此差异已折叠。
zh-cn/device-dev/reference/hdi-apis/interface_i_ril.md 0 → 100644
浏览文件 @ f7d7c3d4
此差异已折叠。
zh-cn/device-dev/reference/hdi-apis/union_scene_desc.md 0 → 100644
浏览文件 @ f7d7c3d4
此差异已折叠。
zh-cn/device-dev/website.md
浏览文件 @ f7d7c3d4
此差异已折叠。
Markdown is supported
0% 或 .
You are about to add 0 people to the discussion. Proceed with caution.
先完成此消息的编辑！
想要评论请 注册 或