From 5c44cca7408b6eca08f63f6a02d0f8e93fec9c87 Mon Sep 17 00:00:00 2001
From: Brandon Wolfe <Wolfe1@gmail.com>
Date: Mon, 12 Jun 2023 14:01:41 -0500
Subject: [PATCH] try this fix from
 https://github.com/shailshouryya/yt-videos-list/issues/19

---
 .github/workflows/run-tests.yml      | 4 ++--
 docs/MobileLibraryDocumentation.html | 2 +-
 2 files changed, 3 insertions(+), 3 deletions(-)

diff --git a/.github/workflows/run-tests.yml b/.github/workflows/run-tests.yml
index 2711c74..7e629f2 100644
--- a/.github/workflows/run-tests.yml
+++ b/.github/workflows/run-tests.yml
@@ -41,6 +41,7 @@ jobs:
           python -m pip install --upgrade pip
           pip install .
           pip install mock
+          pip install urllib3==1.26.5
           sudo apt-get update
 
       - name: Run Mobile Robot Tests
@@ -48,8 +49,7 @@ jobs:
         with:
           timeout_minutes: 45
           max_attempts: 3
-#          command: robot --randomize suites -i Mobile -e BrokenORWindowsOREdge -v sauce_username:${{ secrets.SAUCE_USERNAME }} -v sauce_key:${{ secrets.SAUCE_ACCESS_KEY }} -v GITHUB_RUN_NUMBER:Github.ApplicationLibrary.$GITHUB_RUN_NUMBER --output reports/output.xml test
-          command: robot --randomize suites -i Mobile -e BrokenORWindowsOREdge -v sauce_username:${{ secrets.SAUCE_USERNAME }} -v sauce_key:${{ secrets.SAUCE_ACCESS_KEY }} --output reports/output.xml test
+          command: robot --randomize suites -i Mobile -e BrokenORWindowsOREdge -v sauce_username:${{ secrets.SAUCE_USERNAME }} -v sauce_key:${{ secrets.SAUCE_ACCESS_KEY }} -v GITHUB_RUN_NUMBER:Github.ApplicationLibrary.$GITHUB_RUN_NUMBER --output reports/output.xml test
           new_command_on_retry: robot --rerunfailedsuites "reports/output.xml" -i Mobile -e BrokenORWindowsOREdge -v sauce_username:${{ secrets.SAUCE_USERNAME }} -v sauce_key:${{ secrets.SAUCE_ACCESS_KEY }} -v GITHUB_RUN_NUMBER:Github.ApplicationLibrary.$GITHUB_RUN_NUMBER --output reports/output.xml test
 
       - name: Upload test results
