From 208a24523068566fdd8de4dab40a217a60f1c50a Mon Sep 17 00:00:00 2001 From: wusongqing Date: Sun, 24 Apr 2022 16:47:26 +0800 Subject: [PATCH] updated docs Signed-off-by: wusongqing --- .../js-apis-application-abilityDelegator.md | 121 ++++++++++++++---- .../js-apis-application-abilityMonitor.md | 22 ++-- 2 files changed, 103 insertions(+), 40 deletions(-) diff --git a/en/application-dev/reference/apis/js-apis-application-abilityDelegator.md b/en/application-dev/reference/apis/js-apis-application-abilityDelegator.md index d0e2bddc5d..13cfb0005a 100644 --- a/en/application-dev/reference/apis/js-apis-application-abilityDelegator.md +++ b/en/application-dev/reference/apis/js-apis-application-abilityDelegator.md @@ -34,7 +34,7 @@ Adds an **AbilityMonitor** instance. This API uses an asynchronous callback to r ```js var abilityDelegator; -function onAbilityCreateCallback() { +function onAbilityCreateCallback(data) { console.info("onAbilityCreateCallback"); } @@ -44,7 +44,7 @@ var monitor = { } abilityDelegator = AbilityDelegatorRegistry.getAbilityDelegator(); -abilityDelegator.addAbilityMonitor(monitor, (err) => { +abilityDelegator.addAbilityMonitor(monitor, (err : any) => { console.info("addAbilityMonitor callback"); }); ``` @@ -76,7 +76,7 @@ Adds an **AbilityMonitor** instance. This API uses a promise to return the resul ```js var abilityDelegator; -function onAbilityCreateCallback() { +function onAbilityCreateCallback(data) { console.info("onAbilityCreateCallback"); } @@ -113,7 +113,7 @@ Removes an **AbilityMonitor** instance. This API uses an asynchronous callback t ```js var abilityDelegator; -function onAbilityCreateCallback() { +function onAbilityCreateCallback(data) { console.info("onAbilityCreateCallback"); } @@ -123,7 +123,7 @@ var monitor = { } abilityDelegator = AbilityDelegatorRegistry.getAbilityDelegator(); -abilityDelegator.removeAbilityMonitor(monitor, (err) => { +abilityDelegator.removeAbilityMonitor(monitor, (err : any) => { console.info("removeAbilityMonitor callback"); }); ``` @@ -155,7 +155,7 @@ Removes an **AbilityMonitor** instance. This API uses a promise to return the re ```js var abilityDelegator; -function onAbilityCreateCallback() { +function onAbilityCreateCallback(data) { console.info("onAbilityCreateCallback"); } @@ -192,7 +192,7 @@ Waits for the ability that matches the **AbilityMonitor** instance to reach the ```js var abilityDelegator; -function onAbilityCreateCallback() { +function onAbilityCreateCallback(data) { console.info("onAbilityCreateCallback"); } @@ -202,7 +202,7 @@ var monitor = { } abilityDelegator = AbilityDelegatorRegistry.getAbilityDelegator(); -abilityDelegator.waitAbilityMonitor(monitor, (err, data) => { +abilityDelegator.waitAbilityMonitor(monitor, (err : any, data : any) => { console.info("waitAbilityMonitor callback"); }); ``` @@ -231,7 +231,7 @@ Waits a period of time for the ability that matches the **AbilityMonitor** insta var abilityDelegator; var timeout = 100; -function onAbilityCreateCallback() { +function onAbilityCreateCallback(data) { console.info("onAbilityCreateCallback"); } @@ -241,7 +241,7 @@ var monitor = { } abilityDelegator = AbilityDelegatorRegistry.getAbilityDelegator(); -abilityDelegator.waitAbilityMonitor(monitor, timeout, (err, data) => { +abilityDelegator.waitAbilityMonitor(monitor, timeout, (err : any, data : any) => { console.info("waitAbilityMonitor callback"); }); ``` @@ -274,7 +274,7 @@ Waits a period of time for the ability that matches the **AbilityMonitor** insta ```js var abilityDelegator; -function onAbilityCreateCallback() { +function onAbilityCreateCallback(data) { console.info("onAbilityCreateCallback"); } @@ -343,7 +343,7 @@ var abilityDelegator; var ability; abilityDelegator = AbilityDelegatorRegistry.getAbilityDelegator(); -abilityDelegator.getCurrentTopAbility((err, data) => { +abilityDelegator.getCurrentTopAbility((err : any, data : any) => { console.info("getCurrentTopAbility callback"); ability = data; var state = abilityDelegator.getAbilityState(ability); @@ -374,7 +374,7 @@ var abilityDelegator; var ability; abilityDelegator = AbilityDelegatorRegistry.getAbilityDelegator(); -abilityDelegator.getCurrentTopAbility((err, data) => { +abilityDelegator.getCurrentTopAbility((err : any, data : any) => { console.info("getCurrentTopAbility callback"); ability = data; }); @@ -411,7 +411,7 @@ abilityDelegator.getCurrentTopAbility().then((data : any) => { -### startAbility +### startAbility9+ startAbility(want: Want, callback: AsyncCallback\): void @@ -436,14 +436,14 @@ var want = { }; abilityDelegator = AbilityDelegatorRegistry.getAbilityDelegator(); -abilityDelegator.startAbility(want, (err, data) => { +abilityDelegator.startAbility(want, (err : any, data : any) => { console.info("startAbility callback"); }); ``` -### startAbility +### startAbility9+ startAbility(want: Want): Promise\ @@ -502,10 +502,10 @@ var abilityDelegator; var ability; abilityDelegator = AbilityDelegatorRegistry.getAbilityDelegator(); -abilityDelegator.getCurrentTopAbility((err, data) => { +abilityDelegator.getCurrentTopAbility((err : any, data : any) => { console.info("getCurrentTopAbility callback"); ability = data; - abilityDelegator.doAbilityForeground(ability, (err, data) => { + abilityDelegator.doAbilityForeground(ability, (err : any, data : any) => { console.info("doAbilityForeground callback"); }); }); @@ -540,7 +540,7 @@ var abilityDelegator; var ability; abilityDelegator = AbilityDelegatorRegistry.getAbilityDelegator(); -abilityDelegator.getCurrentTopAbility((err, data) => { +abilityDelegator.getCurrentTopAbility((err : any, data : any) => { console.info("getCurrentTopAbility callback"); ability = data; abilityDelegator.doAbilityForeground(ability).then((data : any) => { @@ -573,10 +573,10 @@ var abilityDelegator; var ability; abilityDelegator = AbilityDelegatorRegistry.getAbilityDelegator(); -abilityDelegator.getCurrentTopAbility((err, data) => { +abilityDelegator.getCurrentTopAbility((err : any, data : any) => { console.info("getCurrentTopAbility callback"); ability = data; - abilityDelegator.doAbilityBackground(ability, (err, data) => { + abilityDelegator.doAbilityBackground(ability, (err : any, data : any) => { console.info("doAbilityBackground callback"); }); }); @@ -611,10 +611,10 @@ var abilityDelegator; var ability; abilityDelegator = AbilityDelegatorRegistry.getAbilityDelegator(); -abilityDelegator.getCurrentTopAbility((err, data) => { +abilityDelegator.getCurrentTopAbility((err : any, data : any) => { console.info("getCurrentTopAbility callback"); ability = data; - abilityDelegator.doAbilityBackground(ability).then((data) => { + abilityDelegator.doAbilityBackground(ability).then((data : any) => { console.info("doAbilityBackground promise"); }); }); @@ -644,7 +644,7 @@ var abilityDelegator; var msg = "msg"; abilityDelegator = AbilityDelegatorRegistry.getAbilityDelegator(); -abilityDelegator.print(msg, (err) => { +abilityDelegator.print(msg, (err : any) => { console.info("print callback"); }); ``` @@ -698,7 +698,7 @@ Executes a shell command. This API uses an asynchronous callback to return the r | Name | Type | Mandatory| Description | | -------- | ------------------------------------------------------------ | ---- | ------------------ | | cmd | string | Yes | Shell command string. | -| callback | AsyncCallback\<[ShellCmdResult](js-apis-application-shellCmdResult.md#ShellCmdResult)> | Yes | Callback used to return a [ShellCmdResult](js-apis-application-shellCmdResult.md#ShellCmdResult) object.| +| callback | AsyncCallback\<[ShellCmdResult](js-apis-application-shellCmdResult.md#ShellCmdResult)> | Yes | Callback used to return the result.| **Example** @@ -707,7 +707,7 @@ var abilityDelegator; var cmd = "cmd"; abilityDelegator = AbilityDelegatorRegistry.getAbilityDelegator(); -abilityDelegator.executeShellCommand(cmd, (err, data) => { +abilityDelegator.executeShellCommand(cmd, (err : any, data : any) => { console.info("executeShellCommand callback"); }); ``` @@ -728,7 +728,7 @@ Executes a shell command with the timeout period specified. This API uses an asy | ----------- | ------------------------------------------------------------ | ---- | ----------------------------- | | cmd | string | Yes | Shell command string. | | timeoutSecs | number | Yes | Command timeout period, in seconds.| -| callback | AsyncCallback\<[ShellCmdResult](js-apis-application-shellCmdResult.md#ShellCmdResult)> | Yes | Callback used to return a [ShellCmdResult](js-apis-application-shellCmdResult.md#ShellCmdResult) object. | +| callback | AsyncCallback\<[ShellCmdResult](js-apis-application-shellCmdResult.md#ShellCmdResult)> | Yes | Callback used to return the result. | **Example** @@ -738,7 +738,7 @@ var cmd = "cmd"; var timeout = 100; abilityDelegator = AbilityDelegatorRegistry.getAbilityDelegator(); -abilityDelegator.executeShellCommand(cmd, timeout, (err, data) => { +abilityDelegator.executeShellCommand(cmd, timeout, (err : any, data : any) => { console.info("executeShellCommand callback"); }); ``` @@ -778,3 +778,68 @@ abilityDelegator.executeShellCommand(cmd, timeout).then((data : any) => { console.info("executeShellCommand promise"); }); ``` + + + +### finishTest9+ + +finishTest(msg: string, code: number, callback: AsyncCallback\): void + +Finishes the test and prints log information to the unit test console. This API uses an asynchronous callback to return the result. + +**System capability**: SystemCapability.Ability.AbilityRuntime.Core + +**Parameters** + +| Name | Type | Mandatory| Description | +| -------- | -------------------- | ---- | ------------------ | +| msg | string | Yes | Log string. | +| code | number | Yes | Log code. | +| callback | AsyncCallback\ | Yes | Callback used to return the result.| + +**Example** + +```js +var abilityDelegator; +var msg = "msg"; + +abilityDelegator = AbilityDelegatorRegistry.getAbilityDelegator(); +abilityDelegator.finishTest(msg, 0, (err : any) => { + console.info("finishTest callback"); +}); +``` + + + +### finishTest9+ + +finishTest(msg: string, code: number): Promise\ + +Finishes the test and prints log information to the unit test console. This API uses a promise to return the result. + +**System capability**: SystemCapability.Ability.AbilityRuntime.Core + +**Parameters** + +| Name| Type | Mandatory| Description | +| ------ | ------ | ---- | ---------- | +| msg | string | Yes | Log string.| +| code | number | Yes | Log code. | + +**Return value** + +| Type | Description | +| -------------- | ------------------- | +| Promise\ | Promise used to return the result.| + +**Example** + +```js +var abilityDelegator; +var msg = "msg"; + +abilityDelegator = AbilityDelegatorRegistry.getAbilityDelegator(); +abilityDelegator.finishTest(msg, 0).then(() => { + console.info("finishTest promise"); +}); +``` diff --git a/en/application-dev/reference/apis/js-apis-application-abilityMonitor.md b/en/application-dev/reference/apis/js-apis-application-abilityMonitor.md index 82ae1e5924..b31687b7ed 100644 --- a/en/application-dev/reference/apis/js-apis-application-abilityMonitor.md +++ b/en/application-dev/reference/apis/js-apis-application-abilityMonitor.md @@ -16,15 +16,13 @@ import AbilityDelegatorRegistry from '@ohos.application.abilityDelegatorRegistry Describes an ability monitor. -**System capability**: SystemCapability.Ability.AbilityRuntime.Core - -| Name | Type | Readable| Writable| Description | -| -------------------- | -------- | ---- | ---- | ------------------------------------------------------------ | -| abilityName | string | Yes | Yes | Name of the ability bound to the ability monitor. | -| onAbilityCreate | function | Yes | Yes | Called when the ability is created.
If this attribute is not set, the corresponding lifecycle callback cannot be received.| -| onAbilityForeground | function | Yes | Yes | Called when the ability starts to run in the foreground.
If this attribute is not set, the corresponding lifecycle callback cannot be received.| -| onAbilityBackground | function | Yes | Yes | Called when the ability starts to run in the background.
If this attribute is not set, the corresponding lifecycle callback cannot be received.| -| onAbilityDestroy | function | Yes | Yes | Called when the ability is destroyed.
If this attribute is not set, the corresponding lifecycle callback cannot be received.| -| onWindowStageCreate | function | Yes | Yes | Called when the window stage is created.
If this attribute is not set, the corresponding lifecycle callback cannot be received.| -| onWindowStageRestore | function | Yes | Yes | Called when the window stage is restored.
If this attribute is not set, the corresponding lifecycle callback cannot be received.| -| onWindowStageDestroy | function | Yes | Yes | Called when the window stage is destroyed.
If this attribute is not set, the corresponding lifecycle callback cannot be received.| +| Name | Type | Readable| Writable| Description | +| ------------------------------------------------------------ | -------- | ---- | ---- | ------------------------------------------------------------ | +| abilityName | string | Yes | Yes | Name of the ability bound to the ability monitor.
**System capability**: SystemCapability.Ability.AbilityRuntime.Core| +| onAbilityCreate?:(data: [Ability](js-apis-application-ability.md#Ability)) | function | Yes | Yes | Called when the ability is created.
If this attribute is not set, the corresponding lifecycle callback cannot be received.
**System capability**: SystemCapability.Ability.AbilityRuntime.Core| +| onAbilityForeground?:(data: [Ability](js-apis-application-ability.md#Ability)) | function | Yes | Yes | Called when the ability starts to run in the foreground.
If this attribute is not set, the corresponding lifecycle callback cannot be received.
**System capability**: SystemCapability.Ability.AbilityRuntime.Core| +| onAbilityBackground?:(data: [Ability](js-apis-application-ability.md#Ability)) | function | Yes | Yes | Called when the ability starts to run in the background.
If this attribute is not set, the corresponding lifecycle callback cannot be received.
**System capability**: SystemCapability.Ability.AbilityRuntime.Core| +| onAbilityDestroy?:(data: [Ability](js-apis-application-ability.md#Ability)) | function | Yes | Yes | Called when the ability is destroyed.
If this attribute is not set, the corresponding lifecycle callback cannot be received.
**System capability**: SystemCapability.Ability.AbilityRuntime.Core| +| onWindowStageCreate?:(data: [Ability](js-apis-application-ability.md#Ability)) | function | Yes | Yes | Called when the window stage is created.
If this attribute is not set, the corresponding lifecycle callback cannot be received.
**System capability**: SystemCapability.Ability.AbilityRuntime.Core| +| onWindowStageRestore?:(data: [Ability](js-apis-application-ability.md#Ability)) | function | Yes | Yes | Called when the window stage is restored.
If this attribute is not set, the corresponding lifecycle callback cannot be received.
**System capability**: SystemCapability.Ability.AbilityRuntime.Core| +| onWindowStageDestroy?:(data: [Ability](js-apis-application-ability.md#Ability)) | function | Yes | Yes | Called when the window stage is destroyed.
If this attribute is not set, the corresponding lifecycle callback cannot be received.
**System capability**: SystemCapability.Ability.AbilityRuntime.Core| -- GitLab