RubyGems - appium_lib - Versions diffs - 8.1.0 → 8.2.0 - Mend

appium_lib 8.1.0 → 8.2.0

Files changed (14) hide show

checksums.yaml +4 -4
data/Rakefile +14 -8
data/android_tests/lib/android/specs/common/device.rb +21 -0
data/android_tests/lib/android/specs/driver.rb +3 -3
data/android_tests/lib/run.rb +3 -3
data/contributing.md +3 -1
data/docs/android_docs.md +14 -2375
data/docs/migration.md +23 -0
data/ios_tests/lib/ios/specs/driver.rb +3 -3
data/lib/appium_lib/common/version.rb +2 -2
data/lib/appium_lib/device/device.rb +98 -0
data/lib/appium_lib/driver.rb +40 -36
data/release_notes.md +9 -2
metadata +2 -2

checksums.yaml CHANGED Viewed

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d1047c021d9e6c8e73618d525540ee4632fa6d97
-  data.tar.gz: a97ad37976b48c146609c5fbcef8ed60223c1a10
+  metadata.gz: 3654883834d498a7f5666fa706cd436a5f7c00dd
+  data.tar.gz: 05533eb431feafea2cbcba7f782e3dd23d6b0b1d
 SHA512:
-  metadata.gz: d2b3f5ce8c771576e22c17d4c7f186776444bbc57ccf91b5de99cb6c7586aa4a3317b35c8a96238c7058af33837b7317837ee5ac7770d0b79b19fd0b31cd8cda
-  data.tar.gz: b16f638919d409ae817ff3e601de26c9466df4c392b4fdd917529894c3c35f1aa5fc3a902d591b6f1b651906a30288b369cb8c05404b60198a437ee3e2ecc1ee
+  metadata.gz: a970ebc14a8caaa3274abb0580bd4220350eaec3a4471a631a5c03f4f206fe2dcee7b39b1533d007b5834126c8e784f1691b6d5eb4856e857497cfc9ae7ec734
+  data.tar.gz: 4ccdb62491dd8918d54c55ddf15cbe1aca7b6726cd3f9c2c275b916e098aeedded6671d8db7d5bfda5ae53ee6e1d93867d099df949cb3b7952ae592e9baa1fd7

data/Rakefile CHANGED Viewed

@@ -94,7 +94,7 @@ def tag_exists tag_name
 end
 # Inspired by Gollum's Rakefile
-desc 'Build and release a new gem to rubygems.org'
+desc 'Generate release note and create a release branch'
 task :release => :gem do
   unless `git branch`.include? '* master'
     puts 'Master branch required to release.'
@@ -108,22 +108,28 @@ task :release => :gem do
   tag_name = "v#{version}"
   raise 'Tag already exists!' if tag_exists tag_name
-  # Commit then pull before pushing.
   sh "git commit --allow-empty -am 'Release #{version}'"
   sh 'git pull'
   sh "git tag #{tag_name}"
+  branch_name = "release_#{version.gsub('.', '_')}"
+  sh "git checkout -b #{branch_name}"
   # update notes now that there's a new tag
   Rake::Task['notes'].execute
   Rake::Task['docs'].execute
   sh "git commit --allow-empty -am 'Update release notes'"
-  sh 'git push origin master'
-  sh "git push origin #{tag_name}"
-  gem_build
-  # sh "gem push #{repo_name}-#{version}.gem"
+  puts "Please git push #{branch_name} and send PR, merge it."
 end
-desc 'Build and release a new gem to rubygems.org (same as release)'
-task :publish => :release do
+desc 'Build and release a new gem to rubygems.org'
+task :publish do
+  tag_name = "v#{version}"
+  sh "git push origin #{tag_name}"
+  gem_build
+  sh "gem push #{repo_name}-#{version}.gem"
 end
 def gem_build

data/android_tests/lib/android/specs/common/device.rb CHANGED Viewed

@@ -114,4 +114,25 @@ describe 'common/device' do
     data = pull_folder '/data/local/tmp'
     data.length.must_be :>, 100
   end
+  t 'ime_available_engines' do
+    ime_latin = 'com.google.android.inputmethod.latin/com.android.inputmethod.latin.LatinIME'
+    wait { find('app').click }
+    wait { find('Search').click }
+    wait { find('Invoke Search').click }
+    imes = ime_available_engines
+    imes.include?(ime_latin).must_equal true
+    wait { ime_activate(ime_latin) }
+    ime_active_engine.must_equal ime_latin
+    ime_activated.must_equal true
+    wait { ime_deactivate }
+    ime_active_engine.wont_equal ime_latin
+    wait { ime_activate(ime_latin) }
+    ime_active_engine.must_equal ime_latin
+  end
 end

data/android_tests/lib/android/specs/driver.rb CHANGED Viewed

@@ -6,9 +6,9 @@ describe 'driver' do
     ENV['UPLOAD_FILE'] && ENV['SAUCE_USERNAME']
   end
-  t 'load_appium_txt' do
-    appium_txt = File.expand_path(File.join(Dir.pwd, 'lib'))
-    parsed   = Appium.load_appium_txt file: appium_txt, verbose: true
+  t 'load_settings' do
+    appium_txt = File.join(Dir.pwd, 'appium.txt')
+    parsed   = Appium.load_settings file: appium_txt, verbose: true
     apk_name = File.basename parsed[:caps][:app]
     assert_equal apk_name, 'api.apk'
   end

data/android_tests/lib/run.rb CHANGED Viewed

@@ -21,8 +21,8 @@ end
 a = OpenStruct.new x: 'ok'
 fail 'x issue' unless a.x == 'ok'
-appium_txt  = File.expand_path(File.join(Dir.pwd, 'lib'))
-dir     = appium_txt
+dir  = File.expand_path(File.join(Dir.pwd, 'lib'))
+appium_txt = File.join(Dir.pwd, 'appium.txt')
 device  = ARGV[0].downcase.strip
 devices = %w(android selendroid ios)
 fail 'Expected android, selendroid or ios as first argument' unless devices.include? device
@@ -30,7 +30,7 @@ fail 'Expected android, selendroid or ios as first argument' unless devices.incl
 one_test = ARGV[1]
 test_dir = "/#{device}/"
-caps       = Appium.load_appium_txt file: appium_txt, verbose: true
+caps       = Appium.load_settings file: appium_txt, verbose: true
 caps       = caps.merge(appium_lib: { debug: true, wait: 1 })
 caps[:app] = ENV['SAUCE_PATH'] if ENV['SAUCE_USERNAME'] && ENV['SAUCE_ACCESS_KEY']

data/contributing.md CHANGED Viewed

@@ -29,4 +29,6 @@ Android tests require running on physical hardware with Android 5.0 (API 21). Th
 ~/.gem/credentials; chmod 0600 ~/.gem/credentials
 1. Bump the version number `rake bump`
-2. Publish with `rake release`
+2. Generate release note and create a branch with `rake release`
+    - Push and merge the branch to the master
+3. Build and publish gem with `rake publish`

data/docs/android_docs.md CHANGED Viewed

@@ -1,9 +1,8 @@
-##### [load_appium_txt](https://github.com/appium/ruby_lib/blob/95d3a6535472559590c4d043e887d15acc445a1a/lib/appium_lib/driver.rb#L70)
+##### [load_settings](https://github.com/appium/ruby_lib/blob/4535ec91f435255ae31b4c4fea9d96e5405d79f5/lib/appium_lib/driver.rb#L69)
-> def self.load_appium_txt(opts = {})
+> def self.load_settings(opts = {})
 Load appium.txt (toml format)