diff --git a/docs/MobileLibraryDocumentation.html b/docs/MobileLibraryDocumentation.html
index 398f1f5..cebaab9 100644
--- a/docs/MobileLibraryDocumentation.html
+++ b/docs/MobileLibraryDocumentation.html
@@ -1192,7 +1192,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 = {"specversion": 1, "name": "Mobile_Library", "doc": "<p>ApplicationLibrary Mobile Library</p>\n<p>This class is the base Library used to generate automated Mobile Tests in the Robot Automation Framework using Appium. This Library uses and extends the robotframework-appiumlibrary.</p>\n<h2 id=\"Locating or Specifying Elements\">Locating or Specifying Elements</h2>\n<p>All keywords in MobileLibrary that need to find an element on the page take an argument, either a <code>locator</code> or a <code>webelement</code>. <code>locator</code> is a string that describes how to locate an element using a syntax specifying different location strategies. <code>webelement</code> is a variable that holds a WebElement instance, which is a representation of the element.</p>\n<h3 id=\"Using locators\">Using locators</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</code> for all elements and locating elements is easy using just the <code>id</code>. For example:</p>\n<pre>\nClick Element    id=my_element\n</pre>\n<p><code>id</code> and <code>xpath</code> are not required to be specified, however <code>xpath</code> should start with <code>//</code> else just use <code>xpath</code> locator as explained below.</p>\n<p>For example:</p>\n<pre>\nClick Element    my_element\nWait Until Page Contains Element    //*[@type=\"android.widget.EditText\"]\n</pre>\n<p>Appium additionally supports some of the <a href=\"https://w3c.github.io/webdriver/webdriver-spec.html\">Mobile JSON Wire Protocol</a> locator strategies. It is also possible to specify the approach MobileLibrary should take to find an element by specifying a lookup strategy with a locator prefix. Supported strategies are:</p>\n<table border=\"1\">\n<tr>\n<td><b>Strategy</b></td>\n<td><b>Example</b></td>\n<td><b>Description</b></td>\n<td><b>Note</b></td>\n</tr>\n<tr>\n<td>identifier</td>\n<td>Click Element <span class=\"name\">|</span> identifier=my_element</td>\n<td>Matches by @id attribute</td>\n<td></td>\n</tr>\n<tr>\n<td>id</td>\n<td>Click Element <span class=\"name\">|</span> id=my_element</td>\n<td>Matches by @resource-id attribute</td>\n<td></td>\n</tr>\n<tr>\n<td>accessibility_id</td>\n<td>Click Element <span class=\"name\">|</span> accessibility_id=button3</td>\n<td>Accessibility options utilize.</td>\n<td></td>\n</tr>\n<tr>\n<td>xpath</td>\n<td>Click Element <span class=\"name\">|</span> xpath=//UIATableView/UIATableCell/UIAButton</td>\n<td>Matches with arbitrary XPath</td>\n<td></td>\n</tr>\n<tr>\n<td>class</td>\n<td>Click Element <span class=\"name\">|</span> class=UIAPickerWheel</td>\n<td>Matches by class</td>\n<td></td>\n</tr>\n<tr>\n<td>android</td>\n<td>Click Element <span class=\"name\">|</span> android=UiSelector().description('Apps')</td>\n<td>Matches by Android UI Automator</td>\n<td></td>\n</tr>\n<tr>\n<td>ios</td>\n<td>Click Element <span class=\"name\">|</span> ios=.buttons().withName('Apps')</td>\n<td>Matches by iOS UI Automation</td>\n<td></td>\n</tr>\n<tr>\n<td>nsp</td>\n<td>Click Element <span class=\"name\">|</span> nsp=name==\"login\"</td>\n<td>Matches by iOSNsPredicate</td>\n<td></td>\n</tr>\n<tr>\n<td>css</td>\n<td>Click Element <span class=\"name\">|</span> css=.green_button</td>\n<td>Matches by css in webview</td>\n<td></td>\n</tr>\n<tr>\n<td>name</td>\n<td>Click Element <span class=\"name\">|</span> name=my_element</td>\n<td>Matches by @name attribute</td>\n<td><b>Only valid</b> for Selendroid</td>\n</tr>\n</table>\n<h3 id=\"Using webelements\">Using webelements</h3>\n<p>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</a> or <a href=\"#Get%20Webelement\" class=\"name\">Get WebElement</a> keyword.</p>\n<p>For example:</p>\n<pre>\n@{elements}    Get Webelements    class=UIAButton\nClick Element    @{elements}[2]\n</pre>", "version": "1.1.2", "generated": "2023-06-07 14:42:22", "type": "LIBRARY", "scope": "GLOBAL", "docFormat": "HTML", "source": "C:\\Git\\robotframework-applicationlibrary\\src\\ApplicationLibrary\\MobileLibrary.py", "lineno": 14, "tags": [], "inits": [{"name": "__init__", "args": [{"name": "timeout", "types": [], "typedocs": {}, "defaultValue": "5", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "timeout=5"}, {"name": "run_on_failure", "types": [], "typedocs": {}, "defaultValue": "Save Appium Screenshot", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "run_on_failure=Save Appium Screenshot"}], "doc": "<p>MobileLibrary can be imported with optional arguments. <code>timeout</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</a>. <code>run_on_failure</code> specifies the name of a keyword (from any available libraries) to execute when a MobileLibrary keyword fails. By default <a href=\"#Save%20Appium%20Screenshot\" class=\"name\">Save Appium Screenshot</a> will be used to take a screenshot of the current page. Using the value <span class=\"name\">No Operation</span> will disable this feature altogether. See <a href=\"#Register%20Keyword%20To%20Run%20On%20Failure\" class=\"name\">Register Keyword To Run On Failure</a> keyword for more information about this functionality. Examples:</p>\n<table border=\"1\">\n<tr>\n<td>Library</td>\n<td>MobileLibrary</td>\n<td>10</td>\n<td># Sets default timeout to 10 seconds</td>\n<td></td>\n</tr>\n<tr>\n<td>Library</td>\n<td>MobileLibrary</td>\n<td>timeout=10</td>\n<td>run_on_failure=No Operation</td>\n<td># Sets default timeout to 10 seconds and does nothing on failure</td>\n</tr>\n</table>", "shortdoc": "MobileLibrary can be imported with optional arguments. ``timeout`` is the default timeout used to wait for all waiting actions. It can be later set with `Set Appium Timeout`. ``run_on_failure`` specifies the name of a keyword (from any available libraries) to execute when a MobileLibrary keyword fails. By default `Save Appium Screenshot` will be used to take a screenshot of the current page. Using the value `No Operation` will disable this feature altogether. See `Register Keyword To Run On Failure` keyword for more information about this functionality. Examples: | Library | MobileLibrary | 10 | # Sets default timeout to 10 seconds                                                                             | | Library | MobileLibrary | timeout=10 | run_on_failure=No Operation | # Sets default timeout to 10 seconds and does nothing on failure           |", "tags": [], "source": "C:\\Git\\robotframework-applicationlibrary\\src\\ApplicationLibrary\\MobileLibrary.py", "lineno": 71}], "keywords": [{"name": "Background App", "args": [{"name": "seconds", "types": [], "typedocs": {}, "defaultValue": "5", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "seconds=5"}], "doc": "<p>Puts the application in the background on the device for a certain duration.</p>", "shortdoc": "Puts the application in the background on the device for a certain duration.", "tags": [], "source": "C:\\Git\\robotframework-applicationlibrary\\venv\\lib\\site-packages\\AppiumLibrary\\keywords\\_applicationmanagement.py", "lineno": 245}, {"name": "Capture Page Screenshot", "args": [{"name": "filename", "types": [], "typedocs": {}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "filename=None"}], "doc": "<p>Takes a screenshot of the current page and embeds it into the log.</p>\n<p><span class=\"name\">filename</span> argument specifies the name of the file to write the screenshot into. If no <span class=\"name\">filename</span> is given, the screenshot is saved into file <span class=\"name\">appium-screenshot-&lt;counter&gt;.png</span> under the directory where the Robot Framework log file is written into. The <span class=\"name\">filename</span> is also considered relative to the same directory, if it is not given in absolute format.</p>\n<p><span class=\"name\">css</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.</p>\n<p>See <a href=\"#Save%20Appium%20Screenshot\" class=\"name\">Save Appium Screenshot</a> for a screenshot that will be unique across reports</p>", "shortdoc": "Takes a screenshot of the current page and embeds it into the log.", "tags": [], "source": "C:\\Git\\robotframework-applicationlibrary\\src\\ApplicationLibrary\\MobileLibrary.py", "lineno": 326}, {"name": "Clear Text", "args": [{"name": "locator", "types": [], "typedocs": {}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "locator"}], "doc": "<p>Clears the text field identified by <span class=\"name\">locator</span>.</p>\n<p>See <a href=\"#Introduction\" class=\"name\">introduction</a> for details about locating elements.</p>", "shortdoc": "Clears the text field identified by `locator`.", "tags": [], "source": "C:\\Git\\robotframework-applicationlibrary\\venv\\lib\\site-packages\\AppiumLibrary\\keywords\\_element.py", "lineno": 27}, {"name": "Click A Point", "args": [{"name": "x", "types": [], "typedocs": {}, "defaultValue": "0", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "x=0"}, {"name": "y", "types": [], "typedocs": {}, "defaultValue": "0", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "y=0"}, {"name": "duration", "types": [], "typedocs": {}, "defaultValue": "100", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "duration=100"}], "doc": "<p>Click on a point</p>", "shortdoc": "Click on a point", "tags": [], "source": "C:\\Git\\robotframework-applicationlibrary\\venv\\lib\\site-packages\\AppiumLibrary\\keywords\\_touch.py", "lineno": 145}, {"name": "Click Button", "args": [{"name": "index_or_name", "types": [], "typedocs": {}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "index_or_name"}], "doc": "<p>Click button</p>", "shortdoc": "Click button", "tags": [], "source": "C:\\Git\\robotframework-applicationlibrary\\venv\\lib\\site-packages\\AppiumLibrary\\keywords\\_element.py", "lineno": 44}, {"name": "Click Element", "args": [{"name": "locator", "types": [], "typedocs": {}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "locator"}], "doc": "<p>Click element identified by <span class=\"name\">locator</span>.</p>\n<p>Key attributes for arbitrary elements are <span class=\"name\">index</span> and <span class=\"name\">name</span>. See <a href=\"#Introduction\" class=\"name\">introduction</a> for details about locating elements.</p>", "shortdoc": "Click element identified by `locator`.", "tags": [], "source": "C:\\Git\\robotframework-applicationlibrary\\venv\\lib\\site-packages\\AppiumLibrary\\keywords\\_element.py", "lineno": 35}, {"name": "Click Element At Coordinates", "args": [{"name": "coordinate_X", "types": [], "typedocs": {}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "coordinate_X"}, {"name": "coordinate_Y", "types": [], "typedocs": {}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "coordinate_Y"}], "doc": "<p>click element at a certain coordinate</p>", "shortdoc": "click element at a certain coordinate", "tags": [], "source": "C:\\Git\\robotframework-applicationlibrary\\venv\\lib\\site-packages\\AppiumLibrary\\keywords\\_touch.py", "lineno": 155}, {"name": "Click Text", "args": [{"name": "text", "types": [], "typedocs": {}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "text"}, {"name": "exact_match", "types": [], "typedocs": {}, "defaultValue": "False", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "exact_match=False"}], "doc": "<p>Click text identified by <code>text</code>.</p>\n<p>By default tries to click first text involves given <code>text</code>, if you would like to click exactly matching text, then set <code>exact_match</code> to <span class=\"name\">True</span>.</p>\n<p>If there are multiple use  of <code>text</code> and you do not want first one, use <span class=\"name\">locator</span> with <a href=\"#Get%20Webelements\" class=\"name\">Get Web Elements</a> instead.</p>", "shortdoc": "Click text identified by ``text``.", "tags": [], "source": "C:\\Git\\robotframework-applicationlibrary\\venv\\lib\\site-packages\\AppiumLibrary\\keywords\\_element.py", "lineno": 52}, {"name": "Close All Applications", "args": [], "doc": "<p>Closes all open applications.</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.</p>\n<p>After this keyword, the application indices returned by <a href=\"#Open%20Application\" class=\"name\">Open Application</a> are reset and start from <span class=\"name\">1</span>.</p>", "shortdoc": "Closes all open applications.", "tags": [], "source": "C:\\Git\\robotframework-applicationlibrary\\venv\\lib\\site-packages\\AppiumLibrary\\keywords\\_applicationmanagement.py", "lineno": 25}, {"name": "Close Application", "args": [], "doc": "<p>Closes the current application and also close webdriver session.</p>", "shortdoc": "Closes the current application and also close webdriver session.", "tags": [], "source": "C:\\Git\\robotframework-applicationlibrary\\venv\\lib\\site-packages\\AppiumLibrary\\keywords\\_applicationmanagement.py", "lineno": 20}, {"name": "Drag And Drop", "args": [{"name": "source", "types": [], "typedocs": {}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "source"}, {"name": "target", "types": [], "typedocs": {}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "target"}, {"name": "delay", "types": [], "typedocs": {}, "defaultValue": "1500", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "delay=1500"}], "doc": "<p>Drags the element found with the locator <code>source</code> to the element found with the locator <code>target</code>.</p>\n<p><code>Delay</code> (iOS Only): Delay between initial button press and dragging, defaults to 1500ms.</p>", "shortdoc": "Drags the element found with the locator ``source`` to the element found with the locator ``target``.", "tags": [], "source": "C:\\Git\\robotframework-applicationlibrary\\src\\ApplicationLibrary\\MobileLibrary.py", "lineno": 245}, {"name": "Drag And Drop By Offset", "args": [{"name": "locator", "types": [], "typedocs": {}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "locator"}, {"name": "x_offset", "types": [], "typedocs": {}, "defaultValue": "0", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "x_offset=0"}, {"name": "y_offset", "types": [], "typedocs": {}, "defaultValue": "0", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "y_offset=0"}, {"name": "delay", "types": [], "typedocs": {}, "defaultValue": "1500", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "delay=1500"}], "doc": "<p>Drags the element found with <code>locator</code> to the given <code>x_offset</code> and <code>y_offset</code> coordinates.</p>\n<p><code>Delay</code> (iOS Only): Delay between initial button press and dragging, defaults to 1500ms.</p>", "shortdoc": "Drags the element found with ``locator`` to the given ``x_offset`` and ``y_offset`` coordinates.", "tags": [], "source": "C:\\Git\\robotframework-applicationlibrary\\src\\ApplicationLibrary\\MobileLibrary.py", "lineno": 253}, {"name": "Element Attribute Should Match", "args": [{"name": "locator", "types": [], "typedocs": {}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "locator"}, {"name": "attr_name", "types": [], "typedocs": {}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "attr_name"}, {"name": "match_pattern", "types": [], "typedocs": {}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "match_pattern"}, {"name": "regexp", "types": [], "typedocs": {}, "defaultValue": "False", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "regexp=False"}], "doc": "<p>Verify that an attribute of an element matches the expected criteria.</p>\n<p>The element is identified by <i>locator</i>. See <a href=\"#Introduction\" class=\"name\">introduction</a> for details about locating elements. If more than one element matches, the first element is selected.</p>\n<p>The <i>attr_name</i> is the name of the attribute within the selected element.</p>\n<p>The <i>match_pattern</i> is used for the matching, if the match_pattern is</p>\n<ul>\n<li>boolean or 'True'/'true'/'False'/'false' String then a boolean match is applied</li>\n<li>any other string is cause a string match</li>\n</ul>\n<p>The <i>regexp</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</a> or string pattern match (i.e. BuiltIn Library's <a href=\"http://robotframework.org/robotframework/latest/libraries/BuiltIn.html#Should%20Match\">Should Match</a>)</p>\n<p>Examples:</p>\n<table border=\"1\">\n<tr>\n<td>Element Attribute Should Match</td>\n<td>xpath = //*[contains(@text,'foo')]</td>\n<td>text</td>\n<td>*foobar</td>\n<td></td>\n</tr>\n<tr>\n<td>Element Attribute Should Match</td>\n<td>xpath = //*[contains(@text,'foo')]</td>\n<td>text</td>\n<td>f.*ar</td>\n<td>regexp = True</td>\n</tr>\n<tr>\n<td>Element Attribute Should Match</td>\n<td>xpath = //*[contains(@text,'foo')]</td>\n<td>enabled</td>\n<td>True</td>\n<td></td>\n</tr>\n</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</pre>\n<p><i><b>NOTE: </b></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</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</i></p>\n<p><i><b>NOTE: </b></i> Some attributes can be evaluated in two different ways e.g. these evaluate the same thing:</p>\n<table border=\"1\">\n<tr>\n<td>Element Attribute Should Match</td>\n<td>xpath = //*[contains(@text,'example text')]</td>\n<td>name</td>\n<td>txt_field_name</td>\n</tr>\n<tr>\n<td>Element Name Should Be</td>\n<td>xpath = //*[contains(@text,'example text')]</td>\n<td>txt_field_name</td>\n<td></td>\n</tr>\n</table>", "shortdoc": "Verify that an attribute of an element matches the expected criteria.", "tags": [], "source": "C:\\Git\\robotframework-applicationlibrary\\venv\\lib\\site-packages\\AppiumLibrary\\keywords\\_element.py", "lineno": 205}, {"name": "Element Name Should Be", "args": [{"name": "locator", "types": [], "typedocs": {}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "locator"}, {"name": "expected", "types": [], "typedocs": {}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "expected"}], "doc": "", "shortdoc": "", "tags": [], "source": "C:\\Git\\robotframework-applicationlibrary\\venv\\lib\\site-packages\\AppiumLibrary\\keywords\\_element.py", "lineno": 191}, {"name": "Element Should Be Disabled", "args": [{"name": "locator", "types": [], "typedocs": {}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "locator"}, {"name": "loglevel", "types": [], "typedocs": {}, "defaultValue": "INFO", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "loglevel=INFO"}], "doc": "<p>Verifies that element identified with locator is disabled.</p>\n<p>Key attributes for arbitrary elements are <span class=\"name\">id</span> and <span class=\"name\">name</span>. See <a href=\"#Introduction\" class=\"name\">introduction</a> for details about locating elements.</p>", "shortdoc": "Verifies that element identified with locator is disabled.", "tags": [], "source": "C:\\Git\\robotframework-applicationlibrary\\venv\\lib\\site-packages\\AppiumLibrary\\keywords\\_element.py", "lineno": 154}, {"name": "Element Should Be Enabled", "args": [{"name": "locator", "types": [], "typedocs": {}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "locator"}, {"name": "loglevel", "types": [], "typedocs": {}, "defaultValue": "INFO", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "loglevel=INFO"}], "doc": "<p>Verifies that element identified with locator is enabled.</p>\n<p>Key attributes for arbitrary elements are <span class=\"name\">id</span> and <span class=\"name\">name</span>. See <a href=\"#Introduction\" class=\"name\">introduction</a> for details about locating elements.</p>", "shortdoc": "Verifies that element identified with locator is enabled.", "tags": [], "source": "C:\\Git\\robotframework-applicationlibrary\\venv\\lib\\site-packages\\AppiumLibrary\\keywords\\_element.py", "lineno": 166}, {"name": "Element Should Be Visible", "args": [{"name": "locator", "types": [], "typedocs": {}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "locator"}, {"name": "loglevel", "types": [], "typedocs": {}, "defaultValue": "INFO", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "loglevel=INFO"}], "doc": "<p>Verifies that element identified with locator is visible.</p>\n<p>Key attributes for arbitrary elements are <span class=\"name\">id</span> and <span class=\"name\">name</span>. See <a href=\"#Introduction\" class=\"name\">introduction</a> for details about locating elements.</p>\n<p>New in AppiumLibrary 1.4.5</p>", "shortdoc": "Verifies that element identified with locator is visible.", "tags": [], "source": "C:\\Git\\robotframework-applicationlibrary\\venv\\lib\\site-packages\\AppiumLibrary\\keywords\\_element.py", "lineno": 178}, {"name": "Element Should Contain Text", "args": [{"name": "locator", "types": [], "typedocs": {}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "locator"}, {"name": "expected", "types": [], "typedocs": {}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "expected"}, {"name": "message", "types": [], "typedocs": {}, "defaultValue": "", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "message="}], "doc": "<p>Verifies element identified by <code>locator</code> contains text <code>expected</code>.</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</a>.</p>\n<p>Key attributes for arbitrary elements are <code>id</code> and <code>xpath</code>. <code>message</code> can be used to override the default error message.</p>\n<p>New in AppiumLibrary 1.4.</p>", "shortdoc": "Verifies element identified by ``locator`` contains text ``expected``.", "tags": [], "source": "C:\\Git\\robotframework-applicationlibrary\\venv\\lib\\site-packages\\AppiumLibrary\\keywords\\_element.py", "lineno": 285}, {"name": "Element Should Not Contain Text", "args": [{"name": "locator", "types": [], "typedocs": {}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "locator"}, {"name": "expected", "types": [], "typedocs": {}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "expected"}, {"name": "message", "types": [], "typedocs": {}, "defaultValue": "", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "message="}], "doc": "<p>Verifies element identified by <code>locator</code> does not contain text <code>expected</code>.</p>\n<p><code>message</code> can be used to override the default error message. See <a href=\"#Element%20Should%20Contain%20Text\" class=\"name\">Element Should Contain Text</a> for more details.</p>", "shortdoc": "Verifies element identified by ``locator`` does not contain text ``expected``.", "tags": [], "source": "C:\\Git\\robotframework-applicationlibrary\\venv\\lib\\site-packages\\AppiumLibrary\\keywords\\_element.py", "lineno": 304}, {"name": "Element Text Should Be", "args": [{"name": "locator", "types": [], "typedocs": {}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "locator"}, {"name": "expected", "types": [], "typedocs": {}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "expected"}, {"name": "message", "types": [], "typedocs": {}, "defaultValue": "", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "message="}], "doc": "<p>Verifies element identified by <code>locator</code> exactly contains text <code>expected</code>.</p>\n<p>In contrast to <a href=\"#Element%20Should%20Contain%20Text\" class=\"name\">Element Should Contain Text</a>, this keyword does not try a substring match but an exact match on the element identified by <code>locator</code>.</p>\n<p><code>message</code> can be used to override the default error message.</p>\n<p>New in AppiumLibrary 1.4.</p>", "shortdoc": "Verifies element identified by ``locator`` exactly contains text ``expected``.", "tags": [], "source": "C:\\Git\\robotframework-applicationlibrary\\venv\\lib\\site-packages\\AppiumLibrary\\keywords\\_element.py", "lineno": 319}, {"name": "Element Value Should Be", "args": [{"name": "locator", "types": [], "typedocs": {}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "locator"}, {"name": "expected", "types": [], "typedocs": {}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "expected"}], "doc": "", "shortdoc": "", "tags": [], "source": "C:\\Git\\robotframework-applicationlibrary\\venv\\lib\\site-packages\\AppiumLibrary\\keywords\\_element.py", "lineno": 198}, {"name": "Execute Adb Shell", "args": [{"name": "command", "types": [], "typedocs": {}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "command"}, {"name": "args", "types": [], "typedocs": {}, "defaultValue": null, "kind": "VAR_POSITIONAL", "required": false, "repr": "*args"}], "doc": "<p>Execute ADB shell commands</p>\n<p>Android only.</p>\n<ul>\n<li><i>command</i> - The ABD shell command</li>\n<li><i>args</i> - Arguments to send to command</li>\n</ul>\n<p>Returns the exit code of ADB shell.</p>\n<p>Requires server flag --relaxed-security to be set on Appium server.</p>", "shortdoc": "Execute ADB shell commands", "tags": [], "source": "C:\\Git\\robotframework-applicationlibrary\\venv\\lib\\site-packages\\AppiumLibrary\\keywords\\_applicationmanagement.py", "lineno": 217}, {"name": "Execute Async Script", "args": [{"name": "script", "types": [], "typedocs": {}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "script"}], "doc": "<p>Inject a snippet of Async-JavaScript into the page for execution in the context of the currently selected frame (Web context only).</p>\n<p>The executed script is assumed to be asynchronous and must signal that is done by invoking the provided callback, which is always provided as the final argument to the function.</p>\n<p>The value to this callback will be returned to the client.</p>\n<p>New in AppiumLibrary 1.5</p>", "shortdoc": "Inject a snippet of Async-JavaScript into the page for execution in the context of the currently selected frame (Web context only).", "tags": [], "source": "C:\\Git\\robotframework-applicationlibrary\\venv\\lib\\site-packages\\AppiumLibrary\\keywords\\_applicationmanagement.py", "lineno": 201}, {"name": "Execute Script", "args": [{"name": "script", "types": [], "typedocs": {}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "script"}], "doc": "<p>Inject a snippet of JavaScript into the page for execution in the context of the currently selected frame (Web context only).</p>\n<p>The executed script is assumed to be synchronous and the result of evaluating the script is returned to the client.</p>\n<p>New in AppiumLibrary 1.5</p>", "shortdoc": "Inject a snippet of JavaScript into the page for execution in the context of the currently selected frame (Web context only).", "tags": [], "source": "C:\\Git\\robotframework-applicationlibrary\\venv\\lib\\site-packages\\AppiumLibrary\\keywords\\_applicationmanagement.py", "lineno": 189}, {"name": "Get Activity", "args": [], "doc": "<p>Retrieves the current activity on the device.</p>\n<p>Android only.</p>", "shortdoc": "Retrieves the current activity on the device.", "tags": [], "source": "C:\\Git\\robotframework-applicationlibrary\\venv\\lib\\site-packages\\AppiumLibrary\\keywords\\_android_utils.py", "lineno": 88}, {"name": "Get Appium SessionId", "args": [], "doc": "<p>Returns the current session ID as a reference</p>", "shortdoc": "Returns the current session ID as a reference", "tags": [], "source": "C:\\Git\\robotframework-applicationlibrary\\venv\\lib\\site-packages\\AppiumLibrary\\keywords\\_applicationmanagement.py", "lineno": 163}, {"name": "Get Appium Timeout", "args": [], "doc": "<p>Gets the timeout in seconds that is used by various keywords.</p>\n<p>See <a href=\"#Set%20Appium%20Timeout\" class=\"name\">Set Appium Timeout</a> for an explanation.</p>", "shortdoc": "Gets the timeout in seconds that is used by various keywords.", "tags": [], "source": "C:\\Git\\robotframework-applicationlibrary\\venv\\lib\\site-packages\\AppiumLibrary\\keywords\\_applicationmanagement.py", "lineno": 137}, {"name": "Get Capability", "args": [{"name": "capability_name", "types": [], "typedocs": {}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "capability_name"}], "doc": "<p>Return the desired capability value by desired capability name</p>", "shortdoc": "Return the desired capability value by desired capability name", "tags": [], "source": "C:\\Git\\robotframework-applicationlibrary\\venv\\lib\\site-packages\\AppiumLibrary\\keywords\\_applicationmanagement.py", "lineno": 353}, {"name": "Get Contexts", "args": [], "doc": "<p>Get available contexts.</p>", "shortdoc": "Get available contexts.", "tags": [], "source": "C:\\Git\\robotframework-applicationlibrary\\venv\\lib\\site-packages\\AppiumLibrary\\keywords\\_applicationmanagement.py", "lineno": 292}, {"name": "Get Current Context", "args": [], "doc": "<p>Get current context.</p>", "shortdoc": "Get current context.", "tags": [], "source": "C:\\Git\\robotframework-applicationlibrary\\venv\\lib\\site-packages\\AppiumLibrary\\keywords\\_applicationmanagement.py", "lineno": 288}, {"name": "Get Element Attribute", "args": [{"name": "locator", "types": [], "typedocs": {}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "locator"}, {"name": "attribute", "types": [], "typedocs": {}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "attribute"}], "doc": "<p>Get element attribute using given attribute: name, value,...</p>\n<p>Examples:</p>\n<table border=\"1\">\n<tr>\n<td>Get Element Attribute</td>\n<td>locator</td>\n<td>name</td>\n</tr>\n<tr>\n<td>Get Element Attribute</td>\n<td>locator</td>\n<td>value</td>\n</tr>\n</table>", "shortdoc": "Get element attribute using given attribute: name, value,...", "tags": [], "source": "C:\\Git\\robotframework-applicationlibrary\\venv\\lib\\site-packages\\AppiumLibrary\\keywords\\_element.py", "lineno": 365}, {"name": "Get Element Location", "args": [{"name": "locator", "types": [], "typedocs": {}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "locator"}], "doc": "<p>Get element location</p>\n<p>Key attributes for arbitrary elements are <span class=\"name\">id</span> and <span class=\"name\">name</span>. See <a href=\"#Introduction\" class=\"name\">introduction</a> for details about locating elements.</p>", "shortdoc": "Get element location", "tags": [], "source": "C:\\Git\\robotframework-applicationlibrary\\venv\\lib\\site-packages\\AppiumLibrary\\keywords\\_element.py", "lineno": 387}, {"name": "Get Element Size", "args": [{"name": "locator", "types": [], "typedocs": {}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "locator"}], "doc": "<p>Get element size</p>\n<p>Key attributes for arbitrary elements are <span class=\"name\">id</span> and <span class=\"name\">name</span>. See <a href=\"#Introduction\" class=\"name\">introduction</a> for details about locating elements.</p>", "shortdoc": "Get element size", "tags": [], "source": "C:\\Git\\robotframework-applicationlibrary\\venv\\lib\\site-packages\\AppiumLibrary\\keywords\\_element.py", "lineno": 398}, {"name": "Get Matching Xpath Count", "args": [{"name": "xpath", "types": [], "typedocs": {}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "xpath"}], "doc": "<p>Returns number of elements matching <code>xpath</code></p>\n<p>One should not use the <span class=\"name\">xpath=</span> prefix for 'xpath'. XPath is assumed.</p>\n<table border=\"1\">\n<tr>\n<td><b>Correct:</b></td>\n<td></td>\n<td></td>\n</tr>\n<tr>\n<td>${count}</td>\n<td>Get Matching Xpath Count</td>\n<td>//android.view.View[@text='Test']</td>\n</tr>\n<tr>\n<td>Incorrect:</td>\n<td></td>\n<td></td>\n</tr>\n<tr>\n<td>${count}</td>\n<td>Get Matching Xpath Count</td>\n<td>xpath=//android.view.View[@text='Test']</td>\n</tr>\n</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</a>.</p>\n<p>New in AppiumLibrary 1.4.</p>", "shortdoc": "Returns number of elements matching ``xpath``", "tags": [], "source": "C:\\Git\\robotframework-applicationlibrary\\venv\\lib\\site-packages\\AppiumLibrary\\keywords\\_element.py", "lineno": 422}, {"name": "Get Network Connection Status", "args": [], "doc": "<p>Returns an integer bitmask specifying the network connection type.</p>\n<p>Android only.</p>\n<p>See <a href=\"#Set%20Network%20Connection%20Status\" class=\"name\">set network connection status</a> for more details.</p>", "shortdoc": "Returns an integer bitmask specifying the network connection type.", "tags": [], "source": "C:\\Git\\robotframework-applicationlibrary\\venv\\lib\\site-packages\\AppiumLibrary\\keywords\\_android_utils.py", "lineno": 19}, {"name": "Get Source", "args": [], "doc": "<p>Returns the entire source of the current page.</p>", "shortdoc": "Returns the entire source of the current page.", "tags": [], "source": "C:\\Git\\robotframework-applicationlibrary\\venv\\lib\\site-packages\\AppiumLibrary\\keywords\\_applicationmanagement.py", "lineno": 168}, {"name": "Get Text", "args": [{"name": "locator", "types": [], "typedocs": {}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "locator"}], "doc": "<p>Get element text (for hybrid and mobile browser use <span class=\"name\">xpath</span> locator, others might cause problem)</p>\n<p>Example:</p>\n<table border=\"1\">\n<tr>\n<td>${text}</td>\n<td>Get Text</td>\n<td>//*[contains(@text,'foo')]</td>\n</tr>\n</table>\n<p>New in AppiumLibrary 1.4.</p>", "shortdoc": "Get element text (for hybrid and mobile browser use `xpath` locator, others might cause problem)", "tags": [], "source": "C:\\Git\\robotframework-applicationlibrary\\venv\\lib\\site-packages\\AppiumLibrary\\keywords\\_element.py", "lineno": 409}, {"name": "Get Webelement", "args": [{"name": "locator", "types": [], "typedocs": {}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "locator"}], "doc": "<p>Returns the first <a href=\"http://selenium-python.readthedocs.io/api.html#module-selenium.webdriver.remote.webelement\">WebElement</a> object matching <code>locator</code>.</p>\n<p>Example:</p>\n<table border=\"1\">\n<tr>\n<td>${element}</td>\n<td>Get Webelement</td>\n<td>id=my_element</td>\n</tr>\n<tr>\n<td>Click Element</td>\n<td>${element}</td>\n<td></td>\n</tr>\n</table>\n<p>New in AppiumLibrary 1.4.</p>", "shortdoc": "Returns the first [http://selenium-python.readthedocs.io/api.html#module-selenium.webdriver.remote.webelement|WebElement] object matching ``locator``.", "tags": [], "source": "C:\\Git\\robotframework-applicationlibrary\\venv\\lib\\site-packages\\AppiumLibrary\\keywords\\_element.py", "lineno": 339}, {"name": "Get Webelements", "args": [{"name": "locator", "types": [], "typedocs": {}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "locator"}], "doc": "<p>Returns list of <a href=\"http://selenium-python.readthedocs.io/api.html#module-selenium.webdriver.remote.webelement\">WebElement</a> objects matching <code>locator</code>.</p>\n<p>Example:</p>\n<table border=\"1\">\n<tr>\n<td>@{elements}</td>\n<td>Get Webelements</td>\n<td>id=my_element</td>\n</tr>\n<tr>\n<td>Click Element</td>\n<td>@{elements}[2]</td>\n<td></td>\n</tr>\n</table>\n<p>This keyword was changed in AppiumLibrary 1.4 in following ways:</p>\n<ul>\n<li>Name is changed from <span class=\"name\">Get Elements</span> to current one.</li>\n<li>Deprecated argument <code>fail_on_error</code>, use <span class=\"name\">Run Keyword and Ignore Error</span> if necessary.</li>\n</ul>\n<p>New in AppiumLibrary 1.4.</p>", "shortdoc": "Returns list of [http://selenium-python.readthedocs.io/api.html#module-selenium.webdriver.remote.webelement|WebElement] objects matching ``locator``.", "tags": [], "source": "C:\\Git\\robotframework-applicationlibrary\\venv\\lib\\site-packages\\AppiumLibrary\\keywords\\_element.py", "lineno": 350}, {"name": "Get Window Height", "args": [], "doc": "<p>Get current device height.</p>\n<p>Example:</p>\n<table border=\"1\">\n<tr>\n<td>${width}</td>\n<td>Get Window Width</td>\n<td></td>\n</tr>\n<tr>\n<td>${height}</td>\n<td>Get Window Height</td>\n<td></td>\n</tr>\n<tr>\n<td>Click A Point</td>\n<td>${width}</td>\n<td>${height}</td>\n</tr>\n</table>\n<p>New in AppiumLibrary 1.4.5</p>", "shortdoc": "Get current device height.", "tags": [], "source": "C:\\Git\\robotframework-applicationlibrary\\venv\\lib\\site-packages\\AppiumLibrary\\keywords\\_applicationmanagement.py", "lineno": 297}, {"name": "Get Window Width", "args": [], "doc": "<p>Get current device width.</p>\n<p>Example:</p>\n<table border=\"1\">\n<tr>\n<td>${width}</td>\n<td>Get Window Width</td>\n<td></td>\n</tr>\n<tr>\n<td>${height}</td>\n<td>Get Window Height</td>\n<td></td>\n</tr>\n<tr>\n<td>Click A Point</td>\n<td>${width}</td>\n<td>${height}</td>\n</tr>\n</table>\n<p>New in AppiumLibrary 1.4.5</p>", "shortdoc": "Get current device width.", "tags": [], "source": "C:\\Git\\robotframework-applicationlibrary\\venv\\lib\\site-packages\\AppiumLibrary\\keywords\\_applicationmanagement.py", "lineno": 309}, {"name": "Go Back", "args": [], "doc": "<p>Goes one step backward in the browser history.</p>", "shortdoc": "Goes one step backward in the browser history.", "tags": [], "source": "C:\\Git\\robotframework-applicationlibrary\\venv\\lib\\site-packages\\AppiumLibrary\\keywords\\_applicationmanagement.py", "lineno": 235}, {"name": "Go To Url", "args": [{"name": "url", "types": [], "typedocs": {}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "url"}], "doc": "<p>Opens URL in default web browser.</p>\n<p>Example:</p>\n<table border=\"1\">\n<tr>\n<td>Open Application</td>\n<td><a href=\"http://localhost:4755/wd/hub\">http://localhost:4755/wd/hub</a></td>\n<td>platformName=iOS</td>\n<td>platformVersion=7.0</td>\n<td>deviceName='iPhone Simulator'</td>\n<td>browserName=Safari</td>\n</tr>\n<tr>\n<td>Go To URL</td>\n<td><a href=\"http://m.webapp.com\">http://m.webapp.com</a></td>\n<td></td>\n<td></td>\n<td></td>\n<td></td>\n</tr>\n</table>", "shortdoc": "Opens URL in default web browser.", "tags": [], "source": "C:\\Git\\robotframework-applicationlibrary\\venv\\lib\\site-packages\\AppiumLibrary\\keywords\\_applicationmanagement.py", "lineno": 343}, {"name": "Hide Keyboard", "args": [{"name": "key_name", "types": [], "typedocs": {}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "key_name=None"}], "doc": "<p>Hides the software keyboard on the device. (optional) In iOS, use <span class=\"name\">key_name</span> to press a particular key, ex. <span class=\"name\">Done</span>. In Android, no parameters are used.</p>", "shortdoc": "Hides the software keyboard on the device. (optional) In iOS, use `key_name` to press a particular key, ex. `Done`. In Android, no parameters are used.", "tags": [], "source": "C:\\Git\\robotframework-applicationlibrary\\venv\\lib\\site-packages\\AppiumLibrary\\keywords\\_element.py", "lineno": 90}, {"name": "Input Password", "args": [{"name": "locator", "types": [], "typedocs": {}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "locator"}, {"name": "text", "types": [], "typedocs": {}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "text"}], "doc": "<p>Types the given password into text field identified by <span class=\"name\">locator</span>.</p>\n<p>Difference between this keyword and <a href=\"#Input%20Text\" class=\"name\">Input Text</a> is that this keyword does not log the given password. See <a href=\"#Introduction\" class=\"name\">introduction</a> for details about locating elements.</p>", "shortdoc": "Types the given password into text field identified by `locator`.", "tags": [], "source": "C:\\Git\\robotframework-applicationlibrary\\venv\\lib\\site-packages\\AppiumLibrary\\keywords\\_element.py", "lineno": 72}, {"name": "Input Text", "args": [{"name": "locator", "types": [], "typedocs": {}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "locator"}, {"name": "text", "types": [], "typedocs": {}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "text"}], "doc": "<p>Types the given <span class=\"name\">text</span> into text field identified by <span class=\"name\">locator</span>.</p>\n<p>See <a href=\"#Introduction\" class=\"name\">introduction</a> for details about locating elements.</p>", "shortdoc": "Types the given `text` into text field identified by `locator`.", "tags": [], "source": "C:\\Git\\robotframework-applicationlibrary\\venv\\lib\\site-packages\\AppiumLibrary\\keywords\\_element.py", "lineno": 64}, {"name": "Input Value", "args": [{"name": "locator", "types": [], "typedocs": {}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "locator"}, {"name": "text", "types": [], "typedocs": {}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "text"}], "doc": "<p>Sets the given value into text field identified by <span class=\"name\">locator</span>. This is an IOS only keyword, input value makes use of set_value</p>\n<p>See <a href=\"#Introduction\" class=\"name\">introduction</a> for details about locating elements.</p>", "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": [], "source": "C:\\Git\\robotframework-applicationlibrary\\venv\\lib\\site-packages\\AppiumLibrary\\keywords\\_element.py", "lineno": 82}, {"name": "Install App", "args": [{"name": "app_path", "types": [], "typedocs": {}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "app_path"}, {"name": "app_package", "types": [], "typedocs": {}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "app_package"}], "doc": "<p>Install App via Appium</p>\n<p>Android only.</p>\n<ul>\n<li>app_path - path to app</li>\n<li>app_package - package of install app to verify</li>\n</ul>", "shortdoc": "Install App via Appium", "tags": [], "source": "C:\\Git\\robotframework-applicationlibrary\\venv\\lib\\site-packages\\AppiumLibrary\\keywords\\_android_utils.py", "lineno": 156}, {"name": "Is Keyboard Shown", "args": [], "doc": "<p>Return true if Android keyboard is displayed or False if not displayed No parameters are used.</p>", "shortdoc": "Return true if Android keyboard is displayed or False if not displayed No parameters are used.", "tags": [], "source": "C:\\Git\\robotframework-applicationlibrary\\venv\\lib\\site-packages\\AppiumLibrary\\keywords\\_element.py", "lineno": 97}, {"name": "Landscape", "args": [], "doc": "<p>Set the device orientation to LANDSCAPE</p>", "shortdoc": "Set the device orientation to LANDSCAPE", "tags": [], "source": "C:\\Git\\robotframework-applicationlibrary\\venv\\lib\\site-packages\\AppiumLibrary\\keywords\\_applicationmanagement.py", "lineno": 282}, {"name": "Launch Application", "args": [], "doc": "<p>Launch application. Application can be launched while Appium session running. This keyword can be used to launch application during test case or between test cases.</p>\n<p>This keyword works while <a href=\"#Open%20Application\" class=\"name\">Open Application</a> has a test running. This is good practice to <a href=\"#Launch%20Application\" class=\"name\">Launch Application</a> and <a href=\"#Quit%20Application\" class=\"name\">Quit Application</a> between test cases. As Suite Setup is <a href=\"#Open%20Application\" class=\"name\">Open Application</a>, <span class=\"name\">Test Setup</span> can be used to <a href=\"#Launch%20Application\" class=\"name\">Launch Application</a></p>\n<p>Example (syntax is just a representation, refer to RF Guide for usage of Setup/Teardown):</p>\n<table border=\"1\">\n<tr>\n<td>[Setup Suite]</td>\n<td></td>\n<td></td>\n<td></td>\n<td></td>\n<td></td>\n</tr>\n<tr>\n<td></td>\n<td>Open Application</td>\n<td><a href=\"http://localhost:4723/wd/hub\">http://localhost:4723/wd/hub</a></td>\n<td>platformName=Android</td>\n<td>deviceName=192.168.56.101:5555</td>\n<td>app=${CURDIR}/demoapp/OrangeDemoApp.apk</td>\n</tr>\n<tr>\n<td>[Test Setup]</td>\n<td></td>\n<td></td>\n<td></td>\n<td></td>\n<td></td>\n</tr>\n<tr>\n<td></td>\n<td>Launch Application</td>\n<td></td>\n<td></td>\n<td></td>\n<td></td>\n</tr>\n<tr>\n<td></td>\n<td></td>\n<td>&lt;&lt;&lt;test execution&gt;&gt;&gt;</td>\n<td></td>\n<td></td>\n<td></td>\n</tr>\n<tr>\n<td></td>\n<td></td>\n<td>&lt;&lt;&lt;test execution&gt;&gt;&gt;</td>\n<td></td>\n<td></td>\n<td></td>\n</tr>\n<tr>\n<td>[Test Teardown]</td>\n<td></td>\n<td></td>\n<td></td>\n<td></td>\n<td></td>\n</tr>\n<tr>\n<td></td>\n<td>Quit Application</td>\n<td></td>\n<td></td>\n<td></td>\n<td></td>\n</tr>\n<tr>\n<td>[Suite Teardown]</td>\n<td></td>\n<td></td>\n<td></td>\n<td></td>\n<td></td>\n</tr>\n<tr>\n<td></td>\n<td>Close Application</td>\n<td></td>\n<td></td>\n<td></td>\n<td></td>\n</tr>\n</table>\n<p>See <a href=\"#Quit%20Application\" class=\"name\">Quit Application</a> for quiting application but keeping Appium sesion running.</p>\n<p>New in AppiumLibrary 1.4.6</p>", "shortdoc": "Launch application. Application can be launched while Appium session running. This keyword can be used to launch application during test case or between test cases.", "tags": [], "source": "C:\\Git\\robotframework-applicationlibrary\\venv\\lib\\site-packages\\AppiumLibrary\\keywords\\_applicationmanagement.py", "lineno": 84}, {"name": "Lock", "args": [{"name": "seconds", "types": [], "typedocs": {}, "defaultValue": "5", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "seconds=5"}], "doc": "<p>Lock the device for a certain period of time. iOS only.</p>", "shortdoc": "Lock the device for a certain period of time. iOS only.", "tags": [], "source": "C:\\Git\\robotframework-applicationlibrary\\venv\\lib\\site-packages\\AppiumLibrary\\keywords\\_applicationmanagement.py", "lineno": 239}, {"name": "Log Source", "args": [{"name": "loglevel", "types": [], "typedocs": {}, "defaultValue": "INFO", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "loglevel=INFO"}], "doc": "<p>Logs and returns the entire html source of the current page or frame.</p>\n<p>The <span class=\"name\">loglevel</span> argument defines the used log level. Valid log levels are <span class=\"name\">WARN</span>, <span class=\"name\">INFO</span> (default), <span class=\"name\">DEBUG</span>, <span class=\"name\">TRACE</span> and <span class=\"name\">NONE</span> (no logging).</p>", "shortdoc": "Logs and returns the entire html source of the current page or frame.", "tags": [], "source": "C:\\Git\\robotframework-applicationlibrary\\venv\\lib\\site-packages\\AppiumLibrary\\keywords\\_applicationmanagement.py", "lineno": 172}, {"name": "Long Press", "args": [{"name": "locator", "types": [], "typedocs": {}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "locator"}, {"name": "duration", "types": [], "typedocs": {}, "defaultValue": "1000", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "duration=1000"}], "doc": "<p>Long press the element with optional duration</p>", "shortdoc": "Long press the element with optional duration", "tags": [], "source": "C:\\Git\\robotframework-applicationlibrary\\venv\\lib\\site-packages\\AppiumLibrary\\keywords\\_touch.py", "lineno": 112}, {"name": "Long Press Keycode", "args": [{"name": "keycode", "types": [], "typedocs": {}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "keycode"}, {"name": "metastate", "types": [], "typedocs": {}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "metastate=None"}], "doc": "<p>Sends a long press of keycode to the device.</p>\n<p>Android only.</p>\n<p>See <a href=\"#Press%20Keycode\" class=\"name\">press keycode</a> for more details.</p>", "shortdoc": "Sends a long press of keycode to the device.", "tags": [], "source": "C:\\Git\\robotframework-applicationlibrary\\venv\\lib\\site-packages\\AppiumLibrary\\keywords\\_keyevent.py", "lineno": 35}, {"name": "Open Application", "args": [{"name": "remote_url", "types": [], "typedocs": {}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "remote_url"}, {"name": "alias", "types": [], "typedocs": {}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "alias=None"}, {"name": "kwargs", "types": [], "typedocs": {}, "defaultValue": null, "kind": "VAR_NAMED", "required": false, "repr": "**kwargs"}], "doc": "<p>Opens a new application to given Appium server. Capabilities of appium server, Android and iOS, Please check <a href=\"https://github.com/appium/appium/blob/master/docs/en/writing-running-appium/server-args.md\">https://github.com/appium/appium/blob/master/docs/en/writing-running-appium/server-args.md</a></p>\n<table border=\"1\">\n<tr>\n<td><b>Option</b></td>\n<td><b>Man.</b></td>\n<td><b>Description</b></td>\n</tr>\n<tr>\n<td>remote_url</td>\n<td>Yes</td>\n<td>Appium server url</td>\n</tr>\n<tr>\n<td>alias</td>\n<td>no</td>\n<td>alias</td>\n</tr>\n</table>\n<p>Examples:</p>\n<table border=\"1\">\n<tr>\n<td>Open Application</td>\n<td><a href=\"http://localhost:4723/wd/hub\">http://localhost:4723/wd/hub</a></td>\n<td>alias=Myapp1</td>\n<td>platformName=iOS</td>\n<td>platformVersion=7.0</td>\n<td>deviceName='iPhone Simulator'</td>\n<td>app=your.app</td>\n<td></td>\n</tr>\n<tr>\n<td>Open Application</td>\n<td><a href=\"http://localhost:4723/wd/hub\">http://localhost:4723/wd/hub</a></td>\n<td>platformName=Android</td>\n<td>platformVersion=4.2.2</td>\n<td>deviceName=192.168.56.101:5555</td>\n<td>app=${CURDIR}/demoapp/OrangeDemoApp.apk</td>\n<td>appPackage=com.netease.qa.orangedemo</td>\n<td>appActivity=MainActivity</td>\n</tr>\n</table>", "shortdoc": "Opens a new application to given Appium server. Capabilities of appium server, Android and iOS, Please check https://github.com/appium/appium/blob/master/docs/en/writing-running-appium/server-args.md | *Option*            | *Man.* | *Description*     | | remote_url          | Yes    | Appium server url | | alias               | no     | alias             |", "tags": [], "source": "C:\\Git\\robotframework-applicationlibrary\\venv\\lib\\site-packages\\AppiumLibrary\\keywords\\_applicationmanagement.py", "lineno": 39}, {"name": "Open Notifications", "args": [], "doc": "<p>Opens and expands an Android device's notification drawer.</p>\n<p>Android only.</p>", "shortdoc": "Opens and expands an Android device's notification drawer.", "tags": [], "source": "C:\\Git\\robotframework-applicationlibrary\\venv\\lib\\site-packages\\AppiumLibrary\\keywords\\_android_utils.py", "lineno": 11}, {"name": "Page Should Contain Element", "args": [{"name": "locator", "types": [], "typedocs": {}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "locator"}, {"name": "loglevel", "types": [], "typedocs": {}, "defaultValue": "INFO", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "loglevel=INFO"}], "doc": "<p>Verifies that current page contains <span class=\"name\">locator</span> element.</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</span> argument. Giving <span class=\"name\">NONE</span> as level disables logging.</p>", "shortdoc": "Verifies that current page contains `locator` element.", "tags": [], "source": "C:\\Git\\robotframework-applicationlibrary\\venv\\lib\\site-packages\\AppiumLibrary\\keywords\\_element.py", "lineno": 129}, {"name": "Page Should Contain Text", "args": [{"name": "text", "types": [], "typedocs": {}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "text"}, {"name": "loglevel", "types": [], "typedocs": {}, "defaultValue": "INFO", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "loglevel=INFO"}], "doc": "<p>Verifies that current page contains <span class=\"name\">text</span>.</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</span> argument. Giving <span class=\"name\">NONE</span> as level disables logging.</p>", "shortdoc": "Verifies that current page contains `text`.", "tags": [], "source": "C:\\Git\\robotframework-applicationlibrary\\venv\\lib\\site-packages\\AppiumLibrary\\keywords\\_element.py", "lineno": 104}, {"name": "Page Should Not Contain Element", "args": [{"name": "locator", "types": [], "typedocs": {}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "locator"}, {"name": "loglevel", "types": [], "typedocs": {}, "defaultValue": "INFO", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "loglevel=INFO"}], "doc": "<p>Verifies that current page not contains <span class=\"name\">locator</span> element.</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</span> argument. Giving <span class=\"name\">NONE</span> as level disables logging.</p>", "shortdoc": "Verifies that current page not contains `locator` element.", "tags": [], "source": "C:\\Git\\robotframework-applicationlibrary\\venv\\lib\\site-packages\\AppiumLibrary\\keywords\\_element.py", "lineno": 142}, {"name": "Page Should Not Contain Text", "args": [{"name": "text", "types": [], "typedocs": {}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "text"}, {"name": "loglevel", "types": [], "typedocs": {}, "defaultValue": "INFO", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "loglevel=INFO"}], "doc": "<p>Verifies that current page not contains <span class=\"name\">text</span>.</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</span> argument. Giving <span class=\"name\">NONE</span> as level disables logging.</p>", "shortdoc": "Verifies that current page not contains `text`.", "tags": [], "source": "C:\\Git\\robotframework-applicationlibrary\\venv\\lib\\site-packages\\AppiumLibrary\\keywords\\_element.py", "lineno": 117}, {"name": "Pinch", "args": [{"name": "locator", "types": [], "typedocs": {}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "locator"}, {"name": "percent", "types": [], "typedocs": {}, "defaultValue": "200%", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "percent=200%"}, {"name": "steps", "types": [], "typedocs": {}, "defaultValue": "1", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "steps=1"}], "doc": "<p>Pinch in on an element a certain amount.</p>", "shortdoc": "Pinch in on an element a certain amount.", "tags": [], "source": "C:\\Git\\robotframework-applicationlibrary\\venv\\lib\\site-packages\\AppiumLibrary\\keywords\\_touch.py", "lineno": 23}, {"name": "Portrait", "args": [], "doc": "<p>Set the device orientation to PORTRAIT</p>", "shortdoc": "Set the device orientation to PORTRAIT", "tags": [], "source": "C:\\Git\\robotframework-applicationlibrary\\venv\\lib\\site-packages\\AppiumLibrary\\keywords\\_applicationmanagement.py", "lineno": 276}, {"name": "Press Keycode", "args": [{"name": "keycode", "types": [], "typedocs": {}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "keycode"}, {"name": "metastate", "types": [], "typedocs": {}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "metastate=None"}], "doc": "<p>Sends a press of keycode to the device.</p>\n<p>Android only.</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</a></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.</p>\n<p>For example</p>\n<ul>\n<li>META_SHIFT_ON = 1</li>\n<li>META_ALT_ON = 2</li>\n</ul>\n<pre>\nmetastate=1 --&gt; Shift is pressed\nmetastate=2 --&gt; Alt is pressed\nmetastate=3 --&gt; Shift+Alt is pressed\n</pre>\n<ul>\n<li>_keycode- - the keycode to be sent to the device</li>\n<li>_metastate- - status of the meta keys</li>\n</ul>", "shortdoc": "Sends a press of keycode to the device.", "tags": [], "source": "C:\\Git\\robotframework-applicationlibrary\\venv\\lib\\site-packages\\AppiumLibrary\\keywords\\_keyevent.py", "lineno": 9}, {"name": "Pull File", "args": [{"name": "path", "types": [], "typedocs": {}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "path"}, {"name": "decode", "types": [], "typedocs": {}, "defaultValue": "False", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "decode=False"}], "doc": "<p>Retrieves the file at <span class=\"name\">path</span> and return it's content.</p>\n<p>Android only.</p>\n<ul>\n<li><i>path</i> - the path to the file on the device</li>\n<li><i>decode</i> - True/False decode the data (base64) before returning it (default=False)</li>\n</ul>", "shortdoc": "Retrieves the file at `path` and return it's content.", "tags": [], "source": "C:\\Git\\robotframework-applicationlibrary\\venv\\lib\\site-packages\\AppiumLibrary\\keywords\\_android_utils.py", "lineno": 45}, {"name": "Pull Folder", "args": [{"name": "path", "types": [], "typedocs": {}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "path"}, {"name": "decode", "types": [], "typedocs": {}, "defaultValue": "False", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "decode=False"}], "doc": "<p>Retrieves a folder at <span class=\"name\">path</span>. Returns the folder's contents zipped.</p>\n<p>Android only.</p>\n<ul>\n<li><i>path</i> - the path to the folder on the device</li>\n<li><i>decode</i> - True/False decode the data (base64) before returning it (default=False)</li>\n</ul>", "shortdoc": "Retrieves a folder at `path`. Returns the folder's contents zipped.", "tags": [], "source": "C:\\Git\\robotframework-applicationlibrary\\venv\\lib\\site-packages\\AppiumLibrary\\keywords\\_android_utils.py", "lineno": 59}, {"name": "Push File", "args": [{"name": "path", "types": [], "typedocs": {}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "path"}, {"name": "data", "types": [], "typedocs": {}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "data"}, {"name": "encode", "types": [], "typedocs": {}, "defaultValue": "False", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "encode=False"}], "doc": "<p>Puts the data in the file specified as <span class=\"name\">path</span>.</p>\n<p>Android only.</p>\n<ul>\n<li><i>path</i> - the path on the device</li>\n<li><i>data</i> - data to be written to the file</li>\n<li><i>encode</i> - True/False encode the data as base64 before writing it to the file (default=False)</li>\n</ul>", "shortdoc": "Puts the data in the file specified as `path`.", "tags": [], "source": "C:\\Git\\robotframework-applicationlibrary\\venv\\lib\\site-packages\\AppiumLibrary\\keywords\\_android_utils.py", "lineno": 73}, {"name": "Quit Application", "args": [], "doc": "<p>Quit application. Application can be quit while Appium session is kept alive. This keyword can be used to close application during test case or between test cases.</p>\n<p>See <a href=\"#Launch%20Application\" class=\"name\">Launch Application</a> for an explanation.</p>\n<p>New in AppiumLibrary 1.4.6</p>", "shortdoc": "Quit application. Application can be quit while Appium session is kept alive. This keyword can be used to close application during test case or between test cases.", "tags": [], "source": "C:\\Git\\robotframework-applicationlibrary\\venv\\lib\\site-packages\\AppiumLibrary\\keywords\\_applicationmanagement.py", "lineno": 110}, {"name": "Register Keyword To Run On Failure", "args": [{"name": "keyword", "types": [], "typedocs": {}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "keyword"}], "doc": "<p>Sets the keyword to execute when a AppiumLibrary keyword fails.</p>\n<p><span class=\"name\">keyword_name</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.</p>\n<p>The initial keyword to use is set in <a href=\"#Importing\" class=\"name\">importing</a>, and the keyword that is used by default is <a href=\"#Capture%20Page%20Screenshot\" class=\"name\">Capture Page Screenshot</a>. Taking a screenshot when something failed is a very useful feature, but notice that it can slow down the execution.</p>\n<p>This keyword returns the name of the previously registered failure keyword. It can be used to restore the original value later.</p>\n<p>Example:</p>\n<table border=\"1\">\n<tr>\n<td>Register Keyword To Run On Failure</td>\n<td>Log Source</td>\n<td># Run <a href=\"#Log%20Source\" class=\"name\">Log Source</a> on failure.</td>\n<td></td>\n</tr>\n<tr>\n<td>${previous kw}=</td>\n<td>Register Keyword To Run On Failure</td>\n<td>Nothing</td>\n<td># Disables run-on-failure functionality and stores the previous kw name in a variable.</td>\n</tr>\n<tr>\n<td>Register Keyword To Run On Failure</td>\n<td>${previous kw}</td>\n<td># Restore to the previous keyword.</td>\n<td></td>\n</tr>\n</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.</p>", "shortdoc": "Sets the keyword to execute when a AppiumLibrary keyword fails.", "tags": [], "source": "C:\\Git\\robotframework-applicationlibrary\\venv\\lib\\site-packages\\AppiumLibrary\\keywords\\_runonfailure.py", "lineno": 17}, {"name": "Remove Application", "args": [{"name": "application_id", "types": [], "typedocs": {}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "application_id"}], "doc": "<p>Removes the application that is identified with an application id</p>\n<p>Example:</p>\n<table border=\"1\">\n<tr>\n<td>Remove Application</td>\n<td>com.netease.qa.orangedemo</td>\n</tr>\n</table>", "shortdoc": "Removes the application that is identified with an application id", "tags": [], "source": "C:\\Git\\robotframework-applicationlibrary\\venv\\lib\\site-packages\\AppiumLibrary\\keywords\\_applicationmanagement.py", "lineno": 127}, {"name": "Reset Application", "args": [], "doc": "<p>Reset application. Open Application can be reset while Appium session is kept alive.</p>", "shortdoc": "Reset application. Open Application can be reset while Appium session is kept alive.", "tags": [], "source": "C:\\Git\\robotframework-applicationlibrary\\venv\\lib\\site-packages\\AppiumLibrary\\keywords\\_applicationmanagement.py", "lineno": 121}, {"name": "Save Appium Screenshot", "args": [], "doc": "<p>Takes a screenshot with a unique filename to be stored in Robot Framework compiled reports.</p>", "shortdoc": "Takes a screenshot with a unique filename to be stored in Robot Framework compiled reports.", "tags": [], "source": "C:\\Git\\robotframework-applicationlibrary\\src\\ApplicationLibrary\\MobileLibrary.py", "lineno": 345}, {"name": "Scroll", "args": [{"name": "start_locator", "types": [], "typedocs": {}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "start_locator"}, {"name": "end_locator", "types": [], "typedocs": {}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "end_locator"}], "doc": "<p>Scrolls from one element to another Key attributes for arbitrary elements are <span class=\"name\">id</span> and <span class=\"name\">name</span>. See <a href=\"#Introduction\" class=\"name\">introduction</a> for details about locating elements.</p>", "shortdoc": "Scrolls from one element to another Key attributes for arbitrary elements are `id` and `name`. See `introduction` for details about locating elements.", "tags": [], "source": "C:\\Git\\robotframework-applicationlibrary\\venv\\lib\\site-packages\\AppiumLibrary\\keywords\\_touch.py", "lineno": 89}, {"name": "Scroll Down", "args": [{"name": "locator", "types": [], "typedocs": {}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "locator"}], "doc": "<p>Scrolls down to an element identified by <code>locator</code>.</p>", "shortdoc": "Scrolls down to an element identified by ``locator``.", "tags": [], "source": "C:\\Git\\robotframework-applicationlibrary\\src\\ApplicationLibrary\\MobileLibrary.py", "lineno": 294}, {"name": "Scroll Down To Text", "args": [{"name": "text", "types": [], "typedocs": {}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "text"}, {"name": "exact_match", "types": [], "typedocs": {}, "defaultValue": "False", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "exact_match=False"}, {"name": "swipe_count", "types": [], "typedocs": {}, "defaultValue": "10", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "swipe_count=10"}], "doc": "<p>Scrolls down to <code>text</code>.</p>\n<p>In some instances the default scroll behavior does not work. In this case the keyword will use small swipes to find the element. The <code>swipe_count</code> limits the number of these swipes before the keyword gives up, defaults to 10.</p>", "shortdoc": "Scrolls down to ``text``.", "tags": [], "source": "C:\\Git\\robotframework-applicationlibrary\\src\\ApplicationLibrary\\MobileLibrary.py", "lineno": 261}, {"name": "Scroll Up", "args": [{"name": "locator", "types": [], "typedocs": {}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "locator"}], "doc": "<p>Scrolls up to an element identified by <code>locator</code>.</p>", "shortdoc": "Scrolls up to an element identified by ``locator``.", "tags": [], "source": "C:\\Git\\robotframework-applicationlibrary\\src\\ApplicationLibrary\\MobileLibrary.py", "lineno": 303}, {"name": "Scroll Up To Text", "args": [{"name": "text", "types": [], "typedocs": {}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "text"}, {"name": "exact_match", "types": [], "typedocs": {}, "defaultValue": "False", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "exact_match=False"}, {"name": "swipe_count", "types": [], "typedocs": {}, "defaultValue": "10", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "swipe_count=10"}], "doc": "<p>Scrolls down to <code>text</code>.</p>\n<p>In some instances the default scroll behavior does not work. In this case the keyword will use small swipes to find the element. The <code>swipe_count</code> limits the number of these swipes before the keyword gives up, defaults to 10.</p>", "shortdoc": "Scrolls down to ``text``.", "tags": [], "source": "C:\\Git\\robotframework-applicationlibrary\\src\\ApplicationLibrary\\MobileLibrary.py", "lineno": 278}, {"name": "Set Appium Timeout", "args": [{"name": "seconds", "types": [], "typedocs": {}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "seconds"}], "doc": "<p>Sets the timeout in seconds used by various keywords.</p>\n<p>There are several <span class=\"name\">Wait ...</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.</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</a>.</p>\n<p>Example:</p>\n<table border=\"1\">\n<tr>\n<td>${orig timeout} =</td>\n<td>Set Appium Timeout</td>\n<td>15 seconds</td>\n</tr>\n<tr>\n<td>Open page that loads slowly</td>\n<td></td>\n<td></td>\n</tr>\n<tr>\n<td>Set Appium Timeout</td>\n<td>${orig timeout}</td>\n<td></td>\n</tr>\n</table>", "shortdoc": "Sets the timeout in seconds used by various keywords.", "tags": [], "source": "C:\\Git\\robotframework-applicationlibrary\\venv\\lib\\site-packages\\AppiumLibrary\\keywords\\_applicationmanagement.py", "lineno": 143}, {"name": "Set Location", "args": [{"name": "latitude", "types": [], "typedocs": {}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "latitude"}, {"name": "longitude", "types": [], "typedocs": {}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "longitude"}, {"name": "altitude", "types": [], "typedocs": {}, "defaultValue": "10", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "altitude=10"}], "doc": "<p>Set location</p>\n<ul>\n<li><i>latitute</i></li>\n<li><i>longitude</i></li>\n<li><i>altitude</i> = 10 [optional]</li>\n</ul>\n<p>Android only. New in AppiumLibrary 1.5</p>", "shortdoc": "Set location", "tags": [], "source": "C:\\Git\\robotframework-applicationlibrary\\venv\\lib\\site-packages\\AppiumLibrary\\keywords\\_android_utils.py", "lineno": 168}, {"name": "Set Network Connection Status", "args": [{"name": "connectionStatus", "types": [], "typedocs": {}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "connectionStatus"}], "doc": "<p>Sets the network connection Status.</p>\n<p>Android only.</p>\n<p>Possible values:</p>\n<table border=\"1\">\n<tr>\n<th>Value</th>\n<th>Alias</th>\n<th>Data</th>\n<th>Wifi</th>\n<th>Airplane Mode</th>\n</tr>\n<tr>\n<td>0</td>\n<td>(None)</td>\n<td>0</td>\n<td>0</td>\n<td>0</td>\n</tr>\n<tr>\n<td>1</td>\n<td>(Airplane Mode)</td>\n<td>0</td>\n<td>0</td>\n<td>1</td>\n</tr>\n<tr>\n<td>2</td>\n<td>(Wifi only)</td>\n<td>0</td>\n<td>1</td>\n<td>0</td>\n</tr>\n<tr>\n<td>4</td>\n<td>(Data only)</td>\n<td>1</td>\n<td>0</td>\n<td>0</td>\n</tr>\n<tr>\n<td>6</td>\n<td>(All network on)</td>\n<td>1</td>\n<td>1</td>\n<td>0</td>\n</tr>\n</table>", "shortdoc": "Sets the network connection Status.", "tags": [], "source": "C:\\Git\\robotframework-applicationlibrary\\venv\\lib\\site-packages\\AppiumLibrary\\keywords\\_android_utils.py", "lineno": 29}, {"name": "Shake", "args": [], "doc": "<p>Shake the device</p>", "shortdoc": "Shake the device", "tags": [], "source": "C:\\Git\\robotframework-applicationlibrary\\venv\\lib\\site-packages\\AppiumLibrary\\keywords\\_applicationmanagement.py", "lineno": 270}, {"name": "Start Activity", "args": [{"name": "appPackage", "types": [], "typedocs": {}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "appPackage"}, {"name": "appActivity", "types": [], "typedocs": {}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "appActivity"}, {"name": "opts", "types": [], "typedocs": {}, "defaultValue": null, "kind": "VAR_NAMED", "required": false, "repr": "**opts"}], "doc": "<p>Opens an arbitrary activity during a test. If the activity belongs to another application, that application is started and the activity is opened.</p>\n<p>Android only.</p>\n<ul>\n<li><i>appPackage</i> - The package containing the activity to start.</li>\n<li><i>appActivity</i> - The activity to start.</li>\n<li><i>appWaitPackage</i> - Begin automation after this package starts (optional).</li>\n<li><i>appWaitActivity</i> - Begin automation after this activity starts (optional).</li>\n<li><i>intentAction</i> - Intent to start (opt_ional).</li>\n<li><i>intentCategory</i> - Intent category to start (optional).</li>\n<li><i>intentFlags</i> - Flags to send to the intent (optional).</li>\n<li><i>optionalIntentArguments</i> - Optional arguments to the intent (optional).</li>\n<li><i>dontStopAppOnReset</i> - Should the app be stopped on reset (optional)?</li>\n</ul>", "shortdoc": "Opens an arbitrary activity during a test. If the activity belongs to another application, that application is started and the activity is opened.", "tags": [], "source": "C:\\Git\\robotframework-applicationlibrary\\venv\\lib\\site-packages\\AppiumLibrary\\keywords\\_android_utils.py", "lineno": 97}, {"name": "Start Screen Recording", "args": [{"name": "timeLimit", "types": [], "typedocs": {}, "defaultValue": "180s", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "timeLimit=180s"}, {"name": "options", "types": [], "typedocs": {}, "defaultValue": null, "kind": "VAR_NAMED", "required": false, "repr": "**options"}], "doc": "<p>Starts an asynchronous Screen Recording for the current open application.</p>\n<p><code>timeLimit</code> sets the actual time limit of the recorded video.</p>\n<ul>\n<li>The default value for both iOS and Android is 180 seconds (3 minutes).</li>\n<li>The maximum value for Android is 3 minutes.</li>\n<li>The maximum value for iOS is 10 minutes.</li>\n</ul>\n<h4>Optional Args</h4>\n<ul>\n<li><code>bitRate</code> (Android Only) The video bit rate for the video, in megabits per second. 4 Mbp/s(4000000) is by default for Android API level below 27.                                    20 Mb/s(20000000) for API level 27 and above.</li>\n</ul>\n<ul>\n<li><code>videoSize</code> (Android Only) The format is widthxheight. The default value is the                device's native display resolution (if supported), 1280x720 if not. For best                        results, use a size supported by your device's Advanced Video Coding (AVC)                          encoder. For example, \"1280x720\"</li>\n</ul>\n<ul>\n<li><code>bugReport</code> (Android Only) Set it to true in order to display additional                       information on the video overlay, such as a timestamp, that is helpful in                           videos captured to illustrate bugs. This option is only supported since                             API level 27 (Android O).</li>\n</ul>\n<ul>\n<li><code>videoQuality</code> (iOS Only) The video encoding quality (low, medium, high,                       photo - defaults to medium).</li>\n</ul>\n<ul>\n<li><code>videoFps</code>         (iOS Only) The Frames Per Second rate of the recorded video.                    Change this value if the resulting video is too slow or too fast. Defaults to 10.                   This can decrease the resulting file size.</li>\n</ul>\n<ul>\n<li><code>videoScale</code> (iOS Only) The scaling value to apply. Read                                       <a href=\"https://trac.ffmpeg.org/wiki/Scaling\">https://trac.ffmpeg.org/wiki/Scaling</a> for possible values. Example value of 720p                     scaling is '1280:720'. This can decrease/increase the resulting file size.                          No scale is applied by default.</li>\n</ul>\n<p><a href=\"#Start%20Screen%20Recording\" class=\"name\">Start Screen Recording</a> is used hand in hand with <a href=\"#Stop%20Screen%20Recording\" class=\"name\">Stop Screen Recording</a>. See <a href=\"#Stop%20Screen%20Recording\" class=\"name\">Stop Screen Recording</a> for more details. Example:</p>\n<table border=\"1\">\n<tr>\n<td><a href=\"#Start%20Screen%20Recording\" class=\"name\">Start Screen Recording</a></td>\n<td></td>\n<td># starts a screen record session</td>\n</tr>\n<tr>\n<td>....     keyword actions</td>\n<td></td>\n<td></td>\n</tr>\n<tr>\n<td><a href=\"#Stop%20Screen%20Recording\" class=\"name\">Stop Screen Recording</a></td>\n<td>filename=output</td>\n<td># saves the recorded session</td>\n</tr>\n</table>", "shortdoc": "Starts an asynchronous Screen Recording for the current open application.", "tags": [], "source": "C:\\Git\\robotframework-applicationlibrary\\venv\\lib\\site-packages\\AppiumLibrary\\keywords\\_screenrecord.py", "lineno": 16}, {"name": "Stop Screen Recording", "args": [{"name": "filename", "types": [], "typedocs": {}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "filename=None"}, {"name": "options", "types": [], "typedocs": {}, "defaultValue": null, "kind": "VAR_NAMED", "required": false, "repr": "**options"}], "doc": "<p>Gathers the output from the previously started screen recording              to a media file, then embeds it to the log.html(Android Only).</p>\n<p>Requires an active or exhausted Screen Recording Session. See <a href=\"#Start%20Screen%20Recording\" class=\"name\">Start Screen Recording</a> for more details.</p>\n<h4>Optional Args</h4>\n<ul>\n<li><code>remotePath</code> The path to the remote location, where the resulting video should be              uploaded. The following protocols are supported <i>http/https</i>, ftp. Null or empty                  string value (the default setting) means the content of resulting file should                       be encoded as Base64 and passed as the endpoint response value. An                                  exception will be thrown if the generated media file is too big to fit                              into the available process memory.</li>\n</ul>\n<ul>\n<li><code>username</code> The name of the user for the remote authentication.</li>\n</ul>\n<ul>\n<li><code>password</code> The password for the remote authentication.</li>\n</ul>\n<ul>\n<li><code>method</code> The http multipart upload method name. The <i>PUT</i> one is used by default.</li>\n</ul>\n<p>Example:</p>\n<table border=\"1\">\n<tr>\n<td><a href=\"#Start%20Screen%20Recording\" class=\"name\">Start Screen Recording</a></td>\n<td></td>\n<td># starts a screen record session</td>\n</tr>\n<tr>\n<td>....     keyword actions</td>\n<td></td>\n<td></td>\n</tr>\n<tr>\n<td><a href=\"#Stop%20Screen%20Recording\" class=\"name\">Stop Screen Recording</a></td>\n<td>filename=output</td>\n<td># saves the recorded session</td>\n</tr>\n</table>", "shortdoc": "Gathers the output from the previously started screen recording              to a media file, then embeds it to the log.html(Android Only).", "tags": [], "source": "C:\\Git\\robotframework-applicationlibrary\\venv\\lib\\site-packages\\AppiumLibrary\\keywords\\_screenrecord.py", "lineno": 68}, {"name": "Swipe", "args": [{"name": "start_x", "types": [], "typedocs": {}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "start_x"}, {"name": "start_y", "types": [], "typedocs": {}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "start_y"}, {"name": "offset_x", "types": [], "typedocs": {}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "offset_x"}, {"name": "offset_y", "types": [], "typedocs": {}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "offset_y"}, {"name": "duration", "types": [], "typedocs": {}, "defaultValue": "1000", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "duration=1000"}], "doc": "<p>Swipe from one point to another point, for an optional duration.</p>\n<p>Args:</p>\n<ul>\n<li>start_x - x-coordinate at which to start</li>\n<li>start_y - y-coordinate at which to start</li>\n<li>offset_x - x-coordinate distance from start_x at which to stop</li>\n<li>offset_y - y-coordinate distance from start_y at which to stop</li>\n<li>duration - (optional) time to take the swipe, in ms.</li>\n</ul>\n<p>Usage:</p>\n<table border=\"1\">\n<tr>\n<td>Swipe</td>\n<td>500</td>\n<td>100</td>\n<td>100</td>\n<td>0</td>\n<td>1000</td>\n</tr>\n</table>\n<p><i><b>NOTE: </b></i> Android 'Swipe' is not working properly, use <code>offset_x</code> and <code>offset_y</code> as if these are destination points.</p>", "shortdoc": "Swipe from one point to another point, for an optional duration.", "tags": [], "source": "C:\\Git\\robotframework-applicationlibrary\\venv\\lib\\site-packages\\AppiumLibrary\\keywords\\_touch.py", "lineno": 31}, {"name": "Swipe By Percent", "args": [{"name": "start_x", "types": [], "typedocs": {}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "start_x"}, {"name": "start_y", "types": [], "typedocs": {}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "start_y"}, {"name": "end_x", "types": [], "typedocs": {}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "end_x"}, {"name": "end_y", "types": [], "typedocs": {}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "end_y"}, {"name": "duration", "types": [], "typedocs": {}, "defaultValue": "1000", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "duration=1000"}], "doc": "<p>Swipe from one percent of the screen to another percent, for an optional duration. Normal swipe fails to scale for different screen resolutions, this can be avoided using percent.</p>\n<p>Args:</p>\n<ul>\n<li>start_x - x-percent at which to start</li>\n<li>start_y - y-percent at which to start</li>\n<li>end_x - x-percent distance from start_x at which to stop</li>\n<li>end_y - y-percent distance from start_y at which to stop</li>\n<li>duration - (optional) time to take the swipe, in ms.</li>\n</ul>\n<p>Usage:</p>\n<table border=\"1\">\n<tr>\n<td>Swipe By Percent</td>\n<td>90</td>\n<td>50</td>\n<td>10</td>\n<td>50</td>\n<td># Swipes screen from right to left.</td>\n</tr>\n</table>\n<p><i><b>NOTE: </b></i> This also considers swipe acts different between iOS and Android.</p>\n<p>New in AppiumLibrary 1.4.5</p>", "shortdoc": "Swipe from one percent of the screen to another percent, for an optional duration. Normal swipe fails to scale for different screen resolutions, this can be avoided using percent.", "tags": [], "source": "C:\\Git\\robotframework-applicationlibrary\\venv\\lib\\site-packages\\AppiumLibrary\\keywords\\_touch.py", "lineno": 55}, {"name": "Switch Application", "args": [{"name": "index_or_alias", "types": [], "typedocs": {}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "index_or_alias"}], "doc": "<p>Switches the active application by index or alias.</p>\n<p><span class=\"name\">index_or_alias</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</a>.</p>\n<p>This keyword returns the index of the previous active application, which can be used to switch back to that application later.</p>\n<p>Example:</p>\n<table border=\"1\">\n<tr>\n<td>${appium1}=</td>\n<td>Open Application</td>\n<td><a href=\"http://localhost:4723/wd/hub\">http://localhost:4723/wd/hub</a></td>\n<td>alias=MyApp1</td>\n<td>platformName=iOS</td>\n<td>platformVersion=7.0</td>\n<td>deviceName='iPhone Simulator'</td>\n<td>app=your.app</td>\n</tr>\n<tr>\n<td>${appium2}=</td>\n<td>Open Application</td>\n<td><a href=\"http://localhost:4755/wd/hub\">http://localhost:4755/wd/hub</a></td>\n<td>alias=MyApp2</td>\n<td>platformName=iOS</td>\n<td>platformVersion=7.0</td>\n<td>deviceName='iPhone Simulator'</td>\n<td>app=your.app</td>\n</tr>\n<tr>\n<td>Click Element</td>\n<td>sendHello</td>\n<td># Executed on appium running at localhost:4755</td>\n<td></td>\n<td></td>\n<td></td>\n<td></td>\n<td></td>\n</tr>\n<tr>\n<td>Switch Application</td>\n<td>${appium1}</td>\n<td># Switch using index</td>\n<td></td>\n<td></td>\n<td></td>\n<td></td>\n<td></td>\n</tr>\n<tr>\n<td>Click Element</td>\n<td>ackHello</td>\n<td># Executed on appium running at localhost:4723</td>\n<td></td>\n<td></td>\n<td></td>\n<td></td>\n<td></td>\n</tr>\n<tr>\n<td>Switch Application</td>\n<td>MyApp2</td>\n<td># Switch using alias</td>\n<td></td>\n<td></td>\n<td></td>\n<td></td>\n<td></td>\n</tr>\n<tr>\n<td>Page Should Contain Text</td>\n<td>ackHello Received</td>\n<td># Executed on appium running at localhost:4755</td>\n<td></td>\n<td></td>\n<td></td>\n<td></td>\n<td></td>\n</tr>\n</table>", "shortdoc": "Switches the active application by index or alias.", "tags": [], "source": "C:\\Git\\robotframework-applicationlibrary\\venv\\lib\\site-packages\\AppiumLibrary\\keywords\\_applicationmanagement.py", "lineno": 58}, {"name": "Switch To Context", "args": [{"name": "context_name", "types": [], "typedocs": {}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "context_name"}], "doc": "<p>Switch to a new context</p>", "shortdoc": "Switch to a new context", "tags": [], "source": "C:\\Git\\robotframework-applicationlibrary\\venv\\lib\\site-packages\\AppiumLibrary\\keywords\\_applicationmanagement.py", "lineno": 321}, {"name": "Switch To Frame", "args": [{"name": "frame", "types": [], "typedocs": {}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "frame"}], "doc": "<p>Switches focus to the specified frame, by index, name, or webelement.</p>\n<p>Example:</p>\n<table border=\"1\">\n<tr>\n<td>Go To Url</td>\n<td><a href=\"http://www.xxx.com\">http://www.xxx.com</a></td>\n</tr>\n</table>\n<pre>\nSwitch To Frame  | iframe_name|\nClick Element | xpath=//*[@id=\"online-btn\"] |\n</pre>", "shortdoc": "Switches focus to the specified frame, by index, name, or webelement.", "tags": [], "source": "C:\\Git\\robotframework-applicationlibrary\\venv\\lib\\site-packages\\AppiumLibrary\\keywords\\_applicationmanagement.py", "lineno": 325}, {"name": "Switch To Parent Frame", "args": [], "doc": "<p>Switches focus to the parent context. If the current context is the top level browsing context, the context remains unchanged.</p>", "shortdoc": "Switches focus to the parent context. If the current context is the top level browsing context, the context remains unchanged.", "tags": [], "source": "C:\\Git\\robotframework-applicationlibrary\\venv\\lib\\site-packages\\AppiumLibrary\\keywords\\_applicationmanagement.py", "lineno": 336}, {"name": "Tap", "args": [{"name": "locator", "types": [], "typedocs": {}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "locator"}, {"name": "x_offset", "types": [], "typedocs": {}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "x_offset=None"}, {"name": "y_offset", "types": [], "typedocs": {}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "y_offset=None"}, {"name": "count", "types": [], "typedocs": {}, "defaultValue": "1", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "count=1"}], "doc": "<p>Tap element identified by <code>locator</code>.</p>\n<p>Args:</p>\n<ul>\n<li><code>locator</code> - (mandatory). Taps coordinates when set to ${None}.</li>\n<li><code>x_offset</code> - (optional) x coordinate to tap, relative to the top left corner of the element.</li>\n<li><code>y_offset</code> - (optional) y coordinate. If y is used, x must also be set, and vice versa</li>\n<li><code>count</code> - can be used for multiple times of tap on that element</li>\n</ul>", "shortdoc": "Tap element identified by ``locator``. ", "tags": [], "source": "C:\\Git\\robotframework-applicationlibrary\\venv\\lib\\site-packages\\AppiumLibrary\\keywords\\_touch.py", "lineno": 119}, {"name": "Tap With Number Of Taps", "args": [{"name": "locator", "types": [], "typedocs": {}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "locator"}, {"name": "number_of_taps", "types": [], "typedocs": {}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "number_of_taps"}, {"name": "number_of_touches", "types": [], "typedocs": {}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "number_of_touches"}], "doc": "<p>Sends one or more taps with one or more touch points.iOS only.</p>\n<p>Args:</p>\n<ul>\n<li><code>number_of_taps</code> - The number of taps.</li>\n<li><code>number_of_touches</code> - The number of touch points.</li>\n</ul>", "shortdoc": "Sends one or more taps with one or more touch points.iOS only.", "tags": [], "source": "C:\\Git\\robotframework-applicationlibrary\\venv\\lib\\site-packages\\AppiumLibrary\\keywords\\_touch.py", "lineno": 133}, {"name": "Text Should Be Visible", "args": [{"name": "text", "types": [], "typedocs": {}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "text"}, {"name": "exact_match", "types": [], "typedocs": {}, "defaultValue": "False", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "exact_match=False"}, {"name": "loglevel", "types": [], "typedocs": {}, "defaultValue": "INFO", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "loglevel=INFO"}], "doc": "<p>Verifies that element identified with text is visible.</p>\n<p>New in AppiumLibrary 1.4.5</p>", "shortdoc": "Verifies that element identified with text is visible.", "tags": [], "source": "C:\\Git\\robotframework-applicationlibrary\\venv\\lib\\site-packages\\AppiumLibrary\\keywords\\_element.py", "lineno": 440}, {"name": "Toggle Touch Id Enrollment", "args": [], "doc": "<p>Toggle Touch ID enrolled state on iOS Simulator</p>\n<p>New in AppiumLibrary 1.5</p>", "shortdoc": "Toggle Touch ID enrolled state on iOS Simulator", "tags": [], "source": "C:\\Git\\robotframework-applicationlibrary\\venv\\lib\\site-packages\\AppiumLibrary\\keywords\\_applicationmanagement.py", "lineno": 262}, {"name": "Touch Id", "args": [{"name": "match", "types": [], "typedocs": {}, "defaultValue": "True", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "match=True"}], "doc": "<p>Simulate Touch ID on iOS Simulator</p>\n<p><span class=\"name\">match</span> (boolean) whether the simulated fingerprint is valid (default true)</p>\n<p>New in AppiumLibrary 1.5</p>", "shortdoc": "Simulate Touch ID on iOS Simulator", "tags": [], "source": "C:\\Git\\robotframework-applicationlibrary\\venv\\lib\\site-packages\\AppiumLibrary\\keywords\\_applicationmanagement.py", "lineno": 252}, {"name": "Wait Activity", "args": [{"name": "activity", "types": [], "typedocs": {}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "activity"}, {"name": "timeout", "types": [], "typedocs": {}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "timeout"}, {"name": "interval", "types": [], "typedocs": {}, "defaultValue": "1", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "interval=1"}], "doc": "<p>Wait for an activity: block until target activity presents or time out.</p>\n<p>Android only.</p>\n<ul>\n<li><i>activity</i> - target activity</li>\n<li><i>timeout</i> - max wait time, in seconds</li>\n<li><i>interval</i> - sleep interval between retries, in seconds</li>\n</ul>", "shortdoc": "Wait for an activity: block until target activity presents or time out.", "tags": [], "source": "C:\\Git\\robotframework-applicationlibrary\\venv\\lib\\site-packages\\AppiumLibrary\\keywords\\_android_utils.py", "lineno": 138}, {"name": "Wait For And Clear Text", "args": [{"name": "locator", "types": [], "typedocs": {}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "locator"}, {"name": "timeout", "types": [], "typedocs": {}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "timeout=None"}, {"name": "error", "types": [], "typedocs": {}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "error=None"}], "doc": "<p>Wait for and then clear the text field identified by <code>locator</code>.</p>\n<p>Fails if <code>timeout</code> expires before the element appears.</p>\n<p><code>error</code> can be used to override the default error message.</p>\n<p>See <a href=\"#Introduction\" class=\"name\">introduction</a> for details about locating elements.</p>", "shortdoc": "Wait for and then clear the text field identified by ``locator``.", "tags": [], "source": "C:\\Git\\robotframework-applicationlibrary\\src\\ApplicationLibrary\\MobileLibrary.py", "lineno": 88}, {"name": "Wait For And Click Button", "args": [{"name": "locator", "types": [], "typedocs": {}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "locator"}, {"name": "timeout", "types": [], "typedocs": {}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "timeout=None"}, {"name": "error", "types": [], "typedocs": {}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "error=None"}], "doc": "<p>Wait for and click the button identified by <code>locator</code>.</p>\n<p>Fails if <code>timeout</code> expires before the element appears.</p>\n<p><code>error</code> can be used to override the default error message.</p>\n<p>See <a href=\"#Introduction\" class=\"name\">introduction</a> for details about locating elements.</p>", "shortdoc": "Wait for and click the button identified by ``locator``.", "tags": [], "source": "C:\\Git\\robotframework-applicationlibrary\\src\\ApplicationLibrary\\MobileLibrary.py", "lineno": 125}, {"name": "Wait For And Click Element", "args": [{"name": "locator", "types": [], "typedocs": {}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "locator"}, {"name": "timeout", "types": [], "typedocs": {}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "timeout=None"}, {"name": "error", "types": [], "typedocs": {}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "error=None"}], "doc": "<p>Wait for and click the element identified by <code>locator</code>.</p>\n<p>Fails if <code>timeout</code> expires before the element appears.</p>\n<p><code>error</code> can be used to override the default error message.</p>\n<p>See <a href=\"#Introduction\" class=\"name\">introduction</a> for details about locating elements.</p>", "shortdoc": "Wait for and click the element identified by ``locator``.", "tags": [], "source": "C:\\Git\\robotframework-applicationlibrary\\src\\ApplicationLibrary\\MobileLibrary.py", "lineno": 100}, {"name": "Wait For And Click Text", "args": [{"name": "text", "types": [], "typedocs": {}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "text"}, {"name": "exact_match", "types": [], "typedocs": {}, "defaultValue": "False", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "exact_match=False"}, {"name": "timeout", "types": [], "typedocs": {}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "timeout=None"}, {"name": "error", "types": [], "typedocs": {}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "error=None"}], "doc": "<p>Wait for and click text identified by <code>text</code>.</p>\n<p>Fails if <code>timeout</code> expires before the element appears.</p>\n<p><code>error</code> can be used to override the default error message.</p>\n<p>By default tries to click first text involves given <code>text</code>. If you would like to click exactly matching text, then set <code>exact_match</code> to <span class=\"name\">True</span>.</p>", "shortdoc": "Wait for and click text identified by ``text``.", "tags": [], "source": "C:\\Git\\robotframework-applicationlibrary\\src\\ApplicationLibrary\\MobileLibrary.py", "lineno": 112}, {"name": "Wait For And Input Password", "args": [{"name": "locator", "types": [], "typedocs": {}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "locator"}, {"name": "text", "types": [], "typedocs": {}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "text"}, {"name": "timeout", "types": [], "typedocs": {}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "timeout=None"}, {"name": "error", "types": [], "typedocs": {}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "error=None"}], "doc": "<p>Wait for and type the given password into the text field identified by <code>locator</code>.</p>\n<p>Fails if <code>timeout</code> expires before the element appears.</p>\n<p><code>error</code> can be used to override the default error message.</p>\n<p>The difference between this keyword and <a href=\"#Wait%20For%20And%20Input%20Text\" class=\"name\">Wait For And Input Text</a> is that this keyword does not log the given password. See <a href=\"#Introduction\" class=\"name\">introduction</a> for details about locating elements.</p>", "shortdoc": "Wait for and type the given password into the text field identified by ``locator``.", "tags": [], "source": "C:\\Git\\robotframework-applicationlibrary\\src\\ApplicationLibrary\\MobileLibrary.py", "lineno": 137}, {"name": "Wait For And Input Text", "args": [{"name": "locator", "types": [], "typedocs": {}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "locator"}, {"name": "text", "types": [], "typedocs": {}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "text"}, {"name": "timeout", "types": [], "typedocs": {}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "timeout=None"}, {"name": "error", "types": [], "typedocs": {}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "error=None"}], "doc": "<p>Wait for and type the given <code>locator</code> into text field identified by <code>locator</code>.</p>\n<p>Fails if <code>timeout</code> expires before the element appears.</p>\n<p><code>error</code> can be used to override the default error message.</p>\n<p>See <a href=\"#Introduction\" class=\"name\">introduction</a> for details about locating elements.</p>", "shortdoc": "Wait for and type the given ``locator`` into text field identified by ``locator``.", "tags": [], "source": "C:\\Git\\robotframework-applicationlibrary\\src\\ApplicationLibrary\\MobileLibrary.py", "lineno": 150}, {"name": "Wait For And Input Value", "args": [{"name": "locator", "types": [], "typedocs": {}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "locator"}, {"name": "value", "types": [], "typedocs": {}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "value"}, {"name": "timeout", "types": [], "typedocs": {}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "timeout=None"}, {"name": "error", "types": [], "typedocs": {}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "error=None"}], "doc": "<p>Wait for and set the given <code>value</code> into the text field identified by <code>locator</code>. This is an IOS only keyword, input value makes use of set_value.</p>\n<p>Fails if <code>timeout</code> expires before the element appears.</p>\n<p><code>error</code> can be used to override the default error message.</p>\n<p>The difference between this keyword and <a href=\"#Wait%20For%20And%20Input%20Text\" class=\"name\">Wait For And Input Text</a> is that this keyword does not log the given password. See <a href=\"#Introduction\" class=\"name\">introduction</a> for details about locating elements.</p>", "shortdoc": "Wait for and set the given ``value`` into the text field identified by ``locator``. This is an IOS only keyword, input value makes use of set_value.", "tags": [], "source": "C:\\Git\\robotframework-applicationlibrary\\src\\ApplicationLibrary\\MobileLibrary.py", "lineno": 162}, {"name": "Wait For And Long Press", "args": [{"name": "locator", "types": [], "typedocs": {}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "locator"}, {"name": "duration", "types": [], "typedocs": {}, "defaultValue": "5000", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "duration=5000"}, {"name": "timeout", "types": [], "typedocs": {}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "timeout=None"}, {"name": "error", "types": [], "typedocs": {}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "error=None"}], "doc": "<p>Wait for and long press the element identified by <code>locator</code> with optional duration.</p>\n<p>Fails if <code>timeout</code> expires before the element appears.</p>\n<p><code>error</code> can be used to override the default error message.</p>\n<p>See <a href=\"#Introduction\" class=\"name\">introduction</a> for details about locating elements.</p>", "shortdoc": "Wait for and long press the element identified by ``locator`` with optional duration.", "tags": [], "source": "C:\\Git\\robotframework-applicationlibrary\\src\\ApplicationLibrary\\MobileLibrary.py", "lineno": 176}, {"name": "Wait For And Tap", "args": [{"name": "locator", "types": [], "typedocs": {}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "locator"}, {"name": "x_offset", "types": [], "typedocs": {}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "x_offset=None"}, {"name": "y_offset", "types": [], "typedocs": {}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "y_offset=None"}, {"name": "count", "types": [], "typedocs": {}, "defaultValue": "1", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "count=1"}, {"name": "timeout", "types": [], "typedocs": {}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "timeout=None"}, {"name": "error", "types": [], "typedocs": {}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "error=None"}], "doc": "<p>Wait for and then Tap element identified by <code>locator</code>. Args:</p>\n<ul>\n<li><code>x_offset</code> - (optional) x coordinate to tap, relative to the top left corner of the element.</li>\n<li><code>y_offset</code> - (optional) y coordinate. If y is used, x must also be set, and vice versa</li>\n<li><code>count</code> - can be used to tap multiple times</li>\n<li><code>timeout</code> - time in seconds to locate the element, defaults to global timeout</li>\n<li><code>error</code> - (optional) used to override the default error message.</li>\n</ul>", "shortdoc": "Wait for and then Tap element identified by ``locator``. Args: - ``x_offset`` - (optional) x coordinate to tap, relative to the top left corner of the element. - ``y_offset`` - (optional) y coordinate. If y is used, x must also be set, and vice versa - ``count`` - can be used to tap multiple times - ``timeout`` - time in seconds to locate the element, defaults to global timeout - ``error`` - (optional) used to override the default error message.", "tags": [], "source": "C:\\Git\\robotframework-applicationlibrary\\src\\ApplicationLibrary\\MobileLibrary.py", "lineno": 313}, {"name": "Wait Until Element Contains", "args": [{"name": "locator", "types": [], "typedocs": {}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "locator"}, {"name": "text", "types": [], "typedocs": {}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "text"}, {"name": "timeout", "types": [], "typedocs": {}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "timeout=None"}, {"name": "error", "types": [], "typedocs": {}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "error=None"}], "doc": "<p>Waits until element specified with <code>locator</code> contains <code>text</code>.</p>\n<p>Fails if <code>timeout</code> expires before the element appears.</p>\n<p><code>error</code> can be used to override the default error message.</p>\n<p>See also <a href=\"#Wait%20Until%20Page%20Contains\" class=\"name\">Wait Until Page Contains</a>, <a href=\"#Wait%20Until%20Page%20Does%20Not%20Contain\" class=\"name\">Wait Until Page Does Not Contain</a> <a href=\"#Wait%20Until%20Page%20Does%20Not%20Contain%20Element\" class=\"name\">Wait Until Page Does Not Contain Element</a></p>", "shortdoc": "Waits until element specified with ``locator`` contains ``text``.", "tags": [], "source": "C:\\Git\\robotframework-applicationlibrary\\src\\ApplicationLibrary\\MobileLibrary.py", "lineno": 188}, {"name": "Wait Until Element Does Not Contain", "args": [{"name": "locator", "types": [], "typedocs": {}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "locator"}, {"name": "text", "types": [], "typedocs": {}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "text"}, {"name": "timeout", "types": [], "typedocs": {}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "timeout=None"}, {"name": "error", "types": [], "typedocs": {}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "error=None"}], "doc": "<p>Waits until element specified with <code>locator</code> does not contain <code>text</code>.</p>\n<p>Fails if <code>timeout</code> expires before the element appears.</p>\n<p><code>error</code> can be used to override the default error message.</p>\n<p>See also <a href=\"#Wait%20Until%20Element%20Contains\" class=\"name\">Wait Until Element Contains</a>, <a href=\"#Wait%20Until%20Page%20Contains\" class=\"name\">Wait Until Page Contains</a>, <a href=\"#Wait%20Until%20Page%20Does%20Not%20Contain\" class=\"name\">Wait Until Page Does Not Contain</a> <a href=\"#Wait%20Until%20Page%20Does%20Not%20Contain%20Element\" class=\"name\">Wait Until Page Does Not Contain Element</a></p>", "shortdoc": "Waits until element specified with ``locator`` does not contain ``text``.", "tags": [], "source": "C:\\Git\\robotframework-applicationlibrary\\src\\ApplicationLibrary\\MobileLibrary.py", "lineno": 203}, {"name": "Wait Until Element Is Disabled", "args": [{"name": "locator", "types": [], "typedocs": {}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "locator"}, {"name": "timeout", "types": [], "typedocs": {}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "timeout=None"}, {"name": "error", "types": [], "typedocs": {}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "error=None"}], "doc": "<p>Waits until element specified with <code>locator</code> is disabled.</p>\n<p>Fails if <code>timeout</code> expires before the element appears.</p>\n<p><code>error</code> can be used to override the default error message.</p>\n<p>See also <a href=\"#Wait%20Until%20Element%20Is%20Disabled\" class=\"name\">Wait Until Element Is Disabled</a></p>", "shortdoc": "Waits until element specified with ``locator`` is disabled.", "tags": [], "source": "C:\\Git\\robotframework-applicationlibrary\\src\\ApplicationLibrary\\MobileLibrary.py", "lineno": 232}, {"name": "Wait Until Element Is Enabled", "args": [{"name": "locator", "types": [], "typedocs": {}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "locator"}, {"name": "timeout", "types": [], "typedocs": {}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "timeout=None"}, {"name": "error", "types": [], "typedocs": {}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "error=None"}], "doc": "<p>Waits until element specified with <code>locator</code> is enabled.</p>\n<p>Fails if <code>timeout</code> expires before the element appears.</p>\n<p><code>error</code> can be used to override the default error message.</p>\n<p>See also <a href=\"#Wait%20Until%20Element%20Is%20Disabled\" class=\"name\">Wait Until Element Is Disabled</a></p>", "shortdoc": "Waits until element specified with ``locator`` is enabled.", "tags": [], "source": "C:\\Git\\robotframework-applicationlibrary\\src\\ApplicationLibrary\\MobileLibrary.py", "lineno": 219}, {"name": "Wait Until Element Is Visible", "args": [{"name": "locator", "types": [], "typedocs": {}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "locator"}, {"name": "timeout", "types": [], "typedocs": {}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "timeout=None"}, {"name": "error", "types": [], "typedocs": {}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "error=None"}], "doc": "<p>Waits until element specified with <span class=\"name\">locator</span> is visible.</p>\n<p>Fails if <span class=\"name\">timeout</span> expires before the element is visible. See <a href=\"#Introduction\" class=\"name\">introduction</a> for more information about <span class=\"name\">timeout</span> and its default value.</p>\n<p><span class=\"name\">error</span> can be used to override the default error message.</p>\n<p>See also <a href=\"#Wait%20Until%20Page%20Contains\" class=\"name\">Wait Until Page Contains</a>, <a href=\"#Wait%20Until%20Page%20Contains%20Element\" class=\"name\">Wait Until Page Contains Element</a>, <span class=\"name\">Wait For Condition</span> and BuiltIn keyword <span class=\"name\">Wait Until Keyword Succeeds</span>.</p>", "shortdoc": "Waits until element specified with `locator` is visible.", "tags": [], "source": "C:\\Git\\robotframework-applicationlibrary\\venv\\lib\\site-packages\\AppiumLibrary\\keywords\\_waiting.py", "lineno": 7}, {"name": "Wait Until Page Contains", "args": [{"name": "text", "types": [], "typedocs": {}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "text"}, {"name": "timeout", "types": [], "typedocs": {}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "timeout=None"}, {"name": "error", "types": [], "typedocs": {}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "error=None"}], "doc": "<p>Waits until <span class=\"name\">text</span> appears on current page.</p>\n<p>Fails if <span class=\"name\">timeout</span> expires before the text appears. See <a href=\"#Introduction\" class=\"name\">introduction</a> for more information about <span class=\"name\">timeout</span> and its default value.</p>\n<p><span class=\"name\">error</span> can be used to override the default error message.</p>\n<p>See also <a href=\"#Wait%20Until%20Page%20Does%20Not%20Contain\" class=\"name\">Wait Until Page Does Not Contain</a>, <a href=\"#Wait%20Until%20Page%20Contains%20Element\" class=\"name\">Wait Until Page Contains Element</a>, <a href=\"#Wait%20Until%20Page%20Does%20Not%20Contain%20Element\" class=\"name\">Wait Until Page Does Not Contain Element</a> and BuiltIn keyword <span class=\"name\">Wait Until Keyword Succeeds</span>.</p>", "shortdoc": "Waits until `text` appears on current page.", "tags": [], "source": "C:\\Git\\robotframework-applicationlibrary\\venv\\lib\\site-packages\\AppiumLibrary\\keywords\\_waiting.py", "lineno": 30}, {"name": "Wait Until Page Contains Element", "args": [{"name": "locator", "types": [], "typedocs": {}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "locator"}, {"name": "timeout", "types": [], "typedocs": {}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "timeout=None"}, {"name": "error", "types": [], "typedocs": {}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "error=None"}], "doc": "<p>Waits until element specified with <span class=\"name\">locator</span> appears on current page.</p>\n<p>Fails if <span class=\"name\">timeout</span> expires before the element appears. See <a href=\"#Introduction\" class=\"name\">introduction</a> for more information about <span class=\"name\">timeout</span> and its default value.</p>\n<p><span class=\"name\">error</span> can be used to override the default error message.</p>\n<p>See also <a href=\"#Wait%20Until%20Page%20Contains\" class=\"name\">Wait Until Page Contains</a>, <a href=\"#Wait%20Until%20Page%20Does%20Not%20Contain\" class=\"name\">Wait Until Page Does Not Contain</a> <a href=\"#Wait%20Until%20Page%20Does%20Not%20Contain%20Element\" class=\"name\">Wait Until Page Does Not Contain Element</a> and BuiltIn keyword <span class=\"name\">Wait Until Keyword Succeeds</span>.</p>", "shortdoc": "Waits until element specified with `locator` appears on current page.", "tags": [], "source": "C:\\Git\\robotframework-applicationlibrary\\venv\\lib\\site-packages\\AppiumLibrary\\keywords\\_waiting.py", "lineno": 72}, {"name": "Wait Until Page Does Not Contain", "args": [{"name": "text", "types": [], "typedocs": {}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "text"}, {"name": "timeout", "types": [], "typedocs": {}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "timeout=None"}, {"name": "error", "types": [], "typedocs": {}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "error=None"}], "doc": "<p>Waits until <span class=\"name\">text</span> disappears from current page.</p>\n<p>Fails if <span class=\"name\">timeout</span> expires before the <span class=\"name\">text</span> disappears. See <a href=\"#Introduction\" class=\"name\">introduction</a> for more information about <span class=\"name\">timeout</span> and its default value.</p>\n<p><span class=\"name\">error</span> can be used to override the default error message.</p>\n<p>See also <a href=\"#Wait%20Until%20Page%20Contains\" class=\"name\">Wait Until Page Contains</a>, <a href=\"#Wait%20Until%20Page%20Contains%20Element\" class=\"name\">Wait Until Page Contains Element</a>, <a href=\"#Wait%20Until%20Page%20Does%20Not%20Contain%20Element\" class=\"name\">Wait Until Page Does Not Contain Element</a> and BuiltIn keyword <span class=\"name\">Wait Until Keyword Succeeds</span>.</p>", "shortdoc": "Waits until `text` disappears from current page.", "tags": [], "source": "C:\\Git\\robotframework-applicationlibrary\\venv\\lib\\site-packages\\AppiumLibrary\\keywords\\_waiting.py", "lineno": 48}, {"name": "Wait Until Page Does Not Contain Element", "args": [{"name": "locator", "types": [], "typedocs": {}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "locator"}, {"name": "timeout", "types": [], "typedocs": {}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "timeout=None"}, {"name": "error", "types": [], "typedocs": {}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "error=None"}], "doc": "<p>Waits until element specified with <span class=\"name\">locator</span> disappears from current page.</p>\n<p>Fails if <span class=\"name\">timeout</span> expires before the element disappears. See <a href=\"#Introduction\" class=\"name\">introduction</a> for more information about <span class=\"name\">timeout</span> and its default value.</p>\n<p><span class=\"name\">error</span> can be used to override the default error message.</p>\n<p>See also <a href=\"#Wait%20Until%20Page%20Contains\" class=\"name\">Wait Until Page Contains</a>, <a href=\"#Wait%20Until%20Page%20Does%20Not%20Contain\" class=\"name\">Wait Until Page Does Not Contain</a>, <a href=\"#Wait%20Until%20Page%20Contains%20Element\" class=\"name\">Wait Until Page Contains Element</a> and BuiltIn keyword <span class=\"name\">Wait Until Keyword Succeeds</span>.</p>", "shortdoc": "Waits until element specified with `locator` disappears from current page.", "tags": [], "source": "C:\\Git\\robotframework-applicationlibrary\\venv\\lib\\site-packages\\AppiumLibrary\\keywords\\_waiting.py", "lineno": 90}, {"name": "Xpath Should Match X Times", "args": [{"name": "xpath", "types": [], "typedocs": {}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "xpath"}, {"name": "count", "types": [], "typedocs": {}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "count"}, {"name": "error", "types": [], "typedocs": {}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "error=None"}, {"name": "loglevel", "types": [], "typedocs": {}, "defaultValue": "INFO", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "loglevel=INFO"}], "doc": "<p>Verifies that the page contains the given number of elements located by the given <code>xpath</code>.</p>\n<p>One should not use the <span class=\"name\">xpath=</span> prefix for 'xpath'. XPath is assumed.</p>\n<table border=\"1\">\n<tr>\n<td><b>Correct:</b></td>\n<td></td>\n<td></td>\n</tr>\n<tr>\n<td>Xpath Should Match X Times</td>\n<td>//android.view.View[@text='Test']</td>\n<td>1</td>\n</tr>\n<tr>\n<td>Incorrect:</td>\n<td></td>\n<td></td>\n</tr>\n<tr>\n<td>Xpath Should Match X Times</td>\n<td>xpath=//android.view.View[@text='Test']</td>\n<td>1</td>\n</tr>\n</table>\n<p><code>error</code> can be used to override the default error message.</p>\n<p>See <a href=\"#Log%20Source\" class=\"name\">Log Source</a> for explanation about <code>loglevel</code> argument.</p>\n<p>New in AppiumLibrary 1.4.</p>", "shortdoc": "Verifies that the page contains the given number of elements located by the given ``xpath``.", "tags": [], "source": "C:\\Git\\robotframework-applicationlibrary\\venv\\lib\\site-packages\\AppiumLibrary\\keywords\\_element.py", "lineno": 450}, {"name": "Zoom", "args": [{"name": "locator", "types": [], "typedocs": {}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "locator"}, {"name": "percent", "types": [], "typedocs": {}, "defaultValue": "200%", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "percent=200%"}, {"name": "steps", "types": [], "typedocs": {}, "defaultValue": "1", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "steps=1"}], "doc": "<p>Zooms in on an element a certain amount.</p>", "shortdoc": "Zooms in on an element a certain amount.", "tags": [], "source": "C:\\Git\\robotframework-applicationlibrary\\venv\\lib\\site-packages\\AppiumLibrary\\keywords\\_touch.py", "lineno": 15}], "dataTypes": {"enums": [], "typedDicts": []}, "typedocs": []}
+libdoc = {"specversion": 1, "name": "Mobile_Library", "doc": "<p>ApplicationLibrary Mobile Library</p>\n<p>This class is the base Library used to generate automated Mobile Tests in the Robot Automation Framework using Appium. This Library uses and extends the robotframework-appiumlibrary.</p>\n<h2 id=\"Locating or Specifying Elements\">Locating or Specifying Elements</h2>\n<p>All keywords in MobileLibrary that need to find an element on the page take an argument, either a <code>locator</code> or a <code>webelement</code>. <code>locator</code> is a string that describes how to locate an element using a syntax specifying different location strategies. <code>webelement</code> is a variable that holds a WebElement instance, which is a representation of the element.</p>\n<h3 id=\"Using locators\">Using locators</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</code> for all elements and locating elements is easy using just the <code>id</code>. For example:</p>\n<pre>\nClick Element    id=my_element\n</pre>\n<p><code>id</code> and <code>xpath</code> are not required to be specified, however <code>xpath</code> should start with <code>//</code> else just use <code>xpath</code> locator as explained below.</p>\n<p>For example:</p>\n<pre>\nClick Element    my_element\nWait Until Page Contains Element    //*[@type=\"android.widget.EditText\"]\n</pre>\n<p>Appium additionally supports some of the <a href=\"https://w3c.github.io/webdriver/webdriver-spec.html\">Mobile JSON Wire Protocol</a> locator strategies. It is also possible to specify the approach MobileLibrary should take to find an element by specifying a lookup strategy with a locator prefix. Supported strategies are:</p>\n<table border=\"1\">\n<tr>\n<td><b>Strategy</b></td>\n<td><b>Example</b></td>\n<td><b>Description</b></td>\n<td><b>Note</b></td>\n</tr>\n<tr>\n<td>identifier</td>\n<td>Click Element <span class=\"name\">|</span> identifier=my_element</td>\n<td>Matches by @id attribute</td>\n<td></td>\n</tr>\n<tr>\n<td>id</td>\n<td>Click Element <span class=\"name\">|</span> id=my_element</td>\n<td>Matches by @resource-id attribute</td>\n<td></td>\n</tr>\n<tr>\n<td>accessibility_id</td>\n<td>Click Element <span class=\"name\">|</span> accessibility_id=button3</td>\n<td>Accessibility options utilize.</td>\n<td></td>\n</tr>\n<tr>\n<td>xpath</td>\n<td>Click Element <span class=\"name\">|</span> xpath=//UIATableView/UIATableCell/UIAButton</td>\n<td>Matches with arbitrary XPath</td>\n<td></td>\n</tr>\n<tr>\n<td>class</td>\n<td>Click Element <span class=\"name\">|</span> class=UIAPickerWheel</td>\n<td>Matches by class</td>\n<td></td>\n</tr>\n<tr>\n<td>android</td>\n<td>Click Element <span class=\"name\">|</span> android=UiSelector().description('Apps')</td>\n<td>Matches by Android UI Automator</td>\n<td></td>\n</tr>\n<tr>\n<td>ios</td>\n<td>Click Element <span class=\"name\">|</span> ios=.buttons().withName('Apps')</td>\n<td>Matches by iOS UI Automation</td>\n<td></td>\n</tr>\n<tr>\n<td>nsp</td>\n<td>Click Element <span class=\"name\">|</span> nsp=name==\"login\"</td>\n<td>Matches by iOSNsPredicate</td>\n<td></td>\n</tr>\n<tr>\n<td>css</td>\n<td>Click Element <span class=\"name\">|</span> css=.green_button</td>\n<td>Matches by css in webview</td>\n<td></td>\n</tr>\n<tr>\n<td>name</td>\n<td>Click Element <span class=\"name\">|</span> name=my_element</td>\n<td>Matches by @name attribute</td>\n<td><b>Only valid</b> for Selendroid</td>\n</tr>\n</table>\n<h3 id=\"Using webelements\">Using webelements</h3>\n<p>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</a> or <a href=\"#Get%20Webelement\" class=\"name\">Get WebElement</a> keyword.</p>\n<p>For example:</p>\n<pre>\n@{elements}    Get Webelements    class=UIAButton\nClick Element    @{elements}[2]\n</pre>", "version": "1.1.2", "generated": "2023-06-12 14:01:42", "type": "LIBRARY", "scope": "GLOBAL", "docFormat": "HTML", "source": "C:\\Git\\robotframework-applicationlibrary\\src\\ApplicationLibrary\\MobileLibrary.py", "lineno": 14, "tags": [], "inits": [{"name": "__init__", "args": [{"name": "timeout", "types": [], "typedocs": {}, "defaultValue": "5", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "timeout=5"}, {"name": "run_on_failure", "types": [], "typedocs": {}, "defaultValue": "Save Appium Screenshot", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "run_on_failure=Save Appium Screenshot"}], "doc": "<p>MobileLibrary can be imported with optional arguments. <code>timeout</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</a>. <code>run_on_failure</code> specifies the name of a keyword (from any available libraries) to execute when a MobileLibrary keyword fails. By default <a href=\"#Save%20Appium%20Screenshot\" class=\"name\">Save Appium Screenshot</a> will be used to take a screenshot of the current page. Using the value <span class=\"name\">No Operation</span> will disable this feature altogether. See <a href=\"#Register%20Keyword%20To%20Run%20On%20Failure\" class=\"name\">Register Keyword To Run On Failure</a> keyword for more information about this functionality. Examples:</p>\n<table border=\"1\">\n<tr>\n<td>Library</td>\n<td>MobileLibrary</td>\n<td>10</td>\n<td># Sets default timeout to 10 seconds</td>\n<td></td>\n</tr>\n<tr>\n<td>Library</td>\n<td>MobileLibrary</td>\n<td>timeout=10</td>\n<td>run_on_failure=No Operation</td>\n<td># Sets default timeout to 10 seconds and does nothing on failure</td>\n</tr>\n</table>", "shortdoc": "MobileLibrary can be imported with optional arguments. ``timeout`` is the default timeout used to wait for all waiting actions. It can be later set with `Set Appium Timeout`. ``run_on_failure`` specifies the name of a keyword (from any available libraries) to execute when a MobileLibrary keyword fails. By default `Save Appium Screenshot` will be used to take a screenshot of the current page. Using the value `No Operation` will disable this feature altogether. See `Register Keyword To Run On Failure` keyword for more information about this functionality. Examples: | Library | MobileLibrary | 10 | # Sets default timeout to 10 seconds                                                                             | | Library | MobileLibrary | timeout=10 | run_on_failure=No Operation | # Sets default timeout to 10 seconds and does nothing on failure           |", "tags": [], "source": "C:\\Git\\robotframework-applicationlibrary\\src\\ApplicationLibrary\\MobileLibrary.py", "lineno": 71}], "keywords": [{"name": "Background App", "args": [{"name": "seconds", "types": [], "typedocs": {}, "defaultValue": "5", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "seconds=5"}], "doc": "<p>Puts the application in the background on the device for a certain duration.</p>", "shortdoc": "Puts the application in the background on the device for a certain duration.", "tags": [], "source": "C:\\Git\\robotframework-applicationlibrary\\venv\\lib\\site-packages\\AppiumLibrary\\keywords\\_applicationmanagement.py", "lineno": 245}, {"name": "Capture Page Screenshot", "args": [{"name": "filename", "types": [], "typedocs": {}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "filename=None"}], "doc": "<p>Takes a screenshot of the current page and embeds it into the log.</p>\n<p><span class=\"name\">filename</span> argument specifies the name of the file to write the screenshot into. If no <span class=\"name\">filename</span> is given, the screenshot is saved into file <span class=\"name\">appium-screenshot-&lt;counter&gt;.png</span> under the directory where the Robot Framework log file is written into. The <span class=\"name\">filename</span> is also considered relative to the same directory, if it is not given in absolute format.</p>\n<p><span class=\"name\">css</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.</p>\n<p>See <a href=\"#Save%20Appium%20Screenshot\" class=\"name\">Save Appium Screenshot</a> for a screenshot that will be unique across reports</p>", "shortdoc": "Takes a screenshot of the current page and embeds it into the log.", "tags": [], "source": "C:\\Git\\robotframework-applicationlibrary\\src\\ApplicationLibrary\\MobileLibrary.py", "lineno": 326}, {"name": "Clear Text", "args": [{"name": "locator", "types": [], "typedocs": {}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "locator"}], "doc": "<p>Clears the text field identified by <span class=\"name\">locator</span>.</p>\n<p>See <a href=\"#Introduction\" class=\"name\">introduction</a> for details about locating elements.</p>", "shortdoc": "Clears the text field identified by `locator`.", "tags": [], "source": "C:\\Git\\robotframework-applicationlibrary\\venv\\lib\\site-packages\\AppiumLibrary\\keywords\\_element.py", "lineno": 27}, {"name": "Click A Point", "args": [{"name": "x", "types": [], "typedocs": {}, "defaultValue": "0", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "x=0"}, {"name": "y", "types": [], "typedocs": {}, "defaultValue": "0", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "y=0"}, {"name": "duration", "types": [], "typedocs": {}, "defaultValue": "100", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "duration=100"}], "doc": "<p>Click on a point</p>", "shortdoc": "Click on a point", "tags": [], "source": "C:\\Git\\robotframework-applicationlibrary\\venv\\lib\\site-packages\\AppiumLibrary\\keywords\\_touch.py", "lineno": 145}, {"name": "Click Button", "args": [{"name": "index_or_name", "types": [], "typedocs": {}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "index_or_name"}], "doc": "<p>Click button</p>", "shortdoc": "Click button", "tags": [], "source": "C:\\Git\\robotframework-applicationlibrary\\venv\\lib\\site-packages\\AppiumLibrary\\keywords\\_element.py", "lineno": 44}, {"name": "Click Element", "args": [{"name": "locator", "types": [], "typedocs": {}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "locator"}], "doc": "<p>Click element identified by <span class=\"name\">locator</span>.</p>\n<p>Key attributes for arbitrary elements are <span class=\"name\">index</span> and <span class=\"name\">name</span>. See <a href=\"#Introduction\" class=\"name\">introduction</a> for details about locating elements.</p>", "shortdoc": "Click element identified by `locator`.", "tags": [], "source": "C:\\Git\\robotframework-applicationlibrary\\venv\\lib\\site-packages\\AppiumLibrary\\keywords\\_element.py", "lineno": 35}, {"name": "Click Element At Coordinates", "args": [{"name": "coordinate_X", "types": [], "typedocs": {}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "coordinate_X"}, {"name": "coordinate_Y", "types": [], "typedocs": {}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "coordinate_Y"}], "doc": "<p>click element at a certain coordinate</p>", "shortdoc": "click element at a certain coordinate", "tags": [], "source": "C:\\Git\\robotframework-applicationlibrary\\venv\\lib\\site-packages\\AppiumLibrary\\keywords\\_touch.py", "lineno": 155}, {"name": "Click Text", "args": [{"name": "text", "types": [], "typedocs": {}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "text"}, {"name": "exact_match", "types": [], "typedocs": {}, "defaultValue": "False", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "exact_match=False"}], "doc": "<p>Click text identified by <code>text</code>.</p>\n<p>By default tries to click first text involves given <code>text</code>, if you would like to click exactly matching text, then set <code>exact_match</code> to <span class=\"name\">True</span>.</p>\n<p>If there are multiple use  of <code>text</code> and you do not want first one, use <span class=\"name\">locator</span> with <a href=\"#Get%20Webelements\" class=\"name\">Get Web Elements</a> instead.</p>", "shortdoc": "Click text identified by ``text``.", "tags": [], "source": "C:\\Git\\robotframework-applicationlibrary\\venv\\lib\\site-packages\\AppiumLibrary\\keywords\\_element.py", "lineno": 52}, {"name": "Close All Applications", "args": [], "doc": "<p>Closes all open applications.</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.</p>\n<p>After this keyword, the application indices returned by <a href=\"#Open%20Application\" class=\"name\">Open Application</a> are reset and start from <span class=\"name\">1</span>.</p>", "shortdoc": "Closes all open applications.", "tags": [], "source": "C:\\Git\\robotframework-applicationlibrary\\venv\\lib\\site-packages\\AppiumLibrary\\keywords\\_applicationmanagement.py", "lineno": 25}, {"name": "Close Application", "args": [], "doc": "<p>Closes the current application and also close webdriver session.</p>", "shortdoc": "Closes the current application and also close webdriver session.", "tags": [], "source": "C:\\Git\\robotframework-applicationlibrary\\venv\\lib\\site-packages\\AppiumLibrary\\keywords\\_applicationmanagement.py", "lineno": 20}, {"name": "Drag And Drop", "args": [{"name": "source", "types": [], "typedocs": {}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "source"}, {"name": "target", "types": [], "typedocs": {}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "target"}, {"name": "delay", "types": [], "typedocs": {}, "defaultValue": "1500", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "delay=1500"}], "doc": "<p>Drags the element found with the locator <code>source</code> to the element found with the locator <code>target</code>.</p>\n<p><code>Delay</code> (iOS Only): Delay between initial button press and dragging, defaults to 1500ms.</p>", "shortdoc": "Drags the element found with the locator ``source`` to the element found with the locator ``target``.", "tags": [], "source": "C:\\Git\\robotframework-applicationlibrary\\src\\ApplicationLibrary\\MobileLibrary.py", "lineno": 245}, {"name": "Drag And Drop By Offset", "args": [{"name": "locator", "types": [], "typedocs": {}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "locator"}, {"name": "x_offset", "types": [], "typedocs": {}, "defaultValue": "0", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "x_offset=0"}, {"name": "y_offset", "types": [], "typedocs": {}, "defaultValue": "0", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "y_offset=0"}, {"name": "delay", "types": [], "typedocs": {}, "defaultValue": "1500", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "delay=1500"}], "doc": "<p>Drags the element found with <code>locator</code> to the given <code>x_offset</code> and <code>y_offset</code> coordinates.</p>\n<p><code>Delay</code> (iOS Only): Delay between initial button press and dragging, defaults to 1500ms.</p>", "shortdoc": "Drags the element found with ``locator`` to the given ``x_offset`` and ``y_offset`` coordinates.", "tags": [], "source": "C:\\Git\\robotframework-applicationlibrary\\src\\ApplicationLibrary\\MobileLibrary.py", "lineno": 253}, {"name": "Element Attribute Should Match", "args": [{"name": "locator", "types": [], "typedocs": {}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "locator"}, {"name": "attr_name", "types": [], "typedocs": {}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "attr_name"}, {"name": "match_pattern", "types": [], "typedocs": {}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "match_pattern"}, {"name": "regexp", "types": [], "typedocs": {}, "defaultValue": "False", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "regexp=False"}], "doc": "<p>Verify that an attribute of an element matches the expected criteria.</p>\n<p>The element is identified by <i>locator</i>. See <a href=\"#Introduction\" class=\"name\">introduction</a> for details about locating elements. If more than one element matches, the first element is selected.</p>\n<p>The <i>attr_name</i> is the name of the attribute within the selected element.</p>\n<p>The <i>match_pattern</i> is used for the matching, if the match_pattern is</p>\n<ul>\n<li>boolean or 'True'/'true'/'False'/'false' String then a boolean match is applied</li>\n<li>any other string is cause a string match</li>\n</ul>\n<p>The <i>regexp</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</a> or string pattern match (i.e. BuiltIn Library's <a href=\"http://robotframework.org/robotframework/latest/libraries/BuiltIn.html#Should%20Match\">Should Match</a>)</p>\n<p>Examples:</p>\n<table border=\"1\">\n<tr>\n<td>Element Attribute Should Match</td>\n<td>xpath = //*[contains(@text,'foo')]</td>\n<td>text</td>\n<td>*foobar</td>\n<td></td>\n</tr>\n<tr>\n<td>Element Attribute Should Match</td>\n<td>xpath = //*[contains(@text,'foo')]</td>\n<td>text</td>\n<td>f.*ar</td>\n<td>regexp = True</td>\n</tr>\n<tr>\n<td>Element Attribute Should Match</td>\n<td>xpath = //*[contains(@text,'foo')]</td>\n<td>enabled</td>\n<td>True</td>\n<td></td>\n</tr>\n</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</pre>\n<p><i><b>NOTE: </b></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</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</i></p>\n<p><i><b>NOTE: </b></i> Some attributes can be evaluated in two different ways e.g. these evaluate the same thing:</p>\n<table border=\"1\">\n<tr>\n<td>Element Attribute Should Match</td>\n<td>xpath = //*[contains(@text,'example text')]</td>\n<td>name</td>\n<td>txt_field_name</td>\n</tr>\n<tr>\n<td>Element Name Should Be</td>\n<td>xpath = //*[contains(@text,'example text')]</td>\n<td>txt_field_name</td>\n<td></td>\n</tr>\n</table>", "shortdoc": "Verify that an attribute of an element matches the expected criteria.", "tags": [], "source": "C:\\Git\\robotframework-applicationlibrary\\venv\\lib\\site-packages\\AppiumLibrary\\keywords\\_element.py", "lineno": 205}, {"name": "Element Name Should Be", "args": [{"name": "locator", "types": [], "typedocs": {}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "locator"}, {"name": "expected", "types": [], "typedocs": {}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "expected"}], "doc": "", "shortdoc": "", "tags": [], "source": "C:\\Git\\robotframework-applicationlibrary\\venv\\lib\\site-packages\\AppiumLibrary\\keywords\\_element.py", "lineno": 191}, {"name": "Element Should Be Disabled", "args": [{"name": "locator", "types": [], "typedocs": {}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "locator"}, {"name": "loglevel", "types": [], "typedocs": {}, "defaultValue": "INFO", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "loglevel=INFO"}], "doc": "<p>Verifies that element identified with locator is disabled.</p>\n<p>Key attributes for arbitrary elements are <span class=\"name\">id</span> and <span class=\"name\">name</span>. See <a href=\"#Introduction\" class=\"name\">introduction</a> for details about locating elements.</p>", "shortdoc": "Verifies that element identified with locator is disabled.", "tags": [], "source": "C:\\Git\\robotframework-applicationlibrary\\venv\\lib\\site-packages\\AppiumLibrary\\keywords\\_element.py", "lineno": 154}, {"name": "Element Should Be Enabled", "args": [{"name": "locator", "types": [], "typedocs": {}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "locator"}, {"name": "loglevel", "types": [], "typedocs": {}, "defaultValue": "INFO", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "loglevel=INFO"}], "doc": "<p>Verifies that element identified with locator is enabled.</p>\n<p>Key attributes for arbitrary elements are <span class=\"name\">id</span> and <span class=\"name\">name</span>. See <a href=\"#Introduction\" class=\"name\">introduction</a> for details about locating elements.</p>", "shortdoc": "Verifies that element identified with locator is enabled.", "tags": [], "source": "C:\\Git\\robotframework-applicationlibrary\\venv\\lib\\site-packages\\AppiumLibrary\\keywords\\_element.py", "lineno": 166}, {"name": "Element Should Be Visible", "args": [{"name": "locator", "types": [], "typedocs": {}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "locator"}, {"name": "loglevel", "types": [], "typedocs": {}, "defaultValue": "INFO", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "loglevel=INFO"}], "doc": "<p>Verifies that element identified with locator is visible.</p>\n<p>Key attributes for arbitrary elements are <span class=\"name\">id</span> and <span class=\"name\">name</span>. See <a href=\"#Introduction\" class=\"name\">introduction</a> for details about locating elements.</p>\n<p>New in AppiumLibrary 1.4.5</p>", "shortdoc": "Verifies that element identified with locator is visible.", "tags": [], "source": "C:\\Git\\robotframework-applicationlibrary\\venv\\lib\\site-packages\\AppiumLibrary\\keywords\\_element.py", "lineno": 178}, {"name": "Element Should Contain Text", "args": [{"name": "locator", "types": [], "typedocs": {}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "locator"}, {"name": "expected", "types": [], "typedocs": {}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "expected"}, {"name": "message", "types": [], "typedocs": {}, "defaultValue": "", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "message="}], "doc": "<p>Verifies element identified by <code>locator</code> contains text <code>expected</code>.</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</a>.</p>\n<p>Key attributes for arbitrary elements are <code>id</code> and <code>xpath</code>. <code>message</code> can be used to override the default error message.</p>\n<p>New in AppiumLibrary 1.4.</p>", "shortdoc": "Verifies element identified by ``locator`` contains text ``expected``.", "tags": [], "source": "C:\\Git\\robotframework-applicationlibrary\\venv\\lib\\site-packages\\AppiumLibrary\\keywords\\_element.py", "lineno": 285}, {"name": "Element Should Not Contain Text", "args": [{"name": "locator", "types": [], "typedocs": {}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "locator"}, {"name": "expected", "types": [], "typedocs": {}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "expected"}, {"name": "message", "types": [], "typedocs": {}, "defaultValue": "", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "message="}], "doc": "<p>Verifies element identified by <code>locator</code> does not contain text <code>expected</code>.</p>\n<p><code>message</code> can be used to override the default error message. See <a href=\"#Element%20Should%20Contain%20Text\" class=\"name\">Element Should Contain Text</a> for more details.</p>", "shortdoc": "Verifies element identified by ``locator`` does not contain text ``expected``.", "tags": [], "source": "C:\\Git\\robotframework-applicationlibrary\\venv\\lib\\site-packages\\AppiumLibrary\\keywords\\_element.py", "lineno": 304}, {"name": "Element Text Should Be", "args": [{"name": "locator", "types": [], "typedocs": {}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "locator"}, {"name": "expected", "types": [], "typedocs": {}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "expected"}, {"name": "message", "types": [], "typedocs": {}, "defaultValue": "", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "message="}], "doc": "<p>Verifies element identified by <code>locator</code> exactly contains text <code>expected</code>.</p>\n<p>In contrast to <a href=\"#Element%20Should%20Contain%20Text\" class=\"name\">Element Should Contain Text</a>, this keyword does not try a substring match but an exact match on the element identified by <code>locator</code>.</p>\n<p><code>message</code> can be used to override the default error message.</p>\n<p>New in AppiumLibrary 1.4.</p>", "shortdoc": "Verifies element identified by ``locator`` exactly contains text ``expected``.", "tags": [], "source": "C:\\Git\\robotframework-applicationlibrary\\venv\\lib\\site-packages\\AppiumLibrary\\keywords\\_element.py", "lineno": 319}, {"name": "Element Value Should Be", "args": [{"name": "locator", "types": [], "typedocs": {}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "locator"}, {"name": "expected", "types": [], "typedocs": {}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "expected"}], "doc": "", "shortdoc": "", "tags": [], "source": "C:\\Git\\robotframework-applicationlibrary\\venv\\lib\\site-packages\\AppiumLibrary\\keywords\\_element.py", "lineno": 198}, {"name": "Execute Adb Shell", "args": [{"name": "command", "types": [], "typedocs": {}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "command"}, {"name": "args", "types": [], "typedocs": {}, "defaultValue": null, "kind": "VAR_POSITIONAL", "required": false, "repr": "*args"}], "doc": "<p>Execute ADB shell commands</p>\n<p>Android only.</p>\n<ul>\n<li><i>command</i> - The ABD shell command</li>\n<li><i>args</i> - Arguments to send to command</li>\n</ul>\n<p>Returns the exit code of ADB shell.</p>\n<p>Requires server flag --relaxed-security to be set on Appium server.</p>", "shortdoc": "Execute ADB shell commands", "tags": [], "source": "C:\\Git\\robotframework-applicationlibrary\\venv\\lib\\site-packages\\AppiumLibrary\\keywords\\_applicationmanagement.py", "lineno": 217}, {"name": "Execute Async Script", "args": [{"name": "script", "types": [], "typedocs": {}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "script"}], "doc": "<p>Inject a snippet of Async-JavaScript into the page for execution in the context of the currently selected frame (Web context only).</p>\n<p>The executed script is assumed to be asynchronous and must signal that is done by invoking the provided callback, which is always provided as the final argument to the function.</p>\n<p>The value to this callback will be returned to the client.</p>\n<p>New in AppiumLibrary 1.5</p>", "shortdoc": "Inject a snippet of Async-JavaScript into the page for execution in the context of the currently selected frame (Web context only).", "tags": [], "source": "C:\\Git\\robotframework-applicationlibrary\\venv\\lib\\site-packages\\AppiumLibrary\\keywords\\_applicationmanagement.py", "lineno": 201}, {"name": "Execute Script", "args": [{"name": "script", "types": [], "typedocs": {}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "script"}], "doc": "<p>Inject a snippet of JavaScript into the page for execution in the context of the currently selected frame (Web context only).</p>\n<p>The executed script is assumed to be synchronous and the result of evaluating the script is returned to the client.</p>\n<p>New in AppiumLibrary 1.5</p>", "shortdoc": "Inject a snippet of JavaScript into the page for execution in the context of the currently selected frame (Web context only).", "tags": [], "source": "C:\\Git\\robotframework-applicationlibrary\\venv\\lib\\site-packages\\AppiumLibrary\\keywords\\_applicationmanagement.py", "lineno": 189}, {"name": "Get Activity", "args": [], "doc": "<p>Retrieves the current activity on the device.</p>\n<p>Android only.</p>", "shortdoc": "Retrieves the current activity on the device.", "tags": [], "source": "C:\\Git\\robotframework-applicationlibrary\\venv\\lib\\site-packages\\AppiumLibrary\\keywords\\_android_utils.py", "lineno": 88}, {"name": "Get Appium SessionId", "args": [], "doc": "<p>Returns the current session ID as a reference</p>", "shortdoc": "Returns the current session ID as a reference", "tags": [], "source": "C:\\Git\\robotframework-applicationlibrary\\venv\\lib\\site-packages\\AppiumLibrary\\keywords\\_applicationmanagement.py", "lineno": 163}, {"name": "Get Appium Timeout", "args": [], "doc": "<p>Gets the timeout in seconds that is used by various keywords.</p>\n<p>See <a href=\"#Set%20Appium%20Timeout\" class=\"name\">Set Appium Timeout</a> for an explanation.</p>", "shortdoc": "Gets the timeout in seconds that is used by various keywords.", "tags": [], "source": "C:\\Git\\robotframework-applicationlibrary\\venv\\lib\\site-packages\\AppiumLibrary\\keywords\\_applicationmanagement.py", "lineno": 137}, {"name": "Get Capability", "args": [{"name": "capability_name", "types": [], "typedocs": {}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "capability_name"}], "doc": "<p>Return the desired capability value by desired capability name</p>", "shortdoc": "Return the desired capability value by desired capability name", "tags": [], "source": "C:\\Git\\robotframework-applicationlibrary\\venv\\lib\\site-packages\\AppiumLibrary\\keywords\\_applicationmanagement.py", "lineno": 353}, {"name": "Get Contexts", "args": [], "doc": "<p>Get available contexts.</p>", "shortdoc": "Get available contexts.", "tags": [], "source": "C:\\Git\\robotframework-applicationlibrary\\venv\\lib\\site-packages\\AppiumLibrary\\keywords\\_applicationmanagement.py", "lineno": 292}, {"name": "Get Current Context", "args": [], "doc": "<p>Get current context.</p>", "shortdoc": "Get current context.", "tags": [], "source": "C:\\Git\\robotframework-applicationlibrary\\venv\\lib\\site-packages\\AppiumLibrary\\keywords\\_applicationmanagement.py", "lineno": 288}, {"name": "Get Element Attribute", "args": [{"name": "locator", "types": [], "typedocs": {}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "locator"}, {"name": "attribute", "types": [], "typedocs": {}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "attribute"}], "doc": "<p>Get element attribute using given attribute: name, value,...</p>\n<p>Examples:</p>\n<table border=\"1\">\n<tr>\n<td>Get Element Attribute</td>\n<td>locator</td>\n<td>name</td>\n</tr>\n<tr>\n<td>Get Element Attribute</td>\n<td>locator</td>\n<td>value</td>\n</tr>\n</table>", "shortdoc": "Get element attribute using given attribute: name, value,...", "tags": [], "source": "C:\\Git\\robotframework-applicationlibrary\\venv\\lib\\site-packages\\AppiumLibrary\\keywords\\_element.py", "lineno": 365}, {"name": "Get Element Location", "args": [{"name": "locator", "types": [], "typedocs": {}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "locator"}], "doc": "<p>Get element location</p>\n<p>Key attributes for arbitrary elements are <span class=\"name\">id</span> and <span class=\"name\">name</span>. See <a href=\"#Introduction\" class=\"name\">introduction</a> for details about locating elements.</p>", "shortdoc": "Get element location", "tags": [], "source": "C:\\Git\\robotframework-applicationlibrary\\venv\\lib\\site-packages\\AppiumLibrary\\keywords\\_element.py", "lineno": 387}, {"name": "Get Element Size", "args": [{"name": "locator", "types": [], "typedocs": {}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "locator"}], "doc": "<p>Get element size</p>\n<p>Key attributes for arbitrary elements are <span class=\"name\">id</span> and <span class=\"name\">name</span>. See <a href=\"#Introduction\" class=\"name\">introduction</a> for details about locating elements.</p>", "shortdoc": "Get element size", "tags": [], "source": "C:\\Git\\robotframework-applicationlibrary\\venv\\lib\\site-packages\\AppiumLibrary\\keywords\\_element.py", "lineno": 398}, {"name": "Get Matching Xpath Count", "args": [{"name": "xpath", "types": [], "typedocs": {}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "xpath"}], "doc": "<p>Returns number of elements matching <code>xpath</code></p>\n<p>One should not use the <span class=\"name\">xpath=</span> prefix for 'xpath'. XPath is assumed.</p>\n<table border=\"1\">\n<tr>\n<td><b>Correct:</b></td>\n<td></td>\n<td></td>\n</tr>\n<tr>\n<td>${count}</td>\n<td>Get Matching Xpath Count</td>\n<td>//android.view.View[@text='Test']</td>\n</tr>\n<tr>\n<td>Incorrect:</td>\n<td></td>\n<td></td>\n</tr>\n<tr>\n<td>${count}</td>\n<td>Get Matching Xpath Count</td>\n<td>xpath=//android.view.View[@text='Test']</td>\n</tr>\n</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</a>.</p>\n<p>New in AppiumLibrary 1.4.</p>", "shortdoc": "Returns number of elements matching ``xpath``", "tags": [], "source": "C:\\Git\\robotframework-applicationlibrary\\venv\\lib\\site-packages\\AppiumLibrary\\keywords\\_element.py", "lineno": 422}, {"name": "Get Network Connection Status", "args": [], "doc": "<p>Returns an integer bitmask specifying the network connection type.</p>\n<p>Android only.</p>\n<p>See <a href=\"#Set%20Network%20Connection%20Status\" class=\"name\">set network connection status</a> for more details.</p>", "shortdoc": "Returns an integer bitmask specifying the network connection type.", "tags": [], "source": "C:\\Git\\robotframework-applicationlibrary\\venv\\lib\\site-packages\\AppiumLibrary\\keywords\\_android_utils.py", "lineno": 19}, {"name": "Get Source", "args": [], "doc": "<p>Returns the entire source of the current page.</p>", "shortdoc": "Returns the entire source of the current page.", "tags": [], "source": "C:\\Git\\robotframework-applicationlibrary\\venv\\lib\\site-packages\\AppiumLibrary\\keywords\\_applicationmanagement.py", "lineno": 168}, {"name": "Get Text", "args": [{"name": "locator", "types": [], "typedocs": {}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "locator"}], "doc": "<p>Get element text (for hybrid and mobile browser use <span class=\"name\">xpath</span> locator, others might cause problem)</p>\n<p>Example:</p>\n<table border=\"1\">\n<tr>\n<td>${text}</td>\n<td>Get Text</td>\n<td>//*[contains(@text,'foo')]</td>\n</tr>\n</table>\n<p>New in AppiumLibrary 1.4.</p>", "shortdoc": "Get element text (for hybrid and mobile browser use `xpath` locator, others might cause problem)", "tags": [], "source": "C:\\Git\\robotframework-applicationlibrary\\venv\\lib\\site-packages\\AppiumLibrary\\keywords\\_element.py", "lineno": 409}, {"name": "Get Webelement", "args": [{"name": "locator", "types": [], "typedocs": {}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "locator"}], "doc": "<p>Returns the first <a href=\"http://selenium-python.readthedocs.io/api.html#module-selenium.webdriver.remote.webelement\">WebElement</a> object matching <code>locator</code>.</p>\n<p>Example:</p>\n<table border=\"1\">\n<tr>\n<td>${element}</td>\n<td>Get Webelement</td>\n<td>id=my_element</td>\n</tr>\n<tr>\n<td>Click Element</td>\n<td>${element}</td>\n<td></td>\n</tr>\n</table>\n<p>New in AppiumLibrary 1.4.</p>", "shortdoc": "Returns the first [http://selenium-python.readthedocs.io/api.html#module-selenium.webdriver.remote.webelement|WebElement] object matching ``locator``.", "tags": [], "source": "C:\\Git\\robotframework-applicationlibrary\\venv\\lib\\site-packages\\AppiumLibrary\\keywords\\_element.py", "lineno": 339}, {"name": "Get Webelements", "args": [{"name": "locator", "types": [], "typedocs": {}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "locator"}], "doc": "<p>Returns list of <a href=\"http://selenium-python.readthedocs.io/api.html#module-selenium.webdriver.remote.webelement\">WebElement</a> objects matching <code>locator</code>.</p>\n<p>Example:</p>\n<table border=\"1\">\n<tr>\n<td>@{elements}</td>\n<td>Get Webelements</td>\n<td>id=my_element</td>\n</tr>\n<tr>\n<td>Click Element</td>\n<td>@{elements}[2]</td>\n<td></td>\n</tr>\n</table>\n<p>This keyword was changed in AppiumLibrary 1.4 in following ways:</p>\n<ul>\n<li>Name is changed from <span class=\"name\">Get Elements</span> to current one.</li>\n<li>Deprecated argument <code>fail_on_error</code>, use <span class=\"name\">Run Keyword and Ignore Error</span> if necessary.</li>\n</ul>\n<p>New in AppiumLibrary 1.4.</p>", "shortdoc": "Returns list of [http://selenium-python.readthedocs.io/api.html#module-selenium.webdriver.remote.webelement|WebElement] objects matching ``locator``.", "tags": [], "source": "C:\\Git\\robotframework-applicationlibrary\\venv\\lib\\site-packages\\AppiumLibrary\\keywords\\_element.py", "lineno": 350}, {"name": "Get Window Height", "args": [], "doc": "<p>Get current device height.</p>\n<p>Example:</p>\n<table border=\"1\">\n<tr>\n<td>${width}</td>\n<td>Get Window Width</td>\n<td></td>\n</tr>\n<tr>\n<td>${height}</td>\n<td>Get Window Height</td>\n<td></td>\n</tr>\n<tr>\n<td>Click A Point</td>\n<td>${width}</td>\n<td>${height}</td>\n</tr>\n</table>\n<p>New in AppiumLibrary 1.4.5</p>", "shortdoc": "Get current device height.", "tags": [], "source": "C:\\Git\\robotframework-applicationlibrary\\venv\\lib\\site-packages\\AppiumLibrary\\keywords\\_applicationmanagement.py", "lineno": 297}, {"name": "Get Window Width", "args": [], "doc": "<p>Get current device width.</p>\n<p>Example:</p>\n<table border=\"1\">\n<tr>\n<td>${width}</td>\n<td>Get Window Width</td>\n<td></td>\n</tr>\n<tr>\n<td>${height}</td>\n<td>Get Window Height</td>\n<td></td>\n</tr>\n<tr>\n<td>Click A Point</td>\n<td>${width}</td>\n<td>${height}</td>\n</tr>\n</table>\n<p>New in AppiumLibrary 1.4.5</p>", "shortdoc": "Get current device width.", "tags": [], "source": "C:\\Git\\robotframework-applicationlibrary\\venv\\lib\\site-packages\\AppiumLibrary\\keywords\\_applicationmanagement.py", "lineno": 309}, {"name": "Go Back", "args": [], "doc": "<p>Goes one step backward in the browser history.</p>", "shortdoc": "Goes one step backward in the browser history.", "tags": [], "source": "C:\\Git\\robotframework-applicationlibrary\\venv\\lib\\site-packages\\AppiumLibrary\\keywords\\_applicationmanagement.py", "lineno": 235}, {"name": "Go To Url", "args": [{"name": "url", "types": [], "typedocs": {}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "url"}], "doc": "<p>Opens URL in default web browser.</p>\n<p>Example:</p>\n<table border=\"1\">\n<tr>\n<td>Open Application</td>\n<td><a href=\"http://localhost:4755/wd/hub\">http://localhost:4755/wd/hub</a></td>\n<td>platformName=iOS</td>\n<td>platformVersion=7.0</td>\n<td>deviceName='iPhone Simulator'</td>\n<td>browserName=Safari</td>\n</tr>\n<tr>\n<td>Go To URL</td>\n<td><a href=\"http://m.webapp.com\">http://m.webapp.com</a></td>\n<td></td>\n<td></td>\n<td></td>\n<td></td>\n</tr>\n</table>", "shortdoc": "Opens URL in default web browser.", "tags": [], "source": "C:\\Git\\robotframework-applicationlibrary\\venv\\lib\\site-packages\\AppiumLibrary\\keywords\\_applicationmanagement.py", "lineno": 343}, {"name": "Hide Keyboard", "args": [{"name": "key_name", "types": [], "typedocs": {}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "key_name=None"}], "doc": "<p>Hides the software keyboard on the device. (optional) In iOS, use <span class=\"name\">key_name</span> to press a particular key, ex. <span class=\"name\">Done</span>. In Android, no parameters are used.</p>", "shortdoc": "Hides the software keyboard on the device. (optional) In iOS, use `key_name` to press a particular key, ex. `Done`. In Android, no parameters are used.", "tags": [], "source": "C:\\Git\\robotframework-applicationlibrary\\venv\\lib\\site-packages\\AppiumLibrary\\keywords\\_element.py", "lineno": 90}, {"name": "Input Password", "args": [{"name": "locator", "types": [], "typedocs": {}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "locator"}, {"name": "text", "types": [], "typedocs": {}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "text"}], "doc": "<p>Types the given password into text field identified by <span class=\"name\">locator</span>.</p>\n<p>Difference between this keyword and <a href=\"#Input%20Text\" class=\"name\">Input Text</a> is that this keyword does not log the given password. See <a href=\"#Introduction\" class=\"name\">introduction</a> for details about locating elements.</p>", "shortdoc": "Types the given password into text field identified by `locator`.", "tags": [], "source": "C:\\Git\\robotframework-applicationlibrary\\venv\\lib\\site-packages\\AppiumLibrary\\keywords\\_element.py", "lineno": 72}, {"name": "Input Text", "args": [{"name": "locator", "types": [], "typedocs": {}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "locator"}, {"name": "text", "types": [], "typedocs": {}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "text"}], "doc": "<p>Types the given <span class=\"name\">text</span> into text field identified by <span class=\"name\">locator</span>.</p>\n<p>See <a href=\"#Introduction\" class=\"name\">introduction</a> for details about locating elements.</p>", "shortdoc": "Types the given `text` into text field identified by `locator`.", "tags": [], "source": "C:\\Git\\robotframework-applicationlibrary\\venv\\lib\\site-packages\\AppiumLibrary\\keywords\\_element.py", "lineno": 64}, {"name": "Input Value", "args": [{"name": "locator", "types": [], "typedocs": {}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "locator"}, {"name": "text", "types": [], "typedocs": {}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "text"}], "doc": "<p>Sets the given value into text field identified by <span class=\"name\">locator</span>. This is an IOS only keyword, input value makes use of set_value</p>\n<p>See <a href=\"#Introduction\" class=\"name\">introduction</a> for details about locating elements.</p>", "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": [], "source": "C:\\Git\\robotframework-applicationlibrary\\venv\\lib\\site-packages\\AppiumLibrary\\keywords\\_element.py", "lineno": 82}, {"name": "Install App", "args": [{"name": "app_path", "types": [], "typedocs": {}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "app_path"}, {"name": "app_package", "types": [], "typedocs": {}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "app_package"}], "doc": "<p>Install App via Appium</p>\n<p>Android only.</p>\n<ul>\n<li>app_path - path to app</li>\n<li>app_package - package of install app to verify</li>\n</ul>", "shortdoc": "Install App via Appium", "tags": [], "source": "C:\\Git\\robotframework-applicationlibrary\\venv\\lib\\site-packages\\AppiumLibrary\\keywords\\_android_utils.py", "lineno": 156}, {"name": "Is Keyboard Shown", "args": [], "doc": "<p>Return true if Android keyboard is displayed or False if not displayed No parameters are used.</p>", "shortdoc": "Return true if Android keyboard is displayed or False if not displayed No parameters are used.", "tags": [], "source": "C:\\Git\\robotframework-applicationlibrary\\venv\\lib\\site-packages\\AppiumLibrary\\keywords\\_element.py", "lineno": 97}, {"name": "Landscape", "args": [], "doc": "<p>Set the device orientation to LANDSCAPE</p>", "shortdoc": "Set the device orientation to LANDSCAPE", "tags": [], "source": "C:\\Git\\robotframework-applicationlibrary\\venv\\lib\\site-packages\\AppiumLibrary\\keywords\\_applicationmanagement.py", "lineno": 282}, {"name": "Launch Application", "args": [], "doc": "<p>Launch application. Application can be launched while Appium session running. This keyword can be used to launch application during test case or between test cases.</p>\n<p>This keyword works while <a href=\"#Open%20Application\" class=\"name\">Open Application</a> has a test running. This is good practice to <a href=\"#Launch%20Application\" class=\"name\">Launch Application</a> and <a href=\"#Quit%20Application\" class=\"name\">Quit Application</a> between test cases. As Suite Setup is <a href=\"#Open%20Application\" class=\"name\">Open Application</a>, <span class=\"name\">Test Setup</span> can be used to <a href=\"#Launch%20Application\" class=\"name\">Launch Application</a></p>\n<p>Example (syntax is just a representation, refer to RF Guide for usage of Setup/Teardown):</p>\n<table border=\"1\">\n<tr>\n<td>[Setup Suite]</td>\n<td></td>\n<td></td>\n<td></td>\n<td></td>\n<td></td>\n</tr>\n<tr>\n<td></td>\n<td>Open Application</td>\n<td><a href=\"http://localhost:4723/wd/hub\">http://localhost:4723/wd/hub</a></td>\n<td>platformName=Android</td>\n<td>deviceName=192.168.56.101:5555</td>\n<td>app=${CURDIR}/demoapp/OrangeDemoApp.apk</td>\n</tr>\n<tr>\n<td>[Test Setup]</td>\n<td></td>\n<td></td>\n<td></td>\n<td></td>\n<td></td>\n</tr>\n<tr>\n<td></td>\n<td>Launch Application</td>\n<td></td>\n<td></td>\n<td></td>\n<td></td>\n</tr>\n<tr>\n<td></td>\n<td></td>\n<td>&lt;&lt;&lt;test execution&gt;&gt;&gt;</td>\n<td></td>\n<td></td>\n<td></td>\n</tr>\n<tr>\n<td></td>\n<td></td>\n<td>&lt;&lt;&lt;test execution&gt;&gt;&gt;</td>\n<td></td>\n<td></td>\n<td></td>\n</tr>\n<tr>\n<td>[Test Teardown]</td>\n<td></td>\n<td></td>\n<td></td>\n<td></td>\n<td></td>\n</tr>\n<tr>\n<td></td>\n<td>Quit Application</td>\n<td></td>\n<td></td>\n<td></td>\n<td></td>\n</tr>\n<tr>\n<td>[Suite Teardown]</td>\n<td></td>\n<td></td>\n<td></td>\n<td></td>\n<td></td>\n</tr>\n<tr>\n<td></td>\n<td>Close Application</td>\n<td></td>\n<td></td>\n<td></td>\n<td></td>\n</tr>\n</table>\n<p>See <a href=\"#Quit%20Application\" class=\"name\">Quit Application</a> for quiting application but keeping Appium sesion running.</p>\n<p>New in AppiumLibrary 1.4.6</p>", "shortdoc": "Launch application. Application can be launched while Appium session running. This keyword can be used to launch application during test case or between test cases.", "tags": [], "source": "C:\\Git\\robotframework-applicationlibrary\\venv\\lib\\site-packages\\AppiumLibrary\\keywords\\_applicationmanagement.py", "lineno": 84}, {"name": "Lock", "args": [{"name": "seconds", "types": [], "typedocs": {}, "defaultValue": "5", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "seconds=5"}], "doc": "<p>Lock the device for a certain period of time. iOS only.</p>", "shortdoc": "Lock the device for a certain period of time. iOS only.", "tags": [], "source": "C:\\Git\\robotframework-applicationlibrary\\venv\\lib\\site-packages\\AppiumLibrary\\keywords\\_applicationmanagement.py", "lineno": 239}, {"name": "Log Source", "args": [{"name": "loglevel", "types": [], "typedocs": {}, "defaultValue": "INFO", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "loglevel=INFO"}], "doc": "<p>Logs and returns the entire html source of the current page or frame.</p>\n<p>The <span class=\"name\">loglevel</span> argument defines the used log level. Valid log levels are <span class=\"name\">WARN</span>, <span class=\"name\">INFO</span> (default), <span class=\"name\">DEBUG</span>, <span class=\"name\">TRACE</span> and <span class=\"name\">NONE</span> (no logging).</p>", "shortdoc": "Logs and returns the entire html source of the current page or frame.", "tags": [], "source": "C:\\Git\\robotframework-applicationlibrary\\venv\\lib\\site-packages\\AppiumLibrary\\keywords\\_applicationmanagement.py", "lineno": 172}, {"name": "Long Press", "args": [{"name": "locator", "types": [], "typedocs": {}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "locator"}, {"name": "duration", "types": [], "typedocs": {}, "defaultValue": "1000", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "duration=1000"}], "doc": "<p>Long press the element with optional duration</p>", "shortdoc": "Long press the element with optional duration", "tags": [], "source": "C:\\Git\\robotframework-applicationlibrary\\venv\\lib\\site-packages\\AppiumLibrary\\keywords\\_touch.py", "lineno": 112}, {"name": "Long Press Keycode", "args": [{"name": "keycode", "types": [], "typedocs": {}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "keycode"}, {"name": "metastate", "types": [], "typedocs": {}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "metastate=None"}], "doc": "<p>Sends a long press of keycode to the device.</p>\n<p>Android only.</p>\n<p>See <a href=\"#Press%20Keycode\" class=\"name\">press keycode</a> for more details.</p>", "shortdoc": "Sends a long press of keycode to the device.", "tags": [], "source": "C:\\Git\\robotframework-applicationlibrary\\venv\\lib\\site-packages\\AppiumLibrary\\keywords\\_keyevent.py", "lineno": 35}, {"name": "Open Application", "args": [{"name": "remote_url", "types": [], "typedocs": {}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "remote_url"}, {"name": "alias", "types": [], "typedocs": {}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "alias=None"}, {"name": "kwargs", "types": [], "typedocs": {}, "defaultValue": null, "kind": "VAR_NAMED", "required": false, "repr": "**kwargs"}], "doc": "<p>Opens a new application to given Appium server. Capabilities of appium server, Android and iOS, Please check <a href=\"https://github.com/appium/appium/blob/master/docs/en/writing-running-appium/server-args.md\">https://github.com/appium/appium/blob/master/docs/en/writing-running-appium/server-args.md</a></p>\n<table border=\"1\">\n<tr>\n<td><b>Option</b></td>\n<td><b>Man.</b></td>\n<td><b>Description</b></td>\n</tr>\n<tr>\n<td>remote_url</td>\n<td>Yes</td>\n<td>Appium server url</td>\n</tr>\n<tr>\n<td>alias</td>\n<td>no</td>\n<td>alias</td>\n</tr>\n</table>\n<p>Examples:</p>\n<table border=\"1\">\n<tr>\n<td>Open Application</td>\n<td><a href=\"http://localhost:4723/wd/hub\">http://localhost:4723/wd/hub</a></td>\n<td>alias=Myapp1</td>\n<td>platformName=iOS</td>\n<td>platformVersion=7.0</td>\n<td>deviceName='iPhone Simulator'</td>\n<td>app=your.app</td>\n<td></td>\n</tr>\n<tr>\n<td>Open Application</td>\n<td><a href=\"http://localhost:4723/wd/hub\">http://localhost:4723/wd/hub</a></td>\n<td>platformName=Android</td>\n<td>platformVersion=4.2.2</td>\n<td>deviceName=192.168.56.101:5555</td>\n<td>app=${CURDIR}/demoapp/OrangeDemoApp.apk</td>\n<td>appPackage=com.netease.qa.orangedemo</td>\n<td>appActivity=MainActivity</td>\n</tr>\n</table>", "shortdoc": "Opens a new application to given Appium server. Capabilities of appium server, Android and iOS, Please check https://github.com/appium/appium/blob/master/docs/en/writing-running-appium/server-args.md | *Option*            | *Man.* | *Description*     | | remote_url          | Yes    | Appium server url | | alias               | no     | alias             |", "tags": [], "source": "C:\\Git\\robotframework-applicationlibrary\\venv\\lib\\site-packages\\AppiumLibrary\\keywords\\_applicationmanagement.py", "lineno": 39}, {"name": "Open Notifications", "args": [], "doc": "<p>Opens and expands an Android device's notification drawer.</p>\n<p>Android only.</p>", "shortdoc": "Opens and expands an Android device's notification drawer.", "tags": [], "source": "C:\\Git\\robotframework-applicationlibrary\\venv\\lib\\site-packages\\AppiumLibrary\\keywords\\_android_utils.py", "lineno": 11}, {"name": "Page Should Contain Element", "args": [{"name": "locator", "types": [], "typedocs": {}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "locator"}, {"name": "loglevel", "types": [], "typedocs": {}, "defaultValue": "INFO", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "loglevel=INFO"}], "doc": "<p>Verifies that current page contains <span class=\"name\">locator</span> element.</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</span> argument. Giving <span class=\"name\">NONE</span> as level disables logging.</p>", "shortdoc": "Verifies that current page contains `locator` element.", "tags": [], "source": "C:\\Git\\robotframework-applicationlibrary\\venv\\lib\\site-packages\\AppiumLibrary\\keywords\\_element.py", "lineno": 129}, {"name": "Page Should Contain Text", "args": [{"name": "text", "types": [], "typedocs": {}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "text"}, {"name": "loglevel", "types": [], "typedocs": {}, "defaultValue": "INFO", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "loglevel=INFO"}], "doc": "<p>Verifies that current page contains <span class=\"name\">text</span>.</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</span> argument. Giving <span class=\"name\">NONE</span> as level disables logging.</p>", "shortdoc": "Verifies that current page contains `text`.", "tags": [], "source": "C:\\Git\\robotframework-applicationlibrary\\venv\\lib\\site-packages\\AppiumLibrary\\keywords\\_element.py", "lineno": 104}, {"name": "Page Should Not Contain Element", "args": [{"name": "locator", "types": [], "typedocs": {}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "locator"}, {"name": "loglevel", "types": [], "typedocs": {}, "defaultValue": "INFO", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "loglevel=INFO"}], "doc": "<p>Verifies that current page not contains <span class=\"name\">locator</span> element.</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</span> argument. Giving <span class=\"name\">NONE</span> as level disables logging.</p>", "shortdoc": "Verifies that current page not contains `locator` element.", "tags": [], "source": "C:\\Git\\robotframework-applicationlibrary\\venv\\lib\\site-packages\\AppiumLibrary\\keywords\\_element.py", "lineno": 142}, {"name": "Page Should Not Contain Text", "args": [{"name": "text", "types": [], "typedocs": {}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "text"}, {"name": "loglevel", "types": [], "typedocs": {}, "defaultValue": "INFO", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "loglevel=INFO"}], "doc": "<p>Verifies that current page not contains <span class=\"name\">text</span>.</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</span> argument. Giving <span class=\"name\">NONE</span> as level disables logging.</p>", "shortdoc": "Verifies that current page not contains `text`.", "tags": [], "source": "C:\\Git\\robotframework-applicationlibrary\\venv\\lib\\site-packages\\AppiumLibrary\\keywords\\_element.py", "lineno": 117}, {"name": "Pinch", "args": [{"name": "locator", "types": [], "typedocs": {}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "locator"}, {"name": "percent", "types": [], "typedocs": {}, "defaultValue": "200%", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "percent=200%"}, {"name": "steps", "types": [], "typedocs": {}, "defaultValue": "1", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "steps=1"}], "doc": "<p>Pinch in on an element a certain amount.</p>", "shortdoc": "Pinch in on an element a certain amount.", "tags": [], "source": "C:\\Git\\robotframework-applicationlibrary\\venv\\lib\\site-packages\\AppiumLibrary\\keywords\\_touch.py", "lineno": 23}, {"name": "Portrait", "args": [], "doc": "<p>Set the device orientation to PORTRAIT</p>", "shortdoc": "Set the device orientation to PORTRAIT", "tags": [], "source": "C:\\Git\\robotframework-applicationlibrary\\venv\\lib\\site-packages\\AppiumLibrary\\keywords\\_applicationmanagement.py", "lineno": 276}, {"name": "Press Keycode", "args": [{"name": "keycode", "types": [], "typedocs": {}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "keycode"}, {"name": "metastate", "types": [], "typedocs": {}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "metastate=None"}], "doc": "<p>Sends a press of keycode to the device.</p>\n<p>Android only.</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</a></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.</p>\n<p>For example</p>\n<ul>\n<li>META_SHIFT_ON = 1</li>\n<li>META_ALT_ON = 2</li>\n</ul>\n<pre>\nmetastate=1 --&gt; Shift is pressed\nmetastate=2 --&gt; Alt is pressed\nmetastate=3 --&gt; Shift+Alt is pressed\n</pre>\n<ul>\n<li>_keycode- - the keycode to be sent to the device</li>\n<li>_metastate- - status of the meta keys</li>\n</ul>", "shortdoc": "Sends a press of keycode to the device.", "tags": [], "source": "C:\\Git\\robotframework-applicationlibrary\\venv\\lib\\site-packages\\AppiumLibrary\\keywords\\_keyevent.py", "lineno": 9}, {"name": "Pull File", "args": [{"name": "path", "types": [], "typedocs": {}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "path"}, {"name": "decode", "types": [], "typedocs": {}, "defaultValue": "False", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "decode=False"}], "doc": "<p>Retrieves the file at <span class=\"name\">path</span> and return it's content.</p>\n<p>Android only.</p>\n<ul>\n<li><i>path</i> - the path to the file on the device</li>\n<li><i>decode</i> - True/False decode the data (base64) before returning it (default=False)</li>\n</ul>", "shortdoc": "Retrieves the file at `path` and return it's content.", "tags": [], "source": "C:\\Git\\robotframework-applicationlibrary\\venv\\lib\\site-packages\\AppiumLibrary\\keywords\\_android_utils.py", "lineno": 45}, {"name": "Pull Folder", "args": [{"name": "path", "types": [], "typedocs": {}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "path"}, {"name": "decode", "types": [], "typedocs": {}, "defaultValue": "False", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "decode=False"}], "doc": "<p>Retrieves a folder at <span class=\"name\">path</span>. Returns the folder's contents zipped.</p>\n<p>Android only.</p>\n<ul>\n<li><i>path</i> - the path to the folder on the device</li>\n<li><i>decode</i> - True/False decode the data (base64) before returning it (default=False)</li>\n</ul>", "shortdoc": "Retrieves a folder at `path`. Returns the folder's contents zipped.", "tags": [], "source": "C:\\Git\\robotframework-applicationlibrary\\venv\\lib\\site-packages\\AppiumLibrary\\keywords\\_android_utils.py", "lineno": 59}, {"name": "Push File", "args": [{"name": "path", "types": [], "typedocs": {}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "path"}, {"name": "data", "types": [], "typedocs": {}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "data"}, {"name": "encode", "types": [], "typedocs": {}, "defaultValue": "False", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "encode=False"}], "doc": "<p>Puts the data in the file specified as <span class=\"name\">path</span>.</p>\n<p>Android only.</p>\n<ul>\n<li><i>path</i> - the path on the device</li>\n<li><i>data</i> - data to be written to the file</li>\n<li><i>encode</i> - True/False encode the data as base64 before writing it to the file (default=False)</li>\n</ul>", "shortdoc": "Puts the data in the file specified as `path`.", "tags": [], "source": "C:\\Git\\robotframework-applicationlibrary\\venv\\lib\\site-packages\\AppiumLibrary\\keywords\\_android_utils.py", "lineno": 73}, {"name": "Quit Application", "args": [], "doc": "<p>Quit application. Application can be quit while Appium session is kept alive. This keyword can be used to close application during test case or between test cases.</p>\n<p>See <a href=\"#Launch%20Application\" class=\"name\">Launch Application</a> for an explanation.</p>\n<p>New in AppiumLibrary 1.4.6</p>", "shortdoc": "Quit application. Application can be quit while Appium session is kept alive. This keyword can be used to close application during test case or between test cases.", "tags": [], "source": "C:\\Git\\robotframework-applicationlibrary\\venv\\lib\\site-packages\\AppiumLibrary\\keywords\\_applicationmanagement.py", "lineno": 110}, {"name": "Register Keyword To Run On Failure", "args": [{"name": "keyword", "types": [], "typedocs": {}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "keyword"}], "doc": "<p>Sets the keyword to execute when a AppiumLibrary keyword fails.</p>\n<p><span class=\"name\">keyword_name</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.</p>\n<p>The initial keyword to use is set in <a href=\"#Importing\" class=\"name\">importing</a>, and the keyword that is used by default is <a href=\"#Capture%20Page%20Screenshot\" class=\"name\">Capture Page Screenshot</a>. Taking a screenshot when something failed is a very useful feature, but notice that it can slow down the execution.</p>\n<p>This keyword returns the name of the previously registered failure keyword. It can be used to restore the original value later.</p>\n<p>Example:</p>\n<table border=\"1\">\n<tr>\n<td>Register Keyword To Run On Failure</td>\n<td>Log Source</td>\n<td># Run <a href=\"#Log%20Source\" class=\"name\">Log Source</a> on failure.</td>\n<td></td>\n</tr>\n<tr>\n<td>${previous kw}=</td>\n<td>Register Keyword To Run On Failure</td>\n<td>Nothing</td>\n<td># Disables run-on-failure functionality and stores the previous kw name in a variable.</td>\n</tr>\n<tr>\n<td>Register Keyword To Run On Failure</td>\n<td>${previous kw}</td>\n<td># Restore to the previous keyword.</td>\n<td></td>\n</tr>\n</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.</p>", "shortdoc": "Sets the keyword to execute when a AppiumLibrary keyword fails.", "tags": [], "source": "C:\\Git\\robotframework-applicationlibrary\\venv\\lib\\site-packages\\AppiumLibrary\\keywords\\_runonfailure.py", "lineno": 17}, {"name": "Remove Application", "args": [{"name": "application_id", "types": [], "typedocs": {}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "application_id"}], "doc": "<p>Removes the application that is identified with an application id</p>\n<p>Example:</p>\n<table border=\"1\">\n<tr>\n<td>Remove Application</td>\n<td>com.netease.qa.orangedemo</td>\n</tr>\n</table>", "shortdoc": "Removes the application that is identified with an application id", "tags": [], "source": "C:\\Git\\robotframework-applicationlibrary\\venv\\lib\\site-packages\\AppiumLibrary\\keywords\\_applicationmanagement.py", "lineno": 127}, {"name": "Reset Application", "args": [], "doc": "<p>Reset application. Open Application can be reset while Appium session is kept alive.</p>", "shortdoc": "Reset application. Open Application can be reset while Appium session is kept alive.", "tags": [], "source": "C:\\Git\\robotframework-applicationlibrary\\venv\\lib\\site-packages\\AppiumLibrary\\keywords\\_applicationmanagement.py", "lineno": 121}, {"name": "Save Appium Screenshot", "args": [], "doc": "<p>Takes a screenshot with a unique filename to be stored in Robot Framework compiled reports.</p>", "shortdoc": "Takes a screenshot with a unique filename to be stored in Robot Framework compiled reports.", "tags": [], "source": "C:\\Git\\robotframework-applicationlibrary\\src\\ApplicationLibrary\\MobileLibrary.py", "lineno": 345}, {"name": "Scroll", "args": [{"name": "start_locator", "types": [], "typedocs": {}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "start_locator"}, {"name": "end_locator", "types": [], "typedocs": {}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "end_locator"}], "doc": "<p>Scrolls from one element to another Key attributes for arbitrary elements are <span class=\"name\">id</span> and <span class=\"name\">name</span>. See <a href=\"#Introduction\" class=\"name\">introduction</a> for details about locating elements.</p>", "shortdoc": "Scrolls from one element to another Key attributes for arbitrary elements are `id` and `name`. See `introduction` for details about locating elements.", "tags": [], "source": "C:\\Git\\robotframework-applicationlibrary\\venv\\lib\\site-packages\\AppiumLibrary\\keywords\\_touch.py", "lineno": 89}, {"name": "Scroll Down", "args": [{"name": "locator", "types": [], "typedocs": {}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "locator"}], "doc": "<p>Scrolls down to an element identified by <code>locator</code>.</p>", "shortdoc": "Scrolls down to an element identified by ``locator``.", "tags": [], "source": "C:\\Git\\robotframework-applicationlibrary\\src\\ApplicationLibrary\\MobileLibrary.py", "lineno": 294}, {"name": "Scroll Down To Text", "args": [{"name": "text", "types": [], "typedocs": {}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "text"}, {"name": "exact_match", "types": [], "typedocs": {}, "defaultValue": "False", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "exact_match=False"}, {"name": "swipe_count", "types": [], "typedocs": {}, "defaultValue": "10", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "swipe_count=10"}], "doc": "<p>Scrolls down to <code>text</code>.</p>\n<p>In some instances the default scroll behavior does not work. In this case the keyword will use small swipes to find the element. The <code>swipe_count</code> limits the number of these swipes before the keyword gives up, defaults to 10.</p>", "shortdoc": "Scrolls down to ``text``.", "tags": [], "source": "C:\\Git\\robotframework-applicationlibrary\\src\\ApplicationLibrary\\MobileLibrary.py", "lineno": 261}, {"name": "Scroll Up", "args": [{"name": "locator", "types": [], "typedocs": {}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "locator"}], "doc": "<p>Scrolls up to an element identified by <code>locator</code>.</p>", "shortdoc": "Scrolls up to an element identified by ``locator``.", "tags": [], "source": "C:\\Git\\robotframework-applicationlibrary\\src\\ApplicationLibrary\\MobileLibrary.py", "lineno": 303}, {"name": "Scroll Up To Text", "args": [{"name": "text", "types": [], "typedocs": {}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "text"}, {"name": "exact_match", "types": [], "typedocs": {}, "defaultValue": "False", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "exact_match=False"}, {"name": "swipe_count", "types": [], "typedocs": {}, "defaultValue": "10", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "swipe_count=10"}], "doc": "<p>Scrolls down to <code>text</code>.</p>\n<p>In some instances the default scroll behavior does not work. In this case the keyword will use small swipes to find the element. The <code>swipe_count</code> limits the number of these swipes before the keyword gives up, defaults to 10.</p>", "shortdoc": "Scrolls down to ``text``.", "tags": [], "source": "C:\\Git\\robotframework-applicationlibrary\\src\\ApplicationLibrary\\MobileLibrary.py", "lineno": 278}, {"name": "Set Appium Timeout", "args": [{"name": "seconds", "types": [], "typedocs": {}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "seconds"}], "doc": "<p>Sets the timeout in seconds used by various keywords.</p>\n<p>There are several <span class=\"name\">Wait ...</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.</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</a>.</p>\n<p>Example:</p>\n<table border=\"1\">\n<tr>\n<td>${orig timeout} =</td>\n<td>Set Appium Timeout</td>\n<td>15 seconds</td>\n</tr>\n<tr>\n<td>Open page that loads slowly</td>\n<td></td>\n<td></td>\n</tr>\n<tr>\n<td>Set Appium Timeout</td>\n<td>${orig timeout}</td>\n<td></td>\n</tr>\n</table>", "shortdoc": "Sets the timeout in seconds used by various keywords.", "tags": [], "source": "C:\\Git\\robotframework-applicationlibrary\\venv\\lib\\site-packages\\AppiumLibrary\\keywords\\_applicationmanagement.py", "lineno": 143}, {"name": "Set Location", "args": [{"name": "latitude", "types": [], "typedocs": {}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "latitude"}, {"name": "longitude", "types": [], "typedocs": {}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "longitude"}, {"name": "altitude", "types": [], "typedocs": {}, "defaultValue": "10", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "altitude=10"}], "doc": "<p>Set location</p>\n<ul>\n<li><i>latitute</i></li>\n<li><i>longitude</i></li>\n<li><i>altitude</i> = 10 [optional]</li>\n</ul>\n<p>Android only. New in AppiumLibrary 1.5</p>", "shortdoc": "Set location", "tags": [], "source": "C:\\Git\\robotframework-applicationlibrary\\venv\\lib\\site-packages\\AppiumLibrary\\keywords\\_android_utils.py", "lineno": 168}, {"name": "Set Network Connection Status", "args": [{"name": "connectionStatus", "types": [], "typedocs": {}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "connectionStatus"}], "doc": "<p>Sets the network connection Status.</p>\n<p>Android only.</p>\n<p>Possible values:</p>\n<table border=\"1\">\n<tr>\n<th>Value</th>\n<th>Alias</th>\n<th>Data</th>\n<th>Wifi</th>\n<th>Airplane Mode</th>\n</tr>\n<tr>\n<td>0</td>\n<td>(None)</td>\n<td>0</td>\n<td>0</td>\n<td>0</td>\n</tr>\n<tr>\n<td>1</td>\n<td>(Airplane Mode)</td>\n<td>0</td>\n<td>0</td>\n<td>1</td>\n</tr>\n<tr>\n<td>2</td>\n<td>(Wifi only)</td>\n<td>0</td>\n<td>1</td>\n<td>0</td>\n</tr>\n<tr>\n<td>4</td>\n<td>(Data only)</td>\n<td>1</td>\n<td>0</td>\n<td>0</td>\n</tr>\n<tr>\n<td>6</td>\n<td>(All network on)</td>\n<td>1</td>\n<td>1</td>\n<td>0</td>\n</tr>\n</table>", "shortdoc": "Sets the network connection Status.", "tags": [], "source": "C:\\Git\\robotframework-applicationlibrary\\venv\\lib\\site-packages\\AppiumLibrary\\keywords\\_android_utils.py", "lineno": 29}, {"name": "Shake", "args": [], "doc": "<p>Shake the device</p>", "shortdoc": "Shake the device", "tags": [], "source": "C:\\Git\\robotframework-applicationlibrary\\venv\\lib\\site-packages\\AppiumLibrary\\keywords\\_applicationmanagement.py", "lineno": 270}, {"name": "Start Activity", "args": [{"name": "appPackage", "types": [], "typedocs": {}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "appPackage"}, {"name": "appActivity", "types": [], "typedocs": {}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "appActivity"}, {"name": "opts", "types": [], "typedocs": {}, "defaultValue": null, "kind": "VAR_NAMED", "required": false, "repr": "**opts"}], "doc": "<p>Opens an arbitrary activity during a test. If the activity belongs to another application, that application is started and the activity is opened.</p>\n<p>Android only.</p>\n<ul>\n<li><i>appPackage</i> - The package containing the activity to start.</li>\n<li><i>appActivity</i> - The activity to start.</li>\n<li><i>appWaitPackage</i> - Begin automation after this package starts (optional).</li>\n<li><i>appWaitActivity</i> - Begin automation after this activity starts (optional).</li>\n<li><i>intentAction</i> - Intent to start (opt_ional).</li>\n<li><i>intentCategory</i> - Intent category to start (optional).</li>\n<li><i>intentFlags</i> - Flags to send to the intent (optional).</li>\n<li><i>optionalIntentArguments</i> - Optional arguments to the intent (optional).</li>\n<li><i>dontStopAppOnReset</i> - Should the app be stopped on reset (optional)?</li>\n</ul>", "shortdoc": "Opens an arbitrary activity during a test. If the activity belongs to another application, that application is started and the activity is opened.", "tags": [], "source": "C:\\Git\\robotframework-applicationlibrary\\venv\\lib\\site-packages\\AppiumLibrary\\keywords\\_android_utils.py", "lineno": 97}, {"name": "Start Screen Recording", "args": [{"name": "timeLimit", "types": [], "typedocs": {}, "defaultValue": "180s", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "timeLimit=180s"}, {"name": "options", "types": [], "typedocs": {}, "defaultValue": null, "kind": "VAR_NAMED", "required": false, "repr": "**options"}], "doc": "<p>Starts an asynchronous Screen Recording for the current open application.</p>\n<p><code>timeLimit</code> sets the actual time limit of the recorded video.</p>\n<ul>\n<li>The default value for both iOS and Android is 180 seconds (3 minutes).</li>\n<li>The maximum value for Android is 3 minutes.</li>\n<li>The maximum value for iOS is 10 minutes.</li>\n</ul>\n<h4>Optional Args</h4>\n<ul>\n<li><code>bitRate</code> (Android Only) The video bit rate for the video, in megabits per second. 4 Mbp/s(4000000) is by default for Android API level below 27.                                    20 Mb/s(20000000) for API level 27 and above.</li>\n</ul>\n<ul>\n<li><code>videoSize</code> (Android Only) The format is widthxheight. The default value is the                device's native display resolution (if supported), 1280x720 if not. For best                        results, use a size supported by your device's Advanced Video Coding (AVC)                          encoder. For example, \"1280x720\"</li>\n</ul>\n<ul>\n<li><code>bugReport</code> (Android Only) Set it to true in order to display additional                       information on the video overlay, such as a timestamp, that is helpful in                           videos captured to illustrate bugs. This option is only supported since                             API level 27 (Android O).</li>\n</ul>\n<ul>\n<li><code>videoQuality</code> (iOS Only) The video encoding quality (low, medium, high,                       photo - defaults to medium).</li>\n</ul>\n<ul>\n<li><code>videoFps</code>         (iOS Only) The Frames Per Second rate of the recorded video.                    Change this value if the resulting video is too slow or too fast. Defaults to 10.                   This can decrease the resulting file size.</li>\n</ul>\n<ul>\n<li><code>videoScale</code> (iOS Only) The scaling value to apply. Read                                       <a href=\"https://trac.ffmpeg.org/wiki/Scaling\">https://trac.ffmpeg.org/wiki/Scaling</a> for possible values. Example value of 720p                     scaling is '1280:720'. This can decrease/increase the resulting file size.                          No scale is applied by default.</li>\n</ul>\n<p><a href=\"#Start%20Screen%20Recording\" class=\"name\">Start Screen Recording</a> is used hand in hand with <a href=\"#Stop%20Screen%20Recording\" class=\"name\">Stop Screen Recording</a>. See <a href=\"#Stop%20Screen%20Recording\" class=\"name\">Stop Screen Recording</a> for more details. Example:</p>\n<table border=\"1\">\n<tr>\n<td><a href=\"#Start%20Screen%20Recording\" class=\"name\">Start Screen Recording</a></td>\n<td></td>\n<td># starts a screen record session</td>\n</tr>\n<tr>\n<td>....     keyword actions</td>\n<td></td>\n<td></td>\n</tr>\n<tr>\n<td><a href=\"#Stop%20Screen%20Recording\" class=\"name\">Stop Screen Recording</a></td>\n<td>filename=output</td>\n<td># saves the recorded session</td>\n</tr>\n</table>", "shortdoc": "Starts an asynchronous Screen Recording for the current open application.", "tags": [], "source": "C:\\Git\\robotframework-applicationlibrary\\venv\\lib\\site-packages\\AppiumLibrary\\keywords\\_screenrecord.py", "lineno": 16}, {"name": "Stop Screen Recording", "args": [{"name": "filename", "types": [], "typedocs": {}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "filename=None"}, {"name": "options", "types": [], "typedocs": {}, "defaultValue": null, "kind": "VAR_NAMED", "required": false, "repr": "**options"}], "doc": "<p>Gathers the output from the previously started screen recording              to a media file, then embeds it to the log.html(Android Only).</p>\n<p>Requires an active or exhausted Screen Recording Session. See <a href=\"#Start%20Screen%20Recording\" class=\"name\">Start Screen Recording</a> for more details.</p>\n<h4>Optional Args</h4>\n<ul>\n<li><code>remotePath</code> The path to the remote location, where the resulting video should be              uploaded. The following protocols are supported <i>http/https</i>, ftp. Null or empty                  string value (the default setting) means the content of resulting file should                       be encoded as Base64 and passed as the endpoint response value. An                                  exception will be thrown if the generated media file is too big to fit                              into the available process memory.</li>\n</ul>\n<ul>\n<li><code>username</code> The name of the user for the remote authentication.</li>\n</ul>\n<ul>\n<li><code>password</code> The password for the remote authentication.</li>\n</ul>\n<ul>\n<li><code>method</code> The http multipart upload method name. The <i>PUT</i> one is used by default.</li>\n</ul>\n<p>Example:</p>\n<table border=\"1\">\n<tr>\n<td><a href=\"#Start%20Screen%20Recording\" class=\"name\">Start Screen Recording</a></td>\n<td></td>\n<td># starts a screen record session</td>\n</tr>\n<tr>\n<td>....     keyword actions</td>\n<td></td>\n<td></td>\n</tr>\n<tr>\n<td><a href=\"#Stop%20Screen%20Recording\" class=\"name\">Stop Screen Recording</a></td>\n<td>filename=output</td>\n<td># saves the recorded session</td>\n</tr>\n</table>", "shortdoc": "Gathers the output from the previously started screen recording              to a media file, then embeds it to the log.html(Android Only).", "tags": [], "source": "C:\\Git\\robotframework-applicationlibrary\\venv\\lib\\site-packages\\AppiumLibrary\\keywords\\_screenrecord.py", "lineno": 68}, {"name": "Swipe", "args": [{"name": "start_x", "types": [], "typedocs": {}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "start_x"}, {"name": "start_y", "types": [], "typedocs": {}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "start_y"}, {"name": "offset_x", "types": [], "typedocs": {}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "offset_x"}, {"name": "offset_y", "types": [], "typedocs": {}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "offset_y"}, {"name": "duration", "types": [], "typedocs": {}, "defaultValue": "1000", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "duration=1000"}], "doc": "<p>Swipe from one point to another point, for an optional duration.</p>\n<p>Args:</p>\n<ul>\n<li>start_x - x-coordinate at which to start</li>\n<li>start_y - y-coordinate at which to start</li>\n<li>offset_x - x-coordinate distance from start_x at which to stop</li>\n<li>offset_y - y-coordinate distance from start_y at which to stop</li>\n<li>duration - (optional) time to take the swipe, in ms.</li>\n</ul>\n<p>Usage:</p>\n<table border=\"1\">\n<tr>\n<td>Swipe</td>\n<td>500</td>\n<td>100</td>\n<td>100</td>\n<td>0</td>\n<td>1000</td>\n</tr>\n</table>\n<p><i><b>NOTE: </b></i> Android 'Swipe' is not working properly, use <code>offset_x</code> and <code>offset_y</code> as if these are destination points.</p>", "shortdoc": "Swipe from one point to another point, for an optional duration.", "tags": [], "source": "C:\\Git\\robotframework-applicationlibrary\\venv\\lib\\site-packages\\AppiumLibrary\\keywords\\_touch.py", "lineno": 31}, {"name": "Swipe By Percent", "args": [{"name": "start_x", "types": [], "typedocs": {}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "start_x"}, {"name": "start_y", "types": [], "typedocs": {}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "start_y"}, {"name": "end_x", "types": [], "typedocs": {}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "end_x"}, {"name": "end_y", "types": [], "typedocs": {}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "end_y"}, {"name": "duration", "types": [], "typedocs": {}, "defaultValue": "1000", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "duration=1000"}], "doc": "<p>Swipe from one percent of the screen to another percent, for an optional duration. Normal swipe fails to scale for different screen resolutions, this can be avoided using percent.</p>\n<p>Args:</p>\n<ul>\n<li>start_x - x-percent at which to start</li>\n<li>start_y - y-percent at which to start</li>\n<li>end_x - x-percent distance from start_x at which to stop</li>\n<li>end_y - y-percent distance from start_y at which to stop</li>\n<li>duration - (optional) time to take the swipe, in ms.</li>\n</ul>\n<p>Usage:</p>\n<table border=\"1\">\n<tr>\n<td>Swipe By Percent</td>\n<td>90</td>\n<td>50</td>\n<td>10</td>\n<td>50</td>\n<td># Swipes screen from right to left.</td>\n</tr>\n</table>\n<p><i><b>NOTE: </b></i> This also considers swipe acts different between iOS and Android.</p>\n<p>New in AppiumLibrary 1.4.5</p>", "shortdoc": "Swipe from one percent of the screen to another percent, for an optional duration. Normal swipe fails to scale for different screen resolutions, this can be avoided using percent.", "tags": [], "source": "C:\\Git\\robotframework-applicationlibrary\\venv\\lib\\site-packages\\AppiumLibrary\\keywords\\_touch.py", "lineno": 55}, {"name": "Switch Application", "args": [{"name": "index_or_alias", "types": [], "typedocs": {}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "index_or_alias"}], "doc": "<p>Switches the active application by index or alias.</p>\n<p><span class=\"name\">index_or_alias</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</a>.</p>\n<p>This keyword returns the index of the previous active application, which can be used to switch back to that application later.</p>\n<p>Example:</p>\n<table border=\"1\">\n<tr>\n<td>${appium1}=</td>\n<td>Open Application</td>\n<td><a href=\"http://localhost:4723/wd/hub\">http://localhost:4723/wd/hub</a></td>\n<td>alias=MyApp1</td>\n<td>platformName=iOS</td>\n<td>platformVersion=7.0</td>\n<td>deviceName='iPhone Simulator'</td>\n<td>app=your.app</td>\n</tr>\n<tr>\n<td>${appium2}=</td>\n<td>Open Application</td>\n<td><a href=\"http://localhost:4755/wd/hub\">http://localhost:4755/wd/hub</a></td>\n<td>alias=MyApp2</td>\n<td>platformName=iOS</td>\n<td>platformVersion=7.0</td>\n<td>deviceName='iPhone Simulator'</td>\n<td>app=your.app</td>\n</tr>\n<tr>\n<td>Click Element</td>\n<td>sendHello</td>\n<td># Executed on appium running at localhost:4755</td>\n<td></td>\n<td></td>\n<td></td>\n<td></td>\n<td></td>\n</tr>\n<tr>\n<td>Switch Application</td>\n<td>${appium1}</td>\n<td># Switch using index</td>\n<td></td>\n<td></td>\n<td></td>\n<td></td>\n<td></td>\n</tr>\n<tr>\n<td>Click Element</td>\n<td>ackHello</td>\n<td># Executed on appium running at localhost:4723</td>\n<td></td>\n<td></td>\n<td></td>\n<td></td>\n<td></td>\n</tr>\n<tr>\n<td>Switch Application</td>\n<td>MyApp2</td>\n<td># Switch using alias</td>\n<td></td>\n<td></td>\n<td></td>\n<td></td>\n<td></td>\n</tr>\n<tr>\n<td>Page Should Contain Text</td>\n<td>ackHello Received</td>\n<td># Executed on appium running at localhost:4755</td>\n<td></td>\n<td></td>\n<td></td>\n<td></td>\n<td></td>\n</tr>\n</table>", "shortdoc": "Switches the active application by index or alias.", "tags": [], "source": "C:\\Git\\robotframework-applicationlibrary\\venv\\lib\\site-packages\\AppiumLibrary\\keywords\\_applicationmanagement.py", "lineno": 58}, {"name": "Switch To Context", "args": [{"name": "context_name", "types": [], "typedocs": {}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "context_name"}], "doc": "<p>Switch to a new context</p>", "shortdoc": "Switch to a new context", "tags": [], "source": "C:\\Git\\robotframework-applicationlibrary\\venv\\lib\\site-packages\\AppiumLibrary\\keywords\\_applicationmanagement.py", "lineno": 321}, {"name": "Switch To Frame", "args": [{"name": "frame", "types": [], "typedocs": {}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "frame"}], "doc": "<p>Switches focus to the specified frame, by index, name, or webelement.</p>\n<p>Example:</p>\n<table border=\"1\">\n<tr>\n<td>Go To Url</td>\n<td><a href=\"http://www.xxx.com\">http://www.xxx.com</a></td>\n</tr>\n</table>\n<pre>\nSwitch To Frame  | iframe_name|\nClick Element | xpath=//*[@id=\"online-btn\"] |\n</pre>", "shortdoc": "Switches focus to the specified frame, by index, name, or webelement.", "tags": [], "source": "C:\\Git\\robotframework-applicationlibrary\\venv\\lib\\site-packages\\AppiumLibrary\\keywords\\_applicationmanagement.py", "lineno": 325}, {"name": "Switch To Parent Frame", "args": [], "doc": "<p>Switches focus to the parent context. If the current context is the top level browsing context, the context remains unchanged.</p>", "shortdoc": "Switches focus to the parent context. If the current context is the top level browsing context, the context remains unchanged.", "tags": [], "source": "C:\\Git\\robotframework-applicationlibrary\\venv\\lib\\site-packages\\AppiumLibrary\\keywords\\_applicationmanagement.py", "lineno": 336}, {"name": "Tap", "args": [{"name": "locator", "types": [], "typedocs": {}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "locator"}, {"name": "x_offset", "types": [], "typedocs": {}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "x_offset=None"}, {"name": "y_offset", "types": [], "typedocs": {}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "y_offset=None"}, {"name": "count", "types": [], "typedocs": {}, "defaultValue": "1", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "count=1"}], "doc": "<p>Tap element identified by <code>locator</code>.</p>\n<p>Args:</p>\n<ul>\n<li><code>locator</code> - (mandatory). Taps coordinates when set to ${None}.</li>\n<li><code>x_offset</code> - (optional) x coordinate to tap, relative to the top left corner of the element.</li>\n<li><code>y_offset</code> - (optional) y coordinate. If y is used, x must also be set, and vice versa</li>\n<li><code>count</code> - can be used for multiple times of tap on that element</li>\n</ul>", "shortdoc": "Tap element identified by ``locator``. ", "tags": [], "source": "C:\\Git\\robotframework-applicationlibrary\\venv\\lib\\site-packages\\AppiumLibrary\\keywords\\_touch.py", "lineno": 119}, {"name": "Tap With Number Of Taps", "args": [{"name": "locator", "types": [], "typedocs": {}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "locator"}, {"name": "number_of_taps", "types": [], "typedocs": {}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "number_of_taps"}, {"name": "number_of_touches", "types": [], "typedocs": {}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "number_of_touches"}], "doc": "<p>Sends one or more taps with one or more touch points.iOS only.</p>\n<p>Args:</p>\n<ul>\n<li><code>number_of_taps</code> - The number of taps.</li>\n<li><code>number_of_touches</code> - The number of touch points.</li>\n</ul>", "shortdoc": "Sends one or more taps with one or more touch points.iOS only.", "tags": [], "source": "C:\\Git\\robotframework-applicationlibrary\\venv\\lib\\site-packages\\AppiumLibrary\\keywords\\_touch.py", "lineno": 133}, {"name": "Text Should Be Visible", "args": [{"name": "text", "types": [], "typedocs": {}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "text"}, {"name": "exact_match", "types": [], "typedocs": {}, "defaultValue": "False", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "exact_match=False"}, {"name": "loglevel", "types": [], "typedocs": {}, "defaultValue": "INFO", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "loglevel=INFO"}], "doc": "<p>Verifies that element identified with text is visible.</p>\n<p>New in AppiumLibrary 1.4.5</p>", "shortdoc": "Verifies that element identified with text is visible.", "tags": [], "source": "C:\\Git\\robotframework-applicationlibrary\\venv\\lib\\site-packages\\AppiumLibrary\\keywords\\_element.py", "lineno": 440}, {"name": "Toggle Touch Id Enrollment", "args": [], "doc": "<p>Toggle Touch ID enrolled state on iOS Simulator</p>\n<p>New in AppiumLibrary 1.5</p>", "shortdoc": "Toggle Touch ID enrolled state on iOS Simulator", "tags": [], "source": "C:\\Git\\robotframework-applicationlibrary\\venv\\lib\\site-packages\\AppiumLibrary\\keywords\\_applicationmanagement.py", "lineno": 262}, {"name": "Touch Id", "args": [{"name": "match", "types": [], "typedocs": {}, "defaultValue": "True", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "match=True"}], "doc": "<p>Simulate Touch ID on iOS Simulator</p>\n<p><span class=\"name\">match</span> (boolean) whether the simulated fingerprint is valid (default true)</p>\n<p>New in AppiumLibrary 1.5</p>", "shortdoc": "Simulate Touch ID on iOS Simulator", "tags": [], "source": "C:\\Git\\robotframework-applicationlibrary\\venv\\lib\\site-packages\\AppiumLibrary\\keywords\\_applicationmanagement.py", "lineno": 252}, {"name": "Wait Activity", "args": [{"name": "activity", "types": [], "typedocs": {}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "activity"}, {"name": "timeout", "types": [], "typedocs": {}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "timeout"}, {"name": "interval", "types": [], "typedocs": {}, "defaultValue": "1", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "interval=1"}], "doc": "<p>Wait for an activity: block until target activity presents or time out.</p>\n<p>Android only.</p>\n<ul>\n<li><i>activity</i> - target activity</li>\n<li><i>timeout</i> - max wait time, in seconds</li>\n<li><i>interval</i> - sleep interval between retries, in seconds</li>\n</ul>", "shortdoc": "Wait for an activity: block until target activity presents or time out.", "tags": [], "source": "C:\\Git\\robotframework-applicationlibrary\\venv\\lib\\site-packages\\AppiumLibrary\\keywords\\_android_utils.py", "lineno": 138}, {"name": "Wait For And Clear Text", "args": [{"name": "locator", "types": [], "typedocs": {}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "locator"}, {"name": "timeout", "types": [], "typedocs": {}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "timeout=None"}, {"name": "error", "types": [], "typedocs": {}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "error=None"}], "doc": "<p>Wait for and then clear the text field identified by <code>locator</code>.</p>\n<p>Fails if <code>timeout</code> expires before the element appears.</p>\n<p><code>error</code> can be used to override the default error message.</p>\n<p>See <a href=\"#Introduction\" class=\"name\">introduction</a> for details about locating elements.</p>", "shortdoc": "Wait for and then clear the text field identified by ``locator``.", "tags": [], "source": "C:\\Git\\robotframework-applicationlibrary\\src\\ApplicationLibrary\\MobileLibrary.py", "lineno": 88}, {"name": "Wait For And Click Button", "args": [{"name": "locator", "types": [], "typedocs": {}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "locator"}, {"name": "timeout", "types": [], "typedocs": {}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "timeout=None"}, {"name": "error", "types": [], "typedocs": {}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "error=None"}], "doc": "<p>Wait for and click the button identified by <code>locator</code>.</p>\n<p>Fails if <code>timeout</code> expires before the element appears.</p>\n<p><code>error</code> can be used to override the default error message.</p>\n<p>See <a href=\"#Introduction\" class=\"name\">introduction</a> for details about locating elements.</p>", "shortdoc": "Wait for and click the button identified by ``locator``.", "tags": [], "source": "C:\\Git\\robotframework-applicationlibrary\\src\\ApplicationLibrary\\MobileLibrary.py", "lineno": 125}, {"name": "Wait For And Click Element", "args": [{"name": "locator", "types": [], "typedocs": {}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "locator"}, {"name": "timeout", "types": [], "typedocs": {}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "timeout=None"}, {"name": "error", "types": [], "typedocs": {}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "error=None"}], "doc": "<p>Wait for and click the element identified by <code>locator</code>.</p>\n<p>Fails if <code>timeout</code> expires before the element appears.</p>\n<p><code>error</code> can be used to override the default error message.</p>\n<p>See <a href=\"#Introduction\" class=\"name\">introduction</a> for details about locating elements.</p>", "shortdoc": "Wait for and click the element identified by ``locator``.", "tags": [], "source": "C:\\Git\\robotframework-applicationlibrary\\src\\ApplicationLibrary\\MobileLibrary.py", "lineno": 100}, {"name": "Wait For And Click Text", "args": [{"name": "text", "types": [], "typedocs": {}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "text"}, {"name": "exact_match", "types": [], "typedocs": {}, "defaultValue": "False", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "exact_match=False"}, {"name": "timeout", "types": [], "typedocs": {}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "timeout=None"}, {"name": "error", "types": [], "typedocs": {}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "error=None"}], "doc": "<p>Wait for and click text identified by <code>text</code>.</p>\n<p>Fails if <code>timeout</code> expires before the element appears.</p>\n<p><code>error</code> can be used to override the default error message.</p>\n<p>By default tries to click first text involves given <code>text</code>. If you would like to click exactly matching text, then set <code>exact_match</code> to <span class=\"name\">True</span>.</p>", "shortdoc": "Wait for and click text identified by ``text``.", "tags": [], "source": "C:\\Git\\robotframework-applicationlibrary\\src\\ApplicationLibrary\\MobileLibrary.py", "lineno": 112}, {"name": "Wait For And Input Password", "args": [{"name": "locator", "types": [], "typedocs": {}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "locator"}, {"name": "text", "types": [], "typedocs": {}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "text"}, {"name": "timeout", "types": [], "typedocs": {}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "timeout=None"}, {"name": "error", "types": [], "typedocs": {}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "error=None"}], "doc": "<p>Wait for and type the given password into the text field identified by <code>locator</code>.</p>\n<p>Fails if <code>timeout</code> expires before the element appears.</p>\n<p><code>error</code> can be used to override the default error message.</p>\n<p>The difference between this keyword and <a href=\"#Wait%20For%20And%20Input%20Text\" class=\"name\">Wait For And Input Text</a> is that this keyword does not log the given password. See <a href=\"#Introduction\" class=\"name\">introduction</a> for details about locating elements.</p>", "shortdoc": "Wait for and type the given password into the text field identified by ``locator``.", "tags": [], "source": "C:\\Git\\robotframework-applicationlibrary\\src\\ApplicationLibrary\\MobileLibrary.py", "lineno": 137}, {"name": "Wait For And Input Text", "args": [{"name": "locator", "types": [], "typedocs": {}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "locator"}, {"name": "text", "types": [], "typedocs": {}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "text"}, {"name": "timeout", "types": [], "typedocs": {}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "timeout=None"}, {"name": "error", "types": [], "typedocs": {}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "error=None"}], "doc": "<p>Wait for and type the given <code>locator</code> into text field identified by <code>locator</code>.</p>\n<p>Fails if <code>timeout</code> expires before the element appears.</p>\n<p><code>error</code> can be used to override the default error message.</p>\n<p>See <a href=\"#Introduction\" class=\"name\">introduction</a> for details about locating elements.</p>", "shortdoc": "Wait for and type the given ``locator`` into text field identified by ``locator``.", "tags": [], "source": "C:\\Git\\robotframework-applicationlibrary\\src\\ApplicationLibrary\\MobileLibrary.py", "lineno": 150}, {"name": "Wait For And Input Value", "args": [{"name": "locator", "types": [], "typedocs": {}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "locator"}, {"name": "value", "types": [], "typedocs": {}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "value"}, {"name": "timeout", "types": [], "typedocs": {}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "timeout=None"}, {"name": "error", "types": [], "typedocs": {}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "error=None"}], "doc": "<p>Wait for and set the given <code>value</code> into the text field identified by <code>locator</code>. This is an IOS only keyword, input value makes use of set_value.</p>\n<p>Fails if <code>timeout</code> expires before the element appears.</p>\n<p><code>error</code> can be used to override the default error message.</p>\n<p>The difference between this keyword and <a href=\"#Wait%20For%20And%20Input%20Text\" class=\"name\">Wait For And Input Text</a> is that this keyword does not log the given password. See <a href=\"#Introduction\" class=\"name\">introduction</a> for details about locating elements.</p>", "shortdoc": "Wait for and set the given ``value`` into the text field identified by ``locator``. This is an IOS only keyword, input value makes use of set_value.", "tags": [], "source": "C:\\Git\\robotframework-applicationlibrary\\src\\ApplicationLibrary\\MobileLibrary.py", "lineno": 162}, {"name": "Wait For And Long Press", "args": [{"name": "locator", "types": [], "typedocs": {}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "locator"}, {"name": "duration", "types": [], "typedocs": {}, "defaultValue": "5000", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "duration=5000"}, {"name": "timeout", "types": [], "typedocs": {}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "timeout=None"}, {"name": "error", "types": [], "typedocs": {}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "error=None"}], "doc": "<p>Wait for and long press the element identified by <code>locator</code> with optional duration.</p>\n<p>Fails if <code>timeout</code> expires before the element appears.</p>\n<p><code>error</code> can be used to override the default error message.</p>\n<p>See <a href=\"#Introduction\" class=\"name\">introduction</a> for details about locating elements.</p>", "shortdoc": "Wait for and long press the element identified by ``locator`` with optional duration.", "tags": [], "source": "C:\\Git\\robotframework-applicationlibrary\\src\\ApplicationLibrary\\MobileLibrary.py", "lineno": 176}, {"name": "Wait For And Tap", "args": [{"name": "locator", "types": [], "typedocs": {}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "locator"}, {"name": "x_offset", "types": [], "typedocs": {}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "x_offset=None"}, {"name": "y_offset", "types": [], "typedocs": {}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "y_offset=None"}, {"name": "count", "types": [], "typedocs": {}, "defaultValue": "1", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "count=1"}, {"name": "timeout", "types": [], "typedocs": {}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "timeout=None"}, {"name": "error", "types": [], "typedocs": {}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "error=None"}], "doc": "<p>Wait for and then Tap element identified by <code>locator</code>. Args:</p>\n<ul>\n<li><code>x_offset</code> - (optional) x coordinate to tap, relative to the top left corner of the element.</li>\n<li><code>y_offset</code> - (optional) y coordinate. If y is used, x must also be set, and vice versa</li>\n<li><code>count</code> - can be used to tap multiple times</li>\n<li><code>timeout</code> - time in seconds to locate the element, defaults to global timeout</li>\n<li><code>error</code> - (optional) used to override the default error message.</li>\n</ul>", "shortdoc": "Wait for and then Tap element identified by ``locator``. Args: - ``x_offset`` - (optional) x coordinate to tap, relative to the top left corner of the element. - ``y_offset`` - (optional) y coordinate. If y is used, x must also be set, and vice versa - ``count`` - can be used to tap multiple times - ``timeout`` - time in seconds to locate the element, defaults to global timeout - ``error`` - (optional) used to override the default error message.", "tags": [], "source": "C:\\Git\\robotframework-applicationlibrary\\src\\ApplicationLibrary\\MobileLibrary.py", "lineno": 313}, {"name": "Wait Until Element Contains", "args": [{"name": "locator", "types": [], "typedocs": {}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "locator"}, {"name": "text", "types": [], "typedocs": {}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "text"}, {"name": "timeout", "types": [], "typedocs": {}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "timeout=None"}, {"name": "error", "types": [], "typedocs": {}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "error=None"}], "doc": "<p>Waits until element specified with <code>locator</code> contains <code>text</code>.</p>\n<p>Fails if <code>timeout</code> expires before the element appears.</p>\n<p><code>error</code> can be used to override the default error message.</p>\n<p>See also <a href=\"#Wait%20Until%20Page%20Contains\" class=\"name\">Wait Until Page Contains</a>, <a href=\"#Wait%20Until%20Page%20Does%20Not%20Contain\" class=\"name\">Wait Until Page Does Not Contain</a> <a href=\"#Wait%20Until%20Page%20Does%20Not%20Contain%20Element\" class=\"name\">Wait Until Page Does Not Contain Element</a></p>", "shortdoc": "Waits until element specified with ``locator`` contains ``text``.", "tags": [], "source": "C:\\Git\\robotframework-applicationlibrary\\src\\ApplicationLibrary\\MobileLibrary.py", "lineno": 188}, {"name": "Wait Until Element Does Not Contain", "args": [{"name": "locator", "types": [], "typedocs": {}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "locator"}, {"name": "text", "types": [], "typedocs": {}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "text"}, {"name": "timeout", "types": [], "typedocs": {}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "timeout=None"}, {"name": "error", "types": [], "typedocs": {}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "error=None"}], "doc": "<p>Waits until element specified with <code>locator</code> does not contain <code>text</code>.</p>\n<p>Fails if <code>timeout</code> expires before the element appears.</p>\n<p><code>error</code> can be used to override the default error message.</p>\n<p>See also <a href=\"#Wait%20Until%20Element%20Contains\" class=\"name\">Wait Until Element Contains</a>, <a href=\"#Wait%20Until%20Page%20Contains\" class=\"name\">Wait Until Page Contains</a>, <a href=\"#Wait%20Until%20Page%20Does%20Not%20Contain\" class=\"name\">Wait Until Page Does Not Contain</a> <a href=\"#Wait%20Until%20Page%20Does%20Not%20Contain%20Element\" class=\"name\">Wait Until Page Does Not Contain Element</a></p>", "shortdoc": "Waits until element specified with ``locator`` does not contain ``text``.", "tags": [], "source": "C:\\Git\\robotframework-applicationlibrary\\src\\ApplicationLibrary\\MobileLibrary.py", "lineno": 203}, {"name": "Wait Until Element Is Disabled", "args": [{"name": "locator", "types": [], "typedocs": {}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "locator"}, {"name": "timeout", "types": [], "typedocs": {}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "timeout=None"}, {"name": "error", "types": [], "typedocs": {}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "error=None"}], "doc": "<p>Waits until element specified with <code>locator</code> is disabled.</p>\n<p>Fails if <code>timeout</code> expires before the element appears.</p>\n<p><code>error</code> can be used to override the default error message.</p>\n<p>See also <a href=\"#Wait%20Until%20Element%20Is%20Disabled\" class=\"name\">Wait Until Element Is Disabled</a></p>", "shortdoc": "Waits until element specified with ``locator`` is disabled.", "tags": [], "source": "C:\\Git\\robotframework-applicationlibrary\\src\\ApplicationLibrary\\MobileLibrary.py", "lineno": 232}, {"name": "Wait Until Element Is Enabled", "args": [{"name": "locator", "types": [], "typedocs": {}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "locator"}, {"name": "timeout", "types": [], "typedocs": {}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "timeout=None"}, {"name": "error", "types": [], "typedocs": {}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "error=None"}], "doc": "<p>Waits until element specified with <code>locator</code> is enabled.</p>\n<p>Fails if <code>timeout</code> expires before the element appears.</p>\n<p><code>error</code> can be used to override the default error message.</p>\n<p>See also <a href=\"#Wait%20Until%20Element%20Is%20Disabled\" class=\"name\">Wait Until Element Is Disabled</a></p>", "shortdoc": "Waits until element specified with ``locator`` is enabled.", "tags": [], "source": "C:\\Git\\robotframework-applicationlibrary\\src\\ApplicationLibrary\\MobileLibrary.py", "lineno": 219}, {"name": "Wait Until Element Is Visible", "args": [{"name": "locator", "types": [], "typedocs": {}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "locator"}, {"name": "timeout", "types": [], "typedocs": {}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "timeout=None"}, {"name": "error", "types": [], "typedocs": {}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "error=None"}], "doc": "<p>Waits until element specified with <span class=\"name\">locator</span> is visible.</p>\n<p>Fails if <span class=\"name\">timeout</span> expires before the element is visible. See <a href=\"#Introduction\" class=\"name\">introduction</a> for more information about <span class=\"name\">timeout</span> and its default value.</p>\n<p><span class=\"name\">error</span> can be used to override the default error message.</p>\n<p>See also <a href=\"#Wait%20Until%20Page%20Contains\" class=\"name\">Wait Until Page Contains</a>, <a href=\"#Wait%20Until%20Page%20Contains%20Element\" class=\"name\">Wait Until Page Contains Element</a>, <span class=\"name\">Wait For Condition</span> and BuiltIn keyword <span class=\"name\">Wait Until Keyword Succeeds</span>.</p>", "shortdoc": "Waits until element specified with `locator` is visible.", "tags": [], "source": "C:\\Git\\robotframework-applicationlibrary\\venv\\lib\\site-packages\\AppiumLibrary\\keywords\\_waiting.py", "lineno": 7}, {"name": "Wait Until Page Contains", "args": [{"name": "text", "types": [], "typedocs": {}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "text"}, {"name": "timeout", "types": [], "typedocs": {}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "timeout=None"}, {"name": "error", "types": [], "typedocs": {}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "error=None"}], "doc": "<p>Waits until <span class=\"name\">text</span> appears on current page.</p>\n<p>Fails if <span class=\"name\">timeout</span> expires before the text appears. See <a href=\"#Introduction\" class=\"name\">introduction</a> for more information about <span class=\"name\">timeout</span> and its default value.</p>\n<p><span class=\"name\">error</span> can be used to override the default error message.</p>\n<p>See also <a href=\"#Wait%20Until%20Page%20Does%20Not%20Contain\" class=\"name\">Wait Until Page Does Not Contain</a>, <a href=\"#Wait%20Until%20Page%20Contains%20Element\" class=\"name\">Wait Until Page Contains Element</a>, <a href=\"#Wait%20Until%20Page%20Does%20Not%20Contain%20Element\" class=\"name\">Wait Until Page Does Not Contain Element</a> and BuiltIn keyword <span class=\"name\">Wait Until Keyword Succeeds</span>.</p>", "shortdoc": "Waits until `text` appears on current page.", "tags": [], "source": "C:\\Git\\robotframework-applicationlibrary\\venv\\lib\\site-packages\\AppiumLibrary\\keywords\\_waiting.py", "lineno": 30}, {"name": "Wait Until Page Contains Element", "args": [{"name": "locator", "types": [], "typedocs": {}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "locator"}, {"name": "timeout", "types": [], "typedocs": {}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "timeout=None"}, {"name": "error", "types": [], "typedocs": {}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "error=None"}], "doc": "<p>Waits until element specified with <span class=\"name\">locator</span> appears on current page.</p>\n<p>Fails if <span class=\"name\">timeout</span> expires before the element appears. See <a href=\"#Introduction\" class=\"name\">introduction</a> for more information about <span class=\"name\">timeout</span> and its default value.</p>\n<p><span class=\"name\">error</span> can be used to override the default error message.</p>\n<p>See also <a href=\"#Wait%20Until%20Page%20Contains\" class=\"name\">Wait Until Page Contains</a>, <a href=\"#Wait%20Until%20Page%20Does%20Not%20Contain\" class=\"name\">Wait Until Page Does Not Contain</a> <a href=\"#Wait%20Until%20Page%20Does%20Not%20Contain%20Element\" class=\"name\">Wait Until Page Does Not Contain Element</a> and BuiltIn keyword <span class=\"name\">Wait Until Keyword Succeeds</span>.</p>", "shortdoc": "Waits until element specified with `locator` appears on current page.", "tags": [], "source": "C:\\Git\\robotframework-applicationlibrary\\venv\\lib\\site-packages\\AppiumLibrary\\keywords\\_waiting.py", "lineno": 72}, {"name": "Wait Until Page Does Not Contain", "args": [{"name": "text", "types": [], "typedocs": {}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "text"}, {"name": "timeout", "types": [], "typedocs": {}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "timeout=None"}, {"name": "error", "types": [], "typedocs": {}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "error=None"}], "doc": "<p>Waits until <span class=\"name\">text</span> disappears from current page.</p>\n<p>Fails if <span class=\"name\">timeout</span> expires before the <span class=\"name\">text</span> disappears. See <a href=\"#Introduction\" class=\"name\">introduction</a> for more information about <span class=\"name\">timeout</span> and its default value.</p>\n<p><span class=\"name\">error</span> can be used to override the default error message.</p>\n<p>See also <a href=\"#Wait%20Until%20Page%20Contains\" class=\"name\">Wait Until Page Contains</a>, <a href=\"#Wait%20Until%20Page%20Contains%20Element\" class=\"name\">Wait Until Page Contains Element</a>, <a href=\"#Wait%20Until%20Page%20Does%20Not%20Contain%20Element\" class=\"name\">Wait Until Page Does Not Contain Element</a> and BuiltIn keyword <span class=\"name\">Wait Until Keyword Succeeds</span>.</p>", "shortdoc": "Waits until `text` disappears from current page.", "tags": [], "source": "C:\\Git\\robotframework-applicationlibrary\\venv\\lib\\site-packages\\AppiumLibrary\\keywords\\_waiting.py", "lineno": 48}, {"name": "Wait Until Page Does Not Contain Element", "args": [{"name": "locator", "types": [], "typedocs": {}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "locator"}, {"name": "timeout", "types": [], "typedocs": {}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "timeout=None"}, {"name": "error", "types": [], "typedocs": {}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "error=None"}], "doc": "<p>Waits until element specified with <span class=\"name\">locator</span> disappears from current page.</p>\n<p>Fails if <span class=\"name\">timeout</span> expires before the element disappears. See <a href=\"#Introduction\" class=\"name\">introduction</a> for more information about <span class=\"name\">timeout</span> and its default value.</p>\n<p><span class=\"name\">error</span> can be used to override the default error message.</p>\n<p>See also <a href=\"#Wait%20Until%20Page%20Contains\" class=\"name\">Wait Until Page Contains</a>, <a href=\"#Wait%20Until%20Page%20Does%20Not%20Contain\" class=\"name\">Wait Until Page Does Not Contain</a>, <a href=\"#Wait%20Until%20Page%20Contains%20Element\" class=\"name\">Wait Until Page Contains Element</a> and BuiltIn keyword <span class=\"name\">Wait Until Keyword Succeeds</span>.</p>", "shortdoc": "Waits until element specified with `locator` disappears from current page.", "tags": [], "source": "C:\\Git\\robotframework-applicationlibrary\\venv\\lib\\site-packages\\AppiumLibrary\\keywords\\_waiting.py", "lineno": 90}, {"name": "Xpath Should Match X Times", "args": [{"name": "xpath", "types": [], "typedocs": {}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "xpath"}, {"name": "count", "types": [], "typedocs": {}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "count"}, {"name": "error", "types": [], "typedocs": {}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "error=None"}, {"name": "loglevel", "types": [], "typedocs": {}, "defaultValue": "INFO", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "loglevel=INFO"}], "doc": "<p>Verifies that the page contains the given number of elements located by the given <code>xpath</code>.</p>\n<p>One should not use the <span class=\"name\">xpath=</span> prefix for 'xpath'. XPath is assumed.</p>\n<table border=\"1\">\n<tr>\n<td><b>Correct:</b></td>\n<td></td>\n<td></td>\n</tr>\n<tr>\n<td>Xpath Should Match X Times</td>\n<td>//android.view.View[@text='Test']</td>\n<td>1</td>\n</tr>\n<tr>\n<td>Incorrect:</td>\n<td></td>\n<td></td>\n</tr>\n<tr>\n<td>Xpath Should Match X Times</td>\n<td>xpath=//android.view.View[@text='Test']</td>\n<td>1</td>\n</tr>\n</table>\n<p><code>error</code> can be used to override the default error message.</p>\n<p>See <a href=\"#Log%20Source\" class=\"name\">Log Source</a> for explanation about <code>loglevel</code> argument.</p>\n<p>New in AppiumLibrary 1.4.</p>", "shortdoc": "Verifies that the page contains the given number of elements located by the given ``xpath``.", "tags": [], "source": "C:\\Git\\robotframework-applicationlibrary\\venv\\lib\\site-packages\\AppiumLibrary\\keywords\\_element.py", "lineno": 450}, {"name": "Zoom", "args": [{"name": "locator", "types": [], "typedocs": {}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "locator"}, {"name": "percent", "types": [], "typedocs": {}, "defaultValue": "200%", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "percent=200%"}, {"name": "steps", "types": [], "typedocs": {}, "defaultValue": "1", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "steps=1"}], "doc": "<p>Zooms in on an element a certain amount.</p>", "shortdoc": "Zooms in on an element a certain amount.", "tags": [], "source": "C:\\Git\\robotframework-applicationlibrary\\venv\\lib\\site-packages\\AppiumLibrary\\keywords\\_touch.py", "lineno": 15}], "dataTypes": {"enums": [], "typedDicts": []}, "typedocs": []}
 </script>
 <title></title>
 </head>