| <!DOCTYPE html><meta charset="UTF-8"><meta http-equiv="Content-Language" content="en" /><title>selenium-webdriver/proxy</title><link href="dossier.css" rel="stylesheet" type="text/css"><div id="main-wrapper"><input type="checkbox" id="sidenav-toggle" /><main><header><h1>Module selenium-webdriver/proxy</h1><a class="source" href="/usr/local/google/home/jleyba/dev/selenium/build/javascript/node/selenium-webdriver/docs/source/proxy.js.src.html">code »</a></header><section><p>Defines functions for configuring a webdriver proxy: | |
| <pre><code> | |
| var webdriver = require('selenium-webdriver'), | |
| proxy = require('selenium-webdriver/proxy'); | |
| var driver = new webdriver.Builder() | |
| .withCapabilities(webdriver.Capabilities.chrome()) | |
| .setProxy(proxy.manual({http: 'host:1234'})) | |
| .build(); | |
| </code></pre></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="typedefs"><h2>Type Definitions</h2><div class="wrap-details public"><div><details><summary><div><a class="source" href="source/proxy.js.src.html#l45">code »</a><a class="member" name="ProxyConfig">ProxyConfig</a> : <code class="type">({proxyType: <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String">string</a>}|{proxyType: <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String">string</a>, proxyAutoconfigUrl: <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String">string</a>}|{proxyType: <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String">string</a>, ftpProxy: <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String">string</a>, httpProxy: <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String">string</a>, sslProxy: <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String">string</a>, noProxy: <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String">string</a>})</code></div><div>Proxy configuration object, as defined by the WebDriver wire protocol.</div></summary></details></div></div></section><section id="static-functions"><h2>Functions</h2><div class="wrap-details public"><div><details class="function"><summary><div><a class="source" href="source/proxy.js.src.html#l56">code »</a><span class="member"><a name="direct">direct</a> <span class="args">( )</span> ⇒ <code class="type">!ProxyConfig</code></span></div><p>Configures WebDriver to bypass all browser proxies.</summary><div class="info"><table><tbody><tr><th>Returns<tr><td><dl>A new proxy configuration object.</dl></table></div></details></div></div><div class="wrap-details public"><div><details class="function"><summary><div><a class="source" href="source/proxy.js.src.html#l83">code »</a><span class="member"><a name="manual">manual</a> <span class="args">( options )</span> ⇒ <code class="type">!ProxyConfig</code></span></div><p>Manually configures the browser proxy. The following options are | |
| supported: | |
| <ul> | |
| <li><code >ftp</code>: Proxy host to use for FTP requests | |
| <li><code >http</code>: Proxy host to use for HTTP requests | |
| <li><code >https</code>: Proxy host to use for HTTPS requests | |
| <li><code >bypass</code>: A list of hosts requests should directly connect to, | |
| bypassing any other proxies for that request. May be specified as a | |
| comma separated string, or a list of strings. | |
| </ul> | |
| Behavior is undefined for FTP, HTTP, and HTTPS requests if the | |
| corresponding key is omitted from the configuration options.</summary><div class="info"><table><tbody><tr><th>Parameters<tr><td><dl><dt>options: <code class="type">{ftp: (<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/Undefined">undefined</a>), http: (<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/Undefined">undefined</a>), https: (<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/Undefined">undefined</a>), bypass: (<a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String">string</a>|!<a href="http://developer.mozilla.org/en/Core_JavaScript_1.5_Reference/Global_Objects/Array">Array</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/Undefined">undefined</a>)}</code><dd>Proxy | |
| configuration options.</dl><tr><th>Returns<tr><td><dl>A new proxy configuration object.</dl></table></div></details></div></div><div class="wrap-details public"><div><details class="function"><summary><div><a class="source" href="source/proxy.js.src.html#l101">code »</a><span class="member"><a name="pac">pac</a> <span class="args">( url )</span> ⇒ <code class="type">!ProxyConfig</code></span></div><p>Configures WebDriver to configure the browser proxy using the PAC file at | |
| the given URL.</summary><div class="info"><table><tbody><tr><th>Parameters<tr><td><dl><dt>url: <code class="type"><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String">string</a></code><dd>URL for the PAC proxy to use.</dl><tr><th>Returns<tr><td><dl>A new proxy configuration object.</dl></table></div></details></div></div><div class="wrap-details public"><div><details class="function"><summary><div><a class="source" href="source/proxy.js.src.html#l113">code »</a><span class="member"><a name="system">system</a> <span class="args">( )</span> ⇒ <code class="type">!ProxyConfig</code></span></div><p>Configures WebDriver to use the current system's proxy.</summary><div class="info"><table><tbody><tr><th>Returns<tr><td><dl>A new proxy configuration object.</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>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> |