appium_lib 6.0.0 → 7.0.0

data/docs/ios_docs.md

@@ -1,6 +1,6 @@
-##### [load_appium_txt](https://github.com/appium/ruby_lib/blob/ea11190b9ab36e34226d988f85fe612af6f769de/lib/appium_lib/driver.rb#L69) 
+##### [load_appium_txt](https://github.com/appium/ruby_lib/blob/af838966d0724793d3dbfa35798ca6dd9f8a3143/lib/appium_lib/driver.rb#L70) 
 
-> def self.load_appium_txt opts={}
+> def self.load_appium_txt(opts = {})
 
 Load appium.txt (toml format)
 the basedir of this file + appium.txt is what's used
@@ -27,9 +27,9 @@ __Returns:__
 
 --
 
-##### [symbolize_keys](https://github.com/appium/ruby_lib/blob/ea11190b9ab36e34226d988f85fe612af6f769de/lib/appium_lib/driver.rb#L139) 
+##### [symbolize_keys](https://github.com/appium/ruby_lib/blob/af838966d0724793d3dbfa35798ca6dd9f8a3143/lib/appium_lib/driver.rb#L139) 
 
-> def self.symbolize_keys hash
+> def self.symbolize_keys(hash)
 
 convert all keys (including nested) to symbols
 
@@ -38,9 +38,17 @@ https://github.com/rails/docrails/blob/a3b1105ada3da64acfa3843b164b14b734456a50/
 
 --
 
-##### [promote_singleton_appium_methods](https://github.com/appium/ruby_lib/blob/ea11190b9ab36e34226d988f85fe612af6f769de/lib/appium_lib/driver.rb#L152) 
+##### [promote_singleton_appium_methods](https://github.com/appium/ruby_lib/blob/af838966d0724793d3dbfa35798ca6dd9f8a3143/lib/appium_lib/driver.rb#L160) 
 
-> def self.promote_singleton_appium_methods modules
+> def self.promote_singleton_appium_methods(modules)
+
+This method is intended to work with page objects that share
+a common module. For example, Page::HomePage, Page::SignIn
+those could be promoted on with Appium.promote_singleton_appium_methods Page
+
+If you are promoting on an individual class then you should use
+Appium.promote_appium_methods instead. The singleton method is intended
+only for the shared module use case.
 
 if modules is a module instead of an array, then the constants of
 that module are promoted on.
@@ -48,9 +56,9 @@ otherwise, the array of modules will be used as the promotion target.
 
 --
 
-##### [promote_appium_methods](https://github.com/appium/ruby_lib/blob/ea11190b9ab36e34226d988f85fe612af6f769de/lib/appium_lib/driver.rb#L192) 
+##### [promote_appium_methods](https://github.com/appium/ruby_lib/blob/af838966d0724793d3dbfa35798ca6dd9f8a3143/lib/appium_lib/driver.rb#L211) 
 
-> def self.promote_appium_methods class_array
+> def self.promote_appium_methods(class_array)
 
 Promote appium methods to class instance methods
 
