docs/ios_docs.md in appium_lib-9.1.3 vs docs/ios_docs.md in appium_lib-9.2.0
- old
+ new
@@ -1,6 +1,6 @@
-##### [load_settings](https://github.com/appium/ruby_lib/blob/ba2fbdcb206609259134fc09eac7940c21cc2c13/lib/appium_lib/driver.rb#L74)
+##### [load_settings](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/driver.rb#L74)
> def self.load_settings(opts = {})
Load arbitrary text (toml format)
@@ -24,11 +24,11 @@
[hash] the symbolized hash with updated :app and :require keys
--
-##### [load_appium_txt](https://github.com/appium/ruby_lib/blob/ba2fbdcb206609259134fc09eac7940c21cc2c13/lib/appium_lib/driver.rb#L110)
+##### [load_appium_txt](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/driver.rb#L110)
> def self.load_settings(opts = {})
Load arbitrary text (toml format)
@@ -53,11 +53,11 @@
[hash] the symbolized hash with updated :app and :require keys
--
-##### [expand_required_files](https://github.com/appium/ruby_lib/blob/ba2fbdcb206609259134fc09eac7940c21cc2c13/lib/appium_lib/driver.rb#L116)
+##### [expand_required_files](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/driver.rb#L116)
> def self.expand_required_files(base_dir, file_paths)
@@ -71,22 +71,22 @@
[Array] list of require files as an array, nil if require doesn't exist
--
-##### [symbolize_keys](https://github.com/appium/ruby_lib/blob/ba2fbdcb206609259134fc09eac7940c21cc2c13/lib/appium_lib/driver.rb#L148)
+##### [symbolize_keys](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/driver.rb#L148)
> def self.symbolize_keys(hash)
convert all keys (including nested) to symbols
based on deep_symbolize_keys & deep_transform_keys from rails
https://github.com/rails/docrails/blob/a3b1105ada3da64acfa3843b164b14b734456a50/activesupport/lib/active_support/core_ext/hash/keys.rb#L84
--
-##### [promote_singleton_appium_methods](https://github.com/appium/ruby_lib/blob/ba2fbdcb206609259134fc09eac7940c21cc2c13/lib/appium_lib/driver.rb#L169)
+##### [promote_singleton_appium_methods](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/driver.rb#L169)
> 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
@@ -100,11 +100,11 @@
that module are promoted on.
otherwise, the array of modules will be used as the promotion target.
--
-##### [promote_appium_methods](https://github.com/appium/ruby_lib/blob/ba2fbdcb206609259134fc09eac7940c21cc2c13/lib/appium_lib/driver.rb#L222)
+##### [promote_appium_methods](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/driver.rb#L222)
> def self.promote_appium_methods(class_array)
Promote appium methods to class instance methods
@@ -130,85 +130,85 @@
[Array<Class>] class_array - An array of classes
--
-##### [init_caps_for_appium](https://github.com/appium/ruby_lib/blob/ba2fbdcb206609259134fc09eac7940c21cc2c13/lib/appium_lib/driver.rb#L254)
+##### [init_caps_for_appium](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/driver.rb#L254)
> def self.init_caps_for_appium(opts_caps = {})
except for browser_name, default capability is equal to ::Selenium::WebDriver::Remote::Capabilities.firefox
Because Selenium::WebDriver::Remote::Bridge uses Capabilities.firefox by default
https://github.com/SeleniumHQ/selenium/blob/selenium-3.0.1/rb/lib/selenium/webdriver/remote/bridge.rb#L67
--
-##### [global_webdriver_http_sleep](https://github.com/appium/ruby_lib/blob/ba2fbdcb206609259134fc09eac7940c21cc2c13/lib/appium_lib/driver.rb#L272)
+##### [global_webdriver_http_sleep](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/driver.rb#L272)
> def global_webdriver_http_sleep
The amount to sleep in seconds before every webdriver http call.
--
-##### [global_webdriver_http_sleep=](https://github.com/appium/ruby_lib/blob/ba2fbdcb206609259134fc09eac7940c21cc2c13/lib/appium_lib/driver.rb#L272)
+##### [global_webdriver_http_sleep=](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/driver.rb#L272)
> def global_webdriver_http_sleep=(value)
The amount to sleep in seconds before every webdriver http call.
--
-##### [caps](https://github.com/appium/ruby_lib/blob/ba2fbdcb206609259134fc09eac7940c21cc2c13/lib/appium_lib/driver.rb#L274)
+##### [caps](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/driver.rb#L274)
> def caps
Selenium webdriver capabilities
--
-##### [caps=](https://github.com/appium/ruby_lib/blob/ba2fbdcb206609259134fc09eac7940c21cc2c13/lib/appium_lib/driver.rb#L274)
+##### [caps=](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/driver.rb#L274)
> def caps=(value)
Selenium webdriver capabilities
--
-##### [custom_url](https://github.com/appium/ruby_lib/blob/ba2fbdcb206609259134fc09eac7940c21cc2c13/lib/appium_lib/driver.rb#L276)
+##### [custom_url](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/driver.rb#L276)
> def custom_url
Custom URL for the selenium server
--
-##### [custom_url=](https://github.com/appium/ruby_lib/blob/ba2fbdcb206609259134fc09eac7940c21cc2c13/lib/appium_lib/driver.rb#L276)
+##### [custom_url=](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/driver.rb#L276)
> def custom_url=(value)
Custom URL for the selenium server
--
-##### [export_session](https://github.com/appium/ruby_lib/blob/ba2fbdcb206609259134fc09eac7940c21cc2c13/lib/appium_lib/driver.rb#L278)
+##### [export_session](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/driver.rb#L278)
> def export_session
Export session id to textfile in /tmp for 3rd party tools
--
-##### [export_session=](https://github.com/appium/ruby_lib/blob/ba2fbdcb206609259134fc09eac7940c21cc2c13/lib/appium_lib/driver.rb#L278)
+##### [export_session=](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/driver.rb#L278)
> def export_session=(value)
Export session id to textfile in /tmp for 3rd party tools
--
-##### [default_wait](https://github.com/appium/ruby_lib/blob/ba2fbdcb206609259134fc09eac7940c21cc2c13/lib/appium_lib/driver.rb#L283)
+##### [default_wait](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/driver.rb#L283)
> def default_wait
Default wait time for elements to appear
Returns the default client side wait.
@@ -218,113 +218,84 @@
[Integer]
--
-##### [default_wait=](https://github.com/appium/ruby_lib/blob/ba2fbdcb206609259134fc09eac7940c21cc2c13/lib/appium_lib/driver.rb#L283)
+##### [sauce_username](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/driver.rb#L285)
-> 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:__
-
- [Integer]
-
---
-
-##### [last_waits](https://github.com/appium/ruby_lib/blob/ba2fbdcb206609259134fc09eac7940c21cc2c13/lib/appium_lib/driver.rb#L285)
-
-> def last_waits
-
-Array of previous wait time values
-
---
-
-##### [last_waits=](https://github.com/appium/ruby_lib/blob/ba2fbdcb206609259134fc09eac7940c21cc2c13/lib/appium_lib/driver.rb#L285)
-
-> def last_waits=(value)
-
-Array of previous wait time values
-
---
-
-##### [sauce_username](https://github.com/appium/ruby_lib/blob/ba2fbdcb206609259134fc09eac7940c21cc2c13/lib/appium_lib/driver.rb#L287)
-
> def sauce_username
Username for use on Sauce Labs
--
-##### [sauce_username=](https://github.com/appium/ruby_lib/blob/ba2fbdcb206609259134fc09eac7940c21cc2c13/lib/appium_lib/driver.rb#L287)
+##### [sauce_username=](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/driver.rb#L285)
> def sauce_username=(value)
Username for use on Sauce Labs
--
-##### [sauce_access_key](https://github.com/appium/ruby_lib/blob/ba2fbdcb206609259134fc09eac7940c21cc2c13/lib/appium_lib/driver.rb#L289)
+##### [sauce_access_key](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/driver.rb#L287)
> def sauce_access_key
Access Key for use on Sauce Labs
--
-##### [sauce_access_key=](https://github.com/appium/ruby_lib/blob/ba2fbdcb206609259134fc09eac7940c21cc2c13/lib/appium_lib/driver.rb#L289)
+##### [sauce_access_key=](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/driver.rb#L287)
> def sauce_access_key=(value)
Access Key for use on Sauce Labs
--
-##### [appium_port](https://github.com/appium/ruby_lib/blob/ba2fbdcb206609259134fc09eac7940c21cc2c13/lib/appium_lib/driver.rb#L291)
+##### [appium_port](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/driver.rb#L289)
> def appium_port
Appium's server port
--
-##### [appium_port=](https://github.com/appium/ruby_lib/blob/ba2fbdcb206609259134fc09eac7940c21cc2c13/lib/appium_lib/driver.rb#L291)
+##### [appium_port=](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/driver.rb#L289)
> def appium_port=(value)
Appium's server port
--
-##### [appium_device](https://github.com/appium/ruby_lib/blob/ba2fbdcb206609259134fc09eac7940c21cc2c13/lib/appium_lib/driver.rb#L293)
+##### [appium_device](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/driver.rb#L291)
> def appium_device
Device type to request from the appium server
--
-##### [appium_device=](https://github.com/appium/ruby_lib/blob/ba2fbdcb206609259134fc09eac7940c21cc2c13/lib/appium_lib/driver.rb#L293)
+##### [appium_device=](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/driver.rb#L291)
> def appium_device=(value)
Device type to request from the appium server
--
-##### [automation_name](https://github.com/appium/ruby_lib/blob/ba2fbdcb206609259134fc09eac7940c21cc2c13/lib/appium_lib/driver.rb#L295)
+##### [automation_name](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/driver.rb#L294)
> def automation_name
-Automation name sent to appium server
+Automation name sent to appium server or received from server
+If automation_name is nil, it is not set both client side and server side.
--
-##### [appium_server_version](https://github.com/appium/ruby_lib/blob/ba2fbdcb206609259134fc09eac7940c21cc2c13/lib/appium_lib/driver.rb#L297)
+##### [appium_server_version](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/driver.rb#L296)
> def appium_server_version
Returns the server's version info
@@ -341,43 +312,43 @@
[Hash]
--
-##### [appium_debug](https://github.com/appium/ruby_lib/blob/ba2fbdcb206609259134fc09eac7940c21cc2c13/lib/appium_lib/driver.rb#L299)
+##### [appium_debug](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/driver.rb#L298)
> def appium_debug
Boolean debug mode for the Appium Ruby bindings
--
-##### [appium_debug=](https://github.com/appium/ruby_lib/blob/ba2fbdcb206609259134fc09eac7940c21cc2c13/lib/appium_lib/driver.rb#L299)
+##### [appium_debug=](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/driver.rb#L298)
> def appium_debug=(value)
Boolean debug mode for the Appium Ruby bindings
--
-##### [listener](https://github.com/appium/ruby_lib/blob/ba2fbdcb206609259134fc09eac7940c21cc2c13/lib/appium_lib/driver.rb#L301)
+##### [listener](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/driver.rb#L300)
> def listener
instance of AbstractEventListener for logging support
--
-##### [listener=](https://github.com/appium/ruby_lib/blob/ba2fbdcb206609259134fc09eac7940c21cc2c13/lib/appium_lib/driver.rb#L301)
+##### [listener=](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/driver.rb#L300)
> def listener=(value)
instance of AbstractEventListener for logging support
--
-##### [driver](https://github.com/appium/ruby_lib/blob/ba2fbdcb206609259134fc09eac7940c21cc2c13/lib/appium_lib/driver.rb#L304)
+##### [driver](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/driver.rb#L303)
> def driver
Returns the driver
@@ -385,11 +356,11 @@
[Driver] the driver
--
-##### [http_client](https://github.com/appium/ruby_lib/blob/ba2fbdcb206609259134fc09eac7940c21cc2c13/lib/appium_lib/driver.rb#L307)
+##### [http_client](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/driver.rb#L306)
> def http_client
Return http client called in start_driver()
@@ -397,11 +368,11 @@
[Selenium::WebDriver::Remote::Http::Default] the http client
--
-##### [initialize](https://github.com/appium/ruby_lib/blob/ba2fbdcb206609259134fc09eac7940c21cc2c13/lib/appium_lib/driver.rb#L328)
+##### [initialize](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/driver.rb#L327)
> def initialize(opts = {})
Creates a new driver
@@ -428,19 +399,19 @@
[Driver]
--
-##### [driver_attributes](https://github.com/appium/ruby_lib/blob/ba2fbdcb206609259134fc09eac7940c21cc2c13/lib/appium_lib/driver.rb#L401)
+##### [driver_attributes](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/driver.rb#L399)
> def driver_attributes
Returns a hash of the driver attributes
--
-##### [device_is_android?](https://github.com/appium/ruby_lib/blob/ba2fbdcb206609259134fc09eac7940c21cc2c13/lib/appium_lib/driver.rb#L423)
+##### [device_is_android?](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/driver.rb#L421)
> def device_is_android?
@@ -448,11 +419,11 @@
[Boolean]
--
-##### [automation_name_is_xcuitest?](https://github.com/appium/ruby_lib/blob/ba2fbdcb206609259134fc09eac7940c21cc2c13/lib/appium_lib/driver.rb#L429)
+##### [automation_name_is_xcuitest?](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/driver.rb#L427)
> def automation_name_is_xcuitest?
Return true if automationName is 'XCUITest'
@@ -460,11 +431,11 @@
[Boolean]
--
-##### [check_server_version_xcuitest](https://github.com/appium/ruby_lib/blob/ba2fbdcb206609259134fc09eac7940c21cc2c13/lib/appium_lib/driver.rb#L436)
+##### [check_server_version_xcuitest](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/driver.rb#L434)
> def check_server_version_xcuitest
Return true if the target Appium server is over REQUIRED_VERSION_XCUITEST.
If the Appium server is under REQUIRED_VERSION_XCUITEST, then error is raised.
@@ -473,11 +444,11 @@
[Boolean]
--
-##### [appium_client_version](https://github.com/appium/ruby_lib/blob/ba2fbdcb206609259134fc09eac7940c21cc2c13/lib/appium_lib/driver.rb#L468)
+##### [appium_client_version](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/driver.rb#L466)
> def appium_client_version
Returns the client's version info
@@ -491,11 +462,11 @@
[Hash]
--
-##### [absolute_app_path](https://github.com/appium/ruby_lib/blob/ba2fbdcb206609259134fc09eac7940c21cc2c13/lib/appium_lib/driver.rb#L480)
+##### [absolute_app_path](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/driver.rb#L478)
> def self.absolute_app_path(opts)
Converts app_path to an absolute path.
@@ -508,11 +479,11 @@
[String] APP_PATH as an absolute path
--
-##### [server_url](https://github.com/appium/ruby_lib/blob/ba2fbdcb206609259134fc09eac7940c21cc2c13/lib/appium_lib/driver.rb#L513)
+##### [server_url](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/driver.rb#L511)
> def server_url
Get the server url
@@ -520,11 +491,11 @@
[String] the server url
--
-##### [restart](https://github.com/appium/ruby_lib/blob/ba2fbdcb206609259134fc09eac7940c21cc2c13/lib/appium_lib/driver.rb#L524)
+##### [restart](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/driver.rb#L522)
> def restart
Restarts the driver
@@ -532,11 +503,11 @@
[Driver] the driver
--
-##### [screenshot](https://github.com/appium/ruby_lib/blob/ba2fbdcb206609259134fc09eac7940c21cc2c13/lib/appium_lib/driver.rb#L535)
+##### [screenshot](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/driver.rb#L533)
> def screenshot(png_save_path)
Takes a png screenshot and saves to the target path.
@@ -550,11 +521,11 @@
[nil]
--
-##### [driver_quit](https://github.com/appium/ruby_lib/blob/ba2fbdcb206609259134fc09eac7940c21cc2c13/lib/appium_lib/driver.rb#L542)
+##### [driver_quit](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/driver.rb#L540)
> def driver_quit
Quits the driver
@@ -562,11 +533,11 @@
[void]
--
-##### [start_driver](https://github.com/appium/ruby_lib/blob/ba2fbdcb206609259134fc09eac7940c21cc2c13/lib/appium_lib/driver.rb#L552)
+##### [start_driver](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/driver.rb#L550)
> def start_driver
Creates a new global driver and quits the old one if it exists.
@@ -574,30 +545,27 @@
[Selenium::WebDriver] the new global driver
--
-##### [no_wait](https://github.com/appium/ruby_lib/blob/ba2fbdcb206609259134fc09eac7940c21cc2c13/lib/appium_lib/driver.rb#L588)
+##### [no_wait](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/driver.rb#L588)
> def no_wait
-Set implicit wait and default_wait to zero.
+Set implicit wait to zero.
--
-##### [set_wait](https://github.com/appium/ruby_lib/blob/ba2fbdcb206609259134fc09eac7940c21cc2c13/lib/appium_lib/driver.rb#L607)
+##### [set_wait](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/driver.rb#L602)
> 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
-wait will be used.
+Set implicit wait. Default to @default_wait.
```ruby`
set_wait 2
-set_wait 3
-set_wait # 2
+set_wait # @default_wait
````
__Parameters:__
@@ -607,11 +575,11 @@
[void]
--
-##### [exists](https://github.com/appium/ruby_lib/blob/ba2fbdcb206609259134fc09eac7940c21cc2c13/lib/appium_lib/driver.rb#L634)
+##### [exists](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/driver.rb#L619)
> def exists(pre_check = 0, post_check = @default_wait)
Returns existence of element.
@@ -633,11 +601,11 @@
[Boolean]
--
-##### [execute_script](https://github.com/appium/ruby_lib/blob/ba2fbdcb206609259134fc09eac7940c21cc2c13/lib/appium_lib/driver.rb#L658)
+##### [execute_script](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/driver.rb#L643)
> def execute_script(script, *args)
The same as @driver.execute_script
@@ -651,11 +619,11 @@
[Object]
--
-##### [find_elements](https://github.com/appium/ruby_lib/blob/ba2fbdcb206609259134fc09eac7940c21cc2c13/lib/appium_lib/driver.rb#L666)
+##### [find_elements](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/driver.rb#L651)
> def find_elements(*args)
Calls @driver.find_elements
@@ -667,11 +635,11 @@
[Array<Element>] Array is empty when no elements are found.
--
-##### [find_element](https://github.com/appium/ruby_lib/blob/ba2fbdcb206609259134fc09eac7940c21cc2c13/lib/appium_lib/driver.rb#L674)
+##### [find_element](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/driver.rb#L659)
> def find_element(*args)
Calls @driver.find_elements
@@ -683,11 +651,11 @@
[Element]
--
-##### [set_location](https://github.com/appium/ruby_lib/blob/ba2fbdcb206609259134fc09eac7940c21cc2c13/lib/appium_lib/driver.rb#L687)
+##### [set_location](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/driver.rb#L672)
> def set_location(opts = {})
Calls @driver.set_location
@@ -699,11 +667,11 @@
[Selenium::WebDriver::Location] the location constructed by the selenium webdriver
--
-##### [x](https://github.com/appium/ruby_lib/blob/ba2fbdcb206609259134fc09eac7940c21cc2c13/lib/appium_lib/driver.rb#L697)
+##### [x](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/driver.rb#L682)
> def x
Quit the driver and Pry.
quit and exit are reserved by Pry.
@@ -712,99 +680,108 @@
[void]
--
-##### [logger=](https://github.com/appium/ruby_lib/blob/ba2fbdcb206609259134fc09eac7940c21cc2c13/lib/appium_lib/logger.rb#L13)
+##### [set_automation_name_if_nil](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/driver.rb#L691)
+> def set_automation_name_if_nil
+
+If "automationName" is set only server side, this method set "automationName" attribute into @automation_name.
+Since @automation_name is set only client side before start_driver is called.
+
+--
+
+##### [logger=](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/logger.rb#L13)
+
> def logger=(value)
Sets the attribute logger
__Parameters:__
value - the value to set the attribute logger to.
--
-##### [logger](https://github.com/appium/ruby_lib/blob/ba2fbdcb206609259134fc09eac7940c21cc2c13/lib/appium_lib/logger.rb#L17)
+##### [logger](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/logger.rb#L17)
> def logger
--
-##### [app_strings](https://github.com/appium/ruby_lib/blob/ba2fbdcb206609259134fc09eac7940c21cc2c13/lib/appium_lib/device/device.rb#L7)
+##### [app_strings](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/device/device.rb#L7)
> def app_strings
Return the hash of all localization strings.
```ruby
app_strings #=> "TransitionsTitle"=>"Transitions", "WebTitle"=>"Web"
```
--
-##### [background_app](https://github.com/appium/ruby_lib/blob/ba2fbdcb206609259134fc09eac7940c21cc2c13/lib/appium_lib/device/device.rb#L13)
+##### [background_app](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/device/device.rb#L13)
> def background_app
Backgrounds the app for a set number of seconds.
This is a blocking application
--
-##### [current_activity](https://github.com/appium/ruby_lib/blob/ba2fbdcb206609259134fc09eac7940c21cc2c13/lib/appium_lib/device/device.rb#L18)
+##### [current_activity](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/device/device.rb#L18)
> def current_activity
--
-##### [launch_app](https://github.com/appium/ruby_lib/blob/ba2fbdcb206609259134fc09eac7940c21cc2c13/lib/appium_lib/device/device.rb#L20)
+##### [launch_app](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/device/device.rb#L20)
> def launch_app
Start the simulator and application configured with desired capabilities
--
-##### [reset](https://github.com/appium/ruby_lib/blob/ba2fbdcb206609259134fc09eac7940c21cc2c13/lib/appium_lib/device/device.rb#L23)
+##### [reset](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/device/device.rb#L23)
> def reset
Reset the device, relaunching the application.
--
-##### [shake](https://github.com/appium/ruby_lib/blob/ba2fbdcb206609259134fc09eac7940c21cc2c13/lib/appium_lib/device/device.rb#L26)
+##### [shake](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/device/device.rb#L26)
> def shake
Cause the device to shake
--
-##### [toggle_flight_mode](https://github.com/appium/ruby_lib/blob/ba2fbdcb206609259134fc09eac7940c21cc2c13/lib/appium_lib/device/device.rb#L29)
+##### [toggle_flight_mode](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/device/device.rb#L29)
> def toggle_flight_mode
Toggle flight mode on or off
--
-##### [device_locked?](https://github.com/appium/ruby_lib/blob/ba2fbdcb206609259134fc09eac7940c21cc2c13/lib/appium_lib/device/device.rb#L32)
+##### [device_locked?](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/device/device.rb#L32)
> def device_locked?
--
-##### [hide_keyboard](https://github.com/appium/ruby_lib/blob/ba2fbdcb206609259134fc09eac7940c21cc2c13/lib/appium_lib/device/device.rb#L34)
+##### [hide_keyboard](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/device/device.rb#L34)
> def hide_keyboard
Hide the onscreen keyboard
@@ -813,11 +790,11 @@
[String] close_key - the name of the key which closes the keyboard.
Defaults to 'Done'.
--
-##### [press_keycode](https://github.com/appium/ruby_lib/blob/ba2fbdcb206609259134fc09eac7940c21cc2c13/lib/appium_lib/device/device.rb#L43)
+##### [press_keycode](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/device/device.rb#L43)
> def press_keycode
Press keycode on the device.
http://developer.android.com/reference/android/view/KeyEvent.html
@@ -828,11 +805,11 @@
[String] metastate - The state the metakeys should be in when pressing the key.
--
-##### [long_press_keycode](https://github.com/appium/ruby_lib/blob/ba2fbdcb206609259134fc09eac7940c21cc2c13/lib/appium_lib/device/device.rb#L49)
+##### [long_press_keycode](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/device/device.rb#L49)
> def long_press_keycode
Long press keycode on the device.
http://developer.android.com/reference/android/view/KeyEvent.html
@@ -843,11 +820,11 @@
[String] metastate - The state the metakeys should be in when long pressing the key.
--
-##### [push_file](https://github.com/appium/ruby_lib/blob/ba2fbdcb206609259134fc09eac7940c21cc2c13/lib/appium_lib/device/device.rb#L55)
+##### [push_file](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/device/device.rb#L55)
> def push_file
Place a file in a specific location on the device.
@@ -857,11 +834,11 @@
[String] data - Raw file data to be sent to the device.
--
-##### [pull_file](https://github.com/appium/ruby_lib/blob/ba2fbdcb206609259134fc09eac7940c21cc2c13/lib/appium_lib/device/device.rb#L60)
+##### [pull_file](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/device/device.rb#L60)
> def pull_file
Retrieve a file from the device. This can retrieve an absolute path or
a path relative to the installed app (iOS only).
@@ -874,11 +851,11 @@
[String] path - Either an absolute path OR, for iOS devices, a path relative to the app, as described.
--
-##### [pull_folder](https://github.com/appium/ruby_lib/blob/ba2fbdcb206609259134fc09eac7940c21cc2c13/lib/appium_lib/device/device.rb#L70)
+##### [pull_folder](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/device/device.rb#L70)
> def pull_folder
Retrieve a folder from the device.
```ruby
@@ -889,11 +866,11 @@
[String] path - absolute path to the folder
--
-##### [touch_id](https://github.com/appium/ruby_lib/blob/ba2fbdcb206609259134fc09eac7940c21cc2c13/lib/appium_lib/device/device.rb#L78)
+##### [touch_id](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/device/device.rb#L78)
> def touch_id
iOS only; Simulate Touch ID with either valid (match == true) or invalid (match == false) fingerprint.
```ruby
@@ -906,11 +883,11 @@
[Boolean] match - fingerprint validity
Defaults to true.
--
-##### [end_coverage](https://github.com/appium/ruby_lib/blob/ba2fbdcb206609259134fc09eac7940c21cc2c13/lib/appium_lib/device/device.rb#L87)
+##### [end_coverage](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/device/device.rb#L87)
> def end_coverage
Android only; Ends the test coverage and writes the results to the given path on device.
@@ -920,35 +897,35 @@
[String] intent - Intent to broadcast when ending coverage.
--
-##### [get_settings](https://github.com/appium/ruby_lib/blob/ba2fbdcb206609259134fc09eac7940c21cc2c13/lib/appium_lib/device/device.rb#L92)
+##### [get_settings](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/device/device.rb#L92)
> def get_settings
Get appium Settings for current test session
--
-##### [extend_search_contexts](https://github.com/appium/ruby_lib/blob/ba2fbdcb206609259134fc09eac7940c21cc2c13/lib/appium_lib/device/device.rb#L356)
+##### [extend_search_contexts](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/device/device.rb#L356)
> def extend_search_contexts
--
-##### [find_element](https://github.com/appium/ruby_lib/blob/ba2fbdcb206609259134fc09eac7940c21cc2c13/lib/appium_lib/device/device.rb#L356)
+##### [find_element](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/device/device.rb#L356)
> def find_element
--
-##### [find_elements](https://github.com/appium/ruby_lib/blob/ba2fbdcb206609259134fc09eac7940c21cc2c13/lib/appium_lib/device/device.rb#L356)
+##### [find_elements](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/device/device.rb#L356)
> def find_elements
find_element/s with their accessibility_id
@@ -956,27 +933,27 @@
find_elements :accessibility_id, 'Animation'
```
--
-##### [add_touch_actions](https://github.com/appium/ruby_lib/blob/ba2fbdcb206609259134fc09eac7940c21cc2c13/lib/appium_lib/device/device.rb#L387)
+##### [add_touch_actions](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/device/device.rb#L387)
> def add_touch_actions
--
-##### [add_ime_actions](https://github.com/appium/ruby_lib/blob/ba2fbdcb206609259134fc09eac7940c21cc2c13/lib/appium_lib/device/device.rb#L410)
+##### [add_ime_actions](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/device/device.rb#L410)
> def add_ime_actions
--
-##### [set_context](https://github.com/appium/ruby_lib/blob/ba2fbdcb206609259134fc09eac7940c21cc2c13/lib/appium_lib/device/device.rb#L485)
+##### [set_context](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/device/device.rb#L485)
> def set_context
Change the context to the given context.
```ruby
@@ -987,11 +964,11 @@
[String] The - context to change to
--
-##### [current_context](https://github.com/appium/ruby_lib/blob/ba2fbdcb206609259134fc09eac7940c21cc2c13/lib/appium_lib/device/device.rb#L493)
+##### [current_context](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/device/device.rb#L493)
> def current_context
@@ -999,11 +976,11 @@
[String] The context currently being used.
--
-##### [available_contexts](https://github.com/appium/ruby_lib/blob/ba2fbdcb206609259134fc09eac7940c21cc2c13/lib/appium_lib/device/device.rb#L496)
+##### [available_contexts](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/device/device.rb#L496)
> def available_contexts
@@ -1011,11 +988,11 @@
[Array<String>] All usable contexts, as an array of strings.
--
-##### [within_context](https://github.com/appium/ruby_lib/blob/ba2fbdcb206609259134fc09eac7940c21cc2c13/lib/appium_lib/device/device.rb#L506)
+##### [within_context](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/device/device.rb#L506)
> def within_context(context)
Perform a block within the given context, then switch back to the starting context.
```ruby
@@ -1027,19 +1004,19 @@
[String] context - The context to switch to for the duration of the block.
--
-##### [switch_to_default_context](https://github.com/appium/ruby_lib/blob/ba2fbdcb206609259134fc09eac7940c21cc2c13/lib/appium_lib/device/device.rb#L514)
+##### [switch_to_default_context](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/device/device.rb#L514)
> def switch_to_default_context
Change to the default context. This is equivalent to `set_context nil`.
--
-##### [pinch](https://github.com/appium/ruby_lib/blob/ba2fbdcb206609259134fc09eac7940c21cc2c13/lib/appium_lib/device/multi_touch.rb#L28)
+##### [pinch](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/device/multi_touch.rb#L28)
> 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.
@@ -1054,11 +1031,11 @@
[boolean] auto_perform - Whether to perform the action immediately (default true)
--
-##### [zoom](https://github.com/appium/ruby_lib/blob/ba2fbdcb206609259134fc09eac7940c21cc2c13/lib/appium_lib/device/multi_touch.rb#L64)
+##### [zoom](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/device/multi_touch.rb#L64)
> 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.
@@ -1073,11 +1050,11 @@
[boolean] auto_perform - Whether to perform the action immediately (default true)
--
-##### [initialize](https://github.com/appium/ruby_lib/blob/ba2fbdcb206609259134fc09eac7940c21cc2c13/lib/appium_lib/device/multi_touch.rb#L95)
+##### [initialize](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/device/multi_touch.rb#L95)
> def initialize
Create a new multi-action
@@ -1085,11 +1062,11 @@
[MultiTouch] a new instance of MultiTouch
--
-##### [add](https://github.com/appium/ruby_lib/blob/ba2fbdcb206609259134fc09eac7940c21cc2c13/lib/appium_lib/device/multi_touch.rb#L101)
+##### [add](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/device/multi_touch.rb#L101)
> def add(chain)
Add a touch_action to be performed
@@ -1097,43 +1074,43 @@
[TouchAction] chain - The action to add to the chain
--
-##### [perform](https://github.com/appium/ruby_lib/blob/ba2fbdcb206609259134fc09eac7940c21cc2c13/lib/appium_lib/device/multi_touch.rb#L106)
+##### [perform](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/device/multi_touch.rb#L106)
> def perform
Ask Appium to perform the actions
--
-##### [ACTIONS](https://github.com/appium/ruby_lib/blob/ba2fbdcb206609259134fc09eac7940c21cc2c13/lib/appium_lib/device/touch_actions.rb#L11)
+##### [ACTIONS](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/device/touch_actions.rb#L11)
> ACTIONS = [:move_to, :long_press, :double_tap, :two_finger_tap, :press, :release, :tap, :wait, :perform].freeze
--
-##### [COMPLEX_ACTIONS](https://github.com/appium/ruby_lib/blob/ba2fbdcb206609259134fc09eac7940c21cc2c13/lib/appium_lib/device/touch_actions.rb#L12)
+##### [COMPLEX_ACTIONS](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/device/touch_actions.rb#L12)
> COMPLEX_ACTIONS = [:swipe].freeze
--
-##### [actions](https://github.com/appium/ruby_lib/blob/ba2fbdcb206609259134fc09eac7940c21cc2c13/lib/appium_lib/device/touch_actions.rb#L26)
+##### [actions](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/device/touch_actions.rb#L26)
> def actions
Returns the value of attribute actions
--
-##### [initialize](https://github.com/appium/ruby_lib/blob/ba2fbdcb206609259134fc09eac7940c21cc2c13/lib/appium_lib/device/touch_actions.rb#L28)
+##### [initialize](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/device/touch_actions.rb#L28)
> def initialize
@@ -1141,11 +1118,11 @@
[TouchAction] a new instance of TouchAction
--
-##### [move_to](https://github.com/appium/ruby_lib/blob/ba2fbdcb206609259134fc09eac7940c21cc2c13/lib/appium_lib/device/touch_actions.rb#L36)
+##### [move_to](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/device/touch_actions.rb#L36)
> def move_to(opts)
Move to the given co-ordinates.
@@ -1153,11 +1130,11 @@
[Hash] opts - a customizable set of options
--
-##### [long_press](https://github.com/appium/ruby_lib/blob/ba2fbdcb206609259134fc09eac7940c21cc2c13/lib/appium_lib/device/touch_actions.rb#L50)
+##### [long_press](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/device/touch_actions.rb#L50)
> def long_press(opts)
Press down for a specific duration.
Alternatively, you can use `press(...).wait(...).release()` instead of `long_press` if duration doesn't work well.
@@ -1174,11 +1151,11 @@
[Hash] duration - a customizable set of options
--
-##### [press](https://github.com/appium/ruby_lib/blob/ba2fbdcb206609259134fc09eac7940c21cc2c13/lib/appium_lib/device/touch_actions.rb#L62)
+##### [press](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/device/touch_actions.rb#L62)
> def press(opts)
Press a finger onto the screen. Finger will stay down until you call
`release`.
@@ -1187,11 +1164,11 @@
[Hash] opts - a customizable set of options
--
-##### [release](https://github.com/appium/ruby_lib/blob/ba2fbdcb206609259134fc09eac7940c21cc2c13/lib/appium_lib/device/touch_actions.rb#L73)
+##### [release](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/device/touch_actions.rb#L73)
> def release(opts = nil)
Remove a finger from the screen.
@@ -1199,23 +1176,24 @@
[Hash] opts - a customizable set of options
--
-##### [tap](https://github.com/appium/ruby_lib/blob/ba2fbdcb206609259134fc09eac7940c21cc2c13/lib/appium_lib/device/touch_actions.rb#L84)
+##### [tap](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/device/touch_actions.rb#L85)
> def tap(opts)
-Touch a point on the screen
+Touch a point on the screen.
+Alternatively, you can use `press(...).release.perform` instead of `tap(...).perform`.
__Parameters:__
[Hash] opts - a customizable set of options
--
-##### [double_tap](https://github.com/appium/ruby_lib/blob/ba2fbdcb206609259134fc09eac7940c21cc2c13/lib/appium_lib/device/touch_actions.rb#L97)
+##### [double_tap](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/device/touch_actions.rb#L98)
> def double_tap(opts)
Double tap an element on the screen
@@ -1223,11 +1201,11 @@
[Hash] opts - a customizable set of options
--
-##### [two_finger_tap](https://github.com/appium/ruby_lib/blob/ba2fbdcb206609259134fc09eac7940c21cc2c13/lib/appium_lib/device/touch_actions.rb#L108)
+##### [two_finger_tap](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/device/touch_actions.rb#L109)
> def two_finger_tap(opts)
Two finger tap an element on the screen
@@ -1235,11 +1213,11 @@
[Hash] opts - a customizable set of options
--
-##### [wait](https://github.com/appium/ruby_lib/blob/ba2fbdcb206609259134fc09eac7940c21cc2c13/lib/appium_lib/device/touch_actions.rb#L116)
+##### [wait](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/device/touch_actions.rb#L117)
> def wait(milliseconds)
Pause for a number of milliseconds before the next action
@@ -1247,11 +1225,11 @@
[integer] milliseconds - Number of milliseconds to pause for
--
-##### [swipe](https://github.com/appium/ruby_lib/blob/ba2fbdcb206609259134fc09eac7940c21cc2c13/lib/appium_lib/device/touch_actions.rb#L131)
+##### [swipe](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/device/touch_actions.rb#L132)
> def swipe(opts, ele = nil)
Convenience method to peform a swipe.
@@ -1261,60 +1239,60 @@
[Hash] opts - a customizable set of options
--
-##### [perform](https://github.com/appium/ruby_lib/blob/ba2fbdcb206609259134fc09eac7940c21cc2c13/lib/appium_lib/device/touch_actions.rb#L165)
+##### [perform](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/device/touch_actions.rb#L166)
> def perform
Ask the driver to perform all actions in this action chain.
--
-##### [cancel](https://github.com/appium/ruby_lib/blob/ba2fbdcb206609259134fc09eac7940c21cc2c13/lib/appium_lib/device/touch_actions.rb#L171)
+##### [cancel](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/device/touch_actions.rb#L172)
> def cancel
Does nothing, currently.
--
-##### [chain_method](https://github.com/appium/ruby_lib/blob/ba2fbdcb206609259134fc09eac7940c21cc2c13/lib/appium_lib/device/touch_actions.rb#L179)
+##### [chain_method](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/device/touch_actions.rb#L180)
> def chain_method(method, args = nil)
--
-##### [args_with_ele_ref](https://github.com/appium/ruby_lib/blob/ba2fbdcb206609259134fc09eac7940c21cc2c13/lib/appium_lib/device/touch_actions.rb#L185)
+##### [args_with_ele_ref](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/device/touch_actions.rb#L186)
> def args_with_ele_ref(args)
--
-##### [_generic_wait](https://github.com/appium/ruby_lib/blob/ba2fbdcb206609259134fc09eac7940c21cc2c13/lib/appium_lib/common/wait.rb#L9)
+##### [_generic_wait](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/common/wait.rb#L9)
> def _generic_wait(opts = {})
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/ba2fbdcb206609259134fc09eac7940c21cc2c13/lib/appium_lib/common/wait.rb#L48)
+##### [_process_wait_opts](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/common/wait.rb#L48)
> def _process_wait_opts(opts)
process opts before calling _generic_wait
--
-##### [wait_true](https://github.com/appium/ruby_lib/blob/ba2fbdcb206609259134fc09eac7940c21cc2c13/lib/appium_lib/common/wait.rb#L69)
+##### [wait_true](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/common/wait.rb#L69)
> def wait_true(opts = {}, &block)
Check every interval seconds to see if yield returns a truthy value.
Note this isn't a strict boolean true, any truthy value is accepted.
@@ -1330,11 +1308,11 @@
[Hash] opts - Options
--
-##### [wait](https://github.com/appium/ruby_lib/blob/ba2fbdcb206609259134fc09eac7940c21cc2c13/lib/appium_lib/common/wait.rb#L87)
+##### [wait](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/common/wait.rb#L87)
> def wait(opts = {}, &block)
Check every interval seconds to see if yield doesn't raise an exception.
Give up after timeout seconds.
@@ -1348,19 +1326,19 @@
[Hash] opts - Options
--
-##### [ignore](https://github.com/appium/ruby_lib/blob/ba2fbdcb206609259134fc09eac7940c21cc2c13/lib/appium_lib/common/helper.rb#L24)
+##### [ignore](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/common/helper.rb#L24)
> def ignore
Return yield and ignore any exceptions.
--
-##### [back](https://github.com/appium/ruby_lib/blob/ba2fbdcb206609259134fc09eac7940c21cc2c13/lib/appium_lib/common/helper.rb#L31)
+##### [back](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/common/helper.rb#L31)
> def back
Navigate back.
@@ -1368,19 +1346,19 @@
[void]
--
-##### [session_id](https://github.com/appium/ruby_lib/blob/ba2fbdcb206609259134fc09eac7940c21cc2c13/lib/appium_lib/common/helper.rb#L36)
+##### [session_id](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/common/helper.rb#L36)
> def session_id
For Sauce Labs reporting. Returns the current session id.
--
-##### [xpath](https://github.com/appium/ruby_lib/blob/ba2fbdcb206609259134fc09eac7940c21cc2c13/lib/appium_lib/common/helper.rb#L44)
+##### [xpath](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/common/helper.rb#L44)
> def xpath(xpath_str)
Returns the first element that matches the provided xpath.
@@ -1392,11 +1370,11 @@
[Element]
--
-##### [xpaths](https://github.com/appium/ruby_lib/blob/ba2fbdcb206609259134fc09eac7940c21cc2c13/lib/appium_lib/common/helper.rb#L52)
+##### [xpaths](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/common/helper.rb#L52)
> def xpaths(xpath_str)
Returns all elements that match the provided xpath.
@@ -1408,27 +1386,27 @@
[Array<Element>]
--
-##### [_print_source](https://github.com/appium/ruby_lib/blob/ba2fbdcb206609259134fc09eac7940c21cc2c13/lib/appium_lib/common/helper.rb#L56)
+##### [_print_source](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/common/helper.rb#L56)
> def _print_source(source)
--
-##### [result](https://github.com/appium/ruby_lib/blob/ba2fbdcb206609259134fc09eac7940c21cc2c13/lib/appium_lib/common/helper.rb#L69)
+##### [result](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/common/helper.rb#L69)
> def result
Returns the value of attribute result
--
-##### [initialize](https://github.com/appium/ruby_lib/blob/ba2fbdcb206609259134fc09eac7940c21cc2c13/lib/appium_lib/common/helper.rb#L71)
+##### [initialize](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/common/helper.rb#L71)
> def initialize
@@ -1436,52 +1414,52 @@
[CountElements] a new instance of CountElements
--
-##### [reset](https://github.com/appium/ruby_lib/blob/ba2fbdcb206609259134fc09eac7940c21cc2c13/lib/appium_lib/common/helper.rb#L75)
+##### [reset](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/common/helper.rb#L75)
> def reset
--
-##### [start_element](https://github.com/appium/ruby_lib/blob/ba2fbdcb206609259134fc09eac7940c21cc2c13/lib/appium_lib/common/helper.rb#L80)
+##### [start_element](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/common/helper.rb#L80)
> def start_element(name, attrs = [])
http://nokogiri.org/Nokogiri/XML/SAX/Document.html
--
-##### [formatted_result](https://github.com/appium/ruby_lib/blob/ba2fbdcb206609259134fc09eac7940c21cc2c13/lib/appium_lib/common/helper.rb#L86)
+##### [formatted_result](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/common/helper.rb#L86)
> def formatted_result
--
-##### [get_page_class](https://github.com/appium/ruby_lib/blob/ba2fbdcb206609259134fc09eac7940c21cc2c13/lib/appium_lib/common/helper.rb#L97)
+##### [get_page_class](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/common/helper.rb#L97)
> def get_page_class
Returns a string of class counts of visible elements.
--
-##### [page_class](https://github.com/appium/ruby_lib/blob/ba2fbdcb206609259134fc09eac7940c21cc2c13/lib/appium_lib/common/helper.rb#L108)
+##### [page_class](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/common/helper.rb#L108)
> def page_class
Count all classes on screen and print to stdout.
Useful for appium_console.
--
-##### [px_to_window_rel](https://github.com/appium/ruby_lib/blob/ba2fbdcb206609259134fc09eac7940c21cc2c13/lib/appium_lib/common/helper.rb#L118)
+##### [px_to_window_rel](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/common/helper.rb#L118)
> def px_to_window_rel(opts = {})
Converts pixel values to window relative values
@@ -1489,11 +1467,11 @@
px_to_window_rel x: 50, y: 150
```
--
-##### [xml_keys](https://github.com/appium/ruby_lib/blob/ba2fbdcb206609259134fc09eac7940c21cc2c13/lib/appium_lib/common/helper.rb#L137)
+##### [xml_keys](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/common/helper.rb#L137)
> def xml_keys(target)
Search strings.xml's values for target.
@@ -1505,11 +1483,11 @@
[Array]
--
-##### [xml_values](https://github.com/appium/ruby_lib/blob/ba2fbdcb206609259134fc09eac7940c21cc2c13/lib/appium_lib/common/helper.rb#L145)
+##### [xml_values](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/common/helper.rb#L145)
> def xml_values(target)
Search strings.xml's keys for target.
@@ -1521,11 +1499,11 @@
[Array]
--
-##### [resolve_id](https://github.com/appium/ruby_lib/blob/ba2fbdcb206609259134fc09eac7940c21cc2c13/lib/appium_lib/common/helper.rb#L153)
+##### [resolve_id](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/common/helper.rb#L153)
> def resolve_id(id)
Resolve id in strings.xml and return the value.
@@ -1537,27 +1515,27 @@
[String]
--
-##### [filter](https://github.com/appium/ruby_lib/blob/ba2fbdcb206609259134fc09eac7940c21cc2c13/lib/appium_lib/common/helper.rb#L159)
+##### [filter](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/common/helper.rb#L159)
> def filter
Returns the value of attribute filter
--
-##### [filter=](https://github.com/appium/ruby_lib/blob/ba2fbdcb206609259134fc09eac7940c21cc2c13/lib/appium_lib/common/helper.rb#L162)
+##### [filter=](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/common/helper.rb#L162)
> def filter=(value)
convert to string to support symbols
--
-##### [initialize](https://github.com/appium/ruby_lib/blob/ba2fbdcb206609259134fc09eac7940c21cc2c13/lib/appium_lib/common/helper.rb#L168)
+##### [initialize](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/common/helper.rb#L168)
> def initialize
@@ -1565,99 +1543,99 @@
[HTMLElements] a new instance of HTMLElements
--
-##### [reset](https://github.com/appium/ruby_lib/blob/ba2fbdcb206609259134fc09eac7940c21cc2c13/lib/appium_lib/common/helper.rb#L173)
+##### [reset](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/common/helper.rb#L173)
> def reset
--
-##### [result](https://github.com/appium/ruby_lib/blob/ba2fbdcb206609259134fc09eac7940c21cc2c13/lib/appium_lib/common/helper.rb#L179)
+##### [result](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/common/helper.rb#L179)
> def result
--
-##### [start_element](https://github.com/appium/ruby_lib/blob/ba2fbdcb206609259134fc09eac7940c21cc2c13/lib/appium_lib/common/helper.rb#L195)
+##### [start_element](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/common/helper.rb#L195)
> def start_element(name, attrs = [])
--
-##### [end_element](https://github.com/appium/ruby_lib/blob/ba2fbdcb206609259134fc09eac7940c21cc2c13/lib/appium_lib/common/helper.rb#L204)
+##### [end_element](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/common/helper.rb#L204)
> def end_element(name)
--
-##### [characters](https://github.com/appium/ruby_lib/blob/ba2fbdcb206609259134fc09eac7940c21cc2c13/lib/appium_lib/common/helper.rb#L210)
+##### [characters](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/common/helper.rb#L210)
> def characters(chars)
--
-##### [_no_such_element](https://github.com/appium/ruby_lib/blob/ba2fbdcb206609259134fc09eac7940c21cc2c13/lib/appium_lib/common/helper.rb#L217)
+##### [_no_such_element](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/common/helper.rb#L217)
> def _no_such_element
--
-##### [COMMAND_NO_ARG](https://github.com/appium/ruby_lib/blob/ba2fbdcb206609259134fc09eac7940c21cc2c13/lib/appium_lib/common/command.rb#L4)
+##### [COMMAND_NO_ARG](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/common/command.rb#L4)
> COMMAND_NO_ARG = {
--
-##### [COMMAND](https://github.com/appium/ruby_lib/blob/ba2fbdcb206609259134fc09eac7940c21cc2c13/lib/appium_lib/common/command.rb#L23)
+##### [COMMAND](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/common/command.rb#L23)
> COMMAND = {
--
-##### [FINDERS](https://github.com/appium/ruby_lib/blob/ba2fbdcb206609259134fc09eac7940c21cc2c13/lib/appium_lib/common/search_context.rb#L5)
+##### [window_size](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/common/element/window.rb#L5)
-> FINDERS = {
+> def window_size
-rubocop:disable Style/MutableConstant
+Get the window's size
--
-##### [window_size](https://github.com/appium/ruby_lib/blob/ba2fbdcb206609259134fc09eac7940c21cc2c13/lib/appium_lib/common/element/window.rb#L5)
+##### [FINDERS](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/common/search_context.rb#L5)
-> def window_size
+> FINDERS = {
-Get the window's size
+rubocop:disable Style/MutableConstant
--
-##### [filter](https://github.com/appium/ruby_lib/blob/ba2fbdcb206609259134fc09eac7940c21cc2c13/lib/appium_lib/ios/helper.rb#L4) ios
+##### [filter](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/ios/helper.rb#L4) ios
> def filter
Returns the value of attribute filter
--
-##### [filter=](https://github.com/appium/ruby_lib/blob/ba2fbdcb206609259134fc09eac7940c21cc2c13/lib/appium_lib/ios/helper.rb#L4) ios
+##### [filter=](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/ios/helper.rb#L4) ios
> def filter=(value)
Sets the attribute filter
@@ -1665,27 +1643,27 @@
value - the value to set the attribute filter to.
--
-##### [start_element](https://github.com/appium/ruby_lib/blob/ba2fbdcb206609259134fc09eac7940c21cc2c13/lib/appium_lib/ios/helper.rb#L6) ios
+##### [start_element](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/ios/helper.rb#L6) ios
> def start_element(type, attrs = [])
--
-##### [_print_attr](https://github.com/appium/ruby_lib/blob/ba2fbdcb206609259134fc09eac7940c21cc2c13/lib/appium_lib/ios/helper.rb#L15) ios
+##### [_print_attr](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/ios/helper.rb#L15) ios
> def _print_attr(type, name, label, value, hint)
--
-##### [ios_password](https://github.com/appium/ruby_lib/blob/ba2fbdcb206609259134fc09eac7940c21cc2c13/lib/appium_lib/ios/helper.rb#L41) ios
+##### [ios_password](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/ios/helper.rb#L41) ios
> def ios_password(length = 1)
iOS only. On Android uiautomator always returns an empty string for EditText password.
@@ -1699,11 +1677,11 @@
[String] the returned string is of size length
--
-##### [get_page](https://github.com/appium/ruby_lib/blob/ba2fbdcb206609259134fc09eac7940c21cc2c13/lib/appium_lib/ios/helper.rb#L53) ios
+##### [get_page](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/ios/helper.rb#L53) ios
> def get_page(element = source_window(0), class_name = nil)
Returns a string of interesting elements. iOS only.
@@ -1720,11 +1698,11 @@
[String]
--
-##### [page](https://github.com/appium/ruby_lib/blob/ba2fbdcb206609259134fc09eac7940c21cc2c13/lib/appium_lib/ios/helper.rb#L139) ios
+##### [page](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/ios/helper.rb#L139) ios
> def page(opts = {})
Prints a string of interesting elements to the console.
@@ -1746,11 +1724,11 @@
[void]
--
-##### [source_window](https://github.com/appium/ruby_lib/blob/ba2fbdcb206609259134fc09eac7940c21cc2c13/lib/appium_lib/ios/helper.rb#L170) ios
+##### [source_window](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/ios/helper.rb#L170) ios
> def source_window(_window_number = 0)
Gets the JSON source of window number
@@ -1762,11 +1740,11 @@
[JSON]
--
-##### [page_window](https://github.com/appium/ruby_lib/blob/ba2fbdcb206609259134fc09eac7940c21cc2c13/lib/appium_lib/ios/helper.rb#L185) ios
+##### [page_window](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/ios/helper.rb#L185) ios
> def page_window(window_number = 0)
Prints parsed page source to console.
@@ -1780,11 +1758,11 @@
[void]
--
-##### [id](https://github.com/appium/ruby_lib/blob/ba2fbdcb206609259134fc09eac7940c21cc2c13/lib/appium_lib/ios/helper.rb#L193) ios
+##### [id](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/ios/helper.rb#L193) ios
> def id(id)
Find by id
@@ -1796,11 +1774,11 @@
[Element]
--
-##### [ios_version](https://github.com/appium/ruby_lib/blob/ba2fbdcb206609259134fc09eac7940c21cc2c13/lib/appium_lib/ios/helper.rb#L199) ios
+##### [ios_version](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/ios/helper.rb#L199) ios
> def ios_version
Return the iOS version as an array of integers
@@ -1808,11 +1786,11 @@
[Array<Integer>]
--
-##### [ele_index](https://github.com/appium/ruby_lib/blob/ba2fbdcb206609259134fc09eac7940c21cc2c13/lib/appium_lib/ios/helper.rb#L212) ios
+##### [ele_index](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/ios/helper.rb#L212) ios
> def ele_index(class_name, index)
Get the element of type class_name at matching index.
@@ -1826,11 +1804,11 @@
[Element]
--
-##### [find_ele_by_attr](https://github.com/appium/ruby_lib/blob/ba2fbdcb206609259134fc09eac7940c21cc2c13/lib/appium_lib/ios/helper.rb#L247) ios
+##### [find_ele_by_attr](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/ios/helper.rb#L247) ios
> def find_ele_by_attr(class_name, attr, value)
Find the first element exactly matching class and attribute value.
Note: Uses XPath
@@ -1847,11 +1825,11 @@
[Element]
--
-##### [find_eles_by_attr](https://github.com/appium/ruby_lib/blob/ba2fbdcb206609259134fc09eac7940c21cc2c13/lib/appium_lib/ios/helper.rb#L257) ios
+##### [find_eles_by_attr](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/ios/helper.rb#L257) ios
> def find_eles_by_attr(class_name, attr, value)
Find all elements exactly matching class and attribute value.
Note: Uses XPath
@@ -1868,11 +1846,11 @@
[Array<Element>]
--
-##### [find_ele_by_attr_include](https://github.com/appium/ruby_lib/blob/ba2fbdcb206609259134fc09eac7940c21cc2c13/lib/appium_lib/ios/helper.rb#L280) ios
+##### [find_ele_by_attr_include](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/ios/helper.rb#L280) ios
> def find_ele_by_attr_include(class_name, attr, value)
Get the first tag by attribute that exactly matches value.
Note: Uses XPath
@@ -1889,11 +1867,11 @@
[Element] the element of type tag who's attribute includes value
--
-##### [find_eles_by_attr_include](https://github.com/appium/ruby_lib/blob/ba2fbdcb206609259134fc09eac7940c21cc2c13/lib/appium_lib/ios/helper.rb#L290) ios
+##### [find_eles_by_attr_include](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/ios/helper.rb#L290) ios
> def find_eles_by_attr_include(class_name, attr, value)
Get tags by attribute that include value.
Note: Uses XPath
@@ -1910,11 +1888,11 @@
[Array<Element>] the elements of type tag who's attribute includes value
--
-##### [first_ele](https://github.com/appium/ruby_lib/blob/ba2fbdcb206609259134fc09eac7940c21cc2c13/lib/appium_lib/ios/helper.rb#L297) ios
+##### [first_ele](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/ios/helper.rb#L297) ios
> def first_ele(class_name)
Get the first tag that matches class_name
@@ -1926,11 +1904,11 @@
[Element]
--
-##### [last_ele](https://github.com/appium/ruby_lib/blob/ba2fbdcb206609259134fc09eac7940c21cc2c13/lib/appium_lib/ios/helper.rb#L308) ios
+##### [last_ele](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/ios/helper.rb#L308) ios
> def last_ele(class_name)
Get the last tag that matches class_name
@@ -1942,11 +1920,11 @@
[Element]
--
-##### [tag](https://github.com/appium/ruby_lib/blob/ba2fbdcb206609259134fc09eac7940c21cc2c13/lib/appium_lib/ios/helper.rb#L322) ios
+##### [tag](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/ios/helper.rb#L322) ios
> def tag(class_name)
Returns the first visible element matching class_name
@@ -1958,11 +1936,11 @@
[Element]
--
-##### [tags](https://github.com/appium/ruby_lib/blob/ba2fbdcb206609259134fc09eac7940c21cc2c13/lib/appium_lib/ios/helper.rb#L334) ios
+##### [tags](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/ios/helper.rb#L334) ios
> def tags(class_name)
Returns all visible elements matching class_name
@@ -1974,11 +1952,11 @@
[Element]
--
-##### [ele_by_json_visible_contains](https://github.com/appium/ruby_lib/blob/ba2fbdcb206609259134fc09eac7940c21cc2c13/lib/appium_lib/ios/helper.rb#L371) ios
+##### [ele_by_json_visible_contains](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/ios/helper.rb#L371) ios
> def ele_by_json_visible_contains(element, value)
Find the first element that contains value.
For Appium(automation name), not XCUITest
@@ -1993,11 +1971,11 @@
[Element]
--
-##### [eles_by_json_visible_contains](https://github.com/appium/ruby_lib/blob/ba2fbdcb206609259134fc09eac7940c21cc2c13/lib/appium_lib/ios/helper.rb#L380) ios
+##### [eles_by_json_visible_contains](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/ios/helper.rb#L380) ios
> def eles_by_json_visible_contains(element, value)
Find all elements containing value
For Appium(automation name), not XCUITest
@@ -2012,11 +1990,11 @@
[Array<Element>]
--
-##### [ele_by_json_visible_exact](https://github.com/appium/ruby_lib/blob/ba2fbdcb206609259134fc09eac7940c21cc2c13/lib/appium_lib/ios/helper.rb#L410) ios
+##### [ele_by_json_visible_exact](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/ios/helper.rb#L410) ios
> def ele_by_json_visible_exact(element, value)
Find the first element exactly matching value
For Appium(automation name), not XCUITest
@@ -2031,11 +2009,11 @@
[Element]
--
-##### [eles_by_json_visible_exact](https://github.com/appium/ruby_lib/blob/ba2fbdcb206609259134fc09eac7940c21cc2c13/lib/appium_lib/ios/helper.rb#L419) ios
+##### [eles_by_json_visible_exact](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/ios/helper.rb#L419) ios
> def eles_by_json_visible_exact(element, value)
Find all elements exactly matching value
For Appium(automation name), not XCUITest
@@ -2050,21 +2028,21 @@
[Element]
--
-##### [_all_pred](https://github.com/appium/ruby_lib/blob/ba2fbdcb206609259134fc09eac7940c21cc2c13/lib/appium_lib/ios/helper.rb#L484) ios
+##### [_all_pred](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/ios/helper.rb#L484) ios
> def _all_pred(opts)
predicate - the predicate to evaluate on the main app
visible - if true, only visible elements are returned. default true
--
-##### [ele_with_pred](https://github.com/appium/ruby_lib/blob/ba2fbdcb206609259134fc09eac7940c21cc2c13/lib/appium_lib/ios/helper.rb#L497) ios
+##### [ele_with_pred](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/ios/helper.rb#L497) ios
> def ele_with_pred(opts)
returns element matching predicate contained in the main app
@@ -2076,11 +2054,11 @@
[Element]
--
-##### [eles_with_pred](https://github.com/appium/ruby_lib/blob/ba2fbdcb206609259134fc09eac7940c21cc2c13/lib/appium_lib/ios/helper.rb#L508) ios
+##### [eles_with_pred](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/ios/helper.rb#L508) ios
> def eles_with_pred(opts)
returns elements matching predicate contained in the main app
@@ -2092,11 +2070,11 @@
[Array<Element>]
--
-##### [source](https://github.com/appium/ruby_lib/blob/ba2fbdcb206609259134fc09eac7940c21cc2c13/lib/appium_lib/ios/helper.rb#L514) ios
+##### [source](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/ios/helper.rb#L514) ios
> def source
Prints xml of the current page
@@ -2104,19 +2082,19 @@
[void]
--
-##### [_validate_object](https://github.com/appium/ruby_lib/blob/ba2fbdcb206609259134fc09eac7940c21cc2c13/lib/appium_lib/ios/helper.rb#L518) ios
+##### [_validate_object](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/ios/helper.rb#L518) ios
> def _validate_object(*objects)
--
-##### [_by_json](https://github.com/appium/ruby_lib/blob/ba2fbdcb206609259134fc09eac7940c21cc2c13/lib/appium_lib/ios/helper.rb#L567) ios
+##### [_by_json](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/ios/helper.rb#L567) ios
> def _by_json(opts)
For Appium(automation name), not XCUITest
typeArray - array of string types to search for. Example: ["UIAStaticText"]
@@ -2147,11 +2125,11 @@
}
}
--
-##### [eles_by_json](https://github.com/appium/ruby_lib/blob/ba2fbdcb206609259134fc09eac7940c21cc2c13/lib/appium_lib/ios/helper.rb#L617) ios
+##### [eles_by_json](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/ios/helper.rb#L617) ios
> def eles_by_json(opts)
For Appium(automation name), not XCUITest
example usage:
@@ -2166,19 +2144,19 @@
},
})
--
-##### [ele_by_json](https://github.com/appium/ruby_lib/blob/ba2fbdcb206609259134fc09eac7940c21cc2c13/lib/appium_lib/ios/helper.rb#L623) ios
+##### [ele_by_json](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/ios/helper.rb#L623) ios
> def ele_by_json(opts)
see eles_by_json
--
-##### [get_source](https://github.com/appium/ruby_lib/blob/ba2fbdcb206609259134fc09eac7940c21cc2c13/lib/appium_lib/ios/helper.rb#L633) ios
+##### [get_source](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/ios/helper.rb#L633) ios
> def get_source
Returns XML string for the current page
Same as driver.page_source
@@ -2187,27 +2165,27 @@
[String]
--
-##### [IAStaticText](https://github.com/appium/ruby_lib/blob/ba2fbdcb206609259134fc09eac7940c21cc2c13/lib/appium_lib/ios/element/text.rb#L4) ios
+##### [IAStaticText](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/ios/element/text.rb#L4) ios
> IAStaticText = 'UIAStaticText'.freeze
--
-##### [XCUIElementTypeStaticText](https://github.com/appium/ruby_lib/blob/ba2fbdcb206609259134fc09eac7940c21cc2c13/lib/appium_lib/ios/element/text.rb#L5) ios
+##### [XCUIElementTypeStaticText](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/ios/element/text.rb#L5) ios
> XCUIElementTypeStaticText = 'XCUIElementTypeStaticText'.freeze
--
-##### [static_text_class](https://github.com/appium/ruby_lib/blob/ba2fbdcb206609259134fc09eac7940c21cc2c13/lib/appium_lib/ios/element/text.rb#L8) ios
+##### [static_text_class](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/ios/element/text.rb#L8) ios
> def static_text_class
@@ -2215,11 +2193,11 @@
[String] Class name for text
--
-##### [text](https://github.com/appium/ruby_lib/blob/ba2fbdcb206609259134fc09eac7940c21cc2c13/lib/appium_lib/ios/element/text.rb#L16) ios
+##### [text](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/ios/element/text.rb#L16) ios
> def text(value)
Find the first UIAStaticText|XCUIElementTypeStaticText that contains value or by index.
If int then the UIAStaticText|XCUIElementTypeStaticText at that index is returned.
@@ -2232,11 +2210,11 @@
[UIAStaticText|XCUIElementTypeStaticText]
--
-##### [texts](https://github.com/appium/ruby_lib/blob/ba2fbdcb206609259134fc09eac7940c21cc2c13/lib/appium_lib/ios/element/text.rb#L30) ios
+##### [texts](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/ios/element/text.rb#L30) ios
> def texts(value = false)
Find all UIAStaticTexts|XCUIElementTypeStaticTexts containing value.
If value is omitted, all UIAStaticTexts|XCUIElementTypeStaticTexts are returned
@@ -2249,11 +2227,11 @@
[Array<UIAStaticText|XCUIElementTypeStaticText>]
--
-##### [first_text](https://github.com/appium/ruby_lib/blob/ba2fbdcb206609259134fc09eac7940c21cc2c13/lib/appium_lib/ios/element/text.rb#L43) ios
+##### [first_text](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/ios/element/text.rb#L43) ios
> def first_text
Find the first UIAStaticText|XCUIElementTypeStaticText.
@@ -2261,11 +2239,11 @@
[UIAStaticText|XCUIElementTypeStaticText]
--
-##### [last_text](https://github.com/appium/ruby_lib/blob/ba2fbdcb206609259134fc09eac7940c21cc2c13/lib/appium_lib/ios/element/text.rb#L49) ios
+##### [last_text](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/ios/element/text.rb#L49) ios
> def last_text
Find the last UIAStaticText|XCUIElementTypeStaticText.
@@ -2273,11 +2251,11 @@
[UIAStaticText|XCUIElementTypeStaticText]
--
-##### [text_exact](https://github.com/appium/ruby_lib/blob/ba2fbdcb206609259134fc09eac7940c21cc2c13/lib/appium_lib/ios/element/text.rb#L56) ios
+##### [text_exact](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/ios/element/text.rb#L56) ios
> def text_exact(value)
Find the first UIAStaticText|XCUIElementTypeStaticText that exactly matches value.
@@ -2289,11 +2267,11 @@
[UIAStaticText|XCUIElementTypeStaticText]
--
-##### [texts_exact](https://github.com/appium/ruby_lib/blob/ba2fbdcb206609259134fc09eac7940c21cc2c13/lib/appium_lib/ios/element/text.rb#L67) ios
+##### [texts_exact](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/ios/element/text.rb#L67) ios
> def texts_exact(value)
Find all UIAStaticTexts|XCUIElementTypeStaticTexts that exactly match value.
@@ -2305,11 +2283,11 @@
[Array<UIAStaticText|XCUIElementTypeStaticText>]
--
-##### [alert_accept](https://github.com/appium/ruby_lib/blob/ba2fbdcb206609259134fc09eac7940c21cc2c13/lib/appium_lib/ios/element/alert.rb#L5) ios
+##### [alert_accept](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/ios/element/alert.rb#L5) ios
> def alert_accept
Accept the alert.
@@ -2317,11 +2295,11 @@
[void]
--
-##### [alert_dismiss](https://github.com/appium/ruby_lib/blob/ba2fbdcb206609259134fc09eac7940c21cc2c13/lib/appium_lib/ios/element/alert.rb#L13) ios
+##### [alert_dismiss](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/ios/element/alert.rb#L13) ios
> def alert_dismiss
Dismiss the alert.
@@ -2329,39 +2307,27 @@
[void]
--
-##### [uiautomation_find](https://github.com/appium/ruby_lib/blob/ba2fbdcb206609259134fc09eac7940c21cc2c13/lib/appium_lib/ios/mobile_methods.rb#L10) ios
+##### [UIAButton](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/ios/element/button.rb#L4) ios
-> def uiautomation_find
-
-find_element/s can be used with a [UIAutomation command](https://developer.apple.com/library/ios/documentation/ToolsLanguages/Reference/UIAWindowClassReference/UIAWindow/UIAWindow.html#//apple_ref/doc/uid/TP40009930).
-
-```ruby
- find_elements :uiautomation, 'elements()
-```
-
---
-
-##### [UIAButton](https://github.com/appium/ruby_lib/blob/ba2fbdcb206609259134fc09eac7940c21cc2c13/lib/appium_lib/ios/element/button.rb#L4) ios
-
> UIAButton = 'UIAButton'.freeze
--
-##### [XCUIElementTypeButton](https://github.com/appium/ruby_lib/blob/ba2fbdcb206609259134fc09eac7940c21cc2c13/lib/appium_lib/ios/element/button.rb#L5) ios
+##### [XCUIElementTypeButton](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/ios/element/button.rb#L5) ios
> XCUIElementTypeButton = 'XCUIElementTypeButton'.freeze
--
-##### [button_class](https://github.com/appium/ruby_lib/blob/ba2fbdcb206609259134fc09eac7940c21cc2c13/lib/appium_lib/ios/element/button.rb#L8) ios
+##### [button_class](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/ios/element/button.rb#L8) ios
> def button_class
@@ -2369,11 +2335,11 @@
[String] Class name for button
--
-##### [button](https://github.com/appium/ruby_lib/blob/ba2fbdcb206609259134fc09eac7940c21cc2c13/lib/appium_lib/ios/element/button.rb#L16) ios
+##### [button](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/ios/element/button.rb#L16) ios
> def button(value)
Find the first UIAButton|XCUIElementTypeButton that contains value or by index.
If int then the UIAButton|XCUIElementTypeButton at that index is returned.
@@ -2386,11 +2352,11 @@
[UIAButton|XCUIElementTypeButton]
--
-##### [buttons](https://github.com/appium/ruby_lib/blob/ba2fbdcb206609259134fc09eac7940c21cc2c13/lib/appium_lib/ios/element/button.rb#L31) ios
+##### [buttons](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/ios/element/button.rb#L31) ios
> def buttons(value = false)
Find all UIAButtons|XCUIElementTypeButtons containing value.
If value is omitted, all UIAButtons|XCUIElementTypeButtons are returned.
@@ -2403,11 +2369,11 @@
[Array<UIAButton|XCUIElementTypeButton>]
--
-##### [first_button](https://github.com/appium/ruby_lib/blob/ba2fbdcb206609259134fc09eac7940c21cc2c13/lib/appium_lib/ios/element/button.rb#L44) ios
+##### [first_button](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/ios/element/button.rb#L44) ios
> def first_button
Find the first UIAButton|XCUIElementTypeButton.
@@ -2415,11 +2381,11 @@
[UIAButton|XCUIElementTypeButton]
--
-##### [last_button](https://github.com/appium/ruby_lib/blob/ba2fbdcb206609259134fc09eac7940c21cc2c13/lib/appium_lib/ios/element/button.rb#L52) ios
+##### [last_button](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/ios/element/button.rb#L52) ios
> def last_button
TODO: add documentation regarding previous element.
Previous UIAElement is differ from UIAButton|XCUIElementTypeButton. So, the results are different.
@@ -2429,11 +2395,11 @@
[UIAButton|XCUIElementTypeButton]
--
-##### [button_exact](https://github.com/appium/ruby_lib/blob/ba2fbdcb206609259134fc09eac7940c21cc2c13/lib/appium_lib/ios/element/button.rb#L59) ios
+##### [button_exact](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/ios/element/button.rb#L59) ios
> def button_exact(value)
Find the first UIAButton|XCUIElementTypeButton that exactly matches value.
@@ -2445,11 +2411,11 @@
[UIAButton|XCUIElementTypeButton]
--
-##### [buttons_exact](https://github.com/appium/ruby_lib/blob/ba2fbdcb206609259134fc09eac7940c21cc2c13/lib/appium_lib/ios/element/button.rb#L70) ios
+##### [buttons_exact](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/ios/element/button.rb#L70) ios
> def buttons_exact(value)
Find all UIAButtons|XCUIElementTypeButtons that exactly match value.
@@ -2461,12 +2427,38 @@
[Array<UIAButton|XCUIElementTypeButton>]
--
-##### [find](https://github.com/appium/ruby_lib/blob/ba2fbdcb206609259134fc09eac7940c21cc2c13/lib/appium_lib/ios/element/generic.rb#L6) ios
+##### [uiautomation_find](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/ios/mobile_methods.rb#L19) ios
+> def uiautomation_find
+
+find_element/s can be used with a [UIAutomation command](https://developer.apple.com/library/ios/documentation/ToolsLanguages/Reference/UIAWindowClassReference/UIAWindow/UIAWindow.html#//apple_ref/doc/uid/TP40009930).
+
+```ruby
+ find_elements :uiautomation, 'elements()
+```
+
+--
+
+##### [ios_predicate_string_find](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/ios/mobile_methods.rb#L19) ios
+
+> def ios_predicate_string_find
+
+find_element/s can be used with a [Predicates](https://developer.apple.com/library/content/documentation/Cocoa/Conceptual/Predicates/AdditionalChapters/Introduction.html)
+
+```ruby
+ find_elements :predicate, "isWDVisible == 1"
+ find_elements :predicate, 'wdName == "Buttons"'
+ find_elements :predicate, 'wdValue == "SearchBar" AND isWDDivisible == 1'
+```
+
+--
+
+##### [find](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/ios/element/generic.rb#L6) ios
+
> def find(value)
Find the first element containing value
__Parameters:__
@@ -2477,11 +2469,11 @@
[Element]
--
-##### [finds](https://github.com/appium/ruby_lib/blob/ba2fbdcb206609259134fc09eac7940c21cc2c13/lib/appium_lib/ios/element/generic.rb#L17) ios
+##### [finds](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/ios/element/generic.rb#L17) ios
> def finds(value)
Find all elements containing value
@@ -2493,11 +2485,11 @@
[Array<Element>]
--
-##### [find_exact](https://github.com/appium/ruby_lib/blob/ba2fbdcb206609259134fc09eac7940c21cc2c13/lib/appium_lib/ios/element/generic.rb#L28) ios
+##### [find_exact](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/ios/element/generic.rb#L28) ios
> def find_exact(value)
Find the first element exactly matching value
@@ -2509,11 +2501,11 @@
[Element]
--
-##### [finds_exact](https://github.com/appium/ruby_lib/blob/ba2fbdcb206609259134fc09eac7940c21cc2c13/lib/appium_lib/ios/element/generic.rb#L39) ios
+##### [finds_exact](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/ios/element/generic.rb#L39) ios
> def finds_exact(value)
Find all elements exactly matching value
@@ -2525,67 +2517,67 @@
[Array<Element>]
--
-##### [_raise_error_if_no_element](https://github.com/appium/ruby_lib/blob/ba2fbdcb206609259134fc09eac7940c21cc2c13/lib/appium_lib/ios/element/generic.rb#L49) ios
+##### [_raise_error_if_no_element](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/ios/element/generic.rb#L49) ios
> def _raise_error_if_no_element(element)
--
-##### [_elements_include](https://github.com/appium/ruby_lib/blob/ba2fbdcb206609259134fc09eac7940c21cc2c13/lib/appium_lib/ios/element/generic.rb#L54) ios
+##### [_elements_include](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/ios/element/generic.rb#L54) ios
> def _elements_include(elements, value)
--
-##### [_elements_exact](https://github.com/appium/ruby_lib/blob/ba2fbdcb206609259134fc09eac7940c21cc2c13/lib/appium_lib/ios/element/generic.rb#L62) ios
+##### [_elements_exact](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/ios/element/generic.rb#L62) ios
> def _elements_exact(elements, value)
--
-##### [UIATextField](https://github.com/appium/ruby_lib/blob/ba2fbdcb206609259134fc09eac7940c21cc2c13/lib/appium_lib/ios/element/textfield.rb#L3) ios
+##### [UIATextField](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/ios/element/textfield.rb#L3) ios
> UIATextField = 'UIATextField'.freeze
--
-##### [UIASecureTextField](https://github.com/appium/ruby_lib/blob/ba2fbdcb206609259134fc09eac7940c21cc2c13/lib/appium_lib/ios/element/textfield.rb#L4) ios
+##### [UIASecureTextField](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/ios/element/textfield.rb#L4) ios
> UIASecureTextField = 'UIASecureTextField'.freeze
--
-##### [XCUIElementTypeTextField](https://github.com/appium/ruby_lib/blob/ba2fbdcb206609259134fc09eac7940c21cc2c13/lib/appium_lib/ios/element/textfield.rb#L6) ios
+##### [XCUIElementTypeTextField](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/ios/element/textfield.rb#L6) ios
> XCUIElementTypeTextField = 'XCUIElementTypeTextField'.freeze
--
-##### [XCUIElementTypeSecureTextField](https://github.com/appium/ruby_lib/blob/ba2fbdcb206609259134fc09eac7940c21cc2c13/lib/appium_lib/ios/element/textfield.rb#L7) ios
+##### [XCUIElementTypeSecureTextField](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/ios/element/textfield.rb#L7) ios
> XCUIElementTypeSecureTextField = 'XCUIElementTypeSecureTextField'.freeze
--
-##### [text_field_class](https://github.com/appium/ruby_lib/blob/ba2fbdcb206609259134fc09eac7940c21cc2c13/lib/appium_lib/ios/element/textfield.rb#L10) ios
+##### [text_field_class](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/ios/element/textfield.rb#L10) ios
> def text_field_class
@@ -2593,11 +2585,11 @@
[String] Class name for text field
--
-##### [secure_text_field_class](https://github.com/appium/ruby_lib/blob/ba2fbdcb206609259134fc09eac7940c21cc2c13/lib/appium_lib/ios/element/textfield.rb#L15) ios
+##### [secure_text_field_class](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/ios/element/textfield.rb#L15) ios
> def secure_text_field_class
@@ -2605,35 +2597,35 @@
[String] Class name for secure text field
--
-##### [_textfield_visible](https://github.com/appium/ruby_lib/blob/ba2fbdcb206609259134fc09eac7940c21cc2c13/lib/appium_lib/ios/element/textfield.rb#L40) ios
+##### [_textfield_visible](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/ios/element/textfield.rb#L40) ios
> def _textfield_visible
Appium
--
-##### [_textfield_exact_string](https://github.com/appium/ruby_lib/blob/ba2fbdcb206609259134fc09eac7940c21cc2c13/lib/appium_lib/ios/element/textfield.rb#L45) ios
+##### [_textfield_exact_string](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/ios/element/textfield.rb#L45) ios
> def _textfield_exact_string(value)
Appium
--
-##### [_textfield_contains_string](https://github.com/appium/ruby_lib/blob/ba2fbdcb206609259134fc09eac7940c21cc2c13/lib/appium_lib/ios/element/textfield.rb#L52) ios
+##### [_textfield_contains_string](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/ios/element/textfield.rb#L52) ios
> def _textfield_contains_string(value)
Appium
--
-##### [textfield](https://github.com/appium/ruby_lib/blob/ba2fbdcb206609259134fc09eac7940c21cc2c13/lib/appium_lib/ios/element/textfield.rb#L65) ios
+##### [textfield](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/ios/element/textfield.rb#L65) ios
> def textfield(value)
Find the first TextField that contains value or by index.
Note: Uses XPath
@@ -2647,11 +2639,11 @@
[TextField]
--
-##### [textfields](https://github.com/appium/ruby_lib/blob/ba2fbdcb206609259134fc09eac7940c21cc2c13/lib/appium_lib/ios/element/textfield.rb#L91) ios
+##### [textfields](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/ios/element/textfield.rb#L91) ios
> def textfields(value = false)
Find all TextFields containing value.
If value is omitted, all TextFields are returned.
@@ -2664,11 +2656,11 @@
[Array<TextField>]
--
-##### [first_textfield](https://github.com/appium/ruby_lib/blob/ba2fbdcb206609259134fc09eac7940c21cc2c13/lib/appium_lib/ios/element/textfield.rb#L103) ios
+##### [first_textfield](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/ios/element/textfield.rb#L103) ios
> def first_textfield
Find the first TextField.
@@ -2676,11 +2668,11 @@
[TextField]
--
-##### [last_textfield](https://github.com/appium/ruby_lib/blob/ba2fbdcb206609259134fc09eac7940c21cc2c13/lib/appium_lib/ios/element/textfield.rb#L113) ios
+##### [last_textfield](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/ios/element/textfield.rb#L113) ios
> def last_textfield
Find the last TextField.
@@ -2688,11 +2680,11 @@
[TextField]
--
-##### [textfield_exact](https://github.com/appium/ruby_lib/blob/ba2fbdcb206609259134fc09eac7940c21cc2c13/lib/appium_lib/ios/element/textfield.rb#L126) ios
+##### [textfield_exact](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/ios/element/textfield.rb#L126) ios
> def textfield_exact(value)
Find the first TextField that exactly matches value.
@@ -2704,11 +2696,11 @@
[TextField]
--
-##### [textfields_exact](https://github.com/appium/ruby_lib/blob/ba2fbdcb206609259134fc09eac7940c21cc2c13/lib/appium_lib/ios/element/textfield.rb#L137) ios
+##### [textfields_exact](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/ios/element/textfield.rb#L137) ios
> def textfields_exact(value)
Find all TextFields that exactly match value.
@@ -2720,31 +2712,31 @@
[Array<TextField>]
--
-##### [value](https://github.com/appium/ruby_lib/blob/ba2fbdcb206609259134fc09eac7940c21cc2c13/lib/appium_lib/common/patch.rb#L12)
+##### [value](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/common/patch.rb#L12)
> def value
Returns the value attribute
Fixes NoMethodError: undefined method `value' for Selenium::WebDriver::Element
--
-##### [name](https://github.com/appium/ruby_lib/blob/ba2fbdcb206609259134fc09eac7940c21cc2c13/lib/appium_lib/common/patch.rb#L19)
+##### [name](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/common/patch.rb#L19)
> def name
Returns the name attribute
Fixes NoMethodError: undefined method `name' for Selenium::WebDriver::Element
--
-##### [location_rel](https://github.com/appium/ruby_lib/blob/ba2fbdcb206609259134fc09eac7940c21cc2c13/lib/appium_lib/common/patch.rb#L31)
+##### [location_rel](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/common/patch.rb#L31)
> def location_rel
For use with mobile tap.
@@ -2758,18 +2750,18 @@
[OpenStruct] the relative x, y in a struct. ex: { x: 0.50, y: 0.20 }
--
-##### [DEFAULT_HEADERS](https://github.com/appium/ruby_lib/blob/ba2fbdcb206609259134fc09eac7940c21cc2c13/lib/appium_lib/common/patch.rb#L152)
+##### [DEFAULT_HEADERS](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/common/patch.rb#L152)
> DEFAULT_HEADERS = { 'Accept' => CONTENT_TYPE, 'User-Agent' => "appium/ruby_lib/#{::Appium::VERSION}" }.freeze
--
-##### [patch_remote_driver_commands](https://github.com/appium/ruby_lib/blob/ba2fbdcb206609259134fc09eac7940c21cc2c13/lib/appium_lib/common/patch.rb#L155)
+##### [patch_remote_driver_commands](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/common/patch.rb#L155)
> def patch_remote_driver_commands