selenium-webdriver
Version:
The official WebDriver JavaScript bindings from the Selenium project
12 lines • 4.15 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>Request</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>Namespace:</b> <a href="namespace_webdriver_http.html">webdriver.http</a></div><div class="codelink"><a href="source/lib/webdriver/http/http.js.src.html#l404">View Source</a></div><h1>class Request</h1><p>Describes a partial HTTP request. This class is a "partial" request and only
defines the path on the server to send a request to. It is each
<a href="interface_webdriver_http_Client.html"><code>webdriver.http.Client</code></a>'s responsibility to build the full URL for the
final request.</p>
<h3>new Request(<wbr>method, path, opt_data)</h3><div><div class="fn-details"><div><b>Parameters</b></div><dl><dt>method<code><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String">string</a></code><dd><p>The HTTP method to use for the request.</p>
<dt>path<code><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String">string</a></code><dd><p>Path on the server to send the request to.</p>
<dt>opt_data<code>?<a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object">Object</a>=</code><dd><p>This request's JSON data.</p>
</dl></div></div><h2>Instance Methods</h2><div id="toString" class="function"><div><h3>toString()<span class="codelink"><a href="source/lib/webdriver/http/http.js.src.html#l433">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></dl></div></div></div></div><h2>Instance Properties</h2><div id="data" class="property"><dl><dt><a href="source/lib/webdriver/http/http.js.src.html#l422">data</a><code><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object">Object</a></code><dd><p>This request's body.</p>
</dl></div><div id="headers" class="property"><dl><dt><a href="source/lib/webdriver/http/http.js.src.html#l428">headers</a><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>|<a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number">number</a>)></code><dd><p>The headers to send with the request.</p>
</dl></div><div id="method" class="property"><dl><dt><a href="source/lib/webdriver/http/http.js.src.html#l410">method</a><code><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String">string</a></code><dd><p>The HTTP method to use for the request.</p>
</dl></div><div id="path" class="property"><dl><dt><a href="source/lib/webdriver/http/http.js.src.html#l416">path</a><code><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String">string</a></code><dd><p>The path on the server to send the request to.</p>
</dl></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>