AndroidCapability (autonomx-core 1.0.5 API)

java.lang.Object
- core.uiCore.driverProperties.capabilities.AndroidCapability

public class AndroidCapability
extends Object

Author:: ehsan.matean

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`ANDROID_ENGINE`
`static String`	`ANDROID_HOME`
`static boolean`	`ANDROID_INIT`
`static String`	`ANDROID_UDID`
`static String`	`APP_DIR_PATH`
`static String`	`APP_NAME`
`org.openqa.selenium.remote.DesiredCapabilities`	`capabilities`
`static String`	`CHROME_VERSION`
`static String`	`IS_HYBRID_APP`
`List<String>`	`simulatorList`
`static int`	`SYSTEM_PORT`
`static String`	`UIAUTOMATOR2`

Constructor Summary

Constructors
Constructor and Description

AndroidCapability()

Constructors
Constructor and Description
`AndroidCapability()`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static List<String>`	`getAndroidDeviceList()` gets the list of android devices including real devices + emulators skips the first item, as it is not a device
`List<String>`	`getAndroidRealDeviceList()`
`String`	`getAppPath()`
`org.openqa.selenium.remote.DesiredCapabilities`	`getCapability()`
`static List<String>`	`getRealDevices(List<String> devices)` gets the name of the first real device connected
`boolean`	`isRealDeviceConnected()` if adb device contains emulator, Then its an emulator otherwise, its a connected real device
`static void`	`printAndroidHelp(Exception e)`
`static void`	`restartAdb()`
`org.openqa.selenium.remote.DesiredCapabilities`	`setAndroidCapabilties()` set capabilties with prefix android.capabilties.
`void`	`setAndroidDevice()` sets device by following strategy: if device is connected, selects device if emulator is not specified with "withDevice1() or with Device2() function, select device 1 by default from properties else select emulator from properties specified in panel config page
`static void`	`setAndroidHome()` sets the value for android home based on its default location sets android home based on user.home location on mac checks if the generated android home location exists, if true, adds to android.home config value
`void`	`setChromeDriver()` download chrome driver if hybrid app is enabled if Version is LATEST, download latest driver unless set in config
`void`	`setPort(String deviceName)` if device has port assigned, use assigned port else generate new port number
`void`	`setRealDevices()` sets real device
`void`	`setSimulator()` sets ios device number of devices must be equal or greater than number of threads for parallel run
`void`	`setSingleSignIn()` runs subsequent tests without restarting the app removes the need to sign in on every test if tests fail, it will restart the app
`static void`	`uninstallUiAutomator2()` uninstalls the uiautomator2 server only runs the first time android test is run a device or emulator must be connected
`AndroidCapability`	`withAndroidCapability()` sets android capabilities values are from maven or properties file maven has higher priority than properties
`AndroidCapability`	`withCapability(org.openqa.selenium.remote.DesiredCapabilities Capabilities)`
`AndroidCapability`	`withDevice(String device)` device: property name from property file.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - capabilities
```
public org.openqa.selenium.remote.DesiredCapabilities capabilities
```
  - APP_DIR_PATH
```
public static String APP_DIR_PATH
```
  - APP_NAME
```
public static String APP_NAME
```
  - ANDROID_ENGINE
```
public static String ANDROID_ENGINE
```
  - UIAUTOMATOR2
```
public static String UIAUTOMATOR2
```
  - ANDROID_INIT
```
public static boolean ANDROID_INIT
```
  - ANDROID_HOME
```
public static String ANDROID_HOME
```
  - ANDROID_UDID
```
public static String ANDROID_UDID
```
  - IS_HYBRID_APP
```
public static String IS_HYBRID_APP
```
  - CHROME_VERSION
```
public static String CHROME_VERSION
```
  - simulatorList
```
public List<String> simulatorList
```
  - SYSTEM_PORT
```
public static int SYSTEM_PORT
```
- Constructor Detail
  - AndroidCapability
```
public AndroidCapability()
```
- Method Detail
  - withCapability
```
public AndroidCapability withCapability(org.openqa.selenium.remote.DesiredCapabilities Capabilities)
```
  - withDevice
```
public AndroidCapability withDevice(String device)
```
    device: property name from property file. eg. device1, device2
    
    Parameters:
    
    device -
    
    Returns:
  - getCapability
```
public org.openqa.selenium.remote.DesiredCapabilities getCapability()
```
  - getAppPath
```
public String getAppPath()
```
  - withAndroidCapability
```
public AndroidCapability withAndroidCapability()
```
    sets android capabilities values are from maven or properties file maven has higher priority than properties
    
    Returns:
  - setAndroidCapabilties
```
public org.openqa.selenium.remote.DesiredCapabilities setAndroidCapabilties()
```
    set capabilties with prefix android.capabilties. eg. android.capabilties.fullReset="false iterates through all property values with such prefix And adds them to android desired capabilities
    
    Returns:
  - setChromeDriver
```
public void setChromeDriver()
```
    download chrome driver if hybrid app is enabled if Version is LATEST, download latest driver unless set in config
  - setSingleSignIn
```
public void setSingleSignIn()
```
    runs subsequent tests without restarting the app removes the need to sign in on every test if tests fail, it will restart the app
  - isRealDeviceConnected
```
public boolean isRealDeviceConnected()
```
    if adb device contains emulator, Then its an emulator otherwise, its a connected real device
    
    Parameters:
    
    devices -
    
    Returns:
  - getRealDevices
```
public static List<String> getRealDevices(List<String> devices)
```
    gets the name of the first real device connected
    
    Parameters:
    
    devices -
    
    Returns:
  - getAndroidDeviceList
```
public static List<String> getAndroidDeviceList()
```
    gets the list of android devices including real devices + emulators skips the first item, as it is not a device
    
    Returns:
    
    device list
  - getAndroidRealDeviceList
```
public List<String> getAndroidRealDeviceList()
```
  - setSimulator
```
public void setSimulator()
```
    sets ios device number of devices must be equal or greater than number of threads for parallel run
  - setPort
```
public void setPort(String deviceName)
```
    if device has port assigned, use assigned port else generate new port number
    
    Parameters:
    
    deviceName -
  - restartAdb
```
public static void restartAdb()
```
  - uninstallUiAutomator2
```
public static void uninstallUiAutomator2()
```
    uninstalls the uiautomator2 server only runs the first time android test is run a device or emulator must be connected
  - setRealDevices
```
public void setRealDevices()
```
    sets real device
  - setAndroidDevice
```
public void setAndroidDevice()
```
    sets device by following strategy: if device is connected, selects device if emulator is not specified with "withDevice1() or with Device2() function, select device 1 by default from properties else select emulator from properties specified in panel config page
  - printAndroidHelp
```
public static void printAndroidHelp(Exception e)
```
  - setAndroidHome
```
public static void setAndroidHome()
```
    sets the value for android home based on its default location sets android home based on user.home location on mac checks if the generated android home location exists, if true, adds to android.home config value

Class AndroidCapability

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

capabilities

APP_DIR_PATH

APP_NAME

ANDROID_ENGINE

UIAUTOMATOR2

ANDROID_INIT

ANDROID_HOME

ANDROID_UDID

IS_HYBRID_APP

CHROME_VERSION

simulatorList

SYSTEM_PORT

Constructor Detail

AndroidCapability

Method Detail

withCapability

withDevice

getCapability

getAppPath

withAndroidCapability

setAndroidCapabilties

setChromeDriver

setSingleSignIn

isRealDeviceConnected

getRealDevices

getAndroidDeviceList

getAndroidRealDeviceList

setSimulator

setPort

restartAdb

uninstallUiAutomator2

setRealDevices

setAndroidDevice

printAndroidHelp

setAndroidHome