docs/android_docs.md in appium_lib-7.0.0 vs docs/android_docs.md in appium_lib-8.0.0

- old
+ new

@@ -1,6 +1,6 @@ -##### [load_appium_txt](https://github.com/appium/ruby_lib/blob/af838966d0724793d3dbfa35798ca6dd9f8a3143/lib/appium_lib/driver.rb#L70) +##### [load_appium_txt](https://github.com/appium/ruby_lib/blob/e71fd1e1a220d9453a954ece00e07875a6b5f7ef/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/af838966d0724793d3dbfa35798ca6dd9f8a3143/lib/appium_lib/driver.rb#L139) +##### [symbolize_keys](https://github.com/appium/ruby_lib/blob/e71fd1e1a220d9453a954ece00e07875a6b5f7ef/lib/appium_lib/driver.rb#L139) > 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/af838966d0724793d3dbfa35798ca6dd9f8a3143/lib/appium_lib/driver.rb#L160) +##### [promote_singleton_appium_methods](https://github.com/appium/ruby_lib/blob/e71fd1e1a220d9453a954ece00e07875a6b5f7ef/lib/appium_lib/driver.rb#L160) > 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/af838966d0724793d3dbfa35798ca6dd9f8a3143/lib/appium_lib/driver.rb#L211) +##### [promote_appium_methods](https://github.com/appium/ruby_lib/blob/e71fd1e1a220d9453a954ece00e07875a6b5f7ef/lib/appium_lib/driver.rb#L211) > 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/af838966d0724793d3dbfa35798ca6dd9f8a3143/lib/appium_lib/driver.rb#L245) +##### [global_webdriver_http_sleep](https://github.com/appium/ruby_lib/blob/e71fd1e1a220d9453a954ece00e07875a6b5f7ef/lib/appium_lib/driver.rb#L245) > 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/af838966d0724793d3dbfa35798ca6dd9f8a3143/lib/appium_lib/driver.rb#L245) +##### [global_webdriver_http_sleep=](https://github.com/appium/ruby_lib/blob/e71fd1e1a220d9453a954ece00e07875a6b5f7ef/lib/appium_lib/driver.rb#L245) > 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/af838966d0724793d3dbfa35798ca6dd9f8a3143/lib/appium_lib/driver.rb#L247) +##### [caps](https://github.com/appium/ruby_lib/blob/e71fd1e1a220d9453a954ece00e07875a6b5f7ef/lib/appium_lib/driver.rb#L247) > def caps Selenium webdriver capabilities -- -##### [caps=](https://github.com/appium/ruby_lib/blob/af838966d0724793d3dbfa35798ca6dd9f8a3143/lib/appium_lib/driver.rb#L247) +##### [caps=](https://github.com/appium/ruby_lib/blob/e71fd1e1a220d9453a954ece00e07875a6b5f7ef/lib/appium_lib/driver.rb#L247) > def caps=(value) Selenium webdriver capabilities -- -##### [custom_url](https://github.com/appium/ruby_lib/blob/af838966d0724793d3dbfa35798ca6dd9f8a3143/lib/appium_lib/driver.rb#L249) +##### [custom_url](https://github.com/appium/ruby_lib/blob/e71fd1e1a220d9453a954ece00e07875a6b5f7ef/lib/appium_lib/driver.rb#L249) > def custom_url Custom URL for the selenium server -- -##### [custom_url=](https://github.com/appium/ruby_lib/blob/af838966d0724793d3dbfa35798ca6dd9f8a3143/lib/appium_lib/driver.rb#L249) +##### [custom_url=](https://github.com/appium/ruby_lib/blob/e71fd1e1a220d9453a954ece00e07875a6b5f7ef/lib/appium_lib/driver.rb#L249) > def custom_url=(value) Custom URL for the selenium server -- -##### [export_session](https://github.com/appium/ruby_lib/blob/af838966d0724793d3dbfa35798ca6dd9f8a3143/lib/appium_lib/driver.rb#L251) +##### [export_session](https://github.com/appium/ruby_lib/blob/e71fd1e1a220d9453a954ece00e07875a6b5f7ef/lib/appium_lib/driver.rb#L251) > def export_session Export session id to textfile in /tmp for 3rd party tools -- -##### [export_session=](https://github.com/appium/ruby_lib/blob/af838966d0724793d3dbfa35798ca6dd9f8a3143/lib/appium_lib/driver.rb#L251) +##### [export_session=](https://github.com/appium/ruby_lib/blob/e71fd1e1a220d9453a954ece00e07875a6b5f7ef/lib/appium_lib/driver.rb#L251) > def export_session=(value) Export session id to textfile in /tmp for 3rd party tools -- -##### [default_wait](https://github.com/appium/ruby_lib/blob/af838966d0724793d3dbfa35798ca6dd9f8a3143/lib/appium_lib/driver.rb#L256) +##### [default_wait](https://github.com/appium/ruby_lib/blob/e71fd1e1a220d9453a954ece00e07875a6b5f7ef/lib/appium_lib/driver.rb#L256) > 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/af838966d0724793d3dbfa35798ca6dd9f8a3143/lib/appium_lib/driver.rb#L256) +##### [default_wait=](https://github.com/appium/ruby_lib/blob/e71fd1e1a220d9453a954ece00e07875a6b5f7ef/lib/appium_lib/driver.rb#L256) > 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/af838966d0724793d3dbfa35798ca6dd9f8a3143/lib/appium_lib/driver.rb#L258) +##### [last_waits](https://github.com/appium/ruby_lib/blob/e71fd1e1a220d9453a954ece00e07875a6b5f7ef/lib/appium_lib/driver.rb#L258) > def last_waits Array of previous wait time values -- -##### [last_waits=](https://github.com/appium/ruby_lib/blob/af838966d0724793d3dbfa35798ca6dd9f8a3143/lib/appium_lib/driver.rb#L258) +##### [last_waits=](https://github.com/appium/ruby_lib/blob/e71fd1e1a220d9453a954ece00e07875a6b5f7ef/lib/appium_lib/driver.rb#L258) > def last_waits=(value) Array of previous wait time values -- -##### [sauce_username](https://github.com/appium/ruby_lib/blob/af838966d0724793d3dbfa35798ca6dd9f8a3143/lib/appium_lib/driver.rb#L260) +##### [sauce_username](https://github.com/appium/ruby_lib/blob/e71fd1e1a220d9453a954ece00e07875a6b5f7ef/lib/appium_lib/driver.rb#L260) > def sauce_username Username for use on Sauce Labs -- -##### [sauce_username=](https://github.com/appium/ruby_lib/blob/af838966d0724793d3dbfa35798ca6dd9f8a3143/lib/appium_lib/driver.rb#L260) +##### [sauce_username=](https://github.com/appium/ruby_lib/blob/e71fd1e1a220d9453a954ece00e07875a6b5f7ef/lib/appium_lib/driver.rb#L260) > def sauce_username=(value) Username for use on Sauce Labs -- -##### [sauce_access_key](https://github.com/appium/ruby_lib/blob/af838966d0724793d3dbfa35798ca6dd9f8a3143/lib/appium_lib/driver.rb#L262) +##### [sauce_access_key](https://github.com/appium/ruby_lib/blob/e71fd1e1a220d9453a954ece00e07875a6b5f7ef/lib/appium_lib/driver.rb#L262) > def sauce_access_key Access Key for use on Sauce Labs -- -##### [sauce_access_key=](https://github.com/appium/ruby_lib/blob/af838966d0724793d3dbfa35798ca6dd9f8a3143/lib/appium_lib/driver.rb#L262) +##### [sauce_access_key=](https://github.com/appium/ruby_lib/blob/e71fd1e1a220d9453a954ece00e07875a6b5f7ef/lib/appium_lib/driver.rb#L262) > def sauce_access_key=(value) Access Key for use on Sauce Labs -- -##### [appium_port](https://github.com/appium/ruby_lib/blob/af838966d0724793d3dbfa35798ca6dd9f8a3143/lib/appium_lib/driver.rb#L264) +##### [appium_port](https://github.com/appium/ruby_lib/blob/e71fd1e1a220d9453a954ece00e07875a6b5f7ef/lib/appium_lib/driver.rb#L264) > def appium_port Appium's server port -- -##### [appium_port=](https://github.com/appium/ruby_lib/blob/af838966d0724793d3dbfa35798ca6dd9f8a3143/lib/appium_lib/driver.rb#L264) +##### [appium_port=](https://github.com/appium/ruby_lib/blob/e71fd1e1a220d9453a954ece00e07875a6b5f7ef/lib/appium_lib/driver.rb#L264) > def appium_port=(value) Appium's server port -- -##### [appium_device](https://github.com/appium/ruby_lib/blob/af838966d0724793d3dbfa35798ca6dd9f8a3143/lib/appium_lib/driver.rb#L266) +##### [appium_device](https://github.com/appium/ruby_lib/blob/e71fd1e1a220d9453a954ece00e07875a6b5f7ef/lib/appium_lib/driver.rb#L266) > def appium_device Device type to request from the appium server -- -##### [appium_device=](https://github.com/appium/ruby_lib/blob/af838966d0724793d3dbfa35798ca6dd9f8a3143/lib/appium_lib/driver.rb#L266) +##### [appium_device=](https://github.com/appium/ruby_lib/blob/e71fd1e1a220d9453a954ece00e07875a6b5f7ef/lib/appium_lib/driver.rb#L266) > def appium_device=(value) Device type to request from the appium server -- -##### [appium_debug](https://github.com/appium/ruby_lib/blob/af838966d0724793d3dbfa35798ca6dd9f8a3143/lib/appium_lib/driver.rb#L268) +##### [appium_debug](https://github.com/appium/ruby_lib/blob/e71fd1e1a220d9453a954ece00e07875a6b5f7ef/lib/appium_lib/driver.rb#L268) > def appium_debug Boolean debug mode for the Appium Ruby bindings -- -##### [appium_debug=](https://github.com/appium/ruby_lib/blob/af838966d0724793d3dbfa35798ca6dd9f8a3143/lib/appium_lib/driver.rb#L268) +##### [appium_debug=](https://github.com/appium/ruby_lib/blob/e71fd1e1a220d9453a954ece00e07875a6b5f7ef/lib/appium_lib/driver.rb#L268) > def appium_debug=(value) Boolean debug mode for the Appium Ruby bindings -- -##### [driver](https://github.com/appium/ruby_lib/blob/af838966d0724793d3dbfa35798ca6dd9f8a3143/lib/appium_lib/driver.rb#L272) +##### [driver](https://github.com/appium/ruby_lib/blob/e71fd1e1a220d9453a954ece00e07875a6b5f7ef/lib/appium_lib/driver.rb#L272) > 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/af838966d0724793d3dbfa35798ca6dd9f8a3143/lib/appium_lib/driver.rb#L293) +##### [initialize](https://github.com/appium/ruby_lib/blob/e71fd1e1a220d9453a954ece00e07875a6b5f7ef/lib/appium_lib/driver.rb#L293) > 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/af838966d0724793d3dbfa35798ca6dd9f8a3143/lib/appium_lib/driver.rb#L359) +##### [driver_attributes](https://github.com/appium/ruby_lib/blob/e71fd1e1a220d9453a954ece00e07875a6b5f7ef/lib/appium_lib/driver.rb#L359) > def driver_attributes Returns a hash of the driver attributes -- -##### [device_is_android?](https://github.com/appium/ruby_lib/blob/af838966d0724793d3dbfa35798ca6dd9f8a3143/lib/appium_lib/driver.rb#L379) +##### [device_is_android?](https://github.com/appium/ruby_lib/blob/e71fd1e1a220d9453a954ece00e07875a6b5f7ef/lib/appium_lib/driver.rb#L379) > def device_is_android? @@ -335,11 +335,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Boolean] -- -##### [appium_server_version](https://github.com/appium/ruby_lib/blob/af838966d0724793d3dbfa35798ca6dd9f8a3143/lib/appium_lib/driver.rb#L395) +##### [appium_server_version](https://github.com/appium/ruby_lib/blob/e71fd1e1a220d9453a954ece00e07875a6b5f7ef/lib/appium_lib/driver.rb#L395) > 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/af838966d0724793d3dbfa35798ca6dd9f8a3143/lib/appium_lib/driver.rb#L407) +##### [absolute_app_path](https://github.com/appium/ruby_lib/blob/e71fd1e1a220d9453a954ece00e07875a6b5f7ef/lib/appium_lib/driver.rb#L407) > 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/af838966d0724793d3dbfa35798ca6dd9f8a3143/lib/appium_lib/driver.rb#L440) +##### [server_url](https://github.com/appium/ruby_lib/blob/e71fd1e1a220d9453a954ece00e07875a6b5f7ef/lib/appium_lib/driver.rb#L440) > 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/af838966d0724793d3dbfa35798ca6dd9f8a3143/lib/appium_lib/driver.rb#L451) +##### [restart](https://github.com/appium/ruby_lib/blob/e71fd1e1a220d9453a954ece00e07875a6b5f7ef/lib/appium_lib/driver.rb#L451) > 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/af838966d0724793d3dbfa35798ca6dd9f8a3143/lib/appium_lib/driver.rb#L462) +##### [screenshot](https://github.com/appium/ruby_lib/blob/e71fd1e1a220d9453a954ece00e07875a6b5f7ef/lib/appium_lib/driver.rb#L462) > 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/af838966d0724793d3dbfa35798ca6dd9f8a3143/lib/appium_lib/driver.rb#L469) +##### [driver_quit](https://github.com/appium/ruby_lib/blob/e71fd1e1a220d9453a954ece00e07875a6b5f7ef/lib/appium_lib/driver.rb#L469) > 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/af838966d0724793d3dbfa35798ca6dd9f8a3143/lib/appium_lib/driver.rb#L478) +##### [start_driver](https://github.com/appium/ruby_lib/blob/e71fd1e1a220d9453a954ece00e07875a6b5f7ef/lib/appium_lib/driver.rb#L478) > 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/af838966d0724793d3dbfa35798ca6dd9f8a3143/lib/appium_lib/driver.rb#L506) +##### [no_wait](https://github.com/appium/ruby_lib/blob/e71fd1e1a220d9453a954ece00e07875a6b5f7ef/lib/appium_lib/driver.rb#L506) > def no_wait Set implicit wait and default_wait to zero. -- -##### [set_wait](https://github.com/appium/ruby_lib/blob/af838966d0724793d3dbfa35798ca6dd9f8a3143/lib/appium_lib/driver.rb#L525) +##### [set_wait](https://github.com/appium/ruby_lib/blob/e71fd1e1a220d9453a954ece00e07875a6b5f7ef/lib/appium_lib/driver.rb#L525) > 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/af838966d0724793d3dbfa35798ca6dd9f8a3143/lib/appium_lib/driver.rb#L552) +##### [exists](https://github.com/appium/ruby_lib/blob/e71fd1e1a220d9453a954ece00e07875a6b5f7ef/lib/appium_lib/driver.rb#L552) > 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/af838966d0724793d3dbfa35798ca6dd9f8a3143/lib/appium_lib/driver.rb#L576) +##### [execute_script](https://github.com/appium/ruby_lib/blob/e71fd1e1a220d9453a954ece00e07875a6b5f7ef/lib/appium_lib/driver.rb#L576) > 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/af838966d0724793d3dbfa35798ca6dd9f8a3143/lib/appium_lib/driver.rb#L584) +##### [find_elements](https://github.com/appium/ruby_lib/blob/e71fd1e1a220d9453a954ece00e07875a6b5f7ef/lib/appium_lib/driver.rb#L584) > 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/af838966d0724793d3dbfa35798ca6dd9f8a3143/lib/appium_lib/driver.rb#L592) +##### [find_element](https://github.com/appium/ruby_lib/blob/e71fd1e1a220d9453a954ece00e07875a6b5f7ef/lib/appium_lib/driver.rb#L592) > 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/af838966d0724793d3dbfa35798ca6dd9f8a3143/lib/appium_lib/driver.rb#L605) +##### [set_location](https://github.com/appium/ruby_lib/blob/e71fd1e1a220d9453a954ece00e07875a6b5f7ef/lib/appium_lib/driver.rb#L605) > 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/af838966d0724793d3dbfa35798ca6dd9f8a3143/lib/appium_lib/driver.rb#L615) +##### [x](https://github.com/appium/ruby_lib/blob/e71fd1e1a220d9453a954ece00e07875a6b5f7ef/lib/appium_lib/driver.rb#L615) > 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/af838966d0724793d3dbfa35798ca6dd9f8a3143/lib/appium_lib/logger.rb#L13) +##### [logger=](https://github.com/appium/ruby_lib/blob/e71fd1e1a220d9453a954ece00e07875a6b5f7ef/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/af838966d0724793d3dbfa35798ca6dd9f8a3143/lib/appium_lib/logger.rb#L17) +##### [logger](https://github.com/appium/ruby_lib/blob/e71fd1e1a220d9453a954ece00e07875a6b5f7ef/lib/appium_lib/logger.rb#L17) > def logger -- -##### [NoArgMethods](https://github.com/appium/ruby_lib/blob/af838966d0724793d3dbfa35798ca6dd9f8a3143/lib/appium_lib/device/device.rb#L7) +##### [NoArgMethods](https://github.com/appium/ruby_lib/blob/e71fd1e1a220d9453a954ece00e07875a6b5f7ef/lib/appium_lib/device/device.rb#L7) > NoArgMethods = { -- -##### [app_strings](https://github.com/appium/ruby_lib/blob/af838966d0724793d3dbfa35798ca6dd9f8a3143/lib/appium_lib/device/device.rb#L24) +##### [app_strings](https://github.com/appium/ruby_lib/blob/e71fd1e1a220d9453a954ece00e07875a6b5f7ef/lib/appium_lib/device/device.rb#L24) > 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/af838966d0724793d3dbfa35798ca6dd9f8a3143/lib/appium_lib/device/device.rb#L30) +##### [background_app](https://github.com/appium/ruby_lib/blob/e71fd1e1a220d9453a954ece00e07875a6b5f7ef/lib/appium_lib/device/device.rb#L30) > 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/af838966d0724793d3dbfa35798ca6dd9f8a3143/lib/appium_lib/device/device.rb#L35) +##### [current_activity](https://github.com/appium/ruby_lib/blob/e71fd1e1a220d9453a954ece00e07875a6b5f7ef/lib/appium_lib/device/device.rb#L35) > def current_activity -- -##### [launch_app](https://github.com/appium/ruby_lib/blob/af838966d0724793d3dbfa35798ca6dd9f8a3143/lib/appium_lib/device/device.rb#L37) +##### [launch_app](https://github.com/appium/ruby_lib/blob/e71fd1e1a220d9453a954ece00e07875a6b5f7ef/lib/appium_lib/device/device.rb#L37) > def launch_app Start the simulator and application configured with desired capabilities -- -##### [reset](https://github.com/appium/ruby_lib/blob/af838966d0724793d3dbfa35798ca6dd9f8a3143/lib/appium_lib/device/device.rb#L40) +##### [reset](https://github.com/appium/ruby_lib/blob/e71fd1e1a220d9453a954ece00e07875a6b5f7ef/lib/appium_lib/device/device.rb#L40) > def reset Reset the device, relaunching the application. -- -##### [shake](https://github.com/appium/ruby_lib/blob/af838966d0724793d3dbfa35798ca6dd9f8a3143/lib/appium_lib/device/device.rb#L43) +##### [shake](https://github.com/appium/ruby_lib/blob/e71fd1e1a220d9453a954ece00e07875a6b5f7ef/lib/appium_lib/device/device.rb#L43) > def shake Cause the device to shake -- -##### [toggle_flight_mode](https://github.com/appium/ruby_lib/blob/af838966d0724793d3dbfa35798ca6dd9f8a3143/lib/appium_lib/device/device.rb#L46) +##### [toggle_flight_mode](https://github.com/appium/ruby_lib/blob/e71fd1e1a220d9453a954ece00e07875a6b5f7ef/lib/appium_lib/device/device.rb#L46) > def toggle_flight_mode Toggle flight mode on or off -- -##### [device_locked?](https://github.com/appium/ruby_lib/blob/af838966d0724793d3dbfa35798ca6dd9f8a3143/lib/appium_lib/device/device.rb#L49) +##### [device_locked?](https://github.com/appium/ruby_lib/blob/e71fd1e1a220d9453a954ece00e07875a6b5f7ef/lib/appium_lib/device/device.rb#L49) > def device_locked? -- -##### [hide_keyboard](https://github.com/appium/ruby_lib/blob/af838966d0724793d3dbfa35798ca6dd9f8a3143/lib/appium_lib/device/device.rb#L51) +##### [hide_keyboard](https://github.com/appium/ruby_lib/blob/e71fd1e1a220d9453a954ece00e07875a6b5f7ef/lib/appium_lib/device/device.rb#L51) > 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/af838966d0724793d3dbfa35798ca6dd9f8a3143/lib/appium_lib/device/device.rb#L60) +##### [press_keycode](https://github.com/appium/ruby_lib/blob/e71fd1e1a220d9453a954ece00e07875a6b5f7ef/lib/appium_lib/device/device.rb#L60) > 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/af838966d0724793d3dbfa35798ca6dd9f8a3143/lib/appium_lib/device/device.rb#L66) +##### [long_press_keycode](https://github.com/appium/ruby_lib/blob/e71fd1e1a220d9453a954ece00e07875a6b5f7ef/lib/appium_lib/device/device.rb#L66) > 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/af838966d0724793d3dbfa35798ca6dd9f8a3143/lib/appium_lib/device/device.rb#L72) +##### [push_file](https://github.com/appium/ruby_lib/blob/e71fd1e1a220d9453a954ece00e07875a6b5f7ef/lib/appium_lib/device/device.rb#L72) > 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/af838966d0724793d3dbfa35798ca6dd9f8a3143/lib/appium_lib/device/device.rb#L77) +##### [pull_file](https://github.com/appium/ruby_lib/blob/e71fd1e1a220d9453a954ece00e07875a6b5f7ef/lib/appium_lib/device/device.rb#L77) > 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/af838966d0724793d3dbfa35798ca6dd9f8a3143/lib/appium_lib/device/device.rb#L87) +##### [pull_folder](https://github.com/appium/ruby_lib/blob/e71fd1e1a220d9453a954ece00e07875a6b5f7ef/lib/appium_lib/device/device.rb#L87) > 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/af838966d0724793d3dbfa35798ca6dd9f8a3143/lib/appium_lib/device/device.rb#L95) +##### [end_coverage](https://github.com/appium/ruby_lib/blob/e71fd1e1a220d9453a954ece00e07875a6b5f7ef/lib/appium_lib/device/device.rb#L95) > 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/af838966d0724793d3dbfa35798ca6dd9f8a3143/lib/appium_lib/device/device.rb#L100) +##### [get_settings](https://github.com/appium/ruby_lib/blob/e71fd1e1a220d9453a954ece00e07875a6b5f7ef/lib/appium_lib/device/device.rb#L100) > def get_settings Get appium Settings for current test session -- -##### [extend_search_contexts](https://github.com/appium/ruby_lib/blob/af838966d0724793d3dbfa35798ca6dd9f8a3143/lib/appium_lib/device/device.rb#L351) +##### [extend_search_contexts](https://github.com/appium/ruby_lib/blob/e71fd1e1a220d9453a954ece00e07875a6b5f7ef/lib/appium_lib/device/device.rb#L351) > def extend_search_contexts -- -##### [accessiblity_id_find](https://github.com/appium/ruby_lib/blob/af838966d0724793d3dbfa35798ca6dd9f8a3143/lib/appium_lib/device/device.rb#L351) +##### [accessiblity_id_find](https://github.com/appium/ruby_lib/blob/e71fd1e1a220d9453a954ece00e07875a6b5f7ef/lib/appium_lib/device/device.rb#L351) > 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/af838966d0724793d3dbfa35798ca6dd9f8a3143/lib/appium_lib/device/device.rb#L357) +##### [add_touch_actions](https://github.com/appium/ruby_lib/blob/e71fd1e1a220d9453a954ece00e07875a6b5f7ef/lib/appium_lib/device/device.rb#L357) > def add_touch_actions -- -##### [set_context](https://github.com/appium/ruby_lib/blob/af838966d0724793d3dbfa35798ca6dd9f8a3143/lib/appium_lib/device/device.rb#L381) +##### [set_context](https://github.com/appium/ruby_lib/blob/e71fd1e1a220d9453a954ece00e07875a6b5f7ef/lib/appium_lib/device/device.rb#L381) > 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/af838966d0724793d3dbfa35798ca6dd9f8a3143/lib/appium_lib/device/device.rb#L389) +##### [current_context](https://github.com/appium/ruby_lib/blob/e71fd1e1a220d9453a954ece00e07875a6b5f7ef/lib/appium_lib/device/device.rb#L389) > 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/af838966d0724793d3dbfa35798ca6dd9f8a3143/lib/appium_lib/device/device.rb#L392) +##### [available_contexts](https://github.com/appium/ruby_lib/blob/e71fd1e1a220d9453a954ece00e07875a6b5f7ef/lib/appium_lib/device/device.rb#L392) > 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/af838966d0724793d3dbfa35798ca6dd9f8a3143/lib/appium_lib/device/device.rb#L402) +##### [within_context](https://github.com/appium/ruby_lib/blob/e71fd1e1a220d9453a954ece00e07875a6b5f7ef/lib/appium_lib/device/device.rb#L402) > 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/af838966d0724793d3dbfa35798ca6dd9f8a3143/lib/appium_lib/device/device.rb#L410) +##### [switch_to_default_context](https://github.com/appium/ruby_lib/blob/e71fd1e1a220d9453a954ece00e07875a6b5f7ef/lib/appium_lib/device/device.rb#L410) > 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/af838966d0724793d3dbfa35798ca6dd9f8a3143/lib/appium_lib/device/multi_touch.rb#L28) +##### [pinch](https://github.com/appium/ruby_lib/blob/e71fd1e1a220d9453a954ece00e07875a6b5f7ef/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/af838966d0724793d3dbfa35798ca6dd9f8a3143/lib/appium_lib/device/multi_touch.rb#L56) +##### [zoom](https://github.com/appium/ruby_lib/blob/e71fd1e1a220d9453a954ece00e07875a6b5f7ef/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/af838966d0724793d3dbfa35798ca6dd9f8a3143/lib/appium_lib/device/multi_touch.rb#L77) +##### [initialize](https://github.com/appium/ruby_lib/blob/e71fd1e1a220d9453a954ece00e07875a6b5f7ef/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/af838966d0724793d3dbfa35798ca6dd9f8a3143/lib/appium_lib/device/multi_touch.rb#L83) +##### [add](https://github.com/appium/ruby_lib/blob/e71fd1e1a220d9453a954ece00e07875a6b5f7ef/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/af838966d0724793d3dbfa35798ca6dd9f8a3143/lib/appium_lib/device/multi_touch.rb#L88) +##### [perform](https://github.com/appium/ruby_lib/blob/e71fd1e1a220d9453a954ece00e07875a6b5f7ef/lib/appium_lib/device/multi_touch.rb#L88) > def perform Ask Appium to perform the actions -- -##### [ACTIONS](https://github.com/appium/ruby_lib/blob/af838966d0724793d3dbfa35798ca6dd9f8a3143/lib/appium_lib/device/touch_actions.rb#L11) +##### [ACTIONS](https://github.com/appium/ruby_lib/blob/e71fd1e1a220d9453a954ece00e07875a6b5f7ef/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/af838966d0724793d3dbfa35798ca6dd9f8a3143/lib/appium_lib/device/touch_actions.rb#L12) +##### [COMPLEX_ACTIONS](https://github.com/appium/ruby_lib/blob/e71fd1e1a220d9453a954ece00e07875a6b5f7ef/lib/appium_lib/device/touch_actions.rb#L12) > COMPLEX_ACTIONS = [:swipe] -- -##### [actions](https://github.com/appium/ruby_lib/blob/af838966d0724793d3dbfa35798ca6dd9f8a3143/lib/appium_lib/device/touch_actions.rb#L26) +##### [actions](https://github.com/appium/ruby_lib/blob/e71fd1e1a220d9453a954ece00e07875a6b5f7ef/lib/appium_lib/device/touch_actions.rb#L26) > def actions Returns the value of attribute actions -- -##### [initialize](https://github.com/appium/ruby_lib/blob/af838966d0724793d3dbfa35798ca6dd9f8a3143/lib/appium_lib/device/touch_actions.rb#L28) +##### [initialize](https://github.com/appium/ruby_lib/blob/e71fd1e1a220d9453a954ece00e07875a6b5f7ef/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/af838966d0724793d3dbfa35798ca6dd9f8a3143/lib/appium_lib/device/touch_actions.rb#L36) +##### [move_to](https://github.com/appium/ruby_lib/blob/e71fd1e1a220d9453a954ece00e07875a6b5f7ef/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/af838966d0724793d3dbfa35798ca6dd9f8a3143/lib/appium_lib/device/touch_actions.rb#L46) +##### [long_press](https://github.com/appium/ruby_lib/blob/e71fd1e1a220d9453a954ece00e07875a6b5f7ef/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/af838966d0724793d3dbfa35798ca6dd9f8a3143/lib/appium_lib/device/touch_actions.rb#L58) +##### [press](https://github.com/appium/ruby_lib/blob/e71fd1e1a220d9453a954ece00e07875a6b5f7ef/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/af838966d0724793d3dbfa35798ca6dd9f8a3143/lib/appium_lib/device/touch_actions.rb#L69) +##### [release](https://github.com/appium/ruby_lib/blob/e71fd1e1a220d9453a954ece00e07875a6b5f7ef/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/af838966d0724793d3dbfa35798ca6dd9f8a3143/lib/appium_lib/device/touch_actions.rb#L80) +##### [tap](https://github.com/appium/ruby_lib/blob/e71fd1e1a220d9453a954ece00e07875a6b5f7ef/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/af838966d0724793d3dbfa35798ca6dd9f8a3143/lib/appium_lib/device/touch_actions.rb#L89) +##### [wait](https://github.com/appium/ruby_lib/blob/e71fd1e1a220d9453a954ece00e07875a6b5f7ef/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/af838966d0724793d3dbfa35798ca6dd9f8a3143/lib/appium_lib/device/touch_actions.rb#L103) +##### [swipe](https://github.com/appium/ruby_lib/blob/e71fd1e1a220d9453a954ece00e07875a6b5f7ef/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/af838966d0724793d3dbfa35798ca6dd9f8a3143/lib/appium_lib/device/touch_actions.rb#L118) +##### [perform](https://github.com/appium/ruby_lib/blob/e71fd1e1a220d9453a954ece00e07875a6b5f7ef/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/af838966d0724793d3dbfa35798ca6dd9f8a3143/lib/appium_lib/device/touch_actions.rb#L124) +##### [cancel](https://github.com/appium/ruby_lib/blob/e71fd1e1a220d9453a954ece00e07875a6b5f7ef/lib/appium_lib/device/touch_actions.rb#L124) > def cancel Does nothing, currently. -- -##### [chain_method](https://github.com/appium/ruby_lib/blob/af838966d0724793d3dbfa35798ca6dd9f8a3143/lib/appium_lib/device/touch_actions.rb#L132) +##### [chain_method](https://github.com/appium/ruby_lib/blob/e71fd1e1a220d9453a954ece00e07875a6b5f7ef/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/af838966d0724793d3dbfa35798ca6dd9f8a3143/lib/appium_lib/device/touch_actions.rb#L141) +##### [args_with_ele_ref](https://github.com/appium/ruby_lib/blob/e71fd1e1a220d9453a954ece00e07875a6b5f7ef/lib/appium_lib/device/touch_actions.rb#L141) > def args_with_ele_ref(args) -- -##### [_generic_wait](https://github.com/appium/ruby_lib/blob/af838966d0724793d3dbfa35798ca6dd9f8a3143/lib/appium_lib/common/wait.rb#L9) +##### [_generic_wait](https://github.com/appium/ruby_lib/blob/e71fd1e1a220d9453a954ece00e07875a6b5f7ef/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/af838966d0724793d3dbfa35798ca6dd9f8a3143/lib/appium_lib/common/wait.rb#L54) +##### [_process_wait_opts](https://github.com/appium/ruby_lib/blob/e71fd1e1a220d9453a954ece00e07875a6b5f7ef/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/af838966d0724793d3dbfa35798ca6dd9f8a3143/lib/appium_lib/common/wait.rb#L75) +##### [wait_true](https://github.com/appium/ruby_lib/blob/e71fd1e1a220d9453a954ece00e07875a6b5f7ef/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/af838966d0724793d3dbfa35798ca6dd9f8a3143/lib/appium_lib/common/wait.rb#L93) +##### [wait](https://github.com/appium/ruby_lib/blob/e71fd1e1a220d9453a954ece00e07875a6b5f7ef/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/af838966d0724793d3dbfa35798ca6dd9f8a3143/lib/appium_lib/common/helper.rb#L24) +##### [ignore](https://github.com/appium/ruby_lib/blob/e71fd1e1a220d9453a954ece00e07875a6b5f7ef/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/af838966d0724793d3dbfa35798ca6dd9f8a3143/lib/appium_lib/common/helper.rb#L31) +##### [back](https://github.com/appium/ruby_lib/blob/e71fd1e1a220d9453a954ece00e07875a6b5f7ef/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/af838966d0724793d3dbfa35798ca6dd9f8a3143/lib/appium_lib/common/helper.rb#L36) +##### [session_id](https://github.com/appium/ruby_lib/blob/e71fd1e1a220d9453a954ece00e07875a6b5f7ef/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/af838966d0724793d3dbfa35798ca6dd9f8a3143/lib/appium_lib/common/helper.rb#L44) +##### [xpath](https://github.com/appium/ruby_lib/blob/e71fd1e1a220d9453a954ece00e07875a6b5f7ef/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/af838966d0724793d3dbfa35798ca6dd9f8a3143/lib/appium_lib/common/helper.rb#L52) +##### [xpaths](https://github.com/appium/ruby_lib/blob/e71fd1e1a220d9453a954ece00e07875a6b5f7ef/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/af838966d0724793d3dbfa35798ca6dd9f8a3143/lib/appium_lib/common/helper.rb#L56) +##### [_print_source](https://github.com/appium/ruby_lib/blob/e71fd1e1a220d9453a954ece00e07875a6b5f7ef/lib/appium_lib/common/helper.rb#L56) > def _print_source(source) -- -##### [result](https://github.com/appium/ruby_lib/blob/af838966d0724793d3dbfa35798ca6dd9f8a3143/lib/appium_lib/common/helper.rb#L69) +##### [result](https://github.com/appium/ruby_lib/blob/e71fd1e1a220d9453a954ece00e07875a6b5f7ef/lib/appium_lib/common/helper.rb#L69) > def result Returns the value of attribute result -- -##### [initialize](https://github.com/appium/ruby_lib/blob/af838966d0724793d3dbfa35798ca6dd9f8a3143/lib/appium_lib/common/helper.rb#L71) +##### [initialize](https://github.com/appium/ruby_lib/blob/e71fd1e1a220d9453a954ece00e07875a6b5f7ef/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/af838966d0724793d3dbfa35798ca6dd9f8a3143/lib/appium_lib/common/helper.rb#L75) +##### [reset](https://github.com/appium/ruby_lib/blob/e71fd1e1a220d9453a954ece00e07875a6b5f7ef/lib/appium_lib/common/helper.rb#L75) > def reset -- -##### [start_element](https://github.com/appium/ruby_lib/blob/af838966d0724793d3dbfa35798ca6dd9f8a3143/lib/appium_lib/common/helper.rb#L80) +##### [start_element](https://github.com/appium/ruby_lib/blob/e71fd1e1a220d9453a954ece00e07875a6b5f7ef/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/af838966d0724793d3dbfa35798ca6dd9f8a3143/lib/appium_lib/common/helper.rb#L86) +##### [formatted_result](https://github.com/appium/ruby_lib/blob/e71fd1e1a220d9453a954ece00e07875a6b5f7ef/lib/appium_lib/common/helper.rb#L86) > def formatted_result -- -##### [get_page_class](https://github.com/appium/ruby_lib/blob/af838966d0724793d3dbfa35798ca6dd9f8a3143/lib/appium_lib/common/helper.rb#L97) +##### [get_page_class](https://github.com/appium/ruby_lib/blob/e71fd1e1a220d9453a954ece00e07875a6b5f7ef/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/af838966d0724793d3dbfa35798ca6dd9f8a3143/lib/appium_lib/common/helper.rb#L108) +##### [page_class](https://github.com/appium/ruby_lib/blob/e71fd1e1a220d9453a954ece00e07875a6b5f7ef/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/af838966d0724793d3dbfa35798ca6dd9f8a3143/lib/appium_lib/common/helper.rb#L118) +##### [px_to_window_rel](https://github.com/appium/ruby_lib/blob/e71fd1e1a220d9453a954ece00e07875a6b5f7ef/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/af838966d0724793d3dbfa35798ca6dd9f8a3143/lib/appium_lib/common/helper.rb#L137) +##### [xml_keys](https://github.com/appium/ruby_lib/blob/e71fd1e1a220d9453a954ece00e07875a6b5f7ef/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/af838966d0724793d3dbfa35798ca6dd9f8a3143/lib/appium_lib/common/helper.rb#L145) +##### [xml_values](https://github.com/appium/ruby_lib/blob/e71fd1e1a220d9453a954ece00e07875a6b5f7ef/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/af838966d0724793d3dbfa35798ca6dd9f8a3143/lib/appium_lib/common/helper.rb#L153) +##### [resolve_id](https://github.com/appium/ruby_lib/blob/e71fd1e1a220d9453a954ece00e07875a6b5f7ef/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/af838966d0724793d3dbfa35798ca6dd9f8a3143/lib/appium_lib/common/helper.rb#L159) +##### [filter](https://github.com/appium/ruby_lib/blob/e71fd1e1a220d9453a954ece00e07875a6b5f7ef/lib/appium_lib/common/helper.rb#L159) > def filter Returns the value of attribute filter -- -##### [filter=](https://github.com/appium/ruby_lib/blob/af838966d0724793d3dbfa35798ca6dd9f8a3143/lib/appium_lib/common/helper.rb#L162) +##### [filter=](https://github.com/appium/ruby_lib/blob/e71fd1e1a220d9453a954ece00e07875a6b5f7ef/lib/appium_lib/common/helper.rb#L162) > def filter=(value) convert to string to support symbols -- -##### [initialize](https://github.com/appium/ruby_lib/blob/af838966d0724793d3dbfa35798ca6dd9f8a3143/lib/appium_lib/common/helper.rb#L168) +##### [initialize](https://github.com/appium/ruby_lib/blob/e71fd1e1a220d9453a954ece00e07875a6b5f7ef/lib/appium_lib/common/helper.rb#L168) > def initialize @@ -1378,107 +1378,107 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[HTMLElements] a new instance of HTMLElements -- -##### [reset](https://github.com/appium/ruby_lib/blob/af838966d0724793d3dbfa35798ca6dd9f8a3143/lib/appium_lib/common/helper.rb#L173) +##### [reset](https://github.com/appium/ruby_lib/blob/e71fd1e1a220d9453a954ece00e07875a6b5f7ef/lib/appium_lib/common/helper.rb#L173) > def reset -- -##### [result](https://github.com/appium/ruby_lib/blob/af838966d0724793d3dbfa35798ca6dd9f8a3143/lib/appium_lib/common/helper.rb#L179) +##### [result](https://github.com/appium/ruby_lib/blob/e71fd1e1a220d9453a954ece00e07875a6b5f7ef/lib/appium_lib/common/helper.rb#L179) > def result -- -##### [start_element](https://github.com/appium/ruby_lib/blob/af838966d0724793d3dbfa35798ca6dd9f8a3143/lib/appium_lib/common/helper.rb#L195) +##### [start_element](https://github.com/appium/ruby_lib/blob/e71fd1e1a220d9453a954ece00e07875a6b5f7ef/lib/appium_lib/common/helper.rb#L195) > def start_element(name, attrs = []) -- -##### [end_element](https://github.com/appium/ruby_lib/blob/af838966d0724793d3dbfa35798ca6dd9f8a3143/lib/appium_lib/common/helper.rb#L204) +##### [end_element](https://github.com/appium/ruby_lib/blob/e71fd1e1a220d9453a954ece00e07875a6b5f7ef/lib/appium_lib/common/helper.rb#L204) > def end_element(name) -- -##### [characters](https://github.com/appium/ruby_lib/blob/af838966d0724793d3dbfa35798ca6dd9f8a3143/lib/appium_lib/common/helper.rb#L210) +##### [characters](https://github.com/appium/ruby_lib/blob/e71fd1e1a220d9453a954ece00e07875a6b5f7ef/lib/appium_lib/common/helper.rb#L210) > def characters(chars) -- -##### [_no_such_element](https://github.com/appium/ruby_lib/blob/af838966d0724793d3dbfa35798ca6dd9f8a3143/lib/appium_lib/common/helper.rb#L217) +##### [_no_such_element](https://github.com/appium/ruby_lib/blob/e71fd1e1a220d9453a954ece00e07875a6b5f7ef/lib/appium_lib/common/helper.rb#L217) > def _no_such_element -- -##### [window_size](https://github.com/appium/ruby_lib/blob/af838966d0724793d3dbfa35798ca6dd9f8a3143/lib/appium_lib/common/element/window.rb#L5) +##### [window_size](https://github.com/appium/ruby_lib/blob/e71fd1e1a220d9453a954ece00e07875a6b5f7ef/lib/appium_lib/common/element/window.rb#L5) > def window_size Get the window's size -- -##### [result](https://github.com/appium/ruby_lib/blob/af838966d0724793d3dbfa35798ca6dd9f8a3143/lib/appium_lib/android/helper.rb#L6) android +##### [result](https://github.com/appium/ruby_lib/blob/e71fd1e1a220d9453a954ece00e07875a6b5f7ef/lib/appium_lib/android/helper.rb#L6) android > def result Returns the value of attribute result -- -##### [keys](https://github.com/appium/ruby_lib/blob/af838966d0724793d3dbfa35798ca6dd9f8a3143/lib/appium_lib/android/helper.rb#L6) android +##### [keys](https://github.com/appium/ruby_lib/blob/e71fd1e1a220d9453a954ece00e07875a6b5f7ef/lib/appium_lib/android/helper.rb#L6) android > def keys Returns the value of attribute keys -- -##### [instance](https://github.com/appium/ruby_lib/blob/af838966d0724793d3dbfa35798ca6dd9f8a3143/lib/appium_lib/android/helper.rb#L6) android +##### [instance](https://github.com/appium/ruby_lib/blob/e71fd1e1a220d9453a954ece00e07875a6b5f7ef/lib/appium_lib/android/helper.rb#L6) android > def instance Returns the value of attribute instance -- -##### [filter](https://github.com/appium/ruby_lib/blob/af838966d0724793d3dbfa35798ca6dd9f8a3143/lib/appium_lib/android/helper.rb#L6) android +##### [filter](https://github.com/appium/ruby_lib/blob/e71fd1e1a220d9453a954ece00e07875a6b5f7ef/lib/appium_lib/android/helper.rb#L6) android > def filter Returns the value of attribute filter -- -##### [filter=](https://github.com/appium/ruby_lib/blob/af838966d0724793d3dbfa35798ca6dd9f8a3143/lib/appium_lib/android/helper.rb#L9) android +##### [filter=](https://github.com/appium/ruby_lib/blob/e71fd1e1a220d9453a954ece00e07875a6b5f7ef/lib/appium_lib/android/helper.rb#L9) android > def filter=(value) convert to string to support symbols -- -##### [initialize](https://github.com/appium/ruby_lib/blob/af838966d0724793d3dbfa35798ca6dd9f8a3143/lib/appium_lib/android/helper.rb#L15) android +##### [initialize](https://github.com/appium/ruby_lib/blob/e71fd1e1a220d9453a954ece00e07875a6b5f7ef/lib/appium_lib/android/helper.rb#L15) android > def initialize @@ -1486,37 +1486,37 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[AndroidElements] a new instance of AndroidElements -- -##### [reset](https://github.com/appium/ruby_lib/blob/af838966d0724793d3dbfa35798ca6dd9f8a3143/lib/appium_lib/android/helper.rb#L21) android +##### [reset](https://github.com/appium/ruby_lib/blob/e71fd1e1a220d9453a954ece00e07875a6b5f7ef/lib/appium_lib/android/helper.rb#L21) android > def reset -- -##### [start_element](https://github.com/appium/ruby_lib/blob/af838966d0724793d3dbfa35798ca6dd9f8a3143/lib/appium_lib/android/helper.rb#L28) android +##### [start_element](https://github.com/appium/ruby_lib/blob/e71fd1e1a220d9453a954ece00e07875a6b5f7ef/lib/appium_lib/android/helper.rb#L28) android > def start_element(name, attrs = []) http://nokogiri.org/Nokogiri/XML/SAX/Document.html -- -##### [_fix_android_native_source](https://github.com/appium/ruby_lib/blob/af838966d0724793d3dbfa35798ca6dd9f8a3143/lib/appium_lib/android/helper.rb#L88) android +##### [_fix_android_native_source](https://github.com/appium/ruby_lib/blob/e71fd1e1a220d9453a954ece00e07875a6b5f7ef/lib/appium_lib/android/helper.rb#L88) android > def _fix_android_native_source(source) Fix uiautomator's xml dump. https://github.com/appium/appium/issues/2822 https://code.google.com/p/android/issues/detail?id=74143 -- -##### [source](https://github.com/appium/ruby_lib/blob/af838966d0724793d3dbfa35798ca6dd9f8a3143/lib/appium_lib/android/helper.rb#L116) android +##### [source](https://github.com/appium/ruby_lib/blob/e71fd1e1a220d9453a954ece00e07875a6b5f7ef/lib/appium_lib/android/helper.rb#L116) android > def source Prints xml of the current page @@ -1524,11 +1524,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[void] -- -##### [get_android_inspect](https://github.com/appium/ruby_lib/blob/af838966d0724793d3dbfa35798ca6dd9f8a3143/lib/appium_lib/android/helper.rb#L126) android +##### [get_android_inspect](https://github.com/appium/ruby_lib/blob/e71fd1e1a220d9453a954ece00e07875a6b5f7ef/lib/appium_lib/android/helper.rb#L126) android > def get_android_inspect(class_name = false) Android only. Returns a string containing interesting elements. @@ -1543,11 +1543,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[String] -- -##### [page](https://github.com/appium/ruby_lib/blob/af838966d0724793d3dbfa35798ca6dd9f8a3143/lib/appium_lib/android/helper.rb#L152) android +##### [page](https://github.com/appium/ruby_lib/blob/e71fd1e1a220d9453a954ece00e07875a6b5f7ef/lib/appium_lib/android/helper.rb#L152) android > def page(opts = {}) Intended for use with console. Inspects and prints the current page. @@ -1562,21 +1562,21 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[void] -- -##### [current_app](https://github.com/appium/ruby_lib/blob/af838966d0724793d3dbfa35798ca6dd9f8a3143/lib/appium_lib/android/helper.rb#L164) android +##### [current_app](https://github.com/appium/ruby_lib/blob/e71fd1e1a220d9453a954ece00e07875a6b5f7ef/lib/appium_lib/android/helper.rb#L164) android > def current_app example line: "mFocusedApp=AppWindowToken{b1420058 token=Token{b128add0 ActivityRecord{b1264d10 u0 com.example.android.apis/.ApiDemos t23}}}" -- -##### [id](https://github.com/appium/ruby_lib/blob/af838966d0724793d3dbfa35798ca6dd9f8a3143/lib/appium_lib/android/helper.rb#L188) android +##### [id](https://github.com/appium/ruby_lib/blob/e71fd1e1a220d9453a954ece00e07875a6b5f7ef/lib/appium_lib/android/helper.rb#L188) android > def id(id) Find the first matching element by id @@ -1588,11 +1588,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Element] -- -##### [ids](https://github.com/appium/ruby_lib/blob/af838966d0724793d3dbfa35798ca6dd9f8a3143/lib/appium_lib/android/helper.rb#L196) android +##### [ids](https://github.com/appium/ruby_lib/blob/e71fd1e1a220d9453a954ece00e07875a6b5f7ef/lib/appium_lib/android/helper.rb#L196) android > def ids(id) Find all matching elements by id @@ -1604,11 +1604,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Element] -- -##### [ele_index](https://github.com/appium/ruby_lib/blob/af838966d0724793d3dbfa35798ca6dd9f8a3143/lib/appium_lib/android/helper.rb#L205) android +##### [ele_index](https://github.com/appium/ruby_lib/blob/e71fd1e1a220d9453a954ece00e07875a6b5f7ef/lib/appium_lib/android/helper.rb#L205) android > def ele_index(class_name, index) Find the element of type class_name at matching index. @@ -1622,11 +1622,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Element] the found element of type class_name -- -##### [first_ele](https://github.com/appium/ruby_lib/blob/af838966d0724793d3dbfa35798ca6dd9f8a3143/lib/appium_lib/android/helper.rb#L223) android +##### [first_ele](https://github.com/appium/ruby_lib/blob/e71fd1e1a220d9453a954ece00e07875a6b5f7ef/lib/appium_lib/android/helper.rb#L223) android > def first_ele(class_name) Find the first element that matches class_name @@ -1638,11 +1638,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Element] -- -##### [last_ele](https://github.com/appium/ruby_lib/blob/af838966d0724793d3dbfa35798ca6dd9f8a3143/lib/appium_lib/android/helper.rb#L230) android +##### [last_ele](https://github.com/appium/ruby_lib/blob/e71fd1e1a220d9453a954ece00e07875a6b5f7ef/lib/appium_lib/android/helper.rb#L230) android > def last_ele(class_name) Find the last element that matches class_name @@ -1654,11 +1654,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Element] -- -##### [tag](https://github.com/appium/ruby_lib/blob/af838966d0724793d3dbfa35798ca6dd9f8a3143/lib/appium_lib/android/helper.rb#L238) android +##### [tag](https://github.com/appium/ruby_lib/blob/e71fd1e1a220d9453a954ece00e07875a6b5f7ef/lib/appium_lib/android/helper.rb#L238) android > def tag(class_name) Find the first element of type class_name @@ -1670,11 +1670,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Element] -- -##### [tags](https://github.com/appium/ruby_lib/blob/af838966d0724793d3dbfa35798ca6dd9f8a3143/lib/appium_lib/android/helper.rb#L246) android +##### [tags](https://github.com/appium/ruby_lib/blob/e71fd1e1a220d9453a954ece00e07875a6b5f7ef/lib/appium_lib/android/helper.rb#L246) android > def tags(class_name) Find all elements of type class_name @@ -1686,11 +1686,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Element] -- -##### [string_visible_contains](https://github.com/appium/ruby_lib/blob/af838966d0724793d3dbfa35798ca6dd9f8a3143/lib/appium_lib/android/helper.rb#L288) android +##### [string_visible_contains](https://github.com/appium/ruby_lib/blob/e71fd1e1a220d9453a954ece00e07875a6b5f7ef/lib/appium_lib/android/helper.rb#L288) android > def string_visible_contains(class_name, value) Returns a string that matches the first element that contains value @@ -1706,11 +1706,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[String] -- -##### [complex_find_contains](https://github.com/appium/ruby_lib/blob/af838966d0724793d3dbfa35798ca6dd9f8a3143/lib/appium_lib/android/helper.rb#L308) android +##### [complex_find_contains](https://github.com/appium/ruby_lib/blob/e71fd1e1a220d9453a954ece00e07875a6b5f7ef/lib/appium_lib/android/helper.rb#L308) android > def complex_find_contains(element, value) Find the first element that contains value @@ -1724,11 +1724,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Element] -- -##### [complex_finds_contains](https://github.com/appium/ruby_lib/blob/af838966d0724793d3dbfa35798ca6dd9f8a3143/lib/appium_lib/android/helper.rb#L316) android +##### [complex_finds_contains](https://github.com/appium/ruby_lib/blob/e71fd1e1a220d9453a954ece00e07875a6b5f7ef/lib/appium_lib/android/helper.rb#L316) android > def complex_finds_contains(element, value) Find all elements containing value @@ -1742,11 +1742,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Array<Element>] -- -##### [complex_find_exact](https://github.com/appium/ruby_lib/blob/af838966d0724793d3dbfa35798ca6dd9f8a3143/lib/appium_lib/android/helper.rb#L345) android +##### [complex_find_exact](https://github.com/appium/ruby_lib/blob/e71fd1e1a220d9453a954ece00e07875a6b5f7ef/lib/appium_lib/android/helper.rb#L345) android > def complex_find_exact(class_name, value) Find the first element exactly matching value @@ -1760,11 +1760,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Element] -- -##### [complex_finds_exact](https://github.com/appium/ruby_lib/blob/af838966d0724793d3dbfa35798ca6dd9f8a3143/lib/appium_lib/android/helper.rb#L353) android +##### [complex_finds_exact](https://github.com/appium/ruby_lib/blob/e71fd1e1a220d9453a954ece00e07875a6b5f7ef/lib/appium_lib/android/helper.rb#L353) android > def complex_finds_exact(class_name, value) Find all elements exactly matching value @@ -1778,11 +1778,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Element] -- -##### [get_source](https://github.com/appium/ruby_lib/blob/af838966d0724793d3dbfa35798ca6dd9f8a3143/lib/appium_lib/android/helper.rb#L361) android +##### [get_source](https://github.com/appium/ruby_lib/blob/e71fd1e1a220d9453a954ece00e07875a6b5f7ef/lib/appium_lib/android/helper.rb#L361) android > def get_source Returns XML string for the current page Fixes uiautomator's $ in node names. @@ -1792,19 +1792,19 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[String] -- -##### [TextView](https://github.com/appium/ruby_lib/blob/af838966d0724793d3dbfa35798ca6dd9f8a3143/lib/appium_lib/android/element/text.rb#L4) android +##### [TextView](https://github.com/appium/ruby_lib/blob/e71fd1e1a220d9453a954ece00e07875a6b5f7ef/lib/appium_lib/android/element/text.rb#L4) android > TextView = 'android.widget.TextView' -- -##### [text](https://github.com/appium/ruby_lib/blob/af838966d0724793d3dbfa35798ca6dd9f8a3143/lib/appium_lib/android/element/text.rb#L10) android +##### [text](https://github.com/appium/ruby_lib/blob/e71fd1e1a220d9453a954ece00e07875a6b5f7ef/lib/appium_lib/android/element/text.rb#L10) android > def text(value) Find the first TextView that contains value or by index. If int then the TextView at that index is returned. @@ -1817,11 +1817,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[TextView] -- -##### [texts](https://github.com/appium/ruby_lib/blob/af838966d0724793d3dbfa35798ca6dd9f8a3143/lib/appium_lib/android/element/text.rb#L19) android +##### [texts](https://github.com/appium/ruby_lib/blob/e71fd1e1a220d9453a954ece00e07875a6b5f7ef/lib/appium_lib/android/element/text.rb#L19) android > def texts(value = false) Find all TextViews containing value. If value is omitted, all texts are returned. @@ -1834,11 +1834,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Array<TextView>] -- -##### [first_text](https://github.com/appium/ruby_lib/blob/af838966d0724793d3dbfa35798ca6dd9f8a3143/lib/appium_lib/android/element/text.rb#L26) android +##### [first_text](https://github.com/appium/ruby_lib/blob/e71fd1e1a220d9453a954ece00e07875a6b5f7ef/lib/appium_lib/android/element/text.rb#L26) android > def first_text Find the first TextView. @@ -1846,11 +1846,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[TextView] -- -##### [last_text](https://github.com/appium/ruby_lib/blob/af838966d0724793d3dbfa35798ca6dd9f8a3143/lib/appium_lib/android/element/text.rb#L32) android +##### [last_text](https://github.com/appium/ruby_lib/blob/e71fd1e1a220d9453a954ece00e07875a6b5f7ef/lib/appium_lib/android/element/text.rb#L32) android > def last_text Find the last TextView. @@ -1858,11 +1858,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[TextView] -- -##### [text_exact](https://github.com/appium/ruby_lib/blob/af838966d0724793d3dbfa35798ca6dd9f8a3143/lib/appium_lib/android/element/text.rb#L39) android +##### [text_exact](https://github.com/appium/ruby_lib/blob/e71fd1e1a220d9453a954ece00e07875a6b5f7ef/lib/appium_lib/android/element/text.rb#L39) android > def text_exact(value) Find the first TextView that exactly matches value. @@ -1874,11 +1874,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[TextView] -- -##### [texts_exact](https://github.com/appium/ruby_lib/blob/af838966d0724793d3dbfa35798ca6dd9f8a3143/lib/appium_lib/android/element/text.rb#L46) android +##### [texts_exact](https://github.com/appium/ruby_lib/blob/e71fd1e1a220d9453a954ece00e07875a6b5f7ef/lib/appium_lib/android/element/text.rb#L46) android > def texts_exact(value) Find all TextViews that exactly match value. @@ -1890,43 +1890,43 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Array<TextView>] -- -##### [_nodeset_to_uiselector](https://github.com/appium/ruby_lib/blob/af838966d0724793d3dbfa35798ca6dd9f8a3143/lib/appium_lib/android/client_xpath.rb#L5) android +##### [_nodeset_to_uiselector](https://github.com/appium/ruby_lib/blob/e71fd1e1a220d9453a954ece00e07875a6b5f7ef/lib/appium_lib/android/client_xpath.rb#L5) android > def _nodeset_to_uiselector(opts = {}) -- -##### [_client_xpath](https://github.com/appium/ruby_lib/blob/af838966d0724793d3dbfa35798ca6dd9f8a3143/lib/appium_lib/android/client_xpath.rb#L20) android +##### [_client_xpath](https://github.com/appium/ruby_lib/blob/e71fd1e1a220d9453a954ece00e07875a6b5f7ef/lib/appium_lib/android/client_xpath.rb#L20) android > def _client_xpath(opts = {}) -- -##### [client_xpath](https://github.com/appium/ruby_lib/blob/af838966d0724793d3dbfa35798ca6dd9f8a3143/lib/appium_lib/android/client_xpath.rb#L36) android +##### [client_xpath](https://github.com/appium/ruby_lib/blob/e71fd1e1a220d9453a954ece00e07875a6b5f7ef/lib/appium_lib/android/client_xpath.rb#L36) android > def client_xpath(xpath) -- -##### [client_xpaths](https://github.com/appium/ruby_lib/blob/af838966d0724793d3dbfa35798ca6dd9f8a3143/lib/appium_lib/android/client_xpath.rb#L40) android +##### [client_xpaths](https://github.com/appium/ruby_lib/blob/e71fd1e1a220d9453a954ece00e07875a6b5f7ef/lib/appium_lib/android/client_xpath.rb#L40) android > def client_xpaths(xpath) -- -##### [alert_click](https://github.com/appium/ruby_lib/blob/af838966d0724793d3dbfa35798ca6dd9f8a3143/lib/appium_lib/android/element/alert.rb#L6) android +##### [alert_click](https://github.com/appium/ruby_lib/blob/e71fd1e1a220d9453a954ece00e07875a6b5f7ef/lib/appium_lib/android/element/alert.rb#L6) android > def alert_click(value) Click the first alert button that contains value or by index. @@ -1938,11 +1938,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[void] -- -##### [alert_accept](https://github.com/appium/ruby_lib/blob/af838966d0724793d3dbfa35798ca6dd9f8a3143/lib/appium_lib/android/element/alert.rb#L13) android +##### [alert_accept](https://github.com/appium/ruby_lib/blob/e71fd1e1a220d9453a954ece00e07875a6b5f7ef/lib/appium_lib/android/element/alert.rb#L13) android > def alert_accept Accept the alert. The last button is considered "accept." @@ -1951,11 +1951,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[void] -- -##### [alert_accept_text](https://github.com/appium/ruby_lib/blob/af838966d0724793d3dbfa35798ca6dd9f8a3143/lib/appium_lib/android/element/alert.rb#L20) android +##### [alert_accept_text](https://github.com/appium/ruby_lib/blob/e71fd1e1a220d9453a954ece00e07875a6b5f7ef/lib/appium_lib/android/element/alert.rb#L20) android > def alert_accept_text Get the text of the alert's accept button. The last button is considered "accept." @@ -1964,11 +1964,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[String] -- -##### [alert_dismiss](https://github.com/appium/ruby_lib/blob/af838966d0724793d3dbfa35798ca6dd9f8a3143/lib/appium_lib/android/element/alert.rb#L27) android +##### [alert_dismiss](https://github.com/appium/ruby_lib/blob/e71fd1e1a220d9453a954ece00e07875a6b5f7ef/lib/appium_lib/android/element/alert.rb#L27) android > def alert_dismiss Dismiss the alert. The first button is considered "dismiss." @@ -1977,11 +1977,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[void] -- -##### [alert_dismiss_text](https://github.com/appium/ruby_lib/blob/af838966d0724793d3dbfa35798ca6dd9f8a3143/lib/appium_lib/android/element/alert.rb#L34) android +##### [alert_dismiss_text](https://github.com/appium/ruby_lib/blob/e71fd1e1a220d9453a954ece00e07875a6b5f7ef/lib/appium_lib/android/element/alert.rb#L34) android > def alert_dismiss_text Get the text of the alert's dismiss button. The first button is considered "dismiss." @@ -1990,11 +1990,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[String] -- -##### [uiautomator_find](https://github.com/appium/ruby_lib/blob/af838966d0724793d3dbfa35798ca6dd9f8a3143/lib/appium_lib/android/mobile_methods.rb#L10) android +##### [uiautomator_find](https://github.com/appium/ruby_lib/blob/e71fd1e1a220d9453a954ece00e07875a6b5f7ef/lib/appium_lib/android/mobile_methods.rb#L10) android > def uiautomator_find find_element/s can be used with a [UISelector](http://developer.android.com/tools/help/uiautomator/UiSelector.html). @@ -2002,27 +2002,27 @@ find_elements :uiautomator, 'new UiSelector().clickable(true)' ``` -- -##### [Button](https://github.com/appium/ruby_lib/blob/af838966d0724793d3dbfa35798ca6dd9f8a3143/lib/appium_lib/android/element/button.rb#L4) android +##### [Button](https://github.com/appium/ruby_lib/blob/e71fd1e1a220d9453a954ece00e07875a6b5f7ef/lib/appium_lib/android/element/button.rb#L4) android > Button = 'android.widget.Button' -- -##### [ImageButton](https://github.com/appium/ruby_lib/blob/af838966d0724793d3dbfa35798ca6dd9f8a3143/lib/appium_lib/android/element/button.rb#L5) android +##### [ImageButton](https://github.com/appium/ruby_lib/blob/e71fd1e1a220d9453a954ece00e07875a6b5f7ef/lib/appium_lib/android/element/button.rb#L5) android > ImageButton = 'android.widget.ImageButton' -- -##### [button](https://github.com/appium/ruby_lib/blob/af838966d0724793d3dbfa35798ca6dd9f8a3143/lib/appium_lib/android/element/button.rb#L43) android +##### [button](https://github.com/appium/ruby_lib/blob/e71fd1e1a220d9453a954ece00e07875a6b5f7ef/lib/appium_lib/android/element/button.rb#L43) android > def button(value) Find the first button that contains value or by index. If int then the button at that index is returned. @@ -2035,11 +2035,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Button] -- -##### [buttons](https://github.com/appium/ruby_lib/blob/af838966d0724793d3dbfa35798ca6dd9f8a3143/lib/appium_lib/android/element/button.rb#L60) android +##### [buttons](https://github.com/appium/ruby_lib/blob/e71fd1e1a220d9453a954ece00e07875a6b5f7ef/lib/appium_lib/android/element/button.rb#L60) android > def buttons(value = false) Find all buttons containing value. If value is omitted, all buttons are returned. @@ -2052,11 +2052,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Array<Button>] -- -##### [first_button](https://github.com/appium/ruby_lib/blob/af838966d0724793d3dbfa35798ca6dd9f8a3143/lib/appium_lib/android/element/button.rb#L67) android +##### [first_button](https://github.com/appium/ruby_lib/blob/e71fd1e1a220d9453a954ece00e07875a6b5f7ef/lib/appium_lib/android/element/button.rb#L67) android > def first_button Find the first button. @@ -2064,11 +2064,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Button] -- -##### [last_button](https://github.com/appium/ruby_lib/blob/af838966d0724793d3dbfa35798ca6dd9f8a3143/lib/appium_lib/android/element/button.rb#L73) android +##### [last_button](https://github.com/appium/ruby_lib/blob/e71fd1e1a220d9453a954ece00e07875a6b5f7ef/lib/appium_lib/android/element/button.rb#L73) android > def last_button Find the last button. @@ -2076,11 +2076,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Button] -- -##### [button_exact](https://github.com/appium/ruby_lib/blob/af838966d0724793d3dbfa35798ca6dd9f8a3143/lib/appium_lib/android/element/button.rb#L89) android +##### [button_exact](https://github.com/appium/ruby_lib/blob/e71fd1e1a220d9453a954ece00e07875a6b5f7ef/lib/appium_lib/android/element/button.rb#L89) android > def button_exact(value) Find the first button that exactly matches value. @@ -2092,11 +2092,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Button] -- -##### [buttons_exact](https://github.com/appium/ruby_lib/blob/af838966d0724793d3dbfa35798ca6dd9f8a3143/lib/appium_lib/android/element/button.rb#L96) android +##### [buttons_exact](https://github.com/appium/ruby_lib/blob/e71fd1e1a220d9453a954ece00e07875a6b5f7ef/lib/appium_lib/android/element/button.rb#L96) android > def buttons_exact(value) Find all buttons that exactly match value. @@ -2108,11 +2108,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Array<Button>] -- -##### [find](https://github.com/appium/ruby_lib/blob/af838966d0724793d3dbfa35798ca6dd9f8a3143/lib/appium_lib/android/element/generic.rb#L6) android +##### [find](https://github.com/appium/ruby_lib/blob/e71fd1e1a220d9453a954ece00e07875a6b5f7ef/lib/appium_lib/android/element/generic.rb#L6) android > def find(value) Find the first element containing value @@ -2124,11 +2124,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Element] -- -##### [finds](https://github.com/appium/ruby_lib/blob/af838966d0724793d3dbfa35798ca6dd9f8a3143/lib/appium_lib/android/element/generic.rb#L13) android +##### [finds](https://github.com/appium/ruby_lib/blob/e71fd1e1a220d9453a954ece00e07875a6b5f7ef/lib/appium_lib/android/element/generic.rb#L13) android > def finds(value) Find all elements containing value @@ -2140,11 +2140,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Array<Element>] -- -##### [find_exact](https://github.com/appium/ruby_lib/blob/af838966d0724793d3dbfa35798ca6dd9f8a3143/lib/appium_lib/android/element/generic.rb#L20) android +##### [find_exact](https://github.com/appium/ruby_lib/blob/e71fd1e1a220d9453a954ece00e07875a6b5f7ef/lib/appium_lib/android/element/generic.rb#L20) android > def find_exact(value) Find the first element exactly matching value @@ -2156,11 +2156,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Element] -- -##### [finds_exact](https://github.com/appium/ruby_lib/blob/af838966d0724793d3dbfa35798ca6dd9f8a3143/lib/appium_lib/android/element/generic.rb#L27) android +##### [finds_exact](https://github.com/appium/ruby_lib/blob/e71fd1e1a220d9453a954ece00e07875a6b5f7ef/lib/appium_lib/android/element/generic.rb#L27) android > def finds_exact(value) Find all elements exactly matching value @@ -2172,11 +2172,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Array<Element>] -- -##### [scroll_to](https://github.com/appium/ruby_lib/blob/af838966d0724793d3dbfa35798ca6dd9f8a3143/lib/appium_lib/android/element/generic.rb#L39) android +##### [scroll_to](https://github.com/appium/ruby_lib/blob/e71fd1e1a220d9453a954ece00e07875a6b5f7ef/lib/appium_lib/android/element/generic.rb#L39) android > def scroll_to(text) Scroll to the first element containing target text or description. @@ -2188,11 +2188,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Element] the element scrolled to -- -##### [scroll_to_exact](https://github.com/appium/ruby_lib/blob/af838966d0724793d3dbfa35798ca6dd9f8a3143/lib/appium_lib/android/element/generic.rb#L51) android +##### [scroll_to_exact](https://github.com/appium/ruby_lib/blob/e71fd1e1a220d9453a954ece00e07875a6b5f7ef/lib/appium_lib/android/element/generic.rb#L51) android > def scroll_to_exact(text) Scroll to the first element with the exact target text or description. @@ -2204,19 +2204,19 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Element] the element scrolled to -- -##### [EditText](https://github.com/appium/ruby_lib/blob/af838966d0724793d3dbfa35798ca6dd9f8a3143/lib/appium_lib/android/element/textfield.rb#L3) android +##### [EditText](https://github.com/appium/ruby_lib/blob/e71fd1e1a220d9453a954ece00e07875a6b5f7ef/lib/appium_lib/android/element/textfield.rb#L3) android > EditText = 'android.widget.EditText' -- -##### [textfield](https://github.com/appium/ruby_lib/blob/af838966d0724793d3dbfa35798ca6dd9f8a3143/lib/appium_lib/android/element/textfield.rb#L9) android +##### [textfield](https://github.com/appium/ruby_lib/blob/e71fd1e1a220d9453a954ece00e07875a6b5f7ef/lib/appium_lib/android/element/textfield.rb#L9) android > def textfield(value) Find the first EditText that contains value or by index. If int then the EditText at that index is returned. @@ -2229,11 +2229,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[EditText] -- -##### [textfields](https://github.com/appium/ruby_lib/blob/af838966d0724793d3dbfa35798ca6dd9f8a3143/lib/appium_lib/android/element/textfield.rb#L18) android +##### [textfields](https://github.com/appium/ruby_lib/blob/e71fd1e1a220d9453a954ece00e07875a6b5f7ef/lib/appium_lib/android/element/textfield.rb#L18) android > def textfields(value = false) Find all EditTexts containing value. If value is omitted, all EditTexts are returned. @@ -2246,11 +2246,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Array<EditText>] -- -##### [first_textfield](https://github.com/appium/ruby_lib/blob/af838966d0724793d3dbfa35798ca6dd9f8a3143/lib/appium_lib/android/element/textfield.rb#L25) android +##### [first_textfield](https://github.com/appium/ruby_lib/blob/e71fd1e1a220d9453a954ece00e07875a6b5f7ef/lib/appium_lib/android/element/textfield.rb#L25) android > def first_textfield Find the first EditText. @@ -2258,11 +2258,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[EditText] -- -##### [last_textfield](https://github.com/appium/ruby_lib/blob/af838966d0724793d3dbfa35798ca6dd9f8a3143/lib/appium_lib/android/element/textfield.rb#L31) android +##### [last_textfield](https://github.com/appium/ruby_lib/blob/e71fd1e1a220d9453a954ece00e07875a6b5f7ef/lib/appium_lib/android/element/textfield.rb#L31) android > def last_textfield Find the last EditText. @@ -2270,11 +2270,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[EditText] -- -##### [textfield_exact](https://github.com/appium/ruby_lib/blob/af838966d0724793d3dbfa35798ca6dd9f8a3143/lib/appium_lib/android/element/textfield.rb#L38) android +##### [textfield_exact](https://github.com/appium/ruby_lib/blob/e71fd1e1a220d9453a954ece00e07875a6b5f7ef/lib/appium_lib/android/element/textfield.rb#L38) android > def textfield_exact(value) Find the first EditText that exactly matches value. @@ -2286,11 +2286,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[EditText] -- -##### [textfields_exact](https://github.com/appium/ruby_lib/blob/af838966d0724793d3dbfa35798ca6dd9f8a3143/lib/appium_lib/android/element/textfield.rb#L45) android +##### [textfields_exact](https://github.com/appium/ruby_lib/blob/e71fd1e1a220d9453a954ece00e07875a6b5f7ef/lib/appium_lib/android/element/textfield.rb#L45) android > def textfields_exact(value) Find all EditTexts that exactly match value. @@ -2302,31 +2302,31 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Array<EditText>] -- -##### [value](https://github.com/appium/ruby_lib/blob/af838966d0724793d3dbfa35798ca6dd9f8a3143/lib/appium_lib/common/patch.rb#L12) +##### [value](https://github.com/appium/ruby_lib/blob/e71fd1e1a220d9453a954ece00e07875a6b5f7ef/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/af838966d0724793d3dbfa35798ca6dd9f8a3143/lib/appium_lib/common/patch.rb#L19) +##### [name](https://github.com/appium/ruby_lib/blob/e71fd1e1a220d9453a954ece00e07875a6b5f7ef/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/af838966d0724793d3dbfa35798ca6dd9f8a3143/lib/appium_lib/common/patch.rb#L31) +##### [location_rel](https://github.com/appium/ruby_lib/blob/e71fd1e1a220d9453a954ece00e07875a6b5f7ef/lib/appium_lib/common/patch.rb#L31) > def location_rel For use with mobile tap. @@ -2340,10 +2340,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/af838966d0724793d3dbfa35798ca6dd9f8a3143/lib/appium_lib/common/patch.rb#L147) +##### [DEFAULT_HEADERS](https://github.com/appium/ruby_lib/blob/e71fd1e1a220d9453a954ece00e07875a6b5f7ef/lib/appium_lib/common/patch.rb#L147) > DEFAULT_HEADERS = { 'Accept' => CONTENT_TYPE, 'User-Agent' => "appium/ruby_lib/#{::Appium::VERSION}" }