From 6f170e5471a441c02388f3adcd084529ba16f8b6 Mon Sep 17 00:00:00 2001
From: serhatbolsu <serhatbolsu@gmail.com>
Date: Wed, 12 Oct 2016 17:11:50 +0300
Subject: [PATCH] Documentation update for new keywords

---
 doc/AppiumLibrary.html                 | 2 +-
 src/AppiumLibrary/__init__.py          | 5 +++++
 src/AppiumLibrary/keywords/_element.py | 4 ++--
 3 files changed, 8 insertions(+), 3 deletions(-)

diff --git a/doc/AppiumLibrary.html b/doc/AppiumLibrary.html
index c3a00d45..04a876d7 100644
--- a/doc/AppiumLibrary.html
+++ b/doc/AppiumLibrary.html
@@ -468,7 +468,7 @@
 jQuery.extend({highlight:function(e,t,n,r){if(e.nodeType===3){var i=e.data.match(t);if(i){var s=document.createElement(n||"span");s.className=r||"highlight";var o=e.splitText(i.index);o.splitText(i[0].length);var u=o.cloneNode(true);s.appendChild(u);o.parentNode.replaceChild(s,o);return 1}}else if(e.nodeType===1&&e.childNodes&&!/(script|style)/i.test(e.tagName)&&!(e.tagName===n.toUpperCase()&&e.className===r)){for(var a=0;a<e.childNodes.length;a++){a+=jQuery.highlight(e.childNodes[a],t,n,r)}}return 0}});jQuery.fn.unhighlight=function(e){var t={className:"highlight",element:"span"};jQuery.extend(t,e);return this.find(t.element+"."+t.className).each(function(){var e=this.parentNode;e.replaceChild(this.firstChild,this);e.normalize()}).end()};jQuery.fn.highlight=function(e,t){var n={className:"highlight",element:"span",caseSensitive:false,wordsOnly:false};jQuery.extend(n,t);if(e.constructor===String){e=[e]}e=jQuery.grep(e,function(e,t){return e!=""});e=jQuery.map(e,function(e,t){return e.replace(/[-[\]{}()*+?.,\\^$|#\s]/g,"\\$&")});if(e.length==0){return this}var r=n.caseSensitive?"":"i";var i="("+e.join("|")+")";if(n.wordsOnly){i="\\b"+i+"\\b"}var s=new RegExp(i,r);return this.each(function(){jQuery.highlight(this,s,n.element,n.className)})}
 </script>
 <script type="text/javascript">
-libdoc = {"all_tags":[],"contains_tags":false,"doc":"<p>AppiumLibrary is a Mobile App testing library for Robot Framework.\x3c/p>\n<h2 id=\"Locating or specifying elements\">Locating or specifying elements\x3c/h2>\n<p>All keywords in AppiumLibrary that need to find an element on the page take an argument, either a <code>locator\x3c/code> or a <code>webelement\x3c/code>. <code>locator\x3c/code> is a string that describes how to locate an element using a syntax specifying different location strategies. <code>webelement\x3c/code> is a variable that holds a WebElement instance, which is a representation of the element.\x3c/p>\n<h3 id=\"Using locators\">Using locators\x3c/h3>\n<p>By default, when a locator is provided, it is matched against the key attributes of the particular element type. For iOS and Android, key attribute is <code>id\x3c/code> for all elements and locating elements is easy using just the <code>id\x3c/code>. For example:\x3c/p>\n<pre>\nClick Element    id=my_element\n\x3c/pre>\n<p>New in AppiumLibrary 1.4, <code>id\x3c/code> and <code>xpath\x3c/code> are not required to be specified, however <code>xpath\x3c/code> should start with <code>//\x3c/code> else just use <code>xpath\x3c/code> locator as explained below.\x3c/p>\n<p>For example:\x3c/p>\n<pre>\nClick Element    my_element\nWait Until Page Contains Element    //*[@type=\"android.widget.EditText\"]\n\x3c/pre>\n<p>Appium additionally supports some of the <a href=\"https://w3c.github.io/webdriver/webdriver-spec.html\">Mobile JSON Wire Protocol\x3c/a> locator strategies. It is also possible to specify the approach AppiumLibrary should take to find an element by specifying a lookup strategy with a locator prefix. Supported strategies are:\x3c/p>\n<table border=\"1\">\n<tr>\n<td><b>Strategy\x3c/b>\x3c/td>\n<td><b>Example\x3c/b>\x3c/td>\n<td><b>Description\x3c/b>\x3c/td>\n<td><b>Note\x3c/b>\x3c/td>\n\x3c/tr>\n<tr>\n<td>identifier\x3c/td>\n<td>Click Element <span class=\"name\">|\x3c/span> identifier=my_element\x3c/td>\n<td>Matches by @id attribute\x3c/td>\n<td>\x3c/td>\n\x3c/tr>\n<tr>\n<td>id\x3c/td>\n<td>Click Element <span class=\"name\">|\x3c/span> id=my_element\x3c/td>\n<td>Matches by @resource-id attribute\x3c/td>\n<td>\x3c/td>\n\x3c/tr>\n<tr>\n<td>accessibility_id\x3c/td>\n<td>Click Element <span class=\"name\">|\x3c/span> accessibility_id=button3\x3c/td>\n<td>Accessibility options utilize.\x3c/td>\n<td>\x3c/td>\n\x3c/tr>\n<tr>\n<td>xpath\x3c/td>\n<td>Click Element <span class=\"name\">|\x3c/span> xpath=//UIATableView/UIATableCell/UIAButton\x3c/td>\n<td>Matches with arbitrary XPath\x3c/td>\n<td>\x3c/td>\n\x3c/tr>\n<tr>\n<td>class\x3c/td>\n<td>Click Element <span class=\"name\">|\x3c/span> class=UIAPickerWheel\x3c/td>\n<td>Matches by class\x3c/td>\n<td>\x3c/td>\n\x3c/tr>\n<tr>\n<td>android\x3c/td>\n<td>Click Element <span class=\"name\">|\x3c/span> android=UiSelector().description('Apps')\x3c/td>\n<td>Matches by Android UI Automator\x3c/td>\n<td>\x3c/td>\n\x3c/tr>\n<tr>\n<td>ios\x3c/td>\n<td>Click Element <span class=\"name\">|\x3c/span> ios=.buttons().withName('Apps')\x3c/td>\n<td>Matches by iOS UI Automation\x3c/td>\n<td>\x3c/td>\n\x3c/tr>\n<tr>\n<td>css\x3c/td>\n<td>Click Element <span class=\"name\">|\x3c/span> css=.green_button\x3c/td>\n<td>Matches by css in webview\x3c/td>\n<td>\x3c/td>\n\x3c/tr>\n<tr>\n<td>name\x3c/td>\n<td>Click Element <span class=\"name\">|\x3c/span> name=my_element\x3c/td>\n<td>Matches by @name attribute\x3c/td>\n<td><b>Only valid\x3c/b> for Selendroid\x3c/td>\n\x3c/tr>\n\x3c/table>\n<h3 id=\"Using webelements\">Using webelements\x3c/h3>\n<p>Starting with version 1.4 of the AppiumLibrary, one can pass an argument that contains a WebElement instead of a string locator. To get a WebElement, use the new <a href=\"#Get%20Webelements\" class=\"name\">Get WebElements\x3c/a> or <a href=\"#Get%20Webelement\" class=\"name\">Get WebElement\x3c/a> keyword.\x3c/p>","generated":"2016-09-27 01:09:49","inits":[{"args":["timeout=5","run_on_failure=Capture Page Screenshot"],"doc":"<p>AppiumLibrary can be imported with optional arguments.\x3c/p>\n<p><code>timeout\x3c/code> is the default timeout used to wait for all waiting actions. It can be later set with <a href=\"#Set%20Appium%20Timeout\" class=\"name\">Set Appium Timeout\x3c/a>.\x3c/p>\n<p><code>run_on_failure\x3c/code> specifies the name of a keyword (from any available libraries) to execute when a AppiumLibrary keyword fails.\x3c/p>\n<p>By default <a href=\"#Capture%20Page%20Screenshot\" class=\"name\">Capture Page Screenshot\x3c/a> will be used to take a screenshot of the current page. Using the value <span class=\"name\">No Operation\x3c/span> will disable this feature altogether. See <a href=\"#Register%20Keyword%20To%20Run%20On%20Failure\" class=\"name\">Register Keyword To Run On Failure\x3c/a> keyword for more information about this functionality.\x3c/p>\n<p>Examples:\x3c/p>\n<table border=\"1\">\n<tr>\n<td>Library\x3c/td>\n<td>AppiumLibrary\x3c/td>\n<td>10\x3c/td>\n<td># Sets default timeout to 10 seconds\x3c/td>\n<td>\x3c/td>\n\x3c/tr>\n<tr>\n<td>Library\x3c/td>\n<td>AppiumLibrary\x3c/td>\n<td>timeout=10\x3c/td>\n<td>run_on_failure=No Operation\x3c/td>\n<td># Sets default timeout to 10 seconds and does nothing on failure\x3c/td>\n\x3c/tr>\n\x3c/table>","matched":true,"name":"Init","shortdoc":"AppiumLibrary can be imported with optional arguments.","tags":[]}],"keywords":[{"args":["seconds=5"],"doc":"<p>Puts the application in the background on the device for a certain duration.\x3c/p>","matched":true,"name":"Background App","shortdoc":"Puts the application in the background on the device for a certain","tags":[]},{"args":["filename=None"],"doc":"<p>Takes a screenshot of the current page and embeds it into the log.\x3c/p>\n<p><span class=\"name\">filename\x3c/span> argument specifies the name of the file to write the screenshot into. If no <span class=\"name\">filename\x3c/span> is given, the screenshot is saved into file <span class=\"name\">appium-screenshot-&lt;counter&gt;.png\x3c/span> under the directory where the Robot Framework log file is written into. The <span class=\"name\">filename\x3c/span> is also considered relative to the same directory, if it is not given in absolute format.\x3c/p>\n<p><span class=\"name\">css\x3c/span> can be used to modify how the screenshot is taken. By default the bakground color is changed to avoid possible problems with background leaking when the page layout is somehow broken.\x3c/p>","matched":true,"name":"Capture Page Screenshot","shortdoc":"Takes a screenshot of the current page and embeds it into the log.","tags":[]},{"args":["locator"],"doc":"<p>Clears the text field identified by <span class=\"name\">locator\x3c/span>.\x3c/p>\n<p>See <a href=\"#Introduction\" class=\"name\">introduction\x3c/a> for details about locating elements.\x3c/p>","matched":true,"name":"Clear Text","shortdoc":"Clears the text field identified by `locator`.","tags":[]},{"args":["x=0","y=0","duration=100"],"doc":"<p>Click on a point\x3c/p>","matched":true,"name":"Click A Point","shortdoc":"Click on a point","tags":[]},{"args":["index_or_name"],"doc":"<p>Click button\x3c/p>","matched":true,"name":"Click Button","shortdoc":"Click button","tags":[]},{"args":["locator"],"doc":"<p>Click element identified by <span class=\"name\">locator\x3c/span>.\x3c/p>\n<p>Key attributes for arbitrary elements are <span class=\"name\">index\x3c/span> and <span class=\"name\">name\x3c/span>. See <a href=\"#Introduction\" class=\"name\">introduction\x3c/a> for details about locating elements.\x3c/p>","matched":true,"name":"Click Element","shortdoc":"Click element identified by `locator`.","tags":[]},{"args":["coordinate_X","coordinate_Y"],"doc":"<p>click element at a certain coordinate\x3c/p>","matched":true,"name":"Click Element At Coordinates","shortdoc":"click element at a certain coordinate","tags":[]},{"args":[],"doc":"<p>Closes all open applications.\x3c/p>\n<p>This keyword is meant to be used in test or suite teardown to make sure all the applications are closed before the test execution finishes.\x3c/p>\n<p>After this keyword, the application indices returned by <a href=\"#Open%20Application\" class=\"name\">Open Application\x3c/a> are reset and start from <span class=\"name\">1\x3c/span>.\x3c/p>","matched":true,"name":"Close All Applications","shortdoc":"Closes all open applications.","tags":[]},{"args":[],"doc":"<p>Closes the current application.\x3c/p>","matched":true,"name":"Close Application","shortdoc":"Closes the current application.","tags":[]},{"args":["locator","attr_name","match_pattern","regexp=False"],"doc":"<p>Verify that an attribute of an element matches the expected criteria.\x3c/p>\n<p>The element is identified by <i>locator\x3c/i>. See <a href=\"#Introduction\" class=\"name\">introduction\x3c/a> for details about locating elements. If more than one element matches, the first element is selected.\x3c/p>\n<p>The <i>attr_name\x3c/i> is the name of the attribute within the selected element.\x3c/p>\n<p>The <i>match_pattern\x3c/i> is used for the matching, if the match_pattern is\x3c/p>\n<ul>\n<li>boolean or 'True'/'true'/'False'/'false' String then a boolean match is applied\x3c/li>\n<li>any other string is cause a string match\x3c/li>\n\x3c/ul>\n<p>The <i>regexp\x3c/i> defines whether the string match is done using regular expressions (i.e. BuiltIn Library's <a href=\"http://robotframework.org/robotframework/latest/libraries/BuiltIn.html#Should%20Match%20Regexp\">Should Match Regexp\x3c/a> or string pattern match (i.e. BuiltIn Library's <a href=\"http://robotframework.org/robotframework/latest/libraries/BuiltIn.html#Should%20Match\">Should Match\x3c/a>)\x3c/p>\n<p>Examples:\x3c/p>\n<table border=\"1\">\n<tr>\n<td>Element Attribute Should Match\x3c/td>\n<td>xpath = //*[contains(@text,'foo')]\x3c/td>\n<td>text\x3c/td>\n<td>*foobar\x3c/td>\n<td>\x3c/td>\n\x3c/tr>\n<tr>\n<td>Element Attribute Should Match\x3c/td>\n<td>xpath = //*[contains(@text,'foo')]\x3c/td>\n<td>text\x3c/td>\n<td>f.*ar\x3c/td>\n<td>regexp = True\x3c/td>\n\x3c/tr>\n<tr>\n<td>Element Attribute Should Match\x3c/td>\n<td>xpath = //*[contains(@text,'foo')]\x3c/td>\n<td>enabled\x3c/td>\n<td>True\x3c/td>\n<td>\x3c/td>\n\x3c/tr>\n\x3c/table>\n<pre>\n1. is a string pattern match i.e. the 'text' attribute should end with the string 'foobar'\n2. is a regular expression match i.e. the regexp 'f.*ar' should be within the 'text' attribute\n3. is a boolead match i.e. the 'enabled' attribute should be True\n\x3c/pre>\n<p><i><b>NOTE: \x3c/b>\x3c/i> On Android the supported attribute names are hard-coded in the <a href=\"https://github.com/appium/appium/blob/master/lib/devices/android/bootstrap/src/io/appium/android/bootstrap/AndroidElement.java\">AndroidElement\x3c/a> Class's getBoolAttribute() and getStringAttribute() methods. Currently supported (appium v1.4.11): <i>contentDescription, text, className, resourceId, enabled, checkable, checked, clickable, focusable, focused, longClickable, scrollable, selected, displayed\x3c/i>\x3c/p>\n<p><i><b>NOTE: \x3c/b>\x3c/i> Some attributes can be evaluated in two different ways e.g. these evaluate the same thing:\x3c/p>\n<table border=\"1\">\n<tr>\n<td>Element Attribute Should Match\x3c/td>\n<td>xpath = //*[contains(@text,'example text')]\x3c/td>\n<td>name\x3c/td>\n<td>txt_field_name\x3c/td>\n\x3c/tr>\n<tr>\n<td>Element Name Should Be\x3c/td>\n<td>xpath = //*[contains(@text,'example text')]\x3c/td>\n<td>txt_field_name\x3c/td>\n<td>\x3c/td>\n\x3c/tr>\n\x3c/table>","matched":true,"name":"Element Attribute Should Match","shortdoc":"Verify that an attribute of an element matches the expected criteria.","tags":[]},{"args":["locator","expected"],"doc":"","matched":true,"name":"Element Name Should Be","shortdoc":"","tags":[]},{"args":["locator","loglevel=INFO"],"doc":"<p>Verifies that element identified with locator is disabled.\x3c/p>\n<p>Key attributes for arbitrary elements are <span class=\"name\">id\x3c/span> and <span class=\"name\">name\x3c/span>. See <a href=\"#Introduction\" class=\"name\">introduction\x3c/a> for details about locating elements.\x3c/p>","matched":true,"name":"Element Should Be Disabled","shortdoc":"Verifies that element identified with locator is disabled.","tags":[]},{"args":["locator","loglevel=INFO"],"doc":"<p>Verifies that element identified with locator is enabled.\x3c/p>\n<p>Key attributes for arbitrary elements are <span class=\"name\">id\x3c/span> and <span class=\"name\">name\x3c/span>. See <a href=\"#Introduction\" class=\"name\">introduction\x3c/a> for details about locating elements.\x3c/p>","matched":true,"name":"Element Should Be Enabled","shortdoc":"Verifies that element identified with locator is enabled.","tags":[]},{"args":["locator","expected","message="],"doc":"<p>Verifies element identified by <code>locator\x3c/code> contains text <code>expected\x3c/code>.\x3c/p>\n<p>If you wish to assert an exact (not a substring) match on the text of the element, use <a href=\"#Element%20Text%20Should%20Be\" class=\"name\">Element Text Should Be\x3c/a>.\x3c/p>\n<p>Key attributes for arbitrary elements are <code>id\x3c/code> and <code>xpath\x3c/code>. <code>message\x3c/code> can be used to override the default error message.\x3c/p>\n<p>New in AppiumLibrary 1.4.\x3c/p>","matched":true,"name":"Element Should Contain Text","shortdoc":"Verifies element identified by ``locator`` contains text ``expected``.","tags":[]},{"args":["locator","expected","message="],"doc":"<p>Verifies element identified by <code>locator\x3c/code> does not contain text <code>expected\x3c/code>.\x3c/p>\n<p><code>message\x3c/code> can be used to override the default error message. See <a href=\"#Element%20Should%20Contain%20Text\" class=\"name\">Element Should Contain Text\x3c/a> for more details.\x3c/p>","matched":true,"name":"Element Should Not Contain Text","shortdoc":"Verifies element identified by ``locator`` does not contain text ``expected``.","tags":[]},{"args":["locator","expected","message="],"doc":"<p>Verifies element identified by <code>locator\x3c/code> exactly contains text <code>expected\x3c/code>.\x3c/p>\n<p>In contrast to <a href=\"#Element%20Should%20Contain%20Text\" class=\"name\">Element Should Contain Text\x3c/a>, this keyword does not try a substring match but an exact match on the element identified by <code>locator\x3c/code>.\x3c/p>\n<p><code>message\x3c/code> can be used to override the default error message.\x3c/p>\n<p>New in AppiumLibrary 1.4.\x3c/p>","matched":true,"name":"Element Text Should Be","shortdoc":"Verifies element identified by ``locator`` exactly contains text ``expected``.","tags":[]},{"args":["locator","expected"],"doc":"","matched":true,"name":"Element Value Should Be","shortdoc":"","tags":[]},{"args":[],"doc":"<p>Gets the timeout in seconds that is used by various keywords.\x3c/p>\n<p>See <a href=\"#Set%20Appium%20Timeout\" class=\"name\">Set Appium Timeout\x3c/a> for an explanation.\x3c/p>","matched":true,"name":"Get Appium Timeout","shortdoc":"Gets the timeout in seconds that is used by various keywords.","tags":[]},{"args":[],"doc":"<p>Get available contexts.\x3c/p>","matched":true,"name":"Get Contexts","shortdoc":"Get available contexts.","tags":[]},{"args":[],"doc":"<p>Get current context.\x3c/p>","matched":true,"name":"Get Current Context","shortdoc":"Get current context.","tags":[]},{"args":["locator","attribute"],"doc":"<p>Get element attribute using given attribute: name, value,...\x3c/p>\n<p>Examples:\x3c/p>\n<table border=\"1\">\n<tr>\n<td>Get Element Attribute\x3c/td>\n<td>locator\x3c/td>\n<td>name\x3c/td>\n\x3c/tr>\n<tr>\n<td>Get Element Attribute\x3c/td>\n<td>locator\x3c/td>\n<td>value\x3c/td>\n\x3c/tr>\n\x3c/table>","matched":true,"name":"Get Element Attribute","shortdoc":"Get element attribute using given attribute: name, value,...","tags":[]},{"args":["locator"],"doc":"<p>Get element location\x3c/p>\n<p>Key attributes for arbitrary elements are <span class=\"name\">id\x3c/span> and <span class=\"name\">name\x3c/span>. See <a href=\"#Introduction\" class=\"name\">introduction\x3c/a> for details about locating elements.\x3c/p>","matched":true,"name":"Get Element Location","shortdoc":"Get element location","tags":[]},{"args":["locator"],"doc":"<p>Get element size\x3c/p>\n<p>Key attributes for arbitrary elements are <span class=\"name\">id\x3c/span> and <span class=\"name\">name\x3c/span>. See <a href=\"#Introduction\" class=\"name\">introduction\x3c/a> for details about locating elements.\x3c/p>","matched":true,"name":"Get Element Size","shortdoc":"Get element size","tags":[]},{"args":["xpath"],"doc":"<p>Returns number of elements matching <code>xpath\x3c/code>\x3c/p>\n<p>One should not use the <span class=\"name\">xpath=\x3c/span> prefix for 'xpath'. XPath is assumed.\x3c/p>\n<table border=\"1\">\n<tr>\n<td><b>Correct:\x3c/b>\x3c/td>\n<td>\x3c/td>\n<td>\x3c/td>\n\x3c/tr>\n<tr>\n<td>${count}\x3c/td>\n<td>Get Matching Xpath Count\x3c/td>\n<td>//android.view.View[@text='Test']\x3c/td>\n\x3c/tr>\n<tr>\n<td>Incorrect:\x3c/td>\n<td>\x3c/td>\n<td>\x3c/td>\n\x3c/tr>\n<tr>\n<td>${count}\x3c/td>\n<td>Get Matching Xpath Count\x3c/td>\n<td>xpath=//android.view.View[@text='Test']\x3c/td>\n\x3c/tr>\n\x3c/table>\n<p>If you wish to assert the number of matching elements, use <a href=\"#Xpath%20Should%20Match%20X%20Times\" class=\"name\">Xpath Should Match X Times\x3c/a>.\x3c/p>\n<p>New in AppiumLibrary 1.4.\x3c/p>","matched":true,"name":"Get Matching Xpath Count","shortdoc":"Returns number of elements matching ``xpath``","tags":[]},{"args":[],"doc":"<p>Returns an integer bitmask specifying the network connection type.\x3c/p>\n<p>Android only.\x3c/p>\n<p>See <a href=\"#Set%20Network%20Connection%20Status\" class=\"name\">set network connection status\x3c/a> for more details.\x3c/p>","matched":true,"name":"Get Network Connection Status","shortdoc":"Returns an integer bitmask specifying the network connection type.","tags":[]},{"args":[],"doc":"<p>Returns the entire source of the current page.\x3c/p>","matched":true,"name":"Get Source","shortdoc":"Returns the entire source of the current page.","tags":[]},{"args":["locator"],"doc":"<p>Get element text (for hybrid and mobile browser use <span class=\"name\">xpath\x3c/span> locator, others might cause problem)\x3c/p>\n<p>Example:\x3c/p>\n<table border=\"1\">\n<tr>\n<td>${text}\x3c/td>\n<td>Get Text\x3c/td>\n<td>//*[contains(@text,'foo')]\x3c/td>\n\x3c/tr>\n\x3c/table>\n<p>New in AppiumLibrary 1.4.\x3c/p>","matched":true,"name":"Get Text","shortdoc":"Get element text (for hybrid and mobile browser use `xpath` locator, others might cause problem)","tags":[]},{"args":["locator"],"doc":"<p>Returns the first <a href=\"http://selenium-python.readthedocs.io/api.html#module-selenium.webdriver.remote.webelement\">WebElement\x3c/a> object matching <code>locator\x3c/code>.\x3c/p>\n<p>Example:\x3c/p>\n<table border=\"1\">\n<tr>\n<td>${element}\x3c/td>\n<td>Get Webelement\x3c/td>\n<td>id=my_element\x3c/td>\n\x3c/tr>\n<tr>\n<td>Click Element\x3c/td>\n<td>${element}\x3c/td>\n<td>\x3c/td>\n\x3c/tr>\n\x3c/table>\n<p>New in AppiumLibrary 1.4.\x3c/p>","matched":true,"name":"Get Webelement","shortdoc":"Returns the first [http://selenium-python.readthedocs.io/api.html#module-selenium.webdriver.remote.webelement|WebElement] object matching ``locator``.","tags":[]},{"args":["locator"],"doc":"<p>Returns list of <a href=\"http://selenium-python.readthedocs.io/api.html#module-selenium.webdriver.remote.webelement\">WebElement\x3c/a> objects matching <code>locator\x3c/code>.\x3c/p>\n<p>Example:\x3c/p>\n<table border=\"1\">\n<tr>\n<td>@{elements}\x3c/td>\n<td>Get Webelements\x3c/td>\n<td>id=my_element\x3c/td>\n\x3c/tr>\n<tr>\n<td>Click Element\x3c/td>\n<td>@{elements}[2]\x3c/td>\n<td>\x3c/td>\n\x3c/tr>\n\x3c/table>\n<p>This keyword was changed in AppiumLibrary 1.4 in following ways:\x3c/p>\n<ul>\n<li>Name is changed from <span class=\"name\">Get Elements\x3c/span> to current one.\x3c/li>\n<li>Deprecated argument <code>fail_on_error\x3c/code>, use <span class=\"name\">Run Keyword and Ignore Error\x3c/span> if necessary.\x3c/li>\n\x3c/ul>\n<p>New in AppiumLibrary 1.4.\x3c/p>","matched":true,"name":"Get Webelements","shortdoc":"Returns list of [http://selenium-python.readthedocs.io/api.html#module-selenium.webdriver.remote.webelement|WebElement] objects matching ``locator``.","tags":[]},{"args":[],"doc":"<p>Goes one step backward in the browser history.\x3c/p>","matched":true,"name":"Go Back","shortdoc":"Goes one step backward in the browser history.","tags":[]},{"args":["url"],"doc":"<p>Opens URL in default web browser.\x3c/p>\n<p>Example:\x3c/p>\n<table border=\"1\">\n<tr>\n<td>Open Application\x3c/td>\n<td><a href=\"http://localhost:4755/wd/hub\">http://localhost:4755/wd/hub\x3c/a>\x3c/td>\n<td>platformName=iOS\x3c/td>\n<td>platformVersion=7.0\x3c/td>\n<td>deviceName='iPhone Simulator'\x3c/td>\n<td>browserName=Safari\x3c/td>\n\x3c/tr>\n<tr>\n<td>Go To URL\x3c/td>\n<td><a href=\"http://m.webapp.com\">http://m.webapp.com\x3c/a>\x3c/td>\n<td>\x3c/td>\n<td>\x3c/td>\n<td>\x3c/td>\n<td>\x3c/td>\n\x3c/tr>\n\x3c/table>","matched":true,"name":"Go To Url","shortdoc":"Opens URL in default web browser.","tags":[]},{"args":["key_name=None"],"doc":"<p>Hides the software keyboard on the device. (optional) In iOS, use <span class=\"name\">key_name\x3c/span> to press a particular key, ex. <span class=\"name\">Done\x3c/span>. In Android, no parameters are used.\x3c/p>","matched":true,"name":"Hide Keyboard","shortdoc":"Hides the software keyboard on the device. (optional) In iOS, use `key_name` to press","tags":[]},{"args":["locator","text"],"doc":"<p>Types the given password into text field identified by <span class=\"name\">locator\x3c/span>.\x3c/p>\n<p>Difference between this keyword and <a href=\"#Input%20Text\" class=\"name\">Input Text\x3c/a> is that this keyword does not log the given password. See <a href=\"#Introduction\" class=\"name\">introduction\x3c/a> for details about locating elements.\x3c/p>","matched":true,"name":"Input Password","shortdoc":"Types the given password into text field identified by `locator`.","tags":[]},{"args":["locator","text"],"doc":"<p>Types the given <span class=\"name\">text\x3c/span> into text field identified by <span class=\"name\">locator\x3c/span>.\x3c/p>\n<p>See <a href=\"#Introduction\" class=\"name\">introduction\x3c/a> for details about locating elements.\x3c/p>","matched":true,"name":"Input Text","shortdoc":"Types the given `text` into text field identified by `locator`.","tags":[]},{"args":["locator","text"],"doc":"<p>Sets the given value into text field identified by <span class=\"name\">locator\x3c/span>. This is an IOS only keyword, input value makes use of set_value\x3c/p>\n<p>See <a href=\"#Introduction\" class=\"name\">introduction\x3c/a> for details about locating elements.\x3c/p>","matched":true,"name":"Input Value","shortdoc":"Sets the given value into text field identified by `locator`. This is an IOS only keyword, input value makes use of set_value","tags":[]},{"args":[],"doc":"<p>Set the device orientation to LANDSCAPE\x3c/p>","matched":true,"name":"Landscape","shortdoc":"Set the device orientation to LANDSCAPE","tags":[]},{"args":["seconds=5"],"doc":"<p>Lock the device for a certain period of time. iOS only.\x3c/p>","matched":true,"name":"Lock","shortdoc":"Lock the device for a certain period of time. iOS only.","tags":[]},{"args":["loglevel=INFO"],"doc":"<p>Logs and returns the entire html source of the current page or frame.\x3c/p>\n<p>The <span class=\"name\">loglevel\x3c/span> argument defines the used log level. Valid log levels are <span class=\"name\">WARN\x3c/span>, <span class=\"name\">INFO\x3c/span> (default), <span class=\"name\">DEBUG\x3c/span>, <span class=\"name\">TRACE\x3c/span> and <span class=\"name\">NONE\x3c/span> (no logging).\x3c/p>","matched":true,"name":"Log Source","shortdoc":"Logs and returns the entire html source of the current page or frame.","tags":[]},{"args":["locator"],"doc":"<p>Long press the element\x3c/p>","matched":true,"name":"Long Press","shortdoc":"Long press the element","tags":[]},{"args":["keycode","metastate=None"],"doc":"<p>Sends a long press of keycode to the device.\x3c/p>\n<p>Android only.\x3c/p>\n<p>See <a href=\"#Press%20Keycode\" class=\"name\">press keycode\x3c/a> for more details.\x3c/p>","matched":true,"name":"Long Press Keycode","shortdoc":"Sends a long press of keycode to the device.","tags":[]},{"args":["remote_url","alias=None","**kwargs"],"doc":"<p>Opens a new application to given Appium server. Capabilities of appium server, Android and iOS, Please check <a href=\"http://appium.io/slate/en/master/?python#appium-server-capabilities\">http://appium.io/slate/en/master/?python#appium-server-capabilities\x3c/a>\x3c/p>\n<table border=\"1\">\n<tr>\n<td><b>Option\x3c/b>\x3c/td>\n<td><b>Man.\x3c/b>\x3c/td>\n<td><b>Description\x3c/b>\x3c/td>\n\x3c/tr>\n<tr>\n<td>remote_url\x3c/td>\n<td>Yes\x3c/td>\n<td>Appium server url\x3c/td>\n\x3c/tr>\n<tr>\n<td>alias\x3c/td>\n<td>no\x3c/td>\n<td>alias\x3c/td>\n\x3c/tr>\n\x3c/table>\n<p>Examples:\x3c/p>\n<table border=\"1\">\n<tr>\n<td>Open Application\x3c/td>\n<td><a href=\"http://localhost:4723/wd/hub\">http://localhost:4723/wd/hub\x3c/a>\x3c/td>\n<td>alias=Myapp1\x3c/td>\n<td>platformName=iOS\x3c/td>\n<td>platformVersion=7.0\x3c/td>\n<td>deviceName='iPhone Simulator'\x3c/td>\n<td>app=your.app\x3c/td>\n<td>\x3c/td>\n\x3c/tr>\n<tr>\n<td>Open Application\x3c/td>\n<td><a href=\"http://localhost:4723/wd/hub\">http://localhost:4723/wd/hub\x3c/a>\x3c/td>\n<td>platformName=Android\x3c/td>\n<td>platformVersion=4.2.2\x3c/td>\n<td>deviceName=192.168.56.101:5555\x3c/td>\n<td>app=${CURDIR}/demoapp/OrangeDemoApp.apk\x3c/td>\n<td>appPackage=com.netease.qa.orangedemo\x3c/td>\n<td>appActivity=MainActivity\x3c/td>\n\x3c/tr>\n\x3c/table>","matched":true,"name":"Open Application","shortdoc":"Opens a new application to given Appium server.","tags":[]},{"args":["locator","loglevel=INFO"],"doc":"<p>Verifies that current page contains <span class=\"name\">locator\x3c/span> element.\x3c/p>\n<p>If this keyword fails, it automatically logs the page source using the log level specified with the optional <span class=\"name\">loglevel\x3c/span> argument. Giving <span class=\"name\">NONE\x3c/span> as level disables logging.\x3c/p>","matched":true,"name":"Page Should Contain Element","shortdoc":"Verifies that current page contains `locator` element.","tags":[]},{"args":["text","loglevel=INFO"],"doc":"<p>Verifies that current page contains <span class=\"name\">text\x3c/span>.\x3c/p>\n<p>If this keyword fails, it automatically logs the page source using the log level specified with the optional <span class=\"name\">loglevel\x3c/span> argument. Giving <span class=\"name\">NONE\x3c/span> as level disables logging.\x3c/p>","matched":true,"name":"Page Should Contain Text","shortdoc":"Verifies that current page contains `text`.","tags":[]},{"args":["locator","loglevel=INFO"],"doc":"<p>Verifies that current page not contains <span class=\"name\">locator\x3c/span> element.\x3c/p>\n<p>If this keyword fails, it automatically logs the page source using the log level specified with the optional <span class=\"name\">loglevel\x3c/span> argument. Giving <span class=\"name\">NONE\x3c/span> as level disables logging.\x3c/p>","matched":true,"name":"Page Should Not Contain Element","shortdoc":"Verifies that current page not contains `locator` element.","tags":[]},{"args":["text","loglevel=INFO"],"doc":"<p>Verifies that current page not contains <span class=\"name\">text\x3c/span>.\x3c/p>\n<p>If this keyword fails, it automatically logs the page source using the log level specified with the optional <span class=\"name\">loglevel\x3c/span> argument. Giving <span class=\"name\">NONE\x3c/span> as level disables logging.\x3c/p>","matched":true,"name":"Page Should Not Contain Text","shortdoc":"Verifies that current page not contains `text`.","tags":[]},{"args":["locator","percent=200%","steps=1"],"doc":"<p>Pinch in on an element a certain amount.\x3c/p>","matched":true,"name":"Pinch","shortdoc":"Pinch in on an element a certain amount.","tags":[]},{"args":[],"doc":"<p>Set the device orientation to PORTRAIT\x3c/p>","matched":true,"name":"Portrait","shortdoc":"Set the device orientation to PORTRAIT","tags":[]},{"args":["keycode","metastate=None"],"doc":"<p>Sends a press of keycode to the device.\x3c/p>\n<p>Android only.\x3c/p>\n<p>Possible keycodes &amp; meta states can be found in <a href=\"http://developer.android.com/reference/android/view/KeyEvent.html\">http://developer.android.com/reference/android/view/KeyEvent.html\x3c/a>\x3c/p>\n<p>Meta state describe the pressed state of key modifiers such as Shift, Ctrl &amp; Alt keys. The Meta State is an integer in which each bit set to 1 represents a pressed meta key.\x3c/p>\n<p>For example\x3c/p>\n<ul>\n<li>META_SHIFT_ON = 1\x3c/li>\n<li>META_ALT_ON = 2\x3c/li>\n\x3c/ul>\n<pre>\nmetastate=1 --&gt; Shift is pressed\nmetastate=2 --&gt; Alt is pressed\nmetastate=3 --&gt; Shift+Alt is pressed\n\x3c/pre>\n<ul>\n<li>_keycode- - the keycode to be sent to the device\x3c/li>\n<li>_metastate- - status of the meta keys\x3c/li>\n\x3c/ul>","matched":true,"name":"Press Keycode","shortdoc":"Sends a press of keycode to the device.","tags":[]},{"args":["path","decode=False"],"doc":"<p>Retrieves the file at <span class=\"name\">path\x3c/span> and return it's content.\x3c/p>\n<p>Android only.\x3c/p>\n<ul>\n<li><i>path\x3c/i> - the path to the file on the device\x3c/li>\n<li><i>decode\x3c/i> - True/False decode the data (base64) before returning it (default=False)\x3c/li>\n\x3c/ul>","matched":true,"name":"Pull File","shortdoc":"Retrieves the file at `path` and return it's content.","tags":[]},{"args":["path","decode=False"],"doc":"<p>Retrieves a folder at <span class=\"name\">path\x3c/span>. Returns the folder's contents zipped.\x3c/p>\n<p>Android only.\x3c/p>\n<ul>\n<li><i>path\x3c/i> - the path to the folder on the device\x3c/li>\n<li><i>decode\x3c/i> - True/False decode the data (base64) before returning it (default=False)\x3c/li>\n\x3c/ul>","matched":true,"name":"Pull Folder","shortdoc":"Retrieves a folder at `path`. Returns the folder's contents zipped.","tags":[]},{"args":["path","data","encode=False"],"doc":"<p>Puts the data in the file specified as <span class=\"name\">path\x3c/span>.\x3c/p>\n<p>Android only.\x3c/p>\n<ul>\n<li><i>path\x3c/i> - the path on the device\x3c/li>\n<li><i>data\x3c/i> - data to be written to the file\x3c/li>\n<li><i>encode\x3c/i> - True/False encode the data as base64 before writing it to the file (default=False)\x3c/li>\n\x3c/ul>","matched":true,"name":"Push File","shortdoc":"Puts the data in the file specified as `path`.","tags":[]},{"args":["keyword"],"doc":"<p>Sets the keyword to execute when a AppiumLibrary keyword fails.\x3c/p>\n<p><span class=\"name\">keyword_name\x3c/span> is the name of a keyword (from any available libraries) that  will be executed if a AppiumLibrary keyword fails. It is not possible to use a keyword that requires arguments. Using the value \"Nothing\" will disable this feature altogether.\x3c/p>\n<p>The initial keyword to use is set in <a href=\"#Importing\" class=\"name\">importing\x3c/a>, and the keyword that is used by default is <a href=\"#Capture%20Page%20Screenshot\" class=\"name\">Capture Page Screenshot\x3c/a>. Taking a screenshot when something failed is a very useful feature, but notice that it can slow down the execution.\x3c/p>\n<p>This keyword returns the name of the previously registered failure keyword. It can be used to restore the original value later.\x3c/p>\n<p>Example:\x3c/p>\n<table border=\"1\">\n<tr>\n<td>Register Keyword To Run On Failure\x3c/td>\n<td>Log Source\x3c/td>\n<td># Run <a href=\"#Log%20Source\" class=\"name\">Log Source\x3c/a> on failure.\x3c/td>\n<td>\x3c/td>\n\x3c/tr>\n<tr>\n<td>${previous kw}=\x3c/td>\n<td>Register Keyword To Run On Failure\x3c/td>\n<td>Nothing\x3c/td>\n<td># Disables run-on-failure functionality and stores the previous kw name in a variable.\x3c/td>\n\x3c/tr>\n<tr>\n<td>Register Keyword To Run On Failure\x3c/td>\n<td>${previous kw}\x3c/td>\n<td># Restore to the previous keyword.\x3c/td>\n<td>\x3c/td>\n\x3c/tr>\n\x3c/table>\n<p>This run-on-failure functionality only works when running tests on Python/Jython 2.4 or newer and it does not work on IronPython at all.\x3c/p>","matched":true,"name":"Register Keyword To Run On Failure","shortdoc":"Sets the keyword to execute when a AppiumLibrary keyword fails.","tags":[]},{"args":["application_id"],"doc":"<p>Removes the application that is identified with an application id\x3c/p>\n<p>Example:\x3c/p>\n<table border=\"1\">\n<tr>\n<td>Remove Application\x3c/td>\n<td>com.netease.qa.orangedemo\x3c/td>\n\x3c/tr>\n\x3c/table>","matched":true,"name":"Remove Application","shortdoc":"Removes the application that is identified with an application id","tags":[]},{"args":[],"doc":"<p>Reset application\x3c/p>","matched":true,"name":"Reset Application","shortdoc":"Reset application","tags":[]},{"args":["start_locator","end_locator"],"doc":"<p>Scrolls from one element to another Key attributes for arbitrary elements are <span class=\"name\">id\x3c/span> and <span class=\"name\">name\x3c/span>. See <a href=\"#Introduction\" class=\"name\">introduction\x3c/a> for details about locating elements.\x3c/p>","matched":true,"name":"Scroll","shortdoc":"Scrolls from one element to another","tags":[]},{"args":["locator"],"doc":"<p>Scrolls down to element\x3c/p>","matched":true,"name":"Scroll Down","shortdoc":"Scrolls down to element","tags":[]},{"args":["locator"],"doc":"<p>Scrolls up to element\x3c/p>","matched":true,"name":"Scroll Up","shortdoc":"Scrolls up to element","tags":[]},{"args":["seconds"],"doc":"<p>Sets the timeout in seconds used by various keywords.\x3c/p>\n<p>There are several <span class=\"name\">Wait ...\x3c/span> keywords that take timeout as an argument. All of these timeout arguments are optional. The timeout used by all of them can be set globally using this keyword.\x3c/p>\n<p>The previous timeout value is returned by this keyword and can be used to set the old value back later. The default timeout is 5 seconds, but it can be altered in <a href=\"#Importing\" class=\"name\">importing\x3c/a>.\x3c/p>\n<p>Example:\x3c/p>\n<table border=\"1\">\n<tr>\n<td>${orig timeout} =\x3c/td>\n<td>Set Appium Timeout\x3c/td>\n<td>15 seconds\x3c/td>\n\x3c/tr>\n<tr>\n<td>Open page that loads slowly\x3c/td>\n<td>\x3c/td>\n<td>\x3c/td>\n\x3c/tr>\n<tr>\n<td>Set Appium Timeout\x3c/td>\n<td>${orig timeout}\x3c/td>\n<td>\x3c/td>\n\x3c/tr>\n\x3c/table>","matched":true,"name":"Set Appium Timeout","shortdoc":"Sets the timeout in seconds used by various keywords.","tags":[]},{"args":["connectionStatus"],"doc":"<p>Sets the network connection Status.\x3c/p>\n<p>Android only.\x3c/p>\n<p>Possible values:\x3c/p>\n<table border=\"1\">\n<tr>\n<th>Value\x3c/th>\n<th>Alias\x3c/th>\n<th>Data\x3c/th>\n<th>Wifi\x3c/th>\n<th>Airplane Mode\x3c/th>\n\x3c/tr>\n<tr>\n<td>0\x3c/td>\n<td>(None)\x3c/td>\n<td>0\x3c/td>\n<td>0\x3c/td>\n<td>0\x3c/td>\n\x3c/tr>\n<tr>\n<td>1\x3c/td>\n<td>(Airplane Mode)\x3c/td>\n<td>0\x3c/td>\n<td>0\x3c/td>\n<td>1\x3c/td>\n\x3c/tr>\n<tr>\n<td>2\x3c/td>\n<td>(Wifi only)\x3c/td>\n<td>0\x3c/td>\n<td>1\x3c/td>\n<td>0\x3c/td>\n\x3c/tr>\n<tr>\n<td>4\x3c/td>\n<td>(Data only)\x3c/td>\n<td>1\x3c/td>\n<td>0\x3c/td>\n<td>0\x3c/td>\n\x3c/tr>\n<tr>\n<td>6\x3c/td>\n<td>(All network on)\x3c/td>\n<td>1\x3c/td>\n<td>1\x3c/td>\n<td>0\x3c/td>\n\x3c/tr>\n\x3c/table>","matched":true,"name":"Set Network Connection Status","shortdoc":"Sets the network connection Status.","tags":[]},{"args":[],"doc":"<p>Shake the device\x3c/p>","matched":true,"name":"Shake","shortdoc":"Shake the device","tags":[]},{"args":["start_x","start_y","offset_x","offset_y","duration=1000"],"doc":"<p>Swipe from one point to another point, for an optional duration.\x3c/p>\n<p>Args:\x3c/p>\n<ul>\n<li>start_x - x-coordinate at which to start\x3c/li>\n<li>start_y - y-coordinate at which to start\x3c/li>\n<li>offset_x - x-coordinate distance from start_x at which to stop\x3c/li>\n<li>offset_y - y-coordinate distance from start_y at which to stop\x3c/li>\n<li>duration - (optional) time to take the swipe, in ms.\x3c/li>\n\x3c/ul>\n<p>Usage:\x3c/p>\n<table border=\"1\">\n<tr>\n<td>Swipe\x3c/td>\n<td>500\x3c/td>\n<td>100\x3c/td>\n<td>100\x3c/td>\n<td>0\x3c/td>\n<td>1000\x3c/td>\n\x3c/tr>\n\x3c/table>\n<p><b>!Important Note:\x3c/b> Android <a href=\"#Swipe\" class=\"name\">Swipe\x3c/a> is not working properly, use <code>offset_x\x3c/code> and <code>offset_y\x3c/code> as if these are destination points.\x3c/p>","matched":true,"name":"Swipe","shortdoc":"Swipe from one point to another point, for an optional duration.","tags":[]},{"args":["index_or_alias"],"doc":"<p>Switches the active application by index or alias.\x3c/p>\n<p><span class=\"name\">index_or_alias\x3c/span> is either application index (an integer) or alias (a string). Index is got as the return value of <a href=\"#Open%20Application\" class=\"name\">Open Application\x3c/a>.\x3c/p>\n<p>This keyword returns the index of the previous active application, which can be used to switch back to that application later.\x3c/p>\n<p>Example:\x3c/p>\n<table border=\"1\">\n<tr>\n<td>${appium1}=\x3c/td>\n<td>Open Application\x3c/td>\n<td><a href=\"http://localhost:4723/wd/hub\">http://localhost:4723/wd/hub\x3c/a>\x3c/td>\n<td>alias=MyApp1\x3c/td>\n<td>platformName=iOS\x3c/td>\n<td>platformVersion=7.0\x3c/td>\n<td>deviceName='iPhone Simulator'\x3c/td>\n<td>app=your.app\x3c/td>\n\x3c/tr>\n<tr>\n<td>${appium2}=\x3c/td>\n<td>Open Application\x3c/td>\n<td><a href=\"http://localhost:4755/wd/hub\">http://localhost:4755/wd/hub\x3c/a>\x3c/td>\n<td>alias=MyApp2\x3c/td>\n<td>platformName=iOS\x3c/td>\n<td>platformVersion=7.0\x3c/td>\n<td>deviceName='iPhone Simulator'\x3c/td>\n<td>app=your.app\x3c/td>\n\x3c/tr>\n<tr>\n<td>Click Element\x3c/td>\n<td>sendHello\x3c/td>\n<td># Executed on appium running at localhost:4755\x3c/td>\n<td>\x3c/td>\n<td>\x3c/td>\n<td>\x3c/td>\n<td>\x3c/td>\n<td>\x3c/td>\n\x3c/tr>\n<tr>\n<td>Switch Application\x3c/td>\n<td>${appium1}\x3c/td>\n<td># Switch using index\x3c/td>\n<td>\x3c/td>\n<td>\x3c/td>\n<td>\x3c/td>\n<td>\x3c/td>\n<td>\x3c/td>\n\x3c/tr>\n<tr>\n<td>Click Element\x3c/td>\n<td>ackHello\x3c/td>\n<td># Executed on appium running at localhost:4723\x3c/td>\n<td>\x3c/td>\n<td>\x3c/td>\n<td>\x3c/td>\n<td>\x3c/td>\n<td>\x3c/td>\n\x3c/tr>\n<tr>\n<td>Switch Application\x3c/td>\n<td>MyApp2\x3c/td>\n<td># Switch using alias\x3c/td>\n<td>\x3c/td>\n<td>\x3c/td>\n<td>\x3c/td>\n<td>\x3c/td>\n<td>\x3c/td>\n\x3c/tr>\n<tr>\n<td>Page Should Contain Text\x3c/td>\n<td>ackHello Received\x3c/td>\n<td># Executed on appium running at localhost:4755\x3c/td>\n<td>\x3c/td>\n<td>\x3c/td>\n<td>\x3c/td>\n<td>\x3c/td>\n<td>\x3c/td>\n\x3c/tr>\n\x3c/table>","matched":true,"name":"Switch Application","shortdoc":"Switches the active application by index or alias.","tags":[]},{"args":["context_name"],"doc":"<p>Switch to a new context\x3c/p>","matched":true,"name":"Switch To Context","shortdoc":"Switch to a new context","tags":[]},{"args":["locator"],"doc":"<p>Tap on element\x3c/p>","matched":true,"name":"Tap","shortdoc":"Tap on element","tags":[]},{"args":["text","timeout=None","error=None"],"doc":"<p>Waits until <span class=\"name\">text\x3c/span> appears on current page.\x3c/p>\n<p>Fails if <span class=\"name\">timeout\x3c/span> expires before the text appears. See <a href=\"#Introduction\" class=\"name\">introduction\x3c/a> for more information about <span class=\"name\">timeout\x3c/span> and its default value.\x3c/p>\n<p><span class=\"name\">error\x3c/span> can be used to override the default error message.\x3c/p>\n<p>See also <a href=\"#Wait%20Until%20Page%20Does%20Not%20Contain\" class=\"name\">Wait Until Page Does Not Contain\x3c/a>, <a href=\"#Wait%20Until%20Page%20Contains%20Element\" class=\"name\">Wait Until Page Contains Element\x3c/a>, <a href=\"#Wait%20Until%20Page%20Does%20Not%20Contain%20Element\" class=\"name\">Wait Until Page Does Not Contain Element\x3c/a> and BuiltIn keyword <span class=\"name\">Wait Until Keyword Succeeds\x3c/span>.\x3c/p>","matched":true,"name":"Wait Until Page Contains","shortdoc":"Waits until `text` appears on current page.","tags":[]},{"args":["locator","timeout=None","error=None"],"doc":"<p>Waits until element specified with <span class=\"name\">locator\x3c/span> appears on current page.\x3c/p>\n<p>Fails if <span class=\"name\">timeout\x3c/span> expires before the element appears. See <a href=\"#Introduction\" class=\"name\">introduction\x3c/a> for more information about <span class=\"name\">timeout\x3c/span> and its default value.\x3c/p>\n<p><span class=\"name\">error\x3c/span> can be used to override the default error message.\x3c/p>\n<p>See also <a href=\"#Wait%20Until%20Page%20Contains\" class=\"name\">Wait Until Page Contains\x3c/a>, <a href=\"#Wait%20Until%20Page%20Does%20Not%20Contain\" class=\"name\">Wait Until Page Does Not Contain\x3c/a> <a href=\"#Wait%20Until%20Page%20Does%20Not%20Contain%20Element\" class=\"name\">Wait Until Page Does Not Contain Element\x3c/a> and BuiltIn keyword <span class=\"name\">Wait Until Keyword Succeeds\x3c/span>.\x3c/p>","matched":true,"name":"Wait Until Page Contains Element","shortdoc":"Waits until element specified with `locator` appears on current page.","tags":[]},{"args":["text","timeout=None","error=None"],"doc":"<p>Waits until <span class=\"name\">text\x3c/span> disappears from current page.\x3c/p>\n<p>Fails if <span class=\"name\">timeout\x3c/span> expires before the <span class=\"name\">text\x3c/span> disappears. See <a href=\"#Introduction\" class=\"name\">introduction\x3c/a> for more information about <span class=\"name\">timeout\x3c/span> and its default value.\x3c/p>\n<p><span class=\"name\">error\x3c/span> can be used to override the default error message.\x3c/p>\n<p>See also <a href=\"#Wait%20Until%20Page%20Contains\" class=\"name\">Wait Until Page Contains\x3c/a>, <a href=\"#Wait%20Until%20Page%20Contains%20Element\" class=\"name\">Wait Until Page Contains Element\x3c/a>, <a href=\"#Wait%20Until%20Page%20Does%20Not%20Contain%20Element\" class=\"name\">Wait Until Page Does Not Contain Element\x3c/a> and BuiltIn keyword <span class=\"name\">Wait Until Keyword Succeeds\x3c/span>.\x3c/p>","matched":true,"name":"Wait Until Page Does Not Contain","shortdoc":"Waits until `text` disappears from current page.","tags":[]},{"args":["locator","timeout=None","error=None"],"doc":"<p>Waits until element specified with <span class=\"name\">locator\x3c/span> disappears from current page.\x3c/p>\n<p>Fails if <span class=\"name\">timeout\x3c/span> expires before the element disappears. See <a href=\"#Introduction\" class=\"name\">introduction\x3c/a> for more information about <span class=\"name\">timeout\x3c/span> and its default value.\x3c/p>\n<p><span class=\"name\">error\x3c/span> can be used to override the default error message.\x3c/p>\n<p>See also <a href=\"#Wait%20Until%20Page%20Contains\" class=\"name\">Wait Until Page Contains\x3c/a>, <a href=\"#Wait%20Until%20Page%20Does%20Not%20Contain\" class=\"name\">Wait Until Page Does Not Contain\x3c/a>, <a href=\"#Wait%20Until%20Page%20Contains%20Element\" class=\"name\">Wait Until Page Contains Element\x3c/a> and BuiltIn keyword <span class=\"name\">Wait Until Keyword Succeeds\x3c/span>.\x3c/p>","matched":true,"name":"Wait Until Page Does Not Contain Element","shortdoc":"Waits until element specified with `locator` disappears from current page.","tags":[]},{"args":["xpath","count","error=None","loglevel=INFO"],"doc":"<p>Verifies that the page contains the given number of elements located by the given <code>xpath\x3c/code>.\x3c/p>\n<p>One should not use the <span class=\"name\">xpath=\x3c/span> prefix for 'xpath'. XPath is assumed.\x3c/p>\n<table border=\"1\">\n<tr>\n<td><b>Correct:\x3c/b>\x3c/td>\n<td>\x3c/td>\n<td>\x3c/td>\n\x3c/tr>\n<tr>\n<td>Xpath Should Match X Times\x3c/td>\n<td>//android.view.View[@text='Test']\x3c/td>\n<td>1\x3c/td>\n\x3c/tr>\n<tr>\n<td>Incorrect:\x3c/td>\n<td>\x3c/td>\n<td>\x3c/td>\n\x3c/tr>\n<tr>\n<td>Xpath Should Match X Times\x3c/td>\n<td>xpath=//android.view.View[@text='Test']\x3c/td>\n<td>1\x3c/td>\n\x3c/tr>\n\x3c/table>\n<p><code>error\x3c/code> can be used to override the default error message.\x3c/p>\n<p>See <a href=\"#Log%20Source\" class=\"name\">Log Source\x3c/a> for explanation about <code>loglevel\x3c/code> argument.\x3c/p>\n<p>New in AppiumLibrary 1.4.\x3c/p>","matched":true,"name":"Xpath Should Match X Times","shortdoc":"Verifies that the page contains the given number of elements located by the given ``xpath``.","tags":[]},{"args":["locator","percent=200%","steps=1"],"doc":"<p>Zooms in on an element a certain amount.\x3c/p>","matched":true,"name":"Zoom","shortdoc":"Zooms in on an element a certain amount.","tags":[]}],"name":"AppiumLibrary","named_args":true,"scope":"global","version":"1.4.0.b1"};
+libdoc = {"all_tags":[],"contains_tags":false,"doc":"<p>AppiumLibrary is a Mobile App testing library for Robot Framework.\x3c/p>\n<h2 id=\"Locating or specifying elements\">Locating or specifying elements\x3c/h2>\n<p>All keywords in AppiumLibrary that need to find an element on the page take an argument, either a <code>locator\x3c/code> or a <code>webelement\x3c/code>. <code>locator\x3c/code> is a string that describes how to locate an element using a syntax specifying different location strategies. <code>webelement\x3c/code> is a variable that holds a WebElement instance, which is a representation of the element.\x3c/p>\n<h3 id=\"Using locators\">Using locators\x3c/h3>\n<p>By default, when a locator is provided, it is matched against the key attributes of the particular element type. For iOS and Android, key attribute is <code>id\x3c/code> for all elements and locating elements is easy using just the <code>id\x3c/code>. For example:\x3c/p>\n<pre>\nClick Element    id=my_element\n\x3c/pre>\n<p>New in AppiumLibrary 1.4, <code>id\x3c/code> and <code>xpath\x3c/code> are not required to be specified, however <code>xpath\x3c/code> should start with <code>//\x3c/code> else just use <code>xpath\x3c/code> locator as explained below.\x3c/p>\n<p>For example:\x3c/p>\n<pre>\nClick Element    my_element\nWait Until Page Contains Element    //*[@type=\"android.widget.EditText\"]\n\x3c/pre>\n<p>Appium additionally supports some of the <a href=\"https://w3c.github.io/webdriver/webdriver-spec.html\">Mobile JSON Wire Protocol\x3c/a> locator strategies. It is also possible to specify the approach AppiumLibrary should take to find an element by specifying a lookup strategy with a locator prefix. Supported strategies are:\x3c/p>\n<table border=\"1\">\n<tr>\n<td><b>Strategy\x3c/b>\x3c/td>\n<td><b>Example\x3c/b>\x3c/td>\n<td><b>Description\x3c/b>\x3c/td>\n<td><b>Note\x3c/b>\x3c/td>\n\x3c/tr>\n<tr>\n<td>identifier\x3c/td>\n<td>Click Element <span class=\"name\">|\x3c/span> identifier=my_element\x3c/td>\n<td>Matches by @id attribute\x3c/td>\n<td>\x3c/td>\n\x3c/tr>\n<tr>\n<td>id\x3c/td>\n<td>Click Element <span class=\"name\">|\x3c/span> id=my_element\x3c/td>\n<td>Matches by @resource-id attribute\x3c/td>\n<td>\x3c/td>\n\x3c/tr>\n<tr>\n<td>accessibility_id\x3c/td>\n<td>Click Element <span class=\"name\">|\x3c/span> accessibility_id=button3\x3c/td>\n<td>Accessibility options utilize.\x3c/td>\n<td>\x3c/td>\n\x3c/tr>\n<tr>\n<td>xpath\x3c/td>\n<td>Click Element <span class=\"name\">|\x3c/span> xpath=//UIATableView/UIATableCell/UIAButton\x3c/td>\n<td>Matches with arbitrary XPath\x3c/td>\n<td>\x3c/td>\n\x3c/tr>\n<tr>\n<td>class\x3c/td>\n<td>Click Element <span class=\"name\">|\x3c/span> class=UIAPickerWheel\x3c/td>\n<td>Matches by class\x3c/td>\n<td>\x3c/td>\n\x3c/tr>\n<tr>\n<td>android\x3c/td>\n<td>Click Element <span class=\"name\">|\x3c/span> android=UiSelector().description('Apps')\x3c/td>\n<td>Matches by Android UI Automator\x3c/td>\n<td>\x3c/td>\n\x3c/tr>\n<tr>\n<td>ios\x3c/td>\n<td>Click Element <span class=\"name\">|\x3c/span> ios=.buttons().withName('Apps')\x3c/td>\n<td>Matches by iOS UI Automation\x3c/td>\n<td>\x3c/td>\n\x3c/tr>\n<tr>\n<td>css\x3c/td>\n<td>Click Element <span class=\"name\">|\x3c/span> css=.green_button\x3c/td>\n<td>Matches by css in webview\x3c/td>\n<td>\x3c/td>\n\x3c/tr>\n<tr>\n<td>name\x3c/td>\n<td>Click Element <span class=\"name\">|\x3c/span> name=my_element\x3c/td>\n<td>Matches by @name attribute\x3c/td>\n<td><b>Only valid\x3c/b> for Selendroid\x3c/td>\n\x3c/tr>\n\x3c/table>\n<h3 id=\"Using webelements\">Using webelements\x3c/h3>\n<p>Starting with version 1.4 of the AppiumLibrary, one can pass an argument that contains a WebElement instead of a string locator. To get a WebElement, use the new <a href=\"#Get%20Webelements\" class=\"name\">Get WebElements\x3c/a> or <a href=\"#Get%20Webelement\" class=\"name\">Get WebElement\x3c/a> keyword.\x3c/p>\n<p>For example:\x3c/p>\n<pre>\n@{elements}    Get Webelements    class=UIAButton\nClick Element    @{elements}[2]\n\x3c/pre>","generated":"2016-10-12 17:10:21","inits":[{"args":["timeout=5","run_on_failure=Capture Page Screenshot"],"doc":"<p>AppiumLibrary can be imported with optional arguments.\x3c/p>\n<p><code>timeout\x3c/code> is the default timeout used to wait for all waiting actions. It can be later set with <a href=\"#Set%20Appium%20Timeout\" class=\"name\">Set Appium Timeout\x3c/a>.\x3c/p>\n<p><code>run_on_failure\x3c/code> specifies the name of a keyword (from any available libraries) to execute when a AppiumLibrary keyword fails.\x3c/p>\n<p>By default <a href=\"#Capture%20Page%20Screenshot\" class=\"name\">Capture Page Screenshot\x3c/a> will be used to take a screenshot of the current page. Using the value <span class=\"name\">No Operation\x3c/span> will disable this feature altogether. See <a href=\"#Register%20Keyword%20To%20Run%20On%20Failure\" class=\"name\">Register Keyword To Run On Failure\x3c/a> keyword for more information about this functionality.\x3c/p>\n<p>Examples:\x3c/p>\n<table border=\"1\">\n<tr>\n<td>Library\x3c/td>\n<td>AppiumLibrary\x3c/td>\n<td>10\x3c/td>\n<td># Sets default timeout to 10 seconds\x3c/td>\n<td>\x3c/td>\n\x3c/tr>\n<tr>\n<td>Library\x3c/td>\n<td>AppiumLibrary\x3c/td>\n<td>timeout=10\x3c/td>\n<td>run_on_failure=No Operation\x3c/td>\n<td># Sets default timeout to 10 seconds and does nothing on failure\x3c/td>\n\x3c/tr>\n\x3c/table>","matched":true,"name":"Init","shortdoc":"AppiumLibrary can be imported with optional arguments.","tags":[]}],"keywords":[{"args":["seconds=5"],"doc":"<p>Puts the application in the background on the device for a certain duration.\x3c/p>","matched":true,"name":"Background App","shortdoc":"Puts the application in the background on the device for a certain","tags":[]},{"args":["filename=None"],"doc":"<p>Takes a screenshot of the current page and embeds it into the log.\x3c/p>\n<p><span class=\"name\">filename\x3c/span> argument specifies the name of the file to write the screenshot into. If no <span class=\"name\">filename\x3c/span> is given, the screenshot is saved into file <span class=\"name\">appium-screenshot-&lt;counter&gt;.png\x3c/span> under the directory where the Robot Framework log file is written into. The <span class=\"name\">filename\x3c/span> is also considered relative to the same directory, if it is not given in absolute format.\x3c/p>\n<p><span class=\"name\">css\x3c/span> can be used to modify how the screenshot is taken. By default the bakground color is changed to avoid possible problems with background leaking when the page layout is somehow broken.\x3c/p>","matched":true,"name":"Capture Page Screenshot","shortdoc":"Takes a screenshot of the current page and embeds it into the log.","tags":[]},{"args":["locator"],"doc":"<p>Clears the text field identified by <span class=\"name\">locator\x3c/span>.\x3c/p>\n<p>See <a href=\"#Introduction\" class=\"name\">introduction\x3c/a> for details about locating elements.\x3c/p>","matched":true,"name":"Clear Text","shortdoc":"Clears the text field identified by `locator`.","tags":[]},{"args":["x=0","y=0","duration=100"],"doc":"<p>Click on a point\x3c/p>","matched":true,"name":"Click A Point","shortdoc":"Click on a point","tags":[]},{"args":["index_or_name"],"doc":"<p>Click button\x3c/p>","matched":true,"name":"Click Button","shortdoc":"Click button","tags":[]},{"args":["locator"],"doc":"<p>Click element identified by <span class=\"name\">locator\x3c/span>.\x3c/p>\n<p>Key attributes for arbitrary elements are <span class=\"name\">index\x3c/span> and <span class=\"name\">name\x3c/span>. See <a href=\"#Introduction\" class=\"name\">introduction\x3c/a> for details about locating elements.\x3c/p>","matched":true,"name":"Click Element","shortdoc":"Click element identified by `locator`.","tags":[]},{"args":["coordinate_X","coordinate_Y"],"doc":"<p>click element at a certain coordinate\x3c/p>","matched":true,"name":"Click Element At Coordinates","shortdoc":"click element at a certain coordinate","tags":[]},{"args":["text","exact_match=False"],"doc":"<p>Click text identified by <code>text\x3c/code>.\x3c/p>\n<p>By default tries to click first text involves given <code>text\x3c/code>, if you would like to click exactly matching text, then set <code>exact_match\x3c/code> to <span class=\"name\">True\x3c/span>.\x3c/p>\n<p>If there are multiple use  of <code>text\x3c/code> use <span class=\"name\">locator\x3c/span> with <a href=\"#Get%20Webelements\" class=\"name\">Get Web Elements\x3c/a> instead.\x3c/p>\n<p>New in AppiumLibrary 1.4.\x3c/p>","matched":true,"name":"Click Text","shortdoc":"Click text identified by ``text``.","tags":[]},{"args":[],"doc":"<p>Closes all open applications.\x3c/p>\n<p>This keyword is meant to be used in test or suite teardown to make sure all the applications are closed before the test execution finishes.\x3c/p>\n<p>After this keyword, the application indices returned by <a href=\"#Open%20Application\" class=\"name\">Open Application\x3c/a> are reset and start from <span class=\"name\">1\x3c/span>.\x3c/p>","matched":true,"name":"Close All Applications","shortdoc":"Closes all open applications.","tags":[]},{"args":[],"doc":"<p>Closes the current application.\x3c/p>","matched":true,"name":"Close Application","shortdoc":"Closes the current application.","tags":[]},{"args":["locator","attr_name","match_pattern","regexp=False"],"doc":"<p>Verify that an attribute of an element matches the expected criteria.\x3c/p>\n<p>The element is identified by <i>locator\x3c/i>. See <a href=\"#Introduction\" class=\"name\">introduction\x3c/a> for details about locating elements. If more than one element matches, the first element is selected.\x3c/p>\n<p>The <i>attr_name\x3c/i> is the name of the attribute within the selected element.\x3c/p>\n<p>The <i>match_pattern\x3c/i> is used for the matching, if the match_pattern is\x3c/p>\n<ul>\n<li>boolean or 'True'/'true'/'False'/'false' String then a boolean match is applied\x3c/li>\n<li>any other string is cause a string match\x3c/li>\n\x3c/ul>\n<p>The <i>regexp\x3c/i> defines whether the string match is done using regular expressions (i.e. BuiltIn Library's <a href=\"http://robotframework.org/robotframework/latest/libraries/BuiltIn.html#Should%20Match%20Regexp\">Should Match Regexp\x3c/a> or string pattern match (i.e. BuiltIn Library's <a href=\"http://robotframework.org/robotframework/latest/libraries/BuiltIn.html#Should%20Match\">Should Match\x3c/a>)\x3c/p>\n<p>Examples:\x3c/p>\n<table border=\"1\">\n<tr>\n<td>Element Attribute Should Match\x3c/td>\n<td>xpath = //*[contains(@text,'foo')]\x3c/td>\n<td>text\x3c/td>\n<td>*foobar\x3c/td>\n<td>\x3c/td>\n\x3c/tr>\n<tr>\n<td>Element Attribute Should Match\x3c/td>\n<td>xpath = //*[contains(@text,'foo')]\x3c/td>\n<td>text\x3c/td>\n<td>f.*ar\x3c/td>\n<td>regexp = True\x3c/td>\n\x3c/tr>\n<tr>\n<td>Element Attribute Should Match\x3c/td>\n<td>xpath = //*[contains(@text,'foo')]\x3c/td>\n<td>enabled\x3c/td>\n<td>True\x3c/td>\n<td>\x3c/td>\n\x3c/tr>\n\x3c/table>\n<pre>\n1. is a string pattern match i.e. the 'text' attribute should end with the string 'foobar'\n2. is a regular expression match i.e. the regexp 'f.*ar' should be within the 'text' attribute\n3. is a boolead match i.e. the 'enabled' attribute should be True\n\x3c/pre>\n<p><i><b>NOTE: \x3c/b>\x3c/i> On Android the supported attribute names are hard-coded in the <a href=\"https://github.com/appium/appium/blob/master/lib/devices/android/bootstrap/src/io/appium/android/bootstrap/AndroidElement.java\">AndroidElement\x3c/a> Class's getBoolAttribute() and getStringAttribute() methods. Currently supported (appium v1.4.11): <i>contentDescription, text, className, resourceId, enabled, checkable, checked, clickable, focusable, focused, longClickable, scrollable, selected, displayed\x3c/i>\x3c/p>\n<p><i><b>NOTE: \x3c/b>\x3c/i> Some attributes can be evaluated in two different ways e.g. these evaluate the same thing:\x3c/p>\n<table border=\"1\">\n<tr>\n<td>Element Attribute Should Match\x3c/td>\n<td>xpath = //*[contains(@text,'example text')]\x3c/td>\n<td>name\x3c/td>\n<td>txt_field_name\x3c/td>\n\x3c/tr>\n<tr>\n<td>Element Name Should Be\x3c/td>\n<td>xpath = //*[contains(@text,'example text')]\x3c/td>\n<td>txt_field_name\x3c/td>\n<td>\x3c/td>\n\x3c/tr>\n\x3c/table>","matched":true,"name":"Element Attribute Should Match","shortdoc":"Verify that an attribute of an element matches the expected criteria.","tags":[]},{"args":["locator","expected"],"doc":"","matched":true,"name":"Element Name Should Be","shortdoc":"","tags":[]},{"args":["locator","loglevel=INFO"],"doc":"<p>Verifies that element identified with locator is disabled.\x3c/p>\n<p>Key attributes for arbitrary elements are <span class=\"name\">id\x3c/span> and <span class=\"name\">name\x3c/span>. See <a href=\"#Introduction\" class=\"name\">introduction\x3c/a> for details about locating elements.\x3c/p>","matched":true,"name":"Element Should Be Disabled","shortdoc":"Verifies that element identified with locator is disabled.","tags":[]},{"args":["locator","loglevel=INFO"],"doc":"<p>Verifies that element identified with locator is enabled.\x3c/p>\n<p>Key attributes for arbitrary elements are <span class=\"name\">id\x3c/span> and <span class=\"name\">name\x3c/span>. See <a href=\"#Introduction\" class=\"name\">introduction\x3c/a> for details about locating elements.\x3c/p>","matched":true,"name":"Element Should Be Enabled","shortdoc":"Verifies that element identified with locator is enabled.","tags":[]},{"args":["locator","expected","message="],"doc":"<p>Verifies element identified by <code>locator\x3c/code> contains text <code>expected\x3c/code>.\x3c/p>\n<p>If you wish to assert an exact (not a substring) match on the text of the element, use <a href=\"#Element%20Text%20Should%20Be\" class=\"name\">Element Text Should Be\x3c/a>.\x3c/p>\n<p>Key attributes for arbitrary elements are <code>id\x3c/code> and <code>xpath\x3c/code>. <code>message\x3c/code> can be used to override the default error message.\x3c/p>\n<p>New in AppiumLibrary 1.4.\x3c/p>","matched":true,"name":"Element Should Contain Text","shortdoc":"Verifies element identified by ``locator`` contains text ``expected``.","tags":[]},{"args":["locator","expected","message="],"doc":"<p>Verifies element identified by <code>locator\x3c/code> does not contain text <code>expected\x3c/code>.\x3c/p>\n<p><code>message\x3c/code> can be used to override the default error message. See <a href=\"#Element%20Should%20Contain%20Text\" class=\"name\">Element Should Contain Text\x3c/a> for more details.\x3c/p>","matched":true,"name":"Element Should Not Contain Text","shortdoc":"Verifies element identified by ``locator`` does not contain text ``expected``.","tags":[]},{"args":["locator","expected","message="],"doc":"<p>Verifies element identified by <code>locator\x3c/code> exactly contains text <code>expected\x3c/code>.\x3c/p>\n<p>In contrast to <a href=\"#Element%20Should%20Contain%20Text\" class=\"name\">Element Should Contain Text\x3c/a>, this keyword does not try a substring match but an exact match on the element identified by <code>locator\x3c/code>.\x3c/p>\n<p><code>message\x3c/code> can be used to override the default error message.\x3c/p>\n<p>New in AppiumLibrary 1.4.\x3c/p>","matched":true,"name":"Element Text Should Be","shortdoc":"Verifies element identified by ``locator`` exactly contains text ``expected``.","tags":[]},{"args":["locator","expected"],"doc":"","matched":true,"name":"Element Value Should Be","shortdoc":"","tags":[]},{"args":[],"doc":"<p>Gets the timeout in seconds that is used by various keywords.\x3c/p>\n<p>See <a href=\"#Set%20Appium%20Timeout\" class=\"name\">Set Appium Timeout\x3c/a> for an explanation.\x3c/p>","matched":true,"name":"Get Appium Timeout","shortdoc":"Gets the timeout in seconds that is used by various keywords.","tags":[]},{"args":[],"doc":"<p>Get available contexts.\x3c/p>","matched":true,"name":"Get Contexts","shortdoc":"Get available contexts.","tags":[]},{"args":[],"doc":"<p>Get current context.\x3c/p>","matched":true,"name":"Get Current Context","shortdoc":"Get current context.","tags":[]},{"args":["locator","attribute"],"doc":"<p>Get element attribute using given attribute: name, value,...\x3c/p>\n<p>Examples:\x3c/p>\n<table border=\"1\">\n<tr>\n<td>Get Element Attribute\x3c/td>\n<td>locator\x3c/td>\n<td>name\x3c/td>\n\x3c/tr>\n<tr>\n<td>Get Element Attribute\x3c/td>\n<td>locator\x3c/td>\n<td>value\x3c/td>\n\x3c/tr>\n\x3c/table>","matched":true,"name":"Get Element Attribute","shortdoc":"Get element attribute using given attribute: name, value,...","tags":[]},{"args":["locator"],"doc":"<p>Get element location\x3c/p>\n<p>Key attributes for arbitrary elements are <span class=\"name\">id\x3c/span> and <span class=\"name\">name\x3c/span>. See <a href=\"#Introduction\" class=\"name\">introduction\x3c/a> for details about locating elements.\x3c/p>","matched":true,"name":"Get Element Location","shortdoc":"Get element location","tags":[]},{"args":["locator"],"doc":"<p>Get element size\x3c/p>\n<p>Key attributes for arbitrary elements are <span class=\"name\">id\x3c/span> and <span class=\"name\">name\x3c/span>. See <a href=\"#Introduction\" class=\"name\">introduction\x3c/a> for details about locating elements.\x3c/p>","matched":true,"name":"Get Element Size","shortdoc":"Get element size","tags":[]},{"args":["xpath"],"doc":"<p>Returns number of elements matching <code>xpath\x3c/code>\x3c/p>\n<p>One should not use the <span class=\"name\">xpath=\x3c/span> prefix for 'xpath'. XPath is assumed.\x3c/p>\n<table border=\"1\">\n<tr>\n<td><b>Correct:\x3c/b>\x3c/td>\n<td>\x3c/td>\n<td>\x3c/td>\n\x3c/tr>\n<tr>\n<td>${count}\x3c/td>\n<td>Get Matching Xpath Count\x3c/td>\n<td>//android.view.View[@text='Test']\x3c/td>\n\x3c/tr>\n<tr>\n<td>Incorrect:\x3c/td>\n<td>\x3c/td>\n<td>\x3c/td>\n\x3c/tr>\n<tr>\n<td>${count}\x3c/td>\n<td>Get Matching Xpath Count\x3c/td>\n<td>xpath=//android.view.View[@text='Test']\x3c/td>\n\x3c/tr>\n\x3c/table>\n<p>If you wish to assert the number of matching elements, use <a href=\"#Xpath%20Should%20Match%20X%20Times\" class=\"name\">Xpath Should Match X Times\x3c/a>.\x3c/p>\n<p>New in AppiumLibrary 1.4.\x3c/p>","matched":true,"name":"Get Matching Xpath Count","shortdoc":"Returns number of elements matching ``xpath``","tags":[]},{"args":[],"doc":"<p>Returns an integer bitmask specifying the network connection type.\x3c/p>\n<p>Android only.\x3c/p>\n<p>See <a href=\"#Set%20Network%20Connection%20Status\" class=\"name\">set network connection status\x3c/a> for more details.\x3c/p>","matched":true,"name":"Get Network Connection Status","shortdoc":"Returns an integer bitmask specifying the network connection type.","tags":[]},{"args":[],"doc":"<p>Returns the entire source of the current page.\x3c/p>","matched":true,"name":"Get Source","shortdoc":"Returns the entire source of the current page.","tags":[]},{"args":["locator"],"doc":"<p>Get element text (for hybrid and mobile browser use <span class=\"name\">xpath\x3c/span> locator, others might cause problem)\x3c/p>\n<p>Example:\x3c/p>\n<table border=\"1\">\n<tr>\n<td>${text}\x3c/td>\n<td>Get Text\x3c/td>\n<td>//*[contains(@text,'foo')]\x3c/td>\n\x3c/tr>\n\x3c/table>\n<p>New in AppiumLibrary 1.4.\x3c/p>","matched":true,"name":"Get Text","shortdoc":"Get element text (for hybrid and mobile browser use `xpath` locator, others might cause problem)","tags":[]},{"args":["locator"],"doc":"<p>Returns the first <a href=\"http://selenium-python.readthedocs.io/api.html#module-selenium.webdriver.remote.webelement\">WebElement\x3c/a> object matching <code>locator\x3c/code>.\x3c/p>\n<p>Example:\x3c/p>\n<table border=\"1\">\n<tr>\n<td>${element}\x3c/td>\n<td>Get Webelement\x3c/td>\n<td>id=my_element\x3c/td>\n\x3c/tr>\n<tr>\n<td>Click Element\x3c/td>\n<td>${element}\x3c/td>\n<td>\x3c/td>\n\x3c/tr>\n\x3c/table>\n<p>New in AppiumLibrary 1.4.\x3c/p>","matched":true,"name":"Get Webelement","shortdoc":"Returns the first [http://selenium-python.readthedocs.io/api.html#module-selenium.webdriver.remote.webelement|WebElement] object matching ``locator``.","tags":[]},{"args":["locator"],"doc":"<p>Returns list of <a href=\"http://selenium-python.readthedocs.io/api.html#module-selenium.webdriver.remote.webelement\">WebElement\x3c/a> objects matching <code>locator\x3c/code>.\x3c/p>\n<p>Example:\x3c/p>\n<table border=\"1\">\n<tr>\n<td>@{elements}\x3c/td>\n<td>Get Webelements\x3c/td>\n<td>id=my_element\x3c/td>\n\x3c/tr>\n<tr>\n<td>Click Element\x3c/td>\n<td>@{elements}[2]\x3c/td>\n<td>\x3c/td>\n\x3c/tr>\n\x3c/table>\n<p>This keyword was changed in AppiumLibrary 1.4 in following ways:\x3c/p>\n<ul>\n<li>Name is changed from <span class=\"name\">Get Elements\x3c/span> to current one.\x3c/li>\n<li>Deprecated argument <code>fail_on_error\x3c/code>, use <span class=\"name\">Run Keyword and Ignore Error\x3c/span> if necessary.\x3c/li>\n\x3c/ul>\n<p>New in AppiumLibrary 1.4.\x3c/p>","matched":true,"name":"Get Webelements","shortdoc":"Returns list of [http://selenium-python.readthedocs.io/api.html#module-selenium.webdriver.remote.webelement|WebElement] objects matching ``locator``.","tags":[]},{"args":[],"doc":"<p>Goes one step backward in the browser history.\x3c/p>","matched":true,"name":"Go Back","shortdoc":"Goes one step backward in the browser history.","tags":[]},{"args":["url"],"doc":"<p>Opens URL in default web browser.\x3c/p>\n<p>Example:\x3c/p>\n<table border=\"1\">\n<tr>\n<td>Open Application\x3c/td>\n<td><a href=\"http://localhost:4755/wd/hub\">http://localhost:4755/wd/hub\x3c/a>\x3c/td>\n<td>platformName=iOS\x3c/td>\n<td>platformVersion=7.0\x3c/td>\n<td>deviceName='iPhone Simulator'\x3c/td>\n<td>browserName=Safari\x3c/td>\n\x3c/tr>\n<tr>\n<td>Go To URL\x3c/td>\n<td><a href=\"http://m.webapp.com\">http://m.webapp.com\x3c/a>\x3c/td>\n<td>\x3c/td>\n<td>\x3c/td>\n<td>\x3c/td>\n<td>\x3c/td>\n\x3c/tr>\n\x3c/table>","matched":true,"name":"Go To Url","shortdoc":"Opens URL in default web browser.","tags":[]},{"args":["key_name=None"],"doc":"<p>Hides the software keyboard on the device. (optional) In iOS, use <span class=\"name\">key_name\x3c/span> to press a particular key, ex. <span class=\"name\">Done\x3c/span>. In Android, no parameters are used.\x3c/p>","matched":true,"name":"Hide Keyboard","shortdoc":"Hides the software keyboard on the device. (optional) In iOS, use `key_name` to press","tags":[]},{"args":["locator","text"],"doc":"<p>Types the given password into text field identified by <span class=\"name\">locator\x3c/span>.\x3c/p>\n<p>Difference between this keyword and <a href=\"#Input%20Text\" class=\"name\">Input Text\x3c/a> is that this keyword does not log the given password. See <a href=\"#Introduction\" class=\"name\">introduction\x3c/a> for details about locating elements.\x3c/p>","matched":true,"name":"Input Password","shortdoc":"Types the given password into text field identified by `locator`.","tags":[]},{"args":["locator","text"],"doc":"<p>Types the given <span class=\"name\">text\x3c/span> into text field identified by <span class=\"name\">locator\x3c/span>.\x3c/p>\n<p>See <a href=\"#Introduction\" class=\"name\">introduction\x3c/a> for details about locating elements.\x3c/p>","matched":true,"name":"Input Text","shortdoc":"Types the given `text` into text field identified by `locator`.","tags":[]},{"args":["locator","text"],"doc":"<p>Sets the given value into text field identified by <span class=\"name\">locator\x3c/span>. This is an IOS only keyword, input value makes use of set_value\x3c/p>\n<p>See <a href=\"#Introduction\" class=\"name\">introduction\x3c/a> for details about locating elements.\x3c/p>","matched":true,"name":"Input Value","shortdoc":"Sets the given value into text field identified by `locator`. This is an IOS only keyword, input value makes use of set_value","tags":[]},{"args":[],"doc":"<p>Set the device orientation to LANDSCAPE\x3c/p>","matched":true,"name":"Landscape","shortdoc":"Set the device orientation to LANDSCAPE","tags":[]},{"args":["seconds=5"],"doc":"<p>Lock the device for a certain period of time. iOS only.\x3c/p>","matched":true,"name":"Lock","shortdoc":"Lock the device for a certain period of time. iOS only.","tags":[]},{"args":["loglevel=INFO"],"doc":"<p>Logs and returns the entire html source of the current page or frame.\x3c/p>\n<p>The <span class=\"name\">loglevel\x3c/span> argument defines the used log level. Valid log levels are <span class=\"name\">WARN\x3c/span>, <span class=\"name\">INFO\x3c/span> (default), <span class=\"name\">DEBUG\x3c/span>, <span class=\"name\">TRACE\x3c/span> and <span class=\"name\">NONE\x3c/span> (no logging).\x3c/p>","matched":true,"name":"Log Source","shortdoc":"Logs and returns the entire html source of the current page or frame.","tags":[]},{"args":["locator"],"doc":"<p>Long press the element\x3c/p>","matched":true,"name":"Long Press","shortdoc":"Long press the element","tags":[]},{"args":["keycode","metastate=None"],"doc":"<p>Sends a long press of keycode to the device.\x3c/p>\n<p>Android only.\x3c/p>\n<p>See <a href=\"#Press%20Keycode\" class=\"name\">press keycode\x3c/a> for more details.\x3c/p>","matched":true,"name":"Long Press Keycode","shortdoc":"Sends a long press of keycode to the device.","tags":[]},{"args":["remote_url","alias=None","**kwargs"],"doc":"<p>Opens a new application to given Appium server. Capabilities of appium server, Android and iOS, Please check <a href=\"http://appium.io/slate/en/master/?python#appium-server-capabilities\">http://appium.io/slate/en/master/?python#appium-server-capabilities\x3c/a>\x3c/p>\n<table border=\"1\">\n<tr>\n<td><b>Option\x3c/b>\x3c/td>\n<td><b>Man.\x3c/b>\x3c/td>\n<td><b>Description\x3c/b>\x3c/td>\n\x3c/tr>\n<tr>\n<td>remote_url\x3c/td>\n<td>Yes\x3c/td>\n<td>Appium server url\x3c/td>\n\x3c/tr>\n<tr>\n<td>alias\x3c/td>\n<td>no\x3c/td>\n<td>alias\x3c/td>\n\x3c/tr>\n\x3c/table>\n<p>Examples:\x3c/p>\n<table border=\"1\">\n<tr>\n<td>Open Application\x3c/td>\n<td><a href=\"http://localhost:4723/wd/hub\">http://localhost:4723/wd/hub\x3c/a>\x3c/td>\n<td>alias=Myapp1\x3c/td>\n<td>platformName=iOS\x3c/td>\n<td>platformVersion=7.0\x3c/td>\n<td>deviceName='iPhone Simulator'\x3c/td>\n<td>app=your.app\x3c/td>\n<td>\x3c/td>\n\x3c/tr>\n<tr>\n<td>Open Application\x3c/td>\n<td><a href=\"http://localhost:4723/wd/hub\">http://localhost:4723/wd/hub\x3c/a>\x3c/td>\n<td>platformName=Android\x3c/td>\n<td>platformVersion=4.2.2\x3c/td>\n<td>deviceName=192.168.56.101:5555\x3c/td>\n<td>app=${CURDIR}/demoapp/OrangeDemoApp.apk\x3c/td>\n<td>appPackage=com.netease.qa.orangedemo\x3c/td>\n<td>appActivity=MainActivity\x3c/td>\n\x3c/tr>\n\x3c/table>","matched":true,"name":"Open Application","shortdoc":"Opens a new application to given Appium server.","tags":[]},{"args":["locator","loglevel=INFO"],"doc":"<p>Verifies that current page contains <span class=\"name\">locator\x3c/span> element.\x3c/p>\n<p>If this keyword fails, it automatically logs the page source using the log level specified with the optional <span class=\"name\">loglevel\x3c/span> argument. Giving <span class=\"name\">NONE\x3c/span> as level disables logging.\x3c/p>","matched":true,"name":"Page Should Contain Element","shortdoc":"Verifies that current page contains `locator` element.","tags":[]},{"args":["text","loglevel=INFO"],"doc":"<p>Verifies that current page contains <span class=\"name\">text\x3c/span>.\x3c/p>\n<p>If this keyword fails, it automatically logs the page source using the log level specified with the optional <span class=\"name\">loglevel\x3c/span> argument. Giving <span class=\"name\">NONE\x3c/span> as level disables logging.\x3c/p>","matched":true,"name":"Page Should Contain Text","shortdoc":"Verifies that current page contains `text`.","tags":[]},{"args":["locator","loglevel=INFO"],"doc":"<p>Verifies that current page not contains <span class=\"name\">locator\x3c/span> element.\x3c/p>\n<p>If this keyword fails, it automatically logs the page source using the log level specified with the optional <span class=\"name\">loglevel\x3c/span> argument. Giving <span class=\"name\">NONE\x3c/span> as level disables logging.\x3c/p>","matched":true,"name":"Page Should Not Contain Element","shortdoc":"Verifies that current page not contains `locator` element.","tags":[]},{"args":["text","loglevel=INFO"],"doc":"<p>Verifies that current page not contains <span class=\"name\">text\x3c/span>.\x3c/p>\n<p>If this keyword fails, it automatically logs the page source using the log level specified with the optional <span class=\"name\">loglevel\x3c/span> argument. Giving <span class=\"name\">NONE\x3c/span> as level disables logging.\x3c/p>","matched":true,"name":"Page Should Not Contain Text","shortdoc":"Verifies that current page not contains `text`.","tags":[]},{"args":["locator","percent=200%","steps=1"],"doc":"<p>Pinch in on an element a certain amount.\x3c/p>","matched":true,"name":"Pinch","shortdoc":"Pinch in on an element a certain amount.","tags":[]},{"args":[],"doc":"<p>Set the device orientation to PORTRAIT\x3c/p>","matched":true,"name":"Portrait","shortdoc":"Set the device orientation to PORTRAIT","tags":[]},{"args":["keycode","metastate=None"],"doc":"<p>Sends a press of keycode to the device.\x3c/p>\n<p>Android only.\x3c/p>\n<p>Possible keycodes &amp; meta states can be found in <a href=\"http://developer.android.com/reference/android/view/KeyEvent.html\">http://developer.android.com/reference/android/view/KeyEvent.html\x3c/a>\x3c/p>\n<p>Meta state describe the pressed state of key modifiers such as Shift, Ctrl &amp; Alt keys. The Meta State is an integer in which each bit set to 1 represents a pressed meta key.\x3c/p>\n<p>For example\x3c/p>\n<ul>\n<li>META_SHIFT_ON = 1\x3c/li>\n<li>META_ALT_ON = 2\x3c/li>\n\x3c/ul>\n<pre>\nmetastate=1 --&gt; Shift is pressed\nmetastate=2 --&gt; Alt is pressed\nmetastate=3 --&gt; Shift+Alt is pressed\n\x3c/pre>\n<ul>\n<li>_keycode- - the keycode to be sent to the device\x3c/li>\n<li>_metastate- - status of the meta keys\x3c/li>\n\x3c/ul>","matched":true,"name":"Press Keycode","shortdoc":"Sends a press of keycode to the device.","tags":[]},{"args":["path","decode=False"],"doc":"<p>Retrieves the file at <span class=\"name\">path\x3c/span> and return it's content.\x3c/p>\n<p>Android only.\x3c/p>\n<ul>\n<li><i>path\x3c/i> - the path to the file on the device\x3c/li>\n<li><i>decode\x3c/i> - True/False decode the data (base64) before returning it (default=False)\x3c/li>\n\x3c/ul>","matched":true,"name":"Pull File","shortdoc":"Retrieves the file at `path` and return it's content.","tags":[]},{"args":["path","decode=False"],"doc":"<p>Retrieves a folder at <span class=\"name\">path\x3c/span>. Returns the folder's contents zipped.\x3c/p>\n<p>Android only.\x3c/p>\n<ul>\n<li><i>path\x3c/i> - the path to the folder on the device\x3c/li>\n<li><i>decode\x3c/i> - True/False decode the data (base64) before returning it (default=False)\x3c/li>\n\x3c/ul>","matched":true,"name":"Pull Folder","shortdoc":"Retrieves a folder at `path`. Returns the folder's contents zipped.","tags":[]},{"args":["path","data","encode=False"],"doc":"<p>Puts the data in the file specified as <span class=\"name\">path\x3c/span>.\x3c/p>\n<p>Android only.\x3c/p>\n<ul>\n<li><i>path\x3c/i> - the path on the device\x3c/li>\n<li><i>data\x3c/i> - data to be written to the file\x3c/li>\n<li><i>encode\x3c/i> - True/False encode the data as base64 before writing it to the file (default=False)\x3c/li>\n\x3c/ul>","matched":true,"name":"Push File","shortdoc":"Puts the data in the file specified as `path`.","tags":[]},{"args":["keyword"],"doc":"<p>Sets the keyword to execute when a AppiumLibrary keyword fails.\x3c/p>\n<p><span class=\"name\">keyword_name\x3c/span> is the name of a keyword (from any available libraries) that  will be executed if a AppiumLibrary keyword fails. It is not possible to use a keyword that requires arguments. Using the value \"Nothing\" will disable this feature altogether.\x3c/p>\n<p>The initial keyword to use is set in <a href=\"#Importing\" class=\"name\">importing\x3c/a>, and the keyword that is used by default is <a href=\"#Capture%20Page%20Screenshot\" class=\"name\">Capture Page Screenshot\x3c/a>. Taking a screenshot when something failed is a very useful feature, but notice that it can slow down the execution.\x3c/p>\n<p>This keyword returns the name of the previously registered failure keyword. It can be used to restore the original value later.\x3c/p>\n<p>Example:\x3c/p>\n<table border=\"1\">\n<tr>\n<td>Register Keyword To Run On Failure\x3c/td>\n<td>Log Source\x3c/td>\n<td># Run <a href=\"#Log%20Source\" class=\"name\">Log Source\x3c/a> on failure.\x3c/td>\n<td>\x3c/td>\n\x3c/tr>\n<tr>\n<td>${previous kw}=\x3c/td>\n<td>Register Keyword To Run On Failure\x3c/td>\n<td>Nothing\x3c/td>\n<td># Disables run-on-failure functionality and stores the previous kw name in a variable.\x3c/td>\n\x3c/tr>\n<tr>\n<td>Register Keyword To Run On Failure\x3c/td>\n<td>${previous kw}\x3c/td>\n<td># Restore to the previous keyword.\x3c/td>\n<td>\x3c/td>\n\x3c/tr>\n\x3c/table>\n<p>This run-on-failure functionality only works when running tests on Python/Jython 2.4 or newer and it does not work on IronPython at all.\x3c/p>","matched":true,"name":"Register Keyword To Run On Failure","shortdoc":"Sets the keyword to execute when a AppiumLibrary keyword fails.","tags":[]},{"args":["application_id"],"doc":"<p>Removes the application that is identified with an application id\x3c/p>\n<p>Example:\x3c/p>\n<table border=\"1\">\n<tr>\n<td>Remove Application\x3c/td>\n<td>com.netease.qa.orangedemo\x3c/td>\n\x3c/tr>\n\x3c/table>","matched":true,"name":"Remove Application","shortdoc":"Removes the application that is identified with an application id","tags":[]},{"args":[],"doc":"<p>Reset application\x3c/p>","matched":true,"name":"Reset Application","shortdoc":"Reset application","tags":[]},{"args":["start_locator","end_locator"],"doc":"<p>Scrolls from one element to another Key attributes for arbitrary elements are <span class=\"name\">id\x3c/span> and <span class=\"name\">name\x3c/span>. See <a href=\"#Introduction\" class=\"name\">introduction\x3c/a> for details about locating elements.\x3c/p>","matched":true,"name":"Scroll","shortdoc":"Scrolls from one element to another","tags":[]},{"args":["locator"],"doc":"<p>Scrolls down to element\x3c/p>","matched":true,"name":"Scroll Down","shortdoc":"Scrolls down to element","tags":[]},{"args":["locator"],"doc":"<p>Scrolls up to element\x3c/p>","matched":true,"name":"Scroll Up","shortdoc":"Scrolls up to element","tags":[]},{"args":["seconds"],"doc":"<p>Sets the timeout in seconds used by various keywords.\x3c/p>\n<p>There are several <span class=\"name\">Wait ...\x3c/span> keywords that take timeout as an argument. All of these timeout arguments are optional. The timeout used by all of them can be set globally using this keyword.\x3c/p>\n<p>The previous timeout value is returned by this keyword and can be used to set the old value back later. The default timeout is 5 seconds, but it can be altered in <a href=\"#Importing\" class=\"name\">importing\x3c/a>.\x3c/p>\n<p>Example:\x3c/p>\n<table border=\"1\">\n<tr>\n<td>${orig timeout} =\x3c/td>\n<td>Set Appium Timeout\x3c/td>\n<td>15 seconds\x3c/td>\n\x3c/tr>\n<tr>\n<td>Open page that loads slowly\x3c/td>\n<td>\x3c/td>\n<td>\x3c/td>\n\x3c/tr>\n<tr>\n<td>Set Appium Timeout\x3c/td>\n<td>${orig timeout}\x3c/td>\n<td>\x3c/td>\n\x3c/tr>\n\x3c/table>","matched":true,"name":"Set Appium Timeout","shortdoc":"Sets the timeout in seconds used by various keywords.","tags":[]},{"args":["connectionStatus"],"doc":"<p>Sets the network connection Status.\x3c/p>\n<p>Android only.\x3c/p>\n<p>Possible values:\x3c/p>\n<table border=\"1\">\n<tr>\n<th>Value\x3c/th>\n<th>Alias\x3c/th>\n<th>Data\x3c/th>\n<th>Wifi\x3c/th>\n<th>Airplane Mode\x3c/th>\n\x3c/tr>\n<tr>\n<td>0\x3c/td>\n<td>(None)\x3c/td>\n<td>0\x3c/td>\n<td>0\x3c/td>\n<td>0\x3c/td>\n\x3c/tr>\n<tr>\n<td>1\x3c/td>\n<td>(Airplane Mode)\x3c/td>\n<td>0\x3c/td>\n<td>0\x3c/td>\n<td>1\x3c/td>\n\x3c/tr>\n<tr>\n<td>2\x3c/td>\n<td>(Wifi only)\x3c/td>\n<td>0\x3c/td>\n<td>1\x3c/td>\n<td>0\x3c/td>\n\x3c/tr>\n<tr>\n<td>4\x3c/td>\n<td>(Data only)\x3c/td>\n<td>1\x3c/td>\n<td>0\x3c/td>\n<td>0\x3c/td>\n\x3c/tr>\n<tr>\n<td>6\x3c/td>\n<td>(All network on)\x3c/td>\n<td>1\x3c/td>\n<td>1\x3c/td>\n<td>0\x3c/td>\n\x3c/tr>\n\x3c/table>","matched":true,"name":"Set Network Connection Status","shortdoc":"Sets the network connection Status.","tags":[]},{"args":[],"doc":"<p>Shake the device\x3c/p>","matched":true,"name":"Shake","shortdoc":"Shake the device","tags":[]},{"args":["start_x","start_y","offset_x","offset_y","duration=1000"],"doc":"<p>Swipe from one point to another point, for an optional duration.\x3c/p>\n<p>Args:\x3c/p>\n<ul>\n<li>start_x - x-coordinate at which to start\x3c/li>\n<li>start_y - y-coordinate at which to start\x3c/li>\n<li>offset_x - x-coordinate distance from start_x at which to stop\x3c/li>\n<li>offset_y - y-coordinate distance from start_y at which to stop\x3c/li>\n<li>duration - (optional) time to take the swipe, in ms.\x3c/li>\n\x3c/ul>\n<p>Usage:\x3c/p>\n<table border=\"1\">\n<tr>\n<td>Swipe\x3c/td>\n<td>500\x3c/td>\n<td>100\x3c/td>\n<td>100\x3c/td>\n<td>0\x3c/td>\n<td>1000\x3c/td>\n\x3c/tr>\n\x3c/table>\n<p><b>!Important Note:\x3c/b> Android <a href=\"#Swipe\" class=\"name\">Swipe\x3c/a> is not working properly, use <code>offset_x\x3c/code> and <code>offset_y\x3c/code> as if these are destination points.\x3c/p>","matched":true,"name":"Swipe","shortdoc":"Swipe from one point to another point, for an optional duration.","tags":[]},{"args":["index_or_alias"],"doc":"<p>Switches the active application by index or alias.\x3c/p>\n<p><span class=\"name\">index_or_alias\x3c/span> is either application index (an integer) or alias (a string). Index is got as the return value of <a href=\"#Open%20Application\" class=\"name\">Open Application\x3c/a>.\x3c/p>\n<p>This keyword returns the index of the previous active application, which can be used to switch back to that application later.\x3c/p>\n<p>Example:\x3c/p>\n<table border=\"1\">\n<tr>\n<td>${appium1}=\x3c/td>\n<td>Open Application\x3c/td>\n<td><a href=\"http://localhost:4723/wd/hub\">http://localhost:4723/wd/hub\x3c/a>\x3c/td>\n<td>alias=MyApp1\x3c/td>\n<td>platformName=iOS\x3c/td>\n<td>platformVersion=7.0\x3c/td>\n<td>deviceName='iPhone Simulator'\x3c/td>\n<td>app=your.app\x3c/td>\n\x3c/tr>\n<tr>\n<td>${appium2}=\x3c/td>\n<td>Open Application\x3c/td>\n<td><a href=\"http://localhost:4755/wd/hub\">http://localhost:4755/wd/hub\x3c/a>\x3c/td>\n<td>alias=MyApp2\x3c/td>\n<td>platformName=iOS\x3c/td>\n<td>platformVersion=7.0\x3c/td>\n<td>deviceName='iPhone Simulator'\x3c/td>\n<td>app=your.app\x3c/td>\n\x3c/tr>\n<tr>\n<td>Click Element\x3c/td>\n<td>sendHello\x3c/td>\n<td># Executed on appium running at localhost:4755\x3c/td>\n<td>\x3c/td>\n<td>\x3c/td>\n<td>\x3c/td>\n<td>\x3c/td>\n<td>\x3c/td>\n\x3c/tr>\n<tr>\n<td>Switch Application\x3c/td>\n<td>${appium1}\x3c/td>\n<td># Switch using index\x3c/td>\n<td>\x3c/td>\n<td>\x3c/td>\n<td>\x3c/td>\n<td>\x3c/td>\n<td>\x3c/td>\n\x3c/tr>\n<tr>\n<td>Click Element\x3c/td>\n<td>ackHello\x3c/td>\n<td># Executed on appium running at localhost:4723\x3c/td>\n<td>\x3c/td>\n<td>\x3c/td>\n<td>\x3c/td>\n<td>\x3c/td>\n<td>\x3c/td>\n\x3c/tr>\n<tr>\n<td>Switch Application\x3c/td>\n<td>MyApp2\x3c/td>\n<td># Switch using alias\x3c/td>\n<td>\x3c/td>\n<td>\x3c/td>\n<td>\x3c/td>\n<td>\x3c/td>\n<td>\x3c/td>\n\x3c/tr>\n<tr>\n<td>Page Should Contain Text\x3c/td>\n<td>ackHello Received\x3c/td>\n<td># Executed on appium running at localhost:4755\x3c/td>\n<td>\x3c/td>\n<td>\x3c/td>\n<td>\x3c/td>\n<td>\x3c/td>\n<td>\x3c/td>\n\x3c/tr>\n\x3c/table>","matched":true,"name":"Switch Application","shortdoc":"Switches the active application by index or alias.","tags":[]},{"args":["context_name"],"doc":"<p>Switch to a new context\x3c/p>","matched":true,"name":"Switch To Context","shortdoc":"Switch to a new context","tags":[]},{"args":["locator"],"doc":"<p>Tap on element\x3c/p>","matched":true,"name":"Tap","shortdoc":"Tap on element","tags":[]},{"args":["text","timeout=None","error=None"],"doc":"<p>Waits until <span class=\"name\">text\x3c/span> appears on current page.\x3c/p>\n<p>Fails if <span class=\"name\">timeout\x3c/span> expires before the text appears. See <a href=\"#Introduction\" class=\"name\">introduction\x3c/a> for more information about <span class=\"name\">timeout\x3c/span> and its default value.\x3c/p>\n<p><span class=\"name\">error\x3c/span> can be used to override the default error message.\x3c/p>\n<p>See also <a href=\"#Wait%20Until%20Page%20Does%20Not%20Contain\" class=\"name\">Wait Until Page Does Not Contain\x3c/a>, <a href=\"#Wait%20Until%20Page%20Contains%20Element\" class=\"name\">Wait Until Page Contains Element\x3c/a>, <a href=\"#Wait%20Until%20Page%20Does%20Not%20Contain%20Element\" class=\"name\">Wait Until Page Does Not Contain Element\x3c/a> and BuiltIn keyword <span class=\"name\">Wait Until Keyword Succeeds\x3c/span>.\x3c/p>","matched":true,"name":"Wait Until Page Contains","shortdoc":"Waits until `text` appears on current page.","tags":[]},{"args":["locator","timeout=None","error=None"],"doc":"<p>Waits until element specified with <span class=\"name\">locator\x3c/span> appears on current page.\x3c/p>\n<p>Fails if <span class=\"name\">timeout\x3c/span> expires before the element appears. See <a href=\"#Introduction\" class=\"name\">introduction\x3c/a> for more information about <span class=\"name\">timeout\x3c/span> and its default value.\x3c/p>\n<p><span class=\"name\">error\x3c/span> can be used to override the default error message.\x3c/p>\n<p>See also <a href=\"#Wait%20Until%20Page%20Contains\" class=\"name\">Wait Until Page Contains\x3c/a>, <a href=\"#Wait%20Until%20Page%20Does%20Not%20Contain\" class=\"name\">Wait Until Page Does Not Contain\x3c/a> <a href=\"#Wait%20Until%20Page%20Does%20Not%20Contain%20Element\" class=\"name\">Wait Until Page Does Not Contain Element\x3c/a> and BuiltIn keyword <span class=\"name\">Wait Until Keyword Succeeds\x3c/span>.\x3c/p>","matched":true,"name":"Wait Until Page Contains Element","shortdoc":"Waits until element specified with `locator` appears on current page.","tags":[]},{"args":["text","timeout=None","error=None"],"doc":"<p>Waits until <span class=\"name\">text\x3c/span> disappears from current page.\x3c/p>\n<p>Fails if <span class=\"name\">timeout\x3c/span> expires before the <span class=\"name\">text\x3c/span> disappears. See <a href=\"#Introduction\" class=\"name\">introduction\x3c/a> for more information about <span class=\"name\">timeout\x3c/span> and its default value.\x3c/p>\n<p><span class=\"name\">error\x3c/span> can be used to override the default error message.\x3c/p>\n<p>See also <a href=\"#Wait%20Until%20Page%20Contains\" class=\"name\">Wait Until Page Contains\x3c/a>, <a href=\"#Wait%20Until%20Page%20Contains%20Element\" class=\"name\">Wait Until Page Contains Element\x3c/a>, <a href=\"#Wait%20Until%20Page%20Does%20Not%20Contain%20Element\" class=\"name\">Wait Until Page Does Not Contain Element\x3c/a> and BuiltIn keyword <span class=\"name\">Wait Until Keyword Succeeds\x3c/span>.\x3c/p>","matched":true,"name":"Wait Until Page Does Not Contain","shortdoc":"Waits until `text` disappears from current page.","tags":[]},{"args":["locator","timeout=None","error=None"],"doc":"<p>Waits until element specified with <span class=\"name\">locator\x3c/span> disappears from current page.\x3c/p>\n<p>Fails if <span class=\"name\">timeout\x3c/span> expires before the element disappears. See <a href=\"#Introduction\" class=\"name\">introduction\x3c/a> for more information about <span class=\"name\">timeout\x3c/span> and its default value.\x3c/p>\n<p><span class=\"name\">error\x3c/span> can be used to override the default error message.\x3c/p>\n<p>See also <a href=\"#Wait%20Until%20Page%20Contains\" class=\"name\">Wait Until Page Contains\x3c/a>, <a href=\"#Wait%20Until%20Page%20Does%20Not%20Contain\" class=\"name\">Wait Until Page Does Not Contain\x3c/a>, <a href=\"#Wait%20Until%20Page%20Contains%20Element\" class=\"name\">Wait Until Page Contains Element\x3c/a> and BuiltIn keyword <span class=\"name\">Wait Until Keyword Succeeds\x3c/span>.\x3c/p>","matched":true,"name":"Wait Until Page Does Not Contain Element","shortdoc":"Waits until element specified with `locator` disappears from current page.","tags":[]},{"args":["xpath","count","error=None","loglevel=INFO"],"doc":"<p>Verifies that the page contains the given number of elements located by the given <code>xpath\x3c/code>.\x3c/p>\n<p>One should not use the <span class=\"name\">xpath=\x3c/span> prefix for 'xpath'. XPath is assumed.\x3c/p>\n<table border=\"1\">\n<tr>\n<td><b>Correct:\x3c/b>\x3c/td>\n<td>\x3c/td>\n<td>\x3c/td>\n\x3c/tr>\n<tr>\n<td>Xpath Should Match X Times\x3c/td>\n<td>//android.view.View[@text='Test']\x3c/td>\n<td>1\x3c/td>\n\x3c/tr>\n<tr>\n<td>Incorrect:\x3c/td>\n<td>\x3c/td>\n<td>\x3c/td>\n\x3c/tr>\n<tr>\n<td>Xpath Should Match X Times\x3c/td>\n<td>xpath=//android.view.View[@text='Test']\x3c/td>\n<td>1\x3c/td>\n\x3c/tr>\n\x3c/table>\n<p><code>error\x3c/code> can be used to override the default error message.\x3c/p>\n<p>See <a href=\"#Log%20Source\" class=\"name\">Log Source\x3c/a> for explanation about <code>loglevel\x3c/code> argument.\x3c/p>\n<p>New in AppiumLibrary 1.4.\x3c/p>","matched":true,"name":"Xpath Should Match X Times","shortdoc":"Verifies that the page contains the given number of elements located by the given ``xpath``.","tags":[]},{"args":["locator","percent=200%","steps=1"],"doc":"<p>Zooms in on an element a certain amount.\x3c/p>","matched":true,"name":"Zoom","shortdoc":"Zooms in on an element a certain amount.","tags":[]}],"name":"AppiumLibrary","named_args":true,"scope":"global","version":"1.4.0.b1"};
 </script>
 <title></title>
 </head>
diff --git a/src/AppiumLibrary/__init__.py b/src/AppiumLibrary/__init__.py
index 9db840e1..2904d60f 100644
--- a/src/AppiumLibrary/__init__.py
+++ b/src/AppiumLibrary/__init__.py
@@ -66,6 +66,11 @@ class AppiumLibrary(
     Starting with version 1.4 of the AppiumLibrary, one can pass an argument
     that contains a WebElement instead of a string locator. To get a WebElement,
     use the new `Get WebElements` or `Get WebElement` keyword.
+
+    For example:
+    | @{elements}    Get Webelements    class=UIAButton
+    | Click Element    @{elements}[2]
+
     """
 
     ROBOT_LIBRARY_SCOPE = 'GLOBAL'
diff --git a/src/AppiumLibrary/keywords/_element.py b/src/AppiumLibrary/keywords/_element.py
index 10662a07..d28fcfcc 100644
--- a/src/AppiumLibrary/keywords/_element.py
+++ b/src/AppiumLibrary/keywords/_element.py
@@ -52,10 +52,10 @@ def click_button(self, index_or_name):
     def click_text(self, text, exact_match=False):
         """Click text identified by ``text``.
 
-        By default tries to click any text involves given ``text``, if you would
+        By default tries to click first text involves given ``text``, if you would
         like to click exactly matching text, then set ``exact_match`` to `True`.
 
-        If there are multiple use  of ``text`` use `Get Web Elements`.
+        If there are multiple use  of ``text`` use `locator` with `Get Web Elements` instead.
 
         New in AppiumLibrary 1.4.
         """