diff --git a/docs/APILibraryDocumentation.html b/docs/APILibraryDocumentation.html
index 78776d9b..fb16da6c 100644
--- a/docs/APILibraryDocumentation.html
+++ b/docs/APILibraryDocumentation.html
@@ -1101,7 +1101,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 = {"name": "API_Library", "doc": "<p>Zoomba API Library</p>\n<p>This class is the base Library used to generate automated API Tests in the Robot Automation Framework. It has been generated to accommodate the RESTful API design pattern.</p>", "version": "2.9.0", "generated": "2021-05-12 09:19:41", "type": "LIBRARY", "scope": "TEST", "docFormat": "HTML", "source": "C:\\Git\\robotframework-zoomba\\src\\Zoomba\\APILibrary.py", "lineno": 15, "tags": [], "inits": [], "keywords": [{"name": "Call Delete Request", "args": [{"name": "headers", "types": [], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "headers=None"}, {"name": "endpoint", "types": [], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "endpoint=None"}, {"name": "fullstring", "types": [], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "fullstring=None"}, {"name": "cookies", "types": [], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "cookies=None"}, {"name": "timeout", "types": [], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "timeout=None"}], "doc": "<p>Generate a DELETE Request. This Keyword is basically a wrapper for delete_request from the RequestsLibrary.</p>\n<p>headers: (dictionary) The headers to be sent as part of the request.</p>\n<p>endpoint: (string) The string that identifies the url endpoint of the App that receives API requests.</p>\n<p>fullstring: (string) A string that contains the rest of the url that identifies a specific API/Webservice along with any query parameters.</p>\n<p>timeout: (float) Time in seconds for the api to respond</p>\n<p>return: (response object) Returns the request response object, which includes headers, content, etc.</p>", "shortdoc": "Generate a DELETE Request. This Keyword is basically a wrapper for delete_request from the RequestsLibrary.", "tags": [], "source": "C:\\Git\\robotframework-zoomba\\src\\Zoomba\\APILibrary.py", "lineno": 70}, {"name": "Call Get Request", "args": [{"name": "headers", "types": [], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "headers=None"}, {"name": "endpoint", "types": [], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "endpoint=None"}, {"name": "fullstring", "types": [], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "fullstring=None"}, {"name": "cookies", "types": [], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "cookies=None"}, {"name": "timeout", "types": [], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "timeout=None"}], "doc": "<p>Generate a GET Request. This Keyword is basically a wrapper for get_request from the RequestsLibrary.</p>\n<p>headers: (dictionary) The headers to be sent as part of the request.</p>\n<p>endpoint: (string) The string that identifies the url endpoint of the App that receives API requests.</p>\n<p>fullstring: (string) A string that contains the rest of the url that identifies a specific API/Webservice</p>\n<p>timeout: (float) Time in seconds for the api to respond</p>\n<p>return: (response object) Returns the request response object, which includes headers, content, etc. along with any query parameters.</p>", "shortdoc": "Generate a GET Request. This Keyword is basically a wrapper for get_request from the RequestsLibrary.", "tags": [], "source": "C:\\Git\\robotframework-zoomba\\src\\Zoomba\\APILibrary.py", "lineno": 37}, {"name": "Call Patch Request", "args": [{"name": "headers", "types": [], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "headers=None"}, {"name": "endpoint", "types": [], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "endpoint=None"}, {"name": "fullstring", "types": [], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "fullstring=None"}, {"name": "data", "types": [], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "data=None"}, {"name": "cookies", "types": [], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "cookies=None"}, {"name": "timeout", "types": [], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "timeout=None"}], "doc": "<p>Generate a PATCH Request. This Keyword is basically a wrapper for patch_request from the RequestsLibrary.</p>\n<p>headers: (dictionary) The headers to be sent as part of the request.</p>\n<p>endpoint: (string) The string that identifies the url endpoint of the App that receives API requests.</p>\n<p>fullstring: (string) A string that contains the rest of the url that identifies a specific API/Webservice along with any query parameters.</p>\n<p>timeout: (float) Time in seconds for the api to respond</p>\n<p>data: (json) The JSON object to be sent on the body of the request to be used by the specific Web service.</p>\n<p>return: (response object) Returns the request response object, which includes headers, content, etc.</p>", "shortdoc": "Generate a PATCH Request. This Keyword is basically a wrapper for patch_request from the RequestsLibrary.", "tags": [], "source": "C:\\Git\\robotframework-zoomba\\src\\Zoomba\\APILibrary.py", "lineno": 85}, {"name": "Call Post Request", "args": [{"name": "headers", "types": [], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "headers=None"}, {"name": "endpoint", "types": [], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "endpoint=None"}, {"name": "fullstring", "types": [], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "fullstring=None"}, {"name": "data", "types": [], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "data=None"}, {"name": "files", "types": [], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "files=None"}, {"name": "cookies", "types": [], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "cookies=None"}, {"name": "timeout", "types": [], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "timeout=None"}], "doc": "<p>Generate a POST Request. This Keyword is basically a wrapper for post_request from the RequestsLibrary.</p>\n<p>headers: (dictionary) The headers to be sent as part of the request.</p>\n<p>endpoint: (string) The string that identifies the url endpoint of the App that receives API requests.</p>\n<p>fullstring: (string) A string that contains the rest of the url that identifies a specific API/Webservice along with any query parameters.</p>\n<p>timeout: (float) Time in seconds for the api to respond</p>\n<p>data: (json) The JSON object to be sent on the body of the request to be used by the specific Web service.</p>\n<p>files: (json) A JSON object that sends in the body of the request to be used by the specific Web service.</p>\n<p>return: (response object) Returns the request response object, which includes headers, content, etc.</p>", "shortdoc": "Generate a POST Request. This Keyword is basically a wrapper for post_request from the RequestsLibrary.", "tags": [], "source": "C:\\Git\\robotframework-zoomba\\src\\Zoomba\\APILibrary.py", "lineno": 52}, {"name": "Call Put Request", "args": [{"name": "headers", "types": [], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "headers=None"}, {"name": "endpoint", "types": [], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "endpoint=None"}, {"name": "fullstring", "types": [], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "fullstring=None"}, {"name": "data", "types": [], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "data=None"}, {"name": "cookies", "types": [], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "cookies=None"}, {"name": "timeout", "types": [], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "timeout=None"}], "doc": "<p>Generate a PUT Request. This Keyword is basically a wrapper for put_request from the RequestsLibrary.</p>\n<p>headers: (dictionary) The headers to be sent as part of the request.</p>\n<p>endpoint: (string) The string that identifies the url endpoint of the App that receives API requests.</p>\n<p>fullstring: (string) A string that contains the rest of the url that identifies a specific API/Webservice along with any query parameters.</p>\n<p>timeout: (float) Time in seconds for the api to respond</p>\n<p>data: (json) The JSON object to be sent on the body of the request to be used by the specific Web service.</p>\n<p>return: (response object) Returns the request response object, which includes headers, content, etc.</p>", "shortdoc": "Generate a PUT Request. This Keyword is basically a wrapper for put_request from the RequestsLibrary.", "tags": [], "source": "C:\\Git\\robotframework-zoomba\\src\\Zoomba\\APILibrary.py", "lineno": 102}, {"name": "Create Connection", "args": [{"name": "endpoint", "types": [], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "endpoint"}, {"name": "method", "types": [], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "method"}, {"name": "data", "types": [], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "data"}, {"name": "headers", "types": [], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "headers=None"}, {"name": "cookies", "types": [], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "cookies=None"}, {"name": "timeout", "types": [], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "timeout=None"}], "doc": "<p><b>DEPRECATED!!</b> Use 'Call Post Request' instead.</p>", "shortdoc": "*DEPRECATED!!* Use 'Call Post Request' instead.", "tags": [], "source": "C:\\Git\\robotframework-zoomba\\src\\Zoomba\\APILibrary.py", "lineno": 119}, {"name": "Date Comparator", "args": [{"name": "expected_date", "types": [], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "expected_date"}, {"name": "actual_date", "types": [], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "actual_date"}, {"name": "key", "types": [], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "key"}, {"name": "unmatched_keys_list", "types": [], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "unmatched_keys_list"}, {"name": "margin_type", "types": [], "defaultValue": "minutes", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "margin_type=minutes"}, {"name": "margin_amt", "types": [], "defaultValue": "10", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "margin_amt=10"}], "doc": "<p>This method compares two date values, given a certain margin type(minutes, seconds, etc), and a margin amount (int). If the two dates are not within the margin amount for the margin type, I.E. within 10 minutes of difference, it asserts False, and returns an error message.</p>\n<p>expected_date: (date) The Expected date value of the key being validated.</p>\n<p>actual_date: (date) The Actual date value of the key being validated.</p>\n<p>key: (string) The key being validated.</p>\n<p>unmatched_keys_list: (list) List of Date keys that are not within the accepted margin_type and margin_amt resolution</p>\n<p>margin_type: (string) The type of unit of time to be used to generate a delta for the date comparisons.</p>\n<p>margin_amt: (integer) The amount of units specified in margin_type to allot for difference between dates.</p>", "shortdoc": "This method compares two date values, given a certain margin type(minutes, seconds, etc), and a margin amount (int). If the two dates are not within the margin amount for the margin type, I.E. within 10 minutes of difference, it asserts False, and returns an error message.", "tags": [], "source": "C:\\Git\\robotframework-zoomba\\src\\Zoomba\\APILibrary.py", "lineno": 302}, {"name": "Date String Comparator", "args": [{"name": "expected_date", "types": [], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "expected_date"}, {"name": "actual_date", "types": [], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "actual_date"}, {"name": "key", "types": [], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "key"}, {"name": "unmatched_keys_list", "types": [], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "unmatched_keys_list"}, {"name": "kwargs", "types": [], "defaultValue": null, "kind": "VAR_NAMED", "required": false, "repr": "**kwargs"}], "doc": "<p>This Method is used to validate a single property on a JSON object of the Date Type. It Validates for any the following Date Formats: %Y-%m-%dT%H:%M:%S, %Y-%m-%dT%H:%M:%SZ, %Y-%m-%dT%H:%M:%S.%f, %Y-%m-%dT%H:%M:%S.%fZ</p>\n<p>expected_date: (string) The Expected date string the key being validated.</p>\n<p>actual_date: (string) The Actual date string of the key being validated.</p>\n<p>key: (string) The key being validated.</p>\n<p>unmatched_keys_list (list): List of keys that are unvalidated - to be passed to error handling method. **kwargs: (dict) Currently supported kwargs are margin_type and margin_amt</p>\n<p>margin_type: (string) The type of unit of time to be used to generate a delta for the date comparisons.</p>\n<p>margin_amt: (string/#) The amount of units specified in margin_type to allot for difference between dates.</p>", "shortdoc": "This Method is used to validate a single property on a JSON object of the Date Type. It Validates for any the following Date Formats: %Y-%m-%dT%H:%M:%S, %Y-%m-%dT%H:%M:%SZ, %Y-%m-%dT%H:%M:%S.%f, %Y-%m-%dT%H:%M:%S.%fZ", "tags": [], "source": "C:\\Git\\robotframework-zoomba\\src\\Zoomba\\APILibrary.py", "lineno": 282}, {"name": "Full List Validation", "args": [{"name": "actual_response_dict", "types": [], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "actual_response_dict"}, {"name": "expected_response_dict", "types": [], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "expected_response_dict"}, {"name": "unmatched_keys_list", "types": [], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "unmatched_keys_list"}, {"name": "ignored_keys", "types": [], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "ignored_keys=None"}, {"name": "kwargs", "types": [], "defaultValue": null, "kind": "VAR_NAMED", "required": false, "repr": "**kwargs"}], "doc": "", "shortdoc": "", "tags": [], "source": "C:\\Git\\robotframework-zoomba\\src\\Zoomba\\APILibrary.py", "lineno": 387}, {"name": "Generate Unmatched Keys Error Message", "args": [{"name": "unmatched_keys", "types": [], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "unmatched_keys"}], "doc": "<p>This method is only used as an internal call from other validating methods to generate an error string containing every unmatched key when a validation fails.</p>\n<p>unmatchedKeys: (array of key/value pairs) An array containing the unmatched keys during a validation.</p>", "shortdoc": "This method is only used as an internal call from other validating methods to generate an error string containing every unmatched key when a validation fails.", "tags": [], "source": "C:\\Git\\robotframework-zoomba\\src\\Zoomba\\APILibrary.py", "lineno": 324}, {"name": "Key By Key Validator", "args": [{"name": "actual_dictionary", "types": [], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "actual_dictionary"}, {"name": "expected_dictionary", "types": [], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "expected_dictionary"}, {"name": "ignored_keys", "types": [], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "ignored_keys=None"}, {"name": "unmatched_keys_list", "types": [], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "unmatched_keys_list=None"}, {"name": "parent_key", "types": [], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "parent_key=None"}, {"name": "full_list_validation", "types": [], "defaultValue": "False", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "full_list_validation=False"}, {"name": "kwargs", "types": [], "defaultValue": null, "kind": "VAR_NAMED", "required": false, "repr": "**kwargs"}], "doc": "<p>This method is used to find and verify the value of every key in the expectedItem dictionary when compared against a single dictionary actual_item, unless any keys are included on the ignored_keys array./n</p>\n<p>actual_item: (array of dictionaries) The list of dictionary items extracted from a json Response.</p>\n<p>ExpectedItem: (dictionary) The expected item with the key to be validated.</p>\n<p>ignored_keys: (strings list) A list of strings of the keys to be ignored on the validation.</p>\n<p>**kwargs: (dict) Currently supported kwargs are margin_type and margin_amt</p>\n<p>margin_type: (string) The type of unit of time to be used to generate a delta for the date comparisons.</p>\n<p>margin_amt: (string/#) The amount of units specified in margin_type to allot for difference between dates.</p>\n<p>return: (boolean) If the method completes successfully, it returns True. Appropriate error messages are returned otherwise.</p>", "shortdoc": "This method is used to find and verify the value of every key in the expectedItem dictionary when compared against a single dictionary actual_item, unless any keys are included on the ignored_keys array./n", "tags": [], "source": "C:\\Git\\robotframework-zoomba\\src\\Zoomba\\APILibrary.py", "lineno": 228}, {"name": "Suppress Insecure Request Warnings", "args": [{"name": "suppress", "types": [], "defaultValue": "True", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "suppress=True"}], "doc": "<p>Suppress Insecure Request Warnings. This keyword suppresses or un-suppresses insecure request warnings</p>\n<p>suppress: (bool) True/False to suppress warnings, default is True</p>\n<p>Examples:</p>\n<pre>\nSuppress Insecure Request Warnings                       #Suppresses Insecure Request Warnings\nSuppress Insecure Request Warnings | suppress=True |     #Suppresses Insecure Request Warnings\nSuppress Insecure Request Warnings | False |    #Does Not Suppresses Insecure Request Warnings\n</pre>", "shortdoc": "Suppress Insecure Request Warnings. This keyword suppresses or un-suppresses insecure request warnings", "tags": [], "source": "C:\\Git\\robotframework-zoomba\\src\\Zoomba\\APILibrary.py", "lineno": 24}, {"name": "Validate Response Contains Correct Number Of Items", "args": [{"name": "json_actual_response", "types": [], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "json_actual_response"}, {"name": "number_of_items", "types": [], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "number_of_items"}], "doc": "<p>This keyword is used to validate the number of returned items on Request responses from an API.</p>\n<p>json_actual_response: (request response object) The response from an API.</p>\n<p>number_of_items: (integer) The expected number of items.</p>\n<p>return: There is no actual returned output, other than error messages when comparisons fail.</p>", "shortdoc": "This keyword is used to validate the number of returned items on Request responses from an API.", "tags": [], "source": "C:\\Git\\robotframework-zoomba\\src\\Zoomba\\APILibrary.py", "lineno": 204}, {"name": "Validate Response Contains Expected Response", "args": [{"name": "json_actual_response", "types": [], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "json_actual_response"}, {"name": "expected_response_dict", "types": [], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "expected_response_dict"}, {"name": "ignored_keys", "types": [], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "ignored_keys=None"}, {"name": "full_list_validation", "types": [], "defaultValue": "False", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "full_list_validation=False"}, {"name": "identity_key", "types": [], "defaultValue": "", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "identity_key="}, {"name": "kwargs", "types": [], "defaultValue": null, "kind": "VAR_NAMED", "required": false, "repr": "**kwargs"}], "doc": "<p>This is the most used method for validating Request responses from an API against a supplied expected response. It performs an object to object comparison between two json objects, and if that fails, a more in depth method is called to find the exact discrepancies between the values of the provided objects. Additionally, a list of keys to ignore on the comparison may be supplied, for keys' values to be ignored./n</p>\n<p>json_actual_response: (request response object) The response from an API.</p>\n<p>expected_response_dict: (json) The expected response, in json format.</p>\n<p>ignored_keys: (strings list) A list of strings of the keys to be ignored on the validation.</p>\n<p>**kwargs: (dict) Currently supported kwargs are margin_type and margin_amt</p>\n<p>margin_type: (string) The type of unit of time to be used to generate a delta for the date comparisons.</p>\n<p>margin_amt: (string/#) The amount of units specified in margin_type to allot for difference between dates.</p>\n<p>return: There is no actual returned output, other than error messages when comparisons fail.</p>", "shortdoc": "This is the most used method for validating Request responses from an API against a supplied expected response. It performs an object to object comparison between two json objects, and if that fails, a more in depth method is called to find the exact discrepancies between the values of the provided objects. Additionally, a list of keys to ignore on the comparison may be supplied, for keys' values to be ignored./n", "tags": [], "source": "C:\\Git\\robotframework-zoomba\\src\\Zoomba\\APILibrary.py", "lineno": 123}, {"name": "Validate Response Contains Expected Response Only Keys Listed", "args": [{"name": "json_actual_response", "types": [], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "json_actual_response"}, {"name": "expected_response", "types": [], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "expected_response"}, {"name": "key_list", "types": [], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "key_list"}], "doc": "<p>This keyword is used for validating that a specific set of key-value pairs are contained on Request responses from an API.</p>\n<p>json_actual_response: (request response object) The response from an API.</p>\n<p>jsonExpectedResponse: (json) The expected response, in json format.</p>\n<p>key_list: (strings list) A list of strings of the keys to be included on the validation.</p>\n<p>return: There is no actual returned output, other than error messages when comparisons fail.</p>", "shortdoc": "This keyword is used for validating that a specific set of key-value pairs are contained on Request responses from an API.", "tags": [], "source": "C:\\Git\\robotframework-zoomba\\src\\Zoomba\\APILibrary.py", "lineno": 174}], "dataTypes": {"enums": [], "typedDicts": []}}
+libdoc = {"name": "API_Library", "doc": "<p>Zoomba API Library</p>\n<p>This class is the base Library used to generate automated API Tests in the Robot Automation Framework. It has been generated to accommodate the RESTful API design pattern.</p>", "version": "2.9.1", "generated": "2021-05-14 11:20:38", "type": "LIBRARY", "scope": "TEST", "docFormat": "HTML", "source": "C:\\Git\\robotframework-zoomba\\src\\Zoomba\\APILibrary.py", "lineno": 15, "tags": [], "inits": [], "keywords": [{"name": "Call Delete Request", "args": [{"name": "headers", "types": [], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "headers=None"}, {"name": "endpoint", "types": [], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "endpoint=None"}, {"name": "fullstring", "types": [], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "fullstring=None"}, {"name": "cookies", "types": [], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "cookies=None"}, {"name": "timeout", "types": [], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "timeout=None"}], "doc": "<p>Generate a DELETE Request. This Keyword is basically a wrapper for delete_request from the RequestsLibrary.</p>\n<p>headers: (dictionary) The headers to be sent as part of the request.</p>\n<p>endpoint: (string) The string that identifies the url endpoint of the App that receives API requests.</p>\n<p>fullstring: (string) A string that contains the rest of the url that identifies a specific API/Webservice along with any query parameters.</p>\n<p>timeout: (float) Time in seconds for the api to respond</p>\n<p>return: (response object) Returns the request response object, which includes headers, content, etc.</p>", "shortdoc": "Generate a DELETE Request. This Keyword is basically a wrapper for delete_request from the RequestsLibrary.", "tags": [], "source": "C:\\Git\\robotframework-zoomba\\src\\Zoomba\\APILibrary.py", "lineno": 70}, {"name": "Call Get Request", "args": [{"name": "headers", "types": [], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "headers=None"}, {"name": "endpoint", "types": [], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "endpoint=None"}, {"name": "fullstring", "types": [], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "fullstring=None"}, {"name": "cookies", "types": [], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "cookies=None"}, {"name": "timeout", "types": [], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "timeout=None"}], "doc": "<p>Generate a GET Request. This Keyword is basically a wrapper for get_request from the RequestsLibrary.</p>\n<p>headers: (dictionary) The headers to be sent as part of the request.</p>\n<p>endpoint: (string) The string that identifies the url endpoint of the App that receives API requests.</p>\n<p>fullstring: (string) A string that contains the rest of the url that identifies a specific API/Webservice</p>\n<p>timeout: (float) Time in seconds for the api to respond</p>\n<p>return: (response object) Returns the request response object, which includes headers, content, etc. along with any query parameters.</p>", "shortdoc": "Generate a GET Request. This Keyword is basically a wrapper for get_request from the RequestsLibrary.", "tags": [], "source": "C:\\Git\\robotframework-zoomba\\src\\Zoomba\\APILibrary.py", "lineno": 37}, {"name": "Call Patch Request", "args": [{"name": "headers", "types": [], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "headers=None"}, {"name": "endpoint", "types": [], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "endpoint=None"}, {"name": "fullstring", "types": [], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "fullstring=None"}, {"name": "data", "types": [], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "data=None"}, {"name": "cookies", "types": [], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "cookies=None"}, {"name": "timeout", "types": [], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "timeout=None"}], "doc": "<p>Generate a PATCH Request. This Keyword is basically a wrapper for patch_request from the RequestsLibrary.</p>\n<p>headers: (dictionary) The headers to be sent as part of the request.</p>\n<p>endpoint: (string) The string that identifies the url endpoint of the App that receives API requests.</p>\n<p>fullstring: (string) A string that contains the rest of the url that identifies a specific API/Webservice along with any query parameters.</p>\n<p>timeout: (float) Time in seconds for the api to respond</p>\n<p>data: (json) The JSON object to be sent on the body of the request to be used by the specific Web service.</p>\n<p>return: (response object) Returns the request response object, which includes headers, content, etc.</p>", "shortdoc": "Generate a PATCH Request. This Keyword is basically a wrapper for patch_request from the RequestsLibrary.", "tags": [], "source": "C:\\Git\\robotframework-zoomba\\src\\Zoomba\\APILibrary.py", "lineno": 85}, {"name": "Call Post Request", "args": [{"name": "headers", "types": [], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "headers=None"}, {"name": "endpoint", "types": [], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "endpoint=None"}, {"name": "fullstring", "types": [], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "fullstring=None"}, {"name": "data", "types": [], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "data=None"}, {"name": "files", "types": [], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "files=None"}, {"name": "cookies", "types": [], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "cookies=None"}, {"name": "timeout", "types": [], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "timeout=None"}], "doc": "<p>Generate a POST Request. This Keyword is basically a wrapper for post_request from the RequestsLibrary.</p>\n<p>headers: (dictionary) The headers to be sent as part of the request.</p>\n<p>endpoint: (string) The string that identifies the url endpoint of the App that receives API requests.</p>\n<p>fullstring: (string) A string that contains the rest of the url that identifies a specific API/Webservice along with any query parameters.</p>\n<p>timeout: (float) Time in seconds for the api to respond</p>\n<p>data: (json) The JSON object to be sent on the body of the request to be used by the specific Web service.</p>\n<p>files: (json) A JSON object that sends in the body of the request to be used by the specific Web service.</p>\n<p>return: (response object) Returns the request response object, which includes headers, content, etc.</p>", "shortdoc": "Generate a POST Request. This Keyword is basically a wrapper for post_request from the RequestsLibrary.", "tags": [], "source": "C:\\Git\\robotframework-zoomba\\src\\Zoomba\\APILibrary.py", "lineno": 52}, {"name": "Call Put Request", "args": [{"name": "headers", "types": [], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "headers=None"}, {"name": "endpoint", "types": [], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "endpoint=None"}, {"name": "fullstring", "types": [], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "fullstring=None"}, {"name": "data", "types": [], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "data=None"}, {"name": "cookies", "types": [], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "cookies=None"}, {"name": "timeout", "types": [], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "timeout=None"}], "doc": "<p>Generate a PUT Request. This Keyword is basically a wrapper for put_request from the RequestsLibrary.</p>\n<p>headers: (dictionary) The headers to be sent as part of the request.</p>\n<p>endpoint: (string) The string that identifies the url endpoint of the App that receives API requests.</p>\n<p>fullstring: (string) A string that contains the rest of the url that identifies a specific API/Webservice along with any query parameters.</p>\n<p>timeout: (float) Time in seconds for the api to respond</p>\n<p>data: (json) The JSON object to be sent on the body of the request to be used by the specific Web service.</p>\n<p>return: (response object) Returns the request response object, which includes headers, content, etc.</p>", "shortdoc": "Generate a PUT Request. This Keyword is basically a wrapper for put_request from the RequestsLibrary.", "tags": [], "source": "C:\\Git\\robotframework-zoomba\\src\\Zoomba\\APILibrary.py", "lineno": 102}, {"name": "Create Connection", "args": [{"name": "endpoint", "types": [], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "endpoint"}, {"name": "method", "types": [], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "method"}, {"name": "data", "types": [], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "data"}, {"name": "headers", "types": [], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "headers=None"}, {"name": "cookies", "types": [], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "cookies=None"}, {"name": "timeout", "types": [], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "timeout=None"}], "doc": "<p><b>DEPRECATED!!</b> Use 'Call Post Request' instead.</p>", "shortdoc": "*DEPRECATED!!* Use 'Call Post Request' instead.", "tags": [], "source": "C:\\Git\\robotframework-zoomba\\src\\Zoomba\\APILibrary.py", "lineno": 119}, {"name": "Date Comparator", "args": [{"name": "expected_date", "types": [], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "expected_date"}, {"name": "actual_date", "types": [], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "actual_date"}, {"name": "key", "types": [], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "key"}, {"name": "unmatched_keys_list", "types": [], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "unmatched_keys_list"}, {"name": "margin_type", "types": [], "defaultValue": "minutes", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "margin_type=minutes"}, {"name": "margin_amt", "types": [], "defaultValue": "10", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "margin_amt=10"}], "doc": "<p>This method compares two date values, given a certain margin type(minutes, seconds, etc), and a margin amount (int). If the two dates are not within the margin amount for the margin type, I.E. within 10 minutes of difference, it asserts False, and returns an error message.</p>\n<p>expected_date: (date) The Expected date value of the key being validated.</p>\n<p>actual_date: (date) The Actual date value of the key being validated.</p>\n<p>key: (string) The key being validated.</p>\n<p>unmatched_keys_list: (list) List of Date keys that are not within the accepted margin_type and margin_amt resolution</p>\n<p>margin_type: (string) The type of unit of time to be used to generate a delta for the date comparisons.</p>\n<p>margin_amt: (integer) The amount of units specified in margin_type to allot for difference between dates.</p>", "shortdoc": "This method compares two date values, given a certain margin type(minutes, seconds, etc), and a margin amount (int). If the two dates are not within the margin amount for the margin type, I.E. within 10 minutes of difference, it asserts False, and returns an error message.", "tags": [], "source": "C:\\Git\\robotframework-zoomba\\src\\Zoomba\\APILibrary.py", "lineno": 302}, {"name": "Date String Comparator", "args": [{"name": "expected_date", "types": [], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "expected_date"}, {"name": "actual_date", "types": [], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "actual_date"}, {"name": "key", "types": [], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "key"}, {"name": "unmatched_keys_list", "types": [], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "unmatched_keys_list"}, {"name": "kwargs", "types": [], "defaultValue": null, "kind": "VAR_NAMED", "required": false, "repr": "**kwargs"}], "doc": "<p>This Method is used to validate a single property on a JSON object of the Date Type. It Validates for any the following Date Formats: %Y-%m-%dT%H:%M:%S, %Y-%m-%dT%H:%M:%SZ, %Y-%m-%dT%H:%M:%S.%f, %Y-%m-%dT%H:%M:%S.%fZ</p>\n<p>expected_date: (string) The Expected date string the key being validated.</p>\n<p>actual_date: (string) The Actual date string of the key being validated.</p>\n<p>key: (string) The key being validated.</p>\n<p>unmatched_keys_list (list): List of keys that are unvalidated - to be passed to error handling method. **kwargs: (dict) Currently supported kwargs are margin_type and margin_amt</p>\n<p>margin_type: (string) The type of unit of time to be used to generate a delta for the date comparisons.</p>\n<p>margin_amt: (string/#) The amount of units specified in margin_type to allot for difference between dates.</p>", "shortdoc": "This Method is used to validate a single property on a JSON object of the Date Type. It Validates for any the following Date Formats: %Y-%m-%dT%H:%M:%S, %Y-%m-%dT%H:%M:%SZ, %Y-%m-%dT%H:%M:%S.%f, %Y-%m-%dT%H:%M:%S.%fZ", "tags": [], "source": "C:\\Git\\robotframework-zoomba\\src\\Zoomba\\APILibrary.py", "lineno": 282}, {"name": "Full List Validation", "args": [{"name": "actual_response_dict", "types": [], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "actual_response_dict"}, {"name": "expected_response_dict", "types": [], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "expected_response_dict"}, {"name": "unmatched_keys_list", "types": [], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "unmatched_keys_list"}, {"name": "ignored_keys", "types": [], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "ignored_keys=None"}, {"name": "kwargs", "types": [], "defaultValue": null, "kind": "VAR_NAMED", "required": false, "repr": "**kwargs"}], "doc": "", "shortdoc": "", "tags": [], "source": "C:\\Git\\robotframework-zoomba\\src\\Zoomba\\APILibrary.py", "lineno": 387}, {"name": "Generate Unmatched Keys Error Message", "args": [{"name": "unmatched_keys", "types": [], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "unmatched_keys"}], "doc": "<p>This method is only used as an internal call from other validating methods to generate an error string containing every unmatched key when a validation fails.</p>\n<p>unmatchedKeys: (array of key/value pairs) An array containing the unmatched keys during a validation.</p>", "shortdoc": "This method is only used as an internal call from other validating methods to generate an error string containing every unmatched key when a validation fails.", "tags": [], "source": "C:\\Git\\robotframework-zoomba\\src\\Zoomba\\APILibrary.py", "lineno": 324}, {"name": "Key By Key Validator", "args": [{"name": "actual_dictionary", "types": [], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "actual_dictionary"}, {"name": "expected_dictionary", "types": [], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "expected_dictionary"}, {"name": "ignored_keys", "types": [], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "ignored_keys=None"}, {"name": "unmatched_keys_list", "types": [], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "unmatched_keys_list=None"}, {"name": "parent_key", "types": [], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "parent_key=None"}, {"name": "full_list_validation", "types": [], "defaultValue": "False", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "full_list_validation=False"}, {"name": "kwargs", "types": [], "defaultValue": null, "kind": "VAR_NAMED", "required": false, "repr": "**kwargs"}], "doc": "<p>This method is used to find and verify the value of every key in the expectedItem dictionary when compared against a single dictionary actual_item, unless any keys are included on the ignored_keys array./n</p>\n<p>actual_item: (array of dictionaries) The list of dictionary items extracted from a json Response.</p>\n<p>ExpectedItem: (dictionary) The expected item with the key to be validated.</p>\n<p>ignored_keys: (strings list) A list of strings of the keys to be ignored on the validation.</p>\n<p>**kwargs: (dict) Currently supported kwargs are margin_type and margin_amt</p>\n<p>margin_type: (string) The type of unit of time to be used to generate a delta for the date comparisons.</p>\n<p>margin_amt: (string/#) The amount of units specified in margin_type to allot for difference between dates.</p>\n<p>return: (boolean) If the method completes successfully, it returns True. Appropriate error messages are returned otherwise.</p>", "shortdoc": "This method is used to find and verify the value of every key in the expectedItem dictionary when compared against a single dictionary actual_item, unless any keys are included on the ignored_keys array./n", "tags": [], "source": "C:\\Git\\robotframework-zoomba\\src\\Zoomba\\APILibrary.py", "lineno": 228}, {"name": "Suppress Insecure Request Warnings", "args": [{"name": "suppress", "types": [], "defaultValue": "True", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "suppress=True"}], "doc": "<p>Suppress Insecure Request Warnings. This keyword suppresses or un-suppresses insecure request warnings</p>\n<p>suppress: (bool) True/False to suppress warnings, default is True</p>\n<p>Examples:</p>\n<pre>\nSuppress Insecure Request Warnings                       #Suppresses Insecure Request Warnings\nSuppress Insecure Request Warnings | suppress=True |     #Suppresses Insecure Request Warnings\nSuppress Insecure Request Warnings | False |    #Does Not Suppresses Insecure Request Warnings\n</pre>", "shortdoc": "Suppress Insecure Request Warnings. This keyword suppresses or un-suppresses insecure request warnings", "tags": [], "source": "C:\\Git\\robotframework-zoomba\\src\\Zoomba\\APILibrary.py", "lineno": 24}, {"name": "Validate Response Contains Correct Number Of Items", "args": [{"name": "json_actual_response", "types": [], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "json_actual_response"}, {"name": "number_of_items", "types": [], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "number_of_items"}], "doc": "<p>This keyword is used to validate the number of returned items on Request responses from an API.</p>\n<p>json_actual_response: (request response object) The response from an API.</p>\n<p>number_of_items: (integer) The expected number of items.</p>\n<p>return: There is no actual returned output, other than error messages when comparisons fail.</p>", "shortdoc": "This keyword is used to validate the number of returned items on Request responses from an API.", "tags": [], "source": "C:\\Git\\robotframework-zoomba\\src\\Zoomba\\APILibrary.py", "lineno": 204}, {"name": "Validate Response Contains Expected Response", "args": [{"name": "json_actual_response", "types": [], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "json_actual_response"}, {"name": "expected_response_dict", "types": [], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "expected_response_dict"}, {"name": "ignored_keys", "types": [], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "ignored_keys=None"}, {"name": "full_list_validation", "types": [], "defaultValue": "False", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "full_list_validation=False"}, {"name": "identity_key", "types": [], "defaultValue": "", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "identity_key="}, {"name": "kwargs", "types": [], "defaultValue": null, "kind": "VAR_NAMED", "required": false, "repr": "**kwargs"}], "doc": "<p>This is the most used method for validating Request responses from an API against a supplied expected response. It performs an object to object comparison between two json objects, and if that fails, a more in depth method is called to find the exact discrepancies between the values of the provided objects. Additionally, a list of keys to ignore on the comparison may be supplied, for keys' values to be ignored./n</p>\n<p>json_actual_response: (request response object) The response from an API.</p>\n<p>expected_response_dict: (json) The expected response, in json format.</p>\n<p>ignored_keys: (strings list) A list of strings of the keys to be ignored on the validation.</p>\n<p>**kwargs: (dict) Currently supported kwargs are margin_type and margin_amt</p>\n<p>margin_type: (string) The type of unit of time to be used to generate a delta for the date comparisons.</p>\n<p>margin_amt: (string/#) The amount of units specified in margin_type to allot for difference between dates.</p>\n<p>return: There is no actual returned output, other than error messages when comparisons fail.</p>", "shortdoc": "This is the most used method for validating Request responses from an API against a supplied expected response. It performs an object to object comparison between two json objects, and if that fails, a more in depth method is called to find the exact discrepancies between the values of the provided objects. Additionally, a list of keys to ignore on the comparison may be supplied, for keys' values to be ignored./n", "tags": [], "source": "C:\\Git\\robotframework-zoomba\\src\\Zoomba\\APILibrary.py", "lineno": 123}, {"name": "Validate Response Contains Expected Response Only Keys Listed", "args": [{"name": "json_actual_response", "types": [], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "json_actual_response"}, {"name": "expected_response", "types": [], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "expected_response"}, {"name": "key_list", "types": [], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "key_list"}], "doc": "<p>This keyword is used for validating that a specific set of key-value pairs are contained on Request responses from an API.</p>\n<p>json_actual_response: (request response object) The response from an API.</p>\n<p>jsonExpectedResponse: (json) The expected response, in json format.</p>\n<p>key_list: (strings list) A list of strings of the keys to be included on the validation.</p>\n<p>return: There is no actual returned output, other than error messages when comparisons fail.</p>", "shortdoc": "This keyword is used for validating that a specific set of key-value pairs are contained on Request responses from an API.", "tags": [], "source": "C:\\Git\\robotframework-zoomba\\src\\Zoomba\\APILibrary.py", "lineno": 174}], "dataTypes": {"enums": [], "typedDicts": []}}
 </script>
 <title></title>
 </head>
diff --git a/docs/DesktopLibraryDocumentation.html b/docs/DesktopLibraryDocumentation.html
index f5307e2a..dd45e2f9 100644
--- a/docs/DesktopLibraryDocumentation.html
+++ b/docs/DesktopLibraryDocumentation.html
@@ -1101,7 +1101,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 = {"name": "Desktop_Library", "doc": "<p>Zoomba Desktop Library</p>\n<p>This class is the base Library used to generate automated Desktop 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 DesktopLibrary that need to find an element on the page take a locator argument. To find these locators we use <b>*Accessibility Insights*</b> to inspect the application under test. This tool allows you to see every UI element/node that you can interact with using DesktopLibrary. <b>*Accessibility Insights*</b> can be downloaded at <a href=\"https://accessibilityinsights.io/\">https://accessibilityinsights.io/</a> The tool will show various element attributes. The table below shows you witch locator strategy you should use to find elements with the corresponding attributes.</p>\n<p>To locate xpath we suggest using the <b>*WinAppDriver UI Recorder*</b> located here: <a href=\"https://github.com/Microsoft/WinAppDriver/releases\">https://github.com/Microsoft/WinAppDriver/releases</a></p>\n<table border=\"1\">\n<tr>\n<td><b>Locator Strategy</b></td>\n<td><b>Matched Attribute in Insights</b></td>\n<td><b>Example</b></td>\n</tr>\n<tr>\n<td>accessibility_id</td>\n<td>AutomationId</td>\n<td>Click Element <span class=\"name\">|</span> accessibility_id=my_element_id</td>\n</tr>\n<tr>\n<td>class</td>\n<td>ClassName</td>\n<td>Click Element <span class=\"name\">|</span> class=UIAPickerWheel</td>\n</tr>\n<tr>\n<td>name</td>\n<td>Name</td>\n<td>Click Element <span class=\"name\">|</span> name=my_element</td>\n</tr>\n<tr>\n<td>xpath</td>\n<td>N/A</td>\n<td>Click Element <span class=\"name\">|</span> xpath=//Button[@Name=\"Close\"]</td>\n</tr>\n<tr>\n<td>image</td>\n<td>N/A</td>\n<td>Click Element <span class=\"name\">|</span> image=file.png</td>\n</tr>\n</table>\n<p>The <code>image</code> locator strategy can only be used with Appium v1.18.0 or higher.</p>\n<p>Example tests using the windows calculator are located in the tests directory.</p>\n<h2 id=\"Use of Wait Keywords\">Use of Wait Keywords</h2>\n<p>When using a modern Windows application there should be no issue with using the 'Wait For And' keywords. However if you are using an older WinForm, Win32, or a larger application it may be necessary to simply use the non-waiting version of keywords. Then you would simply add your waits in manually where necessary using something like <code>Wait Until Page Contains</code> or <code>Wait Until Page Contains Element</code>.</p>", "version": "2.9.0", "generated": "2021-05-12 09:19:41", "type": "LIBRARY", "scope": "GLOBAL", "docFormat": "HTML", "source": "C:\\Git\\robotframework-zoomba\\src\\Zoomba\\DesktopLibrary.py", "lineno": 55, "tags": [], "inits": [{"name": "Init", "args": [{"name": "timeout", "types": [], "defaultValue": "5", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "timeout=5"}, {"name": "run_on_failure", "types": [], "defaultValue": "Save Appium Screenshot", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "run_on_failure=Save Appium Screenshot"}, {"name": "driver_path", "types": [], "defaultValue": "C:\\\\Program Files (x86)\\\\Windows Application Driver\\\\WinAppDriver.exe", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "driver_path=C:\\\\Program Files (x86)\\\\Windows Application Driver\\\\WinAppDriver.exe"}], "doc": "<p>DesktopLibrary can be imported with optional arguments.</p>\n<p><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>.</p>\n<p><code>run_on_failure</code> specifies the name of a keyword (from any available libraries) to execute when a DesktopLibrary 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 <code>No Operation</code> 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.</p>\n<p><code>driver_path</code> is the path to the WinAppDriver.exe file.</p>\n<p>Examples:</p>\n<table border=\"1\">\n<tr>\n<td>Library</td>\n<td>DesktopLibrary</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>DesktopLibrary</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<tr>\n<td>Library</td>\n<td>DesktopLibrary</td>\n<td>timeout=10</td>\n<td>driver_path=\"C:/WinAppDriver.exe\"</td>\n<td># Sets a new path for the WinAppDriver</td>\n</tr>\n</table>", "shortdoc": "DesktopLibrary can be imported with optional arguments.", "tags": [], "source": "C:\\Git\\robotframework-zoomba\\src\\Zoomba\\DesktopLibrary.py", "lineno": 91}], "keywords": [{"name": "Capture Page Screenshot", "args": [{"name": "filename", "types": [], "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 background 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-zoomba\\src\\Zoomba\\DesktopLibrary.py", "lineno": 691}, {"name": "Clear Text", "args": [{"name": "locator", "types": [], "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:\\Python\\lib\\site-packages\\AppiumLibrary\\keywords\\_element.py", "lineno": 27}, {"name": "Click A Point", "args": [{"name": "x_offset", "types": [], "defaultValue": "0", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "x_offset=0"}, {"name": "y_offset", "types": [], "defaultValue": "0", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "y_offset=0"}, {"name": "double_click", "types": [], "defaultValue": "False", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "double_click=False"}], "doc": "<p>Clicks the current mouse location.</p>\n<p><code>x_offset</code> and <code>y_offset</code> can be applied to give an offset.</p>\n<p><code>double_click</code> can be used to click twice.</p>", "shortdoc": "Clicks the current mouse location.", "tags": [], "source": "C:\\Git\\robotframework-zoomba\\src\\Zoomba\\DesktopLibrary.py", "lineno": 608}, {"name": "Click Button", "args": [{"name": "index_or_name", "types": [], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "index_or_name"}], "doc": "<p>Click button</p>", "shortdoc": "Click button", "tags": [], "source": "C:\\Python\\lib\\site-packages\\AppiumLibrary\\keywords\\_element.py", "lineno": 44}, {"name": "Click Element", "args": [{"name": "locator", "types": [], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "locator"}], "doc": "<p>Click element identified by <span class=\"name\">locator</span>.</p>\n<p>Supported prefixes: <code>accessibility_id</code>, <code>name</code>, <code>class</code>, <code>xpath</code>, and <code>image</code></p>\n<p>The <code>image</code> locator strategy can only be used with Appium v1.18.0 and newer.</p>\n<p>If no prefix is given <code>click element</code> defaults to <code>accessibility_id</code> or <code>xpath</code></p>", "shortdoc": "Click element identified by `locator`.", "tags": [], "source": "C:\\Git\\robotframework-zoomba\\src\\Zoomba\\DesktopLibrary.py", "lineno": 400}, {"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:\\Python\\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:\\Python\\lib\\site-packages\\AppiumLibrary\\keywords\\_applicationmanagement.py", "lineno": 20}, {"name": "Context Click A Point", "args": [{"name": "x_offset", "types": [], "defaultValue": "0", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "x_offset=0"}, {"name": "y_offset", "types": [], "defaultValue": "0", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "y_offset=0"}], "doc": "<p>Right-clicks the current mouse location.</p>\n<p><code>x_offset</code> and <code>y_offset</code> can be applied to give an offset.</p>", "shortdoc": "Right-clicks the current mouse location.", "tags": [], "source": "C:\\Git\\robotframework-zoomba\\src\\Zoomba\\DesktopLibrary.py", "lineno": 625}, {"name": "Double Tap", "args": [{"name": "locator", "types": [], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "locator"}], "doc": "<p>Double tap element identified by <code>locator</code>.</p>", "shortdoc": "Double tap element identified by ``locator``.", "tags": [], "source": "C:\\Git\\robotframework-zoomba\\src\\Zoomba\\DesktopLibrary.py", "lineno": 826}, {"name": "Drag And Drop", "args": [{"name": "source", "types": [], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "source"}, {"name": "target", "types": [], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "target"}], "doc": "<p>Drags the element found with the locator <code>source</code> to the element found with the locator <code>target</code>.</p>", "shortdoc": "Drags the element found with the locator ``source`` to the element found with the locator ``target``.", "tags": [], "source": "C:\\Git\\robotframework-zoomba\\src\\Zoomba\\DesktopLibrary.py", "lineno": 637}, {"name": "Drag And Drop By Offset", "args": [{"name": "locator", "types": [], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "locator"}, {"name": "x_offset", "types": [], "defaultValue": "0", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "x_offset=0"}, {"name": "y_offset", "types": [], "defaultValue": "0", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "y_offset=0"}], "doc": "<p>Drags the element found with <code>locator</code> to the given <code>x_offset</code> and <code>y_offset</code> coordinates.</p>", "shortdoc": "Drags the element found with ``locator`` to the given ``x_offset`` and ``y_offset`` coordinates.", "tags": [], "source": "C:\\Git\\robotframework-zoomba\\src\\Zoomba\\DesktopLibrary.py", "lineno": 643}, {"name": "Drag And Drop by Touch", "args": [{"name": "source", "types": [], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "source"}, {"name": "target", "types": [], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "target"}], "doc": "<p>Drags the element found with the locator <code>source</code> to the element found with the locator <code>target</code> using touch actions.</p>", "shortdoc": "Drags the element found with the locator ``source`` to the element found with the locator ``target`` using touch actions.", "tags": [], "source": "C:\\Git\\robotframework-zoomba\\src\\Zoomba\\DesktopLibrary.py", "lineno": 803}, {"name": "Drag And Drop by Touch Offset", "args": [{"name": "locator", "types": [], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "locator"}, {"name": "x_offset", "types": [], "defaultValue": "0", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "x_offset=0"}, {"name": "y_offset", "types": [], "defaultValue": "0", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "y_offset=0"}], "doc": "<p>Drags the element found with <code>locator </code> to the given <code>x_offset</code> and <code>y_offset</code> coordinates using touch actions.</p>", "shortdoc": "Drags the element found with ``locator `` to the given ``x_offset`` and ``y_offset`` coordinates using touch actions.", "tags": [], "source": "C:\\Git\\robotframework-zoomba\\src\\Zoomba\\DesktopLibrary.py", "lineno": 816}, {"name": "Driver Setup", "args": [{"name": "path", "types": [], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "path=None"}], "doc": "<p>Starts the WinAppDriver.</p>\n<p><code>path</code> can be provided if your winappdriver installation is not in the default path of <code>C:/Program Files (x86)/Windows Application Driver/WinAppDriver.exe</code>.</p>\n<p>Not to be used with Appium.</p>", "shortdoc": "Starts the WinAppDriver.", "tags": [], "source": "C:\\Git\\robotframework-zoomba\\src\\Zoomba\\DesktopLibrary.py", "lineno": 229}, {"name": "Driver Teardown", "args": [], "doc": "<p>Stops the WinAppDriver.</p>\n<p>Not to be used with Appium.</p>", "shortdoc": "Stops the WinAppDriver.", "tags": [], "source": "C:\\Git\\robotframework-zoomba\\src\\Zoomba\\DesktopLibrary.py", "lineno": 239}, {"name": "Element Attribute Should Match", "args": [{"name": "locator", "types": [], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "locator"}, {"name": "attr_name", "types": [], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "attr_name"}, {"name": "match_pattern", "types": [], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "match_pattern"}, {"name": "regexp", "types": [], "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:\\Python\\lib\\site-packages\\AppiumLibrary\\keywords\\_element.py", "lineno": 205}, {"name": "Element Should Be Disabled", "args": [{"name": "locator", "types": [], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "locator"}, {"name": "loglevel", "types": [], "defaultValue": "INFO", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "loglevel=INFO"}], "doc": "<p>Verifies that element identified with locator is disabled.</p>", "shortdoc": "Verifies that element identified with locator is disabled.", "tags": [], "source": "C:\\Git\\robotframework-zoomba\\src\\Zoomba\\DesktopLibrary.py", "lineno": 521}, {"name": "Element Should Be Enabled", "args": [{"name": "locator", "types": [], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "locator"}, {"name": "loglevel", "types": [], "defaultValue": "INFO", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "loglevel=INFO"}], "doc": "<p>Verifies that element identified with locator is enabled.</p>", "shortdoc": "Verifies that element identified with locator is enabled.", "tags": [], "source": "C:\\Git\\robotframework-zoomba\\src\\Zoomba\\DesktopLibrary.py", "lineno": 500}, {"name": "Element Should Be Visible", "args": [{"name": "locator", "types": [], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "locator"}, {"name": "loglevel", "types": [], "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:\\Python\\lib\\site-packages\\AppiumLibrary\\keywords\\_element.py", "lineno": 178}, {"name": "Element Should Contain Text", "args": [{"name": "locator", "types": [], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "locator"}, {"name": "expected", "types": [], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "expected"}, {"name": "message", "types": [], "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:\\Python\\lib\\site-packages\\AppiumLibrary\\keywords\\_element.py", "lineno": 285}, {"name": "Element Should Not Contain Text", "args": [{"name": "locator", "types": [], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "locator"}, {"name": "expected", "types": [], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "expected"}, {"name": "message", "types": [], "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:\\Python\\lib\\site-packages\\AppiumLibrary\\keywords\\_element.py", "lineno": 304}, {"name": "Element Text Should Be", "args": [{"name": "locator", "types": [], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "locator"}, {"name": "expected", "types": [], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "expected"}, {"name": "message", "types": [], "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:\\Python\\lib\\site-packages\\AppiumLibrary\\keywords\\_element.py", "lineno": 319}, {"name": "Flick", "args": [{"name": "x_speed", "types": [], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "x_speed"}, {"name": "y_speed", "types": [], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "y_speed"}], "doc": "<p>Flicks from current position.</p>\n<p><code>x_speed</code> is the X speed in pixels per second.</p>\n<p><code>y_speed</code> is the Y speed in pixels per second.</p>", "shortdoc": "Flicks from current position.", "tags": [], "source": "C:\\Git\\robotframework-zoomba\\src\\Zoomba\\DesktopLibrary.py", "lineno": 860}, {"name": "Flick From Element", "args": [{"name": "locator", "types": [], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "locator"}, {"name": "x_offset", "types": [], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "x_offset"}, {"name": "y_offset", "types": [], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "y_offset"}, {"name": "speed", "types": [], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "speed"}], "doc": "<p>Flicks starting at <code>locator</code>.</p>\n<p><code>x_offset</code> is X offset to flick to.</p>\n<p><code>y_offset</code> is Y offset to flick to.</p>\n<p><code>speed</code> is Pixels per second to flick.</p>", "shortdoc": "Flicks starting at ``locator``.", "tags": [], "source": "C:\\Git\\robotframework-zoomba\\src\\Zoomba\\DesktopLibrary.py", "lineno": 870}, {"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:\\Python\\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:\\Python\\lib\\site-packages\\AppiumLibrary\\keywords\\_applicationmanagement.py", "lineno": 137}, {"name": "Get Capability", "args": [{"name": "capability_name", "types": [], "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:\\Python\\lib\\site-packages\\AppiumLibrary\\keywords\\_applicationmanagement.py", "lineno": 335}, {"name": "Get Element Attribute", "args": [{"name": "locator", "types": [], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "locator"}, {"name": "attribute", "types": [], "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:\\Python\\lib\\site-packages\\AppiumLibrary\\keywords\\_element.py", "lineno": 365}, {"name": "Get Element Location", "args": [{"name": "locator", "types": [], "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:\\Python\\lib\\site-packages\\AppiumLibrary\\keywords\\_element.py", "lineno": 387}, {"name": "Get Element Size", "args": [{"name": "locator", "types": [], "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:\\Python\\lib\\site-packages\\AppiumLibrary\\keywords\\_element.py", "lineno": 398}, {"name": "Get Matching Xpath Count", "args": [{"name": "xpath", "types": [], "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:\\Python\\lib\\site-packages\\AppiumLibrary\\keywords\\_element.py", "lineno": 422}, {"name": "Get Webelement", "args": [{"name": "locator", "types": [], "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:\\Python\\lib\\site-packages\\AppiumLibrary\\keywords\\_element.py", "lineno": 339}, {"name": "Get Webelements", "args": [{"name": "locator", "types": [], "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:\\Python\\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:\\Python\\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:\\Python\\lib\\site-packages\\AppiumLibrary\\keywords\\_applicationmanagement.py", "lineno": 309}, {"name": "Input Password", "args": [{"name": "locator", "types": [], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "locator"}, {"name": "text", "types": [], "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:\\Python\\lib\\site-packages\\AppiumLibrary\\keywords\\_element.py", "lineno": 72}, {"name": "Input Text", "args": [{"name": "locator", "types": [], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "locator"}, {"name": "text", "types": [], "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:\\Python\\lib\\site-packages\\AppiumLibrary\\keywords\\_element.py", "lineno": 64}, {"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\">http://localhost:4723</a></td>\n<td>platformName=Windows</td>\n<td>deviceName=Windows</td>\n<td>app=${App_Path}</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 session running.</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-zoomba\\src\\Zoomba\\DesktopLibrary.py", "lineno": 362}, {"name": "Log Source", "args": [{"name": "loglevel", "types": [], "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:\\Python\\lib\\site-packages\\AppiumLibrary\\keywords\\_applicationmanagement.py", "lineno": 172}, {"name": "Long Press", "args": [{"name": "locator", "types": [], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "locator"}, {"name": "duration", "types": [], "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:\\Python\\lib\\site-packages\\AppiumLibrary\\keywords\\_touch.py", "lineno": 112}, {"name": "Maximize Window", "args": [], "doc": "<p>Maximizes the current application window.</p>", "shortdoc": "Maximizes the current application window.", "tags": [], "source": "C:\\Git\\robotframework-zoomba\\src\\Zoomba\\DesktopLibrary.py", "lineno": 247}, {"name": "Mouse Over And Click Element", "args": [{"name": "locator", "types": [], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "locator"}, {"name": "double_click", "types": [], "defaultValue": "False", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "double_click=False"}, {"name": "x_offset", "types": [], "defaultValue": "0", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "x_offset=0"}, {"name": "y_offset", "types": [], "defaultValue": "0", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "y_offset=0"}], "doc": "<p>Moves the mouse over and clicks the given <code>locator</code>.</p>\n<p><code>double_click</code> can be used to click twice.</p>\n<p><code>x_offset</code> and <code>y_offset</code> can be used to move to a specific coordinate.</p>", "shortdoc": "Moves the mouse over and clicks the given ``locator``.", "tags": [], "source": "C:\\Git\\robotframework-zoomba\\src\\Zoomba\\DesktopLibrary.py", "lineno": 565}, {"name": "Mouse Over And Context Click Element", "args": [{"name": "locator", "types": [], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "locator"}, {"name": "x_offset", "types": [], "defaultValue": "0", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "x_offset=0"}, {"name": "y_offset", "types": [], "defaultValue": "0", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "y_offset=0"}], "doc": "<p>Moves the mouse over and right-clicks the given <code>locator</code>.</p>\n<p><code>x_offset</code> and <code>y_offset</code> can be used to move to a specific coordinate.</p>\n<p>See also <a href=\"#Mouse%20Over%20And%20Click%20Element\" class=\"name\">Mouse Over And Click Element</a></p>", "shortdoc": "Moves the mouse over and right-clicks the given ``locator``.", "tags": [], "source": "C:\\Git\\robotframework-zoomba\\src\\Zoomba\\DesktopLibrary.py", "lineno": 575}, {"name": "Mouse Over By Offset", "args": [{"name": "x_offset", "types": [], "defaultValue": "0", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "x_offset=0"}, {"name": "y_offset", "types": [], "defaultValue": "0", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "y_offset=0"}], "doc": "<p>Moves the mouse from its current location by the given <code>x_offset</code> and <code>y_offset</code>.</p>", "shortdoc": "Moves the mouse from its current location by the given ``x_offset`` and ``y_offset``.", "tags": [], "source": "C:\\Git\\robotframework-zoomba\\src\\Zoomba\\DesktopLibrary.py", "lineno": 600}, {"name": "Mouse Over Element", "args": [{"name": "locator", "types": [], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "locator"}, {"name": "x_offset", "types": [], "defaultValue": "0", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "x_offset=0"}, {"name": "y_offset", "types": [], "defaultValue": "0", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "y_offset=0"}], "doc": "<p>Moves the mouse over the given <code>locator</code>.</p>\n<p><code>x_offset</code> and <code>y_offset</code> can be used to move to a specific coordinate.</p>", "shortdoc": "Moves the mouse over the given ``locator``.", "tags": [], "source": "C:\\Git\\robotframework-zoomba\\src\\Zoomba\\DesktopLibrary.py", "lineno": 542}, {"name": "Open Application", "args": [{"name": "remote_url", "types": [], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "remote_url"}, {"name": "alias", "types": [], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "alias=None"}, {"name": "window_name", "types": [], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "window_name=None"}, {"name": "splash_delay", "types": [], "defaultValue": "0", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "splash_delay=0"}, {"name": "exact_match", "types": [], "defaultValue": "True", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "exact_match=True"}, {"name": "kwargs", "types": [], "defaultValue": null, "kind": "VAR_NAMED", "required": false, "repr": "**kwargs"}], "doc": "<p>Opens a new application to given Appium server. If your application has a splash screen please supply the window name of the final window that will appear. For the capabilities of appium server and Windows please check <a href=\"http://appium.io/docs/en/drivers/windows\">http://appium.io/docs/en/drivers/windows</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<tr>\n<td>window_name</td>\n<td>No</td>\n<td>Window name you wish to attach, usually after a splash screen</td>\n</tr>\n<tr>\n<td>splash_delay</td>\n<td>No</td>\n<td>Delay used when waiting for a splash screen to load, in seconds</td>\n</tr>\n<tr>\n<td>exact_match</td>\n<td>No</td>\n<td>Set to False if window_name does not need to match exactly</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=Windows</td>\n<td>deviceName=Windows</td>\n<td>app=your.app</td>\n<td></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>alias=Myapp1</td>\n<td>platformName=Windows</td>\n<td>deviceName=Windows</td>\n<td>app=your.app</td>\n<td>window_name=MyApplication</td>\n<td>splash_delay=5</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>alias=Myapp1</td>\n<td>platformName=Windows</td>\n<td>deviceName=Windows</td>\n<td>app=your.app</td>\n<td>window_name=MyApplication</td>\n<td>exact_match=False</td>\n</tr>\n</table>\n<p>A session for the root desktop will also be opened and can be switched to by running the following:</p>\n<table border=\"1\">\n<tr>\n<td>Switch Application</td>\n<td>Desktop</td>\n</tr>\n</table>", "shortdoc": "Opens a new application to given Appium server. If your application has a splash screen please supply the window name of the final window that will appear. For the capabilities of appium server and Windows please check http://appium.io/docs/en/drivers/windows", "tags": [], "source": "C:\\Git\\robotframework-zoomba\\src\\Zoomba\\DesktopLibrary.py", "lineno": 253}, {"name": "Page Should Contain Element", "args": [{"name": "locator", "types": [], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "locator"}, {"name": "loglevel", "types": [], "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:\\Python\\lib\\site-packages\\AppiumLibrary\\keywords\\_element.py", "lineno": 129}, {"name": "Page Should Contain Text", "args": [{"name": "text", "types": [], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "text"}, {"name": "loglevel", "types": [], "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:\\Python\\lib\\site-packages\\AppiumLibrary\\keywords\\_element.py", "lineno": 104}, {"name": "Page Should Not Contain Element", "args": [{"name": "locator", "types": [], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "locator"}, {"name": "loglevel", "types": [], "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:\\Python\\lib\\site-packages\\AppiumLibrary\\keywords\\_element.py", "lineno": 142}, {"name": "Page Should Not Contain Text", "args": [{"name": "text", "types": [], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "text"}, {"name": "loglevel", "types": [], "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:\\Python\\lib\\site-packages\\AppiumLibrary\\keywords\\_element.py", "lineno": 117}, {"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:\\Python\\lib\\site-packages\\AppiumLibrary\\keywords\\_applicationmanagement.py", "lineno": 110}, {"name": "Register Keyword To Run On Failure", "args": [{"name": "keyword", "types": [], "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:\\Python\\lib\\site-packages\\AppiumLibrary\\keywords\\_runonfailure.py", "lineno": 17}, {"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-zoomba\\src\\Zoomba\\DesktopLibrary.py", "lineno": 710}, {"name": "Scroll", "args": [{"name": "x_offset", "types": [], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "x_offset"}, {"name": "y_offset", "types": [], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "y_offset"}], "doc": "<p>Scrolls from current position.</p>\n<p><code>x_offset</code> is the X offset to scroll to.</p>\n<p><code>y_offset</code> is the Y offset to scroll to.</p>", "shortdoc": "Scrolls from current position.", "tags": [], "source": "C:\\Git\\robotframework-zoomba\\src\\Zoomba\\DesktopLibrary.py", "lineno": 896}, {"name": "Scroll From Element", "args": [{"name": "locator", "types": [], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "locator"}, {"name": "x_offset", "types": [], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "x_offset"}, {"name": "y_offset", "types": [], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "y_offset"}], "doc": "<p>Scrolls starting from <code>locator</code>.</p>\n<p><code>x_offset</code> is the X offset to scroll to.</p>\n<p><code>y_offset</code> is the Y offset to scroll to.</p>", "shortdoc": "Scrolls starting from ``locator``.", "tags": [], "source": "C:\\Git\\robotframework-zoomba\\src\\Zoomba\\DesktopLibrary.py", "lineno": 906}, {"name": "Select Element From ComboBox", "args": [{"name": "list_locator", "types": [], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "list_locator"}, {"name": "element_locator", "types": [], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "element_locator"}, {"name": "skip_to_desktop", "types": [], "defaultValue": "False", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "skip_to_desktop=False"}], "doc": "<p>Selects the <code>element_locator</code> from the combobox found by <code>list_locator</code>.</p>\n<p>The keyword first checks the current application for the combobox list elements. If it is not found it will switch to the desktop session to look for the elements as many windows applications house the actual combobox items in a pane off of the desktop. <code>skip_to_desktop</code> can be set to <code>True</code> in order to go straight to the desktop session. This provides good time savings when dealing with a large application.</p>", "shortdoc": "Selects the ``element_locator`` from the combobox found by ``list_locator``.", "tags": [], "source": "C:\\Git\\robotframework-zoomba\\src\\Zoomba\\DesktopLibrary.py", "lineno": 716}, {"name": "Select Elements From Context Menu", "args": [{"name": "args", "types": [], "defaultValue": null, "kind": "VAR_POSITIONAL", "required": false, "repr": "*args"}], "doc": "<p>Context clicks the first element and then selects N number of elements (given as locators) in the order they are given. This is useful for working though a nested context menu listing of elements.</p>\n<p>On failure this keyword will attempt to select the elements from the desktop session due to the nature of some pop-out menus in Windows.</p>", "shortdoc": "Context clicks the first element and then selects N number of elements (given as locators) in the order they are given. This is useful for working though a nested context menu listing of elements.", "tags": [], "source": "C:\\Git\\robotframework-zoomba\\src\\Zoomba\\DesktopLibrary.py", "lineno": 768}, {"name": "Select Elements From Menu", "args": [{"name": "args", "types": [], "defaultValue": null, "kind": "VAR_POSITIONAL", "required": false, "repr": "*args"}], "doc": "<p>Selects N number of elements (given as locators) in the order they are given. This is useful for working though a nested menu listing of elements.</p>\n<p>On failure this keyword will attempt to select the elements from the desktop session due to the nature of some pop-out menus in Windows.</p>", "shortdoc": "Selects N number of elements (given as locators) in the order they are given. This is useful for working though a nested menu listing of elements.", "tags": [], "source": "C:\\Git\\robotframework-zoomba\\src\\Zoomba\\DesktopLibrary.py", "lineno": 744}, {"name": "Send Keys", "args": [{"name": "argv", "types": [], "defaultValue": null, "kind": "VAR_POSITIONAL", "required": false, "repr": "*argv"}], "doc": "<p>Sends the desired keys in <code>argv</code>.</p>\n<p>A list of special key codes can be found <a href=\"https://seleniumhq.github.io/selenium/docs/api/py/webdriver/selenium.webdriver.common.keys.html\">here</a></p>\n<p>Note that when sending in a modifier key (Ctrl, Alt, Shift) you will need to send the key again to release it.</p>\n<table border=\"1\">\n<tr>\n<td>Send Keys</td>\n<td>a</td>\n<td>b</td>\n<td></td>\n</tr>\n<tr>\n<td>Send Keys</td>\n<td>\\ue00</td>\n<td>p</td>\n<td>\\ue00</td>\n</tr>\n</table>", "shortdoc": "Sends the desired keys in ``argv``.", "tags": [], "source": "C:\\Git\\robotframework-zoomba\\src\\Zoomba\\DesktopLibrary.py", "lineno": 649}, {"name": "Send Keys To Element", "args": [{"name": "locator", "types": [], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "locator"}, {"name": "argv", "types": [], "defaultValue": null, "kind": "VAR_POSITIONAL", "required": false, "repr": "*argv"}], "doc": "<p>Sends the desired keys in <code>argv</code> to <code>locator</code>.</p>\n<p>A list of special key codes can be found <a href=\"https://seleniumhq.github.io/selenium/docs/api/py/webdriver/selenium.webdriver.common.keys.html\">here</a></p>\n<p>Note that when sending in a modifier key (Ctrl, Alt, Shift) you will need to send the key again to release it.</p>\n<table border=\"1\">\n<tr>\n<td>Send Keys To Element</td>\n<td>locator</td>\n<td>a</td>\n<td>b</td>\n<td></td>\n</tr>\n<tr>\n<td>Send Keys To Element</td>\n<td>locator</td>\n<td>\\ue00</td>\n<td>p</td>\n<td>\\ue00</td>\n</tr>\n</table>", "shortdoc": "Sends the desired keys in ``argv`` to ``locator``.", "tags": [], "source": "C:\\Git\\robotframework-zoomba\\src\\Zoomba\\DesktopLibrary.py", "lineno": 670}, {"name": "Set Appium Timeout", "args": [{"name": "seconds", "types": [], "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:\\Python\\lib\\site-packages\\AppiumLibrary\\keywords\\_applicationmanagement.py", "lineno": 143}, {"name": "Start Screen Recording", "args": [{"name": "time_limit", "types": [], "defaultValue": "180s", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "time_limit=180s"}, {"name": "options", "types": [], "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 (defaulting to 180 seconds).</p>\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.</p>\n<p>Keyword requires Appium to be used.</p>\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": "Starts an asynchronous Screen Recording for the current open application.", "tags": [], "source": "C:\\Git\\robotframework-zoomba\\src\\Zoomba\\DesktopLibrary.py", "lineno": 157}, {"name": "Stop Screen Recording", "args": [{"name": "filename", "types": [], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "filename=None"}, {"name": "options", "types": [], "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>Keyword requires Appium to be used.</p>\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-zoomba\\src\\Zoomba\\DesktopLibrary.py", "lineno": 178}, {"name": "Switch Application", "args": [{"name": "index_or_alias", "types": [], "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:\\Python\\lib\\site-packages\\AppiumLibrary\\keywords\\_applicationmanagement.py", "lineno": 58}, {"name": "Switch Application By Name", "args": [{"name": "remote_url", "types": [], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "remote_url"}, {"name": "window_name", "types": [], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "window_name"}, {"name": "alias", "types": [], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "alias=None"}, {"name": "timeout", "types": [], "defaultValue": "5", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "timeout=5"}, {"name": "exact_match", "types": [], "defaultValue": "True", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "exact_match=True"}, {"name": "kwargs", "types": [], "defaultValue": null, "kind": "VAR_NAMED", "required": false, "repr": "**kwargs"}], "doc": "<p>Switches to a currently opened window by <code>window_name</code>. For the capabilities of appium server and Windows, Please check <a href=\"http://appium.io/docs/en/drivers/windows\">http://appium.io/docs/en/drivers/windows</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>window_name</td>\n<td>Yes</td>\n<td>Window name you wish to attach</td>\n</tr>\n<tr>\n<td>alias</td>\n<td>No</td>\n<td>alias</td>\n</tr>\n<tr>\n<td>timeout</td>\n<td>No</td>\n<td>timeout to connect</td>\n</tr>\n<tr>\n<td>exact_match</td>\n<td>No</td>\n<td>Set to False if window_name does not need to match exactly</td>\n</tr>\n</table>\n<p>Examples:</p>\n<table border=\"1\">\n<tr>\n<td>Switch Application By Name</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=Windows</td>\n<td>deviceName=Windows</td>\n<td>window_name=MyApplication</td>\n</tr>\n<tr>\n<td>Switch Application By Name</td>\n<td><a href=\"http://localhost:4723/wd/hub\">http://localhost:4723/wd/hub</a></td>\n<td>window_name=MyApp</td>\n<td>exact_match=False</td>\n<td></td>\n<td></td>\n</tr>\n</table>\n<p>A session for the root desktop will also be opened and can be switched to by running the following:</p>\n<table border=\"1\">\n<tr>\n<td>Switch Application</td>\n<td>Desktop</td>\n</tr>\n</table>", "shortdoc": "Switches to a currently opened window by ``window_name``. For the capabilities of appium server and Windows, Please check http://appium.io/docs/en/drivers/windows | *Option*            | *Man.* | *Description*                         | | remote_url          | Yes    | Appium server url                     | | window_name         | Yes    | Window name you wish to attach        | | alias               | No     | alias                                 | | timeout             | No     | timeout to connect                    | | exact_match         | No     | Set to False if window_name does not need to match exactly       |", "tags": [], "source": "C:\\Git\\robotframework-zoomba\\src\\Zoomba\\DesktopLibrary.py", "lineno": 298}, {"name": "Tap", "args": [{"name": "locator", "types": [], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "locator"}, {"name": "x_offset", "types": [], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "x_offset=None"}, {"name": "y_offset", "types": [], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "y_offset=None"}, {"name": "count", "types": [], "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:\\Python\\lib\\site-packages\\AppiumLibrary\\keywords\\_touch.py", "lineno": 119}, {"name": "Text Should Be Visible", "args": [{"name": "text", "types": [], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "text"}, {"name": "exact_match", "types": [], "defaultValue": "False", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "exact_match=False"}, {"name": "loglevel", "types": [], "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:\\Python\\lib\\site-packages\\AppiumLibrary\\keywords\\_element.py", "lineno": 440}, {"name": "Wait For And Clear Text", "args": [{"name": "locator", "types": [], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "locator"}, {"name": "timeout", "types": [], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "timeout=None"}, {"name": "error", "types": [], "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-zoomba\\src\\Zoomba\\DesktopLibrary.py", "lineno": 388}, {"name": "Wait For And Click Element", "args": [{"name": "locator", "types": [], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "locator"}, {"name": "timeout", "types": [], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "timeout=None"}, {"name": "error", "types": [], "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>\n<p>Use <a href=\"#Wait%20For%20And%20Mouse%20Over%20And%20Click%20Element\" class=\"name\">Wait For And Mouse Over And Click Element</a> if this keyword gives issues in the application.</p>", "shortdoc": "Wait for and click the element identified by ``locator``.", "tags": [], "source": "C:\\Git\\robotframework-zoomba\\src\\Zoomba\\DesktopLibrary.py", "lineno": 413}, {"name": "Wait For And Double Tap", "args": [{"name": "locator", "types": [], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "locator"}, {"name": "timeout", "types": [], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "timeout=None"}, {"name": "error", "types": [], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "error=None"}], "doc": "<p>Wait for and double tap 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 double tap the element identified by ``locator``.", "tags": [], "source": "C:\\Git\\robotframework-zoomba\\src\\Zoomba\\DesktopLibrary.py", "lineno": 848}, {"name": "Wait For And Flick From Element", "args": [{"name": "locator", "types": [], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "locator"}, {"name": "x_offset", "types": [], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "x_offset"}, {"name": "y_offset", "types": [], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "y_offset"}, {"name": "speed", "types": [], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "speed"}, {"name": "timeout", "types": [], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "timeout=None"}, {"name": "error", "types": [], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "error=None"}], "doc": "<p>Wait for and flick from 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 flick from element identified by ``locator``.", "tags": [], "source": "C:\\Git\\robotframework-zoomba\\src\\Zoomba\\DesktopLibrary.py", "lineno": 883}, {"name": "Wait For And Input Password", "args": [{"name": "locator", "types": [], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "locator"}, {"name": "text", "types": [], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "text"}, {"name": "timeout", "types": [], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "timeout=None"}, {"name": "error", "types": [], "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-zoomba\\src\\Zoomba\\DesktopLibrary.py", "lineno": 429}, {"name": "Wait For And Input Text", "args": [{"name": "locator", "types": [], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "locator"}, {"name": "text", "types": [], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "text"}, {"name": "timeout", "types": [], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "timeout=None"}, {"name": "error", "types": [], "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-zoomba\\src\\Zoomba\\DesktopLibrary.py", "lineno": 443}, {"name": "Wait For And Long Press", "args": [{"name": "locator", "types": [], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "locator"}, {"name": "duration", "types": [], "defaultValue": "10000", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "duration=10000"}, {"name": "timeout", "types": [], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "timeout=None"}, {"name": "error", "types": [], "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-zoomba\\src\\Zoomba\\DesktopLibrary.py", "lineno": 456}, {"name": "Wait For And Mouse Over And Click Element", "args": [{"name": "locator", "types": [], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "locator"}, {"name": "timeout", "types": [], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "timeout=None"}, {"name": "error", "types": [], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "error=None"}, {"name": "double_click", "types": [], "defaultValue": "False", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "double_click=False"}, {"name": "x_offset", "types": [], "defaultValue": "0", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "x_offset=0"}, {"name": "y_offset", "types": [], "defaultValue": "0", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "y_offset=0"}], "doc": "<p>Waits for, moves the mouse over, and clicks the given <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><code>double_click</code> can be used to click twice.</p>\n<p><code>x_offset</code> and <code>y_offset</code> can be used to move to a specific coordinate.</p>", "shortdoc": "Waits for, moves the mouse over, and clicks the given ``locator``.", "tags": [], "source": "C:\\Git\\robotframework-zoomba\\src\\Zoomba\\DesktopLibrary.py", "lineno": 585}, {"name": "Wait For And Mouse Over Element", "args": [{"name": "locator", "types": [], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "locator"}, {"name": "timeout", "types": [], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "timeout=None"}, {"name": "error", "types": [], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "error=None"}, {"name": "x_offset", "types": [], "defaultValue": "0", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "x_offset=0"}, {"name": "y_offset", "types": [], "defaultValue": "0", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "y_offset=0"}], "doc": "<p>Waits for and moves the mouse over the given <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><code>x_offset</code> and <code>y_offset</code> can be used to move to a specific coordinate.</p>", "shortdoc": "Waits for and moves the mouse over the given ``locator``.", "tags": [], "source": "C:\\Git\\robotframework-zoomba\\src\\Zoomba\\DesktopLibrary.py", "lineno": 552}, {"name": "Wait For And Scroll From Element", "args": [{"name": "locator", "types": [], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "locator"}, {"name": "x_offset", "types": [], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "x_offset"}, {"name": "y_offset", "types": [], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "y_offset"}, {"name": "timeout", "types": [], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "timeout=None"}, {"name": "error", "types": [], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "error=None"}], "doc": "<p>Wait for and scroll from 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 scroll from element identified by ``locator``.", "tags": [], "source": "C:\\Git\\robotframework-zoomba\\src\\Zoomba\\DesktopLibrary.py", "lineno": 917}, {"name": "Wait For And Tap", "args": [{"name": "locator", "types": [], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "locator"}, {"name": "timeout", "types": [], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "timeout=None"}, {"name": "error", "types": [], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "error=None"}], "doc": "<p>Wait for and tap 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 tap the element identified by ``locator``.", "tags": [], "source": "C:\\Git\\robotframework-zoomba\\src\\Zoomba\\DesktopLibrary.py", "lineno": 834}, {"name": "Wait Until Element Contains", "args": [{"name": "locator", "types": [], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "locator"}, {"name": "text", "types": [], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "text"}, {"name": "timeout", "types": [], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "timeout=None"}, {"name": "error", "types": [], "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-zoomba\\src\\Zoomba\\DesktopLibrary.py", "lineno": 469}, {"name": "Wait Until Element Does Not Contain", "args": [{"name": "locator", "types": [], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "locator"}, {"name": "text", "types": [], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "text"}, {"name": "timeout", "types": [], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "timeout=None"}, {"name": "error", "types": [], "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-zoomba\\src\\Zoomba\\DesktopLibrary.py", "lineno": 484}, {"name": "Wait Until Element Is Disabled", "args": [{"name": "locator", "types": [], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "locator"}, {"name": "timeout", "types": [], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "timeout=None"}, {"name": "error", "types": [], "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%20Enabled\" class=\"name\">Wait Until Element Is Enabled</a></p>", "shortdoc": "Waits until element specified with ``locator`` is disabled.", "tags": [], "source": "C:\\Git\\robotframework-zoomba\\src\\Zoomba\\DesktopLibrary.py", "lineno": 530}, {"name": "Wait Until Element Is Enabled", "args": [{"name": "locator", "types": [], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "locator"}, {"name": "timeout", "types": [], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "timeout=None"}, {"name": "error", "types": [], "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-zoomba\\src\\Zoomba\\DesktopLibrary.py", "lineno": 509}, {"name": "Wait Until Element Is Visible", "args": [{"name": "locator", "types": [], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "locator"}, {"name": "timeout", "types": [], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "timeout=None"}, {"name": "error", "types": [], "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:\\Python\\lib\\site-packages\\AppiumLibrary\\keywords\\_waiting.py", "lineno": 7}, {"name": "Wait Until Page Contains", "args": [{"name": "text", "types": [], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "text"}, {"name": "timeout", "types": [], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "timeout=None"}, {"name": "error", "types": [], "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:\\Python\\lib\\site-packages\\AppiumLibrary\\keywords\\_waiting.py", "lineno": 30}, {"name": "Wait Until Page Contains Element", "args": [{"name": "locator", "types": [], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "locator"}, {"name": "timeout", "types": [], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "timeout=None"}, {"name": "error", "types": [], "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:\\Python\\lib\\site-packages\\AppiumLibrary\\keywords\\_waiting.py", "lineno": 72}, {"name": "Wait Until Page Does Not Contain", "args": [{"name": "text", "types": [], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "text"}, {"name": "timeout", "types": [], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "timeout=None"}, {"name": "error", "types": [], "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:\\Python\\lib\\site-packages\\AppiumLibrary\\keywords\\_waiting.py", "lineno": 48}, {"name": "Wait Until Page Does Not Contain Element", "args": [{"name": "locator", "types": [], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "locator"}, {"name": "timeout", "types": [], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "timeout=None"}, {"name": "error", "types": [], "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:\\Python\\lib\\site-packages\\AppiumLibrary\\keywords\\_waiting.py", "lineno": 90}, {"name": "Xpath Should Match X Times", "args": [{"name": "xpath", "types": [], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "xpath"}, {"name": "count", "types": [], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "count"}, {"name": "error", "types": [], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "error=None"}, {"name": "loglevel", "types": [], "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:\\Python\\lib\\site-packages\\AppiumLibrary\\keywords\\_element.py", "lineno": 450}], "dataTypes": {"enums": [], "typedDicts": []}}
+libdoc = {"name": "Desktop_Library", "doc": "<p>Zoomba Desktop Library</p>\n<p>This class is the base Library used to generate automated Desktop 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 DesktopLibrary that need to find an element on the page take a locator argument. To find these locators we use <b>*Accessibility Insights*</b> to inspect the application under test. This tool allows you to see every UI element/node that you can interact with using DesktopLibrary. <b>*Accessibility Insights*</b> can be downloaded at <a href=\"https://accessibilityinsights.io/\">https://accessibilityinsights.io/</a> The tool will show various element attributes. The table below shows you witch locator strategy you should use to find elements with the corresponding attributes.</p>\n<p>To locate xpath we suggest using the <b>*WinAppDriver UI Recorder*</b> located here: <a href=\"https://github.com/Microsoft/WinAppDriver/releases\">https://github.com/Microsoft/WinAppDriver/releases</a></p>\n<table border=\"1\">\n<tr>\n<td><b>Locator Strategy</b></td>\n<td><b>Matched Attribute in Insights</b></td>\n<td><b>Example</b></td>\n</tr>\n<tr>\n<td>accessibility_id</td>\n<td>AutomationId</td>\n<td>Click Element <span class=\"name\">|</span> accessibility_id=my_element_id</td>\n</tr>\n<tr>\n<td>class</td>\n<td>ClassName</td>\n<td>Click Element <span class=\"name\">|</span> class=UIAPickerWheel</td>\n</tr>\n<tr>\n<td>name</td>\n<td>Name</td>\n<td>Click Element <span class=\"name\">|</span> name=my_element</td>\n</tr>\n<tr>\n<td>xpath</td>\n<td>N/A</td>\n<td>Click Element <span class=\"name\">|</span> xpath=//Button[@Name=\"Close\"]</td>\n</tr>\n<tr>\n<td>image</td>\n<td>N/A</td>\n<td>Click Element <span class=\"name\">|</span> image=file.png</td>\n</tr>\n</table>\n<p>The <code>image</code> locator strategy can only be used with Appium v1.18.0 or higher.</p>\n<p>Example tests using the windows calculator are located in the tests directory.</p>\n<h2 id=\"Use of Wait Keywords\">Use of Wait Keywords</h2>\n<p>When using a modern Windows application there should be no issue with using the 'Wait For And' keywords. However if you are using an older WinForm, Win32, or a larger application it may be necessary to simply use the non-waiting version of keywords. Then you would simply add your waits in manually where necessary using something like <code>Wait Until Page Contains</code> or <code>Wait Until Page Contains Element</code>.</p>", "version": "2.9.1", "generated": "2021-05-14 11:20:39", "type": "LIBRARY", "scope": "GLOBAL", "docFormat": "HTML", "source": "C:\\Git\\robotframework-zoomba\\src\\Zoomba\\DesktopLibrary.py", "lineno": 55, "tags": [], "inits": [{"name": "Init", "args": [{"name": "timeout", "types": [], "defaultValue": "5", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "timeout=5"}, {"name": "run_on_failure", "types": [], "defaultValue": "Save Appium Screenshot", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "run_on_failure=Save Appium Screenshot"}, {"name": "driver_path", "types": [], "defaultValue": "C:\\\\Program Files (x86)\\\\Windows Application Driver\\\\WinAppDriver.exe", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "driver_path=C:\\\\Program Files (x86)\\\\Windows Application Driver\\\\WinAppDriver.exe"}], "doc": "<p>DesktopLibrary can be imported with optional arguments.</p>\n<p><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>.</p>\n<p><code>run_on_failure</code> specifies the name of a keyword (from any available libraries) to execute when a DesktopLibrary 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 <code>No Operation</code> 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.</p>\n<p><code>driver_path</code> is the path to the WinAppDriver.exe file.</p>\n<p>Examples:</p>\n<table border=\"1\">\n<tr>\n<td>Library</td>\n<td>DesktopLibrary</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>DesktopLibrary</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<tr>\n<td>Library</td>\n<td>DesktopLibrary</td>\n<td>timeout=10</td>\n<td>driver_path=\"C:/WinAppDriver.exe\"</td>\n<td># Sets a new path for the WinAppDriver</td>\n</tr>\n</table>", "shortdoc": "DesktopLibrary can be imported with optional arguments.", "tags": [], "source": "C:\\Git\\robotframework-zoomba\\src\\Zoomba\\DesktopLibrary.py", "lineno": 91}], "keywords": [{"name": "Capture Page Screenshot", "args": [{"name": "filename", "types": [], "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 background 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-zoomba\\src\\Zoomba\\DesktopLibrary.py", "lineno": 691}, {"name": "Clear Text", "args": [{"name": "locator", "types": [], "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:\\Python\\lib\\site-packages\\AppiumLibrary\\keywords\\_element.py", "lineno": 27}, {"name": "Click A Point", "args": [{"name": "x_offset", "types": [], "defaultValue": "0", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "x_offset=0"}, {"name": "y_offset", "types": [], "defaultValue": "0", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "y_offset=0"}, {"name": "double_click", "types": [], "defaultValue": "False", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "double_click=False"}], "doc": "<p>Clicks the current mouse location.</p>\n<p><code>x_offset</code> and <code>y_offset</code> can be applied to give an offset.</p>\n<p><code>double_click</code> can be used to click twice.</p>", "shortdoc": "Clicks the current mouse location.", "tags": [], "source": "C:\\Git\\robotframework-zoomba\\src\\Zoomba\\DesktopLibrary.py", "lineno": 608}, {"name": "Click Button", "args": [{"name": "index_or_name", "types": [], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "index_or_name"}], "doc": "<p>Click button</p>", "shortdoc": "Click button", "tags": [], "source": "C:\\Python\\lib\\site-packages\\AppiumLibrary\\keywords\\_element.py", "lineno": 44}, {"name": "Click Element", "args": [{"name": "locator", "types": [], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "locator"}], "doc": "<p>Click element identified by <span class=\"name\">locator</span>.</p>\n<p>Supported prefixes: <code>accessibility_id</code>, <code>name</code>, <code>class</code>, <code>xpath</code>, and <code>image</code></p>\n<p>The <code>image</code> locator strategy can only be used with Appium v1.18.0 and newer.</p>\n<p>If no prefix is given <code>click element</code> defaults to <code>accessibility_id</code> or <code>xpath</code></p>", "shortdoc": "Click element identified by `locator`.", "tags": [], "source": "C:\\Git\\robotframework-zoomba\\src\\Zoomba\\DesktopLibrary.py", "lineno": 400}, {"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:\\Python\\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:\\Python\\lib\\site-packages\\AppiumLibrary\\keywords\\_applicationmanagement.py", "lineno": 20}, {"name": "Context Click A Point", "args": [{"name": "x_offset", "types": [], "defaultValue": "0", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "x_offset=0"}, {"name": "y_offset", "types": [], "defaultValue": "0", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "y_offset=0"}], "doc": "<p>Right-clicks the current mouse location.</p>\n<p><code>x_offset</code> and <code>y_offset</code> can be applied to give an offset.</p>", "shortdoc": "Right-clicks the current mouse location.", "tags": [], "source": "C:\\Git\\robotframework-zoomba\\src\\Zoomba\\DesktopLibrary.py", "lineno": 625}, {"name": "Double Tap", "args": [{"name": "locator", "types": [], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "locator"}], "doc": "<p>Double tap element identified by <code>locator</code>.</p>", "shortdoc": "Double tap element identified by ``locator``.", "tags": [], "source": "C:\\Git\\robotframework-zoomba\\src\\Zoomba\\DesktopLibrary.py", "lineno": 826}, {"name": "Drag And Drop", "args": [{"name": "source", "types": [], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "source"}, {"name": "target", "types": [], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "target"}], "doc": "<p>Drags the element found with the locator <code>source</code> to the element found with the locator <code>target</code>.</p>", "shortdoc": "Drags the element found with the locator ``source`` to the element found with the locator ``target``.", "tags": [], "source": "C:\\Git\\robotframework-zoomba\\src\\Zoomba\\DesktopLibrary.py", "lineno": 637}, {"name": "Drag And Drop By Offset", "args": [{"name": "locator", "types": [], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "locator"}, {"name": "x_offset", "types": [], "defaultValue": "0", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "x_offset=0"}, {"name": "y_offset", "types": [], "defaultValue": "0", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "y_offset=0"}], "doc": "<p>Drags the element found with <code>locator</code> to the given <code>x_offset</code> and <code>y_offset</code> coordinates.</p>", "shortdoc": "Drags the element found with ``locator`` to the given ``x_offset`` and ``y_offset`` coordinates.", "tags": [], "source": "C:\\Git\\robotframework-zoomba\\src\\Zoomba\\DesktopLibrary.py", "lineno": 643}, {"name": "Drag And Drop by Touch", "args": [{"name": "source", "types": [], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "source"}, {"name": "target", "types": [], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "target"}], "doc": "<p>Drags the element found with the locator <code>source</code> to the element found with the locator <code>target</code> using touch actions.</p>", "shortdoc": "Drags the element found with the locator ``source`` to the element found with the locator ``target`` using touch actions.", "tags": [], "source": "C:\\Git\\robotframework-zoomba\\src\\Zoomba\\DesktopLibrary.py", "lineno": 803}, {"name": "Drag And Drop by Touch Offset", "args": [{"name": "locator", "types": [], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "locator"}, {"name": "x_offset", "types": [], "defaultValue": "0", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "x_offset=0"}, {"name": "y_offset", "types": [], "defaultValue": "0", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "y_offset=0"}], "doc": "<p>Drags the element found with <code>locator </code> to the given <code>x_offset</code> and <code>y_offset</code> coordinates using touch actions.</p>", "shortdoc": "Drags the element found with ``locator `` to the given ``x_offset`` and ``y_offset`` coordinates using touch actions.", "tags": [], "source": "C:\\Git\\robotframework-zoomba\\src\\Zoomba\\DesktopLibrary.py", "lineno": 816}, {"name": "Driver Setup", "args": [{"name": "path", "types": [], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "path=None"}], "doc": "<p>Starts the WinAppDriver.</p>\n<p><code>path</code> can be provided if your winappdriver installation is not in the default path of <code>C:/Program Files (x86)/Windows Application Driver/WinAppDriver.exe</code>.</p>\n<p>Not to be used with Appium.</p>", "shortdoc": "Starts the WinAppDriver.", "tags": [], "source": "C:\\Git\\robotframework-zoomba\\src\\Zoomba\\DesktopLibrary.py", "lineno": 229}, {"name": "Driver Teardown", "args": [], "doc": "<p>Stops the WinAppDriver.</p>\n<p>Not to be used with Appium.</p>", "shortdoc": "Stops the WinAppDriver.", "tags": [], "source": "C:\\Git\\robotframework-zoomba\\src\\Zoomba\\DesktopLibrary.py", "lineno": 239}, {"name": "Element Attribute Should Match", "args": [{"name": "locator", "types": [], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "locator"}, {"name": "attr_name", "types": [], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "attr_name"}, {"name": "match_pattern", "types": [], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "match_pattern"}, {"name": "regexp", "types": [], "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:\\Python\\lib\\site-packages\\AppiumLibrary\\keywords\\_element.py", "lineno": 205}, {"name": "Element Should Be Disabled", "args": [{"name": "locator", "types": [], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "locator"}, {"name": "loglevel", "types": [], "defaultValue": "INFO", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "loglevel=INFO"}], "doc": "<p>Verifies that element identified with locator is disabled.</p>", "shortdoc": "Verifies that element identified with locator is disabled.", "tags": [], "source": "C:\\Git\\robotframework-zoomba\\src\\Zoomba\\DesktopLibrary.py", "lineno": 521}, {"name": "Element Should Be Enabled", "args": [{"name": "locator", "types": [], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "locator"}, {"name": "loglevel", "types": [], "defaultValue": "INFO", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "loglevel=INFO"}], "doc": "<p>Verifies that element identified with locator is enabled.</p>", "shortdoc": "Verifies that element identified with locator is enabled.", "tags": [], "source": "C:\\Git\\robotframework-zoomba\\src\\Zoomba\\DesktopLibrary.py", "lineno": 500}, {"name": "Element Should Be Visible", "args": [{"name": "locator", "types": [], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "locator"}, {"name": "loglevel", "types": [], "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:\\Python\\lib\\site-packages\\AppiumLibrary\\keywords\\_element.py", "lineno": 178}, {"name": "Element Should Contain Text", "args": [{"name": "locator", "types": [], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "locator"}, {"name": "expected", "types": [], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "expected"}, {"name": "message", "types": [], "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:\\Python\\lib\\site-packages\\AppiumLibrary\\keywords\\_element.py", "lineno": 285}, {"name": "Element Should Not Contain Text", "args": [{"name": "locator", "types": [], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "locator"}, {"name": "expected", "types": [], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "expected"}, {"name": "message", "types": [], "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:\\Python\\lib\\site-packages\\AppiumLibrary\\keywords\\_element.py", "lineno": 304}, {"name": "Element Text Should Be", "args": [{"name": "locator", "types": [], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "locator"}, {"name": "expected", "types": [], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "expected"}, {"name": "message", "types": [], "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:\\Python\\lib\\site-packages\\AppiumLibrary\\keywords\\_element.py", "lineno": 319}, {"name": "Flick", "args": [{"name": "x_speed", "types": [], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "x_speed"}, {"name": "y_speed", "types": [], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "y_speed"}], "doc": "<p>Flicks from current position.</p>\n<p><code>x_speed</code> is the X speed in pixels per second.</p>\n<p><code>y_speed</code> is the Y speed in pixels per second.</p>", "shortdoc": "Flicks from current position.", "tags": [], "source": "C:\\Git\\robotframework-zoomba\\src\\Zoomba\\DesktopLibrary.py", "lineno": 860}, {"name": "Flick From Element", "args": [{"name": "locator", "types": [], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "locator"}, {"name": "x_offset", "types": [], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "x_offset"}, {"name": "y_offset", "types": [], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "y_offset"}, {"name": "speed", "types": [], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "speed"}], "doc": "<p>Flicks starting at <code>locator</code>.</p>\n<p><code>x_offset</code> is X offset to flick to.</p>\n<p><code>y_offset</code> is Y offset to flick to.</p>\n<p><code>speed</code> is Pixels per second to flick.</p>", "shortdoc": "Flicks starting at ``locator``.", "tags": [], "source": "C:\\Git\\robotframework-zoomba\\src\\Zoomba\\DesktopLibrary.py", "lineno": 870}, {"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:\\Python\\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:\\Python\\lib\\site-packages\\AppiumLibrary\\keywords\\_applicationmanagement.py", "lineno": 137}, {"name": "Get Capability", "args": [{"name": "capability_name", "types": [], "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:\\Python\\lib\\site-packages\\AppiumLibrary\\keywords\\_applicationmanagement.py", "lineno": 335}, {"name": "Get Element Attribute", "args": [{"name": "locator", "types": [], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "locator"}, {"name": "attribute", "types": [], "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:\\Python\\lib\\site-packages\\AppiumLibrary\\keywords\\_element.py", "lineno": 365}, {"name": "Get Element Location", "args": [{"name": "locator", "types": [], "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:\\Python\\lib\\site-packages\\AppiumLibrary\\keywords\\_element.py", "lineno": 387}, {"name": "Get Element Size", "args": [{"name": "locator", "types": [], "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:\\Python\\lib\\site-packages\\AppiumLibrary\\keywords\\_element.py", "lineno": 398}, {"name": "Get Matching Xpath Count", "args": [{"name": "xpath", "types": [], "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:\\Python\\lib\\site-packages\\AppiumLibrary\\keywords\\_element.py", "lineno": 422}, {"name": "Get Webelement", "args": [{"name": "locator", "types": [], "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:\\Python\\lib\\site-packages\\AppiumLibrary\\keywords\\_element.py", "lineno": 339}, {"name": "Get Webelements", "args": [{"name": "locator", "types": [], "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:\\Python\\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:\\Python\\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:\\Python\\lib\\site-packages\\AppiumLibrary\\keywords\\_applicationmanagement.py", "lineno": 309}, {"name": "Input Password", "args": [{"name": "locator", "types": [], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "locator"}, {"name": "text", "types": [], "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:\\Python\\lib\\site-packages\\AppiumLibrary\\keywords\\_element.py", "lineno": 72}, {"name": "Input Text", "args": [{"name": "locator", "types": [], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "locator"}, {"name": "text", "types": [], "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:\\Python\\lib\\site-packages\\AppiumLibrary\\keywords\\_element.py", "lineno": 64}, {"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\">http://localhost:4723</a></td>\n<td>platformName=Windows</td>\n<td>deviceName=Windows</td>\n<td>app=${App_Path}</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 session running.</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-zoomba\\src\\Zoomba\\DesktopLibrary.py", "lineno": 362}, {"name": "Log Source", "args": [{"name": "loglevel", "types": [], "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:\\Python\\lib\\site-packages\\AppiumLibrary\\keywords\\_applicationmanagement.py", "lineno": 172}, {"name": "Long Press", "args": [{"name": "locator", "types": [], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "locator"}, {"name": "duration", "types": [], "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:\\Python\\lib\\site-packages\\AppiumLibrary\\keywords\\_touch.py", "lineno": 112}, {"name": "Maximize Window", "args": [], "doc": "<p>Maximizes the current application window.</p>", "shortdoc": "Maximizes the current application window.", "tags": [], "source": "C:\\Git\\robotframework-zoomba\\src\\Zoomba\\DesktopLibrary.py", "lineno": 247}, {"name": "Mouse Over And Click Element", "args": [{"name": "locator", "types": [], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "locator"}, {"name": "double_click", "types": [], "defaultValue": "False", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "double_click=False"}, {"name": "x_offset", "types": [], "defaultValue": "0", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "x_offset=0"}, {"name": "y_offset", "types": [], "defaultValue": "0", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "y_offset=0"}], "doc": "<p>Moves the mouse over and clicks the given <code>locator</code>.</p>\n<p><code>double_click</code> can be used to click twice.</p>\n<p><code>x_offset</code> and <code>y_offset</code> can be used to move to a specific coordinate.</p>", "shortdoc": "Moves the mouse over and clicks the given ``locator``.", "tags": [], "source": "C:\\Git\\robotframework-zoomba\\src\\Zoomba\\DesktopLibrary.py", "lineno": 565}, {"name": "Mouse Over And Context Click Element", "args": [{"name": "locator", "types": [], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "locator"}, {"name": "x_offset", "types": [], "defaultValue": "0", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "x_offset=0"}, {"name": "y_offset", "types": [], "defaultValue": "0", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "y_offset=0"}], "doc": "<p>Moves the mouse over and right-clicks the given <code>locator</code>.</p>\n<p><code>x_offset</code> and <code>y_offset</code> can be used to move to a specific coordinate.</p>\n<p>See also <a href=\"#Mouse%20Over%20And%20Click%20Element\" class=\"name\">Mouse Over And Click Element</a></p>", "shortdoc": "Moves the mouse over and right-clicks the given ``locator``.", "tags": [], "source": "C:\\Git\\robotframework-zoomba\\src\\Zoomba\\DesktopLibrary.py", "lineno": 575}, {"name": "Mouse Over By Offset", "args": [{"name": "x_offset", "types": [], "defaultValue": "0", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "x_offset=0"}, {"name": "y_offset", "types": [], "defaultValue": "0", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "y_offset=0"}], "doc": "<p>Moves the mouse from its current location by the given <code>x_offset</code> and <code>y_offset</code>.</p>", "shortdoc": "Moves the mouse from its current location by the given ``x_offset`` and ``y_offset``.", "tags": [], "source": "C:\\Git\\robotframework-zoomba\\src\\Zoomba\\DesktopLibrary.py", "lineno": 600}, {"name": "Mouse Over Element", "args": [{"name": "locator", "types": [], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "locator"}, {"name": "x_offset", "types": [], "defaultValue": "0", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "x_offset=0"}, {"name": "y_offset", "types": [], "defaultValue": "0", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "y_offset=0"}], "doc": "<p>Moves the mouse over the given <code>locator</code>.</p>\n<p><code>x_offset</code> and <code>y_offset</code> can be used to move to a specific coordinate.</p>", "shortdoc": "Moves the mouse over the given ``locator``.", "tags": [], "source": "C:\\Git\\robotframework-zoomba\\src\\Zoomba\\DesktopLibrary.py", "lineno": 542}, {"name": "Open Application", "args": [{"name": "remote_url", "types": [], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "remote_url"}, {"name": "alias", "types": [], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "alias=None"}, {"name": "window_name", "types": [], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "window_name=None"}, {"name": "splash_delay", "types": [], "defaultValue": "0", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "splash_delay=0"}, {"name": "exact_match", "types": [], "defaultValue": "True", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "exact_match=True"}, {"name": "kwargs", "types": [], "defaultValue": null, "kind": "VAR_NAMED", "required": false, "repr": "**kwargs"}], "doc": "<p>Opens a new application to given Appium server. If your application has a splash screen please supply the window name of the final window that will appear. For the capabilities of appium server and Windows please check <a href=\"http://appium.io/docs/en/drivers/windows\">http://appium.io/docs/en/drivers/windows</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<tr>\n<td>window_name</td>\n<td>No</td>\n<td>Window name you wish to attach, usually after a splash screen</td>\n</tr>\n<tr>\n<td>splash_delay</td>\n<td>No</td>\n<td>Delay used when waiting for a splash screen to load, in seconds</td>\n</tr>\n<tr>\n<td>exact_match</td>\n<td>No</td>\n<td>Set to False if window_name does not need to match exactly</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=Windows</td>\n<td>deviceName=Windows</td>\n<td>app=your.app</td>\n<td></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>alias=Myapp1</td>\n<td>platformName=Windows</td>\n<td>deviceName=Windows</td>\n<td>app=your.app</td>\n<td>window_name=MyApplication</td>\n<td>splash_delay=5</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>alias=Myapp1</td>\n<td>platformName=Windows</td>\n<td>deviceName=Windows</td>\n<td>app=your.app</td>\n<td>window_name=MyApplication</td>\n<td>exact_match=False</td>\n</tr>\n</table>\n<p>A session for the root desktop will also be opened and can be switched to by running the following:</p>\n<table border=\"1\">\n<tr>\n<td>Switch Application</td>\n<td>Desktop</td>\n</tr>\n</table>", "shortdoc": "Opens a new application to given Appium server. If your application has a splash screen please supply the window name of the final window that will appear. For the capabilities of appium server and Windows please check http://appium.io/docs/en/drivers/windows", "tags": [], "source": "C:\\Git\\robotframework-zoomba\\src\\Zoomba\\DesktopLibrary.py", "lineno": 253}, {"name": "Page Should Contain Element", "args": [{"name": "locator", "types": [], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "locator"}, {"name": "loglevel", "types": [], "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:\\Python\\lib\\site-packages\\AppiumLibrary\\keywords\\_element.py", "lineno": 129}, {"name": "Page Should Contain Text", "args": [{"name": "text", "types": [], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "text"}, {"name": "loglevel", "types": [], "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:\\Python\\lib\\site-packages\\AppiumLibrary\\keywords\\_element.py", "lineno": 104}, {"name": "Page Should Not Contain Element", "args": [{"name": "locator", "types": [], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "locator"}, {"name": "loglevel", "types": [], "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:\\Python\\lib\\site-packages\\AppiumLibrary\\keywords\\_element.py", "lineno": 142}, {"name": "Page Should Not Contain Text", "args": [{"name": "text", "types": [], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "text"}, {"name": "loglevel", "types": [], "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:\\Python\\lib\\site-packages\\AppiumLibrary\\keywords\\_element.py", "lineno": 117}, {"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:\\Python\\lib\\site-packages\\AppiumLibrary\\keywords\\_applicationmanagement.py", "lineno": 110}, {"name": "Register Keyword To Run On Failure", "args": [{"name": "keyword", "types": [], "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:\\Python\\lib\\site-packages\\AppiumLibrary\\keywords\\_runonfailure.py", "lineno": 17}, {"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-zoomba\\src\\Zoomba\\DesktopLibrary.py", "lineno": 710}, {"name": "Scroll", "args": [{"name": "x_offset", "types": [], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "x_offset"}, {"name": "y_offset", "types": [], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "y_offset"}], "doc": "<p>Scrolls from current position.</p>\n<p><code>x_offset</code> is the X offset to scroll to.</p>\n<p><code>y_offset</code> is the Y offset to scroll to.</p>", "shortdoc": "Scrolls from current position.", "tags": [], "source": "C:\\Git\\robotframework-zoomba\\src\\Zoomba\\DesktopLibrary.py", "lineno": 896}, {"name": "Scroll From Element", "args": [{"name": "locator", "types": [], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "locator"}, {"name": "x_offset", "types": [], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "x_offset"}, {"name": "y_offset", "types": [], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "y_offset"}], "doc": "<p>Scrolls starting from <code>locator</code>.</p>\n<p><code>x_offset</code> is the X offset to scroll to.</p>\n<p><code>y_offset</code> is the Y offset to scroll to.</p>", "shortdoc": "Scrolls starting from ``locator``.", "tags": [], "source": "C:\\Git\\robotframework-zoomba\\src\\Zoomba\\DesktopLibrary.py", "lineno": 906}, {"name": "Select Element From ComboBox", "args": [{"name": "list_locator", "types": [], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "list_locator"}, {"name": "element_locator", "types": [], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "element_locator"}, {"name": "skip_to_desktop", "types": [], "defaultValue": "False", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "skip_to_desktop=False"}], "doc": "<p>Selects the <code>element_locator</code> from the combobox found by <code>list_locator</code>.</p>\n<p>The keyword first checks the current application for the combobox list elements. If it is not found it will switch to the desktop session to look for the elements as many windows applications house the actual combobox items in a pane off of the desktop. <code>skip_to_desktop</code> can be set to <code>True</code> in order to go straight to the desktop session. This provides good time savings when dealing with a large application.</p>", "shortdoc": "Selects the ``element_locator`` from the combobox found by ``list_locator``.", "tags": [], "source": "C:\\Git\\robotframework-zoomba\\src\\Zoomba\\DesktopLibrary.py", "lineno": 716}, {"name": "Select Elements From Context Menu", "args": [{"name": "args", "types": [], "defaultValue": null, "kind": "VAR_POSITIONAL", "required": false, "repr": "*args"}], "doc": "<p>Context clicks the first element and then selects N number of elements (given as locators) in the order they are given. This is useful for working though a nested context menu listing of elements.</p>\n<p>On failure this keyword will attempt to select the elements from the desktop session due to the nature of some pop-out menus in Windows.</p>", "shortdoc": "Context clicks the first element and then selects N number of elements (given as locators) in the order they are given. This is useful for working though a nested context menu listing of elements.", "tags": [], "source": "C:\\Git\\robotframework-zoomba\\src\\Zoomba\\DesktopLibrary.py", "lineno": 768}, {"name": "Select Elements From Menu", "args": [{"name": "args", "types": [], "defaultValue": null, "kind": "VAR_POSITIONAL", "required": false, "repr": "*args"}], "doc": "<p>Selects N number of elements (given as locators) in the order they are given. This is useful for working though a nested menu listing of elements.</p>\n<p>On failure this keyword will attempt to select the elements from the desktop session due to the nature of some pop-out menus in Windows.</p>", "shortdoc": "Selects N number of elements (given as locators) in the order they are given. This is useful for working though a nested menu listing of elements.", "tags": [], "source": "C:\\Git\\robotframework-zoomba\\src\\Zoomba\\DesktopLibrary.py", "lineno": 744}, {"name": "Send Keys", "args": [{"name": "argv", "types": [], "defaultValue": null, "kind": "VAR_POSITIONAL", "required": false, "repr": "*argv"}], "doc": "<p>Sends the desired keys in <code>argv</code>.</p>\n<p>A list of special key codes can be found <a href=\"https://seleniumhq.github.io/selenium/docs/api/py/webdriver/selenium.webdriver.common.keys.html\">here</a></p>\n<p>Note that when sending in a modifier key (Ctrl, Alt, Shift) you will need to send the key again to release it.</p>\n<table border=\"1\">\n<tr>\n<td>Send Keys</td>\n<td>a</td>\n<td>b</td>\n<td></td>\n</tr>\n<tr>\n<td>Send Keys</td>\n<td>\\ue00</td>\n<td>p</td>\n<td>\\ue00</td>\n</tr>\n</table>", "shortdoc": "Sends the desired keys in ``argv``.", "tags": [], "source": "C:\\Git\\robotframework-zoomba\\src\\Zoomba\\DesktopLibrary.py", "lineno": 649}, {"name": "Send Keys To Element", "args": [{"name": "locator", "types": [], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "locator"}, {"name": "argv", "types": [], "defaultValue": null, "kind": "VAR_POSITIONAL", "required": false, "repr": "*argv"}], "doc": "<p>Sends the desired keys in <code>argv</code> to <code>locator</code>.</p>\n<p>A list of special key codes can be found <a href=\"https://seleniumhq.github.io/selenium/docs/api/py/webdriver/selenium.webdriver.common.keys.html\">here</a></p>\n<p>Note that when sending in a modifier key (Ctrl, Alt, Shift) you will need to send the key again to release it.</p>\n<table border=\"1\">\n<tr>\n<td>Send Keys To Element</td>\n<td>locator</td>\n<td>a</td>\n<td>b</td>\n<td></td>\n</tr>\n<tr>\n<td>Send Keys To Element</td>\n<td>locator</td>\n<td>\\ue00</td>\n<td>p</td>\n<td>\\ue00</td>\n</tr>\n</table>", "shortdoc": "Sends the desired keys in ``argv`` to ``locator``.", "tags": [], "source": "C:\\Git\\robotframework-zoomba\\src\\Zoomba\\DesktopLibrary.py", "lineno": 670}, {"name": "Set Appium Timeout", "args": [{"name": "seconds", "types": [], "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:\\Python\\lib\\site-packages\\AppiumLibrary\\keywords\\_applicationmanagement.py", "lineno": 143}, {"name": "Start Screen Recording", "args": [{"name": "time_limit", "types": [], "defaultValue": "180s", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "time_limit=180s"}, {"name": "options", "types": [], "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 (defaulting to 180 seconds).</p>\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.</p>\n<p>Keyword requires Appium to be used.</p>\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": "Starts an asynchronous Screen Recording for the current open application.", "tags": [], "source": "C:\\Git\\robotframework-zoomba\\src\\Zoomba\\DesktopLibrary.py", "lineno": 157}, {"name": "Stop Screen Recording", "args": [{"name": "filename", "types": [], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "filename=None"}, {"name": "options", "types": [], "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>Keyword requires Appium to be used.</p>\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-zoomba\\src\\Zoomba\\DesktopLibrary.py", "lineno": 178}, {"name": "Switch Application", "args": [{"name": "index_or_alias", "types": [], "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:\\Python\\lib\\site-packages\\AppiumLibrary\\keywords\\_applicationmanagement.py", "lineno": 58}, {"name": "Switch Application By Name", "args": [{"name": "remote_url", "types": [], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "remote_url"}, {"name": "window_name", "types": [], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "window_name"}, {"name": "alias", "types": [], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "alias=None"}, {"name": "timeout", "types": [], "defaultValue": "5", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "timeout=5"}, {"name": "exact_match", "types": [], "defaultValue": "True", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "exact_match=True"}, {"name": "kwargs", "types": [], "defaultValue": null, "kind": "VAR_NAMED", "required": false, "repr": "**kwargs"}], "doc": "<p>Switches to a currently opened window by <code>window_name</code>. For the capabilities of appium server and Windows, Please check <a href=\"http://appium.io/docs/en/drivers/windows\">http://appium.io/docs/en/drivers/windows</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>window_name</td>\n<td>Yes</td>\n<td>Window name you wish to attach</td>\n</tr>\n<tr>\n<td>alias</td>\n<td>No</td>\n<td>alias</td>\n</tr>\n<tr>\n<td>timeout</td>\n<td>No</td>\n<td>timeout to connect</td>\n</tr>\n<tr>\n<td>exact_match</td>\n<td>No</td>\n<td>Set to False if window_name does not need to match exactly</td>\n</tr>\n</table>\n<p>Examples:</p>\n<table border=\"1\">\n<tr>\n<td>Switch Application By Name</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=Windows</td>\n<td>deviceName=Windows</td>\n<td>window_name=MyApplication</td>\n</tr>\n<tr>\n<td>Switch Application By Name</td>\n<td><a href=\"http://localhost:4723/wd/hub\">http://localhost:4723/wd/hub</a></td>\n<td>window_name=MyApp</td>\n<td>exact_match=False</td>\n<td></td>\n<td></td>\n</tr>\n</table>\n<p>A session for the root desktop will also be opened and can be switched to by running the following:</p>\n<table border=\"1\">\n<tr>\n<td>Switch Application</td>\n<td>Desktop</td>\n</tr>\n</table>", "shortdoc": "Switches to a currently opened window by ``window_name``. For the capabilities of appium server and Windows, Please check http://appium.io/docs/en/drivers/windows | *Option*            | *Man.* | *Description*                         | | remote_url          | Yes    | Appium server url                     | | window_name         | Yes    | Window name you wish to attach        | | alias               | No     | alias                                 | | timeout             | No     | timeout to connect                    | | exact_match         | No     | Set to False if window_name does not need to match exactly       |", "tags": [], "source": "C:\\Git\\robotframework-zoomba\\src\\Zoomba\\DesktopLibrary.py", "lineno": 298}, {"name": "Tap", "args": [{"name": "locator", "types": [], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "locator"}, {"name": "x_offset", "types": [], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "x_offset=None"}, {"name": "y_offset", "types": [], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "y_offset=None"}, {"name": "count", "types": [], "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:\\Python\\lib\\site-packages\\AppiumLibrary\\keywords\\_touch.py", "lineno": 119}, {"name": "Text Should Be Visible", "args": [{"name": "text", "types": [], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "text"}, {"name": "exact_match", "types": [], "defaultValue": "False", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "exact_match=False"}, {"name": "loglevel", "types": [], "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:\\Python\\lib\\site-packages\\AppiumLibrary\\keywords\\_element.py", "lineno": 440}, {"name": "Wait For And Clear Text", "args": [{"name": "locator", "types": [], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "locator"}, {"name": "timeout", "types": [], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "timeout=None"}, {"name": "error", "types": [], "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-zoomba\\src\\Zoomba\\DesktopLibrary.py", "lineno": 388}, {"name": "Wait For And Click Element", "args": [{"name": "locator", "types": [], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "locator"}, {"name": "timeout", "types": [], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "timeout=None"}, {"name": "error", "types": [], "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>\n<p>Use <a href=\"#Wait%20For%20And%20Mouse%20Over%20And%20Click%20Element\" class=\"name\">Wait For And Mouse Over And Click Element</a> if this keyword gives issues in the application.</p>", "shortdoc": "Wait for and click the element identified by ``locator``.", "tags": [], "source": "C:\\Git\\robotframework-zoomba\\src\\Zoomba\\DesktopLibrary.py", "lineno": 413}, {"name": "Wait For And Double Tap", "args": [{"name": "locator", "types": [], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "locator"}, {"name": "timeout", "types": [], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "timeout=None"}, {"name": "error", "types": [], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "error=None"}], "doc": "<p>Wait for and double tap 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 double tap the element identified by ``locator``.", "tags": [], "source": "C:\\Git\\robotframework-zoomba\\src\\Zoomba\\DesktopLibrary.py", "lineno": 848}, {"name": "Wait For And Flick From Element", "args": [{"name": "locator", "types": [], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "locator"}, {"name": "x_offset", "types": [], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "x_offset"}, {"name": "y_offset", "types": [], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "y_offset"}, {"name": "speed", "types": [], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "speed"}, {"name": "timeout", "types": [], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "timeout=None"}, {"name": "error", "types": [], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "error=None"}], "doc": "<p>Wait for and flick from 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 flick from element identified by ``locator``.", "tags": [], "source": "C:\\Git\\robotframework-zoomba\\src\\Zoomba\\DesktopLibrary.py", "lineno": 883}, {"name": "Wait For And Input Password", "args": [{"name": "locator", "types": [], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "locator"}, {"name": "text", "types": [], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "text"}, {"name": "timeout", "types": [], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "timeout=None"}, {"name": "error", "types": [], "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-zoomba\\src\\Zoomba\\DesktopLibrary.py", "lineno": 429}, {"name": "Wait For And Input Text", "args": [{"name": "locator", "types": [], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "locator"}, {"name": "text", "types": [], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "text"}, {"name": "timeout", "types": [], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "timeout=None"}, {"name": "error", "types": [], "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-zoomba\\src\\Zoomba\\DesktopLibrary.py", "lineno": 443}, {"name": "Wait For And Long Press", "args": [{"name": "locator", "types": [], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "locator"}, {"name": "duration", "types": [], "defaultValue": "10000", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "duration=10000"}, {"name": "timeout", "types": [], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "timeout=None"}, {"name": "error", "types": [], "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-zoomba\\src\\Zoomba\\DesktopLibrary.py", "lineno": 456}, {"name": "Wait For And Mouse Over And Click Element", "args": [{"name": "locator", "types": [], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "locator"}, {"name": "timeout", "types": [], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "timeout=None"}, {"name": "error", "types": [], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "error=None"}, {"name": "double_click", "types": [], "defaultValue": "False", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "double_click=False"}, {"name": "x_offset", "types": [], "defaultValue": "0", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "x_offset=0"}, {"name": "y_offset", "types": [], "defaultValue": "0", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "y_offset=0"}], "doc": "<p>Waits for, moves the mouse over, and clicks the given <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><code>double_click</code> can be used to click twice.</p>\n<p><code>x_offset</code> and <code>y_offset</code> can be used to move to a specific coordinate.</p>", "shortdoc": "Waits for, moves the mouse over, and clicks the given ``locator``.", "tags": [], "source": "C:\\Git\\robotframework-zoomba\\src\\Zoomba\\DesktopLibrary.py", "lineno": 585}, {"name": "Wait For And Mouse Over Element", "args": [{"name": "locator", "types": [], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "locator"}, {"name": "timeout", "types": [], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "timeout=None"}, {"name": "error", "types": [], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "error=None"}, {"name": "x_offset", "types": [], "defaultValue": "0", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "x_offset=0"}, {"name": "y_offset", "types": [], "defaultValue": "0", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "y_offset=0"}], "doc": "<p>Waits for and moves the mouse over the given <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><code>x_offset</code> and <code>y_offset</code> can be used to move to a specific coordinate.</p>", "shortdoc": "Waits for and moves the mouse over the given ``locator``.", "tags": [], "source": "C:\\Git\\robotframework-zoomba\\src\\Zoomba\\DesktopLibrary.py", "lineno": 552}, {"name": "Wait For And Scroll From Element", "args": [{"name": "locator", "types": [], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "locator"}, {"name": "x_offset", "types": [], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "x_offset"}, {"name": "y_offset", "types": [], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "y_offset"}, {"name": "timeout", "types": [], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "timeout=None"}, {"name": "error", "types": [], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "error=None"}], "doc": "<p>Wait for and scroll from 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 scroll from element identified by ``locator``.", "tags": [], "source": "C:\\Git\\robotframework-zoomba\\src\\Zoomba\\DesktopLibrary.py", "lineno": 917}, {"name": "Wait For And Tap", "args": [{"name": "locator", "types": [], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "locator"}, {"name": "timeout", "types": [], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "timeout=None"}, {"name": "error", "types": [], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "error=None"}], "doc": "<p>Wait for and tap 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 tap the element identified by ``locator``.", "tags": [], "source": "C:\\Git\\robotframework-zoomba\\src\\Zoomba\\DesktopLibrary.py", "lineno": 834}, {"name": "Wait Until Element Contains", "args": [{"name": "locator", "types": [], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "locator"}, {"name": "text", "types": [], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "text"}, {"name": "timeout", "types": [], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "timeout=None"}, {"name": "error", "types": [], "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-zoomba\\src\\Zoomba\\DesktopLibrary.py", "lineno": 469}, {"name": "Wait Until Element Does Not Contain", "args": [{"name": "locator", "types": [], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "locator"}, {"name": "text", "types": [], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "text"}, {"name": "timeout", "types": [], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "timeout=None"}, {"name": "error", "types": [], "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-zoomba\\src\\Zoomba\\DesktopLibrary.py", "lineno": 484}, {"name": "Wait Until Element Is Disabled", "args": [{"name": "locator", "types": [], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "locator"}, {"name": "timeout", "types": [], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "timeout=None"}, {"name": "error", "types": [], "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%20Enabled\" class=\"name\">Wait Until Element Is Enabled</a></p>", "shortdoc": "Waits until element specified with ``locator`` is disabled.", "tags": [], "source": "C:\\Git\\robotframework-zoomba\\src\\Zoomba\\DesktopLibrary.py", "lineno": 530}, {"name": "Wait Until Element Is Enabled", "args": [{"name": "locator", "types": [], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "locator"}, {"name": "timeout", "types": [], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "timeout=None"}, {"name": "error", "types": [], "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-zoomba\\src\\Zoomba\\DesktopLibrary.py", "lineno": 509}, {"name": "Wait Until Element Is Visible", "args": [{"name": "locator", "types": [], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "locator"}, {"name": "timeout", "types": [], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "timeout=None"}, {"name": "error", "types": [], "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:\\Python\\lib\\site-packages\\AppiumLibrary\\keywords\\_waiting.py", "lineno": 7}, {"name": "Wait Until Page Contains", "args": [{"name": "text", "types": [], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "text"}, {"name": "timeout", "types": [], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "timeout=None"}, {"name": "error", "types": [], "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:\\Python\\lib\\site-packages\\AppiumLibrary\\keywords\\_waiting.py", "lineno": 30}, {"name": "Wait Until Page Contains Element", "args": [{"name": "locator", "types": [], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "locator"}, {"name": "timeout", "types": [], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "timeout=None"}, {"name": "error", "types": [], "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:\\Python\\lib\\site-packages\\AppiumLibrary\\keywords\\_waiting.py", "lineno": 72}, {"name": "Wait Until Page Does Not Contain", "args": [{"name": "text", "types": [], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "text"}, {"name": "timeout", "types": [], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "timeout=None"}, {"name": "error", "types": [], "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:\\Python\\lib\\site-packages\\AppiumLibrary\\keywords\\_waiting.py", "lineno": 48}, {"name": "Wait Until Page Does Not Contain Element", "args": [{"name": "locator", "types": [], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "locator"}, {"name": "timeout", "types": [], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "timeout=None"}, {"name": "error", "types": [], "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:\\Python\\lib\\site-packages\\AppiumLibrary\\keywords\\_waiting.py", "lineno": 90}, {"name": "Xpath Should Match X Times", "args": [{"name": "xpath", "types": [], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "xpath"}, {"name": "count", "types": [], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "count"}, {"name": "error", "types": [], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "error=None"}, {"name": "loglevel", "types": [], "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:\\Python\\lib\\site-packages\\AppiumLibrary\\keywords\\_element.py", "lineno": 450}], "dataTypes": {"enums": [], "typedDicts": []}}
 </script>
 <title></title>
 </head>
diff --git a/docs/GUILibraryDocumentation.html b/docs/GUILibraryDocumentation.html
index 3c924ce5..c9f4a884 100644
--- a/docs/GUILibraryDocumentation.html
+++ b/docs/GUILibraryDocumentation.html
@@ -1101,7 +1101,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 = {"name": "GUI_Library", "doc": "<p>Zoomba GUI Library</p>\n<p>This class inherits from the SeleniumLibrary Class, and expands it with some commonly used keywords. For more information on SeleniumLibrary please visit: <a href=\"https://robotframework.org/SeleniumLibrary/SeleniumLibrary.html\">https://robotframework.org/SeleniumLibrary/SeleniumLibrary.html</a></p>", "version": "2.9.0", "generated": "2021-05-12 09:19:41", "type": "LIBRARY", "scope": "GLOBAL", "docFormat": "HTML", "source": "C:\\Git\\robotframework-zoomba\\src\\Zoomba\\GUILibrary.py", "lineno": 22, "tags": [], "inits": [{"name": "Init", "args": [{"name": "timeout", "types": [], "defaultValue": "5.0", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "timeout=5.0"}, {"name": "implicit_wait", "types": [], "defaultValue": "0.0", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "implicit_wait=0.0"}, {"name": "run_on_failure", "types": [], "defaultValue": "Save Selenium Screenshot", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "run_on_failure=Save Selenium Screenshot"}, {"name": "screenshot_root_directory", "types": [], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "screenshot_root_directory=None"}, {"name": "plugins", "types": [], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "plugins=None"}, {"name": "event_firing_webdriver", "types": [], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "event_firing_webdriver=None"}], "doc": "<p>GUILibrary can be imported with several optional arguments.</p>\n<ul>\n<li><code>timeout</code>: Default value for <span class=\"name\">timeouts</span> used with <code>Wait ...</code> keywords.</li>\n<li><code>implicit_wait</code>: Default value for <span class=\"name\">implicit wait</span> used when locating elements.</li>\n<li><code>run_on_failure</code>: Default action for the <span class=\"name\">run-on-failure functionality</span>.</li>\n<li><code>screenshot_root_directory</code>: Path to folder where possible screenshots are created or EMBED. See <a href=\"#Set%20Screenshot%20Directory\" class=\"name\">Set Screenshot Directory</a> keyword for further details about EMBED. If not given, the directory where the log file is written is used.</li>\n<li><code>plugins</code>: Allows extending the GUILibrary with external Python classes.</li>\n<li><code>event_firing_webdriver</code>: Class for wrapping Selenium with <a href=\"https://seleniumhq.github.io/selenium/docs/api/py/webdriver_support/selenium.webdriver.support.event_firing_webdriver.html#module-selenium.webdriver.support.event_firing_webdriver\">EventFiringWebDriver</a></li>\n</ul>", "shortdoc": "GUILibrary can be imported with several optional arguments.", "tags": [], "source": "C:\\Git\\robotframework-zoomba\\src\\Zoomba\\GUILibrary.py", "lineno": 28}], "keywords": [{"name": "Add Cookie", "args": [{"name": "name", "types": ["str"], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "name: str"}, {"name": "value", "types": ["str"], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "value: str"}, {"name": "path", "types": ["str"], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "path: str = None"}, {"name": "domain", "types": ["str"], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "domain: str = None"}, {"name": "secure", "types": ["bool"], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "secure: bool = None"}, {"name": "expiry", "types": ["str"], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "expiry: str = None"}], "doc": "<p>Adds a cookie to your current session.</p>\n<p><code>name</code> and <code>value</code> are required, <code>path</code>, <code>domain</code>, <code>secure</code> and <code>expiry</code> are optional.  Expiry supports the same formats as the <a href=\"http://robotframework.org/robotframework/latest/libraries/DateTime.html\">DateTime</a> library or an epoch timestamp.</p>\n<p>Example:</p>\n<table border=\"1\">\n<tr>\n<td><a href=\"#Add%20Cookie\" class=\"name\">Add Cookie</a></td>\n<td>foo</td>\n<td>bar</td>\n<td></td>\n<td></td>\n</tr>\n<tr>\n<td><a href=\"#Add%20Cookie\" class=\"name\">Add Cookie</a></td>\n<td>foo</td>\n<td>bar</td>\n<td>domain=example.com</td>\n<td></td>\n</tr>\n<tr>\n<td><a href=\"#Add%20Cookie\" class=\"name\">Add Cookie</a></td>\n<td>foo</td>\n<td>bar</td>\n<td>expiry=2027-09-28 16:21:35</td>\n<td># Expiry as timestamp.</td>\n</tr>\n<tr>\n<td><a href=\"#Add%20Cookie\" class=\"name\">Add Cookie</a></td>\n<td>foo</td>\n<td>bar</td>\n<td>expiry=1822137695</td>\n<td># Expiry as epoch seconds.</td>\n</tr>\n</table>\n<p>Prior to SeleniumLibrary 3.0 setting expiry did not work.</p>", "shortdoc": "Adds a cookie to your current session.", "tags": [], "source": "C:\\Python\\lib\\site-packages\\SeleniumLibrary\\keywords\\cookie.py", "lineno": 143}, {"name": "Add Location Strategy", "args": [{"name": "strategy_name", "types": ["str"], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "strategy_name: str"}, {"name": "strategy_keyword", "types": ["str"], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "strategy_keyword: str"}, {"name": "persist", "types": ["bool"], "defaultValue": "False", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "persist: bool = False"}], "doc": "<p>Adds a custom location strategy.</p>\n<p>See <span class=\"name\">Custom locators</span> for information on how to create and use custom strategies. <a href=\"#Remove%20Location%20Strategy\" class=\"name\">Remove Location Strategy</a> can be used to remove a registered strategy.</p>\n<p>Location strategies are automatically removed after leaving the current scope by default. Setting <code>persist</code> to a true value (see <span class=\"name\">Boolean arguments</span>) will cause the location strategy to stay registered throughout the life of the test.</p>", "shortdoc": "Adds a custom location strategy.", "tags": [], "source": "C:\\Python\\lib\\site-packages\\SeleniumLibrary\\keywords\\element.py", "lineno": 1118}, {"name": "Alert Should Be Present", "args": [{"name": "text", "types": ["str"], "defaultValue": "", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "text: str = "}, {"name": "action", "types": ["str"], "defaultValue": "ACCEPT", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "action: str = ACCEPT"}, {"name": "timeout", "types": ["timedelta"], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "timeout: timedelta = None"}], "doc": "<p>Verifies that an alert is present and by default, accepts it.</p>\n<p>Fails if no alert is present. If <code>text</code> is a non-empty string, then it is used to verify alert's message. The alert is accepted by default, but that behavior can be controlled by using the <code>action</code> argument same way as with <a href=\"#Handle%20Alert\" class=\"name\">Handle Alert</a>.</p>\n<p><code>timeout</code> specifies how long to wait for the alert to appear. If it is not given, the global default <span class=\"name\">timeout</span> is used instead.</p>\n<p><code>action</code> and <code>timeout</code> arguments are new in SeleniumLibrary 3.0. In earlier versions, the alert was always accepted and a timeout was hardcoded to one second.</p>", "shortdoc": "Verifies that an alert is present and by default, accepts it.", "tags": [], "source": "C:\\Python\\lib\\site-packages\\SeleniumLibrary\\keywords\\alert.py", "lineno": 52}, {"name": "Alert Should Not Be Present", "args": [{"name": "action", "types": ["str"], "defaultValue": "ACCEPT", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "action: str = ACCEPT"}, {"name": "timeout", "types": ["timedelta"], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "timeout: timedelta = None"}], "doc": "<p>Verifies that no alert is present.</p>\n<p>If the alert actually exists, the <code>action</code> argument determines how it should be handled. By default, the alert is accepted, but it can be also dismissed or left open the same way as with the <a href=\"#Handle%20Alert\" class=\"name\">Handle Alert</a> keyword.</p>\n<p><code>timeout</code> specifies how long to wait for the alert to appear. By default, is not waited for the alert at all, but a custom time can be given if alert may be delayed. See the <span class=\"name\">time format</span> section for information about the syntax.</p>\n<p>New in SeleniumLibrary 3.0.</p>", "shortdoc": "Verifies that no alert is present.", "tags": [], "source": "C:\\Python\\lib\\site-packages\\SeleniumLibrary\\keywords\\alert.py", "lineno": 79}, {"name": "Assign Id To Element", "args": [{"name": "locator", "types": ["WebElement", "str"], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "locator: WebElement | str"}, {"name": "id", "types": ["str"], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "id: str"}], "doc": "<p>Assigns a temporary <code>id</code> to the element specified by <code>locator</code>.</p>\n<p>This is mainly useful if the locator is complicated and/or slow XPath expression and it is needed multiple times. Identifier expires when the page is reloaded.</p>\n<p>See the <span class=\"name\">Locating elements</span> section for details about the locator syntax.</p>\n<p>Example:</p>\n<table border=\"1\">\n<tr>\n<td><a href=\"#Assign%20Id%20To%20Element\" class=\"name\">Assign ID to Element</a></td>\n<td>//ul[@class='example' and ./li[contains(., 'Stuff')]]</td>\n<td>my id</td>\n</tr>\n<tr>\n<td><a href=\"#Page%20Should%20Contain%20Element\" class=\"name\">Page Should Contain Element</a></td>\n<td>my id</td>\n<td></td>\n</tr>\n</table>", "shortdoc": "Assigns a temporary ``id`` to the element specified by ``locator``.", "tags": [], "source": "C:\\Python\\lib\\site-packages\\SeleniumLibrary\\keywords\\element.py", "lineno": 222}, {"name": "Capture Element Screenshot", "args": [{"name": "locator", "types": ["WebElement", "None", "str"], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "locator: WebElement | None | str"}, {"name": "filename", "types": ["str"], "defaultValue": "selenium-element-screenshot-{index}.png", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "filename: str = selenium-element-screenshot-{index}.png"}], "doc": "<p>Captures a screenshot from the element identified by <code>locator</code> and embeds it into log file.</p>\n<p>See <a href=\"#Capture%20Page%20Screenshot\" class=\"name\">Capture Page Screenshot</a> for details about <code>filename</code> argument. See the <span class=\"name\">Locating elements</span> section for details about the locator syntax.</p>\n<p>An absolute path to the created element screenshot is returned.</p>\n<p>Support for capturing the screenshot from an element has limited support among browser vendors. Please check the browser vendor driver documentation does the browser support capturing a screenshot from an element.</p>\n<p>New in SeleniumLibrary 3.3. Support for EMBED is new in SeleniumLibrary 4.2.</p>\n<p>Examples:</p>\n<table border=\"1\">\n<tr>\n<td><a href=\"#Capture%20Element%20Screenshot\" class=\"name\">Capture Element Screenshot</a></td>\n<td>id:image_id</td>\n<td></td>\n</tr>\n<tr>\n<td><a href=\"#Capture%20Element%20Screenshot\" class=\"name\">Capture Element Screenshot</a></td>\n<td>id:image_id</td>\n<td>${OUTPUTDIR}/id_image_id-1.png</td>\n</tr>\n<tr>\n<td><a href=\"#Capture%20Element%20Screenshot\" class=\"name\">Capture Element Screenshot</a></td>\n<td>id:image_id</td>\n<td>EMBED</td>\n</tr>\n</table>", "shortdoc": "Captures a screenshot from the element identified by ``locator`` and embeds it into log file.", "tags": [], "source": "C:\\Python\\lib\\site-packages\\SeleniumLibrary\\keywords\\screenshot.py", "lineno": 129}, {"name": "Capture Page Screenshot", "args": [{"name": "filename", "types": ["str"], "defaultValue": "selenium-screenshot-{index}.png", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "filename: str = selenium-screenshot-{index}.png"}], "doc": "<p>Takes a screenshot of the current page and embeds it into a log file.</p>\n<p><code>filename</code> argument specifies the name of the file to write the screenshot into. The directory where screenshots are saved can be set when <a href=\"#Importing\" class=\"name\">importing</a> the library or by using the <a href=\"#Set%20Screenshot%20Directory\" class=\"name\">Set Screenshot Directory</a> keyword. If the directory is not configured, screenshots are saved to the same directory where Robot Framework's log file is written.</p>\n<p>If <code>filename</code> equals to EMBED (case insensitive), then screenshot is embedded as Base64 image to the log.html. In this case file is not created in the filesystem.</p>\n<p>Starting from SeleniumLibrary 1.8, if <code>filename</code> contains marker <code>{index}</code>, it will be automatically replaced with an unique running index, preventing files to be overwritten. Indices start from 1, and how they are represented can be customized using Python's <a href=\"https://docs.python.org/3/library/string.html#format-string-syntax\">format string syntax</a>.</p>\n<p>An absolute path to the created screenshot file is returned or if <code>filename</code>  equals to EMBED, word <span class=\"name\">EMBED</span> is returned.</p>\n<p>Support for EMBED is new in SeleniumLibrary 4.2</p>\n<p>Examples:</p>\n<table border=\"1\">\n<tr>\n<td><a href=\"#Capture%20Page%20Screenshot\" class=\"name\">Capture Page Screenshot</a></td>\n<td></td>\n</tr>\n<tr>\n<td><span class=\"name\">File Should Exist</span></td>\n<td>${OUTPUTDIR}/selenium-screenshot-1.png</td>\n</tr>\n<tr>\n<td>${path} =</td>\n<td><a href=\"#Capture%20Page%20Screenshot\" class=\"name\">Capture Page Screenshot</a></td>\n</tr>\n<tr>\n<td><span class=\"name\">File Should Exist</span></td>\n<td>${OUTPUTDIR}/selenium-screenshot-2.png</td>\n</tr>\n<tr>\n<td><span class=\"name\">File Should Exist</span></td>\n<td>${path}</td>\n</tr>\n<tr>\n<td><a href=\"#Capture%20Page%20Screenshot\" class=\"name\">Capture Page Screenshot</a></td>\n<td>custom_name.png</td>\n</tr>\n<tr>\n<td><span class=\"name\">File Should Exist</span></td>\n<td>${OUTPUTDIR}/custom_name.png</td>\n</tr>\n<tr>\n<td><a href=\"#Capture%20Page%20Screenshot\" class=\"name\">Capture Page Screenshot</a></td>\n<td>custom_with_index_{index}.png</td>\n</tr>\n<tr>\n<td><span class=\"name\">File Should Exist</span></td>\n<td>${OUTPUTDIR}/custom_with_index_1.png</td>\n</tr>\n<tr>\n<td><a href=\"#Capture%20Page%20Screenshot\" class=\"name\">Capture Page Screenshot</a></td>\n<td>formatted_index_{index:03}.png</td>\n</tr>\n<tr>\n<td><span class=\"name\">File Should Exist</span></td>\n<td>${OUTPUTDIR}/formatted_index_001.png</td>\n</tr>\n<tr>\n<td><a href=\"#Capture%20Page%20Screenshot\" class=\"name\">Capture Page Screenshot</a></td>\n<td>EMBED</td>\n</tr>\n<tr>\n<td><span class=\"name\">File Should Not Exist</span></td>\n<td>EMBED</td>\n</tr>\n</table>", "shortdoc": "Takes a screenshot of the current page and embeds it into a log file.", "tags": [], "source": "C:\\Python\\lib\\site-packages\\SeleniumLibrary\\keywords\\screenshot.py", "lineno": 67}, {"name": "Checkbox Should Be Selected", "args": [{"name": "locator", "types": ["WebElement", "str"], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "locator: WebElement | str"}], "doc": "<p>Verifies checkbox <code>locator</code> is selected/checked.</p>\n<p>See the <span class=\"name\">Locating elements</span> section for details about the locator syntax.</p>", "shortdoc": "Verifies checkbox ``locator`` is selected/checked.", "tags": [], "source": "C:\\Python\\lib\\site-packages\\SeleniumLibrary\\keywords\\formelement.py", "lineno": 44}, {"name": "Checkbox Should Not Be Selected", "args": [{"name": "locator", "types": ["WebElement", "str"], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "locator: WebElement | str"}], "doc": "<p>Verifies checkbox <code>locator</code> is not selected/checked.</p>\n<p>See the <span class=\"name\">Locating elements</span> section for details about the locator syntax.</p>", "shortdoc": "Verifies checkbox ``locator`` is not selected/checked.", "tags": [], "source": "C:\\Python\\lib\\site-packages\\SeleniumLibrary\\keywords\\formelement.py", "lineno": 58}, {"name": "Choose File", "args": [{"name": "locator", "types": ["WebElement", "str"], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "locator: WebElement | str"}, {"name": "file_path", "types": ["str"], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "file_path: str"}], "doc": "<p>Inputs the <code>file_path</code> into the file input field <code>locator</code>.</p>\n<p>This keyword is most often used to input files into upload forms. The keyword does not check <code>file_path</code> is the file or folder available on the machine where tests are executed. If the <code>file_path</code> points at a file and when using Selenium Grid, Selenium will <a href=\"https://seleniumhq.github.io/selenium/docs/api/py/webdriver_remote/selenium.webdriver.remote.command.html?highlight=upload#selenium.webdriver.remote.command.Command.UPLOAD_FILE\">magically</a>, transfer the file from the machine where the tests are executed to the Selenium Grid node where the browser is running. Then Selenium will send the file path, from the nodes file system, to the browser.</p>\n<p>That <code>file_path</code> is not checked, is new in SeleniumLibrary 4.0.</p>\n<p>Example:</p>\n<table border=\"1\">\n<tr>\n<td><a href=\"#Choose%20File\" class=\"name\">Choose File</a></td>\n<td>my_upload_field</td>\n<td>${CURDIR}/trades.csv</td>\n</tr>\n</table>", "shortdoc": "Inputs the ``file_path`` into the file input field ``locator``.", "tags": [], "source": "C:\\Python\\lib\\site-packages\\SeleniumLibrary\\keywords\\formelement.py", "lineno": 216}, {"name": "Clear Element Text", "args": [{"name": "locator", "types": ["WebElement", "str"], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "locator: WebElement | str"}], "doc": "<p>Clears the value of the text-input-element identified by <code>locator</code>.</p>\n<p>See the <span class=\"name\">Locating elements</span> section for details about the locator syntax.</p>", "shortdoc": "Clears the value of the text-input-element identified by ``locator``.", "tags": [], "source": "C:\\Python\\lib\\site-packages\\SeleniumLibrary\\keywords\\element.py", "lineno": 524}, {"name": "Click Button", "args": [{"name": "locator", "types": ["WebElement", "str"], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "locator: WebElement | str"}, {"name": "modifier", "types": ["bool", "str"], "defaultValue": "False", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "modifier: bool | str = False"}], "doc": "<p>Clicks the button identified by <code>locator</code>.</p>\n<p>See the <span class=\"name\">Locating elements</span> section for details about the locator syntax. When using the default locator strategy, buttons are searched using <code>id</code>, <code>name</code>, and <code>value</code>.</p>\n<p>See the <a href=\"#Click%20Element\" class=\"name\">Click Element</a> keyword for details about the <code>modifier</code> argument.</p>\n<p>The <code>modifier</code> argument is new in SeleniumLibrary 3.3</p>", "shortdoc": "Clicks the button identified by ``locator``.", "tags": [], "source": "C:\\Python\\lib\\site-packages\\SeleniumLibrary\\keywords\\element.py", "lineno": 547}, {"name": "Click Element", "args": [{"name": "locator", "types": ["WebElement", "str"], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "locator: WebElement | str"}, {"name": "modifier", "types": ["bool", "str"], "defaultValue": "False", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "modifier: bool | str = False"}, {"name": "action_chain", "types": ["bool"], "defaultValue": "False", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "action_chain: bool = False"}], "doc": "<p>Click the element identified by <code>locator</code>.</p>\n<p>See the <span class=\"name\">Locating elements</span> section for details about the locator syntax.</p>\n<p>The <code>modifier</code> argument can be used to pass <a href=\"https://seleniumhq.github.io/selenium/docs/api/py/webdriver/selenium.webdriver.common.keys.html#selenium.webdriver.common.keys.Keys\">Selenium Keys</a> when clicking the element. The <span class=\"name\">+</span> can be used as a separator for different Selenium Keys. The <span class=\"name\">CTRL</span> is internally translated to the <span class=\"name\">CONTROL</span> key. The <code>modifier</code> is space and case insensitive, example \"alt\" and \" aLt \" are supported formats to <a href=\"https://seleniumhq.github.io/selenium/docs/api/py/webdriver/selenium.webdriver.common.keys.html#selenium.webdriver.common.keys.Keys.ALT\">ALT key</a> . If <code>modifier</code> does not match to Selenium Keys, keyword fails.</p>\n<p>If <code>action_chain</code> argument is true, see <span class=\"name\">Boolean arguments</span> for more details on how to set boolean argument, then keyword uses ActionChain based click instead of the &lt;web_element&gt;.click() function. If both <code>action_chain</code> and <code>modifier</code> are defined, the click will be performed using <code>modifier</code> and <code>action_chain</code> will be ignored.</p>\n<p>Example:</p>\n<table border=\"1\">\n<tr>\n<td>Click Element</td>\n<td>id:button</td>\n<td></td>\n<td># Would click element without any modifiers.</td>\n</tr>\n<tr>\n<td>Click Element</td>\n<td>id:button</td>\n<td>CTRL</td>\n<td># Would click element with CTLR key pressed down.</td>\n</tr>\n<tr>\n<td>Click Element</td>\n<td>id:button</td>\n<td>CTRL+ALT</td>\n<td># Would click element with CTLR and ALT keys pressed down.</td>\n</tr>\n<tr>\n<td>Click Element</td>\n<td>id:button</td>\n<td>action_chain=True</td>\n<td># Clicks the button using an Selenium  ActionChains</td>\n</tr>\n</table>\n<p>The <code>modifier</code> argument is new in SeleniumLibrary 3.2 The <code>action_chain</code> argument is new in SeleniumLibrary 4.1</p>", "shortdoc": "Click the element identified by ``locator``.", "tags": [], "source": "C:\\Python\\lib\\site-packages\\SeleniumLibrary\\keywords\\element.py", "lineno": 617}, {"name": "Click Element At Coordinates", "args": [{"name": "locator", "types": ["WebElement", "str"], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "locator: WebElement | str"}, {"name": "xoffset", "types": ["int"], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "xoffset: int"}, {"name": "yoffset", "types": ["int"], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "yoffset: int"}], "doc": "<p>Click the element <code>locator</code> at <code>xoffset/yoffset</code>.</p>\n<p>The Cursor is moved and the center of the element and x/y coordinates are calculated from that point.</p>\n<p>See the <span class=\"name\">Locating elements</span> section for details about the locator syntax.</p>", "shortdoc": "Click the element ``locator`` at ``xoffset/yoffset``.", "tags": [], "source": "C:\\Python\\lib\\site-packages\\SeleniumLibrary\\keywords\\element.py", "lineno": 689}, {"name": "Click Image", "args": [{"name": "locator", "types": ["WebElement", "str"], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "locator: WebElement | str"}, {"name": "modifier", "types": ["bool", "str"], "defaultValue": "False", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "modifier: bool | str = False"}], "doc": "<p>Clicks an image identified by <code>locator</code>.</p>\n<p>See the <span class=\"name\">Locating elements</span> section for details about the locator syntax. When using the default locator strategy, images are searched using <code>id</code>, <code>name</code>, <code>src</code> and <code>alt</code>.</p>\n<p>See the <a href=\"#Click%20Element\" class=\"name\">Click Element</a> keyword for details about the <code>modifier</code> argument.</p>\n<p>The <code>modifier</code> argument is new in SeleniumLibrary 3.3</p>", "shortdoc": "Clicks an image identified by ``locator``.", "tags": [], "source": "C:\\Python\\lib\\site-packages\\SeleniumLibrary\\keywords\\element.py", "lineno": 571}, {"name": "Click Link", "args": [{"name": "locator", "types": ["WebElement", "str"], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "locator: WebElement | str"}, {"name": "modifier", "types": ["bool", "str"], "defaultValue": "False", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "modifier: bool | str = False"}], "doc": "<p>Clicks a link identified by <code>locator</code>.</p>\n<p>See the <span class=\"name\">Locating elements</span> section for details about the locator syntax. When using the default locator strategy, links are searched using <code>id</code>, <code>name</code>, <code>href</code> and the link text.</p>\n<p>See the <a href=\"#Click%20Element\" class=\"name\">Click Element</a> keyword for details about the <code>modifier</code> argument.</p>\n<p>The <code>modifier</code> argument is new in SeleniumLibrary 3.3</p>", "shortdoc": "Clicks a link identified by ``locator``.", "tags": [], "source": "C:\\Python\\lib\\site-packages\\SeleniumLibrary\\keywords\\element.py", "lineno": 596}, {"name": "Close All Browsers", "args": [], "doc": "<p>Closes all open browsers and resets the browser cache.</p>\n<p>After this keyword, new indexes returned from <a href=\"#Open%20Browser\" class=\"name\">Open Browser</a> keyword are reset to 1.</p>\n<p>This keyword should be used in test or suite teardown to make sure all browsers are closed.</p>", "shortdoc": "Closes all open browsers and resets the browser cache.", "tags": [], "source": "C:\\Python\\lib\\site-packages\\SeleniumLibrary\\keywords\\browsermanagement.py", "lineno": 40}, {"name": "Close Browser", "args": [], "doc": "<p>Closes the current browser.</p>", "shortdoc": "Closes the current browser.", "tags": [], "source": "C:\\Python\\lib\\site-packages\\SeleniumLibrary\\keywords\\browsermanagement.py", "lineno": 53}, {"name": "Close Window", "args": [], "doc": "<p>Closes currently opened and selected browser window/tab.</p>", "shortdoc": "Closes currently opened and selected browser window/tab.", "tags": [], "source": "C:\\Python\\lib\\site-packages\\SeleniumLibrary\\keywords\\window.py", "lineno": 125}, {"name": "Cover Element", "args": [{"name": "locator", "types": ["WebElement", "str"], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "locator: WebElement | str"}], "doc": "<p>Will cover elements identified by <code>locator</code> with a blue div without breaking page layout.</p>\n<p>See the <span class=\"name\">Locating elements</span> section for details about the locator syntax.</p>\n<p>New in SeleniumLibrary 3.3.0</p>\n<p>Example: |<a href=\"#Cover%20Element\" class=\"name\">Cover Element</a> | css:div#container |</p>", "shortdoc": "Will cover elements identified by ``locator`` with a blue div without breaking page layout.", "tags": [], "source": "C:\\Python\\lib\\site-packages\\SeleniumLibrary\\keywords\\element.py", "lineno": 474}, {"name": "Create Dictionary From Keys And Values Lists", "args": [{"name": "keys", "types": [], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "keys"}, {"name": "values", "types": [], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "values"}], "doc": "<p>This keyword returns a dictionary, given a list of keys and a list of values of the same length.</p>\n<p>keys: (array of strings) A list of keys to be assigned to a dictionary.</p>\n<p>values: (array of strings,integers,dictionaries,etc) A list of values to be assigned to a dictionary.</p>\n<p>return: (dictionary) A dictionary with the mapped key-value pairs.</p>", "shortdoc": "This keyword returns a dictionary, given a list of keys and a list of values of the same length.", "tags": [], "source": "C:\\Git\\robotframework-zoomba\\src\\Zoomba\\GUILibrary.py", "lineno": 322}, {"name": "Create Webdriver", "args": [{"name": "driver_name", "types": ["str"], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "driver_name: str"}, {"name": "alias", "types": ["str"], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "alias: str = None"}, {"name": "kwargs", "types": [], "defaultValue": "{}", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "kwargs={}"}, {"name": "init_kwargs", "types": [], "defaultValue": null, "kind": "VAR_NAMED", "required": false, "repr": "**init_kwargs"}], "doc": "<p>Creates an instance of Selenium WebDriver.</p>\n<p>Like <a href=\"#Open%20Browser\" class=\"name\">Open Browser</a>, but allows passing arguments to the created WebDriver instance directly. This keyword should only be used if the functionality provided by <a href=\"#Open%20Browser\" class=\"name\">Open Browser</a> is not adequate.</p>\n<p><code>driver_name</code> must be a WebDriver implementation name like Firefox, Chrome, Ie, Opera, Safari, PhantomJS, or Remote.</p>\n<p>The initialized WebDriver can be configured either with a Python dictionary <code>kwargs</code> or by using keyword arguments <code>**init_kwargs</code>. These arguments are passed directly to WebDriver without any processing. See <a href=\"https://seleniumhq.github.io/selenium/docs/api/py/api.html\">Selenium API documentation</a> for details about the supported arguments.</p>\n<p>Examples:</p>\n<table border=\"1\">\n<tr>\n<td># Use proxy with Firefox</td>\n<td></td>\n<td></td>\n<td></td>\n</tr>\n<tr>\n<td>${proxy}=</td>\n<td><span class=\"name\">Evaluate</span></td>\n<td>selenium.webdriver.Proxy()</td>\n<td>modules=selenium, selenium.webdriver</td>\n</tr>\n<tr>\n<td>${proxy.http_proxy}=</td>\n<td><span class=\"name\">Set Variable</span></td>\n<td>localhost:8888</td>\n<td></td>\n</tr>\n<tr>\n<td><a href=\"#Create%20Webdriver\" class=\"name\">Create Webdriver</a></td>\n<td>Firefox</td>\n<td>proxy=${proxy}</td>\n<td></td>\n</tr>\n<tr>\n<td># Use proxy with PhantomJS</td>\n<td></td>\n<td></td>\n<td></td>\n</tr>\n<tr>\n<td>${service args}=</td>\n<td><span class=\"name\">Create List</span></td>\n<td>--proxy=192.168.132.104:8888</td>\n<td></td>\n</tr>\n<tr>\n<td><a href=\"#Create%20Webdriver\" class=\"name\">Create Webdriver</a></td>\n<td>PhantomJS</td>\n<td>service_args=${service args}</td>\n<td></td>\n</tr>\n</table>\n<p>Returns the index of this browser instance which can be used later to switch back to it. Index starts from 1 and is reset back to it when <a href=\"#Close%20All%20Browsers\" class=\"name\">Close All Browsers</a> keyword is used. See <a href=\"#Switch%20Browser\" class=\"name\">Switch Browser</a> for an example.</p>", "shortdoc": "Creates an instance of Selenium WebDriver.", "tags": [], "source": "C:\\Python\\lib\\site-packages\\SeleniumLibrary\\keywords\\browsermanagement.py", "lineno": 347}, {"name": "Current Frame Should Contain", "args": [{"name": "text", "types": ["str"], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "text: str"}, {"name": "loglevel", "types": ["str"], "defaultValue": "TRACE", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "loglevel: str = TRACE"}], "doc": "<p>Verifies that the current frame contains <code>text</code>.</p>\n<p>See <a href=\"#Page%20Should%20Contain\" class=\"name\">Page Should Contain</a> for an explanation about the <code>loglevel</code> argument.</p>\n<p>Prior to SeleniumLibrary 3.0 this keyword was named <span class=\"name\">Current Frame Contains</span>.</p>", "shortdoc": "Verifies that the current frame contains ``text``.", "tags": [], "source": "C:\\Python\\lib\\site-packages\\SeleniumLibrary\\keywords\\frames.py", "lineno": 53}, {"name": "Current Frame Should Not Contain", "args": [{"name": "text", "types": ["str"], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "text: str"}, {"name": "loglevel", "types": ["str"], "defaultValue": "TRACE", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "loglevel: str = TRACE"}], "doc": "<p>Verifies that the current frame does not contain <code>text</code>.</p>\n<p>See <a href=\"#Page%20Should%20Contain\" class=\"name\">Page Should Contain</a> for an explanation about the <code>loglevel</code> argument.</p>", "shortdoc": "Verifies that the current frame does not contain ``text``.", "tags": [], "source": "C:\\Python\\lib\\site-packages\\SeleniumLibrary\\keywords\\frames.py", "lineno": 70}, {"name": "Delete All Cookies", "args": [], "doc": "<p>Deletes all cookies.</p>", "shortdoc": "Deletes all cookies.", "tags": [], "source": "C:\\Python\\lib\\site-packages\\SeleniumLibrary\\keywords\\cookie.py", "lineno": 57}, {"name": "Delete Cookie", "args": [{"name": "name", "types": [], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "name"}], "doc": "<p>Deletes the cookie matching <code>name</code>.</p>\n<p>If the cookie is not found, nothing happens.</p>", "shortdoc": "Deletes the cookie matching ``name``.", "tags": [], "source": "C:\\Python\\lib\\site-packages\\SeleniumLibrary\\keywords\\cookie.py", "lineno": 62}, {"name": "Double Click Element", "args": [{"name": "locator", "types": ["WebElement", "str"], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "locator: WebElement | str"}], "doc": "<p>Double clicks the element identified by <code>locator</code>.</p>\n<p>See the <span class=\"name\">Locating elements</span> section for details about the locator syntax.</p>", "shortdoc": "Double clicks the element identified by ``locator``.", "tags": [], "source": "C:\\Python\\lib\\site-packages\\SeleniumLibrary\\keywords\\element.py", "lineno": 713}, {"name": "Drag And Drop", "args": [{"name": "locator", "types": ["WebElement", "str"], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "locator: WebElement | str"}, {"name": "target", "types": ["WebElement", "str"], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "target: WebElement | str"}], "doc": "<p>Drags the element identified by <code>locator</code> into the <code>target</code> element.</p>\n<p>The <code>locator</code> argument is the locator of the dragged element and the <code>target</code> is the locator of the target. See the <span class=\"name\">Locating elements</span> section for details about the locator syntax.</p>\n<p>Example:</p>\n<table border=\"1\">\n<tr>\n<td><a href=\"#Drag%20And%20Drop\" class=\"name\">Drag And Drop</a></td>\n<td>css:div#element</td>\n<td>css:div.target</td>\n</tr>\n</table>", "shortdoc": "Drags the element identified by ``locator`` into the ``target`` element.", "tags": [], "source": "C:\\Python\\lib\\site-packages\\SeleniumLibrary\\keywords\\element.py", "lineno": 753}, {"name": "Drag And Drop By Offset", "args": [{"name": "locator", "types": ["WebElement", "str"], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "locator: WebElement | str"}, {"name": "xoffset", "types": ["int"], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "xoffset: int"}, {"name": "yoffset", "types": ["int"], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "yoffset: int"}], "doc": "<p>Drags the element identified with <code>locator</code> by <code>xoffset/yoffset</code>.</p>\n<p>See the <span class=\"name\">Locating elements</span> section for details about the locator syntax.</p>\n<p>The element will be moved by <code>xoffset</code> and <code>yoffset</code>, each of which is a negative or positive number specifying the offset.</p>\n<p>Example:</p>\n<table border=\"1\">\n<tr>\n<td><a href=\"#Drag%20And%20Drop%20By%20Offset\" class=\"name\">Drag And Drop By Offset</a></td>\n<td>myElem</td>\n<td>50</td>\n<td>-35</td>\n<td># Move myElem 50px right and 35px down</td>\n</tr>\n</table>", "shortdoc": "Drags the element identified with ``locator`` by ``xoffset/yoffset``.", "tags": [], "source": "C:\\Python\\lib\\site-packages\\SeleniumLibrary\\keywords\\element.py", "lineno": 775}, {"name": "Element Attribute Value Should Be", "args": [{"name": "locator", "types": ["WebElement", "str"], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "locator: WebElement | str"}, {"name": "attribute", "types": ["str"], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "attribute: str"}, {"name": "expected", "types": ["None", "str"], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "expected: None | str"}, {"name": "message", "types": ["str"], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "message: str = None"}], "doc": "<p>Verifies element identified by <code>locator</code> contains expected attribute value.</p>\n<p>See the <span class=\"name\">Locating elements</span> section for details about the locator syntax.</p>\n<p>Example: <a href=\"#Element%20Attribute%20Value%20Should%20Be\" class=\"name\">Element Attribute Value Should Be</a> | css:img | href | value</p>\n<p>New in SeleniumLibrary 3.2.</p>", "shortdoc": "Verifies element identified by ``locator`` contains expected attribute value.", "tags": [], "source": "C:\\Python\\lib\\site-packages\\SeleniumLibrary\\keywords\\element.py", "lineno": 414}, {"name": "Element CSS Attribute Value Should Be", "args": [{"name": "locator", "types": [], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "locator"}, {"name": "attribute", "types": [], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "attribute"}, {"name": "expected_value", "types": [], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "expected_value"}], "doc": "<p>Get the CSS attribute value of an element and compare it to an expected value. This would be the values within the 'style' tag.</p>\n<p>locator: (string) A selenium locator(CSS, XPATH, ID, NAME, etc)</p>\n<p>attribute: (string) The attribute you wish to get the value for.</p>\n<p>expected_value: (string) The expected attribute value to be compared against the actual attribute value</p>", "shortdoc": "Get the CSS attribute value of an element and compare it to an expected value. This would be the values within the 'style' tag.", "tags": [], "source": "C:\\Git\\robotframework-zoomba\\src\\Zoomba\\GUILibrary.py", "lineno": 371}, {"name": "Element Should Be Disabled", "args": [{"name": "locator", "types": ["WebElement", "str"], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "locator: WebElement | str"}], "doc": "<p>Verifies that element identified by <code>locator</code> is disabled.</p>\n<p>This keyword considers also elements that are read-only to be disabled.</p>\n<p>See the <span class=\"name\">Locating elements</span> section for details about the locator syntax.</p>", "shortdoc": "Verifies that element identified by ``locator`` is disabled.", "tags": [], "source": "C:\\Python\\lib\\site-packages\\SeleniumLibrary\\keywords\\element.py", "lineno": 241}, {"name": "Element Should Be Enabled", "args": [{"name": "locator", "types": ["WebElement", "str"], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "locator: WebElement | str"}], "doc": "<p>Verifies that element identified by <code>locator</code> is enabled.</p>\n<p>This keyword considers also elements that are read-only to be disabled.</p>\n<p>See the <span class=\"name\">Locating elements</span> section for details about the locator syntax.</p>", "shortdoc": "Verifies that element identified by ``locator`` is enabled.", "tags": [], "source": "C:\\Python\\lib\\site-packages\\SeleniumLibrary\\keywords\\element.py", "lineno": 254}, {"name": "Element Should Be Focused", "args": [{"name": "locator", "types": ["WebElement", "str"], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "locator: WebElement | str"}], "doc": "<p>Verifies that element identified by <code>locator</code> is focused.</p>\n<p>See the <span class=\"name\">Locating elements</span> section for details about the locator syntax.</p>\n<p>New in SeleniumLibrary 3.0.</p>", "shortdoc": "Verifies that element identified by ``locator`` is focused.", "tags": [], "source": "C:\\Python\\lib\\site-packages\\SeleniumLibrary\\keywords\\element.py", "lineno": 267}, {"name": "Element Should Be Visible", "args": [{"name": "locator", "types": ["WebElement", "str"], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "locator: WebElement | str"}, {"name": "message", "types": ["str"], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "message: str = None"}], "doc": "<p>Verifies that the element identified by <code>locator</code> is visible.</p>\n<p>Herein, visible means that the element is logically visible, not optically visible in the current browser viewport. For example, an element that carries <code>display:none</code> is not logically visible, so using this keyword on that element would fail.</p>\n<p>See the <span class=\"name\">Locating elements</span> section for details about the locator syntax.</p>\n<p>The <code>message</code> argument can be used to override the default error message.</p>", "shortdoc": "Verifies that the element identified by ``locator`` is visible.", "tags": [], "source": "C:\\Python\\lib\\site-packages\\SeleniumLibrary\\keywords\\element.py", "lineno": 284}, {"name": "Element Should Contain", "args": [{"name": "locator", "types": ["WebElement", "str"], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "locator: WebElement | str"}, {"name": "expected", "types": ["None", "str"], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "expected: None | str"}, {"name": "message", "types": ["str"], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "message: str = None"}, {"name": "ignore_case", "types": ["bool"], "defaultValue": "False", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "ignore_case: bool = False"}], "doc": "<p>Verifies that element <code>locator</code> contains text <code>expected</code>.</p>\n<p>See the <span class=\"name\">Locating elements</span> section for details about the locator syntax.</p>\n<p>The <code>message</code> argument can be used to override the default error message.</p>\n<p>The <code>ignore_case</code> argument can be set to True to compare case insensitive, default is False. New in SeleniumLibrary 3.1.</p>\n<p><code>ignore_case</code> argument is new in SeleniumLibrary 3.1.</p>\n<p>Use <a href=\"#Element%20Text%20Should%20Be\" class=\"name\">Element Text Should Be</a> if you want to match the exact text, not a substring.</p>", "shortdoc": "Verifies that element ``locator`` contains text ``expected``.", "tags": [], "source": "C:\\Python\\lib\\site-packages\\SeleniumLibrary\\keywords\\element.py", "lineno": 55}, {"name": "Element Should Not Be Visible", "args": [{"name": "locator", "types": ["WebElement", "str"], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "locator: WebElement | str"}, {"name": "message", "types": ["str"], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "message: str = None"}], "doc": "<p>Verifies that the element identified by <code>locator</code> is NOT visible.</p>\n<p>Passes if the element does not exists. See <a href=\"#Element%20Should%20Be%20Visible\" class=\"name\">Element Should Be Visible</a> for more information about visibility and supported arguments.</p>", "shortdoc": "Verifies that the element identified by ``locator`` is NOT visible.", "tags": [], "source": "C:\\Python\\lib\\site-packages\\SeleniumLibrary\\keywords\\element.py", "lineno": 307}, {"name": "Element Should Not Contain", "args": [{"name": "locator", "types": ["WebElement", "str"], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "locator: WebElement | str"}, {"name": "expected", "types": ["None", "str"], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "expected: None | str"}, {"name": "message", "types": ["str"], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "message: str = None"}, {"name": "ignore_case", "types": ["bool"], "defaultValue": "False", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "ignore_case: bool = False"}], "doc": "<p>Verifies that element <code>locator</code> does not contain text <code>expected</code>.</p>\n<p>See the <span class=\"name\">Locating elements</span> section for details about the locator syntax.</p>\n<p>The <code>message</code> argument can be used to override the default error message.</p>\n<p>The <code>ignore_case</code> argument can be set to True to compare case insensitive, default is False.</p>\n<p><code>ignore_case</code> argument new in SeleniumLibrary 3.1.</p>", "shortdoc": "Verifies that element ``locator`` does not contain text ``expected``.", "tags": [], "source": "C:\\Python\\lib\\site-packages\\SeleniumLibrary\\keywords\\element.py", "lineno": 93}, {"name": "Element Text Should Be", "args": [{"name": "locator", "types": ["WebElement", "str"], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "locator: WebElement | str"}, {"name": "expected", "types": ["None", "str"], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "expected: None | str"}, {"name": "message", "types": ["str"], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "message: str = None"}, {"name": "ignore_case", "types": ["bool"], "defaultValue": "False", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "ignore_case: bool = False"}], "doc": "<p>Verifies that element <code>locator</code> contains exact the text <code>expected</code>.</p>\n<p>See the <span class=\"name\">Locating elements</span> section for details about the locator syntax.</p>\n<p>The <code>message</code> argument can be used to override the default error message.</p>\n<p>The <code>ignore_case</code> argument can be set to True to compare case insensitive, default is False.</p>\n<p><code>ignore_case</code> argument is new in SeleniumLibrary 3.1.</p>\n<p>Use <a href=\"#Element%20Should%20Contain\" class=\"name\">Element Should Contain</a> if a substring match is desired.</p>", "shortdoc": "Verifies that element ``locator`` contains exact the text ``expected``.", "tags": [], "source": "C:\\Python\\lib\\site-packages\\SeleniumLibrary\\keywords\\element.py", "lineno": 326}, {"name": "Element Text Should Not Be", "args": [{"name": "locator", "types": ["WebElement", "str"], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "locator: WebElement | str"}, {"name": "not_expected", "types": ["None", "str"], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "not_expected: None | str"}, {"name": "message", "types": ["str"], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "message: str = None"}, {"name": "ignore_case", "types": ["bool"], "defaultValue": "False", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "ignore_case: bool = False"}], "doc": "<p>Verifies that element <code>locator</code> does not contain exact the text <code>not_expected</code>.</p>\n<p>See the <span class=\"name\">Locating elements</span> section for details about the locator syntax.</p>\n<p>The <code>message</code> argument can be used to override the default error message.</p>\n<p>The <code>ignore_case</code> argument can be set to True to compare case insensitive, default is False.</p>\n<p>New in SeleniumLibrary 3.1.1</p>", "shortdoc": "Verifies that element ``locator`` does not contain exact the text ``not_expected``.", "tags": [], "source": "C:\\Python\\lib\\site-packages\\SeleniumLibrary\\keywords\\element.py", "lineno": 362}, {"name": "Element Value Should Be Equal", "args": [{"name": "locator", "types": [], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "locator"}, {"name": "expected_value", "types": [], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "expected_value"}], "doc": "<p>Assert that the value attribute of a web element is equal to a given value</p>\n<p>locator: (string) A selenium locator(CSS, XPATH, ID, NAME, etc)</p>\n<p>expected_value: (string) A string or int value to be compared against the actual web element value</p>", "shortdoc": "Assert that the value attribute of a web element is equal to a given value", "tags": [], "source": "C:\\Git\\robotframework-zoomba\\src\\Zoomba\\GUILibrary.py", "lineno": 52}, {"name": "Element Value Should Not Be Equal", "args": [{"name": "locator", "types": [], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "locator"}, {"name": "expected_value", "types": [], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "expected_value"}], "doc": "<p>Assert that the value attribute of a web element is not equal to a given value</p>\n<p>locator: (string) A selenium locator(CSS, XPATH, ID, NAME, etc)</p>\n<p>expected_value: (string) A string or int value to be compared against the actual web element value</p>", "shortdoc": "Assert that the value attribute of a web element is not equal to a given value", "tags": [], "source": "C:\\Git\\robotframework-zoomba\\src\\Zoomba\\GUILibrary.py", "lineno": 61}, {"name": "Execute Async Javascript", "args": [{"name": "code", "types": ["WebElement", "str"], "defaultValue": null, "kind": "VAR_POSITIONAL", "required": false, "repr": "*code: WebElement | str"}], "doc": "<p>Executes asynchronous JavaScript code with possible arguments.</p>\n<p>Similar to <a href=\"#Execute%20Javascript\" class=\"name\">Execute Javascript</a> except that scripts executed with this keyword must explicitly signal they are finished by invoking the provided callback. This callback is always injected into the executed function as the last argument.</p>\n<p>Scripts must complete within the script timeout or this keyword will fail. See the <span class=\"name\">Timeout</span> section for more information.</p>\n<p>Starting from SeleniumLibrary 3.2 it is possible to provide JavaScript <a href=\"https://seleniumhq.github.io/selenium/docs/api/py/webdriver_remote/selenium.webdriver.remote.webdriver.html#selenium.webdriver.remote.webdriver.WebDriver.execute_async_script\">arguments</a> as part of <code>code</code> argument. See <a href=\"#Execute%20Javascript\" class=\"name\">Execute Javascript</a> for more details.</p>\n<p>Examples:</p>\n<table border=\"1\">\n<tr>\n<td><a href=\"#Execute%20Async%20Javascript\" class=\"name\">Execute Async JavaScript</a></td>\n<td>var callback = arguments[arguments.length - 1]; window.setTimeout(callback, 2000);</td>\n<td></td>\n</tr>\n<tr>\n<td><a href=\"#Execute%20Async%20Javascript\" class=\"name\">Execute Async JavaScript</a></td>\n<td>${CURDIR}/async_js_to_execute.js</td>\n<td></td>\n</tr>\n<tr>\n<td>${result} =</td>\n<td><a href=\"#Execute%20Async%20Javascript\" class=\"name\">Execute Async JavaScript</a></td>\n<td></td>\n</tr>\n<tr>\n<td>...</td>\n<td>var callback = arguments[arguments.length - 1];</td>\n<td></td>\n</tr>\n<tr>\n<td>...</td>\n<td>function answer(){callback(\"text\");};</td>\n<td></td>\n</tr>\n<tr>\n<td>...</td>\n<td>window.setTimeout(answer, 2000);</td>\n<td></td>\n</tr>\n<tr>\n<td><span class=\"name\">Should Be Equal</span></td>\n<td>${result}</td>\n<td>text</td>\n</tr>\n</table>", "shortdoc": "Executes asynchronous JavaScript code with possible arguments.", "tags": [], "source": "C:\\Python\\lib\\site-packages\\SeleniumLibrary\\keywords\\javascript.py", "lineno": 76}, {"name": "Execute Javascript", "args": [{"name": "code", "types": ["WebElement", "str"], "defaultValue": null, "kind": "VAR_POSITIONAL", "required": false, "repr": "*code: WebElement | str"}], "doc": "<p>Executes the given JavaScript code with possible arguments.</p>\n<p><code>code</code> may be divided into multiple cells in the test data and <code>code</code> may contain multiple lines of code and arguments. In that case, the JavaScript code parts are concatenated together without adding spaces and optional arguments are separated from <code>code</code>.</p>\n<p>If <code>code</code> is a path to an existing file, the JavaScript to execute will be read from that file. Forward slashes work as a path separator on all operating systems.</p>\n<p>The JavaScript executes in the context of the currently selected frame or window as the body of an anonymous function. Use <code>window</code> to refer to the window of your application and <code>document</code> to refer to the document object of the current frame or window, e.g. <code>document.getElementById('example')</code>.</p>\n<p>This keyword returns whatever the executed JavaScript code returns. Return values are converted to the appropriate Python types.</p>\n<p>Starting from SeleniumLibrary 3.2 it is possible to provide JavaScript <a href=\"https://seleniumhq.github.io/selenium/docs/api/py/webdriver_remote/selenium.webdriver.remote.webdriver.html#selenium.webdriver.remote.webdriver.WebDriver.execute_script\">arguments</a> as part of <code>code</code> argument. The JavaScript code and arguments must be separated with <span class=\"name\">JAVASCRIPT</span> and <span class=\"name\">ARGUMENTS</span> markers and must be used exactly with this format. If the Javascript code is first, then the <span class=\"name\">JAVASCRIPT</span> marker is optional. The order of <span class=\"name\">JAVASCRIPT</span> and <span class=\"name\">ARGUMENTS</span> markers can be swapped, but if <span class=\"name\">ARGUMENTS</span> is the first marker, then <span class=\"name\">JAVASCRIPT</span> marker is mandatory. It is only allowed to use <span class=\"name\">JAVASCRIPT</span> and <span class=\"name\">ARGUMENTS</span> markers only one time in the <code>code</code> argument.</p>\n<p>Examples:</p>\n<table border=\"1\">\n<tr>\n<td><a href=\"#Execute%20Javascript\" class=\"name\">Execute JavaScript</a></td>\n<td>window.myFunc('arg1', 'arg2')</td>\n<td></td>\n<td></td>\n<td></td>\n</tr>\n<tr>\n<td><a href=\"#Execute%20Javascript\" class=\"name\">Execute JavaScript</a></td>\n<td>${CURDIR}/js_to_execute.js</td>\n<td></td>\n<td></td>\n<td></td>\n</tr>\n<tr>\n<td><a href=\"#Execute%20Javascript\" class=\"name\">Execute JavaScript</a></td>\n<td>alert(arguments[0]);</td>\n<td>ARGUMENTS</td>\n<td>123</td>\n<td></td>\n</tr>\n<tr>\n<td><a href=\"#Execute%20Javascript\" class=\"name\">Execute JavaScript</a></td>\n<td>ARGUMENTS</td>\n<td>123</td>\n<td>JAVASCRIPT</td>\n<td>alert(arguments[0]);</td>\n</tr>\n</table>", "shortdoc": "Executes the given JavaScript code with possible arguments.", "tags": [], "source": "C:\\Python\\lib\\site-packages\\SeleniumLibrary\\keywords\\javascript.py", "lineno": 33}, {"name": "Frame Should Contain", "args": [{"name": "locator", "types": ["WebElement", "str"], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "locator: WebElement | str"}, {"name": "text", "types": ["str"], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "text: str"}, {"name": "loglevel", "types": ["str"], "defaultValue": "TRACE", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "loglevel: str = TRACE"}], "doc": "<p>Verifies that frame identified by <code>locator</code> contains <code>text</code>.</p>\n<p>See the <span class=\"name\">Locating elements</span> section for details about the locator syntax.</p>\n<p>See <a href=\"#Page%20Should%20Contain\" class=\"name\">Page Should Contain</a> for an explanation about the <code>loglevel</code> argument.</p>", "shortdoc": "Verifies that frame identified by ``locator`` contains ``text``.", "tags": [], "source": "C:\\Python\\lib\\site-packages\\SeleniumLibrary\\keywords\\frames.py", "lineno": 84}, {"name": "Get All Links", "args": [], "doc": "<p>Returns a list containing ids of all links found in current page.</p>\n<p>If a link has no id, an empty string will be in the list instead.</p>", "shortdoc": "Returns a list containing ids of all links found in current page.", "tags": [], "source": "C:\\Python\\lib\\site-packages\\SeleniumLibrary\\keywords\\element.py", "lineno": 993}, {"name": "Get Browser Aliases", "args": [], "doc": "<p>Returns aliases of all active browser that has an alias as NormalizedDict. The dictionary contains the aliases as keys and the index as value. This can be accessed as dictionary <code>${aliases.key}</code> or as list <code>@{aliases}[0]</code>.</p>\n<p>Example:</p>\n<table border=\"1\">\n<tr>\n<td><a href=\"#Open%20Browser\" class=\"name\">Open Browser</a></td>\n<td><a href=\"https://example.com\">https://example.com</a></td>\n<td>alias=BrowserA</td>\n<td></td>\n</tr>\n<tr>\n<td><a href=\"#Open%20Browser\" class=\"name\">Open Browser</a></td>\n<td><a href=\"https://example.com\">https://example.com</a></td>\n<td>alias=BrowserB</td>\n<td></td>\n</tr>\n<tr>\n<td>&amp;{aliases}</td>\n<td><a href=\"#Get%20Browser%20Aliases\" class=\"name\">Get Browser Aliases</a></td>\n<td></td>\n<td># &amp;{aliases} = { BrowserA=1|BrowserB=2 }</td>\n</tr>\n<tr>\n<td><span class=\"name\">Log</span></td>\n<td>${aliases.BrowserA}</td>\n<td></td>\n<td># logs <code>1</code></td>\n</tr>\n<tr>\n<td>FOR</td>\n<td>${alias}</td>\n<td>IN</td>\n<td>@{aliases}</td>\n</tr>\n<tr>\n<td></td>\n<td><span class=\"name\">Log</span></td>\n<td>${alias}</td>\n<td># logs <code>BrowserA</code> and <code>BrowserB</code></td>\n</tr>\n<tr>\n<td>END</td>\n<td></td>\n<td></td>\n<td></td>\n</tr>\n</table>\n<p>See <a href=\"#Switch%20Browser\" class=\"name\">Switch Browser</a> for more information and examples.</p>\n<p>New in SeleniumLibrary 4.0</p>", "shortdoc": "Returns aliases of all active browser that has an alias as NormalizedDict. The dictionary contains the aliases as keys and the index as value. This can be accessed as dictionary ``${aliases.key}`` or as list ``@{aliases}[0]``.", "tags": [], "source": "C:\\Python\\lib\\site-packages\\SeleniumLibrary\\keywords\\browsermanagement.py", "lineno": 459}, {"name": "Get Browser Ids", "args": [], "doc": "<p>Returns index of all active browser as list.</p>\n<p>Example:</p>\n<table border=\"1\">\n<tr>\n<td>@{browser_ids}=</td>\n<td>Get Browser Ids</td>\n<td></td>\n<td></td>\n</tr>\n<tr>\n<td>FOR</td>\n<td>${id}</td>\n<td>IN</td>\n<td>@{browser_ids}</td>\n</tr>\n<tr>\n<td></td>\n<td>@{window_titles}=</td>\n<td>Get Window Titles</td>\n<td>browser=${id}</td>\n</tr>\n<tr>\n<td></td>\n<td>Log</td>\n<td>Browser ${id} has these windows: ${window_titles}</td>\n<td></td>\n</tr>\n<tr>\n<td>END</td>\n<td></td>\n<td></td>\n<td></td>\n</tr>\n</table>\n<p>See <a href=\"#Switch%20Browser\" class=\"name\">Switch Browser</a> for more information and examples.</p>\n<p>New in SeleniumLibrary 4.0</p>", "shortdoc": "Returns index of all active browser as list.", "tags": [], "source": "C:\\Python\\lib\\site-packages\\SeleniumLibrary\\keywords\\browsermanagement.py", "lineno": 442}, {"name": "Get Cookie", "args": [{"name": "name", "types": ["str"], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "name: str"}], "doc": "<p>Returns information of cookie with <code>name</code> as an object.</p>\n<p>If no cookie is found with <code>name</code>, keyword fails. The cookie object contains details about the cookie. Attributes available in the object are documented in the table below.</p>\n<table border=\"1\">\n<tr>\n<th>Attribute</th>\n<th>Explanation</th>\n</tr>\n<tr>\n<td>name</td>\n<td>The name of a cookie.</td>\n</tr>\n<tr>\n<td>value</td>\n<td>Value of the cookie.</td>\n</tr>\n<tr>\n<td>path</td>\n<td>Indicates a URL path, for example <code>/</code>.</td>\n</tr>\n<tr>\n<td>domain</td>\n<td>The domain, the cookie is visible to.</td>\n</tr>\n<tr>\n<td>secure</td>\n<td>When true, the cookie is only used with HTTPS connections.</td>\n</tr>\n<tr>\n<td>httpOnly</td>\n<td>When true, the cookie is not accessible via JavaScript.</td>\n</tr>\n<tr>\n<td>expiry</td>\n<td>Python datetime object indicating when the cookie expires.</td>\n</tr>\n<tr>\n<td>extra</td>\n<td>Possible attributes outside of the WebDriver specification</td>\n</tr>\n</table>\n<p>See the <a href=\"https://w3c.github.io/webdriver/#cookies\">WebDriver specification</a> for details about the cookie information. Notice that <code>expiry</code> is specified as a <a href=\"https://docs.python.org/3/library/datetime.html#datetime.datetime\">datetime object</a>, not as seconds since Unix Epoch like WebDriver natively does.</p>\n<p>In some cases, example when running a browser in the cloud, it is possible that the cookie contains other attributes than is defined in the <a href=\"https://w3c.github.io/webdriver/#cookies\">WebDriver specification</a>. These other attributes are available in an <code>extra</code> attribute in the cookie object and it contains a dictionary of the other attributes. The <code>extra</code> attribute is new in SeleniumLibrary 4.0.</p>\n<p>Example:</p>\n<table border=\"1\">\n<tr>\n<td><a href=\"#Add%20Cookie\" class=\"name\">Add Cookie</a></td>\n<td>foo</td>\n<td>bar</td>\n</tr>\n<tr>\n<td>${cookie} =</td>\n<td><a href=\"#Get%20Cookie\" class=\"name\">Get Cookie</a></td>\n<td>foo</td>\n</tr>\n<tr>\n<td><span class=\"name\">Should Be Equal</span></td>\n<td>${cookie.name}</td>\n<td>foo</td>\n</tr>\n<tr>\n<td><span class=\"name\">Should Be Equal</span></td>\n<td>${cookie.value}</td>\n<td>bar</td>\n</tr>\n<tr>\n<td><span class=\"name\">Should Be True</span></td>\n<td>${cookie.expiry.year} &gt; 2017</td>\n<td></td>\n</tr>\n</table>\n<p>New in SeleniumLibrary 3.0.</p>", "shortdoc": "Returns information of cookie with ``name`` as an object.", "tags": [], "source": "C:\\Python\\lib\\site-packages\\SeleniumLibrary\\keywords\\cookie.py", "lineno": 97}, {"name": "Get Cookies", "args": [{"name": "as_dict", "types": ["bool"], "defaultValue": "False", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "as_dict: bool = False"}], "doc": "<p>Returns all cookies of the current page.</p>\n<p>If <code>as_dict</code> argument evaluates as false, see <span class=\"name\">Boolean arguments</span> for more details, then cookie information is returned as a single string in format <code>name1=value1; name2=value2; name3=value3</code>. When <code>as_dict</code> argument evaluates as true, cookie information is returned as Robot Framework dictionary format. The string format can be used, for example, for logging purposes or in headers when sending HTTP requests. The dictionary format is helpful when the result can be passed to requests library's Create Session keyword's optional cookies parameter.</p>\n<p>The <span class=\"name\">` as_dict</span>` argument is new in SeleniumLibrary 3.3</p>", "shortdoc": "Returns all cookies of the current page.", "tags": [], "source": "C:\\Python\\lib\\site-packages\\SeleniumLibrary\\keywords\\cookie.py", "lineno": 70}, {"name": "Get Element Attribute", "args": [{"name": "locator", "types": ["WebElement", "str"], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "locator: WebElement | str"}, {"name": "attribute", "types": ["str"], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "attribute: str"}], "doc": "<p>Returns the value of <code>attribute</code> from the element <code>locator</code>.</p>\n<p>See the <span class=\"name\">Locating elements</span> section for details about the locator syntax.</p>\n<p>Example:</p>\n<table border=\"1\">\n<tr>\n<td>${id}=</td>\n<td><a href=\"#Get%20Element%20Attribute\" class=\"name\">Get Element Attribute</a></td>\n<td>css:h1</td>\n<td>id</td>\n</tr>\n</table>\n<p>Passing attribute name as part of the <code>locator</code> was removed in SeleniumLibrary 3.2. The explicit <code>attribute</code> argument should be used instead.</p>", "shortdoc": "Returns the value of ``attribute`` from the element ``locator``.", "tags": [], "source": "C:\\Python\\lib\\site-packages\\SeleniumLibrary\\keywords\\element.py", "lineno": 396}, {"name": "Get Element Count", "args": [{"name": "locator", "types": ["WebElement", "str"], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "locator: WebElement | str"}], "doc": "<p>Returns the number of elements matching <code>locator</code>.</p>\n<p>If you wish to assert the number of matching elements, use <a href=\"#Page%20Should%20Contain%20Element\" class=\"name\">Page Should Contain Element</a> with <code>limit</code> argument. Keyword will always return an integer.</p>\n<p>Example:</p>\n<table border=\"1\">\n<tr>\n<td>${count} =</td>\n<td><a href=\"#Get%20Element%20Count\" class=\"name\">Get Element Count</a></td>\n<td>name:div_name</td>\n</tr>\n<tr>\n<td><span class=\"name\">Should Be True</span></td>\n<td>${count} &gt; 2</td>\n<td></td>\n</tr>\n</table>\n<p>New in SeleniumLibrary 3.0.</p>", "shortdoc": "Returns the number of elements matching ``locator``.", "tags": [], "source": "C:\\Python\\lib\\site-packages\\SeleniumLibrary\\keywords\\element.py", "lineno": 1102}, {"name": "Get Element CSS Attribute Value", "args": [{"name": "locator", "types": [], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "locator"}, {"name": "attribute", "types": [], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "attribute"}], "doc": "<p>Get the CSS attribute value of an element. This would be the values within the 'style' tag.</p>\n<p>locator: (string) A selenium locator(CSS, XPATH, ID, NAME, etc)</p>\n<p>attribute: (string) The attribute you wish to get the value for.</p>", "shortdoc": "Get the CSS attribute value of an element. This would be the values within the 'style' tag.", "tags": [], "source": "C:\\Git\\robotframework-zoomba\\src\\Zoomba\\GUILibrary.py", "lineno": 359}, {"name": "Get Element Size", "args": [{"name": "locator", "types": ["WebElement", "str"], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "locator: WebElement | str"}], "doc": "<p>Returns width and height of the element identified by <code>locator</code>.</p>\n<p>See the <span class=\"name\">Locating elements</span> section for details about the locator syntax.</p>\n<p>Both width and height are returned as integers.</p>\n<p>Example:</p>\n<table border=\"1\">\n<tr>\n<td>${width}</td>\n<td>${height} =</td>\n<td><a href=\"#Get%20Element%20Size\" class=\"name\">Get Element Size</a></td>\n<td>css:div#container</td>\n</tr>\n</table>", "shortdoc": "Returns width and height of the element identified by ``locator``.", "tags": [], "source": "C:\\Python\\lib\\site-packages\\SeleniumLibrary\\keywords\\element.py", "lineno": 459}, {"name": "Get Horizontal Position", "args": [{"name": "locator", "types": ["WebElement", "str"], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "locator: WebElement | str"}], "doc": "<p>Returns the horizontal position of the element identified by <code>locator</code>.</p>\n<p>See the <span class=\"name\">Locating elements</span> section for details about the locator syntax.</p>\n<p>The position is returned in pixels off the left side of the page, as an integer.</p>\n<p>See also <a href=\"#Get%20Vertical%20Position\" class=\"name\">Get Vertical Position</a>.</p>", "shortdoc": "Returns the horizontal position of the element identified by ``locator``.", "tags": [], "source": "C:\\Python\\lib\\site-packages\\SeleniumLibrary\\keywords\\element.py", "lineno": 445}, {"name": "Get List Items", "args": [{"name": "locator", "types": ["WebElement", "str"], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "locator: WebElement | str"}, {"name": "values", "types": ["bool"], "defaultValue": "False", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "values: bool = False"}], "doc": "<p>Returns all labels or values of selection list <code>locator</code>.</p>\n<p>See the <span class=\"name\">Locating elements</span> section for details about the locator syntax.</p>\n<p>Returns visible labels by default, but values can be returned by setting the <code>values</code> argument to a true value (see <span class=\"name\">Boolean arguments</span>).</p>\n<p>Example:</p>\n<table border=\"1\">\n<tr>\n<td>${labels} =</td>\n<td><a href=\"#Get%20List%20Items\" class=\"name\">Get List Items</a></td>\n<td>mylist</td>\n<td></td>\n</tr>\n<tr>\n<td>${values} =</td>\n<td><a href=\"#Get%20List%20Items\" class=\"name\">Get List Items</a></td>\n<td>css:#example select</td>\n<td>values=True</td>\n</tr>\n</table>\n<p>Support to return values is new in SeleniumLibrary 3.0.</p>", "shortdoc": "Returns all labels or values of selection list ``locator``.", "tags": [], "source": "C:\\Python\\lib\\site-packages\\SeleniumLibrary\\keywords\\selectelement.py", "lineno": 27}, {"name": "Get Location", "args": [], "doc": "<p>Returns the current browser window URL.</p>", "shortdoc": "Returns the current browser window URL.", "tags": [], "source": "C:\\Python\\lib\\site-packages\\SeleniumLibrary\\keywords\\browsermanagement.py", "lineno": 498}, {"name": "Get Locations", "args": [{"name": "browser", "types": ["str"], "defaultValue": "CURRENT", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "browser: str = CURRENT"}], "doc": "<p>Returns and logs URLs of all windows of the selected browser.</p>\n<p><b>Browser Scope:</b></p>\n<p>The <code>browser</code> argument specifies the browser that shall return its windows information.</p>\n<ul>\n<li><code>browser</code> can be <code>index_or_alias</code> like in <a href=\"#Switch%20Browser\" class=\"name\">Switch Browser</a>.</li>\n</ul>\n<ul>\n<li>If <code>browser</code> is <code>CURRENT</code> (default, case-insensitive) the currently active browser is selected.</li>\n</ul>\n<ul>\n<li>If <code>browser</code> is <code>ALL</code> (case-insensitive) the window information of all windows of all opened browsers are returned.</li>\n</ul>", "shortdoc": "Returns and logs URLs of all windows of the selected browser.", "tags": [], "source": "C:\\Python\\lib\\site-packages\\SeleniumLibrary\\keywords\\window.py", "lineno": 166}, {"name": "Get React List Labels", "args": [{"name": "locator", "types": [], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "locator"}], "doc": "<p>This keyword grabs the labels from a React-Select list. See <a href=\"https://react-select.com/home\">https://react-select.com/home</a> for more information on React-Select components.</p>\n<p>locator: (string) A selenium locator(CSS, XPATH, ID, NAME, etc)</p>", "shortdoc": "This keyword grabs the labels from a React-Select list. See https://react-select.com/home for more information on React-Select components.", "tags": [], "source": "C:\\Git\\robotframework-zoomba\\src\\Zoomba\\GUILibrary.py", "lineno": 386}, {"name": "Get Selected List Label", "args": [{"name": "locator", "types": ["WebElement", "str"], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "locator: WebElement | str"}], "doc": "<p>Returns the label of selected option from selection list <code>locator</code>.</p>\n<p>If there are multiple selected options, the label of the first option is returned.</p>\n<p>See the <span class=\"name\">Locating elements</span> section for details about the locator syntax.</p>", "shortdoc": "Returns the label of selected option from selection list ``locator``.", "tags": [], "source": "C:\\Python\\lib\\site-packages\\SeleniumLibrary\\keywords\\selectelement.py", "lineno": 52}, {"name": "Get Selected List Labels", "args": [{"name": "locator", "types": ["WebElement", "str"], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "locator: WebElement | str"}], "doc": "<p>Returns labels of selected options from selection list <code>locator</code>.</p>\n<p>Starting from SeleniumLibrary 3.0, returns an empty list if there are no selections. In earlier versions, this caused an error.</p>\n<p>See the <span class=\"name\">Locating elements</span> section for details about the locator syntax.</p>", "shortdoc": "Returns labels of selected options from selection list ``locator``.", "tags": [], "source": "C:\\Python\\lib\\site-packages\\SeleniumLibrary\\keywords\\selectelement.py", "lineno": 65}, {"name": "Get Selected List Value", "args": [{"name": "locator", "types": ["WebElement", "str"], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "locator: WebElement | str"}], "doc": "<p>Returns the value of selected option from selection list <code>locator</code>.</p>\n<p>If there are multiple selected options, the value of the first option is returned.</p>\n<p>See the <span class=\"name\">Locating elements</span> section for details about the locator syntax.</p>", "shortdoc": "Returns the value of selected option from selection list ``locator``.", "tags": [], "source": "C:\\Python\\lib\\site-packages\\SeleniumLibrary\\keywords\\selectelement.py", "lineno": 78}, {"name": "Get Selected List Values", "args": [{"name": "locator", "types": ["WebElement", "str"], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "locator: WebElement | str"}], "doc": "<p>Returns values of selected options from selection list <code>locator</code>.</p>\n<p>Starting from SeleniumLibrary 3.0, returns an empty list if there are no selections. In earlier versions, this caused an error.</p>\n<p>See the <span class=\"name\">Locating elements</span> section for details about the locator syntax.</p>", "shortdoc": "Returns values of selected options from selection list ``locator``.", "tags": [], "source": "C:\\Python\\lib\\site-packages\\SeleniumLibrary\\keywords\\selectelement.py", "lineno": 91}, {"name": "Get Selenium Implicit Wait", "args": [], "doc": "<p>Gets the implicit wait value used by Selenium.</p>\n<p>The value is returned as a human-readable string like <code>1 second</code>.</p>\n<p>See the <span class=\"name\">Implicit wait</span> section above for more information.</p>", "shortdoc": "Gets the implicit wait value used by Selenium.", "tags": [], "source": "C:\\Python\\lib\\site-packages\\SeleniumLibrary\\keywords\\browsermanagement.py", "lineno": 620}, {"name": "Get Selenium Speed", "args": [], "doc": "<p>Gets the delay that is waited after each Selenium command.</p>\n<p>The value is returned as a human-readable string like <code>1 second</code>.</p>\n<p>See the <span class=\"name\">Selenium Speed</span> section above for more information.</p>", "shortdoc": "Gets the delay that is waited after each Selenium command.", "tags": [], "source": "C:\\Python\\lib\\site-packages\\SeleniumLibrary\\keywords\\browsermanagement.py", "lineno": 600}, {"name": "Get Selenium Timeout", "args": [], "doc": "<p>Gets the timeout that is used by various keywords.</p>\n<p>The value is returned as a human-readable string like <code>1 second</code>.</p>\n<p>See the <span class=\"name\">Timeout</span> section above for more information.</p>", "shortdoc": "Gets the timeout that is used by various keywords.", "tags": [], "source": "C:\\Python\\lib\\site-packages\\SeleniumLibrary\\keywords\\browsermanagement.py", "lineno": 610}, {"name": "Get Session Id", "args": [], "doc": "<p>Returns the currently active browser session id.</p>\n<p>New in SeleniumLibrary 3.2</p>", "shortdoc": "Returns the currently active browser session id.", "tags": [], "source": "C:\\Python\\lib\\site-packages\\SeleniumLibrary\\keywords\\browsermanagement.py", "lineno": 480}, {"name": "Get Source", "args": [], "doc": "<p>Returns the entire HTML source of the current page or frame.</p>", "shortdoc": "Returns the entire HTML source of the current page or frame.", "tags": [], "source": "C:\\Python\\lib\\site-packages\\SeleniumLibrary\\keywords\\browsermanagement.py", "lineno": 488}, {"name": "Get Table Cell", "args": [{"name": "locator", "types": ["WebElement", "None", "str"], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "locator: WebElement | None | str"}, {"name": "row", "types": ["int"], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "row: int"}, {"name": "column", "types": ["int"], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "column: int"}, {"name": "loglevel", "types": ["str"], "defaultValue": "TRACE", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "loglevel: str = TRACE"}], "doc": "<p>Returns contents of a table cell.</p>\n<p>The table is located using the <code>locator</code> argument and its cell found using <code>row</code> and <code>column</code>. See the <span class=\"name\">Locating elements</span> section for details about the locator syntax.</p>\n<p>Both row and column indexes start from 1, and header and footer rows are included in the count. It is possible to refer to rows and columns from the end by using negative indexes so that -1 is the last row/column, -2 is the second last, and so on.</p>\n<p>All <code>&lt;th&gt;</code> and <code>&lt;td&gt;</code> elements anywhere in the table are considered to be cells.</p>\n<p>See <a href=\"#Page%20Should%20Contain\" class=\"name\">Page Should Contain</a> for an explanation about the <code>loglevel</code> argument.</p>", "shortdoc": "Returns contents of a table cell.", "tags": [], "source": "C:\\Python\\lib\\site-packages\\SeleniumLibrary\\keywords\\tableelement.py", "lineno": 26}, {"name": "Get Text", "args": [{"name": "locator", "types": ["WebElement", "str"], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "locator: WebElement | str"}], "doc": "<p>Returns the text value of the element identified by <code>locator</code>.</p>\n<p>See the <span class=\"name\">Locating elements</span> section for details about the locator syntax.</p>", "shortdoc": "Returns the text value of the element identified by ``locator``.", "tags": [], "source": "C:\\Python\\lib\\site-packages\\SeleniumLibrary\\keywords\\element.py", "lineno": 515}, {"name": "Get Text From Web Elements List", "args": [{"name": "web_elements_list", "types": [], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "web_elements_list"}], "doc": "<p>This keyword extracts the HTML text of a list of web elements, and returns a list.</p>\n<p>web_elements_list: (array of selenium web elements) A selenium web element objects list.</p>\n<p>return: (array of strings) A list of strings extracted from the web elements.</p>", "shortdoc": "This keyword extracts the HTML text of a list of web elements, and returns a list.", "tags": [], "source": "C:\\Git\\robotframework-zoomba\\src\\Zoomba\\GUILibrary.py", "lineno": 264}, {"name": "Get Title", "args": [], "doc": "<p>Returns the title of the current page.</p>", "shortdoc": "Returns the title of the current page.", "tags": [], "source": "C:\\Python\\lib\\site-packages\\SeleniumLibrary\\keywords\\browsermanagement.py", "lineno": 493}, {"name": "Get Value", "args": [{"name": "locator", "types": ["WebElement", "str"], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "locator: WebElement | str"}], "doc": "<p>Returns the value attribute of the element identified by <code>locator</code>.</p>\n<p>See the <span class=\"name\">Locating elements</span> section for details about the locator syntax.</p>", "shortdoc": "Returns the value attribute of the element identified by ``locator``.", "tags": [], "source": "C:\\Python\\lib\\site-packages\\SeleniumLibrary\\keywords\\element.py", "lineno": 506}, {"name": "Get Values From Web Elements List", "args": [{"name": "web_elements_list", "types": [], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "web_elements_list"}], "doc": "<p>This keyword extracts the HTML value of a list of web elements, and returns a list.</p>\n<p>web_elements_list: (array of selenium web elements) A selenium web element objects list.</p>\n<p>return: (array of strings) A list of strings extracted from the web elements.</p>", "shortdoc": "This keyword extracts the HTML value of a list of web elements, and returns a list.", "tags": [], "source": "C:\\Git\\robotframework-zoomba\\src\\Zoomba\\GUILibrary.py", "lineno": 276}, {"name": "Get Vertical Position", "args": [{"name": "locator", "types": ["WebElement", "str"], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "locator: WebElement | str"}], "doc": "<p>Returns the vertical position of the element identified by <code>locator</code>.</p>\n<p>See the <span class=\"name\">Locating elements</span> section for details about the locator syntax.</p>\n<p>The position is returned in pixels off the top of the page, as an integer.</p>\n<p>See also <a href=\"#Get%20Horizontal%20Position\" class=\"name\">Get Horizontal Position</a>.</p>", "shortdoc": "Returns the vertical position of the element identified by ``locator``.", "tags": [], "source": "C:\\Python\\lib\\site-packages\\SeleniumLibrary\\keywords\\element.py", "lineno": 533}, {"name": "Get Vertical Position From Web Elements List", "args": [{"name": "web_elements_list", "types": [], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "web_elements_list"}], "doc": "<p>This keyword extracts the vertical position in pixels of a list of web elements, and returns a list.</p>\n<p>web_elements_list: (array of selenium web elements) A selenium web element objects list.</p>\n<p>return: (array of integers) A list of integers of the vertical pixel positions for the provided web elements.</p>", "shortdoc": "This keyword extracts the vertical position in pixels of a list of web elements, and returns a list.", "tags": [], "source": "C:\\Git\\robotframework-zoomba\\src\\Zoomba\\GUILibrary.py", "lineno": 288}, {"name": "Get WebElement", "args": [{"name": "locator", "types": ["WebElement", "str"], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "locator: WebElement | str"}], "doc": "<p>Returns the first WebElement matching the given <code>locator</code>.</p>\n<p>See the <span class=\"name\">Locating elements</span> section for details about the locator syntax.</p>", "shortdoc": "Returns the first WebElement matching the given ``locator``.", "tags": [], "source": "C:\\Python\\lib\\site-packages\\SeleniumLibrary\\keywords\\element.py", "lineno": 33}, {"name": "Get WebElements", "args": [{"name": "locator", "types": ["WebElement", "str"], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "locator: WebElement | str"}], "doc": "<p>Returns a list of WebElement objects matching the <code>locator</code>.</p>\n<p>See the <span class=\"name\">Locating elements</span> section for details about the locator syntax.</p>\n<p>Starting from SeleniumLibrary 3.0, the keyword returns an empty list if there are no matching elements. In previous releases, the keyword failed in this case.</p>", "shortdoc": "Returns a list of WebElement objects matching the ``locator``.", "tags": [], "source": "C:\\Python\\lib\\site-packages\\SeleniumLibrary\\keywords\\element.py", "lineno": 42}, {"name": "Get Window Handles", "args": [{"name": "browser", "types": ["str"], "defaultValue": "CURRENT", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "browser: str = CURRENT"}], "doc": "<p>Returns all child window handles of the selected browser as a list.</p>\n<p>Can be used as a list of windows to exclude with <span class=\"name\">Select Window</span>.</p>\n<p>How to select the <code>browser</code> scope of this keyword, see <a href=\"#Get%20Locations\" class=\"name\">Get Locations</a>.</p>\n<p>Prior to SeleniumLibrary 3.0, this keyword was named <span class=\"name\">List Windows</span>.</p>", "shortdoc": "Returns all child window handles of the selected browser as a list.", "tags": [], "source": "C:\\Python\\lib\\site-packages\\SeleniumLibrary\\keywords\\window.py", "lineno": 130}, {"name": "Get Window Identifiers", "args": [{"name": "browser", "types": ["str"], "defaultValue": "CURRENT", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "browser: str = CURRENT"}], "doc": "<p>Returns and logs id attributes of all windows of the selected browser.</p>\n<p>How to select the <code>browser</code> scope of this keyword, see <a href=\"#Get%20Locations\" class=\"name\">Get Locations</a>.</p>", "shortdoc": "Returns and logs id attributes of all windows of the selected browser.", "tags": [], "source": "C:\\Python\\lib\\site-packages\\SeleniumLibrary\\keywords\\window.py", "lineno": 142}, {"name": "Get Window Names", "args": [{"name": "browser", "types": ["str"], "defaultValue": "CURRENT", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "browser: str = CURRENT"}], "doc": "<p>Returns and logs names of all windows of the selected browser.</p>\n<p>How to select the <code>browser</code> scope of this keyword, see <a href=\"#Get%20Locations\" class=\"name\">Get Locations</a>.</p>", "shortdoc": "Returns and logs names of all windows of the selected browser.", "tags": [], "source": "C:\\Python\\lib\\site-packages\\SeleniumLibrary\\keywords\\window.py", "lineno": 150}, {"name": "Get Window Position", "args": [], "doc": "<p>Returns current window position.</p>\n<p>The position is relative to the top left corner of the screen. Returned values are integers. See also <a href=\"#Set%20Window%20Position\" class=\"name\">Set Window Position</a>.</p>\n<p>Example:</p>\n<table border=\"1\">\n<tr>\n<td>${x}</td>\n<td>${y}=</td>\n<td><a href=\"#Get%20Window%20Position\" class=\"name\">Get Window Position</a></td>\n</tr>\n</table>", "shortdoc": "Returns current window position.", "tags": [], "source": "C:\\Python\\lib\\site-packages\\SeleniumLibrary\\keywords\\window.py", "lineno": 256}, {"name": "Get Window Size", "args": [{"name": "inner", "types": ["bool"], "defaultValue": "False", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "inner: bool = False"}], "doc": "<p>Returns current window width and height as integers.</p>\n<p>See also <a href=\"#Set%20Window%20Size\" class=\"name\">Set Window Size</a>.</p>\n<p>If <code>inner</code> parameter is set to True, keyword returns HTML DOM window.innerWidth and window.innerHeight properties. See <span class=\"name\">Boolean arguments</span> for more details on how to set boolean arguments. The <code>inner</code> is new in SeleniumLibrary 4.0.</p>\n<p>Example:</p>\n<table border=\"1\">\n<tr>\n<td>${width}</td>\n<td>${height}=</td>\n<td><a href=\"#Get%20Window%20Size\" class=\"name\">Get Window Size</a></td>\n<td></td>\n</tr>\n<tr>\n<td>${width}</td>\n<td>${height}=</td>\n<td><a href=\"#Get%20Window%20Size\" class=\"name\">Get Window Size</a></td>\n<td>True</td>\n</tr>\n</table>", "shortdoc": "Returns current window width and height as integers.", "tags": [], "source": "C:\\Python\\lib\\site-packages\\SeleniumLibrary\\keywords\\window.py", "lineno": 190}, {"name": "Get Window Titles", "args": [{"name": "browser", "types": ["str"], "defaultValue": "CURRENT", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "browser: str = CURRENT"}], "doc": "<p>Returns and logs titles of all windows of the selected browser.</p>\n<p>How to select the <code>browser</code> scope of this keyword, see <a href=\"#Get%20Locations\" class=\"name\">Get Locations</a>.</p>", "shortdoc": "Returns and logs titles of all windows of the selected browser.", "tags": [], "source": "C:\\Python\\lib\\site-packages\\SeleniumLibrary\\keywords\\window.py", "lineno": 158}, {"name": "Go Back", "args": [], "doc": "<p>Simulates the user clicking the back button on their browser.</p>", "shortdoc": "Simulates the user clicking the back button on their browser.", "tags": [], "source": "C:\\Python\\lib\\site-packages\\SeleniumLibrary\\keywords\\browsermanagement.py", "lineno": 584}, {"name": "Go To", "args": [{"name": "url", "types": [], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "url"}], "doc": "<p>Navigates the current browser window to the provided <code>url</code>.</p>", "shortdoc": "Navigates the current browser window to the provided ``url``.", "tags": [], "source": "C:\\Python\\lib\\site-packages\\SeleniumLibrary\\keywords\\browsermanagement.py", "lineno": 589}, {"name": "Handle Alert", "args": [{"name": "action", "types": ["str"], "defaultValue": "ACCEPT", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "action: str = ACCEPT"}, {"name": "timeout", "types": ["timedelta"], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "timeout: timedelta = None"}], "doc": "<p>Handles the current alert and returns its message.</p>\n<p>By default, the alert is accepted, but this can be controlled with the <code>action</code> argument that supports the following case-insensitive values:</p>\n<ul>\n<li><code>ACCEPT</code>: Accept the alert i.e. press <code>Ok</code>. Default.</li>\n<li><code>DISMISS</code>: Dismiss the alert i.e. press <code>Cancel</code>.</li>\n<li><code>LEAVE</code>: Leave the alert open.</li>\n</ul>\n<p>The <code>timeout</code> argument specifies how long to wait for the alert to appear. If it is not given, the global default <span class=\"name\">timeout</span> is used instead.</p>\n<p>Examples:</p>\n<table border=\"1\">\n<tr>\n<td>Handle Alert</td>\n<td></td>\n<td></td>\n<td># Accept alert.</td>\n</tr>\n<tr>\n<td>Handle Alert</td>\n<td>action=DISMISS</td>\n<td></td>\n<td># Dismiss alert.</td>\n</tr>\n<tr>\n<td>Handle Alert</td>\n<td>timeout=10 s</td>\n<td></td>\n<td># Use custom timeout and accept alert.</td>\n</tr>\n<tr>\n<td>Handle Alert</td>\n<td>DISMISS</td>\n<td>1 min</td>\n<td># Use custom timeout and dismiss alert.</td>\n</tr>\n<tr>\n<td>${message} =</td>\n<td>Handle Alert</td>\n<td></td>\n<td># Accept alert and get its message.</td>\n</tr>\n<tr>\n<td>${message} =</td>\n<td>Handle Alert</td>\n<td>LEAVE</td>\n<td># Leave alert open and get its message.</td>\n</tr>\n</table>\n<p>New in SeleniumLibrary 3.0.</p>", "shortdoc": "Handles the current alert and returns its message.", "tags": [], "source": "C:\\Python\\lib\\site-packages\\SeleniumLibrary\\keywords\\alert.py", "lineno": 104}, {"name": "Input Password", "args": [{"name": "locator", "types": ["WebElement", "str"], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "locator: WebElement | str"}, {"name": "password", "types": ["str"], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "password: str"}, {"name": "clear", "types": ["bool"], "defaultValue": "True", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "clear: bool = True"}], "doc": "<p>Types the given password into the text field identified by <code>locator</code>.</p>\n<p>See the <span class=\"name\">Locating elements</span> section for details about the locator syntax. See <a href=\"#Input%20Text\" class=\"name\">Input Text</a> for <code>clear</code> argument details.</p>\n<p>Difference compared to <a href=\"#Input%20Text\" class=\"name\">Input Text</a> is that this keyword does not log the given password on the INFO level. Notice that if you use the keyword like</p>\n<table border=\"1\">\n<tr>\n<td>Input Password</td>\n<td>password_field</td>\n<td>password</td>\n</tr>\n</table>\n<p>the password is shown as a normal keyword argument. A way to avoid that is using variables like</p>\n<table border=\"1\">\n<tr>\n<td>Input Password</td>\n<td>password_field</td>\n<td>${PASSWORD}</td>\n</tr>\n</table>\n<p>Please notice that Robot Framework logs all arguments using the TRACE level and tests must not be executed using level below DEBUG if the password should not be logged in any format.</p>\n<p>The <span class=\"name\">clear</span> argument is new in SeleniumLibrary 4.0. Hiding password logging from Selenium logs is new in SeleniumLibrary 4.2.</p>", "shortdoc": "Types the given password into the text field identified by ``locator``.", "tags": [], "source": "C:\\Python\\lib\\site-packages\\SeleniumLibrary\\keywords\\formelement.py", "lineno": 242}, {"name": "Input Text", "args": [{"name": "locator", "types": ["WebElement", "str"], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "locator: WebElement | str"}, {"name": "text", "types": ["str"], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "text: str"}, {"name": "clear", "types": ["bool"], "defaultValue": "True", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "clear: bool = True"}], "doc": "<p>Types the given <code>text</code> into the text field identified by <code>locator</code>.</p>\n<p>When <code>clear</code> is true, the input element is cleared before the text is typed into the element. When false, the previous text is not cleared from the element. Use <a href=\"#Input%20Password\" class=\"name\">Input Password</a> if you do not want the given <code>text</code> to be logged.</p>\n<p>If <a href=\"https://github.com/SeleniumHQ/selenium/wiki/Grid2\">Selenium Grid</a> is used and the <code>text</code> argument points to a file in the file system, then this keyword prevents the Selenium to transfer the file to the Selenium Grid hub. Instead, this keyword will send the <code>text</code> string as is to the element. If a file should be transferred to the hub and upload should be performed, please use <a href=\"#Choose%20File\" class=\"name\">Choose File</a> keyword.</p>\n<p>See the <span class=\"name\">Locating elements</span> section for details about the locator syntax. See the <span class=\"name\">Boolean arguments</span> section how Boolean values are handled.</p>\n<p>Disabling the file upload the Selenium Grid node and the <span class=\"name\">clear</span> argument are new in SeleniumLibrary 4.0</p>", "shortdoc": "Types the given ``text`` into the text field identified by ``locator``.", "tags": [], "source": "C:\\Python\\lib\\site-packages\\SeleniumLibrary\\keywords\\formelement.py", "lineno": 272}, {"name": "Input Text Into Alert", "args": [{"name": "text", "types": ["str"], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "text: str"}, {"name": "action", "types": ["str"], "defaultValue": "ACCEPT", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "action: str = ACCEPT"}, {"name": "timeout", "types": ["timedelta"], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "timeout: timedelta = None"}], "doc": "<p>Types the given <code>text</code> into an input field in an alert.</p>\n<p>The alert is accepted by default, but that behavior can be controlled by using the <code>action</code> argument same way as with <a href=\"#Handle%20Alert\" class=\"name\">Handle Alert</a>.</p>\n<p><code>timeout</code> specifies how long to wait for the alert to appear. If it is not given, the global default <span class=\"name\">timeout</span> is used instead.</p>\n<p>New in SeleniumLibrary 3.0.</p>", "shortdoc": "Types the given ``text`` into an input field in an alert.", "tags": [], "source": "C:\\Python\\lib\\site-packages\\SeleniumLibrary\\keywords\\alert.py", "lineno": 34}, {"name": "List Selection Should Be", "args": [{"name": "locator", "types": ["WebElement", "str"], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "locator: WebElement | str"}, {"name": "expected", "types": ["str"], "defaultValue": null, "kind": "VAR_POSITIONAL", "required": false, "repr": "*expected: str"}], "doc": "<p>Verifies selection list <code>locator</code> has <code>expected</code> options selected.</p>\n<p>It is possible to give expected options both as visible labels and as values. Starting from SeleniumLibrary 3.0, mixing labels and values is not possible. Order of the selected options is not validated.</p>\n<p>If no expected options are given, validates that the list has no selections. A more explicit alternative is using <a href=\"#List%20Should%20Have%20No%20Selections\" class=\"name\">List Should Have No Selections</a>.</p>\n<p>See the <span class=\"name\">Locating elements</span> section for details about the locator syntax.</p>\n<p>Examples:</p>\n<table border=\"1\">\n<tr>\n<td><a href=\"#List%20Selection%20Should%20Be\" class=\"name\">List Selection Should Be</a></td>\n<td>gender</td>\n<td>Female</td>\n<td></td>\n</tr>\n<tr>\n<td><a href=\"#List%20Selection%20Should%20Be\" class=\"name\">List Selection Should Be</a></td>\n<td>interests</td>\n<td>Test Automation</td>\n<td>Python</td>\n</tr>\n</table>", "shortdoc": "Verifies selection list ``locator`` has ``expected`` options selected.", "tags": [], "source": "C:\\Python\\lib\\site-packages\\SeleniumLibrary\\keywords\\selectelement.py", "lineno": 104}, {"name": "List Should Have No Selections", "args": [{"name": "locator", "types": ["WebElement", "str"], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "locator: WebElement | str"}], "doc": "<p>Verifies selection list <code>locator</code> has no options selected.</p>\n<p>See the <span class=\"name\">Locating elements</span> section for details about the locator syntax.</p>", "shortdoc": "Verifies selection list ``locator`` has no options selected.", "tags": [], "source": "C:\\Python\\lib\\site-packages\\SeleniumLibrary\\keywords\\selectelement.py", "lineno": 141}, {"name": "Location Should Be", "args": [{"name": "url", "types": ["str"], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "url: str"}, {"name": "message", "types": ["str"], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "message: str = None"}], "doc": "<p>Verifies that the current URL is exactly <code>url</code>.</p>\n<p>The <code>url</code> argument contains the exact url that should exist in browser.</p>\n<p>The <code>message</code> argument can be used to override the default error message.</p>\n<p><code>message</code> argument is new in SeleniumLibrary 3.2.0.</p>", "shortdoc": "Verifies that the current URL is exactly ``url``.", "tags": [], "source": "C:\\Python\\lib\\site-packages\\SeleniumLibrary\\keywords\\browsermanagement.py", "lineno": 503}, {"name": "Location Should Contain", "args": [{"name": "expected", "types": ["str"], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "expected: str"}, {"name": "message", "types": ["str"], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "message: str = None"}], "doc": "<p>Verifies that the current URL contains <code>expected</code>.</p>\n<p>The <code>expected</code> argument contains the expected value in url.</p>\n<p>The <code>message</code> argument can be used to override the default error message.</p>\n<p><code>message</code> argument is new in SeleniumLibrary 3.2.0.</p>", "shortdoc": "Verifies that the current URL contains ``expected``.", "tags": [], "source": "C:\\Python\\lib\\site-packages\\SeleniumLibrary\\keywords\\browsermanagement.py", "lineno": 521}, {"name": "Log Location", "args": [], "doc": "<p>Logs and returns the current browser window URL.</p>", "shortdoc": "Logs and returns the current browser window URL.", "tags": [], "source": "C:\\Python\\lib\\site-packages\\SeleniumLibrary\\keywords\\browsermanagement.py", "lineno": 542}, {"name": "Log Source", "args": [{"name": "loglevel", "types": ["str"], "defaultValue": "INFO", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "loglevel: str = INFO"}], "doc": "<p>Logs and returns the HTML source of the current page or frame.</p>\n<p>The <code>loglevel</code> argument defines the used log level. Valid log levels are <code>WARN</code>, <code>INFO</code> (default), <code>DEBUG</code>, <code>TRACE</code> and <code>NONE</code> (no logging).</p>", "shortdoc": "Logs and returns the HTML source of the current page or frame.", "tags": [], "source": "C:\\Python\\lib\\site-packages\\SeleniumLibrary\\keywords\\browsermanagement.py", "lineno": 549}, {"name": "Log Title", "args": [], "doc": "<p>Logs and returns the title of the current page.</p>", "shortdoc": "Logs and returns the title of the current page.", "tags": [], "source": "C:\\Python\\lib\\site-packages\\SeleniumLibrary\\keywords\\browsermanagement.py", "lineno": 561}, {"name": "Maximize Browser Window", "args": [], "doc": "<p>Maximizes current browser window.</p>", "shortdoc": "Maximizes current browser window.", "tags": [], "source": "C:\\Python\\lib\\site-packages\\SeleniumLibrary\\keywords\\window.py", "lineno": 185}, {"name": "Mouse Down", "args": [{"name": "locator", "types": ["WebElement", "str"], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "locator: WebElement | str"}], "doc": "<p>Simulates pressing the left mouse button on the element <code>locator</code>.</p>\n<p>See the <span class=\"name\">Locating elements</span> section for details about the locator syntax.</p>\n<p>The element is pressed without releasing the mouse button.</p>\n<p>See also the more specific keywords <a href=\"#Mouse%20Down%20On%20Image\" class=\"name\">Mouse Down On Image</a> and <a href=\"#Mouse%20Down%20On%20Link\" class=\"name\">Mouse Down On Link</a>.</p>", "shortdoc": "Simulates pressing the left mouse button on the element ``locator``.", "tags": [], "source": "C:\\Python\\lib\\site-packages\\SeleniumLibrary\\keywords\\element.py", "lineno": 797}, {"name": "Mouse Down On Image", "args": [{"name": "locator", "types": ["WebElement", "str"], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "locator: WebElement | str"}], "doc": "<p>Simulates a mouse down event on an image identified by <code>locator</code>.</p>\n<p>See the <span class=\"name\">Locating elements</span> section for details about the locator syntax. When using the default locator strategy, images are searched using <code>id</code>, <code>name</code>, <code>src</code> and <code>alt</code>.</p>", "shortdoc": "Simulates a mouse down event on an image identified by ``locator``.", "tags": [], "source": "C:\\Python\\lib\\site-packages\\SeleniumLibrary\\keywords\\element.py", "lineno": 1052}, {"name": "Mouse Down On Link", "args": [{"name": "locator", "types": ["WebElement", "str"], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "locator: WebElement | str"}], "doc": "<p>Simulates a mouse down event on a link identified by <code>locator</code>.</p>\n<p>See the <span class=\"name\">Locating elements</span> section for details about the locator syntax. When using the default locator strategy, links are searched using <code>id</code>, <code>name</code>, <code>href</code> and the link text.</p>", "shortdoc": "Simulates a mouse down event on a link identified by ``locator``.", "tags": [], "source": "C:\\Python\\lib\\site-packages\\SeleniumLibrary\\keywords\\element.py", "lineno": 1002}, {"name": "Mouse Out", "args": [{"name": "locator", "types": ["WebElement", "str"], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "locator: WebElement | str"}], "doc": "<p>Simulates moving the mouse away from the element <code>locator</code>.</p>\n<p>See the <span class=\"name\">Locating elements</span> section for details about the locator syntax.</p>", "shortdoc": "Simulates moving the mouse away from the element ``locator``.", "tags": [], "source": "C:\\Python\\lib\\site-packages\\SeleniumLibrary\\keywords\\element.py", "lineno": 816}, {"name": "Mouse Over", "args": [{"name": "locator", "types": ["WebElement", "str"], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "locator: WebElement | str"}], "doc": "<p>Simulates hovering the mouse over the element <code>locator</code>.</p>\n<p>See the <span class=\"name\">Locating elements</span> section for details about the locator syntax.</p>", "shortdoc": "Simulates hovering the mouse over the element ``locator``.", "tags": [], "source": "C:\\Python\\lib\\site-packages\\SeleniumLibrary\\keywords\\element.py", "lineno": 835}, {"name": "Mouse Up", "args": [{"name": "locator", "types": ["WebElement", "str"], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "locator: WebElement | str"}], "doc": "<p>Simulates releasing the left mouse button on the element <code>locator</code>.</p>\n<p>See the <span class=\"name\">Locating elements</span> section for details about the locator syntax.</p>", "shortdoc": "Simulates releasing the left mouse button on the element ``locator``.", "tags": [], "source": "C:\\Python\\lib\\site-packages\\SeleniumLibrary\\keywords\\element.py", "lineno": 849}, {"name": "Open Browser", "args": [{"name": "url", "types": ["str"], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "url: str = None"}, {"name": "browser", "types": ["str"], "defaultValue": "firefox", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "browser: str = firefox"}, {"name": "alias", "types": ["str"], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "alias: str = None"}, {"name": "remote_url", "types": ["bool", "str"], "defaultValue": "False", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "remote_url: bool | str = False"}, {"name": "desired_capabilities", "types": ["dict", "None", "str"], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "desired_capabilities: dict | None | str = None"}, {"name": "ff_profile_dir", "types": ["FirefoxProfile", "str", "None"], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "ff_profile_dir: FirefoxProfile | str | None = None"}, {"name": "options", "types": ["Any"], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "options: Any = None"}, {"name": "service_log_path", "types": ["str"], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "service_log_path: str = None"}, {"name": "executable_path", "types": ["str"], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "executable_path: str = None"}], "doc": "<p>Opens a new browser instance to the optional <code>url</code>.</p>\n<p>The <code>browser</code> argument specifies which browser to use. The supported browsers are listed in the table below. The browser names are case-insensitive and some browsers have multiple supported names.</p>\n<table border=\"1\">\n<tr>\n<th>Browser</th>\n<th>Name(s)</th>\n</tr>\n<tr>\n<td>Firefox</td>\n<td>firefox, ff</td>\n</tr>\n<tr>\n<td>Google Chrome</td>\n<td>googlechrome, chrome, gc</td>\n</tr>\n<tr>\n<td>Headless Firefox</td>\n<td>headlessfirefox</td>\n</tr>\n<tr>\n<td>Headless Chrome</td>\n<td>headlesschrome</td>\n</tr>\n<tr>\n<td>Internet Explorer</td>\n<td>internetexplorer, ie</td>\n</tr>\n<tr>\n<td>Edge</td>\n<td>edge</td>\n</tr>\n<tr>\n<td>Safari</td>\n<td>safari</td>\n</tr>\n<tr>\n<td>Opera</td>\n<td>opera</td>\n</tr>\n<tr>\n<td>Android</td>\n<td>android</td>\n</tr>\n<tr>\n<td>Iphone</td>\n<td>iphone</td>\n</tr>\n<tr>\n<td>PhantomJS</td>\n<td>phantomjs</td>\n</tr>\n<tr>\n<td>HTMLUnit</td>\n<td>htmlunit</td>\n</tr>\n<tr>\n<td>HTMLUnit with Javascript</td>\n<td>htmlunitwithjs</td>\n</tr>\n</table>\n<p>To be able to actually use one of these browsers, you need to have a matching Selenium browser driver available. See the <a href=\"https://github.com/robotframework/SeleniumLibrary#browser-drivers\">project documentation</a> for more details. Headless Firefox and Headless Chrome are new additions in SeleniumLibrary 3.1.0 and require Selenium 3.8.0 or newer.</p>\n<p>After opening the browser, it is possible to use optional <code>url</code> to navigate the browser to the desired address.</p>\n<p>Optional <code>alias</code> is an alias given for this browser instance and it can be used for switching between browsers. When same <code>alias</code> is given with two <a href=\"#Open%20Browser\" class=\"name\">Open Browser</a> keywords, the first keyword will open a new browser, but the second one will switch to the already opened browser and will not open a new browser. The <code>alias</code> definition overrules <code>browser</code> definition. When same <code>alias</code> is used but a different <code>browser</code> is defined, then switch to a browser with same alias is done and new browser is not opened. An alternative approach for switching is using an index returned by this keyword. These indices start from 1, are incremented when new browsers are opened, and reset back to 1 when <a href=\"#Close%20All%20Browsers\" class=\"name\">Close All Browsers</a> is called. See <a href=\"#Switch%20Browser\" class=\"name\">Switch Browser</a> for more information and examples.</p>\n<p>Optional <code>remote_url</code> is the URL for a <a href=\"https://github.com/SeleniumHQ/selenium/wiki/Grid2\">Selenium Grid</a>.</p>\n<p>Optional <code>desired_capabilities</code> can be used to configure, for example, logging preferences for a browser or a browser and operating system when using <a href=\"http://saucelabs.com\">Sauce Labs</a>. Desired capabilities can be given either as a Python dictionary or as a string in the format <code>key1:value1,key2:value2</code>. <a href=\"https://github.com/SeleniumHQ/selenium/wiki/DesiredCapabilities\">Selenium documentation</a> lists possible capabilities that can be enabled.</p>\n<p>Optional <code>ff_profile_dir</code> is the path to the Firefox profile directory if you wish to overwrite the default profile Selenium uses. Notice that prior to SeleniumLibrary 3.0, the library contained its own profile that was used by default. The <code>ff_profile_dir</code> can also be an instance of the <a href=\"https://seleniumhq.github.io/selenium/docs/api/py/webdriver_firefox/selenium.webdriver.firefox.firefox_profile.html\">selenium.webdriver.FirefoxProfile</a> . As a third option, it is possible to use <span class=\"name\">FirefoxProfile</span> methods and attributes to define the profile using methods and attributes in the same way as with <code>options</code> argument. Example: It is possible to use FirefoxProfile <span class=\"name\">set_preference</span> to define different profile settings. See <code>options</code> argument documentation in below how to handle backslash escaping.</p>\n<p>Optional <code>options</code> argument allows defining browser specific Selenium options. Example for Chrome, the <code>options</code> argument allows defining the following <a href=\"https://seleniumhq.github.io/selenium/docs/api/py/webdriver_chrome/selenium.webdriver.chrome.options.html#selenium.webdriver.chrome.options.Options\">methods and attributes</a> and for Firefox these <a href=\"https://seleniumhq.github.io/selenium/docs/api/py/webdriver_firefox/selenium.webdriver.firefox.options.html?highlight=firefox#selenium.webdriver.firefox.options.Options\">methods and attributes</a> are available. Please note that not all browsers, supported by the SeleniumLibrary, have Selenium options available. Therefore please consult the Selenium documentation which browsers do support the Selenium options. If <code>browser</code> argument is <span class=\"name\">android</span> then <a href=\"https://seleniumhq.github.io/selenium/docs/api/py/webdriver_chrome/selenium.webdriver.chrome.options.html#selenium.webdriver.chrome.options.Options\">Chrome options</a> is used. Selenium options are also supported, when <code>remote_url</code> argument is used.</p>\n<p>The SeleniumLibrary <code>options</code> argument accepts Selenium options in two different formats: as a string and as Python object which is an instance of the Selenium options class.</p>\n<p>The string format allows defining Selenium options methods or attributes and their arguments in Robot Framework test data. The method and attributes names are case and space sensitive and must match to the Selenium options methods and attributes names. When defining a method, it must be defined in a similar way as in python: method name, opening parenthesis, zero to many arguments and closing parenthesis. If there is a need to define multiple arguments for a single method, arguments must be separated with comma, just like in Python. Example: <span class=\"name\">add_argument(\"--headless\")</span> or <span class=\"name\">add_experimental_option(\"key\", \"value\")</span>. Attributes are defined in a similar way as in Python: attribute name, equal sign, and attribute value. Example, <span class=\"name\">headless=True</span>. Multiple methods and attributes must be separated by a semicolon. Example: <span class=\"name\">add_argument(\"--headless\");add_argument(\"--start-maximized\")</span>.</p>\n<p>Arguments allow defining Python data types and arguments are evaluated by using Python <a href=\"https://docs.python.org/3/library/ast.html#ast.literal_eval\">ast.literal_eval</a>. Strings must be quoted with single or double quotes, example \"value\" or 'value'. It is also possible to define other Python builtin data types, example <span class=\"name\">True</span> or <span class=\"name\">None</span>, by not using quotes around the arguments.</p>\n<p>The string format is space friendly. Usually, spaces do not alter the defining methods or attributes. There are two exceptions. In some Robot Framework test data formats, two or more spaces are considered as cell separator and instead of defining a single argument, two or more arguments may be defined. Spaces in string arguments are not removed and are left as is. Example <span class=\"name\">add_argument ( \"--headless\" )</span> is same as <span class=\"name\">add_argument(\"--headless\")</span>. But <span class=\"name\">add_argument(\" --headless \")</span> is not same same as <span class=\"name\">add_argument ( \"--headless\" )</span>, because spaces inside of quotes are not removed. Please note that if options string contains backslash, example a Windows OS path, the backslash needs escaping both in Robot Framework data and in Python side. This means single backslash must be writen using four backslash characters. Example, Windows path: \"C:\\path\\to\\profile\" must be written as \"C:\\\\\\\\path\\\\\\to\\\\\\\\profile\". Another way to write backslash is use Python <a href=\"https://docs.python.org/3/reference/lexical_analysis.html#string-and-bytes-literals\">raw strings</a> and example write: r\"C:\\\\path\\\\to\\\\profile\".</p>\n<p>As last format, <code>options</code> argument also supports receiving the Selenium options as Python class instance. In this case, the instance is used as-is and the SeleniumLibrary will not convert the instance to other formats. For example, if the following code return value is saved to <span class=\"name\">${options}</span> variable in the Robot Framework data:</p>\n<pre>\noptions = webdriver.ChromeOptions()\noptions.add_argument('--disable-dev-shm-usage')\nreturn options\n</pre>\n<p>Then the <span class=\"name\">${options}</span> variable can be used as an argument to <code>options</code>.</p>\n<p>Example the <code>options</code> argument can be used to launch Chomium-based applications which utilize the <a href=\"https://bitbucket.org/chromiumembedded/cef/wiki/UsingChromeDriver\">Chromium Embedded Framework</a> . To lauch Chomium-based application, use <code>options</code> to define <span class=\"name\">binary_location</span> attribute and use <span class=\"name\">add_argument</span> method to define <span class=\"name\">remote-debugging-port</span> port for the application. Once the browser is opened, the test can interact with the embedded web-content of the system under test.</p>\n<p>Optional <code>service_log_path</code> argument defines the name of the file where to write the browser driver logs. If the <code>service_log_path</code>  argument contain a  marker <code>{index}</code>, it will be automatically replaced with unique running index preventing files to be overwritten. Indices start's from 1, and how they are represented can be customized using Python's <a href=\"https://docs.python.org/3/library/string.html#format-string-syntax\">format string syntax</a>.</p>\n<p>Optional <code>executable_path</code> argument defines the path to the driver executable, example to a chromedriver or a geckodriver. If not defined it is assumed the executable is in the <a href=\"https://en.wikipedia.org/wiki/PATH_(variable)\">$PATH</a>.</p>\n<p>Examples:</p>\n<table border=\"1\">\n<tr>\n<td><a href=\"#Open%20Browser\" class=\"name\">Open Browser</a></td>\n<td><a href=\"http://example.com\">http://example.com</a></td>\n<td>Chrome</td>\n<td></td>\n</tr>\n<tr>\n<td><a href=\"#Open%20Browser\" class=\"name\">Open Browser</a></td>\n<td><a href=\"http://example.com\">http://example.com</a></td>\n<td>Firefox</td>\n<td>alias=Firefox</td>\n</tr>\n<tr>\n<td><a href=\"#Open%20Browser\" class=\"name\">Open Browser</a></td>\n<td><a href=\"http://example.com\">http://example.com</a></td>\n<td>Edge</td>\n<td>remote_url=http://127.0.0.1:4444/wd/hub</td>\n</tr>\n<tr>\n<td><a href=\"#Open%20Browser\" class=\"name\">Open Browser</a></td>\n<td>about:blank</td>\n<td></td>\n<td></td>\n</tr>\n<tr>\n<td><a href=\"#Open%20Browser\" class=\"name\">Open Browser</a></td>\n<td>browser=Chrome</td>\n<td></td>\n<td></td>\n</tr>\n</table>\n<p>Alias examples:</p>\n<table border=\"1\">\n<tr>\n<td>${1_index} =</td>\n<td><a href=\"#Open%20Browser\" class=\"name\">Open Browser</a></td>\n<td><a href=\"http://example.com\">http://example.com</a></td>\n<td>Chrome</td>\n<td>alias=Chrome</td>\n<td># Opens new browser because alias is new.</td>\n</tr>\n<tr>\n<td>${2_index} =</td>\n<td><a href=\"#Open%20Browser\" class=\"name\">Open Browser</a></td>\n<td><a href=\"http://example.com\">http://example.com</a></td>\n<td>Firefox</td>\n<td></td>\n<td># Opens new browser because alias is not defined.</td>\n</tr>\n<tr>\n<td>${3_index} =</td>\n<td><a href=\"#Open%20Browser\" class=\"name\">Open Browser</a></td>\n<td><a href=\"http://example.com\">http://example.com</a></td>\n<td>Chrome</td>\n<td>alias=Chrome</td>\n<td># Switches to the browser with Chrome alias.</td>\n</tr>\n<tr>\n<td>${4_index} =</td>\n<td><a href=\"#Open%20Browser\" class=\"name\">Open Browser</a></td>\n<td><a href=\"http://example.com\">http://example.com</a></td>\n<td>Chrome</td>\n<td>alias=${1_index}</td>\n<td># Switches to the browser with Chrome alias.</td>\n</tr>\n<tr>\n<td>Should Be Equal</td>\n<td>${1_index}</td>\n<td>${3_index}</td>\n<td></td>\n<td></td>\n<td></td>\n</tr>\n<tr>\n<td>Should Be Equal</td>\n<td>${1_index}</td>\n<td>${4_index}</td>\n<td></td>\n<td></td>\n<td></td>\n</tr>\n<tr>\n<td>Should Be Equal</td>\n<td>${2_index}</td>\n<td>${2}</td>\n<td></td>\n<td></td>\n<td></td>\n</tr>\n</table>\n<p>Example when using <a href=\"https://seleniumhq.github.io/selenium/docs/api/py/webdriver_chrome/selenium.webdriver.chrome.options.html#selenium.webdriver.chrome.options.Options\">Chrome options</a> method:</p>\n<table border=\"1\">\n<tr>\n<td><a href=\"#Open%20Browser\" class=\"name\">Open Browser</a></td>\n<td><a href=\"http://example.com\">http://example.com</a></td>\n<td>Chrome</td>\n<td>options=add_argument(\"--disable-popup-blocking\"); add_argument(\"--ignore-certificate-errors\")</td>\n<td># Sting format.</td>\n</tr>\n<tr>\n<td>${options} =</td>\n<td>Get Options</td>\n<td></td>\n<td></td>\n<td># Selenium options instance.</td>\n</tr>\n<tr>\n<td><a href=\"#Open%20Browser\" class=\"name\">Open Browser</a></td>\n<td><a href=\"http://example.com\">http://example.com</a></td>\n<td>Chrome</td>\n<td>options=${options}</td>\n<td></td>\n</tr>\n<tr>\n<td><a href=\"#Open%20Browser\" class=\"name\">Open Browser</a></td>\n<td>None</td>\n<td>Chrome</td>\n<td>options=binary_location=\"/path/to/binary\";add_argument(\"remote-debugging-port=port\")</td>\n<td># Start Chomium-based application.</td>\n</tr>\n<tr>\n<td><a href=\"#Open%20Browser\" class=\"name\">Open Browser</a></td>\n<td>None</td>\n<td>Chrome</td>\n<td>options=binary_location=r\"C:\\\\path\\\\to\\\\binary\"</td>\n<td># Windows OS path escaping.</td>\n</tr>\n</table>\n<p>Example for FirefoxProfile</p>\n<table border=\"1\">\n<tr>\n<td><a href=\"#Open%20Browser\" class=\"name\">Open Browser</a></td>\n<td><a href=\"http://example.com\">http://example.com</a></td>\n<td>Firefox</td>\n<td>ff_profile_dir=/path/to/profile</td>\n<td># Using profile from disk.</td>\n</tr>\n<tr>\n<td><a href=\"#Open%20Browser\" class=\"name\">Open Browser</a></td>\n<td><a href=\"http://example.com\">http://example.com</a></td>\n<td>Firefox</td>\n<td>ff_profile_dir=${FirefoxProfile_instance}</td>\n<td># Using instance of FirefoxProfile.</td>\n</tr>\n<tr>\n<td><a href=\"#Open%20Browser\" class=\"name\">Open Browser</a></td>\n<td><a href=\"http://example.com\">http://example.com</a></td>\n<td>Firefox</td>\n<td>ff_profile_dir=set_preference(\"key\", \"value\");set_preference(\"other\", \"setting\")</td>\n<td># Defining profile using FirefoxProfile mehtods.</td>\n</tr>\n</table>\n<p>If the provided configuration options are not enough, it is possible to use <a href=\"#Create%20Webdriver\" class=\"name\">Create Webdriver</a> to customize browser initialization even more.</p>\n<p>Applying <code>desired_capabilities</code> argument also for local browser is new in SeleniumLibrary 3.1.</p>\n<p>Using <code>alias</code> to decide, is the new browser opened is new in SeleniumLibrary 4.0. The <code>options</code> and <code>service_log_path</code> are new in SeleniumLibrary 4.0. Support for <code>ff_profile_dir</code> accepting an instance of the <span class=\"name\">selenium.webdriver.FirefoxProfile</span> and support defining FirefoxProfile with methods and attributes are new in SeleniumLibrary 4.0.</p>\n<p>Making <code>url</code> optional is new in SeleniumLibrary 4.1.</p>\n<p>The <code>executable_path</code> argument is new in SeleniumLibrary 4.2.</p>", "shortdoc": "Opens a new browser instance to the optional ``url``.", "tags": [], "source": "C:\\Python\\lib\\site-packages\\SeleniumLibrary\\keywords\\browsermanagement.py", "lineno": 60}, {"name": "Open Context Menu", "args": [{"name": "locator", "types": ["WebElement", "str"], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "locator: WebElement | str"}], "doc": "<p>Opens the context menu on the element identified by <code>locator</code>.</p>", "shortdoc": "Opens the context menu on the element identified by ``locator``.", "tags": [], "source": "C:\\Python\\lib\\site-packages\\SeleniumLibrary\\keywords\\element.py", "lineno": 862}, {"name": "Page Should Contain", "args": [{"name": "text", "types": ["str"], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "text: str"}, {"name": "loglevel", "types": ["str"], "defaultValue": "TRACE", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "loglevel: str = TRACE"}], "doc": "<p>Verifies that current page contains <code>text</code>.</p>\n<p>If this keyword fails, it automatically logs the page source using the log level specified with the optional <code>loglevel</code> argument. Valid log levels are <code>DEBUG</code>, <code>INFO</code> (default), <code>WARN</code>, and <code>NONE</code>. If the log level is <code>NONE</code> or below the current active log level the source will not be logged.</p>", "shortdoc": "Verifies that current page contains ``text``.", "tags": [], "source": "C:\\Python\\lib\\site-packages\\SeleniumLibrary\\keywords\\element.py", "lineno": 128}, {"name": "Page Should Contain Button", "args": [{"name": "locator", "types": ["WebElement", "str"], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "locator: WebElement | str"}, {"name": "message", "types": ["str"], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "message: str = None"}, {"name": "loglevel", "types": ["str"], "defaultValue": "TRACE", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "loglevel: str = TRACE"}], "doc": "<p>Verifies button <code>locator</code> is found from current page.</p>\n<p>See <a href=\"#Page%20Should%20Contain%20Element\" class=\"name\">Page Should Contain Element</a> for an explanation about <code>message</code> and <code>loglevel</code> arguments.</p>\n<p>See the <span class=\"name\">Locating elements</span> section for details about the locator syntax. When using the default locator strategy, buttons are searched using <code>id</code>, <code>name</code>, and <code>value</code>.</p>", "shortdoc": "Verifies button ``locator`` is found from current page.", "tags": [], "source": "C:\\Python\\lib\\site-packages\\SeleniumLibrary\\keywords\\formelement.py", "lineno": 430}, {"name": "Page Should Contain Checkbox", "args": [{"name": "locator", "types": ["WebElement", "str"], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "locator: WebElement | str"}, {"name": "message", "types": ["str"], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "message: str = None"}, {"name": "loglevel", "types": ["str"], "defaultValue": "TRACE", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "loglevel: str = TRACE"}], "doc": "<p>Verifies checkbox <code>locator</code> is found from the current page.</p>\n<p>See <a href=\"#Page%20Should%20Contain%20Element\" class=\"name\">Page Should Contain Element</a> for an explanation about <code>message</code> and <code>loglevel</code> arguments.</p>\n<p>See the <span class=\"name\">Locating elements</span> section for details about the locator syntax.</p>", "shortdoc": "Verifies checkbox ``locator`` is found from the current page.", "tags": [], "source": "C:\\Python\\lib\\site-packages\\SeleniumLibrary\\keywords\\formelement.py", "lineno": 70}, {"name": "Page Should Contain Element", "args": [{"name": "locator", "types": ["WebElement", "str"], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "locator: WebElement | str"}, {"name": "message", "types": ["str"], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "message: str = None"}, {"name": "loglevel", "types": ["str"], "defaultValue": "TRACE", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "loglevel: str = TRACE"}, {"name": "limit", "types": ["int"], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "limit: int = None"}], "doc": "<p>Verifies that element <code>locator</code> is found on the current page.</p>\n<p>See the <span class=\"name\">Locating elements</span> section for details about the locator syntax.</p>\n<p>The <code>message</code> argument can be used to override the default error message.</p>\n<p>The <code>limit</code> argument can used to define how many elements the page should contain. When <code>limit</code> is <code>None</code> (default) page can contain one or more elements. When limit is a number, page must contain same number of elements.</p>\n<p>See <a href=\"#Page%20Should%20Contain\" class=\"name\">Page Should Contain</a> for an explanation about the <code>loglevel</code> argument.</p>\n<p>Examples assumes that locator matches to two elements.</p>\n<table border=\"1\">\n<tr>\n<td><a href=\"#Page%20Should%20Contain%20Element\" class=\"name\">Page Should Contain Element</a></td>\n<td>div_name</td>\n<td>limit=1</td>\n<td># Keyword fails.</td>\n</tr>\n<tr>\n<td><a href=\"#Page%20Should%20Contain%20Element\" class=\"name\">Page Should Contain Element</a></td>\n<td>div_name</td>\n<td>limit=2</td>\n<td># Keyword passes.</td>\n</tr>\n<tr>\n<td><a href=\"#Page%20Should%20Contain%20Element\" class=\"name\">Page Should Contain Element</a></td>\n<td>div_name</td>\n<td>limit=none</td>\n<td># None is considered one or more.</td>\n</tr>\n<tr>\n<td><a href=\"#Page%20Should%20Contain%20Element\" class=\"name\">Page Should Contain Element</a></td>\n<td>div_name</td>\n<td></td>\n<td># Same as above.</td>\n</tr>\n</table>\n<p>The <code>limit</code> argument is new in SeleniumLibrary 3.0.</p>", "shortdoc": "Verifies that element ``locator`` is found on the current page.", "tags": [], "source": "C:\\Python\\lib\\site-packages\\SeleniumLibrary\\keywords\\element.py", "lineno": 145}, {"name": "Page Should Contain Image", "args": [{"name": "locator", "types": ["WebElement", "str"], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "locator: WebElement | str"}, {"name": "message", "types": ["str"], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "message: str = None"}, {"name": "loglevel", "types": ["str"], "defaultValue": "TRACE", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "loglevel: str = TRACE"}], "doc": "<p>Verifies image identified by <code>locator</code> is found from current page.</p>\n<p>See the <span class=\"name\">Locating elements</span> section for details about the locator syntax. When using the default locator strategy, images are searched using <code>id</code>, <code>name</code>, <code>src</code> and <code>alt</code>.</p>\n<p>See <a href=\"#Page%20Should%20Contain%20Element\" class=\"name\">Page Should Contain Element</a> for an explanation about <code>message</code> and <code>loglevel</code> arguments.</p>", "shortdoc": "Verifies image identified by ``locator`` is found from current page.", "tags": [], "source": "C:\\Python\\lib\\site-packages\\SeleniumLibrary\\keywords\\element.py", "lineno": 1066}, {"name": "Page Should Contain Link", "args": [{"name": "locator", "types": ["WebElement", "str"], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "locator: WebElement | str"}, {"name": "message", "types": ["str"], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "message: str = None"}, {"name": "loglevel", "types": ["str"], "defaultValue": "TRACE", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "loglevel: str = TRACE"}], "doc": "<p>Verifies link identified by <code>locator</code> is found from current page.</p>\n<p>See the <span class=\"name\">Locating elements</span> section for details about the locator syntax. When using the default locator strategy, links are searched using <code>id</code>, <code>name</code>, <code>href</code> and the link text.</p>\n<p>See <a href=\"#Page%20Should%20Contain%20Element\" class=\"name\">Page Should Contain Element</a> for an explanation about <code>message</code> and <code>loglevel</code> arguments.</p>", "shortdoc": "Verifies link identified by ``locator`` is found from current page.", "tags": [], "source": "C:\\Python\\lib\\site-packages\\SeleniumLibrary\\keywords\\element.py", "lineno": 1016}, {"name": "Page Should Contain List", "args": [{"name": "locator", "types": ["WebElement", "str"], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "locator: WebElement | str"}, {"name": "message", "types": ["str"], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "message: str = None"}, {"name": "loglevel", "types": ["str"], "defaultValue": "TRACE", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "loglevel: str = TRACE"}], "doc": "<p>Verifies selection list <code>locator</code> is found from current page.</p>\n<p>See <a href=\"#Page%20Should%20Contain%20Element\" class=\"name\">Page Should Contain Element</a> for an explanation about <code>message</code> and <code>loglevel</code> arguments.</p>\n<p>See the <span class=\"name\">Locating elements</span> section for details about the locator syntax.</p>", "shortdoc": "Verifies selection list ``locator`` is found from current page.", "tags": [], "source": "C:\\Python\\lib\\site-packages\\SeleniumLibrary\\keywords\\selectelement.py", "lineno": 159}, {"name": "Page Should Contain Radio Button", "args": [{"name": "locator", "types": ["WebElement", "str"], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "locator: WebElement | str"}, {"name": "message", "types": ["str"], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "message: str = None"}, {"name": "loglevel", "types": ["str"], "defaultValue": "TRACE", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "loglevel: str = TRACE"}], "doc": "<p>Verifies radio button <code>locator</code> is found from current page.</p>\n<p>See <a href=\"#Page%20Should%20Contain%20Element\" class=\"name\">Page Should Contain Element</a> for an explanation about <code>message</code> and <code>loglevel</code> arguments.</p>\n<p>See the <span class=\"name\">Locating elements</span> section for details about the locator syntax. When using the default locator strategy, radio buttons are searched using <code>id</code>, <code>name</code> and <code>value</code>.</p>", "shortdoc": "Verifies radio button ``locator`` is found from current page.", "tags": [], "source": "C:\\Python\\lib\\site-packages\\SeleniumLibrary\\keywords\\formelement.py", "lineno": 132}, {"name": "Page Should Contain Textfield", "args": [{"name": "locator", "types": ["WebElement", "str"], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "locator: WebElement | str"}, {"name": "message", "types": ["str"], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "message: str = None"}, {"name": "loglevel", "types": ["str"], "defaultValue": "TRACE", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "loglevel: str = TRACE"}], "doc": "<p>Verifies text field <code>locator</code> is found from current page.</p>\n<p>See <a href=\"#Page%20Should%20Contain%20Element\" class=\"name\">Page Should Contain Element</a> for an explanation about <code>message</code> and <code>loglevel</code> arguments.</p>\n<p>See the <span class=\"name\">Locating elements</span> section for details about the locator syntax.</p>", "shortdoc": "Verifies text field ``locator`` is found from current page.", "tags": [], "source": "C:\\Python\\lib\\site-packages\\SeleniumLibrary\\keywords\\formelement.py", "lineno": 300}, {"name": "Page Should Not Contain", "args": [{"name": "text", "types": ["str"], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "text: str"}, {"name": "loglevel", "types": ["str"], "defaultValue": "TRACE", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "loglevel: str = TRACE"}], "doc": "<p>Verifies the current page does not contain <code>text</code>.</p>\n<p>See <a href=\"#Page%20Should%20Contain\" class=\"name\">Page Should Contain</a> for an explanation about the <code>loglevel</code> argument.</p>", "shortdoc": "Verifies the current page does not contain ``text``.", "tags": [], "source": "C:\\Python\\lib\\site-packages\\SeleniumLibrary\\keywords\\element.py", "lineno": 193}, {"name": "Page Should Not Contain Button", "args": [{"name": "locator", "types": ["WebElement", "str"], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "locator: WebElement | str"}, {"name": "message", "types": ["str"], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "message: str = None"}, {"name": "loglevel", "types": ["str"], "defaultValue": "TRACE", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "loglevel: str = TRACE"}], "doc": "<p>Verifies button <code>locator</code> is not found from current page.</p>\n<p>See <a href=\"#Page%20Should%20Contain%20Element\" class=\"name\">Page Should Contain Element</a> for an explanation about <code>message</code> and <code>loglevel</code> arguments.</p>\n<p>See the <span class=\"name\">Locating elements</span> section for details about the locator syntax. When using the default locator strategy, buttons are searched using <code>id</code>, <code>name</code>, and <code>value</code>.</p>", "shortdoc": "Verifies button ``locator`` is not found from current page.", "tags": [], "source": "C:\\Python\\lib\\site-packages\\SeleniumLibrary\\keywords\\formelement.py", "lineno": 451}, {"name": "Page Should Not Contain Checkbox", "args": [{"name": "locator", "types": ["WebElement", "str"], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "locator: WebElement | str"}, {"name": "message", "types": ["str"], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "message: str = None"}, {"name": "loglevel", "types": ["str"], "defaultValue": "TRACE", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "loglevel: str = TRACE"}], "doc": "<p>Verifies checkbox <code>locator</code> is not found from the current page.</p>\n<p>See <a href=\"#Page%20Should%20Contain%20Element\" class=\"name\">Page Should Contain Element</a> for an explanation about <code>message</code> and <code>loglevel</code> arguments.</p>\n<p>See the <span class=\"name\">Locating elements</span> section for details about the locator syntax.</p>", "shortdoc": "Verifies checkbox ``locator`` is not found from the current page.", "tags": [], "source": "C:\\Python\\lib\\site-packages\\SeleniumLibrary\\keywords\\formelement.py", "lineno": 87}, {"name": "Page Should Not Contain Element", "args": [{"name": "locator", "types": ["WebElement", "str"], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "locator: WebElement | str"}, {"name": "message", "types": ["str"], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "message: str = None"}, {"name": "loglevel", "types": ["str"], "defaultValue": "TRACE", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "loglevel: str = TRACE"}], "doc": "<p>Verifies that element <code>locator</code> is not found on the current page.</p>\n<p>See the <span class=\"name\">Locating elements</span> section for details about the locator syntax.</p>\n<p>See <a href=\"#Page%20Should%20Contain\" class=\"name\">Page Should Contain</a> for an explanation about <code>message</code> and <code>loglevel</code> arguments.</p>", "shortdoc": "Verifies that element ``locator`` is not found on the current page.", "tags": [], "source": "C:\\Python\\lib\\site-packages\\SeleniumLibrary\\keywords\\element.py", "lineno": 205}, {"name": "Page Should Not Contain Image", "args": [{"name": "locator", "types": ["WebElement", "str"], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "locator: WebElement | str"}, {"name": "message", "types": ["str"], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "message: str = None"}, {"name": "loglevel", "types": ["str"], "defaultValue": "TRACE", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "loglevel: str = TRACE"}], "doc": "<p>Verifies image identified by <code>locator</code> is not found from current page.</p>\n<p>See the <span class=\"name\">Locating elements</span> section for details about the locator syntax. When using the default locator strategy, images are searched using <code>id</code>, <code>name</code>, <code>src</code> and <code>alt</code>.</p>\n<p>See <a href=\"#Page%20Should%20Contain%20Element\" class=\"name\">Page Should Contain Element</a> for an explanation about <code>message</code> and <code>loglevel</code> arguments.</p>", "shortdoc": "Verifies image identified by ``locator`` is not found from current page.", "tags": [], "source": "C:\\Python\\lib\\site-packages\\SeleniumLibrary\\keywords\\element.py", "lineno": 1084}, {"name": "Page Should Not Contain Link", "args": [{"name": "locator", "types": ["WebElement", "str"], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "locator: WebElement | str"}, {"name": "message", "types": ["str"], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "message: str = None"}, {"name": "loglevel", "types": ["str"], "defaultValue": "TRACE", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "loglevel: str = TRACE"}], "doc": "<p>Verifies link identified by <code>locator</code> is not found from current page.</p>\n<p>See the <span class=\"name\">Locating elements</span> section for details about the locator syntax. When using the default locator strategy, links are searched using <code>id</code>, <code>name</code>, <code>href</code> and the link text.</p>\n<p>See <a href=\"#Page%20Should%20Contain%20Element\" class=\"name\">Page Should Contain Element</a> for an explanation about <code>message</code> and <code>loglevel</code> arguments.</p>", "shortdoc": "Verifies link identified by ``locator`` is not found from current page.", "tags": [], "source": "C:\\Python\\lib\\site-packages\\SeleniumLibrary\\keywords\\element.py", "lineno": 1034}, {"name": "Page Should Not Contain List", "args": [{"name": "locator", "types": ["WebElement", "str"], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "locator: WebElement | str"}, {"name": "message", "types": ["str"], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "message: str = None"}, {"name": "loglevel", "types": ["str"], "defaultValue": "TRACE", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "loglevel: str = TRACE"}], "doc": "<p>Verifies selection list <code>locator</code> is not found from current page.</p>\n<p>See <a href=\"#Page%20Should%20Contain%20Element\" class=\"name\">Page Should Contain Element</a> for an explanation about <code>message</code> and <code>loglevel</code> arguments.</p>\n<p>See the <span class=\"name\">Locating elements</span> section for details about the locator syntax.</p>", "shortdoc": "Verifies selection list ``locator`` is not found from current page.", "tags": [], "source": "C:\\Python\\lib\\site-packages\\SeleniumLibrary\\keywords\\selectelement.py", "lineno": 176}, {"name": "Page Should Not Contain Radio Button", "args": [{"name": "locator", "types": ["WebElement", "str"], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "locator: WebElement | str"}, {"name": "message", "types": ["str"], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "message: str = None"}, {"name": "loglevel", "types": ["str"], "defaultValue": "TRACE", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "loglevel: str = TRACE"}], "doc": "<p>Verifies radio button <code>locator</code> is not found from current page.</p>\n<p>See <a href=\"#Page%20Should%20Contain%20Element\" class=\"name\">Page Should Contain Element</a> for an explanation about <code>message</code> and <code>loglevel</code> arguments.</p>\n<p>See the <span class=\"name\">Locating elements</span> section for details about the locator syntax. When using the default locator strategy, radio buttons are searched using <code>id</code>, <code>name</code> and <code>value</code>.</p>", "shortdoc": "Verifies radio button ``locator`` is not found from current page.", "tags": [], "source": "C:\\Python\\lib\\site-packages\\SeleniumLibrary\\keywords\\formelement.py", "lineno": 150}, {"name": "Page Should Not Contain Textfield", "args": [{"name": "locator", "types": ["WebElement", "str"], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "locator: WebElement | str"}, {"name": "message", "types": ["str"], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "message: str = None"}, {"name": "loglevel", "types": ["str"], "defaultValue": "TRACE", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "loglevel: str = TRACE"}], "doc": "<p>Verifies text field <code>locator</code> is not found from current page.</p>\n<p>See <a href=\"#Page%20Should%20Contain%20Element\" class=\"name\">Page Should Contain Element</a> for an explanation about <code>message</code> and <code>loglevel</code> arguments.</p>\n<p>See the <span class=\"name\">Locating elements</span> section for details about the locator syntax.</p>", "shortdoc": "Verifies text field ``locator`` is not found from current page.", "tags": [], "source": "C:\\Python\\lib\\site-packages\\SeleniumLibrary\\keywords\\formelement.py", "lineno": 317}, {"name": "Press Key", "args": [{"name": "locator", "types": ["WebElement", "str"], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "locator: WebElement | str"}, {"name": "key", "types": ["str"], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "key: str"}], "doc": "<p><b>DEPRECATED in SeleniumLibrary 4.0.</b> use <a href=\"#Press%20Keys\" class=\"name\">Press Keys</a> instead.</p>", "shortdoc": "*DEPRECATED in SeleniumLibrary 4.0.* use `Press Keys` instead.", "tags": [], "source": "C:\\Python\\lib\\site-packages\\SeleniumLibrary\\keywords\\element.py", "lineno": 896}, {"name": "Press Keys", "args": [{"name": "locator", "types": ["WebElement", "None", "str"], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "locator: WebElement | None | str = None"}, {"name": "keys", "types": ["str"], "defaultValue": null, "kind": "VAR_POSITIONAL", "required": false, "repr": "*keys: str"}], "doc": "<p>Simulates the user pressing key(s) to an element or on the active browser.</p>\n<p>If <code>locator</code> evaluates as false, see <span class=\"name\">Boolean arguments</span> for more details, then the <code>keys</code> are sent to the currently active browser. Otherwise element is searched and <code>keys</code> are send to the element identified by the <code>locator</code>. In later case, keyword fails if element is not found. See the <span class=\"name\">Locating elements</span> section for details about the locator syntax.</p>\n<p><code>keys</code> arguments can contain one or many strings, but it can not be empty. <code>keys</code> can also be a combination of <a href=\"https://seleniumhq.github.io/selenium/docs/api/py/webdriver/selenium.webdriver.common.keys.html\">Selenium Keys</a> and strings or a single Selenium Key. If Selenium Key is combined with strings, Selenium key and strings must be separated by the <span class=\"name\">+</span> character, like in <span class=\"name\">CONTROL+c</span>. Selenium Keys are space and case sensitive and Selenium Keys are not parsed inside of the string. Example AALTO, would send string <span class=\"name\">AALTO</span> and <span class=\"name\">ALT</span> not parsed inside of the string. But <span class=\"name\">A+ALT+O</span> would found Selenium ALT key from the <code>keys</code> argument. It also possible to press many Selenium Keys down at the same time, example 'ALT+ARROW_DOWN`.</p>\n<p>If Selenium Keys are detected in the <code>keys</code> argument, keyword will press the Selenium Key down, send the strings and then release the Selenium Key. If keyword needs to send a Selenium Key as a string, then each character must be separated with <span class=\"name\">+</span> character, example <span class=\"name\">E+N+D</span>.</p>\n<p><span class=\"name\">CTRL</span> is alias for <a href=\"https://seleniumhq.github.io/selenium/docs/api/py/webdriver/selenium.webdriver.common.keys.html#selenium.webdriver.common.keys.Keys.CONTROL\">Selenium CONTROL</a> and ESC is alias for <a href=\"https://seleniumhq.github.io/selenium/docs/api/py/webdriver/selenium.webdriver.common.keys.html#selenium.webdriver.common.keys.Keys.ESCAPE\">Selenium ESCAPE</a></p>\n<p>New in SeleniumLibrary 3.3</p>\n<p>Examples:</p>\n<table border=\"1\">\n<tr>\n<td><a href=\"#Press%20Keys\" class=\"name\">Press Keys</a></td>\n<td>text_field</td>\n<td>AAAAA</td>\n<td></td>\n<td># Sends string \"AAAAA\" to element.</td>\n</tr>\n<tr>\n<td><a href=\"#Press%20Keys\" class=\"name\">Press Keys</a></td>\n<td>None</td>\n<td>BBBBB</td>\n<td></td>\n<td># Sends string \"BBBBB\" to currently active browser.</td>\n</tr>\n<tr>\n<td><a href=\"#Press%20Keys\" class=\"name\">Press Keys</a></td>\n<td>text_field</td>\n<td>E+N+D</td>\n<td></td>\n<td># Sends string \"END\" to element.</td>\n</tr>\n<tr>\n<td><a href=\"#Press%20Keys\" class=\"name\">Press Keys</a></td>\n<td>text_field</td>\n<td>XXX</td>\n<td>YY</td>\n<td># Sends strings \"XXX\" and \"YY\" to element.</td>\n</tr>\n<tr>\n<td><a href=\"#Press%20Keys\" class=\"name\">Press Keys</a></td>\n<td>text_field</td>\n<td>XXX+YY</td>\n<td></td>\n<td># Same as above.</td>\n</tr>\n<tr>\n<td><a href=\"#Press%20Keys\" class=\"name\">Press Keys</a></td>\n<td>text_field</td>\n<td>ALT+ARROW_DOWN</td>\n<td></td>\n<td># Pressing \"ALT\" key down, then pressing ARROW_DOWN and then releasing both keys.</td>\n</tr>\n<tr>\n<td><a href=\"#Press%20Keys\" class=\"name\">Press Keys</a></td>\n<td>text_field</td>\n<td>ALT</td>\n<td>ARROW_DOWN</td>\n<td># Pressing \"ALT\" key and then pressing ARROW_DOWN.</td>\n</tr>\n<tr>\n<td><a href=\"#Press%20Keys\" class=\"name\">Press Keys</a></td>\n<td>text_field</td>\n<td>CTRL+c</td>\n<td></td>\n<td># Pressing CTRL key down, sends string \"c\" and then releases CTRL key.</td>\n</tr>\n<tr>\n<td><a href=\"#Press%20Keys\" class=\"name\">Press Keys</a></td>\n<td>button</td>\n<td>RETURN</td>\n<td></td>\n<td># Pressing \"ENTER\" key to element.</td>\n</tr>\n</table>", "shortdoc": "Simulates the user pressing key(s) to an element or on the active browser.", "tags": [], "source": "C:\\Python\\lib\\site-packages\\SeleniumLibrary\\keywords\\element.py", "lineno": 904}, {"name": "Radio Button Should Be Set To", "args": [{"name": "group_name", "types": ["str"], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "group_name: str"}, {"name": "value", "types": ["str"], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "value: str"}], "doc": "<p>Verifies radio button group <code>group_name</code> is set to <code>value</code>.</p>\n<p><code>group_name</code> is the <code>name</code> of the radio button group.</p>", "shortdoc": "Verifies radio button group ``group_name`` is set to ``value``.", "tags": [], "source": "C:\\Python\\lib\\site-packages\\SeleniumLibrary\\keywords\\formelement.py", "lineno": 168}, {"name": "Radio Button Should Not Be Selected", "args": [{"name": "group_name", "types": ["str"], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "group_name: str"}], "doc": "<p>Verifies radio button group <code>group_name</code> has no selection.</p>\n<p><code>group_name</code> is the <code>name</code> of the radio button group.</p>", "shortdoc": "Verifies radio button group ``group_name`` has no selection.", "tags": [], "source": "C:\\Python\\lib\\site-packages\\SeleniumLibrary\\keywords\\formelement.py", "lineno": 183}, {"name": "Register Keyword To Run On Failure", "args": [{"name": "keyword", "types": ["str", "None"], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "keyword: str | None"}], "doc": "<p>Sets the keyword to execute, when a SeleniumLibrary keyword fails.</p>\n<p><code>keyword</code> is the name of a keyword that will be executed if a SeleniumLibrary keyword fails. It is possible to use any available keyword, including user keywords or keywords from other libraries, but the keyword must not take any arguments.</p>\n<p>The initial keyword to use is set when <a href=\"#Importing\" class=\"name\">importing</a> the library, 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>It is possible to use string <code>NOTHING</code> or <code>NONE</code>, case-insensitively, as well as Python <code>None</code> to disable this feature altogether.</p>\n<p>This keyword returns the name of the previously registered failure keyword or Python <code>None</code> if this functionality was previously disabled. The return value can be always used to restore the original value later.</p>\n<p>Example:</p>\n<table border=\"1\">\n<tr>\n<td><a href=\"#Register%20Keyword%20To%20Run%20On%20Failure\" class=\"name\">Register Keyword To Run On Failure</a></td>\n<td>Log Source</td>\n<td></td>\n</tr>\n<tr>\n<td>${previous kw}=</td>\n<td><a href=\"#Register%20Keyword%20To%20Run%20On%20Failure\" class=\"name\">Register Keyword To Run On Failure</a></td>\n<td>NONE</td>\n</tr>\n<tr>\n<td><a href=\"#Register%20Keyword%20To%20Run%20On%20Failure\" class=\"name\">Register Keyword To Run On Failure</a></td>\n<td>${previous kw}</td>\n<td></td>\n</tr>\n</table>\n<p>Changes in SeleniumLibrary 3.0:</p>\n<ul>\n<li>Possible to use string <code>NONE</code> or Python <code>None</code> to disable the functionality.</li>\n<li>Return Python <code>None</code> when the functionality was disabled earlier. In previous versions special value <code>No Keyword</code> was returned and it could not be used to restore the original state.</li>\n</ul>", "shortdoc": "Sets the keyword to execute, when a SeleniumLibrary keyword fails.", "tags": [], "source": "C:\\Python\\lib\\site-packages\\SeleniumLibrary\\keywords\\runonfailure.py", "lineno": 23}, {"name": "Reload Page", "args": [], "doc": "<p>Simulates user reloading page.</p>", "shortdoc": "Simulates user reloading page.", "tags": [], "source": "C:\\Python\\lib\\site-packages\\SeleniumLibrary\\keywords\\browsermanagement.py", "lineno": 595}, {"name": "Remove Location Strategy", "args": [{"name": "strategy_name", "types": ["str"], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "strategy_name: str"}], "doc": "<p>Removes a previously added custom location strategy.</p>\n<p>See <span class=\"name\">Custom locators</span> for information on how to create and use custom strategies.</p>", "shortdoc": "Removes a previously added custom location strategy.", "tags": [], "source": "C:\\Python\\lib\\site-packages\\SeleniumLibrary\\keywords\\element.py", "lineno": 1135}, {"name": "Save Selenium Screenshot", "args": [], "doc": "<p>Takes a screenshot with a unique filename to be stored in Robot Framework compiled reports.</p>\n<p>If <a href=\"#Set%20Screenshot%20Directory\" class=\"name\">Set Screenshot Directory</a> has been set to <code>EMBED</code> then the screenshot will be embedded into the report</p>", "shortdoc": "Takes a screenshot with a unique filename to be stored in Robot Framework compiled reports.", "tags": [], "source": "C:\\Git\\robotframework-zoomba\\src\\Zoomba\\GUILibrary.py", "lineno": 345}, {"name": "Scroll Element Into View", "args": [{"name": "locator", "types": ["WebElement", "str"], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "locator: WebElement | str"}], "doc": "<p>Scrolls the element identified by <code>locator</code> into view.</p>\n<p>See the <span class=\"name\">Locating elements</span> section for details about the locator syntax.</p>\n<p>New in SeleniumLibrary 3.2.0</p>", "shortdoc": "Scrolls the element identified by ``locator`` into view.", "tags": [], "source": "C:\\Python\\lib\\site-packages\\SeleniumLibrary\\keywords\\element.py", "lineno": 739}, {"name": "Scroll To Bottom Of Page", "args": [], "doc": "<p>This keyword scrolls down to the bottom of the page, if jquery is not available it will scroll 20000 pixels</p>", "shortdoc": "This keyword scrolls down to the bottom of the page, if jquery is not available it will scroll 20000 pixels", "tags": [], "source": "C:\\Git\\robotframework-zoomba\\src\\Zoomba\\GUILibrary.py", "lineno": 236}, {"name": "Select All From List", "args": [{"name": "locator", "types": ["WebElement", "str"], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "locator: WebElement | str"}], "doc": "<p>Selects all options from multi-selection list <code>locator</code>.</p>\n<p>See the <span class=\"name\">Locating elements</span> section for details about the locator syntax.</p>", "shortdoc": "Selects all options from multi-selection list ``locator``.", "tags": [], "source": "C:\\Python\\lib\\site-packages\\SeleniumLibrary\\keywords\\selectelement.py", "lineno": 193}, {"name": "Select Checkbox", "args": [{"name": "locator", "types": ["WebElement", "str"], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "locator: WebElement | str"}], "doc": "<p>Selects the checkbox identified by <code>locator</code>.</p>\n<p>Does nothing if checkbox is already selected.</p>\n<p>See the <span class=\"name\">Locating elements</span> section for details about the locator syntax.</p>", "shortdoc": "Selects the checkbox identified by ``locator``.", "tags": [], "source": "C:\\Python\\lib\\site-packages\\SeleniumLibrary\\keywords\\formelement.py", "lineno": 104}, {"name": "Select Frame", "args": [{"name": "locator", "types": ["WebElement", "str"], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "locator: WebElement | str"}], "doc": "<p>Sets frame identified by <code>locator</code> as the current frame.</p>\n<p>See the <span class=\"name\">Locating elements</span> section for details about the locator syntax.</p>\n<p>Works both with frames and iframes. Use <a href=\"#Unselect%20Frame\" class=\"name\">Unselect Frame</a> to cancel the frame selection and return to the main frame.</p>\n<p>Example:</p>\n<table border=\"1\">\n<tr>\n<td><a href=\"#Select%20Frame\" class=\"name\">Select Frame</a></td>\n<td>top-frame</td>\n<td># Select frame with id or name 'top-frame'</td>\n</tr>\n<tr>\n<td><a href=\"#Click%20Link\" class=\"name\">Click Link</a></td>\n<td>example</td>\n<td># Click link 'example' in the selected frame</td>\n</tr>\n<tr>\n<td><a href=\"#Unselect%20Frame\" class=\"name\">Unselect Frame</a></td>\n<td></td>\n<td># Back to main frame.</td>\n</tr>\n<tr>\n<td><a href=\"#Select%20Frame\" class=\"name\">Select Frame</a></td>\n<td>//iframe[@name='xxx']</td>\n<td># Select frame using xpath</td>\n</tr>\n</table>", "shortdoc": "Sets frame identified by ``locator`` as the current frame.", "tags": [], "source": "C:\\Python\\lib\\site-packages\\SeleniumLibrary\\keywords\\frames.py", "lineno": 25}, {"name": "Select From List By Index", "args": [{"name": "locator", "types": ["WebElement", "str"], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "locator: WebElement | str"}, {"name": "indexes", "types": ["str"], "defaultValue": null, "kind": "VAR_POSITIONAL", "required": false, "repr": "*indexes: str"}], "doc": "<p>Selects options from selection list <code>locator</code> by <code>indexes</code>.</p>\n<p>Indexes of list options start from 0.</p>\n<p>If more than one option is given for a single-selection list, the last value will be selected. With multi-selection lists all specified options are selected, but possible old selections are not cleared.</p>\n<p>See the <span class=\"name\">Locating elements</span> section for details about the locator syntax.</p>", "shortdoc": "Selects options from selection list ``locator`` by ``indexes``.", "tags": [], "source": "C:\\Python\\lib\\site-packages\\SeleniumLibrary\\keywords\\selectelement.py", "lineno": 209}, {"name": "Select From List By Label", "args": [{"name": "locator", "types": ["WebElement", "str"], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "locator: WebElement | str"}, {"name": "labels", "types": ["str"], "defaultValue": null, "kind": "VAR_POSITIONAL", "required": false, "repr": "*labels: str"}], "doc": "<p>Selects options from selection list <code>locator</code> by <code>labels</code>.</p>\n<p>If more than one option is given for a single-selection list, the last value will be selected. With multi-selection lists all specified options are selected, but possible old selections are not cleared.</p>\n<p>See the <span class=\"name\">Locating elements</span> section for details about the locator syntax.</p>", "shortdoc": "Selects options from selection list ``locator`` by ``labels``.", "tags": [], "source": "C:\\Python\\lib\\site-packages\\SeleniumLibrary\\keywords\\selectelement.py", "lineno": 256}, {"name": "Select From List By Value", "args": [{"name": "locator", "types": ["WebElement", "str"], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "locator: WebElement | str"}, {"name": "values", "types": ["str"], "defaultValue": null, "kind": "VAR_POSITIONAL", "required": false, "repr": "*values: str"}], "doc": "<p>Selects options from selection list <code>locator</code> by <code>values</code>.</p>\n<p>If more than one option is given for a single-selection list, the last value will be selected. With multi-selection lists all specified options are selected, but possible old selections are not cleared.</p>\n<p>See the <span class=\"name\">Locating elements</span> section for details about the locator syntax.</p>", "shortdoc": "Selects options from selection list ``locator`` by ``values``.", "tags": [], "source": "C:\\Python\\lib\\site-packages\\SeleniumLibrary\\keywords\\selectelement.py", "lineno": 234}, {"name": "Select Nested Frame", "args": [{"name": "locators", "types": [], "defaultValue": null, "kind": "VAR_POSITIONAL", "required": false, "repr": "*locators"}], "doc": "<p>Selects a frame nested in other frames</p>\n<p>locators: (list) A list of selenium locators(CSS, XPATH, ID, NAME, etc)</p>\n<p>Example (Selects iframe3 after traversing iframe1 and iframe2):</p>\n<table border=\"1\">\n<tr>\n<td><a href=\"#Select%20Nested%20Frame\" class=\"name\">Select Nested Frame</a></td>\n<td>id-iframe1</td>\n<td>id=iframe2</td>\n<td>id=iframe3</td>\n</tr>\n</table>", "shortdoc": "Selects a frame nested in other frames", "tags": [], "source": "C:\\Git\\robotframework-zoomba\\src\\Zoomba\\GUILibrary.py", "lineno": 101}, {"name": "Select Radio Button", "args": [{"name": "group_name", "types": ["str"], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "group_name: str"}, {"name": "value", "types": ["str"], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "value: str"}], "doc": "<p>Sets the radio button group <code>group_name</code> to <code>value</code>.</p>\n<p>The radio button to be selected is located by two arguments:</p>\n<ul>\n<li><code>group_name</code> is the name of the radio button group.</li>\n<li><code>value</code> is the <code>id</code> or <code>value</code> attribute of the actual radio button.</li>\n</ul>\n<p>Examples:</p>\n<table border=\"1\">\n<tr>\n<td><a href=\"#Select%20Radio%20Button\" class=\"name\">Select Radio Button</a></td>\n<td>size</td>\n<td>XL</td>\n</tr>\n<tr>\n<td><a href=\"#Select%20Radio%20Button\" class=\"name\">Select Radio Button</a></td>\n<td>contact</td>\n<td>email</td>\n</tr>\n</table>", "shortdoc": "Sets the radio button group ``group_name`` to ``value``.", "tags": [], "source": "C:\\Python\\lib\\site-packages\\SeleniumLibrary\\keywords\\formelement.py", "lineno": 198}, {"name": "Set Browser Implicit Wait", "args": [{"name": "value", "types": ["timedelta"], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "value: timedelta"}], "doc": "<p>Sets the implicit wait value used by Selenium.</p>\n<p>Same as <a href=\"#Set%20Selenium%20Implicit%20Wait\" class=\"name\">Set Selenium Implicit Wait</a> but only affects the current browser.</p>", "shortdoc": "Sets the implicit wait value used by Selenium.", "tags": [], "source": "C:\\Python\\lib\\site-packages\\SeleniumLibrary\\keywords\\browsermanagement.py", "lineno": 698}, {"name": "Set Focus To Element", "args": [{"name": "locator", "types": ["WebElement", "str"], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "locator: WebElement | str"}], "doc": "<p>Sets the focus to the element identified by <code>locator</code>.</p>\n<p>See the <span class=\"name\">Locating elements</span> section for details about the locator syntax.</p>\n<p>Prior to SeleniumLibrary 3.0 this keyword was named <span class=\"name\">Focus</span>.</p>", "shortdoc": "Sets the focus to the element identified by ``locator``.", "tags": [], "source": "C:\\Python\\lib\\site-packages\\SeleniumLibrary\\keywords\\element.py", "lineno": 727}, {"name": "Set Screenshot Directory", "args": [{"name": "path", "types": ["None", "str"], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "path: None | str"}], "doc": "<p>Sets the directory for captured screenshots.</p>\n<p><code>path</code> argument specifies the absolute path to a directory where the screenshots should be written to. If the directory does not exist, it will be created. The directory can also be set when <a href=\"#Importing\" class=\"name\">importing</a> the library. If it is not configured anywhere, screenshots are saved to the same directory where Robot Framework's log file is written.</p>\n<p>If <code>path</code> equals to EMBED (case insensitive) and <a href=\"#Capture%20Page%20Screenshot\" class=\"name\">Capture Page Screenshot</a> or <a href=\"#Capture%20Element%20Screenshot\" class=\"name\">capture Element Screenshot</a> keywords filename argument is not changed from the default value, then the page or element screenshot is embedded as Base64 image to the log.html.</p>\n<p>The previous value is returned and can be used to restore the original value later if needed.</p>\n<p>Returning the previous value is new in SeleniumLibrary 3.0. The persist argument was removed in SeleniumLibrary 3.2 and EMBED is new in SeleniumLibrary 4.2.</p>", "shortdoc": "Sets the directory for captured screenshots.", "tags": [], "source": "C:\\Python\\lib\\site-packages\\SeleniumLibrary\\keywords\\screenshot.py", "lineno": 32}, {"name": "Set Selenium Implicit Wait", "args": [{"name": "value", "types": ["timedelta"], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "value: timedelta"}], "doc": "<p>Sets the implicit wait value used by Selenium.</p>\n<p>The value can be given as a number that is considered to be seconds or as a human-readable string like <code>1 second</code>. The previous value is returned and can be used to restore the original value later if needed.</p>\n<p>This keyword sets the implicit wait for all opened browsers. Use <a href=\"#Set%20Browser%20Implicit%20Wait\" class=\"name\">Set Browser Implicit Wait</a> to set it only to the current browser.</p>\n<p>See the <span class=\"name\">Implicit wait</span> section above for more information.</p>\n<p>Example:</p>\n<table border=\"1\">\n<tr>\n<td>${orig wait} =</td>\n<td><a href=\"#Set%20Selenium%20Implicit%20Wait\" class=\"name\">Set Selenium Implicit Wait</a></td>\n<td>10 seconds</td>\n</tr>\n<tr>\n<td><span class=\"name\">Perform AJAX call that is slow</span></td>\n<td></td>\n<td></td>\n</tr>\n<tr>\n<td><a href=\"#Set%20Selenium%20Implicit%20Wait\" class=\"name\">Set Selenium Implicit Wait</a></td>\n<td>${orig wait}</td>\n<td></td>\n</tr>\n</table>", "shortdoc": "Sets the implicit wait value used by Selenium.", "tags": [], "source": "C:\\Python\\lib\\site-packages\\SeleniumLibrary\\keywords\\browsermanagement.py", "lineno": 672}, {"name": "Set Selenium Speed", "args": [{"name": "value", "types": ["timedelta"], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "value: timedelta"}], "doc": "<p>Sets the delay that is waited after each Selenium command.</p>\n<p>The value can be given as a number that is considered to be seconds or as a human-readable string like <code>1 second</code>. The previous value is returned and can be used to restore the original value later if needed.</p>\n<p>See the <span class=\"name\">Selenium Speed</span> section above for more information.</p>\n<p>Example:</p>\n<table border=\"1\">\n<tr>\n<td><a href=\"#Set%20Selenium%20Speed\" class=\"name\">Set Selenium Speed</a></td>\n<td>0.5 seconds</td>\n</tr>\n</table>", "shortdoc": "Sets the delay that is waited after each Selenium command.", "tags": [], "source": "C:\\Python\\lib\\site-packages\\SeleniumLibrary\\keywords\\browsermanagement.py", "lineno": 630}, {"name": "Set Selenium Timeout", "args": [{"name": "value", "types": ["timedelta"], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "value: timedelta"}], "doc": "<p>Sets the timeout that is used by various keywords.</p>\n<p>The value can be given as a number that is considered to be seconds or as a human-readable string like <code>1 second</code>. The previous value is returned and can be used to restore the original value later if needed.</p>\n<p>See the <span class=\"name\">Timeout</span> section above for more information.</p>\n<p>Example:</p>\n<table border=\"1\">\n<tr>\n<td>${orig timeout} =</td>\n<td><a href=\"#Set%20Selenium%20Timeout\" class=\"name\">Set Selenium Timeout</a></td>\n<td>15 seconds</td>\n</tr>\n<tr>\n<td><span class=\"name\">Open page that loads slowly</span></td>\n<td></td>\n<td></td>\n</tr>\n<tr>\n<td><a href=\"#Set%20Selenium%20Timeout\" class=\"name\">Set Selenium Timeout</a></td>\n<td>${orig timeout}</td>\n<td></td>\n</tr>\n</table>", "shortdoc": "Sets the timeout that is used by various keywords.", "tags": [], "source": "C:\\Python\\lib\\site-packages\\SeleniumLibrary\\keywords\\browsermanagement.py", "lineno": 650}, {"name": "Set Window Position", "args": [{"name": "x", "types": ["int"], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "x: int"}, {"name": "y", "types": ["int"], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "y: int"}], "doc": "<p>Sets window position using <code>x</code> and <code>y</code> coordinates.</p>\n<p>The position is relative to the top left corner of the screen, but some browsers exclude possible task bar set by the operating system from the calculation. The actual position may thus be different with different browsers.</p>\n<p>Values can be given using strings containing numbers or by using actual numbers. See also <a href=\"#Get%20Window%20Position\" class=\"name\">Get Window Position</a>.</p>\n<p>Example:</p>\n<table border=\"1\">\n<tr>\n<td><a href=\"#Set%20Window%20Position\" class=\"name\">Set Window Position</a></td>\n<td>100</td>\n<td>200</td>\n</tr>\n</table>", "shortdoc": "Sets window position using ``x`` and ``y`` coordinates.", "tags": [], "source": "C:\\Python\\lib\\site-packages\\SeleniumLibrary\\keywords\\window.py", "lineno": 269}, {"name": "Set Window Size", "args": [{"name": "width", "types": ["int"], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "width: int"}, {"name": "height", "types": ["int"], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "height: int"}, {"name": "inner", "types": ["bool"], "defaultValue": "False", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "inner: bool = False"}], "doc": "<p>Sets current windows size to given <code>width</code> and <code>height</code>.</p>\n<p>Values can be given using strings containing numbers or by using actual numbers. See also <a href=\"#Get%20Window%20Size\" class=\"name\">Get Window Size</a>.</p>\n<p>Browsers have a limit on their minimum size. Trying to set them smaller will cause the actual size to be bigger than the requested size.</p>\n<p>If <code>inner</code> parameter is set to True, keyword sets the necessary window width and height to have the desired HTML DOM <i>window.innerWidth</i> and <i>window.innerHeight</i>. See <span class=\"name\">Boolean arguments</span> for more details on how to set boolean arguments.</p>\n<p>The <code>inner</code> argument is new since SeleniumLibrary 4.0.</p>\n<p>This <code>inner</code> argument does not support Frames. If a frame is selected, switch to default before running this.</p>\n<p>Example:</p>\n<table border=\"1\">\n<tr>\n<td><a href=\"#Set%20Window%20Size\" class=\"name\">Set Window Size</a></td>\n<td>800</td>\n<td>600</td>\n<td></td>\n</tr>\n<tr>\n<td><a href=\"#Set%20Window%20Size\" class=\"name\">Set Window Size</a></td>\n<td>800</td>\n<td>600</td>\n<td>True</td>\n</tr>\n</table>", "shortdoc": "Sets current windows size to given ``width`` and ``height``.", "tags": [], "source": "C:\\Python\\lib\\site-packages\\SeleniumLibrary\\keywords\\window.py", "lineno": 212}, {"name": "Simulate Event", "args": [{"name": "locator", "types": ["WebElement", "str"], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "locator: WebElement | str"}, {"name": "event", "types": ["str"], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "event: str"}], "doc": "<p>Simulates <code>event</code> on the element identified by <code>locator</code>.</p>\n<p>This keyword is useful if element has <code>OnEvent</code> handler that needs to be explicitly invoked.</p>\n<p>See the <span class=\"name\">Locating elements</span> section for details about the locator syntax.</p>\n<p>Prior to SeleniumLibrary 3.0 this keyword was named <span class=\"name\">Simulate</span>.</p>", "shortdoc": "Simulates ``event`` on the element identified by ``locator``.", "tags": [], "source": "C:\\Python\\lib\\site-packages\\SeleniumLibrary\\keywords\\element.py", "lineno": 871}, {"name": "Submit Form", "args": [{"name": "locator", "types": ["WebElement", "None", "str"], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "locator: WebElement | None | str = None"}], "doc": "<p>Submits a form identified by <code>locator</code>.</p>\n<p>If <code>locator</code> is not given, first form on the page is submitted.</p>\n<p>See the <span class=\"name\">Locating elements</span> section for details about the locator syntax.</p>", "shortdoc": "Submits a form identified by ``locator``.", "tags": [], "source": "C:\\Python\\lib\\site-packages\\SeleniumLibrary\\keywords\\formelement.py", "lineno": 29}, {"name": "Switch Browser", "args": [{"name": "index_or_alias", "types": ["str"], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "index_or_alias: str"}], "doc": "<p>Switches between active browsers using <code>index_or_alias</code>.</p>\n<p>Indices are returned by the <a href=\"#Open%20Browser\" class=\"name\">Open Browser</a> keyword and aliases can be given to it explicitly. Indices start from 1.</p>\n<p>Example:</p>\n<table border=\"1\">\n<tr>\n<td><a href=\"#Open%20Browser\" class=\"name\">Open Browser</a></td>\n<td><a href=\"http://google.com\">http://google.com</a></td>\n<td>ff</td>\n<td></td>\n</tr>\n<tr>\n<td><a href=\"#Location%20Should%20Be\" class=\"name\">Location Should Be</a></td>\n<td><a href=\"http://google.com\">http://google.com</a></td>\n<td></td>\n<td></td>\n</tr>\n<tr>\n<td><a href=\"#Open%20Browser\" class=\"name\">Open Browser</a></td>\n<td><a href=\"http://yahoo.com\">http://yahoo.com</a></td>\n<td>ie</td>\n<td>alias=second</td>\n</tr>\n<tr>\n<td><a href=\"#Location%20Should%20Be\" class=\"name\">Location Should Be</a></td>\n<td><a href=\"http://yahoo.com\">http://yahoo.com</a></td>\n<td></td>\n<td></td>\n</tr>\n<tr>\n<td><a href=\"#Switch%20Browser\" class=\"name\">Switch Browser</a></td>\n<td>1</td>\n<td># index</td>\n<td></td>\n</tr>\n<tr>\n<td><a href=\"#Page%20Should%20Contain\" class=\"name\">Page Should Contain</a></td>\n<td>I'm feeling lucky</td>\n<td></td>\n<td></td>\n</tr>\n<tr>\n<td><a href=\"#Switch%20Browser\" class=\"name\">Switch Browser</a></td>\n<td>second</td>\n<td># alias</td>\n<td></td>\n</tr>\n<tr>\n<td><a href=\"#Page%20Should%20Contain\" class=\"name\">Page Should Contain</a></td>\n<td>More Yahoo!</td>\n<td></td>\n<td></td>\n</tr>\n<tr>\n<td><a href=\"#Close%20All%20Browsers\" class=\"name\">Close All Browsers</a></td>\n<td></td>\n<td></td>\n<td></td>\n</tr>\n</table>\n<p>Above example expects that there was no other open browsers when opening the first one because it used index <code>1</code> when switching to it later. If you are not sure about that, you can store the index into a variable as below.</p>\n<table border=\"1\">\n<tr>\n<td>${index} =</td>\n<td><a href=\"#Open%20Browser\" class=\"name\">Open Browser</a></td>\n<td><a href=\"http://google.com\">http://google.com</a></td>\n</tr>\n<tr>\n<td># Do something ...</td>\n<td></td>\n<td></td>\n</tr>\n<tr>\n<td><a href=\"#Switch%20Browser\" class=\"name\">Switch Browser</a></td>\n<td>${index}</td>\n<td></td>\n</tr>\n</table>", "shortdoc": "Switches between active browsers using ``index_or_alias``.", "tags": [], "source": "C:\\Python\\lib\\site-packages\\SeleniumLibrary\\keywords\\browsermanagement.py", "lineno": 405}, {"name": "Switch Window", "args": [{"name": "locator", "types": ["list", "str"], "defaultValue": "MAIN", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "locator: list | str = MAIN"}, {"name": "timeout", "types": ["str"], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "timeout: str = None"}, {"name": "browser", "types": ["str"], "defaultValue": "CURRENT", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "browser: str = CURRENT"}], "doc": "<p>Switches to browser window matching <code>locator</code>.</p>\n<p>If the window is found, all subsequent commands use the selected window, until this keyword is used again. If the window is not found, this keyword fails. The previous windows handle is returned and can be used to switch back to it later.</p>\n<p>Notice that alerts should be handled with <a href=\"#Handle%20Alert\" class=\"name\">Handle Alert</a> or other alert related keywords.</p>\n<p>The <code>locator</code> can be specified using different strategies somewhat similarly as when <span class=\"name\">locating elements</span> on pages.</p>\n<ul>\n<li>By default, the <code>locator</code> is matched against window handle, name, title, and URL. Matching is done in that order and the first matching window is selected.</li>\n</ul>\n<ul>\n<li>The <code>locator</code> can specify an explicit strategy by using the format <code>strategy:value</code> (recommended) or <code>strategy=value</code>. Supported strategies are <code>name</code>, <code>title</code>, and <code>url</code>. These matches windows using their name, title, or URL, respectively. Additionally, <code>default</code> can be used to explicitly use the default strategy explained above.</li>\n</ul>\n<ul>\n<li>If the <code>locator</code> is <code>NEW</code> (case-insensitive), the latest opened window is selected. It is an error if this is the same as the current window.</li>\n</ul>\n<ul>\n<li>If the <code>locator</code> is <code>MAIN</code> (default, case-insensitive), the main window is selected.</li>\n</ul>\n<ul>\n<li>If the <code>locator</code> is <code>CURRENT</code> (case-insensitive), nothing is done. This effectively just returns the current window handle.</li>\n</ul>\n<ul>\n<li>If the <code>locator</code> is not a string, it is expected to be a list of window handles <i>to exclude</i>. Such a list of excluded windows can be got from <a href=\"#Get%20Window%20Handles\" class=\"name\">Get Window Handles</a> before doing an action that opens a new window.</li>\n</ul>\n<p>The <code>timeout</code> is used to specify how long keyword will poll to select the new window. The <code>timeout</code> is new in SeleniumLibrary 3.2.</p>\n<p>Example:</p>\n<table border=\"1\">\n<tr>\n<td><a href=\"#Click%20Link\" class=\"name\">Click Link</a></td>\n<td>popup1</td>\n<td></td>\n<td># Open new window</td>\n</tr>\n<tr>\n<td><a href=\"#Switch%20Window\" class=\"name\">Switch Window</a></td>\n<td>example</td>\n<td></td>\n<td># Select window using default strategy</td>\n</tr>\n<tr>\n<td><a href=\"#Title%20Should%20Be\" class=\"name\">Title Should Be</a></td>\n<td>Pop-up 1</td>\n<td></td>\n<td></td>\n</tr>\n<tr>\n<td><a href=\"#Click%20Button\" class=\"name\">Click Button</a></td>\n<td>popup2</td>\n<td></td>\n<td># Open another window</td>\n</tr>\n<tr>\n<td>${handle} =</td>\n<td><a href=\"#Switch%20Window\" class=\"name\">Switch Window</a></td>\n<td>NEW</td>\n<td># Select latest opened window</td>\n</tr>\n<tr>\n<td><a href=\"#Title%20Should%20Be\" class=\"name\">Title Should Be</a></td>\n<td>Pop-up 2</td>\n<td></td>\n<td></td>\n</tr>\n<tr>\n<td><a href=\"#Switch%20Window\" class=\"name\">Switch Window</a></td>\n<td>${handle}</td>\n<td></td>\n<td># Select window using handle</td>\n</tr>\n<tr>\n<td><a href=\"#Title%20Should%20Be\" class=\"name\">Title Should Be</a></td>\n<td>Pop-up 1</td>\n<td></td>\n<td></td>\n</tr>\n<tr>\n<td><a href=\"#Switch%20Window\" class=\"name\">Switch Window</a></td>\n<td>MAIN</td>\n<td></td>\n<td># Select the main window</td>\n</tr>\n<tr>\n<td><a href=\"#Title%20Should%20Be\" class=\"name\">Title Should Be</a></td>\n<td>Main</td>\n<td></td>\n<td></td>\n</tr>\n<tr>\n<td>${excludes} =</td>\n<td><a href=\"#Get%20Window%20Handles\" class=\"name\">Get Window Handles</a></td>\n<td></td>\n<td># Get list of current windows</td>\n</tr>\n<tr>\n<td><a href=\"#Click%20Link\" class=\"name\">Click Link</a></td>\n<td>popup3</td>\n<td></td>\n<td># Open one more window</td>\n</tr>\n<tr>\n<td><a href=\"#Switch%20Window\" class=\"name\">Switch Window</a></td>\n<td>${excludes}</td>\n<td></td>\n<td># Select window using excludes</td>\n</tr>\n<tr>\n<td><a href=\"#Title%20Should%20Be\" class=\"name\">Title Should Be</a></td>\n<td>Pop-up 3</td>\n<td></td>\n<td></td>\n</tr>\n</table>\n<p>The <code>browser</code> argument allows with <code>index_or_alias</code> to implicitly switch to a specific browser when switching to a window. See <a href=\"#Switch%20Browser\" class=\"name\">Switch Browser</a></p>\n<ul>\n<li>If the <code>browser</code> is <code>CURRENT</code> (case-insensitive), no other browser is selected.</li>\n</ul>\n<p><b>NOTE:</b></p>\n<ul>\n<li>The <code>strategy:value</code> syntax is only supported by SeleniumLibrary 3.0 and newer.</li>\n<li>Prior to SeleniumLibrary 3.0 matching windows by name, title and URL was case-insensitive.</li>\n<li>Earlier versions supported aliases <code>None</code>, <code>null</code> and the empty string for selecting the main window, and alias <code>self</code> for selecting the current window. Support for these aliases was removed in SeleniumLibrary 3.2.</li>\n</ul>", "shortdoc": "Switches to browser window matching ``locator``.", "tags": [], "source": "C:\\Python\\lib\\site-packages\\SeleniumLibrary\\keywords\\window.py", "lineno": 33}, {"name": "Table Cell Should Contain", "args": [{"name": "locator", "types": ["WebElement", "None", "str"], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "locator: WebElement | None | str"}, {"name": "row", "types": ["int"], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "row: int"}, {"name": "column", "types": ["int"], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "column: int"}, {"name": "expected", "types": ["str"], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "expected: str"}, {"name": "loglevel", "types": ["str"], "defaultValue": "TRACE", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "loglevel: str = TRACE"}], "doc": "<p>Verifies table cell contains text <code>expected</code>.</p>\n<p>See <a href=\"#Get%20Table%20Cell\" class=\"name\">Get Table Cell</a> that this keyword uses internally for an explanation about accepted arguments.</p>", "shortdoc": "Verifies table cell contains text ``expected``.", "tags": [], "source": "C:\\Python\\lib\\site-packages\\SeleniumLibrary\\keywords\\tableelement.py", "lineno": 90}, {"name": "Table Column Should Contain", "args": [{"name": "locator", "types": ["WebElement", "None", "str"], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "locator: WebElement | None | str"}, {"name": "column", "types": ["int"], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "column: int"}, {"name": "expected", "types": ["str"], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "expected: str"}, {"name": "loglevel", "types": ["str"], "defaultValue": "TRACE", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "loglevel: str = TRACE"}], "doc": "<p>Verifies table column contains text <code>expected</code>.</p>\n<p>The table is located using the <code>locator</code> argument and its column found using <code>column</code>. See the <span class=\"name\">Locating elements</span> section for details about the locator syntax.</p>\n<p>Column indexes start from 1. It is possible to refer to columns from the end by using negative indexes so that -1 is the last column, -2 is the second last, and so on.</p>\n<p>If a table contains cells that span multiple columns, those merged cells count as a single column.</p>\n<p>See <a href=\"#Page%20Should%20Contain%20Element\" class=\"name\">Page Should Contain Element</a> for an explanation about the <code>loglevel</code> argument.</p>", "shortdoc": "Verifies table column contains text ``expected``.", "tags": [], "source": "C:\\Python\\lib\\site-packages\\SeleniumLibrary\\keywords\\tableelement.py", "lineno": 113}, {"name": "Table Footer Should Contain", "args": [{"name": "locator", "types": ["WebElement", "None", "str"], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "locator: WebElement | None | str"}, {"name": "expected", "types": ["str"], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "expected: str"}, {"name": "loglevel", "types": ["str"], "defaultValue": "TRACE", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "loglevel: str = TRACE"}], "doc": "<p>Verifies table footer contains text <code>expected</code>.</p>\n<p>Any <code>&lt;td&gt;</code> element inside <code>&lt;tfoot&gt;</code> element is considered to be part of the footer.</p>\n<p>The table is located using the <code>locator</code> argument. See the <span class=\"name\">Locating elements</span> section for details about the locator syntax.</p>\n<p>See <a href=\"#Page%20Should%20Contain%20Element\" class=\"name\">Page Should Contain Element</a> for an explanation about the <code>loglevel</code> argument.</p>", "shortdoc": "Verifies table footer contains text ``expected``.", "tags": [], "source": "C:\\Python\\lib\\site-packages\\SeleniumLibrary\\keywords\\tableelement.py", "lineno": 144}, {"name": "Table Header Should Contain", "args": [{"name": "locator", "types": ["WebElement", "None", "str"], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "locator: WebElement | None | str"}, {"name": "expected", "types": ["str"], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "expected: str"}, {"name": "loglevel", "types": ["str"], "defaultValue": "TRACE", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "loglevel: str = TRACE"}], "doc": "<p>Verifies table header contains text <code>expected</code>.</p>\n<p>Any <code>&lt;th&gt;</code> element anywhere in the table is considered to be part of the header.</p>\n<p>The table is located using the <code>locator</code> argument. See the <span class=\"name\">Locating elements</span> section for details about the locator syntax.</p>\n<p>See <a href=\"#Page%20Should%20Contain%20Element\" class=\"name\">Page Should Contain Element</a> for an explanation about the <code>loglevel</code> argument.</p>", "shortdoc": "Verifies table header contains text ``expected``.", "tags": [], "source": "C:\\Python\\lib\\site-packages\\SeleniumLibrary\\keywords\\tableelement.py", "lineno": 169}, {"name": "Table Row Should Contain", "args": [{"name": "locator", "types": ["WebElement", "None", "str"], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "locator: WebElement | None | str"}, {"name": "row", "types": ["int"], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "row: int"}, {"name": "expected", "types": ["str"], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "expected: str"}, {"name": "loglevel", "types": ["str"], "defaultValue": "TRACE", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "loglevel: str = TRACE"}], "doc": "<p>Verifies that table row contains text <code>expected</code>.</p>\n<p>The table is located using the <code>locator</code> argument and its column found using <code>column</code>. See the <span class=\"name\">Locating elements</span> section for details about the locator syntax.</p>\n<p>Row indexes start from 1. It is possible to refer to rows from the end by using negative indexes so that -1 is the last row, -2 is the second last, and so on.</p>\n<p>If a table contains cells that span multiple rows, a match only occurs for the uppermost row of those merged cells.</p>\n<p>See <a href=\"#Page%20Should%20Contain%20Element\" class=\"name\">Page Should Contain Element</a> for an explanation about the <code>loglevel</code> argument.</p>", "shortdoc": "Verifies that table row contains text ``expected``.", "tags": [], "source": "C:\\Python\\lib\\site-packages\\SeleniumLibrary\\keywords\\tableelement.py", "lineno": 194}, {"name": "Table Should Contain", "args": [{"name": "locator", "types": ["WebElement", "None", "str"], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "locator: WebElement | None | str"}, {"name": "expected", "types": ["str"], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "expected: str"}, {"name": "loglevel", "types": ["str"], "defaultValue": "TRACE", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "loglevel: str = TRACE"}], "doc": "<p>Verifies table contains text <code>expected</code>.</p>\n<p>The table is located using the <code>locator</code> argument. See the <span class=\"name\">Locating elements</span> section for details about the locator syntax.</p>\n<p>See <a href=\"#Page%20Should%20Contain%20Element\" class=\"name\">Page Should Contain Element</a> for an explanation about the <code>loglevel</code> argument.</p>", "shortdoc": "Verifies table contains text ``expected``.", "tags": [], "source": "C:\\Python\\lib\\site-packages\\SeleniumLibrary\\keywords\\tableelement.py", "lineno": 225}, {"name": "Textarea Should Contain", "args": [{"name": "locator", "types": ["WebElement", "str"], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "locator: WebElement | str"}, {"name": "expected", "types": ["str"], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "expected: str"}, {"name": "message", "types": ["str"], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "message: str = None"}], "doc": "<p>Verifies text area <code>locator</code> contains text <code>expected</code>.</p>\n<p><code>message</code> can be used to override default error message.</p>\n<p>See the <span class=\"name\">Locating elements</span> section for details about the locator syntax.</p>", "shortdoc": "Verifies text area ``locator`` contains text ``expected``.", "tags": [], "source": "C:\\Python\\lib\\site-packages\\SeleniumLibrary\\keywords\\formelement.py", "lineno": 382}, {"name": "Textarea Value Should Be", "args": [{"name": "locator", "types": ["WebElement", "str"], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "locator: WebElement | str"}, {"name": "expected", "types": ["str"], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "expected: str"}, {"name": "message", "types": ["str"], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "message: str = None"}], "doc": "<p>Verifies text area <code>locator</code> has exactly text <code>expected</code>.</p>\n<p><code>message</code> can be used to override default error message.</p>\n<p>See the <span class=\"name\">Locating elements</span> section for details about the locator syntax.</p>", "shortdoc": "Verifies text area ``locator`` has exactly text ``expected``.", "tags": [], "source": "C:\\Python\\lib\\site-packages\\SeleniumLibrary\\keywords\\formelement.py", "lineno": 406}, {"name": "Textfield Should Contain", "args": [{"name": "locator", "types": ["WebElement", "str"], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "locator: WebElement | str"}, {"name": "expected", "types": ["str"], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "expected: str"}, {"name": "message", "types": ["str"], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "message: str = None"}], "doc": "<p>Verifies text field <code>locator</code> contains text <code>expected</code>.</p>\n<p><code>message</code> can be used to override the default error message.</p>\n<p>See the <span class=\"name\">Locating elements</span> section for details about the locator syntax.</p>", "shortdoc": "Verifies text field ``locator`` contains text ``expected``.", "tags": [], "source": "C:\\Python\\lib\\site-packages\\SeleniumLibrary\\keywords\\formelement.py", "lineno": 334}, {"name": "Textfield Value Should Be", "args": [{"name": "locator", "types": ["WebElement", "str"], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "locator: WebElement | str"}, {"name": "expected", "types": ["str"], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "expected: str"}, {"name": "message", "types": ["str"], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "message: str = None"}], "doc": "<p>Verifies text field <code>locator</code> has exactly text <code>expected</code>.</p>\n<p><code>message</code> can be used to override default error message.</p>\n<p>See the <span class=\"name\">Locating elements</span> section for details about the locator syntax.</p>", "shortdoc": "Verifies text field ``locator`` has exactly text ``expected``.", "tags": [], "source": "C:\\Python\\lib\\site-packages\\SeleniumLibrary\\keywords\\formelement.py", "lineno": 358}, {"name": "Title Should Be", "args": [{"name": "title", "types": ["str"], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "title: str"}, {"name": "message", "types": ["str"], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "message: str = None"}], "doc": "<p>Verifies that the current page title equals <code>title</code>.</p>\n<p>The <code>message</code> argument can be used to override the default error message.</p>\n<p><code>message</code> argument is new in SeleniumLibrary 3.1.</p>", "shortdoc": "Verifies that the current page title equals ``title``.", "tags": [], "source": "C:\\Python\\lib\\site-packages\\SeleniumLibrary\\keywords\\browsermanagement.py", "lineno": 568}, {"name": "Truncate String", "args": [{"name": "string", "types": [], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "string"}, {"name": "number_of_characters", "types": [], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "number_of_characters"}], "doc": "<p>Truncates a given string to a certain amount of the given number of characters parameter.</p>\n<p>string: (string) Original String number_of_characters: (integer) Truncation index return: (string) A truncated String</p>", "shortdoc": "Truncates a given string to a certain amount of the given number of characters parameter.", "tags": [], "source": "C:\\Git\\robotframework-zoomba\\src\\Zoomba\\GUILibrary.py", "lineno": 335}, {"name": "Unselect All From List", "args": [{"name": "locator", "types": ["WebElement", "str"], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "locator: WebElement | str"}], "doc": "<p>Unselects all options from multi-selection list <code>locator</code>.</p>\n<p>See the <span class=\"name\">Locating elements</span> section for details about the locator syntax.</p>\n<p>New in SeleniumLibrary 3.0.</p>", "shortdoc": "Unselects all options from multi-selection list ``locator``.", "tags": [], "source": "C:\\Python\\lib\\site-packages\\SeleniumLibrary\\keywords\\selectelement.py", "lineno": 278}, {"name": "Unselect And Select Frame", "args": [{"name": "locator", "types": [], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "locator"}, {"name": "timeout", "types": [], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "timeout=None"}], "doc": "<p>This is a series of chained Selenium keywords, that first unselects the current iFrame, then executes a wait for and select frame for a new iFrame.</p>\n<p>locator: (string) A selenium locator(CSS, XPATH, ID, NAME, etc) timeout: (float) Time in seconds to wait, will use global timeout if not set.</p>", "shortdoc": "This is a series of chained Selenium keywords, that first unselects the current iFrame, then executes a wait for and select frame for a new iFrame.", "tags": [], "source": "C:\\Git\\robotframework-zoomba\\src\\Zoomba\\GUILibrary.py", "lineno": 114}, {"name": "Unselect Checkbox", "args": [{"name": "locator", "types": ["WebElement", "str"], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "locator: WebElement | str"}], "doc": "<p>Removes the selection of checkbox identified by <code>locator</code>.</p>\n<p>Does nothing if the checkbox is not selected.</p>\n<p>See the <span class=\"name\">Locating elements</span> section for details about the locator syntax.</p>", "shortdoc": "Removes the selection of checkbox identified by ``locator``.", "tags": [], "source": "C:\\Python\\lib\\site-packages\\SeleniumLibrary\\keywords\\formelement.py", "lineno": 118}, {"name": "Unselect Frame", "args": [], "doc": "<p>Sets the main frame as the current frame.</p>\n<p>In practice cancels the previous <a href=\"#Select%20Frame\" class=\"name\">Select Frame</a> call.</p>", "shortdoc": "Sets the main frame as the current frame.", "tags": [], "source": "C:\\Python\\lib\\site-packages\\SeleniumLibrary\\keywords\\frames.py", "lineno": 45}, {"name": "Unselect From List By Index", "args": [{"name": "locator", "types": ["WebElement", "str"], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "locator: WebElement | str"}, {"name": "indexes", "types": ["str"], "defaultValue": null, "kind": "VAR_POSITIONAL", "required": false, "repr": "*indexes: str"}], "doc": "<p>Unselects options from selection list <code>locator</code> by <code>indexes</code>.</p>\n<p>Indexes of list options start from 0. This keyword works only with multi-selection lists.</p>\n<p>See the <span class=\"name\">Locating elements</span> section for details about the locator syntax.</p>", "shortdoc": "Unselects options from selection list ``locator`` by ``indexes``.", "tags": [], "source": "C:\\Python\\lib\\site-packages\\SeleniumLibrary\\keywords\\selectelement.py", "lineno": 295}, {"name": "Unselect From List By Label", "args": [{"name": "locator", "types": ["WebElement", "str"], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "locator: WebElement | str"}, {"name": "labels", "types": ["str"], "defaultValue": null, "kind": "VAR_POSITIONAL", "required": false, "repr": "*labels: str"}], "doc": "<p>Unselects options from selection list <code>locator</code> by <code>labels</code>.</p>\n<p>This keyword works only with multi-selection lists.</p>\n<p>See the <span class=\"name\">Locating elements</span> section for details about the locator syntax.</p>", "shortdoc": "Unselects options from selection list ``locator`` by ``labels``.", "tags": [], "source": "C:\\Python\\lib\\site-packages\\SeleniumLibrary\\keywords\\selectelement.py", "lineno": 347}, {"name": "Unselect From List By Value", "args": [{"name": "locator", "types": ["WebElement", "str"], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "locator: WebElement | str"}, {"name": "values", "types": ["str"], "defaultValue": null, "kind": "VAR_POSITIONAL", "required": false, "repr": "*values: str"}], "doc": "<p>Unselects options from selection list <code>locator</code> by <code>values</code>.</p>\n<p>This keyword works only with multi-selection lists.</p>\n<p>See the <span class=\"name\">Locating elements</span> section for details about the locator syntax.</p>", "shortdoc": "Unselects options from selection list ``locator`` by ``values``.", "tags": [], "source": "C:\\Python\\lib\\site-packages\\SeleniumLibrary\\keywords\\selectelement.py", "lineno": 322}, {"name": "Wait For And Click Element", "args": [{"name": "locator", "types": [], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "locator"}, {"name": "timeout", "types": [], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "timeout=None"}], "doc": "<p>This is a series of chained Selenium keywords, that tries to find a web element first, and then clicks it. If the element fails to be clicked, it will scroll to the bottom of the page and try again.</p>\n<p>locator: (string) A selenium locator(CSS, XPATH, ID, NAME, etc) timeout: (float) Time in seconds to wait, will use global timeout if not set.</p>", "shortdoc": "This is a series of chained Selenium keywords, that tries to find a web element first, and then clicks it. If the element fails to be clicked, it will scroll to the bottom of the page and try again.", "tags": [], "source": "C:\\Git\\robotframework-zoomba\\src\\Zoomba\\GUILibrary.py", "lineno": 70}, {"name": "Wait For And Focus On Element", "args": [{"name": "locator", "types": [], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "locator"}, {"name": "timeout", "types": [], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "timeout=None"}], "doc": "<p>This is a series of chained Selenium keywords, that first waits for an element to be on the DOM, executes Focus on it, then it waits for it to be visible.</p>\n<p>locator: (string) A selenium locator(CSS, XPATH, ID, NAME, etc) timeout: (float) Time in seconds to wait, will use global timeout if not set.</p>", "shortdoc": "This is a series of chained Selenium keywords, that first waits for an element to be on the DOM, executes Focus on it, then it waits for it to be visible.", "tags": [], "source": "C:\\Git\\robotframework-zoomba\\src\\Zoomba\\GUILibrary.py", "lineno": 188}, {"name": "Wait For And Input Text", "args": [{"name": "locator", "types": [], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "locator"}, {"name": "text", "types": [], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "text"}, {"name": "timeout", "types": [], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "timeout=None"}], "doc": "<p>This is a series of chained Selenium keywords, that tries to find a web element first, and then input text. If the element fails to typed into, it will scroll to the bottom of the page and try again.</p>\n<p>locator: (string) A selenium locator(CSS, XPATH, ID, NAME, etc)</p>\n<p>text: (string) Text to be typed into the input field. timeout: (float) Time in seconds to wait, will use global timeout if not set.</p>", "shortdoc": "This is a series of chained Selenium keywords, that tries to find a web element first, and then input text. If the element fails to typed into, it will scroll to the bottom of the page and try again.", "tags": [], "source": "C:\\Git\\robotframework-zoomba\\src\\Zoomba\\GUILibrary.py", "lineno": 80}, {"name": "Wait For And Mouse Over", "args": [{"name": "locator", "types": [], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "locator"}, {"name": "timeout", "types": [], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "timeout=None"}], "doc": "<p>This is a series of chained Selenium keywords, that first waits for an element to be visible, then executes a mouse over command on it.</p>\n<p>locator: (string) A selenium locator(CSS, XPATH, ID, NAME, etc) timeout: (float) Time in seconds to wait, will use global timeout if not set.</p>", "shortdoc": "This is a series of chained Selenium keywords, that first waits for an element to be visible, then executes a mouse over command on it.", "tags": [], "source": "C:\\Git\\robotframework-zoomba\\src\\Zoomba\\GUILibrary.py", "lineno": 157}, {"name": "Wait For And Mouse Over And Click", "args": [{"name": "locator", "types": [], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "locator"}, {"name": "timeout", "types": [], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "timeout=None"}], "doc": "<p>This is a series of chained Selenium keywords, that first waits for an element to be visible, executes a mouse over command on it, and it finally clicks it.</p>\n<p>locator: (string) A selenium locator(CSS, XPATH, ID, NAME, etc) timeout: (float) Time in seconds to wait, will use global timeout if not set.</p>", "shortdoc": "This is a series of chained Selenium keywords, that first waits for an element to be visible, executes a mouse over command on it, and it finally clicks it.", "tags": [], "source": "C:\\Git\\robotframework-zoomba\\src\\Zoomba\\GUILibrary.py", "lineno": 177}, {"name": "Wait For And Select Checkbox", "args": [{"name": "locator", "types": [], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "locator"}, {"name": "timeout", "types": [], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "timeout=None"}], "doc": "<p>This is a series of chained Selenium keywords, that first waits for an element to be visible, then selects it if it's a checkbox.</p>\n<p>locator: (string) A selenium locator(CSS, XPATH, ID, NAME, etc) timeout: (float) Time in seconds to wait, will use global timeout if not set.</p>", "shortdoc": "This is a series of chained Selenium keywords, that first waits for an element to be visible, then selects it if it's a checkbox.", "tags": [], "source": "C:\\Git\\robotframework-zoomba\\src\\Zoomba\\GUILibrary.py", "lineno": 167}, {"name": "Wait For And Select Frame", "args": [{"name": "locator", "types": [], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "locator"}, {"name": "timeout", "types": [], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "timeout=None"}], "doc": "<p>This is a series of chained Selenium keywords, that first waits until an iFrame exists in the page, and then selects it.</p>\n<p>locator: (string) A selenium locator(CSS, XPATH, ID, NAME, etc) timeout: (float) Time in seconds to wait, will use global timeout if not set.</p>", "shortdoc": "This is a series of chained Selenium keywords, that first waits until an iFrame exists in the page, and then selects it.", "tags": [], "source": "C:\\Git\\robotframework-zoomba\\src\\Zoomba\\GUILibrary.py", "lineno": 91}, {"name": "Wait For And Select From List", "args": [{"name": "locator", "types": [], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "locator"}, {"name": "target", "types": [], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "target"}, {"name": "timeout", "types": [], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "timeout=None"}], "doc": "<p>This is a series of chained Selenium keywords, that first waits for and focuses on a list element, then selects an item(s).</p>\n<p>locator:  (string) A selenium locator(CSS, XPATH, ID, NAME, etc)</p>\n<p>target: (string, array of strings) The list item(s) to be selected (string, or list of strings) timeout: (float) Time in seconds to wait, will use global timeout if not set.</p>", "shortdoc": "This is a series of chained Selenium keywords, that first waits for and focuses on a list element, then selects an item(s).", "tags": [], "source": "C:\\Git\\robotframework-zoomba\\src\\Zoomba\\GUILibrary.py", "lineno": 124}, {"name": "Wait For And Select From List By Index", "args": [{"name": "locator", "types": [], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "locator"}, {"name": "target", "types": [], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "target"}, {"name": "timeout", "types": [], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "timeout=None"}], "doc": "<p>This is a series of chained Selenium keywords, that first waits for and focuses on a list element, then selects an item(s) for it using the index of the item(s) web element.</p>\n<p>locator:  (string) A selenium locator(CSS, XPATH, ID, NAME, etc)</p>\n<p>target: (string, array of strings) The list item(s) to be selected (string, or list of strings) timeout: (float) Time in seconds to wait, will use global timeout if not set.</p>", "shortdoc": "This is a series of chained Selenium keywords, that first waits for and focuses on a list element, then selects an item(s) for it using the index of the item(s) web element.", "tags": [], "source": "C:\\Git\\robotframework-zoomba\\src\\Zoomba\\GUILibrary.py", "lineno": 146}, {"name": "Wait For And Select From List By Value", "args": [{"name": "locator", "types": [], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "locator"}, {"name": "target", "types": [], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "target"}, {"name": "timeout", "types": [], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "timeout=None"}], "doc": "<p>This is a series of chained Selenium keywords, that first waits for and focuses on a list element, then selects an item(s) for it using the value attribute of the item(s) web element.</p>\n<p>locator:  (string) A selenium locator(CSS, XPATH, ID, NAME, etc)</p>\n<p>target: (string, array of strings) The list item(s) to be selected (string, or list of strings) timeout: (float) Time in seconds to wait, will use global timeout if not set.</p>", "shortdoc": "This is a series of chained Selenium keywords, that first waits for and focuses on a list element, then selects an item(s) for it using the value attribute of the item(s) web element.", "tags": [], "source": "C:\\Git\\robotframework-zoomba\\src\\Zoomba\\GUILibrary.py", "lineno": 135}, {"name": "Wait For And Select Window", "args": [{"name": "title", "types": [], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "title"}, {"name": "timeout", "types": [], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "timeout=None"}], "doc": "<p>This is a series of chained Selenium keywords, used to wait until a window with the title argument exists, then it selects that window.</p>\n<p>title: (string) The title of the window you are waiting for. timeout: (float) Time in seconds to wait, will use global timeout if not set.</p>", "shortdoc": "This is a series of chained Selenium keywords, used to wait until a window with the title argument exists, then it selects that window.", "tags": [], "source": "C:\\Git\\robotframework-zoomba\\src\\Zoomba\\GUILibrary.py", "lineno": 226}, {"name": "Wait For Condition", "args": [{"name": "condition", "types": ["str"], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "condition: str"}, {"name": "timeout", "types": ["timedelta"], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "timeout: timedelta = None"}, {"name": "error", "types": ["str"], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "error: str = None"}], "doc": "<p>Waits until <code>condition</code> is true or <code>timeout</code> expires.</p>\n<p>The condition can be arbitrary JavaScript expression but it must return a value to be evaluated. See <a href=\"#Execute%20Javascript\" class=\"name\">Execute JavaScript</a> for information about accessing content on pages.</p>\n<p>Fails if the timeout expires before the condition becomes true. See the <span class=\"name\">Timeouts</span> section for more information about using timeouts and their default value.</p>\n<p><code>error</code> can be used to override the default error message.</p>\n<p>Examples:</p>\n<table border=\"1\">\n<tr>\n<td><a href=\"#Wait%20For%20Condition\" class=\"name\">Wait For Condition</a></td>\n<td>return document.title == \"New Title\"</td>\n</tr>\n<tr>\n<td><a href=\"#Wait%20For%20Condition\" class=\"name\">Wait For Condition</a></td>\n<td>return jQuery.active == 0</td>\n</tr>\n<tr>\n<td><a href=\"#Wait%20For%20Condition\" class=\"name\">Wait For Condition</a></td>\n<td>style = document.querySelector('h1').style; return style.background == \"red\" &amp;&amp; style.color == \"white\"</td>\n</tr>\n</table>", "shortdoc": "Waits until ``condition`` is true or ``timeout`` expires.", "tags": [], "source": "C:\\Python\\lib\\site-packages\\SeleniumLibrary\\keywords\\waiting.py", "lineno": 31}, {"name": "Wait Until Element Contains", "args": [{"name": "locator", "types": ["WebElement", "None", "str"], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "locator: WebElement | None | str"}, {"name": "text", "types": ["str"], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "text: str"}, {"name": "timeout", "types": ["timedelta"], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "timeout: timedelta = None"}, {"name": "error", "types": ["str"], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "error: str = None"}], "doc": "<p>Waits until the element <code>locator</code> contains <code>text</code>.</p>\n<p>Fails if <code>timeout</code> expires before the text appears. See the <span class=\"name\">Timeouts</span> section for more information about using timeouts and their default value and the <span class=\"name\">Locating elements</span> section for details about the locator syntax.</p>\n<p><code>error</code> can be used to override the default error message.</p>", "shortdoc": "Waits until the element ``locator`` contains ``text``.", "tags": [], "source": "C:\\Python\\lib\\site-packages\\SeleniumLibrary\\keywords\\waiting.py", "lineno": 373}, {"name": "Wait Until Element Contains Value", "args": [{"name": "locator", "types": [], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "locator"}, {"name": "expected_value", "types": [], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "expected_value"}, {"name": "timeout", "types": [], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "timeout=None"}], "doc": "<p>Waits until the element <code>locator</code> appears on the current page and contains value. Fails if <code>timeout</code> expires before the element appears. See the <span class=\"name\">Timeouts</span> section for more information about using timeouts and their default value and the <span class=\"name\">Locating elements</span> section for details about the locator syntax.</p>", "shortdoc": "Waits until the element ``locator`` appears on the current page and contains value. Fails if ``timeout`` expires before the element appears. See the `Timeouts` section for more information about using timeouts and their default value and the `Locating elements` section for details about the locator syntax.", "tags": [], "source": "C:\\Git\\robotframework-zoomba\\src\\Zoomba\\GUILibrary.py", "lineno": 310}, {"name": "Wait Until Element Does Not Contain", "args": [{"name": "locator", "types": ["WebElement", "None", "str"], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "locator: WebElement | None | str"}, {"name": "text", "types": ["str"], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "text: str"}, {"name": "timeout", "types": ["timedelta"], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "timeout: timedelta = None"}, {"name": "error", "types": ["str"], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "error: str = None"}], "doc": "<p>Waits until the element <code>locator</code> does not contain <code>text</code>.</p>\n<p>Fails if <code>timeout</code> expires before the text disappears. See the <span class=\"name\">Timeouts</span> section for more information about using timeouts and their default value and the <span class=\"name\">Locating elements</span> section for details about the locator syntax.</p>\n<p><code>error</code> can be used to override the default error message.</p>", "shortdoc": "Waits until the element ``locator`` does not contain ``text``.", "tags": [], "source": "C:\\Python\\lib\\site-packages\\SeleniumLibrary\\keywords\\waiting.py", "lineno": 397}, {"name": "Wait Until Element Is Enabled", "args": [{"name": "locator", "types": ["WebElement", "None", "str"], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "locator: WebElement | None | str"}, {"name": "timeout", "types": ["timedelta"], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "timeout: timedelta = None"}, {"name": "error", "types": ["str"], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "error: str = None"}], "doc": "<p>Waits until the element <code>locator</code> is enabled.</p>\n<p>Element is considered enabled if it is not disabled nor read-only.</p>\n<p>Fails if <code>timeout</code> expires before the element is enabled. See the <span class=\"name\">Timeouts</span> section for more information about using timeouts and their default value and the <span class=\"name\">Locating elements</span> section for details about the locator syntax.</p>\n<p><code>error</code> can be used to override the default error message.</p>\n<p>Considering read-only elements to be disabled is a new feature in SeleniumLibrary 3.0.</p>", "shortdoc": "Waits until the element ``locator`` is enabled.", "tags": [], "source": "C:\\Python\\lib\\site-packages\\SeleniumLibrary\\keywords\\waiting.py", "lineno": 345}, {"name": "Wait Until Element Is Not Visible", "args": [{"name": "locator", "types": ["WebElement", "None", "str"], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "locator: WebElement | None | str"}, {"name": "timeout", "types": ["timedelta"], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "timeout: timedelta = None"}, {"name": "error", "types": ["str"], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "error: str = None"}], "doc": "<p>Waits until the element <code>locator</code> is not visible.</p>\n<p>Fails if <code>timeout</code> expires before the element is not visible. See the <span class=\"name\">Timeouts</span> section for more information about using timeouts and their default value and the <span class=\"name\">Locating elements</span> section for details about the locator syntax.</p>\n<p><code>error</code> can be used to override the default error message.</p>", "shortdoc": "Waits until the element ``locator`` is not visible.", "tags": [], "source": "C:\\Python\\lib\\site-packages\\SeleniumLibrary\\keywords\\waiting.py", "lineno": 322}, {"name": "Wait Until Element Is Visible", "args": [{"name": "locator", "types": ["WebElement", "None", "str"], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "locator: WebElement | None | str"}, {"name": "timeout", "types": ["timedelta"], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "timeout: timedelta = None"}, {"name": "error", "types": ["str"], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "error: str = None"}], "doc": "<p>Waits until the element <code>locator</code> is visible.</p>\n<p>Fails if <code>timeout</code> expires before the element is visible. See the <span class=\"name\">Timeouts</span> section for more information about using timeouts and their default value and the <span class=\"name\">Locating elements</span> section for details about the locator syntax.</p>\n<p><code>error</code> can be used to override the default error message.</p>", "shortdoc": "Waits until the element ``locator`` is visible.", "tags": [], "source": "C:\\Python\\lib\\site-packages\\SeleniumLibrary\\keywords\\waiting.py", "lineno": 299}, {"name": "Wait Until Javascript Is Complete", "args": [], "doc": "<p>This keyword polls the jQuery.active flag, to track execution of AJAX requests. The web application needs to have jQuery in order for this to work.</p>", "shortdoc": "This keyword polls the jQuery.active flag, to track execution of AJAX requests. The web application needs to have jQuery in order for this to work.", "tags": [], "source": "C:\\Git\\robotframework-zoomba\\src\\Zoomba\\GUILibrary.py", "lineno": 248}, {"name": "Wait Until Location Contains", "args": [{"name": "expected", "types": ["str"], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "expected: str"}, {"name": "timeout", "types": ["timedelta"], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "timeout: timedelta = None"}, {"name": "message", "types": ["str"], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "message: str = None"}], "doc": "<p>Waits until the current URL contains <code>expected</code>.</p>\n<p>The <code>expected</code> argument contains the expected value in url.</p>\n<p>Fails if <code>timeout</code> expires before the location contains. See the <span class=\"name\">Timeouts</span> section for more information about using timeouts and their default value.</p>\n<p>The <code>message</code> argument can be used to override the default error message.</p>\n<p>New in SeleniumLibrary 4.0</p>", "shortdoc": "Waits until the current URL contains ``expected``.", "tags": [], "source": "C:\\Python\\lib\\site-packages\\SeleniumLibrary\\keywords\\waiting.py", "lineno": 123}, {"name": "Wait Until Location Does Not Contain", "args": [{"name": "location", "types": ["str"], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "location: str"}, {"name": "timeout", "types": ["timedelta"], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "timeout: timedelta = None"}, {"name": "message", "types": ["str"], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "message: str = None"}], "doc": "<p>Waits until the current URL does not contains <code>location</code>.</p>\n<p>The <code>location</code> argument contains value not expected in url.</p>\n<p>Fails if <code>timeout</code> expires before the location not contains. See the <span class=\"name\">Timeouts</span> section for more information about using timeouts and their default value.</p>\n<p>The <code>message</code> argument can be used to override the default error message.</p>\n<p>New in SeleniumLibrary 4.3</p>", "shortdoc": "Waits until the current URL does not contains ``location``.", "tags": [], "source": "C:\\Python\\lib\\site-packages\\SeleniumLibrary\\keywords\\waiting.py", "lineno": 151}, {"name": "Wait Until Location Is", "args": [{"name": "expected", "types": ["str"], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "expected: str"}, {"name": "timeout", "types": ["timedelta"], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "timeout: timedelta = None"}, {"name": "message", "types": ["str"], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "message: str = None"}], "doc": "<p>Waits until the current URL is <code>expected</code>.</p>\n<p>The <code>expected</code> argument is the expected value in url.</p>\n<p>Fails if <code>timeout</code> expires before the location is. See the <span class=\"name\">Timeouts</span> section for more information about using timeouts and their default value.</p>\n<p>The <code>message</code> argument can be used to override the default error message.</p>\n<p>New in SeleniumLibrary 4.0</p>", "shortdoc": "Waits until the current URL is ``expected``.", "tags": [], "source": "C:\\Python\\lib\\site-packages\\SeleniumLibrary\\keywords\\waiting.py", "lineno": 66}, {"name": "Wait Until Location Is Not", "args": [{"name": "location", "types": ["str"], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "location: str"}, {"name": "timeout", "types": ["timedelta"], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "timeout: timedelta = None"}, {"name": "message", "types": ["str"], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "message: str = None"}], "doc": "<p>Waits until the current URL is not <code>location</code>.</p>\n<p>The <code>location</code> argument is the unexpected value in url.</p>\n<p>Fails if <code>timeout</code> expires before the location is not. See the <span class=\"name\">Timeouts</span> section for more information about using timeouts and their default value.</p>\n<p>The <code>message</code> argument can be used to override the default error message.</p>\n<p>New in SeleniumLibrary 4.3</p>", "shortdoc": "Waits until the current URL is not ``location``.", "tags": [], "source": "C:\\Python\\lib\\site-packages\\SeleniumLibrary\\keywords\\waiting.py", "lineno": 95}, {"name": "Wait Until Page Contains", "args": [{"name": "text", "types": ["str"], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "text: str"}, {"name": "timeout", "types": ["timedelta"], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "timeout: timedelta = None"}, {"name": "error", "types": ["str"], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "error: str = None"}], "doc": "<p>Waits until <code>text</code> appears on the current page.</p>\n<p>Fails if <code>timeout</code> expires before the text appears. See the <span class=\"name\">Timeouts</span> section for more information about using timeouts and their default value.</p>\n<p><code>error</code> can be used to override the default error message.</p>", "shortdoc": "Waits until ``text`` appears on the current page.", "tags": [], "source": "C:\\Python\\lib\\site-packages\\SeleniumLibrary\\keywords\\waiting.py", "lineno": 179}, {"name": "Wait Until Page Contains Element", "args": [{"name": "locator", "types": ["WebElement", "None", "str"], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "locator: WebElement | None | str"}, {"name": "timeout", "types": ["timedelta"], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "timeout: timedelta = None"}, {"name": "error", "types": ["str"], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "error: str = None"}, {"name": "limit", "types": ["int"], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "limit: int = None"}], "doc": "<p>Waits until the element <code>locator</code> appears on the current page.</p>\n<p>Fails if <code>timeout</code> expires before the element appears. See the <span class=\"name\">Timeouts</span> section for more information about using timeouts and their default value and the <span class=\"name\">Locating elements</span> section for details about the locator syntax.</p>\n<p><code>error</code> can be used to override the default error message.</p>\n<p>The <code>limit</code> argument can used to define how many elements the page should contain. When <code>limit</code> is <span class=\"name\">None</span> (default) page can contain one or more elements. When limit is a number, page must contain same number of elements.</p>\n<p><code>limit</code> is new in SeleniumLibrary 4.4</p>", "shortdoc": "Waits until the element ``locator`` appears on the current page.", "tags": [], "source": "C:\\Python\\lib\\site-packages\\SeleniumLibrary\\keywords\\waiting.py", "lineno": 223}, {"name": "Wait Until Page Does Not Contain", "args": [{"name": "text", "types": ["str"], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "text: str"}, {"name": "timeout", "types": ["timedelta"], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "timeout: timedelta = None"}, {"name": "error", "types": ["str"], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "error: str = None"}], "doc": "<p>Waits until <code>text</code> disappears from the current page.</p>\n<p>Fails if <code>timeout</code> expires before the text disappears. See the <span class=\"name\">Timeouts</span> section for more information about using timeouts and their default value.</p>\n<p><code>error</code> can be used to override the default error message.</p>", "shortdoc": "Waits until ``text`` disappears from the current page.", "tags": [], "source": "C:\\Python\\lib\\site-packages\\SeleniumLibrary\\keywords\\waiting.py", "lineno": 201}, {"name": "Wait Until Page Does Not Contain Element", "args": [{"name": "locator", "types": ["WebElement", "None", "str"], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "locator: WebElement | None | str"}, {"name": "timeout", "types": ["timedelta"], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "timeout: timedelta = None"}, {"name": "error", "types": ["str"], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "error: str = None"}, {"name": "limit", "types": ["int"], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "limit: int = None"}], "doc": "<p>Waits until the element <code>locator</code> disappears from the current page.</p>\n<p>Fails if <code>timeout</code> expires before the element disappears. See the <span class=\"name\">Timeouts</span> section for more information about using timeouts and their default value and the <span class=\"name\">Locating elements</span> section for details about the locator syntax.</p>\n<p><code>error</code> can be used to override the default error message.</p>\n<p>The <code>limit</code> argument can used to define how many elements the page should not contain. When <code>limit</code> is <span class=\"name\">None</span> (default) page can`t contain any elements. When limit is a number, page must not contain same number of elements.</p>\n<p><code>limit</code> is new in SeleniumLibrary 4.4</p>", "shortdoc": "Waits until the element ``locator`` disappears from the current page.", "tags": [], "source": "C:\\Python\\lib\\site-packages\\SeleniumLibrary\\keywords\\waiting.py", "lineno": 261}, {"name": "Wait Until Window Closes", "args": [{"name": "title", "types": [], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "title"}, {"name": "timeout", "types": [], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "timeout=None"}], "doc": "<p>This is a series of chained Selenium keywords, used to wait until a window with the title no longer exists.</p>\n<p>title: (string) The title of the window you are expecting to close. timeout: (float) Time in seconds to wait, will use global timeout if not set.</p>", "shortdoc": "This is a series of chained Selenium keywords, used to wait until a window with the title no longer exists.", "tags": [], "source": "C:\\Git\\robotframework-zoomba\\src\\Zoomba\\GUILibrary.py", "lineno": 300}, {"name": "Wait Until Window Opens", "args": [{"name": "title", "types": [], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "title"}, {"name": "timeout", "types": [], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "timeout=None"}], "doc": "<p>Used to get the titles of the current browser windows, then verify that the provided window title is among them.</p>\n<p>title: (string) The title of the window you are waiting for.</p>\n<p>timeout: (float) Time in seconds to wait, will use global timeout if not set.</p>", "shortdoc": "Used to get the titles of the current browser windows, then verify that the provided window title is among them.", "tags": [], "source": "C:\\Git\\robotframework-zoomba\\src\\Zoomba\\GUILibrary.py", "lineno": 201}, {"name": "Window Should Not Be Open", "args": [{"name": "title", "types": [], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "title"}], "doc": "<p>This is a series of chained Selenium keywords, used to check that a window with the title no longer exists.</p>\n<p>title: (string) The title of the window you are expecting to be closed.</p>", "shortdoc": "This is a series of chained Selenium keywords, used to check that a window with the title no longer exists.", "tags": [], "source": "C:\\Git\\robotframework-zoomba\\src\\Zoomba\\GUILibrary.py", "lineno": 218}], "dataTypes": {"enums": [], "typedDicts": []}}
+libdoc = {"name": "GUI_Library", "doc": "<p>Zoomba GUI Library</p>\n<p>This class inherits from the SeleniumLibrary Class, and expands it with some commonly used keywords. For more information on SeleniumLibrary please visit: <a href=\"https://robotframework.org/SeleniumLibrary/SeleniumLibrary.html\">https://robotframework.org/SeleniumLibrary/SeleniumLibrary.html</a></p>", "version": "2.9.1", "generated": "2021-05-14 11:20:39", "type": "LIBRARY", "scope": "GLOBAL", "docFormat": "HTML", "source": "C:\\Git\\robotframework-zoomba\\src\\Zoomba\\GUILibrary.py", "lineno": 22, "tags": [], "inits": [{"name": "Init", "args": [{"name": "timeout", "types": [], "defaultValue": "5.0", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "timeout=5.0"}, {"name": "implicit_wait", "types": [], "defaultValue": "0.0", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "implicit_wait=0.0"}, {"name": "run_on_failure", "types": [], "defaultValue": "Save Selenium Screenshot", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "run_on_failure=Save Selenium Screenshot"}, {"name": "screenshot_root_directory", "types": [], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "screenshot_root_directory=None"}, {"name": "plugins", "types": [], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "plugins=None"}, {"name": "event_firing_webdriver", "types": [], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "event_firing_webdriver=None"}], "doc": "<p>GUILibrary can be imported with several optional arguments.</p>\n<ul>\n<li><code>timeout</code>: Default value for <span class=\"name\">timeouts</span> used with <code>Wait ...</code> keywords.</li>\n<li><code>implicit_wait</code>: Default value for <span class=\"name\">implicit wait</span> used when locating elements.</li>\n<li><code>run_on_failure</code>: Default action for the <span class=\"name\">run-on-failure functionality</span>.</li>\n<li><code>screenshot_root_directory</code>: Path to folder where possible screenshots are created or EMBED. See <a href=\"#Set%20Screenshot%20Directory\" class=\"name\">Set Screenshot Directory</a> keyword for further details about EMBED. If not given, the directory where the log file is written is used.</li>\n<li><code>plugins</code>: Allows extending the GUILibrary with external Python classes.</li>\n<li><code>event_firing_webdriver</code>: Class for wrapping Selenium with <a href=\"https://seleniumhq.github.io/selenium/docs/api/py/webdriver_support/selenium.webdriver.support.event_firing_webdriver.html#module-selenium.webdriver.support.event_firing_webdriver\">EventFiringWebDriver</a></li>\n</ul>", "shortdoc": "GUILibrary can be imported with several optional arguments.", "tags": [], "source": "C:\\Git\\robotframework-zoomba\\src\\Zoomba\\GUILibrary.py", "lineno": 28}], "keywords": [{"name": "Add Cookie", "args": [{"name": "name", "types": ["str"], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "name: str"}, {"name": "value", "types": ["str"], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "value: str"}, {"name": "path", "types": ["str"], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "path: str = None"}, {"name": "domain", "types": ["str"], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "domain: str = None"}, {"name": "secure", "types": ["bool"], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "secure: bool = None"}, {"name": "expiry", "types": ["str"], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "expiry: str = None"}], "doc": "<p>Adds a cookie to your current session.</p>\n<p><code>name</code> and <code>value</code> are required, <code>path</code>, <code>domain</code>, <code>secure</code> and <code>expiry</code> are optional.  Expiry supports the same formats as the <a href=\"http://robotframework.org/robotframework/latest/libraries/DateTime.html\">DateTime</a> library or an epoch timestamp.</p>\n<p>Example:</p>\n<table border=\"1\">\n<tr>\n<td><a href=\"#Add%20Cookie\" class=\"name\">Add Cookie</a></td>\n<td>foo</td>\n<td>bar</td>\n<td></td>\n<td></td>\n</tr>\n<tr>\n<td><a href=\"#Add%20Cookie\" class=\"name\">Add Cookie</a></td>\n<td>foo</td>\n<td>bar</td>\n<td>domain=example.com</td>\n<td></td>\n</tr>\n<tr>\n<td><a href=\"#Add%20Cookie\" class=\"name\">Add Cookie</a></td>\n<td>foo</td>\n<td>bar</td>\n<td>expiry=2027-09-28 16:21:35</td>\n<td># Expiry as timestamp.</td>\n</tr>\n<tr>\n<td><a href=\"#Add%20Cookie\" class=\"name\">Add Cookie</a></td>\n<td>foo</td>\n<td>bar</td>\n<td>expiry=1822137695</td>\n<td># Expiry as epoch seconds.</td>\n</tr>\n</table>\n<p>Prior to SeleniumLibrary 3.0 setting expiry did not work.</p>", "shortdoc": "Adds a cookie to your current session.", "tags": [], "source": "C:\\Python\\lib\\site-packages\\SeleniumLibrary\\keywords\\cookie.py", "lineno": 143}, {"name": "Add Location Strategy", "args": [{"name": "strategy_name", "types": ["str"], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "strategy_name: str"}, {"name": "strategy_keyword", "types": ["str"], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "strategy_keyword: str"}, {"name": "persist", "types": ["bool"], "defaultValue": "False", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "persist: bool = False"}], "doc": "<p>Adds a custom location strategy.</p>\n<p>See <span class=\"name\">Custom locators</span> for information on how to create and use custom strategies. <a href=\"#Remove%20Location%20Strategy\" class=\"name\">Remove Location Strategy</a> can be used to remove a registered strategy.</p>\n<p>Location strategies are automatically removed after leaving the current scope by default. Setting <code>persist</code> to a true value (see <span class=\"name\">Boolean arguments</span>) will cause the location strategy to stay registered throughout the life of the test.</p>", "shortdoc": "Adds a custom location strategy.", "tags": [], "source": "C:\\Python\\lib\\site-packages\\SeleniumLibrary\\keywords\\element.py", "lineno": 1118}, {"name": "Alert Should Be Present", "args": [{"name": "text", "types": ["str"], "defaultValue": "", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "text: str = "}, {"name": "action", "types": ["str"], "defaultValue": "ACCEPT", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "action: str = ACCEPT"}, {"name": "timeout", "types": ["timedelta"], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "timeout: timedelta = None"}], "doc": "<p>Verifies that an alert is present and by default, accepts it.</p>\n<p>Fails if no alert is present. If <code>text</code> is a non-empty string, then it is used to verify alert's message. The alert is accepted by default, but that behavior can be controlled by using the <code>action</code> argument same way as with <a href=\"#Handle%20Alert\" class=\"name\">Handle Alert</a>.</p>\n<p><code>timeout</code> specifies how long to wait for the alert to appear. If it is not given, the global default <span class=\"name\">timeout</span> is used instead.</p>\n<p><code>action</code> and <code>timeout</code> arguments are new in SeleniumLibrary 3.0. In earlier versions, the alert was always accepted and a timeout was hardcoded to one second.</p>", "shortdoc": "Verifies that an alert is present and by default, accepts it.", "tags": [], "source": "C:\\Python\\lib\\site-packages\\SeleniumLibrary\\keywords\\alert.py", "lineno": 52}, {"name": "Alert Should Not Be Present", "args": [{"name": "action", "types": ["str"], "defaultValue": "ACCEPT", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "action: str = ACCEPT"}, {"name": "timeout", "types": ["timedelta"], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "timeout: timedelta = None"}], "doc": "<p>Verifies that no alert is present.</p>\n<p>If the alert actually exists, the <code>action</code> argument determines how it should be handled. By default, the alert is accepted, but it can be also dismissed or left open the same way as with the <a href=\"#Handle%20Alert\" class=\"name\">Handle Alert</a> keyword.</p>\n<p><code>timeout</code> specifies how long to wait for the alert to appear. By default, is not waited for the alert at all, but a custom time can be given if alert may be delayed. See the <span class=\"name\">time format</span> section for information about the syntax.</p>\n<p>New in SeleniumLibrary 3.0.</p>", "shortdoc": "Verifies that no alert is present.", "tags": [], "source": "C:\\Python\\lib\\site-packages\\SeleniumLibrary\\keywords\\alert.py", "lineno": 79}, {"name": "Assign Id To Element", "args": [{"name": "locator", "types": ["WebElement", "str"], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "locator: WebElement | str"}, {"name": "id", "types": ["str"], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "id: str"}], "doc": "<p>Assigns a temporary <code>id</code> to the element specified by <code>locator</code>.</p>\n<p>This is mainly useful if the locator is complicated and/or slow XPath expression and it is needed multiple times. Identifier expires when the page is reloaded.</p>\n<p>See the <span class=\"name\">Locating elements</span> section for details about the locator syntax.</p>\n<p>Example:</p>\n<table border=\"1\">\n<tr>\n<td><a href=\"#Assign%20Id%20To%20Element\" class=\"name\">Assign ID to Element</a></td>\n<td>//ul[@class='example' and ./li[contains(., 'Stuff')]]</td>\n<td>my id</td>\n</tr>\n<tr>\n<td><a href=\"#Page%20Should%20Contain%20Element\" class=\"name\">Page Should Contain Element</a></td>\n<td>my id</td>\n<td></td>\n</tr>\n</table>", "shortdoc": "Assigns a temporary ``id`` to the element specified by ``locator``.", "tags": [], "source": "C:\\Python\\lib\\site-packages\\SeleniumLibrary\\keywords\\element.py", "lineno": 222}, {"name": "Capture Element Screenshot", "args": [{"name": "locator", "types": ["WebElement", "None", "str"], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "locator: WebElement | None | str"}, {"name": "filename", "types": ["str"], "defaultValue": "selenium-element-screenshot-{index}.png", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "filename: str = selenium-element-screenshot-{index}.png"}], "doc": "<p>Captures a screenshot from the element identified by <code>locator</code> and embeds it into log file.</p>\n<p>See <a href=\"#Capture%20Page%20Screenshot\" class=\"name\">Capture Page Screenshot</a> for details about <code>filename</code> argument. See the <span class=\"name\">Locating elements</span> section for details about the locator syntax.</p>\n<p>An absolute path to the created element screenshot is returned.</p>\n<p>Support for capturing the screenshot from an element has limited support among browser vendors. Please check the browser vendor driver documentation does the browser support capturing a screenshot from an element.</p>\n<p>New in SeleniumLibrary 3.3. Support for EMBED is new in SeleniumLibrary 4.2.</p>\n<p>Examples:</p>\n<table border=\"1\">\n<tr>\n<td><a href=\"#Capture%20Element%20Screenshot\" class=\"name\">Capture Element Screenshot</a></td>\n<td>id:image_id</td>\n<td></td>\n</tr>\n<tr>\n<td><a href=\"#Capture%20Element%20Screenshot\" class=\"name\">Capture Element Screenshot</a></td>\n<td>id:image_id</td>\n<td>${OUTPUTDIR}/id_image_id-1.png</td>\n</tr>\n<tr>\n<td><a href=\"#Capture%20Element%20Screenshot\" class=\"name\">Capture Element Screenshot</a></td>\n<td>id:image_id</td>\n<td>EMBED</td>\n</tr>\n</table>", "shortdoc": "Captures a screenshot from the element identified by ``locator`` and embeds it into log file.", "tags": [], "source": "C:\\Python\\lib\\site-packages\\SeleniumLibrary\\keywords\\screenshot.py", "lineno": 129}, {"name": "Capture Page Screenshot", "args": [{"name": "filename", "types": ["str"], "defaultValue": "selenium-screenshot-{index}.png", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "filename: str = selenium-screenshot-{index}.png"}], "doc": "<p>Takes a screenshot of the current page and embeds it into a log file.</p>\n<p><code>filename</code> argument specifies the name of the file to write the screenshot into. The directory where screenshots are saved can be set when <a href=\"#Importing\" class=\"name\">importing</a> the library or by using the <a href=\"#Set%20Screenshot%20Directory\" class=\"name\">Set Screenshot Directory</a> keyword. If the directory is not configured, screenshots are saved to the same directory where Robot Framework's log file is written.</p>\n<p>If <code>filename</code> equals to EMBED (case insensitive), then screenshot is embedded as Base64 image to the log.html. In this case file is not created in the filesystem.</p>\n<p>Starting from SeleniumLibrary 1.8, if <code>filename</code> contains marker <code>{index}</code>, it will be automatically replaced with an unique running index, preventing files to be overwritten. Indices start from 1, and how they are represented can be customized using Python's <a href=\"https://docs.python.org/3/library/string.html#format-string-syntax\">format string syntax</a>.</p>\n<p>An absolute path to the created screenshot file is returned or if <code>filename</code>  equals to EMBED, word <span class=\"name\">EMBED</span> is returned.</p>\n<p>Support for EMBED is new in SeleniumLibrary 4.2</p>\n<p>Examples:</p>\n<table border=\"1\">\n<tr>\n<td><a href=\"#Capture%20Page%20Screenshot\" class=\"name\">Capture Page Screenshot</a></td>\n<td></td>\n</tr>\n<tr>\n<td><span class=\"name\">File Should Exist</span></td>\n<td>${OUTPUTDIR}/selenium-screenshot-1.png</td>\n</tr>\n<tr>\n<td>${path} =</td>\n<td><a href=\"#Capture%20Page%20Screenshot\" class=\"name\">Capture Page Screenshot</a></td>\n</tr>\n<tr>\n<td><span class=\"name\">File Should Exist</span></td>\n<td>${OUTPUTDIR}/selenium-screenshot-2.png</td>\n</tr>\n<tr>\n<td><span class=\"name\">File Should Exist</span></td>\n<td>${path}</td>\n</tr>\n<tr>\n<td><a href=\"#Capture%20Page%20Screenshot\" class=\"name\">Capture Page Screenshot</a></td>\n<td>custom_name.png</td>\n</tr>\n<tr>\n<td><span class=\"name\">File Should Exist</span></td>\n<td>${OUTPUTDIR}/custom_name.png</td>\n</tr>\n<tr>\n<td><a href=\"#Capture%20Page%20Screenshot\" class=\"name\">Capture Page Screenshot</a></td>\n<td>custom_with_index_{index}.png</td>\n</tr>\n<tr>\n<td><span class=\"name\">File Should Exist</span></td>\n<td>${OUTPUTDIR}/custom_with_index_1.png</td>\n</tr>\n<tr>\n<td><a href=\"#Capture%20Page%20Screenshot\" class=\"name\">Capture Page Screenshot</a></td>\n<td>formatted_index_{index:03}.png</td>\n</tr>\n<tr>\n<td><span class=\"name\">File Should Exist</span></td>\n<td>${OUTPUTDIR}/formatted_index_001.png</td>\n</tr>\n<tr>\n<td><a href=\"#Capture%20Page%20Screenshot\" class=\"name\">Capture Page Screenshot</a></td>\n<td>EMBED</td>\n</tr>\n<tr>\n<td><span class=\"name\">File Should Not Exist</span></td>\n<td>EMBED</td>\n</tr>\n</table>", "shortdoc": "Takes a screenshot of the current page and embeds it into a log file.", "tags": [], "source": "C:\\Python\\lib\\site-packages\\SeleniumLibrary\\keywords\\screenshot.py", "lineno": 67}, {"name": "Checkbox Should Be Selected", "args": [{"name": "locator", "types": ["WebElement", "str"], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "locator: WebElement | str"}], "doc": "<p>Verifies checkbox <code>locator</code> is selected/checked.</p>\n<p>See the <span class=\"name\">Locating elements</span> section for details about the locator syntax.</p>", "shortdoc": "Verifies checkbox ``locator`` is selected/checked.", "tags": [], "source": "C:\\Python\\lib\\site-packages\\SeleniumLibrary\\keywords\\formelement.py", "lineno": 44}, {"name": "Checkbox Should Not Be Selected", "args": [{"name": "locator", "types": ["WebElement", "str"], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "locator: WebElement | str"}], "doc": "<p>Verifies checkbox <code>locator</code> is not selected/checked.</p>\n<p>See the <span class=\"name\">Locating elements</span> section for details about the locator syntax.</p>", "shortdoc": "Verifies checkbox ``locator`` is not selected/checked.", "tags": [], "source": "C:\\Python\\lib\\site-packages\\SeleniumLibrary\\keywords\\formelement.py", "lineno": 58}, {"name": "Choose File", "args": [{"name": "locator", "types": ["WebElement", "str"], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "locator: WebElement | str"}, {"name": "file_path", "types": ["str"], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "file_path: str"}], "doc": "<p>Inputs the <code>file_path</code> into the file input field <code>locator</code>.</p>\n<p>This keyword is most often used to input files into upload forms. The keyword does not check <code>file_path</code> is the file or folder available on the machine where tests are executed. If the <code>file_path</code> points at a file and when using Selenium Grid, Selenium will <a href=\"https://seleniumhq.github.io/selenium/docs/api/py/webdriver_remote/selenium.webdriver.remote.command.html?highlight=upload#selenium.webdriver.remote.command.Command.UPLOAD_FILE\">magically</a>, transfer the file from the machine where the tests are executed to the Selenium Grid node where the browser is running. Then Selenium will send the file path, from the nodes file system, to the browser.</p>\n<p>That <code>file_path</code> is not checked, is new in SeleniumLibrary 4.0.</p>\n<p>Example:</p>\n<table border=\"1\">\n<tr>\n<td><a href=\"#Choose%20File\" class=\"name\">Choose File</a></td>\n<td>my_upload_field</td>\n<td>${CURDIR}/trades.csv</td>\n</tr>\n</table>", "shortdoc": "Inputs the ``file_path`` into the file input field ``locator``.", "tags": [], "source": "C:\\Python\\lib\\site-packages\\SeleniumLibrary\\keywords\\formelement.py", "lineno": 216}, {"name": "Clear Element Text", "args": [{"name": "locator", "types": ["WebElement", "str"], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "locator: WebElement | str"}], "doc": "<p>Clears the value of the text-input-element identified by <code>locator</code>.</p>\n<p>See the <span class=\"name\">Locating elements</span> section for details about the locator syntax.</p>", "shortdoc": "Clears the value of the text-input-element identified by ``locator``.", "tags": [], "source": "C:\\Python\\lib\\site-packages\\SeleniumLibrary\\keywords\\element.py", "lineno": 524}, {"name": "Click Button", "args": [{"name": "locator", "types": ["WebElement", "str"], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "locator: WebElement | str"}, {"name": "modifier", "types": ["bool", "str"], "defaultValue": "False", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "modifier: bool | str = False"}], "doc": "<p>Clicks the button identified by <code>locator</code>.</p>\n<p>See the <span class=\"name\">Locating elements</span> section for details about the locator syntax. When using the default locator strategy, buttons are searched using <code>id</code>, <code>name</code>, and <code>value</code>.</p>\n<p>See the <a href=\"#Click%20Element\" class=\"name\">Click Element</a> keyword for details about the <code>modifier</code> argument.</p>\n<p>The <code>modifier</code> argument is new in SeleniumLibrary 3.3</p>", "shortdoc": "Clicks the button identified by ``locator``.", "tags": [], "source": "C:\\Python\\lib\\site-packages\\SeleniumLibrary\\keywords\\element.py", "lineno": 547}, {"name": "Click Element", "args": [{"name": "locator", "types": ["WebElement", "str"], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "locator: WebElement | str"}, {"name": "modifier", "types": ["bool", "str"], "defaultValue": "False", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "modifier: bool | str = False"}, {"name": "action_chain", "types": ["bool"], "defaultValue": "False", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "action_chain: bool = False"}], "doc": "<p>Click the element identified by <code>locator</code>.</p>\n<p>See the <span class=\"name\">Locating elements</span> section for details about the locator syntax.</p>\n<p>The <code>modifier</code> argument can be used to pass <a href=\"https://seleniumhq.github.io/selenium/docs/api/py/webdriver/selenium.webdriver.common.keys.html#selenium.webdriver.common.keys.Keys\">Selenium Keys</a> when clicking the element. The <span class=\"name\">+</span> can be used as a separator for different Selenium Keys. The <span class=\"name\">CTRL</span> is internally translated to the <span class=\"name\">CONTROL</span> key. The <code>modifier</code> is space and case insensitive, example \"alt\" and \" aLt \" are supported formats to <a href=\"https://seleniumhq.github.io/selenium/docs/api/py/webdriver/selenium.webdriver.common.keys.html#selenium.webdriver.common.keys.Keys.ALT\">ALT key</a> . If <code>modifier</code> does not match to Selenium Keys, keyword fails.</p>\n<p>If <code>action_chain</code> argument is true, see <span class=\"name\">Boolean arguments</span> for more details on how to set boolean argument, then keyword uses ActionChain based click instead of the &lt;web_element&gt;.click() function. If both <code>action_chain</code> and <code>modifier</code> are defined, the click will be performed using <code>modifier</code> and <code>action_chain</code> will be ignored.</p>\n<p>Example:</p>\n<table border=\"1\">\n<tr>\n<td>Click Element</td>\n<td>id:button</td>\n<td></td>\n<td># Would click element without any modifiers.</td>\n</tr>\n<tr>\n<td>Click Element</td>\n<td>id:button</td>\n<td>CTRL</td>\n<td># Would click element with CTLR key pressed down.</td>\n</tr>\n<tr>\n<td>Click Element</td>\n<td>id:button</td>\n<td>CTRL+ALT</td>\n<td># Would click element with CTLR and ALT keys pressed down.</td>\n</tr>\n<tr>\n<td>Click Element</td>\n<td>id:button</td>\n<td>action_chain=True</td>\n<td># Clicks the button using an Selenium  ActionChains</td>\n</tr>\n</table>\n<p>The <code>modifier</code> argument is new in SeleniumLibrary 3.2 The <code>action_chain</code> argument is new in SeleniumLibrary 4.1</p>", "shortdoc": "Click the element identified by ``locator``.", "tags": [], "source": "C:\\Python\\lib\\site-packages\\SeleniumLibrary\\keywords\\element.py", "lineno": 617}, {"name": "Click Element At Coordinates", "args": [{"name": "locator", "types": ["WebElement", "str"], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "locator: WebElement | str"}, {"name": "xoffset", "types": ["int"], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "xoffset: int"}, {"name": "yoffset", "types": ["int"], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "yoffset: int"}], "doc": "<p>Click the element <code>locator</code> at <code>xoffset/yoffset</code>.</p>\n<p>The Cursor is moved and the center of the element and x/y coordinates are calculated from that point.</p>\n<p>See the <span class=\"name\">Locating elements</span> section for details about the locator syntax.</p>", "shortdoc": "Click the element ``locator`` at ``xoffset/yoffset``.", "tags": [], "source": "C:\\Python\\lib\\site-packages\\SeleniumLibrary\\keywords\\element.py", "lineno": 689}, {"name": "Click Image", "args": [{"name": "locator", "types": ["WebElement", "str"], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "locator: WebElement | str"}, {"name": "modifier", "types": ["bool", "str"], "defaultValue": "False", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "modifier: bool | str = False"}], "doc": "<p>Clicks an image identified by <code>locator</code>.</p>\n<p>See the <span class=\"name\">Locating elements</span> section for details about the locator syntax. When using the default locator strategy, images are searched using <code>id</code>, <code>name</code>, <code>src</code> and <code>alt</code>.</p>\n<p>See the <a href=\"#Click%20Element\" class=\"name\">Click Element</a> keyword for details about the <code>modifier</code> argument.</p>\n<p>The <code>modifier</code> argument is new in SeleniumLibrary 3.3</p>", "shortdoc": "Clicks an image identified by ``locator``.", "tags": [], "source": "C:\\Python\\lib\\site-packages\\SeleniumLibrary\\keywords\\element.py", "lineno": 571}, {"name": "Click Link", "args": [{"name": "locator", "types": ["WebElement", "str"], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "locator: WebElement | str"}, {"name": "modifier", "types": ["bool", "str"], "defaultValue": "False", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "modifier: bool | str = False"}], "doc": "<p>Clicks a link identified by <code>locator</code>.</p>\n<p>See the <span class=\"name\">Locating elements</span> section for details about the locator syntax. When using the default locator strategy, links are searched using <code>id</code>, <code>name</code>, <code>href</code> and the link text.</p>\n<p>See the <a href=\"#Click%20Element\" class=\"name\">Click Element</a> keyword for details about the <code>modifier</code> argument.</p>\n<p>The <code>modifier</code> argument is new in SeleniumLibrary 3.3</p>", "shortdoc": "Clicks a link identified by ``locator``.", "tags": [], "source": "C:\\Python\\lib\\site-packages\\SeleniumLibrary\\keywords\\element.py", "lineno": 596}, {"name": "Close All Browsers", "args": [], "doc": "<p>Closes all open browsers and resets the browser cache.</p>\n<p>After this keyword, new indexes returned from <a href=\"#Open%20Browser\" class=\"name\">Open Browser</a> keyword are reset to 1.</p>\n<p>This keyword should be used in test or suite teardown to make sure all browsers are closed.</p>", "shortdoc": "Closes all open browsers and resets the browser cache.", "tags": [], "source": "C:\\Python\\lib\\site-packages\\SeleniumLibrary\\keywords\\browsermanagement.py", "lineno": 40}, {"name": "Close Browser", "args": [], "doc": "<p>Closes the current browser.</p>", "shortdoc": "Closes the current browser.", "tags": [], "source": "C:\\Python\\lib\\site-packages\\SeleniumLibrary\\keywords\\browsermanagement.py", "lineno": 53}, {"name": "Close Window", "args": [], "doc": "<p>Closes currently opened and selected browser window/tab.</p>", "shortdoc": "Closes currently opened and selected browser window/tab.", "tags": [], "source": "C:\\Python\\lib\\site-packages\\SeleniumLibrary\\keywords\\window.py", "lineno": 125}, {"name": "Cover Element", "args": [{"name": "locator", "types": ["WebElement", "str"], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "locator: WebElement | str"}], "doc": "<p>Will cover elements identified by <code>locator</code> with a blue div without breaking page layout.</p>\n<p>See the <span class=\"name\">Locating elements</span> section for details about the locator syntax.</p>\n<p>New in SeleniumLibrary 3.3.0</p>\n<p>Example: |<a href=\"#Cover%20Element\" class=\"name\">Cover Element</a> | css:div#container |</p>", "shortdoc": "Will cover elements identified by ``locator`` with a blue div without breaking page layout.", "tags": [], "source": "C:\\Python\\lib\\site-packages\\SeleniumLibrary\\keywords\\element.py", "lineno": 474}, {"name": "Create Dictionary From Keys And Values Lists", "args": [{"name": "keys", "types": [], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "keys"}, {"name": "values", "types": [], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "values"}], "doc": "<p>This keyword returns a dictionary, given a list of keys and a list of values of the same length.</p>\n<p>keys: (array of strings) A list of keys to be assigned to a dictionary.</p>\n<p>values: (array of strings,integers,dictionaries,etc) A list of values to be assigned to a dictionary.</p>\n<p>return: (dictionary) A dictionary with the mapped key-value pairs.</p>", "shortdoc": "This keyword returns a dictionary, given a list of keys and a list of values of the same length.", "tags": [], "source": "C:\\Git\\robotframework-zoomba\\src\\Zoomba\\GUILibrary.py", "lineno": 334}, {"name": "Create Webdriver", "args": [{"name": "driver_name", "types": ["str"], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "driver_name: str"}, {"name": "alias", "types": ["str"], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "alias: str = None"}, {"name": "kwargs", "types": [], "defaultValue": "{}", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "kwargs={}"}, {"name": "init_kwargs", "types": [], "defaultValue": null, "kind": "VAR_NAMED", "required": false, "repr": "**init_kwargs"}], "doc": "<p>Creates an instance of Selenium WebDriver.</p>\n<p>Like <a href=\"#Open%20Browser\" class=\"name\">Open Browser</a>, but allows passing arguments to the created WebDriver instance directly. This keyword should only be used if the functionality provided by <a href=\"#Open%20Browser\" class=\"name\">Open Browser</a> is not adequate.</p>\n<p><code>driver_name</code> must be a WebDriver implementation name like Firefox, Chrome, Ie, Opera, Safari, PhantomJS, or Remote.</p>\n<p>The initialized WebDriver can be configured either with a Python dictionary <code>kwargs</code> or by using keyword arguments <code>**init_kwargs</code>. These arguments are passed directly to WebDriver without any processing. See <a href=\"https://seleniumhq.github.io/selenium/docs/api/py/api.html\">Selenium API documentation</a> for details about the supported arguments.</p>\n<p>Examples:</p>\n<table border=\"1\">\n<tr>\n<td># Use proxy with Firefox</td>\n<td></td>\n<td></td>\n<td></td>\n</tr>\n<tr>\n<td>${proxy}=</td>\n<td><span class=\"name\">Evaluate</span></td>\n<td>selenium.webdriver.Proxy()</td>\n<td>modules=selenium, selenium.webdriver</td>\n</tr>\n<tr>\n<td>${proxy.http_proxy}=</td>\n<td><span class=\"name\">Set Variable</span></td>\n<td>localhost:8888</td>\n<td></td>\n</tr>\n<tr>\n<td><a href=\"#Create%20Webdriver\" class=\"name\">Create Webdriver</a></td>\n<td>Firefox</td>\n<td>proxy=${proxy}</td>\n<td></td>\n</tr>\n<tr>\n<td># Use proxy with PhantomJS</td>\n<td></td>\n<td></td>\n<td></td>\n</tr>\n<tr>\n<td>${service args}=</td>\n<td><span class=\"name\">Create List</span></td>\n<td>--proxy=192.168.132.104:8888</td>\n<td></td>\n</tr>\n<tr>\n<td><a href=\"#Create%20Webdriver\" class=\"name\">Create Webdriver</a></td>\n<td>PhantomJS</td>\n<td>service_args=${service args}</td>\n<td></td>\n</tr>\n</table>\n<p>Returns the index of this browser instance which can be used later to switch back to it. Index starts from 1 and is reset back to it when <a href=\"#Close%20All%20Browsers\" class=\"name\">Close All Browsers</a> keyword is used. See <a href=\"#Switch%20Browser\" class=\"name\">Switch Browser</a> for an example.</p>", "shortdoc": "Creates an instance of Selenium WebDriver.", "tags": [], "source": "C:\\Python\\lib\\site-packages\\SeleniumLibrary\\keywords\\browsermanagement.py", "lineno": 347}, {"name": "Current Frame Should Contain", "args": [{"name": "text", "types": ["str"], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "text: str"}, {"name": "loglevel", "types": ["str"], "defaultValue": "TRACE", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "loglevel: str = TRACE"}], "doc": "<p>Verifies that the current frame contains <code>text</code>.</p>\n<p>See <a href=\"#Page%20Should%20Contain\" class=\"name\">Page Should Contain</a> for an explanation about the <code>loglevel</code> argument.</p>\n<p>Prior to SeleniumLibrary 3.0 this keyword was named <span class=\"name\">Current Frame Contains</span>.</p>", "shortdoc": "Verifies that the current frame contains ``text``.", "tags": [], "source": "C:\\Python\\lib\\site-packages\\SeleniumLibrary\\keywords\\frames.py", "lineno": 53}, {"name": "Current Frame Should Not Contain", "args": [{"name": "text", "types": ["str"], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "text: str"}, {"name": "loglevel", "types": ["str"], "defaultValue": "TRACE", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "loglevel: str = TRACE"}], "doc": "<p>Verifies that the current frame does not contain <code>text</code>.</p>\n<p>See <a href=\"#Page%20Should%20Contain\" class=\"name\">Page Should Contain</a> for an explanation about the <code>loglevel</code> argument.</p>", "shortdoc": "Verifies that the current frame does not contain ``text``.", "tags": [], "source": "C:\\Python\\lib\\site-packages\\SeleniumLibrary\\keywords\\frames.py", "lineno": 70}, {"name": "Delete All Cookies", "args": [], "doc": "<p>Deletes all cookies.</p>", "shortdoc": "Deletes all cookies.", "tags": [], "source": "C:\\Python\\lib\\site-packages\\SeleniumLibrary\\keywords\\cookie.py", "lineno": 57}, {"name": "Delete Cookie", "args": [{"name": "name", "types": [], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "name"}], "doc": "<p>Deletes the cookie matching <code>name</code>.</p>\n<p>If the cookie is not found, nothing happens.</p>", "shortdoc": "Deletes the cookie matching ``name``.", "tags": [], "source": "C:\\Python\\lib\\site-packages\\SeleniumLibrary\\keywords\\cookie.py", "lineno": 62}, {"name": "Double Click Element", "args": [{"name": "locator", "types": ["WebElement", "str"], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "locator: WebElement | str"}], "doc": "<p>Double clicks the element identified by <code>locator</code>.</p>\n<p>See the <span class=\"name\">Locating elements</span> section for details about the locator syntax.</p>", "shortdoc": "Double clicks the element identified by ``locator``.", "tags": [], "source": "C:\\Python\\lib\\site-packages\\SeleniumLibrary\\keywords\\element.py", "lineno": 713}, {"name": "Drag And Drop", "args": [{"name": "locator", "types": ["WebElement", "str"], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "locator: WebElement | str"}, {"name": "target", "types": ["WebElement", "str"], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "target: WebElement | str"}], "doc": "<p>Drags the element identified by <code>locator</code> into the <code>target</code> element.</p>\n<p>The <code>locator</code> argument is the locator of the dragged element and the <code>target</code> is the locator of the target. See the <span class=\"name\">Locating elements</span> section for details about the locator syntax.</p>\n<p>Example:</p>\n<table border=\"1\">\n<tr>\n<td><a href=\"#Drag%20And%20Drop\" class=\"name\">Drag And Drop</a></td>\n<td>css:div#element</td>\n<td>css:div.target</td>\n</tr>\n</table>", "shortdoc": "Drags the element identified by ``locator`` into the ``target`` element.", "tags": [], "source": "C:\\Python\\lib\\site-packages\\SeleniumLibrary\\keywords\\element.py", "lineno": 753}, {"name": "Drag And Drop By Offset", "args": [{"name": "locator", "types": ["WebElement", "str"], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "locator: WebElement | str"}, {"name": "xoffset", "types": ["int"], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "xoffset: int"}, {"name": "yoffset", "types": ["int"], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "yoffset: int"}], "doc": "<p>Drags the element identified with <code>locator</code> by <code>xoffset/yoffset</code>.</p>\n<p>See the <span class=\"name\">Locating elements</span> section for details about the locator syntax.</p>\n<p>The element will be moved by <code>xoffset</code> and <code>yoffset</code>, each of which is a negative or positive number specifying the offset.</p>\n<p>Example:</p>\n<table border=\"1\">\n<tr>\n<td><a href=\"#Drag%20And%20Drop%20By%20Offset\" class=\"name\">Drag And Drop By Offset</a></td>\n<td>myElem</td>\n<td>50</td>\n<td>-35</td>\n<td># Move myElem 50px right and 35px down</td>\n</tr>\n</table>", "shortdoc": "Drags the element identified with ``locator`` by ``xoffset/yoffset``.", "tags": [], "source": "C:\\Python\\lib\\site-packages\\SeleniumLibrary\\keywords\\element.py", "lineno": 775}, {"name": "Element Attribute Value Should Be", "args": [{"name": "locator", "types": ["WebElement", "str"], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "locator: WebElement | str"}, {"name": "attribute", "types": ["str"], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "attribute: str"}, {"name": "expected", "types": ["None", "str"], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "expected: None | str"}, {"name": "message", "types": ["str"], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "message: str = None"}], "doc": "<p>Verifies element identified by <code>locator</code> contains expected attribute value.</p>\n<p>See the <span class=\"name\">Locating elements</span> section for details about the locator syntax.</p>\n<p>Example: <a href=\"#Element%20Attribute%20Value%20Should%20Be\" class=\"name\">Element Attribute Value Should Be</a> | css:img | href | value</p>\n<p>New in SeleniumLibrary 3.2.</p>", "shortdoc": "Verifies element identified by ``locator`` contains expected attribute value.", "tags": [], "source": "C:\\Python\\lib\\site-packages\\SeleniumLibrary\\keywords\\element.py", "lineno": 414}, {"name": "Element CSS Attribute Value Should Be", "args": [{"name": "locator", "types": [], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "locator"}, {"name": "attribute", "types": [], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "attribute"}, {"name": "expected_value", "types": [], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "expected_value"}], "doc": "<p>Get the CSS attribute value of an element and compare it to an expected value. This would be the values within the 'style' tag.</p>\n<p>locator: (string) A selenium locator(CSS, XPATH, ID, NAME, etc)</p>\n<p>attribute: (string) The attribute you wish to get the value for.</p>\n<p>expected_value: (string) The expected attribute value to be compared against the actual attribute value</p>", "shortdoc": "Get the CSS attribute value of an element and compare it to an expected value. This would be the values within the 'style' tag.", "tags": [], "source": "C:\\Git\\robotframework-zoomba\\src\\Zoomba\\GUILibrary.py", "lineno": 383}, {"name": "Element Should Be Disabled", "args": [{"name": "locator", "types": ["WebElement", "str"], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "locator: WebElement | str"}], "doc": "<p>Verifies that element identified by <code>locator</code> is disabled.</p>\n<p>This keyword considers also elements that are read-only to be disabled.</p>\n<p>See the <span class=\"name\">Locating elements</span> section for details about the locator syntax.</p>", "shortdoc": "Verifies that element identified by ``locator`` is disabled.", "tags": [], "source": "C:\\Python\\lib\\site-packages\\SeleniumLibrary\\keywords\\element.py", "lineno": 241}, {"name": "Element Should Be Enabled", "args": [{"name": "locator", "types": ["WebElement", "str"], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "locator: WebElement | str"}], "doc": "<p>Verifies that element identified by <code>locator</code> is enabled.</p>\n<p>This keyword considers also elements that are read-only to be disabled.</p>\n<p>See the <span class=\"name\">Locating elements</span> section for details about the locator syntax.</p>", "shortdoc": "Verifies that element identified by ``locator`` is enabled.", "tags": [], "source": "C:\\Python\\lib\\site-packages\\SeleniumLibrary\\keywords\\element.py", "lineno": 254}, {"name": "Element Should Be Focused", "args": [{"name": "locator", "types": ["WebElement", "str"], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "locator: WebElement | str"}], "doc": "<p>Verifies that element identified by <code>locator</code> is focused.</p>\n<p>See the <span class=\"name\">Locating elements</span> section for details about the locator syntax.</p>\n<p>New in SeleniumLibrary 3.0.</p>", "shortdoc": "Verifies that element identified by ``locator`` is focused.", "tags": [], "source": "C:\\Python\\lib\\site-packages\\SeleniumLibrary\\keywords\\element.py", "lineno": 267}, {"name": "Element Should Be Visible", "args": [{"name": "locator", "types": ["WebElement", "str"], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "locator: WebElement | str"}, {"name": "message", "types": ["str"], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "message: str = None"}], "doc": "<p>Verifies that the element identified by <code>locator</code> is visible.</p>\n<p>Herein, visible means that the element is logically visible, not optically visible in the current browser viewport. For example, an element that carries <code>display:none</code> is not logically visible, so using this keyword on that element would fail.</p>\n<p>See the <span class=\"name\">Locating elements</span> section for details about the locator syntax.</p>\n<p>The <code>message</code> argument can be used to override the default error message.</p>", "shortdoc": "Verifies that the element identified by ``locator`` is visible.", "tags": [], "source": "C:\\Python\\lib\\site-packages\\SeleniumLibrary\\keywords\\element.py", "lineno": 284}, {"name": "Element Should Contain", "args": [{"name": "locator", "types": ["WebElement", "str"], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "locator: WebElement | str"}, {"name": "expected", "types": ["None", "str"], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "expected: None | str"}, {"name": "message", "types": ["str"], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "message: str = None"}, {"name": "ignore_case", "types": ["bool"], "defaultValue": "False", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "ignore_case: bool = False"}], "doc": "<p>Verifies that element <code>locator</code> contains text <code>expected</code>.</p>\n<p>See the <span class=\"name\">Locating elements</span> section for details about the locator syntax.</p>\n<p>The <code>message</code> argument can be used to override the default error message.</p>\n<p>The <code>ignore_case</code> argument can be set to True to compare case insensitive, default is False. New in SeleniumLibrary 3.1.</p>\n<p><code>ignore_case</code> argument is new in SeleniumLibrary 3.1.</p>\n<p>Use <a href=\"#Element%20Text%20Should%20Be\" class=\"name\">Element Text Should Be</a> if you want to match the exact text, not a substring.</p>", "shortdoc": "Verifies that element ``locator`` contains text ``expected``.", "tags": [], "source": "C:\\Python\\lib\\site-packages\\SeleniumLibrary\\keywords\\element.py", "lineno": 55}, {"name": "Element Should Not Be Visible", "args": [{"name": "locator", "types": ["WebElement", "str"], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "locator: WebElement | str"}, {"name": "message", "types": ["str"], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "message: str = None"}], "doc": "<p>Verifies that the element identified by <code>locator</code> is NOT visible.</p>\n<p>Passes if the element does not exists. See <a href=\"#Element%20Should%20Be%20Visible\" class=\"name\">Element Should Be Visible</a> for more information about visibility and supported arguments.</p>", "shortdoc": "Verifies that the element identified by ``locator`` is NOT visible.", "tags": [], "source": "C:\\Python\\lib\\site-packages\\SeleniumLibrary\\keywords\\element.py", "lineno": 307}, {"name": "Element Should Not Contain", "args": [{"name": "locator", "types": ["WebElement", "str"], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "locator: WebElement | str"}, {"name": "expected", "types": ["None", "str"], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "expected: None | str"}, {"name": "message", "types": ["str"], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "message: str = None"}, {"name": "ignore_case", "types": ["bool"], "defaultValue": "False", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "ignore_case: bool = False"}], "doc": "<p>Verifies that element <code>locator</code> does not contain text <code>expected</code>.</p>\n<p>See the <span class=\"name\">Locating elements</span> section for details about the locator syntax.</p>\n<p>The <code>message</code> argument can be used to override the default error message.</p>\n<p>The <code>ignore_case</code> argument can be set to True to compare case insensitive, default is False.</p>\n<p><code>ignore_case</code> argument new in SeleniumLibrary 3.1.</p>", "shortdoc": "Verifies that element ``locator`` does not contain text ``expected``.", "tags": [], "source": "C:\\Python\\lib\\site-packages\\SeleniumLibrary\\keywords\\element.py", "lineno": 93}, {"name": "Element Text Should Be", "args": [{"name": "locator", "types": ["WebElement", "str"], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "locator: WebElement | str"}, {"name": "expected", "types": ["None", "str"], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "expected: None | str"}, {"name": "message", "types": ["str"], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "message: str = None"}, {"name": "ignore_case", "types": ["bool"], "defaultValue": "False", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "ignore_case: bool = False"}], "doc": "<p>Verifies that element <code>locator</code> contains exact the text <code>expected</code>.</p>\n<p>See the <span class=\"name\">Locating elements</span> section for details about the locator syntax.</p>\n<p>The <code>message</code> argument can be used to override the default error message.</p>\n<p>The <code>ignore_case</code> argument can be set to True to compare case insensitive, default is False.</p>\n<p><code>ignore_case</code> argument is new in SeleniumLibrary 3.1.</p>\n<p>Use <a href=\"#Element%20Should%20Contain\" class=\"name\">Element Should Contain</a> if a substring match is desired.</p>", "shortdoc": "Verifies that element ``locator`` contains exact the text ``expected``.", "tags": [], "source": "C:\\Python\\lib\\site-packages\\SeleniumLibrary\\keywords\\element.py", "lineno": 326}, {"name": "Element Text Should Not Be", "args": [{"name": "locator", "types": ["WebElement", "str"], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "locator: WebElement | str"}, {"name": "not_expected", "types": ["None", "str"], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "not_expected: None | str"}, {"name": "message", "types": ["str"], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "message: str = None"}, {"name": "ignore_case", "types": ["bool"], "defaultValue": "False", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "ignore_case: bool = False"}], "doc": "<p>Verifies that element <code>locator</code> does not contain exact the text <code>not_expected</code>.</p>\n<p>See the <span class=\"name\">Locating elements</span> section for details about the locator syntax.</p>\n<p>The <code>message</code> argument can be used to override the default error message.</p>\n<p>The <code>ignore_case</code> argument can be set to True to compare case insensitive, default is False.</p>\n<p>New in SeleniumLibrary 3.1.1</p>", "shortdoc": "Verifies that element ``locator`` does not contain exact the text ``not_expected``.", "tags": [], "source": "C:\\Python\\lib\\site-packages\\SeleniumLibrary\\keywords\\element.py", "lineno": 362}, {"name": "Element Value Should Be Equal", "args": [{"name": "locator", "types": [], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "locator"}, {"name": "expected_value", "types": [], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "expected_value"}], "doc": "<p>Assert that the value attribute of a web element is equal to a given value</p>\n<p>locator: (string) A selenium locator(CSS, XPATH, ID, NAME, etc)</p>\n<p>expected_value: (string) A string or int value to be compared against the actual web element value</p>", "shortdoc": "Assert that the value attribute of a web element is equal to a given value", "tags": [], "source": "C:\\Git\\robotframework-zoomba\\src\\Zoomba\\GUILibrary.py", "lineno": 52}, {"name": "Element Value Should Not Be Equal", "args": [{"name": "locator", "types": [], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "locator"}, {"name": "expected_value", "types": [], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "expected_value"}], "doc": "<p>Assert that the value attribute of a web element is not equal to a given value</p>\n<p>locator: (string) A selenium locator(CSS, XPATH, ID, NAME, etc)</p>\n<p>expected_value: (string) A string or int value to be compared against the actual web element value</p>", "shortdoc": "Assert that the value attribute of a web element is not equal to a given value", "tags": [], "source": "C:\\Git\\robotframework-zoomba\\src\\Zoomba\\GUILibrary.py", "lineno": 61}, {"name": "Execute Async Javascript", "args": [{"name": "code", "types": ["WebElement", "str"], "defaultValue": null, "kind": "VAR_POSITIONAL", "required": false, "repr": "*code: WebElement | str"}], "doc": "<p>Executes asynchronous JavaScript code with possible arguments.</p>\n<p>Similar to <a href=\"#Execute%20Javascript\" class=\"name\">Execute Javascript</a> except that scripts executed with this keyword must explicitly signal they are finished by invoking the provided callback. This callback is always injected into the executed function as the last argument.</p>\n<p>Scripts must complete within the script timeout or this keyword will fail. See the <span class=\"name\">Timeout</span> section for more information.</p>\n<p>Starting from SeleniumLibrary 3.2 it is possible to provide JavaScript <a href=\"https://seleniumhq.github.io/selenium/docs/api/py/webdriver_remote/selenium.webdriver.remote.webdriver.html#selenium.webdriver.remote.webdriver.WebDriver.execute_async_script\">arguments</a> as part of <code>code</code> argument. See <a href=\"#Execute%20Javascript\" class=\"name\">Execute Javascript</a> for more details.</p>\n<p>Examples:</p>\n<table border=\"1\">\n<tr>\n<td><a href=\"#Execute%20Async%20Javascript\" class=\"name\">Execute Async JavaScript</a></td>\n<td>var callback = arguments[arguments.length - 1]; window.setTimeout(callback, 2000);</td>\n<td></td>\n</tr>\n<tr>\n<td><a href=\"#Execute%20Async%20Javascript\" class=\"name\">Execute Async JavaScript</a></td>\n<td>${CURDIR}/async_js_to_execute.js</td>\n<td></td>\n</tr>\n<tr>\n<td>${result} =</td>\n<td><a href=\"#Execute%20Async%20Javascript\" class=\"name\">Execute Async JavaScript</a></td>\n<td></td>\n</tr>\n<tr>\n<td>...</td>\n<td>var callback = arguments[arguments.length - 1];</td>\n<td></td>\n</tr>\n<tr>\n<td>...</td>\n<td>function answer(){callback(\"text\");};</td>\n<td></td>\n</tr>\n<tr>\n<td>...</td>\n<td>window.setTimeout(answer, 2000);</td>\n<td></td>\n</tr>\n<tr>\n<td><span class=\"name\">Should Be Equal</span></td>\n<td>${result}</td>\n<td>text</td>\n</tr>\n</table>", "shortdoc": "Executes asynchronous JavaScript code with possible arguments.", "tags": [], "source": "C:\\Python\\lib\\site-packages\\SeleniumLibrary\\keywords\\javascript.py", "lineno": 76}, {"name": "Execute Javascript", "args": [{"name": "code", "types": ["WebElement", "str"], "defaultValue": null, "kind": "VAR_POSITIONAL", "required": false, "repr": "*code: WebElement | str"}], "doc": "<p>Executes the given JavaScript code with possible arguments.</p>\n<p><code>code</code> may be divided into multiple cells in the test data and <code>code</code> may contain multiple lines of code and arguments. In that case, the JavaScript code parts are concatenated together without adding spaces and optional arguments are separated from <code>code</code>.</p>\n<p>If <code>code</code> is a path to an existing file, the JavaScript to execute will be read from that file. Forward slashes work as a path separator on all operating systems.</p>\n<p>The JavaScript executes in the context of the currently selected frame or window as the body of an anonymous function. Use <code>window</code> to refer to the window of your application and <code>document</code> to refer to the document object of the current frame or window, e.g. <code>document.getElementById('example')</code>.</p>\n<p>This keyword returns whatever the executed JavaScript code returns. Return values are converted to the appropriate Python types.</p>\n<p>Starting from SeleniumLibrary 3.2 it is possible to provide JavaScript <a href=\"https://seleniumhq.github.io/selenium/docs/api/py/webdriver_remote/selenium.webdriver.remote.webdriver.html#selenium.webdriver.remote.webdriver.WebDriver.execute_script\">arguments</a> as part of <code>code</code> argument. The JavaScript code and arguments must be separated with <span class=\"name\">JAVASCRIPT</span> and <span class=\"name\">ARGUMENTS</span> markers and must be used exactly with this format. If the Javascript code is first, then the <span class=\"name\">JAVASCRIPT</span> marker is optional. The order of <span class=\"name\">JAVASCRIPT</span> and <span class=\"name\">ARGUMENTS</span> markers can be swapped, but if <span class=\"name\">ARGUMENTS</span> is the first marker, then <span class=\"name\">JAVASCRIPT</span> marker is mandatory. It is only allowed to use <span class=\"name\">JAVASCRIPT</span> and <span class=\"name\">ARGUMENTS</span> markers only one time in the <code>code</code> argument.</p>\n<p>Examples:</p>\n<table border=\"1\">\n<tr>\n<td><a href=\"#Execute%20Javascript\" class=\"name\">Execute JavaScript</a></td>\n<td>window.myFunc('arg1', 'arg2')</td>\n<td></td>\n<td></td>\n<td></td>\n</tr>\n<tr>\n<td><a href=\"#Execute%20Javascript\" class=\"name\">Execute JavaScript</a></td>\n<td>${CURDIR}/js_to_execute.js</td>\n<td></td>\n<td></td>\n<td></td>\n</tr>\n<tr>\n<td><a href=\"#Execute%20Javascript\" class=\"name\">Execute JavaScript</a></td>\n<td>alert(arguments[0]);</td>\n<td>ARGUMENTS</td>\n<td>123</td>\n<td></td>\n</tr>\n<tr>\n<td><a href=\"#Execute%20Javascript\" class=\"name\">Execute JavaScript</a></td>\n<td>ARGUMENTS</td>\n<td>123</td>\n<td>JAVASCRIPT</td>\n<td>alert(arguments[0]);</td>\n</tr>\n</table>", "shortdoc": "Executes the given JavaScript code with possible arguments.", "tags": [], "source": "C:\\Python\\lib\\site-packages\\SeleniumLibrary\\keywords\\javascript.py", "lineno": 33}, {"name": "Frame Should Contain", "args": [{"name": "locator", "types": ["WebElement", "str"], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "locator: WebElement | str"}, {"name": "text", "types": ["str"], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "text: str"}, {"name": "loglevel", "types": ["str"], "defaultValue": "TRACE", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "loglevel: str = TRACE"}], "doc": "<p>Verifies that frame identified by <code>locator</code> contains <code>text</code>.</p>\n<p>See the <span class=\"name\">Locating elements</span> section for details about the locator syntax.</p>\n<p>See <a href=\"#Page%20Should%20Contain\" class=\"name\">Page Should Contain</a> for an explanation about the <code>loglevel</code> argument.</p>", "shortdoc": "Verifies that frame identified by ``locator`` contains ``text``.", "tags": [], "source": "C:\\Python\\lib\\site-packages\\SeleniumLibrary\\keywords\\frames.py", "lineno": 84}, {"name": "Get All Links", "args": [], "doc": "<p>Returns a list containing ids of all links found in current page.</p>\n<p>If a link has no id, an empty string will be in the list instead.</p>", "shortdoc": "Returns a list containing ids of all links found in current page.", "tags": [], "source": "C:\\Python\\lib\\site-packages\\SeleniumLibrary\\keywords\\element.py", "lineno": 993}, {"name": "Get Browser Aliases", "args": [], "doc": "<p>Returns aliases of all active browser that has an alias as NormalizedDict. The dictionary contains the aliases as keys and the index as value. This can be accessed as dictionary <code>${aliases.key}</code> or as list <code>@{aliases}[0]</code>.</p>\n<p>Example:</p>\n<table border=\"1\">\n<tr>\n<td><a href=\"#Open%20Browser\" class=\"name\">Open Browser</a></td>\n<td><a href=\"https://example.com\">https://example.com</a></td>\n<td>alias=BrowserA</td>\n<td></td>\n</tr>\n<tr>\n<td><a href=\"#Open%20Browser\" class=\"name\">Open Browser</a></td>\n<td><a href=\"https://example.com\">https://example.com</a></td>\n<td>alias=BrowserB</td>\n<td></td>\n</tr>\n<tr>\n<td>&amp;{aliases}</td>\n<td><a href=\"#Get%20Browser%20Aliases\" class=\"name\">Get Browser Aliases</a></td>\n<td></td>\n<td># &amp;{aliases} = { BrowserA=1|BrowserB=2 }</td>\n</tr>\n<tr>\n<td><span class=\"name\">Log</span></td>\n<td>${aliases.BrowserA}</td>\n<td></td>\n<td># logs <code>1</code></td>\n</tr>\n<tr>\n<td>FOR</td>\n<td>${alias}</td>\n<td>IN</td>\n<td>@{aliases}</td>\n</tr>\n<tr>\n<td></td>\n<td><span class=\"name\">Log</span></td>\n<td>${alias}</td>\n<td># logs <code>BrowserA</code> and <code>BrowserB</code></td>\n</tr>\n<tr>\n<td>END</td>\n<td></td>\n<td></td>\n<td></td>\n</tr>\n</table>\n<p>See <a href=\"#Switch%20Browser\" class=\"name\">Switch Browser</a> for more information and examples.</p>\n<p>New in SeleniumLibrary 4.0</p>", "shortdoc": "Returns aliases of all active browser that has an alias as NormalizedDict. The dictionary contains the aliases as keys and the index as value. This can be accessed as dictionary ``${aliases.key}`` or as list ``@{aliases}[0]``.", "tags": [], "source": "C:\\Python\\lib\\site-packages\\SeleniumLibrary\\keywords\\browsermanagement.py", "lineno": 459}, {"name": "Get Browser Ids", "args": [], "doc": "<p>Returns index of all active browser as list.</p>\n<p>Example:</p>\n<table border=\"1\">\n<tr>\n<td>@{browser_ids}=</td>\n<td>Get Browser Ids</td>\n<td></td>\n<td></td>\n</tr>\n<tr>\n<td>FOR</td>\n<td>${id}</td>\n<td>IN</td>\n<td>@{browser_ids}</td>\n</tr>\n<tr>\n<td></td>\n<td>@{window_titles}=</td>\n<td>Get Window Titles</td>\n<td>browser=${id}</td>\n</tr>\n<tr>\n<td></td>\n<td>Log</td>\n<td>Browser ${id} has these windows: ${window_titles}</td>\n<td></td>\n</tr>\n<tr>\n<td>END</td>\n<td></td>\n<td></td>\n<td></td>\n</tr>\n</table>\n<p>See <a href=\"#Switch%20Browser\" class=\"name\">Switch Browser</a> for more information and examples.</p>\n<p>New in SeleniumLibrary 4.0</p>", "shortdoc": "Returns index of all active browser as list.", "tags": [], "source": "C:\\Python\\lib\\site-packages\\SeleniumLibrary\\keywords\\browsermanagement.py", "lineno": 442}, {"name": "Get Cookie", "args": [{"name": "name", "types": ["str"], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "name: str"}], "doc": "<p>Returns information of cookie with <code>name</code> as an object.</p>\n<p>If no cookie is found with <code>name</code>, keyword fails. The cookie object contains details about the cookie. Attributes available in the object are documented in the table below.</p>\n<table border=\"1\">\n<tr>\n<th>Attribute</th>\n<th>Explanation</th>\n</tr>\n<tr>\n<td>name</td>\n<td>The name of a cookie.</td>\n</tr>\n<tr>\n<td>value</td>\n<td>Value of the cookie.</td>\n</tr>\n<tr>\n<td>path</td>\n<td>Indicates a URL path, for example <code>/</code>.</td>\n</tr>\n<tr>\n<td>domain</td>\n<td>The domain, the cookie is visible to.</td>\n</tr>\n<tr>\n<td>secure</td>\n<td>When true, the cookie is only used with HTTPS connections.</td>\n</tr>\n<tr>\n<td>httpOnly</td>\n<td>When true, the cookie is not accessible via JavaScript.</td>\n</tr>\n<tr>\n<td>expiry</td>\n<td>Python datetime object indicating when the cookie expires.</td>\n</tr>\n<tr>\n<td>extra</td>\n<td>Possible attributes outside of the WebDriver specification</td>\n</tr>\n</table>\n<p>See the <a href=\"https://w3c.github.io/webdriver/#cookies\">WebDriver specification</a> for details about the cookie information. Notice that <code>expiry</code> is specified as a <a href=\"https://docs.python.org/3/library/datetime.html#datetime.datetime\">datetime object</a>, not as seconds since Unix Epoch like WebDriver natively does.</p>\n<p>In some cases, example when running a browser in the cloud, it is possible that the cookie contains other attributes than is defined in the <a href=\"https://w3c.github.io/webdriver/#cookies\">WebDriver specification</a>. These other attributes are available in an <code>extra</code> attribute in the cookie object and it contains a dictionary of the other attributes. The <code>extra</code> attribute is new in SeleniumLibrary 4.0.</p>\n<p>Example:</p>\n<table border=\"1\">\n<tr>\n<td><a href=\"#Add%20Cookie\" class=\"name\">Add Cookie</a></td>\n<td>foo</td>\n<td>bar</td>\n</tr>\n<tr>\n<td>${cookie} =</td>\n<td><a href=\"#Get%20Cookie\" class=\"name\">Get Cookie</a></td>\n<td>foo</td>\n</tr>\n<tr>\n<td><span class=\"name\">Should Be Equal</span></td>\n<td>${cookie.name}</td>\n<td>foo</td>\n</tr>\n<tr>\n<td><span class=\"name\">Should Be Equal</span></td>\n<td>${cookie.value}</td>\n<td>bar</td>\n</tr>\n<tr>\n<td><span class=\"name\">Should Be True</span></td>\n<td>${cookie.expiry.year} &gt; 2017</td>\n<td></td>\n</tr>\n</table>\n<p>New in SeleniumLibrary 3.0.</p>", "shortdoc": "Returns information of cookie with ``name`` as an object.", "tags": [], "source": "C:\\Python\\lib\\site-packages\\SeleniumLibrary\\keywords\\cookie.py", "lineno": 97}, {"name": "Get Cookies", "args": [{"name": "as_dict", "types": ["bool"], "defaultValue": "False", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "as_dict: bool = False"}], "doc": "<p>Returns all cookies of the current page.</p>\n<p>If <code>as_dict</code> argument evaluates as false, see <span class=\"name\">Boolean arguments</span> for more details, then cookie information is returned as a single string in format <code>name1=value1; name2=value2; name3=value3</code>. When <code>as_dict</code> argument evaluates as true, cookie information is returned as Robot Framework dictionary format. The string format can be used, for example, for logging purposes or in headers when sending HTTP requests. The dictionary format is helpful when the result can be passed to requests library's Create Session keyword's optional cookies parameter.</p>\n<p>The <span class=\"name\">` as_dict</span>` argument is new in SeleniumLibrary 3.3</p>", "shortdoc": "Returns all cookies of the current page.", "tags": [], "source": "C:\\Python\\lib\\site-packages\\SeleniumLibrary\\keywords\\cookie.py", "lineno": 70}, {"name": "Get Element Attribute", "args": [{"name": "locator", "types": ["WebElement", "str"], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "locator: WebElement | str"}, {"name": "attribute", "types": ["str"], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "attribute: str"}], "doc": "<p>Returns the value of <code>attribute</code> from the element <code>locator</code>.</p>\n<p>See the <span class=\"name\">Locating elements</span> section for details about the locator syntax.</p>\n<p>Example:</p>\n<table border=\"1\">\n<tr>\n<td>${id}=</td>\n<td><a href=\"#Get%20Element%20Attribute\" class=\"name\">Get Element Attribute</a></td>\n<td>css:h1</td>\n<td>id</td>\n</tr>\n</table>\n<p>Passing attribute name as part of the <code>locator</code> was removed in SeleniumLibrary 3.2. The explicit <code>attribute</code> argument should be used instead.</p>", "shortdoc": "Returns the value of ``attribute`` from the element ``locator``.", "tags": [], "source": "C:\\Python\\lib\\site-packages\\SeleniumLibrary\\keywords\\element.py", "lineno": 396}, {"name": "Get Element Count", "args": [{"name": "locator", "types": ["WebElement", "str"], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "locator: WebElement | str"}], "doc": "<p>Returns the number of elements matching <code>locator</code>.</p>\n<p>If you wish to assert the number of matching elements, use <a href=\"#Page%20Should%20Contain%20Element\" class=\"name\">Page Should Contain Element</a> with <code>limit</code> argument. Keyword will always return an integer.</p>\n<p>Example:</p>\n<table border=\"1\">\n<tr>\n<td>${count} =</td>\n<td><a href=\"#Get%20Element%20Count\" class=\"name\">Get Element Count</a></td>\n<td>name:div_name</td>\n</tr>\n<tr>\n<td><span class=\"name\">Should Be True</span></td>\n<td>${count} &gt; 2</td>\n<td></td>\n</tr>\n</table>\n<p>New in SeleniumLibrary 3.0.</p>", "shortdoc": "Returns the number of elements matching ``locator``.", "tags": [], "source": "C:\\Python\\lib\\site-packages\\SeleniumLibrary\\keywords\\element.py", "lineno": 1102}, {"name": "Get Element CSS Attribute Value", "args": [{"name": "locator", "types": [], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "locator"}, {"name": "attribute", "types": [], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "attribute"}], "doc": "<p>Get the CSS attribute value of an element. This would be the values within the 'style' tag.</p>\n<p>locator: (string) A selenium locator(CSS, XPATH, ID, NAME, etc)</p>\n<p>attribute: (string) The attribute you wish to get the value for.</p>", "shortdoc": "Get the CSS attribute value of an element. This would be the values within the 'style' tag.", "tags": [], "source": "C:\\Git\\robotframework-zoomba\\src\\Zoomba\\GUILibrary.py", "lineno": 371}, {"name": "Get Element Size", "args": [{"name": "locator", "types": ["WebElement", "str"], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "locator: WebElement | str"}], "doc": "<p>Returns width and height of the element identified by <code>locator</code>.</p>\n<p>See the <span class=\"name\">Locating elements</span> section for details about the locator syntax.</p>\n<p>Both width and height are returned as integers.</p>\n<p>Example:</p>\n<table border=\"1\">\n<tr>\n<td>${width}</td>\n<td>${height} =</td>\n<td><a href=\"#Get%20Element%20Size\" class=\"name\">Get Element Size</a></td>\n<td>css:div#container</td>\n</tr>\n</table>", "shortdoc": "Returns width and height of the element identified by ``locator``.", "tags": [], "source": "C:\\Python\\lib\\site-packages\\SeleniumLibrary\\keywords\\element.py", "lineno": 459}, {"name": "Get Horizontal Position", "args": [{"name": "locator", "types": ["WebElement", "str"], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "locator: WebElement | str"}], "doc": "<p>Returns the horizontal position of the element identified by <code>locator</code>.</p>\n<p>See the <span class=\"name\">Locating elements</span> section for details about the locator syntax.</p>\n<p>The position is returned in pixels off the left side of the page, as an integer.</p>\n<p>See also <a href=\"#Get%20Vertical%20Position\" class=\"name\">Get Vertical Position</a>.</p>", "shortdoc": "Returns the horizontal position of the element identified by ``locator``.", "tags": [], "source": "C:\\Python\\lib\\site-packages\\SeleniumLibrary\\keywords\\element.py", "lineno": 445}, {"name": "Get List Items", "args": [{"name": "locator", "types": ["WebElement", "str"], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "locator: WebElement | str"}, {"name": "values", "types": ["bool"], "defaultValue": "False", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "values: bool = False"}], "doc": "<p>Returns all labels or values of selection list <code>locator</code>.</p>\n<p>See the <span class=\"name\">Locating elements</span> section for details about the locator syntax.</p>\n<p>Returns visible labels by default, but values can be returned by setting the <code>values</code> argument to a true value (see <span class=\"name\">Boolean arguments</span>).</p>\n<p>Example:</p>\n<table border=\"1\">\n<tr>\n<td>${labels} =</td>\n<td><a href=\"#Get%20List%20Items\" class=\"name\">Get List Items</a></td>\n<td>mylist</td>\n<td></td>\n</tr>\n<tr>\n<td>${values} =</td>\n<td><a href=\"#Get%20List%20Items\" class=\"name\">Get List Items</a></td>\n<td>css:#example select</td>\n<td>values=True</td>\n</tr>\n</table>\n<p>Support to return values is new in SeleniumLibrary 3.0.</p>", "shortdoc": "Returns all labels or values of selection list ``locator``.", "tags": [], "source": "C:\\Python\\lib\\site-packages\\SeleniumLibrary\\keywords\\selectelement.py", "lineno": 27}, {"name": "Get Location", "args": [], "doc": "<p>Returns the current browser window URL.</p>", "shortdoc": "Returns the current browser window URL.", "tags": [], "source": "C:\\Python\\lib\\site-packages\\SeleniumLibrary\\keywords\\browsermanagement.py", "lineno": 498}, {"name": "Get Locations", "args": [{"name": "browser", "types": ["str"], "defaultValue": "CURRENT", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "browser: str = CURRENT"}], "doc": "<p>Returns and logs URLs of all windows of the selected browser.</p>\n<p><b>Browser Scope:</b></p>\n<p>The <code>browser</code> argument specifies the browser that shall return its windows information.</p>\n<ul>\n<li><code>browser</code> can be <code>index_or_alias</code> like in <a href=\"#Switch%20Browser\" class=\"name\">Switch Browser</a>.</li>\n</ul>\n<ul>\n<li>If <code>browser</code> is <code>CURRENT</code> (default, case-insensitive) the currently active browser is selected.</li>\n</ul>\n<ul>\n<li>If <code>browser</code> is <code>ALL</code> (case-insensitive) the window information of all windows of all opened browsers are returned.</li>\n</ul>", "shortdoc": "Returns and logs URLs of all windows of the selected browser.", "tags": [], "source": "C:\\Python\\lib\\site-packages\\SeleniumLibrary\\keywords\\window.py", "lineno": 166}, {"name": "Get React List Labels", "args": [{"name": "locator", "types": [], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "locator"}], "doc": "<p>This keyword grabs the labels from a React-Select list. See <a href=\"https://react-select.com/home\">https://react-select.com/home</a> for more information on React-Select components.</p>\n<p>locator: (string) A selenium locator(CSS, XPATH, ID, NAME, etc)</p>", "shortdoc": "This keyword grabs the labels from a React-Select list. See https://react-select.com/home for more information on React-Select components.", "tags": [], "source": "C:\\Git\\robotframework-zoomba\\src\\Zoomba\\GUILibrary.py", "lineno": 398}, {"name": "Get Selected List Label", "args": [{"name": "locator", "types": ["WebElement", "str"], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "locator: WebElement | str"}], "doc": "<p>Returns the label of selected option from selection list <code>locator</code>.</p>\n<p>If there are multiple selected options, the label of the first option is returned.</p>\n<p>See the <span class=\"name\">Locating elements</span> section for details about the locator syntax.</p>", "shortdoc": "Returns the label of selected option from selection list ``locator``.", "tags": [], "source": "C:\\Python\\lib\\site-packages\\SeleniumLibrary\\keywords\\selectelement.py", "lineno": 52}, {"name": "Get Selected List Labels", "args": [{"name": "locator", "types": ["WebElement", "str"], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "locator: WebElement | str"}], "doc": "<p>Returns labels of selected options from selection list <code>locator</code>.</p>\n<p>Starting from SeleniumLibrary 3.0, returns an empty list if there are no selections. In earlier versions, this caused an error.</p>\n<p>See the <span class=\"name\">Locating elements</span> section for details about the locator syntax.</p>", "shortdoc": "Returns labels of selected options from selection list ``locator``.", "tags": [], "source": "C:\\Python\\lib\\site-packages\\SeleniumLibrary\\keywords\\selectelement.py", "lineno": 65}, {"name": "Get Selected List Value", "args": [{"name": "locator", "types": ["WebElement", "str"], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "locator: WebElement | str"}], "doc": "<p>Returns the value of selected option from selection list <code>locator</code>.</p>\n<p>If there are multiple selected options, the value of the first option is returned.</p>\n<p>See the <span class=\"name\">Locating elements</span> section for details about the locator syntax.</p>", "shortdoc": "Returns the value of selected option from selection list ``locator``.", "tags": [], "source": "C:\\Python\\lib\\site-packages\\SeleniumLibrary\\keywords\\selectelement.py", "lineno": 78}, {"name": "Get Selected List Values", "args": [{"name": "locator", "types": ["WebElement", "str"], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "locator: WebElement | str"}], "doc": "<p>Returns values of selected options from selection list <code>locator</code>.</p>\n<p>Starting from SeleniumLibrary 3.0, returns an empty list if there are no selections. In earlier versions, this caused an error.</p>\n<p>See the <span class=\"name\">Locating elements</span> section for details about the locator syntax.</p>", "shortdoc": "Returns values of selected options from selection list ``locator``.", "tags": [], "source": "C:\\Python\\lib\\site-packages\\SeleniumLibrary\\keywords\\selectelement.py", "lineno": 91}, {"name": "Get Selenium Implicit Wait", "args": [], "doc": "<p>Gets the implicit wait value used by Selenium.</p>\n<p>The value is returned as a human-readable string like <code>1 second</code>.</p>\n<p>See the <span class=\"name\">Implicit wait</span> section above for more information.</p>", "shortdoc": "Gets the implicit wait value used by Selenium.", "tags": [], "source": "C:\\Python\\lib\\site-packages\\SeleniumLibrary\\keywords\\browsermanagement.py", "lineno": 620}, {"name": "Get Selenium Speed", "args": [], "doc": "<p>Gets the delay that is waited after each Selenium command.</p>\n<p>The value is returned as a human-readable string like <code>1 second</code>.</p>\n<p>See the <span class=\"name\">Selenium Speed</span> section above for more information.</p>", "shortdoc": "Gets the delay that is waited after each Selenium command.", "tags": [], "source": "C:\\Python\\lib\\site-packages\\SeleniumLibrary\\keywords\\browsermanagement.py", "lineno": 600}, {"name": "Get Selenium Timeout", "args": [], "doc": "<p>Gets the timeout that is used by various keywords.</p>\n<p>The value is returned as a human-readable string like <code>1 second</code>.</p>\n<p>See the <span class=\"name\">Timeout</span> section above for more information.</p>", "shortdoc": "Gets the timeout that is used by various keywords.", "tags": [], "source": "C:\\Python\\lib\\site-packages\\SeleniumLibrary\\keywords\\browsermanagement.py", "lineno": 610}, {"name": "Get Session Id", "args": [], "doc": "<p>Returns the currently active browser session id.</p>\n<p>New in SeleniumLibrary 3.2</p>", "shortdoc": "Returns the currently active browser session id.", "tags": [], "source": "C:\\Python\\lib\\site-packages\\SeleniumLibrary\\keywords\\browsermanagement.py", "lineno": 480}, {"name": "Get Source", "args": [], "doc": "<p>Returns the entire HTML source of the current page or frame.</p>", "shortdoc": "Returns the entire HTML source of the current page or frame.", "tags": [], "source": "C:\\Python\\lib\\site-packages\\SeleniumLibrary\\keywords\\browsermanagement.py", "lineno": 488}, {"name": "Get Table Cell", "args": [{"name": "locator", "types": ["WebElement", "None", "str"], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "locator: WebElement | None | str"}, {"name": "row", "types": ["int"], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "row: int"}, {"name": "column", "types": ["int"], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "column: int"}, {"name": "loglevel", "types": ["str"], "defaultValue": "TRACE", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "loglevel: str = TRACE"}], "doc": "<p>Returns contents of a table cell.</p>\n<p>The table is located using the <code>locator</code> argument and its cell found using <code>row</code> and <code>column</code>. See the <span class=\"name\">Locating elements</span> section for details about the locator syntax.</p>\n<p>Both row and column indexes start from 1, and header and footer rows are included in the count. It is possible to refer to rows and columns from the end by using negative indexes so that -1 is the last row/column, -2 is the second last, and so on.</p>\n<p>All <code>&lt;th&gt;</code> and <code>&lt;td&gt;</code> elements anywhere in the table are considered to be cells.</p>\n<p>See <a href=\"#Page%20Should%20Contain\" class=\"name\">Page Should Contain</a> for an explanation about the <code>loglevel</code> argument.</p>", "shortdoc": "Returns contents of a table cell.", "tags": [], "source": "C:\\Python\\lib\\site-packages\\SeleniumLibrary\\keywords\\tableelement.py", "lineno": 26}, {"name": "Get Text", "args": [{"name": "locator", "types": ["WebElement", "str"], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "locator: WebElement | str"}], "doc": "<p>Returns the text value of the element identified by <code>locator</code>.</p>\n<p>See the <span class=\"name\">Locating elements</span> section for details about the locator syntax.</p>", "shortdoc": "Returns the text value of the element identified by ``locator``.", "tags": [], "source": "C:\\Python\\lib\\site-packages\\SeleniumLibrary\\keywords\\element.py", "lineno": 515}, {"name": "Get Text From Web Elements List", "args": [{"name": "web_elements_list", "types": [], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "web_elements_list"}], "doc": "<p>This keyword extracts the HTML text of a list of web elements, and returns a list.</p>\n<p>web_elements_list: (array of selenium web elements) A selenium web element objects list.</p>\n<p>return: (array of strings) A list of strings extracted from the web elements.</p>", "shortdoc": "This keyword extracts the HTML text of a list of web elements, and returns a list.", "tags": [], "source": "C:\\Git\\robotframework-zoomba\\src\\Zoomba\\GUILibrary.py", "lineno": 276}, {"name": "Get Title", "args": [], "doc": "<p>Returns the title of the current page.</p>", "shortdoc": "Returns the title of the current page.", "tags": [], "source": "C:\\Python\\lib\\site-packages\\SeleniumLibrary\\keywords\\browsermanagement.py", "lineno": 493}, {"name": "Get Value", "args": [{"name": "locator", "types": ["WebElement", "str"], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "locator: WebElement | str"}], "doc": "<p>Returns the value attribute of the element identified by <code>locator</code>.</p>\n<p>See the <span class=\"name\">Locating elements</span> section for details about the locator syntax.</p>", "shortdoc": "Returns the value attribute of the element identified by ``locator``.", "tags": [], "source": "C:\\Python\\lib\\site-packages\\SeleniumLibrary\\keywords\\element.py", "lineno": 506}, {"name": "Get Values From Web Elements List", "args": [{"name": "web_elements_list", "types": [], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "web_elements_list"}], "doc": "<p>This keyword extracts the HTML value of a list of web elements, and returns a list.</p>\n<p>web_elements_list: (array of selenium web elements) A selenium web element objects list.</p>\n<p>return: (array of strings) A list of strings extracted from the web elements.</p>", "shortdoc": "This keyword extracts the HTML value of a list of web elements, and returns a list.", "tags": [], "source": "C:\\Git\\robotframework-zoomba\\src\\Zoomba\\GUILibrary.py", "lineno": 288}, {"name": "Get Vertical Position", "args": [{"name": "locator", "types": ["WebElement", "str"], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "locator: WebElement | str"}], "doc": "<p>Returns the vertical position of the element identified by <code>locator</code>.</p>\n<p>See the <span class=\"name\">Locating elements</span> section for details about the locator syntax.</p>\n<p>The position is returned in pixels off the top of the page, as an integer.</p>\n<p>See also <a href=\"#Get%20Horizontal%20Position\" class=\"name\">Get Horizontal Position</a>.</p>", "shortdoc": "Returns the vertical position of the element identified by ``locator``.", "tags": [], "source": "C:\\Python\\lib\\site-packages\\SeleniumLibrary\\keywords\\element.py", "lineno": 533}, {"name": "Get Vertical Position From Web Elements List", "args": [{"name": "web_elements_list", "types": [], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "web_elements_list"}], "doc": "<p>This keyword extracts the vertical position in pixels of a list of web elements, and returns a list.</p>\n<p>web_elements_list: (array of selenium web elements) A selenium web element objects list.</p>\n<p>return: (array of integers) A list of integers of the vertical pixel positions for the provided web elements.</p>", "shortdoc": "This keyword extracts the vertical position in pixels of a list of web elements, and returns a list.", "tags": [], "source": "C:\\Git\\robotframework-zoomba\\src\\Zoomba\\GUILibrary.py", "lineno": 300}, {"name": "Get WebElement", "args": [{"name": "locator", "types": ["WebElement", "str"], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "locator: WebElement | str"}], "doc": "<p>Returns the first WebElement matching the given <code>locator</code>.</p>\n<p>See the <span class=\"name\">Locating elements</span> section for details about the locator syntax.</p>", "shortdoc": "Returns the first WebElement matching the given ``locator``.", "tags": [], "source": "C:\\Python\\lib\\site-packages\\SeleniumLibrary\\keywords\\element.py", "lineno": 33}, {"name": "Get WebElements", "args": [{"name": "locator", "types": ["WebElement", "str"], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "locator: WebElement | str"}], "doc": "<p>Returns a list of WebElement objects matching the <code>locator</code>.</p>\n<p>See the <span class=\"name\">Locating elements</span> section for details about the locator syntax.</p>\n<p>Starting from SeleniumLibrary 3.0, the keyword returns an empty list if there are no matching elements. In previous releases, the keyword failed in this case.</p>", "shortdoc": "Returns a list of WebElement objects matching the ``locator``.", "tags": [], "source": "C:\\Python\\lib\\site-packages\\SeleniumLibrary\\keywords\\element.py", "lineno": 42}, {"name": "Get Window Handles", "args": [{"name": "browser", "types": ["str"], "defaultValue": "CURRENT", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "browser: str = CURRENT"}], "doc": "<p>Returns all child window handles of the selected browser as a list.</p>\n<p>Can be used as a list of windows to exclude with <span class=\"name\">Select Window</span>.</p>\n<p>How to select the <code>browser</code> scope of this keyword, see <a href=\"#Get%20Locations\" class=\"name\">Get Locations</a>.</p>\n<p>Prior to SeleniumLibrary 3.0, this keyword was named <span class=\"name\">List Windows</span>.</p>", "shortdoc": "Returns all child window handles of the selected browser as a list.", "tags": [], "source": "C:\\Python\\lib\\site-packages\\SeleniumLibrary\\keywords\\window.py", "lineno": 130}, {"name": "Get Window Identifiers", "args": [{"name": "browser", "types": ["str"], "defaultValue": "CURRENT", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "browser: str = CURRENT"}], "doc": "<p>Returns and logs id attributes of all windows of the selected browser.</p>\n<p>How to select the <code>browser</code> scope of this keyword, see <a href=\"#Get%20Locations\" class=\"name\">Get Locations</a>.</p>", "shortdoc": "Returns and logs id attributes of all windows of the selected browser.", "tags": [], "source": "C:\\Python\\lib\\site-packages\\SeleniumLibrary\\keywords\\window.py", "lineno": 142}, {"name": "Get Window Names", "args": [{"name": "browser", "types": ["str"], "defaultValue": "CURRENT", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "browser: str = CURRENT"}], "doc": "<p>Returns and logs names of all windows of the selected browser.</p>\n<p>How to select the <code>browser</code> scope of this keyword, see <a href=\"#Get%20Locations\" class=\"name\">Get Locations</a>.</p>", "shortdoc": "Returns and logs names of all windows of the selected browser.", "tags": [], "source": "C:\\Python\\lib\\site-packages\\SeleniumLibrary\\keywords\\window.py", "lineno": 150}, {"name": "Get Window Position", "args": [], "doc": "<p>Returns current window position.</p>\n<p>The position is relative to the top left corner of the screen. Returned values are integers. See also <a href=\"#Set%20Window%20Position\" class=\"name\">Set Window Position</a>.</p>\n<p>Example:</p>\n<table border=\"1\">\n<tr>\n<td>${x}</td>\n<td>${y}=</td>\n<td><a href=\"#Get%20Window%20Position\" class=\"name\">Get Window Position</a></td>\n</tr>\n</table>", "shortdoc": "Returns current window position.", "tags": [], "source": "C:\\Python\\lib\\site-packages\\SeleniumLibrary\\keywords\\window.py", "lineno": 256}, {"name": "Get Window Size", "args": [{"name": "inner", "types": ["bool"], "defaultValue": "False", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "inner: bool = False"}], "doc": "<p>Returns current window width and height as integers.</p>\n<p>See also <a href=\"#Set%20Window%20Size\" class=\"name\">Set Window Size</a>.</p>\n<p>If <code>inner</code> parameter is set to True, keyword returns HTML DOM window.innerWidth and window.innerHeight properties. See <span class=\"name\">Boolean arguments</span> for more details on how to set boolean arguments. The <code>inner</code> is new in SeleniumLibrary 4.0.</p>\n<p>Example:</p>\n<table border=\"1\">\n<tr>\n<td>${width}</td>\n<td>${height}=</td>\n<td><a href=\"#Get%20Window%20Size\" class=\"name\">Get Window Size</a></td>\n<td></td>\n</tr>\n<tr>\n<td>${width}</td>\n<td>${height}=</td>\n<td><a href=\"#Get%20Window%20Size\" class=\"name\">Get Window Size</a></td>\n<td>True</td>\n</tr>\n</table>", "shortdoc": "Returns current window width and height as integers.", "tags": [], "source": "C:\\Python\\lib\\site-packages\\SeleniumLibrary\\keywords\\window.py", "lineno": 190}, {"name": "Get Window Titles", "args": [{"name": "browser", "types": ["str"], "defaultValue": "CURRENT", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "browser: str = CURRENT"}], "doc": "<p>Returns and logs titles of all windows of the selected browser.</p>\n<p>How to select the <code>browser</code> scope of this keyword, see <a href=\"#Get%20Locations\" class=\"name\">Get Locations</a>.</p>", "shortdoc": "Returns and logs titles of all windows of the selected browser.", "tags": [], "source": "C:\\Python\\lib\\site-packages\\SeleniumLibrary\\keywords\\window.py", "lineno": 158}, {"name": "Go Back", "args": [], "doc": "<p>Simulates the user clicking the back button on their browser.</p>", "shortdoc": "Simulates the user clicking the back button on their browser.", "tags": [], "source": "C:\\Python\\lib\\site-packages\\SeleniumLibrary\\keywords\\browsermanagement.py", "lineno": 584}, {"name": "Go To", "args": [{"name": "url", "types": [], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "url"}], "doc": "<p>Navigates the current browser window to the provided <code>url</code>.</p>", "shortdoc": "Navigates the current browser window to the provided ``url``.", "tags": [], "source": "C:\\Python\\lib\\site-packages\\SeleniumLibrary\\keywords\\browsermanagement.py", "lineno": 589}, {"name": "Handle Alert", "args": [{"name": "action", "types": ["str"], "defaultValue": "ACCEPT", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "action: str = ACCEPT"}, {"name": "timeout", "types": ["timedelta"], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "timeout: timedelta = None"}], "doc": "<p>Handles the current alert and returns its message.</p>\n<p>By default, the alert is accepted, but this can be controlled with the <code>action</code> argument that supports the following case-insensitive values:</p>\n<ul>\n<li><code>ACCEPT</code>: Accept the alert i.e. press <code>Ok</code>. Default.</li>\n<li><code>DISMISS</code>: Dismiss the alert i.e. press <code>Cancel</code>.</li>\n<li><code>LEAVE</code>: Leave the alert open.</li>\n</ul>\n<p>The <code>timeout</code> argument specifies how long to wait for the alert to appear. If it is not given, the global default <span class=\"name\">timeout</span> is used instead.</p>\n<p>Examples:</p>\n<table border=\"1\">\n<tr>\n<td>Handle Alert</td>\n<td></td>\n<td></td>\n<td># Accept alert.</td>\n</tr>\n<tr>\n<td>Handle Alert</td>\n<td>action=DISMISS</td>\n<td></td>\n<td># Dismiss alert.</td>\n</tr>\n<tr>\n<td>Handle Alert</td>\n<td>timeout=10 s</td>\n<td></td>\n<td># Use custom timeout and accept alert.</td>\n</tr>\n<tr>\n<td>Handle Alert</td>\n<td>DISMISS</td>\n<td>1 min</td>\n<td># Use custom timeout and dismiss alert.</td>\n</tr>\n<tr>\n<td>${message} =</td>\n<td>Handle Alert</td>\n<td></td>\n<td># Accept alert and get its message.</td>\n</tr>\n<tr>\n<td>${message} =</td>\n<td>Handle Alert</td>\n<td>LEAVE</td>\n<td># Leave alert open and get its message.</td>\n</tr>\n</table>\n<p>New in SeleniumLibrary 3.0.</p>", "shortdoc": "Handles the current alert and returns its message.", "tags": [], "source": "C:\\Python\\lib\\site-packages\\SeleniumLibrary\\keywords\\alert.py", "lineno": 104}, {"name": "Input Password", "args": [{"name": "locator", "types": ["WebElement", "str"], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "locator: WebElement | str"}, {"name": "password", "types": ["str"], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "password: str"}, {"name": "clear", "types": ["bool"], "defaultValue": "True", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "clear: bool = True"}], "doc": "<p>Types the given password into the text field identified by <code>locator</code>.</p>\n<p>See the <span class=\"name\">Locating elements</span> section for details about the locator syntax. See <a href=\"#Input%20Text\" class=\"name\">Input Text</a> for <code>clear</code> argument details.</p>\n<p>Difference compared to <a href=\"#Input%20Text\" class=\"name\">Input Text</a> is that this keyword does not log the given password on the INFO level. Notice that if you use the keyword like</p>\n<table border=\"1\">\n<tr>\n<td>Input Password</td>\n<td>password_field</td>\n<td>password</td>\n</tr>\n</table>\n<p>the password is shown as a normal keyword argument. A way to avoid that is using variables like</p>\n<table border=\"1\">\n<tr>\n<td>Input Password</td>\n<td>password_field</td>\n<td>${PASSWORD}</td>\n</tr>\n</table>\n<p>Please notice that Robot Framework logs all arguments using the TRACE level and tests must not be executed using level below DEBUG if the password should not be logged in any format.</p>\n<p>The <span class=\"name\">clear</span> argument is new in SeleniumLibrary 4.0. Hiding password logging from Selenium logs is new in SeleniumLibrary 4.2.</p>", "shortdoc": "Types the given password into the text field identified by ``locator``.", "tags": [], "source": "C:\\Python\\lib\\site-packages\\SeleniumLibrary\\keywords\\formelement.py", "lineno": 242}, {"name": "Input Text", "args": [{"name": "locator", "types": ["WebElement", "str"], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "locator: WebElement | str"}, {"name": "text", "types": ["str"], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "text: str"}, {"name": "clear", "types": ["bool"], "defaultValue": "True", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "clear: bool = True"}], "doc": "<p>Types the given <code>text</code> into the text field identified by <code>locator</code>.</p>\n<p>When <code>clear</code> is true, the input element is cleared before the text is typed into the element. When false, the previous text is not cleared from the element. Use <a href=\"#Input%20Password\" class=\"name\">Input Password</a> if you do not want the given <code>text</code> to be logged.</p>\n<p>If <a href=\"https://github.com/SeleniumHQ/selenium/wiki/Grid2\">Selenium Grid</a> is used and the <code>text</code> argument points to a file in the file system, then this keyword prevents the Selenium to transfer the file to the Selenium Grid hub. Instead, this keyword will send the <code>text</code> string as is to the element. If a file should be transferred to the hub and upload should be performed, please use <a href=\"#Choose%20File\" class=\"name\">Choose File</a> keyword.</p>\n<p>See the <span class=\"name\">Locating elements</span> section for details about the locator syntax. See the <span class=\"name\">Boolean arguments</span> section how Boolean values are handled.</p>\n<p>Disabling the file upload the Selenium Grid node and the <span class=\"name\">clear</span> argument are new in SeleniumLibrary 4.0</p>", "shortdoc": "Types the given ``text`` into the text field identified by ``locator``.", "tags": [], "source": "C:\\Python\\lib\\site-packages\\SeleniumLibrary\\keywords\\formelement.py", "lineno": 272}, {"name": "Input Text Into Alert", "args": [{"name": "text", "types": ["str"], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "text: str"}, {"name": "action", "types": ["str"], "defaultValue": "ACCEPT", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "action: str = ACCEPT"}, {"name": "timeout", "types": ["timedelta"], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "timeout: timedelta = None"}], "doc": "<p>Types the given <code>text</code> into an input field in an alert.</p>\n<p>The alert is accepted by default, but that behavior can be controlled by using the <code>action</code> argument same way as with <a href=\"#Handle%20Alert\" class=\"name\">Handle Alert</a>.</p>\n<p><code>timeout</code> specifies how long to wait for the alert to appear. If it is not given, the global default <span class=\"name\">timeout</span> is used instead.</p>\n<p>New in SeleniumLibrary 3.0.</p>", "shortdoc": "Types the given ``text`` into an input field in an alert.", "tags": [], "source": "C:\\Python\\lib\\site-packages\\SeleniumLibrary\\keywords\\alert.py", "lineno": 34}, {"name": "List Selection Should Be", "args": [{"name": "locator", "types": ["WebElement", "str"], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "locator: WebElement | str"}, {"name": "expected", "types": ["str"], "defaultValue": null, "kind": "VAR_POSITIONAL", "required": false, "repr": "*expected: str"}], "doc": "<p>Verifies selection list <code>locator</code> has <code>expected</code> options selected.</p>\n<p>It is possible to give expected options both as visible labels and as values. Starting from SeleniumLibrary 3.0, mixing labels and values is not possible. Order of the selected options is not validated.</p>\n<p>If no expected options are given, validates that the list has no selections. A more explicit alternative is using <a href=\"#List%20Should%20Have%20No%20Selections\" class=\"name\">List Should Have No Selections</a>.</p>\n<p>See the <span class=\"name\">Locating elements</span> section for details about the locator syntax.</p>\n<p>Examples:</p>\n<table border=\"1\">\n<tr>\n<td><a href=\"#List%20Selection%20Should%20Be\" class=\"name\">List Selection Should Be</a></td>\n<td>gender</td>\n<td>Female</td>\n<td></td>\n</tr>\n<tr>\n<td><a href=\"#List%20Selection%20Should%20Be\" class=\"name\">List Selection Should Be</a></td>\n<td>interests</td>\n<td>Test Automation</td>\n<td>Python</td>\n</tr>\n</table>", "shortdoc": "Verifies selection list ``locator`` has ``expected`` options selected.", "tags": [], "source": "C:\\Python\\lib\\site-packages\\SeleniumLibrary\\keywords\\selectelement.py", "lineno": 104}, {"name": "List Should Have No Selections", "args": [{"name": "locator", "types": ["WebElement", "str"], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "locator: WebElement | str"}], "doc": "<p>Verifies selection list <code>locator</code> has no options selected.</p>\n<p>See the <span class=\"name\">Locating elements</span> section for details about the locator syntax.</p>", "shortdoc": "Verifies selection list ``locator`` has no options selected.", "tags": [], "source": "C:\\Python\\lib\\site-packages\\SeleniumLibrary\\keywords\\selectelement.py", "lineno": 141}, {"name": "Location Should Be", "args": [{"name": "url", "types": ["str"], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "url: str"}, {"name": "message", "types": ["str"], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "message: str = None"}], "doc": "<p>Verifies that the current URL is exactly <code>url</code>.</p>\n<p>The <code>url</code> argument contains the exact url that should exist in browser.</p>\n<p>The <code>message</code> argument can be used to override the default error message.</p>\n<p><code>message</code> argument is new in SeleniumLibrary 3.2.0.</p>", "shortdoc": "Verifies that the current URL is exactly ``url``.", "tags": [], "source": "C:\\Python\\lib\\site-packages\\SeleniumLibrary\\keywords\\browsermanagement.py", "lineno": 503}, {"name": "Location Should Contain", "args": [{"name": "expected", "types": ["str"], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "expected: str"}, {"name": "message", "types": ["str"], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "message: str = None"}], "doc": "<p>Verifies that the current URL contains <code>expected</code>.</p>\n<p>The <code>expected</code> argument contains the expected value in url.</p>\n<p>The <code>message</code> argument can be used to override the default error message.</p>\n<p><code>message</code> argument is new in SeleniumLibrary 3.2.0.</p>", "shortdoc": "Verifies that the current URL contains ``expected``.", "tags": [], "source": "C:\\Python\\lib\\site-packages\\SeleniumLibrary\\keywords\\browsermanagement.py", "lineno": 521}, {"name": "Log Location", "args": [], "doc": "<p>Logs and returns the current browser window URL.</p>", "shortdoc": "Logs and returns the current browser window URL.", "tags": [], "source": "C:\\Python\\lib\\site-packages\\SeleniumLibrary\\keywords\\browsermanagement.py", "lineno": 542}, {"name": "Log Source", "args": [{"name": "loglevel", "types": ["str"], "defaultValue": "INFO", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "loglevel: str = INFO"}], "doc": "<p>Logs and returns the HTML source of the current page or frame.</p>\n<p>The <code>loglevel</code> argument defines the used log level. Valid log levels are <code>WARN</code>, <code>INFO</code> (default), <code>DEBUG</code>, <code>TRACE</code> and <code>NONE</code> (no logging).</p>", "shortdoc": "Logs and returns the HTML source of the current page or frame.", "tags": [], "source": "C:\\Python\\lib\\site-packages\\SeleniumLibrary\\keywords\\browsermanagement.py", "lineno": 549}, {"name": "Log Title", "args": [], "doc": "<p>Logs and returns the title of the current page.</p>", "shortdoc": "Logs and returns the title of the current page.", "tags": [], "source": "C:\\Python\\lib\\site-packages\\SeleniumLibrary\\keywords\\browsermanagement.py", "lineno": 561}, {"name": "Maximize Browser Window", "args": [], "doc": "<p>Maximizes current browser window.</p>", "shortdoc": "Maximizes current browser window.", "tags": [], "source": "C:\\Python\\lib\\site-packages\\SeleniumLibrary\\keywords\\window.py", "lineno": 185}, {"name": "Mouse Down", "args": [{"name": "locator", "types": ["WebElement", "str"], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "locator: WebElement | str"}], "doc": "<p>Simulates pressing the left mouse button on the element <code>locator</code>.</p>\n<p>See the <span class=\"name\">Locating elements</span> section for details about the locator syntax.</p>\n<p>The element is pressed without releasing the mouse button.</p>\n<p>See also the more specific keywords <a href=\"#Mouse%20Down%20On%20Image\" class=\"name\">Mouse Down On Image</a> and <a href=\"#Mouse%20Down%20On%20Link\" class=\"name\">Mouse Down On Link</a>.</p>", "shortdoc": "Simulates pressing the left mouse button on the element ``locator``.", "tags": [], "source": "C:\\Python\\lib\\site-packages\\SeleniumLibrary\\keywords\\element.py", "lineno": 797}, {"name": "Mouse Down On Image", "args": [{"name": "locator", "types": ["WebElement", "str"], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "locator: WebElement | str"}], "doc": "<p>Simulates a mouse down event on an image identified by <code>locator</code>.</p>\n<p>See the <span class=\"name\">Locating elements</span> section for details about the locator syntax. When using the default locator strategy, images are searched using <code>id</code>, <code>name</code>, <code>src</code> and <code>alt</code>.</p>", "shortdoc": "Simulates a mouse down event on an image identified by ``locator``.", "tags": [], "source": "C:\\Python\\lib\\site-packages\\SeleniumLibrary\\keywords\\element.py", "lineno": 1052}, {"name": "Mouse Down On Link", "args": [{"name": "locator", "types": ["WebElement", "str"], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "locator: WebElement | str"}], "doc": "<p>Simulates a mouse down event on a link identified by <code>locator</code>.</p>\n<p>See the <span class=\"name\">Locating elements</span> section for details about the locator syntax. When using the default locator strategy, links are searched using <code>id</code>, <code>name</code>, <code>href</code> and the link text.</p>", "shortdoc": "Simulates a mouse down event on a link identified by ``locator``.", "tags": [], "source": "C:\\Python\\lib\\site-packages\\SeleniumLibrary\\keywords\\element.py", "lineno": 1002}, {"name": "Mouse Out", "args": [{"name": "locator", "types": ["WebElement", "str"], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "locator: WebElement | str"}], "doc": "<p>Simulates moving the mouse away from the element <code>locator</code>.</p>\n<p>See the <span class=\"name\">Locating elements</span> section for details about the locator syntax.</p>", "shortdoc": "Simulates moving the mouse away from the element ``locator``.", "tags": [], "source": "C:\\Python\\lib\\site-packages\\SeleniumLibrary\\keywords\\element.py", "lineno": 816}, {"name": "Mouse Over", "args": [{"name": "locator", "types": ["WebElement", "str"], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "locator: WebElement | str"}], "doc": "<p>Simulates hovering the mouse over the element <code>locator</code>.</p>\n<p>See the <span class=\"name\">Locating elements</span> section for details about the locator syntax.</p>", "shortdoc": "Simulates hovering the mouse over the element ``locator``.", "tags": [], "source": "C:\\Python\\lib\\site-packages\\SeleniumLibrary\\keywords\\element.py", "lineno": 835}, {"name": "Mouse Up", "args": [{"name": "locator", "types": ["WebElement", "str"], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "locator: WebElement | str"}], "doc": "<p>Simulates releasing the left mouse button on the element <code>locator</code>.</p>\n<p>See the <span class=\"name\">Locating elements</span> section for details about the locator syntax.</p>", "shortdoc": "Simulates releasing the left mouse button on the element ``locator``.", "tags": [], "source": "C:\\Python\\lib\\site-packages\\SeleniumLibrary\\keywords\\element.py", "lineno": 849}, {"name": "Open Browser", "args": [{"name": "url", "types": ["str"], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "url: str = None"}, {"name": "browser", "types": ["str"], "defaultValue": "firefox", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "browser: str = firefox"}, {"name": "alias", "types": ["str"], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "alias: str = None"}, {"name": "remote_url", "types": ["bool", "str"], "defaultValue": "False", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "remote_url: bool | str = False"}, {"name": "desired_capabilities", "types": ["dict", "None", "str"], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "desired_capabilities: dict | None | str = None"}, {"name": "ff_profile_dir", "types": ["FirefoxProfile", "str", "None"], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "ff_profile_dir: FirefoxProfile | str | None = None"}, {"name": "options", "types": ["Any"], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "options: Any = None"}, {"name": "service_log_path", "types": ["str"], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "service_log_path: str = None"}, {"name": "executable_path", "types": ["str"], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "executable_path: str = None"}], "doc": "<p>Opens a new browser instance to the optional <code>url</code>.</p>\n<p>The <code>browser</code> argument specifies which browser to use. The supported browsers are listed in the table below. The browser names are case-insensitive and some browsers have multiple supported names.</p>\n<table border=\"1\">\n<tr>\n<th>Browser</th>\n<th>Name(s)</th>\n</tr>\n<tr>\n<td>Firefox</td>\n<td>firefox, ff</td>\n</tr>\n<tr>\n<td>Google Chrome</td>\n<td>googlechrome, chrome, gc</td>\n</tr>\n<tr>\n<td>Headless Firefox</td>\n<td>headlessfirefox</td>\n</tr>\n<tr>\n<td>Headless Chrome</td>\n<td>headlesschrome</td>\n</tr>\n<tr>\n<td>Internet Explorer</td>\n<td>internetexplorer, ie</td>\n</tr>\n<tr>\n<td>Edge</td>\n<td>edge</td>\n</tr>\n<tr>\n<td>Safari</td>\n<td>safari</td>\n</tr>\n<tr>\n<td>Opera</td>\n<td>opera</td>\n</tr>\n<tr>\n<td>Android</td>\n<td>android</td>\n</tr>\n<tr>\n<td>Iphone</td>\n<td>iphone</td>\n</tr>\n<tr>\n<td>PhantomJS</td>\n<td>phantomjs</td>\n</tr>\n<tr>\n<td>HTMLUnit</td>\n<td>htmlunit</td>\n</tr>\n<tr>\n<td>HTMLUnit with Javascript</td>\n<td>htmlunitwithjs</td>\n</tr>\n</table>\n<p>To be able to actually use one of these browsers, you need to have a matching Selenium browser driver available. See the <a href=\"https://github.com/robotframework/SeleniumLibrary#browser-drivers\">project documentation</a> for more details. Headless Firefox and Headless Chrome are new additions in SeleniumLibrary 3.1.0 and require Selenium 3.8.0 or newer.</p>\n<p>After opening the browser, it is possible to use optional <code>url</code> to navigate the browser to the desired address.</p>\n<p>Optional <code>alias</code> is an alias given for this browser instance and it can be used for switching between browsers. When same <code>alias</code> is given with two <a href=\"#Open%20Browser\" class=\"name\">Open Browser</a> keywords, the first keyword will open a new browser, but the second one will switch to the already opened browser and will not open a new browser. The <code>alias</code> definition overrules <code>browser</code> definition. When same <code>alias</code> is used but a different <code>browser</code> is defined, then switch to a browser with same alias is done and new browser is not opened. An alternative approach for switching is using an index returned by this keyword. These indices start from 1, are incremented when new browsers are opened, and reset back to 1 when <a href=\"#Close%20All%20Browsers\" class=\"name\">Close All Browsers</a> is called. See <a href=\"#Switch%20Browser\" class=\"name\">Switch Browser</a> for more information and examples.</p>\n<p>Optional <code>remote_url</code> is the URL for a <a href=\"https://github.com/SeleniumHQ/selenium/wiki/Grid2\">Selenium Grid</a>.</p>\n<p>Optional <code>desired_capabilities</code> can be used to configure, for example, logging preferences for a browser or a browser and operating system when using <a href=\"http://saucelabs.com\">Sauce Labs</a>. Desired capabilities can be given either as a Python dictionary or as a string in the format <code>key1:value1,key2:value2</code>. <a href=\"https://github.com/SeleniumHQ/selenium/wiki/DesiredCapabilities\">Selenium documentation</a> lists possible capabilities that can be enabled.</p>\n<p>Optional <code>ff_profile_dir</code> is the path to the Firefox profile directory if you wish to overwrite the default profile Selenium uses. Notice that prior to SeleniumLibrary 3.0, the library contained its own profile that was used by default. The <code>ff_profile_dir</code> can also be an instance of the <a href=\"https://seleniumhq.github.io/selenium/docs/api/py/webdriver_firefox/selenium.webdriver.firefox.firefox_profile.html\">selenium.webdriver.FirefoxProfile</a> . As a third option, it is possible to use <span class=\"name\">FirefoxProfile</span> methods and attributes to define the profile using methods and attributes in the same way as with <code>options</code> argument. Example: It is possible to use FirefoxProfile <span class=\"name\">set_preference</span> to define different profile settings. See <code>options</code> argument documentation in below how to handle backslash escaping.</p>\n<p>Optional <code>options</code> argument allows defining browser specific Selenium options. Example for Chrome, the <code>options</code> argument allows defining the following <a href=\"https://seleniumhq.github.io/selenium/docs/api/py/webdriver_chrome/selenium.webdriver.chrome.options.html#selenium.webdriver.chrome.options.Options\">methods and attributes</a> and for Firefox these <a href=\"https://seleniumhq.github.io/selenium/docs/api/py/webdriver_firefox/selenium.webdriver.firefox.options.html?highlight=firefox#selenium.webdriver.firefox.options.Options\">methods and attributes</a> are available. Please note that not all browsers, supported by the SeleniumLibrary, have Selenium options available. Therefore please consult the Selenium documentation which browsers do support the Selenium options. If <code>browser</code> argument is <span class=\"name\">android</span> then <a href=\"https://seleniumhq.github.io/selenium/docs/api/py/webdriver_chrome/selenium.webdriver.chrome.options.html#selenium.webdriver.chrome.options.Options\">Chrome options</a> is used. Selenium options are also supported, when <code>remote_url</code> argument is used.</p>\n<p>The SeleniumLibrary <code>options</code> argument accepts Selenium options in two different formats: as a string and as Python object which is an instance of the Selenium options class.</p>\n<p>The string format allows defining Selenium options methods or attributes and their arguments in Robot Framework test data. The method and attributes names are case and space sensitive and must match to the Selenium options methods and attributes names. When defining a method, it must be defined in a similar way as in python: method name, opening parenthesis, zero to many arguments and closing parenthesis. If there is a need to define multiple arguments for a single method, arguments must be separated with comma, just like in Python. Example: <span class=\"name\">add_argument(\"--headless\")</span> or <span class=\"name\">add_experimental_option(\"key\", \"value\")</span>. Attributes are defined in a similar way as in Python: attribute name, equal sign, and attribute value. Example, <span class=\"name\">headless=True</span>. Multiple methods and attributes must be separated by a semicolon. Example: <span class=\"name\">add_argument(\"--headless\");add_argument(\"--start-maximized\")</span>.</p>\n<p>Arguments allow defining Python data types and arguments are evaluated by using Python <a href=\"https://docs.python.org/3/library/ast.html#ast.literal_eval\">ast.literal_eval</a>. Strings must be quoted with single or double quotes, example \"value\" or 'value'. It is also possible to define other Python builtin data types, example <span class=\"name\">True</span> or <span class=\"name\">None</span>, by not using quotes around the arguments.</p>\n<p>The string format is space friendly. Usually, spaces do not alter the defining methods or attributes. There are two exceptions. In some Robot Framework test data formats, two or more spaces are considered as cell separator and instead of defining a single argument, two or more arguments may be defined. Spaces in string arguments are not removed and are left as is. Example <span class=\"name\">add_argument ( \"--headless\" )</span> is same as <span class=\"name\">add_argument(\"--headless\")</span>. But <span class=\"name\">add_argument(\" --headless \")</span> is not same same as <span class=\"name\">add_argument ( \"--headless\" )</span>, because spaces inside of quotes are not removed. Please note that if options string contains backslash, example a Windows OS path, the backslash needs escaping both in Robot Framework data and in Python side. This means single backslash must be writen using four backslash characters. Example, Windows path: \"C:\\path\\to\\profile\" must be written as \"C:\\\\\\\\path\\\\\\to\\\\\\\\profile\". Another way to write backslash is use Python <a href=\"https://docs.python.org/3/reference/lexical_analysis.html#string-and-bytes-literals\">raw strings</a> and example write: r\"C:\\\\path\\\\to\\\\profile\".</p>\n<p>As last format, <code>options</code> argument also supports receiving the Selenium options as Python class instance. In this case, the instance is used as-is and the SeleniumLibrary will not convert the instance to other formats. For example, if the following code return value is saved to <span class=\"name\">${options}</span> variable in the Robot Framework data:</p>\n<pre>\noptions = webdriver.ChromeOptions()\noptions.add_argument('--disable-dev-shm-usage')\nreturn options\n</pre>\n<p>Then the <span class=\"name\">${options}</span> variable can be used as an argument to <code>options</code>.</p>\n<p>Example the <code>options</code> argument can be used to launch Chomium-based applications which utilize the <a href=\"https://bitbucket.org/chromiumembedded/cef/wiki/UsingChromeDriver\">Chromium Embedded Framework</a> . To lauch Chomium-based application, use <code>options</code> to define <span class=\"name\">binary_location</span> attribute and use <span class=\"name\">add_argument</span> method to define <span class=\"name\">remote-debugging-port</span> port for the application. Once the browser is opened, the test can interact with the embedded web-content of the system under test.</p>\n<p>Optional <code>service_log_path</code> argument defines the name of the file where to write the browser driver logs. If the <code>service_log_path</code>  argument contain a  marker <code>{index}</code>, it will be automatically replaced with unique running index preventing files to be overwritten. Indices start's from 1, and how they are represented can be customized using Python's <a href=\"https://docs.python.org/3/library/string.html#format-string-syntax\">format string syntax</a>.</p>\n<p>Optional <code>executable_path</code> argument defines the path to the driver executable, example to a chromedriver or a geckodriver. If not defined it is assumed the executable is in the <a href=\"https://en.wikipedia.org/wiki/PATH_(variable)\">$PATH</a>.</p>\n<p>Examples:</p>\n<table border=\"1\">\n<tr>\n<td><a href=\"#Open%20Browser\" class=\"name\">Open Browser</a></td>\n<td><a href=\"http://example.com\">http://example.com</a></td>\n<td>Chrome</td>\n<td></td>\n</tr>\n<tr>\n<td><a href=\"#Open%20Browser\" class=\"name\">Open Browser</a></td>\n<td><a href=\"http://example.com\">http://example.com</a></td>\n<td>Firefox</td>\n<td>alias=Firefox</td>\n</tr>\n<tr>\n<td><a href=\"#Open%20Browser\" class=\"name\">Open Browser</a></td>\n<td><a href=\"http://example.com\">http://example.com</a></td>\n<td>Edge</td>\n<td>remote_url=http://127.0.0.1:4444/wd/hub</td>\n</tr>\n<tr>\n<td><a href=\"#Open%20Browser\" class=\"name\">Open Browser</a></td>\n<td>about:blank</td>\n<td></td>\n<td></td>\n</tr>\n<tr>\n<td><a href=\"#Open%20Browser\" class=\"name\">Open Browser</a></td>\n<td>browser=Chrome</td>\n<td></td>\n<td></td>\n</tr>\n</table>\n<p>Alias examples:</p>\n<table border=\"1\">\n<tr>\n<td>${1_index} =</td>\n<td><a href=\"#Open%20Browser\" class=\"name\">Open Browser</a></td>\n<td><a href=\"http://example.com\">http://example.com</a></td>\n<td>Chrome</td>\n<td>alias=Chrome</td>\n<td># Opens new browser because alias is new.</td>\n</tr>\n<tr>\n<td>${2_index} =</td>\n<td><a href=\"#Open%20Browser\" class=\"name\">Open Browser</a></td>\n<td><a href=\"http://example.com\">http://example.com</a></td>\n<td>Firefox</td>\n<td></td>\n<td># Opens new browser because alias is not defined.</td>\n</tr>\n<tr>\n<td>${3_index} =</td>\n<td><a href=\"#Open%20Browser\" class=\"name\">Open Browser</a></td>\n<td><a href=\"http://example.com\">http://example.com</a></td>\n<td>Chrome</td>\n<td>alias=Chrome</td>\n<td># Switches to the browser with Chrome alias.</td>\n</tr>\n<tr>\n<td>${4_index} =</td>\n<td><a href=\"#Open%20Browser\" class=\"name\">Open Browser</a></td>\n<td><a href=\"http://example.com\">http://example.com</a></td>\n<td>Chrome</td>\n<td>alias=${1_index}</td>\n<td># Switches to the browser with Chrome alias.</td>\n</tr>\n<tr>\n<td>Should Be Equal</td>\n<td>${1_index}</td>\n<td>${3_index}</td>\n<td></td>\n<td></td>\n<td></td>\n</tr>\n<tr>\n<td>Should Be Equal</td>\n<td>${1_index}</td>\n<td>${4_index}</td>\n<td></td>\n<td></td>\n<td></td>\n</tr>\n<tr>\n<td>Should Be Equal</td>\n<td>${2_index}</td>\n<td>${2}</td>\n<td></td>\n<td></td>\n<td></td>\n</tr>\n</table>\n<p>Example when using <a href=\"https://seleniumhq.github.io/selenium/docs/api/py/webdriver_chrome/selenium.webdriver.chrome.options.html#selenium.webdriver.chrome.options.Options\">Chrome options</a> method:</p>\n<table border=\"1\">\n<tr>\n<td><a href=\"#Open%20Browser\" class=\"name\">Open Browser</a></td>\n<td><a href=\"http://example.com\">http://example.com</a></td>\n<td>Chrome</td>\n<td>options=add_argument(\"--disable-popup-blocking\"); add_argument(\"--ignore-certificate-errors\")</td>\n<td># Sting format.</td>\n</tr>\n<tr>\n<td>${options} =</td>\n<td>Get Options</td>\n<td></td>\n<td></td>\n<td># Selenium options instance.</td>\n</tr>\n<tr>\n<td><a href=\"#Open%20Browser\" class=\"name\">Open Browser</a></td>\n<td><a href=\"http://example.com\">http://example.com</a></td>\n<td>Chrome</td>\n<td>options=${options}</td>\n<td></td>\n</tr>\n<tr>\n<td><a href=\"#Open%20Browser\" class=\"name\">Open Browser</a></td>\n<td>None</td>\n<td>Chrome</td>\n<td>options=binary_location=\"/path/to/binary\";add_argument(\"remote-debugging-port=port\")</td>\n<td># Start Chomium-based application.</td>\n</tr>\n<tr>\n<td><a href=\"#Open%20Browser\" class=\"name\">Open Browser</a></td>\n<td>None</td>\n<td>Chrome</td>\n<td>options=binary_location=r\"C:\\\\path\\\\to\\\\binary\"</td>\n<td># Windows OS path escaping.</td>\n</tr>\n</table>\n<p>Example for FirefoxProfile</p>\n<table border=\"1\">\n<tr>\n<td><a href=\"#Open%20Browser\" class=\"name\">Open Browser</a></td>\n<td><a href=\"http://example.com\">http://example.com</a></td>\n<td>Firefox</td>\n<td>ff_profile_dir=/path/to/profile</td>\n<td># Using profile from disk.</td>\n</tr>\n<tr>\n<td><a href=\"#Open%20Browser\" class=\"name\">Open Browser</a></td>\n<td><a href=\"http://example.com\">http://example.com</a></td>\n<td>Firefox</td>\n<td>ff_profile_dir=${FirefoxProfile_instance}</td>\n<td># Using instance of FirefoxProfile.</td>\n</tr>\n<tr>\n<td><a href=\"#Open%20Browser\" class=\"name\">Open Browser</a></td>\n<td><a href=\"http://example.com\">http://example.com</a></td>\n<td>Firefox</td>\n<td>ff_profile_dir=set_preference(\"key\", \"value\");set_preference(\"other\", \"setting\")</td>\n<td># Defining profile using FirefoxProfile mehtods.</td>\n</tr>\n</table>\n<p>If the provided configuration options are not enough, it is possible to use <a href=\"#Create%20Webdriver\" class=\"name\">Create Webdriver</a> to customize browser initialization even more.</p>\n<p>Applying <code>desired_capabilities</code> argument also for local browser is new in SeleniumLibrary 3.1.</p>\n<p>Using <code>alias</code> to decide, is the new browser opened is new in SeleniumLibrary 4.0. The <code>options</code> and <code>service_log_path</code> are new in SeleniumLibrary 4.0. Support for <code>ff_profile_dir</code> accepting an instance of the <span class=\"name\">selenium.webdriver.FirefoxProfile</span> and support defining FirefoxProfile with methods and attributes are new in SeleniumLibrary 4.0.</p>\n<p>Making <code>url</code> optional is new in SeleniumLibrary 4.1.</p>\n<p>The <code>executable_path</code> argument is new in SeleniumLibrary 4.2.</p>", "shortdoc": "Opens a new browser instance to the optional ``url``.", "tags": [], "source": "C:\\Python\\lib\\site-packages\\SeleniumLibrary\\keywords\\browsermanagement.py", "lineno": 60}, {"name": "Open Context Menu", "args": [{"name": "locator", "types": ["WebElement", "str"], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "locator: WebElement | str"}], "doc": "<p>Opens the context menu on the element identified by <code>locator</code>.</p>", "shortdoc": "Opens the context menu on the element identified by ``locator``.", "tags": [], "source": "C:\\Python\\lib\\site-packages\\SeleniumLibrary\\keywords\\element.py", "lineno": 862}, {"name": "Page Should Contain", "args": [{"name": "text", "types": ["str"], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "text: str"}, {"name": "loglevel", "types": ["str"], "defaultValue": "TRACE", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "loglevel: str = TRACE"}], "doc": "<p>Verifies that current page contains <code>text</code>.</p>\n<p>If this keyword fails, it automatically logs the page source using the log level specified with the optional <code>loglevel</code> argument. Valid log levels are <code>DEBUG</code>, <code>INFO</code> (default), <code>WARN</code>, and <code>NONE</code>. If the log level is <code>NONE</code> or below the current active log level the source will not be logged.</p>", "shortdoc": "Verifies that current page contains ``text``.", "tags": [], "source": "C:\\Python\\lib\\site-packages\\SeleniumLibrary\\keywords\\element.py", "lineno": 128}, {"name": "Page Should Contain Button", "args": [{"name": "locator", "types": ["WebElement", "str"], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "locator: WebElement | str"}, {"name": "message", "types": ["str"], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "message: str = None"}, {"name": "loglevel", "types": ["str"], "defaultValue": "TRACE", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "loglevel: str = TRACE"}], "doc": "<p>Verifies button <code>locator</code> is found from current page.</p>\n<p>See <a href=\"#Page%20Should%20Contain%20Element\" class=\"name\">Page Should Contain Element</a> for an explanation about <code>message</code> and <code>loglevel</code> arguments.</p>\n<p>See the <span class=\"name\">Locating elements</span> section for details about the locator syntax. When using the default locator strategy, buttons are searched using <code>id</code>, <code>name</code>, and <code>value</code>.</p>", "shortdoc": "Verifies button ``locator`` is found from current page.", "tags": [], "source": "C:\\Python\\lib\\site-packages\\SeleniumLibrary\\keywords\\formelement.py", "lineno": 430}, {"name": "Page Should Contain Checkbox", "args": [{"name": "locator", "types": ["WebElement", "str"], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "locator: WebElement | str"}, {"name": "message", "types": ["str"], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "message: str = None"}, {"name": "loglevel", "types": ["str"], "defaultValue": "TRACE", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "loglevel: str = TRACE"}], "doc": "<p>Verifies checkbox <code>locator</code> is found from the current page.</p>\n<p>See <a href=\"#Page%20Should%20Contain%20Element\" class=\"name\">Page Should Contain Element</a> for an explanation about <code>message</code> and <code>loglevel</code> arguments.</p>\n<p>See the <span class=\"name\">Locating elements</span> section for details about the locator syntax.</p>", "shortdoc": "Verifies checkbox ``locator`` is found from the current page.", "tags": [], "source": "C:\\Python\\lib\\site-packages\\SeleniumLibrary\\keywords\\formelement.py", "lineno": 70}, {"name": "Page Should Contain Element", "args": [{"name": "locator", "types": ["WebElement", "str"], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "locator: WebElement | str"}, {"name": "message", "types": ["str"], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "message: str = None"}, {"name": "loglevel", "types": ["str"], "defaultValue": "TRACE", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "loglevel: str = TRACE"}, {"name": "limit", "types": ["int"], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "limit: int = None"}], "doc": "<p>Verifies that element <code>locator</code> is found on the current page.</p>\n<p>See the <span class=\"name\">Locating elements</span> section for details about the locator syntax.</p>\n<p>The <code>message</code> argument can be used to override the default error message.</p>\n<p>The <code>limit</code> argument can used to define how many elements the page should contain. When <code>limit</code> is <code>None</code> (default) page can contain one or more elements. When limit is a number, page must contain same number of elements.</p>\n<p>See <a href=\"#Page%20Should%20Contain\" class=\"name\">Page Should Contain</a> for an explanation about the <code>loglevel</code> argument.</p>\n<p>Examples assumes that locator matches to two elements.</p>\n<table border=\"1\">\n<tr>\n<td><a href=\"#Page%20Should%20Contain%20Element\" class=\"name\">Page Should Contain Element</a></td>\n<td>div_name</td>\n<td>limit=1</td>\n<td># Keyword fails.</td>\n</tr>\n<tr>\n<td><a href=\"#Page%20Should%20Contain%20Element\" class=\"name\">Page Should Contain Element</a></td>\n<td>div_name</td>\n<td>limit=2</td>\n<td># Keyword passes.</td>\n</tr>\n<tr>\n<td><a href=\"#Page%20Should%20Contain%20Element\" class=\"name\">Page Should Contain Element</a></td>\n<td>div_name</td>\n<td>limit=none</td>\n<td># None is considered one or more.</td>\n</tr>\n<tr>\n<td><a href=\"#Page%20Should%20Contain%20Element\" class=\"name\">Page Should Contain Element</a></td>\n<td>div_name</td>\n<td></td>\n<td># Same as above.</td>\n</tr>\n</table>\n<p>The <code>limit</code> argument is new in SeleniumLibrary 3.0.</p>", "shortdoc": "Verifies that element ``locator`` is found on the current page.", "tags": [], "source": "C:\\Python\\lib\\site-packages\\SeleniumLibrary\\keywords\\element.py", "lineno": 145}, {"name": "Page Should Contain Image", "args": [{"name": "locator", "types": ["WebElement", "str"], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "locator: WebElement | str"}, {"name": "message", "types": ["str"], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "message: str = None"}, {"name": "loglevel", "types": ["str"], "defaultValue": "TRACE", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "loglevel: str = TRACE"}], "doc": "<p>Verifies image identified by <code>locator</code> is found from current page.</p>\n<p>See the <span class=\"name\">Locating elements</span> section for details about the locator syntax. When using the default locator strategy, images are searched using <code>id</code>, <code>name</code>, <code>src</code> and <code>alt</code>.</p>\n<p>See <a href=\"#Page%20Should%20Contain%20Element\" class=\"name\">Page Should Contain Element</a> for an explanation about <code>message</code> and <code>loglevel</code> arguments.</p>", "shortdoc": "Verifies image identified by ``locator`` is found from current page.", "tags": [], "source": "C:\\Python\\lib\\site-packages\\SeleniumLibrary\\keywords\\element.py", "lineno": 1066}, {"name": "Page Should Contain Link", "args": [{"name": "locator", "types": ["WebElement", "str"], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "locator: WebElement | str"}, {"name": "message", "types": ["str"], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "message: str = None"}, {"name": "loglevel", "types": ["str"], "defaultValue": "TRACE", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "loglevel: str = TRACE"}], "doc": "<p>Verifies link identified by <code>locator</code> is found from current page.</p>\n<p>See the <span class=\"name\">Locating elements</span> section for details about the locator syntax. When using the default locator strategy, links are searched using <code>id</code>, <code>name</code>, <code>href</code> and the link text.</p>\n<p>See <a href=\"#Page%20Should%20Contain%20Element\" class=\"name\">Page Should Contain Element</a> for an explanation about <code>message</code> and <code>loglevel</code> arguments.</p>", "shortdoc": "Verifies link identified by ``locator`` is found from current page.", "tags": [], "source": "C:\\Python\\lib\\site-packages\\SeleniumLibrary\\keywords\\element.py", "lineno": 1016}, {"name": "Page Should Contain List", "args": [{"name": "locator", "types": ["WebElement", "str"], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "locator: WebElement | str"}, {"name": "message", "types": ["str"], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "message: str = None"}, {"name": "loglevel", "types": ["str"], "defaultValue": "TRACE", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "loglevel: str = TRACE"}], "doc": "<p>Verifies selection list <code>locator</code> is found from current page.</p>\n<p>See <a href=\"#Page%20Should%20Contain%20Element\" class=\"name\">Page Should Contain Element</a> for an explanation about <code>message</code> and <code>loglevel</code> arguments.</p>\n<p>See the <span class=\"name\">Locating elements</span> section for details about the locator syntax.</p>", "shortdoc": "Verifies selection list ``locator`` is found from current page.", "tags": [], "source": "C:\\Python\\lib\\site-packages\\SeleniumLibrary\\keywords\\selectelement.py", "lineno": 159}, {"name": "Page Should Contain Radio Button", "args": [{"name": "locator", "types": ["WebElement", "str"], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "locator: WebElement | str"}, {"name": "message", "types": ["str"], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "message: str = None"}, {"name": "loglevel", "types": ["str"], "defaultValue": "TRACE", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "loglevel: str = TRACE"}], "doc": "<p>Verifies radio button <code>locator</code> is found from current page.</p>\n<p>See <a href=\"#Page%20Should%20Contain%20Element\" class=\"name\">Page Should Contain Element</a> for an explanation about <code>message</code> and <code>loglevel</code> arguments.</p>\n<p>See the <span class=\"name\">Locating elements</span> section for details about the locator syntax. When using the default locator strategy, radio buttons are searched using <code>id</code>, <code>name</code> and <code>value</code>.</p>", "shortdoc": "Verifies radio button ``locator`` is found from current page.", "tags": [], "source": "C:\\Python\\lib\\site-packages\\SeleniumLibrary\\keywords\\formelement.py", "lineno": 132}, {"name": "Page Should Contain Textfield", "args": [{"name": "locator", "types": ["WebElement", "str"], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "locator: WebElement | str"}, {"name": "message", "types": ["str"], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "message: str = None"}, {"name": "loglevel", "types": ["str"], "defaultValue": "TRACE", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "loglevel: str = TRACE"}], "doc": "<p>Verifies text field <code>locator</code> is found from current page.</p>\n<p>See <a href=\"#Page%20Should%20Contain%20Element\" class=\"name\">Page Should Contain Element</a> for an explanation about <code>message</code> and <code>loglevel</code> arguments.</p>\n<p>See the <span class=\"name\">Locating elements</span> section for details about the locator syntax.</p>", "shortdoc": "Verifies text field ``locator`` is found from current page.", "tags": [], "source": "C:\\Python\\lib\\site-packages\\SeleniumLibrary\\keywords\\formelement.py", "lineno": 300}, {"name": "Page Should Not Contain", "args": [{"name": "text", "types": ["str"], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "text: str"}, {"name": "loglevel", "types": ["str"], "defaultValue": "TRACE", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "loglevel: str = TRACE"}], "doc": "<p>Verifies the current page does not contain <code>text</code>.</p>\n<p>See <a href=\"#Page%20Should%20Contain\" class=\"name\">Page Should Contain</a> for an explanation about the <code>loglevel</code> argument.</p>", "shortdoc": "Verifies the current page does not contain ``text``.", "tags": [], "source": "C:\\Python\\lib\\site-packages\\SeleniumLibrary\\keywords\\element.py", "lineno": 193}, {"name": "Page Should Not Contain Button", "args": [{"name": "locator", "types": ["WebElement", "str"], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "locator: WebElement | str"}, {"name": "message", "types": ["str"], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "message: str = None"}, {"name": "loglevel", "types": ["str"], "defaultValue": "TRACE", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "loglevel: str = TRACE"}], "doc": "<p>Verifies button <code>locator</code> is not found from current page.</p>\n<p>See <a href=\"#Page%20Should%20Contain%20Element\" class=\"name\">Page Should Contain Element</a> for an explanation about <code>message</code> and <code>loglevel</code> arguments.</p>\n<p>See the <span class=\"name\">Locating elements</span> section for details about the locator syntax. When using the default locator strategy, buttons are searched using <code>id</code>, <code>name</code>, and <code>value</code>.</p>", "shortdoc": "Verifies button ``locator`` is not found from current page.", "tags": [], "source": "C:\\Python\\lib\\site-packages\\SeleniumLibrary\\keywords\\formelement.py", "lineno": 451}, {"name": "Page Should Not Contain Checkbox", "args": [{"name": "locator", "types": ["WebElement", "str"], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "locator: WebElement | str"}, {"name": "message", "types": ["str"], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "message: str = None"}, {"name": "loglevel", "types": ["str"], "defaultValue": "TRACE", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "loglevel: str = TRACE"}], "doc": "<p>Verifies checkbox <code>locator</code> is not found from the current page.</p>\n<p>See <a href=\"#Page%20Should%20Contain%20Element\" class=\"name\">Page Should Contain Element</a> for an explanation about <code>message</code> and <code>loglevel</code> arguments.</p>\n<p>See the <span class=\"name\">Locating elements</span> section for details about the locator syntax.</p>", "shortdoc": "Verifies checkbox ``locator`` is not found from the current page.", "tags": [], "source": "C:\\Python\\lib\\site-packages\\SeleniumLibrary\\keywords\\formelement.py", "lineno": 87}, {"name": "Page Should Not Contain Element", "args": [{"name": "locator", "types": ["WebElement", "str"], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "locator: WebElement | str"}, {"name": "message", "types": ["str"], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "message: str = None"}, {"name": "loglevel", "types": ["str"], "defaultValue": "TRACE", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "loglevel: str = TRACE"}], "doc": "<p>Verifies that element <code>locator</code> is not found on the current page.</p>\n<p>See the <span class=\"name\">Locating elements</span> section for details about the locator syntax.</p>\n<p>See <a href=\"#Page%20Should%20Contain\" class=\"name\">Page Should Contain</a> for an explanation about <code>message</code> and <code>loglevel</code> arguments.</p>", "shortdoc": "Verifies that element ``locator`` is not found on the current page.", "tags": [], "source": "C:\\Python\\lib\\site-packages\\SeleniumLibrary\\keywords\\element.py", "lineno": 205}, {"name": "Page Should Not Contain Image", "args": [{"name": "locator", "types": ["WebElement", "str"], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "locator: WebElement | str"}, {"name": "message", "types": ["str"], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "message: str = None"}, {"name": "loglevel", "types": ["str"], "defaultValue": "TRACE", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "loglevel: str = TRACE"}], "doc": "<p>Verifies image identified by <code>locator</code> is not found from current page.</p>\n<p>See the <span class=\"name\">Locating elements</span> section for details about the locator syntax. When using the default locator strategy, images are searched using <code>id</code>, <code>name</code>, <code>src</code> and <code>alt</code>.</p>\n<p>See <a href=\"#Page%20Should%20Contain%20Element\" class=\"name\">Page Should Contain Element</a> for an explanation about <code>message</code> and <code>loglevel</code> arguments.</p>", "shortdoc": "Verifies image identified by ``locator`` is not found from current page.", "tags": [], "source": "C:\\Python\\lib\\site-packages\\SeleniumLibrary\\keywords\\element.py", "lineno": 1084}, {"name": "Page Should Not Contain Link", "args": [{"name": "locator", "types": ["WebElement", "str"], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "locator: WebElement | str"}, {"name": "message", "types": ["str"], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "message: str = None"}, {"name": "loglevel", "types": ["str"], "defaultValue": "TRACE", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "loglevel: str = TRACE"}], "doc": "<p>Verifies link identified by <code>locator</code> is not found from current page.</p>\n<p>See the <span class=\"name\">Locating elements</span> section for details about the locator syntax. When using the default locator strategy, links are searched using <code>id</code>, <code>name</code>, <code>href</code> and the link text.</p>\n<p>See <a href=\"#Page%20Should%20Contain%20Element\" class=\"name\">Page Should Contain Element</a> for an explanation about <code>message</code> and <code>loglevel</code> arguments.</p>", "shortdoc": "Verifies link identified by ``locator`` is not found from current page.", "tags": [], "source": "C:\\Python\\lib\\site-packages\\SeleniumLibrary\\keywords\\element.py", "lineno": 1034}, {"name": "Page Should Not Contain List", "args": [{"name": "locator", "types": ["WebElement", "str"], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "locator: WebElement | str"}, {"name": "message", "types": ["str"], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "message: str = None"}, {"name": "loglevel", "types": ["str"], "defaultValue": "TRACE", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "loglevel: str = TRACE"}], "doc": "<p>Verifies selection list <code>locator</code> is not found from current page.</p>\n<p>See <a href=\"#Page%20Should%20Contain%20Element\" class=\"name\">Page Should Contain Element</a> for an explanation about <code>message</code> and <code>loglevel</code> arguments.</p>\n<p>See the <span class=\"name\">Locating elements</span> section for details about the locator syntax.</p>", "shortdoc": "Verifies selection list ``locator`` is not found from current page.", "tags": [], "source": "C:\\Python\\lib\\site-packages\\SeleniumLibrary\\keywords\\selectelement.py", "lineno": 176}, {"name": "Page Should Not Contain Radio Button", "args": [{"name": "locator", "types": ["WebElement", "str"], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "locator: WebElement | str"}, {"name": "message", "types": ["str"], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "message: str = None"}, {"name": "loglevel", "types": ["str"], "defaultValue": "TRACE", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "loglevel: str = TRACE"}], "doc": "<p>Verifies radio button <code>locator</code> is not found from current page.</p>\n<p>See <a href=\"#Page%20Should%20Contain%20Element\" class=\"name\">Page Should Contain Element</a> for an explanation about <code>message</code> and <code>loglevel</code> arguments.</p>\n<p>See the <span class=\"name\">Locating elements</span> section for details about the locator syntax. When using the default locator strategy, radio buttons are searched using <code>id</code>, <code>name</code> and <code>value</code>.</p>", "shortdoc": "Verifies radio button ``locator`` is not found from current page.", "tags": [], "source": "C:\\Python\\lib\\site-packages\\SeleniumLibrary\\keywords\\formelement.py", "lineno": 150}, {"name": "Page Should Not Contain Textfield", "args": [{"name": "locator", "types": ["WebElement", "str"], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "locator: WebElement | str"}, {"name": "message", "types": ["str"], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "message: str = None"}, {"name": "loglevel", "types": ["str"], "defaultValue": "TRACE", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "loglevel: str = TRACE"}], "doc": "<p>Verifies text field <code>locator</code> is not found from current page.</p>\n<p>See <a href=\"#Page%20Should%20Contain%20Element\" class=\"name\">Page Should Contain Element</a> for an explanation about <code>message</code> and <code>loglevel</code> arguments.</p>\n<p>See the <span class=\"name\">Locating elements</span> section for details about the locator syntax.</p>", "shortdoc": "Verifies text field ``locator`` is not found from current page.", "tags": [], "source": "C:\\Python\\lib\\site-packages\\SeleniumLibrary\\keywords\\formelement.py", "lineno": 317}, {"name": "Press Key", "args": [{"name": "locator", "types": ["WebElement", "str"], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "locator: WebElement | str"}, {"name": "key", "types": ["str"], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "key: str"}], "doc": "<p><b>DEPRECATED in SeleniumLibrary 4.0.</b> use <a href=\"#Press%20Keys\" class=\"name\">Press Keys</a> instead.</p>", "shortdoc": "*DEPRECATED in SeleniumLibrary 4.0.* use `Press Keys` instead.", "tags": [], "source": "C:\\Python\\lib\\site-packages\\SeleniumLibrary\\keywords\\element.py", "lineno": 896}, {"name": "Press Keys", "args": [{"name": "locator", "types": ["WebElement", "None", "str"], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "locator: WebElement | None | str = None"}, {"name": "keys", "types": ["str"], "defaultValue": null, "kind": "VAR_POSITIONAL", "required": false, "repr": "*keys: str"}], "doc": "<p>Simulates the user pressing key(s) to an element or on the active browser.</p>\n<p>If <code>locator</code> evaluates as false, see <span class=\"name\">Boolean arguments</span> for more details, then the <code>keys</code> are sent to the currently active browser. Otherwise element is searched and <code>keys</code> are send to the element identified by the <code>locator</code>. In later case, keyword fails if element is not found. See the <span class=\"name\">Locating elements</span> section for details about the locator syntax.</p>\n<p><code>keys</code> arguments can contain one or many strings, but it can not be empty. <code>keys</code> can also be a combination of <a href=\"https://seleniumhq.github.io/selenium/docs/api/py/webdriver/selenium.webdriver.common.keys.html\">Selenium Keys</a> and strings or a single Selenium Key. If Selenium Key is combined with strings, Selenium key and strings must be separated by the <span class=\"name\">+</span> character, like in <span class=\"name\">CONTROL+c</span>. Selenium Keys are space and case sensitive and Selenium Keys are not parsed inside of the string. Example AALTO, would send string <span class=\"name\">AALTO</span> and <span class=\"name\">ALT</span> not parsed inside of the string. But <span class=\"name\">A+ALT+O</span> would found Selenium ALT key from the <code>keys</code> argument. It also possible to press many Selenium Keys down at the same time, example 'ALT+ARROW_DOWN`.</p>\n<p>If Selenium Keys are detected in the <code>keys</code> argument, keyword will press the Selenium Key down, send the strings and then release the Selenium Key. If keyword needs to send a Selenium Key as a string, then each character must be separated with <span class=\"name\">+</span> character, example <span class=\"name\">E+N+D</span>.</p>\n<p><span class=\"name\">CTRL</span> is alias for <a href=\"https://seleniumhq.github.io/selenium/docs/api/py/webdriver/selenium.webdriver.common.keys.html#selenium.webdriver.common.keys.Keys.CONTROL\">Selenium CONTROL</a> and ESC is alias for <a href=\"https://seleniumhq.github.io/selenium/docs/api/py/webdriver/selenium.webdriver.common.keys.html#selenium.webdriver.common.keys.Keys.ESCAPE\">Selenium ESCAPE</a></p>\n<p>New in SeleniumLibrary 3.3</p>\n<p>Examples:</p>\n<table border=\"1\">\n<tr>\n<td><a href=\"#Press%20Keys\" class=\"name\">Press Keys</a></td>\n<td>text_field</td>\n<td>AAAAA</td>\n<td></td>\n<td># Sends string \"AAAAA\" to element.</td>\n</tr>\n<tr>\n<td><a href=\"#Press%20Keys\" class=\"name\">Press Keys</a></td>\n<td>None</td>\n<td>BBBBB</td>\n<td></td>\n<td># Sends string \"BBBBB\" to currently active browser.</td>\n</tr>\n<tr>\n<td><a href=\"#Press%20Keys\" class=\"name\">Press Keys</a></td>\n<td>text_field</td>\n<td>E+N+D</td>\n<td></td>\n<td># Sends string \"END\" to element.</td>\n</tr>\n<tr>\n<td><a href=\"#Press%20Keys\" class=\"name\">Press Keys</a></td>\n<td>text_field</td>\n<td>XXX</td>\n<td>YY</td>\n<td># Sends strings \"XXX\" and \"YY\" to element.</td>\n</tr>\n<tr>\n<td><a href=\"#Press%20Keys\" class=\"name\">Press Keys</a></td>\n<td>text_field</td>\n<td>XXX+YY</td>\n<td></td>\n<td># Same as above.</td>\n</tr>\n<tr>\n<td><a href=\"#Press%20Keys\" class=\"name\">Press Keys</a></td>\n<td>text_field</td>\n<td>ALT+ARROW_DOWN</td>\n<td></td>\n<td># Pressing \"ALT\" key down, then pressing ARROW_DOWN and then releasing both keys.</td>\n</tr>\n<tr>\n<td><a href=\"#Press%20Keys\" class=\"name\">Press Keys</a></td>\n<td>text_field</td>\n<td>ALT</td>\n<td>ARROW_DOWN</td>\n<td># Pressing \"ALT\" key and then pressing ARROW_DOWN.</td>\n</tr>\n<tr>\n<td><a href=\"#Press%20Keys\" class=\"name\">Press Keys</a></td>\n<td>text_field</td>\n<td>CTRL+c</td>\n<td></td>\n<td># Pressing CTRL key down, sends string \"c\" and then releases CTRL key.</td>\n</tr>\n<tr>\n<td><a href=\"#Press%20Keys\" class=\"name\">Press Keys</a></td>\n<td>button</td>\n<td>RETURN</td>\n<td></td>\n<td># Pressing \"ENTER\" key to element.</td>\n</tr>\n</table>", "shortdoc": "Simulates the user pressing key(s) to an element or on the active browser.", "tags": [], "source": "C:\\Python\\lib\\site-packages\\SeleniumLibrary\\keywords\\element.py", "lineno": 904}, {"name": "Radio Button Should Be Set To", "args": [{"name": "group_name", "types": ["str"], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "group_name: str"}, {"name": "value", "types": ["str"], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "value: str"}], "doc": "<p>Verifies radio button group <code>group_name</code> is set to <code>value</code>.</p>\n<p><code>group_name</code> is the <code>name</code> of the radio button group.</p>", "shortdoc": "Verifies radio button group ``group_name`` is set to ``value``.", "tags": [], "source": "C:\\Python\\lib\\site-packages\\SeleniumLibrary\\keywords\\formelement.py", "lineno": 168}, {"name": "Radio Button Should Not Be Selected", "args": [{"name": "group_name", "types": ["str"], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "group_name: str"}], "doc": "<p>Verifies radio button group <code>group_name</code> has no selection.</p>\n<p><code>group_name</code> is the <code>name</code> of the radio button group.</p>", "shortdoc": "Verifies radio button group ``group_name`` has no selection.", "tags": [], "source": "C:\\Python\\lib\\site-packages\\SeleniumLibrary\\keywords\\formelement.py", "lineno": 183}, {"name": "Register Keyword To Run On Failure", "args": [{"name": "keyword", "types": ["str", "None"], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "keyword: str | None"}], "doc": "<p>Sets the keyword to execute, when a SeleniumLibrary keyword fails.</p>\n<p><code>keyword</code> is the name of a keyword that will be executed if a SeleniumLibrary keyword fails. It is possible to use any available keyword, including user keywords or keywords from other libraries, but the keyword must not take any arguments.</p>\n<p>The initial keyword to use is set when <a href=\"#Importing\" class=\"name\">importing</a> the library, 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>It is possible to use string <code>NOTHING</code> or <code>NONE</code>, case-insensitively, as well as Python <code>None</code> to disable this feature altogether.</p>\n<p>This keyword returns the name of the previously registered failure keyword or Python <code>None</code> if this functionality was previously disabled. The return value can be always used to restore the original value later.</p>\n<p>Example:</p>\n<table border=\"1\">\n<tr>\n<td><a href=\"#Register%20Keyword%20To%20Run%20On%20Failure\" class=\"name\">Register Keyword To Run On Failure</a></td>\n<td>Log Source</td>\n<td></td>\n</tr>\n<tr>\n<td>${previous kw}=</td>\n<td><a href=\"#Register%20Keyword%20To%20Run%20On%20Failure\" class=\"name\">Register Keyword To Run On Failure</a></td>\n<td>NONE</td>\n</tr>\n<tr>\n<td><a href=\"#Register%20Keyword%20To%20Run%20On%20Failure\" class=\"name\">Register Keyword To Run On Failure</a></td>\n<td>${previous kw}</td>\n<td></td>\n</tr>\n</table>\n<p>Changes in SeleniumLibrary 3.0:</p>\n<ul>\n<li>Possible to use string <code>NONE</code> or Python <code>None</code> to disable the functionality.</li>\n<li>Return Python <code>None</code> when the functionality was disabled earlier. In previous versions special value <code>No Keyword</code> was returned and it could not be used to restore the original state.</li>\n</ul>", "shortdoc": "Sets the keyword to execute, when a SeleniumLibrary keyword fails.", "tags": [], "source": "C:\\Python\\lib\\site-packages\\SeleniumLibrary\\keywords\\runonfailure.py", "lineno": 23}, {"name": "Reload Page", "args": [], "doc": "<p>Simulates user reloading page.</p>", "shortdoc": "Simulates user reloading page.", "tags": [], "source": "C:\\Python\\lib\\site-packages\\SeleniumLibrary\\keywords\\browsermanagement.py", "lineno": 595}, {"name": "Remove Location Strategy", "args": [{"name": "strategy_name", "types": ["str"], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "strategy_name: str"}], "doc": "<p>Removes a previously added custom location strategy.</p>\n<p>See <span class=\"name\">Custom locators</span> for information on how to create and use custom strategies.</p>", "shortdoc": "Removes a previously added custom location strategy.", "tags": [], "source": "C:\\Python\\lib\\site-packages\\SeleniumLibrary\\keywords\\element.py", "lineno": 1135}, {"name": "Save Selenium Screenshot", "args": [], "doc": "<p>Takes a screenshot with a unique filename to be stored in Robot Framework compiled reports.</p>\n<p>If <a href=\"#Set%20Screenshot%20Directory\" class=\"name\">Set Screenshot Directory</a> has been set to <code>EMBED</code> then the screenshot will be embedded into the report</p>", "shortdoc": "Takes a screenshot with a unique filename to be stored in Robot Framework compiled reports.", "tags": [], "source": "C:\\Git\\robotframework-zoomba\\src\\Zoomba\\GUILibrary.py", "lineno": 357}, {"name": "Scroll Element Into View", "args": [{"name": "locator", "types": ["WebElement", "str"], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "locator: WebElement | str"}], "doc": "<p>Scrolls the element identified by <code>locator</code> into view.</p>\n<p>See the <span class=\"name\">Locating elements</span> section for details about the locator syntax.</p>\n<p>New in SeleniumLibrary 3.2.0</p>", "shortdoc": "Scrolls the element identified by ``locator`` into view.", "tags": [], "source": "C:\\Python\\lib\\site-packages\\SeleniumLibrary\\keywords\\element.py", "lineno": 739}, {"name": "Scroll To Bottom Of Page", "args": [], "doc": "<p>This keyword scrolls down to the bottom of the page, if jquery is not available it will scroll 20000 pixels</p>", "shortdoc": "This keyword scrolls down to the bottom of the page, if jquery is not available it will scroll 20000 pixels", "tags": [], "source": "C:\\Git\\robotframework-zoomba\\src\\Zoomba\\GUILibrary.py", "lineno": 248}, {"name": "Select All From List", "args": [{"name": "locator", "types": ["WebElement", "str"], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "locator: WebElement | str"}], "doc": "<p>Selects all options from multi-selection list <code>locator</code>.</p>\n<p>See the <span class=\"name\">Locating elements</span> section for details about the locator syntax.</p>", "shortdoc": "Selects all options from multi-selection list ``locator``.", "tags": [], "source": "C:\\Python\\lib\\site-packages\\SeleniumLibrary\\keywords\\selectelement.py", "lineno": 193}, {"name": "Select Checkbox", "args": [{"name": "locator", "types": ["WebElement", "str"], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "locator: WebElement | str"}], "doc": "<p>Selects the checkbox identified by <code>locator</code>.</p>\n<p>Does nothing if checkbox is already selected.</p>\n<p>See the <span class=\"name\">Locating elements</span> section for details about the locator syntax.</p>", "shortdoc": "Selects the checkbox identified by ``locator``.", "tags": [], "source": "C:\\Python\\lib\\site-packages\\SeleniumLibrary\\keywords\\formelement.py", "lineno": 104}, {"name": "Select Frame", "args": [{"name": "locator", "types": ["WebElement", "str"], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "locator: WebElement | str"}], "doc": "<p>Sets frame identified by <code>locator</code> as the current frame.</p>\n<p>See the <span class=\"name\">Locating elements</span> section for details about the locator syntax.</p>\n<p>Works both with frames and iframes. Use <a href=\"#Unselect%20Frame\" class=\"name\">Unselect Frame</a> to cancel the frame selection and return to the main frame.</p>\n<p>Example:</p>\n<table border=\"1\">\n<tr>\n<td><a href=\"#Select%20Frame\" class=\"name\">Select Frame</a></td>\n<td>top-frame</td>\n<td># Select frame with id or name 'top-frame'</td>\n</tr>\n<tr>\n<td><a href=\"#Click%20Link\" class=\"name\">Click Link</a></td>\n<td>example</td>\n<td># Click link 'example' in the selected frame</td>\n</tr>\n<tr>\n<td><a href=\"#Unselect%20Frame\" class=\"name\">Unselect Frame</a></td>\n<td></td>\n<td># Back to main frame.</td>\n</tr>\n<tr>\n<td><a href=\"#Select%20Frame\" class=\"name\">Select Frame</a></td>\n<td>//iframe[@name='xxx']</td>\n<td># Select frame using xpath</td>\n</tr>\n</table>", "shortdoc": "Sets frame identified by ``locator`` as the current frame.", "tags": [], "source": "C:\\Python\\lib\\site-packages\\SeleniumLibrary\\keywords\\frames.py", "lineno": 25}, {"name": "Select From List By Index", "args": [{"name": "locator", "types": ["WebElement", "str"], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "locator: WebElement | str"}, {"name": "indexes", "types": ["str"], "defaultValue": null, "kind": "VAR_POSITIONAL", "required": false, "repr": "*indexes: str"}], "doc": "<p>Selects options from selection list <code>locator</code> by <code>indexes</code>.</p>\n<p>Indexes of list options start from 0.</p>\n<p>If more than one option is given for a single-selection list, the last value will be selected. With multi-selection lists all specified options are selected, but possible old selections are not cleared.</p>\n<p>See the <span class=\"name\">Locating elements</span> section for details about the locator syntax.</p>", "shortdoc": "Selects options from selection list ``locator`` by ``indexes``.", "tags": [], "source": "C:\\Python\\lib\\site-packages\\SeleniumLibrary\\keywords\\selectelement.py", "lineno": 209}, {"name": "Select From List By Label", "args": [{"name": "locator", "types": ["WebElement", "str"], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "locator: WebElement | str"}, {"name": "labels", "types": ["str"], "defaultValue": null, "kind": "VAR_POSITIONAL", "required": false, "repr": "*labels: str"}], "doc": "<p>Selects options from selection list <code>locator</code> by <code>labels</code>.</p>\n<p>If more than one option is given for a single-selection list, the last value will be selected. With multi-selection lists all specified options are selected, but possible old selections are not cleared.</p>\n<p>See the <span class=\"name\">Locating elements</span> section for details about the locator syntax.</p>", "shortdoc": "Selects options from selection list ``locator`` by ``labels``.", "tags": [], "source": "C:\\Python\\lib\\site-packages\\SeleniumLibrary\\keywords\\selectelement.py", "lineno": 256}, {"name": "Select From List By Value", "args": [{"name": "locator", "types": ["WebElement", "str"], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "locator: WebElement | str"}, {"name": "values", "types": ["str"], "defaultValue": null, "kind": "VAR_POSITIONAL", "required": false, "repr": "*values: str"}], "doc": "<p>Selects options from selection list <code>locator</code> by <code>values</code>.</p>\n<p>If more than one option is given for a single-selection list, the last value will be selected. With multi-selection lists all specified options are selected, but possible old selections are not cleared.</p>\n<p>See the <span class=\"name\">Locating elements</span> section for details about the locator syntax.</p>", "shortdoc": "Selects options from selection list ``locator`` by ``values``.", "tags": [], "source": "C:\\Python\\lib\\site-packages\\SeleniumLibrary\\keywords\\selectelement.py", "lineno": 234}, {"name": "Select Nested Frame", "args": [{"name": "locators", "types": [], "defaultValue": null, "kind": "VAR_POSITIONAL", "required": false, "repr": "*locators"}], "doc": "<p>Selects a frame nested in other frames</p>\n<p>locators: (list) A list of selenium locators(CSS, XPATH, ID, NAME, etc)</p>\n<p>Example (Selects iframe3 after traversing iframe1 and iframe2):</p>\n<table border=\"1\">\n<tr>\n<td><a href=\"#Select%20Nested%20Frame\" class=\"name\">Select Nested Frame</a></td>\n<td>id-iframe1</td>\n<td>id=iframe2</td>\n<td>id=iframe3</td>\n</tr>\n</table>", "shortdoc": "Selects a frame nested in other frames", "tags": [], "source": "C:\\Git\\robotframework-zoomba\\src\\Zoomba\\GUILibrary.py", "lineno": 113}, {"name": "Select Radio Button", "args": [{"name": "group_name", "types": ["str"], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "group_name: str"}, {"name": "value", "types": ["str"], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "value: str"}], "doc": "<p>Sets the radio button group <code>group_name</code> to <code>value</code>.</p>\n<p>The radio button to be selected is located by two arguments:</p>\n<ul>\n<li><code>group_name</code> is the name of the radio button group.</li>\n<li><code>value</code> is the <code>id</code> or <code>value</code> attribute of the actual radio button.</li>\n</ul>\n<p>Examples:</p>\n<table border=\"1\">\n<tr>\n<td><a href=\"#Select%20Radio%20Button\" class=\"name\">Select Radio Button</a></td>\n<td>size</td>\n<td>XL</td>\n</tr>\n<tr>\n<td><a href=\"#Select%20Radio%20Button\" class=\"name\">Select Radio Button</a></td>\n<td>contact</td>\n<td>email</td>\n</tr>\n</table>", "shortdoc": "Sets the radio button group ``group_name`` to ``value``.", "tags": [], "source": "C:\\Python\\lib\\site-packages\\SeleniumLibrary\\keywords\\formelement.py", "lineno": 198}, {"name": "Set Browser Implicit Wait", "args": [{"name": "value", "types": ["timedelta"], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "value: timedelta"}], "doc": "<p>Sets the implicit wait value used by Selenium.</p>\n<p>Same as <a href=\"#Set%20Selenium%20Implicit%20Wait\" class=\"name\">Set Selenium Implicit Wait</a> but only affects the current browser.</p>", "shortdoc": "Sets the implicit wait value used by Selenium.", "tags": [], "source": "C:\\Python\\lib\\site-packages\\SeleniumLibrary\\keywords\\browsermanagement.py", "lineno": 698}, {"name": "Set Focus To Element", "args": [{"name": "locator", "types": ["WebElement", "str"], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "locator: WebElement | str"}], "doc": "<p>Sets the focus to the element identified by <code>locator</code>.</p>\n<p>See the <span class=\"name\">Locating elements</span> section for details about the locator syntax.</p>\n<p>Prior to SeleniumLibrary 3.0 this keyword was named <span class=\"name\">Focus</span>.</p>", "shortdoc": "Sets the focus to the element identified by ``locator``.", "tags": [], "source": "C:\\Python\\lib\\site-packages\\SeleniumLibrary\\keywords\\element.py", "lineno": 727}, {"name": "Set Screenshot Directory", "args": [{"name": "path", "types": ["None", "str"], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "path: None | str"}], "doc": "<p>Sets the directory for captured screenshots.</p>\n<p><code>path</code> argument specifies the absolute path to a directory where the screenshots should be written to. If the directory does not exist, it will be created. The directory can also be set when <a href=\"#Importing\" class=\"name\">importing</a> the library. If it is not configured anywhere, screenshots are saved to the same directory where Robot Framework's log file is written.</p>\n<p>If <code>path</code> equals to EMBED (case insensitive) and <a href=\"#Capture%20Page%20Screenshot\" class=\"name\">Capture Page Screenshot</a> or <a href=\"#Capture%20Element%20Screenshot\" class=\"name\">capture Element Screenshot</a> keywords filename argument is not changed from the default value, then the page or element screenshot is embedded as Base64 image to the log.html.</p>\n<p>The previous value is returned and can be used to restore the original value later if needed.</p>\n<p>Returning the previous value is new in SeleniumLibrary 3.0. The persist argument was removed in SeleniumLibrary 3.2 and EMBED is new in SeleniumLibrary 4.2.</p>", "shortdoc": "Sets the directory for captured screenshots.", "tags": [], "source": "C:\\Python\\lib\\site-packages\\SeleniumLibrary\\keywords\\screenshot.py", "lineno": 32}, {"name": "Set Selenium Implicit Wait", "args": [{"name": "value", "types": ["timedelta"], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "value: timedelta"}], "doc": "<p>Sets the implicit wait value used by Selenium.</p>\n<p>The value can be given as a number that is considered to be seconds or as a human-readable string like <code>1 second</code>. The previous value is returned and can be used to restore the original value later if needed.</p>\n<p>This keyword sets the implicit wait for all opened browsers. Use <a href=\"#Set%20Browser%20Implicit%20Wait\" class=\"name\">Set Browser Implicit Wait</a> to set it only to the current browser.</p>\n<p>See the <span class=\"name\">Implicit wait</span> section above for more information.</p>\n<p>Example:</p>\n<table border=\"1\">\n<tr>\n<td>${orig wait} =</td>\n<td><a href=\"#Set%20Selenium%20Implicit%20Wait\" class=\"name\">Set Selenium Implicit Wait</a></td>\n<td>10 seconds</td>\n</tr>\n<tr>\n<td><span class=\"name\">Perform AJAX call that is slow</span></td>\n<td></td>\n<td></td>\n</tr>\n<tr>\n<td><a href=\"#Set%20Selenium%20Implicit%20Wait\" class=\"name\">Set Selenium Implicit Wait</a></td>\n<td>${orig wait}</td>\n<td></td>\n</tr>\n</table>", "shortdoc": "Sets the implicit wait value used by Selenium.", "tags": [], "source": "C:\\Python\\lib\\site-packages\\SeleniumLibrary\\keywords\\browsermanagement.py", "lineno": 672}, {"name": "Set Selenium Speed", "args": [{"name": "value", "types": ["timedelta"], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "value: timedelta"}], "doc": "<p>Sets the delay that is waited after each Selenium command.</p>\n<p>The value can be given as a number that is considered to be seconds or as a human-readable string like <code>1 second</code>. The previous value is returned and can be used to restore the original value later if needed.</p>\n<p>See the <span class=\"name\">Selenium Speed</span> section above for more information.</p>\n<p>Example:</p>\n<table border=\"1\">\n<tr>\n<td><a href=\"#Set%20Selenium%20Speed\" class=\"name\">Set Selenium Speed</a></td>\n<td>0.5 seconds</td>\n</tr>\n</table>", "shortdoc": "Sets the delay that is waited after each Selenium command.", "tags": [], "source": "C:\\Python\\lib\\site-packages\\SeleniumLibrary\\keywords\\browsermanagement.py", "lineno": 630}, {"name": "Set Selenium Timeout", "args": [{"name": "value", "types": ["timedelta"], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "value: timedelta"}], "doc": "<p>Sets the timeout that is used by various keywords.</p>\n<p>The value can be given as a number that is considered to be seconds or as a human-readable string like <code>1 second</code>. The previous value is returned and can be used to restore the original value later if needed.</p>\n<p>See the <span class=\"name\">Timeout</span> section above for more information.</p>\n<p>Example:</p>\n<table border=\"1\">\n<tr>\n<td>${orig timeout} =</td>\n<td><a href=\"#Set%20Selenium%20Timeout\" class=\"name\">Set Selenium Timeout</a></td>\n<td>15 seconds</td>\n</tr>\n<tr>\n<td><span class=\"name\">Open page that loads slowly</span></td>\n<td></td>\n<td></td>\n</tr>\n<tr>\n<td><a href=\"#Set%20Selenium%20Timeout\" class=\"name\">Set Selenium Timeout</a></td>\n<td>${orig timeout}</td>\n<td></td>\n</tr>\n</table>", "shortdoc": "Sets the timeout that is used by various keywords.", "tags": [], "source": "C:\\Python\\lib\\site-packages\\SeleniumLibrary\\keywords\\browsermanagement.py", "lineno": 650}, {"name": "Set Window Position", "args": [{"name": "x", "types": ["int"], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "x: int"}, {"name": "y", "types": ["int"], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "y: int"}], "doc": "<p>Sets window position using <code>x</code> and <code>y</code> coordinates.</p>\n<p>The position is relative to the top left corner of the screen, but some browsers exclude possible task bar set by the operating system from the calculation. The actual position may thus be different with different browsers.</p>\n<p>Values can be given using strings containing numbers or by using actual numbers. See also <a href=\"#Get%20Window%20Position\" class=\"name\">Get Window Position</a>.</p>\n<p>Example:</p>\n<table border=\"1\">\n<tr>\n<td><a href=\"#Set%20Window%20Position\" class=\"name\">Set Window Position</a></td>\n<td>100</td>\n<td>200</td>\n</tr>\n</table>", "shortdoc": "Sets window position using ``x`` and ``y`` coordinates.", "tags": [], "source": "C:\\Python\\lib\\site-packages\\SeleniumLibrary\\keywords\\window.py", "lineno": 269}, {"name": "Set Window Size", "args": [{"name": "width", "types": ["int"], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "width: int"}, {"name": "height", "types": ["int"], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "height: int"}, {"name": "inner", "types": ["bool"], "defaultValue": "False", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "inner: bool = False"}], "doc": "<p>Sets current windows size to given <code>width</code> and <code>height</code>.</p>\n<p>Values can be given using strings containing numbers or by using actual numbers. See also <a href=\"#Get%20Window%20Size\" class=\"name\">Get Window Size</a>.</p>\n<p>Browsers have a limit on their minimum size. Trying to set them smaller will cause the actual size to be bigger than the requested size.</p>\n<p>If <code>inner</code> parameter is set to True, keyword sets the necessary window width and height to have the desired HTML DOM <i>window.innerWidth</i> and <i>window.innerHeight</i>. See <span class=\"name\">Boolean arguments</span> for more details on how to set boolean arguments.</p>\n<p>The <code>inner</code> argument is new since SeleniumLibrary 4.0.</p>\n<p>This <code>inner</code> argument does not support Frames. If a frame is selected, switch to default before running this.</p>\n<p>Example:</p>\n<table border=\"1\">\n<tr>\n<td><a href=\"#Set%20Window%20Size\" class=\"name\">Set Window Size</a></td>\n<td>800</td>\n<td>600</td>\n<td></td>\n</tr>\n<tr>\n<td><a href=\"#Set%20Window%20Size\" class=\"name\">Set Window Size</a></td>\n<td>800</td>\n<td>600</td>\n<td>True</td>\n</tr>\n</table>", "shortdoc": "Sets current windows size to given ``width`` and ``height``.", "tags": [], "source": "C:\\Python\\lib\\site-packages\\SeleniumLibrary\\keywords\\window.py", "lineno": 212}, {"name": "Simulate Event", "args": [{"name": "locator", "types": ["WebElement", "str"], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "locator: WebElement | str"}, {"name": "event", "types": ["str"], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "event: str"}], "doc": "<p>Simulates <code>event</code> on the element identified by <code>locator</code>.</p>\n<p>This keyword is useful if element has <code>OnEvent</code> handler that needs to be explicitly invoked.</p>\n<p>See the <span class=\"name\">Locating elements</span> section for details about the locator syntax.</p>\n<p>Prior to SeleniumLibrary 3.0 this keyword was named <span class=\"name\">Simulate</span>.</p>", "shortdoc": "Simulates ``event`` on the element identified by ``locator``.", "tags": [], "source": "C:\\Python\\lib\\site-packages\\SeleniumLibrary\\keywords\\element.py", "lineno": 871}, {"name": "Submit Form", "args": [{"name": "locator", "types": ["WebElement", "None", "str"], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "locator: WebElement | None | str = None"}], "doc": "<p>Submits a form identified by <code>locator</code>.</p>\n<p>If <code>locator</code> is not given, first form on the page is submitted.</p>\n<p>See the <span class=\"name\">Locating elements</span> section for details about the locator syntax.</p>", "shortdoc": "Submits a form identified by ``locator``.", "tags": [], "source": "C:\\Python\\lib\\site-packages\\SeleniumLibrary\\keywords\\formelement.py", "lineno": 29}, {"name": "Switch Browser", "args": [{"name": "index_or_alias", "types": ["str"], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "index_or_alias: str"}], "doc": "<p>Switches between active browsers using <code>index_or_alias</code>.</p>\n<p>Indices are returned by the <a href=\"#Open%20Browser\" class=\"name\">Open Browser</a> keyword and aliases can be given to it explicitly. Indices start from 1.</p>\n<p>Example:</p>\n<table border=\"1\">\n<tr>\n<td><a href=\"#Open%20Browser\" class=\"name\">Open Browser</a></td>\n<td><a href=\"http://google.com\">http://google.com</a></td>\n<td>ff</td>\n<td></td>\n</tr>\n<tr>\n<td><a href=\"#Location%20Should%20Be\" class=\"name\">Location Should Be</a></td>\n<td><a href=\"http://google.com\">http://google.com</a></td>\n<td></td>\n<td></td>\n</tr>\n<tr>\n<td><a href=\"#Open%20Browser\" class=\"name\">Open Browser</a></td>\n<td><a href=\"http://yahoo.com\">http://yahoo.com</a></td>\n<td>ie</td>\n<td>alias=second</td>\n</tr>\n<tr>\n<td><a href=\"#Location%20Should%20Be\" class=\"name\">Location Should Be</a></td>\n<td><a href=\"http://yahoo.com\">http://yahoo.com</a></td>\n<td></td>\n<td></td>\n</tr>\n<tr>\n<td><a href=\"#Switch%20Browser\" class=\"name\">Switch Browser</a></td>\n<td>1</td>\n<td># index</td>\n<td></td>\n</tr>\n<tr>\n<td><a href=\"#Page%20Should%20Contain\" class=\"name\">Page Should Contain</a></td>\n<td>I'm feeling lucky</td>\n<td></td>\n<td></td>\n</tr>\n<tr>\n<td><a href=\"#Switch%20Browser\" class=\"name\">Switch Browser</a></td>\n<td>second</td>\n<td># alias</td>\n<td></td>\n</tr>\n<tr>\n<td><a href=\"#Page%20Should%20Contain\" class=\"name\">Page Should Contain</a></td>\n<td>More Yahoo!</td>\n<td></td>\n<td></td>\n</tr>\n<tr>\n<td><a href=\"#Close%20All%20Browsers\" class=\"name\">Close All Browsers</a></td>\n<td></td>\n<td></td>\n<td></td>\n</tr>\n</table>\n<p>Above example expects that there was no other open browsers when opening the first one because it used index <code>1</code> when switching to it later. If you are not sure about that, you can store the index into a variable as below.</p>\n<table border=\"1\">\n<tr>\n<td>${index} =</td>\n<td><a href=\"#Open%20Browser\" class=\"name\">Open Browser</a></td>\n<td><a href=\"http://google.com\">http://google.com</a></td>\n</tr>\n<tr>\n<td># Do something ...</td>\n<td></td>\n<td></td>\n</tr>\n<tr>\n<td><a href=\"#Switch%20Browser\" class=\"name\">Switch Browser</a></td>\n<td>${index}</td>\n<td></td>\n</tr>\n</table>", "shortdoc": "Switches between active browsers using ``index_or_alias``.", "tags": [], "source": "C:\\Python\\lib\\site-packages\\SeleniumLibrary\\keywords\\browsermanagement.py", "lineno": 405}, {"name": "Switch Window", "args": [{"name": "locator", "types": ["list", "str"], "defaultValue": "MAIN", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "locator: list | str = MAIN"}, {"name": "timeout", "types": ["str"], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "timeout: str = None"}, {"name": "browser", "types": ["str"], "defaultValue": "CURRENT", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "browser: str = CURRENT"}], "doc": "<p>Switches to browser window matching <code>locator</code>.</p>\n<p>If the window is found, all subsequent commands use the selected window, until this keyword is used again. If the window is not found, this keyword fails. The previous windows handle is returned and can be used to switch back to it later.</p>\n<p>Notice that alerts should be handled with <a href=\"#Handle%20Alert\" class=\"name\">Handle Alert</a> or other alert related keywords.</p>\n<p>The <code>locator</code> can be specified using different strategies somewhat similarly as when <span class=\"name\">locating elements</span> on pages.</p>\n<ul>\n<li>By default, the <code>locator</code> is matched against window handle, name, title, and URL. Matching is done in that order and the first matching window is selected.</li>\n</ul>\n<ul>\n<li>The <code>locator</code> can specify an explicit strategy by using the format <code>strategy:value</code> (recommended) or <code>strategy=value</code>. Supported strategies are <code>name</code>, <code>title</code>, and <code>url</code>. These matches windows using their name, title, or URL, respectively. Additionally, <code>default</code> can be used to explicitly use the default strategy explained above.</li>\n</ul>\n<ul>\n<li>If the <code>locator</code> is <code>NEW</code> (case-insensitive), the latest opened window is selected. It is an error if this is the same as the current window.</li>\n</ul>\n<ul>\n<li>If the <code>locator</code> is <code>MAIN</code> (default, case-insensitive), the main window is selected.</li>\n</ul>\n<ul>\n<li>If the <code>locator</code> is <code>CURRENT</code> (case-insensitive), nothing is done. This effectively just returns the current window handle.</li>\n</ul>\n<ul>\n<li>If the <code>locator</code> is not a string, it is expected to be a list of window handles <i>to exclude</i>. Such a list of excluded windows can be got from <a href=\"#Get%20Window%20Handles\" class=\"name\">Get Window Handles</a> before doing an action that opens a new window.</li>\n</ul>\n<p>The <code>timeout</code> is used to specify how long keyword will poll to select the new window. The <code>timeout</code> is new in SeleniumLibrary 3.2.</p>\n<p>Example:</p>\n<table border=\"1\">\n<tr>\n<td><a href=\"#Click%20Link\" class=\"name\">Click Link</a></td>\n<td>popup1</td>\n<td></td>\n<td># Open new window</td>\n</tr>\n<tr>\n<td><a href=\"#Switch%20Window\" class=\"name\">Switch Window</a></td>\n<td>example</td>\n<td></td>\n<td># Select window using default strategy</td>\n</tr>\n<tr>\n<td><a href=\"#Title%20Should%20Be\" class=\"name\">Title Should Be</a></td>\n<td>Pop-up 1</td>\n<td></td>\n<td></td>\n</tr>\n<tr>\n<td><a href=\"#Click%20Button\" class=\"name\">Click Button</a></td>\n<td>popup2</td>\n<td></td>\n<td># Open another window</td>\n</tr>\n<tr>\n<td>${handle} =</td>\n<td><a href=\"#Switch%20Window\" class=\"name\">Switch Window</a></td>\n<td>NEW</td>\n<td># Select latest opened window</td>\n</tr>\n<tr>\n<td><a href=\"#Title%20Should%20Be\" class=\"name\">Title Should Be</a></td>\n<td>Pop-up 2</td>\n<td></td>\n<td></td>\n</tr>\n<tr>\n<td><a href=\"#Switch%20Window\" class=\"name\">Switch Window</a></td>\n<td>${handle}</td>\n<td></td>\n<td># Select window using handle</td>\n</tr>\n<tr>\n<td><a href=\"#Title%20Should%20Be\" class=\"name\">Title Should Be</a></td>\n<td>Pop-up 1</td>\n<td></td>\n<td></td>\n</tr>\n<tr>\n<td><a href=\"#Switch%20Window\" class=\"name\">Switch Window</a></td>\n<td>MAIN</td>\n<td></td>\n<td># Select the main window</td>\n</tr>\n<tr>\n<td><a href=\"#Title%20Should%20Be\" class=\"name\">Title Should Be</a></td>\n<td>Main</td>\n<td></td>\n<td></td>\n</tr>\n<tr>\n<td>${excludes} =</td>\n<td><a href=\"#Get%20Window%20Handles\" class=\"name\">Get Window Handles</a></td>\n<td></td>\n<td># Get list of current windows</td>\n</tr>\n<tr>\n<td><a href=\"#Click%20Link\" class=\"name\">Click Link</a></td>\n<td>popup3</td>\n<td></td>\n<td># Open one more window</td>\n</tr>\n<tr>\n<td><a href=\"#Switch%20Window\" class=\"name\">Switch Window</a></td>\n<td>${excludes}</td>\n<td></td>\n<td># Select window using excludes</td>\n</tr>\n<tr>\n<td><a href=\"#Title%20Should%20Be\" class=\"name\">Title Should Be</a></td>\n<td>Pop-up 3</td>\n<td></td>\n<td></td>\n</tr>\n</table>\n<p>The <code>browser</code> argument allows with <code>index_or_alias</code> to implicitly switch to a specific browser when switching to a window. See <a href=\"#Switch%20Browser\" class=\"name\">Switch Browser</a></p>\n<ul>\n<li>If the <code>browser</code> is <code>CURRENT</code> (case-insensitive), no other browser is selected.</li>\n</ul>\n<p><b>NOTE:</b></p>\n<ul>\n<li>The <code>strategy:value</code> syntax is only supported by SeleniumLibrary 3.0 and newer.</li>\n<li>Prior to SeleniumLibrary 3.0 matching windows by name, title and URL was case-insensitive.</li>\n<li>Earlier versions supported aliases <code>None</code>, <code>null</code> and the empty string for selecting the main window, and alias <code>self</code> for selecting the current window. Support for these aliases was removed in SeleniumLibrary 3.2.</li>\n</ul>", "shortdoc": "Switches to browser window matching ``locator``.", "tags": [], "source": "C:\\Python\\lib\\site-packages\\SeleniumLibrary\\keywords\\window.py", "lineno": 33}, {"name": "Table Cell Should Contain", "args": [{"name": "locator", "types": ["WebElement", "None", "str"], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "locator: WebElement | None | str"}, {"name": "row", "types": ["int"], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "row: int"}, {"name": "column", "types": ["int"], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "column: int"}, {"name": "expected", "types": ["str"], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "expected: str"}, {"name": "loglevel", "types": ["str"], "defaultValue": "TRACE", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "loglevel: str = TRACE"}], "doc": "<p>Verifies table cell contains text <code>expected</code>.</p>\n<p>See <a href=\"#Get%20Table%20Cell\" class=\"name\">Get Table Cell</a> that this keyword uses internally for an explanation about accepted arguments.</p>", "shortdoc": "Verifies table cell contains text ``expected``.", "tags": [], "source": "C:\\Python\\lib\\site-packages\\SeleniumLibrary\\keywords\\tableelement.py", "lineno": 90}, {"name": "Table Column Should Contain", "args": [{"name": "locator", "types": ["WebElement", "None", "str"], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "locator: WebElement | None | str"}, {"name": "column", "types": ["int"], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "column: int"}, {"name": "expected", "types": ["str"], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "expected: str"}, {"name": "loglevel", "types": ["str"], "defaultValue": "TRACE", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "loglevel: str = TRACE"}], "doc": "<p>Verifies table column contains text <code>expected</code>.</p>\n<p>The table is located using the <code>locator</code> argument and its column found using <code>column</code>. See the <span class=\"name\">Locating elements</span> section for details about the locator syntax.</p>\n<p>Column indexes start from 1. It is possible to refer to columns from the end by using negative indexes so that -1 is the last column, -2 is the second last, and so on.</p>\n<p>If a table contains cells that span multiple columns, those merged cells count as a single column.</p>\n<p>See <a href=\"#Page%20Should%20Contain%20Element\" class=\"name\">Page Should Contain Element</a> for an explanation about the <code>loglevel</code> argument.</p>", "shortdoc": "Verifies table column contains text ``expected``.", "tags": [], "source": "C:\\Python\\lib\\site-packages\\SeleniumLibrary\\keywords\\tableelement.py", "lineno": 113}, {"name": "Table Footer Should Contain", "args": [{"name": "locator", "types": ["WebElement", "None", "str"], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "locator: WebElement | None | str"}, {"name": "expected", "types": ["str"], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "expected: str"}, {"name": "loglevel", "types": ["str"], "defaultValue": "TRACE", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "loglevel: str = TRACE"}], "doc": "<p>Verifies table footer contains text <code>expected</code>.</p>\n<p>Any <code>&lt;td&gt;</code> element inside <code>&lt;tfoot&gt;</code> element is considered to be part of the footer.</p>\n<p>The table is located using the <code>locator</code> argument. See the <span class=\"name\">Locating elements</span> section for details about the locator syntax.</p>\n<p>See <a href=\"#Page%20Should%20Contain%20Element\" class=\"name\">Page Should Contain Element</a> for an explanation about the <code>loglevel</code> argument.</p>", "shortdoc": "Verifies table footer contains text ``expected``.", "tags": [], "source": "C:\\Python\\lib\\site-packages\\SeleniumLibrary\\keywords\\tableelement.py", "lineno": 144}, {"name": "Table Header Should Contain", "args": [{"name": "locator", "types": ["WebElement", "None", "str"], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "locator: WebElement | None | str"}, {"name": "expected", "types": ["str"], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "expected: str"}, {"name": "loglevel", "types": ["str"], "defaultValue": "TRACE", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "loglevel: str = TRACE"}], "doc": "<p>Verifies table header contains text <code>expected</code>.</p>\n<p>Any <code>&lt;th&gt;</code> element anywhere in the table is considered to be part of the header.</p>\n<p>The table is located using the <code>locator</code> argument. See the <span class=\"name\">Locating elements</span> section for details about the locator syntax.</p>\n<p>See <a href=\"#Page%20Should%20Contain%20Element\" class=\"name\">Page Should Contain Element</a> for an explanation about the <code>loglevel</code> argument.</p>", "shortdoc": "Verifies table header contains text ``expected``.", "tags": [], "source": "C:\\Python\\lib\\site-packages\\SeleniumLibrary\\keywords\\tableelement.py", "lineno": 169}, {"name": "Table Row Should Contain", "args": [{"name": "locator", "types": ["WebElement", "None", "str"], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "locator: WebElement | None | str"}, {"name": "row", "types": ["int"], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "row: int"}, {"name": "expected", "types": ["str"], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "expected: str"}, {"name": "loglevel", "types": ["str"], "defaultValue": "TRACE", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "loglevel: str = TRACE"}], "doc": "<p>Verifies that table row contains text <code>expected</code>.</p>\n<p>The table is located using the <code>locator</code> argument and its column found using <code>column</code>. See the <span class=\"name\">Locating elements</span> section for details about the locator syntax.</p>\n<p>Row indexes start from 1. It is possible to refer to rows from the end by using negative indexes so that -1 is the last row, -2 is the second last, and so on.</p>\n<p>If a table contains cells that span multiple rows, a match only occurs for the uppermost row of those merged cells.</p>\n<p>See <a href=\"#Page%20Should%20Contain%20Element\" class=\"name\">Page Should Contain Element</a> for an explanation about the <code>loglevel</code> argument.</p>", "shortdoc": "Verifies that table row contains text ``expected``.", "tags": [], "source": "C:\\Python\\lib\\site-packages\\SeleniumLibrary\\keywords\\tableelement.py", "lineno": 194}, {"name": "Table Should Contain", "args": [{"name": "locator", "types": ["WebElement", "None", "str"], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "locator: WebElement | None | str"}, {"name": "expected", "types": ["str"], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "expected: str"}, {"name": "loglevel", "types": ["str"], "defaultValue": "TRACE", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "loglevel: str = TRACE"}], "doc": "<p>Verifies table contains text <code>expected</code>.</p>\n<p>The table is located using the <code>locator</code> argument. See the <span class=\"name\">Locating elements</span> section for details about the locator syntax.</p>\n<p>See <a href=\"#Page%20Should%20Contain%20Element\" class=\"name\">Page Should Contain Element</a> for an explanation about the <code>loglevel</code> argument.</p>", "shortdoc": "Verifies table contains text ``expected``.", "tags": [], "source": "C:\\Python\\lib\\site-packages\\SeleniumLibrary\\keywords\\tableelement.py", "lineno": 225}, {"name": "Textarea Should Contain", "args": [{"name": "locator", "types": ["WebElement", "str"], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "locator: WebElement | str"}, {"name": "expected", "types": ["str"], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "expected: str"}, {"name": "message", "types": ["str"], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "message: str = None"}], "doc": "<p>Verifies text area <code>locator</code> contains text <code>expected</code>.</p>\n<p><code>message</code> can be used to override default error message.</p>\n<p>See the <span class=\"name\">Locating elements</span> section for details about the locator syntax.</p>", "shortdoc": "Verifies text area ``locator`` contains text ``expected``.", "tags": [], "source": "C:\\Python\\lib\\site-packages\\SeleniumLibrary\\keywords\\formelement.py", "lineno": 382}, {"name": "Textarea Value Should Be", "args": [{"name": "locator", "types": ["WebElement", "str"], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "locator: WebElement | str"}, {"name": "expected", "types": ["str"], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "expected: str"}, {"name": "message", "types": ["str"], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "message: str = None"}], "doc": "<p>Verifies text area <code>locator</code> has exactly text <code>expected</code>.</p>\n<p><code>message</code> can be used to override default error message.</p>\n<p>See the <span class=\"name\">Locating elements</span> section for details about the locator syntax.</p>", "shortdoc": "Verifies text area ``locator`` has exactly text ``expected``.", "tags": [], "source": "C:\\Python\\lib\\site-packages\\SeleniumLibrary\\keywords\\formelement.py", "lineno": 406}, {"name": "Textfield Should Contain", "args": [{"name": "locator", "types": ["WebElement", "str"], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "locator: WebElement | str"}, {"name": "expected", "types": ["str"], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "expected: str"}, {"name": "message", "types": ["str"], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "message: str = None"}], "doc": "<p>Verifies text field <code>locator</code> contains text <code>expected</code>.</p>\n<p><code>message</code> can be used to override the default error message.</p>\n<p>See the <span class=\"name\">Locating elements</span> section for details about the locator syntax.</p>", "shortdoc": "Verifies text field ``locator`` contains text ``expected``.", "tags": [], "source": "C:\\Python\\lib\\site-packages\\SeleniumLibrary\\keywords\\formelement.py", "lineno": 334}, {"name": "Textfield Value Should Be", "args": [{"name": "locator", "types": ["WebElement", "str"], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "locator: WebElement | str"}, {"name": "expected", "types": ["str"], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "expected: str"}, {"name": "message", "types": ["str"], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "message: str = None"}], "doc": "<p>Verifies text field <code>locator</code> has exactly text <code>expected</code>.</p>\n<p><code>message</code> can be used to override default error message.</p>\n<p>See the <span class=\"name\">Locating elements</span> section for details about the locator syntax.</p>", "shortdoc": "Verifies text field ``locator`` has exactly text ``expected``.", "tags": [], "source": "C:\\Python\\lib\\site-packages\\SeleniumLibrary\\keywords\\formelement.py", "lineno": 358}, {"name": "Title Should Be", "args": [{"name": "title", "types": ["str"], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "title: str"}, {"name": "message", "types": ["str"], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "message: str = None"}], "doc": "<p>Verifies that the current page title equals <code>title</code>.</p>\n<p>The <code>message</code> argument can be used to override the default error message.</p>\n<p><code>message</code> argument is new in SeleniumLibrary 3.1.</p>", "shortdoc": "Verifies that the current page title equals ``title``.", "tags": [], "source": "C:\\Python\\lib\\site-packages\\SeleniumLibrary\\keywords\\browsermanagement.py", "lineno": 568}, {"name": "Truncate String", "args": [{"name": "string", "types": [], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "string"}, {"name": "number_of_characters", "types": [], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "number_of_characters"}], "doc": "<p>Truncates a given string to a certain amount of the given number of characters parameter.</p>\n<p>string: (string) Original String number_of_characters: (integer) Truncation index return: (string) A truncated String</p>", "shortdoc": "Truncates a given string to a certain amount of the given number of characters parameter.", "tags": [], "source": "C:\\Git\\robotframework-zoomba\\src\\Zoomba\\GUILibrary.py", "lineno": 347}, {"name": "Unselect All From List", "args": [{"name": "locator", "types": ["WebElement", "str"], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "locator: WebElement | str"}], "doc": "<p>Unselects all options from multi-selection list <code>locator</code>.</p>\n<p>See the <span class=\"name\">Locating elements</span> section for details about the locator syntax.</p>\n<p>New in SeleniumLibrary 3.0.</p>", "shortdoc": "Unselects all options from multi-selection list ``locator``.", "tags": [], "source": "C:\\Python\\lib\\site-packages\\SeleniumLibrary\\keywords\\selectelement.py", "lineno": 278}, {"name": "Unselect And Select Frame", "args": [{"name": "locator", "types": [], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "locator"}, {"name": "timeout", "types": [], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "timeout=None"}], "doc": "<p>This is a series of chained Selenium keywords, that first unselects the current iFrame, then executes a wait for and select frame for a new iFrame.</p>\n<p>locator: (string) A selenium locator(CSS, XPATH, ID, NAME, etc) timeout: (float) Time in seconds to wait, will use global timeout if not set.</p>", "shortdoc": "This is a series of chained Selenium keywords, that first unselects the current iFrame, then executes a wait for and select frame for a new iFrame.", "tags": [], "source": "C:\\Git\\robotframework-zoomba\\src\\Zoomba\\GUILibrary.py", "lineno": 126}, {"name": "Unselect Checkbox", "args": [{"name": "locator", "types": ["WebElement", "str"], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "locator: WebElement | str"}], "doc": "<p>Removes the selection of checkbox identified by <code>locator</code>.</p>\n<p>Does nothing if the checkbox is not selected.</p>\n<p>See the <span class=\"name\">Locating elements</span> section for details about the locator syntax.</p>", "shortdoc": "Removes the selection of checkbox identified by ``locator``.", "tags": [], "source": "C:\\Python\\lib\\site-packages\\SeleniumLibrary\\keywords\\formelement.py", "lineno": 118}, {"name": "Unselect Frame", "args": [], "doc": "<p>Sets the main frame as the current frame.</p>\n<p>In practice cancels the previous <a href=\"#Select%20Frame\" class=\"name\">Select Frame</a> call.</p>", "shortdoc": "Sets the main frame as the current frame.", "tags": [], "source": "C:\\Python\\lib\\site-packages\\SeleniumLibrary\\keywords\\frames.py", "lineno": 45}, {"name": "Unselect From List By Index", "args": [{"name": "locator", "types": ["WebElement", "str"], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "locator: WebElement | str"}, {"name": "indexes", "types": ["str"], "defaultValue": null, "kind": "VAR_POSITIONAL", "required": false, "repr": "*indexes: str"}], "doc": "<p>Unselects options from selection list <code>locator</code> by <code>indexes</code>.</p>\n<p>Indexes of list options start from 0. This keyword works only with multi-selection lists.</p>\n<p>See the <span class=\"name\">Locating elements</span> section for details about the locator syntax.</p>", "shortdoc": "Unselects options from selection list ``locator`` by ``indexes``.", "tags": [], "source": "C:\\Python\\lib\\site-packages\\SeleniumLibrary\\keywords\\selectelement.py", "lineno": 295}, {"name": "Unselect From List By Label", "args": [{"name": "locator", "types": ["WebElement", "str"], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "locator: WebElement | str"}, {"name": "labels", "types": ["str"], "defaultValue": null, "kind": "VAR_POSITIONAL", "required": false, "repr": "*labels: str"}], "doc": "<p>Unselects options from selection list <code>locator</code> by <code>labels</code>.</p>\n<p>This keyword works only with multi-selection lists.</p>\n<p>See the <span class=\"name\">Locating elements</span> section for details about the locator syntax.</p>", "shortdoc": "Unselects options from selection list ``locator`` by ``labels``.", "tags": [], "source": "C:\\Python\\lib\\site-packages\\SeleniumLibrary\\keywords\\selectelement.py", "lineno": 347}, {"name": "Unselect From List By Value", "args": [{"name": "locator", "types": ["WebElement", "str"], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "locator: WebElement | str"}, {"name": "values", "types": ["str"], "defaultValue": null, "kind": "VAR_POSITIONAL", "required": false, "repr": "*values: str"}], "doc": "<p>Unselects options from selection list <code>locator</code> by <code>values</code>.</p>\n<p>This keyword works only with multi-selection lists.</p>\n<p>See the <span class=\"name\">Locating elements</span> section for details about the locator syntax.</p>", "shortdoc": "Unselects options from selection list ``locator`` by ``values``.", "tags": [], "source": "C:\\Python\\lib\\site-packages\\SeleniumLibrary\\keywords\\selectelement.py", "lineno": 322}, {"name": "Wait For And Click Element", "args": [{"name": "locator", "types": [], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "locator"}, {"name": "timeout", "types": [], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "timeout=None"}], "doc": "<p>This is a series of chained Selenium keywords, that tries to find a web element first, and then clicks it. If the element fails to be clicked, it will scroll to the bottom of the page and try again.</p>\n<p>locator: (string) A selenium locator(CSS, XPATH, ID, NAME, etc) timeout: (float) Time in seconds to wait, will use global timeout if not set.</p>", "shortdoc": "This is a series of chained Selenium keywords, that tries to find a web element first, and then clicks it. If the element fails to be clicked, it will scroll to the bottom of the page and try again.", "tags": [], "source": "C:\\Git\\robotframework-zoomba\\src\\Zoomba\\GUILibrary.py", "lineno": 70}, {"name": "Wait For And Focus On Element", "args": [{"name": "locator", "types": [], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "locator"}, {"name": "timeout", "types": [], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "timeout=None"}], "doc": "<p>This is a series of chained Selenium keywords, that first waits for an element to be on the DOM, executes Focus on it, then it waits for it to be visible.</p>\n<p>locator: (string) A selenium locator(CSS, XPATH, ID, NAME, etc) timeout: (float) Time in seconds to wait, will use global timeout if not set.</p>", "shortdoc": "This is a series of chained Selenium keywords, that first waits for an element to be on the DOM, executes Focus on it, then it waits for it to be visible.", "tags": [], "source": "C:\\Git\\robotframework-zoomba\\src\\Zoomba\\GUILibrary.py", "lineno": 200}, {"name": "Wait For And Input Password", "args": [{"name": "locator", "types": [], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "locator"}, {"name": "password", "types": [], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "password"}, {"name": "timeout", "types": [], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "timeout=None"}], "doc": "<p>This is a series of chained Selenium keywords, that tries to find a web element first, and then input text. The password text is not printed displayed in logs. If the element fails to typed into, it will scroll to the bottom of the page and try again.</p>\n<p>locator: (string) A selenium locator(CSS, XPATH, ID, NAME, etc)</p>\n<p>password: (string) Password text to be typed into the input field. timeout: (float) Time in seconds to wait, will use global timeout if not set.</p>", "shortdoc": "This is a series of chained Selenium keywords, that tries to find a web element first, and then input text. The password text is not printed displayed in logs. If the element fails to typed into, it will scroll to the bottom of the page and try again.", "tags": [], "source": "C:\\Git\\robotframework-zoomba\\src\\Zoomba\\GUILibrary.py", "lineno": 91}, {"name": "Wait For And Input Text", "args": [{"name": "locator", "types": [], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "locator"}, {"name": "text", "types": [], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "text"}, {"name": "timeout", "types": [], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "timeout=None"}], "doc": "<p>This is a series of chained Selenium keywords, that tries to find a web element first, and then input text. If the element fails to typed into, it will scroll to the bottom of the page and try again.</p>\n<p>locator: (string) A selenium locator(CSS, XPATH, ID, NAME, etc)</p>\n<p>text: (string) Text to be typed into the input field. timeout: (float) Time in seconds to wait, will use global timeout if not set.</p>", "shortdoc": "This is a series of chained Selenium keywords, that tries to find a web element first, and then input text. If the element fails to typed into, it will scroll to the bottom of the page and try again.", "tags": [], "source": "C:\\Git\\robotframework-zoomba\\src\\Zoomba\\GUILibrary.py", "lineno": 80}, {"name": "Wait For And Mouse Over", "args": [{"name": "locator", "types": [], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "locator"}, {"name": "timeout", "types": [], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "timeout=None"}], "doc": "<p>This is a series of chained Selenium keywords, that first waits for an element to be visible, then executes a mouse over command on it.</p>\n<p>locator: (string) A selenium locator(CSS, XPATH, ID, NAME, etc) timeout: (float) Time in seconds to wait, will use global timeout if not set.</p>", "shortdoc": "This is a series of chained Selenium keywords, that first waits for an element to be visible, then executes a mouse over command on it.", "tags": [], "source": "C:\\Git\\robotframework-zoomba\\src\\Zoomba\\GUILibrary.py", "lineno": 169}, {"name": "Wait For And Mouse Over And Click", "args": [{"name": "locator", "types": [], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "locator"}, {"name": "timeout", "types": [], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "timeout=None"}], "doc": "<p>This is a series of chained Selenium keywords, that first waits for an element to be visible, executes a mouse over command on it, and it finally clicks it.</p>\n<p>locator: (string) A selenium locator(CSS, XPATH, ID, NAME, etc) timeout: (float) Time in seconds to wait, will use global timeout if not set.</p>", "shortdoc": "This is a series of chained Selenium keywords, that first waits for an element to be visible, executes a mouse over command on it, and it finally clicks it.", "tags": [], "source": "C:\\Git\\robotframework-zoomba\\src\\Zoomba\\GUILibrary.py", "lineno": 189}, {"name": "Wait For And Select Checkbox", "args": [{"name": "locator", "types": [], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "locator"}, {"name": "timeout", "types": [], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "timeout=None"}], "doc": "<p>This is a series of chained Selenium keywords, that first waits for an element to be visible, then selects it if it's a checkbox.</p>\n<p>locator: (string) A selenium locator(CSS, XPATH, ID, NAME, etc) timeout: (float) Time in seconds to wait, will use global timeout if not set.</p>", "shortdoc": "This is a series of chained Selenium keywords, that first waits for an element to be visible, then selects it if it's a checkbox.", "tags": [], "source": "C:\\Git\\robotframework-zoomba\\src\\Zoomba\\GUILibrary.py", "lineno": 179}, {"name": "Wait For And Select Frame", "args": [{"name": "locator", "types": [], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "locator"}, {"name": "timeout", "types": [], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "timeout=None"}], "doc": "<p>This is a series of chained Selenium keywords, that first waits until an iFrame exists in the page, and then selects it.</p>\n<p>locator: (string) A selenium locator(CSS, XPATH, ID, NAME, etc) timeout: (float) Time in seconds to wait, will use global timeout if not set.</p>", "shortdoc": "This is a series of chained Selenium keywords, that first waits until an iFrame exists in the page, and then selects it.", "tags": [], "source": "C:\\Git\\robotframework-zoomba\\src\\Zoomba\\GUILibrary.py", "lineno": 103}, {"name": "Wait For And Select From List", "args": [{"name": "locator", "types": [], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "locator"}, {"name": "target", "types": [], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "target"}, {"name": "timeout", "types": [], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "timeout=None"}], "doc": "<p>This is a series of chained Selenium keywords, that first waits for and focuses on a list element, then selects an item(s).</p>\n<p>locator:  (string) A selenium locator(CSS, XPATH, ID, NAME, etc)</p>\n<p>target: (string, array of strings) The list item(s) to be selected (string, or list of strings) timeout: (float) Time in seconds to wait, will use global timeout if not set.</p>", "shortdoc": "This is a series of chained Selenium keywords, that first waits for and focuses on a list element, then selects an item(s).", "tags": [], "source": "C:\\Git\\robotframework-zoomba\\src\\Zoomba\\GUILibrary.py", "lineno": 136}, {"name": "Wait For And Select From List By Index", "args": [{"name": "locator", "types": [], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "locator"}, {"name": "target", "types": [], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "target"}, {"name": "timeout", "types": [], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "timeout=None"}], "doc": "<p>This is a series of chained Selenium keywords, that first waits for and focuses on a list element, then selects an item(s) for it using the index of the item(s) web element.</p>\n<p>locator:  (string) A selenium locator(CSS, XPATH, ID, NAME, etc)</p>\n<p>target: (string, array of strings) The list item(s) to be selected (string, or list of strings) timeout: (float) Time in seconds to wait, will use global timeout if not set.</p>", "shortdoc": "This is a series of chained Selenium keywords, that first waits for and focuses on a list element, then selects an item(s) for it using the index of the item(s) web element.", "tags": [], "source": "C:\\Git\\robotframework-zoomba\\src\\Zoomba\\GUILibrary.py", "lineno": 158}, {"name": "Wait For And Select From List By Value", "args": [{"name": "locator", "types": [], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "locator"}, {"name": "target", "types": [], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "target"}, {"name": "timeout", "types": [], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "timeout=None"}], "doc": "<p>This is a series of chained Selenium keywords, that first waits for and focuses on a list element, then selects an item(s) for it using the value attribute of the item(s) web element.</p>\n<p>locator:  (string) A selenium locator(CSS, XPATH, ID, NAME, etc)</p>\n<p>target: (string, array of strings) The list item(s) to be selected (string, or list of strings) timeout: (float) Time in seconds to wait, will use global timeout if not set.</p>", "shortdoc": "This is a series of chained Selenium keywords, that first waits for and focuses on a list element, then selects an item(s) for it using the value attribute of the item(s) web element.", "tags": [], "source": "C:\\Git\\robotframework-zoomba\\src\\Zoomba\\GUILibrary.py", "lineno": 147}, {"name": "Wait For And Select Window", "args": [{"name": "title", "types": [], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "title"}, {"name": "timeout", "types": [], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "timeout=None"}], "doc": "<p>This is a series of chained Selenium keywords, used to wait until a window with the title argument exists, then it selects that window.</p>\n<p>title: (string) The title of the window you are waiting for. timeout: (float) Time in seconds to wait, will use global timeout if not set.</p>", "shortdoc": "This is a series of chained Selenium keywords, used to wait until a window with the title argument exists, then it selects that window.", "tags": [], "source": "C:\\Git\\robotframework-zoomba\\src\\Zoomba\\GUILibrary.py", "lineno": 238}, {"name": "Wait For Condition", "args": [{"name": "condition", "types": ["str"], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "condition: str"}, {"name": "timeout", "types": ["timedelta"], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "timeout: timedelta = None"}, {"name": "error", "types": ["str"], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "error: str = None"}], "doc": "<p>Waits until <code>condition</code> is true or <code>timeout</code> expires.</p>\n<p>The condition can be arbitrary JavaScript expression but it must return a value to be evaluated. See <a href=\"#Execute%20Javascript\" class=\"name\">Execute JavaScript</a> for information about accessing content on pages.</p>\n<p>Fails if the timeout expires before the condition becomes true. See the <span class=\"name\">Timeouts</span> section for more information about using timeouts and their default value.</p>\n<p><code>error</code> can be used to override the default error message.</p>\n<p>Examples:</p>\n<table border=\"1\">\n<tr>\n<td><a href=\"#Wait%20For%20Condition\" class=\"name\">Wait For Condition</a></td>\n<td>return document.title == \"New Title\"</td>\n</tr>\n<tr>\n<td><a href=\"#Wait%20For%20Condition\" class=\"name\">Wait For Condition</a></td>\n<td>return jQuery.active == 0</td>\n</tr>\n<tr>\n<td><a href=\"#Wait%20For%20Condition\" class=\"name\">Wait For Condition</a></td>\n<td>style = document.querySelector('h1').style; return style.background == \"red\" &amp;&amp; style.color == \"white\"</td>\n</tr>\n</table>", "shortdoc": "Waits until ``condition`` is true or ``timeout`` expires.", "tags": [], "source": "C:\\Python\\lib\\site-packages\\SeleniumLibrary\\keywords\\waiting.py", "lineno": 31}, {"name": "Wait Until Element Contains", "args": [{"name": "locator", "types": ["WebElement", "None", "str"], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "locator: WebElement | None | str"}, {"name": "text", "types": ["str"], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "text: str"}, {"name": "timeout", "types": ["timedelta"], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "timeout: timedelta = None"}, {"name": "error", "types": ["str"], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "error: str = None"}], "doc": "<p>Waits until the element <code>locator</code> contains <code>text</code>.</p>\n<p>Fails if <code>timeout</code> expires before the text appears. See the <span class=\"name\">Timeouts</span> section for more information about using timeouts and their default value and the <span class=\"name\">Locating elements</span> section for details about the locator syntax.</p>\n<p><code>error</code> can be used to override the default error message.</p>", "shortdoc": "Waits until the element ``locator`` contains ``text``.", "tags": [], "source": "C:\\Python\\lib\\site-packages\\SeleniumLibrary\\keywords\\waiting.py", "lineno": 373}, {"name": "Wait Until Element Contains Value", "args": [{"name": "locator", "types": [], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "locator"}, {"name": "expected_value", "types": [], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "expected_value"}, {"name": "timeout", "types": [], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "timeout=None"}], "doc": "<p>Waits until the element <code>locator</code> appears on the current page and contains value. Fails if <code>timeout</code> expires before the element appears. See the <span class=\"name\">Timeouts</span> section for more information about using timeouts and their default value and the <span class=\"name\">Locating elements</span> section for details about the locator syntax.</p>", "shortdoc": "Waits until the element ``locator`` appears on the current page and contains value. Fails if ``timeout`` expires before the element appears. See the `Timeouts` section for more information about using timeouts and their default value and the `Locating elements` section for details about the locator syntax.", "tags": [], "source": "C:\\Git\\robotframework-zoomba\\src\\Zoomba\\GUILibrary.py", "lineno": 322}, {"name": "Wait Until Element Does Not Contain", "args": [{"name": "locator", "types": ["WebElement", "None", "str"], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "locator: WebElement | None | str"}, {"name": "text", "types": ["str"], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "text: str"}, {"name": "timeout", "types": ["timedelta"], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "timeout: timedelta = None"}, {"name": "error", "types": ["str"], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "error: str = None"}], "doc": "<p>Waits until the element <code>locator</code> does not contain <code>text</code>.</p>\n<p>Fails if <code>timeout</code> expires before the text disappears. See the <span class=\"name\">Timeouts</span> section for more information about using timeouts and their default value and the <span class=\"name\">Locating elements</span> section for details about the locator syntax.</p>\n<p><code>error</code> can be used to override the default error message.</p>", "shortdoc": "Waits until the element ``locator`` does not contain ``text``.", "tags": [], "source": "C:\\Python\\lib\\site-packages\\SeleniumLibrary\\keywords\\waiting.py", "lineno": 397}, {"name": "Wait Until Element Is Enabled", "args": [{"name": "locator", "types": ["WebElement", "None", "str"], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "locator: WebElement | None | str"}, {"name": "timeout", "types": ["timedelta"], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "timeout: timedelta = None"}, {"name": "error", "types": ["str"], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "error: str = None"}], "doc": "<p>Waits until the element <code>locator</code> is enabled.</p>\n<p>Element is considered enabled if it is not disabled nor read-only.</p>\n<p>Fails if <code>timeout</code> expires before the element is enabled. See the <span class=\"name\">Timeouts</span> section for more information about using timeouts and their default value and the <span class=\"name\">Locating elements</span> section for details about the locator syntax.</p>\n<p><code>error</code> can be used to override the default error message.</p>\n<p>Considering read-only elements to be disabled is a new feature in SeleniumLibrary 3.0.</p>", "shortdoc": "Waits until the element ``locator`` is enabled.", "tags": [], "source": "C:\\Python\\lib\\site-packages\\SeleniumLibrary\\keywords\\waiting.py", "lineno": 345}, {"name": "Wait Until Element Is Not Visible", "args": [{"name": "locator", "types": ["WebElement", "None", "str"], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "locator: WebElement | None | str"}, {"name": "timeout", "types": ["timedelta"], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "timeout: timedelta = None"}, {"name": "error", "types": ["str"], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "error: str = None"}], "doc": "<p>Waits until the element <code>locator</code> is not visible.</p>\n<p>Fails if <code>timeout</code> expires before the element is not visible. See the <span class=\"name\">Timeouts</span> section for more information about using timeouts and their default value and the <span class=\"name\">Locating elements</span> section for details about the locator syntax.</p>\n<p><code>error</code> can be used to override the default error message.</p>", "shortdoc": "Waits until the element ``locator`` is not visible.", "tags": [], "source": "C:\\Python\\lib\\site-packages\\SeleniumLibrary\\keywords\\waiting.py", "lineno": 322}, {"name": "Wait Until Element Is Visible", "args": [{"name": "locator", "types": ["WebElement", "None", "str"], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "locator: WebElement | None | str"}, {"name": "timeout", "types": ["timedelta"], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "timeout: timedelta = None"}, {"name": "error", "types": ["str"], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "error: str = None"}], "doc": "<p>Waits until the element <code>locator</code> is visible.</p>\n<p>Fails if <code>timeout</code> expires before the element is visible. See the <span class=\"name\">Timeouts</span> section for more information about using timeouts and their default value and the <span class=\"name\">Locating elements</span> section for details about the locator syntax.</p>\n<p><code>error</code> can be used to override the default error message.</p>", "shortdoc": "Waits until the element ``locator`` is visible.", "tags": [], "source": "C:\\Python\\lib\\site-packages\\SeleniumLibrary\\keywords\\waiting.py", "lineno": 299}, {"name": "Wait Until Javascript Is Complete", "args": [], "doc": "<p>This keyword polls the jQuery.active flag, to track execution of AJAX requests. The web application needs to have jQuery in order for this to work.</p>", "shortdoc": "This keyword polls the jQuery.active flag, to track execution of AJAX requests. The web application needs to have jQuery in order for this to work.", "tags": [], "source": "C:\\Git\\robotframework-zoomba\\src\\Zoomba\\GUILibrary.py", "lineno": 260}, {"name": "Wait Until Location Contains", "args": [{"name": "expected", "types": ["str"], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "expected: str"}, {"name": "timeout", "types": ["timedelta"], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "timeout: timedelta = None"}, {"name": "message", "types": ["str"], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "message: str = None"}], "doc": "<p>Waits until the current URL contains <code>expected</code>.</p>\n<p>The <code>expected</code> argument contains the expected value in url.</p>\n<p>Fails if <code>timeout</code> expires before the location contains. See the <span class=\"name\">Timeouts</span> section for more information about using timeouts and their default value.</p>\n<p>The <code>message</code> argument can be used to override the default error message.</p>\n<p>New in SeleniumLibrary 4.0</p>", "shortdoc": "Waits until the current URL contains ``expected``.", "tags": [], "source": "C:\\Python\\lib\\site-packages\\SeleniumLibrary\\keywords\\waiting.py", "lineno": 123}, {"name": "Wait Until Location Does Not Contain", "args": [{"name": "location", "types": ["str"], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "location: str"}, {"name": "timeout", "types": ["timedelta"], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "timeout: timedelta = None"}, {"name": "message", "types": ["str"], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "message: str = None"}], "doc": "<p>Waits until the current URL does not contains <code>location</code>.</p>\n<p>The <code>location</code> argument contains value not expected in url.</p>\n<p>Fails if <code>timeout</code> expires before the location not contains. See the <span class=\"name\">Timeouts</span> section for more information about using timeouts and their default value.</p>\n<p>The <code>message</code> argument can be used to override the default error message.</p>\n<p>New in SeleniumLibrary 4.3</p>", "shortdoc": "Waits until the current URL does not contains ``location``.", "tags": [], "source": "C:\\Python\\lib\\site-packages\\SeleniumLibrary\\keywords\\waiting.py", "lineno": 151}, {"name": "Wait Until Location Is", "args": [{"name": "expected", "types": ["str"], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "expected: str"}, {"name": "timeout", "types": ["timedelta"], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "timeout: timedelta = None"}, {"name": "message", "types": ["str"], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "message: str = None"}], "doc": "<p>Waits until the current URL is <code>expected</code>.</p>\n<p>The <code>expected</code> argument is the expected value in url.</p>\n<p>Fails if <code>timeout</code> expires before the location is. See the <span class=\"name\">Timeouts</span> section for more information about using timeouts and their default value.</p>\n<p>The <code>message</code> argument can be used to override the default error message.</p>\n<p>New in SeleniumLibrary 4.0</p>", "shortdoc": "Waits until the current URL is ``expected``.", "tags": [], "source": "C:\\Python\\lib\\site-packages\\SeleniumLibrary\\keywords\\waiting.py", "lineno": 66}, {"name": "Wait Until Location Is Not", "args": [{"name": "location", "types": ["str"], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "location: str"}, {"name": "timeout", "types": ["timedelta"], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "timeout: timedelta = None"}, {"name": "message", "types": ["str"], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "message: str = None"}], "doc": "<p>Waits until the current URL is not <code>location</code>.</p>\n<p>The <code>location</code> argument is the unexpected value in url.</p>\n<p>Fails if <code>timeout</code> expires before the location is not. See the <span class=\"name\">Timeouts</span> section for more information about using timeouts and their default value.</p>\n<p>The <code>message</code> argument can be used to override the default error message.</p>\n<p>New in SeleniumLibrary 4.3</p>", "shortdoc": "Waits until the current URL is not ``location``.", "tags": [], "source": "C:\\Python\\lib\\site-packages\\SeleniumLibrary\\keywords\\waiting.py", "lineno": 95}, {"name": "Wait Until Page Contains", "args": [{"name": "text", "types": ["str"], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "text: str"}, {"name": "timeout", "types": ["timedelta"], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "timeout: timedelta = None"}, {"name": "error", "types": ["str"], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "error: str = None"}], "doc": "<p>Waits until <code>text</code> appears on the current page.</p>\n<p>Fails if <code>timeout</code> expires before the text appears. See the <span class=\"name\">Timeouts</span> section for more information about using timeouts and their default value.</p>\n<p><code>error</code> can be used to override the default error message.</p>", "shortdoc": "Waits until ``text`` appears on the current page.", "tags": [], "source": "C:\\Python\\lib\\site-packages\\SeleniumLibrary\\keywords\\waiting.py", "lineno": 179}, {"name": "Wait Until Page Contains Element", "args": [{"name": "locator", "types": ["WebElement", "None", "str"], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "locator: WebElement | None | str"}, {"name": "timeout", "types": ["timedelta"], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "timeout: timedelta = None"}, {"name": "error", "types": ["str"], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "error: str = None"}, {"name": "limit", "types": ["int"], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "limit: int = None"}], "doc": "<p>Waits until the element <code>locator</code> appears on the current page.</p>\n<p>Fails if <code>timeout</code> expires before the element appears. See the <span class=\"name\">Timeouts</span> section for more information about using timeouts and their default value and the <span class=\"name\">Locating elements</span> section for details about the locator syntax.</p>\n<p><code>error</code> can be used to override the default error message.</p>\n<p>The <code>limit</code> argument can used to define how many elements the page should contain. When <code>limit</code> is <span class=\"name\">None</span> (default) page can contain one or more elements. When limit is a number, page must contain same number of elements.</p>\n<p><code>limit</code> is new in SeleniumLibrary 4.4</p>", "shortdoc": "Waits until the element ``locator`` appears on the current page.", "tags": [], "source": "C:\\Python\\lib\\site-packages\\SeleniumLibrary\\keywords\\waiting.py", "lineno": 223}, {"name": "Wait Until Page Does Not Contain", "args": [{"name": "text", "types": ["str"], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "text: str"}, {"name": "timeout", "types": ["timedelta"], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "timeout: timedelta = None"}, {"name": "error", "types": ["str"], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "error: str = None"}], "doc": "<p>Waits until <code>text</code> disappears from the current page.</p>\n<p>Fails if <code>timeout</code> expires before the text disappears. See the <span class=\"name\">Timeouts</span> section for more information about using timeouts and their default value.</p>\n<p><code>error</code> can be used to override the default error message.</p>", "shortdoc": "Waits until ``text`` disappears from the current page.", "tags": [], "source": "C:\\Python\\lib\\site-packages\\SeleniumLibrary\\keywords\\waiting.py", "lineno": 201}, {"name": "Wait Until Page Does Not Contain Element", "args": [{"name": "locator", "types": ["WebElement", "None", "str"], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "locator: WebElement | None | str"}, {"name": "timeout", "types": ["timedelta"], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "timeout: timedelta = None"}, {"name": "error", "types": ["str"], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "error: str = None"}, {"name": "limit", "types": ["int"], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "limit: int = None"}], "doc": "<p>Waits until the element <code>locator</code> disappears from the current page.</p>\n<p>Fails if <code>timeout</code> expires before the element disappears. See the <span class=\"name\">Timeouts</span> section for more information about using timeouts and their default value and the <span class=\"name\">Locating elements</span> section for details about the locator syntax.</p>\n<p><code>error</code> can be used to override the default error message.</p>\n<p>The <code>limit</code> argument can used to define how many elements the page should not contain. When <code>limit</code> is <span class=\"name\">None</span> (default) page can`t contain any elements. When limit is a number, page must not contain same number of elements.</p>\n<p><code>limit</code> is new in SeleniumLibrary 4.4</p>", "shortdoc": "Waits until the element ``locator`` disappears from the current page.", "tags": [], "source": "C:\\Python\\lib\\site-packages\\SeleniumLibrary\\keywords\\waiting.py", "lineno": 261}, {"name": "Wait Until Window Closes", "args": [{"name": "title", "types": [], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "title"}, {"name": "timeout", "types": [], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "timeout=None"}], "doc": "<p>This is a series of chained Selenium keywords, used to wait until a window with the title no longer exists.</p>\n<p>title: (string) The title of the window you are expecting to close. timeout: (float) Time in seconds to wait, will use global timeout if not set.</p>", "shortdoc": "This is a series of chained Selenium keywords, used to wait until a window with the title no longer exists.", "tags": [], "source": "C:\\Git\\robotframework-zoomba\\src\\Zoomba\\GUILibrary.py", "lineno": 312}, {"name": "Wait Until Window Opens", "args": [{"name": "title", "types": [], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "title"}, {"name": "timeout", "types": [], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "timeout=None"}], "doc": "<p>Used to get the titles of the current browser windows, then verify that the provided window title is among them.</p>\n<p>title: (string) The title of the window you are waiting for.</p>\n<p>timeout: (float) Time in seconds to wait, will use global timeout if not set.</p>", "shortdoc": "Used to get the titles of the current browser windows, then verify that the provided window title is among them.", "tags": [], "source": "C:\\Git\\robotframework-zoomba\\src\\Zoomba\\GUILibrary.py", "lineno": 213}, {"name": "Window Should Not Be Open", "args": [{"name": "title", "types": [], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "title"}], "doc": "<p>This is a series of chained Selenium keywords, used to check that a window with the title no longer exists.</p>\n<p>title: (string) The title of the window you are expecting to be closed.</p>", "shortdoc": "This is a series of chained Selenium keywords, used to check that a window with the title no longer exists.", "tags": [], "source": "C:\\Git\\robotframework-zoomba\\src\\Zoomba\\GUILibrary.py", "lineno": 230}], "dataTypes": {"enums": [], "typedDicts": []}}
 </script>
 <title></title>
 </head>
diff --git a/docs/MobileLibraryDocumentation.html b/docs/MobileLibraryDocumentation.html
index de7bdb70..8d3f80da 100644
--- a/docs/MobileLibraryDocumentation.html
+++ b/docs/MobileLibraryDocumentation.html
@@ -1101,7 +1101,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 = {"name": "Mobile_Library", "doc": "<p>Zoomba 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": "2.9.0", "generated": "2021-05-12 09:19:41", "type": "LIBRARY", "scope": "GLOBAL", "docFormat": "HTML", "source": "C:\\Git\\robotframework-zoomba\\src\\Zoomba\\MobileLibrary.py", "lineno": 14, "tags": [], "inits": [{"name": "Init", "args": [{"name": "timeout", "types": [], "defaultValue": "5", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "timeout=5"}, {"name": "run_on_failure", "types": [], "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-zoomba\\src\\Zoomba\\MobileLibrary.py", "lineno": 71}], "keywords": [{"name": "Background App", "args": [{"name": "seconds", "types": [], "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:\\Python\\lib\\site-packages\\AppiumLibrary\\keywords\\_applicationmanagement.py", "lineno": 245}, {"name": "Capture Page Screenshot", "args": [{"name": "filename", "types": [], "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-zoomba\\src\\Zoomba\\MobileLibrary.py", "lineno": 297}, {"name": "Clear Text", "args": [{"name": "locator", "types": [], "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:\\Python\\lib\\site-packages\\AppiumLibrary\\keywords\\_element.py", "lineno": 27}, {"name": "Click A Point", "args": [{"name": "x", "types": [], "defaultValue": "0", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "x=0"}, {"name": "y", "types": [], "defaultValue": "0", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "y=0"}, {"name": "duration", "types": [], "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:\\Python\\lib\\site-packages\\AppiumLibrary\\keywords\\_touch.py", "lineno": 145}, {"name": "Click Button", "args": [{"name": "index_or_name", "types": [], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "index_or_name"}], "doc": "<p>Click button</p>", "shortdoc": "Click button", "tags": [], "source": "C:\\Python\\lib\\site-packages\\AppiumLibrary\\keywords\\_element.py", "lineno": 44}, {"name": "Click Element", "args": [{"name": "locator", "types": [], "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:\\Python\\lib\\site-packages\\AppiumLibrary\\keywords\\_element.py", "lineno": 35}, {"name": "Click Element At Coordinates", "args": [{"name": "coordinate_X", "types": [], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "coordinate_X"}, {"name": "coordinate_Y", "types": [], "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:\\Python\\lib\\site-packages\\AppiumLibrary\\keywords\\_touch.py", "lineno": 155}, {"name": "Click Text", "args": [{"name": "text", "types": [], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "text"}, {"name": "exact_match", "types": [], "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:\\Python\\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:\\Python\\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:\\Python\\lib\\site-packages\\AppiumLibrary\\keywords\\_applicationmanagement.py", "lineno": 20}, {"name": "Drag And Drop", "args": [{"name": "source", "types": [], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "source"}, {"name": "target", "types": [], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "target"}], "doc": "<p>Drags the element found with the locator <code>source</code> to the element found with the locator <code>target</code>.</p>", "shortdoc": "Drags the element found with the locator ``source`` to the element found with the locator ``target``.", "tags": [], "source": "C:\\Git\\robotframework-zoomba\\src\\Zoomba\\MobileLibrary.py", "lineno": 245}, {"name": "Drag And Drop By Offset", "args": [{"name": "locator", "types": [], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "locator"}, {"name": "x_offset", "types": [], "defaultValue": "0", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "x_offset=0"}, {"name": "y_offset", "types": [], "defaultValue": "0", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "y_offset=0"}], "doc": "<p>Drags the element found with <code>locator</code> to the given <code>x_offset</code> and <code>y_offset</code> coordinates.</p>", "shortdoc": "Drags the element found with ``locator`` to the given ``x_offset`` and ``y_offset`` coordinates.", "tags": [], "source": "C:\\Git\\robotframework-zoomba\\src\\Zoomba\\MobileLibrary.py", "lineno": 251}, {"name": "Element Attribute Should Match", "args": [{"name": "locator", "types": [], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "locator"}, {"name": "attr_name", "types": [], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "attr_name"}, {"name": "match_pattern", "types": [], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "match_pattern"}, {"name": "regexp", "types": [], "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:\\Python\\lib\\site-packages\\AppiumLibrary\\keywords\\_element.py", "lineno": 205}, {"name": "Element Name Should Be", "args": [{"name": "locator", "types": [], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "locator"}, {"name": "expected", "types": [], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "expected"}], "doc": "", "shortdoc": "", "tags": [], "source": "C:\\Python\\lib\\site-packages\\AppiumLibrary\\keywords\\_element.py", "lineno": 191}, {"name": "Element Should Be Disabled", "args": [{"name": "locator", "types": [], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "locator"}, {"name": "loglevel", "types": [], "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:\\Python\\lib\\site-packages\\AppiumLibrary\\keywords\\_element.py", "lineno": 154}, {"name": "Element Should Be Enabled", "args": [{"name": "locator", "types": [], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "locator"}, {"name": "loglevel", "types": [], "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:\\Python\\lib\\site-packages\\AppiumLibrary\\keywords\\_element.py", "lineno": 166}, {"name": "Element Should Be Visible", "args": [{"name": "locator", "types": [], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "locator"}, {"name": "loglevel", "types": [], "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:\\Python\\lib\\site-packages\\AppiumLibrary\\keywords\\_element.py", "lineno": 178}, {"name": "Element Should Contain Text", "args": [{"name": "locator", "types": [], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "locator"}, {"name": "expected", "types": [], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "expected"}, {"name": "message", "types": [], "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:\\Python\\lib\\site-packages\\AppiumLibrary\\keywords\\_element.py", "lineno": 285}, {"name": "Element Should Not Contain Text", "args": [{"name": "locator", "types": [], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "locator"}, {"name": "expected", "types": [], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "expected"}, {"name": "message", "types": [], "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:\\Python\\lib\\site-packages\\AppiumLibrary\\keywords\\_element.py", "lineno": 304}, {"name": "Element Text Should Be", "args": [{"name": "locator", "types": [], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "locator"}, {"name": "expected", "types": [], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "expected"}, {"name": "message", "types": [], "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:\\Python\\lib\\site-packages\\AppiumLibrary\\keywords\\_element.py", "lineno": 319}, {"name": "Element Value Should Be", "args": [{"name": "locator", "types": [], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "locator"}, {"name": "expected", "types": [], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "expected"}], "doc": "", "shortdoc": "", "tags": [], "source": "C:\\Python\\lib\\site-packages\\AppiumLibrary\\keywords\\_element.py", "lineno": 198}, {"name": "Execute Adb Shell", "args": [{"name": "command", "types": [], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "command"}, {"name": "args", "types": [], "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:\\Python\\lib\\site-packages\\AppiumLibrary\\keywords\\_applicationmanagement.py", "lineno": 217}, {"name": "Execute Async Script", "args": [{"name": "script", "types": [], "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:\\Python\\lib\\site-packages\\AppiumLibrary\\keywords\\_applicationmanagement.py", "lineno": 201}, {"name": "Execute Script", "args": [{"name": "script", "types": [], "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:\\Python\\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:\\Python\\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:\\Python\\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:\\Python\\lib\\site-packages\\AppiumLibrary\\keywords\\_applicationmanagement.py", "lineno": 137}, {"name": "Get Capability", "args": [{"name": "capability_name", "types": [], "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:\\Python\\lib\\site-packages\\AppiumLibrary\\keywords\\_applicationmanagement.py", "lineno": 335}, {"name": "Get Contexts", "args": [], "doc": "<p>Get available contexts.</p>", "shortdoc": "Get available contexts.", "tags": [], "source": "C:\\Python\\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:\\Python\\lib\\site-packages\\AppiumLibrary\\keywords\\_applicationmanagement.py", "lineno": 288}, {"name": "Get Element Attribute", "args": [{"name": "locator", "types": [], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "locator"}, {"name": "attribute", "types": [], "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:\\Python\\lib\\site-packages\\AppiumLibrary\\keywords\\_element.py", "lineno": 365}, {"name": "Get Element Location", "args": [{"name": "locator", "types": [], "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:\\Python\\lib\\site-packages\\AppiumLibrary\\keywords\\_element.py", "lineno": 387}, {"name": "Get Element Size", "args": [{"name": "locator", "types": [], "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:\\Python\\lib\\site-packages\\AppiumLibrary\\keywords\\_element.py", "lineno": 398}, {"name": "Get Matching Xpath Count", "args": [{"name": "xpath", "types": [], "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:\\Python\\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:\\Python\\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:\\Python\\lib\\site-packages\\AppiumLibrary\\keywords\\_applicationmanagement.py", "lineno": 168}, {"name": "Get Text", "args": [{"name": "locator", "types": [], "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:\\Python\\lib\\site-packages\\AppiumLibrary\\keywords\\_element.py", "lineno": 409}, {"name": "Get Webelement", "args": [{"name": "locator", "types": [], "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:\\Python\\lib\\site-packages\\AppiumLibrary\\keywords\\_element.py", "lineno": 339}, {"name": "Get Webelements", "args": [{"name": "locator", "types": [], "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:\\Python\\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:\\Python\\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:\\Python\\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:\\Python\\lib\\site-packages\\AppiumLibrary\\keywords\\_applicationmanagement.py", "lineno": 235}, {"name": "Go To Url", "args": [{"name": "url", "types": [], "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:\\Python\\lib\\site-packages\\AppiumLibrary\\keywords\\_applicationmanagement.py", "lineno": 325}, {"name": "Hide Keyboard", "args": [{"name": "key_name", "types": [], "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:\\Python\\lib\\site-packages\\AppiumLibrary\\keywords\\_element.py", "lineno": 90}, {"name": "Input Password", "args": [{"name": "locator", "types": [], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "locator"}, {"name": "text", "types": [], "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:\\Python\\lib\\site-packages\\AppiumLibrary\\keywords\\_element.py", "lineno": 72}, {"name": "Input Text", "args": [{"name": "locator", "types": [], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "locator"}, {"name": "text", "types": [], "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:\\Python\\lib\\site-packages\\AppiumLibrary\\keywords\\_element.py", "lineno": 64}, {"name": "Input Value", "args": [{"name": "locator", "types": [], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "locator"}, {"name": "text", "types": [], "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:\\Python\\lib\\site-packages\\AppiumLibrary\\keywords\\_element.py", "lineno": 82}, {"name": "Install App", "args": [{"name": "app_path", "types": [], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "app_path"}, {"name": "app_package", "types": [], "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:\\Python\\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:\\Python\\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:\\Python\\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:\\Python\\lib\\site-packages\\AppiumLibrary\\keywords\\_applicationmanagement.py", "lineno": 84}, {"name": "Lock", "args": [{"name": "seconds", "types": [], "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:\\Python\\lib\\site-packages\\AppiumLibrary\\keywords\\_applicationmanagement.py", "lineno": 239}, {"name": "Log Source", "args": [{"name": "loglevel", "types": [], "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:\\Python\\lib\\site-packages\\AppiumLibrary\\keywords\\_applicationmanagement.py", "lineno": 172}, {"name": "Long Press", "args": [{"name": "locator", "types": [], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "locator"}, {"name": "duration", "types": [], "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:\\Python\\lib\\site-packages\\AppiumLibrary\\keywords\\_touch.py", "lineno": 112}, {"name": "Long Press Keycode", "args": [{"name": "keycode", "types": [], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "keycode"}, {"name": "metastate", "types": [], "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:\\Python\\lib\\site-packages\\AppiumLibrary\\keywords\\_keyevent.py", "lineno": 35}, {"name": "Open Application", "args": [{"name": "remote_url", "types": [], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "remote_url"}, {"name": "alias", "types": [], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "alias=None"}, {"name": "kwargs", "types": [], "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:\\Python\\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:\\Python\\lib\\site-packages\\AppiumLibrary\\keywords\\_android_utils.py", "lineno": 11}, {"name": "Page Should Contain Element", "args": [{"name": "locator", "types": [], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "locator"}, {"name": "loglevel", "types": [], "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:\\Python\\lib\\site-packages\\AppiumLibrary\\keywords\\_element.py", "lineno": 129}, {"name": "Page Should Contain Text", "args": [{"name": "text", "types": [], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "text"}, {"name": "loglevel", "types": [], "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:\\Python\\lib\\site-packages\\AppiumLibrary\\keywords\\_element.py", "lineno": 104}, {"name": "Page Should Not Contain Element", "args": [{"name": "locator", "types": [], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "locator"}, {"name": "loglevel", "types": [], "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:\\Python\\lib\\site-packages\\AppiumLibrary\\keywords\\_element.py", "lineno": 142}, {"name": "Page Should Not Contain Text", "args": [{"name": "text", "types": [], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "text"}, {"name": "loglevel", "types": [], "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:\\Python\\lib\\site-packages\\AppiumLibrary\\keywords\\_element.py", "lineno": 117}, {"name": "Pinch", "args": [{"name": "locator", "types": [], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "locator"}, {"name": "percent", "types": [], "defaultValue": "200%", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "percent=200%"}, {"name": "steps", "types": [], "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:\\Python\\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:\\Python\\lib\\site-packages\\AppiumLibrary\\keywords\\_applicationmanagement.py", "lineno": 276}, {"name": "Press Keycode", "args": [{"name": "keycode", "types": [], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "keycode"}, {"name": "metastate", "types": [], "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:\\Python\\lib\\site-packages\\AppiumLibrary\\keywords\\_keyevent.py", "lineno": 9}, {"name": "Pull File", "args": [{"name": "path", "types": [], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "path"}, {"name": "decode", "types": [], "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:\\Python\\lib\\site-packages\\AppiumLibrary\\keywords\\_android_utils.py", "lineno": 45}, {"name": "Pull Folder", "args": [{"name": "path", "types": [], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "path"}, {"name": "decode", "types": [], "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:\\Python\\lib\\site-packages\\AppiumLibrary\\keywords\\_android_utils.py", "lineno": 59}, {"name": "Push File", "args": [{"name": "path", "types": [], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "path"}, {"name": "data", "types": [], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "data"}, {"name": "encode", "types": [], "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:\\Python\\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:\\Python\\lib\\site-packages\\AppiumLibrary\\keywords\\_applicationmanagement.py", "lineno": 110}, {"name": "Register Keyword To Run On Failure", "args": [{"name": "keyword", "types": [], "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:\\Python\\lib\\site-packages\\AppiumLibrary\\keywords\\_runonfailure.py", "lineno": 17}, {"name": "Remove Application", "args": [{"name": "application_id", "types": [], "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:\\Python\\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:\\Python\\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-zoomba\\src\\Zoomba\\MobileLibrary.py", "lineno": 316}, {"name": "Scroll", "args": [{"name": "start_locator", "types": [], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "start_locator"}, {"name": "end_locator", "types": [], "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:\\Python\\lib\\site-packages\\AppiumLibrary\\keywords\\_touch.py", "lineno": 89}, {"name": "Scroll Down", "args": [{"name": "locator", "types": [], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "locator"}], "doc": "<p>Scrolls down to element</p>", "shortdoc": "Scrolls down to element", "tags": [], "source": "C:\\Python\\lib\\site-packages\\AppiumLibrary\\keywords\\_touch.py", "lineno": 100}, {"name": "Scroll Down To Text", "args": [{"name": "text", "types": [], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "text"}, {"name": "swipe_count", "types": [], "defaultValue": "20", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "swipe_count=20"}], "doc": "<p>Scrolls down to <code>text</code> using small swipes. The <code>swipe_count</code> defaults to 20.</p>", "shortdoc": "Scrolls down to ``text`` using small swipes. The ``swipe_count`` defaults to 20.", "tags": [], "source": "C:\\Git\\robotframework-zoomba\\src\\Zoomba\\MobileLibrary.py", "lineno": 258}, {"name": "Scroll Up", "args": [{"name": "locator", "types": [], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "locator"}], "doc": "<p>Scrolls up to element</p>", "shortdoc": "Scrolls up to element", "tags": [], "source": "C:\\Python\\lib\\site-packages\\AppiumLibrary\\keywords\\_touch.py", "lineno": 106}, {"name": "Scroll Up To Text", "args": [{"name": "text", "types": [], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "text"}, {"name": "swipe_count", "types": [], "defaultValue": "20", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "swipe_count=20"}], "doc": "<p>Scrolls down to <code>text</code> using small swipes. The <code>swipe_count</code> defaults to 20.</p>", "shortdoc": "Scrolls down to ``text`` using small swipes. The ``swipe_count`` defaults to 20.", "tags": [], "source": "C:\\Git\\robotframework-zoomba\\src\\Zoomba\\MobileLibrary.py", "lineno": 271}, {"name": "Set Appium Timeout", "args": [{"name": "seconds", "types": [], "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:\\Python\\lib\\site-packages\\AppiumLibrary\\keywords\\_applicationmanagement.py", "lineno": 143}, {"name": "Set Location", "args": [{"name": "latitude", "types": [], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "latitude"}, {"name": "longitude", "types": [], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "longitude"}, {"name": "altitude", "types": [], "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:\\Python\\lib\\site-packages\\AppiumLibrary\\keywords\\_android_utils.py", "lineno": 168}, {"name": "Set Network Connection Status", "args": [{"name": "connectionStatus", "types": [], "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:\\Python\\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:\\Python\\lib\\site-packages\\AppiumLibrary\\keywords\\_applicationmanagement.py", "lineno": 270}, {"name": "Start Activity", "args": [{"name": "appPackage", "types": [], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "appPackage"}, {"name": "appActivity", "types": [], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "appActivity"}, {"name": "opts", "types": [], "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:\\Python\\lib\\site-packages\\AppiumLibrary\\keywords\\_android_utils.py", "lineno": 97}, {"name": "Start Screen Recording", "args": [{"name": "timeLimit", "types": [], "defaultValue": "180s", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "timeLimit=180s"}, {"name": "options", "types": [], "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:\\Python\\lib\\site-packages\\AppiumLibrary\\keywords\\_screenrecord.py", "lineno": 16}, {"name": "Stop Screen Recording", "args": [{"name": "filename", "types": [], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "filename=None"}, {"name": "options", "types": [], "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:\\Python\\lib\\site-packages\\AppiumLibrary\\keywords\\_screenrecord.py", "lineno": 68}, {"name": "Swipe", "args": [{"name": "start_x", "types": [], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "start_x"}, {"name": "start_y", "types": [], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "start_y"}, {"name": "offset_x", "types": [], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "offset_x"}, {"name": "offset_y", "types": [], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "offset_y"}, {"name": "duration", "types": [], "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:\\Python\\lib\\site-packages\\AppiumLibrary\\keywords\\_touch.py", "lineno": 31}, {"name": "Swipe By Percent", "args": [{"name": "start_x", "types": [], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "start_x"}, {"name": "start_y", "types": [], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "start_y"}, {"name": "end_x", "types": [], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "end_x"}, {"name": "end_y", "types": [], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "end_y"}, {"name": "duration", "types": [], "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:\\Python\\lib\\site-packages\\AppiumLibrary\\keywords\\_touch.py", "lineno": 55}, {"name": "Switch Application", "args": [{"name": "index_or_alias", "types": [], "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:\\Python\\lib\\site-packages\\AppiumLibrary\\keywords\\_applicationmanagement.py", "lineno": 58}, {"name": "Switch To Context", "args": [{"name": "context_name", "types": [], "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:\\Python\\lib\\site-packages\\AppiumLibrary\\keywords\\_applicationmanagement.py", "lineno": 321}, {"name": "Tap", "args": [{"name": "locator", "types": [], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "locator"}, {"name": "x_offset", "types": [], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "x_offset=None"}, {"name": "y_offset", "types": [], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "y_offset=None"}, {"name": "count", "types": [], "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:\\Python\\lib\\site-packages\\AppiumLibrary\\keywords\\_touch.py", "lineno": 119}, {"name": "Tap With Number Of Taps", "args": [{"name": "locator", "types": [], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "locator"}, {"name": "number_of_taps", "types": [], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "number_of_taps"}, {"name": "number_of_touches", "types": [], "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:\\Python\\lib\\site-packages\\AppiumLibrary\\keywords\\_touch.py", "lineno": 133}, {"name": "Text Should Be Visible", "args": [{"name": "text", "types": [], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "text"}, {"name": "exact_match", "types": [], "defaultValue": "False", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "exact_match=False"}, {"name": "loglevel", "types": [], "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:\\Python\\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:\\Python\\lib\\site-packages\\AppiumLibrary\\keywords\\_applicationmanagement.py", "lineno": 262}, {"name": "Touch Id", "args": [{"name": "match", "types": [], "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:\\Python\\lib\\site-packages\\AppiumLibrary\\keywords\\_applicationmanagement.py", "lineno": 252}, {"name": "Wait Activity", "args": [{"name": "activity", "types": [], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "activity"}, {"name": "timeout", "types": [], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "timeout"}, {"name": "interval", "types": [], "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:\\Python\\lib\\site-packages\\AppiumLibrary\\keywords\\_android_utils.py", "lineno": 138}, {"name": "Wait For And Clear Text", "args": [{"name": "locator", "types": [], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "locator"}, {"name": "timeout", "types": [], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "timeout=None"}, {"name": "error", "types": [], "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-zoomba\\src\\Zoomba\\MobileLibrary.py", "lineno": 88}, {"name": "Wait For And Click Button", "args": [{"name": "locator", "types": [], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "locator"}, {"name": "timeout", "types": [], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "timeout=None"}, {"name": "error", "types": [], "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-zoomba\\src\\Zoomba\\MobileLibrary.py", "lineno": 125}, {"name": "Wait For And Click Element", "args": [{"name": "locator", "types": [], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "locator"}, {"name": "timeout", "types": [], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "timeout=None"}, {"name": "error", "types": [], "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-zoomba\\src\\Zoomba\\MobileLibrary.py", "lineno": 100}, {"name": "Wait For And Click Text", "args": [{"name": "text", "types": [], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "text"}, {"name": "exact_match", "types": [], "defaultValue": "False", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "exact_match=False"}, {"name": "timeout", "types": [], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "timeout=None"}, {"name": "error", "types": [], "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-zoomba\\src\\Zoomba\\MobileLibrary.py", "lineno": 112}, {"name": "Wait For And Input Password", "args": [{"name": "locator", "types": [], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "locator"}, {"name": "text", "types": [], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "text"}, {"name": "timeout", "types": [], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "timeout=None"}, {"name": "error", "types": [], "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-zoomba\\src\\Zoomba\\MobileLibrary.py", "lineno": 137}, {"name": "Wait For And Input Text", "args": [{"name": "locator", "types": [], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "locator"}, {"name": "text", "types": [], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "text"}, {"name": "timeout", "types": [], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "timeout=None"}, {"name": "error", "types": [], "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-zoomba\\src\\Zoomba\\MobileLibrary.py", "lineno": 150}, {"name": "Wait For And Input Value", "args": [{"name": "locator", "types": [], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "locator"}, {"name": "value", "types": [], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "value"}, {"name": "timeout", "types": [], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "timeout=None"}, {"name": "error", "types": [], "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-zoomba\\src\\Zoomba\\MobileLibrary.py", "lineno": 162}, {"name": "Wait For And Long Press", "args": [{"name": "locator", "types": [], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "locator"}, {"name": "duration", "types": [], "defaultValue": "5000", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "duration=5000"}, {"name": "timeout", "types": [], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "timeout=None"}, {"name": "error", "types": [], "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-zoomba\\src\\Zoomba\\MobileLibrary.py", "lineno": 176}, {"name": "Wait For And Tap", "args": [{"name": "locator", "types": [], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "locator"}, {"name": "x_offset", "types": [], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "x_offset=None"}, {"name": "y_offset", "types": [], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "y_offset=None"}, {"name": "count", "types": [], "defaultValue": "1", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "count=1"}, {"name": "timeout", "types": [], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "timeout=None"}, {"name": "error", "types": [], "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-zoomba\\src\\Zoomba\\MobileLibrary.py", "lineno": 284}, {"name": "Wait Until Element Contains", "args": [{"name": "locator", "types": [], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "locator"}, {"name": "text", "types": [], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "text"}, {"name": "timeout", "types": [], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "timeout=None"}, {"name": "error", "types": [], "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-zoomba\\src\\Zoomba\\MobileLibrary.py", "lineno": 188}, {"name": "Wait Until Element Does Not Contain", "args": [{"name": "locator", "types": [], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "locator"}, {"name": "text", "types": [], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "text"}, {"name": "timeout", "types": [], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "timeout=None"}, {"name": "error", "types": [], "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-zoomba\\src\\Zoomba\\MobileLibrary.py", "lineno": 203}, {"name": "Wait Until Element Is Disabled", "args": [{"name": "locator", "types": [], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "locator"}, {"name": "timeout", "types": [], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "timeout=None"}, {"name": "error", "types": [], "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-zoomba\\src\\Zoomba\\MobileLibrary.py", "lineno": 232}, {"name": "Wait Until Element Is Enabled", "args": [{"name": "locator", "types": [], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "locator"}, {"name": "timeout", "types": [], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "timeout=None"}, {"name": "error", "types": [], "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-zoomba\\src\\Zoomba\\MobileLibrary.py", "lineno": 219}, {"name": "Wait Until Element Is Visible", "args": [{"name": "locator", "types": [], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "locator"}, {"name": "timeout", "types": [], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "timeout=None"}, {"name": "error", "types": [], "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:\\Python\\lib\\site-packages\\AppiumLibrary\\keywords\\_waiting.py", "lineno": 7}, {"name": "Wait Until Page Contains", "args": [{"name": "text", "types": [], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "text"}, {"name": "timeout", "types": [], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "timeout=None"}, {"name": "error", "types": [], "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:\\Python\\lib\\site-packages\\AppiumLibrary\\keywords\\_waiting.py", "lineno": 30}, {"name": "Wait Until Page Contains Element", "args": [{"name": "locator", "types": [], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "locator"}, {"name": "timeout", "types": [], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "timeout=None"}, {"name": "error", "types": [], "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:\\Python\\lib\\site-packages\\AppiumLibrary\\keywords\\_waiting.py", "lineno": 72}, {"name": "Wait Until Page Does Not Contain", "args": [{"name": "text", "types": [], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "text"}, {"name": "timeout", "types": [], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "timeout=None"}, {"name": "error", "types": [], "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:\\Python\\lib\\site-packages\\AppiumLibrary\\keywords\\_waiting.py", "lineno": 48}, {"name": "Wait Until Page Does Not Contain Element", "args": [{"name": "locator", "types": [], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "locator"}, {"name": "timeout", "types": [], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "timeout=None"}, {"name": "error", "types": [], "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:\\Python\\lib\\site-packages\\AppiumLibrary\\keywords\\_waiting.py", "lineno": 90}, {"name": "Xpath Should Match X Times", "args": [{"name": "xpath", "types": [], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "xpath"}, {"name": "count", "types": [], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "count"}, {"name": "error", "types": [], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "error=None"}, {"name": "loglevel", "types": [], "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:\\Python\\lib\\site-packages\\AppiumLibrary\\keywords\\_element.py", "lineno": 450}, {"name": "Zoom", "args": [{"name": "locator", "types": [], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "locator"}, {"name": "percent", "types": [], "defaultValue": "200%", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "percent=200%"}, {"name": "steps", "types": [], "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:\\Python\\lib\\site-packages\\AppiumLibrary\\keywords\\_touch.py", "lineno": 15}], "dataTypes": {"enums": [], "typedDicts": []}}
+libdoc = {"name": "Mobile_Library", "doc": "<p>Zoomba 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": "2.9.1", "generated": "2021-05-14 11:20:39", "type": "LIBRARY", "scope": "GLOBAL", "docFormat": "HTML", "source": "C:\\Git\\robotframework-zoomba\\src\\Zoomba\\MobileLibrary.py", "lineno": 14, "tags": [], "inits": [{"name": "Init", "args": [{"name": "timeout", "types": [], "defaultValue": "5", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "timeout=5"}, {"name": "run_on_failure", "types": [], "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-zoomba\\src\\Zoomba\\MobileLibrary.py", "lineno": 71}], "keywords": [{"name": "Background App", "args": [{"name": "seconds", "types": [], "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:\\Python\\lib\\site-packages\\AppiumLibrary\\keywords\\_applicationmanagement.py", "lineno": 245}, {"name": "Capture Page Screenshot", "args": [{"name": "filename", "types": [], "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-zoomba\\src\\Zoomba\\MobileLibrary.py", "lineno": 297}, {"name": "Clear Text", "args": [{"name": "locator", "types": [], "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:\\Python\\lib\\site-packages\\AppiumLibrary\\keywords\\_element.py", "lineno": 27}, {"name": "Click A Point", "args": [{"name": "x", "types": [], "defaultValue": "0", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "x=0"}, {"name": "y", "types": [], "defaultValue": "0", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "y=0"}, {"name": "duration", "types": [], "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:\\Python\\lib\\site-packages\\AppiumLibrary\\keywords\\_touch.py", "lineno": 145}, {"name": "Click Button", "args": [{"name": "index_or_name", "types": [], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "index_or_name"}], "doc": "<p>Click button</p>", "shortdoc": "Click button", "tags": [], "source": "C:\\Python\\lib\\site-packages\\AppiumLibrary\\keywords\\_element.py", "lineno": 44}, {"name": "Click Element", "args": [{"name": "locator", "types": [], "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:\\Python\\lib\\site-packages\\AppiumLibrary\\keywords\\_element.py", "lineno": 35}, {"name": "Click Element At Coordinates", "args": [{"name": "coordinate_X", "types": [], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "coordinate_X"}, {"name": "coordinate_Y", "types": [], "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:\\Python\\lib\\site-packages\\AppiumLibrary\\keywords\\_touch.py", "lineno": 155}, {"name": "Click Text", "args": [{"name": "text", "types": [], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "text"}, {"name": "exact_match", "types": [], "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:\\Python\\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:\\Python\\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:\\Python\\lib\\site-packages\\AppiumLibrary\\keywords\\_applicationmanagement.py", "lineno": 20}, {"name": "Drag And Drop", "args": [{"name": "source", "types": [], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "source"}, {"name": "target", "types": [], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "target"}], "doc": "<p>Drags the element found with the locator <code>source</code> to the element found with the locator <code>target</code>.</p>", "shortdoc": "Drags the element found with the locator ``source`` to the element found with the locator ``target``.", "tags": [], "source": "C:\\Git\\robotframework-zoomba\\src\\Zoomba\\MobileLibrary.py", "lineno": 245}, {"name": "Drag And Drop By Offset", "args": [{"name": "locator", "types": [], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "locator"}, {"name": "x_offset", "types": [], "defaultValue": "0", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "x_offset=0"}, {"name": "y_offset", "types": [], "defaultValue": "0", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "y_offset=0"}], "doc": "<p>Drags the element found with <code>locator</code> to the given <code>x_offset</code> and <code>y_offset</code> coordinates.</p>", "shortdoc": "Drags the element found with ``locator`` to the given ``x_offset`` and ``y_offset`` coordinates.", "tags": [], "source": "C:\\Git\\robotframework-zoomba\\src\\Zoomba\\MobileLibrary.py", "lineno": 251}, {"name": "Element Attribute Should Match", "args": [{"name": "locator", "types": [], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "locator"}, {"name": "attr_name", "types": [], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "attr_name"}, {"name": "match_pattern", "types": [], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "match_pattern"}, {"name": "regexp", "types": [], "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:\\Python\\lib\\site-packages\\AppiumLibrary\\keywords\\_element.py", "lineno": 205}, {"name": "Element Name Should Be", "args": [{"name": "locator", "types": [], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "locator"}, {"name": "expected", "types": [], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "expected"}], "doc": "", "shortdoc": "", "tags": [], "source": "C:\\Python\\lib\\site-packages\\AppiumLibrary\\keywords\\_element.py", "lineno": 191}, {"name": "Element Should Be Disabled", "args": [{"name": "locator", "types": [], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "locator"}, {"name": "loglevel", "types": [], "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:\\Python\\lib\\site-packages\\AppiumLibrary\\keywords\\_element.py", "lineno": 154}, {"name": "Element Should Be Enabled", "args": [{"name": "locator", "types": [], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "locator"}, {"name": "loglevel", "types": [], "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:\\Python\\lib\\site-packages\\AppiumLibrary\\keywords\\_element.py", "lineno": 166}, {"name": "Element Should Be Visible", "args": [{"name": "locator", "types": [], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "locator"}, {"name": "loglevel", "types": [], "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:\\Python\\lib\\site-packages\\AppiumLibrary\\keywords\\_element.py", "lineno": 178}, {"name": "Element Should Contain Text", "args": [{"name": "locator", "types": [], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "locator"}, {"name": "expected", "types": [], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "expected"}, {"name": "message", "types": [], "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:\\Python\\lib\\site-packages\\AppiumLibrary\\keywords\\_element.py", "lineno": 285}, {"name": "Element Should Not Contain Text", "args": [{"name": "locator", "types": [], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "locator"}, {"name": "expected", "types": [], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "expected"}, {"name": "message", "types": [], "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:\\Python\\lib\\site-packages\\AppiumLibrary\\keywords\\_element.py", "lineno": 304}, {"name": "Element Text Should Be", "args": [{"name": "locator", "types": [], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "locator"}, {"name": "expected", "types": [], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "expected"}, {"name": "message", "types": [], "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:\\Python\\lib\\site-packages\\AppiumLibrary\\keywords\\_element.py", "lineno": 319}, {"name": "Element Value Should Be", "args": [{"name": "locator", "types": [], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "locator"}, {"name": "expected", "types": [], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "expected"}], "doc": "", "shortdoc": "", "tags": [], "source": "C:\\Python\\lib\\site-packages\\AppiumLibrary\\keywords\\_element.py", "lineno": 198}, {"name": "Execute Adb Shell", "args": [{"name": "command", "types": [], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "command"}, {"name": "args", "types": [], "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:\\Python\\lib\\site-packages\\AppiumLibrary\\keywords\\_applicationmanagement.py", "lineno": 217}, {"name": "Execute Async Script", "args": [{"name": "script", "types": [], "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:\\Python\\lib\\site-packages\\AppiumLibrary\\keywords\\_applicationmanagement.py", "lineno": 201}, {"name": "Execute Script", "args": [{"name": "script", "types": [], "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:\\Python\\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:\\Python\\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:\\Python\\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:\\Python\\lib\\site-packages\\AppiumLibrary\\keywords\\_applicationmanagement.py", "lineno": 137}, {"name": "Get Capability", "args": [{"name": "capability_name", "types": [], "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:\\Python\\lib\\site-packages\\AppiumLibrary\\keywords\\_applicationmanagement.py", "lineno": 335}, {"name": "Get Contexts", "args": [], "doc": "<p>Get available contexts.</p>", "shortdoc": "Get available contexts.", "tags": [], "source": "C:\\Python\\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:\\Python\\lib\\site-packages\\AppiumLibrary\\keywords\\_applicationmanagement.py", "lineno": 288}, {"name": "Get Element Attribute", "args": [{"name": "locator", "types": [], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "locator"}, {"name": "attribute", "types": [], "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:\\Python\\lib\\site-packages\\AppiumLibrary\\keywords\\_element.py", "lineno": 365}, {"name": "Get Element Location", "args": [{"name": "locator", "types": [], "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:\\Python\\lib\\site-packages\\AppiumLibrary\\keywords\\_element.py", "lineno": 387}, {"name": "Get Element Size", "args": [{"name": "locator", "types": [], "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:\\Python\\lib\\site-packages\\AppiumLibrary\\keywords\\_element.py", "lineno": 398}, {"name": "Get Matching Xpath Count", "args": [{"name": "xpath", "types": [], "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:\\Python\\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:\\Python\\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:\\Python\\lib\\site-packages\\AppiumLibrary\\keywords\\_applicationmanagement.py", "lineno": 168}, {"name": "Get Text", "args": [{"name": "locator", "types": [], "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:\\Python\\lib\\site-packages\\AppiumLibrary\\keywords\\_element.py", "lineno": 409}, {"name": "Get Webelement", "args": [{"name": "locator", "types": [], "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:\\Python\\lib\\site-packages\\AppiumLibrary\\keywords\\_element.py", "lineno": 339}, {"name": "Get Webelements", "args": [{"name": "locator", "types": [], "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:\\Python\\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:\\Python\\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:\\Python\\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:\\Python\\lib\\site-packages\\AppiumLibrary\\keywords\\_applicationmanagement.py", "lineno": 235}, {"name": "Go To Url", "args": [{"name": "url", "types": [], "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:\\Python\\lib\\site-packages\\AppiumLibrary\\keywords\\_applicationmanagement.py", "lineno": 325}, {"name": "Hide Keyboard", "args": [{"name": "key_name", "types": [], "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:\\Python\\lib\\site-packages\\AppiumLibrary\\keywords\\_element.py", "lineno": 90}, {"name": "Input Password", "args": [{"name": "locator", "types": [], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "locator"}, {"name": "text", "types": [], "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:\\Python\\lib\\site-packages\\AppiumLibrary\\keywords\\_element.py", "lineno": 72}, {"name": "Input Text", "args": [{"name": "locator", "types": [], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "locator"}, {"name": "text", "types": [], "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:\\Python\\lib\\site-packages\\AppiumLibrary\\keywords\\_element.py", "lineno": 64}, {"name": "Input Value", "args": [{"name": "locator", "types": [], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "locator"}, {"name": "text", "types": [], "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:\\Python\\lib\\site-packages\\AppiumLibrary\\keywords\\_element.py", "lineno": 82}, {"name": "Install App", "args": [{"name": "app_path", "types": [], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "app_path"}, {"name": "app_package", "types": [], "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:\\Python\\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:\\Python\\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:\\Python\\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:\\Python\\lib\\site-packages\\AppiumLibrary\\keywords\\_applicationmanagement.py", "lineno": 84}, {"name": "Lock", "args": [{"name": "seconds", "types": [], "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:\\Python\\lib\\site-packages\\AppiumLibrary\\keywords\\_applicationmanagement.py", "lineno": 239}, {"name": "Log Source", "args": [{"name": "loglevel", "types": [], "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:\\Python\\lib\\site-packages\\AppiumLibrary\\keywords\\_applicationmanagement.py", "lineno": 172}, {"name": "Long Press", "args": [{"name": "locator", "types": [], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "locator"}, {"name": "duration", "types": [], "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:\\Python\\lib\\site-packages\\AppiumLibrary\\keywords\\_touch.py", "lineno": 112}, {"name": "Long Press Keycode", "args": [{"name": "keycode", "types": [], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "keycode"}, {"name": "metastate", "types": [], "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:\\Python\\lib\\site-packages\\AppiumLibrary\\keywords\\_keyevent.py", "lineno": 35}, {"name": "Open Application", "args": [{"name": "remote_url", "types": [], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "remote_url"}, {"name": "alias", "types": [], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "alias=None"}, {"name": "kwargs", "types": [], "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:\\Python\\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:\\Python\\lib\\site-packages\\AppiumLibrary\\keywords\\_android_utils.py", "lineno": 11}, {"name": "Page Should Contain Element", "args": [{"name": "locator", "types": [], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "locator"}, {"name": "loglevel", "types": [], "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:\\Python\\lib\\site-packages\\AppiumLibrary\\keywords\\_element.py", "lineno": 129}, {"name": "Page Should Contain Text", "args": [{"name": "text", "types": [], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "text"}, {"name": "loglevel", "types": [], "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:\\Python\\lib\\site-packages\\AppiumLibrary\\keywords\\_element.py", "lineno": 104}, {"name": "Page Should Not Contain Element", "args": [{"name": "locator", "types": [], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "locator"}, {"name": "loglevel", "types": [], "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:\\Python\\lib\\site-packages\\AppiumLibrary\\keywords\\_element.py", "lineno": 142}, {"name": "Page Should Not Contain Text", "args": [{"name": "text", "types": [], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "text"}, {"name": "loglevel", "types": [], "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:\\Python\\lib\\site-packages\\AppiumLibrary\\keywords\\_element.py", "lineno": 117}, {"name": "Pinch", "args": [{"name": "locator", "types": [], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "locator"}, {"name": "percent", "types": [], "defaultValue": "200%", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "percent=200%"}, {"name": "steps", "types": [], "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:\\Python\\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:\\Python\\lib\\site-packages\\AppiumLibrary\\keywords\\_applicationmanagement.py", "lineno": 276}, {"name": "Press Keycode", "args": [{"name": "keycode", "types": [], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "keycode"}, {"name": "metastate", "types": [], "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:\\Python\\lib\\site-packages\\AppiumLibrary\\keywords\\_keyevent.py", "lineno": 9}, {"name": "Pull File", "args": [{"name": "path", "types": [], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "path"}, {"name": "decode", "types": [], "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:\\Python\\lib\\site-packages\\AppiumLibrary\\keywords\\_android_utils.py", "lineno": 45}, {"name": "Pull Folder", "args": [{"name": "path", "types": [], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "path"}, {"name": "decode", "types": [], "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:\\Python\\lib\\site-packages\\AppiumLibrary\\keywords\\_android_utils.py", "lineno": 59}, {"name": "Push File", "args": [{"name": "path", "types": [], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "path"}, {"name": "data", "types": [], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "data"}, {"name": "encode", "types": [], "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:\\Python\\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:\\Python\\lib\\site-packages\\AppiumLibrary\\keywords\\_applicationmanagement.py", "lineno": 110}, {"name": "Register Keyword To Run On Failure", "args": [{"name": "keyword", "types": [], "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:\\Python\\lib\\site-packages\\AppiumLibrary\\keywords\\_runonfailure.py", "lineno": 17}, {"name": "Remove Application", "args": [{"name": "application_id", "types": [], "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:\\Python\\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:\\Python\\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-zoomba\\src\\Zoomba\\MobileLibrary.py", "lineno": 316}, {"name": "Scroll", "args": [{"name": "start_locator", "types": [], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "start_locator"}, {"name": "end_locator", "types": [], "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:\\Python\\lib\\site-packages\\AppiumLibrary\\keywords\\_touch.py", "lineno": 89}, {"name": "Scroll Down", "args": [{"name": "locator", "types": [], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "locator"}], "doc": "<p>Scrolls down to element</p>", "shortdoc": "Scrolls down to element", "tags": [], "source": "C:\\Python\\lib\\site-packages\\AppiumLibrary\\keywords\\_touch.py", "lineno": 100}, {"name": "Scroll Down To Text", "args": [{"name": "text", "types": [], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "text"}, {"name": "swipe_count", "types": [], "defaultValue": "20", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "swipe_count=20"}], "doc": "<p>Scrolls down to <code>text</code> using small swipes. The <code>swipe_count</code> defaults to 20.</p>", "shortdoc": "Scrolls down to ``text`` using small swipes. The ``swipe_count`` defaults to 20.", "tags": [], "source": "C:\\Git\\robotframework-zoomba\\src\\Zoomba\\MobileLibrary.py", "lineno": 258}, {"name": "Scroll Up", "args": [{"name": "locator", "types": [], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "locator"}], "doc": "<p>Scrolls up to element</p>", "shortdoc": "Scrolls up to element", "tags": [], "source": "C:\\Python\\lib\\site-packages\\AppiumLibrary\\keywords\\_touch.py", "lineno": 106}, {"name": "Scroll Up To Text", "args": [{"name": "text", "types": [], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "text"}, {"name": "swipe_count", "types": [], "defaultValue": "20", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "swipe_count=20"}], "doc": "<p>Scrolls down to <code>text</code> using small swipes. The <code>swipe_count</code> defaults to 20.</p>", "shortdoc": "Scrolls down to ``text`` using small swipes. The ``swipe_count`` defaults to 20.", "tags": [], "source": "C:\\Git\\robotframework-zoomba\\src\\Zoomba\\MobileLibrary.py", "lineno": 271}, {"name": "Set Appium Timeout", "args": [{"name": "seconds", "types": [], "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:\\Python\\lib\\site-packages\\AppiumLibrary\\keywords\\_applicationmanagement.py", "lineno": 143}, {"name": "Set Location", "args": [{"name": "latitude", "types": [], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "latitude"}, {"name": "longitude", "types": [], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "longitude"}, {"name": "altitude", "types": [], "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:\\Python\\lib\\site-packages\\AppiumLibrary\\keywords\\_android_utils.py", "lineno": 168}, {"name": "Set Network Connection Status", "args": [{"name": "connectionStatus", "types": [], "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:\\Python\\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:\\Python\\lib\\site-packages\\AppiumLibrary\\keywords\\_applicationmanagement.py", "lineno": 270}, {"name": "Start Activity", "args": [{"name": "appPackage", "types": [], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "appPackage"}, {"name": "appActivity", "types": [], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "appActivity"}, {"name": "opts", "types": [], "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:\\Python\\lib\\site-packages\\AppiumLibrary\\keywords\\_android_utils.py", "lineno": 97}, {"name": "Start Screen Recording", "args": [{"name": "timeLimit", "types": [], "defaultValue": "180s", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "timeLimit=180s"}, {"name": "options", "types": [], "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:\\Python\\lib\\site-packages\\AppiumLibrary\\keywords\\_screenrecord.py", "lineno": 16}, {"name": "Stop Screen Recording", "args": [{"name": "filename", "types": [], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "filename=None"}, {"name": "options", "types": [], "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:\\Python\\lib\\site-packages\\AppiumLibrary\\keywords\\_screenrecord.py", "lineno": 68}, {"name": "Swipe", "args": [{"name": "start_x", "types": [], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "start_x"}, {"name": "start_y", "types": [], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "start_y"}, {"name": "offset_x", "types": [], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "offset_x"}, {"name": "offset_y", "types": [], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "offset_y"}, {"name": "duration", "types": [], "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:\\Python\\lib\\site-packages\\AppiumLibrary\\keywords\\_touch.py", "lineno": 31}, {"name": "Swipe By Percent", "args": [{"name": "start_x", "types": [], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "start_x"}, {"name": "start_y", "types": [], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "start_y"}, {"name": "end_x", "types": [], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "end_x"}, {"name": "end_y", "types": [], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "end_y"}, {"name": "duration", "types": [], "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:\\Python\\lib\\site-packages\\AppiumLibrary\\keywords\\_touch.py", "lineno": 55}, {"name": "Switch Application", "args": [{"name": "index_or_alias", "types": [], "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:\\Python\\lib\\site-packages\\AppiumLibrary\\keywords\\_applicationmanagement.py", "lineno": 58}, {"name": "Switch To Context", "args": [{"name": "context_name", "types": [], "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:\\Python\\lib\\site-packages\\AppiumLibrary\\keywords\\_applicationmanagement.py", "lineno": 321}, {"name": "Tap", "args": [{"name": "locator", "types": [], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "locator"}, {"name": "x_offset", "types": [], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "x_offset=None"}, {"name": "y_offset", "types": [], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "y_offset=None"}, {"name": "count", "types": [], "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:\\Python\\lib\\site-packages\\AppiumLibrary\\keywords\\_touch.py", "lineno": 119}, {"name": "Tap With Number Of Taps", "args": [{"name": "locator", "types": [], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "locator"}, {"name": "number_of_taps", "types": [], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "number_of_taps"}, {"name": "number_of_touches", "types": [], "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:\\Python\\lib\\site-packages\\AppiumLibrary\\keywords\\_touch.py", "lineno": 133}, {"name": "Text Should Be Visible", "args": [{"name": "text", "types": [], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "text"}, {"name": "exact_match", "types": [], "defaultValue": "False", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "exact_match=False"}, {"name": "loglevel", "types": [], "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:\\Python\\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:\\Python\\lib\\site-packages\\AppiumLibrary\\keywords\\_applicationmanagement.py", "lineno": 262}, {"name": "Touch Id", "args": [{"name": "match", "types": [], "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:\\Python\\lib\\site-packages\\AppiumLibrary\\keywords\\_applicationmanagement.py", "lineno": 252}, {"name": "Wait Activity", "args": [{"name": "activity", "types": [], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "activity"}, {"name": "timeout", "types": [], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "timeout"}, {"name": "interval", "types": [], "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:\\Python\\lib\\site-packages\\AppiumLibrary\\keywords\\_android_utils.py", "lineno": 138}, {"name": "Wait For And Clear Text", "args": [{"name": "locator", "types": [], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "locator"}, {"name": "timeout", "types": [], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "timeout=None"}, {"name": "error", "types": [], "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-zoomba\\src\\Zoomba\\MobileLibrary.py", "lineno": 88}, {"name": "Wait For And Click Button", "args": [{"name": "locator", "types": [], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "locator"}, {"name": "timeout", "types": [], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "timeout=None"}, {"name": "error", "types": [], "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-zoomba\\src\\Zoomba\\MobileLibrary.py", "lineno": 125}, {"name": "Wait For And Click Element", "args": [{"name": "locator", "types": [], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "locator"}, {"name": "timeout", "types": [], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "timeout=None"}, {"name": "error", "types": [], "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-zoomba\\src\\Zoomba\\MobileLibrary.py", "lineno": 100}, {"name": "Wait For And Click Text", "args": [{"name": "text", "types": [], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "text"}, {"name": "exact_match", "types": [], "defaultValue": "False", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "exact_match=False"}, {"name": "timeout", "types": [], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "timeout=None"}, {"name": "error", "types": [], "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-zoomba\\src\\Zoomba\\MobileLibrary.py", "lineno": 112}, {"name": "Wait For And Input Password", "args": [{"name": "locator", "types": [], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "locator"}, {"name": "text", "types": [], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "text"}, {"name": "timeout", "types": [], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "timeout=None"}, {"name": "error", "types": [], "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-zoomba\\src\\Zoomba\\MobileLibrary.py", "lineno": 137}, {"name": "Wait For And Input Text", "args": [{"name": "locator", "types": [], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "locator"}, {"name": "text", "types": [], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "text"}, {"name": "timeout", "types": [], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "timeout=None"}, {"name": "error", "types": [], "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-zoomba\\src\\Zoomba\\MobileLibrary.py", "lineno": 150}, {"name": "Wait For And Input Value", "args": [{"name": "locator", "types": [], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "locator"}, {"name": "value", "types": [], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "value"}, {"name": "timeout", "types": [], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "timeout=None"}, {"name": "error", "types": [], "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-zoomba\\src\\Zoomba\\MobileLibrary.py", "lineno": 162}, {"name": "Wait For And Long Press", "args": [{"name": "locator", "types": [], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "locator"}, {"name": "duration", "types": [], "defaultValue": "5000", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "duration=5000"}, {"name": "timeout", "types": [], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "timeout=None"}, {"name": "error", "types": [], "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-zoomba\\src\\Zoomba\\MobileLibrary.py", "lineno": 176}, {"name": "Wait For And Tap", "args": [{"name": "locator", "types": [], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "locator"}, {"name": "x_offset", "types": [], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "x_offset=None"}, {"name": "y_offset", "types": [], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "y_offset=None"}, {"name": "count", "types": [], "defaultValue": "1", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "count=1"}, {"name": "timeout", "types": [], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "timeout=None"}, {"name": "error", "types": [], "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-zoomba\\src\\Zoomba\\MobileLibrary.py", "lineno": 284}, {"name": "Wait Until Element Contains", "args": [{"name": "locator", "types": [], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "locator"}, {"name": "text", "types": [], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "text"}, {"name": "timeout", "types": [], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "timeout=None"}, {"name": "error", "types": [], "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-zoomba\\src\\Zoomba\\MobileLibrary.py", "lineno": 188}, {"name": "Wait Until Element Does Not Contain", "args": [{"name": "locator", "types": [], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "locator"}, {"name": "text", "types": [], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "text"}, {"name": "timeout", "types": [], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "timeout=None"}, {"name": "error", "types": [], "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-zoomba\\src\\Zoomba\\MobileLibrary.py", "lineno": 203}, {"name": "Wait Until Element Is Disabled", "args": [{"name": "locator", "types": [], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "locator"}, {"name": "timeout", "types": [], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "timeout=None"}, {"name": "error", "types": [], "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-zoomba\\src\\Zoomba\\MobileLibrary.py", "lineno": 232}, {"name": "Wait Until Element Is Enabled", "args": [{"name": "locator", "types": [], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "locator"}, {"name": "timeout", "types": [], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "timeout=None"}, {"name": "error", "types": [], "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-zoomba\\src\\Zoomba\\MobileLibrary.py", "lineno": 219}, {"name": "Wait Until Element Is Visible", "args": [{"name": "locator", "types": [], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "locator"}, {"name": "timeout", "types": [], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "timeout=None"}, {"name": "error", "types": [], "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:\\Python\\lib\\site-packages\\AppiumLibrary\\keywords\\_waiting.py", "lineno": 7}, {"name": "Wait Until Page Contains", "args": [{"name": "text", "types": [], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "text"}, {"name": "timeout", "types": [], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "timeout=None"}, {"name": "error", "types": [], "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:\\Python\\lib\\site-packages\\AppiumLibrary\\keywords\\_waiting.py", "lineno": 30}, {"name": "Wait Until Page Contains Element", "args": [{"name": "locator", "types": [], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "locator"}, {"name": "timeout", "types": [], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "timeout=None"}, {"name": "error", "types": [], "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:\\Python\\lib\\site-packages\\AppiumLibrary\\keywords\\_waiting.py", "lineno": 72}, {"name": "Wait Until Page Does Not Contain", "args": [{"name": "text", "types": [], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "text"}, {"name": "timeout", "types": [], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "timeout=None"}, {"name": "error", "types": [], "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:\\Python\\lib\\site-packages\\AppiumLibrary\\keywords\\_waiting.py", "lineno": 48}, {"name": "Wait Until Page Does Not Contain Element", "args": [{"name": "locator", "types": [], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "locator"}, {"name": "timeout", "types": [], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "timeout=None"}, {"name": "error", "types": [], "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:\\Python\\lib\\site-packages\\AppiumLibrary\\keywords\\_waiting.py", "lineno": 90}, {"name": "Xpath Should Match X Times", "args": [{"name": "xpath", "types": [], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "xpath"}, {"name": "count", "types": [], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "count"}, {"name": "error", "types": [], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "error=None"}, {"name": "loglevel", "types": [], "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:\\Python\\lib\\site-packages\\AppiumLibrary\\keywords\\_element.py", "lineno": 450}, {"name": "Zoom", "args": [{"name": "locator", "types": [], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "locator"}, {"name": "percent", "types": [], "defaultValue": "200%", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "percent=200%"}, {"name": "steps", "types": [], "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:\\Python\\lib\\site-packages\\AppiumLibrary\\keywords\\_touch.py", "lineno": 15}], "dataTypes": {"enums": [], "typedDicts": []}}
 </script>
 <title></title>
 </head>
diff --git a/docs/SOAPLibraryDocumentation.html b/docs/SOAPLibraryDocumentation.html
index 7169ee21..abfc125a 100644
--- a/docs/SOAPLibraryDocumentation.html
+++ b/docs/SOAPLibraryDocumentation.html
@@ -1101,7 +1101,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 = {"name": "SOAP_Library", "doc": "<p>Zoomba SOAP Library</p>\n<p>This class is the base Library used to generate automated SOAP Tests in the Zoomba Automation Framework.</p>", "version": "2.9.0", "generated": "2021-05-12 09:19:41", "type": "LIBRARY", "scope": "TEST", "docFormat": "HTML", "source": "C:\\Git\\robotframework-zoomba\\src\\Zoomba\\SOAPLibrary.py", "lineno": 43, "tags": [], "inits": [], "keywords": [{"name": "Call Soap Method With List Object", "args": [{"name": "action", "types": [], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "action=None"}, {"name": "soap_object", "types": [], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "soap_object=None"}], "doc": "<p>Call Soap Method. Calls soap method with list object</p>\n<p>action: (string) SOAP Action to be called.</p>\n<p>soap_object: (list) Soap Object in list format, list must be ordered wrt schema</p>", "shortdoc": "Call Soap Method. Calls soap method with list object ", "tags": [], "source": "C:\\Git\\robotframework-zoomba\\src\\Zoomba\\SOAPLibrary.py", "lineno": 100}, {"name": "Call Soap Method With Object", "args": [{"name": "action", "types": [], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "action=None"}, {"name": "soap_object", "types": [], "defaultValue": null, "kind": "VAR_NAMED", "required": false, "repr": "**soap_object"}], "doc": "<p>Call Soap Method with dictionary object. Calls soap method</p>\n<p>action: (string) SOAP Action to be called.</p>\n<p>soap_object: (dict) Soap Object in dict format, dict must contain all required parts of schema object.</p>", "shortdoc": "Call Soap Method with dictionary object. Calls soap method ", "tags": [], "source": "C:\\Git\\robotframework-zoomba\\src\\Zoomba\\SOAPLibrary.py", "lineno": 110}, {"name": "Convert Soap Response To Json", "args": [{"name": "soap_response", "types": [], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "soap_response=None"}], "doc": "<p>Convert Soap Response To Dictionary: This keyword builds a dictionary from the sudsLibrary response</p>\n<p>json_actual_response: (request response object) The response from an API.</p>\n<p>return: There is no actual returned output, other than error messages when comparisons fail.</p>", "shortdoc": "Convert Soap Response To Dictionary: This keyword builds a dictionary from the sudsLibrary response", "tags": [], "source": "C:\\Git\\robotframework-zoomba\\src\\Zoomba\\SOAPLibrary.py", "lineno": 139}, {"name": "Create Soap Session", "args": [{"name": "host", "types": [], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "host=None"}, {"name": "endpoint", "types": [], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "endpoint=None"}, {"name": "alias", "types": [], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "alias=None"}, {"name": "kwargs", "types": [], "defaultValue": null, "kind": "VAR_NAMED", "required": false, "repr": "**kwargs"}], "doc": "<p>Create Soap Session. This Keyword utilizes the WSDL to create a soap client.</p>\n<p>host: (string) The host url.</p>\n<p>endpoint: (string) SOAP API endpoint containing the actions to be referenced.</p>\n<p>**kwargs: (optional) Parameters that could be included to add options to client creation. Current supported parameters are:</p>\n<p>set_location: http address</p>", "shortdoc": "Create Soap Session. This Keyword utilizes the WSDL to create a soap client.", "tags": [], "source": "C:\\Git\\robotframework-zoomba\\src\\Zoomba\\SOAPLibrary.py", "lineno": 68}, {"name": "Create Soap Session And Fix Wsdl", "args": [{"name": "host", "types": [], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "host=None"}, {"name": "endpoint", "types": [], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "endpoint=None"}, {"name": "alias", "types": [], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "alias=None"}, {"name": "kwargs", "types": [], "defaultValue": null, "kind": "VAR_NAMED", "required": false, "repr": "**kwargs"}], "doc": "<p>Create Soap Session. This Keyword utilizes the WSDL and directly accesses calls from sudsLibrary.</p>\n<p>host: (string) The host url.</p>\n<p>endpoint: (string) SOAP API endpoint containing the actions to be referenced.</p>\n<p>alias: (string} Sets the alias for the SudsLibrary Framework **kwargs: (optional) Parameters that could be included to add options to client creation. Current supported parameters are:</p>\n<p>set_location: http address</p>", "shortdoc": "Create Soap Session. This Keyword utilizes the WSDL and directly accesses calls from sudsLibrary.", "tags": [], "source": "C:\\Git\\robotframework-zoomba\\src\\Zoomba\\SOAPLibrary.py", "lineno": 51}, {"name": "Create Soap Session And Set Location", "args": [{"name": "host", "types": [], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "host=None"}, {"name": "endpoint", "types": [], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "endpoint=None"}, {"name": "alias", "types": [], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "alias=None"}, {"name": "set_location", "types": [], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "set_location=None"}, {"name": "fix", "types": [], "defaultValue": "False", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "fix=False"}], "doc": "<p>Create Soap Session and Set Location. In addition to the client creation, this keyword sets the location as specified.</p>\n<p>host: (string) The host url.</p>\n<p>endpoint: (string) SOAP API endpoint containing the actions to be referenced.</p>\n<p>set_location: (string) If set will overwrite the WSDL location with specified address.</p>\n<p>If set to None will replace location with host and endpoint specified</p>", "shortdoc": "Create Soap Session and Set Location. In addition to the client creation, this keyword sets the location as specified.", "tags": [], "source": "C:\\Git\\robotframework-zoomba\\src\\Zoomba\\SOAPLibrary.py", "lineno": 84}, {"name": "Create Wsdl Objects", "args": [{"name": "wsdl_type", "types": [], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "wsdl_type=None"}, {"name": "object_dict", "types": [], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "object_dict=None"}], "doc": "<p>Create Wsdl Objects. This Keyword utilizes the WSDL to create a WSDL object based on the information provided.</p>\n<p>wsdl_type: (string) Wsdl object to be created.</p>\n<p>object_dict: (dict) Python Dictionary containing values and nested dictionaries with construction similar to wsdl defined objects.</p>\n<p>return: (response object) Returns the SOAP client object.</p>", "shortdoc": "Create Wsdl Objects. This Keyword utilizes the WSDL to create a WSDL object based on the information provided.", "tags": [], "source": "C:\\Git\\robotframework-zoomba\\src\\Zoomba\\SOAPLibrary.py", "lineno": 125}], "dataTypes": {"enums": [], "typedDicts": []}}
+libdoc = {"name": "SOAP_Library", "doc": "<p>Zoomba SOAP Library</p>\n<p>This class is the base Library used to generate automated SOAP Tests in the Zoomba Automation Framework.</p>", "version": "2.9.1", "generated": "2021-05-14 11:20:39", "type": "LIBRARY", "scope": "TEST", "docFormat": "HTML", "source": "C:\\Git\\robotframework-zoomba\\src\\Zoomba\\SOAPLibrary.py", "lineno": 43, "tags": [], "inits": [], "keywords": [{"name": "Call Soap Method With List Object", "args": [{"name": "action", "types": [], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "action=None"}, {"name": "soap_object", "types": [], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "soap_object=None"}], "doc": "<p>Call Soap Method. Calls soap method with list object</p>\n<p>action: (string) SOAP Action to be called.</p>\n<p>soap_object: (list) Soap Object in list format, list must be ordered wrt schema</p>", "shortdoc": "Call Soap Method. Calls soap method with list object ", "tags": [], "source": "C:\\Git\\robotframework-zoomba\\src\\Zoomba\\SOAPLibrary.py", "lineno": 100}, {"name": "Call Soap Method With Object", "args": [{"name": "action", "types": [], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "action=None"}, {"name": "soap_object", "types": [], "defaultValue": null, "kind": "VAR_NAMED", "required": false, "repr": "**soap_object"}], "doc": "<p>Call Soap Method with dictionary object. Calls soap method</p>\n<p>action: (string) SOAP Action to be called.</p>\n<p>soap_object: (dict) Soap Object in dict format, dict must contain all required parts of schema object.</p>", "shortdoc": "Call Soap Method with dictionary object. Calls soap method ", "tags": [], "source": "C:\\Git\\robotframework-zoomba\\src\\Zoomba\\SOAPLibrary.py", "lineno": 110}, {"name": "Convert Soap Response To Json", "args": [{"name": "soap_response", "types": [], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "soap_response=None"}], "doc": "<p>Convert Soap Response To Dictionary: This keyword builds a dictionary from the sudsLibrary response</p>\n<p>json_actual_response: (request response object) The response from an API.</p>\n<p>return: There is no actual returned output, other than error messages when comparisons fail.</p>", "shortdoc": "Convert Soap Response To Dictionary: This keyword builds a dictionary from the sudsLibrary response", "tags": [], "source": "C:\\Git\\robotframework-zoomba\\src\\Zoomba\\SOAPLibrary.py", "lineno": 139}, {"name": "Create Soap Session", "args": [{"name": "host", "types": [], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "host=None"}, {"name": "endpoint", "types": [], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "endpoint=None"}, {"name": "alias", "types": [], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "alias=None"}, {"name": "kwargs", "types": [], "defaultValue": null, "kind": "VAR_NAMED", "required": false, "repr": "**kwargs"}], "doc": "<p>Create Soap Session. This Keyword utilizes the WSDL to create a soap client.</p>\n<p>host: (string) The host url.</p>\n<p>endpoint: (string) SOAP API endpoint containing the actions to be referenced.</p>\n<p>**kwargs: (optional) Parameters that could be included to add options to client creation. Current supported parameters are:</p>\n<p>set_location: http address</p>", "shortdoc": "Create Soap Session. This Keyword utilizes the WSDL to create a soap client.", "tags": [], "source": "C:\\Git\\robotframework-zoomba\\src\\Zoomba\\SOAPLibrary.py", "lineno": 68}, {"name": "Create Soap Session And Fix Wsdl", "args": [{"name": "host", "types": [], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "host=None"}, {"name": "endpoint", "types": [], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "endpoint=None"}, {"name": "alias", "types": [], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "alias=None"}, {"name": "kwargs", "types": [], "defaultValue": null, "kind": "VAR_NAMED", "required": false, "repr": "**kwargs"}], "doc": "<p>Create Soap Session. This Keyword utilizes the WSDL and directly accesses calls from sudsLibrary.</p>\n<p>host: (string) The host url.</p>\n<p>endpoint: (string) SOAP API endpoint containing the actions to be referenced.</p>\n<p>alias: (string} Sets the alias for the SudsLibrary Framework **kwargs: (optional) Parameters that could be included to add options to client creation. Current supported parameters are:</p>\n<p>set_location: http address</p>", "shortdoc": "Create Soap Session. This Keyword utilizes the WSDL and directly accesses calls from sudsLibrary.", "tags": [], "source": "C:\\Git\\robotframework-zoomba\\src\\Zoomba\\SOAPLibrary.py", "lineno": 51}, {"name": "Create Soap Session And Set Location", "args": [{"name": "host", "types": [], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "host=None"}, {"name": "endpoint", "types": [], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "endpoint=None"}, {"name": "alias", "types": [], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "alias=None"}, {"name": "set_location", "types": [], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "set_location=None"}, {"name": "fix", "types": [], "defaultValue": "False", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "fix=False"}], "doc": "<p>Create Soap Session and Set Location. In addition to the client creation, this keyword sets the location as specified.</p>\n<p>host: (string) The host url.</p>\n<p>endpoint: (string) SOAP API endpoint containing the actions to be referenced.</p>\n<p>set_location: (string) If set will overwrite the WSDL location with specified address.</p>\n<p>If set to None will replace location with host and endpoint specified</p>", "shortdoc": "Create Soap Session and Set Location. In addition to the client creation, this keyword sets the location as specified.", "tags": [], "source": "C:\\Git\\robotframework-zoomba\\src\\Zoomba\\SOAPLibrary.py", "lineno": 84}, {"name": "Create Wsdl Objects", "args": [{"name": "wsdl_type", "types": [], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "wsdl_type=None"}, {"name": "object_dict", "types": [], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "object_dict=None"}], "doc": "<p>Create Wsdl Objects. This Keyword utilizes the WSDL to create a WSDL object based on the information provided.</p>\n<p>wsdl_type: (string) Wsdl object to be created.</p>\n<p>object_dict: (dict) Python Dictionary containing values and nested dictionaries with construction similar to wsdl defined objects.</p>\n<p>return: (response object) Returns the SOAP client object.</p>", "shortdoc": "Create Wsdl Objects. This Keyword utilizes the WSDL to create a WSDL object based on the information provided.", "tags": [], "source": "C:\\Git\\robotframework-zoomba\\src\\Zoomba\\SOAPLibrary.py", "lineno": 125}], "dataTypes": {"enums": [], "typedDicts": []}}
 </script>
 <title></title>
 </head>
diff --git a/samples/GUITests.robot b/samples/GUITests.robot
index 600cf65d..bb7346ee 100644
--- a/samples/GUITests.robot
+++ b/samples/GUITests.robot
@@ -23,6 +23,14 @@ Wait for Keywords Test
     Wait For And Click Element               //a[@href='/robotframework/robotframework']
     Wait Until Page Contains Element         //div[@id='readme']
 
+Wait for Keywords Test With Password
+    [Setup]         Test Case Setup
+    [Teardown]      Close All Browsers
+    Wait For And Input Password      //input[@name='q']      robotframework
+    Press Keys                    //input[@name='q']      RETURN
+    Wait For And Click Element               //a[@href='/robotframework/robotframework']
+    Wait Until Page Contains Element         //div[@id='readme']
+
 Element Value Should Be Equal and not equal Test
     [Setup]         Test Case Setup        http://www.google.com
     [Teardown]      Close All Browsers
diff --git a/src/Zoomba/GUILibrary.py b/src/Zoomba/GUILibrary.py
index d4c2ce02..d55e4339 100644
--- a/src/Zoomba/GUILibrary.py
+++ b/src/Zoomba/GUILibrary.py
@@ -16,9 +16,9 @@
 
 zoomba = BuiltIn()
 zoomba_collections = Collections()
-
 SCREENSHOT_COUNTER = itertools.count()
 
+
 class GUILibrary(SeleniumLibrary):
     """Zoomba GUI Library
 
@@ -87,6 +87,18 @@ def wait_for_and_input_text(self, locator, text, timeout=None):
         self.wait_for_and_focus_on_element(locator, timeout)
         self.input_text(locator, text)
 
+    @keyword('Wait For And Input Password')
+    def wait_for_and_input_password(self, locator, password, timeout=None):
+        """This is a series of chained Selenium keywords, that tries to find a web element first, and then input text.
+        The password text is not printed displayed in logs.
+        If the element fails to typed into, it will scroll to the bottom of the page and try again.\n
+        locator: (string) A selenium locator(CSS, XPATH, ID, NAME, etc)\n
+        password: (string) Password text to be typed into the input field.
+        timeout: (float) Time in seconds to wait, will use global timeout if not set.
+        """
+        self.wait_for_and_focus_on_element(locator, timeout)
+        self.input_password(locator, password)
+
     @keyword("Wait For And Select Frame")
     def wait_for_and_select_frame(self, locator, timeout=None):
         """This is a series of chained Selenium keywords, that first waits until an iFrame exists in the page, and then
diff --git a/test/GUI/GUITests.robot b/test/GUI/GUITests.robot
index a2cd121d..17226563 100644
--- a/test/GUI/GUITests.robot
+++ b/test/GUI/GUITests.robot
@@ -22,6 +22,14 @@ Wait for Keywords Test
     wait for and click element               //a[@href='/robotframework/robotframework']
     wait until page contains element         //div[@id='readme']
 
+Wait for Keywords Test With Password
+    [Teardown]      Close All Browsers
+    Test Case Setup
+    wait for and input password      //input[@name='q']      robotframework
+    press keys                    //input[@name='q']      RETURN
+    wait for and click element               //a[@href='/robotframework/robotframework']
+    wait until page contains element         //div[@id='readme']
+
 Element value should be equal and not equal Test
     [Teardown]      Close All Browsers
     Test Case Setup    http://www.google.com
diff --git a/test/GUI/test_gui.py b/test/GUI/test_gui.py
index be960d2d..3cd5d88d 100644
--- a/test/GUI/test_gui.py
+++ b/test/GUI/test_gui.py
@@ -77,6 +77,18 @@ def test_wait_for_and_input_text_with_timeout(self):
         mock_gui.wait_for_and_focus_on_element.assert_called_with("some_locator", 5)
         mock_gui.input_text.assert_called_with("some_locator", "text")
 
+    def test_wait_for_and_input_password_simple(self):
+        mock_gui = Mock()
+        GUILibrary.wait_for_and_input_password(mock_gui, "some_locator", "text")
+        mock_gui.wait_for_and_focus_on_element.assert_called_with("some_locator", None)
+        mock_gui.input_password.assert_called_with("some_locator", "text")
+
+    def test_wait_for_and_input_password_with_timeout(self):
+        mock_gui = Mock()
+        GUILibrary.wait_for_and_input_password(mock_gui, "some_locator", "text", 5)
+        mock_gui.wait_for_and_focus_on_element.assert_called_with("some_locator", 5)
+        mock_gui.input_password.assert_called_with("some_locator", "text")
+
     def test_wait_for_and_select_frame_simple(self):
         mock_gui = Mock()
         GUILibrary.wait_for_and_select_frame(mock_gui, "some_locator")
diff --git a/version.py b/version.py
index 481582eb..450d53c9 100644
--- a/version.py
+++ b/version.py
@@ -1 +1 @@
-VERSION = "2.9.0"
+VERSION = "2.9.1"