SupportsConnectHardwareKeyboardOption (java-client API)

All Superinterfaces:: CanSetCapability<T>, org.openqa.selenium.Capabilities, java.io.Serializable

All Known Implementing Classes:: XCUITestOptions

public interface SupportsConnectHardwareKeyboardOption<T extends BaseOptions<T>>
extends org.openqa.selenium.Capabilities, CanSetCapability<T>

Field Summary

Fields
Modifier and Type Field Description

static java.lang.String CONNECT_HARDWARE_KEYBOARD_OPTION

Method Summary

All Methods Instance Methods Default Methods
Modifier and Type	Method	Description
`default T`	`connectHardwareKeyboard()`	Enforce connecting of hardware keyboard to Simulator.
`default java.util.Optional<java.lang.Boolean>`	`doesConnectHardwareKeyboard()`	Get whether to connect hardware keyboard to Simulator.
`default T`	`setConnectHardwareKeyboard(boolean value)`	Set this option to true in order to enable hardware keyboard in Simulator.

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
  - CONNECT_HARDWARE_KEYBOARD_OPTION
```
static final java.lang.String CONNECT_HARDWARE_KEYBOARD_OPTION
```
    See Also:
    
    Constant Field Values
- Method Detail
  - connectHardwareKeyboard
```
default T connectHardwareKeyboard()
```
    Enforce connecting of hardware keyboard to Simulator.
    
    Returns:
    
    self instance for chaining.
  - setConnectHardwareKeyboard
```
default T setConnectHardwareKeyboard(boolean value)
```
    Set this option to true in order to enable hardware keyboard in Simulator. The preference works only when Appium launches a simulator instance with this value. It is set to false by default, because this helps to workaround some XCTest bugs. connectHardwareKeyboard: true makes forceSimulatorSoftwareKeyboardPresence: false if no explicit value is set for forceSimulatorSoftwareKeyboardPresence capability since Appium 1.22.0.
    
    Parameters:
    
    value - Whether to connect hardware keyboard to Simulator.
    
    Returns:
    
    self instance for chaining.
  - doesConnectHardwareKeyboard
```
default java.util.Optional<java.lang.Boolean> doesConnectHardwareKeyboard()
```
    Get whether to connect hardware keyboard to Simulator.
    
    Returns:
    
    True or false.