io.appium.java_client.android

Class AndroidDriver<RequiredElementType extends org.openqa.selenium.WebElement>

java.lang.Object

org.openqa.selenium.remote.RemoteWebDriver

io.appium.java_client.AppiumDriver<RequiredElementType>

io.appium.java_client.android.AndroidDriver<RequiredElementType>

Type Parameters:

RequiredElementType - the required type of class which implement WebElement. Instances of the defined type will be returned via findElement* and findElements*. Warning (!!!). Allowed types: WebElement TouchableElement RemoteWebElement MobileElement AndroidElement

All Implemented Interfaces:

AndroidDeviceActionShortcuts, HasNetworkConnection, PushesFiles, StartsActivity, DeviceActionShortcuts, FindsByAccessibilityId<org.openqa.selenium.WebElement>, FindsByAndroidUIAutomator<RequiredElementType>, GenericFindsByClassName<RequiredElementType>, GenericFindsByCssSelector<RequiredElementType>, GenericFindsById<RequiredElementType>, GenericFindsByLinkText<RequiredElementType>, GenericFindsByName<RequiredElementType>, GenericFindsByTagName<RequiredElementType>, GenericFindsByXPath<RequiredElementType>, GenericSearchContext<RequiredElementType>, HasAppStrings, InteractsWithApps, InteractsWithFiles, MobileDriver, PerformsTouchActions, ScrollsTo<org.openqa.selenium.WebElement>, TouchShortcuts, org.openqa.selenium.ContextAware, org.openqa.selenium.HasCapabilities, org.openqa.selenium.html5.LocationContext, org.openqa.selenium.interactions.HasInputDevices, org.openqa.selenium.internal.FindsByClassName, org.openqa.selenium.internal.FindsByCssSelector, org.openqa.selenium.internal.FindsById, org.openqa.selenium.internal.FindsByLinkText, org.openqa.selenium.internal.FindsByName, org.openqa.selenium.internal.FindsByTagName, org.openqa.selenium.internal.FindsByXPath, org.openqa.selenium.JavascriptExecutor, org.openqa.selenium.Rotatable, org.openqa.selenium.SearchContext, org.openqa.selenium.TakesScreenshot, org.openqa.selenium.WebDriver

public class AndroidDriver<RequiredElementType extends org.openqa.selenium.WebElement>
extends AppiumDriver<RequiredElementType>
implements AndroidDeviceActionShortcuts, HasNetworkConnection, PushesFiles, StartsActivity, FindsByAndroidUIAutomator<RequiredElementType>

Nested Class Summary

Nested classes/interfaces inherited from class org.openqa.selenium.remote.RemoteWebDriver

org.openqa.selenium.remote.RemoteWebDriver.RemoteTargetLocator, org.openqa.selenium.remote.RemoteWebDriver.RemoteWebDriverOptions, org.openqa.selenium.remote.RemoteWebDriver.When

Nested classes/interfaces inherited from interface org.openqa.selenium.WebDriver

org.openqa.selenium.WebDriver.ImeHandler, org.openqa.selenium.WebDriver.Navigation, org.openqa.selenium.WebDriver.Options, org.openqa.selenium.WebDriver.TargetLocator, org.openqa.selenium.WebDriver.Timeouts, org.openqa.selenium.WebDriver.Window

Field Summary

Fields inherited from class io.appium.java_client.AppiumDriver

KEY_CODE, PATH

Constructor Summary

Constructors

Constructor and Description
AndroidDriver(AppiumDriverLocalService service, org.openqa.selenium.Capabilities desiredCapabilities)
AndroidDriver(AppiumDriverLocalService service, org.openqa.selenium.remote.http.HttpClient.Factory httpClientFactory, org.openqa.selenium.Capabilities desiredCapabilities)
AndroidDriver(AppiumServiceBuilder builder, org.openqa.selenium.Capabilities desiredCapabilities)
AndroidDriver(AppiumServiceBuilder builder, org.openqa.selenium.remote.http.HttpClient.Factory httpClientFactory, org.openqa.selenium.Capabilities desiredCapabilities)
AndroidDriver(org.openqa.selenium.Capabilities desiredCapabilities)
AndroidDriver(org.openqa.selenium.remote.http.HttpClient.Factory httpClientFactory, org.openqa.selenium.Capabilities desiredCapabilities)
AndroidDriver(URL remoteAddress, org.openqa.selenium.Capabilities desiredCapabilities)
AndroidDriver(URL remoteAddress, org.openqa.selenium.remote.http.HttpClient.Factory httpClientFactory, org.openqa.selenium.Capabilities desiredCapabilities)

