导入模块

import {UiComponent, UiDriver, Component, Driver, UiWindow, ON, BY, MatchPattern, DisplayRotation, ResizeDirection, WindowMode, PointerMatrix} from '@ohos.UiTest';

MatchPattern

控件属性支持的匹配模式。

系统能力：SystemCapability.Test.UiTest

ResizeDirection9+

窗口调整大小的方向。

系统能力：SystemCapability.Test.UiTest

Point9+

坐标点信息。

系统能力：SystemCapability.Test.UiTest

Rect9+

控件的边框信息。

系统能力：SystemCapability.Test.UiTest

WindowMode9+

系统能力：SystemCapability.Test.UiTest

窗口的窗口模式。

DisplayRotation9+

系统能力：SystemCapability.Test.UiTest

设备显示器的显示方向。

WindowFilter9+

窗口的标志属性信息。

系统能力：SystemCapability.Test.UiTest

On9+

UiTest框架在API 9中，通过On类提供了丰富的控件特征描述API，用于进行控件筛选来匹配/查找出目标控件。

On提供的API能力具有以下几个特点:

1、支持单属性匹配和多属性组合匹配，例如同时指定目标控件text和id。

2、控件属性支持多种匹配模式。

3、支持控件绝对定位，相对定位，可通过ON.isBefore和ON.isAfter等API限定邻近控件特征进行辅助定位。

On类提供的所有API均为同步接口，建议使用者通过静态构造器ON来链式创建On对象。

ON.text('123').type('button');

text9+

text(txt: string, pattern?: MatchPattern): On

指定目标控件文本属性，支持多种匹配模式，返回On对象自身。

系统能力：SystemCapability.Test.UiTest

参数：

返回值：

示例：

let on = ON.text('123'); // 使用静态构造器ON创建On对象，指定目标控件的text属性。

id9+

id(id: string): On

指定目标控件id属性，返回On对象自身。

系统能力：SystemCapability.Test.UiTest

参数：

返回值：

示例：

let on = ON.id('123'); // 使用静态构造器ON创建On对象，指定目标控件的id属性。

type9+

type(tp: string): On

指定目标控件的控件类型属性，返回On对象自身。

系统能力：SystemCapability.Test.UiTest

参数：

返回值：

示例：

let on = ON.type('button'); // 使用静态构造器ON创建On对象，指定目标控件的控件类型属性。

clickable9+

clickable(b?: boolean): On

指定目标控件的可点击状态属性，返回On对象自身。

系统能力：SystemCapability.Test.UiTest

参数：

返回值：

示例：

let on = ON.clickable(true); // 使用静态构造器ON创建On对象，指定目标控件的可点击状态属性。

longClickable9+

longClickable(b?: boolean): On

指定目标控件的可长按点击状态属性，返回On对象自身。

系统能力：SystemCapability.Test.UiTest

参数：

返回值：

示例：

let on = ON.longClickable(true); // 使用静态构造器ON创建On对象，指定目标控件的可长按点击状态属性。

scrollable9+

scrollable(b?: boolean): On

指定目标控件的可滑动状态属性，返回On对象自身。

系统能力：SystemCapability.Test.UiTest

参数：

返回值：

示例：

let on = ON.scrollable(true); // 使用静态构造器ON创建On对象，指定目标控件的可滑动状态属性。

enabled9+

enabled(b?: boolean): On

指定目标控件的使能状态属性，返回On对象自身。

系统能力：SystemCapability.Test.UiTest

参数：

返回值：

示例：

let on = ON.enabled(true); // 使用静态构造器ON创建On对象，指定目标控件的使能状态属性。

focused9+

focused(b?: boolean): On

指定目标控件的获焦状态属性，返回On对象自身。

系统能力：SystemCapability.Test.UiTest

参数：

返回值：

示例：

let on = ON.focused(true); // 使用静态构造器ON创建On对象，指定目标控件的获焦状态属性。

selected9+

selected(b?: boolean): On

指定目标控件的被选中状态属性，返回On对象自身。

系统能力：SystemCapability.Test.UiTest

参数：

返回值：

示例：

let on = ON.selected(true); // 使用静态构造器ON创建On对象，指定目标控件的被选中状态属性。

checked9+

checked(b?: boolean): On

指定目标控件的被勾选状态属性，返回On对象自身。

系统能力：SystemCapability.Test.UiTest

参数：

返回值：

示例：

let on = ON.checked(true); // 使用静态构造器ON创建On对象，指定目标控件的被勾选状态属性

checkable9+

checkable(b?: boolean): On

指定目标控件能否被勾选状态属性，返回On对象自身。

系统能力：SystemCapability.Test.UiTest

参数：

返回值：

示例：

let on = ON.checkable(true); // 使用静态构造器ON创建On对象，指定目标控件的能否被勾选状态属性。

isBefore9+

isBefore(on: On): On

指定目标控件位于给出的特征属性控件之前，返回On对象自身。

系统能力：SystemCapability.Test.UiTest

参数：

返回值：

示例：

let on = ON.isBefore(ON.text('123')); // 使用静态构造器ON创建On对象，指定目标控件位于给出的特征属性控件之前。

isAfter9+

isAfter(on: On): On

指定目标控件位于给出的特征属性控件之后，返回On对象自身。

系统能力：SystemCapability.Test.UiTest

