selenium-webdriver

Version:

The official WebDriver JavaScript bindings from the Selenium project

code.google.com/p/selenium/

4 lines • 17.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>By</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/index.js.src.html#l40">View Source</a></div><h1>namespace By</h1><dl><dt>Alias for <code><a href="namespace_webdriver_By.html">webdriver.By</a></code></dl><p>A collection of factory functions for creating <a href="class_webdriver_Locator.html"><code>webdriver.Locator</code></a> instances.</p><h2>Functions</h2><div id="className" class="function"><div><h3>className(<wbr>className)<span class="codelink"><a href="source/lib/webdriver/locators.js.src.html#l107">code »</a></span></h3><p>Locates elements that have a specific class name. The returned locator is equivalent to searching for elements with the CSS selector ".clazz".</p><div><div class="fn-details"><div><b>Parameters</b></div><dl><dt>className<code><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String">string</a></code><dd><p>The class name to search for.</p></dl></div><div class="fn-details"><div><b>Returns</b></div><dl><dt><code><a href="class_webdriver_Locator.html">webdriver.Locator</a></code><dd><p>The new locator.</p></dl></div></div></div></div><hr class="fn-sep"><div id="css" class="function"><div><h3>css(<wbr>selector)<span class="codelink"><a href="source/lib/webdriver/locators.js.src.html#l120">code »</a></span></h3><p>Locates elements using a CSS selector. For browsers that do not support CSS selectors, WebDriver implementations may return an <a href="enum_bot_Error_State.html#INVALID_SELECTOR">invalid selector</a> error. An implementation may, however, emulate the CSS selector API.</p><div><div class="fn-details"><div><b>Parameters</b></div><dl><dt>selector<code><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String">string</a></code><dd><p>The CSS selector to use.</p></dl></div><div class="fn-details"><div><b>Returns</b></div><dl><dt><code><a href="class_webdriver_Locator.html">webdriver.Locator</a></code><dd><p>The new locator.</p></dl></div></div></div></div><hr class="fn-sep"><div id="id" class="function"><div><h3>id(<wbr>id)<span class="codelink"><a href="source/lib/webdriver/locators.js.src.html#l129">code »</a></span></h3><p>Locates an element by its ID.</p><div><div class="fn-details"><div><b>Parameters</b></div><dl><dt>id<code><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String">string</a></code><dd><p>The ID to search for.</p></dl></div><div class="fn-details"><div><b>Returns</b></div><dl><dt><code><a href="class_webdriver_Locator.html">webdriver.Locator</a></code><dd><p>The new locator.</p></dl></div></div></div></div><hr class="fn-sep"><div id="js" class="function"><div><h3>js(<wbr>script, var_args)<span class="codelink"><a href="source/lib/webdriver/locators.js.src.html#l152">code »</a></span></h3><p>Locates an elements by evaluating a <a href="class_webdriver_WebDriver.html#executeScript">JavaScript expression</a>. The result of this expression must be an element or list of elements.</p><div><div class="fn-details"><div><b>Parameters</b></div><dl><dt>script<code>(<a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String">string</a>|Function)</code><dd><p>The script to execute.</p><dt>var_args<code>...*</code><dd><p>The arguments to pass to the script.</p></dl></div><div class="fn-details"><div><b>Returns</b></div><dl><dt><code>function(<a href="class_webdriver_WebDriver.html">webdriver.WebDriver</a>): <a href="class_webdriver_promise_Promise.html">webdriver.promise.Promise</a></code><dd><p>A new, JavaScript-based locator function.</p></dl></div></div></div></div><hr class="fn-sep"><div id="linkText" class="function"><div><h3>linkText(<wbr>text)<span class="codelink"><a href="source/lib/webdriver/locators.js.src.html#l139">code »</a></span></h3><p>Locates link elements whose <a href="class_webdriver_WebElement.html#getText">visible text</a> matches the given string.</p><div><div class="fn-details"><div><b>Parameters</b></div><dl><dt>text<code><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String">string</a></code><dd><p>The link text to search for.</p></dl></div><div class="fn-details"><div><b>Returns</b></div><dl><dt><code><a href="class_webdriver_Locator.html">webdriver.Locator</a></code><dd><p>The new locator.</p></dl></div></div></div></div><hr class="fn-sep"><div id="name" class="function"><div><h3>name(<wbr>name)<span class="codelink"><a href="source/lib/webdriver/locators.js.src.html#l166">code »</a></span></h3><p>Locates elements whose <code>name</code> attribute has the given value.</p><div><div class="fn-details"><div><b>Parameters</b></div><dl><dt>name<code><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String">string</a></code><dd><p>The name attribute to search for.</p></dl></div><div class="fn-details"><div><b>Returns</b></div><dl><dt><code><a href="class_webdriver_Locator.html">webdriver.Locator</a></code><dd><p>The new locator.</p></dl></div></div></div></div><hr class="fn-sep"><div id="partialLinkText" class="function"><div><h3>partialLinkText(<wbr>text)<span class="codelink"><a href="source/lib/webdriver/locators.js.src.html#l176">code »</a></span></h3><p>Locates link elements whose <a href="class_webdriver_WebElement.html#getText">visible text</a> contains the given substring.</p><div><div class="fn-details"><div><b>Parameters</b></div><dl><dt>text<code><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String">string</a></code><dd><p>The substring to check for in a link's visible text.</p></dl></div><div class="fn-details"><div><b>Returns</b></div><dl><dt><code><a href="class_webdriver_Locator.html">webdriver.Locator</a></code><dd><p>The new locator.</p></dl></div></div></div></div><hr class="fn-sep"><div id="tagName" class="function"><div><h3>tagName(<wbr>text)<span class="codelink"><a href="source/lib/webdriver/locators.js.src.html#l190">code »</a></span></h3><p>Locates elements with a given tag name. The returned locator is equivalent to using the <a href="https://developer.mozilla.org/en-US/docs/Web/API/Element.getElementsByTagName">getElementsByTagName</a> DOM function.</p><div><div class="fn-details"><div><b>Parameters</b></div><dl><dt>text<code><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String">string</a></code><dd><p>The substring to check for in a link's visible text.</p></dl></div><div class="fn-details"><div><b>Returns</b></div><dl><dt><code><a href="class_webdriver_Locator.html">webdriver.Locator</a></code><dd><p>The new locator.</p></dl></div></div></div></div><hr class="fn-sep"><div id="xpath" class="function"><div><h3>xpath(<wbr>xpath)<span class="codelink"><a href="source/lib/webdriver/locators.js.src.html#l205">code »</a></span></h3><p>Locates elements matching a XPath selector. Care should be taken when using an XPath selector with a <a href="class_webdriver_WebElement.html"><code>webdriver.WebElement</code></a> as WebDriver will respect the context in the specified in the selector. For example, given the selector <code>"//div"</code>, WebDriver will search from the document root regardless of whether the locator was used with a WebElement.</p><div><div class="fn-details"><div><b>Parameters</b></div><dl><dt>xpath<code><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String">string</a></code><dd><p>The XPath selector to use.</p></dl></div><div class="fn-details"><div><b>Returns</b></div><dl><dt><code><a href="class_webdriver_Locator.html">webdriver.Locator</a></code><dd><p>The new locator.</p></dl></div></div></div></div><h2>Type Definitions</h2><div id="By.Hash" class="property"><dl><dt><a href="source/lib/webdriver/locators.js.src.html#l95">By.Hash</a><code>({className: <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String">string</a>}|{css: <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String">string</a>}|{id: <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String">string</a>}|{js: <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String">string</a>}|{linkText: <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String">string</a>}|{name: <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String">string</a>}|{partialLinkText: <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String">string</a>}|{tagName: <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String">string</a>}|{xpath: <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String">string</a>})</code><dd><p>Short-hand expressions for the primary element locator strategies. For example the following two statements are equivalent:</p> <pre><code>var e1 = driver.findElement(webdriver.By.id('foo')); var e2 = driver.findElement({id: 'foo'}); </code></pre><p>Care should be taken when using JavaScript minifiers (such as the Closure compiler), as locator hashes will always be parsed using the un-obfuscated properties listed.</p></dl></div></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>