docs/android_docs.md in appium_lib-1.0.0 vs docs/android_docs.md in appium_lib-2.0.0

- old
+ new

@@ -1,6 +1,6 @@ -##### [load_appium_txt](https://github.com/appium/ruby_lib/blob/5a3ecbb4147693ce3c2c6b693e64074022d03511/lib/appium_lib/driver.rb#L71) +##### [load_appium_txt](https://github.com/appium/ruby_lib/blob/2d7ab8b6cc442f39f6171f8a27bc4923e4d4e2a4/lib/appium_lib/driver.rb#L71) > 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/5a3ecbb4147693ce3c2c6b693e64074022d03511/lib/appium_lib/driver.rb#L141) +##### [symbolize_keys](https://github.com/appium/ruby_lib/blob/2d7ab8b6cc442f39f6171f8a27bc4923e4d4e2a4/lib/appium_lib/driver.rb#L141) > 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/5a3ecbb4147693ce3c2c6b693e64074022d03511/lib/appium_lib/driver.rb#L151) +##### [promote_singleton_appium_methods](https://github.com/appium/ruby_lib/blob/2d7ab8b6cc442f39f6171f8a27bc4923e4d4e2a4/lib/appium_lib/driver.rb#L151) > def self.promote_singleton_appium_methods main_module -- -##### [promote_appium_methods](https://github.com/appium/ruby_lib/blob/5a3ecbb4147693ce3c2c6b693e64074022d03511/lib/appium_lib/driver.rb#L180) +##### [promote_appium_methods](https://github.com/appium/ruby_lib/blob/2d7ab8b6cc442f39f6171f8a27bc4923e4d4e2a4/lib/appium_lib/driver.rb#L180) > def self.promote_appium_methods class_array Promote appium methods to class instance methods @@ -62,27 +62,27 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Array<Class>] class_array - An array of classes -- -##### [global_webdriver_http_sleep](https://github.com/appium/ruby_lib/blob/5a3ecbb4147693ce3c2c6b693e64074022d03511/lib/appium_lib/driver.rb#L213) +##### [global_webdriver_http_sleep](https://github.com/appium/ruby_lib/blob/2d7ab8b6cc442f39f6171f8a27bc4923e4d4e2a4/lib/appium_lib/driver.rb#L213) > 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/5a3ecbb4147693ce3c2c6b693e64074022d03511/lib/appium_lib/driver.rb#L213) +##### [global_webdriver_http_sleep=](https://github.com/appium/ruby_lib/blob/2d7ab8b6cc442f39f6171f8a27bc4923e4d4e2a4/lib/appium_lib/driver.rb#L213) > 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/5a3ecbb4147693ce3c2c6b693e64074022d03511/lib/appium_lib/driver.rb#L234) +##### [initialize](https://github.com/appium/ruby_lib/blob/2d7ab8b6cc442f39f6171f8a27bc4923e4d4e2a4/lib/appium_lib/driver.rb#L234) > def initialize opts={} Creates a new driver @@ -109,19 +109,19 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Driver] -- -##### [driver_attributes](https://github.com/appium/ruby_lib/blob/5a3ecbb4147693ce3c2c6b693e64074022d03511/lib/appium_lib/driver.rb#L308) +##### [driver_attributes](https://github.com/appium/ruby_lib/blob/2d7ab8b6cc442f39f6171f8a27bc4923e4d4e2a4/lib/appium_lib/driver.rb#L308) > def driver_attributes Returns a hash of the driver attributes -- -##### [device_is_android?](https://github.com/appium/ruby_lib/blob/5a3ecbb4147693ce3c2c6b693e64074022d03511/lib/appium_lib/driver.rb#L328) +##### [device_is_android?](https://github.com/appium/ruby_lib/blob/2d7ab8b6cc442f39f6171f8a27bc4923e4d4e2a4/lib/appium_lib/driver.rb#L328) > def device_is_android? @@ -129,11 +129,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Boolean] -- -##### [appium_server_version](https://github.com/appium/ruby_lib/blob/5a3ecbb4147693ce3c2c6b693e64074022d03511/lib/appium_lib/driver.rb#L344) +##### [appium_server_version](https://github.com/appium/ruby_lib/blob/2d7ab8b6cc442f39f6171f8a27bc4923e4d4e2a4/lib/appium_lib/driver.rb#L344) > def appium_server_version Returns the server's version info @@ -150,11 +150,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Hash] -- -##### [absolute_app_path](https://github.com/appium/ruby_lib/blob/5a3ecbb4147693ce3c2c6b693e64074022d03511/lib/appium_lib/driver.rb#L350) +##### [absolute_app_path](https://github.com/appium/ruby_lib/blob/2d7ab8b6cc442f39f6171f8a27bc4923e4d4e2a4/lib/appium_lib/driver.rb#L350) > def self.absolute_app_path app_path Converts app_path to an absolute path. @@ -162,11 +162,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[String] APP_PATH as an absolute path -- -##### [server_url](https://github.com/appium/ruby_lib/blob/5a3ecbb4147693ce3c2c6b693e64074022d03511/lib/appium_lib/driver.rb#L374) +##### [server_url](https://github.com/appium/ruby_lib/blob/2d7ab8b6cc442f39f6171f8a27bc4923e4d4e2a4/lib/appium_lib/driver.rb#L374) > def server_url Get the server url @@ -174,11 +174,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[String] the server url -- -##### [restart](https://github.com/appium/ruby_lib/blob/5a3ecbb4147693ce3c2c6b693e64074022d03511/lib/appium_lib/driver.rb#L385) +##### [restart](https://github.com/appium/ruby_lib/blob/2d7ab8b6cc442f39f6171f8a27bc4923e4d4e2a4/lib/appium_lib/driver.rb#L385) > def restart Restarts the driver @@ -186,11 +186,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Driver] the driver -- -##### [driver](https://github.com/appium/ruby_lib/blob/5a3ecbb4147693ce3c2c6b693e64074022d03511/lib/appium_lib/driver.rb#L392) +##### [driver](https://github.com/appium/ruby_lib/blob/2d7ab8b6cc442f39f6171f8a27bc4923e4d4e2a4/lib/appium_lib/driver.rb#L392) > def driver Returns the driver @@ -198,11 +198,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Driver] the driver -- -##### [screenshot](https://github.com/appium/ruby_lib/blob/5a3ecbb4147693ce3c2c6b693e64074022d03511/lib/appium_lib/driver.rb#L402) +##### [screenshot](https://github.com/appium/ruby_lib/blob/2d7ab8b6cc442f39f6171f8a27bc4923e4d4e2a4/lib/appium_lib/driver.rb#L402) > def screenshot png_save_path Takes a png screenshot and saves to the target path. @@ -216,11 +216,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[nil] -- -##### [driver_quit](https://github.com/appium/ruby_lib/blob/5a3ecbb4147693ce3c2c6b693e64074022d03511/lib/appium_lib/driver.rb#L409) +##### [driver_quit](https://github.com/appium/ruby_lib/blob/2d7ab8b6cc442f39f6171f8a27bc4923e4d4e2a4/lib/appium_lib/driver.rb#L409) > def driver_quit Quits the driver @@ -228,11 +228,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[void] -- -##### [start_driver](https://github.com/appium/ruby_lib/blob/5a3ecbb4147693ce3c2c6b693e64074022d03511/lib/appium_lib/driver.rb#L417) +##### [start_driver](https://github.com/appium/ruby_lib/blob/2d7ab8b6cc442f39f6171f8a27bc4923e4d4e2a4/lib/appium_lib/driver.rb#L417) > def start_driver Creates a new global driver and quits the old one if it exists. @@ -240,19 +240,19 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Selenium::WebDriver] the new global driver -- -##### [no_wait](https://github.com/appium/ruby_lib/blob/5a3ecbb4147693ce3c2c6b693e64074022d03511/lib/appium_lib/driver.rb#L443) +##### [no_wait](https://github.com/appium/ruby_lib/blob/2d7ab8b6cc442f39f6171f8a27bc4923e4d4e2a4/lib/appium_lib/driver.rb#L443) > def no_wait Set implicit wait and default_wait to zero. -- -##### [set_wait](https://github.com/appium/ruby_lib/blob/5a3ecbb4147693ce3c2c6b693e64074022d03511/lib/appium_lib/driver.rb#L462) +##### [set_wait](https://github.com/appium/ruby_lib/blob/2d7ab8b6cc442f39f6171f8a27bc4923e4d4e2a4/lib/appium_lib/driver.rb#L462) > 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,11 +273,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[void] -- -##### [default_wait](https://github.com/appium/ruby_lib/blob/5a3ecbb4147693ce3c2c6b693e64074022d03511/lib/appium_lib/driver.rb#L480) +##### [default_wait](https://github.com/appium/ruby_lib/blob/2d7ab8b6cc442f39f6171f8a27bc4923e4d4e2a4/lib/appium_lib/driver.rb#L480) > def default_wait Returns the default client side wait. This value is independent of what the server is using @@ -286,11 +286,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Integer] -- -##### [exists](https://github.com/appium/ruby_lib/blob/5a3ecbb4147693ce3c2c6b693e64074022d03511/lib/appium_lib/driver.rb#L496) +##### [exists](https://github.com/appium/ruby_lib/blob/2d7ab8b6cc442f39f6171f8a27bc4923e4d4e2a4/lib/appium_lib/driver.rb#L496) > def exists pre_check=0, post_check=@default_wait, &search_block Returns existence of element. @@ -312,11 +312,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Boolean] -- -##### [execute_script](https://github.com/appium/ruby_lib/blob/5a3ecbb4147693ce3c2c6b693e64074022d03511/lib/appium_lib/driver.rb#L520) +##### [execute_script](https://github.com/appium/ruby_lib/blob/2d7ab8b6cc442f39f6171f8a27bc4923e4d4e2a4/lib/appium_lib/driver.rb#L520) > def execute_script script, *args The same as @driver.execute_script @@ -330,11 +330,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Object] -- -##### [find_elements](https://github.com/appium/ruby_lib/blob/5a3ecbb4147693ce3c2c6b693e64074022d03511/lib/appium_lib/driver.rb#L528) +##### [find_elements](https://github.com/appium/ruby_lib/blob/2d7ab8b6cc442f39f6171f8a27bc4923e4d4e2a4/lib/appium_lib/driver.rb#L528) > def find_elements *args Calls @driver.find_elements @@ -346,11 +346,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/5a3ecbb4147693ce3c2c6b693e64074022d03511/lib/appium_lib/driver.rb#L536) +##### [find_element](https://github.com/appium/ruby_lib/blob/2d7ab8b6cc442f39f6171f8a27bc4923e4d4e2a4/lib/appium_lib/driver.rb#L536) > def find_element *args Calls @driver.find_elements @@ -362,11 +362,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Element] -- -##### [x](https://github.com/appium/ruby_lib/blob/5a3ecbb4147693ce3c2c6b693e64074022d03511/lib/appium_lib/driver.rb#L543) +##### [x](https://github.com/appium/ruby_lib/blob/2d7ab8b6cc442f39f6171f8a27bc4923e4d4e2a4/lib/appium_lib/driver.rb#L543) > def x Quit the driver and Pry. quit and exit are reserved by Pry. @@ -375,79 +375,79 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[void] -- -##### [NoArgMethods](https://github.com/appium/ruby_lib/blob/5a3ecbb4147693ce3c2c6b693e64074022d03511/lib/appium_lib/device/device.rb#L7) +##### [NoArgMethods](https://github.com/appium/ruby_lib/blob/2d7ab8b6cc442f39f6171f8a27bc4923e4d4e2a4/lib/appium_lib/device/device.rb#L7) > NoArgMethods = { -- -##### [app_strings](https://github.com/appium/ruby_lib/blob/5a3ecbb4147693ce3c2c6b693e64074022d03511/lib/appium_lib/device/device.rb#L23) +##### [app_strings](https://github.com/appium/ruby_lib/blob/2d7ab8b6cc442f39f6171f8a27bc4923e4d4e2a4/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/5a3ecbb4147693ce3c2c6b693e64074022d03511/lib/appium_lib/device/device.rb#L29) +##### [background_app](https://github.com/appium/ruby_lib/blob/2d7ab8b6cc442f39f6171f8a27bc4923e4d4e2a4/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/5a3ecbb4147693ce3c2c6b693e64074022d03511/lib/appium_lib/device/device.rb#L34) +##### [current_activity](https://github.com/appium/ruby_lib/blob/2d7ab8b6cc442f39f6171f8a27bc4923e4d4e2a4/lib/appium_lib/device/device.rb#L33) > def current_activity -- -##### [launch](https://github.com/appium/ruby_lib/blob/5a3ecbb4147693ce3c2c6b693e64074022d03511/lib/appium_lib/device/device.rb#L36) +##### [launch](https://github.com/appium/ruby_lib/blob/2d7ab8b6cc442f39f6171f8a27bc4923e4d4e2a4/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/5a3ecbb4147693ce3c2c6b693e64074022d03511/lib/appium_lib/device/device.rb#L39) +##### [reset](https://github.com/appium/ruby_lib/blob/2d7ab8b6cc442f39f6171f8a27bc4923e4d4e2a4/lib/appium_lib/device/device.rb#L38) > def reset Reset the device, relaunching the application. -- -##### [shake](https://github.com/appium/ruby_lib/blob/5a3ecbb4147693ce3c2c6b693e64074022d03511/lib/appium_lib/device/device.rb#L42) +##### [shake](https://github.com/appium/ruby_lib/blob/2d7ab8b6cc442f39f6171f8a27bc4923e4d4e2a4/lib/appium_lib/device/device.rb#L41) > def shake Cause the device to shake -- -##### [toggle_flight_mode](https://github.com/appium/ruby_lib/blob/5a3ecbb4147693ce3c2c6b693e64074022d03511/lib/appium_lib/device/device.rb#L45) +##### [toggle_flight_mode](https://github.com/appium/ruby_lib/blob/2d7ab8b6cc442f39f6171f8a27bc4923e4d4e2a4/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/5a3ecbb4147693ce3c2c6b693e64074022d03511/lib/appium_lib/device/device.rb#L48) +##### [complex_find](https://github.com/appium/ruby_lib/blob/2d7ab8b6cc442f39f6171f8a27bc4923e4d4e2a4/lib/appium_lib/device/device.rb#L47) > def complex_find Find an element by a complex array of criteria. Available criteria are listed in [link here]. Criteria are formed by creating an array @@ -464,11 +464,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Array<Object>] selectors - The selectors to find elements with. -- -##### [hide_keyboard](https://github.com/appium/ruby_lib/blob/5a3ecbb4147693ce3c2c6b693e64074022d03511/lib/appium_lib/device/device.rb#L60) +##### [hide_keyboard](https://github.com/appium/ruby_lib/blob/2d7ab8b6cc442f39f6171f8a27bc4923e4d4e2a4/lib/appium_lib/device/device.rb#L59) > def hide_keyboard Hide the onscreen keyboard @@ -477,11 +477,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[String] close_key - the name of the key which closes the keyboard. Defaults to 'Done'. -- -##### [key_event](https://github.com/appium/ruby_lib/blob/5a3ecbb4147693ce3c2c6b693e64074022d03511/lib/appium_lib/device/device.rb#L69) +##### [key_event](https://github.com/appium/ruby_lib/blob/2d7ab8b6cc442f39f6171f8a27bc4923e4d4e2a4/lib/appium_lib/device/device.rb#L68) > def key_event Send a key event to the device. @@ -491,11 +491,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[String] metastate - The state the metakeys should be in when sending the key. -- -##### [push_file](https://github.com/appium/ruby_lib/blob/5a3ecbb4147693ce3c2c6b693e64074022d03511/lib/appium_lib/device/device.rb#L74) +##### [push_file](https://github.com/appium/ruby_lib/blob/2d7ab8b6cc442f39f6171f8a27bc4923e4d4e2a4/lib/appium_lib/device/device.rb#L73) > def push_file Place a file in a specific location on the device. @@ -505,11 +505,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/5a3ecbb4147693ce3c2c6b693e64074022d03511/lib/appium_lib/device/device.rb#L79) +##### [pull_file](https://github.com/appium/ruby_lib/blob/2d7ab8b6cc442f39f6171f8a27bc4923e4d4e2a4/lib/appium_lib/device/device.rb#L78) > def pull_file Retrieve a file from the device. This can retrieve an absolute path or a path relative to the installed app (iOS only). @@ -522,19 +522,19 @@ &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/5a3ecbb4147693ce3c2c6b693e64074022d03511/lib/appium_lib/device/device.rb#L277) +##### [extend_search_contexts](https://github.com/appium/ruby_lib/blob/2d7ab8b6cc442f39f6171f8a27bc4923e4d4e2a4/lib/appium_lib/device/device.rb#L283) > def extend_search_contexts -- -##### [accessiblity_id_find](https://github.com/appium/ruby_lib/blob/5a3ecbb4147693ce3c2c6b693e64074022d03511/lib/appium_lib/device/device.rb#L277) +##### [accessiblity_id_find](https://github.com/appium/ruby_lib/blob/2d7ab8b6cc442f39f6171f8a27bc4923e4d4e2a4/lib/appium_lib/device/device.rb#L283) > def accessiblity_id_find find_element/s with their accessibility_id @@ -542,34 +542,34 @@ find_elements :accessibility_id, 'Animation' ``` -- -##### [add_touch_actions](https://github.com/appium/ruby_lib/blob/5a3ecbb4147693ce3c2c6b693e64074022d03511/lib/appium_lib/device/device.rb#L283) +##### [add_touch_actions](https://github.com/appium/ruby_lib/blob/2d7ab8b6cc442f39f6171f8a27bc4923e4d4e2a4/lib/appium_lib/device/device.rb#L289) > def add_touch_actions -- -##### [current_context=](https://github.com/appium/ruby_lib/blob/5a3ecbb4147693ce3c2c6b693e64074022d03511/lib/appium_lib/device/device.rb#L307) +##### [set_context](https://github.com/appium/ruby_lib/blob/2d7ab8b6cc442f39f6171f8a27bc4923e4d4e2a4/lib/appium_lib/device/device.rb#L313) -> def current_context= +> def set_context Change the context to the given context. ```ruby -current_context= "NATIVE_APP" +set_context "NATIVE_APP" ``` __Parameters:__ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[String] The - context to change to -- -##### [current_context](https://github.com/appium/ruby_lib/blob/5a3ecbb4147693ce3c2c6b693e64074022d03511/lib/appium_lib/device/device.rb#L315) +##### [current_context](https://github.com/appium/ruby_lib/blob/2d7ab8b6cc442f39f6171f8a27bc4923e4d4e2a4/lib/appium_lib/device/device.rb#L321) > def current_context @@ -577,11 +577,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[String] The context currently being used. -- -##### [available_contexts](https://github.com/appium/ruby_lib/blob/5a3ecbb4147693ce3c2c6b693e64074022d03511/lib/appium_lib/device/device.rb#L318) +##### [available_contexts](https://github.com/appium/ruby_lib/blob/2d7ab8b6cc442f39f6171f8a27bc4923e4d4e2a4/lib/appium_lib/device/device.rb#L324) > def available_contexts @@ -589,11 +589,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/5a3ecbb4147693ce3c2c6b693e64074022d03511/lib/appium_lib/device/device.rb#L328) +##### [within_context](https://github.com/appium/ruby_lib/blob/2d7ab8b6cc442f39f6171f8a27bc4923e4d4e2a4/lib/appium_lib/device/device.rb#L334) > def within_context(context) Perform a block within the given context, then switch back to the starting context. ```ruby @@ -605,19 +605,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/5a3ecbb4147693ce3c2c6b693e64074022d03511/lib/appium_lib/device/device.rb#L335) +##### [switch_to_default_context](https://github.com/appium/ruby_lib/blob/2d7ab8b6cc442f39f6171f8a27bc4923e4d4e2a4/lib/appium_lib/device/device.rb#L342) > def switch_to_default_context -Change to the default context. This is equivalent to `current_context= nil`. +Change to the default context. This is equivalent to `set_context nil`. -- -##### [pinch](https://github.com/appium/ruby_lib/blob/5a3ecbb4147693ce3c2c6b693e64074022d03511/lib/appium_lib/device/multi_touch.rb#L30) +##### [pinch](https://github.com/appium/ruby_lib/blob/2d7ab8b6cc442f39f6171f8a27bc4923e4d4e2a4/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 +632,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/5a3ecbb4147693ce3c2c6b693e64074022d03511/lib/appium_lib/device/multi_touch.rb#L58) +##### [zoom](https://github.com/appium/ruby_lib/blob/2d7ab8b6cc442f39f6171f8a27bc4923e4d4e2a4/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 +651,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/5a3ecbb4147693ce3c2c6b693e64074022d03511/lib/appium_lib/device/multi_touch.rb#L79) +##### [initialize](https://github.com/appium/ruby_lib/blob/2d7ab8b6cc442f39f6171f8a27bc4923e4d4e2a4/lib/appium_lib/device/multi_touch.rb#L79) > def initialize Create a new multi-action @@ -663,11 +663,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[MultiTouch] a new instance of MultiTouch -- -##### [add](https://github.com/appium/ruby_lib/blob/5a3ecbb4147693ce3c2c6b693e64074022d03511/lib/appium_lib/device/multi_touch.rb#L85) +##### [add](https://github.com/appium/ruby_lib/blob/2d7ab8b6cc442f39f6171f8a27bc4923e4d4e2a4/lib/appium_lib/device/multi_touch.rb#L85) > def add(chain) Add a touch_action to be performed @@ -675,43 +675,43 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[TouchAction] chain - The action to add to the chain -- -##### [perform](https://github.com/appium/ruby_lib/blob/5a3ecbb4147693ce3c2c6b693e64074022d03511/lib/appium_lib/device/multi_touch.rb#L90) +##### [perform](https://github.com/appium/ruby_lib/blob/2d7ab8b6cc442f39f6171f8a27bc4923e4d4e2a4/lib/appium_lib/device/multi_touch.rb#L90) > def perform Ask Appium to perform the actions -- -##### [ACTIONS](https://github.com/appium/ruby_lib/blob/5a3ecbb4147693ce3c2c6b693e64074022d03511/lib/appium_lib/device/touch_actions.rb#L12) +##### [ACTIONS](https://github.com/appium/ruby_lib/blob/2d7ab8b6cc442f39f6171f8a27bc4923e4d4e2a4/lib/appium_lib/device/touch_actions.rb#L12) -> ACTIONS = [:move_to, :press_for_duration, :press, :release, :tap, :wait, :perform] +> ACTIONS = [:move_to, :long_press, :press, :release, :tap, :wait, :perform] -- -##### [COMPLEX_ACTIONS](https://github.com/appium/ruby_lib/blob/5a3ecbb4147693ce3c2c6b693e64074022d03511/lib/appium_lib/device/touch_actions.rb#L13) +##### [COMPLEX_ACTIONS](https://github.com/appium/ruby_lib/blob/2d7ab8b6cc442f39f6171f8a27bc4923e4d4e2a4/lib/appium_lib/device/touch_actions.rb#L13) > COMPLEX_ACTIONS = [:swipe] -- -##### [actions](https://github.com/appium/ruby_lib/blob/5a3ecbb4147693ce3c2c6b693e64074022d03511/lib/appium_lib/device/touch_actions.rb#L27) +##### [actions](https://github.com/appium/ruby_lib/blob/2d7ab8b6cc442f39f6171f8a27bc4923e4d4e2a4/lib/appium_lib/device/touch_actions.rb#L27) > def actions Returns the value of attribute actions -- -##### [initialize](https://github.com/appium/ruby_lib/blob/5a3ecbb4147693ce3c2c6b693e64074022d03511/lib/appium_lib/device/touch_actions.rb#L29) +##### [initialize](https://github.com/appium/ruby_lib/blob/2d7ab8b6cc442f39f6171f8a27bc4923e4d4e2a4/lib/appium_lib/device/touch_actions.rb#L29) > def initialize @@ -719,11 +719,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[TouchAction] a new instance of TouchAction -- -##### [move_to](https://github.com/appium/ruby_lib/blob/5a3ecbb4147693ce3c2c6b693e64074022d03511/lib/appium_lib/device/touch_actions.rb#L37) +##### [move_to](https://github.com/appium/ruby_lib/blob/2d7ab8b6cc442f39f6171f8a27bc4923e4d4e2a4/lib/appium_lib/device/touch_actions.rb#L37) > def move_to(opts) Move to the given co-ordinates. @@ -731,29 +731,29 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Hash] opts - a customizable set of options -- -##### [press_for_duration](https://github.com/appium/ruby_lib/blob/5a3ecbb4147693ce3c2c6b693e64074022d03511/lib/appium_lib/device/touch_actions.rb#L47) +##### [long_press](https://github.com/appium/ruby_lib/blob/2d7ab8b6cc442f39f6171f8a27bc4923e4d4e2a4/lib/appium_lib/device/touch_actions.rb#L47) -> def press_for_duration(element, x, y, duration) +> def long_press(opts) Press down for a specific duration. __Parameters:__ -&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[WebDriver::Element] element - the element to press. +&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Hash] element - a customizable set of options -&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[integer] x - x co-ordinate to press on. +&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Hash] x - a customizable set of options -&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[integer] y - y co-ordinate to press on. +&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Hash] y - a customizable set of options -&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[integer] duration - Number of seconds to press. +&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Hash] duration - a customizable set of options -- -##### [press](https://github.com/appium/ruby_lib/blob/5a3ecbb4147693ce3c2c6b693e64074022d03511/lib/appium_lib/device/touch_actions.rb#L58) +##### [press](https://github.com/appium/ruby_lib/blob/2d7ab8b6cc442f39f6171f8a27bc4923e4d4e2a4/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 +762,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Hash] opts - a customizable set of options -- -##### [release](https://github.com/appium/ruby_lib/blob/5a3ecbb4147693ce3c2c6b693e64074022d03511/lib/appium_lib/device/touch_actions.rb#L69) +##### [release](https://github.com/appium/ruby_lib/blob/2d7ab8b6cc442f39f6171f8a27bc4923e4d4e2a4/lib/appium_lib/device/touch_actions.rb#L70) > def release(opts=nil) Remove a finger from the screen. @@ -774,11 +774,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Hash] opts - a customizable set of options -- -##### [tap](https://github.com/appium/ruby_lib/blob/5a3ecbb4147693ce3c2c6b693e64074022d03511/lib/appium_lib/device/touch_actions.rb#L80) +##### [tap](https://github.com/appium/ruby_lib/blob/2d7ab8b6cc442f39f6171f8a27bc4923e4d4e2a4/lib/appium_lib/device/touch_actions.rb#L81) > def tap(opts) Touch a point on the screen @@ -786,23 +786,23 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Hash] opts - a customizable set of options -- -##### [wait](https://github.com/appium/ruby_lib/blob/5a3ecbb4147693ce3c2c6b693e64074022d03511/lib/appium_lib/device/touch_actions.rb#L88) +##### [wait](https://github.com/appium/ruby_lib/blob/2d7ab8b6cc442f39f6171f8a27bc4923e4d4e2a4/lib/appium_lib/device/touch_actions.rb#L90) -> def wait(seconds) +> def wait(milliseconds) -Pause for a number of seconds before the next action +Pause for a number of milliseconds before the next action __Parameters:__ -&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[integer] seconds - Number of seconds to pause for +&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[integer] milliseconds - Number of milliseconds to pause for -- -##### [swipe](https://github.com/appium/ruby_lib/blob/5a3ecbb4147693ce3c2c6b693e64074022d03511/lib/appium_lib/device/touch_actions.rb#L99) +##### [swipe](https://github.com/appium/ruby_lib/blob/2d7ab8b6cc442f39f6171f8a27bc4923e4d4e2a4/lib/appium_lib/device/touch_actions.rb#L101) > def swipe(opts) Convenience method to peform a swipe. @@ -810,43 +810,43 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Hash] opts - a customizable set of options -- -##### [perform](https://github.com/appium/ruby_lib/blob/5a3ecbb4147693ce3c2c6b693e64074022d03511/lib/appium_lib/device/touch_actions.rb#L114) +##### [perform](https://github.com/appium/ruby_lib/blob/2d7ab8b6cc442f39f6171f8a27bc4923e4d4e2a4/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/5a3ecbb4147693ce3c2c6b693e64074022d03511/lib/appium_lib/device/touch_actions.rb#L120) +##### [cancel](https://github.com/appium/ruby_lib/blob/2d7ab8b6cc442f39f6171f8a27bc4923e4d4e2a4/lib/appium_lib/device/touch_actions.rb#L122) > def cancel Does nothing, currently. -- -##### [chain_method](https://github.com/appium/ruby_lib/blob/5a3ecbb4147693ce3c2c6b693e64074022d03511/lib/appium_lib/device/touch_actions.rb#L128) +##### [chain_method](https://github.com/appium/ruby_lib/blob/2d7ab8b6cc442f39f6171f8a27bc4923e4d4e2a4/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/5a3ecbb4147693ce3c2c6b693e64074022d03511/lib/appium_lib/device/touch_actions.rb#L137) +##### [args_with_ele_ref](https://github.com/appium/ruby_lib/blob/2d7ab8b6cc442f39f6171f8a27bc4923e4d4e2a4/lib/appium_lib/device/touch_actions.rb#L139) > def args_with_ele_ref(args) -- -##### [wait](https://github.com/appium/ruby_lib/blob/5a3ecbb4147693ce3c2c6b693e64074022d03511/lib/appium_lib/common/helper.rb#L33) +##### [wait](https://github.com/appium/ruby_lib/blob/2d7ab8b6cc442f39f6171f8a27bc4923e4d4e2a4/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 +869,19 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Object] the result of block.call -- -##### [ignore](https://github.com/appium/ruby_lib/blob/5a3ecbb4147693ce3c2c6b693e64074022d03511/lib/appium_lib/common/helper.rb#L49) +##### [ignore](https://github.com/appium/ruby_lib/blob/2d7ab8b6cc442f39f6171f8a27bc4923e4d4e2a4/lib/appium_lib/common/helper.rb#L49) > def ignore &block Return block.call and ignore any exceptions. -- -##### [wait_true](https://github.com/appium/ruby_lib/blob/5a3ecbb4147693ce3c2c6b693e64074022d03511/lib/appium_lib/common/helper.rb#L64) +##### [wait_true](https://github.com/appium/ruby_lib/blob/2d7ab8b6cc442f39f6171f8a27bc4923e4d4e2a4/lib/appium_lib/common/helper.rb#L64) > 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 +900,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Object] the result of block.call -- -##### [back](https://github.com/appium/ruby_lib/blob/5a3ecbb4147693ce3c2c6b693e64074022d03511/lib/appium_lib/common/helper.rb#L81) +##### [back](https://github.com/appium/ruby_lib/blob/2d7ab8b6cc442f39f6171f8a27bc4923e4d4e2a4/lib/appium_lib/common/helper.rb#L81) > def back Navigate back. @@ -912,19 +912,19 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[void] -- -##### [session_id](https://github.com/appium/ruby_lib/blob/5a3ecbb4147693ce3c2c6b693e64074022d03511/lib/appium_lib/common/helper.rb#L86) +##### [session_id](https://github.com/appium/ruby_lib/blob/2d7ab8b6cc442f39f6171f8a27bc4923e4d4e2a4/lib/appium_lib/common/helper.rb#L86) > def session_id For Sauce Labs reporting. Returns the current session id. -- -##### [xpath](https://github.com/appium/ruby_lib/blob/5a3ecbb4147693ce3c2c6b693e64074022d03511/lib/appium_lib/common/helper.rb#L94) +##### [xpath](https://github.com/appium/ruby_lib/blob/2d7ab8b6cc442f39f6171f8a27bc4923e4d4e2a4/lib/appium_lib/common/helper.rb#L94) > def xpath xpath_str Returns the first element that matches the provided xpath. @@ -936,11 +936,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Element] -- -##### [xpaths](https://github.com/appium/ruby_lib/blob/5a3ecbb4147693ce3c2c6b693e64074022d03511/lib/appium_lib/common/helper.rb#L102) +##### [xpaths](https://github.com/appium/ruby_lib/blob/2d7ab8b6cc442f39f6171f8a27bc4923e4d4e2a4/lib/appium_lib/common/helper.rb#L102) > def xpaths xpath_str Returns all elements that match the provided xpath. @@ -952,11 +952,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Array<Element>] -- -##### [source](https://github.com/appium/ruby_lib/blob/5a3ecbb4147693ce3c2c6b693e64074022d03511/lib/appium_lib/common/helper.rb#L108) +##### [source](https://github.com/appium/ruby_lib/blob/2d7ab8b6cc442f39f6171f8a27bc4923e4d4e2a4/lib/appium_lib/common/helper.rb#L108) > def source Prints xml of the current page @@ -964,11 +964,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[void] -- -##### [get_source](https://github.com/appium/ruby_lib/blob/5a3ecbb4147693ce3c2c6b693e64074022d03511/lib/appium_lib/common/helper.rb#L118) +##### [get_source](https://github.com/appium/ruby_lib/blob/2d7ab8b6cc442f39f6171f8a27bc4923e4d4e2a4/lib/appium_lib/common/helper.rb#L118) > def get_source Returns XML string for the current page Same as driver.page_source @@ -977,19 +977,19 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[String] -- -##### [result](https://github.com/appium/ruby_lib/blob/5a3ecbb4147693ce3c2c6b693e64074022d03511/lib/appium_lib/common/helper.rb#L125) +##### [result](https://github.com/appium/ruby_lib/blob/2d7ab8b6cc442f39f6171f8a27bc4923e4d4e2a4/lib/appium_lib/common/helper.rb#L125) > def result Returns the value of attribute result -- -##### [initialize](https://github.com/appium/ruby_lib/blob/5a3ecbb4147693ce3c2c6b693e64074022d03511/lib/appium_lib/common/helper.rb#L127) +##### [initialize](https://github.com/appium/ruby_lib/blob/2d7ab8b6cc442f39f6171f8a27bc4923e4d4e2a4/lib/appium_lib/common/helper.rb#L127) > def initialize @@ -997,52 +997,52 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[CountElements] a new instance of CountElements -- -##### [reset](https://github.com/appium/ruby_lib/blob/5a3ecbb4147693ce3c2c6b693e64074022d03511/lib/appium_lib/common/helper.rb#L131) +##### [reset](https://github.com/appium/ruby_lib/blob/2d7ab8b6cc442f39f6171f8a27bc4923e4d4e2a4/lib/appium_lib/common/helper.rb#L131) > def reset -- -##### [start_element](https://github.com/appium/ruby_lib/blob/5a3ecbb4147693ce3c2c6b693e64074022d03511/lib/appium_lib/common/helper.rb#L136) +##### [start_element](https://github.com/appium/ruby_lib/blob/2d7ab8b6cc442f39f6171f8a27bc4923e4d4e2a4/lib/appium_lib/common/helper.rb#L136) > def start_element name, attrs = [] http://nokogiri.org/Nokogiri/XML/SAX/Document.html -- -##### [formatted_result](https://github.com/appium/ruby_lib/blob/5a3ecbb4147693ce3c2c6b693e64074022d03511/lib/appium_lib/common/helper.rb#L140) +##### [formatted_result](https://github.com/appium/ruby_lib/blob/2d7ab8b6cc442f39f6171f8a27bc4923e4d4e2a4/lib/appium_lib/common/helper.rb#L142) > def formatted_result -- -##### [get_page_class](https://github.com/appium/ruby_lib/blob/5a3ecbb4147693ce3c2c6b693e64074022d03511/lib/appium_lib/common/helper.rb#L151) +##### [get_page_class](https://github.com/appium/ruby_lib/blob/2d7ab8b6cc442f39f6171f8a27bc4923e4d4e2a4/lib/appium_lib/common/helper.rb#L153) > def get_page_class -Returns a string of class counts. +Returns a string of class counts of visible elements. -- -##### [page_class](https://github.com/appium/ruby_lib/blob/5a3ecbb4147693ce3c2c6b693e64074022d03511/lib/appium_lib/common/helper.rb#L162) +##### [page_class](https://github.com/appium/ruby_lib/blob/2d7ab8b6cc442f39f6171f8a27bc4923e4d4e2a4/lib/appium_lib/common/helper.rb#L164) > 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/5a3ecbb4147693ce3c2c6b693e64074022d03511/lib/appium_lib/common/helper.rb#L172) +##### [px_to_window_rel](https://github.com/appium/ruby_lib/blob/2d7ab8b6cc442f39f6171f8a27bc4923e4d4e2a4/lib/appium_lib/common/helper.rb#L174) > def px_to_window_rel opts={} Converts pixel values to window relative values @@ -1050,11 +1050,11 @@ px_to_window_rel x: 50, y: 150 ``` -- -##### [xml_keys](https://github.com/appium/ruby_lib/blob/5a3ecbb4147693ce3c2c6b693e64074022d03511/lib/appium_lib/common/helper.rb#L189) +##### [xml_keys](https://github.com/appium/ruby_lib/blob/2d7ab8b6cc442f39f6171f8a27bc4923e4d4e2a4/lib/appium_lib/common/helper.rb#L191) > def xml_keys target Search strings.xml's values for target. @@ -1066,11 +1066,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Array] -- -##### [xml_values](https://github.com/appium/ruby_lib/blob/5a3ecbb4147693ce3c2c6b693e64074022d03511/lib/appium_lib/common/helper.rb#L197) +##### [xml_values](https://github.com/appium/ruby_lib/blob/2d7ab8b6cc442f39f6171f8a27bc4923e4d4e2a4/lib/appium_lib/common/helper.rb#L199) > def xml_values target Search strings.xml's keys for target. @@ -1082,11 +1082,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Array] -- -##### [resolve_id](https://github.com/appium/ruby_lib/blob/5a3ecbb4147693ce3c2c6b693e64074022d03511/lib/appium_lib/common/helper.rb#L205) +##### [resolve_id](https://github.com/appium/ruby_lib/blob/2d7ab8b6cc442f39f6171f8a27bc4923e4d4e2a4/lib/appium_lib/common/helper.rb#L207) > def resolve_id id Resolve id in strings.xml and return the value. @@ -1098,51 +1098,51 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[String] -- -##### [window_size](https://github.com/appium/ruby_lib/blob/5a3ecbb4147693ce3c2c6b693e64074022d03511/lib/appium_lib/common/element/window.rb#L5) +##### [window_size](https://github.com/appium/ruby_lib/blob/2d7ab8b6cc442f39f6171f8a27bc4923e4d4e2a4/lib/appium_lib/common/element/window.rb#L5) > def window_size Get the window's size -- -##### [result](https://github.com/appium/ruby_lib/blob/5a3ecbb4147693ce3c2c6b693e64074022d03511/lib/appium_lib/android/helper.rb#L7) android +##### [result](https://github.com/appium/ruby_lib/blob/2d7ab8b6cc442f39f6171f8a27bc4923e4d4e2a4/lib/appium_lib/android/helper.rb#L7) android > def result TODO: Support strings.xml ids -- -##### [keys](https://github.com/appium/ruby_lib/blob/5a3ecbb4147693ce3c2c6b693e64074022d03511/lib/appium_lib/android/helper.rb#L7) android +##### [keys](https://github.com/appium/ruby_lib/blob/2d7ab8b6cc442f39f6171f8a27bc4923e4d4e2a4/lib/appium_lib/android/helper.rb#L7) android > def keys TODO: Support strings.xml ids -- -##### [filter](https://github.com/appium/ruby_lib/blob/5a3ecbb4147693ce3c2c6b693e64074022d03511/lib/appium_lib/android/helper.rb#L9) android +##### [filter](https://github.com/appium/ruby_lib/blob/2d7ab8b6cc442f39f6171f8a27bc4923e4d4e2a4/lib/appium_lib/android/helper.rb#L9) android > def filter -- -##### [filter=](https://github.com/appium/ruby_lib/blob/5a3ecbb4147693ce3c2c6b693e64074022d03511/lib/appium_lib/android/helper.rb#L14) android +##### [filter=](https://github.com/appium/ruby_lib/blob/2d7ab8b6cc442f39f6171f8a27bc4923e4d4e2a4/lib/appium_lib/android/helper.rb#L14) android > def filter= value convert to string to support symbols -- -##### [initialize](https://github.com/appium/ruby_lib/blob/5a3ecbb4147693ce3c2c6b693e64074022d03511/lib/appium_lib/android/helper.rb#L20) android +##### [initialize](https://github.com/appium/ruby_lib/blob/2d7ab8b6cc442f39f6171f8a27bc4923e4d4e2a4/lib/appium_lib/android/helper.rb#L20) android > def initialize @@ -1150,27 +1150,27 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[AndroidElements] a new instance of AndroidElements -- -##### [reset](https://github.com/appium/ruby_lib/blob/5a3ecbb4147693ce3c2c6b693e64074022d03511/lib/appium_lib/android/helper.rb#L25) android +##### [reset](https://github.com/appium/ruby_lib/blob/2d7ab8b6cc442f39f6171f8a27bc4923e4d4e2a4/lib/appium_lib/android/helper.rb#L25) android > def reset -- -##### [start_element](https://github.com/appium/ruby_lib/blob/5a3ecbb4147693ce3c2c6b693e64074022d03511/lib/appium_lib/android/helper.rb#L31) android +##### [start_element](https://github.com/appium/ruby_lib/blob/2d7ab8b6cc442f39f6171f8a27bc4923e4d4e2a4/lib/appium_lib/android/helper.rb#L31) android > def start_element name, attrs = [] http://nokogiri.org/Nokogiri/XML/SAX/Document.html -- -##### [get_android_inspect](https://github.com/appium/ruby_lib/blob/5a3ecbb4147693ce3c2c6b693e64074022d03511/lib/appium_lib/android/helper.rb#L65) android +##### [get_android_inspect](https://github.com/appium/ruby_lib/blob/2d7ab8b6cc442f39f6171f8a27bc4923e4d4e2a4/lib/appium_lib/android/helper.rb#L88) android > def get_android_inspect class_name=false Android only. Returns a string containing interesting elements. @@ -1185,43 +1185,43 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[String] -- -##### [page](https://github.com/appium/ruby_lib/blob/5a3ecbb4147693ce3c2c6b693e64074022d03511/lib/appium_lib/android/helper.rb#L80) android +##### [page](https://github.com/appium/ruby_lib/blob/2d7ab8b6cc442f39f6171f8a27bc4923e4d4e2a4/lib/appium_lib/android/helper.rb#L103) android -> def page class_name=false +> def page opts={} Intended for use with console. Inspects and prints the current page. -if false (default) then all classes will be inspected +if nil (default) then all classes will be inspected __Parameters:__ -&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[String] class_name - the class name to filter on. +&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Hash] class - a customizable set of options __Returns:__ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[void] -- -##### [current_app](https://github.com/appium/ruby_lib/blob/5a3ecbb4147693ce3c2c6b693e64074022d03511/lib/appium_lib/android/helper.rb#L88) android +##### [current_app](https://github.com/appium/ruby_lib/blob/2d7ab8b6cc442f39f6171f8a27bc4923e4d4e2a4/lib/appium_lib/android/helper.rb#L112) android > def current_app Lists package, activity, and adb shell am start -n value for current app. Works on local host only (not remote). noinspection RubyArgCount -- -##### [id](https://github.com/appium/ruby_lib/blob/5a3ecbb4147693ce3c2c6b693e64074022d03511/lib/appium_lib/android/helper.rb#L102) android +##### [id](https://github.com/appium/ruby_lib/blob/2d7ab8b6cc442f39f6171f8a27bc4923e4d4e2a4/lib/appium_lib/android/helper.rb#L137) android > def id id -Find by id +Find the first matching element by id __Parameters:__ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[String] id - the id to search for @@ -1229,12 +1229,28 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Element] -- -##### [ele_index](https://github.com/appium/ruby_lib/blob/5a3ecbb4147693ce3c2c6b693e64074022d03511/lib/appium_lib/android/helper.rb#L116) android +##### [ids](https://github.com/appium/ruby_lib/blob/2d7ab8b6cc442f39f6171f8a27bc4923e4d4e2a4/lib/appium_lib/android/helper.rb#L144) android +> def ids id + +Find all matching elements by id + +__Parameters:__ + +&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[String] id - the id to search for + +__Returns:__ + +&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Element] + +-- + +##### [ele_index](https://github.com/appium/ruby_lib/blob/2d7ab8b6cc442f39f6171f8a27bc4923e4d4e2a4/lib/appium_lib/android/helper.rb#L152) android + > def ele_index class_name, index Find the element of type class_name at matching index. __Parameters:__ @@ -1247,11 +1263,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Element] the found element of type class_name -- -##### [find_ele_by_attr](https://github.com/appium/ruby_lib/blob/5a3ecbb4147693ce3c2c6b693e64074022d03511/lib/appium_lib/android/helper.rb#L134) android +##### [find_ele_by_attr](https://github.com/appium/ruby_lib/blob/2d7ab8b6cc442f39f6171f8a27bc4923e4d4e2a4/lib/appium_lib/android/helper.rb#L170) android > def find_ele_by_attr class_name, attr, value Find the first element exactly matching class and attribute value. @@ -1267,11 +1283,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Element] -- -##### [find_eles_by_attr](https://github.com/appium/ruby_lib/blob/5a3ecbb4147693ce3c2c6b693e64074022d03511/lib/appium_lib/android/helper.rb#L143) android +##### [find_eles_by_attr](https://github.com/appium/ruby_lib/blob/2d7ab8b6cc442f39f6171f8a27bc4923e4d4e2a4/lib/appium_lib/android/helper.rb#L179) android > def find_eles_by_attr class_name, attr, value Find all elements exactly matching class and attribute value. @@ -1287,11 +1303,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Array<Element>] -- -##### [find_ele_by_attr_include](https://github.com/appium/ruby_lib/blob/5a3ecbb4147693ce3c2c6b693e64074022d03511/lib/appium_lib/android/helper.rb#L157) android +##### [find_ele_by_attr_include](https://github.com/appium/ruby_lib/blob/2d7ab8b6cc442f39f6171f8a27bc4923e4d4e2a4/lib/appium_lib/android/helper.rb#L193) android > def find_ele_by_attr_include class_name, attr, value Find the first element by attribute that exactly matches value. @@ -1307,11 +1323,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Element] the element of type tag who's attribute includes value -- -##### [find_eles_by_attr_include](https://github.com/appium/ruby_lib/blob/5a3ecbb4147693ce3c2c6b693e64074022d03511/lib/appium_lib/android/helper.rb#L166) android +##### [find_eles_by_attr_include](https://github.com/appium/ruby_lib/blob/2d7ab8b6cc442f39f6171f8a27bc4923e4d4e2a4/lib/appium_lib/android/helper.rb#L202) android > def find_eles_by_attr_include class_name, attr, value Find elements by attribute that include value. @@ -1327,11 +1343,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Array<Element>] the elements of type tag who's attribute includes value -- -##### [first_ele](https://github.com/appium/ruby_lib/blob/5a3ecbb4147693ce3c2c6b693e64074022d03511/lib/appium_lib/android/helper.rb#L173) android +##### [first_ele](https://github.com/appium/ruby_lib/blob/2d7ab8b6cc442f39f6171f8a27bc4923e4d4e2a4/lib/appium_lib/android/helper.rb#L209) android > def first_ele class_name Find the first element that matches class_name @@ -1343,11 +1359,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Element] -- -##### [last_ele](https://github.com/appium/ruby_lib/blob/5a3ecbb4147693ce3c2c6b693e64074022d03511/lib/appium_lib/android/helper.rb#L181) android +##### [last_ele](https://github.com/appium/ruby_lib/blob/2d7ab8b6cc442f39f6171f8a27bc4923e4d4e2a4/lib/appium_lib/android/helper.rb#L217) android > def last_ele class_name Find the last element that matches class_name @@ -1359,11 +1375,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Element] -- -##### [tag](https://github.com/appium/ruby_lib/blob/5a3ecbb4147693ce3c2c6b693e64074022d03511/lib/appium_lib/android/helper.rb#L189) android +##### [tag](https://github.com/appium/ruby_lib/blob/2d7ab8b6cc442f39f6171f8a27bc4923e4d4e2a4/lib/appium_lib/android/helper.rb#L225) android > def tag class_name Find the first element of type class_name @@ -1375,11 +1391,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Element] -- -##### [tags](https://github.com/appium/ruby_lib/blob/5a3ecbb4147693ce3c2c6b693e64074022d03511/lib/appium_lib/android/helper.rb#L197) android +##### [tags](https://github.com/appium/ruby_lib/blob/2d7ab8b6cc442f39f6171f8a27bc4923e4d4e2a4/lib/appium_lib/android/helper.rb#L233) android > def tags class_name Find all elements of type class_name @@ -1391,11 +1407,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Element] -- -##### [xpath_visible_contains](https://github.com/appium/ruby_lib/blob/5a3ecbb4147693ce3c2c6b693e64074022d03511/lib/appium_lib/android/helper.rb#L232) android +##### [xpath_visible_contains](https://github.com/appium/ruby_lib/blob/2d7ab8b6cc442f39f6171f8a27bc4923e4d4e2a4/lib/appium_lib/android/helper.rb#L268) android > def xpath_visible_contains element, value Find the first element that contains value @@ -1409,11 +1425,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Element] -- -##### [xpaths_visible_contains](https://github.com/appium/ruby_lib/blob/5a3ecbb4147693ce3c2c6b693e64074022d03511/lib/appium_lib/android/helper.rb#L240) android +##### [xpaths_visible_contains](https://github.com/appium/ruby_lib/blob/2d7ab8b6cc442f39f6171f8a27bc4923e4d4e2a4/lib/appium_lib/android/helper.rb#L276) android > def xpaths_visible_contains element, value Find all elements containing value @@ -1427,11 +1443,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Array<Element>] -- -##### [xpath_visible_exact](https://github.com/appium/ruby_lib/blob/5a3ecbb4147693ce3c2c6b693e64074022d03511/lib/appium_lib/android/helper.rb#L266) android +##### [xpath_visible_exact](https://github.com/appium/ruby_lib/blob/2d7ab8b6cc442f39f6171f8a27bc4923e4d4e2a4/lib/appium_lib/android/helper.rb#L302) android > def xpath_visible_exact element, value Find the first element exactly matching value @@ -1445,11 +1461,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Element] -- -##### [xpaths_visible_exact](https://github.com/appium/ruby_lib/blob/5a3ecbb4147693ce3c2c6b693e64074022d03511/lib/appium_lib/android/helper.rb#L274) android +##### [xpaths_visible_exact](https://github.com/appium/ruby_lib/blob/2d7ab8b6cc442f39f6171f8a27bc4923e4d4e2a4/lib/appium_lib/android/helper.rb#L310) android > def xpaths_visible_exact element, value Find all elements exactly matching value @@ -1463,21 +1479,21 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Element] -- -##### [TextView](https://github.com/appium/ruby_lib/blob/5a3ecbb4147693ce3c2c6b693e64074022d03511/lib/appium_lib/android/element/text.rb#L4) android +##### [TextView](https://github.com/appium/ruby_lib/blob/2d7ab8b6cc442f39f6171f8a27bc4923e4d4e2a4/lib/appium_lib/android/element/text.rb#L4) android > TextView = 'android.widget.TextView' -- -##### [s_text](https://github.com/appium/ruby_lib/blob/5a3ecbb4147693ce3c2c6b693e64074022d03511/lib/appium_lib/android/element/text.rb#L10) android +##### [text](https://github.com/appium/ruby_lib/blob/2d7ab8b6cc442f39f6171f8a27bc4923e4d4e2a4/lib/appium_lib/android/element/text.rb#L10) android -> def s_text value +> def text value Find the first TextView that contains value or by index. If int then the TextView at that index is returned. __Parameters:__ @@ -1488,15 +1504,16 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[TextView] -- -##### [s_texts](https://github.com/appium/ruby_lib/blob/5a3ecbb4147693ce3c2c6b693e64074022d03511/lib/appium_lib/android/element/text.rb#L18) android +##### [texts](https://github.com/appium/ruby_lib/blob/2d7ab8b6cc442f39f6171f8a27bc4923e4d4e2a4/lib/appium_lib/android/element/text.rb#L19) android -> def s_texts value +> def texts value=false Find all TextViews containing value. +If value is omitted, all texts are returned. __Parameters:__ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[String] value - the value to search for @@ -1504,37 +1521,37 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Array<TextView>] -- -##### [first_s_text](https://github.com/appium/ruby_lib/blob/5a3ecbb4147693ce3c2c6b693e64074022d03511/lib/appium_lib/android/element/text.rb#L24) android +##### [first_text](https://github.com/appium/ruby_lib/blob/2d7ab8b6cc442f39f6171f8a27bc4923e4d4e2a4/lib/appium_lib/android/element/text.rb#L26) android -> def first_s_text +> def first_text Find the first TextView. __Returns:__ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[TextView] -- -##### [last_s_text](https://github.com/appium/ruby_lib/blob/5a3ecbb4147693ce3c2c6b693e64074022d03511/lib/appium_lib/android/element/text.rb#L30) android +##### [last_text](https://github.com/appium/ruby_lib/blob/2d7ab8b6cc442f39f6171f8a27bc4923e4d4e2a4/lib/appium_lib/android/element/text.rb#L32) android -> def last_s_text +> def last_text Find the last TextView. __Returns:__ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[TextView] -- -##### [s_text_exact](https://github.com/appium/ruby_lib/blob/5a3ecbb4147693ce3c2c6b693e64074022d03511/lib/appium_lib/android/element/text.rb#L37) android +##### [text_exact](https://github.com/appium/ruby_lib/blob/2d7ab8b6cc442f39f6171f8a27bc4923e4d4e2a4/lib/appium_lib/android/element/text.rb#L39) android -> def s_text_exact value +> def text_exact value Find the first TextView that exactly matches value. __Parameters:__ @@ -1544,13 +1561,13 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[TextView] -- -##### [s_texts_exact](https://github.com/appium/ruby_lib/blob/5a3ecbb4147693ce3c2c6b693e64074022d03511/lib/appium_lib/android/element/text.rb#L44) android +##### [texts_exact](https://github.com/appium/ruby_lib/blob/2d7ab8b6cc442f39f6171f8a27bc4923e4d4e2a4/lib/appium_lib/android/element/text.rb#L46) android -> def s_texts_exact value +> def texts_exact value Find all TextViews that exactly match value. __Parameters:__ @@ -1560,24 +1577,12 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Array<TextView>] -- -##### [e_s_texts](https://github.com/appium/ruby_lib/blob/5a3ecbb4147693ce3c2c6b693e64074022d03511/lib/appium_lib/android/element/text.rb#L50) android +##### [alert_click](https://github.com/appium/ruby_lib/blob/2d7ab8b6cc442f39f6171f8a27bc4923e4d4e2a4/lib/appium_lib/android/element/alert.rb#L6) android -> def e_s_texts - -Find all TextViews. - -__Returns:__ - -&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Array<TextView>] - --- - -##### [alert_click](https://github.com/appium/ruby_lib/blob/5a3ecbb4147693ce3c2c6b693e64074022d03511/lib/appium_lib/android/element/alert.rb#L6) android - > def alert_click value Click the first alert button that contains value or by index. __Parameters:__ @@ -1588,11 +1593,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[void] -- -##### [alert_accept](https://github.com/appium/ruby_lib/blob/5a3ecbb4147693ce3c2c6b693e64074022d03511/lib/appium_lib/android/element/alert.rb#L13) android +##### [alert_accept](https://github.com/appium/ruby_lib/blob/2d7ab8b6cc442f39f6171f8a27bc4923e4d4e2a4/lib/appium_lib/android/element/alert.rb#L13) android > def alert_accept Accept the alert. The last button is considered "accept." @@ -1601,11 +1606,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[void] -- -##### [alert_accept_text](https://github.com/appium/ruby_lib/blob/5a3ecbb4147693ce3c2c6b693e64074022d03511/lib/appium_lib/android/element/alert.rb#L20) android +##### [alert_accept_text](https://github.com/appium/ruby_lib/blob/2d7ab8b6cc442f39f6171f8a27bc4923e4d4e2a4/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." @@ -1614,11 +1619,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[String] -- -##### [alert_dismiss](https://github.com/appium/ruby_lib/blob/5a3ecbb4147693ce3c2c6b693e64074022d03511/lib/appium_lib/android/element/alert.rb#L27) android +##### [alert_dismiss](https://github.com/appium/ruby_lib/blob/2d7ab8b6cc442f39f6171f8a27bc4923e4d4e2a4/lib/appium_lib/android/element/alert.rb#L27) android > def alert_dismiss Dismiss the alert. The first button is considered "dismiss." @@ -1627,11 +1632,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[void] -- -##### [alert_dismiss_text](https://github.com/appium/ruby_lib/blob/5a3ecbb4147693ce3c2c6b693e64074022d03511/lib/appium_lib/android/element/alert.rb#L34) android +##### [alert_dismiss_text](https://github.com/appium/ruby_lib/blob/2d7ab8b6cc442f39f6171f8a27bc4923e4d4e2a4/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." @@ -1640,11 +1645,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[String] -- -##### [uiautomator_find](https://github.com/appium/ruby_lib/blob/5a3ecbb4147693ce3c2c6b693e64074022d03511/lib/appium_lib/android/mobile_methods.rb#L10) android +##### [uiautomator_find](https://github.com/appium/ruby_lib/blob/2d7ab8b6cc442f39f6171f8a27bc4923e4d4e2a4/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). @@ -1652,27 +1657,27 @@ find_elements :uiautomator, 'new UiSelector().clickable(true)' ``` -- -##### [Button](https://github.com/appium/ruby_lib/blob/5a3ecbb4147693ce3c2c6b693e64074022d03511/lib/appium_lib/android/element/button.rb#L4) android +##### [Button](https://github.com/appium/ruby_lib/blob/2d7ab8b6cc442f39f6171f8a27bc4923e4d4e2a4/lib/appium_lib/android/element/button.rb#L4) android > Button = 'android.widget.Button' -- -##### [ImageButton](https://github.com/appium/ruby_lib/blob/5a3ecbb4147693ce3c2c6b693e64074022d03511/lib/appium_lib/android/element/button.rb#L5) android +##### [ImageButton](https://github.com/appium/ruby_lib/blob/2d7ab8b6cc442f39f6171f8a27bc4923e4d4e2a4/lib/appium_lib/android/element/button.rb#L5) android > ImageButton = 'android.widget.ImageButton' -- -##### [button](https://github.com/appium/ruby_lib/blob/5a3ecbb4147693ce3c2c6b693e64074022d03511/lib/appium_lib/android/element/button.rb#L39) android +##### [button](https://github.com/appium/ruby_lib/blob/2d7ab8b6cc442f39f6171f8a27bc4923e4d4e2a4/lib/appium_lib/android/element/button.rb#L39) android > def button value Find the first button that contains value or by index. If int then the button at that index is returned. @@ -1685,15 +1690,16 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Button] -- -##### [buttons](https://github.com/appium/ruby_lib/blob/5a3ecbb4147693ce3c2c6b693e64074022d03511/lib/appium_lib/android/element/button.rb#L55) android +##### [buttons](https://github.com/appium/ruby_lib/blob/2d7ab8b6cc442f39f6171f8a27bc4923e4d4e2a4/lib/appium_lib/android/element/button.rb#L56) android -> def buttons value +> def buttons value=false -Find all buttons containing value +Find all buttons containing value. +If value is omitted, all buttons are returned. __Parameters:__ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[String] value - the value to search for @@ -1701,11 +1707,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Array<Button>] -- -##### [first_button](https://github.com/appium/ruby_lib/blob/5a3ecbb4147693ce3c2c6b693e64074022d03511/lib/appium_lib/android/element/button.rb#L61) android +##### [first_button](https://github.com/appium/ruby_lib/blob/2d7ab8b6cc442f39f6171f8a27bc4923e4d4e2a4/lib/appium_lib/android/element/button.rb#L63) android > def first_button Find the first button. @@ -1713,11 +1719,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Button] -- -##### [last_button](https://github.com/appium/ruby_lib/blob/5a3ecbb4147693ce3c2c6b693e64074022d03511/lib/appium_lib/android/element/button.rb#L67) android +##### [last_button](https://github.com/appium/ruby_lib/blob/2d7ab8b6cc442f39f6171f8a27bc4923e4d4e2a4/lib/appium_lib/android/element/button.rb#L69) android > def last_button Find the last button. @@ -1725,11 +1731,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Button] -- -##### [button_exact](https://github.com/appium/ruby_lib/blob/5a3ecbb4147693ce3c2c6b693e64074022d03511/lib/appium_lib/android/element/button.rb#L74) android +##### [button_exact](https://github.com/appium/ruby_lib/blob/2d7ab8b6cc442f39f6171f8a27bc4923e4d4e2a4/lib/appium_lib/android/element/button.rb#L76) android > def button_exact value Find the first button that exactly matches value. @@ -1741,11 +1747,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Button] -- -##### [buttons_exact](https://github.com/appium/ruby_lib/blob/5a3ecbb4147693ce3c2c6b693e64074022d03511/lib/appium_lib/android/element/button.rb#L81) android +##### [buttons_exact](https://github.com/appium/ruby_lib/blob/2d7ab8b6cc442f39f6171f8a27bc4923e4d4e2a4/lib/appium_lib/android/element/button.rb#L83) android > def buttons_exact value Find all buttons that exactly match value. @@ -1757,24 +1763,12 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Array<Button>] -- -##### [e_buttons](https://github.com/appium/ruby_lib/blob/5a3ecbb4147693ce3c2c6b693e64074022d03511/lib/appium_lib/android/element/button.rb#L87) android +##### [find](https://github.com/appium/ruby_lib/blob/2d7ab8b6cc442f39f6171f8a27bc4923e4d4e2a4/lib/appium_lib/android/element/generic.rb#L7) android -> def e_buttons - -Find all buttons. - -__Returns:__ - -&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Array<Button>] - --- - -##### [find](https://github.com/appium/ruby_lib/blob/5a3ecbb4147693ce3c2c6b693e64074022d03511/lib/appium_lib/android/element/generic.rb#L7) android - > def find value Find the first element containing value __Parameters:__ @@ -1785,11 +1779,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Element] -- -##### [finds](https://github.com/appium/ruby_lib/blob/5a3ecbb4147693ce3c2c6b693e64074022d03511/lib/appium_lib/android/element/generic.rb#L14) android +##### [finds](https://github.com/appium/ruby_lib/blob/2d7ab8b6cc442f39f6171f8a27bc4923e4d4e2a4/lib/appium_lib/android/element/generic.rb#L14) android > def finds value Find all elements containing value @@ -1801,11 +1795,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Array<Element>] -- -##### [find_exact](https://github.com/appium/ruby_lib/blob/5a3ecbb4147693ce3c2c6b693e64074022d03511/lib/appium_lib/android/element/generic.rb#L21) android +##### [find_exact](https://github.com/appium/ruby_lib/blob/2d7ab8b6cc442f39f6171f8a27bc4923e4d4e2a4/lib/appium_lib/android/element/generic.rb#L21) android > def find_exact value Find the first element exactly matching value @@ -1817,11 +1811,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Element] -- -##### [finds_exact](https://github.com/appium/ruby_lib/blob/5a3ecbb4147693ce3c2c6b693e64074022d03511/lib/appium_lib/android/element/generic.rb#L28) android +##### [finds_exact](https://github.com/appium/ruby_lib/blob/2d7ab8b6cc442f39f6171f8a27bc4923e4d4e2a4/lib/appium_lib/android/element/generic.rb#L28) android > def finds_exact value Find all elements exactly matching value @@ -1833,11 +1827,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Array<Element>] -- -##### [scroll_to](https://github.com/appium/ruby_lib/blob/5a3ecbb4147693ce3c2c6b693e64074022d03511/lib/appium_lib/android/element/generic.rb#L35) android +##### [scroll_to](https://github.com/appium/ruby_lib/blob/2d7ab8b6cc442f39f6171f8a27bc4923e4d4e2a4/lib/appium_lib/android/element/generic.rb#L35) android > def scroll_to text Scroll to the first element containing target text or description. @@ -1849,11 +1843,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Element] the element scrolled to -- -##### [scroll_to_exact](https://github.com/appium/ruby_lib/blob/5a3ecbb4147693ce3c2c6b693e64074022d03511/lib/appium_lib/android/element/generic.rb#L48) android +##### [scroll_to_exact](https://github.com/appium/ruby_lib/blob/2d7ab8b6cc442f39f6171f8a27bc4923e4d4e2a4/lib/appium_lib/android/element/generic.rb#L48) android > def scroll_to_exact text Scroll to the first element with the exact target text or description. @@ -1865,19 +1859,19 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Element] the element scrolled to -- -##### [EditText](https://github.com/appium/ruby_lib/blob/5a3ecbb4147693ce3c2c6b693e64074022d03511/lib/appium_lib/android/element/textfield.rb#L3) android +##### [EditText](https://github.com/appium/ruby_lib/blob/2d7ab8b6cc442f39f6171f8a27bc4923e4d4e2a4/lib/appium_lib/android/element/textfield.rb#L3) android > EditText = 'android.widget.EditText' -- -##### [textfield](https://github.com/appium/ruby_lib/blob/5a3ecbb4147693ce3c2c6b693e64074022d03511/lib/appium_lib/android/element/textfield.rb#L9) android +##### [textfield](https://github.com/appium/ruby_lib/blob/2d7ab8b6cc442f39f6171f8a27bc4923e4d4e2a4/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. @@ -1890,15 +1884,16 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[EditText] -- -##### [textfields](https://github.com/appium/ruby_lib/blob/5a3ecbb4147693ce3c2c6b693e64074022d03511/lib/appium_lib/android/element/textfield.rb#L17) android +##### [textfields](https://github.com/appium/ruby_lib/blob/2d7ab8b6cc442f39f6171f8a27bc4923e4d4e2a4/lib/appium_lib/android/element/textfield.rb#L18) android -> def textfields value +> def textfields value=false Find all EditTexts containing value. +If value is omitted, all EditTexts are returned. __Parameters:__ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[String] value - the value to search for @@ -1906,11 +1901,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Array<EditText>] -- -##### [first_textfield](https://github.com/appium/ruby_lib/blob/5a3ecbb4147693ce3c2c6b693e64074022d03511/lib/appium_lib/android/element/textfield.rb#L23) android +##### [first_textfield](https://github.com/appium/ruby_lib/blob/2d7ab8b6cc442f39f6171f8a27bc4923e4d4e2a4/lib/appium_lib/android/element/textfield.rb#L25) android > def first_textfield Find the first EditText. @@ -1918,11 +1913,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[EditText] -- -##### [last_textfield](https://github.com/appium/ruby_lib/blob/5a3ecbb4147693ce3c2c6b693e64074022d03511/lib/appium_lib/android/element/textfield.rb#L29) android +##### [last_textfield](https://github.com/appium/ruby_lib/blob/2d7ab8b6cc442f39f6171f8a27bc4923e4d4e2a4/lib/appium_lib/android/element/textfield.rb#L31) android > def last_textfield Find the last EditText. @@ -1930,11 +1925,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[EditText] -- -##### [textfield_exact](https://github.com/appium/ruby_lib/blob/5a3ecbb4147693ce3c2c6b693e64074022d03511/lib/appium_lib/android/element/textfield.rb#L36) android +##### [textfield_exact](https://github.com/appium/ruby_lib/blob/2d7ab8b6cc442f39f6171f8a27bc4923e4d4e2a4/lib/appium_lib/android/element/textfield.rb#L38) android > def textfield_exact value Find the first EditText that exactly matches value. @@ -1946,11 +1941,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[EditText] -- -##### [textfields_exact](https://github.com/appium/ruby_lib/blob/5a3ecbb4147693ce3c2c6b693e64074022d03511/lib/appium_lib/android/element/textfield.rb#L43) android +##### [textfields_exact](https://github.com/appium/ruby_lib/blob/2d7ab8b6cc442f39f6171f8a27bc4923e4d4e2a4/lib/appium_lib/android/element/textfield.rb#L45) android > def textfields_exact value Find all EditTexts that exactly match value. @@ -1962,42 +1957,30 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Array<EditText>] -- -##### [e_textfields](https://github.com/appium/ruby_lib/blob/5a3ecbb4147693ce3c2c6b693e64074022d03511/lib/appium_lib/android/element/textfield.rb#L49) android +##### [value](https://github.com/appium/ruby_lib/blob/2d7ab8b6cc442f39f6171f8a27bc4923e4d4e2a4/lib/appium_lib/common/patch.rb#L10) -> def e_textfields - -Find all EditTexts. - -__Returns:__ - -&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Array<EditText>] - --- - -##### [value](https://github.com/appium/ruby_lib/blob/5a3ecbb4147693ce3c2c6b693e64074022d03511/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/5a3ecbb4147693ce3c2c6b693e64074022d03511/lib/appium_lib/common/patch.rb#L17) +##### [name](https://github.com/appium/ruby_lib/blob/2d7ab8b6cc442f39f6171f8a27bc4923e4d4e2a4/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/5a3ecbb4147693ce3c2c6b693e64074022d03511/lib/appium_lib/common/patch.rb#L29) +##### [location_rel](https://github.com/appium/ruby_lib/blob/2d7ab8b6cc442f39f6171f8a27bc4923e4d4e2a4/lib/appium_lib/common/patch.rb#L29) > def location_rel For use with mobile tap.