提交 e026071c 编写于 作者: R ry

modify uitest api

Signed-off-by: Nry <ry.renyi@huawei.com>
上级 76f05b9e
......@@ -8,9 +8,9 @@ UiTest提供模拟UI操作的能力,供开发者在测试场景使用,主要
- [Component<sup>9+</sup>](#component9):代表UI界面上的指定控件,提供控件属性获取,控件点击,滑动查找,文本注入等能力。
- [Driver<sup>9+</sup>](#driver9):入口类,提供控件匹配/查找,按键注入,坐标点击/滑动,截图等能力。
- [UiWindow<sup>9+</sup>](#uiwindow9):入口类,提供窗口属性获取,窗口拖动、调整窗口大小等能力。
- [By<sup>(deprecated)</sup>](#bydeprecated):提供控件特征描述能力,用于控件筛选匹配查找。从API version9开始不再维护,建议使用[On<sup>9+</sup>](#on9)
- [UiComponent<sup>(deprecated)</sup>](#uicomponentdeprecated):代表UI界面上的指定控件,提供控件属性获取,控件点击,滑动查找,文本注入等能力。从API version9开始不再维护,建议使用[Component<sup>9+</sup>](#component9)
- [UiDriver<sup>(deprecated)</sup>](#uidriverdeprecated):入口类,提供控件匹配/查找,按键注入,坐标点击/滑动,截图等能力。从API version9开始不再维护,建议使用[Driver<sup>9+</sup>](#driver9)
- [By<sup>(deprecated)</sup>](#bydeprecated):提供控件特征描述能力,用于控件筛选匹配查找。从API version 9开始不再维护,建议使用[On<sup>9+</sup>](#on9)
- [UiComponent<sup>(deprecated)</sup>](#uicomponentdeprecated):代表UI界面上的指定控件,提供控件属性获取,控件点击,滑动查找,文本注入等能力。从API version 9开始不再维护,建议使用[Component<sup>9+</sup>](#component9)
- [UiDriver<sup>(deprecated)</sup>](#uidriverdeprecated):入口类,提供控件匹配/查找,按键注入,坐标点击/滑动,截图等能力。从API version 9开始不再维护,建议使用[Driver<sup>9+</sup>](#driver9)
>**说明:**
>
......@@ -118,7 +118,7 @@ import {UiComponent, UiDriver, Component, Driver, UiWindow, ON, BY, MatchPattern
## On<sup>9+</sup>
UiTest框架在API9中,通过On类提供了丰富的控件特征描述API,用于进行控件筛选来匹配/查找出目标控件。<br>
UiTest框架在API 9中,通过On类提供了丰富的控件特征描述API,用于进行控件筛选来匹配/查找出目标控件。<br>
On提供的API能力具有以下几个特点:<br>1、支持单属性匹配和多属性组合匹配,例如同时指定目标控件text和id。<br>2、控件属性支持多种匹配模式。<br>3、支持控件绝对定位,相对定位,可通过[ON.isBefore](#isbefore)[ON.isAfter](#isafter)等API限定邻近控件特征进行辅助定位。<br>On类提供的所有API均为同步接口,建议使用者通过静态构造器ON来链式创建On对象。
```js
......@@ -2650,7 +2650,7 @@ async function demo() {
UiTest框架通过By类提供了丰富的控件特征描述API,用于进行控件筛选来匹配/查找出目标控件。<br>
By提供的API能力具有以下几个特点:<br>1、支持单属性匹配和多属性组合匹配,例如同时指定目标控件text和id。<br>2、控件属性支持多种匹配模式。<br>3、支持控件绝对定位,相对定位,可通过[By.isBefore<sup>(deprecated)</sup>](#isbeforedeprecated)[By.isAfter<sup>(deprecated)</sup>](#isafterdeprecated)等API限定邻近控件特征进行辅助定位。<br>By类提供的所有API均为同步接口,建议使用者通过静态构造器BY来链式创建By对象。
从API version9开始不再维护,建议使用[On<sup>9+</sup>](#on9)
从API version 9开始不再维护,建议使用[On<sup>9+</sup>](#on9)
```js
BY.text('123').type('button');
......@@ -2662,7 +2662,7 @@ text(txt: string, pattern?: MatchPattern): By
指定目标控件文本属性,支持多种匹配模式,返回By对象自身。
从API version9开始不再维护,建议使用[text<sup>9+</sup>](#text9)
从API version 9开始不再维护,建议使用[text<sup>9+</sup>](#text9)
**系统能力**:SystemCapability.Test.UiTest
......@@ -2692,7 +2692,7 @@ key(key: string): By
指定目标控件key值属性,返回By对象自身。
从API version9开始不再维护,建议使用[id<sup>9+</sup>](#id9)
从API version 9开始不再维护,建议使用[id<sup>9+</sup>](#id9)
**系统能力**:SystemCapability.Test.UiTest
......@@ -2721,7 +2721,7 @@ id(id: number): By
指定目标控件id属性,返回By对象自身。
从API version9开始废弃。
从API version 9开始废弃。
**系统能力**:SystemCapability.Test.UiTest
......@@ -2750,7 +2750,7 @@ type(tp: string): By
指定目标控件的控件类型属性,返回By对象自身。
从API version9开始不再维护,建议使用[type<sup>9+</sup>](#type9)
从API version 9开始不再维护,建议使用[type<sup>9+</sup>](#type9)
**系统能力**:SystemCapability.Test.UiTest
......@@ -2779,7 +2779,7 @@ clickable(b?: boolean): By
指定目标控件的可点击状态属性,返回By对象自身。
从API version9开始不再维护,建议使用[clickable<sup>9+</sup>](#clickable9)
从API version 9开始不再维护,建议使用[clickable<sup>9+</sup>](#clickable9)
**系统能力**:SystemCapability.Test.UiTest
......@@ -2808,7 +2808,7 @@ scrollable(b?: boolean): By
指定目标控件的可滑动状态属性,返回By对象自身。
从API version9开始不再维护,建议使用[scrollable<sup>9+</sup>](#scrollable9)
从API version 9开始不再维护,建议使用[scrollable<sup>9+</sup>](#scrollable9)
**系统能力**:SystemCapability.Test.UiTest
......@@ -2836,7 +2836,7 @@ enabled(b?: boolean): By
指定目标控件的使能状态属性,返回By对象自身。
从API version9开始不再维护,建议使用[enabled<sup>9+</sup>](#enabled9)
从API version 9开始不再维护,建议使用[enabled<sup>9+</sup>](#enabled9)
**系统能力**:SystemCapability.Test.UiTest
......@@ -2864,7 +2864,7 @@ focused(b?: boolean): By
指定目标控件的获焦状态属性,返回By对象自身。
从API version9开始不再维护,建议使用[focused<sup>9+</sup>](#focused9)
从API version 9开始不再维护,建议使用[focused<sup>9+</sup>](#focused9)
**系统能力**:SystemCapability.Test.UiTest
......@@ -2892,7 +2892,7 @@ selected(b?: boolean): By
指定目标控件的被选中状态属性,返回By对象自身。
从API version9开始不再维护,建议使用[selected<sup>9+</sup>](#selected9)
从API version 9开始不再维护,建议使用[selected<sup>9+</sup>](#selected9)
**系统能力**:SystemCapability.Test.UiTest
......@@ -2920,7 +2920,7 @@ isBefore(by: By): By
指定目标控件位于给出的特征属性控件之前,返回By对象自身。
从API version9开始不再维护,建议使用[isBefore<sup>9+</sup>](#isbefore9)
从API version 9开始不再维护,建议使用[isBefore<sup>9+</sup>](#isbefore9)
**系统能力**:SystemCapability.Test.UiTest
......@@ -2948,7 +2948,7 @@ isAfter(by: By): By
指定目标控件位于给出的特征属性控件之后,返回By对象自身。
从API version9开始不再维护,建议使用[isAfter<sup>9+</sup>](#isafter9)
从API version 9开始不再维护,建议使用[isAfter<sup>9+</sup>](#isafter9)
**系统能力**:SystemCapability.Test.UiTest
......@@ -2975,7 +2975,7 @@ let by = BY.isAfter(BY.text('123')); // 使用静态构造器BY创建by对象,
UiTest中,UiComponent类代表了UI界面上的一个控件,提供控件属性获取,控件点击,滑动查找,文本注入等API。
该类提供的所有方法都使用Promise方式作为异步方法,需使用await调用。
从API version9开始不再维护,建议使用[Component<sup>9+</sup>](#component9)
从API version 9开始不再维护,建议使用[Component<sup>9+</sup>](#component9)
### click<sup>(deprecated)</sup>
......@@ -2983,7 +2983,7 @@ click(): Promise\<void>
控件对象进行点击操作。
从API version9开始不再维护,建议使用[click<sup>9+</sup>](#click9)
从API version 9开始不再维护,建议使用[click<sup>9+</sup>](#click9)
**系统能力**:SystemCapability.Test.UiTest
......@@ -3003,7 +3003,7 @@ doubleClick(): Promise\<void>
控件对象进行双击操作。
从API version9开始不再维护,建议使用[doubleClick<sup>9+</sup>](#doubleclick9)
从API version 9开始不再维护,建议使用[doubleClick<sup>9+</sup>](#doubleclick9)
**系统能力**:SystemCapability.Test.UiTest
......@@ -3023,7 +3023,7 @@ longClick(): Promise\<void>
控件对象进行长按操作。
从API version9开始不再维护,建议使用[longClick<sup>9+</sup>](#longclick9)
从API version 9开始不再维护,建议使用[longClick<sup>9+</sup>](#longclick9)
**系统能力**:SystemCapability.Test.UiTest
......@@ -3043,7 +3043,7 @@ getId(): Promise\<number>
获取控件对象的id值。
从API version9开始不再维护,被废弃。
从API version 9开始不再维护,被废弃。
**系统能力**:SystemCapability.Test.UiTest
......@@ -3069,7 +3069,7 @@ getKey(): Promise\<string>
获取控件对象的key值。
从API version9开始不再维护,建议使用[getId<sup>9+</sup>](#getid9)
从API version 9开始不再维护,建议使用[getId<sup>9+</sup>](#getid9)
**系统能力**:SystemCapability.Test.UiTest
......@@ -3095,7 +3095,7 @@ getText(): Promise\<string>
获取控件对象的文本信息。
从API version9开始不再维护,建议使用[getText<sup>9+</sup>](#gettext9)
从API version 9开始不再维护,建议使用[getText<sup>9+</sup>](#gettext9)
**系统能力**:SystemCapability.Test.UiTest
......@@ -3121,7 +3121,7 @@ getType(): Promise\<string>
获取控件对象的控件类型。
从API version9开始不再维护,建议使用[getType<sup>9+</sup>](#gettype9)
从API version 9开始不再维护,建议使用[getType<sup>9+</sup>](#gettype9)
**系统能力**:SystemCapability.Test.UiTest
......@@ -3147,7 +3147,7 @@ isClickable(): Promise\<boolean>
获取控件对象可点击状态。
从API version9开始不再维护,建议使用[isClickable<sup>9+</sup>](#isclickable9)
从API version 9开始不再维护,建议使用[isClickable<sup>9+</sup>](#isclickable9)
**系统能力**:SystemCapability.Test.UiTest
......@@ -3177,7 +3177,7 @@ isScrollable(): Promise\<boolean>
获取控件对象可滑动状态。
从API version9开始不再维护,建议使用[isScrollable<sup>9+</sup>](#isscrollable9)
从API version 9开始不再维护,建议使用[isScrollable<sup>9+</sup>](#isscrollable9)
**系统能力**:SystemCapability.Test.UiTest
......@@ -3208,7 +3208,7 @@ isEnabled(): Promise\<boolean>
获取控件使能状态。
从API version9开始不再维护,建议使用[isEnabled<sup>9+</sup>](#isenabled9)
从API version 9开始不再维护,建议使用[isEnabled<sup>9+</sup>](#isenabled9)
**系统能力**:SystemCapability.Test.UiTest
......@@ -3239,7 +3239,7 @@ isFocused(): Promise\<boolean>
判断控件对象是否获焦。
从API version9开始不再维护,建议使用[isFocused<sup>9+</sup>](#isfocused9)
从API version 9开始不再维护,建议使用[isFocused<sup>9+</sup>](#isfocused9)
**系统能力**:SystemCapability.Test.UiTest
......@@ -3269,7 +3269,7 @@ isSelected(): Promise\<boolean>
获取控件对象被选中状态。
从API version9开始不再维护,建议使用[isSelected<sup>9+</sup>](#isselected9)
从API version 9开始不再维护,建议使用[isSelected<sup>9+</sup>](#isselected9)
**系统能力**:SystemCapability.Test.UiTest
......@@ -3299,7 +3299,7 @@ inputText(text: string): Promise\<void>
向控件中输入文本(适用于文本框控件)。
从API version9开始不再维护,建议使用[inputText<sup>9+</sup>](#inputtext9)
从API version 9开始不再维护,建议使用[inputText<sup>9+</sup>](#inputtext9)
**系统能力**:SystemCapability.Test.UiTest
......@@ -3325,7 +3325,7 @@ scrollSearch(by: By): Promise\<UiComponent>
在控件上滑动查找目标控件(适用于List等支持滑动的控件)。
从API version9开始不再维护,建议使用[scrollSearch<sup>9+</sup>](#scrollsearch9)
从API version 9开始不再维护,建议使用[scrollSearch<sup>9+</sup>](#scrollsearch9)
**系统能力**:SystemCapability.Test.UiTest
......@@ -3356,7 +3356,7 @@ async function demo() {
UiDriver类为uitest测试框架的总入口,提供控件匹配/查找,按键注入,坐标点击/滑动,截图等API。
该类提供的方法除UiDriver.create()以外的所有方法都使用Promise方式作为异步方法,需使用await调用。
从API version9开始不再维护,建议使用[Driver<sup>9+</sup>](#driver9)
从API version 9开始不再维护,建议使用[Driver<sup>9+</sup>](#driver9)
### create<sup>(deprecated)</sup>
......@@ -3364,7 +3364,7 @@ static create(): UiDriver
静态方法,构造一个UiDriver对象,并返回该对象。
从API version9开始不再维护,建议使用[create<sup>9+</sup>](#create9)
从API version 9开始不再维护,建议使用[create<sup>9+</sup>](#create9)
**系统能力**:SystemCapability.Test.UiTest
......@@ -3388,7 +3388,7 @@ delayMs(duration: number): Promise\<void>
UiDriver对象在给定的时间内延时。
从API version9开始不再维护,建议使用[delayMs<sup>9+</sup>](#delayms9)
从API version 9开始不再维护,建议使用[delayMs<sup>9+</sup>](#delayms9)
**系统能力**:SystemCapability.Test.UiTest
......@@ -3413,7 +3413,7 @@ findComponent(by: By): Promise\<UiComponent>
在UiDriver对象中,根据给出的目标控件属性要求查找目标控件。
从API version9开始不再维护,建议使用[findComponent<sup>9+</sup>](#findcomponent9)
从API version 9开始不再维护,建议使用[findComponent<sup>9+</sup>](#findcomponent9)
**系统能力**:SystemCapability.Test.UiTest
......@@ -3444,7 +3444,7 @@ findComponents(by: By): Promise\<Array\<UiComponent>>
在UiDriver对象中,根据给出的目标控件属性要求查找出所有匹配控件,以列表保存。
从API version9开始不再维护,建议使用[findComponents<sup>9+</sup>](#findcomponents9)
从API version 9开始不再维护,建议使用[findComponents<sup>9+</sup>](#findcomponents9)
**系统能力**:SystemCapability.Test.UiTest
......@@ -3475,7 +3475,7 @@ assertComponentExist(by: By): Promise\<void>
断言API,用于断言当前界面存在满足给出的目标控件属性的控件; 如果控件不存在,该API将抛出JS异常,使当前测试用例失败。
从API version9开始不再维护,建议使用[assertComponentExist<sup>9+</sup>](#assertcomponentexist9)
从API version 9开始不再维护,建议使用[assertComponentExist<sup>9+</sup>](#assertcomponentexist9)
**系统能力**:SystemCapability.Test.UiTest
......@@ -3500,7 +3500,7 @@ pressBack(): Promise\<void>
UiDriver对象进行点击BACK键的操作。
从API version9开始不再维护,建议使用[pressBack<sup>9+</sup>](#pressback9)
从API version 9开始不再维护,建议使用[pressBack<sup>9+</sup>](#pressback9)
**系统能力**:SystemCapability.Test.UiTest
......@@ -3519,7 +3519,7 @@ triggerKey(keyCode: number): Promise\<void>
UiDriver对象采取如下操作:通过key值找到对应键并点击。
从API version9开始不再维护,建议使用[triggerKey<sup>9+</sup>](#triggerkey9)
从API version 9开始不再维护,建议使用[triggerKey<sup>9+</sup>](#triggerkey9)
**系统能力**:SystemCapability.Test.UiTest
......@@ -3545,7 +3545,7 @@ click(x: number, y: number): Promise\<void>
UiDriver对象采取如下操作:在目标坐标点单击。
从API version9开始不再维护,建议使用[click<sup>9+</sup>](#click9)
从API version 9开始不再维护,建议使用[click<sup>9+</sup>](#click9)
**系统能力**:SystemCapability.Test.UiTest
......@@ -3571,7 +3571,7 @@ doubleClick(x: number, y: number): Promise\<void>
UiDriver对象采取如下操作:在目标坐标点双击。
从API version9开始不再维护,建议使用[doubleClick<sup>9+</sup>](#doubleclick9)
从API version 9开始不再维护,建议使用[doubleClick<sup>9+</sup>](#doubleclick9)
**系统能力**:SystemCapability.Test.UiTest
......@@ -3597,7 +3597,7 @@ longClick(x: number, y: number): Promise\<void>
UiDriver对象采取如下操作:在目标坐标点长按下鼠标左键。
从API version9开始不再维护,建议使用[longClick<sup>9+</sup>](#longclick9)
从API version 9开始不再维护,建议使用[longClick<sup>9+</sup>](#longclick9)
**系统能力**:SystemCapability.Test.UiTest
......@@ -3623,7 +3623,7 @@ swipe(startx: number, starty: number, endx: number, endy: number): Promise\<void
UiDriver对象采取如下操作:从给出的起始坐标点滑向给出的目的坐标点。
从API version9开始不再维护,建议使用[swipe<sup>9+</sup>](#swipe9)
从API version 9开始不再维护,建议使用[swipe<sup>9+</sup>](#swipe9)
**系统能力**:SystemCapability.Test.UiTest
......@@ -3651,7 +3651,7 @@ screenCap(savePath: string): Promise\<boolean>
UiDriver对象采取如下操作:捕获当前屏幕,并保存为PNG格式的图片至给出的保存路径中。
从API version9开始不再维护,建议使用[screenCap<sup>9+</sup>](#screencap9)
从API version 9开始不再维护,建议使用[screenCap<sup>9+</sup>](#screencap9)
**系统能力**:SystemCapability.Test.UiTest
......
Markdown is supported
0% .
You are about to add 0 people to the discussion. Proceed with caution.
先完成此消息的编辑!
想要评论请 注册