You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
22 lines
14 KiB
22 lines
14 KiB
<!DOCTYPE html><meta charset="UTF-8"><meta http-equiv="Content-Language" content="en" /><title>Options</title><link href="dossier.css" rel="stylesheet" type="text/css"><div id="main-wrapper"><input type="checkbox" id="sidenav-toggle" /><main><header><h1>Class Options</h1><a class="source" href="source/chrome.js.src.html#l470">code »</a></header><section><p>Class for managing ChromeDriver specific options.<h2>Constructor</h2><div class="ctor wrap-details public"><div><div class="ctor"><span class="member">Options <span class="args">( )</span></span></div></div></div></section><div id="visibility-controls"><b>Show:</b><label for="show-public"><span><input type="checkbox" id="show-public" checked/></span>Public</label><label for="show-protected"><span><input type="checkbox" id="show-protected"/></span>Protected</label><label for="show-private"><span><input type="checkbox" id="show-private"/></span>Private</label></div><section id="instance-methods"><h2>Instance Methods</h2><div class="wrap-details public"><div><details class="function"><summary><div><a class="source" href="source/chrome.js.src.html#l286">code »</a><span class="member"><a name="addArguments">addArguments</a> <span class="args">( var_args )</span> ⇒ <code class="type">!Options</code></span></div><p>Add additional command line arguments to use when launching the Chrome
|
|
browser. Each argument may be specified with or without the "--" prefix
|
|
(e.g. "--foo" and "foo"). Arguments with an associated value should be
|
|
delimited by an "=": "foo=bar".</summary><div class="info"><table><tbody><tr><th>Parameters<tr><td><dl><dt>var_args: <code class="type">...(<a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String">string</a>|!<a href="http://developer.mozilla.org/en/Core_JavaScript_1.5_Reference/Global_Objects/Array">Array</a>.<<a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String">string</a>>)</code><dd>The arguments to add.</dl><tr><th>Returns<tr><td><dl>A self reference.</dl></table></div></details></div></div><div class="wrap-details public"><div><details class="function"><summary><div><a class="source" href="source/chrome.js.src.html#l300">code »</a><span class="member"><a name="addExtensions">addExtensions</a> <span class="args">( var_args )</span> ⇒ <code class="type">!Options</code></span></div><p>Add additional extensions to install when launching Chrome. Each extension
|
|
should be specified as the path to the packed CRX file, or a Buffer for an
|
|
extension.</summary><div class="info"><table><tbody><tr><th>Parameters<tr><td><dl><dt>var_args: <code class="type">...(<a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String">string</a>|!Buffer|!<a href="http://developer.mozilla.org/en/Core_JavaScript_1.5_Reference/Global_Objects/Array">Array</a>)</code><dd>The
|
|
extensions to add.</dl><tr><th>Returns<tr><td><dl>A self reference.</dl></table></div></details></div></div><div class="wrap-details public"><div><details class="function"><summary><div><a class="source" href="source/chrome.js.src.html#l332">code »</a><span class="member"><a name="detachDriver">detachDriver</a> <span class="args">( detach )</span> ⇒ <code class="type">!Options</code></span></div><p>Sets whether to leave the started Chrome browser running if the controlling
|
|
ChromeDriver service is killed before <code class="type"><a href="class_webdriver_WebDriver.html#quit">webdriver.WebDriver#quit()</a></code> is
|
|
called.</summary><div class="info"><table><tbody><tr><th>Parameters<tr><td><dl><dt>detach: <code class="type"><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Boolean">boolean</a></code><dd>Whether to leave the browser running if the
|
|
chromedriver service is killed before the session.</dl><tr><th>Returns<tr><td><dl>A self reference.</dl></table></div></details></div></div><div class="wrap-details public"><div><details class="function"><summary><div><a class="source" href="source/chrome.js.src.html#l318">code »</a><span class="member"><a name="setChromeBinaryPath">setChromeBinaryPath</a> <span class="args">( path )</span> ⇒ <code class="type">!Options</code></span></div><p>Sets the path to the Chrome binary to use. On Mac OS X, this path should
|
|
reference the actual Chrome executable, not just the application binary
|
|
(e.g. "/Applications/Google Chrome.app/Contents/MacOS/Google Chrome").
|
|
|
|
The binary path be absolute or relative to the chromedriver server
|
|
executable, but it must exist on the machine that will launch Chrome.</summary><div class="info"><table><tbody><tr><th>Parameters<tr><td><dl><dt>path: <code class="type"><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String">string</a></code><dd>The path to the Chrome binary to use.</dl><tr><th>Returns<tr><td><dl>A self reference.</dl></table></div></details></div></div><div class="wrap-details public"><div><details class="function"><summary><div><a class="source" href="source/chrome.js.src.html#l379">code »</a><span class="member"><a name="setChromeLogFile">setChromeLogFile</a> <span class="args">( path )</span> ⇒ <code class="type">!Options</code></span></div><p>Sets the path to Chrome's log file. This path should exist on the machine
|
|
that will launch Chrome.</summary><div class="info"><table><tbody><tr><th>Parameters<tr><td><dl><dt>path: <code class="type"><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String">string</a></code><dd>Path to the log file to use.</dl><tr><th>Returns<tr><td><dl>A self reference.</dl></table></div></details></div></div><div class="wrap-details public"><div><details class="function"><summary><div><a class="source" href="source/chrome.js.src.html#l367">code »</a><span class="member"><a name="setLocalState">setLocalState</a> <span class="args">( state )</span> ⇒ <code class="type">!Options</code></span></div><p>Sets preferences for the "Local State" file in Chrome's user data
|
|
directory.</summary><div class="info"><table><tbody><tr><th>Parameters<tr><td><dl><dt>state: <code class="type">!<a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object">Object</a></code><dd>Dictionary of local state preferences.</dl><tr><th>Returns<tr><td><dl>A self reference.</dl></table></div></details></div></div><div class="wrap-details public"><div><details class="function"><summary><div><a class="source" href="source/chrome.js.src.html#l355">code »</a><span class="member"><a name="setLoggingPreferences">setLoggingPreferences</a> <span class="args">( prefs )</span> ⇒ <code class="type">!Options</code></span></div><p>Sets the logging preferences for the new session.</summary><div class="info"><table><tbody><tr><th>Parameters<tr><td><dl><dt>prefs: <code class="type">!<a href="namespace_webdriver_logging.html#webdriver.logging.Preferences">webdriver.logging.Preferences</a></code><dd>The logging preferences.</dl><tr><th>Returns<tr><td><dl>A self reference.</dl></table></div></details></div></div><div class="wrap-details public"><div><details class="function"><summary><div><a class="source" href="source/chrome.js.src.html#l390">code »</a><span class="member"><a name="setProxy">setProxy</a> <span class="args">( proxy )</span> ⇒ <code class="type">!Options</code></span></div><p>Sets the proxy settings for the new session.</summary><div class="info"><table><tbody><tr><th>Parameters<tr><td><dl><dt>proxy: <code class="type">ProxyConfig</code><dd>The proxy configuration to use.</dl><tr><th>Returns<tr><td><dl>A self reference.</dl></table></div></details></div></div><div class="wrap-details public"><div><details class="function"><summary><div><a class="source" href="source/chrome.js.src.html#l344">code »</a><span class="member"><a name="setUserPreferences">setUserPreferences</a> <span class="args">( prefs )</span> ⇒ <code class="type">!Options</code></span></div><p>Sets the user preferences for Chrome's user profile. See the "Preferences"
|
|
file in Chrome's user data directory for examples.</summary><div class="info"><table><tbody><tr><th>Parameters<tr><td><dl><dt>prefs: <code class="type">!<a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object">Object</a></code><dd>Dictionary of user preferences to use.</dl><tr><th>Returns<tr><td><dl>A self reference.</dl></table></div></details></div></div><div class="wrap-details public"><div><details class="function"><summary><div><a class="source" href="source/chrome.js.src.html#l402">code »</a><span class="member"><a name="toCapabilities">toCapabilities</a> <span class="args">( opt_capabilities )</span> ⇒ <code class="type">!<a href="class_webdriver_Capabilities.html">webdriver.Capabilities</a></code></span></div><p>Converts this options instance to a <code class="type"><a href="class_webdriver_Capabilities.html">webdriver.Capabilities</a></code> object.</summary><div class="info"><table><tbody><tr><th>Parameters<tr><td><dl><dt>opt_capabilities: <code class="type"><a href="class_webdriver_Capabilities.html">webdriver.Capabilities</a>=</code><dd>The capabilities to merge
|
|
these options into, if any.</dl><tr><th>Returns<tr><td><dl>The capabilities.</dl></table></div></details></div></div><div class="wrap-details public"><div><details class="function"><summary><div><a class="source" href="source/chrome.js.src.html#l424">code »</a><span class="member"><a name="toJSON">toJSON</a> <span class="args">( )</span> ⇒ <code class="type">{args: !<a href="http://developer.mozilla.org/en/Core_JavaScript_1.5_Reference/Global_Objects/Array">Array</a>.<<a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String">string</a>>, binary: (<a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String">string</a>|<a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Undefined">undefined</a>), detach: <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Boolean">boolean</a>, extensions: !<a href="http://developer.mozilla.org/en/Core_JavaScript_1.5_Reference/Global_Objects/Array">Array</a>.<<a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String">string</a>>, localState: (<a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object">Object</a>|<a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Undefined">undefined</a>), logFile: (<a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String">string</a>|<a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Undefined">undefined</a>), prefs: (<a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object">Object</a>|<a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Undefined">undefined</a>)}</code></span></div><p>Converts this instance to its JSON wire protocol representation. Note this
|
|
function is an implementation not intended for general use.</summary><div class="info"><table><tbody><tr><th>Returns<tr><td><dl>The JSON wire protocol representation
|
|
of this instance.</dl></table></div></details></div></div></section><section id="instance-properties"><h2>Instance Properties</h2><div class="wrap-details private"><div><details><summary><div><a class="source" href="source/chrome.js.src.html#l235">code »</a><span class="member"><a name="args_">args_</a> : <code class="type">!<a href="http://developer.mozilla.org/en/Core_JavaScript_1.5_Reference/Global_Objects/Array">Array</a>.<<a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String">string</a>></code></span></div></summary></details></div></div><div class="wrap-details private"><div><details><summary><div><a class="source" href="source/chrome.js.src.html#l238">code »</a><span class="member"><a name="extensions_">extensions_</a> : <code class="type">!<a href="http://developer.mozilla.org/en/Core_JavaScript_1.5_Reference/Global_Objects/Array">Array</a></code></span></div></summary></details></div></div></section><section id="static-functions"><h2>Static Functions</h2><div class="wrap-details public"><div><details class="function"><summary><div><a class="source" href="source/chrome.js.src.html#l248">code »</a><span class="member"><a name="Options.fromCapabilities">Options.fromCapabilities</a> <span class="args">( capabilities )</span> ⇒ <code class="type">!Options</code></span></div><p>Extracts the ChromeDriver specific options from the given capabilities
|
|
object.</summary><div class="info"><table><tbody><tr><th>Parameters<tr><td><dl><dt>capabilities: <code class="type">!<a href="class_webdriver_Capabilities.html">webdriver.Capabilities</a></code><dd>The capabilities object.</dl><tr><th>Returns<tr><td><dl>The ChromeDriver options.</dl></table></div></details></div></div></section></main><nav id="topnav"><div><div id="menubutton"><label for="sidenav-toggle">Menu</label></div><form id="searchbox"><div><input type="search" placeholder="Search" tabindex="1"></div></form></div></nav><nav id="sidenav"><input type="checkbox" id="sidenav-types-ctrl" /><input type="checkbox" id="sidenav-files-ctrl" /><input type="checkbox" id="sidenav-modules-ctrl" /><a id="sidenav-overview"><div><h4>Overview</h4></div></a><div id="sidenav-types"><label for="sidenav-types-ctrl"><h4>Types</h4></label><i>No data</i></div><div id="sidenav-modules"><label for="sidenav-modules-ctrl"><h4>Modules</h4></label><i>No data</i></div><div id="sidenav-files"><label for="sidenav-files-ctrl"><h4>Files</h4></label><i>No data</i></div><a href="license.html"><div><h4>License</h4></div></a></nav><div id="push-footer"></div></div><footer><a href="https://github.com/jleyba/js-dossier">Generated by dossier</a></footer><script src="types.js"></script><script src="dossier.js"></script> |