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 RemoteWebElement MobileElement AndroidElement

All Implemented Interfaces:

AuthenticatesByFinger, HasNetworkConnection, HasAndroidClipboard, HasAndroidDeviceDetails, HasSupportedPerformanceDataType, ListensToLogcatMessages, PressesKey, PushesFiles, StartsActivity, SupportsNetworkStateManagement, SupportsSpecialEmulatorCommands, HasBattery<AndroidBatteryInfo>, HasClipboard, ComparesImages, ExecutesMethod, FindsByAccessibilityId<T>, FindsByAndroidUIAutomator<T>, FindsByFluentSelector<T>, HasAppStrings, HasDeviceTime, HasOnScreenKeyboard, HasSessionDetails, HidesKeyboard, InteractsWithApps, InteractsWithFiles, LocksDevice, MobileDriver<T>, PerformsTouchActions, CanRecordScreen, org.openqa.selenium.ContextAware, org.openqa.selenium.HasCapabilities, org.openqa.selenium.html5.LocationContext, org.openqa.selenium.interactions.HasInputDevices, org.openqa.selenium.interactions.Interactive, 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 PressesKey, HasNetworkConnection, PushesFiles, StartsActivity, FindsByAndroidUIAutomator<T>, LocksDevice, HasAndroidDeviceDetails, HasSupportedPerformanceDataType, AuthenticatesByFinger, HasOnScreenKeyboard, CanRecordScreen, SupportsSpecialEmulatorCommands, SupportsNetworkStateManagement, ListensToLogcatMessages, HasAndroidClipboard, HasBattery<AndroidBatteryInfo>

Android driver implementation.

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) Creates a new instance based on Appium driver local service and capabilities.
AndroidDriver(AppiumDriverLocalService service, org.openqa.selenium.remote.http.HttpClient.Factory httpClientFactory, org.openqa.selenium.Capabilities desiredCapabilities) Creates a new instance based on Appium driver local service, HTTP client factory and capabilities.
AndroidDriver(AppiumServiceBuilder builder, org.openqa.selenium.Capabilities desiredCapabilities) Creates a new instance based on Appium service builder and capabilities.
AndroidDriver(AppiumServiceBuilder builder, org.openqa.selenium.remote.http.HttpClient.Factory httpClientFactory, org.openqa.selenium.Capabilities desiredCapabilities) Creates a new instance based on Appium service builder, HTTP client factory and capabilities.
AndroidDriver(org.openqa.selenium.Capabilities desiredCapabilities) Creates a new instance based on capabilities.
AndroidDriver(org.openqa.selenium.remote.http.HttpClient.Factory httpClientFactory, org.openqa.selenium.Capabilities desiredCapabilities) Creates a new instance based on HTTP client factory and capabilities.
AndroidDriver(org.openqa.selenium.remote.HttpCommandExecutor executor, org.openqa.selenium.Capabilities capabilities) Creates a new instance based on command executor and capabilities.
AndroidDriver(java.net.URL remoteAddress, org.openqa.selenium.Capabilities desiredCapabilities) Creates a new instance based on Appium server URL and capabilities.
AndroidDriver(java.net.URL remoteAddress, org.openqa.selenium.remote.http.HttpClient.Factory httpClientFactory, org.openqa.selenium.Capabilities desiredCapabilities) Creates a new instance based on Appium server URL, HTTP client factory and capabilities.

Method Summary

