org.openqa.selenium.safari

Class SafariOptions

java.lang.Object

org.openqa.selenium.MutableCapabilities

org.openqa.selenium.safari.SafariOptions

All Implemented Interfaces:

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

public class SafariOptions
extends org.openqa.selenium.MutableCapabilities

Class to manage options specific to SafariDriver.

Example usage:

 SafariOptions options = new SafariOptions()
 options.setUseCleanSession(true);

 // For use with SafariDriver:
 SafariDriver driver = new SafariDriver(options);

 // For use with RemoteWebDriver:
 RemoteWebDriver driver = new RemoteWebDriver(
     new URL("http://localhost:4444/wd/hub"),
     options);
 

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	CAPABILITY Key used to store SafariOptions in a DesiredCapabilities object.

Constructor Summary

Constructors

Constructor and Description
SafariOptions()

Method Summary

Modifier and Type	Method and Description
static SafariOptions	fromCapabilities(org.openqa.selenium.Capabilities capabilities) Construct a SafariOptions instance from given capabilites.
int	getPort()
boolean	getUseCleanSession()
boolean	getUseTechnologyPreview()
SafariOptions	setUseCleanSession(boolean useCleanSession) Instruct the SafariDriver to delete all existing session data when starting a new session.
SafariOptions	setUseTechnologyPreview(boolean useTechnologyPreview) Instruct the SafariDriver to use the Safari Technology Preview if true, otherwise use the release version of Safari.

Methods inherited from class org.openqa.selenium.MutableCapabilities

amendHashCode, asMap, equals, getCapability, hashCode, merge, setCapability, setCapability, setCapability, setCapability, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.openqa.selenium.Capabilities

getBrowserName, getPlatform, getVersion, is, isJavascriptEnabled

Field Detail

CAPABILITY

public static final java.lang.String CAPABILITY

Key used to store SafariOptions in a DesiredCapabilities object.

See Also:

Constant Field Values

Constructor Detail

SafariOptions

public SafariOptions()

Method Detail

fromCapabilities

public static SafariOptions fromCapabilities(org.openqa.selenium.Capabilities capabilities)
                                      throws org.openqa.selenium.WebDriverException

Construct a SafariOptions instance from given capabilites. When the CAPABILITY capability is set, all other capabilities will be ignored!

Parameters:

capabilities - Desired capabilities from which the options are derived.

Returns:

SafariOptions

Throws:

org.openqa.selenium.WebDriverException - If an error occurred during the reconstruction of the options

setUseCleanSession

public SafariOptions setUseCleanSession(boolean useCleanSession)

Instruct the SafariDriver to delete all existing session data when starting a new session. This includes browser history, cache, cookies, HTML5 local storage, and HTML5 databases.

Warning: Since Safari uses a single profile for the current user, enabling this capability will permanently erase any existing session data.

Parameters:

useCleanSession - If true, the SafariDriver will erase all existing session data.

setUseTechnologyPreview

public SafariOptions setUseTechnologyPreview(boolean useTechnologyPreview)

Instruct the SafariDriver to use the Safari Technology Preview if true, otherwise use the release version of Safari. Defaults to using the release version of Safari.

Parameters:

useTechnologyPreview - If true, the SafariDriver will use the Safari Technology Preview, otherwise will use the release version of Safari.

getPort

public int getPort()

Returns:

The port the SafariDriverService should be started on. If 0, the server should select a free port.

See Also:

setPort(int)

getUseCleanSession

public boolean getUseCleanSession()

Returns:

Whether the SafariDriver should erase all session data before launching Safari.

See Also:

setUseCleanSession(boolean)

getUseTechnologyPreview

public boolean getUseTechnologyPreview()