Package io.appium.java_client.mac.options

Class Mac2Options

java.lang.Object

org.openqa.selenium.MutableCapabilities

io.appium.java_client.remote.options.BaseOptions<Mac2Options>

io.appium.java_client.mac.options.Mac2Options

All Implemented Interfaces:

SupportsArgumentsOption<Mac2Options>, SupportsBootstrapRootOption<Mac2Options>, SupportsBundleIdOption<Mac2Options>, SupportsEnvironmentOption<Mac2Options>, SupportsServerStartupTimeoutOption<Mac2Options>, SupportsShowServerLogsOption<Mac2Options>, SupportsSkipAppKillOption<Mac2Options>, SupportsSystemHostOption<Mac2Options>, SupportsSystemPortOption<Mac2Options>, SupportsWebDriverAgentMacUrlOption<Mac2Options>, CanSetCapability<Mac2Options>, SupportsAutomationNameOption<Mac2Options>, SupportsBrowserNameOption<Mac2Options>, SupportsEventTimingsOption<Mac2Options>, SupportsFullResetOption<Mac2Options>, SupportsNewCommandTimeoutOption<Mac2Options>, SupportsNoResetOption<Mac2Options>, SupportsPlatformVersionOption<Mac2Options>, SupportsPostrunOption<Mac2Options,AppleScriptData>, SupportsPrerunOption<Mac2Options,AppleScriptData>, SupportsPrintPageSourceOnFindFailureOption<Mac2Options>, SupportsWebSocketUrlOption<Mac2Options>, Serializable, org.openqa.selenium.Capabilities

public class Mac2Options
extends BaseOptions<Mac2Options>
implements SupportsSystemPortOption<Mac2Options>, SupportsSystemHostOption<Mac2Options>, SupportsWebDriverAgentMacUrlOption<Mac2Options>, SupportsBootstrapRootOption<Mac2Options>, SupportsBundleIdOption<Mac2Options>, SupportsArgumentsOption<Mac2Options>, SupportsEnvironmentOption<Mac2Options>, SupportsServerStartupTimeoutOption<Mac2Options>, SupportsSkipAppKillOption<Mac2Options>, SupportsShowServerLogsOption<Mac2Options>, SupportsPrerunOption<Mac2Options,AppleScriptData>, SupportsPostrunOption<Mac2Options,AppleScriptData>

Provides options specific to the Appium Mac2 Driver.

For more details, refer to the capabilities documentation

See Also:

• Serialized Form

Field Summary

Fields inherited from interface io.appium.java_client.mac.options.SupportsArgumentsOption

ARGUMENTS_OPTION

Fields inherited from interface io.appium.java_client.remote.options.SupportsAutomationNameOption

AUTOMATION_NAME_OPTION

Fields inherited from interface io.appium.java_client.mac.options.SupportsBootstrapRootOption

BOOTSTRAP_ROOT_OPTION

Fields inherited from interface io.appium.java_client.remote.options.SupportsBrowserNameOption

BROWSER_NAME_OPTION

Fields inherited from interface io.appium.java_client.mac.options.SupportsBundleIdOption

BUNDLE_ID_OPTION

Fields inherited from interface io.appium.java_client.mac.options.SupportsEnvironmentOption

ENVIRONMENT_OPTION

Fields inherited from interface io.appium.java_client.remote.options.SupportsEventTimingsOption

EVENT_TIMINGS_OPTION

Fields inherited from interface io.appium.java_client.remote.options.SupportsFullResetOption

FULL_RESET_OPTION

Fields inherited from interface io.appium.java_client.remote.options.SupportsNewCommandTimeoutOption

NEW_COMMAND_TIMEOUT_OPTION

Fields inherited from interface io.appium.java_client.remote.options.SupportsNoResetOption

NO_RESET_OPTION

Fields inherited from interface io.appium.java_client.remote.options.SupportsPlatformVersionOption

PLATFORM_VERSION_OPTION

Fields inherited from interface io.appium.java_client.remote.options.SupportsPostrunOption

POSTRUN_OPTION

Fields inherited from interface io.appium.java_client.remote.options.SupportsPrerunOption

PRERUN_OPTION

Fields inherited from interface io.appium.java_client.remote.options.SupportsPrintPageSourceOnFindFailureOption

PRINT_PAGE_SOURCE_ON_FIND_FAILURE_OPTION

Fields inherited from interface io.appium.java_client.mac.options.SupportsServerStartupTimeoutOption

SERVER_STARTUP_TIMEOUT_OPTION

Fields inherited from interface io.appium.java_client.mac.options.SupportsShowServerLogsOption

SHOW_SERVER_LOGS_OPTION

Fields inherited from interface io.appium.java_client.mac.options.SupportsSkipAppKillOption

SKIP_APP_KILL_OPTION

Fields inherited from interface io.appium.java_client.mac.options.SupportsSystemHostOption

SYSTEM_HOST_OPTION