参数：

返回值：

示例：

let on = ON.isAfter(ON.text('123')); // 使用静态构造器ON创建On对象，指定目标控件位于给出的特征属性控件之后。

Component9+

UiTest框架在API9中，Component类代表了UI界面上的一个控件，提供控件属性获取，控件点击，滑动查找，文本注入等API。

该类提供的所有方法都使用Promise方式作为异步方法，需使用await调用。

click9+

click(): Promise<void>

控件对象进行点击操作。

系统能力：SystemCapability.Test.UiTest

错误码：

以下错误码的详细介绍请参见uitest测试框架错误码。

示例：

async function demo() {
    let driver = Driver.create();
    let button = await driver.findComponent(ON.type('button'));
    await button.click();
}

doubleClick9+

doubleClick(): Promise<void>

控件对象进行双击操作。

系统能力：SystemCapability.Test.UiTest

错误码：

以下错误码的详细介绍请参见uitest测试框架错误码。

示例：

async function demo() {
    let driver = Driver.create();
    let button = await driver.findComponent(ON.type('button'));
    await button.doubleClick();
}

longClick9+

longClick(): Promise<void>

控件对象进行长按操作。

系统能力：SystemCapability.Test.UiTest

错误码：

以下错误码的详细介绍请参见uitest测试框架错误码。

示例：

async function demo() {
    let driver = Driver.create();
    let button = await driver.findComponent(ON.type('button'));
    await button.longClick();
}

getId9+

getId(): Promise<string>

获取控件对象的id值。

系统能力：SystemCapability.Test.UiTest

返回值：

错误码：

以下错误码的详细介绍请参见uitest测试框架错误码。

示例：

async function demo() {
    let driver = Driver.create();
    let button = await driver.findComponent(ON.type('button'));
    let num = await button.getId();
}

getText9+

getText(): Promise<string>

获取控件对象的文本信息。

系统能力：SystemCapability.Test.UiTest

返回值：

错误码：

以下错误码的详细介绍请参见uitest测试框架错误码。

示例：

async function demo() {
    let driver = Driver.create();
    let button = await driver.findComponent(ON.type('button'));
    let text = await button.getText();
}

getType9+

getType(): Promise<string>

获取控件对象的控件类型。

系统能力：SystemCapability.Test.UiTest

返回值：

错误码：

以下错误码的详细介绍请参见uitest测试框架错误码。

示例：

async function demo() {
    let driver = Driver.create();
    let button = await driver.findComponent(ON.type('button'));
    let type = await button.getType();
}

getBounds9+

getBounds(): Promise<Rect>

获取控件对象的边框信息。

系统能力：SystemCapability.Test.UiTest

返回值：

错误码：

以下错误码的详细介绍请参见uitest测试框架错误码。

示例：

async function demo() {
    let driver = Driver.create();
    let button = await driver.findComponent(ON.type('button'));
    let rect = await button.getBounds();
}

getBoundsCenter9+

getBoundsCenter(): Promise<Point>

获取控件对象所占区域的中心点信息。

系统能力：SystemCapability.Test.UiTest

返回值：

错误码：

以下错误码的详细介绍请参见uitest测试框架错误码。

示例：

async function demo() {
    let driver = Driver.create();
    let button = await driver.findComponent(ON.type('button'));
    let point = await button.getBoundsCenter();
}

isClickable9+

isClickable(): Promise<boolean>

获取控件对象可点击属性。

系统能力：SystemCapability.Test.UiTest

返回值：

错误码：

以下错误码的详细介绍请参见uitest测试框架错误码。

示例：

async function demo() {
    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');
    }
}

isLongClickable9+

isLongClickable(): Promise<boolean>

获取控件对象可长按点击属性。

系统能力：SystemCapability.Test.UiTest

返回值：

错误码：

以下错误码的详细介绍请参见uitest测试框架错误码。

示例：

async function demo() {
    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');
    }
}

isChecked9+

isChecked(): Promise<boolean>

获取控件对象被勾选状态。

系统能力：SystemCapability.Test.UiTest

返回值：

错误码：

以下错误码的详细介绍请参见uitest测试框架错误码。

示例：

async function demo() {
    let driver = Driver.create();
    let checkBox = await driver.findComponent(ON.type('Checkbox'));
    if(await checkBox.isChecked) {
        console.info('This checkBox is checked');
    } else {
        console.info('This checkBox is not checked');
    }
}

isCheckable9+

isCheckable(): Promise<boolean>

获取控件对象能否被勾选属性。

系统能力：SystemCapability.Test.UiTest

返回值：

错误码：

以下错误码的详细介绍请参见uitest测试框架错误码。

示例：

async function demo() {
    let driver = Driver.create();
    let checkBox = await driver.findComponent(ON.type('Checkbox'));
    if(await checkBox.isCheckable) {
        console.info('This checkBox is checkable');
    } else {
        console.info('This checkBox is not checkable');
    }
}

isScrollable9+

isScrollable(): Promise<boolean>

获取控件对象可滑动属性。

系统能力：SystemCapability.Test.UiTest

返回值：

错误码：

以下错误码的详细介绍请参见uitest测试框架错误码。

示例：

async function demo() {
    let driver = Driver.create();
    let scrollBar = 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');
    }
}

isEnabled9+

isEnabled(): Promise<boolean>

