docs/android_docs.md in appium_lib-9.4.0 vs docs/android_docs.md in appium_lib-9.4.1

- old
+ new

@@ -1,6 +1,6 @@ -##### [load_settings](https://github.com/appium/ruby_lib/blob/125bb67e570b396d675cb24d7c51f43a24a58897/lib/appium_lib/driver.rb#L76) +##### [load_settings](https://github.com/appium/ruby_lib/blob/43a8f19bee4df0e37ba87663728f665829f26e27/lib/appium_lib/driver.rb#L76) > def self.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/125bb67e570b396d675cb24d7c51f43a24a58897/lib/appium_lib/driver.rb#L112) +##### [load_appium_txt](https://github.com/appium/ruby_lib/blob/43a8f19bee4df0e37ba87663728f665829f26e27/lib/appium_lib/driver.rb#L112) > def self.load_settings(opts = {}) Load arbitrary text ([toml format](https://github.com/toml-lang/toml)) The toml is parsed by https://github.com/fbernier/tomlrb . @@ -55,11 +55,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/125bb67e570b396d675cb24d7c51f43a24a58897/lib/appium_lib/driver.rb#L118) +##### [expand_required_files](https://github.com/appium/ruby_lib/blob/43a8f19bee4df0e37ba87663728f665829f26e27/lib/appium_lib/driver.rb#L118) > def self.expand_required_files(base_dir, file_paths) @@ -73,22 +73,22 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Array] list of require files as an array, nil if require doesn't exist -- -##### [symbolize_keys](https://github.com/appium/ruby_lib/blob/125bb67e570b396d675cb24d7c51f43a24a58897/lib/appium_lib/driver.rb#L150) +##### [symbolize_keys](https://github.com/appium/ruby_lib/blob/43a8f19bee4df0e37ba87663728f665829f26e27/lib/appium_lib/driver.rb#L150) > def self.symbolize_keys(hash) convert all keys (including nested) to symbols based on deep_symbolize_keys & deep_transform_keys from rails https://github.com/rails/docrails/blob/a3b1105ada3da64acfa3843b164b14b734456a50/activesupport/lib/active_support/core_ext/hash/keys.rb#L84 -- -##### [promote_singleton_appium_methods](https://github.com/appium/ruby_lib/blob/125bb67e570b396d675cb24d7c51f43a24a58897/lib/appium_lib/driver.rb#L171) +##### [promote_singleton_appium_methods](https://github.com/appium/ruby_lib/blob/43a8f19bee4df0e37ba87663728f665829f26e27/lib/appium_lib/driver.rb#L171) > def self.promote_singleton_appium_methods(modules) This method is intended to work with page objects that share a common module. For example, Page::HomePage, Page::SignIn @@ -102,11 +102,11 @@ that module are promoted on. otherwise, the array of modules will be used as the promotion target. -- -##### [promote_appium_methods](https://github.com/appium/ruby_lib/blob/125bb67e570b396d675cb24d7c51f43a24a58897/lib/appium_lib/driver.rb#L224) +##### [promote_appium_methods](https://github.com/appium/ruby_lib/blob/43a8f19bee4df0e37ba87663728f665829f26e27/lib/appium_lib/driver.rb#L224) > def self.promote_appium_methods(class_array) Promote appium methods to class instance methods @@ -132,11 +132,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Array<Class>] class_array - An array of classes -- -##### [init_caps_for_appium](https://github.com/appium/ruby_lib/blob/125bb67e570b396d675cb24d7c51f43a24a58897/lib/appium_lib/driver.rb#L259) +##### [init_caps_for_appium](https://github.com/appium/ruby_lib/blob/43a8f19bee4df0e37ba87663728f665829f26e27/lib/appium_lib/driver.rb#L259) > def self.init_caps_for_appium(opts_caps = {}) except for browser_name, default capability is equal to ::Selenium::WebDriver::Remote::Capabilities.firefox Because Selenium::WebDriver::Remote::Bridge uses Capabilities.firefox by default @@ -151,75 +151,75 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Selenium::WebDriver::Remote::Capabilities] Return instance of Selenium::WebDriver::Remote::Capabilities -- -##### [global_webdriver_http_sleep](https://github.com/appium/ruby_lib/blob/125bb67e570b396d675cb24d7c51f43a24a58897/lib/appium_lib/driver.rb#L277) +##### [global_webdriver_http_sleep](https://github.com/appium/ruby_lib/blob/43a8f19bee4df0e37ba87663728f665829f26e27/lib/appium_lib/driver.rb#L277) > 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/125bb67e570b396d675cb24d7c51f43a24a58897/lib/appium_lib/driver.rb#L277) +##### [global_webdriver_http_sleep=](https://github.com/appium/ruby_lib/blob/43a8f19bee4df0e37ba87663728f665829f26e27/lib/appium_lib/driver.rb#L277) > def global_webdriver_http_sleep=(value) The amount to sleep in seconds before every webdriver http call. -- -##### [caps](https://github.com/appium/ruby_lib/blob/125bb67e570b396d675cb24d7c51f43a24a58897/lib/appium_lib/driver.rb#L279) +##### [caps](https://github.com/appium/ruby_lib/blob/43a8f19bee4df0e37ba87663728f665829f26e27/lib/appium_lib/driver.rb#L279) > def caps Selenium webdriver capabilities -- -##### [caps=](https://github.com/appium/ruby_lib/blob/125bb67e570b396d675cb24d7c51f43a24a58897/lib/appium_lib/driver.rb#L279) +##### [caps=](https://github.com/appium/ruby_lib/blob/43a8f19bee4df0e37ba87663728f665829f26e27/lib/appium_lib/driver.rb#L279) > def caps=(value) Selenium webdriver capabilities -- -##### [custom_url](https://github.com/appium/ruby_lib/blob/125bb67e570b396d675cb24d7c51f43a24a58897/lib/appium_lib/driver.rb#L281) +##### [custom_url](https://github.com/appium/ruby_lib/blob/43a8f19bee4df0e37ba87663728f665829f26e27/lib/appium_lib/driver.rb#L281) > def custom_url Custom URL for the selenium server -- -##### [custom_url=](https://github.com/appium/ruby_lib/blob/125bb67e570b396d675cb24d7c51f43a24a58897/lib/appium_lib/driver.rb#L281) +##### [custom_url=](https://github.com/appium/ruby_lib/blob/43a8f19bee4df0e37ba87663728f665829f26e27/lib/appium_lib/driver.rb#L281) > def custom_url=(value) Custom URL for the selenium server -- -##### [export_session](https://github.com/appium/ruby_lib/blob/125bb67e570b396d675cb24d7c51f43a24a58897/lib/appium_lib/driver.rb#L283) +##### [export_session](https://github.com/appium/ruby_lib/blob/43a8f19bee4df0e37ba87663728f665829f26e27/lib/appium_lib/driver.rb#L283) > def export_session Export session id to textfile in /tmp for 3rd party tools -- -##### [export_session=](https://github.com/appium/ruby_lib/blob/125bb67e570b396d675cb24d7c51f43a24a58897/lib/appium_lib/driver.rb#L283) +##### [export_session=](https://github.com/appium/ruby_lib/blob/43a8f19bee4df0e37ba87663728f665829f26e27/lib/appium_lib/driver.rb#L283) > def export_session=(value) Export session id to textfile in /tmp for 3rd party tools -- -##### [default_wait](https://github.com/appium/ruby_lib/blob/125bb67e570b396d675cb24d7c51f43a24a58897/lib/appium_lib/driver.rb#L288) +##### [default_wait](https://github.com/appium/ruby_lib/blob/43a8f19bee4df0e37ba87663728f665829f26e27/lib/appium_lib/driver.rb#L288) > def default_wait Default wait time for elements to appear Returns the default client side wait. @@ -229,140 +229,140 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Integer] -- -##### [sauce_username](https://github.com/appium/ruby_lib/blob/125bb67e570b396d675cb24d7c51f43a24a58897/lib/appium_lib/driver.rb#L290) +##### [sauce_username](https://github.com/appium/ruby_lib/blob/43a8f19bee4df0e37ba87663728f665829f26e27/lib/appium_lib/driver.rb#L290) > def sauce_username Username for use on Sauce Labs. Set `false` to disable Sauce, even when SAUCE_USERNAME is in ENV. -- -##### [sauce_username=](https://github.com/appium/ruby_lib/blob/125bb67e570b396d675cb24d7c51f43a24a58897/lib/appium_lib/driver.rb#L290) +##### [sauce_username=](https://github.com/appium/ruby_lib/blob/43a8f19bee4df0e37ba87663728f665829f26e27/lib/appium_lib/driver.rb#L290) > def sauce_username=(value) Username for use on Sauce Labs. Set `false` to disable Sauce, even when SAUCE_USERNAME is in ENV. -- -##### [sauce_access_key](https://github.com/appium/ruby_lib/blob/125bb67e570b396d675cb24d7c51f43a24a58897/lib/appium_lib/driver.rb#L292) +##### [sauce_access_key](https://github.com/appium/ruby_lib/blob/43a8f19bee4df0e37ba87663728f665829f26e27/lib/appium_lib/driver.rb#L292) > def sauce_access_key Access Key for use on Sauce Labs. Set `false` to disable Sauce, even when SAUCE_ACCESS_KEY is in ENV. -- -##### [sauce_access_key=](https://github.com/appium/ruby_lib/blob/125bb67e570b396d675cb24d7c51f43a24a58897/lib/appium_lib/driver.rb#L292) +##### [sauce_access_key=](https://github.com/appium/ruby_lib/blob/43a8f19bee4df0e37ba87663728f665829f26e27/lib/appium_lib/driver.rb#L292) > def sauce_access_key=(value) Access Key for use on Sauce Labs. Set `false` to disable Sauce, even when SAUCE_ACCESS_KEY is in ENV. -- -##### [sauce_endpoint](https://github.com/appium/ruby_lib/blob/125bb67e570b396d675cb24d7c51f43a24a58897/lib/appium_lib/driver.rb#L294) +##### [sauce_endpoint](https://github.com/appium/ruby_lib/blob/43a8f19bee4df0e37ba87663728f665829f26e27/lib/appium_lib/driver.rb#L294) > def sauce_endpoint Override the Sauce Appium endpoint to allow e.g. TestObject tests -- -##### [sauce_endpoint=](https://github.com/appium/ruby_lib/blob/125bb67e570b396d675cb24d7c51f43a24a58897/lib/appium_lib/driver.rb#L294) +##### [sauce_endpoint=](https://github.com/appium/ruby_lib/blob/43a8f19bee4df0e37ba87663728f665829f26e27/lib/appium_lib/driver.rb#L294) > def sauce_endpoint=(value) Override the Sauce Appium endpoint to allow e.g. TestObject tests -- -##### [appium_port](https://github.com/appium/ruby_lib/blob/125bb67e570b396d675cb24d7c51f43a24a58897/lib/appium_lib/driver.rb#L296) +##### [appium_port](https://github.com/appium/ruby_lib/blob/43a8f19bee4df0e37ba87663728f665829f26e27/lib/appium_lib/driver.rb#L296) > def appium_port Appium's server port -- -##### [appium_port=](https://github.com/appium/ruby_lib/blob/125bb67e570b396d675cb24d7c51f43a24a58897/lib/appium_lib/driver.rb#L296) +##### [appium_port=](https://github.com/appium/ruby_lib/blob/43a8f19bee4df0e37ba87663728f665829f26e27/lib/appium_lib/driver.rb#L296) > def appium_port=(value) Appium's server port -- -##### [appium_device](https://github.com/appium/ruby_lib/blob/125bb67e570b396d675cb24d7c51f43a24a58897/lib/appium_lib/driver.rb#L298) +##### [appium_device](https://github.com/appium/ruby_lib/blob/43a8f19bee4df0e37ba87663728f665829f26e27/lib/appium_lib/driver.rb#L298) > def appium_device Device type to request from the appium server -- -##### [appium_device=](https://github.com/appium/ruby_lib/blob/125bb67e570b396d675cb24d7c51f43a24a58897/lib/appium_lib/driver.rb#L298) +##### [appium_device=](https://github.com/appium/ruby_lib/blob/43a8f19bee4df0e37ba87663728f665829f26e27/lib/appium_lib/driver.rb#L298) > def appium_device=(value) Device type to request from the appium server -- -##### [automation_name](https://github.com/appium/ruby_lib/blob/125bb67e570b396d675cb24d7c51f43a24a58897/lib/appium_lib/driver.rb#L301) +##### [automation_name](https://github.com/appium/ruby_lib/blob/43a8f19bee4df0e37ba87663728f665829f26e27/lib/appium_lib/driver.rb#L301) > def automation_name Automation name sent to appium server or received from server If automation_name is nil, it is not set both client side and server side. -- -##### [appium_server_status](https://github.com/appium/ruby_lib/blob/125bb67e570b396d675cb24d7c51f43a24a58897/lib/appium_lib/driver.rb#L303) +##### [appium_server_status](https://github.com/appium/ruby_lib/blob/43a8f19bee4df0e37ba87663728f665829f26e27/lib/appium_lib/driver.rb#L303) > def appium_server_status Appium's server version -- -##### [appium_debug](https://github.com/appium/ruby_lib/blob/125bb67e570b396d675cb24d7c51f43a24a58897/lib/appium_lib/driver.rb#L305) +##### [appium_debug](https://github.com/appium/ruby_lib/blob/43a8f19bee4df0e37ba87663728f665829f26e27/lib/appium_lib/driver.rb#L305) > def appium_debug Boolean debug mode for the Appium Ruby bindings -- -##### [appium_debug=](https://github.com/appium/ruby_lib/blob/125bb67e570b396d675cb24d7c51f43a24a58897/lib/appium_lib/driver.rb#L305) +##### [appium_debug=](https://github.com/appium/ruby_lib/blob/43a8f19bee4df0e37ba87663728f665829f26e27/lib/appium_lib/driver.rb#L305) > def appium_debug=(value) Boolean debug mode for the Appium Ruby bindings -- -##### [listener](https://github.com/appium/ruby_lib/blob/125bb67e570b396d675cb24d7c51f43a24a58897/lib/appium_lib/driver.rb#L307) +##### [listener](https://github.com/appium/ruby_lib/blob/43a8f19bee4df0e37ba87663728f665829f26e27/lib/appium_lib/driver.rb#L307) > def listener instance of AbstractEventListener for logging support -- -##### [listener=](https://github.com/appium/ruby_lib/blob/125bb67e570b396d675cb24d7c51f43a24a58897/lib/appium_lib/driver.rb#L307) +##### [listener=](https://github.com/appium/ruby_lib/blob/43a8f19bee4df0e37ba87663728f665829f26e27/lib/appium_lib/driver.rb#L307) > def listener=(value) instance of AbstractEventListener for logging support -- -##### [driver](https://github.com/appium/ruby_lib/blob/125bb67e570b396d675cb24d7c51f43a24a58897/lib/appium_lib/driver.rb#L310) +##### [driver](https://github.com/appium/ruby_lib/blob/43a8f19bee4df0e37ba87663728f665829f26e27/lib/appium_lib/driver.rb#L310) > def driver Returns the driver @@ -370,11 +370,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Driver] the driver -- -##### [http_client](https://github.com/appium/ruby_lib/blob/125bb67e570b396d675cb24d7c51f43a24a58897/lib/appium_lib/driver.rb#L313) +##### [http_client](https://github.com/appium/ruby_lib/blob/43a8f19bee4df0e37ba87663728f665829f26e27/lib/appium_lib/driver.rb#L313) > def http_client Return http client called in start_driver() @@ -382,11 +382,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Selenium::WebDriver::Remote::Http::Default] the http client -- -##### [appium_wait_timeout](https://github.com/appium/ruby_lib/blob/125bb67e570b396d675cb24d7c51f43a24a58897/lib/appium_lib/driver.rb#L318) +##### [appium_wait_timeout](https://github.com/appium/ruby_lib/blob/43a8f19bee4df0e37ba87663728f665829f26e27/lib/appium_lib/driver.rb#L318) > def appium_wait_timeout Return a time wait timeout Wait time for ::Appium::Common.wait or ::Appium::Common.wait_true. @@ -396,11 +396,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Integer] -- -##### [appium_wait_interval](https://github.com/appium/ruby_lib/blob/125bb67e570b396d675cb24d7c51f43a24a58897/lib/appium_lib/driver.rb#L323) +##### [appium_wait_interval](https://github.com/appium/ruby_lib/blob/43a8f19bee4df0e37ba87663728f665829f26e27/lib/appium_lib/driver.rb#L323) > def appium_wait_interval Return a time wait timeout Wait interval time for ::Appium::Common.wait or ::Appium::Common.wait_true. @@ -410,11 +410,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Integer] -- -##### [initialize](https://github.com/appium/ruby_lib/blob/125bb67e570b396d675cb24d7c51f43a24a58897/lib/appium_lib/driver.rb#L363) +##### [initialize](https://github.com/appium/ruby_lib/blob/43a8f19bee4df0e37ba87663728f665829f26e27/lib/appium_lib/driver.rb#L363) > def initialize(opts = {}) Creates a new driver @@ -426,19 +426,19 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Driver] -- -##### [driver_attributes](https://github.com/appium/ruby_lib/blob/125bb67e570b396d675cb24d7c51f43a24a58897/lib/appium_lib/driver.rb#L442) +##### [driver_attributes](https://github.com/appium/ruby_lib/blob/43a8f19bee4df0e37ba87663728f665829f26e27/lib/appium_lib/driver.rb#L442) > def driver_attributes Returns a hash of the driver attributes -- -##### [device_is_android?](https://github.com/appium/ruby_lib/blob/125bb67e570b396d675cb24d7c51f43a24a58897/lib/appium_lib/driver.rb#L467) +##### [device_is_android?](https://github.com/appium/ruby_lib/blob/43a8f19bee4df0e37ba87663728f665829f26e27/lib/appium_lib/driver.rb#L467) > def device_is_android? @@ -446,11 +446,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Boolean] -- -##### [automation_name_is_xcuitest?](https://github.com/appium/ruby_lib/blob/125bb67e570b396d675cb24d7c51f43a24a58897/lib/appium_lib/driver.rb#L473) +##### [automation_name_is_xcuitest?](https://github.com/appium/ruby_lib/blob/43a8f19bee4df0e37ba87663728f665829f26e27/lib/appium_lib/driver.rb#L473) > def automation_name_is_xcuitest? Return true if automationName is 'XCUITest' @@ -458,12 +458,24 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Boolean] -- -##### [check_server_version_xcuitest](https://github.com/appium/ruby_lib/blob/125bb67e570b396d675cb24d7c51f43a24a58897/lib/appium_lib/driver.rb#L480) +##### [automation_name_is_uiautomator2?](https://github.com/appium/ruby_lib/blob/43a8f19bee4df0e37ba87663728f665829f26e27/lib/appium_lib/driver.rb#L479) +> def automation_name_is_uiautomator2? + +Return true if automationName is 'uiautomator2' + +__Returns:__ + +&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Boolean] + +-- + +##### [check_server_version_xcuitest](https://github.com/appium/ruby_lib/blob/43a8f19bee4df0e37ba87663728f665829f26e27/lib/appium_lib/driver.rb#L486) + > 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. @@ -471,11 +483,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Boolean] -- -##### [appium_server_version](https://github.com/appium/ruby_lib/blob/125bb67e570b396d675cb24d7c51f43a24a58897/lib/appium_lib/driver.rb#L501) +##### [appium_server_version](https://github.com/appium/ruby_lib/blob/43a8f19bee4df0e37ba87663728f665829f26e27/lib/appium_lib/driver.rb#L507) > def appium_server_version Returns the server's version info @@ -492,11 +504,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Hash] -- -##### [appium_client_version](https://github.com/appium/ruby_lib/blob/125bb67e570b396d675cb24d7c51f43a24a58897/lib/appium_lib/driver.rb#L518) +##### [appium_client_version](https://github.com/appium/ruby_lib/blob/43a8f19bee4df0e37ba87663728f665829f26e27/lib/appium_lib/driver.rb#L524) > def appium_client_version Returns the client's version info @@ -510,11 +522,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Hash] -- -##### [absolute_app_path](https://github.com/appium/ruby_lib/blob/125bb67e570b396d675cb24d7c51f43a24a58897/lib/appium_lib/driver.rb#L530) +##### [absolute_app_path](https://github.com/appium/ruby_lib/blob/43a8f19bee4df0e37ba87663728f665829f26e27/lib/appium_lib/driver.rb#L536) > def self.absolute_app_path(opts) Converts app_path to an absolute path. @@ -527,11 +539,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[String] APP_PATH as an absolute path -- -##### [server_url](https://github.com/appium/ruby_lib/blob/125bb67e570b396d675cb24d7c51f43a24a58897/lib/appium_lib/driver.rb#L563) +##### [server_url](https://github.com/appium/ruby_lib/blob/43a8f19bee4df0e37ba87663728f665829f26e27/lib/appium_lib/driver.rb#L569) > def server_url Get the server url @@ -539,11 +551,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[String] the server url -- -##### [restart](https://github.com/appium/ruby_lib/blob/125bb67e570b396d675cb24d7c51f43a24a58897/lib/appium_lib/driver.rb#L574) +##### [restart](https://github.com/appium/ruby_lib/blob/43a8f19bee4df0e37ba87663728f665829f26e27/lib/appium_lib/driver.rb#L580) > def restart Restarts the driver @@ -551,11 +563,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Driver] the driver -- -##### [screenshot](https://github.com/appium/ruby_lib/blob/125bb67e570b396d675cb24d7c51f43a24a58897/lib/appium_lib/driver.rb#L585) +##### [screenshot](https://github.com/appium/ruby_lib/blob/43a8f19bee4df0e37ba87663728f665829f26e27/lib/appium_lib/driver.rb#L591) > def screenshot(png_save_path) Takes a png screenshot and saves to the target path. @@ -569,11 +581,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[nil] -- -##### [driver_quit](https://github.com/appium/ruby_lib/blob/125bb67e570b396d675cb24d7c51f43a24a58897/lib/appium_lib/driver.rb#L592) +##### [driver_quit](https://github.com/appium/ruby_lib/blob/43a8f19bee4df0e37ba87663728f665829f26e27/lib/appium_lib/driver.rb#L598) > def driver_quit Quits the driver @@ -581,11 +593,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[void] -- -##### [start_driver](https://github.com/appium/ruby_lib/blob/125bb67e570b396d675cb24d7c51f43a24a58897/lib/appium_lib/driver.rb#L602) +##### [start_driver](https://github.com/appium/ruby_lib/blob/43a8f19bee4df0e37ba87663728f665829f26e27/lib/appium_lib/driver.rb#L608) > def start_driver Creates a new global driver and quits the old one if it exists. @@ -593,19 +605,19 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Selenium::WebDriver] the new global driver -- -##### [no_wait](https://github.com/appium/ruby_lib/blob/125bb67e570b396d675cb24d7c51f43a24a58897/lib/appium_lib/driver.rb#L640) +##### [no_wait](https://github.com/appium/ruby_lib/blob/43a8f19bee4df0e37ba87663728f665829f26e27/lib/appium_lib/driver.rb#L646) > def no_wait Set implicit wait to zero. -- -##### [set_wait](https://github.com/appium/ruby_lib/blob/125bb67e570b396d675cb24d7c51f43a24a58897/lib/appium_lib/driver.rb#L654) +##### [set_wait](https://github.com/appium/ruby_lib/blob/43a8f19bee4df0e37ba87663728f665829f26e27/lib/appium_lib/driver.rb#L660) > def set_wait(timeout = nil) Set implicit wait. Default to @default_wait. @@ -623,11 +635,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[void] -- -##### [exists](https://github.com/appium/ruby_lib/blob/125bb67e570b396d675cb24d7c51f43a24a58897/lib/appium_lib/driver.rb#L671) +##### [exists](https://github.com/appium/ruby_lib/blob/43a8f19bee4df0e37ba87663728f665829f26e27/lib/appium_lib/driver.rb#L677) > def exists(pre_check = 0, post_check = @default_wait) Returns existence of element. @@ -647,11 +659,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Boolean] -- -##### [execute_script](https://github.com/appium/ruby_lib/blob/125bb67e570b396d675cb24d7c51f43a24a58897/lib/appium_lib/driver.rb#L695) +##### [execute_script](https://github.com/appium/ruby_lib/blob/43a8f19bee4df0e37ba87663728f665829f26e27/lib/appium_lib/driver.rb#L701) > def execute_script(script, *args) The same as @driver.execute_script @@ -665,11 +677,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Object] -- -##### [find_elements](https://github.com/appium/ruby_lib/blob/125bb67e570b396d675cb24d7c51f43a24a58897/lib/appium_lib/driver.rb#L717) +##### [find_elements](https://github.com/appium/ruby_lib/blob/43a8f19bee4df0e37ba87663728f665829f26e27/lib/appium_lib/driver.rb#L723) > def find_elements(*args) Calls @driver.find_elements_with_appium @@ -691,11 +703,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/125bb67e570b396d675cb24d7c51f43a24a58897/lib/appium_lib/driver.rb#L732) +##### [find_element](https://github.com/appium/ruby_lib/blob/43a8f19bee4df0e37ba87663728f665829f26e27/lib/appium_lib/driver.rb#L738) > def find_element(*args) Calls @driver.find_element @@ -712,11 +724,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Element] -- -##### [set_location](https://github.com/appium/ruby_lib/blob/125bb67e570b396d675cb24d7c51f43a24a58897/lib/appium_lib/driver.rb#L745) +##### [set_location](https://github.com/appium/ruby_lib/blob/43a8f19bee4df0e37ba87663728f665829f26e27/lib/appium_lib/driver.rb#L751) > def set_location(opts = {}) Calls @driver.set_location @@ -728,11 +740,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Selenium::WebDriver::Location] the location constructed by the selenium webdriver -- -##### [x](https://github.com/appium/ruby_lib/blob/125bb67e570b396d675cb24d7c51f43a24a58897/lib/appium_lib/driver.rb#L755) +##### [x](https://github.com/appium/ruby_lib/blob/43a8f19bee4df0e37ba87663728f665829f26e27/lib/appium_lib/driver.rb#L761) > def x Quit the driver and Pry. quit and exit are reserved by Pry. @@ -741,20 +753,20 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[void] -- -##### [set_automation_name_if_nil](https://github.com/appium/ruby_lib/blob/125bb67e570b396d675cb24d7c51f43a24a58897/lib/appium_lib/driver.rb#L764) +##### [set_automation_name_if_nil](https://github.com/appium/ruby_lib/blob/43a8f19bee4df0e37ba87663728f665829f26e27/lib/appium_lib/driver.rb#L770) > def set_automation_name_if_nil If "automationName" is set only server side, this method set "automationName" attribute into @automation_name. Since @automation_name is set only client side before start_driver is called. -- -##### [logger=](https://github.com/appium/ruby_lib/blob/125bb67e570b396d675cb24d7c51f43a24a58897/lib/appium_lib/logger.rb#L13) +##### [logger=](https://github.com/appium/ruby_lib/blob/43a8f19bee4df0e37ba87663728f665829f26e27/lib/appium_lib/logger.rb#L13) > def logger=(value) Sets the attribute logger @@ -762,47 +774,47 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;value - the value to set the attribute logger to. -- -##### [logger](https://github.com/appium/ruby_lib/blob/125bb67e570b396d675cb24d7c51f43a24a58897/lib/appium_lib/logger.rb#L17) +##### [logger](https://github.com/appium/ruby_lib/blob/43a8f19bee4df0e37ba87663728f665829f26e27/lib/appium_lib/logger.rb#L17) > def logger -- -##### [app_strings](https://github.com/appium/ruby_lib/blob/125bb67e570b396d675cb24d7c51f43a24a58897/lib/appium_lib/device/device.rb#L7) +##### [app_strings](https://github.com/appium/ruby_lib/blob/43a8f19bee4df0e37ba87663728f665829f26e27/lib/appium_lib/device/device.rb#L7) > def app_strings Return the hash of all localization strings. ```ruby app_strings #=> "TransitionsTitle"=>"Transitions", "WebTitle"=>"Web" ``` -- -##### [background_app](https://github.com/appium/ruby_lib/blob/125bb67e570b396d675cb24d7c51f43a24a58897/lib/appium_lib/device/device.rb#L13) +##### [background_app](https://github.com/appium/ruby_lib/blob/43a8f19bee4df0e37ba87663728f665829f26e27/lib/appium_lib/device/device.rb#L13) > def background_app Backgrounds the app for a set number of seconds. This is a blocking application -- -##### [current_activity](https://github.com/appium/ruby_lib/blob/125bb67e570b396d675cb24d7c51f43a24a58897/lib/appium_lib/device/device.rb#L24) +##### [current_activity](https://github.com/appium/ruby_lib/blob/43a8f19bee4df0e37ba87663728f665829f26e27/lib/appium_lib/device/device.rb#L24) > def current_activity -- -##### [get_system_bars](https://github.com/appium/ruby_lib/blob/125bb67e570b396d675cb24d7c51f43a24a58897/lib/appium_lib/device/device.rb#L26) +##### [get_system_bars](https://github.com/appium/ruby_lib/blob/43a8f19bee4df0e37ba87663728f665829f26e27/lib/appium_lib/device/device.rb#L26) > def get_system_bars Get system bar's information ```ruby @@ -813,11 +825,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[String] System bar -- -##### [get_display_density](https://github.com/appium/ruby_lib/blob/125bb67e570b396d675cb24d7c51f43a24a58897/lib/appium_lib/device/device.rb#L34) +##### [get_display_density](https://github.com/appium/ruby_lib/blob/43a8f19bee4df0e37ba87663728f665829f26e27/lib/appium_lib/device/device.rb#L34) > def get_display_density Get connected device's density. ```ruby @@ -828,11 +840,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Integer] The size of density -- -##### [is_keyboard_shown](https://github.com/appium/ruby_lib/blob/125bb67e570b396d675cb24d7c51f43a24a58897/lib/appium_lib/device/device.rb#L42) +##### [is_keyboard_shown](https://github.com/appium/ruby_lib/blob/43a8f19bee4df0e37ba87663728f665829f26e27/lib/appium_lib/device/device.rb#L42) > def is_keyboard_shown Get whether keyboard is displayed or not. ```ruby @@ -843,51 +855,51 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Bool] Return true if keyboard is shown. Return false if keyboard is hidden. -- -##### [launch_app](https://github.com/appium/ruby_lib/blob/125bb67e570b396d675cb24d7c51f43a24a58897/lib/appium_lib/device/device.rb#L50) +##### [launch_app](https://github.com/appium/ruby_lib/blob/43a8f19bee4df0e37ba87663728f665829f26e27/lib/appium_lib/device/device.rb#L50) > def launch_app Start the simulator and application configured with desired capabilities -- -##### [reset](https://github.com/appium/ruby_lib/blob/125bb67e570b396d675cb24d7c51f43a24a58897/lib/appium_lib/device/device.rb#L53) +##### [reset](https://github.com/appium/ruby_lib/blob/43a8f19bee4df0e37ba87663728f665829f26e27/lib/appium_lib/device/device.rb#L53) > def reset Reset the device, relaunching the application. -- -##### [shake](https://github.com/appium/ruby_lib/blob/125bb67e570b396d675cb24d7c51f43a24a58897/lib/appium_lib/device/device.rb#L56) +##### [shake](https://github.com/appium/ruby_lib/blob/43a8f19bee4df0e37ba87663728f665829f26e27/lib/appium_lib/device/device.rb#L56) > def shake Cause the device to shake -- -##### [toggle_flight_mode](https://github.com/appium/ruby_lib/blob/125bb67e570b396d675cb24d7c51f43a24a58897/lib/appium_lib/device/device.rb#L59) +##### [toggle_flight_mode](https://github.com/appium/ruby_lib/blob/43a8f19bee4df0e37ba87663728f665829f26e27/lib/appium_lib/device/device.rb#L59) > def toggle_flight_mode Toggle flight mode on or off -- -##### [device_locked?](https://github.com/appium/ruby_lib/blob/125bb67e570b396d675cb24d7c51f43a24a58897/lib/appium_lib/device/device.rb#L62) +##### [device_locked?](https://github.com/appium/ruby_lib/blob/43a8f19bee4df0e37ba87663728f665829f26e27/lib/appium_lib/device/device.rb#L62) > def device_locked? -- -##### [hide_keyboard](https://github.com/appium/ruby_lib/blob/125bb67e570b396d675cb24d7c51f43a24a58897/lib/appium_lib/device/device.rb#L64) +##### [hide_keyboard](https://github.com/appium/ruby_lib/blob/43a8f19bee4df0e37ba87663728f665829f26e27/lib/appium_lib/device/device.rb#L64) > def hide_keyboard Hide the onscreen keyboard @@ -896,11 +908,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[String] close_key - The name of the key which closes the keyboard. Defaults to 'Done'. -- -##### [press_keycode](https://github.com/appium/ruby_lib/blob/125bb67e570b396d675cb24d7c51f43a24a58897/lib/appium_lib/device/device.rb#L73) +##### [press_keycode](https://github.com/appium/ruby_lib/blob/43a8f19bee4df0e37ba87663728f665829f26e27/lib/appium_lib/device/device.rb#L73) > def press_keycode Press keycode on the device. http://developer.android.com/reference/android/view/KeyEvent.html @@ -911,11 +923,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[String] metastate - The state the metakeys should be in when pressing the key. -- -##### [long_press_keycode](https://github.com/appium/ruby_lib/blob/125bb67e570b396d675cb24d7c51f43a24a58897/lib/appium_lib/device/device.rb#L79) +##### [long_press_keycode](https://github.com/appium/ruby_lib/blob/43a8f19bee4df0e37ba87663728f665829f26e27/lib/appium_lib/device/device.rb#L79) > def long_press_keycode Long press keycode on the device. http://developer.android.com/reference/android/view/KeyEvent.html @@ -926,11 +938,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[String] metastate - The state the metakeys should be in when long pressing the key. -- -##### [push_file](https://github.com/appium/ruby_lib/blob/125bb67e570b396d675cb24d7c51f43a24a58897/lib/appium_lib/device/device.rb#L85) +##### [push_file](https://github.com/appium/ruby_lib/blob/43a8f19bee4df0e37ba87663728f665829f26e27/lib/appium_lib/device/device.rb#L85) > def push_file Place a file in a specific location on the device. @@ -940,11 +952,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[String] data - Raw file data to be sent to the device. -- -##### [pull_file](https://github.com/appium/ruby_lib/blob/125bb67e570b396d675cb24d7c51f43a24a58897/lib/appium_lib/device/device.rb#L90) +##### [pull_file](https://github.com/appium/ruby_lib/blob/43a8f19bee4df0e37ba87663728f665829f26e27/lib/appium_lib/device/device.rb#L90) > def pull_file Retrieve a file from the device. This can retrieve an absolute path or a path relative to the installed app (iOS only). @@ -957,11 +969,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[String] path - Either an absolute path OR, for iOS devices, a path relative to the app, as described. -- -##### [pull_folder](https://github.com/appium/ruby_lib/blob/125bb67e570b396d675cb24d7c51f43a24a58897/lib/appium_lib/device/device.rb#L100) +##### [pull_folder](https://github.com/appium/ruby_lib/blob/43a8f19bee4df0e37ba87663728f665829f26e27/lib/appium_lib/device/device.rb#L100) > def pull_folder Retrieve a folder from the device. ```ruby @@ -972,11 +984,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[String] path - absolute path to the folder -- -##### [touch_id](https://github.com/appium/ruby_lib/blob/125bb67e570b396d675cb24d7c51f43a24a58897/lib/appium_lib/device/device.rb#L108) +##### [touch_id](https://github.com/appium/ruby_lib/blob/43a8f19bee4df0e37ba87663728f665829f26e27/lib/appium_lib/device/device.rb#L108) > def touch_id iOS only; Simulate Touch ID with either valid (match == true) or invalid (match == false) fingerprint. ```ruby @@ -989,19 +1001,19 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Boolean] match - fingerprint validity Defaults to true. -- -##### [toggle_touch_id_enrollment](https://github.com/appium/ruby_lib/blob/125bb67e570b396d675cb24d7c51f43a24a58897/lib/appium_lib/device/device.rb#L117) +##### [toggle_touch_id_enrollment](https://github.com/appium/ruby_lib/blob/43a8f19bee4df0e37ba87663728f665829f26e27/lib/appium_lib/device/device.rb#L117) > def toggle_touch_id_enrollment iOS Simulator only: Toggle touch id enrollment on an iOS Simulator. -- -##### [end_coverage](https://github.com/appium/ruby_lib/blob/125bb67e570b396d675cb24d7c51f43a24a58897/lib/appium_lib/device/device.rb#L120) +##### [end_coverage](https://github.com/appium/ruby_lib/blob/43a8f19bee4df0e37ba87663728f665829f26e27/lib/appium_lib/device/device.rb#L120) > def end_coverage Android only; Ends the test coverage and writes the results to the given path on device. @@ -1011,19 +1023,19 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[String] intent - Intent to broadcast when ending coverage. -- -##### [get_settings](https://github.com/appium/ruby_lib/blob/125bb67e570b396d675cb24d7c51f43a24a58897/lib/appium_lib/device/device.rb#L125) +##### [get_settings](https://github.com/appium/ruby_lib/blob/43a8f19bee4df0e37ba87663728f665829f26e27/lib/appium_lib/device/device.rb#L125) > def get_settings Get appium Settings for current test session -- -##### [update_settings](https://github.com/appium/ruby_lib/blob/125bb67e570b396d675cb24d7c51f43a24a58897/lib/appium_lib/device/device.rb#L128) +##### [update_settings](https://github.com/appium/ruby_lib/blob/43a8f19bee4df0e37ba87663728f665829f26e27/lib/appium_lib/device/device.rb#L128) > def update_settings Update appium Settings for current test session @@ -1031,11 +1043,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Hash] settings - Settings to update, keys are settings, values to value to set each setting to -- -##### [start_activity](https://github.com/appium/ruby_lib/blob/125bb67e570b396d675cb24d7c51f43a24a58897/lib/appium_lib/device/device.rb#L132) +##### [start_activity](https://github.com/appium/ruby_lib/blob/43a8f19bee4df0e37ba87663728f665829f26e27/lib/appium_lib/device/device.rb#L132) > def start_activity Start a new activity within the current app or launch a new app and start the target activity. @@ -1045,20 +1057,20 @@ app_activity: '.accessibility.AccessibilityNodeProviderActivity' ``` -- -##### [get_network_connection](https://github.com/appium/ruby_lib/blob/125bb67e570b396d675cb24d7c51f43a24a58897/lib/appium_lib/device/device.rb#L146) +##### [get_network_connection](https://github.com/appium/ruby_lib/blob/43a8f19bee4df0e37ba87663728f665829f26e27/lib/appium_lib/device/device.rb#L146) > def get_network_connection Get the device network connection current status See set_network_connection method for return value -- -##### [set_network_connection](https://github.com/appium/ruby_lib/blob/125bb67e570b396d675cb24d7c51f43a24a58897/lib/appium_lib/device/device.rb#L150) +##### [set_network_connection](https://github.com/appium/ruby_lib/blob/43a8f19bee4df0e37ba87663728f665829f26e27/lib/appium_lib/device/device.rb#L150) > def set_network_connection Set the device network connection mode Value (Alias) | Data | Wifi | Airplane Mode @@ -1073,11 +1085,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[String] path - Bit mask that represent the network mode -- -##### [set_immediate_value](https://github.com/appium/ruby_lib/blob/125bb67e570b396d675cb24d7c51f43a24a58897/lib/appium_lib/device/device.rb#L163) +##### [set_immediate_value](https://github.com/appium/ruby_lib/blob/43a8f19bee4df0e37ba87663728f665829f26e27/lib/appium_lib/device/device.rb#L163) > def set_immediate_value Set the value to element directly for iOS; setValue is called in XCUITest instead because XCUITest doesn't provide set value directly. @@ -1087,11 +1099,11 @@ set_immediate_value element, 'hello' ``` -- -##### [get_performance_data_types](https://github.com/appium/ruby_lib/blob/125bb67e570b396d675cb24d7c51f43a24a58897/lib/appium_lib/device/device.rb#L172) +##### [get_performance_data_types](https://github.com/appium/ruby_lib/blob/43a8f19bee4df0e37ba87663728f665829f26e27/lib/appium_lib/device/device.rb#L172) > def get_performance_data_types Get the information type of the system state which is supported to read such as cpu, memory, network, battery via adb commands. @@ -1101,27 +1113,27 @@ get_performance_data_types #=> ["cpuinfo", "batteryinfo", "networkinfo", "memoryinfo"] ``` -- -##### [extend_search_contexts](https://github.com/appium/ruby_lib/blob/125bb67e570b396d675cb24d7c51f43a24a58897/lib/appium_lib/device/device.rb#L434) +##### [extend_search_contexts](https://github.com/appium/ruby_lib/blob/43a8f19bee4df0e37ba87663728f665829f26e27/lib/appium_lib/device/device.rb#L434) > def extend_search_contexts -- -##### [find_element_with_appium](https://github.com/appium/ruby_lib/blob/125bb67e570b396d675cb24d7c51f43a24a58897/lib/appium_lib/device/device.rb#L434) +##### [find_element_with_appium](https://github.com/appium/ruby_lib/blob/43a8f19bee4df0e37ba87663728f665829f26e27/lib/appium_lib/device/device.rb#L434) > def find_element_with_appium -- -##### [find_elements_with_appium](https://github.com/appium/ruby_lib/blob/125bb67e570b396d675cb24d7c51f43a24a58897/lib/appium_lib/device/device.rb#L434) +##### [find_elements_with_appium](https://github.com/appium/ruby_lib/blob/43a8f19bee4df0e37ba87663728f665829f26e27/lib/appium_lib/device/device.rb#L434) > def find_elements_with_appium find_element/s_with_appium with their accessibility_id @@ -1129,27 +1141,27 @@ find_elements :accessibility_id, 'Animation' ``` -- -##### [add_touch_actions](https://github.com/appium/ruby_lib/blob/125bb67e570b396d675cb24d7c51f43a24a58897/lib/appium_lib/device/device.rb#L465) +##### [add_touch_actions](https://github.com/appium/ruby_lib/blob/43a8f19bee4df0e37ba87663728f665829f26e27/lib/appium_lib/device/device.rb#L465) > def add_touch_actions -- -##### [add_ime_actions](https://github.com/appium/ruby_lib/blob/125bb67e570b396d675cb24d7c51f43a24a58897/lib/appium_lib/device/device.rb#L488) +##### [add_ime_actions](https://github.com/appium/ruby_lib/blob/43a8f19bee4df0e37ba87663728f665829f26e27/lib/appium_lib/device/device.rb#L488) > def add_ime_actions -- -##### [set_context](https://github.com/appium/ruby_lib/blob/125bb67e570b396d675cb24d7c51f43a24a58897/lib/appium_lib/device/device.rb#L563) +##### [set_context](https://github.com/appium/ruby_lib/blob/43a8f19bee4df0e37ba87663728f665829f26e27/lib/appium_lib/device/device.rb#L563) > def set_context Change the context to the given context. ```ruby @@ -1160,11 +1172,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[String] The - context to change to -- -##### [current_context](https://github.com/appium/ruby_lib/blob/125bb67e570b396d675cb24d7c51f43a24a58897/lib/appium_lib/device/device.rb#L571) +##### [current_context](https://github.com/appium/ruby_lib/blob/43a8f19bee4df0e37ba87663728f665829f26e27/lib/appium_lib/device/device.rb#L571) > def current_context @@ -1172,11 +1184,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[String] The context currently being used. -- -##### [available_contexts](https://github.com/appium/ruby_lib/blob/125bb67e570b396d675cb24d7c51f43a24a58897/lib/appium_lib/device/device.rb#L574) +##### [available_contexts](https://github.com/appium/ruby_lib/blob/43a8f19bee4df0e37ba87663728f665829f26e27/lib/appium_lib/device/device.rb#L574) > def available_contexts @@ -1184,11 +1196,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Array<String>] All usable contexts, as an array of strings. -- -##### [within_context](https://github.com/appium/ruby_lib/blob/125bb67e570b396d675cb24d7c51f43a24a58897/lib/appium_lib/device/device.rb#L584) +##### [within_context](https://github.com/appium/ruby_lib/blob/43a8f19bee4df0e37ba87663728f665829f26e27/lib/appium_lib/device/device.rb#L584) > def within_context(context) Perform a block within the given context, then switch back to the starting context. ```ruby @@ -1200,19 +1212,19 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[String] context - The context to switch to for the duration of the block. -- -##### [switch_to_default_context](https://github.com/appium/ruby_lib/blob/125bb67e570b396d675cb24d7c51f43a24a58897/lib/appium_lib/device/device.rb#L592) +##### [switch_to_default_context](https://github.com/appium/ruby_lib/blob/43a8f19bee4df0e37ba87663728f665829f26e27/lib/appium_lib/device/device.rb#L592) > def switch_to_default_context Change to the default context. This is equivalent to `set_context nil`. -- -##### [pinch](https://github.com/appium/ruby_lib/blob/125bb67e570b396d675cb24d7c51f43a24a58897/lib/appium_lib/device/multi_touch.rb#L28) +##### [pinch](https://github.com/appium/ruby_lib/blob/43a8f19bee4df0e37ba87663728f665829f26e27/lib/appium_lib/device/multi_touch.rb#L28) > def pinch(percentage = 25, auto_perform = true) Convenience method for pinching the screen. Places two fingers at the edges of the screen and brings them together. @@ -1227,11 +1239,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[boolean] auto_perform - Whether to perform the action immediately (default true) -- -##### [zoom](https://github.com/appium/ruby_lib/blob/125bb67e570b396d675cb24d7c51f43a24a58897/lib/appium_lib/device/multi_touch.rb#L57) +##### [zoom](https://github.com/appium/ruby_lib/blob/43a8f19bee4df0e37ba87663728f665829f26e27/lib/appium_lib/device/multi_touch.rb#L57) > def zoom(percentage = 200, auto_perform = true) Convenience method for zooming the screen. Places two fingers at the edges of the screen and brings them together. @@ -1246,67 +1258,67 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[boolean] auto_perform - Whether to perform the action immediately (default true) -- -##### [pinch_for_xcuitest](https://github.com/appium/ruby_lib/blob/125bb67e570b396d675cb24d7c51f43a24a58897/lib/appium_lib/device/multi_touch.rb#L79) +##### [pinch_for_xcuitest](https://github.com/appium/ruby_lib/blob/43a8f19bee4df0e37ba87663728f665829f26e27/lib/appium_lib/device/multi_touch.rb#L79) > def pinch_for_xcuitest(rate) -- -##### [pinch_android](https://github.com/appium/ruby_lib/blob/125bb67e570b396d675cb24d7c51f43a24a58897/lib/appium_lib/device/multi_touch.rb#L94) +##### [pinch_android](https://github.com/appium/ruby_lib/blob/43a8f19bee4df0e37ba87663728f665829f26e27/lib/appium_lib/device/multi_touch.rb#L94) > def pinch_android(rate) -- -##### [pinch_ios](https://github.com/appium/ruby_lib/blob/125bb67e570b396d675cb24d7c51f43a24a58897/lib/appium_lib/device/multi_touch.rb#L108) +##### [pinch_ios](https://github.com/appium/ruby_lib/blob/43a8f19bee4df0e37ba87663728f665829f26e27/lib/appium_lib/device/multi_touch.rb#L108) > def pinch_ios(rate) -- -##### [zoom_for_xcuitest](https://github.com/appium/ruby_lib/blob/125bb67e570b396d675cb24d7c51f43a24a58897/lib/appium_lib/device/multi_touch.rb#L122) +##### [zoom_for_xcuitest](https://github.com/appium/ruby_lib/blob/43a8f19bee4df0e37ba87663728f665829f26e27/lib/appium_lib/device/multi_touch.rb#L122) > def zoom_for_xcuitest(rate) -- -##### [zoom_android](https://github.com/appium/ruby_lib/blob/125bb67e570b396d675cb24d7c51f43a24a58897/lib/appium_lib/device/multi_touch.rb#L137) +##### [zoom_android](https://github.com/appium/ruby_lib/blob/43a8f19bee4df0e37ba87663728f665829f26e27/lib/appium_lib/device/multi_touch.rb#L137) > def zoom_android(rate) -- -##### [zoom_ios](https://github.com/appium/ruby_lib/blob/125bb67e570b396d675cb24d7c51f43a24a58897/lib/appium_lib/device/multi_touch.rb#L151) +##### [zoom_ios](https://github.com/appium/ruby_lib/blob/43a8f19bee4df0e37ba87663728f665829f26e27/lib/appium_lib/device/multi_touch.rb#L151) > def zoom_ios(rate) -- -##### [actions](https://github.com/appium/ruby_lib/blob/125bb67e570b396d675cb24d7c51f43a24a58897/lib/appium_lib/device/multi_touch.rb#L166) +##### [actions](https://github.com/appium/ruby_lib/blob/43a8f19bee4df0e37ba87663728f665829f26e27/lib/appium_lib/device/multi_touch.rb#L166) > def actions self -- -##### [initialize](https://github.com/appium/ruby_lib/blob/125bb67e570b396d675cb24d7c51f43a24a58897/lib/appium_lib/device/multi_touch.rb#L169) +##### [initialize](https://github.com/appium/ruby_lib/blob/43a8f19bee4df0e37ba87663728f665829f26e27/lib/appium_lib/device/multi_touch.rb#L169) > def initialize Create a new multi-action @@ -1314,11 +1326,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[MultiTouch] a new instance of MultiTouch -- -##### [add](https://github.com/appium/ruby_lib/blob/125bb67e570b396d675cb24d7c51f43a24a58897/lib/appium_lib/device/multi_touch.rb#L175) +##### [add](https://github.com/appium/ruby_lib/blob/43a8f19bee4df0e37ba87663728f665829f26e27/lib/appium_lib/device/multi_touch.rb#L175) > def add(chain) Add a touch_action to be performed @@ -1326,43 +1338,43 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[TouchAction] chain - The action to add to the chain -- -##### [perform](https://github.com/appium/ruby_lib/blob/125bb67e570b396d675cb24d7c51f43a24a58897/lib/appium_lib/device/multi_touch.rb#L180) +##### [perform](https://github.com/appium/ruby_lib/blob/43a8f19bee4df0e37ba87663728f665829f26e27/lib/appium_lib/device/multi_touch.rb#L180) > def perform Ask Appium to perform the actions -- -##### [ACTIONS](https://github.com/appium/ruby_lib/blob/125bb67e570b396d675cb24d7c51f43a24a58897/lib/appium_lib/device/touch_actions.rb#L20) +##### [ACTIONS](https://github.com/appium/ruby_lib/blob/43a8f19bee4df0e37ba87663728f665829f26e27/lib/appium_lib/device/touch_actions.rb#L20) > ACTIONS = [:move_to, :long_press, :double_tap, :two_finger_tap, :press, :release, :tap, :wait, :perform].freeze -- -##### [COMPLEX_ACTIONS](https://github.com/appium/ruby_lib/blob/125bb67e570b396d675cb24d7c51f43a24a58897/lib/appium_lib/device/touch_actions.rb#L21) +##### [COMPLEX_ACTIONS](https://github.com/appium/ruby_lib/blob/43a8f19bee4df0e37ba87663728f665829f26e27/lib/appium_lib/device/touch_actions.rb#L21) > COMPLEX_ACTIONS = [:swipe].freeze -- -##### [actions](https://github.com/appium/ruby_lib/blob/125bb67e570b396d675cb24d7c51f43a24a58897/lib/appium_lib/device/touch_actions.rb#L35) +##### [actions](https://github.com/appium/ruby_lib/blob/43a8f19bee4df0e37ba87663728f665829f26e27/lib/appium_lib/device/touch_actions.rb#L35) > def actions Returns the value of attribute actions -- -##### [initialize](https://github.com/appium/ruby_lib/blob/125bb67e570b396d675cb24d7c51f43a24a58897/lib/appium_lib/device/touch_actions.rb#L37) +##### [initialize](https://github.com/appium/ruby_lib/blob/43a8f19bee4df0e37ba87663728f665829f26e27/lib/appium_lib/device/touch_actions.rb#L37) > def initialize @@ -1370,11 +1382,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[TouchAction] a new instance of TouchAction -- -##### [move_to](https://github.com/appium/ruby_lib/blob/125bb67e570b396d675cb24d7c51f43a24a58897/lib/appium_lib/device/touch_actions.rb#L48) +##### [move_to](https://github.com/appium/ruby_lib/blob/43a8f19bee4df0e37ba87663728f665829f26e27/lib/appium_lib/device/touch_actions.rb#L48) > def move_to(opts) Move to the given co-ordinates. @@ -1384,11 +1396,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Hash] opts - a customizable set of options -- -##### [long_press](https://github.com/appium/ruby_lib/blob/125bb67e570b396d675cb24d7c51f43a24a58897/lib/appium_lib/device/touch_actions.rb#L62) +##### [long_press](https://github.com/appium/ruby_lib/blob/43a8f19bee4df0e37ba87663728f665829f26e27/lib/appium_lib/device/touch_actions.rb#L62) > def long_press(opts) Press down for a specific duration. Alternatively, you can use `press(...).wait(...).release()` instead of `long_press` if duration doesn't work well. @@ -1405,11 +1417,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Hash] duration - a customizable set of options -- -##### [press](https://github.com/appium/ruby_lib/blob/125bb67e570b396d675cb24d7c51f43a24a58897/lib/appium_lib/device/touch_actions.rb#L74) +##### [press](https://github.com/appium/ruby_lib/blob/43a8f19bee4df0e37ba87663728f665829f26e27/lib/appium_lib/device/touch_actions.rb#L74) > def press(opts) Press a finger onto the screen. Finger will stay down until you call `release`. @@ -1418,11 +1430,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Hash] opts - a customizable set of options -- -##### [release](https://github.com/appium/ruby_lib/blob/125bb67e570b396d675cb24d7c51f43a24a58897/lib/appium_lib/device/touch_actions.rb#L85) +##### [release](https://github.com/appium/ruby_lib/blob/43a8f19bee4df0e37ba87663728f665829f26e27/lib/appium_lib/device/touch_actions.rb#L85) > def release(opts = nil) Remove a finger from the screen. @@ -1430,11 +1442,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Hash] opts - a customizable set of options -- -##### [tap](https://github.com/appium/ruby_lib/blob/125bb67e570b396d675cb24d7c51f43a24a58897/lib/appium_lib/device/touch_actions.rb#L97) +##### [tap](https://github.com/appium/ruby_lib/blob/43a8f19bee4df0e37ba87663728f665829f26e27/lib/appium_lib/device/touch_actions.rb#L97) > def tap(opts) Touch a point on the screen. Alternatively, you can use `press(...).release.perform` instead of `tap(...).perform`. @@ -1443,11 +1455,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Hash] opts - a customizable set of options -- -##### [double_tap](https://github.com/appium/ruby_lib/blob/125bb67e570b396d675cb24d7c51f43a24a58897/lib/appium_lib/device/touch_actions.rb#L110) +##### [double_tap](https://github.com/appium/ruby_lib/blob/43a8f19bee4df0e37ba87663728f665829f26e27/lib/appium_lib/device/touch_actions.rb#L110) > def double_tap(opts) Double tap an element on the screen @@ -1455,11 +1467,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Hash] opts - a customizable set of options -- -##### [two_finger_tap](https://github.com/appium/ruby_lib/blob/125bb67e570b396d675cb24d7c51f43a24a58897/lib/appium_lib/device/touch_actions.rb#L121) +##### [two_finger_tap](https://github.com/appium/ruby_lib/blob/43a8f19bee4df0e37ba87663728f665829f26e27/lib/appium_lib/device/touch_actions.rb#L121) > def two_finger_tap(opts) Two finger tap an element on the screen @@ -1467,11 +1479,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Hash] opts - a customizable set of options -- -##### [wait](https://github.com/appium/ruby_lib/blob/125bb67e570b396d675cb24d7c51f43a24a58897/lib/appium_lib/device/touch_actions.rb#L129) +##### [wait](https://github.com/appium/ruby_lib/blob/43a8f19bee4df0e37ba87663728f665829f26e27/lib/appium_lib/device/touch_actions.rb#L129) > def wait(milliseconds) Pause for a number of milliseconds before the next action @@ -1479,11 +1491,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[integer] milliseconds - Number of milliseconds to pause for -- -##### [swipe](https://github.com/appium/ruby_lib/blob/125bb67e570b396d675cb24d7c51f43a24a58897/lib/appium_lib/device/touch_actions.rb#L152) +##### [swipe](https://github.com/appium/ruby_lib/blob/43a8f19bee4df0e37ba87663728f665829f26e27/lib/appium_lib/device/touch_actions.rb#L152) > def swipe(opts, ele = nil) Convenience method to peform a swipe. @@ -1500,68 +1512,68 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Hash] opts - a customizable set of options -- -##### [perform](https://github.com/appium/ruby_lib/blob/125bb67e570b396d675cb24d7c51f43a24a58897/lib/appium_lib/device/touch_actions.rb#L177) +##### [perform](https://github.com/appium/ruby_lib/blob/43a8f19bee4df0e37ba87663728f665829f26e27/lib/appium_lib/device/touch_actions.rb#L177) > def perform Ask the driver to perform all actions in this action chain. -- -##### [cancel](https://github.com/appium/ruby_lib/blob/125bb67e570b396d675cb24d7c51f43a24a58897/lib/appium_lib/device/touch_actions.rb#L184) +##### [cancel](https://github.com/appium/ruby_lib/blob/43a8f19bee4df0e37ba87663728f665829f26e27/lib/appium_lib/device/touch_actions.rb#L184) > def cancel Does nothing, currently. -- -##### [swipe_coordinates](https://github.com/appium/ruby_lib/blob/125bb67e570b396d675cb24d7c51f43a24a58897/lib/appium_lib/device/touch_actions.rb#L190) +##### [swipe_coordinates](https://github.com/appium/ruby_lib/blob/43a8f19bee4df0e37ba87663728f665829f26e27/lib/appium_lib/device/touch_actions.rb#L190) > def swipe_coordinates(end_x: nil, end_y: nil, offset_x: nil, offset_y: nil) -- -##### [chain_method](https://github.com/appium/ruby_lib/blob/125bb67e570b396d675cb24d7c51f43a24a58897/lib/appium_lib/device/touch_actions.rb#L208) +##### [chain_method](https://github.com/appium/ruby_lib/blob/43a8f19bee4df0e37ba87663728f665829f26e27/lib/appium_lib/device/touch_actions.rb#L208) > def chain_method(method, args = nil) -- -##### [args_with_ele_ref](https://github.com/appium/ruby_lib/blob/125bb67e570b396d675cb24d7c51f43a24a58897/lib/appium_lib/device/touch_actions.rb#L214) +##### [args_with_ele_ref](https://github.com/appium/ruby_lib/blob/43a8f19bee4df0e37ba87663728f665829f26e27/lib/appium_lib/device/touch_actions.rb#L214) > def args_with_ele_ref(args) -- -##### [_generic_wait](https://github.com/appium/ruby_lib/blob/125bb67e570b396d675cb24d7c51f43a24a58897/lib/appium_lib/common/wait.rb#L9) +##### [_generic_wait](https://github.com/appium/ruby_lib/blob/43a8f19bee4df0e37ba87663728f665829f26e27/lib/appium_lib/common/wait.rb#L9) > def _generic_wait(opts = {}) Wait code from the selenium Ruby gem https://github.com/SeleniumHQ/selenium/blob/cf501dda3f0ed12233de51ce8170c0e8090f0c20/rb/lib/selenium/webdriver/common/wait.rb -- -##### [_process_wait_opts](https://github.com/appium/ruby_lib/blob/125bb67e570b396d675cb24d7c51f43a24a58897/lib/appium_lib/common/wait.rb#L48) +##### [_process_wait_opts](https://github.com/appium/ruby_lib/blob/43a8f19bee4df0e37ba87663728f665829f26e27/lib/appium_lib/common/wait.rb#L48) > def _process_wait_opts(opts) process opts before calling _generic_wait -- -##### [wait_true](https://github.com/appium/ruby_lib/blob/125bb67e570b396d675cb24d7c51f43a24a58897/lib/appium_lib/common/wait.rb#L69) +##### [wait_true](https://github.com/appium/ruby_lib/blob/43a8f19bee4df0e37ba87663728f665829f26e27/lib/appium_lib/common/wait.rb#L69) > def wait_true(opts = {}, &block) Check every interval seconds to see if yield returns a truthy value. Note this isn't a strict boolean true, any truthy value is accepted. @@ -1577,11 +1589,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Hash] opts - Options -- -##### [wait](https://github.com/appium/ruby_lib/blob/125bb67e570b396d675cb24d7c51f43a24a58897/lib/appium_lib/common/wait.rb#L87) +##### [wait](https://github.com/appium/ruby_lib/blob/43a8f19bee4df0e37ba87663728f665829f26e27/lib/appium_lib/common/wait.rb#L87) > def wait(opts = {}, &block) Check every interval seconds to see if yield doesn't raise an exception. Give up after timeout seconds. @@ -1595,19 +1607,19 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Hash] opts - Options -- -##### [ignore](https://github.com/appium/ruby_lib/blob/125bb67e570b396d675cb24d7c51f43a24a58897/lib/appium_lib/common/helper.rb#L24) +##### [ignore](https://github.com/appium/ruby_lib/blob/43a8f19bee4df0e37ba87663728f665829f26e27/lib/appium_lib/common/helper.rb#L24) > def ignore Return yield and ignore any exceptions. -- -##### [back](https://github.com/appium/ruby_lib/blob/125bb67e570b396d675cb24d7c51f43a24a58897/lib/appium_lib/common/helper.rb#L31) +##### [back](https://github.com/appium/ruby_lib/blob/43a8f19bee4df0e37ba87663728f665829f26e27/lib/appium_lib/common/helper.rb#L31) > def back Navigate back. @@ -1615,19 +1627,19 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[void] -- -##### [session_id](https://github.com/appium/ruby_lib/blob/125bb67e570b396d675cb24d7c51f43a24a58897/lib/appium_lib/common/helper.rb#L36) +##### [session_id](https://github.com/appium/ruby_lib/blob/43a8f19bee4df0e37ba87663728f665829f26e27/lib/appium_lib/common/helper.rb#L36) > def session_id For Sauce Labs reporting. Returns the current session id. -- -##### [xpath](https://github.com/appium/ruby_lib/blob/125bb67e570b396d675cb24d7c51f43a24a58897/lib/appium_lib/common/helper.rb#L44) +##### [xpath](https://github.com/appium/ruby_lib/blob/43a8f19bee4df0e37ba87663728f665829f26e27/lib/appium_lib/common/helper.rb#L44) > def xpath(xpath_str) Returns the first element that matches the provided xpath. @@ -1639,11 +1651,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Element] -- -##### [xpaths](https://github.com/appium/ruby_lib/blob/125bb67e570b396d675cb24d7c51f43a24a58897/lib/appium_lib/common/helper.rb#L52) +##### [xpaths](https://github.com/appium/ruby_lib/blob/43a8f19bee4df0e37ba87663728f665829f26e27/lib/appium_lib/common/helper.rb#L52) > def xpaths(xpath_str) Returns all elements that match the provided xpath. @@ -1655,27 +1667,27 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Array<Element>] -- -##### [_print_source](https://github.com/appium/ruby_lib/blob/125bb67e570b396d675cb24d7c51f43a24a58897/lib/appium_lib/common/helper.rb#L56) +##### [_print_source](https://github.com/appium/ruby_lib/blob/43a8f19bee4df0e37ba87663728f665829f26e27/lib/appium_lib/common/helper.rb#L56) > def _print_source(source) -- -##### [result](https://github.com/appium/ruby_lib/blob/125bb67e570b396d675cb24d7c51f43a24a58897/lib/appium_lib/common/helper.rb#L69) +##### [result](https://github.com/appium/ruby_lib/blob/43a8f19bee4df0e37ba87663728f665829f26e27/lib/appium_lib/common/helper.rb#L69) > def result Returns the value of attribute result -- -##### [initialize](https://github.com/appium/ruby_lib/blob/125bb67e570b396d675cb24d7c51f43a24a58897/lib/appium_lib/common/helper.rb#L71) +##### [initialize](https://github.com/appium/ruby_lib/blob/43a8f19bee4df0e37ba87663728f665829f26e27/lib/appium_lib/common/helper.rb#L71) > def initialize @@ -1683,52 +1695,52 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[CountElements] a new instance of CountElements -- -##### [reset](https://github.com/appium/ruby_lib/blob/125bb67e570b396d675cb24d7c51f43a24a58897/lib/appium_lib/common/helper.rb#L75) +##### [reset](https://github.com/appium/ruby_lib/blob/43a8f19bee4df0e37ba87663728f665829f26e27/lib/appium_lib/common/helper.rb#L75) > def reset -- -##### [start_element](https://github.com/appium/ruby_lib/blob/125bb67e570b396d675cb24d7c51f43a24a58897/lib/appium_lib/common/helper.rb#L80) +##### [start_element](https://github.com/appium/ruby_lib/blob/43a8f19bee4df0e37ba87663728f665829f26e27/lib/appium_lib/common/helper.rb#L80) > def start_element(name, attrs = []) http://nokogiri.org/Nokogiri/XML/SAX/Document.html -- -##### [formatted_result](https://github.com/appium/ruby_lib/blob/125bb67e570b396d675cb24d7c51f43a24a58897/lib/appium_lib/common/helper.rb#L86) +##### [formatted_result](https://github.com/appium/ruby_lib/blob/43a8f19bee4df0e37ba87663728f665829f26e27/lib/appium_lib/common/helper.rb#L86) > def formatted_result -- -##### [get_page_class](https://github.com/appium/ruby_lib/blob/125bb67e570b396d675cb24d7c51f43a24a58897/lib/appium_lib/common/helper.rb#L97) +##### [get_page_class](https://github.com/appium/ruby_lib/blob/43a8f19bee4df0e37ba87663728f665829f26e27/lib/appium_lib/common/helper.rb#L97) > def get_page_class Returns a string of class counts of visible elements. -- -##### [page_class](https://github.com/appium/ruby_lib/blob/125bb67e570b396d675cb24d7c51f43a24a58897/lib/appium_lib/common/helper.rb#L108) +##### [page_class](https://github.com/appium/ruby_lib/blob/43a8f19bee4df0e37ba87663728f665829f26e27/lib/appium_lib/common/helper.rb#L108) > def page_class Count all classes on screen and print to stdout. Useful for appium_console. -- -##### [px_to_window_rel](https://github.com/appium/ruby_lib/blob/125bb67e570b396d675cb24d7c51f43a24a58897/lib/appium_lib/common/helper.rb#L118) +##### [px_to_window_rel](https://github.com/appium/ruby_lib/blob/43a8f19bee4df0e37ba87663728f665829f26e27/lib/appium_lib/common/helper.rb#L118) > def px_to_window_rel(opts = {}) Converts pixel values to window relative values @@ -1736,11 +1748,11 @@ px_to_window_rel x: 50, y: 150 ``` -- -##### [xml_keys](https://github.com/appium/ruby_lib/blob/125bb67e570b396d675cb24d7c51f43a24a58897/lib/appium_lib/common/helper.rb#L137) +##### [xml_keys](https://github.com/appium/ruby_lib/blob/43a8f19bee4df0e37ba87663728f665829f26e27/lib/appium_lib/common/helper.rb#L137) > def xml_keys(target) Search strings.xml's values for target. @@ -1752,11 +1764,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Array] -- -##### [xml_values](https://github.com/appium/ruby_lib/blob/125bb67e570b396d675cb24d7c51f43a24a58897/lib/appium_lib/common/helper.rb#L145) +##### [xml_values](https://github.com/appium/ruby_lib/blob/43a8f19bee4df0e37ba87663728f665829f26e27/lib/appium_lib/common/helper.rb#L145) > def xml_values(target) Search strings.xml's keys for target. @@ -1768,11 +1780,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Array] -- -##### [resolve_id](https://github.com/appium/ruby_lib/blob/125bb67e570b396d675cb24d7c51f43a24a58897/lib/appium_lib/common/helper.rb#L153) +##### [resolve_id](https://github.com/appium/ruby_lib/blob/43a8f19bee4df0e37ba87663728f665829f26e27/lib/appium_lib/common/helper.rb#L153) > def resolve_id(id) Resolve id in strings.xml and return the value. @@ -1784,27 +1796,27 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[String] -- -##### [filter](https://github.com/appium/ruby_lib/blob/125bb67e570b396d675cb24d7c51f43a24a58897/lib/appium_lib/common/helper.rb#L159) +##### [filter](https://github.com/appium/ruby_lib/blob/43a8f19bee4df0e37ba87663728f665829f26e27/lib/appium_lib/common/helper.rb#L159) > def filter Returns the value of attribute filter -- -##### [filter=](https://github.com/appium/ruby_lib/blob/125bb67e570b396d675cb24d7c51f43a24a58897/lib/appium_lib/common/helper.rb#L162) +##### [filter=](https://github.com/appium/ruby_lib/blob/43a8f19bee4df0e37ba87663728f665829f26e27/lib/appium_lib/common/helper.rb#L162) > def filter=(value) convert to string to support symbols -- -##### [initialize](https://github.com/appium/ruby_lib/blob/125bb67e570b396d675cb24d7c51f43a24a58897/lib/appium_lib/common/helper.rb#L168) +##### [initialize](https://github.com/appium/ruby_lib/blob/43a8f19bee4df0e37ba87663728f665829f26e27/lib/appium_lib/common/helper.rb#L168) > def initialize @@ -1812,131 +1824,131 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[HTMLElements] a new instance of HTMLElements -- -##### [reset](https://github.com/appium/ruby_lib/blob/125bb67e570b396d675cb24d7c51f43a24a58897/lib/appium_lib/common/helper.rb#L173) +##### [reset](https://github.com/appium/ruby_lib/blob/43a8f19bee4df0e37ba87663728f665829f26e27/lib/appium_lib/common/helper.rb#L173) > def reset -- -##### [result](https://github.com/appium/ruby_lib/blob/125bb67e570b396d675cb24d7c51f43a24a58897/lib/appium_lib/common/helper.rb#L179) +##### [result](https://github.com/appium/ruby_lib/blob/43a8f19bee4df0e37ba87663728f665829f26e27/lib/appium_lib/common/helper.rb#L179) > def result -- -##### [start_element](https://github.com/appium/ruby_lib/blob/125bb67e570b396d675cb24d7c51f43a24a58897/lib/appium_lib/common/helper.rb#L195) +##### [start_element](https://github.com/appium/ruby_lib/blob/43a8f19bee4df0e37ba87663728f665829f26e27/lib/appium_lib/common/helper.rb#L195) > def start_element(name, attrs = []) -- -##### [end_element](https://github.com/appium/ruby_lib/blob/125bb67e570b396d675cb24d7c51f43a24a58897/lib/appium_lib/common/helper.rb#L204) +##### [end_element](https://github.com/appium/ruby_lib/blob/43a8f19bee4df0e37ba87663728f665829f26e27/lib/appium_lib/common/helper.rb#L204) > def end_element(name) -- -##### [characters](https://github.com/appium/ruby_lib/blob/125bb67e570b396d675cb24d7c51f43a24a58897/lib/appium_lib/common/helper.rb#L210) +##### [characters](https://github.com/appium/ruby_lib/blob/43a8f19bee4df0e37ba87663728f665829f26e27/lib/appium_lib/common/helper.rb#L210) > def characters(chars) -- -##### [_no_such_element](https://github.com/appium/ruby_lib/blob/125bb67e570b396d675cb24d7c51f43a24a58897/lib/appium_lib/common/helper.rb#L217) +##### [_no_such_element](https://github.com/appium/ruby_lib/blob/43a8f19bee4df0e37ba87663728f665829f26e27/lib/appium_lib/common/helper.rb#L217) > def _no_such_element -- -##### [COMMAND_NO_ARG](https://github.com/appium/ruby_lib/blob/125bb67e570b396d675cb24d7c51f43a24a58897/lib/appium_lib/common/command.rb#L4) +##### [COMMAND_NO_ARG](https://github.com/appium/ruby_lib/blob/43a8f19bee4df0e37ba87663728f665829f26e27/lib/appium_lib/common/command.rb#L4) > COMMAND_NO_ARG = { -- -##### [COMMAND](https://github.com/appium/ruby_lib/blob/125bb67e570b396d675cb24d7c51f43a24a58897/lib/appium_lib/common/command.rb#L27) +##### [COMMAND](https://github.com/appium/ruby_lib/blob/43a8f19bee4df0e37ba87663728f665829f26e27/lib/appium_lib/common/command.rb#L27) > COMMAND = { -- -##### [window_size](https://github.com/appium/ruby_lib/blob/125bb67e570b396d675cb24d7c51f43a24a58897/lib/appium_lib/common/element/window.rb#L5) +##### [window_size](https://github.com/appium/ruby_lib/blob/43a8f19bee4df0e37ba87663728f665829f26e27/lib/appium_lib/common/element/window.rb#L5) > def window_size Get the window's size -- -##### [FINDERS](https://github.com/appium/ruby_lib/blob/125bb67e570b396d675cb24d7c51f43a24a58897/lib/appium_lib/common/search_context.rb#L5) +##### [FINDERS](https://github.com/appium/ruby_lib/blob/43a8f19bee4df0e37ba87663728f665829f26e27/lib/appium_lib/common/search_context.rb#L5) > FINDERS = { rubocop:disable Style/MutableConstant -- -##### [result](https://github.com/appium/ruby_lib/blob/125bb67e570b396d675cb24d7c51f43a24a58897/lib/appium_lib/android/helper.rb#L6) android +##### [result](https://github.com/appium/ruby_lib/blob/43a8f19bee4df0e37ba87663728f665829f26e27/lib/appium_lib/android/helper.rb#L6) android > def result Returns the value of attribute result -- -##### [keys](https://github.com/appium/ruby_lib/blob/125bb67e570b396d675cb24d7c51f43a24a58897/lib/appium_lib/android/helper.rb#L6) android +##### [keys](https://github.com/appium/ruby_lib/blob/43a8f19bee4df0e37ba87663728f665829f26e27/lib/appium_lib/android/helper.rb#L6) android > def keys Returns the value of attribute keys -- -##### [instance](https://github.com/appium/ruby_lib/blob/125bb67e570b396d675cb24d7c51f43a24a58897/lib/appium_lib/android/helper.rb#L6) android +##### [instance](https://github.com/appium/ruby_lib/blob/43a8f19bee4df0e37ba87663728f665829f26e27/lib/appium_lib/android/helper.rb#L6) android > def instance Returns the value of attribute instance -- -##### [filter](https://github.com/appium/ruby_lib/blob/125bb67e570b396d675cb24d7c51f43a24a58897/lib/appium_lib/android/helper.rb#L6) android +##### [filter](https://github.com/appium/ruby_lib/blob/43a8f19bee4df0e37ba87663728f665829f26e27/lib/appium_lib/android/helper.rb#L6) android > def filter Returns the value of attribute filter -- -##### [filter=](https://github.com/appium/ruby_lib/blob/125bb67e570b396d675cb24d7c51f43a24a58897/lib/appium_lib/android/helper.rb#L9) android +##### [filter=](https://github.com/appium/ruby_lib/blob/43a8f19bee4df0e37ba87663728f665829f26e27/lib/appium_lib/android/helper.rb#L9) android > def filter=(value) convert to string to support symbols -- -##### [initialize](https://github.com/appium/ruby_lib/blob/125bb67e570b396d675cb24d7c51f43a24a58897/lib/appium_lib/android/helper.rb#L15) android +##### [initialize](https://github.com/appium/ruby_lib/blob/43a8f19bee4df0e37ba87663728f665829f26e27/lib/appium_lib/android/helper.rb#L15) android > def initialize @@ -1944,37 +1956,37 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[AndroidElements] a new instance of AndroidElements -- -##### [reset](https://github.com/appium/ruby_lib/blob/125bb67e570b396d675cb24d7c51f43a24a58897/lib/appium_lib/android/helper.rb#L21) android +##### [reset](https://github.com/appium/ruby_lib/blob/43a8f19bee4df0e37ba87663728f665829f26e27/lib/appium_lib/android/helper.rb#L21) android > def reset -- -##### [start_element](https://github.com/appium/ruby_lib/blob/125bb67e570b396d675cb24d7c51f43a24a58897/lib/appium_lib/android/helper.rb#L28) android +##### [start_element](https://github.com/appium/ruby_lib/blob/43a8f19bee4df0e37ba87663728f665829f26e27/lib/appium_lib/android/helper.rb#L28) android > def start_element(name, attrs = []) http://nokogiri.org/Nokogiri/XML/SAX/Document.html -- -##### [_fix_android_native_source](https://github.com/appium/ruby_lib/blob/125bb67e570b396d675cb24d7c51f43a24a58897/lib/appium_lib/android/helper.rb#L88) android +##### [_fix_android_native_source](https://github.com/appium/ruby_lib/blob/43a8f19bee4df0e37ba87663728f665829f26e27/lib/appium_lib/android/helper.rb#L88) android > def _fix_android_native_source(source) Fix uiautomator's xml dump. https://github.com/appium/appium/issues/2822 https://code.google.com/p/android/issues/detail?id=74143 -- -##### [source](https://github.com/appium/ruby_lib/blob/125bb67e570b396d675cb24d7c51f43a24a58897/lib/appium_lib/android/helper.rb#L116) android +##### [source](https://github.com/appium/ruby_lib/blob/43a8f19bee4df0e37ba87663728f665829f26e27/lib/appium_lib/android/helper.rb#L116) android > def source Prints xml of the current page @@ -1982,11 +1994,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[void] -- -##### [get_android_inspect](https://github.com/appium/ruby_lib/blob/125bb67e570b396d675cb24d7c51f43a24a58897/lib/appium_lib/android/helper.rb#L126) android +##### [get_android_inspect](https://github.com/appium/ruby_lib/blob/43a8f19bee4df0e37ba87663728f665829f26e27/lib/appium_lib/android/helper.rb#L126) android > def get_android_inspect(class_name = false) Android only. Returns a string containing interesting elements. @@ -2001,11 +2013,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[String] -- -##### [page](https://github.com/appium/ruby_lib/blob/125bb67e570b396d675cb24d7c51f43a24a58897/lib/appium_lib/android/helper.rb#L152) android +##### [page](https://github.com/appium/ruby_lib/blob/43a8f19bee4df0e37ba87663728f665829f26e27/lib/appium_lib/android/helper.rb#L152) android > def page(opts = {}) Intended for use with console. Inspects and prints the current page. @@ -2020,21 +2032,21 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[void] -- -##### [current_app](https://github.com/appium/ruby_lib/blob/125bb67e570b396d675cb24d7c51f43a24a58897/lib/appium_lib/android/helper.rb#L164) android +##### [current_app](https://github.com/appium/ruby_lib/blob/43a8f19bee4df0e37ba87663728f665829f26e27/lib/appium_lib/android/helper.rb#L164) android > def current_app example line: "mFocusedApp=AppWindowToken{b1420058 token=Token{b128add0 ActivityRecord{b1264d10 u0 com.example.android.apis/.ApiDemos t23}}}" -- -##### [id](https://github.com/appium/ruby_lib/blob/125bb67e570b396d675cb24d7c51f43a24a58897/lib/appium_lib/android/helper.rb#L188) android +##### [id](https://github.com/appium/ruby_lib/blob/43a8f19bee4df0e37ba87663728f665829f26e27/lib/appium_lib/android/helper.rb#L188) android > def id(id) Find the first matching element by id @@ -2046,11 +2058,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Element] -- -##### [ids](https://github.com/appium/ruby_lib/blob/125bb67e570b396d675cb24d7c51f43a24a58897/lib/appium_lib/android/helper.rb#L196) android +##### [ids](https://github.com/appium/ruby_lib/blob/43a8f19bee4df0e37ba87663728f665829f26e27/lib/appium_lib/android/helper.rb#L196) android > def ids(id) Find all matching elements by id @@ -2062,11 +2074,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Element] -- -##### [ele_index](https://github.com/appium/ruby_lib/blob/125bb67e570b396d675cb24d7c51f43a24a58897/lib/appium_lib/android/helper.rb#L205) android +##### [ele_index](https://github.com/appium/ruby_lib/blob/43a8f19bee4df0e37ba87663728f665829f26e27/lib/appium_lib/android/helper.rb#L205) android > def ele_index(class_name, index) Find the element of type class_name at matching index. @@ -2080,11 +2092,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Element] the found element of type class_name -- -##### [first_ele](https://github.com/appium/ruby_lib/blob/125bb67e570b396d675cb24d7c51f43a24a58897/lib/appium_lib/android/helper.rb#L223) android +##### [first_ele](https://github.com/appium/ruby_lib/blob/43a8f19bee4df0e37ba87663728f665829f26e27/lib/appium_lib/android/helper.rb#L223) android > def first_ele(class_name) Find the first element that matches class_name @@ -2096,11 +2108,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Element] -- -##### [last_ele](https://github.com/appium/ruby_lib/blob/125bb67e570b396d675cb24d7c51f43a24a58897/lib/appium_lib/android/helper.rb#L230) android +##### [last_ele](https://github.com/appium/ruby_lib/blob/43a8f19bee4df0e37ba87663728f665829f26e27/lib/appium_lib/android/helper.rb#L230) android > def last_ele(class_name) Find the last element that matches class_name @@ -2112,11 +2124,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Element] -- -##### [tag](https://github.com/appium/ruby_lib/blob/125bb67e570b396d675cb24d7c51f43a24a58897/lib/appium_lib/android/helper.rb#L238) android +##### [tag](https://github.com/appium/ruby_lib/blob/43a8f19bee4df0e37ba87663728f665829f26e27/lib/appium_lib/android/helper.rb#L238) android > def tag(class_name) Find the first element of type class_name @@ -2128,11 +2140,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Element] -- -##### [tags](https://github.com/appium/ruby_lib/blob/125bb67e570b396d675cb24d7c51f43a24a58897/lib/appium_lib/android/helper.rb#L246) android +##### [tags](https://github.com/appium/ruby_lib/blob/43a8f19bee4df0e37ba87663728f665829f26e27/lib/appium_lib/android/helper.rb#L246) android > def tags(class_name) Find all elements of type class_name @@ -2144,18 +2156,38 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Element] -- -##### [string_visible_contains](https://github.com/appium/ruby_lib/blob/125bb67e570b396d675cb24d7c51f43a24a58897/lib/appium_lib/android/helper.rb#L288) android +##### [string_visible_contains_xpath](https://github.com/appium/ruby_lib/blob/43a8f19bee4df0e37ba87663728f665829f26e27/lib/appium_lib/android/helper.rb#L288) android -> def string_visible_contains(class_name, value) +> def string_visible_contains_xpath(class_name, value) Returns a string that matches the first element that contains value +For automationName is uiautomator2 +example: string_visible_contains_xpath 'UIATextField', 'sign in' -example: complex_find_contains 'UIATextField', 'sign in' +__Parameters:__ +&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[String] class_name - the class name for the element + +&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[String] value - the value to search for + +__Returns:__ + +&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[String] + +-- + +##### [string_visible_contains](https://github.com/appium/ruby_lib/blob/43a8f19bee4df0e37ba87663728f665829f26e27/lib/appium_lib/android/helper.rb#L307) android + +> def string_visible_contains(class_name, value) + +Returns a string that matches the first element that contains value +For automationName is Appium +example: string_visible_contains 'UIATextField', 'sign in' + __Parameters:__ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[String] class_name - the class name for the element &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[String] value - the value to search for @@ -2164,11 +2196,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[String] -- -##### [complex_find_contains](https://github.com/appium/ruby_lib/blob/125bb67e570b396d675cb24d7c51f43a24a58897/lib/appium_lib/android/helper.rb#L304) android +##### [complex_find_contains](https://github.com/appium/ruby_lib/blob/43a8f19bee4df0e37ba87663728f665829f26e27/lib/appium_lib/android/helper.rb#L325) android > def complex_find_contains(element, value) Find the first element that contains value @@ -2182,11 +2214,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Element] -- -##### [complex_finds_contains](https://github.com/appium/ruby_lib/blob/125bb67e570b396d675cb24d7c51f43a24a58897/lib/appium_lib/android/helper.rb#L312) android +##### [complex_finds_contains](https://github.com/appium/ruby_lib/blob/43a8f19bee4df0e37ba87663728f665829f26e27/lib/appium_lib/android/helper.rb#L337) android > def complex_finds_contains(element, value) Find all elements containing value @@ -2200,11 +2232,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Array<Element>] -- -##### [complex_find_exact](https://github.com/appium/ruby_lib/blob/125bb67e570b396d675cb24d7c51f43a24a58897/lib/appium_lib/android/helper.rb#L335) android +##### [complex_find_exact](https://github.com/appium/ruby_lib/blob/43a8f19bee4df0e37ba87663728f665829f26e27/lib/appium_lib/android/helper.rb#L385) android > def complex_find_exact(class_name, value) Find the first element exactly matching value @@ -2218,11 +2250,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Element] -- -##### [complex_finds_exact](https://github.com/appium/ruby_lib/blob/125bb67e570b396d675cb24d7c51f43a24a58897/lib/appium_lib/android/helper.rb#L343) android +##### [complex_finds_exact](https://github.com/appium/ruby_lib/blob/43a8f19bee4df0e37ba87663728f665829f26e27/lib/appium_lib/android/helper.rb#L397) android > def complex_finds_exact(class_name, value) Find all elements exactly matching value @@ -2236,11 +2268,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Element] -- -##### [get_source](https://github.com/appium/ruby_lib/blob/125bb67e570b396d675cb24d7c51f43a24a58897/lib/appium_lib/android/helper.rb#L351) android +##### [get_source](https://github.com/appium/ruby_lib/blob/43a8f19bee4df0e37ba87663728f665829f26e27/lib/appium_lib/android/helper.rb#L409) android > def get_source Returns XML string for the current page Fixes uiautomator's $ in node names. @@ -2250,51 +2282,51 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[String] -- -##### [_nodeset_to_uiselector](https://github.com/appium/ruby_lib/blob/125bb67e570b396d675cb24d7c51f43a24a58897/lib/appium_lib/android/client_xpath.rb#L5) android +##### [_nodeset_to_uiselector](https://github.com/appium/ruby_lib/blob/43a8f19bee4df0e37ba87663728f665829f26e27/lib/appium_lib/android/client_xpath.rb#L5) android > def _nodeset_to_uiselector(opts = {}) -- -##### [_client_xpath](https://github.com/appium/ruby_lib/blob/125bb67e570b396d675cb24d7c51f43a24a58897/lib/appium_lib/android/client_xpath.rb#L20) android +##### [_client_xpath](https://github.com/appium/ruby_lib/blob/43a8f19bee4df0e37ba87663728f665829f26e27/lib/appium_lib/android/client_xpath.rb#L20) android > def _client_xpath(opts = {}) -- -##### [client_xpath](https://github.com/appium/ruby_lib/blob/125bb67e570b396d675cb24d7c51f43a24a58897/lib/appium_lib/android/client_xpath.rb#L36) android +##### [client_xpath](https://github.com/appium/ruby_lib/blob/43a8f19bee4df0e37ba87663728f665829f26e27/lib/appium_lib/android/client_xpath.rb#L36) android > def client_xpath(xpath) -- -##### [client_xpaths](https://github.com/appium/ruby_lib/blob/125bb67e570b396d675cb24d7c51f43a24a58897/lib/appium_lib/android/client_xpath.rb#L40) android +##### [client_xpaths](https://github.com/appium/ruby_lib/blob/43a8f19bee4df0e37ba87663728f665829f26e27/lib/appium_lib/android/client_xpath.rb#L40) android > def client_xpaths(xpath) -- -##### [TextView](https://github.com/appium/ruby_lib/blob/125bb67e570b396d675cb24d7c51f43a24a58897/lib/appium_lib/android/element/text.rb#L4) android +##### [TextView](https://github.com/appium/ruby_lib/blob/43a8f19bee4df0e37ba87663728f665829f26e27/lib/appium_lib/android/element/text.rb#L4) android > TextView = 'android.widget.TextView'.freeze -- -##### [text](https://github.com/appium/ruby_lib/blob/125bb67e570b396d675cb24d7c51f43a24a58897/lib/appium_lib/android/element/text.rb#L10) android +##### [text](https://github.com/appium/ruby_lib/blob/43a8f19bee4df0e37ba87663728f665829f26e27/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. @@ -2307,11 +2339,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[TextView] -- -##### [texts](https://github.com/appium/ruby_lib/blob/125bb67e570b396d675cb24d7c51f43a24a58897/lib/appium_lib/android/element/text.rb#L19) android +##### [texts](https://github.com/appium/ruby_lib/blob/43a8f19bee4df0e37ba87663728f665829f26e27/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. @@ -2324,11 +2356,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Array<TextView>] -- -##### [first_text](https://github.com/appium/ruby_lib/blob/125bb67e570b396d675cb24d7c51f43a24a58897/lib/appium_lib/android/element/text.rb#L26) android +##### [first_text](https://github.com/appium/ruby_lib/blob/43a8f19bee4df0e37ba87663728f665829f26e27/lib/appium_lib/android/element/text.rb#L26) android > def first_text Find the first TextView. @@ -2336,11 +2368,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[TextView] -- -##### [last_text](https://github.com/appium/ruby_lib/blob/125bb67e570b396d675cb24d7c51f43a24a58897/lib/appium_lib/android/element/text.rb#L32) android +##### [last_text](https://github.com/appium/ruby_lib/blob/43a8f19bee4df0e37ba87663728f665829f26e27/lib/appium_lib/android/element/text.rb#L32) android > def last_text Find the last TextView. @@ -2348,11 +2380,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[TextView] -- -##### [text_exact](https://github.com/appium/ruby_lib/blob/125bb67e570b396d675cb24d7c51f43a24a58897/lib/appium_lib/android/element/text.rb#L39) android +##### [text_exact](https://github.com/appium/ruby_lib/blob/43a8f19bee4df0e37ba87663728f665829f26e27/lib/appium_lib/android/element/text.rb#L39) android > def text_exact(value) Find the first TextView that exactly matches value. @@ -2364,11 +2396,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[TextView] -- -##### [texts_exact](https://github.com/appium/ruby_lib/blob/125bb67e570b396d675cb24d7c51f43a24a58897/lib/appium_lib/android/element/text.rb#L46) android +##### [texts_exact](https://github.com/appium/ruby_lib/blob/43a8f19bee4df0e37ba87663728f665829f26e27/lib/appium_lib/android/element/text.rb#L46) android > def texts_exact(value) Find all TextViews that exactly match value. @@ -2380,11 +2412,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Array<TextView>] -- -##### [alert_click](https://github.com/appium/ruby_lib/blob/125bb67e570b396d675cb24d7c51f43a24a58897/lib/appium_lib/android/element/alert.rb#L6) android +##### [alert_click](https://github.com/appium/ruby_lib/blob/43a8f19bee4df0e37ba87663728f665829f26e27/lib/appium_lib/android/element/alert.rb#L6) android > def alert_click(value) Click the first alert button that contains value or by index. @@ -2396,11 +2428,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[void] -- -##### [alert_accept](https://github.com/appium/ruby_lib/blob/125bb67e570b396d675cb24d7c51f43a24a58897/lib/appium_lib/android/element/alert.rb#L13) android +##### [alert_accept](https://github.com/appium/ruby_lib/blob/43a8f19bee4df0e37ba87663728f665829f26e27/lib/appium_lib/android/element/alert.rb#L13) android > def alert_accept Accept the alert. The last button is considered "accept." @@ -2409,11 +2441,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[void] -- -##### [alert_accept_text](https://github.com/appium/ruby_lib/blob/125bb67e570b396d675cb24d7c51f43a24a58897/lib/appium_lib/android/element/alert.rb#L20) android +##### [alert_accept_text](https://github.com/appium/ruby_lib/blob/43a8f19bee4df0e37ba87663728f665829f26e27/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." @@ -2422,11 +2454,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[String] -- -##### [alert_dismiss](https://github.com/appium/ruby_lib/blob/125bb67e570b396d675cb24d7c51f43a24a58897/lib/appium_lib/android/element/alert.rb#L27) android +##### [alert_dismiss](https://github.com/appium/ruby_lib/blob/43a8f19bee4df0e37ba87663728f665829f26e27/lib/appium_lib/android/element/alert.rb#L27) android > def alert_dismiss Dismiss the alert. The first button is considered "dismiss." @@ -2435,11 +2467,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[void] -- -##### [alert_dismiss_text](https://github.com/appium/ruby_lib/blob/125bb67e570b396d675cb24d7c51f43a24a58897/lib/appium_lib/android/element/alert.rb#L34) android +##### [alert_dismiss_text](https://github.com/appium/ruby_lib/blob/43a8f19bee4df0e37ba87663728f665829f26e27/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." @@ -2448,28 +2480,52 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[String] -- -##### [Button](https://github.com/appium/ruby_lib/blob/125bb67e570b396d675cb24d7c51f43a24a58897/lib/appium_lib/android/element/button.rb#L4) android +##### [Button](https://github.com/appium/ruby_lib/blob/43a8f19bee4df0e37ba87663728f665829f26e27/lib/appium_lib/android/element/button.rb#L4) android > Button = 'android.widget.Button'.freeze -- -##### [ImageButton](https://github.com/appium/ruby_lib/blob/125bb67e570b396d675cb24d7c51f43a24a58897/lib/appium_lib/android/element/button.rb#L5) android +##### [ImageButton](https://github.com/appium/ruby_lib/blob/43a8f19bee4df0e37ba87663728f665829f26e27/lib/appium_lib/android/element/button.rb#L5) android > ImageButton = 'android.widget.ImageButton'.freeze -- -##### [button](https://github.com/appium/ruby_lib/blob/125bb67e570b396d675cb24d7c51f43a24a58897/lib/appium_lib/android/element/button.rb#L32) android +##### [_button_visible_selectors](https://github.com/appium/ruby_lib/blob/43a8f19bee4df0e37ba87663728f665829f26e27/lib/appium_lib/android/element/button.rb#L14) android +> def _button_visible_selectors(opts = {}) + + + +-- + +##### [_button_exact_string](https://github.com/appium/ruby_lib/blob/43a8f19bee4df0e37ba87663728f665829f26e27/lib/appium_lib/android/element/button.rb#L34) android + +> def _button_exact_string(value) + + + +-- + +##### [_button_contains_string](https://github.com/appium/ruby_lib/blob/43a8f19bee4df0e37ba87663728f665829f26e27/lib/appium_lib/android/element/button.rb#L47) android + +> def _button_contains_string(value) + + + +-- + +##### [button](https://github.com/appium/ruby_lib/blob/43a8f19bee4df0e37ba87663728f665829f26e27/lib/appium_lib/android/element/button.rb#L59) android + > def button(value) Find the first button that contains value or by index. If int then the button at that index is returned. @@ -2481,11 +2537,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Button] -- -##### [buttons](https://github.com/appium/ruby_lib/blob/125bb67e570b396d675cb24d7c51f43a24a58897/lib/appium_lib/android/element/button.rb#L51) android +##### [buttons](https://github.com/appium/ruby_lib/blob/43a8f19bee4df0e37ba87663728f665829f26e27/lib/appium_lib/android/element/button.rb#L87) android > def buttons(value = false) Find all buttons containing value. If value is omitted, all buttons are returned. @@ -2498,11 +2554,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Array<Button>] -- -##### [first_button](https://github.com/appium/ruby_lib/blob/125bb67e570b396d675cb24d7c51f43a24a58897/lib/appium_lib/android/element/button.rb#L58) android +##### [first_button](https://github.com/appium/ruby_lib/blob/43a8f19bee4df0e37ba87663728f665829f26e27/lib/appium_lib/android/element/button.rb#L99) android > def first_button Find the first button. @@ -2510,11 +2566,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Button] -- -##### [last_button](https://github.com/appium/ruby_lib/blob/125bb67e570b396d675cb24d7c51f43a24a58897/lib/appium_lib/android/element/button.rb#L64) android +##### [last_button](https://github.com/appium/ruby_lib/blob/43a8f19bee4df0e37ba87663728f665829f26e27/lib/appium_lib/android/element/button.rb#L109) android > def last_button Find the last button. @@ -2522,11 +2578,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Button] -- -##### [button_exact](https://github.com/appium/ruby_lib/blob/125bb67e570b396d675cb24d7c51f43a24a58897/lib/appium_lib/android/element/button.rb#L73) android +##### [button_exact](https://github.com/appium/ruby_lib/blob/43a8f19bee4df0e37ba87663728f665829f26e27/lib/appium_lib/android/element/button.rb#L131) android > def button_exact(value) Find the first button that exactly matches value. @@ -2538,11 +2594,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Button] -- -##### [buttons_exact](https://github.com/appium/ruby_lib/blob/125bb67e570b396d675cb24d7c51f43a24a58897/lib/appium_lib/android/element/button.rb#L80) android +##### [buttons_exact](https://github.com/appium/ruby_lib/blob/43a8f19bee4df0e37ba87663728f665829f26e27/lib/appium_lib/android/element/button.rb#L142) android > def buttons_exact(value) Find all buttons that exactly match value. @@ -2554,11 +2610,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Array<Button>] -- -##### [uiautomator_find](https://github.com/appium/ruby_lib/blob/125bb67e570b396d675cb24d7c51f43a24a58897/lib/appium_lib/android/mobile_methods.rb#L10) android +##### [uiautomator_find](https://github.com/appium/ruby_lib/blob/43a8f19bee4df0e37ba87663728f665829f26e27/lib/appium_lib/android/mobile_methods.rb#L10) android > def uiautomator_find find_element/s can be used with a [UISelector](http://developer.android.com/tools/help/uiautomator/UiSelector.html). @@ -2566,11 +2622,11 @@ find_elements :uiautomator, 'new UiSelector().clickable(true)' ``` -- -##### [find](https://github.com/appium/ruby_lib/blob/125bb67e570b396d675cb24d7c51f43a24a58897/lib/appium_lib/android/element/generic.rb#L6) android +##### [find](https://github.com/appium/ruby_lib/blob/43a8f19bee4df0e37ba87663728f665829f26e27/lib/appium_lib/android/element/generic.rb#L6) android > def find(value) Find the first element containing value @@ -2582,11 +2638,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Element] -- -##### [finds](https://github.com/appium/ruby_lib/blob/125bb67e570b396d675cb24d7c51f43a24a58897/lib/appium_lib/android/element/generic.rb#L13) android +##### [finds](https://github.com/appium/ruby_lib/blob/43a8f19bee4df0e37ba87663728f665829f26e27/lib/appium_lib/android/element/generic.rb#L13) android > def finds(value) Find all elements containing value @@ -2598,11 +2654,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Array<Element>] -- -##### [find_exact](https://github.com/appium/ruby_lib/blob/125bb67e570b396d675cb24d7c51f43a24a58897/lib/appium_lib/android/element/generic.rb#L20) android +##### [find_exact](https://github.com/appium/ruby_lib/blob/43a8f19bee4df0e37ba87663728f665829f26e27/lib/appium_lib/android/element/generic.rb#L20) android > def find_exact(value) Find the first element exactly matching value @@ -2614,11 +2670,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Element] -- -##### [finds_exact](https://github.com/appium/ruby_lib/blob/125bb67e570b396d675cb24d7c51f43a24a58897/lib/appium_lib/android/element/generic.rb#L27) android +##### [finds_exact](https://github.com/appium/ruby_lib/blob/43a8f19bee4df0e37ba87663728f665829f26e27/lib/appium_lib/android/element/generic.rb#L27) android > def finds_exact(value) Find all elements exactly matching value @@ -2630,11 +2686,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Array<Element>] -- -##### [scroll_to](https://github.com/appium/ruby_lib/blob/125bb67e570b396d675cb24d7c51f43a24a58897/lib/appium_lib/android/element/generic.rb#L40) android +##### [scroll_to](https://github.com/appium/ruby_lib/blob/43a8f19bee4df0e37ba87663728f665829f26e27/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. @@ -2648,11 +2704,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Element] the element scrolled to -- -##### [scroll_to_exact](https://github.com/appium/ruby_lib/blob/125bb67e570b396d675cb24d7c51f43a24a58897/lib/appium_lib/android/element/generic.rb#L54) android +##### [scroll_to_exact](https://github.com/appium/ruby_lib/blob/43a8f19bee4df0e37ba87663728f665829f26e27/lib/appium_lib/android/element/generic.rb#L54) android > def scroll_to_exact(text, scrollable_index = 0) Scroll to the first element with the exact target text or description. @@ -2666,19 +2722,19 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Element] the element scrolled to -- -##### [EditText](https://github.com/appium/ruby_lib/blob/125bb67e570b396d675cb24d7c51f43a24a58897/lib/appium_lib/android/element/textfield.rb#L3) android +##### [EditText](https://github.com/appium/ruby_lib/blob/43a8f19bee4df0e37ba87663728f665829f26e27/lib/appium_lib/android/element/textfield.rb#L3) android > EditText = 'android.widget.EditText'.freeze -- -##### [textfield](https://github.com/appium/ruby_lib/blob/125bb67e570b396d675cb24d7c51f43a24a58897/lib/appium_lib/android/element/textfield.rb#L9) android +##### [textfield](https://github.com/appium/ruby_lib/blob/43a8f19bee4df0e37ba87663728f665829f26e27/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. @@ -2691,11 +2747,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[EditText] -- -##### [textfields](https://github.com/appium/ruby_lib/blob/125bb67e570b396d675cb24d7c51f43a24a58897/lib/appium_lib/android/element/textfield.rb#L18) android +##### [textfields](https://github.com/appium/ruby_lib/blob/43a8f19bee4df0e37ba87663728f665829f26e27/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. @@ -2708,11 +2764,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Array<EditText>] -- -##### [first_textfield](https://github.com/appium/ruby_lib/blob/125bb67e570b396d675cb24d7c51f43a24a58897/lib/appium_lib/android/element/textfield.rb#L25) android +##### [first_textfield](https://github.com/appium/ruby_lib/blob/43a8f19bee4df0e37ba87663728f665829f26e27/lib/appium_lib/android/element/textfield.rb#L25) android > def first_textfield Find the first EditText. @@ -2720,11 +2776,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[EditText] -- -##### [last_textfield](https://github.com/appium/ruby_lib/blob/125bb67e570b396d675cb24d7c51f43a24a58897/lib/appium_lib/android/element/textfield.rb#L31) android +##### [last_textfield](https://github.com/appium/ruby_lib/blob/43a8f19bee4df0e37ba87663728f665829f26e27/lib/appium_lib/android/element/textfield.rb#L31) android > def last_textfield Find the last EditText. @@ -2732,11 +2788,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[EditText] -- -##### [textfield_exact](https://github.com/appium/ruby_lib/blob/125bb67e570b396d675cb24d7c51f43a24a58897/lib/appium_lib/android/element/textfield.rb#L38) android +##### [textfield_exact](https://github.com/appium/ruby_lib/blob/43a8f19bee4df0e37ba87663728f665829f26e27/lib/appium_lib/android/element/textfield.rb#L38) android > def textfield_exact(value) Find the first EditText that exactly matches value. @@ -2748,11 +2804,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[EditText] -- -##### [textfields_exact](https://github.com/appium/ruby_lib/blob/125bb67e570b396d675cb24d7c51f43a24a58897/lib/appium_lib/android/element/textfield.rb#L45) android +##### [textfields_exact](https://github.com/appium/ruby_lib/blob/43a8f19bee4df0e37ba87663728f665829f26e27/lib/appium_lib/android/element/textfield.rb#L45) android > def textfields_exact(value) Find all EditTexts that exactly match value. @@ -2764,31 +2820,31 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Array<EditText>] -- -##### [value](https://github.com/appium/ruby_lib/blob/125bb67e570b396d675cb24d7c51f43a24a58897/lib/appium_lib/common/patch.rb#L12) +##### [value](https://github.com/appium/ruby_lib/blob/43a8f19bee4df0e37ba87663728f665829f26e27/lib/appium_lib/common/patch.rb#L12) > def value Returns the value attribute Fixes NoMethodError: undefined method `value' for Selenium::WebDriver::Element -- -##### [name](https://github.com/appium/ruby_lib/blob/125bb67e570b396d675cb24d7c51f43a24a58897/lib/appium_lib/common/patch.rb#L19) +##### [name](https://github.com/appium/ruby_lib/blob/43a8f19bee4df0e37ba87663728f665829f26e27/lib/appium_lib/common/patch.rb#L19) > def name Returns the name attribute Fixes NoMethodError: undefined method `name' for Selenium::WebDriver::Element -- -##### [location_rel](https://github.com/appium/ruby_lib/blob/125bb67e570b396d675cb24d7c51f43a24a58897/lib/appium_lib/common/patch.rb#L31) +##### [location_rel](https://github.com/appium/ruby_lib/blob/43a8f19bee4df0e37ba87663728f665829f26e27/lib/appium_lib/common/patch.rb#L31) > def location_rel For use with mobile tap. @@ -2802,18 +2858,18 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[OpenStruct] the relative x, y in a struct. ex: { x: 0.50, y: 0.20 } -- -##### [DEFAULT_HEADERS](https://github.com/appium/ruby_lib/blob/125bb67e570b396d675cb24d7c51f43a24a58897/lib/appium_lib/common/patch.rb#L152) +##### [DEFAULT_HEADERS](https://github.com/appium/ruby_lib/blob/43a8f19bee4df0e37ba87663728f665829f26e27/lib/appium_lib/common/patch.rb#L152) > DEFAULT_HEADERS = { 'Accept' => CONTENT_TYPE, 'User-Agent' => "appium/ruby_lib/#{::Appium::VERSION}" }.freeze -- -##### [patch_remote_driver_commands](https://github.com/appium/ruby_lib/blob/125bb67e570b396d675cb24d7c51f43a24a58897/lib/appium_lib/common/patch.rb#L155) +##### [patch_remote_driver_commands](https://github.com/appium/ruby_lib/blob/43a8f19bee4df0e37ba87663728f665829f26e27/lib/appium_lib/common/patch.rb#L155) > def patch_remote_driver_commands