Modifier and Type	Method and Description
default void	configuratorSetActionAcknowledgmentTimeout(java.time.Duration timeout) invoke setActionAcknowledgmentTimeout in com.android.uiautomator.core.Configurator.
default void	configuratorSetKeyInjectionDelay(java.time.Duration delay) invoke configuratorSetKeyInjectionDelay in com.android.uiautomator.core.Configurator.
default void	configuratorSetScrollAcknowledgmentTimeout(java.time.Duration timeout) invoke setScrollAcknowledgmentTimeout in com.android.uiautomator.core.Configurator.
default void	configuratorSetWaitForIdleTimeout(java.time.Duration timeout) invoke setWaitForIdleTimeout in com.android.uiautomator.core.Configurator.
default void	configuratorSetWaitForSelectorTimeout(java.time.Duration timeout) invoke setWaitForSelectorTimeout in com.android.uiautomator.core.Configurator.
void	endTestCoverage(java.lang.String intent, java.lang.String path) Get test-coverage data.
org.openqa.selenium.remote.Response	execute(java.lang.String command) Executes JSONWP command and returns a response.
org.openqa.selenium.remote.Response	execute(java.lang.String driverCommand, java.util.Map<java.lang.String,?> parameters) Executes JSONWP command and returns a response.
T	findElement(org.openqa.selenium.By by) Find the first WebElement using the given method.
T	findElement(java.lang.String by, java.lang.String using) Method performs the searching for a single element by some selector defined by string and value of the given selector.
T	findElementByClassName(java.lang.String using)
T	findElementByCssSelector(java.lang.String using) Finds a single element by CSS selector.
T	findElementById(java.lang.String id)
T	findElementByLinkText(java.lang.String using) Finds a single element by link text.
T	findElementByName(java.lang.String using)
T	findElementByPartialLinkText(java.lang.String using) Finds a single element by partial link text.
T	findElementByTagName(java.lang.String using)
T	findElementByXPath(java.lang.String using)
AndroidBatteryInfo	getBatteryInfo() Retrieves battery info from the device under test.
org.openqa.selenium.Capabilities	getCapabilities() Returns capabilities that were provided on instantiation.
StringWebSocketClient	getLogcatClient()
org.openqa.selenium.interactions.Mouse	getMouse() Deprecated.
default void	ignoreUnimportantViews(java.lang.Boolean compress) Set the `ignoreUnimportantViews` setting.
void	openNotifications() Open the notification shade, on Android devices.
void	toggleLocationServices()
java.lang.String	toString()

Methods inherited from class io.appium.java_client.AppiumDriver

context, findElements, findElements, findElementsByAccessibilityId, findElementsByClassName, findElementsByCssSelector, findElementsById, findElementsByLinkText, findElementsByName, findElementsByPartialLinkText, findElementsByTagName, findElementsByXPath, getContext, getContextHandles, getExecuteMethod, getOrientation, getRemoteAddress, isBrowser, location, rotate, rotate, rotation, setLocation, substituteMobilePlatform

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

close, executeAsyncScript, executeScript, get, getCommandExecutor, getCurrentUrl, getElementConverter, getErrorHandler, getFileDetector, getKeyboard, getPageSource, getScreenshotAs, getSessionId, getTitle, getWindowHandle, getWindowHandles, log, manage, navigate, perform, quit, resetInputState, setCommandExecutor, setElementConverter, setErrorHandler, setFileDetector, setFoundBy, setLogLevel, setSessionId, startSession, switchTo

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.android.nativekey.PressesKey

longPressKey, longPressKeyCode, longPressKeyCode, pressKey, pressKeyCode, pressKeyCode

Methods inherited from interface io.appium.java_client.android.connection.HasNetworkConnection

getConnection, setConnection

Methods inherited from interface io.appium.java_client.android.PushesFiles

pushFile, pushFile

Methods inherited from interface io.appium.java_client.InteractsWithFiles

pullFile, pullFolder

Methods inherited from interface io.appium.java_client.android.StartsActivity

currentActivity, getCurrentPackage, startActivity

Methods inherited from interface io.appium.java_client.FindsByAndroidUIAutomator

findElementByAndroidUIAutomator, findElementsByAndroidUIAutomator

Methods inherited from interface io.appium.java_client.FindsByFluentSelector

findElement, findElements

Methods inherited from interface io.appium.java_client.LocksDevice

isDeviceLocked, lockDevice, lockDevice, unlockDevice

Methods inherited from interface io.appium.java_client.HasSettings

getSettings, setSetting

Methods inherited from interface io.appium.java_client.android.HasAndroidDeviceDetails

getDisplayDensity, getSystemBars

Methods inherited from interface io.appium.java_client.android.HasSupportedPerformanceDataType

getPerformanceData, getSupportedPerformanceDataTypes

