ti-appium
Version:
An Appium wrapper to test Titanium applications
4,393 lines (874 loc) • 45.5 kB
HTML
<html lang="en">
<head>
<meta charset="utf-8">
<title>JSDoc: Namespace: WebDriverCommands</title>
<script src="scripts/prettify/prettify.js"> </script>
<script src="scripts/prettify/lang-css.js"> </script>
<!--[if lt IE 9]>
<script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
<![endif]-->
<link type="text/css" rel="stylesheet" href="styles/prettify-tomorrow.css">
<link type="text/css" rel="stylesheet" href="styles/jsdoc-default.css">
</head>
<body>
<div id="main">
<h1 class="page-title">Namespace: WebDriverCommands</h1>
<section>
<header>
<h2>WebDriverCommands</h2>
</header>
<article>
<div class="container-overview">
<div class="description">Custom defined commands that can be used for testing. Provides a number of
helper commands such as element finding, touch actions and screenshot testing.</div>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="src_webdriver.js.html">src/webdriver.js</a>, <a href="src_webdriver.js.html#line10">line 10</a>
</li></ul></dd>
</dl>
</div>
<h3 class="subsection-title">Methods</h3>
<h4 class="name" id=".alertAccept"><span class="type-signature">(static) </span>alertAccept<span class="signature">()</span><span class="type-signature"></span></h4>
<div class="description">
Accept the alert on the display to clear it away.
</div>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="src_webdriver.js.html">src/webdriver.js</a>, <a href="src_webdriver.js.html#line91">line 91</a>
</li></ul></dd>
</dl>
<h4 class="name" id=".androidHideKeyboard"><span class="type-signature">(static) </span>androidHideKeyboard<span class="signature">()</span><span class="type-signature"></span></h4>
<div class="description">
Used for hiding the keyboard on Android devices, as it
sometimes focuses on new text fields.
</div>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="src_webdriver.js.html">src/webdriver.js</a>, <a href="src_webdriver.js.html#line52">line 52</a>
</li></ul></dd>
</dl>
<h4 class="name" id=".backspace"><span class="type-signature">(static) </span>backspace<span class="signature">()</span><span class="type-signature"></span></h4>
<div class="description">
Use the backspace key on the keyboard for the required platform.
</div>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="src_webdriver.js.html">src/webdriver.js</a>, <a href="src_webdriver.js.html#line151">line 151</a>
</li></ul></dd>
</dl>
<h4 class="name" id=".doubleClick"><span class="type-signature">(static) </span>doubleClick<span class="signature">()</span><span class="type-signature"></span></h4>
<div class="description">
Double click on the passed element.
</div>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="src_webdriver.js.html">src/webdriver.js</a>, <a href="src_webdriver.js.html#line440">line 440</a>
</li></ul></dd>
</dl>
<h4 class="name" id=".elementClassName"><span class="type-signature">(static) </span>elementClassName<span class="signature">(className)</span><span class="type-signature"></span></h4>
<div class="description">
Return an element by its platform specific class name.
</div>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>className</code></td>
<td class="type">
<span class="param-type">String</span>
</td>
<td class="description last">The class name of the desired element.</td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="src_webdriver.js.html">src/webdriver.js</a>, <a href="src_webdriver.js.html#line173">line 173</a>
</li></ul></dd>
</dl>
<h4 class="name" id=".elementId"><span class="type-signature">(static) </span>elementId<span class="signature">(element)</span><span class="type-signature"></span></h4>
<div class="description">
Return an element by its ID.
</div>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>element</code></td>
<td class="type">
<span class="param-type">String</span>
</td>
<td class="description last">The element ID used to identify the element.</td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="src_webdriver.js.html">src/webdriver.js</a>, <a href="src_webdriver.js.html#line247">line 247</a>
</li></ul></dd>
</dl>
<h4 class="name" id=".elementsClassName"><span class="type-signature">(static) </span>elementsClassName<span class="signature">(className)</span><span class="type-signature"></span></h4>
<div class="description">
Count the number of elements by its platform specific class name.
</div>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>className</code></td>
<td class="type">
<span class="param-type">String</span>
</td>
<td class="description last">The class name of the desired element.</td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="src_webdriver.js.html">src/webdriver.js</a>, <a href="src_webdriver.js.html#line185">line 185</a>
</li></ul></dd>
</dl>
<h4 class="name" id=".elementsId"><span class="type-signature">(static) </span>elementsId<span class="signature">(element)</span><span class="type-signature"></span></h4>
<div class="description">
Count the number of elements by its ID.
</div>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>element</code></td>
<td class="type">
<span class="param-type">String</span>
</td>
<td class="description last">The element ID used to identify the element.</td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="src_webdriver.js.html">src/webdriver.js</a>, <a href="src_webdriver.js.html#line269">line 269</a>
</li></ul></dd>
</dl>
<h4 class="name" id=".elementsText"><span class="type-signature">(static) </span>elementsText<span class="signature">(text)</span><span class="type-signature"></span></h4>
<div class="description">
Count the number of elements by its text content.
</div>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>text</code></td>
<td class="type">
<span class="param-type">String</span>
</td>
<td class="description last">The text to identify the element</td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="src_webdriver.js.html">src/webdriver.js</a>, <a href="src_webdriver.js.html#line340">line 340</a>
</li></ul></dd>
</dl>
<h4 class="name" id=".elementsXPath"><span class="type-signature">(static) </span>elementsXPath<span class="signature">(xPath)</span><span class="type-signature"></span></h4>
<div class="description">
Count the number of elements by its XPath.
</div>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>xPath</code></td>
<td class="type">
<span class="param-type">String</span>
</td>
<td class="description last">The XPath selector of the desired element.</td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="src_webdriver.js.html">src/webdriver.js</a>, <a href="src_webdriver.js.html#line222">line 222</a>
</li></ul></dd>
</dl>
<h4 class="name" id=".elementText"><span class="type-signature">(static) </span>elementText<span class="signature">(text)</span><span class="type-signature"></span></h4>
<div class="description">
Return an element by its text content.
</div>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>text</code></td>
<td class="type">
<span class="param-type">String</span>
</td>
<td class="description last">The text to identify the element</td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="src_webdriver.js.html">src/webdriver.js</a>, <a href="src_webdriver.js.html#line314">line 314</a>
</li></ul></dd>
</dl>
<h4 class="name" id=".elementXPath"><span class="type-signature">(static) </span>elementXPath<span class="signature">(xPath)</span><span class="type-signature"></span></h4>
<div class="description">
Return an element by its XPath.
</div>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>xPath</code></td>
<td class="type">
<span class="param-type">String</span>
</td>
<td class="description last">The XPath selector of the desired element.</td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="src_webdriver.js.html">src/webdriver.js</a>, <a href="src_webdriver.js.html#line210">line 210</a>
</li></ul></dd>
</dl>
<h4 class="name" id=".enter"><span class="type-signature">(static) </span>enter<span class="signature">(term)</span><span class="type-signature"></span></h4>
<div class="description">
Equivelant to hitting the return key, do so for the required platform.
</div>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>term</code></td>
<td class="type">
<span class="param-type">String</span>
</td>
<td class="description last">The enter term to be clicked on iOS devices.</td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="src_webdriver.js.html">src/webdriver.js</a>, <a href="src_webdriver.js.html#line127">line 127</a>
</li></ul></dd>
</dl>
<h4 class="name" id=".fullScreenshotTest"><span class="type-signature">(static) </span>fullScreenshotTest<span class="signature">(file, modRoot, opts)</span><span class="type-signature"></span></h4>
<div class="description">
Compares a screenshot of the app in its current state, to a stored
reference image to see how they match. (Leaves the status bar in, for
tests which may require it).
</div>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>file</code></td>
<td class="type">
<span class="param-type">String</span>
</td>
<td class="description last">The path to the reference image</td>
</tr>
<tr>
<td class="name"><code>modRoot</code></td>
<td class="type">
<span class="param-type">String</span>
</td>
<td class="description last">The path to the root of the project being tested</td>
</tr>
<tr>
<td class="name"><code>opts</code></td>
<td class="type">
<span class="param-type">Object</span>
</td>
<td class="description last">Arguments
<h6>Properties</h6>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>thresh</code></td>
<td class="type">
<span class="param-type">Float</span>
</td>
<td class="description last">Percentage fault value for image matching likeness</td>
</tr>
<tr>
<td class="name"><code>overwrite</code></td>
<td class="type">
<span class="param-type">Boolean</span>
</td>
<td class="description last">Whether or not to overwrite the reference image</td>
</tr>
<tr>
<td class="name"><code>delay</code></td>
<td class="type">
<span class="param-type">Int</span>
</td>
<td class="description last">The time to wait before taking the screenshot in milliseconds</td>
</tr>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="src_webdriver.js.html">src/webdriver.js</a>, <a href="src_webdriver.js.html#line838">line 838</a>
</li></ul></dd>
</dl>
<h4 class="name" id=".getBounds"><span class="type-signature">(static) </span>getBounds<span class="signature">()</span><span class="type-signature"></span></h4>
<div class="description">
Get the dimensions, and coordinates of an element, then return them.
</div>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="src_webdriver.js.html">src/webdriver.js</a>, <a href="src_webdriver.js.html#line393">line 393</a>
</li></ul></dd>
</dl>
<h4 class="name" id=".getDensity"><span class="type-signature">(static) </span>getDensity<span class="signature">()</span><span class="type-signature"></span></h4>
<div class="description">
Used for finding the screen density of Android devices
</div>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="src_webdriver.js.html">src/webdriver.js</a>, <a href="src_webdriver.js.html#line689">line 689</a>
</li></ul></dd>
</dl>
<h4 class="name" id=".getDensity"><span class="type-signature">(static) </span>getDensity<span class="signature">()</span><span class="type-signature"></span></h4>
<div class="description">
Used for finding the screen density of Android devices
</div>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="src_webdriver.js.html">src/webdriver.js</a>, <a href="src_webdriver.js.html#line725">line 725</a>
</li></ul></dd>
</dl>
<h4 class="name" id=".getLog"><span class="type-signature">(static) </span>getLog<span class="signature">()</span><span class="type-signature"></span></h4>
<div class="description">
Return the latest log capture from Appium.
</div>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="src_webdriver.js.html">src/webdriver.js</a>, <a href="src_webdriver.js.html#line591">line 591</a>
</li></ul></dd>
</dl>
<h4 class="name" id=".getPlatform"><span class="type-signature">(static) </span>getPlatform<span class="signature">()</span><span class="type-signature"></span></h4>
<div class="description">
Return the OS of the current device, using the session.
</div>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="src_webdriver.js.html">src/webdriver.js</a>, <a href="src_webdriver.js.html#line38">line 38</a>
</li></ul></dd>
</dl>
<h4 class="name" id=".getText"><span class="type-signature">(static) </span>getText<span class="signature">()</span><span class="type-signature"></span></h4>
<div class="description">
Get the text from the passed UI elements.
</div>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="src_webdriver.js.html">src/webdriver.js</a>, <a href="src_webdriver.js.html#line71">line 71</a>
</li></ul></dd>
</dl>
<h4 class="name" id=".logCount"><span class="type-signature">(static) </span>logCount<span class="signature">(log, searchString, iterations)</span><span class="type-signature"></span></h4>
<div class="description">
Count the amount of times a message appears in a log.
</div>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>log</code></td>
<td class="type">
<span class="param-type">Array.<String></span>
</td>
<td class="description last">The Log to be searched through</td>
</tr>
<tr>
<td class="name"><code>searchString</code></td>
<td class="type">
<span class="param-type">String</span>
</td>
<td class="description last">String that should be present in the log</td>
</tr>
<tr>
<td class="name"><code>iterations</code></td>
<td class="type">
<span class="param-type">Int</span>
</td>
<td class="description last">The amount of times the string should be present</td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="src_webdriver.js.html">src/webdriver.js</a>, <a href="src_webdriver.js.html#line662">line 662</a>
</li></ul></dd>
</dl>
<h4 class="name" id=".logShouldContain"><span class="type-signature">(static) </span>logShouldContain<span class="signature">(log, searchStrings)</span><span class="type-signature"></span></h4>
<div class="description">
Check that a message appears in the device log.
</div>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>log</code></td>
<td class="type">
<span class="param-type">Array.<String></span>
</td>
<td class="description last">The Log to be searched through</td>
</tr>
<tr>
<td class="name"><code>searchStrings</code></td>
<td class="type">
<span class="param-type">Array.<String></span>
</td>
<td class="description last">Strings that should be present in the log</td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="src_webdriver.js.html">src/webdriver.js</a>, <a href="src_webdriver.js.html#line624">line 624</a>
</li></ul></dd>
</dl>
<h4 class="name" id=".logShouldNotContain"><span class="type-signature">(static) </span>logShouldNotContain<span class="signature">(log, searchStrings)</span><span class="type-signature"></span></h4>
<div class="description">
Check that a message doesn't appear in the device log.
</div>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>log</code></td>
<td class="type">
<span class="param-type">Array.<String></span>
</td>
<td class="description last">The Log to be searched through</td>
</tr>
<tr>
<td class="name"><code>searchStrings</code></td>
<td class="type">
<span class="param-type">Array.<String></span>
</td>
<td class="description last">Strings that shouldn't be present in the log</td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="src_webdriver.js.html">src/webdriver.js</a>, <a href="src_webdriver.js.html#line643">line 643</a>
</li></ul></dd>
</dl>
<h4 class="name" id=".longpress"><span class="type-signature">(static) </span>longpress<span class="signature">()</span><span class="type-signature"></span></h4>
<div class="description">
Longpress on the passed element.
</div>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="src_webdriver.js.html">src/webdriver.js</a>, <a href="src_webdriver.js.html#line418">line 418</a>
</li></ul></dd>
</dl>
<h4 class="name" id=".screenshotTest"><span class="type-signature">(static) </span>screenshotTest<span class="signature">(file, modRoot, opts)</span><span class="type-signature"></span></h4>
<div class="description">
Take a screenshot on the device, and then compare it to a reference
screenshot and validate the result against a configurable threshold.
</div>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>file</code></td>
<td class="type">
<span class="param-type">String</span>
</td>
<td class="description last">The path to the reference image</td>
</tr>
<tr>
<td class="name"><code>modRoot</code></td>
<td class="type">
<span class="param-type">String</span>
</td>
<td class="description last">The path to the root of the project being tested</td>
</tr>
<tr>
<td class="name"><code>opts</code></td>
<td class="type">
<span class="param-type">Object</span>
</td>
<td class="description last">Optional arguments
<h6>Properties</h6>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>thresh</code></td>
<td class="type">
<span class="param-type">Float</span>
</td>
<td class="description last">Percentage fault value for image matching likeness</td>
</tr>
<tr>
<td class="name"><code>overwrite</code></td>
<td class="type">
<span class="param-type">Boolean</span>
</td>
<td class="description last">Whether or not to overwrite the reference image</td>
</tr>
<tr>
<td class="name"><code>delay</code></td>
<td class="type">
<span class="param-type">Int</span>
</td>
<td class="description last">The time to wait before taking the screenshot in milliseconds</td>
</tr>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="src_webdriver.js.html">src/webdriver.js</a>, <a href="src_webdriver.js.html#line761">line 761</a>
</li></ul></dd>
</dl>
<h4 class="name" id=".scrollDown"><span class="type-signature">(static) </span>scrollDown<span class="signature">()</span><span class="type-signature"></span></h4>
<div class="description">
Scroll down on the entire height of the passed element.
</div>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="src_webdriver.js.html">src/webdriver.js</a>, <a href="src_webdriver.js.html#line495">line 495</a>
</li></ul></dd>
</dl>
<h4 class="name" id=".scrollUp"><span class="type-signature">(static) </span>scrollUp<span class="signature">()</span><span class="type-signature"></span></h4>
<div class="description">
Scroll up on the entire height of the passed element.
</div>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="src_webdriver.js.html">src/webdriver.js</a>, <a href="src_webdriver.js.html#line463">line 463</a>
</li></ul></dd>
</dl>
<h4 class="name" id=".swipeLeft"><span class="type-signature">(static) </span>swipeLeft<span class="signature">()</span><span class="type-signature"></span></h4>
<div class="description">
Swipe left across the entire width of the passed element.
</div>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="src_webdriver.js.html">src/webdriver.js</a>, <a href="src_webdriver.js.html#line559">line 559</a>
</li></ul></dd>
</dl>
<h4 class="name" id=".swipeRight"><span class="type-signature">(static) </span>swipeRight<span class="signature">()</span><span class="type-signature"></span></h4>
<div class="description">
Swipe right across the entire width of the passed element.
</div>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="src_webdriver.js.html">src/webdriver.js</a>, <a href="src_webdriver.js.html#line527">line 527</a>
</li></ul></dd>
</dl>
<h4 class="name" id=".waitForElementClassName"><span class="type-signature">(static) </span>waitForElementClassName<span class="signature">(className, time)</span><span class="type-signature"></span></h4>
<div class="description">
Return an element by its platform specific class name, but allow wait.
</div>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>className</code></td>
<td class="type">
<span class="param-type">String</span>
</td>
<td class="description last">The class name of the desired element.</td>
</tr>
<tr>
<td class="name"><code>time</code></td>
<td class="type">
<span class="param-type">Int</span>
</td>
<td class="description last">How long to wait in milliseconds.</td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="src_webdriver.js.html">src/webdriver.js</a>, <a href="src_webdriver.js.html#line197">line 197</a>
</li></ul></dd>
</dl>
<h4 class="name" id=".waitForElementId"><span class="type-signature">(static) </span>waitForElementId<span class="signature">(element, time)</span><span class="type-signature"></span></h4>
<div class="description">
Return an element by its ID, but allow wait.
</div>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>element</code></td>
<td class="type">
<span class="param-type">String</span>
</td>
<td class="description last">The element ID used to identify the element.</td>
</tr>
<tr>
<td class="name"><code>time</code></td>
<td class="type">
<span class="param-type">Int</span>
</td>
<td class="description last">How long to wait in milliseconds.</td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="src_webdriver.js.html">src/webdriver.js</a>, <a href="src_webdriver.js.html#line291">line 291</a>
</li></ul></dd>
</dl>
<h4 class="name" id=".waitForElementText"><span class="type-signature">(static) </span>waitForElementText<span class="signature">(text, time)</span><span class="type-signature"></span></h4>
<div class="description">
Return an element by its text content, but allow wait.
</div>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>text</code></td>
<td class="type">
<span class="param-type">String</span>
</td>
<td class="description last">The text to identify the element</td>
</tr>
<tr>
<td class="name"><code>time</code></td>
<td class="type">
<span class="param-type">Int</span>
</td>
<td class="description last">How long to wait in milliseconds</td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="src_webdriver.js.html">src/webdriver.js</a>, <a href="src_webdriver.js.html#line366">line 366</a>
</li></ul></dd>
</dl>
<h4 class="name" id=".waitForElementXPath"><span class="type-signature">(static) </span>waitForElementXPath<span class="signature">(xPath, time)</span><span class="type-signature"></span></h4>
<div class="description">
Return an element by its XPath, but allow wait.
</div>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>xPath</code></td>
<td class="type">
<span class="param-type">String</span>
</td>
<td class="description last">The XPath selector of the desired element.</td>
</tr>
<tr>
<td class="name"><code>time</code></td>
<td class="type">
<span class="param-type">Int</span>
</td>
<td class="description last">How long to wait in milliseconds.</td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="src_webdriver.js.html">src/webdriver.js</a>, <a href="src_webdriver.js.html#line234">line 234</a>
</li></ul></dd>
</dl>
</article>
</section>
</div>
<nav>
<h2><a href="index.html">Home</a></h2><h3>Namespaces</h3><ul><li><a href="WebDriverCommands.html">WebDriverCommands</a></li></ul><h3>Classes</h3><ul><li><a href="Appc_Helper.html">Appc_Helper</a></li><li><a href="Appium_Helper.html">Appium_Helper</a></li><li><a href="Device_Helper.html">Device_Helper</a></li><li><a href="Mocha_Helper.html">Mocha_Helper</a></li><li><a href="Output_Helper.html">Output_Helper</a></li><li><a href="Webdriver_Helper.html">Webdriver_Helper</a></li></ul><h3>Global</h3><ul><li><a href="global.html#appcRun">appcRun</a></li><li><a href="global.html#appcSetup">appcSetup</a></li><li><a href="global.html#banner">banner</a></li><li><a href="global.html#buildApp">buildApp</a></li><li><a href="global.html#createAppPath">createAppPath</a></li><li><a href="global.html#debug">debug</a></li><li><a href="global.html#error">error</a></li><li><a href="global.html#finish">finish</a></li><li><a href="global.html#getCert">getCert</a></li><li><a href="global.html#getProfile">getProfile</a></li><li><a href="global.html#getSimState">getSimState</a></li><li><a href="global.html#info">info</a></li><li><a href="global.html#killEmulator">killEmulator</a></li><li><a href="global.html#killSimulator">killSimulator</a></li><li><a href="global.html#parseSDK">parseSDK</a></li><li><a href="global.html#skip">skip</a></li><li><a href="global.html#startAppium">startAppium</a></li><li><a href="global.html#startClient">startClient</a></li><li><a href="global.html#step">step</a></li><li><a href="global.html#stopAppium">stopAppium</a></li><li><a href="global.html#stopClient">stopClient</a></li><li><a href="global.html#test">test</a></li><li><a href="global.html#warn">warn</a></li></ul>
</nav>
<br class="clear">
<footer>
Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.3</a> on Fri Aug 28 2020 10:09:07 GMT+0100 (British Summer Time)
</footer>
<script> prettyPrint(); </script>
<script src="scripts/linenumber.js"> </script>
</body>
</html>