selenium-webdriver
Version:
The official WebDriver JavaScript bindings from the Selenium project
15 lines • 17.5 kB
HTML
<meta charset="UTF-8"><meta http-equiv="Content-Language" content="en" /><title>webdriver.Capabilities</title><link href="dossier.css" rel="stylesheet" type="text/css"><div id="main-wrapper"><input type="checkbox" id="sidenav-toggle" /><main><header><h1>Class webdriver.Capabilities</h1><a class="source" href="source/lib/webdriver/capabilities.js.src.html#l165">code »</a></header><section><h2>Constructor</h2><div class="ctor wrap-details public"><div><div class="ctor"><span class="member">webdriver.Capabilities <span class="args">( opt_other )</span></span></div><div class="info"><table><tbody><tr><th>Parameters<tr><td><dl><dt>opt_other: <code class="type">(<a href="class_webdriver_Capabilities.html">webdriver.Capabilities</a>|<a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object">Object</a>)=</code><dd>Another set of
capabilities to merge into this instance.</dl></table></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/lib/webdriver/capabilities.js.src.html#l330">code »</a><span class="member"><a name="get">get</a> <span class="args">( key )</span> ⇒ <code class="type">*</code></span></div></summary><div class="info"><table><tbody><tr><th>Parameters<tr><td><dl><dt>key: <code class="type"><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String">string</a></code><dd>The capability to return.</dl><tr><th>Returns<tr><td><dl>The capability with the given key, or <code >null</code> if it has
not been set.</dl></table></div></details></div></div><div class="wrap-details public"><div><details class="function"><summary><div><a class="source" href="source/lib/webdriver/capabilities.js.src.html#l343">code »</a><span class="member"><a name="has">has</a> <span class="args">( key )</span> ⇒ <code class="type"><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Boolean">boolean</a></code></span></div></summary><div class="info"><table><tbody><tr><th>Parameters<tr><td><dl><dt>key: <code class="type"><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String">string</a></code><dd>The capability to check.</dl><tr><th>Returns<tr><td><dl>Whether the specified capability is set.</dl></table></div></details></div></div><div class="wrap-details public"><div><details class="function"><summary><div><a class="source" href="source/lib/webdriver/capabilities.js.src.html#l297">code »</a><span class="member"><a name="merge">merge</a> <span class="args">( other )</span> ⇒ <code class="type">!<a href="class_webdriver_Capabilities.html">webdriver.Capabilities</a></code></span></div><p>Merges another set of capabilities into this instance. Any duplicates in
the provided set will override those already set on this instance.</summary><div class="info"><table><tbody><tr><th>Parameters<tr><td><dl><dt>other: <code class="type">!(<a href="class_webdriver_Capabilities.html">webdriver.Capabilities</a>|<a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object">Object</a>)</code><dd>The capabilities to
merge into this instance.</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/lib/webdriver/capabilities.js.src.html#l315">code »</a><span class="member"><a name="set">set</a> <span class="args">( key, value )</span> ⇒ <code class="type">!<a href="class_webdriver_Capabilities.html">webdriver.Capabilities</a></code></span></div></summary><div class="info"><table><tbody><tr><th>Parameters<tr><td><dl><dt>key: <code class="type"><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String">string</a></code><dd>The capability to set.<dt>value: <code class="type">*</code><dd>The capability value. Capability values must be JSON
serializable. Pass <code >null</code> to unset the capability.</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/lib/webdriver/capabilities.js.src.html#l399">code »</a><span class="member"><a name="setAlertBehavior">setAlertBehavior</a> <span class="args">( behavior )</span> ⇒ <code class="type">!<a href="class_webdriver_Capabilities.html">webdriver.Capabilities</a></code></span></div><p>Sets the default action to take with an unexpected alert before returning
an error.</summary><div class="info"><table><tbody><tr><th>Parameters<tr><td><dl><dt>behavior: <code class="type"><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String">string</a></code><dd>The desired behavior; should be "accept", "dismiss",
or "ignore". Defaults to "dismiss".</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/lib/webdriver/capabilities.js.src.html#l376">code »</a><span class="member"><a name="setEnableNativeEvents">setEnableNativeEvents</a> <span class="args">( enabled )</span> ⇒ <code class="type">!<a href="class_webdriver_Capabilities.html">webdriver.Capabilities</a></code></span></div><p>Sets whether native events should be used.</summary><div class="info"><table><tbody><tr><th>Parameters<tr><td><dl><dt>enabled: <code class="type"><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Boolean">boolean</a></code><dd>Whether to enable native events.</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/lib/webdriver/capabilities.js.src.html#l356">code »</a><span class="member"><a name="setLoggingPrefs">setLoggingPrefs</a> <span class="args">( prefs )</span> ⇒ <code class="type">!<a href="class_webdriver_Capabilities.html">webdriver.Capabilities</a></code></span></div><p>Sets the logging preferences. Preferences may be specified as a
<code class="type"><a href="class_webdriver_logging_Preferences.html">webdriver.logging.Preferences</a></code> instance, or a as a map of log-type to
log-level.</summary><div class="info"><table><tbody><tr><th>Parameters<tr><td><dl><dt>prefs: <code class="type">!(<a href="class_webdriver_logging_Preferences.html">webdriver.logging.Preferences</a>|<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>, <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String">string</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/lib/webdriver/capabilities.js.src.html#l366">code »</a><span class="member"><a name="setProxy">setProxy</a> <span class="args">( proxy )</span> ⇒ <code class="type">!<a href="class_webdriver_Capabilities.html">webdriver.Capabilities</a></code></span></div><p>Sets the proxy configuration for this instance.</summary><div class="info"><table><tbody><tr><th>Parameters<tr><td><dl><dt>proxy: <code class="type"><a href="namespace_webdriver.html#webdriver.ProxyConfig">webdriver.ProxyConfig</a></code><dd>The desired proxy configuration.</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/lib/webdriver/capabilities.js.src.html#l387">code »</a><span class="member"><a name="setScrollBehavior">setScrollBehavior</a> <span class="args">( behavior )</span> ⇒ <code class="type">!<a href="class_webdriver_Capabilities.html">webdriver.Capabilities</a></code></span></div><p>Sets how elements should be scrolled into view for interaction.</summary><div class="info"><table><tbody><tr><th>Parameters<tr><td><dl><dt>behavior: <code class="type"><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number">number</a></code><dd>The desired scroll behavior: either 0 to align with
the top of the viewport or 1 to align with the bottom.</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/lib/webdriver/capabilities.js.src.html#l285">code »</a><span class="member"><a name="toJSON">toJSON</a> <span class="args">( )</span> ⇒ <code class="type">!<a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object">Object</a></code></span></div></summary><div class="info"><table><tbody><tr><th>Returns<tr><td><dl>The JSON 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/lib/webdriver/capabilities.js.src.html#l168">code »</a><span class="member"><a name="caps_">caps_</a> : <code class="type">!<a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object">Object</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/lib/webdriver/capabilities.js.src.html#l179">code »</a><span class="member"><a name="webdriver.Capabilities.android">webdriver.Capabilities.android</a> <span class="args">( )</span> ⇒ <code class="type">!<a href="class_webdriver_Capabilities.html">webdriver.Capabilities</a></code></span></div></summary><div class="info"><table><tbody><tr><th>Returns<tr><td><dl>A basic set of capabilities for Android.</dl></table></div></details></div></div><div class="wrap-details public"><div><details class="function"><summary><div><a class="source" href="source/lib/webdriver/capabilities.js.src.html#l189">code »</a><span class="member"><a name="webdriver.Capabilities.chrome">webdriver.Capabilities.chrome</a> <span class="args">( )</span> ⇒ <code class="type">!<a href="class_webdriver_Capabilities.html">webdriver.Capabilities</a></code></span></div></summary><div class="info"><table><tbody><tr><th>Returns<tr><td><dl>A basic set of capabilities for Chrome.</dl></table></div></details></div></div><div class="wrap-details public"><div><details class="function"><summary><div><a class="source" href="source/lib/webdriver/capabilities.js.src.html#l198">code »</a><span class="member"><a name="webdriver.Capabilities.firefox">webdriver.Capabilities.firefox</a> <span class="args">( )</span> ⇒ <code class="type">!<a href="class_webdriver_Capabilities.html">webdriver.Capabilities</a></code></span></div></summary><div class="info"><table><tbody><tr><th>Returns<tr><td><dl>A basic set of capabilities for Firefox.</dl></table></div></details></div></div><div class="wrap-details public"><div><details class="function"><summary><div><a class="source" href="source/lib/webdriver/capabilities.js.src.html#l267">code »</a><span class="member"><a name="webdriver.Capabilities.htmlunit">webdriver.Capabilities.htmlunit</a> <span class="args">( )</span> ⇒ <code class="type">!<a href="class_webdriver_Capabilities.html">webdriver.Capabilities</a></code></span></div></summary><div class="info"><table><tbody><tr><th>Returns<tr><td><dl>A basic set of capabilities for HTMLUnit.</dl></table></div></details></div></div><div class="wrap-details public"><div><details class="function"><summary><div><a class="source" href="source/lib/webdriver/capabilities.js.src.html#l277">code »</a><span class="member"><a name="webdriver.Capabilities.htmlunitwithjs">webdriver.Capabilities.htmlunitwithjs</a> <span class="args">( )</span> ⇒ <code class="type">!<a href="class_webdriver_Capabilities.html">webdriver.Capabilities</a></code></span></div></summary><div class="info"><table><tbody><tr><th>Returns<tr><td><dl>A basic set of capabilities for HTMLUnit
with enabled Javascript.</dl></table></div></details></div></div><div class="wrap-details public"><div><details class="function"><summary><div><a class="source" href="source/lib/webdriver/capabilities.js.src.html#l208">code »</a><span class="member"><a name="webdriver.Capabilities.ie">webdriver.Capabilities.ie</a> <span class="args">( )</span> ⇒ <code class="type">!<a href="class_webdriver_Capabilities.html">webdriver.Capabilities</a></code></span></div></summary><div class="info"><table><tbody><tr><th>Returns<tr><td><dl>A basic set of capabilities for
Internet Explorer.</dl></table></div></details></div></div><div class="wrap-details public"><div><details class="function"><summary><div><a class="source" href="source/lib/webdriver/capabilities.js.src.html#l219">code »</a><span class="member"><a name="webdriver.Capabilities.ipad">webdriver.Capabilities.ipad</a> <span class="args">( )</span> ⇒ <code class="type">!<a href="class_webdriver_Capabilities.html">webdriver.Capabilities</a></code></span></div></summary><div class="info"><table><tbody><tr><th>Returns<tr><td><dl>A basic set of capabilities for iPad.</dl></table></div></details></div></div><div class="wrap-details public"><div><details class="function"><summary><div><a class="source" href="source/lib/webdriver/capabilities.js.src.html#l229">code »</a><span class="member"><a name="webdriver.Capabilities.iphone">webdriver.Capabilities.iphone</a> <span class="args">( )</span> ⇒ <code class="type">!<a href="class_webdriver_Capabilities.html">webdriver.Capabilities</a></code></span></div></summary><div class="info"><table><tbody><tr><th>Returns<tr><td><dl>A basic set of capabilities for iPhone.</dl></table></div></details></div></div><div class="wrap-details public"><div><details class="function"><summary><div><a class="source" href="source/lib/webdriver/capabilities.js.src.html#l239">code »</a><span class="member"><a name="webdriver.Capabilities.opera">webdriver.Capabilities.opera</a> <span class="args">( )</span> ⇒ <code class="type">!<a href="class_webdriver_Capabilities.html">webdriver.Capabilities</a></code></span></div></summary><div class="info"><table><tbody><tr><th>Returns<tr><td><dl>A basic set of capabilities for Opera.</dl></table></div></details></div></div><div class="wrap-details public"><div><details class="function"><summary><div><a class="source" href="source/lib/webdriver/capabilities.js.src.html#l249">code »</a><span class="member"><a name="webdriver.Capabilities.phantomjs">webdriver.Capabilities.phantomjs</a> <span class="args">( )</span> ⇒ <code class="type">!<a href="class_webdriver_Capabilities.html">webdriver.Capabilities</a></code></span></div></summary><div class="info"><table><tbody><tr><th>Returns<tr><td><dl>A basic set of capabilities for
PhantomJS.</dl></table></div></details></div></div><div class="wrap-details public"><div><details class="function"><summary><div><a class="source" href="source/lib/webdriver/capabilities.js.src.html#l258">code »</a><span class="member"><a name="webdriver.Capabilities.safari">webdriver.Capabilities.safari</a> <span class="args">( )</span> ⇒ <code class="type">!<a href="class_webdriver_Capabilities.html">webdriver.Capabilities</a></code></span></div></summary><div class="info"><table><tbody><tr><th>Returns<tr><td><dl>A basic set of capabilities for Safari.</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>Loading</i></div><div id="sidenav-modules"><label for="sidenav-modules-ctrl"><h4>Modules</h4></label><i>Loading</i></div><div id="sidenav-files"><label for="sidenav-files-ctrl"><h4>Files</h4></label><i>Loading</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>