io.appium.java_client

Class AppiumDriver<T extends WebElement>

java.lang.Object

org.openqa.selenium.remote.RemoteWebDriver

io.appium.java_client.AppiumDriver<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 and its subclasses that designed specifically for each target mobile OS (still Android and iOS)

All Implemented Interfaces:

ComparesImages, ExecutesDriverScript, ExecutesMethod, FindsByAccessibilityId<T>, FindsByCustom<T>, FindsByFluentSelector<T>, FindsByImage<T>, HasAppStrings, HasDeviceTime, HasSessionDetails, HasSettings, HidesKeyboard, InteractsWithApps, InteractsWithFiles, LogsEvents, MobileDriver<T>, PerformsTouchActions, 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

Direct Known Subclasses:

AndroidDriver, IOSDriver, WindowsDriver

public class AppiumDriver<T extends WebElement>
extends org.openqa.selenium.remote.RemoteWebDriver
implements ComparesImages, FindsByImage<T>, FindsByCustom<T>, ExecutesDriverScript, LogsEvents, HasSettings

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

Method Summary

Modifier and Type	Method and Description
WebDriver	context(java.lang.String name)
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)
java.util.List<T>	findElements(org.openqa.selenium.By by) Find all elements within the current page using the given mechanism.
java.util.List<T>	findElements(java.lang.String by, java.lang.String using) Method performs the searching for a list of elements by some selector defined by string and value of the given selector.
java.util.List<T>	findElementsByAccessibilityId(java.lang.String using) Method performs the searching for a list of elements by accessibility ID selector and value of the given selector.
java.util.List<T>	findElementsByClassName(java.lang.String using)
java.util.List<T>	findElementsByCssSelector(java.lang.String using) Finds many elements by CSS selector.
java.util.List<T>	findElementsById(java.lang.String id)
java.util.List<T>	findElementsByLinkText(java.lang.String using) Finds many elements by link text.
java.util.List<T>	findElementsByName(java.lang.String using)
java.util.List<T>	findElementsByPartialLinkText(java.lang.String using) Finds many elements by partial link text.
java.util.List<T>	findElementsByTagName(java.lang.String using)
java.util.List<T>	findElementsByXPath(java.lang.String using)
java.lang.String	getContext()
java.util.Set<java.lang.String>	getContextHandles()
org.openqa.selenium.remote.ExecuteMethod	getExecuteMethod()
org.openqa.selenium.ScreenOrientation	getOrientation()
java.net.URL	getRemoteAddress()
java.util.Map<java.lang.String,java.lang.Object>	getStatus() This method is used to get build version status of running Appium server.
boolean	isBrowser() Checks if focus is on browser.
org.openqa.selenium.html5.Location	location()
void	rotate(org.openqa.selenium.DeviceRotation rotation)
void	rotate(org.openqa.selenium.ScreenOrientation orientation)
org.openqa.selenium.DeviceRotation	rotation()
void	setLocation(org.openqa.selenium.html5.Location location)
protected void	startSession(org.openqa.selenium.Capabilities capabilities)
protected static org.openqa.selenium.Capabilities	substituteMobilePlatform(org.openqa.selenium.Capabilities originalCapabilities, java.lang.String newPlatform) Deprecated. Please use updateDefaultPlatformName(Capabilities, String) instead
java.lang.String	toString()
protected static org.openqa.selenium.Capabilities	updateDefaultPlatformName(org.openqa.selenium.Capabilities originalCapabilities, java.lang.String defaultName) Changes platform name if it is not set and returns new capabilities.

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

builder, close, executeAsyncScript, executeScript, get, getCapabilities, getCommandExecutor, getCurrentUrl, getElementConverter, getErrorHandler, getFileDetector, getKeyboard, getMouse, getPageSource, getScreenshotAs, getSessionId, getTitle, getWindowHandle, getWindowHandles, log, manage, navigate, perform, quit, resetInputState, setCommandExecutor, setElementConverter, setErrorHandler, setFileDetector, setFoundBy, setLogLevel, setSessionId, 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.ComparesImages

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

