docs/android_docs.md in appium_lib-9.14.1 vs docs/android_docs.md in appium_lib-9.14.2

- old
+ new

@@ -1,6 +1,6 @@ -##### [load_settings](https://github.com/appium/ruby_lib/blob/0dca183c11919f20bff1acb7f04138ed6e678ca6/lib/appium_lib/appium.rb#L46) +##### [load_settings](https://github.com/appium/ruby_lib/blob/024167c78c20a817861528ae4d3b80d41ea82590/lib/appium_lib/appium.rb#L46) > def load_settings(opts = {}) Load arbitrary text ([toml format](https://github.com/toml-lang/toml)) The toml is parsed by https://github.com/fbernier/tomlrb . @@ -25,11 +25,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/0dca183c11919f20bff1acb7f04138ed6e678ca6/lib/appium_lib/appium.rb#L80) +##### [load_appium_txt](https://github.com/appium/ruby_lib/blob/024167c78c20a817861528ae4d3b80d41ea82590/lib/appium_lib/appium.rb#L80) > def load_settings(opts = {}) Load arbitrary text ([toml format](https://github.com/toml-lang/toml)) The toml is parsed by https://github.com/fbernier/tomlrb . @@ -54,11 +54,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/0dca183c11919f20bff1acb7f04138ed6e678ca6/lib/appium_lib/appium.rb#L85) +##### [expand_required_files](https://github.com/appium/ruby_lib/blob/024167c78c20a817861528ae4d3b80d41ea82590/lib/appium_lib/appium.rb#L85) > def expand_required_files(base_dir, file_paths) @@ -72,11 +72,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Array] list of require files as an array, nil if require doesn't exist -- -##### [promote_singleton_appium_methods](https://github.com/appium/ruby_lib/blob/0dca183c11919f20bff1acb7f04138ed6e678ca6/lib/appium_lib/appium.rb#L127) +##### [promote_singleton_appium_methods](https://github.com/appium/ruby_lib/blob/024167c78c20a817861528ae4d3b80d41ea82590/lib/appium_lib/appium.rb#L127) > def promote_singleton_appium_methods(modules, driver = $driver) This method is intended to work with page objects that share a common module. For example, Page::HomePage, Page::SignIn @@ -96,11 +96,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Driver] driver - A driver to extend for -- -##### [promote_appium_methods](https://github.com/appium/ruby_lib/blob/0dca183c11919f20bff1acb7f04138ed6e678ca6/lib/appium_lib/appium.rb#L182) +##### [promote_appium_methods](https://github.com/appium/ruby_lib/blob/024167c78c20a817861528ae4d3b80d41ea82590/lib/appium_lib/appium.rb#L182) > def promote_appium_methods(class_array, driver = $driver) Promote appium methods to class instance methods @@ -114,175 +114,175 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Driver] driver - A driver to extend for -- -##### [global_webdriver_http_sleep](https://github.com/appium/ruby_lib/blob/0dca183c11919f20bff1acb7f04138ed6e678ca6/lib/appium_lib/driver.rb#L36) +##### [global_webdriver_http_sleep](https://github.com/appium/ruby_lib/blob/024167c78c20a817861528ae4d3b80d41ea82590/lib/appium_lib/driver.rb#L36) > 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/0dca183c11919f20bff1acb7f04138ed6e678ca6/lib/appium_lib/driver.rb#L36) +##### [global_webdriver_http_sleep=](https://github.com/appium/ruby_lib/blob/024167c78c20a817861528ae4d3b80d41ea82590/lib/appium_lib/driver.rb#L36) > def global_webdriver_http_sleep=(value) The amount to sleep in seconds before every webdriver http call. -- -##### [sauce](https://github.com/appium/ruby_lib/blob/0dca183c11919f20bff1acb7f04138ed6e678ca6/lib/appium_lib/driver.rb#L39) +##### [sauce](https://github.com/appium/ruby_lib/blob/024167c78c20a817861528ae4d3b80d41ea82590/lib/appium_lib/driver.rb#L39) > def sauce SauceLab's settings -- -##### [sauce_username](https://github.com/appium/ruby_lib/blob/0dca183c11919f20bff1acb7f04138ed6e678ca6/lib/appium_lib/driver.rb#L42) +##### [sauce_username](https://github.com/appium/ruby_lib/blob/024167c78c20a817861528ae4d3b80d41ea82590/lib/appium_lib/driver.rb#L42) > def sauce_username Username for use on Sauce Labs. Set `false` to disable Sauce, even when SAUCE_USERNAME is in ENV. same as @sauce.username -- -##### [sauce_access_key](https://github.com/appium/ruby_lib/blob/0dca183c11919f20bff1acb7f04138ed6e678ca6/lib/appium_lib/driver.rb#L45) +##### [sauce_access_key](https://github.com/appium/ruby_lib/blob/024167c78c20a817861528ae4d3b80d41ea82590/lib/appium_lib/driver.rb#L45) > def sauce_access_key Access Key for use on Sauce Labs. Set `false` to disable Sauce, even when SAUCE_ACCESS_KEY is in ENV. same as @sauce.access_key -- -##### [sauce_endpoint](https://github.com/appium/ruby_lib/blob/0dca183c11919f20bff1acb7f04138ed6e678ca6/lib/appium_lib/driver.rb#L48) +##### [sauce_endpoint](https://github.com/appium/ruby_lib/blob/024167c78c20a817861528ae4d3b80d41ea82590/lib/appium_lib/driver.rb#L48) > def sauce_endpoint Override the Sauce Appium endpoint to allow e.g. TestObject tests same as @sauce.endpoint -- -##### [caps](https://github.com/appium/ruby_lib/blob/0dca183c11919f20bff1acb7f04138ed6e678ca6/lib/appium_lib/driver.rb#L52) +##### [caps](https://github.com/appium/ruby_lib/blob/024167c78c20a817861528ae4d3b80d41ea82590/lib/appium_lib/driver.rb#L52) > def caps from Core read http://www.rubydoc.info/github/appium/ruby_lib_core/Appium/Core/Driver -- -##### [custom_url](https://github.com/appium/ruby_lib/blob/0dca183c11919f20bff1acb7f04138ed6e678ca6/lib/appium_lib/driver.rb#L53) +##### [custom_url](https://github.com/appium/ruby_lib/blob/024167c78c20a817861528ae4d3b80d41ea82590/lib/appium_lib/driver.rb#L53) > def custom_url Returns the value of attribute custom_url -- -##### [export_session](https://github.com/appium/ruby_lib/blob/0dca183c11919f20bff1acb7f04138ed6e678ca6/lib/appium_lib/driver.rb#L54) +##### [export_session](https://github.com/appium/ruby_lib/blob/024167c78c20a817861528ae4d3b80d41ea82590/lib/appium_lib/driver.rb#L54) > def export_session Returns the value of attribute export_session -- -##### [export_session_path](https://github.com/appium/ruby_lib/blob/0dca183c11919f20bff1acb7f04138ed6e678ca6/lib/appium_lib/driver.rb#L55) +##### [export_session_path](https://github.com/appium/ruby_lib/blob/024167c78c20a817861528ae4d3b80d41ea82590/lib/appium_lib/driver.rb#L55) > def export_session_path Returns the value of attribute export_session_path -- -##### [default_wait](https://github.com/appium/ruby_lib/blob/0dca183c11919f20bff1acb7f04138ed6e678ca6/lib/appium_lib/driver.rb#L56) +##### [default_wait](https://github.com/appium/ruby_lib/blob/024167c78c20a817861528ae4d3b80d41ea82590/lib/appium_lib/driver.rb#L56) > def default_wait Returns the value of attribute default_wait -- -##### [appium_port](https://github.com/appium/ruby_lib/blob/0dca183c11919f20bff1acb7f04138ed6e678ca6/lib/appium_lib/driver.rb#L57) +##### [appium_port](https://github.com/appium/ruby_lib/blob/024167c78c20a817861528ae4d3b80d41ea82590/lib/appium_lib/driver.rb#L57) > def appium_port Returns the value of attribute appium_port -- -##### [appium_device](https://github.com/appium/ruby_lib/blob/0dca183c11919f20bff1acb7f04138ed6e678ca6/lib/appium_lib/driver.rb#L58) +##### [appium_device](https://github.com/appium/ruby_lib/blob/024167c78c20a817861528ae4d3b80d41ea82590/lib/appium_lib/driver.rb#L58) > def appium_device Returns the value of attribute appium_device -- -##### [automation_name](https://github.com/appium/ruby_lib/blob/0dca183c11919f20bff1acb7f04138ed6e678ca6/lib/appium_lib/driver.rb#L59) +##### [automation_name](https://github.com/appium/ruby_lib/blob/024167c78c20a817861528ae4d3b80d41ea82590/lib/appium_lib/driver.rb#L59) > def automation_name Returns the value of attribute automation_name -- -##### [listener](https://github.com/appium/ruby_lib/blob/0dca183c11919f20bff1acb7f04138ed6e678ca6/lib/appium_lib/driver.rb#L60) +##### [listener](https://github.com/appium/ruby_lib/blob/024167c78c20a817861528ae4d3b80d41ea82590/lib/appium_lib/driver.rb#L60) > def listener Returns the value of attribute listener -- -##### [http_client](https://github.com/appium/ruby_lib/blob/0dca183c11919f20bff1acb7f04138ed6e678ca6/lib/appium_lib/driver.rb#L61) +##### [http_client](https://github.com/appium/ruby_lib/blob/024167c78c20a817861528ae4d3b80d41ea82590/lib/appium_lib/driver.rb#L61) > def http_client Returns the value of attribute http_client -- -##### [appium_wait_timeout](https://github.com/appium/ruby_lib/blob/0dca183c11919f20bff1acb7f04138ed6e678ca6/lib/appium_lib/driver.rb#L62) +##### [appium_wait_timeout](https://github.com/appium/ruby_lib/blob/024167c78c20a817861528ae4d3b80d41ea82590/lib/appium_lib/driver.rb#L62) > def appium_wait_timeout Returns the value of attribute appium_wait_timeout -- -##### [appium_wait_interval](https://github.com/appium/ruby_lib/blob/0dca183c11919f20bff1acb7f04138ed6e678ca6/lib/appium_lib/driver.rb#L63) +##### [appium_wait_interval](https://github.com/appium/ruby_lib/blob/024167c78c20a817861528ae4d3b80d41ea82590/lib/appium_lib/driver.rb#L63) > def appium_wait_interval Returns the value of attribute appium_wait_interval -- -##### [appium_server_status](https://github.com/appium/ruby_lib/blob/0dca183c11919f20bff1acb7f04138ed6e678ca6/lib/appium_lib/driver.rb#L66) +##### [appium_server_status](https://github.com/appium/ruby_lib/blob/024167c78c20a817861528ae4d3b80d41ea82590/lib/appium_lib/driver.rb#L66) > def appium_server_status Appium's server version -- -##### [appium_debug](https://github.com/appium/ruby_lib/blob/0dca183c11919f20bff1acb7f04138ed6e678ca6/lib/appium_lib/driver.rb#L68) +##### [appium_debug](https://github.com/appium/ruby_lib/blob/024167c78c20a817861528ae4d3b80d41ea82590/lib/appium_lib/driver.rb#L68) > def appium_debug Boolean debug mode for the Appium Ruby bindings -- -##### [driver](https://github.com/appium/ruby_lib/blob/0dca183c11919f20bff1acb7f04138ed6e678ca6/lib/appium_lib/driver.rb#L71) +##### [driver](https://github.com/appium/ruby_lib/blob/024167c78c20a817861528ae4d3b80d41ea82590/lib/appium_lib/driver.rb#L71) > def driver Returns the driver @@ -290,19 +290,19 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Driver] the driver -- -##### [core](https://github.com/appium/ruby_lib/blob/0dca183c11919f20bff1acb7f04138ed6e678ca6/lib/appium_lib/driver.rb#L73) +##### [core](https://github.com/appium/ruby_lib/blob/024167c78c20a817861528ae4d3b80d41ea82590/lib/appium_lib/driver.rb#L73) > def core Instance of Appium::Core::Driver -- -##### [initialize](https://github.com/appium/ruby_lib/blob/0dca183c11919f20bff1acb7f04138ed6e678ca6/lib/appium_lib/driver.rb#L141) +##### [initialize](https://github.com/appium/ruby_lib/blob/024167c78c20a817861528ae4d3b80d41ea82590/lib/appium_lib/driver.rb#L141) > def initialize(opts = {}, global_driver = nil) Creates a new driver. The driver is defined as global scope by default. We can avoid defining global driver. @@ -317,19 +317,19 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Driver] -- -##### [driver_attributes](https://github.com/appium/ruby_lib/blob/0dca183c11919f20bff1acb7f04138ed6e678ca6/lib/appium_lib/driver.rb#L251) +##### [driver_attributes](https://github.com/appium/ruby_lib/blob/024167c78c20a817861528ae4d3b80d41ea82590/lib/appium_lib/driver.rb#L251) > def driver_attributes Returns a hash of the driver attributes -- -##### [device_is_android?](https://github.com/appium/ruby_lib/blob/0dca183c11919f20bff1acb7f04138ed6e678ca6/lib/appium_lib/driver.rb#L271) +##### [device_is_android?](https://github.com/appium/ruby_lib/blob/024167c78c20a817861528ae4d3b80d41ea82590/lib/appium_lib/driver.rb#L271) > def device_is_android? @@ -337,11 +337,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Boolean] -- -##### [device_is_ios?](https://github.com/appium/ruby_lib/blob/0dca183c11919f20bff1acb7f04138ed6e678ca6/lib/appium_lib/driver.rb#L275) +##### [device_is_ios?](https://github.com/appium/ruby_lib/blob/024167c78c20a817861528ae4d3b80d41ea82590/lib/appium_lib/driver.rb#L275) > def device_is_ios? @@ -349,11 +349,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Boolean] -- -##### [device_is_windows?](https://github.com/appium/ruby_lib/blob/0dca183c11919f20bff1acb7f04138ed6e678ca6/lib/appium_lib/driver.rb#L279) +##### [device_is_windows?](https://github.com/appium/ruby_lib/blob/024167c78c20a817861528ae4d3b80d41ea82590/lib/appium_lib/driver.rb#L279) > def device_is_windows? @@ -361,11 +361,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Boolean] -- -##### [automation_name_is_uiautomator2?](https://github.com/appium/ruby_lib/blob/0dca183c11919f20bff1acb7f04138ed6e678ca6/lib/appium_lib/driver.rb#L285) +##### [automation_name_is_uiautomator2?](https://github.com/appium/ruby_lib/blob/024167c78c20a817861528ae4d3b80d41ea82590/lib/appium_lib/driver.rb#L285) > def automation_name_is_uiautomator2? Return true if automationName is 'uiautomator2' @@ -373,11 +373,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Boolean] -- -##### [automation_name_is_espresso?](https://github.com/appium/ruby_lib/blob/0dca183c11919f20bff1acb7f04138ed6e678ca6/lib/appium_lib/driver.rb#L291) +##### [automation_name_is_espresso?](https://github.com/appium/ruby_lib/blob/024167c78c20a817861528ae4d3b80d41ea82590/lib/appium_lib/driver.rb#L291) > def automation_name_is_espresso? Return true if automationName is 'Espresso' @@ -385,11 +385,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Boolean] -- -##### [automation_name_is_xcuitest?](https://github.com/appium/ruby_lib/blob/0dca183c11919f20bff1acb7f04138ed6e678ca6/lib/appium_lib/driver.rb#L297) +##### [automation_name_is_xcuitest?](https://github.com/appium/ruby_lib/blob/024167c78c20a817861528ae4d3b80d41ea82590/lib/appium_lib/driver.rb#L297) > def automation_name_is_xcuitest? Return true if automationName is 'XCUITest' @@ -397,11 +397,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Boolean] -- -##### [dialect](https://github.com/appium/ruby_lib/blob/0dca183c11919f20bff1acb7f04138ed6e678ca6/lib/appium_lib/driver.rb#L317) +##### [dialect](https://github.com/appium/ruby_lib/blob/024167c78c20a817861528ae4d3b80d41ea82590/lib/appium_lib/driver.rb#L317) > def dialect Get the dialect value whether current driver is OSS or W3C @@ -419,11 +419,11 @@ action.perform end -- -##### [check_server_version_xcuitest](https://github.com/appium/ruby_lib/blob/0dca183c11919f20bff1acb7f04138ed6e678ca6/lib/appium_lib/driver.rb#L324) +##### [check_server_version_xcuitest](https://github.com/appium/ruby_lib/blob/024167c78c20a817861528ae4d3b80d41ea82590/lib/appium_lib/driver.rb#L324) > 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. @@ -432,11 +432,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Boolean] -- -##### [appium_server_version](https://github.com/appium/ruby_lib/blob/0dca183c11919f20bff1acb7f04138ed6e678ca6/lib/appium_lib/driver.rb#L345) +##### [appium_server_version](https://github.com/appium/ruby_lib/blob/024167c78c20a817861528ae4d3b80d41ea82590/lib/appium_lib/driver.rb#L345) > def appium_server_version Returns the server's version info @@ -444,11 +444,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Hash] -- -##### [remote_status](https://github.com/appium/ruby_lib/blob/0dca183c11919f20bff1acb7f04138ed6e678ca6/lib/appium_lib/driver.rb#L352) +##### [remote_status](https://github.com/appium/ruby_lib/blob/024167c78c20a817861528ae4d3b80d41ea82590/lib/appium_lib/driver.rb#L352) > def appium_server_version Returns the server's version info @@ -456,11 +456,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Hash] -- -##### [platform_version](https://github.com/appium/ruby_lib/blob/0dca183c11919f20bff1acb7f04138ed6e678ca6/lib/appium_lib/driver.rb#L356) +##### [platform_version](https://github.com/appium/ruby_lib/blob/024167c78c20a817861528ae4d3b80d41ea82590/lib/appium_lib/driver.rb#L356) > def platform_version Return the platform version as an array of integers @@ -468,11 +468,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Array<Integer>] -- -##### [appium_client_version](https://github.com/appium/ruby_lib/blob/0dca183c11919f20bff1acb7f04138ed6e678ca6/lib/appium_lib/driver.rb#L369) +##### [appium_client_version](https://github.com/appium/ruby_lib/blob/024167c78c20a817861528ae4d3b80d41ea82590/lib/appium_lib/driver.rb#L369) > def appium_client_version Returns the client's version info @@ -480,11 +480,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Hash] -- -##### [absolute_app_path](https://github.com/appium/ruby_lib/blob/0dca183c11919f20bff1acb7f04138ed6e678ca6/lib/appium_lib/driver.rb#L381) +##### [absolute_app_path](https://github.com/appium/ruby_lib/blob/024167c78c20a817861528ae4d3b80d41ea82590/lib/appium_lib/driver.rb#L381) > def self.absolute_app_path(opts) Converts app_path to an absolute path. @@ -497,11 +497,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[String] APP_PATH as an absolute path -- -##### [server_url](https://github.com/appium/ruby_lib/blob/0dca183c11919f20bff1acb7f04138ed6e678ca6/lib/appium_lib/driver.rb#L414) +##### [server_url](https://github.com/appium/ruby_lib/blob/024167c78c20a817861528ae4d3b80d41ea82590/lib/appium_lib/driver.rb#L414) > def server_url Get the server url @@ -509,11 +509,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[String] the server url -- -##### [restart](https://github.com/appium/ruby_lib/blob/0dca183c11919f20bff1acb7f04138ed6e678ca6/lib/appium_lib/driver.rb#L422) +##### [restart](https://github.com/appium/ruby_lib/blob/024167c78c20a817861528ae4d3b80d41ea82590/lib/appium_lib/driver.rb#L422) > def restart Restarts the driver @@ -521,11 +521,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Driver] the driver -- -##### [screenshot](https://github.com/appium/ruby_lib/blob/0dca183c11919f20bff1acb7f04138ed6e678ca6/lib/appium_lib/driver.rb#L435) +##### [screenshot](https://github.com/appium/ruby_lib/blob/024167c78c20a817861528ae4d3b80d41ea82590/lib/appium_lib/driver.rb#L435) > def screenshot(png_save_path) Takes a png screenshot and saves to the target path. @@ -537,11 +537,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[File] -- -##### [element_screenshot](https://github.com/appium/ruby_lib/blob/0dca183c11919f20bff1acb7f04138ed6e678ca6/lib/appium_lib/driver.rb#L449) +##### [element_screenshot](https://github.com/appium/ruby_lib/blob/024167c78c20a817861528ae4d3b80d41ea82590/lib/appium_lib/driver.rb#L449) > def element_screenshot(element, png_save_path) Takes a png screenshot of particular element's area @@ -555,11 +555,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[File] -- -##### [driver_quit](https://github.com/appium/ruby_lib/blob/0dca183c11919f20bff1acb7f04138ed6e678ca6/lib/appium_lib/driver.rb#L456) +##### [driver_quit](https://github.com/appium/ruby_lib/blob/024167c78c20a817861528ae4d3b80d41ea82590/lib/appium_lib/driver.rb#L456) > def driver_quit Quits the driver @@ -567,11 +567,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[void] -- -##### [quit_driver](https://github.com/appium/ruby_lib/blob/0dca183c11919f20bff1acb7f04138ed6e678ca6/lib/appium_lib/driver.rb#L459) +##### [quit_driver](https://github.com/appium/ruby_lib/blob/024167c78c20a817861528ae4d3b80d41ea82590/lib/appium_lib/driver.rb#L459) > def driver_quit Quits the driver @@ -579,11 +579,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[void] -- -##### [window_size](https://github.com/appium/ruby_lib/blob/0dca183c11919f20bff1acb7f04138ed6e678ca6/lib/appium_lib/driver.rb#L470) +##### [window_size](https://github.com/appium/ruby_lib/blob/024167c78c20a817861528ae4d3b80d41ea82590/lib/appium_lib/driver.rb#L470) > def window_size Get the device window's size. @@ -591,11 +591,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Selenium::WebDriver::Dimension] -- -##### [start_driver](https://github.com/appium/ruby_lib/blob/0dca183c11919f20bff1acb7f04138ed6e678ca6/lib/appium_lib/driver.rb#L503) +##### [start_driver](https://github.com/appium/ruby_lib/blob/024167c78c20a817861528ae4d3b80d41ea82590/lib/appium_lib/driver.rb#L503) > def start_driver(http_client_ops = Creates a new global driver and quits the old one if it exists. You can customise http_client as the following @@ -611,27 +611,27 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Selenium::WebDriver] the new global driver -- -##### [set_implicit_wait](https://github.com/appium/ruby_lib/blob/0dca183c11919f20bff1acb7f04138ed6e678ca6/lib/appium_lib/driver.rb#L525) +##### [set_implicit_wait](https://github.com/appium/ruby_lib/blob/024167c78c20a817861528ae4d3b80d41ea82590/lib/appium_lib/driver.rb#L525) > def set_implicit_wait(wait) To ignore error for Espresso Driver -- -##### [no_wait](https://github.com/appium/ruby_lib/blob/0dca183c11919f20bff1acb7f04138ed6e678ca6/lib/appium_lib/driver.rb#L535) +##### [no_wait](https://github.com/appium/ruby_lib/blob/024167c78c20a817861528ae4d3b80d41ea82590/lib/appium_lib/driver.rb#L535) > def no_wait Set implicit wait to zero. -- -##### [set_wait](https://github.com/appium/ruby_lib/blob/0dca183c11919f20bff1acb7f04138ed6e678ca6/lib/appium_lib/driver.rb#L549) +##### [set_wait](https://github.com/appium/ruby_lib/blob/024167c78c20a817861528ae4d3b80d41ea82590/lib/appium_lib/driver.rb#L549) > def set_wait(timeout = nil) Set implicit wait. Default to @core.default_wait. @@ -643,11 +643,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[void] -- -##### [exists](https://github.com/appium/ruby_lib/blob/0dca183c11919f20bff1acb7f04138ed6e678ca6/lib/appium_lib/driver.rb#L566) +##### [exists](https://github.com/appium/ruby_lib/blob/024167c78c20a817861528ae4d3b80d41ea82590/lib/appium_lib/driver.rb#L566) > def exists(pre_check = 0, post_check = @core.default_wait) Returns existence of element. @@ -667,11 +667,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Boolean] -- -##### [execute_script](https://github.com/appium/ruby_lib/blob/0dca183c11919f20bff1acb7f04138ed6e678ca6/lib/appium_lib/driver.rb#L590) +##### [execute_script](https://github.com/appium/ruby_lib/blob/024167c78c20a817861528ae4d3b80d41ea82590/lib/appium_lib/driver.rb#L590) > def execute_script(script, *args) The same as @driver.execute_script @@ -685,11 +685,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Object] -- -##### [find_elements](https://github.com/appium/ruby_lib/blob/0dca183c11919f20bff1acb7f04138ed6e678ca6/lib/appium_lib/driver.rb#L614) +##### [find_elements](https://github.com/appium/ruby_lib/blob/024167c78c20a817861528ae4d3b80d41ea82590/lib/appium_lib/driver.rb#L614) > def find_elements(*args) Calls @driver.find_elements_with_appium @@ -705,11 +705,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/0dca183c11919f20bff1acb7f04138ed6e678ca6/lib/appium_lib/driver.rb#L630) +##### [find_element](https://github.com/appium/ruby_lib/blob/024167c78c20a817861528ae4d3b80d41ea82590/lib/appium_lib/driver.rb#L630) > def find_element(*args) Calls @driver.find_element @@ -723,12 +723,62 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Element] -- -##### [set_location](https://github.com/appium/ruby_lib/blob/0dca183c11919f20bff1acb7f04138ed6e678ca6/lib/appium_lib/driver.rb#L643) +##### [DEFAULT_MATCH_THRESHOLD](https://github.com/appium/ruby_lib/blob/024167c78c20a817861528ae4d3b80d41ea82590/lib/appium_lib/driver.rb#L648) +> DEFAULT_MATCH_THRESHOLD = 0.5 + +Return ImageElement if current view has a partial image + +__Parameters:__ + +&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[String] png_img_path - A path to a partial image you'd like to find + +&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Flood] match_threshold - At what normalized threshold to reject + +&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Bool] visualize - Makes the endpoint to return an image, which contains the visualized result of +the corresponding picture matching operation. This option is disabled by default. + +__Returns:__ + +&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[::Appium::Core::ImageElement] + +-- + +##### [find_element_by_image](https://github.com/appium/ruby_lib/blob/024167c78c20a817861528ae4d3b80d41ea82590/lib/appium_lib/driver.rb#L649) + +> def find_element_by_image(png_img_path, match_threshold: DEFAULT_MATCH_THRESHOLD, visualize: false) + + + +-- + +##### [find_elements_by_image](https://github.com/appium/ruby_lib/blob/024167c78c20a817861528ae4d3b80d41ea82590/lib/appium_lib/driver.rb#L667) + +> def find_elements_by_image(png_img_paths, match_threshold: DEFAULT_MATCH_THRESHOLD, visualize: false) + +Return ImageElement if current view has partial images + +__Parameters:__ + +&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[[String]] png_img_paths - Paths to a partial image you'd like to find + +&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Flood] match_threshold - At what normalized threshold to reject + +&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Bool] visualize - Makes the endpoint to return an image, which contains the visualized result of +the corresponding picture matching operation. This option is disabled by default. + +__Returns:__ + +&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[[::Appium::Core::ImageElement]] + +-- + +##### [set_location](https://github.com/appium/ruby_lib/blob/024167c78c20a817861528ae4d3b80d41ea82590/lib/appium_lib/driver.rb#L680) + > def set_location(opts = {}) Calls @driver.set_location __Parameters:__ @@ -739,11 +789,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Selenium::WebDriver::Location] the location constructed by the selenium webdriver -- -##### [x](https://github.com/appium/ruby_lib/blob/0dca183c11919f20bff1acb7f04138ed6e678ca6/lib/appium_lib/driver.rb#L653) +##### [x](https://github.com/appium/ruby_lib/blob/024167c78c20a817861528ae4d3b80d41ea82590/lib/appium_lib/driver.rb#L690) > def x Quit the driver and Pry. quit and exit are reserved by Pry. @@ -752,35 +802,35 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[void] -- -##### [username](https://github.com/appium/ruby_lib/blob/0dca183c11919f20bff1acb7f04138ed6e678ca6/lib/appium_lib/sauce_labs.rb#L4) +##### [username](https://github.com/appium/ruby_lib/blob/024167c78c20a817861528ae4d3b80d41ea82590/lib/appium_lib/sauce_labs.rb#L4) > def username Username for use on Sauce Labs. Set `false` to disable Sauce, even when SAUCE_USERNAME is in ENV. -- -##### [access_key](https://github.com/appium/ruby_lib/blob/0dca183c11919f20bff1acb7f04138ed6e678ca6/lib/appium_lib/sauce_labs.rb#L6) +##### [access_key](https://github.com/appium/ruby_lib/blob/024167c78c20a817861528ae4d3b80d41ea82590/lib/appium_lib/sauce_labs.rb#L6) > def access_key Access Key for use on Sauce Labs. Set `false` to disable Sauce, even when SAUCE_ACCESS_KEY is in ENV. -- -##### [endpoint](https://github.com/appium/ruby_lib/blob/0dca183c11919f20bff1acb7f04138ed6e678ca6/lib/appium_lib/sauce_labs.rb#L8) +##### [endpoint](https://github.com/appium/ruby_lib/blob/024167c78c20a817861528ae4d3b80d41ea82590/lib/appium_lib/sauce_labs.rb#L8) > def endpoint Override the Sauce Appium endpoint to allow e.g. TestObject tests. Default is 'ondemand.saucelabs.com:443/wd/hub'. -- -##### [initialize](https://github.com/appium/ruby_lib/blob/0dca183c11919f20bff1acb7f04138ed6e678ca6/lib/appium_lib/sauce_labs.rb#L33) +##### [initialize](https://github.com/appium/ruby_lib/blob/024167c78c20a817861528ae4d3b80d41ea82590/lib/appium_lib/sauce_labs.rb#L33) > def initialize(appium_lib_opts) Create a SauceLabs instance to manage sauce labs related attributes. @@ -792,11 +842,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Appium::SauceLabs] -- -##### [sauce_server_url?](https://github.com/appium/ruby_lib/blob/0dca183c11919f20bff1acb7f04138ed6e678ca6/lib/appium_lib/sauce_labs.rb#L53) +##### [sauce_server_url?](https://github.com/appium/ruby_lib/blob/024167c78c20a817861528ae4d3b80d41ea82590/lib/appium_lib/sauce_labs.rb#L53) > def sauce_server_url? Return true if an instance of Appium::SauceLabs has sauce_username and sauce_access_key. @@ -804,11 +854,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Boolean] -- -##### [server_url](https://github.com/appium/ruby_lib/blob/0dca183c11919f20bff1acb7f04138ed6e678ca6/lib/appium_lib/sauce_labs.rb#L66) +##### [server_url](https://github.com/appium/ruby_lib/blob/024167c78c20a817861528ae4d3b80d41ea82590/lib/appium_lib/sauce_labs.rb#L66) > def server_url Return a particular server url to access to. Default is the local address. @@ -816,11 +866,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[String] -- -##### [get_log](https://github.com/appium/ruby_lib/blob/0dca183c11919f20bff1acb7f04138ed6e678ca6/lib/appium_lib/common/log.rb#L11) +##### [get_log](https://github.com/appium/ruby_lib/blob/024167c78c20a817861528ae4d3b80d41ea82590/lib/appium_lib/common/log.rb#L11) > def get_log(type) @@ -832,11 +882,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[[Selenium::WebDriver::LogEntry]] A list of logs data. -- -##### [get_available_log_types](https://github.com/appium/ruby_lib/blob/0dca183c11919f20bff1acb7f04138ed6e678ca6/lib/appium_lib/common/log.rb#L23) +##### [get_available_log_types](https://github.com/appium/ruby_lib/blob/024167c78c20a817861528ae4d3b80d41ea82590/lib/appium_lib/common/log.rb#L23) > def get_available_log_types Get a list of available log types @@ -844,11 +894,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[[String]] A list of available log types. -- -##### [wait_true](https://github.com/appium/ruby_lib/blob/0dca183c11919f20bff1acb7f04138ed6e678ca6/lib/appium_lib/common/wait.rb#L30) +##### [wait_true](https://github.com/appium/ruby_lib/blob/024167c78c20a817861528ae4d3b80d41ea82590/lib/appium_lib/common/wait.rb#L30) > def wait_true(opts = {}) 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. @@ -864,11 +914,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Hash|Numeric] opts - Options. If the value is _Numeric_, the value is set as `{ timeout: value }` -- -##### [wait](https://github.com/appium/ruby_lib/blob/0dca183c11919f20bff1acb7f04138ed6e678ca6/lib/appium_lib/common/wait.rb#L59) +##### [wait](https://github.com/appium/ruby_lib/blob/024167c78c20a817861528ae4d3b80d41ea82590/lib/appium_lib/common/wait.rb#L59) > def wait(opts = {}) Check every interval seconds to see if yield doesn't raise an exception. Give up after timeout seconds. @@ -882,35 +932,35 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Hash|Numeric] opts - Options. If the value is _Numeric_, the value is set as `{ timeout: value }` -- -##### [add_touch_actions](https://github.com/appium/ruby_lib/blob/0dca183c11919f20bff1acb7f04138ed6e678ca6/lib/appium_lib/common/device.rb#L12) +##### [add_touch_actions](https://github.com/appium/ruby_lib/blob/024167c78c20a817861528ae4d3b80d41ea82590/lib/appium_lib/common/device.rb#L12) > def add_touch_actions -- -##### [delegate_from_appium_driver](https://github.com/appium/ruby_lib/blob/0dca183c11919f20bff1acb7f04138ed6e678ca6/lib/appium_lib/common/device.rb#L24) +##### [delegate_from_appium_driver](https://github.com/appium/ruby_lib/blob/024167c78c20a817861528ae4d3b80d41ea82590/lib/appium_lib/common/device.rb#L24) > def delegate_from_appium_driver(method, delegation_target) -- -##### [ignore](https://github.com/appium/ruby_lib/blob/0dca183c11919f20bff1acb7f04138ed6e678ca6/lib/appium_lib/common/helper.rb#L16) +##### [ignore](https://github.com/appium/ruby_lib/blob/024167c78c20a817861528ae4d3b80d41ea82590/lib/appium_lib/common/helper.rb#L16) > def ignore Return yield and ignore any exceptions. -- -##### [back](https://github.com/appium/ruby_lib/blob/0dca183c11919f20bff1acb7f04138ed6e678ca6/lib/appium_lib/common/helper.rb#L23) +##### [back](https://github.com/appium/ruby_lib/blob/024167c78c20a817861528ae4d3b80d41ea82590/lib/appium_lib/common/helper.rb#L23) > def back Navigate back. @@ -918,11 +968,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[void] -- -##### [session_id](https://github.com/appium/ruby_lib/blob/0dca183c11919f20bff1acb7f04138ed6e678ca6/lib/appium_lib/common/helper.rb#L34) +##### [session_id](https://github.com/appium/ruby_lib/blob/024167c78c20a817861528ae4d3b80d41ea82590/lib/appium_lib/common/helper.rb#L34) > def session_id For Sauce Labs reporting. Returns the current session id. @@ -930,11 +980,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[String] -- -##### [xpath](https://github.com/appium/ruby_lib/blob/0dca183c11919f20bff1acb7f04138ed6e678ca6/lib/appium_lib/common/helper.rb#L42) +##### [xpath](https://github.com/appium/ruby_lib/blob/024167c78c20a817861528ae4d3b80d41ea82590/lib/appium_lib/common/helper.rb#L42) > def xpath(xpath_str) Returns the first element that matches the provided xpath. @@ -946,11 +996,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Element] -- -##### [xpaths](https://github.com/appium/ruby_lib/blob/0dca183c11919f20bff1acb7f04138ed6e678ca6/lib/appium_lib/common/helper.rb#L50) +##### [xpaths](https://github.com/appium/ruby_lib/blob/024167c78c20a817861528ae4d3b80d41ea82590/lib/appium_lib/common/helper.rb#L50) > def xpaths(xpath_str) Returns all elements that match the provided xpath. @@ -962,19 +1012,19 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Array<Element>] -- -##### [result](https://github.com/appium/ruby_lib/blob/0dca183c11919f20bff1acb7f04138ed6e678ca6/lib/appium_lib/common/helper.rb#L60) +##### [result](https://github.com/appium/ruby_lib/blob/024167c78c20a817861528ae4d3b80d41ea82590/lib/appium_lib/common/helper.rb#L60) > def result Returns the value of attribute result -- -##### [initialize](https://github.com/appium/ruby_lib/blob/0dca183c11919f20bff1acb7f04138ed6e678ca6/lib/appium_lib/common/helper.rb#L62) +##### [initialize](https://github.com/appium/ruby_lib/blob/024167c78c20a817861528ae4d3b80d41ea82590/lib/appium_lib/common/helper.rb#L62) > def initialize @@ -982,35 +1032,35 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[CountElements] a new instance of CountElements -- -##### [reset](https://github.com/appium/ruby_lib/blob/0dca183c11919f20bff1acb7f04138ed6e678ca6/lib/appium_lib/common/helper.rb#L66) +##### [reset](https://github.com/appium/ruby_lib/blob/024167c78c20a817861528ae4d3b80d41ea82590/lib/appium_lib/common/helper.rb#L66) > def reset -- -##### [start_element](https://github.com/appium/ruby_lib/blob/0dca183c11919f20bff1acb7f04138ed6e678ca6/lib/appium_lib/common/helper.rb#L71) +##### [start_element](https://github.com/appium/ruby_lib/blob/024167c78c20a817861528ae4d3b80d41ea82590/lib/appium_lib/common/helper.rb#L71) > def start_element(name, attrs = [], driver = $driver) http://nokogiri.org/Nokogiri/XML/SAX/Document.html -- -##### [formatted_result](https://github.com/appium/ruby_lib/blob/0dca183c11919f20bff1acb7f04138ed6e678ca6/lib/appium_lib/common/helper.rb#L77) +##### [formatted_result](https://github.com/appium/ruby_lib/blob/024167c78c20a817861528ae4d3b80d41ea82590/lib/appium_lib/common/helper.rb#L77) > def formatted_result -- -##### [get_page_class](https://github.com/appium/ruby_lib/blob/0dca183c11919f20bff1acb7f04138ed6e678ca6/lib/appium_lib/common/helper.rb#L96) +##### [get_page_class](https://github.com/appium/ruby_lib/blob/024167c78c20a817861528ae4d3b80d41ea82590/lib/appium_lib/common/helper.rb#L96) > def get_page_class Returns a string of class counts of visible elements. @@ -1018,11 +1068,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[String] -- -##### [page_class](https://github.com/appium/ruby_lib/blob/0dca183c11919f20bff1acb7f04138ed6e678ca6/lib/appium_lib/common/helper.rb#L121) +##### [page_class](https://github.com/appium/ruby_lib/blob/024167c78c20a817861528ae4d3b80d41ea82590/lib/appium_lib/common/helper.rb#L121) > def page_class Count all classes on screen and print to stdout. Useful for appium_console. @@ -1031,11 +1081,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[nil] -- -##### [source](https://github.com/appium/ruby_lib/blob/0dca183c11919f20bff1acb7f04138ed6e678ca6/lib/appium_lib/common/helper.rb#L128) +##### [source](https://github.com/appium/ruby_lib/blob/024167c78c20a817861528ae4d3b80d41ea82590/lib/appium_lib/common/helper.rb#L128) > def source Prints xml of the current page @@ -1043,11 +1093,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[void] -- -##### [get_source](https://github.com/appium/ruby_lib/blob/0dca183c11919f20bff1acb7f04138ed6e678ca6/lib/appium_lib/common/helper.rb#L135) +##### [get_source](https://github.com/appium/ruby_lib/blob/024167c78c20a817861528ae4d3b80d41ea82590/lib/appium_lib/common/helper.rb#L135) > def get_source Returns XML string for the current page Same as driver.page_source @@ -1056,19 +1106,19 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[String] -- -##### [px_to_window_rel](https://github.com/appium/ruby_lib/blob/0dca183c11919f20bff1acb7f04138ed6e678ca6/lib/appium_lib/common/helper.rb#L145) +##### [px_to_window_rel](https://github.com/appium/ruby_lib/blob/024167c78c20a817861528ae4d3b80d41ea82590/lib/appium_lib/common/helper.rb#L145) > def px_to_window_rel(opts = {}, driver = $driver) Converts pixel values to window relative values -- -##### [xml_keys](https://github.com/appium/ruby_lib/blob/0dca183c11919f20bff1acb7f04138ed6e678ca6/lib/appium_lib/common/helper.rb#L164) +##### [xml_keys](https://github.com/appium/ruby_lib/blob/024167c78c20a817861528ae4d3b80d41ea82590/lib/appium_lib/common/helper.rb#L164) > def xml_keys(target) Search strings.xml's values for target. @@ -1080,11 +1130,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Array] -- -##### [xml_values](https://github.com/appium/ruby_lib/blob/0dca183c11919f20bff1acb7f04138ed6e678ca6/lib/appium_lib/common/helper.rb#L172) +##### [xml_values](https://github.com/appium/ruby_lib/blob/024167c78c20a817861528ae4d3b80d41ea82590/lib/appium_lib/common/helper.rb#L172) > def xml_values(target) Search strings.xml's keys for target. @@ -1096,11 +1146,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Array] -- -##### [resolve_id](https://github.com/appium/ruby_lib/blob/0dca183c11919f20bff1acb7f04138ed6e678ca6/lib/appium_lib/common/helper.rb#L180) +##### [resolve_id](https://github.com/appium/ruby_lib/blob/024167c78c20a817861528ae4d3b80d41ea82590/lib/appium_lib/common/helper.rb#L180) > def resolve_id(id) Resolve id in strings.xml and return the value. @@ -1112,27 +1162,27 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[String] -- -##### [filter](https://github.com/appium/ruby_lib/blob/0dca183c11919f20bff1acb7f04138ed6e678ca6/lib/appium_lib/common/helper.rb#L187) +##### [filter](https://github.com/appium/ruby_lib/blob/024167c78c20a817861528ae4d3b80d41ea82590/lib/appium_lib/common/helper.rb#L187) > def filter Returns the value of attribute filter -- -##### [filter=](https://github.com/appium/ruby_lib/blob/0dca183c11919f20bff1acb7f04138ed6e678ca6/lib/appium_lib/common/helper.rb#L190) +##### [filter=](https://github.com/appium/ruby_lib/blob/024167c78c20a817861528ae4d3b80d41ea82590/lib/appium_lib/common/helper.rb#L190) > def filter=(value) convert to string to support symbols -- -##### [initialize](https://github.com/appium/ruby_lib/blob/0dca183c11919f20bff1acb7f04138ed6e678ca6/lib/appium_lib/common/helper.rb#L196) +##### [initialize](https://github.com/appium/ruby_lib/blob/024167c78c20a817861528ae4d3b80d41ea82590/lib/appium_lib/common/helper.rb#L196) > def initialize @@ -1140,59 +1190,59 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[HTMLElements] a new instance of HTMLElements -- -##### [reset](https://github.com/appium/ruby_lib/blob/0dca183c11919f20bff1acb7f04138ed6e678ca6/lib/appium_lib/common/helper.rb#L201) +##### [reset](https://github.com/appium/ruby_lib/blob/024167c78c20a817861528ae4d3b80d41ea82590/lib/appium_lib/common/helper.rb#L201) > def reset -- -##### [result](https://github.com/appium/ruby_lib/blob/0dca183c11919f20bff1acb7f04138ed6e678ca6/lib/appium_lib/common/helper.rb#L207) +##### [result](https://github.com/appium/ruby_lib/blob/024167c78c20a817861528ae4d3b80d41ea82590/lib/appium_lib/common/helper.rb#L207) > def result -- -##### [start_element](https://github.com/appium/ruby_lib/blob/0dca183c11919f20bff1acb7f04138ed6e678ca6/lib/appium_lib/common/helper.rb#L223) +##### [start_element](https://github.com/appium/ruby_lib/blob/024167c78c20a817861528ae4d3b80d41ea82590/lib/appium_lib/common/helper.rb#L223) > def start_element(name, attrs = []) -- -##### [end_element](https://github.com/appium/ruby_lib/blob/0dca183c11919f20bff1acb7f04138ed6e678ca6/lib/appium_lib/common/helper.rb#L232) +##### [end_element](https://github.com/appium/ruby_lib/blob/024167c78c20a817861528ae4d3b80d41ea82590/lib/appium_lib/common/helper.rb#L232) > def end_element(name) -- -##### [characters](https://github.com/appium/ruby_lib/blob/0dca183c11919f20bff1acb7f04138ed6e678ca6/lib/appium_lib/common/helper.rb#L238) +##### [characters](https://github.com/appium/ruby_lib/blob/024167c78c20a817861528ae4d3b80d41ea82590/lib/appium_lib/common/helper.rb#L238) > def characters(chars) -- -##### [DEFAULT_HEADERS](https://github.com/appium/ruby_lib/blob/0dca183c11919f20bff1acb7f04138ed6e678ca6/lib/appium_lib/common/http_client.rb#L8) +##### [DEFAULT_HEADERS](https://github.com/appium/ruby_lib/blob/024167c78c20a817861528ae4d3b80d41ea82590/lib/appium_lib/common/http_client.rb#L8) > DEFAULT_HEADERS = { 'Accept' => CONTENT_TYPE, 'User-Agent' => "appium/ruby_lib/#{::Appium::VERSION}" }.freeze Default HTTP client inherit Appium::Core::Base::Http::Default, but has different DEFAULT_HEADERS -- -##### [pinch](https://github.com/appium/ruby_lib/blob/0dca183c11919f20bff1acb7f04138ed6e678ca6/lib/appium_lib/common/multi_touch.rb#L51) +##### [pinch](https://github.com/appium/ruby_lib/blob/024167c78c20a817861528ae4d3b80d41ea82590/lib/appium_lib/common/multi_touch.rb#L51) > def pinch(percentage = 25, auto_perform = true, driver = $driver) Convenience method for pinching the screen. Places two fingers at the edges of the screen and brings them together. @@ -1208,11 +1258,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Driver] driver - Set a driver to conduct the action. DEfault is global driver($driver) -- -##### [zoom](https://github.com/appium/ruby_lib/blob/0dca183c11919f20bff1acb7f04138ed6e678ca6/lib/appium_lib/common/multi_touch.rb#L93) +##### [zoom](https://github.com/appium/ruby_lib/blob/024167c78c20a817861528ae4d3b80d41ea82590/lib/appium_lib/common/multi_touch.rb#L93) > def zoom(percentage = 200, auto_perform = true, driver = $driver) Convenience method for zooming the screen. Places two fingers at the edges of the screen and brings them together. @@ -1228,11 +1278,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Driver] driver - Set a driver to conduct the action. DEfault is global driver($driver) -- -##### [initialize](https://github.com/appium/ruby_lib/blob/0dca183c11919f20bff1acb7f04138ed6e678ca6/lib/appium_lib/common/multi_touch.rb#L178) +##### [initialize](https://github.com/appium/ruby_lib/blob/024167c78c20a817861528ae4d3b80d41ea82590/lib/appium_lib/common/multi_touch.rb#L178) > def initialize(driver = $driver) self @@ -1240,19 +1290,19 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[MultiTouch] a new instance of MultiTouch -- -##### [COMPLEX_ACTIONS](https://github.com/appium/ruby_lib/blob/0dca183c11919f20bff1acb7f04138ed6e678ca6/lib/appium_lib/common/touch_actions.rb#L33) +##### [COMPLEX_ACTIONS](https://github.com/appium/ruby_lib/blob/024167c78c20a817861528ae4d3b80d41ea82590/lib/appium_lib/common/touch_actions.rb#L33) > COMPLEX_ACTIONS = ::Appium::Core::TouchAction::COMPLEX_ACTIONS -- -##### [initialize](https://github.com/appium/ruby_lib/blob/0dca183c11919f20bff1acb7f04138ed6e678ca6/lib/appium_lib/common/touch_actions.rb#L47) +##### [initialize](https://github.com/appium/ruby_lib/blob/024167c78c20a817861528ae4d3b80d41ea82590/lib/appium_lib/common/touch_actions.rb#L47) > def initialize(driver = $driver) @@ -1260,19 +1310,19 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[TouchAction] a new instance of TouchAction -- -##### [swipe](https://github.com/appium/ruby_lib/blob/0dca183c11919f20bff1acb7f04138ed6e678ca6/lib/appium_lib/common/touch_actions.rb#L51) +##### [swipe](https://github.com/appium/ruby_lib/blob/024167c78c20a817861528ae4d3b80d41ea82590/lib/appium_lib/common/touch_actions.rb#L51) > def swipe(opts) -- -##### [initialize](https://github.com/appium/ruby_lib/blob/0dca183c11919f20bff1acb7f04138ed6e678ca6/lib/appium_lib/common/command/ws_logcat.rb#L5) +##### [initialize](https://github.com/appium/ruby_lib/blob/024167c78c20a817861528ae4d3b80d41ea82590/lib/appium_lib/common/command/ws_logcat.rb#L5) > def initialize(url:, output_file: 'logcat.log') @@ -1280,35 +1330,35 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[WsLogcat] a new instance of WsLogcat -- -##### [handle_message_data](https://github.com/appium/ruby_lib/blob/0dca183c11919f20bff1acb7f04138ed6e678ca6/lib/appium_lib/common/command/ws_logcat.rb#L10) +##### [handle_message_data](https://github.com/appium/ruby_lib/blob/024167c78c20a817861528ae4d3b80d41ea82590/lib/appium_lib/common/command/ws_logcat.rb#L10) > def handle_message_data(data) -- -##### [for](https://github.com/appium/ruby_lib/blob/0dca183c11919f20bff1acb7f04138ed6e678ca6/lib/appium_lib/android/android.rb#L19) android +##### [for](https://github.com/appium/ruby_lib/blob/024167c78c20a817861528ae4d3b80d41ea82590/lib/appium_lib/android/android.rb#L19) android > def self.for(target) -- -##### [TextView](https://github.com/appium/ruby_lib/blob/0dca183c11919f20bff1acb7f04138ed6e678ca6/lib/appium_lib/android/element/text.rb#L4) android +##### [TextView](https://github.com/appium/ruby_lib/blob/024167c78c20a817861528ae4d3b80d41ea82590/lib/appium_lib/android/element/text.rb#L4) android > TextView = 'android.widget.TextView'.freeze -- -##### [text](https://github.com/appium/ruby_lib/blob/0dca183c11919f20bff1acb7f04138ed6e678ca6/lib/appium_lib/android/element/text.rb#L10) android +##### [text](https://github.com/appium/ruby_lib/blob/024167c78c20a817861528ae4d3b80d41ea82590/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. @@ -1321,11 +1371,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[TextView] -- -##### [texts](https://github.com/appium/ruby_lib/blob/0dca183c11919f20bff1acb7f04138ed6e678ca6/lib/appium_lib/android/element/text.rb#L19) android +##### [texts](https://github.com/appium/ruby_lib/blob/024167c78c20a817861528ae4d3b80d41ea82590/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. @@ -1338,11 +1388,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Array<TextView>] -- -##### [first_text](https://github.com/appium/ruby_lib/blob/0dca183c11919f20bff1acb7f04138ed6e678ca6/lib/appium_lib/android/element/text.rb#L26) android +##### [first_text](https://github.com/appium/ruby_lib/blob/024167c78c20a817861528ae4d3b80d41ea82590/lib/appium_lib/android/element/text.rb#L26) android > def first_text Find the first TextView. @@ -1350,11 +1400,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[TextView] -- -##### [last_text](https://github.com/appium/ruby_lib/blob/0dca183c11919f20bff1acb7f04138ed6e678ca6/lib/appium_lib/android/element/text.rb#L32) android +##### [last_text](https://github.com/appium/ruby_lib/blob/024167c78c20a817861528ae4d3b80d41ea82590/lib/appium_lib/android/element/text.rb#L32) android > def last_text Find the last TextView. @@ -1362,11 +1412,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[TextView] -- -##### [text_exact](https://github.com/appium/ruby_lib/blob/0dca183c11919f20bff1acb7f04138ed6e678ca6/lib/appium_lib/android/element/text.rb#L39) android +##### [text_exact](https://github.com/appium/ruby_lib/blob/024167c78c20a817861528ae4d3b80d41ea82590/lib/appium_lib/android/element/text.rb#L39) android > def text_exact(value) Find the first TextView that exactly matches value. @@ -1378,11 +1428,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[TextView] -- -##### [texts_exact](https://github.com/appium/ruby_lib/blob/0dca183c11919f20bff1acb7f04138ed6e678ca6/lib/appium_lib/android/element/text.rb#L46) android +##### [texts_exact](https://github.com/appium/ruby_lib/blob/024167c78c20a817861528ae4d3b80d41ea82590/lib/appium_lib/android/element/text.rb#L46) android > def texts_exact(value) Find all TextViews that exactly match value. @@ -1394,43 +1444,43 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Array<TextView>] -- -##### [result](https://github.com/appium/ruby_lib/blob/0dca183c11919f20bff1acb7f04138ed6e678ca6/lib/appium_lib/android/common/helper.rb#L6) android +##### [result](https://github.com/appium/ruby_lib/blob/024167c78c20a817861528ae4d3b80d41ea82590/lib/appium_lib/android/common/helper.rb#L6) android > def result Returns the value of attribute result -- -##### [keys](https://github.com/appium/ruby_lib/blob/0dca183c11919f20bff1acb7f04138ed6e678ca6/lib/appium_lib/android/common/helper.rb#L6) android +##### [keys](https://github.com/appium/ruby_lib/blob/024167c78c20a817861528ae4d3b80d41ea82590/lib/appium_lib/android/common/helper.rb#L6) android > def keys Returns the value of attribute keys -- -##### [filter](https://github.com/appium/ruby_lib/blob/0dca183c11919f20bff1acb7f04138ed6e678ca6/lib/appium_lib/android/common/helper.rb#L6) android +##### [filter](https://github.com/appium/ruby_lib/blob/024167c78c20a817861528ae4d3b80d41ea82590/lib/appium_lib/android/common/helper.rb#L6) android > def filter Returns the value of attribute filter -- -##### [filter=](https://github.com/appium/ruby_lib/blob/0dca183c11919f20bff1acb7f04138ed6e678ca6/lib/appium_lib/android/common/helper.rb#L9) android +##### [filter=](https://github.com/appium/ruby_lib/blob/024167c78c20a817861528ae4d3b80d41ea82590/lib/appium_lib/android/common/helper.rb#L9) android > def filter=(value) convert to string to support symbols -- -##### [initialize](https://github.com/appium/ruby_lib/blob/0dca183c11919f20bff1acb7f04138ed6e678ca6/lib/appium_lib/android/common/helper.rb#L15) android +##### [initialize](https://github.com/appium/ruby_lib/blob/024167c78c20a817861528ae4d3b80d41ea82590/lib/appium_lib/android/common/helper.rb#L15) android > def initialize @@ -1438,27 +1488,27 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[AndroidElements] a new instance of AndroidElements -- -##### [reset](https://github.com/appium/ruby_lib/blob/0dca183c11919f20bff1acb7f04138ed6e678ca6/lib/appium_lib/android/common/helper.rb#L20) android +##### [reset](https://github.com/appium/ruby_lib/blob/024167c78c20a817861528ae4d3b80d41ea82590/lib/appium_lib/android/common/helper.rb#L20) android > def reset -- -##### [start_element](https://github.com/appium/ruby_lib/blob/0dca183c11919f20bff1acb7f04138ed6e678ca6/lib/appium_lib/android/common/helper.rb#L26) android +##### [start_element](https://github.com/appium/ruby_lib/blob/024167c78c20a817861528ae4d3b80d41ea82590/lib/appium_lib/android/common/helper.rb#L26) android > def start_element(name, attrs = [], driver = $driver) http://nokogiri.org/Nokogiri/XML/SAX/Document.html -- -##### [get_android_inspect](https://github.com/appium/ruby_lib/blob/0dca183c11919f20bff1acb7f04138ed6e678ca6/lib/appium_lib/android/common/helper.rb#L80) android +##### [get_android_inspect](https://github.com/appium/ruby_lib/blob/024167c78c20a817861528ae4d3b80d41ea82590/lib/appium_lib/android/common/helper.rb#L80) android > def get_android_inspect(class_name = false) Android only. Returns a string containing interesting elements. @@ -1473,11 +1523,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[String] -- -##### [page](https://github.com/appium/ruby_lib/blob/0dca183c11919f20bff1acb7f04138ed6e678ca6/lib/appium_lib/android/common/helper.rb#L106) android +##### [page](https://github.com/appium/ruby_lib/blob/024167c78c20a817861528ae4d3b80d41ea82590/lib/appium_lib/android/common/helper.rb#L106) android > def page(opts = {}) Intended for use with console. Inspects and prints the current page. @@ -1492,11 +1542,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[void] -- -##### [id](https://github.com/appium/ruby_lib/blob/0dca183c11919f20bff1acb7f04138ed6e678ca6/lib/appium_lib/android/common/helper.rb#L115) android +##### [id](https://github.com/appium/ruby_lib/blob/024167c78c20a817861528ae4d3b80d41ea82590/lib/appium_lib/android/common/helper.rb#L115) android > def id(id) Find the first matching element by id @@ -1508,11 +1558,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Element] -- -##### [ids](https://github.com/appium/ruby_lib/blob/0dca183c11919f20bff1acb7f04138ed6e678ca6/lib/appium_lib/android/common/helper.rb#L123) android +##### [ids](https://github.com/appium/ruby_lib/blob/024167c78c20a817861528ae4d3b80d41ea82590/lib/appium_lib/android/common/helper.rb#L123) android > def ids(id) Find all matching elements by id @@ -1524,11 +1574,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Element] -- -##### [ele_index](https://github.com/appium/ruby_lib/blob/0dca183c11919f20bff1acb7f04138ed6e678ca6/lib/appium_lib/android/common/helper.rb#L132) android +##### [ele_index](https://github.com/appium/ruby_lib/blob/024167c78c20a817861528ae4d3b80d41ea82590/lib/appium_lib/android/common/helper.rb#L132) android > def ele_index(class_name, index) Find the element of type class_name at matching index. @@ -1542,11 +1592,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Element] the found element of type class_name -- -##### [first_ele](https://github.com/appium/ruby_lib/blob/0dca183c11919f20bff1acb7f04138ed6e678ca6/lib/appium_lib/android/common/helper.rb#L150) android +##### [first_ele](https://github.com/appium/ruby_lib/blob/024167c78c20a817861528ae4d3b80d41ea82590/lib/appium_lib/android/common/helper.rb#L150) android > def first_ele(class_name) Find the first element that matches class_name @@ -1558,11 +1608,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Element] -- -##### [last_ele](https://github.com/appium/ruby_lib/blob/0dca183c11919f20bff1acb7f04138ed6e678ca6/lib/appium_lib/android/common/helper.rb#L157) android +##### [last_ele](https://github.com/appium/ruby_lib/blob/024167c78c20a817861528ae4d3b80d41ea82590/lib/appium_lib/android/common/helper.rb#L157) android > def last_ele(class_name) Find the last element that matches class_name @@ -1574,11 +1624,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Element] -- -##### [tag](https://github.com/appium/ruby_lib/blob/0dca183c11919f20bff1acb7f04138ed6e678ca6/lib/appium_lib/android/common/helper.rb#L165) android +##### [tag](https://github.com/appium/ruby_lib/blob/024167c78c20a817861528ae4d3b80d41ea82590/lib/appium_lib/android/common/helper.rb#L165) android > def tag(class_name) Find the first element of type class_name @@ -1590,11 +1640,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Element] -- -##### [tags](https://github.com/appium/ruby_lib/blob/0dca183c11919f20bff1acb7f04138ed6e678ca6/lib/appium_lib/android/common/helper.rb#L173) android +##### [tags](https://github.com/appium/ruby_lib/blob/024167c78c20a817861528ae4d3b80d41ea82590/lib/appium_lib/android/common/helper.rb#L173) android > def tags(class_name) Find all elements of type class_name @@ -1606,11 +1656,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Element] -- -##### [string_visible_contains_xpath](https://github.com/appium/ruby_lib/blob/0dca183c11919f20bff1acb7f04138ed6e678ca6/lib/appium_lib/android/common/helper.rb#L216) android +##### [string_visible_contains_xpath](https://github.com/appium/ruby_lib/blob/024167c78c20a817861528ae4d3b80d41ea82590/lib/appium_lib/android/common/helper.rb#L216) android > def string_visible_contains_xpath(class_name, value) Returns a string that matches the first element that contains value For automationName is uiautomator2 @@ -1627,11 +1677,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[String] -- -##### [string_visible_contains](https://github.com/appium/ruby_lib/blob/0dca183c11919f20bff1acb7f04138ed6e678ca6/lib/appium_lib/android/common/helper.rb#L236) android +##### [string_visible_contains](https://github.com/appium/ruby_lib/blob/024167c78c20a817861528ae4d3b80d41ea82590/lib/appium_lib/android/common/helper.rb#L236) android > def string_visible_contains(class_name, value) Returns a string that matches the first element that contains value For automationName is Appium @@ -1648,11 +1698,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[String] -- -##### [complex_find_contains](https://github.com/appium/ruby_lib/blob/0dca183c11919f20bff1acb7f04138ed6e678ca6/lib/appium_lib/android/common/helper.rb#L254) android +##### [complex_find_contains](https://github.com/appium/ruby_lib/blob/024167c78c20a817861528ae4d3b80d41ea82590/lib/appium_lib/android/common/helper.rb#L254) android > def complex_find_contains(class_name, value) Find the first element that contains value @@ -1666,11 +1716,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Element] -- -##### [complex_finds_contains](https://github.com/appium/ruby_lib/blob/0dca183c11919f20bff1acb7f04138ed6e678ca6/lib/appium_lib/android/common/helper.rb#L262) android +##### [complex_finds_contains](https://github.com/appium/ruby_lib/blob/024167c78c20a817861528ae4d3b80d41ea82590/lib/appium_lib/android/common/helper.rb#L262) android > def complex_finds_contains(class_name, value) Find all elements containing value @@ -1684,11 +1734,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Array<Element>] -- -##### [complex_find_exact](https://github.com/appium/ruby_lib/blob/0dca183c11919f20bff1acb7f04138ed6e678ca6/lib/appium_lib/android/common/helper.rb#L306) android +##### [complex_find_exact](https://github.com/appium/ruby_lib/blob/024167c78c20a817861528ae4d3b80d41ea82590/lib/appium_lib/android/common/helper.rb#L306) android > def complex_find_exact(class_name, value) Find the first element exactly matching value @@ -1702,11 +1752,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Element] -- -##### [complex_finds_exact](https://github.com/appium/ruby_lib/blob/0dca183c11919f20bff1acb7f04138ed6e678ca6/lib/appium_lib/android/common/helper.rb#L314) android +##### [complex_finds_exact](https://github.com/appium/ruby_lib/blob/024167c78c20a817861528ae4d3b80d41ea82590/lib/appium_lib/android/common/helper.rb#L314) android > def complex_finds_exact(class_name, value) Find all elements exactly matching value @@ -1720,11 +1770,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Element] -- -##### [alert_click](https://github.com/appium/ruby_lib/blob/0dca183c11919f20bff1acb7f04138ed6e678ca6/lib/appium_lib/android/element/alert.rb#L6) android +##### [alert_click](https://github.com/appium/ruby_lib/blob/024167c78c20a817861528ae4d3b80d41ea82590/lib/appium_lib/android/element/alert.rb#L6) android > def alert_click(value) Click the first alert button that contains value or by index. @@ -1736,11 +1786,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[void] -- -##### [alert_accept](https://github.com/appium/ruby_lib/blob/0dca183c11919f20bff1acb7f04138ed6e678ca6/lib/appium_lib/android/element/alert.rb#L13) android +##### [alert_accept](https://github.com/appium/ruby_lib/blob/024167c78c20a817861528ae4d3b80d41ea82590/lib/appium_lib/android/element/alert.rb#L13) android > def alert_accept Accept the alert. The last button is considered "accept." @@ -1749,11 +1799,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[void] -- -##### [alert_accept_text](https://github.com/appium/ruby_lib/blob/0dca183c11919f20bff1acb7f04138ed6e678ca6/lib/appium_lib/android/element/alert.rb#L20) android +##### [alert_accept_text](https://github.com/appium/ruby_lib/blob/024167c78c20a817861528ae4d3b80d41ea82590/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." @@ -1762,11 +1812,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[String] -- -##### [alert_dismiss](https://github.com/appium/ruby_lib/blob/0dca183c11919f20bff1acb7f04138ed6e678ca6/lib/appium_lib/android/element/alert.rb#L27) android +##### [alert_dismiss](https://github.com/appium/ruby_lib/blob/024167c78c20a817861528ae4d3b80d41ea82590/lib/appium_lib/android/element/alert.rb#L27) android > def alert_dismiss Dismiss the alert. The first button is considered "dismiss." @@ -1775,11 +1825,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[void] -- -##### [alert_dismiss_text](https://github.com/appium/ruby_lib/blob/0dca183c11919f20bff1acb7f04138ed6e678ca6/lib/appium_lib/android/element/alert.rb#L34) android +##### [alert_dismiss_text](https://github.com/appium/ruby_lib/blob/024167c78c20a817861528ae4d3b80d41ea82590/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." @@ -1788,27 +1838,27 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[String] -- -##### [Button](https://github.com/appium/ruby_lib/blob/0dca183c11919f20bff1acb7f04138ed6e678ca6/lib/appium_lib/android/element/button.rb#L3) android +##### [Button](https://github.com/appium/ruby_lib/blob/024167c78c20a817861528ae4d3b80d41ea82590/lib/appium_lib/android/element/button.rb#L3) android > Button = 'android.widget.Button'.freeze -- -##### [ImageButton](https://github.com/appium/ruby_lib/blob/0dca183c11919f20bff1acb7f04138ed6e678ca6/lib/appium_lib/android/element/button.rb#L4) android +##### [ImageButton](https://github.com/appium/ruby_lib/blob/024167c78c20a817861528ae4d3b80d41ea82590/lib/appium_lib/android/element/button.rb#L4) android > ImageButton = 'android.widget.ImageButton'.freeze -- -##### [button](https://github.com/appium/ruby_lib/blob/0dca183c11919f20bff1acb7f04138ed6e678ca6/lib/appium_lib/android/element/button.rb#L10) android +##### [button](https://github.com/appium/ruby_lib/blob/024167c78c20a817861528ae4d3b80d41ea82590/lib/appium_lib/android/element/button.rb#L10) android > def button(value) Find the first button that contains value or by index. If int then the button at that index is returned. @@ -1821,11 +1871,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Button] -- -##### [buttons](https://github.com/appium/ruby_lib/blob/0dca183c11919f20bff1acb7f04138ed6e678ca6/lib/appium_lib/android/element/button.rb#L27) android +##### [buttons](https://github.com/appium/ruby_lib/blob/024167c78c20a817861528ae4d3b80d41ea82590/lib/appium_lib/android/element/button.rb#L27) android > def buttons(value = false) Find all buttons containing value. If value is omitted, all buttons are returned. @@ -1838,11 +1888,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Array<Button>] -- -##### [first_button](https://github.com/appium/ruby_lib/blob/0dca183c11919f20bff1acb7f04138ed6e678ca6/lib/appium_lib/android/element/button.rb#L34) android +##### [first_button](https://github.com/appium/ruby_lib/blob/024167c78c20a817861528ae4d3b80d41ea82590/lib/appium_lib/android/element/button.rb#L34) android > def first_button Find the first button. @@ -1850,11 +1900,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Button] -- -##### [last_button](https://github.com/appium/ruby_lib/blob/0dca183c11919f20bff1acb7f04138ed6e678ca6/lib/appium_lib/android/element/button.rb#L40) android +##### [last_button](https://github.com/appium/ruby_lib/blob/024167c78c20a817861528ae4d3b80d41ea82590/lib/appium_lib/android/element/button.rb#L40) android > def last_button Find the last button. @@ -1862,11 +1912,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Button] -- -##### [button_exact](https://github.com/appium/ruby_lib/blob/0dca183c11919f20bff1acb7f04138ed6e678ca6/lib/appium_lib/android/element/button.rb#L56) android +##### [button_exact](https://github.com/appium/ruby_lib/blob/024167c78c20a817861528ae4d3b80d41ea82590/lib/appium_lib/android/element/button.rb#L56) android > def button_exact(value) Find the first button that exactly matches value. @@ -1878,11 +1928,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Button] -- -##### [buttons_exact](https://github.com/appium/ruby_lib/blob/0dca183c11919f20bff1acb7f04138ed6e678ca6/lib/appium_lib/android/element/button.rb#L63) android +##### [buttons_exact](https://github.com/appium/ruby_lib/blob/024167c78c20a817861528ae4d3b80d41ea82590/lib/appium_lib/android/element/button.rb#L63) android > def buttons_exact(value) Find all buttons that exactly match value. @@ -1894,11 +1944,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Array<Button>] -- -##### [find](https://github.com/appium/ruby_lib/blob/0dca183c11919f20bff1acb7f04138ed6e678ca6/lib/appium_lib/android/element/generic.rb#L6) android +##### [find](https://github.com/appium/ruby_lib/blob/024167c78c20a817861528ae4d3b80d41ea82590/lib/appium_lib/android/element/generic.rb#L6) android > def find(value) Find the first element containing value @@ -1910,11 +1960,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Element] -- -##### [finds](https://github.com/appium/ruby_lib/blob/0dca183c11919f20bff1acb7f04138ed6e678ca6/lib/appium_lib/android/element/generic.rb#L13) android +##### [finds](https://github.com/appium/ruby_lib/blob/024167c78c20a817861528ae4d3b80d41ea82590/lib/appium_lib/android/element/generic.rb#L13) android > def finds(value) Find all elements containing value @@ -1926,11 +1976,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Array<Element>] -- -##### [find_exact](https://github.com/appium/ruby_lib/blob/0dca183c11919f20bff1acb7f04138ed6e678ca6/lib/appium_lib/android/element/generic.rb#L20) android +##### [find_exact](https://github.com/appium/ruby_lib/blob/024167c78c20a817861528ae4d3b80d41ea82590/lib/appium_lib/android/element/generic.rb#L20) android > def find_exact(value) Find the first element exactly matching value @@ -1942,11 +1992,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Element] -- -##### [finds_exact](https://github.com/appium/ruby_lib/blob/0dca183c11919f20bff1acb7f04138ed6e678ca6/lib/appium_lib/android/element/generic.rb#L27) android +##### [finds_exact](https://github.com/appium/ruby_lib/blob/024167c78c20a817861528ae4d3b80d41ea82590/lib/appium_lib/android/element/generic.rb#L27) android > def finds_exact(value) Find all elements exactly matching value @@ -1958,11 +2008,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Array<Element>] -- -##### [scroll_to](https://github.com/appium/ruby_lib/blob/0dca183c11919f20bff1acb7f04138ed6e678ca6/lib/appium_lib/android/element/generic.rb#L40) android +##### [scroll_to](https://github.com/appium/ruby_lib/blob/024167c78c20a817861528ae4d3b80d41ea82590/lib/appium_lib/android/element/generic.rb#L40) android > def scroll_to(text, scrollable_index = 0) Scroll to the first element containing target text or description. @@ -1976,11 +2026,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Element] the element scrolled to -- -##### [scroll_to_exact](https://github.com/appium/ruby_lib/blob/0dca183c11919f20bff1acb7f04138ed6e678ca6/lib/appium_lib/android/element/generic.rb#L58) android +##### [scroll_to_exact](https://github.com/appium/ruby_lib/blob/024167c78c20a817861528ae4d3b80d41ea82590/lib/appium_lib/android/element/generic.rb#L58) android > def scroll_to_exact(text, scrollable_index = 0) Scroll to the first element with the exact target text or description. @@ -1994,27 +2044,27 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Element] the element scrolled to -- -##### [for](https://github.com/appium/ruby_lib/blob/0dca183c11919f20bff1acb7f04138ed6e678ca6/lib/appium_lib/android/espresso/bridge.rb#L7) android +##### [for](https://github.com/appium/ruby_lib/blob/024167c78c20a817861528ae4d3b80d41ea82590/lib/appium_lib/android/espresso/bridge.rb#L7) android > def self.for(target) -- -##### [EditText](https://github.com/appium/ruby_lib/blob/0dca183c11919f20bff1acb7f04138ed6e678ca6/lib/appium_lib/android/element/textfield.rb#L3) android +##### [EditText](https://github.com/appium/ruby_lib/blob/024167c78c20a817861528ae4d3b80d41ea82590/lib/appium_lib/android/element/textfield.rb#L3) android > EditText = 'android.widget.EditText'.freeze -- -##### [textfield](https://github.com/appium/ruby_lib/blob/0dca183c11919f20bff1acb7f04138ed6e678ca6/lib/appium_lib/android/element/textfield.rb#L9) android +##### [textfield](https://github.com/appium/ruby_lib/blob/024167c78c20a817861528ae4d3b80d41ea82590/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. @@ -2027,11 +2077,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[EditText] -- -##### [textfields](https://github.com/appium/ruby_lib/blob/0dca183c11919f20bff1acb7f04138ed6e678ca6/lib/appium_lib/android/element/textfield.rb#L18) android +##### [textfields](https://github.com/appium/ruby_lib/blob/024167c78c20a817861528ae4d3b80d41ea82590/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. @@ -2044,11 +2094,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Array<EditText>] -- -##### [first_textfield](https://github.com/appium/ruby_lib/blob/0dca183c11919f20bff1acb7f04138ed6e678ca6/lib/appium_lib/android/element/textfield.rb#L25) android +##### [first_textfield](https://github.com/appium/ruby_lib/blob/024167c78c20a817861528ae4d3b80d41ea82590/lib/appium_lib/android/element/textfield.rb#L25) android > def first_textfield Find the first EditText. @@ -2056,11 +2106,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[EditText] -- -##### [last_textfield](https://github.com/appium/ruby_lib/blob/0dca183c11919f20bff1acb7f04138ed6e678ca6/lib/appium_lib/android/element/textfield.rb#L31) android +##### [last_textfield](https://github.com/appium/ruby_lib/blob/024167c78c20a817861528ae4d3b80d41ea82590/lib/appium_lib/android/element/textfield.rb#L31) android > def last_textfield Find the last EditText. @@ -2068,11 +2118,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[EditText] -- -##### [textfield_exact](https://github.com/appium/ruby_lib/blob/0dca183c11919f20bff1acb7f04138ed6e678ca6/lib/appium_lib/android/element/textfield.rb#L38) android +##### [textfield_exact](https://github.com/appium/ruby_lib/blob/024167c78c20a817861528ae4d3b80d41ea82590/lib/appium_lib/android/element/textfield.rb#L38) android > def textfield_exact(value) Find the first EditText that exactly matches value. @@ -2084,11 +2134,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[EditText] -- -##### [textfields_exact](https://github.com/appium/ruby_lib/blob/0dca183c11919f20bff1acb7f04138ed6e678ca6/lib/appium_lib/android/element/textfield.rb#L45) android +##### [textfields_exact](https://github.com/appium/ruby_lib/blob/024167c78c20a817861528ae4d3b80d41ea82590/lib/appium_lib/android/element/textfield.rb#L45) android > def textfields_exact(value) Find all EditTexts that exactly match value. @@ -2100,19 +2150,19 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Array<EditText>] -- -##### [for](https://github.com/appium/ruby_lib/blob/0dca183c11919f20bff1acb7f04138ed6e678ca6/lib/appium_lib/android/uiautomator2/bridge.rb#L7) android +##### [for](https://github.com/appium/ruby_lib/blob/024167c78c20a817861528ae4d3b80d41ea82590/lib/appium_lib/android/uiautomator2/bridge.rb#L7) android > def self.for(target) -- -##### [string_visible_contains](https://github.com/appium/ruby_lib/blob/0dca183c11919f20bff1acb7f04138ed6e678ca6/lib/appium_lib/android/uiautomator2/helper.rb#L13) android +##### [string_visible_contains](https://github.com/appium/ruby_lib/blob/024167c78c20a817861528ae4d3b80d41ea82590/lib/appium_lib/android/uiautomator2/helper.rb#L13) android > def string_visible_contains(class_name, value) Returns a string that matches the first element that contains value For automationName is Appium @@ -2129,11 +2179,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[String] -- -##### [complex_find_contains](https://github.com/appium/ruby_lib/blob/0dca183c11919f20bff1acb7f04138ed6e678ca6/lib/appium_lib/android/uiautomator2/helper.rb#L31) android +##### [complex_find_contains](https://github.com/appium/ruby_lib/blob/024167c78c20a817861528ae4d3b80d41ea82590/lib/appium_lib/android/uiautomator2/helper.rb#L31) android > def complex_find_contains(class_name, value) Find the first element that contains value @@ -2147,11 +2197,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Element] -- -##### [complex_finds_contains](https://github.com/appium/ruby_lib/blob/0dca183c11919f20bff1acb7f04138ed6e678ca6/lib/appium_lib/android/uiautomator2/helper.rb#L41) android +##### [complex_finds_contains](https://github.com/appium/ruby_lib/blob/024167c78c20a817861528ae4d3b80d41ea82590/lib/appium_lib/android/uiautomator2/helper.rb#L41) android > def complex_finds_contains(class_name, value) Find all elements containing value @@ -2165,11 +2215,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Array<Element>] -- -##### [complex_find_exact](https://github.com/appium/ruby_lib/blob/0dca183c11919f20bff1acb7f04138ed6e678ca6/lib/appium_lib/android/uiautomator2/helper.rb#L69) android +##### [complex_find_exact](https://github.com/appium/ruby_lib/blob/024167c78c20a817861528ae4d3b80d41ea82590/lib/appium_lib/android/uiautomator2/helper.rb#L69) android > def complex_find_exact(class_name, value) Find the first element exactly matching value @@ -2183,11 +2233,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Element] -- -##### [complex_finds_exact](https://github.com/appium/ruby_lib/blob/0dca183c11919f20bff1acb7f04138ed6e678ca6/lib/appium_lib/android/uiautomator2/helper.rb#L79) android +##### [complex_finds_exact](https://github.com/appium/ruby_lib/blob/024167c78c20a817861528ae4d3b80d41ea82590/lib/appium_lib/android/uiautomator2/helper.rb#L79) android > def complex_finds_exact(class_name, value) Find all elements exactly matching value @@ -2201,11 +2251,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Element] -- -##### [shell](https://github.com/appium/ruby_lib/blob/0dca183c11919f20bff1acb7f04138ed6e678ca6/lib/appium_lib/android/common/command/command.rb#L14) android +##### [shell](https://github.com/appium/ruby_lib/blob/024167c78c20a817861528ae4d3b80d41ea82590/lib/appium_lib/android/common/command/command.rb#L14) android > def shell(command, arguments) Conduct an adb shell script on Appium server. Require `--relaxed-security` arguments when run Appium server as server side arguments. @@ -2216,11 +2266,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Array] arguments - Arguments for the adb command -- -##### [start_logs_broadcast](https://github.com/appium/ruby_lib/blob/0dca183c11919f20bff1acb7f04138ed6e678ca6/lib/appium_lib/android/common/command/command.rb#L28) android +##### [start_logs_broadcast](https://github.com/appium/ruby_lib/blob/024167c78c20a817861528ae4d3b80d41ea82590/lib/appium_lib/android/common/command/command.rb#L28) android > def start_logs_broadcast(logcat_file = 'logcat.log') Starts Android logcat broadcast websocket @@ -2228,19 +2278,19 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[String] logcat_file - A file path to write messages from a logcat WebSocket client -- -##### [stop_logs_broadcast](https://github.com/appium/ruby_lib/blob/0dca183c11919f20bff1acb7f04138ed6e678ca6/lib/appium_lib/android/common/command/command.rb#L41) android +##### [stop_logs_broadcast](https://github.com/appium/ruby_lib/blob/024167c78c20a817861528ae4d3b80d41ea82590/lib/appium_lib/android/common/command/command.rb#L41) android > def stop_logs_broadcast Stop Android logcat broadcast websocket -- -##### [button](https://github.com/appium/ruby_lib/blob/0dca183c11919f20bff1acb7f04138ed6e678ca6/lib/appium_lib/android/uiautomator2/element/button.rb#L9) android +##### [button](https://github.com/appium/ruby_lib/blob/024167c78c20a817861528ae4d3b80d41ea82590/lib/appium_lib/android/uiautomator2/element/button.rb#L9) android > def button(value) Find the first button that contains value or by index. If int then the button at that index is returned. @@ -2253,11 +2303,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Button] -- -##### [buttons](https://github.com/appium/ruby_lib/blob/0dca183c11919f20bff1acb7f04138ed6e678ca6/lib/appium_lib/android/uiautomator2/element/button.rb#L29) android +##### [buttons](https://github.com/appium/ruby_lib/blob/024167c78c20a817861528ae4d3b80d41ea82590/lib/appium_lib/android/uiautomator2/element/button.rb#L29) android > def buttons(value = false) Find all buttons containing value. If value is omitted, all buttons are returned. @@ -2270,11 +2320,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Array<Button>] -- -##### [first_button](https://github.com/appium/ruby_lib/blob/0dca183c11919f20bff1acb7f04138ed6e678ca6/lib/appium_lib/android/uiautomator2/element/button.rb#L36) android +##### [first_button](https://github.com/appium/ruby_lib/blob/024167c78c20a817861528ae4d3b80d41ea82590/lib/appium_lib/android/uiautomator2/element/button.rb#L36) android > def first_button Find the first button. @@ -2282,11 +2332,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Button] -- -##### [last_button](https://github.com/appium/ruby_lib/blob/0dca183c11919f20bff1acb7f04138ed6e678ca6/lib/appium_lib/android/uiautomator2/element/button.rb#L43) android +##### [last_button](https://github.com/appium/ruby_lib/blob/024167c78c20a817861528ae4d3b80d41ea82590/lib/appium_lib/android/uiautomator2/element/button.rb#L43) android > def last_button Find the last button. @@ -2294,11 +2344,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Button] -- -##### [button_exact](https://github.com/appium/ruby_lib/blob/0dca183c11919f20bff1acb7f04138ed6e678ca6/lib/appium_lib/android/uiautomator2/element/button.rb#L60) android +##### [button_exact](https://github.com/appium/ruby_lib/blob/024167c78c20a817861528ae4d3b80d41ea82590/lib/appium_lib/android/uiautomator2/element/button.rb#L60) android > def button_exact(value) Find the first button that exactly matches value. @@ -2310,10 +2360,10 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Button] -- -##### [buttons_exact](https://github.com/appium/ruby_lib/blob/0dca183c11919f20bff1acb7f04138ed6e678ca6/lib/appium_lib/android/uiautomator2/element/button.rb#L68) android +##### [buttons_exact](https://github.com/appium/ruby_lib/blob/024167c78c20a817861528ae4d3b80d41ea82590/lib/appium_lib/android/uiautomator2/element/button.rb#L68) android > def buttons_exact(value) Find all buttons that exactly match value.