diff --git a/zh-cn/application-dev/reference/apis/js-apis-abilityDelegatorRegistry.md b/zh-cn/application-dev/reference/apis/js-apis-abilityDelegatorRegistry.md new file mode 100644 index 0000000000000000000000000000000000000000..4be8ef319bf4b186e2677e12e557d1592b16152c --- /dev/null +++ b/zh-cn/application-dev/reference/apis/js-apis-abilityDelegatorRegistry.md @@ -0,0 +1,74 @@ +# AbilityDelegatorRegistry + +> **说明** +> +> 本模块首批接口从API version 8开始支持。后续版本的新增接口,采用上角标单独标记接口的起始版本。 + +## 导入模块 + +```js +import AbilityDelegatorRegistry from '@ohos.application.abilityDelegatorRegistry' +``` + + + +## AbilityLifecycleState + +Ability生命周期状态 + +| 名称 | 值 | 说明 | +| ------------- | ---- | ------------------------------------------------------------ | +| UNINITIALIZED | 0 | 表示无效状态。
**系统能力** :SystemCapability.Ability.AbilityRuntime.Core | +| CREATE | 1 | 表示Ability处于已创建状态。
**系统能力** :SystemCapability.Ability.AbilityRuntime.Core | +| FOREGROUND | 2 | 表示Ability处于前台状态。
**系统能力** :SystemCapability.Ability.AbilityRuntime.Core | +| BACKGROUND | 3 | 表示Ability处于后台状态。
**系统能力** :SystemCapability.Ability.AbilityRuntime.Core | +| DESTROY | 4 | 表示Ability处于已销毁状态。
**系统能力** :SystemCapability.Ability.AbilityRuntime.Core | + + + +## AbilityDelegatorRegistry.getAbilityDelegator + +getAbilityDelegator(): AbilityDelegator + +获取应用程序的AbilityDelegator对象 + +**系统能力:** SystemCapability.Ability.AbilityRuntime.Core + +**返回值:** + +| 类型 | 说明 | +| ------------------------------------------------------------ | ------------------------------------------------------------ | +| [AbilityDelegator](js-apis-application-abilityDelegator.md#AbilityDelegator) | [AbilityDelegator](js-apis-application-abilityDelegator.md#AbilityDelegator)对象。可有用来调度测试框架相关功能。 | + +**示例:** + +```js +var abilityDelegator; + +abilityDelegator = AbilityDelegatorRegistry.getAbilityDelegator(); +``` + + + +## AbilityDelegatorRegistry.getArguments + +getArguments(): AbilityDelegatorArgs + +获取单元测试参数AbilityDelegatorArgs对象 + +**系统能力:** SystemCapability.Ability.AbilityRuntime.Core + +**返回值:** + +| 类型 | 说明 | +| ------------------------------------------------------------ | ------------------------------------------------------------ | +| [AbilityDelegatorArgs](js-apis-application-abilityDelegatorArgs.md#AbilityDelegatorArgs) | [AbilityDelegatorArgs](js-apis-application-abilityDelegatorArgs.md#AbilityDelegatorArgs)对象。可以用来获取测试参数。 | + +**示例:** + +```js +var args = AbilityDelegatorRegistry.getArguments(); +console.info("getArguments bundleName:" + args.bundleName); +console.info("getArguments testCaseNames:" + args.testCaseNames); +console.info("getArguments testRunnerClassName:" + args.testRunnerClassName); +``` diff --git a/zh-cn/application-dev/reference/apis/js-apis-application-abilityDelegator.md b/zh-cn/application-dev/reference/apis/js-apis-application-abilityDelegator.md new file mode 100644 index 0000000000000000000000000000000000000000..41d981448b20a55f9a5439a0583e1e065315cf5f --- /dev/null +++ b/zh-cn/application-dev/reference/apis/js-apis-application-abilityDelegator.md @@ -0,0 +1,780 @@ +# AbilityDelegator + +> **说明** +> +> 本模块首批接口从API version 8开始支持。后续版本的新增接口,采用上角标单独标记接口的起始版本。 + +## 导入模块 + +```js +import { AbilityDelegator } from './application/abilityDelegator' +``` + + + +## AbilityDelegator + +### addAbilityMonitor9+ + +addAbilityMonitor(monitor: AbilityMonitor, callback: AsyncCallback\): void + +添加AbilityMonitor实例(callback形式) + +**系统能力:**SystemCapability.Ability.AbilityRuntime.Core + +**参数:** + +| 参数名 | 类型 | 必填说明 | 说明 | +| -------- | ------------------------------------------------------------ | -------- | ------------------------------------------------------------ | +| monitor | [AbilityMonitor](js-apis-application-abilityMonitor.md#AbilityMonitor) | 是 | [AbilityMonitor](js-apis-application-abilityMonitor.md#AbilityMonitor)实例 | +| callback | AsyncCallback\ | 是 | 表示指定的回调方法 | + +**示例:** + +```js +var abilityDelegator; + +function onAbilityCreateCallback() { + console.info("onAbilityCreateCallback"); +} + +var monitor = { + abilityName: "abilityname", + onAbilityCreate: onAbilityCreateCallback +} + +abilityDelegator = AbilityDelegatorRegistry.getAbilityDelegator(); +abilityDelegator.addAbilityMonitor(monitor, (err) => { + console.info("addAbilityMonitor callback"); +}); +``` + + + +### addAbilityMonitor9+ + +addAbilityMonitor(monitor: AbilityMonitor): Promise\ + +添加AbilityMonitor实例(promise形式) + +**系统能力:** SystemCapability.Ability.AbilityRuntime.Core + +**参数:** + +| 参数名 | 类型 | 必填 | 说明 | +| ------- | ------------------------------------------------------------ | ---- | ------------------------------------------------------------ | +| monitor | [AbilityMonitor](js-apis-application-abilityMonitor.md#AbilityMonitor) | 是 | [AbilityMonitor](js-apis-application-abilityMonitor.md#AbilityMonitor)实例 | + +**返回值:** + +| 类型 | 说明 | +| -------------- | ------------------- | +| Promise\ | 以Promise形式返回。 | + +**示例:** + +```js +var abilityDelegator; + +function onAbilityCreateCallback() { + console.info("onAbilityCreateCallback"); +} + +var monitor = { + abilityName: "abilityname", + onAbilityCreate: onAbilityCreateCallback +} + +abilityDelegator = AbilityDelegatorRegistry.getAbilityDelegator(); +abilityDelegator.addAbilityMonitor(monitor).then((void) => { + console.info("addAbilityMonitor promise"); +}); +``` + + + +### removeAbilityMonitor9+ + +removeAbilityMonitor(monitor: AbilityMonitor, callback: AsyncCallback\): void + +删除已经添加的AbilityMonitor实例(callback形式) + +**系统能力:** SystemCapability.Ability.AbilityRuntime.Core + +**参数:** + +| 参数名 | 类型 | 必填 | 说明 | +| -------- | ------------------------------------------------------------ | ---- | ------------------------------------------------------------ | +| monitor | [AbilityMonitor](js-apis-application-abilityMonitor.md#AbilityMonitor) | 是 | [AbilityMonitor](js-apis-application-abilityMonitor.md#AbilityMonitor)实例 | +| callback | AsyncCallback\ | 是 | 表示指定的回调方法 | + +**示例:** + +```js +var abilityDelegator; + +function onAbilityCreateCallback() { + console.info("onAbilityCreateCallback"); +} + +var monitor = { + abilityName: "abilityname", + onAbilityCreate: onAbilityCreateCallback +} + +abilityDelegator = AbilityDelegatorRegistry.getAbilityDelegator(); +abilityDelegator.removeAbilityMonitor(monitor, (err) => { + console.info("removeAbilityMonitor callback"); +}); +``` + + + +### removeAbilityMonitor9+ + +removeAbilityMonitor(monitor: AbilityMonitor): Promise\ + +删除已经添加的AbilityMonitor实例(promise形式) + +**系统能力:** SystemCapability.Ability.AbilityRuntime.Core + +**参数:** + +| 名称 | 类型 | 必填 | 说明 | +| ------- | ------------------------------------------------------------ | ---- | ------------------------------------------------------------ | +| monitor | [AbilityMonitor](js-apis-application-abilityMonitor.md#AbilityMonitor) | 是 | [AbilityMonitor](js-apis-application-abilityMonitor.md#AbilityMonitor)实例 | + +**返回值:** + +| 类型 | 说明 | +| -------------- | ------------------- | +| Promise\ | 以Promise形式返回。 | + +- 示例 + +```js +var abilityDelegator; + +function onAbilityCreateCallback() { + console.info("onAbilityCreateCallback"); +} + +var monitor = { + abilityName: "abilityname", + onAbilityCreate: onAbilityCreateCallback +} + +abilityDelegator = AbilityDelegatorRegistry.getAbilityDelegator(); +abilityDelegator.removeAbilityMonitor(monitor).then((void) => { + console.info("removeAbilityMonitor promise"); +}); +``` + + + +### waitAbilityMonitor9+ + +waitAbilityMonitor(monitor: AbilityMonitor, callback: AsyncCallback\): void + +等待与AbilityMonitor实例匹配的ability到达OnCreate生命周期,并返回ability实例(callback形式) + +**系统能力:** SystemCapability.Ability.AbilityRuntime.Core + +**参数:** + +| 参数名 | 类型 | 必填 | 说明 | +| -------- | ------------------------------------------------------------ | ---- | ------------------------------------------------------------ | +| monitor | [AbilityMonitor](js-apis-application-abilityMonitor.md#AbilityMonitor) | 是 | [AbilityMonitor](js-apis-application-abilityMonitor.md#AbilityMonitor)实例 | +| callback | AsyncCallback\ | 是 | 表示指定的回调方法 | + +**示例:** + +```js +var abilityDelegator; + +function onAbilityCreateCallback() { + console.info("onAbilityCreateCallback"); +} + +var monitor = { + abilityName: "abilityname", + onAbilityCreate: onAbilityCreateCallback +} + +abilityDelegator = AbilityDelegatorRegistry.getAbilityDelegator(); +abilityDelegator.waitAbilityMonitor(monitor, (err, data) => { + console.info("waitAbilityMonitor callback"); +}); +``` + + + +### waitAbilityMonitor9+ + +waitAbilityMonitor(monitor: AbilityMonitor, timeout: number, callback: AsyncCallback\): void + +设置等待时间,等待与AbilityMonitor实例匹配的ability到达OnCreate生命周期,并返回ability实例(callback形式) + +**系统能力:** SystemCapability.Ability.AbilityRuntime.Core + +**参数:** + +| 参数名 | 类型 | 必填 | 说明 | +| -------- | ------------------------------------------------------------ | ---- | ------------------------------------------------------------ | +| monitor | [AbilityMonitor](js-apis-application-abilityMonitor.md#AbilityMonitor) | 是 | [AbilityMonitor](js-apis-application-abilityMonitor.md#AbilityMonitor)实例 | +| timeout | number | 是 | 最大等待时间,单位毫秒 | +| callback | AsyncCallback\ | 是 | 表示指定的回调方法 | + +**示例:** + +```js +var abilityDelegator; +var timeout = 100; + +function onAbilityCreateCallback() { + console.info("onAbilityCreateCallback"); +} + +var monitor = { + abilityName: "abilityname", + onAbilityCreate: onAbilityCreateCallback +} + +abilityDelegator = AbilityDelegatorRegistry.getAbilityDelegator(); +abilityDelegator.waitAbilityMonitor(monitor, timeout, (err, data) => { + console.info("waitAbilityMonitor callback"); +}); +``` + + + +### waitAbilityMonitor9+ + +waitAbilityMonitor(monitor: AbilityMonitor, timeout?: number): Promise\ + +等待与AbilityMonitor实例匹配的ability到达OnCreate生命周期,并返回ability实例(promise形式) + +**系统能力:** SystemCapability.Ability.AbilityRuntime.Core + +**参数:** + +| 参数名 | 类型 | 必填 | 说明 | +| ------- | ------------------------------------------------------------ | ---- | ------------------------------------------------------------ | +| monitor | [AbilityMonitor](js-apis-application-abilityMonitor.md#AbilityMonitor) | 是 | [AbilityMonitor](js-apis-application-abilityMonitor.md#AbilityMonitor)实例 | +| timeout | number | 否 | 最大等待时间,单位毫秒 | + +**返回值:** + +| 类型 | 说明 | +| -------------- | -------------------------- | +| Promise\ | 以Promise形式返回Ability。 | + +**示例:** + +```js +var abilityDelegator; + +function onAbilityCreateCallback() { + console.info("onAbilityCreateCallback"); +} + +var monitor = { + abilityName: "abilityname", + onAbilityCreate: onAbilityCreateCallback +} + +abilityDelegator = AbilityDelegatorRegistry.getAbilityDelegator(); +abilityDelegator.waitAbilityMonitor(monitor).then((data) => { + console.info("waitAbilityMonitor promise"); +}); +``` + + + +### getAppContext9+ + +getAppContext(): Context + +获取应用Context + +**系统能力:** SystemCapability.Ability.AbilityRuntime.Core + +**返回值:** + +| 类型 | 说明 | +| ------------------------------------- | ------------------------------------------- | +| [Context](js-apis-Context.md#Context) | 应用[Context](js-apis-Context.md#Context)。 | + +**示例:** + +```js +var abilityDelegator; + +abilityDelegator = AbilityDelegatorRegistry.getAbilityDelegator(); +var context = abilityDelegator.getAppContext(); +``` + + + +### getAbilityState9+ + +getAbilityState(ability: Ability): number + +获取指定ability的生命周期状态 + +**系统能力:** SystemCapability.Ability.AbilityRuntime.Core + +**参数:** + +| 参数名 | 类型 | 必填 | 说明 | +| ------- | ------- | ---- | --------------- | +| ability | Ability | 是 | 指定Ability对象 | + +**返回值:** + +| 类型 | 说明 | +| ------ | ------------------------------------------------------------ | +| number | 指定ability的生命周期状态。状态枚举值使用[AbilityLifecycleState](js-apis-abilityDelegatorRegistry.md#AbilityLifecycleState)。 | + +**示例:** + +```js +var abilityDelegator; +var ability; + +abilityDelegator = AbilityDelegatorRegistry.getAbilityDelegator(); +abilityDelegator.getCurrentTopAbility((err, data) => { + console.info("getCurrentTopAbility callback"); + ability = data; + var state = abilityDelegator.getAbilityState(ability); + console.info("getAbilityState" + state); +}); +``` + + + +### getCurrentTopAbility9+ + +getCurrentTopAbility(callback: AsyncCallback\): void + +获取当前应用顶部ability(callback形式) + +**系统能力:** SystemCapability.Ability.AbilityRuntime.Core + +**参数:** + +| 参数名 | 类型 | 必填 | 说明 | +| -------- | ----------------------- | ---- | ------------------ | +| callback | AsyncCallback\ | 是 | 表示指定的回调方法 | + +**示例:** + +```js +var abilityDelegator; +var ability; + +abilityDelegator = AbilityDelegatorRegistry.getAbilityDelegator(); +abilityDelegator.getCurrentTopAbility((err, data) => { + console.info("getCurrentTopAbility callback"); + ability = data; +}); +``` + + + +### getCurrentTopAbility9+ + +getCurrentTopAbility(): Promise\ + +获取当前应用顶部ability(promise形式) + +**系统能力:** SystemCapability.Ability.AbilityRuntime.Core + +**返回值:** + +| 类型 | 说明 | +| ----------------- | -------------------------------------- | +| Promise\ | 以Promise形式返回当前应用顶部ability。 | + +**示例:** + +```js +var abilityDelegator; +var ability; + +abilityDelegator = AbilityDelegatorRegistry.getAbilityDelegator(); +abilityDelegator.getCurrentTopAbility().then((data) => { + console.info("getCurrentTopAbility promise"); + ability = data; +}); +``` + + + +### startAbility + +startAbility(want: Want, callback: AsyncCallback\): void + +启动指定ability(callback形式) + +**系统能力:** SystemCapability.Ability.AbilityRuntime.Core + +**参数:** + +| 参数名 | 类型 | 必填 | 说明 | +| -------- | -------------------------------------- | ---- | ------------------ | +| want | [Want](js-apis-featureAbility.md#Want) | 是 | 启动Ability参数 | +| callback | AsyncCallback\ | 是 | 表示指定的回调方法 | + +**示例:** + +```js +var abilityDelegator; +var want = { + bundleName: "bundleName", + abilityName: "abilityName" +}; + +abilityDelegator = AbilityDelegatorRegistry.getAbilityDelegator(); +abilityDelegator.startAbility(want, (err, data) => { + console.info("startAbility callback"); +}); +``` + + + +### startAbility + +startAbility(want: Want): Promise\ + +启动指定ability(promise形式) + +**系统能力:** SystemCapability.Ability.AbilityRuntime.Core + +**参数:** + +| 参数名 | 类型 | 必填 | 说明 | +| ------ | -------------------------------------- | ---- | --------------- | +| want | [Want](js-apis-featureAbility.md#Want) | 是 | 启动Ability参数 | + +**返回值:** + +| 类型 | 说明 | +| -------------- | ------------------- | +| Promise\ | 以Promise形式返回。 | + +**示例:** + +```js +var abilityDelegator; +var want = { + bundleName: "bundleName", + abilityName: "abilityName" +}; + +abilityDelegator = AbilityDelegatorRegistry.getAbilityDelegator(); +abilityDelegator.startAbility(want).then((data) => { + console.info("startAbility promise"); +}); +``` + + + +### doAbilityForeground9+ + +doAbilityForeground(ability: Ability, callback: AsyncCallback\): void + +调度指定ability生命周期状态到Foreground状态(callback形式) + +**系统能力:** SystemCapability.Ability.AbilityRuntime.Core + +**参数:** + +| 参数名 | 类型 | 必填 | 说明 | +| -------- | ----------------------- | ---- | ------------------------------------------------------- | +| ability | Ability | 是 | 指定Ability对象 | +| callback | AsyncCallback\ | 是 | 表示指定的回调方法
\- true:成功
\- false:失败 | + +**示例:** + +```js +var abilityDelegator; +var ability; + +abilityDelegator = AbilityDelegatorRegistry.getAbilityDelegator(); +abilityDelegator.getCurrentTopAbility((err, data) => { + console.info("getCurrentTopAbility callback"); + ability = data; + abilityDelegator.doAbilityForeground(ability, (err, data) => { + console.info("doAbilityForeground callback"); + }); +}); +``` + + + +### doAbilityForeground9+ + +doAbilityForeground(ability: Ability): Promise\ + +调度指定ability生命周期状态到Foreground状态(promise形式) + +**系统能力:** SystemCapability.Ability.AbilityRuntime.Core + +**参数:** + +| 参数名 | 类型 | 必填 | 说明 | +| ------- | ------- | ---- | --------------- | +| ability | Ability | 是 | 指定Ability对象 | + +**返回值:** + +| 类型 | 说明 | +| ----------------- | ------------------------------------------------------------ | +| Promise\ | 以Promise形式返回执行结果。
\- true:成功
\- false:失败 | + +**示例:** + +```js +var abilityDelegator; +var ability; + +abilityDelegator = AbilityDelegatorRegistry.getAbilityDelegator(); +abilityDelegator.getCurrentTopAbility((err, data) => { + console.info("getCurrentTopAbility callback"); + ability = data; + abilityDelegator.doAbilityForeground(ability).then((data) => { + console.info("doAbilityForeground promise"); + }); +}); +``` + + + +### doAbilityBackground9+ + +doAbilityBackground(ability: Ability, callback: AsyncCallback\): void + +调度指定ability生命周期状态到Background状态(callback形式) + +**系统能力:** SystemCapability.Ability.AbilityRuntime.Core + +**参数:** + +| 参数名 | 类型 | 必填 | 说明 | +| -------- | ----------------------- | ---- | ------------------------------------------------------- | +| ability | Ability | 是 | 指定Ability对象 | +| callback | AsyncCallback\ | 是 | 表示指定的回调方法
\- true:成功
\- false:失败 | + +**示例:** + +```js +var abilityDelegator; +var ability; + +abilityDelegator = AbilityDelegatorRegistry.getAbilityDelegator(); +abilityDelegator.getCurrentTopAbility((err, data) => { + console.info("getCurrentTopAbility callback"); + ability = data; + abilityDelegator.doAbilityBackground(ability, (err, data) => { + console.info("doAbilityBackground callback"); + }); +}); +``` + + + +### doAbilityBackground9+ + +doAbilityBackground(ability: Ability): Promise\ + +调度指定ability生命周期状态到Background状态(promise形式) + +**系统能力:** SystemCapability.Ability.AbilityRuntime.Core + +**参数:** + +| 参数名 | 类型 | 必填 | 说明 | +| ------- | ------- | ---- | --------------- | +| ability | Ability | 是 | 指定Ability对象 | + +**返回值:** + +| 类型 | 说明 | +| ----------------- | ------------------------------------------------------------ | +| Promise\ | 以Promise形式返回执行结果。
\- true:成功
\- false:失败 | + +**示例:** + +```js +var abilityDelegator; +var ability; + +abilityDelegator = AbilityDelegatorRegistry.getAbilityDelegator(); +abilityDelegator.getCurrentTopAbility((err, data) => { + console.info("getCurrentTopAbility callback"); + ability = data; + abilityDelegator.doAbilityBackground(ability).then((data) => { + console.info("doAbilityBackground promise"); + }); +}); +``` + + + +### print + +print(msg: string, callback: AsyncCallback\): void + +打印日志信息到单元测试终端控制台(callback形式) + +**系统能力:** SystemCapability.Ability.AbilityRuntime.Core + +**参数:** + +| 参数名 | 类型 | 必填 | 说明 | +| -------- | -------------------- | ---- | ------------------ | +| msg | string | 是 | 日志字符串 | +| callback | AsyncCallback\ | 是 | 表示指定的回调方法 | + +**示例:** + +```js +var abilityDelegator; +var msg = "msg"; + +abilityDelegator = AbilityDelegatorRegistry.getAbilityDelegator(); +abilityDelegator.print(msg, (err) => { + console.info("print callback"); +}); +``` + + + +### print + +print(msg: string): Promise\ + +打印日志信息到单元测试终端控制台(promise形式) + +**系统能力:** SystemCapability.Ability.AbilityRuntime.Core + +**参数:** + +| 参数名 | 类型 | 必填 | 说明 | +| ------ | ------ | ---- | ---------- | +| msg | string | 是 | 日志字符串 | + +**返回值:** + +| 类型 | 说明 | +| -------------- | ------------------- | +| Promise\ | 以Promise形式返回。 | + +**示例:** + +```js +var abilityDelegator; +var msg = "msg"; + +abilityDelegator = AbilityDelegatorRegistry.getAbilityDelegator(); +abilityDelegator.print(msg).then(() => { + console.info("print promise"); +}); +``` + + + +### executeShellCommand + +executeShellCommand(cmd: string, callback: AsyncCallback\): void + +执行指定的shell命令(callback形式) + +**系统能力:** SystemCapability.Ability.AbilityRuntime.Core + +**参数:** + +| 参数名 | 类型 | 必填 | 说明 | +| -------- | ------------------------------------------------------------ | ---- | ------------------ | +| cmd | string | 是 | shell命令字符串 | +| callback | AsyncCallback\<[ShellCmdResult](js-apis-application-shellCmdResult.md#ShellCmdResult)> | 是 | 表示指定的回调方法 | + +**示例:** + +```js +var abilityDelegator; +var cmd = "cmd"; + +abilityDelegator = AbilityDelegatorRegistry.getAbilityDelegator(); +abilityDelegator.executeShellCommand(cmd, (err,data) => { + console.info("executeShellCommand callback"); +}); +``` + + + +### executeShellCommand + +executeShellCommand(cmd: string, timeoutSecs: number, callback: AsyncCallback\): void + +执行指定的shell命令(callback形式) + +**系统能力:** SystemCapability.Ability.AbilityRuntime.Core + +**参数:** + +| 参数名 | 类型 | 必填 | 说明 | +| ----------- | ------------------------------------------------------------ | ---- | ------------------ | +| cmd | string | 是 | shell命令字符串 | +| timeoutSecs | number | 是 | 设定时间,单位秒 | +| callback | AsyncCallback\<[ShellCmdResult](js-apis-application-shellCmdResult.md#ShellCmdResult)> | 是 | 表示指定的回调方法 | + +**示例:** + +```js +var abilityDelegator; +var cmd = "cmd"; +var timeout = 100; + +abilityDelegator = AbilityDelegatorRegistry.getAbilityDelegator(); +abilityDelegator.executeShellCommand(cmd, timeout, (err,data) => { + console.info("executeShellCommand callback"); +}); +``` + + + +### executeShellCommand + +executeShellCommand(cmd: string, timeoutSecs: number): Promise\ + +执行指定的shell命令(promise形式) + +**系统能力:** SystemCapability.Ability.AbilityRuntime.Core + +**参数:** + +| 参数名 | 类型 | 必填 | 说明 | +| ----------- | ------ | ---- | ---------------- | +| cmd | string | 是 | shell命令字符串 | +| timeoutSecs | number | 否 | 设定时间,单位秒 | + +**返回值:** + +| 类型 | 说明 | +| ------------------------------------------------------------ | ------------------------------------------------------------ | +| Promise\<[ShellCmdResult](js-apis-application-shellCmdResult.md#ShellCmdResult)> | 以Promise形式返回Shell命令执行结果[ShellCmdResult](js-apis-application-shellCmdResult.md#ShellCmdResult)对象。 | + +**示例:** + +```js +var abilityDelegator; +var cmd = "cmd"; +var timeout = 100; + +abilityDelegator = AbilityDelegatorRegistry.getAbilityDelegator(); +abilityDelegator.executeShellCommand(cmd, timeout).then((data) => { + console.info("executeShellCommand promise"); +}); +``` diff --git a/zh-cn/application-dev/reference/apis/js-apis-application-abilityDelegatorArgs.md b/zh-cn/application-dev/reference/apis/js-apis-application-abilityDelegatorArgs.md new file mode 100644 index 0000000000000000000000000000000000000000..ca566e75370ee5b504d8902555b78f8d32cfe73d --- /dev/null +++ b/zh-cn/application-dev/reference/apis/js-apis-application-abilityDelegatorArgs.md @@ -0,0 +1,26 @@ +# AbilityDelegatorArgs + +> **说明** +> +> 本模块首批接口从API version 8开始支持。后续版本的新增接口,采用上角标单独标记接口的起始版本。 + +## 导入模块 + +```js +import { AbilityDelegatorArgs } from './application/abilityDelegatorArgs'; +``` + + + +## AbilityDelegatorArgs + +测试参数信息 + +| 名称 | 类型 | 可读 | 可写 | 说明 | +| ------------------- | ---------------------- | ---- | ---- | ------------------------------------------------------------ | +| bundleName | string | 是 | 是 | 当前被测试应用的包名
**系统能力:** SystemCapability.Ability.AbilityRuntime.Core | +| parameters | {[key:string]: string} | 是 | 是 | 当前启动单元测试的参数
**系统能力:** SystemCapability.Ability.AbilityRuntime.Core | +| testCaseNames | string | 是 | 是 | 测试用例名称
**系统能力:** SystemCapability.Ability.AbilityRuntime.Core | +| testRunnerClassName | string | 是 | 是 | 执行测试用例的测试执行器的名称
**系统能力:** SystemCapability.Ability.AbilityRuntime.Core | + + diff --git a/zh-cn/application-dev/reference/apis/js-apis-application-abilityMonitor.md b/zh-cn/application-dev/reference/apis/js-apis-application-abilityMonitor.md new file mode 100644 index 0000000000000000000000000000000000000000..835aad30c8260e2cd9f99c3002072dd57130db4e --- /dev/null +++ b/zh-cn/application-dev/reference/apis/js-apis-application-abilityMonitor.md @@ -0,0 +1,30 @@ +# AbilityMonitor + +> **说明** +> +> 本模块首批接口从API version 9开始支持。后续版本的新增接口,采用上角标单独标记接口的起始版本。 + +## 导入模块 + +```js +import { AbilityMonitor } from './abilityMonitor'; +``` + + + +## AbilityMonitor + +Ability监听器 + +| 名称 | 类型 | 可读 | 可写 | 说明 | +| -------------------- | -------- | ---- | ---- | ------------------------------------------------------------ | +| abilityName | string | 是 | 是 | 当前AbilityMonitor绑定的ability名称
**系统能力:** SystemCapability.Ability.AbilityRuntime.Core | +| onAbilityCreate | function | 是 | 是 | ability被启动初始化时的回调函数
不设置该属性则不能收到该生命周期回调
**系统能力:** SystemCapability.Ability.AbilityRuntime.Core | +| onAbilityForeground | function | 是 | 是 | ability状态变成前台时的回调函数
不设置该属性则不能收到该生命周期回调
**系统能力:** SystemCapability.Ability.AbilityRuntime.Core | +| onAbilityBackground | function | 是 | 是 | ability状态变成后台时的回调函数
不设置该属性则不能收到该生命周期回调
**系统能力:** SystemCapability.Ability.AbilityRuntime.Core | +| onAbilityDestroy | function | 是 | 是 | ability被销毁前的回调函数
不设置该属性则不能收到该生命周期回调
**系统能力:** SystemCapability.Ability.AbilityRuntime.Core | +| onWindowStageCreate | function | 是 | 是 | window stage被创建时的回调函数
不设置该属性则不能收到该生命周期回调
**系统能力:** SystemCapability.Ability.AbilityRuntime.Core | +| onWindowStageRestore | function | 是 | 是 | window stage被重载时的回调函数
不设置该属性则不能收到该生命周期回调
**系统能力:** SystemCapability.Ability.AbilityRuntime.Core | +| onWindowStageDestroy | function | 是 | 是 | window stage被销毁前的回调函数
不设置该属性则不能收到该生命周期回调
**系统能力:** SystemCapability.Ability.AbilityRuntime.Core | + + diff --git a/zh-cn/application-dev/reference/apis/js-apis-application-shellCmdResult.md b/zh-cn/application-dev/reference/apis/js-apis-application-shellCmdResult.md new file mode 100644 index 0000000000000000000000000000000000000000..bfbcf389db0c2a70dfa1c240e5a0ac27fad88481 --- /dev/null +++ b/zh-cn/application-dev/reference/apis/js-apis-application-shellCmdResult.md @@ -0,0 +1,22 @@ +# ShellCmdResult + +> **说明** +> +> 本模块首批接口从API version 8开始支持。后续版本的新增接口,采用上角标单独标记接口的起始版本。 + +## 导入模块 + +```js +import { ShellCmdResult } from './shellCmdResult'; +``` + + + +## ShellCmdResult + +Shell命令执行结果 + +| 名称 | 类型 | 可读 | 可写 | 说明 | +| --------- | ------ | ---- | ---- | ------------------------------------------------------------ | +| stdResult | string | 是 | 是 | 标准输出内容
**系统能力:** SystemCapability.Ability.AbilityRuntime.Core | +| exitCode | number | 是 | 是 | 结果码
**系统能力:** SystemCapability.Ability.AbilityRuntime.Core | diff --git a/zh-cn/application-dev/reference/apis/js-apis-testRunner.md b/zh-cn/application-dev/reference/apis/js-apis-testRunner.md new file mode 100644 index 0000000000000000000000000000000000000000..69d652330c2b1eac2d37cbdff12c978796c7e553 --- /dev/null +++ b/zh-cn/application-dev/reference/apis/js-apis-testRunner.md @@ -0,0 +1,51 @@ +# TestRunner + +> **说明** +> +> 本模块首批接口从API version 8开始支持。后续版本的新增接口,采用上角标单独标记接口的起始版本。 + +## 导入模块 + +```js +import TestRunner from '@ohos.application.testRunner' +``` + + + +## TestRunner.onPrepare + +onPrepare(): void + +为运行测试用例准备单元测试环境 + +**系统能力:** SystemCapability.Ability.AbilityRuntime.Core + +**示例:** + +```js +export default class UserTestRunner extends TestRunner { + onPrepare() { + console.log("Trigger onPrepare") + } +}; +``` + + + +## TestRunner.onRun + +onRun(): void + +运行测试用例 + +**系统能力:** SystemCapability.Ability.AbilityRuntime.Core + +**示例:** + +```js +export default class UserTestRunner extends TestRunner { + onRun() { + console.log("Trigger onRun") + } +}; +```