Methods inherited from interface io.appium.java_client.FindsByImage

findElementByImage, findElementsByImage

Methods inherited from interface io.appium.java_client.FindsByCustom

findElementByCustom, findElementsByCustom

Methods inherited from interface io.appium.java_client.FindsByFluentSelector

findElement

Methods inherited from interface io.appium.java_client.ExecutesDriverScript

executeDriverScript, executeDriverScript

Methods inherited from interface io.appium.java_client.LogsEvents

getEvents, logEvent

Methods inherited from interface io.appium.java_client.HasSettings

getSettings, setSetting, setSetting, setSettings, setSettings

Methods inherited from interface io.appium.java_client.ExecutesMethod

execute, execute

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.InteractsWithFiles

pullFile, pullFolder

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

getAllSessionDetails, getAutomationName, getPlatformName, getSessionDetail, getSessionDetails

Constructor Detail

AppiumDriver

public AppiumDriver(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

AppiumDriver

public AppiumDriver(java.net.URL remoteAddress,
                    org.openqa.selenium.Capabilities desiredCapabilities)

AppiumDriver

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

AppiumDriver

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

AppiumDriver

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

AppiumDriver

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

AppiumDriver

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

AppiumDriver

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

AppiumDriver

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

Method Detail

substituteMobilePlatform

@Deprecated
protected static org.openqa.selenium.Capabilities substituteMobilePlatform(org.openqa.selenium.Capabilities originalCapabilities,
                                                                                       java.lang.String newPlatform)

Deprecated. Please use updateDefaultPlatformName(Capabilities, String) instead

Changes platform name and returns new capabilities.

Parameters:

originalCapabilities - the given Capabilities.

newPlatform - a CapabilityType.PLATFORM_NAME value which has to be set up

Returns:

Capabilities with changed mobile platform value

updateDefaultPlatformName

protected static org.openqa.selenium.Capabilities updateDefaultPlatformName(org.openqa.selenium.Capabilities originalCapabilities,
                                                                            java.lang.String defaultName)

Changes platform name if it is not set and returns new capabilities.

Parameters:

originalCapabilities - the given Capabilities.

defaultName - a CapabilityType.PLATFORM_NAME value which has to be set up

Returns:

Capabilities with changed mobile platform name value or the original capabilities

findElements

public java.util.List<T> findElements(org.openqa.selenium.By by)

Description copied from interface: WebDriver

Find all elements within the current page using the given mechanism. This method is affected by the 'implicit wait' times in force at the time of execution. When implicitly waiting, this method will return as soon as there are more than 0 items in the found collection, or will return an empty list if the timeout is reached.

Specified by:

findElements in interface MobileDriver<T extends WebElement>

Specified by:

findElements in interface SearchContext

Specified by:

findElements in interface WebDriver

Parameters:

by - The locating mechanism to use

Returns:

A list of all WebElements, or an empty list if nothing matches

See Also:

By, WebDriver.Timeouts

findElements

public java.util.List<T> findElements(java.lang.String by,
                                      java.lang.String using)

Description copied from interface: FindsByFluentSelector

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

Specified by:

findElements in interface FindsByFluentSelector<T extends WebElement>

Parameters:

by - is a string selector

using - is a value of the given selector

Returns:

a list of elements

findElementsById

public java.util.List<T> findElementsById(java.lang.String id)

Specified by:

findElementsById in interface MobileDriver<T extends WebElement>

Specified by:

findElementsById in interface FindsById

findElementsByLinkText

public java.util.List<T> findElementsByLinkText(java.lang.String using)

Finds many elements by link text.

Specified by:

findElementsByLinkText in interface MobileDriver<T extends WebElement>

Specified by:

findElementsByLinkText in interface FindsByLinkText

findElementsByPartialLinkText

public java.util.List<T> findElementsByPartialLinkText(java.lang.String using)

Finds many elements by partial link text.

Specified by:

findElementsByPartialLinkText in interface MobileDriver<T extends WebElement>

Specified by:

findElementsByPartialLinkText in interface FindsByLinkText

findElementsByTagName

public java.util.List<T> findElementsByTagName(java.lang.String using)

Specified by:

findElementsByTagName in interface MobileDriver<T extends WebElement>

Specified by:

findElementsByTagName in interface FindsByTagName

findElementsByName

public java.util.List<T> findElementsByName(java.lang.String using)

Specified by:

findElementsByName in interface MobileDriver<T extends WebElement>

Specified by:

findElementsByName in interface FindsByName

findElementsByClassName

public java.util.List<T> findElementsByClassName(java.lang.String using)

Specified by:

findElementsByClassName in interface MobileDriver<T extends WebElement>

Specified by:

findElementsByClassName in interface FindsByClassName

findElementsByCssSelector

public java.util.List<T> findElementsByCssSelector(java.lang.String using)

Finds many elements by CSS selector.

Specified by:

findElementsByCssSelector in interface MobileDriver<T extends WebElement>

Specified by:

findElementsByCssSelector in interface FindsByCssSelector

findElementsByXPath

public java.util.List<T> findElementsByXPath(java.lang.String using)

Specified by:

findElementsByXPath in interface MobileDriver<T extends WebElement>

Specified by:

findElementsByXPath in interface FindsByXPath

findElementsByAccessibilityId

public java.util.List<T> findElementsByAccessibilityId(java.lang.String using)

Description copied from interface: FindsByAccessibilityId

Method performs the searching for a list of elements by accessibility ID selector and value of the given selector.

Specified by:

findElementsByAccessibilityId in interface FindsByAccessibilityId<T extends WebElement>

Parameters:

using - an accessibility ID selector

Returns:

a list of elements that match the given selector

getExecuteMethod

public org.openqa.selenium.remote.ExecuteMethod getExecuteMethod()

Overrides:

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

context

public WebDriver context(java.lang.String name)

Specified by:

context in interface org.openqa.selenium.ContextAware

getContextHandles

public java.util.Set<java.lang.String> getContextHandles()

Specified by:

getContextHandles in interface org.openqa.selenium.ContextAware

getContext

public java.lang.String getContext()

Specified by:

getContext in interface org.openqa.selenium.ContextAware

getStatus

public java.util.Map<java.lang.String,java.lang.Object> getStatus()

This method is used to get build version status of running Appium server.

Returns:

map containing version details

rotation

public org.openqa.selenium.DeviceRotation rotation()

Specified by:

rotation in interface org.openqa.selenium.Rotatable

rotate

public void rotate(org.openqa.selenium.DeviceRotation rotation)

Specified by:

rotate in interface org.openqa.selenium.Rotatable

rotate

public void rotate(org.openqa.selenium.ScreenOrientation orientation)

Specified by:

rotate in interface org.openqa.selenium.Rotatable

getOrientation

public org.openqa.selenium.ScreenOrientation getOrientation()

Specified by:

getOrientation in interface org.openqa.selenium.Rotatable

location

public org.openqa.selenium.html5.Location location()

Specified by:

location in interface org.openqa.selenium.html5.LocationContext

setLocation

public void setLocation(org.openqa.selenium.html5.Location location)

Specified by:

setLocation in interface org.openqa.selenium.html5.LocationContext

getRemoteAddress

public java.net.URL getRemoteAddress()

isBrowser

public boolean isBrowser()

Description copied from interface: HasSessionDetails

Checks if focus is on browser.

Specified by:

isBrowser in interface HasSessionDetails

Returns:

is focus on browser or on native content.

startSession

protected void startSession(org.openqa.selenium.Capabilities capabilities)

Overrides:

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

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

toString

public java.lang.String toString()

Overrides:

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