You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+8-8Lines changed: 8 additions & 8 deletions
Original file line number
Diff line number
Diff line change
@@ -10,7 +10,7 @@ Appium UiAutomator2 Driver is a test automation framework for Android devices. A
10
10
11
11
UiAutomator2 Driver proxies most of the commands to [UiAutomator2 server](https://github.com/appium/appium-uiautomator2-server), which uses Google's [UiAutomator](https://developer.android.com/training/testing/ui-automator) framework under the hood. Some commands are proxied directly to [appium-adb](https://github.com/appium/appium-adb) and other helpers built on top of Android platform tools.
12
12
13
-
> **Note**
13
+
> [!Note]
14
14
>
15
15
> Since version 2.0.0 UiAutomator2 driver has dropped the support of Appium 1, and is only compatible to Appium 2.
16
16
> Use the `appium driver install uiautomator2` command to add it to your Appium 2 dist.
@@ -297,7 +297,7 @@ Along with the common settings the following driver-specific settings are curren
297
297
298
298
Name | Type | Description
299
299
--- | --- | ---
300
-
actionAcknowledgmentTimeout | long | Maximum number of milliseconds to wait for an acknowledgment of generic uiautomator actions, such as clicks, text setting, and menu presses. The acknowledgment is an[AccessibilityEvent](http://developer.android.com/reference/android/view/accessibility/AccessibilityEvent.html") corresponding to an action, that lets the framework determine if the action was successful. Generally, this timeout should not be modified. `3000` ms by default
300
+
actionAcknowledgmentTimeout | long | Maximum number of milliseconds to wait for an acknowledgment of generic uiautomator actions, such as clicks, text setting, and menu presses. The acknowledgment is an[AccessibilityEvent](http://developer.android.com/reference/android/view/accessibility/AccessibilityEvent.html) corresponding to an action, that lets the framework determine if the action was successful. Generally, this timeout should not be modified. `3000` ms by default
301
301
allowInvisibleElements | boolean | Whether to include elements that are not visible to the user (e. g. whose `displayed` attribute is `false`) to the XML source tree. `false` by default
302
302
ignoreUnimportantViews | boolean | Enables or disables layout hierarchy compression. If compression is enabled, the layout hierarchy derived from the Acessibility framework will only contain nodes that are important for uiautomator testing. Any unnecessary surrounding layout nodes that make viewing and searching the hierarchy inefficient are removed. `false` by default
303
303
elementResponseAttributes | string | Comma-separated list of element attribute names to be included into findElement response. By default only element UUID is present there, but it is also possible to add the following items: `name`, `text`, `rect`, `enabled`, `displayed`, `selected`, `attribute/<element_attribute_name>`. It is required that `shouldUseCompactResponses` setting is set to `false` in order for this one to apply.
@@ -1202,12 +1202,12 @@ airplaneMode | boolean | True if Airplane Mode is enabled
1202
1202
Set the connectivity state for different services. At least one valid service name must be provided in arguments.
1203
1203
Missing values tell the driver to not change the corresponding service's state.
1204
1204
1205
-
> **Note**
1205
+
> [!Note]
1206
1206
>
1207
1207
> Switching Wi-Fi and mobile data states reliably work on emulators for all Android versions.
1208
1208
> Real devices support proper state switching only since Android 11.
1209
1209
1210
-
> **Note**
1210
+
> [!Note]
1211
1211
>
1212
1212
> UiAutomator2 REST server app is running on the device under test and might be terminated/disconnected by Android
1213
1213
> thus failing the driver session as a result of using this API. The only way to restore the session would be to quit it
@@ -1860,7 +1860,7 @@ If you observe automated tests need at least 10 seconds or more to locate/intera
1860
1860
1861
1861
Setting the value of `waitForIdleTimeout` to zero `0` ms should completely disable any waits, and enforce interactions to happen immediately ignoring the accessibility event stream state. The downside of that would be that all interactions are never going to be delayed, so clicks and other actions might happen at wrong places of the application UI. That is why is it important to check the app under test first and fix its source to get rid of activities hogging the event loop. Sometimes it makes sence to disable animations completely for the app build under test, which could speed up your flows significantly in some situations.
1862
1862
1863
-
> **Warning**
1863
+
> [!Warning]
1864
1864
> `waitForIdleTimeout` is a setting, not a capability.
1865
1865
1866
1866
### Session Startup Issues
@@ -1916,11 +1916,11 @@ In case of _id_ locators you could try to change the value of the following sett
1916
1916
1917
1917
The general resources naming convention for Android apps is `<app_id>:id/<resource_name>`. This should guarantee uniqueness of each identifier accross the user interface. Although, this is only a convention and it is still allowed to have various resource names that do not follow it. If you have gotten one of such applications for automated testing then consider assigning `disableIdLocatorAutocompletion` setting value to `true`, so UiAutomator2 driver does not automatically rewrite supplied id values by adding `<app_id>:id/` prefixes to them.
1918
1918
1919
-
> **Warning**
1919
+
> [!Warning]
1920
1920
> Default values for settings above have been selected to optimize xpath lookup and page source generation performance.
1921
1921
> Having these settings always different from their default values may sometimes significantly (especially in case of huge accessbility hierarchies) reduce xpath lookup and page source generation speed.
1922
1922
1923
-
> **Warning**
1923
+
> [!Warning]
1924
1924
> All items above are settings, not capabilities.
1925
1925
1926
1926
### ClassCastException: java.util.ArrayList$ListItr cannot be cast to org.eclipse.wst.xml.xpath2.processor
0 commit comments