docs/ios_docs.md in appium_lib-12.0.0.rc5 vs docs/ios_docs.md in appium_lib-12.0.0

- old
+ new

@@ -1,6 +1,6 @@ -##### [load_settings](https://github.com/appium/ruby_lib/blob/06f2e54b4b55df25e624272b5a2cd7b23a000298/lib/appium_lib/appium.rb#L60) common +##### [load_settings](https://github.com/appium/ruby_lib/blob/3060ef3bf06c19a79731a49985efa75c3337dd27/lib/appium_lib/appium.rb#L60) common > def load_settings(opts = {}) Load arbitrary text ([toml format](https://github.com/toml-lang/toml)) The toml is parsed by https://github.com/fbernier/tomlrb . @@ -25,11 +25,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[hash] the symbolized hash with updated :app and :require keys -- -##### [load_appium_txt](https://github.com/appium/ruby_lib/blob/06f2e54b4b55df25e624272b5a2cd7b23a000298/lib/appium_lib/appium.rb#L95) common +##### [load_appium_txt](https://github.com/appium/ruby_lib/blob/3060ef3bf06c19a79731a49985efa75c3337dd27/lib/appium_lib/appium.rb#L95) common > def load_settings(opts = {}) Load arbitrary text ([toml format](https://github.com/toml-lang/toml)) The toml is parsed by https://github.com/fbernier/tomlrb . @@ -54,11 +54,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[hash] the symbolized hash with updated :app and :require keys -- -##### [expand_required_files](https://github.com/appium/ruby_lib/blob/06f2e54b4b55df25e624272b5a2cd7b23a000298/lib/appium_lib/appium.rb#L100) common +##### [expand_required_files](https://github.com/appium/ruby_lib/blob/3060ef3bf06c19a79731a49985efa75c3337dd27/lib/appium_lib/appium.rb#L100) common > def expand_required_files(base_dir, file_paths) @@ -72,11 +72,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Array] list of require files as an array, nil if require doesn't exist -- -##### [promote_singleton_appium_methods](https://github.com/appium/ruby_lib/blob/06f2e54b4b55df25e624272b5a2cd7b23a000298/lib/appium_lib/appium.rb#L142) common +##### [promote_singleton_appium_methods](https://github.com/appium/ruby_lib/blob/3060ef3bf06c19a79731a49985efa75c3337dd27/lib/appium_lib/appium.rb#L142) common > def promote_singleton_appium_methods(modules, driver = $driver) This method is intended to work with page objects that share a common module. For example, Page::HomePage, Page::SignIn @@ -96,11 +96,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Driver] driver - A driver to extend for -- -##### [promote_appium_methods](https://github.com/appium/ruby_lib/blob/06f2e54b4b55df25e624272b5a2cd7b23a000298/lib/appium_lib/appium.rb#L198) common +##### [promote_appium_methods](https://github.com/appium/ruby_lib/blob/3060ef3bf06c19a79731a49985efa75c3337dd27/lib/appium_lib/appium.rb#L196) common > def promote_appium_methods(class_array, driver = $driver) Promote appium methods to class instance methods @@ -114,175 +114,175 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Driver] driver - A driver to extend for -- -##### [global_webdriver_http_sleep](https://github.com/appium/ruby_lib/blob/06f2e54b4b55df25e624272b5a2cd7b23a000298/lib/appium_lib/driver.rb#L49) common +##### [global_webdriver_http_sleep](https://github.com/appium/ruby_lib/blob/3060ef3bf06c19a79731a49985efa75c3337dd27/lib/appium_lib/driver.rb#L49) common > 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/06f2e54b4b55df25e624272b5a2cd7b23a000298/lib/appium_lib/driver.rb#L49) common +##### [global_webdriver_http_sleep=](https://github.com/appium/ruby_lib/blob/3060ef3bf06c19a79731a49985efa75c3337dd27/lib/appium_lib/driver.rb#L49) common > def global_webdriver_http_sleep=(value) The amount to sleep in seconds before every webdriver http call. -- -##### [sauce](https://github.com/appium/ruby_lib/blob/06f2e54b4b55df25e624272b5a2cd7b23a000298/lib/appium_lib/driver.rb#L52) common +##### [sauce](https://github.com/appium/ruby_lib/blob/3060ef3bf06c19a79731a49985efa75c3337dd27/lib/appium_lib/driver.rb#L52) common > def sauce SauceLab's settings -- -##### [sauce_username](https://github.com/appium/ruby_lib/blob/06f2e54b4b55df25e624272b5a2cd7b23a000298/lib/appium_lib/driver.rb#L55) common +##### [sauce_username](https://github.com/appium/ruby_lib/blob/3060ef3bf06c19a79731a49985efa75c3337dd27/lib/appium_lib/driver.rb#L55) common > def sauce_username Username for use on Sauce Labs. Set `false` to disable Sauce, even when SAUCE_USERNAME is in ENV. same as @sauce.username -- -##### [sauce_access_key](https://github.com/appium/ruby_lib/blob/06f2e54b4b55df25e624272b5a2cd7b23a000298/lib/appium_lib/driver.rb#L58) common +##### [sauce_access_key](https://github.com/appium/ruby_lib/blob/3060ef3bf06c19a79731a49985efa75c3337dd27/lib/appium_lib/driver.rb#L58) common > def sauce_access_key Access Key for use on Sauce Labs. Set `false` to disable Sauce, even when SAUCE_ACCESS_KEY is in ENV. same as @sauce.access_key -- -##### [sauce_endpoint](https://github.com/appium/ruby_lib/blob/06f2e54b4b55df25e624272b5a2cd7b23a000298/lib/appium_lib/driver.rb#L61) common +##### [sauce_endpoint](https://github.com/appium/ruby_lib/blob/3060ef3bf06c19a79731a49985efa75c3337dd27/lib/appium_lib/driver.rb#L61) common > def sauce_endpoint Override the Sauce Appium endpoint to allow e.g. TestObject tests same as @sauce.endpoint -- -##### [caps](https://github.com/appium/ruby_lib/blob/06f2e54b4b55df25e624272b5a2cd7b23a000298/lib/appium_lib/driver.rb#L65) common +##### [caps](https://github.com/appium/ruby_lib/blob/3060ef3bf06c19a79731a49985efa75c3337dd27/lib/appium_lib/driver.rb#L65) common > def caps from Core read http://www.rubydoc.info/github/appium/ruby_lib_core/Appium/Core/Driver -- -##### [custom_url](https://github.com/appium/ruby_lib/blob/06f2e54b4b55df25e624272b5a2cd7b23a000298/lib/appium_lib/driver.rb#L66) common +##### [custom_url](https://github.com/appium/ruby_lib/blob/3060ef3bf06c19a79731a49985efa75c3337dd27/lib/appium_lib/driver.rb#L66) common > def custom_url Returns the value of attribute custom_url. -- -##### [export_session](https://github.com/appium/ruby_lib/blob/06f2e54b4b55df25e624272b5a2cd7b23a000298/lib/appium_lib/driver.rb#L67) common +##### [export_session](https://github.com/appium/ruby_lib/blob/3060ef3bf06c19a79731a49985efa75c3337dd27/lib/appium_lib/driver.rb#L67) common > def export_session Returns the value of attribute export_session. -- -##### [export_session_path](https://github.com/appium/ruby_lib/blob/06f2e54b4b55df25e624272b5a2cd7b23a000298/lib/appium_lib/driver.rb#L68) common +##### [export_session_path](https://github.com/appium/ruby_lib/blob/3060ef3bf06c19a79731a49985efa75c3337dd27/lib/appium_lib/driver.rb#L68) common > def export_session_path Returns the value of attribute export_session_path. -- -##### [default_wait](https://github.com/appium/ruby_lib/blob/06f2e54b4b55df25e624272b5a2cd7b23a000298/lib/appium_lib/driver.rb#L69) common +##### [default_wait](https://github.com/appium/ruby_lib/blob/3060ef3bf06c19a79731a49985efa75c3337dd27/lib/appium_lib/driver.rb#L69) common > def default_wait Returns the value of attribute default_wait. -- -##### [appium_port](https://github.com/appium/ruby_lib/blob/06f2e54b4b55df25e624272b5a2cd7b23a000298/lib/appium_lib/driver.rb#L70) common +##### [appium_port](https://github.com/appium/ruby_lib/blob/3060ef3bf06c19a79731a49985efa75c3337dd27/lib/appium_lib/driver.rb#L70) common > def appium_port Returns the value of attribute appium_port. -- -##### [appium_device](https://github.com/appium/ruby_lib/blob/06f2e54b4b55df25e624272b5a2cd7b23a000298/lib/appium_lib/driver.rb#L71) common +##### [appium_device](https://github.com/appium/ruby_lib/blob/3060ef3bf06c19a79731a49985efa75c3337dd27/lib/appium_lib/driver.rb#L71) common > def appium_device Returns the value of attribute appium_device. -- -##### [automation_name](https://github.com/appium/ruby_lib/blob/06f2e54b4b55df25e624272b5a2cd7b23a000298/lib/appium_lib/driver.rb#L72) common +##### [automation_name](https://github.com/appium/ruby_lib/blob/3060ef3bf06c19a79731a49985efa75c3337dd27/lib/appium_lib/driver.rb#L72) common > def automation_name Returns the value of attribute automation_name. -- -##### [listener](https://github.com/appium/ruby_lib/blob/06f2e54b4b55df25e624272b5a2cd7b23a000298/lib/appium_lib/driver.rb#L73) common +##### [listener](https://github.com/appium/ruby_lib/blob/3060ef3bf06c19a79731a49985efa75c3337dd27/lib/appium_lib/driver.rb#L73) common > def listener Returns the value of attribute listener. -- -##### [http_client](https://github.com/appium/ruby_lib/blob/06f2e54b4b55df25e624272b5a2cd7b23a000298/lib/appium_lib/driver.rb#L74) common +##### [http_client](https://github.com/appium/ruby_lib/blob/3060ef3bf06c19a79731a49985efa75c3337dd27/lib/appium_lib/driver.rb#L74) common > def http_client Returns the value of attribute http_client. -- -##### [appium_wait_timeout](https://github.com/appium/ruby_lib/blob/06f2e54b4b55df25e624272b5a2cd7b23a000298/lib/appium_lib/driver.rb#L75) common +##### [appium_wait_timeout](https://github.com/appium/ruby_lib/blob/3060ef3bf06c19a79731a49985efa75c3337dd27/lib/appium_lib/driver.rb#L75) common > def appium_wait_timeout Returns the value of attribute appium_wait_timeout. -- -##### [appium_wait_interval](https://github.com/appium/ruby_lib/blob/06f2e54b4b55df25e624272b5a2cd7b23a000298/lib/appium_lib/driver.rb#L76) common +##### [appium_wait_interval](https://github.com/appium/ruby_lib/blob/3060ef3bf06c19a79731a49985efa75c3337dd27/lib/appium_lib/driver.rb#L76) common > def appium_wait_interval Returns the value of attribute appium_wait_interval. -- -##### [appium_server_status](https://github.com/appium/ruby_lib/blob/06f2e54b4b55df25e624272b5a2cd7b23a000298/lib/appium_lib/driver.rb#L79) common +##### [appium_server_status](https://github.com/appium/ruby_lib/blob/3060ef3bf06c19a79731a49985efa75c3337dd27/lib/appium_lib/driver.rb#L79) common > def appium_server_status Appium's server version -- -##### [appium_debug](https://github.com/appium/ruby_lib/blob/06f2e54b4b55df25e624272b5a2cd7b23a000298/lib/appium_lib/driver.rb#L81) common +##### [appium_debug](https://github.com/appium/ruby_lib/blob/3060ef3bf06c19a79731a49985efa75c3337dd27/lib/appium_lib/driver.rb#L81) common > def appium_debug Boolean debug mode for the Appium Ruby bindings -- -##### [driver](https://github.com/appium/ruby_lib/blob/06f2e54b4b55df25e624272b5a2cd7b23a000298/lib/appium_lib/driver.rb#L84) common +##### [driver](https://github.com/appium/ruby_lib/blob/3060ef3bf06c19a79731a49985efa75c3337dd27/lib/appium_lib/driver.rb#L84) common > def driver Returns the driver @@ -290,21 +290,21 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Driver] the driver -- -##### [core](https://github.com/appium/ruby_lib/blob/06f2e54b4b55df25e624272b5a2cd7b23a000298/lib/appium_lib/driver.rb#L86) common +##### [core](https://github.com/appium/ruby_lib/blob/3060ef3bf06c19a79731a49985efa75c3337dd27/lib/appium_lib/driver.rb#L86) common > def core Instance of Appium::Core::Driver -- -##### [initialize](https://github.com/appium/ruby_lib/blob/06f2e54b4b55df25e624272b5a2cd7b23a000298/lib/appium_lib/driver.rb#L154) common +##### [initialize](https://github.com/appium/ruby_lib/blob/3060ef3bf06c19a79731a49985efa75c3337dd27/lib/appium_lib/driver.rb#L154) common -> def initialize(opts = {}, global_driver = nil) +> def initialize(opts = {}, global_driver = false) Creates a new driver. The driver is defined as global scope by default. We can avoid defining global driver. __Parameters:__ @@ -317,19 +317,19 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Driver] -- -##### [driver_attributes](https://github.com/appium/ruby_lib/blob/06f2e54b4b55df25e624272b5a2cd7b23a000298/lib/appium_lib/driver.rb#L278) common +##### [driver_attributes](https://github.com/appium/ruby_lib/blob/3060ef3bf06c19a79731a49985efa75c3337dd27/lib/appium_lib/driver.rb#L270) common > def driver_attributes Returns a hash of the driver attributes -- -##### [device_is_android?](https://github.com/appium/ruby_lib/blob/06f2e54b4b55df25e624272b5a2cd7b23a000298/lib/appium_lib/driver.rb#L298) common +##### [device_is_android?](https://github.com/appium/ruby_lib/blob/3060ef3bf06c19a79731a49985efa75c3337dd27/lib/appium_lib/driver.rb#L290) common > def device_is_android? @@ -337,11 +337,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Boolean] -- -##### [device_is_ios?](https://github.com/appium/ruby_lib/blob/06f2e54b4b55df25e624272b5a2cd7b23a000298/lib/appium_lib/driver.rb#L302) common +##### [device_is_ios?](https://github.com/appium/ruby_lib/blob/3060ef3bf06c19a79731a49985efa75c3337dd27/lib/appium_lib/driver.rb#L294) common > def device_is_ios? @@ -349,11 +349,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Boolean] -- -##### [device_is_windows?](https://github.com/appium/ruby_lib/blob/06f2e54b4b55df25e624272b5a2cd7b23a000298/lib/appium_lib/driver.rb#L306) common +##### [device_is_windows?](https://github.com/appium/ruby_lib/blob/3060ef3bf06c19a79731a49985efa75c3337dd27/lib/appium_lib/driver.rb#L298) common > def device_is_windows? @@ -361,11 +361,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Boolean] -- -##### [automation_name_is_uiautomator2?](https://github.com/appium/ruby_lib/blob/06f2e54b4b55df25e624272b5a2cd7b23a000298/lib/appium_lib/driver.rb#L312) common +##### [automation_name_is_uiautomator2?](https://github.com/appium/ruby_lib/blob/3060ef3bf06c19a79731a49985efa75c3337dd27/lib/appium_lib/driver.rb#L304) common > def automation_name_is_uiautomator2? Return true if automationName is 'uiautomator2' @@ -373,11 +373,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Boolean] -- -##### [automation_name_is_espresso?](https://github.com/appium/ruby_lib/blob/06f2e54b4b55df25e624272b5a2cd7b23a000298/lib/appium_lib/driver.rb#L318) common +##### [automation_name_is_espresso?](https://github.com/appium/ruby_lib/blob/3060ef3bf06c19a79731a49985efa75c3337dd27/lib/appium_lib/driver.rb#L310) common > def automation_name_is_espresso? Return true if automationName is 'Espresso' @@ -385,11 +385,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Boolean] -- -##### [automation_name_is_xcuitest?](https://github.com/appium/ruby_lib/blob/06f2e54b4b55df25e624272b5a2cd7b23a000298/lib/appium_lib/driver.rb#L324) common +##### [automation_name_is_xcuitest?](https://github.com/appium/ruby_lib/blob/3060ef3bf06c19a79731a49985efa75c3337dd27/lib/appium_lib/driver.rb#L316) common > def automation_name_is_xcuitest? Return true if automationName is 'XCUITest' @@ -397,46 +397,24 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Boolean] -- -##### [dialect](https://github.com/appium/ruby_lib/blob/06f2e54b4b55df25e624272b5a2cd7b23a000298/lib/appium_lib/driver.rb#L344) common +##### [action](https://github.com/appium/ruby_lib/blob/3060ef3bf06c19a79731a49985efa75c3337dd27/lib/appium_lib/driver.rb#L330) common -> def dialect - -Get the dialect value whether current driver is OSS or W3C - -__Returns:__ - -&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[:oss | :w3c] @example - - if dialect == :w3c - driver.action - .move_to_location(500, 500).pointer_down(:left) - .move_to_location(0, 700) - .release.perform - else - action = TouchAction.new(driver).press(x: 500, y: 500).move_to(500, 700).release - action.perform - end - --- - -##### [action](https://github.com/appium/ruby_lib/blob/06f2e54b4b55df25e624272b5a2cd7b23a000298/lib/appium_lib/driver.rb#L358) common - > def action -An entry point to chain W3C actions. Returns `TouchAction.new` if it works as MJSONWP instead of W3C action. +An entry point to chain W3C actions Read https://www.rubydoc.info/github/appium/ruby_lib_core/Appium/Core/Base/Bridge/W3C#action-instance_method __Returns:__ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[TouchAction|Selenium::WebDriver::PointerActions] -- -##### [appium_server_version](https://github.com/appium/ruby_lib/blob/06f2e54b4b55df25e624272b5a2cd7b23a000298/lib/appium_lib/driver.rb#L378) common +##### [appium_server_version](https://github.com/appium/ruby_lib/blob/3060ef3bf06c19a79731a49985efa75c3337dd27/lib/appium_lib/driver.rb#L345) common > def appium_server_version Returns the server's version info @@ -444,11 +422,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Hash] -- -##### [remote_status](https://github.com/appium/ruby_lib/blob/06f2e54b4b55df25e624272b5a2cd7b23a000298/lib/appium_lib/driver.rb#L386) common +##### [remote_status](https://github.com/appium/ruby_lib/blob/3060ef3bf06c19a79731a49985efa75c3337dd27/lib/appium_lib/driver.rb#L353) common > def appium_server_version Returns the server's version info @@ -456,11 +434,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Hash] -- -##### [platform_version](https://github.com/appium/ruby_lib/blob/06f2e54b4b55df25e624272b5a2cd7b23a000298/lib/appium_lib/driver.rb#L390) common +##### [platform_version](https://github.com/appium/ruby_lib/blob/3060ef3bf06c19a79731a49985efa75c3337dd27/lib/appium_lib/driver.rb#L357) common > def platform_version Return the platform version as an array of integers @@ -468,11 +446,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Array<Integer>] -- -##### [appium_client_version](https://github.com/appium/ruby_lib/blob/06f2e54b4b55df25e624272b5a2cd7b23a000298/lib/appium_lib/driver.rb#L403) common +##### [appium_client_version](https://github.com/appium/ruby_lib/blob/3060ef3bf06c19a79731a49985efa75c3337dd27/lib/appium_lib/driver.rb#L370) common > def appium_client_version Returns the client's version info @@ -480,11 +458,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Hash] -- -##### [absolute_app_path](https://github.com/appium/ruby_lib/blob/06f2e54b4b55df25e624272b5a2cd7b23a000298/lib/appium_lib/driver.rb#L415) common +##### [absolute_app_path](https://github.com/appium/ruby_lib/blob/3060ef3bf06c19a79731a49985efa75c3337dd27/lib/appium_lib/driver.rb#L382) common > def absolute_app_path(opts) Converts app_path to an absolute path. @@ -497,11 +475,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[String] APP_PATH as an absolute path -- -##### [server_url](https://github.com/appium/ruby_lib/blob/06f2e54b4b55df25e624272b5a2cd7b23a000298/lib/appium_lib/driver.rb#L436) common +##### [server_url](https://github.com/appium/ruby_lib/blob/3060ef3bf06c19a79731a49985efa75c3337dd27/lib/appium_lib/driver.rb#L403) common > def server_url Get the server url @@ -509,11 +487,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[String] the server url -- -##### [restart](https://github.com/appium/ruby_lib/blob/06f2e54b4b55df25e624272b5a2cd7b23a000298/lib/appium_lib/driver.rb#L445) common +##### [restart](https://github.com/appium/ruby_lib/blob/3060ef3bf06c19a79731a49985efa75c3337dd27/lib/appium_lib/driver.rb#L412) common > def restart Restarts the driver @@ -521,11 +499,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Driver] the driver -- -##### [screenshot](https://github.com/appium/ruby_lib/blob/06f2e54b4b55df25e624272b5a2cd7b23a000298/lib/appium_lib/driver.rb#L458) common +##### [screenshot](https://github.com/appium/ruby_lib/blob/3060ef3bf06c19a79731a49985efa75c3337dd27/lib/appium_lib/driver.rb#L425) common > def screenshot(png_save_path) Takes a png screenshot and saves to the target path. @@ -537,11 +515,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[File] -- -##### [element_screenshot](https://github.com/appium/ruby_lib/blob/06f2e54b4b55df25e624272b5a2cd7b23a000298/lib/appium_lib/driver.rb#L472) common +##### [element_screenshot](https://github.com/appium/ruby_lib/blob/3060ef3bf06c19a79731a49985efa75c3337dd27/lib/appium_lib/driver.rb#L439) common > def element_screenshot(element, png_save_path) Takes a png screenshot of particular element's area @@ -555,11 +533,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[File] -- -##### [driver_quit](https://github.com/appium/ruby_lib/blob/06f2e54b4b55df25e624272b5a2cd7b23a000298/lib/appium_lib/driver.rb#L479) common +##### [driver_quit](https://github.com/appium/ruby_lib/blob/3060ef3bf06c19a79731a49985efa75c3337dd27/lib/appium_lib/driver.rb#L446) common > def driver_quit Quits the driver @@ -567,11 +545,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[void] -- -##### [quit_driver](https://github.com/appium/ruby_lib/blob/06f2e54b4b55df25e624272b5a2cd7b23a000298/lib/appium_lib/driver.rb#L482) common +##### [quit_driver](https://github.com/appium/ruby_lib/blob/3060ef3bf06c19a79731a49985efa75c3337dd27/lib/appium_lib/driver.rb#L449) common > def driver_quit Quits the driver @@ -579,11 +557,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[void] -- -##### [window_size](https://github.com/appium/ruby_lib/blob/06f2e54b4b55df25e624272b5a2cd7b23a000298/lib/appium_lib/driver.rb#L493) common +##### [window_size](https://github.com/appium/ruby_lib/blob/3060ef3bf06c19a79731a49985efa75c3337dd27/lib/appium_lib/driver.rb#L460) common > def window_size Get the device window's size. @@ -591,11 +569,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Selenium::WebDriver::Dimension] -- -##### [window_rect](https://github.com/appium/ruby_lib/blob/06f2e54b4b55df25e624272b5a2cd7b23a000298/lib/appium_lib/driver.rb#L508) common +##### [window_rect](https://github.com/appium/ruby_lib/blob/3060ef3bf06c19a79731a49985efa75c3337dd27/lib/appium_lib/driver.rb#L475) common > def window_rect Get the device window's rect. @@ -603,11 +581,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Selenium::WebDriver::Rectangle] -- -##### [start_driver](https://github.com/appium/ruby_lib/blob/06f2e54b4b55df25e624272b5a2cd7b23a000298/lib/appium_lib/driver.rb#L541) common +##### [start_driver](https://github.com/appium/ruby_lib/blob/3060ef3bf06c19a79731a49985efa75c3337dd27/lib/appium_lib/driver.rb#L508) common > def start_driver(http_client_ops = { http_client: ::Appium::Http::Default.new, open_timeout: 999_999, read_timeout: 999_999 }) Creates a new global driver and quits the old one if it exists. You can customise http_client as the following @@ -623,27 +601,27 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Selenium::WebDriver] the new global driver -- -##### [set_implicit_wait](https://github.com/appium/ruby_lib/blob/06f2e54b4b55df25e624272b5a2cd7b23a000298/lib/appium_lib/driver.rb#L562) common +##### [set_implicit_wait](https://github.com/appium/ruby_lib/blob/3060ef3bf06c19a79731a49985efa75c3337dd27/lib/appium_lib/driver.rb#L529) common > def set_implicit_wait(wait) To ignore error for Espresso Driver -- -##### [no_wait](https://github.com/appium/ruby_lib/blob/06f2e54b4b55df25e624272b5a2cd7b23a000298/lib/appium_lib/driver.rb#L573) common +##### [no_wait](https://github.com/appium/ruby_lib/blob/3060ef3bf06c19a79731a49985efa75c3337dd27/lib/appium_lib/driver.rb#L540) common > def no_wait Set implicit wait to zero. -- -##### [set_wait](https://github.com/appium/ruby_lib/blob/06f2e54b4b55df25e624272b5a2cd7b23a000298/lib/appium_lib/driver.rb#L587) common +##### [set_wait](https://github.com/appium/ruby_lib/blob/3060ef3bf06c19a79731a49985efa75c3337dd27/lib/appium_lib/driver.rb#L554) common > def set_wait(timeout = nil) Set implicit wait. Default to @core.default_wait. @@ -655,11 +633,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[void] -- -##### [exists](https://github.com/appium/ruby_lib/blob/06f2e54b4b55df25e624272b5a2cd7b23a000298/lib/appium_lib/driver.rb#L604) common +##### [exists](https://github.com/appium/ruby_lib/blob/3060ef3bf06c19a79731a49985efa75c3337dd27/lib/appium_lib/driver.rb#L571) common > def exists(pre_check = 0, post_check = @core.default_wait) Returns existence of element. @@ -679,11 +657,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Boolean] -- -##### [execute_script](https://github.com/appium/ruby_lib/blob/06f2e54b4b55df25e624272b5a2cd7b23a000298/lib/appium_lib/driver.rb#L628) common +##### [execute_script](https://github.com/appium/ruby_lib/blob/3060ef3bf06c19a79731a49985efa75c3337dd27/lib/appium_lib/driver.rb#L595) common > def execute_script(script, *args) The same as @driver.execute_script @@ -697,21 +675,21 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Object] -- -##### [execute_async_script](https://github.com/appium/ruby_lib/blob/06f2e54b4b55df25e624272b5a2cd7b23a000298/lib/appium_lib/driver.rb#L636) common +##### [execute_async_script](https://github.com/appium/ruby_lib/blob/3060ef3bf06c19a79731a49985efa75c3337dd27/lib/appium_lib/driver.rb#L603) common > def execute_async_script(script, *args) Wrap calling selenium webdrier APIs via ruby_core Get the window handles of open browser windows -- -##### [execute_driver](https://github.com/appium/ruby_lib/blob/06f2e54b4b55df25e624272b5a2cd7b23a000298/lib/appium_lib/driver.rb#L668) common +##### [execute_driver](https://github.com/appium/ruby_lib/blob/3060ef3bf06c19a79731a49985efa75c3337dd27/lib/appium_lib/driver.rb#L635) common > def execute_driver(script: '', type: 'webdriverio', timeout_ms: nil) Run a set of script against the current session, allowing execution of many commands in one Appium request. Supports {https://webdriver.io/docs/api.html WebdriverIO} API so far. @@ -733,67 +711,67 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Appium::Core::Base::Device::ExecuteDriver::Result] The script result parsed by Appium::Core::Base::Device::ExecuteDriver::Result. -- -##### [window_handles](https://github.com/appium/ruby_lib/blob/06f2e54b4b55df25e624272b5a2cd7b23a000298/lib/appium_lib/driver.rb#L672) common +##### [window_handles](https://github.com/appium/ruby_lib/blob/3060ef3bf06c19a79731a49985efa75c3337dd27/lib/appium_lib/driver.rb#L639) common > def window_handles -- -##### [window_handle](https://github.com/appium/ruby_lib/blob/06f2e54b4b55df25e624272b5a2cd7b23a000298/lib/appium_lib/driver.rb#L677) common +##### [window_handle](https://github.com/appium/ruby_lib/blob/3060ef3bf06c19a79731a49985efa75c3337dd27/lib/appium_lib/driver.rb#L644) common > def window_handle Get the current window handle -- -##### [navigate](https://github.com/appium/ruby_lib/blob/06f2e54b4b55df25e624272b5a2cd7b23a000298/lib/appium_lib/driver.rb#L681) common +##### [navigate](https://github.com/appium/ruby_lib/blob/3060ef3bf06c19a79731a49985efa75c3337dd27/lib/appium_lib/driver.rb#L648) common > def navigate -- -##### [manage](https://github.com/appium/ruby_lib/blob/06f2e54b4b55df25e624272b5a2cd7b23a000298/lib/appium_lib/driver.rb#L685) common +##### [manage](https://github.com/appium/ruby_lib/blob/3060ef3bf06c19a79731a49985efa75c3337dd27/lib/appium_lib/driver.rb#L652) common > def manage -- -##### [get](https://github.com/appium/ruby_lib/blob/06f2e54b4b55df25e624272b5a2cd7b23a000298/lib/appium_lib/driver.rb#L689) common +##### [get](https://github.com/appium/ruby_lib/blob/3060ef3bf06c19a79731a49985efa75c3337dd27/lib/appium_lib/driver.rb#L656) common > def get(url) -- -##### [current_url](https://github.com/appium/ruby_lib/blob/06f2e54b4b55df25e624272b5a2cd7b23a000298/lib/appium_lib/driver.rb#L693) common +##### [current_url](https://github.com/appium/ruby_lib/blob/3060ef3bf06c19a79731a49985efa75c3337dd27/lib/appium_lib/driver.rb#L660) common > def current_url -- -##### [title](https://github.com/appium/ruby_lib/blob/06f2e54b4b55df25e624272b5a2cd7b23a000298/lib/appium_lib/driver.rb#L697) common +##### [title](https://github.com/appium/ruby_lib/blob/3060ef3bf06c19a79731a49985efa75c3337dd27/lib/appium_lib/driver.rb#L664) common > def title -- -##### [switch_to](https://github.com/appium/ruby_lib/blob/06f2e54b4b55df25e624272b5a2cd7b23a000298/lib/appium_lib/driver.rb#L703) common +##### [switch_to](https://github.com/appium/ruby_lib/blob/3060ef3bf06c19a79731a49985efa75c3337dd27/lib/appium_lib/driver.rb#L670) common > def switch_to @@ -801,11 +779,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[TargetLocator] -- -##### [find_elements](https://github.com/appium/ruby_lib/blob/06f2e54b4b55df25e624272b5a2cd7b23a000298/lib/appium_lib/driver.rb#L730) common +##### [find_elements](https://github.com/appium/ruby_lib/blob/3060ef3bf06c19a79731a49985efa75c3337dd27/lib/appium_lib/driver.rb#L697) common > def find_elements(*args) Calls @driver.find_elements_with_appium @@ -821,11 +799,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/06f2e54b4b55df25e624272b5a2cd7b23a000298/lib/appium_lib/driver.rb#L746) common +##### [find_element](https://github.com/appium/ruby_lib/blob/3060ef3bf06c19a79731a49985efa75c3337dd27/lib/appium_lib/driver.rb#L713) common > def find_element(*args) Calls @driver.find_element @@ -839,11 +817,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Element] -- -##### [find_element_by_image](https://github.com/appium/ruby_lib/blob/06f2e54b4b55df25e624272b5a2cd7b23a000298/lib/appium_lib/driver.rb#L761) common +##### [find_element_by_image](https://github.com/appium/ruby_lib/blob/3060ef3bf06c19a79731a49985efa75c3337dd27/lib/appium_lib/driver.rb#L728) common > def find_element_by_image(png_img_path) Return ImageElement if current view has a partial image @@ -855,11 +833,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[::Appium::Core::ImageElement] -- -##### [find_elements_by_image](https://github.com/appium/ruby_lib/blob/06f2e54b4b55df25e624272b5a2cd7b23a000298/lib/appium_lib/driver.rb#L776) common +##### [find_elements_by_image](https://github.com/appium/ruby_lib/blob/3060ef3bf06c19a79731a49985efa75c3337dd27/lib/appium_lib/driver.rb#L743) common > def find_elements_by_image(png_img_paths) Return ImageElement if current view has partial images @@ -871,11 +849,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[[::Appium::Core::ImageElement]] -- -##### [set_location](https://github.com/appium/ruby_lib/blob/06f2e54b4b55df25e624272b5a2cd7b23a000298/lib/appium_lib/driver.rb#L789) common +##### [set_location](https://github.com/appium/ruby_lib/blob/3060ef3bf06c19a79731a49985efa75c3337dd27/lib/appium_lib/driver.rb#L756) common > def set_location(opts = {}) Calls @driver.set_location @@ -887,11 +865,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Selenium::WebDriver::Location] the location constructed by the selenium webdriver -- -##### [log_event](https://github.com/appium/ruby_lib/blob/06f2e54b4b55df25e624272b5a2cd7b23a000298/lib/appium_lib/driver.rb#L813) common +##### [log_event](https://github.com/appium/ruby_lib/blob/3060ef3bf06c19a79731a49985efa75c3337dd27/lib/appium_lib/driver.rb#L780) common > def log_event(vendor:, event:) Logs a custom event. The event is available via {::Appium::Core::Events#get} or <code>driver.session_capabilities['events']</code> with <code>eventTimings</code> capabilities. @@ -906,19 +884,19 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[nil] -- -##### [log_event=](https://github.com/appium/ruby_lib/blob/06f2e54b4b55df25e624272b5a2cd7b23a000298/lib/appium_lib/driver.rb#L817) common +##### [log_event=](https://github.com/appium/ruby_lib/blob/3060ef3bf06c19a79731a49985efa75c3337dd27/lib/appium_lib/driver.rb#L784) common > def log_event=(log_event) -- -##### [log_events](https://github.com/appium/ruby_lib/blob/06f2e54b4b55df25e624272b5a2cd7b23a000298/lib/appium_lib/driver.rb#L834) common +##### [log_events](https://github.com/appium/ruby_lib/blob/3060ef3bf06c19a79731a49985efa75c3337dd27/lib/appium_lib/driver.rb#L803) common > def log_events(type = nil) Returns events with filtering with 'type'. Defaults to all available events. @@ -930,11 +908,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Hash] -- -##### [x](https://github.com/appium/ruby_lib/blob/06f2e54b4b55df25e624272b5a2cd7b23a000298/lib/appium_lib/driver.rb#L841) common +##### [x](https://github.com/appium/ruby_lib/blob/3060ef3bf06c19a79731a49985efa75c3337dd27/lib/appium_lib/driver.rb#L810) common > def x Quit the driver and Pry. quit and exit are reserved by Pry. @@ -943,35 +921,35 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[void] -- -##### [username](https://github.com/appium/ruby_lib/blob/06f2e54b4b55df25e624272b5a2cd7b23a000298/lib/appium_lib/sauce_labs.rb#L18) common +##### [username](https://github.com/appium/ruby_lib/blob/3060ef3bf06c19a79731a49985efa75c3337dd27/lib/appium_lib/sauce_labs.rb#L18) common > def username Username for use on Sauce Labs. Set `false` to disable Sauce, even when SAUCE_USERNAME is in ENV. -- -##### [access_key](https://github.com/appium/ruby_lib/blob/06f2e54b4b55df25e624272b5a2cd7b23a000298/lib/appium_lib/sauce_labs.rb#L20) common +##### [access_key](https://github.com/appium/ruby_lib/blob/3060ef3bf06c19a79731a49985efa75c3337dd27/lib/appium_lib/sauce_labs.rb#L20) common > def access_key Access Key for use on Sauce Labs. Set `false` to disable Sauce, even when SAUCE_ACCESS_KEY is in ENV. -- -##### [endpoint](https://github.com/appium/ruby_lib/blob/06f2e54b4b55df25e624272b5a2cd7b23a000298/lib/appium_lib/sauce_labs.rb#L22) common +##### [endpoint](https://github.com/appium/ruby_lib/blob/3060ef3bf06c19a79731a49985efa75c3337dd27/lib/appium_lib/sauce_labs.rb#L22) common > def endpoint Override the Sauce Appium endpoint to allow e.g. TestObject tests. Default is 'ondemand.saucelabs.com:443/wd/hub'. -- -##### [initialize](https://github.com/appium/ruby_lib/blob/06f2e54b4b55df25e624272b5a2cd7b23a000298/lib/appium_lib/sauce_labs.rb#L47) common +##### [initialize](https://github.com/appium/ruby_lib/blob/3060ef3bf06c19a79731a49985efa75c3337dd27/lib/appium_lib/sauce_labs.rb#L47) common > def initialize(appium_lib_opts) Create a SauceLabs instance to manage sauce labs related attributes. @@ -983,11 +961,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Appium::SauceLabs] -- -##### [sauce_server_url?](https://github.com/appium/ruby_lib/blob/06f2e54b4b55df25e624272b5a2cd7b23a000298/lib/appium_lib/sauce_labs.rb#L67) common +##### [sauce_server_url?](https://github.com/appium/ruby_lib/blob/3060ef3bf06c19a79731a49985efa75c3337dd27/lib/appium_lib/sauce_labs.rb#L67) common > def sauce_server_url? Return true if an instance of Appium::SauceLabs has sauce_username and sauce_access_key. @@ -995,11 +973,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Boolean] -- -##### [server_url](https://github.com/appium/ruby_lib/blob/06f2e54b4b55df25e624272b5a2cd7b23a000298/lib/appium_lib/sauce_labs.rb#L80) common +##### [server_url](https://github.com/appium/ruby_lib/blob/3060ef3bf06c19a79731a49985efa75c3337dd27/lib/appium_lib/sauce_labs.rb#L80) common > def server_url Return a particular server url to access to. Default is the local address. @@ -1007,11 +985,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[String] -- -##### [get_log](https://github.com/appium/ruby_lib/blob/06f2e54b4b55df25e624272b5a2cd7b23a000298/lib/appium_lib/common/log.rb#L25) common +##### [get_log](https://github.com/appium/ruby_lib/blob/3060ef3bf06c19a79731a49985efa75c3337dd27/lib/appium_lib/common/log.rb#L25) common > def get_log(type) @@ -1023,11 +1001,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[[Selenium::WebDriver::LogEntry]] A list of logs data. -- -##### [get_available_log_types](https://github.com/appium/ruby_lib/blob/06f2e54b4b55df25e624272b5a2cd7b23a000298/lib/appium_lib/common/log.rb#L37) common +##### [get_available_log_types](https://github.com/appium/ruby_lib/blob/3060ef3bf06c19a79731a49985efa75c3337dd27/lib/appium_lib/common/log.rb#L37) common > def get_available_log_types Get a list of available log types @@ -1035,11 +1013,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[[String]] A list of available log types. -- -##### [wait_true](https://github.com/appium/ruby_lib/blob/06f2e54b4b55df25e624272b5a2cd7b23a000298/lib/appium_lib/common/wait.rb#L44) common +##### [wait_true](https://github.com/appium/ruby_lib/blob/3060ef3bf06c19a79731a49985efa75c3337dd27/lib/appium_lib/common/wait.rb#L44) common > 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. @@ -1055,11 +1033,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Hash|Numeric] opts - Options. If the value is _Numeric_, the value is set as `{ timeout: value }` -- -##### [wait](https://github.com/appium/ruby_lib/blob/06f2e54b4b55df25e624272b5a2cd7b23a000298/lib/appium_lib/common/wait.rb#L73) common +##### [wait](https://github.com/appium/ruby_lib/blob/3060ef3bf06c19a79731a49985efa75c3337dd27/lib/appium_lib/common/wait.rb#L73) common > def wait(opts = {}) Check every interval seconds to see if yield doesn't raise an exception. Give up after timeout seconds. @@ -1073,35 +1051,35 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Hash|Numeric] opts - Options. If the value is _Numeric_, the value is set as `{ timeout: value }` -- -##### [add_touch_actions](https://github.com/appium/ruby_lib/blob/06f2e54b4b55df25e624272b5a2cd7b23a000298/lib/appium_lib/common/device.rb#L26) common +##### [add_touch_actions](https://github.com/appium/ruby_lib/blob/3060ef3bf06c19a79731a49985efa75c3337dd27/lib/appium_lib/common/device.rb#L26) common > def add_touch_actions -- -##### [delegate_from_appium_driver](https://github.com/appium/ruby_lib/blob/06f2e54b4b55df25e624272b5a2cd7b23a000298/lib/appium_lib/common/device.rb#L38) common +##### [delegate_from_appium_driver](https://github.com/appium/ruby_lib/blob/3060ef3bf06c19a79731a49985efa75c3337dd27/lib/appium_lib/common/device.rb#L38) common > def delegate_from_appium_driver(method, delegation_target) -- -##### [ignore](https://github.com/appium/ruby_lib/blob/06f2e54b4b55df25e624272b5a2cd7b23a000298/lib/appium_lib/common/helper.rb#L30) common +##### [ignore](https://github.com/appium/ruby_lib/blob/3060ef3bf06c19a79731a49985efa75c3337dd27/lib/appium_lib/common/helper.rb#L30) common > def ignore Return yield and ignore any exceptions. -- -##### [back](https://github.com/appium/ruby_lib/blob/06f2e54b4b55df25e624272b5a2cd7b23a000298/lib/appium_lib/common/helper.rb#L38) common +##### [back](https://github.com/appium/ruby_lib/blob/3060ef3bf06c19a79731a49985efa75c3337dd27/lib/appium_lib/common/helper.rb#L38) common > def back Navigate back. @@ -1109,11 +1087,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[void] -- -##### [session_id](https://github.com/appium/ruby_lib/blob/06f2e54b4b55df25e624272b5a2cd7b23a000298/lib/appium_lib/common/helper.rb#L49) common +##### [session_id](https://github.com/appium/ruby_lib/blob/3060ef3bf06c19a79731a49985efa75c3337dd27/lib/appium_lib/common/helper.rb#L49) common > def session_id For Sauce Labs reporting. Returns the current session id. @@ -1121,11 +1099,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[String] -- -##### [xpath](https://github.com/appium/ruby_lib/blob/06f2e54b4b55df25e624272b5a2cd7b23a000298/lib/appium_lib/common/helper.rb#L57) common +##### [xpath](https://github.com/appium/ruby_lib/blob/3060ef3bf06c19a79731a49985efa75c3337dd27/lib/appium_lib/common/helper.rb#L57) common > def xpath(xpath_str) Returns the first element that matches the provided xpath. @@ -1137,11 +1115,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Element] -- -##### [xpaths](https://github.com/appium/ruby_lib/blob/06f2e54b4b55df25e624272b5a2cd7b23a000298/lib/appium_lib/common/helper.rb#L65) common +##### [xpaths](https://github.com/appium/ruby_lib/blob/3060ef3bf06c19a79731a49985efa75c3337dd27/lib/appium_lib/common/helper.rb#L65) common > def xpaths(xpath_str) Returns all elements that match the provided xpath. @@ -1153,19 +1131,19 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Array<Element>] -- -##### [result](https://github.com/appium/ruby_lib/blob/06f2e54b4b55df25e624272b5a2cd7b23a000298/lib/appium_lib/common/helper.rb#L75) common +##### [result](https://github.com/appium/ruby_lib/blob/3060ef3bf06c19a79731a49985efa75c3337dd27/lib/appium_lib/common/helper.rb#L75) common > def result Returns the value of attribute result. -- -##### [initialize](https://github.com/appium/ruby_lib/blob/06f2e54b4b55df25e624272b5a2cd7b23a000298/lib/appium_lib/common/helper.rb#L77) common +##### [initialize](https://github.com/appium/ruby_lib/blob/3060ef3bf06c19a79731a49985efa75c3337dd27/lib/appium_lib/common/helper.rb#L77) common > def initialize(platform) rubocop:disable Lint/MissingSuper @@ -1173,35 +1151,35 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[CountElements] a new instance of CountElements -- -##### [reset](https://github.com/appium/ruby_lib/blob/06f2e54b4b55df25e624272b5a2cd7b23a000298/lib/appium_lib/common/helper.rb#L82) common +##### [reset](https://github.com/appium/ruby_lib/blob/3060ef3bf06c19a79731a49985efa75c3337dd27/lib/appium_lib/common/helper.rb#L82) common > def reset -- -##### [start_element](https://github.com/appium/ruby_lib/blob/06f2e54b4b55df25e624272b5a2cd7b23a000298/lib/appium_lib/common/helper.rb#L87) common +##### [start_element](https://github.com/appium/ruby_lib/blob/3060ef3bf06c19a79731a49985efa75c3337dd27/lib/appium_lib/common/helper.rb#L87) common > def start_element(name, attrs = []) http://nokogiri.org/Nokogiri/XML/SAX/Document.html -- -##### [formatted_result](https://github.com/appium/ruby_lib/blob/06f2e54b4b55df25e624272b5a2cd7b23a000298/lib/appium_lib/common/helper.rb#L98) common +##### [formatted_result](https://github.com/appium/ruby_lib/blob/3060ef3bf06c19a79731a49985efa75c3337dd27/lib/appium_lib/common/helper.rb#L98) common > def formatted_result -- -##### [get_page_class](https://github.com/appium/ruby_lib/blob/06f2e54b4b55df25e624272b5a2cd7b23a000298/lib/appium_lib/common/helper.rb#L116) common +##### [get_page_class](https://github.com/appium/ruby_lib/blob/3060ef3bf06c19a79731a49985efa75c3337dd27/lib/appium_lib/common/helper.rb#L116) common > def get_page_class Returns a string of class counts of visible elements. @@ -1209,11 +1187,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[String] -- -##### [page_class](https://github.com/appium/ruby_lib/blob/06f2e54b4b55df25e624272b5a2cd7b23a000298/lib/appium_lib/common/helper.rb#L141) common +##### [page_class](https://github.com/appium/ruby_lib/blob/3060ef3bf06c19a79731a49985efa75c3337dd27/lib/appium_lib/common/helper.rb#L141) common > def page_class Count all classes on screen and print to stdout. Useful for appium_console. @@ -1222,11 +1200,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[nil] -- -##### [source](https://github.com/appium/ruby_lib/blob/06f2e54b4b55df25e624272b5a2cd7b23a000298/lib/appium_lib/common/helper.rb#L148) common +##### [source](https://github.com/appium/ruby_lib/blob/3060ef3bf06c19a79731a49985efa75c3337dd27/lib/appium_lib/common/helper.rb#L148) common > def source Prints xml of the current page @@ -1234,11 +1212,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[void] -- -##### [get_source](https://github.com/appium/ruby_lib/blob/06f2e54b4b55df25e624272b5a2cd7b23a000298/lib/appium_lib/common/helper.rb#L155) common +##### [get_source](https://github.com/appium/ruby_lib/blob/3060ef3bf06c19a79731a49985efa75c3337dd27/lib/appium_lib/common/helper.rb#L155) common > def get_source Returns XML string for the current page Same as driver.page_source @@ -1247,19 +1225,19 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[String] -- -##### [px_to_window_rel](https://github.com/appium/ruby_lib/blob/06f2e54b4b55df25e624272b5a2cd7b23a000298/lib/appium_lib/common/helper.rb#L165) common +##### [px_to_window_rel](https://github.com/appium/ruby_lib/blob/3060ef3bf06c19a79731a49985efa75c3337dd27/lib/appium_lib/common/helper.rb#L165) common > def px_to_window_rel(opts = {}, driver = $driver) Converts pixel values to window relative values -- -##### [xml_keys](https://github.com/appium/ruby_lib/blob/06f2e54b4b55df25e624272b5a2cd7b23a000298/lib/appium_lib/common/helper.rb#L184) common +##### [xml_keys](https://github.com/appium/ruby_lib/blob/3060ef3bf06c19a79731a49985efa75c3337dd27/lib/appium_lib/common/helper.rb#L184) common > def xml_keys(target) Search strings.xml's values for target. @@ -1271,11 +1249,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Array] -- -##### [xml_values](https://github.com/appium/ruby_lib/blob/06f2e54b4b55df25e624272b5a2cd7b23a000298/lib/appium_lib/common/helper.rb#L192) common +##### [xml_values](https://github.com/appium/ruby_lib/blob/3060ef3bf06c19a79731a49985efa75c3337dd27/lib/appium_lib/common/helper.rb#L192) common > def xml_values(target) Search strings.xml's keys for target. @@ -1287,11 +1265,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Array] -- -##### [resolve_id](https://github.com/appium/ruby_lib/blob/06f2e54b4b55df25e624272b5a2cd7b23a000298/lib/appium_lib/common/helper.rb#L200) common +##### [resolve_id](https://github.com/appium/ruby_lib/blob/3060ef3bf06c19a79731a49985efa75c3337dd27/lib/appium_lib/common/helper.rb#L200) common > def resolve_id(id) Resolve id in strings.xml and return the value. @@ -1303,27 +1281,27 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[String] -- -##### [filter](https://github.com/appium/ruby_lib/blob/06f2e54b4b55df25e624272b5a2cd7b23a000298/lib/appium_lib/common/helper.rb#L207) common +##### [filter](https://github.com/appium/ruby_lib/blob/3060ef3bf06c19a79731a49985efa75c3337dd27/lib/appium_lib/common/helper.rb#L207) common > def filter Returns the value of attribute filter. -- -##### [filter=](https://github.com/appium/ruby_lib/blob/06f2e54b4b55df25e624272b5a2cd7b23a000298/lib/appium_lib/common/helper.rb#L210) common +##### [filter=](https://github.com/appium/ruby_lib/blob/3060ef3bf06c19a79731a49985efa75c3337dd27/lib/appium_lib/common/helper.rb#L210) common > def filter=(value) convert to string to support symbols -- -##### [initialize](https://github.com/appium/ruby_lib/blob/06f2e54b4b55df25e624272b5a2cd7b23a000298/lib/appium_lib/common/helper.rb#L217) common +##### [initialize](https://github.com/appium/ruby_lib/blob/3060ef3bf06c19a79731a49985efa75c3337dd27/lib/appium_lib/common/helper.rb#L217) common > def initialize rubocop:disable Lint/MissingSuper @@ -1331,51 +1309,51 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[HTMLElements] a new instance of HTMLElements -- -##### [reset](https://github.com/appium/ruby_lib/blob/06f2e54b4b55df25e624272b5a2cd7b23a000298/lib/appium_lib/common/helper.rb#L222) common +##### [reset](https://github.com/appium/ruby_lib/blob/3060ef3bf06c19a79731a49985efa75c3337dd27/lib/appium_lib/common/helper.rb#L222) common > def reset -- -##### [result](https://github.com/appium/ruby_lib/blob/06f2e54b4b55df25e624272b5a2cd7b23a000298/lib/appium_lib/common/helper.rb#L228) common +##### [result](https://github.com/appium/ruby_lib/blob/3060ef3bf06c19a79731a49985efa75c3337dd27/lib/appium_lib/common/helper.rb#L228) common > def result -- -##### [start_element](https://github.com/appium/ruby_lib/blob/06f2e54b4b55df25e624272b5a2cd7b23a000298/lib/appium_lib/common/helper.rb#L242) common +##### [start_element](https://github.com/appium/ruby_lib/blob/3060ef3bf06c19a79731a49985efa75c3337dd27/lib/appium_lib/common/helper.rb#L242) common > def start_element(name, attrs = []) -- -##### [end_element](https://github.com/appium/ruby_lib/blob/06f2e54b4b55df25e624272b5a2cd7b23a000298/lib/appium_lib/common/helper.rb#L252) common +##### [end_element](https://github.com/appium/ruby_lib/blob/3060ef3bf06c19a79731a49985efa75c3337dd27/lib/appium_lib/common/helper.rb#L252) common > def end_element(name) -- -##### [characters](https://github.com/appium/ruby_lib/blob/06f2e54b4b55df25e624272b5a2cd7b23a000298/lib/appium_lib/common/helper.rb#L259) common +##### [characters](https://github.com/appium/ruby_lib/blob/3060ef3bf06c19a79731a49985efa75c3337dd27/lib/appium_lib/common/helper.rb#L259) common > def characters(chars) -- -##### [pinch](https://github.com/appium/ruby_lib/blob/06f2e54b4b55df25e624272b5a2cd7b23a000298/lib/appium_lib/common/multi_touch.rb#L65) common +##### [pinch](https://github.com/appium/ruby_lib/blob/3060ef3bf06c19a79731a49985efa75c3337dd27/lib/appium_lib/common/multi_touch.rb#L65) common > def pinch(percentage = 25, auto_perform = true, driver = $driver) Convenience method for pinching the screen. Places two fingers at the edges of the screen and brings them together. @@ -1391,11 +1369,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Driver] driver - Set a driver to conduct the action. DEfault is global driver($driver) -- -##### [zoom](https://github.com/appium/ruby_lib/blob/06f2e54b4b55df25e624272b5a2cd7b23a000298/lib/appium_lib/common/multi_touch.rb#L108) common +##### [zoom](https://github.com/appium/ruby_lib/blob/3060ef3bf06c19a79731a49985efa75c3337dd27/lib/appium_lib/common/multi_touch.rb#L108) common > def zoom(percentage = 200, auto_perform = true, driver = $driver) Convenience method for zooming the screen. Places two fingers at the edges of the screen and brings them together. @@ -1411,11 +1389,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Driver] driver - Set a driver to conduct the action. DEfault is global driver($driver) -- -##### [initialize](https://github.com/appium/ruby_lib/blob/06f2e54b4b55df25e624272b5a2cd7b23a000298/lib/appium_lib/common/multi_touch.rb#L194) common +##### [initialize](https://github.com/appium/ruby_lib/blob/3060ef3bf06c19a79731a49985efa75c3337dd27/lib/appium_lib/common/multi_touch.rb#L194) common > def initialize(driver = $driver) self @@ -1423,11 +1401,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[MultiTouch] a new instance of MultiTouch -- -##### [initialize](https://github.com/appium/ruby_lib/blob/06f2e54b4b55df25e624272b5a2cd7b23a000298/lib/appium_lib/common/touch_actions.rb#L62) common +##### [initialize](https://github.com/appium/ruby_lib/blob/3060ef3bf06c19a79731a49985efa75c3337dd27/lib/appium_lib/common/touch_actions.rb#L62) common > def initialize(driver = $driver) @@ -1435,19 +1413,19 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[TouchAction] a new instance of TouchAction -- -##### [swipe](https://github.com/appium/ruby_lib/blob/06f2e54b4b55df25e624272b5a2cd7b23a000298/lib/appium_lib/common/touch_actions.rb#L66) common +##### [swipe](https://github.com/appium/ruby_lib/blob/3060ef3bf06c19a79731a49985efa75c3337dd27/lib/appium_lib/common/touch_actions.rb#L66) common > def swipe(opts) -- -##### [initialize](https://github.com/appium/ruby_lib/blob/06f2e54b4b55df25e624272b5a2cd7b23a000298/lib/appium_lib/common/command/ws_logcat.rb#L19) common +##### [initialize](https://github.com/appium/ruby_lib/blob/3060ef3bf06c19a79731a49985efa75c3337dd27/lib/appium_lib/common/command/ws_logcat.rb#L19) common > def initialize(url:, output_file: 'logcat.log') @@ -1455,27 +1433,27 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[WsLogcat] a new instance of WsLogcat -- -##### [handle_message_data](https://github.com/appium/ruby_lib/blob/06f2e54b4b55df25e624272b5a2cd7b23a000298/lib/appium_lib/common/command/ws_logcat.rb#L24) common +##### [handle_message_data](https://github.com/appium/ruby_lib/blob/3060ef3bf06c19a79731a49985efa75c3337dd27/lib/appium_lib/common/command/ws_logcat.rb#L24) common > def handle_message_data(data) -- -##### [for](https://github.com/appium/ruby_lib/blob/06f2e54b4b55df25e624272b5a2cd7b23a000298/lib/appium_lib/ios/ios.rb#L29) ios +##### [for](https://github.com/appium/ruby_lib/blob/3060ef3bf06c19a79731a49985efa75c3337dd27/lib/appium_lib/ios/ios.rb#L29) ios > def for(target) -- -##### [static_text_class](https://github.com/appium/ruby_lib/blob/06f2e54b4b55df25e624272b5a2cd7b23a000298/lib/appium_lib/ios/element/text.rb#L25) ios +##### [static_text_class](https://github.com/appium/ruby_lib/blob/3060ef3bf06c19a79731a49985efa75c3337dd27/lib/appium_lib/ios/element/text.rb#L25) ios > def static_text_class @@ -1483,11 +1461,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[String] Class name for text -- -##### [text](https://github.com/appium/ruby_lib/blob/06f2e54b4b55df25e624272b5a2cd7b23a000298/lib/appium_lib/ios/element/text.rb#L33) ios +##### [text](https://github.com/appium/ruby_lib/blob/3060ef3bf06c19a79731a49985efa75c3337dd27/lib/appium_lib/ios/element/text.rb#L33) 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. @@ -1500,11 +1478,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[UIA_STATIC_TEXT|XCUIELEMENT_TYPE_STATIC_TEXT] -- -##### [texts](https://github.com/appium/ruby_lib/blob/06f2e54b4b55df25e624272b5a2cd7b23a000298/lib/appium_lib/ios/element/text.rb#L43) ios +##### [texts](https://github.com/appium/ruby_lib/blob/3060ef3bf06c19a79731a49985efa75c3337dd27/lib/appium_lib/ios/element/text.rb#L43) ios > def texts(value = false) Find all UIAStaticTexts|XCUIElementTypeStaticTexts containing value. If value is omitted, all UIAStaticTexts|XCUIElementTypeStaticTexts are returned @@ -1517,11 +1495,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Array<UIA_STATIC_TEXT|XCUIELEMENT_TYPE_STATIC_TEXT>] -- -##### [first_text](https://github.com/appium/ruby_lib/blob/06f2e54b4b55df25e624272b5a2cd7b23a000298/lib/appium_lib/ios/element/text.rb#L51) ios +##### [first_text](https://github.com/appium/ruby_lib/blob/3060ef3bf06c19a79731a49985efa75c3337dd27/lib/appium_lib/ios/element/text.rb#L51) ios > def first_text Find the first UIAStaticText|XCUIElementTypeStaticText. @@ -1529,11 +1507,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[UIA_STATIC_TEXT|XCUIELEMENT_TYPE_STATIC_TEXT] -- -##### [last_text](https://github.com/appium/ruby_lib/blob/06f2e54b4b55df25e624272b5a2cd7b23a000298/lib/appium_lib/ios/element/text.rb#L57) ios +##### [last_text](https://github.com/appium/ruby_lib/blob/3060ef3bf06c19a79731a49985efa75c3337dd27/lib/appium_lib/ios/element/text.rb#L57) ios > def last_text Find the last UIAStaticText|XCUIElementTypeStaticText. @@ -1541,11 +1519,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[UIA_STATIC_TEXT|XCUIELEMENT_TYPE_STATIC_TEXT] -- -##### [text_exact](https://github.com/appium/ruby_lib/blob/06f2e54b4b55df25e624272b5a2cd7b23a000298/lib/appium_lib/ios/element/text.rb#L64) ios +##### [text_exact](https://github.com/appium/ruby_lib/blob/3060ef3bf06c19a79731a49985efa75c3337dd27/lib/appium_lib/ios/element/text.rb#L64) ios > def text_exact(value) Find the first UIAStaticText|XCUIElementTypeStaticText that exactly matches value. @@ -1557,11 +1535,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[UIA_STATIC_TEXT|XCUIElementTypeStaticText] -- -##### [texts_exact](https://github.com/appium/ruby_lib/blob/06f2e54b4b55df25e624272b5a2cd7b23a000298/lib/appium_lib/ios/element/text.rb#L71) ios +##### [texts_exact](https://github.com/appium/ruby_lib/blob/3060ef3bf06c19a79731a49985efa75c3337dd27/lib/appium_lib/ios/element/text.rb#L71) ios > def texts_exact(value) Find all UIAStaticTexts|XCUIElementTypeStaticTexts that exactly match value. @@ -1573,19 +1551,19 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Array<UIA_STATIC_TEXT|XCUIElementTypeStaticText>] -- -##### [filter](https://github.com/appium/ruby_lib/blob/06f2e54b4b55df25e624272b5a2cd7b23a000298/lib/appium_lib/ios/common/helper.rb#L19) ios +##### [filter](https://github.com/appium/ruby_lib/blob/3060ef3bf06c19a79731a49985efa75c3337dd27/lib/appium_lib/ios/common/helper.rb#L19) ios > def filter Returns the value of attribute filter. -- -##### [filter=](https://github.com/appium/ruby_lib/blob/06f2e54b4b55df25e624272b5a2cd7b23a000298/lib/appium_lib/ios/common/helper.rb#L19) ios +##### [filter=](https://github.com/appium/ruby_lib/blob/3060ef3bf06c19a79731a49985efa75c3337dd27/lib/appium_lib/ios/common/helper.rb#L19) ios > def filter=(value) Sets the attribute filter @@ -1593,19 +1571,19 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[] value - the value to set the attribute filter to. -- -##### [start_element](https://github.com/appium/ruby_lib/blob/06f2e54b4b55df25e624272b5a2cd7b23a000298/lib/appium_lib/ios/common/helper.rb#L21) ios +##### [start_element](https://github.com/appium/ruby_lib/blob/3060ef3bf06c19a79731a49985efa75c3337dd27/lib/appium_lib/ios/common/helper.rb#L21) ios > def start_element(type, attrs = []) -- -##### [ios_password](https://github.com/appium/ruby_lib/blob/06f2e54b4b55df25e624272b5a2cd7b23a000298/lib/appium_lib/ios/common/helper.rb#L58) ios +##### [ios_password](https://github.com/appium/ruby_lib/blob/3060ef3bf06c19a79731a49985efa75c3337dd27/lib/appium_lib/ios/common/helper.rb#L58) ios > def ios_password(length = 1) iOS only. On Android uiautomator always returns an empty string for EditText password. @@ -1619,11 +1597,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[String] the returned string is of size length -- -##### [page](https://github.com/appium/ruby_lib/blob/06f2e54b4b55df25e624272b5a2cd7b23a000298/lib/appium_lib/ios/common/helper.rb#L74) ios +##### [page](https://github.com/appium/ruby_lib/blob/3060ef3bf06c19a79731a49985efa75c3337dd27/lib/appium_lib/ios/common/helper.rb#L74) ios > def page(opts = {}) Prints a string of interesting elements to the console. @@ -1637,11 +1615,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[void] -- -##### [id](https://github.com/appium/ruby_lib/blob/06f2e54b4b55df25e624272b5a2cd7b23a000298/lib/appium_lib/ios/common/helper.rb#L101) ios +##### [id](https://github.com/appium/ruby_lib/blob/3060ef3bf06c19a79731a49985efa75c3337dd27/lib/appium_lib/ios/common/helper.rb#L101) ios > def id(id) Find by id @@ -1653,11 +1631,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Element] -- -##### [ele_index](https://github.com/appium/ruby_lib/blob/06f2e54b4b55df25e624272b5a2cd7b23a000298/lib/appium_lib/ios/common/helper.rb#L109) ios +##### [ele_index](https://github.com/appium/ruby_lib/blob/3060ef3bf06c19a79731a49985efa75c3337dd27/lib/appium_lib/ios/common/helper.rb#L109) ios > def ele_index(class_name, index) Get the element of type class_name at matching index. @@ -1671,11 +1649,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Element] -- -##### [find_ele_by_attr](https://github.com/appium/ruby_lib/blob/06f2e54b4b55df25e624272b5a2cd7b23a000298/lib/appium_lib/ios/common/helper.rb#L139) ios +##### [find_ele_by_attr](https://github.com/appium/ruby_lib/blob/3060ef3bf06c19a79731a49985efa75c3337dd27/lib/appium_lib/ios/common/helper.rb#L139) ios > def find_ele_by_attr(class_name, attr, value) Find the first element exactly matching class and attribute value. Note: Uses XPath @@ -1693,11 +1671,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Element] -- -##### [find_eles_by_attr](https://github.com/appium/ruby_lib/blob/06f2e54b4b55df25e624272b5a2cd7b23a000298/lib/appium_lib/ios/common/helper.rb#L150) ios +##### [find_eles_by_attr](https://github.com/appium/ruby_lib/blob/3060ef3bf06c19a79731a49985efa75c3337dd27/lib/appium_lib/ios/common/helper.rb#L150) ios > def find_eles_by_attr(class_name, attr, value) Find all elements exactly matching class and attribute value. Note: Uses XPath @@ -1715,11 +1693,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Array<Element>] -- -##### [find_ele_by_predicate](https://github.com/appium/ruby_lib/blob/06f2e54b4b55df25e624272b5a2cd7b23a000298/lib/appium_lib/ios/common/helper.rb#L163) ios +##### [find_ele_by_predicate](https://github.com/appium/ruby_lib/blob/3060ef3bf06c19a79731a49985efa75c3337dd27/lib/appium_lib/ios/common/helper.rb#L163) ios > def find_ele_by_predicate(class_name: '*', value:) Find the first element exactly matching attribute case insensitive value. Note: Uses Predicate @@ -1732,11 +1710,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Element] -- -##### [find_eles_by_predicate](https://github.com/appium/ruby_lib/blob/06f2e54b4b55df25e624272b5a2cd7b23a000298/lib/appium_lib/ios/common/helper.rb#L175) ios +##### [find_eles_by_predicate](https://github.com/appium/ruby_lib/blob/3060ef3bf06c19a79731a49985efa75c3337dd27/lib/appium_lib/ios/common/helper.rb#L175) ios > def find_eles_by_predicate(class_name: '*', value:) Find all elements exactly matching attribute case insensitive value. Note: Uses Predicate @@ -1751,11 +1729,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Array<Element>] -- -##### [find_ele_by_attr_include](https://github.com/appium/ruby_lib/blob/06f2e54b4b55df25e624272b5a2cd7b23a000298/lib/appium_lib/ios/common/helper.rb#L191) ios +##### [find_ele_by_attr_include](https://github.com/appium/ruby_lib/blob/3060ef3bf06c19a79731a49985efa75c3337dd27/lib/appium_lib/ios/common/helper.rb#L191) ios > def find_ele_by_attr_include(class_name, attr, value) Get the first tag by attribute that exactly matches value. Note: Uses XPath @@ -1772,11 +1750,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/06f2e54b4b55df25e624272b5a2cd7b23a000298/lib/appium_lib/ios/common/helper.rb#L201) ios +##### [find_eles_by_attr_include](https://github.com/appium/ruby_lib/blob/3060ef3bf06c19a79731a49985efa75c3337dd27/lib/appium_lib/ios/common/helper.rb#L201) ios > def find_eles_by_attr_include(class_name, attr, value) Get tags by attribute that include value. Note: Uses XPath @@ -1793,11 +1771,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/06f2e54b4b55df25e624272b5a2cd7b23a000298/lib/appium_lib/ios/common/helper.rb#L209) ios +##### [find_ele_by_predicate_include](https://github.com/appium/ruby_lib/blob/3060ef3bf06c19a79731a49985efa75c3337dd27/lib/appium_lib/ios/common/helper.rb#L209) ios > def find_ele_by_predicate_include(class_name: '*', value:) Get the first elements that include insensitive value. Note: Uses Predicate @@ -1810,11 +1788,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/06f2e54b4b55df25e624272b5a2cd7b23a000298/lib/appium_lib/ios/common/helper.rb#L221) ios +##### [find_eles_by_predicate_include](https://github.com/appium/ruby_lib/blob/3060ef3bf06c19a79731a49985efa75c3337dd27/lib/appium_lib/ios/common/helper.rb#L221) ios > def find_eles_by_predicate_include(class_name: '*', value:) Get elements that include case insensitive value. Note: Uses Predicate @@ -1829,11 +1807,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/06f2e54b4b55df25e624272b5a2cd7b23a000298/lib/appium_lib/ios/common/helper.rb#L234) ios +##### [first_ele](https://github.com/appium/ruby_lib/blob/3060ef3bf06c19a79731a49985efa75c3337dd27/lib/appium_lib/ios/common/helper.rb#L234) ios > def first_ele(class_name) Get the first tag that matches class_name @@ -1845,11 +1823,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Element] -- -##### [last_ele](https://github.com/appium/ruby_lib/blob/06f2e54b4b55df25e624272b5a2cd7b23a000298/lib/appium_lib/ios/common/helper.rb#L241) ios +##### [last_ele](https://github.com/appium/ruby_lib/blob/3060ef3bf06c19a79731a49985efa75c3337dd27/lib/appium_lib/ios/common/helper.rb#L241) ios > def last_ele(class_name) Get the last tag that matches class_name @@ -1861,11 +1839,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Element] -- -##### [tag](https://github.com/appium/ruby_lib/blob/06f2e54b4b55df25e624272b5a2cd7b23a000298/lib/appium_lib/ios/common/helper.rb#L249) ios +##### [tag](https://github.com/appium/ruby_lib/blob/3060ef3bf06c19a79731a49985efa75c3337dd27/lib/appium_lib/ios/common/helper.rb#L249) ios > def tag(class_name) Returns the first **visible** element matching class_name @@ -1877,11 +1855,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Element] -- -##### [tags](https://github.com/appium/ruby_lib/blob/06f2e54b4b55df25e624272b5a2cd7b23a000298/lib/appium_lib/ios/common/helper.rb#L257) ios +##### [tags](https://github.com/appium/ruby_lib/blob/3060ef3bf06c19a79731a49985efa75c3337dd27/lib/appium_lib/ios/common/helper.rb#L257) ios > def tags(class_name) Returns all visible elements matching class_name @@ -1893,11 +1871,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Element] -- -##### [tags_include](https://github.com/appium/ruby_lib/blob/06f2e54b4b55df25e624272b5a2cd7b23a000298/lib/appium_lib/ios/common/helper.rb#L268) ios +##### [tags_include](https://github.com/appium/ruby_lib/blob/3060ef3bf06c19a79731a49985efa75c3337dd27/lib/appium_lib/ios/common/helper.rb#L268) 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. @@ -1913,11 +1891,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Array[Element]] -- -##### [tags_exact](https://github.com/appium/ruby_lib/blob/06f2e54b4b55df25e624272b5a2cd7b23a000298/lib/appium_lib/ios/common/helper.rb#L283) ios +##### [tags_exact](https://github.com/appium/ruby_lib/blob/3060ef3bf06c19a79731a49985efa75c3337dd27/lib/appium_lib/ios/common/helper.rb#L283) 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. @@ -1933,11 +1911,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Array[Element]] -- -##### [ele_by_json_visible_contains](https://github.com/appium/ruby_lib/blob/06f2e54b4b55df25e624272b5a2cd7b23a000298/lib/appium_lib/ios/common/helper.rb#L320) ios +##### [ele_by_json_visible_contains](https://github.com/appium/ruby_lib/blob/3060ef3bf06c19a79731a49985efa75c3337dd27/lib/appium_lib/ios/common/helper.rb#L320) ios > def ele_by_json_visible_contains(element, value) Find the first element that contains value. For Appium(automation name), not XCUITest @@ -1952,11 +1930,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Element] -- -##### [eles_by_json_visible_contains](https://github.com/appium/ruby_lib/blob/06f2e54b4b55df25e624272b5a2cd7b23a000298/lib/appium_lib/ios/common/helper.rb#L329) ios +##### [eles_by_json_visible_contains](https://github.com/appium/ruby_lib/blob/3060ef3bf06c19a79731a49985efa75c3337dd27/lib/appium_lib/ios/common/helper.rb#L329) ios > def eles_by_json_visible_contains(element, value) Find all elements containing value For Appium(automation name), not XCUITest @@ -1971,11 +1949,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Array<Element>] -- -##### [ele_by_json_visible_exact](https://github.com/appium/ruby_lib/blob/06f2e54b4b55df25e624272b5a2cd7b23a000298/lib/appium_lib/ios/common/helper.rb#L359) ios +##### [ele_by_json_visible_exact](https://github.com/appium/ruby_lib/blob/3060ef3bf06c19a79731a49985efa75c3337dd27/lib/appium_lib/ios/common/helper.rb#L359) ios > def ele_by_json_visible_exact(element, value) Find the first element exactly matching value For Appium(automation name), not XCUITest @@ -1990,11 +1968,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Element] -- -##### [eles_by_json_visible_exact](https://github.com/appium/ruby_lib/blob/06f2e54b4b55df25e624272b5a2cd7b23a000298/lib/appium_lib/ios/common/helper.rb#L368) ios +##### [eles_by_json_visible_exact](https://github.com/appium/ruby_lib/blob/3060ef3bf06c19a79731a49985efa75c3337dd27/lib/appium_lib/ios/common/helper.rb#L368) ios > def eles_by_json_visible_exact(element, value) Find all elements exactly matching value For Appium(automation name), not XCUITest @@ -2009,21 +1987,21 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Element] -- -##### [_all_pred](https://github.com/appium/ruby_lib/blob/06f2e54b4b55df25e624272b5a2cd7b23a000298/lib/appium_lib/ios/common/helper.rb#L377) ios +##### [_all_pred](https://github.com/appium/ruby_lib/blob/3060ef3bf06c19a79731a49985efa75c3337dd27/lib/appium_lib/ios/common/helper.rb#L377) 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/06f2e54b4b55df25e624272b5a2cd7b23a000298/lib/appium_lib/ios/common/helper.rb#L391) ios +##### [ele_with_pred](https://github.com/appium/ruby_lib/blob/3060ef3bf06c19a79731a49985efa75c3337dd27/lib/appium_lib/ios/common/helper.rb#L391) ios > def ele_with_pred(opts) returns element matching predicate contained in the main app @@ -2035,11 +2013,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Element] -- -##### [eles_with_pred](https://github.com/appium/ruby_lib/blob/06f2e54b4b55df25e624272b5a2cd7b23a000298/lib/appium_lib/ios/common/helper.rb#L402) ios +##### [eles_with_pred](https://github.com/appium/ruby_lib/blob/3060ef3bf06c19a79731a49985efa75c3337dd27/lib/appium_lib/ios/common/helper.rb#L402) ios > def eles_with_pred(opts) returns elements matching predicate contained in the main app @@ -2051,19 +2029,19 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Array<Element>] -- -##### [_validate_object](https://github.com/appium/ruby_lib/blob/06f2e54b4b55df25e624272b5a2cd7b23a000298/lib/appium_lib/ios/common/helper.rb#L406) ios +##### [_validate_object](https://github.com/appium/ruby_lib/blob/3060ef3bf06c19a79731a49985efa75c3337dd27/lib/appium_lib/ios/common/helper.rb#L406) ios > def _validate_object(*objects) -- -##### [_by_json](https://github.com/appium/ruby_lib/blob/06f2e54b4b55df25e624272b5a2cd7b23a000298/lib/appium_lib/ios/common/helper.rb#L456) ios +##### [_by_json](https://github.com/appium/ruby_lib/blob/3060ef3bf06c19a79731a49985efa75c3337dd27/lib/appium_lib/ios/common/helper.rb#L456) ios > def _by_json(opts) For Appium(automation name), not XCUITest typeArray - array of string types to search for. Example: ["UIAStaticText"] @@ -2094,11 +2072,11 @@ } } -- -##### [eles_by_json](https://github.com/appium/ruby_lib/blob/06f2e54b4b55df25e624272b5a2cd7b23a000298/lib/appium_lib/ios/common/helper.rb#L506) ios +##### [eles_by_json](https://github.com/appium/ruby_lib/blob/3060ef3bf06c19a79731a49985efa75c3337dd27/lib/appium_lib/ios/common/helper.rb#L506) ios > def eles_by_json(opts) For Appium(automation name), not XCUITest example usage: @@ -2113,19 +2091,19 @@ }, }) -- -##### [ele_by_json](https://github.com/appium/ruby_lib/blob/06f2e54b4b55df25e624272b5a2cd7b23a000298/lib/appium_lib/ios/common/helper.rb#L512) ios +##### [ele_by_json](https://github.com/appium/ruby_lib/blob/3060ef3bf06c19a79731a49985efa75c3337dd27/lib/appium_lib/ios/common/helper.rb#L512) ios > def ele_by_json(opts) see eles_by_json -- -##### [alert_accept](https://github.com/appium/ruby_lib/blob/06f2e54b4b55df25e624272b5a2cd7b23a000298/lib/appium_lib/ios/element/alert.rb#L19) ios +##### [alert_accept](https://github.com/appium/ruby_lib/blob/3060ef3bf06c19a79731a49985efa75c3337dd27/lib/appium_lib/ios/element/alert.rb#L19) ios > def alert_accept Accept the alert. @@ -2133,11 +2111,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[void] -- -##### [alert_dismiss](https://github.com/appium/ruby_lib/blob/06f2e54b4b55df25e624272b5a2cd7b23a000298/lib/appium_lib/ios/element/alert.rb#L27) ios +##### [alert_dismiss](https://github.com/appium/ruby_lib/blob/3060ef3bf06c19a79731a49985efa75c3337dd27/lib/appium_lib/ios/element/alert.rb#L27) ios > def alert_dismiss Dismiss the alert. @@ -2145,11 +2123,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[void] -- -##### [button_class](https://github.com/appium/ruby_lib/blob/06f2e54b4b55df25e624272b5a2cd7b23a000298/lib/appium_lib/ios/element/button.rb#L25) ios +##### [button_class](https://github.com/appium/ruby_lib/blob/3060ef3bf06c19a79731a49985efa75c3337dd27/lib/appium_lib/ios/element/button.rb#L25) ios > def button_class @@ -2157,11 +2135,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[String] Class name for button -- -##### [button](https://github.com/appium/ruby_lib/blob/06f2e54b4b55df25e624272b5a2cd7b23a000298/lib/appium_lib/ios/element/button.rb#L33) ios +##### [button](https://github.com/appium/ruby_lib/blob/3060ef3bf06c19a79731a49985efa75c3337dd27/lib/appium_lib/ios/element/button.rb#L33) 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. @@ -2174,11 +2152,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[UIA_BUTTON|XCUIELEMENT_TYPE_BUTTON] -- -##### [buttons](https://github.com/appium/ruby_lib/blob/06f2e54b4b55df25e624272b5a2cd7b23a000298/lib/appium_lib/ios/element/button.rb#L44) ios +##### [buttons](https://github.com/appium/ruby_lib/blob/3060ef3bf06c19a79731a49985efa75c3337dd27/lib/appium_lib/ios/element/button.rb#L44) ios > def buttons(value = false) Find all UIAButtons|XCUIElementTypeButtons containing value. If value is omitted, all UIAButtons|XCUIElementTypeButtons are returned. @@ -2191,11 +2169,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Array<UIA_BUTTON|XCUIELEMENT_TYPE_BUTTON>] -- -##### [first_button](https://github.com/appium/ruby_lib/blob/06f2e54b4b55df25e624272b5a2cd7b23a000298/lib/appium_lib/ios/element/button.rb#L52) ios +##### [first_button](https://github.com/appium/ruby_lib/blob/3060ef3bf06c19a79731a49985efa75c3337dd27/lib/appium_lib/ios/element/button.rb#L52) ios > def first_button Find the first UIAButton|XCUIElementTypeButton. @@ -2203,11 +2181,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[UIA_BUTTON|XCUIELEMENT_TYPE_BUTTON] -- -##### [last_button](https://github.com/appium/ruby_lib/blob/06f2e54b4b55df25e624272b5a2cd7b23a000298/lib/appium_lib/ios/element/button.rb#L60) ios +##### [last_button](https://github.com/appium/ruby_lib/blob/3060ef3bf06c19a79731a49985efa75c3337dd27/lib/appium_lib/ios/element/button.rb#L60) ios > def last_button TODO: add documentation regarding previous element. Previous UIAElement is differ from UIAButton|XCUIElementTypeButton. So, the results are different. @@ -2217,11 +2195,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[UIA_BUTTON|XCUIELEMENT_TYPE_BUTTON] -- -##### [button_exact](https://github.com/appium/ruby_lib/blob/06f2e54b4b55df25e624272b5a2cd7b23a000298/lib/appium_lib/ios/element/button.rb#L67) ios +##### [button_exact](https://github.com/appium/ruby_lib/blob/3060ef3bf06c19a79731a49985efa75c3337dd27/lib/appium_lib/ios/element/button.rb#L67) ios > def button_exact(value) Find the first UIAButton|XCUIElementTypeButton that exactly matches value. @@ -2233,11 +2211,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[UIA_BUTTON|XCUIELEMENT_TYPE_BUTTON] -- -##### [buttons_exact](https://github.com/appium/ruby_lib/blob/06f2e54b4b55df25e624272b5a2cd7b23a000298/lib/appium_lib/ios/element/button.rb#L74) ios +##### [buttons_exact](https://github.com/appium/ruby_lib/blob/3060ef3bf06c19a79731a49985efa75c3337dd27/lib/appium_lib/ios/element/button.rb#L74) ios > def buttons_exact(value) Find all UIAButtons|XCUIElementTypeButtons that exactly match value. @@ -2249,11 +2227,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Array<UIA_BUTTON|XCUIELEMENT_TYPE_BUTTON>] -- -##### [find](https://github.com/appium/ruby_lib/blob/06f2e54b4b55df25e624272b5a2cd7b23a000298/lib/appium_lib/ios/element/generic.rb#L20) ios +##### [find](https://github.com/appium/ruby_lib/blob/3060ef3bf06c19a79731a49985efa75c3337dd27/lib/appium_lib/ios/element/generic.rb#L20) ios > def find(value) Find the first element containing value @@ -2265,11 +2243,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Element] -- -##### [finds](https://github.com/appium/ruby_lib/blob/06f2e54b4b55df25e624272b5a2cd7b23a000298/lib/appium_lib/ios/element/generic.rb#L27) ios +##### [finds](https://github.com/appium/ruby_lib/blob/3060ef3bf06c19a79731a49985efa75c3337dd27/lib/appium_lib/ios/element/generic.rb#L27) ios > def finds(value) Find all elements containing value @@ -2281,11 +2259,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Array<Element>] -- -##### [find_exact](https://github.com/appium/ruby_lib/blob/06f2e54b4b55df25e624272b5a2cd7b23a000298/lib/appium_lib/ios/element/generic.rb#L34) ios +##### [find_exact](https://github.com/appium/ruby_lib/blob/3060ef3bf06c19a79731a49985efa75c3337dd27/lib/appium_lib/ios/element/generic.rb#L34) ios > def find_exact(value) Find the first element exactly matching value @@ -2297,11 +2275,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Element] -- -##### [finds_exact](https://github.com/appium/ruby_lib/blob/06f2e54b4b55df25e624272b5a2cd7b23a000298/lib/appium_lib/ios/element/generic.rb#L41) ios +##### [finds_exact](https://github.com/appium/ruby_lib/blob/3060ef3bf06c19a79731a49985efa75c3337dd27/lib/appium_lib/ios/element/generic.rb#L41) ios > def finds_exact(value) Find all elements exactly matching value @@ -2313,35 +2291,35 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Array<Element>] -- -##### [raise_error_if_no_element](https://github.com/appium/ruby_lib/blob/06f2e54b4b55df25e624272b5a2cd7b23a000298/lib/appium_lib/ios/element/generic.rb#L47) ios +##### [raise_error_if_no_element](https://github.com/appium/ruby_lib/blob/3060ef3bf06c19a79731a49985efa75c3337dd27/lib/appium_lib/ios/element/generic.rb#L47) ios > def raise_error_if_no_element(element) -- -##### [select_visible_elements](https://github.com/appium/ruby_lib/blob/06f2e54b4b55df25e624272b5a2cd7b23a000298/lib/appium_lib/ios/element/generic.rb#L55) ios +##### [select_visible_elements](https://github.com/appium/ruby_lib/blob/3060ef3bf06c19a79731a49985efa75c3337dd27/lib/appium_lib/ios/element/generic.rb#L55) ios > def select_visible_elements(elements) Return visible elements. -- -##### [for](https://github.com/appium/ruby_lib/blob/06f2e54b4b55df25e624272b5a2cd7b23a000298/lib/appium_lib/ios/xcuitest/bridge.rb#L21) ios +##### [for](https://github.com/appium/ruby_lib/blob/3060ef3bf06c19a79731a49985efa75c3337dd27/lib/appium_lib/ios/xcuitest/bridge.rb#L21) ios > def for(target) -- -##### [last_ele](https://github.com/appium/ruby_lib/blob/06f2e54b4b55df25e624272b5a2cd7b23a000298/lib/appium_lib/ios/xcuitest/helper.rb#L40) ios +##### [last_ele](https://github.com/appium/ruby_lib/blob/3060ef3bf06c19a79731a49985efa75c3337dd27/lib/appium_lib/ios/xcuitest/helper.rb#L40) ios > def last_ele(class_name) Get the last tag that matches class_name @@ -2353,11 +2331,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Element] -- -##### [tag](https://github.com/appium/ruby_lib/blob/06f2e54b4b55df25e624272b5a2cd7b23a000298/lib/appium_lib/ios/xcuitest/helper.rb#L51) ios +##### [tag](https://github.com/appium/ruby_lib/blob/3060ef3bf06c19a79731a49985efa75c3337dd27/lib/appium_lib/ios/xcuitest/helper.rb#L51) ios > def tag(class_name) Returns the first **visible** element matching class_name @@ -2369,11 +2347,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Element] -- -##### [tags](https://github.com/appium/ruby_lib/blob/06f2e54b4b55df25e624272b5a2cd7b23a000298/lib/appium_lib/ios/xcuitest/helper.rb#L59) ios +##### [tags](https://github.com/appium/ruby_lib/blob/3060ef3bf06c19a79731a49985efa75c3337dd27/lib/appium_lib/ios/xcuitest/helper.rb#L59) ios > def tags(class_name) Returns all visible elements matching class_name @@ -2385,11 +2363,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Element] -- -##### [tags_include](https://github.com/appium/ruby_lib/blob/06f2e54b4b55df25e624272b5a2cd7b23a000298/lib/appium_lib/ios/xcuitest/helper.rb#L71) ios +##### [tags_include](https://github.com/appium/ruby_lib/blob/3060ef3bf06c19a79731a49985efa75c3337dd27/lib/appium_lib/ios/xcuitest/helper.rb#L71) 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. @@ -2405,11 +2383,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Array[Element]] -- -##### [tags_exact](https://github.com/appium/ruby_lib/blob/06f2e54b4b55df25e624272b5a2cd7b23a000298/lib/appium_lib/ios/xcuitest/helper.rb#L93) ios +##### [tags_exact](https://github.com/appium/ruby_lib/blob/3060ef3bf06c19a79731a49985efa75c3337dd27/lib/appium_lib/ios/xcuitest/helper.rb#L93) 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. @@ -2425,11 +2403,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Array[Element]] -- -##### [start_logs_broadcast](https://github.com/appium/ruby_lib/blob/06f2e54b4b55df25e624272b5a2cd7b23a000298/lib/appium_lib/ios/xcuitest/command.rb#L33) ios +##### [start_logs_broadcast](https://github.com/appium/ruby_lib/blob/3060ef3bf06c19a79731a49985efa75c3337dd27/lib/appium_lib/ios/xcuitest/command.rb#L33) ios > def start_logs_broadcast(syslog_file = 'syslog.log') Starts iOS syslog broadcast websocket @@ -2437,19 +2415,19 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[String] syslog_file - A file path to write messages from a syslog WebSocket client -- -##### [stop_logs_broadcast](https://github.com/appium/ruby_lib/blob/06f2e54b4b55df25e624272b5a2cd7b23a000298/lib/appium_lib/ios/xcuitest/command.rb#L46) ios +##### [stop_logs_broadcast](https://github.com/appium/ruby_lib/blob/3060ef3bf06c19a79731a49985efa75c3337dd27/lib/appium_lib/ios/xcuitest/command.rb#L46) ios > def stop_logs_broadcast Stop iOS syslog broadcast websocket -- -##### [text_field_class](https://github.com/appium/ruby_lib/blob/06f2e54b4b55df25e624272b5a2cd7b23a000298/lib/appium_lib/ios/element/textfield.rb#L28) ios +##### [text_field_class](https://github.com/appium/ruby_lib/blob/3060ef3bf06c19a79731a49985efa75c3337dd27/lib/appium_lib/ios/element/textfield.rb#L28) ios > def text_field_class @@ -2457,11 +2435,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[String] Class name for text field -- -##### [secure_text_field_class](https://github.com/appium/ruby_lib/blob/06f2e54b4b55df25e624272b5a2cd7b23a000298/lib/appium_lib/ios/element/textfield.rb#L33) ios +##### [secure_text_field_class](https://github.com/appium/ruby_lib/blob/3060ef3bf06c19a79731a49985efa75c3337dd27/lib/appium_lib/ios/element/textfield.rb#L33) ios > def secure_text_field_class @@ -2469,11 +2447,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[String] Class name for secure text field -- -##### [textfield](https://github.com/appium/ruby_lib/blob/06f2e54b4b55df25e624272b5a2cd7b23a000298/lib/appium_lib/ios/element/textfield.rb#L42) ios +##### [textfield](https://github.com/appium/ruby_lib/blob/3060ef3bf06c19a79731a49985efa75c3337dd27/lib/appium_lib/ios/element/textfield.rb#L42) ios > def textfield(value) Find the first TextField that contains value or by index. Note: Uses XPath @@ -2487,11 +2465,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[TextField] -- -##### [textfields](https://github.com/appium/ruby_lib/blob/06f2e54b4b55df25e624272b5a2cd7b23a000298/lib/appium_lib/ios/element/textfield.rb#L61) ios +##### [textfields](https://github.com/appium/ruby_lib/blob/3060ef3bf06c19a79731a49985efa75c3337dd27/lib/appium_lib/ios/element/textfield.rb#L61) ios > def textfields(value = false) Find all TextFields containing value. If value is omitted, all TextFields are returned. @@ -2504,11 +2482,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Array<TextField>] -- -##### [first_textfield](https://github.com/appium/ruby_lib/blob/06f2e54b4b55df25e624272b5a2cd7b23a000298/lib/appium_lib/ios/element/textfield.rb#L69) ios +##### [first_textfield](https://github.com/appium/ruby_lib/blob/3060ef3bf06c19a79731a49985efa75c3337dd27/lib/appium_lib/ios/element/textfield.rb#L69) ios > def first_textfield Find the first TextField. @@ -2516,11 +2494,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[TextField] -- -##### [last_textfield](https://github.com/appium/ruby_lib/blob/06f2e54b4b55df25e624272b5a2cd7b23a000298/lib/appium_lib/ios/element/textfield.rb#L75) ios +##### [last_textfield](https://github.com/appium/ruby_lib/blob/3060ef3bf06c19a79731a49985efa75c3337dd27/lib/appium_lib/ios/element/textfield.rb#L75) ios > def last_textfield Find the last TextField. @@ -2528,11 +2506,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[TextField] -- -##### [textfield_exact](https://github.com/appium/ruby_lib/blob/06f2e54b4b55df25e624272b5a2cd7b23a000298/lib/appium_lib/ios/element/textfield.rb#L85) ios +##### [textfield_exact](https://github.com/appium/ruby_lib/blob/3060ef3bf06c19a79731a49985efa75c3337dd27/lib/appium_lib/ios/element/textfield.rb#L85) ios > def textfield_exact(value) Find the first TextField that exactly matches value. @@ -2544,11 +2522,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[TextField] -- -##### [textfields_exact](https://github.com/appium/ruby_lib/blob/06f2e54b4b55df25e624272b5a2cd7b23a000298/lib/appium_lib/ios/element/textfield.rb#L92) ios +##### [textfields_exact](https://github.com/appium/ruby_lib/blob/3060ef3bf06c19a79731a49985efa75c3337dd27/lib/appium_lib/ios/element/textfield.rb#L92) ios > def textfields_exact(value) Find all TextFields that exactly match value. @@ -2560,35 +2538,35 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Array<TextField>] -- -##### [_textfield_visible](https://github.com/appium/ruby_lib/blob/06f2e54b4b55df25e624272b5a2cd7b23a000298/lib/appium_lib/ios/element/textfield.rb#L99) ios +##### [_textfield_visible](https://github.com/appium/ruby_lib/blob/3060ef3bf06c19a79731a49985efa75c3337dd27/lib/appium_lib/ios/element/textfield.rb#L99) ios > def _textfield_visible Appium -- -##### [_textfield_exact_string](https://github.com/appium/ruby_lib/blob/06f2e54b4b55df25e624272b5a2cd7b23a000298/lib/appium_lib/ios/element/textfield.rb#L104) ios +##### [_textfield_exact_string](https://github.com/appium/ruby_lib/blob/3060ef3bf06c19a79731a49985efa75c3337dd27/lib/appium_lib/ios/element/textfield.rb#L104) ios > def _textfield_exact_string(value) Appium -- -##### [_textfield_contains_string](https://github.com/appium/ruby_lib/blob/06f2e54b4b55df25e624272b5a2cd7b23a000298/lib/appium_lib/ios/element/textfield.rb#L111) ios +##### [_textfield_contains_string](https://github.com/appium/ruby_lib/blob/3060ef3bf06c19a79731a49985efa75c3337dd27/lib/appium_lib/ios/element/textfield.rb#L111) ios > def _textfield_contains_string(value) Appium -- -##### [static_text_class](https://github.com/appium/ruby_lib/blob/06f2e54b4b55df25e624272b5a2cd7b23a000298/lib/appium_lib/ios/xcuitest/element/text.rb#L23) ios +##### [static_text_class](https://github.com/appium/ruby_lib/blob/3060ef3bf06c19a79731a49985efa75c3337dd27/lib/appium_lib/ios/xcuitest/element/text.rb#L23) ios > def static_text_class @@ -2596,11 +2574,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[String] Class name for text -- -##### [text](https://github.com/appium/ruby_lib/blob/06f2e54b4b55df25e624272b5a2cd7b23a000298/lib/appium_lib/ios/xcuitest/element/text.rb#L31) ios +##### [text](https://github.com/appium/ruby_lib/blob/3060ef3bf06c19a79731a49985efa75c3337dd27/lib/appium_lib/ios/xcuitest/element/text.rb#L31) 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. @@ -2613,11 +2591,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[UIA_STATIC_TEXT|XCUIELEMENT_TYPE_STATIC_TEXT] -- -##### [texts](https://github.com/appium/ruby_lib/blob/06f2e54b4b55df25e624272b5a2cd7b23a000298/lib/appium_lib/ios/xcuitest/element/text.rb#L41) ios +##### [texts](https://github.com/appium/ruby_lib/blob/3060ef3bf06c19a79731a49985efa75c3337dd27/lib/appium_lib/ios/xcuitest/element/text.rb#L41) ios > def texts(value = false) Find all UIAStaticTexts|XCUIElementTypeStaticTexts containing value. If value is omitted, all UIAStaticTexts|XCUIElementTypeStaticTexts are returned @@ -2630,11 +2608,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Array<UIA_STATIC_TEXT|XCUIELEMENT_TYPE_STATIC_TEXT>] -- -##### [first_text](https://github.com/appium/ruby_lib/blob/06f2e54b4b55df25e624272b5a2cd7b23a000298/lib/appium_lib/ios/xcuitest/element/text.rb#L50) ios +##### [first_text](https://github.com/appium/ruby_lib/blob/3060ef3bf06c19a79731a49985efa75c3337dd27/lib/appium_lib/ios/xcuitest/element/text.rb#L50) ios > def first_text Find the first UIAStaticText|XCUIElementTypeStaticText. @@ -2642,11 +2620,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[UIA_STATIC_TEXT|XCUIELEMENT_TYPE_STATIC_TEXT] -- -##### [last_text](https://github.com/appium/ruby_lib/blob/06f2e54b4b55df25e624272b5a2cd7b23a000298/lib/appium_lib/ios/xcuitest/element/text.rb#L56) ios +##### [last_text](https://github.com/appium/ruby_lib/blob/3060ef3bf06c19a79731a49985efa75c3337dd27/lib/appium_lib/ios/xcuitest/element/text.rb#L56) ios > def last_text Find the last UIAStaticText|XCUIElementTypeStaticText. @@ -2654,11 +2632,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[UIA_STATIC_TEXT|XCUIELEMENT_TYPE_STATIC_TEXT] -- -##### [text_exact](https://github.com/appium/ruby_lib/blob/06f2e54b4b55df25e624272b5a2cd7b23a000298/lib/appium_lib/ios/xcuitest/element/text.rb#L63) ios +##### [text_exact](https://github.com/appium/ruby_lib/blob/3060ef3bf06c19a79731a49985efa75c3337dd27/lib/appium_lib/ios/xcuitest/element/text.rb#L63) ios > def text_exact(value) Find the first UIAStaticText|XCUIElementTypeStaticText that exactly matches value. @@ -2670,11 +2648,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[UIA_STATIC_TEXT|XCUIELEMENT_TYPE_STATIC_TEXT] -- -##### [texts_exact](https://github.com/appium/ruby_lib/blob/06f2e54b4b55df25e624272b5a2cd7b23a000298/lib/appium_lib/ios/xcuitest/element/text.rb#L70) ios +##### [texts_exact](https://github.com/appium/ruby_lib/blob/3060ef3bf06c19a79731a49985efa75c3337dd27/lib/appium_lib/ios/xcuitest/element/text.rb#L70) ios > def texts_exact(value) Find all UIAStaticTexts|XCUIElementTypeStaticTexts that exactly match value. @@ -2686,11 +2664,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Array<UIA_STATIC_TEXT|XCUIELEMENT_TYPE_STATIC_TEXT>] -- -##### [xcuitest_source](https://github.com/appium/ruby_lib/blob/06f2e54b4b55df25e624272b5a2cd7b23a000298/lib/appium_lib/ios/xcuitest/command/source.rb#L25) ios +##### [xcuitest_source](https://github.com/appium/ruby_lib/blob/3060ef3bf06c19a79731a49985efa75c3337dd27/lib/appium_lib/ios/xcuitest/command/source.rb#L25) ios > def xcuitest_source(format: :xml) @@ -2702,11 +2680,11 @@ xcuitest_source format: :json ``` -- -##### [button_class](https://github.com/appium/ruby_lib/blob/06f2e54b4b55df25e624272b5a2cd7b23a000298/lib/appium_lib/ios/xcuitest/element/button.rb#L23) ios +##### [button_class](https://github.com/appium/ruby_lib/blob/3060ef3bf06c19a79731a49985efa75c3337dd27/lib/appium_lib/ios/xcuitest/element/button.rb#L23) ios > def button_class @@ -2714,11 +2692,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[String] Class name for button -- -##### [button](https://github.com/appium/ruby_lib/blob/06f2e54b4b55df25e624272b5a2cd7b23a000298/lib/appium_lib/ios/xcuitest/element/button.rb#L31) ios +##### [button](https://github.com/appium/ruby_lib/blob/3060ef3bf06c19a79731a49985efa75c3337dd27/lib/appium_lib/ios/xcuitest/element/button.rb#L31) 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. @@ -2731,11 +2709,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[UIA_BUTTON|XCUIELEMENT_TYPE_BUTTON] -- -##### [buttons](https://github.com/appium/ruby_lib/blob/06f2e54b4b55df25e624272b5a2cd7b23a000298/lib/appium_lib/ios/xcuitest/element/button.rb#L42) ios +##### [buttons](https://github.com/appium/ruby_lib/blob/3060ef3bf06c19a79731a49985efa75c3337dd27/lib/appium_lib/ios/xcuitest/element/button.rb#L42) ios > def buttons(value = false) Find all UIAButtons|XCUIElementTypeButtons containing value. If value is omitted, all UIAButtons|XCUIElementTypeButtons are returned. @@ -2748,11 +2726,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Array<UIA_BUTTON|XCUIELEMENT_TYPE_BUTTON>] -- -##### [first_button](https://github.com/appium/ruby_lib/blob/06f2e54b4b55df25e624272b5a2cd7b23a000298/lib/appium_lib/ios/xcuitest/element/button.rb#L51) ios +##### [first_button](https://github.com/appium/ruby_lib/blob/3060ef3bf06c19a79731a49985efa75c3337dd27/lib/appium_lib/ios/xcuitest/element/button.rb#L51) ios > def first_button Find the first UIAButton|XCUIElementTypeButton. @@ -2760,11 +2738,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[UIA_BUTTON|XCUIELEMENT_TYPE_BUTTON] -- -##### [last_button](https://github.com/appium/ruby_lib/blob/06f2e54b4b55df25e624272b5a2cd7b23a000298/lib/appium_lib/ios/xcuitest/element/button.rb#L59) ios +##### [last_button](https://github.com/appium/ruby_lib/blob/3060ef3bf06c19a79731a49985efa75c3337dd27/lib/appium_lib/ios/xcuitest/element/button.rb#L59) ios > def last_button TODO: add documentation regarding previous element. Previous UIAElement is differ from UIAButton|XCUIElementTypeButton. So, the results are different. @@ -2774,11 +2752,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[UIA_BUTTON|XCUIELEMENT_TYPE_BUTTON] -- -##### [button_exact](https://github.com/appium/ruby_lib/blob/06f2e54b4b55df25e624272b5a2cd7b23a000298/lib/appium_lib/ios/xcuitest/element/button.rb#L66) ios +##### [button_exact](https://github.com/appium/ruby_lib/blob/3060ef3bf06c19a79731a49985efa75c3337dd27/lib/appium_lib/ios/xcuitest/element/button.rb#L66) ios > def button_exact(value) Find the first UIAButton|XCUIElementTypeButton that exactly matches value. @@ -2790,11 +2768,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[UIA_BUTTON|XCUIELEMENT_TYPE_BUTTON] -- -##### [buttons_exact](https://github.com/appium/ruby_lib/blob/06f2e54b4b55df25e624272b5a2cd7b23a000298/lib/appium_lib/ios/xcuitest/element/button.rb#L73) ios +##### [buttons_exact](https://github.com/appium/ruby_lib/blob/3060ef3bf06c19a79731a49985efa75c3337dd27/lib/appium_lib/ios/xcuitest/element/button.rb#L73) ios > def buttons_exact(value) Find all UIAButtons|XCUIElementTypeButtons that exactly match value. @@ -2806,11 +2784,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Array<UIA_BUTTON|XCUIELEMENT_TYPE_BUTTON>] -- -##### [find](https://github.com/appium/ruby_lib/blob/06f2e54b4b55df25e624272b5a2cd7b23a000298/lib/appium_lib/ios/xcuitest/element/generic.rb#L22) ios +##### [find](https://github.com/appium/ruby_lib/blob/3060ef3bf06c19a79731a49985efa75c3337dd27/lib/appium_lib/ios/xcuitest/element/generic.rb#L22) ios > def find(value) Find the first element containing value @@ -2822,11 +2800,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Element] -- -##### [finds](https://github.com/appium/ruby_lib/blob/06f2e54b4b55df25e624272b5a2cd7b23a000298/lib/appium_lib/ios/xcuitest/element/generic.rb#L29) ios +##### [finds](https://github.com/appium/ruby_lib/blob/3060ef3bf06c19a79731a49985efa75c3337dd27/lib/appium_lib/ios/xcuitest/element/generic.rb#L29) ios > def finds(value) Find all elements containing value @@ -2838,11 +2816,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Array<Element>] -- -##### [find_exact](https://github.com/appium/ruby_lib/blob/06f2e54b4b55df25e624272b5a2cd7b23a000298/lib/appium_lib/ios/xcuitest/element/generic.rb#L37) ios +##### [find_exact](https://github.com/appium/ruby_lib/blob/3060ef3bf06c19a79731a49985efa75c3337dd27/lib/appium_lib/ios/xcuitest/element/generic.rb#L37) ios > def find_exact(value) Find the first element exactly matching value @@ -2854,11 +2832,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Element] -- -##### [finds_exact](https://github.com/appium/ruby_lib/blob/06f2e54b4b55df25e624272b5a2cd7b23a000298/lib/appium_lib/ios/xcuitest/element/generic.rb#L44) ios +##### [finds_exact](https://github.com/appium/ruby_lib/blob/3060ef3bf06c19a79731a49985efa75c3337dd27/lib/appium_lib/ios/xcuitest/element/generic.rb#L44) ios > def finds_exact(value) Find all elements exactly matching value @@ -2870,27 +2848,27 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Array<Element>] -- -##### [raise_error_if_no_element](https://github.com/appium/ruby_lib/blob/06f2e54b4b55df25e624272b5a2cd7b23a000298/lib/appium_lib/ios/xcuitest/element/generic.rb#L51) ios +##### [raise_error_if_no_element](https://github.com/appium/ruby_lib/blob/3060ef3bf06c19a79731a49985efa75c3337dd27/lib/appium_lib/ios/xcuitest/element/generic.rb#L51) ios > def raise_error_if_no_element(element) -- -##### [select_visible_elements](https://github.com/appium/ruby_lib/blob/06f2e54b4b55df25e624272b5a2cd7b23a000298/lib/appium_lib/ios/xcuitest/element/generic.rb#L59) ios +##### [select_visible_elements](https://github.com/appium/ruby_lib/blob/3060ef3bf06c19a79731a49985efa75c3337dd27/lib/appium_lib/ios/xcuitest/element/generic.rb#L59) ios > def select_visible_elements(elements) Return visible elements. -- -##### [swipe](https://github.com/appium/ruby_lib/blob/06f2e54b4b55df25e624272b5a2cd7b23a000298/lib/appium_lib/ios/xcuitest/command/gestures.rb#L25) ios +##### [swipe](https://github.com/appium/ruby_lib/blob/3060ef3bf06c19a79731a49985efa75c3337dd27/lib/appium_lib/ios/xcuitest/command/gestures.rb#L25) ios > def swipe(direction:, element: nil) @@ -2900,11 +2878,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Hash] opts - a customizable set of options -- -##### [scroll](https://github.com/appium/ruby_lib/blob/06f2e54b4b55df25e624272b5a2cd7b23a000298/lib/appium_lib/ios/xcuitest/command/gestures.rb#L46) ios +##### [scroll](https://github.com/appium/ruby_lib/blob/3060ef3bf06c19a79731a49985efa75c3337dd27/lib/appium_lib/ios/xcuitest/command/gestures.rb#L46) ios > def scroll(direction:, distance: nil, name: nil, element: nil, to_visible: nil, predicate_string: nil) rubocop:disable Metrics/ParameterLists @@ -2914,11 +2892,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Hash] opts - a customizable set of options -- -##### [pinch](https://github.com/appium/ruby_lib/blob/06f2e54b4b55df25e624272b5a2cd7b23a000298/lib/appium_lib/ios/xcuitest/command/gestures.rb#L67) ios +##### [pinch](https://github.com/appium/ruby_lib/blob/3060ef3bf06c19a79731a49985efa75c3337dd27/lib/appium_lib/ios/xcuitest/command/gestures.rb#L67) ios > def pinch(scale:, velocity: 1.0, element: nil) @@ -2930,11 +2908,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Hash] opts - a customizable set of options -- -##### [double_tap](https://github.com/appium/ruby_lib/blob/06f2e54b4b55df25e624272b5a2cd7b23a000298/lib/appium_lib/ios/xcuitest/command/gestures.rb#L82) ios +##### [double_tap](https://github.com/appium/ruby_lib/blob/3060ef3bf06c19a79731a49985efa75c3337dd27/lib/appium_lib/ios/xcuitest/command/gestures.rb#L82) ios > def double_tap(x: nil, y: nil, element: nil) @@ -2946,11 +2924,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Hash] opts - a customizable set of options -- -##### [touch_and_hold](https://github.com/appium/ruby_lib/blob/06f2e54b4b55df25e624272b5a2cd7b23a000298/lib/appium_lib/ios/xcuitest/command/gestures.rb#L99) ios +##### [touch_and_hold](https://github.com/appium/ruby_lib/blob/3060ef3bf06c19a79731a49985efa75c3337dd27/lib/appium_lib/ios/xcuitest/command/gestures.rb#L99) ios > def touch_and_hold(x: nil, y: nil, element: nil, duration: 1.0) @@ -2964,11 +2942,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Hash] opts - a customizable set of options -- -##### [two_finger_tap](https://github.com/appium/ruby_lib/blob/06f2e54b4b55df25e624272b5a2cd7b23a000298/lib/appium_lib/ios/xcuitest/command/gestures.rb#L112) ios +##### [two_finger_tap](https://github.com/appium/ruby_lib/blob/3060ef3bf06c19a79731a49985efa75c3337dd27/lib/appium_lib/ios/xcuitest/command/gestures.rb#L112) ios > def two_finger_tap(element:) @@ -2980,11 +2958,11 @@ two_finger_tap element: find_element(:accessibility_id, "some item") ``` -- -##### [one_finger_tap](https://github.com/appium/ruby_lib/blob/06f2e54b4b55df25e624272b5a2cd7b23a000298/lib/appium_lib/ios/xcuitest/command/gestures.rb#L127) ios +##### [one_finger_tap](https://github.com/appium/ruby_lib/blob/3060ef3bf06c19a79731a49985efa75c3337dd27/lib/appium_lib/ios/xcuitest/command/gestures.rb#L127) ios > def one_finger_tap(x:, y:, element: nil) @@ -2996,11 +2974,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/06f2e54b4b55df25e624272b5a2cd7b23a000298/lib/appium_lib/ios/xcuitest/command/gestures.rb#L147) ios +##### [drag_from_to_for_duration](https://github.com/appium/ruby_lib/blob/3060ef3bf06c19a79731a49985efa75c3337dd27/lib/appium_lib/ios/xcuitest/command/gestures.rb#L147) ios > def drag_from_to_for_duration(from_x:, from_y:, to_x:, to_y:, duration: 1.0, element: nil) rubocop:disable Metrics/ParameterLists @@ -3019,11 +2997,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Hash] opts - a customizable set of options -- -##### [select_picker_wheel](https://github.com/appium/ruby_lib/blob/06f2e54b4b55df25e624272b5a2cd7b23a000298/lib/appium_lib/ios/xcuitest/command/gestures.rb#L164) ios +##### [select_picker_wheel](https://github.com/appium/ruby_lib/blob/3060ef3bf06c19a79731a49985efa75c3337dd27/lib/appium_lib/ios/xcuitest/command/gestures.rb#L164) 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 @@ -3036,11 +3014,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Hash] opts - a customizable set of options -- -##### [alert](https://github.com/appium/ruby_lib/blob/06f2e54b4b55df25e624272b5a2cd7b23a000298/lib/appium_lib/ios/xcuitest/command/gestures.rb#L182) ios +##### [alert](https://github.com/appium/ruby_lib/blob/3060ef3bf06c19a79731a49985efa75c3337dd27/lib/appium_lib/ios/xcuitest/command/gestures.rb#L182) ios > def alert(action:, button_label: nil) @@ -3061,11 +3039,11 @@ alert action: "dismiss" ``` -- -##### [text_field_class](https://github.com/appium/ruby_lib/blob/06f2e54b4b55df25e624272b5a2cd7b23a000298/lib/appium_lib/ios/xcuitest/element/textfield.rb#L23) ios +##### [text_field_class](https://github.com/appium/ruby_lib/blob/3060ef3bf06c19a79731a49985efa75c3337dd27/lib/appium_lib/ios/xcuitest/element/textfield.rb#L23) ios > def text_field_class @@ -3073,11 +3051,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[String] Class name for text field -- -##### [secure_text_field_class](https://github.com/appium/ruby_lib/blob/06f2e54b4b55df25e624272b5a2cd7b23a000298/lib/appium_lib/ios/xcuitest/element/textfield.rb#L28) ios +##### [secure_text_field_class](https://github.com/appium/ruby_lib/blob/3060ef3bf06c19a79731a49985efa75c3337dd27/lib/appium_lib/ios/xcuitest/element/textfield.rb#L28) ios > def secure_text_field_class @@ -3085,11 +3063,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[String] Class name for secure text field -- -##### [textfield](https://github.com/appium/ruby_lib/blob/06f2e54b4b55df25e624272b5a2cd7b23a000298/lib/appium_lib/ios/xcuitest/element/textfield.rb#L37) ios +##### [textfield](https://github.com/appium/ruby_lib/blob/3060ef3bf06c19a79731a49985efa75c3337dd27/lib/appium_lib/ios/xcuitest/element/textfield.rb#L37) ios > def textfield(value) Find the first TextField that contains value or by index. Note: Uses XPath @@ -3103,11 +3081,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[TextField] -- -##### [textfields](https://github.com/appium/ruby_lib/blob/06f2e54b4b55df25e624272b5a2cd7b23a000298/lib/appium_lib/ios/xcuitest/element/textfield.rb#L57) ios +##### [textfields](https://github.com/appium/ruby_lib/blob/3060ef3bf06c19a79731a49985efa75c3337dd27/lib/appium_lib/ios/xcuitest/element/textfield.rb#L57) ios > def textfields(value = false) Find all TextFields containing value. If value is omitted, all TextFields are returned. @@ -3120,11 +3098,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Array<TextField>] -- -##### [first_textfield](https://github.com/appium/ruby_lib/blob/06f2e54b4b55df25e624272b5a2cd7b23a000298/lib/appium_lib/ios/xcuitest/element/textfield.rb#L66) ios +##### [first_textfield](https://github.com/appium/ruby_lib/blob/3060ef3bf06c19a79731a49985efa75c3337dd27/lib/appium_lib/ios/xcuitest/element/textfield.rb#L66) ios > def first_textfield Find the first TextField. @@ -3132,11 +3110,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[TextField] -- -##### [last_textfield](https://github.com/appium/ruby_lib/blob/06f2e54b4b55df25e624272b5a2cd7b23a000298/lib/appium_lib/ios/xcuitest/element/textfield.rb#L72) ios +##### [last_textfield](https://github.com/appium/ruby_lib/blob/3060ef3bf06c19a79731a49985efa75c3337dd27/lib/appium_lib/ios/xcuitest/element/textfield.rb#L72) ios > def last_textfield Find the last TextField. @@ -3144,11 +3122,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[TextField] -- -##### [textfield_exact](https://github.com/appium/ruby_lib/blob/06f2e54b4b55df25e624272b5a2cd7b23a000298/lib/appium_lib/ios/xcuitest/element/textfield.rb#L82) ios +##### [textfield_exact](https://github.com/appium/ruby_lib/blob/3060ef3bf06c19a79731a49985efa75c3337dd27/lib/appium_lib/ios/xcuitest/element/textfield.rb#L82) ios > def textfield_exact(value) Find the first TextField that exactly matches value. @@ -3160,11 +3138,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[TextField] -- -##### [textfields_exact](https://github.com/appium/ruby_lib/blob/06f2e54b4b55df25e624272b5a2cd7b23a000298/lib/appium_lib/ios/xcuitest/element/textfield.rb#L89) ios +##### [textfields_exact](https://github.com/appium/ruby_lib/blob/3060ef3bf06c19a79731a49985efa75c3337dd27/lib/appium_lib/ios/xcuitest/element/textfield.rb#L89) ios > def textfields_exact(value) Find all TextFields that exactly match value. @@ -3176,11 +3154,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Array<TextField>] -- -##### [set_pasteboard](https://github.com/appium/ruby_lib/blob/06f2e54b4b55df25e624272b5a2cd7b23a000298/lib/appium_lib/ios/xcuitest/command/pasteboard.rb#L26) ios +##### [set_pasteboard](https://github.com/appium/ruby_lib/blob/3060ef3bf06c19a79731a49985efa75c3337dd27/lib/appium_lib/ios/xcuitest/command/pasteboard.rb#L26) ios > def set_pasteboard(content:, encoding: nil) @@ -3191,11 +3169,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Hash] opts - a customizable set of options -- -##### [get_pasteboard](https://github.com/appium/ruby_lib/blob/06f2e54b4b55df25e624272b5a2cd7b23a000298/lib/appium_lib/ios/xcuitest/command/pasteboard.rb#L38) ios +##### [get_pasteboard](https://github.com/appium/ruby_lib/blob/3060ef3bf06c19a79731a49985efa75c3337dd27/lib/appium_lib/ios/xcuitest/command/pasteboard.rb#L38) ios > def get_pasteboard(encoding: nil) @@ -3203,11 +3181,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Hash] opts - a customizable set of options -- -##### [install_certificate](https://github.com/appium/ruby_lib/blob/06f2e54b4b55df25e624272b5a2cd7b23a000298/lib/appium_lib/ios/xcuitest/command/certificate.rb#L32) ios +##### [install_certificate](https://github.com/appium/ruby_lib/blob/3060ef3bf06c19a79731a49985efa75c3337dd27/lib/appium_lib/ios/xcuitest/command/certificate.rb#L32) ios > def install_certificate(cer_file:) Generates Apple's over-the-air configuration profile for certificate deployment based on the given PEM certificate content. @@ -3218,19 +3196,19 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[string] cer_file - The content of the certificate file. -- -##### [xcuitest_get_contexts](https://github.com/appium/ruby_lib/blob/06f2e54b4b55df25e624272b5a2cd7b23a000298/lib/appium_lib/ios/xcuitest/command/get_context.rb#L28) ios +##### [xcuitest_get_contexts](https://github.com/appium/ruby_lib/blob/3060ef3bf06c19a79731a49985efa75c3337dd27/lib/appium_lib/ios/xcuitest/command/get_context.rb#L28) ios > def xcuitest_get_contexts Get contexts -- -##### [xcuitest_install_app](https://github.com/appium/ruby_lib/blob/06f2e54b4b55df25e624272b5a2cd7b23a000298/lib/appium_lib/ios/xcuitest/command/multi_app_handler.rb#L35) ios +##### [xcuitest_install_app](https://github.com/appium/ruby_lib/blob/3060ef3bf06c19a79731a49985efa75c3337dd27/lib/appium_lib/ios/xcuitest/command/multi_app_handler.rb#L35) ios > def xcuitest_install_app(app:) Installs given application to the device under test. If the same application is already installed then it's going to be installed over it, which allows to test upgrades. @@ -3246,11 +3224,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[] {} -- -##### [xcuitest_app_installed?](https://github.com/appium/ruby_lib/blob/06f2e54b4b55df25e624272b5a2cd7b23a000298/lib/appium_lib/ios/xcuitest/command/multi_app_handler.rb#L48) ios +##### [xcuitest_app_installed?](https://github.com/appium/ruby_lib/blob/3060ef3bf06c19a79731a49985efa75c3337dd27/lib/appium_lib/ios/xcuitest/command/multi_app_handler.rb#L48) ios > def xcuitest_app_installed?(bundle_id:) Verifies whether the application with given bundle identifier is installed on the device. @@ -3262,11 +3240,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[boolean] -- -##### [xcuitest_remove_app](https://github.com/appium/ruby_lib/blob/06f2e54b4b55df25e624272b5a2cd7b23a000298/lib/appium_lib/ios/xcuitest/command/multi_app_handler.rb#L62) ios +##### [xcuitest_remove_app](https://github.com/appium/ruby_lib/blob/3060ef3bf06c19a79731a49985efa75c3337dd27/lib/appium_lib/ios/xcuitest/command/multi_app_handler.rb#L62) ios > def xcuitest_remove_app(bundle_id:) Uninstalls an existing application from the device under test. This endpoint does not verify whether the application is already installed or not before uninstalling it. @@ -3279,11 +3257,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[] {} -- -##### [xcuitest_launch_app](https://github.com/appium/ruby_lib/blob/06f2e54b4b55df25e624272b5a2cd7b23a000298/lib/appium_lib/ios/xcuitest/command/multi_app_handler.rb#L76) ios +##### [xcuitest_launch_app](https://github.com/appium/ruby_lib/blob/3060ef3bf06c19a79731a49985efa75c3337dd27/lib/appium_lib/ios/xcuitest/command/multi_app_handler.rb#L76) ios > def xcuitest_launch_app(bundle_id:) Executes an existing application on the device. If the application is already running then it will be brought to the foreground. @@ -3296,11 +3274,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[] {} -- -##### [xcuitest_terminate_app](https://github.com/appium/ruby_lib/blob/06f2e54b4b55df25e624272b5a2cd7b23a000298/lib/appium_lib/ios/xcuitest/command/multi_app_handler.rb#L91) ios +##### [xcuitest_terminate_app](https://github.com/appium/ruby_lib/blob/3060ef3bf06c19a79731a49985efa75c3337dd27/lib/appium_lib/ios/xcuitest/command/multi_app_handler.rb#L91) ios > def xcuitest_terminate_app(bundle_id:) Terminates an existing application on the device. If the application is not running then the returned result will be false, otherwise true. @@ -3313,11 +3291,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[] {} -- -##### [xcuitest_query_app_status](https://github.com/appium/ruby_lib/blob/06f2e54b4b55df25e624272b5a2cd7b23a000298/lib/appium_lib/ios/xcuitest/command/multi_app_handler.rb#L112) ios +##### [xcuitest_query_app_status](https://github.com/appium/ruby_lib/blob/3060ef3bf06c19a79731a49985efa75c3337dd27/lib/appium_lib/ios/xcuitest/command/multi_app_handler.rb#L112) ios > def xcuitest_query_app_status(bundle_id:) Get the status of an existing application on the device. State: @@ -3337,10 +3315,10 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[0|1|2|3|4] A number of the state -- -##### [xcuitest_activate_app](https://github.com/appium/ruby_lib/blob/06f2e54b4b55df25e624272b5a2cd7b23a000298/lib/appium_lib/ios/xcuitest/command/multi_app_handler.rb#L127) ios +##### [xcuitest_activate_app](https://github.com/appium/ruby_lib/blob/3060ef3bf06c19a79731a49985efa75c3337dd27/lib/appium_lib/ios/xcuitest/command/multi_app_handler.rb#L127) ios > def xcuitest_activate_app(bundle_id:) Activates an existing application on the device under test and moves it to the foreground. The application should be already running in order to activate it.