io.appium.java_client

Class AppiumDriver

java.lang.Object

org.openqa.selenium.remote.RemoteWebDriver

io.appium.java_client.AppiumDriver

All Implemented Interfaces:

DeviceActionShortcuts, FindsByAccessibilityId, InteractsWithApps, InteractsWithFiles, MobileDriver, PerformsTouchActions, ScrollsTo, 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

Direct Known Subclasses:

AndroidDriver, IOSDriver

public abstract class AppiumDriver
extends org.openqa.selenium.remote.RemoteWebDriver
implements MobileDriver, org.openqa.selenium.ContextAware, org.openqa.selenium.Rotatable, FindsByAccessibilityId, org.openqa.selenium.html5.LocationContext, DeviceActionShortcuts, TouchShortcuts, InteractsWithFiles, InteractsWithApps, ScrollsTo

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

Modifier and Type	Field and Description
protected String	KEY_CODE
protected String	PATH

Constructor Summary

Constructors

Constructor and Description
AppiumDriver(URL remoteAddress, org.openqa.selenium.Capabilities desiredCapabilities)

Method Summary

Methods

Modifier and Type	Method and Description
protected static boolean	_isNotNullOrEmpty(Object ob)
protected static boolean	_isNotNullOrEmpty(String str) Checks if a string is null, empty, or whitespace.
void	closeApp() Close the app which was provided in the capabilities at session creation
org.openqa.selenium.WebDriver	context(String name)
protected org.openqa.selenium.remote.Response	execute(String command)
org.openqa.selenium.remote.Response	execute(String driverCommand, Map<String,?> parameters)
org.openqa.selenium.WebElement	findElementByAccessibilityId(String using)
List<org.openqa.selenium.WebElement>	findElementsByAccessibilityId(String using)
protected static com.google.common.collect.ImmutableMap<String,Object>	getCommandImmutableMap(String[] params, Object[] values)
protected static com.google.common.collect.ImmutableMap<String,Object>	getCommandImmutableMap(String param, Object value)
String	getContext()
Set<String>	getContextHandles()
org.openqa.selenium.remote.ExecuteMethod	getExecuteMethod()
org.openqa.selenium.ScreenOrientation	getOrientation()
URL	getRemoteAddress()
com.google.gson.JsonObject	getSettings() Get settings stored for this test session It's probably better to use a convenience function, rather than use this function directly.
void	hideKeyboard() Hides the keyboard if it is showing.
void	installApp(String appPath) Install an app on the mobile device
boolean	isAppInstalled(String bundleId) Checks if an app is installed on the device
void	launchApp() Launch the app which was provided in the capabilities at session creation
org.openqa.selenium.html5.Location	location()
void	lockScreen(int seconds) Lock the device (bring it to the lock screen) for a given number of seconds
void	performMultiTouchAction(MultiTouchAction multiAction) Performs multiple TouchAction gestures at the same time, to simulate multiple fingers/touch inputs.
TouchAction	performTouchAction(TouchAction touchAction) Performs a chain of touch actions, which together can be considered an entire gesture.
void	pinch(int x, int y) Convenience method for pinching an element on the screen.
void	pinch(org.openqa.selenium.WebElement el) Convenience method for pinching an element on the screen.
byte[]	pullFile(String remotePath)
byte[]	pullFolder(String remotePath) Pull a folder from the simulator/device.
void	removeApp(String bundleId) Remove the specified app from the device (uninstall)
void	resetApp() Reset the currently running app for this session
void	rotate(org.openqa.selenium.ScreenOrientation orientation)
void	runAppInBackground(int seconds) Runs the current app as a background app for the number of seconds requested.
void	sendKeyEvent(int key) Send a key event to the device
void	setLocation(org.openqa.selenium.html5.Location location)
protected void	setSetting(AppiumSetting setting, Object value) Set a setting for this test session It's probably better to use a convenience function, rather than use this function directly.
protected static org.openqa.selenium.Capabilities	substituteMobilePlatform(org.openqa.selenium.Capabilities originalCapabilities, String newPlatform)
void	swipe(int startx, int starty, int endx, int endy, int duration) Convenience method for swiping across the screen
void	tap(int fingers, int x, int y, int duration) Convenience method for tapping a position on the screen
void	tap(int fingers, org.openqa.selenium.WebElement element, int duration) Convenience method for tapping the center of an element on the screen
void	zoom(int x, int y) Convenience method for "zooming in" on an element on the screen.
void	zoom(org.openqa.selenium.WebElement el) Convenience method for "zooming in" on an element on the screen.

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

