docs/android_docs.md in appium_lib-0.5.12 vs docs/android_docs.md in appium_lib-0.5.13
- old
+ new
@@ -1,6 +1,6 @@
-##### [load_appium_txt](https://github.com/appium/ruby_lib/blob/891e003748038a006121c8a4e0c702c12c405799/lib/appium_lib/driver.rb#L12)
+##### [load_appium_txt](https://github.com/appium/ruby_lib/blob/89b0902ed94ed43d8a9f0e364463da77015dcfb7/lib/appium_lib/driver.rb#L12)
> def load_appium_txt opts
Load appium.txt (toml format) into system ENV
the basedir of this file + appium.txt is what's used
@@ -13,11 +13,11 @@
[nil]
--
-##### [default_wait](https://github.com/appium/ruby_lib/blob/891e003748038a006121c8a4e0c702c12c405799/lib/appium_lib/driver.rb#L354)
+##### [default_wait](https://github.com/appium/ruby_lib/blob/89b0902ed94ed43d8a9f0e364463da77015dcfb7/lib/appium_lib/driver.rb#L354)
> def default_wait
Returns the default client side wait.
This value is independent of what the server is using
@@ -26,99 +26,99 @@
[Integer]
--
-##### [app_path](https://github.com/appium/ruby_lib/blob/891e003748038a006121c8a4e0c702c12c405799/lib/appium_lib/driver.rb#L87)
+##### [app_path](https://github.com/appium/ruby_lib/blob/89b0902ed94ed43d8a9f0e364463da77015dcfb7/lib/appium_lib/driver.rb#L87)
> def app_path
Returns the value of attribute app_path
--
-##### [app_name](https://github.com/appium/ruby_lib/blob/891e003748038a006121c8a4e0c702c12c405799/lib/appium_lib/driver.rb#L87)
+##### [app_name](https://github.com/appium/ruby_lib/blob/89b0902ed94ed43d8a9f0e364463da77015dcfb7/lib/appium_lib/driver.rb#L87)
> def app_name
Returns the value of attribute app_name
--
-##### [selendroid](https://github.com/appium/ruby_lib/blob/891e003748038a006121c8a4e0c702c12c405799/lib/appium_lib/driver.rb#L87)
+##### [selendroid](https://github.com/appium/ruby_lib/blob/89b0902ed94ed43d8a9f0e364463da77015dcfb7/lib/appium_lib/driver.rb#L87)
> def selendroid
Returns the value of attribute selendroid
--
-##### [app_package](https://github.com/appium/ruby_lib/blob/891e003748038a006121c8a4e0c702c12c405799/lib/appium_lib/driver.rb#L87)
+##### [app_package](https://github.com/appium/ruby_lib/blob/89b0902ed94ed43d8a9f0e364463da77015dcfb7/lib/appium_lib/driver.rb#L87)
> def app_package
Returns the value of attribute app_package
--
-##### [app_activity](https://github.com/appium/ruby_lib/blob/891e003748038a006121c8a4e0c702c12c405799/lib/appium_lib/driver.rb#L87)
+##### [app_activity](https://github.com/appium/ruby_lib/blob/89b0902ed94ed43d8a9f0e364463da77015dcfb7/lib/appium_lib/driver.rb#L87)
> def app_activity
Returns the value of attribute app_activity
--
-##### [app_wait_activity](https://github.com/appium/ruby_lib/blob/891e003748038a006121c8a4e0c702c12c405799/lib/appium_lib/driver.rb#L87)
+##### [app_wait_activity](https://github.com/appium/ruby_lib/blob/89b0902ed94ed43d8a9f0e364463da77015dcfb7/lib/appium_lib/driver.rb#L87)
> def app_wait_activity
Returns the value of attribute app_wait_activity
--
-##### [sauce_username](https://github.com/appium/ruby_lib/blob/891e003748038a006121c8a4e0c702c12c405799/lib/appium_lib/driver.rb#L87)
+##### [sauce_username](https://github.com/appium/ruby_lib/blob/89b0902ed94ed43d8a9f0e364463da77015dcfb7/lib/appium_lib/driver.rb#L87)
> def sauce_username
Returns the value of attribute sauce_username
--
-##### [sauce_access_key](https://github.com/appium/ruby_lib/blob/891e003748038a006121c8a4e0c702c12c405799/lib/appium_lib/driver.rb#L87)
+##### [sauce_access_key](https://github.com/appium/ruby_lib/blob/89b0902ed94ed43d8a9f0e364463da77015dcfb7/lib/appium_lib/driver.rb#L87)
> def sauce_access_key
Returns the value of attribute sauce_access_key
--
-##### [port](https://github.com/appium/ruby_lib/blob/891e003748038a006121c8a4e0c702c12c405799/lib/appium_lib/driver.rb#L87)
+##### [port](https://github.com/appium/ruby_lib/blob/89b0902ed94ed43d8a9f0e364463da77015dcfb7/lib/appium_lib/driver.rb#L87)
> def port
Returns the value of attribute port
--
-##### [os](https://github.com/appium/ruby_lib/blob/891e003748038a006121c8a4e0c702c12c405799/lib/appium_lib/driver.rb#L87)
+##### [os](https://github.com/appium/ruby_lib/blob/89b0902ed94ed43d8a9f0e364463da77015dcfb7/lib/appium_lib/driver.rb#L87)
> def os
Returns the value of attribute os
--
-##### [debug](https://github.com/appium/ruby_lib/blob/891e003748038a006121c8a4e0c702c12c405799/lib/appium_lib/driver.rb#L87)
+##### [debug](https://github.com/appium/ruby_lib/blob/89b0902ed94ed43d8a9f0e364463da77015dcfb7/lib/appium_lib/driver.rb#L87)
> def debug
Returns the value of attribute debug
--
-##### [initialize](https://github.com/appium/ruby_lib/blob/891e003748038a006121c8a4e0c702c12c405799/lib/appium_lib/driver.rb#L117)
+##### [initialize](https://github.com/appium/ruby_lib/blob/89b0902ed94ed43d8a9f0e364463da77015dcfb7/lib/appium_lib/driver.rb#L117)
> def initialize opts={}
Creates a new driver.
@@ -153,19 +153,19 @@
[Driver]
--
-##### [status](https://github.com/appium/ruby_lib/blob/891e003748038a006121c8a4e0c702c12c405799/lib/appium_lib/driver.rb#L212)
+##### [status](https://github.com/appium/ruby_lib/blob/89b0902ed94ed43d8a9f0e364463da77015dcfb7/lib/appium_lib/driver.rb#L212)
> def status
Returns the status payload
--
-##### [server_version](https://github.com/appium/ruby_lib/blob/891e003748038a006121c8a4e0c702c12c405799/lib/appium_lib/driver.rb#L218)
+##### [server_version](https://github.com/appium/ruby_lib/blob/89b0902ed94ed43d8a9f0e364463da77015dcfb7/lib/appium_lib/driver.rb#L218)
> def server_version
Returns the server's version string
@@ -173,11 +173,11 @@
[String]
--
-##### [absolute_app_path](https://github.com/appium/ruby_lib/blob/891e003748038a006121c8a4e0c702c12c405799/lib/appium_lib/driver.rb#L259)
+##### [absolute_app_path](https://github.com/appium/ruby_lib/blob/89b0902ed94ed43d8a9f0e364463da77015dcfb7/lib/appium_lib/driver.rb#L259)
> def absolute_app_path
Converts environment variable APP_PATH to an absolute path.
@@ -185,11 +185,11 @@
[String] APP_PATH as an absolute path
--
-##### [server_url](https://github.com/appium/ruby_lib/blob/891e003748038a006121c8a4e0c702c12c405799/lib/appium_lib/driver.rb#L275)
+##### [server_url](https://github.com/appium/ruby_lib/blob/89b0902ed94ed43d8a9f0e364463da77015dcfb7/lib/appium_lib/driver.rb#L275)
> def server_url
Get the server url for sauce or local based on env vars.
@@ -197,11 +197,11 @@
[String] the server url
--
-##### [restart](https://github.com/appium/ruby_lib/blob/891e003748038a006121c8a4e0c702c12c405799/lib/appium_lib/driver.rb#L285)
+##### [restart](https://github.com/appium/ruby_lib/blob/89b0902ed94ed43d8a9f0e364463da77015dcfb7/lib/appium_lib/driver.rb#L285)
> def restart
Restarts the driver
@@ -209,11 +209,11 @@
[Driver] the driver
--
-##### [driver](https://github.com/appium/ruby_lib/blob/891e003748038a006121c8a4e0c702c12c405799/lib/appium_lib/driver.rb#L292)
+##### [driver](https://github.com/appium/ruby_lib/blob/89b0902ed94ed43d8a9f0e364463da77015dcfb7/lib/appium_lib/driver.rb#L292)
> def driver
Returns the driver
@@ -221,11 +221,11 @@
[Driver] the driver
--
-##### [screenshot](https://github.com/appium/ruby_lib/blob/891e003748038a006121c8a4e0c702c12c405799/lib/appium_lib/driver.rb#L302)
+##### [screenshot](https://github.com/appium/ruby_lib/blob/89b0902ed94ed43d8a9f0e364463da77015dcfb7/lib/appium_lib/driver.rb#L302)
> def screenshot png_save_path
Takes a png screenshot and saves to the target path.
@@ -239,11 +239,11 @@
[void]
--
-##### [driver_quit](https://github.com/appium/ruby_lib/blob/891e003748038a006121c8a4e0c702c12c405799/lib/appium_lib/driver.rb#L308)
+##### [driver_quit](https://github.com/appium/ruby_lib/blob/89b0902ed94ed43d8a9f0e364463da77015dcfb7/lib/appium_lib/driver.rb#L308)
> def driver_quit
Quits the driver
@@ -251,11 +251,11 @@
[void]
--
-##### [start_driver](https://github.com/appium/ruby_lib/blob/891e003748038a006121c8a4e0c702c12c405799/lib/appium_lib/driver.rb#L316)
+##### [start_driver](https://github.com/appium/ruby_lib/blob/89b0902ed94ed43d8a9f0e364463da77015dcfb7/lib/appium_lib/driver.rb#L316)
> def start_driver
Creates a new global driver and quits the old one if it exists.
@@ -263,19 +263,19 @@
[Selenium::WebDriver] the new global driver
--
-##### [no_wait](https://github.com/appium/ruby_lib/blob/891e003748038a006121c8a4e0c702c12c405799/lib/appium_lib/driver.rb#L340)
+##### [no_wait](https://github.com/appium/ruby_lib/blob/89b0902ed94ed43d8a9f0e364463da77015dcfb7/lib/appium_lib/driver.rb#L340)
> def no_wait
Set implicit wait to zero.
--
-##### [set_wait](https://github.com/appium/ruby_lib/blob/891e003748038a006121c8a4e0c702c12c405799/lib/appium_lib/driver.rb#L347)
+##### [set_wait](https://github.com/appium/ruby_lib/blob/89b0902ed94ed43d8a9f0e364463da77015dcfb7/lib/appium_lib/driver.rb#L347)
> def set_wait timeout=@default_wait
Set implicit wait to timeout, defaults to 30.
@@ -287,11 +287,11 @@
[void]
--
-##### [exists](https://github.com/appium/ruby_lib/blob/891e003748038a006121c8a4e0c702c12c405799/lib/appium_lib/driver.rb#L370)
+##### [exists](https://github.com/appium/ruby_lib/blob/89b0902ed94ed43d8a9f0e364463da77015dcfb7/lib/appium_lib/driver.rb#L370)
> def exists pre_check=0, post_check=@default_wait, &search_block
Returns existence of element.
@@ -313,11 +313,11 @@
[Boolean]
--
-##### [execute_script](https://github.com/appium/ruby_lib/blob/891e003748038a006121c8a4e0c702c12c405799/lib/appium_lib/driver.rb#L392)
+##### [execute_script](https://github.com/appium/ruby_lib/blob/89b0902ed94ed43d8a9f0e364463da77015dcfb7/lib/appium_lib/driver.rb#L392)
> def execute_script script, *args
The same as @driver.execute_script
@@ -331,11 +331,11 @@
[Object]
--
-##### [mobile](https://github.com/appium/ruby_lib/blob/891e003748038a006121c8a4e0c702c12c405799/lib/appium_lib/driver.rb#L408)
+##### [mobile](https://github.com/appium/ruby_lib/blob/89b0902ed94ed43d8a9f0e364463da77015dcfb7/lib/appium_lib/driver.rb#L408)
> def mobile method, *args
Helper method for mobile gestures
@@ -357,11 +357,11 @@
[Object]
--
-##### [find_elements](https://github.com/appium/ruby_lib/blob/891e003748038a006121c8a4e0c702c12c405799/lib/appium_lib/driver.rb#L419)
+##### [find_elements](https://github.com/appium/ruby_lib/blob/89b0902ed94ed43d8a9f0e364463da77015dcfb7/lib/appium_lib/driver.rb#L419)
> def find_elements *args
Calls @driver.find_elements
@@ -373,11 +373,11 @@
[Array<Element>] Array is empty when no elements are found.
--
-##### [find_element](https://github.com/appium/ruby_lib/blob/891e003748038a006121c8a4e0c702c12c405799/lib/appium_lib/driver.rb#L427)
+##### [find_element](https://github.com/appium/ruby_lib/blob/89b0902ed94ed43d8a9f0e364463da77015dcfb7/lib/appium_lib/driver.rb#L427)
> def find_element *args
Calls @driver.find_elements
@@ -389,11 +389,11 @@
[Element]
--
-##### [x](https://github.com/appium/ruby_lib/blob/891e003748038a006121c8a4e0c702c12c405799/lib/appium_lib/driver.rb#L434)
+##### [x](https://github.com/appium/ruby_lib/blob/89b0902ed94ed43d8a9f0e364463da77015dcfb7/lib/appium_lib/driver.rb#L434)
> def x
Quit the driver and Pry.
quit and exit are reserved by Pry.
@@ -402,11 +402,11 @@
[void]
--
-##### [wait](https://github.com/appium/ruby_lib/blob/891e003748038a006121c8a4e0c702c12c405799/lib/appium_lib/common/helper.rb#L33)
+##### [wait](https://github.com/appium/ruby_lib/blob/89b0902ed94ed43d8a9f0e364463da77015dcfb7/lib/appium_lib/common/helper.rb#L33)
> def wait max_wait=30, interval=0.5, &block
Check every 0.5 seconds to see if block.call doesn't raise an exception.
if .call raises an exception then it will be tried again.
@@ -429,19 +429,19 @@
[Object] the result of block.call
--
-##### [ignore](https://github.com/appium/ruby_lib/blob/891e003748038a006121c8a4e0c702c12c405799/lib/appium_lib/common/helper.rb#L45)
+##### [ignore](https://github.com/appium/ruby_lib/blob/89b0902ed94ed43d8a9f0e364463da77015dcfb7/lib/appium_lib/common/helper.rb#L45)
> def ignore &block
Return block.call and ignore any exceptions.
--
-##### [wait_true](https://github.com/appium/ruby_lib/blob/891e003748038a006121c8a4e0c702c12c405799/lib/appium_lib/common/helper.rb#L55)
+##### [wait_true](https://github.com/appium/ruby_lib/blob/89b0902ed94ed43d8a9f0e364463da77015dcfb7/lib/appium_lib/common/helper.rb#L55)
> def wait_true max_wait=30, interval=0.5, &block
Check every 0.5 seconds to see if block.call returns true. nil is considered a failure.
Give up after 30 seconds.
@@ -458,11 +458,11 @@
[Object] the result of block.call
--
-##### [id](https://github.com/appium/ruby_lib/blob/891e003748038a006121c8a4e0c702c12c405799/lib/appium_lib/common/helper.rb#L69)
+##### [id](https://github.com/appium/ruby_lib/blob/89b0902ed94ed43d8a9f0e364463da77015dcfb7/lib/appium_lib/common/helper.rb#L69)
> def id id
Find by id. Useful for selendroid
@@ -474,11 +474,11 @@
[Element]
--
-##### [back](https://github.com/appium/ruby_lib/blob/891e003748038a006121c8a4e0c702c12c405799/lib/appium_lib/common/helper.rb#L75)
+##### [back](https://github.com/appium/ruby_lib/blob/89b0902ed94ed43d8a9f0e364463da77015dcfb7/lib/appium_lib/common/helper.rb#L75)
> def back
Navigate back.
@@ -486,19 +486,19 @@
[void]
--
-##### [session_id](https://github.com/appium/ruby_lib/blob/891e003748038a006121c8a4e0c702c12c405799/lib/appium_lib/common/helper.rb#L80)
+##### [session_id](https://github.com/appium/ruby_lib/blob/89b0902ed94ed43d8a9f0e364463da77015dcfb7/lib/appium_lib/common/helper.rb#L80)
> def session_id
For Sauce Labs reporting. Returns the current session id.
--
-##### [xpath](https://github.com/appium/ruby_lib/blob/891e003748038a006121c8a4e0c702c12c405799/lib/appium_lib/common/helper.rb#L88)
+##### [xpath](https://github.com/appium/ruby_lib/blob/89b0902ed94ed43d8a9f0e364463da77015dcfb7/lib/appium_lib/common/helper.rb#L88)
> def xpath xpath_str
Returns the first element that matches the provided xpath.
@@ -510,11 +510,11 @@
[Element]
--
-##### [xpaths](https://github.com/appium/ruby_lib/blob/891e003748038a006121c8a4e0c702c12c405799/lib/appium_lib/common/helper.rb#L96)
+##### [xpaths](https://github.com/appium/ruby_lib/blob/89b0902ed94ed43d8a9f0e364463da77015dcfb7/lib/appium_lib/common/helper.rb#L96)
> def xpaths xpath_str
Returns all elements that match the provided xpath.
@@ -526,11 +526,11 @@
[Array<Element>]
--
-##### [ele_index](https://github.com/appium/ruby_lib/blob/891e003748038a006121c8a4e0c702c12c405799/lib/appium_lib/common/helper.rb#L104)
+##### [ele_index](https://github.com/appium/ruby_lib/blob/89b0902ed94ed43d8a9f0e364463da77015dcfb7/lib/appium_lib/common/helper.rb#L104)
> def ele_index tag_name, index
Get the element of type tag_name at matching index.
@@ -544,11 +544,11 @@
[Element] the found element of type tag_name
--
-##### [find_eles](https://github.com/appium/ruby_lib/blob/891e003748038a006121c8a4e0c702c12c405799/lib/appium_lib/common/helper.rb#L112)
+##### [find_eles](https://github.com/appium/ruby_lib/blob/89b0902ed94ed43d8a9f0e364463da77015dcfb7/lib/appium_lib/common/helper.rb#L112)
> def find_eles tag_name
Get all elements exactly matching tag name
@@ -560,11 +560,11 @@
[Array<Element>] the found elements of type tag_name
--
-##### [find_ele_by_text](https://github.com/appium/ruby_lib/blob/891e003748038a006121c8a4e0c702c12c405799/lib/appium_lib/common/helper.rb#L120)
+##### [find_ele_by_text](https://github.com/appium/ruby_lib/blob/89b0902ed94ed43d8a9f0e364463da77015dcfb7/lib/appium_lib/common/helper.rb#L120)
> def find_ele_by_text tag, text
Get the first tag that exactly matches tag and text.
@@ -578,11 +578,11 @@
[Element] the element of type tag exactly matching text
--
-##### [find_eles_by_text](https://github.com/appium/ruby_lib/blob/891e003748038a006121c8a4e0c702c12c405799/lib/appium_lib/common/helper.rb#L128)
+##### [find_eles_by_text](https://github.com/appium/ruby_lib/blob/89b0902ed94ed43d8a9f0e364463da77015dcfb7/lib/appium_lib/common/helper.rb#L128)
> def find_eles_by_text tag, text
Get all tags that exactly match tag and text.
@@ -596,11 +596,11 @@
[Array<Element>] the elements of type tag exactly matching text
--
-##### [find_ele_by_attr_include](https://github.com/appium/ruby_lib/blob/891e003748038a006121c8a4e0c702c12c405799/lib/appium_lib/common/helper.rb#L137)
+##### [find_ele_by_attr_include](https://github.com/appium/ruby_lib/blob/89b0902ed94ed43d8a9f0e364463da77015dcfb7/lib/appium_lib/common/helper.rb#L137)
> def find_ele_by_attr_include tag, attr, value
Get the first tag by attribute that exactly matches value.
@@ -616,11 +616,11 @@
[Element] the element of type tag who's attribute includes value
--
-##### [find_eles_by_attr_include](https://github.com/appium/ruby_lib/blob/891e003748038a006121c8a4e0c702c12c405799/lib/appium_lib/common/helper.rb#L146)
+##### [find_eles_by_attr_include](https://github.com/appium/ruby_lib/blob/89b0902ed94ed43d8a9f0e364463da77015dcfb7/lib/appium_lib/common/helper.rb#L146)
> def find_eles_by_attr_include tag, attr, value
Get tags by attribute that include value.
@@ -636,11 +636,11 @@
[Array<Element>] the elements of type tag who's attribute includes value
--
-##### [find_ele_by_text_include](https://github.com/appium/ruby_lib/blob/891e003748038a006121c8a4e0c702c12c405799/lib/appium_lib/common/helper.rb#L155)
+##### [find_ele_by_text_include](https://github.com/appium/ruby_lib/blob/89b0902ed94ed43d8a9f0e364463da77015dcfb7/lib/appium_lib/common/helper.rb#L155)
> def find_ele_by_text_include tag, text
Get the first tag that includes text.
element.attribute(:text).include? text
@@ -655,11 +655,11 @@
[Element] the element of type tag that includes text
--
-##### [find_eles_by_text_include](https://github.com/appium/ruby_lib/blob/891e003748038a006121c8a4e0c702c12c405799/lib/appium_lib/common/helper.rb#L164)
+##### [find_eles_by_text_include](https://github.com/appium/ruby_lib/blob/89b0902ed94ed43d8a9f0e364463da77015dcfb7/lib/appium_lib/common/helper.rb#L164)
> def find_eles_by_text_include tag, text
Get the tags that include text.
element.attribute(:text).include? text
@@ -674,11 +674,11 @@
[Array<Element>] the elements of type tag that includes text
--
-##### [first_ele](https://github.com/appium/ruby_lib/blob/891e003748038a006121c8a4e0c702c12c405799/lib/appium_lib/common/helper.rb#L171)
+##### [first_ele](https://github.com/appium/ruby_lib/blob/89b0902ed94ed43d8a9f0e364463da77015dcfb7/lib/appium_lib/common/helper.rb#L171)
> def first_ele tag_name
Get the first tag that matches tag_name
@@ -690,11 +690,11 @@
[Element]
--
-##### [last_ele](https://github.com/appium/ruby_lib/blob/891e003748038a006121c8a4e0c702c12c405799/lib/appium_lib/common/helper.rb#L179)
+##### [last_ele](https://github.com/appium/ruby_lib/blob/89b0902ed94ed43d8a9f0e364463da77015dcfb7/lib/appium_lib/common/helper.rb#L179)
> def last_ele tag_name
Get the last tag that matches tag_name
@@ -706,11 +706,11 @@
[Element]
--
-##### [source](https://github.com/appium/ruby_lib/blob/891e003748038a006121c8a4e0c702c12c405799/lib/appium_lib/common/helper.rb#L185)
+##### [source](https://github.com/appium/ruby_lib/blob/89b0902ed94ed43d8a9f0e364463da77015dcfb7/lib/appium_lib/common/helper.rb#L185)
> def source
Prints a JSON view of the current page
@@ -718,11 +718,11 @@
[void]
--
-##### [get_source](https://github.com/appium/ruby_lib/blob/891e003748038a006121c8a4e0c702c12c405799/lib/appium_lib/common/helper.rb#L191)
+##### [get_source](https://github.com/appium/ruby_lib/blob/89b0902ed94ed43d8a9f0e364463da77015dcfb7/lib/appium_lib/common/helper.rb#L191)
> def get_source
Gets a JSON view of the current page
@@ -730,11 +730,11 @@
[JSON]
--
-##### [find_name](https://github.com/appium/ruby_lib/blob/891e003748038a006121c8a4e0c702c12c405799/lib/appium_lib/common/helper.rb#L200)
+##### [find_name](https://github.com/appium/ruby_lib/blob/89b0902ed94ed43d8a9f0e364463da77015dcfb7/lib/appium_lib/common/helper.rb#L200)
> def find_name name
Returns the first element that exactly matches name
@@ -746,11 +746,11 @@
[Element]
--
-##### [find_names](https://github.com/appium/ruby_lib/blob/891e003748038a006121c8a4e0c702c12c405799/lib/appium_lib/common/helper.rb#L208)
+##### [find_names](https://github.com/appium/ruby_lib/blob/89b0902ed94ed43d8a9f0e364463da77015dcfb7/lib/appium_lib/common/helper.rb#L208)
> def find_names name
Returns all elements that exactly match name
@@ -762,11 +762,11 @@
[Array<Element>]
--
-##### [tag](https://github.com/appium/ruby_lib/blob/891e003748038a006121c8a4e0c702c12c405799/lib/appium_lib/common/helper.rb#L216)
+##### [tag](https://github.com/appium/ruby_lib/blob/89b0902ed94ed43d8a9f0e364463da77015dcfb7/lib/appium_lib/common/helper.rb#L216)
> def tag tag_name
Returns the first element matching tag_name
@@ -778,11 +778,11 @@
[Element]
--
-##### [s_texts](https://github.com/appium/ruby_lib/blob/891e003748038a006121c8a4e0c702c12c405799/lib/appium_lib/common/element/text.rb#L8)
+##### [s_texts](https://github.com/appium/ruby_lib/blob/89b0902ed94ed43d8a9f0e364463da77015dcfb7/lib/appium_lib/common/element/text.rb#L8)
> def s_texts
Get an array of text texts.
@@ -790,11 +790,11 @@
[Array<String>]
--
-##### [e_s_texts](https://github.com/appium/ruby_lib/blob/891e003748038a006121c8a4e0c702c12c405799/lib/appium_lib/common/element/text.rb#L14)
+##### [e_s_texts](https://github.com/appium/ruby_lib/blob/89b0902ed94ed43d8a9f0e364463da77015dcfb7/lib/appium_lib/common/element/text.rb#L14)
> def e_s_texts
Get an array of text elements.
@@ -802,11 +802,11 @@
[Array<Text>]
--
-##### [first_s_text](https://github.com/appium/ruby_lib/blob/891e003748038a006121c8a4e0c702c12c405799/lib/appium_lib/common/element/text.rb#L20)
+##### [first_s_text](https://github.com/appium/ruby_lib/blob/89b0902ed94ed43d8a9f0e364463da77015dcfb7/lib/appium_lib/common/element/text.rb#L20)
> def first_s_text
Get the first text element.
@@ -814,11 +814,11 @@
[Text]
--
-##### [last_s_text](https://github.com/appium/ruby_lib/blob/891e003748038a006121c8a4e0c702c12c405799/lib/appium_lib/common/element/text.rb#L26)
+##### [last_s_text](https://github.com/appium/ruby_lib/blob/89b0902ed94ed43d8a9f0e364463da77015dcfb7/lib/appium_lib/common/element/text.rb#L26)
> def last_s_text
Get the last text element
@@ -826,11 +826,11 @@
[Text]
--
-##### [s_text](https://github.com/appium/ruby_lib/blob/891e003748038a006121c8a4e0c702c12c405799/lib/appium_lib/common/element/text.rb#L33)
+##### [s_text](https://github.com/appium/ruby_lib/blob/89b0902ed94ed43d8a9f0e364463da77015dcfb7/lib/appium_lib/common/element/text.rb#L33)
> def s_text text
Get the first element that includes text.
@@ -842,11 +842,11 @@
[Text]
--
-##### [s_text_exact](https://github.com/appium/ruby_lib/blob/891e003748038a006121c8a4e0c702c12c405799/lib/appium_lib/common/element/text.rb#L41)
+##### [s_text_exact](https://github.com/appium/ruby_lib/blob/89b0902ed94ed43d8a9f0e364463da77015dcfb7/lib/appium_lib/common/element/text.rb#L41)
> def s_text_exact text
Get the first textfield that matches text.
@@ -858,19 +858,19 @@
[Text]
--
-##### [window_size](https://github.com/appium/ruby_lib/blob/891e003748038a006121c8a4e0c702c12c405799/lib/appium_lib/common/element/window.rb#L5)
+##### [window_size](https://github.com/appium/ruby_lib/blob/89b0902ed94ed43d8a9f0e364463da77015dcfb7/lib/appium_lib/common/element/window.rb#L5)
> def window_size
Get the window's size
--
-##### [button](https://github.com/appium/ruby_lib/blob/891e003748038a006121c8a4e0c702c12c405799/lib/appium_lib/common/element/button.rb#L8)
+##### [button](https://github.com/appium/ruby_lib/blob/89b0902ed94ed43d8a9f0e364463da77015dcfb7/lib/appium_lib/common/element/button.rb#L8)
> def button text, number=0
Find a button by text and optionally number.
@@ -884,11 +884,11 @@
[Button] the button found with text and matching number
--
-##### [buttons](https://github.com/appium/ruby_lib/blob/891e003748038a006121c8a4e0c702c12c405799/lib/appium_lib/common/element/button.rb#L19)
+##### [buttons](https://github.com/appium/ruby_lib/blob/89b0902ed94ed43d8a9f0e364463da77015dcfb7/lib/appium_lib/common/element/button.rb#L19)
> def buttons text=nil
Get an array of button texts or button elements if text is provided.
@@ -900,11 +900,11 @@
[Array<String>, Array<Buttons>] either an array of button texts or an array of button elements if text is provided.
--
-##### [first_button](https://github.com/appium/ruby_lib/blob/891e003748038a006121c8a4e0c702c12c405799/lib/appium_lib/common/element/button.rb#L26)
+##### [first_button](https://github.com/appium/ruby_lib/blob/89b0902ed94ed43d8a9f0e364463da77015dcfb7/lib/appium_lib/common/element/button.rb#L26)
> def first_button
Get the first button element.
@@ -912,11 +912,11 @@
[Button]
--
-##### [last_button](https://github.com/appium/ruby_lib/blob/891e003748038a006121c8a4e0c702c12c405799/lib/appium_lib/common/element/button.rb#L32)
+##### [last_button](https://github.com/appium/ruby_lib/blob/89b0902ed94ed43d8a9f0e364463da77015dcfb7/lib/appium_lib/common/element/button.rb#L32)
> def last_button
Get the last button element.
@@ -924,11 +924,11 @@
[Button]
--
-##### [button_exact](https://github.com/appium/ruby_lib/blob/891e003748038a006121c8a4e0c702c12c405799/lib/appium_lib/common/element/button.rb#L39)
+##### [button_exact](https://github.com/appium/ruby_lib/blob/89b0902ed94ed43d8a9f0e364463da77015dcfb7/lib/appium_lib/common/element/button.rb#L39)
> def button_exact text
Get the first button element that exactly matches text.
@@ -940,11 +940,11 @@
[Button]
--
-##### [buttons_exact](https://github.com/appium/ruby_lib/blob/891e003748038a006121c8a4e0c702c12c405799/lib/appium_lib/common/element/button.rb#L46)
+##### [buttons_exact](https://github.com/appium/ruby_lib/blob/89b0902ed94ed43d8a9f0e364463da77015dcfb7/lib/appium_lib/common/element/button.rb#L46)
> def buttons_exact text
Get all button elements that exactly match text.
@@ -956,11 +956,11 @@
[Array<Button>]
--
-##### [e_buttons](https://github.com/appium/ruby_lib/blob/891e003748038a006121c8a4e0c702c12c405799/lib/appium_lib/common/element/button.rb#L52)
+##### [e_buttons](https://github.com/appium/ruby_lib/blob/89b0902ed94ed43d8a9f0e364463da77015dcfb7/lib/appium_lib/common/element/button.rb#L52)
> def e_buttons
Get an array of button elements.
@@ -968,11 +968,11 @@
[Array<Button>]
--
-##### [button_num](https://github.com/appium/ruby_lib/blob/891e003748038a006121c8a4e0c702c12c405799/lib/appium_lib/common/element/button.rb#L72)
+##### [button_num](https://github.com/appium/ruby_lib/blob/89b0902ed94ed43d8a9f0e364463da77015dcfb7/lib/appium_lib/common/element/button.rb#L72)
> def button_num text, number=1
Expected to be called via button method.
@@ -997,11 +997,11 @@
[Button] the button that matches text and number
--
-##### [tag_name_to_android](https://github.com/appium/ruby_lib/blob/891e003748038a006121c8a4e0c702c12c405799/lib/appium_lib/android/helper.rb#L6) android
+##### [tag_name_to_android](https://github.com/appium/ruby_lib/blob/89b0902ed94ed43d8a9f0e364463da77015dcfb7/lib/appium_lib/android/helper.rb#L6) android
> def tag_name_to_android tag_name
Returns an array of android classes that match the tag name
@@ -1013,11 +1013,11 @@
[String]
--
-##### [find_eles_attr](https://github.com/appium/ruby_lib/blob/891e003748038a006121c8a4e0c702c12c405799/lib/appium_lib/android/helper.rb#L194) android
+##### [find_eles_attr](https://github.com/appium/ruby_lib/blob/89b0902ed94ed43d8a9f0e364463da77015dcfb7/lib/appium_lib/android/helper.rb#L194) android
> def find_eles_attr tag_name, attribute=nil
Find all elements matching the attribute
On android, assume the attr is name (which falls back to text).
@@ -1034,11 +1034,11 @@
[Element]
--
-##### [get_selendroid_inspect](https://github.com/appium/ruby_lib/blob/891e003748038a006121c8a4e0c702c12c405799/lib/appium_lib/android/helper.rb#L216) android
+##### [get_selendroid_inspect](https://github.com/appium/ruby_lib/blob/89b0902ed94ed43d8a9f0e364463da77015dcfb7/lib/appium_lib/android/helper.rb#L216) android
> def get_selendroid_inspect
Selendroid only.
Returns a string containing interesting elements.
@@ -1047,28 +1047,28 @@
[String]
--
-##### [get_page_class](https://github.com/appium/ruby_lib/blob/891e003748038a006121c8a4e0c702c12c405799/lib/appium_lib/android/helper.rb#L278) android
+##### [get_page_class](https://github.com/appium/ruby_lib/blob/89b0902ed94ed43d8a9f0e364463da77015dcfb7/lib/appium_lib/android/helper.rb#L278) android
> def get_page_class
--
-##### [page_class](https://github.com/appium/ruby_lib/blob/891e003748038a006121c8a4e0c702c12c405799/lib/appium_lib/android/helper.rb#L305) android
+##### [page_class](https://github.com/appium/ruby_lib/blob/89b0902ed94ed43d8a9f0e364463da77015dcfb7/lib/appium_lib/android/helper.rb#L305) android
> def page_class
Count all classes on screen and print to stdout.
Useful for appium_console.
--
-##### [get_android_inspect](https://github.com/appium/ruby_lib/blob/891e003748038a006121c8a4e0c702c12c405799/lib/appium_lib/android/helper.rb#L314) android
+##### [get_android_inspect](https://github.com/appium/ruby_lib/blob/89b0902ed94ed43d8a9f0e364463da77015dcfb7/lib/appium_lib/android/helper.rb#L314) android
> def get_android_inspect
Android only.
Returns a string containing interesting elements.
@@ -1078,11 +1078,11 @@
[String]
--
-##### [get_inspect](https://github.com/appium/ruby_lib/blob/891e003748038a006121c8a4e0c702c12c405799/lib/appium_lib/android/helper.rb#L363) android
+##### [get_inspect](https://github.com/appium/ruby_lib/blob/89b0902ed94ed43d8a9f0e364463da77015dcfb7/lib/appium_lib/android/helper.rb#L363) android
> def get_inspect
Automatically detects selendroid or android.
Returns a string containing interesting elements.
@@ -1091,20 +1091,20 @@
[String]
--
-##### [page](https://github.com/appium/ruby_lib/blob/891e003748038a006121c8a4e0c702c12c405799/lib/appium_lib/android/helper.rb#L369) android
+##### [page](https://github.com/appium/ruby_lib/blob/89b0902ed94ed43d8a9f0e364463da77015dcfb7/lib/appium_lib/android/helper.rb#L369) android
> def page
Intended for use with console.
Inspects and prints the current page.
--
-##### [fast_duration](https://github.com/appium/ruby_lib/blob/891e003748038a006121c8a4e0c702c12c405799/lib/appium_lib/android/helper.rb#L382) android
+##### [fast_duration](https://github.com/appium/ruby_lib/blob/89b0902ed94ed43d8a9f0e364463da77015dcfb7/lib/appium_lib/android/helper.rb#L382) android
> def fast_duration
JavaScript code from https://github.com/appium/appium/blob/master/app/android.js
@@ -1115,13 +1115,13 @@
We want steps to be exactly 1. If it's zero then a tap is used instead of a swipe.
--
-##### [search_id](https://github.com/appium/ruby_lib/blob/891e003748038a006121c8a4e0c702c12c405799/lib/appium_lib/android/helper.rb#L389) android
+##### [xml_keys](https://github.com/appium/ruby_lib/blob/89b0902ed94ed43d8a9f0e364463da77015dcfb7/lib/appium_lib/android/helper.rb#L389) android
-> def search_id target
+> def xml_keys target
Search strings.xml's values for target.
__Parameters:__
@@ -1131,13 +1131,13 @@
[Array]
--
-##### [search_value](https://github.com/appium/ruby_lib/blob/891e003748038a006121c8a4e0c702c12c405799/lib/appium_lib/android/helper.rb#L396) android
+##### [xml_values](https://github.com/appium/ruby_lib/blob/89b0902ed94ed43d8a9f0e364463da77015dcfb7/lib/appium_lib/android/helper.rb#L396) android
-> def search_value target
+> def xml_values target
Search strings.xml's keys for target.
__Parameters:__
@@ -1147,11 +1147,11 @@
[Array]
--
-##### [resolve_id](https://github.com/appium/ruby_lib/blob/891e003748038a006121c8a4e0c702c12c405799/lib/appium_lib/android/helper.rb#L403) android
+##### [resolve_id](https://github.com/appium/ruby_lib/blob/89b0902ed94ed43d8a9f0e364463da77015dcfb7/lib/appium_lib/android/helper.rb#L403) android
> def resolve_id id
Resolve id in strings.xml and return the value.
@@ -1163,11 +1163,11 @@
[String]
--
-##### [alert_click](https://github.com/appium/ruby_lib/blob/891e003748038a006121c8a4e0c702c12c405799/lib/appium_lib/android/element/alert.rb#L6) android
+##### [alert_click](https://github.com/appium/ruby_lib/blob/89b0902ed94ed43d8a9f0e364463da77015dcfb7/lib/appium_lib/android/element/alert.rb#L6) android
> def alert_click value
Tap the alert button identified by value.
@@ -1179,11 +1179,11 @@
[void]
--
-##### [alert_accept](https://github.com/appium/ruby_lib/blob/891e003748038a006121c8a4e0c702c12c405799/lib/appium_lib/android/element/alert.rb#L13) android
+##### [alert_accept](https://github.com/appium/ruby_lib/blob/89b0902ed94ed43d8a9f0e364463da77015dcfb7/lib/appium_lib/android/element/alert.rb#L13) android
> def alert_accept
Accept the alert.
The last button is considered "accept."
@@ -1192,11 +1192,11 @@
[void]
--
-##### [alert_accept_text](https://github.com/appium/ruby_lib/blob/891e003748038a006121c8a4e0c702c12c405799/lib/appium_lib/android/element/alert.rb#L20) android
+##### [alert_accept_text](https://github.com/appium/ruby_lib/blob/89b0902ed94ed43d8a9f0e364463da77015dcfb7/lib/appium_lib/android/element/alert.rb#L20) android
> def alert_accept_text
Get the text of the alert's accept button.
The last button is considered "accept."
@@ -1205,11 +1205,11 @@
[String]
--
-##### [alert_dismiss](https://github.com/appium/ruby_lib/blob/891e003748038a006121c8a4e0c702c12c405799/lib/appium_lib/android/element/alert.rb#L27) android
+##### [alert_dismiss](https://github.com/appium/ruby_lib/blob/89b0902ed94ed43d8a9f0e364463da77015dcfb7/lib/appium_lib/android/element/alert.rb#L27) android
> def alert_dismiss
Dismiss the alert.
The first button is considered "dismiss."
@@ -1218,11 +1218,11 @@
[void]
--
-##### [alert_dismiss_text](https://github.com/appium/ruby_lib/blob/891e003748038a006121c8a4e0c702c12c405799/lib/appium_lib/android/element/alert.rb#L34) android
+##### [alert_dismiss_text](https://github.com/appium/ruby_lib/blob/89b0902ed94ed43d8a9f0e364463da77015dcfb7/lib/appium_lib/android/element/alert.rb#L34) android
> def alert_dismiss_text
Get the text of the alert's dismiss button.
The first button is considered "dismiss."
@@ -1231,11 +1231,11 @@
[String]
--
-##### [find](https://github.com/appium/ruby_lib/blob/891e003748038a006121c8a4e0c702c12c405799/lib/appium_lib/android/element/generic.rb#L44) android
+##### [find](https://github.com/appium/ruby_lib/blob/89b0902ed94ed43d8a9f0e364463da77015dcfb7/lib/appium_lib/android/element/generic.rb#L44) android
> def find val
Find the value contained in content description or text. Search elements
in this order: EditText, Button, ImageButton
@@ -1248,11 +1248,11 @@
[Element]
--
-##### [text](https://github.com/appium/ruby_lib/blob/891e003748038a006121c8a4e0c702c12c405799/lib/appium_lib/android/element/generic.rb#L70) android
+##### [text](https://github.com/appium/ruby_lib/blob/89b0902ed94ed43d8a9f0e364463da77015dcfb7/lib/appium_lib/android/element/generic.rb#L70) android
> def text text
Return the first element matching text.
@@ -1264,11 +1264,11 @@
[Element] the first matching element
--
-##### [texts](https://github.com/appium/ruby_lib/blob/891e003748038a006121c8a4e0c702c12c405799/lib/appium_lib/android/element/generic.rb#L79) android
+##### [texts](https://github.com/appium/ruby_lib/blob/89b0902ed94ed43d8a9f0e364463da77015dcfb7/lib/appium_lib/android/element/generic.rb#L79) android
> def texts text
Return all elements matching text.
@@ -1280,11 +1280,11 @@
[Array<Element>] all matching elements
--
-##### [name](https://github.com/appium/ruby_lib/blob/891e003748038a006121c8a4e0c702c12c405799/lib/appium_lib/android/element/generic.rb#L88) android
+##### [name](https://github.com/appium/ruby_lib/blob/89b0902ed94ed43d8a9f0e364463da77015dcfb7/lib/appium_lib/android/element/generic.rb#L88) android
> def name name
Return the first element matching name.
on Android name is content description
@@ -1298,11 +1298,11 @@
[Element] the first matching element
--
-##### [names](https://github.com/appium/ruby_lib/blob/891e003748038a006121c8a4e0c702c12c405799/lib/appium_lib/android/element/generic.rb#L99) android
+##### [names](https://github.com/appium/ruby_lib/blob/89b0902ed94ed43d8a9f0e364463da77015dcfb7/lib/appium_lib/android/element/generic.rb#L99) android
> def names name
Return all elements matching name.
on Android name is content description
@@ -1316,11 +1316,11 @@
[Array<Element>] all matching elements
--
-##### [scroll_to](https://github.com/appium/ruby_lib/blob/891e003748038a006121c8a4e0c702c12c405799/lib/appium_lib/android/element/generic.rb#L108) android
+##### [scroll_to](https://github.com/appium/ruby_lib/blob/89b0902ed94ed43d8a9f0e364463da77015dcfb7/lib/appium_lib/android/element/generic.rb#L108) android
> def scroll_to text
Scroll to an element containing target text or description.
@@ -1332,11 +1332,11 @@
[Element] the element scrolled to
--
-##### [textfields](https://github.com/appium/ruby_lib/blob/891e003748038a006121c8a4e0c702c12c405799/lib/appium_lib/android/element/textfield.rb#L7) android
+##### [textfields](https://github.com/appium/ruby_lib/blob/89b0902ed94ed43d8a9f0e364463da77015dcfb7/lib/appium_lib/android/element/textfield.rb#L7) android
> def textfields
Get an array of textfield texts.
@@ -1344,11 +1344,11 @@
[Array<String>]
--
-##### [e_textfields](https://github.com/appium/ruby_lib/blob/891e003748038a006121c8a4e0c702c12c405799/lib/appium_lib/android/element/textfield.rb#L13) android
+##### [e_textfields](https://github.com/appium/ruby_lib/blob/89b0902ed94ed43d8a9f0e364463da77015dcfb7/lib/appium_lib/android/element/textfield.rb#L13) android
> def e_textfields
Get an array of textfield elements.
@@ -1356,11 +1356,11 @@
[Array<Textfield>]
--
-##### [first_textfield](https://github.com/appium/ruby_lib/blob/891e003748038a006121c8a4e0c702c12c405799/lib/appium_lib/android/element/textfield.rb#L19) android
+##### [first_textfield](https://github.com/appium/ruby_lib/blob/89b0902ed94ed43d8a9f0e364463da77015dcfb7/lib/appium_lib/android/element/textfield.rb#L19) android
> def first_textfield
Get the first textfield element.
@@ -1368,11 +1368,11 @@
[Textfield]
--
-##### [last_textfield](https://github.com/appium/ruby_lib/blob/891e003748038a006121c8a4e0c702c12c405799/lib/appium_lib/android/element/textfield.rb#L25) android
+##### [last_textfield](https://github.com/appium/ruby_lib/blob/89b0902ed94ed43d8a9f0e364463da77015dcfb7/lib/appium_lib/android/element/textfield.rb#L25) android
> def last_textfield
Get the last textfield element.
@@ -1380,11 +1380,11 @@
[Textfield]
--
-##### [textfield](https://github.com/appium/ruby_lib/blob/891e003748038a006121c8a4e0c702c12c405799/lib/appium_lib/android/element/textfield.rb#L32) android
+##### [textfield](https://github.com/appium/ruby_lib/blob/89b0902ed94ed43d8a9f0e364463da77015dcfb7/lib/appium_lib/android/element/textfield.rb#L32) android
> def textfield text
Get the first textfield that includes text or name (content description).
@@ -1396,11 +1396,11 @@
[Textfield]
--
-##### [textfield_exact](https://github.com/appium/ruby_lib/blob/891e003748038a006121c8a4e0c702c12c405799/lib/appium_lib/android/element/textfield.rb#L45) android
+##### [textfield_exact](https://github.com/appium/ruby_lib/blob/89b0902ed94ed43d8a9f0e364463da77015dcfb7/lib/appium_lib/android/element/textfield.rb#L45) android
> def textfield_exact text
Get the first textfield that matches text.
@@ -1412,40 +1412,40 @@
[Textfield]
--
-##### [value](https://github.com/appium/ruby_lib/blob/891e003748038a006121c8a4e0c702c12c405799/lib/appium_lib/common/patch.rb#L32)
+##### [value](https://github.com/appium/ruby_lib/blob/89b0902ed94ed43d8a9f0e364463da77015dcfb7/lib/appium_lib/common/patch.rb#L32)
> def value
Returns the value attribute
Fixes NoMethodError: undefined method `value' for Selenium::WebDriver::Element
--
-##### [name](https://github.com/appium/ruby_lib/blob/891e003748038a006121c8a4e0c702c12c405799/lib/appium_lib/common/patch.rb#L39)
+##### [name](https://github.com/appium/ruby_lib/blob/89b0902ed94ed43d8a9f0e364463da77015dcfb7/lib/appium_lib/common/patch.rb#L39)
> def name
Returns the name attribute
Fixes NoMethodError: undefined method `name' for Selenium::WebDriver::Element
--
-##### [tag_name](https://github.com/appium/ruby_lib/blob/891e003748038a006121c8a4e0c702c12c405799/lib/appium_lib/common/patch.rb#L46)
+##### [tag_name](https://github.com/appium/ruby_lib/blob/89b0902ed94ed43d8a9f0e364463da77015dcfb7/lib/appium_lib/common/patch.rb#L46)
> def tag_name
Returns the type attribute
Fixes Selenium::WebDriver::Error::UnknownError: Not yet implemented
--
-##### [location_rel](https://github.com/appium/ruby_lib/blob/891e003748038a006121c8a4e0c702c12c405799/lib/appium_lib/common/patch.rb#L58)
+##### [location_rel](https://github.com/appium/ruby_lib/blob/89b0902ed94ed43d8a9f0e364463da77015dcfb7/lib/appium_lib/common/patch.rb#L58)
> def location_rel
For use with mobile tap.