docs/ios_docs.md in appium_lib-9.4.9 vs docs/ios_docs.md in appium_lib-9.4.10

- old
+ new

@@ -1,6 +1,6 @@ -##### [load_settings](https://github.com/appium/ruby_lib/blob/c705d40f89117b7dea37ff6365c6d4f418e51ce9/lib/appium_lib/driver.rb#L76) +##### [load_settings](https://github.com/appium/ruby_lib/blob/bc50f6f1315fb3238d9e7614cf2545d06d979ae7/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/c705d40f89117b7dea37ff6365c6d4f418e51ce9/lib/appium_lib/driver.rb#L112) +##### [load_appium_txt](https://github.com/appium/ruby_lib/blob/bc50f6f1315fb3238d9e7614cf2545d06d979ae7/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/c705d40f89117b7dea37ff6365c6d4f418e51ce9/lib/appium_lib/driver.rb#L118) +##### [expand_required_files](https://github.com/appium/ruby_lib/blob/bc50f6f1315fb3238d9e7614cf2545d06d979ae7/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/c705d40f89117b7dea37ff6365c6d4f418e51ce9/lib/appium_lib/driver.rb#L150) +##### [symbolize_keys](https://github.com/appium/ruby_lib/blob/bc50f6f1315fb3238d9e7614cf2545d06d979ae7/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/c705d40f89117b7dea37ff6365c6d4f418e51ce9/lib/appium_lib/driver.rb#L171) +##### [promote_singleton_appium_methods](https://github.com/appium/ruby_lib/blob/bc50f6f1315fb3238d9e7614cf2545d06d979ae7/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/c705d40f89117b7dea37ff6365c6d4f418e51ce9/lib/appium_lib/driver.rb#L224) +##### [promote_appium_methods](https://github.com/appium/ruby_lib/blob/bc50f6f1315fb3238d9e7614cf2545d06d979ae7/lib/appium_lib/driver.rb#L224) > def self.promote_appium_methods(class_array) Promote appium methods to class instance methods @@ -132,12 +132,24 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Array<Class>] class_array - An array of classes -- -##### [init_caps_for_appium](https://github.com/appium/ruby_lib/blob/c705d40f89117b7dea37ff6365c6d4f418e51ce9/lib/appium_lib/driver.rb#L259) +##### [selenium_webdriver_version_more?](https://github.com/appium/ruby_lib/blob/bc50f6f1315fb3238d9e7614cf2545d06d979ae7/lib/appium_lib/driver.rb#L251) +> def self.selenium_webdriver_version_more?(version) + + + +__Returns:__ + +&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Boolean] + +-- + +##### [init_caps_for_appium](https://github.com/appium/ruby_lib/blob/bc50f6f1315fb3238d9e7614cf2545d06d979ae7/lib/appium_lib/driver.rb#L264) + > def self.init_caps_for_appium(opts_caps = {}) except for browser_name, default capability is equal to ::Selenium::WebDriver::Remote::Capabilities.firefox Because Selenium::WebDriver::Remote::Bridge uses Capabilities.firefox by default https://github.com/SeleniumHQ/selenium/blob/selenium-3.0.1/rb/lib/selenium/webdriver/remote/bridge.rb#L67 @@ -151,51 +163,51 @@ &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/c705d40f89117b7dea37ff6365c6d4f418e51ce9/lib/appium_lib/driver.rb#L277) +##### [global_webdriver_http_sleep](https://github.com/appium/ruby_lib/blob/bc50f6f1315fb3238d9e7614cf2545d06d979ae7/lib/appium_lib/driver.rb#L282) > 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/c705d40f89117b7dea37ff6365c6d4f418e51ce9/lib/appium_lib/driver.rb#L277) +##### [global_webdriver_http_sleep=](https://github.com/appium/ruby_lib/blob/bc50f6f1315fb3238d9e7614cf2545d06d979ae7/lib/appium_lib/driver.rb#L282) > 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/c705d40f89117b7dea37ff6365c6d4f418e51ce9/lib/appium_lib/driver.rb#L279) +##### [caps](https://github.com/appium/ruby_lib/blob/bc50f6f1315fb3238d9e7614cf2545d06d979ae7/lib/appium_lib/driver.rb#L284) > def caps Selenium webdriver capabilities -- -##### [custom_url](https://github.com/appium/ruby_lib/blob/c705d40f89117b7dea37ff6365c6d4f418e51ce9/lib/appium_lib/driver.rb#L281) +##### [custom_url](https://github.com/appium/ruby_lib/blob/bc50f6f1315fb3238d9e7614cf2545d06d979ae7/lib/appium_lib/driver.rb#L286) > def custom_url Custom URL for the selenium server -- -##### [export_session](https://github.com/appium/ruby_lib/blob/c705d40f89117b7dea37ff6365c6d4f418e51ce9/lib/appium_lib/driver.rb#L283) +##### [export_session](https://github.com/appium/ruby_lib/blob/bc50f6f1315fb3238d9e7614cf2545d06d979ae7/lib/appium_lib/driver.rb#L288) > def export_session Export session id to textfile in /tmp for 3rd party tools -- -##### [default_wait](https://github.com/appium/ruby_lib/blob/c705d40f89117b7dea37ff6365c6d4f418e51ce9/lib/appium_lib/driver.rb#L288) +##### [default_wait](https://github.com/appium/ruby_lib/blob/bc50f6f1315fb3238d9e7614cf2545d06d979ae7/lib/appium_lib/driver.rb#L293) > def default_wait Default wait time for elements to appear Returns the default client side wait. @@ -205,84 +217,84 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Integer] -- -##### [sauce_username](https://github.com/appium/ruby_lib/blob/c705d40f89117b7dea37ff6365c6d4f418e51ce9/lib/appium_lib/driver.rb#L290) +##### [sauce_username](https://github.com/appium/ruby_lib/blob/bc50f6f1315fb3238d9e7614cf2545d06d979ae7/lib/appium_lib/driver.rb#L295) > def sauce_username 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/c705d40f89117b7dea37ff6365c6d4f418e51ce9/lib/appium_lib/driver.rb#L292) +##### [sauce_access_key](https://github.com/appium/ruby_lib/blob/bc50f6f1315fb3238d9e7614cf2545d06d979ae7/lib/appium_lib/driver.rb#L297) > 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_endpoint](https://github.com/appium/ruby_lib/blob/c705d40f89117b7dea37ff6365c6d4f418e51ce9/lib/appium_lib/driver.rb#L294) +##### [sauce_endpoint](https://github.com/appium/ruby_lib/blob/bc50f6f1315fb3238d9e7614cf2545d06d979ae7/lib/appium_lib/driver.rb#L299) > def sauce_endpoint Override the Sauce Appium endpoint to allow e.g. TestObject tests -- -##### [appium_port](https://github.com/appium/ruby_lib/blob/c705d40f89117b7dea37ff6365c6d4f418e51ce9/lib/appium_lib/driver.rb#L296) +##### [appium_port](https://github.com/appium/ruby_lib/blob/bc50f6f1315fb3238d9e7614cf2545d06d979ae7/lib/appium_lib/driver.rb#L301) > def appium_port Appium's server port -- -##### [appium_device](https://github.com/appium/ruby_lib/blob/c705d40f89117b7dea37ff6365c6d4f418e51ce9/lib/appium_lib/driver.rb#L298) +##### [appium_device](https://github.com/appium/ruby_lib/blob/bc50f6f1315fb3238d9e7614cf2545d06d979ae7/lib/appium_lib/driver.rb#L303) > def appium_device Device type to request from the appium server -- -##### [automation_name](https://github.com/appium/ruby_lib/blob/c705d40f89117b7dea37ff6365c6d4f418e51ce9/lib/appium_lib/driver.rb#L301) +##### [automation_name](https://github.com/appium/ruby_lib/blob/bc50f6f1315fb3238d9e7614cf2545d06d979ae7/lib/appium_lib/driver.rb#L306) > 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/c705d40f89117b7dea37ff6365c6d4f418e51ce9/lib/appium_lib/driver.rb#L303) +##### [appium_server_status](https://github.com/appium/ruby_lib/blob/bc50f6f1315fb3238d9e7614cf2545d06d979ae7/lib/appium_lib/driver.rb#L308) > def appium_server_status Appium's server version -- -##### [appium_debug](https://github.com/appium/ruby_lib/blob/c705d40f89117b7dea37ff6365c6d4f418e51ce9/lib/appium_lib/driver.rb#L305) +##### [appium_debug](https://github.com/appium/ruby_lib/blob/bc50f6f1315fb3238d9e7614cf2545d06d979ae7/lib/appium_lib/driver.rb#L310) > def appium_debug Boolean debug mode for the Appium Ruby bindings -- -##### [listener](https://github.com/appium/ruby_lib/blob/c705d40f89117b7dea37ff6365c6d4f418e51ce9/lib/appium_lib/driver.rb#L307) +##### [listener](https://github.com/appium/ruby_lib/blob/bc50f6f1315fb3238d9e7614cf2545d06d979ae7/lib/appium_lib/driver.rb#L312) > def listener instance of AbstractEventListener for logging support -- -##### [driver](https://github.com/appium/ruby_lib/blob/c705d40f89117b7dea37ff6365c6d4f418e51ce9/lib/appium_lib/driver.rb#L310) +##### [driver](https://github.com/appium/ruby_lib/blob/bc50f6f1315fb3238d9e7614cf2545d06d979ae7/lib/appium_lib/driver.rb#L315) > def driver Returns the driver @@ -290,11 +302,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Driver] the driver -- -##### [http_client](https://github.com/appium/ruby_lib/blob/c705d40f89117b7dea37ff6365c6d4f418e51ce9/lib/appium_lib/driver.rb#L313) +##### [http_client](https://github.com/appium/ruby_lib/blob/bc50f6f1315fb3238d9e7614cf2545d06d979ae7/lib/appium_lib/driver.rb#L318) > def http_client Return http client called in start_driver() @@ -302,11 +314,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Selenium::WebDriver::Remote::Http::Default] the http client -- -##### [appium_wait_timeout](https://github.com/appium/ruby_lib/blob/c705d40f89117b7dea37ff6365c6d4f418e51ce9/lib/appium_lib/driver.rb#L318) +##### [appium_wait_timeout](https://github.com/appium/ruby_lib/blob/bc50f6f1315fb3238d9e7614cf2545d06d979ae7/lib/appium_lib/driver.rb#L323) > def appium_wait_timeout Return a time wait timeout Wait time for ::Appium::Common.wait or ::Appium::Common.wait_true. @@ -316,11 +328,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Integer] -- -##### [appium_wait_interval](https://github.com/appium/ruby_lib/blob/c705d40f89117b7dea37ff6365c6d4f418e51ce9/lib/appium_lib/driver.rb#L323) +##### [appium_wait_interval](https://github.com/appium/ruby_lib/blob/bc50f6f1315fb3238d9e7614cf2545d06d979ae7/lib/appium_lib/driver.rb#L328) > def appium_wait_interval Return a time wait timeout Wait interval time for ::Appium::Common.wait or ::Appium::Common.wait_true. @@ -330,11 +342,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Integer] -- -##### [initialize](https://github.com/appium/ruby_lib/blob/c705d40f89117b7dea37ff6365c6d4f418e51ce9/lib/appium_lib/driver.rb#L363) +##### [initialize](https://github.com/appium/ruby_lib/blob/bc50f6f1315fb3238d9e7614cf2545d06d979ae7/lib/appium_lib/driver.rb#L368) > def initialize(opts = {}) Creates a new driver @@ -346,19 +358,27 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Driver] -- -##### [driver_attributes](https://github.com/appium/ruby_lib/blob/c705d40f89117b7dea37ff6365c6d4f418e51ce9/lib/appium_lib/driver.rb#L441) +##### [set_appium_lib_specific_values](https://github.com/appium/ruby_lib/blob/bc50f6f1315fb3238d9e7614cf2545d06d979ae7/lib/appium_lib/driver.rb#L434) +> def set_appium_lib_specific_values(appium_lib_opts) + + + +-- + +##### [driver_attributes](https://github.com/appium/ruby_lib/blob/bc50f6f1315fb3238d9e7614cf2545d06d979ae7/lib/appium_lib/driver.rb#L460) + > def driver_attributes Returns a hash of the driver attributes -- -##### [device_is_android?](https://github.com/appium/ruby_lib/blob/c705d40f89117b7dea37ff6365c6d4f418e51ce9/lib/appium_lib/driver.rb#L466) +##### [device_is_android?](https://github.com/appium/ruby_lib/blob/bc50f6f1315fb3238d9e7614cf2545d06d979ae7/lib/appium_lib/driver.rb#L479) > def device_is_android? @@ -366,11 +386,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Boolean] -- -##### [automation_name_is_xcuitest?](https://github.com/appium/ruby_lib/blob/c705d40f89117b7dea37ff6365c6d4f418e51ce9/lib/appium_lib/driver.rb#L472) +##### [automation_name_is_xcuitest?](https://github.com/appium/ruby_lib/blob/bc50f6f1315fb3238d9e7614cf2545d06d979ae7/lib/appium_lib/driver.rb#L485) > def automation_name_is_xcuitest? Return true if automationName is 'XCUITest' @@ -378,11 +398,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Boolean] -- -##### [automation_name_is_uiautomator2?](https://github.com/appium/ruby_lib/blob/c705d40f89117b7dea37ff6365c6d4f418e51ce9/lib/appium_lib/driver.rb#L478) +##### [automation_name_is_uiautomator2?](https://github.com/appium/ruby_lib/blob/bc50f6f1315fb3238d9e7614cf2545d06d979ae7/lib/appium_lib/driver.rb#L491) > def automation_name_is_uiautomator2? Return true if automationName is 'uiautomator2' @@ -390,11 +410,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Boolean] -- -##### [check_server_version_xcuitest](https://github.com/appium/ruby_lib/blob/c705d40f89117b7dea37ff6365c6d4f418e51ce9/lib/appium_lib/driver.rb#L485) +##### [check_server_version_xcuitest](https://github.com/appium/ruby_lib/blob/bc50f6f1315fb3238d9e7614cf2545d06d979ae7/lib/appium_lib/driver.rb#L498) > 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. @@ -403,11 +423,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Boolean] -- -##### [appium_server_version](https://github.com/appium/ruby_lib/blob/c705d40f89117b7dea37ff6365c6d4f418e51ce9/lib/appium_lib/driver.rb#L512) +##### [appium_server_version](https://github.com/appium/ruby_lib/blob/bc50f6f1315fb3238d9e7614cf2545d06d979ae7/lib/appium_lib/driver.rb#L525) > def appium_server_version Returns the server's version info @@ -430,11 +450,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Hash] -- -##### [appium_client_version](https://github.com/appium/ruby_lib/blob/c705d40f89117b7dea37ff6365c6d4f418e51ce9/lib/appium_lib/driver.rb#L533) +##### [appium_client_version](https://github.com/appium/ruby_lib/blob/bc50f6f1315fb3238d9e7614cf2545d06d979ae7/lib/appium_lib/driver.rb#L546) > def appium_client_version Returns the client's version info @@ -448,11 +468,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Hash] -- -##### [absolute_app_path](https://github.com/appium/ruby_lib/blob/c705d40f89117b7dea37ff6365c6d4f418e51ce9/lib/appium_lib/driver.rb#L545) +##### [absolute_app_path](https://github.com/appium/ruby_lib/blob/bc50f6f1315fb3238d9e7614cf2545d06d979ae7/lib/appium_lib/driver.rb#L558) > def self.absolute_app_path(opts) Converts app_path to an absolute path. @@ -465,11 +485,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[String] APP_PATH as an absolute path -- -##### [server_url](https://github.com/appium/ruby_lib/blob/c705d40f89117b7dea37ff6365c6d4f418e51ce9/lib/appium_lib/driver.rb#L578) +##### [server_url](https://github.com/appium/ruby_lib/blob/bc50f6f1315fb3238d9e7614cf2545d06d979ae7/lib/appium_lib/driver.rb#L591) > def server_url Get the server url @@ -477,11 +497,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[String] the server url -- -##### [restart](https://github.com/appium/ruby_lib/blob/c705d40f89117b7dea37ff6365c6d4f418e51ce9/lib/appium_lib/driver.rb#L589) +##### [restart](https://github.com/appium/ruby_lib/blob/bc50f6f1315fb3238d9e7614cf2545d06d979ae7/lib/appium_lib/driver.rb#L602) > def restart Restarts the driver @@ -489,11 +509,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Driver] the driver -- -##### [screenshot](https://github.com/appium/ruby_lib/blob/c705d40f89117b7dea37ff6365c6d4f418e51ce9/lib/appium_lib/driver.rb#L600) +##### [screenshot](https://github.com/appium/ruby_lib/blob/bc50f6f1315fb3238d9e7614cf2545d06d979ae7/lib/appium_lib/driver.rb#L613) > def screenshot(png_save_path) Takes a png screenshot and saves to the target path. @@ -507,11 +527,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[nil] -- -##### [driver_quit](https://github.com/appium/ruby_lib/blob/c705d40f89117b7dea37ff6365c6d4f418e51ce9/lib/appium_lib/driver.rb#L607) +##### [driver_quit](https://github.com/appium/ruby_lib/blob/bc50f6f1315fb3238d9e7614cf2545d06d979ae7/lib/appium_lib/driver.rb#L620) > def driver_quit Quits the driver @@ -519,31 +539,32 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[void] -- -##### [start_driver](https://github.com/appium/ruby_lib/blob/c705d40f89117b7dea37ff6365c6d4f418e51ce9/lib/appium_lib/driver.rb#L617) +##### [start_driver](https://github.com/appium/ruby_lib/blob/bc50f6f1315fb3238d9e7614cf2545d06d979ae7/lib/appium_lib/driver.rb#L651) -> def start_driver +> def start_driver(http_client = Creates a new global driver and quits the old one if it exists. +You can customise http_client as the following __Returns:__ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Selenium::WebDriver] the new global driver -- -##### [no_wait](https://github.com/appium/ruby_lib/blob/c705d40f89117b7dea37ff6365c6d4f418e51ce9/lib/appium_lib/driver.rb#L655) +##### [no_wait](https://github.com/appium/ruby_lib/blob/bc50f6f1315fb3238d9e7614cf2545d06d979ae7/lib/appium_lib/driver.rb#L685) > def no_wait Set implicit wait to zero. -- -##### [set_wait](https://github.com/appium/ruby_lib/blob/c705d40f89117b7dea37ff6365c6d4f418e51ce9/lib/appium_lib/driver.rb#L669) +##### [set_wait](https://github.com/appium/ruby_lib/blob/bc50f6f1315fb3238d9e7614cf2545d06d979ae7/lib/appium_lib/driver.rb#L699) > def set_wait(timeout = nil) Set implicit wait. Default to @default_wait. @@ -561,11 +582,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[void] -- -##### [exists](https://github.com/appium/ruby_lib/blob/c705d40f89117b7dea37ff6365c6d4f418e51ce9/lib/appium_lib/driver.rb#L686) +##### [exists](https://github.com/appium/ruby_lib/blob/bc50f6f1315fb3238d9e7614cf2545d06d979ae7/lib/appium_lib/driver.rb#L716) > def exists(pre_check = 0, post_check = @default_wait) Returns existence of element. @@ -585,11 +606,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Boolean] -- -##### [execute_script](https://github.com/appium/ruby_lib/blob/c705d40f89117b7dea37ff6365c6d4f418e51ce9/lib/appium_lib/driver.rb#L710) +##### [execute_script](https://github.com/appium/ruby_lib/blob/bc50f6f1315fb3238d9e7614cf2545d06d979ae7/lib/appium_lib/driver.rb#L740) > def execute_script(script, *args) The same as @driver.execute_script @@ -603,11 +624,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Object] -- -##### [find_elements](https://github.com/appium/ruby_lib/blob/c705d40f89117b7dea37ff6365c6d4f418e51ce9/lib/appium_lib/driver.rb#L732) +##### [find_elements](https://github.com/appium/ruby_lib/blob/bc50f6f1315fb3238d9e7614cf2545d06d979ae7/lib/appium_lib/driver.rb#L762) > def find_elements(*args) Calls @driver.find_elements_with_appium @@ -629,11 +650,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/c705d40f89117b7dea37ff6365c6d4f418e51ce9/lib/appium_lib/driver.rb#L747) +##### [find_element](https://github.com/appium/ruby_lib/blob/bc50f6f1315fb3238d9e7614cf2545d06d979ae7/lib/appium_lib/driver.rb#L777) > def find_element(*args) Calls @driver.find_element @@ -650,11 +671,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Element] -- -##### [set_location](https://github.com/appium/ruby_lib/blob/c705d40f89117b7dea37ff6365c6d4f418e51ce9/lib/appium_lib/driver.rb#L760) +##### [set_location](https://github.com/appium/ruby_lib/blob/bc50f6f1315fb3238d9e7614cf2545d06d979ae7/lib/appium_lib/driver.rb#L790) > def set_location(opts = {}) Calls @driver.set_location @@ -666,11 +687,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Selenium::WebDriver::Location] the location constructed by the selenium webdriver -- -##### [x](https://github.com/appium/ruby_lib/blob/c705d40f89117b7dea37ff6365c6d4f418e51ce9/lib/appium_lib/driver.rb#L770) +##### [x](https://github.com/appium/ruby_lib/blob/bc50f6f1315fb3238d9e7614cf2545d06d979ae7/lib/appium_lib/driver.rb#L800) > def x Quit the driver and Pry. quit and exit are reserved by Pry. @@ -679,20 +700,28 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[void] -- -##### [set_automation_name_if_nil](https://github.com/appium/ruby_lib/blob/c705d40f89117b7dea37ff6365c6d4f418e51ce9/lib/appium_lib/driver.rb#L779) +##### [write_session_id](https://github.com/appium/ruby_lib/blob/bc50f6f1315fb3238d9e7614cf2545d06d979ae7/lib/appium_lib/driver.rb#L807) +> def write_session_id(session_id) + + + +-- + +##### [set_automation_name_if_nil](https://github.com/appium/ruby_lib/blob/bc50f6f1315fb3238d9e7614cf2545d06d979ae7/lib/appium_lib/driver.rb#L816) + > 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/c705d40f89117b7dea37ff6365c6d4f418e51ce9/lib/appium_lib/logger.rb#L13) +##### [logger=](https://github.com/appium/ruby_lib/blob/bc50f6f1315fb3238d9e7614cf2545d06d979ae7/lib/appium_lib/logger.rb#L18) > def logger=(value) Sets the attribute logger @@ -700,39 +729,39 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;value - the value to set the attribute logger to. -- -##### [logger](https://github.com/appium/ruby_lib/blob/c705d40f89117b7dea37ff6365c6d4f418e51ce9/lib/appium_lib/logger.rb#L17) +##### [logger](https://github.com/appium/ruby_lib/blob/bc50f6f1315fb3238d9e7614cf2545d06d979ae7/lib/appium_lib/logger.rb#L22) > def logger -- -##### [app_strings](https://github.com/appium/ruby_lib/blob/c705d40f89117b7dea37ff6365c6d4f418e51ce9/lib/appium_lib/device/device.rb#L7) +##### [app_strings](https://github.com/appium/ruby_lib/blob/bc50f6f1315fb3238d9e7614cf2545d06d979ae7/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/c705d40f89117b7dea37ff6365c6d4f418e51ce9/lib/appium_lib/device/device.rb#L13) +##### [background_app](https://github.com/appium/ruby_lib/blob/bc50f6f1315fb3238d9e7614cf2545d06d979ae7/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/c705d40f89117b7dea37ff6365c6d4f418e51ce9/lib/appium_lib/device/device.rb#L24) +##### [current_activity](https://github.com/appium/ruby_lib/blob/bc50f6f1315fb3238d9e7614cf2545d06d979ae7/lib/appium_lib/device/device.rb#L24) > def current_activity Get current activity name ```ruby @@ -743,11 +772,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[String] An activity name -- -##### [current_package](https://github.com/appium/ruby_lib/blob/c705d40f89117b7dea37ff6365c6d4f418e51ce9/lib/appium_lib/device/device.rb#L32) +##### [current_package](https://github.com/appium/ruby_lib/blob/bc50f6f1315fb3238d9e7614cf2545d06d979ae7/lib/appium_lib/device/device.rb#L32) > def current_package Get current package name ```ruby @@ -758,11 +787,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[String] A package name -- -##### [get_system_bars](https://github.com/appium/ruby_lib/blob/c705d40f89117b7dea37ff6365c6d4f418e51ce9/lib/appium_lib/device/device.rb#L40) +##### [get_system_bars](https://github.com/appium/ruby_lib/blob/bc50f6f1315fb3238d9e7614cf2545d06d979ae7/lib/appium_lib/device/device.rb#L40) > def get_system_bars Get system bar's information ```ruby @@ -773,11 +802,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[String] System bar -- -##### [get_display_density](https://github.com/appium/ruby_lib/blob/c705d40f89117b7dea37ff6365c6d4f418e51ce9/lib/appium_lib/device/device.rb#L48) +##### [get_display_density](https://github.com/appium/ruby_lib/blob/bc50f6f1315fb3238d9e7614cf2545d06d979ae7/lib/appium_lib/device/device.rb#L48) > def get_display_density Get connected device's density. ```ruby @@ -788,11 +817,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Integer] The size of density -- -##### [is_keyboard_shown](https://github.com/appium/ruby_lib/blob/c705d40f89117b7dea37ff6365c6d4f418e51ce9/lib/appium_lib/device/device.rb#L56) +##### [is_keyboard_shown](https://github.com/appium/ruby_lib/blob/bc50f6f1315fb3238d9e7614cf2545d06d979ae7/lib/appium_lib/device/device.rb#L56) > def is_keyboard_shown Get whether keyboard is displayed or not. ```ruby @@ -803,51 +832,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/c705d40f89117b7dea37ff6365c6d4f418e51ce9/lib/appium_lib/device/device.rb#L64) +##### [launch_app](https://github.com/appium/ruby_lib/blob/bc50f6f1315fb3238d9e7614cf2545d06d979ae7/lib/appium_lib/device/device.rb#L64) > def launch_app Start the simulator and application configured with desired capabilities -- -##### [reset](https://github.com/appium/ruby_lib/blob/c705d40f89117b7dea37ff6365c6d4f418e51ce9/lib/appium_lib/device/device.rb#L67) +##### [reset](https://github.com/appium/ruby_lib/blob/bc50f6f1315fb3238d9e7614cf2545d06d979ae7/lib/appium_lib/device/device.rb#L67) > def reset Reset the device, relaunching the application. -- -##### [shake](https://github.com/appium/ruby_lib/blob/c705d40f89117b7dea37ff6365c6d4f418e51ce9/lib/appium_lib/device/device.rb#L70) +##### [shake](https://github.com/appium/ruby_lib/blob/bc50f6f1315fb3238d9e7614cf2545d06d979ae7/lib/appium_lib/device/device.rb#L70) > def shake Cause the device to shake -- -##### [toggle_flight_mode](https://github.com/appium/ruby_lib/blob/c705d40f89117b7dea37ff6365c6d4f418e51ce9/lib/appium_lib/device/device.rb#L73) +##### [toggle_flight_mode](https://github.com/appium/ruby_lib/blob/bc50f6f1315fb3238d9e7614cf2545d06d979ae7/lib/appium_lib/device/device.rb#L73) > def toggle_flight_mode Toggle flight mode on or off -- -##### [device_locked?](https://github.com/appium/ruby_lib/blob/c705d40f89117b7dea37ff6365c6d4f418e51ce9/lib/appium_lib/device/device.rb#L76) +##### [device_locked?](https://github.com/appium/ruby_lib/blob/bc50f6f1315fb3238d9e7614cf2545d06d979ae7/lib/appium_lib/device/device.rb#L76) > def device_locked? -- -##### [hide_keyboard](https://github.com/appium/ruby_lib/blob/c705d40f89117b7dea37ff6365c6d4f418e51ce9/lib/appium_lib/device/device.rb#L78) +##### [hide_keyboard](https://github.com/appium/ruby_lib/blob/bc50f6f1315fb3238d9e7614cf2545d06d979ae7/lib/appium_lib/device/device.rb#L78) > def hide_keyboard Hide the onscreen keyboard @@ -860,11 +889,11 @@ XCUITest ignore this argument. Default for iOS is `:pressKey`. Default for Android is `:tapOutside`. -- -##### [press_keycode](https://github.com/appium/ruby_lib/blob/c705d40f89117b7dea37ff6365c6d4f418e51ce9/lib/appium_lib/device/device.rb#L91) +##### [press_keycode](https://github.com/appium/ruby_lib/blob/bc50f6f1315fb3238d9e7614cf2545d06d979ae7/lib/appium_lib/device/device.rb#L91) > def press_keycode Press keycode on the device. http://developer.android.com/reference/android/view/KeyEvent.html @@ -875,11 +904,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/c705d40f89117b7dea37ff6365c6d4f418e51ce9/lib/appium_lib/device/device.rb#L97) +##### [long_press_keycode](https://github.com/appium/ruby_lib/blob/bc50f6f1315fb3238d9e7614cf2545d06d979ae7/lib/appium_lib/device/device.rb#L97) > def long_press_keycode Long press keycode on the device. http://developer.android.com/reference/android/view/KeyEvent.html @@ -890,11 +919,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/c705d40f89117b7dea37ff6365c6d4f418e51ce9/lib/appium_lib/device/device.rb#L103) +##### [push_file](https://github.com/appium/ruby_lib/blob/bc50f6f1315fb3238d9e7614cf2545d06d979ae7/lib/appium_lib/device/device.rb#L103) > def push_file Place a file in a specific location on the device. @@ -904,11 +933,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/c705d40f89117b7dea37ff6365c6d4f418e51ce9/lib/appium_lib/device/device.rb#L108) +##### [pull_file](https://github.com/appium/ruby_lib/blob/bc50f6f1315fb3238d9e7614cf2545d06d979ae7/lib/appium_lib/device/device.rb#L108) > 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). @@ -921,11 +950,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/c705d40f89117b7dea37ff6365c6d4f418e51ce9/lib/appium_lib/device/device.rb#L118) +##### [pull_folder](https://github.com/appium/ruby_lib/blob/bc50f6f1315fb3238d9e7614cf2545d06d979ae7/lib/appium_lib/device/device.rb#L118) > def pull_folder Retrieve a folder from the device. ```ruby @@ -936,11 +965,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[String] path - absolute path to the folder -- -##### [touch_id](https://github.com/appium/ruby_lib/blob/c705d40f89117b7dea37ff6365c6d4f418e51ce9/lib/appium_lib/device/device.rb#L126) +##### [touch_id](https://github.com/appium/ruby_lib/blob/bc50f6f1315fb3238d9e7614cf2545d06d979ae7/lib/appium_lib/device/device.rb#L126) > def touch_id iOS only; Simulate Touch ID with either valid (match == true) or invalid (match == false) fingerprint. ```ruby @@ -953,19 +982,19 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Boolean] match - fingerprint validity Defaults to true. -- -##### [toggle_touch_id_enrollment](https://github.com/appium/ruby_lib/blob/c705d40f89117b7dea37ff6365c6d4f418e51ce9/lib/appium_lib/device/device.rb#L135) +##### [toggle_touch_id_enrollment](https://github.com/appium/ruby_lib/blob/bc50f6f1315fb3238d9e7614cf2545d06d979ae7/lib/appium_lib/device/device.rb#L135) > 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/c705d40f89117b7dea37ff6365c6d4f418e51ce9/lib/appium_lib/device/device.rb#L138) +##### [end_coverage](https://github.com/appium/ruby_lib/blob/bc50f6f1315fb3238d9e7614cf2545d06d979ae7/lib/appium_lib/device/device.rb#L138) > def end_coverage Android only; Ends the test coverage and writes the results to the given path on device. @@ -975,19 +1004,19 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[String] intent - Intent to broadcast when ending coverage. -- -##### [get_settings](https://github.com/appium/ruby_lib/blob/c705d40f89117b7dea37ff6365c6d4f418e51ce9/lib/appium_lib/device/device.rb#L143) +##### [get_settings](https://github.com/appium/ruby_lib/blob/bc50f6f1315fb3238d9e7614cf2545d06d979ae7/lib/appium_lib/device/device.rb#L143) > def get_settings Get appium Settings for current test session -- -##### [update_settings](https://github.com/appium/ruby_lib/blob/c705d40f89117b7dea37ff6365c6d4f418e51ce9/lib/appium_lib/device/device.rb#L146) +##### [update_settings](https://github.com/appium/ruby_lib/blob/bc50f6f1315fb3238d9e7614cf2545d06d979ae7/lib/appium_lib/device/device.rb#L146) > def update_settings Update appium Settings for current test session @@ -995,11 +1024,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/c705d40f89117b7dea37ff6365c6d4f418e51ce9/lib/appium_lib/device/device.rb#L150) +##### [start_activity](https://github.com/appium/ruby_lib/blob/bc50f6f1315fb3238d9e7614cf2545d06d979ae7/lib/appium_lib/device/device.rb#L150) > def start_activity Start a new activity within the current app or launch a new app and start the target activity. @@ -1009,20 +1038,20 @@ app_activity: '.accessibility.AccessibilityNodeProviderActivity' ``` -- -##### [get_network_connection](https://github.com/appium/ruby_lib/blob/c705d40f89117b7dea37ff6365c6d4f418e51ce9/lib/appium_lib/device/device.rb#L164) +##### [get_network_connection](https://github.com/appium/ruby_lib/blob/bc50f6f1315fb3238d9e7614cf2545d06d979ae7/lib/appium_lib/device/device.rb#L164) > 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/c705d40f89117b7dea37ff6365c6d4f418e51ce9/lib/appium_lib/device/device.rb#L168) +##### [set_network_connection](https://github.com/appium/ruby_lib/blob/bc50f6f1315fb3238d9e7614cf2545d06d979ae7/lib/appium_lib/device/device.rb#L168) > def set_network_connection Set the device network connection mode Value (Alias) | Data | Wifi | Airplane Mode @@ -1037,11 +1066,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/c705d40f89117b7dea37ff6365c6d4f418e51ce9/lib/appium_lib/device/device.rb#L181) +##### [set_immediate_value](https://github.com/appium/ruby_lib/blob/bc50f6f1315fb3238d9e7614cf2545d06d979ae7/lib/appium_lib/device/device.rb#L181) > 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. @@ -1051,11 +1080,11 @@ set_immediate_value element, 'hello' ``` -- -##### [get_performance_data_types](https://github.com/appium/ruby_lib/blob/c705d40f89117b7dea37ff6365c6d4f418e51ce9/lib/appium_lib/device/device.rb#L190) +##### [get_performance_data_types](https://github.com/appium/ruby_lib/blob/bc50f6f1315fb3238d9e7614cf2545d06d979ae7/lib/appium_lib/device/device.rb#L190) > 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. @@ -1065,27 +1094,27 @@ get_performance_data_types #=> ["cpuinfo", "batteryinfo", "networkinfo", "memoryinfo"] ``` -- -##### [extend_search_contexts](https://github.com/appium/ruby_lib/blob/c705d40f89117b7dea37ff6365c6d4f418e51ce9/lib/appium_lib/device/device.rb#L453) +##### [extend_search_contexts](https://github.com/appium/ruby_lib/blob/bc50f6f1315fb3238d9e7614cf2545d06d979ae7/lib/appium_lib/device/device.rb#L453) > def extend_search_contexts -- -##### [find_element_with_appium](https://github.com/appium/ruby_lib/blob/c705d40f89117b7dea37ff6365c6d4f418e51ce9/lib/appium_lib/device/device.rb#L453) +##### [find_element_with_appium](https://github.com/appium/ruby_lib/blob/bc50f6f1315fb3238d9e7614cf2545d06d979ae7/lib/appium_lib/device/device.rb#L453) > def find_element_with_appium -- -##### [find_elements_with_appium](https://github.com/appium/ruby_lib/blob/c705d40f89117b7dea37ff6365c6d4f418e51ce9/lib/appium_lib/device/device.rb#L453) +##### [find_elements_with_appium](https://github.com/appium/ruby_lib/blob/bc50f6f1315fb3238d9e7614cf2545d06d979ae7/lib/appium_lib/device/device.rb#L453) > def find_elements_with_appium find_element/s_with_appium with their accessibility_id @@ -1093,27 +1122,27 @@ find_elements :accessibility_id, 'Animation' ``` -- -##### [add_touch_actions](https://github.com/appium/ruby_lib/blob/c705d40f89117b7dea37ff6365c6d4f418e51ce9/lib/appium_lib/device/device.rb#L484) +##### [add_touch_actions](https://github.com/appium/ruby_lib/blob/bc50f6f1315fb3238d9e7614cf2545d06d979ae7/lib/appium_lib/device/device.rb#L484) > def add_touch_actions -- -##### [add_ime_actions](https://github.com/appium/ruby_lib/blob/c705d40f89117b7dea37ff6365c6d4f418e51ce9/lib/appium_lib/device/device.rb#L507) +##### [add_ime_actions](https://github.com/appium/ruby_lib/blob/bc50f6f1315fb3238d9e7614cf2545d06d979ae7/lib/appium_lib/device/device.rb#L507) > def add_ime_actions -- -##### [set_context](https://github.com/appium/ruby_lib/blob/c705d40f89117b7dea37ff6365c6d4f418e51ce9/lib/appium_lib/device/device.rb#L582) +##### [set_context](https://github.com/appium/ruby_lib/blob/bc50f6f1315fb3238d9e7614cf2545d06d979ae7/lib/appium_lib/device/device.rb#L582) > def set_context Change the context to the given context. ```ruby @@ -1124,11 +1153,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[String] The - context to change to -- -##### [current_context](https://github.com/appium/ruby_lib/blob/c705d40f89117b7dea37ff6365c6d4f418e51ce9/lib/appium_lib/device/device.rb#L590) +##### [current_context](https://github.com/appium/ruby_lib/blob/bc50f6f1315fb3238d9e7614cf2545d06d979ae7/lib/appium_lib/device/device.rb#L590) > def current_context @@ -1136,11 +1165,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[String] The context currently being used. -- -##### [available_contexts](https://github.com/appium/ruby_lib/blob/c705d40f89117b7dea37ff6365c6d4f418e51ce9/lib/appium_lib/device/device.rb#L593) +##### [available_contexts](https://github.com/appium/ruby_lib/blob/bc50f6f1315fb3238d9e7614cf2545d06d979ae7/lib/appium_lib/device/device.rb#L593) > def available_contexts @@ -1148,11 +1177,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/c705d40f89117b7dea37ff6365c6d4f418e51ce9/lib/appium_lib/device/device.rb#L604) +##### [within_context](https://github.com/appium/ruby_lib/blob/bc50f6f1315fb3238d9e7614cf2545d06d979ae7/lib/appium_lib/device/device.rb#L604) > def within_context(context) Perform a block within the given context, then switch back to the starting context. ```ruby @@ -1165,19 +1194,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/c705d40f89117b7dea37ff6365c6d4f418e51ce9/lib/appium_lib/device/device.rb#L617) +##### [switch_to_default_context](https://github.com/appium/ruby_lib/blob/bc50f6f1315fb3238d9e7614cf2545d06d979ae7/lib/appium_lib/device/device.rb#L617) > 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/c705d40f89117b7dea37ff6365c6d4f418e51ce9/lib/appium_lib/device/multi_touch.rb#L28) +##### [pinch](https://github.com/appium/ruby_lib/blob/bc50f6f1315fb3238d9e7614cf2545d06d979ae7/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. @@ -1192,11 +1221,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/c705d40f89117b7dea37ff6365c6d4f418e51ce9/lib/appium_lib/device/multi_touch.rb#L57) +##### [zoom](https://github.com/appium/ruby_lib/blob/bc50f6f1315fb3238d9e7614cf2545d06d979ae7/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. @@ -1211,67 +1240,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/c705d40f89117b7dea37ff6365c6d4f418e51ce9/lib/appium_lib/device/multi_touch.rb#L79) +##### [pinch_for_xcuitest](https://github.com/appium/ruby_lib/blob/bc50f6f1315fb3238d9e7614cf2545d06d979ae7/lib/appium_lib/device/multi_touch.rb#L79) > def pinch_for_xcuitest(rate) -- -##### [pinch_android](https://github.com/appium/ruby_lib/blob/c705d40f89117b7dea37ff6365c6d4f418e51ce9/lib/appium_lib/device/multi_touch.rb#L94) +##### [pinch_android](https://github.com/appium/ruby_lib/blob/bc50f6f1315fb3238d9e7614cf2545d06d979ae7/lib/appium_lib/device/multi_touch.rb#L94) > def pinch_android(rate) -- -##### [pinch_ios](https://github.com/appium/ruby_lib/blob/c705d40f89117b7dea37ff6365c6d4f418e51ce9/lib/appium_lib/device/multi_touch.rb#L108) +##### [pinch_ios](https://github.com/appium/ruby_lib/blob/bc50f6f1315fb3238d9e7614cf2545d06d979ae7/lib/appium_lib/device/multi_touch.rb#L108) > def pinch_ios(rate) -- -##### [zoom_for_xcuitest](https://github.com/appium/ruby_lib/blob/c705d40f89117b7dea37ff6365c6d4f418e51ce9/lib/appium_lib/device/multi_touch.rb#L122) +##### [zoom_for_xcuitest](https://github.com/appium/ruby_lib/blob/bc50f6f1315fb3238d9e7614cf2545d06d979ae7/lib/appium_lib/device/multi_touch.rb#L122) > def zoom_for_xcuitest(rate) -- -##### [zoom_android](https://github.com/appium/ruby_lib/blob/c705d40f89117b7dea37ff6365c6d4f418e51ce9/lib/appium_lib/device/multi_touch.rb#L137) +##### [zoom_android](https://github.com/appium/ruby_lib/blob/bc50f6f1315fb3238d9e7614cf2545d06d979ae7/lib/appium_lib/device/multi_touch.rb#L137) > def zoom_android(rate) -- -##### [zoom_ios](https://github.com/appium/ruby_lib/blob/c705d40f89117b7dea37ff6365c6d4f418e51ce9/lib/appium_lib/device/multi_touch.rb#L151) +##### [zoom_ios](https://github.com/appium/ruby_lib/blob/bc50f6f1315fb3238d9e7614cf2545d06d979ae7/lib/appium_lib/device/multi_touch.rb#L151) > def zoom_ios(rate) -- -##### [actions](https://github.com/appium/ruby_lib/blob/c705d40f89117b7dea37ff6365c6d4f418e51ce9/lib/appium_lib/device/multi_touch.rb#L166) +##### [actions](https://github.com/appium/ruby_lib/blob/bc50f6f1315fb3238d9e7614cf2545d06d979ae7/lib/appium_lib/device/multi_touch.rb#L166) > def actions self -- -##### [initialize](https://github.com/appium/ruby_lib/blob/c705d40f89117b7dea37ff6365c6d4f418e51ce9/lib/appium_lib/device/multi_touch.rb#L169) +##### [initialize](https://github.com/appium/ruby_lib/blob/bc50f6f1315fb3238d9e7614cf2545d06d979ae7/lib/appium_lib/device/multi_touch.rb#L169) > def initialize Create a new multi-action @@ -1279,11 +1308,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[MultiTouch] a new instance of MultiTouch -- -##### [add](https://github.com/appium/ruby_lib/blob/c705d40f89117b7dea37ff6365c6d4f418e51ce9/lib/appium_lib/device/multi_touch.rb#L175) +##### [add](https://github.com/appium/ruby_lib/blob/bc50f6f1315fb3238d9e7614cf2545d06d979ae7/lib/appium_lib/device/multi_touch.rb#L175) > def add(chain) Add a touch_action to be performed @@ -1291,43 +1320,43 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[TouchAction] chain - The action to add to the chain -- -##### [perform](https://github.com/appium/ruby_lib/blob/c705d40f89117b7dea37ff6365c6d4f418e51ce9/lib/appium_lib/device/multi_touch.rb#L180) +##### [perform](https://github.com/appium/ruby_lib/blob/bc50f6f1315fb3238d9e7614cf2545d06d979ae7/lib/appium_lib/device/multi_touch.rb#L180) > def perform Ask Appium to perform the actions -- -##### [ACTIONS](https://github.com/appium/ruby_lib/blob/c705d40f89117b7dea37ff6365c6d4f418e51ce9/lib/appium_lib/device/touch_actions.rb#L22) +##### [ACTIONS](https://github.com/appium/ruby_lib/blob/bc50f6f1315fb3238d9e7614cf2545d06d979ae7/lib/appium_lib/device/touch_actions.rb#L22) > 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/c705d40f89117b7dea37ff6365c6d4f418e51ce9/lib/appium_lib/device/touch_actions.rb#L23) +##### [COMPLEX_ACTIONS](https://github.com/appium/ruby_lib/blob/bc50f6f1315fb3238d9e7614cf2545d06d979ae7/lib/appium_lib/device/touch_actions.rb#L23) > COMPLEX_ACTIONS = [:swipe].freeze -- -##### [actions](https://github.com/appium/ruby_lib/blob/c705d40f89117b7dea37ff6365c6d4f418e51ce9/lib/appium_lib/device/touch_actions.rb#L37) +##### [actions](https://github.com/appium/ruby_lib/blob/bc50f6f1315fb3238d9e7614cf2545d06d979ae7/lib/appium_lib/device/touch_actions.rb#L37) > def actions Returns the value of attribute actions -- -##### [initialize](https://github.com/appium/ruby_lib/blob/c705d40f89117b7dea37ff6365c6d4f418e51ce9/lib/appium_lib/device/touch_actions.rb#L39) +##### [initialize](https://github.com/appium/ruby_lib/blob/bc50f6f1315fb3238d9e7614cf2545d06d979ae7/lib/appium_lib/device/touch_actions.rb#L39) > def initialize @@ -1335,11 +1364,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[TouchAction] a new instance of TouchAction -- -##### [move_to](https://github.com/appium/ruby_lib/blob/c705d40f89117b7dea37ff6365c6d4f418e51ce9/lib/appium_lib/device/touch_actions.rb#L50) +##### [move_to](https://github.com/appium/ruby_lib/blob/bc50f6f1315fb3238d9e7614cf2545d06d979ae7/lib/appium_lib/device/touch_actions.rb#L50) > def move_to(opts) Move to the given co-ordinates. @@ -1349,11 +1378,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Hash] opts - a customizable set of options -- -##### [long_press](https://github.com/appium/ruby_lib/blob/c705d40f89117b7dea37ff6365c6d4f418e51ce9/lib/appium_lib/device/touch_actions.rb#L64) +##### [long_press](https://github.com/appium/ruby_lib/blob/bc50f6f1315fb3238d9e7614cf2545d06d979ae7/lib/appium_lib/device/touch_actions.rb#L64) > 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. @@ -1370,11 +1399,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Hash] duration - a customizable set of options -- -##### [press](https://github.com/appium/ruby_lib/blob/c705d40f89117b7dea37ff6365c6d4f418e51ce9/lib/appium_lib/device/touch_actions.rb#L76) +##### [press](https://github.com/appium/ruby_lib/blob/bc50f6f1315fb3238d9e7614cf2545d06d979ae7/lib/appium_lib/device/touch_actions.rb#L76) > def press(opts) Press a finger onto the screen. Finger will stay down until you call `release`. @@ -1383,11 +1412,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Hash] opts - a customizable set of options -- -##### [release](https://github.com/appium/ruby_lib/blob/c705d40f89117b7dea37ff6365c6d4f418e51ce9/lib/appium_lib/device/touch_actions.rb#L87) +##### [release](https://github.com/appium/ruby_lib/blob/bc50f6f1315fb3238d9e7614cf2545d06d979ae7/lib/appium_lib/device/touch_actions.rb#L87) > def release(opts = nil) Remove a finger from the screen. @@ -1395,11 +1424,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Hash] opts - a customizable set of options -- -##### [tap](https://github.com/appium/ruby_lib/blob/c705d40f89117b7dea37ff6365c6d4f418e51ce9/lib/appium_lib/device/touch_actions.rb#L99) +##### [tap](https://github.com/appium/ruby_lib/blob/bc50f6f1315fb3238d9e7614cf2545d06d979ae7/lib/appium_lib/device/touch_actions.rb#L99) > def tap(opts) Touch a point on the screen. Alternatively, you can use `press(...).release.perform` instead of `tap(...).perform`. @@ -1408,11 +1437,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Hash] opts - a customizable set of options -- -##### [double_tap](https://github.com/appium/ruby_lib/blob/c705d40f89117b7dea37ff6365c6d4f418e51ce9/lib/appium_lib/device/touch_actions.rb#L112) +##### [double_tap](https://github.com/appium/ruby_lib/blob/bc50f6f1315fb3238d9e7614cf2545d06d979ae7/lib/appium_lib/device/touch_actions.rb#L112) > def double_tap(opts) Double tap an element on the screen @@ -1420,11 +1449,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Hash] opts - a customizable set of options -- -##### [two_finger_tap](https://github.com/appium/ruby_lib/blob/c705d40f89117b7dea37ff6365c6d4f418e51ce9/lib/appium_lib/device/touch_actions.rb#L123) +##### [two_finger_tap](https://github.com/appium/ruby_lib/blob/bc50f6f1315fb3238d9e7614cf2545d06d979ae7/lib/appium_lib/device/touch_actions.rb#L123) > def two_finger_tap(opts) Two finger tap an element on the screen @@ -1432,11 +1461,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Hash] opts - a customizable set of options -- -##### [wait](https://github.com/appium/ruby_lib/blob/c705d40f89117b7dea37ff6365c6d4f418e51ce9/lib/appium_lib/device/touch_actions.rb#L131) +##### [wait](https://github.com/appium/ruby_lib/blob/bc50f6f1315fb3238d9e7614cf2545d06d979ae7/lib/appium_lib/device/touch_actions.rb#L131) > def wait(milliseconds) Pause for a number of milliseconds before the next action @@ -1444,11 +1473,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[integer] milliseconds - Number of milliseconds to pause for -- -##### [swipe](https://github.com/appium/ruby_lib/blob/c705d40f89117b7dea37ff6365c6d4f418e51ce9/lib/appium_lib/device/touch_actions.rb#L154) +##### [swipe](https://github.com/appium/ruby_lib/blob/bc50f6f1315fb3238d9e7614cf2545d06d979ae7/lib/appium_lib/device/touch_actions.rb#L154) > def swipe(opts, ele = nil) Convenience method to peform a swipe. @@ -1465,51 +1494,51 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Hash] opts - a customizable set of options -- -##### [perform](https://github.com/appium/ruby_lib/blob/c705d40f89117b7dea37ff6365c6d4f418e51ce9/lib/appium_lib/device/touch_actions.rb#L179) +##### [perform](https://github.com/appium/ruby_lib/blob/bc50f6f1315fb3238d9e7614cf2545d06d979ae7/lib/appium_lib/device/touch_actions.rb#L179) > def perform Ask the driver to perform all actions in this action chain. -- -##### [cancel](https://github.com/appium/ruby_lib/blob/c705d40f89117b7dea37ff6365c6d4f418e51ce9/lib/appium_lib/device/touch_actions.rb#L186) +##### [cancel](https://github.com/appium/ruby_lib/blob/bc50f6f1315fb3238d9e7614cf2545d06d979ae7/lib/appium_lib/device/touch_actions.rb#L186) > def cancel Does nothing, currently. -- -##### [swipe_coordinates](https://github.com/appium/ruby_lib/blob/c705d40f89117b7dea37ff6365c6d4f418e51ce9/lib/appium_lib/device/touch_actions.rb#L192) +##### [swipe_coordinates](https://github.com/appium/ruby_lib/blob/bc50f6f1315fb3238d9e7614cf2545d06d979ae7/lib/appium_lib/device/touch_actions.rb#L192) > def swipe_coordinates(end_x: nil, end_y: nil, offset_x: nil, offset_y: nil) -- -##### [chain_method](https://github.com/appium/ruby_lib/blob/c705d40f89117b7dea37ff6365c6d4f418e51ce9/lib/appium_lib/device/touch_actions.rb#L210) +##### [chain_method](https://github.com/appium/ruby_lib/blob/bc50f6f1315fb3238d9e7614cf2545d06d979ae7/lib/appium_lib/device/touch_actions.rb#L210) > def chain_method(method, args = nil) -- -##### [args_with_ele_ref](https://github.com/appium/ruby_lib/blob/c705d40f89117b7dea37ff6365c6d4f418e51ce9/lib/appium_lib/device/touch_actions.rb#L216) +##### [args_with_ele_ref](https://github.com/appium/ruby_lib/blob/bc50f6f1315fb3238d9e7614cf2545d06d979ae7/lib/appium_lib/device/touch_actions.rb#L216) > def args_with_ele_ref(args) -- -##### [initialize](https://github.com/appium/ruby_lib/blob/c705d40f89117b7dea37ff6365c6d4f418e51ce9/lib/appium_lib/common/wait.rb#L4) +##### [initialize](https://github.com/appium/ruby_lib/blob/bc50f6f1315fb3238d9e7614cf2545d06d979ae7/lib/appium_lib/common/wait.rb#L4) > def initialize(opts = {}) @@ -1517,28 +1546,28 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Wait] a new instance of Wait -- -##### [until](https://github.com/appium/ruby_lib/blob/c705d40f89117b7dea37ff6365c6d4f418e51ce9/lib/appium_lib/common/wait.rb#L23) +##### [until](https://github.com/appium/ruby_lib/blob/bc50f6f1315fb3238d9e7614cf2545d06d979ae7/lib/appium_lib/common/wait.rb#L23) > def until 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/c705d40f89117b7dea37ff6365c6d4f418e51ce9/lib/appium_lib/common/wait.rb#L51) +##### [_process_wait_opts](https://github.com/appium/ruby_lib/blob/bc50f6f1315fb3238d9e7614cf2545d06d979ae7/lib/appium_lib/common/wait.rb#L51) > def _process_wait_opts(opts) process opts before calling _generic_wait -- -##### [wait_true](https://github.com/appium/ruby_lib/blob/c705d40f89117b7dea37ff6365c6d4f418e51ce9/lib/appium_lib/common/wait.rb#L72) +##### [wait_true](https://github.com/appium/ruby_lib/blob/bc50f6f1315fb3238d9e7614cf2545d06d979ae7/lib/appium_lib/common/wait.rb#L72) > def wait_true(opts = {}) Check every interval seconds to see if yield returns a truthy value. Note this isn't a strict boolean true, any truthy value is accepted. @@ -1554,11 +1583,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Hash] opts - Options -- -##### [wait](https://github.com/appium/ruby_lib/blob/c705d40f89117b7dea37ff6365c6d4f418e51ce9/lib/appium_lib/common/wait.rb#L95) +##### [wait](https://github.com/appium/ruby_lib/blob/bc50f6f1315fb3238d9e7614cf2545d06d979ae7/lib/appium_lib/common/wait.rb#L95) > def wait(opts = {}) Check every interval seconds to see if yield doesn't raise an exception. Give up after timeout seconds. @@ -1572,19 +1601,19 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Hash] opts - Options -- -##### [ignore](https://github.com/appium/ruby_lib/blob/c705d40f89117b7dea37ff6365c6d4f418e51ce9/lib/appium_lib/common/helper.rb#L24) +##### [ignore](https://github.com/appium/ruby_lib/blob/bc50f6f1315fb3238d9e7614cf2545d06d979ae7/lib/appium_lib/common/helper.rb#L24) > def ignore Return yield and ignore any exceptions. -- -##### [back](https://github.com/appium/ruby_lib/blob/c705d40f89117b7dea37ff6365c6d4f418e51ce9/lib/appium_lib/common/helper.rb#L31) +##### [back](https://github.com/appium/ruby_lib/blob/bc50f6f1315fb3238d9e7614cf2545d06d979ae7/lib/appium_lib/common/helper.rb#L31) > def back Navigate back. @@ -1592,19 +1621,19 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[void] -- -##### [session_id](https://github.com/appium/ruby_lib/blob/c705d40f89117b7dea37ff6365c6d4f418e51ce9/lib/appium_lib/common/helper.rb#L36) +##### [session_id](https://github.com/appium/ruby_lib/blob/bc50f6f1315fb3238d9e7614cf2545d06d979ae7/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/c705d40f89117b7dea37ff6365c6d4f418e51ce9/lib/appium_lib/common/helper.rb#L44) +##### [xpath](https://github.com/appium/ruby_lib/blob/bc50f6f1315fb3238d9e7614cf2545d06d979ae7/lib/appium_lib/common/helper.rb#L44) > def xpath(xpath_str) Returns the first element that matches the provided xpath. @@ -1616,11 +1645,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Element] -- -##### [xpaths](https://github.com/appium/ruby_lib/blob/c705d40f89117b7dea37ff6365c6d4f418e51ce9/lib/appium_lib/common/helper.rb#L52) +##### [xpaths](https://github.com/appium/ruby_lib/blob/bc50f6f1315fb3238d9e7614cf2545d06d979ae7/lib/appium_lib/common/helper.rb#L52) > def xpaths(xpath_str) Returns all elements that match the provided xpath. @@ -1632,27 +1661,27 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Array<Element>] -- -##### [_print_source](https://github.com/appium/ruby_lib/blob/c705d40f89117b7dea37ff6365c6d4f418e51ce9/lib/appium_lib/common/helper.rb#L56) +##### [_print_source](https://github.com/appium/ruby_lib/blob/bc50f6f1315fb3238d9e7614cf2545d06d979ae7/lib/appium_lib/common/helper.rb#L56) > def _print_source(source) -- -##### [result](https://github.com/appium/ruby_lib/blob/c705d40f89117b7dea37ff6365c6d4f418e51ce9/lib/appium_lib/common/helper.rb#L69) +##### [result](https://github.com/appium/ruby_lib/blob/bc50f6f1315fb3238d9e7614cf2545d06d979ae7/lib/appium_lib/common/helper.rb#L69) > def result Returns the value of attribute result -- -##### [initialize](https://github.com/appium/ruby_lib/blob/c705d40f89117b7dea37ff6365c6d4f418e51ce9/lib/appium_lib/common/helper.rb#L71) +##### [initialize](https://github.com/appium/ruby_lib/blob/bc50f6f1315fb3238d9e7614cf2545d06d979ae7/lib/appium_lib/common/helper.rb#L71) > def initialize @@ -1660,52 +1689,52 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[CountElements] a new instance of CountElements -- -##### [reset](https://github.com/appium/ruby_lib/blob/c705d40f89117b7dea37ff6365c6d4f418e51ce9/lib/appium_lib/common/helper.rb#L75) +##### [reset](https://github.com/appium/ruby_lib/blob/bc50f6f1315fb3238d9e7614cf2545d06d979ae7/lib/appium_lib/common/helper.rb#L75) > def reset -- -##### [start_element](https://github.com/appium/ruby_lib/blob/c705d40f89117b7dea37ff6365c6d4f418e51ce9/lib/appium_lib/common/helper.rb#L80) +##### [start_element](https://github.com/appium/ruby_lib/blob/bc50f6f1315fb3238d9e7614cf2545d06d979ae7/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/c705d40f89117b7dea37ff6365c6d4f418e51ce9/lib/appium_lib/common/helper.rb#L86) +##### [formatted_result](https://github.com/appium/ruby_lib/blob/bc50f6f1315fb3238d9e7614cf2545d06d979ae7/lib/appium_lib/common/helper.rb#L86) > def formatted_result -- -##### [get_page_class](https://github.com/appium/ruby_lib/blob/c705d40f89117b7dea37ff6365c6d4f418e51ce9/lib/appium_lib/common/helper.rb#L97) +##### [get_page_class](https://github.com/appium/ruby_lib/blob/bc50f6f1315fb3238d9e7614cf2545d06d979ae7/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/c705d40f89117b7dea37ff6365c6d4f418e51ce9/lib/appium_lib/common/helper.rb#L108) +##### [page_class](https://github.com/appium/ruby_lib/blob/bc50f6f1315fb3238d9e7614cf2545d06d979ae7/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/c705d40f89117b7dea37ff6365c6d4f418e51ce9/lib/appium_lib/common/helper.rb#L118) +##### [px_to_window_rel](https://github.com/appium/ruby_lib/blob/bc50f6f1315fb3238d9e7614cf2545d06d979ae7/lib/appium_lib/common/helper.rb#L118) > def px_to_window_rel(opts = {}) Converts pixel values to window relative values @@ -1713,11 +1742,11 @@ px_to_window_rel x: 50, y: 150 ``` -- -##### [xml_keys](https://github.com/appium/ruby_lib/blob/c705d40f89117b7dea37ff6365c6d4f418e51ce9/lib/appium_lib/common/helper.rb#L137) +##### [xml_keys](https://github.com/appium/ruby_lib/blob/bc50f6f1315fb3238d9e7614cf2545d06d979ae7/lib/appium_lib/common/helper.rb#L137) > def xml_keys(target) Search strings.xml's values for target. @@ -1729,11 +1758,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Array] -- -##### [xml_values](https://github.com/appium/ruby_lib/blob/c705d40f89117b7dea37ff6365c6d4f418e51ce9/lib/appium_lib/common/helper.rb#L145) +##### [xml_values](https://github.com/appium/ruby_lib/blob/bc50f6f1315fb3238d9e7614cf2545d06d979ae7/lib/appium_lib/common/helper.rb#L145) > def xml_values(target) Search strings.xml's keys for target. @@ -1745,11 +1774,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Array] -- -##### [resolve_id](https://github.com/appium/ruby_lib/blob/c705d40f89117b7dea37ff6365c6d4f418e51ce9/lib/appium_lib/common/helper.rb#L153) +##### [resolve_id](https://github.com/appium/ruby_lib/blob/bc50f6f1315fb3238d9e7614cf2545d06d979ae7/lib/appium_lib/common/helper.rb#L153) > def resolve_id(id) Resolve id in strings.xml and return the value. @@ -1761,27 +1790,27 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[String] -- -##### [filter](https://github.com/appium/ruby_lib/blob/c705d40f89117b7dea37ff6365c6d4f418e51ce9/lib/appium_lib/common/helper.rb#L159) +##### [filter](https://github.com/appium/ruby_lib/blob/bc50f6f1315fb3238d9e7614cf2545d06d979ae7/lib/appium_lib/common/helper.rb#L159) > def filter Returns the value of attribute filter -- -##### [filter=](https://github.com/appium/ruby_lib/blob/c705d40f89117b7dea37ff6365c6d4f418e51ce9/lib/appium_lib/common/helper.rb#L162) +##### [filter=](https://github.com/appium/ruby_lib/blob/bc50f6f1315fb3238d9e7614cf2545d06d979ae7/lib/appium_lib/common/helper.rb#L162) > def filter=(value) convert to string to support symbols -- -##### [initialize](https://github.com/appium/ruby_lib/blob/c705d40f89117b7dea37ff6365c6d4f418e51ce9/lib/appium_lib/common/helper.rb#L168) +##### [initialize](https://github.com/appium/ruby_lib/blob/bc50f6f1315fb3238d9e7614cf2545d06d979ae7/lib/appium_lib/common/helper.rb#L168) > def initialize @@ -1789,99 +1818,99 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[HTMLElements] a new instance of HTMLElements -- -##### [reset](https://github.com/appium/ruby_lib/blob/c705d40f89117b7dea37ff6365c6d4f418e51ce9/lib/appium_lib/common/helper.rb#L173) +##### [reset](https://github.com/appium/ruby_lib/blob/bc50f6f1315fb3238d9e7614cf2545d06d979ae7/lib/appium_lib/common/helper.rb#L173) > def reset -- -##### [result](https://github.com/appium/ruby_lib/blob/c705d40f89117b7dea37ff6365c6d4f418e51ce9/lib/appium_lib/common/helper.rb#L179) +##### [result](https://github.com/appium/ruby_lib/blob/bc50f6f1315fb3238d9e7614cf2545d06d979ae7/lib/appium_lib/common/helper.rb#L179) > def result -- -##### [start_element](https://github.com/appium/ruby_lib/blob/c705d40f89117b7dea37ff6365c6d4f418e51ce9/lib/appium_lib/common/helper.rb#L195) +##### [start_element](https://github.com/appium/ruby_lib/blob/bc50f6f1315fb3238d9e7614cf2545d06d979ae7/lib/appium_lib/common/helper.rb#L195) > def start_element(name, attrs = []) -- -##### [end_element](https://github.com/appium/ruby_lib/blob/c705d40f89117b7dea37ff6365c6d4f418e51ce9/lib/appium_lib/common/helper.rb#L204) +##### [end_element](https://github.com/appium/ruby_lib/blob/bc50f6f1315fb3238d9e7614cf2545d06d979ae7/lib/appium_lib/common/helper.rb#L204) > def end_element(name) -- -##### [characters](https://github.com/appium/ruby_lib/blob/c705d40f89117b7dea37ff6365c6d4f418e51ce9/lib/appium_lib/common/helper.rb#L210) +##### [characters](https://github.com/appium/ruby_lib/blob/bc50f6f1315fb3238d9e7614cf2545d06d979ae7/lib/appium_lib/common/helper.rb#L210) > def characters(chars) -- -##### [_no_such_element](https://github.com/appium/ruby_lib/blob/c705d40f89117b7dea37ff6365c6d4f418e51ce9/lib/appium_lib/common/helper.rb#L217) +##### [_no_such_element](https://github.com/appium/ruby_lib/blob/bc50f6f1315fb3238d9e7614cf2545d06d979ae7/lib/appium_lib/common/helper.rb#L217) > def _no_such_element -- -##### [COMMAND_NO_ARG](https://github.com/appium/ruby_lib/blob/c705d40f89117b7dea37ff6365c6d4f418e51ce9/lib/appium_lib/common/command.rb#L4) +##### [COMMAND_NO_ARG](https://github.com/appium/ruby_lib/blob/bc50f6f1315fb3238d9e7614cf2545d06d979ae7/lib/appium_lib/common/command.rb#L4) > COMMAND_NO_ARG = { -- -##### [COMMAND](https://github.com/appium/ruby_lib/blob/c705d40f89117b7dea37ff6365c6d4f418e51ce9/lib/appium_lib/common/command.rb#L28) +##### [COMMAND](https://github.com/appium/ruby_lib/blob/bc50f6f1315fb3238d9e7614cf2545d06d979ae7/lib/appium_lib/common/command.rb#L28) > COMMAND = { -- -##### [window_size](https://github.com/appium/ruby_lib/blob/c705d40f89117b7dea37ff6365c6d4f418e51ce9/lib/appium_lib/common/element/window.rb#L5) +##### [window_size](https://github.com/appium/ruby_lib/blob/bc50f6f1315fb3238d9e7614cf2545d06d979ae7/lib/appium_lib/common/element/window.rb#L5) > def window_size Get the window's size -- -##### [FINDERS](https://github.com/appium/ruby_lib/blob/c705d40f89117b7dea37ff6365c6d4f418e51ce9/lib/appium_lib/common/search_context.rb#L5) +##### [FINDERS](https://github.com/appium/ruby_lib/blob/bc50f6f1315fb3238d9e7614cf2545d06d979ae7/lib/appium_lib/common/search_context.rb#L5) > FINDERS = { rubocop:disable Style/MutableConstant -- -##### [filter](https://github.com/appium/ruby_lib/blob/c705d40f89117b7dea37ff6365c6d4f418e51ce9/lib/appium_lib/ios/helper.rb#L4) ios +##### [filter](https://github.com/appium/ruby_lib/blob/bc50f6f1315fb3238d9e7614cf2545d06d979ae7/lib/appium_lib/ios/helper.rb#L4) ios > def filter Returns the value of attribute filter -- -##### [filter=](https://github.com/appium/ruby_lib/blob/c705d40f89117b7dea37ff6365c6d4f418e51ce9/lib/appium_lib/ios/helper.rb#L4) ios +##### [filter=](https://github.com/appium/ruby_lib/blob/bc50f6f1315fb3238d9e7614cf2545d06d979ae7/lib/appium_lib/ios/helper.rb#L4) ios > def filter=(value) Sets the attribute filter @@ -1889,27 +1918,27 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;value - the value to set the attribute filter to. -- -##### [start_element](https://github.com/appium/ruby_lib/blob/c705d40f89117b7dea37ff6365c6d4f418e51ce9/lib/appium_lib/ios/helper.rb#L6) ios +##### [start_element](https://github.com/appium/ruby_lib/blob/bc50f6f1315fb3238d9e7614cf2545d06d979ae7/lib/appium_lib/ios/helper.rb#L6) ios > def start_element(type, attrs = []) -- -##### [_print_attr](https://github.com/appium/ruby_lib/blob/c705d40f89117b7dea37ff6365c6d4f418e51ce9/lib/appium_lib/ios/helper.rb#L15) ios +##### [_print_attr](https://github.com/appium/ruby_lib/blob/bc50f6f1315fb3238d9e7614cf2545d06d979ae7/lib/appium_lib/ios/helper.rb#L15) ios > def _print_attr(type, name, label, value, hint, visible) # rubocop:disable Metrics/ParameterLists rubocop:disable Metrics/ParameterLists -- -##### [ios_password](https://github.com/appium/ruby_lib/blob/c705d40f89117b7dea37ff6365c6d4f418e51ce9/lib/appium_lib/ios/helper.rb#L42) ios +##### [ios_password](https://github.com/appium/ruby_lib/blob/bc50f6f1315fb3238d9e7614cf2545d06d979ae7/lib/appium_lib/ios/helper.rb#L42) ios > def ios_password(length = 1) iOS only. On Android uiautomator always returns an empty string for EditText password. @@ -1923,11 +1952,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[String] the returned string is of size length -- -##### [get_page](https://github.com/appium/ruby_lib/blob/c705d40f89117b7dea37ff6365c6d4f418e51ce9/lib/appium_lib/ios/helper.rb#L55) ios +##### [get_page](https://github.com/appium/ruby_lib/blob/bc50f6f1315fb3238d9e7614cf2545d06d979ae7/lib/appium_lib/ios/helper.rb#L55) ios > def get_page(element = source_window(0), class_name = nil) Returns a string of interesting elements. iOS only. @@ -1944,11 +1973,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[String] -- -##### [page](https://github.com/appium/ruby_lib/blob/c705d40f89117b7dea37ff6365c6d4f418e51ce9/lib/appium_lib/ios/helper.rb#L142) ios +##### [page](https://github.com/appium/ruby_lib/blob/bc50f6f1315fb3238d9e7614cf2545d06d979ae7/lib/appium_lib/ios/helper.rb#L142) ios > def page(opts = {}) Prints a string of interesting elements to the console. @@ -1969,11 +1998,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[void] -- -##### [source_window](https://github.com/appium/ruby_lib/blob/c705d40f89117b7dea37ff6365c6d4f418e51ce9/lib/appium_lib/ios/helper.rb#L166) ios +##### [source_window](https://github.com/appium/ruby_lib/blob/bc50f6f1315fb3238d9e7614cf2545d06d979ae7/lib/appium_lib/ios/helper.rb#L166) ios > def source_window(window_number = nil) Gets the JSON source of window number @@ -1981,11 +2010,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[JSON] -- -##### [page_window](https://github.com/appium/ruby_lib/blob/c705d40f89117b7dea37ff6365c6d4f418e51ce9/lib/appium_lib/ios/helper.rb#L177) ios +##### [page_window](https://github.com/appium/ruby_lib/blob/bc50f6f1315fb3238d9e7614cf2545d06d979ae7/lib/appium_lib/ios/helper.rb#L177) ios > def page_window(window_number = 0) Prints parsed page source to console. @@ -1999,11 +2028,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[void] -- -##### [id](https://github.com/appium/ruby_lib/blob/c705d40f89117b7dea37ff6365c6d4f418e51ce9/lib/appium_lib/ios/helper.rb#L185) ios +##### [id](https://github.com/appium/ruby_lib/blob/bc50f6f1315fb3238d9e7614cf2545d06d979ae7/lib/appium_lib/ios/helper.rb#L185) ios > def id(id) Find by id @@ -2015,11 +2044,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Element] -- -##### [ios_version](https://github.com/appium/ruby_lib/blob/c705d40f89117b7dea37ff6365c6d4f418e51ce9/lib/appium_lib/ios/helper.rb#L191) ios +##### [ios_version](https://github.com/appium/ruby_lib/blob/bc50f6f1315fb3238d9e7614cf2545d06d979ae7/lib/appium_lib/ios/helper.rb#L191) ios > def ios_version Return the iOS version as an array of integers @@ -2027,11 +2056,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Array<Integer>] -- -##### [ele_index](https://github.com/appium/ruby_lib/blob/c705d40f89117b7dea37ff6365c6d4f418e51ce9/lib/appium_lib/ios/helper.rb#L204) ios +##### [ele_index](https://github.com/appium/ruby_lib/blob/bc50f6f1315fb3238d9e7614cf2545d06d979ae7/lib/appium_lib/ios/helper.rb#L204) ios > def ele_index(class_name, index) Get the element of type class_name at matching index. @@ -2045,11 +2074,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Element] -- -##### [find_ele_by_attr](https://github.com/appium/ruby_lib/blob/c705d40f89117b7dea37ff6365c6d4f418e51ce9/lib/appium_lib/ios/helper.rb#L240) ios +##### [find_ele_by_attr](https://github.com/appium/ruby_lib/blob/bc50f6f1315fb3238d9e7614cf2545d06d979ae7/lib/appium_lib/ios/helper.rb#L240) ios > def find_ele_by_attr(class_name, attr, value) Find the first element exactly matching class and attribute value. Note: Uses XPath @@ -2067,11 +2096,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Element] -- -##### [find_eles_by_attr](https://github.com/appium/ruby_lib/blob/c705d40f89117b7dea37ff6365c6d4f418e51ce9/lib/appium_lib/ios/helper.rb#L251) ios +##### [find_eles_by_attr](https://github.com/appium/ruby_lib/blob/bc50f6f1315fb3238d9e7614cf2545d06d979ae7/lib/appium_lib/ios/helper.rb#L251) ios > def find_eles_by_attr(class_name, attr, value) Find all elements exactly matching class and attribute value. Note: Uses XPath @@ -2089,11 +2118,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Array<Element>] -- -##### [find_ele_by_predicate](https://github.com/appium/ruby_lib/blob/c705d40f89117b7dea37ff6365c6d4f418e51ce9/lib/appium_lib/ios/helper.rb#L272) ios +##### [find_ele_by_predicate](https://github.com/appium/ruby_lib/blob/bc50f6f1315fb3238d9e7614cf2545d06d979ae7/lib/appium_lib/ios/helper.rb#L272) ios > def find_ele_by_predicate(class_name: '*', value:) Find the first element exactly matching attribute case insensitive value. Note: Uses Predicate @@ -2106,11 +2135,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Element] -- -##### [find_eles_by_predicate](https://github.com/appium/ruby_lib/blob/c705d40f89117b7dea37ff6365c6d4f418e51ce9/lib/appium_lib/ios/helper.rb#L283) ios +##### [find_eles_by_predicate](https://github.com/appium/ruby_lib/blob/bc50f6f1315fb3238d9e7614cf2545d06d979ae7/lib/appium_lib/ios/helper.rb#L283) ios > def find_eles_by_predicate(class_name: '*', value:) Find all elements exactly matching attribute case insensitive value. Note: Uses Predicate @@ -2125,11 +2154,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Array<Element>] -- -##### [find_ele_by_attr_include](https://github.com/appium/ruby_lib/blob/c705d40f89117b7dea37ff6365c6d4f418e51ce9/lib/appium_lib/ios/helper.rb#L299) ios +##### [find_ele_by_attr_include](https://github.com/appium/ruby_lib/blob/bc50f6f1315fb3238d9e7614cf2545d06d979ae7/lib/appium_lib/ios/helper.rb#L299) ios > def find_ele_by_attr_include(class_name, attr, value) Get the first tag by attribute that exactly matches value. Note: Uses XPath @@ -2146,11 +2175,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Element] the element of type tag who's attribute includes value -- -##### [find_eles_by_attr_include](https://github.com/appium/ruby_lib/blob/c705d40f89117b7dea37ff6365c6d4f418e51ce9/lib/appium_lib/ios/helper.rb#L309) ios +##### [find_eles_by_attr_include](https://github.com/appium/ruby_lib/blob/bc50f6f1315fb3238d9e7614cf2545d06d979ae7/lib/appium_lib/ios/helper.rb#L309) ios > def find_eles_by_attr_include(class_name, attr, value) Get tags by attribute that include value. Note: Uses XPath @@ -2167,11 +2196,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Array<Element>] the elements of type tag who's attribute includes value -- -##### [find_ele_by_predicate_include](https://github.com/appium/ruby_lib/blob/c705d40f89117b7dea37ff6365c6d4f418e51ce9/lib/appium_lib/ios/helper.rb#L317) ios +##### [find_ele_by_predicate_include](https://github.com/appium/ruby_lib/blob/bc50f6f1315fb3238d9e7614cf2545d06d979ae7/lib/appium_lib/ios/helper.rb#L317) ios > def find_ele_by_predicate_include(class_name: '*', value:) Get the first elements that include insensitive value. Note: Uses Predicate @@ -2184,11 +2213,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Element] the element of type tag who's attribute includes value -- -##### [find_eles_by_predicate_include](https://github.com/appium/ruby_lib/blob/c705d40f89117b7dea37ff6365c6d4f418e51ce9/lib/appium_lib/ios/helper.rb#L328) ios +##### [find_eles_by_predicate_include](https://github.com/appium/ruby_lib/blob/bc50f6f1315fb3238d9e7614cf2545d06d979ae7/lib/appium_lib/ios/helper.rb#L328) ios > def find_eles_by_predicate_include(class_name: '*', value:) Get elements that include case insensitive value. Note: Uses Predicate @@ -2203,11 +2232,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Array<Element>] the elements of type tag who's attribute includes value -- -##### [first_ele](https://github.com/appium/ruby_lib/blob/c705d40f89117b7dea37ff6365c6d4f418e51ce9/lib/appium_lib/ios/helper.rb#L341) ios +##### [first_ele](https://github.com/appium/ruby_lib/blob/bc50f6f1315fb3238d9e7614cf2545d06d979ae7/lib/appium_lib/ios/helper.rb#L341) ios > def first_ele(class_name) Get the first tag that matches class_name @@ -2219,11 +2248,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Element] -- -##### [last_ele](https://github.com/appium/ruby_lib/blob/c705d40f89117b7dea37ff6365c6d4f418e51ce9/lib/appium_lib/ios/helper.rb#L348) ios +##### [last_ele](https://github.com/appium/ruby_lib/blob/bc50f6f1315fb3238d9e7614cf2545d06d979ae7/lib/appium_lib/ios/helper.rb#L348) ios > def last_ele(class_name) Get the last tag that matches class_name @@ -2235,11 +2264,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Element] -- -##### [tag](https://github.com/appium/ruby_lib/blob/c705d40f89117b7dea37ff6365c6d4f418e51ce9/lib/appium_lib/ios/helper.rb#L362) ios +##### [tag](https://github.com/appium/ruby_lib/blob/bc50f6f1315fb3238d9e7614cf2545d06d979ae7/lib/appium_lib/ios/helper.rb#L362) ios > def tag(class_name) Returns the first **visible** element matching class_name @@ -2251,11 +2280,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Element] -- -##### [tags](https://github.com/appium/ruby_lib/blob/c705d40f89117b7dea37ff6365c6d4f418e51ce9/lib/appium_lib/ios/helper.rb#L374) ios +##### [tags](https://github.com/appium/ruby_lib/blob/bc50f6f1315fb3238d9e7614cf2545d06d979ae7/lib/appium_lib/ios/helper.rb#L374) ios > def tags(class_name) Returns all visible elements matching class_name @@ -2267,11 +2296,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Element] -- -##### [tags_include](https://github.com/appium/ruby_lib/blob/c705d40f89117b7dea37ff6365c6d4f418e51ce9/lib/appium_lib/ios/helper.rb#L390) ios +##### [tags_include](https://github.com/appium/ruby_lib/blob/bc50f6f1315fb3238d9e7614cf2545d06d979ae7/lib/appium_lib/ios/helper.rb#L390) ios > def tags_include(class_names:, value: nil) Returns all visible elements matching class_names and value This method calls find_element/s and element.value/text many times. @@ -2287,11 +2316,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Array[Element]] -- -##### [tags_exact](https://github.com/appium/ruby_lib/blob/c705d40f89117b7dea37ff6365c6d4f418e51ce9/lib/appium_lib/ios/helper.rb#L419) ios +##### [tags_exact](https://github.com/appium/ruby_lib/blob/bc50f6f1315fb3238d9e7614cf2545d06d979ae7/lib/appium_lib/ios/helper.rb#L419) ios > def tags_exact(class_names:, value: nil) Returns all visible elements matching class_names and value. This method calls find_element/s and element.value/text many times. @@ -2307,11 +2336,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Array[Element]] -- -##### [ele_by_json_visible_contains](https://github.com/appium/ruby_lib/blob/c705d40f89117b7dea37ff6365c6d4f418e51ce9/lib/appium_lib/ios/helper.rb#L470) ios +##### [ele_by_json_visible_contains](https://github.com/appium/ruby_lib/blob/bc50f6f1315fb3238d9e7614cf2545d06d979ae7/lib/appium_lib/ios/helper.rb#L470) ios > def ele_by_json_visible_contains(element, value) Find the first element that contains value. For Appium(automation name), not XCUITest @@ -2326,11 +2355,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Element] -- -##### [eles_by_json_visible_contains](https://github.com/appium/ruby_lib/blob/c705d40f89117b7dea37ff6365c6d4f418e51ce9/lib/appium_lib/ios/helper.rb#L479) ios +##### [eles_by_json_visible_contains](https://github.com/appium/ruby_lib/blob/bc50f6f1315fb3238d9e7614cf2545d06d979ae7/lib/appium_lib/ios/helper.rb#L479) ios > def eles_by_json_visible_contains(element, value) Find all elements containing value For Appium(automation name), not XCUITest @@ -2345,11 +2374,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Array<Element>] -- -##### [ele_by_json_visible_exact](https://github.com/appium/ruby_lib/blob/c705d40f89117b7dea37ff6365c6d4f418e51ce9/lib/appium_lib/ios/helper.rb#L509) ios +##### [ele_by_json_visible_exact](https://github.com/appium/ruby_lib/blob/bc50f6f1315fb3238d9e7614cf2545d06d979ae7/lib/appium_lib/ios/helper.rb#L509) ios > def ele_by_json_visible_exact(element, value) Find the first element exactly matching value For Appium(automation name), not XCUITest @@ -2364,11 +2393,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Element] -- -##### [eles_by_json_visible_exact](https://github.com/appium/ruby_lib/blob/c705d40f89117b7dea37ff6365c6d4f418e51ce9/lib/appium_lib/ios/helper.rb#L518) ios +##### [eles_by_json_visible_exact](https://github.com/appium/ruby_lib/blob/bc50f6f1315fb3238d9e7614cf2545d06d979ae7/lib/appium_lib/ios/helper.rb#L518) ios > def eles_by_json_visible_exact(element, value) Find all elements exactly matching value For Appium(automation name), not XCUITest @@ -2383,21 +2412,21 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Element] -- -##### [_all_pred](https://github.com/appium/ruby_lib/blob/c705d40f89117b7dea37ff6365c6d4f418e51ce9/lib/appium_lib/ios/helper.rb#L527) ios +##### [_all_pred](https://github.com/appium/ruby_lib/blob/bc50f6f1315fb3238d9e7614cf2545d06d979ae7/lib/appium_lib/ios/helper.rb#L527) ios > def _all_pred(opts) predicate - the predicate to evaluate on the main app visible - if true, only visible elements are returned. default true -- -##### [ele_with_pred](https://github.com/appium/ruby_lib/blob/c705d40f89117b7dea37ff6365c6d4f418e51ce9/lib/appium_lib/ios/helper.rb#L540) ios +##### [ele_with_pred](https://github.com/appium/ruby_lib/blob/bc50f6f1315fb3238d9e7614cf2545d06d979ae7/lib/appium_lib/ios/helper.rb#L540) ios > def ele_with_pred(opts) returns element matching predicate contained in the main app @@ -2409,11 +2438,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Element] -- -##### [eles_with_pred](https://github.com/appium/ruby_lib/blob/c705d40f89117b7dea37ff6365c6d4f418e51ce9/lib/appium_lib/ios/helper.rb#L551) ios +##### [eles_with_pred](https://github.com/appium/ruby_lib/blob/bc50f6f1315fb3238d9e7614cf2545d06d979ae7/lib/appium_lib/ios/helper.rb#L551) ios > def eles_with_pred(opts) returns elements matching predicate contained in the main app @@ -2425,11 +2454,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Array<Element>] -- -##### [source](https://github.com/appium/ruby_lib/blob/c705d40f89117b7dea37ff6365c6d4f418e51ce9/lib/appium_lib/ios/helper.rb#L557) ios +##### [source](https://github.com/appium/ruby_lib/blob/bc50f6f1315fb3238d9e7614cf2545d06d979ae7/lib/appium_lib/ios/helper.rb#L557) ios > def source Prints xml of the current page @@ -2437,19 +2466,19 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[void] -- -##### [_validate_object](https://github.com/appium/ruby_lib/blob/c705d40f89117b7dea37ff6365c6d4f418e51ce9/lib/appium_lib/ios/helper.rb#L561) ios +##### [_validate_object](https://github.com/appium/ruby_lib/blob/bc50f6f1315fb3238d9e7614cf2545d06d979ae7/lib/appium_lib/ios/helper.rb#L561) ios > def _validate_object(*objects) -- -##### [_by_json](https://github.com/appium/ruby_lib/blob/c705d40f89117b7dea37ff6365c6d4f418e51ce9/lib/appium_lib/ios/helper.rb#L610) ios +##### [_by_json](https://github.com/appium/ruby_lib/blob/bc50f6f1315fb3238d9e7614cf2545d06d979ae7/lib/appium_lib/ios/helper.rb#L610) ios > def _by_json(opts) For Appium(automation name), not XCUITest typeArray - array of string types to search for. Example: ["UIAStaticText"] @@ -2480,11 +2509,11 @@ } } -- -##### [eles_by_json](https://github.com/appium/ruby_lib/blob/c705d40f89117b7dea37ff6365c6d4f418e51ce9/lib/appium_lib/ios/helper.rb#L660) ios +##### [eles_by_json](https://github.com/appium/ruby_lib/blob/bc50f6f1315fb3238d9e7614cf2545d06d979ae7/lib/appium_lib/ios/helper.rb#L660) ios > def eles_by_json(opts) For Appium(automation name), not XCUITest example usage: @@ -2499,19 +2528,19 @@ }, }) -- -##### [ele_by_json](https://github.com/appium/ruby_lib/blob/c705d40f89117b7dea37ff6365c6d4f418e51ce9/lib/appium_lib/ios/helper.rb#L666) ios +##### [ele_by_json](https://github.com/appium/ruby_lib/blob/bc50f6f1315fb3238d9e7614cf2545d06d979ae7/lib/appium_lib/ios/helper.rb#L666) ios > def ele_by_json(opts) see eles_by_json -- -##### [get_source](https://github.com/appium/ruby_lib/blob/c705d40f89117b7dea37ff6365c6d4f418e51ce9/lib/appium_lib/ios/helper.rb#L676) ios +##### [get_source](https://github.com/appium/ruby_lib/blob/bc50f6f1315fb3238d9e7614cf2545d06d979ae7/lib/appium_lib/ios/helper.rb#L676) ios > def get_source Returns XML string for the current page Same as driver.page_source @@ -2520,27 +2549,27 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[String] -- -##### [UIAStaticText](https://github.com/appium/ruby_lib/blob/c705d40f89117b7dea37ff6365c6d4f418e51ce9/lib/appium_lib/ios/element/text.rb#L4) ios +##### [UIAStaticText](https://github.com/appium/ruby_lib/blob/bc50f6f1315fb3238d9e7614cf2545d06d979ae7/lib/appium_lib/ios/element/text.rb#L4) ios > UIAStaticText = 'UIAStaticText'.freeze -- -##### [XCUIElementTypeStaticText](https://github.com/appium/ruby_lib/blob/c705d40f89117b7dea37ff6365c6d4f418e51ce9/lib/appium_lib/ios/element/text.rb#L5) ios +##### [XCUIElementTypeStaticText](https://github.com/appium/ruby_lib/blob/bc50f6f1315fb3238d9e7614cf2545d06d979ae7/lib/appium_lib/ios/element/text.rb#L5) ios > XCUIElementTypeStaticText = 'XCUIElementTypeStaticText'.freeze -- -##### [static_text_class](https://github.com/appium/ruby_lib/blob/c705d40f89117b7dea37ff6365c6d4f418e51ce9/lib/appium_lib/ios/element/text.rb#L8) ios +##### [static_text_class](https://github.com/appium/ruby_lib/blob/bc50f6f1315fb3238d9e7614cf2545d06d979ae7/lib/appium_lib/ios/element/text.rb#L8) ios > def static_text_class @@ -2548,11 +2577,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[String] Class name for text -- -##### [text](https://github.com/appium/ruby_lib/blob/c705d40f89117b7dea37ff6365c6d4f418e51ce9/lib/appium_lib/ios/element/text.rb#L16) ios +##### [text](https://github.com/appium/ruby_lib/blob/bc50f6f1315fb3238d9e7614cf2545d06d979ae7/lib/appium_lib/ios/element/text.rb#L16) ios > def text(value) Find the first UIAStaticText|XCUIElementTypeStaticText that contains value or by index. If int then the UIAStaticText|XCUIElementTypeStaticText at that index is returned. @@ -2565,11 +2594,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[UIAStaticText|XCUIElementTypeStaticText] -- -##### [texts](https://github.com/appium/ruby_lib/blob/c705d40f89117b7dea37ff6365c6d4f418e51ce9/lib/appium_lib/ios/element/text.rb#L30) ios +##### [texts](https://github.com/appium/ruby_lib/blob/bc50f6f1315fb3238d9e7614cf2545d06d979ae7/lib/appium_lib/ios/element/text.rb#L30) ios > def texts(value = false) Find all UIAStaticTexts|XCUIElementTypeStaticTexts containing value. If value is omitted, all UIAStaticTexts|XCUIElementTypeStaticTexts are returned @@ -2582,11 +2611,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Array<UIAStaticText|XCUIElementTypeStaticText>] -- -##### [first_text](https://github.com/appium/ruby_lib/blob/c705d40f89117b7dea37ff6365c6d4f418e51ce9/lib/appium_lib/ios/element/text.rb#L43) ios +##### [first_text](https://github.com/appium/ruby_lib/blob/bc50f6f1315fb3238d9e7614cf2545d06d979ae7/lib/appium_lib/ios/element/text.rb#L43) ios > def first_text Find the first UIAStaticText|XCUIElementTypeStaticText. @@ -2594,11 +2623,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[UIAStaticText|XCUIElementTypeStaticText] -- -##### [last_text](https://github.com/appium/ruby_lib/blob/c705d40f89117b7dea37ff6365c6d4f418e51ce9/lib/appium_lib/ios/element/text.rb#L49) ios +##### [last_text](https://github.com/appium/ruby_lib/blob/bc50f6f1315fb3238d9e7614cf2545d06d979ae7/lib/appium_lib/ios/element/text.rb#L49) ios > def last_text Find the last UIAStaticText|XCUIElementTypeStaticText. @@ -2606,11 +2635,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[UIAStaticText|XCUIElementTypeStaticText] -- -##### [text_exact](https://github.com/appium/ruby_lib/blob/c705d40f89117b7dea37ff6365c6d4f418e51ce9/lib/appium_lib/ios/element/text.rb#L56) ios +##### [text_exact](https://github.com/appium/ruby_lib/blob/bc50f6f1315fb3238d9e7614cf2545d06d979ae7/lib/appium_lib/ios/element/text.rb#L56) ios > def text_exact(value) Find the first UIAStaticText|XCUIElementTypeStaticText that exactly matches value. @@ -2622,11 +2651,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[UIAStaticText|XCUIElementTypeStaticText] -- -##### [texts_exact](https://github.com/appium/ruby_lib/blob/c705d40f89117b7dea37ff6365c6d4f418e51ce9/lib/appium_lib/ios/element/text.rb#L67) ios +##### [texts_exact](https://github.com/appium/ruby_lib/blob/bc50f6f1315fb3238d9e7614cf2545d06d979ae7/lib/appium_lib/ios/element/text.rb#L67) ios > def texts_exact(value) Find all UIAStaticTexts|XCUIElementTypeStaticTexts that exactly match value. @@ -2638,11 +2667,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Array<UIAStaticText|XCUIElementTypeStaticText>] -- -##### [alert_accept](https://github.com/appium/ruby_lib/blob/c705d40f89117b7dea37ff6365c6d4f418e51ce9/lib/appium_lib/ios/element/alert.rb#L5) ios +##### [alert_accept](https://github.com/appium/ruby_lib/blob/bc50f6f1315fb3238d9e7614cf2545d06d979ae7/lib/appium_lib/ios/element/alert.rb#L5) ios > def alert_accept Accept the alert. @@ -2650,11 +2679,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[void] -- -##### [alert_dismiss](https://github.com/appium/ruby_lib/blob/c705d40f89117b7dea37ff6365c6d4f418e51ce9/lib/appium_lib/ios/element/alert.rb#L13) ios +##### [alert_dismiss](https://github.com/appium/ruby_lib/blob/bc50f6f1315fb3238d9e7614cf2545d06d979ae7/lib/appium_lib/ios/element/alert.rb#L13) ios > def alert_dismiss Dismiss the alert. @@ -2662,27 +2691,27 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[void] -- -##### [UIAButton](https://github.com/appium/ruby_lib/blob/c705d40f89117b7dea37ff6365c6d4f418e51ce9/lib/appium_lib/ios/element/button.rb#L4) ios +##### [UIAButton](https://github.com/appium/ruby_lib/blob/bc50f6f1315fb3238d9e7614cf2545d06d979ae7/lib/appium_lib/ios/element/button.rb#L4) ios > UIAButton = 'UIAButton'.freeze -- -##### [XCUIElementTypeButton](https://github.com/appium/ruby_lib/blob/c705d40f89117b7dea37ff6365c6d4f418e51ce9/lib/appium_lib/ios/element/button.rb#L5) ios +##### [XCUIElementTypeButton](https://github.com/appium/ruby_lib/blob/bc50f6f1315fb3238d9e7614cf2545d06d979ae7/lib/appium_lib/ios/element/button.rb#L5) ios > XCUIElementTypeButton = 'XCUIElementTypeButton'.freeze -- -##### [button_class](https://github.com/appium/ruby_lib/blob/c705d40f89117b7dea37ff6365c6d4f418e51ce9/lib/appium_lib/ios/element/button.rb#L8) ios +##### [button_class](https://github.com/appium/ruby_lib/blob/bc50f6f1315fb3238d9e7614cf2545d06d979ae7/lib/appium_lib/ios/element/button.rb#L8) ios > def button_class @@ -2690,11 +2719,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[String] Class name for button -- -##### [button](https://github.com/appium/ruby_lib/blob/c705d40f89117b7dea37ff6365c6d4f418e51ce9/lib/appium_lib/ios/element/button.rb#L16) ios +##### [button](https://github.com/appium/ruby_lib/blob/bc50f6f1315fb3238d9e7614cf2545d06d979ae7/lib/appium_lib/ios/element/button.rb#L16) ios > def button(value) Find the first UIAButton|XCUIElementTypeButton that contains value or by index. If int then the UIAButton|XCUIElementTypeButton at that index is returned. @@ -2707,11 +2736,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[UIAButton|XCUIElementTypeButton] -- -##### [buttons](https://github.com/appium/ruby_lib/blob/c705d40f89117b7dea37ff6365c6d4f418e51ce9/lib/appium_lib/ios/element/button.rb#L31) ios +##### [buttons](https://github.com/appium/ruby_lib/blob/bc50f6f1315fb3238d9e7614cf2545d06d979ae7/lib/appium_lib/ios/element/button.rb#L31) ios > def buttons(value = false) Find all UIAButtons|XCUIElementTypeButtons containing value. If value is omitted, all UIAButtons|XCUIElementTypeButtons are returned. @@ -2724,11 +2753,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Array<UIAButton|XCUIElementTypeButton>] -- -##### [first_button](https://github.com/appium/ruby_lib/blob/c705d40f89117b7dea37ff6365c6d4f418e51ce9/lib/appium_lib/ios/element/button.rb#L44) ios +##### [first_button](https://github.com/appium/ruby_lib/blob/bc50f6f1315fb3238d9e7614cf2545d06d979ae7/lib/appium_lib/ios/element/button.rb#L44) ios > def first_button Find the first UIAButton|XCUIElementTypeButton. @@ -2736,11 +2765,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[UIAButton|XCUIElementTypeButton] -- -##### [last_button](https://github.com/appium/ruby_lib/blob/c705d40f89117b7dea37ff6365c6d4f418e51ce9/lib/appium_lib/ios/element/button.rb#L52) ios +##### [last_button](https://github.com/appium/ruby_lib/blob/bc50f6f1315fb3238d9e7614cf2545d06d979ae7/lib/appium_lib/ios/element/button.rb#L52) ios > def last_button TODO: add documentation regarding previous element. Previous UIAElement is differ from UIAButton|XCUIElementTypeButton. So, the results are different. @@ -2750,11 +2779,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[UIAButton|XCUIElementTypeButton] -- -##### [button_exact](https://github.com/appium/ruby_lib/blob/c705d40f89117b7dea37ff6365c6d4f418e51ce9/lib/appium_lib/ios/element/button.rb#L59) ios +##### [button_exact](https://github.com/appium/ruby_lib/blob/bc50f6f1315fb3238d9e7614cf2545d06d979ae7/lib/appium_lib/ios/element/button.rb#L59) ios > def button_exact(value) Find the first UIAButton|XCUIElementTypeButton that exactly matches value. @@ -2766,11 +2795,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[UIAButton|XCUIElementTypeButton] -- -##### [buttons_exact](https://github.com/appium/ruby_lib/blob/c705d40f89117b7dea37ff6365c6d4f418e51ce9/lib/appium_lib/ios/element/button.rb#L70) ios +##### [buttons_exact](https://github.com/appium/ruby_lib/blob/bc50f6f1315fb3238d9e7614cf2545d06d979ae7/lib/appium_lib/ios/element/button.rb#L70) ios > def buttons_exact(value) Find all UIAButtons|XCUIElementTypeButtons that exactly match value. @@ -2782,11 +2811,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Array<UIAButton|XCUIElementTypeButton>] -- -##### [uiautomation_find](https://github.com/appium/ruby_lib/blob/c705d40f89117b7dea37ff6365c6d4f418e51ce9/lib/appium_lib/ios/mobile_methods.rb#L32) ios +##### [uiautomation_find](https://github.com/appium/ruby_lib/blob/bc50f6f1315fb3238d9e7614cf2545d06d979ae7/lib/appium_lib/ios/mobile_methods.rb#L19) ios > def uiautomation_find find_element/s can be used with a [UIAutomation command](https://developer.apple.com/library/ios/documentation/ToolsLanguages/Reference/UIAWindowClassReference/UIAWindow/UIAWindow.html#//apple_ref/doc/uid/TP40009930). @@ -2794,11 +2823,11 @@ find_elements :uiautomation, 'elements() ``` -- -##### [ios_predicate_string_find](https://github.com/appium/ruby_lib/blob/c705d40f89117b7dea37ff6365c6d4f418e51ce9/lib/appium_lib/ios/mobile_methods.rb#L32) ios +##### [ios_predicate_string_find](https://github.com/appium/ruby_lib/blob/bc50f6f1315fb3238d9e7614cf2545d06d979ae7/lib/appium_lib/ios/mobile_methods.rb#L19) ios > def ios_predicate_string_find find_element/s can be used with a [Predicates](https://developer.apple.com/library/content/documentation/Cocoa/Conceptual/Predicates/AdditionalChapters/Introduction.html) @@ -2808,11 +2837,11 @@ find_elements :predicate, 'wdValue == "SearchBar" AND isWDDivisible == 1' ``` -- -##### [ios_class_chain_find](https://github.com/appium/ruby_lib/blob/c705d40f89117b7dea37ff6365c6d4f418e51ce9/lib/appium_lib/ios/mobile_methods.rb#L32) ios +##### [ios_class_chain_find](https://github.com/appium/ruby_lib/blob/bc50f6f1315fb3238d9e7614cf2545d06d979ae7/lib/appium_lib/ios/mobile_methods.rb#L39) ios > def ios_class_chain_find Only for XCUITest(WebDriverAgent) find_element/s can be used with a [class chain]( https://github.com/facebook/WebDriverAgent/wiki/Queries) @@ -2826,11 +2855,11 @@ find_elements :class_chain, 'XCUIElementTypeWindow[2]/XCUIElementTypeAny[-2]' ``` -- -##### [find](https://github.com/appium/ruby_lib/blob/c705d40f89117b7dea37ff6365c6d4f418e51ce9/lib/appium_lib/ios/element/generic.rb#L6) ios +##### [find](https://github.com/appium/ruby_lib/blob/bc50f6f1315fb3238d9e7614cf2545d06d979ae7/lib/appium_lib/ios/element/generic.rb#L6) ios > def find(value) Find the first element containing value @@ -2842,11 +2871,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Element] -- -##### [finds](https://github.com/appium/ruby_lib/blob/c705d40f89117b7dea37ff6365c6d4f418e51ce9/lib/appium_lib/ios/element/generic.rb#L17) ios +##### [finds](https://github.com/appium/ruby_lib/blob/bc50f6f1315fb3238d9e7614cf2545d06d979ae7/lib/appium_lib/ios/element/generic.rb#L17) ios > def finds(value) Find all elements containing value @@ -2858,11 +2887,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Array<Element>] -- -##### [find_exact](https://github.com/appium/ruby_lib/blob/c705d40f89117b7dea37ff6365c6d4f418e51ce9/lib/appium_lib/ios/element/generic.rb#L29) ios +##### [find_exact](https://github.com/appium/ruby_lib/blob/bc50f6f1315fb3238d9e7614cf2545d06d979ae7/lib/appium_lib/ios/element/generic.rb#L29) ios > def find_exact(value) Find the first element exactly matching value @@ -2874,11 +2903,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Element] -- -##### [finds_exact](https://github.com/appium/ruby_lib/blob/c705d40f89117b7dea37ff6365c6d4f418e51ce9/lib/appium_lib/ios/element/generic.rb#L40) ios +##### [finds_exact](https://github.com/appium/ruby_lib/blob/bc50f6f1315fb3238d9e7614cf2545d06d979ae7/lib/appium_lib/ios/element/generic.rb#L40) ios > def finds_exact(value) Find all elements exactly matching value @@ -2890,59 +2919,59 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Array<Element>] -- -##### [raise_error_if_no_element](https://github.com/appium/ruby_lib/blob/c705d40f89117b7dea37ff6365c6d4f418e51ce9/lib/appium_lib/ios/element/generic.rb#L51) ios +##### [raise_error_if_no_element](https://github.com/appium/ruby_lib/blob/bc50f6f1315fb3238d9e7614cf2545d06d979ae7/lib/appium_lib/ios/element/generic.rb#L51) ios > def raise_error_if_no_element(element) -- -##### [select_visible_elements](https://github.com/appium/ruby_lib/blob/c705d40f89117b7dea37ff6365c6d4f418e51ce9/lib/appium_lib/ios/element/generic.rb#L58) ios +##### [select_visible_elements](https://github.com/appium/ruby_lib/blob/bc50f6f1315fb3238d9e7614cf2545d06d979ae7/lib/appium_lib/ios/element/generic.rb#L58) ios > def select_visible_elements(elements) Return visible elements. -- -##### [UIATextField](https://github.com/appium/ruby_lib/blob/c705d40f89117b7dea37ff6365c6d4f418e51ce9/lib/appium_lib/ios/element/textfield.rb#L3) ios +##### [UIATextField](https://github.com/appium/ruby_lib/blob/bc50f6f1315fb3238d9e7614cf2545d06d979ae7/lib/appium_lib/ios/element/textfield.rb#L3) ios > UIATextField = 'UIATextField'.freeze -- -##### [UIASecureTextField](https://github.com/appium/ruby_lib/blob/c705d40f89117b7dea37ff6365c6d4f418e51ce9/lib/appium_lib/ios/element/textfield.rb#L4) ios +##### [UIASecureTextField](https://github.com/appium/ruby_lib/blob/bc50f6f1315fb3238d9e7614cf2545d06d979ae7/lib/appium_lib/ios/element/textfield.rb#L4) ios > UIASecureTextField = 'UIASecureTextField'.freeze -- -##### [XCUIElementTypeTextField](https://github.com/appium/ruby_lib/blob/c705d40f89117b7dea37ff6365c6d4f418e51ce9/lib/appium_lib/ios/element/textfield.rb#L6) ios +##### [XCUIElementTypeTextField](https://github.com/appium/ruby_lib/blob/bc50f6f1315fb3238d9e7614cf2545d06d979ae7/lib/appium_lib/ios/element/textfield.rb#L6) ios > XCUIElementTypeTextField = 'XCUIElementTypeTextField'.freeze -- -##### [XCUIElementTypeSecureTextField](https://github.com/appium/ruby_lib/blob/c705d40f89117b7dea37ff6365c6d4f418e51ce9/lib/appium_lib/ios/element/textfield.rb#L7) ios +##### [XCUIElementTypeSecureTextField](https://github.com/appium/ruby_lib/blob/bc50f6f1315fb3238d9e7614cf2545d06d979ae7/lib/appium_lib/ios/element/textfield.rb#L7) ios > XCUIElementTypeSecureTextField = 'XCUIElementTypeSecureTextField'.freeze -- -##### [text_field_class](https://github.com/appium/ruby_lib/blob/c705d40f89117b7dea37ff6365c6d4f418e51ce9/lib/appium_lib/ios/element/textfield.rb#L10) ios +##### [text_field_class](https://github.com/appium/ruby_lib/blob/bc50f6f1315fb3238d9e7614cf2545d06d979ae7/lib/appium_lib/ios/element/textfield.rb#L10) ios > def text_field_class @@ -2950,11 +2979,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[String] Class name for text field -- -##### [secure_text_field_class](https://github.com/appium/ruby_lib/blob/c705d40f89117b7dea37ff6365c6d4f418e51ce9/lib/appium_lib/ios/element/textfield.rb#L15) ios +##### [secure_text_field_class](https://github.com/appium/ruby_lib/blob/bc50f6f1315fb3238d9e7614cf2545d06d979ae7/lib/appium_lib/ios/element/textfield.rb#L15) ios > def secure_text_field_class @@ -2962,35 +2991,35 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[String] Class name for secure text field -- -##### [_textfield_visible](https://github.com/appium/ruby_lib/blob/c705d40f89117b7dea37ff6365c6d4f418e51ce9/lib/appium_lib/ios/element/textfield.rb#L35) ios +##### [_textfield_visible](https://github.com/appium/ruby_lib/blob/bc50f6f1315fb3238d9e7614cf2545d06d979ae7/lib/appium_lib/ios/element/textfield.rb#L35) ios > def _textfield_visible Appium -- -##### [_textfield_exact_string](https://github.com/appium/ruby_lib/blob/c705d40f89117b7dea37ff6365c6d4f418e51ce9/lib/appium_lib/ios/element/textfield.rb#L40) ios +##### [_textfield_exact_string](https://github.com/appium/ruby_lib/blob/bc50f6f1315fb3238d9e7614cf2545d06d979ae7/lib/appium_lib/ios/element/textfield.rb#L40) ios > def _textfield_exact_string(value) Appium -- -##### [_textfield_contains_string](https://github.com/appium/ruby_lib/blob/c705d40f89117b7dea37ff6365c6d4f418e51ce9/lib/appium_lib/ios/element/textfield.rb#L47) ios +##### [_textfield_contains_string](https://github.com/appium/ruby_lib/blob/bc50f6f1315fb3238d9e7614cf2545d06d979ae7/lib/appium_lib/ios/element/textfield.rb#L47) ios > def _textfield_contains_string(value) Appium -- -##### [textfield](https://github.com/appium/ruby_lib/blob/c705d40f89117b7dea37ff6365c6d4f418e51ce9/lib/appium_lib/ios/element/textfield.rb#L60) ios +##### [textfield](https://github.com/appium/ruby_lib/blob/bc50f6f1315fb3238d9e7614cf2545d06d979ae7/lib/appium_lib/ios/element/textfield.rb#L60) ios > def textfield(value) Find the first TextField that contains value or by index. Note: Uses XPath @@ -3004,11 +3033,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[TextField] -- -##### [textfields](https://github.com/appium/ruby_lib/blob/c705d40f89117b7dea37ff6365c6d4f418e51ce9/lib/appium_lib/ios/element/textfield.rb#L86) ios +##### [textfields](https://github.com/appium/ruby_lib/blob/bc50f6f1315fb3238d9e7614cf2545d06d979ae7/lib/appium_lib/ios/element/textfield.rb#L86) ios > def textfields(value = false) Find all TextFields containing value. If value is omitted, all TextFields are returned. @@ -3021,11 +3050,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Array<TextField>] -- -##### [first_textfield](https://github.com/appium/ruby_lib/blob/c705d40f89117b7dea37ff6365c6d4f418e51ce9/lib/appium_lib/ios/element/textfield.rb#L100) ios +##### [first_textfield](https://github.com/appium/ruby_lib/blob/bc50f6f1315fb3238d9e7614cf2545d06d979ae7/lib/appium_lib/ios/element/textfield.rb#L100) ios > def first_textfield Find the first TextField. @@ -3033,11 +3062,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[TextField] -- -##### [last_textfield](https://github.com/appium/ruby_lib/blob/c705d40f89117b7dea37ff6365c6d4f418e51ce9/lib/appium_lib/ios/element/textfield.rb#L110) ios +##### [last_textfield](https://github.com/appium/ruby_lib/blob/bc50f6f1315fb3238d9e7614cf2545d06d979ae7/lib/appium_lib/ios/element/textfield.rb#L110) ios > def last_textfield Find the last TextField. @@ -3045,11 +3074,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[TextField] -- -##### [textfield_exact](https://github.com/appium/ruby_lib/blob/c705d40f89117b7dea37ff6365c6d4f418e51ce9/lib/appium_lib/ios/element/textfield.rb#L123) ios +##### [textfield_exact](https://github.com/appium/ruby_lib/blob/bc50f6f1315fb3238d9e7614cf2545d06d979ae7/lib/appium_lib/ios/element/textfield.rb#L123) ios > def textfield_exact(value) Find the first TextField that exactly matches value. @@ -3061,11 +3090,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[TextField] -- -##### [textfields_exact](https://github.com/appium/ruby_lib/blob/c705d40f89117b7dea37ff6365c6d4f418e51ce9/lib/appium_lib/ios/element/textfield.rb#L134) ios +##### [textfields_exact](https://github.com/appium/ruby_lib/blob/bc50f6f1315fb3238d9e7614cf2545d06d979ae7/lib/appium_lib/ios/element/textfield.rb#L134) ios > def textfields_exact(value) Find all TextFields that exactly match value. @@ -3077,11 +3106,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Array<TextField>] -- -##### [swipe](https://github.com/appium/ruby_lib/blob/c705d40f89117b7dea37ff6365c6d4f418e51ce9/lib/appium_lib/ios/xcuitest_gestures.rb#L10) ios +##### [swipe](https://github.com/appium/ruby_lib/blob/bc50f6f1315fb3238d9e7614cf2545d06d979ae7/lib/appium_lib/ios/xcuitest_gestures.rb#L11) ios > def swipe(direction:, element: nil) @@ -3091,11 +3120,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Hash] opts - a customizable set of options -- -##### [scroll](https://github.com/appium/ruby_lib/blob/c705d40f89117b7dea37ff6365c6d4f418e51ce9/lib/appium_lib/ios/xcuitest_gestures.rb#L30) ios +##### [scroll](https://github.com/appium/ruby_lib/blob/bc50f6f1315fb3238d9e7614cf2545d06d979ae7/lib/appium_lib/ios/xcuitest_gestures.rb#L31) ios > def scroll(direction:, name: nil, element: nil, to_visible: nil, predicate_string: nil) @@ -3105,11 +3134,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Hash] opts - a customizable set of options -- -##### [pinch](https://github.com/appium/ruby_lib/blob/c705d40f89117b7dea37ff6365c6d4f418e51ce9/lib/appium_lib/ios/xcuitest_gestures.rb#L49) ios +##### [pinch](https://github.com/appium/ruby_lib/blob/bc50f6f1315fb3238d9e7614cf2545d06d979ae7/lib/appium_lib/ios/xcuitest_gestures.rb#L50) ios > def pinch(scale:, velocity: 1.0, element: nil) @@ -3121,11 +3150,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Hash] opts - a customizable set of options -- -##### [double_tap](https://github.com/appium/ruby_lib/blob/c705d40f89117b7dea37ff6365c6d4f418e51ce9/lib/appium_lib/ios/xcuitest_gestures.rb#L66) ios +##### [double_tap](https://github.com/appium/ruby_lib/blob/bc50f6f1315fb3238d9e7614cf2545d06d979ae7/lib/appium_lib/ios/xcuitest_gestures.rb#L67) ios > def double_tap(x: nil, y: nil, element: nil) @@ -3137,11 +3166,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Hash] opts - a customizable set of options -- -##### [touch_and_hold](https://github.com/appium/ruby_lib/blob/c705d40f89117b7dea37ff6365c6d4f418e51ce9/lib/appium_lib/ios/xcuitest_gestures.rb#L84) ios +##### [touch_and_hold](https://github.com/appium/ruby_lib/blob/bc50f6f1315fb3238d9e7614cf2545d06d979ae7/lib/appium_lib/ios/xcuitest_gestures.rb#L85) ios > def touch_and_hold(x: nil, y: nil, element: nil, duration: 1.0) @@ -3155,11 +3184,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Hash] opts - a customizable set of options -- -##### [two_finger_tap](https://github.com/appium/ruby_lib/blob/c705d40f89117b7dea37ff6365c6d4f418e51ce9/lib/appium_lib/ios/xcuitest_gestures.rb#L98) ios +##### [two_finger_tap](https://github.com/appium/ruby_lib/blob/bc50f6f1315fb3238d9e7614cf2545d06d979ae7/lib/appium_lib/ios/xcuitest_gestures.rb#L99) ios > def two_finger_tap(element:) @@ -3171,11 +3200,11 @@ two_finger_tap element: find_element(:accessibility_id, "some item") ``` -- -##### [tap](https://github.com/appium/ruby_lib/blob/c705d40f89117b7dea37ff6365c6d4f418e51ce9/lib/appium_lib/ios/xcuitest_gestures.rb#L115) ios +##### [tap](https://github.com/appium/ruby_lib/blob/bc50f6f1315fb3238d9e7614cf2545d06d979ae7/lib/appium_lib/ios/xcuitest_gestures.rb#L116) ios > def tap(x:, y:, element: nil) @@ -3187,11 +3216,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Hash] opts - a customizable set of options -- -##### [drag_from_to_for_duration](https://github.com/appium/ruby_lib/blob/c705d40f89117b7dea37ff6365c6d4f418e51ce9/lib/appium_lib/ios/xcuitest_gestures.rb#L137) ios +##### [drag_from_to_for_duration](https://github.com/appium/ruby_lib/blob/bc50f6f1315fb3238d9e7614cf2545d06d979ae7/lib/appium_lib/ios/xcuitest_gestures.rb#L138) ios > def drag_from_to_for_duration(from_x:, from_y:, to_x:, to_y:, duration: 1.0, element: nil) rubocop:disable Metrics/ParameterLists @@ -3210,11 +3239,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Hash] opts - a customizable set of options -- -##### [select_picker_wheel](https://github.com/appium/ruby_lib/blob/c705d40f89117b7dea37ff6365c6d4f418e51ce9/lib/appium_lib/ios/xcuitest_gestures.rb#L156) ios +##### [select_picker_wheel](https://github.com/appium/ruby_lib/blob/bc50f6f1315fb3238d9e7614cf2545d06d979ae7/lib/appium_lib/ios/xcuitest_gestures.rb#L157) ios > def select_picker_wheel(element:, order:, offset: nil) https://github.com/facebook/WebDriverAgent/pull/523 https://github.com/appium/appium-xcuitest-driver/pull/420 @@ -3227,11 +3256,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Hash] opts - a customizable set of options -- -##### [alert](https://github.com/appium/ruby_lib/blob/c705d40f89117b7dea37ff6365c6d4f418e51ce9/lib/appium_lib/ios/xcuitest_gestures.rb#L175) ios +##### [alert](https://github.com/appium/ruby_lib/blob/bc50f6f1315fb3238d9e7614cf2545d06d979ae7/lib/appium_lib/ios/xcuitest_gestures.rb#L176) ios > def alert(action:, button_label: nil) @@ -3242,56 +3271,54 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[String] button_label - The label text of an existing alert button to click on. This is an optional parameter and is only valid in combination with accept and dismiss actions. -- -##### [value](https://github.com/appium/ruby_lib/blob/c705d40f89117b7dea37ff6365c6d4f418e51ce9/lib/appium_lib/common/patch.rb#L12) +##### [value](https://github.com/appium/ruby_lib/blob/bc50f6f1315fb3238d9e7614cf2545d06d979ae7/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/c705d40f89117b7dea37ff6365c6d4f418e51ce9/lib/appium_lib/common/patch.rb#L19) +##### [name](https://github.com/appium/ruby_lib/blob/bc50f6f1315fb3238d9e7614cf2545d06d979ae7/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/c705d40f89117b7dea37ff6365c6d4f418e51ce9/lib/appium_lib/common/patch.rb#L31) +##### [location_rel](https://github.com/appium/ruby_lib/blob/bc50f6f1315fb3238d9e7614cf2545d06d979ae7/lib/appium_lib/common/patch.rb#L30) > def location_rel For use with mobile tap. ```ruby execute_script 'mobile: tap', :x => 0.0, :y => 0.98 ``` -https://github.com/appium/appium/wiki/Automating-mobile-gestures - __Returns:__ &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/c705d40f89117b7dea37ff6365c6d4f418e51ce9/lib/appium_lib/common/patch.rb#L152) +##### [DEFAULT_HEADERS](https://github.com/appium/ruby_lib/blob/bc50f6f1315fb3238d9e7614cf2545d06d979ae7/lib/appium_lib/common/patch.rb#L162) > DEFAULT_HEADERS = { 'Accept' => CONTENT_TYPE, 'User-Agent' => "appium/ruby_lib/#{::Appium::VERSION}" }.freeze -- -##### [patch_remote_driver_commands](https://github.com/appium/ruby_lib/blob/c705d40f89117b7dea37ff6365c6d4f418e51ce9/lib/appium_lib/common/patch.rb#L155) +##### [patch_remote_driver_commands](https://github.com/appium/ruby_lib/blob/bc50f6f1315fb3238d9e7614cf2545d06d979ae7/lib/appium_lib/common/patch.rb#L165) > def patch_remote_driver_commands