io.appium.java_client.android

Class AndroidDriver<T extends WebElement>

java.lang.Object

org.openqa.selenium.remote.RemoteWebDriver

io.appium.java_client.AppiumDriver<T>

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

Type Parameters:

T - 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<T>, FindsByAndroidUIAutomator<T>, HasAppStrings, InteractsWithApps, InteractsWithFiles, MobileDriver<T>, PerformsTouchActions, TouchShortcuts, org.openqa.selenium.ContextAware, org.openqa.selenium.HasCapabilities, org.openqa.selenium.html5.LocationContext, org.openqa.selenium.interactions.HasInputDevices, FindsByClassName, FindsByCssSelector, FindsById, FindsByLinkText, FindsByName, FindsByTagName, FindsByXPath, org.openqa.selenium.JavascriptExecutor, org.openqa.selenium.Rotatable, SearchContext, org.openqa.selenium.TakesScreenshot, WebDriver

public class AndroidDriver<T extends WebElement>
extends AppiumDriver<T>
implements AndroidDeviceActionShortcuts, HasNetworkConnection, PushesFiles, StartsActivity, FindsByAndroidUIAutomator<T>

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

WebDriver.ImeHandler, WebDriver.Navigation, WebDriver.Options, WebDriver.TargetLocator, WebDriver.Timeouts, WebDriver.Window

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(org.openqa.selenium.remote.HttpCommandExecutor executor, org.openqa.selenium.Capabilities capabilities)
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) Find the first WebElement using the given method.
T	findElement(String by, String using)
T	findElementByAccessibilityId(String using)
T	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<T>	findElementsByAndroidUIAutomator(String using)
Connection	getConnection() Get the current network settings of the device.
org.openqa.selenium.interactions.Mouse	getMouse() Deprecated.
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.
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.
void	pushFile(String remotePath, byte[] base64Data) Saves base64 encoded data as a file on the remote mobile device.
void	pushFile(String remotePath, File file) Saves given file as a file on the remote mobile device.
void	setConnection(Connection 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	startActivity(String appPackage, String appActivity, String appWaitPackage, String appWaitActivity, String intentAction, String intentCategory, String intentFlags, String intentOptionalArgs) This method should start arbitrary activity during a test.
void	startActivity(String appPackage, String appActivity, String appWaitPackage, String appWaitActivity, String intentAction, String intentCategory, String intentFlags, String optionalIntentArguments, boolean stopApp) This method should start arbitrary activity during a test.
void	swipe(int startx, int starty, int endx, int endy, int duration) Convenience method for swiping across the screen.
void	toggleLocationServices()
void	unlockDevice() This method unlocks a device.

Methods inherited from class io.appium.java_client.AppiumDriver

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

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

close, executeAsyncScript, executeScript, 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(org.openqa.selenium.remote.HttpCommandExecutor executor,
             org.openqa.selenium.Capabilities capabilities)

Parameters:

executor - is an instance of HttpCommandExecutor or class that extends it. Default commands or another vendor-specific commands may be specified there.

capabilities - take a look at Capabilities

AndroidDriver

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

Parameters:

remoteAddress - is the address of remotely/locally started Appium server

desiredCapabilities - take a look at Capabilities

AndroidDriver

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

Parameters:

remoteAddress - is the address of remotely/locally started Appium server

httpClientFactory - take a look at HttpClient.Factory

desiredCapabilities - take a look at Capabilities

AndroidDriver

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

Parameters:

service - take a look at AppiumDriverLocalService

desiredCapabilities - take a look at Capabilities

AndroidDriver

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

Parameters:

service - take a look at AppiumDriverLocalService

httpClientFactory - take a look at HttpClient.Factory

desiredCapabilities - take a look at Capabilities

AndroidDriver

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

Parameters:

builder - take a look at AppiumServiceBuilder

desiredCapabilities - take a look at Capabilities

AndroidDriver

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

Parameters:

builder - take a look at AppiumServiceBuilder

httpClientFactory - take a look at HttpClient.Factory

desiredCapabilities - take a look at Capabilities

AndroidDriver

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

Parameters:

httpClientFactory - take a look at HttpClient.Factory

desiredCapabilities - take a look at Capabilities

AndroidDriver

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

Parameters:

desiredCapabilities - take a look at Capabilities

Method Detail

swipe

public void swipe(int startx,
         int starty,
         int endx,
         int endy,
         int duration)

Description copied from interface: TouchShortcuts

Convenience method for swiping across the screen.

Specified by:

swipe in interface TouchShortcuts

Specified by:

swipe in class AppiumDriver<T extends WebElement>

Parameters:

startx - starting x coordinate.

starty - starting y coordinate.

endx - ending x coordinate.

endy - ending y coordinate.

duration - amount of time in milliseconds for the entire swipe action to take

See Also:

TouchShortcuts.swipe(int, int, int, int, int)

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)