获取控件使能状态。

系统能力：SystemCapability.Test.UiTest

返回值：

错误码：

以下错误码的详细介绍请参见uitest测试框架错误码。

示例：

async function demo() {
    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');
    }
}

isFocused9+

isFocused(): Promise<boolean>

判断控件对象获焦状态。

系统能力：SystemCapability.Test.UiTest

返回值：

错误码：

以下错误码的详细介绍请参见uitest测试框架错误码。

示例：

async function demo() {
    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');
    }
}

isSelected9+

isSelected(): Promise<boolean>

获取控件对象被选中状态。

系统能力：SystemCapability.Test.UiTest

返回值：

错误码：

以下错误码的详细介绍请参见uitest测试框架错误码。

示例：

async function demo() {
    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');
    }
}

inputText9+

inputText(text: string): Promise<void>

向控件中输入文本(适用于文本框控件)。

系统能力：SystemCapability.Test.UiTest

参数：

错误码：

以下错误码的详细介绍请参见uitest测试框架错误码。

示例：

async function demo() {
    let driver = Driver.create();
    let text = await driver.findComponent(ON.text('hello world'));
    await text.inputText('123');
}

clearText9+

clearText(): Promise<void>

清除控件的文本信息(适用于文本框控件)。

系统能力：SystemCapability.Test.UiTest

错误码：

示例：

async function demo() {
    let driver = Driver.create();
    let text = await driver.findComponent(ON.text('hello world'));
    await text.clearText();
}

scrollSearch9+

scrollSearch(on: On): Promise<Component>

在控件上滑动查找目标控件(适用支持滑动的控件)。

系统能力：SystemCapability.Test.UiTest

参数：

返回值：

错误码：

以下错误码的详细介绍请参见uitest测试框架错误码。

示例：

async function demo() {
    let driver = Driver.create();
    let button = await driver.findComponent(ON.type('Scroll'));
    let button = await scrollBar.scrollSearch(ON.text('next page'));
}

scrollToTop9+

scrollToTop(speed?: number): Promise<void>

在控件上滑动到顶部(适用支持滑动的控件)。

系统能力：SystemCapability.Test.UiTest

参数：

错误码：

以下错误码的详细介绍请参见uitest测试框架错误码。

示例：

async function demo() {
    let driver = Driver.create();
    let scrollBar = await driver.findComponent(ON.type('Scroll'));
    await scrollBar.scrollToTop();
}

scrollToBottom9+

scrollToBottom(speed?: number): Promise<void>

在控件上滑动到底部(适用支持滑动的控件)。

系统能力：SystemCapability.Test.UiTest

参数：

错误码：

以下错误码的详细介绍请参见uitest测试框架错误码。

示例：

async function demo() {
    let driver = Driver.create();
    let scrollBar = await driver.findComponent(ON.type('Scroll'));
    await scrollBar.scrollToBottom();
}

dragTo9+

dragTo(target: Component): Promise<void>

将控件拖拽至目标控件处。

系统能力：SystemCapability.Test.UiTest

参数：

错误码：

以下错误码的详细介绍请参见uitest测试框架错误码。

示例：

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);
    }

pinchOut9+

pinchOut(scale: number): Promise<void>

将控件按指定的比例进行捏合放大。

系统能力：SystemCapability.Test.UiTest

参数：

错误码：

以下错误码的详细介绍请参见uitest测试框架错误码。

示例：

async function demo() {
    let driver = Driver.create();
    let image = await driver.findComponent(ON.type('image'));
    await image.pinchOut(1.5);
    }

pinchIn9+

pinchIn(scale: number): Promise<void>

将控件按指定的比例进行捏合缩小。

系统能力：SystemCapability.Test.UiTest

参数：

错误码：

以下错误码的详细介绍请参见uitest测试框架错误码。

示例：

async function demo() {
    let driver = Driver.create();
    let image = await driver.findComponent(ON.type('image'));
    await image.pinchIn(0.5);
    }

Driver9+

Driver类为uitest测试框架的总入口，提供控件匹配/查找，按键注入，坐标点击/滑动，截图等能力。

该类提供的方法除Driver.create()以外的所有方法都使用Promise方式作为异步方法，需使用await方式调用。

create9+

static create(): Driver

静态方法，构造一个Driver对象，并返回该对象。

系统能力：SystemCapability.Test.UiTest

返回值：

错误码：

以下错误码的详细介绍请参见uitest测试框架错误码。

示例：

async function demo() {
    let driver = Driver.create();
}

delayMs9+

delayMs(duration: number): Promise<void>

Driver对象在给定的时间内延时。

系统能力：SystemCapability.Test.UiTest

参数：

错误码：

以下错误码的详细介绍请参见uitest测试框架错误码。

示例：

async function demo() {
    let driver = Driver.create();
    await driver.delayMs(1000);
}

findComponent9+

findComponent(on: On): Promise<Component>

在Driver对象中，根据给出的目标控件属性要求查找目标控件。

系统能力：SystemCapability.Test.UiTest

参数：

返回值：

错误码：

以下错误码的详细介绍请参见uitest测试框架错误码。

示例：

async function demo() {
    let driver = Driver.create();
    let button = await driver.findComponent(ON.text('next page'));
}

findComponents9+

findComponents(on: On): Promise<Array<Component>>

