io.appium.java_client.remote

Class MobileOptions<T extends MobileOptions<T>>

java.lang.Object

org.openqa.selenium.MutableCapabilities

io.appium.java_client.remote.MobileOptions<T>

All Implemented Interfaces:

java.io.Serializable, org.openqa.selenium.Capabilities

Direct Known Subclasses:

AndroidOptions, IOSOptions

public class MobileOptions<T extends MobileOptions<T>>
extends org.openqa.selenium.MutableCapabilities

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
MobileOptions() Creates new instance with no preset capabilities.
MobileOptions(org.openqa.selenium.Capabilities source) Creates new instance with provided capabilities capabilities.

Method Summary

Modifier and Type	Method and Description
protected T	amend(java.lang.String optionName, java.lang.Object value)
protected int	amendHashCode()
boolean	doesAutoWebview() Get whether the app moves directly into Webview context.
boolean	doesClearSystemFiles() Get whether the app deletes generated files at the end of a session.
boolean	doesEventTimings() Get whether the app reports the timings for various Appium-internal events.
boolean	doesFullReset() Get whether the app does a full reset.
boolean	doesNoReset() Get whether the app does not do a reset.
boolean	doesPrintPageSourceOnFindFailure() Get whether the app to print page source when a find operation fails.
java.lang.String	getApp() Get the app location.
java.lang.String	getAutomationName() Get the automation engine to use.
java.lang.String	getDeviceName() Get the name of the device.
java.lang.String	getLanguage() Get language abbreviation for use in session.
java.lang.String	getLocale() Get locale abbreviation for use in session.
java.time.Duration	getNewCommandTimeout() Get the timeout for new commands.
org.openqa.selenium.ScreenOrientation	getOrientation() Get the orientation of the screen.
java.lang.String	getOtherApps() Get the list of apps to install before running a test.
java.lang.String	getPlatformName() Get the kind of mobile device or emulator to use.
java.lang.String	getPlatformVersion() Get the version of the platform.
java.lang.String	getUdid() Get the id of the device.
boolean	isEnablePerformanceLogging() Get the app logs performance.
T	merge(org.openqa.selenium.Capabilities extraCapabilities)
T	setApp(java.lang.String path) Set the absolute local path for the location of the App.
T	setApp(java.net.URL url) Set the remote http URL for the location of the App.
T	setAutomationName(java.lang.String name) Set the automation engine to use.
T	setAutoWebview() Set the app to move directly into Webview context.
T	setAutoWebview(boolean bool) Set whether the app moves directly into Webview context.
T	setClearSystemFiles() Set the app to delete any generated files at the end of a session.
T	setClearSystemFiles(boolean bool) Set whether the app deletes generated files at the end of a session.
T	setDeviceName(java.lang.String deviceName) Set the name of the device.
T	setEnablePerformanceLogging() Set the app to enable performance logging.
T	setEnablePerformanceLogging(boolean bool) Set whether the app logs performance.
T	setEventTimings() Set the app to report the timings for various Appium-internal events.
T	setEventTimings(boolean bool) Set whether the app reports the timings for various Appium-internal events.
T	setFullReset() Set the app to do a full reset.
T	setFullReset(boolean bool) Set whether the app does a full reset.
T	setLanguage(java.lang.String language) Set language abbreviation for use in session.
T	setLocale(java.lang.String locale) Set locale abbreviation for use in session.
T	setNewCommandTimeout(java.time.Duration duration) Set the timeout for new commands.
T	setNoReset() Set the app not to do a reset.
T	setNoReset(boolean bool) Set whether the app does not do a reset.
T	setOrientation(org.openqa.selenium.ScreenOrientation orientation) Set the orientation of the screen.
T	setOtherApps(java.lang.String apps) Set the location of the app(s) to install before running a test.
T	setPlatformName(java.lang.String platform) Set the kind of mobile device or emulator to use.
T	setPlatformVersion(java.lang.String version) Set the version of the platform.
T	setPrintPageSourceOnFindFailure() Set the app to print page source when a find operation fails.
T	setPrintPageSourceOnFindFailure(boolean bool) Set whether the app to print page source when a find operation fails.
T	setUdid(java.lang.String id) Set the id of the device.

Methods inherited from class org.openqa.selenium.MutableCapabilities

setCapability, setCapability, setCapability, setCapability

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.openqa.selenium.Capabilities

getBrowserName, getVersion, is, isJavascriptEnabled

Constructor Detail

MobileOptions

public MobileOptions()

Creates new instance with no preset capabilities.

MobileOptions

public MobileOptions(org.openqa.selenium.Capabilities source)

Creates new instance with provided capabilities capabilities.

Parameters:

source - is Capabilities instance to merge into new instance

Method Detail

setPlatformName

public T setPlatformName(java.lang.String platform)

Set the kind of mobile device or emulator to use.

Parameters:

platform - the kind of mobile device or emulator to use.

Returns:

this MobileOptions, for chaining.

See Also:

CapabilityType.PLATFORM_NAME

getPlatformName

public java.lang.String getPlatformName()

Get the kind of mobile device or emulator to use.

Returns:

String representing the kind of mobile device or emulator to use.

See Also:

CapabilityType.PLATFORM_NAME

setApp

public T setApp(java.lang.String path)

Set the absolute local path for the location of the App. The or remote http URL to a .ipa file (IOS),

Parameters:

path - is a String representing the location of the App

Returns:

this MobileOptions, for chaining.

See Also:

MobileCapabilityType.APP

setApp

public T setApp(java.net.URL url)

Set the remote http URL for the location of the App.

Parameters:

url - is the URL representing the location of the App

Returns:

this MobileOptions, for chaining.

See Also:

MobileCapabilityType.APP

getApp

public java.lang.String getApp()

Get the app location.

Returns:

String representing app location

See Also:

MobileCapabilityType.APP

setAutomationName

public T setAutomationName(java.lang.String name)

Set the automation engine to use.

Parameters:

name - is the name of the automation engine

Returns:

this MobileOptions, for chaining.

See Also:

MobileCapabilityType.AUTOMATION_NAME

getAutomationName

public java.lang.String getAutomationName()

Get the automation engine to use.

Returns:

String representing the name of the automation engine

See Also:

MobileCapabilityType.AUTOMATION_NAME

setAutoWebview

public T setAutoWebview()

Set the app to move directly into Webview context.

Returns:

this MobileOptions, for chaining.

See Also:

MobileCapabilityType.AUTO_WEBVIEW

setAutoWebview

public T setAutoWebview(boolean bool)

Set whether the app moves directly into Webview context.

Parameters:

bool - is whether the app moves directly into Webview context.

Returns:

this MobileOptions, for chaining.

See Also:

MobileCapabilityType.AUTO_WEBVIEW

doesAutoWebview

public boolean doesAutoWebview()

Get whether the app moves directly into Webview context.

Returns:

true if app moves directly into Webview context.

See Also:

MobileCapabilityType.AUTO_WEBVIEW

setClearSystemFiles

public T setClearSystemFiles()

Set the app to delete any generated files at the end of a session.

Returns:

this MobileOptions, for chaining.

See Also:

MobileCapabilityType.CLEAR_SYSTEM_FILES

setClearSystemFiles

public T setClearSystemFiles(boolean bool)

Set whether the app deletes generated files at the end of a session.

Parameters:

bool - is whether the app deletes generated files at the end of a session.

Returns:

this MobileOptions, for chaining.

See Also:

MobileCapabilityType.CLEAR_SYSTEM_FILES

doesClearSystemFiles

public boolean doesClearSystemFiles()

Get whether the app deletes generated files at the end of a session.

Returns:

true if the app deletes generated files at the end of a session.

See Also:

MobileCapabilityType.CLEAR_SYSTEM_FILES

setDeviceName

public T setDeviceName(java.lang.String deviceName)

Set the name of the device.

Parameters:

deviceName - is the name of the device.

Returns:

this MobileOptions, for chaining.

See Also:

MobileCapabilityType.DEVICE_NAME

getDeviceName

public java.lang.String getDeviceName()

Get the name of the device.

Returns:

String representing the name of the device.

See Also:

MobileCapabilityType.DEVICE_NAME

setEnablePerformanceLogging

public T setEnablePerformanceLogging()

Set the app to enable performance logging.

Returns:

this MobileOptions, for chaining.

See Also:

MobileCapabilityType.ENABLE_PERFORMANCE_LOGGING

setEnablePerformanceLogging

public T setEnablePerformanceLogging(boolean bool)

Set whether the app logs performance.

Parameters:

bool - is whether the app logs performance.

Returns:

this MobileOptions, for chaining.

See Also:

MobileCapabilityType.ENABLE_PERFORMANCE_LOGGING

isEnablePerformanceLogging

public boolean isEnablePerformanceLogging()

Get the app logs performance.

Returns:

true if the app logs performance.

See Also:

MobileCapabilityType.ENABLE_PERFORMANCE_LOGGING

setEventTimings

public T setEventTimings()

Set the app to report the timings for various Appium-internal events.

Returns:

this MobileOptions, for chaining.

See Also:

MobileCapabilityType.EVENT_TIMINGS

setEventTimings

public T setEventTimings(boolean bool)

Set whether the app reports the timings for various Appium-internal events.

Parameters:

bool - is whether the app enables event timings.

Returns:

this MobileOptions, for chaining.

See Also:

MobileCapabilityType.EVENT_TIMINGS

doesEventTimings

public boolean doesEventTimings()

Get whether the app reports the timings for various Appium-internal events.

Returns:

true if the app reports event timings.

See Also:

MobileCapabilityType.EVENT_TIMINGS

setFullReset

public T setFullReset()

Set the app to do a full reset.

Returns:

this MobileOptions, for chaining.

See Also:

MobileCapabilityType.FULL_RESET

setFullReset

public T setFullReset(boolean bool)

Set whether the app does a full reset.

Parameters:

bool - is whether the app does a full reset.

Returns:

this MobileOptions, for chaining.

See Also:

MobileCapabilityType.FULL_RESET

doesFullReset

public boolean doesFullReset()

Get whether the app does a full reset.

Returns:

true if the app does a full reset.

See Also:

MobileCapabilityType.FULL_RESET

setLanguage

public T setLanguage(java.lang.String language)

Set language abbreviation for use in session.

Parameters:

language - is the language abbreviation.

Returns:

this MobileOptions, for chaining.

See Also:

MobileCapabilityType.LANGUAGE

getLanguage

public java.lang.String getLanguage()

Get language abbreviation for use in session.

Returns:

String representing the language abbreviation.

See Also:

MobileCapabilityType.LANGUAGE

setLocale

public T setLocale(java.lang.String locale)

Set locale abbreviation for use in session.

Parameters:

locale - is the locale abbreviation.

Returns:

this MobileOptions, for chaining.

See Also:

MobileCapabilityType.LOCALE

getLocale

public java.lang.String getLocale()

Get locale abbreviation for use in session.

Returns:

String representing the locale abbreviation.

See Also:

MobileCapabilityType.LOCALE

setNewCommandTimeout

public T setNewCommandTimeout(java.time.Duration duration)

Set the timeout for new commands.

Parameters:

duration - is the allowed time before seeing a new command.

Returns:

this MobileOptions, for chaining.

See Also:

MobileCapabilityType.NEW_COMMAND_TIMEOUT

getNewCommandTimeout

public java.time.Duration getNewCommandTimeout()

Get the timeout for new commands.

Returns:

allowed time before seeing a new command.

See Also:

MobileCapabilityType.NEW_COMMAND_TIMEOUT

setNoReset

public T setNoReset()

Set the app not to do a reset.

Returns:

this MobileOptions, for chaining.

See Also:

MobileCapabilityType.NO_RESET

setNoReset

public T setNoReset(boolean bool)

Set whether the app does not do a reset.

Parameters:

bool - is whether the app does not do a reset.

Returns:

this MobileOptions, for chaining.

See Also:

MobileCapabilityType.NO_RESET

doesNoReset

public boolean doesNoReset()

Get whether the app does not do a reset.

Returns:

true if the app does not do a reset.

See Also:

MobileCapabilityType.NO_RESET

setOrientation

public T setOrientation(org.openqa.selenium.ScreenOrientation orientation)

Set the orientation of the screen.

Parameters:

orientation - is the screen orientation.

Returns:

this MobileOptions, for chaining.

See Also:

MobileCapabilityType.ORIENTATION

getOrientation

public org.openqa.selenium.ScreenOrientation getOrientation()

Get the orientation of the screen.

Returns:

ScreenOrientation of the app.

See Also:

MobileCapabilityType.ORIENTATION

setOtherApps

public T setOtherApps(java.lang.String apps)

Set the location of the app(s) to install before running a test.

Parameters:

apps - is the apps to install.

Returns:

this MobileOptions, for chaining.

See Also:

MobileCapabilityType.OTHER_APPS

getOtherApps

public java.lang.String getOtherApps()

Get the list of apps to install before running a test.

Returns:

String of apps to install.

See Also:

MobileCapabilityType.OTHER_APPS

setPlatformVersion

public T setPlatformVersion(java.lang.String version)

Set the version of the platform.

Parameters:

version - is the platform version.

Returns:

this MobileOptions, for chaining.

See Also:

MobileCapabilityType.PLATFORM_VERSION

getPlatformVersion

public java.lang.String getPlatformVersion()

Get the version of the platform.

Returns:

String representing the platform version.

See Also:

MobileCapabilityType.PLATFORM_VERSION

setPrintPageSourceOnFindFailure

public T setPrintPageSourceOnFindFailure()

Set the app to print page source when a find operation fails.

Returns:

this MobileOptions, for chaining.

See Also:

MobileCapabilityType.PRINT_PAGE_SOURCE_ON_FIND_FAILURE

setPrintPageSourceOnFindFailure

public T setPrintPageSourceOnFindFailure(boolean bool)

Set whether the app to print page source when a find operation fails.

Parameters:

bool - is whether to print page source.

Returns:

this MobileOptions, for chaining.

See Also:

MobileCapabilityType.PRINT_PAGE_SOURCE_ON_FIND_FAILURE

doesPrintPageSourceOnFindFailure

public boolean doesPrintPageSourceOnFindFailure()

Get whether the app to print page source when a find operation fails.

Returns:

true if app prints page source.

See Also:

MobileCapabilityType.PRINT_PAGE_SOURCE_ON_FIND_FAILURE

setUdid

public T setUdid(java.lang.String id)

Set the id of the device.

Parameters:

id - is the unique device identifier.

Returns:

this MobileOptions, for chaining.

See Also:

MobileCapabilityType.UDID

getUdid

public java.lang.String getUdid()

Get the id of the device.

Returns:

String representing the unique device identifier.

See Also:

MobileCapabilityType.UDID

merge

public T merge(org.openqa.selenium.Capabilities extraCapabilities)

Specified by:

merge in interface org.openqa.selenium.Capabilities

Overrides:

merge in class org.openqa.selenium.MutableCapabilities

amend

protected T amend(java.lang.String optionName,
                  java.lang.Object value)

amendHashCode

protected int amendHashCode()