提交 b6590d27 编写于 作者: G Gloria

Update docs against 16735+17296+17418+17488

Signed-off-by: wusongqing<wusongqing@huawei.com>
上级 148438ff
...@@ -63,7 +63,7 @@ For details about how to use DevEco Studio to start the test framework, see [Ope ...@@ -63,7 +63,7 @@ For details about how to use DevEco Studio to start the test framework, see [Ope
**Example** **Example**
```javascript ```javascript
import AbilityDelegatorRegistry from '@ohos.app.ability.abilityDelegatorRegistry'; import AbilityDelegatorRegistry from '@ohos.application.abilityDelegatorRegistry'
function onAbilityCreateCallback(data) { function onAbilityCreateCallback(data) {
console.info("onAbilityCreateCallback"); console.info("onAbilityCreateCallback");
...@@ -87,11 +87,11 @@ abilityDelegator.addAbilityMonitor(monitor).then(() => { ...@@ -87,11 +87,11 @@ abilityDelegator.addAbilityMonitor(monitor).then(() => {
**Modules to Import** **Modules to Import**
```javascript ```javascript
import AbilityDelegatorRegistry from '@ohos.app.ability.abilityDelegatorRegistry'; import AbilityDelegatorRegistry from '@ohos.application.abilityDelegatorRegistry'
``` ```
```javascript ```javascript
var abilityDelegator = AbilityDelegatorRegistry.getAbilityDelegator(); var abilityDelegator = AbilityDelegatorRegistry.getAbilityDelegator()
``` ```
### Starting an Ability and Listening for the Ability State ### Starting an Ability and Listening for the Ability State
......
...@@ -25,7 +25,7 @@ Carry out the following operations to develop the widget provider based on the [ ...@@ -25,7 +25,7 @@ Carry out the following operations to develop the widget provider based on the [
1. Implement lifecycle callbacks by using the **LifecycleForm** APIs. 1. Implement lifecycle callbacks by using the **LifecycleForm** APIs.
2. Create a **FormBindingData** instance. 2. Create a **FormBindingData** instance.
3. Update a widget by using the **FormProvider** APIs. 3. Update a widget by using the **FormProvider** APIs.
4. Develop the widget UI pages. 4. Develop the widget UI page.
## Available APIs ## Available APIs
...@@ -231,7 +231,7 @@ You should override **onDestroy** to implement widget data deletion. ...@@ -231,7 +231,7 @@ You should override **onDestroy** to implement widget data deletion.
} }
``` ```
For details about how to implement persistent data storage, see [Lightweight Data Store Development](../database/database-preference-guidelines.md). For details about how to implement persistent data storage, see [Data Persistence by User Preferences](../database/data-persistence-by-preferences.md).
The **Want** object passed in by the widget host to the widget provider contains a flag that specifies whether the requested widget is normal or temporary. The **Want** object passed in by the widget host to the widget provider contains a flag that specifies whether the requested widget is normal or temporary.
...@@ -402,3 +402,5 @@ The code snippet is as follows: ...@@ -402,3 +402,5 @@ The code snippet is as follows:
} }
} }
``` ```
<!--no_check-->
\ No newline at end of file
...@@ -6,7 +6,7 @@ Ability continuation is to continue the current mission of an application, inclu ...@@ -6,7 +6,7 @@ Ability continuation is to continue the current mission of an application, inclu
## Available APIs ## Available APIs
The following table lists the APIs used for ability continuation. For details about the APIs, see [Ability](../reference/apis/js-apis-application-ability.md). The following table lists the APIs used for ability continuation. For details about the APIs, see [UIAbility](../reference/apis/js-apis-app-ability-uiAbility.md).
**Table 1** Ability continuation APIs **Table 1** Ability continuation APIs
...@@ -48,12 +48,9 @@ The code snippets provided below are all from [Sample](https://gitee.com/openhar ...@@ -48,12 +48,9 @@ The code snippets provided below are all from [Sample](https://gitee.com/openhar
} }
``` ```
- Configure the application startup type. - Configure the application startup type.
If **launchType** is set to **standard** in the **module.json5** file, the application is of the multi-instance launch type. During ability continuation, regardless of whether the application is already open, the target starts the application and restores the UI page. If **launchType** is set to **singleton**, the application is of the singleton launch type. If the application is already open, the target clears the existing page stack and restores the UI page. For more information, see "Launch Type" in [Ability Development](./stage-ability.md). If **launchType** is set to **multiton** in the **module.json5** file, the application is of the multi-instance launch type. During ability continuation, regardless of whether the application is already open, the target starts the application and restores the UI page. If **launchType** is set to **singleton**, the application is of the singleton launch type. If the application is already open, the target clears the existing page stack and restores the UI page. For more information, see "Launch Type" in [Ability Development](./stage-ability.md).
Configure a multi-instance application as follows: Configure a multi-instance application as follows:
...@@ -62,7 +59,7 @@ The code snippets provided below are all from [Sample](https://gitee.com/openhar ...@@ -62,7 +59,7 @@ The code snippets provided below are all from [Sample](https://gitee.com/openhar
"module": { "module": {
"abilities": [ "abilities": [
{ {
"launchType": "standard" "launchType": "multiton"
} }
] ]
} }
...@@ -83,8 +80,6 @@ The code snippets provided below are all from [Sample](https://gitee.com/openhar ...@@ -83,8 +80,6 @@ The code snippets provided below are all from [Sample](https://gitee.com/openhar
} }
``` ```
- Apply for the distributed permissions. - Apply for the distributed permissions.
Declare the **DISTRIBUTED_DATASYNC** permission in the **module.json5** file for the application. Declare the **DISTRIBUTED_DATASYNC** permission in the **module.json5** file for the application.
...@@ -96,8 +91,6 @@ The code snippets provided below are all from [Sample](https://gitee.com/openhar ...@@ -96,8 +91,6 @@ The code snippets provided below are all from [Sample](https://gitee.com/openhar
}, },
``` ```
This permission must be granted by the user in a dialog box when the application is started for the first time. To enable the application to display a dialog box to ask for the permission, add the following code to **onWindowStageCreate** of the **Ability** class: This permission must be granted by the user in a dialog box when the application is started for the first time. To enable the application to display a dialog box to ask for the permission, add the following code to **onWindowStageCreate** of the **Ability** class:
```javascript ```javascript
...@@ -139,7 +132,6 @@ The code snippets provided below are all from [Sample](https://gitee.com/openhar ...@@ -139,7 +132,6 @@ The code snippets provided below are all from [Sample](https://gitee.com/openhar
2. Implement the **onContinue()** API. 2. Implement the **onContinue()** API.
The **onContinue()** API is called by the initiator to save the UI component state variables and memory data and prepare for continuation. After the application completes the continuation preparation, the system must return either **OnContinueResult.AGREE(0)** to accept the continuation request or an error code to reject the request. If this API is not implemented, the system rejects the continuation request by default. The **onContinue()** API is called by the initiator to save the UI component state variables and memory data and prepare for continuation. After the application completes the continuation preparation, the system must return either **OnContinueResult.AGREE(0)** to accept the continuation request or an error code to reject the request. If this API is not implemented, the system rejects the continuation request by default.
...@@ -155,7 +147,7 @@ The code snippets provided below are all from [Sample](https://gitee.com/openhar ...@@ -155,7 +147,7 @@ The code snippets provided below are all from [Sample](https://gitee.com/openhar
You can obtain the target device ID (identified by the key **targetDevice**) and the version number (identified by the key **version**) of the application installed on the target device from the **wantParam** parameter of this API. The version number can be used for compatibility check. If the current application version is incompatible with that on the target device, **OnContinueResult.MISMATCH** can be returned to reject the continuation request. You can obtain the target device ID (identified by the key **targetDevice**) and the version number (identified by the key **version**) of the application installed on the target device from the **wantParam** parameter of this API. The version number can be used for compatibility check. If the current application version is incompatible with that on the target device, **OnContinueResult.MISMATCH** can be returned to reject the continuation request.
Example Example:
```javascript ```javascript
onContinue(wantParam : {[key: string]: any}) { onContinue(wantParam : {[key: string]: any}) {
...@@ -168,8 +160,6 @@ The code snippets provided below are all from [Sample](https://gitee.com/openhar ...@@ -168,8 +160,6 @@ The code snippets provided below are all from [Sample](https://gitee.com/openhar
} }
``` ```
3. Implement the continuation logic in the **onCreate()** or **onNewWant()** API. 3. Implement the continuation logic in the **onCreate()** or **onNewWant()** API.
The **onCreate()** API is called by the target. When the ability is started on the target device, this API is called to instruct the application to synchronize the memory data and UI component state, and triggers page restoration after the synchronization is complete. If the continuation logic is not implemented, the ability will be started in common startup mode and the page cannot be restored. The **onCreate()** API is called by the target. When the ability is started on the target device, this API is called to instruct the application to synchronize the memory data and UI component state, and triggers page restoration after the synchronization is complete. If the continuation logic is not implemented, the ability will be started in common startup mode and the page cannot be restored.
...@@ -178,11 +168,9 @@ The code snippets provided below are all from [Sample](https://gitee.com/openhar ...@@ -178,11 +168,9 @@ The code snippets provided below are all from [Sample](https://gitee.com/openhar
After data restore is complete, call **restoreWindowStage** to trigger page restoration. After data restore is complete, call **restoreWindowStage** to trigger page restoration.
You can also use **want.parameters.version** in the **want** parameter to obtain the application version number of the initiator. You can also use **want.parameters.version** in the **want** parameter to obtain the application version number of the initiator.
Example Example:
```javascript ```javascript
import UIAbility from '@ohos.app.ability.UIAbility'; import UIAbility from '@ohos.app.ability.UIAbility';
...@@ -211,7 +199,7 @@ For a singleton ability, use **onNewWant()** to achieve the same implementation. ...@@ -211,7 +199,7 @@ For a singleton ability, use **onNewWant()** to achieve the same implementation.
Use distributed objects. Use distributed objects.
Distributed objects allow cross-device data synchronization like local variables. For two devices that form a Super Device, when data in the distributed data object of an application is added, deleted, or modified on a device, the data for the same application is also updated on the other device. Both devices can listen for the data changes and online and offline states of the other. For details, see [Distributed Data Object Development](../database/database-distributedobject-guidelines.md). Distributed objects allow cross-device data synchronization like local variables. For two devices that form a Super Device, when data in the distributed data object of an application is added, deleted, or modified on a device, the data for the same application is also updated on the other device. Both devices can listen for the data changes and online and offline states of the other. For details, see [Sharing Distributed Data Objects](../database/data-sync-of-distributed-data-object.md).
In the ability continuation scenario, the distributed data object is used to synchronize the memory data from the local device to the target device. In the ability continuation scenario, the distributed data object is used to synchronize the memory data from the local device to the target device.
...@@ -249,8 +237,6 @@ In the ability continuation scenario, the distributed data object is used to syn ...@@ -249,8 +237,6 @@ In the ability continuation scenario, the distributed data object is used to syn
}); });
``` ```
- The target device obtains the session ID from **onCreate()**, creates a distributed object, and associates the distributed object with the session ID. In this way, the distributed object can be synchronized. Before calling **restoreWindowStage**, ensure that all distributed objects required for continuation have been associated. - The target device obtains the session ID from **onCreate()**, creates a distributed object, and associates the distributed object with the session ID. In this way, the distributed object can be synchronized. Before calling **restoreWindowStage**, ensure that all distributed objects required for continuation have been associated.
```javascript ```javascript
...@@ -283,8 +269,6 @@ In the ability continuation scenario, the distributed data object is used to syn ...@@ -283,8 +269,6 @@ In the ability continuation scenario, the distributed data object is used to syn
} }
``` ```
### More Information ### More Information
1. Timeout 1. Timeout
...@@ -294,15 +278,13 @@ In the ability continuation scenario, the distributed data object is used to syn ...@@ -294,15 +278,13 @@ In the ability continuation scenario, the distributed data object is used to syn
2. By default, the system supports page stack information migration, which means that the page stack of the initiator will be automatically migrated to the target device. No adaptation is required. 2. By default, the system supports page stack information migration, which means that the page stack of the initiator will be automatically migrated to the target device. No adaptation is required.
### Restrictions ### Restrictions
1. The continuation must be performed between the same ability, which means the same bundle name, module name, and ability name. For details, see [Application Package Structure Configuration File](../quick-start/module-configuration-file.md). 1. The continuation must be performed between the same ability, which means the same bundle name, module name, and ability name. For details, see [Application Package Structure Configuration File](../quick-start/module-configuration-file.md).
2. Currently, the application can only implement the continuation capability. The continuation action must be initiated by the system. 2. Currently, the application can only implement the continuation capability. The continuation action must be initiated by the system.
### Best Practice ### Best Practice
For better user experience, you are advised to use the **wantParam** parameter to transmit data smaller than 100 KB and use distributed objects to transmit data larger than 100 KB. For better user experience, you are advised to use the **wantParam** parameter to transmit data smaller than 100 KB and use distributed objects to transmit data larger than 100 KB.
<!--no_check-->
\ No newline at end of file
...@@ -12,8 +12,8 @@ An ability can be launched in the **standard**, **singleton**, or **specified** ...@@ -12,8 +12,8 @@ An ability can be launched in the **standard**, **singleton**, or **specified**
| Launch Type | Description |Action | | Launch Type | Description |Action |
| ----------- | ------- |---------------- | | ----------- | ------- |---------------- |
| standard | Standard mode | A new instance is started each time an ability starts.| | multiton | Multi-instance mode| A new instance is started each time an ability starts.|
| singleton | Singleton mode | The ability has only one instance in the system. If an instance already exists when an ability is started, that instance is reused.| | singleton | Singleton mode | Default type. The ability has only one instance in the system. If an instance already exists when an ability is started, that instance is reused.|
| specified | Instance-specific| The internal service of an ability determines whether to create multiple instances during running.| | specified | Instance-specific| The internal service of an ability determines whether to create multiple instances during running.|
By default, the singleton mode is used. The following is an example of the **module.json5** file: By default, the singleton mode is used. The following is an example of the **module.json5** file:
...@@ -39,7 +39,7 @@ The table below describes the APIs provided by the **AbilityStage** class, which ...@@ -39,7 +39,7 @@ The table below describes the APIs provided by the **AbilityStage** class, which
|onAcceptWant(want: Want): string|Called when a specified ability is started.| |onAcceptWant(want: Want): string|Called when a specified ability is started.|
|onConfigurationUpdated(config: Configuration): void|Called when the global configuration is updated.| |onConfigurationUpdated(config: Configuration): void|Called when the global configuration is updated.|
The table below describes the APIs provided by the **Ability** class. For details about the APIs, see [Ability](../reference/apis/js-apis-application-ability.md). The table below describes the APIs provided by the **Ability** class. For details about the APIs, see [UIAbility](../reference/apis/js-apis-app-ability-uiAbility.md).
**Table 2** Ability APIs **Table 2** Ability APIs
...@@ -190,7 +190,7 @@ export default class EntryAbility extends UIAbility { ...@@ -190,7 +190,7 @@ export default class EntryAbility extends UIAbility {
``` ```
## Starting an Ability ## Starting an Ability
### Available APIs ### Available APIs
The **Ability** class has the **context** attribute, which belongs to the **AbilityContext** class. The **AbilityContext** class has the **abilityInfo**, **currentHapModuleInfo**, and other attributes as well as the APIs used for starting abilities. For details, see [AbilityContext](../reference/apis/js-apis-ability-context.md). The **Ability** class has the **context** attribute, which belongs to the **AbilityContext** class. The **AbilityContext** class has the **abilityInfo**, **currentHapModuleInfo**, and other attributes as well as the APIs used for starting abilities. For details, see [AbilityContext](../reference/apis/js-apis-inner-application-uiAbilityContext.md).
**Table 3** AbilityContext APIs **Table 3** AbilityContext APIs
|API|Description| |API|Description|
...@@ -207,7 +207,7 @@ The **Ability** class has the **context** attribute, which belongs to the **Abil ...@@ -207,7 +207,7 @@ The **Ability** class has the **context** attribute, which belongs to the **Abil
An application can obtain the context of an **Ability** instance through **this.context** and then use the **startAbility** API in the **AbilityContext** class to start the ability. The ability can be started by specifying **Want**, **StartOptions**, and **accountId**, and the operation result can be returned using a callback or **Promise** instance. The sample code is as follows: An application can obtain the context of an **Ability** instance through **this.context** and then use the **startAbility** API in the **AbilityContext** class to start the ability. The ability can be started by specifying **Want**, **StartOptions**, and **accountId**, and the operation result can be returned using a callback or **Promise** instance. The sample code is as follows:
```ts ```ts
let context = this.context let context = this.context
var want = { let want = {
"deviceId": "", "deviceId": "",
"bundleName": "com.example.MyApplication", "bundleName": "com.example.MyApplication",
"abilityName": "EntryAbility" "abilityName": "EntryAbility"
...@@ -224,7 +224,7 @@ context.startAbility(want).then(() => { ...@@ -224,7 +224,7 @@ context.startAbility(want).then(() => {
In the cross-device scenario, you must specify the ID of the remote device. The sample code is as follows: In the cross-device scenario, you must specify the ID of the remote device. The sample code is as follows:
```ts ```ts
let context = this.context let context = this.context
var want = { let want = {
"deviceId": getRemoteDeviceId(), "deviceId": getRemoteDeviceId(),
"bundleName": "com.example.MyApplication", "bundleName": "com.example.MyApplication",
"abilityName": "EntryAbility" "abilityName": "EntryAbility"
...@@ -239,9 +239,9 @@ Obtain the ID of a specified device from **DeviceManager**. The sample code is a ...@@ -239,9 +239,9 @@ Obtain the ID of a specified device from **DeviceManager**. The sample code is a
```ts ```ts
import deviceManager from '@ohos.distributedHardware.deviceManager'; import deviceManager from '@ohos.distributedHardware.deviceManager';
function getRemoteDeviceId() { function getRemoteDeviceId() {
if (typeof dmClass === 'object' && dmClass != null) { if (typeof dmClass === 'object' && dmClass !== null) {
var list = dmClass.getTrustedDeviceListSync(); let list = dmClass.getTrustedDeviceListSync();
if (typeof (list) == 'undefined' || typeof (list.length) == 'undefined') { if (typeof (list) === 'undefined' || typeof (list.length) === 'undefined') {
console.log("EntryAbility onButtonClick getRemoteDeviceId err: list is null"); console.log("EntryAbility onButtonClick getRemoteDeviceId err: list is null");
return; return;
} }
......
...@@ -31,12 +31,12 @@ The ability call process is as follows: ...@@ -31,12 +31,12 @@ The ability call process is as follows:
> Currently, only system applications can use the ability call. > Currently, only system applications can use the ability call.
## Available APIs ## Available APIs
The table below describes the ability call APIs. For details, see [Ability](../reference/apis/js-apis-application-ability.md#caller). The table below describes the ability call APIs. For details, see [UIAbility](../reference/apis/js-apis-app-ability-uiAbility.md#caller).
**Table 2** Ability call APIs **Table 2** Ability call APIs
|API|Description| |API|Description|
|:------|:------| |:------|:------|
|startAbilityByCall(want: Want): Promise\<Caller>|Starts an ability in the foreground (through the **want** configuration) or background (default) and obtains the **Caller** object for communication with the ability. For details, see [AbilityContext](../reference/apis/js-apis-ability-context.md#abilitycontextstartabilitybycall) or **ServiceExtensionContext**.| |startAbilityByCall(want: Want): Promise\<Caller>|Starts an ability in the foreground (through the **want** configuration) or background (default) and obtains the **Caller** object for communication with the ability. For details, see [AbilityContext](../reference/apis/js-apis-inner-application-uiAbilityContext.md#uiabilitycontextstartabilitybycall) or **ServiceExtensionContext**.|
|on(method: string, callback: CalleeCallBack): void|Callback invoked when the callee ability registers a method.| |on(method: string, callback: CalleeCallBack): void|Callback invoked when the callee ability registers a method.|
|off(method: string): void|Callback invoked when the callee ability deregisters a method.| |off(method: string): void|Callback invoked when the callee ability deregisters a method.|
|call(method: string, data: rpc.Sequenceable): Promise\<void>|Sends agreed sequenceable data to the callee ability.| |call(method: string, data: rpc.Sequenceable): Promise\<void>|Sends agreed sequenceable data to the callee ability.|
...@@ -47,40 +47,45 @@ The table below describes the ability call APIs. For details, see [Ability](../r ...@@ -47,40 +47,45 @@ The table below describes the ability call APIs. For details, see [Ability](../r
## How to Develop ## How to Develop
The procedure for developing the ability call is as follows: The procedure for developing the ability call is as follows:
1. Create a callee ability. 1. Create a callee ability.
2. Access the callee ability. 2. Access the callee ability.
### Creating a Callee Ability ### Creating a Callee Ability
For the callee ability, implement the callback to receive data and the methods to marshal and unmarshal data. When data needs to be received, use **on()** to register a listener. When data does not need to be received, use **off()** to deregister the listener. For the callee ability, implement the callback to receive data and the methods to marshal and unmarshal data. When data needs to be received, use **on()** to register a listener. When data does not need to be received, use **off()** to deregister the listener.
**1. Configure the ability launch type.**
1. **Configure the ability launch type.**
Set **launchType** of the callee ability to **singleton** in the **module.json5** file. Set **launchType** of the callee ability to **singleton** in the **module.json5** file.
|JSON Field|Description| |JSON Field|Description|
|:------|:------| |:------|:------|
|"launchType"|Ability launch type. Set this parameter to **singleton**.| |"launchType"|Ability launch type. Set this parameter to **singleton**.|
An example of the ability configuration is as follows: An example of the ability configuration is as follows:
```json
"abilities":[{ ```json
"abilities":[{
"name": ".CalleeAbility", "name": ".CalleeAbility",
"srcEntrance": "./ets/CalleeAbility/CalleeAbility.ts", "srcEntry": "./ets/CalleeAbility/CalleeAbility.ts",
"launchType": "singleton", "launchType": "singleton",
"description": "$string:CalleeAbility_desc", "description": "$string:CalleeAbility_desc",
"icon": "$media:icon", "icon": "$media:icon",
"label": "$string:CalleeAbility_label", "label": "$string:CalleeAbility_label",
"visible": true "exported": true
}] }]
``` ```
**2. Import the Ability module.**
```ts 2. **Import the UIAbility module.**
import Ability from '@ohos.app.ability.UIAbility'
``` ```ts
**3. Define the agreed sequenceable data.** import UIAbility from '@ohos.app.ability.UIAbility';
```
3. **Define the agreed sequenceable data.**
The data formats sent and received by the caller and callee abilities must be consistent. In the following example, the data formats are number and string. The code snippet is as follows: The data formats sent and received by the caller and callee abilities must be consistent. In the following example, the data formats are number and string. The code snippet is as follows:
```ts
export default class MySequenceable { ```ts
export default class MySequenceable {
num: number = 0 num: number = 0
str: string = "" str: string = ""
...@@ -100,16 +105,18 @@ export default class MySequenceable { ...@@ -100,16 +105,18 @@ export default class MySequenceable {
this.str = messageParcel.readString() this.str = messageParcel.readString()
return true return true
} }
} }
``` ```
**4. Implement Callee.on and Callee.off.**
4. **Implement Callee.on and Callee.off.**
The time to register a listener for the callee ability depends on your application. The data sent and received before the listener is registered and that after the listener is deregistered are not processed. In the following example, the **MSG_SEND_METHOD** listener is registered in **onCreate** of the ability and deregistered in **onDestroy**. After receiving sequenceable data, the application processes the data and returns the data result. You need to implement processing based on service requirements. The code snippet is as follows: The time to register a listener for the callee ability depends on your application. The data sent and received before the listener is registered and that after the listener is deregistered are not processed. In the following example, the **MSG_SEND_METHOD** listener is registered in **onCreate** of the ability and deregistered in **onDestroy**. After receiving sequenceable data, the application processes the data and returns the data result. You need to implement processing based on service requirements. The code snippet is as follows:
```ts
const TAG: string = '[CalleeAbility]'
const MSG_SEND_METHOD: string = 'CallSendMsg'
function sendMsgCallback(data) { ```ts
const TAG: string = '[CalleeAbility]'
const MSG_SEND_METHOD: string = 'CallSendMsg'
function sendMsgCallback(data) {
console.log('CalleeSortFunc called') console.log('CalleeSortFunc called')
// Obtain the sequenceable data sent by the caller ability. // Obtain the sequenceable data sent by the caller ability.
...@@ -120,9 +127,9 @@ function sendMsgCallback(data) { ...@@ -120,9 +127,9 @@ function sendMsgCallback(data) {
// Process the data. // Process the data.
// Return the sequenceable data result to the caller ability. // Return the sequenceable data result to the caller ability.
return new MySequenceable(receivedData.num + 1, `send ${receivedData.str} succeed`) return new MySequenceable(receivedData.num + 1, `send ${receivedData.str} succeed`)
} }
export default class CalleeAbility extends Ability { export default class CalleeAbility extends Ability {
onCreate(want, launchParam) { onCreate(want, launchParam) {
try { try {
this.callee.on(MSG_SEND_METHOD, sendMsgCallback) this.callee.on(MSG_SEND_METHOD, sendMsgCallback)
...@@ -138,20 +145,23 @@ export default class CalleeAbility extends Ability { ...@@ -138,20 +145,23 @@ export default class CalleeAbility extends Ability {
console.error(TAG, `${MSG_SEND_METHOD} unregister failed with error ${JSON.stringify(error)}`) console.error(TAG, `${MSG_SEND_METHOD} unregister failed with error ${JSON.stringify(error)}`)
} }
} }
} }
``` ```
### Accessing the Callee Ability ### Accessing the Callee Ability
**1. Import the Ability module.** 1. **Import the Ability module.**
```ts
import Ability from '@ohos.app.ability.UIAbility' ```ts
``` import UIAbility from '@ohos.app.ability.UIAbility';
**2. Obtain the Caller object.** ```
2. **Obtain the Caller object.**
The **context** attribute of the ability implements **startAbilityByCall** to obtain the **Caller** object for communication. The following example uses **this.context** to obtain the **context** attribute of the ability, uses **startAbilityByCall** to start the callee ability, obtain the **Caller** object, and register the **onRelease** listener of the caller ability. You need to implement processing based on service requirements. The code snippet is as follows: The **context** attribute of the ability implements **startAbilityByCall** to obtain the **Caller** object for communication. The following example uses **this.context** to obtain the **context** attribute of the ability, uses **startAbilityByCall** to start the callee ability, obtain the **Caller** object, and register the **onRelease** listener of the caller ability. You need to implement processing based on service requirements. The code snippet is as follows:
```ts
// Register the onRelease listener of the caller ability. ```ts
private regOnRelease(caller) { // Register the onRelease listener of the caller ability.
private regOnRelease(caller) {
try { try {
caller.on("release", (msg) => { caller.on("release", (msg) => {
console.log(`caller onRelease is called ${msg}`) console.log(`caller onRelease is called ${msg}`)
...@@ -160,9 +170,9 @@ private regOnRelease(caller) { ...@@ -160,9 +170,9 @@ private regOnRelease(caller) {
} catch (error) { } catch (error) {
console.log(`caller register OnRelease failed with ${error}`) console.log(`caller register OnRelease failed with ${error}`)
} }
} }
async onButtonGetCaller() { async onButtonGetCaller() {
try { try {
this.caller = await context.startAbilityByCall({ this.caller = await context.startAbilityByCall({
bundleName: 'com.samples.CallApplication', bundleName: 'com.samples.CallApplication',
...@@ -177,11 +187,13 @@ async onButtonGetCaller() { ...@@ -177,11 +187,13 @@ async onButtonGetCaller() {
} catch (error) { } catch (error) {
console.log(`get caller failed with ${error}`) console.log(`get caller failed with ${error}`)
} }
} }
``` ```
In the cross-device scenario, you need to specify the ID of the peer device. The code snippet is as follows: In the cross-device scenario, you need to specify the ID of the peer device. The code snippet is as follows:
```ts
async onButtonGetRemoteCaller() { ```ts
async onButtonGetRemoteCaller() {
var caller = undefined var caller = undefined
var context = this.context var context = this.context
...@@ -202,13 +214,15 @@ async onButtonGetRemoteCaller() { ...@@ -202,13 +214,15 @@ async onButtonGetRemoteCaller() {
}).catch((error) => { }).catch((error) => {
console.error(`get remote caller failed with ${error}`) console.error(`get remote caller failed with ${error}`)
}) })
} }
``` ```
Obtain the ID of the peer device from **DeviceManager**. Note that the **getTrustedDeviceListSync** API is open only to system applications. The code snippet is as follows: Obtain the ID of the peer device from **DeviceManager**. Note that the **getTrustedDeviceListSync** API is open only to system applications. The code snippet is as follows:
```ts
import deviceManager from '@ohos.distributedHardware.deviceManager'; ```ts
var dmClass; import deviceManager from '@ohos.distributedHardware.deviceManager';
function getRemoteDeviceId() { var dmClass;
function getRemoteDeviceId() {
if (typeof dmClass === 'object' && dmClass != null) { if (typeof dmClass === 'object' && dmClass != null) {
var list = dmClass.getTrustedDeviceListSync() var list = dmClass.getTrustedDeviceListSync()
if (typeof (list) == 'undefined' || typeof (list.length) == 'undefined') { if (typeof (list) == 'undefined' || typeof (list.length) == 'undefined') {
...@@ -220,13 +234,15 @@ function getRemoteDeviceId() { ...@@ -220,13 +234,15 @@ function getRemoteDeviceId() {
} else { } else {
console.log("EntryAbility onButtonClick getRemoteDeviceId err: dmClass is null") console.log("EntryAbility onButtonClick getRemoteDeviceId err: dmClass is null")
} }
} }
``` ```
In the cross-device scenario, your application must also apply for the data synchronization permission from end users. The code snippet is as follows: In the cross-device scenario, your application must also apply for the data synchronization permission from end users. The code snippet is as follows:
```ts
import abilityAccessCtrl from '@ohos.abilityAccessCtrl.d.ts';
requestPermission() { ```ts
import abilityAccessCtrl from '@ohos.abilityAccessCtrl.d.ts';
requestPermission() {
let context = this.context let context = this.context
let permissions: Array<string> = ['ohos.permission.DISTRIBUTED_DATASYNC'] let permissions: Array<string> = ['ohos.permission.DISTRIBUTED_DATASYNC']
let atManager = abilityAccessCtrl.createAtManager(); let atManager = abilityAccessCtrl.createAtManager();
...@@ -235,29 +251,32 @@ requestPermission() { ...@@ -235,29 +251,32 @@ requestPermission() {
}).catch((error) => { }).catch((error) => {
console.log("Failed to request permission from user with error: "+ JSON.stringify(error)) console.log("Failed to request permission from user with error: "+ JSON.stringify(error))
}) })
} }
``` ```
**3. Send agreed sequenceable data.**
3. **Send agreed sequenceable data.**
The sequenceable data can be sent to the callee ability with or without a return value. The method and sequenceable data must be consistent with those of the callee ability. The following example describes how to send data to the callee ability. The code snippet is as follows: The sequenceable data can be sent to the callee ability with or without a return value. The method and sequenceable data must be consistent with those of the callee ability. The following example describes how to send data to the callee ability. The code snippet is as follows:
```ts
const MSG_SEND_METHOD: string = 'CallSendMsg' ```ts
async onButtonCall() { const MSG_SEND_METHOD: string = 'CallSendMsg'
async onButtonCall() {
try { try {
let msg = new MySequenceable(1, 'origin_Msg') let msg = new MySequenceable(1, 'origin_Msg')
await this.caller.call(MSG_SEND_METHOD, msg) await this.caller.call(MSG_SEND_METHOD, msg)
} catch (error) { } catch (error) {
console.log(`caller call failed with ${error}`) console.log(`caller call failed with ${error}`)
} }
} }
``` ```
In the following, **CallWithResult** is used to send data **originMsg** to the callee ability and assign the data processed by the **CallSendMsg** method to **backMsg**. The code snippet is as follows: In the following, **CallWithResult** is used to send data **originMsg** to the callee ability and assign the data processed by the **CallSendMsg** method to **backMsg**. The code snippet is as follows:
```ts
const MSG_SEND_METHOD: string = 'CallSendMsg' ```ts
originMsg: string = '' const MSG_SEND_METHOD: string = 'CallSendMsg'
backMsg: string = '' originMsg: string = ''
async onButtonCallWithResult(originMsg, backMsg) { backMsg: string = ''
async onButtonCallWithResult(originMsg, backMsg) {
try { try {
let msg = new MySequenceable(1, originMsg) let msg = new MySequenceable(1, originMsg)
const data = await this.caller.callWithResult(MSG_SEND_METHOD, msg) const data = await this.caller.callWithResult(MSG_SEND_METHOD, msg)
...@@ -270,13 +289,15 @@ async onButtonCallWithResult(originMsg, backMsg) { ...@@ -270,13 +289,15 @@ async onButtonCallWithResult(originMsg, backMsg) {
} catch (error) { } catch (error) {
console.log(`caller callWithResult failed with ${error}`) console.log(`caller callWithResult failed with ${error}`)
} }
} }
``` ```
**4. Release the Caller object.**
4. **Release the Caller object.**
When the **Caller** object is no longer required, use **release()** to release it. The code snippet is as follows: When the **Caller** object is no longer required, use **release()** to release it. The code snippet is as follows:
```ts
releaseCall() { ```ts
releaseCall() {
try { try {
this.caller.release() this.caller.release()
this.caller = undefined this.caller = undefined
...@@ -284,5 +305,5 @@ releaseCall() { ...@@ -284,5 +305,5 @@ releaseCall() {
} catch (error) { } catch (error) {
console.log(`caller release failed with ${error}`) console.log(`caller release failed with ${error}`)
} }
} }
``` ```
\ No newline at end of file
...@@ -135,7 +135,7 @@ To create a widget in the stage model, you need to implement lifecycle callbacks ...@@ -135,7 +135,7 @@ To create a widget in the stage model, you need to implement lifecycle callbacks
| Name | Description | Data Type | Default Value Allowed | | Name | Description | Data Type | Default Value Allowed |
| ----------- | ------------------------------------------------------------ | ---------- | -------------------- | | ----------- | ------------------------------------------------------------ | ---------- | -------------------- |
| name | Name of the Extension ability. This field must be specified. | String | No | | name | Name of the Extension ability. This field must be specified. | String | No |
| srcEntrance | Path of the Extension ability lifecycle code. This field must be specified.| String | No | | srcEntry | Path of the Extension ability lifecycle code. This field must be specified.| String | No |
| description | Description of the Extension ability. The value can be a string or a resource index to descriptions in multiple languages.| String | Yes (initial value: left empty)| | description | Description of the Extension ability. The value can be a string or a resource index to descriptions in multiple languages.| String | Yes (initial value: left empty)|
| icon | Index of the Extension ability icon file. | String | Yes (initial value: left empty)| | icon | Index of the Extension ability icon file. | String | Yes (initial value: left empty)|
| label | Descriptive information about the Extension ability presented externally. The value can be a string or a resource index to the description.| String | Yes (initial value: left empty)| | label | Descriptive information about the Extension ability presented externally. The value can be a string or a resource index to the description.| String | Yes (initial value: left empty)|
...@@ -150,7 +150,7 @@ To create a widget in the stage model, you need to implement lifecycle callbacks ...@@ -150,7 +150,7 @@ To create a widget in the stage model, you need to implement lifecycle callbacks
```json ```json
"extensionAbilities": [{ "extensionAbilities": [{
"name": "FormAbility", "name": "FormAbility",
"srcEntrance": "./ets/FormAbility/FormAbility.ts", "srcEntry": "./ets/FormAbility/FormAbility.ts",
"label": "$string:form_FormAbility_label", "label": "$string:form_FormAbility_label",
"description": "$string:form_FormAbility_desc", "description": "$string:form_FormAbility_desc",
"type": "form", "type": "form",
...@@ -242,7 +242,7 @@ You should override **onDestroy** to implement widget data deletion. ...@@ -242,7 +242,7 @@ You should override **onDestroy** to implement widget data deletion.
} }
``` ```
For details about how to implement persistent data storage, see [Lightweight Data Store Development](../database/database-preference-guidelines.md). For details about how to implement persistent data storage, see [Application Data Persistence Overview](../database/app-data-persistence-overview.md).
The **Want** object passed in by the widget host to the widget provider contains a flag that specifies whether the requested widget is normal or temporary. The **Want** object passed in by the widget host to the widget provider contains a flag that specifies whether the requested widget is normal or temporary.
...@@ -366,7 +366,7 @@ You can set router and message events for components on a widget. The router eve ...@@ -366,7 +366,7 @@ You can set router and message events for components on a widget. The router eve
1. Set the **onclick** field in the HML file to **routerEvent** or **messageEvent**, depending on the **actions** settings in the JSON file. 1. Set the **onclick** field in the HML file to **routerEvent** or **messageEvent**, depending on the **actions** settings in the JSON file.
2. Set the router event. 2. Set the router event.
- **action**: **"router"**, which indicates a router event. - **action**: **"router"**, which indicates a router event.
- **abilityName**: target ability name, for example, **EntryAbility**, which is the default UIAbility name in DevEco Studio for the stage model. - **abilityName**: target ability name, for example, **EntryAbility**, which is the default main ability name in DevEco Studio for the stage model.
- **params**: custom parameters of the target ability. Set them as required. The value can be obtained from **parameters** in **want** used for starting the target ability. For example, in the lifecycle function **onCreate** of the EntryAbility in the stage model, you can obtain **want** and its **parameters** field. - **params**: custom parameters of the target ability. Set them as required. The value can be obtained from **parameters** in **want** used for starting the target ability. For example, in the lifecycle function **onCreate** of the EntryAbility in the stage model, you can obtain **want** and its **parameters** field.
3. Set the message event. 3. Set the message event.
- **action**: **"message"**, which indicates a message event. - **action**: **"message"**, which indicates a message event.
...@@ -413,3 +413,5 @@ The code snippet is as follows: ...@@ -413,3 +413,5 @@ The code snippet is as follows:
} }
} }
``` ```
<!--no_check-->
\ No newline at end of file
...@@ -33,8 +33,8 @@ OpenHarmony does not support creation of a Service Extension ability for third-p ...@@ -33,8 +33,8 @@ OpenHarmony does not support creation of a Service Extension ability for third-p
"icon": "$media:icon", "icon": "$media:icon",
"description": "service", "description": "service",
"type": "service", "type": "service",
"visible": true, "exported": true,
"srcEntrance": "./ets/ServiceExtAbility/ServiceExtAbility.ts" "srcEntry": "./ets/ServiceExtAbility/ServiceExtAbility.ts"
}] }]
``` ```
......
Markdown is supported
0% .
You are about to add 0 people to the discussion. Proceed with caution.
先完成此消息的编辑!
想要评论请 注册