Interface SupportsUseNewWdaOption<T extends BaseOptions<T>>

All Superinterfaces:
CanSetCapability<T>, org.openqa.selenium.Capabilities, Serializable
All Known Implementing Classes:
XCUITestOptions

public interface SupportsUseNewWdaOption<T extends BaseOptions<T>> extends org.openqa.selenium.Capabilities, CanSetCapability<T>
  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final String
     
  • Method Summary

    Modifier and Type
    Method
    Description
    default Optional<Boolean>
    Get whether to uninstall of any existing WebDriverAgent app on the device under test.
    default T
    setUseNewWDA(boolean value)
    If true, forces uninstall of any existing WebDriverAgent app on device.
    default T
    Enforce uninstall of any existing WebDriverAgent app on the device under test.

    Methods inherited from interface io.appium.java_client.remote.options.CanSetCapability

    amend, setCapability

    Methods inherited from interface org.openqa.selenium.Capabilities

    asMap, get, getBrowserName, getBrowserVersion, getCapability, getCapabilityNames, getPlatformName, is, merge, required
  • Field Details

  • Method Details

    • useNewWDA

      default T useNewWDA()
      Enforce uninstall of any existing WebDriverAgent app on the device under test.
      Returns:
      self instance for chaining.
    • setUseNewWDA

      default T setUseNewWDA(boolean value)
      If true, forces uninstall of any existing WebDriverAgent app on device. Set it to true if you want to apply different startup options for WebDriverAgent for each session. Although, it is only guaranteed to work stable on Simulator. Real devices require WebDriverAgent client to run for as long as possible without reinstall/restart to avoid issues like https://github.com/facebook/WebDriverAgent/issues/507. The false value (the default behaviour since driver version 2.35.0) will try to detect currently running WDA listener executed by previous testing session(s) and reuse it if possible, which is highly recommended for real device testing and to speed up suites of multiple tests in general. A new WDA session will be triggered at the default URL (http://localhost:8100) if WDA is not listening and webDriverAgentUrl capability is not set. The negative/unset value of useNewWDA capability has no effect prior to xcuitest driver version 2.35.0.
      Parameters:
      value - Whether to force uninstall of any existing WebDriverAgent app on device.
      Returns:
      self instance for chaining.
    • doesUseNewWDA

      default Optional<Boolean> doesUseNewWDA()
      Get whether to uninstall of any existing WebDriverAgent app on the device under test.
      Returns:
      True or false.