ChromeOptions

java.lang.Object
- org.openqa.selenium.chrome.ChromeOptions

public class ChromeOptions
extends java.lang.Object

Class to manage options specific to ChromeDriver.

Example usage:


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

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

 // or alternatively:
 DesiredCapabilities capabilities = DesiredCapabilities.chrome();
 capabilities.setCapability(ChromeOptions.CAPABILITY, options);
 ChromeDriver driver = new ChromeDriver(capabilities);

 // For use with RemoteWebDriver:
 DesiredCapabilities capabilities = DesiredCapabilities.chrome();
 capabilities.setCapability(ChromeOptions.CAPABILITY, options);
 RemoteWebDriver driver = new RemoteWebDriver(
     new URL("http://localhost:4444/wd/hub"), capabilities);

Since:: Since chromedriver v17.0.963.0

Field Summary

Fields
Modifier and Type Field and Description

static java.lang.String CAPABILITY
Key used to store a set of ChromeOptions in a DesiredCapabilities object.

Fields
Modifier and Type	Field and Description
`static java.lang.String`	`CAPABILITY` Key used to store a set of ChromeOptions in a `DesiredCapabilities` object.

Constructor Summary

Constructors
Constructor and Description

ChromeOptions()

Constructors
Constructor and Description
`ChromeOptions()`

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`addArguments(java.util.List<java.lang.String> arguments)` Adds additional command line arguments to be used when starting Chrome.
`void`	`addArguments(java.lang.String... arguments)`
`void`	`addEncodedExtensions(java.util.List<java.lang.String> encoded)` Adds a new Chrome extension to install on browser startup.
`void`	`addEncodedExtensions(java.lang.String... encoded)`
`void`	`addExtensions(java.io.File... paths)`
`void`	`addExtensions(java.util.List<java.io.File> paths)` Adds a new Chrome extension to install on browser startup.
`boolean`	`equals(java.lang.Object other)`
`java.lang.Object`	`getExperimentalOption(java.lang.String name)` Returns the value of an experimental option.
`int`	`hashCode()`
`void`	`setBinary(java.io.File path)` Sets the path to the Chrome executable.
`void`	`setBinary(java.lang.String path)` Sets the path to the Chrome executable.
`void`	`setExperimentalOption(java.lang.String name, java.lang.Object value)` Sets an experimental option.
`com.google.gson.JsonElement`	`toJson()` Converts this instance to its JSON representation.

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - CAPABILITY
```
public static final java.lang.String CAPABILITY
```
    Key used to store a set of ChromeOptions in a DesiredCapabilities object.
    
    See Also:
    Constant Field Values
- Constructor Detail
  - ChromeOptions
```
public ChromeOptions()
```
- Method Detail
  - setBinary
```
public void setBinary(java.io.File path)
```
    Sets the path to the Chrome executable. This path should exist on the machine which will launch Chrome. The path should either be absolute or relative to the location of running ChromeDriver server.
    
    Parameters:
    path - Path to Chrome executable.
  - setBinary
```
public void setBinary(java.lang.String path)
```
    Sets the path to the Chrome executable. This path should exist on the machine which will launch Chrome. The path should either be absolute or relative to the location of running ChromeDriver server.
    
    Parameters:
    path - Path to Chrome executable.
  - addArguments
```
public void addArguments(java.lang.String... arguments)
```
    Parameters:
    arguments - The arguments to use when starting Chrome.
    See Also:
    addArguments(java.util.List)
  - addArguments
```
public void addArguments(java.util.List<java.lang.String> arguments)
```
    Adds additional command line arguments to be used when starting Chrome. 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 Chrome.
  - addExtensions
```
public void addExtensions(java.io.File... paths)
```
    Parameters:
    paths - Paths to the extensions to install.
    See Also:
    addExtensions(java.util.List)
  - addExtensions
```
public void addExtensions(java.util.List<java.io.File> paths)
```
    Adds a new Chrome extension to install on browser startup. Each path should specify a packed Chrome extension (CRX file).
    
    Parameters:
    paths - Paths to the extensions to install.
  - addEncodedExtensions
```
public void addEncodedExtensions(java.lang.String... encoded)
```
    Parameters:
    encoded - Base64 encoded data of the extensions to install.
    See Also:
    addEncodedExtensions(java.util.List)
  - addEncodedExtensions
```
public void addEncodedExtensions(java.util.List<java.lang.String> encoded)
```
    Adds a new Chrome extension to install on browser startup. Each string data should specify a Base64 encoded string of packed Chrome extension (CRX file).
    
    Parameters:
    encoded - Base64 encoded data of the extensions to install.
  - setExperimentalOption
```
public void setExperimentalOption(java.lang.String name,
                         java.lang.Object value)
```
    Sets an experimental option. Useful for new ChromeDriver options not yet exposed through the ChromeOptions API.
    
    Parameters:
    name - Name of the experimental option.
    value - Value of the experimental option, which must be convertible to JSON.
  - getExperimentalOption
```
public java.lang.Object getExperimentalOption(java.lang.String name)
```
    Returns the value of an experimental option.
    
    Parameters:
    name - The option name.
    
    Returns:
    The option value, or null if not set.
  - toJson
```
public com.google.gson.JsonElement toJson()
                                   throws java.io.IOException
```
    Converts this instance to its JSON representation.
    
    Returns:
    The JSON representation of these options.
    
    Throws:
    
    java.io.IOException - If an error occurs while reading the extension files from disk.
  - equals
```
public boolean equals(java.lang.Object other)
```
    Overrides:
    
    equals in class java.lang.Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class java.lang.Object

Class ChromeOptions

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

CAPABILITY

Constructor Detail

ChromeOptions

Method Detail

setBinary

setBinary

addArguments

addArguments

addExtensions

addExtensions

addEncodedExtensions

addEncodedExtensions

setExperimentalOption

getExperimentalOption

toJson

equals

hashCode