在Driver对象中，根据给出的目标控件属性要求查找出所有匹配控件，以列表保存。

系统能力：SystemCapability.Test.UiTest

参数：

返回值：

错误码：

以下错误码的详细介绍请参见uitest测试框架错误码。

示例：

async function demo() {
    let driver = Driver.create();
    let buttonList = await driver.findComponents(ON.text('next page'));
}

findWindow9+

findWindow(filter: WindowFilter): Promise<UiWindow>

通过指定窗口的属性来查找目标窗口。

系统能力：SystemCapability.Test.UiTest

参数：

返回值：

错误码：

以下错误码的详细介绍请参见uitest测试框架错误码。

示例：

async function demo() {
    let driver = Driver.create();
    let window = await driver.findWindow({actived: true});
}

waitForComponent9+

waitForComponent(on: On, time: number): Promise<Component>

在Driver对象中，在用户给定的时间内，持续查找满足控件属性要求的目标控件。

系统能力：SystemCapability.Test.UiTest

参数：

返回值：

错误码：

以下错误码的详细介绍请参见uitest测试框架错误码。

示例：

async function demo() {
    let driver = Driver.create();
    let button = await driver.waitForComponent(ON.text('next page'),500);
}

assertComponentExist9+

assertComponentExist(on: On): Promise<void>

断言API，用于断言当前界面是否存在满足给出的目标属性的控件。

系统能力：SystemCapability.Test.UiTest

参数：

错误码：

以下错误码的详细介绍请参见uitest测试框架错误码。

示例：

async function demo() {
    let driver = Driver.create();
    await driver.assertComponentExist(ON.text('next page'));
}

pressBack9+

pressBack(): Promise<void>

Driver对象进行点击BACK键的操作。

系统能力：SystemCapability.Test.UiTest

错误码：

以下错误码的详细介绍请参见uitest测试框架错误码。

示例：

async function demo() {
    let driver = Driver.create();
    await driver.pressBack();
}

triggerKey9+

triggerKey(keyCode: number): Promise<void>

Driver对象采取如下操作：传入key值实现模拟点击对应按键的效果。

系统能力：SystemCapability.Test.UiTest

参数：

错误码：

以下错误码的详细介绍请参见uitest测试框架错误码。

示例：

async function demo() {
    let driver = Driver.create();
    await driver.triggerKey(123);
}

triggerCombineKeys9+

triggerCombineKeys(key0: number, key1: number, key2?: number): Promise<void>

Driver对象通过给定的key值，找到对应组合键并点击。例如，Key值为(2072, 2019)时，Driver对象找到key值对应的组合键并点击，如ctrl+c。

系统能力：SystemCapability.Test.UiTest

参数：

错误码：

以下错误码的详细介绍请参见uitest测试框架错误码。

示例：

async function demo() {
    let driver = Driver.create();
    await driver.triggerCombineKeys(2072, 2047, 2035);
}

click9+

click(x: number, y: number): Promise<void>

Driver对象采取如下操作：在目标坐标点单击。

系统能力：SystemCapability.Test.UiTest

参数：

错误码：

以下错误码的详细介绍请参见uitest测试框架错误码。

示例：

async function demo() {
    let driver = Driver.create();
    await driver.click(100,100);
}

doubleClick9+

doubleClick(x: number, y: number): Promise<void>

Driver对象采取如下操作：在目标坐标点双击。

系统能力：SystemCapability.Test.UiTest

参数：

错误码：

以下错误码的详细介绍请参见uitest测试框架错误码。

示例：

async function demo() {
    let driver = Driver.create();
    await driver.doubleClick(100,100);
}

longClick9+

longClick(x: number, y: number): Promise<void>

Driver对象采取如下操作：在目标坐标点长按。

系统能力：SystemCapability.Test.UiTest

参数：

错误码：

以下错误码的详细介绍请参见uitest测试框架错误码。

示例：

async function demo() {
    let driver = Driver.create();
    await driver.longClick(100,100);
}

swipe9+

swipe(startx: number, starty: number, endx: number, endy: number, speed?: number): Promise<void>

Driver对象采取如下操作：从起始坐标点滑向目的坐标点。

系统能力：SystemCapability.Test.UiTest

参数：

错误码：

以下错误码的详细介绍请参见uitest测试框架错误码。

示例：

async function demo() {
    let driver = Driver.create();
    await driver.swipe(100,100,200,200,600);
}

drag9+

drag(startx: number, starty: number, endx: number, endy: number, speed?: number): Promise<void>

Driver对象采取如下操作：从起始坐标点拖拽至目的坐标点。

系统能力：SystemCapability.Test.UiTest

参数：

错误码：

以下错误码的详细介绍请参见uitest测试框架错误码。

示例：

async function demo() {
    let driver = Driver.create();
    await driver.drag(100,100,200,200,600);
}

screenCap9+

screenCap(savePath: string): Promise<boolean>

Driver对象采取如下操作：捕获当前屏幕，并保存为PNG格式的图片至给出的保存路径中。

系统能力：SystemCapability.Test.UiTest

参数：

返回值：

错误码：

以下错误码的详细介绍请参见uitest测试框架错误码。

示例：

async function demo() {
    let driver = Driver.create();
    await driver.screenCap('/local/tmp/1.png');
}

setDisplayRotation9+

