Package io.appium.java_client.remote.options

Interface SupportsWebSocketUrlOption<T extends BaseOptions<T>>

All Superinterfaces:
CanSetCapability<T>, org.openqa.selenium.Capabilities, Serializable
All Known Implementing Classes:
BaseOptions, ChromiumOptions, EspressoOptions, FlutterDriverOptions, GeckoOptions, Mac2Options, SafariOptions, UiAutomator2Options, WindowsOptions, XCUITestOptions
public interface SupportsWebSocketUrlOption<T extends BaseOptions<T>> extends org.openqa.selenium.Capabilities, CanSetCapability<T>

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final String
    WEB_SOCKET_URL
     

  • Method Summary

    Modifier and Type
    Method
    Description
    default T
    enableBiDi()
    Enable BiDi session support.
    default Optional<Object>
    getWebSocketUrl()
    For input capabilities: whether enable BiDi session support is enabled.
    default T
    setWebSocketUrl(boolean value)
    Whether to enable BiDi session support.

    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

    • enableBiDi

      default T enableBiDi()
      Enable BiDi session support.
      Returns:
      self instance for chaining.

    • setWebSocketUrl

      default T setWebSocketUrl(boolean value)
      Whether to enable BiDi session support.
      Returns:
      self instance for chaining.

    • getWebSocketUrl

      default Optional<Object> getWebSocketUrl()
      For input capabilities: whether enable BiDi session support is enabled. For session creation response capabilities: BiDi web socket URL.
      Returns:
      If called on request capabilities if BiDi support is enabled for the driver session