Fields inherited from interface io.appium.java_client.mac.options.SupportsSystemPortOption

SYSTEM_PORT_OPTION

Fields inherited from interface io.appium.java_client.mac.options.SupportsWebDriverAgentMacUrlOption

WEB_DRIVER_AGENT_MAC_URL_OPTION

Fields inherited from interface io.appium.java_client.remote.options.SupportsWebSocketUrlOption

WEB_SOCKET_URL

Constructor Summary

Constructors

Constructor	Description
Mac2Options()
Mac2Options(Map<String,?> source)
Mac2Options(org.openqa.selenium.Capabilities source)

Method Summary

Modifier and Type	Method	Description
Optional<AppleScriptData>	getPostrun()	Get the postrun script.
Optional<AppleScriptData>	getPrerun()	Get the prerun script.
Mac2Options	setPostrun(AppleScriptData script)	An object containing either script or command key.
Mac2Options	setPrerun(AppleScriptData script)	An object containing either script or command key.

Methods inherited from class io.appium.java_client.remote.options.BaseOptions

asMap, clone, getCapability, getPlatformName, merge, setCapability, setPlatformName, toW3cName

Methods inherited from class org.openqa.selenium.MutableCapabilities

equals, getCapabilityNames, hashCode, setCapability, setCapability, setCapability, toJson, toString

Methods inherited from class java.lang.Object

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

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

amend, setCapability

Methods inherited from interface org.openqa.selenium.Capabilities

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

Methods inherited from interface io.appium.java_client.mac.options.SupportsArgumentsOption

getArguments, setArguments

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

getAutomationName, setAutomationName

Methods inherited from interface io.appium.java_client.mac.options.SupportsBootstrapRootOption

getBootstrapRoot, setBootstrapRoot

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

withBrowserName

Methods inherited from interface io.appium.java_client.mac.options.SupportsBundleIdOption

getBundleId, setBundleId

Methods inherited from interface io.appium.java_client.mac.options.SupportsEnvironmentOption

getEnvironment, setEnvironment

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

doesEventTimings, eventTimings, setEventTimings

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

doesFullReset, fullReset, setFullReset

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

getNewCommandTimeout, setNewCommandTimeout

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

doesNoReset, noReset, setNoReset

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

getPlatformVersion, setPlatformVersion

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

doesPrintPageSourceOnFindFailure, printPageSourceOnFindFailure, setPrintPageSourceOnFindFailure

Methods inherited from interface io.appium.java_client.mac.options.SupportsServerStartupTimeoutOption

getServerStartupTimeout, setServerStartupTimeout

Methods inherited from interface io.appium.java_client.mac.options.SupportsShowServerLogsOption

doesShowServerLogs, setShowServerLogs, showServerLogs

Methods inherited from interface io.appium.java_client.mac.options.SupportsSkipAppKillOption

doesSkipAppKill, setSkipAppKill, skipAppKill

Methods inherited from interface io.appium.java_client.mac.options.SupportsSystemHostOption

getSystemHost, setSystemHost

Methods inherited from interface io.appium.java_client.mac.options.SupportsSystemPortOption

getSystemPort, setSystemPort

Methods inherited from interface io.appium.java_client.mac.options.SupportsWebDriverAgentMacUrlOption

getWebDriverAgentMacUrl, setWebDriverAgentMacUrl, setWebDriverAgentMacUrl

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

enableBiDi, getWebSocketUrl, setWebSocketUrl

Constructor Details

Mac2Options

public Mac2Options()

Mac2Options

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

Mac2Options

public Mac2Options(Map<String,?> source)

Method Details

setPrerun

public Mac2Options setPrerun(AppleScriptData script)

An object containing either script or command key. The value of each key must be a valid AppleScript script or command to be executed after before Mac2Driver session is started. See https://github.com/appium/appium-mac2-driver#applescript-commands-execution for more details.

Specified by:

setPrerun in interface SupportsPrerunOption<Mac2Options,AppleScriptData>

Parameters:

script - A valid AppleScript snippet.

Returns:

self instance for chaining.

getPrerun

public Optional<AppleScriptData> getPrerun()

Get the prerun script.

Specified by:

getPrerun in interface SupportsPrerunOption<Mac2Options,AppleScriptData>

Returns:

Prerun script.

setPostrun

public Mac2Options setPostrun(AppleScriptData script)

An object containing either script or command key. The value of each key must be a valid AppleScript script or command to be executed after Mac2Driver session is stopped. See https://github.com/appium/appium-mac2-driver#applescript-commands-execution for more details.

Specified by:

setPostrun in interface SupportsPostrunOption<Mac2Options,AppleScriptData>

Parameters:

script - A valid AppleScript snippet.

Returns:

self instance for chaining.

getPostrun

public Optional<AppleScriptData> getPostrun()

Get the postrun script.

Specified by:

getPostrun in interface SupportsPostrunOption<Mac2Options,AppleScriptData>

Returns:

Postrun script.