setDisplayRotation(rotation: DisplayRotation): Promise<void>

将设备的屏幕显示方向设置为指定的显示方向。

系统能力：SystemCapability.Test.UiTest

参数：

错误码：

以下错误码的详细介绍请参见uitest测试框架错误码。

示例：

async function demo() {
    let driver = Driver.create();
    await driver.setDisplayRotation(DisplayRotation.ROTATION_180);
}

getDisplayRotation9+

getDisplayRotation(): Promise<DisplayRotation>

获取当前设备的屏幕显示方向。

系统能力：SystemCapability.Test.UiTest

返回值：

错误码：

以下错误码的详细介绍请参见uitest测试框架错误码。

示例：

async function demo() {
    let driver = Driver.create();
    let rotation = await driver.getDisplayRotation();
}

setDisplayRotationEnabled9+

setDisplayRotationEnabled(enabled: boolean): Promise<void>

启用/禁用设备旋转屏幕的功能。

系统能力：SystemCapability.Test.UiTest

参数：

错误码：

以下错误码的详细介绍请参见uitest测试框架错误码。

示例：

async function demo() {
    let driver = Driver.create();
    await driver.setDisplayRotationEnabled(false);
}

getDisplaySize9+

getDisplaySize(): Promise<Point>

获取当前设备的屏幕大小。

系统能力：SystemCapability.Test.UiTest

返回值：

错误码：

以下错误码的详细介绍请参见uitest测试框架错误码。

示例：

async function demo() {
    let driver = Driver.create();
    let size = await driver.getDisplaySize();
}

getDisplayDensity9+

getDisplayDensity(): Promise<Point>

获取当前设备屏幕的分辨率。

系统能力：SystemCapability.Test.UiTest

返回值：

错误码：

以下错误码的详细介绍请参见uitest测试框架错误码。

示例：

async function demo() {
    let driver = Driver.create();
    let density = await driver.getDisplayDensity();
}

wakeUpDisplay9+

wakeUpDisplay(): Promise<void>

唤醒当前设备即设备亮屏。

系统能力：SystemCapability.Test.UiTest

错误码：

以下错误码的详细介绍请参见uitest测试框架错误码。

示例：

async function demo() {
    let driver = Driver.create();
    await driver.wakeUpDisplay();
}

pressHome9+

pressHome(): Promise<void>

设备返回到桌面。

系统能力：SystemCapability.Test.UiTest

错误码：

以下错误码的详细介绍请参见uitest测试框架错误码。

示例：

async function demo() {
    let driver = Driver.create();
    await driver.pressHome();
}

waitForIdle9+

waitForIdle(idleTime: number, timeout: number): Promise<boolean>

判断当前界面的所有控件是否已经空闲。

系统能力：SystemCapability.Test.UiTest

参数：

返回值：

错误码：

以下错误码的详细介绍请参见uitest测试框架错误码。

示例：

async function demo() {
    let driver = Driver.create();
    let idled = await driver.waitForIdle(4000,5000);
}

fling9+

fling(from: Point, to: Point, stepLen: number, speed: number): Promise<void>

模拟手指滑动后脱离屏幕的快速滑动操作。

系统能力：SystemCapability.Test.UiTest

参数：

错误码：

以下错误码的详细介绍请参见uitest测试框架错误码。

示例：

async function demo() {
    let driver = Driver.create();
    await driver.fling({x: 500, y: 480},{x: 450, y: 480},5,600);
}

injectMultiPointerAction9+

injectMultiPointerAction(pointers: PointerMatrix, speed?: number): Promise<boolean>

向设备注入多指操作。

系统能力：SystemCapability.Test.UiTest

参数：

返回值：

错误码：

以下错误码的详细介绍请参见uitest测试框架错误码。

示例：

async function demo() {
    let driver = Driver.create();
    let pointers = PointerMatrix.create(2,3);
    pointers.setPoint(0,0,{x:230,y:480});
    pointers.setPoint(0,1,{x:250,y:380});
    pointers.setPoint(0,2,{x:270,y:280});
    pointers.setPoint(1,0,{x:230,y:680});
    pointers.setPoint(1,1,{x:240,y:580});
    pointers.setPoint(1,2,{x:250,y:480});
    await driver.injectMultiPointerAction(pointers);
}

PointerMatrix9+

存储多指操作中每根手指每一步动作的坐标点及其行为的二维数组。

create9+

static create(fingers: number, steps: number): PointerMatrix

静态方法，构造一个PointerMatrix对象，并返回该对象。

系统能力：SystemCapability.Test.UiTest

参数：

返回值：

示例：

async function demo() {
    let pointerMatrix = PointerMatrix.create(2,3);
}

setPoint9+

setPoint(finger: number, step: number, point: Point): void

设置PointerMatrix对象中指定手指和步骤对应动作的坐标点。

系统能力：SystemCapability.Test.UiTest

参数：

示例：

async function demo() {
    let pointers = PointerMatrix.create(2,3);
    pointers.setPoint(0,0,{x:230,y:480});
    pointers.setPoint(0,1,{x:250,y:380});
    pointers.setPoint(0,2,{x:270,y:280});
    pointers.setPoint(1,0,{x:230,y:680});
    pointers.setPoint(1,1,{x:240,y:580});
    pointers.setPoint(1,2,{x:250,y:480});
}

UiWindow9+

