selenium-webdriver

Version:

The official WebDriver JavaScript bindings from the Selenium project

23 lines • 5.53 kB

HTML

<!DOCTYPE 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_safari.html">selenium-webdriver/safari</a></div><div class="codelink"><a href="source/safari.js.src.html#l538">View Source</a></div><h1>class Options</h1><pre class="inheritance"><a href="class_webdriver_Serializable.html">webdriver.Serializable</a> └ Options</pre><p>Configuration options specific to the <a href="module_selenium-webdriver_safari_class_Driver.html"><code>SafariDriver</code></a>.</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="serialize" class="function"><div><h3>serialize()<span class="codelink"><a href="source/safari.js.src.html#l499">code »</a></span></h3><p>Converts this instance to its JSON wire protocol representation. Note this function is an implementation detail 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><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/String">string</a>, *></code><dd><p>The JSON wire protocol representation of this instance.</p> </dl></div></div></div></div><hr class="fn-sep"><div id="setCleanSession" class="function"><div><h3>setCleanSession(<wbr>clean)<span class="codelink"><a href="source/safari.js.src.html#l454">code »</a></span></h3><p>Sets whether to force Safari to start with a clean session. Enabling this option will cause all global browser data to be deleted.</p> <div><div class="fn-details"><div><b>Parameters</b></div><dl><dt>clean<code><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Boolean">boolean</a></code><dd><p>Whether to make sure the session has no cookies, cache entries, local storage, or databases.</p> </dl></div><div class="fn-details"><div><b>Returns</b></div><dl><dt><code><a href="module_selenium-webdriver_safari_class_Options.html">Options</a></code><dd><p>A self reference.</p> </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/safari.js.src.html#l468">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_safari_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/safari.js.src.html#l480">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/safari.js.src.html#l428">code »</a></span></h3><p>Extracts the SafariDriver 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_safari_class_Options.html">Options</a></code><dd><p>The ChromeDriver 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>