io.appium.java_client.android.options.locking

Interface SupportsSkipUnlockOption<T extends BaseOptions<T>>

All Superinterfaces:

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

All Known Implementing Classes:

EspressoOptions, UiAutomator2Options

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

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	SKIP_UNLOCK_OPTION

Method Summary

Modifier and Type	Method and Description
default java.util.Optional<java.lang.Boolean>	doesSkipUnlock() Get whether to skip the check for lock screen presence.
default T	setSkipUnlock(boolean value) Whether to skip the check for lock screen presence (true).
default T	skipUnlock() Skip the check for lock screen presence.

Methods inherited from interface org.openqa.selenium.Capabilities

asMap, getBrowserName, getBrowserVersion, getCapability, getCapabilityNames, getPlatformName, is, merge

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

amend, setCapability

Field Detail

SKIP_UNLOCK_OPTION

static final java.lang.String SKIP_UNLOCK_OPTION

See Also:

Constant Field Values

Method Detail

skipUnlock

default T skipUnlock()

Skip the check for lock screen presence.

Returns:

self instance for chaining.

setSkipUnlock

default T setSkipUnlock(boolean value)

Whether to skip the check for lock screen presence (true). By default, UiAutomator2 driver tries to detect if the device's screen is locked before starting the test and to unlock that (which sometimes might be unstable). Note, that this operation takes some time, so it is highly recommended to set this capability to true and disable screen locking on devices under test.

Parameters:

value - Set it to true in order to skip screen unlock checks.

Returns:

self instance for chaining.

doesSkipUnlock

default java.util.Optional<java.lang.Boolean> doesSkipUnlock()

Get whether to skip the check for lock screen presence.

Returns:

True or false.