docs/ios_docs.md in appium_lib-0.7.1 vs docs/ios_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 -- -##### [find_eles_attr](https://github.com/appium/ruby_lib/blob/c8f3041049c2feb9ac85f67e85523118a6ce5a84/lib/appium_lib/ios/helper.rb#L8) ios +##### [find_eles_attr](https://github.com/appium/ruby_lib/blob/1e0f36e22833246873b6ecb8cc4d2bf3544de2c8/lib/appium_lib/ios/helper.rb#L8) ios > def find_eles_attr tag_name, attribute iOS only. Android uses uiautomator instead of uiautomation. Get an array of attribute values from elements exactly matching tag name. @@ -234,11 +234,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Array<String>] an array of strings containing the attribute from found elements of type tag_name. -- -##### [find_2_eles_attr](https://github.com/appium/ruby_lib/blob/c8f3041049c2feb9ac85f67e85523118a6ce5a84/lib/appium_lib/ios/helper.rb#L29) ios +##### [find_2_eles_attr](https://github.com/appium/ruby_lib/blob/1e0f36e22833246873b6ecb8cc4d2bf3544de2c8/lib/appium_lib/ios/helper.rb#L29) ios > def find_2_eles_attr tag_name_1, tag_name_2, attribute iOS only. Android doesn't use find_2_eles_attr. Get an array of attribute values from elements exactly matching tag name. @@ -255,11 +255,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Array<String>] an array of strings containing the attribute from found elements of type tag_name. -- -##### [password](https://github.com/appium/ruby_lib/blob/c8f3041049c2feb9ac85f67e85523118a6ce5a84/lib/appium_lib/ios/helper.rb#L50) ios +##### [password](https://github.com/appium/ruby_lib/blob/1e0f36e22833246873b6ecb8cc4d2bf3544de2c8/lib/appium_lib/ios/helper.rb#L50) ios > def password length=1 iOS only. On Android uiautomator always returns an empty string for EditText password. @@ -273,36 +273,28 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[String] the returned string is of size length -- -##### [get_page_class](https://github.com/appium/ruby_lib/blob/c8f3041049c2feb9ac85f67e85523118a6ce5a84/lib/appium_lib/ios/helper.rb#L55) ios +##### [get_page_class](https://github.com/appium/ruby_lib/blob/1e0f36e22833246873b6ecb8cc4d2bf3544de2c8/lib/appium_lib/ios/helper.rb#L55) ios > def get_page_class Returns a string of class counts. -- -##### [page_class](https://github.com/appium/ruby_lib/blob/c8f3041049c2feb9ac85f67e85523118a6ce5a84/lib/appium_lib/ios/helper.rb#L81) ios +##### [page_class](https://github.com/appium/ruby_lib/blob/1e0f36e22833246873b6ecb8cc4d2bf3544de2c8/lib/appium_lib/ios/helper.rb#L81) ios > def page_class -- -##### [lazy_load_strings](https://github.com/appium/ruby_lib/blob/c8f3041049c2feb9ac85f67e85523118a6ce5a84/lib/appium_lib/ios/helper.rb#L86) ios +##### [get_page](https://github.com/appium/ruby_lib/blob/1e0f36e22833246873b6ecb8cc4d2bf3544de2c8/lib/appium_lib/ios/helper.rb#L93) ios -> def lazy_load_strings - - - --- - -##### [get_page](https://github.com/appium/ruby_lib/blob/c8f3041049c2feb9ac85f67e85523118a6ce5a84/lib/appium_lib/ios/helper.rb#L97) ios - > def get_page element=source_window(0) Returns a string of interesting elements. iOS only. Defaults to inspecting the 1st windows source only. @@ -316,11 +308,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[String] -- -##### [page](https://github.com/appium/ruby_lib/blob/c8f3041049c2feb9ac85f67e85523118a6ce5a84/lib/appium_lib/ios/helper.rb#L158) ios +##### [page](https://github.com/appium/ruby_lib/blob/1e0f36e22833246873b6ecb8cc4d2bf3544de2c8/lib/appium_lib/ios/helper.rb#L154) ios > def page Prints a string of interesting elements to the console. @@ -328,11 +320,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[void] -- -##### [source_window](https://github.com/appium/ruby_lib/blob/c8f3041049c2feb9ac85f67e85523118a6ce5a84/lib/appium_lib/ios/helper.rb#L166) ios +##### [source_window](https://github.com/appium/ruby_lib/blob/1e0f36e22833246873b6ecb8cc4d2bf3544de2c8/lib/appium_lib/ios/helper.rb#L162) ios > def source_window window_number=0 Gets the JSON source of window number @@ -344,11 +336,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[JSON] -- -##### [page_window](https://github.com/appium/ruby_lib/blob/c8f3041049c2feb9ac85f67e85523118a6ce5a84/lib/appium_lib/ios/helper.rb#L173) ios +##### [page_window](https://github.com/appium/ruby_lib/blob/1e0f36e22833246873b6ecb8cc4d2bf3544de2c8/lib/appium_lib/ios/helper.rb#L169) ios > def page_window window_number=0 Prints parsed page source to console. example: page_window 0 @@ -357,11 +349,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Integer] window_number - the int index of the target window -- -##### [fast_duration](https://github.com/appium/ruby_lib/blob/c8f3041049c2feb9ac85f67e85523118a6ce5a84/lib/appium_lib/ios/helper.rb#L180) ios +##### [fast_duration](https://github.com/appium/ruby_lib/blob/1e0f36e22833246873b6ecb8cc4d2bf3544de2c8/lib/appium_lib/ios/helper.rb#L176) ios > def fast_duration The fastest duration that can be used on iOS. @@ -369,11 +361,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Float] -- -##### [alert_click](https://github.com/appium/ruby_lib/blob/c8f3041049c2feb9ac85f67e85523118a6ce5a84/lib/appium_lib/ios/element/alert.rb#L14) ios +##### [alert_click](https://github.com/appium/ruby_lib/blob/1e0f36e22833246873b6ecb8cc4d2bf3544de2c8/lib/appium_lib/ios/element/alert.rb#L14) ios > def alert_click value iOS only Tap the alert button identified by value. @@ -392,11 +384,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[void] -- -##### [alert_text](https://github.com/appium/ruby_lib/blob/c8f3041049c2feb9ac85f67e85523118a6ce5a84/lib/appium_lib/ios/element/alert.rb#L21) ios +##### [alert_text](https://github.com/appium/ruby_lib/blob/1e0f36e22833246873b6ecb8cc4d2bf3544de2c8/lib/appium_lib/ios/element/alert.rb#L21) ios > def alert_text Get the alert message text. @@ -404,11 +396,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[String] -- -##### [alert_accept](https://github.com/appium/ruby_lib/blob/c8f3041049c2feb9ac85f67e85523118a6ce5a84/lib/appium_lib/ios/element/alert.rb#L30) ios +##### [alert_accept](https://github.com/appium/ruby_lib/blob/1e0f36e22833246873b6ecb8cc4d2bf3544de2c8/lib/appium_lib/ios/element/alert.rb#L30) ios > def alert_accept Accept the alert. @@ -416,11 +408,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[void] -- -##### [alert_accept_text](https://github.com/appium/ruby_lib/blob/c8f3041049c2feb9ac85f67e85523118a6ce5a84/lib/appium_lib/ios/element/alert.rb#L39) ios +##### [alert_accept_text](https://github.com/appium/ruby_lib/blob/1e0f36e22833246873b6ecb8cc4d2bf3544de2c8/lib/appium_lib/ios/element/alert.rb#L39) ios > def alert_accept_text Get the text of the alert's accept button. The last button is considered "accept." @@ -429,11 +421,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[String] -- -##### [alert_dismiss](https://github.com/appium/ruby_lib/blob/c8f3041049c2feb9ac85f67e85523118a6ce5a84/lib/appium_lib/ios/element/alert.rb#L48) ios +##### [alert_dismiss](https://github.com/appium/ruby_lib/blob/1e0f36e22833246873b6ecb8cc4d2bf3544de2c8/lib/appium_lib/ios/element/alert.rb#L48) ios > def alert_dismiss Dismiss the alert. @@ -441,11 +433,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[void] -- -##### [alert_dismiss_text](https://github.com/appium/ruby_lib/blob/c8f3041049c2feb9ac85f67e85523118a6ce5a84/lib/appium_lib/ios/element/alert.rb#L57) ios +##### [alert_dismiss_text](https://github.com/appium/ruby_lib/blob/1e0f36e22833246873b6ecb8cc4d2bf3544de2c8/lib/appium_lib/ios/element/alert.rb#L57) ios > def alert_dismiss_text Get the text of the alert's dismiss button. The first button is considered "dismiss." @@ -454,11 +446,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[String] -- -##### [find](https://github.com/appium/ruby_lib/blob/c8f3041049c2feb9ac85f67e85523118a6ce5a84/lib/appium_lib/ios/element/generic.rb#L61) ios +##### [find](https://github.com/appium/ruby_lib/blob/1e0f36e22833246873b6ecb8cc4d2bf3544de2c8/lib/appium_lib/ios/element/generic.rb#L61) ios > def find text Return the first element matching text. @@ -470,11 +462,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Element] the first matching element -- -##### [finds](https://github.com/appium/ruby_lib/blob/c8f3041049c2feb9ac85f67e85523118a6ce5a84/lib/appium_lib/ios/element/generic.rb#L83) ios +##### [finds](https://github.com/appium/ruby_lib/blob/1e0f36e22833246873b6ecb8cc4d2bf3544de2c8/lib/appium_lib/ios/element/generic.rb#L83) ios > def finds text Return all elements matching text. @@ -486,11 +478,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Array<Element>] all matching elements -- -##### [text](https://github.com/appium/ruby_lib/blob/c8f3041049c2feb9ac85f67e85523118a6ce5a84/lib/appium_lib/ios/element/generic.rb#L97) ios +##### [text](https://github.com/appium/ruby_lib/blob/1e0f36e22833246873b6ecb8cc4d2bf3544de2c8/lib/appium_lib/ios/element/generic.rb#L97) ios > def text text Return the first element matching text. @@ -502,11 +494,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Element] the first matching element -- -##### [texts](https://github.com/appium/ruby_lib/blob/c8f3041049c2feb9ac85f67e85523118a6ce5a84/lib/appium_lib/ios/element/generic.rb#L105) ios +##### [texts](https://github.com/appium/ruby_lib/blob/1e0f36e22833246873b6ecb8cc4d2bf3544de2c8/lib/appium_lib/ios/element/generic.rb#L105) ios > def texts text Return all elements matching text. @@ -518,11 +510,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Array<Element>] all matching elements -- -##### [name](https://github.com/appium/ruby_lib/blob/c8f3041049c2feb9ac85f67e85523118a6ce5a84/lib/appium_lib/ios/element/generic.rb#L117) ios +##### [name](https://github.com/appium/ruby_lib/blob/1e0f36e22833246873b6ecb8cc4d2bf3544de2c8/lib/appium_lib/ios/element/generic.rb#L117) ios > def name name Return the first element matching name. on Android name is content description @@ -536,11 +528,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Element] the first matching element -- -##### [names](https://github.com/appium/ruby_lib/blob/c8f3041049c2feb9ac85f67e85523118a6ce5a84/lib/appium_lib/ios/element/generic.rb#L126) ios +##### [names](https://github.com/appium/ruby_lib/blob/1e0f36e22833246873b6ecb8cc4d2bf3544de2c8/lib/appium_lib/ios/element/generic.rb#L126) ios > def names name Return all elements matching name. on Android name is content description @@ -554,11 +546,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Array<Element>] all matching elements -- -##### [textfields](https://github.com/appium/ruby_lib/blob/c8f3041049c2feb9ac85f67e85523118a6ce5a84/lib/appium_lib/ios/element/textfield.rb#L10) ios +##### [textfields](https://github.com/appium/ruby_lib/blob/1e0f36e22833246873b6ecb8cc4d2bf3544de2c8/lib/appium_lib/ios/element/textfield.rb#L10) ios > def textfields Get an array of textfield texts. @@ -566,11 +558,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Array<String>] -- -##### [e_textfields](https://github.com/appium/ruby_lib/blob/c8f3041049c2feb9ac85f67e85523118a6ce5a84/lib/appium_lib/ios/element/textfield.rb#L16) ios +##### [e_textfields](https://github.com/appium/ruby_lib/blob/1e0f36e22833246873b6ecb8cc4d2bf3544de2c8/lib/appium_lib/ios/element/textfield.rb#L16) ios > def e_textfields Get an array of textfield elements. @@ -578,11 +570,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Array<Textfield>] -- -##### [first_textfield](https://github.com/appium/ruby_lib/blob/c8f3041049c2feb9ac85f67e85523118a6ce5a84/lib/appium_lib/ios/element/textfield.rb#L22) ios +##### [first_textfield](https://github.com/appium/ruby_lib/blob/1e0f36e22833246873b6ecb8cc4d2bf3544de2c8/lib/appium_lib/ios/element/textfield.rb#L22) ios > def first_textfield Get the first textfield element. @@ -590,11 +582,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Textfield] -- -##### [last_textfield](https://github.com/appium/ruby_lib/blob/c8f3041049c2feb9ac85f67e85523118a6ce5a84/lib/appium_lib/ios/element/textfield.rb#L29) ios +##### [last_textfield](https://github.com/appium/ruby_lib/blob/1e0f36e22833246873b6ecb8cc4d2bf3544de2c8/lib/appium_lib/ios/element/textfield.rb#L29) ios > def last_textfield Get the last textfield element. @@ -602,11 +594,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Textfield] -- -##### [textfield](https://github.com/appium/ruby_lib/blob/c8f3041049c2feb9ac85f67e85523118a6ce5a84/lib/appium_lib/ios/element/textfield.rb#L37) ios +##### [textfield](https://github.com/appium/ruby_lib/blob/1e0f36e22833246873b6ecb8cc4d2bf3544de2c8/lib/appium_lib/ios/element/textfield.rb#L37) ios > def textfield text Get the first textfield that matches text. @@ -618,11 +610,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Textfield] -- -##### [textfield_include](https://github.com/appium/ruby_lib/blob/c8f3041049c2feb9ac85f67e85523118a6ce5a84/lib/appium_lib/ios/element/textfield.rb#L51) ios +##### [textfield_include](https://github.com/appium/ruby_lib/blob/1e0f36e22833246873b6ecb8cc4d2bf3544de2c8/lib/appium_lib/ios/element/textfield.rb#L51) ios > def textfield_include text Get the first textfield that includes text. @@ -634,11 +626,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Textfield] -- -##### [textfield_exact](https://github.com/appium/ruby_lib/blob/c8f3041049c2feb9ac85f67e85523118a6ce5a84/lib/appium_lib/ios/element/textfield.rb#L64) ios +##### [textfield_exact](https://github.com/appium/ruby_lib/blob/1e0f36e22833246873b6ecb8cc4d2bf3544de2c8/lib/appium_lib/ios/element/textfield.rb#L64) ios > def textfield_exact text Get the first textfield that exactly matches text. @@ -650,11 +642,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. @@ -677,19 +669,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. @@ -706,11 +698,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 @@ -722,11 +714,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. @@ -734,19 +726,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. @@ -758,11 +750,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. @@ -774,11 +766,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. @@ -792,11 +784,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 @@ -808,11 +800,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. @@ -826,11 +818,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. @@ -844,11 +836,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. @@ -864,11 +856,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. @@ -884,11 +876,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 @@ -903,11 +895,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 @@ -922,11 +914,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 @@ -938,11 +930,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 @@ -954,11 +946,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 @@ -966,11 +958,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 @@ -978,11 +970,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 @@ -994,11 +986,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 @@ -1010,11 +1002,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 @@ -1026,11 +1018,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 @@ -1038,41 +1030,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. @@ -1086,27 +1134,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 @@ -1119,11 +1167,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 @@ -1137,11 +1185,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 @@ -1150,131 +1198,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 @@ -1311,11 +1367,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 @@ -1337,11 +1393,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 @@ -1349,11 +1405,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. @@ -1361,11 +1417,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. @@ -1373,11 +1429,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 @@ -1385,11 +1441,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 @@ -1397,11 +1453,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. @@ -1415,11 +1471,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 @@ -1427,11 +1483,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. @@ -1439,19 +1495,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. @@ -1463,11 +1519,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. @@ -1489,11 +1545,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 @@ -1507,11 +1563,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 @@ -1533,11 +1589,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 @@ -1549,11 +1605,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 @@ -1565,10 +1621,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.