-the basedir of this file + appium.txt is what's used
 ```
 [caps]
@@ -27,2391 +26,31 @@ __Returns:__
 --
-##### [symbolize_keys](https://github.com/appium/ruby_lib/blob/95d3a6535472559590c4d043e887d15acc445a1a/lib/appium_lib/driver.rb#L136)
+##### [load_appium_txt](https://github.com/appium/ruby_lib/blob/4535ec91f435255ae31b4c4fea9d96e5405d79f5/lib/appium_lib/driver.rb#L102)
-> def self.symbolize_keys(hash)
+> def self.load_settings(opts = {})
-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/95d3a6535472559590c4d043e887d15acc445a1a/lib/appium_lib/driver.rb#L157)
-> 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
-those could be promoted on with Appium.promote_singleton_appium_methods Page
-If you are promoting on an individual class then you should use
-Appium.promote_appium_methods instead. The singleton method is intended
-only for the shared module use case.
-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.
---
-##### [promote_appium_methods](https://github.com/appium/ruby_lib/blob/95d3a6535472559590c4d043e887d15acc445a1a/lib/appium_lib/driver.rb#L208)
-> def self.promote_appium_methods(class_array)
-Promote appium methods to class instance methods
-To promote methods to all classes:
-```ruby
-Appium.promote_appium_methods Object
-```
-It's better to promote on specific classes instead of Object
-```ruby
-# promote on rspec
-Appium.promote_appium_methods RSpec::Core::ExampleGroup
-```
-```ruby
-# promote on minispec
-Appium.promote_appium_methods Minitest::Spec
-```
-__Parameters:__
-&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Array<Class>] class_array - An array of classes
---
-##### [global_webdriver_http_sleep](https://github.com/appium/ruby_lib/blob/95d3a6535472559590c4d043e887d15acc445a1a/lib/appium_lib/driver.rb#L242)
-> 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/95d3a6535472559590c4d043e887d15acc445a1a/lib/appium_lib/driver.rb#L242)
-> 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/95d3a6535472559590c4d043e887d15acc445a1a/lib/appium_lib/driver.rb#L244)
-> def caps
-Selenium webdriver capabilities
---
-##### [caps=](https://github.com/appium/ruby_lib/blob/95d3a6535472559590c4d043e887d15acc445a1a/lib/appium_lib/driver.rb#L244)
-> def caps=(value)
-Selenium webdriver capabilities
---
-##### [custom_url](https://github.com/appium/ruby_lib/blob/95d3a6535472559590c4d043e887d15acc445a1a/lib/appium_lib/driver.rb#L246)
-> def custom_url
-Custom URL for the selenium server
---
-##### [custom_url=](https://github.com/appium/ruby_lib/blob/95d3a6535472559590c4d043e887d15acc445a1a/lib/appium_lib/driver.rb#L246)
-> def custom_url=(value)
-Custom URL for the selenium server
---
-##### [export_session](https://github.com/appium/ruby_lib/blob/95d3a6535472559590c4d043e887d15acc445a1a/lib/appium_lib/driver.rb#L248)
-> def export_session
-Export session id to textfile in /tmp for 3rd party tools
---
-##### [export_session=](https://github.com/appium/ruby_lib/blob/95d3a6535472559590c4d043e887d15acc445a1a/lib/appium_lib/driver.rb#L248)
-> def export_session=(value)
-Export session id to textfile in /tmp for 3rd party tools
---
-##### [default_wait](https://github.com/appium/ruby_lib/blob/95d3a6535472559590c4d043e887d15acc445a1a/lib/appium_lib/driver.rb#L253)
-> def default_wait
-Default wait time for elements to appear
-Returns the default client side wait.
-This value is independent of what the server is using
-__Returns:__
-&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Integer]
---
-##### [default_wait=](https://github.com/appium/ruby_lib/blob/95d3a6535472559590c4d043e887d15acc445a1a/lib/appium_lib/driver.rb#L253)
-> def default_wait=(value)
-Default wait time for elements to appear
-Returns the default client side wait.
-This value is independent of what the server is using
-__Returns:__
-&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Integer]
---
-##### [last_waits](https://github.com/appium/ruby_lib/blob/95d3a6535472559590c4d043e887d15acc445a1a/lib/appium_lib/driver.rb#L255)
-> def last_waits
-Array of previous wait time values
---
-##### [last_waits=](https://github.com/appium/ruby_lib/blob/95d3a6535472559590c4d043e887d15acc445a1a/lib/appium_lib/driver.rb#L255)
-> def last_waits=(value)
-Array of previous wait time values
---
-##### [sauce_username](https://github.com/appium/ruby_lib/blob/95d3a6535472559590c4d043e887d15acc445a1a/lib/appium_lib/driver.rb#L257)
-> def sauce_username
-Username for use on Sauce Labs
---
-##### [sauce_username=](https://github.com/appium/ruby_lib/blob/95d3a6535472559590c4d043e887d15acc445a1a/lib/appium_lib/driver.rb#L257)
-> def sauce_username=(value)
-Username for use on Sauce Labs
---
-##### [sauce_access_key](https://github.com/appium/ruby_lib/blob/95d3a6535472559590c4d043e887d15acc445a1a/lib/appium_lib/driver.rb#L259)
-> def sauce_access_key
-Access Key for use on Sauce Labs
---
-##### [sauce_access_key=](https://github.com/appium/ruby_lib/blob/95d3a6535472559590c4d043e887d15acc445a1a/lib/appium_lib/driver.rb#L259)
-> def sauce_access_key=(value)
-Access Key for use on Sauce Labs
---
-##### [appium_port](https://github.com/appium/ruby_lib/blob/95d3a6535472559590c4d043e887d15acc445a1a/lib/appium_lib/driver.rb#L261)
-> def appium_port
-Appium's server port
---
-##### [appium_port=](https://github.com/appium/ruby_lib/blob/95d3a6535472559590c4d043e887d15acc445a1a/lib/appium_lib/driver.rb#L261)
-> def appium_port=(value)
-Appium's server port
---
-##### [appium_device](https://github.com/appium/ruby_lib/blob/95d3a6535472559590c4d043e887d15acc445a1a/lib/appium_lib/driver.rb#L263)
-> def appium_device
-Device type to request from the appium server
---
-##### [appium_device=](https://github.com/appium/ruby_lib/blob/95d3a6535472559590c4d043e887d15acc445a1a/lib/appium_lib/driver.rb#L263)
-> def appium_device=(value)
-Device type to request from the appium server
---
-##### [appium_debug](https://github.com/appium/ruby_lib/blob/95d3a6535472559590c4d043e887d15acc445a1a/lib/appium_lib/driver.rb#L265)
-> def appium_debug
-Boolean debug mode for the Appium Ruby bindings
---
-##### [appium_debug=](https://github.com/appium/ruby_lib/blob/95d3a6535472559590c4d043e887d15acc445a1a/lib/appium_lib/driver.rb#L265)
-> def appium_debug=(value)
-Boolean debug mode for the Appium Ruby bindings
---
-##### [listener](https://github.com/appium/ruby_lib/blob/95d3a6535472559590c4d043e887d15acc445a1a/lib/appium_lib/driver.rb#L267)
-> def listener
-instance of AbstractEventListener for logging support
---
-##### [listener=](https://github.com/appium/ruby_lib/blob/95d3a6535472559590c4d043e887d15acc445a1a/lib/appium_lib/driver.rb#L267)
-> def listener=(value)
-instance of AbstractEventListener for logging support
---
-##### [driver](https://github.com/appium/ruby_lib/blob/95d3a6535472559590c4d043e887d15acc445a1a/lib/appium_lib/driver.rb#L271)
-> def driver
-Returns the driver
-__Returns:__
-&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Driver] the driver
---
-##### [initialize](https://github.com/appium/ruby_lib/blob/95d3a6535472559590c4d043e887d15acc445a1a/lib/appium_lib/driver.rb#L292)
-> def initialize(opts = {})
-Creates a new driver
-```ruby
-require 'rubygems'
-require 'appium_lib'
-# platformName takes a string or a symbol.
-# Start iOS driver
-opts = { caps: { platformName: :ios, app: '/path/to/MyiOS.app' } }
-Appium::Driver.new(opts).start_driver
+Load appium.txt (toml format)
-# Start Android driver
-opts = { caps: { platformName: :android, app: '/path/to/my.apk' } }
-Appium::Driver.new(opts).start_driver
 ```
+[caps]
+app = "path/to/app"
-__Parameters:__
-&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Object] opts - A hash containing various options.
-__Returns:__
-&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Driver]
---
-##### [driver_attributes](https://github.com/appium/ruby_lib/blob/95d3a6535472559590c4d043e887d15acc445a1a/lib/appium_lib/driver.rb#L360)
-> def driver_attributes
-Returns a hash of the driver attributes
---
-##### [device_is_android?](https://github.com/appium/ruby_lib/blob/95d3a6535472559590c4d043e887d15acc445a1a/lib/appium_lib/driver.rb#L381)
-> def device_is_android?
-__Returns:__
-&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Boolean]
---
-##### [appium_server_version](https://github.com/appium/ruby_lib/blob/95d3a6535472559590c4d043e887d15acc445a1a/lib/appium_lib/driver.rb#L397)
-> def appium_server_version
-Returns the server's version info
-```ruby
-{
-    "build" => {
-        "version" => "0.18.1",
-        "revision" => "d242ebcfd92046a974347ccc3a28f0e898595198"
-    }
-}
+[appium_lib]
+port = 8080
 ```
-__Returns:__
-&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Hash]
---
-##### [absolute_app_path](https://github.com/appium/ruby_lib/blob/95d3a6535472559590c4d043e887d15acc445a1a/lib/appium_lib/driver.rb#L409)
-> def self.absolute_app_path(opts)
-Converts app_path to an absolute path.
-opts is the full options hash (caps and appium_lib). If server_url is set
-then the app path is used as is.
-if app isn't set then an error is raised.
-__Returns:__
-&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[String] APP_PATH as an absolute path
---
-##### [server_url](https://github.com/appium/ruby_lib/blob/95d3a6535472559590c4d043e887d15acc445a1a/lib/appium_lib/driver.rb#L442)
-> def server_url
-Get the server url
-__Returns:__
-&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[String] the server url
---
-##### [restart](https://github.com/appium/ruby_lib/blob/95d3a6535472559590c4d043e887d15acc445a1a/lib/appium_lib/driver.rb#L453)
-> def restart
-Restarts the driver
-__Returns:__
-&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Driver] the driver
---
-##### [screenshot](https://github.com/appium/ruby_lib/blob/95d3a6535472559590c4d043e887d15acc445a1a/lib/appium_lib/driver.rb#L464)
-> def screenshot(png_save_path)
-Takes a png screenshot and saves to the target path.
-Example: screenshot '/tmp/hi.png'
+:app is expanded
+:require is expanded
+all keys are converted to symbols
 __Parameters:__
-&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[String] png_save_path - the full path to save the png
-__Returns:__
-&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[nil]
---
-##### [driver_quit](https://github.com/appium/ruby_lib/blob/95d3a6535472559590c4d043e887d15acc445a1a/lib/appium_lib/driver.rb#L471)
-> def driver_quit
-Quits the driver
-__Returns:__
-&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[void]
---
-##### [start_driver](https://github.com/appium/ruby_lib/blob/95d3a6535472559590c4d043e887d15acc445a1a/lib/appium_lib/driver.rb#L480)
-> def start_driver
-Creates a new global driver and quits the old one if it exists.
+&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Hash] opts - file: '/path/to/appium.txt', verbose: true
 __Returns:__
-&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Selenium::WebDriver] the new global driver
---
-##### [no_wait](https://github.com/appium/ruby_lib/blob/95d3a6535472559590c4d043e887d15acc445a1a/lib/appium_lib/driver.rb#L513)
-> def no_wait
-Set implicit wait and default_wait to zero.
---
-##### [set_wait](https://github.com/appium/ruby_lib/blob/95d3a6535472559590c4d043e887d15acc445a1a/lib/appium_lib/driver.rb#L532)
-> def set_wait(timeout = nil)
-Set implicit wait and default_wait to timeout, defaults to 30.
-if set_wait is called without a param then the second to last
-wait will be used.
-```ruby`
-set_wait 2
-set_wait 3
-set_wait # 2
-````
-__Parameters:__
-&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Integer] timeout - the timeout in seconds
-__Returns:__
-&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[void]
---
-##### [exists](https://github.com/appium/ruby_lib/blob/95d3a6535472559590c4d043e887d15acc445a1a/lib/appium_lib/driver.rb#L559)
-> def exists(pre_check = 0, post_check = @default_wait, &search_block)
-Returns existence of element.
-Example:
-exists { button('sign in') } ? puts('true') : puts('false')
-__Parameters:__
-&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Integer] pre_check - the amount in seconds to set the
-wait to before checking existance
-&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Integer] post_check - the amount in seconds to set the
-wait to after checking existance
-&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Block] search_block - the block to call
-__Returns:__
-&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Boolean]
---
-##### [execute_script](https://github.com/appium/ruby_lib/blob/95d3a6535472559590c4d043e887d15acc445a1a/lib/appium_lib/driver.rb#L583)
-> def execute_script(script, *args)
-The same as @driver.execute_script
-__Parameters:__
-&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[String] script - the script to execute
-&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[*args] args - the args to pass to the script
-__Returns:__
-&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Object]
---
-##### [find_elements](https://github.com/appium/ruby_lib/blob/95d3a6535472559590c4d043e887d15acc445a1a/lib/appium_lib/driver.rb#L591)
-> def find_elements(*args)
-Calls @driver.find_elements
-__Parameters:__
-&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[*args] args - the args to use
-__Returns:__
-&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Array<Element>] Array is empty when no elements are found.
---
-##### [find_element](https://github.com/appium/ruby_lib/blob/95d3a6535472559590c4d043e887d15acc445a1a/lib/appium_lib/driver.rb#L599)
-> def find_element(*args)
-Calls @driver.find_elements
-__Parameters:__
-&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[*args] args - the args to use
-__Returns:__
-&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Element]
---
-##### [set_location](https://github.com/appium/ruby_lib/blob/95d3a6535472559590c4d043e887d15acc445a1a/lib/appium_lib/driver.rb#L612)
-> def set_location(opts = {})
-Calls @driver.set_location
-__Parameters:__
-&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Hash] opts - consisting of:
-__Returns:__
-&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Selenium::WebDriver::Location] the location constructed by the selenium webdriver
---
-##### [x](https://github.com/appium/ruby_lib/blob/95d3a6535472559590c4d043e887d15acc445a1a/lib/appium_lib/driver.rb#L622)
-> def x
-Quit the driver and Pry.
-quit and exit are reserved by Pry.
-__Returns:__
-&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[void]
---
-##### [logger=](https://github.com/appium/ruby_lib/blob/95d3a6535472559590c4d043e887d15acc445a1a/lib/appium_lib/logger.rb#L13)
-> def logger=(value)
-Sets the attribute logger
-__Parameters:__
-&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;value - the value to set the attribute logger to.
---
-##### [logger](https://github.com/appium/ruby_lib/blob/95d3a6535472559590c4d043e887d15acc445a1a/lib/appium_lib/logger.rb#L17)
-> def logger
---
-##### [NoArgMethods](https://github.com/appium/ruby_lib/blob/95d3a6535472559590c4d043e887d15acc445a1a/lib/appium_lib/device/device.rb#L7)
-> NoArgMethods = {
---
-##### [app_strings](https://github.com/appium/ruby_lib/blob/95d3a6535472559590c4d043e887d15acc445a1a/lib/appium_lib/device/device.rb#L25)
-> 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/95d3a6535472559590c4d043e887d15acc445a1a/lib/appium_lib/device/device.rb#L31)
-> 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/95d3a6535472559590c4d043e887d15acc445a1a/lib/appium_lib/device/device.rb#L36)
-> def current_activity
---
-##### [launch_app](https://github.com/appium/ruby_lib/blob/95d3a6535472559590c4d043e887d15acc445a1a/lib/appium_lib/device/device.rb#L38)
-> def launch_app
-Start the simulator and application configured with desired capabilities
---
-##### [reset](https://github.com/appium/ruby_lib/blob/95d3a6535472559590c4d043e887d15acc445a1a/lib/appium_lib/device/device.rb#L41)
-> def reset
-Reset the device, relaunching the application.
---
-##### [shake](https://github.com/appium/ruby_lib/blob/95d3a6535472559590c4d043e887d15acc445a1a/lib/appium_lib/device/device.rb#L44)
-> def shake
-Cause the device to shake
---
-##### [toggle_flight_mode](https://github.com/appium/ruby_lib/blob/95d3a6535472559590c4d043e887d15acc445a1a/lib/appium_lib/device/device.rb#L47)
-> def toggle_flight_mode
-Toggle flight mode on or off
---
-##### [device_locked?](https://github.com/appium/ruby_lib/blob/95d3a6535472559590c4d043e887d15acc445a1a/lib/appium_lib/device/device.rb#L50)
-> def device_locked?
---
-##### [hide_keyboard](https://github.com/appium/ruby_lib/blob/95d3a6535472559590c4d043e887d15acc445a1a/lib/appium_lib/device/device.rb#L52)
-> def hide_keyboard
-Hide the onscreen keyboard
-__Parameters:__
-&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/95d3a6535472559590c4d043e887d15acc445a1a/lib/appium_lib/device/device.rb#L61)
-> def press_keycode
-Press keycode on the device.
-http://developer.android.com/reference/android/view/KeyEvent.html
-__Parameters:__
-&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[integer] key - The key to press.
-&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/95d3a6535472559590c4d043e887d15acc445a1a/lib/appium_lib/device/device.rb#L67)
-> def long_press_keycode
-Long press keycode on the device.
-http://developer.android.com/reference/android/view/KeyEvent.html
-__Parameters:__
-&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[integer] key - The key to long press.
-&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/95d3a6535472559590c4d043e887d15acc445a1a/lib/appium_lib/device/device.rb#L73)
-> def push_file
-Place a file in a specific location on the device.
-__Parameters:__
-&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[String] path - The absolute path on the device to store data at.
-&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/95d3a6535472559590c4d043e887d15acc445a1a/lib/appium_lib/device/device.rb#L78)
-> 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).
-```ruby
-pull_file '/local/data/some/path' #=> Get the file at that path
-pull_file 'Shenanigans.app/some/file' #=> Get 'some/file' from the install location of Shenanigans.app
-```
-__Parameters:__
-&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/95d3a6535472559590c4d043e887d15acc445a1a/lib/appium_lib/device/device.rb#L88)
-> def pull_folder
-Retrieve a folder from the device.
-```ruby
-pull_folder '/data/local/tmp' #=> Get the folder at that path
-```
-__Parameters:__
-&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[String] path - absolute path to the folder
---
-##### [touch_id](https://github.com/appium/ruby_lib/blob/95d3a6535472559590c4d043e887d15acc445a1a/lib/appium_lib/device/device.rb#L96)
-> def touch_id
-iOS only;  Simulate Touch ID with either valid (match == true) or invalid (match == false) fingerprint.
-```ruby
-touch_id true #=> Simulate valid fingerprint
-touch_id false #=> Simulate invalid fingerprint
-```
-__Parameters:__
-&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Boolean] match - fingerprint validity
-Defaults to true.
---
-##### [end_coverage](https://github.com/appium/ruby_lib/blob/95d3a6535472559590c4d043e887d15acc445a1a/lib/appium_lib/device/device.rb#L105)
-> def end_coverage
-Android only;  Ends the test coverage and writes the results to the given path on device.
-__Parameters:__
-&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[String] path - Path on the device to write too.
-&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[String] intent - Intent to broadcast when ending coverage.
---
-##### [get_settings](https://github.com/appium/ruby_lib/blob/95d3a6535472559590c4d043e887d15acc445a1a/lib/appium_lib/device/device.rb#L110)
-> def get_settings
-Get appium Settings for current test session
---
-##### [extend_search_contexts](https://github.com/appium/ruby_lib/blob/95d3a6535472559590c4d043e887d15acc445a1a/lib/appium_lib/device/device.rb#L370)
-> def extend_search_contexts
---
-##### [find_element](https://github.com/appium/ruby_lib/blob/95d3a6535472559590c4d043e887d15acc445a1a/lib/appium_lib/device/device.rb#L370)
-> def find_element
---
-##### [find_elements](https://github.com/appium/ruby_lib/blob/95d3a6535472559590c4d043e887d15acc445a1a/lib/appium_lib/device/device.rb#L370)
-> def find_elements
-find_element/s with their accessibility_id
-```ruby
- find_elements :accessibility_id, 'Animation'
-```
---
-##### [add_touch_actions](https://github.com/appium/ruby_lib/blob/95d3a6535472559590c4d043e887d15acc445a1a/lib/appium_lib/device/device.rb#L376)
-> def add_touch_actions
---
-##### [set_context](https://github.com/appium/ruby_lib/blob/95d3a6535472559590c4d043e887d15acc445a1a/lib/appium_lib/device/device.rb#L400)
-> def set_context
-Change the context to the given context.
-```ruby
-set_context "NATIVE_APP"
-```
-__Parameters:__
-&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[String] The - context to change to
---
-##### [current_context](https://github.com/appium/ruby_lib/blob/95d3a6535472559590c4d043e887d15acc445a1a/lib/appium_lib/device/device.rb#L408)
-> def current_context
-__Returns:__
-&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[String] The context currently being used.
---
-##### [available_contexts](https://github.com/appium/ruby_lib/blob/95d3a6535472559590c4d043e887d15acc445a1a/lib/appium_lib/device/device.rb#L411)
-> def available_contexts
-__Returns:__
-&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Array<String>] All usable contexts, as an array of strings.
---
-##### [within_context](https://github.com/appium/ruby_lib/blob/95d3a6535472559590c4d043e887d15acc445a1a/lib/appium_lib/device/device.rb#L421)
-> def within_context(context)
-Perform a block within the given context, then switch back to the starting context.
-```ruby
-within_context('NATIVE_APP') do
-  find_element [:tag, "button"]
-```
-__Parameters:__
-&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/95d3a6535472559590c4d043e887d15acc445a1a/lib/appium_lib/device/device.rb#L429)
-> 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/95d3a6535472559590c4d043e887d15acc445a1a/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.
-```ruby
-action = pinch 75 #=> Pinch the screen from the top right and bottom left corners
-action.perform    #=> to 25% of its size.
-```
-__Parameters:__
-&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[int] percentage - The percent size by which to shrink the screen when pinched.
-&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[boolean] auto_perform - Whether to perform the action immediately (default true)
---
-##### [zoom](https://github.com/appium/ruby_lib/blob/95d3a6535472559590c4d043e887d15acc445a1a/lib/appium_lib/device/multi_touch.rb#L56)
-> 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.
-```ruby
-action = zoom 200 #=> Zoom in the screen from the center until it doubles in size.
-action.perform
-```
-__Parameters:__
-&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[int] percentage - The percent size by which to shrink the screen when pinched.
-&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[boolean] auto_perform - Whether to perform the action immediately (default true)
---
-##### [initialize](https://github.com/appium/ruby_lib/blob/95d3a6535472559590c4d043e887d15acc445a1a/lib/appium_lib/device/multi_touch.rb#L77)
-> 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/95d3a6535472559590c4d043e887d15acc445a1a/lib/appium_lib/device/multi_touch.rb#L83)
-> def add(chain)
-Add a touch_action to be performed
-__Parameters:__
-&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[TouchAction] chain - The action to add to the chain
---
-##### [perform](https://github.com/appium/ruby_lib/blob/95d3a6535472559590c4d043e887d15acc445a1a/lib/appium_lib/device/multi_touch.rb#L88)
-> def perform
-Ask Appium to perform the actions
---
-##### [ACTIONS](https://github.com/appium/ruby_lib/blob/95d3a6535472559590c4d043e887d15acc445a1a/lib/appium_lib/device/touch_actions.rb#L11)
-> ACTIONS         = [:move_to, :long_press, :double_tap, :two_finger_tap, :press, :release, :tap, :wait, :perform]
---
-##### [COMPLEX_ACTIONS](https://github.com/appium/ruby_lib/blob/95d3a6535472559590c4d043e887d15acc445a1a/lib/appium_lib/device/touch_actions.rb#L12)
-> COMPLEX_ACTIONS = [:swipe]
---
-##### [actions](https://github.com/appium/ruby_lib/blob/95d3a6535472559590c4d043e887d15acc445a1a/lib/appium_lib/device/touch_actions.rb#L26)
-> def actions
-Returns the value of attribute actions
---
-##### [initialize](https://github.com/appium/ruby_lib/blob/95d3a6535472559590c4d043e887d15acc445a1a/lib/appium_lib/device/touch_actions.rb#L28)
-> def initialize
-__Returns:__
-&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[TouchAction] a new instance of TouchAction
---
-##### [move_to](https://github.com/appium/ruby_lib/blob/95d3a6535472559590c4d043e887d15acc445a1a/lib/appium_lib/device/touch_actions.rb#L36)
-> def move_to(opts)
-Move to the given co-ordinates.
-__Parameters:__
-&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Hash] opts - a customizable set of options
---
-##### [long_press](https://github.com/appium/ruby_lib/blob/95d3a6535472559590c4d043e887d15acc445a1a/lib/appium_lib/device/touch_actions.rb#L46)
-> def long_press(opts)
-Press down for a specific duration.
-__Parameters:__
-&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Hash] element - a customizable set of options
-&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Hash] x - a customizable set of options
-&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Hash] y - a customizable set of options
-&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Hash] duration - a customizable set of options
---
-##### [press](https://github.com/appium/ruby_lib/blob/95d3a6535472559590c4d043e887d15acc445a1a/lib/appium_lib/device/touch_actions.rb#L58)
-> def press(opts)
-Press a finger onto the screen.  Finger will stay down until you call
-`release`.
-__Parameters:__
-&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Hash] opts - a customizable set of options
---
-##### [release](https://github.com/appium/ruby_lib/blob/95d3a6535472559590c4d043e887d15acc445a1a/lib/appium_lib/device/touch_actions.rb#L69)
-> def release(opts = nil)
-Remove a finger from the screen.
-__Parameters:__
-&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Hash] opts - a customizable set of options
---
-##### [tap](https://github.com/appium/ruby_lib/blob/95d3a6535472559590c4d043e887d15acc445a1a/lib/appium_lib/device/touch_actions.rb#L80)
-> def tap(opts)
-Touch a point on the screen
-__Parameters:__
-&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Hash] opts - a customizable set of options
---
-##### [double_tap](https://github.com/appium/ruby_lib/blob/95d3a6535472559590c4d043e887d15acc445a1a/lib/appium_lib/device/touch_actions.rb#L93)
-> def double_tap(opts)
-Double tap an element on the screen
-__Parameters:__
-&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Hash] opts - a customizable set of options
---
-##### [two_finger_tap](https://github.com/appium/ruby_lib/blob/95d3a6535472559590c4d043e887d15acc445a1a/lib/appium_lib/device/touch_actions.rb#L104)
-> def two_finger_tap(opts)
-Two finger tap an element on the screen
-__Parameters:__
-&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Hash] opts - a customizable set of options
---
-##### [wait](https://github.com/appium/ruby_lib/blob/95d3a6535472559590c4d043e887d15acc445a1a/lib/appium_lib/device/touch_actions.rb#L112)
-> def wait(milliseconds)
-Pause for a number of milliseconds before the next action
-__Parameters:__
-&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[integer] milliseconds - Number of milliseconds to pause for
---
-##### [swipe](https://github.com/appium/ruby_lib/blob/95d3a6535472559590c4d043e887d15acc445a1a/lib/appium_lib/device/touch_actions.rb#L127)
-> def swipe(opts)
-Convenience method to peform a swipe.
-Note that iOS 7 simulators have broken swipe.
-__Parameters:__
-&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Hash] opts - a customizable set of options
---
-##### [perform](https://github.com/appium/ruby_lib/blob/95d3a6535472559590c4d043e887d15acc445a1a/lib/appium_lib/device/touch_actions.rb#L155)
-> def perform
-Ask the driver to perform all actions in this action chain.
---
-##### [cancel](https://github.com/appium/ruby_lib/blob/95d3a6535472559590c4d043e887d15acc445a1a/lib/appium_lib/device/touch_actions.rb#L161)
-> def cancel
-Does nothing, currently.
---
-##### [chain_method](https://github.com/appium/ruby_lib/blob/95d3a6535472559590c4d043e887d15acc445a1a/lib/appium_lib/device/touch_actions.rb#L169)
-> def chain_method(method, args = nil)
---
-##### [args_with_ele_ref](https://github.com/appium/ruby_lib/blob/95d3a6535472559590c4d043e887d15acc445a1a/lib/appium_lib/device/touch_actions.rb#L178)
-> def args_with_ele_ref(args)
---
-##### [_generic_wait](https://github.com/appium/ruby_lib/blob/95d3a6535472559590c4d043e887d15acc445a1a/lib/appium_lib/common/wait.rb#L9)
-> def _generic_wait(opts = {}, &block)
-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/95d3a6535472559590c4d043e887d15acc445a1a/lib/appium_lib/common/wait.rb#L54)
-> def _process_wait_opts(opts)
-process opts before calling _generic_wait
---
-##### [wait_true](https://github.com/appium/ruby_lib/blob/95d3a6535472559590c4d043e887d15acc445a1a/lib/appium_lib/common/wait.rb#L75)
-> def wait_true(opts = {}, &block)
-Check every interval seconds to see if block.call returns a truthy value.
-Note this isn't a strict boolean true, any truthy value is accepted.
-false and nil are considered failures.
-Give up after timeout seconds.
-Wait code from the selenium Ruby gem
-https://github.com/SeleniumHQ/selenium/blob/cf501dda3f0ed12233de51ce8170c0e8090f0c20/rb/lib/selenium/webdriver/common/wait.rb
-If only a number is provided then it's treated as the timeout value.
-__Parameters:__
-&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Hash] opts - Options
---
-##### [wait](https://github.com/appium/ruby_lib/blob/95d3a6535472559590c4d043e887d15acc445a1a/lib/appium_lib/common/wait.rb#L93)
-> def wait(opts = {}, &block)
-Check every interval seconds to see if block.call doesn't raise an exception.
-Give up after timeout seconds.
-Wait code from the selenium Ruby gem
-https://github.com/SeleniumHQ/selenium/blob/cf501dda3f0ed12233de51ce8170c0e8090f0c20/rb/lib/selenium/webdriver/common/wait.rb
-If only a number is provided then it's treated as the timeout value.
-__Parameters:__
-&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Hash] opts - Options
---
-##### [ignore](https://github.com/appium/ruby_lib/blob/95d3a6535472559590c4d043e887d15acc445a1a/lib/appium_lib/common/helper.rb#L24)
-> def ignore(&block)
-Return block.call and ignore any exceptions.
---
-##### [back](https://github.com/appium/ruby_lib/blob/95d3a6535472559590c4d043e887d15acc445a1a/lib/appium_lib/common/helper.rb#L31)
-> def back
-Navigate back.
-__Returns:__
-&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[void]
---
-##### [session_id](https://github.com/appium/ruby_lib/blob/95d3a6535472559590c4d043e887d15acc445a1a/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/95d3a6535472559590c4d043e887d15acc445a1a/lib/appium_lib/common/helper.rb#L44)
-> def xpath(xpath_str)
-Returns the first element that matches the provided xpath.
-__Parameters:__
-&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[String] xpath_str - the XPath string
-__Returns:__
-&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Element]
---
-##### [xpaths](https://github.com/appium/ruby_lib/blob/95d3a6535472559590c4d043e887d15acc445a1a/lib/appium_lib/common/helper.rb#L52)
-> def xpaths(xpath_str)
-Returns all elements that match the provided xpath.
-__Parameters:__
-&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[String] xpath_str - the XPath string
-__Returns:__
-&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Array<Element>]
---
-##### [_print_source](https://github.com/appium/ruby_lib/blob/95d3a6535472559590c4d043e887d15acc445a1a/lib/appium_lib/common/helper.rb#L56)
-> def _print_source(source)
---
-##### [result](https://github.com/appium/ruby_lib/blob/95d3a6535472559590c4d043e887d15acc445a1a/lib/appium_lib/common/helper.rb#L69)
-> def result
-Returns the value of attribute result
---
-##### [initialize](https://github.com/appium/ruby_lib/blob/95d3a6535472559590c4d043e887d15acc445a1a/lib/appium_lib/common/helper.rb#L71)
-> def initialize
-__Returns:__
-&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[CountElements] a new instance of CountElements
---
-##### [reset](https://github.com/appium/ruby_lib/blob/95d3a6535472559590c4d043e887d15acc445a1a/lib/appium_lib/common/helper.rb#L75)
-> def reset
---
-##### [start_element](https://github.com/appium/ruby_lib/blob/95d3a6535472559590c4d043e887d15acc445a1a/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/95d3a6535472559590c4d043e887d15acc445a1a/lib/appium_lib/common/helper.rb#L86)
-> def formatted_result
---
-##### [get_page_class](https://github.com/appium/ruby_lib/blob/95d3a6535472559590c4d043e887d15acc445a1a/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/95d3a6535472559590c4d043e887d15acc445a1a/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/95d3a6535472559590c4d043e887d15acc445a1a/lib/appium_lib/common/helper.rb#L118)
-> def px_to_window_rel(opts = {})
-Converts pixel values to window relative values
-```ruby
-px_to_window_rel x: 50, y: 150
-```
---
-##### [xml_keys](https://github.com/appium/ruby_lib/blob/95d3a6535472559590c4d043e887d15acc445a1a/lib/appium_lib/common/helper.rb#L137)
-> def xml_keys(target)
-Search strings.xml's values for target.
-__Parameters:__
-&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[String] target - the target to search for in strings.xml values
-__Returns:__
-&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Array]
---
-##### [xml_values](https://github.com/appium/ruby_lib/blob/95d3a6535472559590c4d043e887d15acc445a1a/lib/appium_lib/common/helper.rb#L145)
-> def xml_values(target)
-Search strings.xml's keys for target.
-__Parameters:__
-&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[String] target - the target to search for in strings.xml keys
-__Returns:__
-&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Array]
---
-##### [resolve_id](https://github.com/appium/ruby_lib/blob/95d3a6535472559590c4d043e887d15acc445a1a/lib/appium_lib/common/helper.rb#L153)
-> def resolve_id(id)
-Resolve id in strings.xml and return the value.
-__Parameters:__
-&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[String] id - the id to resolve
-__Returns:__
-&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[String]
---
-##### [filter](https://github.com/appium/ruby_lib/blob/95d3a6535472559590c4d043e887d15acc445a1a/lib/appium_lib/common/helper.rb#L159)
-> def filter
-Returns the value of attribute filter
---
-##### [filter=](https://github.com/appium/ruby_lib/blob/95d3a6535472559590c4d043e887d15acc445a1a/lib/appium_lib/common/helper.rb#L162)
-> def filter=(value)
-convert to string to support symbols
---
-##### [initialize](https://github.com/appium/ruby_lib/blob/95d3a6535472559590c4d043e887d15acc445a1a/lib/appium_lib/common/helper.rb#L168)
-> def initialize
-__Returns:__
-&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[HTMLElements] a new instance of HTMLElements
---
-##### [reset](https://github.com/appium/ruby_lib/blob/95d3a6535472559590c4d043e887d15acc445a1a/lib/appium_lib/common/helper.rb#L173)
-> def reset
---
-##### [result](https://github.com/appium/ruby_lib/blob/95d3a6535472559590c4d043e887d15acc445a1a/lib/appium_lib/common/helper.rb#L179)
-> def result
---
-##### [start_element](https://github.com/appium/ruby_lib/blob/95d3a6535472559590c4d043e887d15acc445a1a/lib/appium_lib/common/helper.rb#L195)
-> def start_element(name, attrs = [])
---
-##### [end_element](https://github.com/appium/ruby_lib/blob/95d3a6535472559590c4d043e887d15acc445a1a/lib/appium_lib/common/helper.rb#L204)
-> def end_element(name)
---
-##### [characters](https://github.com/appium/ruby_lib/blob/95d3a6535472559590c4d043e887d15acc445a1a/lib/appium_lib/common/helper.rb#L210)
-> def characters(chars)
---
-##### [_no_such_element](https://github.com/appium/ruby_lib/blob/95d3a6535472559590c4d043e887d15acc445a1a/lib/appium_lib/common/helper.rb#L217)
-> def _no_such_element
---
-##### [window_size](https://github.com/appium/ruby_lib/blob/95d3a6535472559590c4d043e887d15acc445a1a/lib/appium_lib/common/element/window.rb#L5)
-> def window_size
-Get the window's size
---
-##### [result](https://github.com/appium/ruby_lib/blob/95d3a6535472559590c4d043e887d15acc445a1a/lib/appium_lib/android/helper.rb#L6) android
-> def result
-Returns the value of attribute result
---
-##### [keys](https://github.com/appium/ruby_lib/blob/95d3a6535472559590c4d043e887d15acc445a1a/lib/appium_lib/android/helper.rb#L6) android
-> def keys
-Returns the value of attribute keys
---
-##### [instance](https://github.com/appium/ruby_lib/blob/95d3a6535472559590c4d043e887d15acc445a1a/lib/appium_lib/android/helper.rb#L6) android
-> def instance
-Returns the value of attribute instance
---
-##### [filter](https://github.com/appium/ruby_lib/blob/95d3a6535472559590c4d043e887d15acc445a1a/lib/appium_lib/android/helper.rb#L6) android
-> def filter
-Returns the value of attribute filter
---
-##### [filter=](https://github.com/appium/ruby_lib/blob/95d3a6535472559590c4d043e887d15acc445a1a/lib/appium_lib/android/helper.rb#L9) android
-> def filter=(value)
-convert to string to support symbols
---
-##### [initialize](https://github.com/appium/ruby_lib/blob/95d3a6535472559590c4d043e887d15acc445a1a/lib/appium_lib/android/helper.rb#L15) android
-> def initialize
-__Returns:__
-&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[AndroidElements] a new instance of AndroidElements
---
-##### [reset](https://github.com/appium/ruby_lib/blob/95d3a6535472559590c4d043e887d15acc445a1a/lib/appium_lib/android/helper.rb#L21) android
-> def reset
---
-##### [start_element](https://github.com/appium/ruby_lib/blob/95d3a6535472559590c4d043e887d15acc445a1a/lib/appium_lib/android/helper.rb#L28) android
-> def start_element(name, attrs = [])
-http://nokogiri.org/Nokogiri/XML/SAX/Document.html
---
-##### [_fix_android_native_source](https://github.com/appium/ruby_lib/blob/95d3a6535472559590c4d043e887d15acc445a1a/lib/appium_lib/android/helper.rb#L88) android
-> def _fix_android_native_source(source)
-Fix uiautomator's xml dump.
-https://github.com/appium/appium/issues/2822
-https://code.google.com/p/android/issues/detail?id=74143
---
-##### [source](https://github.com/appium/ruby_lib/blob/95d3a6535472559590c4d043e887d15acc445a1a/lib/appium_lib/android/helper.rb#L116) android
-> def source
-Prints xml of the current page
-__Returns:__
-&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[void]
---
-##### [get_android_inspect](https://github.com/appium/ruby_lib/blob/95d3a6535472559590c4d043e887d15acc445a1a/lib/appium_lib/android/helper.rb#L126) android
-> def get_android_inspect(class_name = false)
-Android only.
-Returns a string containing interesting elements.
-The text, content description, and id are returned.
-if false (default) then all classes will be inspected
-__Parameters:__
-&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[String] class_name - the class name to filter on.
-__Returns:__
-&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[String]
---
-##### [page](https://github.com/appium/ruby_lib/blob/95d3a6535472559590c4d043e887d15acc445a1a/lib/appium_lib/android/helper.rb#L152) android
-> def page(opts = {})
-Intended for use with console.
-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:__
-&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Hash] class - a customizable set of options
-__Returns:__
-&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[void]
---
-##### [current_app](https://github.com/appium/ruby_lib/blob/95d3a6535472559590c4d043e887d15acc445a1a/lib/appium_lib/android/helper.rb#L164) android
-> def current_app
-example line:
-"mFocusedApp=AppWindowToken{b1420058 token=Token{b128add0
- ActivityRecord{b1264d10 u0 com.example.android.apis/.ApiDemos t23}}}"
---
-##### [id](https://github.com/appium/ruby_lib/blob/95d3a6535472559590c4d043e887d15acc445a1a/lib/appium_lib/android/helper.rb#L188) android
-> def id(id)
-Find the first matching element by id
-__Parameters:__
-&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[String] id - the id to search for
-__Returns:__
-&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Element]
---
-##### [ids](https://github.com/appium/ruby_lib/blob/95d3a6535472559590c4d043e887d15acc445a1a/lib/appium_lib/android/helper.rb#L196) android
-> def ids(id)
-Find all matching elements by id
-__Parameters:__
-&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[String] id - the id to search for
-__Returns:__
-&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Element]
---
-##### [ele_index](https://github.com/appium/ruby_lib/blob/95d3a6535472559590c4d043e887d15acc445a1a/lib/appium_lib/android/helper.rb#L205) android
-> def ele_index(class_name, index)
-Find the element of type class_name at matching index.
-__Parameters:__
-&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[String] class_name - the class name to find
-&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Integer] index - the index
-__Returns:__
-&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Element] the found element of type class_name
---
-##### [first_ele](https://github.com/appium/ruby_lib/blob/95d3a6535472559590c4d043e887d15acc445a1a/lib/appium_lib/android/helper.rb#L223) android
-> def first_ele(class_name)
-Find the first element that matches class_name
-__Parameters:__
-&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[String] class_name - the tag to match
-__Returns:__
-&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Element]
---
-##### [last_ele](https://github.com/appium/ruby_lib/blob/95d3a6535472559590c4d043e887d15acc445a1a/lib/appium_lib/android/helper.rb#L230) android
-> def last_ele(class_name)
-Find the last element that matches class_name
-__Parameters:__
-&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[String] class_name - the tag to match
-__Returns:__
-&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Element]
---
-##### [tag](https://github.com/appium/ruby_lib/blob/95d3a6535472559590c4d043e887d15acc445a1a/lib/appium_lib/android/helper.rb#L238) android
-> def tag(class_name)
-Find the first element of type class_name
-__Parameters:__
-&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[String] class_name - the class_name to search for
-__Returns:__
-&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Element]
---
-##### [tags](https://github.com/appium/ruby_lib/blob/95d3a6535472559590c4d043e887d15acc445a1a/lib/appium_lib/android/helper.rb#L246) android
-> def tags(class_name)
-Find all elements of type class_name
-__Parameters:__
-&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[String] class_name - the class_name to search for
-__Returns:__
-&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Element]
---
-##### [string_visible_contains](https://github.com/appium/ruby_lib/blob/95d3a6535472559590c4d043e887d15acc445a1a/lib/appium_lib/android/helper.rb#L288) android
-> def string_visible_contains(class_name, value)
-Returns a string that matches the first element that contains value
-example: complex_find_contains 'UIATextField', 'sign in'
-__Parameters:__
-&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[String] class_name - the class name for the element
-&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[String] value - the value to search for
-__Returns:__
-&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[String]
---
-##### [complex_find_contains](https://github.com/appium/ruby_lib/blob/95d3a6535472559590c4d043e887d15acc445a1a/lib/appium_lib/android/helper.rb#L308) android
-> def complex_find_contains(element, value)
-Find the first element that contains value
-__Parameters:__
-&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[String] element - the class name for the element
-&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[String] value - the value to search for
-__Returns:__
-&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Element]
---
-##### [complex_finds_contains](https://github.com/appium/ruby_lib/blob/95d3a6535472559590c4d043e887d15acc445a1a/lib/appium_lib/android/helper.rb#L316) android
-> def complex_finds_contains(element, value)
-Find all elements containing value
-__Parameters:__
-&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[String] element - the class name for the element
-&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[String] value - the value to search for
-__Returns:__
-&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Array<Element>]
---
-##### [complex_find_exact](https://github.com/appium/ruby_lib/blob/95d3a6535472559590c4d043e887d15acc445a1a/lib/appium_lib/android/helper.rb#L345) android
-> def complex_find_exact(class_name, value)
-Find the first element exactly matching value
-__Parameters:__
-&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[String] class_name - the class name for the element
-&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[String] value - the value to search for
-__Returns:__
-&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Element]
---
-##### [complex_finds_exact](https://github.com/appium/ruby_lib/blob/95d3a6535472559590c4d043e887d15acc445a1a/lib/appium_lib/android/helper.rb#L353) android
-> def complex_finds_exact(class_name, value)
-Find all elements exactly matching value
-__Parameters:__
-&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[String] class_name - the class name for the element
-&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[String] value - the value to search for
-__Returns:__
-&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Element]
---
-##### [get_source](https://github.com/appium/ruby_lib/blob/95d3a6535472559590c4d043e887d15acc445a1a/lib/appium_lib/android/helper.rb#L361) android
-> def get_source
-Returns XML string for the current page
-Fixes uiautomator's $ in node names.
-`android.app.ActionBar$Tab` becomes `android.app.ActionBar.Tab`
-__Returns:__
-&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[String]
---
-##### [TextView](https://github.com/appium/ruby_lib/blob/95d3a6535472559590c4d043e887d15acc445a1a/lib/appium_lib/android/element/text.rb#L4) android
-> TextView = 'android.widget.TextView'
---
-##### [text](https://github.com/appium/ruby_lib/blob/95d3a6535472559590c4d043e887d15acc445a1a/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:__
-&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[String, Integer] value - the value to find.
-__Returns:__
-&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[TextView]
---
-##### [texts](https://github.com/appium/ruby_lib/blob/95d3a6535472559590c4d043e887d15acc445a1a/lib/appium_lib/android/element/text.rb#L19) android
-> def texts(value = false)
-Find all TextViews containing value.
-If value is omitted, all texts are returned.
-__Parameters:__
-&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[String] value - the value to search for
-__Returns:__
-&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Array<TextView>]
---
-##### [first_text](https://github.com/appium/ruby_lib/blob/95d3a6535472559590c4d043e887d15acc445a1a/lib/appium_lib/android/element/text.rb#L26) android
-> def first_text
-Find the first TextView.
-__Returns:__
-&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[TextView]
---
-##### [last_text](https://github.com/appium/ruby_lib/blob/95d3a6535472559590c4d043e887d15acc445a1a/lib/appium_lib/android/element/text.rb#L32) android
-> def last_text
-Find the last TextView.
-__Returns:__
-&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[TextView]
---
-##### [text_exact](https://github.com/appium/ruby_lib/blob/95d3a6535472559590c4d043e887d15acc445a1a/lib/appium_lib/android/element/text.rb#L39) android
-> def text_exact(value)
-Find the first TextView that exactly matches value.
-__Parameters:__
-&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[String] value - the value to match exactly
-__Returns:__
-&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[TextView]
---
-##### [texts_exact](https://github.com/appium/ruby_lib/blob/95d3a6535472559590c4d043e887d15acc445a1a/lib/appium_lib/android/element/text.rb#L46) android
-> def texts_exact(value)
-Find all TextViews that exactly match value.
-__Parameters:__
-&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[String] value - the value to match exactly
-__Returns:__
-&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Array<TextView>]
---
-##### [_nodeset_to_uiselector](https://github.com/appium/ruby_lib/blob/95d3a6535472559590c4d043e887d15acc445a1a/lib/appium_lib/android/client_xpath.rb#L5) android
-> def _nodeset_to_uiselector(opts = {})
---
-##### [_client_xpath](https://github.com/appium/ruby_lib/blob/95d3a6535472559590c4d043e887d15acc445a1a/lib/appium_lib/android/client_xpath.rb#L20) android
-> def _client_xpath(opts = {})
---
-##### [client_xpath](https://github.com/appium/ruby_lib/blob/95d3a6535472559590c4d043e887d15acc445a1a/lib/appium_lib/android/client_xpath.rb#L36) android
-> def client_xpath(xpath)
---
-##### [client_xpaths](https://github.com/appium/ruby_lib/blob/95d3a6535472559590c4d043e887d15acc445a1a/lib/appium_lib/android/client_xpath.rb#L40) android
-> def client_xpaths(xpath)
---
-##### [alert_click](https://github.com/appium/ruby_lib/blob/95d3a6535472559590c4d043e887d15acc445a1a/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:__
-&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Integer, String] value - either an integer index of the button or the button's name
-__Returns:__
-&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[void]
---
-##### [alert_accept](https://github.com/appium/ruby_lib/blob/95d3a6535472559590c4d043e887d15acc445a1a/lib/appium_lib/android/element/alert.rb#L13) android
-> def alert_accept
-Accept the alert.
-The last button is considered "accept."
-__Returns:__
-&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[void]
---
-##### [alert_accept_text](https://github.com/appium/ruby_lib/blob/95d3a6535472559590c4d043e887d15acc445a1a/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:__
-&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[String]
---
-##### [alert_dismiss](https://github.com/appium/ruby_lib/blob/95d3a6535472559590c4d043e887d15acc445a1a/lib/appium_lib/android/element/alert.rb#L27) android
-> def alert_dismiss
-Dismiss the alert.
-The first button is considered "dismiss."
-__Returns:__
-&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[void]
---
-##### [alert_dismiss_text](https://github.com/appium/ruby_lib/blob/95d3a6535472559590c4d043e887d15acc445a1a/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:__
-&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[String]
---
-##### [Button](https://github.com/appium/ruby_lib/blob/95d3a6535472559590c4d043e887d15acc445a1a/lib/appium_lib/android/element/button.rb#L4) android
-> Button      = 'android.widget.Button'
---
-##### [ImageButton](https://github.com/appium/ruby_lib/blob/95d3a6535472559590c4d043e887d15acc445a1a/lib/appium_lib/android/element/button.rb#L5) android
-> ImageButton = 'android.widget.ImageButton'
---
-##### [button](https://github.com/appium/ruby_lib/blob/95d3a6535472559590c4d043e887d15acc445a1a/lib/appium_lib/android/element/button.rb#L43) 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:__
-&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[String, Integer] value - the value to exactly match.
-__Returns:__
-&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Button]
---
-##### [buttons](https://github.com/appium/ruby_lib/blob/95d3a6535472559590c4d043e887d15acc445a1a/lib/appium_lib/android/element/button.rb#L60) android
-> def buttons(value = false)
-Find all buttons containing value.
-If value is omitted, all buttons are returned.
-__Parameters:__
-&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[String] value - the value to search for
-__Returns:__
-&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Array<Button>]
---
-##### [first_button](https://github.com/appium/ruby_lib/blob/95d3a6535472559590c4d043e887d15acc445a1a/lib/appium_lib/android/element/button.rb#L67) android
-> def first_button
-Find the first button.
-__Returns:__
-&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Button]
---
-##### [last_button](https://github.com/appium/ruby_lib/blob/95d3a6535472559590c4d043e887d15acc445a1a/lib/appium_lib/android/element/button.rb#L73) android
-> def last_button
-Find the last button.
-__Returns:__
-&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Button]
---
-##### [button_exact](https://github.com/appium/ruby_lib/blob/95d3a6535472559590c4d043e887d15acc445a1a/lib/appium_lib/android/element/button.rb#L89) android
-> def button_exact(value)
-Find the first button that exactly matches value.
-__Parameters:__
-&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[String] value - the value to match exactly
-__Returns:__
-&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Button]
---
-##### [buttons_exact](https://github.com/appium/ruby_lib/blob/95d3a6535472559590c4d043e887d15acc445a1a/lib/appium_lib/android/element/button.rb#L96) android
-> def buttons_exact(value)
-Find all buttons that exactly match value.
-__Parameters:__
-&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[String] value - the value to match exactly
-__Returns:__
-&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Array<Button>]
---
-##### [uiautomator_find](https://github.com/appium/ruby_lib/blob/95d3a6535472559590c4d043e887d15acc445a1a/lib/appium_lib/android/mobile_methods.rb#L10) android
-> def uiautomator_find
-find_element/s can be used with a [UISelector](http://developer.android.com/tools/help/uiautomator/UiSelector.html).
-```ruby
- find_elements :uiautomator, 'new UiSelector().clickable(true)'
-```
---
-##### [find](https://github.com/appium/ruby_lib/blob/95d3a6535472559590c4d043e887d15acc445a1a/lib/appium_lib/android/element/generic.rb#L6) android
-> def find(value)
-Find the first element containing value
-__Parameters:__
-&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[String] value - the value to search for
-__Returns:__
-&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Element]
---
-##### [finds](https://github.com/appium/ruby_lib/blob/95d3a6535472559590c4d043e887d15acc445a1a/lib/appium_lib/android/element/generic.rb#L13) android
-> def finds(value)
-Find all elements containing value
-__Parameters:__
-&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[String] value - the value to search for
-__Returns:__
-&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Array<Element>]
---
-##### [find_exact](https://github.com/appium/ruby_lib/blob/95d3a6535472559590c4d043e887d15acc445a1a/lib/appium_lib/android/element/generic.rb#L20) android
-> def find_exact(value)
-Find the first element exactly matching value
-__Parameters:__
-&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[String] value - the value to search for
-__Returns:__
-&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Element]
---
-##### [finds_exact](https://github.com/appium/ruby_lib/blob/95d3a6535472559590c4d043e887d15acc445a1a/lib/appium_lib/android/element/generic.rb#L27) android
-> def finds_exact(value)
-Find all elements exactly matching value
-__Parameters:__
-&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[String] value - the value to search for
-__Returns:__
-&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Array<Element>]
---
-##### [scroll_to](https://github.com/appium/ruby_lib/blob/95d3a6535472559590c4d043e887d15acc445a1a/lib/appium_lib/android/element/generic.rb#L39) android
-> def scroll_to(text)
-Scroll to the first element containing target text or description.
-__Parameters:__
-&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[String] text - the text to search for in the text value and content description
-__Returns:__
-&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Element] the element scrolled to
---
-##### [scroll_to_exact](https://github.com/appium/ruby_lib/blob/95d3a6535472559590c4d043e887d15acc445a1a/lib/appium_lib/android/element/generic.rb#L51) android
-> def scroll_to_exact(text)
-Scroll to the first element with the exact target text or description.
-__Parameters:__
-&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[String] text - the text to search for in the text value and content description
-__Returns:__
-&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Element] the element scrolled to
---
-##### [EditText](https://github.com/appium/ruby_lib/blob/95d3a6535472559590c4d043e887d15acc445a1a/lib/appium_lib/android/element/textfield.rb#L3) android
-> EditText = 'android.widget.EditText'
---
-##### [textfield](https://github.com/appium/ruby_lib/blob/95d3a6535472559590c4d043e887d15acc445a1a/lib/appium_lib/android/element/textfield.rb#L9) android
-> def textfield(value)
-Find the first EditText that contains value or by index.
-If int then the EditText at that index is returned.
-__Parameters:__
-&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[String, Integer] value - the text to match exactly.
-__Returns:__
-&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[EditText]
---
-##### [textfields](https://github.com/appium/ruby_lib/blob/95d3a6535472559590c4d043e887d15acc445a1a/lib/appium_lib/android/element/textfield.rb#L18) android
-> def textfields(value = false)
-Find all EditTexts containing value.
-If value is omitted, all EditTexts are returned.
-__Parameters:__
-&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[String] value - the value to search for
-__Returns:__
-&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Array<EditText>]
---
-##### [first_textfield](https://github.com/appium/ruby_lib/blob/95d3a6535472559590c4d043e887d15acc445a1a/lib/appium_lib/android/element/textfield.rb#L25) android
-> def first_textfield
-Find the first EditText.
-__Returns:__
-&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[EditText]
---
-##### [last_textfield](https://github.com/appium/ruby_lib/blob/95d3a6535472559590c4d043e887d15acc445a1a/lib/appium_lib/android/element/textfield.rb#L31) android
-> def last_textfield
-Find the last EditText.
-__Returns:__
-&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[EditText]
---
-##### [textfield_exact](https://github.com/appium/ruby_lib/blob/95d3a6535472559590c4d043e887d15acc445a1a/lib/appium_lib/android/element/textfield.rb#L38) android
-> def textfield_exact(value)
-Find the first EditText that exactly matches value.
-__Parameters:__
-&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[String] value - the value to match exactly
-__Returns:__
-&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[EditText]
---
-##### [textfields_exact](https://github.com/appium/ruby_lib/blob/95d3a6535472559590c4d043e887d15acc445a1a/lib/appium_lib/android/element/textfield.rb#L45) android
-> def textfields_exact(value)
-Find all EditTexts that exactly match value.
-__Parameters:__
-&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[String] value - the value to match exactly
-__Returns:__
-&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Array<EditText>]
---
-##### [value](https://github.com/appium/ruby_lib/blob/95d3a6535472559590c4d043e887d15acc445a1a/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/95d3a6535472559590c4d043e887d15acc445a1a/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/95d3a6535472559590c4d043e887d15acc445a1a/lib/appium_lib/common/patch.rb#L31)
-> def location_rel
-For use with mobile tap.
-```ruby
-execute_script 'mobile: tap', :x => 0.0, :y => 0.98
-```
-https://github.com/appium/appium/wiki/Automating-mobile-gestures
-__Returns:__
-&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[OpenStruct] the relative x, y in a struct. ex: { x: 0.50, y: 0.20 }
---
-##### [DEFAULT_HEADERS](https://github.com/appium/ruby_lib/blob/95d3a6535472559590c4d043e887d15acc445a1a/lib/appium_lib/common/patch.rb#L147)
-> DEFAULT_HEADERS = { 'Accept' => CONTENT_TYPE, 'User-Agent' => "appium/ruby_lib/#{::Appium::VERSION}" }
+&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[hash] the symbolized hash with updated :app and :require keys
 --