docs/android_docs.md in appium_lib-0.7.1 vs docs/android_docs.md in appium_lib-0.8.0

- old
+ new

@@ -1,6 +1,6 @@ -##### [s_texts](https://github.com/appium/ruby_lib/blob/c8f3041049c2feb9ac85f67e85523118a6ce5a84/lib/appium_lib/common/element/text.rb#L8) +##### [s_texts](https://github.com/appium/ruby_lib/blob/1e0f36e22833246873b6ecb8cc4d2bf3544de2c8/lib/appium_lib/common/element/text.rb#L8) > def s_texts Get an array of text texts. @@ -8,11 +8,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Array<String>] -- -##### [e_s_texts](https://github.com/appium/ruby_lib/blob/c8f3041049c2feb9ac85f67e85523118a6ce5a84/lib/appium_lib/common/element/text.rb#L14) +##### [e_s_texts](https://github.com/appium/ruby_lib/blob/1e0f36e22833246873b6ecb8cc4d2bf3544de2c8/lib/appium_lib/common/element/text.rb#L14) > def e_s_texts Get an array of text elements. @@ -20,11 +20,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Array<Text>] -- -##### [first_s_text](https://github.com/appium/ruby_lib/blob/c8f3041049c2feb9ac85f67e85523118a6ce5a84/lib/appium_lib/common/element/text.rb#L20) +##### [first_s_text](https://github.com/appium/ruby_lib/blob/1e0f36e22833246873b6ecb8cc4d2bf3544de2c8/lib/appium_lib/common/element/text.rb#L20) > def first_s_text Get the first text element. @@ -32,11 +32,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Text] -- -##### [last_s_text](https://github.com/appium/ruby_lib/blob/c8f3041049c2feb9ac85f67e85523118a6ce5a84/lib/appium_lib/common/element/text.rb#L26) +##### [last_s_text](https://github.com/appium/ruby_lib/blob/1e0f36e22833246873b6ecb8cc4d2bf3544de2c8/lib/appium_lib/common/element/text.rb#L26) > def last_s_text Get the last text element @@ -44,11 +44,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Text] -- -##### [s_text](https://github.com/appium/ruby_lib/blob/c8f3041049c2feb9ac85f67e85523118a6ce5a84/lib/appium_lib/common/element/text.rb#L33) +##### [s_text](https://github.com/appium/ruby_lib/blob/1e0f36e22833246873b6ecb8cc4d2bf3544de2c8/lib/appium_lib/common/element/text.rb#L33) > def s_text text Get the first element that includes text. @@ -60,11 +60,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Text] -- -##### [s_text_exact](https://github.com/appium/ruby_lib/blob/c8f3041049c2feb9ac85f67e85523118a6ce5a84/lib/appium_lib/common/element/text.rb#L41) +##### [s_text_exact](https://github.com/appium/ruby_lib/blob/1e0f36e22833246873b6ecb8cc4d2bf3544de2c8/lib/appium_lib/common/element/text.rb#L41) > def s_text_exact text Get the first textfield that matches text. @@ -76,19 +76,19 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Text] -- -##### [window_size](https://github.com/appium/ruby_lib/blob/c8f3041049c2feb9ac85f67e85523118a6ce5a84/lib/appium_lib/common/element/window.rb#L5) +##### [window_size](https://github.com/appium/ruby_lib/blob/1e0f36e22833246873b6ecb8cc4d2bf3544de2c8/lib/appium_lib/common/element/window.rb#L5) > def window_size Get the window's size -- -##### [button](https://github.com/appium/ruby_lib/blob/c8f3041049c2feb9ac85f67e85523118a6ce5a84/lib/appium_lib/common/element/button.rb#L8) +##### [button](https://github.com/appium/ruby_lib/blob/1e0f36e22833246873b6ecb8cc4d2bf3544de2c8/lib/appium_lib/common/element/button.rb#L8) > def button text, number=0 Find a button by text and optionally number. @@ -102,11 +102,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Button] the button found with text and matching number -- -##### [buttons](https://github.com/appium/ruby_lib/blob/c8f3041049c2feb9ac85f67e85523118a6ce5a84/lib/appium_lib/common/element/button.rb#L19) +##### [buttons](https://github.com/appium/ruby_lib/blob/1e0f36e22833246873b6ecb8cc4d2bf3544de2c8/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. @@ -118,11 +118,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/c8f3041049c2feb9ac85f67e85523118a6ce5a84/lib/appium_lib/common/element/button.rb#L26) +##### [first_button](https://github.com/appium/ruby_lib/blob/1e0f36e22833246873b6ecb8cc4d2bf3544de2c8/lib/appium_lib/common/element/button.rb#L26) > def first_button Get the first button element. @@ -130,11 +130,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Button] -- -##### [last_button](https://github.com/appium/ruby_lib/blob/c8f3041049c2feb9ac85f67e85523118a6ce5a84/lib/appium_lib/common/element/button.rb#L32) +##### [last_button](https://github.com/appium/ruby_lib/blob/1e0f36e22833246873b6ecb8cc4d2bf3544de2c8/lib/appium_lib/common/element/button.rb#L32) > def last_button Get the last button element. @@ -142,11 +142,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Button] -- -##### [button_exact](https://github.com/appium/ruby_lib/blob/c8f3041049c2feb9ac85f67e85523118a6ce5a84/lib/appium_lib/common/element/button.rb#L39) +##### [button_exact](https://github.com/appium/ruby_lib/blob/1e0f36e22833246873b6ecb8cc4d2bf3544de2c8/lib/appium_lib/common/element/button.rb#L39) > def button_exact text Get the first button element that exactly matches text. @@ -158,11 +158,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Button] -- -##### [buttons_exact](https://github.com/appium/ruby_lib/blob/c8f3041049c2feb9ac85f67e85523118a6ce5a84/lib/appium_lib/common/element/button.rb#L46) +##### [buttons_exact](https://github.com/appium/ruby_lib/blob/1e0f36e22833246873b6ecb8cc4d2bf3544de2c8/lib/appium_lib/common/element/button.rb#L46) > def buttons_exact text Get all button elements that exactly match text. @@ -174,11 +174,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Array<Button>] -- -##### [e_buttons](https://github.com/appium/ruby_lib/blob/c8f3041049c2feb9ac85f67e85523118a6ce5a84/lib/appium_lib/common/element/button.rb#L52) +##### [e_buttons](https://github.com/appium/ruby_lib/blob/1e0f36e22833246873b6ecb8cc4d2bf3544de2c8/lib/appium_lib/common/element/button.rb#L52) > def e_buttons Get an array of button elements. @@ -186,11 +186,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Array<Button>] -- -##### [button_num](https://github.com/appium/ruby_lib/blob/c8f3041049c2feb9ac85f67e85523118a6ce5a84/lib/appium_lib/common/element/button.rb#L72) +##### [button_num](https://github.com/appium/ruby_lib/blob/1e0f36e22833246873b6ecb8cc4d2bf3544de2c8/lib/appium_lib/common/element/button.rb#L72) > def button_num text, number=1 Expected to be called via button method. @@ -215,11 +215,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/c8f3041049c2feb9ac85f67e85523118a6ce5a84/lib/appium_lib/android/helper.rb#L6) android +##### [tag_name_to_android](https://github.com/appium/ruby_lib/blob/1e0f36e22833246873b6ecb8cc4d2bf3544de2c8/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 @@ -231,11 +231,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[String] -- -##### [find_eles_attr](https://github.com/appium/ruby_lib/blob/c8f3041049c2feb9ac85f67e85523118a6ce5a84/lib/appium_lib/android/helper.rb#L194) android +##### [find_eles_attr](https://github.com/appium/ruby_lib/blob/1e0f36e22833246873b6ecb8cc4d2bf3544de2c8/lib/appium_lib/android/helper.rb#L194) 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). @@ -252,11 +252,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Element] -- -##### [get_selendroid_inspect](https://github.com/appium/ruby_lib/blob/c8f3041049c2feb9ac85f67e85523118a6ce5a84/lib/appium_lib/android/helper.rb#L216) android +##### [get_selendroid_inspect](https://github.com/appium/ruby_lib/blob/1e0f36e22833246873b6ecb8cc4d2bf3544de2c8/lib/appium_lib/android/helper.rb#L216) android > def get_selendroid_inspect Selendroid only. Returns a string containing interesting elements. @@ -265,37 +265,29 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[String] -- -##### [get_page_class](https://github.com/appium/ruby_lib/blob/c8f3041049c2feb9ac85f67e85523118a6ce5a84/lib/appium_lib/android/helper.rb#L278) android +##### [get_page_class](https://github.com/appium/ruby_lib/blob/1e0f36e22833246873b6ecb8cc4d2bf3544de2c8/lib/appium_lib/android/helper.rb#L278) android > def get_page_class -- -##### [page_class](https://github.com/appium/ruby_lib/blob/c8f3041049c2feb9ac85f67e85523118a6ce5a84/lib/appium_lib/android/helper.rb#L305) android +##### [page_class](https://github.com/appium/ruby_lib/blob/1e0f36e22833246873b6ecb8cc4d2bf3544de2c8/lib/appium_lib/android/helper.rb#L305) android > def page_class Count all classes on screen and print to stdout. Useful for appium_console. -- -##### [lazy_load_strings](https://github.com/appium/ruby_lib/blob/c8f3041049c2feb9ac85f67e85523118a6ce5a84/lib/appium_lib/android/helper.rb#L310) android +##### [get_android_inspect](https://github.com/appium/ruby_lib/blob/1e0f36e22833246873b6ecb8cc4d2bf3544de2c8/lib/appium_lib/android/helper.rb#L314) android -> def lazy_load_strings - - - --- - -##### [get_android_inspect](https://github.com/appium/ruby_lib/blob/c8f3041049c2feb9ac85f67e85523118a6ce5a84/lib/appium_lib/android/helper.rb#L318) android - > def get_android_inspect Android only. Returns a string containing interesting elements. If an element has no content desc or text, then it's not returned by this method. @@ -304,11 +296,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[String] -- -##### [get_inspect](https://github.com/appium/ruby_lib/blob/c8f3041049c2feb9ac85f67e85523118a6ce5a84/lib/appium_lib/android/helper.rb#L396) android +##### [get_inspect](https://github.com/appium/ruby_lib/blob/1e0f36e22833246873b6ecb8cc4d2bf3544de2c8/lib/appium_lib/android/helper.rb#L392) android > def get_inspect Automatically detects selendroid or android. Returns a string containing interesting elements. @@ -317,20 +309,20 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[String] -- -##### [page](https://github.com/appium/ruby_lib/blob/c8f3041049c2feb9ac85f67e85523118a6ce5a84/lib/appium_lib/android/helper.rb#L402) android +##### [page](https://github.com/appium/ruby_lib/blob/1e0f36e22833246873b6ecb8cc4d2bf3544de2c8/lib/appium_lib/android/helper.rb#L398) android > def page Intended for use with console. Inspects and prints the current page. -- -##### [fast_duration](https://github.com/appium/ruby_lib/blob/c8f3041049c2feb9ac85f67e85523118a6ce5a84/lib/appium_lib/android/helper.rb#L415) android +##### [fast_duration](https://github.com/appium/ruby_lib/blob/1e0f36e22833246873b6ecb8cc4d2bf3544de2c8/lib/appium_lib/android/helper.rb#L411) android > def fast_duration JavaScript code from https://github.com/appium/appium/blob/master/app/android.js @@ -341,68 +333,20 @@ We want steps to be exactly 1. If it's zero then a tap is used instead of a swipe. -- -##### [xml_keys](https://github.com/appium/ruby_lib/blob/c8f3041049c2feb9ac85f67e85523118a6ce5a84/lib/appium_lib/android/helper.rb#L422) android +##### [current_app](https://github.com/appium/ruby_lib/blob/1e0f36e22833246873b6ecb8cc4d2bf3544de2c8/lib/appium_lib/android/helper.rb#L417) android -> def xml_keys target - -Search strings.xml's values for target. - -__Parameters:__ - -&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[String] target - the target to search for in strings.xml values - -__Returns:__ - -&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Array] - --- - -##### [xml_values](https://github.com/appium/ruby_lib/blob/c8f3041049c2feb9ac85f67e85523118a6ce5a84/lib/appium_lib/android/helper.rb#L430) android - -> def xml_values target - -Search strings.xml's keys for target. - -__Parameters:__ - -&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[String] target - the target to search for in strings.xml keys - -__Returns:__ - -&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Array] - --- - -##### [resolve_id](https://github.com/appium/ruby_lib/blob/c8f3041049c2feb9ac85f67e85523118a6ce5a84/lib/appium_lib/android/helper.rb#L438) android - -> def resolve_id id - -Resolve id in strings.xml and return the value. - -__Parameters:__ - -&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[String] id - the id to resolve - -__Returns:__ - -&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[String] - --- - -##### [current_app](https://github.com/appium/ruby_lib/blob/c8f3041049c2feb9ac85f67e85523118a6ce5a84/lib/appium_lib/android/helper.rb#L445) android - > def current_app Lists package, activity, and adb shell am start -n value for current app. Works on local host only (not remote). -- -##### [alert_click](https://github.com/appium/ruby_lib/blob/c8f3041049c2feb9ac85f67e85523118a6ce5a84/lib/appium_lib/android/element/alert.rb#L6) android +##### [alert_click](https://github.com/appium/ruby_lib/blob/1e0f36e22833246873b6ecb8cc4d2bf3544de2c8/lib/appium_lib/android/element/alert.rb#L6) android > def alert_click value Tap the alert button identified by value. @@ -414,11 +358,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[void] -- -##### [alert_accept](https://github.com/appium/ruby_lib/blob/c8f3041049c2feb9ac85f67e85523118a6ce5a84/lib/appium_lib/android/element/alert.rb#L13) android +##### [alert_accept](https://github.com/appium/ruby_lib/blob/1e0f36e22833246873b6ecb8cc4d2bf3544de2c8/lib/appium_lib/android/element/alert.rb#L13) android > def alert_accept Accept the alert. The last button is considered "accept." @@ -427,11 +371,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[void] -- -##### [alert_accept_text](https://github.com/appium/ruby_lib/blob/c8f3041049c2feb9ac85f67e85523118a6ce5a84/lib/appium_lib/android/element/alert.rb#L20) android +##### [alert_accept_text](https://github.com/appium/ruby_lib/blob/1e0f36e22833246873b6ecb8cc4d2bf3544de2c8/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." @@ -440,11 +384,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[String] -- -##### [alert_dismiss](https://github.com/appium/ruby_lib/blob/c8f3041049c2feb9ac85f67e85523118a6ce5a84/lib/appium_lib/android/element/alert.rb#L27) android +##### [alert_dismiss](https://github.com/appium/ruby_lib/blob/1e0f36e22833246873b6ecb8cc4d2bf3544de2c8/lib/appium_lib/android/element/alert.rb#L27) android > def alert_dismiss Dismiss the alert. The first button is considered "dismiss." @@ -453,11 +397,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[void] -- -##### [alert_dismiss_text](https://github.com/appium/ruby_lib/blob/c8f3041049c2feb9ac85f67e85523118a6ce5a84/lib/appium_lib/android/element/alert.rb#L34) android +##### [alert_dismiss_text](https://github.com/appium/ruby_lib/blob/1e0f36e22833246873b6ecb8cc4d2bf3544de2c8/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." @@ -466,11 +410,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[String] -- -##### [find](https://github.com/appium/ruby_lib/blob/c8f3041049c2feb9ac85f67e85523118a6ce5a84/lib/appium_lib/android/element/generic.rb#L44) android +##### [find](https://github.com/appium/ruby_lib/blob/1e0f36e22833246873b6ecb8cc4d2bf3544de2c8/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 @@ -483,11 +427,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Element] -- -##### [text](https://github.com/appium/ruby_lib/blob/c8f3041049c2feb9ac85f67e85523118a6ce5a84/lib/appium_lib/android/element/generic.rb#L70) android +##### [text](https://github.com/appium/ruby_lib/blob/1e0f36e22833246873b6ecb8cc4d2bf3544de2c8/lib/appium_lib/android/element/generic.rb#L70) android > def text text Return the first element matching text. @@ -499,11 +443,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Element] the first matching element -- -##### [texts](https://github.com/appium/ruby_lib/blob/c8f3041049c2feb9ac85f67e85523118a6ce5a84/lib/appium_lib/android/element/generic.rb#L79) android +##### [texts](https://github.com/appium/ruby_lib/blob/1e0f36e22833246873b6ecb8cc4d2bf3544de2c8/lib/appium_lib/android/element/generic.rb#L79) android > def texts text Return all elements matching text. @@ -515,11 +459,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Array<Element>] all matching elements -- -##### [name](https://github.com/appium/ruby_lib/blob/c8f3041049c2feb9ac85f67e85523118a6ce5a84/lib/appium_lib/android/element/generic.rb#L88) android +##### [name](https://github.com/appium/ruby_lib/blob/1e0f36e22833246873b6ecb8cc4d2bf3544de2c8/lib/appium_lib/android/element/generic.rb#L88) android > def name name Return the first element matching name. on Android name is content description @@ -533,11 +477,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Element] the first matching element -- -##### [names](https://github.com/appium/ruby_lib/blob/c8f3041049c2feb9ac85f67e85523118a6ce5a84/lib/appium_lib/android/element/generic.rb#L99) android +##### [names](https://github.com/appium/ruby_lib/blob/1e0f36e22833246873b6ecb8cc4d2bf3544de2c8/lib/appium_lib/android/element/generic.rb#L99) android > def names name Return all elements matching name. on Android name is content description @@ -551,11 +495,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Array<Element>] all matching elements -- -##### [scroll_to](https://github.com/appium/ruby_lib/blob/c8f3041049c2feb9ac85f67e85523118a6ce5a84/lib/appium_lib/android/element/generic.rb#L108) android +##### [scroll_to](https://github.com/appium/ruby_lib/blob/1e0f36e22833246873b6ecb8cc4d2bf3544de2c8/lib/appium_lib/android/element/generic.rb#L108) android > def scroll_to text Scroll to an element containing target text or description. @@ -567,11 +511,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Element] the element scrolled to -- -##### [textfields](https://github.com/appium/ruby_lib/blob/c8f3041049c2feb9ac85f67e85523118a6ce5a84/lib/appium_lib/android/element/textfield.rb#L7) android +##### [textfields](https://github.com/appium/ruby_lib/blob/1e0f36e22833246873b6ecb8cc4d2bf3544de2c8/lib/appium_lib/android/element/textfield.rb#L7) android > def textfields Get an array of textfield texts. @@ -579,11 +523,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Array<String>] -- -##### [e_textfields](https://github.com/appium/ruby_lib/blob/c8f3041049c2feb9ac85f67e85523118a6ce5a84/lib/appium_lib/android/element/textfield.rb#L13) android +##### [e_textfields](https://github.com/appium/ruby_lib/blob/1e0f36e22833246873b6ecb8cc4d2bf3544de2c8/lib/appium_lib/android/element/textfield.rb#L13) android > def e_textfields Get an array of textfield elements. @@ -591,11 +535,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Array<Textfield>] -- -##### [first_textfield](https://github.com/appium/ruby_lib/blob/c8f3041049c2feb9ac85f67e85523118a6ce5a84/lib/appium_lib/android/element/textfield.rb#L19) android +##### [first_textfield](https://github.com/appium/ruby_lib/blob/1e0f36e22833246873b6ecb8cc4d2bf3544de2c8/lib/appium_lib/android/element/textfield.rb#L19) android > def first_textfield Get the first textfield element. @@ -603,11 +547,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Textfield] -- -##### [last_textfield](https://github.com/appium/ruby_lib/blob/c8f3041049c2feb9ac85f67e85523118a6ce5a84/lib/appium_lib/android/element/textfield.rb#L25) android +##### [last_textfield](https://github.com/appium/ruby_lib/blob/1e0f36e22833246873b6ecb8cc4d2bf3544de2c8/lib/appium_lib/android/element/textfield.rb#L25) android > def last_textfield Get the last textfield element. @@ -615,11 +559,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Textfield] -- -##### [textfield](https://github.com/appium/ruby_lib/blob/c8f3041049c2feb9ac85f67e85523118a6ce5a84/lib/appium_lib/android/element/textfield.rb#L32) android +##### [textfield](https://github.com/appium/ruby_lib/blob/1e0f36e22833246873b6ecb8cc4d2bf3544de2c8/lib/appium_lib/android/element/textfield.rb#L32) android > def textfield text Get the first textfield that includes text or name (content description). @@ -631,11 +575,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Textfield] -- -##### [textfield_exact](https://github.com/appium/ruby_lib/blob/c8f3041049c2feb9ac85f67e85523118a6ce5a84/lib/appium_lib/android/element/textfield.rb#L45) android +##### [textfield_exact](https://github.com/appium/ruby_lib/blob/1e0f36e22833246873b6ecb8cc4d2bf3544de2c8/lib/appium_lib/android/element/textfield.rb#L45) android > def textfield_exact text Get the first textfield that matches text. @@ -647,11 +591,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Textfield] -- -##### [wait](https://github.com/appium/ruby_lib/blob/c8f3041049c2feb9ac85f67e85523118a6ce5a84/lib/appium_lib/common/helper.rb#L33) +##### [wait](https://github.com/appium/ruby_lib/blob/1e0f36e22833246873b6ecb8cc4d2bf3544de2c8/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. @@ -674,19 +618,19 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Object] the result of block.call -- -##### [ignore](https://github.com/appium/ruby_lib/blob/c8f3041049c2feb9ac85f67e85523118a6ce5a84/lib/appium_lib/common/helper.rb#L45) +##### [ignore](https://github.com/appium/ruby_lib/blob/1e0f36e22833246873b6ecb8cc4d2bf3544de2c8/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/c8f3041049c2feb9ac85f67e85523118a6ce5a84/lib/appium_lib/common/helper.rb#L55) +##### [wait_true](https://github.com/appium/ruby_lib/blob/1e0f36e22833246873b6ecb8cc4d2bf3544de2c8/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. @@ -703,11 +647,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Object] the result of block.call -- -##### [id](https://github.com/appium/ruby_lib/blob/c8f3041049c2feb9ac85f67e85523118a6ce5a84/lib/appium_lib/common/helper.rb#L69) +##### [id](https://github.com/appium/ruby_lib/blob/1e0f36e22833246873b6ecb8cc4d2bf3544de2c8/lib/appium_lib/common/helper.rb#L69) > def id id Find by id. Useful for selendroid @@ -719,11 +663,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Element] -- -##### [back](https://github.com/appium/ruby_lib/blob/c8f3041049c2feb9ac85f67e85523118a6ce5a84/lib/appium_lib/common/helper.rb#L75) +##### [back](https://github.com/appium/ruby_lib/blob/1e0f36e22833246873b6ecb8cc4d2bf3544de2c8/lib/appium_lib/common/helper.rb#L75) > def back Navigate back. @@ -731,19 +675,19 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[void] -- -##### [session_id](https://github.com/appium/ruby_lib/blob/c8f3041049c2feb9ac85f67e85523118a6ce5a84/lib/appium_lib/common/helper.rb#L80) +##### [session_id](https://github.com/appium/ruby_lib/blob/1e0f36e22833246873b6ecb8cc4d2bf3544de2c8/lib/appium_lib/common/helper.rb#L80) > def session_id For Sauce Labs reporting. Returns the current session id. -- -##### [xpath](https://github.com/appium/ruby_lib/blob/c8f3041049c2feb9ac85f67e85523118a6ce5a84/lib/appium_lib/common/helper.rb#L88) +##### [xpath](https://github.com/appium/ruby_lib/blob/1e0f36e22833246873b6ecb8cc4d2bf3544de2c8/lib/appium_lib/common/helper.rb#L88) > def xpath xpath_str Returns the first element that matches the provided xpath. @@ -755,11 +699,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Element] -- -##### [xpaths](https://github.com/appium/ruby_lib/blob/c8f3041049c2feb9ac85f67e85523118a6ce5a84/lib/appium_lib/common/helper.rb#L96) +##### [xpaths](https://github.com/appium/ruby_lib/blob/1e0f36e22833246873b6ecb8cc4d2bf3544de2c8/lib/appium_lib/common/helper.rb#L96) > def xpaths xpath_str Returns all elements that match the provided xpath. @@ -771,11 +715,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Array<Element>] -- -##### [ele_index](https://github.com/appium/ruby_lib/blob/c8f3041049c2feb9ac85f67e85523118a6ce5a84/lib/appium_lib/common/helper.rb#L104) +##### [ele_index](https://github.com/appium/ruby_lib/blob/1e0f36e22833246873b6ecb8cc4d2bf3544de2c8/lib/appium_lib/common/helper.rb#L104) > def ele_index tag_name, index Get the element of type tag_name at matching index. @@ -789,11 +733,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Element] the found element of type tag_name -- -##### [find_eles](https://github.com/appium/ruby_lib/blob/c8f3041049c2feb9ac85f67e85523118a6ce5a84/lib/appium_lib/common/helper.rb#L112) +##### [find_eles](https://github.com/appium/ruby_lib/blob/1e0f36e22833246873b6ecb8cc4d2bf3544de2c8/lib/appium_lib/common/helper.rb#L112) > def find_eles tag_name Get all elements exactly matching tag name @@ -805,11 +749,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/c8f3041049c2feb9ac85f67e85523118a6ce5a84/lib/appium_lib/common/helper.rb#L120) +##### [find_ele_by_text](https://github.com/appium/ruby_lib/blob/1e0f36e22833246873b6ecb8cc4d2bf3544de2c8/lib/appium_lib/common/helper.rb#L120) > def find_ele_by_text tag, text Get the first tag that exactly matches tag and text. @@ -823,11 +767,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/c8f3041049c2feb9ac85f67e85523118a6ce5a84/lib/appium_lib/common/helper.rb#L128) +##### [find_eles_by_text](https://github.com/appium/ruby_lib/blob/1e0f36e22833246873b6ecb8cc4d2bf3544de2c8/lib/appium_lib/common/helper.rb#L128) > def find_eles_by_text tag, text Get all tags that exactly match tag and text. @@ -841,11 +785,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/c8f3041049c2feb9ac85f67e85523118a6ce5a84/lib/appium_lib/common/helper.rb#L137) +##### [find_ele_by_attr_include](https://github.com/appium/ruby_lib/blob/1e0f36e22833246873b6ecb8cc4d2bf3544de2c8/lib/appium_lib/common/helper.rb#L137) > def find_ele_by_attr_include tag, attr, value Get the first tag by attribute that exactly matches value. @@ -861,11 +805,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/c8f3041049c2feb9ac85f67e85523118a6ce5a84/lib/appium_lib/common/helper.rb#L146) +##### [find_eles_by_attr_include](https://github.com/appium/ruby_lib/blob/1e0f36e22833246873b6ecb8cc4d2bf3544de2c8/lib/appium_lib/common/helper.rb#L146) > def find_eles_by_attr_include tag, attr, value Get tags by attribute that include value. @@ -881,11 +825,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/c8f3041049c2feb9ac85f67e85523118a6ce5a84/lib/appium_lib/common/helper.rb#L155) +##### [find_ele_by_text_include](https://github.com/appium/ruby_lib/blob/1e0f36e22833246873b6ecb8cc4d2bf3544de2c8/lib/appium_lib/common/helper.rb#L155) > def find_ele_by_text_include tag, text Get the first tag that includes text. element.attribute(:text).include? text @@ -900,11 +844,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/c8f3041049c2feb9ac85f67e85523118a6ce5a84/lib/appium_lib/common/helper.rb#L164) +##### [find_eles_by_text_include](https://github.com/appium/ruby_lib/blob/1e0f36e22833246873b6ecb8cc4d2bf3544de2c8/lib/appium_lib/common/helper.rb#L164) > def find_eles_by_text_include tag, text Get the tags that include text. element.attribute(:text).include? text @@ -919,11 +863,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/c8f3041049c2feb9ac85f67e85523118a6ce5a84/lib/appium_lib/common/helper.rb#L171) +##### [first_ele](https://github.com/appium/ruby_lib/blob/1e0f36e22833246873b6ecb8cc4d2bf3544de2c8/lib/appium_lib/common/helper.rb#L171) > def first_ele tag_name Get the first tag that matches tag_name @@ -935,11 +879,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Element] -- -##### [last_ele](https://github.com/appium/ruby_lib/blob/c8f3041049c2feb9ac85f67e85523118a6ce5a84/lib/appium_lib/common/helper.rb#L179) +##### [last_ele](https://github.com/appium/ruby_lib/blob/1e0f36e22833246873b6ecb8cc4d2bf3544de2c8/lib/appium_lib/common/helper.rb#L179) > def last_ele tag_name Get the last tag that matches tag_name @@ -951,11 +895,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Element] -- -##### [source](https://github.com/appium/ruby_lib/blob/c8f3041049c2feb9ac85f67e85523118a6ce5a84/lib/appium_lib/common/helper.rb#L185) +##### [source](https://github.com/appium/ruby_lib/blob/1e0f36e22833246873b6ecb8cc4d2bf3544de2c8/lib/appium_lib/common/helper.rb#L185) > def source Prints a JSON view of the current page @@ -963,11 +907,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[void] -- -##### [get_source](https://github.com/appium/ruby_lib/blob/c8f3041049c2feb9ac85f67e85523118a6ce5a84/lib/appium_lib/common/helper.rb#L191) +##### [get_source](https://github.com/appium/ruby_lib/blob/1e0f36e22833246873b6ecb8cc4d2bf3544de2c8/lib/appium_lib/common/helper.rb#L191) > def get_source Gets a JSON view of the current page @@ -975,11 +919,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[JSON] -- -##### [find_name](https://github.com/appium/ruby_lib/blob/c8f3041049c2feb9ac85f67e85523118a6ce5a84/lib/appium_lib/common/helper.rb#L200) +##### [find_name](https://github.com/appium/ruby_lib/blob/1e0f36e22833246873b6ecb8cc4d2bf3544de2c8/lib/appium_lib/common/helper.rb#L200) > def find_name name Returns the first element that exactly matches name @@ -991,11 +935,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Element] -- -##### [find_names](https://github.com/appium/ruby_lib/blob/c8f3041049c2feb9ac85f67e85523118a6ce5a84/lib/appium_lib/common/helper.rb#L208) +##### [find_names](https://github.com/appium/ruby_lib/blob/1e0f36e22833246873b6ecb8cc4d2bf3544de2c8/lib/appium_lib/common/helper.rb#L208) > def find_names name Returns all elements that exactly match name @@ -1007,11 +951,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Array<Element>] -- -##### [tag](https://github.com/appium/ruby_lib/blob/c8f3041049c2feb9ac85f67e85523118a6ce5a84/lib/appium_lib/common/helper.rb#L216) +##### [tag](https://github.com/appium/ruby_lib/blob/1e0f36e22833246873b6ecb8cc4d2bf3544de2c8/lib/appium_lib/common/helper.rb#L216) > def tag tag_name Returns the first element matching tag_name @@ -1023,11 +967,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Element] -- -##### [px_to_window_rel](https://github.com/appium/ruby_lib/blob/c8f3041049c2feb9ac85f67e85523118a6ce5a84/lib/appium_lib/common/helper.rb#L226) +##### [px_to_window_rel](https://github.com/appium/ruby_lib/blob/1e0f36e22833246873b6ecb8cc4d2bf3544de2c8/lib/appium_lib/common/helper.rb#L226) > def px_to_window_rel opts={} Converts pixel values to window relative values @@ -1035,41 +979,97 @@ px_to_window_rel x: 50, y: 150 ``` -- -##### [value](https://github.com/appium/ruby_lib/blob/c8f3041049c2feb9ac85f67e85523118a6ce5a84/lib/appium_lib/common/patch.rb#L32) +##### [lazy_load_strings](https://github.com/appium/ruby_lib/blob/1e0f36e22833246873b6ecb8cc4d2bf3544de2c8/lib/appium_lib/common/helper.rb#L236) +> def lazy_load_strings + + + +-- + +##### [xml_keys](https://github.com/appium/ruby_lib/blob/1e0f36e22833246873b6ecb8cc4d2bf3544de2c8/lib/appium_lib/common/helper.rb#L243) + +> def xml_keys target + +Search strings.xml's values for target. + +__Parameters:__ + +&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[String] target - the target to search for in strings.xml values + +__Returns:__ + +&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Array] + +-- + +##### [xml_values](https://github.com/appium/ruby_lib/blob/1e0f36e22833246873b6ecb8cc4d2bf3544de2c8/lib/appium_lib/common/helper.rb#L251) + +> def xml_values target + +Search strings.xml's keys for target. + +__Parameters:__ + +&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[String] target - the target to search for in strings.xml keys + +__Returns:__ + +&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Array] + +-- + +##### [resolve_id](https://github.com/appium/ruby_lib/blob/1e0f36e22833246873b6ecb8cc4d2bf3544de2c8/lib/appium_lib/common/helper.rb#L259) + +> def resolve_id id + +Resolve id in strings.xml and return the value. + +__Parameters:__ + +&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[String] id - the id to resolve + +__Returns:__ + +&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[String] + +-- + +##### [value](https://github.com/appium/ruby_lib/blob/1e0f36e22833246873b6ecb8cc4d2bf3544de2c8/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/c8f3041049c2feb9ac85f67e85523118a6ce5a84/lib/appium_lib/common/patch.rb#L39) +##### [name](https://github.com/appium/ruby_lib/blob/1e0f36e22833246873b6ecb8cc4d2bf3544de2c8/lib/appium_lib/common/patch.rb#L39) > def name Returns the name attribute Fixes NoMethodError: undefined method `name' for Selenium::WebDriver::Element -- -##### [tag_name](https://github.com/appium/ruby_lib/blob/c8f3041049c2feb9ac85f67e85523118a6ce5a84/lib/appium_lib/common/patch.rb#L46) +##### [tag_name](https://github.com/appium/ruby_lib/blob/1e0f36e22833246873b6ecb8cc4d2bf3544de2c8/lib/appium_lib/common/patch.rb#L46) > def tag_name Returns the type attribute Fixes Selenium::WebDriver::Error::UnknownError: Not yet implemented -- -##### [location_rel](https://github.com/appium/ruby_lib/blob/c8f3041049c2feb9ac85f67e85523118a6ce5a84/lib/appium_lib/common/patch.rb#L58) +##### [location_rel](https://github.com/appium/ruby_lib/blob/1e0f36e22833246873b6ecb8cc4d2bf3544de2c8/lib/appium_lib/common/patch.rb#L58) > def location_rel For use with mobile tap. @@ -1083,27 +1083,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/c8f3041049c2feb9ac85f67e85523118a6ce5a84/lib/appium_lib/driver.rb#L16) +##### [CORE](https://github.com/appium/ruby_lib/blob/1e0f36e22833246873b6ecb8cc4d2bf3544de2c8/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/c8f3041049c2feb9ac85f67e85523118a6ce5a84/lib/appium_lib/driver.rb#L18) +##### [awesome_openstruct](https://github.com/appium/ruby_lib/blob/1e0f36e22833246873b6ecb8cc4d2bf3544de2c8/lib/appium_lib/driver.rb#L18) > def awesome_openstruct target -- -##### [load_appium_txt](https://github.com/appium/ruby_lib/blob/c8f3041049c2feb9ac85f67e85523118a6ce5a84/lib/appium_lib/driver.rb#L28) +##### [load_appium_txt](https://github.com/appium/ruby_lib/blob/1e0f36e22833246873b6ecb8cc4d2bf3544de2c8/lib/appium_lib/driver.rb#L28) > def load_appium_txt opts Load appium.txt (toml format) into system ENV the basedir of this file + appium.txt is what's used @@ -1116,11 +1116,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Array<String>] the require files. nil if require doesn't exist -- -##### [promote_appium_methods](https://github.com/appium/ruby_lib/blob/c8f3041049c2feb9ac85f67e85523118a6ce5a84/lib/appium_lib/driver.rb#L165) +##### [promote_appium_methods](https://github.com/appium/ruby_lib/blob/1e0f36e22833246873b6ecb8cc4d2bf3544de2c8/lib/appium_lib/driver.rb#L165) > def self.promote_appium_methods class_array Promote appium methods to class instance methods @@ -1134,11 +1134,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Array<Class>] class_array - An array of classes -- -##### [default_wait](https://github.com/appium/ruby_lib/blob/c8f3041049c2feb9ac85f67e85523118a6ce5a84/lib/appium_lib/driver.rb#L491) +##### [default_wait](https://github.com/appium/ruby_lib/blob/1e0f36e22833246873b6ecb8cc4d2bf3544de2c8/lib/appium_lib/driver.rb#L494) > def default_wait Returns the default client side wait. This value is independent of what the server is using @@ -1147,131 +1147,139 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Integer] -- -##### [app_path](https://github.com/appium/ruby_lib/blob/c8f3041049c2feb9ac85f67e85523118a6ce5a84/lib/appium_lib/driver.rb#L194) +##### [app_path](https://github.com/appium/ruby_lib/blob/1e0f36e22833246873b6ecb8cc4d2bf3544de2c8/lib/appium_lib/driver.rb#L194) > def app_path Returns the value of attribute app_path -- -##### [app_name](https://github.com/appium/ruby_lib/blob/c8f3041049c2feb9ac85f67e85523118a6ce5a84/lib/appium_lib/driver.rb#L194) +##### [app_name](https://github.com/appium/ruby_lib/blob/1e0f36e22833246873b6ecb8cc4d2bf3544de2c8/lib/appium_lib/driver.rb#L194) > def app_name Returns the value of attribute app_name -- -##### [device](https://github.com/appium/ruby_lib/blob/c8f3041049c2feb9ac85f67e85523118a6ce5a84/lib/appium_lib/driver.rb#L194) +##### [device](https://github.com/appium/ruby_lib/blob/1e0f36e22833246873b6ecb8cc4d2bf3544de2c8/lib/appium_lib/driver.rb#L194) > def device Returns the value of attribute device -- -##### [app_package](https://github.com/appium/ruby_lib/blob/c8f3041049c2feb9ac85f67e85523118a6ce5a84/lib/appium_lib/driver.rb#L194) +##### [app_package](https://github.com/appium/ruby_lib/blob/1e0f36e22833246873b6ecb8cc4d2bf3544de2c8/lib/appium_lib/driver.rb#L194) > def app_package Returns the value of attribute app_package -- -##### [app_activity](https://github.com/appium/ruby_lib/blob/c8f3041049c2feb9ac85f67e85523118a6ce5a84/lib/appium_lib/driver.rb#L194) +##### [app_activity](https://github.com/appium/ruby_lib/blob/1e0f36e22833246873b6ecb8cc4d2bf3544de2c8/lib/appium_lib/driver.rb#L194) > def app_activity Returns the value of attribute app_activity -- -##### [app_wait_activity](https://github.com/appium/ruby_lib/blob/c8f3041049c2feb9ac85f67e85523118a6ce5a84/lib/appium_lib/driver.rb#L194) +##### [app_wait_activity](https://github.com/appium/ruby_lib/blob/1e0f36e22833246873b6ecb8cc4d2bf3544de2c8/lib/appium_lib/driver.rb#L194) > def app_wait_activity Returns the value of attribute app_wait_activity -- -##### [sauce_username](https://github.com/appium/ruby_lib/blob/c8f3041049c2feb9ac85f67e85523118a6ce5a84/lib/appium_lib/driver.rb#L194) +##### [sauce_username](https://github.com/appium/ruby_lib/blob/1e0f36e22833246873b6ecb8cc4d2bf3544de2c8/lib/appium_lib/driver.rb#L194) > def sauce_username Returns the value of attribute sauce_username -- -##### [sauce_access_key](https://github.com/appium/ruby_lib/blob/c8f3041049c2feb9ac85f67e85523118a6ce5a84/lib/appium_lib/driver.rb#L194) +##### [sauce_access_key](https://github.com/appium/ruby_lib/blob/1e0f36e22833246873b6ecb8cc4d2bf3544de2c8/lib/appium_lib/driver.rb#L194) > def sauce_access_key Returns the value of attribute sauce_access_key -- -##### [port](https://github.com/appium/ruby_lib/blob/c8f3041049c2feb9ac85f67e85523118a6ce5a84/lib/appium_lib/driver.rb#L194) +##### [port](https://github.com/appium/ruby_lib/blob/1e0f36e22833246873b6ecb8cc4d2bf3544de2c8/lib/appium_lib/driver.rb#L194) > def port Returns the value of attribute port -- -##### [debug](https://github.com/appium/ruby_lib/blob/c8f3041049c2feb9ac85f67e85523118a6ce5a84/lib/appium_lib/driver.rb#L194) +##### [debug](https://github.com/appium/ruby_lib/blob/1e0f36e22833246873b6ecb8cc4d2bf3544de2c8/lib/appium_lib/driver.rb#L194) > def debug Returns the value of attribute debug -- -##### [export_session](https://github.com/appium/ruby_lib/blob/c8f3041049c2feb9ac85f67e85523118a6ce5a84/lib/appium_lib/driver.rb#L194) +##### [export_session](https://github.com/appium/ruby_lib/blob/1e0f36e22833246873b6ecb8cc4d2bf3544de2c8/lib/appium_lib/driver.rb#L194) > def export_session Returns the value of attribute export_session -- -##### [device_cap](https://github.com/appium/ruby_lib/blob/c8f3041049c2feb9ac85f67e85523118a6ce5a84/lib/appium_lib/driver.rb#L194) +##### [device_cap](https://github.com/appium/ruby_lib/blob/1e0f36e22833246873b6ecb8cc4d2bf3544de2c8/lib/appium_lib/driver.rb#L194) > def device_cap Returns the value of attribute device_cap -- -##### [compress_xml](https://github.com/appium/ruby_lib/blob/c8f3041049c2feb9ac85f67e85523118a6ce5a84/lib/appium_lib/driver.rb#L194) +##### [compress_xml](https://github.com/appium/ruby_lib/blob/1e0f36e22833246873b6ecb8cc4d2bf3544de2c8/lib/appium_lib/driver.rb#L194) > def compress_xml Returns the value of attribute compress_xml -- -##### [global_webdriver_http_sleep](https://github.com/appium/ruby_lib/blob/c8f3041049c2feb9ac85f67e85523118a6ce5a84/lib/appium_lib/driver.rb#L200) +##### [custom_url](https://github.com/appium/ruby_lib/blob/1e0f36e22833246873b6ecb8cc4d2bf3544de2c8/lib/appium_lib/driver.rb#L194) +> def custom_url + +Returns the value of attribute custom_url + +-- + +##### [global_webdriver_http_sleep](https://github.com/appium/ruby_lib/blob/1e0f36e22833246873b6ecb8cc4d2bf3544de2c8/lib/appium_lib/driver.rb#L200) + > 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/c8f3041049c2feb9ac85f67e85523118a6ce5a84/lib/appium_lib/driver.rb#L200) +##### [global_webdriver_http_sleep=](https://github.com/appium/ruby_lib/blob/1e0f36e22833246873b6ecb8cc4d2bf3544de2c8/lib/appium_lib/driver.rb#L200) > 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/c8f3041049c2feb9ac85f67e85523118a6ce5a84/lib/appium_lib/driver.rb#L230) +##### [initialize](https://github.com/appium/ruby_lib/blob/1e0f36e22833246873b6ecb8cc4d2bf3544de2c8/lib/appium_lib/driver.rb#L230) > def initialize opts={} Creates a new driver. :device is :android, :ios, or :selendroid @@ -1308,11 +1316,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Driver] -- -##### [status](https://github.com/appium/ruby_lib/blob/c8f3041049c2feb9ac85f67e85523118a6ce5a84/lib/appium_lib/driver.rb#L335) +##### [status](https://github.com/appium/ruby_lib/blob/1e0f36e22833246873b6ecb8cc4d2bf3544de2c8/lib/appium_lib/driver.rb#L337) > def status Returns the status payload @@ -1334,11 +1342,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[JSON] -- -##### [server_version](https://github.com/appium/ruby_lib/blob/c8f3041049c2feb9ac85f67e85523118a6ce5a84/lib/appium_lib/driver.rb#L341) +##### [server_version](https://github.com/appium/ruby_lib/blob/1e0f36e22833246873b6ecb8cc4d2bf3544de2c8/lib/appium_lib/driver.rb#L343) > def server_version Returns the server's version string @@ -1346,11 +1354,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[String] -- -##### [absolute_app_path](https://github.com/appium/ruby_lib/blob/c8f3041049c2feb9ac85f67e85523118a6ce5a84/lib/appium_lib/driver.rb#L381) +##### [absolute_app_path](https://github.com/appium/ruby_lib/blob/1e0f36e22833246873b6ecb8cc4d2bf3544de2c8/lib/appium_lib/driver.rb#L383) > def absolute_app_path Converts environment variable APP_PATH to an absolute path. @@ -1358,11 +1366,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[String] APP_PATH as an absolute path -- -##### [server_url](https://github.com/appium/ruby_lib/blob/c8f3041049c2feb9ac85f67e85523118a6ce5a84/lib/appium_lib/driver.rb#L401) +##### [server_url](https://github.com/appium/ruby_lib/blob/1e0f36e22833246873b6ecb8cc4d2bf3544de2c8/lib/appium_lib/driver.rb#L403) > def server_url Get the server url for sauce or local based on env vars. @@ -1370,11 +1378,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[String] the server url -- -##### [restart](https://github.com/appium/ruby_lib/blob/c8f3041049c2feb9ac85f67e85523118a6ce5a84/lib/appium_lib/driver.rb#L411) +##### [restart](https://github.com/appium/ruby_lib/blob/1e0f36e22833246873b6ecb8cc4d2bf3544de2c8/lib/appium_lib/driver.rb#L414) > def restart Restarts the driver @@ -1382,11 +1390,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Driver] the driver -- -##### [driver](https://github.com/appium/ruby_lib/blob/c8f3041049c2feb9ac85f67e85523118a6ce5a84/lib/appium_lib/driver.rb#L418) +##### [driver](https://github.com/appium/ruby_lib/blob/1e0f36e22833246873b6ecb8cc4d2bf3544de2c8/lib/appium_lib/driver.rb#L421) > def driver Returns the driver @@ -1394,11 +1402,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Driver] the driver -- -##### [screenshot](https://github.com/appium/ruby_lib/blob/c8f3041049c2feb9ac85f67e85523118a6ce5a84/lib/appium_lib/driver.rb#L428) +##### [screenshot](https://github.com/appium/ruby_lib/blob/1e0f36e22833246873b6ecb8cc4d2bf3544de2c8/lib/appium_lib/driver.rb#L431) > def screenshot png_save_path Takes a png screenshot and saves to the target path. @@ -1412,11 +1420,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[nil] -- -##### [driver_quit](https://github.com/appium/ruby_lib/blob/c8f3041049c2feb9ac85f67e85523118a6ce5a84/lib/appium_lib/driver.rb#L435) +##### [driver_quit](https://github.com/appium/ruby_lib/blob/1e0f36e22833246873b6ecb8cc4d2bf3544de2c8/lib/appium_lib/driver.rb#L438) > def driver_quit Quits the driver @@ -1424,11 +1432,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[void] -- -##### [start_driver](https://github.com/appium/ruby_lib/blob/c8f3041049c2feb9ac85f67e85523118a6ce5a84/lib/appium_lib/driver.rb#L443) +##### [start_driver](https://github.com/appium/ruby_lib/blob/1e0f36e22833246873b6ecb8cc4d2bf3544de2c8/lib/appium_lib/driver.rb#L446) > def start_driver Creates a new global driver and quits the old one if it exists. @@ -1436,19 +1444,19 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Selenium::WebDriver] the new global driver -- -##### [no_wait](https://github.com/appium/ruby_lib/blob/c8f3041049c2feb9ac85f67e85523118a6ce5a84/lib/appium_lib/driver.rb#L477) +##### [no_wait](https://github.com/appium/ruby_lib/blob/1e0f36e22833246873b6ecb8cc4d2bf3544de2c8/lib/appium_lib/driver.rb#L480) > def no_wait Set implicit wait to zero. -- -##### [set_wait](https://github.com/appium/ruby_lib/blob/c8f3041049c2feb9ac85f67e85523118a6ce5a84/lib/appium_lib/driver.rb#L484) +##### [set_wait](https://github.com/appium/ruby_lib/blob/1e0f36e22833246873b6ecb8cc4d2bf3544de2c8/lib/appium_lib/driver.rb#L487) > def set_wait timeout=@default_wait Set implicit wait to timeout, defaults to 30. @@ -1460,11 +1468,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[void] -- -##### [exists](https://github.com/appium/ruby_lib/blob/c8f3041049c2feb9ac85f67e85523118a6ce5a84/lib/appium_lib/driver.rb#L507) +##### [exists](https://github.com/appium/ruby_lib/blob/1e0f36e22833246873b6ecb8cc4d2bf3544de2c8/lib/appium_lib/driver.rb#L510) > def exists pre_check=0, post_check=@default_wait, &search_block Returns existence of element. @@ -1486,11 +1494,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Boolean] -- -##### [execute_script](https://github.com/appium/ruby_lib/blob/c8f3041049c2feb9ac85f67e85523118a6ce5a84/lib/appium_lib/driver.rb#L529) +##### [execute_script](https://github.com/appium/ruby_lib/blob/1e0f36e22833246873b6ecb8cc4d2bf3544de2c8/lib/appium_lib/driver.rb#L532) > def execute_script script, *args The same as @driver.execute_script @@ -1504,11 +1512,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Object] -- -##### [mobile](https://github.com/appium/ruby_lib/blob/c8f3041049c2feb9ac85f67e85523118a6ce5a84/lib/appium_lib/driver.rb#L545) +##### [mobile](https://github.com/appium/ruby_lib/blob/1e0f36e22833246873b6ecb8cc4d2bf3544de2c8/lib/appium_lib/driver.rb#L548) > def mobile method, *args Helper method for mobile gestures @@ -1530,11 +1538,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Object] -- -##### [find_elements](https://github.com/appium/ruby_lib/blob/c8f3041049c2feb9ac85f67e85523118a6ce5a84/lib/appium_lib/driver.rb#L556) +##### [find_elements](https://github.com/appium/ruby_lib/blob/1e0f36e22833246873b6ecb8cc4d2bf3544de2c8/lib/appium_lib/driver.rb#L559) > def find_elements *args Calls @driver.find_elements @@ -1546,11 +1554,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/c8f3041049c2feb9ac85f67e85523118a6ce5a84/lib/appium_lib/driver.rb#L564) +##### [find_element](https://github.com/appium/ruby_lib/blob/1e0f36e22833246873b6ecb8cc4d2bf3544de2c8/lib/appium_lib/driver.rb#L567) > def find_element *args Calls @driver.find_elements @@ -1562,10 +1570,10 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Element] -- -##### [x](https://github.com/appium/ruby_lib/blob/c8f3041049c2feb9ac85f67e85523118a6ce5a84/lib/appium_lib/driver.rb#L571) +##### [x](https://github.com/appium/ruby_lib/blob/1e0f36e22833246873b6ecb8cc4d2bf3544de2c8/lib/appium_lib/driver.rb#L574) > def x Quit the driver and Pry. quit and exit are reserved by Pry.