docs/android_docs.md in appium_lib-3.0.3 vs docs/android_docs.md in appium_lib-4.0.0

- old
+ new

@@ -1,6 +1,6 @@ -##### [load_appium_txt](https://github.com/appium/ruby_lib/blob/3ed875cc01ba7f670e9b1b8ccfd7b7adb0af82c1/lib/appium_lib/driver.rb#L71) +##### [load_appium_txt](https://github.com/appium/ruby_lib/blob/8cc004ad04ec087a8a11c06ca0749a5e2c6586a7/lib/appium_lib/driver.rb#L70) > def self.load_appium_txt opts={} Load appium.txt (toml format) the basedir of this file + appium.txt is what's used @@ -25,30 +25,30 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[hash] the symbolized hash with updated :app and :require keys -- -##### [symbolize_keys](https://github.com/appium/ruby_lib/blob/3ed875cc01ba7f670e9b1b8ccfd7b7adb0af82c1/lib/appium_lib/driver.rb#L141) +##### [symbolize_keys](https://github.com/appium/ruby_lib/blob/8cc004ad04ec087a8a11c06ca0749a5e2c6586a7/lib/appium_lib/driver.rb#L140) > 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/3ed875cc01ba7f670e9b1b8ccfd7b7adb0af82c1/lib/appium_lib/driver.rb#L151) +##### [promote_singleton_appium_methods](https://github.com/appium/ruby_lib/blob/8cc004ad04ec087a8a11c06ca0749a5e2c6586a7/lib/appium_lib/driver.rb#L150) > def self.promote_singleton_appium_methods main_module -- -##### [promote_appium_methods](https://github.com/appium/ruby_lib/blob/3ed875cc01ba7f670e9b1b8ccfd7b7adb0af82c1/lib/appium_lib/driver.rb#L180) +##### [promote_appium_methods](https://github.com/appium/ruby_lib/blob/8cc004ad04ec087a8a11c06ca0749a5e2c6586a7/lib/appium_lib/driver.rb#L179) > def self.promote_appium_methods class_array Promote appium methods to class instance methods @@ -62,28 +62,193 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Array<Class>] class_array - An array of classes -- -##### [global_webdriver_http_sleep](https://github.com/appium/ruby_lib/blob/3ed875cc01ba7f670e9b1b8ccfd7b7adb0af82c1/lib/appium_lib/driver.rb#L213) +##### [global_webdriver_http_sleep](https://github.com/appium/ruby_lib/blob/8cc004ad04ec087a8a11c06ca0749a5e2c6586a7/lib/appium_lib/driver.rb#L212) > 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/3ed875cc01ba7f670e9b1b8ccfd7b7adb0af82c1/lib/appium_lib/driver.rb#L213) +##### [global_webdriver_http_sleep=](https://github.com/appium/ruby_lib/blob/8cc004ad04ec087a8a11c06ca0749a5e2c6586a7/lib/appium_lib/driver.rb#L212) > def global_webdriver_http_sleep=(value) The amount to sleep in seconds before every webdriver http call. -- -##### [initialize](https://github.com/appium/ruby_lib/blob/3ed875cc01ba7f670e9b1b8ccfd7b7adb0af82c1/lib/appium_lib/driver.rb#L234) +##### [caps](https://github.com/appium/ruby_lib/blob/8cc004ad04ec087a8a11c06ca0749a5e2c6586a7/lib/appium_lib/driver.rb#L212) +> def caps + +The amount to sleep in seconds before every webdriver http call. + +-- + +##### [caps=](https://github.com/appium/ruby_lib/blob/8cc004ad04ec087a8a11c06ca0749a5e2c6586a7/lib/appium_lib/driver.rb#L212) + +> def caps=(value) + +The amount to sleep in seconds before every webdriver http call. + +-- + +##### [custom_url](https://github.com/appium/ruby_lib/blob/8cc004ad04ec087a8a11c06ca0749a5e2c6586a7/lib/appium_lib/driver.rb#L212) + +> def custom_url + +The amount to sleep in seconds before every webdriver http call. + +-- + +##### [custom_url=](https://github.com/appium/ruby_lib/blob/8cc004ad04ec087a8a11c06ca0749a5e2c6586a7/lib/appium_lib/driver.rb#L212) + +> def custom_url=(value) + +The amount to sleep in seconds before every webdriver http call. + +-- + +##### [export_session](https://github.com/appium/ruby_lib/blob/8cc004ad04ec087a8a11c06ca0749a5e2c6586a7/lib/appium_lib/driver.rb#L212) + +> def export_session + +The amount to sleep in seconds before every webdriver http call. + +-- + +##### [export_session=](https://github.com/appium/ruby_lib/blob/8cc004ad04ec087a8a11c06ca0749a5e2c6586a7/lib/appium_lib/driver.rb#L212) + +> def export_session=(value) + +The amount to sleep in seconds before every webdriver http call. + +-- + +##### [default_wait](https://github.com/appium/ruby_lib/blob/8cc004ad04ec087a8a11c06ca0749a5e2c6586a7/lib/appium_lib/driver.rb#L212) + +> def default_wait + +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/8cc004ad04ec087a8a11c06ca0749a5e2c6586a7/lib/appium_lib/driver.rb#L212) + +> def default_wait=(value) + +The amount to sleep in seconds before every webdriver http call. + +-- + +##### [last_waits](https://github.com/appium/ruby_lib/blob/8cc004ad04ec087a8a11c06ca0749a5e2c6586a7/lib/appium_lib/driver.rb#L212) + +> def last_waits + +The amount to sleep in seconds before every webdriver http call. + +-- + +##### [last_waits=](https://github.com/appium/ruby_lib/blob/8cc004ad04ec087a8a11c06ca0749a5e2c6586a7/lib/appium_lib/driver.rb#L212) + +> def last_waits=(value) + +The amount to sleep in seconds before every webdriver http call. + +-- + +##### [sauce_username](https://github.com/appium/ruby_lib/blob/8cc004ad04ec087a8a11c06ca0749a5e2c6586a7/lib/appium_lib/driver.rb#L212) + +> def sauce_username + +The amount to sleep in seconds before every webdriver http call. + +-- + +##### [sauce_username=](https://github.com/appium/ruby_lib/blob/8cc004ad04ec087a8a11c06ca0749a5e2c6586a7/lib/appium_lib/driver.rb#L212) + +> def sauce_username=(value) + +The amount to sleep in seconds before every webdriver http call. + +-- + +##### [sauce_access_key](https://github.com/appium/ruby_lib/blob/8cc004ad04ec087a8a11c06ca0749a5e2c6586a7/lib/appium_lib/driver.rb#L212) + +> def sauce_access_key + +The amount to sleep in seconds before every webdriver http call. + +-- + +##### [sauce_access_key=](https://github.com/appium/ruby_lib/blob/8cc004ad04ec087a8a11c06ca0749a5e2c6586a7/lib/appium_lib/driver.rb#L212) + +> def sauce_access_key=(value) + +The amount to sleep in seconds before every webdriver http call. + +-- + +##### [appium_port](https://github.com/appium/ruby_lib/blob/8cc004ad04ec087a8a11c06ca0749a5e2c6586a7/lib/appium_lib/driver.rb#L212) + +> def appium_port + +The amount to sleep in seconds before every webdriver http call. + +-- + +##### [appium_port=](https://github.com/appium/ruby_lib/blob/8cc004ad04ec087a8a11c06ca0749a5e2c6586a7/lib/appium_lib/driver.rb#L212) + +> def appium_port=(value) + +The amount to sleep in seconds before every webdriver http call. + +-- + +##### [appium_device](https://github.com/appium/ruby_lib/blob/8cc004ad04ec087a8a11c06ca0749a5e2c6586a7/lib/appium_lib/driver.rb#L212) + +> def appium_device + +The amount to sleep in seconds before every webdriver http call. + +-- + +##### [appium_device=](https://github.com/appium/ruby_lib/blob/8cc004ad04ec087a8a11c06ca0749a5e2c6586a7/lib/appium_lib/driver.rb#L212) + +> def appium_device=(value) + +The amount to sleep in seconds before every webdriver http call. + +-- + +##### [appium_debug](https://github.com/appium/ruby_lib/blob/8cc004ad04ec087a8a11c06ca0749a5e2c6586a7/lib/appium_lib/driver.rb#L212) + +> def appium_debug + +The amount to sleep in seconds before every webdriver http call. + +-- + +##### [appium_debug=](https://github.com/appium/ruby_lib/blob/8cc004ad04ec087a8a11c06ca0749a5e2c6586a7/lib/appium_lib/driver.rb#L212) + +> def appium_debug=(value) + +The amount to sleep in seconds before every webdriver http call. + +-- + +##### [initialize](https://github.com/appium/ruby_lib/blob/8cc004ad04ec087a8a11c06ca0749a5e2c6586a7/lib/appium_lib/driver.rb#L243) + > def initialize opts={} Creates a new driver ```ruby @@ -109,19 +274,19 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Driver] -- -##### [driver_attributes](https://github.com/appium/ruby_lib/blob/3ed875cc01ba7f670e9b1b8ccfd7b7adb0af82c1/lib/appium_lib/driver.rb#L311) +##### [driver_attributes](https://github.com/appium/ruby_lib/blob/8cc004ad04ec087a8a11c06ca0749a5e2c6586a7/lib/appium_lib/driver.rb#L318) > def driver_attributes Returns a hash of the driver attributes -- -##### [device_is_android?](https://github.com/appium/ruby_lib/blob/3ed875cc01ba7f670e9b1b8ccfd7b7adb0af82c1/lib/appium_lib/driver.rb#L331) +##### [device_is_android?](https://github.com/appium/ruby_lib/blob/8cc004ad04ec087a8a11c06ca0749a5e2c6586a7/lib/appium_lib/driver.rb#L338) > def device_is_android? @@ -129,11 +294,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Boolean] -- -##### [appium_server_version](https://github.com/appium/ruby_lib/blob/3ed875cc01ba7f670e9b1b8ccfd7b7adb0af82c1/lib/appium_lib/driver.rb#L347) +##### [appium_server_version](https://github.com/appium/ruby_lib/blob/8cc004ad04ec087a8a11c06ca0749a5e2c6586a7/lib/appium_lib/driver.rb#L354) > def appium_server_version Returns the server's version info @@ -150,11 +315,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Hash] -- -##### [absolute_app_path](https://github.com/appium/ruby_lib/blob/3ed875cc01ba7f670e9b1b8ccfd7b7adb0af82c1/lib/appium_lib/driver.rb#L353) +##### [absolute_app_path](https://github.com/appium/ruby_lib/blob/8cc004ad04ec087a8a11c06ca0749a5e2c6586a7/lib/appium_lib/driver.rb#L360) > def self.absolute_app_path app_path Converts app_path to an absolute path. @@ -162,11 +327,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[String] APP_PATH as an absolute path -- -##### [server_url](https://github.com/appium/ruby_lib/blob/3ed875cc01ba7f670e9b1b8ccfd7b7adb0af82c1/lib/appium_lib/driver.rb#L377) +##### [server_url](https://github.com/appium/ruby_lib/blob/8cc004ad04ec087a8a11c06ca0749a5e2c6586a7/lib/appium_lib/driver.rb#L387) > def server_url Get the server url @@ -174,11 +339,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[String] the server url -- -##### [restart](https://github.com/appium/ruby_lib/blob/3ed875cc01ba7f670e9b1b8ccfd7b7adb0af82c1/lib/appium_lib/driver.rb#L388) +##### [restart](https://github.com/appium/ruby_lib/blob/8cc004ad04ec087a8a11c06ca0749a5e2c6586a7/lib/appium_lib/driver.rb#L398) > def restart Restarts the driver @@ -186,11 +351,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Driver] the driver -- -##### [driver](https://github.com/appium/ruby_lib/blob/3ed875cc01ba7f670e9b1b8ccfd7b7adb0af82c1/lib/appium_lib/driver.rb#L395) +##### [driver](https://github.com/appium/ruby_lib/blob/8cc004ad04ec087a8a11c06ca0749a5e2c6586a7/lib/appium_lib/driver.rb#L405) > def driver Returns the driver @@ -198,11 +363,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Driver] the driver -- -##### [screenshot](https://github.com/appium/ruby_lib/blob/3ed875cc01ba7f670e9b1b8ccfd7b7adb0af82c1/lib/appium_lib/driver.rb#L405) +##### [screenshot](https://github.com/appium/ruby_lib/blob/8cc004ad04ec087a8a11c06ca0749a5e2c6586a7/lib/appium_lib/driver.rb#L415) > def screenshot png_save_path Takes a png screenshot and saves to the target path. @@ -216,11 +381,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[nil] -- -##### [driver_quit](https://github.com/appium/ruby_lib/blob/3ed875cc01ba7f670e9b1b8ccfd7b7adb0af82c1/lib/appium_lib/driver.rb#L412) +##### [driver_quit](https://github.com/appium/ruby_lib/blob/8cc004ad04ec087a8a11c06ca0749a5e2c6586a7/lib/appium_lib/driver.rb#L422) > def driver_quit Quits the driver @@ -228,11 +393,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[void] -- -##### [start_driver](https://github.com/appium/ruby_lib/blob/3ed875cc01ba7f670e9b1b8ccfd7b7adb0af82c1/lib/appium_lib/driver.rb#L420) +##### [start_driver](https://github.com/appium/ruby_lib/blob/8cc004ad04ec087a8a11c06ca0749a5e2c6586a7/lib/appium_lib/driver.rb#L430) > def start_driver Creates a new global driver and quits the old one if it exists. @@ -240,19 +405,19 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Selenium::WebDriver] the new global driver -- -##### [no_wait](https://github.com/appium/ruby_lib/blob/3ed875cc01ba7f670e9b1b8ccfd7b7adb0af82c1/lib/appium_lib/driver.rb#L447) +##### [no_wait](https://github.com/appium/ruby_lib/blob/8cc004ad04ec087a8a11c06ca0749a5e2c6586a7/lib/appium_lib/driver.rb#L457) > def no_wait Set implicit wait and default_wait to zero. -- -##### [set_wait](https://github.com/appium/ruby_lib/blob/3ed875cc01ba7f670e9b1b8ccfd7b7adb0af82c1/lib/appium_lib/driver.rb#L466) +##### [set_wait](https://github.com/appium/ruby_lib/blob/8cc004ad04ec087a8a11c06ca0749a5e2c6586a7/lib/appium_lib/driver.rb#L476) > 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 @@ -273,25 +438,12 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[void] -- -##### [default_wait](https://github.com/appium/ruby_lib/blob/3ed875cc01ba7f670e9b1b8ccfd7b7adb0af82c1/lib/appium_lib/driver.rb#L484) +##### [exists](https://github.com/appium/ruby_lib/blob/8cc004ad04ec087a8a11c06ca0749a5e2c6586a7/lib/appium_lib/driver.rb#L510) -> def default_wait - -Returns the default client side wait. -This value is independent of what the server is using - -__Returns:__ - -&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Integer] - --- - -##### [exists](https://github.com/appium/ruby_lib/blob/3ed875cc01ba7f670e9b1b8ccfd7b7adb0af82c1/lib/appium_lib/driver.rb#L500) - > def exists pre_check=0, post_check=@default_wait, &search_block Returns existence of element. Example: @@ -312,11 +464,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Boolean] -- -##### [execute_script](https://github.com/appium/ruby_lib/blob/3ed875cc01ba7f670e9b1b8ccfd7b7adb0af82c1/lib/appium_lib/driver.rb#L524) +##### [execute_script](https://github.com/appium/ruby_lib/blob/8cc004ad04ec087a8a11c06ca0749a5e2c6586a7/lib/appium_lib/driver.rb#L534) > def execute_script script, *args The same as @driver.execute_script @@ -330,11 +482,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Object] -- -##### [find_elements](https://github.com/appium/ruby_lib/blob/3ed875cc01ba7f670e9b1b8ccfd7b7adb0af82c1/lib/appium_lib/driver.rb#L532) +##### [find_elements](https://github.com/appium/ruby_lib/blob/8cc004ad04ec087a8a11c06ca0749a5e2c6586a7/lib/appium_lib/driver.rb#L542) > def find_elements *args Calls @driver.find_elements @@ -346,11 +498,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/3ed875cc01ba7f670e9b1b8ccfd7b7adb0af82c1/lib/appium_lib/driver.rb#L540) +##### [find_element](https://github.com/appium/ruby_lib/blob/8cc004ad04ec087a8a11c06ca0749a5e2c6586a7/lib/appium_lib/driver.rb#L550) > def find_element *args Calls @driver.find_elements @@ -362,11 +514,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Element] -- -##### [x](https://github.com/appium/ruby_lib/blob/3ed875cc01ba7f670e9b1b8ccfd7b7adb0af82c1/lib/appium_lib/driver.rb#L547) +##### [x](https://github.com/appium/ruby_lib/blob/8cc004ad04ec087a8a11c06ca0749a5e2c6586a7/lib/appium_lib/driver.rb#L557) > def x Quit the driver and Pry. quit and exit are reserved by Pry. @@ -375,127 +527,122 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[void] -- -##### [NoArgMethods](https://github.com/appium/ruby_lib/blob/3ed875cc01ba7f670e9b1b8ccfd7b7adb0af82c1/lib/appium_lib/device/device.rb#L7) +##### [NoArgMethods](https://github.com/appium/ruby_lib/blob/8cc004ad04ec087a8a11c06ca0749a5e2c6586a7/lib/appium_lib/device/device.rb#L7) > NoArgMethods = { -- -##### [app_strings](https://github.com/appium/ruby_lib/blob/3ed875cc01ba7f670e9b1b8ccfd7b7adb0af82c1/lib/appium_lib/device/device.rb#L22) +##### [app_strings](https://github.com/appium/ruby_lib/blob/8cc004ad04ec087a8a11c06ca0749a5e2c6586a7/lib/appium_lib/device/device.rb#L22) > 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/3ed875cc01ba7f670e9b1b8ccfd7b7adb0af82c1/lib/appium_lib/device/device.rb#L28) +##### [background_app](https://github.com/appium/ruby_lib/blob/8cc004ad04ec087a8a11c06ca0749a5e2c6586a7/lib/appium_lib/device/device.rb#L28) > 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/3ed875cc01ba7f670e9b1b8ccfd7b7adb0af82c1/lib/appium_lib/device/device.rb#L33) +##### [current_activity](https://github.com/appium/ruby_lib/blob/8cc004ad04ec087a8a11c06ca0749a5e2c6586a7/lib/appium_lib/device/device.rb#L33) > def current_activity -- -##### [launch](https://github.com/appium/ruby_lib/blob/3ed875cc01ba7f670e9b1b8ccfd7b7adb0af82c1/lib/appium_lib/device/device.rb#L35) +##### [launch](https://github.com/appium/ruby_lib/blob/8cc004ad04ec087a8a11c06ca0749a5e2c6586a7/lib/appium_lib/device/device.rb#L35) > def launch Start the simulator and applicaton configured with desired capabilities -- -##### [reset](https://github.com/appium/ruby_lib/blob/3ed875cc01ba7f670e9b1b8ccfd7b7adb0af82c1/lib/appium_lib/device/device.rb#L38) +##### [reset](https://github.com/appium/ruby_lib/blob/8cc004ad04ec087a8a11c06ca0749a5e2c6586a7/lib/appium_lib/device/device.rb#L38) > def reset Reset the device, relaunching the application. -- -##### [shake](https://github.com/appium/ruby_lib/blob/3ed875cc01ba7f670e9b1b8ccfd7b7adb0af82c1/lib/appium_lib/device/device.rb#L41) +##### [shake](https://github.com/appium/ruby_lib/blob/8cc004ad04ec087a8a11c06ca0749a5e2c6586a7/lib/appium_lib/device/device.rb#L41) > def shake Cause the device to shake -- -##### [toggle_flight_mode](https://github.com/appium/ruby_lib/blob/3ed875cc01ba7f670e9b1b8ccfd7b7adb0af82c1/lib/appium_lib/device/device.rb#L44) +##### [toggle_flight_mode](https://github.com/appium/ruby_lib/blob/8cc004ad04ec087a8a11c06ca0749a5e2c6586a7/lib/appium_lib/device/device.rb#L44) > def toggle_flight_mode toggle flight mode on or off -- -##### [complex_find](https://github.com/appium/ruby_lib/blob/3ed875cc01ba7f670e9b1b8ccfd7b7adb0af82c1/lib/appium_lib/device/device.rb#L47) +##### [hide_keyboard](https://github.com/appium/ruby_lib/blob/8cc004ad04ec087a8a11c06ca0749a5e2c6586a7/lib/appium_lib/device/device.rb#L47) -> def complex_find +> def hide_keyboard -Find an element by a complex array of criteria. Available criteria -are listed in [link here]. Criteria are formed by creating an array -of arrays, each containing a selector and that selector's value. +Hide the onscreen keyboard -```ruby -complex_find [[[2, 'Sau'], [14, true]]] # => Find a clickable element - # whose names starts with 'Sau' -``` - __Parameters:__ -&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Symbol] mod - If present, will be the 0th element in the selector array. +&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[String] close_key - the name of the key which closes the keyboard. +Defaults to 'Done'. -&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Array<Object>] selectors - The selectors to find elements with. - -- -##### [hide_keyboard](https://github.com/appium/ruby_lib/blob/3ed875cc01ba7f670e9b1b8ccfd7b7adb0af82c1/lib/appium_lib/device/device.rb#L59) +##### [press_keycode](https://github.com/appium/ruby_lib/blob/8cc004ad04ec087a8a11c06ca0749a5e2c6586a7/lib/appium_lib/device/device.rb#L56) -> def hide_keyboard +> def press_keycode -Hide the onscreen keyboard +Press keycode on the device. +http://developer.android.com/reference/android/view/KeyEvent.html __Parameters:__ -&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[String] close_key - the name of the key which closes the keyboard. -Defaults to 'Done'. +&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. + -- -##### [key_event](https://github.com/appium/ruby_lib/blob/3ed875cc01ba7f670e9b1b8ccfd7b7adb0af82c1/lib/appium_lib/device/device.rb#L68) +##### [long_press_keycode](https://github.com/appium/ruby_lib/blob/8cc004ad04ec087a8a11c06ca0749a5e2c6586a7/lib/appium_lib/device/device.rb#L62) -> def key_event +> def long_press_keycode -Send a key event to the device. +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 send. +&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 sending the key. +&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/3ed875cc01ba7f670e9b1b8ccfd7b7adb0af82c1/lib/appium_lib/device/device.rb#L73) +##### [push_file](https://github.com/appium/ruby_lib/blob/8cc004ad04ec087a8a11c06ca0749a5e2c6586a7/lib/appium_lib/device/device.rb#L68) > def push_file Place a file in a specific location on the device. @@ -505,11 +652,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/3ed875cc01ba7f670e9b1b8ccfd7b7adb0af82c1/lib/appium_lib/device/device.rb#L78) +##### [pull_file](https://github.com/appium/ruby_lib/blob/8cc004ad04ec087a8a11c06ca0749a5e2c6586a7/lib/appium_lib/device/device.rb#L73) > 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). @@ -522,19 +669,34 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[String] path - Either an absolute path OR, for iOS devices, a path relative to the app, as described. -- -##### [extend_search_contexts](https://github.com/appium/ruby_lib/blob/3ed875cc01ba7f670e9b1b8ccfd7b7adb0af82c1/lib/appium_lib/device/device.rb#L290) +##### [pull_folder](https://github.com/appium/ruby_lib/blob/8cc004ad04ec087a8a11c06ca0749a5e2c6586a7/lib/appium_lib/device/device.rb#L83) +> 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 + +-- + +##### [extend_search_contexts](https://github.com/appium/ruby_lib/blob/8cc004ad04ec087a8a11c06ca0749a5e2c6586a7/lib/appium_lib/device/device.rb#L274) + > def extend_search_contexts -- -##### [accessiblity_id_find](https://github.com/appium/ruby_lib/blob/3ed875cc01ba7f670e9b1b8ccfd7b7adb0af82c1/lib/appium_lib/device/device.rb#L290) +##### [accessiblity_id_find](https://github.com/appium/ruby_lib/blob/8cc004ad04ec087a8a11c06ca0749a5e2c6586a7/lib/appium_lib/device/device.rb#L274) > def accessiblity_id_find find_element/s with their accessibility_id @@ -542,19 +704,19 @@ find_elements :accessibility_id, 'Animation' ``` -- -##### [add_touch_actions](https://github.com/appium/ruby_lib/blob/3ed875cc01ba7f670e9b1b8ccfd7b7adb0af82c1/lib/appium_lib/device/device.rb#L296) +##### [add_touch_actions](https://github.com/appium/ruby_lib/blob/8cc004ad04ec087a8a11c06ca0749a5e2c6586a7/lib/appium_lib/device/device.rb#L280) > def add_touch_actions -- -##### [set_context](https://github.com/appium/ruby_lib/blob/3ed875cc01ba7f670e9b1b8ccfd7b7adb0af82c1/lib/appium_lib/device/device.rb#L320) +##### [set_context](https://github.com/appium/ruby_lib/blob/8cc004ad04ec087a8a11c06ca0749a5e2c6586a7/lib/appium_lib/device/device.rb#L304) > def set_context Change the context to the given context. ```ruby @@ -565,11 +727,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[String] The - context to change to -- -##### [current_context](https://github.com/appium/ruby_lib/blob/3ed875cc01ba7f670e9b1b8ccfd7b7adb0af82c1/lib/appium_lib/device/device.rb#L328) +##### [current_context](https://github.com/appium/ruby_lib/blob/8cc004ad04ec087a8a11c06ca0749a5e2c6586a7/lib/appium_lib/device/device.rb#L312) > def current_context @@ -577,11 +739,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[String] The context currently being used. -- -##### [available_contexts](https://github.com/appium/ruby_lib/blob/3ed875cc01ba7f670e9b1b8ccfd7b7adb0af82c1/lib/appium_lib/device/device.rb#L331) +##### [available_contexts](https://github.com/appium/ruby_lib/blob/8cc004ad04ec087a8a11c06ca0749a5e2c6586a7/lib/appium_lib/device/device.rb#L315) > def available_contexts @@ -589,11 +751,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/3ed875cc01ba7f670e9b1b8ccfd7b7adb0af82c1/lib/appium_lib/device/device.rb#L341) +##### [within_context](https://github.com/appium/ruby_lib/blob/8cc004ad04ec087a8a11c06ca0749a5e2c6586a7/lib/appium_lib/device/device.rb#L325) > def within_context(context) Perform a block within the given context, then switch back to the starting context. ```ruby @@ -605,19 +767,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/3ed875cc01ba7f670e9b1b8ccfd7b7adb0af82c1/lib/appium_lib/device/device.rb#L349) +##### [switch_to_default_context](https://github.com/appium/ruby_lib/blob/8cc004ad04ec087a8a11c06ca0749a5e2c6586a7/lib/appium_lib/device/device.rb#L333) > 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/3ed875cc01ba7f670e9b1b8ccfd7b7adb0af82c1/lib/appium_lib/device/multi_touch.rb#L30) +##### [pinch](https://github.com/appium/ruby_lib/blob/8cc004ad04ec087a8a11c06ca0749a5e2c6586a7/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. @@ -632,11 +794,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/3ed875cc01ba7f670e9b1b8ccfd7b7adb0af82c1/lib/appium_lib/device/multi_touch.rb#L58) +##### [zoom](https://github.com/appium/ruby_lib/blob/8cc004ad04ec087a8a11c06ca0749a5e2c6586a7/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. @@ -651,11 +813,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/3ed875cc01ba7f670e9b1b8ccfd7b7adb0af82c1/lib/appium_lib/device/multi_touch.rb#L79) +##### [initialize](https://github.com/appium/ruby_lib/blob/8cc004ad04ec087a8a11c06ca0749a5e2c6586a7/lib/appium_lib/device/multi_touch.rb#L79) > def initialize Create a new multi-action @@ -663,11 +825,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[MultiTouch] a new instance of MultiTouch -- -##### [add](https://github.com/appium/ruby_lib/blob/3ed875cc01ba7f670e9b1b8ccfd7b7adb0af82c1/lib/appium_lib/device/multi_touch.rb#L85) +##### [add](https://github.com/appium/ruby_lib/blob/8cc004ad04ec087a8a11c06ca0749a5e2c6586a7/lib/appium_lib/device/multi_touch.rb#L85) > def add(chain) Add a touch_action to be performed @@ -675,43 +837,43 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[TouchAction] chain - The action to add to the chain -- -##### [perform](https://github.com/appium/ruby_lib/blob/3ed875cc01ba7f670e9b1b8ccfd7b7adb0af82c1/lib/appium_lib/device/multi_touch.rb#L90) +##### [perform](https://github.com/appium/ruby_lib/blob/8cc004ad04ec087a8a11c06ca0749a5e2c6586a7/lib/appium_lib/device/multi_touch.rb#L90) > def perform Ask Appium to perform the actions -- -##### [ACTIONS](https://github.com/appium/ruby_lib/blob/3ed875cc01ba7f670e9b1b8ccfd7b7adb0af82c1/lib/appium_lib/device/touch_actions.rb#L12) +##### [ACTIONS](https://github.com/appium/ruby_lib/blob/8cc004ad04ec087a8a11c06ca0749a5e2c6586a7/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/3ed875cc01ba7f670e9b1b8ccfd7b7adb0af82c1/lib/appium_lib/device/touch_actions.rb#L13) +##### [COMPLEX_ACTIONS](https://github.com/appium/ruby_lib/blob/8cc004ad04ec087a8a11c06ca0749a5e2c6586a7/lib/appium_lib/device/touch_actions.rb#L13) > COMPLEX_ACTIONS = [:swipe] -- -##### [actions](https://github.com/appium/ruby_lib/blob/3ed875cc01ba7f670e9b1b8ccfd7b7adb0af82c1/lib/appium_lib/device/touch_actions.rb#L27) +##### [actions](https://github.com/appium/ruby_lib/blob/8cc004ad04ec087a8a11c06ca0749a5e2c6586a7/lib/appium_lib/device/touch_actions.rb#L27) > def actions Returns the value of attribute actions -- -##### [initialize](https://github.com/appium/ruby_lib/blob/3ed875cc01ba7f670e9b1b8ccfd7b7adb0af82c1/lib/appium_lib/device/touch_actions.rb#L29) +##### [initialize](https://github.com/appium/ruby_lib/blob/8cc004ad04ec087a8a11c06ca0749a5e2c6586a7/lib/appium_lib/device/touch_actions.rb#L29) > def initialize @@ -719,11 +881,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[TouchAction] a new instance of TouchAction -- -##### [move_to](https://github.com/appium/ruby_lib/blob/3ed875cc01ba7f670e9b1b8ccfd7b7adb0af82c1/lib/appium_lib/device/touch_actions.rb#L37) +##### [move_to](https://github.com/appium/ruby_lib/blob/8cc004ad04ec087a8a11c06ca0749a5e2c6586a7/lib/appium_lib/device/touch_actions.rb#L37) > def move_to(opts) Move to the given co-ordinates. @@ -731,11 +893,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Hash] opts - a customizable set of options -- -##### [long_press](https://github.com/appium/ruby_lib/blob/3ed875cc01ba7f670e9b1b8ccfd7b7adb0af82c1/lib/appium_lib/device/touch_actions.rb#L47) +##### [long_press](https://github.com/appium/ruby_lib/blob/8cc004ad04ec087a8a11c06ca0749a5e2c6586a7/lib/appium_lib/device/touch_actions.rb#L47) > def long_press(opts) Press down for a specific duration. @@ -749,11 +911,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Hash] duration - a customizable set of options -- -##### [press](https://github.com/appium/ruby_lib/blob/3ed875cc01ba7f670e9b1b8ccfd7b7adb0af82c1/lib/appium_lib/device/touch_actions.rb#L59) +##### [press](https://github.com/appium/ruby_lib/blob/8cc004ad04ec087a8a11c06ca0749a5e2c6586a7/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`. @@ -762,11 +924,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Hash] opts - a customizable set of options -- -##### [release](https://github.com/appium/ruby_lib/blob/3ed875cc01ba7f670e9b1b8ccfd7b7adb0af82c1/lib/appium_lib/device/touch_actions.rb#L70) +##### [release](https://github.com/appium/ruby_lib/blob/8cc004ad04ec087a8a11c06ca0749a5e2c6586a7/lib/appium_lib/device/touch_actions.rb#L70) > def release(opts=nil) Remove a finger from the screen. @@ -774,11 +936,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Hash] opts - a customizable set of options -- -##### [tap](https://github.com/appium/ruby_lib/blob/3ed875cc01ba7f670e9b1b8ccfd7b7adb0af82c1/lib/appium_lib/device/touch_actions.rb#L81) +##### [tap](https://github.com/appium/ruby_lib/blob/8cc004ad04ec087a8a11c06ca0749a5e2c6586a7/lib/appium_lib/device/touch_actions.rb#L81) > def tap(opts) Touch a point on the screen @@ -786,11 +948,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Hash] opts - a customizable set of options -- -##### [wait](https://github.com/appium/ruby_lib/blob/3ed875cc01ba7f670e9b1b8ccfd7b7adb0af82c1/lib/appium_lib/device/touch_actions.rb#L90) +##### [wait](https://github.com/appium/ruby_lib/blob/8cc004ad04ec087a8a11c06ca0749a5e2c6586a7/lib/appium_lib/device/touch_actions.rb#L90) > def wait(milliseconds) Pause for a number of milliseconds before the next action @@ -798,11 +960,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[integer] milliseconds - Number of milliseconds to pause for -- -##### [swipe](https://github.com/appium/ruby_lib/blob/3ed875cc01ba7f670e9b1b8ccfd7b7adb0af82c1/lib/appium_lib/device/touch_actions.rb#L101) +##### [swipe](https://github.com/appium/ruby_lib/blob/8cc004ad04ec087a8a11c06ca0749a5e2c6586a7/lib/appium_lib/device/touch_actions.rb#L101) > def swipe(opts) Convenience method to peform a swipe. @@ -810,43 +972,43 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Hash] opts - a customizable set of options -- -##### [perform](https://github.com/appium/ruby_lib/blob/3ed875cc01ba7f670e9b1b8ccfd7b7adb0af82c1/lib/appium_lib/device/touch_actions.rb#L116) +##### [perform](https://github.com/appium/ruby_lib/blob/8cc004ad04ec087a8a11c06ca0749a5e2c6586a7/lib/appium_lib/device/touch_actions.rb#L116) > def perform Ask the driver to perform all actions in this action chain. -- -##### [cancel](https://github.com/appium/ruby_lib/blob/3ed875cc01ba7f670e9b1b8ccfd7b7adb0af82c1/lib/appium_lib/device/touch_actions.rb#L122) +##### [cancel](https://github.com/appium/ruby_lib/blob/8cc004ad04ec087a8a11c06ca0749a5e2c6586a7/lib/appium_lib/device/touch_actions.rb#L122) > def cancel Does nothing, currently. -- -##### [chain_method](https://github.com/appium/ruby_lib/blob/3ed875cc01ba7f670e9b1b8ccfd7b7adb0af82c1/lib/appium_lib/device/touch_actions.rb#L130) +##### [chain_method](https://github.com/appium/ruby_lib/blob/8cc004ad04ec087a8a11c06ca0749a5e2c6586a7/lib/appium_lib/device/touch_actions.rb#L130) > def chain_method(method, args=nil) -- -##### [args_with_ele_ref](https://github.com/appium/ruby_lib/blob/3ed875cc01ba7f670e9b1b8ccfd7b7adb0af82c1/lib/appium_lib/device/touch_actions.rb#L139) +##### [args_with_ele_ref](https://github.com/appium/ruby_lib/blob/8cc004ad04ec087a8a11c06ca0749a5e2c6586a7/lib/appium_lib/device/touch_actions.rb#L139) > def args_with_ele_ref(args) -- -##### [wait](https://github.com/appium/ruby_lib/blob/3ed875cc01ba7f670e9b1b8ccfd7b7adb0af82c1/lib/appium_lib/common/helper.rb#L33) +##### [wait](https://github.com/appium/ruby_lib/blob/8cc004ad04ec087a8a11c06ca0749a5e2c6586a7/lib/appium_lib/common/helper.rb#L33) > def wait max_wait=30, interval=0.5, &block Check every 0.5 seconds to see if block.call doesn't raise an exception. if .call raises an exception then it will be tried again. @@ -869,19 +1031,19 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Object] the result of block.call -- -##### [ignore](https://github.com/appium/ruby_lib/blob/3ed875cc01ba7f670e9b1b8ccfd7b7adb0af82c1/lib/appium_lib/common/helper.rb#L54) +##### [ignore](https://github.com/appium/ruby_lib/blob/8cc004ad04ec087a8a11c06ca0749a5e2c6586a7/lib/appium_lib/common/helper.rb#L54) > def ignore &block Return block.call and ignore any exceptions. -- -##### [wait_true](https://github.com/appium/ruby_lib/blob/3ed875cc01ba7f670e9b1b8ccfd7b7adb0af82c1/lib/appium_lib/common/helper.rb#L69) +##### [wait_true](https://github.com/appium/ruby_lib/blob/8cc004ad04ec087a8a11c06ca0749a5e2c6586a7/lib/appium_lib/common/helper.rb#L69) > def wait_true max_wait=30, interval=0.5, &block Check every 0.5 seconds to see if block.call returns a truthy value. Note this isn't a strict boolean true, any truthy value is accepted. @@ -900,11 +1062,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Object] the result of block.call -- -##### [back](https://github.com/appium/ruby_lib/blob/3ed875cc01ba7f670e9b1b8ccfd7b7adb0af82c1/lib/appium_lib/common/helper.rb#L89) +##### [back](https://github.com/appium/ruby_lib/blob/8cc004ad04ec087a8a11c06ca0749a5e2c6586a7/lib/appium_lib/common/helper.rb#L89) > def back Navigate back. @@ -912,19 +1074,19 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[void] -- -##### [session_id](https://github.com/appium/ruby_lib/blob/3ed875cc01ba7f670e9b1b8ccfd7b7adb0af82c1/lib/appium_lib/common/helper.rb#L94) +##### [session_id](https://github.com/appium/ruby_lib/blob/8cc004ad04ec087a8a11c06ca0749a5e2c6586a7/lib/appium_lib/common/helper.rb#L94) > def session_id For Sauce Labs reporting. Returns the current session id. -- -##### [xpath](https://github.com/appium/ruby_lib/blob/3ed875cc01ba7f670e9b1b8ccfd7b7adb0af82c1/lib/appium_lib/common/helper.rb#L102) +##### [xpath](https://github.com/appium/ruby_lib/blob/8cc004ad04ec087a8a11c06ca0749a5e2c6586a7/lib/appium_lib/common/helper.rb#L102) > def xpath xpath_str Returns the first element that matches the provided xpath. @@ -936,11 +1098,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Element] -- -##### [xpaths](https://github.com/appium/ruby_lib/blob/3ed875cc01ba7f670e9b1b8ccfd7b7adb0af82c1/lib/appium_lib/common/helper.rb#L110) +##### [xpaths](https://github.com/appium/ruby_lib/blob/8cc004ad04ec087a8a11c06ca0749a5e2c6586a7/lib/appium_lib/common/helper.rb#L110) > def xpaths xpath_str Returns all elements that match the provided xpath. @@ -952,11 +1114,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Array<Element>] -- -##### [source](https://github.com/appium/ruby_lib/blob/3ed875cc01ba7f670e9b1b8ccfd7b7adb0af82c1/lib/appium_lib/common/helper.rb#L116) +##### [source](https://github.com/appium/ruby_lib/blob/8cc004ad04ec087a8a11c06ca0749a5e2c6586a7/lib/appium_lib/common/helper.rb#L116) > def source Prints xml of the current page @@ -964,11 +1126,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[void] -- -##### [get_source](https://github.com/appium/ruby_lib/blob/3ed875cc01ba7f670e9b1b8ccfd7b7adb0af82c1/lib/appium_lib/common/helper.rb#L134) +##### [get_source](https://github.com/appium/ruby_lib/blob/8cc004ad04ec087a8a11c06ca0749a5e2c6586a7/lib/appium_lib/common/helper.rb#L134) > def get_source Returns XML string for the current page Same as driver.page_source @@ -977,19 +1139,19 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[String] -- -##### [result](https://github.com/appium/ruby_lib/blob/3ed875cc01ba7f670e9b1b8ccfd7b7adb0af82c1/lib/appium_lib/common/helper.rb#L141) +##### [result](https://github.com/appium/ruby_lib/blob/8cc004ad04ec087a8a11c06ca0749a5e2c6586a7/lib/appium_lib/common/helper.rb#L141) > def result Returns the value of attribute result -- -##### [initialize](https://github.com/appium/ruby_lib/blob/3ed875cc01ba7f670e9b1b8ccfd7b7adb0af82c1/lib/appium_lib/common/helper.rb#L143) +##### [initialize](https://github.com/appium/ruby_lib/blob/8cc004ad04ec087a8a11c06ca0749a5e2c6586a7/lib/appium_lib/common/helper.rb#L143) > def initialize @@ -997,52 +1159,52 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[CountElements] a new instance of CountElements -- -##### [reset](https://github.com/appium/ruby_lib/blob/3ed875cc01ba7f670e9b1b8ccfd7b7adb0af82c1/lib/appium_lib/common/helper.rb#L147) +##### [reset](https://github.com/appium/ruby_lib/blob/8cc004ad04ec087a8a11c06ca0749a5e2c6586a7/lib/appium_lib/common/helper.rb#L147) > def reset -- -##### [start_element](https://github.com/appium/ruby_lib/blob/3ed875cc01ba7f670e9b1b8ccfd7b7adb0af82c1/lib/appium_lib/common/helper.rb#L152) +##### [start_element](https://github.com/appium/ruby_lib/blob/8cc004ad04ec087a8a11c06ca0749a5e2c6586a7/lib/appium_lib/common/helper.rb#L152) > def start_element name, attrs = [] http://nokogiri.org/Nokogiri/XML/SAX/Document.html -- -##### [formatted_result](https://github.com/appium/ruby_lib/blob/3ed875cc01ba7f670e9b1b8ccfd7b7adb0af82c1/lib/appium_lib/common/helper.rb#L158) +##### [formatted_result](https://github.com/appium/ruby_lib/blob/8cc004ad04ec087a8a11c06ca0749a5e2c6586a7/lib/appium_lib/common/helper.rb#L158) > def formatted_result -- -##### [get_page_class](https://github.com/appium/ruby_lib/blob/3ed875cc01ba7f670e9b1b8ccfd7b7adb0af82c1/lib/appium_lib/common/helper.rb#L169) +##### [get_page_class](https://github.com/appium/ruby_lib/blob/8cc004ad04ec087a8a11c06ca0749a5e2c6586a7/lib/appium_lib/common/helper.rb#L169) > def get_page_class Returns a string of class counts of visible elements. -- -##### [page_class](https://github.com/appium/ruby_lib/blob/3ed875cc01ba7f670e9b1b8ccfd7b7adb0af82c1/lib/appium_lib/common/helper.rb#L180) +##### [page_class](https://github.com/appium/ruby_lib/blob/8cc004ad04ec087a8a11c06ca0749a5e2c6586a7/lib/appium_lib/common/helper.rb#L180) > 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/3ed875cc01ba7f670e9b1b8ccfd7b7adb0af82c1/lib/appium_lib/common/helper.rb#L190) +##### [px_to_window_rel](https://github.com/appium/ruby_lib/blob/8cc004ad04ec087a8a11c06ca0749a5e2c6586a7/lib/appium_lib/common/helper.rb#L190) > def px_to_window_rel opts={} Converts pixel values to window relative values @@ -1050,11 +1212,11 @@ px_to_window_rel x: 50, y: 150 ``` -- -##### [xml_keys](https://github.com/appium/ruby_lib/blob/3ed875cc01ba7f670e9b1b8ccfd7b7adb0af82c1/lib/appium_lib/common/helper.rb#L207) +##### [xml_keys](https://github.com/appium/ruby_lib/blob/8cc004ad04ec087a8a11c06ca0749a5e2c6586a7/lib/appium_lib/common/helper.rb#L207) > def xml_keys target Search strings.xml's values for target. @@ -1066,11 +1228,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Array] -- -##### [xml_values](https://github.com/appium/ruby_lib/blob/3ed875cc01ba7f670e9b1b8ccfd7b7adb0af82c1/lib/appium_lib/common/helper.rb#L215) +##### [xml_values](https://github.com/appium/ruby_lib/blob/8cc004ad04ec087a8a11c06ca0749a5e2c6586a7/lib/appium_lib/common/helper.rb#L215) > def xml_values target Search strings.xml's keys for target. @@ -1082,11 +1244,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Array] -- -##### [resolve_id](https://github.com/appium/ruby_lib/blob/3ed875cc01ba7f670e9b1b8ccfd7b7adb0af82c1/lib/appium_lib/common/helper.rb#L223) +##### [resolve_id](https://github.com/appium/ruby_lib/blob/8cc004ad04ec087a8a11c06ca0749a5e2c6586a7/lib/appium_lib/common/helper.rb#L223) > def resolve_id id Resolve id in strings.xml and return the value. @@ -1098,27 +1260,27 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[String] -- -##### [filter](https://github.com/appium/ruby_lib/blob/3ed875cc01ba7f670e9b1b8ccfd7b7adb0af82c1/lib/appium_lib/common/helper.rb#L229) +##### [filter](https://github.com/appium/ruby_lib/blob/8cc004ad04ec087a8a11c06ca0749a5e2c6586a7/lib/appium_lib/common/helper.rb#L229) > def filter -- -##### [filter=](https://github.com/appium/ruby_lib/blob/3ed875cc01ba7f670e9b1b8ccfd7b7adb0af82c1/lib/appium_lib/common/helper.rb#L234) +##### [filter=](https://github.com/appium/ruby_lib/blob/8cc004ad04ec087a8a11c06ca0749a5e2c6586a7/lib/appium_lib/common/helper.rb#L234) > def filter= value convert to string to support symbols -- -##### [initialize](https://github.com/appium/ruby_lib/blob/3ed875cc01ba7f670e9b1b8ccfd7b7adb0af82c1/lib/appium_lib/common/helper.rb#L240) +##### [initialize](https://github.com/appium/ruby_lib/blob/8cc004ad04ec087a8a11c06ca0749a5e2c6586a7/lib/appium_lib/common/helper.rb#L240) > def initialize @@ -1126,91 +1288,99 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[HTMLElements] a new instance of HTMLElements -- -##### [reset](https://github.com/appium/ruby_lib/blob/3ed875cc01ba7f670e9b1b8ccfd7b7adb0af82c1/lib/appium_lib/common/helper.rb#L245) +##### [reset](https://github.com/appium/ruby_lib/blob/8cc004ad04ec087a8a11c06ca0749a5e2c6586a7/lib/appium_lib/common/helper.rb#L245) > def reset -- -##### [result](https://github.com/appium/ruby_lib/blob/3ed875cc01ba7f670e9b1b8ccfd7b7adb0af82c1/lib/appium_lib/common/helper.rb#L251) +##### [result](https://github.com/appium/ruby_lib/blob/8cc004ad04ec087a8a11c06ca0749a5e2c6586a7/lib/appium_lib/common/helper.rb#L251) > def result -- -##### [start_element](https://github.com/appium/ruby_lib/blob/3ed875cc01ba7f670e9b1b8ccfd7b7adb0af82c1/lib/appium_lib/common/helper.rb#L265) +##### [start_element](https://github.com/appium/ruby_lib/blob/8cc004ad04ec087a8a11c06ca0749a5e2c6586a7/lib/appium_lib/common/helper.rb#L265) > def start_element name, attrs = [] -- -##### [end_element](https://github.com/appium/ruby_lib/blob/3ed875cc01ba7f670e9b1b8ccfd7b7adb0af82c1/lib/appium_lib/common/helper.rb#L275) +##### [end_element](https://github.com/appium/ruby_lib/blob/8cc004ad04ec087a8a11c06ca0749a5e2c6586a7/lib/appium_lib/common/helper.rb#L275) > def end_element name -- -##### [characters](https://github.com/appium/ruby_lib/blob/3ed875cc01ba7f670e9b1b8ccfd7b7adb0af82c1/lib/appium_lib/common/helper.rb#L281) +##### [characters](https://github.com/appium/ruby_lib/blob/8cc004ad04ec087a8a11c06ca0749a5e2c6586a7/lib/appium_lib/common/helper.rb#L281) > def characters(chars) -- -##### [window_size](https://github.com/appium/ruby_lib/blob/3ed875cc01ba7f670e9b1b8ccfd7b7adb0af82c1/lib/appium_lib/common/element/window.rb#L5) +##### [window_size](https://github.com/appium/ruby_lib/blob/8cc004ad04ec087a8a11c06ca0749a5e2c6586a7/lib/appium_lib/common/element/window.rb#L5) > def window_size Get the window's size -- -##### [result](https://github.com/appium/ruby_lib/blob/3ed875cc01ba7f670e9b1b8ccfd7b7adb0af82c1/lib/appium_lib/android/helper.rb#L7) android +##### [result](https://github.com/appium/ruby_lib/blob/8cc004ad04ec087a8a11c06ca0749a5e2c6586a7/lib/appium_lib/android/helper.rb#L6) android > def result -TODO: Support strings.xml ids +Returns the value of attribute result -- -##### [keys](https://github.com/appium/ruby_lib/blob/3ed875cc01ba7f670e9b1b8ccfd7b7adb0af82c1/lib/appium_lib/android/helper.rb#L7) android +##### [keys](https://github.com/appium/ruby_lib/blob/8cc004ad04ec087a8a11c06ca0749a5e2c6586a7/lib/appium_lib/android/helper.rb#L6) android > def keys -TODO: Support strings.xml ids +Returns the value of attribute keys -- -##### [filter](https://github.com/appium/ruby_lib/blob/3ed875cc01ba7f670e9b1b8ccfd7b7adb0af82c1/lib/appium_lib/android/helper.rb#L9) android +##### [instance](https://github.com/appium/ruby_lib/blob/8cc004ad04ec087a8a11c06ca0749a5e2c6586a7/lib/appium_lib/android/helper.rb#L6) android +> def instance + +Returns the value of attribute instance + +-- + +##### [filter](https://github.com/appium/ruby_lib/blob/8cc004ad04ec087a8a11c06ca0749a5e2c6586a7/lib/appium_lib/android/helper.rb#L8) android + > def filter -- -##### [filter=](https://github.com/appium/ruby_lib/blob/3ed875cc01ba7f670e9b1b8ccfd7b7adb0af82c1/lib/appium_lib/android/helper.rb#L14) android +##### [filter=](https://github.com/appium/ruby_lib/blob/8cc004ad04ec087a8a11c06ca0749a5e2c6586a7/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/3ed875cc01ba7f670e9b1b8ccfd7b7adb0af82c1/lib/appium_lib/android/helper.rb#L20) android +##### [initialize](https://github.com/appium/ruby_lib/blob/8cc004ad04ec087a8a11c06ca0749a5e2c6586a7/lib/appium_lib/android/helper.rb#L19) android > def initialize @@ -1218,27 +1388,27 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[AndroidElements] a new instance of AndroidElements -- -##### [reset](https://github.com/appium/ruby_lib/blob/3ed875cc01ba7f670e9b1b8ccfd7b7adb0af82c1/lib/appium_lib/android/helper.rb#L25) android +##### [reset](https://github.com/appium/ruby_lib/blob/8cc004ad04ec087a8a11c06ca0749a5e2c6586a7/lib/appium_lib/android/helper.rb#L25) android > def reset -- -##### [start_element](https://github.com/appium/ruby_lib/blob/3ed875cc01ba7f670e9b1b8ccfd7b7adb0af82c1/lib/appium_lib/android/helper.rb#L31) android +##### [start_element](https://github.com/appium/ruby_lib/blob/8cc004ad04ec087a8a11c06ca0749a5e2c6586a7/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/3ed875cc01ba7f670e9b1b8ccfd7b7adb0af82c1/lib/appium_lib/android/helper.rb#L88) android +##### [get_android_inspect](https://github.com/appium/ruby_lib/blob/8cc004ad04ec087a8a11c06ca0749a5e2c6586a7/lib/appium_lib/android/helper.rb#L92) android > def get_android_inspect class_name=false Android only. Returns a string containing interesting elements. @@ -1253,11 +1423,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[String] -- -##### [page](https://github.com/appium/ruby_lib/blob/3ed875cc01ba7f670e9b1b8ccfd7b7adb0af82c1/lib/appium_lib/android/helper.rb#L107) android +##### [page](https://github.com/appium/ruby_lib/blob/8cc004ad04ec087a8a11c06ca0749a5e2c6586a7/lib/appium_lib/android/helper.rb#L113) android > def page opts={} Intended for use with console. Inspects and prints the current page. @@ -1272,20 +1442,20 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[void] -- -##### [current_app](https://github.com/appium/ruby_lib/blob/3ed875cc01ba7f670e9b1b8ccfd7b7adb0af82c1/lib/appium_lib/android/helper.rb#L118) android +##### [current_app](https://github.com/appium/ruby_lib/blob/8cc004ad04ec087a8a11c06ca0749a5e2c6586a7/lib/appium_lib/android/helper.rb#L124) 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/3ed875cc01ba7f670e9b1b8ccfd7b7adb0af82c1/lib/appium_lib/android/helper.rb#L142) android +##### [id](https://github.com/appium/ruby_lib/blob/8cc004ad04ec087a8a11c06ca0749a5e2c6586a7/lib/appium_lib/android/helper.rb#L148) android > def id id Find the first matching element by id @@ -1297,11 +1467,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Element] -- -##### [ids](https://github.com/appium/ruby_lib/blob/3ed875cc01ba7f670e9b1b8ccfd7b7adb0af82c1/lib/appium_lib/android/helper.rb#L150) android +##### [ids](https://github.com/appium/ruby_lib/blob/8cc004ad04ec087a8a11c06ca0749a5e2c6586a7/lib/appium_lib/android/helper.rb#L156) android > def ids id Find all matching elements by id @@ -1313,11 +1483,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Element] -- -##### [ele_index](https://github.com/appium/ruby_lib/blob/3ed875cc01ba7f670e9b1b8ccfd7b7adb0af82c1/lib/appium_lib/android/helper.rb#L159) android +##### [ele_index](https://github.com/appium/ruby_lib/blob/8cc004ad04ec087a8a11c06ca0749a5e2c6586a7/lib/appium_lib/android/helper.rb#L165) android > def ele_index class_name, index Find the element of type class_name at matching index. @@ -1331,11 +1501,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Element] the found element of type class_name -- -##### [first_ele](https://github.com/appium/ruby_lib/blob/3ed875cc01ba7f670e9b1b8ccfd7b7adb0af82c1/lib/appium_lib/android/helper.rb#L173) android +##### [first_ele](https://github.com/appium/ruby_lib/blob/8cc004ad04ec087a8a11c06ca0749a5e2c6586a7/lib/appium_lib/android/helper.rb#L183) android > def first_ele class_name Find the first element that matches class_name @@ -1347,11 +1517,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Element] -- -##### [last_ele](https://github.com/appium/ruby_lib/blob/3ed875cc01ba7f670e9b1b8ccfd7b7adb0af82c1/lib/appium_lib/android/helper.rb#L180) android +##### [last_ele](https://github.com/appium/ruby_lib/blob/8cc004ad04ec087a8a11c06ca0749a5e2c6586a7/lib/appium_lib/android/helper.rb#L190) android > def last_ele class_name Find the last element that matches class_name @@ -1363,11 +1533,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Element] -- -##### [tag](https://github.com/appium/ruby_lib/blob/3ed875cc01ba7f670e9b1b8ccfd7b7adb0af82c1/lib/appium_lib/android/helper.rb#L188) android +##### [tag](https://github.com/appium/ruby_lib/blob/8cc004ad04ec087a8a11c06ca0749a5e2c6586a7/lib/appium_lib/android/helper.rb#L198) android > def tag class_name Find the first element of type class_name @@ -1379,11 +1549,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Element] -- -##### [tags](https://github.com/appium/ruby_lib/blob/3ed875cc01ba7f670e9b1b8ccfd7b7adb0af82c1/lib/appium_lib/android/helper.rb#L196) android +##### [tags](https://github.com/appium/ruby_lib/blob/8cc004ad04ec087a8a11c06ca0749a5e2c6586a7/lib/appium_lib/android/helper.rb#L206) android > def tags class_name Find all elements of type class_name @@ -1395,11 +1565,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Element] -- -##### [complex_find_contains](https://github.com/appium/ruby_lib/blob/3ed875cc01ba7f670e9b1b8ccfd7b7adb0af82c1/lib/appium_lib/android/helper.rb#L241) android +##### [complex_find_contains](https://github.com/appium/ruby_lib/blob/8cc004ad04ec087a8a11c06ca0749a5e2c6586a7/lib/appium_lib/android/helper.rb#L238) android > def complex_find_contains element, value Find the first element that contains value @@ -1413,11 +1583,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Element] -- -##### [complex_finds_contains](https://github.com/appium/ruby_lib/blob/3ed875cc01ba7f670e9b1b8ccfd7b7adb0af82c1/lib/appium_lib/android/helper.rb#L249) android +##### [complex_finds_contains](https://github.com/appium/ruby_lib/blob/8cc004ad04ec087a8a11c06ca0749a5e2c6586a7/lib/appium_lib/android/helper.rb#L246) android > def complex_finds_contains element, value Find all elements containing value @@ -1431,11 +1601,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Array<Element>] -- -##### [complex_find_exact](https://github.com/appium/ruby_lib/blob/3ed875cc01ba7f670e9b1b8ccfd7b7adb0af82c1/lib/appium_lib/android/helper.rb#L289) android +##### [complex_find_exact](https://github.com/appium/ruby_lib/blob/8cc004ad04ec087a8a11c06ca0749a5e2c6586a7/lib/appium_lib/android/helper.rb#L275) android > def complex_find_exact class_name, value Find the first element exactly matching value @@ -1449,11 +1619,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Element] -- -##### [complex_finds_exact](https://github.com/appium/ruby_lib/blob/3ed875cc01ba7f670e9b1b8ccfd7b7adb0af82c1/lib/appium_lib/android/helper.rb#L297) android +##### [complex_finds_exact](https://github.com/appium/ruby_lib/blob/8cc004ad04ec087a8a11c06ca0749a5e2c6586a7/lib/appium_lib/android/helper.rb#L283) android > def complex_finds_exact class_name, value Find all elements exactly matching value @@ -1467,19 +1637,19 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Element] -- -##### [TextView](https://github.com/appium/ruby_lib/blob/3ed875cc01ba7f670e9b1b8ccfd7b7adb0af82c1/lib/appium_lib/android/element/text.rb#L4) android +##### [TextView](https://github.com/appium/ruby_lib/blob/8cc004ad04ec087a8a11c06ca0749a5e2c6586a7/lib/appium_lib/android/element/text.rb#L4) android > TextView = 'android.widget.TextView' -- -##### [text](https://github.com/appium/ruby_lib/blob/3ed875cc01ba7f670e9b1b8ccfd7b7adb0af82c1/lib/appium_lib/android/element/text.rb#L10) android +##### [text](https://github.com/appium/ruby_lib/blob/8cc004ad04ec087a8a11c06ca0749a5e2c6586a7/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. @@ -1492,11 +1662,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[TextView] -- -##### [texts](https://github.com/appium/ruby_lib/blob/3ed875cc01ba7f670e9b1b8ccfd7b7adb0af82c1/lib/appium_lib/android/element/text.rb#L19) android +##### [texts](https://github.com/appium/ruby_lib/blob/8cc004ad04ec087a8a11c06ca0749a5e2c6586a7/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. @@ -1509,11 +1679,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Array<TextView>] -- -##### [first_text](https://github.com/appium/ruby_lib/blob/3ed875cc01ba7f670e9b1b8ccfd7b7adb0af82c1/lib/appium_lib/android/element/text.rb#L26) android +##### [first_text](https://github.com/appium/ruby_lib/blob/8cc004ad04ec087a8a11c06ca0749a5e2c6586a7/lib/appium_lib/android/element/text.rb#L26) android > def first_text Find the first TextView. @@ -1521,11 +1691,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[TextView] -- -##### [last_text](https://github.com/appium/ruby_lib/blob/3ed875cc01ba7f670e9b1b8ccfd7b7adb0af82c1/lib/appium_lib/android/element/text.rb#L32) android +##### [last_text](https://github.com/appium/ruby_lib/blob/8cc004ad04ec087a8a11c06ca0749a5e2c6586a7/lib/appium_lib/android/element/text.rb#L32) android > def last_text Find the last TextView. @@ -1533,11 +1703,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[TextView] -- -##### [text_exact](https://github.com/appium/ruby_lib/blob/3ed875cc01ba7f670e9b1b8ccfd7b7adb0af82c1/lib/appium_lib/android/element/text.rb#L39) android +##### [text_exact](https://github.com/appium/ruby_lib/blob/8cc004ad04ec087a8a11c06ca0749a5e2c6586a7/lib/appium_lib/android/element/text.rb#L39) android > def text_exact value Find the first TextView that exactly matches value. @@ -1549,11 +1719,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[TextView] -- -##### [texts_exact](https://github.com/appium/ruby_lib/blob/3ed875cc01ba7f670e9b1b8ccfd7b7adb0af82c1/lib/appium_lib/android/element/text.rb#L46) android +##### [texts_exact](https://github.com/appium/ruby_lib/blob/8cc004ad04ec087a8a11c06ca0749a5e2c6586a7/lib/appium_lib/android/element/text.rb#L46) android > def texts_exact value Find all TextViews that exactly match value. @@ -1565,11 +1735,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Array<TextView>] -- -##### [alert_click](https://github.com/appium/ruby_lib/blob/3ed875cc01ba7f670e9b1b8ccfd7b7adb0af82c1/lib/appium_lib/android/element/alert.rb#L6) android +##### [alert_click](https://github.com/appium/ruby_lib/blob/8cc004ad04ec087a8a11c06ca0749a5e2c6586a7/lib/appium_lib/android/element/alert.rb#L6) android > def alert_click value Click the first alert button that contains value or by index. @@ -1581,11 +1751,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[void] -- -##### [alert_accept](https://github.com/appium/ruby_lib/blob/3ed875cc01ba7f670e9b1b8ccfd7b7adb0af82c1/lib/appium_lib/android/element/alert.rb#L13) android +##### [alert_accept](https://github.com/appium/ruby_lib/blob/8cc004ad04ec087a8a11c06ca0749a5e2c6586a7/lib/appium_lib/android/element/alert.rb#L13) android > def alert_accept Accept the alert. The last button is considered "accept." @@ -1594,11 +1764,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[void] -- -##### [alert_accept_text](https://github.com/appium/ruby_lib/blob/3ed875cc01ba7f670e9b1b8ccfd7b7adb0af82c1/lib/appium_lib/android/element/alert.rb#L20) android +##### [alert_accept_text](https://github.com/appium/ruby_lib/blob/8cc004ad04ec087a8a11c06ca0749a5e2c6586a7/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." @@ -1607,11 +1777,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[String] -- -##### [alert_dismiss](https://github.com/appium/ruby_lib/blob/3ed875cc01ba7f670e9b1b8ccfd7b7adb0af82c1/lib/appium_lib/android/element/alert.rb#L27) android +##### [alert_dismiss](https://github.com/appium/ruby_lib/blob/8cc004ad04ec087a8a11c06ca0749a5e2c6586a7/lib/appium_lib/android/element/alert.rb#L27) android > def alert_dismiss Dismiss the alert. The first button is considered "dismiss." @@ -1620,11 +1790,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[void] -- -##### [alert_dismiss_text](https://github.com/appium/ruby_lib/blob/3ed875cc01ba7f670e9b1b8ccfd7b7adb0af82c1/lib/appium_lib/android/element/alert.rb#L34) android +##### [alert_dismiss_text](https://github.com/appium/ruby_lib/blob/8cc004ad04ec087a8a11c06ca0749a5e2c6586a7/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." @@ -1633,11 +1803,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[String] -- -##### [uiautomator_find](https://github.com/appium/ruby_lib/blob/3ed875cc01ba7f670e9b1b8ccfd7b7adb0af82c1/lib/appium_lib/android/mobile_methods.rb#L10) android +##### [uiautomator_find](https://github.com/appium/ruby_lib/blob/8cc004ad04ec087a8a11c06ca0749a5e2c6586a7/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). @@ -1645,27 +1815,27 @@ find_elements :uiautomator, 'new UiSelector().clickable(true)' ``` -- -##### [Button](https://github.com/appium/ruby_lib/blob/3ed875cc01ba7f670e9b1b8ccfd7b7adb0af82c1/lib/appium_lib/android/element/button.rb#L4) android +##### [Button](https://github.com/appium/ruby_lib/blob/8cc004ad04ec087a8a11c06ca0749a5e2c6586a7/lib/appium_lib/android/element/button.rb#L4) android > Button = 'android.widget.Button' -- -##### [ImageButton](https://github.com/appium/ruby_lib/blob/3ed875cc01ba7f670e9b1b8ccfd7b7adb0af82c1/lib/appium_lib/android/element/button.rb#L5) android +##### [ImageButton](https://github.com/appium/ruby_lib/blob/8cc004ad04ec087a8a11c06ca0749a5e2c6586a7/lib/appium_lib/android/element/button.rb#L5) android > ImageButton = 'android.widget.ImageButton' -- -##### [button](https://github.com/appium/ruby_lib/blob/3ed875cc01ba7f670e9b1b8ccfd7b7adb0af82c1/lib/appium_lib/android/element/button.rb#L55) android +##### [button](https://github.com/appium/ruby_lib/blob/8cc004ad04ec087a8a11c06ca0749a5e2c6586a7/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. @@ -1678,11 +1848,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Button] -- -##### [buttons](https://github.com/appium/ruby_lib/blob/3ed875cc01ba7f670e9b1b8ccfd7b7adb0af82c1/lib/appium_lib/android/element/button.rb#L72) android +##### [buttons](https://github.com/appium/ruby_lib/blob/8cc004ad04ec087a8a11c06ca0749a5e2c6586a7/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. @@ -1695,11 +1865,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Array<Button>] -- -##### [first_button](https://github.com/appium/ruby_lib/blob/3ed875cc01ba7f670e9b1b8ccfd7b7adb0af82c1/lib/appium_lib/android/element/button.rb#L79) android +##### [first_button](https://github.com/appium/ruby_lib/blob/8cc004ad04ec087a8a11c06ca0749a5e2c6586a7/lib/appium_lib/android/element/button.rb#L67) android > def first_button Find the first button. @@ -1707,11 +1877,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Button] -- -##### [last_button](https://github.com/appium/ruby_lib/blob/3ed875cc01ba7f670e9b1b8ccfd7b7adb0af82c1/lib/appium_lib/android/element/button.rb#L85) android +##### [last_button](https://github.com/appium/ruby_lib/blob/8cc004ad04ec087a8a11c06ca0749a5e2c6586a7/lib/appium_lib/android/element/button.rb#L73) android > def last_button Find the last button. @@ -1719,11 +1889,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Button] -- -##### [button_exact](https://github.com/appium/ruby_lib/blob/3ed875cc01ba7f670e9b1b8ccfd7b7adb0af82c1/lib/appium_lib/android/element/button.rb#L99) android +##### [button_exact](https://github.com/appium/ruby_lib/blob/8cc004ad04ec087a8a11c06ca0749a5e2c6586a7/lib/appium_lib/android/element/button.rb#L89) android > def button_exact value Find the first button that exactly matches value. @@ -1735,11 +1905,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Button] -- -##### [buttons_exact](https://github.com/appium/ruby_lib/blob/3ed875cc01ba7f670e9b1b8ccfd7b7adb0af82c1/lib/appium_lib/android/element/button.rb#L106) android +##### [buttons_exact](https://github.com/appium/ruby_lib/blob/8cc004ad04ec087a8a11c06ca0749a5e2c6586a7/lib/appium_lib/android/element/button.rb#L96) android > def buttons_exact value Find all buttons that exactly match value. @@ -1751,11 +1921,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Array<Button>] -- -##### [find](https://github.com/appium/ruby_lib/blob/3ed875cc01ba7f670e9b1b8ccfd7b7adb0af82c1/lib/appium_lib/android/element/generic.rb#L7) android +##### [find](https://github.com/appium/ruby_lib/blob/8cc004ad04ec087a8a11c06ca0749a5e2c6586a7/lib/appium_lib/android/element/generic.rb#L7) android > def find value Find the first element containing value @@ -1767,11 +1937,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Element] -- -##### [finds](https://github.com/appium/ruby_lib/blob/3ed875cc01ba7f670e9b1b8ccfd7b7adb0af82c1/lib/appium_lib/android/element/generic.rb#L14) android +##### [finds](https://github.com/appium/ruby_lib/blob/8cc004ad04ec087a8a11c06ca0749a5e2c6586a7/lib/appium_lib/android/element/generic.rb#L14) android > def finds value Find all elements containing value @@ -1783,11 +1953,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Array<Element>] -- -##### [find_exact](https://github.com/appium/ruby_lib/blob/3ed875cc01ba7f670e9b1b8ccfd7b7adb0af82c1/lib/appium_lib/android/element/generic.rb#L21) android +##### [find_exact](https://github.com/appium/ruby_lib/blob/8cc004ad04ec087a8a11c06ca0749a5e2c6586a7/lib/appium_lib/android/element/generic.rb#L21) android > def find_exact value Find the first element exactly matching value @@ -1799,11 +1969,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Element] -- -##### [finds_exact](https://github.com/appium/ruby_lib/blob/3ed875cc01ba7f670e9b1b8ccfd7b7adb0af82c1/lib/appium_lib/android/element/generic.rb#L28) android +##### [finds_exact](https://github.com/appium/ruby_lib/blob/8cc004ad04ec087a8a11c06ca0749a5e2c6586a7/lib/appium_lib/android/element/generic.rb#L28) android > def finds_exact value Find all elements exactly matching value @@ -1815,11 +1985,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Array<Element>] -- -##### [scroll_to](https://github.com/appium/ruby_lib/blob/3ed875cc01ba7f670e9b1b8ccfd7b7adb0af82c1/lib/appium_lib/android/element/generic.rb#L35) android +##### [scroll_to](https://github.com/appium/ruby_lib/blob/8cc004ad04ec087a8a11c06ca0749a5e2c6586a7/lib/appium_lib/android/element/generic.rb#L40) android > def scroll_to text Scroll to the first element containing target text or description. @@ -1831,11 +2001,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Element] the element scrolled to -- -##### [scroll_to_exact](https://github.com/appium/ruby_lib/blob/3ed875cc01ba7f670e9b1b8ccfd7b7adb0af82c1/lib/appium_lib/android/element/generic.rb#L48) android +##### [scroll_to_exact](https://github.com/appium/ruby_lib/blob/8cc004ad04ec087a8a11c06ca0749a5e2c6586a7/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. @@ -1847,19 +2017,19 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Element] the element scrolled to -- -##### [EditText](https://github.com/appium/ruby_lib/blob/3ed875cc01ba7f670e9b1b8ccfd7b7adb0af82c1/lib/appium_lib/android/element/textfield.rb#L3) android +##### [EditText](https://github.com/appium/ruby_lib/blob/8cc004ad04ec087a8a11c06ca0749a5e2c6586a7/lib/appium_lib/android/element/textfield.rb#L3) android > EditText = 'android.widget.EditText' -- -##### [textfield](https://github.com/appium/ruby_lib/blob/3ed875cc01ba7f670e9b1b8ccfd7b7adb0af82c1/lib/appium_lib/android/element/textfield.rb#L9) android +##### [textfield](https://github.com/appium/ruby_lib/blob/8cc004ad04ec087a8a11c06ca0749a5e2c6586a7/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. @@ -1872,11 +2042,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[EditText] -- -##### [textfields](https://github.com/appium/ruby_lib/blob/3ed875cc01ba7f670e9b1b8ccfd7b7adb0af82c1/lib/appium_lib/android/element/textfield.rb#L18) android +##### [textfields](https://github.com/appium/ruby_lib/blob/8cc004ad04ec087a8a11c06ca0749a5e2c6586a7/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. @@ -1889,11 +2059,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Array<EditText>] -- -##### [first_textfield](https://github.com/appium/ruby_lib/blob/3ed875cc01ba7f670e9b1b8ccfd7b7adb0af82c1/lib/appium_lib/android/element/textfield.rb#L25) android +##### [first_textfield](https://github.com/appium/ruby_lib/blob/8cc004ad04ec087a8a11c06ca0749a5e2c6586a7/lib/appium_lib/android/element/textfield.rb#L25) android > def first_textfield Find the first EditText. @@ -1901,11 +2071,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[EditText] -- -##### [last_textfield](https://github.com/appium/ruby_lib/blob/3ed875cc01ba7f670e9b1b8ccfd7b7adb0af82c1/lib/appium_lib/android/element/textfield.rb#L31) android +##### [last_textfield](https://github.com/appium/ruby_lib/blob/8cc004ad04ec087a8a11c06ca0749a5e2c6586a7/lib/appium_lib/android/element/textfield.rb#L31) android > def last_textfield Find the last EditText. @@ -1913,11 +2083,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[EditText] -- -##### [textfield_exact](https://github.com/appium/ruby_lib/blob/3ed875cc01ba7f670e9b1b8ccfd7b7adb0af82c1/lib/appium_lib/android/element/textfield.rb#L38) android +##### [textfield_exact](https://github.com/appium/ruby_lib/blob/8cc004ad04ec087a8a11c06ca0749a5e2c6586a7/lib/appium_lib/android/element/textfield.rb#L38) android > def textfield_exact value Find the first EditText that exactly matches value. @@ -1929,11 +2099,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[EditText] -- -##### [textfields_exact](https://github.com/appium/ruby_lib/blob/3ed875cc01ba7f670e9b1b8ccfd7b7adb0af82c1/lib/appium_lib/android/element/textfield.rb#L45) android +##### [textfields_exact](https://github.com/appium/ruby_lib/blob/8cc004ad04ec087a8a11c06ca0749a5e2c6586a7/lib/appium_lib/android/element/textfield.rb#L45) android > def textfields_exact value Find all EditTexts that exactly match value. @@ -1945,30 +2115,30 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Array<EditText>] -- -##### [value](https://github.com/appium/ruby_lib/blob/3ed875cc01ba7f670e9b1b8ccfd7b7adb0af82c1/lib/appium_lib/common/patch.rb#L10) +##### [value](https://github.com/appium/ruby_lib/blob/8cc004ad04ec087a8a11c06ca0749a5e2c6586a7/lib/appium_lib/common/patch.rb#L10) > def value Returns the value attribute Fixes NoMethodError: undefined method `value' for Selenium::WebDriver::Element -- -##### [name](https://github.com/appium/ruby_lib/blob/3ed875cc01ba7f670e9b1b8ccfd7b7adb0af82c1/lib/appium_lib/common/patch.rb#L17) +##### [name](https://github.com/appium/ruby_lib/blob/8cc004ad04ec087a8a11c06ca0749a5e2c6586a7/lib/appium_lib/common/patch.rb#L17) > def name Returns the name attribute Fixes NoMethodError: undefined method `name' for Selenium::WebDriver::Element -- -##### [location_rel](https://github.com/appium/ruby_lib/blob/3ed875cc01ba7f670e9b1b8ccfd7b7adb0af82c1/lib/appium_lib/common/patch.rb#L29) +##### [location_rel](https://github.com/appium/ruby_lib/blob/8cc004ad04ec087a8a11c06ca0749a5e2c6586a7/lib/appium_lib/common/patch.rb#L29) > def location_rel For use with mobile tap.