io.selendroid.common

Class SelendroidCapabilities

java.lang.Object

org.openqa.selenium.remote.DesiredCapabilities

io.selendroid.common.SelendroidCapabilities

All Implemented Interfaces:

Serializable, org.openqa.selenium.Capabilities

public class SelendroidCapabilities
extends org.openqa.selenium.remote.DesiredCapabilities

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static String	API_TARGET_TYPE
static String	AUT
static String	AUTOMATION_NAME
static String	BOOTSTRAP_CLASS_NAMES
static String	DISPLAY
static String	EMULATOR
static String	LAUNCH_ACTIVITY
static String	LOCALE
static String	MODEL
static String	PLATFORM_NAME
static String	PLATFORM_VERSION
static String	PRE_SESSION_ADB_COMMANDS
static String	SCREEN_SIZE
static String	SELENDROID_EXTENSIONS
static String	SERIAL

Constructor Summary

Constructors

Constructor and Description
SelendroidCapabilities()
SelendroidCapabilities(org.json.JSONObject source)
SelendroidCapabilities(Map<String,?> from)
SelendroidCapabilities(String aut)
SelendroidCapabilities(String serial, String aut)

Method Summary

Methods

Modifier and Type	Method and Description
SelendroidCapabilities	addBootstrapClass(String className) Adds a class to run on app startup.
static org.openqa.selenium.remote.DesiredCapabilities	android(DeviceTargetPlatform platform)
static SelendroidCapabilities	copyOf(SelendroidCapabilities caps)
static SelendroidCapabilities	device(DeviceTargetPlatform platform, String aut)
static SelendroidCapabilities	device(String aut)
static SelendroidCapabilities	empty()
static SelendroidCapabilities	emulator(DeviceTargetPlatform platform, String aut)
static SelendroidCapabilities	emulator(String aut)
String	getAPITargetType() Gets the API target type.
String	getAut()
String	getAutomationName()
String	getBootstrapClassNames() Full name of class to run on the device before starting the app under test.
String	getDefaultApp(Set<String> supportedApps) Returns the application under test in the format of "appName:appVersion", or "appName" if the supported application does not have any version associated with it, or returns null if the requested app is not in the apps store.
Boolean	getEmulator()
String	getLaunchActivity()
String	getLocale()
String	getModel()
String	getPlatformName()
String	getPlatformVersion()
List<String>	getPreSessionAdbCommands()
Map<String,Object>	getRawCapabilities()
String	getScreenSize()
String	getSelendroidExtensions() Full path of the dex file (on the host machine) containing Selendroid extensions to be loaded at run time Example: /home/user/extension.dex
String	getSerial()
void	setAPITargetType(String apiTargetType) Sets the API target type.
void	setAut(String aut)
void	setEmulator(Boolean emulator)
void	setLaunchActivity(String launchActivity)
void	setLocale(String locale)
void	setModel(String model)
void	setPlatformVersion(DeviceTargetPlatform androidTarget)
void	setPreSessionAdbCommands(List<String> commands) Command like: "shell setprop name selendroid", please note that the adb command itself and the serial will be added by selendroid automatically.
void	setScreenSize(String screenSize)
SelendroidCapabilities	setSelendroidExtensions(String filePath)
void	setSerial(String serial)
SelendroidCapabilities	withMerged(SelendroidCapabilities caps) Returns a copy of this instance with caps merged, overwriting existing keys on collision.

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

android, asMap, chrome, edge, equals, firefox, getBrowserName, getCapability, getPlatform, getVersion, hashCode, htmlUnit, htmlUnitWithJs, internetExplorer, ipad, iphone, is, isJavascriptEnabled, merge, opera, operaBlink, phantomjs, safari, setBrowserName, setCapability, setCapability, setCapability, setCapability, setJavascriptEnabled, setPlatform, setVersion, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

AUT

public static final String AUT

See Also:

Constant Field Values

EMULATOR

public static final String EMULATOR

See Also:

Constant Field Values

DISPLAY

public static final String DISPLAY

See Also:

Constant Field Values

LOCALE

public static final String LOCALE

See Also:

Constant Field Values

SCREEN_SIZE

public static final String SCREEN_SIZE

See Also:

Constant Field Values

PRE_SESSION_ADB_COMMANDS

public static final String PRE_SESSION_ADB_COMMANDS

See Also:

Constant Field Values

SERIAL

public static final String SERIAL

See Also:

Constant Field Values

MODEL

public static final String MODEL

See Also:

Constant Field Values

API_TARGET_TYPE

public static final String API_TARGET_TYPE

See Also:

Constant Field Values

PLATFORM_VERSION

public static final String PLATFORM_VERSION

See Also:

Constant Field Values

PLATFORM_NAME

public static final String PLATFORM_NAME

See Also:

Constant Field Values

AUTOMATION_NAME

public static final String AUTOMATION_NAME

See Also:

Constant Field Values

LAUNCH_ACTIVITY

public static final String LAUNCH_ACTIVITY