setConnection

public void setConnection(Connection connection)

Description copied from interface: HasNetworkConnection

Set the network connection of the device.

Specified by:

setConnection in interface HasNetworkConnection

Parameters:

connection - The bitmask of the desired connection

getConnection

public Connection getConnection()

Description copied from interface: HasNetworkConnection

Get the current network settings of the device.

Specified by:

getConnection in interface HasNetworkConnection

Returns:

Connection object will let you inspect the status of None, AirplaneMode, Wifi, Data and All connections

pushFile

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

Description copied from interface: PushesFiles

Saves 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

pushFile

public void pushFile(String remotePath,
            File file)
              throws IOException

Description copied from interface: PushesFiles

Saves given file 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

file - is a file to write to remote device

Throws:

IOException - when there are problems with a file or current file system

startActivity

public void startActivity(String appPackage,
                 String appActivity,
                 String appWaitPackage,
                 String appWaitActivity,
                 String intentAction,
                 String intentCategory,
                 String intentFlags,
                 String optionalIntentArguments,
                 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]

intentAction - Intent action which will be used to start activity [Optional]

intentCategory - Intent category which will be used to start activity [Optional]

intentFlags - Flags that will be used to start activity [Optional]

optionalIntentArguments - Additional intent arguments that will be used to start activity [Optional]

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

Throws:

IllegalArgumentException

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

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

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

startActivity

public void startActivity(String appPackage,
                 String appActivity,
                 String appWaitPackage,
                 String appWaitActivity,
                 String intentAction,
                 String intentCategory,
                 String intentFlags,
                 String intentOptionalArgs)
                   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]

intentAction - Intent action which will be used to start activity [Optional]

intentCategory - Intent category which will be used to start activity [Optional]

intentFlags - Flags that will be used to start activity [Optional]

intentOptionalArgs - Additional intent arguments that will be used to start activity [Optional]

Throws:

IllegalArgumentException

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 T findElementByAndroidUIAutomator(String using)
                                                     throws org.openqa.selenium.WebDriverException

Specified by:

findElementByAndroidUIAutomator in interface FindsByAndroidUIAutomator<T extends WebElement>

Throws:

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

findElementsByAndroidUIAutomator

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

Specified by:

findElementsByAndroidUIAutomator in interface FindsByAndroidUIAutomator<T extends 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<T extends WebElement>

Overrides:

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

findElement

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

Description copied from interface: WebDriver

Find the first WebElement using the given method. This method is affected by the 'implicit wait' times in force at the time of execution. The findElement(..) invocation will return a matching row, or try again repeatedly until the configured timeout is reached.

findElement should not be used to look for non-present elements, use WebDriver.findElements(By) and assert zero length response instead.

Specified by:

findElement in interface MobileDriver<T extends WebElement>

Specified by:

findElement in interface SearchContext

Specified by:

findElement in interface WebDriver

Overrides:

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

Parameters:

by - The locating mechanism

Returns:

The first matching element on the current page

See Also:

By, WebDriver.Timeouts

findElement

public T findElement(String by,
            String using)

Overrides:

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

findElementById

public T findElementById(String id)

Specified by:

findElementById in interface MobileDriver<T extends WebElement>

Specified by:

findElementById in interface 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 MobileDriver<T extends WebElement>

Specified by:

findElementByLinkText in interface 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 MobileDriver<T extends WebElement>

Specified by:

findElementByPartialLinkText in interface 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 MobileDriver<T extends WebElement>

Specified by:

findElementByTagName in interface FindsByTagName

Overrides:

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

findElementByName

public T findElementByName(String using)

Specified by:

findElementByName in interface MobileDriver<T extends WebElement>

Specified by:

findElementByName in interface FindsByName

Overrides:

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

findElementByClassName

public T findElementByClassName(String using)

Specified by:

findElementByClassName in interface MobileDriver<T extends WebElement>

Specified by:

findElementByClassName in interface 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 MobileDriver<T extends WebElement>

Specified by:

findElementByCssSelector in interface 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 MobileDriver<T extends WebElement>

Specified by:

findElementByXPath in interface 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<T extends WebElement>

Throws:

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

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