UNPKG

selenium-webdriver

Version:

The official WebDriver JavaScript bindings from the Selenium project

8 lines 6.28 kB
<!DOCTYPE html><meta charset="UTF-8"><meta http-equiv="Content-Language" content="en" /><title>webdriver.http.Executor</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.http.Executor</h1><a class="source" href="source/lib/webdriver/http/http.js.src.html#l65">code &raquo;</a><dl><dt>All implemented interfaces:<dd><code><a href="interface_webdriver_CommandExecutor.html">webdriver.CommandExecutor</a></code></dl></header><section><p>A command executor that communicates with a server using the WebDriver command protocol.<h2>Constructor</h2><div class="ctor wrap-details public"><div><div class="ctor"><span class="member">webdriver.http.Executor <span class="args">( client )</span></span></div><div class="info"><table><tbody><tr><th>Parameters<tr><td><dl><dt>client: <code class="type">!<a href="interface_webdriver_http_Client.html">webdriver.http.Client</a></code><dd>The client to use when sending requests to the server.</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/http/http.js.src.html#l76">code &raquo;</a><span class="member"><a name="execute">execute</a> <span class="args">( command, callback )</span></span></div></summary><div class="info"><table><tbody><tr><th>Parameters<tr><td><dl><dt>command<dt>callback</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/http/http.js.src.html#l71">code &raquo;</a><span class="member"><a name="client_">client_</a> : <code class="type">!<a href="interface_webdriver_http_Client.html">webdriver.http.Client</a></code></span></div><p>Client used to communicate with the server.</summary></details></div></div></section><section id="static-functions"><h2>Static Functions</h2><div class="wrap-details private"><div><details class="function"><summary><div><a class="source" href="source/lib/webdriver/http/http.js.src.html#l112">code &raquo;</a><span class="member"><a name="webdriver.http.Executor.buildPath_">webdriver.http.Executor.buildPath_</a> <span class="args">( path, parameters )</span> &rArr; <code class="type"><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String">string</a></code></span></div><p>Builds a fully qualified path using the given set of command parameters. Each path segment prefixed with ':' will be replaced by the value of the corresponding parameter. All parameters spliced into the path will be removed from the parameter map.</summary><div class="info"><table><tbody><tr><th>Parameters<tr><td><dl><dt>path: <code class="type"><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String">string</a></code><dd>The original resource path.<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 parameters object to splice into the path.</dl><tr><th>Returns<tr><td><dl>The modified path.</dl></table></div></details></div></div><div class="wrap-details private"><div><details class="function"><summary><div><a class="source" href="source/lib/webdriver/http/http.js.src.html#l145">code &raquo;</a><span class="member"><a name="webdriver.http.Executor.parseHttpResponse_">webdriver.http.Executor.parseHttpResponse_</a> <span class="args">( httpResponse )</span> &rArr; <code class="type">!<a href="namespace_bot_response.html#bot.response.ResponseObject">bot.response.ResponseObject</a></code></span></div><p>Callback used to parse <code class="type"><a href="class_webdriver_http_Response.html">webdriver.http.Response</a></code> objects from a <code class="type"><a href="interface_webdriver_http_Client.html">webdriver.http.Client</a></code>.</summary><div class="info"><table><tbody><tr><th>Parameters<tr><td><dl><dt>httpResponse: <code class="type">!<a href="class_webdriver_http_Response.html">webdriver.http.Response</a></code><dd>The HTTP response to parse.</dl><tr><th>Returns<tr><td><dl>The parsed response.</dl></table></div></details></div></div></section><section id="static-properties"><h2>Static Properties</h2><div class="wrap-details private"><div><details><summary><div><a class="source" href="source/lib/webdriver/http/http.js.src.html#l176">code &raquo;</a><span class="member"><a name="webdriver.http.Executor.COMMAND_MAP_">webdriver.http.Executor.COMMAND_MAP_</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>Maps command names to resource locator.</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>