docs/ios_docs.md in appium_lib-9.3.4 vs docs/ios_docs.md in appium_lib-9.3.5

- old
+ new

@@ -1,6 +1,6 @@ -##### [load_settings](https://github.com/appium/ruby_lib/blob/02da3389a76ed75e42cc8f8f2018dc61cc93c70c/lib/appium_lib/driver.rb#L75) +##### [load_settings](https://github.com/appium/ruby_lib/blob/11cdf97bf9c4a90ac4e7c7dcf518cfb3fcd99ef2/lib/appium_lib/driver.rb#L75) > def self.load_settings(opts = {}) Load arbitrary text ([toml format](https://github.com/toml-lang/toml)) The toml is parsed by https://github.com/fbernier/tomlrb . @@ -25,11 +25,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[hash] the symbolized hash with updated :app and :require keys -- -##### [load_appium_txt](https://github.com/appium/ruby_lib/blob/02da3389a76ed75e42cc8f8f2018dc61cc93c70c/lib/appium_lib/driver.rb#L111) +##### [load_appium_txt](https://github.com/appium/ruby_lib/blob/11cdf97bf9c4a90ac4e7c7dcf518cfb3fcd99ef2/lib/appium_lib/driver.rb#L111) > def self.load_settings(opts = {}) Load arbitrary text ([toml format](https://github.com/toml-lang/toml)) The toml is parsed by https://github.com/fbernier/tomlrb . @@ -55,11 +55,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[hash] the symbolized hash with updated :app and :require keys -- -##### [expand_required_files](https://github.com/appium/ruby_lib/blob/02da3389a76ed75e42cc8f8f2018dc61cc93c70c/lib/appium_lib/driver.rb#L117) +##### [expand_required_files](https://github.com/appium/ruby_lib/blob/11cdf97bf9c4a90ac4e7c7dcf518cfb3fcd99ef2/lib/appium_lib/driver.rb#L117) > def self.expand_required_files(base_dir, file_paths) @@ -73,22 +73,22 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Array] list of require files as an array, nil if require doesn't exist -- -##### [symbolize_keys](https://github.com/appium/ruby_lib/blob/02da3389a76ed75e42cc8f8f2018dc61cc93c70c/lib/appium_lib/driver.rb#L149) +##### [symbolize_keys](https://github.com/appium/ruby_lib/blob/11cdf97bf9c4a90ac4e7c7dcf518cfb3fcd99ef2/lib/appium_lib/driver.rb#L149) > def self.symbolize_keys(hash) convert all keys (including nested) to symbols based on deep_symbolize_keys & deep_transform_keys from rails https://github.com/rails/docrails/blob/a3b1105ada3da64acfa3843b164b14b734456a50/activesupport/lib/active_support/core_ext/hash/keys.rb#L84 -- -##### [promote_singleton_appium_methods](https://github.com/appium/ruby_lib/blob/02da3389a76ed75e42cc8f8f2018dc61cc93c70c/lib/appium_lib/driver.rb#L170) +##### [promote_singleton_appium_methods](https://github.com/appium/ruby_lib/blob/11cdf97bf9c4a90ac4e7c7dcf518cfb3fcd99ef2/lib/appium_lib/driver.rb#L170) > def self.promote_singleton_appium_methods(modules) This method is intended to work with page objects that share a common module. For example, Page::HomePage, Page::SignIn @@ -102,11 +102,11 @@ that module are promoted on. otherwise, the array of modules will be used as the promotion target. -- -##### [promote_appium_methods](https://github.com/appium/ruby_lib/blob/02da3389a76ed75e42cc8f8f2018dc61cc93c70c/lib/appium_lib/driver.rb#L223) +##### [promote_appium_methods](https://github.com/appium/ruby_lib/blob/11cdf97bf9c4a90ac4e7c7dcf518cfb3fcd99ef2/lib/appium_lib/driver.rb#L223) > def self.promote_appium_methods(class_array) Promote appium methods to class instance methods @@ -132,11 +132,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Array<Class>] class_array - An array of classes -- -##### [init_caps_for_appium](https://github.com/appium/ruby_lib/blob/02da3389a76ed75e42cc8f8f2018dc61cc93c70c/lib/appium_lib/driver.rb#L258) +##### [init_caps_for_appium](https://github.com/appium/ruby_lib/blob/11cdf97bf9c4a90ac4e7c7dcf518cfb3fcd99ef2/lib/appium_lib/driver.rb#L258) > def self.init_caps_for_appium(opts_caps = {}) except for browser_name, default capability is equal to ::Selenium::WebDriver::Remote::Capabilities.firefox Because Selenium::WebDriver::Remote::Bridge uses Capabilities.firefox by default @@ -151,75 +151,75 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Selenium::WebDriver::Remote::Capabilities] Return instance of Selenium::WebDriver::Remote::Capabilities -- -##### [global_webdriver_http_sleep](https://github.com/appium/ruby_lib/blob/02da3389a76ed75e42cc8f8f2018dc61cc93c70c/lib/appium_lib/driver.rb#L276) +##### [global_webdriver_http_sleep](https://github.com/appium/ruby_lib/blob/11cdf97bf9c4a90ac4e7c7dcf518cfb3fcd99ef2/lib/appium_lib/driver.rb#L276) > 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/02da3389a76ed75e42cc8f8f2018dc61cc93c70c/lib/appium_lib/driver.rb#L276) +##### [global_webdriver_http_sleep=](https://github.com/appium/ruby_lib/blob/11cdf97bf9c4a90ac4e7c7dcf518cfb3fcd99ef2/lib/appium_lib/driver.rb#L276) > def global_webdriver_http_sleep=(value) The amount to sleep in seconds before every webdriver http call. -- -##### [caps](https://github.com/appium/ruby_lib/blob/02da3389a76ed75e42cc8f8f2018dc61cc93c70c/lib/appium_lib/driver.rb#L278) +##### [caps](https://github.com/appium/ruby_lib/blob/11cdf97bf9c4a90ac4e7c7dcf518cfb3fcd99ef2/lib/appium_lib/driver.rb#L278) > def caps Selenium webdriver capabilities -- -##### [caps=](https://github.com/appium/ruby_lib/blob/02da3389a76ed75e42cc8f8f2018dc61cc93c70c/lib/appium_lib/driver.rb#L278) +##### [caps=](https://github.com/appium/ruby_lib/blob/11cdf97bf9c4a90ac4e7c7dcf518cfb3fcd99ef2/lib/appium_lib/driver.rb#L278) > def caps=(value) Selenium webdriver capabilities -- -##### [custom_url](https://github.com/appium/ruby_lib/blob/02da3389a76ed75e42cc8f8f2018dc61cc93c70c/lib/appium_lib/driver.rb#L280) +##### [custom_url](https://github.com/appium/ruby_lib/blob/11cdf97bf9c4a90ac4e7c7dcf518cfb3fcd99ef2/lib/appium_lib/driver.rb#L280) > def custom_url Custom URL for the selenium server -- -##### [custom_url=](https://github.com/appium/ruby_lib/blob/02da3389a76ed75e42cc8f8f2018dc61cc93c70c/lib/appium_lib/driver.rb#L280) +##### [custom_url=](https://github.com/appium/ruby_lib/blob/11cdf97bf9c4a90ac4e7c7dcf518cfb3fcd99ef2/lib/appium_lib/driver.rb#L280) > def custom_url=(value) Custom URL for the selenium server -- -##### [export_session](https://github.com/appium/ruby_lib/blob/02da3389a76ed75e42cc8f8f2018dc61cc93c70c/lib/appium_lib/driver.rb#L282) +##### [export_session](https://github.com/appium/ruby_lib/blob/11cdf97bf9c4a90ac4e7c7dcf518cfb3fcd99ef2/lib/appium_lib/driver.rb#L282) > def export_session Export session id to textfile in /tmp for 3rd party tools -- -##### [export_session=](https://github.com/appium/ruby_lib/blob/02da3389a76ed75e42cc8f8f2018dc61cc93c70c/lib/appium_lib/driver.rb#L282) +##### [export_session=](https://github.com/appium/ruby_lib/blob/11cdf97bf9c4a90ac4e7c7dcf518cfb3fcd99ef2/lib/appium_lib/driver.rb#L282) > def export_session=(value) Export session id to textfile in /tmp for 3rd party tools -- -##### [default_wait](https://github.com/appium/ruby_lib/blob/02da3389a76ed75e42cc8f8f2018dc61cc93c70c/lib/appium_lib/driver.rb#L287) +##### [default_wait](https://github.com/appium/ruby_lib/blob/11cdf97bf9c4a90ac4e7c7dcf518cfb3fcd99ef2/lib/appium_lib/driver.rb#L287) > def default_wait Default wait time for elements to appear Returns the default client side wait. @@ -229,140 +229,140 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Integer] -- -##### [sauce_username](https://github.com/appium/ruby_lib/blob/02da3389a76ed75e42cc8f8f2018dc61cc93c70c/lib/appium_lib/driver.rb#L289) +##### [sauce_username](https://github.com/appium/ruby_lib/blob/11cdf97bf9c4a90ac4e7c7dcf518cfb3fcd99ef2/lib/appium_lib/driver.rb#L289) > def sauce_username Username for use on Sauce Labs. Set `false` to disable Sauce, even when SAUCE_USERNAME is in ENV. -- -##### [sauce_username=](https://github.com/appium/ruby_lib/blob/02da3389a76ed75e42cc8f8f2018dc61cc93c70c/lib/appium_lib/driver.rb#L289) +##### [sauce_username=](https://github.com/appium/ruby_lib/blob/11cdf97bf9c4a90ac4e7c7dcf518cfb3fcd99ef2/lib/appium_lib/driver.rb#L289) > def sauce_username=(value) Username for use on Sauce Labs. Set `false` to disable Sauce, even when SAUCE_USERNAME is in ENV. -- -##### [sauce_access_key](https://github.com/appium/ruby_lib/blob/02da3389a76ed75e42cc8f8f2018dc61cc93c70c/lib/appium_lib/driver.rb#L291) +##### [sauce_access_key](https://github.com/appium/ruby_lib/blob/11cdf97bf9c4a90ac4e7c7dcf518cfb3fcd99ef2/lib/appium_lib/driver.rb#L291) > def sauce_access_key Access Key for use on Sauce Labs. Set `false` to disable Sauce, even when SAUCE_ACCESS_KEY is in ENV. -- -##### [sauce_access_key=](https://github.com/appium/ruby_lib/blob/02da3389a76ed75e42cc8f8f2018dc61cc93c70c/lib/appium_lib/driver.rb#L291) +##### [sauce_access_key=](https://github.com/appium/ruby_lib/blob/11cdf97bf9c4a90ac4e7c7dcf518cfb3fcd99ef2/lib/appium_lib/driver.rb#L291) > def sauce_access_key=(value) Access Key for use on Sauce Labs. Set `false` to disable Sauce, even when SAUCE_ACCESS_KEY is in ENV. -- -##### [sauce_endpoint](https://github.com/appium/ruby_lib/blob/02da3389a76ed75e42cc8f8f2018dc61cc93c70c/lib/appium_lib/driver.rb#L293) +##### [sauce_endpoint](https://github.com/appium/ruby_lib/blob/11cdf97bf9c4a90ac4e7c7dcf518cfb3fcd99ef2/lib/appium_lib/driver.rb#L293) > def sauce_endpoint Override the Sauce Appium endpoint to allow e.g. TestObject tests -- -##### [sauce_endpoint=](https://github.com/appium/ruby_lib/blob/02da3389a76ed75e42cc8f8f2018dc61cc93c70c/lib/appium_lib/driver.rb#L293) +##### [sauce_endpoint=](https://github.com/appium/ruby_lib/blob/11cdf97bf9c4a90ac4e7c7dcf518cfb3fcd99ef2/lib/appium_lib/driver.rb#L293) > def sauce_endpoint=(value) Override the Sauce Appium endpoint to allow e.g. TestObject tests -- -##### [appium_port](https://github.com/appium/ruby_lib/blob/02da3389a76ed75e42cc8f8f2018dc61cc93c70c/lib/appium_lib/driver.rb#L295) +##### [appium_port](https://github.com/appium/ruby_lib/blob/11cdf97bf9c4a90ac4e7c7dcf518cfb3fcd99ef2/lib/appium_lib/driver.rb#L295) > def appium_port Appium's server port -- -##### [appium_port=](https://github.com/appium/ruby_lib/blob/02da3389a76ed75e42cc8f8f2018dc61cc93c70c/lib/appium_lib/driver.rb#L295) +##### [appium_port=](https://github.com/appium/ruby_lib/blob/11cdf97bf9c4a90ac4e7c7dcf518cfb3fcd99ef2/lib/appium_lib/driver.rb#L295) > def appium_port=(value) Appium's server port -- -##### [appium_device](https://github.com/appium/ruby_lib/blob/02da3389a76ed75e42cc8f8f2018dc61cc93c70c/lib/appium_lib/driver.rb#L297) +##### [appium_device](https://github.com/appium/ruby_lib/blob/11cdf97bf9c4a90ac4e7c7dcf518cfb3fcd99ef2/lib/appium_lib/driver.rb#L297) > def appium_device Device type to request from the appium server -- -##### [appium_device=](https://github.com/appium/ruby_lib/blob/02da3389a76ed75e42cc8f8f2018dc61cc93c70c/lib/appium_lib/driver.rb#L297) +##### [appium_device=](https://github.com/appium/ruby_lib/blob/11cdf97bf9c4a90ac4e7c7dcf518cfb3fcd99ef2/lib/appium_lib/driver.rb#L297) > def appium_device=(value) Device type to request from the appium server -- -##### [automation_name](https://github.com/appium/ruby_lib/blob/02da3389a76ed75e42cc8f8f2018dc61cc93c70c/lib/appium_lib/driver.rb#L300) +##### [automation_name](https://github.com/appium/ruby_lib/blob/11cdf97bf9c4a90ac4e7c7dcf518cfb3fcd99ef2/lib/appium_lib/driver.rb#L300) > def automation_name Automation name sent to appium server or received from server If automation_name is nil, it is not set both client side and server side. -- -##### [appium_server_status](https://github.com/appium/ruby_lib/blob/02da3389a76ed75e42cc8f8f2018dc61cc93c70c/lib/appium_lib/driver.rb#L302) +##### [appium_server_status](https://github.com/appium/ruby_lib/blob/11cdf97bf9c4a90ac4e7c7dcf518cfb3fcd99ef2/lib/appium_lib/driver.rb#L302) > def appium_server_status Appium's server version -- -##### [appium_debug](https://github.com/appium/ruby_lib/blob/02da3389a76ed75e42cc8f8f2018dc61cc93c70c/lib/appium_lib/driver.rb#L304) +##### [appium_debug](https://github.com/appium/ruby_lib/blob/11cdf97bf9c4a90ac4e7c7dcf518cfb3fcd99ef2/lib/appium_lib/driver.rb#L304) > def appium_debug Boolean debug mode for the Appium Ruby bindings -- -##### [appium_debug=](https://github.com/appium/ruby_lib/blob/02da3389a76ed75e42cc8f8f2018dc61cc93c70c/lib/appium_lib/driver.rb#L304) +##### [appium_debug=](https://github.com/appium/ruby_lib/blob/11cdf97bf9c4a90ac4e7c7dcf518cfb3fcd99ef2/lib/appium_lib/driver.rb#L304) > def appium_debug=(value) Boolean debug mode for the Appium Ruby bindings -- -##### [listener](https://github.com/appium/ruby_lib/blob/02da3389a76ed75e42cc8f8f2018dc61cc93c70c/lib/appium_lib/driver.rb#L306) +##### [listener](https://github.com/appium/ruby_lib/blob/11cdf97bf9c4a90ac4e7c7dcf518cfb3fcd99ef2/lib/appium_lib/driver.rb#L306) > def listener instance of AbstractEventListener for logging support -- -##### [listener=](https://github.com/appium/ruby_lib/blob/02da3389a76ed75e42cc8f8f2018dc61cc93c70c/lib/appium_lib/driver.rb#L306) +##### [listener=](https://github.com/appium/ruby_lib/blob/11cdf97bf9c4a90ac4e7c7dcf518cfb3fcd99ef2/lib/appium_lib/driver.rb#L306) > def listener=(value) instance of AbstractEventListener for logging support -- -##### [driver](https://github.com/appium/ruby_lib/blob/02da3389a76ed75e42cc8f8f2018dc61cc93c70c/lib/appium_lib/driver.rb#L309) +##### [driver](https://github.com/appium/ruby_lib/blob/11cdf97bf9c4a90ac4e7c7dcf518cfb3fcd99ef2/lib/appium_lib/driver.rb#L309) > def driver Returns the driver @@ -370,11 +370,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Driver] the driver -- -##### [http_client](https://github.com/appium/ruby_lib/blob/02da3389a76ed75e42cc8f8f2018dc61cc93c70c/lib/appium_lib/driver.rb#L312) +##### [http_client](https://github.com/appium/ruby_lib/blob/11cdf97bf9c4a90ac4e7c7dcf518cfb3fcd99ef2/lib/appium_lib/driver.rb#L312) > def http_client Return http client called in start_driver() @@ -382,11 +382,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Selenium::WebDriver::Remote::Http::Default] the http client -- -##### [appium_wait_timeout](https://github.com/appium/ruby_lib/blob/02da3389a76ed75e42cc8f8f2018dc61cc93c70c/lib/appium_lib/driver.rb#L317) +##### [appium_wait_timeout](https://github.com/appium/ruby_lib/blob/11cdf97bf9c4a90ac4e7c7dcf518cfb3fcd99ef2/lib/appium_lib/driver.rb#L317) > def appium_wait_timeout Return a time wait timeout Wait time for ::Appium::Common.wait or ::Appium::Common.wait_true. @@ -396,11 +396,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Integer] -- -##### [appium_wait_interval](https://github.com/appium/ruby_lib/blob/02da3389a76ed75e42cc8f8f2018dc61cc93c70c/lib/appium_lib/driver.rb#L322) +##### [appium_wait_interval](https://github.com/appium/ruby_lib/blob/11cdf97bf9c4a90ac4e7c7dcf518cfb3fcd99ef2/lib/appium_lib/driver.rb#L322) > def appium_wait_interval Return a time wait timeout Wait interval time for ::Appium::Common.wait or ::Appium::Common.wait_true. @@ -410,11 +410,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Integer] -- -##### [initialize](https://github.com/appium/ruby_lib/blob/02da3389a76ed75e42cc8f8f2018dc61cc93c70c/lib/appium_lib/driver.rb#L362) +##### [initialize](https://github.com/appium/ruby_lib/blob/11cdf97bf9c4a90ac4e7c7dcf518cfb3fcd99ef2/lib/appium_lib/driver.rb#L362) > def initialize(opts = {}) Creates a new driver @@ -426,19 +426,19 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Driver] -- -##### [driver_attributes](https://github.com/appium/ruby_lib/blob/02da3389a76ed75e42cc8f8f2018dc61cc93c70c/lib/appium_lib/driver.rb#L440) +##### [driver_attributes](https://github.com/appium/ruby_lib/blob/11cdf97bf9c4a90ac4e7c7dcf518cfb3fcd99ef2/lib/appium_lib/driver.rb#L440) > def driver_attributes Returns a hash of the driver attributes -- -##### [device_is_android?](https://github.com/appium/ruby_lib/blob/02da3389a76ed75e42cc8f8f2018dc61cc93c70c/lib/appium_lib/driver.rb#L465) +##### [device_is_android?](https://github.com/appium/ruby_lib/blob/11cdf97bf9c4a90ac4e7c7dcf518cfb3fcd99ef2/lib/appium_lib/driver.rb#L465) > def device_is_android? @@ -446,11 +446,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Boolean] -- -##### [automation_name_is_xcuitest?](https://github.com/appium/ruby_lib/blob/02da3389a76ed75e42cc8f8f2018dc61cc93c70c/lib/appium_lib/driver.rb#L471) +##### [automation_name_is_xcuitest?](https://github.com/appium/ruby_lib/blob/11cdf97bf9c4a90ac4e7c7dcf518cfb3fcd99ef2/lib/appium_lib/driver.rb#L471) > def automation_name_is_xcuitest? Return true if automationName is 'XCUITest' @@ -458,11 +458,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Boolean] -- -##### [check_server_version_xcuitest](https://github.com/appium/ruby_lib/blob/02da3389a76ed75e42cc8f8f2018dc61cc93c70c/lib/appium_lib/driver.rb#L478) +##### [check_server_version_xcuitest](https://github.com/appium/ruby_lib/blob/11cdf97bf9c4a90ac4e7c7dcf518cfb3fcd99ef2/lib/appium_lib/driver.rb#L478) > def check_server_version_xcuitest Return true if the target Appium server is over REQUIRED_VERSION_XCUITEST. If the Appium server is under REQUIRED_VERSION_XCUITEST, then error is raised. @@ -471,11 +471,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Boolean] -- -##### [appium_server_version](https://github.com/appium/ruby_lib/blob/02da3389a76ed75e42cc8f8f2018dc61cc93c70c/lib/appium_lib/driver.rb#L497) +##### [appium_server_version](https://github.com/appium/ruby_lib/blob/11cdf97bf9c4a90ac4e7c7dcf518cfb3fcd99ef2/lib/appium_lib/driver.rb#L497) > def appium_server_version Returns the server's version info @@ -492,11 +492,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Hash] -- -##### [appium_client_version](https://github.com/appium/ruby_lib/blob/02da3389a76ed75e42cc8f8f2018dc61cc93c70c/lib/appium_lib/driver.rb#L510) +##### [appium_client_version](https://github.com/appium/ruby_lib/blob/11cdf97bf9c4a90ac4e7c7dcf518cfb3fcd99ef2/lib/appium_lib/driver.rb#L510) > def appium_client_version Returns the client's version info @@ -510,11 +510,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Hash] -- -##### [absolute_app_path](https://github.com/appium/ruby_lib/blob/02da3389a76ed75e42cc8f8f2018dc61cc93c70c/lib/appium_lib/driver.rb#L522) +##### [absolute_app_path](https://github.com/appium/ruby_lib/blob/11cdf97bf9c4a90ac4e7c7dcf518cfb3fcd99ef2/lib/appium_lib/driver.rb#L522) > def self.absolute_app_path(opts) Converts app_path to an absolute path. @@ -527,11 +527,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[String] APP_PATH as an absolute path -- -##### [server_url](https://github.com/appium/ruby_lib/blob/02da3389a76ed75e42cc8f8f2018dc61cc93c70c/lib/appium_lib/driver.rb#L555) +##### [server_url](https://github.com/appium/ruby_lib/blob/11cdf97bf9c4a90ac4e7c7dcf518cfb3fcd99ef2/lib/appium_lib/driver.rb#L555) > def server_url Get the server url @@ -539,11 +539,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[String] the server url -- -##### [restart](https://github.com/appium/ruby_lib/blob/02da3389a76ed75e42cc8f8f2018dc61cc93c70c/lib/appium_lib/driver.rb#L566) +##### [restart](https://github.com/appium/ruby_lib/blob/11cdf97bf9c4a90ac4e7c7dcf518cfb3fcd99ef2/lib/appium_lib/driver.rb#L566) > def restart Restarts the driver @@ -551,11 +551,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Driver] the driver -- -##### [screenshot](https://github.com/appium/ruby_lib/blob/02da3389a76ed75e42cc8f8f2018dc61cc93c70c/lib/appium_lib/driver.rb#L577) +##### [screenshot](https://github.com/appium/ruby_lib/blob/11cdf97bf9c4a90ac4e7c7dcf518cfb3fcd99ef2/lib/appium_lib/driver.rb#L577) > def screenshot(png_save_path) Takes a png screenshot and saves to the target path. @@ -569,11 +569,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[nil] -- -##### [driver_quit](https://github.com/appium/ruby_lib/blob/02da3389a76ed75e42cc8f8f2018dc61cc93c70c/lib/appium_lib/driver.rb#L584) +##### [driver_quit](https://github.com/appium/ruby_lib/blob/11cdf97bf9c4a90ac4e7c7dcf518cfb3fcd99ef2/lib/appium_lib/driver.rb#L584) > def driver_quit Quits the driver @@ -581,11 +581,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[void] -- -##### [start_driver](https://github.com/appium/ruby_lib/blob/02da3389a76ed75e42cc8f8f2018dc61cc93c70c/lib/appium_lib/driver.rb#L594) +##### [start_driver](https://github.com/appium/ruby_lib/blob/11cdf97bf9c4a90ac4e7c7dcf518cfb3fcd99ef2/lib/appium_lib/driver.rb#L594) > def start_driver Creates a new global driver and quits the old one if it exists. @@ -593,19 +593,19 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Selenium::WebDriver] the new global driver -- -##### [no_wait](https://github.com/appium/ruby_lib/blob/02da3389a76ed75e42cc8f8f2018dc61cc93c70c/lib/appium_lib/driver.rb#L632) +##### [no_wait](https://github.com/appium/ruby_lib/blob/11cdf97bf9c4a90ac4e7c7dcf518cfb3fcd99ef2/lib/appium_lib/driver.rb#L632) > def no_wait Set implicit wait to zero. -- -##### [set_wait](https://github.com/appium/ruby_lib/blob/02da3389a76ed75e42cc8f8f2018dc61cc93c70c/lib/appium_lib/driver.rb#L646) +##### [set_wait](https://github.com/appium/ruby_lib/blob/11cdf97bf9c4a90ac4e7c7dcf518cfb3fcd99ef2/lib/appium_lib/driver.rb#L646) > def set_wait(timeout = nil) Set implicit wait. Default to @default_wait. @@ -623,11 +623,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[void] -- -##### [exists](https://github.com/appium/ruby_lib/blob/02da3389a76ed75e42cc8f8f2018dc61cc93c70c/lib/appium_lib/driver.rb#L663) +##### [exists](https://github.com/appium/ruby_lib/blob/11cdf97bf9c4a90ac4e7c7dcf518cfb3fcd99ef2/lib/appium_lib/driver.rb#L663) > def exists(pre_check = 0, post_check = @default_wait) Returns existence of element. @@ -647,11 +647,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Boolean] -- -##### [execute_script](https://github.com/appium/ruby_lib/blob/02da3389a76ed75e42cc8f8f2018dc61cc93c70c/lib/appium_lib/driver.rb#L687) +##### [execute_script](https://github.com/appium/ruby_lib/blob/11cdf97bf9c4a90ac4e7c7dcf518cfb3fcd99ef2/lib/appium_lib/driver.rb#L687) > def execute_script(script, *args) The same as @driver.execute_script @@ -665,11 +665,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Object] -- -##### [find_elements](https://github.com/appium/ruby_lib/blob/02da3389a76ed75e42cc8f8f2018dc61cc93c70c/lib/appium_lib/driver.rb#L695) +##### [find_elements](https://github.com/appium/ruby_lib/blob/11cdf97bf9c4a90ac4e7c7dcf518cfb3fcd99ef2/lib/appium_lib/driver.rb#L695) > def find_elements(*args) Calls @driver.find_elements @@ -681,11 +681,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/02da3389a76ed75e42cc8f8f2018dc61cc93c70c/lib/appium_lib/driver.rb#L703) +##### [find_element](https://github.com/appium/ruby_lib/blob/11cdf97bf9c4a90ac4e7c7dcf518cfb3fcd99ef2/lib/appium_lib/driver.rb#L703) > def find_element(*args) Calls @driver.find_elements @@ -697,11 +697,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Element] -- -##### [set_location](https://github.com/appium/ruby_lib/blob/02da3389a76ed75e42cc8f8f2018dc61cc93c70c/lib/appium_lib/driver.rb#L716) +##### [set_location](https://github.com/appium/ruby_lib/blob/11cdf97bf9c4a90ac4e7c7dcf518cfb3fcd99ef2/lib/appium_lib/driver.rb#L716) > def set_location(opts = {}) Calls @driver.set_location @@ -713,11 +713,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Selenium::WebDriver::Location] the location constructed by the selenium webdriver -- -##### [x](https://github.com/appium/ruby_lib/blob/02da3389a76ed75e42cc8f8f2018dc61cc93c70c/lib/appium_lib/driver.rb#L726) +##### [x](https://github.com/appium/ruby_lib/blob/11cdf97bf9c4a90ac4e7c7dcf518cfb3fcd99ef2/lib/appium_lib/driver.rb#L726) > def x Quit the driver and Pry. quit and exit are reserved by Pry. @@ -726,20 +726,20 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[void] -- -##### [set_automation_name_if_nil](https://github.com/appium/ruby_lib/blob/02da3389a76ed75e42cc8f8f2018dc61cc93c70c/lib/appium_lib/driver.rb#L735) +##### [set_automation_name_if_nil](https://github.com/appium/ruby_lib/blob/11cdf97bf9c4a90ac4e7c7dcf518cfb3fcd99ef2/lib/appium_lib/driver.rb#L735) > def set_automation_name_if_nil If "automationName" is set only server side, this method set "automationName" attribute into @automation_name. Since @automation_name is set only client side before start_driver is called. -- -##### [logger=](https://github.com/appium/ruby_lib/blob/02da3389a76ed75e42cc8f8f2018dc61cc93c70c/lib/appium_lib/logger.rb#L13) +##### [logger=](https://github.com/appium/ruby_lib/blob/11cdf97bf9c4a90ac4e7c7dcf518cfb3fcd99ef2/lib/appium_lib/logger.rb#L13) > def logger=(value) Sets the attribute logger @@ -747,87 +747,132 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;value - the value to set the attribute logger to. -- -##### [logger](https://github.com/appium/ruby_lib/blob/02da3389a76ed75e42cc8f8f2018dc61cc93c70c/lib/appium_lib/logger.rb#L17) +##### [logger](https://github.com/appium/ruby_lib/blob/11cdf97bf9c4a90ac4e7c7dcf518cfb3fcd99ef2/lib/appium_lib/logger.rb#L17) > def logger -- -##### [app_strings](https://github.com/appium/ruby_lib/blob/02da3389a76ed75e42cc8f8f2018dc61cc93c70c/lib/appium_lib/device/device.rb#L7) +##### [app_strings](https://github.com/appium/ruby_lib/blob/11cdf97bf9c4a90ac4e7c7dcf518cfb3fcd99ef2/lib/appium_lib/device/device.rb#L7) > def app_strings Return the hash of all localization strings. ```ruby app_strings #=> "TransitionsTitle"=>"Transitions", "WebTitle"=>"Web" ``` -- -##### [background_app](https://github.com/appium/ruby_lib/blob/02da3389a76ed75e42cc8f8f2018dc61cc93c70c/lib/appium_lib/device/device.rb#L13) +##### [background_app](https://github.com/appium/ruby_lib/blob/11cdf97bf9c4a90ac4e7c7dcf518cfb3fcd99ef2/lib/appium_lib/device/device.rb#L13) > def background_app Backgrounds the app for a set number of seconds. This is a blocking application -- -##### [current_activity](https://github.com/appium/ruby_lib/blob/02da3389a76ed75e42cc8f8f2018dc61cc93c70c/lib/appium_lib/device/device.rb#L24) +##### [current_activity](https://github.com/appium/ruby_lib/blob/11cdf97bf9c4a90ac4e7c7dcf518cfb3fcd99ef2/lib/appium_lib/device/device.rb#L24) > def current_activity -- -##### [launch_app](https://github.com/appium/ruby_lib/blob/02da3389a76ed75e42cc8f8f2018dc61cc93c70c/lib/appium_lib/device/device.rb#L26) +##### [get_system_bars](https://github.com/appium/ruby_lib/blob/11cdf97bf9c4a90ac4e7c7dcf518cfb3fcd99ef2/lib/appium_lib/device/device.rb#L26) +> def get_system_bars + +Get system bar's information +```ruby +get_system_bars +``` + +__Returns:__ + +&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[String] System bar + +-- + +##### [get_display_density](https://github.com/appium/ruby_lib/blob/11cdf97bf9c4a90ac4e7c7dcf518cfb3fcd99ef2/lib/appium_lib/device/device.rb#L34) + +> def get_display_density + +Get connected device's density. +```ruby +get_display_density # 320 +``` + +__Returns:__ + +&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Integer] The size of density + +-- + +##### [is_keyboard_shown](https://github.com/appium/ruby_lib/blob/11cdf97bf9c4a90ac4e7c7dcf518cfb3fcd99ef2/lib/appium_lib/device/device.rb#L42) + +> def is_keyboard_shown + +Get whether keyboard is displayed or not. +```ruby +is_keyboard_shown # false +``` + +__Returns:__ + +&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Bool] Return true if keyboard is shown. Return false if keyboard is hidden. + +-- + +##### [launch_app](https://github.com/appium/ruby_lib/blob/11cdf97bf9c4a90ac4e7c7dcf518cfb3fcd99ef2/lib/appium_lib/device/device.rb#L50) + > def launch_app Start the simulator and application configured with desired capabilities -- -##### [reset](https://github.com/appium/ruby_lib/blob/02da3389a76ed75e42cc8f8f2018dc61cc93c70c/lib/appium_lib/device/device.rb#L29) +##### [reset](https://github.com/appium/ruby_lib/blob/11cdf97bf9c4a90ac4e7c7dcf518cfb3fcd99ef2/lib/appium_lib/device/device.rb#L53) > def reset Reset the device, relaunching the application. -- -##### [shake](https://github.com/appium/ruby_lib/blob/02da3389a76ed75e42cc8f8f2018dc61cc93c70c/lib/appium_lib/device/device.rb#L32) +##### [shake](https://github.com/appium/ruby_lib/blob/11cdf97bf9c4a90ac4e7c7dcf518cfb3fcd99ef2/lib/appium_lib/device/device.rb#L56) > def shake Cause the device to shake -- -##### [toggle_flight_mode](https://github.com/appium/ruby_lib/blob/02da3389a76ed75e42cc8f8f2018dc61cc93c70c/lib/appium_lib/device/device.rb#L35) +##### [toggle_flight_mode](https://github.com/appium/ruby_lib/blob/11cdf97bf9c4a90ac4e7c7dcf518cfb3fcd99ef2/lib/appium_lib/device/device.rb#L59) > def toggle_flight_mode Toggle flight mode on or off -- -##### [device_locked?](https://github.com/appium/ruby_lib/blob/02da3389a76ed75e42cc8f8f2018dc61cc93c70c/lib/appium_lib/device/device.rb#L38) +##### [device_locked?](https://github.com/appium/ruby_lib/blob/11cdf97bf9c4a90ac4e7c7dcf518cfb3fcd99ef2/lib/appium_lib/device/device.rb#L62) > def device_locked? -- -##### [hide_keyboard](https://github.com/appium/ruby_lib/blob/02da3389a76ed75e42cc8f8f2018dc61cc93c70c/lib/appium_lib/device/device.rb#L40) +##### [hide_keyboard](https://github.com/appium/ruby_lib/blob/11cdf97bf9c4a90ac4e7c7dcf518cfb3fcd99ef2/lib/appium_lib/device/device.rb#L64) > def hide_keyboard Hide the onscreen keyboard @@ -836,11 +881,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[String] close_key - The name of the key which closes the keyboard. Defaults to 'Done'. -- -##### [press_keycode](https://github.com/appium/ruby_lib/blob/02da3389a76ed75e42cc8f8f2018dc61cc93c70c/lib/appium_lib/device/device.rb#L49) +##### [press_keycode](https://github.com/appium/ruby_lib/blob/11cdf97bf9c4a90ac4e7c7dcf518cfb3fcd99ef2/lib/appium_lib/device/device.rb#L73) > def press_keycode Press keycode on the device. http://developer.android.com/reference/android/view/KeyEvent.html @@ -851,11 +896,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[String] metastate - The state the metakeys should be in when pressing the key. -- -##### [long_press_keycode](https://github.com/appium/ruby_lib/blob/02da3389a76ed75e42cc8f8f2018dc61cc93c70c/lib/appium_lib/device/device.rb#L55) +##### [long_press_keycode](https://github.com/appium/ruby_lib/blob/11cdf97bf9c4a90ac4e7c7dcf518cfb3fcd99ef2/lib/appium_lib/device/device.rb#L79) > def long_press_keycode Long press keycode on the device. http://developer.android.com/reference/android/view/KeyEvent.html @@ -866,11 +911,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[String] metastate - The state the metakeys should be in when long pressing the key. -- -##### [push_file](https://github.com/appium/ruby_lib/blob/02da3389a76ed75e42cc8f8f2018dc61cc93c70c/lib/appium_lib/device/device.rb#L61) +##### [push_file](https://github.com/appium/ruby_lib/blob/11cdf97bf9c4a90ac4e7c7dcf518cfb3fcd99ef2/lib/appium_lib/device/device.rb#L85) > def push_file Place a file in a specific location on the device. @@ -880,11 +925,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[String] data - Raw file data to be sent to the device. -- -##### [pull_file](https://github.com/appium/ruby_lib/blob/02da3389a76ed75e42cc8f8f2018dc61cc93c70c/lib/appium_lib/device/device.rb#L66) +##### [pull_file](https://github.com/appium/ruby_lib/blob/11cdf97bf9c4a90ac4e7c7dcf518cfb3fcd99ef2/lib/appium_lib/device/device.rb#L90) > def pull_file Retrieve a file from the device. This can retrieve an absolute path or a path relative to the installed app (iOS only). @@ -897,11 +942,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[String] path - Either an absolute path OR, for iOS devices, a path relative to the app, as described. -- -##### [pull_folder](https://github.com/appium/ruby_lib/blob/02da3389a76ed75e42cc8f8f2018dc61cc93c70c/lib/appium_lib/device/device.rb#L76) +##### [pull_folder](https://github.com/appium/ruby_lib/blob/11cdf97bf9c4a90ac4e7c7dcf518cfb3fcd99ef2/lib/appium_lib/device/device.rb#L100) > def pull_folder Retrieve a folder from the device. ```ruby @@ -912,11 +957,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[String] path - absolute path to the folder -- -##### [touch_id](https://github.com/appium/ruby_lib/blob/02da3389a76ed75e42cc8f8f2018dc61cc93c70c/lib/appium_lib/device/device.rb#L84) +##### [touch_id](https://github.com/appium/ruby_lib/blob/11cdf97bf9c4a90ac4e7c7dcf518cfb3fcd99ef2/lib/appium_lib/device/device.rb#L108) > def touch_id iOS only; Simulate Touch ID with either valid (match == true) or invalid (match == false) fingerprint. ```ruby @@ -929,11 +974,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Boolean] match - fingerprint validity Defaults to true. -- -##### [end_coverage](https://github.com/appium/ruby_lib/blob/02da3389a76ed75e42cc8f8f2018dc61cc93c70c/lib/appium_lib/device/device.rb#L93) +##### [end_coverage](https://github.com/appium/ruby_lib/blob/11cdf97bf9c4a90ac4e7c7dcf518cfb3fcd99ef2/lib/appium_lib/device/device.rb#L117) > def end_coverage Android only; Ends the test coverage and writes the results to the given path on device. @@ -943,19 +988,19 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[String] intent - Intent to broadcast when ending coverage. -- -##### [get_settings](https://github.com/appium/ruby_lib/blob/02da3389a76ed75e42cc8f8f2018dc61cc93c70c/lib/appium_lib/device/device.rb#L98) +##### [get_settings](https://github.com/appium/ruby_lib/blob/11cdf97bf9c4a90ac4e7c7dcf518cfb3fcd99ef2/lib/appium_lib/device/device.rb#L122) > def get_settings Get appium Settings for current test session -- -##### [update_settings](https://github.com/appium/ruby_lib/blob/02da3389a76ed75e42cc8f8f2018dc61cc93c70c/lib/appium_lib/device/device.rb#L101) +##### [update_settings](https://github.com/appium/ruby_lib/blob/11cdf97bf9c4a90ac4e7c7dcf518cfb3fcd99ef2/lib/appium_lib/device/device.rb#L125) > def update_settings Update appium Settings for current test session @@ -963,11 +1008,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Hash] settings - Settings to update, keys are settings, values to value to set each setting to -- -##### [start_activity](https://github.com/appium/ruby_lib/blob/02da3389a76ed75e42cc8f8f2018dc61cc93c70c/lib/appium_lib/device/device.rb#L105) +##### [start_activity](https://github.com/appium/ruby_lib/blob/11cdf97bf9c4a90ac4e7c7dcf518cfb3fcd99ef2/lib/appium_lib/device/device.rb#L129) > def start_activity Start a new activity within the current app or launch a new app and start the target activity. @@ -977,20 +1022,20 @@ app_activity: '.accessibility.AccessibilityNodeProviderActivity' ``` -- -##### [get_network_connection](https://github.com/appium/ruby_lib/blob/02da3389a76ed75e42cc8f8f2018dc61cc93c70c/lib/appium_lib/device/device.rb#L119) +##### [get_network_connection](https://github.com/appium/ruby_lib/blob/11cdf97bf9c4a90ac4e7c7dcf518cfb3fcd99ef2/lib/appium_lib/device/device.rb#L143) > def get_network_connection Get the device network connection current status See set_network_connection method for return value -- -##### [set_network_connection](https://github.com/appium/ruby_lib/blob/02da3389a76ed75e42cc8f8f2018dc61cc93c70c/lib/appium_lib/device/device.rb#L123) +##### [set_network_connection](https://github.com/appium/ruby_lib/blob/11cdf97bf9c4a90ac4e7c7dcf518cfb3fcd99ef2/lib/appium_lib/device/device.rb#L147) > def set_network_connection Set the device network connection mode Value (Alias) | Data | Wifi | Airplane Mode @@ -1005,11 +1050,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[String] path - Bit mask that represent the network mode -- -##### [set_immediate_value](https://github.com/appium/ruby_lib/blob/02da3389a76ed75e42cc8f8f2018dc61cc93c70c/lib/appium_lib/device/device.rb#L136) +##### [set_immediate_value](https://github.com/appium/ruby_lib/blob/11cdf97bf9c4a90ac4e7c7dcf518cfb3fcd99ef2/lib/appium_lib/device/device.rb#L160) > def set_immediate_value Set the value to element directly for iOS; setValue is called in XCUITest instead because XCUITest doesn't provide set value directly. @@ -1019,11 +1064,11 @@ set_immediate_value element, 'hello' ``` -- -##### [get_performance_data_types](https://github.com/appium/ruby_lib/blob/02da3389a76ed75e42cc8f8f2018dc61cc93c70c/lib/appium_lib/device/device.rb#L145) +##### [get_performance_data_types](https://github.com/appium/ruby_lib/blob/11cdf97bf9c4a90ac4e7c7dcf518cfb3fcd99ef2/lib/appium_lib/device/device.rb#L169) > def get_performance_data_types Get the information type of the system state which is supported to read such as cpu, memory, network, battery via adb commands. @@ -1033,27 +1078,27 @@ get_performance_data_types #=> ["cpuinfo", "batteryinfo", "networkinfo", "memoryinfo"] ``` -- -##### [extend_search_contexts](https://github.com/appium/ruby_lib/blob/02da3389a76ed75e42cc8f8f2018dc61cc93c70c/lib/appium_lib/device/device.rb#L400) +##### [extend_search_contexts](https://github.com/appium/ruby_lib/blob/11cdf97bf9c4a90ac4e7c7dcf518cfb3fcd99ef2/lib/appium_lib/device/device.rb#L424) > def extend_search_contexts -- -##### [find_element](https://github.com/appium/ruby_lib/blob/02da3389a76ed75e42cc8f8f2018dc61cc93c70c/lib/appium_lib/device/device.rb#L400) +##### [find_element](https://github.com/appium/ruby_lib/blob/11cdf97bf9c4a90ac4e7c7dcf518cfb3fcd99ef2/lib/appium_lib/device/device.rb#L424) > def find_element -- -##### [find_elements](https://github.com/appium/ruby_lib/blob/02da3389a76ed75e42cc8f8f2018dc61cc93c70c/lib/appium_lib/device/device.rb#L400) +##### [find_elements](https://github.com/appium/ruby_lib/blob/11cdf97bf9c4a90ac4e7c7dcf518cfb3fcd99ef2/lib/appium_lib/device/device.rb#L424) > def find_elements find_element/s with their accessibility_id @@ -1061,27 +1106,27 @@ find_elements :accessibility_id, 'Animation' ``` -- -##### [add_touch_actions](https://github.com/appium/ruby_lib/blob/02da3389a76ed75e42cc8f8f2018dc61cc93c70c/lib/appium_lib/device/device.rb#L431) +##### [add_touch_actions](https://github.com/appium/ruby_lib/blob/11cdf97bf9c4a90ac4e7c7dcf518cfb3fcd99ef2/lib/appium_lib/device/device.rb#L455) > def add_touch_actions -- -##### [add_ime_actions](https://github.com/appium/ruby_lib/blob/02da3389a76ed75e42cc8f8f2018dc61cc93c70c/lib/appium_lib/device/device.rb#L454) +##### [add_ime_actions](https://github.com/appium/ruby_lib/blob/11cdf97bf9c4a90ac4e7c7dcf518cfb3fcd99ef2/lib/appium_lib/device/device.rb#L478) > def add_ime_actions -- -##### [set_context](https://github.com/appium/ruby_lib/blob/02da3389a76ed75e42cc8f8f2018dc61cc93c70c/lib/appium_lib/device/device.rb#L529) +##### [set_context](https://github.com/appium/ruby_lib/blob/11cdf97bf9c4a90ac4e7c7dcf518cfb3fcd99ef2/lib/appium_lib/device/device.rb#L553) > def set_context Change the context to the given context. ```ruby @@ -1092,11 +1137,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[String] The - context to change to -- -##### [current_context](https://github.com/appium/ruby_lib/blob/02da3389a76ed75e42cc8f8f2018dc61cc93c70c/lib/appium_lib/device/device.rb#L537) +##### [current_context](https://github.com/appium/ruby_lib/blob/11cdf97bf9c4a90ac4e7c7dcf518cfb3fcd99ef2/lib/appium_lib/device/device.rb#L561) > def current_context @@ -1104,11 +1149,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[String] The context currently being used. -- -##### [available_contexts](https://github.com/appium/ruby_lib/blob/02da3389a76ed75e42cc8f8f2018dc61cc93c70c/lib/appium_lib/device/device.rb#L540) +##### [available_contexts](https://github.com/appium/ruby_lib/blob/11cdf97bf9c4a90ac4e7c7dcf518cfb3fcd99ef2/lib/appium_lib/device/device.rb#L564) > def available_contexts @@ -1116,11 +1161,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Array<String>] All usable contexts, as an array of strings. -- -##### [within_context](https://github.com/appium/ruby_lib/blob/02da3389a76ed75e42cc8f8f2018dc61cc93c70c/lib/appium_lib/device/device.rb#L550) +##### [within_context](https://github.com/appium/ruby_lib/blob/11cdf97bf9c4a90ac4e7c7dcf518cfb3fcd99ef2/lib/appium_lib/device/device.rb#L574) > def within_context(context) Perform a block within the given context, then switch back to the starting context. ```ruby @@ -1132,19 +1177,19 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[String] context - The context to switch to for the duration of the block. -- -##### [switch_to_default_context](https://github.com/appium/ruby_lib/blob/02da3389a76ed75e42cc8f8f2018dc61cc93c70c/lib/appium_lib/device/device.rb#L558) +##### [switch_to_default_context](https://github.com/appium/ruby_lib/blob/11cdf97bf9c4a90ac4e7c7dcf518cfb3fcd99ef2/lib/appium_lib/device/device.rb#L582) > def switch_to_default_context Change to the default context. This is equivalent to `set_context nil`. -- -##### [pinch](https://github.com/appium/ruby_lib/blob/02da3389a76ed75e42cc8f8f2018dc61cc93c70c/lib/appium_lib/device/multi_touch.rb#L28) +##### [pinch](https://github.com/appium/ruby_lib/blob/11cdf97bf9c4a90ac4e7c7dcf518cfb3fcd99ef2/lib/appium_lib/device/multi_touch.rb#L28) > def pinch(percentage = 25, auto_perform = true) Convenience method for pinching the screen. Places two fingers at the edges of the screen and brings them together. @@ -1159,11 +1204,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[boolean] auto_perform - Whether to perform the action immediately (default true) -- -##### [zoom](https://github.com/appium/ruby_lib/blob/02da3389a76ed75e42cc8f8f2018dc61cc93c70c/lib/appium_lib/device/multi_touch.rb#L57) +##### [zoom](https://github.com/appium/ruby_lib/blob/11cdf97bf9c4a90ac4e7c7dcf518cfb3fcd99ef2/lib/appium_lib/device/multi_touch.rb#L57) > def zoom(percentage = 200, auto_perform = true) Convenience method for zooming the screen. Places two fingers at the edges of the screen and brings them together. @@ -1178,71 +1223,79 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[boolean] auto_perform - Whether to perform the action immediately (default true) -- -##### [pinch_for_xcuitest](https://github.com/appium/ruby_lib/blob/02da3389a76ed75e42cc8f8f2018dc61cc93c70c/lib/appium_lib/device/multi_touch.rb#L79) +##### [pinch_for_xcuitest](https://github.com/appium/ruby_lib/blob/11cdf97bf9c4a90ac4e7c7dcf518cfb3fcd99ef2/lib/appium_lib/device/multi_touch.rb#L79) > def pinch_for_xcuitest(rate) -- -##### [pinch_android](https://github.com/appium/ruby_lib/blob/02da3389a76ed75e42cc8f8f2018dc61cc93c70c/lib/appium_lib/device/multi_touch.rb#L94) +##### [pinch_android](https://github.com/appium/ruby_lib/blob/11cdf97bf9c4a90ac4e7c7dcf518cfb3fcd99ef2/lib/appium_lib/device/multi_touch.rb#L94) > def pinch_android(rate) -- -##### [pinch_ios](https://github.com/appium/ruby_lib/blob/02da3389a76ed75e42cc8f8f2018dc61cc93c70c/lib/appium_lib/device/multi_touch.rb#L108) +##### [pinch_ios](https://github.com/appium/ruby_lib/blob/11cdf97bf9c4a90ac4e7c7dcf518cfb3fcd99ef2/lib/appium_lib/device/multi_touch.rb#L108) > def pinch_ios(rate) -- -##### [zoom_for_xcuitest](https://github.com/appium/ruby_lib/blob/02da3389a76ed75e42cc8f8f2018dc61cc93c70c/lib/appium_lib/device/multi_touch.rb#L122) +##### [zoom_for_xcuitest](https://github.com/appium/ruby_lib/blob/11cdf97bf9c4a90ac4e7c7dcf518cfb3fcd99ef2/lib/appium_lib/device/multi_touch.rb#L122) > def zoom_for_xcuitest(rate) -- -##### [zoom_android](https://github.com/appium/ruby_lib/blob/02da3389a76ed75e42cc8f8f2018dc61cc93c70c/lib/appium_lib/device/multi_touch.rb#L137) +##### [zoom_android](https://github.com/appium/ruby_lib/blob/11cdf97bf9c4a90ac4e7c7dcf518cfb3fcd99ef2/lib/appium_lib/device/multi_touch.rb#L137) > def zoom_android(rate) -- -##### [zoom_ios](https://github.com/appium/ruby_lib/blob/02da3389a76ed75e42cc8f8f2018dc61cc93c70c/lib/appium_lib/device/multi_touch.rb#L151) +##### [zoom_ios](https://github.com/appium/ruby_lib/blob/11cdf97bf9c4a90ac4e7c7dcf518cfb3fcd99ef2/lib/appium_lib/device/multi_touch.rb#L151) > def zoom_ios(rate) -- -##### [initialize](https://github.com/appium/ruby_lib/blob/02da3389a76ed75e42cc8f8f2018dc61cc93c70c/lib/appium_lib/device/multi_touch.rb#L167) +##### [actions](https://github.com/appium/ruby_lib/blob/11cdf97bf9c4a90ac4e7c7dcf518cfb3fcd99ef2/lib/appium_lib/device/multi_touch.rb#L166) +> def actions + +self + +-- + +##### [initialize](https://github.com/appium/ruby_lib/blob/11cdf97bf9c4a90ac4e7c7dcf518cfb3fcd99ef2/lib/appium_lib/device/multi_touch.rb#L169) + > def initialize Create a new multi-action __Returns:__ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[MultiTouch] a new instance of MultiTouch -- -##### [add](https://github.com/appium/ruby_lib/blob/02da3389a76ed75e42cc8f8f2018dc61cc93c70c/lib/appium_lib/device/multi_touch.rb#L173) +##### [add](https://github.com/appium/ruby_lib/blob/11cdf97bf9c4a90ac4e7c7dcf518cfb3fcd99ef2/lib/appium_lib/device/multi_touch.rb#L175) > def add(chain) Add a touch_action to be performed @@ -1250,43 +1303,43 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[TouchAction] chain - The action to add to the chain -- -##### [perform](https://github.com/appium/ruby_lib/blob/02da3389a76ed75e42cc8f8f2018dc61cc93c70c/lib/appium_lib/device/multi_touch.rb#L178) +##### [perform](https://github.com/appium/ruby_lib/blob/11cdf97bf9c4a90ac4e7c7dcf518cfb3fcd99ef2/lib/appium_lib/device/multi_touch.rb#L180) > def perform Ask Appium to perform the actions -- -##### [ACTIONS](https://github.com/appium/ruby_lib/blob/02da3389a76ed75e42cc8f8f2018dc61cc93c70c/lib/appium_lib/device/touch_actions.rb#L11) +##### [ACTIONS](https://github.com/appium/ruby_lib/blob/11cdf97bf9c4a90ac4e7c7dcf518cfb3fcd99ef2/lib/appium_lib/device/touch_actions.rb#L20) > ACTIONS = [:move_to, :long_press, :double_tap, :two_finger_tap, :press, :release, :tap, :wait, :perform].freeze -- -##### [COMPLEX_ACTIONS](https://github.com/appium/ruby_lib/blob/02da3389a76ed75e42cc8f8f2018dc61cc93c70c/lib/appium_lib/device/touch_actions.rb#L12) +##### [COMPLEX_ACTIONS](https://github.com/appium/ruby_lib/blob/11cdf97bf9c4a90ac4e7c7dcf518cfb3fcd99ef2/lib/appium_lib/device/touch_actions.rb#L21) > COMPLEX_ACTIONS = [:swipe].freeze -- -##### [actions](https://github.com/appium/ruby_lib/blob/02da3389a76ed75e42cc8f8f2018dc61cc93c70c/lib/appium_lib/device/touch_actions.rb#L26) +##### [actions](https://github.com/appium/ruby_lib/blob/11cdf97bf9c4a90ac4e7c7dcf518cfb3fcd99ef2/lib/appium_lib/device/touch_actions.rb#L35) > def actions Returns the value of attribute actions -- -##### [initialize](https://github.com/appium/ruby_lib/blob/02da3389a76ed75e42cc8f8f2018dc61cc93c70c/lib/appium_lib/device/touch_actions.rb#L28) +##### [initialize](https://github.com/appium/ruby_lib/blob/11cdf97bf9c4a90ac4e7c7dcf518cfb3fcd99ef2/lib/appium_lib/device/touch_actions.rb#L37) > def initialize @@ -1294,11 +1347,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[TouchAction] a new instance of TouchAction -- -##### [move_to](https://github.com/appium/ruby_lib/blob/02da3389a76ed75e42cc8f8f2018dc61cc93c70c/lib/appium_lib/device/touch_actions.rb#L39) +##### [move_to](https://github.com/appium/ruby_lib/blob/11cdf97bf9c4a90ac4e7c7dcf518cfb3fcd99ef2/lib/appium_lib/device/touch_actions.rb#L48) > def move_to(opts) Move to the given co-ordinates. @@ -1308,11 +1361,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Hash] opts - a customizable set of options -- -##### [long_press](https://github.com/appium/ruby_lib/blob/02da3389a76ed75e42cc8f8f2018dc61cc93c70c/lib/appium_lib/device/touch_actions.rb#L53) +##### [long_press](https://github.com/appium/ruby_lib/blob/11cdf97bf9c4a90ac4e7c7dcf518cfb3fcd99ef2/lib/appium_lib/device/touch_actions.rb#L62) > def long_press(opts) Press down for a specific duration. Alternatively, you can use `press(...).wait(...).release()` instead of `long_press` if duration doesn't work well. @@ -1329,11 +1382,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Hash] duration - a customizable set of options -- -##### [press](https://github.com/appium/ruby_lib/blob/02da3389a76ed75e42cc8f8f2018dc61cc93c70c/lib/appium_lib/device/touch_actions.rb#L65) +##### [press](https://github.com/appium/ruby_lib/blob/11cdf97bf9c4a90ac4e7c7dcf518cfb3fcd99ef2/lib/appium_lib/device/touch_actions.rb#L74) > def press(opts) Press a finger onto the screen. Finger will stay down until you call `release`. @@ -1342,11 +1395,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Hash] opts - a customizable set of options -- -##### [release](https://github.com/appium/ruby_lib/blob/02da3389a76ed75e42cc8f8f2018dc61cc93c70c/lib/appium_lib/device/touch_actions.rb#L76) +##### [release](https://github.com/appium/ruby_lib/blob/11cdf97bf9c4a90ac4e7c7dcf518cfb3fcd99ef2/lib/appium_lib/device/touch_actions.rb#L85) > def release(opts = nil) Remove a finger from the screen. @@ -1354,11 +1407,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Hash] opts - a customizable set of options -- -##### [tap](https://github.com/appium/ruby_lib/blob/02da3389a76ed75e42cc8f8f2018dc61cc93c70c/lib/appium_lib/device/touch_actions.rb#L88) +##### [tap](https://github.com/appium/ruby_lib/blob/11cdf97bf9c4a90ac4e7c7dcf518cfb3fcd99ef2/lib/appium_lib/device/touch_actions.rb#L97) > def tap(opts) Touch a point on the screen. Alternatively, you can use `press(...).release.perform` instead of `tap(...).perform`. @@ -1367,11 +1420,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Hash] opts - a customizable set of options -- -##### [double_tap](https://github.com/appium/ruby_lib/blob/02da3389a76ed75e42cc8f8f2018dc61cc93c70c/lib/appium_lib/device/touch_actions.rb#L101) +##### [double_tap](https://github.com/appium/ruby_lib/blob/11cdf97bf9c4a90ac4e7c7dcf518cfb3fcd99ef2/lib/appium_lib/device/touch_actions.rb#L110) > def double_tap(opts) Double tap an element on the screen @@ -1379,11 +1432,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Hash] opts - a customizable set of options -- -##### [two_finger_tap](https://github.com/appium/ruby_lib/blob/02da3389a76ed75e42cc8f8f2018dc61cc93c70c/lib/appium_lib/device/touch_actions.rb#L112) +##### [two_finger_tap](https://github.com/appium/ruby_lib/blob/11cdf97bf9c4a90ac4e7c7dcf518cfb3fcd99ef2/lib/appium_lib/device/touch_actions.rb#L121) > def two_finger_tap(opts) Two finger tap an element on the screen @@ -1391,11 +1444,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Hash] opts - a customizable set of options -- -##### [wait](https://github.com/appium/ruby_lib/blob/02da3389a76ed75e42cc8f8f2018dc61cc93c70c/lib/appium_lib/device/touch_actions.rb#L120) +##### [wait](https://github.com/appium/ruby_lib/blob/11cdf97bf9c4a90ac4e7c7dcf518cfb3fcd99ef2/lib/appium_lib/device/touch_actions.rb#L129) > def wait(milliseconds) Pause for a number of milliseconds before the next action @@ -1403,11 +1456,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[integer] milliseconds - Number of milliseconds to pause for -- -##### [swipe](https://github.com/appium/ruby_lib/blob/02da3389a76ed75e42cc8f8f2018dc61cc93c70c/lib/appium_lib/device/touch_actions.rb#L143) +##### [swipe](https://github.com/appium/ruby_lib/blob/11cdf97bf9c4a90ac4e7c7dcf518cfb3fcd99ef2/lib/appium_lib/device/touch_actions.rb#L152) > def swipe(opts, ele = nil) Convenience method to peform a swipe. @@ -1424,68 +1477,68 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Hash] opts - a customizable set of options -- -##### [perform](https://github.com/appium/ruby_lib/blob/02da3389a76ed75e42cc8f8f2018dc61cc93c70c/lib/appium_lib/device/touch_actions.rb#L168) +##### [perform](https://github.com/appium/ruby_lib/blob/11cdf97bf9c4a90ac4e7c7dcf518cfb3fcd99ef2/lib/appium_lib/device/touch_actions.rb#L177) > def perform Ask the driver to perform all actions in this action chain. -- -##### [cancel](https://github.com/appium/ruby_lib/blob/02da3389a76ed75e42cc8f8f2018dc61cc93c70c/lib/appium_lib/device/touch_actions.rb#L174) +##### [cancel](https://github.com/appium/ruby_lib/blob/11cdf97bf9c4a90ac4e7c7dcf518cfb3fcd99ef2/lib/appium_lib/device/touch_actions.rb#L184) > def cancel Does nothing, currently. -- -##### [swipe_coordinates](https://github.com/appium/ruby_lib/blob/02da3389a76ed75e42cc8f8f2018dc61cc93c70c/lib/appium_lib/device/touch_actions.rb#L180) +##### [swipe_coordinates](https://github.com/appium/ruby_lib/blob/11cdf97bf9c4a90ac4e7c7dcf518cfb3fcd99ef2/lib/appium_lib/device/touch_actions.rb#L190) > def swipe_coordinates(end_x: nil, end_y: nil, offset_x: nil, offset_y: nil) -- -##### [chain_method](https://github.com/appium/ruby_lib/blob/02da3389a76ed75e42cc8f8f2018dc61cc93c70c/lib/appium_lib/device/touch_actions.rb#L198) +##### [chain_method](https://github.com/appium/ruby_lib/blob/11cdf97bf9c4a90ac4e7c7dcf518cfb3fcd99ef2/lib/appium_lib/device/touch_actions.rb#L208) > def chain_method(method, args = nil) -- -##### [args_with_ele_ref](https://github.com/appium/ruby_lib/blob/02da3389a76ed75e42cc8f8f2018dc61cc93c70c/lib/appium_lib/device/touch_actions.rb#L204) +##### [args_with_ele_ref](https://github.com/appium/ruby_lib/blob/11cdf97bf9c4a90ac4e7c7dcf518cfb3fcd99ef2/lib/appium_lib/device/touch_actions.rb#L214) > def args_with_ele_ref(args) -- -##### [_generic_wait](https://github.com/appium/ruby_lib/blob/02da3389a76ed75e42cc8f8f2018dc61cc93c70c/lib/appium_lib/common/wait.rb#L9) +##### [_generic_wait](https://github.com/appium/ruby_lib/blob/11cdf97bf9c4a90ac4e7c7dcf518cfb3fcd99ef2/lib/appium_lib/common/wait.rb#L9) > def _generic_wait(opts = {}) Wait code from the selenium Ruby gem https://github.com/SeleniumHQ/selenium/blob/cf501dda3f0ed12233de51ce8170c0e8090f0c20/rb/lib/selenium/webdriver/common/wait.rb -- -##### [_process_wait_opts](https://github.com/appium/ruby_lib/blob/02da3389a76ed75e42cc8f8f2018dc61cc93c70c/lib/appium_lib/common/wait.rb#L48) +##### [_process_wait_opts](https://github.com/appium/ruby_lib/blob/11cdf97bf9c4a90ac4e7c7dcf518cfb3fcd99ef2/lib/appium_lib/common/wait.rb#L48) > def _process_wait_opts(opts) process opts before calling _generic_wait -- -##### [wait_true](https://github.com/appium/ruby_lib/blob/02da3389a76ed75e42cc8f8f2018dc61cc93c70c/lib/appium_lib/common/wait.rb#L69) +##### [wait_true](https://github.com/appium/ruby_lib/blob/11cdf97bf9c4a90ac4e7c7dcf518cfb3fcd99ef2/lib/appium_lib/common/wait.rb#L69) > def wait_true(opts = {}, &block) Check every interval seconds to see if yield returns a truthy value. Note this isn't a strict boolean true, any truthy value is accepted. @@ -1501,11 +1554,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Hash] opts - Options -- -##### [wait](https://github.com/appium/ruby_lib/blob/02da3389a76ed75e42cc8f8f2018dc61cc93c70c/lib/appium_lib/common/wait.rb#L87) +##### [wait](https://github.com/appium/ruby_lib/blob/11cdf97bf9c4a90ac4e7c7dcf518cfb3fcd99ef2/lib/appium_lib/common/wait.rb#L87) > def wait(opts = {}, &block) Check every interval seconds to see if yield doesn't raise an exception. Give up after timeout seconds. @@ -1519,19 +1572,19 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Hash] opts - Options -- -##### [ignore](https://github.com/appium/ruby_lib/blob/02da3389a76ed75e42cc8f8f2018dc61cc93c70c/lib/appium_lib/common/helper.rb#L24) +##### [ignore](https://github.com/appium/ruby_lib/blob/11cdf97bf9c4a90ac4e7c7dcf518cfb3fcd99ef2/lib/appium_lib/common/helper.rb#L24) > def ignore Return yield and ignore any exceptions. -- -##### [back](https://github.com/appium/ruby_lib/blob/02da3389a76ed75e42cc8f8f2018dc61cc93c70c/lib/appium_lib/common/helper.rb#L31) +##### [back](https://github.com/appium/ruby_lib/blob/11cdf97bf9c4a90ac4e7c7dcf518cfb3fcd99ef2/lib/appium_lib/common/helper.rb#L31) > def back Navigate back. @@ -1539,19 +1592,19 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[void] -- -##### [session_id](https://github.com/appium/ruby_lib/blob/02da3389a76ed75e42cc8f8f2018dc61cc93c70c/lib/appium_lib/common/helper.rb#L36) +##### [session_id](https://github.com/appium/ruby_lib/blob/11cdf97bf9c4a90ac4e7c7dcf518cfb3fcd99ef2/lib/appium_lib/common/helper.rb#L36) > def session_id For Sauce Labs reporting. Returns the current session id. -- -##### [xpath](https://github.com/appium/ruby_lib/blob/02da3389a76ed75e42cc8f8f2018dc61cc93c70c/lib/appium_lib/common/helper.rb#L44) +##### [xpath](https://github.com/appium/ruby_lib/blob/11cdf97bf9c4a90ac4e7c7dcf518cfb3fcd99ef2/lib/appium_lib/common/helper.rb#L44) > def xpath(xpath_str) Returns the first element that matches the provided xpath. @@ -1563,11 +1616,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Element] -- -##### [xpaths](https://github.com/appium/ruby_lib/blob/02da3389a76ed75e42cc8f8f2018dc61cc93c70c/lib/appium_lib/common/helper.rb#L52) +##### [xpaths](https://github.com/appium/ruby_lib/blob/11cdf97bf9c4a90ac4e7c7dcf518cfb3fcd99ef2/lib/appium_lib/common/helper.rb#L52) > def xpaths(xpath_str) Returns all elements that match the provided xpath. @@ -1579,27 +1632,27 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Array<Element>] -- -##### [_print_source](https://github.com/appium/ruby_lib/blob/02da3389a76ed75e42cc8f8f2018dc61cc93c70c/lib/appium_lib/common/helper.rb#L56) +##### [_print_source](https://github.com/appium/ruby_lib/blob/11cdf97bf9c4a90ac4e7c7dcf518cfb3fcd99ef2/lib/appium_lib/common/helper.rb#L56) > def _print_source(source) -- -##### [result](https://github.com/appium/ruby_lib/blob/02da3389a76ed75e42cc8f8f2018dc61cc93c70c/lib/appium_lib/common/helper.rb#L69) +##### [result](https://github.com/appium/ruby_lib/blob/11cdf97bf9c4a90ac4e7c7dcf518cfb3fcd99ef2/lib/appium_lib/common/helper.rb#L69) > def result Returns the value of attribute result -- -##### [initialize](https://github.com/appium/ruby_lib/blob/02da3389a76ed75e42cc8f8f2018dc61cc93c70c/lib/appium_lib/common/helper.rb#L71) +##### [initialize](https://github.com/appium/ruby_lib/blob/11cdf97bf9c4a90ac4e7c7dcf518cfb3fcd99ef2/lib/appium_lib/common/helper.rb#L71) > def initialize @@ -1607,52 +1660,52 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[CountElements] a new instance of CountElements -- -##### [reset](https://github.com/appium/ruby_lib/blob/02da3389a76ed75e42cc8f8f2018dc61cc93c70c/lib/appium_lib/common/helper.rb#L75) +##### [reset](https://github.com/appium/ruby_lib/blob/11cdf97bf9c4a90ac4e7c7dcf518cfb3fcd99ef2/lib/appium_lib/common/helper.rb#L75) > def reset -- -##### [start_element](https://github.com/appium/ruby_lib/blob/02da3389a76ed75e42cc8f8f2018dc61cc93c70c/lib/appium_lib/common/helper.rb#L80) +##### [start_element](https://github.com/appium/ruby_lib/blob/11cdf97bf9c4a90ac4e7c7dcf518cfb3fcd99ef2/lib/appium_lib/common/helper.rb#L80) > def start_element(name, attrs = []) http://nokogiri.org/Nokogiri/XML/SAX/Document.html -- -##### [formatted_result](https://github.com/appium/ruby_lib/blob/02da3389a76ed75e42cc8f8f2018dc61cc93c70c/lib/appium_lib/common/helper.rb#L86) +##### [formatted_result](https://github.com/appium/ruby_lib/blob/11cdf97bf9c4a90ac4e7c7dcf518cfb3fcd99ef2/lib/appium_lib/common/helper.rb#L86) > def formatted_result -- -##### [get_page_class](https://github.com/appium/ruby_lib/blob/02da3389a76ed75e42cc8f8f2018dc61cc93c70c/lib/appium_lib/common/helper.rb#L97) +##### [get_page_class](https://github.com/appium/ruby_lib/blob/11cdf97bf9c4a90ac4e7c7dcf518cfb3fcd99ef2/lib/appium_lib/common/helper.rb#L97) > def get_page_class Returns a string of class counts of visible elements. -- -##### [page_class](https://github.com/appium/ruby_lib/blob/02da3389a76ed75e42cc8f8f2018dc61cc93c70c/lib/appium_lib/common/helper.rb#L108) +##### [page_class](https://github.com/appium/ruby_lib/blob/11cdf97bf9c4a90ac4e7c7dcf518cfb3fcd99ef2/lib/appium_lib/common/helper.rb#L108) > def page_class Count all classes on screen and print to stdout. Useful for appium_console. -- -##### [px_to_window_rel](https://github.com/appium/ruby_lib/blob/02da3389a76ed75e42cc8f8f2018dc61cc93c70c/lib/appium_lib/common/helper.rb#L118) +##### [px_to_window_rel](https://github.com/appium/ruby_lib/blob/11cdf97bf9c4a90ac4e7c7dcf518cfb3fcd99ef2/lib/appium_lib/common/helper.rb#L118) > def px_to_window_rel(opts = {}) Converts pixel values to window relative values @@ -1660,11 +1713,11 @@ px_to_window_rel x: 50, y: 150 ``` -- -##### [xml_keys](https://github.com/appium/ruby_lib/blob/02da3389a76ed75e42cc8f8f2018dc61cc93c70c/lib/appium_lib/common/helper.rb#L137) +##### [xml_keys](https://github.com/appium/ruby_lib/blob/11cdf97bf9c4a90ac4e7c7dcf518cfb3fcd99ef2/lib/appium_lib/common/helper.rb#L137) > def xml_keys(target) Search strings.xml's values for target. @@ -1676,11 +1729,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Array] -- -##### [xml_values](https://github.com/appium/ruby_lib/blob/02da3389a76ed75e42cc8f8f2018dc61cc93c70c/lib/appium_lib/common/helper.rb#L145) +##### [xml_values](https://github.com/appium/ruby_lib/blob/11cdf97bf9c4a90ac4e7c7dcf518cfb3fcd99ef2/lib/appium_lib/common/helper.rb#L145) > def xml_values(target) Search strings.xml's keys for target. @@ -1692,11 +1745,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Array] -- -##### [resolve_id](https://github.com/appium/ruby_lib/blob/02da3389a76ed75e42cc8f8f2018dc61cc93c70c/lib/appium_lib/common/helper.rb#L153) +##### [resolve_id](https://github.com/appium/ruby_lib/blob/11cdf97bf9c4a90ac4e7c7dcf518cfb3fcd99ef2/lib/appium_lib/common/helper.rb#L153) > def resolve_id(id) Resolve id in strings.xml and return the value. @@ -1708,27 +1761,27 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[String] -- -##### [filter](https://github.com/appium/ruby_lib/blob/02da3389a76ed75e42cc8f8f2018dc61cc93c70c/lib/appium_lib/common/helper.rb#L159) +##### [filter](https://github.com/appium/ruby_lib/blob/11cdf97bf9c4a90ac4e7c7dcf518cfb3fcd99ef2/lib/appium_lib/common/helper.rb#L159) > def filter Returns the value of attribute filter -- -##### [filter=](https://github.com/appium/ruby_lib/blob/02da3389a76ed75e42cc8f8f2018dc61cc93c70c/lib/appium_lib/common/helper.rb#L162) +##### [filter=](https://github.com/appium/ruby_lib/blob/11cdf97bf9c4a90ac4e7c7dcf518cfb3fcd99ef2/lib/appium_lib/common/helper.rb#L162) > def filter=(value) convert to string to support symbols -- -##### [initialize](https://github.com/appium/ruby_lib/blob/02da3389a76ed75e42cc8f8f2018dc61cc93c70c/lib/appium_lib/common/helper.rb#L168) +##### [initialize](https://github.com/appium/ruby_lib/blob/11cdf97bf9c4a90ac4e7c7dcf518cfb3fcd99ef2/lib/appium_lib/common/helper.rb#L168) > def initialize @@ -1736,99 +1789,99 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[HTMLElements] a new instance of HTMLElements -- -##### [reset](https://github.com/appium/ruby_lib/blob/02da3389a76ed75e42cc8f8f2018dc61cc93c70c/lib/appium_lib/common/helper.rb#L173) +##### [reset](https://github.com/appium/ruby_lib/blob/11cdf97bf9c4a90ac4e7c7dcf518cfb3fcd99ef2/lib/appium_lib/common/helper.rb#L173) > def reset -- -##### [result](https://github.com/appium/ruby_lib/blob/02da3389a76ed75e42cc8f8f2018dc61cc93c70c/lib/appium_lib/common/helper.rb#L179) +##### [result](https://github.com/appium/ruby_lib/blob/11cdf97bf9c4a90ac4e7c7dcf518cfb3fcd99ef2/lib/appium_lib/common/helper.rb#L179) > def result -- -##### [start_element](https://github.com/appium/ruby_lib/blob/02da3389a76ed75e42cc8f8f2018dc61cc93c70c/lib/appium_lib/common/helper.rb#L195) +##### [start_element](https://github.com/appium/ruby_lib/blob/11cdf97bf9c4a90ac4e7c7dcf518cfb3fcd99ef2/lib/appium_lib/common/helper.rb#L195) > def start_element(name, attrs = []) -- -##### [end_element](https://github.com/appium/ruby_lib/blob/02da3389a76ed75e42cc8f8f2018dc61cc93c70c/lib/appium_lib/common/helper.rb#L204) +##### [end_element](https://github.com/appium/ruby_lib/blob/11cdf97bf9c4a90ac4e7c7dcf518cfb3fcd99ef2/lib/appium_lib/common/helper.rb#L204) > def end_element(name) -- -##### [characters](https://github.com/appium/ruby_lib/blob/02da3389a76ed75e42cc8f8f2018dc61cc93c70c/lib/appium_lib/common/helper.rb#L210) +##### [characters](https://github.com/appium/ruby_lib/blob/11cdf97bf9c4a90ac4e7c7dcf518cfb3fcd99ef2/lib/appium_lib/common/helper.rb#L210) > def characters(chars) -- -##### [_no_such_element](https://github.com/appium/ruby_lib/blob/02da3389a76ed75e42cc8f8f2018dc61cc93c70c/lib/appium_lib/common/helper.rb#L217) +##### [_no_such_element](https://github.com/appium/ruby_lib/blob/11cdf97bf9c4a90ac4e7c7dcf518cfb3fcd99ef2/lib/appium_lib/common/helper.rb#L217) > def _no_such_element -- -##### [COMMAND_NO_ARG](https://github.com/appium/ruby_lib/blob/02da3389a76ed75e42cc8f8f2018dc61cc93c70c/lib/appium_lib/common/command.rb#L4) +##### [COMMAND_NO_ARG](https://github.com/appium/ruby_lib/blob/11cdf97bf9c4a90ac4e7c7dcf518cfb3fcd99ef2/lib/appium_lib/common/command.rb#L4) > COMMAND_NO_ARG = { -- -##### [COMMAND](https://github.com/appium/ruby_lib/blob/02da3389a76ed75e42cc8f8f2018dc61cc93c70c/lib/appium_lib/common/command.rb#L24) +##### [COMMAND](https://github.com/appium/ruby_lib/blob/11cdf97bf9c4a90ac4e7c7dcf518cfb3fcd99ef2/lib/appium_lib/common/command.rb#L27) > COMMAND = { -- -##### [window_size](https://github.com/appium/ruby_lib/blob/02da3389a76ed75e42cc8f8f2018dc61cc93c70c/lib/appium_lib/common/element/window.rb#L5) +##### [window_size](https://github.com/appium/ruby_lib/blob/11cdf97bf9c4a90ac4e7c7dcf518cfb3fcd99ef2/lib/appium_lib/common/element/window.rb#L5) > def window_size Get the window's size -- -##### [FINDERS](https://github.com/appium/ruby_lib/blob/02da3389a76ed75e42cc8f8f2018dc61cc93c70c/lib/appium_lib/common/search_context.rb#L5) +##### [FINDERS](https://github.com/appium/ruby_lib/blob/11cdf97bf9c4a90ac4e7c7dcf518cfb3fcd99ef2/lib/appium_lib/common/search_context.rb#L5) > FINDERS = { rubocop:disable Style/MutableConstant -- -##### [filter](https://github.com/appium/ruby_lib/blob/02da3389a76ed75e42cc8f8f2018dc61cc93c70c/lib/appium_lib/ios/helper.rb#L4) ios +##### [filter](https://github.com/appium/ruby_lib/blob/11cdf97bf9c4a90ac4e7c7dcf518cfb3fcd99ef2/lib/appium_lib/ios/helper.rb#L4) ios > def filter Returns the value of attribute filter -- -##### [filter=](https://github.com/appium/ruby_lib/blob/02da3389a76ed75e42cc8f8f2018dc61cc93c70c/lib/appium_lib/ios/helper.rb#L4) ios +##### [filter=](https://github.com/appium/ruby_lib/blob/11cdf97bf9c4a90ac4e7c7dcf518cfb3fcd99ef2/lib/appium_lib/ios/helper.rb#L4) ios > def filter=(value) Sets the attribute filter @@ -1836,27 +1889,27 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;value - the value to set the attribute filter to. -- -##### [start_element](https://github.com/appium/ruby_lib/blob/02da3389a76ed75e42cc8f8f2018dc61cc93c70c/lib/appium_lib/ios/helper.rb#L6) ios +##### [start_element](https://github.com/appium/ruby_lib/blob/11cdf97bf9c4a90ac4e7c7dcf518cfb3fcd99ef2/lib/appium_lib/ios/helper.rb#L6) ios > def start_element(type, attrs = []) -- -##### [_print_attr](https://github.com/appium/ruby_lib/blob/02da3389a76ed75e42cc8f8f2018dc61cc93c70c/lib/appium_lib/ios/helper.rb#L15) ios +##### [_print_attr](https://github.com/appium/ruby_lib/blob/11cdf97bf9c4a90ac4e7c7dcf518cfb3fcd99ef2/lib/appium_lib/ios/helper.rb#L15) ios > def _print_attr(type, name, label, value, hint) -- -##### [ios_password](https://github.com/appium/ruby_lib/blob/02da3389a76ed75e42cc8f8f2018dc61cc93c70c/lib/appium_lib/ios/helper.rb#L41) ios +##### [ios_password](https://github.com/appium/ruby_lib/blob/11cdf97bf9c4a90ac4e7c7dcf518cfb3fcd99ef2/lib/appium_lib/ios/helper.rb#L41) ios > def ios_password(length = 1) iOS only. On Android uiautomator always returns an empty string for EditText password. @@ -1870,11 +1923,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[String] the returned string is of size length -- -##### [get_page](https://github.com/appium/ruby_lib/blob/02da3389a76ed75e42cc8f8f2018dc61cc93c70c/lib/appium_lib/ios/helper.rb#L53) ios +##### [get_page](https://github.com/appium/ruby_lib/blob/11cdf97bf9c4a90ac4e7c7dcf518cfb3fcd99ef2/lib/appium_lib/ios/helper.rb#L53) ios > def get_page(element = source_window(0), class_name = nil) Returns a string of interesting elements. iOS only. @@ -1891,11 +1944,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[String] -- -##### [page](https://github.com/appium/ruby_lib/blob/02da3389a76ed75e42cc8f8f2018dc61cc93c70c/lib/appium_lib/ios/helper.rb#L139) ios +##### [page](https://github.com/appium/ruby_lib/blob/11cdf97bf9c4a90ac4e7c7dcf518cfb3fcd99ef2/lib/appium_lib/ios/helper.rb#L139) ios > def page(opts = {}) Prints a string of interesting elements to the console. @@ -1917,11 +1970,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[void] -- -##### [source_window](https://github.com/appium/ruby_lib/blob/02da3389a76ed75e42cc8f8f2018dc61cc93c70c/lib/appium_lib/ios/helper.rb#L170) ios +##### [source_window](https://github.com/appium/ruby_lib/blob/11cdf97bf9c4a90ac4e7c7dcf518cfb3fcd99ef2/lib/appium_lib/ios/helper.rb#L170) ios > def source_window(_window_number = 0) Gets the JSON source of window number @@ -1933,11 +1986,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[JSON] -- -##### [page_window](https://github.com/appium/ruby_lib/blob/02da3389a76ed75e42cc8f8f2018dc61cc93c70c/lib/appium_lib/ios/helper.rb#L185) ios +##### [page_window](https://github.com/appium/ruby_lib/blob/11cdf97bf9c4a90ac4e7c7dcf518cfb3fcd99ef2/lib/appium_lib/ios/helper.rb#L185) ios > def page_window(window_number = 0) Prints parsed page source to console. @@ -1951,11 +2004,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[void] -- -##### [id](https://github.com/appium/ruby_lib/blob/02da3389a76ed75e42cc8f8f2018dc61cc93c70c/lib/appium_lib/ios/helper.rb#L193) ios +##### [id](https://github.com/appium/ruby_lib/blob/11cdf97bf9c4a90ac4e7c7dcf518cfb3fcd99ef2/lib/appium_lib/ios/helper.rb#L193) ios > def id(id) Find by id @@ -1967,11 +2020,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Element] -- -##### [ios_version](https://github.com/appium/ruby_lib/blob/02da3389a76ed75e42cc8f8f2018dc61cc93c70c/lib/appium_lib/ios/helper.rb#L199) ios +##### [ios_version](https://github.com/appium/ruby_lib/blob/11cdf97bf9c4a90ac4e7c7dcf518cfb3fcd99ef2/lib/appium_lib/ios/helper.rb#L199) ios > def ios_version Return the iOS version as an array of integers @@ -1979,11 +2032,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Array<Integer>] -- -##### [ele_index](https://github.com/appium/ruby_lib/blob/02da3389a76ed75e42cc8f8f2018dc61cc93c70c/lib/appium_lib/ios/helper.rb#L212) ios +##### [ele_index](https://github.com/appium/ruby_lib/blob/11cdf97bf9c4a90ac4e7c7dcf518cfb3fcd99ef2/lib/appium_lib/ios/helper.rb#L212) ios > def ele_index(class_name, index) Get the element of type class_name at matching index. @@ -1997,11 +2050,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Element] -- -##### [find_ele_by_attr](https://github.com/appium/ruby_lib/blob/02da3389a76ed75e42cc8f8f2018dc61cc93c70c/lib/appium_lib/ios/helper.rb#L248) ios +##### [find_ele_by_attr](https://github.com/appium/ruby_lib/blob/11cdf97bf9c4a90ac4e7c7dcf518cfb3fcd99ef2/lib/appium_lib/ios/helper.rb#L248) ios > def find_ele_by_attr(class_name, attr, value) Find the first element exactly matching class and attribute value. Note: Uses XPath @@ -2019,11 +2072,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Element] -- -##### [find_eles_by_attr](https://github.com/appium/ruby_lib/blob/02da3389a76ed75e42cc8f8f2018dc61cc93c70c/lib/appium_lib/ios/helper.rb#L259) ios +##### [find_eles_by_attr](https://github.com/appium/ruby_lib/blob/11cdf97bf9c4a90ac4e7c7dcf518cfb3fcd99ef2/lib/appium_lib/ios/helper.rb#L259) ios > def find_eles_by_attr(class_name, attr, value) Find all elements exactly matching class and attribute value. Note: Uses XPath @@ -2041,11 +2094,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Array<Element>] -- -##### [find_ele_by_predicate](https://github.com/appium/ruby_lib/blob/02da3389a76ed75e42cc8f8f2018dc61cc93c70c/lib/appium_lib/ios/helper.rb#L280) ios +##### [find_ele_by_predicate](https://github.com/appium/ruby_lib/blob/11cdf97bf9c4a90ac4e7c7dcf518cfb3fcd99ef2/lib/appium_lib/ios/helper.rb#L280) ios > def find_ele_by_predicate(class_name: '*', value:) Find the first element exactly matching attribute case insensitive value. Note: Uses Predicate @@ -2058,11 +2111,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Element] -- -##### [find_eles_by_predicate](https://github.com/appium/ruby_lib/blob/02da3389a76ed75e42cc8f8f2018dc61cc93c70c/lib/appium_lib/ios/helper.rb#L291) ios +##### [find_eles_by_predicate](https://github.com/appium/ruby_lib/blob/11cdf97bf9c4a90ac4e7c7dcf518cfb3fcd99ef2/lib/appium_lib/ios/helper.rb#L291) ios > def find_eles_by_predicate(class_name: '*', value:) Find all elements exactly matching attribute case insensitive value. Note: Uses Predicate @@ -2077,11 +2130,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Array<Element>] -- -##### [find_ele_by_attr_include](https://github.com/appium/ruby_lib/blob/02da3389a76ed75e42cc8f8f2018dc61cc93c70c/lib/appium_lib/ios/helper.rb#L307) ios +##### [find_ele_by_attr_include](https://github.com/appium/ruby_lib/blob/11cdf97bf9c4a90ac4e7c7dcf518cfb3fcd99ef2/lib/appium_lib/ios/helper.rb#L307) ios > def find_ele_by_attr_include(class_name, attr, value) Get the first tag by attribute that exactly matches value. Note: Uses XPath @@ -2098,11 +2151,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/02da3389a76ed75e42cc8f8f2018dc61cc93c70c/lib/appium_lib/ios/helper.rb#L317) ios +##### [find_eles_by_attr_include](https://github.com/appium/ruby_lib/blob/11cdf97bf9c4a90ac4e7c7dcf518cfb3fcd99ef2/lib/appium_lib/ios/helper.rb#L317) ios > def find_eles_by_attr_include(class_name, attr, value) Get tags by attribute that include value. Note: Uses XPath @@ -2119,11 +2172,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/02da3389a76ed75e42cc8f8f2018dc61cc93c70c/lib/appium_lib/ios/helper.rb#L325) ios +##### [find_ele_by_predicate_include](https://github.com/appium/ruby_lib/blob/11cdf97bf9c4a90ac4e7c7dcf518cfb3fcd99ef2/lib/appium_lib/ios/helper.rb#L325) ios > def find_ele_by_predicate_include(class_name: '*', value:) Get the first elements that include insensitive value. Note: Uses Predicate @@ -2136,11 +2189,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/02da3389a76ed75e42cc8f8f2018dc61cc93c70c/lib/appium_lib/ios/helper.rb#L336) ios +##### [find_eles_by_predicate_include](https://github.com/appium/ruby_lib/blob/11cdf97bf9c4a90ac4e7c7dcf518cfb3fcd99ef2/lib/appium_lib/ios/helper.rb#L336) ios > def find_eles_by_predicate_include(class_name: '*', value:) Get elements that include case insensitive value. Note: Uses Predicate @@ -2155,11 +2208,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/02da3389a76ed75e42cc8f8f2018dc61cc93c70c/lib/appium_lib/ios/helper.rb#L349) ios +##### [first_ele](https://github.com/appium/ruby_lib/blob/11cdf97bf9c4a90ac4e7c7dcf518cfb3fcd99ef2/lib/appium_lib/ios/helper.rb#L349) ios > def first_ele(class_name) Get the first tag that matches class_name @@ -2171,11 +2224,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Element] -- -##### [last_ele](https://github.com/appium/ruby_lib/blob/02da3389a76ed75e42cc8f8f2018dc61cc93c70c/lib/appium_lib/ios/helper.rb#L356) ios +##### [last_ele](https://github.com/appium/ruby_lib/blob/11cdf97bf9c4a90ac4e7c7dcf518cfb3fcd99ef2/lib/appium_lib/ios/helper.rb#L356) ios > def last_ele(class_name) Get the last tag that matches class_name @@ -2187,11 +2240,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Element] -- -##### [tag](https://github.com/appium/ruby_lib/blob/02da3389a76ed75e42cc8f8f2018dc61cc93c70c/lib/appium_lib/ios/helper.rb#L370) ios +##### [tag](https://github.com/appium/ruby_lib/blob/11cdf97bf9c4a90ac4e7c7dcf518cfb3fcd99ef2/lib/appium_lib/ios/helper.rb#L370) ios > def tag(class_name) Returns the first **visible** element matching class_name @@ -2203,11 +2256,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Element] -- -##### [tags](https://github.com/appium/ruby_lib/blob/02da3389a76ed75e42cc8f8f2018dc61cc93c70c/lib/appium_lib/ios/helper.rb#L382) ios +##### [tags](https://github.com/appium/ruby_lib/blob/11cdf97bf9c4a90ac4e7c7dcf518cfb3fcd99ef2/lib/appium_lib/ios/helper.rb#L382) ios > def tags(class_name) Returns all visible elements matching class_name @@ -2219,11 +2272,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Element] -- -##### [tags_include](https://github.com/appium/ruby_lib/blob/02da3389a76ed75e42cc8f8f2018dc61cc93c70c/lib/appium_lib/ios/helper.rb#L398) ios +##### [tags_include](https://github.com/appium/ruby_lib/blob/11cdf97bf9c4a90ac4e7c7dcf518cfb3fcd99ef2/lib/appium_lib/ios/helper.rb#L398) 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. @@ -2239,11 +2292,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Array[Element]] -- -##### [tags_exact](https://github.com/appium/ruby_lib/blob/02da3389a76ed75e42cc8f8f2018dc61cc93c70c/lib/appium_lib/ios/helper.rb#L427) ios +##### [tags_exact](https://github.com/appium/ruby_lib/blob/11cdf97bf9c4a90ac4e7c7dcf518cfb3fcd99ef2/lib/appium_lib/ios/helper.rb#L427) 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. @@ -2259,11 +2312,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Array[Element]] -- -##### [ele_by_json_visible_contains](https://github.com/appium/ruby_lib/blob/02da3389a76ed75e42cc8f8f2018dc61cc93c70c/lib/appium_lib/ios/helper.rb#L478) ios +##### [ele_by_json_visible_contains](https://github.com/appium/ruby_lib/blob/11cdf97bf9c4a90ac4e7c7dcf518cfb3fcd99ef2/lib/appium_lib/ios/helper.rb#L478) ios > def ele_by_json_visible_contains(element, value) Find the first element that contains value. For Appium(automation name), not XCUITest @@ -2278,11 +2331,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Element] -- -##### [eles_by_json_visible_contains](https://github.com/appium/ruby_lib/blob/02da3389a76ed75e42cc8f8f2018dc61cc93c70c/lib/appium_lib/ios/helper.rb#L487) ios +##### [eles_by_json_visible_contains](https://github.com/appium/ruby_lib/blob/11cdf97bf9c4a90ac4e7c7dcf518cfb3fcd99ef2/lib/appium_lib/ios/helper.rb#L487) ios > def eles_by_json_visible_contains(element, value) Find all elements containing value For Appium(automation name), not XCUITest @@ -2297,11 +2350,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Array<Element>] -- -##### [ele_by_json_visible_exact](https://github.com/appium/ruby_lib/blob/02da3389a76ed75e42cc8f8f2018dc61cc93c70c/lib/appium_lib/ios/helper.rb#L517) ios +##### [ele_by_json_visible_exact](https://github.com/appium/ruby_lib/blob/11cdf97bf9c4a90ac4e7c7dcf518cfb3fcd99ef2/lib/appium_lib/ios/helper.rb#L517) ios > def ele_by_json_visible_exact(element, value) Find the first element exactly matching value For Appium(automation name), not XCUITest @@ -2316,11 +2369,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Element] -- -##### [eles_by_json_visible_exact](https://github.com/appium/ruby_lib/blob/02da3389a76ed75e42cc8f8f2018dc61cc93c70c/lib/appium_lib/ios/helper.rb#L526) ios +##### [eles_by_json_visible_exact](https://github.com/appium/ruby_lib/blob/11cdf97bf9c4a90ac4e7c7dcf518cfb3fcd99ef2/lib/appium_lib/ios/helper.rb#L526) ios > def eles_by_json_visible_exact(element, value) Find all elements exactly matching value For Appium(automation name), not XCUITest @@ -2335,21 +2388,21 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Element] -- -##### [_all_pred](https://github.com/appium/ruby_lib/blob/02da3389a76ed75e42cc8f8f2018dc61cc93c70c/lib/appium_lib/ios/helper.rb#L591) ios +##### [_all_pred](https://github.com/appium/ruby_lib/blob/11cdf97bf9c4a90ac4e7c7dcf518cfb3fcd99ef2/lib/appium_lib/ios/helper.rb#L591) 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/02da3389a76ed75e42cc8f8f2018dc61cc93c70c/lib/appium_lib/ios/helper.rb#L604) ios +##### [ele_with_pred](https://github.com/appium/ruby_lib/blob/11cdf97bf9c4a90ac4e7c7dcf518cfb3fcd99ef2/lib/appium_lib/ios/helper.rb#L604) ios > def ele_with_pred(opts) returns element matching predicate contained in the main app @@ -2361,11 +2414,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Element] -- -##### [eles_with_pred](https://github.com/appium/ruby_lib/blob/02da3389a76ed75e42cc8f8f2018dc61cc93c70c/lib/appium_lib/ios/helper.rb#L615) ios +##### [eles_with_pred](https://github.com/appium/ruby_lib/blob/11cdf97bf9c4a90ac4e7c7dcf518cfb3fcd99ef2/lib/appium_lib/ios/helper.rb#L615) ios > def eles_with_pred(opts) returns elements matching predicate contained in the main app @@ -2377,11 +2430,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Array<Element>] -- -##### [source](https://github.com/appium/ruby_lib/blob/02da3389a76ed75e42cc8f8f2018dc61cc93c70c/lib/appium_lib/ios/helper.rb#L621) ios +##### [source](https://github.com/appium/ruby_lib/blob/11cdf97bf9c4a90ac4e7c7dcf518cfb3fcd99ef2/lib/appium_lib/ios/helper.rb#L621) ios > def source Prints xml of the current page @@ -2389,19 +2442,19 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[void] -- -##### [_validate_object](https://github.com/appium/ruby_lib/blob/02da3389a76ed75e42cc8f8f2018dc61cc93c70c/lib/appium_lib/ios/helper.rb#L625) ios +##### [_validate_object](https://github.com/appium/ruby_lib/blob/11cdf97bf9c4a90ac4e7c7dcf518cfb3fcd99ef2/lib/appium_lib/ios/helper.rb#L625) ios > def _validate_object(*objects) -- -##### [_by_json](https://github.com/appium/ruby_lib/blob/02da3389a76ed75e42cc8f8f2018dc61cc93c70c/lib/appium_lib/ios/helper.rb#L674) ios +##### [_by_json](https://github.com/appium/ruby_lib/blob/11cdf97bf9c4a90ac4e7c7dcf518cfb3fcd99ef2/lib/appium_lib/ios/helper.rb#L674) ios > def _by_json(opts) For Appium(automation name), not XCUITest typeArray - array of string types to search for. Example: ["UIAStaticText"] @@ -2432,11 +2485,11 @@ } } -- -##### [eles_by_json](https://github.com/appium/ruby_lib/blob/02da3389a76ed75e42cc8f8f2018dc61cc93c70c/lib/appium_lib/ios/helper.rb#L724) ios +##### [eles_by_json](https://github.com/appium/ruby_lib/blob/11cdf97bf9c4a90ac4e7c7dcf518cfb3fcd99ef2/lib/appium_lib/ios/helper.rb#L724) ios > def eles_by_json(opts) For Appium(automation name), not XCUITest example usage: @@ -2451,19 +2504,19 @@ }, }) -- -##### [ele_by_json](https://github.com/appium/ruby_lib/blob/02da3389a76ed75e42cc8f8f2018dc61cc93c70c/lib/appium_lib/ios/helper.rb#L730) ios +##### [ele_by_json](https://github.com/appium/ruby_lib/blob/11cdf97bf9c4a90ac4e7c7dcf518cfb3fcd99ef2/lib/appium_lib/ios/helper.rb#L730) ios > def ele_by_json(opts) see eles_by_json -- -##### [get_source](https://github.com/appium/ruby_lib/blob/02da3389a76ed75e42cc8f8f2018dc61cc93c70c/lib/appium_lib/ios/helper.rb#L740) ios +##### [get_source](https://github.com/appium/ruby_lib/blob/11cdf97bf9c4a90ac4e7c7dcf518cfb3fcd99ef2/lib/appium_lib/ios/helper.rb#L740) ios > def get_source Returns XML string for the current page Same as driver.page_source @@ -2472,27 +2525,27 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[String] -- -##### [UIAStaticText](https://github.com/appium/ruby_lib/blob/02da3389a76ed75e42cc8f8f2018dc61cc93c70c/lib/appium_lib/ios/element/text.rb#L4) ios +##### [UIAStaticText](https://github.com/appium/ruby_lib/blob/11cdf97bf9c4a90ac4e7c7dcf518cfb3fcd99ef2/lib/appium_lib/ios/element/text.rb#L4) ios > UIAStaticText = 'UIAStaticText'.freeze -- -##### [XCUIElementTypeStaticText](https://github.com/appium/ruby_lib/blob/02da3389a76ed75e42cc8f8f2018dc61cc93c70c/lib/appium_lib/ios/element/text.rb#L5) ios +##### [XCUIElementTypeStaticText](https://github.com/appium/ruby_lib/blob/11cdf97bf9c4a90ac4e7c7dcf518cfb3fcd99ef2/lib/appium_lib/ios/element/text.rb#L5) ios > XCUIElementTypeStaticText = 'XCUIElementTypeStaticText'.freeze -- -##### [static_text_class](https://github.com/appium/ruby_lib/blob/02da3389a76ed75e42cc8f8f2018dc61cc93c70c/lib/appium_lib/ios/element/text.rb#L8) ios +##### [static_text_class](https://github.com/appium/ruby_lib/blob/11cdf97bf9c4a90ac4e7c7dcf518cfb3fcd99ef2/lib/appium_lib/ios/element/text.rb#L8) ios > def static_text_class @@ -2500,11 +2553,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[String] Class name for text -- -##### [text](https://github.com/appium/ruby_lib/blob/02da3389a76ed75e42cc8f8f2018dc61cc93c70c/lib/appium_lib/ios/element/text.rb#L16) ios +##### [text](https://github.com/appium/ruby_lib/blob/11cdf97bf9c4a90ac4e7c7dcf518cfb3fcd99ef2/lib/appium_lib/ios/element/text.rb#L16) ios > def text(value) Find the first UIAStaticText|XCUIElementTypeStaticText that contains value or by index. If int then the UIAStaticText|XCUIElementTypeStaticText at that index is returned. @@ -2517,11 +2570,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[UIAStaticText|XCUIElementTypeStaticText] -- -##### [texts](https://github.com/appium/ruby_lib/blob/02da3389a76ed75e42cc8f8f2018dc61cc93c70c/lib/appium_lib/ios/element/text.rb#L30) ios +##### [texts](https://github.com/appium/ruby_lib/blob/11cdf97bf9c4a90ac4e7c7dcf518cfb3fcd99ef2/lib/appium_lib/ios/element/text.rb#L30) ios > def texts(value = false) Find all UIAStaticTexts|XCUIElementTypeStaticTexts containing value. If value is omitted, all UIAStaticTexts|XCUIElementTypeStaticTexts are returned @@ -2534,11 +2587,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Array<UIAStaticText|XCUIElementTypeStaticText>] -- -##### [first_text](https://github.com/appium/ruby_lib/blob/02da3389a76ed75e42cc8f8f2018dc61cc93c70c/lib/appium_lib/ios/element/text.rb#L43) ios +##### [first_text](https://github.com/appium/ruby_lib/blob/11cdf97bf9c4a90ac4e7c7dcf518cfb3fcd99ef2/lib/appium_lib/ios/element/text.rb#L43) ios > def first_text Find the first UIAStaticText|XCUIElementTypeStaticText. @@ -2546,11 +2599,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[UIAStaticText|XCUIElementTypeStaticText] -- -##### [last_text](https://github.com/appium/ruby_lib/blob/02da3389a76ed75e42cc8f8f2018dc61cc93c70c/lib/appium_lib/ios/element/text.rb#L49) ios +##### [last_text](https://github.com/appium/ruby_lib/blob/11cdf97bf9c4a90ac4e7c7dcf518cfb3fcd99ef2/lib/appium_lib/ios/element/text.rb#L49) ios > def last_text Find the last UIAStaticText|XCUIElementTypeStaticText. @@ -2558,11 +2611,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[UIAStaticText|XCUIElementTypeStaticText] -- -##### [text_exact](https://github.com/appium/ruby_lib/blob/02da3389a76ed75e42cc8f8f2018dc61cc93c70c/lib/appium_lib/ios/element/text.rb#L56) ios +##### [text_exact](https://github.com/appium/ruby_lib/blob/11cdf97bf9c4a90ac4e7c7dcf518cfb3fcd99ef2/lib/appium_lib/ios/element/text.rb#L56) ios > def text_exact(value) Find the first UIAStaticText|XCUIElementTypeStaticText that exactly matches value. @@ -2574,11 +2627,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[UIAStaticText|XCUIElementTypeStaticText] -- -##### [texts_exact](https://github.com/appium/ruby_lib/blob/02da3389a76ed75e42cc8f8f2018dc61cc93c70c/lib/appium_lib/ios/element/text.rb#L67) ios +##### [texts_exact](https://github.com/appium/ruby_lib/blob/11cdf97bf9c4a90ac4e7c7dcf518cfb3fcd99ef2/lib/appium_lib/ios/element/text.rb#L67) ios > def texts_exact(value) Find all UIAStaticTexts|XCUIElementTypeStaticTexts that exactly match value. @@ -2590,11 +2643,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Array<UIAStaticText|XCUIElementTypeStaticText>] -- -##### [alert_accept](https://github.com/appium/ruby_lib/blob/02da3389a76ed75e42cc8f8f2018dc61cc93c70c/lib/appium_lib/ios/element/alert.rb#L5) ios +##### [alert_accept](https://github.com/appium/ruby_lib/blob/11cdf97bf9c4a90ac4e7c7dcf518cfb3fcd99ef2/lib/appium_lib/ios/element/alert.rb#L5) ios > def alert_accept Accept the alert. @@ -2602,11 +2655,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[void] -- -##### [alert_dismiss](https://github.com/appium/ruby_lib/blob/02da3389a76ed75e42cc8f8f2018dc61cc93c70c/lib/appium_lib/ios/element/alert.rb#L13) ios +##### [alert_dismiss](https://github.com/appium/ruby_lib/blob/11cdf97bf9c4a90ac4e7c7dcf518cfb3fcd99ef2/lib/appium_lib/ios/element/alert.rb#L13) ios > def alert_dismiss Dismiss the alert. @@ -2614,27 +2667,27 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[void] -- -##### [UIAButton](https://github.com/appium/ruby_lib/blob/02da3389a76ed75e42cc8f8f2018dc61cc93c70c/lib/appium_lib/ios/element/button.rb#L4) ios +##### [UIAButton](https://github.com/appium/ruby_lib/blob/11cdf97bf9c4a90ac4e7c7dcf518cfb3fcd99ef2/lib/appium_lib/ios/element/button.rb#L4) ios > UIAButton = 'UIAButton'.freeze -- -##### [XCUIElementTypeButton](https://github.com/appium/ruby_lib/blob/02da3389a76ed75e42cc8f8f2018dc61cc93c70c/lib/appium_lib/ios/element/button.rb#L5) ios +##### [XCUIElementTypeButton](https://github.com/appium/ruby_lib/blob/11cdf97bf9c4a90ac4e7c7dcf518cfb3fcd99ef2/lib/appium_lib/ios/element/button.rb#L5) ios > XCUIElementTypeButton = 'XCUIElementTypeButton'.freeze -- -##### [button_class](https://github.com/appium/ruby_lib/blob/02da3389a76ed75e42cc8f8f2018dc61cc93c70c/lib/appium_lib/ios/element/button.rb#L8) ios +##### [button_class](https://github.com/appium/ruby_lib/blob/11cdf97bf9c4a90ac4e7c7dcf518cfb3fcd99ef2/lib/appium_lib/ios/element/button.rb#L8) ios > def button_class @@ -2642,11 +2695,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[String] Class name for button -- -##### [button](https://github.com/appium/ruby_lib/blob/02da3389a76ed75e42cc8f8f2018dc61cc93c70c/lib/appium_lib/ios/element/button.rb#L16) ios +##### [button](https://github.com/appium/ruby_lib/blob/11cdf97bf9c4a90ac4e7c7dcf518cfb3fcd99ef2/lib/appium_lib/ios/element/button.rb#L16) ios > def button(value) Find the first UIAButton|XCUIElementTypeButton that contains value or by index. If int then the UIAButton|XCUIElementTypeButton at that index is returned. @@ -2659,11 +2712,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[UIAButton|XCUIElementTypeButton] -- -##### [buttons](https://github.com/appium/ruby_lib/blob/02da3389a76ed75e42cc8f8f2018dc61cc93c70c/lib/appium_lib/ios/element/button.rb#L31) ios +##### [buttons](https://github.com/appium/ruby_lib/blob/11cdf97bf9c4a90ac4e7c7dcf518cfb3fcd99ef2/lib/appium_lib/ios/element/button.rb#L31) ios > def buttons(value = false) Find all UIAButtons|XCUIElementTypeButtons containing value. If value is omitted, all UIAButtons|XCUIElementTypeButtons are returned. @@ -2676,11 +2729,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Array<UIAButton|XCUIElementTypeButton>] -- -##### [first_button](https://github.com/appium/ruby_lib/blob/02da3389a76ed75e42cc8f8f2018dc61cc93c70c/lib/appium_lib/ios/element/button.rb#L44) ios +##### [first_button](https://github.com/appium/ruby_lib/blob/11cdf97bf9c4a90ac4e7c7dcf518cfb3fcd99ef2/lib/appium_lib/ios/element/button.rb#L44) ios > def first_button Find the first UIAButton|XCUIElementTypeButton. @@ -2688,11 +2741,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[UIAButton|XCUIElementTypeButton] -- -##### [last_button](https://github.com/appium/ruby_lib/blob/02da3389a76ed75e42cc8f8f2018dc61cc93c70c/lib/appium_lib/ios/element/button.rb#L52) ios +##### [last_button](https://github.com/appium/ruby_lib/blob/11cdf97bf9c4a90ac4e7c7dcf518cfb3fcd99ef2/lib/appium_lib/ios/element/button.rb#L52) ios > def last_button TODO: add documentation regarding previous element. Previous UIAElement is differ from UIAButton|XCUIElementTypeButton. So, the results are different. @@ -2702,11 +2755,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[UIAButton|XCUIElementTypeButton] -- -##### [button_exact](https://github.com/appium/ruby_lib/blob/02da3389a76ed75e42cc8f8f2018dc61cc93c70c/lib/appium_lib/ios/element/button.rb#L59) ios +##### [button_exact](https://github.com/appium/ruby_lib/blob/11cdf97bf9c4a90ac4e7c7dcf518cfb3fcd99ef2/lib/appium_lib/ios/element/button.rb#L59) ios > def button_exact(value) Find the first UIAButton|XCUIElementTypeButton that exactly matches value. @@ -2718,11 +2771,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[UIAButton|XCUIElementTypeButton] -- -##### [buttons_exact](https://github.com/appium/ruby_lib/blob/02da3389a76ed75e42cc8f8f2018dc61cc93c70c/lib/appium_lib/ios/element/button.rb#L70) ios +##### [buttons_exact](https://github.com/appium/ruby_lib/blob/11cdf97bf9c4a90ac4e7c7dcf518cfb3fcd99ef2/lib/appium_lib/ios/element/button.rb#L70) ios > def buttons_exact(value) Find all UIAButtons|XCUIElementTypeButtons that exactly match value. @@ -2734,11 +2787,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Array<UIAButton|XCUIElementTypeButton>] -- -##### [uiautomation_find](https://github.com/appium/ruby_lib/blob/02da3389a76ed75e42cc8f8f2018dc61cc93c70c/lib/appium_lib/ios/mobile_methods.rb#L19) ios +##### [uiautomation_find](https://github.com/appium/ruby_lib/blob/11cdf97bf9c4a90ac4e7c7dcf518cfb3fcd99ef2/lib/appium_lib/ios/mobile_methods.rb#L32) ios > def uiautomation_find find_element/s can be used with a [UIAutomation command](https://developer.apple.com/library/ios/documentation/ToolsLanguages/Reference/UIAWindowClassReference/UIAWindow/UIAWindow.html#//apple_ref/doc/uid/TP40009930). @@ -2746,11 +2799,11 @@ find_elements :uiautomation, 'elements() ``` -- -##### [ios_predicate_string_find](https://github.com/appium/ruby_lib/blob/02da3389a76ed75e42cc8f8f2018dc61cc93c70c/lib/appium_lib/ios/mobile_methods.rb#L19) ios +##### [ios_predicate_string_find](https://github.com/appium/ruby_lib/blob/11cdf97bf9c4a90ac4e7c7dcf518cfb3fcd99ef2/lib/appium_lib/ios/mobile_methods.rb#L32) ios > def ios_predicate_string_find find_element/s can be used with a [Predicates](https://developer.apple.com/library/content/documentation/Cocoa/Conceptual/Predicates/AdditionalChapters/Introduction.html) @@ -2760,12 +2813,30 @@ find_elements :predicate, 'wdValue == "SearchBar" AND isWDDivisible == 1' ``` -- -##### [find](https://github.com/appium/ruby_lib/blob/02da3389a76ed75e42cc8f8f2018dc61cc93c70c/lib/appium_lib/ios/element/generic.rb#L6) ios +##### [ios_class_chain_find](https://github.com/appium/ruby_lib/blob/11cdf97bf9c4a90ac4e7c7dcf518cfb3fcd99ef2/lib/appium_lib/ios/mobile_methods.rb#L32) ios +> def ios_class_chain_find + +Only for XCUITest(WebDriverAgent) +find_element/s can be used with a [class chain]( https://github.com/facebook/WebDriverAgent/wiki/Queries) + +```ruby + # select the third child button of the first child window element + find_elements :class_chain, 'XCUIElementTypeWindow/XCUIElementTypeButton[3]' + # select all the children windows + find_elements :class_chain, 'XCUIElementTypeWindow' + # select the second last child of the second child window + find_elements :class_chain, 'XCUIElementTypeWindow[2]/XCUIElementTypeAny[-2]' +``` + +-- + +##### [find](https://github.com/appium/ruby_lib/blob/11cdf97bf9c4a90ac4e7c7dcf518cfb3fcd99ef2/lib/appium_lib/ios/element/generic.rb#L6) ios + > def find(value) Find the first element containing value __Parameters:__ @@ -2776,11 +2847,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Element] -- -##### [finds](https://github.com/appium/ruby_lib/blob/02da3389a76ed75e42cc8f8f2018dc61cc93c70c/lib/appium_lib/ios/element/generic.rb#L17) ios +##### [finds](https://github.com/appium/ruby_lib/blob/11cdf97bf9c4a90ac4e7c7dcf518cfb3fcd99ef2/lib/appium_lib/ios/element/generic.rb#L17) ios > def finds(value) Find all elements containing value @@ -2792,11 +2863,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Array<Element>] -- -##### [find_exact](https://github.com/appium/ruby_lib/blob/02da3389a76ed75e42cc8f8f2018dc61cc93c70c/lib/appium_lib/ios/element/generic.rb#L29) ios +##### [find_exact](https://github.com/appium/ruby_lib/blob/11cdf97bf9c4a90ac4e7c7dcf518cfb3fcd99ef2/lib/appium_lib/ios/element/generic.rb#L29) ios > def find_exact(value) Find the first element exactly matching value @@ -2808,11 +2879,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Element] -- -##### [finds_exact](https://github.com/appium/ruby_lib/blob/02da3389a76ed75e42cc8f8f2018dc61cc93c70c/lib/appium_lib/ios/element/generic.rb#L40) ios +##### [finds_exact](https://github.com/appium/ruby_lib/blob/11cdf97bf9c4a90ac4e7c7dcf518cfb3fcd99ef2/lib/appium_lib/ios/element/generic.rb#L40) ios > def finds_exact(value) Find all elements exactly matching value @@ -2824,59 +2895,59 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Array<Element>] -- -##### [raise_error_if_no_element](https://github.com/appium/ruby_lib/blob/02da3389a76ed75e42cc8f8f2018dc61cc93c70c/lib/appium_lib/ios/element/generic.rb#L51) ios +##### [raise_error_if_no_element](https://github.com/appium/ruby_lib/blob/11cdf97bf9c4a90ac4e7c7dcf518cfb3fcd99ef2/lib/appium_lib/ios/element/generic.rb#L51) ios > def raise_error_if_no_element(element) -- -##### [select_visible_elements](https://github.com/appium/ruby_lib/blob/02da3389a76ed75e42cc8f8f2018dc61cc93c70c/lib/appium_lib/ios/element/generic.rb#L58) ios +##### [select_visible_elements](https://github.com/appium/ruby_lib/blob/11cdf97bf9c4a90ac4e7c7dcf518cfb3fcd99ef2/lib/appium_lib/ios/element/generic.rb#L58) ios > def select_visible_elements(elements) Return visible elements. -- -##### [UIATextField](https://github.com/appium/ruby_lib/blob/02da3389a76ed75e42cc8f8f2018dc61cc93c70c/lib/appium_lib/ios/element/textfield.rb#L3) ios +##### [UIATextField](https://github.com/appium/ruby_lib/blob/11cdf97bf9c4a90ac4e7c7dcf518cfb3fcd99ef2/lib/appium_lib/ios/element/textfield.rb#L3) ios > UIATextField = 'UIATextField'.freeze -- -##### [UIASecureTextField](https://github.com/appium/ruby_lib/blob/02da3389a76ed75e42cc8f8f2018dc61cc93c70c/lib/appium_lib/ios/element/textfield.rb#L4) ios +##### [UIASecureTextField](https://github.com/appium/ruby_lib/blob/11cdf97bf9c4a90ac4e7c7dcf518cfb3fcd99ef2/lib/appium_lib/ios/element/textfield.rb#L4) ios > UIASecureTextField = 'UIASecureTextField'.freeze -- -##### [XCUIElementTypeTextField](https://github.com/appium/ruby_lib/blob/02da3389a76ed75e42cc8f8f2018dc61cc93c70c/lib/appium_lib/ios/element/textfield.rb#L6) ios +##### [XCUIElementTypeTextField](https://github.com/appium/ruby_lib/blob/11cdf97bf9c4a90ac4e7c7dcf518cfb3fcd99ef2/lib/appium_lib/ios/element/textfield.rb#L6) ios > XCUIElementTypeTextField = 'XCUIElementTypeTextField'.freeze -- -##### [XCUIElementTypeSecureTextField](https://github.com/appium/ruby_lib/blob/02da3389a76ed75e42cc8f8f2018dc61cc93c70c/lib/appium_lib/ios/element/textfield.rb#L7) ios +##### [XCUIElementTypeSecureTextField](https://github.com/appium/ruby_lib/blob/11cdf97bf9c4a90ac4e7c7dcf518cfb3fcd99ef2/lib/appium_lib/ios/element/textfield.rb#L7) ios > XCUIElementTypeSecureTextField = 'XCUIElementTypeSecureTextField'.freeze -- -##### [text_field_class](https://github.com/appium/ruby_lib/blob/02da3389a76ed75e42cc8f8f2018dc61cc93c70c/lib/appium_lib/ios/element/textfield.rb#L10) ios +##### [text_field_class](https://github.com/appium/ruby_lib/blob/11cdf97bf9c4a90ac4e7c7dcf518cfb3fcd99ef2/lib/appium_lib/ios/element/textfield.rb#L10) ios > def text_field_class @@ -2884,11 +2955,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[String] Class name for text field -- -##### [secure_text_field_class](https://github.com/appium/ruby_lib/blob/02da3389a76ed75e42cc8f8f2018dc61cc93c70c/lib/appium_lib/ios/element/textfield.rb#L15) ios +##### [secure_text_field_class](https://github.com/appium/ruby_lib/blob/11cdf97bf9c4a90ac4e7c7dcf518cfb3fcd99ef2/lib/appium_lib/ios/element/textfield.rb#L15) ios > def secure_text_field_class @@ -2896,35 +2967,35 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[String] Class name for secure text field -- -##### [_textfield_visible](https://github.com/appium/ruby_lib/blob/02da3389a76ed75e42cc8f8f2018dc61cc93c70c/lib/appium_lib/ios/element/textfield.rb#L35) ios +##### [_textfield_visible](https://github.com/appium/ruby_lib/blob/11cdf97bf9c4a90ac4e7c7dcf518cfb3fcd99ef2/lib/appium_lib/ios/element/textfield.rb#L35) ios > def _textfield_visible Appium -- -##### [_textfield_exact_string](https://github.com/appium/ruby_lib/blob/02da3389a76ed75e42cc8f8f2018dc61cc93c70c/lib/appium_lib/ios/element/textfield.rb#L40) ios +##### [_textfield_exact_string](https://github.com/appium/ruby_lib/blob/11cdf97bf9c4a90ac4e7c7dcf518cfb3fcd99ef2/lib/appium_lib/ios/element/textfield.rb#L40) ios > def _textfield_exact_string(value) Appium -- -##### [_textfield_contains_string](https://github.com/appium/ruby_lib/blob/02da3389a76ed75e42cc8f8f2018dc61cc93c70c/lib/appium_lib/ios/element/textfield.rb#L47) ios +##### [_textfield_contains_string](https://github.com/appium/ruby_lib/blob/11cdf97bf9c4a90ac4e7c7dcf518cfb3fcd99ef2/lib/appium_lib/ios/element/textfield.rb#L47) ios > def _textfield_contains_string(value) Appium -- -##### [textfield](https://github.com/appium/ruby_lib/blob/02da3389a76ed75e42cc8f8f2018dc61cc93c70c/lib/appium_lib/ios/element/textfield.rb#L60) ios +##### [textfield](https://github.com/appium/ruby_lib/blob/11cdf97bf9c4a90ac4e7c7dcf518cfb3fcd99ef2/lib/appium_lib/ios/element/textfield.rb#L60) ios > def textfield(value) Find the first TextField that contains value or by index. Note: Uses XPath @@ -2938,11 +3009,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[TextField] -- -##### [textfields](https://github.com/appium/ruby_lib/blob/02da3389a76ed75e42cc8f8f2018dc61cc93c70c/lib/appium_lib/ios/element/textfield.rb#L86) ios +##### [textfields](https://github.com/appium/ruby_lib/blob/11cdf97bf9c4a90ac4e7c7dcf518cfb3fcd99ef2/lib/appium_lib/ios/element/textfield.rb#L86) ios > def textfields(value = false) Find all TextFields containing value. If value is omitted, all TextFields are returned. @@ -2955,11 +3026,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Array<TextField>] -- -##### [first_textfield](https://github.com/appium/ruby_lib/blob/02da3389a76ed75e42cc8f8f2018dc61cc93c70c/lib/appium_lib/ios/element/textfield.rb#L100) ios +##### [first_textfield](https://github.com/appium/ruby_lib/blob/11cdf97bf9c4a90ac4e7c7dcf518cfb3fcd99ef2/lib/appium_lib/ios/element/textfield.rb#L100) ios > def first_textfield Find the first TextField. @@ -2967,11 +3038,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[TextField] -- -##### [last_textfield](https://github.com/appium/ruby_lib/blob/02da3389a76ed75e42cc8f8f2018dc61cc93c70c/lib/appium_lib/ios/element/textfield.rb#L110) ios +##### [last_textfield](https://github.com/appium/ruby_lib/blob/11cdf97bf9c4a90ac4e7c7dcf518cfb3fcd99ef2/lib/appium_lib/ios/element/textfield.rb#L110) ios > def last_textfield Find the last TextField. @@ -2979,11 +3050,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[TextField] -- -##### [textfield_exact](https://github.com/appium/ruby_lib/blob/02da3389a76ed75e42cc8f8f2018dc61cc93c70c/lib/appium_lib/ios/element/textfield.rb#L123) ios +##### [textfield_exact](https://github.com/appium/ruby_lib/blob/11cdf97bf9c4a90ac4e7c7dcf518cfb3fcd99ef2/lib/appium_lib/ios/element/textfield.rb#L123) ios > def textfield_exact(value) Find the first TextField that exactly matches value. @@ -2995,11 +3066,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[TextField] -- -##### [textfields_exact](https://github.com/appium/ruby_lib/blob/02da3389a76ed75e42cc8f8f2018dc61cc93c70c/lib/appium_lib/ios/element/textfield.rb#L134) ios +##### [textfields_exact](https://github.com/appium/ruby_lib/blob/11cdf97bf9c4a90ac4e7c7dcf518cfb3fcd99ef2/lib/appium_lib/ios/element/textfield.rb#L134) ios > def textfields_exact(value) Find all TextFields that exactly match value. @@ -3011,31 +3082,31 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Array<TextField>] -- -##### [value](https://github.com/appium/ruby_lib/blob/02da3389a76ed75e42cc8f8f2018dc61cc93c70c/lib/appium_lib/common/patch.rb#L12) +##### [value](https://github.com/appium/ruby_lib/blob/11cdf97bf9c4a90ac4e7c7dcf518cfb3fcd99ef2/lib/appium_lib/common/patch.rb#L12) > def value Returns the value attribute Fixes NoMethodError: undefined method `value' for Selenium::WebDriver::Element -- -##### [name](https://github.com/appium/ruby_lib/blob/02da3389a76ed75e42cc8f8f2018dc61cc93c70c/lib/appium_lib/common/patch.rb#L19) +##### [name](https://github.com/appium/ruby_lib/blob/11cdf97bf9c4a90ac4e7c7dcf518cfb3fcd99ef2/lib/appium_lib/common/patch.rb#L19) > def name Returns the name attribute Fixes NoMethodError: undefined method `name' for Selenium::WebDriver::Element -- -##### [location_rel](https://github.com/appium/ruby_lib/blob/02da3389a76ed75e42cc8f8f2018dc61cc93c70c/lib/appium_lib/common/patch.rb#L31) +##### [location_rel](https://github.com/appium/ruby_lib/blob/11cdf97bf9c4a90ac4e7c7dcf518cfb3fcd99ef2/lib/appium_lib/common/patch.rb#L31) > def location_rel For use with mobile tap. @@ -3049,18 +3120,18 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[OpenStruct] the relative x, y in a struct. ex: { x: 0.50, y: 0.20 } -- -##### [DEFAULT_HEADERS](https://github.com/appium/ruby_lib/blob/02da3389a76ed75e42cc8f8f2018dc61cc93c70c/lib/appium_lib/common/patch.rb#L152) +##### [DEFAULT_HEADERS](https://github.com/appium/ruby_lib/blob/11cdf97bf9c4a90ac4e7c7dcf518cfb3fcd99ef2/lib/appium_lib/common/patch.rb#L152) > DEFAULT_HEADERS = { 'Accept' => CONTENT_TYPE, 'User-Agent' => "appium/ruby_lib/#{::Appium::VERSION}" }.freeze -- -##### [patch_remote_driver_commands](https://github.com/appium/ruby_lib/blob/02da3389a76ed75e42cc8f8f2018dc61cc93c70c/lib/appium_lib/common/patch.rb#L155) +##### [patch_remote_driver_commands](https://github.com/appium/ruby_lib/blob/11cdf97bf9c4a90ac4e7c7dcf518cfb3fcd99ef2/lib/appium_lib/common/patch.rb#L155) > def patch_remote_driver_commands