selenium-webdriver

Version:

The official WebDriver JavaScript bindings from the Selenium project

1 lines • 42.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>builder.js</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 class="srcfile"><h1>builder.js</h1><div><table><tr><td><a id="l1"></a><a href="#l1">1</a><td>// Licensed to the Software Freedom Conservancy (SFC) under one<tr><td><a id="l2"></a><a href="#l2">2</a><td>// or more contributor license agreements. See the NOTICE file<tr><td><a id="l3"></a><a href="#l3">3</a><td>// distributed with this work for additional information<tr><td><a id="l4"></a><a href="#l4">4</a><td>// regarding copyright ownership. The SFC licenses this file<tr><td><a id="l5"></a><a href="#l5">5</a><td>// to you under the Apache License, Version 2.0 (the<tr><td><a id="l6"></a><a href="#l6">6</a><td>// "License"); you may not use this file except in compliance<tr><td><a id="l7"></a><a href="#l7">7</a><td>// with the License. You may obtain a copy of the License at<tr><td><a id="l8"></a><a href="#l8">8</a><td>//<tr><td><a id="l9"></a><a href="#l9">9</a><td>// http://www.apache.org/licenses/LICENSE-2.0<tr><td><a id="l10"></a><a href="#l10">10</a><td>//<tr><td><a id="l11"></a><a href="#l11">11</a><td>// Unless required by applicable law or agreed to in writing,<tr><td><a id="l12"></a><a href="#l12">12</a><td>// software distributed under the License is distributed on an<tr><td><a id="l13"></a><a href="#l13">13</a><td>// "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY<tr><td><a id="l14"></a><a href="#l14">14</a><td>// KIND, either express or implied. See the License for the<tr><td><a id="l15"></a><a href="#l15">15</a><td>// specific language governing permissions and limitations<tr><td><a id="l16"></a><a href="#l16">16</a><td>// under the License.<tr><td><a id="l17"></a><a href="#l17">17</a><td><tr><td><a id="l18"></a><a href="#l18">18</a><td>var base = require('./_base'),<tr><td><a id="l19"></a><a href="#l19">19</a><td> executors = require('./executors');<tr><td><a id="l20"></a><a href="#l20">20</a><td><tr><td><a id="l21"></a><a href="#l21">21</a><td>// Use base.require to avoid circular references between index and this module.<tr><td><a id="l22"></a><a href="#l22">22</a><td>var Browser = base.require('webdriver.Browser'),<tr><td><a id="l23"></a><a href="#l23">23</a><td> Capabilities = base.require('webdriver.Capabilities'),<tr><td><a id="l24"></a><a href="#l24">24</a><td> Capability = base.require('webdriver.Capability'),<tr><td><a id="l25"></a><a href="#l25">25</a><td> WebDriver = base.require('webdriver.WebDriver'),<tr><td><a id="l26"></a><a href="#l26">26</a><td> promise = base.require('webdriver.promise');<tr><td><a id="l27"></a><a href="#l27">27</a><td><tr><td><a id="l28"></a><a href="#l28">28</a><td><tr><td><a id="l29"></a><a href="#l29">29</a><td><tr><td><a id="l30"></a><a href="#l30">30</a><td>var seleniumServer;<tr><td><a id="l31"></a><a href="#l31">31</a><td><tr><td><a id="l32"></a><a href="#l32">32</a><td>/**<tr><td><a id="l33"></a><a href="#l33">33</a><td> * Starts an instance of the Selenium server if not yet running.<tr><td><a id="l34"></a><a href="#l34">34</a><td> * @param {string} jar Path to the server jar to use.<tr><td><a id="l35"></a><a href="#l35">35</a><td> * @return {!webdriver.promise.Promise<string>} A promise for the server's<tr><td><a id="l36"></a><a href="#l36">36</a><td> * addrss once started.<tr><td><a id="l37"></a><a href="#l37">37</a><td> */<tr><td><a id="l38"></a><a href="#l38">38</a><td>function startSeleniumServer(jar) {<tr><td><a id="l39"></a><a href="#l39">39</a><td> if (!seleniumServer) {<tr><td><a id="l40"></a><a href="#l40">40</a><td> // Requiring 'chrome' above would create a cycle:<tr><td><a id="l41"></a><a href="#l41">41</a><td> // index -> builder -> chrome -> index<tr><td><a id="l42"></a><a href="#l42">42</a><td> var remote = require('./remote');<tr><td><a id="l43"></a><a href="#l43">43</a><td> seleniumServer = new remote.SeleniumServer(jar);<tr><td><a id="l44"></a><a href="#l44">44</a><td> }<tr><td><a id="l45"></a><a href="#l45">45</a><td> return seleniumServer.start();<tr><td><a id="l46"></a><a href="#l46">46</a><td>}<tr><td><a id="l47"></a><a href="#l47">47</a><td><tr><td><a id="l48"></a><a href="#l48">48</a><td><tr><td><a id="l49"></a><a href="#l49">49</a><td>/**<tr><td><a id="l50"></a><a href="#l50">50</a><td> * Creates new {@link webdriver.WebDriver WebDriver} instances. The environment<tr><td><a id="l51"></a><a href="#l51">51</a><td> * variables listed below may be used to override a builder's configuration,<tr><td><a id="l52"></a><a href="#l52">52</a><td> * allowing quick runtime changes.<tr><td><a id="l53"></a><a href="#l53">53</a><td> *<tr><td><a id="l54"></a><a href="#l54">54</a><td> * - {@code SELENIUM_BROWSER}: defines the target browser in the form<tr><td><a id="l55"></a><a href="#l55">55</a><td> * {@code browser[:version][:platform]}.<tr><td><a id="l56"></a><a href="#l56">56</a><td> *<tr><td><a id="l57"></a><a href="#l57">57</a><td> * - {@code SELENIUM_REMOTE_URL}: defines the remote URL for all builder<tr><td><a id="l58"></a><a href="#l58">58</a><td> * instances. This environment variable should be set to a fully qualified<tr><td><a id="l59"></a><a href="#l59">59</a><td> * URL for a WebDriver server (e.g. http://localhost:4444/wd/hub). This<tr><td><a id="l60"></a><a href="#l60">60</a><td> * option always takes precedence over {@code SELENIUM_SERVER_JAR}.<tr><td><a id="l61"></a><a href="#l61">61</a><td> *<tr><td><a id="l62"></a><a href="#l62">62</a><td> * - {@code SELENIUM_SERVER_JAR}: defines the path to the<tr><td><a id="l63"></a><a href="#l63">63</a><td> * <a href="http://selenium-release.storage.googleapis.com/index.html"><tr><td><a id="l64"></a><a href="#l64">64</a><td> * standalone Selenium server</a> jar to use. The server will be started the<tr><td><a id="l65"></a><a href="#l65">65</a><td> * first time a WebDriver instance and be killed when the process exits.<tr><td><a id="l66"></a><a href="#l66">66</a><td> *<tr><td><a id="l67"></a><a href="#l67">67</a><td> * Suppose you had mytest.js that created WebDriver with<tr><td><a id="l68"></a><a href="#l68">68</a><td> *<tr><td><a id="l69"></a><a href="#l69">69</a><td> * var driver = new webdriver.Builder()<tr><td><a id="l70"></a><a href="#l70">70</a><td> * .forBrowser('chrome')<tr><td><a id="l71"></a><a href="#l71">71</a><td> * .build();<tr><td><a id="l72"></a><a href="#l72">72</a><td> *<tr><td><a id="l73"></a><a href="#l73">73</a><td> * This test could be made to use Firefox on the local machine by running with<tr><td><a id="l74"></a><a href="#l74">74</a><td> * `SELENIUM_BROWSER=firefox node mytest.js`. Rather than change the code to<tr><td><a id="l75"></a><a href="#l75">75</a><td> * target Google Chrome on a remote machine, you can simply set the<tr><td><a id="l76"></a><a href="#l76">76</a><td> * `SELENIUM_BROWSER` and `SELENIUM_REMOTE_URL` environment variables:<tr><td><a id="l77"></a><a href="#l77">77</a><td> *<tr><td><a id="l78"></a><a href="#l78">78</a><td> * SELENIUM_BROWSER=chrome:36:LINUX \<tr><td><a id="l79"></a><a href="#l79">79</a><td> * SELENIUM_REMOTE_URL=http://www.example.com:4444/wd/hub \<tr><td><a id="l80"></a><a href="#l80">80</a><td> * node mytest.js<tr><td><a id="l81"></a><a href="#l81">81</a><td> *<tr><td><a id="l82"></a><a href="#l82">82</a><td> * You could also use a local copy of the standalone Selenium server:<tr><td><a id="l83"></a><a href="#l83">83</a><td> *<tr><td><a id="l84"></a><a href="#l84">84</a><td> * SELENIUM_BROWSER=chrome:36:LINUX \<tr><td><a id="l85"></a><a href="#l85">85</a><td> * SELENIUM_SERVER_JAR=/path/to/selenium-server-standalone.jar \<tr><td><a id="l86"></a><a href="#l86">86</a><td> * node mytest.js<tr><td><a id="l87"></a><a href="#l87">87</a><td> *<tr><td><a id="l88"></a><a href="#l88">88</a><td> * @constructor<tr><td><a id="l89"></a><a href="#l89">89</a><td> */<tr><td><a id="l90"></a><a href="#l90">90</a><td>var Builder = function() {<tr><td><a id="l91"></a><a href="#l91">91</a><td><tr><td><a id="l92"></a><a href="#l92">92</a><td> /** @private {webdriver.promise.ControlFlow} */<tr><td><a id="l93"></a><a href="#l93">93</a><td> this.flow_ = null;<tr><td><a id="l94"></a><a href="#l94">94</a><td><tr><td><a id="l95"></a><a href="#l95">95</a><td> /** @private {string} */<tr><td><a id="l96"></a><a href="#l96">96</a><td> this.url_ = '';<tr><td><a id="l97"></a><a href="#l97">97</a><td><tr><td><a id="l98"></a><a href="#l98">98</a><td> /** @private {?string} */<tr><td><a id="l99"></a><a href="#l99">99</a><td> this.proxy_ = null;<tr><td><a id="l100"></a><a href="#l100">100</a><td><tr><td><a id="l101"></a><a href="#l101">101</a><td> /** @private {!webdriver.Capabilities} */<tr><td><a id="l102"></a><a href="#l102">102</a><td> this.capabilities_ = new Capabilities();<tr><td><a id="l103"></a><a href="#l103">103</a><td><tr><td><a id="l104"></a><a href="#l104">104</a><td> /** @private {chrome.Options} */<tr><td><a id="l105"></a><a href="#l105">105</a><td> this.chromeOptions_ = null;<tr><td><a id="l106"></a><a href="#l106">106</a><td><tr><td><a id="l107"></a><a href="#l107">107</a><td> /** @private {firefox.Options} */<tr><td><a id="l108"></a><a href="#l108">108</a><td> this.firefoxOptions_ = null;<tr><td><a id="l109"></a><a href="#l109">109</a><td><tr><td><a id="l110"></a><a href="#l110">110</a><td> /** @private {opera.Options} */<tr><td><a id="l111"></a><a href="#l111">111</a><td> this.operaOptions_ = null;<tr><td><a id="l112"></a><a href="#l112">112</a><td><tr><td><a id="l113"></a><a href="#l113">113</a><td> /** @private {ie.Options} */<tr><td><a id="l114"></a><a href="#l114">114</a><td> this.ieOptions_ = null;<tr><td><a id="l115"></a><a href="#l115">115</a><td><tr><td><a id="l116"></a><a href="#l116">116</a><td> /** @private {safari.Options} */<tr><td><a id="l117"></a><a href="#l117">117</a><td> this.safariOptions_ = null;<tr><td><a id="l118"></a><a href="#l118">118</a><td><tr><td><a id="l119"></a><a href="#l119">119</a><td> /** @private {boolean} */<tr><td><a id="l120"></a><a href="#l120">120</a><td> this.ignoreEnv_ = false;<tr><td><a id="l121"></a><a href="#l121">121</a><td>};<tr><td><a id="l122"></a><a href="#l122">122</a><td><tr><td><a id="l123"></a><a href="#l123">123</a><td><tr><td><a id="l124"></a><a href="#l124">124</a><td>/**<tr><td><a id="l125"></a><a href="#l125">125</a><td> * Configures this builder to ignore any environment variable overrides and to<tr><td><a id="l126"></a><a href="#l126">126</a><td> * only use the configuration specified through this instance's API.<tr><td><a id="l127"></a><a href="#l127">127</a><td> *<tr><td><a id="l128"></a><a href="#l128">128</a><td> * @return {!Builder} A self reference.<tr><td><a id="l129"></a><a href="#l129">129</a><td> */<tr><td><a id="l130"></a><a href="#l130">130</a><td>Builder.prototype.disableEnvironmentOverrides = function() {<tr><td><a id="l131"></a><a href="#l131">131</a><td> this.ignoreEnv_ = true;<tr><td><a id="l132"></a><a href="#l132">132</a><td> return this;<tr><td><a id="l133"></a><a href="#l133">133</a><td>};<tr><td><a id="l134"></a><a href="#l134">134</a><td><tr><td><a id="l135"></a><a href="#l135">135</a><td><tr><td><a id="l136"></a><a href="#l136">136</a><td>/**<tr><td><a id="l137"></a><a href="#l137">137</a><td> * Sets the URL of a remote WebDriver server to use. Once a remote URL has been<tr><td><a id="l138"></a><a href="#l138">138</a><td> * specified, the builder direct all new clients to that server. If this method<tr><td><a id="l139"></a><a href="#l139">139</a><td> * is never called, the Builder will attempt to create all clients locally.<tr><td><a id="l140"></a><a href="#l140">140</a><td> *<tr><td><a id="l141"></a><a href="#l141">141</a><td> * As an alternative to this method, you may also set the `SELENIUM_REMOTE_URL`<tr><td><a id="l142"></a><a href="#l142">142</a><td> * environment variable.<tr><td><a id="l143"></a><a href="#l143">143</a><td> *<tr><td><a id="l144"></a><a href="#l144">144</a><td> * @param {string} url The URL of a remote server to use.<tr><td><a id="l145"></a><a href="#l145">145</a><td> * @return {!Builder} A self reference.<tr><td><a id="l146"></a><a href="#l146">146</a><td> */<tr><td><a id="l147"></a><a href="#l147">147</a><td>Builder.prototype.usingServer = function(url) {<tr><td><a id="l148"></a><a href="#l148">148</a><td> this.url_ = url;<tr><td><a id="l149"></a><a href="#l149">149</a><td> return this;<tr><td><a id="l150"></a><a href="#l150">150</a><td>};<tr><td><a id="l151"></a><a href="#l151">151</a><td><tr><td><a id="l152"></a><a href="#l152">152</a><td><tr><td><a id="l153"></a><a href="#l153">153</a><td>/**<tr><td><a id="l154"></a><a href="#l154">154</a><td> * @return {string} The URL of the WebDriver server this instance is configured<tr><td><a id="l155"></a><a href="#l155">155</a><td> * to use.<tr><td><a id="l156"></a><a href="#l156">156</a><td> */<tr><td><a id="l157"></a><a href="#l157">157</a><td>Builder.prototype.getServerUrl = function() {<tr><td><a id="l158"></a><a href="#l158">158</a><td> return this.url_;<tr><td><a id="l159"></a><a href="#l159">159</a><td>};<tr><td><a id="l160"></a><a href="#l160">160</a><td><tr><td><a id="l161"></a><a href="#l161">161</a><td><tr><td><a id="l162"></a><a href="#l162">162</a><td>/**<tr><td><a id="l163"></a><a href="#l163">163</a><td> * Sets the URL of the proxy to use for the WebDriver's HTTP connections.<tr><td><a id="l164"></a><a href="#l164">164</a><td> * If this method is never called, the Builder will create a connection without<tr><td><a id="l165"></a><a href="#l165">165</a><td> * a proxy.<tr><td><a id="l166"></a><a href="#l166">166</a><td> *<tr><td><a id="l167"></a><a href="#l167">167</a><td> * @param {string} proxy The URL of a proxy to use.<tr><td><a id="l168"></a><a href="#l168">168</a><td> * @return {!Builder} A self reference.<tr><td><a id="l169"></a><a href="#l169">169</a><td> */<tr><td><a id="l170"></a><a href="#l170">170</a><td>Builder.prototype.usingWebDriverProxy = function(proxy) {<tr><td><a id="l171"></a><a href="#l171">171</a><td> this.proxy_ = proxy;<tr><td><a id="l172"></a><a href="#l172">172</a><td> return this;<tr><td><a id="l173"></a><a href="#l173">173</a><td>};<tr><td><a id="l174"></a><a href="#l174">174</a><td><tr><td><a id="l175"></a><a href="#l175">175</a><td><tr><td><a id="l176"></a><a href="#l176">176</a><td>/**<tr><td><a id="l177"></a><a href="#l177">177</a><td> * @return {string} The URL of the proxy server to use for the WebDriver's HTTP<tr><td><a id="l178"></a><a href="#l178">178</a><td> * connections.<tr><td><a id="l179"></a><a href="#l179">179</a><td> */<tr><td><a id="l180"></a><a href="#l180">180</a><td>Builder.prototype.getWebDriverProxy = function() {<tr><td><a id="l181"></a><a href="#l181">181</a><td> return this.proxy_;<tr><td><a id="l182"></a><a href="#l182">182</a><td>};<tr><td><a id="l183"></a><a href="#l183">183</a><td><tr><td><a id="l184"></a><a href="#l184">184</a><td><tr><td><a id="l185"></a><a href="#l185">185</a><td>/**<tr><td><a id="l186"></a><a href="#l186">186</a><td> * Sets the desired capabilities when requesting a new session. This will<tr><td><a id="l187"></a><a href="#l187">187</a><td> * overwrite any previously set capabilities.<tr><td><a id="l188"></a><a href="#l188">188</a><td> * @param {!(Object|webdriver.Capabilities)} capabilities The desired<tr><td><a id="l189"></a><a href="#l189">189</a><td> * capabilities for a new session.<tr><td><a id="l190"></a><a href="#l190">190</a><td> * @return {!Builder} A self reference.<tr><td><a id="l191"></a><a href="#l191">191</a><td> */<tr><td><a id="l192"></a><a href="#l192">192</a><td>Builder.prototype.withCapabilities = function(capabilities) {<tr><td><a id="l193"></a><a href="#l193">193</a><td> this.capabilities_ = new Capabilities(capabilities);<tr><td><a id="l194"></a><a href="#l194">194</a><td> return this;<tr><td><a id="l195"></a><a href="#l195">195</a><td>};<tr><td><a id="l196"></a><a href="#l196">196</a><td><tr><td><a id="l197"></a><a href="#l197">197</a><td><tr><td><a id="l198"></a><a href="#l198">198</a><td>/**<tr><td><a id="l199"></a><a href="#l199">199</a><td> * Returns the base set of capabilities this instance is currently configured<tr><td><a id="l200"></a><a href="#l200">200</a><td> * to use.<tr><td><a id="l201"></a><a href="#l201">201</a><td> * @return {!webdriver.Capabilities} The current capabilities for this builder.<tr><td><a id="l202"></a><a href="#l202">202</a><td> */<tr><td><a id="l203"></a><a href="#l203">203</a><td>Builder.prototype.getCapabilities = function() {<tr><td><a id="l204"></a><a href="#l204">204</a><td> return this.capabilities_;<tr><td><a id="l205"></a><a href="#l205">205</a><td>};<tr><td><a id="l206"></a><a href="#l206">206</a><td><tr><td><a id="l207"></a><a href="#l207">207</a><td><tr><td><a id="l208"></a><a href="#l208">208</a><td>/**<tr><td><a id="l209"></a><a href="#l209">209</a><td> * Configures the target browser for clients created by this instance.<tr><td><a id="l210"></a><a href="#l210">210</a><td> * Any calls to {@link #withCapabilities} after this function will<tr><td><a id="l211"></a><a href="#l211">211</a><td> * overwrite these settings.<tr><td><a id="l212"></a><a href="#l212">212</a><td> *<tr><td><a id="l213"></a><a href="#l213">213</a><td> * You may also define the target browser using the {@code SELENIUM_BROWSER}<tr><td><a id="l214"></a><a href="#l214">214</a><td> * environment variable. If set, this environment variable should be of the<tr><td><a id="l215"></a><a href="#l215">215</a><td> * form `browser[:[version][:platform]]`.<tr><td><a id="l216"></a><a href="#l216">216</a><td> *<tr><td><a id="l217"></a><a href="#l217">217</a><td> * @param {(string|webdriver.Browser)} name The name of the target browser;<tr><td><a id="l218"></a><a href="#l218">218</a><td> * common defaults are available on the {@link webdriver.Browser} enum.<tr><td><a id="l219"></a><a href="#l219">219</a><td> * @param {string=} opt_version A desired version; may be omitted if any<tr><td><a id="l220"></a><a href="#l220">220</a><td> * version should be used.<tr><td><a id="l221"></a><a href="#l221">221</a><td> * @param {string=} opt_platform The desired platform; may be omitted if any<tr><td><a id="l222"></a><a href="#l222">222</a><td> * version may be used.<tr><td><a id="l223"></a><a href="#l223">223</a><td> * @return {!Builder} A self reference.<tr><td><a id="l224"></a><a href="#l224">224</a><td> */<tr><td><a id="l225"></a><a href="#l225">225</a><td>Builder.prototype.forBrowser = function(name, opt_version, opt_platform) {<tr><td><a id="l226"></a><a href="#l226">226</a><td> this.capabilities_.set(Capability.BROWSER_NAME, name);<tr><td><a id="l227"></a><a href="#l227">227</a><td> this.capabilities_.set(Capability.VERSION, opt_version || null);<tr><td><a id="l228"></a><a href="#l228">228</a><td> this.capabilities_.set(Capability.PLATFORM, opt_platform || null);<tr><td><a id="l229"></a><a href="#l229">229</a><td> return this;<tr><td><a id="l230"></a><a href="#l230">230</a><td>};<tr><td><a id="l231"></a><a href="#l231">231</a><td><tr><td><a id="l232"></a><a href="#l232">232</a><td><tr><td><a id="l233"></a><a href="#l233">233</a><td>/**<tr><td><a id="l234"></a><a href="#l234">234</a><td> * Sets the proxy configuration to use for WebDriver clients created by this<tr><td><a id="l235"></a><a href="#l235">235</a><td> * builder. Any calls to {@link #withCapabilities} after this function will<tr><td><a id="l236"></a><a href="#l236">236</a><td> * overwrite these settings.<tr><td><a id="l237"></a><a href="#l237">237</a><td> * @param {!webdriver.ProxyConfig} config The configuration to use.<tr><td><a id="l238"></a><a href="#l238">238</a><td> * @return {!Builder} A self reference.<tr><td><a id="l239"></a><a href="#l239">239</a><td> */<tr><td><a id="l240"></a><a href="#l240">240</a><td>Builder.prototype.setProxy = function(config) {<tr><td><a id="l241"></a><a href="#l241">241</a><td> this.capabilities_.setProxy(config);<tr><td><a id="l242"></a><a href="#l242">242</a><td> return this;<tr><td><a id="l243"></a><a href="#l243">243</a><td>};<tr><td><a id="l244"></a><a href="#l244">244</a><td><tr><td><a id="l245"></a><a href="#l245">245</a><td><tr><td><a id="l246"></a><a href="#l246">246</a><td>/**<tr><td><a id="l247"></a><a href="#l247">247</a><td> * Sets the logging preferences for the created session. Preferences may be<tr><td><a id="l248"></a><a href="#l248">248</a><td> * changed by repeated calls, or by calling {@link #withCapabilities}.<tr><td><a id="l249"></a><a href="#l249">249</a><td> * @param {!(webdriver.logging.Preferences|Object.<string, string>)} prefs The<tr><td><a id="l250"></a><a href="#l250">250</a><td> * desired logging preferences.<tr><td><a id="l251"></a><a href="#l251">251</a><td> * @return {!Builder} A self reference.<tr><td><a id="l252"></a><a href="#l252">252</a><td> */<tr><td><a id="l253"></a><a href="#l253">253</a><td>Builder.prototype.setLoggingPrefs = function(prefs) {<tr><td><a id="l254"></a><a href="#l254">254</a><td> this.capabilities_.setLoggingPrefs(prefs);<tr><td><a id="l255"></a><a href="#l255">255</a><td> return this;<tr><td><a id="l256"></a><a href="#l256">256</a><td>};<tr><td><a id="l257"></a><a href="#l257">257</a><td><tr><td><a id="l258"></a><a href="#l258">258</a><td><tr><td><a id="l259"></a><a href="#l259">259</a><td>/**<tr><td><a id="l260"></a><a href="#l260">260</a><td> * Sets whether native events should be used.<tr><td><a id="l261"></a><a href="#l261">261</a><td> * @param {boolean} enabled Whether to enable native events.<tr><td><a id="l262"></a><a href="#l262">262</a><td> * @return {!Builder} A self reference.<tr><td><a id="l263"></a><a href="#l263">263</a><td> */<tr><td><a id="l264"></a><a href="#l264">264</a><td>Builder.prototype.setEnableNativeEvents = function(enabled) {<tr><td><a id="l265"></a><a href="#l265">265</a><td> this.capabilities_.setEnableNativeEvents(enabled);<tr><td><a id="l266"></a><a href="#l266">266</a><td> return this;<tr><td><a id="l267"></a><a href="#l267">267</a><td>};<tr><td><a id="l268"></a><a href="#l268">268</a><td><tr><td><a id="l269"></a><a href="#l269">269</a><td><tr><td><a id="l270"></a><a href="#l270">270</a><td>/**<tr><td><a id="l271"></a><a href="#l271">271</a><td> * Sets how elements should be scrolled into view for interaction.<tr><td><a id="l272"></a><a href="#l272">272</a><td> * @param {number} behavior The desired scroll behavior: either 0 to align with<tr><td><a id="l273"></a><a href="#l273">273</a><td> * the top of the viewport or 1 to align with the bottom.<tr><td><a id="l274"></a><a href="#l274">274</a><td> * @return {!Builder} A self reference.<tr><td><a id="l275"></a><a href="#l275">275</a><td> */<tr><td><a id="l276"></a><a href="#l276">276</a><td>Builder.prototype.setScrollBehavior = function(behavior) {<tr><td><a id="l277"></a><a href="#l277">277</a><td> this.capabilities_.setScrollBehavior(behavior);<tr><td><a id="l278"></a><a href="#l278">278</a><td> return this;<tr><td><a id="l279"></a><a href="#l279">279</a><td>};<tr><td><a id="l280"></a><a href="#l280">280</a><td><tr><td><a id="l281"></a><a href="#l281">281</a><td><tr><td><a id="l282"></a><a href="#l282">282</a><td>/**<tr><td><a id="l283"></a><a href="#l283">283</a><td> * Sets the default action to take with an unexpected alert before returning<tr><td><a id="l284"></a><a href="#l284">284</a><td> * an error.<tr><td><a id="l285"></a><a href="#l285">285</a><td> * @param {string} beahvior The desired behavior; should be "accept", "dismiss",<tr><td><a id="l286"></a><a href="#l286">286</a><td> * or "ignore". Defaults to "dismiss".<tr><td><a id="l287"></a><a href="#l287">287</a><td> * @return {!Builder} A self reference.<tr><td><a id="l288"></a><a href="#l288">288</a><td> */<tr><td><a id="l289"></a><a href="#l289">289</a><td>Builder.prototype.setAlertBehavior = function(behavior) {<tr><td><a id="l290"></a><a href="#l290">290</a><td> this.capabilities_.setAlertBehavior(behavior);<tr><td><a id="l291"></a><a href="#l291">291</a><td> return this;<tr><td><a id="l292"></a><a href="#l292">292</a><td>};<tr><td><a id="l293"></a><a href="#l293">293</a><td><tr><td><a id="l294"></a><a href="#l294">294</a><td><tr><td><a id="l295"></a><a href="#l295">295</a><td>/**<tr><td><a id="l296"></a><a href="#l296">296</a><td> * Sets Chrome specific {@linkplain selenium-webdriver/chrome.Options options}<tr><td><a id="l297"></a><a href="#l297">297</a><td> * for drivers created by this builder. Any logging or proxy settings defined<tr><td><a id="l298"></a><a href="#l298">298</a><td> * on the given options will take precedence over those set through<tr><td><a id="l299"></a><a href="#l299">299</a><td> * {@link #setLoggingPrefs} and {@link #setProxy}, respectively.<tr><td><a id="l300"></a><a href="#l300">300</a><td> *<tr><td><a id="l301"></a><a href="#l301">301</a><td> * @param {!chrome.Options} options The ChromeDriver options to use.<tr><td><a id="l302"></a><a href="#l302">302</a><td> * @return {!Builder} A self reference.<tr><td><a id="l303"></a><a href="#l303">303</a><td> */<tr><td><a id="l304"></a><a href="#l304">304</a><td>Builder.prototype.setChromeOptions = function(options) {<tr><td><a id="l305"></a><a href="#l305">305</a><td> this.chromeOptions_ = options;<tr><td><a id="l306"></a><a href="#l306">306</a><td> return this;<tr><td><a id="l307"></a><a href="#l307">307</a><td>};<tr><td><a id="l308"></a><a href="#l308">308</a><td><tr><td><a id="l309"></a><a href="#l309">309</a><td><tr><td><a id="l310"></a><a href="#l310">310</a><td>/**<tr><td><a id="l311"></a><a href="#l311">311</a><td> * Sets Firefox specific {@linkplain selenium-webdriver/firefox.Options options}<tr><td><a id="l312"></a><a href="#l312">312</a><td> * for drivers created by this builder. Any logging or proxy settings defined<tr><td><a id="l313"></a><a href="#l313">313</a><td> * on the given options will take precedence over those set through<tr><td><a id="l314"></a><a href="#l314">314</a><td> * {@link #setLoggingPrefs} and {@link #setProxy}, respectively.<tr><td><a id="l315"></a><a href="#l315">315</a><td> *<tr><td><a id="l316"></a><a href="#l316">316</a><td> * @param {!firefox.Options} options The FirefoxDriver options to use.<tr><td><a id="l317"></a><a href="#l317">317</a><td> * @return {!Builder} A self reference.<tr><td><a id="l318"></a><a href="#l318">318</a><td> */<tr><td><a id="l319"></a><a href="#l319">319</a><td>Builder.prototype.setFirefoxOptions = function(options) {<tr><td><a id="l320"></a><a href="#l320">320</a><td> this.firefoxOptions_ = options;<tr><td><a id="l321"></a><a href="#l321">321</a><td> return this;<tr><td><a id="l322"></a><a href="#l322">322</a><td>};<tr><td><a id="l323"></a><a href="#l323">323</a><td><tr><td><a id="l324"></a><a href="#l324">324</a><td><tr><td><a id="l325"></a><a href="#l325">325</a><td>/**<tr><td><a id="l326"></a><a href="#l326">326</a><td> * Sets Opera specific {@linkplain selenium-webdriver/opera.Options options} for<tr><td><a id="l327"></a><a href="#l327">327</a><td> * drivers created by this builder. Any logging or proxy settings defined on the<tr><td><a id="l328"></a><a href="#l328">328</a><td> * given options will take precedence over those set through<tr><td><a id="l329"></a><a href="#l329">329</a><td> * {@link #setLoggingPrefs} and {@link #setProxy}, respectively.<tr><td><a id="l330"></a><a href="#l330">330</a><td> *<tr><td><a id="l331"></a><a href="#l331">331</a><td> * @param {!opera.Options} options The OperaDriver options to use.<tr><td><a id="l332"></a><a href="#l332">332</a><td> * @return {!Builder} A self reference.<tr><td><a id="l333"></a><a href="#l333">333</a><td> */<tr><td><a id="l334"></a><a href="#l334">334</a><td>Builder.prototype.setOperaOptions = function(options) {<tr><td><a id="l335"></a><a href="#l335">335</a><td> this.operaOptions_ = options;<tr><td><a id="l336"></a><a href="#l336">336</a><td> return this;<tr><td><a id="l337"></a><a href="#l337">337</a><td>};<tr><td><a id="l338"></a><a href="#l338">338</a><td><tr><td><a id="l339"></a><a href="#l339">339</a><td><tr><td><a id="l340"></a><a href="#l340">340</a><td>/**<tr><td><a id="l341"></a><a href="#l341">341</a><td> * Sets Internet Explorer specific<tr><td><a id="l342"></a><a href="#l342">342</a><td> * {@linkplain selenium-webdriver/ie.Options options} for drivers created by<tr><td><a id="l343"></a><a href="#l343">343</a><td> * this builder. Any proxy settings defined on the given options will take<tr><td><a id="l344"></a><a href="#l344">344</a><td> * precedence over those set through {@link #setProxy}.<tr><td><a id="l345"></a><a href="#l345">345</a><td> *<tr><td><a id="l346"></a><a href="#l346">346</a><td> * @param {!ie.Options} options The IEDriver options to use.<tr><td><a id="l347"></a><a href="#l347">347</a><td> * @return {!Builder} A self reference.<tr><td><a id="l348"></a><a href="#l348">348</a><td> */<tr><td><a id="l349"></a><a href="#l349">349</a><td>Builder.prototype.setIeOptions = function(options) {<tr><td><a id="l350"></a><a href="#l350">350</a><td> this.ieOptions_ = options;<tr><td><a id="l351"></a><a href="#l351">351</a><td> return this;<tr><td><a id="l352"></a><a href="#l352">352</a><td>};<tr><td><a id="l353"></a><a href="#l353">353</a><td><tr><td><a id="l354"></a><a href="#l354">354</a><td><tr><td><a id="l355"></a><a href="#l355">355</a><td>/**<tr><td><a id="l356"></a><a href="#l356">356</a><td> * Sets Safari specific {@linkplain selenium-webdriver/safari.Options options}<tr><td><a id="l357"></a><a href="#l357">357</a><td> * for drivers created by this builder. Any logging settings defined on the<tr><td><a id="l358"></a><a href="#l358">358</a><td> * given options will take precedence over those set through<tr><td><a id="l359"></a><a href="#l359">359</a><td> * {@link #setLoggingPrefs}.<tr><td><a id="l360"></a><a href="#l360">360</a><td> *<tr><td><a id="l361"></a><a href="#l361">361</a><td> * @param {!safari.Options} options The Safari options to use.<tr><td><a id="l362"></a><a href="#l362">362</a><td> * @return {!Builder} A self reference.<tr><td><a id="l363"></a><a href="#l363">363</a><td> */<tr><td><a id="l364"></a><a href="#l364">364</a><td>Builder.prototype.setSafariOptions = function(options) {<tr><td><a id="l365"></a><a href="#l365">365</a><td> this.safariOptions_ = options;<tr><td><a id="l366"></a><a href="#l366">366</a><td> return this;<tr><td><a id="l367"></a><a href="#l367">367</a><td>};<tr><td><a id="l368"></a><a href="#l368">368</a><td><tr><td><a id="l369"></a><a href="#l369">369</a><td><tr><td><a id="l370"></a><a href="#l370">370</a><td>/**<tr><td><a id="l371"></a><a href="#l371">371</a><td> * Sets the control flow that created drivers should execute actions in. If<tr><td><a id="l372"></a><a href="#l372">372</a><td> * the flow is never set, or is set to {@code null}, it will use the active<tr><td><a id="l373"></a><a href="#l373">373</a><td> * flow at the time {@link #build()} is called.<tr><td><a id="l374"></a><a href="#l374">374</a><td> * @param {webdriver.promise.ControlFlow} flow The control flow to use, or<tr><td><a id="l375"></a><a href="#l375">375</a><td> * {@code null} to<tr><td><a id="l376"></a><a href="#l376">376</a><td> * @return {!Builder} A self reference.<tr><td><a id="l377"></a><a href="#l377">377</a><td> */<tr><td><a id="l378"></a><a href="#l378">378</a><td>Builder.prototype.setControlFlow = function(flow) {<tr><td><a id="l379"></a><a href="#l379">379</a><td> this.flow_ = flow;<tr><td><a id="l380"></a><a href="#l380">380</a><td> return this;<tr><td><a id="l381"></a><a href="#l381">381</a><td>};<tr><td><a id="l382"></a><a href="#l382">382</a><td><tr><td><a id="l383"></a><a href="#l383">383</a><td><tr><td><a id="l384"></a><a href="#l384">384</a><td>/**<tr><td><a id="l385"></a><a href="#l385">385</a><td> * Creates a new WebDriver client based on this builder's current<tr><td><a id="l386"></a><a href="#l386">386</a><td> * configuration.<tr><td><a id="l387"></a><a href="#l387">387</a><td> *<tr><td><a id="l388"></a><a href="#l388">388</a><td> * @return {!webdriver.WebDriver} A new WebDriver instance.<tr><td><a id="l389"></a><a href="#l389">389</a><td> * @throws {Error} If the current configuration is invalid.<tr><td><a id="l390"></a><a href="#l390">390</a><td> */<tr><td><a id="l391"></a><a href="#l391">391</a><td>Builder.prototype.build = function() {<tr><td><a id="l392"></a><a href="#l392">392</a><td> // Create a copy for any changes we may need to make based on the current<tr><td><a id="l393"></a><a href="#l393">393</a><td> // environment.<tr><td><a id="l394"></a><a href="#l394">394</a><td> var capabilities = new Capabilities(this.capabilities_);<tr><td><a id="l395"></a><a href="#l395">395</a><td><tr><td><a id="l396"></a><a href="#l396">396</a><td> var browser;<tr><td><a id="l397"></a><a href="#l397">397</a><td> if (!this.ignoreEnv_ && process.env.SELENIUM_BROWSER) {<tr><td><a id="l398"></a><a href="#l398">398</a><td> browser = process.env.SELENIUM_BROWSER.split(/:/, 3);<tr><td><a id="l399"></a><a href="#l399">399</a><td> capabilities.set(Capability.BROWSER_NAME, browser[0]);<tr><td><a id="l400"></a><a href="#l400">400</a><td> capabilities.set(Capability.VERSION, browser[1] || null);<tr><td><a id="l401"></a><a href="#l401">401</a><td> capabilities.set(Capability.PLATFORM, browser[2] || null);<tr><td><a id="l402"></a><a href="#l402">402</a><td> }<tr><td><a id="l403"></a><a href="#l403">403</a><td><tr><td><a id="l404"></a><a href="#l404">404</a><td> browser = capabilities.get(Capability.BROWSER_NAME);<tr><td><a id="l405"></a><a href="#l405">405</a><td><tr><td><a id="l406"></a><a href="#l406">406</a><td> if (typeof browser !== 'string') {<tr><td><a id="l407"></a><a href="#l407">407</a><td> throw TypeError(<tr><td><a id="l408"></a><a href="#l408">408</a><td> 'Target browser must be a string, but is <' + (typeof browser) + '>;' +<tr><td><a id="l409"></a><a href="#l409">409</a><td> ' did you forget to call forBrowser()?');<tr><td><a id="l410"></a><a href="#l410">410</a><td> }<tr><td><a id="l411"></a><a href="#l411">411</a><td><tr><td><a id="l412"></a><a href="#l412">412</a><td> if (browser === 'ie') {<tr><td><a id="l413"></a><a href="#l413">413</a><td> browser = Browser.INTERNET_EXPLORER;<tr><td><a id="l414"></a><a href="#l414">414</a><td> }<tr><td><a id="l415"></a><a href="#l415">415</a><td><tr><td><a id="l416"></a><a href="#l416">416</a><td> // Apply browser specific overrides.<tr><td><a id="l417"></a><a href="#l417">417</a><td> if (browser === Browser.CHROME && this.chromeOptions_) {<tr><td><a id="l418"></a><a href="#l418">418</a><td> capabilities.merge(this.chromeOptions_.toCapabilities());<tr><td><a id="l419"></a><a href="#l419">419</a><td><tr><td><a id="l420"></a><a href="#l420">420</a><td> } else if (browser === Browser.FIREFOX && this.firefoxOptions_) {<tr><td><a id="l421"></a><a href="#l421">421</a><td> capabilities.merge(this.firefoxOptions_.toCapabilities());<tr><td><a id="l422"></a><a href="#l422">422</a><td><tr><td><a id="l423"></a><a href="#l423">423</a><td> } else if (browser === Browser.INTERNET_EXPLORER && this.ieOptions_) {<tr><td><a id="l424"></a><a href="#l424">424</a><td> capabilities.merge(this.ieOptions_.toCapabilities());<tr><td><a id="l425"></a><a href="#l425">425</a><td><tr><td><a id="l426"></a><a href="#l426">426</a><td> } else if (browser === Browser.OPERA && this.operaOptions_) {<tr><td><a id="l427"></a><a href="#l427">427</a><td> capabilities.merge(this.operaOptions_.toCapabilities());<tr><td><a id="l428"></a><a href="#l428">428</a><td><tr><td><a id="l429"></a><a href="#l429">429</a><td> } else if (browser === Browser.SAFARI && this.safariOptions_) {<tr><td><a id="l430"></a><a href="#l430">430</a><td> capabilities.merge(this.safariOptions_.toCapabilities());<tr><td><a id="l431"></a><a href="#l431">431</a><td> }<tr><td><a id="l432"></a><a href="#l432">432</a><td><tr><td><a id="l433"></a><a href="#l433">433</a><td> // Check for a remote browser.<tr><td><a id="l434"></a><a href="#l434">434</a><td> var url = this.url_;<tr><td><a id="l435"></a><a href="#l435">435</a><td> if (!this.ignoreEnv_) {<tr><td><a id="l436"></a><a href="#l436">436</a><td> if (process.env.SELENIUM_REMOTE_URL) {<tr><td><a id="l437"></a><a href="#l437">437</a><td> url = process.env.SELENIUM_REMOTE_URL;<tr><td><a id="l438"></a><a href="#l438">438</a><td> } else if (process.env.SELENIUM_SERVER_JAR) {<tr><td><a id="l439"></a><a href="#l439">439</a><td> url = startSeleniumServer(process.env.SELENIUM_SERVER_JAR);<tr><td><a id="l440"></a><a href="#l440">440</a><td> }<tr><td><a id="l441"></a><a href="#l441">441</a><td> }<tr><td><a id="l442"></a><a href="#l442">442</a><td><tr><td><a id="l443"></a><a href="#l443">443</a><td> if (url) {<tr><td><a id="l444"></a><a href="#l444">444</a><td> var executor = executors.createExecutor(url, this.proxy_);<tr><td><a id="l445"></a><a href="#l445">445</a><td> return WebDriver.createSession(executor, capabilities, this.flow_);<tr><td><a id="l446"></a><a href="#l446">446</a><td> }<tr><td><a id="l447"></a><a href="#l447">447</a><td><tr><td><a id="l448"></a><a href="#l448">448</a><td> // Check for a native browser.<tr><td><a id="l449"></a><a href="#l449">449</a><td> switch (browser) {<tr><td><a id="l450"></a><a href="#l450">450</a><td> case Browser.CHROME:<tr><td><a id="l451"></a><a href="#l451">451</a><td> // Requiring 'chrome' above would create a cycle:<tr><td><a id="l452"></a><a href="#l452">452</a><td> // index -> builder -> chrome -> index<tr><td><a id="l453"></a><a href="#l453">453</a><td> var chrome = require('./chrome');<tr><td><a id="l454"></a><a href="#l454">454</a><td> return new chrome.Driver(capabilities, null, this.flow_);<tr><td><a id="l455"></a><a href="#l455">455</a><td><tr><td><a id="l456"></a><a href="#l456">456</a><td> case Browser.FIREFOX:<tr><td><a id="l457"></a><a href="#l457">457</a><td> // Requiring 'firefox' above would create a cycle:<tr><td><a id="l458"></a><a href="#l458">458</a><td> // index -> builder -> firefox -> index<tr><td><a id="l459"></a><a href="#l459">459</a><td> var firefox = require('./firefox');<tr><td><a id="l460"></a><a href="#l460">460</a><td> return new firefox.Driver(capabilities, this.flow_);<tr><td><a id="l461"></a><a href="#l461">461</a><td><tr><td><a id="l462"></a><a href="#l462">462</a><td> case Browser.INTERNET_EXPLORER:<tr><td><a id="l463"></a><a href="#l463">463</a><td> // Requiring 'ie' above would create a cycle:<tr><td><a id="l464"></a><a href="#l464">464</a><td> // index -> builder -> ie -> index<tr><td><a id="l465"></a><a href="#l465">465</a><td> var ie = require('./ie');<tr><td><a id="l466"></a><a href="#l466">466</a><td> return new ie.Driver(capabilities, this.flow_);<tr><td><a id="l467"></a><a href="#l467">467</a><td><tr><td><a id="l468"></a><a href="#l468">468</a><td> case Browser.OPERA:<tr><td><a id="l469"></a><a href="#l469">469</a><td> // Requiring 'opera' would create a cycle:<tr><td><a id="l470"></a><a href="#l470">470</a><td> // index -> builder -> opera -> index<tr><td><a id="l471"></a><a href="#l471">471</a><td> var opera = require('./opera');<tr><td><a id="l472"></a><a href="#l472">472</a><td> return new opera.Driver(capabilities, this.flow_);<tr><td><a id="l473"></a><a href="#l473">473</a><td><tr><td><a id="l474"></a><a href="#l474">474</a><td> case Browser.PHANTOM_JS:<tr><td><a id="l475"></a><a href="#l475">475</a><td> // Requiring 'phantomjs' would create a cycle:<tr><td><a id="l476"></a><a href="#l476">476</a><td> // index -> builder -> phantomjs -> index<tr><td><a id="l477"></a><a href="#l477">477</a><td> var phantomjs = require('./phantomjs');<tr><td><a id="l478"></a><a href="#l478">478</a><td> return new phantomjs.Driver(capabilities, this.flow_);<tr><td><a id="l479"></a><a href="#l479">479</a><td><tr><td><a id="l480"></a><a href="#l480">480</a><td> case Browser.SAFARI:<tr><td><a id="l481"></a><a href="#l481">481</a><td> // Requiring 'safari' would create a cycle:<tr><td><a id="l482"></a><a href="#l482">482</a><td> // index -> builder -> safari -> index<tr><td><a id="l483"></a><a href="#l483">483</a><td> var safari = require('./safari');<tr><td><a id="l484"></a><a href="#l484">484</a><td> return new safari.Driver(capabilities, this.flow_);<tr><td><a id="l485"></a><a href="#l485">485</a><td><tr><td><a id="l486"></a><a href="#l486">486</a><td> default:<tr><td><a id="l487"></a><a href="#l487">487</a><td> throw new Error('Do not know how to build driver: ' + browser<tr><td><a id="l488"></a><a href="#l488">488</a><td> + '; did you forget to call usingServer(url)?');<tr><td><a id="l489"></a><a href="#l489">489</a><td> }<tr><td><a id="l490"></a><a href="#l490">490</a><td>};<tr><td><a id="l491"></a><a href="#l491">491</a><td><tr><td><a id="l492"></a><a href="#l492">492</a><td><tr><td><a id="l493"></a><a href="#l493">493</a><td>// PUBLIC API<tr><td><a id="l494"></a><a href="#l494">494</a><td><tr><td><a id="l495"></a><a href="#l495">495</a><td><tr><td><a id="l496"></a><a href="#l496">496</a><td>exports.Builder = Builder;</table></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>