com.microsoft.edge.seleniumtools

Class EdgeOptions

java.lang.Object

org.openqa.selenium.MutableCapabilities

com.microsoft.edge.seleniumtools.EdgeOptions

All Implemented Interfaces:

Serializable, org.openqa.selenium.Capabilities

public class EdgeOptions
extends org.openqa.selenium.MutableCapabilities

Class to manage options specific to EdgeDriver.

Example usage:

 EdgeOptions options = new EdgeOptions()
 options.addExtensions(new File("/path/to/extension.crx"))
 options.setBinary(new File("/path/to/msedge"));

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

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

Since:

Since msedgedriver v17.0.963.0

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static String	CAPABILITY Key used to store a set of EdgeOptions in a Capabilities object.
static String	USE_CHROMIUM

Constructor Summary

Constructors

Constructor and Description
EdgeOptions()

Method Summary

Modifier and Type	Method and Description
EdgeOptions	addArguments(List<String> arguments) Adds additional command line arguments to be used when starting Edge.
EdgeOptions	addArguments(String... arguments)
EdgeOptions	addEncodedExtensions(List<String> encoded) Adds a new Edge extension to install on browser startup.
EdgeOptions	addEncodedExtensions(String... encoded)
EdgeOptions	addExtensions(File... paths)
EdgeOptions	addExtensions(List<File> paths) Adds a new Edge extension to install on browser startup.
protected int	amendHashCode()
Map<String,Object>	asMap()
Object	getExperimentalOption(String name) Deprecated. Getters are not needed in browser Options classes.
EdgeOptions	merge(org.openqa.selenium.Capabilities extraCapabilities)
EdgeOptions	setAcceptInsecureCerts(boolean acceptInsecureCerts) Returns EdgeOptions with the capability ACCEPT_INSECURE_CERTS set.
EdgeOptions	setBinary(File path) Sets the path to the Edge executable.
EdgeOptions	setBinary(String path) Sets the path to the Edge executable.
EdgeOptions	setExperimentalOption(String name, Object value) Sets an experimental option.
EdgeOptions	setHeadless(boolean headless)
EdgeOptions	setPageLoadStrategy(org.openqa.selenium.PageLoadStrategy strategy)
EdgeOptions	setProxy(org.openqa.selenium.Proxy proxy)
EdgeOptions	setUnhandledPromptBehaviour(org.openqa.selenium.UnexpectedAlertBehaviour behaviour)
EdgeOptions	setUseWebView(boolean useWebView) Sets whether to launch an Edge (Chromium) WebView executable instead of launching the Edge browser.

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

Field Detail

CAPABILITY

public static final String CAPABILITY

Key used to store a set of EdgeOptions in a Capabilities object.

See Also:

Constant Field Values

USE_CHROMIUM

public static final String USE_CHROMIUM

See Also:

Constant Field Values

Constructor Detail

EdgeOptions

public EdgeOptions()

Method Detail

merge

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

Specified by:

merge in interface org.openqa.selenium.Capabilities

Overrides:

merge in class org.openqa.selenium.MutableCapabilities

setUseWebView

public EdgeOptions setUseWebView(boolean useWebView)

Sets whether to launch an Edge (Chromium) WebView executable instead of launching the Edge browser.

Parameters:

useWebView - Whether to launch a WebView executable.

setBinary

public EdgeOptions setBinary(File path)

Sets the path to the Edge executable. This path should exist on the machine which will launch Edge. The path should either be absolute or relative to the location of running EdgeDriver server.

Parameters:

path - Path to Edge executable.

setBinary

public EdgeOptions setBinary(String path)

Sets the path to the Edge executable. This path should exist on the machine which will launch Edge. The path should either be absolute or relative to the location of running EdgeDriver server.

Parameters:

path - Path to Edge executable.

addArguments

public EdgeOptions addArguments(String... arguments)

Parameters:

arguments - The arguments to use when starting Edge.

See Also:

addArguments(java.util.List)

addArguments

public EdgeOptions addArguments(List<String> arguments)

Adds additional command line arguments to be used when starting Edge. For example:

   options.setArguments(
       "load-extension=/path/to/unpacked_extension",
       "allow-outdated-plugins");
 

Each argument may contain an option "--" prefix: "--foo" or "foo". Arguments with an associated value should be delimitted with an "=": "foo=bar".

Parameters:

arguments - The arguments to use when starting Edge.

addExtensions

public EdgeOptions addExtensions(File... paths)

Parameters:

paths - Paths to the extensions to install.

See Also:

addExtensions(java.util.List)

addExtensions

public EdgeOptions addExtensions(List<File> paths)

Adds a new Edge extension to install on browser startup. Each path should specify a packed Edge extension (CRX file).

Parameters:

paths - Paths to the extensions to install.

addEncodedExtensions

public EdgeOptions addEncodedExtensions(String... encoded)

Parameters:

encoded - Base64 encoded data of the extensions to install.

See Also:

addEncodedExtensions(java.util.List)

addEncodedExtensions

public EdgeOptions addEncodedExtensions(List<String> encoded)

Adds a new Edge extension to install on browser startup. Each string data should specify a Base64 encoded string of packed Edge extension (CRX file).

Parameters:

encoded - Base64 encoded data of the extensions to install.

setExperimentalOption

public EdgeOptions setExperimentalOption(String name,
                                         Object value)

Sets an experimental option. Useful for new EdgeDriver options not yet exposed through the EdgeOptions API.

Parameters:

name - Name of the experimental option.

value - Value of the experimental option, which must be convertible to JSON.

getExperimentalOption

@Deprecated
public Object getExperimentalOption(String name)

Deprecated. Getters are not needed in browser Options classes.

Returns the value of an experimental option.

Parameters:

name - The option name.

Returns:

The option value, or null if not set.

setPageLoadStrategy

public EdgeOptions setPageLoadStrategy(org.openqa.selenium.PageLoadStrategy strategy)

setUnhandledPromptBehaviour

public EdgeOptions setUnhandledPromptBehaviour(org.openqa.selenium.UnexpectedAlertBehaviour behaviour)

setAcceptInsecureCerts

public EdgeOptions setAcceptInsecureCerts(boolean acceptInsecureCerts)

Returns EdgeOptions with the capability ACCEPT_INSECURE_CERTS set.

Parameters:

acceptInsecureCerts -

Returns:

EdgeOptions

setHeadless

public EdgeOptions setHeadless(boolean headless)

setProxy

public EdgeOptions setProxy(org.openqa.selenium.Proxy proxy)

amendHashCode

protected int amendHashCode()

asMap

public Map<String,Object> asMap()

Specified by:

asMap in interface org.openqa.selenium.Capabilities

Overrides:

asMap in class org.openqa.selenium.MutableCapabilities