docs/ios_docs.md in appium_lib-5.0.1 vs docs/ios_docs.md in appium_lib-6.0.0

- old
+ new

@@ -1,6 +1,6 @@ -##### [load_appium_txt](https://github.com/appium/ruby_lib/blob/9b157011965442e6f021dcfeef588450277f1c6a/lib/appium_lib/driver.rb#L69) +##### [load_appium_txt](https://github.com/appium/ruby_lib/blob/ea11190b9ab36e34226d988f85fe612af6f769de/lib/appium_lib/driver.rb#L69) > def self.load_appium_txt opts={} Load appium.txt (toml format) the basedir of this file + appium.txt is what's used @@ -25,32 +25,32 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[hash] the symbolized hash with updated :app and :require keys -- -##### [symbolize_keys](https://github.com/appium/ruby_lib/blob/9b157011965442e6f021dcfeef588450277f1c6a/lib/appium_lib/driver.rb#L139) +##### [symbolize_keys](https://github.com/appium/ruby_lib/blob/ea11190b9ab36e34226d988f85fe612af6f769de/lib/appium_lib/driver.rb#L139) > 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/9b157011965442e6f021dcfeef588450277f1c6a/lib/appium_lib/driver.rb#L152) +##### [promote_singleton_appium_methods](https://github.com/appium/ruby_lib/blob/ea11190b9ab36e34226d988f85fe612af6f769de/lib/appium_lib/driver.rb#L152) > 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/9b157011965442e6f021dcfeef588450277f1c6a/lib/appium_lib/driver.rb#L192) +##### [promote_appium_methods](https://github.com/appium/ruby_lib/blob/ea11190b9ab36e34226d988f85fe612af6f769de/lib/appium_lib/driver.rb#L192) > def self.promote_appium_methods class_array Promote appium methods to class instance methods @@ -64,75 +64,75 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Array<Class>] class_array - An array of classes -- -##### [global_webdriver_http_sleep](https://github.com/appium/ruby_lib/blob/9b157011965442e6f021dcfeef588450277f1c6a/lib/appium_lib/driver.rb#L228) +##### [global_webdriver_http_sleep](https://github.com/appium/ruby_lib/blob/ea11190b9ab36e34226d988f85fe612af6f769de/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/9b157011965442e6f021dcfeef588450277f1c6a/lib/appium_lib/driver.rb#L228) +##### [global_webdriver_http_sleep=](https://github.com/appium/ruby_lib/blob/ea11190b9ab36e34226d988f85fe612af6f769de/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/9b157011965442e6f021dcfeef588450277f1c6a/lib/appium_lib/driver.rb#L230) +##### [caps](https://github.com/appium/ruby_lib/blob/ea11190b9ab36e34226d988f85fe612af6f769de/lib/appium_lib/driver.rb#L230) > def caps Selenium webdriver capabilities -- -##### [caps=](https://github.com/appium/ruby_lib/blob/9b157011965442e6f021dcfeef588450277f1c6a/lib/appium_lib/driver.rb#L230) +##### [caps=](https://github.com/appium/ruby_lib/blob/ea11190b9ab36e34226d988f85fe612af6f769de/lib/appium_lib/driver.rb#L230) > def caps=(value) Selenium webdriver capabilities -- -##### [custom_url](https://github.com/appium/ruby_lib/blob/9b157011965442e6f021dcfeef588450277f1c6a/lib/appium_lib/driver.rb#L232) +##### [custom_url](https://github.com/appium/ruby_lib/blob/ea11190b9ab36e34226d988f85fe612af6f769de/lib/appium_lib/driver.rb#L232) > def custom_url Custom URL for the selenium server -- -##### [custom_url=](https://github.com/appium/ruby_lib/blob/9b157011965442e6f021dcfeef588450277f1c6a/lib/appium_lib/driver.rb#L232) +##### [custom_url=](https://github.com/appium/ruby_lib/blob/ea11190b9ab36e34226d988f85fe612af6f769de/lib/appium_lib/driver.rb#L232) > def custom_url=(value) Custom URL for the selenium server -- -##### [export_session](https://github.com/appium/ruby_lib/blob/9b157011965442e6f021dcfeef588450277f1c6a/lib/appium_lib/driver.rb#L234) +##### [export_session](https://github.com/appium/ruby_lib/blob/ea11190b9ab36e34226d988f85fe612af6f769de/lib/appium_lib/driver.rb#L234) > def export_session Export session id to textfile in /tmp for 3rd party tools -- -##### [export_session=](https://github.com/appium/ruby_lib/blob/9b157011965442e6f021dcfeef588450277f1c6a/lib/appium_lib/driver.rb#L234) +##### [export_session=](https://github.com/appium/ruby_lib/blob/ea11190b9ab36e34226d988f85fe612af6f769de/lib/appium_lib/driver.rb#L234) > def export_session=(value) Export session id to textfile in /tmp for 3rd party tools -- -##### [default_wait](https://github.com/appium/ruby_lib/blob/9b157011965442e6f021dcfeef588450277f1c6a/lib/appium_lib/driver.rb#L236) +##### [default_wait](https://github.com/appium/ruby_lib/blob/ea11190b9ab36e34226d988f85fe612af6f769de/lib/appium_lib/driver.rb#L236) > def default_wait Returns the default client side wait. This value is independent of what the server is using @@ -141,115 +141,115 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Integer] -- -##### [default_wait=](https://github.com/appium/ruby_lib/blob/9b157011965442e6f021dcfeef588450277f1c6a/lib/appium_lib/driver.rb#L236) +##### [default_wait=](https://github.com/appium/ruby_lib/blob/ea11190b9ab36e34226d988f85fe612af6f769de/lib/appium_lib/driver.rb#L236) > def default_wait=(value) Default wait time for elements to appear -- -##### [last_waits](https://github.com/appium/ruby_lib/blob/9b157011965442e6f021dcfeef588450277f1c6a/lib/appium_lib/driver.rb#L238) +##### [last_waits](https://github.com/appium/ruby_lib/blob/ea11190b9ab36e34226d988f85fe612af6f769de/lib/appium_lib/driver.rb#L238) > def last_waits Array of previous wait time values -- -##### [last_waits=](https://github.com/appium/ruby_lib/blob/9b157011965442e6f021dcfeef588450277f1c6a/lib/appium_lib/driver.rb#L238) +##### [last_waits=](https://github.com/appium/ruby_lib/blob/ea11190b9ab36e34226d988f85fe612af6f769de/lib/appium_lib/driver.rb#L238) > def last_waits=(value) Array of previous wait time values -- -##### [sauce_username](https://github.com/appium/ruby_lib/blob/9b157011965442e6f021dcfeef588450277f1c6a/lib/appium_lib/driver.rb#L240) +##### [sauce_username](https://github.com/appium/ruby_lib/blob/ea11190b9ab36e34226d988f85fe612af6f769de/lib/appium_lib/driver.rb#L240) > def sauce_username Username for use on Sauce Labs -- -##### [sauce_username=](https://github.com/appium/ruby_lib/blob/9b157011965442e6f021dcfeef588450277f1c6a/lib/appium_lib/driver.rb#L240) +##### [sauce_username=](https://github.com/appium/ruby_lib/blob/ea11190b9ab36e34226d988f85fe612af6f769de/lib/appium_lib/driver.rb#L240) > def sauce_username=(value) Username for use on Sauce Labs -- -##### [sauce_access_key](https://github.com/appium/ruby_lib/blob/9b157011965442e6f021dcfeef588450277f1c6a/lib/appium_lib/driver.rb#L242) +##### [sauce_access_key](https://github.com/appium/ruby_lib/blob/ea11190b9ab36e34226d988f85fe612af6f769de/lib/appium_lib/driver.rb#L242) > def sauce_access_key Access Key for use on Sauce Labs -- -##### [sauce_access_key=](https://github.com/appium/ruby_lib/blob/9b157011965442e6f021dcfeef588450277f1c6a/lib/appium_lib/driver.rb#L242) +##### [sauce_access_key=](https://github.com/appium/ruby_lib/blob/ea11190b9ab36e34226d988f85fe612af6f769de/lib/appium_lib/driver.rb#L242) > def sauce_access_key=(value) Access Key for use on Sauce Labs -- -##### [appium_port](https://github.com/appium/ruby_lib/blob/9b157011965442e6f021dcfeef588450277f1c6a/lib/appium_lib/driver.rb#L244) +##### [appium_port](https://github.com/appium/ruby_lib/blob/ea11190b9ab36e34226d988f85fe612af6f769de/lib/appium_lib/driver.rb#L244) > def appium_port Appium's server port -- -##### [appium_port=](https://github.com/appium/ruby_lib/blob/9b157011965442e6f021dcfeef588450277f1c6a/lib/appium_lib/driver.rb#L244) +##### [appium_port=](https://github.com/appium/ruby_lib/blob/ea11190b9ab36e34226d988f85fe612af6f769de/lib/appium_lib/driver.rb#L244) > def appium_port=(value) Appium's server port -- -##### [appium_device](https://github.com/appium/ruby_lib/blob/9b157011965442e6f021dcfeef588450277f1c6a/lib/appium_lib/driver.rb#L246) +##### [appium_device](https://github.com/appium/ruby_lib/blob/ea11190b9ab36e34226d988f85fe612af6f769de/lib/appium_lib/driver.rb#L246) > def appium_device Device type to request from the appium server -- -##### [appium_device=](https://github.com/appium/ruby_lib/blob/9b157011965442e6f021dcfeef588450277f1c6a/lib/appium_lib/driver.rb#L246) +##### [appium_device=](https://github.com/appium/ruby_lib/blob/ea11190b9ab36e34226d988f85fe612af6f769de/lib/appium_lib/driver.rb#L246) > def appium_device=(value) Device type to request from the appium server -- -##### [appium_debug](https://github.com/appium/ruby_lib/blob/9b157011965442e6f021dcfeef588450277f1c6a/lib/appium_lib/driver.rb#L248) +##### [appium_debug](https://github.com/appium/ruby_lib/blob/ea11190b9ab36e34226d988f85fe612af6f769de/lib/appium_lib/driver.rb#L248) > def appium_debug Boolean debug mode for the Appium Ruby bindings -- -##### [appium_debug=](https://github.com/appium/ruby_lib/blob/9b157011965442e6f021dcfeef588450277f1c6a/lib/appium_lib/driver.rb#L248) +##### [appium_debug=](https://github.com/appium/ruby_lib/blob/ea11190b9ab36e34226d988f85fe612af6f769de/lib/appium_lib/driver.rb#L248) > def appium_debug=(value) Boolean debug mode for the Appium Ruby bindings -- -##### [initialize](https://github.com/appium/ruby_lib/blob/9b157011965442e6f021dcfeef588450277f1c6a/lib/appium_lib/driver.rb#L269) +##### [initialize](https://github.com/appium/ruby_lib/blob/ea11190b9ab36e34226d988f85fe612af6f769de/lib/appium_lib/driver.rb#L269) > def initialize opts={} Creates a new driver @@ -276,19 +276,19 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Driver] -- -##### [driver_attributes](https://github.com/appium/ruby_lib/blob/9b157011965442e6f021dcfeef588450277f1c6a/lib/appium_lib/driver.rb#L344) +##### [driver_attributes](https://github.com/appium/ruby_lib/blob/ea11190b9ab36e34226d988f85fe612af6f769de/lib/appium_lib/driver.rb#L344) > def driver_attributes Returns a hash of the driver attributes -- -##### [device_is_android?](https://github.com/appium/ruby_lib/blob/9b157011965442e6f021dcfeef588450277f1c6a/lib/appium_lib/driver.rb#L364) +##### [device_is_android?](https://github.com/appium/ruby_lib/blob/ea11190b9ab36e34226d988f85fe612af6f769de/lib/appium_lib/driver.rb#L364) > def device_is_android? @@ -296,11 +296,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Boolean] -- -##### [appium_server_version](https://github.com/appium/ruby_lib/blob/9b157011965442e6f021dcfeef588450277f1c6a/lib/appium_lib/driver.rb#L380) +##### [appium_server_version](https://github.com/appium/ruby_lib/blob/ea11190b9ab36e34226d988f85fe612af6f769de/lib/appium_lib/driver.rb#L380) > def appium_server_version Returns the server's version info @@ -317,11 +317,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Hash] -- -##### [absolute_app_path](https://github.com/appium/ruby_lib/blob/9b157011965442e6f021dcfeef588450277f1c6a/lib/appium_lib/driver.rb#L392) +##### [absolute_app_path](https://github.com/appium/ruby_lib/blob/ea11190b9ab36e34226d988f85fe612af6f769de/lib/appium_lib/driver.rb#L392) > def self.absolute_app_path opts Converts app_path to an absolute path. @@ -334,11 +334,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[String] APP_PATH as an absolute path -- -##### [server_url](https://github.com/appium/ruby_lib/blob/9b157011965442e6f021dcfeef588450277f1c6a/lib/appium_lib/driver.rb#L425) +##### [server_url](https://github.com/appium/ruby_lib/blob/ea11190b9ab36e34226d988f85fe612af6f769de/lib/appium_lib/driver.rb#L425) > def server_url Get the server url @@ -346,11 +346,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[String] the server url -- -##### [restart](https://github.com/appium/ruby_lib/blob/9b157011965442e6f021dcfeef588450277f1c6a/lib/appium_lib/driver.rb#L436) +##### [restart](https://github.com/appium/ruby_lib/blob/ea11190b9ab36e34226d988f85fe612af6f769de/lib/appium_lib/driver.rb#L436) > def restart Restarts the driver @@ -358,11 +358,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Driver] the driver -- -##### [driver](https://github.com/appium/ruby_lib/blob/9b157011965442e6f021dcfeef588450277f1c6a/lib/appium_lib/driver.rb#L443) +##### [driver](https://github.com/appium/ruby_lib/blob/ea11190b9ab36e34226d988f85fe612af6f769de/lib/appium_lib/driver.rb#L443) > def driver Returns the driver @@ -370,11 +370,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Driver] the driver -- -##### [screenshot](https://github.com/appium/ruby_lib/blob/9b157011965442e6f021dcfeef588450277f1c6a/lib/appium_lib/driver.rb#L453) +##### [screenshot](https://github.com/appium/ruby_lib/blob/ea11190b9ab36e34226d988f85fe612af6f769de/lib/appium_lib/driver.rb#L453) > def screenshot png_save_path Takes a png screenshot and saves to the target path. @@ -388,11 +388,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[nil] -- -##### [driver_quit](https://github.com/appium/ruby_lib/blob/9b157011965442e6f021dcfeef588450277f1c6a/lib/appium_lib/driver.rb#L460) +##### [driver_quit](https://github.com/appium/ruby_lib/blob/ea11190b9ab36e34226d988f85fe612af6f769de/lib/appium_lib/driver.rb#L460) > def driver_quit Quits the driver @@ -400,11 +400,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[void] -- -##### [start_driver](https://github.com/appium/ruby_lib/blob/9b157011965442e6f021dcfeef588450277f1c6a/lib/appium_lib/driver.rb#L468) +##### [start_driver](https://github.com/appium/ruby_lib/blob/ea11190b9ab36e34226d988f85fe612af6f769de/lib/appium_lib/driver.rb#L468) > def start_driver Creates a new global driver and quits the old one if it exists. @@ -412,19 +412,19 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Selenium::WebDriver] the new global driver -- -##### [no_wait](https://github.com/appium/ruby_lib/blob/9b157011965442e6f021dcfeef588450277f1c6a/lib/appium_lib/driver.rb#L494) +##### [no_wait](https://github.com/appium/ruby_lib/blob/ea11190b9ab36e34226d988f85fe612af6f769de/lib/appium_lib/driver.rb#L494) > def no_wait Set implicit wait and default_wait to zero. -- -##### [set_wait](https://github.com/appium/ruby_lib/blob/9b157011965442e6f021dcfeef588450277f1c6a/lib/appium_lib/driver.rb#L513) +##### [set_wait](https://github.com/appium/ruby_lib/blob/ea11190b9ab36e34226d988f85fe612af6f769de/lib/appium_lib/driver.rb#L513) > def set_wait timeout=nil Set implicit wait and default_wait to timeout, defaults to 30. if set_wait is called without a param then the second to last @@ -445,11 +445,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[void] -- -##### [exists](https://github.com/appium/ruby_lib/blob/9b157011965442e6f021dcfeef588450277f1c6a/lib/appium_lib/driver.rb#L547) +##### [exists](https://github.com/appium/ruby_lib/blob/ea11190b9ab36e34226d988f85fe612af6f769de/lib/appium_lib/driver.rb#L547) > def exists pre_check=0, post_check=@default_wait, &search_block Returns existence of element. @@ -471,11 +471,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Boolean] -- -##### [execute_script](https://github.com/appium/ruby_lib/blob/9b157011965442e6f021dcfeef588450277f1c6a/lib/appium_lib/driver.rb#L571) +##### [execute_script](https://github.com/appium/ruby_lib/blob/ea11190b9ab36e34226d988f85fe612af6f769de/lib/appium_lib/driver.rb#L571) > def execute_script script, *args The same as @driver.execute_script @@ -489,11 +489,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Object] -- -##### [find_elements](https://github.com/appium/ruby_lib/blob/9b157011965442e6f021dcfeef588450277f1c6a/lib/appium_lib/driver.rb#L579) +##### [find_elements](https://github.com/appium/ruby_lib/blob/ea11190b9ab36e34226d988f85fe612af6f769de/lib/appium_lib/driver.rb#L579) > def find_elements *args Calls @driver.find_elements @@ -505,11 +505,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Array<Element>] Array is empty when no elements are found. -- -##### [find_element](https://github.com/appium/ruby_lib/blob/9b157011965442e6f021dcfeef588450277f1c6a/lib/appium_lib/driver.rb#L587) +##### [find_element](https://github.com/appium/ruby_lib/blob/ea11190b9ab36e34226d988f85fe612af6f769de/lib/appium_lib/driver.rb#L587) > def find_element *args Calls @driver.find_elements @@ -521,11 +521,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Element] -- -##### [x](https://github.com/appium/ruby_lib/blob/9b157011965442e6f021dcfeef588450277f1c6a/lib/appium_lib/driver.rb#L594) +##### [x](https://github.com/appium/ruby_lib/blob/ea11190b9ab36e34226d988f85fe612af6f769de/lib/appium_lib/driver.rb#L594) > def x Quit the driver and Pry. quit and exit are reserved by Pry. @@ -534,79 +534,87 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[void] -- -##### [NoArgMethods](https://github.com/appium/ruby_lib/blob/9b157011965442e6f021dcfeef588450277f1c6a/lib/appium_lib/device/device.rb#L7) +##### [logger](https://github.com/appium/ruby_lib/blob/ea11190b9ab36e34226d988f85fe612af6f769de/lib/appium_lib/logger.rb#L15) +> def logger + + + +-- + +##### [NoArgMethods](https://github.com/appium/ruby_lib/blob/ea11190b9ab36e34226d988f85fe612af6f769de/lib/appium_lib/device/device.rb#L7) + > NoArgMethods = { -- -##### [app_strings](https://github.com/appium/ruby_lib/blob/9b157011965442e6f021dcfeef588450277f1c6a/lib/appium_lib/device/device.rb#L23) +##### [app_strings](https://github.com/appium/ruby_lib/blob/ea11190b9ab36e34226d988f85fe612af6f769de/lib/appium_lib/device/device.rb#L23) > def app_strings Return the hash of all localization strings. ```ruby app_strings #=> "TransitionsTitle"=>"Transitions", "WebTitle"=>"Web" ``` -- -##### [background_app](https://github.com/appium/ruby_lib/blob/9b157011965442e6f021dcfeef588450277f1c6a/lib/appium_lib/device/device.rb#L29) +##### [background_app](https://github.com/appium/ruby_lib/blob/ea11190b9ab36e34226d988f85fe612af6f769de/lib/appium_lib/device/device.rb#L29) > def background_app Backgrounds the app for a set number of seconds. This is a blocking application -- -##### [current_activity](https://github.com/appium/ruby_lib/blob/9b157011965442e6f021dcfeef588450277f1c6a/lib/appium_lib/device/device.rb#L34) +##### [current_activity](https://github.com/appium/ruby_lib/blob/ea11190b9ab36e34226d988f85fe612af6f769de/lib/appium_lib/device/device.rb#L34) > def current_activity -- -##### [launch_app](https://github.com/appium/ruby_lib/blob/9b157011965442e6f021dcfeef588450277f1c6a/lib/appium_lib/device/device.rb#L36) +##### [launch_app](https://github.com/appium/ruby_lib/blob/ea11190b9ab36e34226d988f85fe612af6f769de/lib/appium_lib/device/device.rb#L36) > def launch_app Start the simulator and applicaton configured with desired capabilities -- -##### [reset](https://github.com/appium/ruby_lib/blob/9b157011965442e6f021dcfeef588450277f1c6a/lib/appium_lib/device/device.rb#L39) +##### [reset](https://github.com/appium/ruby_lib/blob/ea11190b9ab36e34226d988f85fe612af6f769de/lib/appium_lib/device/device.rb#L39) > def reset Reset the device, relaunching the application. -- -##### [shake](https://github.com/appium/ruby_lib/blob/9b157011965442e6f021dcfeef588450277f1c6a/lib/appium_lib/device/device.rb#L42) +##### [shake](https://github.com/appium/ruby_lib/blob/ea11190b9ab36e34226d988f85fe612af6f769de/lib/appium_lib/device/device.rb#L42) > def shake Cause the device to shake -- -##### [toggle_flight_mode](https://github.com/appium/ruby_lib/blob/9b157011965442e6f021dcfeef588450277f1c6a/lib/appium_lib/device/device.rb#L45) +##### [toggle_flight_mode](https://github.com/appium/ruby_lib/blob/ea11190b9ab36e34226d988f85fe612af6f769de/lib/appium_lib/device/device.rb#L45) > def toggle_flight_mode toggle flight mode on or off -- -##### [hide_keyboard](https://github.com/appium/ruby_lib/blob/9b157011965442e6f021dcfeef588450277f1c6a/lib/appium_lib/device/device.rb#L48) +##### [hide_keyboard](https://github.com/appium/ruby_lib/blob/ea11190b9ab36e34226d988f85fe612af6f769de/lib/appium_lib/device/device.rb#L48) > def hide_keyboard Hide the onscreen keyboard @@ -615,11 +623,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/9b157011965442e6f021dcfeef588450277f1c6a/lib/appium_lib/device/device.rb#L57) +##### [press_keycode](https://github.com/appium/ruby_lib/blob/ea11190b9ab36e34226d988f85fe612af6f769de/lib/appium_lib/device/device.rb#L57) > def press_keycode Press keycode on the device. http://developer.android.com/reference/android/view/KeyEvent.html @@ -630,11 +638,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/9b157011965442e6f021dcfeef588450277f1c6a/lib/appium_lib/device/device.rb#L63) +##### [long_press_keycode](https://github.com/appium/ruby_lib/blob/ea11190b9ab36e34226d988f85fe612af6f769de/lib/appium_lib/device/device.rb#L63) > def long_press_keycode Long press keycode on the device. http://developer.android.com/reference/android/view/KeyEvent.html @@ -645,11 +653,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/9b157011965442e6f021dcfeef588450277f1c6a/lib/appium_lib/device/device.rb#L69) +##### [push_file](https://github.com/appium/ruby_lib/blob/ea11190b9ab36e34226d988f85fe612af6f769de/lib/appium_lib/device/device.rb#L69) > def push_file Place a file in a specific location on the device. @@ -659,11 +667,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/9b157011965442e6f021dcfeef588450277f1c6a/lib/appium_lib/device/device.rb#L74) +##### [pull_file](https://github.com/appium/ruby_lib/blob/ea11190b9ab36e34226d988f85fe612af6f769de/lib/appium_lib/device/device.rb#L74) > def pull_file Retrieve a file from the device. This can retrieve an absolute path or a path relative to the installed app (iOS only). @@ -676,11 +684,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/9b157011965442e6f021dcfeef588450277f1c6a/lib/appium_lib/device/device.rb#L84) +##### [pull_folder](https://github.com/appium/ruby_lib/blob/ea11190b9ab36e34226d988f85fe612af6f769de/lib/appium_lib/device/device.rb#L84) > def pull_folder Retrieve a folder from the device. ```ruby @@ -691,11 +699,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[String] path - absolute path to the folder -- -##### [end_coverage](https://github.com/appium/ruby_lib/blob/9b157011965442e6f021dcfeef588450277f1c6a/lib/appium_lib/device/device.rb#L92) +##### [end_coverage](https://github.com/appium/ruby_lib/blob/ea11190b9ab36e34226d988f85fe612af6f769de/lib/appium_lib/device/device.rb#L92) > def end_coverage Android only; Ends the test coverage and writes the results to the given path on device. @@ -705,27 +713,27 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[String] intent - Intent to broadcast when ending coverage. -- -##### [get_settings](https://github.com/appium/ruby_lib/blob/9b157011965442e6f021dcfeef588450277f1c6a/lib/appium_lib/device/device.rb#L97) +##### [get_settings](https://github.com/appium/ruby_lib/blob/ea11190b9ab36e34226d988f85fe612af6f769de/lib/appium_lib/device/device.rb#L97) > def get_settings Get appium Settings for current test session -- -##### [extend_search_contexts](https://github.com/appium/ruby_lib/blob/9b157011965442e6f021dcfeef588450277f1c6a/lib/appium_lib/device/device.rb#L345) +##### [extend_search_contexts](https://github.com/appium/ruby_lib/blob/ea11190b9ab36e34226d988f85fe612af6f769de/lib/appium_lib/device/device.rb#L345) > def extend_search_contexts -- -##### [accessiblity_id_find](https://github.com/appium/ruby_lib/blob/9b157011965442e6f021dcfeef588450277f1c6a/lib/appium_lib/device/device.rb#L345) +##### [accessiblity_id_find](https://github.com/appium/ruby_lib/blob/ea11190b9ab36e34226d988f85fe612af6f769de/lib/appium_lib/device/device.rb#L345) > def accessiblity_id_find find_element/s with their accessibility_id @@ -733,19 +741,19 @@ find_elements :accessibility_id, 'Animation' ``` -- -##### [add_touch_actions](https://github.com/appium/ruby_lib/blob/9b157011965442e6f021dcfeef588450277f1c6a/lib/appium_lib/device/device.rb#L351) +##### [add_touch_actions](https://github.com/appium/ruby_lib/blob/ea11190b9ab36e34226d988f85fe612af6f769de/lib/appium_lib/device/device.rb#L351) > def add_touch_actions -- -##### [set_context](https://github.com/appium/ruby_lib/blob/9b157011965442e6f021dcfeef588450277f1c6a/lib/appium_lib/device/device.rb#L375) +##### [set_context](https://github.com/appium/ruby_lib/blob/ea11190b9ab36e34226d988f85fe612af6f769de/lib/appium_lib/device/device.rb#L375) > def set_context Change the context to the given context. ```ruby @@ -756,11 +764,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[String] The - context to change to -- -##### [current_context](https://github.com/appium/ruby_lib/blob/9b157011965442e6f021dcfeef588450277f1c6a/lib/appium_lib/device/device.rb#L383) +##### [current_context](https://github.com/appium/ruby_lib/blob/ea11190b9ab36e34226d988f85fe612af6f769de/lib/appium_lib/device/device.rb#L383) > def current_context @@ -768,11 +776,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[String] The context currently being used. -- -##### [available_contexts](https://github.com/appium/ruby_lib/blob/9b157011965442e6f021dcfeef588450277f1c6a/lib/appium_lib/device/device.rb#L386) +##### [available_contexts](https://github.com/appium/ruby_lib/blob/ea11190b9ab36e34226d988f85fe612af6f769de/lib/appium_lib/device/device.rb#L386) > def available_contexts @@ -780,11 +788,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/9b157011965442e6f021dcfeef588450277f1c6a/lib/appium_lib/device/device.rb#L396) +##### [within_context](https://github.com/appium/ruby_lib/blob/ea11190b9ab36e34226d988f85fe612af6f769de/lib/appium_lib/device/device.rb#L396) > def within_context(context) Perform a block within the given context, then switch back to the starting context. ```ruby @@ -796,19 +804,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/9b157011965442e6f021dcfeef588450277f1c6a/lib/appium_lib/device/device.rb#L404) +##### [switch_to_default_context](https://github.com/appium/ruby_lib/blob/ea11190b9ab36e34226d988f85fe612af6f769de/lib/appium_lib/device/device.rb#L404) > def switch_to_default_context Change to the default context. This is equivalent to `set_context nil`. -- -##### [pinch](https://github.com/appium/ruby_lib/blob/9b157011965442e6f021dcfeef588450277f1c6a/lib/appium_lib/device/multi_touch.rb#L30) +##### [pinch](https://github.com/appium/ruby_lib/blob/ea11190b9ab36e34226d988f85fe612af6f769de/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. @@ -823,11 +831,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/9b157011965442e6f021dcfeef588450277f1c6a/lib/appium_lib/device/multi_touch.rb#L58) +##### [zoom](https://github.com/appium/ruby_lib/blob/ea11190b9ab36e34226d988f85fe612af6f769de/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. @@ -842,11 +850,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/9b157011965442e6f021dcfeef588450277f1c6a/lib/appium_lib/device/multi_touch.rb#L79) +##### [initialize](https://github.com/appium/ruby_lib/blob/ea11190b9ab36e34226d988f85fe612af6f769de/lib/appium_lib/device/multi_touch.rb#L79) > def initialize Create a new multi-action @@ -854,11 +862,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[MultiTouch] a new instance of MultiTouch -- -##### [add](https://github.com/appium/ruby_lib/blob/9b157011965442e6f021dcfeef588450277f1c6a/lib/appium_lib/device/multi_touch.rb#L85) +##### [add](https://github.com/appium/ruby_lib/blob/ea11190b9ab36e34226d988f85fe612af6f769de/lib/appium_lib/device/multi_touch.rb#L85) > def add(chain) Add a touch_action to be performed @@ -866,43 +874,43 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[TouchAction] chain - The action to add to the chain -- -##### [perform](https://github.com/appium/ruby_lib/blob/9b157011965442e6f021dcfeef588450277f1c6a/lib/appium_lib/device/multi_touch.rb#L90) +##### [perform](https://github.com/appium/ruby_lib/blob/ea11190b9ab36e34226d988f85fe612af6f769de/lib/appium_lib/device/multi_touch.rb#L90) > def perform Ask Appium to perform the actions -- -##### [ACTIONS](https://github.com/appium/ruby_lib/blob/9b157011965442e6f021dcfeef588450277f1c6a/lib/appium_lib/device/touch_actions.rb#L12) +##### [ACTIONS](https://github.com/appium/ruby_lib/blob/ea11190b9ab36e34226d988f85fe612af6f769de/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/9b157011965442e6f021dcfeef588450277f1c6a/lib/appium_lib/device/touch_actions.rb#L13) +##### [COMPLEX_ACTIONS](https://github.com/appium/ruby_lib/blob/ea11190b9ab36e34226d988f85fe612af6f769de/lib/appium_lib/device/touch_actions.rb#L13) > COMPLEX_ACTIONS = [:swipe] -- -##### [actions](https://github.com/appium/ruby_lib/blob/9b157011965442e6f021dcfeef588450277f1c6a/lib/appium_lib/device/touch_actions.rb#L27) +##### [actions](https://github.com/appium/ruby_lib/blob/ea11190b9ab36e34226d988f85fe612af6f769de/lib/appium_lib/device/touch_actions.rb#L27) > def actions Returns the value of attribute actions -- -##### [initialize](https://github.com/appium/ruby_lib/blob/9b157011965442e6f021dcfeef588450277f1c6a/lib/appium_lib/device/touch_actions.rb#L29) +##### [initialize](https://github.com/appium/ruby_lib/blob/ea11190b9ab36e34226d988f85fe612af6f769de/lib/appium_lib/device/touch_actions.rb#L29) > def initialize @@ -910,11 +918,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[TouchAction] a new instance of TouchAction -- -##### [move_to](https://github.com/appium/ruby_lib/blob/9b157011965442e6f021dcfeef588450277f1c6a/lib/appium_lib/device/touch_actions.rb#L37) +##### [move_to](https://github.com/appium/ruby_lib/blob/ea11190b9ab36e34226d988f85fe612af6f769de/lib/appium_lib/device/touch_actions.rb#L37) > def move_to(opts) Move to the given co-ordinates. @@ -922,11 +930,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Hash] opts - a customizable set of options -- -##### [long_press](https://github.com/appium/ruby_lib/blob/9b157011965442e6f021dcfeef588450277f1c6a/lib/appium_lib/device/touch_actions.rb#L47) +##### [long_press](https://github.com/appium/ruby_lib/blob/ea11190b9ab36e34226d988f85fe612af6f769de/lib/appium_lib/device/touch_actions.rb#L47) > def long_press(opts) Press down for a specific duration. @@ -940,11 +948,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Hash] duration - a customizable set of options -- -##### [press](https://github.com/appium/ruby_lib/blob/9b157011965442e6f021dcfeef588450277f1c6a/lib/appium_lib/device/touch_actions.rb#L59) +##### [press](https://github.com/appium/ruby_lib/blob/ea11190b9ab36e34226d988f85fe612af6f769de/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`. @@ -953,11 +961,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Hash] opts - a customizable set of options -- -##### [release](https://github.com/appium/ruby_lib/blob/9b157011965442e6f021dcfeef588450277f1c6a/lib/appium_lib/device/touch_actions.rb#L70) +##### [release](https://github.com/appium/ruby_lib/blob/ea11190b9ab36e34226d988f85fe612af6f769de/lib/appium_lib/device/touch_actions.rb#L70) > def release(opts=nil) Remove a finger from the screen. @@ -965,11 +973,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Hash] opts - a customizable set of options -- -##### [tap](https://github.com/appium/ruby_lib/blob/9b157011965442e6f021dcfeef588450277f1c6a/lib/appium_lib/device/touch_actions.rb#L81) +##### [tap](https://github.com/appium/ruby_lib/blob/ea11190b9ab36e34226d988f85fe612af6f769de/lib/appium_lib/device/touch_actions.rb#L81) > def tap(opts) Touch a point on the screen @@ -977,11 +985,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Hash] opts - a customizable set of options -- -##### [wait](https://github.com/appium/ruby_lib/blob/9b157011965442e6f021dcfeef588450277f1c6a/lib/appium_lib/device/touch_actions.rb#L90) +##### [wait](https://github.com/appium/ruby_lib/blob/ea11190b9ab36e34226d988f85fe612af6f769de/lib/appium_lib/device/touch_actions.rb#L90) > def wait(milliseconds) Pause for a number of milliseconds before the next action @@ -989,11 +997,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[integer] milliseconds - Number of milliseconds to pause for -- -##### [swipe](https://github.com/appium/ruby_lib/blob/9b157011965442e6f021dcfeef588450277f1c6a/lib/appium_lib/device/touch_actions.rb#L104) +##### [swipe](https://github.com/appium/ruby_lib/blob/ea11190b9ab36e34226d988f85fe612af6f769de/lib/appium_lib/device/touch_actions.rb#L104) > def swipe(opts) Convenience method to peform a swipe. @@ -1003,60 +1011,60 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Hash] opts - a customizable set of options -- -##### [perform](https://github.com/appium/ruby_lib/blob/9b157011965442e6f021dcfeef588450277f1c6a/lib/appium_lib/device/touch_actions.rb#L119) +##### [perform](https://github.com/appium/ruby_lib/blob/ea11190b9ab36e34226d988f85fe612af6f769de/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/9b157011965442e6f021dcfeef588450277f1c6a/lib/appium_lib/device/touch_actions.rb#L125) +##### [cancel](https://github.com/appium/ruby_lib/blob/ea11190b9ab36e34226d988f85fe612af6f769de/lib/appium_lib/device/touch_actions.rb#L125) > def cancel Does nothing, currently. -- -##### [chain_method](https://github.com/appium/ruby_lib/blob/9b157011965442e6f021dcfeef588450277f1c6a/lib/appium_lib/device/touch_actions.rb#L133) +##### [chain_method](https://github.com/appium/ruby_lib/blob/ea11190b9ab36e34226d988f85fe612af6f769de/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/9b157011965442e6f021dcfeef588450277f1c6a/lib/appium_lib/device/touch_actions.rb#L142) +##### [args_with_ele_ref](https://github.com/appium/ruby_lib/blob/ea11190b9ab36e34226d988f85fe612af6f769de/lib/appium_lib/device/touch_actions.rb#L142) > def args_with_ele_ref(args) -- -##### [_generic_wait](https://github.com/appium/ruby_lib/blob/9b157011965442e6f021dcfeef588450277f1c6a/lib/appium_lib/common/wait.rb#L10) +##### [_generic_wait](https://github.com/appium/ruby_lib/blob/ea11190b9ab36e34226d988f85fe612af6f769de/lib/appium_lib/common/wait.rb#L10) > def _generic_wait opts={}, &block Wait code from the selenium Ruby gem https://github.com/SeleniumHQ/selenium/blob/cf501dda3f0ed12233de51ce8170c0e8090f0c20/rb/lib/selenium/webdriver/common/wait.rb -- -##### [_process_wait_opts](https://github.com/appium/ruby_lib/blob/9b157011965442e6f021dcfeef588450277f1c6a/lib/appium_lib/common/wait.rb#L55) +##### [_process_wait_opts](https://github.com/appium/ruby_lib/blob/ea11190b9ab36e34226d988f85fe612af6f769de/lib/appium_lib/common/wait.rb#L55) > def _process_wait_opts opts process opts before calling _generic_wait -- -##### [wait_true](https://github.com/appium/ruby_lib/blob/9b157011965442e6f021dcfeef588450277f1c6a/lib/appium_lib/common/wait.rb#L76) +##### [wait_true](https://github.com/appium/ruby_lib/blob/ea11190b9ab36e34226d988f85fe612af6f769de/lib/appium_lib/common/wait.rb#L76) > def wait_true opts={}, &block Check every interval seconds to see if block.call returns a truthy value. Note this isn't a strict boolean true, any truthy value is accepted. @@ -1072,11 +1080,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Hash] opts - Options -- -##### [wait](https://github.com/appium/ruby_lib/blob/9b157011965442e6f021dcfeef588450277f1c6a/lib/appium_lib/common/wait.rb#L94) +##### [wait](https://github.com/appium/ruby_lib/blob/ea11190b9ab36e34226d988f85fe612af6f769de/lib/appium_lib/common/wait.rb#L94) > def wait opts={}, &block Check every interval seconds to see if block.call doesn't raise an exception. Give up after timeout seconds. @@ -1090,19 +1098,19 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Hash] opts - Options -- -##### [ignore](https://github.com/appium/ruby_lib/blob/9b157011965442e6f021dcfeef588450277f1c6a/lib/appium_lib/common/helper.rb#L24) +##### [ignore](https://github.com/appium/ruby_lib/blob/ea11190b9ab36e34226d988f85fe612af6f769de/lib/appium_lib/common/helper.rb#L24) > def ignore &block Return block.call and ignore any exceptions. -- -##### [back](https://github.com/appium/ruby_lib/blob/9b157011965442e6f021dcfeef588450277f1c6a/lib/appium_lib/common/helper.rb#L33) +##### [back](https://github.com/appium/ruby_lib/blob/ea11190b9ab36e34226d988f85fe612af6f769de/lib/appium_lib/common/helper.rb#L33) > def back Navigate back. @@ -1110,19 +1118,19 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[void] -- -##### [session_id](https://github.com/appium/ruby_lib/blob/9b157011965442e6f021dcfeef588450277f1c6a/lib/appium_lib/common/helper.rb#L38) +##### [session_id](https://github.com/appium/ruby_lib/blob/ea11190b9ab36e34226d988f85fe612af6f769de/lib/appium_lib/common/helper.rb#L38) > def session_id For Sauce Labs reporting. Returns the current session id. -- -##### [xpath](https://github.com/appium/ruby_lib/blob/9b157011965442e6f021dcfeef588450277f1c6a/lib/appium_lib/common/helper.rb#L46) +##### [xpath](https://github.com/appium/ruby_lib/blob/ea11190b9ab36e34226d988f85fe612af6f769de/lib/appium_lib/common/helper.rb#L46) > def xpath xpath_str Returns the first element that matches the provided xpath. @@ -1134,11 +1142,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Element] -- -##### [xpaths](https://github.com/appium/ruby_lib/blob/9b157011965442e6f021dcfeef588450277f1c6a/lib/appium_lib/common/helper.rb#L54) +##### [xpaths](https://github.com/appium/ruby_lib/blob/ea11190b9ab36e34226d988f85fe612af6f769de/lib/appium_lib/common/helper.rb#L54) > def xpaths xpath_str Returns all elements that match the provided xpath. @@ -1150,27 +1158,27 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Array<Element>] -- -##### [_print_source](https://github.com/appium/ruby_lib/blob/9b157011965442e6f021dcfeef588450277f1c6a/lib/appium_lib/common/helper.rb#L58) +##### [_print_source](https://github.com/appium/ruby_lib/blob/ea11190b9ab36e34226d988f85fe612af6f769de/lib/appium_lib/common/helper.rb#L58) > def _print_source source -- -##### [result](https://github.com/appium/ruby_lib/blob/9b157011965442e6f021dcfeef588450277f1c6a/lib/appium_lib/common/helper.rb#L71) +##### [result](https://github.com/appium/ruby_lib/blob/ea11190b9ab36e34226d988f85fe612af6f769de/lib/appium_lib/common/helper.rb#L71) > def result Returns the value of attribute result -- -##### [initialize](https://github.com/appium/ruby_lib/blob/9b157011965442e6f021dcfeef588450277f1c6a/lib/appium_lib/common/helper.rb#L73) +##### [initialize](https://github.com/appium/ruby_lib/blob/ea11190b9ab36e34226d988f85fe612af6f769de/lib/appium_lib/common/helper.rb#L73) > def initialize @@ -1178,52 +1186,52 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[CountElements] a new instance of CountElements -- -##### [reset](https://github.com/appium/ruby_lib/blob/9b157011965442e6f021dcfeef588450277f1c6a/lib/appium_lib/common/helper.rb#L77) +##### [reset](https://github.com/appium/ruby_lib/blob/ea11190b9ab36e34226d988f85fe612af6f769de/lib/appium_lib/common/helper.rb#L77) > def reset -- -##### [start_element](https://github.com/appium/ruby_lib/blob/9b157011965442e6f021dcfeef588450277f1c6a/lib/appium_lib/common/helper.rb#L82) +##### [start_element](https://github.com/appium/ruby_lib/blob/ea11190b9ab36e34226d988f85fe612af6f769de/lib/appium_lib/common/helper.rb#L82) > def start_element name, attrs = [] http://nokogiri.org/Nokogiri/XML/SAX/Document.html -- -##### [formatted_result](https://github.com/appium/ruby_lib/blob/9b157011965442e6f021dcfeef588450277f1c6a/lib/appium_lib/common/helper.rb#L88) +##### [formatted_result](https://github.com/appium/ruby_lib/blob/ea11190b9ab36e34226d988f85fe612af6f769de/lib/appium_lib/common/helper.rb#L88) > def formatted_result -- -##### [get_page_class](https://github.com/appium/ruby_lib/blob/9b157011965442e6f021dcfeef588450277f1c6a/lib/appium_lib/common/helper.rb#L99) +##### [get_page_class](https://github.com/appium/ruby_lib/blob/ea11190b9ab36e34226d988f85fe612af6f769de/lib/appium_lib/common/helper.rb#L99) > def get_page_class Returns a string of class counts of visible elements. -- -##### [page_class](https://github.com/appium/ruby_lib/blob/9b157011965442e6f021dcfeef588450277f1c6a/lib/appium_lib/common/helper.rb#L110) +##### [page_class](https://github.com/appium/ruby_lib/blob/ea11190b9ab36e34226d988f85fe612af6f769de/lib/appium_lib/common/helper.rb#L110) > def page_class Count all classes on screen and print to stdout. Useful for appium_console. -- -##### [px_to_window_rel](https://github.com/appium/ruby_lib/blob/9b157011965442e6f021dcfeef588450277f1c6a/lib/appium_lib/common/helper.rb#L120) +##### [px_to_window_rel](https://github.com/appium/ruby_lib/blob/ea11190b9ab36e34226d988f85fe612af6f769de/lib/appium_lib/common/helper.rb#L120) > def px_to_window_rel opts={} Converts pixel values to window relative values @@ -1231,11 +1239,11 @@ px_to_window_rel x: 50, y: 150 ``` -- -##### [xml_keys](https://github.com/appium/ruby_lib/blob/9b157011965442e6f021dcfeef588450277f1c6a/lib/appium_lib/common/helper.rb#L139) +##### [xml_keys](https://github.com/appium/ruby_lib/blob/ea11190b9ab36e34226d988f85fe612af6f769de/lib/appium_lib/common/helper.rb#L139) > def xml_keys target Search strings.xml's values for target. @@ -1247,11 +1255,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Array] -- -##### [xml_values](https://github.com/appium/ruby_lib/blob/9b157011965442e6f021dcfeef588450277f1c6a/lib/appium_lib/common/helper.rb#L147) +##### [xml_values](https://github.com/appium/ruby_lib/blob/ea11190b9ab36e34226d988f85fe612af6f769de/lib/appium_lib/common/helper.rb#L147) > def xml_values target Search strings.xml's keys for target. @@ -1263,11 +1271,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Array] -- -##### [resolve_id](https://github.com/appium/ruby_lib/blob/9b157011965442e6f021dcfeef588450277f1c6a/lib/appium_lib/common/helper.rb#L155) +##### [resolve_id](https://github.com/appium/ruby_lib/blob/ea11190b9ab36e34226d988f85fe612af6f769de/lib/appium_lib/common/helper.rb#L155) > def resolve_id id Resolve id in strings.xml and return the value. @@ -1279,27 +1287,27 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[String] -- -##### [filter](https://github.com/appium/ruby_lib/blob/9b157011965442e6f021dcfeef588450277f1c6a/lib/appium_lib/common/helper.rb#L161) +##### [filter](https://github.com/appium/ruby_lib/blob/ea11190b9ab36e34226d988f85fe612af6f769de/lib/appium_lib/common/helper.rb#L161) > def filter -- -##### [filter=](https://github.com/appium/ruby_lib/blob/9b157011965442e6f021dcfeef588450277f1c6a/lib/appium_lib/common/helper.rb#L166) +##### [filter=](https://github.com/appium/ruby_lib/blob/ea11190b9ab36e34226d988f85fe612af6f769de/lib/appium_lib/common/helper.rb#L166) > def filter= value convert to string to support symbols -- -##### [initialize](https://github.com/appium/ruby_lib/blob/9b157011965442e6f021dcfeef588450277f1c6a/lib/appium_lib/common/helper.rb#L172) +##### [initialize](https://github.com/appium/ruby_lib/blob/ea11190b9ab36e34226d988f85fe612af6f769de/lib/appium_lib/common/helper.rb#L172) > def initialize @@ -1307,67 +1315,67 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[HTMLElements] a new instance of HTMLElements -- -##### [reset](https://github.com/appium/ruby_lib/blob/9b157011965442e6f021dcfeef588450277f1c6a/lib/appium_lib/common/helper.rb#L177) +##### [reset](https://github.com/appium/ruby_lib/blob/ea11190b9ab36e34226d988f85fe612af6f769de/lib/appium_lib/common/helper.rb#L177) > def reset -- -##### [result](https://github.com/appium/ruby_lib/blob/9b157011965442e6f021dcfeef588450277f1c6a/lib/appium_lib/common/helper.rb#L183) +##### [result](https://github.com/appium/ruby_lib/blob/ea11190b9ab36e34226d988f85fe612af6f769de/lib/appium_lib/common/helper.rb#L183) > def result -- -##### [start_element](https://github.com/appium/ruby_lib/blob/9b157011965442e6f021dcfeef588450277f1c6a/lib/appium_lib/common/helper.rb#L199) +##### [start_element](https://github.com/appium/ruby_lib/blob/ea11190b9ab36e34226d988f85fe612af6f769de/lib/appium_lib/common/helper.rb#L199) > def start_element name, attrs = [] -- -##### [end_element](https://github.com/appium/ruby_lib/blob/9b157011965442e6f021dcfeef588450277f1c6a/lib/appium_lib/common/helper.rb#L209) +##### [end_element](https://github.com/appium/ruby_lib/blob/ea11190b9ab36e34226d988f85fe612af6f769de/lib/appium_lib/common/helper.rb#L209) > def end_element name -- -##### [characters](https://github.com/appium/ruby_lib/blob/9b157011965442e6f021dcfeef588450277f1c6a/lib/appium_lib/common/helper.rb#L215) +##### [characters](https://github.com/appium/ruby_lib/blob/ea11190b9ab36e34226d988f85fe612af6f769de/lib/appium_lib/common/helper.rb#L215) > def characters(chars) -- -##### [_no_such_element](https://github.com/appium/ruby_lib/blob/9b157011965442e6f021dcfeef588450277f1c6a/lib/appium_lib/common/helper.rb#L223) +##### [_no_such_element](https://github.com/appium/ruby_lib/blob/ea11190b9ab36e34226d988f85fe612af6f769de/lib/appium_lib/common/helper.rb#L223) > def _no_such_element -- -##### [window_size](https://github.com/appium/ruby_lib/blob/9b157011965442e6f021dcfeef588450277f1c6a/lib/appium_lib/common/element/window.rb#L5) +##### [window_size](https://github.com/appium/ruby_lib/blob/ea11190b9ab36e34226d988f85fe612af6f769de/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/9b157011965442e6f021dcfeef588450277f1c6a/lib/appium_lib/ios/helper.rb#L8) ios +##### [ios_password](https://github.com/appium/ruby_lib/blob/ea11190b9ab36e34226d988f85fe612af6f769de/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. @@ -1381,11 +1389,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[String] the returned string is of size length -- -##### [get_page](https://github.com/appium/ruby_lib/blob/9b157011965442e6f021dcfeef588450277f1c6a/lib/appium_lib/ios/helper.rb#L20) ios +##### [get_page](https://github.com/appium/ruby_lib/blob/ea11190b9ab36e34226d988f85fe612af6f769de/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. @@ -1402,11 +1410,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[String] -- -##### [page](https://github.com/appium/ruby_lib/blob/9b157011965442e6f021dcfeef588450277f1c6a/lib/appium_lib/ios/helper.rb#L125) ios +##### [page](https://github.com/appium/ruby_lib/blob/ea11190b9ab36e34226d988f85fe612af6f769de/lib/appium_lib/ios/helper.rb#L125) ios > def page opts={} Prints a string of interesting elements to the console. @@ -1428,11 +1436,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[void] -- -##### [source_window](https://github.com/appium/ruby_lib/blob/9b157011965442e6f021dcfeef588450277f1c6a/lib/appium_lib/ios/helper.rb#L157) ios +##### [source_window](https://github.com/appium/ruby_lib/blob/ea11190b9ab36e34226d988f85fe612af6f769de/lib/appium_lib/ios/helper.rb#L157) ios > def source_window window_number=0 Gets the JSON source of window number @@ -1444,11 +1452,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[JSON] -- -##### [page_window](https://github.com/appium/ruby_lib/blob/9b157011965442e6f021dcfeef588450277f1c6a/lib/appium_lib/ios/helper.rb#L171) ios +##### [page_window](https://github.com/appium/ruby_lib/blob/ea11190b9ab36e34226d988f85fe612af6f769de/lib/appium_lib/ios/helper.rb#L171) ios > def page_window window_number=0 Prints parsed page source to console. @@ -1462,11 +1470,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[void] -- -##### [id](https://github.com/appium/ruby_lib/blob/9b157011965442e6f021dcfeef588450277f1c6a/lib/appium_lib/ios/helper.rb#L179) ios +##### [id](https://github.com/appium/ruby_lib/blob/ea11190b9ab36e34226d988f85fe612af6f769de/lib/appium_lib/ios/helper.rb#L179) ios > def id id Find by id @@ -1478,11 +1486,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Element] -- -##### [ios_version](https://github.com/appium/ruby_lib/blob/9b157011965442e6f021dcfeef588450277f1c6a/lib/appium_lib/ios/helper.rb#L185) ios +##### [ios_version](https://github.com/appium/ruby_lib/blob/ea11190b9ab36e34226d988f85fe612af6f769de/lib/appium_lib/ios/helper.rb#L185) ios > def ios_version Return the iOS version as an array of integers @@ -1490,11 +1498,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Array<Integer>] -- -##### [ele_index](https://github.com/appium/ruby_lib/blob/9b157011965442e6f021dcfeef588450277f1c6a/lib/appium_lib/ios/helper.rb#L194) ios +##### [ele_index](https://github.com/appium/ruby_lib/blob/ea11190b9ab36e34226d988f85fe612af6f769de/lib/appium_lib/ios/helper.rb#L194) ios > def ele_index class_name, index Get the element of type class_name at matching index. @@ -1508,11 +1516,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Element] -- -##### [find_ele_by_attr](https://github.com/appium/ruby_lib/blob/9b157011965442e6f021dcfeef588450277f1c6a/lib/appium_lib/ios/helper.rb#L221) ios +##### [find_ele_by_attr](https://github.com/appium/ruby_lib/blob/ea11190b9ab36e34226d988f85fe612af6f769de/lib/appium_lib/ios/helper.rb#L221) ios > def find_ele_by_attr class_name, attr, value Find the first element exactly matching class and attribute value. Note: Uses XPath @@ -1529,11 +1537,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Element] -- -##### [find_eles_by_attr](https://github.com/appium/ruby_lib/blob/9b157011965442e6f021dcfeef588450277f1c6a/lib/appium_lib/ios/helper.rb#L231) ios +##### [find_eles_by_attr](https://github.com/appium/ruby_lib/blob/ea11190b9ab36e34226d988f85fe612af6f769de/lib/appium_lib/ios/helper.rb#L231) ios > def find_eles_by_attr class_name, attr, value Find all elements exactly matching class and attribute value. Note: Uses XPath @@ -1550,11 +1558,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Array<Element>] -- -##### [find_ele_by_attr_include](https://github.com/appium/ruby_lib/blob/9b157011965442e6f021dcfeef588450277f1c6a/lib/appium_lib/ios/helper.rb#L246) ios +##### [find_ele_by_attr_include](https://github.com/appium/ruby_lib/blob/ea11190b9ab36e34226d988f85fe612af6f769de/lib/appium_lib/ios/helper.rb#L246) ios > def find_ele_by_attr_include class_name, attr, value Get the first tag by attribute that exactly matches value. Note: Uses XPath @@ -1571,11 +1579,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/9b157011965442e6f021dcfeef588450277f1c6a/lib/appium_lib/ios/helper.rb#L256) ios +##### [find_eles_by_attr_include](https://github.com/appium/ruby_lib/blob/ea11190b9ab36e34226d988f85fe612af6f769de/lib/appium_lib/ios/helper.rb#L256) ios > def find_eles_by_attr_include class_name, attr, value Get tags by attribute that include value. Note: Uses XPath @@ -1592,11 +1600,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/9b157011965442e6f021dcfeef588450277f1c6a/lib/appium_lib/ios/helper.rb#L263) ios +##### [first_ele](https://github.com/appium/ruby_lib/blob/ea11190b9ab36e34226d988f85fe612af6f769de/lib/appium_lib/ios/helper.rb#L263) ios > def first_ele class_name Get the first tag that matches class_name @@ -1608,11 +1616,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Element] -- -##### [last_ele](https://github.com/appium/ruby_lib/blob/9b157011965442e6f021dcfeef588450277f1c6a/lib/appium_lib/ios/helper.rb#L271) ios +##### [last_ele](https://github.com/appium/ruby_lib/blob/ea11190b9ab36e34226d988f85fe612af6f769de/lib/appium_lib/ios/helper.rb#L271) ios > def last_ele class_name Get the last tag that matches class_name @@ -1624,11 +1632,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Element] -- -##### [tag](https://github.com/appium/ruby_lib/blob/9b157011965442e6f021dcfeef588450277f1c6a/lib/appium_lib/ios/helper.rb#L279) ios +##### [tag](https://github.com/appium/ruby_lib/blob/ea11190b9ab36e34226d988f85fe612af6f769de/lib/appium_lib/ios/helper.rb#L279) ios > def tag class_name Returns the first visible element matching class_name @@ -1640,11 +1648,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Element] -- -##### [tags](https://github.com/appium/ruby_lib/blob/9b157011965442e6f021dcfeef588450277f1c6a/lib/appium_lib/ios/helper.rb#L290) ios +##### [tags](https://github.com/appium/ruby_lib/blob/ea11190b9ab36e34226d988f85fe612af6f769de/lib/appium_lib/ios/helper.rb#L290) ios > def tags class_name Returns all visible elements matching class_name @@ -1656,11 +1664,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Element] -- -##### [ele_by_json_visible_contains](https://github.com/appium/ruby_lib/blob/9b157011965442e6f021dcfeef588450277f1c6a/lib/appium_lib/ios/helper.rb#L325) ios +##### [ele_by_json_visible_contains](https://github.com/appium/ruby_lib/blob/ea11190b9ab36e34226d988f85fe612af6f769de/lib/appium_lib/ios/helper.rb#L325) ios > def ele_by_json_visible_contains element, value Find the first element that contains value @@ -1674,11 +1682,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Element] -- -##### [eles_by_json_visible_contains](https://github.com/appium/ruby_lib/blob/9b157011965442e6f021dcfeef588450277f1c6a/lib/appium_lib/ios/helper.rb#L333) ios +##### [eles_by_json_visible_contains](https://github.com/appium/ruby_lib/blob/ea11190b9ab36e34226d988f85fe612af6f769de/lib/appium_lib/ios/helper.rb#L333) ios > def eles_by_json_visible_contains element, value Find all elements containing value @@ -1692,11 +1700,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Array<Element>] -- -##### [ele_by_json_visible_exact](https://github.com/appium/ruby_lib/blob/9b157011965442e6f021dcfeef588450277f1c6a/lib/appium_lib/ios/helper.rb#L362) ios +##### [ele_by_json_visible_exact](https://github.com/appium/ruby_lib/blob/ea11190b9ab36e34226d988f85fe612af6f769de/lib/appium_lib/ios/helper.rb#L362) ios > def ele_by_json_visible_exact element, value Find the first element exactly matching value @@ -1710,11 +1718,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Element] -- -##### [eles_by_json_visible_exact](https://github.com/appium/ruby_lib/blob/9b157011965442e6f021dcfeef588450277f1c6a/lib/appium_lib/ios/helper.rb#L370) ios +##### [eles_by_json_visible_exact](https://github.com/appium/ruby_lib/blob/ea11190b9ab36e34226d988f85fe612af6f769de/lib/appium_lib/ios/helper.rb#L370) ios > def eles_by_json_visible_exact element, value Find all elements exactly matching value @@ -1728,21 +1736,21 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Element] -- -##### [_all_pred](https://github.com/appium/ruby_lib/blob/9b157011965442e6f021dcfeef588450277f1c6a/lib/appium_lib/ios/helper.rb#L434) ios +##### [_all_pred](https://github.com/appium/ruby_lib/blob/ea11190b9ab36e34226d988f85fe612af6f769de/lib/appium_lib/ios/helper.rb#L434) ios > def _all_pred opts predicate - the predicate to evaluate on the main app visible - if true, only visible elements are returned. default true -- -##### [ele_with_pred](https://github.com/appium/ruby_lib/blob/9b157011965442e6f021dcfeef588450277f1c6a/lib/appium_lib/ios/helper.rb#L447) ios +##### [ele_with_pred](https://github.com/appium/ruby_lib/blob/ea11190b9ab36e34226d988f85fe612af6f769de/lib/appium_lib/ios/helper.rb#L447) ios > def ele_with_pred opts returns element matching predicate contained in the main app @@ -1754,11 +1762,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Element] -- -##### [eles_with_pred](https://github.com/appium/ruby_lib/blob/9b157011965442e6f021dcfeef588450277f1c6a/lib/appium_lib/ios/helper.rb#L458) ios +##### [eles_with_pred](https://github.com/appium/ruby_lib/blob/ea11190b9ab36e34226d988f85fe612af6f769de/lib/appium_lib/ios/helper.rb#L458) ios > def eles_with_pred opts returns elements matching predicate contained in the main app @@ -1770,11 +1778,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Array<Element>] -- -##### [source](https://github.com/appium/ruby_lib/blob/9b157011965442e6f021dcfeef588450277f1c6a/lib/appium_lib/ios/helper.rb#L464) ios +##### [source](https://github.com/appium/ruby_lib/blob/ea11190b9ab36e34226d988f85fe612af6f769de/lib/appium_lib/ios/helper.rb#L464) ios > def source Prints xml of the current page @@ -1782,19 +1790,19 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[void] -- -##### [_validate_object](https://github.com/appium/ruby_lib/blob/9b157011965442e6f021dcfeef588450277f1c6a/lib/appium_lib/ios/helper.rb#L468) ios +##### [_validate_object](https://github.com/appium/ruby_lib/blob/ea11190b9ab36e34226d988f85fe612af6f769de/lib/appium_lib/ios/helper.rb#L468) ios > def _validate_object *objects -- -##### [_by_json](https://github.com/appium/ruby_lib/blob/9b157011965442e6f021dcfeef588450277f1c6a/lib/appium_lib/ios/helper.rb#L516) ios +##### [_by_json](https://github.com/appium/ruby_lib/blob/ea11190b9ab36e34226d988f85fe612af6f769de/lib/appium_lib/ios/helper.rb#L516) ios > def _by_json opts typeArray - array of string types to search for. Example: ["UIAStaticText"] onlyFirst - boolean. returns only the first result if true. Example: true @@ -1824,11 +1832,11 @@ } } -- -##### [eles_by_json](https://github.com/appium/ruby_lib/blob/9b157011965442e6f021dcfeef588450277f1c6a/lib/appium_lib/ios/helper.rb#L556) ios +##### [eles_by_json](https://github.com/appium/ruby_lib/blob/ea11190b9ab36e34226d988f85fe612af6f769de/lib/appium_lib/ios/helper.rb#L556) ios > def eles_by_json opts example usage: @@ -1842,19 +1850,19 @@ }, }) -- -##### [ele_by_json](https://github.com/appium/ruby_lib/blob/9b157011965442e6f021dcfeef588450277f1c6a/lib/appium_lib/ios/helper.rb#L562) ios +##### [ele_by_json](https://github.com/appium/ruby_lib/blob/ea11190b9ab36e34226d988f85fe612af6f769de/lib/appium_lib/ios/helper.rb#L562) ios > def ele_by_json opts see eles_by_json -- -##### [get_source](https://github.com/appium/ruby_lib/blob/9b157011965442e6f021dcfeef588450277f1c6a/lib/appium_lib/ios/helper.rb#L572) ios +##### [get_source](https://github.com/appium/ruby_lib/blob/ea11190b9ab36e34226d988f85fe612af6f769de/lib/appium_lib/ios/helper.rb#L572) ios > def get_source Returns XML string for the current page Same as driver.page_source @@ -1863,19 +1871,19 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[String] -- -##### [UIAStaticText](https://github.com/appium/ruby_lib/blob/9b157011965442e6f021dcfeef588450277f1c6a/lib/appium_lib/ios/element/text.rb#L4) ios +##### [UIAStaticText](https://github.com/appium/ruby_lib/blob/ea11190b9ab36e34226d988f85fe612af6f769de/lib/appium_lib/ios/element/text.rb#L4) ios > UIAStaticText = 'UIAStaticText' -- -##### [text](https://github.com/appium/ruby_lib/blob/9b157011965442e6f021dcfeef588450277f1c6a/lib/appium_lib/ios/element/text.rb#L10) ios +##### [text](https://github.com/appium/ruby_lib/blob/ea11190b9ab36e34226d988f85fe612af6f769de/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. @@ -1888,11 +1896,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[UIAStaticText] -- -##### [texts](https://github.com/appium/ruby_lib/blob/9b157011965442e6f021dcfeef588450277f1c6a/lib/appium_lib/ios/element/text.rb#L19) ios +##### [texts](https://github.com/appium/ruby_lib/blob/ea11190b9ab36e34226d988f85fe612af6f769de/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 @@ -1905,11 +1913,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Array<UIAStaticText>] -- -##### [first_text](https://github.com/appium/ruby_lib/blob/9b157011965442e6f021dcfeef588450277f1c6a/lib/appium_lib/ios/element/text.rb#L26) ios +##### [first_text](https://github.com/appium/ruby_lib/blob/ea11190b9ab36e34226d988f85fe612af6f769de/lib/appium_lib/ios/element/text.rb#L26) ios > def first_text Find the first UIAStaticText. @@ -1917,11 +1925,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[UIAStaticText] -- -##### [last_text](https://github.com/appium/ruby_lib/blob/9b157011965442e6f021dcfeef588450277f1c6a/lib/appium_lib/ios/element/text.rb#L32) ios +##### [last_text](https://github.com/appium/ruby_lib/blob/ea11190b9ab36e34226d988f85fe612af6f769de/lib/appium_lib/ios/element/text.rb#L32) ios > def last_text Find the last UIAStaticText. @@ -1929,11 +1937,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[UIAStaticText] -- -##### [text_exact](https://github.com/appium/ruby_lib/blob/9b157011965442e6f021dcfeef588450277f1c6a/lib/appium_lib/ios/element/text.rb#L39) ios +##### [text_exact](https://github.com/appium/ruby_lib/blob/ea11190b9ab36e34226d988f85fe612af6f769de/lib/appium_lib/ios/element/text.rb#L39) ios > def text_exact value Find the first UIAStaticText that exactly matches value. @@ -1945,11 +1953,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[UIAStaticText] -- -##### [texts_exact](https://github.com/appium/ruby_lib/blob/9b157011965442e6f021dcfeef588450277f1c6a/lib/appium_lib/ios/element/text.rb#L46) ios +##### [texts_exact](https://github.com/appium/ruby_lib/blob/ea11190b9ab36e34226d988f85fe612af6f769de/lib/appium_lib/ios/element/text.rb#L46) ios > def texts_exact value Find all UIAStaticTexts that exactly match value. @@ -1961,11 +1969,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Array<UIAStaticText>] -- -##### [alert_accept](https://github.com/appium/ruby_lib/blob/9b157011965442e6f021dcfeef588450277f1c6a/lib/appium_lib/ios/element/alert.rb#L5) ios +##### [alert_accept](https://github.com/appium/ruby_lib/blob/ea11190b9ab36e34226d988f85fe612af6f769de/lib/appium_lib/ios/element/alert.rb#L5) ios > def alert_accept Accept the alert. @@ -1973,11 +1981,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[void] -- -##### [alert_dismiss](https://github.com/appium/ruby_lib/blob/9b157011965442e6f021dcfeef588450277f1c6a/lib/appium_lib/ios/element/alert.rb#L13) ios +##### [alert_dismiss](https://github.com/appium/ruby_lib/blob/ea11190b9ab36e34226d988f85fe612af6f769de/lib/appium_lib/ios/element/alert.rb#L13) ios > def alert_dismiss Dismiss the alert. @@ -1985,11 +1993,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[void] -- -##### [uiautomation_find](https://github.com/appium/ruby_lib/blob/9b157011965442e6f021dcfeef588450277f1c6a/lib/appium_lib/ios/mobile_methods.rb#L10) ios +##### [uiautomation_find](https://github.com/appium/ruby_lib/blob/ea11190b9ab36e34226d988f85fe612af6f769de/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). @@ -1997,19 +2005,19 @@ find_elements :uiautomation, 'elements() ``` -- -##### [UIAButton](https://github.com/appium/ruby_lib/blob/9b157011965442e6f021dcfeef588450277f1c6a/lib/appium_lib/ios/element/button.rb#L4) ios +##### [UIAButton](https://github.com/appium/ruby_lib/blob/ea11190b9ab36e34226d988f85fe612af6f769de/lib/appium_lib/ios/element/button.rb#L4) ios > UIAButton = 'UIAButton' -- -##### [button](https://github.com/appium/ruby_lib/blob/9b157011965442e6f021dcfeef588450277f1c6a/lib/appium_lib/ios/element/button.rb#L10) ios +##### [button](https://github.com/appium/ruby_lib/blob/ea11190b9ab36e34226d988f85fe612af6f769de/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. @@ -2022,11 +2030,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[UIAButton] -- -##### [buttons](https://github.com/appium/ruby_lib/blob/9b157011965442e6f021dcfeef588450277f1c6a/lib/appium_lib/ios/element/button.rb#L20) ios +##### [buttons](https://github.com/appium/ruby_lib/blob/ea11190b9ab36e34226d988f85fe612af6f769de/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. @@ -2039,11 +2047,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Array<UIAButton>] -- -##### [first_button](https://github.com/appium/ruby_lib/blob/9b157011965442e6f021dcfeef588450277f1c6a/lib/appium_lib/ios/element/button.rb#L27) ios +##### [first_button](https://github.com/appium/ruby_lib/blob/ea11190b9ab36e34226d988f85fe612af6f769de/lib/appium_lib/ios/element/button.rb#L27) ios > def first_button Find the first UIAButton. @@ -2051,11 +2059,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[UIAButton] -- -##### [last_button](https://github.com/appium/ruby_lib/blob/9b157011965442e6f021dcfeef588450277f1c6a/lib/appium_lib/ios/element/button.rb#L33) ios +##### [last_button](https://github.com/appium/ruby_lib/blob/ea11190b9ab36e34226d988f85fe612af6f769de/lib/appium_lib/ios/element/button.rb#L33) ios > def last_button Find the last UIAButton. @@ -2063,11 +2071,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[UIAButton] -- -##### [button_exact](https://github.com/appium/ruby_lib/blob/9b157011965442e6f021dcfeef588450277f1c6a/lib/appium_lib/ios/element/button.rb#L40) ios +##### [button_exact](https://github.com/appium/ruby_lib/blob/ea11190b9ab36e34226d988f85fe612af6f769de/lib/appium_lib/ios/element/button.rb#L40) ios > def button_exact value Find the first UIAButton that exactly matches value. @@ -2079,11 +2087,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[UIAButton] -- -##### [buttons_exact](https://github.com/appium/ruby_lib/blob/9b157011965442e6f021dcfeef588450277f1c6a/lib/appium_lib/ios/element/button.rb#L47) ios +##### [buttons_exact](https://github.com/appium/ruby_lib/blob/ea11190b9ab36e34226d988f85fe612af6f769de/lib/appium_lib/ios/element/button.rb#L47) ios > def buttons_exact value Find all UIAButtons that exactly match value. @@ -2095,11 +2103,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Array<UIAButton>] -- -##### [find](https://github.com/appium/ruby_lib/blob/9b157011965442e6f021dcfeef588450277f1c6a/lib/appium_lib/ios/element/generic.rb#L7) ios +##### [find](https://github.com/appium/ruby_lib/blob/ea11190b9ab36e34226d988f85fe612af6f769de/lib/appium_lib/ios/element/generic.rb#L7) ios > def find value Find the first element containing value @@ -2111,11 +2119,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Element] -- -##### [finds](https://github.com/appium/ruby_lib/blob/9b157011965442e6f021dcfeef588450277f1c6a/lib/appium_lib/ios/element/generic.rb#L14) ios +##### [finds](https://github.com/appium/ruby_lib/blob/ea11190b9ab36e34226d988f85fe612af6f769de/lib/appium_lib/ios/element/generic.rb#L14) ios > def finds value Find all elements containing value @@ -2127,11 +2135,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Array<Element>] -- -##### [find_exact](https://github.com/appium/ruby_lib/blob/9b157011965442e6f021dcfeef588450277f1c6a/lib/appium_lib/ios/element/generic.rb#L21) ios +##### [find_exact](https://github.com/appium/ruby_lib/blob/ea11190b9ab36e34226d988f85fe612af6f769de/lib/appium_lib/ios/element/generic.rb#L21) ios > def find_exact value Find the first element exactly matching value @@ -2143,11 +2151,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Element] -- -##### [finds_exact](https://github.com/appium/ruby_lib/blob/9b157011965442e6f021dcfeef588450277f1c6a/lib/appium_lib/ios/element/generic.rb#L28) ios +##### [finds_exact](https://github.com/appium/ruby_lib/blob/ea11190b9ab36e34226d988f85fe612af6f769de/lib/appium_lib/ios/element/generic.rb#L28) ios > def finds_exact value Find all elements exactly matching value @@ -2159,27 +2167,27 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Array<Element>] -- -##### [UIATextField](https://github.com/appium/ruby_lib/blob/9b157011965442e6f021dcfeef588450277f1c6a/lib/appium_lib/ios/element/textfield.rb#L3) ios +##### [UIATextField](https://github.com/appium/ruby_lib/blob/ea11190b9ab36e34226d988f85fe612af6f769de/lib/appium_lib/ios/element/textfield.rb#L3) ios > UIATextField = 'UIATextField' -- -##### [UIASecureTextField](https://github.com/appium/ruby_lib/blob/9b157011965442e6f021dcfeef588450277f1c6a/lib/appium_lib/ios/element/textfield.rb#L4) ios +##### [UIASecureTextField](https://github.com/appium/ruby_lib/blob/ea11190b9ab36e34226d988f85fe612af6f769de/lib/appium_lib/ios/element/textfield.rb#L4) ios > UIASecureTextField = 'UIASecureTextField' -- -##### [textfield](https://github.com/appium/ruby_lib/blob/9b157011965442e6f021dcfeef588450277f1c6a/lib/appium_lib/ios/element/textfield.rb#L52) ios +##### [textfield](https://github.com/appium/ruby_lib/blob/ea11190b9ab36e34226d988f85fe612af6f769de/lib/appium_lib/ios/element/textfield.rb#L52) ios > def textfield value Find the first TextField that contains value or by index. If int then the TextField at that index is returned. @@ -2192,11 +2200,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[TextField] -- -##### [textfields](https://github.com/appium/ruby_lib/blob/9b157011965442e6f021dcfeef588450277f1c6a/lib/appium_lib/ios/element/textfield.rb#L72) ios +##### [textfields](https://github.com/appium/ruby_lib/blob/ea11190b9ab36e34226d988f85fe612af6f769de/lib/appium_lib/ios/element/textfield.rb#L72) ios > def textfields value=false Find all TextFields containing value. If value is omitted, all TextFields are returned. @@ -2209,11 +2217,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Array<TextField>] -- -##### [first_textfield](https://github.com/appium/ruby_lib/blob/9b157011965442e6f021dcfeef588450277f1c6a/lib/appium_lib/ios/element/textfield.rb#L79) ios +##### [first_textfield](https://github.com/appium/ruby_lib/blob/ea11190b9ab36e34226d988f85fe612af6f769de/lib/appium_lib/ios/element/textfield.rb#L79) ios > def first_textfield Find the first TextField. @@ -2221,11 +2229,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[TextField] -- -##### [last_textfield](https://github.com/appium/ruby_lib/blob/9b157011965442e6f021dcfeef588450277f1c6a/lib/appium_lib/ios/element/textfield.rb#L85) ios +##### [last_textfield](https://github.com/appium/ruby_lib/blob/ea11190b9ab36e34226d988f85fe612af6f769de/lib/appium_lib/ios/element/textfield.rb#L85) ios > def last_textfield Find the last TextField. @@ -2233,11 +2241,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[TextField] -- -##### [textfield_exact](https://github.com/appium/ruby_lib/blob/9b157011965442e6f021dcfeef588450277f1c6a/lib/appium_lib/ios/element/textfield.rb#L94) ios +##### [textfield_exact](https://github.com/appium/ruby_lib/blob/ea11190b9ab36e34226d988f85fe612af6f769de/lib/appium_lib/ios/element/textfield.rb#L94) ios > def textfield_exact value Find the first TextField that exactly matches value. @@ -2249,11 +2257,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[TextField] -- -##### [textfields_exact](https://github.com/appium/ruby_lib/blob/9b157011965442e6f021dcfeef588450277f1c6a/lib/appium_lib/ios/element/textfield.rb#L101) ios +##### [textfields_exact](https://github.com/appium/ruby_lib/blob/ea11190b9ab36e34226d988f85fe612af6f769de/lib/appium_lib/ios/element/textfield.rb#L101) ios > def textfields_exact value Find all TextFields that exactly match value. @@ -2265,31 +2273,31 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Array<TextField>] -- -##### [value](https://github.com/appium/ruby_lib/blob/9b157011965442e6f021dcfeef588450277f1c6a/lib/appium_lib/common/patch.rb#L12) +##### [value](https://github.com/appium/ruby_lib/blob/ea11190b9ab36e34226d988f85fe612af6f769de/lib/appium_lib/common/patch.rb#L12) > def value Returns the value attribute Fixes NoMethodError: undefined method `value' for Selenium::WebDriver::Element -- -##### [name](https://github.com/appium/ruby_lib/blob/9b157011965442e6f021dcfeef588450277f1c6a/lib/appium_lib/common/patch.rb#L19) +##### [name](https://github.com/appium/ruby_lib/blob/ea11190b9ab36e34226d988f85fe612af6f769de/lib/appium_lib/common/patch.rb#L19) > def name Returns the name attribute Fixes NoMethodError: undefined method `name' for Selenium::WebDriver::Element -- -##### [location_rel](https://github.com/appium/ruby_lib/blob/9b157011965442e6f021dcfeef588450277f1c6a/lib/appium_lib/common/patch.rb#L31) +##### [location_rel](https://github.com/appium/ruby_lib/blob/ea11190b9ab36e34226d988f85fe612af6f769de/lib/appium_lib/common/patch.rb#L31) > def location_rel For use with mobile tap. @@ -2303,10 +2311,10 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[OpenStruct] the relative x, y in a struct. ex: { x: 0.50, y: 0.20 } -- -##### [DEFAULT_HEADERS](https://github.com/appium/ruby_lib/blob/9b157011965442e6f021dcfeef588450277f1c6a/lib/appium_lib/common/patch.rb#L145) +##### [DEFAULT_HEADERS](https://github.com/appium/ruby_lib/blob/ea11190b9ab36e34226d988f85fe612af6f769de/lib/appium_lib/common/patch.rb#L145) > DEFAULT_HEADERS = { 'Accept' => CONTENT_TYPE, 'User-Agent' => "appium/ruby_lib/#{::Appium::VERSION}" }