Method Summary

Methods

Modifier and Type	Method and Description
String	currentActivity() Get the current activity being run on the mobile device
void	endTestCoverage(String intent, String path) Get test-coverage data
org.openqa.selenium.remote.Response	execute(String driverCommand, Map<String,?> parameters)
T	findElement(org.openqa.selenium.By by)
T	findElementByAccessibilityId(String using)
RequiredElementType	findElementByAndroidUIAutomator(String using)
T	findElementByClassName(String using)
T	findElementByCssSelector(String using)
T	findElementById(String id)
T	findElementByLinkText(String using)
T	findElementByName(String using)
T	findElementByPartialLinkText(String using)
T	findElementByTagName(String using)
T	findElementByXPath(String using)
List<RequiredElementType>	findElementsByAndroidUIAutomator(String using)
org.openqa.selenium.interactions.Mouse	getMouse() Deprecated.
NetworkConnectionSetting	getNetworkConnection() Get the current network settings of the device.
void	ignoreUnimportantViews(Boolean compress) Set the `ignoreUnimportantViews` setting.
boolean	isLocked() Check if the device is locked.
void	lockDevice() This method locks a device.
void	longPressKeyCode(int key) Send a long key event to the device
void	longPressKeyCode(int key, Integer metastate) Send a long key event along with an Android metastate to an Android device Metastates are things like *shift* to get uppercase characters
void	openNotifications() Open the notification shade, on Android devices.
void	pressKeyCode(int key) Send a key event to the device
void	pressKeyCode(int key, Integer metastate) Send a key event along with an Android metastate to an Android device Metastates are things like *shift* to get uppercase characters
void	pushFile(String remotePath, byte[] base64Data) Save base64 encoded data as a file on the remote mobile device.
RequiredElementType	scrollTo(String text) Scroll to an element which contains the given text.
RequiredElementType	scrollToExact(String text) Scroll to an element with the given text.
void	setNetworkConnection(NetworkConnectionSetting connection) Set the network connection of the device.
void	startActivity(String appPackage, String appActivity) This method should start arbitrary activity during a test.
void	startActivity(String appPackage, String appActivity, String appWaitPackage, String appWaitActivity) This method should start arbitrary activity during a test.
void	startActivity(String appPackage, String appActivity, String appWaitPackage, String appWaitActivity, boolean stopApp) This method should start arbitrary activity during a test.
void	toggleLocationServices()
void	unlockDevice() This method unlocks a device.

Methods inherited from class io.appium.java_client.AppiumDriver

_isNotNullOrEmpty, _isNotNullOrEmpty, closeApp, context, execute, findElements, findElementsByAccessibilityId, findElementsByClassName, findElementsByCssSelector, findElementsById, findElementsByLinkText, findElementsByName, findElementsByPartialLinkText, findElementsByTagName, findElementsByXPath, getAppStringMap, getAppStringMap, getAppStringMap, getAppStrings, getAppStrings, getCommandImmutableMap, getCommandImmutableMap, getContext, getContextHandles, getDeviceTime, getExecuteMethod, getOrientation, getRemoteAddress, getSettings, hideKeyboard, installApp, isAppInstalled, launchApp, location, lockScreen, performMultiTouchAction, performTouchAction, pinch, pinch, pullFile, pullFolder, removeApp, resetApp, rotate, runAppInBackground, setLocation, setSetting, substituteMobilePlatform, swipe, tap, tap, zoom, zoom

Methods inherited from class org.openqa.selenium.remote.RemoteWebDriver

close, executeAsyncScript, executeScript, findElement, findElements, get, getCapabilities, getCommandExecutor, getCurrentUrl, getElementConverter, getErrorHandler, getFileDetector, getKeyboard, getPageSource, getScreenshotAs, getSessionId, getTitle, getW3CStandardComplianceLevel, getWindowHandle, getWindowHandles, log, manage, navigate, quit, setCommandExecutor, setElementConverter, setErrorHandler, setFileDetector, setFoundBy, setLogLevel, setSessionId, startClient, startSession, startSession, stopClient, switchTo, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface io.appium.java_client.DeviceActionShortcuts

getDeviceTime, hideKeyboard

Methods inherited from interface io.appium.java_client.InteractsWithFiles

pullFile, pullFolder

Methods inherited from interface org.openqa.selenium.WebDriver

close, get, getCurrentUrl, getPageSource, getTitle, getWindowHandle, getWindowHandles, manage, navigate, quit, switchTo

Constructor Detail

