提交 604f3f74 编写于 作者: G Gloria

Update docs against 13602

Signed-off-by: wusongqing<wusongqing@huawei.com>
上级 8bc22295
...@@ -224,7 +224,7 @@ Requests a continuous task from the system. This API uses an asynchronous callba ...@@ -224,7 +224,7 @@ Requests a continuous task from the system. This API uses an asynchronous callba
```ts ```ts
import notification from '@ohos.notification'; import notification from '@ohos.notification';
import particleAbility from '@ohos.ability.particleAbility'; import particleAbility from '@ohos.ability.particleAbility';
import wantAgent from '@ohos.wantAgent'; import wantAgent from '@ohos.app.ability.wantAgent';
function callback(err, data) { function callback(err, data) {
if (err) { if (err) {
...@@ -293,7 +293,7 @@ Requests a continuous task from the system. This API uses a promise to return th ...@@ -293,7 +293,7 @@ Requests a continuous task from the system. This API uses a promise to return th
```ts ```ts
import notification from '@ohos.notification'; import notification from '@ohos.notification';
import particleAbility from '@ohos.ability.particleAbility'; import particleAbility from '@ohos.ability.particleAbility';
import wantAgent from '@ohos.wantAgent'; import wantAgent from '@ohos.app.ability.wantAgent';
let wantAgentInfo = { let wantAgentInfo = {
wants: [ wants: [
...@@ -445,7 +445,6 @@ particleAbility.disconnectAbility(connId).then((data) => { ...@@ -445,7 +445,6 @@ particleAbility.disconnectAbility(connId).then((data) => {
}).catch((error) => { }).catch((error) => {
console.log('particleAbilityTest result errCode : ' + error.code) console.log('particleAbilityTest result errCode : ' + error.code)
}); });
``` ```
## particleAbility.disconnectAbility ## particleAbility.disconnectAbility
...@@ -491,10 +490,10 @@ var connId = particleAbility.connectAbility( ...@@ -491,10 +490,10 @@ var connId = particleAbility.connectAbility(
onFailed: onFailedCallback, onFailed: onFailedCallback,
}, },
); );
var result = particleAbility.disconnectAbility(connId).then((data) => {
console.log(" data: " + data); particleAbility.disconnectAbility(connId, (err) => {
}).catch((error) => { console.log("particleAbilityTest disconnectAbility err====>"
console.log('particleAbilityTest result errCode : ' + error.code) + ("json err=") + JSON.stringify(err));
}); });
``` ```
......
...@@ -9,7 +9,7 @@ The **Configuration** module defines environment change information. ...@@ -9,7 +9,7 @@ The **Configuration** module defines environment change information.
## Modules to Import ## Modules to Import
```ts ```ts
import Configuration from '@ohos.app.ability.Configuration' import Configuration from '@ohos.app.ability.Configuration';
``` ```
**System capability**: SystemCapability.Ability.AbilityBase **System capability**: SystemCapability.Ability.AbilityBase
...@@ -26,30 +26,30 @@ import Configuration from '@ohos.app.ability.Configuration' ...@@ -26,30 +26,30 @@ import Configuration from '@ohos.app.ability.Configuration'
For details about the fields, see the **ohos.app.ability.Configuration.d.ts** file. For details about the fields, see the **ohos.app.ability.Configuration.d.ts** file.
**Example** **Example**
```ts ```ts
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 {
onCreate(want, launchParam) { onCreate(want, launchParam) {
let envCallback = { let envCallback = {
onConfigurationUpdated(config) { onConfigurationUpdated(config) {
console.info(`envCallback onConfigurationUpdated success: ${JSON.stringify(config)}`) console.info(`envCallback onConfigurationUpdated success: ${JSON.stringify(config)}`)
let language = config.language; let language = config.language;
let colorMode = config.colorMode; let colorMode = config.colorMode;
let direction = config.direction; let direction = config.direction;
let screenDensity = config.screenDensity; let screenDensity = config.screenDensity;
let displayId = config.displayId; let displayId = config.displayId;
let hasPointerDevice = config.hasPointerDevice; let hasPointerDevice = config.hasPointerDevice;
}
};
try {
let applicationContext = this.context.getApplicationContext();
let callbackId = applicationContext.on("environment", envCallback);
console.log("callbackId: " + callbackId);
} catch (paramError) {
console.log("error: " + paramError.code + ", " + paramError.message);
} }
};
try {
let applicationContext = this.context.getApplicationContext();
let callbackId = applicationContext.on("environment", envCallback);
console.log("callbackId: " + callbackId);
} catch (paramError) {
console.log("error: " + paramError.code + ", " + paramError.message);
}
} }
} }
``` ```
...@@ -124,7 +124,7 @@ Updates a widget. This API uses an asynchronous callback to return the result. ...@@ -124,7 +124,7 @@ Updates a widget. This API uses an asynchronous callback to return the result.
**Example** **Example**
```ts ```ts
import formBindingData from '@ohos.application.formBindingData'; import formBindingData from '@ohos.app.form.formBindingData';
import formProvider from '@ohos.app.form.formProvider'; import formProvider from '@ohos.app.form.formProvider';
let formId = "12400633174999288"; let formId = "12400633174999288";
...@@ -173,7 +173,7 @@ Updates a widget. This API uses a promise to return the result. ...@@ -173,7 +173,7 @@ Updates a widget. This API uses a promise to return the result.
**Example** **Example**
```ts ```ts
import formBindingData from '@ohos.application.formBindingData'; import formBindingData from '@ohos.app.form.formBindingData';
import formProvider from '@ohos.app.form.formProvider'; import formProvider from '@ohos.app.form.formProvider';
let formId = "12400633174999288"; let formId = "12400633174999288";
...@@ -349,7 +349,7 @@ Requests to publish a widget carrying data to the widget host. This API uses an ...@@ -349,7 +349,7 @@ Requests to publish a widget carrying data to the widget host. This API uses an
**Example** **Example**
```ts ```ts
import formBindingData from '@ohos.application.formBindingData'; import formBindingData from '@ohos.app.form.formBindingData';
import formProvider from '@ohos.app.form.formProvider'; import formProvider from '@ohos.app.form.formProvider';
let want = { let want = {
......
...@@ -8,14 +8,17 @@ This module provides the following common ability-related functions: ...@@ -8,14 +8,17 @@ This module provides the following common ability-related functions:
- [Callee](#callee): implements callbacks for registration and deregistration of caller notifications. - [Callee](#callee): implements callbacks for registration and deregistration of caller notifications.
> **NOTE** > **NOTE**
> >
> The initial APIs of this module are supported since API version 9. Newly added APIs will be marked with a superscript to indicate their earliest API version. > The APIs of this module are deprecated since API version 9. You are advised to use [@ohos.app.ability.UIAbility (UIAbility)](js-apis-app-ability-uiAbility.md) instead.
>
> The initial APIs of this module are supported since API version 9. Newly added APIs will be marked with a superscript to indicate their earliest API version.
>
> The APIs of this module can be used only in the stage model. > The APIs of this module can be used only in the stage model.
## Modules to Import ## Modules to Import
```ts ```ts
import UIAbility from '@ohos.app.ability.UIAbility'; import UIAbility from '@ohos.application.Ability';
``` ```
## Attributes ## Attributes
...@@ -72,7 +75,7 @@ Called when a **WindowStage** is created for this ability. ...@@ -72,7 +75,7 @@ Called when a **WindowStage** is created for this ability.
**Example** **Example**
```ts ```ts
class myAbility extends Ability { export default class EntryAbility extends UIAbility {
onWindowStageCreate(windowStage) { onWindowStageCreate(windowStage) {
console.log('onWindowStageCreate'); console.log('onWindowStageCreate');
} }
...@@ -91,7 +94,7 @@ Called when the **WindowStage** is destroyed for this ability. ...@@ -91,7 +94,7 @@ Called when the **WindowStage** is destroyed for this ability.
**Example** **Example**
```ts ```ts
class myAbility extends Ability { export default class EntryAbility extends UIAbility {
onWindowStageDestroy() { onWindowStageDestroy() {
console.log('onWindowStageDestroy'); console.log('onWindowStageDestroy');
} }
...@@ -116,7 +119,7 @@ Called when the **WindowStage** is restored during the migration of this ability ...@@ -116,7 +119,7 @@ Called when the **WindowStage** is restored during the migration of this ability
**Example** **Example**
```ts ```ts
class myAbility extends Ability { export default class EntryAbility extends UIAbility {
onWindowStageRestore(windowStage) { onWindowStageRestore(windowStage) {
console.log('onWindowStageRestore'); console.log('onWindowStageRestore');
} }
...@@ -133,9 +136,9 @@ Called when this ability is destroyed to clear resources. ...@@ -133,9 +136,9 @@ Called when this ability is destroyed to clear resources.
**System capability**: SystemCapability.Ability.AbilityRuntime.AbilityCore **System capability**: SystemCapability.Ability.AbilityRuntime.AbilityCore
**Example** **Example**
```ts ```ts
class myAbility extends Ability { export default class EntryAbility extends UIAbility {
onDestroy() { onDestroy() {
console.log('onDestroy'); console.log('onDestroy');
} }
...@@ -152,9 +155,9 @@ Called when this ability is switched from the background to the foreground. ...@@ -152,9 +155,9 @@ Called when this ability is switched from the background to the foreground.
**System capability**: SystemCapability.Ability.AbilityRuntime.AbilityCore **System capability**: SystemCapability.Ability.AbilityRuntime.AbilityCore
**Example** **Example**
```ts ```ts
class myAbility extends Ability { export default class EntryAbility extends UIAbility {
onForeground() { onForeground() {
console.log('onForeground'); console.log('onForeground');
} }
...@@ -171,9 +174,9 @@ Called when this ability is switched from the foreground to the background. ...@@ -171,9 +174,9 @@ Called when this ability is switched from the foreground to the background.
**System capability**: SystemCapability.Ability.AbilityRuntime.AbilityCore **System capability**: SystemCapability.Ability.AbilityRuntime.AbilityCore
**Example** **Example**
```ts ```ts
class myAbility extends Ability { export default class EntryAbility extends UIAbility {
onBackground() { onBackground() {
console.log('onBackground'); console.log('onBackground');
} }
...@@ -202,10 +205,11 @@ Called to save data during the ability migration preparation process. ...@@ -202,10 +205,11 @@ Called to save data during the ability migration preparation process.
| AbilityConstant.OnContinueResult | Continuation result.| | AbilityConstant.OnContinueResult | Continuation result.|
**Example** **Example**
```ts ```ts
import AbilityConstant from "@ohos.application.AbilityConstant" import AbilityConstant from "@ohos.app.ability.AbilityConstant";
class myAbility extends Ability {
export default class EntryAbility extends UIAbility {
onContinue(wantParams) { onContinue(wantParams) {
console.log('onContinue'); console.log('onContinue');
wantParams["myData"] = "my1234567"; wantParams["myData"] = "my1234567";
...@@ -231,9 +235,9 @@ Called when a new Want is passed in and this UIAbility is started again. ...@@ -231,9 +235,9 @@ Called when a new Want is passed in and this UIAbility is started again.
| launchParams | AbilityConstant.LaunchParam | Yes| Reason for the ability startup and the last abnormal exit.| | launchParams | AbilityConstant.LaunchParam | Yes| Reason for the ability startup and the last abnormal exit.|
**Example** **Example**
```ts ```ts
class myAbility extends Ability { export default class EntryAbility extends UIAbility {
onNewWant(want, launchParams) { onNewWant(want, launchParams) {
console.log('onNewWant, want:' + want.abilityName); console.log('onNewWant, want:' + want.abilityName);
console.log('onNewWant, launchParams:' + JSON.stringify(launchParams)); console.log('onNewWant, launchParams:' + JSON.stringify(launchParams));
...@@ -256,9 +260,9 @@ Called when the global configuration is updated. ...@@ -256,9 +260,9 @@ Called when the global configuration is updated.
| config | [Configuration](js-apis-application-configuration.md) | Yes| Callback invoked when the global configuration is updated. The global configuration indicates the configuration of the environment where the application is running and includes the language and color mode.| | config | [Configuration](js-apis-application-configuration.md) | Yes| Callback invoked when the global configuration is updated. The global configuration indicates the configuration of the environment where the application is running and includes the language and color mode.|
**Example** **Example**
```ts ```ts
class myAbility extends Ability { export default class EntryAbility extends UIAbility {
onConfigurationUpdated(config) { onConfigurationUpdated(config) {
console.log('onConfigurationUpdated, language:' + config.language); console.log('onConfigurationUpdated, language:' + config.language);
} }
...@@ -280,9 +284,9 @@ Dumps client information. ...@@ -280,9 +284,9 @@ Dumps client information.
| params | Array\<string> | Yes| Parameters in the form of a command.| | params | Array\<string> | Yes| Parameters in the form of a command.|
**Example** **Example**
```ts ```ts
class myAbility extends Ability { export default class EntryAbility extends UIAbility {
dump(params) { dump(params) {
console.log('dump, params:' + JSON.stringify(params)); console.log('dump, params:' + JSON.stringify(params));
return ["params"] return ["params"]
...@@ -305,9 +309,9 @@ Called when the system has decided to adjust the memory level. For example, this ...@@ -305,9 +309,9 @@ Called when the system has decided to adjust the memory level. For example, this
| level | [AbilityConstant.MemoryLevel](js-apis-application-abilityConstant.md#abilityconstantmemorylevel) | Yes| Memory level that indicates the memory usage status. When the specified memory level is reached, a callback will be invoked and the system will start adjustment.| | level | [AbilityConstant.MemoryLevel](js-apis-application-abilityConstant.md#abilityconstantmemorylevel) | Yes| Memory level that indicates the memory usage status. When the specified memory level is reached, a callback will be invoked and the system will start adjustment.|
**Example** **Example**
```ts ```ts
class myAbility extends Ability { export default class EntryAbility extends UIAbility {
onMemoryLevel(level) { onMemoryLevel(level) {
console.log('onMemoryLevel, level:' + JSON.stringify(level)); console.log('onMemoryLevel, level:' + JSON.stringify(level));
} }
...@@ -338,9 +342,9 @@ Called when the framework automatically saves the ability state in the case of a ...@@ -338,9 +342,9 @@ Called when the framework automatically saves the ability state in the case of a
**Example** **Example**
```ts ```ts
import AbilityConstant from '@ohos.application.AbilityConstant' import AbilityConstant from '@ohos.app.ability.AbilityConstant';
class myAbility extends Ability { export default class EntryAbility extends UIAbility {
onSaveState(reason, wantParam) { onSaveState(reason, wantParam) {
console.log('onSaveState'); console.log('onSaveState');
wantParam["myData"] = "my1234567"; wantParam["myData"] = "my1234567";
...@@ -349,8 +353,6 @@ class myAbility extends Ability { ...@@ -349,8 +353,6 @@ class myAbility extends Ability {
} }
``` ```
## Caller ## Caller
Implements sending of sequenceable data to the target ability when an ability (caller ability) invokes the target ability (callee ability). Implements sending of sequenceable data to the target ability when an ability (caller ability) invokes the target ability (callee ability).
...@@ -387,7 +389,7 @@ Sends sequenceable data to the target ability. ...@@ -387,7 +389,7 @@ Sends sequenceable data to the target ability.
| 16000050 | Internal Error. | | 16000050 | Internal Error. |
**Example** **Example**
```ts ```ts
import UIAbility from '@ohos.app.ability.UIAbility'; import UIAbility from '@ohos.app.ability.UIAbility';
...@@ -545,7 +547,6 @@ Releases the caller interface of the target ability. ...@@ -545,7 +547,6 @@ Releases the caller interface of the target ability.
| 16000050 | Internal Error. | | 16000050 | Internal Error. |
**Example** **Example**
```ts ```ts
import UIAbility from '@ohos.app.ability.UIAbility'; import UIAbility from '@ohos.app.ability.UIAbility';
...@@ -589,7 +590,7 @@ Registers a callback that is invoked when the stub on the target ability is disc ...@@ -589,7 +590,7 @@ Registers a callback that is invoked when the stub on the target ability is disc
| callback | OnReleaseCallBack | Yes| Callback used for the **onRelease** API.| | callback | OnReleaseCallBack | Yes| Callback used for the **onRelease** API.|
**Example** **Example**
```ts ```ts
import UIAbility from '@ohos.app.ability.UIAbility'; import UIAbility from '@ohos.app.ability.UIAbility';
...@@ -716,7 +717,6 @@ Deregisters a caller notification callback, which is invoked when the target abi ...@@ -716,7 +717,6 @@ Deregisters a caller notification callback, which is invoked when the target abi
**Example** **Example**
```ts ```ts
import UIAbility from '@ohos.app.ability.UIAbility'; import UIAbility from '@ohos.app.ability.UIAbility';
......
...@@ -9,7 +9,7 @@ The **AbilityDelegatorRegistry** module provides APIs for storing the global reg ...@@ -9,7 +9,7 @@ The **AbilityDelegatorRegistry** module provides APIs for storing the global reg
## Modules to Import ## Modules to Import
```ts ```ts
import AbilityDelegatorRegistry from '@ohos.application.abilityDelegatorRegistry' import AbilityDelegatorRegistry from '@ohos.application.abilityDelegatorRegistry';
``` ```
## AbilityLifecycleState ## AbilityLifecycleState
......
...@@ -156,7 +156,7 @@ Called when an ability is continued on another device. ...@@ -156,7 +156,7 @@ Called when an ability is continued on another device.
**Example** **Example**
```ts ```ts
import AbilityStage from "@ohos.application.AbilityStage"; import AbilityStage from "@ohos.app.ability.AbilityStage";
var lifecycleId; var lifecycleId;
......
...@@ -10,7 +10,7 @@ The **AbilityManager** module provides APIs for obtaining, adding, and modifying ...@@ -10,7 +10,7 @@ The **AbilityManager** module provides APIs for obtaining, adding, and modifying
## Modules to Import ## Modules to Import
```ts ```ts
import abilityManager from '@ohos.application.abilityManager' import abilityManager from '@ohos.application.abilityManager';
``` ```
## AbilityState ## AbilityState
...@@ -38,7 +38,7 @@ Updates the configuration. This API uses an asynchronous callback to return the ...@@ -38,7 +38,7 @@ Updates the configuration. This API uses an asynchronous callback to return the
**Permission required**: ohos.permission.UPDATE_CONFIGURATION **Permission required**: ohos.permission.UPDATE_CONFIGURATION
**System capability**: SystemCapability.Ability.AbilityRuntime.Core **System capability**: SystemCapability.Ability.AbilityRuntime.Core
**Parameters** **Parameters**
| Name | Type | Mandatory | Description | | Name | Type | Mandatory | Description |
...@@ -176,7 +176,7 @@ abilityManager.getExtensionRunningInfos(upperLimit, (err,data) => { ...@@ -176,7 +176,7 @@ abilityManager.getExtensionRunningInfos(upperLimit, (err,data) => {
getExtensionRunningInfos(upperLimit: number): Promise\<Array\<ExtensionRunningInfo>> getExtensionRunningInfos(upperLimit: number): Promise\<Array\<ExtensionRunningInfo>>
Obtains the extension running information. This API uses a promise to return the result. Obtains the extension running information. This API uses a promise to return the result.
**Required permissions**: ohos.permission.GET_RUNNING_INFO **Required permissions**: ohos.permission.GET_RUNNING_INFO
**System capability**: SystemCapability.Ability.AbilityRuntime.Core **System capability**: SystemCapability.Ability.AbilityRuntime.Core
...@@ -232,7 +232,7 @@ abilityManager.getTopAbility((err,data) => { ...@@ -232,7 +232,7 @@ abilityManager.getTopAbility((err,data) => {
getTopAbility(): Promise\<ElementName>; getTopAbility(): Promise\<ElementName>;
Obtains the top ability, which is the ability that has the window focus. This API uses a promise to return the result. Obtains the top ability, which is the ability that has the window focus. This API uses a promise to return the result.
**System capability**: SystemCapability.Ability.AbilityRuntime.Core **System capability**: SystemCapability.Ability.AbilityRuntime.Core
**Return value** **Return value**
......
...@@ -420,7 +420,7 @@ Deregisters the application state observer. This API uses a promise to return th ...@@ -420,7 +420,7 @@ Deregisters the application state observer. This API uses a promise to return th
getForegroundApplications(callback: AsyncCallback\<Array\<AppStateData>>): void; getForegroundApplications(callback: AsyncCallback\<Array\<AppStateData>>): void;
Obtains information about the applications that are running in the foreground. This API uses an asynchronous callback to return the result. The application information is defined by [AppStateData](js-apis-inner-application-appStateData.md). Obtains information about the applications that are running in the foreground. This API uses an asynchronous callback to return the result. The application information is defined by [AppStateData](js-apis-inner-application-appStateData.md).
**Required permissions**: ohos.permission.GET_RUNNING_INFO **Required permissions**: ohos.permission.GET_RUNNING_INFO
**System capability**: SystemCapability.Ability.AbilityRuntime.Core **System capability**: SystemCapability.Ability.AbilityRuntime.Core
......
...@@ -26,7 +26,6 @@ import Configuration from '@ohos.application.Configuration' ...@@ -26,7 +26,6 @@ import Configuration from '@ohos.application.Configuration'
For details about the fields, see the **ohos.application.Configuration.d.ts** file. For details about the fields, see the **ohos.application.Configuration.d.ts** file.
**Example** **Example**
```ts ```ts
import hilog from '@ohos.hilog'; import hilog from '@ohos.hilog';
import UIAbility from '@ohos.app.ability.UIAbility'; import UIAbility from '@ohos.app.ability.UIAbility';
......
...@@ -8,7 +8,7 @@ The **ErrorManager** module provides APIs for registering and deregistering erro ...@@ -8,7 +8,7 @@ The **ErrorManager** module provides APIs for registering and deregistering erro
## Modules to Import ## Modules to Import
```ts ```ts
import errorManager from '@ohos.application.errorManager' import errorManager from '@ohos.application.errorManager';
``` ```
## ErrorManager.registerErrorObserver ## ErrorManager.registerErrorObserver
...@@ -20,7 +20,7 @@ Registers an error observer. ...@@ -20,7 +20,7 @@ Registers an error observer.
**System capability**: SystemCapability.Ability.AbilityRuntime.Core **System capability**: SystemCapability.Ability.AbilityRuntime.Core
**Parameters** **Parameters**
| Name| Type| Mandatory| Description| | Name| Type| Mandatory| Description|
| -------- | -------- | -------- | -------- | | -------- | -------- | -------- | -------- |
| observer | [ErrorObserver](js-apis-inner-application-errorObserver.md) | Yes| Numeric code of the observer.| | observer | [ErrorObserver](js-apis-inner-application-errorObserver.md) | Yes| Numeric code of the observer.|
...@@ -45,7 +45,7 @@ Deregisters an error observer. This API uses an asynchronous callback to return ...@@ -45,7 +45,7 @@ Deregisters an error observer. This API uses an asynchronous callback to return
**System capability**: SystemCapability.Ability.AbilityRuntime.Core **System capability**: SystemCapability.Ability.AbilityRuntime.Core
**Parameters** **Parameters**
| Name| Type| Mandatory| Description| | Name| Type| Mandatory| Description|
| -------- | -------- | -------- | -------- | | -------- | -------- | -------- | -------- |
| observerId | number | Yes| Numeric code of the observer.| | observerId | number | Yes| Numeric code of the observer.|
...@@ -74,7 +74,7 @@ Deregisters an error observer. This API uses a promise to return the result. ...@@ -74,7 +74,7 @@ Deregisters an error observer. This API uses a promise to return the result.
**System capability**: SystemCapability.Ability.AbilityRuntime.Core **System capability**: SystemCapability.Ability.AbilityRuntime.Core
**Parameters** **Parameters**
| Name| Type| Mandatory| Description| | Name| Type| Mandatory| Description|
| -------- | -------- | -------- | -------- | | -------- | -------- | -------- | -------- |
| observerId | number | Yes| Numeric code of the observer.| | observerId | number | Yes| Numeric code of the observer.|
......
...@@ -48,7 +48,7 @@ Creates a **FormBindingData** object. ...@@ -48,7 +48,7 @@ Creates a **FormBindingData** object.
**Example** **Example**
```ts ```ts
import formBindingData from @ohos.application.formBindingData; import formBindingData from '@ohos.application.formBindingData';
import fs from '@ohos.file.fs'; import fs from '@ohos.file.fs';
try { try {
......
...@@ -94,7 +94,7 @@ Updates a widget. This API uses an asynchronous callback to return the result. ...@@ -94,7 +94,7 @@ Updates a widget. This API uses an asynchronous callback to return the result.
**Example** **Example**
```ts ```ts
import formBindingData from '@ohos.application.formBindingData'; import formBindingData from '@ohos.app.form.formBindingData';
import formProvider from '@ohos.app.form.formProvider'; import formProvider from '@ohos.app.form.formProvider';
let formId = "12400633174999288"; let formId = "12400633174999288";
......
...@@ -1001,7 +1001,7 @@ For details about the error codes, see [AVSession Management Error Codes](../err ...@@ -1001,7 +1001,7 @@ For details about the error codes, see [AVSession Management Error Codes](../err
**Example** **Example**
```js ```js
import wantAgent from '@ohos.wantAgent'; import wantAgent from '@ohos.app.ability.wantAgent';
// WantAgentInfo object // WantAgentInfo object
let wantAgentInfo = { let wantAgentInfo = {
...@@ -1066,7 +1066,7 @@ For details about the error codes, see [AVSession Management Error Codes](../err ...@@ -1066,7 +1066,7 @@ For details about the error codes, see [AVSession Management Error Codes](../err
**Example** **Example**
```js ```js
import wantAgent from '@ohos.wantAgent'; import wantAgent from '@ohos.app.ability.wantAgent';
// WantAgentInfo object // WantAgentInfo object
let wantAgentInfo = { let wantAgentInfo = {
...@@ -2222,7 +2222,7 @@ For details about the error codes, see [AVSession Management Error Codes](../err ...@@ -2222,7 +2222,7 @@ For details about the error codes, see [AVSession Management Error Codes](../err
**Example** **Example**
```js ```js
import wantAgent from '@ohos.wantAgent'; import wantAgent from '@ohos.app.ability.wantAgent';
controller.getLaunchAbility().then((agent) => { controller.getLaunchAbility().then((agent) => {
console.info(`GetLaunchAbility : SUCCESS : wantAgent : ${agent}`); console.info(`GetLaunchAbility : SUCCESS : wantAgent : ${agent}`);
...@@ -2257,7 +2257,7 @@ For details about the error codes, see [AVSession Management Error Codes](../err ...@@ -2257,7 +2257,7 @@ For details about the error codes, see [AVSession Management Error Codes](../err
**Example** **Example**
```js ```js
import wantAgent from '@ohos.wantAgent'; import wantAgent from '@ohos.app.ability.wantAgent';
controller.getLaunchAbility(function (err, agent) { controller.getLaunchAbility(function (err, agent) {
if (err) { if (err) {
......
...@@ -173,7 +173,7 @@ FA model: ...@@ -173,7 +173,7 @@ FA model:
```js ```js
import backgroundTaskManager from '@ohos.backgroundTaskManager'; import backgroundTaskManager from '@ohos.backgroundTaskManager';
import featureAbility from '@ohos.ability.featureAbility'; import featureAbility from '@ohos.ability.featureAbility';
import wantAgent from '@ohos.wantAgent'; import wantAgent from '@ohos.app.ability.wantAgent';
function callback(err, data) { function callback(err, data) {
if (err) { if (err) {
...@@ -207,7 +207,7 @@ Stage model: ...@@ -207,7 +207,7 @@ Stage model:
```ts ```ts
import UIAbility from '@ohos.app.ability.UIAbility'; import UIAbility from '@ohos.app.ability.UIAbility';
import backgroundTaskManager from '@ohos.backgroundTaskManager'; import backgroundTaskManager from '@ohos.backgroundTaskManager';
import wantAgent from '@ohos.wantAgent'; import wantAgent from '@ohos.app.ability.wantAgent';
function callback(err, data) { function callback(err, data) {
if (err) { if (err) {
...@@ -270,7 +270,7 @@ FA model: ...@@ -270,7 +270,7 @@ FA model:
```js ```js
import backgroundTaskManager from '@ohos.backgroundTaskManager'; import backgroundTaskManager from '@ohos.backgroundTaskManager';
import featureAbility from '@ohos.ability.featureAbility'; import featureAbility from '@ohos.ability.featureAbility';
import wantAgent from '@ohos.wantAgent'; import wantAgent from '@ohos.app.ability.wantAgent';
let wantAgentInfo = { let wantAgentInfo = {
wants: [ wants: [
...@@ -299,7 +299,7 @@ Stage model: ...@@ -299,7 +299,7 @@ Stage model:
```ts ```ts
import UIAbility from '@ohos.app.ability.UIAbility'; import UIAbility from '@ohos.app.ability.UIAbility';
import backgroundTaskManager from '@ohos.backgroundTaskManager'; import backgroundTaskManager from '@ohos.backgroundTaskManager';
import wantAgent from '@ohos.wantAgent'; import wantAgent from '@ohos.app.ability.wantAgent';
export default class EntryAbility extends UIAbility { export default class EntryAbility extends UIAbility {
onCreate(want, launchParam) { onCreate(want, launchParam) {
......
...@@ -10,7 +10,7 @@ The **AbilityDelegator** module provides APIs for managing **AbilityMonitor** in ...@@ -10,7 +10,7 @@ The **AbilityDelegator** module provides APIs for managing **AbilityMonitor** in
An **AbilityDelegator** object is obtained by calling [getAbilityDelegator](js-apis-app-ability-abilityDelegatorRegistry.md#abilitydelegatorregistrygetabilitydelegator) in **AbilityDelegatorRegistry**. An **AbilityDelegator** object is obtained by calling [getAbilityDelegator](js-apis-app-ability-abilityDelegatorRegistry.md#abilitydelegatorregistrygetabilitydelegator) in **AbilityDelegatorRegistry**.
```ts ```ts
import AbilityDelegatorRegistry from '@ohos.application.abilityDelegatorRegistry' import AbilityDelegatorRegistry from '@ohos.app.ability.abilityDelegatorRegistry';
let abilityDelegator = AbilityDelegatorRegistry.getAbilityDelegator(); let abilityDelegator = AbilityDelegatorRegistry.getAbilityDelegator();
``` ```
...@@ -35,13 +35,13 @@ Adds an **AbilityMonitor** instance. This API uses an asynchronous callback to r ...@@ -35,13 +35,13 @@ Adds an **AbilityMonitor** instance. This API uses an asynchronous callback to r
**Example** **Example**
```ts ```ts
var abilityDelegator; let abilityDelegator;
function onAbilityCreateCallback(data) { function onAbilityCreateCallback(data) {
console.info("onAbilityCreateCallback"); console.info("onAbilityCreateCallback");
} }
var monitor = { let monitor = {
abilityName: "abilityname", abilityName: "abilityname",
onAbilityCreate: onAbilityCreateCallback onAbilityCreate: onAbilityCreateCallback
} }
...@@ -75,13 +75,13 @@ Adds an **AbilityMonitor** instance. This API uses a promise to return the resul ...@@ -75,13 +75,13 @@ Adds an **AbilityMonitor** instance. This API uses a promise to return the resul
**Example** **Example**
```ts ```ts
var abilityDelegator; let abilityDelegator;
function onAbilityCreateCallback(data) { function onAbilityCreateCallback(data) {
console.info("onAbilityCreateCallback"); console.info("onAbilityCreateCallback");
} }
var monitor = { let monitor = {
abilityName: "abilityname", abilityName: "abilityname",
onAbilityCreate: onAbilityCreateCallback onAbilityCreate: onAbilityCreateCallback
} }
...@@ -92,8 +92,6 @@ abilityDelegator.addAbilityMonitor(monitor).then(() => { ...@@ -92,8 +92,6 @@ abilityDelegator.addAbilityMonitor(monitor).then(() => {
}); });
``` ```
### removeAbilityMonitor<sup>9+</sup> ### removeAbilityMonitor<sup>9+</sup>
removeAbilityMonitor(monitor: AbilityMonitor, callback: AsyncCallback\<void>): void; removeAbilityMonitor(monitor: AbilityMonitor, callback: AsyncCallback\<void>): void;
...@@ -112,13 +110,13 @@ Removes an **AbilityMonitor** instance. This API uses an asynchronous callback t ...@@ -112,13 +110,13 @@ Removes an **AbilityMonitor** instance. This API uses an asynchronous callback t
**Example** **Example**
```ts ```ts
var abilityDelegator; let abilityDelegator;
function onAbilityCreateCallback(data) { function onAbilityCreateCallback(data) {
console.info("onAbilityCreateCallback"); console.info("onAbilityCreateCallback");
} }
var monitor = { let monitor = {
abilityName: "abilityname", abilityName: "abilityname",
onAbilityCreate: onAbilityCreateCallback onAbilityCreate: onAbilityCreateCallback
} }
...@@ -129,8 +127,6 @@ abilityDelegator.removeAbilityMonitor(monitor, (err : any) => { ...@@ -129,8 +127,6 @@ abilityDelegator.removeAbilityMonitor(monitor, (err : any) => {
}); });
``` ```
### removeAbilityMonitor<sup>9+</sup> ### removeAbilityMonitor<sup>9+</sup>
removeAbilityMonitor(monitor: AbilityMonitor): Promise\<void>; removeAbilityMonitor(monitor: AbilityMonitor): Promise\<void>;
...@@ -154,13 +150,13 @@ Removes an **AbilityMonitor** instance. This API uses a promise to return the re ...@@ -154,13 +150,13 @@ Removes an **AbilityMonitor** instance. This API uses a promise to return the re
- Example - Example
```ts ```ts
var abilityDelegator; let abilityDelegator;
function onAbilityCreateCallback(data) { function onAbilityCreateCallback(data) {
console.info("onAbilityCreateCallback"); console.info("onAbilityCreateCallback");
} }
var monitor = { let monitor = {
abilityName: "abilityname", abilityName: "abilityname",
onAbilityCreate: onAbilityCreateCallback onAbilityCreate: onAbilityCreateCallback
} }
...@@ -171,8 +167,6 @@ abilityDelegator.removeAbilityMonitor(monitor).then(() => { ...@@ -171,8 +167,6 @@ abilityDelegator.removeAbilityMonitor(monitor).then(() => {
}); });
``` ```
### waitAbilityMonitor<sup>9+</sup> ### waitAbilityMonitor<sup>9+</sup>
waitAbilityMonitor(monitor: AbilityMonitor, callback: AsyncCallback\<UIAbility>): void; waitAbilityMonitor(monitor: AbilityMonitor, callback: AsyncCallback\<UIAbility>): void;
...@@ -191,13 +185,13 @@ Waits for the **Ability** instance that matches the **AbilityMonitor** instance ...@@ -191,13 +185,13 @@ Waits for the **Ability** instance that matches the **AbilityMonitor** instance
**Example** **Example**
```ts ```ts
var abilityDelegator; let abilityDelegator;
function onAbilityCreateCallback(data) { function onAbilityCreateCallback(data) {
console.info("onAbilityCreateCallback"); console.info("onAbilityCreateCallback");
} }
var monitor = { let monitor = {
abilityName: "abilityname", abilityName: "abilityname",
onAbilityCreate: onAbilityCreateCallback onAbilityCreate: onAbilityCreateCallback
} }
...@@ -227,14 +221,14 @@ Waits a period of time for the **Ability** instance that matches the **AbilityMo ...@@ -227,14 +221,14 @@ Waits a period of time for the **Ability** instance that matches the **AbilityMo
**Example** **Example**
```ts ```ts
var abilityDelegator; let abilityDelegator;
var timeout = 100; let timeout = 100;
function onAbilityCreateCallback(data) { function onAbilityCreateCallback(data) {
console.info("onAbilityCreateCallback"); console.info("onAbilityCreateCallback");
} }
var monitor = { let monitor = {
abilityName: "abilityname", abilityName: "abilityname",
onAbilityCreate: onAbilityCreateCallback onAbilityCreate: onAbilityCreateCallback
} }
...@@ -271,13 +265,13 @@ Waits a period of time for the **Ability** instance that matches the **AbilityMo ...@@ -271,13 +265,13 @@ Waits a period of time for the **Ability** instance that matches the **AbilityMo
**Example** **Example**
```ts ```ts
var abilityDelegator; let abilityDelegator;
function onAbilityCreateCallback(data) { function onAbilityCreateCallback(data) {
console.info("onAbilityCreateCallback"); console.info("onAbilityCreateCallback");
} }
var monitor = { let monitor = {
abilityName: "abilityname", abilityName: "abilityname",
onAbilityCreate: onAbilityCreateCallback onAbilityCreate: onAbilityCreateCallback
} }
...@@ -288,8 +282,6 @@ abilityDelegator.waitAbilityMonitor(monitor).then((data : any) => { ...@@ -288,8 +282,6 @@ abilityDelegator.waitAbilityMonitor(monitor).then((data : any) => {
}); });
``` ```
### getAppContext<sup>9+</sup> ### getAppContext<sup>9+</sup>
getAppContext(): Context; getAppContext(): Context;
...@@ -307,14 +299,12 @@ Obtains the application context. ...@@ -307,14 +299,12 @@ Obtains the application context.
**Example** **Example**
```ts ```ts
var abilityDelegator; let abilityDelegator;
abilityDelegator = AbilityDelegatorRegistry.getAbilityDelegator(); abilityDelegator = AbilityDelegatorRegistry.getAbilityDelegator();
var context = abilityDelegator.getAppContext(); let context = abilityDelegator.getAppContext();
``` ```
### getAbilityState<sup>9+</sup> ### getAbilityState<sup>9+</sup>
getAbilityState(ability: UIAbility): number; getAbilityState(ability: UIAbility): number;
...@@ -338,20 +328,18 @@ Obtains the lifecycle state of an ability. ...@@ -338,20 +328,18 @@ Obtains the lifecycle state of an ability.
**Example** **Example**
```ts ```ts
var abilityDelegator; let abilityDelegator;
var ability; let ability;
abilityDelegator = AbilityDelegatorRegistry.getAbilityDelegator(); abilityDelegator = AbilityDelegatorRegistry.getAbilityDelegator();
abilityDelegator.getCurrentTopAbility((err : any, data : any) => { abilityDelegator.getCurrentTopAbility((err : any, data : any) => {
console.info("getCurrentTopAbility callback"); console.info("getCurrentTopAbility callback");
ability = data; ability = data;
var state = abilityDelegator.getAbilityState(ability); let state = abilityDelegator.getAbilityState(ability);
console.info("getAbilityState" + state); console.info("getAbilityState" + state);
}); });
``` ```
### getCurrentTopAbility<sup>9+</sup> ### getCurrentTopAbility<sup>9+</sup>
getCurrentTopAbility(callback: AsyncCallback\<UIAbility>): void; getCurrentTopAbility(callback: AsyncCallback\<UIAbility>): void;
...@@ -369,8 +357,8 @@ Obtains the top ability of this application. This API uses an asynchronous callb ...@@ -369,8 +357,8 @@ Obtains the top ability of this application. This API uses an asynchronous callb
**Example** **Example**
```ts ```ts
var abilityDelegator; let abilityDelegator;
var ability; let ability;
abilityDelegator = AbilityDelegatorRegistry.getAbilityDelegator(); abilityDelegator = AbilityDelegatorRegistry.getAbilityDelegator();
abilityDelegator.getCurrentTopAbility((err : any, data : any) => { abilityDelegator.getCurrentTopAbility((err : any, data : any) => {
...@@ -379,8 +367,6 @@ abilityDelegator.getCurrentTopAbility((err : any, data : any) => { ...@@ -379,8 +367,6 @@ abilityDelegator.getCurrentTopAbility((err : any, data : any) => {
}); });
``` ```
### getCurrentTopAbility<sup>9+</sup> ### getCurrentTopAbility<sup>9+</sup>
getCurrentTopAbility(): Promise\<UIAbility>; getCurrentTopAbility(): Promise\<UIAbility>;
...@@ -398,8 +384,8 @@ Obtains the top ability of this application. This API uses a promise to return t ...@@ -398,8 +384,8 @@ Obtains the top ability of this application. This API uses a promise to return t
**Example** **Example**
```ts ```ts
var abilityDelegator; let abilityDelegator;
var ability; let ability;
abilityDelegator = AbilityDelegatorRegistry.getAbilityDelegator(); abilityDelegator = AbilityDelegatorRegistry.getAbilityDelegator();
abilityDelegator.getCurrentTopAbility().then((data : any) => { abilityDelegator.getCurrentTopAbility().then((data : any) => {
...@@ -408,8 +394,6 @@ abilityDelegator.getCurrentTopAbility().then((data : any) => { ...@@ -408,8 +394,6 @@ abilityDelegator.getCurrentTopAbility().then((data : any) => {
}); });
``` ```
### startAbility<sup>9+</sup> ### startAbility<sup>9+</sup>
startAbility(want: Want, callback: AsyncCallback\<void>): void; startAbility(want: Want, callback: AsyncCallback\<void>): void;
...@@ -428,8 +412,8 @@ Starts an ability. This API uses an asynchronous callback to return the result. ...@@ -428,8 +412,8 @@ Starts an ability. This API uses an asynchronous callback to return the result.
**Example** **Example**
```ts ```ts
var abilityDelegator; let abilityDelegator;
var want = { let want = {
bundleName: "bundleName", bundleName: "bundleName",
abilityName: "abilityName" abilityName: "abilityName"
}; };
...@@ -440,8 +424,6 @@ abilityDelegator.startAbility(want, (err : any, data : any) => { ...@@ -440,8 +424,6 @@ abilityDelegator.startAbility(want, (err : any, data : any) => {
}); });
``` ```
### startAbility<sup>9+</sup> ### startAbility<sup>9+</sup>
startAbility(want: Want): Promise\<void>; startAbility(want: Want): Promise\<void>;
...@@ -465,8 +447,8 @@ Starts an ability. This API uses a promise to return the result. ...@@ -465,8 +447,8 @@ Starts an ability. This API uses a promise to return the result.
**Example** **Example**
```ts ```ts
var abilityDelegator; let abilityDelegator;
var want = { let want = {
bundleName: "bundleName", bundleName: "bundleName",
abilityName: "abilityName" abilityName: "abilityName"
}; };
...@@ -477,8 +459,6 @@ abilityDelegator.startAbility(want).then((data: any) => { ...@@ -477,8 +459,6 @@ abilityDelegator.startAbility(want).then((data: any) => {
}); });
``` ```
### doAbilityForeground<sup>9+</sup> ### doAbilityForeground<sup>9+</sup>
doAbilityForeground(ability: UIAbility, callback: AsyncCallback\<void>): void; doAbilityForeground(ability: UIAbility, callback: AsyncCallback\<void>): void;
...@@ -497,8 +477,8 @@ Schedules the lifecycle state of an ability to **Foreground**. This API uses an ...@@ -497,8 +477,8 @@ Schedules the lifecycle state of an ability to **Foreground**. This API uses an
**Example** **Example**
```ts ```ts
var abilityDelegator; let abilityDelegator;
var ability; let ability;
abilityDelegator = AbilityDelegatorRegistry.getAbilityDelegator(); abilityDelegator = AbilityDelegatorRegistry.getAbilityDelegator();
abilityDelegator.getCurrentTopAbility((err : any, data : any) => { abilityDelegator.getCurrentTopAbility((err : any, data : any) => {
...@@ -510,8 +490,6 @@ abilityDelegator.getCurrentTopAbility((err : any, data : any) => { ...@@ -510,8 +490,6 @@ abilityDelegator.getCurrentTopAbility((err : any, data : any) => {
}); });
``` ```
### doAbilityForeground<sup>9+</sup> ### doAbilityForeground<sup>9+</sup>
doAbilityForeground(ability: UIAbility): Promise\<void>; doAbilityForeground(ability: UIAbility): Promise\<void>;
...@@ -535,8 +513,8 @@ Schedules the lifecycle state of an ability to **Foreground**. This API uses a p ...@@ -535,8 +513,8 @@ Schedules the lifecycle state of an ability to **Foreground**. This API uses a p
**Example** **Example**
```ts ```ts
var abilityDelegator; let abilityDelegator;
var ability; let ability;
abilityDelegator = AbilityDelegatorRegistry.getAbilityDelegator(); abilityDelegator = AbilityDelegatorRegistry.getAbilityDelegator();
abilityDelegator.getCurrentTopAbility((err : any, data : any) => { abilityDelegator.getCurrentTopAbility((err : any, data : any) => {
...@@ -548,8 +526,6 @@ abilityDelegator.getCurrentTopAbility((err : any, data : any) => { ...@@ -548,8 +526,6 @@ abilityDelegator.getCurrentTopAbility((err : any, data : any) => {
}); });
``` ```
### doAbilityBackground<sup>9+</sup> ### doAbilityBackground<sup>9+</sup>
doAbilityBackground(ability: UIAbility, callback: AsyncCallback\<void>): void; doAbilityBackground(ability: UIAbility, callback: AsyncCallback\<void>): void;
...@@ -568,8 +544,8 @@ Schedules the lifecycle state of an ability to **Background**. This API uses an ...@@ -568,8 +544,8 @@ Schedules the lifecycle state of an ability to **Background**. This API uses an
**Example** **Example**
```ts ```ts
var abilityDelegator; let abilityDelegator;
var ability; let ability;
abilityDelegator = AbilityDelegatorRegistry.getAbilityDelegator(); abilityDelegator = AbilityDelegatorRegistry.getAbilityDelegator();
abilityDelegator.getCurrentTopAbility((err : any, data : any) => { abilityDelegator.getCurrentTopAbility((err : any, data : any) => {
...@@ -581,8 +557,6 @@ abilityDelegator.getCurrentTopAbility((err : any, data : any) => { ...@@ -581,8 +557,6 @@ abilityDelegator.getCurrentTopAbility((err : any, data : any) => {
}); });
``` ```
### doAbilityBackground<sup>9+</sup> ### doAbilityBackground<sup>9+</sup>
doAbilityBackground(ability: UIAbility): Promise\<void>; doAbilityBackground(ability: UIAbility): Promise\<void>;
...@@ -606,8 +580,8 @@ Schedules the lifecycle state of an ability to **Background**. This API uses a p ...@@ -606,8 +580,8 @@ Schedules the lifecycle state of an ability to **Background**. This API uses a p
**Example** **Example**
```ts ```ts
var abilityDelegator; let abilityDelegator;
var ability; let ability;
abilityDelegator = AbilityDelegatorRegistry.getAbilityDelegator(); abilityDelegator = AbilityDelegatorRegistry.getAbilityDelegator();
abilityDelegator.getCurrentTopAbility((err : any, data : any) => { abilityDelegator.getCurrentTopAbility((err : any, data : any) => {
...@@ -619,8 +593,6 @@ abilityDelegator.getCurrentTopAbility((err : any, data : any) => { ...@@ -619,8 +593,6 @@ abilityDelegator.getCurrentTopAbility((err : any, data : any) => {
}); });
``` ```
### printSync<sup>9+</sup> ### printSync<sup>9+</sup>
printSync(msg: string): void; printSync(msg: string): void;
...@@ -638,15 +610,13 @@ Prints log information to the unit test console. ...@@ -638,15 +610,13 @@ Prints log information to the unit test console.
**Example** **Example**
```ts ```ts
var abilityDelegator; let abilityDelegator;
var msg = "msg"; let msg = "msg";
abilityDelegator = AbilityDelegatorRegistry.getAbilityDelegator(); abilityDelegator = AbilityDelegatorRegistry.getAbilityDelegator();
abilityDelegator.printSync(msg); abilityDelegator.printSync(msg);
``` ```
### print ### print
print(msg: string, callback: AsyncCallback\<void>): void; print(msg: string, callback: AsyncCallback\<void>): void;
...@@ -665,8 +635,8 @@ Prints log information to the unit test console. This API uses an asynchronous c ...@@ -665,8 +635,8 @@ Prints log information to the unit test console. This API uses an asynchronous c
**Example** **Example**
```ts ```ts
var abilityDelegator; let abilityDelegator;
var msg = "msg"; let msg = "msg";
abilityDelegator = AbilityDelegatorRegistry.getAbilityDelegator(); abilityDelegator = AbilityDelegatorRegistry.getAbilityDelegator();
abilityDelegator.print(msg, (err : any) => { abilityDelegator.print(msg, (err : any) => {
...@@ -674,8 +644,6 @@ abilityDelegator.print(msg, (err : any) => { ...@@ -674,8 +644,6 @@ abilityDelegator.print(msg, (err : any) => {
}); });
``` ```
### print ### print
print(msg: string): Promise\<void>; print(msg: string): Promise\<void>;
...@@ -699,8 +667,8 @@ Prints log information to the unit test console. This API uses a promise to retu ...@@ -699,8 +667,8 @@ Prints log information to the unit test console. This API uses a promise to retu
**Example** **Example**
```ts ```ts
var abilityDelegator; let abilityDelegator;
var msg = "msg"; let msg = "msg";
abilityDelegator = AbilityDelegatorRegistry.getAbilityDelegator(); abilityDelegator = AbilityDelegatorRegistry.getAbilityDelegator();
abilityDelegator.print(msg).then(() => { abilityDelegator.print(msg).then(() => {
...@@ -708,8 +676,6 @@ abilityDelegator.print(msg).then(() => { ...@@ -708,8 +676,6 @@ abilityDelegator.print(msg).then(() => {
}); });
``` ```
### executeShellCommand ### executeShellCommand
executeShellCommand(cmd: string, callback: AsyncCallback\<ShellCmdResult>): void; executeShellCommand(cmd: string, callback: AsyncCallback\<ShellCmdResult>): void;
...@@ -728,8 +694,8 @@ Executes a shell command. This API uses an asynchronous callback to return the r ...@@ -728,8 +694,8 @@ Executes a shell command. This API uses an asynchronous callback to return the r
**Example** **Example**
```ts ```ts
var abilityDelegator; let abilityDelegator;
var cmd = "cmd"; let cmd = "cmd";
abilityDelegator = AbilityDelegatorRegistry.getAbilityDelegator(); abilityDelegator = AbilityDelegatorRegistry.getAbilityDelegator();
abilityDelegator.executeShellCommand(cmd, (err : any, data : any) => { abilityDelegator.executeShellCommand(cmd, (err : any, data : any) => {
...@@ -737,8 +703,6 @@ abilityDelegator.executeShellCommand(cmd, (err : any, data : any) => { ...@@ -737,8 +703,6 @@ abilityDelegator.executeShellCommand(cmd, (err : any, data : any) => {
}); });
``` ```
### executeShellCommand ### executeShellCommand
executeShellCommand(cmd: string, timeoutSecs: number, callback: AsyncCallback\<ShellCmdResult>): void; executeShellCommand(cmd: string, timeoutSecs: number, callback: AsyncCallback\<ShellCmdResult>): void;
...@@ -758,9 +722,9 @@ Executes a shell command with the timeout period specified. This API uses an asy ...@@ -758,9 +722,9 @@ Executes a shell command with the timeout period specified. This API uses an asy
**Example** **Example**
```ts ```ts
var abilityDelegator; let abilityDelegator;
var cmd = "cmd"; let cmd = "cmd";
var timeout = 100; let timeout = 100;
abilityDelegator = AbilityDelegatorRegistry.getAbilityDelegator(); abilityDelegator = AbilityDelegatorRegistry.getAbilityDelegator();
abilityDelegator.executeShellCommand(cmd, timeout, (err : any, data : any) => { abilityDelegator.executeShellCommand(cmd, timeout, (err : any, data : any) => {
...@@ -768,8 +732,6 @@ abilityDelegator.executeShellCommand(cmd, timeout, (err : any, data : any) => { ...@@ -768,8 +732,6 @@ abilityDelegator.executeShellCommand(cmd, timeout, (err : any, data : any) => {
}); });
``` ```
### executeShellCommand ### executeShellCommand
executeShellCommand(cmd: string, timeoutSecs?: number): Promise\<ShellCmdResult>; executeShellCommand(cmd: string, timeoutSecs?: number): Promise\<ShellCmdResult>;
...@@ -794,9 +756,9 @@ Executes a shell command with the timeout period specified. This API uses a prom ...@@ -794,9 +756,9 @@ Executes a shell command with the timeout period specified. This API uses a prom
**Example** **Example**
```ts ```ts
var abilityDelegator; let abilityDelegator;
var cmd = "cmd"; let cmd = "cmd";
var timeout = 100; let timeout = 100;
abilityDelegator = AbilityDelegatorRegistry.getAbilityDelegator(); abilityDelegator = AbilityDelegatorRegistry.getAbilityDelegator();
abilityDelegator.executeShellCommand(cmd, timeout).then((data : any) => { abilityDelegator.executeShellCommand(cmd, timeout).then((data : any) => {
...@@ -804,8 +766,6 @@ abilityDelegator.executeShellCommand(cmd, timeout).then((data : any) => { ...@@ -804,8 +766,6 @@ abilityDelegator.executeShellCommand(cmd, timeout).then((data : any) => {
}); });
``` ```
### finishTest<sup>9+</sup> ### finishTest<sup>9+</sup>
finishTest(msg: string, code: number, callback: AsyncCallback\<void>): void; finishTest(msg: string, code: number, callback: AsyncCallback\<void>): void;
...@@ -825,8 +785,8 @@ Finishes the test and prints log information to the unit test console. This API ...@@ -825,8 +785,8 @@ Finishes the test and prints log information to the unit test console. This API
**Example** **Example**
```ts ```ts
var abilityDelegator; let abilityDelegator;
var msg = "msg"; let msg = "msg";
abilityDelegator = AbilityDelegatorRegistry.getAbilityDelegator(); abilityDelegator = AbilityDelegatorRegistry.getAbilityDelegator();
abilityDelegator.finishTest(msg, 0, (err : any) => { abilityDelegator.finishTest(msg, 0, (err : any) => {
...@@ -834,8 +794,6 @@ abilityDelegator.finishTest(msg, 0, (err : any) => { ...@@ -834,8 +794,6 @@ abilityDelegator.finishTest(msg, 0, (err : any) => {
}); });
``` ```
### finishTest<sup>9+</sup> ### finishTest<sup>9+</sup>
finishTest(msg: string, code: number): Promise\<void>; finishTest(msg: string, code: number): Promise\<void>;
...@@ -860,8 +818,8 @@ Finishes the test and prints log information to the unit test console. This API ...@@ -860,8 +818,8 @@ Finishes the test and prints log information to the unit test console. This API
**Example** **Example**
```ts ```ts
var abilityDelegator; let abilityDelegator;
var msg = "msg"; let msg = "msg";
abilityDelegator = AbilityDelegatorRegistry.getAbilityDelegator(); abilityDelegator = AbilityDelegatorRegistry.getAbilityDelegator();
abilityDelegator.finishTest(msg, 0).then(() => { abilityDelegator.finishTest(msg, 0).then(() => {
...@@ -887,9 +845,9 @@ Adds an **AbilityStageMonitor** instance to monitor the lifecycle state changes ...@@ -887,9 +845,9 @@ Adds an **AbilityStageMonitor** instance to monitor the lifecycle state changes
**Example** **Example**
```ts ```ts
var abilityDelegator; let abilityDelegator;
var monitor = { let monitor = {
moduleName: "moduleName", moduleName: "moduleName",
srcEntrance: "srcEntrance", srcEntrance: "srcEntrance",
} }
...@@ -900,8 +858,6 @@ abilityDelegator.addAbilityStageMonitor(monitor, (err : any) => { ...@@ -900,8 +858,6 @@ abilityDelegator.addAbilityStageMonitor(monitor, (err : any) => {
}); });
``` ```
### addAbilityStageMonitor<sup>9+</sup> ### addAbilityStageMonitor<sup>9+</sup>
addAbilityStageMonitor(monitor: AbilityStageMonitor): Promise\<void>; addAbilityStageMonitor(monitor: AbilityStageMonitor): Promise\<void>;
...@@ -925,9 +881,9 @@ Adds an **AbilityStageMonitor** instance to monitor the lifecycle state changes ...@@ -925,9 +881,9 @@ Adds an **AbilityStageMonitor** instance to monitor the lifecycle state changes
**Example** **Example**
```ts ```ts
var abilityDelegator; let abilityDelegator;
var monitor = { let monitor = {
moduleName: "moduleName", moduleName: "moduleName",
srcEntrance: "srcEntrance", srcEntrance: "srcEntrance",
} }
...@@ -956,9 +912,9 @@ Removes an **AbilityStageMonitor** instance from the application memory. This AP ...@@ -956,9 +912,9 @@ Removes an **AbilityStageMonitor** instance from the application memory. This AP
**Example** **Example**
```ts ```ts
var abilityDelegator; let abilityDelegator;
var monitor = { let monitor = {
moduleName: "moduleName", moduleName: "moduleName",
srcEntrance: "srcEntrance", srcEntrance: "srcEntrance",
} }
...@@ -969,8 +925,6 @@ abilityDelegator.removeAbilityStageMonitor(monitor, (err : any) => { ...@@ -969,8 +925,6 @@ abilityDelegator.removeAbilityStageMonitor(monitor, (err : any) => {
}); });
``` ```
### removeAbilityStageMonitor<sup>9+</sup> ### removeAbilityStageMonitor<sup>9+</sup>
removeAbilityStageMonitor(monitor: AbilityStageMonitor): Promise\<void>; removeAbilityStageMonitor(monitor: AbilityStageMonitor): Promise\<void>;
...@@ -994,9 +948,9 @@ Removes an **AbilityStageMonitor** object from the application memory. This API ...@@ -994,9 +948,9 @@ Removes an **AbilityStageMonitor** object from the application memory. This API
**Example** **Example**
```ts ```ts
var abilityDelegator; let abilityDelegator;
var monitor = { let monitor = {
moduleName: "moduleName", moduleName: "moduleName",
srcEntrance: "srcEntrance", srcEntrance: "srcEntrance",
} }
...@@ -1025,13 +979,13 @@ Waits for an **AbilityStage** instance that matches the conditions set in an **A ...@@ -1025,13 +979,13 @@ Waits for an **AbilityStage** instance that matches the conditions set in an **A
**Example** **Example**
```ts ```ts
var abilityDelegator; let abilityDelegator;
function onAbilityCreateCallback(data) { function onAbilityCreateCallback(data) {
console.info("onAbilityCreateCallback"); console.info("onAbilityCreateCallback");
} }
var monitor = { let monitor = {
moduleName: "moduleName", moduleName: "moduleName",
srcEntrance: "srcEntrance", srcEntrance: "srcEntrance",
} }
...@@ -1066,13 +1020,13 @@ Waits for an **AbilityStage** instance that matches the conditions set in an **A ...@@ -1066,13 +1020,13 @@ Waits for an **AbilityStage** instance that matches the conditions set in an **A
**Example** **Example**
```ts ```ts
var abilityDelegator; let abilityDelegator;
function onAbilityCreateCallback(data) { function onAbilityCreateCallback(data) {
console.info("onAbilityCreateCallback"); console.info("onAbilityCreateCallback");
} }
var monitor = { let monitor = {
moduleName: "moduleName", moduleName: "moduleName",
srcEntrance: "srcEntrance", srcEntrance: "srcEntrance",
} }
...@@ -1102,14 +1056,14 @@ Waits a period of time for an **AbilityStage** instance that matches the conditi ...@@ -1102,14 +1056,14 @@ Waits a period of time for an **AbilityStage** instance that matches the conditi
**Example** **Example**
```ts ```ts
var abilityDelegator; let abilityDelegator;
var timeout = 100; let timeout = 100;
function onAbilityCreateCallback(data) { function onAbilityCreateCallback(data) {
console.info("onAbilityCreateCallback"); console.info("onAbilityCreateCallback");
} }
var monitor = { let monitor = {
moduleName: "moduleName", moduleName: "moduleName",
srcEntrance: "srcEntrance", srcEntrance: "srcEntrance",
} }
......
...@@ -26,7 +26,7 @@ Describes the ability delegator arguments. ...@@ -26,7 +26,7 @@ Describes the ability delegator arguments.
**Example** **Example**
```ts ```ts
import AbilityDelegatorRegistry from '@ohos.application.abilityDelegatorRegistry'; import AbilityDelegatorRegistry from '@ohos.app.ability.abilityDelegatorRegistry';
var args = AbilityDelegatorRegistry.getArguments(); var args = AbilityDelegatorRegistry.getArguments();
``` ```
...@@ -30,7 +30,7 @@ Describes an ability monitor. ...@@ -30,7 +30,7 @@ Describes an ability monitor.
**Example** **Example**
```ts ```ts
import AbilityDelegatorRegistry from '@ohos.application.abilityDelegatorRegistry' import AbilityDelegatorRegistry from '@ohos.app.ability.abilityDelegatorRegistry';
function onAbilityCreateCallback(data) { function onAbilityCreateCallback(data) {
console.info("onAbilityCreateCallback"); console.info("onAbilityCreateCallback");
......
...@@ -28,7 +28,8 @@ The ability running information is obtained by calling [getAbilityRunningInfos]( ...@@ -28,7 +28,8 @@ The ability running information is obtained by calling [getAbilityRunningInfos](
**Example** **Example**
```ts ```ts
import abilitymanager from '@ohos.application.abilityManager'; import abilitymanager from '@ohos.app.ability.abilityManager';
abilitymanager.getAbilityRunningInfos((err,data) => { abilitymanager.getAbilityRunningInfos((err,data) => {
console.log("getAbilityRunningInfos err: " + err + " data: " + JSON.stringify(data)); console.log("getAbilityRunningInfos err: " + err + " data: " + JSON.stringify(data));
for (let i = 0; i < data.length; i++) { for (let i = 0; i < data.length; i++) {
......
...@@ -14,7 +14,8 @@ This module provides APIs for accessing a specific ability stage. You can use th ...@@ -14,7 +14,8 @@ This module provides APIs for accessing a specific ability stage. You can use th
The ability stage context is obtained through an **AbilityStage** instance. The ability stage context is obtained through an **AbilityStage** instance.
```ts ```ts
import AbilityStage from '@ohos.application.AbilityStage'; import AbilityStage from '@ohos.app.ability.AbilityStage';
class MyAbilityStage extends AbilityStage { class MyAbilityStage extends AbilityStage {
onCreate() { onCreate() {
let abilityStageContext = this.context; let abilityStageContext = this.context;
......
...@@ -11,7 +11,7 @@ The **AbilityStageMonitor** module provides conditions for matching **AbilitySta ...@@ -11,7 +11,7 @@ The **AbilityStageMonitor** module provides conditions for matching **AbilitySta
**Example** **Example**
```ts ```ts
import AbilityDelegatorRegistry from '@ohos.application.abilityDelegatorRegistry' import AbilityDelegatorRegistry from '@ohos.app.ability.abilityDelegatorRegistry';
let monitor = { let monitor = {
moduleName: "feature_as1", moduleName: "feature_as1",
......
...@@ -16,7 +16,7 @@ The **ApplicationStateObserver** module defines an observer to listen for applic ...@@ -16,7 +16,7 @@ The **ApplicationStateObserver** module defines an observer to listen for applic
**Example** **Example**
```ts ```ts
import appManager from "@ohos.application.appManager" import appManager from "@ohos.app.ability.appManager";
let applicationStateObserver = { let applicationStateObserver = {
onForegroundApplicationChanged(appStateData) { onForegroundApplicationChanged(appStateData) {
......
...@@ -31,8 +31,9 @@ To adapt to devices with different performance, an application provides three mo ...@@ -31,8 +31,9 @@ To adapt to devices with different performance, an application provides three mo
Define a **ServiceExtension** with the same name for the three modules. Define a **ServiceExtension** with the same name for the three modules.
```ts ```ts
import ServiceExtension from '@ohos.app.ability.ServiceExtensionAbility' import ServiceExtension from '@ohos.app.ability.ServiceExtensionAbility';
import Want from '@ohos.application.Want' import Want from '@ohos.app.ability.Want';
export default class TheServiceExtension extends ServiceExtension { export default class TheServiceExtension extends ServiceExtension {
onCreate(want:Want) { onCreate(want:Want) {
console.log('ServiceAbility onCreate, want: ' + want.abilityName); console.log('ServiceAbility onCreate, want: ' + want.abilityName);
......
...@@ -17,7 +17,7 @@ The **ProcessData** module defines process data. If a lifecycle change listener ...@@ -17,7 +17,7 @@ The **ProcessData** module defines process data. If a lifecycle change listener
**Example** **Example**
```ts ```ts
import appManager from '@ohos.application.appManager' import appManager from '@ohos.app.ability.appManager';
let applicationStateObserver = { let applicationStateObserver = {
onForegroundApplicationChanged(appStateData) { onForegroundApplicationChanged(appStateData) {
......
...@@ -23,7 +23,7 @@ The process running information is obtained by using [getProcessRunningInfos](js ...@@ -23,7 +23,7 @@ The process running information is obtained by using [getProcessRunningInfos](js
**Example** **Example**
```ts ```ts
import appManager from '@ohos.application.appManager'; import appManager from '@ohos.app.ability.appManager';
appManager.getProcessRunningInfos().then((data) => { appManager.getProcessRunningInfos().then((data) => {
console.log('success:' + JSON.stringify(data)); console.log('success:' + JSON.stringify(data));
......
...@@ -19,7 +19,7 @@ The result is obtained by calling [executeShellCommand](js-apis-inner-applicatio ...@@ -19,7 +19,7 @@ The result is obtained by calling [executeShellCommand](js-apis-inner-applicatio
**Example** **Example**
```ts ```ts
import AbilityDelegatorRegistry from "@ohos.application.abilityDelegatorRegistry"; import AbilityDelegatorRegistry from "@ohos.app.ability.abilityDelegatorRegistry";
let abilityDelegator; let abilityDelegator;
let cmd = "cmd"; let cmd = "cmd";
......
...@@ -67,8 +67,8 @@ For details about the error codes, see [backgroundTaskManager Error Codes](../er ...@@ -67,8 +67,8 @@ For details about the error codes, see [backgroundTaskManager Error Codes](../er
let delayInfo = backgroundTaskManager.requestSuspendDelay(myReason, () => { let delayInfo = backgroundTaskManager.requestSuspendDelay(myReason, () => {
console.info("Request suspension delay will time out."); console.info("Request suspension delay will time out.");
}) })
var id = delayInfo.requestId; let id = delayInfo.requestId;
var time = delayInfo.actualDelayTime; let time = delayInfo.actualDelayTime;
console.info("The requestId is: " + id); console.info("The requestId is: " + id);
console.info("The actualDelayTime is: " + time); console.info("The actualDelayTime is: " + time);
} catch (error) { } catch (error) {
...@@ -258,7 +258,7 @@ For details about the error codes, see [backgroundTaskManager Error Codes](../er ...@@ -258,7 +258,7 @@ For details about the error codes, see [backgroundTaskManager Error Codes](../er
```js ```js
import UIAbility from '@ohos.app.ability.UIAbility'; import UIAbility from '@ohos.app.ability.UIAbility';
import backgroundTaskManager from '@ohos.resourceschedule.backgroundTaskManager'; import backgroundTaskManager from '@ohos.resourceschedule.backgroundTaskManager';
import wantAgent from '@ohos.wantAgent'; import wantAgent from '@ohos.app.ability.wantAgent';
function callback(error, data) { function callback(error, data) {
if (error) { if (error) {
...@@ -282,14 +282,18 @@ export default class EntryAbility extends UIAbility { ...@@ -282,14 +282,18 @@ export default class EntryAbility extends UIAbility {
wantAgentFlags: [wantAgent.WantAgentFlags.UPDATE_PRESENT_FLAG] wantAgentFlags: [wantAgent.WantAgentFlags.UPDATE_PRESENT_FLAG]
}; };
wantAgent.getWantAgent(wantAgentInfo).then((wantAgentObj) => { try {
try { wantAgent.getWantAgent(wantAgentInfo).then((wantAgentObj) => {
backgroundTaskManager.startBackgroundRunning(this.context, try {
backgroundTaskManager.BackgroundMode.LOCATION, wantAgentObj, callback) backgroundTaskManager.startBackgroundRunning(this.context,
} catch (error) { backgroundTaskManager.BackgroundMode.LOCATION, wantAgentObj, callback)
console.error(`Operation startBackgroundRunning failed. code is ${error.code} message is ${error.message}`); } catch (error) {
} console.error(`Operation startBackgroundRunning failed. code is ${error.code} message is ${error.message}`);
}); }
});
} catch (error) {
console.error(`Operation getWantAgent failed. code is ${error.code} message is ${error.message}`);
}
} }
}; };
``` ```
...@@ -337,7 +341,7 @@ For details about the error codes, see [backgroundTaskManager Error Codes](../er ...@@ -337,7 +341,7 @@ For details about the error codes, see [backgroundTaskManager Error Codes](../er
```js ```js
import UIAbility from '@ohos.app.ability.UIAbility'; import UIAbility from '@ohos.app.ability.UIAbility';
import backgroundTaskManager from '@ohos.resourceschedule.backgroundTaskManager'; import backgroundTaskManager from '@ohos.resourceschedule.backgroundTaskManager';
import wantAgent from '@ohos.wantAgent'; import wantAgent from '@ohos.app.ability.wantAgent';
export default class EntryAbility extends UIAbility { export default class EntryAbility extends UIAbility {
onCreate(want, launchParam) { onCreate(want, launchParam) {
...@@ -353,18 +357,22 @@ export default class EntryAbility extends UIAbility { ...@@ -353,18 +357,22 @@ export default class EntryAbility extends UIAbility {
wantAgentFlags: [wantAgent.WantAgentFlags.UPDATE_PRESENT_FLAG] wantAgentFlags: [wantAgent.WantAgentFlags.UPDATE_PRESENT_FLAG]
}; };
wantAgent.getWantAgent(wantAgentInfo).then((wantAgentObj) => { try {
try { wantAgent.getWantAgent(wantAgentInfo).then((wantAgentObj) => {
backgroundTaskManager.startBackgroundRunning(this.context, try {
backgroundTaskManager.BackgroundMode.LOCATION, wantAgentObj).then(() => { backgroundTaskManager.startBackgroundRunning(this.context,
console.info("Operation startBackgroundRunning succeeded"); backgroundTaskManager.BackgroundMode.LOCATION, wantAgentObj).then(() => {
}).catch((error) => { console.info("Operation startBackgroundRunning succeeded");
}).catch((error) => {
console.error(`Operation startBackgroundRunning failed. code is ${error.code} message is ${error.message}`);
});
} catch (error) {
console.error(`Operation startBackgroundRunning failed. code is ${error.code} message is ${error.message}`); console.error(`Operation startBackgroundRunning failed. code is ${error.code} message is ${error.message}`);
}); }
} catch (error) { });
console.error(`Operation startBackgroundRunning failed. code is ${error.code} message is ${error.message}`); } catch (error) {
} console.error(`Operation getWantAgent failed. code is ${error.code} message is ${error.message}`);
}); }
} }
}; };
``` ```
......
Markdown is supported
0% .
You are about to add 0 people to the discussion. Proceed with caution.
先完成此消息的编辑!
想要评论请 注册