selenium-webdriver
Version:
The official WebDriver JavaScript bindings from the Selenium project
44 lines • 8.33 kB
HTML
<meta charset="UTF-8"><meta name="viewport" content="width=device-width, initial-scale=1, minimum-scale=1, maximum-scale=1, user-scalable=no"><meta http-equiv="Content-Language" content="en"><meta http-equiv="X-UA-Compatible" content="IE=edge"><title>Options</title><link href="dossier.css" rel="stylesheet" type="text/css"><header><div><form><div><input type="search" placeholder="Search" tabindex="1"></div></form></div></header><main><article><div class="parentlink"><b>Module:</b> <a href="module_selenium-webdriver_opera.html">selenium-webdriver/opera</a></div><div class="codelink"><a href="source/opera.js.src.html#l496">View Source</a></div><h1>class Options</h1><pre class="inheritance"><a href="class_webdriver_Serializable.html">webdriver.Serializable</a>
└ Options</pre><p>Class for managing <a href="module_selenium-webdriver_opera_class_Driver.html"><code>OperaDriver</code></a> specific options.</p>
<h3>new Options()</h3><div><div class="fn-details"><div><b>Parameters</b></div><dl><dd>None.</dl></div></div><h2>Instance Methods</h2><div id="addArguments" class="function"><div><h3>addArguments(<wbr>var_args)<span class="codelink"><a href="source/opera.js.src.html#l332">code »</a></span></h3><p>Add additional command line arguments to use when launching the Opera
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".</p>
<div><div class="fn-details"><div><b>Parameters</b></div><dl><dt>var_args<code>...(<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/Array">Array</a><<a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String">string</a>>)</code><dd><p>The arguments to add.</p>
</dl></div><div class="fn-details"><div><b>Returns</b></div><dl><dt><code><a href="module_selenium-webdriver_opera_class_Options.html">Options</a></code><dd><p>A self reference.</p>
</dl></div></div></div></div><hr class="fn-sep"><div id="addExtensions" class="function"><div><h3>addExtensions(<wbr>var_args)<span class="codelink"><a href="source/opera.js.src.html#l346">code »</a></span></h3><p>Add additional extensions to install when launching Opera. Each extension
should be specified as the path to the packed CRX file, or a Buffer for an
extension.</p>
<div><div class="fn-details"><div><b>Parameters</b></div><dl><dt>var_args<code>...(<a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String">string</a>|Buffer|<a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array">Array</a><(<a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String">string</a>|Buffer)>)</code><dd><p>The
extensions to add.</p>
</dl></div><div class="fn-details"><div><b>Returns</b></div><dl><dt><code><a href="module_selenium-webdriver_opera_class_Options.html">Options</a></code><dd><p>A self reference.</p>
</dl></div></div></div></div><hr class="fn-sep"><div id="serialize" class="function"><div><h3>serialize()<span class="codelink"><a href="source/opera.js.src.html#l419">code »</a></span></h3><p>Converts this instance to its JSON wire protocol representation. Note this
function is an implementation not intended for general use.</p>
<p><b>Overrides: </b><a href="class_webdriver_Serializable.html#serialize">webdriver.Serializable</a></p><div><div class="fn-details"><div><b>Returns</b></div><dl><dt><code>(T|IThenable<T>)</code><dd><blockquote>
<p>,
localState: (Object|undefined),
logPath: (string|undefined),
prefs: (Object|undefined)}} The JSON wire protocol representation
of this instance.</p>
</blockquote>
</dl></div></div></div></div><hr class="fn-sep"><div id="setLoggingPrefs" class="function"><div><h3>setLoggingPrefs(<wbr>prefs)<span class="codelink"><a href="source/opera.js.src.html#l373">code »</a></span></h3><p>Sets the logging preferences for the new session.</p>
<div><div class="fn-details"><div><b>Parameters</b></div><dl><dt>prefs<code><a href="class_webdriver_logging_Preferences.html">webdriver.logging.Preferences</a></code><dd><p>The logging preferences.</p>
</dl></div><div class="fn-details"><div><b>Returns</b></div><dl><dt><code><a href="module_selenium-webdriver_opera_class_Options.html">Options</a></code><dd><p>A self reference.</p>
</dl></div></div></div></div><hr class="fn-sep"><div id="setOperaBinaryPath" class="function"><div><h3>setOperaBinaryPath(<wbr>path)<span class="codelink"><a href="source/opera.js.src.html#l362">code »</a></span></h3><p>Sets the path to the Opera binary to use. On Mac OS X, this path should
reference the actual Opera executable, not just the application binary. The
binary path be absolute or relative to the operadriver server executable, but
it must exist on the machine that will launch Opera.</p>
<div><div class="fn-details"><div><b>Parameters</b></div><dl><dt>path<code><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String">string</a></code><dd><p>The path to the Opera binary to use.</p>
</dl></div><div class="fn-details"><div><b>Returns</b></div><dl><dt><code><a href="module_selenium-webdriver_opera_class_Options.html">Options</a></code><dd><p>A self reference.</p>
</dl></div></div></div></div><hr class="fn-sep"><div id="setProxy" class="function"><div><h3>setProxy(<wbr>proxy)<span class="codelink"><a href="source/opera.js.src.html#l384">code »</a></span></h3><p>Sets the proxy settings for the new session.</p>
<div><div class="fn-details"><div><b>Parameters</b></div><dl><dt>proxy<code><a href="module_selenium-webdriver.html">selenium-webdriver.ProxyConfig</a></code><dd><p>The proxy configuration to use.</p>
</dl></div><div class="fn-details"><div><b>Returns</b></div><dl><dt><code><a href="module_selenium-webdriver_opera_class_Options.html">Options</a></code><dd><p>A self reference.</p>
</dl></div></div></div></div><hr class="fn-sep"><div id="toCapabilities" class="function"><div><h3>toCapabilities(<wbr>opt_capabilities)<span class="codelink"><a href="source/opera.js.src.html#l396">code »</a></span></h3><p>Converts this options instance to a <a href="class_webdriver_Capabilities.html"><code>webdriver.Capabilities</code></a> object.</p>
<div><div class="fn-details"><div><b>Parameters</b></div><dl><dt>opt_capabilities<code>?<a href="module_selenium-webdriver_class_Capabilities.html">Capabilities</a>=</code><dd><p>The capabilities to merge
these options into, if any.</p>
</dl></div><div class="fn-details"><div><b>Returns</b></div><dl><dt><code><a href="class_webdriver_Capabilities.html">webdriver.Capabilities</a></code><dd><p>The capabilities.</p>
</dl></div></div></div></div><h2>Static Functions</h2><div id="Options.fromCapabilities" class="function"><div><h3>Options.fromCapabilities(<wbr>capabilities)<span class="codelink"><a href="source/opera.js.src.html#l297">code »</a></span></h3><p>Extracts the OperaDriver specific options from the given capabilities
object.</p>
<div><div class="fn-details"><div><b>Parameters</b></div><dl><dt>capabilities<code><a href="module_selenium-webdriver_class_Capabilities.html">Capabilities</a></code><dd><p>The capabilities object.</p>
</dl></div><div class="fn-details"><div><b>Returns</b></div><dl><dt><code><a href="module_selenium-webdriver_opera_class_Options.html">Options</a></code><dd><p>The OperaDriver options.</p>
</dl></div></div></div></div></article><nav><h3><a href="index.html" tabindex="2">Overview</a></h3><div><input type="checkbox" id="nav-modules" checked/><label for="nav-modules"><h3><span class="selectable" tabindex="2">Modules</span></h3></label><div id="nav-modules-view"></div></div><div><input type="checkbox" id="nav-types" checked/><label for="nav-types"><h3><span class="selectable" tabindex="2">Types</span></h3></label><div id="nav-types-view"></div></div><h3><a href="Changes.html" tabindex="2">Changes</a></h3></nav></main><footer><div><a href="https://github.com/jleyba/js-dossier">Generated by dossier</a></div></footer><script src="types.js"></script><script src="dossier.js"></script>