AndroidDriver

public AndroidDriver(URL remoteAddress,
             org.openqa.selenium.Capabilities desiredCapabilities)

AndroidDriver

public AndroidDriver(URL remoteAddress,
             org.openqa.selenium.remote.http.HttpClient.Factory httpClientFactory,
             org.openqa.selenium.Capabilities desiredCapabilities)

AndroidDriver

public AndroidDriver(AppiumDriverLocalService service,
             org.openqa.selenium.Capabilities desiredCapabilities)

AndroidDriver

public AndroidDriver(AppiumDriverLocalService service,
             org.openqa.selenium.remote.http.HttpClient.Factory httpClientFactory,
             org.openqa.selenium.Capabilities desiredCapabilities)

AndroidDriver

public AndroidDriver(AppiumServiceBuilder builder,
             org.openqa.selenium.Capabilities desiredCapabilities)

AndroidDriver

public AndroidDriver(AppiumServiceBuilder builder,
             org.openqa.selenium.remote.http.HttpClient.Factory httpClientFactory,
             org.openqa.selenium.Capabilities desiredCapabilities)

AndroidDriver

public AndroidDriver(org.openqa.selenium.remote.http.HttpClient.Factory httpClientFactory,
             org.openqa.selenium.Capabilities desiredCapabilities)

AndroidDriver

public AndroidDriver(org.openqa.selenium.Capabilities desiredCapabilities)

Method Detail

scrollTo

public RequiredElementType scrollTo(String text)

Description copied from interface: ScrollsTo

Scroll to an element which contains the given text.

Specified by:

scrollTo in interface ScrollsTo<org.openqa.selenium.WebElement>

Specified by:

scrollTo in class AppiumDriver<RequiredElementType extends org.openqa.selenium.WebElement>

Parameters:

text - description or text of an element scroll to

Returns:

an element that matches

scrollToExact

public RequiredElementType scrollToExact(String text)

Description copied from interface: ScrollsTo

Scroll to an element with the given text.

Specified by:

scrollToExact in interface ScrollsTo<org.openqa.selenium.WebElement>

Specified by:

scrollToExact in class AppiumDriver<RequiredElementType extends org.openqa.selenium.WebElement>

Parameters:

text - description or text of an element scroll to

Returns:

an element that matches

pressKeyCode

public void pressKeyCode(int key)

Send a key event to the device

Specified by:

pressKeyCode in interface AndroidDeviceActionShortcuts

Parameters:

key - code for the key pressed on the device

pressKeyCode

public void pressKeyCode(int key,
                Integer metastate)

Description copied from interface: AndroidDeviceActionShortcuts

Send a key event along with an Android metastate to an Android device Metastates are things like *shift* to get uppercase characters

Specified by:

pressKeyCode in interface AndroidDeviceActionShortcuts

Parameters:

key - code for the key pressed on the Android device

metastate - metastate for the keypress

See Also:

AndroidKeyCode, AndroidKeyMetastate, AndroidDeviceActionShortcuts.pressKeyCode(int, Integer)

longPressKeyCode

public void longPressKeyCode(int key)

Send a long key event to the device

Specified by:

longPressKeyCode in interface AndroidDeviceActionShortcuts

Parameters:

key - code for the long key pressed on the device

longPressKeyCode

public void longPressKeyCode(int key,
                    Integer metastate)

Description copied from interface: AndroidDeviceActionShortcuts

Send a long key event along with an Android metastate to an Android device Metastates are things like *shift* to get uppercase characters

Specified by:

longPressKeyCode in interface AndroidDeviceActionShortcuts

Parameters:

key - code for the long key pressed on the Android device

metastate - metastate for the long key press

See Also:

AndroidKeyCode, AndroidKeyMetastate, AndroidDeviceActionShortcuts.pressKeyCode(int, Integer)

getNetworkConnection

public NetworkConnectionSetting getNetworkConnection()

Description copied from interface: HasNetworkConnection

Get the current network settings of the device.

Specified by:

getNetworkConnection in interface HasNetworkConnection

Returns:

NetworkConnectionSetting objects will let you inspect the status of AirplaneMode, Wifi, Data connections

See Also:

HasNetworkConnection.getNetworkConnection()

setNetworkConnection

public void setNetworkConnection(NetworkConnectionSetting connection)

Description copied from interface: HasNetworkConnection

Set the network connection of the device. This is an Android-only method

Specified by:

setNetworkConnection in interface HasNetworkConnection

Parameters:

connection - The NetworkConnectionSetting configuration to use for the device

See Also:

