docs/ios_docs.md in appium_lib-8.2.0 vs docs/ios_docs.md in appium_lib-8.2.1
- old
+ new
@@ -1,11 +1,10 @@
-##### [load_appium_txt](https://github.com/appium/ruby_lib/blob/95d3a6535472559590c4d043e887d15acc445a1a/lib/appium_lib/driver.rb#L70)
+##### [load_settings](https://github.com/appium/ruby_lib/blob/ad91ee47a96bf7a19b6f784dc760ac70b8788e5a/lib/appium_lib/driver.rb#L69)
-> def self.load_appium_txt(opts = {})
+> def self.load_settings(opts = {})
-Load appium.txt (toml format)
-the basedir of this file + appium.txt is what's used
+Load arbitrary text (toml format)
```
[caps]
app = "path/to/app"
@@ -25,22 +24,68 @@
[hash] the symbolized hash with updated :app and :require keys
--
-##### [symbolize_keys](https://github.com/appium/ruby_lib/blob/95d3a6535472559590c4d043e887d15acc445a1a/lib/appium_lib/driver.rb#L136)
+##### [load_appium_txt](https://github.com/appium/ruby_lib/blob/ad91ee47a96bf7a19b6f784dc760ac70b8788e5a/lib/appium_lib/driver.rb#L102)
+> def self.load_settings(opts = {})
+
+Load arbitrary text (toml format)
+
+```
+[caps]
+app = "path/to/app"
+
+[appium_lib]
+port = 8080
+```
+
+:app is expanded
+:require is expanded
+all keys are converted to symbols
+
+__Parameters:__
+
+ [Hash] opts - file: '/path/to/appium.txt', verbose: true
+
+__Returns:__
+
+ [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)
+
+> def self.expand_required_files(base_dir, file_paths)
+
+
+
+__Parameters:__
+
+ [String] base_dir - parent directory of loaded appium.txt (toml)
+
+ [String] file_paths -
+
+__Returns:__
+
+ [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)
+
> 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/95d3a6535472559590c4d043e887d15acc445a1a/lib/appium_lib/driver.rb#L157)
+##### [promote_singleton_appium_methods](https://github.com/appium/ruby_lib/blob/ad91ee47a96bf7a19b6f784dc760ac70b8788e5a/lib/appium_lib/driver.rb#L161)
> 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
@@ -54,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/95d3a6535472559590c4d043e887d15acc445a1a/lib/appium_lib/driver.rb#L208)
+##### [promote_appium_methods](https://github.com/appium/ruby_lib/blob/ad91ee47a96bf7a19b6f784dc760ac70b8788e5a/lib/appium_lib/driver.rb#L212)
> def self.promote_appium_methods(class_array)
Promote appium methods to class instance methods
@@ -84,75 +129,75 @@
[Array<Class>] class_array - An array of classes
--
-##### [global_webdriver_http_sleep](https://github.com/appium/ruby_lib/blob/95d3a6535472559590c4d043e887d15acc445a1a/lib/appium_lib/driver.rb#L242)
+##### [global_webdriver_http_sleep](https://github.com/appium/ruby_lib/blob/ad91ee47a96bf7a19b6f784dc760ac70b8788e5a/lib/appium_lib/driver.rb#L246)
> 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/95d3a6535472559590c4d043e887d15acc445a1a/lib/appium_lib/driver.rb#L242)
+##### [global_webdriver_http_sleep=](https://github.com/appium/ruby_lib/blob/ad91ee47a96bf7a19b6f784dc760ac70b8788e5a/lib/appium_lib/driver.rb#L246)
> 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/95d3a6535472559590c4d043e887d15acc445a1a/lib/appium_lib/driver.rb#L244)
+##### [caps](https://github.com/appium/ruby_lib/blob/ad91ee47a96bf7a19b6f784dc760ac70b8788e5a/lib/appium_lib/driver.rb#L248)
> def caps
Selenium webdriver capabilities
--
-##### [caps=](https://github.com/appium/ruby_lib/blob/95d3a6535472559590c4d043e887d15acc445a1a/lib/appium_lib/driver.rb#L244)
+##### [caps=](https://github.com/appium/ruby_lib/blob/ad91ee47a96bf7a19b6f784dc760ac70b8788e5a/lib/appium_lib/driver.rb#L248)
> def caps=(value)
Selenium webdriver capabilities
--
-##### [custom_url](https://github.com/appium/ruby_lib/blob/95d3a6535472559590c4d043e887d15acc445a1a/lib/appium_lib/driver.rb#L246)
+##### [custom_url](https://github.com/appium/ruby_lib/blob/ad91ee47a96bf7a19b6f784dc760ac70b8788e5a/lib/appium_lib/driver.rb#L250)
> def custom_url
Custom URL for the selenium server
--
-##### [custom_url=](https://github.com/appium/ruby_lib/blob/95d3a6535472559590c4d043e887d15acc445a1a/lib/appium_lib/driver.rb#L246)
+##### [custom_url=](https://github.com/appium/ruby_lib/blob/ad91ee47a96bf7a19b6f784dc760ac70b8788e5a/lib/appium_lib/driver.rb#L250)
> def custom_url=(value)
Custom URL for the selenium server
--
-##### [export_session](https://github.com/appium/ruby_lib/blob/95d3a6535472559590c4d043e887d15acc445a1a/lib/appium_lib/driver.rb#L248)
+##### [export_session](https://github.com/appium/ruby_lib/blob/ad91ee47a96bf7a19b6f784dc760ac70b8788e5a/lib/appium_lib/driver.rb#L252)
> def export_session
Export session id to textfile in /tmp for 3rd party tools
--
-##### [export_session=](https://github.com/appium/ruby_lib/blob/95d3a6535472559590c4d043e887d15acc445a1a/lib/appium_lib/driver.rb#L248)
+##### [export_session=](https://github.com/appium/ruby_lib/blob/ad91ee47a96bf7a19b6f784dc760ac70b8788e5a/lib/appium_lib/driver.rb#L252)
> def export_session=(value)
Export session id to textfile in /tmp for 3rd party tools
--
-##### [default_wait](https://github.com/appium/ruby_lib/blob/95d3a6535472559590c4d043e887d15acc445a1a/lib/appium_lib/driver.rb#L253)
+##### [default_wait](https://github.com/appium/ruby_lib/blob/ad91ee47a96bf7a19b6f784dc760ac70b8788e5a/lib/appium_lib/driver.rb#L257)
> def default_wait
Default wait time for elements to appear
Returns the default client side wait.
@@ -162,11 +207,11 @@
[Integer]
--
-##### [default_wait=](https://github.com/appium/ruby_lib/blob/95d3a6535472559590c4d043e887d15acc445a1a/lib/appium_lib/driver.rb#L253)
+##### [default_wait=](https://github.com/appium/ruby_lib/blob/ad91ee47a96bf7a19b6f784dc760ac70b8788e5a/lib/appium_lib/driver.rb#L257)
> def default_wait=(value)
Default wait time for elements to appear
Returns the default client side wait.
@@ -176,123 +221,123 @@
[Integer]
--
-##### [last_waits](https://github.com/appium/ruby_lib/blob/95d3a6535472559590c4d043e887d15acc445a1a/lib/appium_lib/driver.rb#L255)
+##### [last_waits](https://github.com/appium/ruby_lib/blob/ad91ee47a96bf7a19b6f784dc760ac70b8788e5a/lib/appium_lib/driver.rb#L259)
> def last_waits
Array of previous wait time values
--
-##### [last_waits=](https://github.com/appium/ruby_lib/blob/95d3a6535472559590c4d043e887d15acc445a1a/lib/appium_lib/driver.rb#L255)
+##### [last_waits=](https://github.com/appium/ruby_lib/blob/ad91ee47a96bf7a19b6f784dc760ac70b8788e5a/lib/appium_lib/driver.rb#L259)
> def last_waits=(value)
Array of previous wait time values
--
-##### [sauce_username](https://github.com/appium/ruby_lib/blob/95d3a6535472559590c4d043e887d15acc445a1a/lib/appium_lib/driver.rb#L257)
+##### [sauce_username](https://github.com/appium/ruby_lib/blob/ad91ee47a96bf7a19b6f784dc760ac70b8788e5a/lib/appium_lib/driver.rb#L261)
> def sauce_username
Username for use on Sauce Labs
--
-##### [sauce_username=](https://github.com/appium/ruby_lib/blob/95d3a6535472559590c4d043e887d15acc445a1a/lib/appium_lib/driver.rb#L257)
+##### [sauce_username=](https://github.com/appium/ruby_lib/blob/ad91ee47a96bf7a19b6f784dc760ac70b8788e5a/lib/appium_lib/driver.rb#L261)
> def sauce_username=(value)
Username for use on Sauce Labs
--
-##### [sauce_access_key](https://github.com/appium/ruby_lib/blob/95d3a6535472559590c4d043e887d15acc445a1a/lib/appium_lib/driver.rb#L259)
+##### [sauce_access_key](https://github.com/appium/ruby_lib/blob/ad91ee47a96bf7a19b6f784dc760ac70b8788e5a/lib/appium_lib/driver.rb#L263)
> def sauce_access_key
Access Key for use on Sauce Labs
--
-##### [sauce_access_key=](https://github.com/appium/ruby_lib/blob/95d3a6535472559590c4d043e887d15acc445a1a/lib/appium_lib/driver.rb#L259)
+##### [sauce_access_key=](https://github.com/appium/ruby_lib/blob/ad91ee47a96bf7a19b6f784dc760ac70b8788e5a/lib/appium_lib/driver.rb#L263)
> def sauce_access_key=(value)
Access Key for use on Sauce Labs
--
-##### [appium_port](https://github.com/appium/ruby_lib/blob/95d3a6535472559590c4d043e887d15acc445a1a/lib/appium_lib/driver.rb#L261)
+##### [appium_port](https://github.com/appium/ruby_lib/blob/ad91ee47a96bf7a19b6f784dc760ac70b8788e5a/lib/appium_lib/driver.rb#L265)
> def appium_port
Appium's server port
--
-##### [appium_port=](https://github.com/appium/ruby_lib/blob/95d3a6535472559590c4d043e887d15acc445a1a/lib/appium_lib/driver.rb#L261)
+##### [appium_port=](https://github.com/appium/ruby_lib/blob/ad91ee47a96bf7a19b6f784dc760ac70b8788e5a/lib/appium_lib/driver.rb#L265)
> def appium_port=(value)
Appium's server port
--
-##### [appium_device](https://github.com/appium/ruby_lib/blob/95d3a6535472559590c4d043e887d15acc445a1a/lib/appium_lib/driver.rb#L263)
+##### [appium_device](https://github.com/appium/ruby_lib/blob/ad91ee47a96bf7a19b6f784dc760ac70b8788e5a/lib/appium_lib/driver.rb#L267)
> def appium_device
Device type to request from the appium server
--
-##### [appium_device=](https://github.com/appium/ruby_lib/blob/95d3a6535472559590c4d043e887d15acc445a1a/lib/appium_lib/driver.rb#L263)
+##### [appium_device=](https://github.com/appium/ruby_lib/blob/ad91ee47a96bf7a19b6f784dc760ac70b8788e5a/lib/appium_lib/driver.rb#L267)
> def appium_device=(value)
Device type to request from the appium server
--
-##### [appium_debug](https://github.com/appium/ruby_lib/blob/95d3a6535472559590c4d043e887d15acc445a1a/lib/appium_lib/driver.rb#L265)
+##### [appium_debug](https://github.com/appium/ruby_lib/blob/ad91ee47a96bf7a19b6f784dc760ac70b8788e5a/lib/appium_lib/driver.rb#L269)
> def appium_debug
Boolean debug mode for the Appium Ruby bindings
--
-##### [appium_debug=](https://github.com/appium/ruby_lib/blob/95d3a6535472559590c4d043e887d15acc445a1a/lib/appium_lib/driver.rb#L265)
+##### [appium_debug=](https://github.com/appium/ruby_lib/blob/ad91ee47a96bf7a19b6f784dc760ac70b8788e5a/lib/appium_lib/driver.rb#L269)
> def appium_debug=(value)
Boolean debug mode for the Appium Ruby bindings
--
-##### [listener](https://github.com/appium/ruby_lib/blob/95d3a6535472559590c4d043e887d15acc445a1a/lib/appium_lib/driver.rb#L267)
+##### [listener](https://github.com/appium/ruby_lib/blob/ad91ee47a96bf7a19b6f784dc760ac70b8788e5a/lib/appium_lib/driver.rb#L271)
> def listener
instance of AbstractEventListener for logging support
--
-##### [listener=](https://github.com/appium/ruby_lib/blob/95d3a6535472559590c4d043e887d15acc445a1a/lib/appium_lib/driver.rb#L267)
+##### [listener=](https://github.com/appium/ruby_lib/blob/ad91ee47a96bf7a19b6f784dc760ac70b8788e5a/lib/appium_lib/driver.rb#L271)
> def listener=(value)
instance of AbstractEventListener for logging support
--
-##### [driver](https://github.com/appium/ruby_lib/blob/95d3a6535472559590c4d043e887d15acc445a1a/lib/appium_lib/driver.rb#L271)
+##### [driver](https://github.com/appium/ruby_lib/blob/ad91ee47a96bf7a19b6f784dc760ac70b8788e5a/lib/appium_lib/driver.rb#L275)
> def driver
Returns the driver
@@ -300,11 +345,11 @@
[Driver] the driver
--
-##### [initialize](https://github.com/appium/ruby_lib/blob/95d3a6535472559590c4d043e887d15acc445a1a/lib/appium_lib/driver.rb#L292)
+##### [initialize](https://github.com/appium/ruby_lib/blob/ad91ee47a96bf7a19b6f784dc760ac70b8788e5a/lib/appium_lib/driver.rb#L296)
> def initialize(opts = {})
Creates a new driver
@@ -331,19 +376,19 @@
[Driver]
--
-##### [driver_attributes](https://github.com/appium/ruby_lib/blob/95d3a6535472559590c4d043e887d15acc445a1a/lib/appium_lib/driver.rb#L360)
+##### [driver_attributes](https://github.com/appium/ruby_lib/blob/ad91ee47a96bf7a19b6f784dc760ac70b8788e5a/lib/appium_lib/driver.rb#L364)
> def driver_attributes
Returns a hash of the driver attributes
--
-##### [device_is_android?](https://github.com/appium/ruby_lib/blob/95d3a6535472559590c4d043e887d15acc445a1a/lib/appium_lib/driver.rb#L381)
+##### [device_is_android?](https://github.com/appium/ruby_lib/blob/ad91ee47a96bf7a19b6f784dc760ac70b8788e5a/lib/appium_lib/driver.rb#L385)
> def device_is_android?
@@ -351,11 +396,11 @@
[Boolean]
--
-##### [appium_server_version](https://github.com/appium/ruby_lib/blob/95d3a6535472559590c4d043e887d15acc445a1a/lib/appium_lib/driver.rb#L397)
+##### [appium_server_version](https://github.com/appium/ruby_lib/blob/ad91ee47a96bf7a19b6f784dc760ac70b8788e5a/lib/appium_lib/driver.rb#L401)
> def appium_server_version
Returns the server's version info
@@ -372,11 +417,11 @@
[Hash]
--
-##### [absolute_app_path](https://github.com/appium/ruby_lib/blob/95d3a6535472559590c4d043e887d15acc445a1a/lib/appium_lib/driver.rb#L409)
+##### [absolute_app_path](https://github.com/appium/ruby_lib/blob/ad91ee47a96bf7a19b6f784dc760ac70b8788e5a/lib/appium_lib/driver.rb#L413)
> def self.absolute_app_path(opts)
Converts app_path to an absolute path.
@@ -389,11 +434,11 @@
[String] APP_PATH as an absolute path
--
-##### [server_url](https://github.com/appium/ruby_lib/blob/95d3a6535472559590c4d043e887d15acc445a1a/lib/appium_lib/driver.rb#L442)
+##### [server_url](https://github.com/appium/ruby_lib/blob/ad91ee47a96bf7a19b6f784dc760ac70b8788e5a/lib/appium_lib/driver.rb#L446)
> def server_url
Get the server url
@@ -401,11 +446,11 @@
[String] the server url
--
-##### [restart](https://github.com/appium/ruby_lib/blob/95d3a6535472559590c4d043e887d15acc445a1a/lib/appium_lib/driver.rb#L453)
+##### [restart](https://github.com/appium/ruby_lib/blob/ad91ee47a96bf7a19b6f784dc760ac70b8788e5a/lib/appium_lib/driver.rb#L457)
> def restart
Restarts the driver
@@ -413,11 +458,11 @@
[Driver] the driver
--
-##### [screenshot](https://github.com/appium/ruby_lib/blob/95d3a6535472559590c4d043e887d15acc445a1a/lib/appium_lib/driver.rb#L464)
+##### [screenshot](https://github.com/appium/ruby_lib/blob/ad91ee47a96bf7a19b6f784dc760ac70b8788e5a/lib/appium_lib/driver.rb#L468)
> def screenshot(png_save_path)
Takes a png screenshot and saves to the target path.
@@ -431,11 +476,11 @@
[nil]
--
-##### [driver_quit](https://github.com/appium/ruby_lib/blob/95d3a6535472559590c4d043e887d15acc445a1a/lib/appium_lib/driver.rb#L471)
+##### [driver_quit](https://github.com/appium/ruby_lib/blob/ad91ee47a96bf7a19b6f784dc760ac70b8788e5a/lib/appium_lib/driver.rb#L475)
> def driver_quit
Quits the driver
@@ -443,11 +488,11 @@
[void]
--
-##### [start_driver](https://github.com/appium/ruby_lib/blob/95d3a6535472559590c4d043e887d15acc445a1a/lib/appium_lib/driver.rb#L480)
+##### [start_driver](https://github.com/appium/ruby_lib/blob/ad91ee47a96bf7a19b6f784dc760ac70b8788e5a/lib/appium_lib/driver.rb#L484)
> def start_driver
Creates a new global driver and quits the old one if it exists.
@@ -455,19 +500,19 @@
[Selenium::WebDriver] the new global driver
--
-##### [no_wait](https://github.com/appium/ruby_lib/blob/95d3a6535472559590c4d043e887d15acc445a1a/lib/appium_lib/driver.rb#L513)
+##### [no_wait](https://github.com/appium/ruby_lib/blob/ad91ee47a96bf7a19b6f784dc760ac70b8788e5a/lib/appium_lib/driver.rb#L517)
> def no_wait
Set implicit wait and default_wait to zero.
--
-##### [set_wait](https://github.com/appium/ruby_lib/blob/95d3a6535472559590c4d043e887d15acc445a1a/lib/appium_lib/driver.rb#L532)
+##### [set_wait](https://github.com/appium/ruby_lib/blob/ad91ee47a96bf7a19b6f784dc760ac70b8788e5a/lib/appium_lib/driver.rb#L536)
> 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
@@ -488,11 +533,11 @@
[void]
--
-##### [exists](https://github.com/appium/ruby_lib/blob/95d3a6535472559590c4d043e887d15acc445a1a/lib/appium_lib/driver.rb#L559)
+##### [exists](https://github.com/appium/ruby_lib/blob/ad91ee47a96bf7a19b6f784dc760ac70b8788e5a/lib/appium_lib/driver.rb#L563)
> def exists(pre_check = 0, post_check = @default_wait, &search_block)
Returns existence of element.
@@ -514,11 +559,11 @@
[Boolean]
--
-##### [execute_script](https://github.com/appium/ruby_lib/blob/95d3a6535472559590c4d043e887d15acc445a1a/lib/appium_lib/driver.rb#L583)
+##### [execute_script](https://github.com/appium/ruby_lib/blob/ad91ee47a96bf7a19b6f784dc760ac70b8788e5a/lib/appium_lib/driver.rb#L587)
> def execute_script(script, *args)
The same as @driver.execute_script
@@ -532,11 +577,11 @@
[Object]
--
-##### [find_elements](https://github.com/appium/ruby_lib/blob/95d3a6535472559590c4d043e887d15acc445a1a/lib/appium_lib/driver.rb#L591)
+##### [find_elements](https://github.com/appium/ruby_lib/blob/ad91ee47a96bf7a19b6f784dc760ac70b8788e5a/lib/appium_lib/driver.rb#L595)
> def find_elements(*args)
Calls @driver.find_elements
@@ -548,11 +593,11 @@
[Array<Element>] Array is empty when no elements are found.
--
-##### [find_element](https://github.com/appium/ruby_lib/blob/95d3a6535472559590c4d043e887d15acc445a1a/lib/appium_lib/driver.rb#L599)
+##### [find_element](https://github.com/appium/ruby_lib/blob/ad91ee47a96bf7a19b6f784dc760ac70b8788e5a/lib/appium_lib/driver.rb#L603)
> def find_element(*args)
Calls @driver.find_elements
@@ -564,11 +609,11 @@
[Element]
--
-##### [set_location](https://github.com/appium/ruby_lib/blob/95d3a6535472559590c4d043e887d15acc445a1a/lib/appium_lib/driver.rb#L612)
+##### [set_location](https://github.com/appium/ruby_lib/blob/ad91ee47a96bf7a19b6f784dc760ac70b8788e5a/lib/appium_lib/driver.rb#L616)
> def set_location(opts = {})
Calls @driver.set_location
@@ -580,11 +625,11 @@
[Selenium::WebDriver::Location] the location constructed by the selenium webdriver
--
-##### [x](https://github.com/appium/ruby_lib/blob/95d3a6535472559590c4d043e887d15acc445a1a/lib/appium_lib/driver.rb#L622)
+##### [x](https://github.com/appium/ruby_lib/blob/ad91ee47a96bf7a19b6f784dc760ac70b8788e5a/lib/appium_lib/driver.rb#L626)
> def x
Quit the driver and Pry.
quit and exit are reserved by Pry.
@@ -593,11 +638,11 @@
[void]
--
-##### [logger=](https://github.com/appium/ruby_lib/blob/95d3a6535472559590c4d043e887d15acc445a1a/lib/appium_lib/logger.rb#L13)
+##### [logger=](https://github.com/appium/ruby_lib/blob/ad91ee47a96bf7a19b6f784dc760ac70b8788e5a/lib/appium_lib/logger.rb#L13)
> def logger=(value)
Sets the attribute logger
@@ -605,95 +650,95 @@
value - the value to set the attribute logger to.
--
-##### [logger](https://github.com/appium/ruby_lib/blob/95d3a6535472559590c4d043e887d15acc445a1a/lib/appium_lib/logger.rb#L17)
+##### [logger](https://github.com/appium/ruby_lib/blob/ad91ee47a96bf7a19b6f784dc760ac70b8788e5a/lib/appium_lib/logger.rb#L17)
> def logger
--
-##### [NoArgMethods](https://github.com/appium/ruby_lib/blob/95d3a6535472559590c4d043e887d15acc445a1a/lib/appium_lib/device/device.rb#L7)
+##### [NoArgMethods](https://github.com/appium/ruby_lib/blob/ad91ee47a96bf7a19b6f784dc760ac70b8788e5a/lib/appium_lib/device/device.rb#L7)
> NoArgMethods = {
--
-##### [app_strings](https://github.com/appium/ruby_lib/blob/95d3a6535472559590c4d043e887d15acc445a1a/lib/appium_lib/device/device.rb#L25)
+##### [app_strings](https://github.com/appium/ruby_lib/blob/ad91ee47a96bf7a19b6f784dc760ac70b8788e5a/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/95d3a6535472559590c4d043e887d15acc445a1a/lib/appium_lib/device/device.rb#L31)
+##### [background_app](https://github.com/appium/ruby_lib/blob/ad91ee47a96bf7a19b6f784dc760ac70b8788e5a/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/95d3a6535472559590c4d043e887d15acc445a1a/lib/appium_lib/device/device.rb#L36)
+##### [current_activity](https://github.com/appium/ruby_lib/blob/ad91ee47a96bf7a19b6f784dc760ac70b8788e5a/lib/appium_lib/device/device.rb#L36)
> def current_activity
--
-##### [launch_app](https://github.com/appium/ruby_lib/blob/95d3a6535472559590c4d043e887d15acc445a1a/lib/appium_lib/device/device.rb#L38)
+##### [launch_app](https://github.com/appium/ruby_lib/blob/ad91ee47a96bf7a19b6f784dc760ac70b8788e5a/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/95d3a6535472559590c4d043e887d15acc445a1a/lib/appium_lib/device/device.rb#L41)
+##### [reset](https://github.com/appium/ruby_lib/blob/ad91ee47a96bf7a19b6f784dc760ac70b8788e5a/lib/appium_lib/device/device.rb#L41)
> def reset
Reset the device, relaunching the application.
--
-##### [shake](https://github.com/appium/ruby_lib/blob/95d3a6535472559590c4d043e887d15acc445a1a/lib/appium_lib/device/device.rb#L44)
+##### [shake](https://github.com/appium/ruby_lib/blob/ad91ee47a96bf7a19b6f784dc760ac70b8788e5a/lib/appium_lib/device/device.rb#L44)
> def shake
Cause the device to shake
--
-##### [toggle_flight_mode](https://github.com/appium/ruby_lib/blob/95d3a6535472559590c4d043e887d15acc445a1a/lib/appium_lib/device/device.rb#L47)
+##### [toggle_flight_mode](https://github.com/appium/ruby_lib/blob/ad91ee47a96bf7a19b6f784dc760ac70b8788e5a/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/95d3a6535472559590c4d043e887d15acc445a1a/lib/appium_lib/device/device.rb#L50)
+##### [device_locked?](https://github.com/appium/ruby_lib/blob/ad91ee47a96bf7a19b6f784dc760ac70b8788e5a/lib/appium_lib/device/device.rb#L50)
> def device_locked?
--
-##### [hide_keyboard](https://github.com/appium/ruby_lib/blob/95d3a6535472559590c4d043e887d15acc445a1a/lib/appium_lib/device/device.rb#L52)
+##### [hide_keyboard](https://github.com/appium/ruby_lib/blob/ad91ee47a96bf7a19b6f784dc760ac70b8788e5a/lib/appium_lib/device/device.rb#L52)
> def hide_keyboard
Hide the onscreen keyboard
@@ -702,11 +747,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/95d3a6535472559590c4d043e887d15acc445a1a/lib/appium_lib/device/device.rb#L61)
+##### [press_keycode](https://github.com/appium/ruby_lib/blob/ad91ee47a96bf7a19b6f784dc760ac70b8788e5a/lib/appium_lib/device/device.rb#L61)
> def press_keycode
Press keycode on the device.
http://developer.android.com/reference/android/view/KeyEvent.html
@@ -717,11 +762,11 @@
[String] metastate - The state the metakeys should be in when pressing the key.
--
-##### [long_press_keycode](https://github.com/appium/ruby_lib/blob/95d3a6535472559590c4d043e887d15acc445a1a/lib/appium_lib/device/device.rb#L67)
+##### [long_press_keycode](https://github.com/appium/ruby_lib/blob/ad91ee47a96bf7a19b6f784dc760ac70b8788e5a/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
@@ -732,11 +777,11 @@
[String] metastate - The state the metakeys should be in when long pressing the key.
--
-##### [push_file](https://github.com/appium/ruby_lib/blob/95d3a6535472559590c4d043e887d15acc445a1a/lib/appium_lib/device/device.rb#L73)
+##### [push_file](https://github.com/appium/ruby_lib/blob/ad91ee47a96bf7a19b6f784dc760ac70b8788e5a/lib/appium_lib/device/device.rb#L73)
> def push_file
Place a file in a specific location on the device.
@@ -746,11 +791,11 @@
[String] data - Raw file data to be sent to the device.
--
-##### [pull_file](https://github.com/appium/ruby_lib/blob/95d3a6535472559590c4d043e887d15acc445a1a/lib/appium_lib/device/device.rb#L78)
+##### [pull_file](https://github.com/appium/ruby_lib/blob/ad91ee47a96bf7a19b6f784dc760ac70b8788e5a/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).
@@ -763,11 +808,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/95d3a6535472559590c4d043e887d15acc445a1a/lib/appium_lib/device/device.rb#L88)
+##### [pull_folder](https://github.com/appium/ruby_lib/blob/ad91ee47a96bf7a19b6f784dc760ac70b8788e5a/lib/appium_lib/device/device.rb#L88)
> def pull_folder
Retrieve a folder from the device.
```ruby
@@ -778,11 +823,11 @@
[String] path - absolute path to the folder
--
-##### [touch_id](https://github.com/appium/ruby_lib/blob/95d3a6535472559590c4d043e887d15acc445a1a/lib/appium_lib/device/device.rb#L96)
+##### [touch_id](https://github.com/appium/ruby_lib/blob/ad91ee47a96bf7a19b6f784dc760ac70b8788e5a/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
@@ -795,11 +840,11 @@
[Boolean] match - fingerprint validity
Defaults to true.
--
-##### [end_coverage](https://github.com/appium/ruby_lib/blob/95d3a6535472559590c4d043e887d15acc445a1a/lib/appium_lib/device/device.rb#L105)
+##### [end_coverage](https://github.com/appium/ruby_lib/blob/ad91ee47a96bf7a19b6f784dc760ac70b8788e5a/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.
@@ -809,35 +854,35 @@
[String] intent - Intent to broadcast when ending coverage.
--
-##### [get_settings](https://github.com/appium/ruby_lib/blob/95d3a6535472559590c4d043e887d15acc445a1a/lib/appium_lib/device/device.rb#L110)
+##### [get_settings](https://github.com/appium/ruby_lib/blob/ad91ee47a96bf7a19b6f784dc760ac70b8788e5a/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/95d3a6535472559590c4d043e887d15acc445a1a/lib/appium_lib/device/device.rb#L370)
+##### [extend_search_contexts](https://github.com/appium/ruby_lib/blob/ad91ee47a96bf7a19b6f784dc760ac70b8788e5a/lib/appium_lib/device/device.rb#L394)
> def extend_search_contexts
--
-##### [find_element](https://github.com/appium/ruby_lib/blob/95d3a6535472559590c4d043e887d15acc445a1a/lib/appium_lib/device/device.rb#L370)
+##### [find_element](https://github.com/appium/ruby_lib/blob/ad91ee47a96bf7a19b6f784dc760ac70b8788e5a/lib/appium_lib/device/device.rb#L394)
> def find_element
--
-##### [find_elements](https://github.com/appium/ruby_lib/blob/95d3a6535472559590c4d043e887d15acc445a1a/lib/appium_lib/device/device.rb#L370)
+##### [find_elements](https://github.com/appium/ruby_lib/blob/ad91ee47a96bf7a19b6f784dc760ac70b8788e5a/lib/appium_lib/device/device.rb#L394)
> def find_elements
find_element/s with their accessibility_id
@@ -845,20 +890,28 @@
find_elements :accessibility_id, 'Animation'
```
--
-##### [add_touch_actions](https://github.com/appium/ruby_lib/blob/95d3a6535472559590c4d043e887d15acc445a1a/lib/appium_lib/device/device.rb#L376)
+##### [add_touch_actions](https://github.com/appium/ruby_lib/blob/ad91ee47a96bf7a19b6f784dc760ac70b8788e5a/lib/appium_lib/device/device.rb#L400)
> def add_touch_actions
--
-##### [set_context](https://github.com/appium/ruby_lib/blob/95d3a6535472559590c4d043e887d15acc445a1a/lib/appium_lib/device/device.rb#L400)
+##### [add_ime_actions](https://github.com/appium/ruby_lib/blob/ad91ee47a96bf7a19b6f784dc760ac70b8788e5a/lib/appium_lib/device/device.rb#L423)
+> def add_ime_actions
+
+
+
+--
+
+##### [set_context](https://github.com/appium/ruby_lib/blob/ad91ee47a96bf7a19b6f784dc760ac70b8788e5a/lib/appium_lib/device/device.rb#L498)
+
> def set_context
Change the context to the given context.
```ruby
set_context "NATIVE_APP"
@@ -868,11 +921,11 @@
[String] The - context to change to
--
-##### [current_context](https://github.com/appium/ruby_lib/blob/95d3a6535472559590c4d043e887d15acc445a1a/lib/appium_lib/device/device.rb#L408)
+##### [current_context](https://github.com/appium/ruby_lib/blob/ad91ee47a96bf7a19b6f784dc760ac70b8788e5a/lib/appium_lib/device/device.rb#L506)
> def current_context
@@ -880,11 +933,11 @@
[String] The context currently being used.
--
-##### [available_contexts](https://github.com/appium/ruby_lib/blob/95d3a6535472559590c4d043e887d15acc445a1a/lib/appium_lib/device/device.rb#L411)
+##### [available_contexts](https://github.com/appium/ruby_lib/blob/ad91ee47a96bf7a19b6f784dc760ac70b8788e5a/lib/appium_lib/device/device.rb#L509)
> def available_contexts
@@ -892,11 +945,11 @@
[Array<String>] All usable contexts, as an array of strings.
--
-##### [within_context](https://github.com/appium/ruby_lib/blob/95d3a6535472559590c4d043e887d15acc445a1a/lib/appium_lib/device/device.rb#L421)
+##### [within_context](https://github.com/appium/ruby_lib/blob/ad91ee47a96bf7a19b6f784dc760ac70b8788e5a/lib/appium_lib/device/device.rb#L519)
> def within_context(context)
Perform a block within the given context, then switch back to the starting context.
```ruby
@@ -908,19 +961,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/95d3a6535472559590c4d043e887d15acc445a1a/lib/appium_lib/device/device.rb#L429)
+##### [switch_to_default_context](https://github.com/appium/ruby_lib/blob/ad91ee47a96bf7a19b6f784dc760ac70b8788e5a/lib/appium_lib/device/device.rb#L527)
> 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/95d3a6535472559590c4d043e887d15acc445a1a/lib/appium_lib/device/multi_touch.rb#L28)
+##### [pinch](https://github.com/appium/ruby_lib/blob/ad91ee47a96bf7a19b6f784dc760ac70b8788e5a/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.
@@ -935,11 +988,11 @@
[boolean] auto_perform - Whether to perform the action immediately (default true)
--
-##### [zoom](https://github.com/appium/ruby_lib/blob/95d3a6535472559590c4d043e887d15acc445a1a/lib/appium_lib/device/multi_touch.rb#L56)
+##### [zoom](https://github.com/appium/ruby_lib/blob/ad91ee47a96bf7a19b6f784dc760ac70b8788e5a/lib/appium_lib/device/multi_touch.rb#L56)
> 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.
@@ -954,11 +1007,11 @@
[boolean] auto_perform - Whether to perform the action immediately (default true)
--
-##### [initialize](https://github.com/appium/ruby_lib/blob/95d3a6535472559590c4d043e887d15acc445a1a/lib/appium_lib/device/multi_touch.rb#L77)
+##### [initialize](https://github.com/appium/ruby_lib/blob/ad91ee47a96bf7a19b6f784dc760ac70b8788e5a/lib/appium_lib/device/multi_touch.rb#L77)
> def initialize
Create a new multi-action
@@ -966,11 +1019,11 @@
[MultiTouch] a new instance of MultiTouch
--
-##### [add](https://github.com/appium/ruby_lib/blob/95d3a6535472559590c4d043e887d15acc445a1a/lib/appium_lib/device/multi_touch.rb#L83)
+##### [add](https://github.com/appium/ruby_lib/blob/ad91ee47a96bf7a19b6f784dc760ac70b8788e5a/lib/appium_lib/device/multi_touch.rb#L83)
> def add(chain)
Add a touch_action to be performed
@@ -978,43 +1031,43 @@
[TouchAction] chain - The action to add to the chain
--
-##### [perform](https://github.com/appium/ruby_lib/blob/95d3a6535472559590c4d043e887d15acc445a1a/lib/appium_lib/device/multi_touch.rb#L88)
+##### [perform](https://github.com/appium/ruby_lib/blob/ad91ee47a96bf7a19b6f784dc760ac70b8788e5a/lib/appium_lib/device/multi_touch.rb#L88)
> def perform
Ask Appium to perform the actions
--
-##### [ACTIONS](https://github.com/appium/ruby_lib/blob/95d3a6535472559590c4d043e887d15acc445a1a/lib/appium_lib/device/touch_actions.rb#L11)
+##### [ACTIONS](https://github.com/appium/ruby_lib/blob/ad91ee47a96bf7a19b6f784dc760ac70b8788e5a/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/95d3a6535472559590c4d043e887d15acc445a1a/lib/appium_lib/device/touch_actions.rb#L12)
+##### [COMPLEX_ACTIONS](https://github.com/appium/ruby_lib/blob/ad91ee47a96bf7a19b6f784dc760ac70b8788e5a/lib/appium_lib/device/touch_actions.rb#L12)
> COMPLEX_ACTIONS = [:swipe]
--
-##### [actions](https://github.com/appium/ruby_lib/blob/95d3a6535472559590c4d043e887d15acc445a1a/lib/appium_lib/device/touch_actions.rb#L26)
+##### [actions](https://github.com/appium/ruby_lib/blob/ad91ee47a96bf7a19b6f784dc760ac70b8788e5a/lib/appium_lib/device/touch_actions.rb#L26)
> def actions
Returns the value of attribute actions
--
-##### [initialize](https://github.com/appium/ruby_lib/blob/95d3a6535472559590c4d043e887d15acc445a1a/lib/appium_lib/device/touch_actions.rb#L28)
+##### [initialize](https://github.com/appium/ruby_lib/blob/ad91ee47a96bf7a19b6f784dc760ac70b8788e5a/lib/appium_lib/device/touch_actions.rb#L28)
> def initialize
@@ -1022,11 +1075,11 @@
[TouchAction] a new instance of TouchAction
--
-##### [move_to](https://github.com/appium/ruby_lib/blob/95d3a6535472559590c4d043e887d15acc445a1a/lib/appium_lib/device/touch_actions.rb#L36)
+##### [move_to](https://github.com/appium/ruby_lib/blob/ad91ee47a96bf7a19b6f784dc760ac70b8788e5a/lib/appium_lib/device/touch_actions.rb#L36)
> def move_to(opts)
Move to the given co-ordinates.
@@ -1034,11 +1087,11 @@
[Hash] opts - a customizable set of options
--
-##### [long_press](https://github.com/appium/ruby_lib/blob/95d3a6535472559590c4d043e887d15acc445a1a/lib/appium_lib/device/touch_actions.rb#L46)
+##### [long_press](https://github.com/appium/ruby_lib/blob/ad91ee47a96bf7a19b6f784dc760ac70b8788e5a/lib/appium_lib/device/touch_actions.rb#L46)
> def long_press(opts)
Press down for a specific duration.
@@ -1052,11 +1105,11 @@
[Hash] duration - a customizable set of options
--
-##### [press](https://github.com/appium/ruby_lib/blob/95d3a6535472559590c4d043e887d15acc445a1a/lib/appium_lib/device/touch_actions.rb#L58)
+##### [press](https://github.com/appium/ruby_lib/blob/ad91ee47a96bf7a19b6f784dc760ac70b8788e5a/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`.
@@ -1065,11 +1118,11 @@
[Hash] opts - a customizable set of options
--
-##### [release](https://github.com/appium/ruby_lib/blob/95d3a6535472559590c4d043e887d15acc445a1a/lib/appium_lib/device/touch_actions.rb#L69)
+##### [release](https://github.com/appium/ruby_lib/blob/ad91ee47a96bf7a19b6f784dc760ac70b8788e5a/lib/appium_lib/device/touch_actions.rb#L69)
> def release(opts = nil)
Remove a finger from the screen.
@@ -1077,11 +1130,11 @@
[Hash] opts - a customizable set of options
--
-##### [tap](https://github.com/appium/ruby_lib/blob/95d3a6535472559590c4d043e887d15acc445a1a/lib/appium_lib/device/touch_actions.rb#L80)
+##### [tap](https://github.com/appium/ruby_lib/blob/ad91ee47a96bf7a19b6f784dc760ac70b8788e5a/lib/appium_lib/device/touch_actions.rb#L80)
> def tap(opts)
Touch a point on the screen
@@ -1089,11 +1142,11 @@
[Hash] opts - a customizable set of options
--
-##### [double_tap](https://github.com/appium/ruby_lib/blob/95d3a6535472559590c4d043e887d15acc445a1a/lib/appium_lib/device/touch_actions.rb#L93)
+##### [double_tap](https://github.com/appium/ruby_lib/blob/ad91ee47a96bf7a19b6f784dc760ac70b8788e5a/lib/appium_lib/device/touch_actions.rb#L93)
> def double_tap(opts)
Double tap an element on the screen
@@ -1101,11 +1154,11 @@
[Hash] opts - a customizable set of options
--
-##### [two_finger_tap](https://github.com/appium/ruby_lib/blob/95d3a6535472559590c4d043e887d15acc445a1a/lib/appium_lib/device/touch_actions.rb#L104)
+##### [two_finger_tap](https://github.com/appium/ruby_lib/blob/ad91ee47a96bf7a19b6f784dc760ac70b8788e5a/lib/appium_lib/device/touch_actions.rb#L104)
> def two_finger_tap(opts)
Two finger tap an element on the screen
@@ -1113,11 +1166,11 @@
[Hash] opts - a customizable set of options
--
-##### [wait](https://github.com/appium/ruby_lib/blob/95d3a6535472559590c4d043e887d15acc445a1a/lib/appium_lib/device/touch_actions.rb#L112)
+##### [wait](https://github.com/appium/ruby_lib/blob/ad91ee47a96bf7a19b6f784dc760ac70b8788e5a/lib/appium_lib/device/touch_actions.rb#L112)
> def wait(milliseconds)
Pause for a number of milliseconds before the next action
@@ -1125,11 +1178,11 @@
[integer] milliseconds - Number of milliseconds to pause for
--
-##### [swipe](https://github.com/appium/ruby_lib/blob/95d3a6535472559590c4d043e887d15acc445a1a/lib/appium_lib/device/touch_actions.rb#L127)
+##### [swipe](https://github.com/appium/ruby_lib/blob/ad91ee47a96bf7a19b6f784dc760ac70b8788e5a/lib/appium_lib/device/touch_actions.rb#L127)
> def swipe(opts)
Convenience method to peform a swipe.
@@ -1139,60 +1192,60 @@
[Hash] opts - a customizable set of options
--
-##### [perform](https://github.com/appium/ruby_lib/blob/95d3a6535472559590c4d043e887d15acc445a1a/lib/appium_lib/device/touch_actions.rb#L155)
+##### [perform](https://github.com/appium/ruby_lib/blob/ad91ee47a96bf7a19b6f784dc760ac70b8788e5a/lib/appium_lib/device/touch_actions.rb#L155)
> def perform
Ask the driver to perform all actions in this action chain.
--
-##### [cancel](https://github.com/appium/ruby_lib/blob/95d3a6535472559590c4d043e887d15acc445a1a/lib/appium_lib/device/touch_actions.rb#L161)
+##### [cancel](https://github.com/appium/ruby_lib/blob/ad91ee47a96bf7a19b6f784dc760ac70b8788e5a/lib/appium_lib/device/touch_actions.rb#L161)
> def cancel
Does nothing, currently.
--
-##### [chain_method](https://github.com/appium/ruby_lib/blob/95d3a6535472559590c4d043e887d15acc445a1a/lib/appium_lib/device/touch_actions.rb#L169)
+##### [chain_method](https://github.com/appium/ruby_lib/blob/ad91ee47a96bf7a19b6f784dc760ac70b8788e5a/lib/appium_lib/device/touch_actions.rb#L169)
> def chain_method(method, args = nil)
--
-##### [args_with_ele_ref](https://github.com/appium/ruby_lib/blob/95d3a6535472559590c4d043e887d15acc445a1a/lib/appium_lib/device/touch_actions.rb#L178)
+##### [args_with_ele_ref](https://github.com/appium/ruby_lib/blob/ad91ee47a96bf7a19b6f784dc760ac70b8788e5a/lib/appium_lib/device/touch_actions.rb#L178)
> def args_with_ele_ref(args)
--
-##### [_generic_wait](https://github.com/appium/ruby_lib/blob/95d3a6535472559590c4d043e887d15acc445a1a/lib/appium_lib/common/wait.rb#L9)
+##### [_generic_wait](https://github.com/appium/ruby_lib/blob/ad91ee47a96bf7a19b6f784dc760ac70b8788e5a/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/95d3a6535472559590c4d043e887d15acc445a1a/lib/appium_lib/common/wait.rb#L54)
+##### [_process_wait_opts](https://github.com/appium/ruby_lib/blob/ad91ee47a96bf7a19b6f784dc760ac70b8788e5a/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/95d3a6535472559590c4d043e887d15acc445a1a/lib/appium_lib/common/wait.rb#L75)
+##### [wait_true](https://github.com/appium/ruby_lib/blob/ad91ee47a96bf7a19b6f784dc760ac70b8788e5a/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.
@@ -1208,11 +1261,11 @@
[Hash] opts - Options
--
-##### [wait](https://github.com/appium/ruby_lib/blob/95d3a6535472559590c4d043e887d15acc445a1a/lib/appium_lib/common/wait.rb#L93)
+##### [wait](https://github.com/appium/ruby_lib/blob/ad91ee47a96bf7a19b6f784dc760ac70b8788e5a/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.
@@ -1226,19 +1279,19 @@
[Hash] opts - Options
--
-##### [ignore](https://github.com/appium/ruby_lib/blob/95d3a6535472559590c4d043e887d15acc445a1a/lib/appium_lib/common/helper.rb#L24)
+##### [ignore](https://github.com/appium/ruby_lib/blob/ad91ee47a96bf7a19b6f784dc760ac70b8788e5a/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/95d3a6535472559590c4d043e887d15acc445a1a/lib/appium_lib/common/helper.rb#L31)
+##### [back](https://github.com/appium/ruby_lib/blob/ad91ee47a96bf7a19b6f784dc760ac70b8788e5a/lib/appium_lib/common/helper.rb#L31)
> def back
Navigate back.
@@ -1246,19 +1299,19 @@
[void]
--
-##### [session_id](https://github.com/appium/ruby_lib/blob/95d3a6535472559590c4d043e887d15acc445a1a/lib/appium_lib/common/helper.rb#L36)
+##### [session_id](https://github.com/appium/ruby_lib/blob/ad91ee47a96bf7a19b6f784dc760ac70b8788e5a/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/95d3a6535472559590c4d043e887d15acc445a1a/lib/appium_lib/common/helper.rb#L44)
+##### [xpath](https://github.com/appium/ruby_lib/blob/ad91ee47a96bf7a19b6f784dc760ac70b8788e5a/lib/appium_lib/common/helper.rb#L44)
> def xpath(xpath_str)
Returns the first element that matches the provided xpath.
@@ -1270,11 +1323,11 @@
[Element]
--
-##### [xpaths](https://github.com/appium/ruby_lib/blob/95d3a6535472559590c4d043e887d15acc445a1a/lib/appium_lib/common/helper.rb#L52)
+##### [xpaths](https://github.com/appium/ruby_lib/blob/ad91ee47a96bf7a19b6f784dc760ac70b8788e5a/lib/appium_lib/common/helper.rb#L52)
> def xpaths(xpath_str)
Returns all elements that match the provided xpath.
@@ -1286,27 +1339,27 @@
[Array<Element>]
--
-##### [_print_source](https://github.com/appium/ruby_lib/blob/95d3a6535472559590c4d043e887d15acc445a1a/lib/appium_lib/common/helper.rb#L56)
+##### [_print_source](https://github.com/appium/ruby_lib/blob/ad91ee47a96bf7a19b6f784dc760ac70b8788e5a/lib/appium_lib/common/helper.rb#L56)
> def _print_source(source)
--
-##### [result](https://github.com/appium/ruby_lib/blob/95d3a6535472559590c4d043e887d15acc445a1a/lib/appium_lib/common/helper.rb#L69)
+##### [result](https://github.com/appium/ruby_lib/blob/ad91ee47a96bf7a19b6f784dc760ac70b8788e5a/lib/appium_lib/common/helper.rb#L69)
> def result
Returns the value of attribute result
--
-##### [initialize](https://github.com/appium/ruby_lib/blob/95d3a6535472559590c4d043e887d15acc445a1a/lib/appium_lib/common/helper.rb#L71)
+##### [initialize](https://github.com/appium/ruby_lib/blob/ad91ee47a96bf7a19b6f784dc760ac70b8788e5a/lib/appium_lib/common/helper.rb#L71)
> def initialize
@@ -1314,52 +1367,52 @@
[CountElements] a new instance of CountElements
--
-##### [reset](https://github.com/appium/ruby_lib/blob/95d3a6535472559590c4d043e887d15acc445a1a/lib/appium_lib/common/helper.rb#L75)
+##### [reset](https://github.com/appium/ruby_lib/blob/ad91ee47a96bf7a19b6f784dc760ac70b8788e5a/lib/appium_lib/common/helper.rb#L75)
> def reset
--
-##### [start_element](https://github.com/appium/ruby_lib/blob/95d3a6535472559590c4d043e887d15acc445a1a/lib/appium_lib/common/helper.rb#L80)
+##### [start_element](https://github.com/appium/ruby_lib/blob/ad91ee47a96bf7a19b6f784dc760ac70b8788e5a/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/95d3a6535472559590c4d043e887d15acc445a1a/lib/appium_lib/common/helper.rb#L86)
+##### [formatted_result](https://github.com/appium/ruby_lib/blob/ad91ee47a96bf7a19b6f784dc760ac70b8788e5a/lib/appium_lib/common/helper.rb#L86)
> def formatted_result
--
-##### [get_page_class](https://github.com/appium/ruby_lib/blob/95d3a6535472559590c4d043e887d15acc445a1a/lib/appium_lib/common/helper.rb#L97)
+##### [get_page_class](https://github.com/appium/ruby_lib/blob/ad91ee47a96bf7a19b6f784dc760ac70b8788e5a/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/95d3a6535472559590c4d043e887d15acc445a1a/lib/appium_lib/common/helper.rb#L108)
+##### [page_class](https://github.com/appium/ruby_lib/blob/ad91ee47a96bf7a19b6f784dc760ac70b8788e5a/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/95d3a6535472559590c4d043e887d15acc445a1a/lib/appium_lib/common/helper.rb#L118)
+##### [px_to_window_rel](https://github.com/appium/ruby_lib/blob/ad91ee47a96bf7a19b6f784dc760ac70b8788e5a/lib/appium_lib/common/helper.rb#L118)
> def px_to_window_rel(opts = {})
Converts pixel values to window relative values
@@ -1367,11 +1420,11 @@
px_to_window_rel x: 50, y: 150
```
--
-##### [xml_keys](https://github.com/appium/ruby_lib/blob/95d3a6535472559590c4d043e887d15acc445a1a/lib/appium_lib/common/helper.rb#L137)
+##### [xml_keys](https://github.com/appium/ruby_lib/blob/ad91ee47a96bf7a19b6f784dc760ac70b8788e5a/lib/appium_lib/common/helper.rb#L137)
> def xml_keys(target)
Search strings.xml's values for target.
@@ -1383,11 +1436,11 @@
[Array]
--
-##### [xml_values](https://github.com/appium/ruby_lib/blob/95d3a6535472559590c4d043e887d15acc445a1a/lib/appium_lib/common/helper.rb#L145)
+##### [xml_values](https://github.com/appium/ruby_lib/blob/ad91ee47a96bf7a19b6f784dc760ac70b8788e5a/lib/appium_lib/common/helper.rb#L145)
> def xml_values(target)
Search strings.xml's keys for target.
@@ -1399,11 +1452,11 @@
[Array]
--
-##### [resolve_id](https://github.com/appium/ruby_lib/blob/95d3a6535472559590c4d043e887d15acc445a1a/lib/appium_lib/common/helper.rb#L153)
+##### [resolve_id](https://github.com/appium/ruby_lib/blob/ad91ee47a96bf7a19b6f784dc760ac70b8788e5a/lib/appium_lib/common/helper.rb#L153)
> def resolve_id(id)
Resolve id in strings.xml and return the value.
@@ -1415,27 +1468,27 @@
[String]
--
-##### [filter](https://github.com/appium/ruby_lib/blob/95d3a6535472559590c4d043e887d15acc445a1a/lib/appium_lib/common/helper.rb#L159)
+##### [filter](https://github.com/appium/ruby_lib/blob/ad91ee47a96bf7a19b6f784dc760ac70b8788e5a/lib/appium_lib/common/helper.rb#L159)
> def filter
Returns the value of attribute filter
--
-##### [filter=](https://github.com/appium/ruby_lib/blob/95d3a6535472559590c4d043e887d15acc445a1a/lib/appium_lib/common/helper.rb#L162)
+##### [filter=](https://github.com/appium/ruby_lib/blob/ad91ee47a96bf7a19b6f784dc760ac70b8788e5a/lib/appium_lib/common/helper.rb#L162)
> def filter=(value)
convert to string to support symbols
--
-##### [initialize](https://github.com/appium/ruby_lib/blob/95d3a6535472559590c4d043e887d15acc445a1a/lib/appium_lib/common/helper.rb#L168)
+##### [initialize](https://github.com/appium/ruby_lib/blob/ad91ee47a96bf7a19b6f784dc760ac70b8788e5a/lib/appium_lib/common/helper.rb#L168)
> def initialize
@@ -1443,67 +1496,67 @@
[HTMLElements] a new instance of HTMLElements
--
-##### [reset](https://github.com/appium/ruby_lib/blob/95d3a6535472559590c4d043e887d15acc445a1a/lib/appium_lib/common/helper.rb#L173)
+##### [reset](https://github.com/appium/ruby_lib/blob/ad91ee47a96bf7a19b6f784dc760ac70b8788e5a/lib/appium_lib/common/helper.rb#L173)
> def reset
--
-##### [result](https://github.com/appium/ruby_lib/blob/95d3a6535472559590c4d043e887d15acc445a1a/lib/appium_lib/common/helper.rb#L179)
+##### [result](https://github.com/appium/ruby_lib/blob/ad91ee47a96bf7a19b6f784dc760ac70b8788e5a/lib/appium_lib/common/helper.rb#L179)
> def result
--
-##### [start_element](https://github.com/appium/ruby_lib/blob/95d3a6535472559590c4d043e887d15acc445a1a/lib/appium_lib/common/helper.rb#L195)
+##### [start_element](https://github.com/appium/ruby_lib/blob/ad91ee47a96bf7a19b6f784dc760ac70b8788e5a/lib/appium_lib/common/helper.rb#L195)
> def start_element(name, attrs = [])
--
-##### [end_element](https://github.com/appium/ruby_lib/blob/95d3a6535472559590c4d043e887d15acc445a1a/lib/appium_lib/common/helper.rb#L204)
+##### [end_element](https://github.com/appium/ruby_lib/blob/ad91ee47a96bf7a19b6f784dc760ac70b8788e5a/lib/appium_lib/common/helper.rb#L204)
> def end_element(name)
--
-##### [characters](https://github.com/appium/ruby_lib/blob/95d3a6535472559590c4d043e887d15acc445a1a/lib/appium_lib/common/helper.rb#L210)
+##### [characters](https://github.com/appium/ruby_lib/blob/ad91ee47a96bf7a19b6f784dc760ac70b8788e5a/lib/appium_lib/common/helper.rb#L210)
> def characters(chars)
--
-##### [_no_such_element](https://github.com/appium/ruby_lib/blob/95d3a6535472559590c4d043e887d15acc445a1a/lib/appium_lib/common/helper.rb#L217)
+##### [_no_such_element](https://github.com/appium/ruby_lib/blob/ad91ee47a96bf7a19b6f784dc760ac70b8788e5a/lib/appium_lib/common/helper.rb#L217)
> def _no_such_element
--
-##### [window_size](https://github.com/appium/ruby_lib/blob/95d3a6535472559590c4d043e887d15acc445a1a/lib/appium_lib/common/element/window.rb#L5)
+##### [window_size](https://github.com/appium/ruby_lib/blob/ad91ee47a96bf7a19b6f784dc760ac70b8788e5a/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/95d3a6535472559590c4d043e887d15acc445a1a/lib/appium_lib/ios/helper.rb#L8) ios
+##### [ios_password](https://github.com/appium/ruby_lib/blob/ad91ee47a96bf7a19b6f784dc760ac70b8788e5a/lib/appium_lib/ios/helper.rb#L8) ios
> def ios_password(length = 1)
iOS only. On Android uiautomator always returns an empty string for EditText password.
@@ -1517,11 +1570,11 @@
[String] the returned string is of size length
--
-##### [get_page](https://github.com/appium/ruby_lib/blob/95d3a6535472559590c4d043e887d15acc445a1a/lib/appium_lib/ios/helper.rb#L20) ios
+##### [get_page](https://github.com/appium/ruby_lib/blob/ad91ee47a96bf7a19b6f784dc760ac70b8788e5a/lib/appium_lib/ios/helper.rb#L20) ios
> def get_page(element = source_window(0), class_name = nil)
Returns a string of interesting elements. iOS only.
@@ -1538,11 +1591,11 @@
[String]
--
-##### [page](https://github.com/appium/ruby_lib/blob/95d3a6535472559590c4d043e887d15acc445a1a/lib/appium_lib/ios/helper.rb#L129) ios
+##### [page](https://github.com/appium/ruby_lib/blob/ad91ee47a96bf7a19b6f784dc760ac70b8788e5a/lib/appium_lib/ios/helper.rb#L129) ios
> def page(opts = {})
Prints a string of interesting elements to the console.
@@ -1564,11 +1617,11 @@
[void]
--
-##### [source_window](https://github.com/appium/ruby_lib/blob/95d3a6535472559590c4d043e887d15acc445a1a/lib/appium_lib/ios/helper.rb#L161) ios
+##### [source_window](https://github.com/appium/ruby_lib/blob/ad91ee47a96bf7a19b6f784dc760ac70b8788e5a/lib/appium_lib/ios/helper.rb#L161) ios
> def source_window(window_number = 0)
Gets the JSON source of window number
@@ -1580,11 +1633,11 @@
[JSON]
--
-##### [page_window](https://github.com/appium/ruby_lib/blob/95d3a6535472559590c4d043e887d15acc445a1a/lib/appium_lib/ios/helper.rb#L175) ios
+##### [page_window](https://github.com/appium/ruby_lib/blob/ad91ee47a96bf7a19b6f784dc760ac70b8788e5a/lib/appium_lib/ios/helper.rb#L175) ios
> def page_window(window_number = 0)
Prints parsed page source to console.
@@ -1598,11 +1651,11 @@
[void]
--
-##### [id](https://github.com/appium/ruby_lib/blob/95d3a6535472559590c4d043e887d15acc445a1a/lib/appium_lib/ios/helper.rb#L183) ios
+##### [id](https://github.com/appium/ruby_lib/blob/ad91ee47a96bf7a19b6f784dc760ac70b8788e5a/lib/appium_lib/ios/helper.rb#L183) ios
> def id(id)
Find by id
@@ -1614,11 +1667,11 @@
[Element]
--
-##### [ios_version](https://github.com/appium/ruby_lib/blob/95d3a6535472559590c4d043e887d15acc445a1a/lib/appium_lib/ios/helper.rb#L189) ios
+##### [ios_version](https://github.com/appium/ruby_lib/blob/ad91ee47a96bf7a19b6f784dc760ac70b8788e5a/lib/appium_lib/ios/helper.rb#L189) ios
> def ios_version
Return the iOS version as an array of integers
@@ -1626,11 +1679,11 @@
[Array<Integer>]
--
-##### [ele_index](https://github.com/appium/ruby_lib/blob/95d3a6535472559590c4d043e887d15acc445a1a/lib/appium_lib/ios/helper.rb#L198) ios
+##### [ele_index](https://github.com/appium/ruby_lib/blob/ad91ee47a96bf7a19b6f784dc760ac70b8788e5a/lib/appium_lib/ios/helper.rb#L198) ios
> def ele_index(class_name, index)
Get the element of type class_name at matching index.
@@ -1644,11 +1697,11 @@
[Element]
--
-##### [find_ele_by_attr](https://github.com/appium/ruby_lib/blob/95d3a6535472559590c4d043e887d15acc445a1a/lib/appium_lib/ios/helper.rb#L225) ios
+##### [find_ele_by_attr](https://github.com/appium/ruby_lib/blob/ad91ee47a96bf7a19b6f784dc760ac70b8788e5a/lib/appium_lib/ios/helper.rb#L225) ios
> def find_ele_by_attr(class_name, attr, value)
Find the first element exactly matching class and attribute value.
Note: Uses XPath
@@ -1665,11 +1718,11 @@
[Element]
--
-##### [find_eles_by_attr](https://github.com/appium/ruby_lib/blob/95d3a6535472559590c4d043e887d15acc445a1a/lib/appium_lib/ios/helper.rb#L235) ios
+##### [find_eles_by_attr](https://github.com/appium/ruby_lib/blob/ad91ee47a96bf7a19b6f784dc760ac70b8788e5a/lib/appium_lib/ios/helper.rb#L235) ios
> def find_eles_by_attr(class_name, attr, value)
Find all elements exactly matching class and attribute value.
Note: Uses XPath
@@ -1686,11 +1739,11 @@
[Array<Element>]
--
-##### [find_ele_by_attr_include](https://github.com/appium/ruby_lib/blob/95d3a6535472559590c4d043e887d15acc445a1a/lib/appium_lib/ios/helper.rb#L250) ios
+##### [find_ele_by_attr_include](https://github.com/appium/ruby_lib/blob/ad91ee47a96bf7a19b6f784dc760ac70b8788e5a/lib/appium_lib/ios/helper.rb#L250) ios
> def find_ele_by_attr_include(class_name, attr, value)
Get the first tag by attribute that exactly matches value.
Note: Uses XPath
@@ -1707,11 +1760,11 @@
[Element] the element of type tag who's attribute includes value
--
-##### [find_eles_by_attr_include](https://github.com/appium/ruby_lib/blob/95d3a6535472559590c4d043e887d15acc445a1a/lib/appium_lib/ios/helper.rb#L260) ios
+##### [find_eles_by_attr_include](https://github.com/appium/ruby_lib/blob/ad91ee47a96bf7a19b6f784dc760ac70b8788e5a/lib/appium_lib/ios/helper.rb#L260) ios
> def find_eles_by_attr_include(class_name, attr, value)
Get tags by attribute that include value.
Note: Uses XPath
@@ -1728,11 +1781,11 @@
[Array<Element>] the elements of type tag who's attribute includes value
--
-##### [first_ele](https://github.com/appium/ruby_lib/blob/95d3a6535472559590c4d043e887d15acc445a1a/lib/appium_lib/ios/helper.rb#L267) ios
+##### [first_ele](https://github.com/appium/ruby_lib/blob/ad91ee47a96bf7a19b6f784dc760ac70b8788e5a/lib/appium_lib/ios/helper.rb#L267) ios
> def first_ele(class_name)
Get the first tag that matches class_name
@@ -1744,11 +1797,11 @@
[Element]
--
-##### [last_ele](https://github.com/appium/ruby_lib/blob/95d3a6535472559590c4d043e887d15acc445a1a/lib/appium_lib/ios/helper.rb#L275) ios
+##### [last_ele](https://github.com/appium/ruby_lib/blob/ad91ee47a96bf7a19b6f784dc760ac70b8788e5a/lib/appium_lib/ios/helper.rb#L275) ios
> def last_ele(class_name)
Get the last tag that matches class_name
@@ -1760,11 +1813,11 @@
[Element]
--
-##### [tag](https://github.com/appium/ruby_lib/blob/95d3a6535472559590c4d043e887d15acc445a1a/lib/appium_lib/ios/helper.rb#L283) ios
+##### [tag](https://github.com/appium/ruby_lib/blob/ad91ee47a96bf7a19b6f784dc760ac70b8788e5a/lib/appium_lib/ios/helper.rb#L283) ios
> def tag(class_name)
Returns the first visible element matching class_name
@@ -1776,11 +1829,11 @@
[Element]
--
-##### [tags](https://github.com/appium/ruby_lib/blob/95d3a6535472559590c4d043e887d15acc445a1a/lib/appium_lib/ios/helper.rb#L294) ios
+##### [tags](https://github.com/appium/ruby_lib/blob/ad91ee47a96bf7a19b6f784dc760ac70b8788e5a/lib/appium_lib/ios/helper.rb#L294) ios
> def tags(class_name)
Returns all visible elements matching class_name
@@ -1792,11 +1845,11 @@
[Element]
--
-##### [ele_by_json_visible_contains](https://github.com/appium/ruby_lib/blob/95d3a6535472559590c4d043e887d15acc445a1a/lib/appium_lib/ios/helper.rb#L329) ios
+##### [ele_by_json_visible_contains](https://github.com/appium/ruby_lib/blob/ad91ee47a96bf7a19b6f784dc760ac70b8788e5a/lib/appium_lib/ios/helper.rb#L329) ios
> def ele_by_json_visible_contains(element, value)
Find the first element that contains value
@@ -1810,11 +1863,11 @@
[Element]
--
-##### [eles_by_json_visible_contains](https://github.com/appium/ruby_lib/blob/95d3a6535472559590c4d043e887d15acc445a1a/lib/appium_lib/ios/helper.rb#L337) ios
+##### [eles_by_json_visible_contains](https://github.com/appium/ruby_lib/blob/ad91ee47a96bf7a19b6f784dc760ac70b8788e5a/lib/appium_lib/ios/helper.rb#L337) ios
> def eles_by_json_visible_contains(element, value)
Find all elements containing value
@@ -1828,11 +1881,11 @@
[Array<Element>]
--
-##### [ele_by_json_visible_exact](https://github.com/appium/ruby_lib/blob/95d3a6535472559590c4d043e887d15acc445a1a/lib/appium_lib/ios/helper.rb#L366) ios
+##### [ele_by_json_visible_exact](https://github.com/appium/ruby_lib/blob/ad91ee47a96bf7a19b6f784dc760ac70b8788e5a/lib/appium_lib/ios/helper.rb#L366) ios
> def ele_by_json_visible_exact(element, value)
Find the first element exactly matching value
@@ -1846,11 +1899,11 @@
[Element]
--
-##### [eles_by_json_visible_exact](https://github.com/appium/ruby_lib/blob/95d3a6535472559590c4d043e887d15acc445a1a/lib/appium_lib/ios/helper.rb#L374) ios
+##### [eles_by_json_visible_exact](https://github.com/appium/ruby_lib/blob/ad91ee47a96bf7a19b6f784dc760ac70b8788e5a/lib/appium_lib/ios/helper.rb#L374) ios
> def eles_by_json_visible_exact(element, value)
Find all elements exactly matching value
@@ -1864,21 +1917,21 @@
[Element]
--
-##### [_all_pred](https://github.com/appium/ruby_lib/blob/95d3a6535472559590c4d043e887d15acc445a1a/lib/appium_lib/ios/helper.rb#L438) ios
+##### [_all_pred](https://github.com/appium/ruby_lib/blob/ad91ee47a96bf7a19b6f784dc760ac70b8788e5a/lib/appium_lib/ios/helper.rb#L438) 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/95d3a6535472559590c4d043e887d15acc445a1a/lib/appium_lib/ios/helper.rb#L451) ios
+##### [ele_with_pred](https://github.com/appium/ruby_lib/blob/ad91ee47a96bf7a19b6f784dc760ac70b8788e5a/lib/appium_lib/ios/helper.rb#L451) ios
> def ele_with_pred(opts)
returns element matching predicate contained in the main app
@@ -1890,11 +1943,11 @@
[Element]
--
-##### [eles_with_pred](https://github.com/appium/ruby_lib/blob/95d3a6535472559590c4d043e887d15acc445a1a/lib/appium_lib/ios/helper.rb#L462) ios
+##### [eles_with_pred](https://github.com/appium/ruby_lib/blob/ad91ee47a96bf7a19b6f784dc760ac70b8788e5a/lib/appium_lib/ios/helper.rb#L462) ios
> def eles_with_pred(opts)
returns elements matching predicate contained in the main app
@@ -1906,11 +1959,11 @@
[Array<Element>]
--
-##### [source](https://github.com/appium/ruby_lib/blob/95d3a6535472559590c4d043e887d15acc445a1a/lib/appium_lib/ios/helper.rb#L468) ios
+##### [source](https://github.com/appium/ruby_lib/blob/ad91ee47a96bf7a19b6f784dc760ac70b8788e5a/lib/appium_lib/ios/helper.rb#L468) ios
> def source
Prints xml of the current page
@@ -1918,19 +1971,19 @@
[void]
--
-##### [_validate_object](https://github.com/appium/ruby_lib/blob/95d3a6535472559590c4d043e887d15acc445a1a/lib/appium_lib/ios/helper.rb#L472) ios
+##### [_validate_object](https://github.com/appium/ruby_lib/blob/ad91ee47a96bf7a19b6f784dc760ac70b8788e5a/lib/appium_lib/ios/helper.rb#L472) ios
> def _validate_object(*objects)
--
-##### [_by_json](https://github.com/appium/ruby_lib/blob/95d3a6535472559590c4d043e887d15acc445a1a/lib/appium_lib/ios/helper.rb#L520) ios
+##### [_by_json](https://github.com/appium/ruby_lib/blob/ad91ee47a96bf7a19b6f784dc760ac70b8788e5a/lib/appium_lib/ios/helper.rb#L520) ios
> def _by_json(opts)
typeArray - array of string types to search for. Example: ["UIAStaticText"]
onlyFirst - boolean. returns only the first result if true. Example: true
@@ -1960,11 +2013,11 @@
}
}
--
-##### [eles_by_json](https://github.com/appium/ruby_lib/blob/95d3a6535472559590c4d043e887d15acc445a1a/lib/appium_lib/ios/helper.rb#L569) ios
+##### [eles_by_json](https://github.com/appium/ruby_lib/blob/ad91ee47a96bf7a19b6f784dc760ac70b8788e5a/lib/appium_lib/ios/helper.rb#L569) ios
> def eles_by_json(opts)
example usage:
@@ -1978,19 +2031,19 @@
},
})
--
-##### [ele_by_json](https://github.com/appium/ruby_lib/blob/95d3a6535472559590c4d043e887d15acc445a1a/lib/appium_lib/ios/helper.rb#L575) ios
+##### [ele_by_json](https://github.com/appium/ruby_lib/blob/ad91ee47a96bf7a19b6f784dc760ac70b8788e5a/lib/appium_lib/ios/helper.rb#L575) ios
> def ele_by_json(opts)
see eles_by_json
--
-##### [get_source](https://github.com/appium/ruby_lib/blob/95d3a6535472559590c4d043e887d15acc445a1a/lib/appium_lib/ios/helper.rb#L585) ios
+##### [get_source](https://github.com/appium/ruby_lib/blob/ad91ee47a96bf7a19b6f784dc760ac70b8788e5a/lib/appium_lib/ios/helper.rb#L585) ios
> def get_source
Returns XML string for the current page
Same as driver.page_source
@@ -1999,19 +2052,19 @@
[String]
--
-##### [UIAStaticText](https://github.com/appium/ruby_lib/blob/95d3a6535472559590c4d043e887d15acc445a1a/lib/appium_lib/ios/element/text.rb#L4) ios
+##### [UIAStaticText](https://github.com/appium/ruby_lib/blob/ad91ee47a96bf7a19b6f784dc760ac70b8788e5a/lib/appium_lib/ios/element/text.rb#L4) ios
> UIAStaticText = 'UIAStaticText'
--
-##### [text](https://github.com/appium/ruby_lib/blob/95d3a6535472559590c4d043e887d15acc445a1a/lib/appium_lib/ios/element/text.rb#L10) ios
+##### [text](https://github.com/appium/ruby_lib/blob/ad91ee47a96bf7a19b6f784dc760ac70b8788e5a/lib/appium_lib/ios/element/text.rb#L10) ios
> def text(value)
Find the first UIAStaticText that contains value or by index.
If int then the UIAStaticText at that index is returned.
@@ -2024,11 +2077,11 @@
[UIAStaticText]
--
-##### [texts](https://github.com/appium/ruby_lib/blob/95d3a6535472559590c4d043e887d15acc445a1a/lib/appium_lib/ios/element/text.rb#L19) ios
+##### [texts](https://github.com/appium/ruby_lib/blob/ad91ee47a96bf7a19b6f784dc760ac70b8788e5a/lib/appium_lib/ios/element/text.rb#L19) ios
> def texts(value = false)
Find all UIAStaticText containing value.
If value is omitted, all UIAStaticTexts are returned
@@ -2041,11 +2094,11 @@
[Array<UIAStaticText>]
--
-##### [first_text](https://github.com/appium/ruby_lib/blob/95d3a6535472559590c4d043e887d15acc445a1a/lib/appium_lib/ios/element/text.rb#L26) ios
+##### [first_text](https://github.com/appium/ruby_lib/blob/ad91ee47a96bf7a19b6f784dc760ac70b8788e5a/lib/appium_lib/ios/element/text.rb#L26) ios
> def first_text
Find the first UIAStaticText.
@@ -2053,11 +2106,11 @@
[UIAStaticText]
--
-##### [last_text](https://github.com/appium/ruby_lib/blob/95d3a6535472559590c4d043e887d15acc445a1a/lib/appium_lib/ios/element/text.rb#L32) ios
+##### [last_text](https://github.com/appium/ruby_lib/blob/ad91ee47a96bf7a19b6f784dc760ac70b8788e5a/lib/appium_lib/ios/element/text.rb#L32) ios
> def last_text
Find the last UIAStaticText.
@@ -2065,11 +2118,11 @@
[UIAStaticText]
--
-##### [text_exact](https://github.com/appium/ruby_lib/blob/95d3a6535472559590c4d043e887d15acc445a1a/lib/appium_lib/ios/element/text.rb#L39) ios
+##### [text_exact](https://github.com/appium/ruby_lib/blob/ad91ee47a96bf7a19b6f784dc760ac70b8788e5a/lib/appium_lib/ios/element/text.rb#L39) ios
> def text_exact(value)
Find the first UIAStaticText that exactly matches value.
@@ -2081,11 +2134,11 @@
[UIAStaticText]
--
-##### [texts_exact](https://github.com/appium/ruby_lib/blob/95d3a6535472559590c4d043e887d15acc445a1a/lib/appium_lib/ios/element/text.rb#L46) ios
+##### [texts_exact](https://github.com/appium/ruby_lib/blob/ad91ee47a96bf7a19b6f784dc760ac70b8788e5a/lib/appium_lib/ios/element/text.rb#L46) ios
> def texts_exact(value)
Find all UIAStaticTexts that exactly match value.
@@ -2097,11 +2150,11 @@
[Array<UIAStaticText>]
--
-##### [alert_accept](https://github.com/appium/ruby_lib/blob/95d3a6535472559590c4d043e887d15acc445a1a/lib/appium_lib/ios/element/alert.rb#L5) ios
+##### [alert_accept](https://github.com/appium/ruby_lib/blob/ad91ee47a96bf7a19b6f784dc760ac70b8788e5a/lib/appium_lib/ios/element/alert.rb#L5) ios
> def alert_accept
Accept the alert.
@@ -2109,11 +2162,11 @@
[void]
--
-##### [alert_dismiss](https://github.com/appium/ruby_lib/blob/95d3a6535472559590c4d043e887d15acc445a1a/lib/appium_lib/ios/element/alert.rb#L13) ios
+##### [alert_dismiss](https://github.com/appium/ruby_lib/blob/ad91ee47a96bf7a19b6f784dc760ac70b8788e5a/lib/appium_lib/ios/element/alert.rb#L13) ios
> def alert_dismiss
Dismiss the alert.
@@ -2121,11 +2174,11 @@
[void]
--
-##### [uiautomation_find](https://github.com/appium/ruby_lib/blob/95d3a6535472559590c4d043e887d15acc445a1a/lib/appium_lib/ios/mobile_methods.rb#L10) ios
+##### [uiautomation_find](https://github.com/appium/ruby_lib/blob/ad91ee47a96bf7a19b6f784dc760ac70b8788e5a/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).
@@ -2133,19 +2186,19 @@
find_elements :uiautomation, 'elements()
```
--
-##### [UIAButton](https://github.com/appium/ruby_lib/blob/95d3a6535472559590c4d043e887d15acc445a1a/lib/appium_lib/ios/element/button.rb#L4) ios
+##### [UIAButton](https://github.com/appium/ruby_lib/blob/ad91ee47a96bf7a19b6f784dc760ac70b8788e5a/lib/appium_lib/ios/element/button.rb#L4) ios
> UIAButton = 'UIAButton'
--
-##### [button](https://github.com/appium/ruby_lib/blob/95d3a6535472559590c4d043e887d15acc445a1a/lib/appium_lib/ios/element/button.rb#L10) ios
+##### [button](https://github.com/appium/ruby_lib/blob/ad91ee47a96bf7a19b6f784dc760ac70b8788e5a/lib/appium_lib/ios/element/button.rb#L10) ios
> def button(value)
Find the first UIAButton that contains value or by index.
If int then the UIAButton at that index is returned.
@@ -2158,11 +2211,11 @@
[UIAButton]
--
-##### [buttons](https://github.com/appium/ruby_lib/blob/95d3a6535472559590c4d043e887d15acc445a1a/lib/appium_lib/ios/element/button.rb#L20) ios
+##### [buttons](https://github.com/appium/ruby_lib/blob/ad91ee47a96bf7a19b6f784dc760ac70b8788e5a/lib/appium_lib/ios/element/button.rb#L20) ios
> def buttons(value = false)
Find all UIAButtons containing value.
If value is omitted, all UIAButtons are returned.
@@ -2175,11 +2228,11 @@
[Array<UIAButton>]
--
-##### [first_button](https://github.com/appium/ruby_lib/blob/95d3a6535472559590c4d043e887d15acc445a1a/lib/appium_lib/ios/element/button.rb#L27) ios
+##### [first_button](https://github.com/appium/ruby_lib/blob/ad91ee47a96bf7a19b6f784dc760ac70b8788e5a/lib/appium_lib/ios/element/button.rb#L27) ios
> def first_button
Find the first UIAButton.
@@ -2187,11 +2240,11 @@
[UIAButton]
--
-##### [last_button](https://github.com/appium/ruby_lib/blob/95d3a6535472559590c4d043e887d15acc445a1a/lib/appium_lib/ios/element/button.rb#L33) ios
+##### [last_button](https://github.com/appium/ruby_lib/blob/ad91ee47a96bf7a19b6f784dc760ac70b8788e5a/lib/appium_lib/ios/element/button.rb#L33) ios
> def last_button
Find the last UIAButton.
@@ -2199,11 +2252,11 @@
[UIAButton]
--
-##### [button_exact](https://github.com/appium/ruby_lib/blob/95d3a6535472559590c4d043e887d15acc445a1a/lib/appium_lib/ios/element/button.rb#L40) ios
+##### [button_exact](https://github.com/appium/ruby_lib/blob/ad91ee47a96bf7a19b6f784dc760ac70b8788e5a/lib/appium_lib/ios/element/button.rb#L40) ios
> def button_exact(value)
Find the first UIAButton that exactly matches value.
@@ -2215,11 +2268,11 @@
[UIAButton]
--
-##### [buttons_exact](https://github.com/appium/ruby_lib/blob/95d3a6535472559590c4d043e887d15acc445a1a/lib/appium_lib/ios/element/button.rb#L47) ios
+##### [buttons_exact](https://github.com/appium/ruby_lib/blob/ad91ee47a96bf7a19b6f784dc760ac70b8788e5a/lib/appium_lib/ios/element/button.rb#L47) ios
> def buttons_exact(value)
Find all UIAButtons that exactly match value.
@@ -2231,11 +2284,11 @@
[Array<UIAButton>]
--
-##### [find](https://github.com/appium/ruby_lib/blob/95d3a6535472559590c4d043e887d15acc445a1a/lib/appium_lib/ios/element/generic.rb#L6) ios
+##### [find](https://github.com/appium/ruby_lib/blob/ad91ee47a96bf7a19b6f784dc760ac70b8788e5a/lib/appium_lib/ios/element/generic.rb#L6) ios
> def find(value)
Find the first element containing value
@@ -2247,11 +2300,11 @@
[Element]
--
-##### [finds](https://github.com/appium/ruby_lib/blob/95d3a6535472559590c4d043e887d15acc445a1a/lib/appium_lib/ios/element/generic.rb#L13) ios
+##### [finds](https://github.com/appium/ruby_lib/blob/ad91ee47a96bf7a19b6f784dc760ac70b8788e5a/lib/appium_lib/ios/element/generic.rb#L13) ios
> def finds(value)
Find all elements containing value
@@ -2263,11 +2316,11 @@
[Array<Element>]
--
-##### [find_exact](https://github.com/appium/ruby_lib/blob/95d3a6535472559590c4d043e887d15acc445a1a/lib/appium_lib/ios/element/generic.rb#L20) ios
+##### [find_exact](https://github.com/appium/ruby_lib/blob/ad91ee47a96bf7a19b6f784dc760ac70b8788e5a/lib/appium_lib/ios/element/generic.rb#L20) ios
> def find_exact(value)
Find the first element exactly matching value
@@ -2279,11 +2332,11 @@
[Element]
--
-##### [finds_exact](https://github.com/appium/ruby_lib/blob/95d3a6535472559590c4d043e887d15acc445a1a/lib/appium_lib/ios/element/generic.rb#L27) ios
+##### [finds_exact](https://github.com/appium/ruby_lib/blob/ad91ee47a96bf7a19b6f784dc760ac70b8788e5a/lib/appium_lib/ios/element/generic.rb#L27) ios
> def finds_exact(value)
Find all elements exactly matching value
@@ -2295,27 +2348,27 @@
[Array<Element>]
--
-##### [UIATextField](https://github.com/appium/ruby_lib/blob/95d3a6535472559590c4d043e887d15acc445a1a/lib/appium_lib/ios/element/textfield.rb#L3) ios
+##### [UIATextField](https://github.com/appium/ruby_lib/blob/ad91ee47a96bf7a19b6f784dc760ac70b8788e5a/lib/appium_lib/ios/element/textfield.rb#L3) ios
> UIATextField = 'UIATextField'
--
-##### [UIASecureTextField](https://github.com/appium/ruby_lib/blob/95d3a6535472559590c4d043e887d15acc445a1a/lib/appium_lib/ios/element/textfield.rb#L4) ios
+##### [UIASecureTextField](https://github.com/appium/ruby_lib/blob/ad91ee47a96bf7a19b6f784dc760ac70b8788e5a/lib/appium_lib/ios/element/textfield.rb#L4) ios
> UIASecureTextField = 'UIASecureTextField'
--
-##### [textfield](https://github.com/appium/ruby_lib/blob/95d3a6535472559590c4d043e887d15acc445a1a/lib/appium_lib/ios/element/textfield.rb#L52) ios
+##### [textfield](https://github.com/appium/ruby_lib/blob/ad91ee47a96bf7a19b6f784dc760ac70b8788e5a/lib/appium_lib/ios/element/textfield.rb#L52) ios
> def textfield(value)
Find the first TextField that contains value or by index.
If int then the TextField at that index is returned.
@@ -2328,11 +2381,11 @@
[TextField]
--
-##### [textfields](https://github.com/appium/ruby_lib/blob/95d3a6535472559590c4d043e887d15acc445a1a/lib/appium_lib/ios/element/textfield.rb#L72) ios
+##### [textfields](https://github.com/appium/ruby_lib/blob/ad91ee47a96bf7a19b6f784dc760ac70b8788e5a/lib/appium_lib/ios/element/textfield.rb#L72) ios
> def textfields(value = false)
Find all TextFields containing value.
If value is omitted, all TextFields are returned.
@@ -2345,11 +2398,11 @@
[Array<TextField>]
--
-##### [first_textfield](https://github.com/appium/ruby_lib/blob/95d3a6535472559590c4d043e887d15acc445a1a/lib/appium_lib/ios/element/textfield.rb#L79) ios
+##### [first_textfield](https://github.com/appium/ruby_lib/blob/ad91ee47a96bf7a19b6f784dc760ac70b8788e5a/lib/appium_lib/ios/element/textfield.rb#L79) ios
> def first_textfield
Find the first TextField.
@@ -2357,11 +2410,11 @@
[TextField]
--
-##### [last_textfield](https://github.com/appium/ruby_lib/blob/95d3a6535472559590c4d043e887d15acc445a1a/lib/appium_lib/ios/element/textfield.rb#L85) ios
+##### [last_textfield](https://github.com/appium/ruby_lib/blob/ad91ee47a96bf7a19b6f784dc760ac70b8788e5a/lib/appium_lib/ios/element/textfield.rb#L85) ios
> def last_textfield
Find the last TextField.
@@ -2369,11 +2422,11 @@
[TextField]
--
-##### [textfield_exact](https://github.com/appium/ruby_lib/blob/95d3a6535472559590c4d043e887d15acc445a1a/lib/appium_lib/ios/element/textfield.rb#L94) ios
+##### [textfield_exact](https://github.com/appium/ruby_lib/blob/ad91ee47a96bf7a19b6f784dc760ac70b8788e5a/lib/appium_lib/ios/element/textfield.rb#L94) ios
> def textfield_exact(value)
Find the first TextField that exactly matches value.
@@ -2385,11 +2438,11 @@
[TextField]
--
-##### [textfields_exact](https://github.com/appium/ruby_lib/blob/95d3a6535472559590c4d043e887d15acc445a1a/lib/appium_lib/ios/element/textfield.rb#L101) ios
+##### [textfields_exact](https://github.com/appium/ruby_lib/blob/ad91ee47a96bf7a19b6f784dc760ac70b8788e5a/lib/appium_lib/ios/element/textfield.rb#L101) ios
> def textfields_exact(value)
Find all TextFields that exactly match value.
@@ -2401,31 +2454,31 @@
[Array<TextField>]
--
-##### [value](https://github.com/appium/ruby_lib/blob/95d3a6535472559590c4d043e887d15acc445a1a/lib/appium_lib/common/patch.rb#L12)
+##### [value](https://github.com/appium/ruby_lib/blob/ad91ee47a96bf7a19b6f784dc760ac70b8788e5a/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/95d3a6535472559590c4d043e887d15acc445a1a/lib/appium_lib/common/patch.rb#L19)
+##### [name](https://github.com/appium/ruby_lib/blob/ad91ee47a96bf7a19b6f784dc760ac70b8788e5a/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/95d3a6535472559590c4d043e887d15acc445a1a/lib/appium_lib/common/patch.rb#L31)
+##### [location_rel](https://github.com/appium/ruby_lib/blob/ad91ee47a96bf7a19b6f784dc760ac70b8788e5a/lib/appium_lib/common/patch.rb#L31)
> def location_rel
For use with mobile tap.
@@ -2439,10 +2492,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/95d3a6535472559590c4d043e887d15acc445a1a/lib/appium_lib/common/patch.rb#L147)
+##### [DEFAULT_HEADERS](https://github.com/appium/ruby_lib/blob/ad91ee47a96bf7a19b6f784dc760ac70b8788e5a/lib/appium_lib/common/patch.rb#L147)
> DEFAULT_HEADERS = { 'Accept' => CONTENT_TYPE, 'User-Agent' => "appium/ruby_lib/#{::Appium::VERSION}" }