MobileDriverFactory (Katalon Studio API Specification)

com.kms.katalon.core.mobile.keyword.internal.MobileDriverFactory

```
public class MobileDriverFactory
```

Field Summary

Fields
Modifiers	Name	Description
`static String`	`EXISTING_DRIVER_PROPERTY`
`static String`	`MOBILE_DRIVER_PROPERTY`
`static String`	`REMOTE_DRIVER_PROPERTY`

Methods Summary

Methods
Type Params	Return Type	Name and description
	`public static void`	`cleanup()` Clean up all running drivers and processes
	`public static void`	`closeDriver()` Close the current active mobile driver
	`public static String`	`getDeviceId()` Get the id of the current mobile device
	`public static String`	`getDeviceManufacturer()` Get the manufacturer of the current mobile device
	`public static String`	`getDeviceModel()` Get the model of the current mobile device
	`public static String`	`getDeviceName()` Get the name of the current mobile device
	`public static String`	`getDeviceOS()` Get the os of the current mobile device
	`public static String`	`getDeviceOSVersion()` Get the os version of the current mobile device
	`public static String`	`getDevicePlatform()` Get the platform of the current active driver
	`public static AppiumDriver<?>`	`getDriver()` Get the current active native app mobile driver
	`public static DriverType`	`getExecutedDriver()` Get the native app mobile driver type of the current active driver
	`public static MobileDriverType`	`getMobileDriverType()` Get the native app mobile driver type of the current active driver
	`public static String`	`getRemoteDeviceId()` Get the id of the remote mobile device
	`public static String`	`getRemoteDeviceManufacturer()` Get the manufacturer of the remote mobile device
	`public static String`	`getRemoteDeviceModel()` Get the model of the remote mobile device
	`public static String`	`getRemoteDeviceName()` Get the name of the remote mobile device
	`public static String`	`getRemoteDeviceOS()` Get the os of the remote mobile device
	`public static String`	`getRemoteDeviceOSVersion()` Get 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`	`isUsingAndroid7OrBigger()`
	`public static void`	`setDriver(AppiumDriver<?> driver)` Sets the current active mobile driver.
	`protected static AppiumDriver<?>`	`startExistingBrowser()`
	`public static AppiumDriver<?>`	`startLocalMobileDriver(MobileDriverType osType, String deviceId, String deviceName, String platformVersion, String appFile, boolean uninstallAfterCloseApp)` Start a new native app mobile driver
	`public static AppiumDriver<?>`	`startMobileDriver(String appId)`
	`public static AppiumDriver<?>`	`startMobileDriver(String appFile, boolean uninstallAfterCloseApp)` Start a new native app mobile driver
	`public static AppiumDriver<?>`	`startRemoteMobileDriver(String remoteWebUrl, DesiredCapabilities desiredCapabilities, MobileDriverType driverType, String appFile)`

Inherited Methods Summary

Inherited Methods
Methods inherited from class	Name
`class Object`	`wait, wait, wait, equals, toString, hashCode, getClass, notify, notifyAll`

- Field Detail
  - public static final String EXISTING_DRIVER_PROPERTY
  - public static final String MOBILE_DRIVER_PROPERTY
  - public static final String REMOTE_DRIVER_PROPERTY
- Method Detail
  - public static void cleanup()
    
    Clean up all running drivers and processes
    throws:
    InterruptedException
    throws:
    IOException
  - 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
    
    Returns:
    the active mobile driver as an AppiumDriver object
  - public static DriverType 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 isUsingAndroid7OrBigger()
  - public static void setDriver(AppiumDriver<?> driver)
    
    Sets the current active mobile driver.
    Parameters:
    driver - the mobile driver to set
    Since:
    7.6.0
  - protected static AppiumDriver<?> startExistingBrowser()
  - 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
    
    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)

Summary:
Field
Method

| Detail:
Field
Method

[Java] Class MobileDriverFactory

Field Summary

Methods Summary

Inherited Methods Summary

Field Detail

public static final String EXISTING_DRIVER_PROPERTY

public static final String MOBILE_DRIVER_PROPERTY

public static final String REMOTE_DRIVER_PROPERTY

Method Detail

public static void cleanup()

public static void closeDriver()

public static String getDeviceId()

public static String getDeviceManufacturer()

public static String getDeviceModel()

public static String getDeviceName()

public static String getDeviceOS()

public static String getDeviceOSVersion()

public static String getDevicePlatform()

public static AppiumDriver<?> getDriver()

public static DriverType getExecutedDriver()

public static MobileDriverType getMobileDriverType()

public static String getRemoteDeviceId()

public static String getRemoteDeviceManufacturer()

public static String getRemoteDeviceModel()

public static String getRemoteDeviceName()

public static String getRemoteDeviceOS()

public static String getRemoteDeviceOSVersion()

public static MobileDriverType getRemoteMobileDriver()

public static Map<String, Object> getRemoteWebDriverPreferences()

public static String getRemoteWebDriverServerUrl()

public static String getRemoteWebDriverType()

public static boolean isUsingAndroid7OrBigger()

public static void setDriver(AppiumDriver<?> driver)

protected static AppiumDriver<?> startExistingBrowser()

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

public static AppiumDriver<?> startMobileDriver(String appId)

public static AppiumDriver<?> startMobileDriver(String appFile, boolean uninstallAfterCloseApp)

public static AppiumDriver<?> startRemoteMobileDriver(String remoteWebUrl, DesiredCapabilities desiredCapabilities, MobileDriverType driverType, String appFile)