docs/ios_docs.md in appium_lib-0.5.0 vs docs/ios_docs.md in appium_lib-0.5.1
- old
+ new
@@ -1,88 +1,126 @@
-##### [app_path](https://github.com/appium/ruby_lib/blob/849594bdd87bf6133cbb64c43d0a02f427f17467/lib/appium_lib/driver.rb#L38)
+##### [load_appium_txt](https://github.com/appium/ruby_lib/blob/de58f7164230d7551df8462d65d0e43a3d0cfdab/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
+
+__Parameters:__
+
+ [Hash] opts - file: '/path/to/appium.txt', verbose: true
+
+__Returns:__
+
+ [nil]
+
+--
+
+##### [default_wait](https://github.com/appium/ruby_lib/blob/de58f7164230d7551df8462d65d0e43a3d0cfdab/lib/appium_lib/driver.rb#L344)
+
+> def default_wait
+
+Returns the default client side wait.
+This value is independent of what the server is using
+
+__Returns:__
+
+ [Integer]
+
+--
+
+##### [app_path](https://github.com/appium/ruby_lib/blob/de58f7164230d7551df8462d65d0e43a3d0cfdab/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/849594bdd87bf6133cbb64c43d0a02f427f17467/lib/appium_lib/driver.rb#L38)
+##### [app_name](https://github.com/appium/ruby_lib/blob/de58f7164230d7551df8462d65d0e43a3d0cfdab/lib/appium_lib/driver.rb#L87)
> def app_name
Returns the value of attribute app_name
--
-##### [app_package](https://github.com/appium/ruby_lib/blob/849594bdd87bf6133cbb64c43d0a02f427f17467/lib/appium_lib/driver.rb#L38)
+##### [selendroid](https://github.com/appium/ruby_lib/blob/de58f7164230d7551df8462d65d0e43a3d0cfdab/lib/appium_lib/driver.rb#L87)
+> def selendroid
+
+Returns the value of attribute selendroid
+
+--
+
+##### [app_package](https://github.com/appium/ruby_lib/blob/de58f7164230d7551df8462d65d0e43a3d0cfdab/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/849594bdd87bf6133cbb64c43d0a02f427f17467/lib/appium_lib/driver.rb#L38)
+##### [app_activity](https://github.com/appium/ruby_lib/blob/de58f7164230d7551df8462d65d0e43a3d0cfdab/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/849594bdd87bf6133cbb64c43d0a02f427f17467/lib/appium_lib/driver.rb#L38)
+##### [app_wait_activity](https://github.com/appium/ruby_lib/blob/de58f7164230d7551df8462d65d0e43a3d0cfdab/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/849594bdd87bf6133cbb64c43d0a02f427f17467/lib/appium_lib/driver.rb#L38)
+##### [sauce_username](https://github.com/appium/ruby_lib/blob/de58f7164230d7551df8462d65d0e43a3d0cfdab/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/849594bdd87bf6133cbb64c43d0a02f427f17467/lib/appium_lib/driver.rb#L38)
+##### [sauce_access_key](https://github.com/appium/ruby_lib/blob/de58f7164230d7551df8462d65d0e43a3d0cfdab/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/849594bdd87bf6133cbb64c43d0a02f427f17467/lib/appium_lib/driver.rb#L38)
+##### [port](https://github.com/appium/ruby_lib/blob/de58f7164230d7551df8462d65d0e43a3d0cfdab/lib/appium_lib/driver.rb#L87)
> def port
Returns the value of attribute port
--
-##### [os](https://github.com/appium/ruby_lib/blob/849594bdd87bf6133cbb64c43d0a02f427f17467/lib/appium_lib/driver.rb#L38)
+##### [os](https://github.com/appium/ruby_lib/blob/de58f7164230d7551df8462d65d0e43a3d0cfdab/lib/appium_lib/driver.rb#L87)
> def os
Returns the value of attribute os
--
-##### [debug](https://github.com/appium/ruby_lib/blob/849594bdd87bf6133cbb64c43d0a02f427f17467/lib/appium_lib/driver.rb#L38)
+##### [debug](https://github.com/appium/ruby_lib/blob/de58f7164230d7551df8462d65d0e43a3d0cfdab/lib/appium_lib/driver.rb#L87)
> def debug
Returns the value of attribute debug
--
-##### [initialize](https://github.com/appium/ruby_lib/blob/849594bdd87bf6133cbb64c43d0a02f427f17467/lib/appium_lib/driver.rb#L68)
+##### [initialize](https://github.com/appium/ruby_lib/blob/de58f7164230d7551df8462d65d0e43a3d0cfdab/lib/appium_lib/driver.rb#L117)
-> def initialize options={}
+> def initialize opts={}
Creates a new driver.
```ruby
# Options include:
@@ -107,27 +145,27 @@
Appium::Driver.new(apk).start_driver
```
__Parameters:__
- [Object] options - A hash containing various options.
+ [Object] opts - A hash containing various options.
__Returns:__
[Driver]
--
-##### [status](https://github.com/appium/ruby_lib/blob/849594bdd87bf6133cbb64c43d0a02f427f17467/lib/appium_lib/driver.rb#L153)
+##### [status](https://github.com/appium/ruby_lib/blob/de58f7164230d7551df8462d65d0e43a3d0cfdab/lib/appium_lib/driver.rb#L204)
> def status
Returns the status payload
--
-##### [server_version](https://github.com/appium/ruby_lib/blob/849594bdd87bf6133cbb64c43d0a02f427f17467/lib/appium_lib/driver.rb#L159)
+##### [server_version](https://github.com/appium/ruby_lib/blob/de58f7164230d7551df8462d65d0e43a3d0cfdab/lib/appium_lib/driver.rb#L210)
> def server_version
Returns the server's version string
@@ -135,11 +173,11 @@
[String]
--
-##### [absolute_app_path](https://github.com/appium/ruby_lib/blob/849594bdd87bf6133cbb64c43d0a02f427f17467/lib/appium_lib/driver.rb#L200)
+##### [absolute_app_path](https://github.com/appium/ruby_lib/blob/de58f7164230d7551df8462d65d0e43a3d0cfdab/lib/appium_lib/driver.rb#L251)
> def absolute_app_path
Converts environment variable APP_PATH to an absolute path.
@@ -147,11 +185,11 @@
[String] APP_PATH as an absolute path
--
-##### [server_url](https://github.com/appium/ruby_lib/blob/849594bdd87bf6133cbb64c43d0a02f427f17467/lib/appium_lib/driver.rb#L214)
+##### [server_url](https://github.com/appium/ruby_lib/blob/de58f7164230d7551df8462d65d0e43a3d0cfdab/lib/appium_lib/driver.rb#L265)
> def server_url
Get the server url for sauce or local based on env vars.
@@ -159,11 +197,11 @@
[String] the server url
--
-##### [restart](https://github.com/appium/ruby_lib/blob/849594bdd87bf6133cbb64c43d0a02f427f17467/lib/appium_lib/driver.rb#L224)
+##### [restart](https://github.com/appium/ruby_lib/blob/de58f7164230d7551df8462d65d0e43a3d0cfdab/lib/appium_lib/driver.rb#L275)
> def restart
Restarts the driver
@@ -171,11 +209,11 @@
[Driver] the driver
--
-##### [driver](https://github.com/appium/ruby_lib/blob/849594bdd87bf6133cbb64c43d0a02f427f17467/lib/appium_lib/driver.rb#L231)
+##### [driver](https://github.com/appium/ruby_lib/blob/de58f7164230d7551df8462d65d0e43a3d0cfdab/lib/appium_lib/driver.rb#L282)
> def driver
Returns the driver
@@ -183,27 +221,29 @@
[Driver] the driver
--
-##### [screenshot](https://github.com/appium/ruby_lib/blob/849594bdd87bf6133cbb64c43d0a02f427f17467/lib/appium_lib/driver.rb#L239)
+##### [screenshot](https://github.com/appium/ruby_lib/blob/de58f7164230d7551df8462d65d0e43a3d0cfdab/lib/appium_lib/driver.rb#L292)
> def screenshot png_save_path
Takes a png screenshot and saves to the target path.
+Example: screenshot '/tmp/hi.png'
+
__Parameters:__
[String] png_save_path - the full path to save the png
__Returns:__
[void]
--
-##### [driver_quit](https://github.com/appium/ruby_lib/blob/849594bdd87bf6133cbb64c43d0a02f427f17467/lib/appium_lib/driver.rb#L245)
+##### [driver_quit](https://github.com/appium/ruby_lib/blob/de58f7164230d7551df8462d65d0e43a3d0cfdab/lib/appium_lib/driver.rb#L298)
> def driver_quit
Quits the driver
@@ -211,35 +251,31 @@
[void]
--
-##### [start_driver](https://github.com/appium/ruby_lib/blob/849594bdd87bf6133cbb64c43d0a02f427f17467/lib/appium_lib/driver.rb#L254)
+##### [start_driver](https://github.com/appium/ruby_lib/blob/de58f7164230d7551df8462d65d0e43a3d0cfdab/lib/appium_lib/driver.rb#L306)
-> def start_driver wait=30
+> def start_driver
Creates a new global driver and quits the old one if it exists.
-__Parameters:__
-
- [Integer] wait - seconds to wait before timing out a command. defaults to 30 seconds
-
__Returns:__
[Selenium::WebDriver] the new global driver
--
-##### [no_wait](https://github.com/appium/ruby_lib/blob/849594bdd87bf6133cbb64c43d0a02f427f17467/lib/appium_lib/driver.rb#L280)
+##### [no_wait](https://github.com/appium/ruby_lib/blob/de58f7164230d7551df8462d65d0e43a3d0cfdab/lib/appium_lib/driver.rb#L330)
> def no_wait
Set implicit wait to zero.
--
-##### [set_wait](https://github.com/appium/ruby_lib/blob/849594bdd87bf6133cbb64c43d0a02f427f17467/lib/appium_lib/driver.rb#L287)
+##### [set_wait](https://github.com/appium/ruby_lib/blob/de58f7164230d7551df8462d65d0e43a3d0cfdab/lib/appium_lib/driver.rb#L337)
> def set_wait timeout=@default_wait
Set implicit wait to timeout, defaults to 30.
@@ -251,44 +287,37 @@
[void]
--
-##### [default_wait](https://github.com/appium/ruby_lib/blob/849594bdd87bf6133cbb64c43d0a02f427f17467/lib/appium_lib/driver.rb#L294)
+##### [exists](https://github.com/appium/ruby_lib/blob/de58f7164230d7551df8462d65d0e43a3d0cfdab/lib/appium_lib/driver.rb#L360)
-> def default_wait
+> def exists pre_check=0, post_check=@default_wait, &search_block
-Returns the default client side wait.
-This value is independent of what the server is using
-
-__Returns:__
-
- [Integer]
-
---
-
-##### [exists](https://github.com/appium/ruby_lib/blob/849594bdd87bf6133cbb64c43d0a02f427f17467/lib/appium_lib/driver.rb#L306)
-
-> def exists &search_block
-
Returns existence of element.
Example:
exists { button('sign in') } ? puts('true') : puts('false')
__Parameters:__
+ [Integer] pre_check - the amount in seconds to set the
+wait to before checking existance
+
+ [Integer] post_check - the amount in seconds to set the
+wait to after checking existance
+
[Block] search_block - the block to call
__Returns:__
[Boolean]
--
-##### [execute_script](https://github.com/appium/ruby_lib/blob/849594bdd87bf6133cbb64c43d0a02f427f17467/lib/appium_lib/driver.rb#L331)
+##### [execute_script](https://github.com/appium/ruby_lib/blob/de58f7164230d7551df8462d65d0e43a3d0cfdab/lib/appium_lib/driver.rb#L382)
> def execute_script script, *args
The same as @driver.execute_script
@@ -302,11 +331,11 @@
[Object]
--
-##### [mobile](https://github.com/appium/ruby_lib/blob/849594bdd87bf6133cbb64c43d0a02f427f17467/lib/appium_lib/driver.rb#L347)
+##### [mobile](https://github.com/appium/ruby_lib/blob/de58f7164230d7551df8462d65d0e43a3d0cfdab/lib/appium_lib/driver.rb#L398)
> def mobile method, *args
Helper method for mobile gestures
@@ -328,11 +357,11 @@
[Object]
--
-##### [find_elements](https://github.com/appium/ruby_lib/blob/849594bdd87bf6133cbb64c43d0a02f427f17467/lib/appium_lib/driver.rb#L358)
+##### [find_elements](https://github.com/appium/ruby_lib/blob/de58f7164230d7551df8462d65d0e43a3d0cfdab/lib/appium_lib/driver.rb#L409)
> def find_elements *args
Calls @driver.find_elements
@@ -344,11 +373,11 @@
[Array<Element>] Array is empty when no elements are found.
--
-##### [find_element](https://github.com/appium/ruby_lib/blob/849594bdd87bf6133cbb64c43d0a02f427f17467/lib/appium_lib/driver.rb#L366)
+##### [find_element](https://github.com/appium/ruby_lib/blob/de58f7164230d7551df8462d65d0e43a3d0cfdab/lib/appium_lib/driver.rb#L417)
> def find_element *args
Calls @driver.find_elements
@@ -360,11 +389,11 @@
[Element]
--
-##### [x](https://github.com/appium/ruby_lib/blob/849594bdd87bf6133cbb64c43d0a02f427f17467/lib/appium_lib/driver.rb#L373)
+##### [x](https://github.com/appium/ruby_lib/blob/de58f7164230d7551df8462d65d0e43a3d0cfdab/lib/appium_lib/driver.rb#L424)
> def x
Quit the driver and Pry.
quit and exit are reserved by Pry.
@@ -373,11 +402,11 @@
[void]
--
-##### [wait](https://github.com/appium/ruby_lib/blob/849594bdd87bf6133cbb64c43d0a02f427f17467/lib/appium_lib/common/helper.rb#L32)
+##### [wait](https://github.com/appium/ruby_lib/blob/de58f7164230d7551df8462d65d0e43a3d0cfdab/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.
@@ -387,11 +416,12 @@
Give up after 30 seconds.
__Parameters:__
- [Integer] max_wait - the maximum time in seconds to wait for
+ [Integer] max_wait - the maximum time in seconds to wait for.
+Note that max wait 0 means infinity.
[Float] interval - the time in seconds to wait after calling the block
[Block] block - the block to call
@@ -399,11 +429,11 @@
[Object] the result of block.call
--
-##### [wait_true](https://github.com/appium/ruby_lib/blob/849594bdd87bf6133cbb64c43d0a02f427f17467/lib/appium_lib/common/helper.rb#L49)
+##### [wait_true](https://github.com/appium/ruby_lib/blob/de58f7164230d7551df8462d65d0e43a3d0cfdab/lib/appium_lib/common/helper.rb#L50)
> 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.
@@ -420,11 +450,11 @@
[Object] the result of block.call
--
-##### [id](https://github.com/appium/ruby_lib/blob/849594bdd87bf6133cbb64c43d0a02f427f17467/lib/appium_lib/common/helper.rb#L63)
+##### [id](https://github.com/appium/ruby_lib/blob/de58f7164230d7551df8462d65d0e43a3d0cfdab/lib/appium_lib/common/helper.rb#L64)
> def id id
Find by id. Useful for selendroid
@@ -436,11 +466,11 @@
[Element]
--
-##### [back](https://github.com/appium/ruby_lib/blob/849594bdd87bf6133cbb64c43d0a02f427f17467/lib/appium_lib/common/helper.rb#L69)
+##### [back](https://github.com/appium/ruby_lib/blob/de58f7164230d7551df8462d65d0e43a3d0cfdab/lib/appium_lib/common/helper.rb#L70)
> def back
Navigate back.
@@ -448,19 +478,19 @@
[void]
--
-##### [session_id](https://github.com/appium/ruby_lib/blob/849594bdd87bf6133cbb64c43d0a02f427f17467/lib/appium_lib/common/helper.rb#L74)
+##### [session_id](https://github.com/appium/ruby_lib/blob/de58f7164230d7551df8462d65d0e43a3d0cfdab/lib/appium_lib/common/helper.rb#L75)
> def session_id
For Sauce Labs reporting. Returns the current session id.
--
-##### [xpath](https://github.com/appium/ruby_lib/blob/849594bdd87bf6133cbb64c43d0a02f427f17467/lib/appium_lib/common/helper.rb#L82)
+##### [xpath](https://github.com/appium/ruby_lib/blob/de58f7164230d7551df8462d65d0e43a3d0cfdab/lib/appium_lib/common/helper.rb#L83)
> def xpath xpath_str
Returns the first element that matches the provided xpath.
@@ -472,11 +502,11 @@
[Element]
--
-##### [xpaths](https://github.com/appium/ruby_lib/blob/849594bdd87bf6133cbb64c43d0a02f427f17467/lib/appium_lib/common/helper.rb#L90)
+##### [xpaths](https://github.com/appium/ruby_lib/blob/de58f7164230d7551df8462d65d0e43a3d0cfdab/lib/appium_lib/common/helper.rb#L91)
> def xpaths xpath_str
Returns all elements that match the provided xpath.
@@ -488,11 +518,11 @@
[Array<Element>]
--
-##### [ele_index](https://github.com/appium/ruby_lib/blob/849594bdd87bf6133cbb64c43d0a02f427f17467/lib/appium_lib/common/helper.rb#L98)
+##### [ele_index](https://github.com/appium/ruby_lib/blob/de58f7164230d7551df8462d65d0e43a3d0cfdab/lib/appium_lib/common/helper.rb#L99)
> def ele_index tag_name, index
Get the element of type tag_name at matching index.
@@ -506,11 +536,11 @@
[Element] the found element of type tag_name
--
-##### [find_eles](https://github.com/appium/ruby_lib/blob/849594bdd87bf6133cbb64c43d0a02f427f17467/lib/appium_lib/common/helper.rb#L106)
+##### [find_eles](https://github.com/appium/ruby_lib/blob/de58f7164230d7551df8462d65d0e43a3d0cfdab/lib/appium_lib/common/helper.rb#L107)
> def find_eles tag_name
Get all elements exactly matching tag name
@@ -522,11 +552,11 @@
[Array<Element>] the found elements of type tag_name
--
-##### [find_ele_by_text](https://github.com/appium/ruby_lib/blob/849594bdd87bf6133cbb64c43d0a02f427f17467/lib/appium_lib/common/helper.rb#L114)
+##### [find_ele_by_text](https://github.com/appium/ruby_lib/blob/de58f7164230d7551df8462d65d0e43a3d0cfdab/lib/appium_lib/common/helper.rb#L115)
> def find_ele_by_text tag, text
Get the first tag that exactly matches tag and text.
@@ -540,11 +570,11 @@
[Element] the element of type tag exactly matching text
--
-##### [find_eles_by_text](https://github.com/appium/ruby_lib/blob/849594bdd87bf6133cbb64c43d0a02f427f17467/lib/appium_lib/common/helper.rb#L122)
+##### [find_eles_by_text](https://github.com/appium/ruby_lib/blob/de58f7164230d7551df8462d65d0e43a3d0cfdab/lib/appium_lib/common/helper.rb#L123)
> def find_eles_by_text tag, text
Get all tags that exactly match tag and text.
@@ -558,11 +588,11 @@
[Array<Element>] the elements of type tag exactly matching text
--
-##### [find_ele_by_attr_include](https://github.com/appium/ruby_lib/blob/849594bdd87bf6133cbb64c43d0a02f427f17467/lib/appium_lib/common/helper.rb#L131)
+##### [find_ele_by_attr_include](https://github.com/appium/ruby_lib/blob/de58f7164230d7551df8462d65d0e43a3d0cfdab/lib/appium_lib/common/helper.rb#L132)
> def find_ele_by_attr_include tag, attr, value
Get the first tag by attribute that exactly matches value.
@@ -578,11 +608,11 @@
[Element] the element of type tag who's attribute includes value
--
-##### [find_eles_by_attr_include](https://github.com/appium/ruby_lib/blob/849594bdd87bf6133cbb64c43d0a02f427f17467/lib/appium_lib/common/helper.rb#L140)
+##### [find_eles_by_attr_include](https://github.com/appium/ruby_lib/blob/de58f7164230d7551df8462d65d0e43a3d0cfdab/lib/appium_lib/common/helper.rb#L141)
> def find_eles_by_attr_include tag, attr, value
Get tags by attribute that include value.
@@ -598,11 +628,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/849594bdd87bf6133cbb64c43d0a02f427f17467/lib/appium_lib/common/helper.rb#L149)
+##### [find_ele_by_text_include](https://github.com/appium/ruby_lib/blob/de58f7164230d7551df8462d65d0e43a3d0cfdab/lib/appium_lib/common/helper.rb#L150)
> def find_ele_by_text_include tag, text
Get the first tag that includes text.
element.attribute(:text).include? text
@@ -617,11 +647,11 @@
[Element] the element of type tag that includes text
--
-##### [find_eles_by_text_include](https://github.com/appium/ruby_lib/blob/849594bdd87bf6133cbb64c43d0a02f427f17467/lib/appium_lib/common/helper.rb#L158)
+##### [find_eles_by_text_include](https://github.com/appium/ruby_lib/blob/de58f7164230d7551df8462d65d0e43a3d0cfdab/lib/appium_lib/common/helper.rb#L159)
> def find_eles_by_text_include tag, text
Get the tags that include text.
element.attribute(:text).include? text
@@ -636,11 +666,11 @@
[Array<Element>] the elements of type tag that includes text
--
-##### [first_ele](https://github.com/appium/ruby_lib/blob/849594bdd87bf6133cbb64c43d0a02f427f17467/lib/appium_lib/common/helper.rb#L165)
+##### [first_ele](https://github.com/appium/ruby_lib/blob/de58f7164230d7551df8462d65d0e43a3d0cfdab/lib/appium_lib/common/helper.rb#L166)
> def first_ele tag_name
Get the first tag that matches tag_name
@@ -652,11 +682,11 @@
[Element]
--
-##### [last_ele](https://github.com/appium/ruby_lib/blob/849594bdd87bf6133cbb64c43d0a02f427f17467/lib/appium_lib/common/helper.rb#L173)
+##### [last_ele](https://github.com/appium/ruby_lib/blob/de58f7164230d7551df8462d65d0e43a3d0cfdab/lib/appium_lib/common/helper.rb#L174)
> def last_ele tag_name
Get the last tag that matches tag_name
@@ -668,11 +698,11 @@
[Element]
--
-##### [source](https://github.com/appium/ruby_lib/blob/849594bdd87bf6133cbb64c43d0a02f427f17467/lib/appium_lib/common/helper.rb#L179)
+##### [source](https://github.com/appium/ruby_lib/blob/de58f7164230d7551df8462d65d0e43a3d0cfdab/lib/appium_lib/common/helper.rb#L180)
> def source
Prints a JSON view of the current page
@@ -680,11 +710,11 @@
[void]
--
-##### [get_source](https://github.com/appium/ruby_lib/blob/849594bdd87bf6133cbb64c43d0a02f427f17467/lib/appium_lib/common/helper.rb#L185)
+##### [get_source](https://github.com/appium/ruby_lib/blob/de58f7164230d7551df8462d65d0e43a3d0cfdab/lib/appium_lib/common/helper.rb#L186)
> def get_source
Gets a JSON view of the current page
@@ -692,43 +722,43 @@
[JSON]
--
-##### [find_name](https://github.com/appium/ruby_lib/blob/849594bdd87bf6133cbb64c43d0a02f427f17467/lib/appium_lib/common/helper.rb#L194)
+##### [find_name](https://github.com/appium/ruby_lib/blob/de58f7164230d7551df8462d65d0e43a3d0cfdab/lib/appium_lib/common/helper.rb#L195)
> def find_name name
-Returns the first element that matches name
+Returns the first element that exactly matches name
__Parameters:__
- [String] name - the name to match
+ [String] name - the name to exactly match
__Returns:__
[Element]
--
-##### [find_names](https://github.com/appium/ruby_lib/blob/849594bdd87bf6133cbb64c43d0a02f427f17467/lib/appium_lib/common/helper.rb#L202)
+##### [find_names](https://github.com/appium/ruby_lib/blob/de58f7164230d7551df8462d65d0e43a3d0cfdab/lib/appium_lib/common/helper.rb#L203)
> def find_names name
-Returns all elements that match name
+Returns all elements that exactly match name
__Parameters:__
- [String] name - the name to match
+ [String] name - the name to exactly match
__Returns:__
[Array<Element>]
--
-##### [s_texts](https://github.com/appium/ruby_lib/blob/849594bdd87bf6133cbb64c43d0a02f427f17467/lib/appium_lib/common/element/text.rb#L8)
+##### [s_texts](https://github.com/appium/ruby_lib/blob/de58f7164230d7551df8462d65d0e43a3d0cfdab/lib/appium_lib/common/element/text.rb#L8)
> def s_texts
Get an array of text texts.
@@ -736,11 +766,11 @@
[Array<String>]
--
-##### [e_s_texts](https://github.com/appium/ruby_lib/blob/849594bdd87bf6133cbb64c43d0a02f427f17467/lib/appium_lib/common/element/text.rb#L14)
+##### [e_s_texts](https://github.com/appium/ruby_lib/blob/de58f7164230d7551df8462d65d0e43a3d0cfdab/lib/appium_lib/common/element/text.rb#L14)
> def e_s_texts
Get an array of text elements.
@@ -748,35 +778,35 @@
[Array<Text>]
--
-##### [s_first_text](https://github.com/appium/ruby_lib/blob/849594bdd87bf6133cbb64c43d0a02f427f17467/lib/appium_lib/common/element/text.rb#L20)
+##### [first_s_text](https://github.com/appium/ruby_lib/blob/de58f7164230d7551df8462d65d0e43a3d0cfdab/lib/appium_lib/common/element/text.rb#L20)
-> def s_first_text
+> def first_s_text
Get the first text element.
__Returns:__
[Text]
--
-##### [s_last_text](https://github.com/appium/ruby_lib/blob/849594bdd87bf6133cbb64c43d0a02f427f17467/lib/appium_lib/common/element/text.rb#L26)
+##### [last_s_text](https://github.com/appium/ruby_lib/blob/de58f7164230d7551df8462d65d0e43a3d0cfdab/lib/appium_lib/common/element/text.rb#L26)
-> def s_last_text
+> def last_s_text
Get the last text element
__Returns:__
[Text]
--
-##### [s_text](https://github.com/appium/ruby_lib/blob/849594bdd87bf6133cbb64c43d0a02f427f17467/lib/appium_lib/common/element/text.rb#L33)
+##### [s_text](https://github.com/appium/ruby_lib/blob/de58f7164230d7551df8462d65d0e43a3d0cfdab/lib/appium_lib/common/element/text.rb#L33)
> def s_text text
Get the first element that includes text.
@@ -788,11 +818,11 @@
[Text]
--
-##### [s_text_exact](https://github.com/appium/ruby_lib/blob/849594bdd87bf6133cbb64c43d0a02f427f17467/lib/appium_lib/common/element/text.rb#L41)
+##### [s_text_exact](https://github.com/appium/ruby_lib/blob/de58f7164230d7551df8462d65d0e43a3d0cfdab/lib/appium_lib/common/element/text.rb#L41)
> def s_text_exact text
Get the first textfield that matches text.
@@ -804,12 +834,20 @@
[Text]
--
-##### [button](https://github.com/appium/ruby_lib/blob/849594bdd87bf6133cbb64c43d0a02f427f17467/lib/appium_lib/common/element/button.rb#L8)
+##### [window_size](https://github.com/appium/ruby_lib/blob/de58f7164230d7551df8462d65d0e43a3d0cfdab/lib/appium_lib/common/element/window.rb#L5)
+> def window_size
+
+Get the window's size
+
+--
+
+##### [button](https://github.com/appium/ruby_lib/blob/de58f7164230d7551df8462d65d0e43a3d0cfdab/lib/appium_lib/common/element/button.rb#L8)
+
> def button text, number=0
Find a button by text and optionally number.
__Parameters:__
@@ -822,11 +860,11 @@
[Button] the button found with text and matching number
--
-##### [buttons](https://github.com/appium/ruby_lib/blob/849594bdd87bf6133cbb64c43d0a02f427f17467/lib/appium_lib/common/element/button.rb#L19)
+##### [buttons](https://github.com/appium/ruby_lib/blob/de58f7164230d7551df8462d65d0e43a3d0cfdab/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.
@@ -838,11 +876,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/849594bdd87bf6133cbb64c43d0a02f427f17467/lib/appium_lib/common/element/button.rb#L26)
+##### [first_button](https://github.com/appium/ruby_lib/blob/de58f7164230d7551df8462d65d0e43a3d0cfdab/lib/appium_lib/common/element/button.rb#L26)
> def first_button
Get the first button element.
@@ -850,11 +888,11 @@
[Button]
--
-##### [last_button](https://github.com/appium/ruby_lib/blob/849594bdd87bf6133cbb64c43d0a02f427f17467/lib/appium_lib/common/element/button.rb#L32)
+##### [last_button](https://github.com/appium/ruby_lib/blob/de58f7164230d7551df8462d65d0e43a3d0cfdab/lib/appium_lib/common/element/button.rb#L32)
> def last_button
Get the last button element.
@@ -862,11 +900,11 @@
[Button]
--
-##### [button_exact](https://github.com/appium/ruby_lib/blob/849594bdd87bf6133cbb64c43d0a02f427f17467/lib/appium_lib/common/element/button.rb#L39)
+##### [button_exact](https://github.com/appium/ruby_lib/blob/de58f7164230d7551df8462d65d0e43a3d0cfdab/lib/appium_lib/common/element/button.rb#L39)
> def button_exact text
Get the first button element that exactly matches text.
@@ -878,11 +916,11 @@
[Button]
--
-##### [buttons_exact](https://github.com/appium/ruby_lib/blob/849594bdd87bf6133cbb64c43d0a02f427f17467/lib/appium_lib/common/element/button.rb#L46)
+##### [buttons_exact](https://github.com/appium/ruby_lib/blob/de58f7164230d7551df8462d65d0e43a3d0cfdab/lib/appium_lib/common/element/button.rb#L46)
> def buttons_exact text
Get all button elements that exactly match text.
@@ -894,11 +932,11 @@
[Array<Button>]
--
-##### [e_buttons](https://github.com/appium/ruby_lib/blob/849594bdd87bf6133cbb64c43d0a02f427f17467/lib/appium_lib/common/element/button.rb#L52)
+##### [e_buttons](https://github.com/appium/ruby_lib/blob/de58f7164230d7551df8462d65d0e43a3d0cfdab/lib/appium_lib/common/element/button.rb#L52)
> def e_buttons
Get an array of button elements.
@@ -906,11 +944,11 @@
[Array<Button>]
--
-##### [button_num](https://github.com/appium/ruby_lib/blob/849594bdd87bf6133cbb64c43d0a02f427f17467/lib/appium_lib/common/element/button.rb#L72)
+##### [button_num](https://github.com/appium/ruby_lib/blob/de58f7164230d7551df8462d65d0e43a3d0cfdab/lib/appium_lib/common/element/button.rb#L72)
> def button_num text, number=1
Expected to be called via button method.
@@ -935,20 +973,12 @@
[Button] the button that matches text and number
--
-##### [window_size](https://github.com/appium/ruby_lib/blob/849594bdd87bf6133cbb64c43d0a02f427f17467/lib/appium_lib/common/element/window.rb#L5)
+##### [find_eles_attr](https://github.com/appium/ruby_lib/blob/de58f7164230d7551df8462d65d0e43a3d0cfdab/lib/appium_lib/ios/helper.rb#L8) ios
-> def window_size
-
-Get the window's size
-
---
-
-##### [find_eles_attr](https://github.com/appium/ruby_lib/blob/849594bdd87bf6133cbb64c43d0a02f427f17467/lib/appium_lib/ios/helper.rb#L8) ios
-
> def find_eles_attr tag_name, attribute
iOS only. Android uses uiautomator instead of uiautomation.
Get an array of attribute values from elements exactly matching tag name.
@@ -962,11 +992,11 @@
[Array<String>] an array of strings containing the attribute from found elements of type tag_name.
--
-##### [find_2_eles_attr](https://github.com/appium/ruby_lib/blob/849594bdd87bf6133cbb64c43d0a02f427f17467/lib/appium_lib/ios/helper.rb#L29) ios
+##### [find_2_eles_attr](https://github.com/appium/ruby_lib/blob/de58f7164230d7551df8462d65d0e43a3d0cfdab/lib/appium_lib/ios/helper.rb#L29) ios
> def find_2_eles_attr tag_name_1, tag_name_2, attribute
iOS only. Android doesn't use find_2_eles_attr.
Get an array of attribute values from elements exactly matching tag name.
@@ -983,11 +1013,11 @@
[Array<String>] an array of strings containing the attribute from found elements of type tag_name.
--
-##### [password](https://github.com/appium/ruby_lib/blob/849594bdd87bf6133cbb64c43d0a02f427f17467/lib/appium_lib/ios/helper.rb#L50) ios
+##### [password](https://github.com/appium/ruby_lib/blob/de58f7164230d7551df8462d65d0e43a3d0cfdab/lib/appium_lib/ios/helper.rb#L50) ios
> def password length=1
iOS only. On Android uiautomator always returns an empty string for EditText password.
@@ -1001,11 +1031,11 @@
[String] the returned string is of size length
--
-##### [get_page](https://github.com/appium/ruby_lib/blob/849594bdd87bf6133cbb64c43d0a02f427f17467/lib/appium_lib/ios/helper.rb#L58) ios
+##### [get_page](https://github.com/appium/ruby_lib/blob/de58f7164230d7551df8462d65d0e43a3d0cfdab/lib/appium_lib/ios/helper.rb#L58) ios
> def get_page element=get_source
Returns a string of interesting elements. iOS only.
@@ -1017,11 +1047,11 @@
[String]
--
-##### [page](https://github.com/appium/ruby_lib/blob/849594bdd87bf6133cbb64c43d0a02f427f17467/lib/appium_lib/ios/helper.rb#L103) ios
+##### [page](https://github.com/appium/ruby_lib/blob/de58f7164230d7551df8462d65d0e43a3d0cfdab/lib/appium_lib/ios/helper.rb#L103) ios
> def page
Prints a string of interesting elements to the console.
@@ -1029,11 +1059,11 @@
[void]
--
-##### [source_window](https://github.com/appium/ruby_lib/blob/849594bdd87bf6133cbb64c43d0a02f427f17467/lib/appium_lib/ios/helper.rb#L111) ios
+##### [source_window](https://github.com/appium/ruby_lib/blob/de58f7164230d7551df8462d65d0e43a3d0cfdab/lib/appium_lib/ios/helper.rb#L111) ios
> def source_window window_number=0
Gets the JSON source of window number
@@ -1045,11 +1075,11 @@
[JSON]
--
-##### [page_window](https://github.com/appium/ruby_lib/blob/849594bdd87bf6133cbb64c43d0a02f427f17467/lib/appium_lib/ios/helper.rb#L118) ios
+##### [page_window](https://github.com/appium/ruby_lib/blob/de58f7164230d7551df8462d65d0e43a3d0cfdab/lib/appium_lib/ios/helper.rb#L118) ios
> def page_window window_number=0
Prints parsed page source to console.
example: page_window 0
@@ -1058,11 +1088,11 @@
[Integer] window_number - the int index of the target window
--
-##### [fast_duration](https://github.com/appium/ruby_lib/blob/849594bdd87bf6133cbb64c43d0a02f427f17467/lib/appium_lib/ios/helper.rb#L125) ios
+##### [fast_duration](https://github.com/appium/ruby_lib/blob/de58f7164230d7551df8462d65d0e43a3d0cfdab/lib/appium_lib/ios/helper.rb#L125) ios
> def fast_duration
The fastest duration that can be used on iOS.
@@ -1070,11 +1100,11 @@
[Float]
--
-##### [alert_click](https://github.com/appium/ruby_lib/blob/849594bdd87bf6133cbb64c43d0a02f427f17467/lib/appium_lib/ios/element/alert.rb#L14) ios
+##### [alert_click](https://github.com/appium/ruby_lib/blob/de58f7164230d7551df8462d65d0e43a3d0cfdab/lib/appium_lib/ios/element/alert.rb#L14) ios
> def alert_click value
iOS only
Tap the alert button identified by value.
@@ -1093,11 +1123,11 @@
[void]
--
-##### [alert_text](https://github.com/appium/ruby_lib/blob/849594bdd87bf6133cbb64c43d0a02f427f17467/lib/appium_lib/ios/element/alert.rb#L21) ios
+##### [alert_text](https://github.com/appium/ruby_lib/blob/de58f7164230d7551df8462d65d0e43a3d0cfdab/lib/appium_lib/ios/element/alert.rb#L21) ios
> def alert_text
Get the alert message text.
@@ -1105,11 +1135,11 @@
[String]
--
-##### [alert_accept](https://github.com/appium/ruby_lib/blob/849594bdd87bf6133cbb64c43d0a02f427f17467/lib/appium_lib/ios/element/alert.rb#L27) ios
+##### [alert_accept](https://github.com/appium/ruby_lib/blob/de58f7164230d7551df8462d65d0e43a3d0cfdab/lib/appium_lib/ios/element/alert.rb#L27) ios
> def alert_accept
Accept the alert.
@@ -1117,11 +1147,11 @@
[void]
--
-##### [alert_accept_text](https://github.com/appium/ruby_lib/blob/849594bdd87bf6133cbb64c43d0a02f427f17467/lib/appium_lib/ios/element/alert.rb#L34) ios
+##### [alert_accept_text](https://github.com/appium/ruby_lib/blob/de58f7164230d7551df8462d65d0e43a3d0cfdab/lib/appium_lib/ios/element/alert.rb#L34) ios
> def alert_accept_text
Get the text of the alert's accept button.
The last button is considered "accept."
@@ -1130,11 +1160,11 @@
[String]
--
-##### [alert_dismiss](https://github.com/appium/ruby_lib/blob/849594bdd87bf6133cbb64c43d0a02f427f17467/lib/appium_lib/ios/element/alert.rb#L43) ios
+##### [alert_dismiss](https://github.com/appium/ruby_lib/blob/de58f7164230d7551df8462d65d0e43a3d0cfdab/lib/appium_lib/ios/element/alert.rb#L43) ios
> def alert_dismiss
Dismiss the alert.
@@ -1142,11 +1172,11 @@
[void]
--
-##### [alert_dismiss_text](https://github.com/appium/ruby_lib/blob/849594bdd87bf6133cbb64c43d0a02f427f17467/lib/appium_lib/ios/element/alert.rb#L50) ios
+##### [alert_dismiss_text](https://github.com/appium/ruby_lib/blob/de58f7164230d7551df8462d65d0e43a3d0cfdab/lib/appium_lib/ios/element/alert.rb#L50) ios
> def alert_dismiss_text
Get the text of the alert's dismiss button.
The first button is considered "dismiss."
@@ -1155,11 +1185,11 @@
[String]
--
-##### [find](https://github.com/appium/ruby_lib/blob/849594bdd87bf6133cbb64c43d0a02f427f17467/lib/appium_lib/ios/element/generic.rb#L61) ios
+##### [find](https://github.com/appium/ruby_lib/blob/de58f7164230d7551df8462d65d0e43a3d0cfdab/lib/appium_lib/ios/element/generic.rb#L61) ios
> def find text
Return the first element matching text.
@@ -1171,11 +1201,11 @@
[Element] the first matching element
--
-##### [finds](https://github.com/appium/ruby_lib/blob/849594bdd87bf6133cbb64c43d0a02f427f17467/lib/appium_lib/ios/element/generic.rb#L69) ios
+##### [finds](https://github.com/appium/ruby_lib/blob/de58f7164230d7551df8462d65d0e43a3d0cfdab/lib/appium_lib/ios/element/generic.rb#L69) ios
> def finds text
Return all elements matching text.
@@ -1187,11 +1217,11 @@
[Array<Element>] all matching elements
--
-##### [text](https://github.com/appium/ruby_lib/blob/849594bdd87bf6133cbb64c43d0a02f427f17467/lib/appium_lib/ios/element/generic.rb#L79) ios
+##### [text](https://github.com/appium/ruby_lib/blob/de58f7164230d7551df8462d65d0e43a3d0cfdab/lib/appium_lib/ios/element/generic.rb#L79) ios
> def text text
Return the first element matching text.
@@ -1203,11 +1233,11 @@
[Element] the first matching element
--
-##### [texts](https://github.com/appium/ruby_lib/blob/849594bdd87bf6133cbb64c43d0a02f427f17467/lib/appium_lib/ios/element/generic.rb#L87) ios
+##### [texts](https://github.com/appium/ruby_lib/blob/de58f7164230d7551df8462d65d0e43a3d0cfdab/lib/appium_lib/ios/element/generic.rb#L87) ios
> def texts text
Return all elements matching text.
@@ -1219,11 +1249,11 @@
[Array<Element>] all matching elements
--
-##### [name](https://github.com/appium/ruby_lib/blob/849594bdd87bf6133cbb64c43d0a02f427f17467/lib/appium_lib/ios/element/generic.rb#L99) ios
+##### [name](https://github.com/appium/ruby_lib/blob/de58f7164230d7551df8462d65d0e43a3d0cfdab/lib/appium_lib/ios/element/generic.rb#L99) ios
> def name name
Return the first element matching name.
on Android name is content description
@@ -1237,11 +1267,11 @@
[Element] the first matching element
--
-##### [names](https://github.com/appium/ruby_lib/blob/849594bdd87bf6133cbb64c43d0a02f427f17467/lib/appium_lib/ios/element/generic.rb#L108) ios
+##### [names](https://github.com/appium/ruby_lib/blob/de58f7164230d7551df8462d65d0e43a3d0cfdab/lib/appium_lib/ios/element/generic.rb#L108) ios
> def names name
Return all elements matching name.
on Android name is content description
@@ -1255,11 +1285,11 @@
[Array<Element>] all matching elements
--
-##### [textfields](https://github.com/appium/ruby_lib/blob/849594bdd87bf6133cbb64c43d0a02f427f17467/lib/appium_lib/ios/element/textfield.rb#L10) ios
+##### [textfields](https://github.com/appium/ruby_lib/blob/de58f7164230d7551df8462d65d0e43a3d0cfdab/lib/appium_lib/ios/element/textfield.rb#L10) ios
> def textfields
Get an array of textfield texts.
@@ -1267,11 +1297,11 @@
[Array<String>]
--
-##### [e_textfields](https://github.com/appium/ruby_lib/blob/849594bdd87bf6133cbb64c43d0a02f427f17467/lib/appium_lib/ios/element/textfield.rb#L16) ios
+##### [e_textfields](https://github.com/appium/ruby_lib/blob/de58f7164230d7551df8462d65d0e43a3d0cfdab/lib/appium_lib/ios/element/textfield.rb#L16) ios
> def e_textfields
Get an array of textfield elements.
@@ -1279,11 +1309,11 @@
[Array<Textfield>]
--
-##### [first_textfield](https://github.com/appium/ruby_lib/blob/849594bdd87bf6133cbb64c43d0a02f427f17467/lib/appium_lib/ios/element/textfield.rb#L22) ios
+##### [first_textfield](https://github.com/appium/ruby_lib/blob/de58f7164230d7551df8462d65d0e43a3d0cfdab/lib/appium_lib/ios/element/textfield.rb#L22) ios
> def first_textfield
Get the first textfield element.
@@ -1291,11 +1321,11 @@
[Textfield]
--
-##### [last_textfield](https://github.com/appium/ruby_lib/blob/849594bdd87bf6133cbb64c43d0a02f427f17467/lib/appium_lib/ios/element/textfield.rb#L29) ios
+##### [last_textfield](https://github.com/appium/ruby_lib/blob/de58f7164230d7551df8462d65d0e43a3d0cfdab/lib/appium_lib/ios/element/textfield.rb#L29) ios
> def last_textfield
Get the last textfield element.
@@ -1303,11 +1333,11 @@
[Textfield]
--
-##### [textfield](https://github.com/appium/ruby_lib/blob/849594bdd87bf6133cbb64c43d0a02f427f17467/lib/appium_lib/ios/element/textfield.rb#L37) ios
+##### [textfield](https://github.com/appium/ruby_lib/blob/de58f7164230d7551df8462d65d0e43a3d0cfdab/lib/appium_lib/ios/element/textfield.rb#L37) ios
> def textfield text
Get the first textfield that matches text.
@@ -1319,11 +1349,11 @@
[Textfield]
--
-##### [textfield_include](https://github.com/appium/ruby_lib/blob/849594bdd87bf6133cbb64c43d0a02f427f17467/lib/appium_lib/ios/element/textfield.rb#L51) ios
+##### [textfield_include](https://github.com/appium/ruby_lib/blob/de58f7164230d7551df8462d65d0e43a3d0cfdab/lib/appium_lib/ios/element/textfield.rb#L51) ios
> def textfield_include text
Get the first textfield that includes text.
@@ -1335,11 +1365,11 @@
[Textfield]
--
-##### [textfield_exact](https://github.com/appium/ruby_lib/blob/849594bdd87bf6133cbb64c43d0a02f427f17467/lib/appium_lib/ios/element/textfield.rb#L64) ios
+##### [textfield_exact](https://github.com/appium/ruby_lib/blob/de58f7164230d7551df8462d65d0e43a3d0cfdab/lib/appium_lib/ios/element/textfield.rb#L64) ios
> def textfield_exact text
Get the first textfield that exactly matches text.
@@ -1351,40 +1381,40 @@
[Textfield]
--
-##### [value](https://github.com/appium/ruby_lib/blob/849594bdd87bf6133cbb64c43d0a02f427f17467/lib/appium_lib/common/patch.rb#L32)
+##### [value](https://github.com/appium/ruby_lib/blob/de58f7164230d7551df8462d65d0e43a3d0cfdab/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/849594bdd87bf6133cbb64c43d0a02f427f17467/lib/appium_lib/common/patch.rb#L39)
+##### [name](https://github.com/appium/ruby_lib/blob/de58f7164230d7551df8462d65d0e43a3d0cfdab/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/849594bdd87bf6133cbb64c43d0a02f427f17467/lib/appium_lib/common/patch.rb#L46)
+##### [tag_name](https://github.com/appium/ruby_lib/blob/de58f7164230d7551df8462d65d0e43a3d0cfdab/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/849594bdd87bf6133cbb64c43d0a02f427f17467/lib/appium_lib/common/patch.rb#L58)
+##### [location_rel](https://github.com/appium/ruby_lib/blob/de58f7164230d7551df8462d65d0e43a3d0cfdab/lib/appium_lib/common/patch.rb#L58)
> def location_rel
For use with mobile tap.