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.
1 line
5.9 KiB
1 line
5.9 KiB
<!DOCTYPE html><meta charset="UTF-8"><meta http-equiv="Content-Language" content="en" /><title>webdriver.Command</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.Command</h1><a class="source" href="source/lib/webdriver/command.js.src.html#l30">code »</a></header><section><p>Describes a command to be executed by the WebDriverJS framework.<h2>Constructor</h2><div class="ctor wrap-details public"><div><div class="ctor"><span class="member">webdriver.Command <span class="args">( name )</span></span></div><div class="info"><table><tbody><tr><th>Parameters<tr><td><dl><dt>name: <code class="type">!<a href="enum_webdriver_CommandName.html">webdriver.CommandName</a></code><dd>The name of this command.</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/command.js.src.html#l49">code »</a><span class="member"><a name="getName">getName</a> <span class="args">( )</span> ⇒ <code class="type">!<a href="enum_webdriver_CommandName.html">webdriver.CommandName</a></code></span></div></summary><div class="info"><table><tbody><tr><th>Returns<tr><td><dl>This command's name.</dl></table></div></details></div></div><div class="wrap-details public"><div><details class="function"><summary><div><a class="source" href="source/lib/webdriver/command.js.src.html#l82">code »</a><span class="member"><a name="getParameter">getParameter</a> <span class="args">( key )</span> ⇒ <code class="type">*</code></span></div><p>Returns a named command parameter.</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 parameter key to look up.</dl><tr><th>Returns<tr><td><dl>The parameter value, or undefined 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/command.js.src.html#l90">code »</a><span class="member"><a name="getParameters">getParameters</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 parameters to send with this command.</dl></table></div></details></div></div><div class="wrap-details public"><div><details class="function"><summary><div><a class="source" href="source/lib/webdriver/command.js.src.html#l60">code »</a><span class="member"><a name="setParameter">setParameter</a> <span class="args">( name, value )</span> ⇒ <code class="type">!<a href="class_webdriver_Command.html">webdriver.Command</a></code></span></div><p>Sets a parameter to send with this command.</summary><div class="info"><table><tbody><tr><th>Parameters<tr><td><dl><dt>name: <code class="type"><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String">string</a></code><dd>The parameter name.<dt>value: <code class="type">*</code><dd>The parameter value.</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/command.js.src.html#l71">code »</a><span class="member"><a name="setParameters">setParameters</a> <span class="args">( parameters )</span> ⇒ <code class="type">!<a href="class_webdriver_Command.html">webdriver.Command</a></code></span></div><p>Sets the parameters for this command.</summary><div class="info"><table><tbody><tr><th>Parameters<tr><td><dl><dt>parameters: <code class="type">!<a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object">Object</a></code><dd>The command parameters.</dl><tr><th>Returns<tr><td><dl>A self reference.</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/command.js.src.html#l42">code »</a><span class="member"><a name="parameters_">parameters_</a> : <code class="type">!<a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object">Object</a></code></span></div><p>The parameters to this command.</summary></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> |