HasNetworkConnection.setNetworkConnection(NetworkConnectionSetting)

pushFile

public void pushFile(String remotePath,
            byte[] base64Data)

Description copied from interface: PushesFiles

Save base64 encoded data as a file on the remote mobile device.

Specified by:

pushFile in interface PushesFiles

Parameters:

remotePath - Path to file to write data to on remote device

base64Data - Base64 encoded byte array of data to write to remote device

See Also:

PushesFiles.pushFile(String, byte[])

startActivity

public void startActivity(String appPackage,
                 String appActivity,
                 String appWaitPackage,
                 String appWaitActivity,
                 boolean stopApp)
                   throws IllegalArgumentException

Description copied from interface: StartsActivity

This method should start arbitrary activity during a test. If the activity belongs to another application, that application is started and the activity is opened.

Specified by:

startActivity in interface StartsActivity

Parameters:

appPackage - The package containing the activity. [Required]

appActivity - The activity to start. [Required]

appWaitPackage - Automation will begin after this package starts. [Optional]

appWaitActivity - Automation will begin after this activity starts. [Optional]

stopApp - If true, target app will be stopped. [Optional]

Throws:

IllegalArgumentException

See Also:

StartsActivity.startActivity(String, String, String, String)

startActivity

public void startActivity(String appPackage,
                 String appActivity,
                 String appWaitPackage,
                 String appWaitActivity)
                   throws IllegalArgumentException

Description copied from interface: StartsActivity

This method should start arbitrary activity during a test. If the activity belongs to another application, that application is started and the activity is opened.

Specified by:

startActivity in interface StartsActivity

Parameters:

appPackage - The package containing the activity. [Required]

appActivity - The activity to start. [Required]

appWaitPackage - Automation will begin after this package starts. [Optional]

appWaitActivity - Automation will begin after this activity starts. [Optional]

Throws:

IllegalArgumentException

See Also:

StartsActivity.startActivity(String, String, String, String)

startActivity

public void startActivity(String appPackage,
                 String appActivity)
                   throws IllegalArgumentException

Description copied from interface: StartsActivity

This method should start arbitrary activity during a test. If the activity belongs to another application, that application is started and the activity is opened.

Specified by:

startActivity in interface StartsActivity

Parameters:

appPackage - The package containing the activity. [Required]

appActivity - The activity to start. [Required]

Throws:

IllegalArgumentException

See Also:

StartsActivity.startActivity(String, String)

endTestCoverage

public void endTestCoverage(String intent,
                   String path)

Get test-coverage data

Parameters:

intent - intent to broadcast

path - path to .ec file

currentActivity

public String currentActivity()

Get the current activity being run on the mobile device

Returns:

a current activity being run on the mobile device

openNotifications

public void openNotifications()

Open the notification shade, on Android devices.

isLocked

public boolean isLocked()

Check if the device is locked.

Returns:

true if device is locked. False otherwise

toggleLocationServices

public void toggleLocationServices()

ignoreUnimportantViews

public void ignoreUnimportantViews(Boolean compress)

Set the `ignoreUnimportantViews` setting. *Android-only method*

Sets whether Android devices should use `setCompressedLayoutHeirarchy()` which ignores all views which are marked IMPORTANT_FOR_ACCESSIBILITY_NO or IMPORTANT_FOR_ACCESSIBILITY_AUTO (and have been deemed not important by the system), in an attempt to make things less confusing or faster.

Parameters:

compress - ignores unimportant views if true, doesn't ignore otherwise.

findElementByAndroidUIAutomator

public RequiredElementType findElementByAndroidUIAutomator(String using)
                                                                                           throws org.openqa.selenium.WebDriverException

Specified by:

findElementByAndroidUIAutomator in interface FindsByAndroidUIAutomator<RequiredElementType extends org.openqa.selenium.WebElement>

Throws:

org.openqa.selenium.WebDriverException - This method is not applicable with browser/webview UI.

findElementsByAndroidUIAutomator

public List<RequiredElementType> findElementsByAndroidUIAutomator(String using)
                                                                                                  throws org.openqa.selenium.WebDriverException

Specified by:

findElementsByAndroidUIAutomator in interface FindsByAndroidUIAutomator<RequiredElementType extends org.openqa.selenium.WebElement>

Throws:

org.openqa.selenium.WebDriverException - This method is not applicable with browser/webview UI.

lockDevice

public void lockDevice()

This method locks a device.

unlockDevice

public void unlockDevice()

This method unlocks a device.

execute

public org.openqa.selenium.remote.Response execute(String driverCommand,
                                          Map<String,?> parameters)