UiWindow代表了UI界面上的一个窗口，提供窗口属性获取，窗口拖动、调整窗口大小等能力。

该类提供的所有方法都使用Promise方式作为异步方法，需使用await方式调用。

getBundleName9+

getBundleName(): Promise<string>

获取窗口归属应用的包名信息。

系统能力：SystemCapability.Test.UiTest

返回值：

错误码：

以下错误码的详细介绍请参见uitest测试框架错误码。

示例：

async function demo() {
    let driver = Driver.create();
    let window = await driver.findWindow({actived: true});
    let name = await window.getBundleName();
}

getBounds9+

getBounds(): Promise<Rect>

获取窗口的边框信息。

系统能力：SystemCapability.Test.UiTest

返回值：

错误码：

以下错误码的详细介绍请参见uitest测试框架错误码。

示例：

async function demo() {
    let driver = Driver.create();
    let window = await driver.findWindow({actived: true});
    let rect = await window.getBounds();
}

getTitle9+

getTitle(): Promise<string>

获取窗口的标题信息。

系统能力：SystemCapability.Test.UiTest

返回值：

错误码：

以下错误码的详细介绍请参见uitest测试框架错误码。

示例：

async function demo() {
    let driver = Driver.create();
    let window = await driver.findWindow({actived: true});
    let rect = await window.getTitle();
}

getWindowMode9+

getWindowMode(): Promise<WindowMode>

获取窗口的窗口模式信息。

系统能力：SystemCapability.Test.UiTest

返回值：

错误码：

以下错误码的详细介绍请参见uitest测试框架错误码。

示例：

async function demo() {
    let driver = Driver.create();
    let window = await driver.findWindow({actived: true});
    let mode = await window.getWindowMode();
}

isFocused9+

isFocused(): Promise<boolean>

判断窗口是否处于获焦状态。

系统能力：SystemCapability.Test.UiTest

返回值：

错误码：

以下错误码的详细介绍请参见uitest测试框架错误码。

示例：

async function demo() {
    let driver = Driver.create();
    let window = await driver.findWindow({actived: true});
    let focused = await window.isFocused();
}

isActived9+

isActived(): Promise<boolean>

判断窗口是否为用户正在交互窗口。

系统能力：SystemCapability.Test.UiTest

返回值：

错误码：

以下错误码的详细介绍请参见uitest测试框架错误码。

示例：

async function demo() {
    let driver = Driver.create();
    let window = await driver.findWindow({actived: true});
    let focused = await window.isActived();
}

focus9+

focus(): Promise<void>

让窗口获焦。

系统能力：SystemCapability.Test.UiTest

错误码：

以下错误码的详细介绍请参见uitest测试框架错误码。

示例：

async function demo() {
    let driver = Driver.create();
    let window = await driver.findWindow({actived: true});
    await window.focus();
}

moveTo9+

moveTo(x: number, y: number): Promise<void>

将窗口移动到目标点。适用于支持移动的窗口。

系统能力：SystemCapability.Test.UiTest

参数：

错误码：

以下错误码的详细介绍请参见uitest测试框架错误码。

示例：

async function demo() {
    let driver = Driver.create();
    let window = await driver.findWindow({actived: true});
    await window.moveTo(100, 100);
}

resize9+

resize(wide: number, height: number, direction: ResizeDirection): Promise<void>

根据传入的宽、高和调整方向来调整窗口的大小。适用于支持调整大小的窗口。

系统能力：SystemCapability.Test.UiTest

参数：

错误码：

以下错误码的详细介绍请参见uitest测试框架错误码。

示例：

async function demo() {
    let driver = Driver.create();
    let window = await driver.findWindow({actived: true});
    await window.resize(100, 100, ResizeDirection.LEFT);
}

split9+

split(): Promise<void>

将窗口模式切换成分屏模式。适用于支持切换分屏模式的窗口。

系统能力：SystemCapability.Test.UiTest

错误码：

以下错误码的详细介绍请参见uitest测试框架错误码。

示例：

async function demo() {
    let driver = Driver.create();
    let window = await driver.findWindow({actived: true});
    await window.split();
}

maximize9+

maximize(): Promise<void>

将窗口最大化。适用于支持窗口最大化操作的窗口。

系统能力：SystemCapability.Test.UiTest

错误码：

以下错误码的详细介绍请参见uitest测试框架错误码。

示例：

async function demo() {
    let driver = Driver.create();
    let window = await driver.findWindow({actived: true});
    await window.maximize();
}

minimize9+

minimize(): Promise<void>

将窗口最小化。适用于支持窗口最小化操作的窗口。

系统能力：SystemCapability.Test.UiTest

错误码：

以下错误码的详细介绍请参见uitest测试框架错误码。

示例：

async function demo() {
    let driver = Driver.create();
    let window = await driver.findWindow({actived: true});
    await window.minimize();
}

resume9+

resume(): Promise<void>

将窗口恢复到之前的窗口模式。

系统能力：SystemCapability.Test.UiTest

错误码：

以下错误码的详细介绍请参见uitest测试框架错误码。

示例：

async function demo() {
    let driver = Driver.create();
    let window = await driver.findWindow({actived: true});
    await window.resume();
}

close9+

close(): Promise<void>

将窗口关闭。

系统能力：SystemCapability.Test.UiTest

错误码：

