docs/android_docs.md in appium_lib-0.21.0 vs docs/android_docs.md in appium_lib-0.22.0

- old
+ new

@@ -1,6 +1,6 @@ -##### [s_texts](https://github.com/appium/ruby_lib/blob/db2df39eb6fc09e516e22334dd990699755c0509/lib/appium_lib/common/element/text.rb#L10) +##### [s_texts](https://github.com/appium/ruby_lib/blob/4d88ecd87be7a2319dd0b7e437e230300269175f/lib/appium_lib/common/element/text.rb#L10) > def s_texts text=nil Get an array of text texts if text is nil else Get all static textfields that include text. @@ -13,19 +13,19 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Array] -- -##### [s_texts_names](https://github.com/appium/ruby_lib/blob/db2df39eb6fc09e516e22334dd990699755c0509/lib/appium_lib/common/element/text.rb#L18) +##### [s_texts_names](https://github.com/appium/ruby_lib/blob/4d88ecd87be7a2319dd0b7e437e230300269175f/lib/appium_lib/common/element/text.rb#L18) > def s_texts_names -- -##### [e_s_texts](https://github.com/appium/ruby_lib/blob/db2df39eb6fc09e516e22334dd990699755c0509/lib/appium_lib/common/element/text.rb#L24) +##### [e_s_texts](https://github.com/appium/ruby_lib/blob/4d88ecd87be7a2319dd0b7e437e230300269175f/lib/appium_lib/common/element/text.rb#L24) > def e_s_texts Get an array of text elements. @@ -33,11 +33,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Array<Text>] -- -##### [first_s_text](https://github.com/appium/ruby_lib/blob/db2df39eb6fc09e516e22334dd990699755c0509/lib/appium_lib/common/element/text.rb#L30) +##### [first_s_text](https://github.com/appium/ruby_lib/blob/4d88ecd87be7a2319dd0b7e437e230300269175f/lib/appium_lib/common/element/text.rb#L30) > def first_s_text Get the first text element. @@ -45,11 +45,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Text] -- -##### [last_s_text](https://github.com/appium/ruby_lib/blob/db2df39eb6fc09e516e22334dd990699755c0509/lib/appium_lib/common/element/text.rb#L36) +##### [last_s_text](https://github.com/appium/ruby_lib/blob/4d88ecd87be7a2319dd0b7e437e230300269175f/lib/appium_lib/common/element/text.rb#L36) > def last_s_text Get the last text element @@ -57,11 +57,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Text] -- -##### [s_text](https://github.com/appium/ruby_lib/blob/db2df39eb6fc09e516e22334dd990699755c0509/lib/appium_lib/common/element/text.rb#L43) +##### [s_text](https://github.com/appium/ruby_lib/blob/4d88ecd87be7a2319dd0b7e437e230300269175f/lib/appium_lib/common/element/text.rb#L43) > def s_text text Get the first element that includes text. @@ -73,11 +73,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Text] -- -##### [s_text_exact](https://github.com/appium/ruby_lib/blob/db2df39eb6fc09e516e22334dd990699755c0509/lib/appium_lib/common/element/text.rb#L51) +##### [s_text_exact](https://github.com/appium/ruby_lib/blob/4d88ecd87be7a2319dd0b7e437e230300269175f/lib/appium_lib/common/element/text.rb#L51) > def s_text_exact text Get the first textfield that matches text. @@ -89,11 +89,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Text] -- -##### [s_texts_exact](https://github.com/appium/ruby_lib/blob/db2df39eb6fc09e516e22334dd990699755c0509/lib/appium_lib/common/element/text.rb#L58) +##### [s_texts_exact](https://github.com/appium/ruby_lib/blob/4d88ecd87be7a2319dd0b7e437e230300269175f/lib/appium_lib/common/element/text.rb#L58) > def s_texts_exact text Get all static textfields that matches text. @@ -105,19 +105,19 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Array<Text>] -- -##### [window_size](https://github.com/appium/ruby_lib/blob/db2df39eb6fc09e516e22334dd990699755c0509/lib/appium_lib/common/element/window.rb#L5) +##### [window_size](https://github.com/appium/ruby_lib/blob/4d88ecd87be7a2319dd0b7e437e230300269175f/lib/appium_lib/common/element/window.rb#L5) > def window_size Get the window's size -- -##### [button](https://github.com/appium/ruby_lib/blob/db2df39eb6fc09e516e22334dd990699755c0509/lib/appium_lib/common/element/button.rb#L8) +##### [button](https://github.com/appium/ruby_lib/blob/4d88ecd87be7a2319dd0b7e437e230300269175f/lib/appium_lib/common/element/button.rb#L8) > def button text, number=0 Find a button by text and optionally number. @@ -131,11 +131,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Button] the button found with text and matching number -- -##### [buttons](https://github.com/appium/ruby_lib/blob/db2df39eb6fc09e516e22334dd990699755c0509/lib/appium_lib/common/element/button.rb#L19) +##### [buttons](https://github.com/appium/ruby_lib/blob/4d88ecd87be7a2319dd0b7e437e230300269175f/lib/appium_lib/common/element/button.rb#L19) > def buttons text=nil Get an array of button texts or button elements if text is provided. @@ -147,11 +147,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Array<String>, Array<Buttons>] either an array of button texts or an array of button elements if text is provided. -- -##### [first_button](https://github.com/appium/ruby_lib/blob/db2df39eb6fc09e516e22334dd990699755c0509/lib/appium_lib/common/element/button.rb#L26) +##### [first_button](https://github.com/appium/ruby_lib/blob/4d88ecd87be7a2319dd0b7e437e230300269175f/lib/appium_lib/common/element/button.rb#L26) > def first_button Get the first button element. @@ -159,11 +159,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Button] -- -##### [last_button](https://github.com/appium/ruby_lib/blob/db2df39eb6fc09e516e22334dd990699755c0509/lib/appium_lib/common/element/button.rb#L32) +##### [last_button](https://github.com/appium/ruby_lib/blob/4d88ecd87be7a2319dd0b7e437e230300269175f/lib/appium_lib/common/element/button.rb#L32) > def last_button Get the last button element. @@ -171,11 +171,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Button] -- -##### [button_exact](https://github.com/appium/ruby_lib/blob/db2df39eb6fc09e516e22334dd990699755c0509/lib/appium_lib/common/element/button.rb#L39) +##### [button_exact](https://github.com/appium/ruby_lib/blob/4d88ecd87be7a2319dd0b7e437e230300269175f/lib/appium_lib/common/element/button.rb#L39) > def button_exact text Get the first button element that exactly matches text. @@ -187,11 +187,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Button] -- -##### [buttons_exact](https://github.com/appium/ruby_lib/blob/db2df39eb6fc09e516e22334dd990699755c0509/lib/appium_lib/common/element/button.rb#L46) +##### [buttons_exact](https://github.com/appium/ruby_lib/blob/4d88ecd87be7a2319dd0b7e437e230300269175f/lib/appium_lib/common/element/button.rb#L46) > def buttons_exact text Get all button elements that exactly match text. @@ -203,11 +203,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Array<Button>] -- -##### [e_buttons](https://github.com/appium/ruby_lib/blob/db2df39eb6fc09e516e22334dd990699755c0509/lib/appium_lib/common/element/button.rb#L52) +##### [e_buttons](https://github.com/appium/ruby_lib/blob/4d88ecd87be7a2319dd0b7e437e230300269175f/lib/appium_lib/common/element/button.rb#L52) > def e_buttons Get an array of button elements. @@ -215,11 +215,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Array<Button>] -- -##### [button_num](https://github.com/appium/ruby_lib/blob/db2df39eb6fc09e516e22334dd990699755c0509/lib/appium_lib/common/element/button.rb#L72) +##### [button_num](https://github.com/appium/ruby_lib/blob/4d88ecd87be7a2319dd0b7e437e230300269175f/lib/appium_lib/common/element/button.rb#L72) > def button_num text, number=1 Expected to be called via button method. @@ -244,11 +244,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Button] the button that matches text and number -- -##### [tag_name_to_android](https://github.com/appium/ruby_lib/blob/db2df39eb6fc09e516e22334dd990699755c0509/lib/appium_lib/android/helper.rb#L6) android +##### [tag_name_to_android](https://github.com/appium/ruby_lib/blob/4d88ecd87be7a2319dd0b7e437e230300269175f/lib/appium_lib/android/helper.rb#L6) android > def tag_name_to_android tag_name Returns an array of android classes that match the tag name @@ -260,11 +260,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[String] -- -##### [find_eles_attr](https://github.com/appium/ruby_lib/blob/db2df39eb6fc09e516e22334dd990699755c0509/lib/appium_lib/android/helper.rb#L198) android +##### [find_eles_attr](https://github.com/appium/ruby_lib/blob/4d88ecd87be7a2319dd0b7e437e230300269175f/lib/appium_lib/android/helper.rb#L198) android > def find_eles_attr tag_name, attribute=nil Find all elements matching the attribute On android, assume the attr is name (which falls back to text). @@ -281,11 +281,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Element] -- -##### [get_selendroid_inspect](https://github.com/appium/ruby_lib/blob/db2df39eb6fc09e516e22334dd990699755c0509/lib/appium_lib/android/helper.rb#L220) android +##### [get_selendroid_inspect](https://github.com/appium/ruby_lib/blob/4d88ecd87be7a2319dd0b7e437e230300269175f/lib/appium_lib/android/helper.rb#L220) android > def get_selendroid_inspect Selendroid only. Returns a string containing interesting elements. @@ -294,28 +294,28 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[String] -- -##### [get_page_class](https://github.com/appium/ruby_lib/blob/db2df39eb6fc09e516e22334dd990699755c0509/lib/appium_lib/android/helper.rb#L282) android +##### [get_page_class](https://github.com/appium/ruby_lib/blob/4d88ecd87be7a2319dd0b7e437e230300269175f/lib/appium_lib/android/helper.rb#L282) android > def get_page_class -- -##### [page_class](https://github.com/appium/ruby_lib/blob/db2df39eb6fc09e516e22334dd990699755c0509/lib/appium_lib/android/helper.rb#L310) android +##### [page_class](https://github.com/appium/ruby_lib/blob/4d88ecd87be7a2319dd0b7e437e230300269175f/lib/appium_lib/android/helper.rb#L310) android > def page_class Count all classes on screen and print to stdout. Useful for appium_console. -- -##### [get_android_inspect](https://github.com/appium/ruby_lib/blob/db2df39eb6fc09e516e22334dd990699755c0509/lib/appium_lib/android/helper.rb#L319) android +##### [get_android_inspect](https://github.com/appium/ruby_lib/blob/4d88ecd87be7a2319dd0b7e437e230300269175f/lib/appium_lib/android/helper.rb#L319) android > def get_android_inspect Android only. Returns a string containing interesting elements. @@ -325,11 +325,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[String] -- -##### [get_inspect](https://github.com/appium/ruby_lib/blob/db2df39eb6fc09e516e22334dd990699755c0509/lib/appium_lib/android/helper.rb#L403) android +##### [get_inspect](https://github.com/appium/ruby_lib/blob/4d88ecd87be7a2319dd0b7e437e230300269175f/lib/appium_lib/android/helper.rb#L403) android > def get_inspect Automatically detects selendroid or android. Returns a string containing interesting elements. @@ -338,20 +338,20 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[String] -- -##### [page](https://github.com/appium/ruby_lib/blob/db2df39eb6fc09e516e22334dd990699755c0509/lib/appium_lib/android/helper.rb#L409) android +##### [page](https://github.com/appium/ruby_lib/blob/4d88ecd87be7a2319dd0b7e437e230300269175f/lib/appium_lib/android/helper.rb#L409) android > def page Intended for use with console. Inspects and prints the current page. -- -##### [fast_duration](https://github.com/appium/ruby_lib/blob/db2df39eb6fc09e516e22334dd990699755c0509/lib/appium_lib/android/helper.rb#L421) android +##### [fast_duration](https://github.com/appium/ruby_lib/blob/4d88ecd87be7a2319dd0b7e437e230300269175f/lib/appium_lib/android/helper.rb#L421) android > def fast_duration JavaScript code from https://github.com/appium/appium/blob/master/app/android.js @@ -361,20 +361,20 @@ We want steps to be exactly 1. If it's zero then a tap is used instead of a swipe. -- -##### [current_app](https://github.com/appium/ruby_lib/blob/db2df39eb6fc09e516e22334dd990699755c0509/lib/appium_lib/android/helper.rb#L427) android +##### [current_app](https://github.com/appium/ruby_lib/blob/4d88ecd87be7a2319dd0b7e437e230300269175f/lib/appium_lib/android/helper.rb#L427) android > def current_app Lists package, activity, and adb shell am start -n value for current app. Works on local host only (not remote). -- -##### [id](https://github.com/appium/ruby_lib/blob/db2df39eb6fc09e516e22334dd990699755c0509/lib/appium_lib/android/helper.rb#L441) android +##### [id](https://github.com/appium/ruby_lib/blob/4d88ecd87be7a2319dd0b7e437e230300269175f/lib/appium_lib/android/helper.rb#L441) android > def id id Find by id. Useful for selendroid @@ -386,11 +386,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Element] -- -##### [alert_click](https://github.com/appium/ruby_lib/blob/db2df39eb6fc09e516e22334dd990699755c0509/lib/appium_lib/android/element/alert.rb#L6) android +##### [alert_click](https://github.com/appium/ruby_lib/blob/4d88ecd87be7a2319dd0b7e437e230300269175f/lib/appium_lib/android/element/alert.rb#L6) android > def alert_click value Tap the alert button identified by value. @@ -402,11 +402,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[void] -- -##### [alert_accept](https://github.com/appium/ruby_lib/blob/db2df39eb6fc09e516e22334dd990699755c0509/lib/appium_lib/android/element/alert.rb#L13) android +##### [alert_accept](https://github.com/appium/ruby_lib/blob/4d88ecd87be7a2319dd0b7e437e230300269175f/lib/appium_lib/android/element/alert.rb#L13) android > def alert_accept Accept the alert. The last button is considered "accept." @@ -415,11 +415,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[void] -- -##### [alert_accept_text](https://github.com/appium/ruby_lib/blob/db2df39eb6fc09e516e22334dd990699755c0509/lib/appium_lib/android/element/alert.rb#L20) android +##### [alert_accept_text](https://github.com/appium/ruby_lib/blob/4d88ecd87be7a2319dd0b7e437e230300269175f/lib/appium_lib/android/element/alert.rb#L20) android > def alert_accept_text Get the text of the alert's accept button. The last button is considered "accept." @@ -428,11 +428,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[String] -- -##### [alert_dismiss](https://github.com/appium/ruby_lib/blob/db2df39eb6fc09e516e22334dd990699755c0509/lib/appium_lib/android/element/alert.rb#L27) android +##### [alert_dismiss](https://github.com/appium/ruby_lib/blob/4d88ecd87be7a2319dd0b7e437e230300269175f/lib/appium_lib/android/element/alert.rb#L27) android > def alert_dismiss Dismiss the alert. The first button is considered "dismiss." @@ -441,11 +441,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[void] -- -##### [alert_dismiss_text](https://github.com/appium/ruby_lib/blob/db2df39eb6fc09e516e22334dd990699755c0509/lib/appium_lib/android/element/alert.rb#L34) android +##### [alert_dismiss_text](https://github.com/appium/ruby_lib/blob/4d88ecd87be7a2319dd0b7e437e230300269175f/lib/appium_lib/android/element/alert.rb#L34) android > def alert_dismiss_text Get the text of the alert's dismiss button. The first button is considered "dismiss." @@ -454,11 +454,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[String] -- -##### [find](https://github.com/appium/ruby_lib/blob/db2df39eb6fc09e516e22334dd990699755c0509/lib/appium_lib/android/element/generic.rb#L44) android +##### [find](https://github.com/appium/ruby_lib/blob/4d88ecd87be7a2319dd0b7e437e230300269175f/lib/appium_lib/android/element/generic.rb#L44) android > def find val Find the value contained in content description or text. Search elements in this order: EditText, Button, ImageButton @@ -471,11 +471,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Element] -- -##### [text](https://github.com/appium/ruby_lib/blob/db2df39eb6fc09e516e22334dd990699755c0509/lib/appium_lib/android/element/generic.rb#L70) android +##### [text](https://github.com/appium/ruby_lib/blob/4d88ecd87be7a2319dd0b7e437e230300269175f/lib/appium_lib/android/element/generic.rb#L70) android > def text text Return the first element matching text. @@ -487,11 +487,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Element] the first matching element -- -##### [texts](https://github.com/appium/ruby_lib/blob/db2df39eb6fc09e516e22334dd990699755c0509/lib/appium_lib/android/element/generic.rb#L79) android +##### [texts](https://github.com/appium/ruby_lib/blob/4d88ecd87be7a2319dd0b7e437e230300269175f/lib/appium_lib/android/element/generic.rb#L79) android > def texts text Return all elements matching text. @@ -503,11 +503,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Array<Element>] all matching elements -- -##### [name](https://github.com/appium/ruby_lib/blob/db2df39eb6fc09e516e22334dd990699755c0509/lib/appium_lib/android/element/generic.rb#L88) android +##### [name](https://github.com/appium/ruby_lib/blob/4d88ecd87be7a2319dd0b7e437e230300269175f/lib/appium_lib/android/element/generic.rb#L88) android > def name name Return the first element matching name. on Android name is content description @@ -521,11 +521,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Element] the first matching element -- -##### [name_exact](https://github.com/appium/ruby_lib/blob/db2df39eb6fc09e516e22334dd990699755c0509/lib/appium_lib/android/element/generic.rb#L99) android +##### [name_exact](https://github.com/appium/ruby_lib/blob/4d88ecd87be7a2319dd0b7e437e230300269175f/lib/appium_lib/android/element/generic.rb#L99) android > def name_exact name Return the first element exactly matching name. on Android name is content description @@ -539,11 +539,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Element] the first matching element -- -##### [names](https://github.com/appium/ruby_lib/blob/db2df39eb6fc09e516e22334dd990699755c0509/lib/appium_lib/android/element/generic.rb#L117) android +##### [names](https://github.com/appium/ruby_lib/blob/4d88ecd87be7a2319dd0b7e437e230300269175f/lib/appium_lib/android/element/generic.rb#L117) android > def names name='' Return all elements matching name. on Android name is content description @@ -557,11 +557,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Array<Element>] all matching elements -- -##### [scroll_to](https://github.com/appium/ruby_lib/blob/db2df39eb6fc09e516e22334dd990699755c0509/lib/appium_lib/android/element/generic.rb#L131) android +##### [scroll_to](https://github.com/appium/ruby_lib/blob/4d88ecd87be7a2319dd0b7e437e230300269175f/lib/appium_lib/android/element/generic.rb#L131) android > def scroll_to text Scroll to an element containing target text or description. @@ -573,11 +573,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Element] the element scrolled to -- -##### [scroll_to_exact](https://github.com/appium/ruby_lib/blob/db2df39eb6fc09e516e22334dd990699755c0509/lib/appium_lib/android/element/generic.rb#L144) android +##### [scroll_to_exact](https://github.com/appium/ruby_lib/blob/4d88ecd87be7a2319dd0b7e437e230300269175f/lib/appium_lib/android/element/generic.rb#L144) android > def scroll_to_exact text Scroll to an element with the exact target text or description. @@ -589,11 +589,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Element] the element scrolled to -- -##### [textfields](https://github.com/appium/ruby_lib/blob/db2df39eb6fc09e516e22334dd990699755c0509/lib/appium_lib/android/element/textfield.rb#L7) android +##### [textfields](https://github.com/appium/ruby_lib/blob/4d88ecd87be7a2319dd0b7e437e230300269175f/lib/appium_lib/android/element/textfield.rb#L7) android > def textfields Get an array of textfield texts. @@ -601,11 +601,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Array<String>] -- -##### [e_textfields](https://github.com/appium/ruby_lib/blob/db2df39eb6fc09e516e22334dd990699755c0509/lib/appium_lib/android/element/textfield.rb#L13) android +##### [e_textfields](https://github.com/appium/ruby_lib/blob/4d88ecd87be7a2319dd0b7e437e230300269175f/lib/appium_lib/android/element/textfield.rb#L13) android > def e_textfields Get an array of textfield elements. @@ -613,11 +613,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Array<Textfield>] -- -##### [first_textfield](https://github.com/appium/ruby_lib/blob/db2df39eb6fc09e516e22334dd990699755c0509/lib/appium_lib/android/element/textfield.rb#L19) android +##### [first_textfield](https://github.com/appium/ruby_lib/blob/4d88ecd87be7a2319dd0b7e437e230300269175f/lib/appium_lib/android/element/textfield.rb#L19) android > def first_textfield Get the first textfield element. @@ -625,11 +625,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Textfield] -- -##### [last_textfield](https://github.com/appium/ruby_lib/blob/db2df39eb6fc09e516e22334dd990699755c0509/lib/appium_lib/android/element/textfield.rb#L25) android +##### [last_textfield](https://github.com/appium/ruby_lib/blob/4d88ecd87be7a2319dd0b7e437e230300269175f/lib/appium_lib/android/element/textfield.rb#L25) android > def last_textfield Get the last textfield element. @@ -637,11 +637,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Textfield] -- -##### [textfield](https://github.com/appium/ruby_lib/blob/db2df39eb6fc09e516e22334dd990699755c0509/lib/appium_lib/android/element/textfield.rb#L32) android +##### [textfield](https://github.com/appium/ruby_lib/blob/4d88ecd87be7a2319dd0b7e437e230300269175f/lib/appium_lib/android/element/textfield.rb#L32) android > def textfield text Get the first textfield that includes text or name (content description). @@ -653,11 +653,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Textfield] -- -##### [textfield_exact](https://github.com/appium/ruby_lib/blob/db2df39eb6fc09e516e22334dd990699755c0509/lib/appium_lib/android/element/textfield.rb#L45) android +##### [textfield_exact](https://github.com/appium/ruby_lib/blob/4d88ecd87be7a2319dd0b7e437e230300269175f/lib/appium_lib/android/element/textfield.rb#L45) android > def textfield_exact text Get the first textfield that matches text. @@ -669,11 +669,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Textfield] -- -##### [wait](https://github.com/appium/ruby_lib/blob/db2df39eb6fc09e516e22334dd990699755c0509/lib/appium_lib/common/helper.rb#L33) +##### [wait](https://github.com/appium/ruby_lib/blob/4d88ecd87be7a2319dd0b7e437e230300269175f/lib/appium_lib/common/helper.rb#L33) > def wait max_wait=30, interval=0.5, &block Check every 0.5 seconds to see if block.call doesn't raise an exception. if .call raises an exception then it will be tried again. @@ -696,19 +696,19 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Object] the result of block.call -- -##### [ignore](https://github.com/appium/ruby_lib/blob/db2df39eb6fc09e516e22334dd990699755c0509/lib/appium_lib/common/helper.rb#L45) +##### [ignore](https://github.com/appium/ruby_lib/blob/4d88ecd87be7a2319dd0b7e437e230300269175f/lib/appium_lib/common/helper.rb#L45) > def ignore &block Return block.call and ignore any exceptions. -- -##### [wait_true](https://github.com/appium/ruby_lib/blob/db2df39eb6fc09e516e22334dd990699755c0509/lib/appium_lib/common/helper.rb#L55) +##### [wait_true](https://github.com/appium/ruby_lib/blob/4d88ecd87be7a2319dd0b7e437e230300269175f/lib/appium_lib/common/helper.rb#L55) > def wait_true max_wait=30, interval=0.5, &block Check every 0.5 seconds to see if block.call returns true. nil is considered a failure. Give up after 30 seconds. @@ -725,11 +725,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Object] the result of block.call -- -##### [back](https://github.com/appium/ruby_lib/blob/db2df39eb6fc09e516e22334dd990699755c0509/lib/appium_lib/common/helper.rb#L68) +##### [back](https://github.com/appium/ruby_lib/blob/4d88ecd87be7a2319dd0b7e437e230300269175f/lib/appium_lib/common/helper.rb#L68) > def back Navigate back. @@ -737,19 +737,19 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[void] -- -##### [session_id](https://github.com/appium/ruby_lib/blob/db2df39eb6fc09e516e22334dd990699755c0509/lib/appium_lib/common/helper.rb#L73) +##### [session_id](https://github.com/appium/ruby_lib/blob/4d88ecd87be7a2319dd0b7e437e230300269175f/lib/appium_lib/common/helper.rb#L73) > def session_id For Sauce Labs reporting. Returns the current session id. -- -##### [xpath](https://github.com/appium/ruby_lib/blob/db2df39eb6fc09e516e22334dd990699755c0509/lib/appium_lib/common/helper.rb#L81) +##### [xpath](https://github.com/appium/ruby_lib/blob/4d88ecd87be7a2319dd0b7e437e230300269175f/lib/appium_lib/common/helper.rb#L81) > def xpath xpath_str Returns the first element that matches the provided xpath. @@ -761,11 +761,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Element] -- -##### [xpaths](https://github.com/appium/ruby_lib/blob/db2df39eb6fc09e516e22334dd990699755c0509/lib/appium_lib/common/helper.rb#L89) +##### [xpaths](https://github.com/appium/ruby_lib/blob/4d88ecd87be7a2319dd0b7e437e230300269175f/lib/appium_lib/common/helper.rb#L89) > def xpaths xpath_str Returns all elements that match the provided xpath. @@ -777,11 +777,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Array<Element>] -- -##### [ele_index](https://github.com/appium/ruby_lib/blob/db2df39eb6fc09e516e22334dd990699755c0509/lib/appium_lib/common/helper.rb#L97) +##### [ele_index](https://github.com/appium/ruby_lib/blob/4d88ecd87be7a2319dd0b7e437e230300269175f/lib/appium_lib/common/helper.rb#L97) > def ele_index tag_name, index Get the element of type tag_name at matching index. @@ -795,11 +795,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Element] the found element of type tag_name -- -##### [find_eles](https://github.com/appium/ruby_lib/blob/db2df39eb6fc09e516e22334dd990699755c0509/lib/appium_lib/common/helper.rb#L106) +##### [find_eles](https://github.com/appium/ruby_lib/blob/4d88ecd87be7a2319dd0b7e437e230300269175f/lib/appium_lib/common/helper.rb#L106) > def find_eles tag_name Get all elements exactly matching tag name @@ -811,11 +811,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Array<Element>] the found elements of type tag_name -- -##### [find_ele_by_text](https://github.com/appium/ruby_lib/blob/db2df39eb6fc09e516e22334dd990699755c0509/lib/appium_lib/common/helper.rb#L114) +##### [find_ele_by_text](https://github.com/appium/ruby_lib/blob/4d88ecd87be7a2319dd0b7e437e230300269175f/lib/appium_lib/common/helper.rb#L114) > def find_ele_by_text tag, text Get the first tag that exactly matches tag and text. @@ -829,11 +829,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Element] the element of type tag exactly matching text -- -##### [find_eles_by_text](https://github.com/appium/ruby_lib/blob/db2df39eb6fc09e516e22334dd990699755c0509/lib/appium_lib/common/helper.rb#L122) +##### [find_eles_by_text](https://github.com/appium/ruby_lib/blob/4d88ecd87be7a2319dd0b7e437e230300269175f/lib/appium_lib/common/helper.rb#L122) > def find_eles_by_text tag, text Get all tags that exactly match tag and text. @@ -847,11 +847,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Array<Element>] the elements of type tag exactly matching text -- -##### [find_ele_by_attr_include](https://github.com/appium/ruby_lib/blob/db2df39eb6fc09e516e22334dd990699755c0509/lib/appium_lib/common/helper.rb#L131) +##### [find_ele_by_attr_include](https://github.com/appium/ruby_lib/blob/4d88ecd87be7a2319dd0b7e437e230300269175f/lib/appium_lib/common/helper.rb#L131) > def find_ele_by_attr_include tag, attr, value Get the first tag by attribute that exactly matches value. @@ -867,11 +867,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/db2df39eb6fc09e516e22334dd990699755c0509/lib/appium_lib/common/helper.rb#L140) +##### [find_eles_by_attr_include](https://github.com/appium/ruby_lib/blob/4d88ecd87be7a2319dd0b7e437e230300269175f/lib/appium_lib/common/helper.rb#L140) > def find_eles_by_attr_include tag, attr, value Get tags by attribute that include value. @@ -887,11 +887,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Array<Element>] the elements of type tag who's attribute includes value -- -##### [find_ele_by_text_include](https://github.com/appium/ruby_lib/blob/db2df39eb6fc09e516e22334dd990699755c0509/lib/appium_lib/common/helper.rb#L149) +##### [find_ele_by_text_include](https://github.com/appium/ruby_lib/blob/4d88ecd87be7a2319dd0b7e437e230300269175f/lib/appium_lib/common/helper.rb#L149) > def find_ele_by_text_include tag, text Get the first tag that includes text. element.attribute(:text).include? text @@ -906,11 +906,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Element] the element of type tag that includes text -- -##### [find_eles_by_text_include](https://github.com/appium/ruby_lib/blob/db2df39eb6fc09e516e22334dd990699755c0509/lib/appium_lib/common/helper.rb#L158) +##### [find_eles_by_text_include](https://github.com/appium/ruby_lib/blob/4d88ecd87be7a2319dd0b7e437e230300269175f/lib/appium_lib/common/helper.rb#L158) > def find_eles_by_text_include tag, text Get the tags that include text. element.attribute(:text).include? text @@ -925,11 +925,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Array<Element>] the elements of type tag that includes text -- -##### [first_ele](https://github.com/appium/ruby_lib/blob/db2df39eb6fc09e516e22334dd990699755c0509/lib/appium_lib/common/helper.rb#L165) +##### [first_ele](https://github.com/appium/ruby_lib/blob/4d88ecd87be7a2319dd0b7e437e230300269175f/lib/appium_lib/common/helper.rb#L165) > def first_ele tag_name Get the first tag that matches tag_name @@ -941,11 +941,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Element] -- -##### [last_ele](https://github.com/appium/ruby_lib/blob/db2df39eb6fc09e516e22334dd990699755c0509/lib/appium_lib/common/helper.rb#L173) +##### [last_ele](https://github.com/appium/ruby_lib/blob/4d88ecd87be7a2319dd0b7e437e230300269175f/lib/appium_lib/common/helper.rb#L173) > def last_ele tag_name Get the last tag that matches tag_name @@ -957,11 +957,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Element] -- -##### [source](https://github.com/appium/ruby_lib/blob/db2df39eb6fc09e516e22334dd990699755c0509/lib/appium_lib/common/helper.rb#L179) +##### [source](https://github.com/appium/ruby_lib/blob/4d88ecd87be7a2319dd0b7e437e230300269175f/lib/appium_lib/common/helper.rb#L179) > def source Prints a JSON view of the current page @@ -969,11 +969,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[void] -- -##### [get_source](https://github.com/appium/ruby_lib/blob/db2df39eb6fc09e516e22334dd990699755c0509/lib/appium_lib/common/helper.rb#L185) +##### [get_source](https://github.com/appium/ruby_lib/blob/4d88ecd87be7a2319dd0b7e437e230300269175f/lib/appium_lib/common/helper.rb#L185) > def get_source Gets a JSON view of the current page @@ -981,11 +981,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[JSON] -- -##### [find_name](https://github.com/appium/ruby_lib/blob/db2df39eb6fc09e516e22334dd990699755c0509/lib/appium_lib/common/helper.rb#L194) +##### [find_name](https://github.com/appium/ruby_lib/blob/4d88ecd87be7a2319dd0b7e437e230300269175f/lib/appium_lib/common/helper.rb#L194) > def find_name name Returns the first element that exactly matches name @@ -997,11 +997,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Element] -- -##### [find_names](https://github.com/appium/ruby_lib/blob/db2df39eb6fc09e516e22334dd990699755c0509/lib/appium_lib/common/helper.rb#L202) +##### [find_names](https://github.com/appium/ruby_lib/blob/4d88ecd87be7a2319dd0b7e437e230300269175f/lib/appium_lib/common/helper.rb#L202) > def find_names name Returns all elements that exactly match name @@ -1013,11 +1013,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Array<Element>] -- -##### [tag](https://github.com/appium/ruby_lib/blob/db2df39eb6fc09e516e22334dd990699755c0509/lib/appium_lib/common/helper.rb#L210) +##### [tag](https://github.com/appium/ruby_lib/blob/4d88ecd87be7a2319dd0b7e437e230300269175f/lib/appium_lib/common/helper.rb#L210) > def tag tag_name Returns the first element matching tag_name @@ -1029,11 +1029,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Element] -- -##### [tags](https://github.com/appium/ruby_lib/blob/db2df39eb6fc09e516e22334dd990699755c0509/lib/appium_lib/common/helper.rb#L218) +##### [tags](https://github.com/appium/ruby_lib/blob/4d88ecd87be7a2319dd0b7e437e230300269175f/lib/appium_lib/common/helper.rb#L218) > def tags tag_name Returns all elements matching tag_name @@ -1045,11 +1045,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Element] -- -##### [px_to_window_rel](https://github.com/appium/ruby_lib/blob/db2df39eb6fc09e516e22334dd990699755c0509/lib/appium_lib/common/helper.rb#L228) +##### [px_to_window_rel](https://github.com/appium/ruby_lib/blob/4d88ecd87be7a2319dd0b7e437e230300269175f/lib/appium_lib/common/helper.rb#L228) > def px_to_window_rel opts={} Converts pixel values to window relative values @@ -1057,19 +1057,19 @@ px_to_window_rel x: 50, y: 150 ``` -- -##### [lazy_load_strings](https://github.com/appium/ruby_lib/blob/db2df39eb6fc09e516e22334dd990699755c0509/lib/appium_lib/common/helper.rb#L238) +##### [lazy_load_strings](https://github.com/appium/ruby_lib/blob/4d88ecd87be7a2319dd0b7e437e230300269175f/lib/appium_lib/common/helper.rb#L238) > def lazy_load_strings -- -##### [xml_keys](https://github.com/appium/ruby_lib/blob/db2df39eb6fc09e516e22334dd990699755c0509/lib/appium_lib/common/helper.rb#L245) +##### [xml_keys](https://github.com/appium/ruby_lib/blob/4d88ecd87be7a2319dd0b7e437e230300269175f/lib/appium_lib/common/helper.rb#L245) > def xml_keys target Search strings.xml's values for target. @@ -1081,11 +1081,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Array] -- -##### [xml_values](https://github.com/appium/ruby_lib/blob/db2df39eb6fc09e516e22334dd990699755c0509/lib/appium_lib/common/helper.rb#L253) +##### [xml_values](https://github.com/appium/ruby_lib/blob/4d88ecd87be7a2319dd0b7e437e230300269175f/lib/appium_lib/common/helper.rb#L253) > def xml_values target Search strings.xml's keys for target. @@ -1097,11 +1097,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Array] -- -##### [resolve_id](https://github.com/appium/ruby_lib/blob/db2df39eb6fc09e516e22334dd990699755c0509/lib/appium_lib/common/helper.rb#L261) +##### [resolve_id](https://github.com/appium/ruby_lib/blob/4d88ecd87be7a2319dd0b7e437e230300269175f/lib/appium_lib/common/helper.rb#L261) > def resolve_id id Resolve id in strings.xml and return the value. @@ -1113,39 +1113,39 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[String] -- -##### [raise_no_element_error](https://github.com/appium/ruby_lib/blob/db2df39eb6fc09e516e22334dd990699755c0509/lib/appium_lib/common/helper.rb#L267) +##### [raise_no_element_error](https://github.com/appium/ruby_lib/blob/4d88ecd87be7a2319dd0b7e437e230300269175f/lib/appium_lib/common/helper.rb#L267) > def raise_no_element_error Used to error when finding a single element fails. -- -##### [value](https://github.com/appium/ruby_lib/blob/db2df39eb6fc09e516e22334dd990699755c0509/lib/appium_lib/common/patch.rb#L32) +##### [value](https://github.com/appium/ruby_lib/blob/4d88ecd87be7a2319dd0b7e437e230300269175f/lib/appium_lib/common/patch.rb#L32) > def value Returns the value attribute Fixes NoMethodError: undefined method `value' for Selenium::WebDriver::Element -- -##### [name](https://github.com/appium/ruby_lib/blob/db2df39eb6fc09e516e22334dd990699755c0509/lib/appium_lib/common/patch.rb#L39) +##### [name](https://github.com/appium/ruby_lib/blob/4d88ecd87be7a2319dd0b7e437e230300269175f/lib/appium_lib/common/patch.rb#L39) > def name Returns the name attribute Fixes NoMethodError: undefined method `name' for Selenium::WebDriver::Element -- -##### [location_rel](https://github.com/appium/ruby_lib/blob/db2df39eb6fc09e516e22334dd990699755c0509/lib/appium_lib/common/patch.rb#L51) +##### [location_rel](https://github.com/appium/ruby_lib/blob/4d88ecd87be7a2319dd0b7e437e230300269175f/lib/appium_lib/common/patch.rb#L51) > def location_rel For use with mobile tap. @@ -1159,27 +1159,27 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[OpenStruct] the relative x, y in a struct. ex: { x: 0.50, y: 0.20 } -- -##### [CORE](https://github.com/appium/ruby_lib/blob/db2df39eb6fc09e516e22334dd990699755c0509/lib/appium_lib/driver.rb#L16) +##### [CORE](https://github.com/appium/ruby_lib/blob/4d88ecd87be7a2319dd0b7e437e230300269175f/lib/appium_lib/driver.rb#L16) > CORE = [ :array, :hash, :class, :file, :dir, :bigdecimal, :rational, :struct, :openstruct, :method, :unboundmethod ] -- -##### [awesome_openstruct](https://github.com/appium/ruby_lib/blob/db2df39eb6fc09e516e22334dd990699755c0509/lib/appium_lib/driver.rb#L18) +##### [awesome_openstruct](https://github.com/appium/ruby_lib/blob/4d88ecd87be7a2319dd0b7e437e230300269175f/lib/appium_lib/driver.rb#L18) > def awesome_openstruct target -- -##### [load_appium_txt](https://github.com/appium/ruby_lib/blob/db2df39eb6fc09e516e22334dd990699755c0509/lib/appium_lib/driver.rb#L27) +##### [load_appium_txt](https://github.com/appium/ruby_lib/blob/4d88ecd87be7a2319dd0b7e437e230300269175f/lib/appium_lib/driver.rb#L27) > def load_appium_txt opts Load appium.txt (toml format) into system ENV the basedir of this file + appium.txt is what's used @@ -1192,19 +1192,19 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Array<String>] the require files. nil if require doesn't exist -- -##### [promote_singleton_appium_methods](https://github.com/appium/ruby_lib/blob/db2df39eb6fc09e516e22334dd990699755c0509/lib/appium_lib/driver.rb#L152) +##### [promote_singleton_appium_methods](https://github.com/appium/ruby_lib/blob/4d88ecd87be7a2319dd0b7e437e230300269175f/lib/appium_lib/driver.rb#L152) > def self.promote_singleton_appium_methods main_module -- -##### [promote_appium_methods](https://github.com/appium/ruby_lib/blob/db2df39eb6fc09e516e22334dd990699755c0509/lib/appium_lib/driver.rb#L182) +##### [promote_appium_methods](https://github.com/appium/ruby_lib/blob/4d88ecd87be7a2319dd0b7e437e230300269175f/lib/appium_lib/driver.rb#L182) > def self.promote_appium_methods class_array Promote appium methods to class instance methods @@ -1218,11 +1218,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Array<Class>] class_array - An array of classes -- -##### [default_wait](https://github.com/appium/ruby_lib/blob/db2df39eb6fc09e516e22334dd990699755c0509/lib/appium_lib/driver.rb#L564) +##### [default_wait](https://github.com/appium/ruby_lib/blob/4d88ecd87be7a2319dd0b7e437e230300269175f/lib/appium_lib/driver.rb#L565) > def default_wait Returns the default client side wait. This value is independent of what the server is using @@ -1231,139 +1231,139 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Integer] -- -##### [app_path](https://github.com/appium/ruby_lib/blob/db2df39eb6fc09e516e22334dd990699755c0509/lib/appium_lib/driver.rb#L211) +##### [app_path](https://github.com/appium/ruby_lib/blob/4d88ecd87be7a2319dd0b7e437e230300269175f/lib/appium_lib/driver.rb#L211) > def app_path Returns the value of attribute app_path -- -##### [app_name](https://github.com/appium/ruby_lib/blob/db2df39eb6fc09e516e22334dd990699755c0509/lib/appium_lib/driver.rb#L211) +##### [app_name](https://github.com/appium/ruby_lib/blob/4d88ecd87be7a2319dd0b7e437e230300269175f/lib/appium_lib/driver.rb#L211) > def app_name Returns the value of attribute app_name -- -##### [device](https://github.com/appium/ruby_lib/blob/db2df39eb6fc09e516e22334dd990699755c0509/lib/appium_lib/driver.rb#L211) +##### [device](https://github.com/appium/ruby_lib/blob/4d88ecd87be7a2319dd0b7e437e230300269175f/lib/appium_lib/driver.rb#L211) > def device Returns the value of attribute device -- -##### [app_package](https://github.com/appium/ruby_lib/blob/db2df39eb6fc09e516e22334dd990699755c0509/lib/appium_lib/driver.rb#L211) +##### [app_package](https://github.com/appium/ruby_lib/blob/4d88ecd87be7a2319dd0b7e437e230300269175f/lib/appium_lib/driver.rb#L211) > def app_package Returns the value of attribute app_package -- -##### [app_activity](https://github.com/appium/ruby_lib/blob/db2df39eb6fc09e516e22334dd990699755c0509/lib/appium_lib/driver.rb#L211) +##### [app_activity](https://github.com/appium/ruby_lib/blob/4d88ecd87be7a2319dd0b7e437e230300269175f/lib/appium_lib/driver.rb#L211) > def app_activity Returns the value of attribute app_activity -- -##### [app_wait_activity](https://github.com/appium/ruby_lib/blob/db2df39eb6fc09e516e22334dd990699755c0509/lib/appium_lib/driver.rb#L211) +##### [app_wait_activity](https://github.com/appium/ruby_lib/blob/4d88ecd87be7a2319dd0b7e437e230300269175f/lib/appium_lib/driver.rb#L211) > def app_wait_activity Returns the value of attribute app_wait_activity -- -##### [sauce_username](https://github.com/appium/ruby_lib/blob/db2df39eb6fc09e516e22334dd990699755c0509/lib/appium_lib/driver.rb#L211) +##### [sauce_username](https://github.com/appium/ruby_lib/blob/4d88ecd87be7a2319dd0b7e437e230300269175f/lib/appium_lib/driver.rb#L211) > def sauce_username Returns the value of attribute sauce_username -- -##### [sauce_access_key](https://github.com/appium/ruby_lib/blob/db2df39eb6fc09e516e22334dd990699755c0509/lib/appium_lib/driver.rb#L211) +##### [sauce_access_key](https://github.com/appium/ruby_lib/blob/4d88ecd87be7a2319dd0b7e437e230300269175f/lib/appium_lib/driver.rb#L211) > def sauce_access_key Returns the value of attribute sauce_access_key -- -##### [port](https://github.com/appium/ruby_lib/blob/db2df39eb6fc09e516e22334dd990699755c0509/lib/appium_lib/driver.rb#L211) +##### [port](https://github.com/appium/ruby_lib/blob/4d88ecd87be7a2319dd0b7e437e230300269175f/lib/appium_lib/driver.rb#L211) > def port Returns the value of attribute port -- -##### [debug](https://github.com/appium/ruby_lib/blob/db2df39eb6fc09e516e22334dd990699755c0509/lib/appium_lib/driver.rb#L211) +##### [debug](https://github.com/appium/ruby_lib/blob/4d88ecd87be7a2319dd0b7e437e230300269175f/lib/appium_lib/driver.rb#L211) > def debug Returns the value of attribute debug -- -##### [export_session](https://github.com/appium/ruby_lib/blob/db2df39eb6fc09e516e22334dd990699755c0509/lib/appium_lib/driver.rb#L211) +##### [export_session](https://github.com/appium/ruby_lib/blob/4d88ecd87be7a2319dd0b7e437e230300269175f/lib/appium_lib/driver.rb#L211) > def export_session Returns the value of attribute export_session -- -##### [device_cap](https://github.com/appium/ruby_lib/blob/db2df39eb6fc09e516e22334dd990699755c0509/lib/appium_lib/driver.rb#L211) +##### [device_cap](https://github.com/appium/ruby_lib/blob/4d88ecd87be7a2319dd0b7e437e230300269175f/lib/appium_lib/driver.rb#L211) > def device_cap Returns the value of attribute device_cap -- -##### [compress_xml](https://github.com/appium/ruby_lib/blob/db2df39eb6fc09e516e22334dd990699755c0509/lib/appium_lib/driver.rb#L211) +##### [compress_xml](https://github.com/appium/ruby_lib/blob/4d88ecd87be7a2319dd0b7e437e230300269175f/lib/appium_lib/driver.rb#L211) > def compress_xml Returns the value of attribute compress_xml -- -##### [custom_url](https://github.com/appium/ruby_lib/blob/db2df39eb6fc09e516e22334dd990699755c0509/lib/appium_lib/driver.rb#L211) +##### [custom_url](https://github.com/appium/ruby_lib/blob/4d88ecd87be7a2319dd0b7e437e230300269175f/lib/appium_lib/driver.rb#L211) > def custom_url Returns the value of attribute custom_url -- -##### [global_webdriver_http_sleep](https://github.com/appium/ruby_lib/blob/db2df39eb6fc09e516e22334dd990699755c0509/lib/appium_lib/driver.rb#L217) +##### [global_webdriver_http_sleep](https://github.com/appium/ruby_lib/blob/4d88ecd87be7a2319dd0b7e437e230300269175f/lib/appium_lib/driver.rb#L217) > 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/db2df39eb6fc09e516e22334dd990699755c0509/lib/appium_lib/driver.rb#L217) +##### [global_webdriver_http_sleep=](https://github.com/appium/ruby_lib/blob/4d88ecd87be7a2319dd0b7e437e230300269175f/lib/appium_lib/driver.rb#L217) > def global_webdriver_http_sleep=(value) The amount to sleep in seconds before every webdriver http call. -- -##### [initialize](https://github.com/appium/ruby_lib/blob/db2df39eb6fc09e516e22334dd990699755c0509/lib/appium_lib/driver.rb#L247) +##### [initialize](https://github.com/appium/ruby_lib/blob/4d88ecd87be7a2319dd0b7e437e230300269175f/lib/appium_lib/driver.rb#L247) > def initialize opts={} Creates a new driver. :device is :android, :ios, or :selendroid @@ -1400,11 +1400,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Driver] -- -##### [status](https://github.com/appium/ruby_lib/blob/db2df39eb6fc09e516e22334dd990699755c0509/lib/appium_lib/driver.rb#L376) +##### [status](https://github.com/appium/ruby_lib/blob/4d88ecd87be7a2319dd0b7e437e230300269175f/lib/appium_lib/driver.rb#L378) > def status Returns the status payload @@ -1426,11 +1426,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[JSON] -- -##### [server_version](https://github.com/appium/ruby_lib/blob/db2df39eb6fc09e516e22334dd990699755c0509/lib/appium_lib/driver.rb#L382) +##### [server_version](https://github.com/appium/ruby_lib/blob/4d88ecd87be7a2319dd0b7e437e230300269175f/lib/appium_lib/driver.rb#L384) > def server_version Returns the server's version string @@ -1438,11 +1438,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[String] -- -##### [absolute_app_path](https://github.com/appium/ruby_lib/blob/db2df39eb6fc09e516e22334dd990699755c0509/lib/appium_lib/driver.rb#L426) +##### [absolute_app_path](https://github.com/appium/ruby_lib/blob/4d88ecd87be7a2319dd0b7e437e230300269175f/lib/appium_lib/driver.rb#L427) > def self.absolute_app_path app_path Converts environment variable APP_PATH to an absolute path. @@ -1450,11 +1450,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[String] APP_PATH as an absolute path -- -##### [server_url](https://github.com/appium/ruby_lib/blob/db2df39eb6fc09e516e22334dd990699755c0509/lib/appium_lib/driver.rb#L450) +##### [server_url](https://github.com/appium/ruby_lib/blob/4d88ecd87be7a2319dd0b7e437e230300269175f/lib/appium_lib/driver.rb#L451) > def server_url Get the server url for sauce or local based on env vars. @@ -1462,11 +1462,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[String] the server url -- -##### [restart](https://github.com/appium/ruby_lib/blob/db2df39eb6fc09e516e22334dd990699755c0509/lib/appium_lib/driver.rb#L461) +##### [restart](https://github.com/appium/ruby_lib/blob/4d88ecd87be7a2319dd0b7e437e230300269175f/lib/appium_lib/driver.rb#L462) > def restart Restarts the driver @@ -1474,11 +1474,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Driver] the driver -- -##### [driver](https://github.com/appium/ruby_lib/blob/db2df39eb6fc09e516e22334dd990699755c0509/lib/appium_lib/driver.rb#L468) +##### [driver](https://github.com/appium/ruby_lib/blob/4d88ecd87be7a2319dd0b7e437e230300269175f/lib/appium_lib/driver.rb#L469) > def driver Returns the driver @@ -1486,11 +1486,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Driver] the driver -- -##### [screenshot](https://github.com/appium/ruby_lib/blob/db2df39eb6fc09e516e22334dd990699755c0509/lib/appium_lib/driver.rb#L478) +##### [screenshot](https://github.com/appium/ruby_lib/blob/4d88ecd87be7a2319dd0b7e437e230300269175f/lib/appium_lib/driver.rb#L479) > def screenshot png_save_path Takes a png screenshot and saves to the target path. @@ -1504,11 +1504,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[nil] -- -##### [driver_quit](https://github.com/appium/ruby_lib/blob/db2df39eb6fc09e516e22334dd990699755c0509/lib/appium_lib/driver.rb#L485) +##### [driver_quit](https://github.com/appium/ruby_lib/blob/4d88ecd87be7a2319dd0b7e437e230300269175f/lib/appium_lib/driver.rb#L486) > def driver_quit Quits the driver @@ -1516,11 +1516,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[void] -- -##### [start_driver](https://github.com/appium/ruby_lib/blob/db2df39eb6fc09e516e22334dd990699755c0509/lib/appium_lib/driver.rb#L493) +##### [start_driver](https://github.com/appium/ruby_lib/blob/4d88ecd87be7a2319dd0b7e437e230300269175f/lib/appium_lib/driver.rb#L494) > def start_driver Creates a new global driver and quits the old one if it exists. @@ -1528,19 +1528,19 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Selenium::WebDriver] the new global driver -- -##### [no_wait](https://github.com/appium/ruby_lib/blob/db2df39eb6fc09e516e22334dd990699755c0509/lib/appium_lib/driver.rb#L527) +##### [no_wait](https://github.com/appium/ruby_lib/blob/4d88ecd87be7a2319dd0b7e437e230300269175f/lib/appium_lib/driver.rb#L528) > def no_wait Set implicit wait and default_wait to zero. -- -##### [set_wait](https://github.com/appium/ruby_lib/blob/db2df39eb6fc09e516e22334dd990699755c0509/lib/appium_lib/driver.rb#L546) +##### [set_wait](https://github.com/appium/ruby_lib/blob/4d88ecd87be7a2319dd0b7e437e230300269175f/lib/appium_lib/driver.rb#L547) > 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 @@ -1561,11 +1561,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[void] -- -##### [exists](https://github.com/appium/ruby_lib/blob/db2df39eb6fc09e516e22334dd990699755c0509/lib/appium_lib/driver.rb#L580) +##### [exists](https://github.com/appium/ruby_lib/blob/4d88ecd87be7a2319dd0b7e437e230300269175f/lib/appium_lib/driver.rb#L581) > def exists pre_check=0, post_check=@default_wait, &search_block Returns existence of element. @@ -1587,11 +1587,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Boolean] -- -##### [execute_script](https://github.com/appium/ruby_lib/blob/db2df39eb6fc09e516e22334dd990699755c0509/lib/appium_lib/driver.rb#L604) +##### [execute_script](https://github.com/appium/ruby_lib/blob/4d88ecd87be7a2319dd0b7e437e230300269175f/lib/appium_lib/driver.rb#L605) > def execute_script script, *args The same as @driver.execute_script @@ -1605,11 +1605,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Object] -- -##### [mobile](https://github.com/appium/ruby_lib/blob/db2df39eb6fc09e516e22334dd990699755c0509/lib/appium_lib/driver.rb#L620) +##### [mobile](https://github.com/appium/ruby_lib/blob/4d88ecd87be7a2319dd0b7e437e230300269175f/lib/appium_lib/driver.rb#L621) > def mobile method, *args Helper method for mobile gestures @@ -1631,11 +1631,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Object] -- -##### [find_elements](https://github.com/appium/ruby_lib/blob/db2df39eb6fc09e516e22334dd990699755c0509/lib/appium_lib/driver.rb#L631) +##### [find_elements](https://github.com/appium/ruby_lib/blob/4d88ecd87be7a2319dd0b7e437e230300269175f/lib/appium_lib/driver.rb#L632) > def find_elements *args Calls @driver.find_elements @@ -1647,11 +1647,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/db2df39eb6fc09e516e22334dd990699755c0509/lib/appium_lib/driver.rb#L639) +##### [find_element](https://github.com/appium/ruby_lib/blob/4d88ecd87be7a2319dd0b7e437e230300269175f/lib/appium_lib/driver.rb#L640) > def find_element *args Calls @driver.find_elements @@ -1663,10 +1663,10 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Element] -- -##### [x](https://github.com/appium/ruby_lib/blob/db2df39eb6fc09e516e22334dd990699755c0509/lib/appium_lib/driver.rb#L646) +##### [x](https://github.com/appium/ruby_lib/blob/4d88ecd87be7a2319dd0b7e437e230300269175f/lib/appium_lib/driver.rb#L647) > def x Quit the driver and Pry. quit and exit are reserved by Pry.