docs/ios_docs.md in appium_lib-4.0.0 vs docs/ios_docs.md in appium_lib-4.1.0

- old
+ new

@@ -1,6 +1,6 @@ -##### [load_appium_txt](https://github.com/appium/ruby_lib/blob/8cc004ad04ec087a8a11c06ca0749a5e2c6586a7/lib/appium_lib/driver.rb#L70) +##### [load_appium_txt](https://github.com/appium/ruby_lib/blob/a13158fb926212d84f26120c3bc5355c8cd34baf/lib/appium_lib/driver.rb#L72) > def self.load_appium_txt opts={} Load appium.txt (toml format) the basedir of this file + appium.txt is what's used @@ -25,30 +25,32 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[hash] the symbolized hash with updated :app and :require keys -- -##### [symbolize_keys](https://github.com/appium/ruby_lib/blob/8cc004ad04ec087a8a11c06ca0749a5e2c6586a7/lib/appium_lib/driver.rb#L140) +##### [symbolize_keys](https://github.com/appium/ruby_lib/blob/a13158fb926212d84f26120c3bc5355c8cd34baf/lib/appium_lib/driver.rb#L142) > def self.symbolize_keys hash convert all keys (including nested) to symbols based on deep_symbolize_keys & deep_transform_keys from rails https://github.com/rails/docrails/blob/a3b1105ada3da64acfa3843b164b14b734456a50/activesupport/lib/active_support/core_ext/hash/keys.rb#L84 -- -##### [promote_singleton_appium_methods](https://github.com/appium/ruby_lib/blob/8cc004ad04ec087a8a11c06ca0749a5e2c6586a7/lib/appium_lib/driver.rb#L150) +##### [promote_singleton_appium_methods](https://github.com/appium/ruby_lib/blob/a13158fb926212d84f26120c3bc5355c8cd34baf/lib/appium_lib/driver.rb#L155) -> def self.promote_singleton_appium_methods main_module +> def self.promote_singleton_appium_methods modules +if modules is a module instead of an array, then the constants of +that module are promoted on. +otherwise, the array of modules will be used as the promotion target. - -- -##### [promote_appium_methods](https://github.com/appium/ruby_lib/blob/8cc004ad04ec087a8a11c06ca0749a5e2c6586a7/lib/appium_lib/driver.rb#L179) +##### [promote_appium_methods](https://github.com/appium/ruby_lib/blob/a13158fb926212d84f26120c3bc5355c8cd34baf/lib/appium_lib/driver.rb#L195) > def self.promote_appium_methods class_array Promote appium methods to class instance methods @@ -62,75 +64,75 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Array<Class>] class_array - An array of classes -- -##### [global_webdriver_http_sleep](https://github.com/appium/ruby_lib/blob/8cc004ad04ec087a8a11c06ca0749a5e2c6586a7/lib/appium_lib/driver.rb#L212) +##### [global_webdriver_http_sleep](https://github.com/appium/ruby_lib/blob/a13158fb926212d84f26120c3bc5355c8cd34baf/lib/appium_lib/driver.rb#L228) > 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/8cc004ad04ec087a8a11c06ca0749a5e2c6586a7/lib/appium_lib/driver.rb#L212) +##### [global_webdriver_http_sleep=](https://github.com/appium/ruby_lib/blob/a13158fb926212d84f26120c3bc5355c8cd34baf/lib/appium_lib/driver.rb#L228) > def global_webdriver_http_sleep=(value) The amount to sleep in seconds before every webdriver http call. -- -##### [caps](https://github.com/appium/ruby_lib/blob/8cc004ad04ec087a8a11c06ca0749a5e2c6586a7/lib/appium_lib/driver.rb#L212) +##### [caps](https://github.com/appium/ruby_lib/blob/a13158fb926212d84f26120c3bc5355c8cd34baf/lib/appium_lib/driver.rb#L228) > 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) +##### [caps=](https://github.com/appium/ruby_lib/blob/a13158fb926212d84f26120c3bc5355c8cd34baf/lib/appium_lib/driver.rb#L228) > 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) +##### [custom_url](https://github.com/appium/ruby_lib/blob/a13158fb926212d84f26120c3bc5355c8cd34baf/lib/appium_lib/driver.rb#L228) > 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) +##### [custom_url=](https://github.com/appium/ruby_lib/blob/a13158fb926212d84f26120c3bc5355c8cd34baf/lib/appium_lib/driver.rb#L228) > 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) +##### [export_session](https://github.com/appium/ruby_lib/blob/a13158fb926212d84f26120c3bc5355c8cd34baf/lib/appium_lib/driver.rb#L228) > 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) +##### [export_session=](https://github.com/appium/ruby_lib/blob/a13158fb926212d84f26120c3bc5355c8cd34baf/lib/appium_lib/driver.rb#L228) > 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) +##### [default_wait](https://github.com/appium/ruby_lib/blob/a13158fb926212d84f26120c3bc5355c8cd34baf/lib/appium_lib/driver.rb#L228) > def default_wait Returns the default client side wait. This value is independent of what the server is using @@ -139,115 +141,115 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Integer] -- -##### [default_wait=](https://github.com/appium/ruby_lib/blob/8cc004ad04ec087a8a11c06ca0749a5e2c6586a7/lib/appium_lib/driver.rb#L212) +##### [default_wait=](https://github.com/appium/ruby_lib/blob/a13158fb926212d84f26120c3bc5355c8cd34baf/lib/appium_lib/driver.rb#L228) > 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) +##### [last_waits](https://github.com/appium/ruby_lib/blob/a13158fb926212d84f26120c3bc5355c8cd34baf/lib/appium_lib/driver.rb#L228) > 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) +##### [last_waits=](https://github.com/appium/ruby_lib/blob/a13158fb926212d84f26120c3bc5355c8cd34baf/lib/appium_lib/driver.rb#L228) > 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) +##### [sauce_username](https://github.com/appium/ruby_lib/blob/a13158fb926212d84f26120c3bc5355c8cd34baf/lib/appium_lib/driver.rb#L228) > 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) +##### [sauce_username=](https://github.com/appium/ruby_lib/blob/a13158fb926212d84f26120c3bc5355c8cd34baf/lib/appium_lib/driver.rb#L228) > 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) +##### [sauce_access_key](https://github.com/appium/ruby_lib/blob/a13158fb926212d84f26120c3bc5355c8cd34baf/lib/appium_lib/driver.rb#L228) > 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) +##### [sauce_access_key=](https://github.com/appium/ruby_lib/blob/a13158fb926212d84f26120c3bc5355c8cd34baf/lib/appium_lib/driver.rb#L228) > 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) +##### [appium_port](https://github.com/appium/ruby_lib/blob/a13158fb926212d84f26120c3bc5355c8cd34baf/lib/appium_lib/driver.rb#L228) > 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) +##### [appium_port=](https://github.com/appium/ruby_lib/blob/a13158fb926212d84f26120c3bc5355c8cd34baf/lib/appium_lib/driver.rb#L228) > 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) +##### [appium_device](https://github.com/appium/ruby_lib/blob/a13158fb926212d84f26120c3bc5355c8cd34baf/lib/appium_lib/driver.rb#L228) > 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) +##### [appium_device=](https://github.com/appium/ruby_lib/blob/a13158fb926212d84f26120c3bc5355c8cd34baf/lib/appium_lib/driver.rb#L228) > 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) +##### [appium_debug](https://github.com/appium/ruby_lib/blob/a13158fb926212d84f26120c3bc5355c8cd34baf/lib/appium_lib/driver.rb#L228) > 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) +##### [appium_debug=](https://github.com/appium/ruby_lib/blob/a13158fb926212d84f26120c3bc5355c8cd34baf/lib/appium_lib/driver.rb#L228) > 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) +##### [initialize](https://github.com/appium/ruby_lib/blob/a13158fb926212d84f26120c3bc5355c8cd34baf/lib/appium_lib/driver.rb#L259) > def initialize opts={} Creates a new driver @@ -274,19 +276,19 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Driver] -- -##### [driver_attributes](https://github.com/appium/ruby_lib/blob/8cc004ad04ec087a8a11c06ca0749a5e2c6586a7/lib/appium_lib/driver.rb#L318) +##### [driver_attributes](https://github.com/appium/ruby_lib/blob/a13158fb926212d84f26120c3bc5355c8cd34baf/lib/appium_lib/driver.rb#L334) > def driver_attributes Returns a hash of the driver attributes -- -##### [device_is_android?](https://github.com/appium/ruby_lib/blob/8cc004ad04ec087a8a11c06ca0749a5e2c6586a7/lib/appium_lib/driver.rb#L338) +##### [device_is_android?](https://github.com/appium/ruby_lib/blob/a13158fb926212d84f26120c3bc5355c8cd34baf/lib/appium_lib/driver.rb#L354) > def device_is_android? @@ -294,11 +296,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Boolean] -- -##### [appium_server_version](https://github.com/appium/ruby_lib/blob/8cc004ad04ec087a8a11c06ca0749a5e2c6586a7/lib/appium_lib/driver.rb#L354) +##### [appium_server_version](https://github.com/appium/ruby_lib/blob/a13158fb926212d84f26120c3bc5355c8cd34baf/lib/appium_lib/driver.rb#L370) > def appium_server_version Returns the server's version info @@ -315,23 +317,28 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Hash] -- -##### [absolute_app_path](https://github.com/appium/ruby_lib/blob/8cc004ad04ec087a8a11c06ca0749a5e2c6586a7/lib/appium_lib/driver.rb#L360) +##### [absolute_app_path](https://github.com/appium/ruby_lib/blob/a13158fb926212d84f26120c3bc5355c8cd34baf/lib/appium_lib/driver.rb#L382) -> def self.absolute_app_path app_path +> def self.absolute_app_path opts Converts app_path to an absolute path. +opts is the full options hash (caps and appium_lib). If server_url is set +then the app path is used as is. + +if app isn't set then an error is raised. + __Returns:__ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[String] APP_PATH as an absolute path -- -##### [server_url](https://github.com/appium/ruby_lib/blob/8cc004ad04ec087a8a11c06ca0749a5e2c6586a7/lib/appium_lib/driver.rb#L387) +##### [server_url](https://github.com/appium/ruby_lib/blob/a13158fb926212d84f26120c3bc5355c8cd34baf/lib/appium_lib/driver.rb#L415) > def server_url Get the server url @@ -339,11 +346,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[String] the server url -- -##### [restart](https://github.com/appium/ruby_lib/blob/8cc004ad04ec087a8a11c06ca0749a5e2c6586a7/lib/appium_lib/driver.rb#L398) +##### [restart](https://github.com/appium/ruby_lib/blob/a13158fb926212d84f26120c3bc5355c8cd34baf/lib/appium_lib/driver.rb#L426) > def restart Restarts the driver @@ -351,11 +358,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Driver] the driver -- -##### [driver](https://github.com/appium/ruby_lib/blob/8cc004ad04ec087a8a11c06ca0749a5e2c6586a7/lib/appium_lib/driver.rb#L405) +##### [driver](https://github.com/appium/ruby_lib/blob/a13158fb926212d84f26120c3bc5355c8cd34baf/lib/appium_lib/driver.rb#L433) > def driver Returns the driver @@ -363,11 +370,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Driver] the driver -- -##### [screenshot](https://github.com/appium/ruby_lib/blob/8cc004ad04ec087a8a11c06ca0749a5e2c6586a7/lib/appium_lib/driver.rb#L415) +##### [screenshot](https://github.com/appium/ruby_lib/blob/a13158fb926212d84f26120c3bc5355c8cd34baf/lib/appium_lib/driver.rb#L443) > def screenshot png_save_path Takes a png screenshot and saves to the target path. @@ -381,11 +388,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[nil] -- -##### [driver_quit](https://github.com/appium/ruby_lib/blob/8cc004ad04ec087a8a11c06ca0749a5e2c6586a7/lib/appium_lib/driver.rb#L422) +##### [driver_quit](https://github.com/appium/ruby_lib/blob/a13158fb926212d84f26120c3bc5355c8cd34baf/lib/appium_lib/driver.rb#L450) > def driver_quit Quits the driver @@ -393,11 +400,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[void] -- -##### [start_driver](https://github.com/appium/ruby_lib/blob/8cc004ad04ec087a8a11c06ca0749a5e2c6586a7/lib/appium_lib/driver.rb#L430) +##### [start_driver](https://github.com/appium/ruby_lib/blob/a13158fb926212d84f26120c3bc5355c8cd34baf/lib/appium_lib/driver.rb#L458) > def start_driver Creates a new global driver and quits the old one if it exists. @@ -405,19 +412,19 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Selenium::WebDriver] the new global driver -- -##### [no_wait](https://github.com/appium/ruby_lib/blob/8cc004ad04ec087a8a11c06ca0749a5e2c6586a7/lib/appium_lib/driver.rb#L457) +##### [no_wait](https://github.com/appium/ruby_lib/blob/a13158fb926212d84f26120c3bc5355c8cd34baf/lib/appium_lib/driver.rb#L485) > def no_wait Set implicit wait and default_wait to zero. -- -##### [set_wait](https://github.com/appium/ruby_lib/blob/8cc004ad04ec087a8a11c06ca0749a5e2c6586a7/lib/appium_lib/driver.rb#L476) +##### [set_wait](https://github.com/appium/ruby_lib/blob/a13158fb926212d84f26120c3bc5355c8cd34baf/lib/appium_lib/driver.rb#L504) > 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 @@ -438,11 +445,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[void] -- -##### [exists](https://github.com/appium/ruby_lib/blob/8cc004ad04ec087a8a11c06ca0749a5e2c6586a7/lib/appium_lib/driver.rb#L510) +##### [exists](https://github.com/appium/ruby_lib/blob/a13158fb926212d84f26120c3bc5355c8cd34baf/lib/appium_lib/driver.rb#L538) > def exists pre_check=0, post_check=@default_wait, &search_block Returns existence of element. @@ -464,11 +471,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Boolean] -- -##### [execute_script](https://github.com/appium/ruby_lib/blob/8cc004ad04ec087a8a11c06ca0749a5e2c6586a7/lib/appium_lib/driver.rb#L534) +##### [execute_script](https://github.com/appium/ruby_lib/blob/a13158fb926212d84f26120c3bc5355c8cd34baf/lib/appium_lib/driver.rb#L562) > def execute_script script, *args The same as @driver.execute_script @@ -482,11 +489,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Object] -- -##### [find_elements](https://github.com/appium/ruby_lib/blob/8cc004ad04ec087a8a11c06ca0749a5e2c6586a7/lib/appium_lib/driver.rb#L542) +##### [find_elements](https://github.com/appium/ruby_lib/blob/a13158fb926212d84f26120c3bc5355c8cd34baf/lib/appium_lib/driver.rb#L570) > def find_elements *args Calls @driver.find_elements @@ -498,11 +505,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Array<Element>] Array is empty when no elements are found. -- -##### [find_element](https://github.com/appium/ruby_lib/blob/8cc004ad04ec087a8a11c06ca0749a5e2c6586a7/lib/appium_lib/driver.rb#L550) +##### [find_element](https://github.com/appium/ruby_lib/blob/a13158fb926212d84f26120c3bc5355c8cd34baf/lib/appium_lib/driver.rb#L578) > def find_element *args Calls @driver.find_elements @@ -514,11 +521,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Element] -- -##### [x](https://github.com/appium/ruby_lib/blob/8cc004ad04ec087a8a11c06ca0749a5e2c6586a7/lib/appium_lib/driver.rb#L557) +##### [x](https://github.com/appium/ruby_lib/blob/a13158fb926212d84f26120c3bc5355c8cd34baf/lib/appium_lib/driver.rb#L585) > def x Quit the driver and Pry. quit and exit are reserved by Pry. @@ -527,79 +534,79 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[void] -- -##### [NoArgMethods](https://github.com/appium/ruby_lib/blob/8cc004ad04ec087a8a11c06ca0749a5e2c6586a7/lib/appium_lib/device/device.rb#L7) +##### [NoArgMethods](https://github.com/appium/ruby_lib/blob/a13158fb926212d84f26120c3bc5355c8cd34baf/lib/appium_lib/device/device.rb#L7) > NoArgMethods = { -- -##### [app_strings](https://github.com/appium/ruby_lib/blob/8cc004ad04ec087a8a11c06ca0749a5e2c6586a7/lib/appium_lib/device/device.rb#L22) +##### [app_strings](https://github.com/appium/ruby_lib/blob/a13158fb926212d84f26120c3bc5355c8cd34baf/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/8cc004ad04ec087a8a11c06ca0749a5e2c6586a7/lib/appium_lib/device/device.rb#L28) +##### [background_app](https://github.com/appium/ruby_lib/blob/a13158fb926212d84f26120c3bc5355c8cd34baf/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/8cc004ad04ec087a8a11c06ca0749a5e2c6586a7/lib/appium_lib/device/device.rb#L33) +##### [current_activity](https://github.com/appium/ruby_lib/blob/a13158fb926212d84f26120c3bc5355c8cd34baf/lib/appium_lib/device/device.rb#L33) > def current_activity -- -##### [launch](https://github.com/appium/ruby_lib/blob/8cc004ad04ec087a8a11c06ca0749a5e2c6586a7/lib/appium_lib/device/device.rb#L35) +##### [launch](https://github.com/appium/ruby_lib/blob/a13158fb926212d84f26120c3bc5355c8cd34baf/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/8cc004ad04ec087a8a11c06ca0749a5e2c6586a7/lib/appium_lib/device/device.rb#L38) +##### [reset](https://github.com/appium/ruby_lib/blob/a13158fb926212d84f26120c3bc5355c8cd34baf/lib/appium_lib/device/device.rb#L38) > def reset Reset the device, relaunching the application. -- -##### [shake](https://github.com/appium/ruby_lib/blob/8cc004ad04ec087a8a11c06ca0749a5e2c6586a7/lib/appium_lib/device/device.rb#L41) +##### [shake](https://github.com/appium/ruby_lib/blob/a13158fb926212d84f26120c3bc5355c8cd34baf/lib/appium_lib/device/device.rb#L41) > def shake Cause the device to shake -- -##### [toggle_flight_mode](https://github.com/appium/ruby_lib/blob/8cc004ad04ec087a8a11c06ca0749a5e2c6586a7/lib/appium_lib/device/device.rb#L44) +##### [toggle_flight_mode](https://github.com/appium/ruby_lib/blob/a13158fb926212d84f26120c3bc5355c8cd34baf/lib/appium_lib/device/device.rb#L44) > def toggle_flight_mode toggle flight mode on or off -- -##### [hide_keyboard](https://github.com/appium/ruby_lib/blob/8cc004ad04ec087a8a11c06ca0749a5e2c6586a7/lib/appium_lib/device/device.rb#L47) +##### [hide_keyboard](https://github.com/appium/ruby_lib/blob/a13158fb926212d84f26120c3bc5355c8cd34baf/lib/appium_lib/device/device.rb#L47) > def hide_keyboard Hide the onscreen keyboard @@ -608,11 +615,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[String] close_key - the name of the key which closes the keyboard. Defaults to 'Done'. -- -##### [press_keycode](https://github.com/appium/ruby_lib/blob/8cc004ad04ec087a8a11c06ca0749a5e2c6586a7/lib/appium_lib/device/device.rb#L56) +##### [press_keycode](https://github.com/appium/ruby_lib/blob/a13158fb926212d84f26120c3bc5355c8cd34baf/lib/appium_lib/device/device.rb#L56) > def press_keycode Press keycode on the device. http://developer.android.com/reference/android/view/KeyEvent.html @@ -623,11 +630,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[String] metastate - The state the metakeys should be in when pressing the key. -- -##### [long_press_keycode](https://github.com/appium/ruby_lib/blob/8cc004ad04ec087a8a11c06ca0749a5e2c6586a7/lib/appium_lib/device/device.rb#L62) +##### [long_press_keycode](https://github.com/appium/ruby_lib/blob/a13158fb926212d84f26120c3bc5355c8cd34baf/lib/appium_lib/device/device.rb#L62) > def long_press_keycode Long press keycode on the device. http://developer.android.com/reference/android/view/KeyEvent.html @@ -638,11 +645,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[String] metastate - The state the metakeys should be in when long pressing the key. -- -##### [push_file](https://github.com/appium/ruby_lib/blob/8cc004ad04ec087a8a11c06ca0749a5e2c6586a7/lib/appium_lib/device/device.rb#L68) +##### [push_file](https://github.com/appium/ruby_lib/blob/a13158fb926212d84f26120c3bc5355c8cd34baf/lib/appium_lib/device/device.rb#L68) > def push_file Place a file in a specific location on the device. @@ -652,11 +659,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[String] data - Raw file data to be sent to the device. -- -##### [pull_file](https://github.com/appium/ruby_lib/blob/8cc004ad04ec087a8a11c06ca0749a5e2c6586a7/lib/appium_lib/device/device.rb#L73) +##### [pull_file](https://github.com/appium/ruby_lib/blob/a13158fb926212d84f26120c3bc5355c8cd34baf/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). @@ -669,11 +676,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[String] path - Either an absolute path OR, for iOS devices, a path relative to the app, as described. -- -##### [pull_folder](https://github.com/appium/ruby_lib/blob/8cc004ad04ec087a8a11c06ca0749a5e2c6586a7/lib/appium_lib/device/device.rb#L83) +##### [pull_folder](https://github.com/appium/ruby_lib/blob/a13158fb926212d84f26120c3bc5355c8cd34baf/lib/appium_lib/device/device.rb#L83) > def pull_folder Retrieve a folder from the device. ```ruby @@ -684,19 +691,19 @@ &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) +##### [extend_search_contexts](https://github.com/appium/ruby_lib/blob/a13158fb926212d84f26120c3bc5355c8cd34baf/lib/appium_lib/device/device.rb#L274) > def extend_search_contexts -- -##### [accessiblity_id_find](https://github.com/appium/ruby_lib/blob/8cc004ad04ec087a8a11c06ca0749a5e2c6586a7/lib/appium_lib/device/device.rb#L274) +##### [accessiblity_id_find](https://github.com/appium/ruby_lib/blob/a13158fb926212d84f26120c3bc5355c8cd34baf/lib/appium_lib/device/device.rb#L274) > def accessiblity_id_find find_element/s with their accessibility_id @@ -704,19 +711,19 @@ find_elements :accessibility_id, 'Animation' ``` -- -##### [add_touch_actions](https://github.com/appium/ruby_lib/blob/8cc004ad04ec087a8a11c06ca0749a5e2c6586a7/lib/appium_lib/device/device.rb#L280) +##### [add_touch_actions](https://github.com/appium/ruby_lib/blob/a13158fb926212d84f26120c3bc5355c8cd34baf/lib/appium_lib/device/device.rb#L280) > def add_touch_actions -- -##### [set_context](https://github.com/appium/ruby_lib/blob/8cc004ad04ec087a8a11c06ca0749a5e2c6586a7/lib/appium_lib/device/device.rb#L304) +##### [set_context](https://github.com/appium/ruby_lib/blob/a13158fb926212d84f26120c3bc5355c8cd34baf/lib/appium_lib/device/device.rb#L304) > def set_context Change the context to the given context. ```ruby @@ -727,11 +734,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[String] The - context to change to -- -##### [current_context](https://github.com/appium/ruby_lib/blob/8cc004ad04ec087a8a11c06ca0749a5e2c6586a7/lib/appium_lib/device/device.rb#L312) +##### [current_context](https://github.com/appium/ruby_lib/blob/a13158fb926212d84f26120c3bc5355c8cd34baf/lib/appium_lib/device/device.rb#L312) > def current_context @@ -739,11 +746,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[String] The context currently being used. -- -##### [available_contexts](https://github.com/appium/ruby_lib/blob/8cc004ad04ec087a8a11c06ca0749a5e2c6586a7/lib/appium_lib/device/device.rb#L315) +##### [available_contexts](https://github.com/appium/ruby_lib/blob/a13158fb926212d84f26120c3bc5355c8cd34baf/lib/appium_lib/device/device.rb#L315) > def available_contexts @@ -751,11 +758,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/8cc004ad04ec087a8a11c06ca0749a5e2c6586a7/lib/appium_lib/device/device.rb#L325) +##### [within_context](https://github.com/appium/ruby_lib/blob/a13158fb926212d84f26120c3bc5355c8cd34baf/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 @@ -767,19 +774,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/8cc004ad04ec087a8a11c06ca0749a5e2c6586a7/lib/appium_lib/device/device.rb#L333) +##### [switch_to_default_context](https://github.com/appium/ruby_lib/blob/a13158fb926212d84f26120c3bc5355c8cd34baf/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/8cc004ad04ec087a8a11c06ca0749a5e2c6586a7/lib/appium_lib/device/multi_touch.rb#L30) +##### [pinch](https://github.com/appium/ruby_lib/blob/a13158fb926212d84f26120c3bc5355c8cd34baf/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. @@ -794,11 +801,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/8cc004ad04ec087a8a11c06ca0749a5e2c6586a7/lib/appium_lib/device/multi_touch.rb#L58) +##### [zoom](https://github.com/appium/ruby_lib/blob/a13158fb926212d84f26120c3bc5355c8cd34baf/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. @@ -813,11 +820,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/8cc004ad04ec087a8a11c06ca0749a5e2c6586a7/lib/appium_lib/device/multi_touch.rb#L79) +##### [initialize](https://github.com/appium/ruby_lib/blob/a13158fb926212d84f26120c3bc5355c8cd34baf/lib/appium_lib/device/multi_touch.rb#L79) > def initialize Create a new multi-action @@ -825,11 +832,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[MultiTouch] a new instance of MultiTouch -- -##### [add](https://github.com/appium/ruby_lib/blob/8cc004ad04ec087a8a11c06ca0749a5e2c6586a7/lib/appium_lib/device/multi_touch.rb#L85) +##### [add](https://github.com/appium/ruby_lib/blob/a13158fb926212d84f26120c3bc5355c8cd34baf/lib/appium_lib/device/multi_touch.rb#L85) > def add(chain) Add a touch_action to be performed @@ -837,43 +844,43 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[TouchAction] chain - The action to add to the chain -- -##### [perform](https://github.com/appium/ruby_lib/blob/8cc004ad04ec087a8a11c06ca0749a5e2c6586a7/lib/appium_lib/device/multi_touch.rb#L90) +##### [perform](https://github.com/appium/ruby_lib/blob/a13158fb926212d84f26120c3bc5355c8cd34baf/lib/appium_lib/device/multi_touch.rb#L90) > def perform Ask Appium to perform the actions -- -##### [ACTIONS](https://github.com/appium/ruby_lib/blob/8cc004ad04ec087a8a11c06ca0749a5e2c6586a7/lib/appium_lib/device/touch_actions.rb#L12) +##### [ACTIONS](https://github.com/appium/ruby_lib/blob/a13158fb926212d84f26120c3bc5355c8cd34baf/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/8cc004ad04ec087a8a11c06ca0749a5e2c6586a7/lib/appium_lib/device/touch_actions.rb#L13) +##### [COMPLEX_ACTIONS](https://github.com/appium/ruby_lib/blob/a13158fb926212d84f26120c3bc5355c8cd34baf/lib/appium_lib/device/touch_actions.rb#L13) > COMPLEX_ACTIONS = [:swipe] -- -##### [actions](https://github.com/appium/ruby_lib/blob/8cc004ad04ec087a8a11c06ca0749a5e2c6586a7/lib/appium_lib/device/touch_actions.rb#L27) +##### [actions](https://github.com/appium/ruby_lib/blob/a13158fb926212d84f26120c3bc5355c8cd34baf/lib/appium_lib/device/touch_actions.rb#L27) > def actions Returns the value of attribute actions -- -##### [initialize](https://github.com/appium/ruby_lib/blob/8cc004ad04ec087a8a11c06ca0749a5e2c6586a7/lib/appium_lib/device/touch_actions.rb#L29) +##### [initialize](https://github.com/appium/ruby_lib/blob/a13158fb926212d84f26120c3bc5355c8cd34baf/lib/appium_lib/device/touch_actions.rb#L29) > def initialize @@ -881,11 +888,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[TouchAction] a new instance of TouchAction -- -##### [move_to](https://github.com/appium/ruby_lib/blob/8cc004ad04ec087a8a11c06ca0749a5e2c6586a7/lib/appium_lib/device/touch_actions.rb#L37) +##### [move_to](https://github.com/appium/ruby_lib/blob/a13158fb926212d84f26120c3bc5355c8cd34baf/lib/appium_lib/device/touch_actions.rb#L37) > def move_to(opts) Move to the given co-ordinates. @@ -893,11 +900,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Hash] opts - a customizable set of options -- -##### [long_press](https://github.com/appium/ruby_lib/blob/8cc004ad04ec087a8a11c06ca0749a5e2c6586a7/lib/appium_lib/device/touch_actions.rb#L47) +##### [long_press](https://github.com/appium/ruby_lib/blob/a13158fb926212d84f26120c3bc5355c8cd34baf/lib/appium_lib/device/touch_actions.rb#L47) > def long_press(opts) Press down for a specific duration. @@ -911,11 +918,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Hash] duration - a customizable set of options -- -##### [press](https://github.com/appium/ruby_lib/blob/8cc004ad04ec087a8a11c06ca0749a5e2c6586a7/lib/appium_lib/device/touch_actions.rb#L59) +##### [press](https://github.com/appium/ruby_lib/blob/a13158fb926212d84f26120c3bc5355c8cd34baf/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`. @@ -924,11 +931,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Hash] opts - a customizable set of options -- -##### [release](https://github.com/appium/ruby_lib/blob/8cc004ad04ec087a8a11c06ca0749a5e2c6586a7/lib/appium_lib/device/touch_actions.rb#L70) +##### [release](https://github.com/appium/ruby_lib/blob/a13158fb926212d84f26120c3bc5355c8cd34baf/lib/appium_lib/device/touch_actions.rb#L70) > def release(opts=nil) Remove a finger from the screen. @@ -936,11 +943,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Hash] opts - a customizable set of options -- -##### [tap](https://github.com/appium/ruby_lib/blob/8cc004ad04ec087a8a11c06ca0749a5e2c6586a7/lib/appium_lib/device/touch_actions.rb#L81) +##### [tap](https://github.com/appium/ruby_lib/blob/a13158fb926212d84f26120c3bc5355c8cd34baf/lib/appium_lib/device/touch_actions.rb#L81) > def tap(opts) Touch a point on the screen @@ -948,11 +955,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Hash] opts - a customizable set of options -- -##### [wait](https://github.com/appium/ruby_lib/blob/8cc004ad04ec087a8a11c06ca0749a5e2c6586a7/lib/appium_lib/device/touch_actions.rb#L90) +##### [wait](https://github.com/appium/ruby_lib/blob/a13158fb926212d84f26120c3bc5355c8cd34baf/lib/appium_lib/device/touch_actions.rb#L90) > def wait(milliseconds) Pause for a number of milliseconds before the next action @@ -960,113 +967,120 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[integer] milliseconds - Number of milliseconds to pause for -- -##### [swipe](https://github.com/appium/ruby_lib/blob/8cc004ad04ec087a8a11c06ca0749a5e2c6586a7/lib/appium_lib/device/touch_actions.rb#L101) +##### [swipe](https://github.com/appium/ruby_lib/blob/a13158fb926212d84f26120c3bc5355c8cd34baf/lib/appium_lib/device/touch_actions.rb#L104) > def swipe(opts) Convenience method to peform a swipe. +Note that iOS 7 simulators have broken swipe. + __Parameters:__ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Hash] opts - a customizable set of options -- -##### [perform](https://github.com/appium/ruby_lib/blob/8cc004ad04ec087a8a11c06ca0749a5e2c6586a7/lib/appium_lib/device/touch_actions.rb#L116) +##### [perform](https://github.com/appium/ruby_lib/blob/a13158fb926212d84f26120c3bc5355c8cd34baf/lib/appium_lib/device/touch_actions.rb#L119) > def perform Ask the driver to perform all actions in this action chain. -- -##### [cancel](https://github.com/appium/ruby_lib/blob/8cc004ad04ec087a8a11c06ca0749a5e2c6586a7/lib/appium_lib/device/touch_actions.rb#L122) +##### [cancel](https://github.com/appium/ruby_lib/blob/a13158fb926212d84f26120c3bc5355c8cd34baf/lib/appium_lib/device/touch_actions.rb#L125) > def cancel Does nothing, currently. -- -##### [chain_method](https://github.com/appium/ruby_lib/blob/8cc004ad04ec087a8a11c06ca0749a5e2c6586a7/lib/appium_lib/device/touch_actions.rb#L130) +##### [chain_method](https://github.com/appium/ruby_lib/blob/a13158fb926212d84f26120c3bc5355c8cd34baf/lib/appium_lib/device/touch_actions.rb#L133) > def chain_method(method, args=nil) -- -##### [args_with_ele_ref](https://github.com/appium/ruby_lib/blob/8cc004ad04ec087a8a11c06ca0749a5e2c6586a7/lib/appium_lib/device/touch_actions.rb#L139) +##### [args_with_ele_ref](https://github.com/appium/ruby_lib/blob/a13158fb926212d84f26120c3bc5355c8cd34baf/lib/appium_lib/device/touch_actions.rb#L142) > def args_with_ele_ref(args) -- -##### [wait](https://github.com/appium/ruby_lib/blob/8cc004ad04ec087a8a11c06ca0749a5e2c6586a7/lib/appium_lib/common/helper.rb#L33) +##### [_generic_wait](https://github.com/appium/ruby_lib/blob/a13158fb926212d84f26120c3bc5355c8cd34baf/lib/appium_lib/common/wait.rb#L10) -> def wait max_wait=30, interval=0.5, &block +> def _generic_wait opts={}, &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. -if .call doesn't raise an exception then it will stop waiting. +Wait code from the selenium Ruby gem +https://github.com/SeleniumHQ/selenium/blob/cf501dda3f0ed12233de51ce8170c0e8090f0c20/rb/lib/selenium/webdriver/common/wait.rb -Example: wait { name('back').click } +-- -Give up after 30 seconds. +##### [_process_wait_opts](https://github.com/appium/ruby_lib/blob/a13158fb926212d84f26120c3bc5355c8cd34baf/lib/appium_lib/common/wait.rb#L55) -__Parameters:__ +> def _process_wait_opts opts -&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Integer] max_wait - the maximum time in seconds to wait for. -Note that max wait 0 means infinity. +process opts before calling _generic_wait -&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Float] interval - the time in seconds to wait after calling the block +-- -&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Block] block - the block to call +##### [wait_true](https://github.com/appium/ruby_lib/blob/a13158fb926212d84f26120c3bc5355c8cd34baf/lib/appium_lib/common/wait.rb#L76) -__Returns:__ +> def wait_true opts={}, &block -&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Object] the result of block.call +Check every interval seconds to see if block.call returns a truthy value. +Note this isn't a strict boolean true, any truthy value is accepted. +false and nil are considered failures. +Give up after timeout seconds. --- +Wait code from the selenium Ruby gem +https://github.com/SeleniumHQ/selenium/blob/cf501dda3f0ed12233de51ce8170c0e8090f0c20/rb/lib/selenium/webdriver/common/wait.rb -##### [ignore](https://github.com/appium/ruby_lib/blob/8cc004ad04ec087a8a11c06ca0749a5e2c6586a7/lib/appium_lib/common/helper.rb#L54) +If only a number is provided then it's treated as the timeout value. -> def ignore &block +__Parameters:__ -Return block.call and ignore any exceptions. +&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Hash] opts - Options -- -##### [wait_true](https://github.com/appium/ruby_lib/blob/8cc004ad04ec087a8a11c06ca0749a5e2c6586a7/lib/appium_lib/common/helper.rb#L69) +##### [wait](https://github.com/appium/ruby_lib/blob/a13158fb926212d84f26120c3bc5355c8cd34baf/lib/appium_lib/common/wait.rb#L94) -> def wait_true max_wait=30, interval=0.5, &block +> def wait opts={}, &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. -false and nil are considered failures. -Give up after 30 seconds. +Check every interval seconds to see if block.call doesn't raise an exception. +Give up after timeout seconds. +Wait code from the selenium Ruby gem +https://github.com/SeleniumHQ/selenium/blob/cf501dda3f0ed12233de51ce8170c0e8090f0c20/rb/lib/selenium/webdriver/common/wait.rb + +If only a number is provided then it's treated as the timeout value. + __Parameters:__ -&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Integer] max_wait - the maximum time in seconds to wait for +&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Hash] opts - Options -&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Float] interval - the time in seconds to wait after calling the block +-- -&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Block] block - the block to call +##### [ignore](https://github.com/appium/ruby_lib/blob/a13158fb926212d84f26120c3bc5355c8cd34baf/lib/appium_lib/common/helper.rb#L22) -__Returns:__ +> def ignore &block -&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Object] the result of block.call +Return block.call and ignore any exceptions. -- -##### [back](https://github.com/appium/ruby_lib/blob/8cc004ad04ec087a8a11c06ca0749a5e2c6586a7/lib/appium_lib/common/helper.rb#L89) +##### [back](https://github.com/appium/ruby_lib/blob/a13158fb926212d84f26120c3bc5355c8cd34baf/lib/appium_lib/common/helper.rb#L31) > def back Navigate back. @@ -1074,19 +1088,19 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[void] -- -##### [session_id](https://github.com/appium/ruby_lib/blob/8cc004ad04ec087a8a11c06ca0749a5e2c6586a7/lib/appium_lib/common/helper.rb#L94) +##### [session_id](https://github.com/appium/ruby_lib/blob/a13158fb926212d84f26120c3bc5355c8cd34baf/lib/appium_lib/common/helper.rb#L36) > def session_id For Sauce Labs reporting. Returns the current session id. -- -##### [xpath](https://github.com/appium/ruby_lib/blob/8cc004ad04ec087a8a11c06ca0749a5e2c6586a7/lib/appium_lib/common/helper.rb#L102) +##### [xpath](https://github.com/appium/ruby_lib/blob/a13158fb926212d84f26120c3bc5355c8cd34baf/lib/appium_lib/common/helper.rb#L44) > def xpath xpath_str Returns the first element that matches the provided xpath. @@ -1098,11 +1112,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Element] -- -##### [xpaths](https://github.com/appium/ruby_lib/blob/8cc004ad04ec087a8a11c06ca0749a5e2c6586a7/lib/appium_lib/common/helper.rb#L110) +##### [xpaths](https://github.com/appium/ruby_lib/blob/a13158fb926212d84f26120c3bc5355c8cd34baf/lib/appium_lib/common/helper.rb#L52) > def xpaths xpath_str Returns all elements that match the provided xpath. @@ -1114,11 +1128,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Array<Element>] -- -##### [source](https://github.com/appium/ruby_lib/blob/8cc004ad04ec087a8a11c06ca0749a5e2c6586a7/lib/appium_lib/common/helper.rb#L116) +##### [source](https://github.com/appium/ruby_lib/blob/a13158fb926212d84f26120c3bc5355c8cd34baf/lib/appium_lib/common/helper.rb#L58) > def source Prints xml of the current page @@ -1126,11 +1140,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[void] -- -##### [get_source](https://github.com/appium/ruby_lib/blob/8cc004ad04ec087a8a11c06ca0749a5e2c6586a7/lib/appium_lib/common/helper.rb#L134) +##### [get_source](https://github.com/appium/ruby_lib/blob/a13158fb926212d84f26120c3bc5355c8cd34baf/lib/appium_lib/common/helper.rb#L76) > def get_source Returns XML string for the current page Same as driver.page_source @@ -1139,19 +1153,19 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[String] -- -##### [result](https://github.com/appium/ruby_lib/blob/8cc004ad04ec087a8a11c06ca0749a5e2c6586a7/lib/appium_lib/common/helper.rb#L141) +##### [result](https://github.com/appium/ruby_lib/blob/a13158fb926212d84f26120c3bc5355c8cd34baf/lib/appium_lib/common/helper.rb#L83) > def result Returns the value of attribute result -- -##### [initialize](https://github.com/appium/ruby_lib/blob/8cc004ad04ec087a8a11c06ca0749a5e2c6586a7/lib/appium_lib/common/helper.rb#L143) +##### [initialize](https://github.com/appium/ruby_lib/blob/a13158fb926212d84f26120c3bc5355c8cd34baf/lib/appium_lib/common/helper.rb#L85) > def initialize @@ -1159,52 +1173,52 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[CountElements] a new instance of CountElements -- -##### [reset](https://github.com/appium/ruby_lib/blob/8cc004ad04ec087a8a11c06ca0749a5e2c6586a7/lib/appium_lib/common/helper.rb#L147) +##### [reset](https://github.com/appium/ruby_lib/blob/a13158fb926212d84f26120c3bc5355c8cd34baf/lib/appium_lib/common/helper.rb#L89) > def reset -- -##### [start_element](https://github.com/appium/ruby_lib/blob/8cc004ad04ec087a8a11c06ca0749a5e2c6586a7/lib/appium_lib/common/helper.rb#L152) +##### [start_element](https://github.com/appium/ruby_lib/blob/a13158fb926212d84f26120c3bc5355c8cd34baf/lib/appium_lib/common/helper.rb#L94) > def start_element name, attrs = [] http://nokogiri.org/Nokogiri/XML/SAX/Document.html -- -##### [formatted_result](https://github.com/appium/ruby_lib/blob/8cc004ad04ec087a8a11c06ca0749a5e2c6586a7/lib/appium_lib/common/helper.rb#L158) +##### [formatted_result](https://github.com/appium/ruby_lib/blob/a13158fb926212d84f26120c3bc5355c8cd34baf/lib/appium_lib/common/helper.rb#L100) > def formatted_result -- -##### [get_page_class](https://github.com/appium/ruby_lib/blob/8cc004ad04ec087a8a11c06ca0749a5e2c6586a7/lib/appium_lib/common/helper.rb#L169) +##### [get_page_class](https://github.com/appium/ruby_lib/blob/a13158fb926212d84f26120c3bc5355c8cd34baf/lib/appium_lib/common/helper.rb#L111) > def get_page_class Returns a string of class counts of visible elements. -- -##### [page_class](https://github.com/appium/ruby_lib/blob/8cc004ad04ec087a8a11c06ca0749a5e2c6586a7/lib/appium_lib/common/helper.rb#L180) +##### [page_class](https://github.com/appium/ruby_lib/blob/a13158fb926212d84f26120c3bc5355c8cd34baf/lib/appium_lib/common/helper.rb#L122) > 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/8cc004ad04ec087a8a11c06ca0749a5e2c6586a7/lib/appium_lib/common/helper.rb#L190) +##### [px_to_window_rel](https://github.com/appium/ruby_lib/blob/a13158fb926212d84f26120c3bc5355c8cd34baf/lib/appium_lib/common/helper.rb#L132) > def px_to_window_rel opts={} Converts pixel values to window relative values @@ -1212,11 +1226,11 @@ px_to_window_rel x: 50, y: 150 ``` -- -##### [xml_keys](https://github.com/appium/ruby_lib/blob/8cc004ad04ec087a8a11c06ca0749a5e2c6586a7/lib/appium_lib/common/helper.rb#L207) +##### [xml_keys](https://github.com/appium/ruby_lib/blob/a13158fb926212d84f26120c3bc5355c8cd34baf/lib/appium_lib/common/helper.rb#L149) > def xml_keys target Search strings.xml's values for target. @@ -1228,11 +1242,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Array] -- -##### [xml_values](https://github.com/appium/ruby_lib/blob/8cc004ad04ec087a8a11c06ca0749a5e2c6586a7/lib/appium_lib/common/helper.rb#L215) +##### [xml_values](https://github.com/appium/ruby_lib/blob/a13158fb926212d84f26120c3bc5355c8cd34baf/lib/appium_lib/common/helper.rb#L157) > def xml_values target Search strings.xml's keys for target. @@ -1244,11 +1258,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Array] -- -##### [resolve_id](https://github.com/appium/ruby_lib/blob/8cc004ad04ec087a8a11c06ca0749a5e2c6586a7/lib/appium_lib/common/helper.rb#L223) +##### [resolve_id](https://github.com/appium/ruby_lib/blob/a13158fb926212d84f26120c3bc5355c8cd34baf/lib/appium_lib/common/helper.rb#L165) > def resolve_id id Resolve id in strings.xml and return the value. @@ -1260,27 +1274,27 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[String] -- -##### [filter](https://github.com/appium/ruby_lib/blob/8cc004ad04ec087a8a11c06ca0749a5e2c6586a7/lib/appium_lib/common/helper.rb#L229) +##### [filter](https://github.com/appium/ruby_lib/blob/a13158fb926212d84f26120c3bc5355c8cd34baf/lib/appium_lib/common/helper.rb#L171) > def filter -- -##### [filter=](https://github.com/appium/ruby_lib/blob/8cc004ad04ec087a8a11c06ca0749a5e2c6586a7/lib/appium_lib/common/helper.rb#L234) +##### [filter=](https://github.com/appium/ruby_lib/blob/a13158fb926212d84f26120c3bc5355c8cd34baf/lib/appium_lib/common/helper.rb#L176) > def filter= value convert to string to support symbols -- -##### [initialize](https://github.com/appium/ruby_lib/blob/8cc004ad04ec087a8a11c06ca0749a5e2c6586a7/lib/appium_lib/common/helper.rb#L240) +##### [initialize](https://github.com/appium/ruby_lib/blob/a13158fb926212d84f26120c3bc5355c8cd34baf/lib/appium_lib/common/helper.rb#L182) > def initialize @@ -1288,59 +1302,59 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[HTMLElements] a new instance of HTMLElements -- -##### [reset](https://github.com/appium/ruby_lib/blob/8cc004ad04ec087a8a11c06ca0749a5e2c6586a7/lib/appium_lib/common/helper.rb#L245) +##### [reset](https://github.com/appium/ruby_lib/blob/a13158fb926212d84f26120c3bc5355c8cd34baf/lib/appium_lib/common/helper.rb#L187) > def reset -- -##### [result](https://github.com/appium/ruby_lib/blob/8cc004ad04ec087a8a11c06ca0749a5e2c6586a7/lib/appium_lib/common/helper.rb#L251) +##### [result](https://github.com/appium/ruby_lib/blob/a13158fb926212d84f26120c3bc5355c8cd34baf/lib/appium_lib/common/helper.rb#L193) > def result -- -##### [start_element](https://github.com/appium/ruby_lib/blob/8cc004ad04ec087a8a11c06ca0749a5e2c6586a7/lib/appium_lib/common/helper.rb#L265) +##### [start_element](https://github.com/appium/ruby_lib/blob/a13158fb926212d84f26120c3bc5355c8cd34baf/lib/appium_lib/common/helper.rb#L207) > def start_element name, attrs = [] -- -##### [end_element](https://github.com/appium/ruby_lib/blob/8cc004ad04ec087a8a11c06ca0749a5e2c6586a7/lib/appium_lib/common/helper.rb#L275) +##### [end_element](https://github.com/appium/ruby_lib/blob/a13158fb926212d84f26120c3bc5355c8cd34baf/lib/appium_lib/common/helper.rb#L217) > def end_element name -- -##### [characters](https://github.com/appium/ruby_lib/blob/8cc004ad04ec087a8a11c06ca0749a5e2c6586a7/lib/appium_lib/common/helper.rb#L281) +##### [characters](https://github.com/appium/ruby_lib/blob/a13158fb926212d84f26120c3bc5355c8cd34baf/lib/appium_lib/common/helper.rb#L223) > def characters(chars) -- -##### [window_size](https://github.com/appium/ruby_lib/blob/8cc004ad04ec087a8a11c06ca0749a5e2c6586a7/lib/appium_lib/common/element/window.rb#L5) +##### [window_size](https://github.com/appium/ruby_lib/blob/a13158fb926212d84f26120c3bc5355c8cd34baf/lib/appium_lib/common/element/window.rb#L5) > def window_size Get the window's size -- -##### [ios_password](https://github.com/appium/ruby_lib/blob/8cc004ad04ec087a8a11c06ca0749a5e2c6586a7/lib/appium_lib/ios/helper.rb#L8) ios +##### [ios_password](https://github.com/appium/ruby_lib/blob/a13158fb926212d84f26120c3bc5355c8cd34baf/lib/appium_lib/ios/helper.rb#L8) ios > def ios_password length=1 iOS only. On Android uiautomator always returns an empty string for EditText password. @@ -1354,11 +1368,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[String] the returned string is of size length -- -##### [get_page](https://github.com/appium/ruby_lib/blob/8cc004ad04ec087a8a11c06ca0749a5e2c6586a7/lib/appium_lib/ios/helper.rb#L20) ios +##### [get_page](https://github.com/appium/ruby_lib/blob/a13158fb926212d84f26120c3bc5355c8cd34baf/lib/appium_lib/ios/helper.rb#L20) ios > def get_page element=source_window(0), class_name=nil Returns a string of interesting elements. iOS only. @@ -1375,11 +1389,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[String] -- -##### [page](https://github.com/appium/ruby_lib/blob/8cc004ad04ec087a8a11c06ca0749a5e2c6586a7/lib/appium_lib/ios/helper.rb#L125) ios +##### [page](https://github.com/appium/ruby_lib/blob/a13158fb926212d84f26120c3bc5355c8cd34baf/lib/appium_lib/ios/helper.rb#L125) ios > def page opts={} Prints a string of interesting elements to the console. @@ -1401,11 +1415,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[void] -- -##### [source_window](https://github.com/appium/ruby_lib/blob/8cc004ad04ec087a8a11c06ca0749a5e2c6586a7/lib/appium_lib/ios/helper.rb#L157) ios +##### [source_window](https://github.com/appium/ruby_lib/blob/a13158fb926212d84f26120c3bc5355c8cd34baf/lib/appium_lib/ios/helper.rb#L157) ios > def source_window window_number=0 Gets the JSON source of window number @@ -1417,11 +1431,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[JSON] -- -##### [page_window](https://github.com/appium/ruby_lib/blob/8cc004ad04ec087a8a11c06ca0749a5e2c6586a7/lib/appium_lib/ios/helper.rb#L171) ios +##### [page_window](https://github.com/appium/ruby_lib/blob/a13158fb926212d84f26120c3bc5355c8cd34baf/lib/appium_lib/ios/helper.rb#L171) ios > def page_window window_number=0 Prints parsed page source to console. @@ -1435,11 +1449,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[void] -- -##### [id](https://github.com/appium/ruby_lib/blob/8cc004ad04ec087a8a11c06ca0749a5e2c6586a7/lib/appium_lib/ios/helper.rb#L179) ios +##### [id](https://github.com/appium/ruby_lib/blob/a13158fb926212d84f26120c3bc5355c8cd34baf/lib/appium_lib/ios/helper.rb#L179) ios > def id id Find by id @@ -1451,11 +1465,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Element] -- -##### [ios_version](https://github.com/appium/ruby_lib/blob/8cc004ad04ec087a8a11c06ca0749a5e2c6586a7/lib/appium_lib/ios/helper.rb#L189) ios +##### [ios_version](https://github.com/appium/ruby_lib/blob/a13158fb926212d84f26120c3bc5355c8cd34baf/lib/appium_lib/ios/helper.rb#L189) ios > def ios_version Return the iOS version as an array of integers @@ -1463,11 +1477,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Array<Integer>] -- -##### [ele_index](https://github.com/appium/ruby_lib/blob/8cc004ad04ec087a8a11c06ca0749a5e2c6586a7/lib/appium_lib/ios/helper.rb#L198) ios +##### [ele_index](https://github.com/appium/ruby_lib/blob/a13158fb926212d84f26120c3bc5355c8cd34baf/lib/appium_lib/ios/helper.rb#L198) ios > def ele_index class_name, index Get the element of type class_name at matching index. @@ -1481,11 +1495,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Element] -- -##### [find_ele_by_attr](https://github.com/appium/ruby_lib/blob/8cc004ad04ec087a8a11c06ca0749a5e2c6586a7/lib/appium_lib/ios/helper.rb#L216) ios +##### [find_ele_by_attr](https://github.com/appium/ruby_lib/blob/a13158fb926212d84f26120c3bc5355c8cd34baf/lib/appium_lib/ios/helper.rb#L216) ios > def find_ele_by_attr class_name, attr, value Find the first element exactly matching class and attribute value. @@ -1501,11 +1515,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Element] -- -##### [find_eles_by_attr](https://github.com/appium/ruby_lib/blob/8cc004ad04ec087a8a11c06ca0749a5e2c6586a7/lib/appium_lib/ios/helper.rb#L225) ios +##### [find_eles_by_attr](https://github.com/appium/ruby_lib/blob/a13158fb926212d84f26120c3bc5355c8cd34baf/lib/appium_lib/ios/helper.rb#L225) ios > def find_eles_by_attr class_name, attr, value Find all elements exactly matching class and attribute value. @@ -1521,11 +1535,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Array<Element>] -- -##### [find_ele_by_attr_include](https://github.com/appium/ruby_lib/blob/8cc004ad04ec087a8a11c06ca0749a5e2c6586a7/lib/appium_lib/ios/helper.rb#L239) ios +##### [find_ele_by_attr_include](https://github.com/appium/ruby_lib/blob/a13158fb926212d84f26120c3bc5355c8cd34baf/lib/appium_lib/ios/helper.rb#L239) ios > def find_ele_by_attr_include class_name, attr, value Get the first tag by attribute that exactly matches value. @@ -1541,11 +1555,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/8cc004ad04ec087a8a11c06ca0749a5e2c6586a7/lib/appium_lib/ios/helper.rb#L248) ios +##### [find_eles_by_attr_include](https://github.com/appium/ruby_lib/blob/a13158fb926212d84f26120c3bc5355c8cd34baf/lib/appium_lib/ios/helper.rb#L248) ios > def find_eles_by_attr_include class_name, attr, value Get tags by attribute that include value. @@ -1561,11 +1575,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/8cc004ad04ec087a8a11c06ca0749a5e2c6586a7/lib/appium_lib/ios/helper.rb#L255) ios +##### [first_ele](https://github.com/appium/ruby_lib/blob/a13158fb926212d84f26120c3bc5355c8cd34baf/lib/appium_lib/ios/helper.rb#L255) ios > def first_ele class_name Get the first tag that matches class_name @@ -1577,11 +1591,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Element] -- -##### [last_ele](https://github.com/appium/ruby_lib/blob/8cc004ad04ec087a8a11c06ca0749a5e2c6586a7/lib/appium_lib/ios/helper.rb#L263) ios +##### [last_ele](https://github.com/appium/ruby_lib/blob/a13158fb926212d84f26120c3bc5355c8cd34baf/lib/appium_lib/ios/helper.rb#L263) ios > def last_ele class_name Get the last tag that matches class_name @@ -1593,11 +1607,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Element] -- -##### [tag](https://github.com/appium/ruby_lib/blob/8cc004ad04ec087a8a11c06ca0749a5e2c6586a7/lib/appium_lib/ios/helper.rb#L271) ios +##### [tag](https://github.com/appium/ruby_lib/blob/a13158fb926212d84f26120c3bc5355c8cd34baf/lib/appium_lib/ios/helper.rb#L271) ios > def tag class_name Returns the first element matching class_name @@ -1609,11 +1623,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Element] -- -##### [tags](https://github.com/appium/ruby_lib/blob/8cc004ad04ec087a8a11c06ca0749a5e2c6586a7/lib/appium_lib/ios/helper.rb#L279) ios +##### [tags](https://github.com/appium/ruby_lib/blob/a13158fb926212d84f26120c3bc5355c8cd34baf/lib/appium_lib/ios/helper.rb#L279) ios > def tags class_name Returns all elements matching class_name @@ -1625,11 +1639,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Element] -- -##### [xpath_visible_contains](https://github.com/appium/ruby_lib/blob/8cc004ad04ec087a8a11c06ca0749a5e2c6586a7/lib/appium_lib/ios/helper.rb#L311) ios +##### [xpath_visible_contains](https://github.com/appium/ruby_lib/blob/a13158fb926212d84f26120c3bc5355c8cd34baf/lib/appium_lib/ios/helper.rb#L311) ios > def xpath_visible_contains element, value Find the first element that contains value @@ -1643,11 +1657,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Element] -- -##### [xpaths_visible_contains](https://github.com/appium/ruby_lib/blob/8cc004ad04ec087a8a11c06ca0749a5e2c6586a7/lib/appium_lib/ios/helper.rb#L319) ios +##### [xpaths_visible_contains](https://github.com/appium/ruby_lib/blob/a13158fb926212d84f26120c3bc5355c8cd34baf/lib/appium_lib/ios/helper.rb#L319) ios > def xpaths_visible_contains element, value Find all elements containing value @@ -1661,11 +1675,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Array<Element>] -- -##### [xpath_visible_exact](https://github.com/appium/ruby_lib/blob/8cc004ad04ec087a8a11c06ca0749a5e2c6586a7/lib/appium_lib/ios/helper.rb#L346) ios +##### [xpath_visible_exact](https://github.com/appium/ruby_lib/blob/a13158fb926212d84f26120c3bc5355c8cd34baf/lib/appium_lib/ios/helper.rb#L346) ios > def xpath_visible_exact element, value Find the first element exactly matching value @@ -1679,11 +1693,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Element] -- -##### [xpaths_visible_exact](https://github.com/appium/ruby_lib/blob/8cc004ad04ec087a8a11c06ca0749a5e2c6586a7/lib/appium_lib/ios/helper.rb#L354) ios +##### [xpaths_visible_exact](https://github.com/appium/ruby_lib/blob/a13158fb926212d84f26120c3bc5355c8cd34baf/lib/appium_lib/ios/helper.rb#L354) ios > def xpaths_visible_exact element, value Find all elements exactly matching value @@ -1697,19 +1711,19 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Element] -- -##### [UIAStaticText](https://github.com/appium/ruby_lib/blob/8cc004ad04ec087a8a11c06ca0749a5e2c6586a7/lib/appium_lib/ios/element/text.rb#L4) ios +##### [UIAStaticText](https://github.com/appium/ruby_lib/blob/a13158fb926212d84f26120c3bc5355c8cd34baf/lib/appium_lib/ios/element/text.rb#L4) ios > UIAStaticText = 'UIAStaticText' -- -##### [text](https://github.com/appium/ruby_lib/blob/8cc004ad04ec087a8a11c06ca0749a5e2c6586a7/lib/appium_lib/ios/element/text.rb#L10) ios +##### [text](https://github.com/appium/ruby_lib/blob/a13158fb926212d84f26120c3bc5355c8cd34baf/lib/appium_lib/ios/element/text.rb#L10) ios > def text value Find the first UIAStaticText that contains value or by index. If int then the UIAStaticText at that index is returned. @@ -1722,11 +1736,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[UIAStaticText] -- -##### [texts](https://github.com/appium/ruby_lib/blob/8cc004ad04ec087a8a11c06ca0749a5e2c6586a7/lib/appium_lib/ios/element/text.rb#L19) ios +##### [texts](https://github.com/appium/ruby_lib/blob/a13158fb926212d84f26120c3bc5355c8cd34baf/lib/appium_lib/ios/element/text.rb#L19) ios > def texts value=false Find all UIAStaticText containing value. If value is omitted, all UIAStaticTexts are returned @@ -1739,11 +1753,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Array<UIAStaticText>] -- -##### [first_text](https://github.com/appium/ruby_lib/blob/8cc004ad04ec087a8a11c06ca0749a5e2c6586a7/lib/appium_lib/ios/element/text.rb#L26) ios +##### [first_text](https://github.com/appium/ruby_lib/blob/a13158fb926212d84f26120c3bc5355c8cd34baf/lib/appium_lib/ios/element/text.rb#L26) ios > def first_text Find the first UIAStaticText. @@ -1751,11 +1765,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[UIAStaticText] -- -##### [last_text](https://github.com/appium/ruby_lib/blob/8cc004ad04ec087a8a11c06ca0749a5e2c6586a7/lib/appium_lib/ios/element/text.rb#L32) ios +##### [last_text](https://github.com/appium/ruby_lib/blob/a13158fb926212d84f26120c3bc5355c8cd34baf/lib/appium_lib/ios/element/text.rb#L32) ios > def last_text Find the last UIAStaticText. @@ -1763,11 +1777,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[UIAStaticText] -- -##### [text_exact](https://github.com/appium/ruby_lib/blob/8cc004ad04ec087a8a11c06ca0749a5e2c6586a7/lib/appium_lib/ios/element/text.rb#L39) ios +##### [text_exact](https://github.com/appium/ruby_lib/blob/a13158fb926212d84f26120c3bc5355c8cd34baf/lib/appium_lib/ios/element/text.rb#L39) ios > def text_exact value Find the first UIAStaticText that exactly matches value. @@ -1779,11 +1793,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[UIAStaticText] -- -##### [texts_exact](https://github.com/appium/ruby_lib/blob/8cc004ad04ec087a8a11c06ca0749a5e2c6586a7/lib/appium_lib/ios/element/text.rb#L46) ios +##### [texts_exact](https://github.com/appium/ruby_lib/blob/a13158fb926212d84f26120c3bc5355c8cd34baf/lib/appium_lib/ios/element/text.rb#L46) ios > def texts_exact value Find all UIAStaticTexts that exactly match value. @@ -1795,11 +1809,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Array<UIAStaticText>] -- -##### [alert_accept](https://github.com/appium/ruby_lib/blob/8cc004ad04ec087a8a11c06ca0749a5e2c6586a7/lib/appium_lib/ios/element/alert.rb#L5) ios +##### [alert_accept](https://github.com/appium/ruby_lib/blob/a13158fb926212d84f26120c3bc5355c8cd34baf/lib/appium_lib/ios/element/alert.rb#L5) ios > def alert_accept Accept the alert. @@ -1807,11 +1821,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[void] -- -##### [alert_dismiss](https://github.com/appium/ruby_lib/blob/8cc004ad04ec087a8a11c06ca0749a5e2c6586a7/lib/appium_lib/ios/element/alert.rb#L13) ios +##### [alert_dismiss](https://github.com/appium/ruby_lib/blob/a13158fb926212d84f26120c3bc5355c8cd34baf/lib/appium_lib/ios/element/alert.rb#L13) ios > def alert_dismiss Dismiss the alert. @@ -1819,11 +1833,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[void] -- -##### [uiautomation_find](https://github.com/appium/ruby_lib/blob/8cc004ad04ec087a8a11c06ca0749a5e2c6586a7/lib/appium_lib/ios/mobile_methods.rb#L10) ios +##### [uiautomation_find](https://github.com/appium/ruby_lib/blob/a13158fb926212d84f26120c3bc5355c8cd34baf/lib/appium_lib/ios/mobile_methods.rb#L10) ios > def uiautomation_find find_element/s can be used with a [UIAutomation command](https://developer.apple.com/library/ios/documentation/ToolsLanguages/Reference/UIAWindowClassReference/UIAWindow/UIAWindow.html#//apple_ref/doc/uid/TP40009930). @@ -1831,19 +1845,19 @@ find_elements :uiautomation, 'elements() ``` -- -##### [UIAButton](https://github.com/appium/ruby_lib/blob/8cc004ad04ec087a8a11c06ca0749a5e2c6586a7/lib/appium_lib/ios/element/button.rb#L4) ios +##### [UIAButton](https://github.com/appium/ruby_lib/blob/a13158fb926212d84f26120c3bc5355c8cd34baf/lib/appium_lib/ios/element/button.rb#L4) ios > UIAButton = 'UIAButton' -- -##### [button](https://github.com/appium/ruby_lib/blob/8cc004ad04ec087a8a11c06ca0749a5e2c6586a7/lib/appium_lib/ios/element/button.rb#L10) ios +##### [button](https://github.com/appium/ruby_lib/blob/a13158fb926212d84f26120c3bc5355c8cd34baf/lib/appium_lib/ios/element/button.rb#L10) ios > def button value Find the first UIAButton that contains value or by index. If int then the UIAButton at that index is returned. @@ -1856,11 +1870,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[UIAButton] -- -##### [buttons](https://github.com/appium/ruby_lib/blob/8cc004ad04ec087a8a11c06ca0749a5e2c6586a7/lib/appium_lib/ios/element/button.rb#L20) ios +##### [buttons](https://github.com/appium/ruby_lib/blob/a13158fb926212d84f26120c3bc5355c8cd34baf/lib/appium_lib/ios/element/button.rb#L20) ios > def buttons value=false Find all UIAButtons containing value. If value is omitted, all UIAButtons are returned. @@ -1873,11 +1887,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Array<UIAButton>] -- -##### [first_button](https://github.com/appium/ruby_lib/blob/8cc004ad04ec087a8a11c06ca0749a5e2c6586a7/lib/appium_lib/ios/element/button.rb#L27) ios +##### [first_button](https://github.com/appium/ruby_lib/blob/a13158fb926212d84f26120c3bc5355c8cd34baf/lib/appium_lib/ios/element/button.rb#L27) ios > def first_button Find the first UIAButton. @@ -1885,11 +1899,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[UIAButton] -- -##### [last_button](https://github.com/appium/ruby_lib/blob/8cc004ad04ec087a8a11c06ca0749a5e2c6586a7/lib/appium_lib/ios/element/button.rb#L33) ios +##### [last_button](https://github.com/appium/ruby_lib/blob/a13158fb926212d84f26120c3bc5355c8cd34baf/lib/appium_lib/ios/element/button.rb#L33) ios > def last_button Find the last UIAButton. @@ -1897,11 +1911,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[UIAButton] -- -##### [button_exact](https://github.com/appium/ruby_lib/blob/8cc004ad04ec087a8a11c06ca0749a5e2c6586a7/lib/appium_lib/ios/element/button.rb#L40) ios +##### [button_exact](https://github.com/appium/ruby_lib/blob/a13158fb926212d84f26120c3bc5355c8cd34baf/lib/appium_lib/ios/element/button.rb#L40) ios > def button_exact value Find the first UIAButton that exactly matches value. @@ -1913,11 +1927,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[UIAButton] -- -##### [buttons_exact](https://github.com/appium/ruby_lib/blob/8cc004ad04ec087a8a11c06ca0749a5e2c6586a7/lib/appium_lib/ios/element/button.rb#L47) ios +##### [buttons_exact](https://github.com/appium/ruby_lib/blob/a13158fb926212d84f26120c3bc5355c8cd34baf/lib/appium_lib/ios/element/button.rb#L47) ios > def buttons_exact value Find all UIAButtons that exactly match value. @@ -1929,11 +1943,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Array<UIAButton>] -- -##### [find](https://github.com/appium/ruby_lib/blob/8cc004ad04ec087a8a11c06ca0749a5e2c6586a7/lib/appium_lib/ios/element/generic.rb#L7) ios +##### [find](https://github.com/appium/ruby_lib/blob/a13158fb926212d84f26120c3bc5355c8cd34baf/lib/appium_lib/ios/element/generic.rb#L7) ios > def find value Find the first element containing value @@ -1945,11 +1959,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Element] -- -##### [finds](https://github.com/appium/ruby_lib/blob/8cc004ad04ec087a8a11c06ca0749a5e2c6586a7/lib/appium_lib/ios/element/generic.rb#L14) ios +##### [finds](https://github.com/appium/ruby_lib/blob/a13158fb926212d84f26120c3bc5355c8cd34baf/lib/appium_lib/ios/element/generic.rb#L14) ios > def finds value Find all elements containing value @@ -1961,11 +1975,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Array<Element>] -- -##### [find_exact](https://github.com/appium/ruby_lib/blob/8cc004ad04ec087a8a11c06ca0749a5e2c6586a7/lib/appium_lib/ios/element/generic.rb#L21) ios +##### [find_exact](https://github.com/appium/ruby_lib/blob/a13158fb926212d84f26120c3bc5355c8cd34baf/lib/appium_lib/ios/element/generic.rb#L21) ios > def find_exact value Find the first element exactly matching value @@ -1977,11 +1991,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Element] -- -##### [finds_exact](https://github.com/appium/ruby_lib/blob/8cc004ad04ec087a8a11c06ca0749a5e2c6586a7/lib/appium_lib/ios/element/generic.rb#L28) ios +##### [finds_exact](https://github.com/appium/ruby_lib/blob/a13158fb926212d84f26120c3bc5355c8cd34baf/lib/appium_lib/ios/element/generic.rb#L28) ios > def finds_exact value Find all elements exactly matching value @@ -1993,27 +2007,27 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Array<Element>] -- -##### [UIATextField](https://github.com/appium/ruby_lib/blob/8cc004ad04ec087a8a11c06ca0749a5e2c6586a7/lib/appium_lib/ios/element/textfield.rb#L3) ios +##### [UIATextField](https://github.com/appium/ruby_lib/blob/a13158fb926212d84f26120c3bc5355c8cd34baf/lib/appium_lib/ios/element/textfield.rb#L3) ios > UIATextField = 'UIATextField' -- -##### [UIASecureTextField](https://github.com/appium/ruby_lib/blob/8cc004ad04ec087a8a11c06ca0749a5e2c6586a7/lib/appium_lib/ios/element/textfield.rb#L4) ios +##### [UIASecureTextField](https://github.com/appium/ruby_lib/blob/a13158fb926212d84f26120c3bc5355c8cd34baf/lib/appium_lib/ios/element/textfield.rb#L4) ios > UIASecureTextField = 'UIASecureTextField' -- -##### [textfield](https://github.com/appium/ruby_lib/blob/8cc004ad04ec087a8a11c06ca0749a5e2c6586a7/lib/appium_lib/ios/element/textfield.rb#L38) ios +##### [textfield](https://github.com/appium/ruby_lib/blob/a13158fb926212d84f26120c3bc5355c8cd34baf/lib/appium_lib/ios/element/textfield.rb#L38) ios > def textfield value Find the first TextField that contains value or by index. If int then the TextField at that index is returned. @@ -2026,11 +2040,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[TextField] -- -##### [textfields](https://github.com/appium/ruby_lib/blob/8cc004ad04ec087a8a11c06ca0749a5e2c6586a7/lib/appium_lib/ios/element/textfield.rb#L55) ios +##### [textfields](https://github.com/appium/ruby_lib/blob/a13158fb926212d84f26120c3bc5355c8cd34baf/lib/appium_lib/ios/element/textfield.rb#L55) ios > def textfields value=false Find all TextFields containing value. If value is omitted, all TextFields are returned. @@ -2043,11 +2057,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Array<TextField>] -- -##### [first_textfield](https://github.com/appium/ruby_lib/blob/8cc004ad04ec087a8a11c06ca0749a5e2c6586a7/lib/appium_lib/ios/element/textfield.rb#L62) ios +##### [first_textfield](https://github.com/appium/ruby_lib/blob/a13158fb926212d84f26120c3bc5355c8cd34baf/lib/appium_lib/ios/element/textfield.rb#L62) ios > def first_textfield Find the first TextField. @@ -2055,11 +2069,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[TextField] -- -##### [last_textfield](https://github.com/appium/ruby_lib/blob/8cc004ad04ec087a8a11c06ca0749a5e2c6586a7/lib/appium_lib/ios/element/textfield.rb#L68) ios +##### [last_textfield](https://github.com/appium/ruby_lib/blob/a13158fb926212d84f26120c3bc5355c8cd34baf/lib/appium_lib/ios/element/textfield.rb#L68) ios > def last_textfield Find the last TextField. @@ -2067,11 +2081,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[TextField] -- -##### [textfield_exact](https://github.com/appium/ruby_lib/blob/8cc004ad04ec087a8a11c06ca0749a5e2c6586a7/lib/appium_lib/ios/element/textfield.rb#L75) ios +##### [textfield_exact](https://github.com/appium/ruby_lib/blob/a13158fb926212d84f26120c3bc5355c8cd34baf/lib/appium_lib/ios/element/textfield.rb#L75) ios > def textfield_exact value Find the first TextField that exactly matches value. @@ -2083,11 +2097,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[TextField] -- -##### [textfields_exact](https://github.com/appium/ruby_lib/blob/8cc004ad04ec087a8a11c06ca0749a5e2c6586a7/lib/appium_lib/ios/element/textfield.rb#L82) ios +##### [textfields_exact](https://github.com/appium/ruby_lib/blob/a13158fb926212d84f26120c3bc5355c8cd34baf/lib/appium_lib/ios/element/textfield.rb#L82) ios > def textfields_exact value Find all TextFields that exactly match value. @@ -2099,30 +2113,30 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Array<TextField>] -- -##### [value](https://github.com/appium/ruby_lib/blob/8cc004ad04ec087a8a11c06ca0749a5e2c6586a7/lib/appium_lib/common/patch.rb#L10) +##### [value](https://github.com/appium/ruby_lib/blob/a13158fb926212d84f26120c3bc5355c8cd34baf/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/8cc004ad04ec087a8a11c06ca0749a5e2c6586a7/lib/appium_lib/common/patch.rb#L17) +##### [name](https://github.com/appium/ruby_lib/blob/a13158fb926212d84f26120c3bc5355c8cd34baf/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/8cc004ad04ec087a8a11c06ca0749a5e2c6586a7/lib/appium_lib/common/patch.rb#L29) +##### [location_rel](https://github.com/appium/ruby_lib/blob/a13158fb926212d84f26120c3bc5355c8cd34baf/lib/appium_lib/common/patch.rb#L29) > def location_rel For use with mobile tap.