diff --git a/zh-cn/application-dev/reference/apis/js-apis-uitest.md b/zh-cn/application-dev/reference/apis/js-apis-uitest.md index aa35794cc466b4e592cedeaa16be6400d9caba9c..212701eefaa6fa62c51f94eb98907f158f93a9c7 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-uitest.md +++ b/zh-cn/application-dev/reference/apis/js-apis-uitest.md @@ -6,11 +6,11 @@ UiTest提供模拟UI操作的能力,供开发者在测试场景使用,主要 - [On9+](#on9):提供控件特征描述能力,用于控件筛选匹配查找。 - [Component9+](#component9):代表UI界面上的指定控件,提供控件属性获取,控件点击,滑动查找,文本注入等能力。 -- [Driver9+](#driver9):入口类,提供控件匹配/查找,按键注入,坐标点击/滑动,截图等能能力。 -- [UiWindow9+](#uiwindow9):入口类,提供窗口属性获取,窗口拖动、调整窗口大小等能能力。 -- [By](#by):提供控件特征描述能力,用于控件筛选匹配查找。从API version9开始不再维护,建议使用[[On9+](#on9)](#driver9)。 -- [UiComponent](#uicomponent):代表UI界面上的指定控件,提供控件属性获取,控件点击,滑动查找,文本注入等能力。从API version9开始不再维护,建议使用[Component9+](#component9)。 -- [UiDriver](#uidriver):入口类,提供控件匹配/查找,按键注入,坐标点击/滑动,截图等能能力。从API version9开始不再维护,建议使用[Driver9+](#driver9)。 +- [Driver9+](#driver9):入口类,提供控件匹配/查找,按键注入,坐标点击/滑动,截图等能力。 +- [UiWindow9+](#uiwindow9):入口类,提供窗口属性获取,窗口拖动、调整窗口大小等能力。 +- [By(deprecated)](#bydeprecated):提供控件特征描述能力,用于控件筛选匹配查找。从API version9开始不再维护,建议使用[On9+](#on9)。 +- [UiComponent(deprecated)](#uicomponentdeprecated):代表UI界面上的指定控件,提供控件属性获取,控件点击,滑动查找,文本注入等能力。从API version9开始不再维护,建议使用[Component9+](#component9)。 +- [UiDriver(deprecated)](#uidriverdeprecated):入口类,提供控件匹配/查找,按键注入,坐标点击/滑动,截图等能力。从API version9开始不再维护,建议使用[Driver9+](#driver9)。 >**说明:** > @@ -20,7 +20,7 @@ UiTest提供模拟UI操作的能力,供开发者在测试场景使用,主要 ## 导入模块 ```js -import {UiComponent, UiDriver, Component, Driver, UiWindow, ON, BY, MatchPattern, DisplayRotation, ResizeDirection, WindowMode, PointerMatrix} from '@ohos.uitest' +import {UiComponent, UiDriver, Component, Driver, UiWindow, ON, BY, MatchPattern, DisplayRotation, ResizeDirection, WindowMode, PointerMatrix} from '@ohos.uitest'; ``` ## MatchPattern @@ -122,7 +122,7 @@ UiTest框架在API9中,通过On类提供了丰富的控件特征描述API, On提供的API能力具有以下几个特点:
1、支持单属性匹配和多属性组合匹配,例如同时指定目标控件text和id。
2、控件属性支持多种匹配模式。
3、支持控件绝对定位,相对定位,可通过[ON.isBefore](#isbefore)和[ON.isAfter](#isafter)等API限定邻近控件特征进行辅助定位。
On类提供的所有API均为同步接口,建议使用者通过静态构造器ON来链式创建On对象。 ```js -ON.text('123').type('button') +ON.text('123').type('button'); ``` ### text9+ @@ -149,7 +149,7 @@ text(txt: string, pattern?: MatchPattern): On **示例:** ```js -let on = ON.text('123') //使用静态构造器ON创建On对象,指定目标控件的text属性。 +let on = ON.text('123'); // 使用静态构造器ON创建On对象,指定目标控件的text属性。 ``` @@ -176,7 +176,7 @@ id(id: string): On **示例:** ```js -let on = ON.id(123) //使用静态构造器ON创建On对象,指定目标控件的id属性。 +let on = ON.id('123'); // 使用静态构造器ON创建On对象,指定目标控件的id属性。 ``` @@ -203,7 +203,7 @@ type(tp: string): On **示例:** ```js -let on = ON.type('button') //使用静态构造器ON创建On对象,指定目标控件的控件类型属性。 +let on = ON.type('button'); // 使用静态构造器ON创建On对象,指定目标控件的控件类型属性。 ``` @@ -230,7 +230,7 @@ clickable(b?: boolean): On **示例:** ```js -let on = ON.clickable(true) //使用静态构造器ON创建On对象,指定目标控件的可点击状态属性。 +let on = ON.clickable(true); // 使用静态构造器ON创建On对象,指定目标控件的可点击状态属性。 ``` ### longClickable9+ @@ -256,7 +256,7 @@ longClickable(b?: boolean): On **示例:** ```js -let on = ON.longClickable(true) //使用静态构造器ON创建On对象,指定目标控件的可长按点击状态属性。 +let on = ON.longClickable(true); // 使用静态构造器ON创建On对象,指定目标控件的可长按点击状态属性。 ``` @@ -283,7 +283,7 @@ scrollable(b?: boolean): On **示例:** ```js -let on = ON.scrollable(true) //使用静态构造器ON创建On对象,指定目标控件的可滑动状态属性。 +let on = ON.scrollable(true); // 使用静态构造器ON创建On对象,指定目标控件的可滑动状态属性。 ``` ### enabled9+ @@ -309,7 +309,7 @@ enabled(b?: boolean): On **示例:** ```js -let on = ON.enabled(true) //使用静态构造器ON创建On对象,指定目标控件的使能状态属性。 +let on = ON.enabled(true); // 使用静态构造器ON创建On对象,指定目标控件的使能状态属性。 ``` ### focused9+ @@ -335,7 +335,7 @@ focused(b?: boolean): On **示例:** ```js -let on = ON.focused(true) //使用静态构造器ON创建On对象,指定目标控件的获焦状态属性。 +let on = ON.focused(true); // 使用静态构造器ON创建On对象,指定目标控件的获焦状态属性。 ``` ### selected9+ @@ -361,7 +361,7 @@ selected(b?: boolean): On **示例:** ```js -let on = ON.selected(true) //使用静态构造器ON创建On对象,指定目标控件的被选中状态属性。 +let on = ON.selected(true); // 使用静态构造器ON创建On对象,指定目标控件的被选中状态属性。 ``` ### checked9+ @@ -387,7 +387,7 @@ checked(b?: boolean): On **示例:** ```js -let on = ON.checked(true) //使用静态构造器ON创建On对象,指定目标控件的被勾选状态属性 +let on = ON.checked(true); // 使用静态构造器ON创建On对象,指定目标控件的被勾选状态属性 ``` ### checkable9+ @@ -413,7 +413,7 @@ checkable(b?: boolean): On **示例:** ```js -let on = ON.checkable(true) //使用静态构造器ON创建On对象,指定目标控件的能否被勾选状态属性。 +let on = ON.checkable(true); // 使用静态构造器ON创建On对象,指定目标控件的能否被勾选状态属性。 ``` ### isBefore9+ @@ -439,7 +439,7 @@ isBefore(on: On): On **示例:** ```js -let on = ON.isBefore(ON.text('123')) //使用静态构造器ON创建On对象,指定目标控件位于给出的特征属性控件之前。 +let on = ON.isBefore(ON.text('123')); // 使用静态构造器ON创建On对象,指定目标控件位于给出的特征属性控件之前。 ``` ### isAfter9+ @@ -465,7 +465,7 @@ isAfter(on: On): On **示例:** ```js -let on = ON.isAfter(ON.text('123')) //使用静态构造器ON创建On对象,指定目标控件位于给出的特征属性控件之后。 +let on = ON.isAfter(ON.text('123')); // 使用静态构造器ON创建On对象,指定目标控件位于给出的特征属性控件之后。 ``` ## Component9+ @@ -494,9 +494,9 @@ click(): Promise\ ```js async function demo() { - let driver = Driver.create() - let button = await driver.findComponent(ON.type('button')) - await button.click() + let driver = Driver.create(); + let button = await driver.findComponent(ON.type('button')); + await button.click(); } ``` @@ -521,9 +521,9 @@ doubleClick(): Promise\ ```js async function demo() { - let driver = Driver.create() - let button = await driver.findComponent(ON.type('button')) - await button.doubleClick() + let driver = Driver.create(); + let button = await driver.findComponent(ON.type('button')); + await button.doubleClick(); } ``` @@ -548,9 +548,9 @@ longClick(): Promise\ ```js async function demo() { - let driver = Driver.create() - let button = await driver.findComponent(ON.type('button')) - await button.longClick() + let driver = Driver.create(); + let button = await driver.findComponent(ON.type('button')); + await button.longClick(); } ``` @@ -581,9 +581,9 @@ getId(): Promise\ ```js async function demo() { - let driver = Driver.create() - let button = await driver.findComponent(ON.type('button')) - let num = await button.getId() + let driver = Driver.create(); + let button = await driver.findComponent(ON.type('button')); + let num = await button.getId(); } ``` @@ -614,9 +614,9 @@ getText(): Promise\ ```js async function demo() { - let driver = Driver.create() - let button = await driver.findComponent(ON.type('button')) - let text = await button.getText() + let driver = Driver.create(); + let button = await driver.findComponent(ON.type('button')); + let text = await button.getText(); } ``` @@ -647,9 +647,9 @@ getType(): Promise\ ```js async function demo() { - let driver = Driver.create() - let button = await driver.findComponent(ON.type('button')) - let type = await button.getType() + let driver = Driver.create(); + let button = await driver.findComponent(ON.type('button')); + let type = await button.getType(); } ``` @@ -680,9 +680,9 @@ getBounds(): Promise\ ```js async function demo() { - let driver = Driver.create() - let button = await driver.findComponent(ON.type('button')) - let rect = await button.getBounds() + let driver = Driver.create(); + let button = await driver.findComponent(ON.type('button')); + let rect = await button.getBounds(); } ``` @@ -713,9 +713,9 @@ getBoundsCenter(): Promise\ ```js async function demo() { - let driver = Driver.create() - let button = await driver.findComponent(ON.type('button')) - let point = await button.getBoundsCenter() + let driver = Driver.create(); + let button = await driver.findComponent(ON.type('button')); + let point = await button.getBoundsCenter(); } ``` @@ -746,13 +746,12 @@ isClickable(): Promise\ ```js async function demo() { - let driver = Driver.create() - let button = await driver.findComponent(ON.type('button')) + let driver = Driver.create(); + let button = await driver.findComponent(ON.type('button')); if(await button.isClickable()) { - console.info('This button can be Clicked') - } - else{ - console.info('This button can not be Clicked') + console.info('This button can be Clicked'); + } else { + console.info('This button can not be Clicked'); } } ``` @@ -784,13 +783,12 @@ isLongClickable(): Promise\ ```js async function demo() { - let driver = Driver.create() - let button = await driver.findComponent(ON.type('button')) + let driver = Driver.create(); + let button = await driver.findComponent(ON.type('button')); if(await button.isLongClickable()) { - console.info('This button can longClick') - } - else{ - console.info('This button can not longClick') + console.info('This button can longClick'); + } else { + console.info('This button can not longClick'); } } ``` @@ -822,13 +820,12 @@ isChecked(): Promise\ ```js async function demo() { - let driver = Driver.create() - let button = await driver.findComponent(ON.type('Checkbox')) + let driver = Driver.create(); + let button = await driver.findComponent(ON.type('Checkbox')); if(await checkBox.isChecked) { - console.info('This checkBox is checked') - } - else{ - console.info('This checkBox is not checked') + console.info('This checkBox is checked'); + } else { + console.info('This checkBox is not checked'); } } ``` @@ -860,13 +857,12 @@ isCheckable(): Promise\ ```js async function demo() { - let driver = Driver.create() - let button = await driver.findComponent(ON.type('Checkbox')) + let driver = Driver.create(); + let button = await driver.findComponent(ON.type('Checkbox')); if(await checkBox.isCheckable) { - console.info('This checkBox is checkable') - } - else{ - console.info('This checkBox is not checkable') + console.info('This checkBox is checkable'); + } else { + console.info('This checkBox is not checkable'); } } ``` @@ -898,13 +894,12 @@ isScrollable(): Promise\ ```js async function demo() { - let driver = Driver.create() - let button = await driver.findComponent(ON.scrollable(true)) + let driver = Driver.create(); + let button = await driver.findComponent(ON.scrollable(true)); if(await scrollBar.isScrollable()) { - console.info('This scrollBar can be operated') - } - else{ - console.info('This scrollBar can not be operated') + console.info('This scrollBar can be operated'); + } else { + console.info('This scrollBar can not be operated'); } } ``` @@ -937,13 +932,12 @@ isEnabled(): Promise\ ```js async function demo() { - let driver = Driver.create() - let button = await driver.findComponent(ON.type('button')) + let driver = Driver.create(); + let button = await driver.findComponent(ON.type('button')); if(await button.isEnabled()) { - console.info('This button can be operated') - } - else{ - console.info('This button can not be operated') + console.info('This button can be operated'); + } else { + console.info('This button can not be operated'); } } @@ -976,13 +970,12 @@ isFocused(): Promise\ ```js async function demo() { - let driver = Driver.create() - let button = await driver.findComponent(ON.type('button')) + let driver = Driver.create(); + let button = await driver.findComponent(ON.type('button')); if(await button.isFocused()) { - console.info('This button is focused') - } - else{ - console.info('This button is not focused') + console.info('This button is focused'); + } else { + console.info('This button is not focused'); } } ``` @@ -1014,13 +1007,12 @@ isSelected(): Promise\ ```js async function demo() { - let driver = Driver.create() - let button = await driver.findComponent(ON.type('button')) + let driver = Driver.create(); + let button = await driver.findComponent(ON.type('button')); if(await button.isSelected()) { - console.info('This button is selected') - } - else{ - console.info('This button is not selected') + console.info('This button is selected'); + } else { + console.info('This button is not selected'); } } ``` @@ -1052,9 +1044,9 @@ inputText(text: string): Promise\ ```js async function demo() { - let driver = Driver.create() - let button = await driver.findComponent(ON.text('hello world')) - await text.inputText('123') + let driver = Driver.create(); + let button = await driver.findComponent(ON.text('hello world')); + await text.inputText('123'); } ``` @@ -1077,9 +1069,9 @@ clearText(): Promise\ ```js async function demo() { - let driver = Driver.create() - let button = await driver.findComponent(ON.text('hello world')) - await text.clearText() + let driver = Driver.create(); + let button = await driver.findComponent(ON.text('hello world')); + await text.clearText(); } ``` @@ -1116,9 +1108,9 @@ scrollSearch(on: ON): Promise\ ```js async function demo() { - let driver = Driver.create() - let button = await driver.findComponent(ON.type('Scroll')) - let button = await scrollBar.scrollSearch(ON.text('next page')) + let driver = Driver.create(); + let button = await driver.findComponent(ON.type('Scroll')); + let button = await scrollBar.scrollSearch(ON.text('next page')); } ``` @@ -1149,9 +1141,9 @@ scrollToTop(speed?: number): Promise\ ```js async function demo() { - let driver = Driver.create() - let button = await driver.findComponent(ON.type('Scroll')) - await scrollBar.scrollToTop() + let driver = Driver.create(); + let button = await driver.findComponent(ON.type('Scroll')); + await scrollBar.scrollToTop(); } ``` @@ -1182,9 +1174,9 @@ scrollToBottom(speed?: number): Promise\ ```js async function demo() { - let driver = Driver.create() - let button = await driver.findComponent(ON.type('Scroll')) - await scrollBar.scrollToBottom() + let driver = Driver.create(); + let button = await driver.findComponent(ON.type('Scroll')); + await scrollBar.scrollToBottom(); } ``` @@ -1215,10 +1207,10 @@ dragTo(target: Component): Promise\ ```js async function demo() { - let driver = Driver.create() - let button = await driver.findComponent(ON.type('button')) - let text = await driver.findComponent(ON.text('hello world')) - await button.dragTo(text) + let driver = Driver.create(); + let button = await driver.findComponent(ON.type('button')); + let text = await driver.findComponent(ON.text('hello world')); + await button.dragTo(text); } ``` @@ -1249,9 +1241,9 @@ pinchOut(scale: number): Promise\ ```js async function demo() { - let driver = Driver.create() - let button = await driver.findComponent(ON.type('image')) - await image.pinchOut(1.5) + let driver = Driver.create(); + let button = await driver.findComponent(ON.type('image')); + await image.pinchOut(1.5); } ``` @@ -1282,9 +1274,9 @@ pinchIn(scale: number): Promise\ ```js async function demo() { - let driver = Driver.create() - let button = await driver.findComponent(ON.type('image')) - await image.pinchIn(0.5) + let driver = Driver.create(); + let button = await driver.findComponent(ON.type('image')); + await image.pinchIn(0.5); } ``` @@ -1319,7 +1311,7 @@ static create(): Driver ```js async function demo() { - let driver = Driver.create() + let driver = Driver.create(); } ``` @@ -1349,8 +1341,8 @@ Driver对象在给定的时间内延时。 ```js async function demo() { - let driver = Driver.create() - await driver.delayMs(1000) + let driver = Driver.create(); + await driver.delayMs(1000); } ``` @@ -1386,8 +1378,8 @@ findComponent(on: On): Promise\ ```js async function demo() { - let driver = Driver.create() - let button = await driver.findComponent(ON.text('next page')) + let driver = Driver.create(); + let button = await driver.findComponent(ON.text('next page')); } ``` @@ -1423,8 +1415,8 @@ findComponents(on: On): Promise\> ```js async function demo() { - let driver = Driver.create() - let buttonList = await driver.findComponents(ON.text('next page')) + let driver = Driver.create(); + let buttonList = await driver.findComponents(ON.text('next page')); } ``` @@ -1460,8 +1452,8 @@ findWindow(filter: WindowFilter): Promise\ ```js async function demo() { - let driver = Driver.create() - let window = await driver.findWindow({actived: true}) + let driver = Driver.create(); + let window = await driver.findWindow({actived: true}); } ``` @@ -1498,8 +1490,8 @@ waitForComponent(on: On, time: number): Promise\ ```js async function demo() { - let driver = Driver.create() - let button = await driver.waitForComponent(ON.text('next page'),500) + let driver = Driver.create(); + let button = await driver.waitForComponent(ON.text('next page'),500); } ``` @@ -1530,8 +1522,8 @@ assertComponentExist(on: On): Promise\ ```js async function demo() { - let driver = Driver.create() - await driver.assertComponentExist(ON.text('next page')) + let driver = Driver.create(); + await driver.assertComponentExist(ON.text('next page')); } ``` @@ -1555,8 +1547,8 @@ Driver对象进行点击BACK键的操作。 ```js async function demo() { - let driver = Driver.create() - await driver.pressBack() + let driver = Driver.create(); + await driver.pressBack(); } ``` @@ -1586,8 +1578,8 @@ Driver对象采取如下操作:传入key值实现模拟点击对应按键的 ```js async function demo() { - let driver = Driver.create() - await driver.triggerKey(123) + let driver = Driver.create(); + await driver.triggerKey(123); } ``` @@ -1619,8 +1611,8 @@ Driver对象通过给定的key值,找到对应组合键并点击。例如,Ke ```js async function demo() { - let driver = Driver.create() - await driver.triggerCombineKeys(2072, 2047, 2035) + let driver = Driver.create(); + await driver.triggerCombineKeys(2072, 2047, 2035); } ``` @@ -1652,8 +1644,8 @@ Driver对象采取如下操作:在目标坐标点单击。 ```js async function demo() { - let driver = Driver.create() - await driver.click(100,100) + let driver = Driver.create(); + await driver.click(100,100); } ``` @@ -1684,8 +1676,8 @@ Driver对象采取如下操作:在目标坐标点双击。 ```js async function demo() { - let driver = Driver.create() - await driver.doubleClick(100,100) + let driver = Driver.create(); + await driver.doubleClick(100,100); } ``` @@ -1716,8 +1708,8 @@ Driver对象采取如下操作:在目标坐标点长按。 ```js async function demo() { - let driver = Driver.create() - await driver.longClick(100,100) + let driver = Driver.create(); + await driver.longClick(100,100); } ``` @@ -1751,8 +1743,8 @@ Driver对象采取如下操作:从起始坐标点滑向目的坐标点。 ```js async function demo() { - let driver = Driver.create() - await driver.swipe(100,100,200,200,600) + let driver = Driver.create(); + await driver.swipe(100,100,200,200,600); } ``` @@ -1786,8 +1778,8 @@ Driver对象采取如下操作:从起始坐标点拖拽至目的坐标点。 ```js async function demo() { - let driver = Driver.create() - await driver.drag(100,100,200,200,600) + let driver = Driver.create(); + await driver.drag(100,100,200,200,600); } ``` @@ -1823,8 +1815,8 @@ Driver对象采取如下操作:捕获当前屏幕,并保存为PNG格式的 ```js async function demo() { - let driver = Driver.create() - await driver.screenCap('/local/tmp/') + let driver = Driver.create(); + await driver.screenCap('/local/tmp/'); } ``` @@ -1854,8 +1846,8 @@ setDisplayRotation(rotation: DisplayRotation): Promise\ ```js async function demo() { - let driver = Driver.create() - await driver.setDisplayRotation(DisplayRotation.ROTATION_180) + let driver = Driver.create(); + await driver.setDisplayRotation(DisplayRotation.ROTATION_180); } ``` @@ -1885,8 +1877,8 @@ getDisplayRotation(): Promise\ ```js async function demo() { - let driver = Driver.create() - let rotation = await driver.getDisplayRotation() + let driver = Driver.create(); + let rotation = await driver.getDisplayRotation(); } ``` @@ -1916,8 +1908,8 @@ setDisplayRotationEnabled(enabled: boolean): Promise\ ```js async function demo() { - let driver = Driver.create() - await driver.setDisplayRotationEnabled(false) + let driver = Driver.create(); + await driver.setDisplayRotationEnabled(false); } ``` @@ -1947,8 +1939,8 @@ getDisplaySize(): Promise\ ```js async function demo() { - let driver = Driver.create() - let size = await driver.getDisplaySize() + let driver = Driver.create(); + let size = await driver.getDisplaySize(); } ``` @@ -1978,8 +1970,8 @@ getDisplayDensity(): Promise\ ```js async function demo() { - let driver = Driver.create() - let density = await driver.getDisplayDensity() + let driver = Driver.create(); + let density = await driver.getDisplayDensity(); } ``` @@ -2003,8 +1995,8 @@ wakeUpDisplay(): Promise\ ```js async function demo() { - let driver = Driver.create() - await driver.wakeUpDisplay() + let driver = Driver.create(); + await driver.wakeUpDisplay(); } ``` @@ -2028,8 +2020,8 @@ pressHome(): Promise\ ```js async function demo() { - let driver = Driver.create() - await driver.pressHome() + let driver = Driver.create(); + await driver.pressHome(); } ``` @@ -2066,8 +2058,8 @@ waitForIdle(idleTime: number, timeout: number): Promise\ ```js async function demo() { - let driver = Driver.create() - let idled = await driver.waitForIdle(4000,5000) + let driver = Driver.create(); + let idled = await driver.waitForIdle(4000,5000); } ``` @@ -2100,8 +2092,8 @@ fling(from: Point, to: Point, stepLen: number, speed: number): Promise\ ```js async function demo() { - let driver = Driver.create() - await driver.fling({X: 500, Y: 480},{X: 450, Y: 480},5,600) + let driver = Driver.create(); + await driver.fling({X: 500, Y: 480},{X: 450, Y: 480},5,600); } ``` @@ -2138,14 +2130,14 @@ injectMultiPointerAction(pointers: PointerMatrix, speed?: number): Promise\ ```js async function demo() { - let driver = Driver.create() - let window = await driver.findWindow({actived: true}) - let name = await window.getBundleName() + let driver = Driver.create(); + let window = await driver.findWindow({actived: true}); + let name = await window.getBundleName(); } ``` @@ -2277,9 +2269,9 @@ getBounds(): Promise\ ```js async function demo() { - let driver = Driver.create() - let window = await driver.findWindow({actived: true}) - let rect = await window.getBounds() + let driver = Driver.create(); + let window = await driver.findWindow({actived: true}); + let rect = await window.getBounds(); } ``` @@ -2310,9 +2302,9 @@ getTitle(): Promise\ ```js async function demo() { - let driver = Driver.create() - let window = await driver.findWindow({actived: true}) - let rect = await window.getTitle() + let driver = Driver.create(); + let window = await driver.findWindow({actived: true}); + let rect = await window.getTitle(); } ``` @@ -2343,9 +2335,9 @@ getWindowMode(): Promise\ ```js async function demo() { - let driver = Driver.create() - let window = await driver.findWindow({actived: true}) - let mode = await window.getWindowMode() + let driver = Driver.create(); + let window = await driver.findWindow({actived: true}); + let mode = await window.getWindowMode(); } ``` @@ -2376,9 +2368,9 @@ isFocused(): Promise\ ```js async function demo() { - let driver = Driver.create() - let window = await driver.findWindow({actived: true}) - let focused = await window.isFocused() + let driver = Driver.create(); + let window = await driver.findWindow({actived: true}); + let focused = await window.isFocused(); } ``` @@ -2409,9 +2401,9 @@ isActived(): Promise\ ```js async function demo() { - let driver = Driver.create() - let window = await driver.findWindow({actived: true}) - let focused = await window.isActived() + let driver = Driver.create(); + let window = await driver.findWindow({actived: true}); + let focused = await window.isActived(); } ``` @@ -2436,9 +2428,9 @@ focus(): Promise\ ```js async function demo() { - let driver = Driver.create() - let window = await driver.findWindow({actived: true}) - await window.focus() + let driver = Driver.create(); + let window = await driver.findWindow({actived: true}); + await window.focus(); } ``` @@ -2471,9 +2463,9 @@ moveTo(x: number, y: number): Promise\ ```js async function demo() { - let driver = Driver.create() - let window = await driver.findWindow({actived: true}) - await window.moveTo(100, 100) + let driver = Driver.create(); + let window = await driver.findWindow({actived: true}); + await window.moveTo(100, 100); } ``` @@ -2507,9 +2499,9 @@ resize(wide: number, height: number, direction: ResizeDirection): Promise\ ```js async function demo() { - let driver = Driver.create() - let window = await driver.findWindow({actived: true}) - await window.resize(100, 100, ResizeDirection.LEFT) + let driver = Driver.create(); + let window = await driver.findWindow({actived: true}); + await window.resize(100, 100, ResizeDirection.LEFT); } ``` @@ -2535,9 +2527,9 @@ split(): Promise\ ```js async function demo() { - let driver = Driver.create() - let window = await driver.findWindow({actived: true}) - await window.split() + let driver = Driver.create(); + let window = await driver.findWindow({actived: true}); + await window.split(); } ``` @@ -2563,9 +2555,9 @@ maximize(): Promise\ ```js async function demo() { - let driver = Driver.create() - let window = await driver.findWindow({actived: true}) - await window.maximize() + let driver = Driver.create(); + let window = await driver.findWindow({actived: true}); + await window.maximize(); } ``` @@ -2591,9 +2583,9 @@ minimize(): Promise\ ```js async function demo() { - let driver = Driver.create() - let window = await driver.findWindow({actived: true}) - await window.minimize() + let driver = Driver.create(); + let window = await driver.findWindow({actived: true}); + await window.minimize(); } ``` @@ -2619,9 +2611,9 @@ resume(): Promise\ ```js async function demo() { - let driver = Driver.create() - let window = await driver.findWindow({actived: true}) - await window.resume() + let driver = Driver.create(); + let window = await driver.findWindow({actived: true}); + await window.resume(); } ``` @@ -2647,21 +2639,21 @@ close(): Promise\ ```js async function demo() { - let driver = Driver.create() - let window = await driver.findWindow({actived: true}) - await window.close() + let driver = Driver.create(); + let window = await driver.findWindow({actived: true}); + await window.close(); } ``` ## By(deprecated) UiTest框架通过By类提供了丰富的控件特征描述API,用于进行控件筛选来匹配/查找出目标控件。
-By提供的API能力具有以下几个特点:
1、支持单属性匹配和多属性组合匹配,例如同时指定目标控件text和id。
2、控件属性支持多种匹配模式。
3、支持控件绝对定位,相对定位,可通过[By.isBefore](#isbefore)和[By.isAfter](#isafter)等API限定邻近控件特征进行辅助定位。
By类提供的所有API均为同步接口,建议使用者通过静态构造器BY来链式创建By对象。 +By提供的API能力具有以下几个特点:
1、支持单属性匹配和多属性组合匹配,例如同时指定目标控件text和id。
2、控件属性支持多种匹配模式。
3、支持控件绝对定位,相对定位,可通过[By.isBefore(deprecated)](#isbeforedeprecated)和[By.isAfter(deprecated)](#isafterdeprecated)等API限定邻近控件特征进行辅助定位。
By类提供的所有API均为同步接口,建议使用者通过静态构造器BY来链式创建By对象。 从API version9开始不再维护,建议使用[On9+](#on9)。 ```js -BY.text('123').type('button') +BY.text('123').type('button'); ``` ### text(deprecated) @@ -2683,14 +2675,14 @@ text(txt: string, pattern?: MatchPattern): By **返回值:** -| 类型 | 说明 | -| --------- | ---------------------------------- | -| [By](#by) | 返回指定目标控件文本属性的By对象。 | +| 类型 | 说明 | +| ------------------- | ---------------------------------- | +| [By(deprecated)](#bydeprecated) | 返回指定目标控件文本属性的By对象。 | **示例:** ```js -let by = BY.text('123') //使用静态构造器BY创建by对象,指定目标控件的text属性。 +let by = BY.text('123'); // 使用静态构造器BY创建by对象,指定目标控件的text属性。 ``` @@ -2712,14 +2704,14 @@ key(key: string): By **返回值:** -| 类型 | 说明 | -| --------- | ----------------------------------- | -| [By](#by) | 返回指定目标控件key值属性的By对象。 | +| 类型 | 说明 | +| ------------------- | ----------------------------------- | +| [By(deprecated)](#bydeprecated) | 返回指定目标控件key值属性的By对象。 | **示例:** ```js -let by = BY.key('123') //使用静态构造器BY创建by对象,指定目标控件的key值属性。 +let by = BY.key('123'); // 使用静态构造器BY创建by对象,指定目标控件的key值属性。 ``` @@ -2741,14 +2733,14 @@ id(id: number): By **返回值:** -| 类型 | 说明 | -| --------- | -------------------------------- | -| [By](#by) | 返回指定目标控件id属性的By对象。 | +| 类型 | 说明 | +| ------------------- | -------------------------------- | +| [By(deprecated)](#bydeprecated) | 返回指定目标控件id属性的By对象。 | **示例:** ```js -let by = BY.id(123) //使用静态构造器BY创建by对象,指定目标控件的id属性。 +let by = BY.id(123); // 使用静态构造器BY创建by对象,指定目标控件的id属性。 ``` @@ -2770,14 +2762,14 @@ type(tp: string): By **返回值:** -| 类型 | 说明 | -| --------- | ---------------------------------------- | -| [By](#by) | 返回指定目标控件的控件类型属性的By对象。 | +| 类型 | 说明 | +| ------------------- | ---------------------------------------- | +| [By(deprecated)](#bydeprecated) | 返回指定目标控件的控件类型属性的By对象。 | **示例:** ```js -let by = BY.type('button') //使用静态构造器BY创建by对象,指定目标控件的控件类型属性。 +let by = BY.type('button'); // 使用静态构造器BY创建by对象,指定目标控件的控件类型属性。 ``` @@ -2799,14 +2791,14 @@ clickable(b?: boolean): By **返回值:** -| 类型 | 说明 | -| --------- | ------------------------------------------ | -| [By](#by) | 返回指定目标控件的可点击状态属性的By对象。 | +| 类型 | 说明 | +| ------------------- | ------------------------------------------ | +| [By(deprecated)](#bydeprecated) | 返回指定目标控件的可点击状态属性的By对象。 | **示例:** ```js -let by = BY.clickable(true) //使用静态构造器BY创建by对象,指定目标控件的可点击状态属性。 +let by = BY.clickable(true); // 使用静态构造器BY创建by对象,指定目标控件的可点击状态属性。 ``` @@ -2828,14 +2820,14 @@ scrollable(b?: boolean): By **返回值:** -| 类型 | 说明 | -| --------- | ------------------------------------------ | -| [By](#by) | 返回指定目标控件的可滑动状态属性的By对象。 | +| 类型 | 说明 | +| ------------------- | ------------------------------------------ | +| [By(deprecated)](#bydeprecated) | 返回指定目标控件的可滑动状态属性的By对象。 | **示例:** ```js -let by = BY.scrollable(true) //使用静态构造器BY创建by对象,指定目标控件的可滑动状态属性。 +let by = BY.scrollable(true); // 使用静态构造器BY创建by对象,指定目标控件的可滑动状态属性。 ``` ### enabled(deprecated) @@ -2856,14 +2848,14 @@ enabled(b?: boolean): By **返回值:** -| 类型 | 说明 | -| --------- | ---------------------------------------- | -| [By](#by) | 返回指定目标控件的使能状态属性的By对象。 | +| 类型 | 说明 | +| ------------------- | ---------------------------------------- | +| [By(deprecated)](#bydeprecated) | 返回指定目标控件的使能状态属性的By对象。 | **示例:** ```js -let by = BY.enabled(true) //使用静态构造器BY创建by对象,指定目标控件的使能状态属性。 +let by = BY.enabled(true); // 使用静态构造器BY创建by对象,指定目标控件的使能状态属性。 ``` ### focused(deprecated) @@ -2884,14 +2876,14 @@ focused(b?: boolean): By **返回值:** -| 类型 | 说明 | -| --------- | ---------------------------------------- | -| [By](#by) | 返回指定目标控件的获焦状态属性的By对象。 | +| 类型 | 说明 | +| ------------------- | ---------------------------------------- | +| [By(deprecated)](#bydeprecated) | 返回指定目标控件的获焦状态属性的By对象。 | **示例:** ```js -let by = BY.focused(true) //使用静态构造器BY创建by对象,指定目标控件的获焦状态属性。 +let by = BY.focused(true); // 使用静态构造器BY创建by对象,指定目标控件的获焦状态属性。 ``` ### selected(deprecated) @@ -2912,14 +2904,14 @@ selected(b?: boolean): By **返回值:** -| 类型 | 说明 | -| --------- | ------------------------------------------ | -| [By](#by) | 返回指定目标控件的被选中状态属性的By对象。 | +| 类型 | 说明 | +| ------------------- | ------------------------------------------ | +| [By(deprecated)](#bydeprecated) | 返回指定目标控件的被选中状态属性的By对象。 | **示例:** ```js -let by = BY.selected(true) //使用静态构造器BY创建by对象,指定目标控件的被选中状态属性。 +let by = BY.selected(true); // 使用静态构造器BY创建by对象,指定目标控件的被选中状态属性。 ``` ### isBefore(deprecated) @@ -2934,20 +2926,20 @@ isBefore(by: By): By **参数:** -| 参数名 | 类型 | 必填 | 说明 | -| ------ | --------- | ---- | ---------------- | -| by | [By](#by) | 是 | 特征控件的属性。 | +| 参数名 | 类型 | 必填 | 说明 | +| ------ | ------------------- | ---- | ---------------- | +| by | [By(deprecated)](#bydeprecated) | 是 | 特征控件的属性。 | **返回值:** -| 类型 | 说明 | -| --------- | ---------------------------------------------------- | -| [By](#by) | 返回指定目标控件位于给出的特征属性控件之前的By对象。 | +| 类型 | 说明 | +| ------------------- | ---------------------------------------------------- | +| [By(deprecated)](#bydeprecated) | 返回指定目标控件位于给出的特征属性控件之前的By对象。 | **示例:** ```js -let by = BY.isBefore(BY.text('123')) //使用静态构造器BY创建by对象,指定目标控件位于给出的特征属性控件之前。 +let by = BY.isBefore(BY.text('123')); // 使用静态构造器BY创建by对象,指定目标控件位于给出的特征属性控件之前。 ``` ### isAfter(deprecated) @@ -2962,20 +2954,20 @@ isAfter(by: By): By **参数:** -| 参数名 | 类型 | 必填 | 说明 | -| ------ | --------- | ---- | ---------------- | -| by | [By](#by) | 是 | 特征控件的属性。 | +| 参数名 | 类型 | 必填 | 说明 | +| ------ | ------------------- | ---- | ---------------- | +| by | [By(deprecated)](#bydeprecated) | 是 | 特征控件的属性。 | **返回值:** -| 类型 | 说明 | -| --------- | ---------------------------------------------------- | -| [By](#by) | 返回指定目标控件位于给出的特征属性控件之后的By对象。 | +| 类型 | 说明 | +| ------------------- | ---------------------------------------------------- | +| [By(deprecated)](#bydeprecated) | 返回指定目标控件位于给出的特征属性控件之后的By对象。 | **示例:** ```js -let by = BY.isAfter(BY.text('123')) //使用静态构造器BY创建by对象,指定目标控件位于给出的特征属性控件之后。 +let by = BY.isAfter(BY.text('123')); // 使用静态构造器BY创建by对象,指定目标控件位于给出的特征属性控件之后。 ``` ## UiComponent(deprecated) @@ -2999,9 +2991,9 @@ click(): Promise\ ```js async function demo() { - let driver = UiDriver.create() - let button = await driver.findComponent(BY.type('button')) - await button.click() + let driver = UiDriver.create(); + let button = await driver.findComponent(BY.type('button')); + await button.click(); } ``` @@ -3019,9 +3011,9 @@ doubleClick(): Promise\ ```js async function demo() { - let driver = UiDriver.create() - let button = await driver.findComponent(BY.type('button')) - await button.doubleClick() + let driver = UiDriver.create(); + let button = await driver.findComponent(BY.type('button')); + await button.doubleClick(); } ``` @@ -3039,9 +3031,9 @@ longClick(): Promise\ ```js async function demo() { - let driver = UiDriver.create() - let button = await driver.findComponent(BY.type('button')) - await button.longClick() + let driver = UiDriver.create(); + let button = await driver.findComponent(BY.type('button')); + await button.longClick(); } ``` @@ -3065,9 +3057,9 @@ getId(): Promise\ ```js async function demo() { - let driver = UiDriver.create() - let button = await driver.findComponent(BY.type('button')) - let num = await button.getId() + let driver = UiDriver.create(); + let button = await driver.findComponent(BY.type('button')); + let num = await button.getId(); } ``` @@ -3091,9 +3083,9 @@ getKey(): Promise\ ```js async function demo() { - let driver = UiDriver.create() - let button = await driver.findComponent(BY.type('button')) - let str_key = await button.getKey() + let driver = UiDriver.create(); + let button = await driver.findComponent(BY.type('button')); + let str_key = await button.getKey(); } ``` @@ -3117,9 +3109,9 @@ getText(): Promise\ ```js async function demo() { - let driver = UiDriver.create() - let button = await driver.findComponent(BY.type('button')) - let text = await button.getText() + let driver = UiDriver.create(); + let button = await driver.findComponent(BY.type('button')); + let text = await button.getText(); } ``` @@ -3143,9 +3135,9 @@ getType(): Promise\ ```js async function demo() { - let driver = UiDriver.create() - let button = await driver.findComponent(BY.type('button')) - let type = await button.getType() + let driver = UiDriver.create(); + let button = await driver.findComponent(BY.type('button')); + let type = await button.getType(); } ``` @@ -3169,13 +3161,12 @@ isClickable(): Promise\ ```js async function demo() { - let driver = UiDriver.create() - let button = await driver.findComponent(BY.type('button')) + let driver = UiDriver.create(); + let button = await driver.findComponent(BY.type('button')); if(await button.isClickable()) { - console.info('This button can be Clicked') - } - else{ - console.info('This button can not be Clicked') + console.info('This button can be Clicked'); + } else { + console.info('This button can not be Clicked'); } } ``` @@ -3200,13 +3191,12 @@ isScrollable(): Promise\ ```js async function demo() { - let driver = UiDriver.create() - let scrollBar = await driver.findComponent(BY.scrollable(true)) + let driver = UiDriver.create(); + let scrollBar = await driver.findComponent(BY.scrollable(true)); if(await scrollBar.isScrollable()) { - console.info('This scrollBar can be operated') - } - else{ - console.info('This scrollBar can not be operated') + console.info('This scrollBar can be operated'); + } else { + console.info('This scrollBar can not be operated'); } } ``` @@ -3232,13 +3222,12 @@ isEnabled(): Promise\ ```js async function demo() { - let driver = UiDriver.create() - let button = await driver.findComponent(BY.type('button')) + let driver = UiDriver.create(); + let button = await driver.findComponent(BY.type('button')); if(await button.isEnabled()) { - console.info('This button can be operated') - } - else{ - console.info('This button can not be operated') + console.info('This button can be operated'); + } else { + console.info('This button can not be operated'); } } @@ -3264,13 +3253,12 @@ isFocused(): Promise\ ```js async function demo() { - let driver = UiDriver.create() - let button = await driver.findComponent(BY.type('button')) + let driver = UiDriver.create(); + let button = await driver.findComponent(BY.type('button')); if(await button.isFocused()) { - console.info('This button is focused') - } - else{ - console.info('This button is not focused') + console.info('This button is focused'); + } else { + console.info('This button is not focused'); } } ``` @@ -3295,13 +3283,12 @@ isSelected(): Promise\ ```js async function demo() { - let driver = UiDriver.create() - let button = await driver.findComponent(BY.type('button')) + let driver = UiDriver.create(); + let button = await driver.findComponent(BY.type('button')); if(await button.isSelected()) { - console.info('This button is selected') - } - else{ - console.info('This button is not selected') + console.info('This button is selected'); + } else { + console.info('This button is not selected'); } } ``` @@ -3326,9 +3313,9 @@ inputText(text: string): Promise\ ```js async function demo() { - let driver = UiDriver.create() - let text = await driver.findComponent(BY.text('hello world')) - await text.inputText('123') + let driver = UiDriver.create(); + let text = await driver.findComponent(BY.text('hello world')); + await text.inputText('123'); } ``` @@ -3344,23 +3331,23 @@ scrollSearch(by: By): Promise\ **参数:** -| 参数名 | 类型 | 必填 | 说明 | -| ------ | --------- | ---- | -------------------- | -| by | [By](#by) | 是 | 目标控件的属性要求。 | +| 参数名 | 类型 | 必填 | 说明 | +| ------ | ------------------- | ---- | -------------------- | +| by | [By(deprecated)](#bydeprecated) | 是 | 目标控件的属性要求。 | **返回值:** -| 类型 | 说明 | -| ------------------------------------- | ------------------------------------- | -| Promise\<[UiComponent](#uicomponent)> | 以Promise形式返回找到的目标控件对象。 | +| 类型 | 说明 | +| ------------------------------------------------------------ | ------------------------------------- | +| Promise\<[UiComponent(deprecated)](#uicomponentdeprecated)> | 以Promise形式返回找到的目标控件对象。 | **示例:** ```js async function demo() { - let driver = UiDriver.create() - let scrollBar = await driver.findComponent(BY.type('Scroll')) - let button = await scrollBar.scrollSearch(BY.text('next page')) + let driver = UiDriver.create(); + let scrollBar = await driver.findComponent(BY.type('Scroll')); + let button = await scrollBar.scrollSearch(BY.text('next page')); } ``` @@ -3391,7 +3378,7 @@ static create(): UiDriver ```js async function demo() { - let driver = UiDriver.create() + let driver = UiDriver.create(); } ``` @@ -3415,8 +3402,8 @@ UiDriver对象在给定的时间内延时。 ```js async function demo() { - let driver = UiDriver.create() - await driver.delayMs(1000) + let driver = UiDriver.create(); + await driver.delayMs(1000); } ``` @@ -3432,22 +3419,22 @@ findComponent(by: By): Promise\ **参数:** -| 参数名 | 类型 | 必填 | 说明 | -| ------ | --------- | ---- | -------------------- | -| by | [By](#by) | 是 | 目标控件的属性要求。 | +| 参数名 | 类型 | 必填 | 说明 | +| ------ | ------------------- | ---- | -------------------- | +| by | [By(deprecated)](#bydeprecated) | 是 | 目标控件的属性要求。 | **返回值:** -| 类型 | 说明 | -| ------------------------------------- | --------------------------------- | -| Promise\<[UiComponent](#uicomponent)> | 以Promise形式返回找到的控件对象。 | +| 类型 | 说明 | +| ------------------------------------------------------------ | --------------------------------- | +| Promise\<[UiComponent(deprecated)](#uicomponentdeprecated)> | 以Promise形式返回找到的控件对象。 | **示例:** ```js async function demo() { - let driver = UiDriver.create() - let button = await driver.findComponent(BY.text('next page')) + let driver = UiDriver.create(); + let button = await driver.findComponent(BY.text('next page')); } ``` @@ -3463,22 +3450,22 @@ findComponents(by: By): Promise\> **参数:** -| 参数名 | 类型 | 必填 | 说明 | -| ------ | --------- | ---- | -------------------- | -| by | [By](#by) | 是 | 目标控件的属性要求。 | +| 参数名 | 类型 | 必填 | 说明 | +| ------ | ------------------- | ---- | -------------------- | +| by | [By(deprecated)](#bydeprecated) | 是 | 目标控件的属性要求。 | **返回值:** -| 类型 | 说明 | -| --------------------------------------------- | --------------------------------------- | -| Promise\> | 以Promise形式返回找到的控件对象的列表。 | +| 类型 | 说明 | +| ------------------------------------------------------------ | --------------------------------------- | +| Promise\(deprecated)](#uicomponentdeprecated)>> | 以Promise形式返回找到的控件对象的列表。 | **示例:** ```js async function demo() { - let driver = UiDriver.create() - let buttonList = await driver.findComponents(BY.text('next page')) + let driver = UiDriver.create(); + let buttonList = await driver.findComponents(BY.text('next page')); } ``` @@ -3494,16 +3481,16 @@ assertComponentExist(by: By): Promise\ **参数:** -| 参数名 | 类型 | 必填 | 说明 | -| ------ | --------- | ---- | -------------------- | -| by | [By](#by) | 是 | 目标控件的属性要求。 | +| 参数名 | 类型 | 必填 | 说明 | +| ------ | ------------------- | ---- | -------------------- | +| by | [By(deprecated)](#bydeprecated) | 是 | 目标控件的属性要求。 | **示例:** ```js async function demo() { - let driver = UiDriver.create() - await driver.assertComponentExist(BY.text('next page')) + let driver = UiDriver.create(); + await driver.assertComponentExist(BY.text('next page')); } ``` @@ -3521,8 +3508,8 @@ UiDriver对象进行点击BACK键的操作。 ```js async function demo() { - let driver = UiDriver.create() - await driver.pressBack() + let driver = UiDriver.create(); + await driver.pressBack(); } ``` @@ -3546,8 +3533,8 @@ UiDriver对象采取如下操作:通过key值找到对应键并点击。 ```js async function demo() { - let driver = UiDriver.create() - await driver.triggerKey(123) + let driver = UiDriver.create(); + await driver.triggerKey(123); } ``` @@ -3573,8 +3560,8 @@ UiDriver对象采取如下操作:在目标坐标点单击。 ```js async function demo() { - let driver = UiDriver.create() - await driver.click(100,100) + let driver = UiDriver.create(); + await driver.click(100,100); } ``` @@ -3599,8 +3586,8 @@ UiDriver对象采取如下操作:在目标坐标点双击。 ```js async function demo() { - let driver = UiDriver.create() - await driver.doubleClick(100,100) + let driver = UiDriver.create(); + await driver.doubleClick(100,100); } ``` @@ -3625,8 +3612,8 @@ UiDriver对象采取如下操作:在目标坐标点长按下鼠标左键。 ```js async function demo() { - let driver = UiDriver.create() - await driver.longClick(100,100) + let driver = UiDriver.create(); + await driver.longClick(100,100); } ``` @@ -3653,8 +3640,8 @@ UiDriver对象采取如下操作:从给出的起始坐标点滑向给出的目 ```js async function demo() { - let driver = UiDriver.create() - await driver.swipe(100,100,200,200) + let driver = UiDriver.create(); + await driver.swipe(100,100,200,200); } ``` @@ -3684,7 +3671,7 @@ UiDriver对象采取如下操作:捕获当前屏幕,并保存为PNG格式的 ```js async function demo() { - let driver = UiDriver.create() - await driver.screenCap('/local/tmp/') + let driver = UiDriver.create(); + await driver.screenCap('/local/tmp/1.png'); } ```