docs/android_docs.md in appium_lib-4.1.0 vs docs/android_docs.md in appium_lib-5.0.0

- old
+ new

@@ -1,6 +1,6 @@ -##### [load_appium_txt](https://github.com/appium/ruby_lib/blob/a13158fb926212d84f26120c3bc5355c8cd34baf/lib/appium_lib/driver.rb#L72) +##### [load_appium_txt](https://github.com/appium/ruby_lib/blob/7c3bc19905d0f008192a59dc7f5a938e3701ec8f/lib/appium_lib/driver.rb#L72) > def self.load_appium_txt opts={} Load appium.txt (toml format) the basedir of this file + appium.txt is what's used @@ -25,32 +25,32 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[hash] the symbolized hash with updated :app and :require keys -- -##### [symbolize_keys](https://github.com/appium/ruby_lib/blob/a13158fb926212d84f26120c3bc5355c8cd34baf/lib/appium_lib/driver.rb#L142) +##### [symbolize_keys](https://github.com/appium/ruby_lib/blob/7c3bc19905d0f008192a59dc7f5a938e3701ec8f/lib/appium_lib/driver.rb#L142) > def self.symbolize_keys hash convert all keys (including nested) to symbols based on deep_symbolize_keys & deep_transform_keys from rails https://github.com/rails/docrails/blob/a3b1105ada3da64acfa3843b164b14b734456a50/activesupport/lib/active_support/core_ext/hash/keys.rb#L84 -- -##### [promote_singleton_appium_methods](https://github.com/appium/ruby_lib/blob/a13158fb926212d84f26120c3bc5355c8cd34baf/lib/appium_lib/driver.rb#L155) +##### [promote_singleton_appium_methods](https://github.com/appium/ruby_lib/blob/7c3bc19905d0f008192a59dc7f5a938e3701ec8f/lib/appium_lib/driver.rb#L155) > def self.promote_singleton_appium_methods modules 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/a13158fb926212d84f26120c3bc5355c8cd34baf/lib/appium_lib/driver.rb#L195) +##### [promote_appium_methods](https://github.com/appium/ruby_lib/blob/7c3bc19905d0f008192a59dc7f5a938e3701ec8f/lib/appium_lib/driver.rb#L195) > def self.promote_appium_methods class_array Promote appium methods to class instance methods @@ -64,75 +64,75 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Array<Class>] class_array - An array of classes -- -##### [global_webdriver_http_sleep](https://github.com/appium/ruby_lib/blob/a13158fb926212d84f26120c3bc5355c8cd34baf/lib/appium_lib/driver.rb#L228) +##### [global_webdriver_http_sleep](https://github.com/appium/ruby_lib/blob/7c3bc19905d0f008192a59dc7f5a938e3701ec8f/lib/appium_lib/driver.rb#L231) > 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/a13158fb926212d84f26120c3bc5355c8cd34baf/lib/appium_lib/driver.rb#L228) +##### [global_webdriver_http_sleep=](https://github.com/appium/ruby_lib/blob/7c3bc19905d0f008192a59dc7f5a938e3701ec8f/lib/appium_lib/driver.rb#L231) > 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/a13158fb926212d84f26120c3bc5355c8cd34baf/lib/appium_lib/driver.rb#L228) +##### [caps](https://github.com/appium/ruby_lib/blob/7c3bc19905d0f008192a59dc7f5a938e3701ec8f/lib/appium_lib/driver.rb#L233) > def caps -The amount to sleep in seconds before every webdriver http call. +Selenium webdriver capabilities -- -##### [caps=](https://github.com/appium/ruby_lib/blob/a13158fb926212d84f26120c3bc5355c8cd34baf/lib/appium_lib/driver.rb#L228) +##### [caps=](https://github.com/appium/ruby_lib/blob/7c3bc19905d0f008192a59dc7f5a938e3701ec8f/lib/appium_lib/driver.rb#L233) > def caps=(value) -The amount to sleep in seconds before every webdriver http call. +Selenium webdriver capabilities -- -##### [custom_url](https://github.com/appium/ruby_lib/blob/a13158fb926212d84f26120c3bc5355c8cd34baf/lib/appium_lib/driver.rb#L228) +##### [custom_url](https://github.com/appium/ruby_lib/blob/7c3bc19905d0f008192a59dc7f5a938e3701ec8f/lib/appium_lib/driver.rb#L235) > def custom_url -The amount to sleep in seconds before every webdriver http call. +Custom URL for the selenium server -- -##### [custom_url=](https://github.com/appium/ruby_lib/blob/a13158fb926212d84f26120c3bc5355c8cd34baf/lib/appium_lib/driver.rb#L228) +##### [custom_url=](https://github.com/appium/ruby_lib/blob/7c3bc19905d0f008192a59dc7f5a938e3701ec8f/lib/appium_lib/driver.rb#L235) > def custom_url=(value) -The amount to sleep in seconds before every webdriver http call. +Custom URL for the selenium server -- -##### [export_session](https://github.com/appium/ruby_lib/blob/a13158fb926212d84f26120c3bc5355c8cd34baf/lib/appium_lib/driver.rb#L228) +##### [export_session](https://github.com/appium/ruby_lib/blob/7c3bc19905d0f008192a59dc7f5a938e3701ec8f/lib/appium_lib/driver.rb#L237) > def export_session -The amount to sleep in seconds before every webdriver http call. +Export session id to textfile in /tmp for 3rd party tools -- -##### [export_session=](https://github.com/appium/ruby_lib/blob/a13158fb926212d84f26120c3bc5355c8cd34baf/lib/appium_lib/driver.rb#L228) +##### [export_session=](https://github.com/appium/ruby_lib/blob/7c3bc19905d0f008192a59dc7f5a938e3701ec8f/lib/appium_lib/driver.rb#L237) > def export_session=(value) -The amount to sleep in seconds before every webdriver http call. +Export session id to textfile in /tmp for 3rd party tools -- -##### [default_wait](https://github.com/appium/ruby_lib/blob/a13158fb926212d84f26120c3bc5355c8cd34baf/lib/appium_lib/driver.rb#L228) +##### [default_wait](https://github.com/appium/ruby_lib/blob/7c3bc19905d0f008192a59dc7f5a938e3701ec8f/lib/appium_lib/driver.rb#L239) > def default_wait Returns the default client side wait. This value is independent of what the server is using @@ -141,115 +141,115 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Integer] -- -##### [default_wait=](https://github.com/appium/ruby_lib/blob/a13158fb926212d84f26120c3bc5355c8cd34baf/lib/appium_lib/driver.rb#L228) +##### [default_wait=](https://github.com/appium/ruby_lib/blob/7c3bc19905d0f008192a59dc7f5a938e3701ec8f/lib/appium_lib/driver.rb#L239) > def default_wait=(value) -The amount to sleep in seconds before every webdriver http call. +Default wait time for elements to appear -- -##### [last_waits](https://github.com/appium/ruby_lib/blob/a13158fb926212d84f26120c3bc5355c8cd34baf/lib/appium_lib/driver.rb#L228) +##### [last_waits](https://github.com/appium/ruby_lib/blob/7c3bc19905d0f008192a59dc7f5a938e3701ec8f/lib/appium_lib/driver.rb#L241) > def last_waits -The amount to sleep in seconds before every webdriver http call. +Array of previous wait time values -- -##### [last_waits=](https://github.com/appium/ruby_lib/blob/a13158fb926212d84f26120c3bc5355c8cd34baf/lib/appium_lib/driver.rb#L228) +##### [last_waits=](https://github.com/appium/ruby_lib/blob/7c3bc19905d0f008192a59dc7f5a938e3701ec8f/lib/appium_lib/driver.rb#L241) > def last_waits=(value) -The amount to sleep in seconds before every webdriver http call. +Array of previous wait time values -- -##### [sauce_username](https://github.com/appium/ruby_lib/blob/a13158fb926212d84f26120c3bc5355c8cd34baf/lib/appium_lib/driver.rb#L228) +##### [sauce_username](https://github.com/appium/ruby_lib/blob/7c3bc19905d0f008192a59dc7f5a938e3701ec8f/lib/appium_lib/driver.rb#L243) > def sauce_username -The amount to sleep in seconds before every webdriver http call. +Username for use on Sauce Labs -- -##### [sauce_username=](https://github.com/appium/ruby_lib/blob/a13158fb926212d84f26120c3bc5355c8cd34baf/lib/appium_lib/driver.rb#L228) +##### [sauce_username=](https://github.com/appium/ruby_lib/blob/7c3bc19905d0f008192a59dc7f5a938e3701ec8f/lib/appium_lib/driver.rb#L243) > def sauce_username=(value) -The amount to sleep in seconds before every webdriver http call. +Username for use on Sauce Labs -- -##### [sauce_access_key](https://github.com/appium/ruby_lib/blob/a13158fb926212d84f26120c3bc5355c8cd34baf/lib/appium_lib/driver.rb#L228) +##### [sauce_access_key](https://github.com/appium/ruby_lib/blob/7c3bc19905d0f008192a59dc7f5a938e3701ec8f/lib/appium_lib/driver.rb#L245) > def sauce_access_key -The amount to sleep in seconds before every webdriver http call. +Access Key for use on Sauce Labs -- -##### [sauce_access_key=](https://github.com/appium/ruby_lib/blob/a13158fb926212d84f26120c3bc5355c8cd34baf/lib/appium_lib/driver.rb#L228) +##### [sauce_access_key=](https://github.com/appium/ruby_lib/blob/7c3bc19905d0f008192a59dc7f5a938e3701ec8f/lib/appium_lib/driver.rb#L245) > def sauce_access_key=(value) -The amount to sleep in seconds before every webdriver http call. +Access Key for use on Sauce Labs -- -##### [appium_port](https://github.com/appium/ruby_lib/blob/a13158fb926212d84f26120c3bc5355c8cd34baf/lib/appium_lib/driver.rb#L228) +##### [appium_port](https://github.com/appium/ruby_lib/blob/7c3bc19905d0f008192a59dc7f5a938e3701ec8f/lib/appium_lib/driver.rb#L247) > def appium_port -The amount to sleep in seconds before every webdriver http call. +Appium's server port -- -##### [appium_port=](https://github.com/appium/ruby_lib/blob/a13158fb926212d84f26120c3bc5355c8cd34baf/lib/appium_lib/driver.rb#L228) +##### [appium_port=](https://github.com/appium/ruby_lib/blob/7c3bc19905d0f008192a59dc7f5a938e3701ec8f/lib/appium_lib/driver.rb#L247) > def appium_port=(value) -The amount to sleep in seconds before every webdriver http call. +Appium's server port -- -##### [appium_device](https://github.com/appium/ruby_lib/blob/a13158fb926212d84f26120c3bc5355c8cd34baf/lib/appium_lib/driver.rb#L228) +##### [appium_device](https://github.com/appium/ruby_lib/blob/7c3bc19905d0f008192a59dc7f5a938e3701ec8f/lib/appium_lib/driver.rb#L249) > def appium_device -The amount to sleep in seconds before every webdriver http call. +Device type to request from the appium server -- -##### [appium_device=](https://github.com/appium/ruby_lib/blob/a13158fb926212d84f26120c3bc5355c8cd34baf/lib/appium_lib/driver.rb#L228) +##### [appium_device=](https://github.com/appium/ruby_lib/blob/7c3bc19905d0f008192a59dc7f5a938e3701ec8f/lib/appium_lib/driver.rb#L249) > def appium_device=(value) -The amount to sleep in seconds before every webdriver http call. +Device type to request from the appium server -- -##### [appium_debug](https://github.com/appium/ruby_lib/blob/a13158fb926212d84f26120c3bc5355c8cd34baf/lib/appium_lib/driver.rb#L228) +##### [appium_debug](https://github.com/appium/ruby_lib/blob/7c3bc19905d0f008192a59dc7f5a938e3701ec8f/lib/appium_lib/driver.rb#L251) > def appium_debug -The amount to sleep in seconds before every webdriver http call. +Boolean debug mode for the Appium Ruby bindings -- -##### [appium_debug=](https://github.com/appium/ruby_lib/blob/a13158fb926212d84f26120c3bc5355c8cd34baf/lib/appium_lib/driver.rb#L228) +##### [appium_debug=](https://github.com/appium/ruby_lib/blob/7c3bc19905d0f008192a59dc7f5a938e3701ec8f/lib/appium_lib/driver.rb#L251) > def appium_debug=(value) -The amount to sleep in seconds before every webdriver http call. +Boolean debug mode for the Appium Ruby bindings -- -##### [initialize](https://github.com/appium/ruby_lib/blob/a13158fb926212d84f26120c3bc5355c8cd34baf/lib/appium_lib/driver.rb#L259) +##### [initialize](https://github.com/appium/ruby_lib/blob/7c3bc19905d0f008192a59dc7f5a938e3701ec8f/lib/appium_lib/driver.rb#L272) > def initialize opts={} Creates a new driver @@ -276,19 +276,19 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Driver] -- -##### [driver_attributes](https://github.com/appium/ruby_lib/blob/a13158fb926212d84f26120c3bc5355c8cd34baf/lib/appium_lib/driver.rb#L334) +##### [driver_attributes](https://github.com/appium/ruby_lib/blob/7c3bc19905d0f008192a59dc7f5a938e3701ec8f/lib/appium_lib/driver.rb#L347) > def driver_attributes Returns a hash of the driver attributes -- -##### [device_is_android?](https://github.com/appium/ruby_lib/blob/a13158fb926212d84f26120c3bc5355c8cd34baf/lib/appium_lib/driver.rb#L354) +##### [device_is_android?](https://github.com/appium/ruby_lib/blob/7c3bc19905d0f008192a59dc7f5a938e3701ec8f/lib/appium_lib/driver.rb#L367) > def device_is_android? @@ -296,11 +296,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Boolean] -- -##### [appium_server_version](https://github.com/appium/ruby_lib/blob/a13158fb926212d84f26120c3bc5355c8cd34baf/lib/appium_lib/driver.rb#L370) +##### [appium_server_version](https://github.com/appium/ruby_lib/blob/7c3bc19905d0f008192a59dc7f5a938e3701ec8f/lib/appium_lib/driver.rb#L383) > def appium_server_version Returns the server's version info @@ -317,11 +317,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Hash] -- -##### [absolute_app_path](https://github.com/appium/ruby_lib/blob/a13158fb926212d84f26120c3bc5355c8cd34baf/lib/appium_lib/driver.rb#L382) +##### [absolute_app_path](https://github.com/appium/ruby_lib/blob/7c3bc19905d0f008192a59dc7f5a938e3701ec8f/lib/appium_lib/driver.rb#L395) > def self.absolute_app_path opts Converts app_path to an absolute path. @@ -334,11 +334,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[String] APP_PATH as an absolute path -- -##### [server_url](https://github.com/appium/ruby_lib/blob/a13158fb926212d84f26120c3bc5355c8cd34baf/lib/appium_lib/driver.rb#L415) +##### [server_url](https://github.com/appium/ruby_lib/blob/7c3bc19905d0f008192a59dc7f5a938e3701ec8f/lib/appium_lib/driver.rb#L428) > def server_url Get the server url @@ -346,11 +346,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[String] the server url -- -##### [restart](https://github.com/appium/ruby_lib/blob/a13158fb926212d84f26120c3bc5355c8cd34baf/lib/appium_lib/driver.rb#L426) +##### [restart](https://github.com/appium/ruby_lib/blob/7c3bc19905d0f008192a59dc7f5a938e3701ec8f/lib/appium_lib/driver.rb#L439) > def restart Restarts the driver @@ -358,11 +358,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Driver] the driver -- -##### [driver](https://github.com/appium/ruby_lib/blob/a13158fb926212d84f26120c3bc5355c8cd34baf/lib/appium_lib/driver.rb#L433) +##### [driver](https://github.com/appium/ruby_lib/blob/7c3bc19905d0f008192a59dc7f5a938e3701ec8f/lib/appium_lib/driver.rb#L446) > def driver Returns the driver @@ -370,11 +370,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Driver] the driver -- -##### [screenshot](https://github.com/appium/ruby_lib/blob/a13158fb926212d84f26120c3bc5355c8cd34baf/lib/appium_lib/driver.rb#L443) +##### [screenshot](https://github.com/appium/ruby_lib/blob/7c3bc19905d0f008192a59dc7f5a938e3701ec8f/lib/appium_lib/driver.rb#L456) > def screenshot png_save_path Takes a png screenshot and saves to the target path. @@ -388,11 +388,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[nil] -- -##### [driver_quit](https://github.com/appium/ruby_lib/blob/a13158fb926212d84f26120c3bc5355c8cd34baf/lib/appium_lib/driver.rb#L450) +##### [driver_quit](https://github.com/appium/ruby_lib/blob/7c3bc19905d0f008192a59dc7f5a938e3701ec8f/lib/appium_lib/driver.rb#L463) > def driver_quit Quits the driver @@ -400,11 +400,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[void] -- -##### [start_driver](https://github.com/appium/ruby_lib/blob/a13158fb926212d84f26120c3bc5355c8cd34baf/lib/appium_lib/driver.rb#L458) +##### [start_driver](https://github.com/appium/ruby_lib/blob/7c3bc19905d0f008192a59dc7f5a938e3701ec8f/lib/appium_lib/driver.rb#L471) > def start_driver Creates a new global driver and quits the old one if it exists. @@ -412,19 +412,19 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Selenium::WebDriver] the new global driver -- -##### [no_wait](https://github.com/appium/ruby_lib/blob/a13158fb926212d84f26120c3bc5355c8cd34baf/lib/appium_lib/driver.rb#L485) +##### [no_wait](https://github.com/appium/ruby_lib/blob/7c3bc19905d0f008192a59dc7f5a938e3701ec8f/lib/appium_lib/driver.rb#L497) > def no_wait Set implicit wait and default_wait to zero. -- -##### [set_wait](https://github.com/appium/ruby_lib/blob/a13158fb926212d84f26120c3bc5355c8cd34baf/lib/appium_lib/driver.rb#L504) +##### [set_wait](https://github.com/appium/ruby_lib/blob/7c3bc19905d0f008192a59dc7f5a938e3701ec8f/lib/appium_lib/driver.rb#L516) > 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 @@ -445,11 +445,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[void] -- -##### [exists](https://github.com/appium/ruby_lib/blob/a13158fb926212d84f26120c3bc5355c8cd34baf/lib/appium_lib/driver.rb#L538) +##### [exists](https://github.com/appium/ruby_lib/blob/7c3bc19905d0f008192a59dc7f5a938e3701ec8f/lib/appium_lib/driver.rb#L550) > def exists pre_check=0, post_check=@default_wait, &search_block Returns existence of element. @@ -471,11 +471,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Boolean] -- -##### [execute_script](https://github.com/appium/ruby_lib/blob/a13158fb926212d84f26120c3bc5355c8cd34baf/lib/appium_lib/driver.rb#L562) +##### [execute_script](https://github.com/appium/ruby_lib/blob/7c3bc19905d0f008192a59dc7f5a938e3701ec8f/lib/appium_lib/driver.rb#L574) > def execute_script script, *args The same as @driver.execute_script @@ -489,11 +489,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Object] -- -##### [find_elements](https://github.com/appium/ruby_lib/blob/a13158fb926212d84f26120c3bc5355c8cd34baf/lib/appium_lib/driver.rb#L570) +##### [find_elements](https://github.com/appium/ruby_lib/blob/7c3bc19905d0f008192a59dc7f5a938e3701ec8f/lib/appium_lib/driver.rb#L582) > def find_elements *args Calls @driver.find_elements @@ -505,11 +505,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Array<Element>] Array is empty when no elements are found. -- -##### [find_element](https://github.com/appium/ruby_lib/blob/a13158fb926212d84f26120c3bc5355c8cd34baf/lib/appium_lib/driver.rb#L578) +##### [find_element](https://github.com/appium/ruby_lib/blob/7c3bc19905d0f008192a59dc7f5a938e3701ec8f/lib/appium_lib/driver.rb#L590) > def find_element *args Calls @driver.find_elements @@ -521,11 +521,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Element] -- -##### [x](https://github.com/appium/ruby_lib/blob/a13158fb926212d84f26120c3bc5355c8cd34baf/lib/appium_lib/driver.rb#L585) +##### [x](https://github.com/appium/ruby_lib/blob/7c3bc19905d0f008192a59dc7f5a938e3701ec8f/lib/appium_lib/driver.rb#L597) > def x Quit the driver and Pry. quit and exit are reserved by Pry. @@ -534,79 +534,79 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[void] -- -##### [NoArgMethods](https://github.com/appium/ruby_lib/blob/a13158fb926212d84f26120c3bc5355c8cd34baf/lib/appium_lib/device/device.rb#L7) +##### [NoArgMethods](https://github.com/appium/ruby_lib/blob/7c3bc19905d0f008192a59dc7f5a938e3701ec8f/lib/appium_lib/device/device.rb#L7) > NoArgMethods = { -- -##### [app_strings](https://github.com/appium/ruby_lib/blob/a13158fb926212d84f26120c3bc5355c8cd34baf/lib/appium_lib/device/device.rb#L22) +##### [app_strings](https://github.com/appium/ruby_lib/blob/7c3bc19905d0f008192a59dc7f5a938e3701ec8f/lib/appium_lib/device/device.rb#L23) > 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/a13158fb926212d84f26120c3bc5355c8cd34baf/lib/appium_lib/device/device.rb#L28) +##### [background_app](https://github.com/appium/ruby_lib/blob/7c3bc19905d0f008192a59dc7f5a938e3701ec8f/lib/appium_lib/device/device.rb#L29) > 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/a13158fb926212d84f26120c3bc5355c8cd34baf/lib/appium_lib/device/device.rb#L33) +##### [current_activity](https://github.com/appium/ruby_lib/blob/7c3bc19905d0f008192a59dc7f5a938e3701ec8f/lib/appium_lib/device/device.rb#L34) > def current_activity -- -##### [launch](https://github.com/appium/ruby_lib/blob/a13158fb926212d84f26120c3bc5355c8cd34baf/lib/appium_lib/device/device.rb#L35) +##### [launch_app](https://github.com/appium/ruby_lib/blob/7c3bc19905d0f008192a59dc7f5a938e3701ec8f/lib/appium_lib/device/device.rb#L36) -> def launch +> def launch_app Start the simulator and applicaton configured with desired capabilities -- -##### [reset](https://github.com/appium/ruby_lib/blob/a13158fb926212d84f26120c3bc5355c8cd34baf/lib/appium_lib/device/device.rb#L38) +##### [reset](https://github.com/appium/ruby_lib/blob/7c3bc19905d0f008192a59dc7f5a938e3701ec8f/lib/appium_lib/device/device.rb#L39) > def reset Reset the device, relaunching the application. -- -##### [shake](https://github.com/appium/ruby_lib/blob/a13158fb926212d84f26120c3bc5355c8cd34baf/lib/appium_lib/device/device.rb#L41) +##### [shake](https://github.com/appium/ruby_lib/blob/7c3bc19905d0f008192a59dc7f5a938e3701ec8f/lib/appium_lib/device/device.rb#L42) > def shake Cause the device to shake -- -##### [toggle_flight_mode](https://github.com/appium/ruby_lib/blob/a13158fb926212d84f26120c3bc5355c8cd34baf/lib/appium_lib/device/device.rb#L44) +##### [toggle_flight_mode](https://github.com/appium/ruby_lib/blob/7c3bc19905d0f008192a59dc7f5a938e3701ec8f/lib/appium_lib/device/device.rb#L45) > def toggle_flight_mode toggle flight mode on or off -- -##### [hide_keyboard](https://github.com/appium/ruby_lib/blob/a13158fb926212d84f26120c3bc5355c8cd34baf/lib/appium_lib/device/device.rb#L47) +##### [hide_keyboard](https://github.com/appium/ruby_lib/blob/7c3bc19905d0f008192a59dc7f5a938e3701ec8f/lib/appium_lib/device/device.rb#L48) > def hide_keyboard Hide the onscreen keyboard @@ -615,11 +615,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[String] close_key - the name of the key which closes the keyboard. Defaults to 'Done'. -- -##### [press_keycode](https://github.com/appium/ruby_lib/blob/a13158fb926212d84f26120c3bc5355c8cd34baf/lib/appium_lib/device/device.rb#L56) +##### [press_keycode](https://github.com/appium/ruby_lib/blob/7c3bc19905d0f008192a59dc7f5a938e3701ec8f/lib/appium_lib/device/device.rb#L57) > def press_keycode Press keycode on the device. http://developer.android.com/reference/android/view/KeyEvent.html @@ -630,11 +630,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[String] metastate - The state the metakeys should be in when pressing the key. -- -##### [long_press_keycode](https://github.com/appium/ruby_lib/blob/a13158fb926212d84f26120c3bc5355c8cd34baf/lib/appium_lib/device/device.rb#L62) +##### [long_press_keycode](https://github.com/appium/ruby_lib/blob/7c3bc19905d0f008192a59dc7f5a938e3701ec8f/lib/appium_lib/device/device.rb#L63) > def long_press_keycode Long press keycode on the device. http://developer.android.com/reference/android/view/KeyEvent.html @@ -645,11 +645,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[String] metastate - The state the metakeys should be in when long pressing the key. -- -##### [push_file](https://github.com/appium/ruby_lib/blob/a13158fb926212d84f26120c3bc5355c8cd34baf/lib/appium_lib/device/device.rb#L68) +##### [push_file](https://github.com/appium/ruby_lib/blob/7c3bc19905d0f008192a59dc7f5a938e3701ec8f/lib/appium_lib/device/device.rb#L69) > def push_file Place a file in a specific location on the device. @@ -659,11 +659,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[String] data - Raw file data to be sent to the device. -- -##### [pull_file](https://github.com/appium/ruby_lib/blob/a13158fb926212d84f26120c3bc5355c8cd34baf/lib/appium_lib/device/device.rb#L73) +##### [pull_file](https://github.com/appium/ruby_lib/blob/7c3bc19905d0f008192a59dc7f5a938e3701ec8f/lib/appium_lib/device/device.rb#L74) > 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). @@ -676,11 +676,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[String] path - Either an absolute path OR, for iOS devices, a path relative to the app, as described. -- -##### [pull_folder](https://github.com/appium/ruby_lib/blob/a13158fb926212d84f26120c3bc5355c8cd34baf/lib/appium_lib/device/device.rb#L83) +##### [pull_folder](https://github.com/appium/ruby_lib/blob/7c3bc19905d0f008192a59dc7f5a938e3701ec8f/lib/appium_lib/device/device.rb#L84) > def pull_folder Retrieve a folder from the device. ```ruby @@ -691,19 +691,41 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[String] path - absolute path to the folder -- -##### [extend_search_contexts](https://github.com/appium/ruby_lib/blob/a13158fb926212d84f26120c3bc5355c8cd34baf/lib/appium_lib/device/device.rb#L274) +##### [end_coverage](https://github.com/appium/ruby_lib/blob/7c3bc19905d0f008192a59dc7f5a938e3701ec8f/lib/appium_lib/device/device.rb#L92) +> 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/7c3bc19905d0f008192a59dc7f5a938e3701ec8f/lib/appium_lib/device/device.rb#L97) + +> def get_settings + +Get appium Settings for current test session + +-- + +##### [extend_search_contexts](https://github.com/appium/ruby_lib/blob/7c3bc19905d0f008192a59dc7f5a938e3701ec8f/lib/appium_lib/device/device.rb#L345) + > def extend_search_contexts -- -##### [accessiblity_id_find](https://github.com/appium/ruby_lib/blob/a13158fb926212d84f26120c3bc5355c8cd34baf/lib/appium_lib/device/device.rb#L274) +##### [accessiblity_id_find](https://github.com/appium/ruby_lib/blob/7c3bc19905d0f008192a59dc7f5a938e3701ec8f/lib/appium_lib/device/device.rb#L345) > def accessiblity_id_find find_element/s with their accessibility_id @@ -711,19 +733,19 @@ find_elements :accessibility_id, 'Animation' ``` -- -##### [add_touch_actions](https://github.com/appium/ruby_lib/blob/a13158fb926212d84f26120c3bc5355c8cd34baf/lib/appium_lib/device/device.rb#L280) +##### [add_touch_actions](https://github.com/appium/ruby_lib/blob/7c3bc19905d0f008192a59dc7f5a938e3701ec8f/lib/appium_lib/device/device.rb#L351) > def add_touch_actions -- -##### [set_context](https://github.com/appium/ruby_lib/blob/a13158fb926212d84f26120c3bc5355c8cd34baf/lib/appium_lib/device/device.rb#L304) +##### [set_context](https://github.com/appium/ruby_lib/blob/7c3bc19905d0f008192a59dc7f5a938e3701ec8f/lib/appium_lib/device/device.rb#L375) > def set_context Change the context to the given context. ```ruby @@ -734,11 +756,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[String] The - context to change to -- -##### [current_context](https://github.com/appium/ruby_lib/blob/a13158fb926212d84f26120c3bc5355c8cd34baf/lib/appium_lib/device/device.rb#L312) +##### [current_context](https://github.com/appium/ruby_lib/blob/7c3bc19905d0f008192a59dc7f5a938e3701ec8f/lib/appium_lib/device/device.rb#L383) > def current_context @@ -746,11 +768,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[String] The context currently being used. -- -##### [available_contexts](https://github.com/appium/ruby_lib/blob/a13158fb926212d84f26120c3bc5355c8cd34baf/lib/appium_lib/device/device.rb#L315) +##### [available_contexts](https://github.com/appium/ruby_lib/blob/7c3bc19905d0f008192a59dc7f5a938e3701ec8f/lib/appium_lib/device/device.rb#L386) > def available_contexts @@ -758,11 +780,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Array<String>] All usable contexts, as an array of strings. -- -##### [within_context](https://github.com/appium/ruby_lib/blob/a13158fb926212d84f26120c3bc5355c8cd34baf/lib/appium_lib/device/device.rb#L325) +##### [within_context](https://github.com/appium/ruby_lib/blob/7c3bc19905d0f008192a59dc7f5a938e3701ec8f/lib/appium_lib/device/device.rb#L396) > def within_context(context) Perform a block within the given context, then switch back to the starting context. ```ruby @@ -774,19 +796,19 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[String] context - The context to switch to for the duration of the block. -- -##### [switch_to_default_context](https://github.com/appium/ruby_lib/blob/a13158fb926212d84f26120c3bc5355c8cd34baf/lib/appium_lib/device/device.rb#L333) +##### [switch_to_default_context](https://github.com/appium/ruby_lib/blob/7c3bc19905d0f008192a59dc7f5a938e3701ec8f/lib/appium_lib/device/device.rb#L404) > 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/a13158fb926212d84f26120c3bc5355c8cd34baf/lib/appium_lib/device/multi_touch.rb#L30) +##### [pinch](https://github.com/appium/ruby_lib/blob/7c3bc19905d0f008192a59dc7f5a938e3701ec8f/lib/appium_lib/device/multi_touch.rb#L30) > 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. @@ -801,11 +823,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[boolean] auto_perform - Whether to perform the action immediately (default true) -- -##### [zoom](https://github.com/appium/ruby_lib/blob/a13158fb926212d84f26120c3bc5355c8cd34baf/lib/appium_lib/device/multi_touch.rb#L58) +##### [zoom](https://github.com/appium/ruby_lib/blob/7c3bc19905d0f008192a59dc7f5a938e3701ec8f/lib/appium_lib/device/multi_touch.rb#L58) > 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. @@ -820,11 +842,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[boolean] auto_perform - Whether to perform the action immediately (default true) -- -##### [initialize](https://github.com/appium/ruby_lib/blob/a13158fb926212d84f26120c3bc5355c8cd34baf/lib/appium_lib/device/multi_touch.rb#L79) +##### [initialize](https://github.com/appium/ruby_lib/blob/7c3bc19905d0f008192a59dc7f5a938e3701ec8f/lib/appium_lib/device/multi_touch.rb#L79) > def initialize Create a new multi-action @@ -832,11 +854,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[MultiTouch] a new instance of MultiTouch -- -##### [add](https://github.com/appium/ruby_lib/blob/a13158fb926212d84f26120c3bc5355c8cd34baf/lib/appium_lib/device/multi_touch.rb#L85) +##### [add](https://github.com/appium/ruby_lib/blob/7c3bc19905d0f008192a59dc7f5a938e3701ec8f/lib/appium_lib/device/multi_touch.rb#L85) > def add(chain) Add a touch_action to be performed @@ -844,43 +866,43 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[TouchAction] chain - The action to add to the chain -- -##### [perform](https://github.com/appium/ruby_lib/blob/a13158fb926212d84f26120c3bc5355c8cd34baf/lib/appium_lib/device/multi_touch.rb#L90) +##### [perform](https://github.com/appium/ruby_lib/blob/7c3bc19905d0f008192a59dc7f5a938e3701ec8f/lib/appium_lib/device/multi_touch.rb#L90) > def perform Ask Appium to perform the actions -- -##### [ACTIONS](https://github.com/appium/ruby_lib/blob/a13158fb926212d84f26120c3bc5355c8cd34baf/lib/appium_lib/device/touch_actions.rb#L12) +##### [ACTIONS](https://github.com/appium/ruby_lib/blob/7c3bc19905d0f008192a59dc7f5a938e3701ec8f/lib/appium_lib/device/touch_actions.rb#L12) > ACTIONS = [:move_to, :long_press, :press, :release, :tap, :wait, :perform] -- -##### [COMPLEX_ACTIONS](https://github.com/appium/ruby_lib/blob/a13158fb926212d84f26120c3bc5355c8cd34baf/lib/appium_lib/device/touch_actions.rb#L13) +##### [COMPLEX_ACTIONS](https://github.com/appium/ruby_lib/blob/7c3bc19905d0f008192a59dc7f5a938e3701ec8f/lib/appium_lib/device/touch_actions.rb#L13) > COMPLEX_ACTIONS = [:swipe] -- -##### [actions](https://github.com/appium/ruby_lib/blob/a13158fb926212d84f26120c3bc5355c8cd34baf/lib/appium_lib/device/touch_actions.rb#L27) +##### [actions](https://github.com/appium/ruby_lib/blob/7c3bc19905d0f008192a59dc7f5a938e3701ec8f/lib/appium_lib/device/touch_actions.rb#L27) > def actions Returns the value of attribute actions -- -##### [initialize](https://github.com/appium/ruby_lib/blob/a13158fb926212d84f26120c3bc5355c8cd34baf/lib/appium_lib/device/touch_actions.rb#L29) +##### [initialize](https://github.com/appium/ruby_lib/blob/7c3bc19905d0f008192a59dc7f5a938e3701ec8f/lib/appium_lib/device/touch_actions.rb#L29) > def initialize @@ -888,11 +910,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[TouchAction] a new instance of TouchAction -- -##### [move_to](https://github.com/appium/ruby_lib/blob/a13158fb926212d84f26120c3bc5355c8cd34baf/lib/appium_lib/device/touch_actions.rb#L37) +##### [move_to](https://github.com/appium/ruby_lib/blob/7c3bc19905d0f008192a59dc7f5a938e3701ec8f/lib/appium_lib/device/touch_actions.rb#L37) > def move_to(opts) Move to the given co-ordinates. @@ -900,11 +922,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Hash] opts - a customizable set of options -- -##### [long_press](https://github.com/appium/ruby_lib/blob/a13158fb926212d84f26120c3bc5355c8cd34baf/lib/appium_lib/device/touch_actions.rb#L47) +##### [long_press](https://github.com/appium/ruby_lib/blob/7c3bc19905d0f008192a59dc7f5a938e3701ec8f/lib/appium_lib/device/touch_actions.rb#L47) > def long_press(opts) Press down for a specific duration. @@ -918,11 +940,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Hash] duration - a customizable set of options -- -##### [press](https://github.com/appium/ruby_lib/blob/a13158fb926212d84f26120c3bc5355c8cd34baf/lib/appium_lib/device/touch_actions.rb#L59) +##### [press](https://github.com/appium/ruby_lib/blob/7c3bc19905d0f008192a59dc7f5a938e3701ec8f/lib/appium_lib/device/touch_actions.rb#L59) > def press(opts) Press a finger onto the screen. Finger will stay down until you call `release`. @@ -931,11 +953,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Hash] opts - a customizable set of options -- -##### [release](https://github.com/appium/ruby_lib/blob/a13158fb926212d84f26120c3bc5355c8cd34baf/lib/appium_lib/device/touch_actions.rb#L70) +##### [release](https://github.com/appium/ruby_lib/blob/7c3bc19905d0f008192a59dc7f5a938e3701ec8f/lib/appium_lib/device/touch_actions.rb#L70) > def release(opts=nil) Remove a finger from the screen. @@ -943,11 +965,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Hash] opts - a customizable set of options -- -##### [tap](https://github.com/appium/ruby_lib/blob/a13158fb926212d84f26120c3bc5355c8cd34baf/lib/appium_lib/device/touch_actions.rb#L81) +##### [tap](https://github.com/appium/ruby_lib/blob/7c3bc19905d0f008192a59dc7f5a938e3701ec8f/lib/appium_lib/device/touch_actions.rb#L81) > def tap(opts) Touch a point on the screen @@ -955,11 +977,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Hash] opts - a customizable set of options -- -##### [wait](https://github.com/appium/ruby_lib/blob/a13158fb926212d84f26120c3bc5355c8cd34baf/lib/appium_lib/device/touch_actions.rb#L90) +##### [wait](https://github.com/appium/ruby_lib/blob/7c3bc19905d0f008192a59dc7f5a938e3701ec8f/lib/appium_lib/device/touch_actions.rb#L90) > def wait(milliseconds) Pause for a number of milliseconds before the next action @@ -967,11 +989,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[integer] milliseconds - Number of milliseconds to pause for -- -##### [swipe](https://github.com/appium/ruby_lib/blob/a13158fb926212d84f26120c3bc5355c8cd34baf/lib/appium_lib/device/touch_actions.rb#L104) +##### [swipe](https://github.com/appium/ruby_lib/blob/7c3bc19905d0f008192a59dc7f5a938e3701ec8f/lib/appium_lib/device/touch_actions.rb#L104) > def swipe(opts) Convenience method to peform a swipe. @@ -981,60 +1003,60 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Hash] opts - a customizable set of options -- -##### [perform](https://github.com/appium/ruby_lib/blob/a13158fb926212d84f26120c3bc5355c8cd34baf/lib/appium_lib/device/touch_actions.rb#L119) +##### [perform](https://github.com/appium/ruby_lib/blob/7c3bc19905d0f008192a59dc7f5a938e3701ec8f/lib/appium_lib/device/touch_actions.rb#L119) > def perform Ask the driver to perform all actions in this action chain. -- -##### [cancel](https://github.com/appium/ruby_lib/blob/a13158fb926212d84f26120c3bc5355c8cd34baf/lib/appium_lib/device/touch_actions.rb#L125) +##### [cancel](https://github.com/appium/ruby_lib/blob/7c3bc19905d0f008192a59dc7f5a938e3701ec8f/lib/appium_lib/device/touch_actions.rb#L125) > def cancel Does nothing, currently. -- -##### [chain_method](https://github.com/appium/ruby_lib/blob/a13158fb926212d84f26120c3bc5355c8cd34baf/lib/appium_lib/device/touch_actions.rb#L133) +##### [chain_method](https://github.com/appium/ruby_lib/blob/7c3bc19905d0f008192a59dc7f5a938e3701ec8f/lib/appium_lib/device/touch_actions.rb#L133) > def chain_method(method, args=nil) -- -##### [args_with_ele_ref](https://github.com/appium/ruby_lib/blob/a13158fb926212d84f26120c3bc5355c8cd34baf/lib/appium_lib/device/touch_actions.rb#L142) +##### [args_with_ele_ref](https://github.com/appium/ruby_lib/blob/7c3bc19905d0f008192a59dc7f5a938e3701ec8f/lib/appium_lib/device/touch_actions.rb#L142) > def args_with_ele_ref(args) -- -##### [_generic_wait](https://github.com/appium/ruby_lib/blob/a13158fb926212d84f26120c3bc5355c8cd34baf/lib/appium_lib/common/wait.rb#L10) +##### [_generic_wait](https://github.com/appium/ruby_lib/blob/7c3bc19905d0f008192a59dc7f5a938e3701ec8f/lib/appium_lib/common/wait.rb#L10) > 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/a13158fb926212d84f26120c3bc5355c8cd34baf/lib/appium_lib/common/wait.rb#L55) +##### [_process_wait_opts](https://github.com/appium/ruby_lib/blob/7c3bc19905d0f008192a59dc7f5a938e3701ec8f/lib/appium_lib/common/wait.rb#L55) > def _process_wait_opts opts process opts before calling _generic_wait -- -##### [wait_true](https://github.com/appium/ruby_lib/blob/a13158fb926212d84f26120c3bc5355c8cd34baf/lib/appium_lib/common/wait.rb#L76) +##### [wait_true](https://github.com/appium/ruby_lib/blob/7c3bc19905d0f008192a59dc7f5a938e3701ec8f/lib/appium_lib/common/wait.rb#L76) > 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. @@ -1050,11 +1072,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Hash] opts - Options -- -##### [wait](https://github.com/appium/ruby_lib/blob/a13158fb926212d84f26120c3bc5355c8cd34baf/lib/appium_lib/common/wait.rb#L94) +##### [wait](https://github.com/appium/ruby_lib/blob/7c3bc19905d0f008192a59dc7f5a938e3701ec8f/lib/appium_lib/common/wait.rb#L94) > def wait opts={}, &block Check every interval seconds to see if block.call doesn't raise an exception. Give up after timeout seconds. @@ -1068,19 +1090,19 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Hash] opts - Options -- -##### [ignore](https://github.com/appium/ruby_lib/blob/a13158fb926212d84f26120c3bc5355c8cd34baf/lib/appium_lib/common/helper.rb#L22) +##### [ignore](https://github.com/appium/ruby_lib/blob/7c3bc19905d0f008192a59dc7f5a938e3701ec8f/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/a13158fb926212d84f26120c3bc5355c8cd34baf/lib/appium_lib/common/helper.rb#L31) +##### [back](https://github.com/appium/ruby_lib/blob/7c3bc19905d0f008192a59dc7f5a938e3701ec8f/lib/appium_lib/common/helper.rb#L33) > def back Navigate back. @@ -1088,19 +1110,19 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[void] -- -##### [session_id](https://github.com/appium/ruby_lib/blob/a13158fb926212d84f26120c3bc5355c8cd34baf/lib/appium_lib/common/helper.rb#L36) +##### [session_id](https://github.com/appium/ruby_lib/blob/7c3bc19905d0f008192a59dc7f5a938e3701ec8f/lib/appium_lib/common/helper.rb#L38) > def session_id For Sauce Labs reporting. Returns the current session id. -- -##### [xpath](https://github.com/appium/ruby_lib/blob/a13158fb926212d84f26120c3bc5355c8cd34baf/lib/appium_lib/common/helper.rb#L44) +##### [xpath](https://github.com/appium/ruby_lib/blob/7c3bc19905d0f008192a59dc7f5a938e3701ec8f/lib/appium_lib/common/helper.rb#L46) > def xpath xpath_str Returns the first element that matches the provided xpath. @@ -1112,11 +1134,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Element] -- -##### [xpaths](https://github.com/appium/ruby_lib/blob/a13158fb926212d84f26120c3bc5355c8cd34baf/lib/appium_lib/common/helper.rb#L52) +##### [xpaths](https://github.com/appium/ruby_lib/blob/7c3bc19905d0f008192a59dc7f5a938e3701ec8f/lib/appium_lib/common/helper.rb#L54) > def xpaths xpath_str Returns all elements that match the provided xpath. @@ -1128,44 +1150,27 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Array<Element>] -- -##### [source](https://github.com/appium/ruby_lib/blob/a13158fb926212d84f26120c3bc5355c8cd34baf/lib/appium_lib/common/helper.rb#L58) +##### [_print_source](https://github.com/appium/ruby_lib/blob/7c3bc19905d0f008192a59dc7f5a938e3701ec8f/lib/appium_lib/common/helper.rb#L58) -> def source +> def _print_source source -Prints xml of the current page -__Returns:__ -&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[void] - -- -##### [get_source](https://github.com/appium/ruby_lib/blob/a13158fb926212d84f26120c3bc5355c8cd34baf/lib/appium_lib/common/helper.rb#L76) +##### [result](https://github.com/appium/ruby_lib/blob/7c3bc19905d0f008192a59dc7f5a938e3701ec8f/lib/appium_lib/common/helper.rb#L71) -> def get_source - -Returns XML string for the current page -Same as driver.page_source - -__Returns:__ - -&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[String] - --- - -##### [result](https://github.com/appium/ruby_lib/blob/a13158fb926212d84f26120c3bc5355c8cd34baf/lib/appium_lib/common/helper.rb#L83) - > def result Returns the value of attribute result -- -##### [initialize](https://github.com/appium/ruby_lib/blob/a13158fb926212d84f26120c3bc5355c8cd34baf/lib/appium_lib/common/helper.rb#L85) +##### [initialize](https://github.com/appium/ruby_lib/blob/7c3bc19905d0f008192a59dc7f5a938e3701ec8f/lib/appium_lib/common/helper.rb#L73) > def initialize @@ -1173,52 +1178,52 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[CountElements] a new instance of CountElements -- -##### [reset](https://github.com/appium/ruby_lib/blob/a13158fb926212d84f26120c3bc5355c8cd34baf/lib/appium_lib/common/helper.rb#L89) +##### [reset](https://github.com/appium/ruby_lib/blob/7c3bc19905d0f008192a59dc7f5a938e3701ec8f/lib/appium_lib/common/helper.rb#L77) > def reset -- -##### [start_element](https://github.com/appium/ruby_lib/blob/a13158fb926212d84f26120c3bc5355c8cd34baf/lib/appium_lib/common/helper.rb#L94) +##### [start_element](https://github.com/appium/ruby_lib/blob/7c3bc19905d0f008192a59dc7f5a938e3701ec8f/lib/appium_lib/common/helper.rb#L82) > def start_element name, attrs = [] http://nokogiri.org/Nokogiri/XML/SAX/Document.html -- -##### [formatted_result](https://github.com/appium/ruby_lib/blob/a13158fb926212d84f26120c3bc5355c8cd34baf/lib/appium_lib/common/helper.rb#L100) +##### [formatted_result](https://github.com/appium/ruby_lib/blob/7c3bc19905d0f008192a59dc7f5a938e3701ec8f/lib/appium_lib/common/helper.rb#L88) > def formatted_result -- -##### [get_page_class](https://github.com/appium/ruby_lib/blob/a13158fb926212d84f26120c3bc5355c8cd34baf/lib/appium_lib/common/helper.rb#L111) +##### [get_page_class](https://github.com/appium/ruby_lib/blob/7c3bc19905d0f008192a59dc7f5a938e3701ec8f/lib/appium_lib/common/helper.rb#L99) > def get_page_class Returns a string of class counts of visible elements. -- -##### [page_class](https://github.com/appium/ruby_lib/blob/a13158fb926212d84f26120c3bc5355c8cd34baf/lib/appium_lib/common/helper.rb#L122) +##### [page_class](https://github.com/appium/ruby_lib/blob/7c3bc19905d0f008192a59dc7f5a938e3701ec8f/lib/appium_lib/common/helper.rb#L110) > 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/a13158fb926212d84f26120c3bc5355c8cd34baf/lib/appium_lib/common/helper.rb#L132) +##### [px_to_window_rel](https://github.com/appium/ruby_lib/blob/7c3bc19905d0f008192a59dc7f5a938e3701ec8f/lib/appium_lib/common/helper.rb#L120) > def px_to_window_rel opts={} Converts pixel values to window relative values @@ -1226,11 +1231,11 @@ px_to_window_rel x: 50, y: 150 ``` -- -##### [xml_keys](https://github.com/appium/ruby_lib/blob/a13158fb926212d84f26120c3bc5355c8cd34baf/lib/appium_lib/common/helper.rb#L149) +##### [xml_keys](https://github.com/appium/ruby_lib/blob/7c3bc19905d0f008192a59dc7f5a938e3701ec8f/lib/appium_lib/common/helper.rb#L139) > def xml_keys target Search strings.xml's values for target. @@ -1242,11 +1247,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Array] -- -##### [xml_values](https://github.com/appium/ruby_lib/blob/a13158fb926212d84f26120c3bc5355c8cd34baf/lib/appium_lib/common/helper.rb#L157) +##### [xml_values](https://github.com/appium/ruby_lib/blob/7c3bc19905d0f008192a59dc7f5a938e3701ec8f/lib/appium_lib/common/helper.rb#L147) > def xml_values target Search strings.xml's keys for target. @@ -1258,11 +1263,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Array] -- -##### [resolve_id](https://github.com/appium/ruby_lib/blob/a13158fb926212d84f26120c3bc5355c8cd34baf/lib/appium_lib/common/helper.rb#L165) +##### [resolve_id](https://github.com/appium/ruby_lib/blob/7c3bc19905d0f008192a59dc7f5a938e3701ec8f/lib/appium_lib/common/helper.rb#L155) > def resolve_id id Resolve id in strings.xml and return the value. @@ -1274,27 +1279,27 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[String] -- -##### [filter](https://github.com/appium/ruby_lib/blob/a13158fb926212d84f26120c3bc5355c8cd34baf/lib/appium_lib/common/helper.rb#L171) +##### [filter](https://github.com/appium/ruby_lib/blob/7c3bc19905d0f008192a59dc7f5a938e3701ec8f/lib/appium_lib/common/helper.rb#L161) > def filter -- -##### [filter=](https://github.com/appium/ruby_lib/blob/a13158fb926212d84f26120c3bc5355c8cd34baf/lib/appium_lib/common/helper.rb#L176) +##### [filter=](https://github.com/appium/ruby_lib/blob/7c3bc19905d0f008192a59dc7f5a938e3701ec8f/lib/appium_lib/common/helper.rb#L166) > def filter= value convert to string to support symbols -- -##### [initialize](https://github.com/appium/ruby_lib/blob/a13158fb926212d84f26120c3bc5355c8cd34baf/lib/appium_lib/common/helper.rb#L182) +##### [initialize](https://github.com/appium/ruby_lib/blob/7c3bc19905d0f008192a59dc7f5a938e3701ec8f/lib/appium_lib/common/helper.rb#L172) > def initialize @@ -1302,99 +1307,107 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[HTMLElements] a new instance of HTMLElements -- -##### [reset](https://github.com/appium/ruby_lib/blob/a13158fb926212d84f26120c3bc5355c8cd34baf/lib/appium_lib/common/helper.rb#L187) +##### [reset](https://github.com/appium/ruby_lib/blob/7c3bc19905d0f008192a59dc7f5a938e3701ec8f/lib/appium_lib/common/helper.rb#L177) > def reset -- -##### [result](https://github.com/appium/ruby_lib/blob/a13158fb926212d84f26120c3bc5355c8cd34baf/lib/appium_lib/common/helper.rb#L193) +##### [result](https://github.com/appium/ruby_lib/blob/7c3bc19905d0f008192a59dc7f5a938e3701ec8f/lib/appium_lib/common/helper.rb#L183) > def result -- -##### [start_element](https://github.com/appium/ruby_lib/blob/a13158fb926212d84f26120c3bc5355c8cd34baf/lib/appium_lib/common/helper.rb#L207) +##### [start_element](https://github.com/appium/ruby_lib/blob/7c3bc19905d0f008192a59dc7f5a938e3701ec8f/lib/appium_lib/common/helper.rb#L199) > def start_element name, attrs = [] -- -##### [end_element](https://github.com/appium/ruby_lib/blob/a13158fb926212d84f26120c3bc5355c8cd34baf/lib/appium_lib/common/helper.rb#L217) +##### [end_element](https://github.com/appium/ruby_lib/blob/7c3bc19905d0f008192a59dc7f5a938e3701ec8f/lib/appium_lib/common/helper.rb#L209) > def end_element name -- -##### [characters](https://github.com/appium/ruby_lib/blob/a13158fb926212d84f26120c3bc5355c8cd34baf/lib/appium_lib/common/helper.rb#L223) +##### [characters](https://github.com/appium/ruby_lib/blob/7c3bc19905d0f008192a59dc7f5a938e3701ec8f/lib/appium_lib/common/helper.rb#L215) > def characters(chars) -- -##### [window_size](https://github.com/appium/ruby_lib/blob/a13158fb926212d84f26120c3bc5355c8cd34baf/lib/appium_lib/common/element/window.rb#L5) +##### [_no_such_element](https://github.com/appium/ruby_lib/blob/7c3bc19905d0f008192a59dc7f5a938e3701ec8f/lib/appium_lib/common/helper.rb#L223) +> def _no_such_element + + + +-- + +##### [window_size](https://github.com/appium/ruby_lib/blob/7c3bc19905d0f008192a59dc7f5a938e3701ec8f/lib/appium_lib/common/element/window.rb#L5) + > def window_size Get the window's size -- -##### [result](https://github.com/appium/ruby_lib/blob/a13158fb926212d84f26120c3bc5355c8cd34baf/lib/appium_lib/android/helper.rb#L6) android +##### [result](https://github.com/appium/ruby_lib/blob/7c3bc19905d0f008192a59dc7f5a938e3701ec8f/lib/appium_lib/android/helper.rb#L6) android > def result Returns the value of attribute result -- -##### [keys](https://github.com/appium/ruby_lib/blob/a13158fb926212d84f26120c3bc5355c8cd34baf/lib/appium_lib/android/helper.rb#L6) android +##### [keys](https://github.com/appium/ruby_lib/blob/7c3bc19905d0f008192a59dc7f5a938e3701ec8f/lib/appium_lib/android/helper.rb#L6) android > def keys Returns the value of attribute keys -- -##### [instance](https://github.com/appium/ruby_lib/blob/a13158fb926212d84f26120c3bc5355c8cd34baf/lib/appium_lib/android/helper.rb#L6) android +##### [instance](https://github.com/appium/ruby_lib/blob/7c3bc19905d0f008192a59dc7f5a938e3701ec8f/lib/appium_lib/android/helper.rb#L6) android > def instance Returns the value of attribute instance -- -##### [filter](https://github.com/appium/ruby_lib/blob/a13158fb926212d84f26120c3bc5355c8cd34baf/lib/appium_lib/android/helper.rb#L8) android +##### [filter](https://github.com/appium/ruby_lib/blob/7c3bc19905d0f008192a59dc7f5a938e3701ec8f/lib/appium_lib/android/helper.rb#L8) android > def filter -- -##### [filter=](https://github.com/appium/ruby_lib/blob/a13158fb926212d84f26120c3bc5355c8cd34baf/lib/appium_lib/android/helper.rb#L13) android +##### [filter=](https://github.com/appium/ruby_lib/blob/7c3bc19905d0f008192a59dc7f5a938e3701ec8f/lib/appium_lib/android/helper.rb#L13) android > def filter= value convert to string to support symbols -- -##### [initialize](https://github.com/appium/ruby_lib/blob/a13158fb926212d84f26120c3bc5355c8cd34baf/lib/appium_lib/android/helper.rb#L19) android +##### [initialize](https://github.com/appium/ruby_lib/blob/7c3bc19905d0f008192a59dc7f5a938e3701ec8f/lib/appium_lib/android/helper.rb#L19) android > def initialize @@ -1402,28 +1415,50 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[AndroidElements] a new instance of AndroidElements -- -##### [reset](https://github.com/appium/ruby_lib/blob/a13158fb926212d84f26120c3bc5355c8cd34baf/lib/appium_lib/android/helper.rb#L25) android +##### [reset](https://github.com/appium/ruby_lib/blob/7c3bc19905d0f008192a59dc7f5a938e3701ec8f/lib/appium_lib/android/helper.rb#L25) android > def reset -- -##### [start_element](https://github.com/appium/ruby_lib/blob/a13158fb926212d84f26120c3bc5355c8cd34baf/lib/appium_lib/android/helper.rb#L32) android +##### [start_element](https://github.com/appium/ruby_lib/blob/7c3bc19905d0f008192a59dc7f5a938e3701ec8f/lib/appium_lib/android/helper.rb#L32) android > def start_element name, attrs = [] http://nokogiri.org/Nokogiri/XML/SAX/Document.html -- -##### [get_android_inspect](https://github.com/appium/ruby_lib/blob/a13158fb926212d84f26120c3bc5355c8cd34baf/lib/appium_lib/android/helper.rb#L92) android +##### [_fix_android_native_source](https://github.com/appium/ruby_lib/blob/7c3bc19905d0f008192a59dc7f5a938e3701ec8f/lib/appium_lib/android/helper.rb#L89) 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/7c3bc19905d0f008192a59dc7f5a938e3701ec8f/lib/appium_lib/android/helper.rb#L117) 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/7c3bc19905d0f008192a59dc7f5a938e3701ec8f/lib/appium_lib/android/helper.rb#L127) android + > def get_android_inspect class_name=false Android only. Returns a string containing interesting elements. The text, content description, and id are returned. @@ -1437,11 +1472,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[String] -- -##### [page](https://github.com/appium/ruby_lib/blob/a13158fb926212d84f26120c3bc5355c8cd34baf/lib/appium_lib/android/helper.rb#L113) android +##### [page](https://github.com/appium/ruby_lib/blob/7c3bc19905d0f008192a59dc7f5a938e3701ec8f/lib/appium_lib/android/helper.rb#L153) android > def page opts={} Intended for use with console. Inspects and prints the current page. @@ -1456,20 +1491,20 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[void] -- -##### [current_app](https://github.com/appium/ruby_lib/blob/a13158fb926212d84f26120c3bc5355c8cd34baf/lib/appium_lib/android/helper.rb#L124) android +##### [current_app](https://github.com/appium/ruby_lib/blob/7c3bc19905d0f008192a59dc7f5a938e3701ec8f/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/a13158fb926212d84f26120c3bc5355c8cd34baf/lib/appium_lib/android/helper.rb#L148) android +##### [id](https://github.com/appium/ruby_lib/blob/7c3bc19905d0f008192a59dc7f5a938e3701ec8f/lib/appium_lib/android/helper.rb#L188) android > def id id Find the first matching element by id @@ -1481,11 +1516,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Element] -- -##### [ids](https://github.com/appium/ruby_lib/blob/a13158fb926212d84f26120c3bc5355c8cd34baf/lib/appium_lib/android/helper.rb#L156) android +##### [ids](https://github.com/appium/ruby_lib/blob/7c3bc19905d0f008192a59dc7f5a938e3701ec8f/lib/appium_lib/android/helper.rb#L196) android > def ids id Find all matching elements by id @@ -1497,11 +1532,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Element] -- -##### [ele_index](https://github.com/appium/ruby_lib/blob/a13158fb926212d84f26120c3bc5355c8cd34baf/lib/appium_lib/android/helper.rb#L165) android +##### [ele_index](https://github.com/appium/ruby_lib/blob/7c3bc19905d0f008192a59dc7f5a938e3701ec8f/lib/appium_lib/android/helper.rb#L205) android > def ele_index class_name, index Find the element of type class_name at matching index. @@ -1515,11 +1550,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Element] the found element of type class_name -- -##### [first_ele](https://github.com/appium/ruby_lib/blob/a13158fb926212d84f26120c3bc5355c8cd34baf/lib/appium_lib/android/helper.rb#L183) android +##### [first_ele](https://github.com/appium/ruby_lib/blob/7c3bc19905d0f008192a59dc7f5a938e3701ec8f/lib/appium_lib/android/helper.rb#L223) android > def first_ele class_name Find the first element that matches class_name @@ -1531,11 +1566,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Element] -- -##### [last_ele](https://github.com/appium/ruby_lib/blob/a13158fb926212d84f26120c3bc5355c8cd34baf/lib/appium_lib/android/helper.rb#L190) android +##### [last_ele](https://github.com/appium/ruby_lib/blob/7c3bc19905d0f008192a59dc7f5a938e3701ec8f/lib/appium_lib/android/helper.rb#L230) android > def last_ele class_name Find the last element that matches class_name @@ -1547,11 +1582,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Element] -- -##### [tag](https://github.com/appium/ruby_lib/blob/a13158fb926212d84f26120c3bc5355c8cd34baf/lib/appium_lib/android/helper.rb#L198) android +##### [tag](https://github.com/appium/ruby_lib/blob/7c3bc19905d0f008192a59dc7f5a938e3701ec8f/lib/appium_lib/android/helper.rb#L238) android > def tag class_name Find the first element of type class_name @@ -1563,11 +1598,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Element] -- -##### [tags](https://github.com/appium/ruby_lib/blob/a13158fb926212d84f26120c3bc5355c8cd34baf/lib/appium_lib/android/helper.rb#L206) android +##### [tags](https://github.com/appium/ruby_lib/blob/7c3bc19905d0f008192a59dc7f5a938e3701ec8f/lib/appium_lib/android/helper.rb#L246) android > def tags class_name Find all elements of type class_name @@ -1579,11 +1614,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Element] -- -##### [complex_find_contains](https://github.com/appium/ruby_lib/blob/a13158fb926212d84f26120c3bc5355c8cd34baf/lib/appium_lib/android/helper.rb#L238) android +##### [complex_find_contains](https://github.com/appium/ruby_lib/blob/7c3bc19905d0f008192a59dc7f5a938e3701ec8f/lib/appium_lib/android/helper.rb#L278) android > def complex_find_contains element, value Find the first element that contains value @@ -1597,11 +1632,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Element] -- -##### [complex_finds_contains](https://github.com/appium/ruby_lib/blob/a13158fb926212d84f26120c3bc5355c8cd34baf/lib/appium_lib/android/helper.rb#L246) android +##### [complex_finds_contains](https://github.com/appium/ruby_lib/blob/7c3bc19905d0f008192a59dc7f5a938e3701ec8f/lib/appium_lib/android/helper.rb#L286) android > def complex_finds_contains element, value Find all elements containing value @@ -1615,11 +1650,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Array<Element>] -- -##### [complex_find_exact](https://github.com/appium/ruby_lib/blob/a13158fb926212d84f26120c3bc5355c8cd34baf/lib/appium_lib/android/helper.rb#L275) android +##### [complex_find_exact](https://github.com/appium/ruby_lib/blob/7c3bc19905d0f008192a59dc7f5a938e3701ec8f/lib/appium_lib/android/helper.rb#L315) android > def complex_find_exact class_name, value Find the first element exactly matching value @@ -1633,11 +1668,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Element] -- -##### [complex_finds_exact](https://github.com/appium/ruby_lib/blob/a13158fb926212d84f26120c3bc5355c8cd34baf/lib/appium_lib/android/helper.rb#L283) android +##### [complex_finds_exact](https://github.com/appium/ruby_lib/blob/7c3bc19905d0f008192a59dc7f5a938e3701ec8f/lib/appium_lib/android/helper.rb#L323) android > def complex_finds_exact class_name, value Find all elements exactly matching value @@ -1651,19 +1686,33 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Element] -- -##### [TextView](https://github.com/appium/ruby_lib/blob/a13158fb926212d84f26120c3bc5355c8cd34baf/lib/appium_lib/android/element/text.rb#L4) android +##### [get_source](https://github.com/appium/ruby_lib/blob/7c3bc19905d0f008192a59dc7f5a938e3701ec8f/lib/appium_lib/android/helper.rb#L331) 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/7c3bc19905d0f008192a59dc7f5a938e3701ec8f/lib/appium_lib/android/element/text.rb#L4) android + > TextView = 'android.widget.TextView' -- -##### [text](https://github.com/appium/ruby_lib/blob/a13158fb926212d84f26120c3bc5355c8cd34baf/lib/appium_lib/android/element/text.rb#L10) android +##### [text](https://github.com/appium/ruby_lib/blob/7c3bc19905d0f008192a59dc7f5a938e3701ec8f/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. @@ -1676,11 +1725,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[TextView] -- -##### [texts](https://github.com/appium/ruby_lib/blob/a13158fb926212d84f26120c3bc5355c8cd34baf/lib/appium_lib/android/element/text.rb#L19) android +##### [texts](https://github.com/appium/ruby_lib/blob/7c3bc19905d0f008192a59dc7f5a938e3701ec8f/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. @@ -1693,11 +1742,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Array<TextView>] -- -##### [first_text](https://github.com/appium/ruby_lib/blob/a13158fb926212d84f26120c3bc5355c8cd34baf/lib/appium_lib/android/element/text.rb#L26) android +##### [first_text](https://github.com/appium/ruby_lib/blob/7c3bc19905d0f008192a59dc7f5a938e3701ec8f/lib/appium_lib/android/element/text.rb#L26) android > def first_text Find the first TextView. @@ -1705,11 +1754,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[TextView] -- -##### [last_text](https://github.com/appium/ruby_lib/blob/a13158fb926212d84f26120c3bc5355c8cd34baf/lib/appium_lib/android/element/text.rb#L32) android +##### [last_text](https://github.com/appium/ruby_lib/blob/7c3bc19905d0f008192a59dc7f5a938e3701ec8f/lib/appium_lib/android/element/text.rb#L32) android > def last_text Find the last TextView. @@ -1717,11 +1766,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[TextView] -- -##### [text_exact](https://github.com/appium/ruby_lib/blob/a13158fb926212d84f26120c3bc5355c8cd34baf/lib/appium_lib/android/element/text.rb#L39) android +##### [text_exact](https://github.com/appium/ruby_lib/blob/7c3bc19905d0f008192a59dc7f5a938e3701ec8f/lib/appium_lib/android/element/text.rb#L39) android > def text_exact value Find the first TextView that exactly matches value. @@ -1733,11 +1782,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[TextView] -- -##### [texts_exact](https://github.com/appium/ruby_lib/blob/a13158fb926212d84f26120c3bc5355c8cd34baf/lib/appium_lib/android/element/text.rb#L46) android +##### [texts_exact](https://github.com/appium/ruby_lib/blob/7c3bc19905d0f008192a59dc7f5a938e3701ec8f/lib/appium_lib/android/element/text.rb#L46) android > def texts_exact value Find all TextViews that exactly match value. @@ -1749,43 +1798,43 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Array<TextView>] -- -##### [_nodeset_to_uiselector](https://github.com/appium/ruby_lib/blob/a13158fb926212d84f26120c3bc5355c8cd34baf/lib/appium_lib/android/client_xpath.rb#L5) android +##### [_nodeset_to_uiselector](https://github.com/appium/ruby_lib/blob/7c3bc19905d0f008192a59dc7f5a938e3701ec8f/lib/appium_lib/android/client_xpath.rb#L5) android > def _nodeset_to_uiselector opts={} -- -##### [_client_xpath](https://github.com/appium/ruby_lib/blob/a13158fb926212d84f26120c3bc5355c8cd34baf/lib/appium_lib/android/client_xpath.rb#L20) android +##### [_client_xpath](https://github.com/appium/ruby_lib/blob/7c3bc19905d0f008192a59dc7f5a938e3701ec8f/lib/appium_lib/android/client_xpath.rb#L20) android > def _client_xpath opts={} -- -##### [client_xpath](https://github.com/appium/ruby_lib/blob/a13158fb926212d84f26120c3bc5355c8cd34baf/lib/appium_lib/android/client_xpath.rb#L36) android +##### [client_xpath](https://github.com/appium/ruby_lib/blob/7c3bc19905d0f008192a59dc7f5a938e3701ec8f/lib/appium_lib/android/client_xpath.rb#L36) android > def client_xpath xpath -- -##### [client_xpaths](https://github.com/appium/ruby_lib/blob/a13158fb926212d84f26120c3bc5355c8cd34baf/lib/appium_lib/android/client_xpath.rb#L40) android +##### [client_xpaths](https://github.com/appium/ruby_lib/blob/7c3bc19905d0f008192a59dc7f5a938e3701ec8f/lib/appium_lib/android/client_xpath.rb#L40) android > def client_xpaths xpath -- -##### [alert_click](https://github.com/appium/ruby_lib/blob/a13158fb926212d84f26120c3bc5355c8cd34baf/lib/appium_lib/android/element/alert.rb#L6) android +##### [alert_click](https://github.com/appium/ruby_lib/blob/7c3bc19905d0f008192a59dc7f5a938e3701ec8f/lib/appium_lib/android/element/alert.rb#L6) android > def alert_click value Click the first alert button that contains value or by index. @@ -1797,11 +1846,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[void] -- -##### [alert_accept](https://github.com/appium/ruby_lib/blob/a13158fb926212d84f26120c3bc5355c8cd34baf/lib/appium_lib/android/element/alert.rb#L13) android +##### [alert_accept](https://github.com/appium/ruby_lib/blob/7c3bc19905d0f008192a59dc7f5a938e3701ec8f/lib/appium_lib/android/element/alert.rb#L13) android > def alert_accept Accept the alert. The last button is considered "accept." @@ -1810,11 +1859,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[void] -- -##### [alert_accept_text](https://github.com/appium/ruby_lib/blob/a13158fb926212d84f26120c3bc5355c8cd34baf/lib/appium_lib/android/element/alert.rb#L20) android +##### [alert_accept_text](https://github.com/appium/ruby_lib/blob/7c3bc19905d0f008192a59dc7f5a938e3701ec8f/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." @@ -1823,11 +1872,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[String] -- -##### [alert_dismiss](https://github.com/appium/ruby_lib/blob/a13158fb926212d84f26120c3bc5355c8cd34baf/lib/appium_lib/android/element/alert.rb#L27) android +##### [alert_dismiss](https://github.com/appium/ruby_lib/blob/7c3bc19905d0f008192a59dc7f5a938e3701ec8f/lib/appium_lib/android/element/alert.rb#L27) android > def alert_dismiss Dismiss the alert. The first button is considered "dismiss." @@ -1836,11 +1885,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[void] -- -##### [alert_dismiss_text](https://github.com/appium/ruby_lib/blob/a13158fb926212d84f26120c3bc5355c8cd34baf/lib/appium_lib/android/element/alert.rb#L34) android +##### [alert_dismiss_text](https://github.com/appium/ruby_lib/blob/7c3bc19905d0f008192a59dc7f5a938e3701ec8f/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." @@ -1849,11 +1898,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[String] -- -##### [uiautomator_find](https://github.com/appium/ruby_lib/blob/a13158fb926212d84f26120c3bc5355c8cd34baf/lib/appium_lib/android/mobile_methods.rb#L10) android +##### [uiautomator_find](https://github.com/appium/ruby_lib/blob/7c3bc19905d0f008192a59dc7f5a938e3701ec8f/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). @@ -1861,27 +1910,27 @@ find_elements :uiautomator, 'new UiSelector().clickable(true)' ``` -- -##### [Button](https://github.com/appium/ruby_lib/blob/a13158fb926212d84f26120c3bc5355c8cd34baf/lib/appium_lib/android/element/button.rb#L4) android +##### [Button](https://github.com/appium/ruby_lib/blob/7c3bc19905d0f008192a59dc7f5a938e3701ec8f/lib/appium_lib/android/element/button.rb#L4) android > Button = 'android.widget.Button' -- -##### [ImageButton](https://github.com/appium/ruby_lib/blob/a13158fb926212d84f26120c3bc5355c8cd34baf/lib/appium_lib/android/element/button.rb#L5) android +##### [ImageButton](https://github.com/appium/ruby_lib/blob/7c3bc19905d0f008192a59dc7f5a938e3701ec8f/lib/appium_lib/android/element/button.rb#L5) android > ImageButton = 'android.widget.ImageButton' -- -##### [button](https://github.com/appium/ruby_lib/blob/a13158fb926212d84f26120c3bc5355c8cd34baf/lib/appium_lib/android/element/button.rb#L43) android +##### [button](https://github.com/appium/ruby_lib/blob/7c3bc19905d0f008192a59dc7f5a938e3701ec8f/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. @@ -1894,11 +1943,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Button] -- -##### [buttons](https://github.com/appium/ruby_lib/blob/a13158fb926212d84f26120c3bc5355c8cd34baf/lib/appium_lib/android/element/button.rb#L60) android +##### [buttons](https://github.com/appium/ruby_lib/blob/7c3bc19905d0f008192a59dc7f5a938e3701ec8f/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. @@ -1911,11 +1960,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Array<Button>] -- -##### [first_button](https://github.com/appium/ruby_lib/blob/a13158fb926212d84f26120c3bc5355c8cd34baf/lib/appium_lib/android/element/button.rb#L67) android +##### [first_button](https://github.com/appium/ruby_lib/blob/7c3bc19905d0f008192a59dc7f5a938e3701ec8f/lib/appium_lib/android/element/button.rb#L67) android > def first_button Find the first button. @@ -1923,11 +1972,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Button] -- -##### [last_button](https://github.com/appium/ruby_lib/blob/a13158fb926212d84f26120c3bc5355c8cd34baf/lib/appium_lib/android/element/button.rb#L73) android +##### [last_button](https://github.com/appium/ruby_lib/blob/7c3bc19905d0f008192a59dc7f5a938e3701ec8f/lib/appium_lib/android/element/button.rb#L73) android > def last_button Find the last button. @@ -1935,11 +1984,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Button] -- -##### [button_exact](https://github.com/appium/ruby_lib/blob/a13158fb926212d84f26120c3bc5355c8cd34baf/lib/appium_lib/android/element/button.rb#L89) android +##### [button_exact](https://github.com/appium/ruby_lib/blob/7c3bc19905d0f008192a59dc7f5a938e3701ec8f/lib/appium_lib/android/element/button.rb#L89) android > def button_exact value Find the first button that exactly matches value. @@ -1951,11 +2000,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Button] -- -##### [buttons_exact](https://github.com/appium/ruby_lib/blob/a13158fb926212d84f26120c3bc5355c8cd34baf/lib/appium_lib/android/element/button.rb#L96) android +##### [buttons_exact](https://github.com/appium/ruby_lib/blob/7c3bc19905d0f008192a59dc7f5a938e3701ec8f/lib/appium_lib/android/element/button.rb#L96) android > def buttons_exact value Find all buttons that exactly match value. @@ -1967,11 +2016,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Array<Button>] -- -##### [find](https://github.com/appium/ruby_lib/blob/a13158fb926212d84f26120c3bc5355c8cd34baf/lib/appium_lib/android/element/generic.rb#L7) android +##### [find](https://github.com/appium/ruby_lib/blob/7c3bc19905d0f008192a59dc7f5a938e3701ec8f/lib/appium_lib/android/element/generic.rb#L7) android > def find value Find the first element containing value @@ -1983,11 +2032,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Element] -- -##### [finds](https://github.com/appium/ruby_lib/blob/a13158fb926212d84f26120c3bc5355c8cd34baf/lib/appium_lib/android/element/generic.rb#L14) android +##### [finds](https://github.com/appium/ruby_lib/blob/7c3bc19905d0f008192a59dc7f5a938e3701ec8f/lib/appium_lib/android/element/generic.rb#L14) android > def finds value Find all elements containing value @@ -1999,11 +2048,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Array<Element>] -- -##### [find_exact](https://github.com/appium/ruby_lib/blob/a13158fb926212d84f26120c3bc5355c8cd34baf/lib/appium_lib/android/element/generic.rb#L21) android +##### [find_exact](https://github.com/appium/ruby_lib/blob/7c3bc19905d0f008192a59dc7f5a938e3701ec8f/lib/appium_lib/android/element/generic.rb#L21) android > def find_exact value Find the first element exactly matching value @@ -2015,11 +2064,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Element] -- -##### [finds_exact](https://github.com/appium/ruby_lib/blob/a13158fb926212d84f26120c3bc5355c8cd34baf/lib/appium_lib/android/element/generic.rb#L28) android +##### [finds_exact](https://github.com/appium/ruby_lib/blob/7c3bc19905d0f008192a59dc7f5a938e3701ec8f/lib/appium_lib/android/element/generic.rb#L28) android > def finds_exact value Find all elements exactly matching value @@ -2031,11 +2080,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Array<Element>] -- -##### [scroll_to](https://github.com/appium/ruby_lib/blob/a13158fb926212d84f26120c3bc5355c8cd34baf/lib/appium_lib/android/element/generic.rb#L40) android +##### [scroll_to](https://github.com/appium/ruby_lib/blob/7c3bc19905d0f008192a59dc7f5a938e3701ec8f/lib/appium_lib/android/element/generic.rb#L40) android > def scroll_to text Scroll to the first element containing target text or description. @@ -2047,11 +2096,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Element] the element scrolled to -- -##### [scroll_to_exact](https://github.com/appium/ruby_lib/blob/a13158fb926212d84f26120c3bc5355c8cd34baf/lib/appium_lib/android/element/generic.rb#L52) android +##### [scroll_to_exact](https://github.com/appium/ruby_lib/blob/7c3bc19905d0f008192a59dc7f5a938e3701ec8f/lib/appium_lib/android/element/generic.rb#L52) android > def scroll_to_exact text Scroll to the first element with the exact target text or description. @@ -2063,19 +2112,19 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Element] the element scrolled to -- -##### [EditText](https://github.com/appium/ruby_lib/blob/a13158fb926212d84f26120c3bc5355c8cd34baf/lib/appium_lib/android/element/textfield.rb#L3) android +##### [EditText](https://github.com/appium/ruby_lib/blob/7c3bc19905d0f008192a59dc7f5a938e3701ec8f/lib/appium_lib/android/element/textfield.rb#L3) android > EditText = 'android.widget.EditText' -- -##### [textfield](https://github.com/appium/ruby_lib/blob/a13158fb926212d84f26120c3bc5355c8cd34baf/lib/appium_lib/android/element/textfield.rb#L9) android +##### [textfield](https://github.com/appium/ruby_lib/blob/7c3bc19905d0f008192a59dc7f5a938e3701ec8f/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. @@ -2088,11 +2137,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[EditText] -- -##### [textfields](https://github.com/appium/ruby_lib/blob/a13158fb926212d84f26120c3bc5355c8cd34baf/lib/appium_lib/android/element/textfield.rb#L18) android +##### [textfields](https://github.com/appium/ruby_lib/blob/7c3bc19905d0f008192a59dc7f5a938e3701ec8f/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. @@ -2105,11 +2154,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Array<EditText>] -- -##### [first_textfield](https://github.com/appium/ruby_lib/blob/a13158fb926212d84f26120c3bc5355c8cd34baf/lib/appium_lib/android/element/textfield.rb#L25) android +##### [first_textfield](https://github.com/appium/ruby_lib/blob/7c3bc19905d0f008192a59dc7f5a938e3701ec8f/lib/appium_lib/android/element/textfield.rb#L25) android > def first_textfield Find the first EditText. @@ -2117,11 +2166,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[EditText] -- -##### [last_textfield](https://github.com/appium/ruby_lib/blob/a13158fb926212d84f26120c3bc5355c8cd34baf/lib/appium_lib/android/element/textfield.rb#L31) android +##### [last_textfield](https://github.com/appium/ruby_lib/blob/7c3bc19905d0f008192a59dc7f5a938e3701ec8f/lib/appium_lib/android/element/textfield.rb#L31) android > def last_textfield Find the last EditText. @@ -2129,11 +2178,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[EditText] -- -##### [textfield_exact](https://github.com/appium/ruby_lib/blob/a13158fb926212d84f26120c3bc5355c8cd34baf/lib/appium_lib/android/element/textfield.rb#L38) android +##### [textfield_exact](https://github.com/appium/ruby_lib/blob/7c3bc19905d0f008192a59dc7f5a938e3701ec8f/lib/appium_lib/android/element/textfield.rb#L38) android > def textfield_exact value Find the first EditText that exactly matches value. @@ -2145,11 +2194,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[EditText] -- -##### [textfields_exact](https://github.com/appium/ruby_lib/blob/a13158fb926212d84f26120c3bc5355c8cd34baf/lib/appium_lib/android/element/textfield.rb#L45) android +##### [textfields_exact](https://github.com/appium/ruby_lib/blob/7c3bc19905d0f008192a59dc7f5a938e3701ec8f/lib/appium_lib/android/element/textfield.rb#L45) android > def textfields_exact value Find all EditTexts that exactly match value. @@ -2161,31 +2210,31 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Array<EditText>] -- -##### [value](https://github.com/appium/ruby_lib/blob/a13158fb926212d84f26120c3bc5355c8cd34baf/lib/appium_lib/common/patch.rb#L10) +##### [value](https://github.com/appium/ruby_lib/blob/7c3bc19905d0f008192a59dc7f5a938e3701ec8f/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/a13158fb926212d84f26120c3bc5355c8cd34baf/lib/appium_lib/common/patch.rb#L17) +##### [name](https://github.com/appium/ruby_lib/blob/7c3bc19905d0f008192a59dc7f5a938e3701ec8f/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/a13158fb926212d84f26120c3bc5355c8cd34baf/lib/appium_lib/common/patch.rb#L29) +##### [location_rel](https://github.com/appium/ruby_lib/blob/7c3bc19905d0f008192a59dc7f5a938e3701ec8f/lib/appium_lib/common/patch.rb#L31) > def location_rel For use with mobile tap. @@ -2196,8 +2245,16 @@ 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/7c3bc19905d0f008192a59dc7f5a938e3701ec8f/lib/appium_lib/common/patch.rb#L145) + +> DEFAULT_HEADERS = { 'Accept' => CONTENT_TYPE, 'User-Agent' => "appium/ruby_lib/#{::Appium::VERSION}" } + + --