docs/ios_docs.md in appium_lib-8.0.1 vs docs/ios_docs.md in appium_lib-8.0.2

- old
+ new

@@ -1,6 +1,6 @@ -##### [load_appium_txt](https://github.com/appium/ruby_lib/blob/ed917866929f0f7b0ff7ef0aedb5a9b35fdcc95b/lib/appium_lib/driver.rb#L70) +##### [load_appium_txt](https://github.com/appium/ruby_lib/blob/d67cbbac43f511515f6e6f53197cfae2bb7671e0/lib/appium_lib/driver.rb#L70) > def self.load_appium_txt(opts = {}) Load appium.txt (toml format) the basedir of this file + appium.txt is what's used @@ -25,22 +25,22 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[hash] the symbolized hash with updated :app and :require keys -- -##### [symbolize_keys](https://github.com/appium/ruby_lib/blob/ed917866929f0f7b0ff7ef0aedb5a9b35fdcc95b/lib/appium_lib/driver.rb#L136) +##### [symbolize_keys](https://github.com/appium/ruby_lib/blob/d67cbbac43f511515f6e6f53197cfae2bb7671e0/lib/appium_lib/driver.rb#L136) > 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/ed917866929f0f7b0ff7ef0aedb5a9b35fdcc95b/lib/appium_lib/driver.rb#L157) +##### [promote_singleton_appium_methods](https://github.com/appium/ruby_lib/blob/d67cbbac43f511515f6e6f53197cfae2bb7671e0/lib/appium_lib/driver.rb#L157) > 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 +54,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/ed917866929f0f7b0ff7ef0aedb5a9b35fdcc95b/lib/appium_lib/driver.rb#L208) +##### [promote_appium_methods](https://github.com/appium/ruby_lib/blob/d67cbbac43f511515f6e6f53197cfae2bb7671e0/lib/appium_lib/driver.rb#L208) > def self.promote_appium_methods(class_array) Promote appium methods to class instance methods @@ -84,75 +84,75 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Array<Class>] class_array - An array of classes -- -##### [global_webdriver_http_sleep](https://github.com/appium/ruby_lib/blob/ed917866929f0f7b0ff7ef0aedb5a9b35fdcc95b/lib/appium_lib/driver.rb#L242) +##### [global_webdriver_http_sleep](https://github.com/appium/ruby_lib/blob/d67cbbac43f511515f6e6f53197cfae2bb7671e0/lib/appium_lib/driver.rb#L242) > 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/ed917866929f0f7b0ff7ef0aedb5a9b35fdcc95b/lib/appium_lib/driver.rb#L242) +##### [global_webdriver_http_sleep=](https://github.com/appium/ruby_lib/blob/d67cbbac43f511515f6e6f53197cfae2bb7671e0/lib/appium_lib/driver.rb#L242) > 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/ed917866929f0f7b0ff7ef0aedb5a9b35fdcc95b/lib/appium_lib/driver.rb#L244) +##### [caps](https://github.com/appium/ruby_lib/blob/d67cbbac43f511515f6e6f53197cfae2bb7671e0/lib/appium_lib/driver.rb#L244) > def caps Selenium webdriver capabilities -- -##### [caps=](https://github.com/appium/ruby_lib/blob/ed917866929f0f7b0ff7ef0aedb5a9b35fdcc95b/lib/appium_lib/driver.rb#L244) +##### [caps=](https://github.com/appium/ruby_lib/blob/d67cbbac43f511515f6e6f53197cfae2bb7671e0/lib/appium_lib/driver.rb#L244) > def caps=(value) Selenium webdriver capabilities -- -##### [custom_url](https://github.com/appium/ruby_lib/blob/ed917866929f0f7b0ff7ef0aedb5a9b35fdcc95b/lib/appium_lib/driver.rb#L246) +##### [custom_url](https://github.com/appium/ruby_lib/blob/d67cbbac43f511515f6e6f53197cfae2bb7671e0/lib/appium_lib/driver.rb#L246) > def custom_url Custom URL for the selenium server -- -##### [custom_url=](https://github.com/appium/ruby_lib/blob/ed917866929f0f7b0ff7ef0aedb5a9b35fdcc95b/lib/appium_lib/driver.rb#L246) +##### [custom_url=](https://github.com/appium/ruby_lib/blob/d67cbbac43f511515f6e6f53197cfae2bb7671e0/lib/appium_lib/driver.rb#L246) > def custom_url=(value) Custom URL for the selenium server -- -##### [export_session](https://github.com/appium/ruby_lib/blob/ed917866929f0f7b0ff7ef0aedb5a9b35fdcc95b/lib/appium_lib/driver.rb#L248) +##### [export_session](https://github.com/appium/ruby_lib/blob/d67cbbac43f511515f6e6f53197cfae2bb7671e0/lib/appium_lib/driver.rb#L248) > def export_session Export session id to textfile in /tmp for 3rd party tools -- -##### [export_session=](https://github.com/appium/ruby_lib/blob/ed917866929f0f7b0ff7ef0aedb5a9b35fdcc95b/lib/appium_lib/driver.rb#L248) +##### [export_session=](https://github.com/appium/ruby_lib/blob/d67cbbac43f511515f6e6f53197cfae2bb7671e0/lib/appium_lib/driver.rb#L248) > def export_session=(value) Export session id to textfile in /tmp for 3rd party tools -- -##### [default_wait](https://github.com/appium/ruby_lib/blob/ed917866929f0f7b0ff7ef0aedb5a9b35fdcc95b/lib/appium_lib/driver.rb#L253) +##### [default_wait](https://github.com/appium/ruby_lib/blob/d67cbbac43f511515f6e6f53197cfae2bb7671e0/lib/appium_lib/driver.rb#L253) > def default_wait Default wait time for elements to appear Returns the default client side wait. @@ -162,11 +162,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Integer] -- -##### [default_wait=](https://github.com/appium/ruby_lib/blob/ed917866929f0f7b0ff7ef0aedb5a9b35fdcc95b/lib/appium_lib/driver.rb#L253) +##### [default_wait=](https://github.com/appium/ruby_lib/blob/d67cbbac43f511515f6e6f53197cfae2bb7671e0/lib/appium_lib/driver.rb#L253) > def default_wait=(value) Default wait time for elements to appear Returns the default client side wait. @@ -176,107 +176,107 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Integer] -- -##### [last_waits](https://github.com/appium/ruby_lib/blob/ed917866929f0f7b0ff7ef0aedb5a9b35fdcc95b/lib/appium_lib/driver.rb#L255) +##### [last_waits](https://github.com/appium/ruby_lib/blob/d67cbbac43f511515f6e6f53197cfae2bb7671e0/lib/appium_lib/driver.rb#L255) > def last_waits Array of previous wait time values -- -##### [last_waits=](https://github.com/appium/ruby_lib/blob/ed917866929f0f7b0ff7ef0aedb5a9b35fdcc95b/lib/appium_lib/driver.rb#L255) +##### [last_waits=](https://github.com/appium/ruby_lib/blob/d67cbbac43f511515f6e6f53197cfae2bb7671e0/lib/appium_lib/driver.rb#L255) > def last_waits=(value) Array of previous wait time values -- -##### [sauce_username](https://github.com/appium/ruby_lib/blob/ed917866929f0f7b0ff7ef0aedb5a9b35fdcc95b/lib/appium_lib/driver.rb#L257) +##### [sauce_username](https://github.com/appium/ruby_lib/blob/d67cbbac43f511515f6e6f53197cfae2bb7671e0/lib/appium_lib/driver.rb#L257) > def sauce_username Username for use on Sauce Labs -- -##### [sauce_username=](https://github.com/appium/ruby_lib/blob/ed917866929f0f7b0ff7ef0aedb5a9b35fdcc95b/lib/appium_lib/driver.rb#L257) +##### [sauce_username=](https://github.com/appium/ruby_lib/blob/d67cbbac43f511515f6e6f53197cfae2bb7671e0/lib/appium_lib/driver.rb#L257) > def sauce_username=(value) Username for use on Sauce Labs -- -##### [sauce_access_key](https://github.com/appium/ruby_lib/blob/ed917866929f0f7b0ff7ef0aedb5a9b35fdcc95b/lib/appium_lib/driver.rb#L259) +##### [sauce_access_key](https://github.com/appium/ruby_lib/blob/d67cbbac43f511515f6e6f53197cfae2bb7671e0/lib/appium_lib/driver.rb#L259) > def sauce_access_key Access Key for use on Sauce Labs -- -##### [sauce_access_key=](https://github.com/appium/ruby_lib/blob/ed917866929f0f7b0ff7ef0aedb5a9b35fdcc95b/lib/appium_lib/driver.rb#L259) +##### [sauce_access_key=](https://github.com/appium/ruby_lib/blob/d67cbbac43f511515f6e6f53197cfae2bb7671e0/lib/appium_lib/driver.rb#L259) > def sauce_access_key=(value) Access Key for use on Sauce Labs -- -##### [appium_port](https://github.com/appium/ruby_lib/blob/ed917866929f0f7b0ff7ef0aedb5a9b35fdcc95b/lib/appium_lib/driver.rb#L261) +##### [appium_port](https://github.com/appium/ruby_lib/blob/d67cbbac43f511515f6e6f53197cfae2bb7671e0/lib/appium_lib/driver.rb#L261) > def appium_port Appium's server port -- -##### [appium_port=](https://github.com/appium/ruby_lib/blob/ed917866929f0f7b0ff7ef0aedb5a9b35fdcc95b/lib/appium_lib/driver.rb#L261) +##### [appium_port=](https://github.com/appium/ruby_lib/blob/d67cbbac43f511515f6e6f53197cfae2bb7671e0/lib/appium_lib/driver.rb#L261) > def appium_port=(value) Appium's server port -- -##### [appium_device](https://github.com/appium/ruby_lib/blob/ed917866929f0f7b0ff7ef0aedb5a9b35fdcc95b/lib/appium_lib/driver.rb#L263) +##### [appium_device](https://github.com/appium/ruby_lib/blob/d67cbbac43f511515f6e6f53197cfae2bb7671e0/lib/appium_lib/driver.rb#L263) > def appium_device Device type to request from the appium server -- -##### [appium_device=](https://github.com/appium/ruby_lib/blob/ed917866929f0f7b0ff7ef0aedb5a9b35fdcc95b/lib/appium_lib/driver.rb#L263) +##### [appium_device=](https://github.com/appium/ruby_lib/blob/d67cbbac43f511515f6e6f53197cfae2bb7671e0/lib/appium_lib/driver.rb#L263) > def appium_device=(value) Device type to request from the appium server -- -##### [appium_debug](https://github.com/appium/ruby_lib/blob/ed917866929f0f7b0ff7ef0aedb5a9b35fdcc95b/lib/appium_lib/driver.rb#L265) +##### [appium_debug](https://github.com/appium/ruby_lib/blob/d67cbbac43f511515f6e6f53197cfae2bb7671e0/lib/appium_lib/driver.rb#L265) > def appium_debug Boolean debug mode for the Appium Ruby bindings -- -##### [appium_debug=](https://github.com/appium/ruby_lib/blob/ed917866929f0f7b0ff7ef0aedb5a9b35fdcc95b/lib/appium_lib/driver.rb#L265) +##### [appium_debug=](https://github.com/appium/ruby_lib/blob/d67cbbac43f511515f6e6f53197cfae2bb7671e0/lib/appium_lib/driver.rb#L265) > def appium_debug=(value) Boolean debug mode for the Appium Ruby bindings -- -##### [driver](https://github.com/appium/ruby_lib/blob/ed917866929f0f7b0ff7ef0aedb5a9b35fdcc95b/lib/appium_lib/driver.rb#L269) +##### [driver](https://github.com/appium/ruby_lib/blob/d67cbbac43f511515f6e6f53197cfae2bb7671e0/lib/appium_lib/driver.rb#L269) > def driver Returns the driver @@ -284,11 +284,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Driver] the driver -- -##### [initialize](https://github.com/appium/ruby_lib/blob/ed917866929f0f7b0ff7ef0aedb5a9b35fdcc95b/lib/appium_lib/driver.rb#L290) +##### [initialize](https://github.com/appium/ruby_lib/blob/d67cbbac43f511515f6e6f53197cfae2bb7671e0/lib/appium_lib/driver.rb#L290) > def initialize(opts = {}) Creates a new driver @@ -315,19 +315,19 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Driver] -- -##### [driver_attributes](https://github.com/appium/ruby_lib/blob/ed917866929f0f7b0ff7ef0aedb5a9b35fdcc95b/lib/appium_lib/driver.rb#L354) +##### [driver_attributes](https://github.com/appium/ruby_lib/blob/d67cbbac43f511515f6e6f53197cfae2bb7671e0/lib/appium_lib/driver.rb#L354) > def driver_attributes Returns a hash of the driver attributes -- -##### [device_is_android?](https://github.com/appium/ruby_lib/blob/ed917866929f0f7b0ff7ef0aedb5a9b35fdcc95b/lib/appium_lib/driver.rb#L374) +##### [device_is_android?](https://github.com/appium/ruby_lib/blob/d67cbbac43f511515f6e6f53197cfae2bb7671e0/lib/appium_lib/driver.rb#L374) > def device_is_android? @@ -335,11 +335,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Boolean] -- -##### [appium_server_version](https://github.com/appium/ruby_lib/blob/ed917866929f0f7b0ff7ef0aedb5a9b35fdcc95b/lib/appium_lib/driver.rb#L390) +##### [appium_server_version](https://github.com/appium/ruby_lib/blob/d67cbbac43f511515f6e6f53197cfae2bb7671e0/lib/appium_lib/driver.rb#L390) > def appium_server_version Returns the server's version info @@ -356,11 +356,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Hash] -- -##### [absolute_app_path](https://github.com/appium/ruby_lib/blob/ed917866929f0f7b0ff7ef0aedb5a9b35fdcc95b/lib/appium_lib/driver.rb#L402) +##### [absolute_app_path](https://github.com/appium/ruby_lib/blob/d67cbbac43f511515f6e6f53197cfae2bb7671e0/lib/appium_lib/driver.rb#L402) > def self.absolute_app_path(opts) Converts app_path to an absolute path. @@ -373,11 +373,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[String] APP_PATH as an absolute path -- -##### [server_url](https://github.com/appium/ruby_lib/blob/ed917866929f0f7b0ff7ef0aedb5a9b35fdcc95b/lib/appium_lib/driver.rb#L435) +##### [server_url](https://github.com/appium/ruby_lib/blob/d67cbbac43f511515f6e6f53197cfae2bb7671e0/lib/appium_lib/driver.rb#L435) > def server_url Get the server url @@ -385,11 +385,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[String] the server url -- -##### [restart](https://github.com/appium/ruby_lib/blob/ed917866929f0f7b0ff7ef0aedb5a9b35fdcc95b/lib/appium_lib/driver.rb#L446) +##### [restart](https://github.com/appium/ruby_lib/blob/d67cbbac43f511515f6e6f53197cfae2bb7671e0/lib/appium_lib/driver.rb#L446) > def restart Restarts the driver @@ -397,11 +397,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Driver] the driver -- -##### [screenshot](https://github.com/appium/ruby_lib/blob/ed917866929f0f7b0ff7ef0aedb5a9b35fdcc95b/lib/appium_lib/driver.rb#L457) +##### [screenshot](https://github.com/appium/ruby_lib/blob/d67cbbac43f511515f6e6f53197cfae2bb7671e0/lib/appium_lib/driver.rb#L457) > def screenshot(png_save_path) Takes a png screenshot and saves to the target path. @@ -415,11 +415,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[nil] -- -##### [driver_quit](https://github.com/appium/ruby_lib/blob/ed917866929f0f7b0ff7ef0aedb5a9b35fdcc95b/lib/appium_lib/driver.rb#L464) +##### [driver_quit](https://github.com/appium/ruby_lib/blob/d67cbbac43f511515f6e6f53197cfae2bb7671e0/lib/appium_lib/driver.rb#L464) > def driver_quit Quits the driver @@ -427,11 +427,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[void] -- -##### [start_driver](https://github.com/appium/ruby_lib/blob/ed917866929f0f7b0ff7ef0aedb5a9b35fdcc95b/lib/appium_lib/driver.rb#L473) +##### [start_driver](https://github.com/appium/ruby_lib/blob/d67cbbac43f511515f6e6f53197cfae2bb7671e0/lib/appium_lib/driver.rb#L473) > def start_driver Creates a new global driver and quits the old one if it exists. @@ -439,19 +439,19 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Selenium::WebDriver] the new global driver -- -##### [no_wait](https://github.com/appium/ruby_lib/blob/ed917866929f0f7b0ff7ef0aedb5a9b35fdcc95b/lib/appium_lib/driver.rb#L501) +##### [no_wait](https://github.com/appium/ruby_lib/blob/d67cbbac43f511515f6e6f53197cfae2bb7671e0/lib/appium_lib/driver.rb#L501) > def no_wait Set implicit wait and default_wait to zero. -- -##### [set_wait](https://github.com/appium/ruby_lib/blob/ed917866929f0f7b0ff7ef0aedb5a9b35fdcc95b/lib/appium_lib/driver.rb#L520) +##### [set_wait](https://github.com/appium/ruby_lib/blob/d67cbbac43f511515f6e6f53197cfae2bb7671e0/lib/appium_lib/driver.rb#L520) > 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 @@ -472,11 +472,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[void] -- -##### [exists](https://github.com/appium/ruby_lib/blob/ed917866929f0f7b0ff7ef0aedb5a9b35fdcc95b/lib/appium_lib/driver.rb#L547) +##### [exists](https://github.com/appium/ruby_lib/blob/d67cbbac43f511515f6e6f53197cfae2bb7671e0/lib/appium_lib/driver.rb#L547) > def exists(pre_check = 0, post_check = @default_wait, &search_block) Returns existence of element. @@ -498,11 +498,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Boolean] -- -##### [execute_script](https://github.com/appium/ruby_lib/blob/ed917866929f0f7b0ff7ef0aedb5a9b35fdcc95b/lib/appium_lib/driver.rb#L571) +##### [execute_script](https://github.com/appium/ruby_lib/blob/d67cbbac43f511515f6e6f53197cfae2bb7671e0/lib/appium_lib/driver.rb#L571) > def execute_script(script, *args) The same as @driver.execute_script @@ -516,11 +516,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Object] -- -##### [find_elements](https://github.com/appium/ruby_lib/blob/ed917866929f0f7b0ff7ef0aedb5a9b35fdcc95b/lib/appium_lib/driver.rb#L579) +##### [find_elements](https://github.com/appium/ruby_lib/blob/d67cbbac43f511515f6e6f53197cfae2bb7671e0/lib/appium_lib/driver.rb#L579) > def find_elements(*args) Calls @driver.find_elements @@ -532,11 +532,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Array<Element>] Array is empty when no elements are found. -- -##### [find_element](https://github.com/appium/ruby_lib/blob/ed917866929f0f7b0ff7ef0aedb5a9b35fdcc95b/lib/appium_lib/driver.rb#L587) +##### [find_element](https://github.com/appium/ruby_lib/blob/d67cbbac43f511515f6e6f53197cfae2bb7671e0/lib/appium_lib/driver.rb#L587) > def find_element(*args) Calls @driver.find_elements @@ -548,11 +548,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Element] -- -##### [set_location](https://github.com/appium/ruby_lib/blob/ed917866929f0f7b0ff7ef0aedb5a9b35fdcc95b/lib/appium_lib/driver.rb#L600) +##### [set_location](https://github.com/appium/ruby_lib/blob/d67cbbac43f511515f6e6f53197cfae2bb7671e0/lib/appium_lib/driver.rb#L600) > def set_location(opts = {}) Calls @driver.set_location @@ -564,11 +564,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Selenium::WebDriver::Location] the location constructed by the selenium webdriver -- -##### [x](https://github.com/appium/ruby_lib/blob/ed917866929f0f7b0ff7ef0aedb5a9b35fdcc95b/lib/appium_lib/driver.rb#L610) +##### [x](https://github.com/appium/ruby_lib/blob/d67cbbac43f511515f6e6f53197cfae2bb7671e0/lib/appium_lib/driver.rb#L610) > def x Quit the driver and Pry. quit and exit are reserved by Pry. @@ -577,11 +577,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[void] -- -##### [logger=](https://github.com/appium/ruby_lib/blob/ed917866929f0f7b0ff7ef0aedb5a9b35fdcc95b/lib/appium_lib/logger.rb#L13) +##### [logger=](https://github.com/appium/ruby_lib/blob/d67cbbac43f511515f6e6f53197cfae2bb7671e0/lib/appium_lib/logger.rb#L13) > def logger=(value) Sets the attribute logger @@ -589,95 +589,95 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;value - the value to set the attribute logger to. -- -##### [logger](https://github.com/appium/ruby_lib/blob/ed917866929f0f7b0ff7ef0aedb5a9b35fdcc95b/lib/appium_lib/logger.rb#L17) +##### [logger](https://github.com/appium/ruby_lib/blob/d67cbbac43f511515f6e6f53197cfae2bb7671e0/lib/appium_lib/logger.rb#L17) > def logger -- -##### [NoArgMethods](https://github.com/appium/ruby_lib/blob/ed917866929f0f7b0ff7ef0aedb5a9b35fdcc95b/lib/appium_lib/device/device.rb#L7) +##### [NoArgMethods](https://github.com/appium/ruby_lib/blob/d67cbbac43f511515f6e6f53197cfae2bb7671e0/lib/appium_lib/device/device.rb#L7) > NoArgMethods = { -- -##### [app_strings](https://github.com/appium/ruby_lib/blob/ed917866929f0f7b0ff7ef0aedb5a9b35fdcc95b/lib/appium_lib/device/device.rb#L24) +##### [app_strings](https://github.com/appium/ruby_lib/blob/d67cbbac43f511515f6e6f53197cfae2bb7671e0/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/ed917866929f0f7b0ff7ef0aedb5a9b35fdcc95b/lib/appium_lib/device/device.rb#L30) +##### [background_app](https://github.com/appium/ruby_lib/blob/d67cbbac43f511515f6e6f53197cfae2bb7671e0/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/ed917866929f0f7b0ff7ef0aedb5a9b35fdcc95b/lib/appium_lib/device/device.rb#L35) +##### [current_activity](https://github.com/appium/ruby_lib/blob/d67cbbac43f511515f6e6f53197cfae2bb7671e0/lib/appium_lib/device/device.rb#L36) > def current_activity -- -##### [launch_app](https://github.com/appium/ruby_lib/blob/ed917866929f0f7b0ff7ef0aedb5a9b35fdcc95b/lib/appium_lib/device/device.rb#L37) +##### [launch_app](https://github.com/appium/ruby_lib/blob/d67cbbac43f511515f6e6f53197cfae2bb7671e0/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/ed917866929f0f7b0ff7ef0aedb5a9b35fdcc95b/lib/appium_lib/device/device.rb#L40) +##### [reset](https://github.com/appium/ruby_lib/blob/d67cbbac43f511515f6e6f53197cfae2bb7671e0/lib/appium_lib/device/device.rb#L41) > def reset Reset the device, relaunching the application. -- -##### [shake](https://github.com/appium/ruby_lib/blob/ed917866929f0f7b0ff7ef0aedb5a9b35fdcc95b/lib/appium_lib/device/device.rb#L43) +##### [shake](https://github.com/appium/ruby_lib/blob/d67cbbac43f511515f6e6f53197cfae2bb7671e0/lib/appium_lib/device/device.rb#L44) > def shake Cause the device to shake -- -##### [toggle_flight_mode](https://github.com/appium/ruby_lib/blob/ed917866929f0f7b0ff7ef0aedb5a9b35fdcc95b/lib/appium_lib/device/device.rb#L46) +##### [toggle_flight_mode](https://github.com/appium/ruby_lib/blob/d67cbbac43f511515f6e6f53197cfae2bb7671e0/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/ed917866929f0f7b0ff7ef0aedb5a9b35fdcc95b/lib/appium_lib/device/device.rb#L49) +##### [device_locked?](https://github.com/appium/ruby_lib/blob/d67cbbac43f511515f6e6f53197cfae2bb7671e0/lib/appium_lib/device/device.rb#L50) > def device_locked? -- -##### [hide_keyboard](https://github.com/appium/ruby_lib/blob/ed917866929f0f7b0ff7ef0aedb5a9b35fdcc95b/lib/appium_lib/device/device.rb#L51) +##### [hide_keyboard](https://github.com/appium/ruby_lib/blob/d67cbbac43f511515f6e6f53197cfae2bb7671e0/lib/appium_lib/device/device.rb#L52) > def hide_keyboard Hide the onscreen keyboard @@ -686,11 +686,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[String] close_key - the name of the key which closes the keyboard. Defaults to 'Done'. -- -##### [press_keycode](https://github.com/appium/ruby_lib/blob/ed917866929f0f7b0ff7ef0aedb5a9b35fdcc95b/lib/appium_lib/device/device.rb#L60) +##### [press_keycode](https://github.com/appium/ruby_lib/blob/d67cbbac43f511515f6e6f53197cfae2bb7671e0/lib/appium_lib/device/device.rb#L61) > def press_keycode Press keycode on the device. http://developer.android.com/reference/android/view/KeyEvent.html @@ -701,11 +701,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[String] metastate - The state the metakeys should be in when pressing the key. -- -##### [long_press_keycode](https://github.com/appium/ruby_lib/blob/ed917866929f0f7b0ff7ef0aedb5a9b35fdcc95b/lib/appium_lib/device/device.rb#L66) +##### [long_press_keycode](https://github.com/appium/ruby_lib/blob/d67cbbac43f511515f6e6f53197cfae2bb7671e0/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 @@ -716,11 +716,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[String] metastate - The state the metakeys should be in when long pressing the key. -- -##### [push_file](https://github.com/appium/ruby_lib/blob/ed917866929f0f7b0ff7ef0aedb5a9b35fdcc95b/lib/appium_lib/device/device.rb#L72) +##### [push_file](https://github.com/appium/ruby_lib/blob/d67cbbac43f511515f6e6f53197cfae2bb7671e0/lib/appium_lib/device/device.rb#L73) > def push_file Place a file in a specific location on the device. @@ -730,11 +730,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[String] data - Raw file data to be sent to the device. -- -##### [pull_file](https://github.com/appium/ruby_lib/blob/ed917866929f0f7b0ff7ef0aedb5a9b35fdcc95b/lib/appium_lib/device/device.rb#L77) +##### [pull_file](https://github.com/appium/ruby_lib/blob/d67cbbac43f511515f6e6f53197cfae2bb7671e0/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). @@ -747,11 +747,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[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/ed917866929f0f7b0ff7ef0aedb5a9b35fdcc95b/lib/appium_lib/device/device.rb#L87) +##### [pull_folder](https://github.com/appium/ruby_lib/blob/d67cbbac43f511515f6e6f53197cfae2bb7671e0/lib/appium_lib/device/device.rb#L88) > def pull_folder Retrieve a folder from the device. ```ruby @@ -762,11 +762,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[String] path - absolute path to the folder -- -##### [end_coverage](https://github.com/appium/ruby_lib/blob/ed917866929f0f7b0ff7ef0aedb5a9b35fdcc95b/lib/appium_lib/device/device.rb#L95) +##### [end_coverage](https://github.com/appium/ruby_lib/blob/d67cbbac43f511515f6e6f53197cfae2bb7671e0/lib/appium_lib/device/device.rb#L96) > def end_coverage Android only; Ends the test coverage and writes the results to the given path on device. @@ -776,27 +776,27 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[String] intent - Intent to broadcast when ending coverage. -- -##### [get_settings](https://github.com/appium/ruby_lib/blob/ed917866929f0f7b0ff7ef0aedb5a9b35fdcc95b/lib/appium_lib/device/device.rb#L100) +##### [get_settings](https://github.com/appium/ruby_lib/blob/d67cbbac43f511515f6e6f53197cfae2bb7671e0/lib/appium_lib/device/device.rb#L101) > def get_settings Get appium Settings for current test session -- -##### [extend_search_contexts](https://github.com/appium/ruby_lib/blob/ed917866929f0f7b0ff7ef0aedb5a9b35fdcc95b/lib/appium_lib/device/device.rb#L351) +##### [extend_search_contexts](https://github.com/appium/ruby_lib/blob/d67cbbac43f511515f6e6f53197cfae2bb7671e0/lib/appium_lib/device/device.rb#L352) > def extend_search_contexts -- -##### [accessiblity_id_find](https://github.com/appium/ruby_lib/blob/ed917866929f0f7b0ff7ef0aedb5a9b35fdcc95b/lib/appium_lib/device/device.rb#L351) +##### [accessiblity_id_find](https://github.com/appium/ruby_lib/blob/d67cbbac43f511515f6e6f53197cfae2bb7671e0/lib/appium_lib/device/device.rb#L352) > def accessiblity_id_find find_element/s with their accessibility_id @@ -804,19 +804,19 @@ find_elements :accessibility_id, 'Animation' ``` -- -##### [add_touch_actions](https://github.com/appium/ruby_lib/blob/ed917866929f0f7b0ff7ef0aedb5a9b35fdcc95b/lib/appium_lib/device/device.rb#L357) +##### [add_touch_actions](https://github.com/appium/ruby_lib/blob/d67cbbac43f511515f6e6f53197cfae2bb7671e0/lib/appium_lib/device/device.rb#L358) > def add_touch_actions -- -##### [set_context](https://github.com/appium/ruby_lib/blob/ed917866929f0f7b0ff7ef0aedb5a9b35fdcc95b/lib/appium_lib/device/device.rb#L381) +##### [set_context](https://github.com/appium/ruby_lib/blob/d67cbbac43f511515f6e6f53197cfae2bb7671e0/lib/appium_lib/device/device.rb#L382) > def set_context Change the context to the given context. ```ruby @@ -827,11 +827,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[String] The - context to change to -- -##### [current_context](https://github.com/appium/ruby_lib/blob/ed917866929f0f7b0ff7ef0aedb5a9b35fdcc95b/lib/appium_lib/device/device.rb#L389) +##### [current_context](https://github.com/appium/ruby_lib/blob/d67cbbac43f511515f6e6f53197cfae2bb7671e0/lib/appium_lib/device/device.rb#L390) > def current_context @@ -839,11 +839,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[String] The context currently being used. -- -##### [available_contexts](https://github.com/appium/ruby_lib/blob/ed917866929f0f7b0ff7ef0aedb5a9b35fdcc95b/lib/appium_lib/device/device.rb#L392) +##### [available_contexts](https://github.com/appium/ruby_lib/blob/d67cbbac43f511515f6e6f53197cfae2bb7671e0/lib/appium_lib/device/device.rb#L393) > def available_contexts @@ -851,11 +851,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Array<String>] All usable contexts, as an array of strings. -- -##### [within_context](https://github.com/appium/ruby_lib/blob/ed917866929f0f7b0ff7ef0aedb5a9b35fdcc95b/lib/appium_lib/device/device.rb#L402) +##### [within_context](https://github.com/appium/ruby_lib/blob/d67cbbac43f511515f6e6f53197cfae2bb7671e0/lib/appium_lib/device/device.rb#L403) > def within_context(context) Perform a block within the given context, then switch back to the starting context. ```ruby @@ -867,19 +867,19 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[String] context - The context to switch to for the duration of the block. -- -##### [switch_to_default_context](https://github.com/appium/ruby_lib/blob/ed917866929f0f7b0ff7ef0aedb5a9b35fdcc95b/lib/appium_lib/device/device.rb#L410) +##### [switch_to_default_context](https://github.com/appium/ruby_lib/blob/d67cbbac43f511515f6e6f53197cfae2bb7671e0/lib/appium_lib/device/device.rb#L411) > 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/ed917866929f0f7b0ff7ef0aedb5a9b35fdcc95b/lib/appium_lib/device/multi_touch.rb#L28) +##### [pinch](https://github.com/appium/ruby_lib/blob/d67cbbac43f511515f6e6f53197cfae2bb7671e0/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. @@ -894,11 +894,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[boolean] auto_perform - Whether to perform the action immediately (default true) -- -##### [zoom](https://github.com/appium/ruby_lib/blob/ed917866929f0f7b0ff7ef0aedb5a9b35fdcc95b/lib/appium_lib/device/multi_touch.rb#L56) +##### [zoom](https://github.com/appium/ruby_lib/blob/d67cbbac43f511515f6e6f53197cfae2bb7671e0/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. @@ -913,11 +913,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[boolean] auto_perform - Whether to perform the action immediately (default true) -- -##### [initialize](https://github.com/appium/ruby_lib/blob/ed917866929f0f7b0ff7ef0aedb5a9b35fdcc95b/lib/appium_lib/device/multi_touch.rb#L77) +##### [initialize](https://github.com/appium/ruby_lib/blob/d67cbbac43f511515f6e6f53197cfae2bb7671e0/lib/appium_lib/device/multi_touch.rb#L77) > def initialize Create a new multi-action @@ -925,11 +925,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[MultiTouch] a new instance of MultiTouch -- -##### [add](https://github.com/appium/ruby_lib/blob/ed917866929f0f7b0ff7ef0aedb5a9b35fdcc95b/lib/appium_lib/device/multi_touch.rb#L83) +##### [add](https://github.com/appium/ruby_lib/blob/d67cbbac43f511515f6e6f53197cfae2bb7671e0/lib/appium_lib/device/multi_touch.rb#L83) > def add(chain) Add a touch_action to be performed @@ -937,43 +937,43 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[TouchAction] chain - The action to add to the chain -- -##### [perform](https://github.com/appium/ruby_lib/blob/ed917866929f0f7b0ff7ef0aedb5a9b35fdcc95b/lib/appium_lib/device/multi_touch.rb#L88) +##### [perform](https://github.com/appium/ruby_lib/blob/d67cbbac43f511515f6e6f53197cfae2bb7671e0/lib/appium_lib/device/multi_touch.rb#L88) > def perform Ask Appium to perform the actions -- -##### [ACTIONS](https://github.com/appium/ruby_lib/blob/ed917866929f0f7b0ff7ef0aedb5a9b35fdcc95b/lib/appium_lib/device/touch_actions.rb#L11) +##### [ACTIONS](https://github.com/appium/ruby_lib/blob/d67cbbac43f511515f6e6f53197cfae2bb7671e0/lib/appium_lib/device/touch_actions.rb#L11) > ACTIONS = [:move_to, :long_press, :press, :release, :tap, :wait, :perform] -- -##### [COMPLEX_ACTIONS](https://github.com/appium/ruby_lib/blob/ed917866929f0f7b0ff7ef0aedb5a9b35fdcc95b/lib/appium_lib/device/touch_actions.rb#L12) +##### [COMPLEX_ACTIONS](https://github.com/appium/ruby_lib/blob/d67cbbac43f511515f6e6f53197cfae2bb7671e0/lib/appium_lib/device/touch_actions.rb#L12) > COMPLEX_ACTIONS = [:swipe] -- -##### [actions](https://github.com/appium/ruby_lib/blob/ed917866929f0f7b0ff7ef0aedb5a9b35fdcc95b/lib/appium_lib/device/touch_actions.rb#L26) +##### [actions](https://github.com/appium/ruby_lib/blob/d67cbbac43f511515f6e6f53197cfae2bb7671e0/lib/appium_lib/device/touch_actions.rb#L26) > def actions Returns the value of attribute actions -- -##### [initialize](https://github.com/appium/ruby_lib/blob/ed917866929f0f7b0ff7ef0aedb5a9b35fdcc95b/lib/appium_lib/device/touch_actions.rb#L28) +##### [initialize](https://github.com/appium/ruby_lib/blob/d67cbbac43f511515f6e6f53197cfae2bb7671e0/lib/appium_lib/device/touch_actions.rb#L28) > def initialize @@ -981,11 +981,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[TouchAction] a new instance of TouchAction -- -##### [move_to](https://github.com/appium/ruby_lib/blob/ed917866929f0f7b0ff7ef0aedb5a9b35fdcc95b/lib/appium_lib/device/touch_actions.rb#L36) +##### [move_to](https://github.com/appium/ruby_lib/blob/d67cbbac43f511515f6e6f53197cfae2bb7671e0/lib/appium_lib/device/touch_actions.rb#L36) > def move_to(opts) Move to the given co-ordinates. @@ -993,11 +993,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Hash] opts - a customizable set of options -- -##### [long_press](https://github.com/appium/ruby_lib/blob/ed917866929f0f7b0ff7ef0aedb5a9b35fdcc95b/lib/appium_lib/device/touch_actions.rb#L46) +##### [long_press](https://github.com/appium/ruby_lib/blob/d67cbbac43f511515f6e6f53197cfae2bb7671e0/lib/appium_lib/device/touch_actions.rb#L46) > def long_press(opts) Press down for a specific duration. @@ -1011,11 +1011,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Hash] duration - a customizable set of options -- -##### [press](https://github.com/appium/ruby_lib/blob/ed917866929f0f7b0ff7ef0aedb5a9b35fdcc95b/lib/appium_lib/device/touch_actions.rb#L58) +##### [press](https://github.com/appium/ruby_lib/blob/d67cbbac43f511515f6e6f53197cfae2bb7671e0/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`. @@ -1024,11 +1024,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Hash] opts - a customizable set of options -- -##### [release](https://github.com/appium/ruby_lib/blob/ed917866929f0f7b0ff7ef0aedb5a9b35fdcc95b/lib/appium_lib/device/touch_actions.rb#L69) +##### [release](https://github.com/appium/ruby_lib/blob/d67cbbac43f511515f6e6f53197cfae2bb7671e0/lib/appium_lib/device/touch_actions.rb#L69) > def release(opts = nil) Remove a finger from the screen. @@ -1036,11 +1036,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Hash] opts - a customizable set of options -- -##### [tap](https://github.com/appium/ruby_lib/blob/ed917866929f0f7b0ff7ef0aedb5a9b35fdcc95b/lib/appium_lib/device/touch_actions.rb#L80) +##### [tap](https://github.com/appium/ruby_lib/blob/d67cbbac43f511515f6e6f53197cfae2bb7671e0/lib/appium_lib/device/touch_actions.rb#L80) > def tap(opts) Touch a point on the screen @@ -1048,11 +1048,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Hash] opts - a customizable set of options -- -##### [wait](https://github.com/appium/ruby_lib/blob/ed917866929f0f7b0ff7ef0aedb5a9b35fdcc95b/lib/appium_lib/device/touch_actions.rb#L89) +##### [wait](https://github.com/appium/ruby_lib/blob/d67cbbac43f511515f6e6f53197cfae2bb7671e0/lib/appium_lib/device/touch_actions.rb#L89) > def wait(milliseconds) Pause for a number of milliseconds before the next action @@ -1060,11 +1060,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[integer] milliseconds - Number of milliseconds to pause for -- -##### [swipe](https://github.com/appium/ruby_lib/blob/ed917866929f0f7b0ff7ef0aedb5a9b35fdcc95b/lib/appium_lib/device/touch_actions.rb#L103) +##### [swipe](https://github.com/appium/ruby_lib/blob/d67cbbac43f511515f6e6f53197cfae2bb7671e0/lib/appium_lib/device/touch_actions.rb#L103) > def swipe(opts) Convenience method to peform a swipe. @@ -1074,60 +1074,60 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Hash] opts - a customizable set of options -- -##### [perform](https://github.com/appium/ruby_lib/blob/ed917866929f0f7b0ff7ef0aedb5a9b35fdcc95b/lib/appium_lib/device/touch_actions.rb#L118) +##### [perform](https://github.com/appium/ruby_lib/blob/d67cbbac43f511515f6e6f53197cfae2bb7671e0/lib/appium_lib/device/touch_actions.rb#L118) > def perform Ask the driver to perform all actions in this action chain. -- -##### [cancel](https://github.com/appium/ruby_lib/blob/ed917866929f0f7b0ff7ef0aedb5a9b35fdcc95b/lib/appium_lib/device/touch_actions.rb#L124) +##### [cancel](https://github.com/appium/ruby_lib/blob/d67cbbac43f511515f6e6f53197cfae2bb7671e0/lib/appium_lib/device/touch_actions.rb#L124) > def cancel Does nothing, currently. -- -##### [chain_method](https://github.com/appium/ruby_lib/blob/ed917866929f0f7b0ff7ef0aedb5a9b35fdcc95b/lib/appium_lib/device/touch_actions.rb#L132) +##### [chain_method](https://github.com/appium/ruby_lib/blob/d67cbbac43f511515f6e6f53197cfae2bb7671e0/lib/appium_lib/device/touch_actions.rb#L132) > def chain_method(method, args = nil) -- -##### [args_with_ele_ref](https://github.com/appium/ruby_lib/blob/ed917866929f0f7b0ff7ef0aedb5a9b35fdcc95b/lib/appium_lib/device/touch_actions.rb#L141) +##### [args_with_ele_ref](https://github.com/appium/ruby_lib/blob/d67cbbac43f511515f6e6f53197cfae2bb7671e0/lib/appium_lib/device/touch_actions.rb#L141) > def args_with_ele_ref(args) -- -##### [_generic_wait](https://github.com/appium/ruby_lib/blob/ed917866929f0f7b0ff7ef0aedb5a9b35fdcc95b/lib/appium_lib/common/wait.rb#L9) +##### [_generic_wait](https://github.com/appium/ruby_lib/blob/d67cbbac43f511515f6e6f53197cfae2bb7671e0/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/ed917866929f0f7b0ff7ef0aedb5a9b35fdcc95b/lib/appium_lib/common/wait.rb#L54) +##### [_process_wait_opts](https://github.com/appium/ruby_lib/blob/d67cbbac43f511515f6e6f53197cfae2bb7671e0/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/ed917866929f0f7b0ff7ef0aedb5a9b35fdcc95b/lib/appium_lib/common/wait.rb#L75) +##### [wait_true](https://github.com/appium/ruby_lib/blob/d67cbbac43f511515f6e6f53197cfae2bb7671e0/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. @@ -1143,11 +1143,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Hash] opts - Options -- -##### [wait](https://github.com/appium/ruby_lib/blob/ed917866929f0f7b0ff7ef0aedb5a9b35fdcc95b/lib/appium_lib/common/wait.rb#L93) +##### [wait](https://github.com/appium/ruby_lib/blob/d67cbbac43f511515f6e6f53197cfae2bb7671e0/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. @@ -1161,19 +1161,19 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Hash] opts - Options -- -##### [ignore](https://github.com/appium/ruby_lib/blob/ed917866929f0f7b0ff7ef0aedb5a9b35fdcc95b/lib/appium_lib/common/helper.rb#L24) +##### [ignore](https://github.com/appium/ruby_lib/blob/d67cbbac43f511515f6e6f53197cfae2bb7671e0/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/ed917866929f0f7b0ff7ef0aedb5a9b35fdcc95b/lib/appium_lib/common/helper.rb#L31) +##### [back](https://github.com/appium/ruby_lib/blob/d67cbbac43f511515f6e6f53197cfae2bb7671e0/lib/appium_lib/common/helper.rb#L31) > def back Navigate back. @@ -1181,19 +1181,19 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[void] -- -##### [session_id](https://github.com/appium/ruby_lib/blob/ed917866929f0f7b0ff7ef0aedb5a9b35fdcc95b/lib/appium_lib/common/helper.rb#L36) +##### [session_id](https://github.com/appium/ruby_lib/blob/d67cbbac43f511515f6e6f53197cfae2bb7671e0/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/ed917866929f0f7b0ff7ef0aedb5a9b35fdcc95b/lib/appium_lib/common/helper.rb#L44) +##### [xpath](https://github.com/appium/ruby_lib/blob/d67cbbac43f511515f6e6f53197cfae2bb7671e0/lib/appium_lib/common/helper.rb#L44) > def xpath(xpath_str) Returns the first element that matches the provided xpath. @@ -1205,11 +1205,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Element] -- -##### [xpaths](https://github.com/appium/ruby_lib/blob/ed917866929f0f7b0ff7ef0aedb5a9b35fdcc95b/lib/appium_lib/common/helper.rb#L52) +##### [xpaths](https://github.com/appium/ruby_lib/blob/d67cbbac43f511515f6e6f53197cfae2bb7671e0/lib/appium_lib/common/helper.rb#L52) > def xpaths(xpath_str) Returns all elements that match the provided xpath. @@ -1221,27 +1221,27 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Array<Element>] -- -##### [_print_source](https://github.com/appium/ruby_lib/blob/ed917866929f0f7b0ff7ef0aedb5a9b35fdcc95b/lib/appium_lib/common/helper.rb#L56) +##### [_print_source](https://github.com/appium/ruby_lib/blob/d67cbbac43f511515f6e6f53197cfae2bb7671e0/lib/appium_lib/common/helper.rb#L56) > def _print_source(source) -- -##### [result](https://github.com/appium/ruby_lib/blob/ed917866929f0f7b0ff7ef0aedb5a9b35fdcc95b/lib/appium_lib/common/helper.rb#L69) +##### [result](https://github.com/appium/ruby_lib/blob/d67cbbac43f511515f6e6f53197cfae2bb7671e0/lib/appium_lib/common/helper.rb#L69) > def result Returns the value of attribute result -- -##### [initialize](https://github.com/appium/ruby_lib/blob/ed917866929f0f7b0ff7ef0aedb5a9b35fdcc95b/lib/appium_lib/common/helper.rb#L71) +##### [initialize](https://github.com/appium/ruby_lib/blob/d67cbbac43f511515f6e6f53197cfae2bb7671e0/lib/appium_lib/common/helper.rb#L71) > def initialize @@ -1249,52 +1249,52 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[CountElements] a new instance of CountElements -- -##### [reset](https://github.com/appium/ruby_lib/blob/ed917866929f0f7b0ff7ef0aedb5a9b35fdcc95b/lib/appium_lib/common/helper.rb#L75) +##### [reset](https://github.com/appium/ruby_lib/blob/d67cbbac43f511515f6e6f53197cfae2bb7671e0/lib/appium_lib/common/helper.rb#L75) > def reset -- -##### [start_element](https://github.com/appium/ruby_lib/blob/ed917866929f0f7b0ff7ef0aedb5a9b35fdcc95b/lib/appium_lib/common/helper.rb#L80) +##### [start_element](https://github.com/appium/ruby_lib/blob/d67cbbac43f511515f6e6f53197cfae2bb7671e0/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/ed917866929f0f7b0ff7ef0aedb5a9b35fdcc95b/lib/appium_lib/common/helper.rb#L86) +##### [formatted_result](https://github.com/appium/ruby_lib/blob/d67cbbac43f511515f6e6f53197cfae2bb7671e0/lib/appium_lib/common/helper.rb#L86) > def formatted_result -- -##### [get_page_class](https://github.com/appium/ruby_lib/blob/ed917866929f0f7b0ff7ef0aedb5a9b35fdcc95b/lib/appium_lib/common/helper.rb#L97) +##### [get_page_class](https://github.com/appium/ruby_lib/blob/d67cbbac43f511515f6e6f53197cfae2bb7671e0/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/ed917866929f0f7b0ff7ef0aedb5a9b35fdcc95b/lib/appium_lib/common/helper.rb#L108) +##### [page_class](https://github.com/appium/ruby_lib/blob/d67cbbac43f511515f6e6f53197cfae2bb7671e0/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/ed917866929f0f7b0ff7ef0aedb5a9b35fdcc95b/lib/appium_lib/common/helper.rb#L118) +##### [px_to_window_rel](https://github.com/appium/ruby_lib/blob/d67cbbac43f511515f6e6f53197cfae2bb7671e0/lib/appium_lib/common/helper.rb#L118) > def px_to_window_rel(opts = {}) Converts pixel values to window relative values @@ -1302,11 +1302,11 @@ px_to_window_rel x: 50, y: 150 ``` -- -##### [xml_keys](https://github.com/appium/ruby_lib/blob/ed917866929f0f7b0ff7ef0aedb5a9b35fdcc95b/lib/appium_lib/common/helper.rb#L137) +##### [xml_keys](https://github.com/appium/ruby_lib/blob/d67cbbac43f511515f6e6f53197cfae2bb7671e0/lib/appium_lib/common/helper.rb#L137) > def xml_keys(target) Search strings.xml's values for target. @@ -1318,11 +1318,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Array] -- -##### [xml_values](https://github.com/appium/ruby_lib/blob/ed917866929f0f7b0ff7ef0aedb5a9b35fdcc95b/lib/appium_lib/common/helper.rb#L145) +##### [xml_values](https://github.com/appium/ruby_lib/blob/d67cbbac43f511515f6e6f53197cfae2bb7671e0/lib/appium_lib/common/helper.rb#L145) > def xml_values(target) Search strings.xml's keys for target. @@ -1334,11 +1334,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Array] -- -##### [resolve_id](https://github.com/appium/ruby_lib/blob/ed917866929f0f7b0ff7ef0aedb5a9b35fdcc95b/lib/appium_lib/common/helper.rb#L153) +##### [resolve_id](https://github.com/appium/ruby_lib/blob/d67cbbac43f511515f6e6f53197cfae2bb7671e0/lib/appium_lib/common/helper.rb#L153) > def resolve_id(id) Resolve id in strings.xml and return the value. @@ -1350,27 +1350,27 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[String] -- -##### [filter](https://github.com/appium/ruby_lib/blob/ed917866929f0f7b0ff7ef0aedb5a9b35fdcc95b/lib/appium_lib/common/helper.rb#L159) +##### [filter](https://github.com/appium/ruby_lib/blob/d67cbbac43f511515f6e6f53197cfae2bb7671e0/lib/appium_lib/common/helper.rb#L159) > def filter Returns the value of attribute filter -- -##### [filter=](https://github.com/appium/ruby_lib/blob/ed917866929f0f7b0ff7ef0aedb5a9b35fdcc95b/lib/appium_lib/common/helper.rb#L162) +##### [filter=](https://github.com/appium/ruby_lib/blob/d67cbbac43f511515f6e6f53197cfae2bb7671e0/lib/appium_lib/common/helper.rb#L162) > def filter=(value) convert to string to support symbols -- -##### [initialize](https://github.com/appium/ruby_lib/blob/ed917866929f0f7b0ff7ef0aedb5a9b35fdcc95b/lib/appium_lib/common/helper.rb#L168) +##### [initialize](https://github.com/appium/ruby_lib/blob/d67cbbac43f511515f6e6f53197cfae2bb7671e0/lib/appium_lib/common/helper.rb#L168) > def initialize @@ -1378,67 +1378,67 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[HTMLElements] a new instance of HTMLElements -- -##### [reset](https://github.com/appium/ruby_lib/blob/ed917866929f0f7b0ff7ef0aedb5a9b35fdcc95b/lib/appium_lib/common/helper.rb#L173) +##### [reset](https://github.com/appium/ruby_lib/blob/d67cbbac43f511515f6e6f53197cfae2bb7671e0/lib/appium_lib/common/helper.rb#L173) > def reset -- -##### [result](https://github.com/appium/ruby_lib/blob/ed917866929f0f7b0ff7ef0aedb5a9b35fdcc95b/lib/appium_lib/common/helper.rb#L179) +##### [result](https://github.com/appium/ruby_lib/blob/d67cbbac43f511515f6e6f53197cfae2bb7671e0/lib/appium_lib/common/helper.rb#L179) > def result -- -##### [start_element](https://github.com/appium/ruby_lib/blob/ed917866929f0f7b0ff7ef0aedb5a9b35fdcc95b/lib/appium_lib/common/helper.rb#L195) +##### [start_element](https://github.com/appium/ruby_lib/blob/d67cbbac43f511515f6e6f53197cfae2bb7671e0/lib/appium_lib/common/helper.rb#L195) > def start_element(name, attrs = []) -- -##### [end_element](https://github.com/appium/ruby_lib/blob/ed917866929f0f7b0ff7ef0aedb5a9b35fdcc95b/lib/appium_lib/common/helper.rb#L204) +##### [end_element](https://github.com/appium/ruby_lib/blob/d67cbbac43f511515f6e6f53197cfae2bb7671e0/lib/appium_lib/common/helper.rb#L204) > def end_element(name) -- -##### [characters](https://github.com/appium/ruby_lib/blob/ed917866929f0f7b0ff7ef0aedb5a9b35fdcc95b/lib/appium_lib/common/helper.rb#L210) +##### [characters](https://github.com/appium/ruby_lib/blob/d67cbbac43f511515f6e6f53197cfae2bb7671e0/lib/appium_lib/common/helper.rb#L210) > def characters(chars) -- -##### [_no_such_element](https://github.com/appium/ruby_lib/blob/ed917866929f0f7b0ff7ef0aedb5a9b35fdcc95b/lib/appium_lib/common/helper.rb#L217) +##### [_no_such_element](https://github.com/appium/ruby_lib/blob/d67cbbac43f511515f6e6f53197cfae2bb7671e0/lib/appium_lib/common/helper.rb#L217) > def _no_such_element -- -##### [window_size](https://github.com/appium/ruby_lib/blob/ed917866929f0f7b0ff7ef0aedb5a9b35fdcc95b/lib/appium_lib/common/element/window.rb#L5) +##### [window_size](https://github.com/appium/ruby_lib/blob/d67cbbac43f511515f6e6f53197cfae2bb7671e0/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/ed917866929f0f7b0ff7ef0aedb5a9b35fdcc95b/lib/appium_lib/ios/helper.rb#L8) ios +##### [ios_password](https://github.com/appium/ruby_lib/blob/d67cbbac43f511515f6e6f53197cfae2bb7671e0/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. @@ -1452,11 +1452,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[String] the returned string is of size length -- -##### [get_page](https://github.com/appium/ruby_lib/blob/ed917866929f0f7b0ff7ef0aedb5a9b35fdcc95b/lib/appium_lib/ios/helper.rb#L20) ios +##### [get_page](https://github.com/appium/ruby_lib/blob/d67cbbac43f511515f6e6f53197cfae2bb7671e0/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. @@ -1473,11 +1473,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[String] -- -##### [page](https://github.com/appium/ruby_lib/blob/ed917866929f0f7b0ff7ef0aedb5a9b35fdcc95b/lib/appium_lib/ios/helper.rb#L129) ios +##### [page](https://github.com/appium/ruby_lib/blob/d67cbbac43f511515f6e6f53197cfae2bb7671e0/lib/appium_lib/ios/helper.rb#L129) ios > def page(opts = {}) Prints a string of interesting elements to the console. @@ -1499,11 +1499,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[void] -- -##### [source_window](https://github.com/appium/ruby_lib/blob/ed917866929f0f7b0ff7ef0aedb5a9b35fdcc95b/lib/appium_lib/ios/helper.rb#L161) ios +##### [source_window](https://github.com/appium/ruby_lib/blob/d67cbbac43f511515f6e6f53197cfae2bb7671e0/lib/appium_lib/ios/helper.rb#L161) ios > def source_window(window_number = 0) Gets the JSON source of window number @@ -1515,11 +1515,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[JSON] -- -##### [page_window](https://github.com/appium/ruby_lib/blob/ed917866929f0f7b0ff7ef0aedb5a9b35fdcc95b/lib/appium_lib/ios/helper.rb#L175) ios +##### [page_window](https://github.com/appium/ruby_lib/blob/d67cbbac43f511515f6e6f53197cfae2bb7671e0/lib/appium_lib/ios/helper.rb#L175) ios > def page_window(window_number = 0) Prints parsed page source to console. @@ -1533,11 +1533,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[void] -- -##### [id](https://github.com/appium/ruby_lib/blob/ed917866929f0f7b0ff7ef0aedb5a9b35fdcc95b/lib/appium_lib/ios/helper.rb#L183) ios +##### [id](https://github.com/appium/ruby_lib/blob/d67cbbac43f511515f6e6f53197cfae2bb7671e0/lib/appium_lib/ios/helper.rb#L183) ios > def id(id) Find by id @@ -1549,11 +1549,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Element] -- -##### [ios_version](https://github.com/appium/ruby_lib/blob/ed917866929f0f7b0ff7ef0aedb5a9b35fdcc95b/lib/appium_lib/ios/helper.rb#L189) ios +##### [ios_version](https://github.com/appium/ruby_lib/blob/d67cbbac43f511515f6e6f53197cfae2bb7671e0/lib/appium_lib/ios/helper.rb#L189) ios > def ios_version Return the iOS version as an array of integers @@ -1561,11 +1561,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Array<Integer>] -- -##### [ele_index](https://github.com/appium/ruby_lib/blob/ed917866929f0f7b0ff7ef0aedb5a9b35fdcc95b/lib/appium_lib/ios/helper.rb#L198) ios +##### [ele_index](https://github.com/appium/ruby_lib/blob/d67cbbac43f511515f6e6f53197cfae2bb7671e0/lib/appium_lib/ios/helper.rb#L198) ios > def ele_index(class_name, index) Get the element of type class_name at matching index. @@ -1579,11 +1579,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Element] -- -##### [find_ele_by_attr](https://github.com/appium/ruby_lib/blob/ed917866929f0f7b0ff7ef0aedb5a9b35fdcc95b/lib/appium_lib/ios/helper.rb#L225) ios +##### [find_ele_by_attr](https://github.com/appium/ruby_lib/blob/d67cbbac43f511515f6e6f53197cfae2bb7671e0/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 @@ -1600,11 +1600,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Element] -- -##### [find_eles_by_attr](https://github.com/appium/ruby_lib/blob/ed917866929f0f7b0ff7ef0aedb5a9b35fdcc95b/lib/appium_lib/ios/helper.rb#L235) ios +##### [find_eles_by_attr](https://github.com/appium/ruby_lib/blob/d67cbbac43f511515f6e6f53197cfae2bb7671e0/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 @@ -1621,11 +1621,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Array<Element>] -- -##### [find_ele_by_attr_include](https://github.com/appium/ruby_lib/blob/ed917866929f0f7b0ff7ef0aedb5a9b35fdcc95b/lib/appium_lib/ios/helper.rb#L250) ios +##### [find_ele_by_attr_include](https://github.com/appium/ruby_lib/blob/d67cbbac43f511515f6e6f53197cfae2bb7671e0/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 @@ -1642,11 +1642,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Element] the element of type tag who's attribute includes value -- -##### [find_eles_by_attr_include](https://github.com/appium/ruby_lib/blob/ed917866929f0f7b0ff7ef0aedb5a9b35fdcc95b/lib/appium_lib/ios/helper.rb#L260) ios +##### [find_eles_by_attr_include](https://github.com/appium/ruby_lib/blob/d67cbbac43f511515f6e6f53197cfae2bb7671e0/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 @@ -1663,11 +1663,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Array<Element>] the elements of type tag who's attribute includes value -- -##### [first_ele](https://github.com/appium/ruby_lib/blob/ed917866929f0f7b0ff7ef0aedb5a9b35fdcc95b/lib/appium_lib/ios/helper.rb#L267) ios +##### [first_ele](https://github.com/appium/ruby_lib/blob/d67cbbac43f511515f6e6f53197cfae2bb7671e0/lib/appium_lib/ios/helper.rb#L267) ios > def first_ele(class_name) Get the first tag that matches class_name @@ -1679,11 +1679,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Element] -- -##### [last_ele](https://github.com/appium/ruby_lib/blob/ed917866929f0f7b0ff7ef0aedb5a9b35fdcc95b/lib/appium_lib/ios/helper.rb#L275) ios +##### [last_ele](https://github.com/appium/ruby_lib/blob/d67cbbac43f511515f6e6f53197cfae2bb7671e0/lib/appium_lib/ios/helper.rb#L275) ios > def last_ele(class_name) Get the last tag that matches class_name @@ -1695,11 +1695,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Element] -- -##### [tag](https://github.com/appium/ruby_lib/blob/ed917866929f0f7b0ff7ef0aedb5a9b35fdcc95b/lib/appium_lib/ios/helper.rb#L283) ios +##### [tag](https://github.com/appium/ruby_lib/blob/d67cbbac43f511515f6e6f53197cfae2bb7671e0/lib/appium_lib/ios/helper.rb#L283) ios > def tag(class_name) Returns the first visible element matching class_name @@ -1711,11 +1711,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Element] -- -##### [tags](https://github.com/appium/ruby_lib/blob/ed917866929f0f7b0ff7ef0aedb5a9b35fdcc95b/lib/appium_lib/ios/helper.rb#L294) ios +##### [tags](https://github.com/appium/ruby_lib/blob/d67cbbac43f511515f6e6f53197cfae2bb7671e0/lib/appium_lib/ios/helper.rb#L294) ios > def tags(class_name) Returns all visible elements matching class_name @@ -1727,11 +1727,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Element] -- -##### [ele_by_json_visible_contains](https://github.com/appium/ruby_lib/blob/ed917866929f0f7b0ff7ef0aedb5a9b35fdcc95b/lib/appium_lib/ios/helper.rb#L329) ios +##### [ele_by_json_visible_contains](https://github.com/appium/ruby_lib/blob/d67cbbac43f511515f6e6f53197cfae2bb7671e0/lib/appium_lib/ios/helper.rb#L329) ios > def ele_by_json_visible_contains(element, value) Find the first element that contains value @@ -1745,11 +1745,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Element] -- -##### [eles_by_json_visible_contains](https://github.com/appium/ruby_lib/blob/ed917866929f0f7b0ff7ef0aedb5a9b35fdcc95b/lib/appium_lib/ios/helper.rb#L337) ios +##### [eles_by_json_visible_contains](https://github.com/appium/ruby_lib/blob/d67cbbac43f511515f6e6f53197cfae2bb7671e0/lib/appium_lib/ios/helper.rb#L337) ios > def eles_by_json_visible_contains(element, value) Find all elements containing value @@ -1763,11 +1763,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Array<Element>] -- -##### [ele_by_json_visible_exact](https://github.com/appium/ruby_lib/blob/ed917866929f0f7b0ff7ef0aedb5a9b35fdcc95b/lib/appium_lib/ios/helper.rb#L366) ios +##### [ele_by_json_visible_exact](https://github.com/appium/ruby_lib/blob/d67cbbac43f511515f6e6f53197cfae2bb7671e0/lib/appium_lib/ios/helper.rb#L366) ios > def ele_by_json_visible_exact(element, value) Find the first element exactly matching value @@ -1781,11 +1781,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Element] -- -##### [eles_by_json_visible_exact](https://github.com/appium/ruby_lib/blob/ed917866929f0f7b0ff7ef0aedb5a9b35fdcc95b/lib/appium_lib/ios/helper.rb#L374) ios +##### [eles_by_json_visible_exact](https://github.com/appium/ruby_lib/blob/d67cbbac43f511515f6e6f53197cfae2bb7671e0/lib/appium_lib/ios/helper.rb#L374) ios > def eles_by_json_visible_exact(element, value) Find all elements exactly matching value @@ -1799,21 +1799,21 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Element] -- -##### [_all_pred](https://github.com/appium/ruby_lib/blob/ed917866929f0f7b0ff7ef0aedb5a9b35fdcc95b/lib/appium_lib/ios/helper.rb#L438) ios +##### [_all_pred](https://github.com/appium/ruby_lib/blob/d67cbbac43f511515f6e6f53197cfae2bb7671e0/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/ed917866929f0f7b0ff7ef0aedb5a9b35fdcc95b/lib/appium_lib/ios/helper.rb#L451) ios +##### [ele_with_pred](https://github.com/appium/ruby_lib/blob/d67cbbac43f511515f6e6f53197cfae2bb7671e0/lib/appium_lib/ios/helper.rb#L451) ios > def ele_with_pred(opts) returns element matching predicate contained in the main app @@ -1825,11 +1825,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Element] -- -##### [eles_with_pred](https://github.com/appium/ruby_lib/blob/ed917866929f0f7b0ff7ef0aedb5a9b35fdcc95b/lib/appium_lib/ios/helper.rb#L462) ios +##### [eles_with_pred](https://github.com/appium/ruby_lib/blob/d67cbbac43f511515f6e6f53197cfae2bb7671e0/lib/appium_lib/ios/helper.rb#L462) ios > def eles_with_pred(opts) returns elements matching predicate contained in the main app @@ -1841,11 +1841,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Array<Element>] -- -##### [source](https://github.com/appium/ruby_lib/blob/ed917866929f0f7b0ff7ef0aedb5a9b35fdcc95b/lib/appium_lib/ios/helper.rb#L468) ios +##### [source](https://github.com/appium/ruby_lib/blob/d67cbbac43f511515f6e6f53197cfae2bb7671e0/lib/appium_lib/ios/helper.rb#L468) ios > def source Prints xml of the current page @@ -1853,19 +1853,19 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[void] -- -##### [_validate_object](https://github.com/appium/ruby_lib/blob/ed917866929f0f7b0ff7ef0aedb5a9b35fdcc95b/lib/appium_lib/ios/helper.rb#L472) ios +##### [_validate_object](https://github.com/appium/ruby_lib/blob/d67cbbac43f511515f6e6f53197cfae2bb7671e0/lib/appium_lib/ios/helper.rb#L472) ios > def _validate_object(*objects) -- -##### [_by_json](https://github.com/appium/ruby_lib/blob/ed917866929f0f7b0ff7ef0aedb5a9b35fdcc95b/lib/appium_lib/ios/helper.rb#L520) ios +##### [_by_json](https://github.com/appium/ruby_lib/blob/d67cbbac43f511515f6e6f53197cfae2bb7671e0/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 @@ -1895,11 +1895,11 @@ } } -- -##### [eles_by_json](https://github.com/appium/ruby_lib/blob/ed917866929f0f7b0ff7ef0aedb5a9b35fdcc95b/lib/appium_lib/ios/helper.rb#L569) ios +##### [eles_by_json](https://github.com/appium/ruby_lib/blob/d67cbbac43f511515f6e6f53197cfae2bb7671e0/lib/appium_lib/ios/helper.rb#L569) ios > def eles_by_json(opts) example usage: @@ -1913,19 +1913,19 @@ }, }) -- -##### [ele_by_json](https://github.com/appium/ruby_lib/blob/ed917866929f0f7b0ff7ef0aedb5a9b35fdcc95b/lib/appium_lib/ios/helper.rb#L575) ios +##### [ele_by_json](https://github.com/appium/ruby_lib/blob/d67cbbac43f511515f6e6f53197cfae2bb7671e0/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/ed917866929f0f7b0ff7ef0aedb5a9b35fdcc95b/lib/appium_lib/ios/helper.rb#L585) ios +##### [get_source](https://github.com/appium/ruby_lib/blob/d67cbbac43f511515f6e6f53197cfae2bb7671e0/lib/appium_lib/ios/helper.rb#L585) ios > def get_source Returns XML string for the current page Same as driver.page_source @@ -1934,19 +1934,19 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[String] -- -##### [UIAStaticText](https://github.com/appium/ruby_lib/blob/ed917866929f0f7b0ff7ef0aedb5a9b35fdcc95b/lib/appium_lib/ios/element/text.rb#L4) ios +##### [UIAStaticText](https://github.com/appium/ruby_lib/blob/d67cbbac43f511515f6e6f53197cfae2bb7671e0/lib/appium_lib/ios/element/text.rb#L4) ios > UIAStaticText = 'UIAStaticText' -- -##### [text](https://github.com/appium/ruby_lib/blob/ed917866929f0f7b0ff7ef0aedb5a9b35fdcc95b/lib/appium_lib/ios/element/text.rb#L10) ios +##### [text](https://github.com/appium/ruby_lib/blob/d67cbbac43f511515f6e6f53197cfae2bb7671e0/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. @@ -1959,11 +1959,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[UIAStaticText] -- -##### [texts](https://github.com/appium/ruby_lib/blob/ed917866929f0f7b0ff7ef0aedb5a9b35fdcc95b/lib/appium_lib/ios/element/text.rb#L19) ios +##### [texts](https://github.com/appium/ruby_lib/blob/d67cbbac43f511515f6e6f53197cfae2bb7671e0/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 @@ -1976,11 +1976,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Array<UIAStaticText>] -- -##### [first_text](https://github.com/appium/ruby_lib/blob/ed917866929f0f7b0ff7ef0aedb5a9b35fdcc95b/lib/appium_lib/ios/element/text.rb#L26) ios +##### [first_text](https://github.com/appium/ruby_lib/blob/d67cbbac43f511515f6e6f53197cfae2bb7671e0/lib/appium_lib/ios/element/text.rb#L26) ios > def first_text Find the first UIAStaticText. @@ -1988,11 +1988,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[UIAStaticText] -- -##### [last_text](https://github.com/appium/ruby_lib/blob/ed917866929f0f7b0ff7ef0aedb5a9b35fdcc95b/lib/appium_lib/ios/element/text.rb#L32) ios +##### [last_text](https://github.com/appium/ruby_lib/blob/d67cbbac43f511515f6e6f53197cfae2bb7671e0/lib/appium_lib/ios/element/text.rb#L32) ios > def last_text Find the last UIAStaticText. @@ -2000,11 +2000,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[UIAStaticText] -- -##### [text_exact](https://github.com/appium/ruby_lib/blob/ed917866929f0f7b0ff7ef0aedb5a9b35fdcc95b/lib/appium_lib/ios/element/text.rb#L39) ios +##### [text_exact](https://github.com/appium/ruby_lib/blob/d67cbbac43f511515f6e6f53197cfae2bb7671e0/lib/appium_lib/ios/element/text.rb#L39) ios > def text_exact(value) Find the first UIAStaticText that exactly matches value. @@ -2016,11 +2016,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[UIAStaticText] -- -##### [texts_exact](https://github.com/appium/ruby_lib/blob/ed917866929f0f7b0ff7ef0aedb5a9b35fdcc95b/lib/appium_lib/ios/element/text.rb#L46) ios +##### [texts_exact](https://github.com/appium/ruby_lib/blob/d67cbbac43f511515f6e6f53197cfae2bb7671e0/lib/appium_lib/ios/element/text.rb#L46) ios > def texts_exact(value) Find all UIAStaticTexts that exactly match value. @@ -2032,11 +2032,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Array<UIAStaticText>] -- -##### [alert_accept](https://github.com/appium/ruby_lib/blob/ed917866929f0f7b0ff7ef0aedb5a9b35fdcc95b/lib/appium_lib/ios/element/alert.rb#L5) ios +##### [alert_accept](https://github.com/appium/ruby_lib/blob/d67cbbac43f511515f6e6f53197cfae2bb7671e0/lib/appium_lib/ios/element/alert.rb#L5) ios > def alert_accept Accept the alert. @@ -2044,11 +2044,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[void] -- -##### [alert_dismiss](https://github.com/appium/ruby_lib/blob/ed917866929f0f7b0ff7ef0aedb5a9b35fdcc95b/lib/appium_lib/ios/element/alert.rb#L13) ios +##### [alert_dismiss](https://github.com/appium/ruby_lib/blob/d67cbbac43f511515f6e6f53197cfae2bb7671e0/lib/appium_lib/ios/element/alert.rb#L13) ios > def alert_dismiss Dismiss the alert. @@ -2056,11 +2056,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[void] -- -##### [uiautomation_find](https://github.com/appium/ruby_lib/blob/ed917866929f0f7b0ff7ef0aedb5a9b35fdcc95b/lib/appium_lib/ios/mobile_methods.rb#L10) ios +##### [uiautomation_find](https://github.com/appium/ruby_lib/blob/d67cbbac43f511515f6e6f53197cfae2bb7671e0/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). @@ -2068,19 +2068,19 @@ find_elements :uiautomation, 'elements() ``` -- -##### [UIAButton](https://github.com/appium/ruby_lib/blob/ed917866929f0f7b0ff7ef0aedb5a9b35fdcc95b/lib/appium_lib/ios/element/button.rb#L4) ios +##### [UIAButton](https://github.com/appium/ruby_lib/blob/d67cbbac43f511515f6e6f53197cfae2bb7671e0/lib/appium_lib/ios/element/button.rb#L4) ios > UIAButton = 'UIAButton' -- -##### [button](https://github.com/appium/ruby_lib/blob/ed917866929f0f7b0ff7ef0aedb5a9b35fdcc95b/lib/appium_lib/ios/element/button.rb#L10) ios +##### [button](https://github.com/appium/ruby_lib/blob/d67cbbac43f511515f6e6f53197cfae2bb7671e0/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. @@ -2093,11 +2093,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[UIAButton] -- -##### [buttons](https://github.com/appium/ruby_lib/blob/ed917866929f0f7b0ff7ef0aedb5a9b35fdcc95b/lib/appium_lib/ios/element/button.rb#L20) ios +##### [buttons](https://github.com/appium/ruby_lib/blob/d67cbbac43f511515f6e6f53197cfae2bb7671e0/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. @@ -2110,11 +2110,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Array<UIAButton>] -- -##### [first_button](https://github.com/appium/ruby_lib/blob/ed917866929f0f7b0ff7ef0aedb5a9b35fdcc95b/lib/appium_lib/ios/element/button.rb#L27) ios +##### [first_button](https://github.com/appium/ruby_lib/blob/d67cbbac43f511515f6e6f53197cfae2bb7671e0/lib/appium_lib/ios/element/button.rb#L27) ios > def first_button Find the first UIAButton. @@ -2122,11 +2122,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[UIAButton] -- -##### [last_button](https://github.com/appium/ruby_lib/blob/ed917866929f0f7b0ff7ef0aedb5a9b35fdcc95b/lib/appium_lib/ios/element/button.rb#L33) ios +##### [last_button](https://github.com/appium/ruby_lib/blob/d67cbbac43f511515f6e6f53197cfae2bb7671e0/lib/appium_lib/ios/element/button.rb#L33) ios > def last_button Find the last UIAButton. @@ -2134,11 +2134,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[UIAButton] -- -##### [button_exact](https://github.com/appium/ruby_lib/blob/ed917866929f0f7b0ff7ef0aedb5a9b35fdcc95b/lib/appium_lib/ios/element/button.rb#L40) ios +##### [button_exact](https://github.com/appium/ruby_lib/blob/d67cbbac43f511515f6e6f53197cfae2bb7671e0/lib/appium_lib/ios/element/button.rb#L40) ios > def button_exact(value) Find the first UIAButton that exactly matches value. @@ -2150,11 +2150,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[UIAButton] -- -##### [buttons_exact](https://github.com/appium/ruby_lib/blob/ed917866929f0f7b0ff7ef0aedb5a9b35fdcc95b/lib/appium_lib/ios/element/button.rb#L47) ios +##### [buttons_exact](https://github.com/appium/ruby_lib/blob/d67cbbac43f511515f6e6f53197cfae2bb7671e0/lib/appium_lib/ios/element/button.rb#L47) ios > def buttons_exact(value) Find all UIAButtons that exactly match value. @@ -2166,11 +2166,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Array<UIAButton>] -- -##### [find](https://github.com/appium/ruby_lib/blob/ed917866929f0f7b0ff7ef0aedb5a9b35fdcc95b/lib/appium_lib/ios/element/generic.rb#L6) ios +##### [find](https://github.com/appium/ruby_lib/blob/d67cbbac43f511515f6e6f53197cfae2bb7671e0/lib/appium_lib/ios/element/generic.rb#L6) ios > def find(value) Find the first element containing value @@ -2182,11 +2182,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Element] -- -##### [finds](https://github.com/appium/ruby_lib/blob/ed917866929f0f7b0ff7ef0aedb5a9b35fdcc95b/lib/appium_lib/ios/element/generic.rb#L13) ios +##### [finds](https://github.com/appium/ruby_lib/blob/d67cbbac43f511515f6e6f53197cfae2bb7671e0/lib/appium_lib/ios/element/generic.rb#L13) ios > def finds(value) Find all elements containing value @@ -2198,11 +2198,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Array<Element>] -- -##### [find_exact](https://github.com/appium/ruby_lib/blob/ed917866929f0f7b0ff7ef0aedb5a9b35fdcc95b/lib/appium_lib/ios/element/generic.rb#L20) ios +##### [find_exact](https://github.com/appium/ruby_lib/blob/d67cbbac43f511515f6e6f53197cfae2bb7671e0/lib/appium_lib/ios/element/generic.rb#L20) ios > def find_exact(value) Find the first element exactly matching value @@ -2214,11 +2214,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Element] -- -##### [finds_exact](https://github.com/appium/ruby_lib/blob/ed917866929f0f7b0ff7ef0aedb5a9b35fdcc95b/lib/appium_lib/ios/element/generic.rb#L27) ios +##### [finds_exact](https://github.com/appium/ruby_lib/blob/d67cbbac43f511515f6e6f53197cfae2bb7671e0/lib/appium_lib/ios/element/generic.rb#L27) ios > def finds_exact(value) Find all elements exactly matching value @@ -2230,27 +2230,27 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Array<Element>] -- -##### [UIATextField](https://github.com/appium/ruby_lib/blob/ed917866929f0f7b0ff7ef0aedb5a9b35fdcc95b/lib/appium_lib/ios/element/textfield.rb#L3) ios +##### [UIATextField](https://github.com/appium/ruby_lib/blob/d67cbbac43f511515f6e6f53197cfae2bb7671e0/lib/appium_lib/ios/element/textfield.rb#L3) ios > UIATextField = 'UIATextField' -- -##### [UIASecureTextField](https://github.com/appium/ruby_lib/blob/ed917866929f0f7b0ff7ef0aedb5a9b35fdcc95b/lib/appium_lib/ios/element/textfield.rb#L4) ios +##### [UIASecureTextField](https://github.com/appium/ruby_lib/blob/d67cbbac43f511515f6e6f53197cfae2bb7671e0/lib/appium_lib/ios/element/textfield.rb#L4) ios > UIASecureTextField = 'UIASecureTextField' -- -##### [textfield](https://github.com/appium/ruby_lib/blob/ed917866929f0f7b0ff7ef0aedb5a9b35fdcc95b/lib/appium_lib/ios/element/textfield.rb#L52) ios +##### [textfield](https://github.com/appium/ruby_lib/blob/d67cbbac43f511515f6e6f53197cfae2bb7671e0/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. @@ -2263,11 +2263,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[TextField] -- -##### [textfields](https://github.com/appium/ruby_lib/blob/ed917866929f0f7b0ff7ef0aedb5a9b35fdcc95b/lib/appium_lib/ios/element/textfield.rb#L72) ios +##### [textfields](https://github.com/appium/ruby_lib/blob/d67cbbac43f511515f6e6f53197cfae2bb7671e0/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. @@ -2280,11 +2280,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Array<TextField>] -- -##### [first_textfield](https://github.com/appium/ruby_lib/blob/ed917866929f0f7b0ff7ef0aedb5a9b35fdcc95b/lib/appium_lib/ios/element/textfield.rb#L79) ios +##### [first_textfield](https://github.com/appium/ruby_lib/blob/d67cbbac43f511515f6e6f53197cfae2bb7671e0/lib/appium_lib/ios/element/textfield.rb#L79) ios > def first_textfield Find the first TextField. @@ -2292,11 +2292,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[TextField] -- -##### [last_textfield](https://github.com/appium/ruby_lib/blob/ed917866929f0f7b0ff7ef0aedb5a9b35fdcc95b/lib/appium_lib/ios/element/textfield.rb#L85) ios +##### [last_textfield](https://github.com/appium/ruby_lib/blob/d67cbbac43f511515f6e6f53197cfae2bb7671e0/lib/appium_lib/ios/element/textfield.rb#L85) ios > def last_textfield Find the last TextField. @@ -2304,11 +2304,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[TextField] -- -##### [textfield_exact](https://github.com/appium/ruby_lib/blob/ed917866929f0f7b0ff7ef0aedb5a9b35fdcc95b/lib/appium_lib/ios/element/textfield.rb#L94) ios +##### [textfield_exact](https://github.com/appium/ruby_lib/blob/d67cbbac43f511515f6e6f53197cfae2bb7671e0/lib/appium_lib/ios/element/textfield.rb#L94) ios > def textfield_exact(value) Find the first TextField that exactly matches value. @@ -2320,11 +2320,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[TextField] -- -##### [textfields_exact](https://github.com/appium/ruby_lib/blob/ed917866929f0f7b0ff7ef0aedb5a9b35fdcc95b/lib/appium_lib/ios/element/textfield.rb#L101) ios +##### [textfields_exact](https://github.com/appium/ruby_lib/blob/d67cbbac43f511515f6e6f53197cfae2bb7671e0/lib/appium_lib/ios/element/textfield.rb#L101) ios > def textfields_exact(value) Find all TextFields that exactly match value. @@ -2336,31 +2336,31 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Array<TextField>] -- -##### [value](https://github.com/appium/ruby_lib/blob/ed917866929f0f7b0ff7ef0aedb5a9b35fdcc95b/lib/appium_lib/common/patch.rb#L12) +##### [value](https://github.com/appium/ruby_lib/blob/d67cbbac43f511515f6e6f53197cfae2bb7671e0/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/ed917866929f0f7b0ff7ef0aedb5a9b35fdcc95b/lib/appium_lib/common/patch.rb#L19) +##### [name](https://github.com/appium/ruby_lib/blob/d67cbbac43f511515f6e6f53197cfae2bb7671e0/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/ed917866929f0f7b0ff7ef0aedb5a9b35fdcc95b/lib/appium_lib/common/patch.rb#L31) +##### [location_rel](https://github.com/appium/ruby_lib/blob/d67cbbac43f511515f6e6f53197cfae2bb7671e0/lib/appium_lib/common/patch.rb#L31) > def location_rel For use with mobile tap. @@ -2374,10 +2374,10 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[OpenStruct] the relative x, y in a struct. ex: { x: 0.50, y: 0.20 } -- -##### [DEFAULT_HEADERS](https://github.com/appium/ruby_lib/blob/ed917866929f0f7b0ff7ef0aedb5a9b35fdcc95b/lib/appium_lib/common/patch.rb#L147) +##### [DEFAULT_HEADERS](https://github.com/appium/ruby_lib/blob/d67cbbac43f511515f6e6f53197cfae2bb7671e0/lib/appium_lib/common/patch.rb#L147) > DEFAULT_HEADERS = { 'Accept' => CONTENT_TYPE, 'User-Agent' => "appium/ruby_lib/#{::Appium::VERSION}" }