Package com.axway.ats.uiengine

Class MobileDriver

java.lang.Object

com.axway.ats.uiengine.UiDriver

com.axway.ats.uiengine.MobileDriver

public class MobileDriver
extends UiDriver

A driver used for working with a mobile applications(Android or iOS)

Field Summary

Fields

Modifier and Type	Field	Description
static String	DEVICE_ANDROID
static String	DEVICE_ANDROID_EMULATOR
static String	DEVICE_IPAD_SIMULATOR
static String	DEVICE_IPHONE_SIMULATOR
static String	NATIVE_CONTEXT

Constructor Summary

Constructors

Constructor	Description
MobileDriver(String deviceName, String platformVersion, String udid)
MobileDriver(String deviceName, String platformVersion, String udid, String host)
MobileDriver(String deviceName, String platformVersion, String udid, String host, int port)

Method Summary

Modifier and Type	Method	Description
void	clearAppCache(String applicationPackage)	Clear application cache
String	getAdbLocation()
String	getAndroidHome()
String	getHost()
Object	getInternalObject(String objectName)	NOTE: This method should not be used directly into the test scripts.
MobileEngine	getMobileEngine()
org.openqa.selenium.Dimension	getScreenDimensions()
boolean	isAndroidAgent()
boolean	isWorkingRemotely()
void	removeApp(String applicationPackage)	Remove application by name
void	setAndroidHome(String androidHome)
void	setScreenshotOnError(boolean screenshotOnError)
void	start()	Deprecated. Use start(String) method instead.
void	start(String appPath)	Start session to device and load the application
void	stop()	stop the driver
void	stopIOSSimulator()	Stopping iOS Simulator
void	terminateApp(String applicationPackage)	Stop application by name

Methods inherited from class com.axway.ats.uiengine.UiDriver

getChromeDriver, getChromeDriver, getCustomDriver, getEdgeDriver, getEdgeDriver, getFirefoxDriver, getFirefoxDriver, getFirefoxDriver, getHiddenBrowserDriver, getHiddenBrowserDriver, getInternetExplorerDriver, getInternetExplorerDriver, getMobileDriver, getMobileDriver, getPhantomJSDriver, getRobotDriver, getSafariDriver, getSafariDriver, getSwingDriver, getSwingDriver, getSwingDriver, getSwingDriver

Methods inherited from class java.lang.Object

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

Field Detail

DEVICE_ANDROID_EMULATOR

public static final String DEVICE_ANDROID_EMULATOR

See Also:

Constant Field Values

DEVICE_ANDROID

public static final String DEVICE_ANDROID

See Also:

Constant Field Values

DEVICE_IPHONE_SIMULATOR

public static final String DEVICE_IPHONE_SIMULATOR

See Also:

Constant Field Values

DEVICE_IPAD_SIMULATOR

public static final String DEVICE_IPAD_SIMULATOR

See Also:

Constant Field Values

NATIVE_CONTEXT

public static final String NATIVE_CONTEXT

See Also:

Constant Field Values

Constructor Detail

MobileDriver

public MobileDriver(String deviceName,
                    String platformVersion,
                    String udid)

MobileDriver

public MobileDriver(String deviceName,
                    String platformVersion,
                    String udid,
                    String host)

MobileDriver

public MobileDriver(String deviceName,
                    String platformVersion,
                    String udid,
                    String host,
                    int port)

Method Detail

isAndroidAgent

public boolean isAndroidAgent()

Returns:

whether the target agent is Android, otherwise it is iOS

getHost

public String getHost()

isWorkingRemotely

public boolean isWorkingRemotely()

setAndroidHome

public void setAndroidHome(String androidHome)

Parameters:

androidHome - example: "d:\\android\\android-sdk\\"

start

@Deprecated
public void start()

Deprecated.

Use start(String) method instead.

Start session to device

Specified by:

start in class UiDriver

start

public void start(String appPath)

Start session to device and load the application

Parameters:

appPath - filesystem path to the application - absolute or relative to the Appium server current dir

       iOS: absolute path to simulator-compiled .app file or the bundle_id of the desired target on device
       Android: absolute path to .apk file
 

stop

public void stop()

Description copied from class: UiDriver

stop the driver

Specified by:

stop in class UiDriver

terminateApp

public void terminateApp(String applicationPackage)

Stop application by name

Parameters:

applicationPackage - application package name

removeApp

public void removeApp(String applicationPackage)

Remove application by name

Parameters:

applicationPackage - - bundle identifier or application ID of the application to be removed

clearAppCache

public void clearAppCache(String applicationPackage)

Clear application cache

Parameters:

applicationPackage - application package name

getMobileEngine

public MobileEngine getMobileEngine()

getInternalObject

public Object getInternalObject(String objectName)

NOTE: This method should not be used directly into the test scripts. The implementation may be changed by the Automation Framework Team without notice.

Returns:

Internal Object

getAndroidHome

public String getAndroidHome()

Returns:

android home location

getAdbLocation

public String getAdbLocation()

Returns:

adb location

setScreenshotOnError

public void setScreenshotOnError(boolean screenshotOnError)

Parameters:

screenshotOnError - whether to create screenshot on error

getScreenDimensions

public org.openqa.selenium.Dimension getScreenDimensions()

stopIOSSimulator

public void stopIOSSimulator()

Stopping iOS Simulator