Specified by:

execute in interface MobileDriver

Overrides:

execute in class org.openqa.selenium.remote.RemoteWebDriver

findElement

public T findElement(org.openqa.selenium.By by)

Specified by:

findElement in interface GenericSearchContext<T extends org.openqa.selenium.WebElement>

Specified by:

findElement in interface org.openqa.selenium.SearchContext

Specified by:

findElement in interface org.openqa.selenium.WebDriver

Overrides:

findElement in class org.openqa.selenium.remote.RemoteWebDriver

findElementById

public T findElementById(String id)

Specified by:

findElementById in interface GenericFindsById<T extends org.openqa.selenium.WebElement>

Specified by:

findElementById in interface org.openqa.selenium.internal.FindsById

Overrides:

findElementById in class org.openqa.selenium.remote.RemoteWebDriver

findElementByLinkText

public T findElementByLinkText(String using)
                                                               throws org.openqa.selenium.WebDriverException

Specified by:

findElementByLinkText in interface GenericFindsByLinkText<T extends org.openqa.selenium.WebElement>

Specified by:

findElementByLinkText in interface org.openqa.selenium.internal.FindsByLinkText

Overrides:

findElementByLinkText in class org.openqa.selenium.remote.RemoteWebDriver

Throws:

org.openqa.selenium.WebDriverException - his method doesn't work against native app UI.

findElementByPartialLinkText

public T findElementByPartialLinkText(String using)
                                                                      throws org.openqa.selenium.WebDriverException

Specified by:

findElementByPartialLinkText in interface GenericFindsByLinkText<T extends org.openqa.selenium.WebElement>

Specified by:

findElementByPartialLinkText in interface org.openqa.selenium.internal.FindsByLinkText

Overrides:

findElementByPartialLinkText in class org.openqa.selenium.remote.RemoteWebDriver

Throws:

org.openqa.selenium.WebDriverException - his method doesn't work against native app UI.

findElementByTagName

public T findElementByTagName(String using)

Specified by:

findElementByTagName in interface GenericFindsByTagName<T extends org.openqa.selenium.WebElement>

Specified by:

findElementByTagName in interface org.openqa.selenium.internal.FindsByTagName

Overrides:

findElementByTagName in class org.openqa.selenium.remote.RemoteWebDriver

findElementByName

public T findElementByName(String using)

Specified by:

findElementByName in interface GenericFindsByName<T extends org.openqa.selenium.WebElement>

Specified by:

findElementByName in interface org.openqa.selenium.internal.FindsByName

Overrides:

findElementByName in class org.openqa.selenium.remote.RemoteWebDriver

findElementByClassName

public T findElementByClassName(String using)

Specified by:

findElementByClassName in interface GenericFindsByClassName<T extends org.openqa.selenium.WebElement>

Specified by:

findElementByClassName in interface org.openqa.selenium.internal.FindsByClassName

Overrides:

findElementByClassName in class org.openqa.selenium.remote.RemoteWebDriver

findElementByCssSelector

public T findElementByCssSelector(String using)
                                                                  throws org.openqa.selenium.WebDriverException

Specified by:

findElementByCssSelector in interface GenericFindsByCssSelector<T extends org.openqa.selenium.WebElement>

Specified by:

findElementByCssSelector in interface org.openqa.selenium.internal.FindsByCssSelector

Overrides:

findElementByCssSelector in class org.openqa.selenium.remote.RemoteWebDriver

Throws:

org.openqa.selenium.WebDriverException - his method doesn't work against native app UI.

findElementByXPath

public T findElementByXPath(String using)

Specified by:

findElementByXPath in interface GenericFindsByXPath<T extends org.openqa.selenium.WebElement>

Specified by:

findElementByXPath in interface org.openqa.selenium.internal.FindsByXPath

Overrides:

findElementByXPath in class org.openqa.selenium.remote.RemoteWebDriver

findElementByAccessibilityId

public T findElementByAccessibilityId(String using)
                                                                      throws org.openqa.selenium.WebDriverException

Specified by:

findElementByAccessibilityId in interface FindsByAccessibilityId<org.openqa.selenium.WebElement>

Throws:

org.openqa.selenium.WebDriverException

getMouse

@Deprecated
public org.openqa.selenium.interactions.Mouse getMouse()

Deprecated.

Mouse doesn't work on mobile devices and emulators

Specified by:

getMouse in interface org.openqa.selenium.interactions.HasInputDevices

Overrides:

getMouse in class org.openqa.selenium.remote.RemoteWebDriver