--- /dev/null
+<!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>selenium-webdriver/chrome</title><link href="dossier.css" rel="stylesheet" type="text/css"><header><div><form><div><input type="search" placeholder="Search"></div></form></div></header><main><article><div class="codelink"><a href="source/chrome.js.src.html#l113">View Source</a></div><h1>module selenium-webdriver/chrome</h1><p>Defines a <a href="module_selenium-webdriver_chrome_class_Driver.html">WebDriver</a> client for the Chrome web browser. Before using this module, you must download the latest <a href="http://chromedriver.storage.googleapis.com/index.html">ChromeDriver release</a> and ensure it can be found on your system <a href="http://en.wikipedia.org/wiki/PATH_%28variable%29">PATH</a>.</p><p>There are three primary classes exported by this module:</p>
+<ol><li><p><a href="module_selenium-webdriver_chrome_class_ServiceBuilder.html">ServiceBuilder</a>: configures the <a href="module_selenium-webdriver_remote_class_DriverService.html"><code>remote.DriverService</code></a> that manages the <a href="https://sites.google.com/a/chromium.org/chromedriver/">ChromeDriver</a> child process.</p></li><li><p><a href="module_selenium-webdriver_chrome_class_Options.html">Options</a>: defines configuration options for each new Chrome session, such as which <a href="module_selenium-webdriver_chrome_class_Options.html#setProxy">proxy</a> to use, what <a href="module_selenium-webdriver_chrome_class_Options.html#addExtensions">extensions</a> to install, or what <a href="module_selenium-webdriver_chrome_class_Options.html#addArguments">command-line switches</a> to use when starting the browser.</p></li><li><p><a href="module_selenium-webdriver_chrome_class_Driver.html">Driver</a>: the WebDriver client; each new instance will control a unique browser session with a clean user profile (unless otherwise configured through the <a href="module_selenium-webdriver_chrome_class_Options.html"><code>Options</code></a> class).</p></li></ol><p><strong>Customizing the ChromeDriver Server</strong> <a id="custom-server"></a></p><p>By default, every Chrome session will use a single driver service, which is started the first time a <a href="module_selenium-webdriver_chrome_class_Driver.html"><code>Driver</code></a> instance is created and terminated when this process exits. The default service will inherit its environment from the current process and direct all output to /dev/null. You may obtain a handle to this default service using <a href="module_selenium-webdriver_chrome.html#getDefaultService"><code>getDefaultService()</code></a> and change its configuration with <a href="module_selenium-webdriver_chrome.html#setDefaultService"><code>setDefaultService()</code></a>.</p><p>You may also create a <a href="module_selenium-webdriver_chrome_class_Driver.html"><code>Driver</code></a> with its own driver service. This is useful if you need to capture the server's log output for a specific session:</p>
+<pre><code>var chrome = require('selenium-webdriver/chrome');
+
+var service = new chrome.ServiceBuilder()
+ .loggingTo('/my/log/file.txt')
+ .enableVerboseLogging()
+ .build();
+
+var options = new chrome.Options();
+// configure browser options ...
+
+var driver = new chrome.Driver(options, service);
+</code></pre><p>Users should only instantiate the <a href="module_selenium-webdriver_chrome_class_Driver.html"><code>Driver</code></a> class directly when they need a custom driver service configuration (as shown above). For normal operation, users should start Chrome using the <a href="module_selenium-webdriver_class_Builder.html"><code>selenium-webdriver.Builder</code></a>.</p><p><strong>Working with Android</strong> <a id="android"></a></p><p>The <a href="https://sites.google.com/a/chromium.org/chromedriver/getting-started/getting-started---android">ChromeDriver</a> supports running tests on the Chrome browser as well as <a href="https://developer.chrome.com/multidevice/webview/overview">WebView apps</a> starting in Android 4.4 (KitKat). In order to work with Android, you must first start the adb</p>
+<pre><code>adb start-server
+</code></pre><p>By default, adb will start on port 5037. You may change this port, but this will require configuring a <a href="#custom-server">custom server</a> that will connect to adb on the <a href="module_selenium-webdriver_chrome_class_ServiceBuilder.html#setAdbPort">correct port</a>:</p>
+<pre><code>var service = new chrome.ServiceBuilder()
+ .setAdbPort(1234)
+ build();
+// etc.
+</code></pre><p>The ChromeDriver may be configured to launch Chrome on Android using <a href="module_selenium-webdriver_chrome_class_Options.html#androidChrome"><code>Options#androidChrome()</code></a>:</p>
+<pre><code>var driver = new Builder()
+ .forBrowser('chrome')
+ .setChromeOptions(new chrome.Options().androidChrome())
+ .build();
+</code></pre><p>Alternatively, you can configure the ChromeDriver to launch an app with a Chrome-WebView by setting the <a href="module_selenium-webdriver_chrome_class_Options.html#androidActivity">androidActivity</a> option:</p>
+<pre><code>var driver = new Builder()
+ .forBrowser('chrome')
+ .setChromeOptions(new chrome.Options()
+ .androidPackage('com.example')
+ .androidActivity('com.example.Activity'))
+ .build();
+</code></pre><p>Refer to the ChromeDriver site] for more information on using the <a href="https://sites.google.com/a/chromium.org/chromedriver/getting-started/getting-started---android">ChromeDriver with Android</a>.</p><h2>Functions</h2><div id="createDriver" class="function"><div><h3>createDriver(<wbr>opt_options, opt_service, opt_flow)<span class="codelink"><a href="source/chrome.js.src.html#l815">code »</a></span></h3><div class="tags"><span>deprecated</span></div><p>Creates a new ChromeDriver session.</p><p><b>Deprecated: </b>Use <a href="module_selenium-webdriver_chrome_class_Driver.html"><code>new Driver()</code></a>.</p><div><div class="fn-details"><div><b>Parameters</b></div><dl><dt>opt_options<code>?(<a href="module_selenium-webdriver_class_Capabilities.html">Capabilities</a>|<a href="module_selenium-webdriver_chrome_class_Options.html">Options</a>)=</code><dd><p>The session options.</p><dt>opt_service<code>?<a href="module_selenium-webdriver_remote_class_DriverService.html">DriverService</a>=</code><dd><p>The session to use; will use the <a href="module_selenium-webdriver_chrome.html#getDefaultService">default service</a> by default.</p><dt>opt_flow<code>?<a href="class_webdriver_promise_ControlFlow.html">webdriver.promise.ControlFlow</a>=</code><dd><p>The control flow to use, or <code>null</code> to use the currently active flow.</p></dl></div><div class="fn-details"><div><b>Returns</b></div><dl><dt><code><a href="class_webdriver_WebDriver.html">webdriver.WebDriver</a></code><dd><p>A new WebDriver instance.</p></dl></div></div></div></div><hr class="fn-sep"><div id="getDefaultService" class="function"><div><h3>getDefaultService()<span class="codelink"><a href="source/chrome.js.src.html#l816">code »</a></span></h3><p>Returns the default ChromeDriver service. If such a service has not been configured, one will be constructed using the default configuration for a ChromeDriver executable found on the system PATH.</p><div><div class="fn-details"><div><b>Returns</b></div><dl><dt><code><a href="module_selenium-webdriver_remote_class_DriverService.html">DriverService</a></code><dd><p>The default ChromeDriver service.</p></dl></div></div></div></div><hr class="fn-sep"><div id="setDefaultService" class="function"><div><h3>setDefaultService(<wbr>service)<span class="codelink"><a href="source/chrome.js.src.html#l817">code »</a></span></h3><p>Sets the default service to use for new ChromeDriver instances.</p><div><div class="fn-details"><div><b>Parameters</b></div><dl><dt>service<code><a href="module_selenium-webdriver_remote_class_DriverService.html">DriverService</a></code><dd><p>The service to use.</p></dl></div><div class="fn-details"><div><b>Throws</b></div><dl><dt><code><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Error">Error</a></code><dd><p>If the default service is currently running.</p></dl></div></div></div></div><h2>Types</h2><dl><dt><a href="module_selenium-webdriver_chrome_class_Driver.html">Driver</a><dd><p>Creates a new WebDriver client for Chrome.</p><dt><a href="module_selenium-webdriver_chrome_class_Options.html">Options</a><dd><p>Class for managing ChromeDriver specific options.</p><dt><a href="module_selenium-webdriver_chrome_class_ServiceBuilder.html">ServiceBuilder</a><dd><p>Creates <a href="module_selenium-webdriver_remote_class_DriverService.html"><code>selenium-webdriver/remote.DriverService</code></a> instances that manage a <a href="https://sites.google.com/a/chromium.org/chromedriver/">ChromeDriver</a> server in a child process.</p></dl></article><nav><h3><a href="index.html">Overview</a></h3><div><input type="checkbox" id="nav-modules" checked/><label for="nav-modules"><h3>Modules</h3></label><div><ul><li><a href="module_selenium-webdriver.html">selenium-webdriver</a><li><a href="module_selenium-webdriver__base.html">selenium-webdriver/_base</a><li><a href="module_selenium-webdriver_builder.html">selenium-webdriver/builder</a><li><a href="module_selenium-webdriver_chrome.html">selenium-webdriver/chrome</a><li><a href="module_selenium-webdriver_error.html">selenium-webdriver/error</a><li><a href="module_selenium-webdriver_executors.html">selenium-webdriver/executors</a><li><a href="module_selenium-webdriver_firefox.html">selenium-webdriver/firefox</a><li><a href="module_selenium-webdriver_firefox_binary.html">selenium-webdriver/firefox/binary</a><li><a href="module_selenium-webdriver_firefox_extension.html">selenium-webdriver/firefox/extension</a><li><a href="module_selenium-webdriver_firefox_profile.html">selenium-webdriver/firefox/profile</a><li><a href="module_selenium-webdriver_http.html">selenium-webdriver/http</a><li><a href="module_selenium-webdriver_http_util.html">selenium-webdriver/http/util</a><li><a href="module_selenium-webdriver_ie.html">selenium-webdriver/ie</a><li><a href="module_selenium-webdriver_io.html">selenium-webdriver/io</a><li><a href="module_selenium-webdriver_io_exec.html">selenium-webdriver/io/exec</a><li><a href="module_selenium-webdriver_net.html">selenium-webdriver/net</a><li><a href="module_selenium-webdriver_net_portprober.html">selenium-webdriver/net/portprober</a><li><a href="module_selenium-webdriver_opera.html">selenium-webdriver/opera</a><li><a href="module_selenium-webdriver_phantomjs.html">selenium-webdriver/phantomjs</a><li><a href="module_selenium-webdriver_proxy.html">selenium-webdriver/proxy</a><li><a href="module_selenium-webdriver_remote.html">selenium-webdriver/remote</a><li><a href="module_selenium-webdriver_safari.html">selenium-webdriver/safari</a><li><a href="module_selenium-webdriver_testing.html">selenium-webdriver/testing</a><li><a href="module_selenium-webdriver_testing_assert.html">selenium-webdriver/testing/assert</a></ul></div></div><div><input type="checkbox" id="nav-types" checked/><label for="nav-types"><h3>Types</h3></label><div><ul><li><a href="namespace_bot.html">bot</a><li><a href="class_bot_Error.html">bot.Error</a><li><a href="enum_bot_Error_State.html">bot.Error.State</a><li><a href="enum_bot_ErrorCode.html">bot.ErrorCode</a><li><a href="namespace_bot_json.html">bot.json</a><li><a href="namespace_bot_response.html">bot.response</a><li><a href="namespace_bot_userAgent.html">bot.userAgent</a><li><a href="namespace_webdriver.html">webdriver</a><li><a href="class_webdriver_ActionSequence.html">webdriver.ActionSequence</a><li><a href="class_webdriver_Alert.html">webdriver.Alert</a><li><a href="class_webdriver_AlertPromise.html">webdriver.AlertPromise</a><li><a href="enum_webdriver_Browser.html">webdriver.Browser</a><li><a href="enum_webdriver_Button.html">webdriver.Button</a><li><a href="namespace_webdriver_By.html">webdriver.By</a><li><a href="class_webdriver_Capabilities.html">webdriver.Capabilities</a><li><a href="enum_webdriver_Capability.html">webdriver.Capability</a><li><a href="class_webdriver_Command.html">webdriver.Command</a><li><a href="interface_webdriver_CommandExecutor.html">webdriver.CommandExecutor</a><li><a href="enum_webdriver_CommandName.html">webdriver.CommandName</a><li><a href="class_webdriver_EventEmitter.html">webdriver.EventEmitter</a><li><a href="class_webdriver_FileDetector.html">webdriver.FileDetector</a><li><a href="enum_webdriver_Key.html">webdriver.Key</a><li><a href="class_webdriver_Locator.html">webdriver.Locator</a><li><a href="class_webdriver_Serializable.html">webdriver.Serializable</a><li><a href="class_webdriver_Session.html">webdriver.Session</a><li><a href="class_webdriver_TouchSequence.html">webdriver.TouchSequence</a><li><a href="class_webdriver_UnhandledAlertError.html">webdriver.UnhandledAlertError</a><li><a href="class_webdriver_WebDriver.html">webdriver.WebDriver</a><li><a href="class_webdriver_WebDriver_Logs.html">webdriver.WebDriver.Logs</a><li><a href="class_webdriver_WebDriver_Navigation.html">webdriver.WebDriver.Navigation</a><li><a href="class_webdriver_WebDriver_Options.html">webdriver.WebDriver.Options</a><li><a href="class_webdriver_WebDriver_TargetLocator.html">webdriver.WebDriver.TargetLocator</a><li><a href="class_webdriver_WebDriver_Timeouts.html">webdriver.WebDriver.Timeouts</a><li><a href="class_webdriver_WebDriver_Window.html">webdriver.WebDriver.Window</a><li><a href="class_webdriver_WebElement.html">webdriver.WebElement</a><li><a href="class_webdriver_WebElementPromise.html">webdriver.WebElementPromise</a><li><a href="namespace_webdriver_http.html">webdriver.http</a><li><a href="interface_webdriver_http_Client.html">webdriver.http.Client</a><li><a href="class_webdriver_http_Executor.html">webdriver.http.Executor</a><li><a href="class_webdriver_http_Request.html">webdriver.http.Request</a><li><a href="class_webdriver_http_Response.html">webdriver.http.Response</a><li><a href="namespace_webdriver_logging.html">webdriver.logging</a><li><a href="class_webdriver_logging_Entry.html">webdriver.logging.Entry</a><li><a href="enum_webdriver_logging_Level.html">webdriver.logging.Level</a><li><a href="class_webdriver_logging_Preferences.html">webdriver.logging.Preferences</a><li><a href="enum_webdriver_logging_Type.html">webdriver.logging.Type</a><li><a href="namespace_webdriver_promise.html">webdriver.promise</a><li><a href="class_webdriver_promise_Callback_.html">webdriver.promise.Callback_</a><li><a href="class_webdriver_promise_CancellationError.html">webdriver.promise.CancellationError</a><li><a href="class_webdriver_promise_ControlFlow.html">webdriver.promise.ControlFlow</a><li><a href="enum_webdriver_promise_ControlFlow_EventType.html">webdriver.promise.ControlFlow.EventType</a><li><a href="class_webdriver_promise_Deferred.html">webdriver.promise.Deferred</a><li><a href="class_webdriver_promise_Frame_.html">webdriver.promise.Frame_</a><li><a href="class_webdriver_promise_MicroTask_.html">webdriver.promise.MicroTask_</a><li><a href="class_webdriver_promise_Promise.html">webdriver.promise.Promise</a><li><a href="enum_webdriver_promise_Promise_State_.html">webdriver.promise.Promise.State_</a><li><a href="class_webdriver_promise_Task_.html">webdriver.promise.Task_</a><li><a href="interface_webdriver_promise_Thenable.html">webdriver.promise.Thenable</a><li><a href="namespace_webdriver_stacktrace.html">webdriver.stacktrace</a><li><a href="class_webdriver_stacktrace_Frame.html">webdriver.stacktrace.Frame</a><li><a href="class_webdriver_stacktrace_Snapshot.html">webdriver.stacktrace.Snapshot</a><li><a href="namespace_webdriver_testing.html">webdriver.testing</a><li><a href="class_webdriver_testing_Assertion.html">webdriver.testing.Assertion</a><li><a href="class_webdriver_testing_Assertion_DelegatingMatcher_.html">webdriver.testing.Assertion.DelegatingMatcher_</a><li><a href="class_webdriver_testing_ContainsMatcher.html">webdriver.testing.ContainsMatcher</a><li><a href="class_webdriver_testing_NegatedAssertion.html">webdriver.testing.NegatedAssertion</a><li><a href="namespace_webdriver_testing_assert.html">webdriver.testing.assert</a><li><a href="namespace_webdriver_testing_asserts.html">webdriver.testing.asserts</a><li><a href="namespace_webdriver_until.html">webdriver.until</a><li><a href="class_webdriver_until_Condition.html">webdriver.until.Condition</a></ul></div></div><h3><a href="Changes.html">Changes</a></h3></nav></main><div class="pre-footer"><div></div></div><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>
\ No newline at end of file