Methods inherited from interface io.appium.java_client.android.AuthenticatesByFinger

fingerPrint

Methods inherited from interface io.appium.java_client.HasOnScreenKeyboard

isKeyboardShown

Methods inherited from interface io.appium.java_client.screenrecording.CanRecordScreen

startRecordingScreen, startRecordingScreen, stopRecordingScreen, stopRecordingScreen

Methods inherited from interface io.appium.java_client.android.SupportsSpecialEmulatorCommands

makeGsmCall, sendSMS, setGsmSignalStrength, setGsmVoice, setNetworkSpeed, setPowerAC, setPowerCapacity

Methods inherited from interface io.appium.java_client.android.SupportsNetworkStateManagement

toggleAirplaneMode, toggleData, toggleWifi

Methods inherited from interface io.appium.java_client.android.ListensToLogcatMessages

addLogcatConnectionListener, addLogcatDisconnectionListener, addLogcatErrorsListener, addLogcatMessagesListener, removeAllLogcatListeners, startLogcatBroadcast, startLogcatBroadcast, startLogcatBroadcast, stopLogcatBroadcast

Methods inherited from interface io.appium.java_client.android.HasAndroidClipboard

setClipboard, setClipboardText

Methods inherited from interface io.appium.java_client.clipboard.HasClipboard

getClipboard, getClipboardText, setClipboard, setClipboardText

Methods inherited from interface io.appium.java_client.ComparesImages

findImageOccurrence, findImageOccurrence, findImageOccurrence, findImageOccurrence, getImagesSimilarity, getImagesSimilarity, getImagesSimilarity, getImagesSimilarity, matchImagesFeatures, matchImagesFeatures, matchImagesFeatures, matchImagesFeatures

Methods inherited from interface org.openqa.selenium.WebDriver

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

Methods inherited from interface io.appium.java_client.PerformsTouchActions

performMultiTouchAction, performTouchAction

Methods inherited from interface io.appium.java_client.FindsByAccessibilityId

findElementByAccessibilityId

Methods inherited from interface io.appium.java_client.HidesKeyboard

hideKeyboard

Methods inherited from interface io.appium.java_client.HasDeviceTime

getDeviceTime, getDeviceTime

Methods inherited from interface io.appium.java_client.InteractsWithApps

activateApp, activateApp, closeApp, installApp, installApp, isAppInstalled, launchApp, queryAppState, removeApp, removeApp, resetApp, runAppInBackground, terminateApp, terminateApp

Methods inherited from interface io.appium.java_client.HasAppStrings

getAppStringMap, getAppStringMap, getAppStringMap

Methods inherited from interface io.appium.java_client.HasSessionDetails

getAutomationName, getPlatformName, getSessionDetail, getSessionDetails

Constructor Detail

AndroidDriver

public AndroidDriver(org.openqa.selenium.remote.HttpCommandExecutor executor,
                     org.openqa.selenium.Capabilities capabilities)

Creates a new instance based on command executor and 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(java.net.URL remoteAddress,
                     org.openqa.selenium.Capabilities desiredCapabilities)

Creates a new instance based on Appium server URL and capabilities.

Parameters:

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

desiredCapabilities - take a look at Capabilities

AndroidDriver

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

Creates a new instance based on Appium server URL, HTTP client factory and capabilities.

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)

Creates a new instance based on Appium driver local service and capabilities.

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)

Creates a new instance based on Appium driver local service, HTTP client factory and capabilities.

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)

Creates a new instance based on Appium service builder and capabilities.

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)

Creates a new instance based on Appium service builder, HTTP client factory and capabilities.

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)

Creates a new instance based on HTTP client factory and capabilities.

Parameters:

httpClientFactory - take a look at HttpClient.Factory

desiredCapabilities - take a look at Capabilities

AndroidDriver

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

Creates a new instance based on capabilities.

Parameters:

desiredCapabilities - take a look at Capabilities

Method Detail

endTestCoverage

public void endTestCoverage(java.lang.String intent,
                            java.lang.String path)

Get test-coverage data.

Parameters:

intent - intent to broadcast.

path - path to .ec file.

openNotifications

