docs/ios_docs.md in appium_lib-9.2.0 vs docs/ios_docs.md in appium_lib-9.3.0
- old
+ new
@@ -1,6 +1,6 @@
-##### [load_settings](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/driver.rb#L74)
+##### [load_settings](https://github.com/appium/ruby_lib/blob/94f3348a8fbec111a7a958063d3a2e643051b2e9/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/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/driver.rb#L110)
+##### [load_appium_txt](https://github.com/appium/ruby_lib/blob/94f3348a8fbec111a7a958063d3a2e643051b2e9/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/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/driver.rb#L116)
+##### [expand_required_files](https://github.com/appium/ruby_lib/blob/94f3348a8fbec111a7a958063d3a2e643051b2e9/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/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/driver.rb#L148)
+##### [symbolize_keys](https://github.com/appium/ruby_lib/blob/94f3348a8fbec111a7a958063d3a2e643051b2e9/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/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/driver.rb#L169)
+##### [promote_singleton_appium_methods](https://github.com/appium/ruby_lib/blob/94f3348a8fbec111a7a958063d3a2e643051b2e9/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/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/driver.rb#L222)
+##### [promote_appium_methods](https://github.com/appium/ruby_lib/blob/94f3348a8fbec111a7a958063d3a2e643051b2e9/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/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/driver.rb#L254)
+##### [init_caps_for_appium](https://github.com/appium/ruby_lib/blob/94f3348a8fbec111a7a958063d3a2e643051b2e9/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/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/driver.rb#L272)
+##### [global_webdriver_http_sleep](https://github.com/appium/ruby_lib/blob/94f3348a8fbec111a7a958063d3a2e643051b2e9/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/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/driver.rb#L272)
+##### [global_webdriver_http_sleep=](https://github.com/appium/ruby_lib/blob/94f3348a8fbec111a7a958063d3a2e643051b2e9/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/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/driver.rb#L274)
+##### [caps](https://github.com/appium/ruby_lib/blob/94f3348a8fbec111a7a958063d3a2e643051b2e9/lib/appium_lib/driver.rb#L274)
> def caps
Selenium webdriver capabilities
--
-##### [caps=](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/driver.rb#L274)
+##### [caps=](https://github.com/appium/ruby_lib/blob/94f3348a8fbec111a7a958063d3a2e643051b2e9/lib/appium_lib/driver.rb#L274)
> def caps=(value)
Selenium webdriver capabilities
--
-##### [custom_url](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/driver.rb#L276)
+##### [custom_url](https://github.com/appium/ruby_lib/blob/94f3348a8fbec111a7a958063d3a2e643051b2e9/lib/appium_lib/driver.rb#L276)
> def custom_url
Custom URL for the selenium server
--
-##### [custom_url=](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/driver.rb#L276)
+##### [custom_url=](https://github.com/appium/ruby_lib/blob/94f3348a8fbec111a7a958063d3a2e643051b2e9/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/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/driver.rb#L278)
+##### [export_session](https://github.com/appium/ruby_lib/blob/94f3348a8fbec111a7a958063d3a2e643051b2e9/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/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/driver.rb#L278)
+##### [export_session=](https://github.com/appium/ruby_lib/blob/94f3348a8fbec111a7a958063d3a2e643051b2e9/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/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/driver.rb#L283)
+##### [default_wait](https://github.com/appium/ruby_lib/blob/94f3348a8fbec111a7a958063d3a2e643051b2e9/lib/appium_lib/driver.rb#L283)
> def default_wait
Default wait time for elements to appear
Returns the default client side wait.
@@ -218,84 +218,84 @@
[Integer]
--
-##### [sauce_username](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/driver.rb#L285)
+##### [sauce_username](https://github.com/appium/ruby_lib/blob/94f3348a8fbec111a7a958063d3a2e643051b2e9/lib/appium_lib/driver.rb#L285)
> def sauce_username
Username for use on Sauce Labs
--
-##### [sauce_username=](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/driver.rb#L285)
+##### [sauce_username=](https://github.com/appium/ruby_lib/blob/94f3348a8fbec111a7a958063d3a2e643051b2e9/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/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/driver.rb#L287)
+##### [sauce_access_key](https://github.com/appium/ruby_lib/blob/94f3348a8fbec111a7a958063d3a2e643051b2e9/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/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/driver.rb#L287)
+##### [sauce_access_key=](https://github.com/appium/ruby_lib/blob/94f3348a8fbec111a7a958063d3a2e643051b2e9/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/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/driver.rb#L289)
+##### [appium_port](https://github.com/appium/ruby_lib/blob/94f3348a8fbec111a7a958063d3a2e643051b2e9/lib/appium_lib/driver.rb#L289)
> def appium_port
Appium's server port
--
-##### [appium_port=](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/driver.rb#L289)
+##### [appium_port=](https://github.com/appium/ruby_lib/blob/94f3348a8fbec111a7a958063d3a2e643051b2e9/lib/appium_lib/driver.rb#L289)
> def appium_port=(value)
Appium's server port
--
-##### [appium_device](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/driver.rb#L291)
+##### [appium_device](https://github.com/appium/ruby_lib/blob/94f3348a8fbec111a7a958063d3a2e643051b2e9/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/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/driver.rb#L291)
+##### [appium_device=](https://github.com/appium/ruby_lib/blob/94f3348a8fbec111a7a958063d3a2e643051b2e9/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/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/driver.rb#L294)
+##### [automation_name](https://github.com/appium/ruby_lib/blob/94f3348a8fbec111a7a958063d3a2e643051b2e9/lib/appium_lib/driver.rb#L294)
> def automation_name
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/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/driver.rb#L296)
+##### [appium_server_version](https://github.com/appium/ruby_lib/blob/94f3348a8fbec111a7a958063d3a2e643051b2e9/lib/appium_lib/driver.rb#L296)
> def appium_server_version
Returns the server's version info
@@ -312,43 +312,43 @@
[Hash]
--
-##### [appium_debug](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/driver.rb#L298)
+##### [appium_debug](https://github.com/appium/ruby_lib/blob/94f3348a8fbec111a7a958063d3a2e643051b2e9/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/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/driver.rb#L298)
+##### [appium_debug=](https://github.com/appium/ruby_lib/blob/94f3348a8fbec111a7a958063d3a2e643051b2e9/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/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/driver.rb#L300)
+##### [listener](https://github.com/appium/ruby_lib/blob/94f3348a8fbec111a7a958063d3a2e643051b2e9/lib/appium_lib/driver.rb#L300)
> def listener
instance of AbstractEventListener for logging support
--
-##### [listener=](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/driver.rb#L300)
+##### [listener=](https://github.com/appium/ruby_lib/blob/94f3348a8fbec111a7a958063d3a2e643051b2e9/lib/appium_lib/driver.rb#L300)
> def listener=(value)
instance of AbstractEventListener for logging support
--
-##### [driver](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/driver.rb#L303)
+##### [driver](https://github.com/appium/ruby_lib/blob/94f3348a8fbec111a7a958063d3a2e643051b2e9/lib/appium_lib/driver.rb#L303)
> def driver
Returns the driver
@@ -356,11 +356,11 @@
[Driver] the driver
--
-##### [http_client](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/driver.rb#L306)
+##### [http_client](https://github.com/appium/ruby_lib/blob/94f3348a8fbec111a7a958063d3a2e643051b2e9/lib/appium_lib/driver.rb#L306)
> def http_client
Return http client called in start_driver()
@@ -368,50 +368,63 @@
[Selenium::WebDriver::Remote::Http::Default] the http client
--
-##### [initialize](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/driver.rb#L327)
+##### [appium_wait_timeout](https://github.com/appium/ruby_lib/blob/94f3348a8fbec111a7a958063d3a2e643051b2e9/lib/appium_lib/driver.rb#L311)
-> def initialize(opts = {})
+> def appium_wait_timeout
-Creates a new driver
+Return a time wait timeout
+Wait time for ::Appium::Common.wait or ::Appium::Common.wait_true.
+Provide Appium::Drive like { appium_lib: { wait_timeout: 20 } }
-```ruby
-require 'rubygems'
-require 'appium_lib'
+__Returns:__
-# platformName takes a string or a symbol.
+ [Integer]
-# Start iOS driver
-opts = { caps: { platformName: :ios, app: '/path/to/MyiOS.app' } }
-Appium::Driver.new(opts).start_driver
+--
-# Start Android driver
-opts = { caps: { platformName: :android, app: '/path/to/my.apk' } }
-Appium::Driver.new(opts).start_driver
-```
+##### [appium_wait_interval](https://github.com/appium/ruby_lib/blob/94f3348a8fbec111a7a958063d3a2e643051b2e9/lib/appium_lib/driver.rb#L316)
+> def appium_wait_interval
+
+Return a time wait timeout
+Wait interval time for ::Appium::Common.wait or ::Appium::Common.wait_true.
+Provide Appium::Drive like { appium_lib: { wait_interval: 20 } }
+
+__Returns:__
+
+ [Integer]
+
+--
+
+##### [initialize](https://github.com/appium/ruby_lib/blob/94f3348a8fbec111a7a958063d3a2e643051b2e9/lib/appium_lib/driver.rb#L356)
+
+> def initialize(opts = {})
+
+Creates a new driver
+
__Parameters:__
[Object] opts - A hash containing various options.
__Returns:__
[Driver]
--
-##### [driver_attributes](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/driver.rb#L399)
+##### [driver_attributes](https://github.com/appium/ruby_lib/blob/94f3348a8fbec111a7a958063d3a2e643051b2e9/lib/appium_lib/driver.rb#L431)
> def driver_attributes
Returns a hash of the driver attributes
--
-##### [device_is_android?](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/driver.rb#L421)
+##### [device_is_android?](https://github.com/appium/ruby_lib/blob/94f3348a8fbec111a7a958063d3a2e643051b2e9/lib/appium_lib/driver.rb#L455)
> def device_is_android?
@@ -419,11 +432,11 @@
[Boolean]
--
-##### [automation_name_is_xcuitest?](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/driver.rb#L427)
+##### [automation_name_is_xcuitest?](https://github.com/appium/ruby_lib/blob/94f3348a8fbec111a7a958063d3a2e643051b2e9/lib/appium_lib/driver.rb#L461)
> def automation_name_is_xcuitest?
Return true if automationName is 'XCUITest'
@@ -431,11 +444,11 @@
[Boolean]
--
-##### [check_server_version_xcuitest](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/driver.rb#L434)
+##### [check_server_version_xcuitest](https://github.com/appium/ruby_lib/blob/94f3348a8fbec111a7a958063d3a2e643051b2e9/lib/appium_lib/driver.rb#L468)
> 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.
@@ -444,11 +457,11 @@
[Boolean]
--
-##### [appium_client_version](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/driver.rb#L466)
+##### [appium_client_version](https://github.com/appium/ruby_lib/blob/94f3348a8fbec111a7a958063d3a2e643051b2e9/lib/appium_lib/driver.rb#L500)
> def appium_client_version
Returns the client's version info
@@ -462,11 +475,11 @@
[Hash]
--
-##### [absolute_app_path](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/driver.rb#L478)
+##### [absolute_app_path](https://github.com/appium/ruby_lib/blob/94f3348a8fbec111a7a958063d3a2e643051b2e9/lib/appium_lib/driver.rb#L512)
> def self.absolute_app_path(opts)
Converts app_path to an absolute path.
@@ -479,11 +492,11 @@
[String] APP_PATH as an absolute path
--
-##### [server_url](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/driver.rb#L511)
+##### [server_url](https://github.com/appium/ruby_lib/blob/94f3348a8fbec111a7a958063d3a2e643051b2e9/lib/appium_lib/driver.rb#L545)
> def server_url
Get the server url
@@ -491,11 +504,11 @@
[String] the server url
--
-##### [restart](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/driver.rb#L522)
+##### [restart](https://github.com/appium/ruby_lib/blob/94f3348a8fbec111a7a958063d3a2e643051b2e9/lib/appium_lib/driver.rb#L556)
> def restart
Restarts the driver
@@ -503,11 +516,11 @@
[Driver] the driver
--
-##### [screenshot](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/driver.rb#L533)
+##### [screenshot](https://github.com/appium/ruby_lib/blob/94f3348a8fbec111a7a958063d3a2e643051b2e9/lib/appium_lib/driver.rb#L567)
> def screenshot(png_save_path)
Takes a png screenshot and saves to the target path.
@@ -521,11 +534,11 @@
[nil]
--
-##### [driver_quit](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/driver.rb#L540)
+##### [driver_quit](https://github.com/appium/ruby_lib/blob/94f3348a8fbec111a7a958063d3a2e643051b2e9/lib/appium_lib/driver.rb#L574)
> def driver_quit
Quits the driver
@@ -533,11 +546,11 @@
[void]
--
-##### [start_driver](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/driver.rb#L550)
+##### [start_driver](https://github.com/appium/ruby_lib/blob/94f3348a8fbec111a7a958063d3a2e643051b2e9/lib/appium_lib/driver.rb#L584)
> def start_driver
Creates a new global driver and quits the old one if it exists.
@@ -545,19 +558,19 @@
[Selenium::WebDriver] the new global driver
--
-##### [no_wait](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/driver.rb#L588)
+##### [no_wait](https://github.com/appium/ruby_lib/blob/94f3348a8fbec111a7a958063d3a2e643051b2e9/lib/appium_lib/driver.rb#L622)
> def no_wait
Set implicit wait to zero.
--
-##### [set_wait](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/driver.rb#L602)
+##### [set_wait](https://github.com/appium/ruby_lib/blob/94f3348a8fbec111a7a958063d3a2e643051b2e9/lib/appium_lib/driver.rb#L636)
> def set_wait(timeout = nil)
Set implicit wait. Default to @default_wait.
@@ -575,11 +588,11 @@
[void]
--
-##### [exists](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/driver.rb#L619)
+##### [exists](https://github.com/appium/ruby_lib/blob/94f3348a8fbec111a7a958063d3a2e643051b2e9/lib/appium_lib/driver.rb#L653)
> def exists(pre_check = 0, post_check = @default_wait)
Returns existence of element.
@@ -587,75 +600,73 @@
exists { button('sign in') } ? puts('true') : puts('false')
__Parameters:__
- [Integer] pre_check - the amount in seconds to set the
-wait to before checking existance
+ [Integer] pre_check - The amount in seconds to set the
+wait to before checking existence
- [Integer] post_check - the amount in seconds to set the
-wait to after checking existance
+ [Integer] post_check - The amount in seconds to set the
+wait to after checking existence
- [Block] search_block - the block to call
-
__Returns:__
[Boolean]
--
-##### [execute_script](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/driver.rb#L643)
+##### [execute_script](https://github.com/appium/ruby_lib/blob/94f3348a8fbec111a7a958063d3a2e643051b2e9/lib/appium_lib/driver.rb#L677)
> def execute_script(script, *args)
The same as @driver.execute_script
__Parameters:__
- [String] script - the script to execute
+ [String] script - The script to execute
- [*args] args - the args to pass to the script
+ [*args] args - The args to pass to the script
__Returns:__
[Object]
--
-##### [find_elements](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/driver.rb#L651)
+##### [find_elements](https://github.com/appium/ruby_lib/blob/94f3348a8fbec111a7a958063d3a2e643051b2e9/lib/appium_lib/driver.rb#L685)
> def find_elements(*args)
Calls @driver.find_elements
__Parameters:__
- [*args] args - the args to use
+ [*args] args - The args to use
__Returns:__
[Array<Element>] Array is empty when no elements are found.
--
-##### [find_element](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/driver.rb#L659)
+##### [find_element](https://github.com/appium/ruby_lib/blob/94f3348a8fbec111a7a958063d3a2e643051b2e9/lib/appium_lib/driver.rb#L693)
> def find_element(*args)
Calls @driver.find_elements
__Parameters:__
- [*args] args - the args to use
+ [*args] args - The args to use
__Returns:__
[Element]
--
-##### [set_location](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/driver.rb#L672)
+##### [set_location](https://github.com/appium/ruby_lib/blob/94f3348a8fbec111a7a958063d3a2e643051b2e9/lib/appium_lib/driver.rb#L706)
> def set_location(opts = {})
Calls @driver.set_location
@@ -667,11 +678,11 @@
[Selenium::WebDriver::Location] the location constructed by the selenium webdriver
--
-##### [x](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/driver.rb#L682)
+##### [x](https://github.com/appium/ruby_lib/blob/94f3348a8fbec111a7a958063d3a2e643051b2e9/lib/appium_lib/driver.rb#L716)
> def x
Quit the driver and Pry.
quit and exit are reserved by Pry.
@@ -680,20 +691,20 @@
[void]
--
-##### [set_automation_name_if_nil](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/driver.rb#L691)
+##### [set_automation_name_if_nil](https://github.com/appium/ruby_lib/blob/94f3348a8fbec111a7a958063d3a2e643051b2e9/lib/appium_lib/driver.rb#L725)
> 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)
+##### [logger=](https://github.com/appium/ruby_lib/blob/94f3348a8fbec111a7a958063d3a2e643051b2e9/lib/appium_lib/logger.rb#L13)
> def logger=(value)
Sets the attribute logger
@@ -701,100 +712,100 @@
value - the value to set the attribute logger to.
--
-##### [logger](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/logger.rb#L17)
+##### [logger](https://github.com/appium/ruby_lib/blob/94f3348a8fbec111a7a958063d3a2e643051b2e9/lib/appium_lib/logger.rb#L17)
> def logger
--
-##### [app_strings](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/device/device.rb#L7)
+##### [app_strings](https://github.com/appium/ruby_lib/blob/94f3348a8fbec111a7a958063d3a2e643051b2e9/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/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/device/device.rb#L13)
+##### [background_app](https://github.com/appium/ruby_lib/blob/94f3348a8fbec111a7a958063d3a2e643051b2e9/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/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/device/device.rb#L18)
+##### [current_activity](https://github.com/appium/ruby_lib/blob/94f3348a8fbec111a7a958063d3a2e643051b2e9/lib/appium_lib/device/device.rb#L18)
> def current_activity
--
-##### [launch_app](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/device/device.rb#L20)
+##### [launch_app](https://github.com/appium/ruby_lib/blob/94f3348a8fbec111a7a958063d3a2e643051b2e9/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/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/device/device.rb#L23)
+##### [reset](https://github.com/appium/ruby_lib/blob/94f3348a8fbec111a7a958063d3a2e643051b2e9/lib/appium_lib/device/device.rb#L23)
> def reset
Reset the device, relaunching the application.
--
-##### [shake](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/device/device.rb#L26)
+##### [shake](https://github.com/appium/ruby_lib/blob/94f3348a8fbec111a7a958063d3a2e643051b2e9/lib/appium_lib/device/device.rb#L26)
> def shake
Cause the device to shake
--
-##### [toggle_flight_mode](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/device/device.rb#L29)
+##### [toggle_flight_mode](https://github.com/appium/ruby_lib/blob/94f3348a8fbec111a7a958063d3a2e643051b2e9/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/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/device/device.rb#L32)
+##### [device_locked?](https://github.com/appium/ruby_lib/blob/94f3348a8fbec111a7a958063d3a2e643051b2e9/lib/appium_lib/device/device.rb#L32)
> def device_locked?
--
-##### [hide_keyboard](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/device/device.rb#L34)
+##### [hide_keyboard](https://github.com/appium/ruby_lib/blob/94f3348a8fbec111a7a958063d3a2e643051b2e9/lib/appium_lib/device/device.rb#L34)
> def hide_keyboard
Hide the onscreen keyboard
__Parameters:__
- [String] close_key - the name of the key which closes the keyboard.
+ [String] close_key - The name of the key which closes the keyboard.
Defaults to 'Done'.
--
-##### [press_keycode](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/device/device.rb#L43)
+##### [press_keycode](https://github.com/appium/ruby_lib/blob/94f3348a8fbec111a7a958063d3a2e643051b2e9/lib/appium_lib/device/device.rb#L43)
> def press_keycode
Press keycode on the device.
http://developer.android.com/reference/android/view/KeyEvent.html
@@ -805,11 +816,11 @@
[String] metastate - The state the metakeys should be in when pressing the key.
--
-##### [long_press_keycode](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/device/device.rb#L49)
+##### [long_press_keycode](https://github.com/appium/ruby_lib/blob/94f3348a8fbec111a7a958063d3a2e643051b2e9/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
@@ -820,11 +831,11 @@
[String] metastate - The state the metakeys should be in when long pressing the key.
--
-##### [push_file](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/device/device.rb#L55)
+##### [push_file](https://github.com/appium/ruby_lib/blob/94f3348a8fbec111a7a958063d3a2e643051b2e9/lib/appium_lib/device/device.rb#L55)
> def push_file
Place a file in a specific location on the device.
@@ -834,11 +845,11 @@
[String] data - Raw file data to be sent to the device.
--
-##### [pull_file](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/device/device.rb#L60)
+##### [pull_file](https://github.com/appium/ruby_lib/blob/94f3348a8fbec111a7a958063d3a2e643051b2e9/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).
@@ -851,11 +862,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/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/device/device.rb#L70)
+##### [pull_folder](https://github.com/appium/ruby_lib/blob/94f3348a8fbec111a7a958063d3a2e643051b2e9/lib/appium_lib/device/device.rb#L70)
> def pull_folder
Retrieve a folder from the device.
```ruby
@@ -866,11 +877,11 @@
[String] path - absolute path to the folder
--
-##### [touch_id](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/device/device.rb#L78)
+##### [touch_id](https://github.com/appium/ruby_lib/blob/94f3348a8fbec111a7a958063d3a2e643051b2e9/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
@@ -883,11 +894,11 @@
[Boolean] match - fingerprint validity
Defaults to true.
--
-##### [end_coverage](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/device/device.rb#L87)
+##### [end_coverage](https://github.com/appium/ruby_lib/blob/94f3348a8fbec111a7a958063d3a2e643051b2e9/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.
@@ -897,35 +908,89 @@
[String] intent - Intent to broadcast when ending coverage.
--
-##### [get_settings](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/device/device.rb#L92)
+##### [get_settings](https://github.com/appium/ruby_lib/blob/94f3348a8fbec111a7a958063d3a2e643051b2e9/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/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/device/device.rb#L356)
+##### [update_settings](https://github.com/appium/ruby_lib/blob/94f3348a8fbec111a7a958063d3a2e643051b2e9/lib/appium_lib/device/device.rb#L95)
+> def update_settings
+
+Update appium Settings for current test session
+
+__Parameters:__
+
+ [Hash] settings - Settings to update, keys are settings, values to value to set each setting to
+
+--
+
+##### [start_activity](https://github.com/appium/ruby_lib/blob/94f3348a8fbec111a7a958063d3a2e643051b2e9/lib/appium_lib/device/device.rb#L99)
+
+> def start_activity
+
+Start a new activity within the current app or launch a new app and start the target activity.
+
+Android only.
+```ruby
+start_activity app_package: 'io.appium.android.apis',
+ app_activity: '.accessibility.AccessibilityNodeProviderActivity'
+```
+
+--
+
+##### [get_network_connection](https://github.com/appium/ruby_lib/blob/94f3348a8fbec111a7a958063d3a2e643051b2e9/lib/appium_lib/device/device.rb#L113)
+
+> def get_network_connection
+
+Get the device network connection current status
+See set_network_connection method for return value
+
+--
+
+##### [set_network_connection](https://github.com/appium/ruby_lib/blob/94f3348a8fbec111a7a958063d3a2e643051b2e9/lib/appium_lib/device/device.rb#L117)
+
+> def set_network_connection
+
+Set the device network connection mode
+Value (Alias) | Data | Wifi | Airplane Mode
+-------------------------------------------------
+1 (Airplane Mode) | 0 | 0 | 1
+6 (All network on) | 1 | 1 | 0
+4 (Data only) | 1 | 0 | 0
+2 (Wifi only) | 0 | 1 | 0
+0 (None) | 0 | 0 | 0
+
+__Parameters:__
+
+ [String] path - Bit mask that represent the network mode
+
+--
+
+##### [extend_search_contexts](https://github.com/appium/ruby_lib/blob/94f3348a8fbec111a7a958063d3a2e643051b2e9/lib/appium_lib/device/device.rb#L360)
+
> def extend_search_contexts
--
-##### [find_element](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/device/device.rb#L356)
+##### [find_element](https://github.com/appium/ruby_lib/blob/94f3348a8fbec111a7a958063d3a2e643051b2e9/lib/appium_lib/device/device.rb#L360)
> def find_element
--
-##### [find_elements](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/device/device.rb#L356)
+##### [find_elements](https://github.com/appium/ruby_lib/blob/94f3348a8fbec111a7a958063d3a2e643051b2e9/lib/appium_lib/device/device.rb#L360)
> def find_elements
find_element/s with their accessibility_id
@@ -933,27 +998,27 @@
find_elements :accessibility_id, 'Animation'
```
--
-##### [add_touch_actions](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/device/device.rb#L387)
+##### [add_touch_actions](https://github.com/appium/ruby_lib/blob/94f3348a8fbec111a7a958063d3a2e643051b2e9/lib/appium_lib/device/device.rb#L391)
> def add_touch_actions
--
-##### [add_ime_actions](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/device/device.rb#L410)
+##### [add_ime_actions](https://github.com/appium/ruby_lib/blob/94f3348a8fbec111a7a958063d3a2e643051b2e9/lib/appium_lib/device/device.rb#L414)
> def add_ime_actions
--
-##### [set_context](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/device/device.rb#L485)
+##### [set_context](https://github.com/appium/ruby_lib/blob/94f3348a8fbec111a7a958063d3a2e643051b2e9/lib/appium_lib/device/device.rb#L489)
> def set_context
Change the context to the given context.
```ruby
@@ -964,11 +1029,11 @@
[String] The - context to change to
--
-##### [current_context](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/device/device.rb#L493)
+##### [current_context](https://github.com/appium/ruby_lib/blob/94f3348a8fbec111a7a958063d3a2e643051b2e9/lib/appium_lib/device/device.rb#L497)
> def current_context
@@ -976,11 +1041,11 @@
[String] The context currently being used.
--
-##### [available_contexts](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/device/device.rb#L496)
+##### [available_contexts](https://github.com/appium/ruby_lib/blob/94f3348a8fbec111a7a958063d3a2e643051b2e9/lib/appium_lib/device/device.rb#L500)
> def available_contexts
@@ -988,11 +1053,11 @@
[Array<String>] All usable contexts, as an array of strings.
--
-##### [within_context](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/device/device.rb#L506)
+##### [within_context](https://github.com/appium/ruby_lib/blob/94f3348a8fbec111a7a958063d3a2e643051b2e9/lib/appium_lib/device/device.rb#L510)
> def within_context(context)
Perform a block within the given context, then switch back to the starting context.
```ruby
@@ -1004,19 +1069,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/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/device/device.rb#L514)
+##### [switch_to_default_context](https://github.com/appium/ruby_lib/blob/94f3348a8fbec111a7a958063d3a2e643051b2e9/lib/appium_lib/device/device.rb#L518)
> 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/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/device/multi_touch.rb#L28)
+##### [pinch](https://github.com/appium/ruby_lib/blob/94f3348a8fbec111a7a958063d3a2e643051b2e9/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.
@@ -1031,11 +1096,11 @@
[boolean] auto_perform - Whether to perform the action immediately (default true)
--
-##### [zoom](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/device/multi_touch.rb#L64)
+##### [zoom](https://github.com/appium/ruby_lib/blob/94f3348a8fbec111a7a958063d3a2e643051b2e9/lib/appium_lib/device/multi_touch.rb#L57)
> 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.
@@ -1050,23 +1115,71 @@
[boolean] auto_perform - Whether to perform the action immediately (default true)
--
-##### [initialize](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/device/multi_touch.rb#L95)
+##### [pinch_for_xcuitest](https://github.com/appium/ruby_lib/blob/94f3348a8fbec111a7a958063d3a2e643051b2e9/lib/appium_lib/device/multi_touch.rb#L79)
+> def pinch_for_xcuitest(rate)
+
+
+
+--
+
+##### [pinch_android](https://github.com/appium/ruby_lib/blob/94f3348a8fbec111a7a958063d3a2e643051b2e9/lib/appium_lib/device/multi_touch.rb#L94)
+
+> def pinch_android(rate)
+
+
+
+--
+
+##### [pinch_ios](https://github.com/appium/ruby_lib/blob/94f3348a8fbec111a7a958063d3a2e643051b2e9/lib/appium_lib/device/multi_touch.rb#L108)
+
+> def pinch_ios(rate)
+
+
+
+--
+
+##### [zoom_for_xcuitest](https://github.com/appium/ruby_lib/blob/94f3348a8fbec111a7a958063d3a2e643051b2e9/lib/appium_lib/device/multi_touch.rb#L122)
+
+> def zoom_for_xcuitest(rate)
+
+
+
+--
+
+##### [zoom_android](https://github.com/appium/ruby_lib/blob/94f3348a8fbec111a7a958063d3a2e643051b2e9/lib/appium_lib/device/multi_touch.rb#L137)
+
+> def zoom_android(rate)
+
+
+
+--
+
+##### [zoom_ios](https://github.com/appium/ruby_lib/blob/94f3348a8fbec111a7a958063d3a2e643051b2e9/lib/appium_lib/device/multi_touch.rb#L151)
+
+> def zoom_ios(rate)
+
+
+
+--
+
+##### [initialize](https://github.com/appium/ruby_lib/blob/94f3348a8fbec111a7a958063d3a2e643051b2e9/lib/appium_lib/device/multi_touch.rb#L167)
+
> def initialize
Create a new multi-action
__Returns:__
[MultiTouch] a new instance of MultiTouch
--
-##### [add](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/device/multi_touch.rb#L101)
+##### [add](https://github.com/appium/ruby_lib/blob/94f3348a8fbec111a7a958063d3a2e643051b2e9/lib/appium_lib/device/multi_touch.rb#L173)
> def add(chain)
Add a touch_action to be performed
@@ -1074,43 +1187,43 @@
[TouchAction] chain - The action to add to the chain
--
-##### [perform](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/device/multi_touch.rb#L106)
+##### [perform](https://github.com/appium/ruby_lib/blob/94f3348a8fbec111a7a958063d3a2e643051b2e9/lib/appium_lib/device/multi_touch.rb#L178)
> def perform
Ask Appium to perform the actions
--
-##### [ACTIONS](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/device/touch_actions.rb#L11)
+##### [ACTIONS](https://github.com/appium/ruby_lib/blob/94f3348a8fbec111a7a958063d3a2e643051b2e9/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/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/device/touch_actions.rb#L12)
+##### [COMPLEX_ACTIONS](https://github.com/appium/ruby_lib/blob/94f3348a8fbec111a7a958063d3a2e643051b2e9/lib/appium_lib/device/touch_actions.rb#L12)
> COMPLEX_ACTIONS = [:swipe].freeze
--
-##### [actions](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/device/touch_actions.rb#L26)
+##### [actions](https://github.com/appium/ruby_lib/blob/94f3348a8fbec111a7a958063d3a2e643051b2e9/lib/appium_lib/device/touch_actions.rb#L26)
> def actions
Returns the value of attribute actions
--
-##### [initialize](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/device/touch_actions.rb#L28)
+##### [initialize](https://github.com/appium/ruby_lib/blob/94f3348a8fbec111a7a958063d3a2e643051b2e9/lib/appium_lib/device/touch_actions.rb#L28)
> def initialize
@@ -1118,23 +1231,25 @@
[TouchAction] a new instance of TouchAction
--
-##### [move_to](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/device/touch_actions.rb#L36)
+##### [move_to](https://github.com/appium/ruby_lib/blob/94f3348a8fbec111a7a958063d3a2e643051b2e9/lib/appium_lib/device/touch_actions.rb#L39)
> def move_to(opts)
Move to the given co-ordinates.
+`move_to`'s `x` and `y` have two case. One is working as coordinate, the other is working as offset.
+
__Parameters:__
[Hash] opts - a customizable set of options
--
-##### [long_press](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/device/touch_actions.rb#L50)
+##### [long_press](https://github.com/appium/ruby_lib/blob/94f3348a8fbec111a7a958063d3a2e643051b2e9/lib/appium_lib/device/touch_actions.rb#L53)
> 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.
@@ -1151,11 +1266,11 @@
[Hash] duration - a customizable set of options
--
-##### [press](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/device/touch_actions.rb#L62)
+##### [press](https://github.com/appium/ruby_lib/blob/94f3348a8fbec111a7a958063d3a2e643051b2e9/lib/appium_lib/device/touch_actions.rb#L65)
> def press(opts)
Press a finger onto the screen. Finger will stay down until you call
`release`.
@@ -1164,11 +1279,11 @@
[Hash] opts - a customizable set of options
--
-##### [release](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/device/touch_actions.rb#L73)
+##### [release](https://github.com/appium/ruby_lib/blob/94f3348a8fbec111a7a958063d3a2e643051b2e9/lib/appium_lib/device/touch_actions.rb#L76)
> def release(opts = nil)
Remove a finger from the screen.
@@ -1176,11 +1291,11 @@
[Hash] opts - a customizable set of options
--
-##### [tap](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/device/touch_actions.rb#L85)
+##### [tap](https://github.com/appium/ruby_lib/blob/94f3348a8fbec111a7a958063d3a2e643051b2e9/lib/appium_lib/device/touch_actions.rb#L88)
> def tap(opts)
Touch a point on the screen.
Alternatively, you can use `press(...).release.perform` instead of `tap(...).perform`.
@@ -1189,11 +1304,11 @@
[Hash] opts - a customizable set of options
--
-##### [double_tap](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/device/touch_actions.rb#L98)
+##### [double_tap](https://github.com/appium/ruby_lib/blob/94f3348a8fbec111a7a958063d3a2e643051b2e9/lib/appium_lib/device/touch_actions.rb#L101)
> def double_tap(opts)
Double tap an element on the screen
@@ -1201,11 +1316,11 @@
[Hash] opts - a customizable set of options
--
-##### [two_finger_tap](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/device/touch_actions.rb#L109)
+##### [two_finger_tap](https://github.com/appium/ruby_lib/blob/94f3348a8fbec111a7a958063d3a2e643051b2e9/lib/appium_lib/device/touch_actions.rb#L112)
> def two_finger_tap(opts)
Two finger tap an element on the screen
@@ -1213,11 +1328,11 @@
[Hash] opts - a customizable set of options
--
-##### [wait](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/device/touch_actions.rb#L117)
+##### [wait](https://github.com/appium/ruby_lib/blob/94f3348a8fbec111a7a958063d3a2e643051b2e9/lib/appium_lib/device/touch_actions.rb#L120)
> def wait(milliseconds)
Pause for a number of milliseconds before the next action
@@ -1225,74 +1340,89 @@
[integer] milliseconds - Number of milliseconds to pause for
--
-##### [swipe](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/device/touch_actions.rb#L132)
+##### [swipe](https://github.com/appium/ruby_lib/blob/94f3348a8fbec111a7a958063d3a2e643051b2e9/lib/appium_lib/device/touch_actions.rb#L143)
> def swipe(opts, ele = nil)
Convenience method to peform a swipe.
Note that iOS 7 simulators have broken swipe.
+For iOS: Use `offset_x` and `offset_y` to define the end point.
+
+For Android: Use `end_x` and `end_y` to define the end point.
+
+If you'd like more details, please read tests and its log samples in
+`ios_tests/lib/ios/specs/device/touch_actions.rb` and `ios_tests/lib/ios/specs/device/touch_actions.rb`
+
__Parameters:__
[Hash] opts - a customizable set of options
--
-##### [perform](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/device/touch_actions.rb#L166)
+##### [perform](https://github.com/appium/ruby_lib/blob/94f3348a8fbec111a7a958063d3a2e643051b2e9/lib/appium_lib/device/touch_actions.rb#L168)
> def perform
Ask the driver to perform all actions in this action chain.
--
-##### [cancel](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/device/touch_actions.rb#L172)
+##### [cancel](https://github.com/appium/ruby_lib/blob/94f3348a8fbec111a7a958063d3a2e643051b2e9/lib/appium_lib/device/touch_actions.rb#L174)
> def cancel
Does nothing, currently.
--
-##### [chain_method](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/device/touch_actions.rb#L180)
+##### [swipe_coordinates](https://github.com/appium/ruby_lib/blob/94f3348a8fbec111a7a958063d3a2e643051b2e9/lib/appium_lib/device/touch_actions.rb#L180)
+> def swipe_coordinates(end_x: nil, end_y: nil, offset_x: nil, offset_y: nil)
+
+
+
+--
+
+##### [chain_method](https://github.com/appium/ruby_lib/blob/94f3348a8fbec111a7a958063d3a2e643051b2e9/lib/appium_lib/device/touch_actions.rb#L198)
+
> def chain_method(method, args = nil)
--
-##### [args_with_ele_ref](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/device/touch_actions.rb#L186)
+##### [args_with_ele_ref](https://github.com/appium/ruby_lib/blob/94f3348a8fbec111a7a958063d3a2e643051b2e9/lib/appium_lib/device/touch_actions.rb#L204)
> def args_with_ele_ref(args)
--
-##### [_generic_wait](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/common/wait.rb#L9)
+##### [_generic_wait](https://github.com/appium/ruby_lib/blob/94f3348a8fbec111a7a958063d3a2e643051b2e9/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/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/common/wait.rb#L48)
+##### [_process_wait_opts](https://github.com/appium/ruby_lib/blob/94f3348a8fbec111a7a958063d3a2e643051b2e9/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/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/common/wait.rb#L69)
+##### [wait_true](https://github.com/appium/ruby_lib/blob/94f3348a8fbec111a7a958063d3a2e643051b2e9/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.
@@ -1308,11 +1438,11 @@
[Hash] opts - Options
--
-##### [wait](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/common/wait.rb#L87)
+##### [wait](https://github.com/appium/ruby_lib/blob/94f3348a8fbec111a7a958063d3a2e643051b2e9/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.
@@ -1326,19 +1456,19 @@
[Hash] opts - Options
--
-##### [ignore](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/common/helper.rb#L24)
+##### [ignore](https://github.com/appium/ruby_lib/blob/94f3348a8fbec111a7a958063d3a2e643051b2e9/lib/appium_lib/common/helper.rb#L24)
> def ignore
Return yield and ignore any exceptions.
--
-##### [back](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/common/helper.rb#L31)
+##### [back](https://github.com/appium/ruby_lib/blob/94f3348a8fbec111a7a958063d3a2e643051b2e9/lib/appium_lib/common/helper.rb#L31)
> def back
Navigate back.
@@ -1346,19 +1476,19 @@
[void]
--
-##### [session_id](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/common/helper.rb#L36)
+##### [session_id](https://github.com/appium/ruby_lib/blob/94f3348a8fbec111a7a958063d3a2e643051b2e9/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/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/common/helper.rb#L44)
+##### [xpath](https://github.com/appium/ruby_lib/blob/94f3348a8fbec111a7a958063d3a2e643051b2e9/lib/appium_lib/common/helper.rb#L44)
> def xpath(xpath_str)
Returns the first element that matches the provided xpath.
@@ -1370,11 +1500,11 @@
[Element]
--
-##### [xpaths](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/common/helper.rb#L52)
+##### [xpaths](https://github.com/appium/ruby_lib/blob/94f3348a8fbec111a7a958063d3a2e643051b2e9/lib/appium_lib/common/helper.rb#L52)
> def xpaths(xpath_str)
Returns all elements that match the provided xpath.
@@ -1386,27 +1516,27 @@
[Array<Element>]
--
-##### [_print_source](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/common/helper.rb#L56)
+##### [_print_source](https://github.com/appium/ruby_lib/blob/94f3348a8fbec111a7a958063d3a2e643051b2e9/lib/appium_lib/common/helper.rb#L56)
> def _print_source(source)
--
-##### [result](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/common/helper.rb#L69)
+##### [result](https://github.com/appium/ruby_lib/blob/94f3348a8fbec111a7a958063d3a2e643051b2e9/lib/appium_lib/common/helper.rb#L69)
> def result
Returns the value of attribute result
--
-##### [initialize](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/common/helper.rb#L71)
+##### [initialize](https://github.com/appium/ruby_lib/blob/94f3348a8fbec111a7a958063d3a2e643051b2e9/lib/appium_lib/common/helper.rb#L71)
> def initialize
@@ -1414,52 +1544,52 @@
[CountElements] a new instance of CountElements
--
-##### [reset](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/common/helper.rb#L75)
+##### [reset](https://github.com/appium/ruby_lib/blob/94f3348a8fbec111a7a958063d3a2e643051b2e9/lib/appium_lib/common/helper.rb#L75)
> def reset
--
-##### [start_element](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/common/helper.rb#L80)
+##### [start_element](https://github.com/appium/ruby_lib/blob/94f3348a8fbec111a7a958063d3a2e643051b2e9/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/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/common/helper.rb#L86)
+##### [formatted_result](https://github.com/appium/ruby_lib/blob/94f3348a8fbec111a7a958063d3a2e643051b2e9/lib/appium_lib/common/helper.rb#L86)
> def formatted_result
--
-##### [get_page_class](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/common/helper.rb#L97)
+##### [get_page_class](https://github.com/appium/ruby_lib/blob/94f3348a8fbec111a7a958063d3a2e643051b2e9/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/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/common/helper.rb#L108)
+##### [page_class](https://github.com/appium/ruby_lib/blob/94f3348a8fbec111a7a958063d3a2e643051b2e9/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/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/common/helper.rb#L118)
+##### [px_to_window_rel](https://github.com/appium/ruby_lib/blob/94f3348a8fbec111a7a958063d3a2e643051b2e9/lib/appium_lib/common/helper.rb#L118)
> def px_to_window_rel(opts = {})
Converts pixel values to window relative values
@@ -1467,11 +1597,11 @@
px_to_window_rel x: 50, y: 150
```
--
-##### [xml_keys](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/common/helper.rb#L137)
+##### [xml_keys](https://github.com/appium/ruby_lib/blob/94f3348a8fbec111a7a958063d3a2e643051b2e9/lib/appium_lib/common/helper.rb#L137)
> def xml_keys(target)
Search strings.xml's values for target.
@@ -1483,11 +1613,11 @@
[Array]
--
-##### [xml_values](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/common/helper.rb#L145)
+##### [xml_values](https://github.com/appium/ruby_lib/blob/94f3348a8fbec111a7a958063d3a2e643051b2e9/lib/appium_lib/common/helper.rb#L145)
> def xml_values(target)
Search strings.xml's keys for target.
@@ -1499,11 +1629,11 @@
[Array]
--
-##### [resolve_id](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/common/helper.rb#L153)
+##### [resolve_id](https://github.com/appium/ruby_lib/blob/94f3348a8fbec111a7a958063d3a2e643051b2e9/lib/appium_lib/common/helper.rb#L153)
> def resolve_id(id)
Resolve id in strings.xml and return the value.
@@ -1515,27 +1645,27 @@
[String]
--
-##### [filter](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/common/helper.rb#L159)
+##### [filter](https://github.com/appium/ruby_lib/blob/94f3348a8fbec111a7a958063d3a2e643051b2e9/lib/appium_lib/common/helper.rb#L159)
> def filter
Returns the value of attribute filter
--
-##### [filter=](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/common/helper.rb#L162)
+##### [filter=](https://github.com/appium/ruby_lib/blob/94f3348a8fbec111a7a958063d3a2e643051b2e9/lib/appium_lib/common/helper.rb#L162)
> def filter=(value)
convert to string to support symbols
--
-##### [initialize](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/common/helper.rb#L168)
+##### [initialize](https://github.com/appium/ruby_lib/blob/94f3348a8fbec111a7a958063d3a2e643051b2e9/lib/appium_lib/common/helper.rb#L168)
> def initialize
@@ -1543,99 +1673,99 @@
[HTMLElements] a new instance of HTMLElements
--
-##### [reset](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/common/helper.rb#L173)
+##### [reset](https://github.com/appium/ruby_lib/blob/94f3348a8fbec111a7a958063d3a2e643051b2e9/lib/appium_lib/common/helper.rb#L173)
> def reset
--
-##### [result](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/common/helper.rb#L179)
+##### [result](https://github.com/appium/ruby_lib/blob/94f3348a8fbec111a7a958063d3a2e643051b2e9/lib/appium_lib/common/helper.rb#L179)
> def result
--
-##### [start_element](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/common/helper.rb#L195)
+##### [start_element](https://github.com/appium/ruby_lib/blob/94f3348a8fbec111a7a958063d3a2e643051b2e9/lib/appium_lib/common/helper.rb#L195)
> def start_element(name, attrs = [])
--
-##### [end_element](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/common/helper.rb#L204)
+##### [end_element](https://github.com/appium/ruby_lib/blob/94f3348a8fbec111a7a958063d3a2e643051b2e9/lib/appium_lib/common/helper.rb#L204)
> def end_element(name)
--
-##### [characters](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/common/helper.rb#L210)
+##### [characters](https://github.com/appium/ruby_lib/blob/94f3348a8fbec111a7a958063d3a2e643051b2e9/lib/appium_lib/common/helper.rb#L210)
> def characters(chars)
--
-##### [_no_such_element](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/common/helper.rb#L217)
+##### [_no_such_element](https://github.com/appium/ruby_lib/blob/94f3348a8fbec111a7a958063d3a2e643051b2e9/lib/appium_lib/common/helper.rb#L217)
> def _no_such_element
--
-##### [COMMAND_NO_ARG](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/common/command.rb#L4)
+##### [COMMAND_NO_ARG](https://github.com/appium/ruby_lib/blob/94f3348a8fbec111a7a958063d3a2e643051b2e9/lib/appium_lib/common/command.rb#L4)
> COMMAND_NO_ARG = {
--
-##### [COMMAND](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/common/command.rb#L23)
+##### [COMMAND](https://github.com/appium/ruby_lib/blob/94f3348a8fbec111a7a958063d3a2e643051b2e9/lib/appium_lib/common/command.rb#L23)
> COMMAND = {
--
-##### [window_size](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/common/element/window.rb#L5)
+##### [window_size](https://github.com/appium/ruby_lib/blob/94f3348a8fbec111a7a958063d3a2e643051b2e9/lib/appium_lib/common/element/window.rb#L5)
> def window_size
Get the window's size
--
-##### [FINDERS](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/common/search_context.rb#L5)
+##### [FINDERS](https://github.com/appium/ruby_lib/blob/94f3348a8fbec111a7a958063d3a2e643051b2e9/lib/appium_lib/common/search_context.rb#L5)
> FINDERS = {
rubocop:disable Style/MutableConstant
--
-##### [filter](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/ios/helper.rb#L4) ios
+##### [filter](https://github.com/appium/ruby_lib/blob/94f3348a8fbec111a7a958063d3a2e643051b2e9/lib/appium_lib/ios/helper.rb#L4) ios
> def filter
Returns the value of attribute filter
--
-##### [filter=](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/ios/helper.rb#L4) ios
+##### [filter=](https://github.com/appium/ruby_lib/blob/94f3348a8fbec111a7a958063d3a2e643051b2e9/lib/appium_lib/ios/helper.rb#L4) ios
> def filter=(value)
Sets the attribute filter
@@ -1643,27 +1773,27 @@
value - the value to set the attribute filter to.
--
-##### [start_element](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/ios/helper.rb#L6) ios
+##### [start_element](https://github.com/appium/ruby_lib/blob/94f3348a8fbec111a7a958063d3a2e643051b2e9/lib/appium_lib/ios/helper.rb#L6) ios
> def start_element(type, attrs = [])
--
-##### [_print_attr](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/ios/helper.rb#L15) ios
+##### [_print_attr](https://github.com/appium/ruby_lib/blob/94f3348a8fbec111a7a958063d3a2e643051b2e9/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/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/ios/helper.rb#L41) ios
+##### [ios_password](https://github.com/appium/ruby_lib/blob/94f3348a8fbec111a7a958063d3a2e643051b2e9/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.
@@ -1677,11 +1807,11 @@
[String] the returned string is of size length
--
-##### [get_page](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/ios/helper.rb#L53) ios
+##### [get_page](https://github.com/appium/ruby_lib/blob/94f3348a8fbec111a7a958063d3a2e643051b2e9/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.
@@ -1698,11 +1828,11 @@
[String]
--
-##### [page](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/ios/helper.rb#L139) ios
+##### [page](https://github.com/appium/ruby_lib/blob/94f3348a8fbec111a7a958063d3a2e643051b2e9/lib/appium_lib/ios/helper.rb#L139) ios
> def page(opts = {})
Prints a string of interesting elements to the console.
@@ -1724,27 +1854,27 @@
[void]
--
-##### [source_window](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/ios/helper.rb#L170) ios
+##### [source_window](https://github.com/appium/ruby_lib/blob/94f3348a8fbec111a7a958063d3a2e643051b2e9/lib/appium_lib/ios/helper.rb#L170) ios
> def source_window(_window_number = 0)
Gets the JSON source of window number
__Parameters:__
- [Integer] window_number - the int index of the target window
+ [Integer] _window_number - The int index of the target window
__Returns:__
[JSON]
--
-##### [page_window](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/ios/helper.rb#L185) ios
+##### [page_window](https://github.com/appium/ruby_lib/blob/94f3348a8fbec111a7a958063d3a2e643051b2e9/lib/appium_lib/ios/helper.rb#L185) ios
> def page_window(window_number = 0)
Prints parsed page source to console.
@@ -1758,11 +1888,11 @@
[void]
--
-##### [id](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/ios/helper.rb#L193) ios
+##### [id](https://github.com/appium/ruby_lib/blob/94f3348a8fbec111a7a958063d3a2e643051b2e9/lib/appium_lib/ios/helper.rb#L193) ios
> def id(id)
Find by id
@@ -1774,11 +1904,11 @@
[Element]
--
-##### [ios_version](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/ios/helper.rb#L199) ios
+##### [ios_version](https://github.com/appium/ruby_lib/blob/94f3348a8fbec111a7a958063d3a2e643051b2e9/lib/appium_lib/ios/helper.rb#L199) ios
> def ios_version
Return the iOS version as an array of integers
@@ -1786,11 +1916,11 @@
[Array<Integer>]
--
-##### [ele_index](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/ios/helper.rb#L212) ios
+##### [ele_index](https://github.com/appium/ruby_lib/blob/94f3348a8fbec111a7a958063d3a2e643051b2e9/lib/appium_lib/ios/helper.rb#L212) ios
> def ele_index(class_name, index)
Get the element of type class_name at matching index.
@@ -1804,16 +1934,17 @@
[Element]
--
-##### [find_ele_by_attr](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/ios/helper.rb#L247) ios
+##### [find_ele_by_attr](https://github.com/appium/ruby_lib/blob/94f3348a8fbec111a7a958063d3a2e643051b2e9/lib/appium_lib/ios/helper.rb#L248) ios
> def find_ele_by_attr(class_name, attr, value)
Find the first element exactly matching class and attribute value.
Note: Uses XPath
+Note: For XCUITest, this method return ALL elements include displayed or not displayed elements.
__Parameters:__
[String] class_name - the class name to search for
@@ -1825,16 +1956,17 @@
[Element]
--
-##### [find_eles_by_attr](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/ios/helper.rb#L257) ios
+##### [find_eles_by_attr](https://github.com/appium/ruby_lib/blob/94f3348a8fbec111a7a958063d3a2e643051b2e9/lib/appium_lib/ios/helper.rb#L259) ios
> def find_eles_by_attr(class_name, attr, value)
Find all elements exactly matching class and attribute value.
Note: Uses XPath
+Note: For XCUITest, this method return ALL elements include displayed or not displayed elements.
__Parameters:__
[String] class_name - the class name to match
@@ -1846,11 +1978,11 @@
[Array<Element>]
--
-##### [find_ele_by_attr_include](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/ios/helper.rb#L280) ios
+##### [find_ele_by_attr_include](https://github.com/appium/ruby_lib/blob/94f3348a8fbec111a7a958063d3a2e643051b2e9/lib/appium_lib/ios/helper.rb#L282) ios
> def find_ele_by_attr_include(class_name, attr, value)
Get the first tag by attribute that exactly matches value.
Note: Uses XPath
@@ -1867,11 +1999,11 @@
[Element] the element of type tag who's attribute includes value
--
-##### [find_eles_by_attr_include](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/ios/helper.rb#L290) ios
+##### [find_eles_by_attr_include](https://github.com/appium/ruby_lib/blob/94f3348a8fbec111a7a958063d3a2e643051b2e9/lib/appium_lib/ios/helper.rb#L292) ios
> def find_eles_by_attr_include(class_name, attr, value)
Get tags by attribute that include value.
Note: Uses XPath
@@ -1888,11 +2020,11 @@
[Array<Element>] the elements of type tag who's attribute includes value
--
-##### [first_ele](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/ios/helper.rb#L297) ios
+##### [first_ele](https://github.com/appium/ruby_lib/blob/94f3348a8fbec111a7a958063d3a2e643051b2e9/lib/appium_lib/ios/helper.rb#L299) ios
> def first_ele(class_name)
Get the first tag that matches class_name
@@ -1904,11 +2036,11 @@
[Element]
--
-##### [last_ele](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/ios/helper.rb#L308) ios
+##### [last_ele](https://github.com/appium/ruby_lib/blob/94f3348a8fbec111a7a958063d3a2e643051b2e9/lib/appium_lib/ios/helper.rb#L306) ios
> def last_ele(class_name)
Get the last tag that matches class_name
@@ -1920,15 +2052,15 @@
[Element]
--
-##### [tag](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/ios/helper.rb#L322) ios
+##### [tag](https://github.com/appium/ruby_lib/blob/94f3348a8fbec111a7a958063d3a2e643051b2e9/lib/appium_lib/ios/helper.rb#L320) ios
> def tag(class_name)
-Returns the first visible element matching class_name
+Returns the first **visible** element matching class_name
__Parameters:__
[String] class_name - the class_name to search for
@@ -1936,11 +2068,11 @@
[Element]
--
-##### [tags](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/ios/helper.rb#L334) ios
+##### [tags](https://github.com/appium/ruby_lib/blob/94f3348a8fbec111a7a958063d3a2e643051b2e9/lib/appium_lib/ios/helper.rb#L332) ios
> def tags(class_name)
Returns all visible elements matching class_name
@@ -1952,11 +2084,11 @@
[Element]
--
-##### [ele_by_json_visible_contains](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/ios/helper.rb#L371) ios
+##### [ele_by_json_visible_contains](https://github.com/appium/ruby_lib/blob/94f3348a8fbec111a7a958063d3a2e643051b2e9/lib/appium_lib/ios/helper.rb#L370) ios
> def ele_by_json_visible_contains(element, value)
Find the first element that contains value.
For Appium(automation name), not XCUITest
@@ -1971,11 +2103,11 @@
[Element]
--
-##### [eles_by_json_visible_contains](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/ios/helper.rb#L380) ios
+##### [eles_by_json_visible_contains](https://github.com/appium/ruby_lib/blob/94f3348a8fbec111a7a958063d3a2e643051b2e9/lib/appium_lib/ios/helper.rb#L379) ios
> def eles_by_json_visible_contains(element, value)
Find all elements containing value
For Appium(automation name), not XCUITest
@@ -1990,11 +2122,11 @@
[Array<Element>]
--
-##### [ele_by_json_visible_exact](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/ios/helper.rb#L410) ios
+##### [ele_by_json_visible_exact](https://github.com/appium/ruby_lib/blob/94f3348a8fbec111a7a958063d3a2e643051b2e9/lib/appium_lib/ios/helper.rb#L409) ios
> def ele_by_json_visible_exact(element, value)
Find the first element exactly matching value
For Appium(automation name), not XCUITest
@@ -2009,11 +2141,11 @@
[Element]
--
-##### [eles_by_json_visible_exact](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/ios/helper.rb#L419) ios
+##### [eles_by_json_visible_exact](https://github.com/appium/ruby_lib/blob/94f3348a8fbec111a7a958063d3a2e643051b2e9/lib/appium_lib/ios/helper.rb#L418) ios
> def eles_by_json_visible_exact(element, value)
Find all elements exactly matching value
For Appium(automation name), not XCUITest
@@ -2028,21 +2160,21 @@
[Element]
--
-##### [_all_pred](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/ios/helper.rb#L484) ios
+##### [_all_pred](https://github.com/appium/ruby_lib/blob/94f3348a8fbec111a7a958063d3a2e643051b2e9/lib/appium_lib/ios/helper.rb#L483) 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/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/ios/helper.rb#L497) ios
+##### [ele_with_pred](https://github.com/appium/ruby_lib/blob/94f3348a8fbec111a7a958063d3a2e643051b2e9/lib/appium_lib/ios/helper.rb#L496) ios
> def ele_with_pred(opts)
returns element matching predicate contained in the main app
@@ -2054,11 +2186,11 @@
[Element]
--
-##### [eles_with_pred](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/ios/helper.rb#L508) ios
+##### [eles_with_pred](https://github.com/appium/ruby_lib/blob/94f3348a8fbec111a7a958063d3a2e643051b2e9/lib/appium_lib/ios/helper.rb#L507) ios
> def eles_with_pred(opts)
returns elements matching predicate contained in the main app
@@ -2070,11 +2202,11 @@
[Array<Element>]
--
-##### [source](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/ios/helper.rb#L514) ios
+##### [source](https://github.com/appium/ruby_lib/blob/94f3348a8fbec111a7a958063d3a2e643051b2e9/lib/appium_lib/ios/helper.rb#L513) ios
> def source
Prints xml of the current page
@@ -2082,19 +2214,19 @@
[void]
--
-##### [_validate_object](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/ios/helper.rb#L518) ios
+##### [_validate_object](https://github.com/appium/ruby_lib/blob/94f3348a8fbec111a7a958063d3a2e643051b2e9/lib/appium_lib/ios/helper.rb#L517) ios
> def _validate_object(*objects)
--
-##### [_by_json](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/ios/helper.rb#L567) ios
+##### [_by_json](https://github.com/appium/ruby_lib/blob/94f3348a8fbec111a7a958063d3a2e643051b2e9/lib/appium_lib/ios/helper.rb#L566) ios
> def _by_json(opts)
For Appium(automation name), not XCUITest
typeArray - array of string types to search for. Example: ["UIAStaticText"]
@@ -2125,11 +2257,11 @@
}
}
--
-##### [eles_by_json](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/ios/helper.rb#L617) ios
+##### [eles_by_json](https://github.com/appium/ruby_lib/blob/94f3348a8fbec111a7a958063d3a2e643051b2e9/lib/appium_lib/ios/helper.rb#L616) ios
> def eles_by_json(opts)
For Appium(automation name), not XCUITest
example usage:
@@ -2144,19 +2276,19 @@
},
})
--
-##### [ele_by_json](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/ios/helper.rb#L623) ios
+##### [ele_by_json](https://github.com/appium/ruby_lib/blob/94f3348a8fbec111a7a958063d3a2e643051b2e9/lib/appium_lib/ios/helper.rb#L622) ios
> def ele_by_json(opts)
see eles_by_json
--
-##### [get_source](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/ios/helper.rb#L633) ios
+##### [get_source](https://github.com/appium/ruby_lib/blob/94f3348a8fbec111a7a958063d3a2e643051b2e9/lib/appium_lib/ios/helper.rb#L632) ios
> def get_source
Returns XML string for the current page
Same as driver.page_source
@@ -2165,27 +2297,27 @@
[String]
--
-##### [IAStaticText](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/ios/element/text.rb#L4) ios
+##### [UIAStaticText](https://github.com/appium/ruby_lib/blob/94f3348a8fbec111a7a958063d3a2e643051b2e9/lib/appium_lib/ios/element/text.rb#L4) ios
-> IAStaticText = 'UIAStaticText'.freeze
+> UIAStaticText = 'UIAStaticText'.freeze
--
-##### [XCUIElementTypeStaticText](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/ios/element/text.rb#L5) ios
+##### [XCUIElementTypeStaticText](https://github.com/appium/ruby_lib/blob/94f3348a8fbec111a7a958063d3a2e643051b2e9/lib/appium_lib/ios/element/text.rb#L5) ios
> XCUIElementTypeStaticText = 'XCUIElementTypeStaticText'.freeze
--
-##### [static_text_class](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/ios/element/text.rb#L8) ios
+##### [static_text_class](https://github.com/appium/ruby_lib/blob/94f3348a8fbec111a7a958063d3a2e643051b2e9/lib/appium_lib/ios/element/text.rb#L8) ios
> def static_text_class
@@ -2193,11 +2325,11 @@
[String] Class name for text
--
-##### [text](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/ios/element/text.rb#L16) ios
+##### [text](https://github.com/appium/ruby_lib/blob/94f3348a8fbec111a7a958063d3a2e643051b2e9/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.
@@ -2210,11 +2342,11 @@
[UIAStaticText|XCUIElementTypeStaticText]
--
-##### [texts](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/ios/element/text.rb#L30) ios
+##### [texts](https://github.com/appium/ruby_lib/blob/94f3348a8fbec111a7a958063d3a2e643051b2e9/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
@@ -2227,11 +2359,11 @@
[Array<UIAStaticText|XCUIElementTypeStaticText>]
--
-##### [first_text](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/ios/element/text.rb#L43) ios
+##### [first_text](https://github.com/appium/ruby_lib/blob/94f3348a8fbec111a7a958063d3a2e643051b2e9/lib/appium_lib/ios/element/text.rb#L43) ios
> def first_text
Find the first UIAStaticText|XCUIElementTypeStaticText.
@@ -2239,11 +2371,11 @@
[UIAStaticText|XCUIElementTypeStaticText]
--
-##### [last_text](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/ios/element/text.rb#L49) ios
+##### [last_text](https://github.com/appium/ruby_lib/blob/94f3348a8fbec111a7a958063d3a2e643051b2e9/lib/appium_lib/ios/element/text.rb#L49) ios
> def last_text
Find the last UIAStaticText|XCUIElementTypeStaticText.
@@ -2251,11 +2383,11 @@
[UIAStaticText|XCUIElementTypeStaticText]
--
-##### [text_exact](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/ios/element/text.rb#L56) ios
+##### [text_exact](https://github.com/appium/ruby_lib/blob/94f3348a8fbec111a7a958063d3a2e643051b2e9/lib/appium_lib/ios/element/text.rb#L56) ios
> def text_exact(value)
Find the first UIAStaticText|XCUIElementTypeStaticText that exactly matches value.
@@ -2267,11 +2399,11 @@
[UIAStaticText|XCUIElementTypeStaticText]
--
-##### [texts_exact](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/ios/element/text.rb#L67) ios
+##### [texts_exact](https://github.com/appium/ruby_lib/blob/94f3348a8fbec111a7a958063d3a2e643051b2e9/lib/appium_lib/ios/element/text.rb#L67) ios
> def texts_exact(value)
Find all UIAStaticTexts|XCUIElementTypeStaticTexts that exactly match value.
@@ -2283,11 +2415,11 @@
[Array<UIAStaticText|XCUIElementTypeStaticText>]
--
-##### [alert_accept](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/ios/element/alert.rb#L5) ios
+##### [alert_accept](https://github.com/appium/ruby_lib/blob/94f3348a8fbec111a7a958063d3a2e643051b2e9/lib/appium_lib/ios/element/alert.rb#L5) ios
> def alert_accept
Accept the alert.
@@ -2295,11 +2427,11 @@
[void]
--
-##### [alert_dismiss](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/ios/element/alert.rb#L13) ios
+##### [alert_dismiss](https://github.com/appium/ruby_lib/blob/94f3348a8fbec111a7a958063d3a2e643051b2e9/lib/appium_lib/ios/element/alert.rb#L13) ios
> def alert_dismiss
Dismiss the alert.
@@ -2307,27 +2439,27 @@
[void]
--
-##### [UIAButton](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/ios/element/button.rb#L4) ios
+##### [UIAButton](https://github.com/appium/ruby_lib/blob/94f3348a8fbec111a7a958063d3a2e643051b2e9/lib/appium_lib/ios/element/button.rb#L4) ios
> UIAButton = 'UIAButton'.freeze
--
-##### [XCUIElementTypeButton](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/ios/element/button.rb#L5) ios
+##### [XCUIElementTypeButton](https://github.com/appium/ruby_lib/blob/94f3348a8fbec111a7a958063d3a2e643051b2e9/lib/appium_lib/ios/element/button.rb#L5) ios
> XCUIElementTypeButton = 'XCUIElementTypeButton'.freeze
--
-##### [button_class](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/ios/element/button.rb#L8) ios
+##### [button_class](https://github.com/appium/ruby_lib/blob/94f3348a8fbec111a7a958063d3a2e643051b2e9/lib/appium_lib/ios/element/button.rb#L8) ios
> def button_class
@@ -2335,11 +2467,11 @@
[String] Class name for button
--
-##### [button](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/ios/element/button.rb#L16) ios
+##### [button](https://github.com/appium/ruby_lib/blob/94f3348a8fbec111a7a958063d3a2e643051b2e9/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.
@@ -2352,11 +2484,11 @@
[UIAButton|XCUIElementTypeButton]
--
-##### [buttons](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/ios/element/button.rb#L31) ios
+##### [buttons](https://github.com/appium/ruby_lib/blob/94f3348a8fbec111a7a958063d3a2e643051b2e9/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.
@@ -2369,11 +2501,11 @@
[Array<UIAButton|XCUIElementTypeButton>]
--
-##### [first_button](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/ios/element/button.rb#L44) ios
+##### [first_button](https://github.com/appium/ruby_lib/blob/94f3348a8fbec111a7a958063d3a2e643051b2e9/lib/appium_lib/ios/element/button.rb#L44) ios
> def first_button
Find the first UIAButton|XCUIElementTypeButton.
@@ -2381,11 +2513,11 @@
[UIAButton|XCUIElementTypeButton]
--
-##### [last_button](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/ios/element/button.rb#L52) ios
+##### [last_button](https://github.com/appium/ruby_lib/blob/94f3348a8fbec111a7a958063d3a2e643051b2e9/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.
@@ -2395,11 +2527,11 @@
[UIAButton|XCUIElementTypeButton]
--
-##### [button_exact](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/ios/element/button.rb#L59) ios
+##### [button_exact](https://github.com/appium/ruby_lib/blob/94f3348a8fbec111a7a958063d3a2e643051b2e9/lib/appium_lib/ios/element/button.rb#L59) ios
> def button_exact(value)
Find the first UIAButton|XCUIElementTypeButton that exactly matches value.
@@ -2411,11 +2543,11 @@
[UIAButton|XCUIElementTypeButton]
--
-##### [buttons_exact](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/ios/element/button.rb#L70) ios
+##### [buttons_exact](https://github.com/appium/ruby_lib/blob/94f3348a8fbec111a7a958063d3a2e643051b2e9/lib/appium_lib/ios/element/button.rb#L70) ios
> def buttons_exact(value)
Find all UIAButtons|XCUIElementTypeButtons that exactly match value.
@@ -2427,11 +2559,11 @@
[Array<UIAButton|XCUIElementTypeButton>]
--
-##### [uiautomation_find](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/ios/mobile_methods.rb#L19) ios
+##### [uiautomation_find](https://github.com/appium/ruby_lib/blob/94f3348a8fbec111a7a958063d3a2e643051b2e9/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).
@@ -2439,11 +2571,11 @@
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
+##### [ios_predicate_string_find](https://github.com/appium/ruby_lib/blob/94f3348a8fbec111a7a958063d3a2e643051b2e9/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)
@@ -2453,11 +2585,11 @@
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
+##### [find](https://github.com/appium/ruby_lib/blob/94f3348a8fbec111a7a958063d3a2e643051b2e9/lib/appium_lib/ios/element/generic.rb#L6) ios
> def find(value)
Find the first element containing value
@@ -2469,11 +2601,11 @@
[Element]
--
-##### [finds](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/ios/element/generic.rb#L17) ios
+##### [finds](https://github.com/appium/ruby_lib/blob/94f3348a8fbec111a7a958063d3a2e643051b2e9/lib/appium_lib/ios/element/generic.rb#L17) ios
> def finds(value)
Find all elements containing value
@@ -2485,11 +2617,11 @@
[Array<Element>]
--
-##### [find_exact](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/ios/element/generic.rb#L28) ios
+##### [find_exact](https://github.com/appium/ruby_lib/blob/94f3348a8fbec111a7a958063d3a2e643051b2e9/lib/appium_lib/ios/element/generic.rb#L29) ios
> def find_exact(value)
Find the first element exactly matching value
@@ -2501,11 +2633,11 @@
[Element]
--
-##### [finds_exact](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/ios/element/generic.rb#L39) ios
+##### [finds_exact](https://github.com/appium/ruby_lib/blob/94f3348a8fbec111a7a958063d3a2e643051b2e9/lib/appium_lib/ios/element/generic.rb#L40) ios
> def finds_exact(value)
Find all elements exactly matching value
@@ -2517,67 +2649,75 @@
[Array<Element>]
--
-##### [_raise_error_if_no_element](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/ios/element/generic.rb#L49) ios
+##### [raise_error_if_no_element](https://github.com/appium/ruby_lib/blob/94f3348a8fbec111a7a958063d3a2e643051b2e9/lib/appium_lib/ios/element/generic.rb#L51) ios
-> def _raise_error_if_no_element(element)
+> def raise_error_if_no_element(element)
--
-##### [_elements_include](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/ios/element/generic.rb#L54) ios
+##### [elements_include](https://github.com/appium/ruby_lib/blob/94f3348a8fbec111a7a958063d3a2e643051b2e9/lib/appium_lib/ios/element/generic.rb#L58) ios
-> def _elements_include(elements, value)
+> def elements_include(elements, value)
+Return all elements include not displayed elements.
-
--
-##### [_elements_exact](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/ios/element/generic.rb#L62) ios
+##### [elements_exact](https://github.com/appium/ruby_lib/blob/94f3348a8fbec111a7a958063d3a2e643051b2e9/lib/appium_lib/ios/element/generic.rb#L72) ios
-> def _elements_exact(elements, value)
+> def elements_exact(elements, value)
+Return all elements include not displayed elements.
+--
+##### [select_visible_elements](https://github.com/appium/ruby_lib/blob/94f3348a8fbec111a7a958063d3a2e643051b2e9/lib/appium_lib/ios/element/generic.rb#L86) ios
+
+> def select_visible_elements(elements)
+
+Return visible elements.
+
--
-##### [UIATextField](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/ios/element/textfield.rb#L3) ios
+##### [UIATextField](https://github.com/appium/ruby_lib/blob/94f3348a8fbec111a7a958063d3a2e643051b2e9/lib/appium_lib/ios/element/textfield.rb#L3) ios
> UIATextField = 'UIATextField'.freeze
--
-##### [UIASecureTextField](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/ios/element/textfield.rb#L4) ios
+##### [UIASecureTextField](https://github.com/appium/ruby_lib/blob/94f3348a8fbec111a7a958063d3a2e643051b2e9/lib/appium_lib/ios/element/textfield.rb#L4) ios
> UIASecureTextField = 'UIASecureTextField'.freeze
--
-##### [XCUIElementTypeTextField](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/ios/element/textfield.rb#L6) ios
+##### [XCUIElementTypeTextField](https://github.com/appium/ruby_lib/blob/94f3348a8fbec111a7a958063d3a2e643051b2e9/lib/appium_lib/ios/element/textfield.rb#L6) ios
> XCUIElementTypeTextField = 'XCUIElementTypeTextField'.freeze
--
-##### [XCUIElementTypeSecureTextField](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/ios/element/textfield.rb#L7) ios
+##### [XCUIElementTypeSecureTextField](https://github.com/appium/ruby_lib/blob/94f3348a8fbec111a7a958063d3a2e643051b2e9/lib/appium_lib/ios/element/textfield.rb#L7) ios
> XCUIElementTypeSecureTextField = 'XCUIElementTypeSecureTextField'.freeze
--
-##### [text_field_class](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/ios/element/textfield.rb#L10) ios
+##### [text_field_class](https://github.com/appium/ruby_lib/blob/94f3348a8fbec111a7a958063d3a2e643051b2e9/lib/appium_lib/ios/element/textfield.rb#L10) ios
> def text_field_class
@@ -2585,11 +2725,11 @@
[String] Class name for text field
--
-##### [secure_text_field_class](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/ios/element/textfield.rb#L15) ios
+##### [secure_text_field_class](https://github.com/appium/ruby_lib/blob/94f3348a8fbec111a7a958063d3a2e643051b2e9/lib/appium_lib/ios/element/textfield.rb#L15) ios
> def secure_text_field_class
@@ -2597,35 +2737,35 @@
[String] Class name for secure text field
--
-##### [_textfield_visible](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/ios/element/textfield.rb#L40) ios
+##### [_textfield_visible](https://github.com/appium/ruby_lib/blob/94f3348a8fbec111a7a958063d3a2e643051b2e9/lib/appium_lib/ios/element/textfield.rb#L41) ios
> def _textfield_visible
Appium
--
-##### [_textfield_exact_string](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/ios/element/textfield.rb#L45) ios
+##### [_textfield_exact_string](https://github.com/appium/ruby_lib/blob/94f3348a8fbec111a7a958063d3a2e643051b2e9/lib/appium_lib/ios/element/textfield.rb#L46) ios
> def _textfield_exact_string(value)
Appium
--
-##### [_textfield_contains_string](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/ios/element/textfield.rb#L52) ios
+##### [_textfield_contains_string](https://github.com/appium/ruby_lib/blob/94f3348a8fbec111a7a958063d3a2e643051b2e9/lib/appium_lib/ios/element/textfield.rb#L53) ios
> def _textfield_contains_string(value)
Appium
--
-##### [textfield](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/ios/element/textfield.rb#L65) ios
+##### [textfield](https://github.com/appium/ruby_lib/blob/94f3348a8fbec111a7a958063d3a2e643051b2e9/lib/appium_lib/ios/element/textfield.rb#L66) ios
> def textfield(value)
Find the first TextField that contains value or by index.
Note: Uses XPath
@@ -2639,11 +2779,11 @@
[TextField]
--
-##### [textfields](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/ios/element/textfield.rb#L91) ios
+##### [textfields](https://github.com/appium/ruby_lib/blob/94f3348a8fbec111a7a958063d3a2e643051b2e9/lib/appium_lib/ios/element/textfield.rb#L92) ios
> def textfields(value = false)
Find all TextFields containing value.
If value is omitted, all TextFields are returned.
@@ -2656,11 +2796,11 @@
[Array<TextField>]
--
-##### [first_textfield](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/ios/element/textfield.rb#L103) ios
+##### [first_textfield](https://github.com/appium/ruby_lib/blob/94f3348a8fbec111a7a958063d3a2e643051b2e9/lib/appium_lib/ios/element/textfield.rb#L105) ios
> def first_textfield
Find the first TextField.
@@ -2668,11 +2808,11 @@
[TextField]
--
-##### [last_textfield](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/ios/element/textfield.rb#L113) ios
+##### [last_textfield](https://github.com/appium/ruby_lib/blob/94f3348a8fbec111a7a958063d3a2e643051b2e9/lib/appium_lib/ios/element/textfield.rb#L115) ios
> def last_textfield
Find the last TextField.
@@ -2680,11 +2820,11 @@
[TextField]
--
-##### [textfield_exact](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/ios/element/textfield.rb#L126) ios
+##### [textfield_exact](https://github.com/appium/ruby_lib/blob/94f3348a8fbec111a7a958063d3a2e643051b2e9/lib/appium_lib/ios/element/textfield.rb#L128) ios
> def textfield_exact(value)
Find the first TextField that exactly matches value.
@@ -2696,11 +2836,11 @@
[TextField]
--
-##### [textfields_exact](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/ios/element/textfield.rb#L137) ios
+##### [textfields_exact](https://github.com/appium/ruby_lib/blob/94f3348a8fbec111a7a958063d3a2e643051b2e9/lib/appium_lib/ios/element/textfield.rb#L139) ios
> def textfields_exact(value)
Find all TextFields that exactly match value.
@@ -2712,31 +2852,31 @@
[Array<TextField>]
--
-##### [value](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/common/patch.rb#L12)
+##### [value](https://github.com/appium/ruby_lib/blob/94f3348a8fbec111a7a958063d3a2e643051b2e9/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/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/common/patch.rb#L19)
+##### [name](https://github.com/appium/ruby_lib/blob/94f3348a8fbec111a7a958063d3a2e643051b2e9/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/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/common/patch.rb#L31)
+##### [location_rel](https://github.com/appium/ruby_lib/blob/94f3348a8fbec111a7a958063d3a2e643051b2e9/lib/appium_lib/common/patch.rb#L31)
> def location_rel
For use with mobile tap.
@@ -2750,18 +2890,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/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/common/patch.rb#L152)
+##### [DEFAULT_HEADERS](https://github.com/appium/ruby_lib/blob/94f3348a8fbec111a7a958063d3a2e643051b2e9/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/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/common/patch.rb#L155)
+##### [patch_remote_driver_commands](https://github.com/appium/ruby_lib/blob/94f3348a8fbec111a7a958063d3a2e643051b2e9/lib/appium_lib/common/patch.rb#L155)
> def patch_remote_driver_commands