close, executeAsyncScript, executeScript, findElement, findElement, findElementByClassName, findElementByCssSelector, findElementById, findElementByLinkText, findElementByName, findElementByPartialLinkText, findElementByTagName, findElementByXPath, findElements, findElements, findElementsByClassName, findElementsByCssSelector, findElementsById, findElementsByLinkText, findElementsByName, findElementsByPartialLinkText, findElementsByTagName, findElementsByXPath, get, getCapabilities, getCommandExecutor, getCurrentUrl, getElementConverter, getErrorHandler, getFileDetector, getKeyboard, getMouse, getPageSource, getRemoteStatus, getScreenshotAs, getSessionId, getTitle, 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 org.openqa.selenium.WebDriver

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

Methods inherited from interface io.appium.java_client.ScrollsTo

scrollTo, scrollToExact

Field Detail

KEY_CODE

protected final String KEY_CODE

See Also:

Constant Field Values

PATH

protected final String PATH

See Also:

Constant Field Values

Constructor Detail

AppiumDriver

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

Method Detail

substituteMobilePlatform

protected static org.openqa.selenium.Capabilities substituteMobilePlatform(org.openqa.selenium.Capabilities originalCapabilities,
                                                        String newPlatform)

Parameters:

originalCapabilities - the given Capabilities

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

Returns:

Capabilities with changed mobile platform value

getCommandImmutableMap

protected static com.google.common.collect.ImmutableMap<String,Object> getCommandImmutableMap(String param,
                                                                           Object value)

Parameters:

param - is a parameter name

value - is the parameter value

Returns:

built ImmutableMap

getCommandImmutableMap

protected static com.google.common.collect.ImmutableMap<String,Object> getCommandImmutableMap(String[] params,
                                                                           Object[] values)

Parameters:

params - is the array with parameter names

values - is the array with parameter values

Returns:

built ImmutableMap

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

execute

protected org.openqa.selenium.remote.Response execute(String command)

Overrides:

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

getExecuteMethod

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

Overrides:

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

resetApp

public void resetApp()

Description copied from interface: InteractsWithApps

Reset the currently running app for this session

Specified by:

resetApp in interface InteractsWithApps

See Also:

InteractsWithApps.resetApp()

isAppInstalled

public boolean isAppInstalled(String bundleId)

Description copied from interface: InteractsWithApps

Checks if an app is installed on the device

Specified by:

isAppInstalled in interface InteractsWithApps

Parameters:

bundleId - bundleId of the app

Returns:

True if app is installed, false otherwise

See Also:

InteractsWithApps.isAppInstalled(String)

installApp

public void installApp(String appPath)

Description copied from interface: InteractsWithApps

Install an app on the mobile device

Specified by:

installApp in interface InteractsWithApps

Parameters:

appPath - path to app to install

See Also:

InteractsWithApps.installApp(String)

removeApp

public void removeApp(String bundleId)

Description copied from interface: InteractsWithApps

Remove the specified app from the device (uninstall)

Specified by:

removeApp in interface InteractsWithApps

Parameters:

bundleId - the bunble identifier (or app id) of the app to remove

See Also:

InteractsWithApps.removeApp(String)

launchApp

public void launchApp()

Description copied from interface: InteractsWithApps

Launch the app which was provided in the capabilities at session creation

Specified by:

launchApp in interface InteractsWithApps

See Also:

InteractsWithApps.launchApp()

closeApp

public void closeApp()

Description copied from interface: InteractsWithApps

Close the app which was provided in the capabilities at session creation

Specified by:

closeApp in interface InteractsWithApps

See Also:

InteractsWithApps.closeApp()

runAppInBackground

public void runAppInBackground(int seconds)

Description copied from interface: InteractsWithApps

Runs the current app as a background app for the number of seconds requested. This is a synchronous method, it returns after the back has been returned to the foreground.

Specified by:

runAppInBackground in interface InteractsWithApps

Parameters:

seconds - Number of seconds to run App in background

See Also:

InteractsWithApps.runAppInBackground(int)

sendKeyEvent

public void sendKeyEvent(int key)

Send a key event to the device

Specified by:

sendKeyEvent in interface DeviceActionShortcuts

Parameters:

key - code for the key pressed on the device

See Also:

AndroidKeyCode, IOSKeyCode

hideKeyboard

public void hideKeyboard()

Description copied from interface: DeviceActionShortcuts

Hides the keyboard if it is showing. On iOS, there are multiple strategies for hiding the keyboard. Defaults to the "tapOutside" strategy (taps outside the keyboard). Switch to using hideKeyboard(HideKeyboardStrategy.PRESS_KEY, "Done") if this doesn't work.

Specified by:

hideKeyboard in interface DeviceActionShortcuts

See Also:

DeviceActionShortcuts.hideKeyboard()

pullFile

public byte[] pullFile(String remotePath)

Specified by:

pullFile in interface InteractsWithFiles

Parameters:

remotePath - On Android and iOS, this is either the path to the file (relative to the root of the app's file system). On iOS only, if path starts with /AppName.app, which will be replaced with the application's .app directory

Returns:

A byte array of Base64 encoded data.

See Also:

InteractsWithFiles.pullFile(String)

pullFolder

public byte[] pullFolder(String remotePath)

Description copied from interface: InteractsWithFiles

Pull a folder from the simulator/device. Does not work on iOS Real Devices, but works on simulators

Specified by:

pullFolder in interface InteractsWithFiles

Parameters:

remotePath - On Android and iOS, this is either the path to the file (relative to the root of the app's file system). On iOS only, if path starts with /AppName.app, which will be replaced with the application's .app directory

Returns:

A byte array of Base64 encoded data, representing a ZIP ARCHIVE of the contents of the requested folder.

See Also:

InteractsWithFiles.pullFolder(String)

performTouchAction

public TouchAction performTouchAction(TouchAction touchAction)

Description copied from interface: PerformsTouchActions

Performs a chain of touch actions, which together can be considered an entire gesture. See the Webriver 3 spec https://dvcs.w3.org/hg/webdriver/raw-file/default/webdriver-spec.html It's more convenient to call the perform() method of the TouchAction object itself.

Specified by:

performTouchAction in interface PerformsTouchActions

Parameters:

touchAction - A TouchAction object, which contains a list of individual touch actions to perform

Returns:

the same touch action object

See Also:

PerformsTouchActions.performTouchAction(TouchAction)

performMultiTouchAction

public void performMultiTouchAction(MultiTouchAction multiAction)

Description copied from interface: PerformsTouchActions

Performs multiple TouchAction gestures at the same time, to simulate multiple fingers/touch inputs. See the Webriver 3 spec https://dvcs.w3.org/hg/webdriver/raw-file/default/webdriver-spec.html It's more convenient to call the perform() method of the MultiTouchAction object.

Specified by:

performMultiTouchAction in interface PerformsTouchActions

Parameters:

multiAction - the MultiTouchAction object to perform.

See Also:

PerformsTouchActions.performMultiTouchAction(MultiTouchAction)

tap

public void tap(int fingers,
       org.openqa.selenium.WebElement element,
       int duration)

Description copied from interface: TouchShortcuts

Convenience method for tapping the center of an element on the screen

Specified by:

tap in interface TouchShortcuts

Parameters:

fingers - number of fingers/appendages to tap with

element - element to tap

duration - how long between pressing down, and lifting fingers/appendages

See Also:

TouchShortcuts.tap(int, WebElement, int)

tap

public void tap(int fingers,
       int x,
       int y,
       int duration)

Description copied from interface: TouchShortcuts

Convenience method for tapping a position on the screen

Specified by:

tap in interface TouchShortcuts

Parameters:

fingers - number of fingers/appendages to tap with

x - x coordinate

y - y coordinate

See Also:

TouchShortcuts.tap(int, int, int, int)

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

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)

pinch

public void pinch(org.openqa.selenium.WebElement el)

Convenience method for pinching an element on the screen. "pinching" refers to the action of two appendages pressing the screen and sliding towards each other. NOTE: This convenience method places the initial touches around the element, if this would happen to place one of them off the screen, appium with return an outOfBounds error. In this case, revert to using the MultiTouchAction api instead of this method.

Specified by:

pinch in interface TouchShortcuts

Parameters:

el - The element to pinch

pinch

public void pinch(int x,
         int y)

Convenience method for pinching an element on the screen. "pinching" refers to the action of two appendages pressing the screen and sliding towards each other. NOTE: This convenience method places the initial touches around the element at a distance, if this would happen to place one of them off the screen, appium will return an outOfBounds error. In this case, revert to using the MultiTouchAction api instead of this method.

Specified by:

pinch in interface TouchShortcuts

Parameters:

x - x coordinate to terminate the pinch on

y - y coordinate to terminate the pinch on

zoom

public void zoom(org.openqa.selenium.WebElement el)

Convenience method for "zooming in" on an element on the screen. "zooming in" refers to the action of two appendages pressing the screen and sliding away from each other. NOTE: This convenience method slides touches away from the element, if this would happen to place one of them off the screen, appium will return an outOfBounds error. In this case, revert to using the MultiTouchAction api instead of this method.

Specified by:

zoom in interface TouchShortcuts

Parameters:

el - The element to pinch

zoom

public void zoom(int x,
        int y)

Convenience method for "zooming in" on an element on the screen. "zooming in" refers to the action of two appendages pressing the screen and sliding away from each other. NOTE: This convenience method slides touches away from the element, if this would happen to place one of them off the screen, appium will return an outOfBounds error. In this case, revert to using the MultiTouchAction api instead of this method.

Specified by:

zoom in interface TouchShortcuts

Parameters:

x - x coordinate to start zoom on

y - y coordinate to start zoom on

getSettings

public com.google.gson.JsonObject getSettings()

Get settings stored for this test session It's probably better to use a convenience function, rather than use this function directly. Try finding the method for the specific setting you want to read

Returns:

JsonObject, a straight-up hash of settings

setSetting

protected void setSetting(AppiumSetting setting,
              Object value)

Set a setting for this test session It's probably better to use a convenience function, rather than use this function directly. Try finding the method for the specific setting you want to change

Parameters:

setting - AppiumSetting you wish to set

value - value of the setting

lockScreen

public void lockScreen(int seconds)

Lock the device (bring it to the lock screen) for a given number of seconds

Parameters:

seconds - number of seconds to lock the screen for

context

public org.openqa.selenium.WebDriver context(String name)

Specified by:

context in interface org.openqa.selenium.ContextAware

getContextHandles

public Set<String> getContextHandles()

Specified by:

getContextHandles in interface org.openqa.selenium.ContextAware

getContext

public String getContext()

Specified by:

getContext in interface org.openqa.selenium.ContextAware

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

findElementByAccessibilityId

public org.openqa.selenium.WebElement findElementByAccessibilityId(String using)

Specified by:

findElementByAccessibilityId in interface FindsByAccessibilityId

findElementsByAccessibilityId

public List<org.openqa.selenium.WebElement> findElementsByAccessibilityId(String using)

Specified by:

findElementsByAccessibilityId in interface FindsByAccessibilityId

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 URL getRemoteAddress()

_isNotNullOrEmpty

protected static boolean _isNotNullOrEmpty(String str)

Checks if a string is null, empty, or whitespace.

Parameters:

str - String to check.

Returns:

True if str is not null or empty.

_isNotNullOrEmpty

protected static boolean _isNotNullOrEmpty(Object ob)