Field Detail

• public static final String EXISTING_DRIVER_PROPERTY

• public static final String IS_REMOTE_WEB_DRIVER_URL_ENCRYPTED

• public static final String MOBILE_DRIVER_PROPERTY

• public static final String REMOTE_DRIVER_PROPERTY

• public static final String REMOTE_WEB_DRIVER_URL

Method Detail

• public static void cleanup()

  Clean up all running drivers and processes

  throws:

  InterruptedException

  throws:

  IOException

• public static void clearExistingDriverProperty()

• public static void closeDriver()

  Close the current active mobile driver

• public static String getDeviceId()

  Get the id of the current mobile device

  Returns:

  the id of the current mobile device

• public static String getDeviceManufacturer()

  Get the manufacturer of the current mobile device

  Returns:

  the manufacturer of the current mobile device

• public static String getDeviceModel()

  Get the model of the current mobile device

  Returns:

  the model of the current mobile device

• public static String getDeviceName()

  Get the name of the current mobile device

  Returns:

  the name of the current mobile device

• public static String getDeviceOS()

  Get the os of the current mobile device

  Returns:

  the os of the current mobile device

• public static String getDeviceOSVersion()

  Get the os version of the current mobile device

  Returns:

  the os version of the current mobile device

• public static String getDevicePlatform()

  Get the platform of the current active driver

  Possible values: iOS, Android

  Returns:

  the platform

• public static AppiumDriver getDriver()

  Get the current active native app mobile driver

  throws:

  StepFailedException

  throws:

  URISyntaxException

  Returns:

  the active mobile driver as an AppiumDriver object

• public static IDriverType getExecutedDriver()

  Get the native app mobile driver type of the current active driver

  See Also:

  MobileDriverType

  Returns:

  the driver type

• public static MobileDriverType getMobileDriverType()

  Get the native app mobile driver type of the current active driver

  See Also:

  MobileDriverType

  Returns:

  the driver type

• public static String getRemoteDeviceId()

  Get the id of the remote mobile device

  Returns:

  the id of the remote mobile device

• public static String getRemoteDeviceManufacturer()

  Get the manufacturer of the remote mobile device

  Returns:

  the manufacturer of the remote mobile device

• public static String getRemoteDeviceModel()

  Get the model of the remote mobile device

  Returns:

  the model of the remote mobile device

• public static String getRemoteDeviceName()

  Get the name of the remote mobile device

  Returns:

  the name of the remote mobile device

• public static String getRemoteDeviceOS()

  Get the os of the remote mobile device

  Returns:

  the os of the remote mobile device

• public static String getRemoteDeviceOSVersion()

  Get the os version of the remote mobile device

  Returns:

  the os version of the remote mobile device

• public static MobileDriverType getRemoteMobileDriver()

• public static Map<String, Object> getRemoteWebDriverPreferences()

  Returns:

  the remote web driver url if running Mobile keyword on cloud services

• public static String getRemoteWebDriverServerUrl()

  Returns:

  the remote web driver url if running Mobile keyword on cloud services

• public static String getRemoteWebDriverType()

  Returns:

  the remote web driver type if running Mobile keyword on cloud services

• public static boolean isRemoteWebDriver()

  Returns:

  true when this run targets a remote Appium/RemoteWebDriver server, false for a LOCAL Appium driver. Backed by the RunConfiguration#REMOTE_DRIVER_PROPERTY#REMOTE_DRIVER_PROPERTY ("Remote") property — there is no separate enabled/disabled flag stored alongside it, only the server URL (and its encryption flag), so a configured, non-blank getRemoteWebDriverServerUrl() is itself the authoritative LOCAL-vs-REMOTE signal. This is the same condition startMobileDriver itself branches on to pick startRemoteMobileDriver vs. startLocalMobileDriver — exposed here so other callers don't have to re-derive it from the raw URL string.

• public static boolean isUsingAndroid7OrBigger()

• public static void setDriver(AppiumDriver driver)

  Sets the current active mobile driver.

  Parameters:

  driver - the mobile driver to set

  Since:

  7.6.0

• @Deprecated protected static AppiumDriver startExistingBrowser()

• protected static AppiumDriver startExistingDriver()

• public static AppiumDriver startLocalMobileDriver(MobileDriverType osType, String deviceId, String deviceName, String platformVersion, String appFile, boolean uninstallAfterCloseApp)

  Start a new native app mobile driver

  throws:

  MobileDriverInitializeException

  throws:

  IOException

  throws:

  InterruptedException

  throws:

  AppiumStartException

  Parameters:

  osType - the os type for the new mobile driver with type MobileDriverType

  deviceId - id of the device

  deviceName - name of the device

  platformVersion - platform version of the device

  appFile - absolute path of the application file

  uninstallAfterCloseApp - true to un-install the app after execution

  Returns:

  the newly created driver with type AppiumDriver

• public static AppiumDriver startMobileDriver(String appId)

• public static AppiumDriver startMobileDriver(String appFile, boolean uninstallAfterCloseApp)

  Start a new native app mobile driver

  throws:

  AppiumStartException

  throws:

  IOException

  throws:

  InterruptedException

  throws:

  MobileDriverInitializeException

  throws:

  IOSWebkitStartException

  throws:

  URISyntaxException

  Parameters:

  appFile - the absolute path of the application file

  uninstallAfterCloseApp - true to un-install the app after execution

  Returns:

  the newly created driver with type AppiumDriver

• public static AppiumDriver startRemoteMobileDriver(String remoteWebUrl, DesiredCapabilities desiredCapabilities, MobileDriverType driverType, String appFile)