未验证 提交 0f9b3b83 编写于 作者: O openharmony_ci 提交者: Gitee

!2943 【测试框架】文档更新追加finishTest函数

Merge pull request !2943 from njupthan/update_master_0401
...@@ -20,7 +20,7 @@ addAbilityMonitor(monitor: AbilityMonitor, callback: AsyncCallback\<void>): void ...@@ -20,7 +20,7 @@ addAbilityMonitor(monitor: AbilityMonitor, callback: AsyncCallback\<void>): void
添加AbilityMonitor实例(callback形式) 添加AbilityMonitor实例(callback形式)
**系统能力:** SystemCapability.Ability.AbilityRuntime.Core **系统能力:**SystemCapability.Ability.AbilityRuntime.Core
**参数:** **参数:**
...@@ -34,7 +34,7 @@ addAbilityMonitor(monitor: AbilityMonitor, callback: AsyncCallback\<void>): void ...@@ -34,7 +34,7 @@ addAbilityMonitor(monitor: AbilityMonitor, callback: AsyncCallback\<void>): void
```js ```js
var abilityDelegator; var abilityDelegator;
function onAbilityCreateCallback() { function onAbilityCreateCallback(data) {
console.info("onAbilityCreateCallback"); console.info("onAbilityCreateCallback");
} }
...@@ -44,7 +44,7 @@ var monitor = { ...@@ -44,7 +44,7 @@ var monitor = {
} }
abilityDelegator = AbilityDelegatorRegistry.getAbilityDelegator(); abilityDelegator = AbilityDelegatorRegistry.getAbilityDelegator();
abilityDelegator.addAbilityMonitor(monitor, (err) => { abilityDelegator.addAbilityMonitor(monitor, (err : any) => {
console.info("addAbilityMonitor callback"); console.info("addAbilityMonitor callback");
}); });
``` ```
...@@ -76,7 +76,7 @@ addAbilityMonitor(monitor: AbilityMonitor): Promise\<void> ...@@ -76,7 +76,7 @@ addAbilityMonitor(monitor: AbilityMonitor): Promise\<void>
```js ```js
var abilityDelegator; var abilityDelegator;
function onAbilityCreateCallback() { function onAbilityCreateCallback(data) {
console.info("onAbilityCreateCallback"); console.info("onAbilityCreateCallback");
} }
...@@ -113,7 +113,7 @@ removeAbilityMonitor(monitor: AbilityMonitor, callback: AsyncCallback\<void>): v ...@@ -113,7 +113,7 @@ removeAbilityMonitor(monitor: AbilityMonitor, callback: AsyncCallback\<void>): v
```js ```js
var abilityDelegator; var abilityDelegator;
function onAbilityCreateCallback() { function onAbilityCreateCallback(data) {
console.info("onAbilityCreateCallback"); console.info("onAbilityCreateCallback");
} }
...@@ -123,7 +123,7 @@ var monitor = { ...@@ -123,7 +123,7 @@ var monitor = {
} }
abilityDelegator = AbilityDelegatorRegistry.getAbilityDelegator(); abilityDelegator = AbilityDelegatorRegistry.getAbilityDelegator();
abilityDelegator.removeAbilityMonitor(monitor, (err) => { abilityDelegator.removeAbilityMonitor(monitor, (err : any) => {
console.info("removeAbilityMonitor callback"); console.info("removeAbilityMonitor callback");
}); });
``` ```
...@@ -155,7 +155,7 @@ removeAbilityMonitor(monitor: AbilityMonitor): Promise\<void> ...@@ -155,7 +155,7 @@ removeAbilityMonitor(monitor: AbilityMonitor): Promise\<void>
```js ```js
var abilityDelegator; var abilityDelegator;
function onAbilityCreateCallback() { function onAbilityCreateCallback(data) {
console.info("onAbilityCreateCallback"); console.info("onAbilityCreateCallback");
} }
...@@ -192,7 +192,7 @@ waitAbilityMonitor(monitor: AbilityMonitor, callback: AsyncCallback\<Ability>): ...@@ -192,7 +192,7 @@ waitAbilityMonitor(monitor: AbilityMonitor, callback: AsyncCallback\<Ability>):
```js ```js
var abilityDelegator; var abilityDelegator;
function onAbilityCreateCallback() { function onAbilityCreateCallback(data) {
console.info("onAbilityCreateCallback"); console.info("onAbilityCreateCallback");
} }
...@@ -202,7 +202,7 @@ var monitor = { ...@@ -202,7 +202,7 @@ var monitor = {
} }
abilityDelegator = AbilityDelegatorRegistry.getAbilityDelegator(); abilityDelegator = AbilityDelegatorRegistry.getAbilityDelegator();
abilityDelegator.waitAbilityMonitor(monitor, (err, data) => { abilityDelegator.waitAbilityMonitor(monitor, (err : any, data : any) => {
console.info("waitAbilityMonitor callback"); console.info("waitAbilityMonitor callback");
}); });
``` ```
...@@ -231,7 +231,7 @@ waitAbilityMonitor(monitor: AbilityMonitor, timeout: number, callback: AsyncCall ...@@ -231,7 +231,7 @@ waitAbilityMonitor(monitor: AbilityMonitor, timeout: number, callback: AsyncCall
var abilityDelegator; var abilityDelegator;
var timeout = 100; var timeout = 100;
function onAbilityCreateCallback() { function onAbilityCreateCallback(data) {
console.info("onAbilityCreateCallback"); console.info("onAbilityCreateCallback");
} }
...@@ -241,7 +241,7 @@ var monitor = { ...@@ -241,7 +241,7 @@ var monitor = {
} }
abilityDelegator = AbilityDelegatorRegistry.getAbilityDelegator(); abilityDelegator = AbilityDelegatorRegistry.getAbilityDelegator();
abilityDelegator.waitAbilityMonitor(monitor, timeout, (err, data) => { abilityDelegator.waitAbilityMonitor(monitor, timeout, (err : any, data : any) => {
console.info("waitAbilityMonitor callback"); console.info("waitAbilityMonitor callback");
}); });
``` ```
...@@ -274,7 +274,7 @@ waitAbilityMonitor(monitor: AbilityMonitor, timeout?: number): Promise\<Ability> ...@@ -274,7 +274,7 @@ waitAbilityMonitor(monitor: AbilityMonitor, timeout?: number): Promise\<Ability>
```js ```js
var abilityDelegator; var abilityDelegator;
function onAbilityCreateCallback() { function onAbilityCreateCallback(data) {
console.info("onAbilityCreateCallback"); console.info("onAbilityCreateCallback");
} }
...@@ -343,7 +343,7 @@ var abilityDelegator; ...@@ -343,7 +343,7 @@ var abilityDelegator;
var ability; var ability;
abilityDelegator = AbilityDelegatorRegistry.getAbilityDelegator(); abilityDelegator = AbilityDelegatorRegistry.getAbilityDelegator();
abilityDelegator.getCurrentTopAbility((err, data) => { abilityDelegator.getCurrentTopAbility((err : any, data : any) => {
console.info("getCurrentTopAbility callback"); console.info("getCurrentTopAbility callback");
ability = data; ability = data;
var state = abilityDelegator.getAbilityState(ability); var state = abilityDelegator.getAbilityState(ability);
...@@ -374,7 +374,7 @@ var abilityDelegator; ...@@ -374,7 +374,7 @@ var abilityDelegator;
var ability; var ability;
abilityDelegator = AbilityDelegatorRegistry.getAbilityDelegator(); abilityDelegator = AbilityDelegatorRegistry.getAbilityDelegator();
abilityDelegator.getCurrentTopAbility((err, data) => { abilityDelegator.getCurrentTopAbility((err : any, data : any) => {
console.info("getCurrentTopAbility callback"); console.info("getCurrentTopAbility callback");
ability = data; ability = data;
}); });
...@@ -411,7 +411,7 @@ abilityDelegator.getCurrentTopAbility().then((data : any) => { ...@@ -411,7 +411,7 @@ abilityDelegator.getCurrentTopAbility().then((data : any) => {
### startAbility ### startAbility<sup>9+</sup>
startAbility(want: Want, callback: AsyncCallback\<void>): void startAbility(want: Want, callback: AsyncCallback\<void>): void
...@@ -436,14 +436,14 @@ var want = { ...@@ -436,14 +436,14 @@ var want = {
}; };
abilityDelegator = AbilityDelegatorRegistry.getAbilityDelegator(); abilityDelegator = AbilityDelegatorRegistry.getAbilityDelegator();
abilityDelegator.startAbility(want, (err, data) => { abilityDelegator.startAbility(want, (err : any, data : any) => {
console.info("startAbility callback"); console.info("startAbility callback");
}); });
``` ```
### startAbility ### startAbility<sup>9+</sup>
startAbility(want: Want): Promise\<void> startAbility(want: Want): Promise\<void>
...@@ -502,10 +502,10 @@ var abilityDelegator; ...@@ -502,10 +502,10 @@ var abilityDelegator;
var ability; var ability;
abilityDelegator = AbilityDelegatorRegistry.getAbilityDelegator(); abilityDelegator = AbilityDelegatorRegistry.getAbilityDelegator();
abilityDelegator.getCurrentTopAbility((err, data) => { abilityDelegator.getCurrentTopAbility((err : any, data : any) => {
console.info("getCurrentTopAbility callback"); console.info("getCurrentTopAbility callback");
ability = data; ability = data;
abilityDelegator.doAbilityForeground(ability, (err, data) => { abilityDelegator.doAbilityForeground(ability, (err : any, data : any) => {
console.info("doAbilityForeground callback"); console.info("doAbilityForeground callback");
}); });
}); });
...@@ -540,7 +540,7 @@ var abilityDelegator; ...@@ -540,7 +540,7 @@ var abilityDelegator;
var ability; var ability;
abilityDelegator = AbilityDelegatorRegistry.getAbilityDelegator(); abilityDelegator = AbilityDelegatorRegistry.getAbilityDelegator();
abilityDelegator.getCurrentTopAbility((err, data) => { abilityDelegator.getCurrentTopAbility((err : any, data : any) => {
console.info("getCurrentTopAbility callback"); console.info("getCurrentTopAbility callback");
ability = data; ability = data;
abilityDelegator.doAbilityForeground(ability).then((data : any) => { abilityDelegator.doAbilityForeground(ability).then((data : any) => {
...@@ -573,10 +573,10 @@ var abilityDelegator; ...@@ -573,10 +573,10 @@ var abilityDelegator;
var ability; var ability;
abilityDelegator = AbilityDelegatorRegistry.getAbilityDelegator(); abilityDelegator = AbilityDelegatorRegistry.getAbilityDelegator();
abilityDelegator.getCurrentTopAbility((err, data) => { abilityDelegator.getCurrentTopAbility((err : any, data : any) => {
console.info("getCurrentTopAbility callback"); console.info("getCurrentTopAbility callback");
ability = data; ability = data;
abilityDelegator.doAbilityBackground(ability, (err, data) => { abilityDelegator.doAbilityBackground(ability, (err : any, data : any) => {
console.info("doAbilityBackground callback"); console.info("doAbilityBackground callback");
}); });
}); });
...@@ -611,10 +611,10 @@ var abilityDelegator; ...@@ -611,10 +611,10 @@ var abilityDelegator;
var ability; var ability;
abilityDelegator = AbilityDelegatorRegistry.getAbilityDelegator(); abilityDelegator = AbilityDelegatorRegistry.getAbilityDelegator();
abilityDelegator.getCurrentTopAbility((err, data) => { abilityDelegator.getCurrentTopAbility((err : any, data : any) => {
console.info("getCurrentTopAbility callback"); console.info("getCurrentTopAbility callback");
ability = data; ability = data;
abilityDelegator.doAbilityBackground(ability).then((data) => { abilityDelegator.doAbilityBackground(ability).then((data : any) => {
console.info("doAbilityBackground promise"); console.info("doAbilityBackground promise");
}); });
}); });
...@@ -644,7 +644,7 @@ var abilityDelegator; ...@@ -644,7 +644,7 @@ var abilityDelegator;
var msg = "msg"; var msg = "msg";
abilityDelegator = AbilityDelegatorRegistry.getAbilityDelegator(); abilityDelegator = AbilityDelegatorRegistry.getAbilityDelegator();
abilityDelegator.print(msg, (err) => { abilityDelegator.print(msg, (err : any) => {
console.info("print callback"); console.info("print callback");
}); });
``` ```
...@@ -707,7 +707,7 @@ var abilityDelegator; ...@@ -707,7 +707,7 @@ var abilityDelegator;
var cmd = "cmd"; var cmd = "cmd";
abilityDelegator = AbilityDelegatorRegistry.getAbilityDelegator(); abilityDelegator = AbilityDelegatorRegistry.getAbilityDelegator();
abilityDelegator.executeShellCommand(cmd, (err, data) => { abilityDelegator.executeShellCommand(cmd, (err : any, data : any) => {
console.info("executeShellCommand callback"); console.info("executeShellCommand callback");
}); });
``` ```
...@@ -738,7 +738,7 @@ var cmd = "cmd"; ...@@ -738,7 +738,7 @@ var cmd = "cmd";
var timeout = 100; var timeout = 100;
abilityDelegator = AbilityDelegatorRegistry.getAbilityDelegator(); abilityDelegator = AbilityDelegatorRegistry.getAbilityDelegator();
abilityDelegator.executeShellCommand(cmd, timeout, (err, data) => { abilityDelegator.executeShellCommand(cmd, timeout, (err : any, data : any) => {
console.info("executeShellCommand callback"); console.info("executeShellCommand callback");
}); });
``` ```
...@@ -778,3 +778,69 @@ abilityDelegator.executeShellCommand(cmd, timeout).then((data : any) => { ...@@ -778,3 +778,69 @@ abilityDelegator.executeShellCommand(cmd, timeout).then((data : any) => {
console.info("executeShellCommand promise"); console.info("executeShellCommand promise");
}); });
``` ```
### finishTest<sup>9+</sup>
finishTest(msg: string, code: number, callback: AsyncCallback\<void>): void
结束测试并打印日志信息到单元测试终端控制台(callback形式)
**系统能力:** SystemCapability.Ability.AbilityRuntime.Core
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------------------- | ---- | ------------------ |
| msg | string | 是 | 日志字符串 |
| code | number | 是 | 日志码 |
| callback | AsyncCallback\<void> | 是 | 表示指定的回调方法 |
**示例:**
```js
var abilityDelegator;
var msg = "msg";
abilityDelegator = AbilityDelegatorRegistry.getAbilityDelegator();
abilityDelegator.finishTest(msg, 0, (err : any) => {
console.info("finishTest callback");
});
```
### finishTest<sup>9+</sup>
finishTest(msg: string, code: number): Promise\<void>
结束测试并打印日志信息到单元测试终端控制台(promise形式)
**系统能力:** SystemCapability.Ability.AbilityRuntime.Core
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| ------ | ------ | ---- | ---------- |
| msg | string | 是 | 日志字符串 |
| code | number | 是 | 日志码 |
**返回值:**
| 类型 | 说明 |
| -------------- | ------------------- |
| Promise\<void> | 以Promise形式返回。 |
**示例:**
```js
var abilityDelegator;
var msg = "msg";
abilityDelegator = AbilityDelegatorRegistry.getAbilityDelegator();
abilityDelegator.finishTest(msg, 0).then(() => {
console.info("finishTest promise");
});
```
...@@ -16,16 +16,15 @@ import AbilityDelegatorRegistry from '@ohos.application.abilityDelegatorRegistry ...@@ -16,16 +16,15 @@ import AbilityDelegatorRegistry from '@ohos.application.abilityDelegatorRegistry
Ability监听器 Ability监听器
**系统能力:** 以下各项对应的系统能力均为SystemCapability.Ability.AbilityRuntime.Core | 名称 | 类型 | 可读 | 可写 | 说明 |
| ------------------------------------------------------------ | -------- | ---- | ---- | ------------------------------------------------------------ |
| 名称 | 类型 | 可读 | 可写 | 说明 | | abilityName | string | 是 | 是 | 当前AbilityMonitor绑定的ability名称<br/>**系统能力:** SystemCapability.Ability.AbilityRuntime.Core |
| -------------------- | -------- | ---- | ---- | ------------------------------------------------------------ | | onAbilityCreate?:(data: [Ability](js-apis-application-ability.md#Ability)) | function | 是 | 是 | ability被启动初始化时的回调函数<br/>不设置该属性则不能收到该生命周期回调<br/>**系统能力:** SystemCapability.Ability.AbilityRuntime.Core |
| abilityName | string | 是 | 是 | 当前AbilityMonitor绑定的ability名称。 | | onAbilityForeground?:(data: [Ability](js-apis-application-ability.md#Ability)) | function | 是 | 是 | ability状态变成前台时的回调函数<br/>不设置该属性则不能收到该生命周期回调<br/>**系统能力:** SystemCapability.Ability.AbilityRuntime.Core |
| onAbilityCreate | function | 是 | 是 | ability被启动初始化时的回调函数。<br/>不设置该属性则不能收到该生命周期回调。 | | onAbilityBackground?:(data: [Ability](js-apis-application-ability.md#Ability)) | function | 是 | 是 | ability状态变成后台时的回调函数<br/>不设置该属性则不能收到该生命周期回调<br/>**系统能力:** SystemCapability.Ability.AbilityRuntime.Core |
| onAbilityForeground | function | 是 | 是 | ability状态变成前台时的回调函数。<br/>不设置该属性则不能收到该生命周期回调。 | | onAbilityDestroy?:(data: [Ability](js-apis-application-ability.md#Ability)) | function | 是 | 是 | ability被销毁前的回调函数<br/>不设置该属性则不能收到该生命周期回调<br/>**系统能力:** SystemCapability.Ability.AbilityRuntime.Core |
| onAbilityBackground | function | 是 | 是 | ability状态变成后台时的回调函数。<br/>不设置该属性则不能收到该生命周期回调。 | | onWindowStageCreate?:(data: [Ability](js-apis-application-ability.md#Ability)) | function | 是 | 是 | window stage被创建时的回调函数<br/>不设置该属性则不能收到该生命周期回调<br/>**系统能力:** SystemCapability.Ability.AbilityRuntime.Core |
| onAbilityDestroy | function | 是 | 是 | ability被销毁前的回调函数。<br/>不设置该属性则不能收到该生命周期回调。 | | onWindowStageRestore?:(data: [Ability](js-apis-application-ability.md#Ability)) | function | 是 | 是 | window stage被重载时的回调函数<br/>不设置该属性则不能收到该生命周期回调<br/>**系统能力:** SystemCapability.Ability.AbilityRuntime.Core |
| onWindowStageCreate | function | 是 | 是 | window stage被创建时的回调函数。<br/>不设置该属性则不能收到该生命周期回调。 | | onWindowStageDestroy?:(data: [Ability](js-apis-application-ability.md#Ability)) | function | 是 | 是 | window stage被销毁前的回调函数<br/>不设置该属性则不能收到该生命周期回调<br/>**系统能力:** SystemCapability.Ability.AbilityRuntime.Core |
| onWindowStageRestore | function | 是 | 是 | window stage被重载时的回调函数。<br/>不设置该属性则不能收到该生命周期回调。 |
| onWindowStageDestroy | function | 是 | 是 | window stage被销毁前的回调函数。<br/>不设置该属性则不能收到该生命周期回调。 |
Markdown is supported
0% .
You are about to add 0 people to the discussion. Proceed with caution.
先完成此消息的编辑!
想要评论请 注册