docs/android_docs.md in appium_lib-9.1.3 vs docs/android_docs.md in appium_lib-9.2.0

- old
+ new

@@ -1,6 +1,6 @@ -##### [load_settings](https://github.com/appium/ruby_lib/blob/ba2fbdcb206609259134fc09eac7940c21cc2c13/lib/appium_lib/driver.rb#L74) +##### [load_settings](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/driver.rb#L74) > def self.load_settings(opts = {}) Load arbitrary text (toml format) @@ -24,11 +24,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[hash] the symbolized hash with updated :app and :require keys -- -##### [load_appium_txt](https://github.com/appium/ruby_lib/blob/ba2fbdcb206609259134fc09eac7940c21cc2c13/lib/appium_lib/driver.rb#L110) +##### [load_appium_txt](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/driver.rb#L110) > def self.load_settings(opts = {}) Load arbitrary text (toml format) @@ -53,11 +53,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[hash] the symbolized hash with updated :app and :require keys -- -##### [expand_required_files](https://github.com/appium/ruby_lib/blob/ba2fbdcb206609259134fc09eac7940c21cc2c13/lib/appium_lib/driver.rb#L116) +##### [expand_required_files](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/driver.rb#L116) > def self.expand_required_files(base_dir, file_paths) @@ -71,22 +71,22 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Array] list of require files as an array, nil if require doesn't exist -- -##### [symbolize_keys](https://github.com/appium/ruby_lib/blob/ba2fbdcb206609259134fc09eac7940c21cc2c13/lib/appium_lib/driver.rb#L148) +##### [symbolize_keys](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/driver.rb#L148) > def self.symbolize_keys(hash) convert all keys (including nested) to symbols based on deep_symbolize_keys & deep_transform_keys from rails https://github.com/rails/docrails/blob/a3b1105ada3da64acfa3843b164b14b734456a50/activesupport/lib/active_support/core_ext/hash/keys.rb#L84 -- -##### [promote_singleton_appium_methods](https://github.com/appium/ruby_lib/blob/ba2fbdcb206609259134fc09eac7940c21cc2c13/lib/appium_lib/driver.rb#L169) +##### [promote_singleton_appium_methods](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/driver.rb#L169) > def self.promote_singleton_appium_methods(modules) This method is intended to work with page objects that share a common module. For example, Page::HomePage, Page::SignIn @@ -100,11 +100,11 @@ that module are promoted on. otherwise, the array of modules will be used as the promotion target. -- -##### [promote_appium_methods](https://github.com/appium/ruby_lib/blob/ba2fbdcb206609259134fc09eac7940c21cc2c13/lib/appium_lib/driver.rb#L222) +##### [promote_appium_methods](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/driver.rb#L222) > def self.promote_appium_methods(class_array) Promote appium methods to class instance methods @@ -130,85 +130,85 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Array<Class>] class_array - An array of classes -- -##### [init_caps_for_appium](https://github.com/appium/ruby_lib/blob/ba2fbdcb206609259134fc09eac7940c21cc2c13/lib/appium_lib/driver.rb#L254) +##### [init_caps_for_appium](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/driver.rb#L254) > def self.init_caps_for_appium(opts_caps = {}) except for browser_name, default capability is equal to ::Selenium::WebDriver::Remote::Capabilities.firefox Because Selenium::WebDriver::Remote::Bridge uses Capabilities.firefox by default https://github.com/SeleniumHQ/selenium/blob/selenium-3.0.1/rb/lib/selenium/webdriver/remote/bridge.rb#L67 -- -##### [global_webdriver_http_sleep](https://github.com/appium/ruby_lib/blob/ba2fbdcb206609259134fc09eac7940c21cc2c13/lib/appium_lib/driver.rb#L272) +##### [global_webdriver_http_sleep](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/driver.rb#L272) > def global_webdriver_http_sleep The amount to sleep in seconds before every webdriver http call. -- -##### [global_webdriver_http_sleep=](https://github.com/appium/ruby_lib/blob/ba2fbdcb206609259134fc09eac7940c21cc2c13/lib/appium_lib/driver.rb#L272) +##### [global_webdriver_http_sleep=](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/driver.rb#L272) > def global_webdriver_http_sleep=(value) The amount to sleep in seconds before every webdriver http call. -- -##### [caps](https://github.com/appium/ruby_lib/blob/ba2fbdcb206609259134fc09eac7940c21cc2c13/lib/appium_lib/driver.rb#L274) +##### [caps](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/driver.rb#L274) > def caps Selenium webdriver capabilities -- -##### [caps=](https://github.com/appium/ruby_lib/blob/ba2fbdcb206609259134fc09eac7940c21cc2c13/lib/appium_lib/driver.rb#L274) +##### [caps=](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/driver.rb#L274) > def caps=(value) Selenium webdriver capabilities -- -##### [custom_url](https://github.com/appium/ruby_lib/blob/ba2fbdcb206609259134fc09eac7940c21cc2c13/lib/appium_lib/driver.rb#L276) +##### [custom_url](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/driver.rb#L276) > def custom_url Custom URL for the selenium server -- -##### [custom_url=](https://github.com/appium/ruby_lib/blob/ba2fbdcb206609259134fc09eac7940c21cc2c13/lib/appium_lib/driver.rb#L276) +##### [custom_url=](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/driver.rb#L276) > def custom_url=(value) Custom URL for the selenium server -- -##### [export_session](https://github.com/appium/ruby_lib/blob/ba2fbdcb206609259134fc09eac7940c21cc2c13/lib/appium_lib/driver.rb#L278) +##### [export_session](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/driver.rb#L278) > def export_session Export session id to textfile in /tmp for 3rd party tools -- -##### [export_session=](https://github.com/appium/ruby_lib/blob/ba2fbdcb206609259134fc09eac7940c21cc2c13/lib/appium_lib/driver.rb#L278) +##### [export_session=](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/driver.rb#L278) > def export_session=(value) Export session id to textfile in /tmp for 3rd party tools -- -##### [default_wait](https://github.com/appium/ruby_lib/blob/ba2fbdcb206609259134fc09eac7940c21cc2c13/lib/appium_lib/driver.rb#L283) +##### [default_wait](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/driver.rb#L283) > def default_wait Default wait time for elements to appear Returns the default client side wait. @@ -218,113 +218,84 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Integer] -- -##### [default_wait=](https://github.com/appium/ruby_lib/blob/ba2fbdcb206609259134fc09eac7940c21cc2c13/lib/appium_lib/driver.rb#L283) +##### [sauce_username](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/driver.rb#L285) -> def default_wait=(value) - -Default wait time for elements to appear -Returns the default client side wait. -This value is independent of what the server is using - -__Returns:__ - -&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Integer] - --- - -##### [last_waits](https://github.com/appium/ruby_lib/blob/ba2fbdcb206609259134fc09eac7940c21cc2c13/lib/appium_lib/driver.rb#L285) - -> def last_waits - -Array of previous wait time values - --- - -##### [last_waits=](https://github.com/appium/ruby_lib/blob/ba2fbdcb206609259134fc09eac7940c21cc2c13/lib/appium_lib/driver.rb#L285) - -> def last_waits=(value) - -Array of previous wait time values - --- - -##### [sauce_username](https://github.com/appium/ruby_lib/blob/ba2fbdcb206609259134fc09eac7940c21cc2c13/lib/appium_lib/driver.rb#L287) - > def sauce_username Username for use on Sauce Labs -- -##### [sauce_username=](https://github.com/appium/ruby_lib/blob/ba2fbdcb206609259134fc09eac7940c21cc2c13/lib/appium_lib/driver.rb#L287) +##### [sauce_username=](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/driver.rb#L285) > def sauce_username=(value) Username for use on Sauce Labs -- -##### [sauce_access_key](https://github.com/appium/ruby_lib/blob/ba2fbdcb206609259134fc09eac7940c21cc2c13/lib/appium_lib/driver.rb#L289) +##### [sauce_access_key](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/driver.rb#L287) > def sauce_access_key Access Key for use on Sauce Labs -- -##### [sauce_access_key=](https://github.com/appium/ruby_lib/blob/ba2fbdcb206609259134fc09eac7940c21cc2c13/lib/appium_lib/driver.rb#L289) +##### [sauce_access_key=](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/driver.rb#L287) > def sauce_access_key=(value) Access Key for use on Sauce Labs -- -##### [appium_port](https://github.com/appium/ruby_lib/blob/ba2fbdcb206609259134fc09eac7940c21cc2c13/lib/appium_lib/driver.rb#L291) +##### [appium_port](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/driver.rb#L289) > def appium_port Appium's server port -- -##### [appium_port=](https://github.com/appium/ruby_lib/blob/ba2fbdcb206609259134fc09eac7940c21cc2c13/lib/appium_lib/driver.rb#L291) +##### [appium_port=](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/driver.rb#L289) > def appium_port=(value) Appium's server port -- -##### [appium_device](https://github.com/appium/ruby_lib/blob/ba2fbdcb206609259134fc09eac7940c21cc2c13/lib/appium_lib/driver.rb#L293) +##### [appium_device](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/driver.rb#L291) > def appium_device Device type to request from the appium server -- -##### [appium_device=](https://github.com/appium/ruby_lib/blob/ba2fbdcb206609259134fc09eac7940c21cc2c13/lib/appium_lib/driver.rb#L293) +##### [appium_device=](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/driver.rb#L291) > def appium_device=(value) Device type to request from the appium server -- -##### [automation_name](https://github.com/appium/ruby_lib/blob/ba2fbdcb206609259134fc09eac7940c21cc2c13/lib/appium_lib/driver.rb#L295) +##### [automation_name](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/driver.rb#L294) > def automation_name -Automation name sent to appium server +Automation name sent to appium server or received from server +If automation_name is nil, it is not set both client side and server side. -- -##### [appium_server_version](https://github.com/appium/ruby_lib/blob/ba2fbdcb206609259134fc09eac7940c21cc2c13/lib/appium_lib/driver.rb#L297) +##### [appium_server_version](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/driver.rb#L296) > def appium_server_version Returns the server's version info @@ -341,43 +312,43 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Hash] -- -##### [appium_debug](https://github.com/appium/ruby_lib/blob/ba2fbdcb206609259134fc09eac7940c21cc2c13/lib/appium_lib/driver.rb#L299) +##### [appium_debug](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/driver.rb#L298) > def appium_debug Boolean debug mode for the Appium Ruby bindings -- -##### [appium_debug=](https://github.com/appium/ruby_lib/blob/ba2fbdcb206609259134fc09eac7940c21cc2c13/lib/appium_lib/driver.rb#L299) +##### [appium_debug=](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/driver.rb#L298) > def appium_debug=(value) Boolean debug mode for the Appium Ruby bindings -- -##### [listener](https://github.com/appium/ruby_lib/blob/ba2fbdcb206609259134fc09eac7940c21cc2c13/lib/appium_lib/driver.rb#L301) +##### [listener](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/driver.rb#L300) > def listener instance of AbstractEventListener for logging support -- -##### [listener=](https://github.com/appium/ruby_lib/blob/ba2fbdcb206609259134fc09eac7940c21cc2c13/lib/appium_lib/driver.rb#L301) +##### [listener=](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/driver.rb#L300) > def listener=(value) instance of AbstractEventListener for logging support -- -##### [driver](https://github.com/appium/ruby_lib/blob/ba2fbdcb206609259134fc09eac7940c21cc2c13/lib/appium_lib/driver.rb#L304) +##### [driver](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/driver.rb#L303) > def driver Returns the driver @@ -385,11 +356,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Driver] the driver -- -##### [http_client](https://github.com/appium/ruby_lib/blob/ba2fbdcb206609259134fc09eac7940c21cc2c13/lib/appium_lib/driver.rb#L307) +##### [http_client](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/driver.rb#L306) > def http_client Return http client called in start_driver() @@ -397,11 +368,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Selenium::WebDriver::Remote::Http::Default] the http client -- -##### [initialize](https://github.com/appium/ruby_lib/blob/ba2fbdcb206609259134fc09eac7940c21cc2c13/lib/appium_lib/driver.rb#L328) +##### [initialize](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/driver.rb#L327) > def initialize(opts = {}) Creates a new driver @@ -428,19 +399,19 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Driver] -- -##### [driver_attributes](https://github.com/appium/ruby_lib/blob/ba2fbdcb206609259134fc09eac7940c21cc2c13/lib/appium_lib/driver.rb#L401) +##### [driver_attributes](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/driver.rb#L399) > def driver_attributes Returns a hash of the driver attributes -- -##### [device_is_android?](https://github.com/appium/ruby_lib/blob/ba2fbdcb206609259134fc09eac7940c21cc2c13/lib/appium_lib/driver.rb#L423) +##### [device_is_android?](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/driver.rb#L421) > def device_is_android? @@ -448,11 +419,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Boolean] -- -##### [automation_name_is_xcuitest?](https://github.com/appium/ruby_lib/blob/ba2fbdcb206609259134fc09eac7940c21cc2c13/lib/appium_lib/driver.rb#L429) +##### [automation_name_is_xcuitest?](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/driver.rb#L427) > def automation_name_is_xcuitest? Return true if automationName is 'XCUITest' @@ -460,11 +431,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Boolean] -- -##### [check_server_version_xcuitest](https://github.com/appium/ruby_lib/blob/ba2fbdcb206609259134fc09eac7940c21cc2c13/lib/appium_lib/driver.rb#L436) +##### [check_server_version_xcuitest](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/driver.rb#L434) > def check_server_version_xcuitest Return true if the target Appium server is over REQUIRED_VERSION_XCUITEST. If the Appium server is under REQUIRED_VERSION_XCUITEST, then error is raised. @@ -473,11 +444,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Boolean] -- -##### [appium_client_version](https://github.com/appium/ruby_lib/blob/ba2fbdcb206609259134fc09eac7940c21cc2c13/lib/appium_lib/driver.rb#L468) +##### [appium_client_version](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/driver.rb#L466) > def appium_client_version Returns the client's version info @@ -491,11 +462,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Hash] -- -##### [absolute_app_path](https://github.com/appium/ruby_lib/blob/ba2fbdcb206609259134fc09eac7940c21cc2c13/lib/appium_lib/driver.rb#L480) +##### [absolute_app_path](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/driver.rb#L478) > def self.absolute_app_path(opts) Converts app_path to an absolute path. @@ -508,11 +479,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[String] APP_PATH as an absolute path -- -##### [server_url](https://github.com/appium/ruby_lib/blob/ba2fbdcb206609259134fc09eac7940c21cc2c13/lib/appium_lib/driver.rb#L513) +##### [server_url](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/driver.rb#L511) > def server_url Get the server url @@ -520,11 +491,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[String] the server url -- -##### [restart](https://github.com/appium/ruby_lib/blob/ba2fbdcb206609259134fc09eac7940c21cc2c13/lib/appium_lib/driver.rb#L524) +##### [restart](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/driver.rb#L522) > def restart Restarts the driver @@ -532,11 +503,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Driver] the driver -- -##### [screenshot](https://github.com/appium/ruby_lib/blob/ba2fbdcb206609259134fc09eac7940c21cc2c13/lib/appium_lib/driver.rb#L535) +##### [screenshot](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/driver.rb#L533) > def screenshot(png_save_path) Takes a png screenshot and saves to the target path. @@ -550,11 +521,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[nil] -- -##### [driver_quit](https://github.com/appium/ruby_lib/blob/ba2fbdcb206609259134fc09eac7940c21cc2c13/lib/appium_lib/driver.rb#L542) +##### [driver_quit](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/driver.rb#L540) > def driver_quit Quits the driver @@ -562,11 +533,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[void] -- -##### [start_driver](https://github.com/appium/ruby_lib/blob/ba2fbdcb206609259134fc09eac7940c21cc2c13/lib/appium_lib/driver.rb#L552) +##### [start_driver](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/driver.rb#L550) > def start_driver Creates a new global driver and quits the old one if it exists. @@ -574,30 +545,27 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Selenium::WebDriver] the new global driver -- -##### [no_wait](https://github.com/appium/ruby_lib/blob/ba2fbdcb206609259134fc09eac7940c21cc2c13/lib/appium_lib/driver.rb#L588) +##### [no_wait](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/driver.rb#L588) > def no_wait -Set implicit wait and default_wait to zero. +Set implicit wait to zero. -- -##### [set_wait](https://github.com/appium/ruby_lib/blob/ba2fbdcb206609259134fc09eac7940c21cc2c13/lib/appium_lib/driver.rb#L607) +##### [set_wait](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/driver.rb#L602) > 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 -wait will be used. +Set implicit wait. Default to @default_wait. ```ruby` set_wait 2 -set_wait 3 -set_wait # 2 +set_wait # @default_wait ```` __Parameters:__ @@ -607,11 +575,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[void] -- -##### [exists](https://github.com/appium/ruby_lib/blob/ba2fbdcb206609259134fc09eac7940c21cc2c13/lib/appium_lib/driver.rb#L634) +##### [exists](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/driver.rb#L619) > def exists(pre_check = 0, post_check = @default_wait) Returns existence of element. @@ -633,11 +601,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Boolean] -- -##### [execute_script](https://github.com/appium/ruby_lib/blob/ba2fbdcb206609259134fc09eac7940c21cc2c13/lib/appium_lib/driver.rb#L658) +##### [execute_script](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/driver.rb#L643) > def execute_script(script, *args) The same as @driver.execute_script @@ -651,11 +619,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Object] -- -##### [find_elements](https://github.com/appium/ruby_lib/blob/ba2fbdcb206609259134fc09eac7940c21cc2c13/lib/appium_lib/driver.rb#L666) +##### [find_elements](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/driver.rb#L651) > def find_elements(*args) Calls @driver.find_elements @@ -667,11 +635,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/ba2fbdcb206609259134fc09eac7940c21cc2c13/lib/appium_lib/driver.rb#L674) +##### [find_element](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/driver.rb#L659) > def find_element(*args) Calls @driver.find_elements @@ -683,11 +651,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Element] -- -##### [set_location](https://github.com/appium/ruby_lib/blob/ba2fbdcb206609259134fc09eac7940c21cc2c13/lib/appium_lib/driver.rb#L687) +##### [set_location](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/driver.rb#L672) > def set_location(opts = {}) Calls @driver.set_location @@ -699,11 +667,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Selenium::WebDriver::Location] the location constructed by the selenium webdriver -- -##### [x](https://github.com/appium/ruby_lib/blob/ba2fbdcb206609259134fc09eac7940c21cc2c13/lib/appium_lib/driver.rb#L697) +##### [x](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/driver.rb#L682) > def x Quit the driver and Pry. quit and exit are reserved by Pry. @@ -712,99 +680,108 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[void] -- -##### [logger=](https://github.com/appium/ruby_lib/blob/ba2fbdcb206609259134fc09eac7940c21cc2c13/lib/appium_lib/logger.rb#L13) +##### [set_automation_name_if_nil](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/driver.rb#L691) +> def set_automation_name_if_nil + +If "automationName" is set only server side, this method set "automationName" attribute into @automation_name. +Since @automation_name is set only client side before start_driver is called. + +-- + +##### [logger=](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/logger.rb#L13) + > def logger=(value) Sets the attribute logger __Parameters:__ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;value - the value to set the attribute logger to. -- -##### [logger](https://github.com/appium/ruby_lib/blob/ba2fbdcb206609259134fc09eac7940c21cc2c13/lib/appium_lib/logger.rb#L17) +##### [logger](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/logger.rb#L17) > def logger -- -##### [app_strings](https://github.com/appium/ruby_lib/blob/ba2fbdcb206609259134fc09eac7940c21cc2c13/lib/appium_lib/device/device.rb#L7) +##### [app_strings](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/device/device.rb#L7) > def app_strings Return the hash of all localization strings. ```ruby app_strings #=> "TransitionsTitle"=>"Transitions", "WebTitle"=>"Web" ``` -- -##### [background_app](https://github.com/appium/ruby_lib/blob/ba2fbdcb206609259134fc09eac7940c21cc2c13/lib/appium_lib/device/device.rb#L13) +##### [background_app](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/device/device.rb#L13) > def background_app Backgrounds the app for a set number of seconds. This is a blocking application -- -##### [current_activity](https://github.com/appium/ruby_lib/blob/ba2fbdcb206609259134fc09eac7940c21cc2c13/lib/appium_lib/device/device.rb#L18) +##### [current_activity](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/device/device.rb#L18) > def current_activity -- -##### [launch_app](https://github.com/appium/ruby_lib/blob/ba2fbdcb206609259134fc09eac7940c21cc2c13/lib/appium_lib/device/device.rb#L20) +##### [launch_app](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/device/device.rb#L20) > def launch_app Start the simulator and application configured with desired capabilities -- -##### [reset](https://github.com/appium/ruby_lib/blob/ba2fbdcb206609259134fc09eac7940c21cc2c13/lib/appium_lib/device/device.rb#L23) +##### [reset](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/device/device.rb#L23) > def reset Reset the device, relaunching the application. -- -##### [shake](https://github.com/appium/ruby_lib/blob/ba2fbdcb206609259134fc09eac7940c21cc2c13/lib/appium_lib/device/device.rb#L26) +##### [shake](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/device/device.rb#L26) > def shake Cause the device to shake -- -##### [toggle_flight_mode](https://github.com/appium/ruby_lib/blob/ba2fbdcb206609259134fc09eac7940c21cc2c13/lib/appium_lib/device/device.rb#L29) +##### [toggle_flight_mode](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/device/device.rb#L29) > def toggle_flight_mode Toggle flight mode on or off -- -##### [device_locked?](https://github.com/appium/ruby_lib/blob/ba2fbdcb206609259134fc09eac7940c21cc2c13/lib/appium_lib/device/device.rb#L32) +##### [device_locked?](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/device/device.rb#L32) > def device_locked? -- -##### [hide_keyboard](https://github.com/appium/ruby_lib/blob/ba2fbdcb206609259134fc09eac7940c21cc2c13/lib/appium_lib/device/device.rb#L34) +##### [hide_keyboard](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/device/device.rb#L34) > def hide_keyboard Hide the onscreen keyboard @@ -813,11 +790,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/ba2fbdcb206609259134fc09eac7940c21cc2c13/lib/appium_lib/device/device.rb#L43) +##### [press_keycode](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/device/device.rb#L43) > def press_keycode Press keycode on the device. http://developer.android.com/reference/android/view/KeyEvent.html @@ -828,11 +805,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/ba2fbdcb206609259134fc09eac7940c21cc2c13/lib/appium_lib/device/device.rb#L49) +##### [long_press_keycode](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/device/device.rb#L49) > def long_press_keycode Long press keycode on the device. http://developer.android.com/reference/android/view/KeyEvent.html @@ -843,11 +820,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/ba2fbdcb206609259134fc09eac7940c21cc2c13/lib/appium_lib/device/device.rb#L55) +##### [push_file](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/device/device.rb#L55) > def push_file Place a file in a specific location on the device. @@ -857,11 +834,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/ba2fbdcb206609259134fc09eac7940c21cc2c13/lib/appium_lib/device/device.rb#L60) +##### [pull_file](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/device/device.rb#L60) > def pull_file Retrieve a file from the device. This can retrieve an absolute path or a path relative to the installed app (iOS only). @@ -874,11 +851,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/ba2fbdcb206609259134fc09eac7940c21cc2c13/lib/appium_lib/device/device.rb#L70) +##### [pull_folder](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/device/device.rb#L70) > def pull_folder Retrieve a folder from the device. ```ruby @@ -889,11 +866,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[String] path - absolute path to the folder -- -##### [touch_id](https://github.com/appium/ruby_lib/blob/ba2fbdcb206609259134fc09eac7940c21cc2c13/lib/appium_lib/device/device.rb#L78) +##### [touch_id](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/device/device.rb#L78) > def touch_id iOS only; Simulate Touch ID with either valid (match == true) or invalid (match == false) fingerprint. ```ruby @@ -906,11 +883,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Boolean] match - fingerprint validity Defaults to true. -- -##### [end_coverage](https://github.com/appium/ruby_lib/blob/ba2fbdcb206609259134fc09eac7940c21cc2c13/lib/appium_lib/device/device.rb#L87) +##### [end_coverage](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/device/device.rb#L87) > def end_coverage Android only; Ends the test coverage and writes the results to the given path on device. @@ -920,35 +897,35 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[String] intent - Intent to broadcast when ending coverage. -- -##### [get_settings](https://github.com/appium/ruby_lib/blob/ba2fbdcb206609259134fc09eac7940c21cc2c13/lib/appium_lib/device/device.rb#L92) +##### [get_settings](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/device/device.rb#L92) > def get_settings Get appium Settings for current test session -- -##### [extend_search_contexts](https://github.com/appium/ruby_lib/blob/ba2fbdcb206609259134fc09eac7940c21cc2c13/lib/appium_lib/device/device.rb#L356) +##### [extend_search_contexts](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/device/device.rb#L356) > def extend_search_contexts -- -##### [find_element](https://github.com/appium/ruby_lib/blob/ba2fbdcb206609259134fc09eac7940c21cc2c13/lib/appium_lib/device/device.rb#L356) +##### [find_element](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/device/device.rb#L356) > def find_element -- -##### [find_elements](https://github.com/appium/ruby_lib/blob/ba2fbdcb206609259134fc09eac7940c21cc2c13/lib/appium_lib/device/device.rb#L356) +##### [find_elements](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/device/device.rb#L356) > def find_elements find_element/s with their accessibility_id @@ -956,27 +933,27 @@ find_elements :accessibility_id, 'Animation' ``` -- -##### [add_touch_actions](https://github.com/appium/ruby_lib/blob/ba2fbdcb206609259134fc09eac7940c21cc2c13/lib/appium_lib/device/device.rb#L387) +##### [add_touch_actions](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/device/device.rb#L387) > def add_touch_actions -- -##### [add_ime_actions](https://github.com/appium/ruby_lib/blob/ba2fbdcb206609259134fc09eac7940c21cc2c13/lib/appium_lib/device/device.rb#L410) +##### [add_ime_actions](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/device/device.rb#L410) > def add_ime_actions -- -##### [set_context](https://github.com/appium/ruby_lib/blob/ba2fbdcb206609259134fc09eac7940c21cc2c13/lib/appium_lib/device/device.rb#L485) +##### [set_context](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/device/device.rb#L485) > def set_context Change the context to the given context. ```ruby @@ -987,11 +964,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[String] The - context to change to -- -##### [current_context](https://github.com/appium/ruby_lib/blob/ba2fbdcb206609259134fc09eac7940c21cc2c13/lib/appium_lib/device/device.rb#L493) +##### [current_context](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/device/device.rb#L493) > def current_context @@ -999,11 +976,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[String] The context currently being used. -- -##### [available_contexts](https://github.com/appium/ruby_lib/blob/ba2fbdcb206609259134fc09eac7940c21cc2c13/lib/appium_lib/device/device.rb#L496) +##### [available_contexts](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/device/device.rb#L496) > def available_contexts @@ -1011,11 +988,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/ba2fbdcb206609259134fc09eac7940c21cc2c13/lib/appium_lib/device/device.rb#L506) +##### [within_context](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/device/device.rb#L506) > def within_context(context) Perform a block within the given context, then switch back to the starting context. ```ruby @@ -1027,19 +1004,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/ba2fbdcb206609259134fc09eac7940c21cc2c13/lib/appium_lib/device/device.rb#L514) +##### [switch_to_default_context](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/device/device.rb#L514) > 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/ba2fbdcb206609259134fc09eac7940c21cc2c13/lib/appium_lib/device/multi_touch.rb#L28) +##### [pinch](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/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. @@ -1054,11 +1031,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/ba2fbdcb206609259134fc09eac7940c21cc2c13/lib/appium_lib/device/multi_touch.rb#L64) +##### [zoom](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/device/multi_touch.rb#L64) > def zoom(percentage = 200, auto_perform = true) Convenience method for zooming the screen. Places two fingers at the edges of the screen and brings them together. @@ -1073,11 +1050,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/ba2fbdcb206609259134fc09eac7940c21cc2c13/lib/appium_lib/device/multi_touch.rb#L95) +##### [initialize](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/device/multi_touch.rb#L95) > def initialize Create a new multi-action @@ -1085,11 +1062,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[MultiTouch] a new instance of MultiTouch -- -##### [add](https://github.com/appium/ruby_lib/blob/ba2fbdcb206609259134fc09eac7940c21cc2c13/lib/appium_lib/device/multi_touch.rb#L101) +##### [add](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/device/multi_touch.rb#L101) > def add(chain) Add a touch_action to be performed @@ -1097,43 +1074,43 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[TouchAction] chain - The action to add to the chain -- -##### [perform](https://github.com/appium/ruby_lib/blob/ba2fbdcb206609259134fc09eac7940c21cc2c13/lib/appium_lib/device/multi_touch.rb#L106) +##### [perform](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/device/multi_touch.rb#L106) > def perform Ask Appium to perform the actions -- -##### [ACTIONS](https://github.com/appium/ruby_lib/blob/ba2fbdcb206609259134fc09eac7940c21cc2c13/lib/appium_lib/device/touch_actions.rb#L11) +##### [ACTIONS](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/device/touch_actions.rb#L11) > ACTIONS = [:move_to, :long_press, :double_tap, :two_finger_tap, :press, :release, :tap, :wait, :perform].freeze -- -##### [COMPLEX_ACTIONS](https://github.com/appium/ruby_lib/blob/ba2fbdcb206609259134fc09eac7940c21cc2c13/lib/appium_lib/device/touch_actions.rb#L12) +##### [COMPLEX_ACTIONS](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/device/touch_actions.rb#L12) > COMPLEX_ACTIONS = [:swipe].freeze -- -##### [actions](https://github.com/appium/ruby_lib/blob/ba2fbdcb206609259134fc09eac7940c21cc2c13/lib/appium_lib/device/touch_actions.rb#L26) +##### [actions](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/device/touch_actions.rb#L26) > def actions Returns the value of attribute actions -- -##### [initialize](https://github.com/appium/ruby_lib/blob/ba2fbdcb206609259134fc09eac7940c21cc2c13/lib/appium_lib/device/touch_actions.rb#L28) +##### [initialize](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/device/touch_actions.rb#L28) > def initialize @@ -1141,11 +1118,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[TouchAction] a new instance of TouchAction -- -##### [move_to](https://github.com/appium/ruby_lib/blob/ba2fbdcb206609259134fc09eac7940c21cc2c13/lib/appium_lib/device/touch_actions.rb#L36) +##### [move_to](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/device/touch_actions.rb#L36) > def move_to(opts) Move to the given co-ordinates. @@ -1153,11 +1130,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Hash] opts - a customizable set of options -- -##### [long_press](https://github.com/appium/ruby_lib/blob/ba2fbdcb206609259134fc09eac7940c21cc2c13/lib/appium_lib/device/touch_actions.rb#L50) +##### [long_press](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/device/touch_actions.rb#L50) > def long_press(opts) Press down for a specific duration. Alternatively, you can use `press(...).wait(...).release()` instead of `long_press` if duration doesn't work well. @@ -1174,11 +1151,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Hash] duration - a customizable set of options -- -##### [press](https://github.com/appium/ruby_lib/blob/ba2fbdcb206609259134fc09eac7940c21cc2c13/lib/appium_lib/device/touch_actions.rb#L62) +##### [press](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/device/touch_actions.rb#L62) > def press(opts) Press a finger onto the screen. Finger will stay down until you call `release`. @@ -1187,11 +1164,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Hash] opts - a customizable set of options -- -##### [release](https://github.com/appium/ruby_lib/blob/ba2fbdcb206609259134fc09eac7940c21cc2c13/lib/appium_lib/device/touch_actions.rb#L73) +##### [release](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/device/touch_actions.rb#L73) > def release(opts = nil) Remove a finger from the screen. @@ -1199,23 +1176,24 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Hash] opts - a customizable set of options -- -##### [tap](https://github.com/appium/ruby_lib/blob/ba2fbdcb206609259134fc09eac7940c21cc2c13/lib/appium_lib/device/touch_actions.rb#L84) +##### [tap](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/device/touch_actions.rb#L85) > def tap(opts) -Touch a point on the screen +Touch a point on the screen. +Alternatively, you can use `press(...).release.perform` instead of `tap(...).perform`. __Parameters:__ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Hash] opts - a customizable set of options -- -##### [double_tap](https://github.com/appium/ruby_lib/blob/ba2fbdcb206609259134fc09eac7940c21cc2c13/lib/appium_lib/device/touch_actions.rb#L97) +##### [double_tap](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/device/touch_actions.rb#L98) > def double_tap(opts) Double tap an element on the screen @@ -1223,11 +1201,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Hash] opts - a customizable set of options -- -##### [two_finger_tap](https://github.com/appium/ruby_lib/blob/ba2fbdcb206609259134fc09eac7940c21cc2c13/lib/appium_lib/device/touch_actions.rb#L108) +##### [two_finger_tap](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/device/touch_actions.rb#L109) > def two_finger_tap(opts) Two finger tap an element on the screen @@ -1235,11 +1213,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Hash] opts - a customizable set of options -- -##### [wait](https://github.com/appium/ruby_lib/blob/ba2fbdcb206609259134fc09eac7940c21cc2c13/lib/appium_lib/device/touch_actions.rb#L116) +##### [wait](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/device/touch_actions.rb#L117) > def wait(milliseconds) Pause for a number of milliseconds before the next action @@ -1247,11 +1225,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[integer] milliseconds - Number of milliseconds to pause for -- -##### [swipe](https://github.com/appium/ruby_lib/blob/ba2fbdcb206609259134fc09eac7940c21cc2c13/lib/appium_lib/device/touch_actions.rb#L131) +##### [swipe](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/device/touch_actions.rb#L132) > def swipe(opts, ele = nil) Convenience method to peform a swipe. @@ -1261,60 +1239,60 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Hash] opts - a customizable set of options -- -##### [perform](https://github.com/appium/ruby_lib/blob/ba2fbdcb206609259134fc09eac7940c21cc2c13/lib/appium_lib/device/touch_actions.rb#L165) +##### [perform](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/device/touch_actions.rb#L166) > def perform Ask the driver to perform all actions in this action chain. -- -##### [cancel](https://github.com/appium/ruby_lib/blob/ba2fbdcb206609259134fc09eac7940c21cc2c13/lib/appium_lib/device/touch_actions.rb#L171) +##### [cancel](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/device/touch_actions.rb#L172) > def cancel Does nothing, currently. -- -##### [chain_method](https://github.com/appium/ruby_lib/blob/ba2fbdcb206609259134fc09eac7940c21cc2c13/lib/appium_lib/device/touch_actions.rb#L179) +##### [chain_method](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/device/touch_actions.rb#L180) > def chain_method(method, args = nil) -- -##### [args_with_ele_ref](https://github.com/appium/ruby_lib/blob/ba2fbdcb206609259134fc09eac7940c21cc2c13/lib/appium_lib/device/touch_actions.rb#L185) +##### [args_with_ele_ref](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/device/touch_actions.rb#L186) > def args_with_ele_ref(args) -- -##### [_generic_wait](https://github.com/appium/ruby_lib/blob/ba2fbdcb206609259134fc09eac7940c21cc2c13/lib/appium_lib/common/wait.rb#L9) +##### [_generic_wait](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/common/wait.rb#L9) > def _generic_wait(opts = {}) Wait code from the selenium Ruby gem https://github.com/SeleniumHQ/selenium/blob/cf501dda3f0ed12233de51ce8170c0e8090f0c20/rb/lib/selenium/webdriver/common/wait.rb -- -##### [_process_wait_opts](https://github.com/appium/ruby_lib/blob/ba2fbdcb206609259134fc09eac7940c21cc2c13/lib/appium_lib/common/wait.rb#L48) +##### [_process_wait_opts](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/common/wait.rb#L48) > def _process_wait_opts(opts) process opts before calling _generic_wait -- -##### [wait_true](https://github.com/appium/ruby_lib/blob/ba2fbdcb206609259134fc09eac7940c21cc2c13/lib/appium_lib/common/wait.rb#L69) +##### [wait_true](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/common/wait.rb#L69) > def wait_true(opts = {}, &block) Check every interval seconds to see if yield returns a truthy value. Note this isn't a strict boolean true, any truthy value is accepted. @@ -1330,11 +1308,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Hash] opts - Options -- -##### [wait](https://github.com/appium/ruby_lib/blob/ba2fbdcb206609259134fc09eac7940c21cc2c13/lib/appium_lib/common/wait.rb#L87) +##### [wait](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/common/wait.rb#L87) > def wait(opts = {}, &block) Check every interval seconds to see if yield doesn't raise an exception. Give up after timeout seconds. @@ -1348,19 +1326,19 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Hash] opts - Options -- -##### [ignore](https://github.com/appium/ruby_lib/blob/ba2fbdcb206609259134fc09eac7940c21cc2c13/lib/appium_lib/common/helper.rb#L24) +##### [ignore](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/common/helper.rb#L24) > def ignore Return yield and ignore any exceptions. -- -##### [back](https://github.com/appium/ruby_lib/blob/ba2fbdcb206609259134fc09eac7940c21cc2c13/lib/appium_lib/common/helper.rb#L31) +##### [back](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/common/helper.rb#L31) > def back Navigate back. @@ -1368,19 +1346,19 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[void] -- -##### [session_id](https://github.com/appium/ruby_lib/blob/ba2fbdcb206609259134fc09eac7940c21cc2c13/lib/appium_lib/common/helper.rb#L36) +##### [session_id](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/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/ba2fbdcb206609259134fc09eac7940c21cc2c13/lib/appium_lib/common/helper.rb#L44) +##### [xpath](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/common/helper.rb#L44) > def xpath(xpath_str) Returns the first element that matches the provided xpath. @@ -1392,11 +1370,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Element] -- -##### [xpaths](https://github.com/appium/ruby_lib/blob/ba2fbdcb206609259134fc09eac7940c21cc2c13/lib/appium_lib/common/helper.rb#L52) +##### [xpaths](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/common/helper.rb#L52) > def xpaths(xpath_str) Returns all elements that match the provided xpath. @@ -1408,27 +1386,27 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Array<Element>] -- -##### [_print_source](https://github.com/appium/ruby_lib/blob/ba2fbdcb206609259134fc09eac7940c21cc2c13/lib/appium_lib/common/helper.rb#L56) +##### [_print_source](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/common/helper.rb#L56) > def _print_source(source) -- -##### [result](https://github.com/appium/ruby_lib/blob/ba2fbdcb206609259134fc09eac7940c21cc2c13/lib/appium_lib/common/helper.rb#L69) +##### [result](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/common/helper.rb#L69) > def result Returns the value of attribute result -- -##### [initialize](https://github.com/appium/ruby_lib/blob/ba2fbdcb206609259134fc09eac7940c21cc2c13/lib/appium_lib/common/helper.rb#L71) +##### [initialize](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/common/helper.rb#L71) > def initialize @@ -1436,52 +1414,52 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[CountElements] a new instance of CountElements -- -##### [reset](https://github.com/appium/ruby_lib/blob/ba2fbdcb206609259134fc09eac7940c21cc2c13/lib/appium_lib/common/helper.rb#L75) +##### [reset](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/common/helper.rb#L75) > def reset -- -##### [start_element](https://github.com/appium/ruby_lib/blob/ba2fbdcb206609259134fc09eac7940c21cc2c13/lib/appium_lib/common/helper.rb#L80) +##### [start_element](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/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/ba2fbdcb206609259134fc09eac7940c21cc2c13/lib/appium_lib/common/helper.rb#L86) +##### [formatted_result](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/common/helper.rb#L86) > def formatted_result -- -##### [get_page_class](https://github.com/appium/ruby_lib/blob/ba2fbdcb206609259134fc09eac7940c21cc2c13/lib/appium_lib/common/helper.rb#L97) +##### [get_page_class](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/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/ba2fbdcb206609259134fc09eac7940c21cc2c13/lib/appium_lib/common/helper.rb#L108) +##### [page_class](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/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/ba2fbdcb206609259134fc09eac7940c21cc2c13/lib/appium_lib/common/helper.rb#L118) +##### [px_to_window_rel](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/common/helper.rb#L118) > def px_to_window_rel(opts = {}) Converts pixel values to window relative values @@ -1489,11 +1467,11 @@ px_to_window_rel x: 50, y: 150 ``` -- -##### [xml_keys](https://github.com/appium/ruby_lib/blob/ba2fbdcb206609259134fc09eac7940c21cc2c13/lib/appium_lib/common/helper.rb#L137) +##### [xml_keys](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/common/helper.rb#L137) > def xml_keys(target) Search strings.xml's values for target. @@ -1505,11 +1483,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Array] -- -##### [xml_values](https://github.com/appium/ruby_lib/blob/ba2fbdcb206609259134fc09eac7940c21cc2c13/lib/appium_lib/common/helper.rb#L145) +##### [xml_values](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/common/helper.rb#L145) > def xml_values(target) Search strings.xml's keys for target. @@ -1521,11 +1499,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Array] -- -##### [resolve_id](https://github.com/appium/ruby_lib/blob/ba2fbdcb206609259134fc09eac7940c21cc2c13/lib/appium_lib/common/helper.rb#L153) +##### [resolve_id](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/common/helper.rb#L153) > def resolve_id(id) Resolve id in strings.xml and return the value. @@ -1537,27 +1515,27 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[String] -- -##### [filter](https://github.com/appium/ruby_lib/blob/ba2fbdcb206609259134fc09eac7940c21cc2c13/lib/appium_lib/common/helper.rb#L159) +##### [filter](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/common/helper.rb#L159) > def filter Returns the value of attribute filter -- -##### [filter=](https://github.com/appium/ruby_lib/blob/ba2fbdcb206609259134fc09eac7940c21cc2c13/lib/appium_lib/common/helper.rb#L162) +##### [filter=](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/common/helper.rb#L162) > def filter=(value) convert to string to support symbols -- -##### [initialize](https://github.com/appium/ruby_lib/blob/ba2fbdcb206609259134fc09eac7940c21cc2c13/lib/appium_lib/common/helper.rb#L168) +##### [initialize](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/common/helper.rb#L168) > def initialize @@ -1565,131 +1543,131 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[HTMLElements] a new instance of HTMLElements -- -##### [reset](https://github.com/appium/ruby_lib/blob/ba2fbdcb206609259134fc09eac7940c21cc2c13/lib/appium_lib/common/helper.rb#L173) +##### [reset](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/common/helper.rb#L173) > def reset -- -##### [result](https://github.com/appium/ruby_lib/blob/ba2fbdcb206609259134fc09eac7940c21cc2c13/lib/appium_lib/common/helper.rb#L179) +##### [result](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/common/helper.rb#L179) > def result -- -##### [start_element](https://github.com/appium/ruby_lib/blob/ba2fbdcb206609259134fc09eac7940c21cc2c13/lib/appium_lib/common/helper.rb#L195) +##### [start_element](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/common/helper.rb#L195) > def start_element(name, attrs = []) -- -##### [end_element](https://github.com/appium/ruby_lib/blob/ba2fbdcb206609259134fc09eac7940c21cc2c13/lib/appium_lib/common/helper.rb#L204) +##### [end_element](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/common/helper.rb#L204) > def end_element(name) -- -##### [characters](https://github.com/appium/ruby_lib/blob/ba2fbdcb206609259134fc09eac7940c21cc2c13/lib/appium_lib/common/helper.rb#L210) +##### [characters](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/common/helper.rb#L210) > def characters(chars) -- -##### [_no_such_element](https://github.com/appium/ruby_lib/blob/ba2fbdcb206609259134fc09eac7940c21cc2c13/lib/appium_lib/common/helper.rb#L217) +##### [_no_such_element](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/common/helper.rb#L217) > def _no_such_element -- -##### [COMMAND_NO_ARG](https://github.com/appium/ruby_lib/blob/ba2fbdcb206609259134fc09eac7940c21cc2c13/lib/appium_lib/common/command.rb#L4) +##### [COMMAND_NO_ARG](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/common/command.rb#L4) > COMMAND_NO_ARG = { -- -##### [COMMAND](https://github.com/appium/ruby_lib/blob/ba2fbdcb206609259134fc09eac7940c21cc2c13/lib/appium_lib/common/command.rb#L23) +##### [COMMAND](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/common/command.rb#L23) > COMMAND = { -- -##### [FINDERS](https://github.com/appium/ruby_lib/blob/ba2fbdcb206609259134fc09eac7940c21cc2c13/lib/appium_lib/common/search_context.rb#L5) +##### [window_size](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/common/element/window.rb#L5) -> FINDERS = { +> def window_size -rubocop:disable Style/MutableConstant +Get the window's size -- -##### [window_size](https://github.com/appium/ruby_lib/blob/ba2fbdcb206609259134fc09eac7940c21cc2c13/lib/appium_lib/common/element/window.rb#L5) +##### [FINDERS](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/common/search_context.rb#L5) -> def window_size +> FINDERS = { -Get the window's size +rubocop:disable Style/MutableConstant -- -##### [result](https://github.com/appium/ruby_lib/blob/ba2fbdcb206609259134fc09eac7940c21cc2c13/lib/appium_lib/android/helper.rb#L6) android +##### [result](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/android/helper.rb#L6) android > def result Returns the value of attribute result -- -##### [keys](https://github.com/appium/ruby_lib/blob/ba2fbdcb206609259134fc09eac7940c21cc2c13/lib/appium_lib/android/helper.rb#L6) android +##### [keys](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/android/helper.rb#L6) android > def keys Returns the value of attribute keys -- -##### [instance](https://github.com/appium/ruby_lib/blob/ba2fbdcb206609259134fc09eac7940c21cc2c13/lib/appium_lib/android/helper.rb#L6) android +##### [instance](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/android/helper.rb#L6) android > def instance Returns the value of attribute instance -- -##### [filter](https://github.com/appium/ruby_lib/blob/ba2fbdcb206609259134fc09eac7940c21cc2c13/lib/appium_lib/android/helper.rb#L6) android +##### [filter](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/android/helper.rb#L6) android > def filter Returns the value of attribute filter -- -##### [filter=](https://github.com/appium/ruby_lib/blob/ba2fbdcb206609259134fc09eac7940c21cc2c13/lib/appium_lib/android/helper.rb#L9) android +##### [filter=](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/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/ba2fbdcb206609259134fc09eac7940c21cc2c13/lib/appium_lib/android/helper.rb#L15) android +##### [initialize](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/android/helper.rb#L15) android > def initialize @@ -1697,37 +1675,37 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[AndroidElements] a new instance of AndroidElements -- -##### [reset](https://github.com/appium/ruby_lib/blob/ba2fbdcb206609259134fc09eac7940c21cc2c13/lib/appium_lib/android/helper.rb#L21) android +##### [reset](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/android/helper.rb#L21) android > def reset -- -##### [start_element](https://github.com/appium/ruby_lib/blob/ba2fbdcb206609259134fc09eac7940c21cc2c13/lib/appium_lib/android/helper.rb#L28) android +##### [start_element](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/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/ba2fbdcb206609259134fc09eac7940c21cc2c13/lib/appium_lib/android/helper.rb#L88) android +##### [_fix_android_native_source](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/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/ba2fbdcb206609259134fc09eac7940c21cc2c13/lib/appium_lib/android/helper.rb#L116) android +##### [source](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/android/helper.rb#L116) android > def source Prints xml of the current page @@ -1735,11 +1713,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[void] -- -##### [get_android_inspect](https://github.com/appium/ruby_lib/blob/ba2fbdcb206609259134fc09eac7940c21cc2c13/lib/appium_lib/android/helper.rb#L126) android +##### [get_android_inspect](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/android/helper.rb#L126) android > def get_android_inspect(class_name = false) Android only. Returns a string containing interesting elements. @@ -1754,11 +1732,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[String] -- -##### [page](https://github.com/appium/ruby_lib/blob/ba2fbdcb206609259134fc09eac7940c21cc2c13/lib/appium_lib/android/helper.rb#L152) android +##### [page](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/android/helper.rb#L152) android > def page(opts = {}) Intended for use with console. Inspects and prints the current page. @@ -1773,21 +1751,21 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[void] -- -##### [current_app](https://github.com/appium/ruby_lib/blob/ba2fbdcb206609259134fc09eac7940c21cc2c13/lib/appium_lib/android/helper.rb#L164) android +##### [current_app](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/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/ba2fbdcb206609259134fc09eac7940c21cc2c13/lib/appium_lib/android/helper.rb#L188) android +##### [id](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/android/helper.rb#L188) android > def id(id) Find the first matching element by id @@ -1799,11 +1777,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Element] -- -##### [ids](https://github.com/appium/ruby_lib/blob/ba2fbdcb206609259134fc09eac7940c21cc2c13/lib/appium_lib/android/helper.rb#L196) android +##### [ids](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/android/helper.rb#L196) android > def ids(id) Find all matching elements by id @@ -1815,11 +1793,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Element] -- -##### [ele_index](https://github.com/appium/ruby_lib/blob/ba2fbdcb206609259134fc09eac7940c21cc2c13/lib/appium_lib/android/helper.rb#L205) android +##### [ele_index](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/android/helper.rb#L205) android > def ele_index(class_name, index) Find the element of type class_name at matching index. @@ -1833,11 +1811,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Element] the found element of type class_name -- -##### [first_ele](https://github.com/appium/ruby_lib/blob/ba2fbdcb206609259134fc09eac7940c21cc2c13/lib/appium_lib/android/helper.rb#L223) android +##### [first_ele](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/android/helper.rb#L223) android > def first_ele(class_name) Find the first element that matches class_name @@ -1849,11 +1827,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Element] -- -##### [last_ele](https://github.com/appium/ruby_lib/blob/ba2fbdcb206609259134fc09eac7940c21cc2c13/lib/appium_lib/android/helper.rb#L230) android +##### [last_ele](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/android/helper.rb#L230) android > def last_ele(class_name) Find the last element that matches class_name @@ -1865,11 +1843,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Element] -- -##### [tag](https://github.com/appium/ruby_lib/blob/ba2fbdcb206609259134fc09eac7940c21cc2c13/lib/appium_lib/android/helper.rb#L238) android +##### [tag](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/android/helper.rb#L238) android > def tag(class_name) Find the first element of type class_name @@ -1881,11 +1859,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Element] -- -##### [tags](https://github.com/appium/ruby_lib/blob/ba2fbdcb206609259134fc09eac7940c21cc2c13/lib/appium_lib/android/helper.rb#L246) android +##### [tags](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/android/helper.rb#L246) android > def tags(class_name) Find all elements of type class_name @@ -1897,11 +1875,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Element] -- -##### [string_visible_contains](https://github.com/appium/ruby_lib/blob/ba2fbdcb206609259134fc09eac7940c21cc2c13/lib/appium_lib/android/helper.rb#L288) android +##### [string_visible_contains](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/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 @@ -1917,11 +1895,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[String] -- -##### [complex_find_contains](https://github.com/appium/ruby_lib/blob/ba2fbdcb206609259134fc09eac7940c21cc2c13/lib/appium_lib/android/helper.rb#L308) android +##### [complex_find_contains](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/android/helper.rb#L308) android > def complex_find_contains(element, value) Find the first element that contains value @@ -1935,11 +1913,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Element] -- -##### [complex_finds_contains](https://github.com/appium/ruby_lib/blob/ba2fbdcb206609259134fc09eac7940c21cc2c13/lib/appium_lib/android/helper.rb#L316) android +##### [complex_finds_contains](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/android/helper.rb#L316) android > def complex_finds_contains(element, value) Find all elements containing value @@ -1953,11 +1931,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Array<Element>] -- -##### [complex_find_exact](https://github.com/appium/ruby_lib/blob/ba2fbdcb206609259134fc09eac7940c21cc2c13/lib/appium_lib/android/helper.rb#L345) android +##### [complex_find_exact](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/android/helper.rb#L345) android > def complex_find_exact(class_name, value) Find the first element exactly matching value @@ -1971,11 +1949,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Element] -- -##### [complex_finds_exact](https://github.com/appium/ruby_lib/blob/ba2fbdcb206609259134fc09eac7940c21cc2c13/lib/appium_lib/android/helper.rb#L353) android +##### [complex_finds_exact](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/android/helper.rb#L353) android > def complex_finds_exact(class_name, value) Find all elements exactly matching value @@ -1989,11 +1967,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Element] -- -##### [get_source](https://github.com/appium/ruby_lib/blob/ba2fbdcb206609259134fc09eac7940c21cc2c13/lib/appium_lib/android/helper.rb#L361) android +##### [get_source](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/android/helper.rb#L361) android > def get_source Returns XML string for the current page Fixes uiautomator's $ in node names. @@ -2003,19 +1981,51 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[String] -- -##### [TextView](https://github.com/appium/ruby_lib/blob/ba2fbdcb206609259134fc09eac7940c21cc2c13/lib/appium_lib/android/element/text.rb#L4) android +##### [_nodeset_to_uiselector](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/android/client_xpath.rb#L5) android +> def _nodeset_to_uiselector(opts = {}) + + + +-- + +##### [_client_xpath](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/android/client_xpath.rb#L20) android + +> def _client_xpath(opts = {}) + + + +-- + +##### [client_xpath](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/android/client_xpath.rb#L36) android + +> def client_xpath(xpath) + + + +-- + +##### [client_xpaths](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/android/client_xpath.rb#L40) android + +> def client_xpaths(xpath) + + + +-- + +##### [TextView](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/android/element/text.rb#L4) android + > TextView = 'android.widget.TextView'.freeze -- -##### [text](https://github.com/appium/ruby_lib/blob/ba2fbdcb206609259134fc09eac7940c21cc2c13/lib/appium_lib/android/element/text.rb#L10) android +##### [text](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/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. @@ -2028,11 +2038,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[TextView] -- -##### [texts](https://github.com/appium/ruby_lib/blob/ba2fbdcb206609259134fc09eac7940c21cc2c13/lib/appium_lib/android/element/text.rb#L19) android +##### [texts](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/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. @@ -2045,11 +2055,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Array<TextView>] -- -##### [first_text](https://github.com/appium/ruby_lib/blob/ba2fbdcb206609259134fc09eac7940c21cc2c13/lib/appium_lib/android/element/text.rb#L26) android +##### [first_text](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/android/element/text.rb#L26) android > def first_text Find the first TextView. @@ -2057,11 +2067,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[TextView] -- -##### [last_text](https://github.com/appium/ruby_lib/blob/ba2fbdcb206609259134fc09eac7940c21cc2c13/lib/appium_lib/android/element/text.rb#L32) android +##### [last_text](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/android/element/text.rb#L32) android > def last_text Find the last TextView. @@ -2069,11 +2079,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[TextView] -- -##### [text_exact](https://github.com/appium/ruby_lib/blob/ba2fbdcb206609259134fc09eac7940c21cc2c13/lib/appium_lib/android/element/text.rb#L39) android +##### [text_exact](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/android/element/text.rb#L39) android > def text_exact(value) Find the first TextView that exactly matches value. @@ -2085,11 +2095,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[TextView] -- -##### [texts_exact](https://github.com/appium/ruby_lib/blob/ba2fbdcb206609259134fc09eac7940c21cc2c13/lib/appium_lib/android/element/text.rb#L46) android +##### [texts_exact](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/android/element/text.rb#L46) android > def texts_exact(value) Find all TextViews that exactly match value. @@ -2101,44 +2111,12 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Array<TextView>] -- -##### [_nodeset_to_uiselector](https://github.com/appium/ruby_lib/blob/ba2fbdcb206609259134fc09eac7940c21cc2c13/lib/appium_lib/android/client_xpath.rb#L5) android +##### [alert_click](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/android/element/alert.rb#L6) android -> def _nodeset_to_uiselector(opts = {}) - - - --- - -##### [_client_xpath](https://github.com/appium/ruby_lib/blob/ba2fbdcb206609259134fc09eac7940c21cc2c13/lib/appium_lib/android/client_xpath.rb#L20) android - -> def _client_xpath(opts = {}) - - - --- - -##### [client_xpath](https://github.com/appium/ruby_lib/blob/ba2fbdcb206609259134fc09eac7940c21cc2c13/lib/appium_lib/android/client_xpath.rb#L36) android - -> def client_xpath(xpath) - - - --- - -##### [client_xpaths](https://github.com/appium/ruby_lib/blob/ba2fbdcb206609259134fc09eac7940c21cc2c13/lib/appium_lib/android/client_xpath.rb#L40) android - -> def client_xpaths(xpath) - - - --- - -##### [alert_click](https://github.com/appium/ruby_lib/blob/ba2fbdcb206609259134fc09eac7940c21cc2c13/lib/appium_lib/android/element/alert.rb#L6) android - > def alert_click(value) Click the first alert button that contains value or by index. __Parameters:__ @@ -2149,11 +2127,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[void] -- -##### [alert_accept](https://github.com/appium/ruby_lib/blob/ba2fbdcb206609259134fc09eac7940c21cc2c13/lib/appium_lib/android/element/alert.rb#L13) android +##### [alert_accept](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/android/element/alert.rb#L13) android > def alert_accept Accept the alert. The last button is considered "accept." @@ -2162,11 +2140,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[void] -- -##### [alert_accept_text](https://github.com/appium/ruby_lib/blob/ba2fbdcb206609259134fc09eac7940c21cc2c13/lib/appium_lib/android/element/alert.rb#L20) android +##### [alert_accept_text](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/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." @@ -2175,11 +2153,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[String] -- -##### [alert_dismiss](https://github.com/appium/ruby_lib/blob/ba2fbdcb206609259134fc09eac7940c21cc2c13/lib/appium_lib/android/element/alert.rb#L27) android +##### [alert_dismiss](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/android/element/alert.rb#L27) android > def alert_dismiss Dismiss the alert. The first button is considered "dismiss." @@ -2188,11 +2166,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[void] -- -##### [alert_dismiss_text](https://github.com/appium/ruby_lib/blob/ba2fbdcb206609259134fc09eac7940c21cc2c13/lib/appium_lib/android/element/alert.rb#L34) android +##### [alert_dismiss_text](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/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." @@ -2201,27 +2179,27 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[String] -- -##### [Button](https://github.com/appium/ruby_lib/blob/ba2fbdcb206609259134fc09eac7940c21cc2c13/lib/appium_lib/android/element/button.rb#L4) android +##### [Button](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/android/element/button.rb#L4) android > Button = 'android.widget.Button'.freeze -- -##### [ImageButton](https://github.com/appium/ruby_lib/blob/ba2fbdcb206609259134fc09eac7940c21cc2c13/lib/appium_lib/android/element/button.rb#L5) android +##### [ImageButton](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/android/element/button.rb#L5) android > ImageButton = 'android.widget.ImageButton'.freeze -- -##### [button](https://github.com/appium/ruby_lib/blob/ba2fbdcb206609259134fc09eac7940c21cc2c13/lib/appium_lib/android/element/button.rb#L43) android +##### [button](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/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. @@ -2234,11 +2212,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Button] -- -##### [buttons](https://github.com/appium/ruby_lib/blob/ba2fbdcb206609259134fc09eac7940c21cc2c13/lib/appium_lib/android/element/button.rb#L60) android +##### [buttons](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/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. @@ -2251,11 +2229,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Array<Button>] -- -##### [first_button](https://github.com/appium/ruby_lib/blob/ba2fbdcb206609259134fc09eac7940c21cc2c13/lib/appium_lib/android/element/button.rb#L67) android +##### [first_button](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/android/element/button.rb#L67) android > def first_button Find the first button. @@ -2263,11 +2241,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Button] -- -##### [last_button](https://github.com/appium/ruby_lib/blob/ba2fbdcb206609259134fc09eac7940c21cc2c13/lib/appium_lib/android/element/button.rb#L73) android +##### [last_button](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/android/element/button.rb#L73) android > def last_button Find the last button. @@ -2275,11 +2253,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Button] -- -##### [button_exact](https://github.com/appium/ruby_lib/blob/ba2fbdcb206609259134fc09eac7940c21cc2c13/lib/appium_lib/android/element/button.rb#L89) android +##### [button_exact](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/android/element/button.rb#L89) android > def button_exact(value) Find the first button that exactly matches value. @@ -2291,11 +2269,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Button] -- -##### [buttons_exact](https://github.com/appium/ruby_lib/blob/ba2fbdcb206609259134fc09eac7940c21cc2c13/lib/appium_lib/android/element/button.rb#L96) android +##### [buttons_exact](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/android/element/button.rb#L96) android > def buttons_exact(value) Find all buttons that exactly match value. @@ -2307,11 +2285,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Array<Button>] -- -##### [uiautomator_find](https://github.com/appium/ruby_lib/blob/ba2fbdcb206609259134fc09eac7940c21cc2c13/lib/appium_lib/android/mobile_methods.rb#L10) android +##### [uiautomator_find](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/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). @@ -2319,11 +2297,11 @@ find_elements :uiautomator, 'new UiSelector().clickable(true)' ``` -- -##### [find](https://github.com/appium/ruby_lib/blob/ba2fbdcb206609259134fc09eac7940c21cc2c13/lib/appium_lib/android/element/generic.rb#L6) android +##### [find](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/android/element/generic.rb#L6) android > def find(value) Find the first element containing value @@ -2335,11 +2313,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Element] -- -##### [finds](https://github.com/appium/ruby_lib/blob/ba2fbdcb206609259134fc09eac7940c21cc2c13/lib/appium_lib/android/element/generic.rb#L13) android +##### [finds](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/android/element/generic.rb#L13) android > def finds(value) Find all elements containing value @@ -2351,11 +2329,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Array<Element>] -- -##### [find_exact](https://github.com/appium/ruby_lib/blob/ba2fbdcb206609259134fc09eac7940c21cc2c13/lib/appium_lib/android/element/generic.rb#L20) android +##### [find_exact](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/android/element/generic.rb#L20) android > def find_exact(value) Find the first element exactly matching value @@ -2367,11 +2345,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Element] -- -##### [finds_exact](https://github.com/appium/ruby_lib/blob/ba2fbdcb206609259134fc09eac7940c21cc2c13/lib/appium_lib/android/element/generic.rb#L27) android +##### [finds_exact](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/android/element/generic.rb#L27) android > def finds_exact(value) Find all elements exactly matching value @@ -2383,11 +2361,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Array<Element>] -- -##### [scroll_to](https://github.com/appium/ruby_lib/blob/ba2fbdcb206609259134fc09eac7940c21cc2c13/lib/appium_lib/android/element/generic.rb#L39) android +##### [scroll_to](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/android/element/generic.rb#L39) android > def scroll_to(text) Scroll to the first element containing target text or description. @@ -2399,11 +2377,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Element] the element scrolled to -- -##### [scroll_to_exact](https://github.com/appium/ruby_lib/blob/ba2fbdcb206609259134fc09eac7940c21cc2c13/lib/appium_lib/android/element/generic.rb#L51) android +##### [scroll_to_exact](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/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. @@ -2415,19 +2393,19 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Element] the element scrolled to -- -##### [EditText](https://github.com/appium/ruby_lib/blob/ba2fbdcb206609259134fc09eac7940c21cc2c13/lib/appium_lib/android/element/textfield.rb#L3) android +##### [EditText](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/android/element/textfield.rb#L3) android > EditText = 'android.widget.EditText'.freeze -- -##### [textfield](https://github.com/appium/ruby_lib/blob/ba2fbdcb206609259134fc09eac7940c21cc2c13/lib/appium_lib/android/element/textfield.rb#L9) android +##### [textfield](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/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. @@ -2440,11 +2418,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[EditText] -- -##### [textfields](https://github.com/appium/ruby_lib/blob/ba2fbdcb206609259134fc09eac7940c21cc2c13/lib/appium_lib/android/element/textfield.rb#L18) android +##### [textfields](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/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. @@ -2457,11 +2435,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Array<EditText>] -- -##### [first_textfield](https://github.com/appium/ruby_lib/blob/ba2fbdcb206609259134fc09eac7940c21cc2c13/lib/appium_lib/android/element/textfield.rb#L25) android +##### [first_textfield](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/android/element/textfield.rb#L25) android > def first_textfield Find the first EditText. @@ -2469,11 +2447,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[EditText] -- -##### [last_textfield](https://github.com/appium/ruby_lib/blob/ba2fbdcb206609259134fc09eac7940c21cc2c13/lib/appium_lib/android/element/textfield.rb#L31) android +##### [last_textfield](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/android/element/textfield.rb#L31) android > def last_textfield Find the last EditText. @@ -2481,11 +2459,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[EditText] -- -##### [textfield_exact](https://github.com/appium/ruby_lib/blob/ba2fbdcb206609259134fc09eac7940c21cc2c13/lib/appium_lib/android/element/textfield.rb#L38) android +##### [textfield_exact](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/android/element/textfield.rb#L38) android > def textfield_exact(value) Find the first EditText that exactly matches value. @@ -2497,11 +2475,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[EditText] -- -##### [textfields_exact](https://github.com/appium/ruby_lib/blob/ba2fbdcb206609259134fc09eac7940c21cc2c13/lib/appium_lib/android/element/textfield.rb#L45) android +##### [textfields_exact](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/android/element/textfield.rb#L45) android > def textfields_exact(value) Find all EditTexts that exactly match value. @@ -2513,31 +2491,31 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Array<EditText>] -- -##### [value](https://github.com/appium/ruby_lib/blob/ba2fbdcb206609259134fc09eac7940c21cc2c13/lib/appium_lib/common/patch.rb#L12) +##### [value](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/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/ba2fbdcb206609259134fc09eac7940c21cc2c13/lib/appium_lib/common/patch.rb#L19) +##### [name](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/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/ba2fbdcb206609259134fc09eac7940c21cc2c13/lib/appium_lib/common/patch.rb#L31) +##### [location_rel](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/common/patch.rb#L31) > def location_rel For use with mobile tap. @@ -2551,18 +2529,18 @@ &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/ba2fbdcb206609259134fc09eac7940c21cc2c13/lib/appium_lib/common/patch.rb#L152) +##### [DEFAULT_HEADERS](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/common/patch.rb#L152) > DEFAULT_HEADERS = { 'Accept' => CONTENT_TYPE, 'User-Agent' => "appium/ruby_lib/#{::Appium::VERSION}" }.freeze -- -##### [patch_remote_driver_commands](https://github.com/appium/ruby_lib/blob/ba2fbdcb206609259134fc09eac7940c21cc2c13/lib/appium_lib/common/patch.rb#L155) +##### [patch_remote_driver_commands](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/common/patch.rb#L155) > def patch_remote_driver_commands