以下错误码的详细介绍请参见uitest测试框架错误码。

示例：

async function demo() {
    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(deprecated)和By.isAfter(deprecated)等API限定邻近控件特征进行辅助定位。

By类提供的所有API均为同步接口，建议使用者通过静态构造器BY来链式创建By对象。

从API version 9开始不再维护，建议使用On9+。

BY.text('123').type('button');

text(deprecated)

text(txt: string, pattern?: MatchPattern): By

指定目标控件文本属性，支持多种匹配模式，返回By对象自身。

从API version 9开始不再维护，建议使用text9+。

系统能力：SystemCapability.Test.UiTest

参数：

返回值：

示例：

let by = BY.text('123'); // 使用静态构造器BY创建by对象，指定目标控件的text属性。

key(deprecated)

key(key: string): By

指定目标控件key值属性，返回By对象自身。

从API version 9开始不再维护，建议使用id9+。

系统能力：SystemCapability.Test.UiTest

参数：

返回值：

示例：

let by = BY.key('123'); // 使用静态构造器BY创建by对象，指定目标控件的key值属性。

id(deprecated)

id(id: number): By

指定目标控件id属性，返回By对象自身。

从API version 9开始废弃。

系统能力：SystemCapability.Test.UiTest

参数：

返回值：

示例：

let by = BY.id(123); // 使用静态构造器BY创建by对象，指定目标控件的id属性。

type(deprecated)

type(tp: string): By

指定目标控件的控件类型属性，返回By对象自身。

从API version 9开始不再维护，建议使用type9+。

系统能力：SystemCapability.Test.UiTest

参数：

返回值：

示例：

let by = BY.type('button'); // 使用静态构造器BY创建by对象，指定目标控件的控件类型属性。

clickable(deprecated)

clickable(b?: boolean): By

指定目标控件的可点击状态属性，返回By对象自身。

从API version 9开始不再维护，建议使用clickable9+。

系统能力：SystemCapability.Test.UiTest

参数：

返回值：

示例：

let by = BY.clickable(true); // 使用静态构造器BY创建by对象，指定目标控件的可点击状态属性。

scrollable(deprecated)

scrollable(b?: boolean): By

指定目标控件的可滑动状态属性，返回By对象自身。

从API version 9开始不再维护，建议使用scrollable9+。

系统能力：SystemCapability.Test.UiTest

参数：

返回值：

示例：

let by = BY.scrollable(true); // 使用静态构造器BY创建by对象，指定目标控件的可滑动状态属性。

enabled(deprecated)

enabled(b?: boolean): By

指定目标控件的使能状态属性，返回By对象自身。

从API version 9开始不再维护，建议使用enabled9+。

系统能力：SystemCapability.Test.UiTest

参数：

返回值：

示例：

let by = BY.enabled(true); // 使用静态构造器BY创建by对象，指定目标控件的使能状态属性。

focused(deprecated)

focused(b?: boolean): By

指定目标控件的获焦状态属性，返回By对象自身。

从API version 9开始不再维护，建议使用focused9+。

系统能力：SystemCapability.Test.UiTest

参数：

返回值：

示例：

let by = BY.focused(true); // 使用静态构造器BY创建by对象，指定目标控件的获焦状态属性。

selected(deprecated)

selected(b?: boolean): By

指定目标控件的被选中状态属性，返回By对象自身。

从API version 9开始不再维护，建议使用selected9+。

系统能力：SystemCapability.Test.UiTest

参数：

返回值：

示例：

let by = BY.selected(true); // 使用静态构造器BY创建by对象，指定目标控件的被选中状态属性。

isBefore(deprecated)

isBefore(by: By): By

指定目标控件位于给出的特征属性控件之前，返回By对象自身。

从API version 9开始不再维护，建议使用isBefore9+。

系统能力：SystemCapability.Test.UiTest

参数：

返回值：

示例：

let by = BY.isBefore(BY.text('123')); // 使用静态构造器BY创建by对象，指定目标控件位于给出的特征属性控件之前。

isAfter(deprecated)

isAfter(by: By): By

指定目标控件位于给出的特征属性控件之后，返回By对象自身。

从API version 9开始不再维护，建议使用isAfter9+。

系统能力：SystemCapability.Test.UiTest

参数：

返回值：

示例：

let by = BY.isAfter(BY.text('123')); // 使用静态构造器BY创建by对象，指定目标控件位于给出的特征属性控件之后。

UiComponent(deprecated)

UiTest中，UiComponent类代表了UI界面上的一个控件，提供控件属性获取，控件点击，滑动查找，文本注入等API。

该类提供的所有方法都使用Promise方式作为异步方法，需使用await调用。

从API version 9开始不再维护，建议使用Component9+。

click(deprecated)

click(): Promise<void>

控件对象进行点击操作。

从API version 9开始不再维护，建议使用click9+。

系统能力：SystemCapability.Test.UiTest

示例：

async function demo() {
    let driver = UiDriver.create();
    let button = await driver.findComponent(BY.type('button'));
    await button.click();
}

doubleClick(deprecated)

doubleClick(): Promise<void>

控件对象进行双击操作。

从API version 9开始不再维护，建议使用doubleClick9+。

系统能力：SystemCapability.Test.UiTest

示例：

async function demo() {
    let driver = UiDriver.create();
    let button = await driver.findComponent(BY.type('button'));
    await button.doubleClick();
}

longClick(deprecated)

longClick(): Promise<void>

控件对象进行长按操作。

从API version 9开始不再维护，建议使用longClick9+。

系统能力：SystemCapability.Test.UiTest

示例：

async function demo() {
    let driver = UiDriver.create();
    let button = await driver.findComponent(BY.type('button'));
    await button.longClick();
}

getId(deprecated)

getId(): Promise<number>

获取控件对象的id值。

从API version 9开始不再维护，被废弃。

系统能力：SystemCapability.Test.UiTest

返回值：

示例：

async function demo() {
    let driver = UiDriver.create();
    let button = await driver.findComponent(BY.type('button'));
    let num = await button.getId();
}

getKey(deprecated)

getKey(): Promise<string>

获取控件对象的key值。

从API version 9开始不再维护，建议使用getId9+

系统能力：SystemCapability.Test.UiTest

返回值：

示例：

async function demo() {
    let driver = UiDriver.create();
    let button = await driver.findComponent(BY.type('button'));
    let str_key = await button.getKey();
}

getText(deprecated)

getText(): Promise<string>

获取控件对象的文本信息。

从API version 9开始不再维护，建议使用getText9+。

系统能力：SystemCapability.Test.UiTest

返回值：

示例：

async function demo() {
    let driver = UiDriver.create();
    let button = await driver.findComponent(BY.type('button'));
    let text = await button.getText();
}

getType(deprecated)

getType(): Promise<string>

获取控件对象的控件类型。

从API version 9开始不再维护，建议使用getType9+。

系统能力：SystemCapability.Test.UiTest

返回值：

示例：

async function demo() {
    let driver = UiDriver.create();
    let button = await driver.findComponent(BY.type('button'));
    let type = await button.getType();
}

isClickable(deprecated)

isClickable(): Promise<boolean>

获取控件对象可点击状态。

从API version 9开始不再维护，建议使用isClickable9+。

系统能力：SystemCapability.Test.UiTest

返回值：

示例：

async function demo() {
    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');
    }
}