See Also:

Constant Field Values

SELENDROID_EXTENSIONS

public static final String SELENDROID_EXTENSIONS

See Also:

Constant Field Values

BOOTSTRAP_CLASS_NAMES

public static final String BOOTSTRAP_CLASS_NAMES

See Also:

Constant Field Values

Constructor Detail

SelendroidCapabilities

public SelendroidCapabilities(Map<String,?> from)

SelendroidCapabilities

public SelendroidCapabilities(org.json.JSONObject source)
                       throws org.json.JSONException

Throws:

org.json.JSONException

SelendroidCapabilities

public SelendroidCapabilities()

SelendroidCapabilities

public SelendroidCapabilities(String aut)

SelendroidCapabilities

public SelendroidCapabilities(String serial,
                      String aut)

Method Detail

empty

public static SelendroidCapabilities empty()

copyOf

public static SelendroidCapabilities copyOf(SelendroidCapabilities caps)

getSerial

public String getSerial()

getPlatformVersion

public String getPlatformVersion()

getAut

public String getAut()

getModel

public String getModel()

getAPITargetType

public String getAPITargetType()

Gets the API target type.

Returns:

the API target type

getLaunchActivity

public String getLaunchActivity()

getEmulator

public Boolean getEmulator()

getPlatformName

public String getPlatformName()

getAutomationName

public String getAutomationName()

getLocale

public String getLocale()

getRawCapabilities

public Map<String,Object> getRawCapabilities()

getScreenSize

public String getScreenSize()

getSelendroidExtensions

public String getSelendroidExtensions()

Full path of the dex file (on the host machine) containing Selendroid extensions to be loaded at run time Example: /home/user/extension.dex

getBootstrapClassNames

public String getBootstrapClassNames()

Full name of class to run on the device before starting the app under test. The class must be a part of an extension dex pushed to the device.

setSerial

public void setSerial(String serial)

setModel

public void setModel(String model)

setAPITargetType

public void setAPITargetType(String apiTargetType)

Sets the API target type. For example, set this to google if your application requires Google APIs.

Parameters:

apiTargetType - the new API target type

setPlatformVersion

public void setPlatformVersion(DeviceTargetPlatform androidTarget)

setAut

public void setAut(String aut)

setLaunchActivity

public void setLaunchActivity(String launchActivity)

setEmulator

public void setEmulator(Boolean emulator)

setLocale

public void setLocale(String locale)

setScreenSize

public void setScreenSize(String screenSize)

setSelendroidExtensions

public SelendroidCapabilities setSelendroidExtensions(String filePath)

addBootstrapClass

public SelendroidCapabilities addBootstrapClass(String className)

Adds a class to run on app startup. Class names are stored as a string separated by commas.

emulator

public static SelendroidCapabilities emulator(String aut)

Parameters:

aut - The application under test. Expected format is basePackage:version. E.g.: io.selendroid.testapp:0.4

Returns:

Desired Capabilities of an emulator.

emulator

public static SelendroidCapabilities emulator(DeviceTargetPlatform platform,
                              String aut)

Parameters:

platform - The Android target platform to use.

aut - The application under test. Expected format is basePackage:version. E.g.: io.selendroid.testapp:0.4

Returns:

Desired Capabilities of an emulator.

android

public static org.openqa.selenium.remote.DesiredCapabilities android(DeviceTargetPlatform platform)

getPreSessionAdbCommands

public List<String> getPreSessionAdbCommands()

Returns:

The list of ADB commands that will be executed before the test session starts on the device.

setPreSessionAdbCommands

public void setPreSessionAdbCommands(List<String> commands)

Command like: "shell setprop name selendroid", please note that the adb command itself and the serial will be added by selendroid automatically.

Parameters:

commands - The list of ADB commands that will be executed before the test session starts on the device.

device

public static SelendroidCapabilities device(DeviceTargetPlatform platform,
                            String aut)

Parameters:

platform - The Android target platform to use.

aut - The application under test. Expected format is basePackage:version. E.g.: io.selendroid.testapp:0.4

Returns:

Desired Capabilities of an device.

device

public static SelendroidCapabilities device(String aut)

Parameters:

aut - The application under test. Expected format is basePackage:version. E.g.: io.selendroid.testapp:0.4

Returns:

Desired Capabilities of an device.

withMerged

public SelendroidCapabilities withMerged(SelendroidCapabilities caps)

Returns a copy of this instance with caps merged, overwriting existing keys on collision.

getDefaultApp

public String getDefaultApp(Set<String> supportedApps)

Returns the application under test in the format of "appName:appVersion", or "appName" if the supported application does not have any version associated with it, or returns null if the requested app is not in the apps store. If the launch activity is also specified with requested application then just return the requested application as app under test so it can be later installed to the device by SelendroidStandaloneDriver.

Parameters:

supportedApps - The list of supported apps in the apps store.

Returns:

The application under test in "appName" or "appName:appVersion" format, or null if the application is not in the list of supported apps and the launch activity is not specified.