public void openNotifications()

Open the notification shade, on Android devices.

toggleLocationServices

public void toggleLocationServices()

getBatteryInfo

public AndroidBatteryInfo getBatteryInfo()

Description copied from interface: HasBattery

Retrieves battery info from the device under test.

Specified by:

getBatteryInfo in interface HasBattery<AndroidBatteryInfo>

Returns:

BatteryInfo instance, containing the battery information

getCapabilities

public org.openqa.selenium.Capabilities getCapabilities()

Returns capabilities that were provided on instantiation.

Specified by:

getCapabilities in interface org.openqa.selenium.HasCapabilities

Overrides:

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

Returns:

given Capabilities

getLogcatClient

public StringWebSocketClient getLogcatClient()

Specified by:

getLogcatClient in interface ListensToLogcatMessages

ignoreUnimportantViews

public void ignoreUnimportantViews(java.lang.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.

configuratorSetWaitForIdleTimeout

public void configuratorSetWaitForIdleTimeout(java.time.Duration timeout)

invoke setWaitForIdleTimeout in com.android.uiautomator.core.Configurator.

Parameters:

timeout - A negative value would reset to its default value. Minimum time unit resolution is one millisecond

configuratorSetWaitForSelectorTimeout

public void configuratorSetWaitForSelectorTimeout(java.time.Duration timeout)

invoke setWaitForSelectorTimeout in com.android.uiautomator.core.Configurator.

Parameters:

timeout - A negative value would reset to its default value. Minimum time unit resolution is one millisecond

configuratorSetScrollAcknowledgmentTimeout

public void configuratorSetScrollAcknowledgmentTimeout(java.time.Duration timeout)

invoke setScrollAcknowledgmentTimeout in com.android.uiautomator.core.Configurator.

Parameters:

timeout - A negative value would reset to its default value. Minimum time unit resolution is one millisecond

configuratorSetKeyInjectionDelay

public void configuratorSetKeyInjectionDelay(java.time.Duration delay)

invoke configuratorSetKeyInjectionDelay in com.android.uiautomator.core.Configurator.

Parameters:

delay - A negative value would reset to its default value. Minimum time unit resolution is one millisecond

configuratorSetActionAcknowledgmentTimeout

public void configuratorSetActionAcknowledgmentTimeout(java.time.Duration timeout)

invoke setActionAcknowledgmentTimeout in com.android.uiautomator.core.Configurator.

Parameters:

timeout - A negative value would reset to its default value. Minimum time unit resolution is one millisecond

execute

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

Description copied from interface: ExecutesMethod

Executes JSONWP command and returns a response.

Specified by:

execute in interface ExecutesMethod

Overrides:

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

Parameters:

driverCommand - a JSONWP command

parameters - map of command parameters

Returns:

a result response

execute

public org.openqa.selenium.remote.Response execute(java.lang.String command)

Description copied from interface: ExecutesMethod

Executes JSONWP command and returns a response.

Specified by:

execute in interface ExecutesMethod

Overrides:

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

Parameters:

command - a JSONWP command

Returns:

a result response

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(java.lang.String by,
                     java.lang.String using)

Description copied from interface: FindsByFluentSelector

Method performs the searching for a single element by some selector defined by string and value of the given selector.

Specified by:

findElement in interface FindsByFluentSelector<T extends WebElement>

Overrides:

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

Parameters:

by - is a string selector

using - is a value of the given selector

Returns:

the first found element

findElementById

public T findElementById(java.lang.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(java.lang.String using)
                        throws org.openqa.selenium.WebDriverException

Finds a single element by link text.

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 - This method doesn't work against native app UI.

findElementByPartialLinkText

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

Finds a single element by partial link text.

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 - This method doesn't work against native app UI.

findElementByTagName

public T findElementByTagName(java.lang.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(java.lang.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(java.lang.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(java.lang.String using)
                           throws org.openqa.selenium.WebDriverException

Finds a single element by CSS selector.

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 - This method doesn't work against native app UI.

findElementByXPath

public T findElementByXPath(java.lang.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

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

toString

public java.lang.String toString()

Overrides:

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