Package io.appium.java_client.windows.options

Class WindowsOptions

java.lang.Object

org.openqa.selenium.MutableCapabilities

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

io.appium.java_client.windows.options.WindowsOptions

All Implemented Interfaces:

CanSetCapability<WindowsOptions>, SupportsAppOption<WindowsOptions>, SupportsAutomationNameOption<WindowsOptions>, SupportsBrowserNameOption<WindowsOptions>, SupportsEventTimingsOption<WindowsOptions>, SupportsFullResetOption<WindowsOptions>, SupportsNewCommandTimeoutOption<WindowsOptions>, SupportsNoResetOption<WindowsOptions>, SupportsPlatformVersionOption<WindowsOptions>, SupportsPostrunOption<WindowsOptions,PowerShellData>, SupportsPrerunOption<WindowsOptions,PowerShellData>, SupportsPrintPageSourceOnFindFailureOption<WindowsOptions>, SupportsWebSocketUrlOption<WindowsOptions>, SupportsAppArgumentsOption<WindowsOptions>, SupportsAppTopLevelWindowOption<WindowsOptions>, SupportsAppWorkingDirOption<WindowsOptions>, SupportsCreateSessionTimeoutOption<WindowsOptions>, SupportsMsExperimentalWebDriverOption<WindowsOptions>, SupportsMsWaitForAppLaunchOption<WindowsOptions>, SupportsSystemPortOption<WindowsOptions>, Serializable, org.openqa.selenium.Capabilities

public class WindowsOptions
extends BaseOptions<WindowsOptions>
implements SupportsAppOption<WindowsOptions>, SupportsAppArgumentsOption<WindowsOptions>, SupportsAppTopLevelWindowOption<WindowsOptions>, SupportsAppWorkingDirOption<WindowsOptions>, SupportsCreateSessionTimeoutOption<WindowsOptions>, SupportsMsWaitForAppLaunchOption<WindowsOptions>, SupportsMsExperimentalWebDriverOption<WindowsOptions>, SupportsSystemPortOption<WindowsOptions>, SupportsPrerunOption<WindowsOptions,PowerShellData>, SupportsPostrunOption<WindowsOptions,PowerShellData>

https://github.com/appium/appium-windows-driver#usage.

See Also:

• Serialized Form

Field Summary

Fields inherited from interface io.appium.java_client.windows.options.SupportsAppArgumentsOption

APP_ARGUMENTS_OPTION

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

APP_OPTION

Fields inherited from interface io.appium.java_client.windows.options.SupportsAppTopLevelWindowOption

APP_TOP_LEVEL_WINDOW_OPTION

Fields inherited from interface io.appium.java_client.windows.options.SupportsAppWorkingDirOption

APP_WORKING_DIR_OPTION

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

AUTOMATION_NAME_OPTION

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

BROWSER_NAME_OPTION

Fields inherited from interface io.appium.java_client.windows.options.SupportsCreateSessionTimeoutOption

CREATE_SESSION_TIMEOUT_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.windows.options.SupportsMsExperimentalWebDriverOption

MS_EXPERIMENTAL_WEBDRIVER_OPTION

Fields inherited from interface io.appium.java_client.windows.options.SupportsMsWaitForAppLaunchOption

MS_WAIT_FOR_APP_LAUNCH_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.windows.options.SupportsSystemPortOption

SYSTEM_PORT_OPTION

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

WEB_SOCKET_URL

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
Optional<PowerShellData>	getPostrun()	Get the postrun script.
Optional<PowerShellData>	getPrerun()	Get the prerun script.
WindowsOptions	setPostrun(PowerShellData script)	An object containing either script or command key.
WindowsOptions	setPrerun(PowerShellData 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.windows.options.SupportsAppArgumentsOption

setAppArguments, setAppArguments

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

getApp, setApp, setApp

Methods inherited from interface io.appium.java_client.windows.options.SupportsAppTopLevelWindowOption

getAppTopLevelWindow, setAppTopLevelWindow

Methods inherited from interface io.appium.java_client.windows.options.SupportsAppWorkingDirOption

getAppWorkingDir, setAppWorkingDir

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

getAutomationName, setAutomationName

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

withBrowserName

Methods inherited from interface io.appium.java_client.windows.options.SupportsCreateSessionTimeoutOption

getCreateSessionTimeout, setCreateSessionTimeout

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.windows.options.SupportsMsExperimentalWebDriverOption

experimentalWebDriver, isExperimentalWebDriver, setExperimentalWebDriver

Methods inherited from interface io.appium.java_client.windows.options.SupportsMsWaitForAppLaunchOption

doesWaitForAppLaunch, setWaitForAppLaunch

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.windows.options.SupportsSystemPortOption

getSystemPort, setSystemPort

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

enableBiDi, getWebSocketUrl, setWebSocketUrl

Constructor Details

WindowsOptions

public WindowsOptions()

WindowsOptions

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

WindowsOptions

public WindowsOptions(Map<String,?> source)

Method Details

setPrerun

public WindowsOptions setPrerun(PowerShellData script)

An object containing either script or command key. The value of each key must be a valid PowerShell script or command to be executed prior to the WinAppDriver session startup. See https://github.com/appium/appium-windows-driver#power-shell-commands-execution for more details.

Specified by:

setPrerun in interface SupportsPrerunOption<WindowsOptions,PowerShellData>

Parameters:

script - E.g. {script: 'Get-Process outlook -ErrorAction SilentlyContinue'}.

Returns:

self instance for chaining.

getPrerun

public Optional<PowerShellData> getPrerun()

Get the prerun script.

Specified by:

getPrerun in interface SupportsPrerunOption<WindowsOptions,PowerShellData>

Returns:

Prerun script.

setPostrun

public WindowsOptions setPostrun(PowerShellData script)

An object containing either script or command key. The value of each key must be a valid PowerShell script or command to be executed after an WinAppDriver session is finished. See https://github.com/appium/appium-windows-driver#power-shell-commands-execution for more details.

Specified by:

setPostrun in interface SupportsPostrunOption<WindowsOptions,PowerShellData>

Parameters:

script - E.g. {script: 'Get-Process outlook -ErrorAction SilentlyContinue'}.

Returns:

self instance for chaining.

getPostrun

public Optional<PowerShellData> getPostrun()

Get the postrun script.

Specified by:

getPostrun in interface SupportsPostrunOption<WindowsOptions,PowerShellData>

Returns:

Postrun script.