@@ -60,13 +68,25 @@ To promote methods to all classes:
 Appium.promote_appium_methods Object
 ```
 
+It's better to promote on specific classes instead of Object
+
+```ruby
+# promote on rspec
+Appium.promote_appium_methods RSpec::Core::ExampleGroup
+```
+
+```ruby
+# promote on minispec
+Appium.promote_appium_methods Minitest::Spec
+```
+
 __Parameters:__
 
 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Array<Class>] class_array - An array of classes
 
 --
 
-##### [global_webdriver_http_sleep](https://github.com/appium/ruby_lib/blob/ea11190b9ab36e34226d988f85fe612af6f769de/lib/appium_lib/driver.rb#L228) 
+##### [global_webdriver_http_sleep](https://github.com/appium/ruby_lib/blob/af838966d0724793d3dbfa35798ca6dd9f8a3143/lib/appium_lib/driver.rb#L245) 
 
 > def global_webdriver_http_sleep
 
@@ -74,7 +94,7 @@ The amount to sleep in seconds before every webdriver http call.
 
 --
 
-##### [global_webdriver_http_sleep=](https://github.com/appium/ruby_lib/blob/ea11190b9ab36e34226d988f85fe612af6f769de/lib/appium_lib/driver.rb#L228) 
+##### [global_webdriver_http_sleep=](https://github.com/appium/ruby_lib/blob/af838966d0724793d3dbfa35798ca6dd9f8a3143/lib/appium_lib/driver.rb#L245) 
 
 > def global_webdriver_http_sleep=(value)
 
@@ -82,7 +102,7 @@ The amount to sleep in seconds before every webdriver http call.
 
 --
 
-##### [caps](https://github.com/appium/ruby_lib/blob/ea11190b9ab36e34226d988f85fe612af6f769de/lib/appium_lib/driver.rb#L230) 
+##### [caps](https://github.com/appium/ruby_lib/blob/af838966d0724793d3dbfa35798ca6dd9f8a3143/lib/appium_lib/driver.rb#L247) 
 
 > def caps
 
@@ -90,7 +110,7 @@ Selenium webdriver capabilities
 
 --
 
-##### [caps=](https://github.com/appium/ruby_lib/blob/ea11190b9ab36e34226d988f85fe612af6f769de/lib/appium_lib/driver.rb#L230) 
+##### [caps=](https://github.com/appium/ruby_lib/blob/af838966d0724793d3dbfa35798ca6dd9f8a3143/lib/appium_lib/driver.rb#L247) 
 
 > def caps=(value)
 
@@ -98,7 +118,7 @@ Selenium webdriver capabilities
 
 --
 
-##### [custom_url](https://github.com/appium/ruby_lib/blob/ea11190b9ab36e34226d988f85fe612af6f769de/lib/appium_lib/driver.rb#L232) 
+##### [custom_url](https://github.com/appium/ruby_lib/blob/af838966d0724793d3dbfa35798ca6dd9f8a3143/lib/appium_lib/driver.rb#L249) 
 
 > def custom_url
 
@@ -106,7 +126,7 @@ Custom URL for the selenium server
 
 --
 
-##### [custom_url=](https://github.com/appium/ruby_lib/blob/ea11190b9ab36e34226d988f85fe612af6f769de/lib/appium_lib/driver.rb#L232) 
+##### [custom_url=](https://github.com/appium/ruby_lib/blob/af838966d0724793d3dbfa35798ca6dd9f8a3143/lib/appium_lib/driver.rb#L249) 
 
 > def custom_url=(value)
 
@@ -114,7 +134,7 @@ Custom URL for the selenium server
 
 --
 
-##### [export_session](https://github.com/appium/ruby_lib/blob/ea11190b9ab36e34226d988f85fe612af6f769de/lib/appium_lib/driver.rb#L234) 
+##### [export_session](https://github.com/appium/ruby_lib/blob/af838966d0724793d3dbfa35798ca6dd9f8a3143/lib/appium_lib/driver.rb#L251) 
 
 > def export_session
 
@@ -122,7 +142,7 @@ Export session id to textfile in /tmp for 3rd party tools
 
 --
 
-##### [export_session=](https://github.com/appium/ruby_lib/blob/ea11190b9ab36e34226d988f85fe612af6f769de/lib/appium_lib/driver.rb#L234) 
+##### [export_session=](https://github.com/appium/ruby_lib/blob/af838966d0724793d3dbfa35798ca6dd9f8a3143/lib/appium_lib/driver.rb#L251) 
 
 > def export_session=(value)
 
@@ -130,10 +150,11 @@ Export session id to textfile in /tmp for 3rd party tools
 
 --
 
-##### [default_wait](https://github.com/appium/ruby_lib/blob/ea11190b9ab36e34226d988f85fe612af6f769de/lib/appium_lib/driver.rb#L236) 
+##### [default_wait](https://github.com/appium/ruby_lib/blob/af838966d0724793d3dbfa35798ca6dd9f8a3143/lib/appium_lib/driver.rb#L256) 
 
 > def default_wait
 
+Default wait time for elements to appear
 Returns the default client side wait.
 This value is independent of what the server is using
 
@@ -143,15 +164,21 @@ __Returns:__
 
 --
 
-##### [default_wait=](https://github.com/appium/ruby_lib/blob/ea11190b9ab36e34226d988f85fe612af6f769de/lib/appium_lib/driver.rb#L236) 
+##### [default_wait=](https://github.com/appium/ruby_lib/blob/af838966d0724793d3dbfa35798ca6dd9f8a3143/lib/appium_lib/driver.rb#L256) 
 
 > def default_wait=(value)
 
 Default wait time for elements to appear
+Returns the default client side wait.
+This value is independent of what the server is using
+
+__Returns:__
+
+&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Integer] 
 
 --
 
-##### [last_waits](https://github.com/appium/ruby_lib/blob/ea11190b9ab36e34226d988f85fe612af6f769de/lib/appium_lib/driver.rb#L238) 
+##### [last_waits](https://github.com/appium/ruby_lib/blob/af838966d0724793d3dbfa35798ca6dd9f8a3143/lib/appium_lib/driver.rb#L258) 
 
 > def last_waits
 
@@ -159,7 +186,7 @@ Array of previous wait time values
 
 --
 
-##### [last_waits=](https://github.com/appium/ruby_lib/blob/ea11190b9ab36e34226d988f85fe612af6f769de/lib/appium_lib/driver.rb#L238) 
+##### [last_waits=](https://github.com/appium/ruby_lib/blob/af838966d0724793d3dbfa35798ca6dd9f8a3143/lib/appium_lib/driver.rb#L258) 
 
 > def last_waits=(value)
 
@@ -167,7 +194,7 @@ Array of previous wait time values
 
 --
 
-##### [sauce_username](https://github.com/appium/ruby_lib/blob/ea11190b9ab36e34226d988f85fe612af6f769de/lib/appium_lib/driver.rb#L240) 
+##### [sauce_username](https://github.com/appium/ruby_lib/blob/af838966d0724793d3dbfa35798ca6dd9f8a3143/lib/appium_lib/driver.rb#L260) 
 
 > def sauce_username
 
@@ -175,7 +202,7 @@ Username for use on Sauce Labs
 
 --
 
-##### [sauce_username=](https://github.com/appium/ruby_lib/blob/ea11190b9ab36e34226d988f85fe612af6f769de/lib/appium_lib/driver.rb#L240) 
+##### [sauce_username=](https://github.com/appium/ruby_lib/blob/af838966d0724793d3dbfa35798ca6dd9f8a3143/lib/appium_lib/driver.rb#L260) 
 
 > def sauce_username=(value)
 
@@ -183,7 +210,7 @@ Username for use on Sauce Labs
 
 --
 
-##### [sauce_access_key](https://github.com/appium/ruby_lib/blob/ea11190b9ab36e34226d988f85fe612af6f769de/lib/appium_lib/driver.rb#L242) 
+##### [sauce_access_key](https://github.com/appium/ruby_lib/blob/af838966d0724793d3dbfa35798ca6dd9f8a3143/lib/appium_lib/driver.rb#L262) 
 
 > def sauce_access_key
 
@@ -191,7 +218,7 @@ Access Key for use on Sauce Labs
 
 --
 
-##### [sauce_access_key=](https://github.com/appium/ruby_lib/blob/ea11190b9ab36e34226d988f85fe612af6f769de/lib/appium_lib/driver.rb#L242) 
+##### [sauce_access_key=](https://github.com/appium/ruby_lib/blob/af838966d0724793d3dbfa35798ca6dd9f8a3143/lib/appium_lib/driver.rb#L262) 
 
 > def sauce_access_key=(value)
 
@@ -199,7 +226,7 @@ Access Key for use on Sauce Labs
 
 --
 
-##### [appium_port](https://github.com/appium/ruby_lib/blob/ea11190b9ab36e34226d988f85fe612af6f769de/lib/appium_lib/driver.rb#L244) 
+##### [appium_port](https://github.com/appium/ruby_lib/blob/af838966d0724793d3dbfa35798ca6dd9f8a3143/lib/appium_lib/driver.rb#L264) 
 
 > def appium_port
 
@@ -207,7 +234,7 @@ Appium's server port
 
 --
 
-##### [appium_port=](https://github.com/appium/ruby_lib/blob/ea11190b9ab36e34226d988f85fe612af6f769de/lib/appium_lib/driver.rb#L244) 
+##### [appium_port=](https://github.com/appium/ruby_lib/blob/af838966d0724793d3dbfa35798ca6dd9f8a3143/lib/appium_lib/driver.rb#L264) 
 
 > def appium_port=(value)
 
@@ -215,7 +242,7 @@ Appium's server port
 
 --
 
-##### [appium_device](https://github.com/appium/ruby_lib/blob/ea11190b9ab36e34226d988f85fe612af6f769de/lib/appium_lib/driver.rb#L246) 
+##### [appium_device](https://github.com/appium/ruby_lib/blob/af838966d0724793d3dbfa35798ca6dd9f8a3143/lib/appium_lib/driver.rb#L266) 
 
 > def appium_device
 
@@ -223,7 +250,7 @@ Device type to request from the appium server
 
 --
 
-##### [appium_device=](https://github.com/appium/ruby_lib/blob/ea11190b9ab36e34226d988f85fe612af6f769de/lib/appium_lib/driver.rb#L246) 
+##### [appium_device=](https://github.com/appium/ruby_lib/blob/af838966d0724793d3dbfa35798ca6dd9f8a3143/lib/appium_lib/driver.rb#L266) 
 
 > def appium_device=(value)
 
@@ -231,7 +258,7 @@ Device type to request from the appium server
 
 --
 
-##### [appium_debug](https://github.com/appium/ruby_lib/blob/ea11190b9ab36e34226d988f85fe612af6f769de/lib/appium_lib/driver.rb#L248) 
+##### [appium_debug](https://github.com/appium/ruby_lib/blob/af838966d0724793d3dbfa35798ca6dd9f8a3143/lib/appium_lib/driver.rb#L268) 
 
 > def appium_debug
 
@@ -239,7 +266,7 @@ Boolean debug mode for the Appium Ruby bindings
 
 --
 
-##### [appium_debug=](https://github.com/appium/ruby_lib/blob/ea11190b9ab36e34226d988f85fe612af6f769de/lib/appium_lib/driver.rb#L248) 
+##### [appium_debug=](https://github.com/appium/ruby_lib/blob/af838966d0724793d3dbfa35798ca6dd9f8a3143/lib/appium_lib/driver.rb#L268) 
 
 > def appium_debug=(value)
 
@@ -247,9 +274,21 @@ Boolean debug mode for the Appium Ruby bindings
 
 --
 
-##### [initialize](https://github.com/appium/ruby_lib/blob/ea11190b9ab36e34226d988f85fe612af6f769de/lib/appium_lib/driver.rb#L269) 
+##### [driver](https://github.com/appium/ruby_lib/blob/af838966d0724793d3dbfa35798ca6dd9f8a3143/lib/appium_lib/driver.rb#L272) 
 
-> def initialize opts={}
+> def driver
+
+Returns the driver
+
+__Returns:__
+
+&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Driver] the driver
+
+--
+
+##### [initialize](https://github.com/appium/ruby_lib/blob/af838966d0724793d3dbfa35798ca6dd9f8a3143/lib/appium_lib/driver.rb#L293) 
+
+> def initialize(opts = {})
 
 Creates a new driver
 
@@ -278,7 +317,7 @@ __Returns:__
 
 --
 
-##### [driver_attributes](https://github.com/appium/ruby_lib/blob/ea11190b9ab36e34226d988f85fe612af6f769de/lib/appium_lib/driver.rb#L344) 
+##### [driver_attributes](https://github.com/appium/ruby_lib/blob/af838966d0724793d3dbfa35798ca6dd9f8a3143/lib/appium_lib/driver.rb#L359) 
 
 > def driver_attributes
 
@@ -286,7 +325,7 @@ Returns a hash of the driver attributes
 
 --
 
-##### [device_is_android?](https://github.com/appium/ruby_lib/blob/ea11190b9ab36e34226d988f85fe612af6f769de/lib/appium_lib/driver.rb#L364) 
+##### [device_is_android?](https://github.com/appium/ruby_lib/blob/af838966d0724793d3dbfa35798ca6dd9f8a3143/lib/appium_lib/driver.rb#L379) 
 
 > def device_is_android?
 
@@ -298,7 +337,7 @@ __Returns:__
 
 --
 
-##### [appium_server_version](https://github.com/appium/ruby_lib/blob/ea11190b9ab36e34226d988f85fe612af6f769de/lib/appium_lib/driver.rb#L380) 
+##### [appium_server_version](https://github.com/appium/ruby_lib/blob/af838966d0724793d3dbfa35798ca6dd9f8a3143/lib/appium_lib/driver.rb#L395) 
 
 > def appium_server_version
 
@@ -319,9 +358,9 @@ __Returns:__
 
 --
 
-##### [absolute_app_path](https://github.com/appium/ruby_lib/blob/ea11190b9ab36e34226d988f85fe612af6f769de/lib/appium_lib/driver.rb#L392) 
+##### [absolute_app_path](https://github.com/appium/ruby_lib/blob/af838966d0724793d3dbfa35798ca6dd9f8a3143/lib/appium_lib/driver.rb#L407) 
 
-> def self.absolute_app_path opts
+> def self.absolute_app_path(opts)
 
 Converts app_path to an absolute path.
 
@@ -336,7 +375,7 @@ __Returns:__
 
 --
 
-##### [server_url](https://github.com/appium/ruby_lib/blob/ea11190b9ab36e34226d988f85fe612af6f769de/lib/appium_lib/driver.rb#L425) 
+##### [server_url](https://github.com/appium/ruby_lib/blob/af838966d0724793d3dbfa35798ca6dd9f8a3143/lib/appium_lib/driver.rb#L440) 
 
 > def server_url
 
@@ -348,7 +387,7 @@ __Returns:__
 
 --
 
-##### [restart](https://github.com/appium/ruby_lib/blob/ea11190b9ab36e34226d988f85fe612af6f769de/lib/appium_lib/driver.rb#L436) 
+##### [restart](https://github.com/appium/ruby_lib/blob/af838966d0724793d3dbfa35798ca6dd9f8a3143/lib/appium_lib/driver.rb#L451) 
 
 > def restart
 
@@ -360,21 +399,9 @@ __Returns:__
 
 --
 
-##### [driver](https://github.com/appium/ruby_lib/blob/ea11190b9ab36e34226d988f85fe612af6f769de/lib/appium_lib/driver.rb#L443) 
-
-> def driver
-
-Returns the driver
-
-__Returns:__
-
-&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Driver] the driver
-
---
-
-##### [screenshot](https://github.com/appium/ruby_lib/blob/ea11190b9ab36e34226d988f85fe612af6f769de/lib/appium_lib/driver.rb#L453) 
+##### [screenshot](https://github.com/appium/ruby_lib/blob/af838966d0724793d3dbfa35798ca6dd9f8a3143/lib/appium_lib/driver.rb#L462) 
 
-> def screenshot png_save_path
+> def screenshot(png_save_path)
 
 Takes a png screenshot and saves to the target path.
 
@@ -390,7 +417,7 @@ __Returns:__
 
 --
 
-##### [driver_quit](https://github.com/appium/ruby_lib/blob/ea11190b9ab36e34226d988f85fe612af6f769de/lib/appium_lib/driver.rb#L460) 
+##### [driver_quit](https://github.com/appium/ruby_lib/blob/af838966d0724793d3dbfa35798ca6dd9f8a3143/lib/appium_lib/driver.rb#L469) 
 
 > def driver_quit
 
@@ -402,7 +429,7 @@ __Returns:__
 
 --
 
-##### [start_driver](https://github.com/appium/ruby_lib/blob/ea11190b9ab36e34226d988f85fe612af6f769de/lib/appium_lib/driver.rb#L468) 
+##### [start_driver](https://github.com/appium/ruby_lib/blob/af838966d0724793d3dbfa35798ca6dd9f8a3143/lib/appium_lib/driver.rb#L478) 
 
 > def start_driver
 
@@ -414,7 +441,7 @@ __Returns:__
 
 --
 
-##### [no_wait](https://github.com/appium/ruby_lib/blob/ea11190b9ab36e34226d988f85fe612af6f769de/lib/appium_lib/driver.rb#L494) 
+##### [no_wait](https://github.com/appium/ruby_lib/blob/af838966d0724793d3dbfa35798ca6dd9f8a3143/lib/appium_lib/driver.rb#L506) 
 
 > def no_wait
 
@@ -422,9 +449,9 @@ Set implicit wait and default_wait to zero.
 
 --
 
-##### [set_wait](https://github.com/appium/ruby_lib/blob/ea11190b9ab36e34226d988f85fe612af6f769de/lib/appium_lib/driver.rb#L513) 
+##### [set_wait](https://github.com/appium/ruby_lib/blob/af838966d0724793d3dbfa35798ca6dd9f8a3143/lib/appium_lib/driver.rb#L525) 
 
-> def set_wait timeout=nil
+> def set_wait(timeout = nil)
 
 Set implicit wait and default_wait to timeout, defaults to 30.
 if set_wait is called without a param then the second to last
@@ -447,9 +474,9 @@ __Returns:__
 
 --
 
-##### [exists](https://github.com/appium/ruby_lib/blob/ea11190b9ab36e34226d988f85fe612af6f769de/lib/appium_lib/driver.rb#L547) 
+##### [exists](https://github.com/appium/ruby_lib/blob/af838966d0724793d3dbfa35798ca6dd9f8a3143/lib/appium_lib/driver.rb#L552) 
 
-> def exists pre_check=0, post_check=@default_wait, &search_block
+> def exists(pre_check = 0, post_check = @default_wait, &search_block)
 
 Returns existence of element.
 
@@ -473,9 +500,9 @@ __Returns:__
 
 --
 
-##### [execute_script](https://github.com/appium/ruby_lib/blob/ea11190b9ab36e34226d988f85fe612af6f769de/lib/appium_lib/driver.rb#L571) 
+##### [execute_script](https://github.com/appium/ruby_lib/blob/af838966d0724793d3dbfa35798ca6dd9f8a3143/lib/appium_lib/driver.rb#L576) 
 
-> def execute_script script, *args
+> def execute_script(script, *args)
 
 The same as @driver.execute_script
 
@@ -491,9 +518,9 @@ __Returns:__
 
 --
 
-##### [find_elements](https://github.com/appium/ruby_lib/blob/ea11190b9ab36e34226d988f85fe612af6f769de/lib/appium_lib/driver.rb#L579) 
+##### [find_elements](https://github.com/appium/ruby_lib/blob/af838966d0724793d3dbfa35798ca6dd9f8a3143/lib/appium_lib/driver.rb#L584) 
 
-> def find_elements *args
+> def find_elements(*args)
 
 Calls @driver.find_elements
 
@@ -507,9 +534,9 @@ __Returns:__
 
 --
 
-##### [find_element](https://github.com/appium/ruby_lib/blob/ea11190b9ab36e34226d988f85fe612af6f769de/lib/appium_lib/driver.rb#L587) 
+##### [find_element](https://github.com/appium/ruby_lib/blob/af838966d0724793d3dbfa35798ca6dd9f8a3143/lib/appium_lib/driver.rb#L592) 
 
-> def find_element *args
+> def find_element(*args)
 
 Calls @driver.find_elements
 
@@ -523,7 +550,23 @@ __Returns:__
 
 --
 
-##### [x](https://github.com/appium/ruby_lib/blob/ea11190b9ab36e34226d988f85fe612af6f769de/lib/appium_lib/driver.rb#L594) 
+##### [set_location](https://github.com/appium/ruby_lib/blob/af838966d0724793d3dbfa35798ca6dd9f8a3143/lib/appium_lib/driver.rb#L605) 
+
+> def set_location(opts = {})
+
+Calls @driver.set_location
+
+__Parameters:__
+
+&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Hash] opts - consisting of:
+
+__Returns:__
+
+&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Selenium::WebDriver::Location] the location constructed by the selenium webdriver
+
+--
+
+##### [x](https://github.com/appium/ruby_lib/blob/af838966d0724793d3dbfa35798ca6dd9f8a3143/lib/appium_lib/driver.rb#L615) 
 
 > def x
 
@@ -536,7 +579,19 @@ __Returns:__
 
 --
 
-##### [logger](https://github.com/appium/ruby_lib/blob/ea11190b9ab36e34226d988f85fe612af6f769de/lib/appium_lib/logger.rb#L15) 
+##### [logger=](https://github.com/appium/ruby_lib/blob/af838966d0724793d3dbfa35798ca6dd9f8a3143/lib/appium_lib/logger.rb#L13) 
+
+> def logger=(value)
+
+Sets the attribute logger
+
+__Parameters:__
+
+&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;value - the value to set the attribute logger to.
+
+--
+
+##### [logger](https://github.com/appium/ruby_lib/blob/af838966d0724793d3dbfa35798ca6dd9f8a3143/lib/appium_lib/logger.rb#L17) 
 
 > def logger
 
@@ -544,7 +599,7 @@ __Returns:__
 
 --
 
-##### [NoArgMethods](https://github.com/appium/ruby_lib/blob/ea11190b9ab36e34226d988f85fe612af6f769de/lib/appium_lib/device/device.rb#L7) 
+##### [NoArgMethods](https://github.com/appium/ruby_lib/blob/af838966d0724793d3dbfa35798ca6dd9f8a3143/lib/appium_lib/device/device.rb#L7) 
 
 > NoArgMethods = {
 
@@ -552,7 +607,7 @@ __Returns:__
 
 --
 
-##### [app_strings](https://github.com/appium/ruby_lib/blob/ea11190b9ab36e34226d988f85fe612af6f769de/lib/appium_lib/device/device.rb#L23) 
+##### [app_strings](https://github.com/appium/ruby_lib/blob/af838966d0724793d3dbfa35798ca6dd9f8a3143/lib/appium_lib/device/device.rb#L24) 
 
 > def app_strings
 
@@ -563,7 +618,7 @@ app_strings #=> "TransitionsTitle"=>"Transitions", "WebTitle"=>"Web"
 
 --
 
-##### [background_app](https://github.com/appium/ruby_lib/blob/ea11190b9ab36e34226d988f85fe612af6f769de/lib/appium_lib/device/device.rb#L29) 
+##### [background_app](https://github.com/appium/ruby_lib/blob/af838966d0724793d3dbfa35798ca6dd9f8a3143/lib/appium_lib/device/device.rb#L30) 
 
 > def background_app
 
@@ -572,7 +627,7 @@ This is a blocking application
 
 --
 
-##### [current_activity](https://github.com/appium/ruby_lib/blob/ea11190b9ab36e34226d988f85fe612af6f769de/lib/appium_lib/device/device.rb#L34) 
+##### [current_activity](https://github.com/appium/ruby_lib/blob/af838966d0724793d3dbfa35798ca6dd9f8a3143/lib/appium_lib/device/device.rb#L35) 
 
 > def current_activity
 
@@ -580,15 +635,15 @@ This is a blocking application
 
 --
 
-##### [launch_app](https://github.com/appium/ruby_lib/blob/ea11190b9ab36e34226d988f85fe612af6f769de/lib/appium_lib/device/device.rb#L36) 
+##### [launch_app](https://github.com/appium/ruby_lib/blob/af838966d0724793d3dbfa35798ca6dd9f8a3143/lib/appium_lib/device/device.rb#L37) 
 
 > def launch_app
 
-Start the simulator and applicaton configured with desired capabilities
+Start the simulator and application configured with desired capabilities
 
 --
 
-##### [reset](https://github.com/appium/ruby_lib/blob/ea11190b9ab36e34226d988f85fe612af6f769de/lib/appium_lib/device/device.rb#L39) 
+##### [reset](https://github.com/appium/ruby_lib/blob/af838966d0724793d3dbfa35798ca6dd9f8a3143/lib/appium_lib/device/device.rb#L40) 
 
 > def reset
 
@@ -596,7 +651,7 @@ Reset the device, relaunching the application.
 
 --
 
-##### [shake](https://github.com/appium/ruby_lib/blob/ea11190b9ab36e34226d988f85fe612af6f769de/lib/appium_lib/device/device.rb#L42) 
+##### [shake](https://github.com/appium/ruby_lib/blob/af838966d0724793d3dbfa35798ca6dd9f8a3143/lib/appium_lib/device/device.rb#L43) 
 
 > def shake
 
@@ -604,15 +659,23 @@ Cause the device to shake
 
 --
 
-##### [toggle_flight_mode](https://github.com/appium/ruby_lib/blob/ea11190b9ab36e34226d988f85fe612af6f769de/lib/appium_lib/device/device.rb#L45) 
+##### [toggle_flight_mode](https://github.com/appium/ruby_lib/blob/af838966d0724793d3dbfa35798ca6dd9f8a3143/lib/appium_lib/device/device.rb#L46) 
 
 > def toggle_flight_mode
 
-toggle flight mode on or off
+Toggle flight mode on or off
+
+--
+
+##### [device_locked?](https://github.com/appium/ruby_lib/blob/af838966d0724793d3dbfa35798ca6dd9f8a3143/lib/appium_lib/device/device.rb#L49) 
+
+> def device_locked?
+
+
 
 --
 
-##### [hide_keyboard](https://github.com/appium/ruby_lib/blob/ea11190b9ab36e34226d988f85fe612af6f769de/lib/appium_lib/device/device.rb#L48) 
+##### [hide_keyboard](https://github.com/appium/ruby_lib/blob/af838966d0724793d3dbfa35798ca6dd9f8a3143/lib/appium_lib/device/device.rb#L51) 
 
 > def hide_keyboard
 
@@ -625,7 +688,7 @@ Defaults to 'Done'.
 
 --
 
-##### [press_keycode](https://github.com/appium/ruby_lib/blob/ea11190b9ab36e34226d988f85fe612af6f769de/lib/appium_lib/device/device.rb#L57) 
+##### [press_keycode](https://github.com/appium/ruby_lib/blob/af838966d0724793d3dbfa35798ca6dd9f8a3143/lib/appium_lib/device/device.rb#L60) 
 
 > def press_keycode
 
@@ -640,7 +703,7 @@ __Parameters:__
 
 --
 
-##### [long_press_keycode](https://github.com/appium/ruby_lib/blob/ea11190b9ab36e34226d988f85fe612af6f769de/lib/appium_lib/device/device.rb#L63) 
+##### [long_press_keycode](https://github.com/appium/ruby_lib/blob/af838966d0724793d3dbfa35798ca6dd9f8a3143/lib/appium_lib/device/device.rb#L66) 
 
 > def long_press_keycode
 
@@ -655,7 +718,7 @@ __Parameters:__
 
 --
 
-##### [push_file](https://github.com/appium/ruby_lib/blob/ea11190b9ab36e34226d988f85fe612af6f769de/lib/appium_lib/device/device.rb#L69) 
+##### [push_file](https://github.com/appium/ruby_lib/blob/af838966d0724793d3dbfa35798ca6dd9f8a3143/lib/appium_lib/device/device.rb#L72) 
 
 > def push_file
 
@@ -669,7 +732,7 @@ __Parameters:__
 
 --
 
-##### [pull_file](https://github.com/appium/ruby_lib/blob/ea11190b9ab36e34226d988f85fe612af6f769de/lib/appium_lib/device/device.rb#L74) 
+##### [pull_file](https://github.com/appium/ruby_lib/blob/af838966d0724793d3dbfa35798ca6dd9f8a3143/lib/appium_lib/device/device.rb#L77) 
 
 > def pull_file
 
@@ -686,7 +749,7 @@ __Parameters:__
 
 --
 
-##### [pull_folder](https://github.com/appium/ruby_lib/blob/ea11190b9ab36e34226d988f85fe612af6f769de/lib/appium_lib/device/device.rb#L84) 
+##### [pull_folder](https://github.com/appium/ruby_lib/blob/af838966d0724793d3dbfa35798ca6dd9f8a3143/lib/appium_lib/device/device.rb#L87) 
 
 > def pull_folder
 
@@ -701,7 +764,7 @@ __Parameters:__
 
 --
 
-##### [end_coverage](https://github.com/appium/ruby_lib/blob/ea11190b9ab36e34226d988f85fe612af6f769de/lib/appium_lib/device/device.rb#L92) 
+##### [end_coverage](https://github.com/appium/ruby_lib/blob/af838966d0724793d3dbfa35798ca6dd9f8a3143/lib/appium_lib/device/device.rb#L95) 
 
 > def end_coverage
 
@@ -715,7 +778,7 @@ __Parameters:__
 
 --
 
-##### [get_settings](https://github.com/appium/ruby_lib/blob/ea11190b9ab36e34226d988f85fe612af6f769de/lib/appium_lib/device/device.rb#L97) 
+##### [get_settings](https://github.com/appium/ruby_lib/blob/af838966d0724793d3dbfa35798ca6dd9f8a3143/lib/appium_lib/device/device.rb#L100) 
 
 > def get_settings
 
@@ -723,7 +786,7 @@ Get appium Settings for current test session
 
 --
 
-##### [extend_search_contexts](https://github.com/appium/ruby_lib/blob/ea11190b9ab36e34226d988f85fe612af6f769de/lib/appium_lib/device/device.rb#L345) 
+##### [extend_search_contexts](https://github.com/appium/ruby_lib/blob/af838966d0724793d3dbfa35798ca6dd9f8a3143/lib/appium_lib/device/device.rb#L351) 
 
 > def extend_search_contexts
 
@@ -731,7 +794,7 @@ Get appium Settings for current test session
 
 --
 
-##### [accessiblity_id_find](https://github.com/appium/ruby_lib/blob/ea11190b9ab36e34226d988f85fe612af6f769de/lib/appium_lib/device/device.rb#L345) 
+##### [accessiblity_id_find](https://github.com/appium/ruby_lib/blob/af838966d0724793d3dbfa35798ca6dd9f8a3143/lib/appium_lib/device/device.rb#L351) 
 
 > def accessiblity_id_find
 
@@ -743,7 +806,7 @@ find_element/s with their accessibility_id
 
 --
 
-##### [add_touch_actions](https://github.com/appium/ruby_lib/blob/ea11190b9ab36e34226d988f85fe612af6f769de/lib/appium_lib/device/device.rb#L351) 
+##### [add_touch_actions](https://github.com/appium/ruby_lib/blob/af838966d0724793d3dbfa35798ca6dd9f8a3143/lib/appium_lib/device/device.rb#L357) 
 
 > def add_touch_actions
 
@@ -751,7 +814,7 @@ find_element/s with their accessibility_id
 
 --
 
-##### [set_context](https://github.com/appium/ruby_lib/blob/ea11190b9ab36e34226d988f85fe612af6f769de/lib/appium_lib/device/device.rb#L375) 
+##### [set_context](https://github.com/appium/ruby_lib/blob/af838966d0724793d3dbfa35798ca6dd9f8a3143/lib/appium_lib/device/device.rb#L381) 
 
 > def set_context
 
@@ -766,7 +829,7 @@ __Parameters:__
 
 --
 
-##### [current_context](https://github.com/appium/ruby_lib/blob/ea11190b9ab36e34226d988f85fe612af6f769de/lib/appium_lib/device/device.rb#L383) 
+##### [current_context](https://github.com/appium/ruby_lib/blob/af838966d0724793d3dbfa35798ca6dd9f8a3143/lib/appium_lib/device/device.rb#L389) 
 
 > def current_context
 
@@ -778,7 +841,7 @@ __Returns:__
 
 --
 
-##### [available_contexts](https://github.com/appium/ruby_lib/blob/ea11190b9ab36e34226d988f85fe612af6f769de/lib/appium_lib/device/device.rb#L386) 
+##### [available_contexts](https://github.com/appium/ruby_lib/blob/af838966d0724793d3dbfa35798ca6dd9f8a3143/lib/appium_lib/device/device.rb#L392) 
 
 > def available_contexts
 
@@ -790,7 +853,7 @@ __Returns:__
 
 --
 
-##### [within_context](https://github.com/appium/ruby_lib/blob/ea11190b9ab36e34226d988f85fe612af6f769de/lib/appium_lib/device/device.rb#L396) 
+##### [within_context](https://github.com/appium/ruby_lib/blob/af838966d0724793d3dbfa35798ca6dd9f8a3143/lib/appium_lib/device/device.rb#L402) 
 
 > def within_context(context)
 
@@ -806,7 +869,7 @@ __Parameters:__
 
 --
 
-##### [switch_to_default_context](https://github.com/appium/ruby_lib/blob/ea11190b9ab36e34226d988f85fe612af6f769de/lib/appium_lib/device/device.rb#L404) 
+##### [switch_to_default_context](https://github.com/appium/ruby_lib/blob/af838966d0724793d3dbfa35798ca6dd9f8a3143/lib/appium_lib/device/device.rb#L410) 
 
 > def switch_to_default_context
 
@@ -814,9 +877,9 @@ Change to the default context.  This is equivalent to `set_context nil`.
 
 --
 
-##### [pinch](https://github.com/appium/ruby_lib/blob/ea11190b9ab36e34226d988f85fe612af6f769de/lib/appium_lib/device/multi_touch.rb#L30) 
+##### [pinch](https://github.com/appium/ruby_lib/blob/af838966d0724793d3dbfa35798ca6dd9f8a3143/lib/appium_lib/device/multi_touch.rb#L28) 
 
-> def pinch(percentage=25, auto_perform=true)
+> def pinch(percentage = 25, auto_perform = true)
 
 Convenience method for pinching the screen.
 Places two fingers at the edges of the screen and brings them together.
@@ -833,9 +896,9 @@ __Parameters:__
 
 --
 
-##### [zoom](https://github.com/appium/ruby_lib/blob/ea11190b9ab36e34226d988f85fe612af6f769de/lib/appium_lib/device/multi_touch.rb#L58) 
+##### [zoom](https://github.com/appium/ruby_lib/blob/af838966d0724793d3dbfa35798ca6dd9f8a3143/lib/appium_lib/device/multi_touch.rb#L56) 
 
-> def zoom(percentage=200, auto_perform=true)
+> def zoom(percentage = 200, auto_perform = true)
 
 Convenience method for zooming the screen.
 Places two fingers at the edges of the screen and brings them together.
@@ -852,7 +915,7 @@ __Parameters:__
 
 --
 
-##### [initialize](https://github.com/appium/ruby_lib/blob/ea11190b9ab36e34226d988f85fe612af6f769de/lib/appium_lib/device/multi_touch.rb#L79) 
+##### [initialize](https://github.com/appium/ruby_lib/blob/af838966d0724793d3dbfa35798ca6dd9f8a3143/lib/appium_lib/device/multi_touch.rb#L77) 
 
 > def initialize
 
@@ -864,7 +927,7 @@ __Returns:__
 
 --
 
-##### [add](https://github.com/appium/ruby_lib/blob/ea11190b9ab36e34226d988f85fe612af6f769de/lib/appium_lib/device/multi_touch.rb#L85) 
+##### [add](https://github.com/appium/ruby_lib/blob/af838966d0724793d3dbfa35798ca6dd9f8a3143/lib/appium_lib/device/multi_touch.rb#L83) 
 
 > def add(chain)
 
@@ -876,7 +939,7 @@ __Parameters:__
 
 --
 
-##### [perform](https://github.com/appium/ruby_lib/blob/ea11190b9ab36e34226d988f85fe612af6f769de/lib/appium_lib/device/multi_touch.rb#L90) 
+##### [perform](https://github.com/appium/ruby_lib/blob/af838966d0724793d3dbfa35798ca6dd9f8a3143/lib/appium_lib/device/multi_touch.rb#L88) 
 
 > def perform
 
@@ -884,7 +947,7 @@ Ask Appium to perform the actions
 
 --
 
-##### [ACTIONS](https://github.com/appium/ruby_lib/blob/ea11190b9ab36e34226d988f85fe612af6f769de/lib/appium_lib/device/touch_actions.rb#L12) 
+##### [ACTIONS](https://github.com/appium/ruby_lib/blob/af838966d0724793d3dbfa35798ca6dd9f8a3143/lib/appium_lib/device/touch_actions.rb#L11) 
 
 > ACTIONS         = [:move_to, :long_press, :press, :release, :tap, :wait, :perform]
 
@@ -892,7 +955,7 @@ Ask Appium to perform the actions
 
 --
 
-##### [COMPLEX_ACTIONS](https://github.com/appium/ruby_lib/blob/ea11190b9ab36e34226d988f85fe612af6f769de/lib/appium_lib/device/touch_actions.rb#L13) 
+##### [COMPLEX_ACTIONS](https://github.com/appium/ruby_lib/blob/af838966d0724793d3dbfa35798ca6dd9f8a3143/lib/appium_lib/device/touch_actions.rb#L12) 
 
 > COMPLEX_ACTIONS = [:swipe]
 
@@ -900,7 +963,7 @@ Ask Appium to perform the actions
 
 --
 
-##### [actions](https://github.com/appium/ruby_lib/blob/ea11190b9ab36e34226d988f85fe612af6f769de/lib/appium_lib/device/touch_actions.rb#L27) 
+##### [actions](https://github.com/appium/ruby_lib/blob/af838966d0724793d3dbfa35798ca6dd9f8a3143/lib/appium_lib/device/touch_actions.rb#L26) 
 
 > def actions
 
@@ -908,7 +971,7 @@ Returns the value of attribute actions
 
 --
 
-##### [initialize](https://github.com/appium/ruby_lib/blob/ea11190b9ab36e34226d988f85fe612af6f769de/lib/appium_lib/device/touch_actions.rb#L29) 
+##### [initialize](https://github.com/appium/ruby_lib/blob/af838966d0724793d3dbfa35798ca6dd9f8a3143/lib/appium_lib/device/touch_actions.rb#L28) 
 
 > def initialize
 
@@ -920,7 +983,7 @@ __Returns:__
 
 --
 
-##### [move_to](https://github.com/appium/ruby_lib/blob/ea11190b9ab36e34226d988f85fe612af6f769de/lib/appium_lib/device/touch_actions.rb#L37) 
+##### [move_to](https://github.com/appium/ruby_lib/blob/af838966d0724793d3dbfa35798ca6dd9f8a3143/lib/appium_lib/device/touch_actions.rb#L36) 
 
 > def move_to(opts)
 
@@ -932,7 +995,7 @@ __Parameters:__
 
 --
 
-##### [long_press](https://github.com/appium/ruby_lib/blob/ea11190b9ab36e34226d988f85fe612af6f769de/lib/appium_lib/device/touch_actions.rb#L47) 
+##### [long_press](https://github.com/appium/ruby_lib/blob/af838966d0724793d3dbfa35798ca6dd9f8a3143/lib/appium_lib/device/touch_actions.rb#L46) 
 
 > def long_press(opts)
 
@@ -950,7 +1013,7 @@ __Parameters:__
 
 --
 
-##### [press](https://github.com/appium/ruby_lib/blob/ea11190b9ab36e34226d988f85fe612af6f769de/lib/appium_lib/device/touch_actions.rb#L59) 
+##### [press](https://github.com/appium/ruby_lib/blob/af838966d0724793d3dbfa35798ca6dd9f8a3143/lib/appium_lib/device/touch_actions.rb#L58) 
 
 > def press(opts)
 
@@ -963,9 +1026,9 @@ __Parameters:__
 
 --
 
-##### [release](https://github.com/appium/ruby_lib/blob/ea11190b9ab36e34226d988f85fe612af6f769de/lib/appium_lib/device/touch_actions.rb#L70) 
+##### [release](https://github.com/appium/ruby_lib/blob/af838966d0724793d3dbfa35798ca6dd9f8a3143/lib/appium_lib/device/touch_actions.rb#L69) 
 
-> def release(opts=nil)
+> def release(opts = nil)
 
 Remove a finger from the screen.
 
@@ -975,7 +1038,7 @@ __Parameters:__
 
 --
 
-##### [tap](https://github.com/appium/ruby_lib/blob/ea11190b9ab36e34226d988f85fe612af6f769de/lib/appium_lib/device/touch_actions.rb#L81) 
+##### [tap](https://github.com/appium/ruby_lib/blob/af838966d0724793d3dbfa35798ca6dd9f8a3143/lib/appium_lib/device/touch_actions.rb#L80) 
 
 > def tap(opts)
 
@@ -987,7 +1050,7 @@ __Parameters:__
 
 --
 
-##### [wait](https://github.com/appium/ruby_lib/blob/ea11190b9ab36e34226d988f85fe612af6f769de/lib/appium_lib/device/touch_actions.rb#L90) 
+##### [wait](https://github.com/appium/ruby_lib/blob/af838966d0724793d3dbfa35798ca6dd9f8a3143/lib/appium_lib/device/touch_actions.rb#L89) 
 
 > def wait(milliseconds)
 
@@ -999,7 +1062,7 @@ __Parameters:__
 
 --
 
-##### [swipe](https://github.com/appium/ruby_lib/blob/ea11190b9ab36e34226d988f85fe612af6f769de/lib/appium_lib/device/touch_actions.rb#L104) 
+##### [swipe](https://github.com/appium/ruby_lib/blob/af838966d0724793d3dbfa35798ca6dd9f8a3143/lib/appium_lib/device/touch_actions.rb#L103) 
 
 > def swipe(opts)
 
@@ -1013,7 +1076,7 @@ __Parameters:__
 
 --
 
-##### [perform](https://github.com/appium/ruby_lib/blob/ea11190b9ab36e34226d988f85fe612af6f769de/lib/appium_lib/device/touch_actions.rb#L119) 
+##### [perform](https://github.com/appium/ruby_lib/blob/af838966d0724793d3dbfa35798ca6dd9f8a3143/lib/appium_lib/device/touch_actions.rb#L118) 
 
 > def perform
 
@@ -1021,7 +1084,7 @@ Ask the driver to perform all actions in this action chain.
 
 --
 
-##### [cancel](https://github.com/appium/ruby_lib/blob/ea11190b9ab36e34226d988f85fe612af6f769de/lib/appium_lib/device/touch_actions.rb#L125) 
+##### [cancel](https://github.com/appium/ruby_lib/blob/af838966d0724793d3dbfa35798ca6dd9f8a3143/lib/appium_lib/device/touch_actions.rb#L124) 
 
 > def cancel
 
@@ -1029,15 +1092,15 @@ Does nothing, currently.
 
 --
 
-##### [chain_method](https://github.com/appium/ruby_lib/blob/ea11190b9ab36e34226d988f85fe612af6f769de/lib/appium_lib/device/touch_actions.rb#L133) 
+##### [chain_method](https://github.com/appium/ruby_lib/blob/af838966d0724793d3dbfa35798ca6dd9f8a3143/lib/appium_lib/device/touch_actions.rb#L132) 
 
-> def chain_method(method, args=nil)
+> def chain_method(method, args = nil)
 
 
 
 --
 
-##### [args_with_ele_ref](https://github.com/appium/ruby_lib/blob/ea11190b9ab36e34226d988f85fe612af6f769de/lib/appium_lib/device/touch_actions.rb#L142) 
+##### [args_with_ele_ref](https://github.com/appium/ruby_lib/blob/af838966d0724793d3dbfa35798ca6dd9f8a3143/lib/appium_lib/device/touch_actions.rb#L141) 
 
 > def args_with_ele_ref(args)
 
@@ -1045,26 +1108,26 @@ Does nothing, currently.
 
 --
 
-##### [_generic_wait](https://github.com/appium/ruby_lib/blob/ea11190b9ab36e34226d988f85fe612af6f769de/lib/appium_lib/common/wait.rb#L10) 
+##### [_generic_wait](https://github.com/appium/ruby_lib/blob/af838966d0724793d3dbfa35798ca6dd9f8a3143/lib/appium_lib/common/wait.rb#L9) 
 
-> def _generic_wait opts={}, &block
+> def _generic_wait(opts = {}, &block)
 
 Wait code from the selenium Ruby gem
 https://github.com/SeleniumHQ/selenium/blob/cf501dda3f0ed12233de51ce8170c0e8090f0c20/rb/lib/selenium/webdriver/common/wait.rb
 
 --
 
-##### [_process_wait_opts](https://github.com/appium/ruby_lib/blob/ea11190b9ab36e34226d988f85fe612af6f769de/lib/appium_lib/common/wait.rb#L55) 
+##### [_process_wait_opts](https://github.com/appium/ruby_lib/blob/af838966d0724793d3dbfa35798ca6dd9f8a3143/lib/appium_lib/common/wait.rb#L54) 
 
-> def _process_wait_opts opts
+> def _process_wait_opts(opts)
 
 process opts before calling _generic_wait
 
 --
 
-##### [wait_true](https://github.com/appium/ruby_lib/blob/ea11190b9ab36e34226d988f85fe612af6f769de/lib/appium_lib/common/wait.rb#L76) 
+##### [wait_true](https://github.com/appium/ruby_lib/blob/af838966d0724793d3dbfa35798ca6dd9f8a3143/lib/appium_lib/common/wait.rb#L75) 
 
-> def wait_true opts={}, &block
+> def wait_true(opts = {}, &block)
 
 Check every interval seconds to see if block.call returns a truthy value.
 Note this isn't a strict boolean true, any truthy value is accepted.
@@ -1082,9 +1145,9 @@ __Parameters:__
 
 --
 
-##### [wait](https://github.com/appium/ruby_lib/blob/ea11190b9ab36e34226d988f85fe612af6f769de/lib/appium_lib/common/wait.rb#L94) 
+##### [wait](https://github.com/appium/ruby_lib/blob/af838966d0724793d3dbfa35798ca6dd9f8a3143/lib/appium_lib/common/wait.rb#L93) 
 
-> def wait opts={}, &block
+> def wait(opts = {}, &block)
 
 Check every interval seconds to see if block.call doesn't raise an exception.
 Give up after timeout seconds.
@@ -1100,15 +1163,15 @@ __Parameters:__
 
 --
 
-##### [ignore](https://github.com/appium/ruby_lib/blob/ea11190b9ab36e34226d988f85fe612af6f769de/lib/appium_lib/common/helper.rb#L24) 
+##### [ignore](https://github.com/appium/ruby_lib/blob/af838966d0724793d3dbfa35798ca6dd9f8a3143/lib/appium_lib/common/helper.rb#L24) 
 
-> def ignore &block
+> def ignore(&block)
 
 Return block.call and ignore any exceptions.
 
 --
 
-##### [back](https://github.com/appium/ruby_lib/blob/ea11190b9ab36e34226d988f85fe612af6f769de/lib/appium_lib/common/helper.rb#L33) 
+##### [back](https://github.com/appium/ruby_lib/blob/af838966d0724793d3dbfa35798ca6dd9f8a3143/lib/appium_lib/common/helper.rb#L31) 
 
 > def back
 
@@ -1120,7 +1183,7 @@ __Returns:__
 
 --
 
-##### [session_id](https://github.com/appium/ruby_lib/blob/ea11190b9ab36e34226d988f85fe612af6f769de/lib/appium_lib/common/helper.rb#L38) 
+##### [session_id](https://github.com/appium/ruby_lib/blob/af838966d0724793d3dbfa35798ca6dd9f8a3143/lib/appium_lib/common/helper.rb#L36) 
 
 > def session_id
 
@@ -1128,9 +1191,9 @@ For Sauce Labs reporting. Returns the current session id.
 
 --
 
-##### [xpath](https://github.com/appium/ruby_lib/blob/ea11190b9ab36e34226d988f85fe612af6f769de/lib/appium_lib/common/helper.rb#L46) 
+##### [xpath](https://github.com/appium/ruby_lib/blob/af838966d0724793d3dbfa35798ca6dd9f8a3143/lib/appium_lib/common/helper.rb#L44) 
 
-> def xpath xpath_str
+> def xpath(xpath_str)
 
 Returns the first element that matches the provided xpath.
 
@@ -1144,9 +1207,9 @@ __Returns:__
 
 --
 
-##### [xpaths](https://github.com/appium/ruby_lib/blob/ea11190b9ab36e34226d988f85fe612af6f769de/lib/appium_lib/common/helper.rb#L54) 
+##### [xpaths](https://github.com/appium/ruby_lib/blob/af838966d0724793d3dbfa35798ca6dd9f8a3143/lib/appium_lib/common/helper.rb#L52) 
 
-> def xpaths xpath_str
+> def xpaths(xpath_str)
 
 Returns all elements that match the provided xpath.
 
@@ -1160,15 +1223,15 @@ __Returns:__
 
 --
 
-##### [_print_source](https://github.com/appium/ruby_lib/blob/ea11190b9ab36e34226d988f85fe612af6f769de/lib/appium_lib/common/helper.rb#L58) 
+##### [_print_source](https://github.com/appium/ruby_lib/blob/af838966d0724793d3dbfa35798ca6dd9f8a3143/lib/appium_lib/common/helper.rb#L56) 
 
-> def _print_source source
+> def _print_source(source)
 
 
 
 --
 
-##### [result](https://github.com/appium/ruby_lib/blob/ea11190b9ab36e34226d988f85fe612af6f769de/lib/appium_lib/common/helper.rb#L71) 
+##### [result](https://github.com/appium/ruby_lib/blob/af838966d0724793d3dbfa35798ca6dd9f8a3143/lib/appium_lib/common/helper.rb#L69) 
 
 > def result
 
@@ -1176,7 +1239,7 @@ Returns the value of attribute result
 
 --
 
-##### [initialize](https://github.com/appium/ruby_lib/blob/ea11190b9ab36e34226d988f85fe612af6f769de/lib/appium_lib/common/helper.rb#L73) 
+##### [initialize](https://github.com/appium/ruby_lib/blob/af838966d0724793d3dbfa35798ca6dd9f8a3143/lib/appium_lib/common/helper.rb#L71) 
 
 > def initialize
 
@@ -1188,7 +1251,7 @@ __Returns:__
 
 --
 
-##### [reset](https://github.com/appium/ruby_lib/blob/ea11190b9ab36e34226d988f85fe612af6f769de/lib/appium_lib/common/helper.rb#L77) 
+##### [reset](https://github.com/appium/ruby_lib/blob/af838966d0724793d3dbfa35798ca6dd9f8a3143/lib/appium_lib/common/helper.rb#L75) 
 
 > def reset
 
@@ -1196,15 +1259,15 @@ __Returns:__
 
 --
 
-##### [start_element](https://github.com/appium/ruby_lib/blob/ea11190b9ab36e34226d988f85fe612af6f769de/lib/appium_lib/common/helper.rb#L82) 
+##### [start_element](https://github.com/appium/ruby_lib/blob/af838966d0724793d3dbfa35798ca6dd9f8a3143/lib/appium_lib/common/helper.rb#L80) 
 
-> def start_element name, attrs = []
+> def start_element(name, attrs = [])
 
 http://nokogiri.org/Nokogiri/XML/SAX/Document.html
 
 --
 
-##### [formatted_result](https://github.com/appium/ruby_lib/blob/ea11190b9ab36e34226d988f85fe612af6f769de/lib/appium_lib/common/helper.rb#L88) 
+##### [formatted_result](https://github.com/appium/ruby_lib/blob/af838966d0724793d3dbfa35798ca6dd9f8a3143/lib/appium_lib/common/helper.rb#L86) 
 
 > def formatted_result
 
@@ -1212,7 +1275,7 @@ http://nokogiri.org/Nokogiri/XML/SAX/Document.html
 
 --
 
-##### [get_page_class](https://github.com/appium/ruby_lib/blob/ea11190b9ab36e34226d988f85fe612af6f769de/lib/appium_lib/common/helper.rb#L99) 
+##### [get_page_class](https://github.com/appium/ruby_lib/blob/af838966d0724793d3dbfa35798ca6dd9f8a3143/lib/appium_lib/common/helper.rb#L97) 
 
 > def get_page_class
 
@@ -1220,7 +1283,7 @@ Returns a string of class counts of visible elements.
 
 --
 
-##### [page_class](https://github.com/appium/ruby_lib/blob/ea11190b9ab36e34226d988f85fe612af6f769de/lib/appium_lib/common/helper.rb#L110) 
+##### [page_class](https://github.com/appium/ruby_lib/blob/af838966d0724793d3dbfa35798ca6dd9f8a3143/lib/appium_lib/common/helper.rb#L108) 
 
 > def page_class
 
@@ -1229,9 +1292,9 @@ Useful for appium_console.
 
 --
 
-##### [px_to_window_rel](https://github.com/appium/ruby_lib/blob/ea11190b9ab36e34226d988f85fe612af6f769de/lib/appium_lib/common/helper.rb#L120) 
+##### [px_to_window_rel](https://github.com/appium/ruby_lib/blob/af838966d0724793d3dbfa35798ca6dd9f8a3143/lib/appium_lib/common/helper.rb#L118) 
 
-> def px_to_window_rel opts={}
+> def px_to_window_rel(opts = {})
 
 Converts pixel values to window relative values
 
@@ -1241,9 +1304,9 @@ px_to_window_rel x: 50, y: 150
 
 --
 
-##### [xml_keys](https://github.com/appium/ruby_lib/blob/ea11190b9ab36e34226d988f85fe612af6f769de/lib/appium_lib/common/helper.rb#L139) 
+##### [xml_keys](https://github.com/appium/ruby_lib/blob/af838966d0724793d3dbfa35798ca6dd9f8a3143/lib/appium_lib/common/helper.rb#L137) 
 
-> def xml_keys target
+> def xml_keys(target)
 
 Search strings.xml's values for target.
 
@@ -1257,9 +1320,9 @@ __Returns:__
 
 --
 
-##### [xml_values](https://github.com/appium/ruby_lib/blob/ea11190b9ab36e34226d988f85fe612af6f769de/lib/appium_lib/common/helper.rb#L147) 
+##### [xml_values](https://github.com/appium/ruby_lib/blob/af838966d0724793d3dbfa35798ca6dd9f8a3143/lib/appium_lib/common/helper.rb#L145) 
 
-> def xml_values target
+> def xml_values(target)
 
 Search strings.xml's keys for target.
 
@@ -1273,9 +1336,9 @@ __Returns:__
 
 --
 
-##### [resolve_id](https://github.com/appium/ruby_lib/blob/ea11190b9ab36e34226d988f85fe612af6f769de/lib/appium_lib/common/helper.rb#L155) 
+##### [resolve_id](https://github.com/appium/ruby_lib/blob/af838966d0724793d3dbfa35798ca6dd9f8a3143/lib/appium_lib/common/helper.rb#L153) 
 
-> def resolve_id id
+> def resolve_id(id)
 
 Resolve id in strings.xml and return the value.
 
@@ -1289,23 +1352,23 @@ __Returns:__
 
 --
 
-##### [filter](https://github.com/appium/ruby_lib/blob/ea11190b9ab36e34226d988f85fe612af6f769de/lib/appium_lib/common/helper.rb#L161) 
+##### [filter](https://github.com/appium/ruby_lib/blob/af838966d0724793d3dbfa35798ca6dd9f8a3143/lib/appium_lib/common/helper.rb#L159) 
 
 > def filter
 
-
+Returns the value of attribute filter
 
 --
 
-##### [filter=](https://github.com/appium/ruby_lib/blob/ea11190b9ab36e34226d988f85fe612af6f769de/lib/appium_lib/common/helper.rb#L166) 
+##### [filter=](https://github.com/appium/ruby_lib/blob/af838966d0724793d3dbfa35798ca6dd9f8a3143/lib/appium_lib/common/helper.rb#L162) 
 
-> def filter= value
+> def filter=(value)
 
 convert to string to support symbols
 
 --
 
-##### [initialize](https://github.com/appium/ruby_lib/blob/ea11190b9ab36e34226d988f85fe612af6f769de/lib/appium_lib/common/helper.rb#L172) 
+##### [initialize](https://github.com/appium/ruby_lib/blob/af838966d0724793d3dbfa35798ca6dd9f8a3143/lib/appium_lib/common/helper.rb#L168) 
 
 > def initialize
 
@@ -1317,7 +1380,7 @@ __Returns:__
 
 --
 
-##### [reset](https://github.com/appium/ruby_lib/blob/ea11190b9ab36e34226d988f85fe612af6f769de/lib/appium_lib/common/helper.rb#L177) 
+##### [reset](https://github.com/appium/ruby_lib/blob/af838966d0724793d3dbfa35798ca6dd9f8a3143/lib/appium_lib/common/helper.rb#L173) 
 
 > def reset
 
@@ -1325,7 +1388,7 @@ __Returns:__
 
 --
 
-##### [result](https://github.com/appium/ruby_lib/blob/ea11190b9ab36e34226d988f85fe612af6f769de/lib/appium_lib/common/helper.rb#L183) 
+##### [result](https://github.com/appium/ruby_lib/blob/af838966d0724793d3dbfa35798ca6dd9f8a3143/lib/appium_lib/common/helper.rb#L179) 
 
 > def result
 
@@ -1333,23 +1396,23 @@ __Returns:__
 
 --
 
-##### [start_element](https://github.com/appium/ruby_lib/blob/ea11190b9ab36e34226d988f85fe612af6f769de/lib/appium_lib/common/helper.rb#L199) 
+##### [start_element](https://github.com/appium/ruby_lib/blob/af838966d0724793d3dbfa35798ca6dd9f8a3143/lib/appium_lib/common/helper.rb#L195) 
 
-> def start_element name, attrs = []
+> def start_element(name, attrs = [])
 
 
 
 --
 
-##### [end_element](https://github.com/appium/ruby_lib/blob/ea11190b9ab36e34226d988f85fe612af6f769de/lib/appium_lib/common/helper.rb#L209) 
+##### [end_element](https://github.com/appium/ruby_lib/blob/af838966d0724793d3dbfa35798ca6dd9f8a3143/lib/appium_lib/common/helper.rb#L204) 
 
-> def end_element name
+> def end_element(name)
 
 
 
 --
 
-##### [characters](https://github.com/appium/ruby_lib/blob/ea11190b9ab36e34226d988f85fe612af6f769de/lib/appium_lib/common/helper.rb#L215) 
+##### [characters](https://github.com/appium/ruby_lib/blob/af838966d0724793d3dbfa35798ca6dd9f8a3143/lib/appium_lib/common/helper.rb#L210) 
 
 > def characters(chars)
 
@@ -1357,7 +1420,7 @@ __Returns:__
 
 --
 
-##### [_no_such_element](https://github.com/appium/ruby_lib/blob/ea11190b9ab36e34226d988f85fe612af6f769de/lib/appium_lib/common/helper.rb#L223) 
+##### [_no_such_element](https://github.com/appium/ruby_lib/blob/af838966d0724793d3dbfa35798ca6dd9f8a3143/lib/appium_lib/common/helper.rb#L217) 
 
 > def _no_such_element
 
@@ -1365,7 +1428,7 @@ __Returns:__
 
 --
 
-##### [window_size](https://github.com/appium/ruby_lib/blob/ea11190b9ab36e34226d988f85fe612af6f769de/lib/appium_lib/common/element/window.rb#L5) 
+##### [window_size](https://github.com/appium/ruby_lib/blob/af838966d0724793d3dbfa35798ca6dd9f8a3143/lib/appium_lib/common/element/window.rb#L5) 
 
 > def window_size
 
@@ -1373,9 +1436,9 @@ Get the window's size
 
 --
 
-##### [ios_password](https://github.com/appium/ruby_lib/blob/ea11190b9ab36e34226d988f85fe612af6f769de/lib/appium_lib/ios/helper.rb#L8) ios
+##### [ios_password](https://github.com/appium/ruby_lib/blob/af838966d0724793d3dbfa35798ca6dd9f8a3143/lib/appium_lib/ios/helper.rb#L8) ios
 
-> def ios_password length=1
+> def ios_password(length = 1)
 
 iOS only. On Android uiautomator always returns an empty string for EditText password.
 
@@ -1391,9 +1454,9 @@ __Returns:__
 
 --
 
-##### [get_page](https://github.com/appium/ruby_lib/blob/ea11190b9ab36e34226d988f85fe612af6f769de/lib/appium_lib/ios/helper.rb#L20) ios
+##### [get_page](https://github.com/appium/ruby_lib/blob/af838966d0724793d3dbfa35798ca6dd9f8a3143/lib/appium_lib/ios/helper.rb#L20) ios
 
-> def get_page element=source_window(0), class_name=nil
+> def get_page(element = source_window(0), class_name = nil)
 
 Returns a string of interesting elements. iOS only.
 
@@ -1412,9 +1475,9 @@ __Returns:__
 
 --
 
-##### [page](https://github.com/appium/ruby_lib/blob/ea11190b9ab36e34226d988f85fe612af6f769de/lib/appium_lib/ios/helper.rb#L125) ios
+##### [page](https://github.com/appium/ruby_lib/blob/af838966d0724793d3dbfa35798ca6dd9f8a3143/lib/appium_lib/ios/helper.rb#L129) ios
 
-> def page opts={}
+> def page(opts = {})
 
 Prints a string of interesting elements to the console.
 
@@ -1438,9 +1501,9 @@ __Returns:__
 
 --
 
-##### [source_window](https://github.com/appium/ruby_lib/blob/ea11190b9ab36e34226d988f85fe612af6f769de/lib/appium_lib/ios/helper.rb#L157) ios
+##### [source_window](https://github.com/appium/ruby_lib/blob/af838966d0724793d3dbfa35798ca6dd9f8a3143/lib/appium_lib/ios/helper.rb#L161) ios
 
-> def source_window window_number=0
+> def source_window(window_number = 0)
 
 Gets the JSON source of window number
 
@@ -1454,9 +1517,9 @@ __Returns:__
 
 --
 
-##### [page_window](https://github.com/appium/ruby_lib/blob/ea11190b9ab36e34226d988f85fe612af6f769de/lib/appium_lib/ios/helper.rb#L171) ios
+##### [page_window](https://github.com/appium/ruby_lib/blob/af838966d0724793d3dbfa35798ca6dd9f8a3143/lib/appium_lib/ios/helper.rb#L175) ios
 
-> def page_window window_number=0
+> def page_window(window_number = 0)
 
 Prints parsed page source to console.
 
@@ -1472,9 +1535,9 @@ __Returns:__
 
 --
 
-##### [id](https://github.com/appium/ruby_lib/blob/ea11190b9ab36e34226d988f85fe612af6f769de/lib/appium_lib/ios/helper.rb#L179) ios
+##### [id](https://github.com/appium/ruby_lib/blob/af838966d0724793d3dbfa35798ca6dd9f8a3143/lib/appium_lib/ios/helper.rb#L183) ios
 
-> def id id
+> def id(id)
 
 Find by id
 
@@ -1488,7 +1551,7 @@ __Returns:__
 
 --
 
-##### [ios_version](https://github.com/appium/ruby_lib/blob/ea11190b9ab36e34226d988f85fe612af6f769de/lib/appium_lib/ios/helper.rb#L185) ios
+##### [ios_version](https://github.com/appium/ruby_lib/blob/af838966d0724793d3dbfa35798ca6dd9f8a3143/lib/appium_lib/ios/helper.rb#L189) ios
 
 > def ios_version
 
@@ -1500,9 +1563,9 @@ __Returns:__
 
 --
 
-##### [ele_index](https://github.com/appium/ruby_lib/blob/ea11190b9ab36e34226d988f85fe612af6f769de/lib/appium_lib/ios/helper.rb#L194) ios
+##### [ele_index](https://github.com/appium/ruby_lib/blob/af838966d0724793d3dbfa35798ca6dd9f8a3143/lib/appium_lib/ios/helper.rb#L198) ios
 
-> def ele_index class_name, index
+> def ele_index(class_name, index)
 
 Get the element of type class_name at matching index.
 
@@ -1518,9 +1581,9 @@ __Returns:__
 
 --
 
-##### [find_ele_by_attr](https://github.com/appium/ruby_lib/blob/ea11190b9ab36e34226d988f85fe612af6f769de/lib/appium_lib/ios/helper.rb#L221) ios
+##### [find_ele_by_attr](https://github.com/appium/ruby_lib/blob/af838966d0724793d3dbfa35798ca6dd9f8a3143/lib/appium_lib/ios/helper.rb#L225) ios
 
-> def find_ele_by_attr class_name, attr, value
+> def find_ele_by_attr(class_name, attr, value)
 
 Find the first element exactly matching class and attribute value.
 Note: Uses XPath
@@ -1539,9 +1602,9 @@ __Returns:__
 
 --
 
-##### [find_eles_by_attr](https://github.com/appium/ruby_lib/blob/ea11190b9ab36e34226d988f85fe612af6f769de/lib/appium_lib/ios/helper.rb#L231) ios
+##### [find_eles_by_attr](https://github.com/appium/ruby_lib/blob/af838966d0724793d3dbfa35798ca6dd9f8a3143/lib/appium_lib/ios/helper.rb#L235) ios
 
-> def find_eles_by_attr class_name, attr, value
+> def find_eles_by_attr(class_name, attr, value)
 
 Find all elements exactly matching class and attribute value.
 Note: Uses XPath
@@ -1560,9 +1623,9 @@ __Returns:__
 
 --
 
-##### [find_ele_by_attr_include](https://github.com/appium/ruby_lib/blob/ea11190b9ab36e34226d988f85fe612af6f769de/lib/appium_lib/ios/helper.rb#L246) ios
+##### [find_ele_by_attr_include](https://github.com/appium/ruby_lib/blob/af838966d0724793d3dbfa35798ca6dd9f8a3143/lib/appium_lib/ios/helper.rb#L250) ios
 
-> def find_ele_by_attr_include class_name, attr, value
+> def find_ele_by_attr_include(class_name, attr, value)
 
 Get the first tag by attribute that exactly matches value.
 Note: Uses XPath
@@ -1581,9 +1644,9 @@ __Returns:__
 
 --
 
-##### [find_eles_by_attr_include](https://github.com/appium/ruby_lib/blob/ea11190b9ab36e34226d988f85fe612af6f769de/lib/appium_lib/ios/helper.rb#L256) ios
+##### [find_eles_by_attr_include](https://github.com/appium/ruby_lib/blob/af838966d0724793d3dbfa35798ca6dd9f8a3143/lib/appium_lib/ios/helper.rb#L260) ios
 
-> def find_eles_by_attr_include class_name, attr, value
+> def find_eles_by_attr_include(class_name, attr, value)
 
 Get tags by attribute that include value.
 Note: Uses XPath
@@ -1602,9 +1665,9 @@ __Returns:__
 
 --
 
-##### [first_ele](https://github.com/appium/ruby_lib/blob/ea11190b9ab36e34226d988f85fe612af6f769de/lib/appium_lib/ios/helper.rb#L263) ios
+##### [first_ele](https://github.com/appium/ruby_lib/blob/af838966d0724793d3dbfa35798ca6dd9f8a3143/lib/appium_lib/ios/helper.rb#L267) ios
 
-> def first_ele class_name
+> def first_ele(class_name)
 
 Get the first tag that matches class_name
 
@@ -1618,9 +1681,9 @@ __Returns:__
 
 --
 
-##### [last_ele](https://github.com/appium/ruby_lib/blob/ea11190b9ab36e34226d988f85fe612af6f769de/lib/appium_lib/ios/helper.rb#L271) ios
+##### [last_ele](https://github.com/appium/ruby_lib/blob/af838966d0724793d3dbfa35798ca6dd9f8a3143/lib/appium_lib/ios/helper.rb#L275) ios
 
-> def last_ele class_name
+> def last_ele(class_name)
 
 Get the last tag that matches class_name
 
@@ -1634,9 +1697,9 @@ __Returns:__
 
 --
 
-##### [tag](https://github.com/appium/ruby_lib/blob/ea11190b9ab36e34226d988f85fe612af6f769de/lib/appium_lib/ios/helper.rb#L279) ios
+##### [tag](https://github.com/appium/ruby_lib/blob/af838966d0724793d3dbfa35798ca6dd9f8a3143/lib/appium_lib/ios/helper.rb#L283) ios
 
-> def tag class_name
+> def tag(class_name)
 
 Returns the first visible element matching class_name
 
@@ -1650,9 +1713,9 @@ __Returns:__
 
 --
 
-##### [tags](https://github.com/appium/ruby_lib/blob/ea11190b9ab36e34226d988f85fe612af6f769de/lib/appium_lib/ios/helper.rb#L290) ios
+##### [tags](https://github.com/appium/ruby_lib/blob/af838966d0724793d3dbfa35798ca6dd9f8a3143/lib/appium_lib/ios/helper.rb#L294) ios
 
-> def tags class_name
+> def tags(class_name)
 
 Returns all visible elements matching class_name
 
@@ -1666,9 +1729,9 @@ __Returns:__
 
 --
 
-##### [ele_by_json_visible_contains](https://github.com/appium/ruby_lib/blob/ea11190b9ab36e34226d988f85fe612af6f769de/lib/appium_lib/ios/helper.rb#L325) ios
+##### [ele_by_json_visible_contains](https://github.com/appium/ruby_lib/blob/af838966d0724793d3dbfa35798ca6dd9f8a3143/lib/appium_lib/ios/helper.rb#L329) ios
 
-> def ele_by_json_visible_contains element, value
+> def ele_by_json_visible_contains(element, value)
 
 Find the first element that contains value
 
@@ -1684,9 +1747,9 @@ __Returns:__
 
 --
 
-##### [eles_by_json_visible_contains](https://github.com/appium/ruby_lib/blob/ea11190b9ab36e34226d988f85fe612af6f769de/lib/appium_lib/ios/helper.rb#L333) ios
+##### [eles_by_json_visible_contains](https://github.com/appium/ruby_lib/blob/af838966d0724793d3dbfa35798ca6dd9f8a3143/lib/appium_lib/ios/helper.rb#L337) ios
 
-> def eles_by_json_visible_contains element, value
+> def eles_by_json_visible_contains(element, value)
 
 Find all elements containing value
 
@@ -1702,9 +1765,9 @@ __Returns:__
 
 --
 
-##### [ele_by_json_visible_exact](https://github.com/appium/ruby_lib/blob/ea11190b9ab36e34226d988f85fe612af6f769de/lib/appium_lib/ios/helper.rb#L362) ios
+##### [ele_by_json_visible_exact](https://github.com/appium/ruby_lib/blob/af838966d0724793d3dbfa35798ca6dd9f8a3143/lib/appium_lib/ios/helper.rb#L366) ios
 
-> def ele_by_json_visible_exact element, value
+> def ele_by_json_visible_exact(element, value)
 
 Find the first element exactly matching value
 
@@ -1720,9 +1783,9 @@ __Returns:__
 
 --
 
-##### [eles_by_json_visible_exact](https://github.com/appium/ruby_lib/blob/ea11190b9ab36e34226d988f85fe612af6f769de/lib/appium_lib/ios/helper.rb#L370) ios
+##### [eles_by_json_visible_exact](https://github.com/appium/ruby_lib/blob/af838966d0724793d3dbfa35798ca6dd9f8a3143/lib/appium_lib/ios/helper.rb#L374) ios
 
-> def eles_by_json_visible_exact element, value
+> def eles_by_json_visible_exact(element, value)
 
 Find all elements exactly matching value
 
@@ -1738,9 +1801,9 @@ __Returns:__
 
 --
 
-##### [_all_pred](https://github.com/appium/ruby_lib/blob/ea11190b9ab36e34226d988f85fe612af6f769de/lib/appium_lib/ios/helper.rb#L434) ios
+##### [_all_pred](https://github.com/appium/ruby_lib/blob/af838966d0724793d3dbfa35798ca6dd9f8a3143/lib/appium_lib/ios/helper.rb#L438) ios
 
-> def _all_pred opts
+> def _all_pred(opts)
 
 predicate - the predicate to evaluate on the main app
 
@@ -1748,9 +1811,9 @@ visible - if true, only visible elements are returned. default true
 
 --
 
-##### [ele_with_pred](https://github.com/appium/ruby_lib/blob/ea11190b9ab36e34226d988f85fe612af6f769de/lib/appium_lib/ios/helper.rb#L447) ios
+##### [ele_with_pred](https://github.com/appium/ruby_lib/blob/af838966d0724793d3dbfa35798ca6dd9f8a3143/lib/appium_lib/ios/helper.rb#L451) ios
 
-> def ele_with_pred opts
+> def ele_with_pred(opts)
 
 returns element matching predicate contained in the main app
 
@@ -1764,9 +1827,9 @@ __Returns:__
 
 --
 
-##### [eles_with_pred](https://github.com/appium/ruby_lib/blob/ea11190b9ab36e34226d988f85fe612af6f769de/lib/appium_lib/ios/helper.rb#L458) ios
+##### [eles_with_pred](https://github.com/appium/ruby_lib/blob/af838966d0724793d3dbfa35798ca6dd9f8a3143/lib/appium_lib/ios/helper.rb#L462) ios
 
-> def eles_with_pred opts
+> def eles_with_pred(opts)
 
 returns elements matching predicate contained in the main app
 
@@ -1780,7 +1843,7 @@ __Returns:__
 
 --
 
-##### [source](https://github.com/appium/ruby_lib/blob/ea11190b9ab36e34226d988f85fe612af6f769de/lib/appium_lib/ios/helper.rb#L464) ios
+##### [source](https://github.com/appium/ruby_lib/blob/af838966d0724793d3dbfa35798ca6dd9f8a3143/lib/appium_lib/ios/helper.rb#L468) ios
 
 > def source
 
@@ -1792,17 +1855,17 @@ __Returns:__
 
 --
 
-##### [_validate_object](https://github.com/appium/ruby_lib/blob/ea11190b9ab36e34226d988f85fe612af6f769de/lib/appium_lib/ios/helper.rb#L468) ios
+##### [_validate_object](https://github.com/appium/ruby_lib/blob/af838966d0724793d3dbfa35798ca6dd9f8a3143/lib/appium_lib/ios/helper.rb#L472) ios
 
-> def _validate_object *objects
+> def _validate_object(*objects)
 
 
 
 --
 
-##### [_by_json](https://github.com/appium/ruby_lib/blob/ea11190b9ab36e34226d988f85fe612af6f769de/lib/appium_lib/ios/helper.rb#L516) ios
+##### [_by_json](https://github.com/appium/ruby_lib/blob/af838966d0724793d3dbfa35798ca6dd9f8a3143/lib/appium_lib/ios/helper.rb#L520) ios
 
-> def _by_json opts
+> def _by_json(opts)
 
 typeArray - array of string types to search for. Example: ["UIAStaticText"]
 onlyFirst - boolean. returns only the first result if true. Example: true
@@ -1834,9 +1897,9 @@ opts = {
 
 --
 
-##### [eles_by_json](https://github.com/appium/ruby_lib/blob/ea11190b9ab36e34226d988f85fe612af6f769de/lib/appium_lib/ios/helper.rb#L556) ios
+##### [eles_by_json](https://github.com/appium/ruby_lib/blob/af838966d0724793d3dbfa35798ca6dd9f8a3143/lib/appium_lib/ios/helper.rb#L569) ios
 
-> def eles_by_json opts
+> def eles_by_json(opts)
 
 example usage:
 
@@ -1852,15 +1915,15 @@ eles_by_json({
 
 --
 
-##### [ele_by_json](https://github.com/appium/ruby_lib/blob/ea11190b9ab36e34226d988f85fe612af6f769de/lib/appium_lib/ios/helper.rb#L562) ios
+##### [ele_by_json](https://github.com/appium/ruby_lib/blob/af838966d0724793d3dbfa35798ca6dd9f8a3143/lib/appium_lib/ios/helper.rb#L575) ios
 
-> def ele_by_json opts
+> def ele_by_json(opts)
 
 see eles_by_json
 
 --
 
-##### [get_source](https://github.com/appium/ruby_lib/blob/ea11190b9ab36e34226d988f85fe612af6f769de/lib/appium_lib/ios/helper.rb#L572) ios
+##### [get_source](https://github.com/appium/ruby_lib/blob/af838966d0724793d3dbfa35798ca6dd9f8a3143/lib/appium_lib/ios/helper.rb#L585) ios
 
 > def get_source
 
@@ -1873,7 +1936,7 @@ __Returns:__
 
 --
 
-##### [UIAStaticText](https://github.com/appium/ruby_lib/blob/ea11190b9ab36e34226d988f85fe612af6f769de/lib/appium_lib/ios/element/text.rb#L4) ios
+##### [UIAStaticText](https://github.com/appium/ruby_lib/blob/af838966d0724793d3dbfa35798ca6dd9f8a3143/lib/appium_lib/ios/element/text.rb#L4) ios
 
 > UIAStaticText = 'UIAStaticText'
 
@@ -1881,9 +1944,9 @@ __Returns:__
 
 --
 
-##### [text](https://github.com/appium/ruby_lib/blob/ea11190b9ab36e34226d988f85fe612af6f769de/lib/appium_lib/ios/element/text.rb#L10) ios
+##### [text](https://github.com/appium/ruby_lib/blob/af838966d0724793d3dbfa35798ca6dd9f8a3143/lib/appium_lib/ios/element/text.rb#L10) ios
 
-> def text value
+> def text(value)
 
 Find the first UIAStaticText that contains value or by index.
 If int then the UIAStaticText at that index is returned.
@@ -1898,9 +1961,9 @@ __Returns:__
 
 --
 
-##### [texts](https://github.com/appium/ruby_lib/blob/ea11190b9ab36e34226d988f85fe612af6f769de/lib/appium_lib/ios/element/text.rb#L19) ios
+##### [texts](https://github.com/appium/ruby_lib/blob/af838966d0724793d3dbfa35798ca6dd9f8a3143/lib/appium_lib/ios/element/text.rb#L19) ios
 
-> def texts value=false
+> def texts(value = false)
 
 Find all UIAStaticText containing value.
 If value is omitted, all UIAStaticTexts are returned
@@ -1915,7 +1978,7 @@ __Returns:__
 
 --
 
-##### [first_text](https://github.com/appium/ruby_lib/blob/ea11190b9ab36e34226d988f85fe612af6f769de/lib/appium_lib/ios/element/text.rb#L26) ios
+##### [first_text](https://github.com/appium/ruby_lib/blob/af838966d0724793d3dbfa35798ca6dd9f8a3143/lib/appium_lib/ios/element/text.rb#L26) ios
 
 > def first_text
 
@@ -1927,7 +1990,7 @@ __Returns:__
 
 --
 
-##### [last_text](https://github.com/appium/ruby_lib/blob/ea11190b9ab36e34226d988f85fe612af6f769de/lib/appium_lib/ios/element/text.rb#L32) ios
+##### [last_text](https://github.com/appium/ruby_lib/blob/af838966d0724793d3dbfa35798ca6dd9f8a3143/lib/appium_lib/ios/element/text.rb#L32) ios
 
 > def last_text
 
@@ -1939,9 +2002,9 @@ __Returns:__
 
 --
 
-##### [text_exact](https://github.com/appium/ruby_lib/blob/ea11190b9ab36e34226d988f85fe612af6f769de/lib/appium_lib/ios/element/text.rb#L39) ios
+##### [text_exact](https://github.com/appium/ruby_lib/blob/af838966d0724793d3dbfa35798ca6dd9f8a3143/lib/appium_lib/ios/element/text.rb#L39) ios
 
-> def text_exact value
+> def text_exact(value)
 
 Find the first UIAStaticText that exactly matches value.
 
@@ -1955,9 +2018,9 @@ __Returns:__
 
 --
 
-##### [texts_exact](https://github.com/appium/ruby_lib/blob/ea11190b9ab36e34226d988f85fe612af6f769de/lib/appium_lib/ios/element/text.rb#L46) ios
+##### [texts_exact](https://github.com/appium/ruby_lib/blob/af838966d0724793d3dbfa35798ca6dd9f8a3143/lib/appium_lib/ios/element/text.rb#L46) ios
 
-> def texts_exact value
+> def texts_exact(value)
 
 Find all UIAStaticTexts that exactly match value.
 
@@ -1971,7 +2034,7 @@ __Returns:__
 
 --
 
-##### [alert_accept](https://github.com/appium/ruby_lib/blob/ea11190b9ab36e34226d988f85fe612af6f769de/lib/appium_lib/ios/element/alert.rb#L5) ios
+##### [alert_accept](https://github.com/appium/ruby_lib/blob/af838966d0724793d3dbfa35798ca6dd9f8a3143/lib/appium_lib/ios/element/alert.rb#L5) ios
 
 > def alert_accept
 
@@ -1983,7 +2046,7 @@ __Returns:__
 
 --
 
-##### [alert_dismiss](https://github.com/appium/ruby_lib/blob/ea11190b9ab36e34226d988f85fe612af6f769de/lib/appium_lib/ios/element/alert.rb#L13) ios
+##### [alert_dismiss](https://github.com/appium/ruby_lib/blob/af838966d0724793d3dbfa35798ca6dd9f8a3143/lib/appium_lib/ios/element/alert.rb#L13) ios
 
 > def alert_dismiss
 
@@ -1995,7 +2058,7 @@ __Returns:__
 
 --
 
-##### [uiautomation_find](https://github.com/appium/ruby_lib/blob/ea11190b9ab36e34226d988f85fe612af6f769de/lib/appium_lib/ios/mobile_methods.rb#L10) ios
+##### [uiautomation_find](https://github.com/appium/ruby_lib/blob/af838966d0724793d3dbfa35798ca6dd9f8a3143/lib/appium_lib/ios/mobile_methods.rb#L10) ios
 
 > def uiautomation_find
 
@@ -2007,7 +2070,7 @@ find_element/s can be used with a [UIAutomation command](https://developer.apple
 
 --
 
-##### [UIAButton](https://github.com/appium/ruby_lib/blob/ea11190b9ab36e34226d988f85fe612af6f769de/lib/appium_lib/ios/element/button.rb#L4) ios
+##### [UIAButton](https://github.com/appium/ruby_lib/blob/af838966d0724793d3dbfa35798ca6dd9f8a3143/lib/appium_lib/ios/element/button.rb#L4) ios
 
 > UIAButton = 'UIAButton'
 
@@ -2015,9 +2078,9 @@ find_element/s can be used with a [UIAutomation command](https://developer.apple
 
 --
 
-##### [button](https://github.com/appium/ruby_lib/blob/ea11190b9ab36e34226d988f85fe612af6f769de/lib/appium_lib/ios/element/button.rb#L10) ios
+##### [button](https://github.com/appium/ruby_lib/blob/af838966d0724793d3dbfa35798ca6dd9f8a3143/lib/appium_lib/ios/element/button.rb#L10) ios
 
-> def button value
+> def button(value)
 
 Find the first UIAButton that contains value or by index.
 If int then the UIAButton at that index is returned.
@@ -2032,9 +2095,9 @@ __Returns:__
 
 --
 
-##### [buttons](https://github.com/appium/ruby_lib/blob/ea11190b9ab36e34226d988f85fe612af6f769de/lib/appium_lib/ios/element/button.rb#L20) ios
+##### [buttons](https://github.com/appium/ruby_lib/blob/af838966d0724793d3dbfa35798ca6dd9f8a3143/lib/appium_lib/ios/element/button.rb#L20) ios
 
-> def buttons value=false
+> def buttons(value = false)
 
 Find all UIAButtons containing value.
 If value is omitted, all UIAButtons are returned.
@@ -2049,7 +2112,7 @@ __Returns:__
 
 --
 
-##### [first_button](https://github.com/appium/ruby_lib/blob/ea11190b9ab36e34226d988f85fe612af6f769de/lib/appium_lib/ios/element/button.rb#L27) ios
+##### [first_button](https://github.com/appium/ruby_lib/blob/af838966d0724793d3dbfa35798ca6dd9f8a3143/lib/appium_lib/ios/element/button.rb#L27) ios
 
 > def first_button
 
@@ -2061,7 +2124,7 @@ __Returns:__
 
 --
 
-##### [last_button](https://github.com/appium/ruby_lib/blob/ea11190b9ab36e34226d988f85fe612af6f769de/lib/appium_lib/ios/element/button.rb#L33) ios
+##### [last_button](https://github.com/appium/ruby_lib/blob/af838966d0724793d3dbfa35798ca6dd9f8a3143/lib/appium_lib/ios/element/button.rb#L33) ios
 
 > def last_button
 
@@ -2073,9 +2136,9 @@ __Returns:__
 
 --
 
-##### [button_exact](https://github.com/appium/ruby_lib/blob/ea11190b9ab36e34226d988f85fe612af6f769de/lib/appium_lib/ios/element/button.rb#L40) ios
+##### [button_exact](https://github.com/appium/ruby_lib/blob/af838966d0724793d3dbfa35798ca6dd9f8a3143/lib/appium_lib/ios/element/button.rb#L40) ios
 
-> def button_exact value
+> def button_exact(value)
 
 Find the first UIAButton that exactly matches value.
 
@@ -2089,9 +2152,9 @@ __Returns:__
 
 --
 
-##### [buttons_exact](https://github.com/appium/ruby_lib/blob/ea11190b9ab36e34226d988f85fe612af6f769de/lib/appium_lib/ios/element/button.rb#L47) ios
+##### [buttons_exact](https://github.com/appium/ruby_lib/blob/af838966d0724793d3dbfa35798ca6dd9f8a3143/lib/appium_lib/ios/element/button.rb#L47) ios
 
-> def buttons_exact value
+> def buttons_exact(value)
 
 Find all UIAButtons that exactly match value.
 
@@ -2105,9 +2168,9 @@ __Returns:__
 
 --
 
-##### [find](https://github.com/appium/ruby_lib/blob/ea11190b9ab36e34226d988f85fe612af6f769de/lib/appium_lib/ios/element/generic.rb#L7) ios
+##### [find](https://github.com/appium/ruby_lib/blob/af838966d0724793d3dbfa35798ca6dd9f8a3143/lib/appium_lib/ios/element/generic.rb#L6) ios
 
-> def find value
+> def find(value)
 
 Find the first element containing value
 
@@ -2121,9 +2184,9 @@ __Returns:__
 
 --
 
-##### [finds](https://github.com/appium/ruby_lib/blob/ea11190b9ab36e34226d988f85fe612af6f769de/lib/appium_lib/ios/element/generic.rb#L14) ios
+##### [finds](https://github.com/appium/ruby_lib/blob/af838966d0724793d3dbfa35798ca6dd9f8a3143/lib/appium_lib/ios/element/generic.rb#L13) ios
 
-> def finds value
+> def finds(value)
 
 Find all elements containing value
 
@@ -2137,9 +2200,9 @@ __Returns:__
 
 --
 
-##### [find_exact](https://github.com/appium/ruby_lib/blob/ea11190b9ab36e34226d988f85fe612af6f769de/lib/appium_lib/ios/element/generic.rb#L21) ios
+##### [find_exact](https://github.com/appium/ruby_lib/blob/af838966d0724793d3dbfa35798ca6dd9f8a3143/lib/appium_lib/ios/element/generic.rb#L20) ios
 
-> def find_exact value
+> def find_exact(value)
 
 Find the first element exactly matching value
 
@@ -2153,9 +2216,9 @@ __Returns:__
 
 --
 
-##### [finds_exact](https://github.com/appium/ruby_lib/blob/ea11190b9ab36e34226d988f85fe612af6f769de/lib/appium_lib/ios/element/generic.rb#L28) ios
+##### [finds_exact](https://github.com/appium/ruby_lib/blob/af838966d0724793d3dbfa35798ca6dd9f8a3143/lib/appium_lib/ios/element/generic.rb#L27) ios
 
-> def finds_exact value
+> def finds_exact(value)
 
 Find all elements exactly matching value
 
@@ -2169,7 +2232,7 @@ __Returns:__
 
 --
 
-##### [UIATextField](https://github.com/appium/ruby_lib/blob/ea11190b9ab36e34226d988f85fe612af6f769de/lib/appium_lib/ios/element/textfield.rb#L3) ios
+##### [UIATextField](https://github.com/appium/ruby_lib/blob/af838966d0724793d3dbfa35798ca6dd9f8a3143/lib/appium_lib/ios/element/textfield.rb#L3) ios
 
 > UIATextField       = 'UIATextField'
 
@@ -2177,7 +2240,7 @@ __Returns:__
 
 --
 
-##### [UIASecureTextField](https://github.com/appium/ruby_lib/blob/ea11190b9ab36e34226d988f85fe612af6f769de/lib/appium_lib/ios/element/textfield.rb#L4) ios
+##### [UIASecureTextField](https://github.com/appium/ruby_lib/blob/af838966d0724793d3dbfa35798ca6dd9f8a3143/lib/appium_lib/ios/element/textfield.rb#L4) ios
 
 > UIASecureTextField = 'UIASecureTextField'
 
@@ -2185,9 +2248,9 @@ __Returns:__
 
 --
 
-##### [textfield](https://github.com/appium/ruby_lib/blob/ea11190b9ab36e34226d988f85fe612af6f769de/lib/appium_lib/ios/element/textfield.rb#L52) ios
+##### [textfield](https://github.com/appium/ruby_lib/blob/af838966d0724793d3dbfa35798ca6dd9f8a3143/lib/appium_lib/ios/element/textfield.rb#L52) ios
 
-> def textfield value
+> def textfield(value)
 
 Find the first TextField that contains value or by index.
 If int then the TextField at that index is returned.
@@ -2202,9 +2265,9 @@ __Returns:__
 
 --
 
-##### [textfields](https://github.com/appium/ruby_lib/blob/ea11190b9ab36e34226d988f85fe612af6f769de/lib/appium_lib/ios/element/textfield.rb#L72) ios
+##### [textfields](https://github.com/appium/ruby_lib/blob/af838966d0724793d3dbfa35798ca6dd9f8a3143/lib/appium_lib/ios/element/textfield.rb#L72) ios
 
-> def textfields value=false
+> def textfields(value = false)
 
 Find all TextFields containing value.
 If value is omitted, all TextFields are returned.
@@ -2219,7 +2282,7 @@ __Returns:__
 
 --
 
-##### [first_textfield](https://github.com/appium/ruby_lib/blob/ea11190b9ab36e34226d988f85fe612af6f769de/lib/appium_lib/ios/element/textfield.rb#L79) ios
+##### [first_textfield](https://github.com/appium/ruby_lib/blob/af838966d0724793d3dbfa35798ca6dd9f8a3143/lib/appium_lib/ios/element/textfield.rb#L79) ios
 
 > def first_textfield
 
@@ -2231,7 +2294,7 @@ __Returns:__
 
 --
 
-##### [last_textfield](https://github.com/appium/ruby_lib/blob/ea11190b9ab36e34226d988f85fe612af6f769de/lib/appium_lib/ios/element/textfield.rb#L85) ios
+##### [last_textfield](https://github.com/appium/ruby_lib/blob/af838966d0724793d3dbfa35798ca6dd9f8a3143/lib/appium_lib/ios/element/textfield.rb#L85) ios
 
 > def last_textfield
 
@@ -2243,9 +2306,9 @@ __Returns:__
 
 --
 
-##### [textfield_exact](https://github.com/appium/ruby_lib/blob/ea11190b9ab36e34226d988f85fe612af6f769de/lib/appium_lib/ios/element/textfield.rb#L94) ios
+##### [textfield_exact](https://github.com/appium/ruby_lib/blob/af838966d0724793d3dbfa35798ca6dd9f8a3143/lib/appium_lib/ios/element/textfield.rb#L94) ios
 
-> def textfield_exact value
+> def textfield_exact(value)
 
 Find the first TextField that exactly matches value.
 
@@ -2259,9 +2322,9 @@ __Returns:__
 
 --
 
-##### [textfields_exact](https://github.com/appium/ruby_lib/blob/ea11190b9ab36e34226d988f85fe612af6f769de/lib/appium_lib/ios/element/textfield.rb#L101) ios
+##### [textfields_exact](https://github.com/appium/ruby_lib/blob/af838966d0724793d3dbfa35798ca6dd9f8a3143/lib/appium_lib/ios/element/textfield.rb#L101) ios
 
-> def textfields_exact value
+> def textfields_exact(value)
 
 Find all TextFields that exactly match value.
 
@@ -2275,7 +2338,7 @@ __Returns:__
 
 --
 
-##### [value](https://github.com/appium/ruby_lib/blob/ea11190b9ab36e34226d988f85fe612af6f769de/lib/appium_lib/common/patch.rb#L12) 
+##### [value](https://github.com/appium/ruby_lib/blob/af838966d0724793d3dbfa35798ca6dd9f8a3143/lib/appium_lib/common/patch.rb#L12) 
 
 > def value
 
@@ -2285,7 +2348,7 @@ Fixes NoMethodError: undefined method `value' for Selenium::WebDriver::Element
 
 --
 
