selenium-webdriver
Version:
The official WebDriver JavaScript bindings from the Selenium project
89 lines • 17 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_ie.html">selenium-webdriver/ie</a></div><div class="codelink"><a href="source/ie.js.src.html#l464">View Source</a></div><h1>class Options</h1><p>Class for managing IEDriver 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/ie.js.src.html#l255">code »</a></span></h3><p>Specifies command-line switches to use when launching Internet Explorer.
This is only valid when used with <a href="module_selenium-webdriver_ie_class_Options.html#forceCreateProcessApi"><code>#forceCreateProcessApi</code></a>.</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_ie_class_Options.html">Options</a></code><dd><p>A self reference.</p>
</dl></div></div></div></div><hr class="fn-sep"><div id="browserAttachTimeout" class="function"><div><h3>browserAttachTimeout(<wbr>timeout)<span class="codelink"><a href="source/ie.js.src.html#l227">code »</a></span></h3><p>Configures the timeout, in milliseconds, that the driver will attempt to
located and attach to a newly opened instance of Internet Explorer. The
default is zero, which indicates waiting indefinitely.</p>
<div><div class="fn-details"><div><b>Parameters</b></div><dl><dt>timeout<code><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number">number</a></code><dd><p>How long to wait for IE.</p>
</dl></div><div class="fn-details"><div><b>Returns</b></div><dl><dt><code><a href="module_selenium-webdriver_ie_class_Options.html">Options</a></code><dd><p>A self reference.</p>
</dl></div></div></div></div><hr class="fn-sep"><div id="enableElementCacheCleanup" class="function"><div><h3>enableElementCacheCleanup(<wbr>enable)<span class="codelink"><a href="source/ie.js.src.html#l198">code »</a></span></h3><p>Configures whether the driver should attempt to remove obsolete
<a href="class_webdriver_WebElement.html">WebElements</a> from its internal cache on
page navigation (true by default). Disabling this option will cause the
driver to run with a larger memory footprint.</p>
<div><div class="fn-details"><div><b>Parameters</b></div><dl><dt>enable<code><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Boolean">boolean</a></code><dd><p>Whether to enable element reference cleanup.</p>
</dl></div><div class="fn-details"><div><b>Returns</b></div><dl><dt><code><a href="module_selenium-webdriver_ie_class_Options.html">Options</a></code><dd><p>A self reference.</p>
</dl></div></div></div></div><hr class="fn-sep"><div id="enablePersistentHover" class="function"><div><h3>enablePersistentHover(<wbr>enable)<span class="codelink"><a href="source/ie.js.src.html#l183">code »</a></span></h3><p>Configures whether to enable persistent mouse hovering (true by default).
Persistent hovering is achieved by continuously firing mouse over events at
the last location the mouse cursor has been moved to.</p>
<div><div class="fn-details"><div><b>Parameters</b></div><dl><dt>enable<code><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Boolean">boolean</a></code><dd><p>Whether to enable persistent hovering.</p>
</dl></div><div class="fn-details"><div><b>Returns</b></div><dl><dt><code><a href="module_selenium-webdriver_ie_class_Options.html">Options</a></code><dd><p>A self reference.</p>
</dl></div></div></div></div><hr class="fn-sep"><div id="ensureCleanSession" class="function"><div><h3>ensureCleanSession(<wbr>cleanSession)<span class="codelink"><a href="source/ie.js.src.html#l286">code »</a></span></h3><p>Configures whether to clear the cache, cookies, history, and saved form data
before starting the browser. <em>Using this capability will clear session data
for all running instances of Internet Explorer, including those started
manually.</em></p>
<div><div class="fn-details"><div><b>Parameters</b></div><dl><dt>cleanSession<code><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Boolean">boolean</a></code><dd><p>Whether to clear all session data on startup.</p>
</dl></div><div class="fn-details"><div><b>Returns</b></div><dl><dt><code><a href="module_selenium-webdriver_ie_class_Options.html">Options</a></code><dd><p>A self reference.</p>
</dl></div></div></div></div><hr class="fn-sep"><div id="forceCreateProcessApi" class="function"><div><h3>forceCreateProcessApi(<wbr>force)<span class="codelink"><a href="source/ie.js.src.html#l242">code »</a></span></h3><p>Configures whether to launch Internet Explorer using the CreateProcess API.
If this option is not specified, IE is launched using IELaunchURL, if
available. For IE 8 and above, this option requires the TabProcGrowth
registry value to be set to 0.</p>
<div><div class="fn-details"><div><b>Parameters</b></div><dl><dt>force<code><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Boolean">boolean</a></code><dd><p>Whether to use the CreateProcess API.</p>
</dl></div><div class="fn-details"><div><b>Returns</b></div><dl><dt><code><a href="module_selenium-webdriver_ie_class_Options.html">Options</a></code><dd><p>A self reference.</p>
</dl></div></div></div></div><hr class="fn-sep"><div id="ignoreZoomSetting" class="function"><div><h3>ignoreZoomSetting(<wbr>ignore)<span class="codelink"><a href="source/ie.js.src.html#l153">code »</a></span></h3><p>Indicates whether to skip the check that the browser's zoom level is set to
100%.</p>
<div><div class="fn-details"><div><b>Parameters</b></div><dl><dt>ignore<code>?</code></dl></div><div class="fn-details"><div><b>Returns</b></div><dl><dt><code><a href="module_selenium-webdriver_ie_class_Options.html">Options</a></code><dd><p>ore Whether to ignore the browser's zoom level settings.</p>
</dl></div></div></div></div><hr class="fn-sep"><div id="initialBrowserUrl" class="function"><div><h3>initialBrowserUrl(<wbr>url)<span class="codelink"><a href="source/ie.js.src.html#l169">code »</a></span></h3><p>Sets the initial URL loaded when IE starts. This is intended to be used with
<a href="module_selenium-webdriver_ie_class_Options.html"><code>#ignoreProtectedModeSettings</code></a> to allow the user to initialize IE in
the proper Protected Mode zone. Setting this option may cause browser
instability or flaky and unresponsive code. Only "best effort" support is
provided when using this option.</p>
<div><div class="fn-details"><div><b>Parameters</b></div><dl><dt>url<code><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String">string</a></code><dd><p>The initial browser URL.</p>
</dl></div><div class="fn-details"><div><b>Returns</b></div><dl><dt><code><a href="module_selenium-webdriver_ie_class_Options.html">Options</a></code><dd><p>A self reference.</p>
</dl></div></div></div></div><hr class="fn-sep"><div id="introduceFlakinessByIgnoringProtectedModeSettings" class="function"><div><h3>introduceFlakinessByIgnoringProtectedModeSettings(<wbr>ignoreSettings)<span class="codelink"><a href="source/ie.js.src.html#l139">code »</a></span></h3><p>Whether to disable the protected mode settings check when the session is
created. Disbling this setting may lead to significant instability as the
browser may become unresponsive/hang. Only "best effort" support is provided
when using this capability.</p>
<p>For more information, refer to the IEDriver's
<a href="http://goo.gl/eH0Yi3">required system configuration</a>.</p>
<div><div class="fn-details"><div><b>Parameters</b></div><dl><dt>ignoreSettings<code><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Boolean">boolean</a></code><dd><p>Whether to ignore protected mode settings.</p>
</dl></div><div class="fn-details"><div><b>Returns</b></div><dl><dt><code><a href="module_selenium-webdriver_ie_class_Options.html">Options</a></code><dd><p>A self reference.</p>
</dl></div></div></div></div><hr class="fn-sep"><div id="requireWindowFocus" class="function"><div><h3>requireWindowFocus(<wbr>require)<span class="codelink"><a href="source/ie.js.src.html#l213">code »</a></span></h3><p>Configures whether to require the IE window to have input focus before
performing any user interactions (i.e. mouse or keyboard events). This
option is disabled by default, but delivers much more accurate interaction
events when enabled.</p>
<div><div class="fn-details"><div><b>Parameters</b></div><dl><dt>require<code><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Boolean">boolean</a></code><dd><p>Whether to require window focus.</p>
</dl></div><div class="fn-details"><div><b>Returns</b></div><dl><dt><code><a href="module_selenium-webdriver_ie_class_Options.html">Options</a></code><dd><p>A self reference.</p>
</dl></div></div></div></div><hr class="fn-sep"><div id="setExtractPath" class="function"><div><h3>setExtractPath(<wbr>path)<span class="codelink"><a href="source/ie.js.src.html#l330">code »</a></span></h3><p>Sets the path of the temporary data directory to use.</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 log file path.</p>
</dl></div><div class="fn-details"><div><b>Returns</b></div><dl><dt><code><a href="module_selenium-webdriver_ie_class_Options.html">Options</a></code><dd><p>A self reference.</p>
</dl></div></div></div></div><hr class="fn-sep"><div id="setHost" class="function"><div><h3>setHost(<wbr>host)<span class="codelink"><a href="source/ie.js.src.html#l319">code »</a></span></h3><p>Sets the IP address of the driver's host adapter.</p>
<div><div class="fn-details"><div><b>Parameters</b></div><dl><dt>host<code><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String">string</a></code><dd><p>The IP address to use.</p>
</dl></div><div class="fn-details"><div><b>Returns</b></div><dl><dt><code><a href="module_selenium-webdriver_ie_class_Options.html">Options</a></code><dd><p>A self reference.</p>
</dl></div></div></div></div><hr class="fn-sep"><div id="setLogFile" class="function"><div><h3>setLogFile(<wbr>path)<span class="codelink"><a href="source/ie.js.src.html#l297">code »</a></span></h3><p>Sets the path to the log file the driver should log to.</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 log file path.</p>
</dl></div><div class="fn-details"><div><b>Returns</b></div><dl><dt><code><a href="module_selenium-webdriver_ie_class_Options.html">Options</a></code><dd><p>A self reference.</p>
</dl></div></div></div></div><hr class="fn-sep"><div id="setLogLevel" class="function"><div><h3>setLogLevel(<wbr>level)<span class="codelink"><a href="source/ie.js.src.html#l308">code »</a></span></h3><p>Sets the IEDriverServer's logging <a href="module_selenium-webdriver_ie_enum_Level.html">level</a>.</p>
<div><div class="fn-details"><div><b>Parameters</b></div><dl><dt>level<code><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String">string</a></code><dd><p>The logging level.</p>
</dl></div><div class="fn-details"><div><b>Returns</b></div><dl><dt><code><a href="module_selenium-webdriver_ie_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/ie.js.src.html#l352">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_ie_class_Options.html">Options</a></code><dd><p>A self reference.</p>
</dl></div></div></div></div><hr class="fn-sep"><div id="silent" class="function"><div><h3>silent(<wbr>silent)<span class="codelink"><a href="source/ie.js.src.html#l341">code »</a></span></h3><p>Sets whether the driver should start in silent mode.</p>
<div><div class="fn-details"><div><b>Parameters</b></div><dl><dt>silent<code><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Boolean">boolean</a></code><dd><p>Whether to run in silent mode.</p>
</dl></div><div class="fn-details"><div><b>Returns</b></div><dl><dt><code><a href="module_selenium-webdriver_ie_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/ie.js.src.html#l364">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><hr class="fn-sep"><div id="usePerProcessProxy" class="function"><div><h3>usePerProcessProxy(<wbr>enable)<span class="codelink"><a href="source/ie.js.src.html#l271">code »</a></span></h3><p>Configures whether proxies should be configured on a per-process basis. If
not set, setting a <a href="module_selenium-webdriver_ie_class_Options.html#setProxy">proxy</a> will configure the system
proxy. The default behavior is to use the system proxy.</p>
<div><div class="fn-details"><div><b>Parameters</b></div><dl><dt>enable<code><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Boolean">boolean</a></code><dd><p>Whether to enable per-process proxy settings.</p>
</dl></div><div class="fn-details"><div><b>Returns</b></div><dl><dt><code><a href="module_selenium-webdriver_ie_class_Options.html">Options</a></code><dd><p>A self reference.</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/ie.js.src.html#l108">code »</a></span></h3><p>Extracts the IEDriver 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_ie_class_Options.html">Options</a></code><dd><p>The IEDriver 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>