selenium-webdriver
Version:
The official WebDriver JavaScript bindings from the Selenium project
1 lines • 71.6 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>chrome.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>chrome.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>/**<tr><td><a id="l19"></a><a href="#l19">19</a><td> * @fileoverview Defines a {@linkplain Driver WebDriver} client for the Chrome<tr><td><a id="l20"></a><a href="#l20">20</a><td> * web browser. Before using this module, you must download the latest<tr><td><a id="l21"></a><a href="#l21">21</a><td> * [ChromeDriver release] and ensure it can be found on your system [PATH].<tr><td><a id="l22"></a><a href="#l22">22</a><td> *<tr><td><a id="l23"></a><a href="#l23">23</a><td> * There are three primary classes exported by this module:<tr><td><a id="l24"></a><a href="#l24">24</a><td> *<tr><td><a id="l25"></a><a href="#l25">25</a><td> * 1. {@linkplain ServiceBuilder}: configures the<tr><td><a id="l26"></a><a href="#l26">26</a><td> * {@link selenium-webdriver/remote.DriverService remote.DriverService}<tr><td><a id="l27"></a><a href="#l27">27</a><td> * that manages the [ChromeDriver] child process.<tr><td><a id="l28"></a><a href="#l28">28</a><td> *<tr><td><a id="l29"></a><a href="#l29">29</a><td> * 2. {@linkplain Options}: defines configuration options for each new Chrome<tr><td><a id="l30"></a><a href="#l30">30</a><td> * session, such as which {@linkplain Options#setProxy proxy} to use,<tr><td><a id="l31"></a><a href="#l31">31</a><td> * what {@linkplain Options#addExtensions extensions} to install, or<tr><td><a id="l32"></a><a href="#l32">32</a><td> * what {@linkplain Options#addArguments command-line switches} to use when<tr><td><a id="l33"></a><a href="#l33">33</a><td> * starting the browser.<tr><td><a id="l34"></a><a href="#l34">34</a><td> *<tr><td><a id="l35"></a><a href="#l35">35</a><td> * 3. {@linkplain Driver}: the WebDriver client; each new instance will control<tr><td><a id="l36"></a><a href="#l36">36</a><td> * a unique browser session with a clean user profile (unless otherwise<tr><td><a id="l37"></a><a href="#l37">37</a><td> * configured through the {@link Options} class).<tr><td><a id="l38"></a><a href="#l38">38</a><td> *<tr><td><a id="l39"></a><a href="#l39">39</a><td> * __Customizing the ChromeDriver Server__ <a id="custom-server"></a><tr><td><a id="l40"></a><a href="#l40">40</a><td> *<tr><td><a id="l41"></a><a href="#l41">41</a><td> * By default, every Chrome session will use a single driver service, which is<tr><td><a id="l42"></a><a href="#l42">42</a><td> * started the first time a {@link Driver} instance is created and terminated<tr><td><a id="l43"></a><a href="#l43">43</a><td> * when this process exits. The default service will inherit its environment<tr><td><a id="l44"></a><a href="#l44">44</a><td> * from the current process and direct all output to /dev/null. You may obtain<tr><td><a id="l45"></a><a href="#l45">45</a><td> * a handle to this default service using<tr><td><a id="l46"></a><a href="#l46">46</a><td> * {@link #getDefaultService getDefaultService()} and change its configuration<tr><td><a id="l47"></a><a href="#l47">47</a><td> * with {@link #setDefaultService setDefaultService()}.<tr><td><a id="l48"></a><a href="#l48">48</a><td> *<tr><td><a id="l49"></a><a href="#l49">49</a><td> * You may also create a {@link Driver} with its own driver service. This is<tr><td><a id="l50"></a><a href="#l50">50</a><td> * useful if you need to capture the server's log output for a specific session:<tr><td><a id="l51"></a><a href="#l51">51</a><td> *<tr><td><a id="l52"></a><a href="#l52">52</a><td> * var chrome = require('selenium-webdriver/chrome');<tr><td><a id="l53"></a><a href="#l53">53</a><td> *<tr><td><a id="l54"></a><a href="#l54">54</a><td> * var service = new chrome.ServiceBuilder()<tr><td><a id="l55"></a><a href="#l55">55</a><td> * .loggingTo('/my/log/file.txt')<tr><td><a id="l56"></a><a href="#l56">56</a><td> * .enableVerboseLogging()<tr><td><a id="l57"></a><a href="#l57">57</a><td> * .build();<tr><td><a id="l58"></a><a href="#l58">58</a><td> *<tr><td><a id="l59"></a><a href="#l59">59</a><td> * var options = new chrome.Options();<tr><td><a id="l60"></a><a href="#l60">60</a><td> * // configure browser options ...<tr><td><a id="l61"></a><a href="#l61">61</a><td> *<tr><td><a id="l62"></a><a href="#l62">62</a><td> * var driver = new chrome.Driver(options, service);<tr><td><a id="l63"></a><a href="#l63">63</a><td> *<tr><td><a id="l64"></a><a href="#l64">64</a><td> * Users should only instantiate the {@link Driver} class directly when they<tr><td><a id="l65"></a><a href="#l65">65</a><td> * need a custom driver service configuration (as shown above). For normal<tr><td><a id="l66"></a><a href="#l66">66</a><td> * operation, users should start Chrome using the<tr><td><a id="l67"></a><a href="#l67">67</a><td> * {@link selenium-webdriver.Builder}.<tr><td><a id="l68"></a><a href="#l68">68</a><td> *<tr><td><a id="l69"></a><a href="#l69">69</a><td> * __Working with Android__ <a id="android"></a><tr><td><a id="l70"></a><a href="#l70">70</a><td> *<tr><td><a id="l71"></a><a href="#l71">71</a><td> * The [ChromeDriver][android] supports running tests on the Chrome browser as<tr><td><a id="l72"></a><a href="#l72">72</a><td> * well as [WebView apps][webview] starting in Android 4.4 (KitKat). In order to<tr><td><a id="l73"></a><a href="#l73">73</a><td> * work with Android, you must first start the adb<tr><td><a id="l74"></a><a href="#l74">74</a><td> *<tr><td><a id="l75"></a><a href="#l75">75</a><td> * adb start-server<tr><td><a id="l76"></a><a href="#l76">76</a><td> *<tr><td><a id="l77"></a><a href="#l77">77</a><td> * By default, adb will start on port 5037. You may change this port, but this<tr><td><a id="l78"></a><a href="#l78">78</a><td> * will require configuring a [custom server](#custom-server) that will connect<tr><td><a id="l79"></a><a href="#l79">79</a><td> * to adb on the {@linkplain ServiceBuilder#setAdbPort correct port}:<tr><td><a id="l80"></a><a href="#l80">80</a><td> *<tr><td><a id="l81"></a><a href="#l81">81</a><td> * var service = new chrome.ServiceBuilder()<tr><td><a id="l82"></a><a href="#l82">82</a><td> * .setAdbPort(1234)<tr><td><a id="l83"></a><a href="#l83">83</a><td> * build();<tr><td><a id="l84"></a><a href="#l84">84</a><td> * // etc.<tr><td><a id="l85"></a><a href="#l85">85</a><td> *<tr><td><a id="l86"></a><a href="#l86">86</a><td> * The ChromeDriver may be configured to launch Chrome on Android using<tr><td><a id="l87"></a><a href="#l87">87</a><td> * {@link Options#androidChrome()}:<tr><td><a id="l88"></a><a href="#l88">88</a><td> *<tr><td><a id="l89"></a><a href="#l89">89</a><td> * var driver = new Builder()<tr><td><a id="l90"></a><a href="#l90">90</a><td> * .forBrowser('chrome')<tr><td><a id="l91"></a><a href="#l91">91</a><td> * .setChromeOptions(new chrome.Options().androidChrome())<tr><td><a id="l92"></a><a href="#l92">92</a><td> * .build();<tr><td><a id="l93"></a><a href="#l93">93</a><td> *<tr><td><a id="l94"></a><a href="#l94">94</a><td> * Alternatively, you can configure the ChromeDriver to launch an app with a<tr><td><a id="l95"></a><a href="#l95">95</a><td> * Chrome-WebView by setting the {@linkplain Options#androidActivity<tr><td><a id="l96"></a><a href="#l96">96</a><td> * androidActivity} option:<tr><td><a id="l97"></a><a href="#l97">97</a><td> *<tr><td><a id="l98"></a><a href="#l98">98</a><td> * var driver = new Builder()<tr><td><a id="l99"></a><a href="#l99">99</a><td> * .forBrowser('chrome')<tr><td><a id="l100"></a><a href="#l100">100</a><td> * .setChromeOptions(new chrome.Options()<tr><td><a id="l101"></a><a href="#l101">101</a><td> * .androidPackage('com.example')<tr><td><a id="l102"></a><a href="#l102">102</a><td> * .androidActivity('com.example.Activity'))<tr><td><a id="l103"></a><a href="#l103">103</a><td> * .build();<tr><td><a id="l104"></a><a href="#l104">104</a><td> *<tr><td><a id="l105"></a><a href="#l105">105</a><td> * [Refer to the ChromeDriver site] for more information on using the<tr><td><a id="l106"></a><a href="#l106">106</a><td> * [ChromeDriver with Android][android].<tr><td><a id="l107"></a><a href="#l107">107</a><td> *<tr><td><a id="l108"></a><a href="#l108">108</a><td> * [ChromeDriver]: https://sites.google.com/a/chromium.org/chromedriver/<tr><td><a id="l109"></a><a href="#l109">109</a><td> * [ChromeDriver release]: http://chromedriver.storage.googleapis.com/index.html<tr><td><a id="l110"></a><a href="#l110">110</a><td> * [PATH]: http://en.wikipedia.org/wiki/PATH_%28variable%29<tr><td><a id="l111"></a><a href="#l111">111</a><td> * [android]: https://sites.google.com/a/chromium.org/chromedriver/getting-started/getting-started---android<tr><td><a id="l112"></a><a href="#l112">112</a><td> * [webview]: https://developer.chrome.com/multidevice/webview/overview<tr><td><a id="l113"></a><a href="#l113">113</a><td> */<tr><td><a id="l114"></a><a href="#l114">114</a><td><tr><td><a id="l115"></a><a href="#l115">115</a><td>'use strict';<tr><td><a id="l116"></a><a href="#l116">116</a><td><tr><td><a id="l117"></a><a href="#l117">117</a><td>var fs = require('fs'),<tr><td><a id="l118"></a><a href="#l118">118</a><td> util = require('util');<tr><td><a id="l119"></a><a href="#l119">119</a><td><tr><td><a id="l120"></a><a href="#l120">120</a><td>var webdriver = require('./index'),<tr><td><a id="l121"></a><a href="#l121">121</a><td> executors = require('./executors'),<tr><td><a id="l122"></a><a href="#l122">122</a><td> http = require('./http'),<tr><td><a id="l123"></a><a href="#l123">123</a><td> io = require('./io'),<tr><td><a id="l124"></a><a href="#l124">124</a><td> portprober = require('./net/portprober'),<tr><td><a id="l125"></a><a href="#l125">125</a><td> remote = require('./remote');<tr><td><a id="l126"></a><a href="#l126">126</a><td><tr><td><a id="l127"></a><a href="#l127">127</a><td><tr><td><a id="l128"></a><a href="#l128">128</a><td>/**<tr><td><a id="l129"></a><a href="#l129">129</a><td> * Name of the ChromeDriver executable.<tr><td><a id="l130"></a><a href="#l130">130</a><td> * @type {string}<tr><td><a id="l131"></a><a href="#l131">131</a><td> * @const<tr><td><a id="l132"></a><a href="#l132">132</a><td> */<tr><td><a id="l133"></a><a href="#l133">133</a><td>var CHROMEDRIVER_EXE =<tr><td><a id="l134"></a><a href="#l134">134</a><td> process.platform === 'win32' ? 'chromedriver.exe' : 'chromedriver';<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>/**<tr><td><a id="l138"></a><a href="#l138">138</a><td> * Custom command names supported by ChromeDriver.<tr><td><a id="l139"></a><a href="#l139">139</a><td> * @enum {string}<tr><td><a id="l140"></a><a href="#l140">140</a><td> */<tr><td><a id="l141"></a><a href="#l141">141</a><td>var Command = {<tr><td><a id="l142"></a><a href="#l142">142</a><td> LAUNCH_APP: 'launchApp'<tr><td><a id="l143"></a><a href="#l143">143</a><td>};<tr><td><a id="l144"></a><a href="#l144">144</a><td><tr><td><a id="l145"></a><a href="#l145">145</a><td><tr><td><a id="l146"></a><a href="#l146">146</a><td>/**<tr><td><a id="l147"></a><a href="#l147">147</a><td> * Creates a command executor with support for ChromeDriver's custom commands.<tr><td><a id="l148"></a><a href="#l148">148</a><td> * @param {!webdriver.promise.Promise<string>} url The server's URL.<tr><td><a id="l149"></a><a href="#l149">149</a><td> * @return {!webdriver.CommandExecutor} The new command executor.<tr><td><a id="l150"></a><a href="#l150">150</a><td> */<tr><td><a id="l151"></a><a href="#l151">151</a><td>function createExecutor(url) {<tr><td><a id="l152"></a><a href="#l152">152</a><td> return new executors.DeferredExecutor(url.then(function(url) {<tr><td><a id="l153"></a><a href="#l153">153</a><td> var client = new http.HttpClient(url);<tr><td><a id="l154"></a><a href="#l154">154</a><td> var executor = new http.Executor(client);<tr><td><a id="l155"></a><a href="#l155">155</a><td> executor.defineCommand(<tr><td><a id="l156"></a><a href="#l156">156</a><td> Command.LAUNCH_APP,<tr><td><a id="l157"></a><a href="#l157">157</a><td> 'POST', '/session/:sessionId/chromium/launch_app');<tr><td><a id="l158"></a><a href="#l158">158</a><td> return executor;<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>/**<tr><td><a id="l164"></a><a href="#l164">164</a><td> * Creates {@link selenium-webdriver/remote.DriverService} instances that manage<tr><td><a id="l165"></a><a href="#l165">165</a><td> * a [ChromeDriver](https://sites.google.com/a/chromium.org/chromedriver/)<tr><td><a id="l166"></a><a href="#l166">166</a><td> * server in a child process.<tr><td><a id="l167"></a><a href="#l167">167</a><td> *<tr><td><a id="l168"></a><a href="#l168">168</a><td> * @param {string=} opt_exe Path to the server executable to use. If omitted,<tr><td><a id="l169"></a><a href="#l169">169</a><td> * the builder will attempt to locate the chromedriver on the current<tr><td><a id="l170"></a><a href="#l170">170</a><td> * PATH.<tr><td><a id="l171"></a><a href="#l171">171</a><td> * @throws {Error} If provided executable does not exist, or the chromedriver<tr><td><a id="l172"></a><a href="#l172">172</a><td> * cannot be found on the PATH.<tr><td><a id="l173"></a><a href="#l173">173</a><td> * @constructor<tr><td><a id="l174"></a><a href="#l174">174</a><td> */<tr><td><a id="l175"></a><a href="#l175">175</a><td>var ServiceBuilder = function(opt_exe) {<tr><td><a id="l176"></a><a href="#l176">176</a><td> /** @private {string} */<tr><td><a id="l177"></a><a href="#l177">177</a><td> this.exe_ = opt_exe || io.findInPath(CHROMEDRIVER_EXE, true);<tr><td><a id="l178"></a><a href="#l178">178</a><td> if (!this.exe_) {<tr><td><a id="l179"></a><a href="#l179">179</a><td> throw Error(<tr><td><a id="l180"></a><a href="#l180">180</a><td> 'The ChromeDriver could not be found on the current PATH. Please ' +<tr><td><a id="l181"></a><a href="#l181">181</a><td> 'download the latest version of the ChromeDriver from ' +<tr><td><a id="l182"></a><a href="#l182">182</a><td> 'http://chromedriver.storage.googleapis.com/index.html and ensure ' +<tr><td><a id="l183"></a><a href="#l183">183</a><td> 'it can be found on your PATH.');<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> if (!fs.existsSync(this.exe_)) {<tr><td><a id="l187"></a><a href="#l187">187</a><td> throw Error('File does not exist: ' + this.exe_);<tr><td><a id="l188"></a><a href="#l188">188</a><td> }<tr><td><a id="l189"></a><a href="#l189">189</a><td><tr><td><a id="l190"></a><a href="#l190">190</a><td> /** @private {!Array.<string>} */<tr><td><a id="l191"></a><a href="#l191">191</a><td> this.args_ = [];<tr><td><a id="l192"></a><a href="#l192">192</a><td> this.stdio_ = 'ignore';<tr><td><a id="l193"></a><a href="#l193">193</a><td>};<tr><td><a id="l194"></a><a href="#l194">194</a><td><tr><td><a id="l195"></a><a href="#l195">195</a><td><tr><td><a id="l196"></a><a href="#l196">196</a><td>/** @private {string} */<tr><td><a id="l197"></a><a href="#l197">197</a><td>ServiceBuilder.prototype.path_ = null;<tr><td><a id="l198"></a><a href="#l198">198</a><td><tr><td><a id="l199"></a><a href="#l199">199</a><td>/** @private {number} */<tr><td><a id="l200"></a><a href="#l200">200</a><td>ServiceBuilder.prototype.port_ = 0;<tr><td><a id="l201"></a><a href="#l201">201</a><td><tr><td><a id="l202"></a><a href="#l202">202</a><td><tr><td><a id="l203"></a><a href="#l203">203</a><td>/** @private {(string|!Array.<string|number|!Stream|null|undefined>)} */<tr><td><a id="l204"></a><a href="#l204">204</a><td>ServiceBuilder.prototype.stdio_ = 'ignore';<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>/** @private {Object.<string, string>} */<tr><td><a id="l208"></a><a href="#l208">208</a><td>ServiceBuilder.prototype.env_ = null;<tr><td><a id="l209"></a><a href="#l209">209</a><td><tr><td><a id="l210"></a><a href="#l210">210</a><td><tr><td><a id="l211"></a><a href="#l211">211</a><td>/**<tr><td><a id="l212"></a><a href="#l212">212</a><td> * Sets the port to start the ChromeDriver on.<tr><td><a id="l213"></a><a href="#l213">213</a><td> * @param {number} port The port to use, or 0 for any free port.<tr><td><a id="l214"></a><a href="#l214">214</a><td> * @return {!ServiceBuilder} A self reference.<tr><td><a id="l215"></a><a href="#l215">215</a><td> * @throws {Error} If the port is invalid.<tr><td><a id="l216"></a><a href="#l216">216</a><td> */<tr><td><a id="l217"></a><a href="#l217">217</a><td>ServiceBuilder.prototype.usingPort = function(port) {<tr><td><a id="l218"></a><a href="#l218">218</a><td> if (port < 0) {<tr><td><a id="l219"></a><a href="#l219">219</a><td> throw Error('port must be >= 0: ' + port);<tr><td><a id="l220"></a><a href="#l220">220</a><td> }<tr><td><a id="l221"></a><a href="#l221">221</a><td> this.port_ = port;<tr><td><a id="l222"></a><a href="#l222">222</a><td> return this;<tr><td><a id="l223"></a><a href="#l223">223</a><td>};<tr><td><a id="l224"></a><a href="#l224">224</a><td><tr><td><a id="l225"></a><a href="#l225">225</a><td><tr><td><a id="l226"></a><a href="#l226">226</a><td>/**<tr><td><a id="l227"></a><a href="#l227">227</a><td> * Sets which port adb is listening to. _The ChromeDriver will connect to adb<tr><td><a id="l228"></a><a href="#l228">228</a><td> * if an {@linkplain Options#androidPackage Android session} is requested, but<tr><td><a id="l229"></a><a href="#l229">229</a><td> * adb **must** be started beforehand._<tr><td><a id="l230"></a><a href="#l230">230</a><td> *<tr><td><a id="l231"></a><a href="#l231">231</a><td> * @param {number} port Which port adb is running on.<tr><td><a id="l232"></a><a href="#l232">232</a><td> * @return {!ServiceBuilder} A self reference.<tr><td><a id="l233"></a><a href="#l233">233</a><td> */<tr><td><a id="l234"></a><a href="#l234">234</a><td>ServiceBuilder.prototype.setAdbPort = function(port) {<tr><td><a id="l235"></a><a href="#l235">235</a><td> this.args_.push('--adb-port=' + port);<tr><td><a id="l236"></a><a href="#l236">236</a><td> return this;<tr><td><a id="l237"></a><a href="#l237">237</a><td>};<tr><td><a id="l238"></a><a href="#l238">238</a><td><tr><td><a id="l239"></a><a href="#l239">239</a><td><tr><td><a id="l240"></a><a href="#l240">240</a><td>/**<tr><td><a id="l241"></a><a href="#l241">241</a><td> * Sets the path of the log file the driver should log to. If a log file is<tr><td><a id="l242"></a><a href="#l242">242</a><td> * not specified, the driver will log to stderr.<tr><td><a id="l243"></a><a href="#l243">243</a><td> * @param {string} path Path of the log file to use.<tr><td><a id="l244"></a><a href="#l244">244</a><td> * @return {!ServiceBuilder} A self reference.<tr><td><a id="l245"></a><a href="#l245">245</a><td> */<tr><td><a id="l246"></a><a href="#l246">246</a><td>ServiceBuilder.prototype.loggingTo = function(path) {<tr><td><a id="l247"></a><a href="#l247">247</a><td> this.args_.push('--log-path=' + path);<tr><td><a id="l248"></a><a href="#l248">248</a><td> return this;<tr><td><a id="l249"></a><a href="#l249">249</a><td>};<tr><td><a id="l250"></a><a href="#l250">250</a><td><tr><td><a id="l251"></a><a href="#l251">251</a><td><tr><td><a id="l252"></a><a href="#l252">252</a><td>/**<tr><td><a id="l253"></a><a href="#l253">253</a><td> * Enables verbose logging.<tr><td><a id="l254"></a><a href="#l254">254</a><td> * @return {!ServiceBuilder} A self reference.<tr><td><a id="l255"></a><a href="#l255">255</a><td> */<tr><td><a id="l256"></a><a href="#l256">256</a><td>ServiceBuilder.prototype.enableVerboseLogging = function() {<tr><td><a id="l257"></a><a href="#l257">257</a><td> this.args_.push('--verbose');<tr><td><a id="l258"></a><a href="#l258">258</a><td> return this;<tr><td><a id="l259"></a><a href="#l259">259</a><td>};<tr><td><a id="l260"></a><a href="#l260">260</a><td><tr><td><a id="l261"></a><a href="#l261">261</a><td><tr><td><a id="l262"></a><a href="#l262">262</a><td>/**<tr><td><a id="l263"></a><a href="#l263">263</a><td> * Sets the number of threads the driver should use to manage HTTP requests.<tr><td><a id="l264"></a><a href="#l264">264</a><td> * By default, the driver will use 4 threads.<tr><td><a id="l265"></a><a href="#l265">265</a><td> * @param {number} n The number of threads to use.<tr><td><a id="l266"></a><a href="#l266">266</a><td> * @return {!ServiceBuilder} A self reference.<tr><td><a id="l267"></a><a href="#l267">267</a><td> */<tr><td><a id="l268"></a><a href="#l268">268</a><td>ServiceBuilder.prototype.setNumHttpThreads = function(n) {<tr><td><a id="l269"></a><a href="#l269">269</a><td> this.args_.push('--http-threads=' + n);<tr><td><a id="l270"></a><a href="#l270">270</a><td> return this;<tr><td><a id="l271"></a><a href="#l271">271</a><td>};<tr><td><a id="l272"></a><a href="#l272">272</a><td><tr><td><a id="l273"></a><a href="#l273">273</a><td><tr><td><a id="l274"></a><a href="#l274">274</a><td>/**<tr><td><a id="l275"></a><a href="#l275">275</a><td> * Sets the base path for WebDriver REST commands (e.g. "/wd/hub").<tr><td><a id="l276"></a><a href="#l276">276</a><td> * By default, the driver will accept commands relative to "/".<tr><td><a id="l277"></a><a href="#l277">277</a><td> * @param {string} path The base path to use.<tr><td><a id="l278"></a><a href="#l278">278</a><td> * @return {!ServiceBuilder} A self reference.<tr><td><a id="l279"></a><a href="#l279">279</a><td> */<tr><td><a id="l280"></a><a href="#l280">280</a><td>ServiceBuilder.prototype.setUrlBasePath = function(path) {<tr><td><a id="l281"></a><a href="#l281">281</a><td> this.args_.push('--url-base=' + path);<tr><td><a id="l282"></a><a href="#l282">282</a><td> this.path_ = path;<tr><td><a id="l283"></a><a href="#l283">283</a><td> return this;<tr><td><a id="l284"></a><a href="#l284">284</a><td>};<tr><td><a id="l285"></a><a href="#l285">285</a><td><tr><td><a id="l286"></a><a href="#l286">286</a><td><tr><td><a id="l287"></a><a href="#l287">287</a><td>/**<tr><td><a id="l288"></a><a href="#l288">288</a><td> * Defines the stdio configuration for the driver service. See<tr><td><a id="l289"></a><a href="#l289">289</a><td> * {@code child_process.spawn} for more information.<tr><td><a id="l290"></a><a href="#l290">290</a><td> * @param {(string|!Array.<string|number|!Stream|null|undefined>)} config The<tr><td><a id="l291"></a><a href="#l291">291</a><td> * configuration to use.<tr><td><a id="l292"></a><a href="#l292">292</a><td> * @return {!ServiceBuilder} A self reference.<tr><td><a id="l293"></a><a href="#l293">293</a><td> */<tr><td><a id="l294"></a><a href="#l294">294</a><td>ServiceBuilder.prototype.setStdio = function(config) {<tr><td><a id="l295"></a><a href="#l295">295</a><td> this.stdio_ = config;<tr><td><a id="l296"></a><a href="#l296">296</a><td> return this;<tr><td><a id="l297"></a><a href="#l297">297</a><td>};<tr><td><a id="l298"></a><a href="#l298">298</a><td><tr><td><a id="l299"></a><a href="#l299">299</a><td><tr><td><a id="l300"></a><a href="#l300">300</a><td>/**<tr><td><a id="l301"></a><a href="#l301">301</a><td> * Defines the environment to start the server under. This settings will be<tr><td><a id="l302"></a><a href="#l302">302</a><td> * inherited by every browser session started by the server.<tr><td><a id="l303"></a><a href="#l303">303</a><td> * @param {!Object.<string, string>} env The environment to use.<tr><td><a id="l304"></a><a href="#l304">304</a><td> * @return {!ServiceBuilder} A self reference.<tr><td><a id="l305"></a><a href="#l305">305</a><td> */<tr><td><a id="l306"></a><a href="#l306">306</a><td>ServiceBuilder.prototype.withEnvironment = function(env) {<tr><td><a id="l307"></a><a href="#l307">307</a><td> this.env_ = env;<tr><td><a id="l308"></a><a href="#l308">308</a><td> return this;<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><tr><td><a id="l312"></a><a href="#l312">312</a><td>/**<tr><td><a id="l313"></a><a href="#l313">313</a><td> * Creates a new DriverService using this instance's current configuration.<tr><td><a id="l314"></a><a href="#l314">314</a><td> * @return {remote.DriverService} A new driver service using this instance's<tr><td><a id="l315"></a><a href="#l315">315</a><td> * current configuration.<tr><td><a id="l316"></a><a href="#l316">316</a><td> * @throws {Error} If the driver exectuable was not specified and a default<tr><td><a id="l317"></a><a href="#l317">317</a><td> * could not be found on the current PATH.<tr><td><a id="l318"></a><a href="#l318">318</a><td> */<tr><td><a id="l319"></a><a href="#l319">319</a><td>ServiceBuilder.prototype.build = function() {<tr><td><a id="l320"></a><a href="#l320">320</a><td> var port = this.port_ || portprober.findFreePort();<tr><td><a id="l321"></a><a href="#l321">321</a><td> var args = this.args_.concat(); // Defensive copy.<tr><td><a id="l322"></a><a href="#l322">322</a><td><tr><td><a id="l323"></a><a href="#l323">323</a><td> return new remote.DriverService(this.exe_, {<tr><td><a id="l324"></a><a href="#l324">324</a><td> loopback: true,<tr><td><a id="l325"></a><a href="#l325">325</a><td> path: this.path_,<tr><td><a id="l326"></a><a href="#l326">326</a><td> port: port,<tr><td><a id="l327"></a><a href="#l327">327</a><td> args: webdriver.promise.when(port, function(port) {<tr><td><a id="l328"></a><a href="#l328">328</a><td> return args.concat('--port=' + port);<tr><td><a id="l329"></a><a href="#l329">329</a><td> }),<tr><td><a id="l330"></a><a href="#l330">330</a><td> env: this.env_,<tr><td><a id="l331"></a><a href="#l331">331</a><td> stdio: this.stdio_<tr><td><a id="l332"></a><a href="#l332">332</a><td> });<tr><td><a id="l333"></a><a href="#l333">333</a><td>};<tr><td><a id="l334"></a><a href="#l334">334</a><td><tr><td><a id="l335"></a><a href="#l335">335</a><td><tr><td><a id="l336"></a><a href="#l336">336</a><td>/** @type {remote.DriverService} */<tr><td><a id="l337"></a><a href="#l337">337</a><td>var defaultService = null;<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 the default service to use for new ChromeDriver instances.<tr><td><a id="l342"></a><a href="#l342">342</a><td> * @param {!remote.DriverService} service The service to use.<tr><td><a id="l343"></a><a href="#l343">343</a><td> * @throws {Error} If the default service is currently running.<tr><td><a id="l344"></a><a href="#l344">344</a><td> */<tr><td><a id="l345"></a><a href="#l345">345</a><td>function setDefaultService(service) {<tr><td><a id="l346"></a><a href="#l346">346</a><td> if (defaultService && defaultService.isRunning()) {<tr><td><a id="l347"></a><a href="#l347">347</a><td> throw Error(<tr><td><a id="l348"></a><a href="#l348">348</a><td> 'The previously configured ChromeDriver service is still running. ' +<tr><td><a id="l349"></a><a href="#l349">349</a><td> 'You must shut it down before you may adjust its configuration.');<tr><td><a id="l350"></a><a href="#l350">350</a><td> }<tr><td><a id="l351"></a><a href="#l351">351</a><td> defaultService = service;<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> * Returns the default ChromeDriver service. If such a service has not been<tr><td><a id="l357"></a><a href="#l357">357</a><td> * configured, one will be constructed using the default configuration for<tr><td><a id="l358"></a><a href="#l358">358</a><td> * a ChromeDriver executable found on the system PATH.<tr><td><a id="l359"></a><a href="#l359">359</a><td> * @return {!remote.DriverService} The default ChromeDriver service.<tr><td><a id="l360"></a><a href="#l360">360</a><td> */<tr><td><a id="l361"></a><a href="#l361">361</a><td>function getDefaultService() {<tr><td><a id="l362"></a><a href="#l362">362</a><td> if (!defaultService) {<tr><td><a id="l363"></a><a href="#l363">363</a><td> defaultService = new ServiceBuilder().build();<tr><td><a id="l364"></a><a href="#l364">364</a><td> }<tr><td><a id="l365"></a><a href="#l365">365</a><td> return defaultService;<tr><td><a id="l366"></a><a href="#l366">366</a><td>}<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> * @type {string}<tr><td><a id="l371"></a><a href="#l371">371</a><td> * @const<tr><td><a id="l372"></a><a href="#l372">372</a><td> */<tr><td><a id="l373"></a><a href="#l373">373</a><td>var OPTIONS_CAPABILITY_KEY = 'chromeOptions';<tr><td><a id="l374"></a><a href="#l374">374</a><td><tr><td><a id="l375"></a><a href="#l375">375</a><td><tr><td><a id="l376"></a><a href="#l376">376</a><td>/**<tr><td><a id="l377"></a><a href="#l377">377</a><td> * Class for managing ChromeDriver specific options.<tr><td><a id="l378"></a><a href="#l378">378</a><td> * @constructor<tr><td><a id="l379"></a><a href="#l379">379</a><td> * @extends {webdriver.Serializable}<tr><td><a id="l380"></a><a href="#l380">380</a><td> */<tr><td><a id="l381"></a><a href="#l381">381</a><td>var Options = function() {<tr><td><a id="l382"></a><a href="#l382">382</a><td> webdriver.Serializable.call(this);<tr><td><a id="l383"></a><a href="#l383">383</a><td><tr><td><a id="l384"></a><a href="#l384">384</a><td> /** @private {!Object} */<tr><td><a id="l385"></a><a href="#l385">385</a><td> this.options_ = {};<tr><td><a id="l386"></a><a href="#l386">386</a><td><tr><td><a id="l387"></a><a href="#l387">387</a><td> /** @private {!Array.<(string|!Buffer)>} */<tr><td><a id="l388"></a><a href="#l388">388</a><td> this.extensions_ = [];<tr><td><a id="l389"></a><a href="#l389">389</a><td><tr><td><a id="l390"></a><a href="#l390">390</a><td> /** @private {?webdriver.logging.Preferences} */<tr><td><a id="l391"></a><a href="#l391">391</a><td> this.logPrefs_ = null;<tr><td><a id="l392"></a><a href="#l392">392</a><td><tr><td><a id="l393"></a><a href="#l393">393</a><td> /** @private {?webdriver.ProxyConfig} */<tr><td><a id="l394"></a><a href="#l394">394</a><td> this.proxy_ = null;<tr><td><a id="l395"></a><a href="#l395">395</a><td>};<tr><td><a id="l396"></a><a href="#l396">396</a><td>util.inherits(Options, webdriver.Serializable);<tr><td><a id="l397"></a><a href="#l397">397</a><td><tr><td><a id="l398"></a><a href="#l398">398</a><td><tr><td><a id="l399"></a><a href="#l399">399</a><td>/**<tr><td><a id="l400"></a><a href="#l400">400</a><td> * Extracts the ChromeDriver specific options from the given capabilities<tr><td><a id="l401"></a><a href="#l401">401</a><td> * object.<tr><td><a id="l402"></a><a href="#l402">402</a><td> * @param {!webdriver.Capabilities} capabilities The capabilities object.<tr><td><a id="l403"></a><a href="#l403">403</a><td> * @return {!Options} The ChromeDriver options.<tr><td><a id="l404"></a><a href="#l404">404</a><td> */<tr><td><a id="l405"></a><a href="#l405">405</a><td>Options.fromCapabilities = function(capabilities) {<tr><td><a id="l406"></a><a href="#l406">406</a><td> var options = new Options();<tr><td><a id="l407"></a><a href="#l407">407</a><td><tr><td><a id="l408"></a><a href="#l408">408</a><td> var o = capabilities.get(OPTIONS_CAPABILITY_KEY);<tr><td><a id="l409"></a><a href="#l409">409</a><td> if (o instanceof Options) {<tr><td><a id="l410"></a><a href="#l410">410</a><td> options = o;<tr><td><a id="l411"></a><a href="#l411">411</a><td> } else if (o) {<tr><td><a id="l412"></a><a href="#l412">412</a><td> options.<tr><td><a id="l413"></a><a href="#l413">413</a><td> addArguments(o.args || []).<tr><td><a id="l414"></a><a href="#l414">414</a><td> addExtensions(o.extensions || []).<tr><td><a id="l415"></a><a href="#l415">415</a><td> detachDriver(o.detach).<tr><td><a id="l416"></a><a href="#l416">416</a><td> excludeSwitches(o.excludeSwitches || []).<tr><td><a id="l417"></a><a href="#l417">417</a><td> setChromeBinaryPath(o.binary).<tr><td><a id="l418"></a><a href="#l418">418</a><td> setChromeLogFile(o.logPath).<tr><td><a id="l419"></a><a href="#l419">419</a><td> setChromeMinidumpPath(o.minidumpPath).<tr><td><a id="l420"></a><a href="#l420">420</a><td> setLocalState(o.localState).<tr><td><a id="l421"></a><a href="#l421">421</a><td> setMobileEmulation(o.mobileEmulation).<tr><td><a id="l422"></a><a href="#l422">422</a><td> setUserPreferences(o.prefs).<tr><td><a id="l423"></a><a href="#l423">423</a><td> setPerfLoggingPrefs(o.perfLoggingPrefs);<tr><td><a id="l424"></a><a href="#l424">424</a><td> }<tr><td><a id="l425"></a><a href="#l425">425</a><td><tr><td><a id="l426"></a><a href="#l426">426</a><td> if (capabilities.has(webdriver.Capability.PROXY)) {<tr><td><a id="l427"></a><a href="#l427">427</a><td> options.setProxy(capabilities.get(webdriver.Capability.PROXY));<tr><td><a id="l428"></a><a href="#l428">428</a><td> }<tr><td><a id="l429"></a><a href="#l429">429</a><td><tr><td><a id="l430"></a><a href="#l430">430</a><td> if (capabilities.has(webdriver.Capability.LOGGING_PREFS)) {<tr><td><a id="l431"></a><a href="#l431">431</a><td> options.setLoggingPrefs(<tr><td><a id="l432"></a><a href="#l432">432</a><td> capabilities.get(webdriver.Capability.LOGGING_PREFS));<tr><td><a id="l433"></a><a href="#l433">433</a><td> }<tr><td><a id="l434"></a><a href="#l434">434</a><td><tr><td><a id="l435"></a><a href="#l435">435</a><td> return options;<tr><td><a id="l436"></a><a href="#l436">436</a><td>};<tr><td><a id="l437"></a><a href="#l437">437</a><td><tr><td><a id="l438"></a><a href="#l438">438</a><td><tr><td><a id="l439"></a><a href="#l439">439</a><td>/**<tr><td><a id="l440"></a><a href="#l440">440</a><td> * Add additional command line arguments to use when launching the Chrome<tr><td><a id="l441"></a><a href="#l441">441</a><td> * browser. Each argument may be specified with or without the "--" prefix<tr><td><a id="l442"></a><a href="#l442">442</a><td> * (e.g. "--foo" and "foo"). Arguments with an associated value should be<tr><td><a id="l443"></a><a href="#l443">443</a><td> * delimited by an "=": "foo=bar".<tr><td><a id="l444"></a><a href="#l444">444</a><td> * @param {...(string|!Array.<string>)} var_args The arguments to add.<tr><td><a id="l445"></a><a href="#l445">445</a><td> * @return {!Options} A self reference.<tr><td><a id="l446"></a><a href="#l446">446</a><td> */<tr><td><a id="l447"></a><a href="#l447">447</a><td>Options.prototype.addArguments = function(var_args) {<tr><td><a id="l448"></a><a href="#l448">448</a><td> var args = this.options_.args || [];<tr><td><a id="l449"></a><a href="#l449">449</a><td> args = args.concat.apply(args, arguments);<tr><td><a id="l450"></a><a href="#l450">450</a><td> if (args.length) {<tr><td><a id="l451"></a><a href="#l451">451</a><td> this.options_.args = args;<tr><td><a id="l452"></a><a href="#l452">452</a><td> }<tr><td><a id="l453"></a><a href="#l453">453</a><td> return this;<tr><td><a id="l454"></a><a href="#l454">454</a><td>};<tr><td><a id="l455"></a><a href="#l455">455</a><td><tr><td><a id="l456"></a><a href="#l456">456</a><td><tr><td><a id="l457"></a><a href="#l457">457</a><td>/**<tr><td><a id="l458"></a><a href="#l458">458</a><td> * List of Chrome command line switches to exclude that ChromeDriver by default<tr><td><a id="l459"></a><a href="#l459">459</a><td> * passes when starting Chrome. Do not prefix switches with "--".<tr><td><a id="l460"></a><a href="#l460">460</a><td> *<tr><td><a id="l461"></a><a href="#l461">461</a><td> * @param {...(string|!Array<string>)} var_args The switches to exclude.<tr><td><a id="l462"></a><a href="#l462">462</a><td> * @return {!Options} A self reference.<tr><td><a id="l463"></a><a href="#l463">463</a><td> */<tr><td><a id="l464"></a><a href="#l464">464</a><td>Options.prototype.excludeSwitches = function(var_args) {<tr><td><a id="l465"></a><a href="#l465">465</a><td> var switches = this.options_.excludeSwitches || [];<tr><td><a id="l466"></a><a href="#l466">466</a><td> switches = switches.concat.apply(switches, arguments);<tr><td><a id="l467"></a><a href="#l467">467</a><td> if (switches.length) {<tr><td><a id="l468"></a><a href="#l468">468</a><td> this.options_.excludeSwitches = switches;<tr><td><a id="l469"></a><a href="#l469">469</a><td> }<tr><td><a id="l470"></a><a href="#l470">470</a><td> return this;<tr><td><a id="l471"></a><a href="#l471">471</a><td>};<tr><td><a id="l472"></a><a href="#l472">472</a><td><tr><td><a id="l473"></a><a href="#l473">473</a><td><tr><td><a id="l474"></a><a href="#l474">474</a><td>/**<tr><td><a id="l475"></a><a href="#l475">475</a><td> * Add additional extensions to install when launching Chrome. Each extension<tr><td><a id="l476"></a><a href="#l476">476</a><td> * should be specified as the path to the packed CRX file, or a Buffer for an<tr><td><a id="l477"></a><a href="#l477">477</a><td> * extension.<tr><td><a id="l478"></a><a href="#l478">478</a><td> * @param {...(string|!Buffer|!Array.<(string|!Buffer)>)} var_args The<tr><td><a id="l479"></a><a href="#l479">479</a><td> * extensions to add.<tr><td><a id="l480"></a><a href="#l480">480</a><td> * @return {!Options} A self reference.<tr><td><a id="l481"></a><a href="#l481">481</a><td> */<tr><td><a id="l482"></a><a href="#l482">482</a><td>Options.prototype.addExtensions = function(var_args) {<tr><td><a id="l483"></a><a href="#l483">483</a><td> this.extensions_ = this.extensions_.concat.apply(this.extensions_, arguments);<tr><td><a id="l484"></a><a href="#l484">484</a><td> return this;<tr><td><a id="l485"></a><a href="#l485">485</a><td>};<tr><td><a id="l486"></a><a href="#l486">486</a><td><tr><td><a id="l487"></a><a href="#l487">487</a><td><tr><td><a id="l488"></a><a href="#l488">488</a><td>/**<tr><td><a id="l489"></a><a href="#l489">489</a><td> * Sets the path to the Chrome binary to use. On Mac OS X, this path should<tr><td><a id="l490"></a><a href="#l490">490</a><td> * reference the actual Chrome executable, not just the application binary<tr><td><a id="l491"></a><a href="#l491">491</a><td> * (e.g. "/Applications/Google Chrome.app/Contents/MacOS/Google Chrome").<tr><td><a id="l492"></a><a href="#l492">492</a><td> *<tr><td><a id="l493"></a><a href="#l493">493</a><td> * The binary path be absolute or relative to the chromedriver server<tr><td><a id="l494"></a><a href="#l494">494</a><td> * executable, but it must exist on the machine that will launch Chrome.<tr><td><a id="l495"></a><a href="#l495">495</a><td> *<tr><td><a id="l496"></a><a href="#l496">496</a><td> * @param {string} path The path to the Chrome binary to use.<tr><td><a id="l497"></a><a href="#l497">497</a><td> * @return {!Options} A self reference.<tr><td><a id="l498"></a><a href="#l498">498</a><td> */<tr><td><a id="l499"></a><a href="#l499">499</a><td>Options.prototype.setChromeBinaryPath = function(path) {<tr><td><a id="l500"></a><a href="#l500">500</a><td> this.options_.binary = path;<tr><td><a id="l501"></a><a href="#l501">501</a><td> return this;<tr><td><a id="l502"></a><a href="#l502">502</a><td>};<tr><td><a id="l503"></a><a href="#l503">503</a><td><tr><td><a id="l504"></a><a href="#l504">504</a><td><tr><td><a id="l505"></a><a href="#l505">505</a><td>/**<tr><td><a id="l506"></a><a href="#l506">506</a><td> * Sets whether to leave the started Chrome browser running if the controlling<tr><td><a id="l507"></a><a href="#l507">507</a><td> * ChromeDriver service is killed before {@link webdriver.WebDriver#quit()} is<tr><td><a id="l508"></a><a href="#l508">508</a><td> * called.<tr><td><a id="l509"></a><a href="#l509">509</a><td> * @param {boolean} detach Whether to leave the browser running if the<tr><td><a id="l510"></a><a href="#l510">510</a><td> * chromedriver service is killed before the session.<tr><td><a id="l511"></a><a href="#l511">511</a><td> * @return {!Options} A self reference.<tr><td><a id="l512"></a><a href="#l512">512</a><td> */<tr><td><a id="l513"></a><a href="#l513">513</a><td>Options.prototype.detachDriver = function(detach) {<tr><td><a id="l514"></a><a href="#l514">514</a><td> this.options_.detach = detach;<tr><td><a id="l515"></a><a href="#l515">515</a><td> return this;<tr><td><a id="l516"></a><a href="#l516">516</a><td>};<tr><td><a id="l517"></a><a href="#l517">517</a><td><tr><td><a id="l518"></a><a href="#l518">518</a><td><tr><td><a id="l519"></a><a href="#l519">519</a><td>/**<tr><td><a id="l520"></a><a href="#l520">520</a><td> * Sets the user preferences for Chrome's user profile. See the "Preferences"<tr><td><a id="l521"></a><a href="#l521">521</a><td> * file in Chrome's user data directory for examples.<tr><td><a id="l522"></a><a href="#l522">522</a><td> * @param {!Object} prefs Dictionary of user preferences to use.<tr><td><a id="l523"></a><a href="#l523">523</a><td> * @return {!Options} A self reference.<tr><td><a id="l524"></a><a href="#l524">524</a><td> */<tr><td><a id="l525"></a><a href="#l525">525</a><td>Options.prototype.setUserPreferences = function(prefs) {<tr><td><a id="l526"></a><a href="#l526">526</a><td> this.options_.prefs = prefs;<tr><td><a id="l527"></a><a href="#l527">527</a><td> return this;<tr><td><a id="l528"></a><a href="#l528">528</a><td>};<tr><td><a id="l529"></a><a href="#l529">529</a><td><tr><td><a id="l530"></a><a href="#l530">530</a><td><tr><td><a id="l531"></a><a href="#l531">531</a><td>/**<tr><td><a id="l532"></a><a href="#l532">532</a><td> * Sets the logging preferences for the new session.<tr><td><a id="l533"></a><a href="#l533">533</a><td> * @param {!webdriver.logging.Preferences} prefs The logging preferences.<tr><td><a id="l534"></a><a href="#l534">534</a><td> * @return {!Options} A self reference.<tr><td><a id="l535"></a><a href="#l535">535</a><td> */<tr><td><a id="l536"></a><a href="#l536">536</a><td>Options.prototype.setLoggingPrefs = function(prefs) {<tr><td><a id="l537"></a><a href="#l537">537</a><td> this.logPrefs_ = prefs;<tr><td><a id="l538"></a><a href="#l538">538</a><td> return this;<tr><td><a id="l539"></a><a href="#l539">539</a><td>};<tr><td><a id="l540"></a><a href="#l540">540</a><td><tr><td><a id="l541"></a><a href="#l541">541</a><td><tr><td><a id="l542"></a><a href="#l542">542</a><td>/**<tr><td><a id="l543"></a><a href="#l543">543</a><td> * Sets the performance logging preferences. Options include:<tr><td><a id="l544"></a><a href="#l544">544</a><td> *<tr><td><a id="l545"></a><a href="#l545">545</a><td> * - `enableNetwork`: Whether or not to collect events from Network domain.<tr><td><a id="l546"></a><a href="#l546">546</a><td> * - `enablePage`: Whether or not to collect events from Page domain.<tr><td><a id="l547"></a><a href="#l547">547</a><td> * - `enableTimeline`: Whether or not to collect events from Timeline domain.<tr><td><a id="l548"></a><a href="#l548">548</a><td> * Note: when tracing is enabled, Timeline domain is implicitly disabled,<tr><td><a id="l549"></a><a href="#l549">549</a><td> * unless `enableTimeline` is explicitly set to true.<tr><td><a id="l550"></a><a href="#l550">550</a><td> * - `tracingCategories`: A comma-separated string of Chrome tracing categories<tr><td><a id="l551"></a><a href="#l551">551</a><td> * for which trace events should be collected. An unspecified or empty<tr><td><a id="l552"></a><a href="#l552">552</a><td> * string disables tracing.<tr><td><a id="l553"></a><a href="#l553">553</a><td> * - `bufferUsageReportingInterval`: The requested number of milliseconds<tr><td><a id="l554"></a><a href="#l554">554</a><td> * between DevTools trace buffer usage events. For example, if 1000, then<tr><td><a id="l555"></a><a href="#l555">555</a><td> * once per second, DevTools will report how full the trace buffer is. If a<tr><td><a id="l556"></a><a href="#l556">556</a><td> * report indicates the buffer usage is 100%, a warning will be issued.<tr><td><a id="l557"></a><a href="#l557">557</a><td> *<tr><td><a id="l558"></a><a href="#l558">558</a><td> * @param {{enableNetwork: boolean,<tr><td><a id="l559"></a><a href="#l559">559</a><td> * enablePage: boolean,<tr><td><a id="l560"></a><a href="#l560">560</a><td> * enableTimeline: boolean,<tr><td><a id="l561"></a><a href="#l561">561</a><td> * tracingCategories: string,<tr><td><a id="l562"></a><a href="#l562">562</a><td> * bufferUsageReportingInterval: number}} prefs The performance<tr><td><a id="l563"></a><a href="#l563">563</a><td> * logging preferences.<tr><td><a id="l564"></a><a href="#l564">564</a><td> * @return {!Options} A self reference.<tr><td><a id="l565"></a><a href="#l565">565</a><td> */<tr><td><a id="l566"></a><a href="#l566">566</a><td>Options.prototype.setPerfLoggingPrefs = function(prefs) {<tr><td><a id="l567"></a><a href="#l567">567</a><td> this.options_.perfLoggingPrefs = prefs;<tr><td><a id="l568"></a><a href="#l568">568</a><td> return this;<tr><td><a id="l569"></a><a href="#l569">569</a><td>};<tr><td><a id="l570"></a><a href="#l570">570</a><td><tr><td><a id="l571"></a><a href="#l571">571</a><td><tr><td><a id="l572"></a><a href="#l572">572</a><td>/**<tr><td><a id="l573"></a><a href="#l573">573</a><td> * Sets preferences for the "Local State" file in Chrome's user data<tr><td><a id="l574"></a><a href="#l574">574</a><td> * directory.<tr><td><a id="l575"></a><a href="#l575">575</a><td> * @param {!Object} state Dictionary of local state preferences.<tr><td><a id="l576"></a><a href="#l576">576</a><td> * @return {!Options} A self reference.<tr><td><a id="l577"></a><a href="#l577">577</a><td> */<tr><td><a id="l578"></a><a href="#l578">578</a><td>Options.prototype.setLocalState = function(state) {<tr><td><a id="l579"></a><a href="#l579">579</a><td> this.options_.localState = state;<tr><td><a id="l580"></a><a href="#l580">580</a><td> return this;<tr><td><a id="l581"></a><a href="#l581">581</a><td>};<tr><td><a id="l582"></a><a href="#l582">582</a><td><tr><td><a id="l583"></a><a href="#l583">583</a><td><tr><td><a id="l584"></a><a href="#l584">584</a><td>/**<tr><td><a id="l585"></a><a href="#l585">585</a><td> * Sets the name of the activity hosting a Chrome-based Android WebView. This<tr><td><a id="l586"></a><a href="#l586">586</a><td> * option must be set to connect to an [Android WebView](<tr><td><a id="l587"></a><a href="#l587">587</a><td> * https://sites.google.com/a/chromium.org/chromedriver/getting-started/getting-started---android)<tr><td><a id="l588"></a><a href="#l588">588</a><td> *<tr><td><a id="l589"></a><a href="#l589">589</a><td> * @param {string} name The activity name.<tr><td><a id="l590"></a><a href="#l590">590</a><td> * @return {!Options} A self reference.<tr><td><a id="l591"></a><