-##### [name](https://github.com/appium/ruby_lib/blob/ea11190b9ab36e34226d988f85fe612af6f769de/lib/appium_lib/common/patch.rb#L19) 
+##### [name](https://github.com/appium/ruby_lib/blob/af838966d0724793d3dbfa35798ca6dd9f8a3143/lib/appium_lib/common/patch.rb#L19) 
 
 > def name
 
@@ -2295,7 +2358,7 @@ Fixes NoMethodError: undefined method `name' for Selenium::WebDriver::Element
 
 --
 
-##### [location_rel](https://github.com/appium/ruby_lib/blob/ea11190b9ab36e34226d988f85fe612af6f769de/lib/appium_lib/common/patch.rb#L31) 
+##### [location_rel](https://github.com/appium/ruby_lib/blob/af838966d0724793d3dbfa35798ca6dd9f8a3143/lib/appium_lib/common/patch.rb#L31) 
 
 > def location_rel
 
@@ -2313,7 +2376,7 @@ __Returns:__
 
 --
 
-##### [DEFAULT_HEADERS](https://github.com/appium/ruby_lib/blob/ea11190b9ab36e34226d988f85fe612af6f769de/lib/appium_lib/common/patch.rb#L145) 
+##### [DEFAULT_HEADERS](https://github.com/appium/ruby_lib/blob/af838966d0724793d3dbfa35798ca6dd9f8a3143/lib/appium_lib/common/patch.rb#L147) 
 
 > DEFAULT_HEADERS = { 'Accept' => CONTENT_TYPE, 'User-Agent' => "appium/ruby_lib/#{::Appium::VERSION}" }