SupportsWebSocketUrlOption (java-client API)

All Superinterfaces:

CanSetCapability<T>, org.openqa.selenium.Capabilities, java.io.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 java.lang.String WEB_SOCKET_URL

Method Summary

All Methods Instance Methods Default Methods
Modifier and Type	Method	Description
`default T`	`enableBiDi()`	Enable BiDi session support.
`default java.util.Optional<java.lang.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, getBrowserName, getBrowserVersion, getCapability, getCapabilityNames, getPlatformName, is, merge

- Field Detail
  - WEB_SOCKET_URL
```
static final java.lang.String WEB_SOCKET_URL
```
    See Also:
    
    Constant Field Values
- Method Detail
  - 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 java.util.Optional<java.lang.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