selenium-webdriver

Version:

The official WebDriver JavaScript bindings from the Selenium project

15 lines • 4.7 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>Command</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.html">selenium-webdriver</a></div><div class="codelink"><a href="source/index.js.src.html#l50">View Source</a></div><h1>class Command</h1><dl><dt>Alias for <code><a href="class_webdriver_Command.html">webdriver.Command</a></code></dl><p>Describes a command to be executed by the WebDriverJS framework.</p> <h3>new Command(<wbr>name)</h3><div><div class="fn-details"><div><b>Parameters</b></div><dl><dt>name<code><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String">string</a></code><dd><p>The name of this command.</p> </dl></div></div><h2>Instance Methods</h2><div id="getName" class="function"><div><h3>getName()<span class="codelink"><a href="source/lib/webdriver/command.js.src.html#l52">code »</a></span></h3><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/String">string</a></code><dd><p>This command's name.</p> </dl></div></div></div></div><hr class="fn-sep"><div id="getParameter" class="function"><div><h3>getParameter(<wbr>key)<span class="codelink"><a href="source/lib/webdriver/command.js.src.html#l85">code »</a></span></h3><p>Returns a named command parameter.</p> <div><div class="fn-details"><div><b>Parameters</b></div><dl><dt>key<code><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String">string</a></code><dd><p>The parameter key to look up.</p> </dl></div><div class="fn-details"><div><b>Returns</b></div><p>The parameter value, or undefined if it has not been set.</p> </div></div></div></div><hr class="fn-sep"><div id="getParameters" class="function"><div><h3>getParameters()<span class="codelink"><a href="source/lib/webdriver/command.js.src.html#l93">code »</a></span></h3><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><?, *></code><dd><p>The parameters to send with this command.</p> </dl></div></div></div></div><hr class="fn-sep"><div id="setParameter" class="function"><div><h3>setParameter(<wbr>name, value)<span class="codelink"><a href="source/lib/webdriver/command.js.src.html#l63">code »</a></span></h3><p>Sets a parameter to send with this command.</p> <div><div class="fn-details"><div><b>Parameters</b></div><dl><dt>name<code><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String">string</a></code><dd><p>The parameter name.</p> <dt>value<code>*</code><dd><p>The parameter value.</p> </dl></div><div class="fn-details"><div><b>Returns</b></div><dl><dt><code><a href="class_webdriver_Command.html">webdriver.Command</a></code><dd><p>A self reference.</p> </dl></div></div></div></div><hr class="fn-sep"><div id="setParameters" class="function"><div><h3>setParameters(<wbr>parameters)<span class="codelink"><a href="source/lib/webdriver/command.js.src.html#l74">code »</a></span></h3><p>Sets the parameters for this command.</p> <div><div class="fn-details"><div><b>Parameters</b></div><dl><dt>parameters<code><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object">Object</a><?, *></code><dd><p>The command parameters.</p> </dl></div><div class="fn-details"><div><b>Returns</b></div><dl><dt><code><a href="class_webdriver_Command.html">webdriver.Command</a></code><dd><p>A self reference.</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>