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 4dcb3cfd57ceee3d37b65982075f20e7a72fcfc1..1e6f73189bdcdcd1486b869cd1788513e5a9cddc 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-uitest.md +++ b/zh-cn/application-dev/reference/apis/js-apis-uitest.md @@ -8,9 +8,9 @@ UiTest提供模拟UI操作的能力，供开发者在测试场景使用，主要 - [Component9+](#component9)：代表UI界面上的指定控件，提供控件属性获取，控件点击，滑动查找，文本注入等能力。 - [Driver9+](#driver9)：入口类，提供控件匹配/查找，按键注入，坐标点击/滑动，截图等能能力。 - [UiWindow9+](#uiwindow9)：入口类，提供窗口属性获取，窗口拖动、调整窗口大小等能能力。 -- [By](#by)：提供控件特征描述能力，用于控件筛选匹配查找。从API version9开始不再维护，建议使用[[On9+](#on9)](#Driver9)。 +- [By](#by)：提供控件特征描述能力，用于控件筛选匹配查找。从API version9开始不再维护，建议使用[[On9+](#on9)](#driver9)。 - [UiComponent](#uicomponent)：代表UI界面上的指定控件，提供控件属性获取，控件点击，滑动查找，文本注入等能力。从API version9开始不再维护，建议使用[Component9+](#component9)。 -- [UiDriver](#uidriver)：入口类，提供控件匹配/查找，按键注入，坐标点击/滑动，截图等能能力。从API version9开始不再维护，建议使用[Driver9+](#Driver9)。 +- [UiDriver](#uidriver)：入口类，提供控件匹配/查找，按键注入，坐标点击/滑动，截图等能能力。从API version9开始不再维护，建议使用[Driver9+](#driver9)。 >**说明：** > @@ -1279,7 +1279,7 @@ findComponent(on: On): Promise\ | 类型 | 说明 | | ---------------------------------- | --------------------------------- | -| Promise\<[Component](#Component9)> | 以Promise形式返回找到的控件对象。 | +| Promise\<[Component](#component9)> | 以Promise形式返回找到的控件对象。 | **错误码：** @@ -1316,7 +1316,7 @@ findComponents(on: On): Promise\> | 类型 | 说明 | | ------------------------------------------ | --------------------------------------- | -| Promise\> | 以Promise形式返回找到的控件对象的列表。 | +| Promise\> | 以Promise形式返回找到的控件对象的列表。 | **错误码：** @@ -1391,7 +1391,7 @@ waitForComponent(on: On, time: number): Promise\ | 类型 | 说明 | | --------------------------------- | --------------------------------- | -| Promise\<[Component](#Component)> | 以Promise形式返回找到的控件对象。 | +| Promise\<[Component](#component)> | 以Promise形式返回找到的控件对象。 | **错误码：** @@ -2658,7 +2658,7 @@ async function demo() { UiTest框架通过By类提供了丰富的控件特征描述API，用于进行控件筛选来匹配/查找出目标控件。
By提供的API能力具有以下几个特点:
1、支持单属性匹配和多属性组合匹配，例如同时指定目标控件text和id。
2、控件属性支持多种匹配模式。
3、支持控件绝对定位，相对定位，可通过[By.isBefore](#isbefore)和[By.isAfter](#isafter)等API限定邻近控件特征进行辅助定位。
By类提供的所有API均为同步接口，建议使用者通过静态构造器BY来链式创建By对象。 -从API version9开始不再维护，建议使用[On9+](#On9)。 +从API version9开始不再维护，建议使用[On9+](#on9)。 ```js BY.text('123').type('button') @@ -2928,7 +2928,7 @@ isBefore(by: By): By 指定目标控件位于给出的特征属性控件之前，返回By对象自身。 -从API version9开始不再维护，建议使用[isBefore9+](#isBefore9)。 +从API version9开始不再维护，建议使用[isBefore9+](#isbefore9)。 **系统能力**：SystemCapability.Test.UiTest @@ -2956,7 +2956,7 @@ isAfter(by: By): By 指定目标控件位于给出的特征属性控件之后，返回By对象自身。 -从API version9开始不再维护，建议使用[isAfter9+](#isAfter9)。 +从API version9开始不再维护，建议使用[isAfter9+](#isafter9)。 **系统能力**：SystemCapability.Test.UiTest @@ -3011,7 +3011,7 @@ doubleClick(): Promise\ 控件对象进行双击操作。 -从API version9开始不再维护，建议使用[doubleClick9+](#doubleClick9)。 +从API version9开始不再维护，建议使用[doubleClick9+](#doubleclick9)。 **系统能力**：SystemCapability.Test.UiTest @@ -3031,7 +3031,7 @@ longClick(): Promise\ 控件对象进行长按操作。 -从API version9开始不再维护，建议使用[longClick9+](#longClick9)。 +从API version9开始不再维护，建议使用[longClick9+](#longclick9)。 **系统能力**：SystemCapability.Test.UiTest @@ -3051,7 +3051,7 @@ getId(): Promise\ 获取控件对象的id值。 -从API version9开始不再维护，建议使用[getId9+](#getId9)。 +从API version9开始不再维护，建议使用[getId9+](#getid9)。 **系统能力**：SystemCapability.Test.UiTest @@ -3103,7 +3103,7 @@ getText(): Promise\ 获取控件对象的文本信息。 -从API version9开始不再维护，建议使用[getText9+](#getText9)。 +从API version9开始不再维护，建议使用[getText9+](#gettext9)。 **系统能力**：SystemCapability.Test.UiTest @@ -3129,7 +3129,7 @@ getType(): Promise\ 获取控件对象的控件类型。 -从API version9开始不再维护，建议使用[getType9+](#getType9)。 +从API version9开始不再维护，建议使用[getType9+](#gettype9)。 **系统能力**：SystemCapability.Test.UiTest @@ -3155,7 +3155,7 @@ isClickable(): Promise\ 获取控件对象可点击状态。 -从API version9开始不再维护，建议使用[isClickable9+](#isClickable9)。 +从API version9开始不再维护，建议使用[isClickable9+](#isclickable9)。 **系统能力**：SystemCapability.Test.UiTest @@ -3186,7 +3186,7 @@ isScrollable(): Promise\ 获取控件对象可滑动状态。 -从API version9开始不再维护，建议使用[isScrollable9+](#isScrollable9)。 +从API version9开始不再维护，建议使用[isScrollable9+](#isscrollable9)。 **系统能力**：SystemCapability.Test.UiTest @@ -3218,7 +3218,7 @@ isEnabled(): Promise\ 获取控件使能状态。 -从API version9开始不再维护，建议使用[isEnabled9+](#isEnabled9)。 +从API version9开始不再维护，建议使用[isEnabled9+](#isenabled9)。 **系统能力**：SystemCapability.Test.UiTest @@ -3250,7 +3250,7 @@ isFocused(): Promise\ 判断控件对象是否获焦。 -从API version9开始不再维护，建议使用[isFocused9+](#isFocused9)。 +从API version9开始不再维护，建议使用[isFocused9+](#isfocused9)。 **系统能力**：SystemCapability.Test.UiTest @@ -3281,7 +3281,7 @@ isSelected(): Promise\ 获取控件对象被选中状态。 -从API version9开始不再维护，建议使用[isSelected9+](#isSelected9)。 +从API version9开始不再维护，建议使用[isSelected9+](#isselected9)。 **系统能力**：SystemCapability.Test.UiTest @@ -3312,7 +3312,7 @@ inputText(text: string): Promise\ 向控件中输入文本(适用于文本框控件)。 -从API version9开始不再维护，建议使用[inputText9+](#inputText9)。 +从API version9开始不再维护，建议使用[inputText9+](#inputtext9)。 **系统能力**：SystemCapability.Test.UiTest @@ -3338,7 +3338,7 @@ scrollSearch(by: By): Promise\ 在控件上滑动查找目标控件(适用于List等支持滑动的控件)。 -从API version9开始不再维护，建议使用[scrollSearch9+](#scrollSearch9)。 +从API version9开始不再维护，建议使用[scrollSearch9+](#scrollsearch9)。 **系统能力**：SystemCapability.Test.UiTest @@ -3369,7 +3369,7 @@ async function demo() { UiDriver类为uitest测试框架的总入口，提供控件匹配/查找，按键注入，坐标点击/滑动，截图等API。 该类提供的方法除UiDriver.create()以外的所有方法都使用Promise方式作为异步方法，需使用await调用。 -从API version9开始不再维护，建议使用[Driver9+](#Driver9)。 +从API version9开始不再维护，建议使用[Driver9+](#driver9)。 ### create(deprecated) @@ -3401,7 +3401,7 @@ delayMs(duration: number): Promise\ UiDriver对象在给定的时间内延时。 -从API version9开始不再维护，建议使用[delayMs9+](#delayMs9)。 +从API version9开始不再维护，建议使用[delayMs9+](#delayms9)。 **系统能力**：SystemCapability.Test.UiTest @@ -3426,7 +3426,7 @@ findComponent(by: By): Promise\ 在UiDriver对象中，根据给出的目标控件属性要求查找目标控件。 -从API version9开始不再维护，建议使用[findComponent9+](#findComponent9)。 +从API version9开始不再维护，建议使用[findComponent9+](#findcomponent9)。 **系统能力**：SystemCapability.Test.UiTest @@ -3457,7 +3457,7 @@ findComponents(by: By): Promise\> 在UiDriver对象中，根据给出的目标控件属性要求查找出所有匹配控件，以列表保存。 -从API version9开始不再维护，建议使用[findComponents9+](#findComponents9)。 +从API version9开始不再维护，建议使用[findComponents9+](#findcomponents9)。 **系统能力**：SystemCapability.Test.UiTest @@ -3488,7 +3488,7 @@ assertComponentExist(by: By): Promise\ 断言API，用于断言当前界面存在满足给出的目标控件属性的控件; 如果控件不存在，该API将抛出JS异常，使当前测试用例失败。 -从API version9开始不再维护，建议使用[assertComponentExist9+](#assertComponentExist9)。 +从API version9开始不再维护，建议使用[assertComponentExist9+](#assertcomponentexist9)。 **系统能力**：SystemCapability.Test.UiTest @@ -3513,7 +3513,7 @@ pressBack(): Promise\ UiDriver对象进行点击BACK键的操作。 -从API version9开始不再维护，建议使用[pressBack9+](#pressBack9)。 +从API version9开始不再维护，建议使用[pressBack9+](#pressback9)。 **系统能力**：SystemCapability.Test.UiTest @@ -3532,7 +3532,7 @@ triggerKey(keyCode: number): Promise\ UiDriver对象采取如下操作：通过key值找到对应键并点击。 -从API version9开始不再维护，建议使用[triggerKey9+](#triggerKey9)。 +从API version9开始不再维护，建议使用[triggerKey9+](#triggerkey9)。 **系统能力**：SystemCapability.Test.UiTest @@ -3584,7 +3584,7 @@ doubleClick(x: number, y: number): Promise\ UiDriver对象采取如下操作：在目标坐标点双击。 -从API version9开始不再维护，建议使用[doubleClick9+](#doubleClick9)。 +从API version9开始不再维护，建议使用[doubleClick9+](#doubleclick9)。 **系统能力**：SystemCapability.Test.UiTest @@ -3610,7 +3610,7 @@ longClick(x: number, y: number): Promise\ UiDriver对象采取如下操作：在目标坐标点长按下鼠标左键。 -从API version9开始不再维护，建议使用[longClick9+](#longClick9)。 +从API version9开始不再维护，建议使用[longClick9+](#longclick9)。 **系统能力**：SystemCapability.Test.UiTest @@ -3664,7 +3664,7 @@ screenCap(savePath: string): Promise\ UiDriver对象采取如下操作：捕获当前屏幕，并保存为PNG格式的图片至给出的保存路径中。 -从API version9开始不再维护，建议使用[screenCap9+](#screenCap9)。 +从API version9开始不再维护，建议使用[screenCap9+](#screencap9)。 **系统能力**：SystemCapability.Test.UiTest diff --git a/zh-cn/application-dev/reference/errorcodes/errorcode-uitest.md b/zh-cn/application-dev/reference/errorcodes/errorcode-uitest.md index c2140b0e70dec2806a657f7137c3b0f79f0a90bd..dda3aabebadab92b9937e8f86039344e87329343 100644 --- a/zh-cn/application-dev/reference/errorcodes/errorcode-uitest.md +++ b/zh-cn/application-dev/reference/errorcodes/errorcode-uitest.md @@ -2,52 +2,86 @@ ## 17000001 初始化失败 -### 错误信息 +**错误信息** + Initialize failed. -### 错误描述 + +**错误描述** + 框架初始化失败。 -### 可能原因 + +**可能原因** + 无法连接到无障碍服务。 -### 处理步骤 + +**处理步骤** + 执行param set persist.ace.testmode.enabled 1，并重启设备。 ## 17000002 当前无法调用 -### 错误信息 +**错误信息** + API does not allow calling concurrently. -### 错误描述 + +**错误描述** + 当前无法调用API。 -### 可能原因 + +**可能原因** + API没有使用await进行异步调用，造成堵塞。 -### 处理步骤 +**处理步骤** + 检查测试用例，确保异步接口使用await调用。 ## 17000003 断言失败 -### 错误信息 +**错误信息** + Component existence assertion failed. -### 错误描述 + +**错误描述** + 用户断言失败。 -### 可能原因 + +**可能原因** + 用户断言存在的控件实际不存在。 -### 处理步骤 + +**处理步骤** + 检查用户断言存在的控件实际是否存在。 ## 17000004 目标控件/窗口丢失 -### 错误信息 +**错误信息** + Component lost/UiWindow lost. -### 错误描述 + +**错误描述** + 目标控件/窗口丢失，无法进行操作。 -### 可能原因 + +**可能原因** + 获取到目标控件/窗口后，页面发生变化导致目标丢失。 -### 处理步骤 + +**处理步骤** + 检查获取到目标控件/窗口后，页面是否发生变化导致目标丢失。 ## 17000005 操作不支持 -### 错误信息 +**错误信息** + This operation is not supported. -### 错误描述 + +**错误描述** + UI对象不支持该操作。 -### 可能原因 + +**可能原因** + 当前界面控件/窗口属性不支持该操作。 -### 处理步骤 + +**处理步骤** + 检查当前界面控件/窗口属性是否该操作。 diff --git a/zh-cn/application-dev/reference/errorcodes/errorcodes-zlib.md b/zh-cn/application-dev/reference/errorcodes/errorcodes-zlib.md index a2518a702c545f9d81821cef3680cb51b534c030..559f2ba4a7e76e966212fc53bb96e88270e1c09a 100755 --- a/zh-cn/application-dev/reference/errorcodes/errorcodes-zlib.md +++ b/zh-cn/application-dev/reference/errorcodes/errorcodes-zlib.md @@ -1,24 +1,5 @@ # zlib子系统错误码 -## 401 参数检查错误 - -**错误信息** - -The parameter invalid. - -**错误描述** - -当调用zlib的compress及decompress接口时，若传入参数的类型或者范围不匹配，会报此错误码。 - -**可能原因** - -1. 入参类型错误不匹配，如传入的文件路径类型不是strinf。 -2. 入参范围不匹配，如传入的options中包含的枚举不存在。 - -**处理步骤** - -检查入参类型和范围是否匹配。 - ## 900001 传入的源文件错误 **错误信息**