docs/ios_docs.md in appium_lib-8.2.1 vs docs/ios_docs.md in appium_lib-9.0.0
- old
+ new
@@ -1,6 +1,6 @@
-##### [load_settings](https://github.com/appium/ruby_lib/blob/ad91ee47a96bf7a19b6f784dc760ac70b8788e5a/lib/appium_lib/driver.rb#L69)
+##### [load_settings](https://github.com/appium/ruby_lib/blob/54ff9c45df80ce901b718347e79e761f93a4316b/lib/appium_lib/driver.rb#L72)
> 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/ad91ee47a96bf7a19b6f784dc760ac70b8788e5a/lib/appium_lib/driver.rb#L102)
+##### [load_appium_txt](https://github.com/appium/ruby_lib/blob/54ff9c45df80ce901b718347e79e761f93a4316b/lib/appium_lib/driver.rb#L105)
> def self.load_settings(opts = {})
Load arbitrary text (toml format)
@@ -52,11 +52,11 @@
[hash] the symbolized hash with updated :app and :require keys
--
-##### [expand_required_files](https://github.com/appium/ruby_lib/blob/ad91ee47a96bf7a19b6f784dc760ac70b8788e5a/lib/appium_lib/driver.rb#L108)
+##### [expand_required_files](https://github.com/appium/ruby_lib/blob/54ff9c45df80ce901b718347e79e761f93a4316b/lib/appium_lib/driver.rb#L111)
> def self.expand_required_files(base_dir, file_paths)
@@ -70,22 +70,22 @@
[Array] list of require files as an array, nil if require doesn't exist
--
-##### [symbolize_keys](https://github.com/appium/ruby_lib/blob/ad91ee47a96bf7a19b6f784dc760ac70b8788e5a/lib/appium_lib/driver.rb#L140)
+##### [symbolize_keys](https://github.com/appium/ruby_lib/blob/54ff9c45df80ce901b718347e79e761f93a4316b/lib/appium_lib/driver.rb#L143)
> 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/ad91ee47a96bf7a19b6f784dc760ac70b8788e5a/lib/appium_lib/driver.rb#L161)
+##### [promote_singleton_appium_methods](https://github.com/appium/ruby_lib/blob/54ff9c45df80ce901b718347e79e761f93a4316b/lib/appium_lib/driver.rb#L164)
> 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
@@ -99,11 +99,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/ad91ee47a96bf7a19b6f784dc760ac70b8788e5a/lib/appium_lib/driver.rb#L212)
+##### [promote_appium_methods](https://github.com/appium/ruby_lib/blob/54ff9c45df80ce901b718347e79e761f93a4316b/lib/appium_lib/driver.rb#L215)
> def self.promote_appium_methods(class_array)
Promote appium methods to class instance methods
@@ -129,75 +129,75 @@
[Array<Class>] class_array - An array of classes
--
-##### [global_webdriver_http_sleep](https://github.com/appium/ruby_lib/blob/ad91ee47a96bf7a19b6f784dc760ac70b8788e5a/lib/appium_lib/driver.rb#L246)
+##### [global_webdriver_http_sleep](https://github.com/appium/ruby_lib/blob/54ff9c45df80ce901b718347e79e761f93a4316b/lib/appium_lib/driver.rb#L249)
> 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/ad91ee47a96bf7a19b6f784dc760ac70b8788e5a/lib/appium_lib/driver.rb#L246)
+##### [global_webdriver_http_sleep=](https://github.com/appium/ruby_lib/blob/54ff9c45df80ce901b718347e79e761f93a4316b/lib/appium_lib/driver.rb#L249)
> 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/ad91ee47a96bf7a19b6f784dc760ac70b8788e5a/lib/appium_lib/driver.rb#L248)
+##### [caps](https://github.com/appium/ruby_lib/blob/54ff9c45df80ce901b718347e79e761f93a4316b/lib/appium_lib/driver.rb#L251)
> def caps
Selenium webdriver capabilities
--
-##### [caps=](https://github.com/appium/ruby_lib/blob/ad91ee47a96bf7a19b6f784dc760ac70b8788e5a/lib/appium_lib/driver.rb#L248)
+##### [caps=](https://github.com/appium/ruby_lib/blob/54ff9c45df80ce901b718347e79e761f93a4316b/lib/appium_lib/driver.rb#L251)
> def caps=(value)
Selenium webdriver capabilities
--
-##### [custom_url](https://github.com/appium/ruby_lib/blob/ad91ee47a96bf7a19b6f784dc760ac70b8788e5a/lib/appium_lib/driver.rb#L250)
+##### [custom_url](https://github.com/appium/ruby_lib/blob/54ff9c45df80ce901b718347e79e761f93a4316b/lib/appium_lib/driver.rb#L253)
> def custom_url
Custom URL for the selenium server
--
-##### [custom_url=](https://github.com/appium/ruby_lib/blob/ad91ee47a96bf7a19b6f784dc760ac70b8788e5a/lib/appium_lib/driver.rb#L250)
+##### [custom_url=](https://github.com/appium/ruby_lib/blob/54ff9c45df80ce901b718347e79e761f93a4316b/lib/appium_lib/driver.rb#L253)
> def custom_url=(value)
Custom URL for the selenium server
--
-##### [export_session](https://github.com/appium/ruby_lib/blob/ad91ee47a96bf7a19b6f784dc760ac70b8788e5a/lib/appium_lib/driver.rb#L252)
+##### [export_session](https://github.com/appium/ruby_lib/blob/54ff9c45df80ce901b718347e79e761f93a4316b/lib/appium_lib/driver.rb#L255)
> def export_session
Export session id to textfile in /tmp for 3rd party tools
--
-##### [export_session=](https://github.com/appium/ruby_lib/blob/ad91ee47a96bf7a19b6f784dc760ac70b8788e5a/lib/appium_lib/driver.rb#L252)
+##### [export_session=](https://github.com/appium/ruby_lib/blob/54ff9c45df80ce901b718347e79e761f93a4316b/lib/appium_lib/driver.rb#L255)
> def export_session=(value)
Export session id to textfile in /tmp for 3rd party tools
--
-##### [default_wait](https://github.com/appium/ruby_lib/blob/ad91ee47a96bf7a19b6f784dc760ac70b8788e5a/lib/appium_lib/driver.rb#L257)
+##### [default_wait](https://github.com/appium/ruby_lib/blob/54ff9c45df80ce901b718347e79e761f93a4316b/lib/appium_lib/driver.rb#L260)
> def default_wait
Default wait time for elements to appear
Returns the default client side wait.
@@ -207,11 +207,11 @@
[Integer]
--
-##### [default_wait=](https://github.com/appium/ruby_lib/blob/ad91ee47a96bf7a19b6f784dc760ac70b8788e5a/lib/appium_lib/driver.rb#L257)
+##### [default_wait=](https://github.com/appium/ruby_lib/blob/54ff9c45df80ce901b718347e79e761f93a4316b/lib/appium_lib/driver.rb#L260)
> def default_wait=(value)
Default wait time for elements to appear
Returns the default client side wait.
@@ -221,123 +221,152 @@
[Integer]
--
-##### [last_waits](https://github.com/appium/ruby_lib/blob/ad91ee47a96bf7a19b6f784dc760ac70b8788e5a/lib/appium_lib/driver.rb#L259)
+##### [last_waits](https://github.com/appium/ruby_lib/blob/54ff9c45df80ce901b718347e79e761f93a4316b/lib/appium_lib/driver.rb#L262)
> def last_waits
Array of previous wait time values
--
-##### [last_waits=](https://github.com/appium/ruby_lib/blob/ad91ee47a96bf7a19b6f784dc760ac70b8788e5a/lib/appium_lib/driver.rb#L259)
+##### [last_waits=](https://github.com/appium/ruby_lib/blob/54ff9c45df80ce901b718347e79e761f93a4316b/lib/appium_lib/driver.rb#L262)
> def last_waits=(value)
Array of previous wait time values
--
-##### [sauce_username](https://github.com/appium/ruby_lib/blob/ad91ee47a96bf7a19b6f784dc760ac70b8788e5a/lib/appium_lib/driver.rb#L261)
+##### [sauce_username](https://github.com/appium/ruby_lib/blob/54ff9c45df80ce901b718347e79e761f93a4316b/lib/appium_lib/driver.rb#L264)
> def sauce_username
Username for use on Sauce Labs
--
-##### [sauce_username=](https://github.com/appium/ruby_lib/blob/ad91ee47a96bf7a19b6f784dc760ac70b8788e5a/lib/appium_lib/driver.rb#L261)
+##### [sauce_username=](https://github.com/appium/ruby_lib/blob/54ff9c45df80ce901b718347e79e761f93a4316b/lib/appium_lib/driver.rb#L264)
> def sauce_username=(value)
Username for use on Sauce Labs
--
-##### [sauce_access_key](https://github.com/appium/ruby_lib/blob/ad91ee47a96bf7a19b6f784dc760ac70b8788e5a/lib/appium_lib/driver.rb#L263)
+##### [sauce_access_key](https://github.com/appium/ruby_lib/blob/54ff9c45df80ce901b718347e79e761f93a4316b/lib/appium_lib/driver.rb#L266)
> def sauce_access_key
Access Key for use on Sauce Labs
--
-##### [sauce_access_key=](https://github.com/appium/ruby_lib/blob/ad91ee47a96bf7a19b6f784dc760ac70b8788e5a/lib/appium_lib/driver.rb#L263)
+##### [sauce_access_key=](https://github.com/appium/ruby_lib/blob/54ff9c45df80ce901b718347e79e761f93a4316b/lib/appium_lib/driver.rb#L266)
> def sauce_access_key=(value)
Access Key for use on Sauce Labs
--
-##### [appium_port](https://github.com/appium/ruby_lib/blob/ad91ee47a96bf7a19b6f784dc760ac70b8788e5a/lib/appium_lib/driver.rb#L265)
+##### [appium_port](https://github.com/appium/ruby_lib/blob/54ff9c45df80ce901b718347e79e761f93a4316b/lib/appium_lib/driver.rb#L268)
> def appium_port
Appium's server port
--
-##### [appium_port=](https://github.com/appium/ruby_lib/blob/ad91ee47a96bf7a19b6f784dc760ac70b8788e5a/lib/appium_lib/driver.rb#L265)
+##### [appium_port=](https://github.com/appium/ruby_lib/blob/54ff9c45df80ce901b718347e79e761f93a4316b/lib/appium_lib/driver.rb#L268)
> def appium_port=(value)
Appium's server port
--
-##### [appium_device](https://github.com/appium/ruby_lib/blob/ad91ee47a96bf7a19b6f784dc760ac70b8788e5a/lib/appium_lib/driver.rb#L267)
+##### [appium_device](https://github.com/appium/ruby_lib/blob/54ff9c45df80ce901b718347e79e761f93a4316b/lib/appium_lib/driver.rb#L270)
> def appium_device
Device type to request from the appium server
--
-##### [appium_device=](https://github.com/appium/ruby_lib/blob/ad91ee47a96bf7a19b6f784dc760ac70b8788e5a/lib/appium_lib/driver.rb#L267)
+##### [appium_device=](https://github.com/appium/ruby_lib/blob/54ff9c45df80ce901b718347e79e761f93a4316b/lib/appium_lib/driver.rb#L270)
> def appium_device=(value)
Device type to request from the appium server
--
-##### [appium_debug](https://github.com/appium/ruby_lib/blob/ad91ee47a96bf7a19b6f784dc760ac70b8788e5a/lib/appium_lib/driver.rb#L269)
+##### [automation_name](https://github.com/appium/ruby_lib/blob/54ff9c45df80ce901b718347e79e761f93a4316b/lib/appium_lib/driver.rb#L272)
+> def automation_name
+
+Automation name sent to appium server
+
+--
+
+##### [appium_server_version](https://github.com/appium/ruby_lib/blob/54ff9c45df80ce901b718347e79e761f93a4316b/lib/appium_lib/driver.rb#L274)
+
+> def appium_server_version
+
+Returns the server's version info
+
+```ruby
+{
+ "build" => {
+ "version" => "0.18.1",
+ "revision" => "d242ebcfd92046a974347ccc3a28f0e898595198"
+ }
+}
+```
+
+__Returns:__
+
+ [Hash]
+
+--
+
+##### [appium_debug](https://github.com/appium/ruby_lib/blob/54ff9c45df80ce901b718347e79e761f93a4316b/lib/appium_lib/driver.rb#L276)
+
> def appium_debug
Boolean debug mode for the Appium Ruby bindings
--
-##### [appium_debug=](https://github.com/appium/ruby_lib/blob/ad91ee47a96bf7a19b6f784dc760ac70b8788e5a/lib/appium_lib/driver.rb#L269)
+##### [appium_debug=](https://github.com/appium/ruby_lib/blob/54ff9c45df80ce901b718347e79e761f93a4316b/lib/appium_lib/driver.rb#L276)
> def appium_debug=(value)
Boolean debug mode for the Appium Ruby bindings
--
-##### [listener](https://github.com/appium/ruby_lib/blob/ad91ee47a96bf7a19b6f784dc760ac70b8788e5a/lib/appium_lib/driver.rb#L271)
+##### [listener](https://github.com/appium/ruby_lib/blob/54ff9c45df80ce901b718347e79e761f93a4316b/lib/appium_lib/driver.rb#L278)
> def listener
instance of AbstractEventListener for logging support
--
-##### [listener=](https://github.com/appium/ruby_lib/blob/ad91ee47a96bf7a19b6f784dc760ac70b8788e5a/lib/appium_lib/driver.rb#L271)
+##### [listener=](https://github.com/appium/ruby_lib/blob/54ff9c45df80ce901b718347e79e761f93a4316b/lib/appium_lib/driver.rb#L278)
> def listener=(value)
instance of AbstractEventListener for logging support
--
-##### [driver](https://github.com/appium/ruby_lib/blob/ad91ee47a96bf7a19b6f784dc760ac70b8788e5a/lib/appium_lib/driver.rb#L275)
+##### [driver](https://github.com/appium/ruby_lib/blob/54ff9c45df80ce901b718347e79e761f93a4316b/lib/appium_lib/driver.rb#L281)
> def driver
Returns the driver
@@ -345,11 +374,11 @@
[Driver] the driver
--
-##### [initialize](https://github.com/appium/ruby_lib/blob/ad91ee47a96bf7a19b6f784dc760ac70b8788e5a/lib/appium_lib/driver.rb#L296)
+##### [initialize](https://github.com/appium/ruby_lib/blob/54ff9c45df80ce901b718347e79e761f93a4316b/lib/appium_lib/driver.rb#L302)
> def initialize(opts = {})
Creates a new driver
@@ -376,19 +405,19 @@
[Driver]
--
-##### [driver_attributes](https://github.com/appium/ruby_lib/blob/ad91ee47a96bf7a19b6f784dc760ac70b8788e5a/lib/appium_lib/driver.rb#L364)
+##### [driver_attributes](https://github.com/appium/ruby_lib/blob/54ff9c45df80ce901b718347e79e761f93a4316b/lib/appium_lib/driver.rb#L372)
> def driver_attributes
Returns a hash of the driver attributes
--
-##### [device_is_android?](https://github.com/appium/ruby_lib/blob/ad91ee47a96bf7a19b6f784dc760ac70b8788e5a/lib/appium_lib/driver.rb#L385)
+##### [device_is_android?](https://github.com/appium/ruby_lib/blob/54ff9c45df80ce901b718347e79e761f93a4316b/lib/appium_lib/driver.rb#L393)
> def device_is_android?
@@ -396,32 +425,36 @@
[Boolean]
--
-##### [appium_server_version](https://github.com/appium/ruby_lib/blob/ad91ee47a96bf7a19b6f784dc760ac70b8788e5a/lib/appium_lib/driver.rb#L401)
+##### [automation_name_is_xcuitest?](https://github.com/appium/ruby_lib/blob/54ff9c45df80ce901b718347e79e761f93a4316b/lib/appium_lib/driver.rb#L399)
-> def appium_server_version
+> def automation_name_is_xcuitest?
-Returns the server's version info
+Return true if automationName is 'XCUITest'
-```ruby
-{
- "build" => {
- "version" => "0.18.1",
- "revision" => "d242ebcfd92046a974347ccc3a28f0e898595198"
- }
-}
-```
+__Returns:__
+ [Boolean]
+
+--
+
+##### [check_server_version_xcuitest](https://github.com/appium/ruby_lib/blob/54ff9c45df80ce901b718347e79e761f93a4316b/lib/appium_lib/driver.rb#L406)
+
+> 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.
+
__Returns:__
- [Hash]
+ [Boolean]
--
-##### [absolute_app_path](https://github.com/appium/ruby_lib/blob/ad91ee47a96bf7a19b6f784dc760ac70b8788e5a/lib/appium_lib/driver.rb#L413)
+##### [absolute_app_path](https://github.com/appium/ruby_lib/blob/54ff9c45df80ce901b718347e79e761f93a4316b/lib/appium_lib/driver.rb#L437)
> def self.absolute_app_path(opts)
Converts app_path to an absolute path.
@@ -434,11 +467,11 @@
[String] APP_PATH as an absolute path
--
-##### [server_url](https://github.com/appium/ruby_lib/blob/ad91ee47a96bf7a19b6f784dc760ac70b8788e5a/lib/appium_lib/driver.rb#L446)
+##### [server_url](https://github.com/appium/ruby_lib/blob/54ff9c45df80ce901b718347e79e761f93a4316b/lib/appium_lib/driver.rb#L470)
> def server_url
Get the server url
@@ -446,11 +479,11 @@
[String] the server url
--
-##### [restart](https://github.com/appium/ruby_lib/blob/ad91ee47a96bf7a19b6f784dc760ac70b8788e5a/lib/appium_lib/driver.rb#L457)
+##### [restart](https://github.com/appium/ruby_lib/blob/54ff9c45df80ce901b718347e79e761f93a4316b/lib/appium_lib/driver.rb#L481)
> def restart
Restarts the driver
@@ -458,11 +491,11 @@
[Driver] the driver
--
-##### [screenshot](https://github.com/appium/ruby_lib/blob/ad91ee47a96bf7a19b6f784dc760ac70b8788e5a/lib/appium_lib/driver.rb#L468)
+##### [screenshot](https://github.com/appium/ruby_lib/blob/54ff9c45df80ce901b718347e79e761f93a4316b/lib/appium_lib/driver.rb#L492)
> def screenshot(png_save_path)
Takes a png screenshot and saves to the target path.
@@ -476,11 +509,11 @@
[nil]
--
-##### [driver_quit](https://github.com/appium/ruby_lib/blob/ad91ee47a96bf7a19b6f784dc760ac70b8788e5a/lib/appium_lib/driver.rb#L475)
+##### [driver_quit](https://github.com/appium/ruby_lib/blob/54ff9c45df80ce901b718347e79e761f93a4316b/lib/appium_lib/driver.rb#L499)
> def driver_quit
Quits the driver
@@ -488,11 +521,11 @@
[void]
--
-##### [start_driver](https://github.com/appium/ruby_lib/blob/ad91ee47a96bf7a19b6f784dc760ac70b8788e5a/lib/appium_lib/driver.rb#L484)
+##### [start_driver](https://github.com/appium/ruby_lib/blob/54ff9c45df80ce901b718347e79e761f93a4316b/lib/appium_lib/driver.rb#L508)
> def start_driver
Creates a new global driver and quits the old one if it exists.
@@ -500,19 +533,19 @@
[Selenium::WebDriver] the new global driver
--
-##### [no_wait](https://github.com/appium/ruby_lib/blob/ad91ee47a96bf7a19b6f784dc760ac70b8788e5a/lib/appium_lib/driver.rb#L517)
+##### [no_wait](https://github.com/appium/ruby_lib/blob/54ff9c45df80ce901b718347e79e761f93a4316b/lib/appium_lib/driver.rb#L545)
> def no_wait
Set implicit wait and default_wait to zero.
--
-##### [set_wait](https://github.com/appium/ruby_lib/blob/ad91ee47a96bf7a19b6f784dc760ac70b8788e5a/lib/appium_lib/driver.rb#L536)
+##### [set_wait](https://github.com/appium/ruby_lib/blob/54ff9c45df80ce901b718347e79e761f93a4316b/lib/appium_lib/driver.rb#L564)
> def set_wait(timeout = nil)
Set implicit wait and default_wait to timeout, defaults to 30.
if set_wait is called without a param then the second to last
@@ -533,11 +566,11 @@
[void]
--
-##### [exists](https://github.com/appium/ruby_lib/blob/ad91ee47a96bf7a19b6f784dc760ac70b8788e5a/lib/appium_lib/driver.rb#L563)
+##### [exists](https://github.com/appium/ruby_lib/blob/54ff9c45df80ce901b718347e79e761f93a4316b/lib/appium_lib/driver.rb#L591)
> def exists(pre_check = 0, post_check = @default_wait, &search_block)
Returns existence of element.
@@ -559,11 +592,11 @@
[Boolean]
--
-##### [execute_script](https://github.com/appium/ruby_lib/blob/ad91ee47a96bf7a19b6f784dc760ac70b8788e5a/lib/appium_lib/driver.rb#L587)
+##### [execute_script](https://github.com/appium/ruby_lib/blob/54ff9c45df80ce901b718347e79e761f93a4316b/lib/appium_lib/driver.rb#L615)
> def execute_script(script, *args)
The same as @driver.execute_script
@@ -577,11 +610,11 @@
[Object]
--
-##### [find_elements](https://github.com/appium/ruby_lib/blob/ad91ee47a96bf7a19b6f784dc760ac70b8788e5a/lib/appium_lib/driver.rb#L595)
+##### [find_elements](https://github.com/appium/ruby_lib/blob/54ff9c45df80ce901b718347e79e761f93a4316b/lib/appium_lib/driver.rb#L623)
> def find_elements(*args)
Calls @driver.find_elements
@@ -593,11 +626,11 @@
[Array<Element>] Array is empty when no elements are found.
--
-##### [find_element](https://github.com/appium/ruby_lib/blob/ad91ee47a96bf7a19b6f784dc760ac70b8788e5a/lib/appium_lib/driver.rb#L603)
+##### [find_element](https://github.com/appium/ruby_lib/blob/54ff9c45df80ce901b718347e79e761f93a4316b/lib/appium_lib/driver.rb#L631)
> def find_element(*args)
Calls @driver.find_elements
@@ -609,11 +642,11 @@
[Element]
--
-##### [set_location](https://github.com/appium/ruby_lib/blob/ad91ee47a96bf7a19b6f784dc760ac70b8788e5a/lib/appium_lib/driver.rb#L616)
+##### [set_location](https://github.com/appium/ruby_lib/blob/54ff9c45df80ce901b718347e79e761f93a4316b/lib/appium_lib/driver.rb#L644)
> def set_location(opts = {})
Calls @driver.set_location
@@ -625,11 +658,11 @@
[Selenium::WebDriver::Location] the location constructed by the selenium webdriver
--
-##### [x](https://github.com/appium/ruby_lib/blob/ad91ee47a96bf7a19b6f784dc760ac70b8788e5a/lib/appium_lib/driver.rb#L626)
+##### [x](https://github.com/appium/ruby_lib/blob/54ff9c45df80ce901b718347e79e761f93a4316b/lib/appium_lib/driver.rb#L654)
> def x
Quit the driver and Pry.
quit and exit are reserved by Pry.
@@ -638,11 +671,11 @@
[void]
--
-##### [logger=](https://github.com/appium/ruby_lib/blob/ad91ee47a96bf7a19b6f784dc760ac70b8788e5a/lib/appium_lib/logger.rb#L13)
+##### [logger=](https://github.com/appium/ruby_lib/blob/54ff9c45df80ce901b718347e79e761f93a4316b/lib/appium_lib/logger.rb#L13)
> def logger=(value)
Sets the attribute logger
@@ -650,95 +683,95 @@
value - the value to set the attribute logger to.
--
-##### [logger](https://github.com/appium/ruby_lib/blob/ad91ee47a96bf7a19b6f784dc760ac70b8788e5a/lib/appium_lib/logger.rb#L17)
+##### [logger](https://github.com/appium/ruby_lib/blob/54ff9c45df80ce901b718347e79e761f93a4316b/lib/appium_lib/logger.rb#L17)
> def logger
--
-##### [NoArgMethods](https://github.com/appium/ruby_lib/blob/ad91ee47a96bf7a19b6f784dc760ac70b8788e5a/lib/appium_lib/device/device.rb#L7)
+##### [NoArgMethods](https://github.com/appium/ruby_lib/blob/54ff9c45df80ce901b718347e79e761f93a4316b/lib/appium_lib/device/device.rb#L7)
> NoArgMethods = {
--
-##### [app_strings](https://github.com/appium/ruby_lib/blob/ad91ee47a96bf7a19b6f784dc760ac70b8788e5a/lib/appium_lib/device/device.rb#L25)
+##### [app_strings](https://github.com/appium/ruby_lib/blob/54ff9c45df80ce901b718347e79e761f93a4316b/lib/appium_lib/device/device.rb#L25)
> 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/ad91ee47a96bf7a19b6f784dc760ac70b8788e5a/lib/appium_lib/device/device.rb#L31)
+##### [background_app](https://github.com/appium/ruby_lib/blob/54ff9c45df80ce901b718347e79e761f93a4316b/lib/appium_lib/device/device.rb#L31)
> 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/ad91ee47a96bf7a19b6f784dc760ac70b8788e5a/lib/appium_lib/device/device.rb#L36)
+##### [current_activity](https://github.com/appium/ruby_lib/blob/54ff9c45df80ce901b718347e79e761f93a4316b/lib/appium_lib/device/device.rb#L36)
> def current_activity
--
-##### [launch_app](https://github.com/appium/ruby_lib/blob/ad91ee47a96bf7a19b6f784dc760ac70b8788e5a/lib/appium_lib/device/device.rb#L38)
+##### [launch_app](https://github.com/appium/ruby_lib/blob/54ff9c45df80ce901b718347e79e761f93a4316b/lib/appium_lib/device/device.rb#L38)
> def launch_app
Start the simulator and application configured with desired capabilities
--
-##### [reset](https://github.com/appium/ruby_lib/blob/ad91ee47a96bf7a19b6f784dc760ac70b8788e5a/lib/appium_lib/device/device.rb#L41)
+##### [reset](https://github.com/appium/ruby_lib/blob/54ff9c45df80ce901b718347e79e761f93a4316b/lib/appium_lib/device/device.rb#L41)
> def reset
Reset the device, relaunching the application.
--
-##### [shake](https://github.com/appium/ruby_lib/blob/ad91ee47a96bf7a19b6f784dc760ac70b8788e5a/lib/appium_lib/device/device.rb#L44)
+##### [shake](https://github.com/appium/ruby_lib/blob/54ff9c45df80ce901b718347e79e761f93a4316b/lib/appium_lib/device/device.rb#L44)
> def shake
Cause the device to shake
--
-##### [toggle_flight_mode](https://github.com/appium/ruby_lib/blob/ad91ee47a96bf7a19b6f784dc760ac70b8788e5a/lib/appium_lib/device/device.rb#L47)
+##### [toggle_flight_mode](https://github.com/appium/ruby_lib/blob/54ff9c45df80ce901b718347e79e761f93a4316b/lib/appium_lib/device/device.rb#L47)
> def toggle_flight_mode
Toggle flight mode on or off
--
-##### [device_locked?](https://github.com/appium/ruby_lib/blob/ad91ee47a96bf7a19b6f784dc760ac70b8788e5a/lib/appium_lib/device/device.rb#L50)
+##### [device_locked?](https://github.com/appium/ruby_lib/blob/54ff9c45df80ce901b718347e79e761f93a4316b/lib/appium_lib/device/device.rb#L50)
> def device_locked?
--
-##### [hide_keyboard](https://github.com/appium/ruby_lib/blob/ad91ee47a96bf7a19b6f784dc760ac70b8788e5a/lib/appium_lib/device/device.rb#L52)
+##### [hide_keyboard](https://github.com/appium/ruby_lib/blob/54ff9c45df80ce901b718347e79e761f93a4316b/lib/appium_lib/device/device.rb#L52)
> def hide_keyboard
Hide the onscreen keyboard
@@ -747,11 +780,11 @@
[String] close_key - the name of the key which closes the keyboard.
Defaults to 'Done'.
--
-##### [press_keycode](https://github.com/appium/ruby_lib/blob/ad91ee47a96bf7a19b6f784dc760ac70b8788e5a/lib/appium_lib/device/device.rb#L61)
+##### [press_keycode](https://github.com/appium/ruby_lib/blob/54ff9c45df80ce901b718347e79e761f93a4316b/lib/appium_lib/device/device.rb#L61)
> def press_keycode
Press keycode on the device.
http://developer.android.com/reference/android/view/KeyEvent.html
@@ -762,11 +795,11 @@
[String] metastate - The state the metakeys should be in when pressing the key.
--
-##### [long_press_keycode](https://github.com/appium/ruby_lib/blob/ad91ee47a96bf7a19b6f784dc760ac70b8788e5a/lib/appium_lib/device/device.rb#L67)
+##### [long_press_keycode](https://github.com/appium/ruby_lib/blob/54ff9c45df80ce901b718347e79e761f93a4316b/lib/appium_lib/device/device.rb#L67)
> def long_press_keycode
Long press keycode on the device.
http://developer.android.com/reference/android/view/KeyEvent.html
@@ -777,11 +810,11 @@
[String] metastate - The state the metakeys should be in when long pressing the key.
--
-##### [push_file](https://github.com/appium/ruby_lib/blob/ad91ee47a96bf7a19b6f784dc760ac70b8788e5a/lib/appium_lib/device/device.rb#L73)
+##### [push_file](https://github.com/appium/ruby_lib/blob/54ff9c45df80ce901b718347e79e761f93a4316b/lib/appium_lib/device/device.rb#L73)
> def push_file
Place a file in a specific location on the device.
@@ -791,11 +824,11 @@
[String] data - Raw file data to be sent to the device.
--
-##### [pull_file](https://github.com/appium/ruby_lib/blob/ad91ee47a96bf7a19b6f784dc760ac70b8788e5a/lib/appium_lib/device/device.rb#L78)
+##### [pull_file](https://github.com/appium/ruby_lib/blob/54ff9c45df80ce901b718347e79e761f93a4316b/lib/appium_lib/device/device.rb#L78)
> 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).
@@ -808,11 +841,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/ad91ee47a96bf7a19b6f784dc760ac70b8788e5a/lib/appium_lib/device/device.rb#L88)
+##### [pull_folder](https://github.com/appium/ruby_lib/blob/54ff9c45df80ce901b718347e79e761f93a4316b/lib/appium_lib/device/device.rb#L88)
> def pull_folder
Retrieve a folder from the device.
```ruby
@@ -823,11 +856,11 @@
[String] path - absolute path to the folder
--
-##### [touch_id](https://github.com/appium/ruby_lib/blob/ad91ee47a96bf7a19b6f784dc760ac70b8788e5a/lib/appium_lib/device/device.rb#L96)
+##### [touch_id](https://github.com/appium/ruby_lib/blob/54ff9c45df80ce901b718347e79e761f93a4316b/lib/appium_lib/device/device.rb#L96)
> def touch_id
iOS only; Simulate Touch ID with either valid (match == true) or invalid (match == false) fingerprint.
```ruby
@@ -840,11 +873,11 @@
[Boolean] match - fingerprint validity
Defaults to true.
--
-##### [end_coverage](https://github.com/appium/ruby_lib/blob/ad91ee47a96bf7a19b6f784dc760ac70b8788e5a/lib/appium_lib/device/device.rb#L105)
+##### [end_coverage](https://github.com/appium/ruby_lib/blob/54ff9c45df80ce901b718347e79e761f93a4316b/lib/appium_lib/device/device.rb#L105)
> def end_coverage
Android only; Ends the test coverage and writes the results to the given path on device.
@@ -854,35 +887,35 @@
[String] intent - Intent to broadcast when ending coverage.
--
-##### [get_settings](https://github.com/appium/ruby_lib/blob/ad91ee47a96bf7a19b6f784dc760ac70b8788e5a/lib/appium_lib/device/device.rb#L110)
+##### [get_settings](https://github.com/appium/ruby_lib/blob/54ff9c45df80ce901b718347e79e761f93a4316b/lib/appium_lib/device/device.rb#L110)
> def get_settings
Get appium Settings for current test session
--
-##### [extend_search_contexts](https://github.com/appium/ruby_lib/blob/ad91ee47a96bf7a19b6f784dc760ac70b8788e5a/lib/appium_lib/device/device.rb#L394)
+##### [extend_search_contexts](https://github.com/appium/ruby_lib/blob/54ff9c45df80ce901b718347e79e761f93a4316b/lib/appium_lib/device/device.rb#L400)
> def extend_search_contexts
--
-##### [find_element](https://github.com/appium/ruby_lib/blob/ad91ee47a96bf7a19b6f784dc760ac70b8788e5a/lib/appium_lib/device/device.rb#L394)
+##### [find_element](https://github.com/appium/ruby_lib/blob/54ff9c45df80ce901b718347e79e761f93a4316b/lib/appium_lib/device/device.rb#L400)
> def find_element
--
-##### [find_elements](https://github.com/appium/ruby_lib/blob/ad91ee47a96bf7a19b6f784dc760ac70b8788e5a/lib/appium_lib/device/device.rb#L394)
+##### [find_elements](https://github.com/appium/ruby_lib/blob/54ff9c45df80ce901b718347e79e761f93a4316b/lib/appium_lib/device/device.rb#L400)
> def find_elements
find_element/s with their accessibility_id
@@ -890,27 +923,27 @@
find_elements :accessibility_id, 'Animation'
```
--
-##### [add_touch_actions](https://github.com/appium/ruby_lib/blob/ad91ee47a96bf7a19b6f784dc760ac70b8788e5a/lib/appium_lib/device/device.rb#L400)
+##### [add_touch_actions](https://github.com/appium/ruby_lib/blob/54ff9c45df80ce901b718347e79e761f93a4316b/lib/appium_lib/device/device.rb#L406)
> def add_touch_actions
--
-##### [add_ime_actions](https://github.com/appium/ruby_lib/blob/ad91ee47a96bf7a19b6f784dc760ac70b8788e5a/lib/appium_lib/device/device.rb#L423)
+##### [add_ime_actions](https://github.com/appium/ruby_lib/blob/54ff9c45df80ce901b718347e79e761f93a4316b/lib/appium_lib/device/device.rb#L429)
> def add_ime_actions
--
-##### [set_context](https://github.com/appium/ruby_lib/blob/ad91ee47a96bf7a19b6f784dc760ac70b8788e5a/lib/appium_lib/device/device.rb#L498)
+##### [set_context](https://github.com/appium/ruby_lib/blob/54ff9c45df80ce901b718347e79e761f93a4316b/lib/appium_lib/device/device.rb#L504)
> def set_context
Change the context to the given context.
```ruby
@@ -921,11 +954,11 @@
[String] The - context to change to
--
-##### [current_context](https://github.com/appium/ruby_lib/blob/ad91ee47a96bf7a19b6f784dc760ac70b8788e5a/lib/appium_lib/device/device.rb#L506)
+##### [current_context](https://github.com/appium/ruby_lib/blob/54ff9c45df80ce901b718347e79e761f93a4316b/lib/appium_lib/device/device.rb#L512)
> def current_context
@@ -933,11 +966,11 @@
[String] The context currently being used.
--
-##### [available_contexts](https://github.com/appium/ruby_lib/blob/ad91ee47a96bf7a19b6f784dc760ac70b8788e5a/lib/appium_lib/device/device.rb#L509)
+##### [available_contexts](https://github.com/appium/ruby_lib/blob/54ff9c45df80ce901b718347e79e761f93a4316b/lib/appium_lib/device/device.rb#L515)
> def available_contexts
@@ -945,11 +978,11 @@
[Array<String>] All usable contexts, as an array of strings.
--
-##### [within_context](https://github.com/appium/ruby_lib/blob/ad91ee47a96bf7a19b6f784dc760ac70b8788e5a/lib/appium_lib/device/device.rb#L519)
+##### [within_context](https://github.com/appium/ruby_lib/blob/54ff9c45df80ce901b718347e79e761f93a4316b/lib/appium_lib/device/device.rb#L525)
> def within_context(context)
Perform a block within the given context, then switch back to the starting context.
```ruby
@@ -961,19 +994,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/ad91ee47a96bf7a19b6f784dc760ac70b8788e5a/lib/appium_lib/device/device.rb#L527)
+##### [switch_to_default_context](https://github.com/appium/ruby_lib/blob/54ff9c45df80ce901b718347e79e761f93a4316b/lib/appium_lib/device/device.rb#L533)
> 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/ad91ee47a96bf7a19b6f784dc760ac70b8788e5a/lib/appium_lib/device/multi_touch.rb#L28)
+##### [pinch](https://github.com/appium/ruby_lib/blob/54ff9c45df80ce901b718347e79e761f93a4316b/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.
@@ -988,11 +1021,11 @@
[boolean] auto_perform - Whether to perform the action immediately (default true)
--
-##### [zoom](https://github.com/appium/ruby_lib/blob/ad91ee47a96bf7a19b6f784dc760ac70b8788e5a/lib/appium_lib/device/multi_touch.rb#L56)
+##### [zoom](https://github.com/appium/ruby_lib/blob/54ff9c45df80ce901b718347e79e761f93a4316b/lib/appium_lib/device/multi_touch.rb#L64)
> def zoom(percentage = 200, auto_perform = true)
Convenience method for zooming the screen.
Places two fingers at the edges of the screen and brings them together.
@@ -1007,11 +1040,11 @@
[boolean] auto_perform - Whether to perform the action immediately (default true)
--
-##### [initialize](https://github.com/appium/ruby_lib/blob/ad91ee47a96bf7a19b6f784dc760ac70b8788e5a/lib/appium_lib/device/multi_touch.rb#L77)
+##### [initialize](https://github.com/appium/ruby_lib/blob/54ff9c45df80ce901b718347e79e761f93a4316b/lib/appium_lib/device/multi_touch.rb#L95)
> def initialize
Create a new multi-action
@@ -1019,11 +1052,11 @@
[MultiTouch] a new instance of MultiTouch
--
-##### [add](https://github.com/appium/ruby_lib/blob/ad91ee47a96bf7a19b6f784dc760ac70b8788e5a/lib/appium_lib/device/multi_touch.rb#L83)
+##### [add](https://github.com/appium/ruby_lib/blob/54ff9c45df80ce901b718347e79e761f93a4316b/lib/appium_lib/device/multi_touch.rb#L101)
> def add(chain)
Add a touch_action to be performed
@@ -1031,43 +1064,43 @@
[TouchAction] chain - The action to add to the chain
--
-##### [perform](https://github.com/appium/ruby_lib/blob/ad91ee47a96bf7a19b6f784dc760ac70b8788e5a/lib/appium_lib/device/multi_touch.rb#L88)
+##### [perform](https://github.com/appium/ruby_lib/blob/54ff9c45df80ce901b718347e79e761f93a4316b/lib/appium_lib/device/multi_touch.rb#L106)
> def perform
Ask Appium to perform the actions
--
-##### [ACTIONS](https://github.com/appium/ruby_lib/blob/ad91ee47a96bf7a19b6f784dc760ac70b8788e5a/lib/appium_lib/device/touch_actions.rb#L11)
+##### [ACTIONS](https://github.com/appium/ruby_lib/blob/54ff9c45df80ce901b718347e79e761f93a4316b/lib/appium_lib/device/touch_actions.rb#L11)
> ACTIONS = [:move_to, :long_press, :double_tap, :two_finger_tap, :press, :release, :tap, :wait, :perform]
--
-##### [COMPLEX_ACTIONS](https://github.com/appium/ruby_lib/blob/ad91ee47a96bf7a19b6f784dc760ac70b8788e5a/lib/appium_lib/device/touch_actions.rb#L12)
+##### [COMPLEX_ACTIONS](https://github.com/appium/ruby_lib/blob/54ff9c45df80ce901b718347e79e761f93a4316b/lib/appium_lib/device/touch_actions.rb#L12)
> COMPLEX_ACTIONS = [:swipe]
--
-##### [actions](https://github.com/appium/ruby_lib/blob/ad91ee47a96bf7a19b6f784dc760ac70b8788e5a/lib/appium_lib/device/touch_actions.rb#L26)
+##### [actions](https://github.com/appium/ruby_lib/blob/54ff9c45df80ce901b718347e79e761f93a4316b/lib/appium_lib/device/touch_actions.rb#L26)
> def actions
Returns the value of attribute actions
--
-##### [initialize](https://github.com/appium/ruby_lib/blob/ad91ee47a96bf7a19b6f784dc760ac70b8788e5a/lib/appium_lib/device/touch_actions.rb#L28)
+##### [initialize](https://github.com/appium/ruby_lib/blob/54ff9c45df80ce901b718347e79e761f93a4316b/lib/appium_lib/device/touch_actions.rb#L28)
> def initialize
@@ -1075,11 +1108,11 @@
[TouchAction] a new instance of TouchAction
--
-##### [move_to](https://github.com/appium/ruby_lib/blob/ad91ee47a96bf7a19b6f784dc760ac70b8788e5a/lib/appium_lib/device/touch_actions.rb#L36)
+##### [move_to](https://github.com/appium/ruby_lib/blob/54ff9c45df80ce901b718347e79e761f93a4316b/lib/appium_lib/device/touch_actions.rb#L36)
> def move_to(opts)
Move to the given co-ordinates.
@@ -1087,11 +1120,11 @@
[Hash] opts - a customizable set of options
--
-##### [long_press](https://github.com/appium/ruby_lib/blob/ad91ee47a96bf7a19b6f784dc760ac70b8788e5a/lib/appium_lib/device/touch_actions.rb#L46)
+##### [long_press](https://github.com/appium/ruby_lib/blob/54ff9c45df80ce901b718347e79e761f93a4316b/lib/appium_lib/device/touch_actions.rb#L46)
> def long_press(opts)
Press down for a specific duration.
@@ -1105,11 +1138,11 @@
[Hash] duration - a customizable set of options
--
-##### [press](https://github.com/appium/ruby_lib/blob/ad91ee47a96bf7a19b6f784dc760ac70b8788e5a/lib/appium_lib/device/touch_actions.rb#L58)
+##### [press](https://github.com/appium/ruby_lib/blob/54ff9c45df80ce901b718347e79e761f93a4316b/lib/appium_lib/device/touch_actions.rb#L58)
> def press(opts)
Press a finger onto the screen. Finger will stay down until you call
`release`.
@@ -1118,11 +1151,11 @@
[Hash] opts - a customizable set of options
--
-##### [release](https://github.com/appium/ruby_lib/blob/ad91ee47a96bf7a19b6f784dc760ac70b8788e5a/lib/appium_lib/device/touch_actions.rb#L69)
+##### [release](https://github.com/appium/ruby_lib/blob/54ff9c45df80ce901b718347e79e761f93a4316b/lib/appium_lib/device/touch_actions.rb#L69)
> def release(opts = nil)
Remove a finger from the screen.
@@ -1130,11 +1163,11 @@
[Hash] opts - a customizable set of options
--
-##### [tap](https://github.com/appium/ruby_lib/blob/ad91ee47a96bf7a19b6f784dc760ac70b8788e5a/lib/appium_lib/device/touch_actions.rb#L80)
+##### [tap](https://github.com/appium/ruby_lib/blob/54ff9c45df80ce901b718347e79e761f93a4316b/lib/appium_lib/device/touch_actions.rb#L80)
> def tap(opts)
Touch a point on the screen
@@ -1142,11 +1175,11 @@
[Hash] opts - a customizable set of options
--
-##### [double_tap](https://github.com/appium/ruby_lib/blob/ad91ee47a96bf7a19b6f784dc760ac70b8788e5a/lib/appium_lib/device/touch_actions.rb#L93)
+##### [double_tap](https://github.com/appium/ruby_lib/blob/54ff9c45df80ce901b718347e79e761f93a4316b/lib/appium_lib/device/touch_actions.rb#L93)
> def double_tap(opts)
Double tap an element on the screen
@@ -1154,11 +1187,11 @@
[Hash] opts - a customizable set of options
--
-##### [two_finger_tap](https://github.com/appium/ruby_lib/blob/ad91ee47a96bf7a19b6f784dc760ac70b8788e5a/lib/appium_lib/device/touch_actions.rb#L104)
+##### [two_finger_tap](https://github.com/appium/ruby_lib/blob/54ff9c45df80ce901b718347e79e761f93a4316b/lib/appium_lib/device/touch_actions.rb#L104)
> def two_finger_tap(opts)
Two finger tap an element on the screen
@@ -1166,11 +1199,11 @@
[Hash] opts - a customizable set of options
--
-##### [wait](https://github.com/appium/ruby_lib/blob/ad91ee47a96bf7a19b6f784dc760ac70b8788e5a/lib/appium_lib/device/touch_actions.rb#L112)
+##### [wait](https://github.com/appium/ruby_lib/blob/54ff9c45df80ce901b718347e79e761f93a4316b/lib/appium_lib/device/touch_actions.rb#L112)
> def wait(milliseconds)
Pause for a number of milliseconds before the next action
@@ -1178,13 +1211,13 @@
[integer] milliseconds - Number of milliseconds to pause for
--
-##### [swipe](https://github.com/appium/ruby_lib/blob/ad91ee47a96bf7a19b6f784dc760ac70b8788e5a/lib/appium_lib/device/touch_actions.rb#L127)
+##### [swipe](https://github.com/appium/ruby_lib/blob/54ff9c45df80ce901b718347e79e761f93a4316b/lib/appium_lib/device/touch_actions.rb#L127)
-> def swipe(opts)
+> def swipe(opts, ele = nil)
Convenience method to peform a swipe.
Note that iOS 7 simulators have broken swipe.
@@ -1192,60 +1225,60 @@
[Hash] opts - a customizable set of options
--
-##### [perform](https://github.com/appium/ruby_lib/blob/ad91ee47a96bf7a19b6f784dc760ac70b8788e5a/lib/appium_lib/device/touch_actions.rb#L155)
+##### [perform](https://github.com/appium/ruby_lib/blob/54ff9c45df80ce901b718347e79e761f93a4316b/lib/appium_lib/device/touch_actions.rb#L162)
> def perform
Ask the driver to perform all actions in this action chain.
--
-##### [cancel](https://github.com/appium/ruby_lib/blob/ad91ee47a96bf7a19b6f784dc760ac70b8788e5a/lib/appium_lib/device/touch_actions.rb#L161)
+##### [cancel](https://github.com/appium/ruby_lib/blob/54ff9c45df80ce901b718347e79e761f93a4316b/lib/appium_lib/device/touch_actions.rb#L168)
> def cancel
Does nothing, currently.
--
-##### [chain_method](https://github.com/appium/ruby_lib/blob/ad91ee47a96bf7a19b6f784dc760ac70b8788e5a/lib/appium_lib/device/touch_actions.rb#L169)
+##### [chain_method](https://github.com/appium/ruby_lib/blob/54ff9c45df80ce901b718347e79e761f93a4316b/lib/appium_lib/device/touch_actions.rb#L176)
> def chain_method(method, args = nil)
--
-##### [args_with_ele_ref](https://github.com/appium/ruby_lib/blob/ad91ee47a96bf7a19b6f784dc760ac70b8788e5a/lib/appium_lib/device/touch_actions.rb#L178)
+##### [args_with_ele_ref](https://github.com/appium/ruby_lib/blob/54ff9c45df80ce901b718347e79e761f93a4316b/lib/appium_lib/device/touch_actions.rb#L185)
> def args_with_ele_ref(args)
--
-##### [_generic_wait](https://github.com/appium/ruby_lib/blob/ad91ee47a96bf7a19b6f784dc760ac70b8788e5a/lib/appium_lib/common/wait.rb#L9)
+##### [_generic_wait](https://github.com/appium/ruby_lib/blob/54ff9c45df80ce901b718347e79e761f93a4316b/lib/appium_lib/common/wait.rb#L9)
> def _generic_wait(opts = {}, &block)
Wait code from the selenium Ruby gem
https://github.com/SeleniumHQ/selenium/blob/cf501dda3f0ed12233de51ce8170c0e8090f0c20/rb/lib/selenium/webdriver/common/wait.rb
--
-##### [_process_wait_opts](https://github.com/appium/ruby_lib/blob/ad91ee47a96bf7a19b6f784dc760ac70b8788e5a/lib/appium_lib/common/wait.rb#L54)
+##### [_process_wait_opts](https://github.com/appium/ruby_lib/blob/54ff9c45df80ce901b718347e79e761f93a4316b/lib/appium_lib/common/wait.rb#L54)
> def _process_wait_opts(opts)
process opts before calling _generic_wait
--
-##### [wait_true](https://github.com/appium/ruby_lib/blob/ad91ee47a96bf7a19b6f784dc760ac70b8788e5a/lib/appium_lib/common/wait.rb#L75)
+##### [wait_true](https://github.com/appium/ruby_lib/blob/54ff9c45df80ce901b718347e79e761f93a4316b/lib/appium_lib/common/wait.rb#L75)
> def wait_true(opts = {}, &block)
Check every interval seconds to see if block.call returns a truthy value.
Note this isn't a strict boolean true, any truthy value is accepted.
@@ -1261,11 +1294,11 @@
[Hash] opts - Options
--
-##### [wait](https://github.com/appium/ruby_lib/blob/ad91ee47a96bf7a19b6f784dc760ac70b8788e5a/lib/appium_lib/common/wait.rb#L93)
+##### [wait](https://github.com/appium/ruby_lib/blob/54ff9c45df80ce901b718347e79e761f93a4316b/lib/appium_lib/common/wait.rb#L93)
> def wait(opts = {}, &block)
Check every interval seconds to see if block.call doesn't raise an exception.
Give up after timeout seconds.
@@ -1279,19 +1312,19 @@
[Hash] opts - Options
--
-##### [ignore](https://github.com/appium/ruby_lib/blob/ad91ee47a96bf7a19b6f784dc760ac70b8788e5a/lib/appium_lib/common/helper.rb#L24)
+##### [ignore](https://github.com/appium/ruby_lib/blob/54ff9c45df80ce901b718347e79e761f93a4316b/lib/appium_lib/common/helper.rb#L24)
> def ignore(&block)
Return block.call and ignore any exceptions.
--
-##### [back](https://github.com/appium/ruby_lib/blob/ad91ee47a96bf7a19b6f784dc760ac70b8788e5a/lib/appium_lib/common/helper.rb#L31)
+##### [back](https://github.com/appium/ruby_lib/blob/54ff9c45df80ce901b718347e79e761f93a4316b/lib/appium_lib/common/helper.rb#L31)
> def back
Navigate back.
@@ -1299,19 +1332,19 @@
[void]
--
-##### [session_id](https://github.com/appium/ruby_lib/blob/ad91ee47a96bf7a19b6f784dc760ac70b8788e5a/lib/appium_lib/common/helper.rb#L36)
+##### [session_id](https://github.com/appium/ruby_lib/blob/54ff9c45df80ce901b718347e79e761f93a4316b/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/ad91ee47a96bf7a19b6f784dc760ac70b8788e5a/lib/appium_lib/common/helper.rb#L44)
+##### [xpath](https://github.com/appium/ruby_lib/blob/54ff9c45df80ce901b718347e79e761f93a4316b/lib/appium_lib/common/helper.rb#L44)
> def xpath(xpath_str)
Returns the first element that matches the provided xpath.
@@ -1323,11 +1356,11 @@
[Element]
--
-##### [xpaths](https://github.com/appium/ruby_lib/blob/ad91ee47a96bf7a19b6f784dc760ac70b8788e5a/lib/appium_lib/common/helper.rb#L52)
+##### [xpaths](https://github.com/appium/ruby_lib/blob/54ff9c45df80ce901b718347e79e761f93a4316b/lib/appium_lib/common/helper.rb#L52)
> def xpaths(xpath_str)
Returns all elements that match the provided xpath.
@@ -1339,27 +1372,27 @@
[Array<Element>]
--
-##### [_print_source](https://github.com/appium/ruby_lib/blob/ad91ee47a96bf7a19b6f784dc760ac70b8788e5a/lib/appium_lib/common/helper.rb#L56)
+##### [_print_source](https://github.com/appium/ruby_lib/blob/54ff9c45df80ce901b718347e79e761f93a4316b/lib/appium_lib/common/helper.rb#L56)
> def _print_source(source)
--
-##### [result](https://github.com/appium/ruby_lib/blob/ad91ee47a96bf7a19b6f784dc760ac70b8788e5a/lib/appium_lib/common/helper.rb#L69)
+##### [result](https://github.com/appium/ruby_lib/blob/54ff9c45df80ce901b718347e79e761f93a4316b/lib/appium_lib/common/helper.rb#L69)
> def result
Returns the value of attribute result
--
-##### [initialize](https://github.com/appium/ruby_lib/blob/ad91ee47a96bf7a19b6f784dc760ac70b8788e5a/lib/appium_lib/common/helper.rb#L71)
+##### [initialize](https://github.com/appium/ruby_lib/blob/54ff9c45df80ce901b718347e79e761f93a4316b/lib/appium_lib/common/helper.rb#L71)
> def initialize
@@ -1367,52 +1400,52 @@
[CountElements] a new instance of CountElements
--
-##### [reset](https://github.com/appium/ruby_lib/blob/ad91ee47a96bf7a19b6f784dc760ac70b8788e5a/lib/appium_lib/common/helper.rb#L75)
+##### [reset](https://github.com/appium/ruby_lib/blob/54ff9c45df80ce901b718347e79e761f93a4316b/lib/appium_lib/common/helper.rb#L75)
> def reset
--
-##### [start_element](https://github.com/appium/ruby_lib/blob/ad91ee47a96bf7a19b6f784dc760ac70b8788e5a/lib/appium_lib/common/helper.rb#L80)
+##### [start_element](https://github.com/appium/ruby_lib/blob/54ff9c45df80ce901b718347e79e761f93a4316b/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/ad91ee47a96bf7a19b6f784dc760ac70b8788e5a/lib/appium_lib/common/helper.rb#L86)
+##### [formatted_result](https://github.com/appium/ruby_lib/blob/54ff9c45df80ce901b718347e79e761f93a4316b/lib/appium_lib/common/helper.rb#L86)
> def formatted_result
--
-##### [get_page_class](https://github.com/appium/ruby_lib/blob/ad91ee47a96bf7a19b6f784dc760ac70b8788e5a/lib/appium_lib/common/helper.rb#L97)
+##### [get_page_class](https://github.com/appium/ruby_lib/blob/54ff9c45df80ce901b718347e79e761f93a4316b/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/ad91ee47a96bf7a19b6f784dc760ac70b8788e5a/lib/appium_lib/common/helper.rb#L108)
+##### [page_class](https://github.com/appium/ruby_lib/blob/54ff9c45df80ce901b718347e79e761f93a4316b/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/ad91ee47a96bf7a19b6f784dc760ac70b8788e5a/lib/appium_lib/common/helper.rb#L118)
+##### [px_to_window_rel](https://github.com/appium/ruby_lib/blob/54ff9c45df80ce901b718347e79e761f93a4316b/lib/appium_lib/common/helper.rb#L118)
> def px_to_window_rel(opts = {})
Converts pixel values to window relative values
@@ -1420,11 +1453,11 @@
px_to_window_rel x: 50, y: 150
```
--
-##### [xml_keys](https://github.com/appium/ruby_lib/blob/ad91ee47a96bf7a19b6f784dc760ac70b8788e5a/lib/appium_lib/common/helper.rb#L137)
+##### [xml_keys](https://github.com/appium/ruby_lib/blob/54ff9c45df80ce901b718347e79e761f93a4316b/lib/appium_lib/common/helper.rb#L137)
> def xml_keys(target)
Search strings.xml's values for target.
@@ -1436,11 +1469,11 @@
[Array]
--
-##### [xml_values](https://github.com/appium/ruby_lib/blob/ad91ee47a96bf7a19b6f784dc760ac70b8788e5a/lib/appium_lib/common/helper.rb#L145)
+##### [xml_values](https://github.com/appium/ruby_lib/blob/54ff9c45df80ce901b718347e79e761f93a4316b/lib/appium_lib/common/helper.rb#L145)
> def xml_values(target)
Search strings.xml's keys for target.
@@ -1452,11 +1485,11 @@
[Array]
--
-##### [resolve_id](https://github.com/appium/ruby_lib/blob/ad91ee47a96bf7a19b6f784dc760ac70b8788e5a/lib/appium_lib/common/helper.rb#L153)
+##### [resolve_id](https://github.com/appium/ruby_lib/blob/54ff9c45df80ce901b718347e79e761f93a4316b/lib/appium_lib/common/helper.rb#L153)
> def resolve_id(id)
Resolve id in strings.xml and return the value.
@@ -1468,27 +1501,27 @@
[String]
--
-##### [filter](https://github.com/appium/ruby_lib/blob/ad91ee47a96bf7a19b6f784dc760ac70b8788e5a/lib/appium_lib/common/helper.rb#L159)
+##### [filter](https://github.com/appium/ruby_lib/blob/54ff9c45df80ce901b718347e79e761f93a4316b/lib/appium_lib/common/helper.rb#L159)
> def filter
Returns the value of attribute filter
--
-##### [filter=](https://github.com/appium/ruby_lib/blob/ad91ee47a96bf7a19b6f784dc760ac70b8788e5a/lib/appium_lib/common/helper.rb#L162)
+##### [filter=](https://github.com/appium/ruby_lib/blob/54ff9c45df80ce901b718347e79e761f93a4316b/lib/appium_lib/common/helper.rb#L162)
> def filter=(value)
convert to string to support symbols
--
-##### [initialize](https://github.com/appium/ruby_lib/blob/ad91ee47a96bf7a19b6f784dc760ac70b8788e5a/lib/appium_lib/common/helper.rb#L168)
+##### [initialize](https://github.com/appium/ruby_lib/blob/54ff9c45df80ce901b718347e79e761f93a4316b/lib/appium_lib/common/helper.rb#L168)
> def initialize
@@ -1496,68 +1529,104 @@
[HTMLElements] a new instance of HTMLElements
--
-##### [reset](https://github.com/appium/ruby_lib/blob/ad91ee47a96bf7a19b6f784dc760ac70b8788e5a/lib/appium_lib/common/helper.rb#L173)
+##### [reset](https://github.com/appium/ruby_lib/blob/54ff9c45df80ce901b718347e79e761f93a4316b/lib/appium_lib/common/helper.rb#L173)
> def reset
--
-##### [result](https://github.com/appium/ruby_lib/blob/ad91ee47a96bf7a19b6f784dc760ac70b8788e5a/lib/appium_lib/common/helper.rb#L179)
+##### [result](https://github.com/appium/ruby_lib/blob/54ff9c45df80ce901b718347e79e761f93a4316b/lib/appium_lib/common/helper.rb#L179)
> def result
--
-##### [start_element](https://github.com/appium/ruby_lib/blob/ad91ee47a96bf7a19b6f784dc760ac70b8788e5a/lib/appium_lib/common/helper.rb#L195)
+##### [start_element](https://github.com/appium/ruby_lib/blob/54ff9c45df80ce901b718347e79e761f93a4316b/lib/appium_lib/common/helper.rb#L195)
> def start_element(name, attrs = [])
--
-##### [end_element](https://github.com/appium/ruby_lib/blob/ad91ee47a96bf7a19b6f784dc760ac70b8788e5a/lib/appium_lib/common/helper.rb#L204)
+##### [end_element](https://github.com/appium/ruby_lib/blob/54ff9c45df80ce901b718347e79e761f93a4316b/lib/appium_lib/common/helper.rb#L204)
> def end_element(name)
--
-##### [characters](https://github.com/appium/ruby_lib/blob/ad91ee47a96bf7a19b6f784dc760ac70b8788e5a/lib/appium_lib/common/helper.rb#L210)
+##### [characters](https://github.com/appium/ruby_lib/blob/54ff9c45df80ce901b718347e79e761f93a4316b/lib/appium_lib/common/helper.rb#L210)
> def characters(chars)
--
-##### [_no_such_element](https://github.com/appium/ruby_lib/blob/ad91ee47a96bf7a19b6f784dc760ac70b8788e5a/lib/appium_lib/common/helper.rb#L217)
+##### [_no_such_element](https://github.com/appium/ruby_lib/blob/54ff9c45df80ce901b718347e79e761f93a4316b/lib/appium_lib/common/helper.rb#L217)
> def _no_such_element
--
-##### [window_size](https://github.com/appium/ruby_lib/blob/ad91ee47a96bf7a19b6f784dc760ac70b8788e5a/lib/appium_lib/common/element/window.rb#L5)
+##### [window_size](https://github.com/appium/ruby_lib/blob/54ff9c45df80ce901b718347e79e761f93a4316b/lib/appium_lib/common/element/window.rb#L5)
> def window_size
Get the window's size
--
-##### [ios_password](https://github.com/appium/ruby_lib/blob/ad91ee47a96bf7a19b6f784dc760ac70b8788e5a/lib/appium_lib/ios/helper.rb#L8) ios
+##### [filter](https://github.com/appium/ruby_lib/blob/54ff9c45df80ce901b718347e79e761f93a4316b/lib/appium_lib/ios/helper.rb#L4) ios
+> def filter
+
+Returns the value of attribute filter
+
+--
+
+##### [filter=](https://github.com/appium/ruby_lib/blob/54ff9c45df80ce901b718347e79e761f93a4316b/lib/appium_lib/ios/helper.rb#L4) ios
+
+> def filter=(value)
+
+Sets the attribute filter
+
+__Parameters:__
+
+ value - the value to set the attribute filter to.
+
+--
+
+##### [start_element](https://github.com/appium/ruby_lib/blob/54ff9c45df80ce901b718347e79e761f93a4316b/lib/appium_lib/ios/helper.rb#L6) ios
+
+> def start_element(type, attrs = [])
+
+
+
+--
+
+##### [_print_attr](https://github.com/appium/ruby_lib/blob/54ff9c45df80ce901b718347e79e761f93a4316b/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/54ff9c45df80ce901b718347e79e761f93a4316b/lib/appium_lib/ios/helper.rb#L44) ios
+
> def ios_password(length = 1)
iOS only. On Android uiautomator always returns an empty string for EditText password.
Password character returned from value of UIASecureTextField
@@ -1570,11 +1639,11 @@
[String] the returned string is of size length
--
-##### [get_page](https://github.com/appium/ruby_lib/blob/ad91ee47a96bf7a19b6f784dc760ac70b8788e5a/lib/appium_lib/ios/helper.rb#L20) ios
+##### [get_page](https://github.com/appium/ruby_lib/blob/54ff9c45df80ce901b718347e79e761f93a4316b/lib/appium_lib/ios/helper.rb#L56) ios
> def get_page(element = source_window(0), class_name = nil)
Returns a string of interesting elements. iOS only.
@@ -1591,11 +1660,11 @@
[String]
--
-##### [page](https://github.com/appium/ruby_lib/blob/ad91ee47a96bf7a19b6f784dc760ac70b8788e5a/lib/appium_lib/ios/helper.rb#L129) ios
+##### [page](https://github.com/appium/ruby_lib/blob/54ff9c45df80ce901b718347e79e761f93a4316b/lib/appium_lib/ios/helper.rb#L165) ios
> def page(opts = {})
Prints a string of interesting elements to the console.
@@ -1617,13 +1686,13 @@
[void]
--
-##### [source_window](https://github.com/appium/ruby_lib/blob/ad91ee47a96bf7a19b6f784dc760ac70b8788e5a/lib/appium_lib/ios/helper.rb#L161) ios
+##### [source_window](https://github.com/appium/ruby_lib/blob/54ff9c45df80ce901b718347e79e761f93a4316b/lib/appium_lib/ios/helper.rb#L196) ios
-> def source_window(window_number = 0)
+> def source_window(_window_number = 0)
Gets the JSON source of window number
__Parameters:__
@@ -1633,11 +1702,11 @@
[JSON]
--
-##### [page_window](https://github.com/appium/ruby_lib/blob/ad91ee47a96bf7a19b6f784dc760ac70b8788e5a/lib/appium_lib/ios/helper.rb#L175) ios
+##### [page_window](https://github.com/appium/ruby_lib/blob/54ff9c45df80ce901b718347e79e761f93a4316b/lib/appium_lib/ios/helper.rb#L211) ios
> def page_window(window_number = 0)
Prints parsed page source to console.
@@ -1651,11 +1720,11 @@
[void]
--
-##### [id](https://github.com/appium/ruby_lib/blob/ad91ee47a96bf7a19b6f784dc760ac70b8788e5a/lib/appium_lib/ios/helper.rb#L183) ios
+##### [id](https://github.com/appium/ruby_lib/blob/54ff9c45df80ce901b718347e79e761f93a4316b/lib/appium_lib/ios/helper.rb#L219) ios
> def id(id)
Find by id
@@ -1667,11 +1736,11 @@
[Element]
--
-##### [ios_version](https://github.com/appium/ruby_lib/blob/ad91ee47a96bf7a19b6f784dc760ac70b8788e5a/lib/appium_lib/ios/helper.rb#L189) ios
+##### [ios_version](https://github.com/appium/ruby_lib/blob/54ff9c45df80ce901b718347e79e761f93a4316b/lib/appium_lib/ios/helper.rb#L225) ios
> def ios_version
Return the iOS version as an array of integers
@@ -1679,11 +1748,11 @@
[Array<Integer>]
--
-##### [ele_index](https://github.com/appium/ruby_lib/blob/ad91ee47a96bf7a19b6f784dc760ac70b8788e5a/lib/appium_lib/ios/helper.rb#L198) ios
+##### [ele_index](https://github.com/appium/ruby_lib/blob/54ff9c45df80ce901b718347e79e761f93a4316b/lib/appium_lib/ios/helper.rb#L238) ios
> def ele_index(class_name, index)
Get the element of type class_name at matching index.
@@ -1697,11 +1766,11 @@
[Element]
--
-##### [find_ele_by_attr](https://github.com/appium/ruby_lib/blob/ad91ee47a96bf7a19b6f784dc760ac70b8788e5a/lib/appium_lib/ios/helper.rb#L225) ios
+##### [find_ele_by_attr](https://github.com/appium/ruby_lib/blob/54ff9c45df80ce901b718347e79e761f93a4316b/lib/appium_lib/ios/helper.rb#L273) ios
> def find_ele_by_attr(class_name, attr, value)
Find the first element exactly matching class and attribute value.
Note: Uses XPath
@@ -1718,11 +1787,11 @@
[Element]
--
-##### [find_eles_by_attr](https://github.com/appium/ruby_lib/blob/ad91ee47a96bf7a19b6f784dc760ac70b8788e5a/lib/appium_lib/ios/helper.rb#L235) ios
+##### [find_eles_by_attr](https://github.com/appium/ruby_lib/blob/54ff9c45df80ce901b718347e79e761f93a4316b/lib/appium_lib/ios/helper.rb#L283) ios
> def find_eles_by_attr(class_name, attr, value)
Find all elements exactly matching class and attribute value.
Note: Uses XPath
@@ -1739,11 +1808,11 @@
[Array<Element>]
--
-##### [find_ele_by_attr_include](https://github.com/appium/ruby_lib/blob/ad91ee47a96bf7a19b6f784dc760ac70b8788e5a/lib/appium_lib/ios/helper.rb#L250) ios
+##### [find_ele_by_attr_include](https://github.com/appium/ruby_lib/blob/54ff9c45df80ce901b718347e79e761f93a4316b/lib/appium_lib/ios/helper.rb#L306) ios
> def find_ele_by_attr_include(class_name, attr, value)
Get the first tag by attribute that exactly matches value.
Note: Uses XPath
@@ -1760,11 +1829,11 @@
[Element] the element of type tag who's attribute includes value
--
-##### [find_eles_by_attr_include](https://github.com/appium/ruby_lib/blob/ad91ee47a96bf7a19b6f784dc760ac70b8788e5a/lib/appium_lib/ios/helper.rb#L260) ios
+##### [find_eles_by_attr_include](https://github.com/appium/ruby_lib/blob/54ff9c45df80ce901b718347e79e761f93a4316b/lib/appium_lib/ios/helper.rb#L316) ios
> def find_eles_by_attr_include(class_name, attr, value)
Get tags by attribute that include value.
Note: Uses XPath
@@ -1781,11 +1850,11 @@
[Array<Element>] the elements of type tag who's attribute includes value
--
-##### [first_ele](https://github.com/appium/ruby_lib/blob/ad91ee47a96bf7a19b6f784dc760ac70b8788e5a/lib/appium_lib/ios/helper.rb#L267) ios
+##### [first_ele](https://github.com/appium/ruby_lib/blob/54ff9c45df80ce901b718347e79e761f93a4316b/lib/appium_lib/ios/helper.rb#L323) ios
> def first_ele(class_name)
Get the first tag that matches class_name
@@ -1797,11 +1866,11 @@
[Element]
--
-##### [last_ele](https://github.com/appium/ruby_lib/blob/ad91ee47a96bf7a19b6f784dc760ac70b8788e5a/lib/appium_lib/ios/helper.rb#L275) ios
+##### [last_ele](https://github.com/appium/ruby_lib/blob/54ff9c45df80ce901b718347e79e761f93a4316b/lib/appium_lib/ios/helper.rb#L334) ios
> def last_ele(class_name)
Get the last tag that matches class_name
@@ -1813,11 +1882,11 @@
[Element]
--
-##### [tag](https://github.com/appium/ruby_lib/blob/ad91ee47a96bf7a19b6f784dc760ac70b8788e5a/lib/appium_lib/ios/helper.rb#L283) ios
+##### [tag](https://github.com/appium/ruby_lib/blob/54ff9c45df80ce901b718347e79e761f93a4316b/lib/appium_lib/ios/helper.rb#L348) ios
> def tag(class_name)
Returns the first visible element matching class_name
@@ -1829,11 +1898,11 @@
[Element]
--
-##### [tags](https://github.com/appium/ruby_lib/blob/ad91ee47a96bf7a19b6f784dc760ac70b8788e5a/lib/appium_lib/ios/helper.rb#L294) ios
+##### [tags](https://github.com/appium/ruby_lib/blob/54ff9c45df80ce901b718347e79e761f93a4316b/lib/appium_lib/ios/helper.rb#L360) ios
> def tags(class_name)
Returns all visible elements matching class_name
@@ -1845,15 +1914,16 @@
[Element]
--
-##### [ele_by_json_visible_contains](https://github.com/appium/ruby_lib/blob/ad91ee47a96bf7a19b6f784dc760ac70b8788e5a/lib/appium_lib/ios/helper.rb#L329) ios
+##### [ele_by_json_visible_contains](https://github.com/appium/ruby_lib/blob/54ff9c45df80ce901b718347e79e761f93a4316b/lib/appium_lib/ios/helper.rb#L397) ios
> def ele_by_json_visible_contains(element, value)
-Find the first element that contains value
+Find the first element that contains value.
+For Appium(automation name), not XCUITest
__Parameters:__
[String] element - the class name for the element
@@ -1863,15 +1933,16 @@
[Element]
--
-##### [eles_by_json_visible_contains](https://github.com/appium/ruby_lib/blob/ad91ee47a96bf7a19b6f784dc760ac70b8788e5a/lib/appium_lib/ios/helper.rb#L337) ios
+##### [eles_by_json_visible_contains](https://github.com/appium/ruby_lib/blob/54ff9c45df80ce901b718347e79e761f93a4316b/lib/appium_lib/ios/helper.rb#L406) ios
> def eles_by_json_visible_contains(element, value)
Find all elements containing value
+For Appium(automation name), not XCUITest
__Parameters:__
[String] element - the class name for the element
@@ -1881,15 +1952,16 @@
[Array<Element>]
--
-##### [ele_by_json_visible_exact](https://github.com/appium/ruby_lib/blob/ad91ee47a96bf7a19b6f784dc760ac70b8788e5a/lib/appium_lib/ios/helper.rb#L366) ios
+##### [ele_by_json_visible_exact](https://github.com/appium/ruby_lib/blob/54ff9c45df80ce901b718347e79e761f93a4316b/lib/appium_lib/ios/helper.rb#L436) ios
> def ele_by_json_visible_exact(element, value)
Find the first element exactly matching value
+For Appium(automation name), not XCUITest
__Parameters:__
[String] element - the class name for the element
@@ -1899,15 +1971,16 @@
[Element]
--
-##### [eles_by_json_visible_exact](https://github.com/appium/ruby_lib/blob/ad91ee47a96bf7a19b6f784dc760ac70b8788e5a/lib/appium_lib/ios/helper.rb#L374) ios
+##### [eles_by_json_visible_exact](https://github.com/appium/ruby_lib/blob/54ff9c45df80ce901b718347e79e761f93a4316b/lib/appium_lib/ios/helper.rb#L445) ios
> def eles_by_json_visible_exact(element, value)
Find all elements exactly matching value
+For Appium(automation name), not XCUITest
__Parameters:__
[String] element - the class name for the element
@@ -1917,21 +1990,21 @@
[Element]
--
-##### [_all_pred](https://github.com/appium/ruby_lib/blob/ad91ee47a96bf7a19b6f784dc760ac70b8788e5a/lib/appium_lib/ios/helper.rb#L438) ios
+##### [_all_pred](https://github.com/appium/ruby_lib/blob/54ff9c45df80ce901b718347e79e761f93a4316b/lib/appium_lib/ios/helper.rb#L510) 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/ad91ee47a96bf7a19b6f784dc760ac70b8788e5a/lib/appium_lib/ios/helper.rb#L451) ios
+##### [ele_with_pred](https://github.com/appium/ruby_lib/blob/54ff9c45df80ce901b718347e79e761f93a4316b/lib/appium_lib/ios/helper.rb#L523) ios
> def ele_with_pred(opts)
returns element matching predicate contained in the main app
@@ -1943,11 +2016,11 @@
[Element]
--
-##### [eles_with_pred](https://github.com/appium/ruby_lib/blob/ad91ee47a96bf7a19b6f784dc760ac70b8788e5a/lib/appium_lib/ios/helper.rb#L462) ios
+##### [eles_with_pred](https://github.com/appium/ruby_lib/blob/54ff9c45df80ce901b718347e79e761f93a4316b/lib/appium_lib/ios/helper.rb#L534) ios
> def eles_with_pred(opts)
returns elements matching predicate contained in the main app
@@ -1959,11 +2032,11 @@
[Array<Element>]
--
-##### [source](https://github.com/appium/ruby_lib/blob/ad91ee47a96bf7a19b6f784dc760ac70b8788e5a/lib/appium_lib/ios/helper.rb#L468) ios
+##### [source](https://github.com/appium/ruby_lib/blob/54ff9c45df80ce901b718347e79e761f93a4316b/lib/appium_lib/ios/helper.rb#L540) ios
> def source
Prints xml of the current page
@@ -1971,22 +2044,23 @@
[void]
--
-##### [_validate_object](https://github.com/appium/ruby_lib/blob/ad91ee47a96bf7a19b6f784dc760ac70b8788e5a/lib/appium_lib/ios/helper.rb#L472) ios
+##### [_validate_object](https://github.com/appium/ruby_lib/blob/54ff9c45df80ce901b718347e79e761f93a4316b/lib/appium_lib/ios/helper.rb#L544) ios
> def _validate_object(*objects)
--
-##### [_by_json](https://github.com/appium/ruby_lib/blob/ad91ee47a96bf7a19b6f784dc760ac70b8788e5a/lib/appium_lib/ios/helper.rb#L520) ios
+##### [_by_json](https://github.com/appium/ruby_lib/blob/54ff9c45df80ce901b718347e79e761f93a4316b/lib/appium_lib/ios/helper.rb#L593) ios
> def _by_json(opts)
+For Appium(automation name), not XCUITest
typeArray - array of string types to search for. Example: ["UIAStaticText"]
onlyFirst - boolean. returns only the first result if true. Example: true
onlyVisible - boolean. returns only visible elements if true. Example: true
target - string. the target value to search for. Example: "Buttons, Various uses of UIButton"
substring - boolean. matches on substrings if true otherwise an exact mathc is required. Example: true
@@ -2013,14 +2087,15 @@
}
}
--
-##### [eles_by_json](https://github.com/appium/ruby_lib/blob/ad91ee47a96bf7a19b6f784dc760ac70b8788e5a/lib/appium_lib/ios/helper.rb#L569) ios
+##### [eles_by_json](https://github.com/appium/ruby_lib/blob/54ff9c45df80ce901b718347e79e761f93a4316b/lib/appium_lib/ios/helper.rb#L643) ios
> def eles_by_json(opts)
+For Appium(automation name), not XCUITest
example usage:
eles_by_json({
typeArray: ["UIAStaticText"],
onlyVisible: true,
@@ -2031,19 +2106,19 @@
},
})
--
-##### [ele_by_json](https://github.com/appium/ruby_lib/blob/ad91ee47a96bf7a19b6f784dc760ac70b8788e5a/lib/appium_lib/ios/helper.rb#L575) ios
+##### [ele_by_json](https://github.com/appium/ruby_lib/blob/54ff9c45df80ce901b718347e79e761f93a4316b/lib/appium_lib/ios/helper.rb#L649) ios
> def ele_by_json(opts)
see eles_by_json
--
-##### [get_source](https://github.com/appium/ruby_lib/blob/ad91ee47a96bf7a19b6f784dc760ac70b8788e5a/lib/appium_lib/ios/helper.rb#L585) ios
+##### [get_source](https://github.com/appium/ruby_lib/blob/54ff9c45df80ce901b718347e79e761f93a4316b/lib/appium_lib/ios/helper.rb#L659) ios
> def get_source
Returns XML string for the current page
Same as driver.page_source
@@ -2052,109 +2127,129 @@
[String]
--
-##### [UIAStaticText](https://github.com/appium/ruby_lib/blob/ad91ee47a96bf7a19b6f784dc760ac70b8788e5a/lib/appium_lib/ios/element/text.rb#L4) ios
+##### [IAStaticText](https://github.com/appium/ruby_lib/blob/54ff9c45df80ce901b718347e79e761f93a4316b/lib/appium_lib/ios/element/text.rb#L4) ios
-> UIAStaticText = 'UIAStaticText'
+> IAStaticText = 'UIAStaticText'.freeze
--
-##### [text](https://github.com/appium/ruby_lib/blob/ad91ee47a96bf7a19b6f784dc760ac70b8788e5a/lib/appium_lib/ios/element/text.rb#L10) ios
+##### [XCUIElementTypeStaticText](https://github.com/appium/ruby_lib/blob/54ff9c45df80ce901b718347e79e761f93a4316b/lib/appium_lib/ios/element/text.rb#L5) ios
+> XCUIElementTypeStaticText = 'XCUIElementTypeStaticText'.freeze
+
+
+
+--
+
+##### [static_text_class](https://github.com/appium/ruby_lib/blob/54ff9c45df80ce901b718347e79e761f93a4316b/lib/appium_lib/ios/element/text.rb#L8) ios
+
+> def static_text_class
+
+
+
+__Returns:__
+
+ [String] Class name for text
+
+--
+
+##### [text](https://github.com/appium/ruby_lib/blob/54ff9c45df80ce901b718347e79e761f93a4316b/lib/appium_lib/ios/element/text.rb#L16) ios
+
> def text(value)
-Find the first UIAStaticText that contains value or by index.
-If int then the UIAStaticText at that index is returned.
+Find the first UIAStaticText|XCUIElementTypeStaticText that contains value or by index.
+If int then the UIAStaticText|XCUIElementTypeStaticText at that index is returned.
__Parameters:__
[String, Integer] value - the value to find.
__Returns:__
- [UIAStaticText]
+ [UIAStaticText|XCUIElementTypeStaticText]
--
-##### [texts](https://github.com/appium/ruby_lib/blob/ad91ee47a96bf7a19b6f784dc760ac70b8788e5a/lib/appium_lib/ios/element/text.rb#L19) ios
+##### [texts](https://github.com/appium/ruby_lib/blob/54ff9c45df80ce901b718347e79e761f93a4316b/lib/appium_lib/ios/element/text.rb#L30) ios
> def texts(value = false)
-Find all UIAStaticText containing value.
-If value is omitted, all UIAStaticTexts are returned
+Find all UIAStaticTexts|XCUIElementTypeStaticTexts containing value.
+If value is omitted, all UIAStaticTexts|XCUIElementTypeStaticTexts are returned
__Parameters:__
[String] value - the value to search for
__Returns:__
- [Array<UIAStaticText>]
+ [Array<UIAStaticText|XCUIElementTypeStaticText>]
--
-##### [first_text](https://github.com/appium/ruby_lib/blob/ad91ee47a96bf7a19b6f784dc760ac70b8788e5a/lib/appium_lib/ios/element/text.rb#L26) ios
+##### [first_text](https://github.com/appium/ruby_lib/blob/54ff9c45df80ce901b718347e79e761f93a4316b/lib/appium_lib/ios/element/text.rb#L42) ios
> def first_text
-Find the first UIAStaticText.
+Find the first UIAStaticText|XCUIElementTypeStaticText.
__Returns:__
- [UIAStaticText]
+ [UIAStaticText|XCUIElementTypeStaticText]
--
-##### [last_text](https://github.com/appium/ruby_lib/blob/ad91ee47a96bf7a19b6f784dc760ac70b8788e5a/lib/appium_lib/ios/element/text.rb#L32) ios
+##### [last_text](https://github.com/appium/ruby_lib/blob/54ff9c45df80ce901b718347e79e761f93a4316b/lib/appium_lib/ios/element/text.rb#L48) ios
> def last_text
-Find the last UIAStaticText.
+Find the last UIAStaticText|XCUIElementTypeStaticText.
__Returns:__
- [UIAStaticText]
+ [UIAStaticText|XCUIElementTypeStaticText]
--
-##### [text_exact](https://github.com/appium/ruby_lib/blob/ad91ee47a96bf7a19b6f784dc760ac70b8788e5a/lib/appium_lib/ios/element/text.rb#L39) ios
+##### [text_exact](https://github.com/appium/ruby_lib/blob/54ff9c45df80ce901b718347e79e761f93a4316b/lib/appium_lib/ios/element/text.rb#L55) ios
> def text_exact(value)
-Find the first UIAStaticText that exactly matches value.
+Find the first UIAStaticText|XCUIElementTypeStaticText that exactly matches value.
__Parameters:__
[String] value - the value to match exactly
__Returns:__
- [UIAStaticText]
+ [UIAStaticText|XCUIElementTypeStaticText]
--
-##### [texts_exact](https://github.com/appium/ruby_lib/blob/ad91ee47a96bf7a19b6f784dc760ac70b8788e5a/lib/appium_lib/ios/element/text.rb#L46) ios
+##### [texts_exact](https://github.com/appium/ruby_lib/blob/54ff9c45df80ce901b718347e79e761f93a4316b/lib/appium_lib/ios/element/text.rb#L66) ios
> def texts_exact(value)
-Find all UIAStaticTexts that exactly match value.
+Find all UIAStaticTexts|XCUIElementTypeStaticTexts that exactly match value.
__Parameters:__
[String] value - the value to match exactly
__Returns:__
- [Array<UIAStaticText>]
+ [Array<UIAStaticText|XCUIElementTypeStaticText>]
--
-##### [alert_accept](https://github.com/appium/ruby_lib/blob/ad91ee47a96bf7a19b6f784dc760ac70b8788e5a/lib/appium_lib/ios/element/alert.rb#L5) ios
+##### [alert_accept](https://github.com/appium/ruby_lib/blob/54ff9c45df80ce901b718347e79e761f93a4316b/lib/appium_lib/ios/element/alert.rb#L5) ios
> def alert_accept
Accept the alert.
@@ -2162,11 +2257,11 @@
[void]
--
-##### [alert_dismiss](https://github.com/appium/ruby_lib/blob/ad91ee47a96bf7a19b6f784dc760ac70b8788e5a/lib/appium_lib/ios/element/alert.rb#L13) ios
+##### [alert_dismiss](https://github.com/appium/ruby_lib/blob/54ff9c45df80ce901b718347e79e761f93a4316b/lib/appium_lib/ios/element/alert.rb#L13) ios
> def alert_dismiss
Dismiss the alert.
@@ -2174,11 +2269,11 @@
[void]
--
-##### [uiautomation_find](https://github.com/appium/ruby_lib/blob/ad91ee47a96bf7a19b6f784dc760ac70b8788e5a/lib/appium_lib/ios/mobile_methods.rb#L10) ios
+##### [uiautomation_find](https://github.com/appium/ruby_lib/blob/54ff9c45df80ce901b718347e79e761f93a4316b/lib/appium_lib/ios/mobile_methods.rb#L10) 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).
@@ -2186,109 +2281,131 @@
find_elements :uiautomation, 'elements()
```
--
-##### [UIAButton](https://github.com/appium/ruby_lib/blob/ad91ee47a96bf7a19b6f784dc760ac70b8788e5a/lib/appium_lib/ios/element/button.rb#L4) ios
+##### [UIAButton](https://github.com/appium/ruby_lib/blob/54ff9c45df80ce901b718347e79e761f93a4316b/lib/appium_lib/ios/element/button.rb#L4) ios
-> UIAButton = 'UIAButton'
+> UIAButton = 'UIAButton'.freeze
--
-##### [button](https://github.com/appium/ruby_lib/blob/ad91ee47a96bf7a19b6f784dc760ac70b8788e5a/lib/appium_lib/ios/element/button.rb#L10) ios
+##### [XCUIElementTypeButton](https://github.com/appium/ruby_lib/blob/54ff9c45df80ce901b718347e79e761f93a4316b/lib/appium_lib/ios/element/button.rb#L5) ios
+> XCUIElementTypeButton = 'XCUIElementTypeButton'.freeze
+
+
+
+--
+
+##### [button_class](https://github.com/appium/ruby_lib/blob/54ff9c45df80ce901b718347e79e761f93a4316b/lib/appium_lib/ios/element/button.rb#L8) ios
+
+> def button_class
+
+
+
+__Returns:__
+
+ [String] Class name for button
+
+--
+
+##### [button](https://github.com/appium/ruby_lib/blob/54ff9c45df80ce901b718347e79e761f93a4316b/lib/appium_lib/ios/element/button.rb#L16) ios
+
> def button(value)
-Find the first UIAButton that contains value or by index.
-If int then the UIAButton at that index is returned.
+Find the first UIAButton|XCUIElementTypeButton that contains value or by index.
+If int then the UIAButton|XCUIElementTypeButton at that index is returned.
__Parameters:__
[String, Integer] value - the value to exactly match.
__Returns:__
- [UIAButton]
+ [UIAButton|XCUIElementTypeButton]
--
-##### [buttons](https://github.com/appium/ruby_lib/blob/ad91ee47a96bf7a19b6f784dc760ac70b8788e5a/lib/appium_lib/ios/element/button.rb#L20) ios
+##### [buttons](https://github.com/appium/ruby_lib/blob/54ff9c45df80ce901b718347e79e761f93a4316b/lib/appium_lib/ios/element/button.rb#L31) ios
> def buttons(value = false)
-Find all UIAButtons containing value.
-If value is omitted, all UIAButtons are returned.
+Find all UIAButtons|XCUIElementTypeButtons containing value.
+If value is omitted, all UIAButtons|XCUIElementTypeButtons are returned.
__Parameters:__
[String] value - the value to search for
__Returns:__
- [Array<UIAButton>]
+ [Array<UIAButton|XCUIElementTypeButton>]
--
-##### [first_button](https://github.com/appium/ruby_lib/blob/ad91ee47a96bf7a19b6f784dc760ac70b8788e5a/lib/appium_lib/ios/element/button.rb#L27) ios
+##### [first_button](https://github.com/appium/ruby_lib/blob/54ff9c45df80ce901b718347e79e761f93a4316b/lib/appium_lib/ios/element/button.rb#L43) ios
> def first_button
-Find the first UIAButton.
+Find the first UIAButton|XCUIElementTypeButton.
__Returns:__
- [UIAButton]
+ [UIAButton|XCUIElementTypeButton]
--
-##### [last_button](https://github.com/appium/ruby_lib/blob/ad91ee47a96bf7a19b6f784dc760ac70b8788e5a/lib/appium_lib/ios/element/button.rb#L33) ios
+##### [last_button](https://github.com/appium/ruby_lib/blob/54ff9c45df80ce901b718347e79e761f93a4316b/lib/appium_lib/ios/element/button.rb#L51) ios
> def last_button
-Find the last UIAButton.
+TODO: add documentation regarding previous element.
+ Previous UIAElement is differ from UIAButton|XCUIElementTypeButton. So, the results are different.
+Find the last UIAButton|XCUIElementTypeButton.
__Returns:__
- [UIAButton]
+ [UIAButton|XCUIElementTypeButton]
--
-##### [button_exact](https://github.com/appium/ruby_lib/blob/ad91ee47a96bf7a19b6f784dc760ac70b8788e5a/lib/appium_lib/ios/element/button.rb#L40) ios
+##### [button_exact](https://github.com/appium/ruby_lib/blob/54ff9c45df80ce901b718347e79e761f93a4316b/lib/appium_lib/ios/element/button.rb#L58) ios
> def button_exact(value)
-Find the first UIAButton that exactly matches value.
+Find the first UIAButton|XCUIElementTypeButton that exactly matches value.
__Parameters:__
[String] value - the value to match exactly
__Returns:__
- [UIAButton]
+ [UIAButton|XCUIElementTypeButton]
--
-##### [buttons_exact](https://github.com/appium/ruby_lib/blob/ad91ee47a96bf7a19b6f784dc760ac70b8788e5a/lib/appium_lib/ios/element/button.rb#L47) ios
+##### [buttons_exact](https://github.com/appium/ruby_lib/blob/54ff9c45df80ce901b718347e79e761f93a4316b/lib/appium_lib/ios/element/button.rb#L69) ios
> def buttons_exact(value)
-Find all UIAButtons that exactly match value.
+Find all UIAButtons|XCUIElementTypeButtons that exactly match value.
__Parameters:__
[String] value - the value to match exactly
__Returns:__
- [Array<UIAButton>]
+ [Array<UIAButton|XCUIElementTypeButton>]
--
-##### [find](https://github.com/appium/ruby_lib/blob/ad91ee47a96bf7a19b6f784dc760ac70b8788e5a/lib/appium_lib/ios/element/generic.rb#L6) ios
+##### [find](https://github.com/appium/ruby_lib/blob/54ff9c45df80ce901b718347e79e761f93a4316b/lib/appium_lib/ios/element/generic.rb#L6) ios
> def find(value)
Find the first element containing value
@@ -2300,11 +2417,11 @@
[Element]
--
-##### [finds](https://github.com/appium/ruby_lib/blob/ad91ee47a96bf7a19b6f784dc760ac70b8788e5a/lib/appium_lib/ios/element/generic.rb#L13) ios
+##### [finds](https://github.com/appium/ruby_lib/blob/54ff9c45df80ce901b718347e79e761f93a4316b/lib/appium_lib/ios/element/generic.rb#L17) ios
> def finds(value)
Find all elements containing value
@@ -2316,11 +2433,11 @@
[Array<Element>]
--
-##### [find_exact](https://github.com/appium/ruby_lib/blob/ad91ee47a96bf7a19b6f784dc760ac70b8788e5a/lib/appium_lib/ios/element/generic.rb#L20) ios
+##### [find_exact](https://github.com/appium/ruby_lib/blob/54ff9c45df80ce901b718347e79e761f93a4316b/lib/appium_lib/ios/element/generic.rb#L28) ios
> def find_exact(value)
Find the first element exactly matching value
@@ -2332,11 +2449,11 @@
[Element]
--
-##### [finds_exact](https://github.com/appium/ruby_lib/blob/ad91ee47a96bf7a19b6f784dc760ac70b8788e5a/lib/appium_lib/ios/element/generic.rb#L27) ios
+##### [finds_exact](https://github.com/appium/ruby_lib/blob/54ff9c45df80ce901b718347e79e761f93a4316b/lib/appium_lib/ios/element/generic.rb#L39) ios
> def finds_exact(value)
Find all elements exactly matching value
@@ -2348,31 +2465,96 @@
[Array<Element>]
--
-##### [UIATextField](https://github.com/appium/ruby_lib/blob/ad91ee47a96bf7a19b6f784dc760ac70b8788e5a/lib/appium_lib/ios/element/textfield.rb#L3) ios
+##### [UIATextField](https://github.com/appium/ruby_lib/blob/54ff9c45df80ce901b718347e79e761f93a4316b/lib/appium_lib/ios/element/textfield.rb#L3) ios
-> UIATextField = 'UIATextField'
+> UIATextField = 'UIATextField'.freeze
--
-##### [UIASecureTextField](https://github.com/appium/ruby_lib/blob/ad91ee47a96bf7a19b6f784dc760ac70b8788e5a/lib/appium_lib/ios/element/textfield.rb#L4) ios
+##### [UIASecureTextField](https://github.com/appium/ruby_lib/blob/54ff9c45df80ce901b718347e79e761f93a4316b/lib/appium_lib/ios/element/textfield.rb#L4) ios
-> UIASecureTextField = 'UIASecureTextField'
+> UIASecureTextField = 'UIASecureTextField'.freeze
--
-##### [textfield](https://github.com/appium/ruby_lib/blob/ad91ee47a96bf7a19b6f784dc760ac70b8788e5a/lib/appium_lib/ios/element/textfield.rb#L52) ios
+##### [XCUIElementTypeTextField](https://github.com/appium/ruby_lib/blob/54ff9c45df80ce901b718347e79e761f93a4316b/lib/appium_lib/ios/element/textfield.rb#L6) ios
+> XCUIElementTypeTextField = 'XCUIElementTypeTextField'.freeze
+
+
+
+--
+
+##### [XCUIElementTypeSecureTextField](https://github.com/appium/ruby_lib/blob/54ff9c45df80ce901b718347e79e761f93a4316b/lib/appium_lib/ios/element/textfield.rb#L7) ios
+
+> XCUIElementTypeSecureTextField = 'XCUIElementTypeSecureTextField'.freeze
+
+
+
+--
+
+##### [text_field_class](https://github.com/appium/ruby_lib/blob/54ff9c45df80ce901b718347e79e761f93a4316b/lib/appium_lib/ios/element/textfield.rb#L10) ios
+
+> def text_field_class
+
+
+
+__Returns:__
+
+ [String] Class name for text field
+
+--
+
+##### [secure_text_field_class](https://github.com/appium/ruby_lib/blob/54ff9c45df80ce901b718347e79e761f93a4316b/lib/appium_lib/ios/element/textfield.rb#L15) ios
+
+> def secure_text_field_class
+
+
+
+__Returns:__
+
+ [String] Class name for secure text field
+
+--
+
+##### [_textfield_visible](https://github.com/appium/ruby_lib/blob/54ff9c45df80ce901b718347e79e761f93a4316b/lib/appium_lib/ios/element/textfield.rb#L40) ios
+
+> def _textfield_visible
+
+Appium
+
+--
+
+##### [_textfield_exact_string](https://github.com/appium/ruby_lib/blob/54ff9c45df80ce901b718347e79e761f93a4316b/lib/appium_lib/ios/element/textfield.rb#L45) ios
+
+> def _textfield_exact_string(value)
+
+Appium
+
+--
+
+##### [_textfield_contains_string](https://github.com/appium/ruby_lib/blob/54ff9c45df80ce901b718347e79e761f93a4316b/lib/appium_lib/ios/element/textfield.rb#L52) ios
+
+> def _textfield_contains_string(value)
+
+Appium
+
+--
+
+##### [textfield](https://github.com/appium/ruby_lib/blob/54ff9c45df80ce901b718347e79e761f93a4316b/lib/appium_lib/ios/element/textfield.rb#L65) ios
+
> def textfield(value)
Find the first TextField that contains value or by index.
+Note: Uses XPath
If int then the TextField at that index is returned.
__Parameters:__
[String, Integer] value - the text to match exactly.
@@ -2381,11 +2563,11 @@
[TextField]
--
-##### [textfields](https://github.com/appium/ruby_lib/blob/ad91ee47a96bf7a19b6f784dc760ac70b8788e5a/lib/appium_lib/ios/element/textfield.rb#L72) ios
+##### [textfields](https://github.com/appium/ruby_lib/blob/54ff9c45df80ce901b718347e79e761f93a4316b/lib/appium_lib/ios/element/textfield.rb#L91) ios
> def textfields(value = false)
Find all TextFields containing value.
If value is omitted, all TextFields are returned.
@@ -2398,11 +2580,11 @@
[Array<TextField>]
--
-##### [first_textfield](https://github.com/appium/ruby_lib/blob/ad91ee47a96bf7a19b6f784dc760ac70b8788e5a/lib/appium_lib/ios/element/textfield.rb#L79) ios
+##### [first_textfield](https://github.com/appium/ruby_lib/blob/54ff9c45df80ce901b718347e79e761f93a4316b/lib/appium_lib/ios/element/textfield.rb#L103) ios
> def first_textfield
Find the first TextField.
@@ -2410,11 +2592,11 @@
[TextField]
--
-##### [last_textfield](https://github.com/appium/ruby_lib/blob/ad91ee47a96bf7a19b6f784dc760ac70b8788e5a/lib/appium_lib/ios/element/textfield.rb#L85) ios
+##### [last_textfield](https://github.com/appium/ruby_lib/blob/54ff9c45df80ce901b718347e79e761f93a4316b/lib/appium_lib/ios/element/textfield.rb#L113) ios
> def last_textfield
Find the last TextField.
@@ -2422,11 +2604,11 @@
[TextField]
--
-##### [textfield_exact](https://github.com/appium/ruby_lib/blob/ad91ee47a96bf7a19b6f784dc760ac70b8788e5a/lib/appium_lib/ios/element/textfield.rb#L94) ios
+##### [textfield_exact](https://github.com/appium/ruby_lib/blob/54ff9c45df80ce901b718347e79e761f93a4316b/lib/appium_lib/ios/element/textfield.rb#L126) ios
> def textfield_exact(value)
Find the first TextField that exactly matches value.
@@ -2438,11 +2620,11 @@
[TextField]
--
-##### [textfields_exact](https://github.com/appium/ruby_lib/blob/ad91ee47a96bf7a19b6f784dc760ac70b8788e5a/lib/appium_lib/ios/element/textfield.rb#L101) ios
+##### [textfields_exact](https://github.com/appium/ruby_lib/blob/54ff9c45df80ce901b718347e79e761f93a4316b/lib/appium_lib/ios/element/textfield.rb#L137) ios
> def textfields_exact(value)
Find all TextFields that exactly match value.
@@ -2454,31 +2636,31 @@
[Array<TextField>]
--
-##### [value](https://github.com/appium/ruby_lib/blob/ad91ee47a96bf7a19b6f784dc760ac70b8788e5a/lib/appium_lib/common/patch.rb#L12)
+##### [value](https://github.com/appium/ruby_lib/blob/54ff9c45df80ce901b718347e79e761f93a4316b/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/ad91ee47a96bf7a19b6f784dc760ac70b8788e5a/lib/appium_lib/common/patch.rb#L19)
+##### [name](https://github.com/appium/ruby_lib/blob/54ff9c45df80ce901b718347e79e761f93a4316b/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/ad91ee47a96bf7a19b6f784dc760ac70b8788e5a/lib/appium_lib/common/patch.rb#L31)
+##### [location_rel](https://github.com/appium/ruby_lib/blob/54ff9c45df80ce901b718347e79e761f93a4316b/lib/appium_lib/common/patch.rb#L31)
> def location_rel
For use with mobile tap.
@@ -2492,10 +2674,10 @@
[OpenStruct] the relative x, y in a struct. ex: { x: 0.50, y: 0.20 }
--
-##### [DEFAULT_HEADERS](https://github.com/appium/ruby_lib/blob/ad91ee47a96bf7a19b6f784dc760ac70b8788e5a/lib/appium_lib/common/patch.rb#L147)
+##### [DEFAULT_HEADERS](https://github.com/appium/ruby_lib/blob/54ff9c45df80ce901b718347e79e761f93a4316b/lib/appium_lib/common/patch.rb#L147)
> DEFAULT_HEADERS = { 'Accept' => CONTENT_TYPE, 'User-Agent' => "appium/ruby_lib/#{::Appium::VERSION}" }