docs/android_docs.md in appium_lib-9.7.1 vs docs/android_docs.md in appium_lib-9.7.2

- old
+ new

@@ -1,6 +1,6 @@ -##### [load_settings](https://github.com/appium/ruby_lib/blob/63a853ea755edb68a3469bd6647f23530c746853/lib/appium_lib/appium.rb#L45) +##### [load_settings](https://github.com/appium/ruby_lib/blob/b9b8784697d9fbe73d3883cf42d260f19138d8f5/lib/appium_lib/appium.rb#L45) > 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/63a853ea755edb68a3469bd6647f23530c746853/lib/appium_lib/appium.rb#L78) +##### [load_appium_txt](https://github.com/appium/ruby_lib/blob/b9b8784697d9fbe73d3883cf42d260f19138d8f5/lib/appium_lib/appium.rb#L79) > 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/63a853ea755edb68a3469bd6647f23530c746853/lib/appium_lib/appium.rb#L83) +##### [expand_required_files](https://github.com/appium/ruby_lib/blob/b9b8784697d9fbe73d3883cf42d260f19138d8f5/lib/appium_lib/appium.rb#L84) > 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/63a853ea755edb68a3469bd6647f23530c746853/lib/appium_lib/appium.rb#L122) +##### [promote_singleton_appium_methods](https://github.com/appium/ruby_lib/blob/b9b8784697d9fbe73d3883cf42d260f19138d8f5/lib/appium_lib/appium.rb#L126) > 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 @@ -88,198 +88,192 @@ if modules is a module instead of an array, then the constants of that module are promoted on. otherwise, the array of modules will be used as the promotion target. +__Parameters:__ + +&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Array<Module>] modules - An array of modules + +&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Driver] driver - A driver to extend for + -- -##### [promote_appium_methods](https://github.com/appium/ruby_lib/blob/63a853ea755edb68a3469bd6647f23530c746853/lib/appium_lib/appium.rb#L175) +##### [promote_appium_methods](https://github.com/appium/ruby_lib/blob/b9b8784697d9fbe73d3883cf42d260f19138d8f5/lib/appium_lib/appium.rb#L181) > def promote_appium_methods(class_array, driver = $driver) Promote appium methods to class instance methods To promote methods to all classes: -```ruby -Appium.promote_appium_methods Object -``` - It's better to promote on specific classes instead of Object -```ruby -# promote on rspec -Appium.promote_appium_methods RSpec::Core::ExampleGroup -``` - -```ruby -# promote on minispec -Appium.promote_appium_methods Minitest::Spec -``` - __Parameters:__ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Array<Class>] class_array - An array of classes +&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Driver] driver - A driver to extend for + -- -##### [global_webdriver_http_sleep](https://github.com/appium/ruby_lib/blob/63a853ea755edb68a3469bd6647f23530c746853/lib/appium_lib/driver.rb#L24) +##### [global_webdriver_http_sleep](https://github.com/appium/ruby_lib/blob/b9b8784697d9fbe73d3883cf42d260f19138d8f5/lib/appium_lib/driver.rb#L24) > 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/63a853ea755edb68a3469bd6647f23530c746853/lib/appium_lib/driver.rb#L24) +##### [global_webdriver_http_sleep=](https://github.com/appium/ruby_lib/blob/b9b8784697d9fbe73d3883cf42d260f19138d8f5/lib/appium_lib/driver.rb#L24) > 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/63a853ea755edb68a3469bd6647f23530c746853/lib/appium_lib/driver.rb#L27) +##### [sauce](https://github.com/appium/ruby_lib/blob/b9b8784697d9fbe73d3883cf42d260f19138d8f5/lib/appium_lib/driver.rb#L27) > def sauce SauceLab's settings -- -##### [sauce_username](https://github.com/appium/ruby_lib/blob/63a853ea755edb68a3469bd6647f23530c746853/lib/appium_lib/driver.rb#L30) +##### [sauce_username](https://github.com/appium/ruby_lib/blob/b9b8784697d9fbe73d3883cf42d260f19138d8f5/lib/appium_lib/driver.rb#L30) > 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/63a853ea755edb68a3469bd6647f23530c746853/lib/appium_lib/driver.rb#L33) +##### [sauce_access_key](https://github.com/appium/ruby_lib/blob/b9b8784697d9fbe73d3883cf42d260f19138d8f5/lib/appium_lib/driver.rb#L33) > 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/63a853ea755edb68a3469bd6647f23530c746853/lib/appium_lib/driver.rb#L36) +##### [sauce_endpoint](https://github.com/appium/ruby_lib/blob/b9b8784697d9fbe73d3883cf42d260f19138d8f5/lib/appium_lib/driver.rb#L36) > 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/63a853ea755edb68a3469bd6647f23530c746853/lib/appium_lib/driver.rb#L39) +##### [caps](https://github.com/appium/ruby_lib/blob/b9b8784697d9fbe73d3883cf42d260f19138d8f5/lib/appium_lib/driver.rb#L39) > def caps from Core -- -##### [custom_url](https://github.com/appium/ruby_lib/blob/63a853ea755edb68a3469bd6647f23530c746853/lib/appium_lib/driver.rb#L40) +##### [custom_url](https://github.com/appium/ruby_lib/blob/b9b8784697d9fbe73d3883cf42d260f19138d8f5/lib/appium_lib/driver.rb#L40) > def custom_url Returns the value of attribute custom_url -- -##### [export_session](https://github.com/appium/ruby_lib/blob/63a853ea755edb68a3469bd6647f23530c746853/lib/appium_lib/driver.rb#L41) +##### [export_session](https://github.com/appium/ruby_lib/blob/b9b8784697d9fbe73d3883cf42d260f19138d8f5/lib/appium_lib/driver.rb#L41) > def export_session Returns the value of attribute export_session -- -##### [default_wait](https://github.com/appium/ruby_lib/blob/63a853ea755edb68a3469bd6647f23530c746853/lib/appium_lib/driver.rb#L42) +##### [default_wait](https://github.com/appium/ruby_lib/blob/b9b8784697d9fbe73d3883cf42d260f19138d8f5/lib/appium_lib/driver.rb#L42) > def default_wait Returns the value of attribute default_wait -- -##### [appium_port](https://github.com/appium/ruby_lib/blob/63a853ea755edb68a3469bd6647f23530c746853/lib/appium_lib/driver.rb#L43) +##### [appium_port](https://github.com/appium/ruby_lib/blob/b9b8784697d9fbe73d3883cf42d260f19138d8f5/lib/appium_lib/driver.rb#L43) > def appium_port Returns the value of attribute appium_port -- -##### [appium_device](https://github.com/appium/ruby_lib/blob/63a853ea755edb68a3469bd6647f23530c746853/lib/appium_lib/driver.rb#L44) +##### [appium_device](https://github.com/appium/ruby_lib/blob/b9b8784697d9fbe73d3883cf42d260f19138d8f5/lib/appium_lib/driver.rb#L44) > def appium_device Returns the value of attribute appium_device -- -##### [automation_name](https://github.com/appium/ruby_lib/blob/63a853ea755edb68a3469bd6647f23530c746853/lib/appium_lib/driver.rb#L45) +##### [automation_name](https://github.com/appium/ruby_lib/blob/b9b8784697d9fbe73d3883cf42d260f19138d8f5/lib/appium_lib/driver.rb#L45) > def automation_name Returns the value of attribute automation_name -- -##### [listener](https://github.com/appium/ruby_lib/blob/63a853ea755edb68a3469bd6647f23530c746853/lib/appium_lib/driver.rb#L46) +##### [listener](https://github.com/appium/ruby_lib/blob/b9b8784697d9fbe73d3883cf42d260f19138d8f5/lib/appium_lib/driver.rb#L46) > def listener Returns the value of attribute listener -- -##### [http_client](https://github.com/appium/ruby_lib/blob/63a853ea755edb68a3469bd6647f23530c746853/lib/appium_lib/driver.rb#L47) +##### [http_client](https://github.com/appium/ruby_lib/blob/b9b8784697d9fbe73d3883cf42d260f19138d8f5/lib/appium_lib/driver.rb#L47) > def http_client Returns the value of attribute http_client -- -##### [appium_wait_timeout](https://github.com/appium/ruby_lib/blob/63a853ea755edb68a3469bd6647f23530c746853/lib/appium_lib/driver.rb#L48) +##### [appium_wait_timeout](https://github.com/appium/ruby_lib/blob/b9b8784697d9fbe73d3883cf42d260f19138d8f5/lib/appium_lib/driver.rb#L48) > def appium_wait_timeout Returns the value of attribute appium_wait_timeout -- -##### [appium_wait_interval](https://github.com/appium/ruby_lib/blob/63a853ea755edb68a3469bd6647f23530c746853/lib/appium_lib/driver.rb#L49) +##### [appium_wait_interval](https://github.com/appium/ruby_lib/blob/b9b8784697d9fbe73d3883cf42d260f19138d8f5/lib/appium_lib/driver.rb#L49) > def appium_wait_interval Returns the value of attribute appium_wait_interval -- -##### [appium_server_status](https://github.com/appium/ruby_lib/blob/63a853ea755edb68a3469bd6647f23530c746853/lib/appium_lib/driver.rb#L52) +##### [appium_server_status](https://github.com/appium/ruby_lib/blob/b9b8784697d9fbe73d3883cf42d260f19138d8f5/lib/appium_lib/driver.rb#L52) > def appium_server_status Appium's server version -- -##### [appium_debug](https://github.com/appium/ruby_lib/blob/63a853ea755edb68a3469bd6647f23530c746853/lib/appium_lib/driver.rb#L54) +##### [appium_debug](https://github.com/appium/ruby_lib/blob/b9b8784697d9fbe73d3883cf42d260f19138d8f5/lib/appium_lib/driver.rb#L54) > def appium_debug Boolean debug mode for the Appium Ruby bindings -- -##### [driver](https://github.com/appium/ruby_lib/blob/63a853ea755edb68a3469bd6647f23530c746853/lib/appium_lib/driver.rb#L57) +##### [driver](https://github.com/appium/ruby_lib/blob/b9b8784697d9fbe73d3883cf42d260f19138d8f5/lib/appium_lib/driver.rb#L57) > def driver Returns the driver @@ -287,19 +281,19 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Driver] the driver -- -##### [core](https://github.com/appium/ruby_lib/blob/63a853ea755edb68a3469bd6647f23530c746853/lib/appium_lib/driver.rb#L59) +##### [core](https://github.com/appium/ruby_lib/blob/b9b8784697d9fbe73d3883cf42d260f19138d8f5/lib/appium_lib/driver.rb#L59) > def core Instance of Appium::Core::Driver -- -##### [initialize](https://github.com/appium/ruby_lib/blob/63a853ea755edb68a3469bd6647f23530c746853/lib/appium_lib/driver.rb#L113) +##### [initialize](https://github.com/appium/ruby_lib/blob/b9b8784697d9fbe73d3883cf42d260f19138d8f5/lib/appium_lib/driver.rb#L110) > 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. @@ -314,19 +308,19 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Driver] -- -##### [driver_attributes](https://github.com/appium/ruby_lib/blob/63a853ea755edb68a3469bd6647f23530c746853/lib/appium_lib/driver.rb#L218) +##### [driver_attributes](https://github.com/appium/ruby_lib/blob/b9b8784697d9fbe73d3883cf42d260f19138d8f5/lib/appium_lib/driver.rb#L215) > def driver_attributes Returns a hash of the driver attributes -- -##### [device_is_android?](https://github.com/appium/ruby_lib/blob/63a853ea755edb68a3469bd6647f23530c746853/lib/appium_lib/driver.rb#L237) +##### [device_is_android?](https://github.com/appium/ruby_lib/blob/b9b8784697d9fbe73d3883cf42d260f19138d8f5/lib/appium_lib/driver.rb#L234) > def device_is_android? @@ -334,11 +328,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Boolean] -- -##### [device_is_ios?](https://github.com/appium/ruby_lib/blob/63a853ea755edb68a3469bd6647f23530c746853/lib/appium_lib/driver.rb#L241) +##### [device_is_ios?](https://github.com/appium/ruby_lib/blob/b9b8784697d9fbe73d3883cf42d260f19138d8f5/lib/appium_lib/driver.rb#L238) > def device_is_ios? @@ -346,11 +340,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Boolean] -- -##### [device_is_windows?](https://github.com/appium/ruby_lib/blob/63a853ea755edb68a3469bd6647f23530c746853/lib/appium_lib/driver.rb#L245) +##### [device_is_windows?](https://github.com/appium/ruby_lib/blob/b9b8784697d9fbe73d3883cf42d260f19138d8f5/lib/appium_lib/driver.rb#L242) > def device_is_windows? @@ -358,11 +352,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Boolean] -- -##### [automation_name_is_uiautomator2?](https://github.com/appium/ruby_lib/blob/63a853ea755edb68a3469bd6647f23530c746853/lib/appium_lib/driver.rb#L251) +##### [automation_name_is_uiautomator2?](https://github.com/appium/ruby_lib/blob/b9b8784697d9fbe73d3883cf42d260f19138d8f5/lib/appium_lib/driver.rb#L248) > def automation_name_is_uiautomator2? Return true if automationName is 'uiautomator2' @@ -370,11 +364,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Boolean] -- -##### [automation_name_is_espresso?](https://github.com/appium/ruby_lib/blob/63a853ea755edb68a3469bd6647f23530c746853/lib/appium_lib/driver.rb#L257) +##### [automation_name_is_espresso?](https://github.com/appium/ruby_lib/blob/b9b8784697d9fbe73d3883cf42d260f19138d8f5/lib/appium_lib/driver.rb#L254) > def automation_name_is_espresso? Return true if automationName is 'Espresso' @@ -382,11 +376,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Boolean] -- -##### [automation_name_is_xcuitest?](https://github.com/appium/ruby_lib/blob/63a853ea755edb68a3469bd6647f23530c746853/lib/appium_lib/driver.rb#L263) +##### [automation_name_is_xcuitest?](https://github.com/appium/ruby_lib/blob/b9b8784697d9fbe73d3883cf42d260f19138d8f5/lib/appium_lib/driver.rb#L260) > def automation_name_is_xcuitest? Return true if automationName is 'XCUITest' @@ -394,11 +388,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Boolean] -- -##### [check_server_version_xcuitest](https://github.com/appium/ruby_lib/blob/63a853ea755edb68a3469bd6647f23530c746853/lib/appium_lib/driver.rb#L270) +##### [check_server_version_xcuitest](https://github.com/appium/ruby_lib/blob/b9b8784697d9fbe73d3883cf42d260f19138d8f5/lib/appium_lib/driver.rb#L267) > 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. @@ -407,32 +401,23 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Boolean] -- -##### [appium_server_version](https://github.com/appium/ruby_lib/blob/63a853ea755edb68a3469bd6647f23530c746853/lib/appium_lib/driver.rb#L292) +##### [appium_server_version](https://github.com/appium/ruby_lib/blob/b9b8784697d9fbe73d3883cf42d260f19138d8f5/lib/appium_lib/driver.rb#L288) > def appium_server_version Returns the server's version info -```ruby -{ - "build" => { - "version" => "0.18.1", - "revision" => "d242ebcfd92046a974347ccc3a28f0e898595198" - } -} -``` - __Returns:__ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Hash] -- -##### [platform_version](https://github.com/appium/ruby_lib/blob/63a853ea755edb68a3469bd6647f23530c746853/lib/appium_lib/driver.rb#L302) +##### [platform_version](https://github.com/appium/ruby_lib/blob/b9b8784697d9fbe73d3883cf42d260f19138d8f5/lib/appium_lib/driver.rb#L298) > def platform_version Return the platform version as an array of integers @@ -440,29 +425,23 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Array<Integer>] -- -##### [appium_client_version](https://github.com/appium/ruby_lib/blob/63a853ea755edb68a3469bd6647f23530c746853/lib/appium_lib/driver.rb#L321) +##### [appium_client_version](https://github.com/appium/ruby_lib/blob/b9b8784697d9fbe73d3883cf42d260f19138d8f5/lib/appium_lib/driver.rb#L317) > def appium_client_version Returns the client's version info -```ruby -{ - "version" => "9.1.1" -} -``` - __Returns:__ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Hash] -- -##### [absolute_app_path](https://github.com/appium/ruby_lib/blob/63a853ea755edb68a3469bd6647f23530c746853/lib/appium_lib/driver.rb#L333) +##### [absolute_app_path](https://github.com/appium/ruby_lib/blob/b9b8784697d9fbe73d3883cf42d260f19138d8f5/lib/appium_lib/driver.rb#L329) > def self.absolute_app_path(opts) Converts app_path to an absolute path. @@ -475,11 +454,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[String] APP_PATH as an absolute path -- -##### [server_url](https://github.com/appium/ruby_lib/blob/63a853ea755edb68a3469bd6647f23530c746853/lib/appium_lib/driver.rb#L366) +##### [server_url](https://github.com/appium/ruby_lib/blob/b9b8784697d9fbe73d3883cf42d260f19138d8f5/lib/appium_lib/driver.rb#L362) > def server_url Get the server url @@ -487,11 +466,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[String] the server url -- -##### [restart](https://github.com/appium/ruby_lib/blob/63a853ea755edb68a3469bd6647f23530c746853/lib/appium_lib/driver.rb#L374) +##### [restart](https://github.com/appium/ruby_lib/blob/b9b8784697d9fbe73d3883cf42d260f19138d8f5/lib/appium_lib/driver.rb#L370) > def restart Restarts the driver @@ -499,29 +478,27 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Driver] the driver -- -##### [screenshot](https://github.com/appium/ruby_lib/blob/63a853ea755edb68a3469bd6647f23530c746853/lib/appium_lib/driver.rb#L385) +##### [screenshot](https://github.com/appium/ruby_lib/blob/b9b8784697d9fbe73d3883cf42d260f19138d8f5/lib/appium_lib/driver.rb#L383) > def screenshot(png_save_path) Takes a png screenshot and saves to the target path. -Example: screenshot '/tmp/hi.png' - __Parameters:__ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[String] png_save_path - the full path to save the png __Returns:__ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[nil] -- -##### [driver_quit](https://github.com/appium/ruby_lib/blob/63a853ea755edb68a3469bd6647f23530c746853/lib/appium_lib/driver.rb#L391) +##### [driver_quit](https://github.com/appium/ruby_lib/blob/b9b8784697d9fbe73d3883cf42d260f19138d8f5/lib/appium_lib/driver.rb#L389) > def driver_quit Quits the driver @@ -529,11 +506,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[void] -- -##### [quit_driver](https://github.com/appium/ruby_lib/blob/63a853ea755edb68a3469bd6647f23530c746853/lib/appium_lib/driver.rb#L394) +##### [quit_driver](https://github.com/appium/ruby_lib/blob/b9b8784697d9fbe73d3883cf42d260f19138d8f5/lib/appium_lib/driver.rb#L392) > def driver_quit Quits the driver @@ -541,11 +518,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[void] -- -##### [window_size](https://github.com/appium/ruby_lib/blob/63a853ea755edb68a3469bd6647f23530c746853/lib/appium_lib/driver.rb#L403) +##### [window_size](https://github.com/appium/ruby_lib/blob/b9b8784697d9fbe73d3883cf42d260f19138d8f5/lib/appium_lib/driver.rb#L403) > def window_size Get the device window's size. @@ -553,11 +530,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Selenium::WebDriver::Dimension] -- -##### [start_driver](https://github.com/appium/ruby_lib/blob/63a853ea755edb68a3469bd6647f23530c746853/lib/appium_lib/driver.rb#L433) +##### [start_driver](https://github.com/appium/ruby_lib/blob/b9b8784697d9fbe73d3883cf42d260f19138d8f5/lib/appium_lib/driver.rb#L432) > 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 @@ -570,49 +547,43 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Selenium::WebDriver] the new global driver -- -##### [set_implicit_wait](https://github.com/appium/ruby_lib/blob/63a853ea755edb68a3469bd6647f23530c746853/lib/appium_lib/driver.rb#L457) +##### [set_implicit_wait](https://github.com/appium/ruby_lib/blob/b9b8784697d9fbe73d3883cf42d260f19138d8f5/lib/appium_lib/driver.rb#L456) > def set_implicit_wait(wait) To ignore error for Espresso Driver -- -##### [no_wait](https://github.com/appium/ruby_lib/blob/63a853ea755edb68a3469bd6647f23530c746853/lib/appium_lib/driver.rb#L467) +##### [no_wait](https://github.com/appium/ruby_lib/blob/b9b8784697d9fbe73d3883cf42d260f19138d8f5/lib/appium_lib/driver.rb#L466) > def no_wait Set implicit wait to zero. -- -##### [set_wait](https://github.com/appium/ruby_lib/blob/63a853ea755edb68a3469bd6647f23530c746853/lib/appium_lib/driver.rb#L481) +##### [set_wait](https://github.com/appium/ruby_lib/blob/b9b8784697d9fbe73d3883cf42d260f19138d8f5/lib/appium_lib/driver.rb#L480) > def set_wait(timeout = nil) Set implicit wait. Default to @core.default_wait. -```ruby -set_wait 2 -set_wait # @core.default_wait - -``` - __Parameters:__ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Integer] timeout - the timeout in seconds __Returns:__ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[void] -- -##### [exists](https://github.com/appium/ruby_lib/blob/63a853ea755edb68a3469bd6647f23530c746853/lib/appium_lib/driver.rb#L498) +##### [exists](https://github.com/appium/ruby_lib/blob/b9b8784697d9fbe73d3883cf42d260f19138d8f5/lib/appium_lib/driver.rb#L497) > def exists(pre_check = 0, post_check = @core.default_wait) Returns existence of element. @@ -632,11 +603,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Boolean] -- -##### [execute_script](https://github.com/appium/ruby_lib/blob/63a853ea755edb68a3469bd6647f23530c746853/lib/appium_lib/driver.rb#L522) +##### [execute_script](https://github.com/appium/ruby_lib/blob/b9b8784697d9fbe73d3883cf42d260f19138d8f5/lib/appium_lib/driver.rb#L521) > def execute_script(script, *args) The same as @driver.execute_script @@ -650,11 +621,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Object] -- -##### [find_elements](https://github.com/appium/ruby_lib/blob/63a853ea755edb68a3469bd6647f23530c746853/lib/appium_lib/driver.rb#L546) +##### [find_elements](https://github.com/appium/ruby_lib/blob/b9b8784697d9fbe73d3883cf42d260f19138d8f5/lib/appium_lib/driver.rb#L543) > def find_elements(*args) Calls @driver.find_elements_with_appium @@ -670,11 +641,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/63a853ea755edb68a3469bd6647f23530c746853/lib/appium_lib/driver.rb#L562) +##### [find_element](https://github.com/appium/ruby_lib/blob/b9b8784697d9fbe73d3883cf42d260f19138d8f5/lib/appium_lib/driver.rb#L558) > def find_element(*args) Calls @driver.find_element @@ -688,11 +659,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Element] -- -##### [set_location](https://github.com/appium/ruby_lib/blob/63a853ea755edb68a3469bd6647f23530c746853/lib/appium_lib/driver.rb#L575) +##### [set_location](https://github.com/appium/ruby_lib/blob/b9b8784697d9fbe73d3883cf42d260f19138d8f5/lib/appium_lib/driver.rb#L571) > def set_location(opts = {}) Calls @driver.set_location @@ -704,11 +675,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Selenium::WebDriver::Location] the location constructed by the selenium webdriver -- -##### [x](https://github.com/appium/ruby_lib/blob/63a853ea755edb68a3469bd6647f23530c746853/lib/appium_lib/driver.rb#L585) +##### [x](https://github.com/appium/ruby_lib/blob/b9b8784697d9fbe73d3883cf42d260f19138d8f5/lib/appium_lib/driver.rb#L581) > def x Quit the driver and Pry. quit and exit are reserved by Pry. @@ -717,67 +688,75 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[void] -- -##### [username](https://github.com/appium/ruby_lib/blob/63a853ea755edb68a3469bd6647f23530c746853/lib/appium_lib/sauce_labs.rb#L4) +##### [username](https://github.com/appium/ruby_lib/blob/b9b8784697d9fbe73d3883cf42d260f19138d8f5/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/63a853ea755edb68a3469bd6647f23530c746853/lib/appium_lib/sauce_labs.rb#L6) +##### [access_key](https://github.com/appium/ruby_lib/blob/b9b8784697d9fbe73d3883cf42d260f19138d8f5/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/63a853ea755edb68a3469bd6647f23530c746853/lib/appium_lib/sauce_labs.rb#L8) +##### [endpoint](https://github.com/appium/ruby_lib/blob/b9b8784697d9fbe73d3883cf42d260f19138d8f5/lib/appium_lib/sauce_labs.rb#L8) > def endpoint -Override the Sauce Appium endpoint to allow e.g. TestObject tests +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/63a853ea755edb68a3469bd6647f23530c746853/lib/appium_lib/sauce_labs.rb#L10) +##### [initialize](https://github.com/appium/ruby_lib/blob/b9b8784697d9fbe73d3883cf42d260f19138d8f5/lib/appium_lib/sauce_labs.rb#L33) > def initialize(appium_lib_opts) +Create a SauceLabs instance to manage sauce labs related attributes. +__Parameters:__ +&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Hash] appium_lib_opts - Appium library parameter + __Returns:__ -&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[SauceLabs] a new instance of SauceLabs +&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Appium::SauceLabs] -- -##### [sauce_server_url?](https://github.com/appium/ruby_lib/blob/63a853ea755edb68a3469bd6647f23530c746853/lib/appium_lib/sauce_labs.rb#L21) +##### [sauce_server_url?](https://github.com/appium/ruby_lib/blob/b9b8784697d9fbe73d3883cf42d260f19138d8f5/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. - __Returns:__ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Boolean] -- -##### [server_url](https://github.com/appium/ruby_lib/blob/63a853ea755edb68a3469bd6647f23530c746853/lib/appium_lib/sauce_labs.rb#L25) +##### [server_url](https://github.com/appium/ruby_lib/blob/b9b8784697d9fbe73d3883cf42d260f19138d8f5/lib/appium_lib/sauce_labs.rb#L66) > def server_url +Return a particular server url to access to. Default is the local address. +__Returns:__ +&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[String] + -- -##### [get_log](https://github.com/appium/ruby_lib/blob/63a853ea755edb68a3469bd6647f23530c746853/lib/appium_lib/common/log.rb#L10) +##### [get_log](https://github.com/appium/ruby_lib/blob/b9b8784697d9fbe73d3883cf42d260f19138d8f5/lib/appium_lib/common/log.rb#L11) > def get_log(type) @@ -789,11 +768,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/63a853ea755edb68a3469bd6647f23530c746853/lib/appium_lib/common/log.rb#L20) +##### [get_available_log_types](https://github.com/appium/ruby_lib/blob/b9b8784697d9fbe73d3883cf42d260f19138d8f5/lib/appium_lib/common/log.rb#L23) > def get_available_log_types Get a list of available log types @@ -801,11 +780,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[[String]] A list of available log types. -- -##### [initialize](https://github.com/appium/ruby_lib/blob/63a853ea755edb68a3469bd6647f23530c746853/lib/appium_lib/common/wait.rb#L6) +##### [initialize](https://github.com/appium/ruby_lib/blob/b9b8784697d9fbe73d3883cf42d260f19138d8f5/lib/appium_lib/common/wait.rb#L6) > def initialize(opts = {}) @@ -813,11 +792,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Wait] a new instance of Wait -- -##### [wait_true](https://github.com/appium/ruby_lib/blob/63a853ea755edb68a3469bd6647f23530c746853/lib/appium_lib/common/wait.rb#L34) +##### [wait_true](https://github.com/appium/ruby_lib/blob/b9b8784697d9fbe73d3883cf42d260f19138d8f5/lib/appium_lib/common/wait.rb#L34) > 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. @@ -833,11 +812,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Hash] opts - Options -- -##### [wait](https://github.com/appium/ruby_lib/blob/63a853ea755edb68a3469bd6647f23530c746853/lib/appium_lib/common/wait.rb#L57) +##### [wait](https://github.com/appium/ruby_lib/blob/b9b8784697d9fbe73d3883cf42d260f19138d8f5/lib/appium_lib/common/wait.rb#L57) > def wait(opts = {}) Check every interval seconds to see if yield doesn't raise an exception. Give up after timeout seconds. @@ -851,19 +830,19 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Hash] opts - Options -- -##### [ignore](https://github.com/appium/ruby_lib/blob/63a853ea755edb68a3469bd6647f23530c746853/lib/appium_lib/common/helper.rb#L17) +##### [ignore](https://github.com/appium/ruby_lib/blob/b9b8784697d9fbe73d3883cf42d260f19138d8f5/lib/appium_lib/common/helper.rb#L16) > def ignore Return yield and ignore any exceptions. -- -##### [back](https://github.com/appium/ruby_lib/blob/63a853ea755edb68a3469bd6647f23530c746853/lib/appium_lib/common/helper.rb#L24) +##### [back](https://github.com/appium/ruby_lib/blob/b9b8784697d9fbe73d3883cf42d260f19138d8f5/lib/appium_lib/common/helper.rb#L23) > def back Navigate back. @@ -871,19 +850,23 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[void] -- -##### [session_id](https://github.com/appium/ruby_lib/blob/63a853ea755edb68a3469bd6647f23530c746853/lib/appium_lib/common/helper.rb#L29) +##### [session_id](https://github.com/appium/ruby_lib/blob/b9b8784697d9fbe73d3883cf42d260f19138d8f5/lib/appium_lib/common/helper.rb#L34) > def session_id For Sauce Labs reporting. Returns the current session id. +__Returns:__ + +&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[String] + -- -##### [xpath](https://github.com/appium/ruby_lib/blob/63a853ea755edb68a3469bd6647f23530c746853/lib/appium_lib/common/helper.rb#L37) +##### [xpath](https://github.com/appium/ruby_lib/blob/b9b8784697d9fbe73d3883cf42d260f19138d8f5/lib/appium_lib/common/helper.rb#L42) > def xpath(xpath_str) Returns the first element that matches the provided xpath. @@ -895,11 +878,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Element] -- -##### [xpaths](https://github.com/appium/ruby_lib/blob/63a853ea755edb68a3469bd6647f23530c746853/lib/appium_lib/common/helper.rb#L45) +##### [xpaths](https://github.com/appium/ruby_lib/blob/b9b8784697d9fbe73d3883cf42d260f19138d8f5/lib/appium_lib/common/helper.rb#L50) > def xpaths(xpath_str) Returns all elements that match the provided xpath. @@ -911,19 +894,19 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Array<Element>] -- -##### [result](https://github.com/appium/ruby_lib/blob/63a853ea755edb68a3469bd6647f23530c746853/lib/appium_lib/common/helper.rb#L56) +##### [result](https://github.com/appium/ruby_lib/blob/b9b8784697d9fbe73d3883cf42d260f19138d8f5/lib/appium_lib/common/helper.rb#L61) > def result Returns the value of attribute result -- -##### [initialize](https://github.com/appium/ruby_lib/blob/63a853ea755edb68a3469bd6647f23530c746853/lib/appium_lib/common/helper.rb#L58) +##### [initialize](https://github.com/appium/ruby_lib/blob/b9b8784697d9fbe73d3883cf42d260f19138d8f5/lib/appium_lib/common/helper.rb#L63) > def initialize @@ -931,64 +914,68 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[CountElements] a new instance of CountElements -- -##### [reset](https://github.com/appium/ruby_lib/blob/63a853ea755edb68a3469bd6647f23530c746853/lib/appium_lib/common/helper.rb#L62) +##### [reset](https://github.com/appium/ruby_lib/blob/b9b8784697d9fbe73d3883cf42d260f19138d8f5/lib/appium_lib/common/helper.rb#L67) > def reset -- -##### [start_element](https://github.com/appium/ruby_lib/blob/63a853ea755edb68a3469bd6647f23530c746853/lib/appium_lib/common/helper.rb#L67) +##### [start_element](https://github.com/appium/ruby_lib/blob/b9b8784697d9fbe73d3883cf42d260f19138d8f5/lib/appium_lib/common/helper.rb#L72) > def start_element(name, attrs = [], driver = $driver) http://nokogiri.org/Nokogiri/XML/SAX/Document.html -- -##### [formatted_result](https://github.com/appium/ruby_lib/blob/63a853ea755edb68a3469bd6647f23530c746853/lib/appium_lib/common/helper.rb#L73) +##### [formatted_result](https://github.com/appium/ruby_lib/blob/b9b8784697d9fbe73d3883cf42d260f19138d8f5/lib/appium_lib/common/helper.rb#L78) > def formatted_result -- -##### [get_page_class](https://github.com/appium/ruby_lib/blob/63a853ea755edb68a3469bd6647f23530c746853/lib/appium_lib/common/helper.rb#L84) +##### [get_page_class](https://github.com/appium/ruby_lib/blob/b9b8784697d9fbe73d3883cf42d260f19138d8f5/lib/appium_lib/common/helper.rb#L97) > def get_page_class Returns a string of class counts of visible elements. +__Returns:__ + +&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[String] + -- -##### [page_class](https://github.com/appium/ruby_lib/blob/63a853ea755edb68a3469bd6647f23530c746853/lib/appium_lib/common/helper.rb#L95) +##### [page_class](https://github.com/appium/ruby_lib/blob/b9b8784697d9fbe73d3883cf42d260f19138d8f5/lib/appium_lib/common/helper.rb#L122) > def page_class Count all classes on screen and print to stdout. Useful for appium_console. +__Returns:__ + +&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[nil] + -- -##### [px_to_window_rel](https://github.com/appium/ruby_lib/blob/63a853ea755edb68a3469bd6647f23530c746853/lib/appium_lib/common/helper.rb#L105) +##### [px_to_window_rel](https://github.com/appium/ruby_lib/blob/b9b8784697d9fbe73d3883cf42d260f19138d8f5/lib/appium_lib/common/helper.rb#L133) > def px_to_window_rel(opts = {}, driver = $driver) Converts pixel values to window relative values -```ruby -px_to_window_rel x: 50, y: 150 -``` - -- -##### [xml_keys](https://github.com/appium/ruby_lib/blob/63a853ea755edb68a3469bd6647f23530c746853/lib/appium_lib/common/helper.rb#L124) +##### [xml_keys](https://github.com/appium/ruby_lib/blob/b9b8784697d9fbe73d3883cf42d260f19138d8f5/lib/appium_lib/common/helper.rb#L152) > def xml_keys(target) Search strings.xml's values for target. @@ -1000,11 +987,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Array] -- -##### [xml_values](https://github.com/appium/ruby_lib/blob/63a853ea755edb68a3469bd6647f23530c746853/lib/appium_lib/common/helper.rb#L132) +##### [xml_values](https://github.com/appium/ruby_lib/blob/b9b8784697d9fbe73d3883cf42d260f19138d8f5/lib/appium_lib/common/helper.rb#L160) > def xml_values(target) Search strings.xml's keys for target. @@ -1016,11 +1003,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Array] -- -##### [resolve_id](https://github.com/appium/ruby_lib/blob/63a853ea755edb68a3469bd6647f23530c746853/lib/appium_lib/common/helper.rb#L140) +##### [resolve_id](https://github.com/appium/ruby_lib/blob/b9b8784697d9fbe73d3883cf42d260f19138d8f5/lib/appium_lib/common/helper.rb#L168) > def resolve_id(id) Resolve id in strings.xml and return the value. @@ -1032,27 +1019,27 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[String] -- -##### [filter](https://github.com/appium/ruby_lib/blob/63a853ea755edb68a3469bd6647f23530c746853/lib/appium_lib/common/helper.rb#L146) +##### [filter](https://github.com/appium/ruby_lib/blob/b9b8784697d9fbe73d3883cf42d260f19138d8f5/lib/appium_lib/common/helper.rb#L175) > def filter Returns the value of attribute filter -- -##### [filter=](https://github.com/appium/ruby_lib/blob/63a853ea755edb68a3469bd6647f23530c746853/lib/appium_lib/common/helper.rb#L149) +##### [filter=](https://github.com/appium/ruby_lib/blob/b9b8784697d9fbe73d3883cf42d260f19138d8f5/lib/appium_lib/common/helper.rb#L178) > def filter=(value) convert to string to support symbols -- -##### [initialize](https://github.com/appium/ruby_lib/blob/63a853ea755edb68a3469bd6647f23530c746853/lib/appium_lib/common/helper.rb#L155) +##### [initialize](https://github.com/appium/ruby_lib/blob/b9b8784697d9fbe73d3883cf42d260f19138d8f5/lib/appium_lib/common/helper.rb#L184) > def initialize @@ -1060,127 +1047,99 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[HTMLElements] a new instance of HTMLElements -- -##### [reset](https://github.com/appium/ruby_lib/blob/63a853ea755edb68a3469bd6647f23530c746853/lib/appium_lib/common/helper.rb#L160) +##### [reset](https://github.com/appium/ruby_lib/blob/b9b8784697d9fbe73d3883cf42d260f19138d8f5/lib/appium_lib/common/helper.rb#L189) > def reset -- -##### [result](https://github.com/appium/ruby_lib/blob/63a853ea755edb68a3469bd6647f23530c746853/lib/appium_lib/common/helper.rb#L166) +##### [result](https://github.com/appium/ruby_lib/blob/b9b8784697d9fbe73d3883cf42d260f19138d8f5/lib/appium_lib/common/helper.rb#L195) > def result -- -##### [start_element](https://github.com/appium/ruby_lib/blob/63a853ea755edb68a3469bd6647f23530c746853/lib/appium_lib/common/helper.rb#L182) +##### [start_element](https://github.com/appium/ruby_lib/blob/b9b8784697d9fbe73d3883cf42d260f19138d8f5/lib/appium_lib/common/helper.rb#L211) > def start_element(name, attrs = []) -- -##### [end_element](https://github.com/appium/ruby_lib/blob/63a853ea755edb68a3469bd6647f23530c746853/lib/appium_lib/common/helper.rb#L191) +##### [end_element](https://github.com/appium/ruby_lib/blob/b9b8784697d9fbe73d3883cf42d260f19138d8f5/lib/appium_lib/common/helper.rb#L220) > def end_element(name) -- -##### [characters](https://github.com/appium/ruby_lib/blob/63a853ea755edb68a3469bd6647f23530c746853/lib/appium_lib/common/helper.rb#L197) +##### [characters](https://github.com/appium/ruby_lib/blob/b9b8784697d9fbe73d3883cf42d260f19138d8f5/lib/appium_lib/common/helper.rb#L226) > def characters(chars) -- -##### [DEFAULT_HEADERS](https://github.com/appium/ruby_lib/blob/63a853ea755edb68a3469bd6647f23530c746853/lib/appium_lib/common/http_client.rb#L7) +##### [DEFAULT_HEADERS](https://github.com/appium/ruby_lib/blob/b9b8784697d9fbe73d3883cf42d260f19138d8f5/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/63a853ea755edb68a3469bd6647f23530c746853/lib/appium_lib/common/multi_touch.rb#L53) +##### [pinch](https://github.com/appium/ruby_lib/blob/b9b8784697d9fbe73d3883cf42d260f19138d8f5/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. -```ruby -pinch 75 #=> Pinch the screen from the top right and bottom left corners -``` - Without auto_perform -```ruby -action = pinch 75, false #=> Pinch the screen from the top right and bottom left corners -action.perform #=> to 25% of its size. -``` - With driver -```ruby -driver = Appium::Driver.new(opts, false).start_driver -pinch 75, true, driver #=> Pinch the screen from the top right and bottom left corners -``` - __Parameters:__ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[int] percentage - The percent size by which to shrink the screen when pinched. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[boolean] auto_perform - Whether to perform the action immediately (default true) &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/63a853ea755edb68a3469bd6647f23530c746853/lib/appium_lib/common/multi_touch.rb#L80) +##### [zoom](https://github.com/appium/ruby_lib/blob/b9b8784697d9fbe73d3883cf42d260f19138d8f5/lib/appium_lib/common/multi_touch.rb#L79) > 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. -```ruby -action = zoom 200 #=> Zoom in the screen from the center until it doubles in size. -``` - Without auto_perform -```ruby -action = zoom 200, false #=> Zoom in the screen from the center until it doubles in size. -action.perform #=> to 25% of its size. -``` - With driver -```ruby -driver = Appium::Driver.new(opts, false).start_driver -pinch 200, true, driver #=> Zoom in the screen from the center until it doubles in size. -``` - __Parameters:__ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[int] percentage - The percent size by which to shrink the screen when pinched. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[boolean] auto_perform - Whether to perform the action immediately (default true) &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/63a853ea755edb68a3469bd6647f23530c746853/lib/appium_lib/common/multi_touch.rb#L85) +##### [initialize](https://github.com/appium/ruby_lib/blob/b9b8784697d9fbe73d3883cf42d260f19138d8f5/lib/appium_lib/common/multi_touch.rb#L84) > def initialize(driver = $driver) self @@ -1188,19 +1147,19 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[MultiTouch] a new instance of MultiTouch -- -##### [COMPLEX_ACTIONS](https://github.com/appium/ruby_lib/blob/63a853ea755edb68a3469bd6647f23530c746853/lib/appium_lib/common/touch_actions.rb#L30) +##### [COMPLEX_ACTIONS](https://github.com/appium/ruby_lib/blob/b9b8784697d9fbe73d3883cf42d260f19138d8f5/lib/appium_lib/common/touch_actions.rb#L33) > COMPLEX_ACTIONS = ::Appium::Core::TouchAction::COMPLEX_ACTIONS -- -##### [initialize](https://github.com/appium/ruby_lib/blob/63a853ea755edb68a3469bd6647f23530c746853/lib/appium_lib/common/touch_actions.rb#L44) +##### [initialize](https://github.com/appium/ruby_lib/blob/b9b8784697d9fbe73d3883cf42d260f19138d8f5/lib/appium_lib/common/touch_actions.rb#L47) > def initialize(driver = $driver) @@ -1208,27 +1167,27 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[TouchAction] a new instance of TouchAction -- -##### [for](https://github.com/appium/ruby_lib/blob/63a853ea755edb68a3469bd6647f23530c746853/lib/appium_lib/android/android.rb#L15) android +##### [for](https://github.com/appium/ruby_lib/blob/b9b8784697d9fbe73d3883cf42d260f19138d8f5/lib/appium_lib/android/android.rb#L15) android > def self.for(target) -- -##### [TextView](https://github.com/appium/ruby_lib/blob/63a853ea755edb68a3469bd6647f23530c746853/lib/appium_lib/android/element/text.rb#L4) android +##### [TextView](https://github.com/appium/ruby_lib/blob/b9b8784697d9fbe73d3883cf42d260f19138d8f5/lib/appium_lib/android/element/text.rb#L4) android > TextView = 'android.widget.TextView'.freeze -- -##### [text](https://github.com/appium/ruby_lib/blob/63a853ea755edb68a3469bd6647f23530c746853/lib/appium_lib/android/element/text.rb#L10) android +##### [text](https://github.com/appium/ruby_lib/blob/b9b8784697d9fbe73d3883cf42d260f19138d8f5/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. @@ -1241,11 +1200,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[TextView] -- -##### [texts](https://github.com/appium/ruby_lib/blob/63a853ea755edb68a3469bd6647f23530c746853/lib/appium_lib/android/element/text.rb#L19) android +##### [texts](https://github.com/appium/ruby_lib/blob/b9b8784697d9fbe73d3883cf42d260f19138d8f5/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. @@ -1258,11 +1217,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Array<TextView>] -- -##### [first_text](https://github.com/appium/ruby_lib/blob/63a853ea755edb68a3469bd6647f23530c746853/lib/appium_lib/android/element/text.rb#L26) android +##### [first_text](https://github.com/appium/ruby_lib/blob/b9b8784697d9fbe73d3883cf42d260f19138d8f5/lib/appium_lib/android/element/text.rb#L26) android > def first_text Find the first TextView. @@ -1270,11 +1229,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[TextView] -- -##### [last_text](https://github.com/appium/ruby_lib/blob/63a853ea755edb68a3469bd6647f23530c746853/lib/appium_lib/android/element/text.rb#L32) android +##### [last_text](https://github.com/appium/ruby_lib/blob/b9b8784697d9fbe73d3883cf42d260f19138d8f5/lib/appium_lib/android/element/text.rb#L32) android > def last_text Find the last TextView. @@ -1282,11 +1241,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[TextView] -- -##### [text_exact](https://github.com/appium/ruby_lib/blob/63a853ea755edb68a3469bd6647f23530c746853/lib/appium_lib/android/element/text.rb#L39) android +##### [text_exact](https://github.com/appium/ruby_lib/blob/b9b8784697d9fbe73d3883cf42d260f19138d8f5/lib/appium_lib/android/element/text.rb#L39) android > def text_exact(value) Find the first TextView that exactly matches value. @@ -1298,11 +1257,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[TextView] -- -##### [texts_exact](https://github.com/appium/ruby_lib/blob/63a853ea755edb68a3469bd6647f23530c746853/lib/appium_lib/android/element/text.rb#L46) android +##### [texts_exact](https://github.com/appium/ruby_lib/blob/b9b8784697d9fbe73d3883cf42d260f19138d8f5/lib/appium_lib/android/element/text.rb#L46) android > def texts_exact(value) Find all TextViews that exactly match value. @@ -1314,43 +1273,43 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Array<TextView>] -- -##### [result](https://github.com/appium/ruby_lib/blob/63a853ea755edb68a3469bd6647f23530c746853/lib/appium_lib/android/common/helper.rb#L6) android +##### [result](https://github.com/appium/ruby_lib/blob/b9b8784697d9fbe73d3883cf42d260f19138d8f5/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/63a853ea755edb68a3469bd6647f23530c746853/lib/appium_lib/android/common/helper.rb#L6) android +##### [keys](https://github.com/appium/ruby_lib/blob/b9b8784697d9fbe73d3883cf42d260f19138d8f5/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/63a853ea755edb68a3469bd6647f23530c746853/lib/appium_lib/android/common/helper.rb#L6) android +##### [filter](https://github.com/appium/ruby_lib/blob/b9b8784697d9fbe73d3883cf42d260f19138d8f5/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/63a853ea755edb68a3469bd6647f23530c746853/lib/appium_lib/android/common/helper.rb#L9) android +##### [filter=](https://github.com/appium/ruby_lib/blob/b9b8784697d9fbe73d3883cf42d260f19138d8f5/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/63a853ea755edb68a3469bd6647f23530c746853/lib/appium_lib/android/common/helper.rb#L15) android +##### [initialize](https://github.com/appium/ruby_lib/blob/b9b8784697d9fbe73d3883cf42d260f19138d8f5/lib/appium_lib/android/common/helper.rb#L15) android > def initialize @@ -1358,27 +1317,27 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[AndroidElements] a new instance of AndroidElements -- -##### [reset](https://github.com/appium/ruby_lib/blob/63a853ea755edb68a3469bd6647f23530c746853/lib/appium_lib/android/common/helper.rb#L20) android +##### [reset](https://github.com/appium/ruby_lib/blob/b9b8784697d9fbe73d3883cf42d260f19138d8f5/lib/appium_lib/android/common/helper.rb#L20) android > def reset -- -##### [start_element](https://github.com/appium/ruby_lib/blob/63a853ea755edb68a3469bd6647f23530c746853/lib/appium_lib/android/common/helper.rb#L26) android +##### [start_element](https://github.com/appium/ruby_lib/blob/b9b8784697d9fbe73d3883cf42d260f19138d8f5/lib/appium_lib/android/common/helper.rb#L26) android > def start_element(name, attrs = [], driver = $driver) http://nokogiri.org/Nokogiri/XML/SAX/Document.html -- -##### [source](https://github.com/appium/ruby_lib/blob/63a853ea755edb68a3469bd6647f23530c746853/lib/appium_lib/android/common/helper.rb#L76) android +##### [source](https://github.com/appium/ruby_lib/blob/b9b8784697d9fbe73d3883cf42d260f19138d8f5/lib/appium_lib/android/common/helper.rb#L76) android > def source Prints xml of the current page @@ -1386,11 +1345,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[void] -- -##### [get_android_inspect](https://github.com/appium/ruby_lib/blob/63a853ea755edb68a3469bd6647f23530c746853/lib/appium_lib/android/common/helper.rb#L86) android +##### [get_android_inspect](https://github.com/appium/ruby_lib/blob/b9b8784697d9fbe73d3883cf42d260f19138d8f5/lib/appium_lib/android/common/helper.rb#L86) android > def get_android_inspect(class_name = false) Android only. Returns a string containing interesting elements. @@ -1405,11 +1364,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[String] -- -##### [page](https://github.com/appium/ruby_lib/blob/63a853ea755edb68a3469bd6647f23530c746853/lib/appium_lib/android/common/helper.rb#L112) android +##### [page](https://github.com/appium/ruby_lib/blob/b9b8784697d9fbe73d3883cf42d260f19138d8f5/lib/appium_lib/android/common/helper.rb#L112) android > def page(opts = {}) Intended for use with console. Inspects and prints the current page. @@ -1424,21 +1383,21 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[void] -- -##### [current_app](https://github.com/appium/ruby_lib/blob/63a853ea755edb68a3469bd6647f23530c746853/lib/appium_lib/android/common/helper.rb#L124) android +##### [current_app](https://github.com/appium/ruby_lib/blob/b9b8784697d9fbe73d3883cf42d260f19138d8f5/lib/appium_lib/android/common/helper.rb#L124) 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/63a853ea755edb68a3469bd6647f23530c746853/lib/appium_lib/android/common/helper.rb#L148) android +##### [id](https://github.com/appium/ruby_lib/blob/b9b8784697d9fbe73d3883cf42d260f19138d8f5/lib/appium_lib/android/common/helper.rb#L148) android > def id(id) Find the first matching element by id @@ -1450,11 +1409,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Element] -- -##### [ids](https://github.com/appium/ruby_lib/blob/63a853ea755edb68a3469bd6647f23530c746853/lib/appium_lib/android/common/helper.rb#L156) android +##### [ids](https://github.com/appium/ruby_lib/blob/b9b8784697d9fbe73d3883cf42d260f19138d8f5/lib/appium_lib/android/common/helper.rb#L156) android > def ids(id) Find all matching elements by id @@ -1466,11 +1425,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Element] -- -##### [ele_index](https://github.com/appium/ruby_lib/blob/63a853ea755edb68a3469bd6647f23530c746853/lib/appium_lib/android/common/helper.rb#L165) android +##### [ele_index](https://github.com/appium/ruby_lib/blob/b9b8784697d9fbe73d3883cf42d260f19138d8f5/lib/appium_lib/android/common/helper.rb#L165) android > def ele_index(class_name, index) Find the element of type class_name at matching index. @@ -1484,11 +1443,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Element] the found element of type class_name -- -##### [first_ele](https://github.com/appium/ruby_lib/blob/63a853ea755edb68a3469bd6647f23530c746853/lib/appium_lib/android/common/helper.rb#L183) android +##### [first_ele](https://github.com/appium/ruby_lib/blob/b9b8784697d9fbe73d3883cf42d260f19138d8f5/lib/appium_lib/android/common/helper.rb#L183) android > def first_ele(class_name) Find the first element that matches class_name @@ -1500,11 +1459,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Element] -- -##### [last_ele](https://github.com/appium/ruby_lib/blob/63a853ea755edb68a3469bd6647f23530c746853/lib/appium_lib/android/common/helper.rb#L190) android +##### [last_ele](https://github.com/appium/ruby_lib/blob/b9b8784697d9fbe73d3883cf42d260f19138d8f5/lib/appium_lib/android/common/helper.rb#L190) android > def last_ele(class_name) Find the last element that matches class_name @@ -1516,11 +1475,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Element] -- -##### [tag](https://github.com/appium/ruby_lib/blob/63a853ea755edb68a3469bd6647f23530c746853/lib/appium_lib/android/common/helper.rb#L198) android +##### [tag](https://github.com/appium/ruby_lib/blob/b9b8784697d9fbe73d3883cf42d260f19138d8f5/lib/appium_lib/android/common/helper.rb#L198) android > def tag(class_name) Find the first element of type class_name @@ -1532,11 +1491,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Element] -- -##### [tags](https://github.com/appium/ruby_lib/blob/63a853ea755edb68a3469bd6647f23530c746853/lib/appium_lib/android/common/helper.rb#L206) android +##### [tags](https://github.com/appium/ruby_lib/blob/b9b8784697d9fbe73d3883cf42d260f19138d8f5/lib/appium_lib/android/common/helper.rb#L206) android > def tags(class_name) Find all elements of type class_name @@ -1548,11 +1507,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Element] -- -##### [string_visible_contains_xpath](https://github.com/appium/ruby_lib/blob/63a853ea755edb68a3469bd6647f23530c746853/lib/appium_lib/android/common/helper.rb#L249) android +##### [string_visible_contains_xpath](https://github.com/appium/ruby_lib/blob/b9b8784697d9fbe73d3883cf42d260f19138d8f5/lib/appium_lib/android/common/helper.rb#L249) android > def string_visible_contains_xpath(class_name, value) Returns a string that matches the first element that contains value For automationName is uiautomator2 @@ -1569,11 +1528,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[String] -- -##### [string_visible_contains](https://github.com/appium/ruby_lib/blob/63a853ea755edb68a3469bd6647f23530c746853/lib/appium_lib/android/common/helper.rb#L269) android +##### [string_visible_contains](https://github.com/appium/ruby_lib/blob/b9b8784697d9fbe73d3883cf42d260f19138d8f5/lib/appium_lib/android/common/helper.rb#L269) android > def string_visible_contains(class_name, value) Returns a string that matches the first element that contains value For automationName is Appium @@ -1590,11 +1549,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[String] -- -##### [complex_find_contains](https://github.com/appium/ruby_lib/blob/63a853ea755edb68a3469bd6647f23530c746853/lib/appium_lib/android/common/helper.rb#L287) android +##### [complex_find_contains](https://github.com/appium/ruby_lib/blob/b9b8784697d9fbe73d3883cf42d260f19138d8f5/lib/appium_lib/android/common/helper.rb#L287) android > def complex_find_contains(class_name, value) Find the first element that contains value @@ -1608,11 +1567,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Element] -- -##### [complex_finds_contains](https://github.com/appium/ruby_lib/blob/63a853ea755edb68a3469bd6647f23530c746853/lib/appium_lib/android/common/helper.rb#L295) android +##### [complex_finds_contains](https://github.com/appium/ruby_lib/blob/b9b8784697d9fbe73d3883cf42d260f19138d8f5/lib/appium_lib/android/common/helper.rb#L295) android > def complex_finds_contains(class_name, value) Find all elements containing value @@ -1626,11 +1585,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Array<Element>] -- -##### [complex_find_exact](https://github.com/appium/ruby_lib/blob/63a853ea755edb68a3469bd6647f23530c746853/lib/appium_lib/android/common/helper.rb#L339) android +##### [complex_find_exact](https://github.com/appium/ruby_lib/blob/b9b8784697d9fbe73d3883cf42d260f19138d8f5/lib/appium_lib/android/common/helper.rb#L339) android > def complex_find_exact(class_name, value) Find the first element exactly matching value @@ -1644,11 +1603,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Element] -- -##### [complex_finds_exact](https://github.com/appium/ruby_lib/blob/63a853ea755edb68a3469bd6647f23530c746853/lib/appium_lib/android/common/helper.rb#L347) android +##### [complex_finds_exact](https://github.com/appium/ruby_lib/blob/b9b8784697d9fbe73d3883cf42d260f19138d8f5/lib/appium_lib/android/common/helper.rb#L347) android > def complex_finds_exact(class_name, value) Find all elements exactly matching value @@ -1662,11 +1621,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Element] -- -##### [get_source](https://github.com/appium/ruby_lib/blob/63a853ea755edb68a3469bd6647f23530c746853/lib/appium_lib/android/common/helper.rb#L353) android +##### [get_source](https://github.com/appium/ruby_lib/blob/b9b8784697d9fbe73d3883cf42d260f19138d8f5/lib/appium_lib/android/common/helper.rb#L353) android > def get_source Returns XML string for the current page via `page_source` @@ -1674,11 +1633,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[String] -- -##### [alert_click](https://github.com/appium/ruby_lib/blob/63a853ea755edb68a3469bd6647f23530c746853/lib/appium_lib/android/element/alert.rb#L6) android +##### [alert_click](https://github.com/appium/ruby_lib/blob/b9b8784697d9fbe73d3883cf42d260f19138d8f5/lib/appium_lib/android/element/alert.rb#L6) android > def alert_click(value) Click the first alert button that contains value or by index. @@ -1690,11 +1649,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[void] -- -##### [alert_accept](https://github.com/appium/ruby_lib/blob/63a853ea755edb68a3469bd6647f23530c746853/lib/appium_lib/android/element/alert.rb#L13) android +##### [alert_accept](https://github.com/appium/ruby_lib/blob/b9b8784697d9fbe73d3883cf42d260f19138d8f5/lib/appium_lib/android/element/alert.rb#L13) android > def alert_accept Accept the alert. The last button is considered "accept." @@ -1703,11 +1662,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[void] -- -##### [alert_accept_text](https://github.com/appium/ruby_lib/blob/63a853ea755edb68a3469bd6647f23530c746853/lib/appium_lib/android/element/alert.rb#L20) android +##### [alert_accept_text](https://github.com/appium/ruby_lib/blob/b9b8784697d9fbe73d3883cf42d260f19138d8f5/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." @@ -1716,11 +1675,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[String] -- -##### [alert_dismiss](https://github.com/appium/ruby_lib/blob/63a853ea755edb68a3469bd6647f23530c746853/lib/appium_lib/android/element/alert.rb#L27) android +##### [alert_dismiss](https://github.com/appium/ruby_lib/blob/b9b8784697d9fbe73d3883cf42d260f19138d8f5/lib/appium_lib/android/element/alert.rb#L27) android > def alert_dismiss Dismiss the alert. The first button is considered "dismiss." @@ -1729,11 +1688,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[void] -- -##### [alert_dismiss_text](https://github.com/appium/ruby_lib/blob/63a853ea755edb68a3469bd6647f23530c746853/lib/appium_lib/android/element/alert.rb#L34) android +##### [alert_dismiss_text](https://github.com/appium/ruby_lib/blob/b9b8784697d9fbe73d3883cf42d260f19138d8f5/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." @@ -1742,27 +1701,27 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[String] -- -##### [Button](https://github.com/appium/ruby_lib/blob/63a853ea755edb68a3469bd6647f23530c746853/lib/appium_lib/android/element/button.rb#L3) android +##### [Button](https://github.com/appium/ruby_lib/blob/b9b8784697d9fbe73d3883cf42d260f19138d8f5/lib/appium_lib/android/element/button.rb#L3) android > Button = 'android.widget.Button'.freeze -- -##### [ImageButton](https://github.com/appium/ruby_lib/blob/63a853ea755edb68a3469bd6647f23530c746853/lib/appium_lib/android/element/button.rb#L4) android +##### [ImageButton](https://github.com/appium/ruby_lib/blob/b9b8784697d9fbe73d3883cf42d260f19138d8f5/lib/appium_lib/android/element/button.rb#L4) android > ImageButton = 'android.widget.ImageButton'.freeze -- -##### [button](https://github.com/appium/ruby_lib/blob/63a853ea755edb68a3469bd6647f23530c746853/lib/appium_lib/android/element/button.rb#L10) android +##### [button](https://github.com/appium/ruby_lib/blob/b9b8784697d9fbe73d3883cf42d260f19138d8f5/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. @@ -1775,11 +1734,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Button] -- -##### [buttons](https://github.com/appium/ruby_lib/blob/63a853ea755edb68a3469bd6647f23530c746853/lib/appium_lib/android/element/button.rb#L27) android +##### [buttons](https://github.com/appium/ruby_lib/blob/b9b8784697d9fbe73d3883cf42d260f19138d8f5/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. @@ -1792,11 +1751,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Array<Button>] -- -##### [first_button](https://github.com/appium/ruby_lib/blob/63a853ea755edb68a3469bd6647f23530c746853/lib/appium_lib/android/element/button.rb#L34) android +##### [first_button](https://github.com/appium/ruby_lib/blob/b9b8784697d9fbe73d3883cf42d260f19138d8f5/lib/appium_lib/android/element/button.rb#L34) android > def first_button Find the first button. @@ -1804,11 +1763,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Button] -- -##### [last_button](https://github.com/appium/ruby_lib/blob/63a853ea755edb68a3469bd6647f23530c746853/lib/appium_lib/android/element/button.rb#L40) android +##### [last_button](https://github.com/appium/ruby_lib/blob/b9b8784697d9fbe73d3883cf42d260f19138d8f5/lib/appium_lib/android/element/button.rb#L40) android > def last_button Find the last button. @@ -1816,11 +1775,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Button] -- -##### [button_exact](https://github.com/appium/ruby_lib/blob/63a853ea755edb68a3469bd6647f23530c746853/lib/appium_lib/android/element/button.rb#L56) android +##### [button_exact](https://github.com/appium/ruby_lib/blob/b9b8784697d9fbe73d3883cf42d260f19138d8f5/lib/appium_lib/android/element/button.rb#L56) android > def button_exact(value) Find the first button that exactly matches value. @@ -1832,11 +1791,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Button] -- -##### [buttons_exact](https://github.com/appium/ruby_lib/blob/63a853ea755edb68a3469bd6647f23530c746853/lib/appium_lib/android/element/button.rb#L63) android +##### [buttons_exact](https://github.com/appium/ruby_lib/blob/b9b8784697d9fbe73d3883cf42d260f19138d8f5/lib/appium_lib/android/element/button.rb#L63) android > def buttons_exact(value) Find all buttons that exactly match value. @@ -1848,11 +1807,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Array<Button>] -- -##### [find](https://github.com/appium/ruby_lib/blob/63a853ea755edb68a3469bd6647f23530c746853/lib/appium_lib/android/element/generic.rb#L6) android +##### [find](https://github.com/appium/ruby_lib/blob/b9b8784697d9fbe73d3883cf42d260f19138d8f5/lib/appium_lib/android/element/generic.rb#L6) android > def find(value) Find the first element containing value @@ -1864,11 +1823,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Element] -- -##### [finds](https://github.com/appium/ruby_lib/blob/63a853ea755edb68a3469bd6647f23530c746853/lib/appium_lib/android/element/generic.rb#L13) android +##### [finds](https://github.com/appium/ruby_lib/blob/b9b8784697d9fbe73d3883cf42d260f19138d8f5/lib/appium_lib/android/element/generic.rb#L13) android > def finds(value) Find all elements containing value @@ -1880,11 +1839,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Array<Element>] -- -##### [find_exact](https://github.com/appium/ruby_lib/blob/63a853ea755edb68a3469bd6647f23530c746853/lib/appium_lib/android/element/generic.rb#L20) android +##### [find_exact](https://github.com/appium/ruby_lib/blob/b9b8784697d9fbe73d3883cf42d260f19138d8f5/lib/appium_lib/android/element/generic.rb#L20) android > def find_exact(value) Find the first element exactly matching value @@ -1896,11 +1855,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Element] -- -##### [finds_exact](https://github.com/appium/ruby_lib/blob/63a853ea755edb68a3469bd6647f23530c746853/lib/appium_lib/android/element/generic.rb#L27) android +##### [finds_exact](https://github.com/appium/ruby_lib/blob/b9b8784697d9fbe73d3883cf42d260f19138d8f5/lib/appium_lib/android/element/generic.rb#L27) android > def finds_exact(value) Find all elements exactly matching value @@ -1912,11 +1871,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Array<Element>] -- -##### [scroll_to](https://github.com/appium/ruby_lib/blob/63a853ea755edb68a3469bd6647f23530c746853/lib/appium_lib/android/element/generic.rb#L40) android +##### [scroll_to](https://github.com/appium/ruby_lib/blob/b9b8784697d9fbe73d3883cf42d260f19138d8f5/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. @@ -1930,11 +1889,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Element] the element scrolled to -- -##### [scroll_to_exact](https://github.com/appium/ruby_lib/blob/63a853ea755edb68a3469bd6647f23530c746853/lib/appium_lib/android/element/generic.rb#L58) android +##### [scroll_to_exact](https://github.com/appium/ruby_lib/blob/b9b8784697d9fbe73d3883cf42d260f19138d8f5/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. @@ -1948,19 +1907,19 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Element] the element scrolled to -- -##### [EditText](https://github.com/appium/ruby_lib/blob/63a853ea755edb68a3469bd6647f23530c746853/lib/appium_lib/android/element/textfield.rb#L3) android +##### [EditText](https://github.com/appium/ruby_lib/blob/b9b8784697d9fbe73d3883cf42d260f19138d8f5/lib/appium_lib/android/element/textfield.rb#L3) android > EditText = 'android.widget.EditText'.freeze -- -##### [textfield](https://github.com/appium/ruby_lib/blob/63a853ea755edb68a3469bd6647f23530c746853/lib/appium_lib/android/element/textfield.rb#L9) android +##### [textfield](https://github.com/appium/ruby_lib/blob/b9b8784697d9fbe73d3883cf42d260f19138d8f5/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. @@ -1973,11 +1932,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[EditText] -- -##### [textfields](https://github.com/appium/ruby_lib/blob/63a853ea755edb68a3469bd6647f23530c746853/lib/appium_lib/android/element/textfield.rb#L18) android +##### [textfields](https://github.com/appium/ruby_lib/blob/b9b8784697d9fbe73d3883cf42d260f19138d8f5/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. @@ -1990,11 +1949,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Array<EditText>] -- -##### [first_textfield](https://github.com/appium/ruby_lib/blob/63a853ea755edb68a3469bd6647f23530c746853/lib/appium_lib/android/element/textfield.rb#L25) android +##### [first_textfield](https://github.com/appium/ruby_lib/blob/b9b8784697d9fbe73d3883cf42d260f19138d8f5/lib/appium_lib/android/element/textfield.rb#L25) android > def first_textfield Find the first EditText. @@ -2002,11 +1961,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[EditText] -- -##### [last_textfield](https://github.com/appium/ruby_lib/blob/63a853ea755edb68a3469bd6647f23530c746853/lib/appium_lib/android/element/textfield.rb#L31) android +##### [last_textfield](https://github.com/appium/ruby_lib/blob/b9b8784697d9fbe73d3883cf42d260f19138d8f5/lib/appium_lib/android/element/textfield.rb#L31) android > def last_textfield Find the last EditText. @@ -2014,11 +1973,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[EditText] -- -##### [textfield_exact](https://github.com/appium/ruby_lib/blob/63a853ea755edb68a3469bd6647f23530c746853/lib/appium_lib/android/element/textfield.rb#L38) android +##### [textfield_exact](https://github.com/appium/ruby_lib/blob/b9b8784697d9fbe73d3883cf42d260f19138d8f5/lib/appium_lib/android/element/textfield.rb#L38) android > def textfield_exact(value) Find the first EditText that exactly matches value. @@ -2030,11 +1989,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[EditText] -- -##### [textfields_exact](https://github.com/appium/ruby_lib/blob/63a853ea755edb68a3469bd6647f23530c746853/lib/appium_lib/android/element/textfield.rb#L45) android +##### [textfields_exact](https://github.com/appium/ruby_lib/blob/b9b8784697d9fbe73d3883cf42d260f19138d8f5/lib/appium_lib/android/element/textfield.rb#L45) android > def textfields_exact(value) Find all EditTexts that exactly match value. @@ -2046,19 +2005,19 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Array<EditText>] -- -##### [for](https://github.com/appium/ruby_lib/blob/63a853ea755edb68a3469bd6647f23530c746853/lib/appium_lib/android/uiautomator2/bridge.rb#L7) android +##### [for](https://github.com/appium/ruby_lib/blob/b9b8784697d9fbe73d3883cf42d260f19138d8f5/lib/appium_lib/android/uiautomator2/bridge.rb#L7) android > def self.for(target) -- -##### [string_visible_contains](https://github.com/appium/ruby_lib/blob/63a853ea755edb68a3469bd6647f23530c746853/lib/appium_lib/android/uiautomator2/helper.rb#L13) android +##### [string_visible_contains](https://github.com/appium/ruby_lib/blob/b9b8784697d9fbe73d3883cf42d260f19138d8f5/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 @@ -2075,11 +2034,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[String] -- -##### [complex_find_contains](https://github.com/appium/ruby_lib/blob/63a853ea755edb68a3469bd6647f23530c746853/lib/appium_lib/android/uiautomator2/helper.rb#L31) android +##### [complex_find_contains](https://github.com/appium/ruby_lib/blob/b9b8784697d9fbe73d3883cf42d260f19138d8f5/lib/appium_lib/android/uiautomator2/helper.rb#L31) android > def complex_find_contains(class_name, value) Find the first element that contains value @@ -2093,11 +2052,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Element] -- -##### [complex_finds_contains](https://github.com/appium/ruby_lib/blob/63a853ea755edb68a3469bd6647f23530c746853/lib/appium_lib/android/uiautomator2/helper.rb#L41) android +##### [complex_finds_contains](https://github.com/appium/ruby_lib/blob/b9b8784697d9fbe73d3883cf42d260f19138d8f5/lib/appium_lib/android/uiautomator2/helper.rb#L41) android > def complex_finds_contains(class_name, value) Find all elements containing value @@ -2111,11 +2070,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Array<Element>] -- -##### [complex_find_exact](https://github.com/appium/ruby_lib/blob/63a853ea755edb68a3469bd6647f23530c746853/lib/appium_lib/android/uiautomator2/helper.rb#L69) android +##### [complex_find_exact](https://github.com/appium/ruby_lib/blob/b9b8784697d9fbe73d3883cf42d260f19138d8f5/lib/appium_lib/android/uiautomator2/helper.rb#L69) android > def complex_find_exact(class_name, value) Find the first element exactly matching value @@ -2129,11 +2088,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Element] -- -##### [complex_finds_exact](https://github.com/appium/ruby_lib/blob/63a853ea755edb68a3469bd6647f23530c746853/lib/appium_lib/android/uiautomator2/helper.rb#L79) android +##### [complex_finds_exact](https://github.com/appium/ruby_lib/blob/b9b8784697d9fbe73d3883cf42d260f19138d8f5/lib/appium_lib/android/uiautomator2/helper.rb#L79) android > def complex_finds_exact(class_name, value) Find all elements exactly matching value @@ -2147,11 +2106,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Element] -- -##### [button](https://github.com/appium/ruby_lib/blob/63a853ea755edb68a3469bd6647f23530c746853/lib/appium_lib/android/uiautomator2/element/button.rb#L9) android +##### [button](https://github.com/appium/ruby_lib/blob/b9b8784697d9fbe73d3883cf42d260f19138d8f5/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. @@ -2164,11 +2123,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Button] -- -##### [buttons](https://github.com/appium/ruby_lib/blob/63a853ea755edb68a3469bd6647f23530c746853/lib/appium_lib/android/uiautomator2/element/button.rb#L29) android +##### [buttons](https://github.com/appium/ruby_lib/blob/b9b8784697d9fbe73d3883cf42d260f19138d8f5/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. @@ -2181,11 +2140,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Array<Button>] -- -##### [first_button](https://github.com/appium/ruby_lib/blob/63a853ea755edb68a3469bd6647f23530c746853/lib/appium_lib/android/uiautomator2/element/button.rb#L36) android +##### [first_button](https://github.com/appium/ruby_lib/blob/b9b8784697d9fbe73d3883cf42d260f19138d8f5/lib/appium_lib/android/uiautomator2/element/button.rb#L36) android > def first_button Find the first button. @@ -2193,11 +2152,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Button] -- -##### [last_button](https://github.com/appium/ruby_lib/blob/63a853ea755edb68a3469bd6647f23530c746853/lib/appium_lib/android/uiautomator2/element/button.rb#L43) android +##### [last_button](https://github.com/appium/ruby_lib/blob/b9b8784697d9fbe73d3883cf42d260f19138d8f5/lib/appium_lib/android/uiautomator2/element/button.rb#L43) android > def last_button Find the last button. @@ -2205,11 +2164,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Button] -- -##### [button_exact](https://github.com/appium/ruby_lib/blob/63a853ea755edb68a3469bd6647f23530c746853/lib/appium_lib/android/uiautomator2/element/button.rb#L60) android +##### [button_exact](https://github.com/appium/ruby_lib/blob/b9b8784697d9fbe73d3883cf42d260f19138d8f5/lib/appium_lib/android/uiautomator2/element/button.rb#L60) android > def button_exact(value) Find the first button that exactly matches value. @@ -2221,10 +2180,10 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Button] -- -##### [buttons_exact](https://github.com/appium/ruby_lib/blob/63a853ea755edb68a3469bd6647f23530c746853/lib/appium_lib/android/uiautomator2/element/button.rb#L68) android +##### [buttons_exact](https://github.com/appium/ruby_lib/blob/b9b8784697d9fbe73d3883cf42d260f19138d8f5/lib/appium_lib/android/uiautomator2/element/button.rb#L68) android > def buttons_exact(value) Find all buttons that exactly match value.