appium-uiautomator2-driver 3.8.0 → 3.8.1

package/CHANGELOG.md

@@ -1,3 +1,9 @@
+## [3.8.1](https://github.com/appium/appium-uiautomator2-driver/compare/v3.8.0...v3.8.1) (2024-10-31)
+
+### Miscellaneous Chores
+
+* Bump android driver ([aeb5809](https://github.com/appium/appium-uiautomator2-driver/commit/aeb58092119ac58a7ff1c761332dd75f028f3e0a))
+
 ## [3.8.0](https://github.com/appium/appium-uiautomator2-driver/compare/v3.7.11...v3.8.0) (2024-09-17)
 
 ### Features

package/README.md

@@ -110,7 +110,7 @@ appium:skipLogcatCapture | Being set to `true` disables automatic logcat output
 appium:suppressKillServer | Being set to `true` prevents the driver from ever killing the ADB server explicitly. Could be useful if ADB is connected wirelessly. `false` by default
 appium:ignoreHiddenApiPolicyError | Being set to `true` ignores a failure while changing hidden API access policies to [enable access to non-SDK interfaces](https://developer.android.com/guide/app-compatibility/restrictions-non-sdk-interfaces#how_can_i_enable_access_to_non-sdk_interfaces). Could be useful on some devices, where access to these policies has been locked by its vendor. `false` by default.
 appium:hideKeyboard | Being set to `true` hides the on-screen keyboard while the session is running. Use it instead of the legacy `appium:unicodeKeyboard` one (which will be dropped in the future). This effect is achieved by assigning a custom "artificial" [input method](https://developer.android.com/develop/ui/views/touch-and-input/creating-input-method). Only use this feature for special/exploratory cases as it violates the way your application under test is normally interacted with by a human. Setting this capability explicitly to `false` enforces `adb shell ime reset` call on session startup, which resets the currently selected/enabled IMEs to the default ones as if the device is initially booted with the current locale. `undefined` by default.
-appium:mockLocationApp | Sets the package identifier of the app, which is used as a system mock location provider since Appium 1.18.0+. This capability has no effect on emulators. If the value is set to `null` or an empty string, then Appium will skip the mocked location provider setup procedure. Defaults to Appium Setting package identifier (`io.appium.settings`). Termination of a mock location provider application resets the mocked location data.
+appium:mockLocationApp | Sets the package identifier of the app, which is used as a system mock location provider since Appium 1.18.0+. This capability has no effect on emulators. If the value is set to `null` or an empty string, then the driver will reset the mocked location provider, e.g. the location won't be mocked anymore. Defaults to Appium Setting package identifier (`io.appium.settings`). Termination of a mock location provider application resets the mocked location data.
 appium:logcatFormat | The log print format, where `format` is one of: `brief` `process` `tag` `thread` `raw` `time` `threadtime` `long`. `threadtime` is the default value.
 appium:logcatFilterSpecs | Series of `tag[:priority]` where `tag` is a log component tag (or * for all) and priority is: `V    Verbose`, `D    Debug`, `I    Info`, `W    Warn`, `E    Error`, `F    Fatal`, `S    Silent (supress all output)`. '*' means '*:d' and `tag` by itself means `tag:v`. If not specified on the commandline, filterspec is set from ANDROID_LOG_TAGS. If no filterspec is found, filter defaults to '*:I'.
 appium:allowDelayAdb | Being set to `false` prevents emulator to use `-delay-adb` feature to detect its startup. See https://github.com/appium/appium/issues/14773 for more details.
@@ -243,7 +243,7 @@ xpath | For elements lookup Xpath strategy the driver uses the same XML tree tha
 > using them or plan to use them in the future.
 
 
-# BiDi Protocol Support
+## BiDi Protocol Support
 
 UIAutomator2 driver has partial support of the [BiDi Protocol](https://w3c.github.io/webdriver-bidi/) since version 3.7.10. Check the [Supported BiDi Commands And Events](./docs/bidi.md) document for more details.
 
@@ -1035,6 +1035,37 @@ Determine whether the device is locked.
 
 Either `true` or `false`
 
+### mobile: setGeolocation
+
+Sets emulated geolocation coordinates on the device under test.
+
+#### Arguments
+
+Name | Type | Required | Description | Example
+--- | --- | --- | --- | ---
+latitude | number | yes | [Latitude](https://en.wikipedia.org/wiki/Latitude) value | 32.456
+longitude | number | yes | [longitude](https://en.wikipedia.org/wiki/Longitude) value | 32.456
+altitude | number | no | [Altitude](https://en.wikipedia.org/wiki/Altitude) value. Zero by default | 5.678
+
+### mobile: getGeolocation
+
+Retrieves current geolocation coordinates from the device under test. If coordinates are mocked/emulated
+then these coordinates would be returned.
+
+#### Returned Result
+
+A map with the following entries:
+
+Name | Type | Description | Example
+--- | --- | --- | ---
+latitude | number | [Latitude](https://en.wikipedia.org/wiki/Latitude) value | 32.456
+longitude | number | [longitude](https://en.wikipedia.org/wiki/Longitude) value | 32.456
+altitude | number | [Altitude](https://en.wikipedia.org/wiki/Altitude) value | 5.678
+
+### mobile: resetGeolocation
+
+Resets mocked geolocation provider to the default/system one. Only works for real devices.
+
 ### mobile: refreshGpsCache
 
 Sends a request to refresh the GPS cache on the device under test.