diff --git a/appium_lib.gemspec b/appium_lib.gemspec index b5e1ea9f..1c525289 100644 --- a/appium_lib.gemspec +++ b/appium_lib.gemspec @@ -18,7 +18,7 @@ Gem::Specification.new do |s| s.add_runtime_dependency 'nokogiri', '~> 1.8', '>= 1.8.1' s.add_runtime_dependency 'tomlrb', '~> 1.1' - s.add_development_dependency 'appium_thor', '~> 1.1', '>= 1.1.2' + s.add_development_dependency 'appium_thor', '~> 1.1', '>= 1.1.4' s.add_development_dependency 'fakefs', '~> 0.13.0' s.add_development_dependency 'hashdiff', '~> 0.3.7' s.add_development_dependency 'posix-spawn', '~> 0.3' diff --git a/docs/android_docs.md b/docs/android_docs.md index 735f612a..c52862d9 100644 --- a/docs/android_docs.md +++ b/docs/android_docs.md @@ -1,4 +1,4 @@ -##### [load_settings](https://github.com/appium/ruby_lib/blob/621a9ebaf18bcd80eb0e1f5fc17fbb4dddf5293a/lib/appium_lib/appium.rb#L46) common +##### [load_settings](https://github.com/appium/ruby_lib/blob/1ca8483c461f010a02aec40ec723fd3573a14cd1/lib/appium_lib/appium.rb#L46) common > def load_settings(opts = {}) @@ -17,11 +17,17 @@ port = 8080 :require is expanded all keys are converted to symbols -__Parameters:__\n\n     [Hash] opts - file: '/path/to/appium.txt', verbose: true +__Parameters:__ -__Returns:__\n\n     [hash] the symbolized hash with updated :app and :require keys +     [Hash] opts - file: '/path/to/appium.txt', verbose: true ---\n\n##### [load_appium_txt](https://github.com/appium/ruby_lib/blob/621a9ebaf18bcd80eb0e1f5fc17fbb4dddf5293a/lib/appium_lib/appium.rb#L82) common +__Returns:__ + +     [hash] the symbolized hash with updated :app and :require keys + +-- + +##### [load_appium_txt](https://github.com/appium/ruby_lib/blob/1ca8483c461f010a02aec40ec723fd3573a14cd1/lib/appium_lib/appium.rb#L82) common > def load_settings(opts = {}) @@ -40,23 +46,35 @@ port = 8080 :require is expanded all keys are converted to symbols -__Parameters:__\n\n     [Hash] opts - file: '/path/to/appium.txt', verbose: true +__Parameters:__ + +     [Hash] opts - file: '/path/to/appium.txt', verbose: true -__Returns:__\n\n     [hash] the symbolized hash with updated :app and :require keys +__Returns:__ ---\n\n##### [expand_required_files](https://github.com/appium/ruby_lib/blob/621a9ebaf18bcd80eb0e1f5fc17fbb4dddf5293a/lib/appium_lib/appium.rb#L87) common +     [hash] the symbolized hash with updated :app and :require keys + +-- + +##### [expand_required_files](https://github.com/appium/ruby_lib/blob/1ca8483c461f010a02aec40ec723fd3573a14cd1/lib/appium_lib/appium.rb#L87) common > def expand_required_files(base_dir, file_paths) -__Parameters:__\n\n     [String] base_dir - parent directory of loaded appium.txt (toml) +__Parameters:__ + +     [String] base_dir - parent directory of loaded appium.txt (toml)      [String] file_paths - -__Returns:__\n\n     [Array] list of require files as an array, nil if require doesn't exist +__Returns:__ ---\n\n##### [promote_singleton_appium_methods](https://github.com/appium/ruby_lib/blob/621a9ebaf18bcd80eb0e1f5fc17fbb4dddf5293a/lib/appium_lib/appium.rb#L129) common +     [Array] list of require files as an array, nil if require doesn't exist + +-- + +##### [promote_singleton_appium_methods](https://github.com/appium/ruby_lib/blob/1ca8483c461f010a02aec40ec723fd3573a14cd1/lib/appium_lib/appium.rb#L129) common > def promote_singleton_appium_methods(modules, driver = $driver) @@ -72,11 +90,15 @@ if modules is a module instead of an array, then the constants of that module are promoted on. otherwise, the array of modules will be used as the promotion target. -__Parameters:__\n\n     [Array] modules - An array of modules +__Parameters:__ + +     [Array] modules - An array of modules      [Driver] driver - A driver to extend for ---\n\n##### [promote_appium_methods](https://github.com/appium/ruby_lib/blob/621a9ebaf18bcd80eb0e1f5fc17fbb4dddf5293a/lib/appium_lib/appium.rb#L185) common +-- + +##### [promote_appium_methods](https://github.com/appium/ruby_lib/blob/1ca8483c461f010a02aec40ec723fd3573a14cd1/lib/appium_lib/appium.rb#L185) common > def promote_appium_methods(class_array, driver = $driver) @@ -86,222 +108,306 @@ To promote methods to all classes: It's better to promote on specific classes instead of Object -__Parameters:__\n\n     [Array] class_array - An array of classes +__Parameters:__ + +     [Array] class_array - An array of classes      [Driver] driver - A driver to extend for ---\n\n##### [global_webdriver_http_sleep](https://github.com/appium/ruby_lib/blob/621a9ebaf18bcd80eb0e1f5fc17fbb4dddf5293a/lib/appium_lib/driver.rb#L37) common +-- + +##### [global_webdriver_http_sleep](https://github.com/appium/ruby_lib/blob/1ca8483c461f010a02aec40ec723fd3573a14cd1/lib/appium_lib/driver.rb#L37) common > def global_webdriver_http_sleep The amount to sleep in seconds before every webdriver http call. ---\n\n##### [global_webdriver_http_sleep=](https://github.com/appium/ruby_lib/blob/621a9ebaf18bcd80eb0e1f5fc17fbb4dddf5293a/lib/appium_lib/driver.rb#L37) common +-- + +##### [global_webdriver_http_sleep=](https://github.com/appium/ruby_lib/blob/1ca8483c461f010a02aec40ec723fd3573a14cd1/lib/appium_lib/driver.rb#L37) common > def global_webdriver_http_sleep=(value) The amount to sleep in seconds before every webdriver http call. ---\n\n##### [sauce](https://github.com/appium/ruby_lib/blob/621a9ebaf18bcd80eb0e1f5fc17fbb4dddf5293a/lib/appium_lib/driver.rb#L40) common +-- + +##### [sauce](https://github.com/appium/ruby_lib/blob/1ca8483c461f010a02aec40ec723fd3573a14cd1/lib/appium_lib/driver.rb#L40) common > def sauce SauceLab's settings ---\n\n##### [sauce_username](https://github.com/appium/ruby_lib/blob/621a9ebaf18bcd80eb0e1f5fc17fbb4dddf5293a/lib/appium_lib/driver.rb#L43) common +-- + +##### [sauce_username](https://github.com/appium/ruby_lib/blob/1ca8483c461f010a02aec40ec723fd3573a14cd1/lib/appium_lib/driver.rb#L43) common > def sauce_username Username for use on Sauce Labs. Set `false` to disable Sauce, even when SAUCE_USERNAME is in ENV. same as @sauce.username ---\n\n##### [sauce_access_key](https://github.com/appium/ruby_lib/blob/621a9ebaf18bcd80eb0e1f5fc17fbb4dddf5293a/lib/appium_lib/driver.rb#L46) common +-- + +##### [sauce_access_key](https://github.com/appium/ruby_lib/blob/1ca8483c461f010a02aec40ec723fd3573a14cd1/lib/appium_lib/driver.rb#L46) common > def sauce_access_key Access Key for use on Sauce Labs. Set `false` to disable Sauce, even when SAUCE_ACCESS_KEY is in ENV. same as @sauce.access_key ---\n\n##### [sauce_endpoint](https://github.com/appium/ruby_lib/blob/621a9ebaf18bcd80eb0e1f5fc17fbb4dddf5293a/lib/appium_lib/driver.rb#L49) common +-- + +##### [sauce_endpoint](https://github.com/appium/ruby_lib/blob/1ca8483c461f010a02aec40ec723fd3573a14cd1/lib/appium_lib/driver.rb#L49) common > def sauce_endpoint Override the Sauce Appium endpoint to allow e.g. TestObject tests same as @sauce.endpoint ---\n\n##### [caps](https://github.com/appium/ruby_lib/blob/621a9ebaf18bcd80eb0e1f5fc17fbb4dddf5293a/lib/appium_lib/driver.rb#L53) common +-- + +##### [caps](https://github.com/appium/ruby_lib/blob/1ca8483c461f010a02aec40ec723fd3573a14cd1/lib/appium_lib/driver.rb#L53) common > def caps from Core read http://www.rubydoc.info/github/appium/ruby_lib_core/Appium/Core/Driver ---\n\n##### [custom_url](https://github.com/appium/ruby_lib/blob/621a9ebaf18bcd80eb0e1f5fc17fbb4dddf5293a/lib/appium_lib/driver.rb#L54) common +-- + +##### [custom_url](https://github.com/appium/ruby_lib/blob/1ca8483c461f010a02aec40ec723fd3573a14cd1/lib/appium_lib/driver.rb#L54) common > def custom_url Returns the value of attribute custom_url ---\n\n##### [export_session](https://github.com/appium/ruby_lib/blob/621a9ebaf18bcd80eb0e1f5fc17fbb4dddf5293a/lib/appium_lib/driver.rb#L55) common +-- + +##### [export_session](https://github.com/appium/ruby_lib/blob/1ca8483c461f010a02aec40ec723fd3573a14cd1/lib/appium_lib/driver.rb#L55) common > def export_session Returns the value of attribute export_session ---\n\n##### [export_session_path](https://github.com/appium/ruby_lib/blob/621a9ebaf18bcd80eb0e1f5fc17fbb4dddf5293a/lib/appium_lib/driver.rb#L56) common +-- + +##### [export_session_path](https://github.com/appium/ruby_lib/blob/1ca8483c461f010a02aec40ec723fd3573a14cd1/lib/appium_lib/driver.rb#L56) common > def export_session_path Returns the value of attribute export_session_path ---\n\n##### [default_wait](https://github.com/appium/ruby_lib/blob/621a9ebaf18bcd80eb0e1f5fc17fbb4dddf5293a/lib/appium_lib/driver.rb#L57) common +-- + +##### [default_wait](https://github.com/appium/ruby_lib/blob/1ca8483c461f010a02aec40ec723fd3573a14cd1/lib/appium_lib/driver.rb#L57) common > def default_wait Returns the value of attribute default_wait ---\n\n##### [appium_port](https://github.com/appium/ruby_lib/blob/621a9ebaf18bcd80eb0e1f5fc17fbb4dddf5293a/lib/appium_lib/driver.rb#L58) common +-- + +##### [appium_port](https://github.com/appium/ruby_lib/blob/1ca8483c461f010a02aec40ec723fd3573a14cd1/lib/appium_lib/driver.rb#L58) common > def appium_port Returns the value of attribute appium_port ---\n\n##### [appium_device](https://github.com/appium/ruby_lib/blob/621a9ebaf18bcd80eb0e1f5fc17fbb4dddf5293a/lib/appium_lib/driver.rb#L59) common +-- + +##### [appium_device](https://github.com/appium/ruby_lib/blob/1ca8483c461f010a02aec40ec723fd3573a14cd1/lib/appium_lib/driver.rb#L59) common > def appium_device Returns the value of attribute appium_device ---\n\n##### [automation_name](https://github.com/appium/ruby_lib/blob/621a9ebaf18bcd80eb0e1f5fc17fbb4dddf5293a/lib/appium_lib/driver.rb#L60) common +-- + +##### [automation_name](https://github.com/appium/ruby_lib/blob/1ca8483c461f010a02aec40ec723fd3573a14cd1/lib/appium_lib/driver.rb#L60) common > def automation_name Returns the value of attribute automation_name ---\n\n##### [listener](https://github.com/appium/ruby_lib/blob/621a9ebaf18bcd80eb0e1f5fc17fbb4dddf5293a/lib/appium_lib/driver.rb#L61) common +-- + +##### [listener](https://github.com/appium/ruby_lib/blob/1ca8483c461f010a02aec40ec723fd3573a14cd1/lib/appium_lib/driver.rb#L61) common > def listener Returns the value of attribute listener ---\n\n##### [http_client](https://github.com/appium/ruby_lib/blob/621a9ebaf18bcd80eb0e1f5fc17fbb4dddf5293a/lib/appium_lib/driver.rb#L62) common +-- + +##### [http_client](https://github.com/appium/ruby_lib/blob/1ca8483c461f010a02aec40ec723fd3573a14cd1/lib/appium_lib/driver.rb#L62) common > def http_client Returns the value of attribute http_client ---\n\n##### [appium_wait_timeout](https://github.com/appium/ruby_lib/blob/621a9ebaf18bcd80eb0e1f5fc17fbb4dddf5293a/lib/appium_lib/driver.rb#L63) common +-- + +##### [appium_wait_timeout](https://github.com/appium/ruby_lib/blob/1ca8483c461f010a02aec40ec723fd3573a14cd1/lib/appium_lib/driver.rb#L63) common > def appium_wait_timeout Returns the value of attribute appium_wait_timeout ---\n\n##### [appium_wait_interval](https://github.com/appium/ruby_lib/blob/621a9ebaf18bcd80eb0e1f5fc17fbb4dddf5293a/lib/appium_lib/driver.rb#L64) common +-- + +##### [appium_wait_interval](https://github.com/appium/ruby_lib/blob/1ca8483c461f010a02aec40ec723fd3573a14cd1/lib/appium_lib/driver.rb#L64) common > def appium_wait_interval Returns the value of attribute appium_wait_interval ---\n\n##### [appium_server_status](https://github.com/appium/ruby_lib/blob/621a9ebaf18bcd80eb0e1f5fc17fbb4dddf5293a/lib/appium_lib/driver.rb#L67) common +-- + +##### [appium_server_status](https://github.com/appium/ruby_lib/blob/1ca8483c461f010a02aec40ec723fd3573a14cd1/lib/appium_lib/driver.rb#L67) common > def appium_server_status Appium's server version ---\n\n##### [appium_debug](https://github.com/appium/ruby_lib/blob/621a9ebaf18bcd80eb0e1f5fc17fbb4dddf5293a/lib/appium_lib/driver.rb#L69) common +-- + +##### [appium_debug](https://github.com/appium/ruby_lib/blob/1ca8483c461f010a02aec40ec723fd3573a14cd1/lib/appium_lib/driver.rb#L69) common > def appium_debug Boolean debug mode for the Appium Ruby bindings ---\n\n##### [driver](https://github.com/appium/ruby_lib/blob/621a9ebaf18bcd80eb0e1f5fc17fbb4dddf5293a/lib/appium_lib/driver.rb#L72) common +-- + +##### [driver](https://github.com/appium/ruby_lib/blob/1ca8483c461f010a02aec40ec723fd3573a14cd1/lib/appium_lib/driver.rb#L72) common > def driver Returns the driver -__Returns:__\n\n     [Driver] the driver +__Returns:__ + +     [Driver] the driver ---\n\n##### [core](https://github.com/appium/ruby_lib/blob/621a9ebaf18bcd80eb0e1f5fc17fbb4dddf5293a/lib/appium_lib/driver.rb#L74) common +-- + +##### [core](https://github.com/appium/ruby_lib/blob/1ca8483c461f010a02aec40ec723fd3573a14cd1/lib/appium_lib/driver.rb#L74) common > def core Instance of Appium::Core::Driver ---\n\n##### [initialize](https://github.com/appium/ruby_lib/blob/621a9ebaf18bcd80eb0e1f5fc17fbb4dddf5293a/lib/appium_lib/driver.rb#L142) common +-- + +##### [initialize](https://github.com/appium/ruby_lib/blob/1ca8483c461f010a02aec40ec723fd3573a14cd1/lib/appium_lib/driver.rb#L142) common > def initialize(opts = {}, global_driver = nil) Creates a new driver. The driver is defined as global scope by default. We can avoid defining global driver. -__Parameters:__\n\n     [Object] opts - A hash containing various options. +__Parameters:__ + +     [Object] opts - A hash containing various options.      [Bool] global_driver - A bool require global driver before initialize. -__Returns:__\n\n     [Driver] +__Returns:__ ---\n\n##### [driver_attributes](https://github.com/appium/ruby_lib/blob/621a9ebaf18bcd80eb0e1f5fc17fbb4dddf5293a/lib/appium_lib/driver.rb#L256) common +     [Driver] + +-- + +##### [driver_attributes](https://github.com/appium/ruby_lib/blob/1ca8483c461f010a02aec40ec723fd3573a14cd1/lib/appium_lib/driver.rb#L256) common > def driver_attributes Returns a hash of the driver attributes ---\n\n##### [device_is_android?](https://github.com/appium/ruby_lib/blob/621a9ebaf18bcd80eb0e1f5fc17fbb4dddf5293a/lib/appium_lib/driver.rb#L278) common +-- + +##### [device_is_android?](https://github.com/appium/ruby_lib/blob/1ca8483c461f010a02aec40ec723fd3573a14cd1/lib/appium_lib/driver.rb#L278) common > def device_is_android? -__Returns:__\n\n     [Boolean] +__Returns:__ ---\n\n##### [device_is_ios?](https://github.com/appium/ruby_lib/blob/621a9ebaf18bcd80eb0e1f5fc17fbb4dddf5293a/lib/appium_lib/driver.rb#L282) common +     [Boolean] + +-- + +##### [device_is_ios?](https://github.com/appium/ruby_lib/blob/1ca8483c461f010a02aec40ec723fd3573a14cd1/lib/appium_lib/driver.rb#L282) common > def device_is_ios? -__Returns:__\n\n     [Boolean] +__Returns:__ + +     [Boolean] ---\n\n##### [device_is_windows?](https://github.com/appium/ruby_lib/blob/621a9ebaf18bcd80eb0e1f5fc17fbb4dddf5293a/lib/appium_lib/driver.rb#L286) common +-- + +##### [device_is_windows?](https://github.com/appium/ruby_lib/blob/1ca8483c461f010a02aec40ec723fd3573a14cd1/lib/appium_lib/driver.rb#L286) common > def device_is_windows? -__Returns:__\n\n     [Boolean] +__Returns:__ + +     [Boolean] + +-- ---\n\n##### [automation_name_is_uiautomator2?](https://github.com/appium/ruby_lib/blob/621a9ebaf18bcd80eb0e1f5fc17fbb4dddf5293a/lib/appium_lib/driver.rb#L292) common +##### [automation_name_is_uiautomator2?](https://github.com/appium/ruby_lib/blob/1ca8483c461f010a02aec40ec723fd3573a14cd1/lib/appium_lib/driver.rb#L292) common > def automation_name_is_uiautomator2? Return true if automationName is 'uiautomator2' -__Returns:__\n\n     [Boolean] +__Returns:__ ---\n\n##### [automation_name_is_espresso?](https://github.com/appium/ruby_lib/blob/621a9ebaf18bcd80eb0e1f5fc17fbb4dddf5293a/lib/appium_lib/driver.rb#L298) common +     [Boolean] + +-- + +##### [automation_name_is_espresso?](https://github.com/appium/ruby_lib/blob/1ca8483c461f010a02aec40ec723fd3573a14cd1/lib/appium_lib/driver.rb#L298) common > def automation_name_is_espresso? Return true if automationName is 'Espresso' -__Returns:__\n\n     [Boolean] +__Returns:__ + +     [Boolean] ---\n\n##### [automation_name_is_xcuitest?](https://github.com/appium/ruby_lib/blob/621a9ebaf18bcd80eb0e1f5fc17fbb4dddf5293a/lib/appium_lib/driver.rb#L304) common +-- + +##### [automation_name_is_xcuitest?](https://github.com/appium/ruby_lib/blob/1ca8483c461f010a02aec40ec723fd3573a14cd1/lib/appium_lib/driver.rb#L304) common > def automation_name_is_xcuitest? Return true if automationName is 'XCUITest' -__Returns:__\n\n     [Boolean] +__Returns:__ + +     [Boolean] + +-- ---\n\n##### [dialect](https://github.com/appium/ruby_lib/blob/621a9ebaf18bcd80eb0e1f5fc17fbb4dddf5293a/lib/appium_lib/driver.rb#L324) common +##### [dialect](https://github.com/appium/ruby_lib/blob/1ca8483c461f010a02aec40ec723fd3573a14cd1/lib/appium_lib/driver.rb#L324) common > def dialect Get the dialect value whether current driver is OSS or W3C -__Returns:__\n\n     [:oss | :w3c] @example +__Returns:__ + +     [:oss | :w3c] @example if dialect == :w3c driver.action @@ -313,48 +419,70 @@ __Returns:__\n\n     [:oss | :w3c] @example action.perform end ---\n\n##### [check_server_version_xcuitest](https://github.com/appium/ruby_lib/blob/621a9ebaf18bcd80eb0e1f5fc17fbb4dddf5293a/lib/appium_lib/driver.rb#L331) common +-- + +##### [check_server_version_xcuitest](https://github.com/appium/ruby_lib/blob/1ca8483c461f010a02aec40ec723fd3573a14cd1/lib/appium_lib/driver.rb#L331) common > 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. -__Returns:__\n\n     [Boolean] +__Returns:__ + +     [Boolean] ---\n\n##### [appium_server_version](https://github.com/appium/ruby_lib/blob/621a9ebaf18bcd80eb0e1f5fc17fbb4dddf5293a/lib/appium_lib/driver.rb#L353) common +-- + +##### [appium_server_version](https://github.com/appium/ruby_lib/blob/1ca8483c461f010a02aec40ec723fd3573a14cd1/lib/appium_lib/driver.rb#L353) common > def appium_server_version Returns the server's version info -__Returns:__\n\n     [Hash] +__Returns:__ + +     [Hash] + +-- ---\n\n##### [remote_status](https://github.com/appium/ruby_lib/blob/621a9ebaf18bcd80eb0e1f5fc17fbb4dddf5293a/lib/appium_lib/driver.rb#L361) common +##### [remote_status](https://github.com/appium/ruby_lib/blob/1ca8483c461f010a02aec40ec723fd3573a14cd1/lib/appium_lib/driver.rb#L361) common > def appium_server_version Returns the server's version info -__Returns:__\n\n     [Hash] +__Returns:__ ---\n\n##### [platform_version](https://github.com/appium/ruby_lib/blob/621a9ebaf18bcd80eb0e1f5fc17fbb4dddf5293a/lib/appium_lib/driver.rb#L365) common +     [Hash] + +-- + +##### [platform_version](https://github.com/appium/ruby_lib/blob/1ca8483c461f010a02aec40ec723fd3573a14cd1/lib/appium_lib/driver.rb#L365) common > def platform_version Return the platform version as an array of integers -__Returns:__\n\n     [Array] +__Returns:__ + +     [Array] ---\n\n##### [appium_client_version](https://github.com/appium/ruby_lib/blob/621a9ebaf18bcd80eb0e1f5fc17fbb4dddf5293a/lib/appium_lib/driver.rb#L378) common +-- + +##### [appium_client_version](https://github.com/appium/ruby_lib/blob/1ca8483c461f010a02aec40ec723fd3573a14cd1/lib/appium_lib/driver.rb#L378) common > def appium_client_version Returns the client's version info -__Returns:__\n\n     [Hash] +__Returns:__ + +     [Hash] + +-- ---\n\n##### [absolute_app_path](https://github.com/appium/ruby_lib/blob/621a9ebaf18bcd80eb0e1f5fc17fbb4dddf5293a/lib/appium_lib/driver.rb#L390) common +##### [absolute_app_path](https://github.com/appium/ruby_lib/blob/1ca8483c461f010a02aec40ec723fd3573a14cd1/lib/appium_lib/driver.rb#L390) common > def self.absolute_app_path(opts) @@ -365,71 +493,107 @@ then the app path is used as is. if app isn't set then an error is raised. -__Returns:__\n\n     [String] APP_PATH as an absolute path +__Returns:__ ---\n\n##### [server_url](https://github.com/appium/ruby_lib/blob/621a9ebaf18bcd80eb0e1f5fc17fbb4dddf5293a/lib/appium_lib/driver.rb#L413) common +     [String] APP_PATH as an absolute path + +-- + +##### [server_url](https://github.com/appium/ruby_lib/blob/1ca8483c461f010a02aec40ec723fd3573a14cd1/lib/appium_lib/driver.rb#L413) common > def server_url Get the server url -__Returns:__\n\n     [String] the server url +__Returns:__ + +     [String] the server url ---\n\n##### [restart](https://github.com/appium/ruby_lib/blob/621a9ebaf18bcd80eb0e1f5fc17fbb4dddf5293a/lib/appium_lib/driver.rb#L422) common +-- + +##### [restart](https://github.com/appium/ruby_lib/blob/1ca8483c461f010a02aec40ec723fd3573a14cd1/lib/appium_lib/driver.rb#L422) common > def restart Restarts the driver -__Returns:__\n\n     [Driver] the driver +__Returns:__ + +     [Driver] the driver + +-- ---\n\n##### [screenshot](https://github.com/appium/ruby_lib/blob/621a9ebaf18bcd80eb0e1f5fc17fbb4dddf5293a/lib/appium_lib/driver.rb#L435) common +##### [screenshot](https://github.com/appium/ruby_lib/blob/1ca8483c461f010a02aec40ec723fd3573a14cd1/lib/appium_lib/driver.rb#L435) common > def screenshot(png_save_path) Takes a png screenshot and saves to the target path. -__Parameters:__\n\n     [String] png_save_path - the full path to save the png +__Parameters:__ + +     [String] png_save_path - the full path to save the png + +__Returns:__ -__Returns:__\n\n     [File] +     [File] ---\n\n##### [element_screenshot](https://github.com/appium/ruby_lib/blob/621a9ebaf18bcd80eb0e1f5fc17fbb4dddf5293a/lib/appium_lib/driver.rb#L449) common +-- + +##### [element_screenshot](https://github.com/appium/ruby_lib/blob/1ca8483c461f010a02aec40ec723fd3573a14cd1/lib/appium_lib/driver.rb#L449) common > def element_screenshot(element, png_save_path) Takes a png screenshot of particular element's area -__Parameters:__\n\n     [String] element - Element take a screenshot +__Parameters:__ + +     [String] element - Element take a screenshot      [String] png_save_path - the full path to save the png -__Returns:__\n\n     [File] +__Returns:__ + +     [File] ---\n\n##### [driver_quit](https://github.com/appium/ruby_lib/blob/621a9ebaf18bcd80eb0e1f5fc17fbb4dddf5293a/lib/appium_lib/driver.rb#L456) common +-- + +##### [driver_quit](https://github.com/appium/ruby_lib/blob/1ca8483c461f010a02aec40ec723fd3573a14cd1/lib/appium_lib/driver.rb#L456) common > def driver_quit Quits the driver -__Returns:__\n\n     [void] +__Returns:__ + +     [void] + +-- ---\n\n##### [quit_driver](https://github.com/appium/ruby_lib/blob/621a9ebaf18bcd80eb0e1f5fc17fbb4dddf5293a/lib/appium_lib/driver.rb#L459) common +##### [quit_driver](https://github.com/appium/ruby_lib/blob/1ca8483c461f010a02aec40ec723fd3573a14cd1/lib/appium_lib/driver.rb#L459) common > def driver_quit Quits the driver -__Returns:__\n\n     [void] +__Returns:__ ---\n\n##### [window_size](https://github.com/appium/ruby_lib/blob/621a9ebaf18bcd80eb0e1f5fc17fbb4dddf5293a/lib/appium_lib/driver.rb#L470) common +     [void] + +-- + +##### [window_size](https://github.com/appium/ruby_lib/blob/1ca8483c461f010a02aec40ec723fd3573a14cd1/lib/appium_lib/driver.rb#L470) common > def window_size Get the device window's size. -__Returns:__\n\n     [Selenium::WebDriver::Dimension] +__Returns:__ + +     [Selenium::WebDriver::Dimension] ---\n\n##### [start_driver](https://github.com/appium/ruby_lib/blob/621a9ebaf18bcd80eb0e1f5fc17fbb4dddf5293a/lib/appium_lib/driver.rb#L503) common +-- + +##### [start_driver](https://github.com/appium/ruby_lib/blob/1ca8483c461f010a02aec40ec723fd3573a14cd1/lib/appium_lib/driver.rb#L503) common > def start_driver(http_client_ops = @@ -439,33 +603,49 @@ You can customise http_client as the following Read http://www.rubydoc.info/github/appium/ruby_lib_core/Appium/Core/Device to understand more what the driver can call instance methods. -__Parameters:__\n\n     [Hash] http_client_ops - a customizable set of options +__Parameters:__ + +     [Hash] http_client_ops - a customizable set of options + +__Returns:__ -__Returns:__\n\n     [Selenium::WebDriver] the new global driver +     [Selenium::WebDriver] the new global driver ---\n\n##### [set_implicit_wait](https://github.com/appium/ruby_lib/blob/621a9ebaf18bcd80eb0e1f5fc17fbb4dddf5293a/lib/appium_lib/driver.rb#L525) common +-- + +##### [set_implicit_wait](https://github.com/appium/ruby_lib/blob/1ca8483c461f010a02aec40ec723fd3573a14cd1/lib/appium_lib/driver.rb#L525) common > def set_implicit_wait(wait) To ignore error for Espresso Driver ---\n\n##### [no_wait](https://github.com/appium/ruby_lib/blob/621a9ebaf18bcd80eb0e1f5fc17fbb4dddf5293a/lib/appium_lib/driver.rb#L536) common +-- + +##### [no_wait](https://github.com/appium/ruby_lib/blob/1ca8483c461f010a02aec40ec723fd3573a14cd1/lib/appium_lib/driver.rb#L536) common > def no_wait Set implicit wait to zero. ---\n\n##### [set_wait](https://github.com/appium/ruby_lib/blob/621a9ebaf18bcd80eb0e1f5fc17fbb4dddf5293a/lib/appium_lib/driver.rb#L550) common +-- + +##### [set_wait](https://github.com/appium/ruby_lib/blob/1ca8483c461f010a02aec40ec723fd3573a14cd1/lib/appium_lib/driver.rb#L550) common > def set_wait(timeout = nil) Set implicit wait. Default to @core.default_wait. -__Parameters:__\n\n     [Integer] timeout - the timeout in seconds +__Parameters:__ + +     [Integer] timeout - the timeout in seconds + +__Returns:__ + +     [void] -__Returns:__\n\n     [void] +-- ---\n\n##### [exists](https://github.com/appium/ruby_lib/blob/621a9ebaf18bcd80eb0e1f5fc17fbb4dddf5293a/lib/appium_lib/driver.rb#L567) common +##### [exists](https://github.com/appium/ruby_lib/blob/1ca8483c461f010a02aec40ec723fd3573a14cd1/lib/appium_lib/driver.rb#L567) common > def exists(pre_check = 0, post_check = @core.default_wait) @@ -475,27 +655,39 @@ Example: exists { button('sign in') } ? puts('true') : puts('false') -__Parameters:__\n\n     [Integer] pre_check - The amount in seconds to set the +__Parameters:__ + +     [Integer] pre_check - The amount in seconds to set the wait to before checking existence      [Integer] post_check - The amount in seconds to set the wait to after checking existence -__Returns:__\n\n     [Boolean] +__Returns:__ + +     [Boolean] + +-- ---\n\n##### [execute_script](https://github.com/appium/ruby_lib/blob/621a9ebaf18bcd80eb0e1f5fc17fbb4dddf5293a/lib/appium_lib/driver.rb#L591) common +##### [execute_script](https://github.com/appium/ruby_lib/blob/1ca8483c461f010a02aec40ec723fd3573a14cd1/lib/appium_lib/driver.rb#L591) common > def execute_script(script, *args) The same as @driver.execute_script -__Parameters:__\n\n     [String] script - The script to execute +__Parameters:__ + +     [String] script - The script to execute      [*args] args - The args to pass to the script -__Returns:__\n\n     [Object] +__Returns:__ + +     [Object] + +-- ---\n\n##### [execute_async_script](https://github.com/appium/ruby_lib/blob/621a9ebaf18bcd80eb0e1f5fc17fbb4dddf5293a/lib/appium_lib/driver.rb#L599) common +##### [execute_async_script](https://github.com/appium/ruby_lib/blob/1ca8483c461f010a02aec40ec723fd3573a14cd1/lib/appium_lib/driver.rb#L599) common > def execute_async_script(script, *args) @@ -503,57 +695,77 @@ Wrap calling selenium webdrier APIs via ruby_core Get the window handles of open browser windows ---\n\n##### [window_handles](https://github.com/appium/ruby_lib/blob/621a9ebaf18bcd80eb0e1f5fc17fbb4dddf5293a/lib/appium_lib/driver.rb#L603) common +-- + +##### [window_handles](https://github.com/appium/ruby_lib/blob/1ca8483c461f010a02aec40ec723fd3573a14cd1/lib/appium_lib/driver.rb#L603) common > def window_handles ---\n\n##### [window_handle](https://github.com/appium/ruby_lib/blob/621a9ebaf18bcd80eb0e1f5fc17fbb4dddf5293a/lib/appium_lib/driver.rb#L608) common +-- + +##### [window_handle](https://github.com/appium/ruby_lib/blob/1ca8483c461f010a02aec40ec723fd3573a14cd1/lib/appium_lib/driver.rb#L608) common > def window_handle Get the current window handle ---\n\n##### [navigate](https://github.com/appium/ruby_lib/blob/621a9ebaf18bcd80eb0e1f5fc17fbb4dddf5293a/lib/appium_lib/driver.rb#L612) common +-- + +##### [navigate](https://github.com/appium/ruby_lib/blob/1ca8483c461f010a02aec40ec723fd3573a14cd1/lib/appium_lib/driver.rb#L612) common > def navigate ---\n\n##### [manage](https://github.com/appium/ruby_lib/blob/621a9ebaf18bcd80eb0e1f5fc17fbb4dddf5293a/lib/appium_lib/driver.rb#L616) common +-- + +##### [manage](https://github.com/appium/ruby_lib/blob/1ca8483c461f010a02aec40ec723fd3573a14cd1/lib/appium_lib/driver.rb#L616) common > def manage ---\n\n##### [get](https://github.com/appium/ruby_lib/blob/621a9ebaf18bcd80eb0e1f5fc17fbb4dddf5293a/lib/appium_lib/driver.rb#L620) common +-- + +##### [get](https://github.com/appium/ruby_lib/blob/1ca8483c461f010a02aec40ec723fd3573a14cd1/lib/appium_lib/driver.rb#L620) common > def get(url) ---\n\n##### [current_url](https://github.com/appium/ruby_lib/blob/621a9ebaf18bcd80eb0e1f5fc17fbb4dddf5293a/lib/appium_lib/driver.rb#L624) common +-- + +##### [current_url](https://github.com/appium/ruby_lib/blob/1ca8483c461f010a02aec40ec723fd3573a14cd1/lib/appium_lib/driver.rb#L624) common > def current_url ---\n\n##### [title](https://github.com/appium/ruby_lib/blob/621a9ebaf18bcd80eb0e1f5fc17fbb4dddf5293a/lib/appium_lib/driver.rb#L628) common +-- + +##### [title](https://github.com/appium/ruby_lib/blob/1ca8483c461f010a02aec40ec723fd3573a14cd1/lib/appium_lib/driver.rb#L628) common > def title ---\n\n##### [switch_to](https://github.com/appium/ruby_lib/blob/621a9ebaf18bcd80eb0e1f5fc17fbb4dddf5293a/lib/appium_lib/driver.rb#L634) common +-- + +##### [switch_to](https://github.com/appium/ruby_lib/blob/1ca8483c461f010a02aec40ec723fd3573a14cd1/lib/appium_lib/driver.rb#L634) common > def switch_to -__Returns:__\n\n     [TargetLocator] +__Returns:__ + +     [TargetLocator] ---\n\n##### [find_elements](https://github.com/appium/ruby_lib/blob/621a9ebaf18bcd80eb0e1f5fc17fbb4dddf5293a/lib/appium_lib/driver.rb#L661) common +-- + +##### [find_elements](https://github.com/appium/ruby_lib/blob/1ca8483c461f010a02aec40ec723fd3573a14cd1/lib/appium_lib/driver.rb#L661) common > def find_elements(*args) @@ -563,11 +775,17 @@ If you call `Appium.promote_appium_methods`, you can call `find_elements` direct If you call `Appium.promote_appium_methods`, you can call `find_elements` directly. -__Parameters:__\n\n     [*args] args - The args to use +__Parameters:__ + +     [*args] args - The args to use + +__Returns:__ -__Returns:__\n\n     [Array] Array is empty when no elements are found. +     [Array] Array is empty when no elements are found. ---\n\n##### [find_element](https://github.com/appium/ruby_lib/blob/621a9ebaf18bcd80eb0e1f5fc17fbb4dddf5293a/lib/appium_lib/driver.rb#L677) common +-- + +##### [find_element](https://github.com/appium/ruby_lib/blob/1ca8483c461f010a02aec40ec723fd3573a14cd1/lib/appium_lib/driver.rb#L677) common > def find_element(*args) @@ -575,128 +793,188 @@ Calls @driver.find_element If you call `Appium.promote_appium_methods`, you can call `find_element` directly. -__Parameters:__\n\n     [*args] args - The args to use +__Parameters:__ + +     [*args] args - The args to use + +__Returns:__ -__Returns:__\n\n     [Element] +     [Element] ---\n\n##### [DEFAULT_MATCH_THRESHOLD](https://github.com/appium/ruby_lib/blob/621a9ebaf18bcd80eb0e1f5fc17fbb4dddf5293a/lib/appium_lib/driver.rb#L695) common +-- + +##### [DEFAULT_MATCH_THRESHOLD](https://github.com/appium/ruby_lib/blob/1ca8483c461f010a02aec40ec723fd3573a14cd1/lib/appium_lib/driver.rb#L695) common > DEFAULT_MATCH_THRESHOLD = 0.5 Return ImageElement if current view has a partial image -__Parameters:__\n\n     [String] png_img_path - A path to a partial image you'd like to find +__Parameters:__ + +     [String] png_img_path - A path to a partial image you'd like to find      [Flood] match_threshold - At what normalized threshold to reject      [Bool] visualize - Makes the endpoint to return an image, which contains the visualized result of the corresponding picture matching operation. This option is disabled by default. -__Returns:__\n\n     [::Appium::Core::ImageElement] +__Returns:__ + +     [::Appium::Core::ImageElement] ---\n\n##### [find_element_by_image](https://github.com/appium/ruby_lib/blob/621a9ebaf18bcd80eb0e1f5fc17fbb4dddf5293a/lib/appium_lib/driver.rb#L696) common +-- + +##### [find_element_by_image](https://github.com/appium/ruby_lib/blob/1ca8483c461f010a02aec40ec723fd3573a14cd1/lib/appium_lib/driver.rb#L696) common > def find_element_by_image(png_img_path, match_threshold: DEFAULT_MATCH_THRESHOLD, visualize: false) ---\n\n##### [find_elements_by_image](https://github.com/appium/ruby_lib/blob/621a9ebaf18bcd80eb0e1f5fc17fbb4dddf5293a/lib/appium_lib/driver.rb#L714) common +-- + +##### [find_elements_by_image](https://github.com/appium/ruby_lib/blob/1ca8483c461f010a02aec40ec723fd3573a14cd1/lib/appium_lib/driver.rb#L714) common > def find_elements_by_image(png_img_paths, match_threshold: DEFAULT_MATCH_THRESHOLD, visualize: false) Return ImageElement if current view has partial images -__Parameters:__\n\n     [[String]] png_img_paths - Paths to a partial image you'd like to find +__Parameters:__ + +     [[String]] png_img_paths - Paths to a partial image you'd like to find      [Flood] match_threshold - At what normalized threshold to reject      [Bool] visualize - Makes the endpoint to return an image, which contains the visualized result of the corresponding picture matching operation. This option is disabled by default. -__Returns:__\n\n     [[::Appium::Core::ImageElement]] +__Returns:__ ---\n\n##### [set_location](https://github.com/appium/ruby_lib/blob/621a9ebaf18bcd80eb0e1f5fc17fbb4dddf5293a/lib/appium_lib/driver.rb#L727) common +     [[::Appium::Core::ImageElement]] + +-- + +##### [set_location](https://github.com/appium/ruby_lib/blob/1ca8483c461f010a02aec40ec723fd3573a14cd1/lib/appium_lib/driver.rb#L727) common > def set_location(opts = {}) Calls @driver.set_location -__Parameters:__\n\n     [Hash] opts - consisting of: +__Parameters:__ + +     [Hash] opts - consisting of: -__Returns:__\n\n     [Selenium::WebDriver::Location] the location constructed by the selenium webdriver +__Returns:__ ---\n\n##### [x](https://github.com/appium/ruby_lib/blob/621a9ebaf18bcd80eb0e1f5fc17fbb4dddf5293a/lib/appium_lib/driver.rb#L737) common +     [Selenium::WebDriver::Location] the location constructed by the selenium webdriver + +-- + +##### [x](https://github.com/appium/ruby_lib/blob/1ca8483c461f010a02aec40ec723fd3573a14cd1/lib/appium_lib/driver.rb#L737) common > def x Quit the driver and Pry. quit and exit are reserved by Pry. -__Returns:__\n\n     [void] +__Returns:__ + +     [void] ---\n\n##### [username](https://github.com/appium/ruby_lib/blob/621a9ebaf18bcd80eb0e1f5fc17fbb4dddf5293a/lib/appium_lib/sauce_labs.rb#L4) common +-- + +##### [username](https://github.com/appium/ruby_lib/blob/1ca8483c461f010a02aec40ec723fd3573a14cd1/lib/appium_lib/sauce_labs.rb#L4) common > def username Username for use on Sauce Labs. Set `false` to disable Sauce, even when SAUCE_USERNAME is in ENV. ---\n\n##### [access_key](https://github.com/appium/ruby_lib/blob/621a9ebaf18bcd80eb0e1f5fc17fbb4dddf5293a/lib/appium_lib/sauce_labs.rb#L6) common +-- + +##### [access_key](https://github.com/appium/ruby_lib/blob/1ca8483c461f010a02aec40ec723fd3573a14cd1/lib/appium_lib/sauce_labs.rb#L6) common > def access_key Access Key for use on Sauce Labs. Set `false` to disable Sauce, even when SAUCE_ACCESS_KEY is in ENV. ---\n\n##### [endpoint](https://github.com/appium/ruby_lib/blob/621a9ebaf18bcd80eb0e1f5fc17fbb4dddf5293a/lib/appium_lib/sauce_labs.rb#L8) common +-- + +##### [endpoint](https://github.com/appium/ruby_lib/blob/1ca8483c461f010a02aec40ec723fd3573a14cd1/lib/appium_lib/sauce_labs.rb#L8) common > def endpoint Override the Sauce Appium endpoint to allow e.g. TestObject tests. Default is 'ondemand.saucelabs.com:443/wd/hub'. ---\n\n##### [initialize](https://github.com/appium/ruby_lib/blob/621a9ebaf18bcd80eb0e1f5fc17fbb4dddf5293a/lib/appium_lib/sauce_labs.rb#L33) common +-- + +##### [initialize](https://github.com/appium/ruby_lib/blob/1ca8483c461f010a02aec40ec723fd3573a14cd1/lib/appium_lib/sauce_labs.rb#L33) common > def initialize(appium_lib_opts) Create a SauceLabs instance to manage sauce labs related attributes. -__Parameters:__\n\n     [Hash] appium_lib_opts - Appium library parameter +__Parameters:__ + +     [Hash] appium_lib_opts - Appium library parameter + +__Returns:__ -__Returns:__\n\n     [Appium::SauceLabs] +     [Appium::SauceLabs] ---\n\n##### [sauce_server_url?](https://github.com/appium/ruby_lib/blob/621a9ebaf18bcd80eb0e1f5fc17fbb4dddf5293a/lib/appium_lib/sauce_labs.rb#L53) common +-- + +##### [sauce_server_url?](https://github.com/appium/ruby_lib/blob/1ca8483c461f010a02aec40ec723fd3573a14cd1/lib/appium_lib/sauce_labs.rb#L53) common > def sauce_server_url? Return true if an instance of Appium::SauceLabs has sauce_username and sauce_access_key. -__Returns:__\n\n     [Boolean] +__Returns:__ + +     [Boolean] + +-- ---\n\n##### [server_url](https://github.com/appium/ruby_lib/blob/621a9ebaf18bcd80eb0e1f5fc17fbb4dddf5293a/lib/appium_lib/sauce_labs.rb#L66) common +##### [server_url](https://github.com/appium/ruby_lib/blob/1ca8483c461f010a02aec40ec723fd3573a14cd1/lib/appium_lib/sauce_labs.rb#L66) common > def server_url Return a particular server url to access to. Default is the local address. -__Returns:__\n\n     [String] +__Returns:__ ---\n\n##### [get_log](https://github.com/appium/ruby_lib/blob/621a9ebaf18bcd80eb0e1f5fc17fbb4dddf5293a/lib/appium_lib/common/log.rb#L11) common +     [String] + +-- + +##### [get_log](https://github.com/appium/ruby_lib/blob/1ca8483c461f010a02aec40ec723fd3573a14cd1/lib/appium_lib/common/log.rb#L11) common > def get_log(type) -__Parameters:__\n\n     [String|Hash] type - You can get particular type's logs. +__Parameters:__ + +     [String|Hash] type - You can get particular type's logs. -__Returns:__\n\n     [[Selenium::WebDriver::LogEntry]] A list of logs data. +__Returns:__ ---\n\n##### [get_available_log_types](https://github.com/appium/ruby_lib/blob/621a9ebaf18bcd80eb0e1f5fc17fbb4dddf5293a/lib/appium_lib/common/log.rb#L23) common +     [[Selenium::WebDriver::LogEntry]] A list of logs data. + +-- + +##### [get_available_log_types](https://github.com/appium/ruby_lib/blob/1ca8483c461f010a02aec40ec723fd3573a14cd1/lib/appium_lib/common/log.rb#L23) common > def get_available_log_types Get a list of available log types -__Returns:__\n\n     [[String]] A list of available log types. +__Returns:__ + +     [[String]] A list of available log types. ---\n\n##### [wait_true](https://github.com/appium/ruby_lib/blob/621a9ebaf18bcd80eb0e1f5fc17fbb4dddf5293a/lib/appium_lib/common/wait.rb#L30) common +-- + +##### [wait_true](https://github.com/appium/ruby_lib/blob/1ca8483c461f010a02aec40ec723fd3573a14cd1/lib/appium_lib/common/wait.rb#L30) common > def wait_true(opts = {}) @@ -710,9 +988,13 @@ https://github.com/SeleniumHQ/selenium/blob/cf501dda3f0ed12233de51ce8170c0e8090f If only a number is provided then it's treated as the timeout value. -__Parameters:__\n\n     [Hash|Numeric] opts - Options. If the value is _Numeric_, the value is set as `{ timeout: value }` +__Parameters:__ + +     [Hash|Numeric] opts - Options. If the value is _Numeric_, the value is set as `{ timeout: value }` + +-- ---\n\n##### [wait](https://github.com/appium/ruby_lib/blob/621a9ebaf18bcd80eb0e1f5fc17fbb4dddf5293a/lib/appium_lib/common/wait.rb#L59) common +##### [wait](https://github.com/appium/ruby_lib/blob/1ca8483c461f010a02aec40ec723fd3573a14cd1/lib/appium_lib/common/wait.rb#L59) common > def wait(opts = {}) @@ -724,221 +1006,319 @@ https://github.com/SeleniumHQ/selenium/blob/cf501dda3f0ed12233de51ce8170c0e8090f If only a number is provided then it's treated as the timeout value. -__Parameters:__\n\n     [Hash|Numeric] opts - Options. If the value is _Numeric_, the value is set as `{ timeout: value }` +__Parameters:__ ---\n\n##### [add_touch_actions](https://github.com/appium/ruby_lib/blob/621a9ebaf18bcd80eb0e1f5fc17fbb4dddf5293a/lib/appium_lib/common/device.rb#L12) common +     [Hash|Numeric] opts - Options. If the value is _Numeric_, the value is set as `{ timeout: value }` + +-- + +##### [add_touch_actions](https://github.com/appium/ruby_lib/blob/1ca8483c461f010a02aec40ec723fd3573a14cd1/lib/appium_lib/common/device.rb#L12) common > def add_touch_actions ---\n\n##### [delegate_from_appium_driver](https://github.com/appium/ruby_lib/blob/621a9ebaf18bcd80eb0e1f5fc17fbb4dddf5293a/lib/appium_lib/common/device.rb#L24) common +-- + +##### [delegate_from_appium_driver](https://github.com/appium/ruby_lib/blob/1ca8483c461f010a02aec40ec723fd3573a14cd1/lib/appium_lib/common/device.rb#L24) common > def delegate_from_appium_driver(method, delegation_target) ---\n\n##### [ignore](https://github.com/appium/ruby_lib/blob/621a9ebaf18bcd80eb0e1f5fc17fbb4dddf5293a/lib/appium_lib/common/helper.rb#L16) common +-- + +##### [ignore](https://github.com/appium/ruby_lib/blob/1ca8483c461f010a02aec40ec723fd3573a14cd1/lib/appium_lib/common/helper.rb#L16) common > def ignore Return yield and ignore any exceptions. ---\n\n##### [back](https://github.com/appium/ruby_lib/blob/621a9ebaf18bcd80eb0e1f5fc17fbb4dddf5293a/lib/appium_lib/common/helper.rb#L23) common +-- + +##### [back](https://github.com/appium/ruby_lib/blob/1ca8483c461f010a02aec40ec723fd3573a14cd1/lib/appium_lib/common/helper.rb#L23) common > def back Navigate back. -__Returns:__\n\n     [void] +__Returns:__ + +     [void] ---\n\n##### [session_id](https://github.com/appium/ruby_lib/blob/621a9ebaf18bcd80eb0e1f5fc17fbb4dddf5293a/lib/appium_lib/common/helper.rb#L34) common +-- + +##### [session_id](https://github.com/appium/ruby_lib/blob/1ca8483c461f010a02aec40ec723fd3573a14cd1/lib/appium_lib/common/helper.rb#L34) common > def session_id For Sauce Labs reporting. Returns the current session id. -__Returns:__\n\n     [String] +__Returns:__ + +     [String] + +-- ---\n\n##### [xpath](https://github.com/appium/ruby_lib/blob/621a9ebaf18bcd80eb0e1f5fc17fbb4dddf5293a/lib/appium_lib/common/helper.rb#L42) common +##### [xpath](https://github.com/appium/ruby_lib/blob/1ca8483c461f010a02aec40ec723fd3573a14cd1/lib/appium_lib/common/helper.rb#L42) common > def xpath(xpath_str) Returns the first element that matches the provided xpath. -__Parameters:__\n\n     [String] xpath_str - the XPath string +__Parameters:__ -__Returns:__\n\n     [Element] +     [String] xpath_str - the XPath string ---\n\n##### [xpaths](https://github.com/appium/ruby_lib/blob/621a9ebaf18bcd80eb0e1f5fc17fbb4dddf5293a/lib/appium_lib/common/helper.rb#L50) common +__Returns:__ + +     [Element] + +-- + +##### [xpaths](https://github.com/appium/ruby_lib/blob/1ca8483c461f010a02aec40ec723fd3573a14cd1/lib/appium_lib/common/helper.rb#L50) common > def xpaths(xpath_str) Returns all elements that match the provided xpath. -__Parameters:__\n\n     [String] xpath_str - the XPath string +__Parameters:__ + +     [String] xpath_str - the XPath string + +__Returns:__ + +     [Array] -__Returns:__\n\n     [Array] +-- ---\n\n##### [result](https://github.com/appium/ruby_lib/blob/621a9ebaf18bcd80eb0e1f5fc17fbb4dddf5293a/lib/appium_lib/common/helper.rb#L60) common +##### [result](https://github.com/appium/ruby_lib/blob/1ca8483c461f010a02aec40ec723fd3573a14cd1/lib/appium_lib/common/helper.rb#L60) common > def result Returns the value of attribute result ---\n\n##### [initialize](https://github.com/appium/ruby_lib/blob/621a9ebaf18bcd80eb0e1f5fc17fbb4dddf5293a/lib/appium_lib/common/helper.rb#L62) common +-- + +##### [initialize](https://github.com/appium/ruby_lib/blob/1ca8483c461f010a02aec40ec723fd3573a14cd1/lib/appium_lib/common/helper.rb#L62) common > def initialize(platform) -__Returns:__\n\n     [CountElements] a new instance of CountElements +__Returns:__ + +     [CountElements] a new instance of CountElements + +-- ---\n\n##### [reset](https://github.com/appium/ruby_lib/blob/621a9ebaf18bcd80eb0e1f5fc17fbb4dddf5293a/lib/appium_lib/common/helper.rb#L67) common +##### [reset](https://github.com/appium/ruby_lib/blob/1ca8483c461f010a02aec40ec723fd3573a14cd1/lib/appium_lib/common/helper.rb#L67) common > def reset ---\n\n##### [start_element](https://github.com/appium/ruby_lib/blob/621a9ebaf18bcd80eb0e1f5fc17fbb4dddf5293a/lib/appium_lib/common/helper.rb#L72) common +-- + +##### [start_element](https://github.com/appium/ruby_lib/blob/1ca8483c461f010a02aec40ec723fd3573a14cd1/lib/appium_lib/common/helper.rb#L72) common > def start_element(name, attrs = []) http://nokogiri.org/Nokogiri/XML/SAX/Document.html ---\n\n##### [formatted_result](https://github.com/appium/ruby_lib/blob/621a9ebaf18bcd80eb0e1f5fc17fbb4dddf5293a/lib/appium_lib/common/helper.rb#L83) common +-- + +##### [formatted_result](https://github.com/appium/ruby_lib/blob/1ca8483c461f010a02aec40ec723fd3573a14cd1/lib/appium_lib/common/helper.rb#L83) common > def formatted_result ---\n\n##### [get_page_class](https://github.com/appium/ruby_lib/blob/621a9ebaf18bcd80eb0e1f5fc17fbb4dddf5293a/lib/appium_lib/common/helper.rb#L101) common +-- + +##### [get_page_class](https://github.com/appium/ruby_lib/blob/1ca8483c461f010a02aec40ec723fd3573a14cd1/lib/appium_lib/common/helper.rb#L101) common > def get_page_class Returns a string of class counts of visible elements. -__Returns:__\n\n     [String] +__Returns:__ ---\n\n##### [page_class](https://github.com/appium/ruby_lib/blob/621a9ebaf18bcd80eb0e1f5fc17fbb4dddf5293a/lib/appium_lib/common/helper.rb#L126) common +     [String] + +-- + +##### [page_class](https://github.com/appium/ruby_lib/blob/1ca8483c461f010a02aec40ec723fd3573a14cd1/lib/appium_lib/common/helper.rb#L126) common > def page_class Count all classes on screen and print to stdout. Useful for appium_console. -__Returns:__\n\n     [nil] +__Returns:__ + +     [nil] ---\n\n##### [source](https://github.com/appium/ruby_lib/blob/621a9ebaf18bcd80eb0e1f5fc17fbb4dddf5293a/lib/appium_lib/common/helper.rb#L133) common +-- + +##### [source](https://github.com/appium/ruby_lib/blob/1ca8483c461f010a02aec40ec723fd3573a14cd1/lib/appium_lib/common/helper.rb#L133) common > def source Prints xml of the current page -__Returns:__\n\n     [void] +__Returns:__ + +     [void] + +-- ---\n\n##### [get_source](https://github.com/appium/ruby_lib/blob/621a9ebaf18bcd80eb0e1f5fc17fbb4dddf5293a/lib/appium_lib/common/helper.rb#L140) common +##### [get_source](https://github.com/appium/ruby_lib/blob/1ca8483c461f010a02aec40ec723fd3573a14cd1/lib/appium_lib/common/helper.rb#L140) common > def get_source Returns XML string for the current page Same as driver.page_source -__Returns:__\n\n     [String] +__Returns:__ ---\n\n##### [px_to_window_rel](https://github.com/appium/ruby_lib/blob/621a9ebaf18bcd80eb0e1f5fc17fbb4dddf5293a/lib/appium_lib/common/helper.rb#L150) common +     [String] + +-- + +##### [px_to_window_rel](https://github.com/appium/ruby_lib/blob/1ca8483c461f010a02aec40ec723fd3573a14cd1/lib/appium_lib/common/helper.rb#L150) common > def px_to_window_rel(opts = {}, driver = $driver) Converts pixel values to window relative values ---\n\n##### [xml_keys](https://github.com/appium/ruby_lib/blob/621a9ebaf18bcd80eb0e1f5fc17fbb4dddf5293a/lib/appium_lib/common/helper.rb#L169) common +-- + +##### [xml_keys](https://github.com/appium/ruby_lib/blob/1ca8483c461f010a02aec40ec723fd3573a14cd1/lib/appium_lib/common/helper.rb#L169) common > def xml_keys(target) Search strings.xml's values for target. -__Parameters:__\n\n     [String] target - the target to search for in strings.xml values +__Parameters:__ + +     [String] target - the target to search for in strings.xml values + +__Returns:__ + +     [Array] -__Returns:__\n\n     [Array] +-- ---\n\n##### [xml_values](https://github.com/appium/ruby_lib/blob/621a9ebaf18bcd80eb0e1f5fc17fbb4dddf5293a/lib/appium_lib/common/helper.rb#L177) common +##### [xml_values](https://github.com/appium/ruby_lib/blob/1ca8483c461f010a02aec40ec723fd3573a14cd1/lib/appium_lib/common/helper.rb#L177) common > def xml_values(target) Search strings.xml's keys for target. -__Parameters:__\n\n     [String] target - the target to search for in strings.xml keys +__Parameters:__ -__Returns:__\n\n     [Array] +     [String] target - the target to search for in strings.xml keys ---\n\n##### [resolve_id](https://github.com/appium/ruby_lib/blob/621a9ebaf18bcd80eb0e1f5fc17fbb4dddf5293a/lib/appium_lib/common/helper.rb#L185) common +__Returns:__ + +     [Array] + +-- + +##### [resolve_id](https://github.com/appium/ruby_lib/blob/1ca8483c461f010a02aec40ec723fd3573a14cd1/lib/appium_lib/common/helper.rb#L185) common > def resolve_id(id) Resolve id in strings.xml and return the value. -__Parameters:__\n\n     [String] id - the id to resolve +__Parameters:__ + +     [String] id - the id to resolve + +__Returns:__ + +     [String] -__Returns:__\n\n     [String] +-- ---\n\n##### [filter](https://github.com/appium/ruby_lib/blob/621a9ebaf18bcd80eb0e1f5fc17fbb4dddf5293a/lib/appium_lib/common/helper.rb#L192) common +##### [filter](https://github.com/appium/ruby_lib/blob/1ca8483c461f010a02aec40ec723fd3573a14cd1/lib/appium_lib/common/helper.rb#L192) common > def filter Returns the value of attribute filter ---\n\n##### [filter=](https://github.com/appium/ruby_lib/blob/621a9ebaf18bcd80eb0e1f5fc17fbb4dddf5293a/lib/appium_lib/common/helper.rb#L195) common +-- + +##### [filter=](https://github.com/appium/ruby_lib/blob/1ca8483c461f010a02aec40ec723fd3573a14cd1/lib/appium_lib/common/helper.rb#L195) common > def filter=(value) convert to string to support symbols ---\n\n##### [initialize](https://github.com/appium/ruby_lib/blob/621a9ebaf18bcd80eb0e1f5fc17fbb4dddf5293a/lib/appium_lib/common/helper.rb#L202) common +-- + +##### [initialize](https://github.com/appium/ruby_lib/blob/1ca8483c461f010a02aec40ec723fd3573a14cd1/lib/appium_lib/common/helper.rb#L202) common > def initialize -__Returns:__\n\n     [HTMLElements] a new instance of HTMLElements +__Returns:__ + +     [HTMLElements] a new instance of HTMLElements ---\n\n##### [reset](https://github.com/appium/ruby_lib/blob/621a9ebaf18bcd80eb0e1f5fc17fbb4dddf5293a/lib/appium_lib/common/helper.rb#L207) common +-- + +##### [reset](https://github.com/appium/ruby_lib/blob/1ca8483c461f010a02aec40ec723fd3573a14cd1/lib/appium_lib/common/helper.rb#L207) common > def reset ---\n\n##### [result](https://github.com/appium/ruby_lib/blob/621a9ebaf18bcd80eb0e1f5fc17fbb4dddf5293a/lib/appium_lib/common/helper.rb#L213) common +-- + +##### [result](https://github.com/appium/ruby_lib/blob/1ca8483c461f010a02aec40ec723fd3573a14cd1/lib/appium_lib/common/helper.rb#L213) common > def result ---\n\n##### [start_element](https://github.com/appium/ruby_lib/blob/621a9ebaf18bcd80eb0e1f5fc17fbb4dddf5293a/lib/appium_lib/common/helper.rb#L226) common +-- + +##### [start_element](https://github.com/appium/ruby_lib/blob/1ca8483c461f010a02aec40ec723fd3573a14cd1/lib/appium_lib/common/helper.rb#L226) common > def start_element(name, attrs = []) ---\n\n##### [end_element](https://github.com/appium/ruby_lib/blob/621a9ebaf18bcd80eb0e1f5fc17fbb4dddf5293a/lib/appium_lib/common/helper.rb#L236) common +-- + +##### [end_element](https://github.com/appium/ruby_lib/blob/1ca8483c461f010a02aec40ec723fd3573a14cd1/lib/appium_lib/common/helper.rb#L236) common > def end_element(name) ---\n\n##### [characters](https://github.com/appium/ruby_lib/blob/621a9ebaf18bcd80eb0e1f5fc17fbb4dddf5293a/lib/appium_lib/common/helper.rb#L243) common +-- + +##### [characters](https://github.com/appium/ruby_lib/blob/1ca8483c461f010a02aec40ec723fd3573a14cd1/lib/appium_lib/common/helper.rb#L243) common > def characters(chars) ---\n\n##### [DEFAULT_HEADERS](https://github.com/appium/ruby_lib/blob/621a9ebaf18bcd80eb0e1f5fc17fbb4dddf5293a/lib/appium_lib/common/http_client.rb#L8) common +-- + +##### [DEFAULT_HEADERS](https://github.com/appium/ruby_lib/blob/1ca8483c461f010a02aec40ec723fd3573a14cd1/lib/appium_lib/common/http_client.rb#L8) common > DEFAULT_HEADERS = { 'Accept' => CONTENT_TYPE, 'User-Agent' => "appium/ruby_lib/#{::Appium::VERSION}" }.freeze Default HTTP client inherit Appium::Core::Base::Http::Default, but has different DEFAULT_HEADERS ---\n\n##### [pinch](https://github.com/appium/ruby_lib/blob/621a9ebaf18bcd80eb0e1f5fc17fbb4dddf5293a/lib/appium_lib/common/multi_touch.rb#L51) common +-- + +##### [pinch](https://github.com/appium/ruby_lib/blob/1ca8483c461f010a02aec40ec723fd3573a14cd1/lib/appium_lib/common/multi_touch.rb#L51) common > def pinch(percentage = 25, auto_perform = true, driver = $driver) @@ -948,13 +1328,17 @@ Without auto_perform With driver -__Parameters:__\n\n     [int] percentage - The percent size by which to shrink the screen when pinched. +__Parameters:__ + +     [int] percentage - The percent size by which to shrink the screen when pinched.      [boolean] auto_perform - Whether to perform the action immediately (default true)      [Driver] driver - Set a driver to conduct the action. DEfault is global driver($driver) ---\n\n##### [zoom](https://github.com/appium/ruby_lib/blob/621a9ebaf18bcd80eb0e1f5fc17fbb4dddf5293a/lib/appium_lib/common/multi_touch.rb#L94) common +-- + +##### [zoom](https://github.com/appium/ruby_lib/blob/1ca8483c461f010a02aec40ec723fd3573a14cd1/lib/appium_lib/common/multi_touch.rb#L94) common > def zoom(percentage = 200, auto_perform = true, driver = $driver) @@ -964,169 +1348,243 @@ Without auto_perform With driver -__Parameters:__\n\n     [int] percentage - The percent size by which to shrink the screen when pinched. +__Parameters:__ + +     [int] percentage - The percent size by which to shrink the screen when pinched.      [boolean] auto_perform - Whether to perform the action immediately (default true)      [Driver] driver - Set a driver to conduct the action. DEfault is global driver($driver) ---\n\n##### [initialize](https://github.com/appium/ruby_lib/blob/621a9ebaf18bcd80eb0e1f5fc17fbb4dddf5293a/lib/appium_lib/common/multi_touch.rb#L180) common +-- + +##### [initialize](https://github.com/appium/ruby_lib/blob/1ca8483c461f010a02aec40ec723fd3573a14cd1/lib/appium_lib/common/multi_touch.rb#L180) common > def initialize(driver = $driver) self -__Returns:__\n\n     [MultiTouch] a new instance of MultiTouch +__Returns:__ + +     [MultiTouch] a new instance of MultiTouch ---\n\n##### [COMPLEX_ACTIONS](https://github.com/appium/ruby_lib/blob/621a9ebaf18bcd80eb0e1f5fc17fbb4dddf5293a/lib/appium_lib/common/touch_actions.rb#L33) common +-- + +##### [COMPLEX_ACTIONS](https://github.com/appium/ruby_lib/blob/1ca8483c461f010a02aec40ec723fd3573a14cd1/lib/appium_lib/common/touch_actions.rb#L33) common > COMPLEX_ACTIONS = ::Appium::Core::TouchAction::COMPLEX_ACTIONS ---\n\n##### [initialize](https://github.com/appium/ruby_lib/blob/621a9ebaf18bcd80eb0e1f5fc17fbb4dddf5293a/lib/appium_lib/common/touch_actions.rb#L48) common +-- + +##### [initialize](https://github.com/appium/ruby_lib/blob/1ca8483c461f010a02aec40ec723fd3573a14cd1/lib/appium_lib/common/touch_actions.rb#L48) common > def initialize(driver = $driver) -__Returns:__\n\n     [TouchAction] a new instance of TouchAction +__Returns:__ + +     [TouchAction] a new instance of TouchAction ---\n\n##### [swipe](https://github.com/appium/ruby_lib/blob/621a9ebaf18bcd80eb0e1f5fc17fbb4dddf5293a/lib/appium_lib/common/touch_actions.rb#L52) common +-- + +##### [swipe](https://github.com/appium/ruby_lib/blob/1ca8483c461f010a02aec40ec723fd3573a14cd1/lib/appium_lib/common/touch_actions.rb#L52) common > def swipe(opts) ---\n\n##### [initialize](https://github.com/appium/ruby_lib/blob/621a9ebaf18bcd80eb0e1f5fc17fbb4dddf5293a/lib/appium_lib/common/command/ws_logcat.rb#L5) common +-- + +##### [initialize](https://github.com/appium/ruby_lib/blob/1ca8483c461f010a02aec40ec723fd3573a14cd1/lib/appium_lib/common/command/ws_logcat.rb#L5) common > def initialize(url:, output_file: 'logcat.log') -__Returns:__\n\n     [WsLogcat] a new instance of WsLogcat +__Returns:__ + +     [WsLogcat] a new instance of WsLogcat ---\n\n##### [handle_message_data](https://github.com/appium/ruby_lib/blob/621a9ebaf18bcd80eb0e1f5fc17fbb4dddf5293a/lib/appium_lib/common/command/ws_logcat.rb#L10) common +-- + +##### [handle_message_data](https://github.com/appium/ruby_lib/blob/1ca8483c461f010a02aec40ec723fd3573a14cd1/lib/appium_lib/common/command/ws_logcat.rb#L10) common > def handle_message_data(data) ---\n\n##### [for](https://github.com/appium/ruby_lib/blob/621a9ebaf18bcd80eb0e1f5fc17fbb4dddf5293a/lib/appium_lib/android/android.rb#L19) android +-- + +##### [for](https://github.com/appium/ruby_lib/blob/1ca8483c461f010a02aec40ec723fd3573a14cd1/lib/appium_lib/android/android.rb#L19) android > def self.for(target) ---\n\n##### [TextView](https://github.com/appium/ruby_lib/blob/621a9ebaf18bcd80eb0e1f5fc17fbb4dddf5293a/lib/appium_lib/android/element/text.rb#L4) android +-- + +##### [TextView](https://github.com/appium/ruby_lib/blob/1ca8483c461f010a02aec40ec723fd3573a14cd1/lib/appium_lib/android/element/text.rb#L4) android > TextView = 'android.widget.TextView'.freeze ---\n\n##### [text](https://github.com/appium/ruby_lib/blob/621a9ebaf18bcd80eb0e1f5fc17fbb4dddf5293a/lib/appium_lib/android/element/text.rb#L10) android +-- + +##### [text](https://github.com/appium/ruby_lib/blob/1ca8483c461f010a02aec40ec723fd3573a14cd1/lib/appium_lib/android/element/text.rb#L10) android > def text(value) Find the first TextView that contains value or by index. If int then the TextView at that index is returned. -__Parameters:__\n\n     [String, Integer] value - the value to find. +__Parameters:__ + +     [String, Integer] value - the value to find. + +__Returns:__ -__Returns:__\n\n     [TextView] +     [TextView] ---\n\n##### [texts](https://github.com/appium/ruby_lib/blob/621a9ebaf18bcd80eb0e1f5fc17fbb4dddf5293a/lib/appium_lib/android/element/text.rb#L20) android +-- + +##### [texts](https://github.com/appium/ruby_lib/blob/1ca8483c461f010a02aec40ec723fd3573a14cd1/lib/appium_lib/android/element/text.rb#L20) android > def texts(value = false) Find all TextViews containing value. If value is omitted, all texts are returned. -__Parameters:__\n\n     [String] value - the value to search for +__Parameters:__ + +     [String] value - the value to search for + +__Returns:__ + +     [Array] -__Returns:__\n\n     [Array] +-- ---\n\n##### [first_text](https://github.com/appium/ruby_lib/blob/621a9ebaf18bcd80eb0e1f5fc17fbb4dddf5293a/lib/appium_lib/android/element/text.rb#L28) android +##### [first_text](https://github.com/appium/ruby_lib/blob/1ca8483c461f010a02aec40ec723fd3573a14cd1/lib/appium_lib/android/element/text.rb#L28) android > def first_text Find the first TextView. -__Returns:__\n\n     [TextView] +__Returns:__ + +     [TextView] ---\n\n##### [last_text](https://github.com/appium/ruby_lib/blob/621a9ebaf18bcd80eb0e1f5fc17fbb4dddf5293a/lib/appium_lib/android/element/text.rb#L34) android +-- + +##### [last_text](https://github.com/appium/ruby_lib/blob/1ca8483c461f010a02aec40ec723fd3573a14cd1/lib/appium_lib/android/element/text.rb#L34) android > def last_text Find the last TextView. -__Returns:__\n\n     [TextView] +__Returns:__ + +     [TextView] + +-- ---\n\n##### [text_exact](https://github.com/appium/ruby_lib/blob/621a9ebaf18bcd80eb0e1f5fc17fbb4dddf5293a/lib/appium_lib/android/element/text.rb#L41) android +##### [text_exact](https://github.com/appium/ruby_lib/blob/1ca8483c461f010a02aec40ec723fd3573a14cd1/lib/appium_lib/android/element/text.rb#L41) android > def text_exact(value) Find the first TextView that exactly matches value. -__Parameters:__\n\n     [String] value - the value to match exactly +__Parameters:__ -__Returns:__\n\n     [TextView] +     [String] value - the value to match exactly ---\n\n##### [texts_exact](https://github.com/appium/ruby_lib/blob/621a9ebaf18bcd80eb0e1f5fc17fbb4dddf5293a/lib/appium_lib/android/element/text.rb#L48) android +__Returns:__ + +     [TextView] + +-- + +##### [texts_exact](https://github.com/appium/ruby_lib/blob/1ca8483c461f010a02aec40ec723fd3573a14cd1/lib/appium_lib/android/element/text.rb#L48) android > def texts_exact(value) Find all TextViews that exactly match value. -__Parameters:__\n\n     [String] value - the value to match exactly +__Parameters:__ + +     [String] value - the value to match exactly + +__Returns:__ + +     [Array] -__Returns:__\n\n     [Array] +-- ---\n\n##### [result](https://github.com/appium/ruby_lib/blob/621a9ebaf18bcd80eb0e1f5fc17fbb4dddf5293a/lib/appium_lib/android/common/helper.rb#L6) android +##### [result](https://github.com/appium/ruby_lib/blob/1ca8483c461f010a02aec40ec723fd3573a14cd1/lib/appium_lib/android/common/helper.rb#L6) android > def result Returns the value of attribute result ---\n\n##### [keys](https://github.com/appium/ruby_lib/blob/621a9ebaf18bcd80eb0e1f5fc17fbb4dddf5293a/lib/appium_lib/android/common/helper.rb#L6) android +-- + +##### [keys](https://github.com/appium/ruby_lib/blob/1ca8483c461f010a02aec40ec723fd3573a14cd1/lib/appium_lib/android/common/helper.rb#L6) android > def keys Returns the value of attribute keys ---\n\n##### [filter](https://github.com/appium/ruby_lib/blob/621a9ebaf18bcd80eb0e1f5fc17fbb4dddf5293a/lib/appium_lib/android/common/helper.rb#L6) android +-- + +##### [filter](https://github.com/appium/ruby_lib/blob/1ca8483c461f010a02aec40ec723fd3573a14cd1/lib/appium_lib/android/common/helper.rb#L6) android > def filter Returns the value of attribute filter ---\n\n##### [filter=](https://github.com/appium/ruby_lib/blob/621a9ebaf18bcd80eb0e1f5fc17fbb4dddf5293a/lib/appium_lib/android/common/helper.rb#L9) android +-- + +##### [filter=](https://github.com/appium/ruby_lib/blob/1ca8483c461f010a02aec40ec723fd3573a14cd1/lib/appium_lib/android/common/helper.rb#L9) android > def filter=(value) convert to string to support symbols ---\n\n##### [initialize](https://github.com/appium/ruby_lib/blob/621a9ebaf18bcd80eb0e1f5fc17fbb4dddf5293a/lib/appium_lib/android/common/helper.rb#L16) android +-- + +##### [initialize](https://github.com/appium/ruby_lib/blob/1ca8483c461f010a02aec40ec723fd3573a14cd1/lib/appium_lib/android/common/helper.rb#L16) android > def initialize -__Returns:__\n\n     [AndroidElements] a new instance of AndroidElements +__Returns:__ + +     [AndroidElements] a new instance of AndroidElements + +-- ---\n\n##### [reset](https://github.com/appium/ruby_lib/blob/621a9ebaf18bcd80eb0e1f5fc17fbb4dddf5293a/lib/appium_lib/android/common/helper.rb#L21) android +##### [reset](https://github.com/appium/ruby_lib/blob/1ca8483c461f010a02aec40ec723fd3573a14cd1/lib/appium_lib/android/common/helper.rb#L21) android > def reset ---\n\n##### [start_element](https://github.com/appium/ruby_lib/blob/621a9ebaf18bcd80eb0e1f5fc17fbb4dddf5293a/lib/appium_lib/android/common/helper.rb#L27) android +-- + +##### [start_element](https://github.com/appium/ruby_lib/blob/1ca8483c461f010a02aec40ec723fd3573a14cd1/lib/appium_lib/android/common/helper.rb#L27) android > def start_element(name, attrs = [], driver = $driver) http://nokogiri.org/Nokogiri/XML/SAX/Document.html ---\n\n##### [get_android_inspect](https://github.com/appium/ruby_lib/blob/621a9ebaf18bcd80eb0e1f5fc17fbb4dddf5293a/lib/appium_lib/android/common/helper.rb#L81) android +-- + +##### [get_android_inspect](https://github.com/appium/ruby_lib/blob/1ca8483c461f010a02aec40ec723fd3573a14cd1/lib/appium_lib/android/common/helper.rb#L81) android > def get_android_inspect(class_name = false) @@ -1135,11 +1593,17 @@ Returns a string containing interesting elements. The text, content description, and id are returned. if false (default) then all classes will be inspected -__Parameters:__\n\n     [String] class_name - the class name to filter on. +__Parameters:__ + +     [String] class_name - the class name to filter on. -__Returns:__\n\n     [String] +__Returns:__ ---\n\n##### [page](https://github.com/appium/ruby_lib/blob/621a9ebaf18bcd80eb0e1f5fc17fbb4dddf5293a/lib/appium_lib/android/common/helper.rb#L107) android +     [String] + +-- + +##### [page](https://github.com/appium/ruby_lib/blob/1ca8483c461f010a02aec40ec723fd3573a14cd1/lib/appium_lib/android/common/helper.rb#L107) android > def page(opts = {}) @@ -1148,83 +1612,131 @@ Inspects and prints the current page. Will return XHTML for Web contexts because of a quirk with Nokogiri. if nil (default) then all classes will be inspected -__Parameters:__\n\n     [Hash] class - a customizable set of options +__Parameters:__ + +     [Hash] class - a customizable set of options -__Returns:__\n\n     [void] +__Returns:__ ---\n\n##### [id](https://github.com/appium/ruby_lib/blob/621a9ebaf18bcd80eb0e1f5fc17fbb4dddf5293a/lib/appium_lib/android/common/helper.rb#L116) android +     [void] + +-- + +##### [id](https://github.com/appium/ruby_lib/blob/1ca8483c461f010a02aec40ec723fd3573a14cd1/lib/appium_lib/android/common/helper.rb#L116) android > def id(id) Find the first matching element by id -__Parameters:__\n\n     [String] id - the id to search for +__Parameters:__ + +     [String] id - the id to search for -__Returns:__\n\n     [Element] +__Returns:__ ---\n\n##### [ids](https://github.com/appium/ruby_lib/blob/621a9ebaf18bcd80eb0e1f5fc17fbb4dddf5293a/lib/appium_lib/android/common/helper.rb#L124) android +     [Element] + +-- + +##### [ids](https://github.com/appium/ruby_lib/blob/1ca8483c461f010a02aec40ec723fd3573a14cd1/lib/appium_lib/android/common/helper.rb#L124) android > def ids(id) Find all matching elements by id -__Parameters:__\n\n     [String] id - the id to search for +__Parameters:__ + +     [String] id - the id to search for -__Returns:__\n\n     [Element] +__Returns:__ ---\n\n##### [ele_index](https://github.com/appium/ruby_lib/blob/621a9ebaf18bcd80eb0e1f5fc17fbb4dddf5293a/lib/appium_lib/android/common/helper.rb#L133) android +     [Element] + +-- + +##### [ele_index](https://github.com/appium/ruby_lib/blob/1ca8483c461f010a02aec40ec723fd3573a14cd1/lib/appium_lib/android/common/helper.rb#L133) android > def ele_index(class_name, index) Find the element of type class_name at matching index. -__Parameters:__\n\n     [String] class_name - the class name to find +__Parameters:__ + +     [String] class_name - the class name to find      [Integer] index - the index -__Returns:__\n\n     [Element] the found element of type class_name +__Returns:__ ---\n\n##### [first_ele](https://github.com/appium/ruby_lib/blob/621a9ebaf18bcd80eb0e1f5fc17fbb4dddf5293a/lib/appium_lib/android/common/helper.rb#L152) android +     [Element] the found element of type class_name + +-- + +##### [first_ele](https://github.com/appium/ruby_lib/blob/1ca8483c461f010a02aec40ec723fd3573a14cd1/lib/appium_lib/android/common/helper.rb#L152) android > def first_ele(class_name) Find the first element that matches class_name -__Parameters:__\n\n     [String] class_name - the tag to match +__Parameters:__ + +     [String] class_name - the tag to match -__Returns:__\n\n     [Element] +__Returns:__ ---\n\n##### [last_ele](https://github.com/appium/ruby_lib/blob/621a9ebaf18bcd80eb0e1f5fc17fbb4dddf5293a/lib/appium_lib/android/common/helper.rb#L159) android +     [Element] + +-- + +##### [last_ele](https://github.com/appium/ruby_lib/blob/1ca8483c461f010a02aec40ec723fd3573a14cd1/lib/appium_lib/android/common/helper.rb#L159) android > def last_ele(class_name) Find the last element that matches class_name -__Parameters:__\n\n     [String] class_name - the tag to match +__Parameters:__ + +     [String] class_name - the tag to match -__Returns:__\n\n     [Element] +__Returns:__ ---\n\n##### [tag](https://github.com/appium/ruby_lib/blob/621a9ebaf18bcd80eb0e1f5fc17fbb4dddf5293a/lib/appium_lib/android/common/helper.rb#L167) android +     [Element] + +-- + +##### [tag](https://github.com/appium/ruby_lib/blob/1ca8483c461f010a02aec40ec723fd3573a14cd1/lib/appium_lib/android/common/helper.rb#L167) android > def tag(class_name) Find the first element of type class_name -__Parameters:__\n\n     [String] class_name - the class_name to search for +__Parameters:__ + +     [String] class_name - the class_name to search for -__Returns:__\n\n     [Element] +__Returns:__ ---\n\n##### [tags](https://github.com/appium/ruby_lib/blob/621a9ebaf18bcd80eb0e1f5fc17fbb4dddf5293a/lib/appium_lib/android/common/helper.rb#L175) android +     [Element] + +-- + +##### [tags](https://github.com/appium/ruby_lib/blob/1ca8483c461f010a02aec40ec723fd3573a14cd1/lib/appium_lib/android/common/helper.rb#L175) android > def tags(class_name) Find all elements of type class_name -__Parameters:__\n\n     [String] class_name - the class_name to search for +__Parameters:__ + +     [String] class_name - the class_name to search for -__Returns:__\n\n     [Element] +__Returns:__ ---\n\n##### [string_visible_contains_xpath](https://github.com/appium/ruby_lib/blob/621a9ebaf18bcd80eb0e1f5fc17fbb4dddf5293a/lib/appium_lib/android/common/helper.rb#L218) android +     [Element] + +-- + +##### [string_visible_contains_xpath](https://github.com/appium/ruby_lib/blob/1ca8483c461f010a02aec40ec723fd3573a14cd1/lib/appium_lib/android/common/helper.rb#L218) android > def string_visible_contains_xpath(class_name, value) @@ -1233,13 +1745,19 @@ For automationName is uiautomator2 example: string_visible_contains_xpath 'UIATextField', 'sign in' note for XPath: https://github.com/appium/ruby_lib/pull/561 -__Parameters:__\n\n     [String] class_name - the class name for the element +__Parameters:__ + +     [String] class_name - the class name for the element      [String] value - the value to search for -__Returns:__\n\n     [String] +__Returns:__ ---\n\n##### [string_visible_contains](https://github.com/appium/ruby_lib/blob/621a9ebaf18bcd80eb0e1f5fc17fbb4dddf5293a/lib/appium_lib/android/common/helper.rb#L238) android +     [String] + +-- + +##### [string_visible_contains](https://github.com/appium/ruby_lib/blob/1ca8483c461f010a02aec40ec723fd3573a14cd1/lib/appium_lib/android/common/helper.rb#L238) android > def string_visible_contains(class_name, value) @@ -1248,317 +1766,479 @@ For automationName is Appium example: string_visible_contains 'UIATextField', 'sign in' note for XPath: https://github.com/appium/ruby_lib/pull/561 -__Parameters:__\n\n     [String] class_name - the class name for the element +__Parameters:__ + +     [String] class_name - the class name for the element      [String] value - the value to search for -__Returns:__\n\n     [String] +__Returns:__ ---\n\n##### [complex_find_contains](https://github.com/appium/ruby_lib/blob/621a9ebaf18bcd80eb0e1f5fc17fbb4dddf5293a/lib/appium_lib/android/common/helper.rb#L256) android +     [String] + +-- + +##### [complex_find_contains](https://github.com/appium/ruby_lib/blob/1ca8483c461f010a02aec40ec723fd3573a14cd1/lib/appium_lib/android/common/helper.rb#L256) android > def complex_find_contains(class_name, value) Find the first element that contains value -__Parameters:__\n\n     [String] class_name - the class name for the element +__Parameters:__ + +     [String] class_name - the class name for the element      [String] value - the value to search for -__Returns:__\n\n     [Element] +__Returns:__ ---\n\n##### [complex_finds_contains](https://github.com/appium/ruby_lib/blob/621a9ebaf18bcd80eb0e1f5fc17fbb4dddf5293a/lib/appium_lib/android/common/helper.rb#L264) android +     [Element] + +-- + +##### [complex_finds_contains](https://github.com/appium/ruby_lib/blob/1ca8483c461f010a02aec40ec723fd3573a14cd1/lib/appium_lib/android/common/helper.rb#L264) android > def complex_finds_contains(class_name, value) Find all elements containing value -__Parameters:__\n\n     [String] class_name - the class name for the element +__Parameters:__ + +     [String] class_name - the class name for the element      [String] value - the value to search for -__Returns:__\n\n     [Array] +__Returns:__ ---\n\n##### [complex_find_exact](https://github.com/appium/ruby_lib/blob/621a9ebaf18bcd80eb0e1f5fc17fbb4dddf5293a/lib/appium_lib/android/common/helper.rb#L306) android +     [Array] + +-- + +##### [complex_find_exact](https://github.com/appium/ruby_lib/blob/1ca8483c461f010a02aec40ec723fd3573a14cd1/lib/appium_lib/android/common/helper.rb#L306) android > def complex_find_exact(class_name, value) Find the first element exactly matching value -__Parameters:__\n\n     [String] class_name - the class name for the element +__Parameters:__ + +     [String] class_name - the class name for the element      [String] value - the value to search for -__Returns:__\n\n     [Element] +__Returns:__ ---\n\n##### [complex_finds_exact](https://github.com/appium/ruby_lib/blob/621a9ebaf18bcd80eb0e1f5fc17fbb4dddf5293a/lib/appium_lib/android/common/helper.rb#L314) android +     [Element] + +-- + +##### [complex_finds_exact](https://github.com/appium/ruby_lib/blob/1ca8483c461f010a02aec40ec723fd3573a14cd1/lib/appium_lib/android/common/helper.rb#L314) android > def complex_finds_exact(class_name, value) Find all elements exactly matching value -__Parameters:__\n\n     [String] class_name - the class name for the element +__Parameters:__ + +     [String] class_name - the class name for the element      [String] value - the value to search for -__Returns:__\n\n     [Element] +__Returns:__ ---\n\n##### [alert_click](https://github.com/appium/ruby_lib/blob/621a9ebaf18bcd80eb0e1f5fc17fbb4dddf5293a/lib/appium_lib/android/element/alert.rb#L6) android +     [Element] + +-- + +##### [alert_click](https://github.com/appium/ruby_lib/blob/1ca8483c461f010a02aec40ec723fd3573a14cd1/lib/appium_lib/android/element/alert.rb#L6) android > def alert_click(value) Click the first alert button that contains value or by index. -__Parameters:__\n\n     [Integer, String] value - either an integer index of the button or the button's name +__Parameters:__ + +     [Integer, String] value - either an integer index of the button or the button's name -__Returns:__\n\n     [void] +__Returns:__ ---\n\n##### [alert_accept](https://github.com/appium/ruby_lib/blob/621a9ebaf18bcd80eb0e1f5fc17fbb4dddf5293a/lib/appium_lib/android/element/alert.rb#L13) android +     [void] + +-- + +##### [alert_accept](https://github.com/appium/ruby_lib/blob/1ca8483c461f010a02aec40ec723fd3573a14cd1/lib/appium_lib/android/element/alert.rb#L13) android > def alert_accept Accept the alert. The last button is considered "accept." -__Returns:__\n\n     [void] +__Returns:__ + +     [void] ---\n\n##### [alert_accept_text](https://github.com/appium/ruby_lib/blob/621a9ebaf18bcd80eb0e1f5fc17fbb4dddf5293a/lib/appium_lib/android/element/alert.rb#L20) android +-- + +##### [alert_accept_text](https://github.com/appium/ruby_lib/blob/1ca8483c461f010a02aec40ec723fd3573a14cd1/lib/appium_lib/android/element/alert.rb#L20) android > def alert_accept_text Get the text of the alert's accept button. The last button is considered "accept." -__Returns:__\n\n     [String] +__Returns:__ + +     [String] + +-- ---\n\n##### [alert_dismiss](https://github.com/appium/ruby_lib/blob/621a9ebaf18bcd80eb0e1f5fc17fbb4dddf5293a/lib/appium_lib/android/element/alert.rb#L27) android +##### [alert_dismiss](https://github.com/appium/ruby_lib/blob/1ca8483c461f010a02aec40ec723fd3573a14cd1/lib/appium_lib/android/element/alert.rb#L27) android > def alert_dismiss Dismiss the alert. The first button is considered "dismiss." -__Returns:__\n\n     [void] +__Returns:__ ---\n\n##### [alert_dismiss_text](https://github.com/appium/ruby_lib/blob/621a9ebaf18bcd80eb0e1f5fc17fbb4dddf5293a/lib/appium_lib/android/element/alert.rb#L34) android +     [void] + +-- + +##### [alert_dismiss_text](https://github.com/appium/ruby_lib/blob/1ca8483c461f010a02aec40ec723fd3573a14cd1/lib/appium_lib/android/element/alert.rb#L34) android > def alert_dismiss_text Get the text of the alert's dismiss button. The first button is considered "dismiss." -__Returns:__\n\n     [String] +__Returns:__ + +     [String] ---\n\n##### [Button](https://github.com/appium/ruby_lib/blob/621a9ebaf18bcd80eb0e1f5fc17fbb4dddf5293a/lib/appium_lib/android/element/button.rb#L3) android +-- + +##### [Button](https://github.com/appium/ruby_lib/blob/1ca8483c461f010a02aec40ec723fd3573a14cd1/lib/appium_lib/android/element/button.rb#L3) android > Button = 'android.widget.Button'.freeze ---\n\n##### [ImageButton](https://github.com/appium/ruby_lib/blob/621a9ebaf18bcd80eb0e1f5fc17fbb4dddf5293a/lib/appium_lib/android/element/button.rb#L4) android +-- + +##### [ImageButton](https://github.com/appium/ruby_lib/blob/1ca8483c461f010a02aec40ec723fd3573a14cd1/lib/appium_lib/android/element/button.rb#L4) android > ImageButton = 'android.widget.ImageButton'.freeze ---\n\n##### [button](https://github.com/appium/ruby_lib/blob/621a9ebaf18bcd80eb0e1f5fc17fbb4dddf5293a/lib/appium_lib/android/element/button.rb#L10) android +-- + +##### [button](https://github.com/appium/ruby_lib/blob/1ca8483c461f010a02aec40ec723fd3573a14cd1/lib/appium_lib/android/element/button.rb#L10) android > def button(value) Find the first button that contains value or by index. If int then the button at that index is returned. -__Parameters:__\n\n     [String, Integer] value - the value to exactly match. +__Parameters:__ -__Returns:__\n\n     [Button] +     [String, Integer] value - the value to exactly match. ---\n\n##### [buttons](https://github.com/appium/ruby_lib/blob/621a9ebaf18bcd80eb0e1f5fc17fbb4dddf5293a/lib/appium_lib/android/element/button.rb#L27) android +__Returns:__ + +     [Button] + +-- + +##### [buttons](https://github.com/appium/ruby_lib/blob/1ca8483c461f010a02aec40ec723fd3573a14cd1/lib/appium_lib/android/element/button.rb#L27) android > def buttons(value = false) Find all buttons containing value. If value is omitted, all buttons are returned. -__Parameters:__\n\n     [String] value - the value to search for +__Parameters:__ + +     [String] value - the value to search for + +__Returns:__ -__Returns:__\n\n     [Array