isScrollable(deprecated)

isScrollable(): Promise<boolean>

获取控件对象可滑动状态。

从API version 9开始不再维护，建议使用isScrollable9+。

系统能力：SystemCapability.Test.UiTest

返回值：

示例：

async function demo() {
    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');
    }
}

isEnabled(deprecated)

isEnabled(): Promise<boolean>

获取控件使能状态。

从API version 9开始不再维护，建议使用isEnabled9+。

系统能力：SystemCapability.Test.UiTest

返回值：

示例：

async function demo() {
    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');
    }
}

isFocused(deprecated)

isFocused(): Promise<boolean>

判断控件对象是否获焦。

从API version 9开始不再维护，建议使用isFocused9+。

系统能力：SystemCapability.Test.UiTest

返回值：

示例：

async function demo() {
    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');
    }
}

isSelected(deprecated)

isSelected(): Promise<boolean>

获取控件对象被选中状态。

从API version 9开始不再维护，建议使用isSelected9+。

系统能力：SystemCapability.Test.UiTest

返回值：

示例：

async function demo() {
    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');
    }
}

inputText(deprecated)

inputText(text: string): Promise<void>

向控件中输入文本(适用于文本框控件)。

从API version 9开始不再维护，建议使用inputText9+。

系统能力：SystemCapability.Test.UiTest

参数：

示例：

async function demo() {
    let driver = UiDriver.create();
    let text = await driver.findComponent(BY.text('hello world'));
    await text.inputText('123');
}

scrollSearch(deprecated)

scrollSearch(by: By): Promise<UiComponent>

在控件上滑动查找目标控件(适用于List等支持滑动的控件)。

从API version 9开始不再维护，建议使用scrollSearch9+。

系统能力：SystemCapability.Test.UiTest

参数：

返回值：

示例：

async function demo() {
    let driver = UiDriver.create();
    let scrollBar = await driver.findComponent(BY.type('Scroll'));
    let button = await scrollBar.scrollSearch(BY.text('next page'));
}

UiDriver(deprecated)

UiDriver类为uitest测试框架的总入口，提供控件匹配/查找，按键注入，坐标点击/滑动，截图等API。

该类提供的方法除UiDriver.create()以外的所有方法都使用Promise方式作为异步方法，需使用await调用。

从API version 9开始不再维护，建议使用Driver9+。

create(deprecated)

static create(): UiDriver

静态方法，构造一个UiDriver对象，并返回该对象。

从API version 9开始不再维护，建议使用create9+。

系统能力：SystemCapability.Test.UiTest

返回值：

示例：

async function demo() {
    let driver = UiDriver.create();
}

delayMs(deprecated)

delayMs(duration: number): Promise<void>

UiDriver对象在给定的时间内延时。

从API version 9开始不再维护，建议使用delayMs9+。

系统能力：SystemCapability.Test.UiTest

参数：

示例：

async function demo() {
    let driver = UiDriver.create();
    await driver.delayMs(1000);
}

findComponent(deprecated)

findComponent(by: By): Promise<UiComponent>

在UiDriver对象中，根据给出的目标控件属性要求查找目标控件。

从API version 9开始不再维护，建议使用findComponent9+。

系统能力：SystemCapability.Test.UiTest

参数：