SupportsUnlockKeyOption (java-client API)

All Superinterfaces:

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

All Known Implementing Classes:

EspressoOptions, UiAutomator2Options
```
public interface SupportsUnlockKeyOption<T extends BaseOptions<T>>
extends org.openqa.selenium.Capabilities, CanSetCapability<T>
```

Field Summary

Fields
Modifier and Type Field Description

static java.lang.String UNLOCK_KEY_OPTION

Method Summary

All Methods Instance Methods Default Methods
Modifier and Type	Method	Description
`default java.util.Optional<java.lang.String>`	`getUnlockKey()`	Get the unlock key.
`default T`	`setUnlockKey(java.lang.String unlockKey)`	Allows to set an unlock key.

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, getPlatform, getPlatformName, getVersion, is, merge

- Field Detail
  - UNLOCK_KEY_OPTION
```
static final java.lang.String UNLOCK_KEY_OPTION
```
    See Also:
    
    Constant Field Values
- Method Detail
  - setUnlockKey
```
default T setUnlockKey(java.lang.String unlockKey)
```
    Allows to set an unlock key. Read [Unlock tutorial](https://github.com/appium/appium-android-driver/blob/master/docs/UNLOCK.md) for more details.
    
    Parameters:
    
    unlockKey - The unlock key.
    
    Returns:
    
    self instance for chaining.
  - getUnlockKey
```
default java.util.Optional<java.lang.String> getUnlockKey()
```
    Get the unlock key.
    
    Returns:
    
    Unlock key.