docs/ios_docs.md in appium_lib-0.17.0 vs docs/ios_docs.md in appium_lib-0.18.0

- old
+ new

@@ -1,6 +1,6 @@ -##### [s_texts](https://github.com/appium/ruby_lib/blob/b9264f66b9dd04eb5221c3a4c4ea17c4eb9ef8aa/lib/appium_lib/common/element/text.rb#L10) +##### [s_texts](https://github.com/appium/ruby_lib/blob/8571197b04ea923db6e375bae808bf84dea52c98/lib/appium_lib/common/element/text.rb#L10) > def s_texts text=nil Get an array of text texts if text is nil else Get all static textfields that include text. @@ -13,19 +13,19 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Array] -- -##### [s_texts_names](https://github.com/appium/ruby_lib/blob/b9264f66b9dd04eb5221c3a4c4ea17c4eb9ef8aa/lib/appium_lib/common/element/text.rb#L18) +##### [s_texts_names](https://github.com/appium/ruby_lib/blob/8571197b04ea923db6e375bae808bf84dea52c98/lib/appium_lib/common/element/text.rb#L18) > def s_texts_names -- -##### [e_s_texts](https://github.com/appium/ruby_lib/blob/b9264f66b9dd04eb5221c3a4c4ea17c4eb9ef8aa/lib/appium_lib/common/element/text.rb#L24) +##### [e_s_texts](https://github.com/appium/ruby_lib/blob/8571197b04ea923db6e375bae808bf84dea52c98/lib/appium_lib/common/element/text.rb#L24) > def e_s_texts Get an array of text elements. @@ -33,11 +33,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Array<Text>] -- -##### [first_s_text](https://github.com/appium/ruby_lib/blob/b9264f66b9dd04eb5221c3a4c4ea17c4eb9ef8aa/lib/appium_lib/common/element/text.rb#L30) +##### [first_s_text](https://github.com/appium/ruby_lib/blob/8571197b04ea923db6e375bae808bf84dea52c98/lib/appium_lib/common/element/text.rb#L30) > def first_s_text Get the first text element. @@ -45,11 +45,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Text] -- -##### [last_s_text](https://github.com/appium/ruby_lib/blob/b9264f66b9dd04eb5221c3a4c4ea17c4eb9ef8aa/lib/appium_lib/common/element/text.rb#L36) +##### [last_s_text](https://github.com/appium/ruby_lib/blob/8571197b04ea923db6e375bae808bf84dea52c98/lib/appium_lib/common/element/text.rb#L36) > def last_s_text Get the last text element @@ -57,11 +57,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Text] -- -##### [s_text](https://github.com/appium/ruby_lib/blob/b9264f66b9dd04eb5221c3a4c4ea17c4eb9ef8aa/lib/appium_lib/common/element/text.rb#L43) +##### [s_text](https://github.com/appium/ruby_lib/blob/8571197b04ea923db6e375bae808bf84dea52c98/lib/appium_lib/common/element/text.rb#L43) > def s_text text Get the first element that includes text. @@ -73,11 +73,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Text] -- -##### [s_text_exact](https://github.com/appium/ruby_lib/blob/b9264f66b9dd04eb5221c3a4c4ea17c4eb9ef8aa/lib/appium_lib/common/element/text.rb#L51) +##### [s_text_exact](https://github.com/appium/ruby_lib/blob/8571197b04ea923db6e375bae808bf84dea52c98/lib/appium_lib/common/element/text.rb#L51) > def s_text_exact text Get the first textfield that matches text. @@ -89,11 +89,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Text] -- -##### [s_texts_exact](https://github.com/appium/ruby_lib/blob/b9264f66b9dd04eb5221c3a4c4ea17c4eb9ef8aa/lib/appium_lib/common/element/text.rb#L58) +##### [s_texts_exact](https://github.com/appium/ruby_lib/blob/8571197b04ea923db6e375bae808bf84dea52c98/lib/appium_lib/common/element/text.rb#L58) > def s_texts_exact text Get all static textfields that matches text. @@ -105,19 +105,19 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Array<Text>] -- -##### [window_size](https://github.com/appium/ruby_lib/blob/b9264f66b9dd04eb5221c3a4c4ea17c4eb9ef8aa/lib/appium_lib/common/element/window.rb#L5) +##### [window_size](https://github.com/appium/ruby_lib/blob/8571197b04ea923db6e375bae808bf84dea52c98/lib/appium_lib/common/element/window.rb#L5) > def window_size Get the window's size -- -##### [button](https://github.com/appium/ruby_lib/blob/b9264f66b9dd04eb5221c3a4c4ea17c4eb9ef8aa/lib/appium_lib/common/element/button.rb#L8) +##### [button](https://github.com/appium/ruby_lib/blob/8571197b04ea923db6e375bae808bf84dea52c98/lib/appium_lib/common/element/button.rb#L8) > def button text, number=0 Find a button by text and optionally number. @@ -131,11 +131,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Button] the button found with text and matching number -- -##### [buttons](https://github.com/appium/ruby_lib/blob/b9264f66b9dd04eb5221c3a4c4ea17c4eb9ef8aa/lib/appium_lib/common/element/button.rb#L19) +##### [buttons](https://github.com/appium/ruby_lib/blob/8571197b04ea923db6e375bae808bf84dea52c98/lib/appium_lib/common/element/button.rb#L19) > def buttons text=nil Get an array of button texts or button elements if text is provided. @@ -147,11 +147,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Array<String>, Array<Buttons>] either an array of button texts or an array of button elements if text is provided. -- -##### [first_button](https://github.com/appium/ruby_lib/blob/b9264f66b9dd04eb5221c3a4c4ea17c4eb9ef8aa/lib/appium_lib/common/element/button.rb#L26) +##### [first_button](https://github.com/appium/ruby_lib/blob/8571197b04ea923db6e375bae808bf84dea52c98/lib/appium_lib/common/element/button.rb#L26) > def first_button Get the first button element. @@ -159,11 +159,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Button] -- -##### [last_button](https://github.com/appium/ruby_lib/blob/b9264f66b9dd04eb5221c3a4c4ea17c4eb9ef8aa/lib/appium_lib/common/element/button.rb#L32) +##### [last_button](https://github.com/appium/ruby_lib/blob/8571197b04ea923db6e375bae808bf84dea52c98/lib/appium_lib/common/element/button.rb#L32) > def last_button Get the last button element. @@ -171,11 +171,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Button] -- -##### [button_exact](https://github.com/appium/ruby_lib/blob/b9264f66b9dd04eb5221c3a4c4ea17c4eb9ef8aa/lib/appium_lib/common/element/button.rb#L39) +##### [button_exact](https://github.com/appium/ruby_lib/blob/8571197b04ea923db6e375bae808bf84dea52c98/lib/appium_lib/common/element/button.rb#L39) > def button_exact text Get the first button element that exactly matches text. @@ -187,11 +187,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Button] -- -##### [buttons_exact](https://github.com/appium/ruby_lib/blob/b9264f66b9dd04eb5221c3a4c4ea17c4eb9ef8aa/lib/appium_lib/common/element/button.rb#L46) +##### [buttons_exact](https://github.com/appium/ruby_lib/blob/8571197b04ea923db6e375bae808bf84dea52c98/lib/appium_lib/common/element/button.rb#L46) > def buttons_exact text Get all button elements that exactly match text. @@ -203,11 +203,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Array<Button>] -- -##### [e_buttons](https://github.com/appium/ruby_lib/blob/b9264f66b9dd04eb5221c3a4c4ea17c4eb9ef8aa/lib/appium_lib/common/element/button.rb#L52) +##### [e_buttons](https://github.com/appium/ruby_lib/blob/8571197b04ea923db6e375bae808bf84dea52c98/lib/appium_lib/common/element/button.rb#L52) > def e_buttons Get an array of button elements. @@ -215,11 +215,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Array<Button>] -- -##### [button_num](https://github.com/appium/ruby_lib/blob/b9264f66b9dd04eb5221c3a4c4ea17c4eb9ef8aa/lib/appium_lib/common/element/button.rb#L72) +##### [button_num](https://github.com/appium/ruby_lib/blob/8571197b04ea923db6e375bae808bf84dea52c98/lib/appium_lib/common/element/button.rb#L72) > def button_num text, number=1 Expected to be called via button method. @@ -244,11 +244,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Button] the button that matches text and number -- -##### [find_eles_attr](https://github.com/appium/ruby_lib/blob/b9264f66b9dd04eb5221c3a4c4ea17c4eb9ef8aa/lib/appium_lib/ios/helper.rb#L8) ios +##### [find_eles_attr](https://github.com/appium/ruby_lib/blob/8571197b04ea923db6e375bae808bf84dea52c98/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. @@ -263,11 +263,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/b9264f66b9dd04eb5221c3a4c4ea17c4eb9ef8aa/lib/appium_lib/ios/helper.rb#L29) ios +##### [find_2_eles_attr](https://github.com/appium/ruby_lib/blob/8571197b04ea923db6e375bae808bf84dea52c98/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. @@ -284,11 +284,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Array<String>] an array of strings containing the attribute from found elements of type tag_name. -- -##### [ios_password](https://github.com/appium/ruby_lib/blob/b9264f66b9dd04eb5221c3a4c4ea17c4eb9ef8aa/lib/appium_lib/ios/helper.rb#L50) ios +##### [ios_password](https://github.com/appium/ruby_lib/blob/8571197b04ea923db6e375bae808bf84dea52c98/lib/appium_lib/ios/helper.rb#L50) ios > def ios_password length=1 iOS only. On Android uiautomator always returns an empty string for EditText password. @@ -302,27 +302,27 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[String] the returned string is of size length -- -##### [get_page_class](https://github.com/appium/ruby_lib/blob/b9264f66b9dd04eb5221c3a4c4ea17c4eb9ef8aa/lib/appium_lib/ios/helper.rb#L55) ios +##### [get_page_class](https://github.com/appium/ruby_lib/blob/8571197b04ea923db6e375bae808bf84dea52c98/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/b9264f66b9dd04eb5221c3a4c4ea17c4eb9ef8aa/lib/appium_lib/ios/helper.rb#L81) ios +##### [page_class](https://github.com/appium/ruby_lib/blob/8571197b04ea923db6e375bae808bf84dea52c98/lib/appium_lib/ios/helper.rb#L81) ios > def page_class -- -##### [get_page](https://github.com/appium/ruby_lib/blob/b9264f66b9dd04eb5221c3a4c4ea17c4eb9ef8aa/lib/appium_lib/ios/helper.rb#L93) ios +##### [get_page](https://github.com/appium/ruby_lib/blob/8571197b04ea923db6e375bae808bf84dea52c98/lib/appium_lib/ios/helper.rb#L93) ios > def get_page element=source_window(0) Returns a string of interesting elements. iOS only. @@ -337,11 +337,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[String] -- -##### [page](https://github.com/appium/ruby_lib/blob/b9264f66b9dd04eb5221c3a4c4ea17c4eb9ef8aa/lib/appium_lib/ios/helper.rb#L161) ios +##### [page](https://github.com/appium/ruby_lib/blob/8571197b04ea923db6e375bae808bf84dea52c98/lib/appium_lib/ios/helper.rb#L161) ios > def page window_number = -1 Prints a string of interesting elements to the console. @@ -349,11 +349,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[void] -- -##### [source_window](https://github.com/appium/ruby_lib/blob/b9264f66b9dd04eb5221c3a4c4ea17c4eb9ef8aa/lib/appium_lib/ios/helper.rb#L176) ios +##### [source_window](https://github.com/appium/ruby_lib/blob/8571197b04ea923db6e375bae808bf84dea52c98/lib/appium_lib/ios/helper.rb#L176) ios > def source_window window_number=0 Gets the JSON source of window number @@ -365,11 +365,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[JSON] -- -##### [page_window](https://github.com/appium/ruby_lib/blob/b9264f66b9dd04eb5221c3a4c4ea17c4eb9ef8aa/lib/appium_lib/ios/helper.rb#L183) ios +##### [page_window](https://github.com/appium/ruby_lib/blob/8571197b04ea923db6e375bae808bf84dea52c98/lib/appium_lib/ios/helper.rb#L183) ios > def page_window window_number=0 Prints parsed page source to console. example: page_window 0 @@ -378,11 +378,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/b9264f66b9dd04eb5221c3a4c4ea17c4eb9ef8aa/lib/appium_lib/ios/helper.rb#L190) ios +##### [fast_duration](https://github.com/appium/ruby_lib/blob/8571197b04ea923db6e375bae808bf84dea52c98/lib/appium_lib/ios/helper.rb#L190) ios > def fast_duration The fastest duration that can be used on iOS. @@ -390,11 +390,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Float] -- -##### [id](https://github.com/appium/ruby_lib/blob/b9264f66b9dd04eb5221c3a4c4ea17c4eb9ef8aa/lib/appium_lib/ios/helper.rb#L197) ios +##### [id](https://github.com/appium/ruby_lib/blob/8571197b04ea923db6e375bae808bf84dea52c98/lib/appium_lib/ios/helper.rb#L197) ios > def id id Find by id. Useful for selendroid @@ -406,11 +406,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Element] -- -##### [ios_version](https://github.com/appium/ruby_lib/blob/b9264f66b9dd04eb5221c3a4c4ea17c4eb9ef8aa/lib/appium_lib/ios/helper.rb#L205) ios +##### [ios_version](https://github.com/appium/ruby_lib/blob/8571197b04ea923db6e375bae808bf84dea52c98/lib/appium_lib/ios/helper.rb#L205) ios > def ios_version Return the iOS version as an array of integers @@ -418,11 +418,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Array<Integer>] -- -##### [alert_click](https://github.com/appium/ruby_lib/blob/b9264f66b9dd04eb5221c3a4c4ea17c4eb9ef8aa/lib/appium_lib/ios/element/alert.rb#L14) ios +##### [alert_click](https://github.com/appium/ruby_lib/blob/8571197b04ea923db6e375bae808bf84dea52c98/lib/appium_lib/ios/element/alert.rb#L14) ios > def alert_click value iOS only Tap the alert button identified by value. @@ -441,11 +441,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[void] -- -##### [alert_text](https://github.com/appium/ruby_lib/blob/b9264f66b9dd04eb5221c3a4c4ea17c4eb9ef8aa/lib/appium_lib/ios/element/alert.rb#L21) ios +##### [alert_text](https://github.com/appium/ruby_lib/blob/8571197b04ea923db6e375bae808bf84dea52c98/lib/appium_lib/ios/element/alert.rb#L21) ios > def alert_text Get the alert message text. @@ -453,11 +453,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[String] -- -##### [alert_accept](https://github.com/appium/ruby_lib/blob/b9264f66b9dd04eb5221c3a4c4ea17c4eb9ef8aa/lib/appium_lib/ios/element/alert.rb#L30) ios +##### [alert_accept](https://github.com/appium/ruby_lib/blob/8571197b04ea923db6e375bae808bf84dea52c98/lib/appium_lib/ios/element/alert.rb#L30) ios > def alert_accept Accept the alert. @@ -465,11 +465,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[void] -- -##### [alert_accept_text](https://github.com/appium/ruby_lib/blob/b9264f66b9dd04eb5221c3a4c4ea17c4eb9ef8aa/lib/appium_lib/ios/element/alert.rb#L40) ios +##### [alert_accept_text](https://github.com/appium/ruby_lib/blob/8571197b04ea923db6e375bae808bf84dea52c98/lib/appium_lib/ios/element/alert.rb#L40) ios > def alert_accept_text Get the text of the alert's accept button. The last button is considered "accept." on iOS 6 @@ -479,11 +479,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[String] -- -##### [alert_dismiss](https://github.com/appium/ruby_lib/blob/b9264f66b9dd04eb5221c3a4c4ea17c4eb9ef8aa/lib/appium_lib/ios/element/alert.rb#L64) ios +##### [alert_dismiss](https://github.com/appium/ruby_lib/blob/8571197b04ea923db6e375bae808bf84dea52c98/lib/appium_lib/ios/element/alert.rb#L64) ios > def alert_dismiss Dismiss the alert. @@ -491,11 +491,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[void] -- -##### [alert_dismiss_text](https://github.com/appium/ruby_lib/blob/b9264f66b9dd04eb5221c3a4c4ea17c4eb9ef8aa/lib/appium_lib/ios/element/alert.rb#L74) ios +##### [alert_dismiss_text](https://github.com/appium/ruby_lib/blob/8571197b04ea923db6e375bae808bf84dea52c98/lib/appium_lib/ios/element/alert.rb#L74) ios > def alert_dismiss_text Get the text of the alert's dismiss button. The first button is considered "dismiss." on iOS 6 @@ -505,11 +505,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[String] -- -##### [find](https://github.com/appium/ruby_lib/blob/b9264f66b9dd04eb5221c3a4c4ea17c4eb9ef8aa/lib/appium_lib/ios/element/generic.rb#L61) ios +##### [find](https://github.com/appium/ruby_lib/blob/8571197b04ea923db6e375bae808bf84dea52c98/lib/appium_lib/ios/element/generic.rb#L61) ios > def find text Return the first element matching text. @@ -521,11 +521,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Element] the first matching element -- -##### [finds](https://github.com/appium/ruby_lib/blob/b9264f66b9dd04eb5221c3a4c4ea17c4eb9ef8aa/lib/appium_lib/ios/element/generic.rb#L83) ios +##### [finds](https://github.com/appium/ruby_lib/blob/8571197b04ea923db6e375bae808bf84dea52c98/lib/appium_lib/ios/element/generic.rb#L83) ios > def finds text Return all elements matching text. @@ -537,11 +537,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Array<Element>] all matching elements -- -##### [text](https://github.com/appium/ruby_lib/blob/b9264f66b9dd04eb5221c3a4c4ea17c4eb9ef8aa/lib/appium_lib/ios/element/generic.rb#L97) ios +##### [text](https://github.com/appium/ruby_lib/blob/8571197b04ea923db6e375bae808bf84dea52c98/lib/appium_lib/ios/element/generic.rb#L97) ios > def text text Return the first element matching text. @@ -553,11 +553,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Element] the first matching element -- -##### [texts](https://github.com/appium/ruby_lib/blob/b9264f66b9dd04eb5221c3a4c4ea17c4eb9ef8aa/lib/appium_lib/ios/element/generic.rb#L105) ios +##### [texts](https://github.com/appium/ruby_lib/blob/8571197b04ea923db6e375bae808bf84dea52c98/lib/appium_lib/ios/element/generic.rb#L105) ios > def texts text Return all elements matching text. @@ -569,11 +569,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Array<Element>] all matching elements -- -##### [name](https://github.com/appium/ruby_lib/blob/b9264f66b9dd04eb5221c3a4c4ea17c4eb9ef8aa/lib/appium_lib/ios/element/generic.rb#L117) ios +##### [name](https://github.com/appium/ruby_lib/blob/8571197b04ea923db6e375bae808bf84dea52c98/lib/appium_lib/ios/element/generic.rb#L117) ios > def name name Return the first element matching name. on Android name is content description @@ -587,19 +587,19 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Element] the first matching element -- -##### [name_exact](https://github.com/appium/ruby_lib/blob/b9264f66b9dd04eb5221c3a4c4ea17c4eb9ef8aa/lib/appium_lib/ios/element/generic.rb#L121) ios +##### [name_exact](https://github.com/appium/ruby_lib/blob/8571197b04ea923db6e375bae808bf84dea52c98/lib/appium_lib/ios/element/generic.rb#L121) ios > def name_exact name -- -##### [names](https://github.com/appium/ruby_lib/blob/b9264f66b9dd04eb5221c3a4c4ea17c4eb9ef8aa/lib/appium_lib/ios/element/generic.rb#L139) ios +##### [names](https://github.com/appium/ruby_lib/blob/8571197b04ea923db6e375bae808bf84dea52c98/lib/appium_lib/ios/element/generic.rb#L139) ios > def names name Return all elements matching name. on Android name is content description @@ -613,22 +613,22 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Array<Element>] all matching elements -- -##### [locate_single_textfield](https://github.com/appium/ruby_lib/blob/b9264f66b9dd04eb5221c3a4c4ea17c4eb9ef8aa/lib/appium_lib/ios/element/textfield.rb#L8) ios +##### [locate_single_textfield](https://github.com/appium/ruby_lib/blob/8571197b04ea923db6e375bae808bf84dea52c98/lib/appium_lib/ios/element/textfield.rb#L8) ios > def locate_single_textfield js UIATextField & UIASecureTextField methods Find textfield and then secure elements in one server call to match Android. -- -##### [textfields](https://github.com/appium/ruby_lib/blob/b9264f66b9dd04eb5221c3a4c4ea17c4eb9ef8aa/lib/appium_lib/ios/element/textfield.rb#L18) ios +##### [textfields](https://github.com/appium/ruby_lib/blob/8571197b04ea923db6e375bae808bf84dea52c98/lib/appium_lib/ios/element/textfield.rb#L18) ios > def textfields Get an array of textfield texts. Does not respect implicit wait because we're using execute_script. @@ -637,11 +637,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Array<String>] -- -##### [e_textfields](https://github.com/appium/ruby_lib/blob/b9264f66b9dd04eb5221c3a4c4ea17c4eb9ef8aa/lib/appium_lib/ios/element/textfield.rb#L24) ios +##### [e_textfields](https://github.com/appium/ruby_lib/blob/8571197b04ea923db6e375bae808bf84dea52c98/lib/appium_lib/ios/element/textfield.rb#L24) ios > def e_textfields Get an array of textfield elements. @@ -649,11 +649,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Array<Textfield>] -- -##### [first_textfield](https://github.com/appium/ruby_lib/blob/b9264f66b9dd04eb5221c3a4c4ea17c4eb9ef8aa/lib/appium_lib/ios/element/textfield.rb#L30) ios +##### [first_textfield](https://github.com/appium/ruby_lib/blob/8571197b04ea923db6e375bae808bf84dea52c98/lib/appium_lib/ios/element/textfield.rb#L30) ios > def first_textfield Get the first textfield element. @@ -661,11 +661,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Textfield] -- -##### [last_textfield](https://github.com/appium/ruby_lib/blob/b9264f66b9dd04eb5221c3a4c4ea17c4eb9ef8aa/lib/appium_lib/ios/element/textfield.rb#L36) ios +##### [last_textfield](https://github.com/appium/ruby_lib/blob/8571197b04ea923db6e375bae808bf84dea52c98/lib/appium_lib/ios/element/textfield.rb#L36) ios > def last_textfield Get the last textfield element. @@ -673,11 +673,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Textfield] -- -##### [textfield](https://github.com/appium/ruby_lib/blob/b9264f66b9dd04eb5221c3a4c4ea17c4eb9ef8aa/lib/appium_lib/ios/element/textfield.rb#L43) ios +##### [textfield](https://github.com/appium/ruby_lib/blob/8571197b04ea923db6e375bae808bf84dea52c98/lib/appium_lib/ios/element/textfield.rb#L43) ios > def textfield text Get the first textfield that matches text. @@ -689,11 +689,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Textfield] -- -##### [textfield_include](https://github.com/appium/ruby_lib/blob/b9264f66b9dd04eb5221c3a4c4ea17c4eb9ef8aa/lib/appium_lib/ios/element/textfield.rb#L57) ios +##### [textfield_include](https://github.com/appium/ruby_lib/blob/8571197b04ea923db6e375bae808bf84dea52c98/lib/appium_lib/ios/element/textfield.rb#L57) ios > def textfield_include text Get the first textfield that includes text. @@ -705,11 +705,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Textfield] -- -##### [textfield_exact](https://github.com/appium/ruby_lib/blob/b9264f66b9dd04eb5221c3a4c4ea17c4eb9ef8aa/lib/appium_lib/ios/element/textfield.rb#L64) ios +##### [textfield_exact](https://github.com/appium/ruby_lib/blob/8571197b04ea923db6e375bae808bf84dea52c98/lib/appium_lib/ios/element/textfield.rb#L64) ios > def textfield_exact text Get the first textfield that exactly matches text. @@ -721,11 +721,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Textfield] -- -##### [textfield_named](https://github.com/appium/ruby_lib/blob/b9264f66b9dd04eb5221c3a4c4ea17c4eb9ef8aa/lib/appium_lib/ios/element/textfield.rb#L70) ios +##### [textfield_named](https://github.com/appium/ruby_lib/blob/8571197b04ea923db6e375bae808bf84dea52c98/lib/appium_lib/ios/element/textfield.rb#L70) ios > def textfield_named target_name Get the first textfield that exactly matches name @@ -733,11 +733,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Element] -- -##### [wait](https://github.com/appium/ruby_lib/blob/b9264f66b9dd04eb5221c3a4c4ea17c4eb9ef8aa/lib/appium_lib/common/helper.rb#L33) +##### [wait](https://github.com/appium/ruby_lib/blob/8571197b04ea923db6e375bae808bf84dea52c98/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. @@ -760,19 +760,19 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Object] the result of block.call -- -##### [ignore](https://github.com/appium/ruby_lib/blob/b9264f66b9dd04eb5221c3a4c4ea17c4eb9ef8aa/lib/appium_lib/common/helper.rb#L45) +##### [ignore](https://github.com/appium/ruby_lib/blob/8571197b04ea923db6e375bae808bf84dea52c98/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/b9264f66b9dd04eb5221c3a4c4ea17c4eb9ef8aa/lib/appium_lib/common/helper.rb#L55) +##### [wait_true](https://github.com/appium/ruby_lib/blob/8571197b04ea923db6e375bae808bf84dea52c98/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. @@ -789,11 +789,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Object] the result of block.call -- -##### [back](https://github.com/appium/ruby_lib/blob/b9264f66b9dd04eb5221c3a4c4ea17c4eb9ef8aa/lib/appium_lib/common/helper.rb#L68) +##### [back](https://github.com/appium/ruby_lib/blob/8571197b04ea923db6e375bae808bf84dea52c98/lib/appium_lib/common/helper.rb#L68) > def back Navigate back. @@ -801,19 +801,19 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[void] -- -##### [session_id](https://github.com/appium/ruby_lib/blob/b9264f66b9dd04eb5221c3a4c4ea17c4eb9ef8aa/lib/appium_lib/common/helper.rb#L73) +##### [session_id](https://github.com/appium/ruby_lib/blob/8571197b04ea923db6e375bae808bf84dea52c98/lib/appium_lib/common/helper.rb#L73) > def session_id For Sauce Labs reporting. Returns the current session id. -- -##### [xpath](https://github.com/appium/ruby_lib/blob/b9264f66b9dd04eb5221c3a4c4ea17c4eb9ef8aa/lib/appium_lib/common/helper.rb#L81) +##### [xpath](https://github.com/appium/ruby_lib/blob/8571197b04ea923db6e375bae808bf84dea52c98/lib/appium_lib/common/helper.rb#L81) > def xpath xpath_str Returns the first element that matches the provided xpath. @@ -825,11 +825,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Element] -- -##### [xpaths](https://github.com/appium/ruby_lib/blob/b9264f66b9dd04eb5221c3a4c4ea17c4eb9ef8aa/lib/appium_lib/common/helper.rb#L89) +##### [xpaths](https://github.com/appium/ruby_lib/blob/8571197b04ea923db6e375bae808bf84dea52c98/lib/appium_lib/common/helper.rb#L89) > def xpaths xpath_str Returns all elements that match the provided xpath. @@ -841,11 +841,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Array<Element>] -- -##### [ele_index](https://github.com/appium/ruby_lib/blob/b9264f66b9dd04eb5221c3a4c4ea17c4eb9ef8aa/lib/appium_lib/common/helper.rb#L97) +##### [ele_index](https://github.com/appium/ruby_lib/blob/8571197b04ea923db6e375bae808bf84dea52c98/lib/appium_lib/common/helper.rb#L97) > def ele_index tag_name, index Get the element of type tag_name at matching index. @@ -859,11 +859,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Element] the found element of type tag_name -- -##### [find_eles](https://github.com/appium/ruby_lib/blob/b9264f66b9dd04eb5221c3a4c4ea17c4eb9ef8aa/lib/appium_lib/common/helper.rb#L106) +##### [find_eles](https://github.com/appium/ruby_lib/blob/8571197b04ea923db6e375bae808bf84dea52c98/lib/appium_lib/common/helper.rb#L106) > def find_eles tag_name Get all elements exactly matching tag name @@ -875,11 +875,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/b9264f66b9dd04eb5221c3a4c4ea17c4eb9ef8aa/lib/appium_lib/common/helper.rb#L114) +##### [find_ele_by_text](https://github.com/appium/ruby_lib/blob/8571197b04ea923db6e375bae808bf84dea52c98/lib/appium_lib/common/helper.rb#L114) > def find_ele_by_text tag, text Get the first tag that exactly matches tag and text. @@ -893,11 +893,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/b9264f66b9dd04eb5221c3a4c4ea17c4eb9ef8aa/lib/appium_lib/common/helper.rb#L122) +##### [find_eles_by_text](https://github.com/appium/ruby_lib/blob/8571197b04ea923db6e375bae808bf84dea52c98/lib/appium_lib/common/helper.rb#L122) > def find_eles_by_text tag, text Get all tags that exactly match tag and text. @@ -911,11 +911,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/b9264f66b9dd04eb5221c3a4c4ea17c4eb9ef8aa/lib/appium_lib/common/helper.rb#L131) +##### [find_ele_by_attr_include](https://github.com/appium/ruby_lib/blob/8571197b04ea923db6e375bae808bf84dea52c98/lib/appium_lib/common/helper.rb#L131) > def find_ele_by_attr_include tag, attr, value Get the first tag by attribute that exactly matches value. @@ -931,11 +931,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/b9264f66b9dd04eb5221c3a4c4ea17c4eb9ef8aa/lib/appium_lib/common/helper.rb#L140) +##### [find_eles_by_attr_include](https://github.com/appium/ruby_lib/blob/8571197b04ea923db6e375bae808bf84dea52c98/lib/appium_lib/common/helper.rb#L140) > def find_eles_by_attr_include tag, attr, value Get tags by attribute that include value. @@ -951,11 +951,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/b9264f66b9dd04eb5221c3a4c4ea17c4eb9ef8aa/lib/appium_lib/common/helper.rb#L149) +##### [find_ele_by_text_include](https://github.com/appium/ruby_lib/blob/8571197b04ea923db6e375bae808bf84dea52c98/lib/appium_lib/common/helper.rb#L149) > def find_ele_by_text_include tag, text Get the first tag that includes text. element.attribute(:text).include? text @@ -970,11 +970,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/b9264f66b9dd04eb5221c3a4c4ea17c4eb9ef8aa/lib/appium_lib/common/helper.rb#L158) +##### [find_eles_by_text_include](https://github.com/appium/ruby_lib/blob/8571197b04ea923db6e375bae808bf84dea52c98/lib/appium_lib/common/helper.rb#L158) > def find_eles_by_text_include tag, text Get the tags that include text. element.attribute(:text).include? text @@ -989,11 +989,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/b9264f66b9dd04eb5221c3a4c4ea17c4eb9ef8aa/lib/appium_lib/common/helper.rb#L165) +##### [first_ele](https://github.com/appium/ruby_lib/blob/8571197b04ea923db6e375bae808bf84dea52c98/lib/appium_lib/common/helper.rb#L165) > def first_ele tag_name Get the first tag that matches tag_name @@ -1005,11 +1005,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Element] -- -##### [last_ele](https://github.com/appium/ruby_lib/blob/b9264f66b9dd04eb5221c3a4c4ea17c4eb9ef8aa/lib/appium_lib/common/helper.rb#L173) +##### [last_ele](https://github.com/appium/ruby_lib/blob/8571197b04ea923db6e375bae808bf84dea52c98/lib/appium_lib/common/helper.rb#L173) > def last_ele tag_name Get the last tag that matches tag_name @@ -1021,11 +1021,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Element] -- -##### [source](https://github.com/appium/ruby_lib/blob/b9264f66b9dd04eb5221c3a4c4ea17c4eb9ef8aa/lib/appium_lib/common/helper.rb#L179) +##### [source](https://github.com/appium/ruby_lib/blob/8571197b04ea923db6e375bae808bf84dea52c98/lib/appium_lib/common/helper.rb#L179) > def source Prints a JSON view of the current page @@ -1033,11 +1033,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[void] -- -##### [get_source](https://github.com/appium/ruby_lib/blob/b9264f66b9dd04eb5221c3a4c4ea17c4eb9ef8aa/lib/appium_lib/common/helper.rb#L185) +##### [get_source](https://github.com/appium/ruby_lib/blob/8571197b04ea923db6e375bae808bf84dea52c98/lib/appium_lib/common/helper.rb#L185) > def get_source Gets a JSON view of the current page @@ -1045,11 +1045,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[JSON] -- -##### [find_name](https://github.com/appium/ruby_lib/blob/b9264f66b9dd04eb5221c3a4c4ea17c4eb9ef8aa/lib/appium_lib/common/helper.rb#L194) +##### [find_name](https://github.com/appium/ruby_lib/blob/8571197b04ea923db6e375bae808bf84dea52c98/lib/appium_lib/common/helper.rb#L194) > def find_name name Returns the first element that exactly matches name @@ -1061,11 +1061,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Element] -- -##### [find_names](https://github.com/appium/ruby_lib/blob/b9264f66b9dd04eb5221c3a4c4ea17c4eb9ef8aa/lib/appium_lib/common/helper.rb#L202) +##### [find_names](https://github.com/appium/ruby_lib/blob/8571197b04ea923db6e375bae808bf84dea52c98/lib/appium_lib/common/helper.rb#L202) > def find_names name Returns all elements that exactly match name @@ -1077,11 +1077,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Array<Element>] -- -##### [tag](https://github.com/appium/ruby_lib/blob/b9264f66b9dd04eb5221c3a4c4ea17c4eb9ef8aa/lib/appium_lib/common/helper.rb#L210) +##### [tag](https://github.com/appium/ruby_lib/blob/8571197b04ea923db6e375bae808bf84dea52c98/lib/appium_lib/common/helper.rb#L210) > def tag tag_name Returns the first element matching tag_name @@ -1093,11 +1093,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Element] -- -##### [tags](https://github.com/appium/ruby_lib/blob/b9264f66b9dd04eb5221c3a4c4ea17c4eb9ef8aa/lib/appium_lib/common/helper.rb#L218) +##### [tags](https://github.com/appium/ruby_lib/blob/8571197b04ea923db6e375bae808bf84dea52c98/lib/appium_lib/common/helper.rb#L218) > def tags tag_name Returns all elements matching tag_name @@ -1109,11 +1109,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Element] -- -##### [px_to_window_rel](https://github.com/appium/ruby_lib/blob/b9264f66b9dd04eb5221c3a4c4ea17c4eb9ef8aa/lib/appium_lib/common/helper.rb#L228) +##### [px_to_window_rel](https://github.com/appium/ruby_lib/blob/8571197b04ea923db6e375bae808bf84dea52c98/lib/appium_lib/common/helper.rb#L228) > def px_to_window_rel opts={} Converts pixel values to window relative values @@ -1121,19 +1121,19 @@ px_to_window_rel x: 50, y: 150 ``` -- -##### [lazy_load_strings](https://github.com/appium/ruby_lib/blob/b9264f66b9dd04eb5221c3a4c4ea17c4eb9ef8aa/lib/appium_lib/common/helper.rb#L238) +##### [lazy_load_strings](https://github.com/appium/ruby_lib/blob/8571197b04ea923db6e375bae808bf84dea52c98/lib/appium_lib/common/helper.rb#L238) > def lazy_load_strings -- -##### [xml_keys](https://github.com/appium/ruby_lib/blob/b9264f66b9dd04eb5221c3a4c4ea17c4eb9ef8aa/lib/appium_lib/common/helper.rb#L245) +##### [xml_keys](https://github.com/appium/ruby_lib/blob/8571197b04ea923db6e375bae808bf84dea52c98/lib/appium_lib/common/helper.rb#L245) > def xml_keys target Search strings.xml's values for target. @@ -1145,11 +1145,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Array] -- -##### [xml_values](https://github.com/appium/ruby_lib/blob/b9264f66b9dd04eb5221c3a4c4ea17c4eb9ef8aa/lib/appium_lib/common/helper.rb#L253) +##### [xml_values](https://github.com/appium/ruby_lib/blob/8571197b04ea923db6e375bae808bf84dea52c98/lib/appium_lib/common/helper.rb#L253) > def xml_values target Search strings.xml's keys for target. @@ -1161,11 +1161,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Array] -- -##### [resolve_id](https://github.com/appium/ruby_lib/blob/b9264f66b9dd04eb5221c3a4c4ea17c4eb9ef8aa/lib/appium_lib/common/helper.rb#L261) +##### [resolve_id](https://github.com/appium/ruby_lib/blob/8571197b04ea923db6e375bae808bf84dea52c98/lib/appium_lib/common/helper.rb#L261) > def resolve_id id Resolve id in strings.xml and return the value. @@ -1177,49 +1177,49 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[String] -- -##### [raise_no_element_error](https://github.com/appium/ruby_lib/blob/b9264f66b9dd04eb5221c3a4c4ea17c4eb9ef8aa/lib/appium_lib/common/helper.rb#L267) +##### [raise_no_element_error](https://github.com/appium/ruby_lib/blob/8571197b04ea923db6e375bae808bf84dea52c98/lib/appium_lib/common/helper.rb#L267) > def raise_no_element_error Used to error when finding a single element fails. -- -##### [value](https://github.com/appium/ruby_lib/blob/b9264f66b9dd04eb5221c3a4c4ea17c4eb9ef8aa/lib/appium_lib/common/patch.rb#L32) +##### [value](https://github.com/appium/ruby_lib/blob/8571197b04ea923db6e375bae808bf84dea52c98/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/b9264f66b9dd04eb5221c3a4c4ea17c4eb9ef8aa/lib/appium_lib/common/patch.rb#L39) +##### [name](https://github.com/appium/ruby_lib/blob/8571197b04ea923db6e375bae808bf84dea52c98/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/b9264f66b9dd04eb5221c3a4c4ea17c4eb9ef8aa/lib/appium_lib/common/patch.rb#L46) +##### [tag_name](https://github.com/appium/ruby_lib/blob/8571197b04ea923db6e375bae808bf84dea52c98/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/b9264f66b9dd04eb5221c3a4c4ea17c4eb9ef8aa/lib/appium_lib/common/patch.rb#L58) +##### [location_rel](https://github.com/appium/ruby_lib/blob/8571197b04ea923db6e375bae808bf84dea52c98/lib/appium_lib/common/patch.rb#L58) > def location_rel For use with mobile tap. @@ -1233,27 +1233,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/b9264f66b9dd04eb5221c3a4c4ea17c4eb9ef8aa/lib/appium_lib/driver.rb#L16) +##### [CORE](https://github.com/appium/ruby_lib/blob/8571197b04ea923db6e375bae808bf84dea52c98/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/b9264f66b9dd04eb5221c3a4c4ea17c4eb9ef8aa/lib/appium_lib/driver.rb#L18) +##### [awesome_openstruct](https://github.com/appium/ruby_lib/blob/8571197b04ea923db6e375bae808bf84dea52c98/lib/appium_lib/driver.rb#L18) > def awesome_openstruct target -- -##### [load_appium_txt](https://github.com/appium/ruby_lib/blob/b9264f66b9dd04eb5221c3a4c4ea17c4eb9ef8aa/lib/appium_lib/driver.rb#L28) +##### [load_appium_txt](https://github.com/appium/ruby_lib/blob/8571197b04ea923db6e375bae808bf84dea52c98/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 @@ -1266,19 +1266,19 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Array<String>] the require files. nil if require doesn't exist -- -##### [promote_singleton_appium_methods](https://github.com/appium/ruby_lib/blob/b9264f66b9dd04eb5221c3a4c4ea17c4eb9ef8aa/lib/appium_lib/driver.rb#L154) +##### [promote_singleton_appium_methods](https://github.com/appium/ruby_lib/blob/8571197b04ea923db6e375bae808bf84dea52c98/lib/appium_lib/driver.rb#L156) > def self.promote_singleton_appium_methods main_module -- -##### [promote_appium_methods](https://github.com/appium/ruby_lib/blob/b9264f66b9dd04eb5221c3a4c4ea17c4eb9ef8aa/lib/appium_lib/driver.rb#L184) +##### [promote_appium_methods](https://github.com/appium/ruby_lib/blob/8571197b04ea923db6e375bae808bf84dea52c98/lib/appium_lib/driver.rb#L186) > def self.promote_appium_methods class_array Promote appium methods to class instance methods @@ -1292,11 +1292,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Array<Class>] class_array - An array of classes -- -##### [default_wait](https://github.com/appium/ruby_lib/blob/b9264f66b9dd04eb5221c3a4c4ea17c4eb9ef8aa/lib/appium_lib/driver.rb#L538) +##### [default_wait](https://github.com/appium/ruby_lib/blob/8571197b04ea923db6e375bae808bf84dea52c98/lib/appium_lib/driver.rb#L544) > def default_wait Returns the default client side wait. This value is independent of what the server is using @@ -1305,139 +1305,139 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Integer] -- -##### [app_path](https://github.com/appium/ruby_lib/blob/b9264f66b9dd04eb5221c3a4c4ea17c4eb9ef8aa/lib/appium_lib/driver.rb#L213) +##### [app_path](https://github.com/appium/ruby_lib/blob/8571197b04ea923db6e375bae808bf84dea52c98/lib/appium_lib/driver.rb#L215) > def app_path Returns the value of attribute app_path -- -##### [app_name](https://github.com/appium/ruby_lib/blob/b9264f66b9dd04eb5221c3a4c4ea17c4eb9ef8aa/lib/appium_lib/driver.rb#L213) +##### [app_name](https://github.com/appium/ruby_lib/blob/8571197b04ea923db6e375bae808bf84dea52c98/lib/appium_lib/driver.rb#L215) > def app_name Returns the value of attribute app_name -- -##### [device](https://github.com/appium/ruby_lib/blob/b9264f66b9dd04eb5221c3a4c4ea17c4eb9ef8aa/lib/appium_lib/driver.rb#L213) +##### [device](https://github.com/appium/ruby_lib/blob/8571197b04ea923db6e375bae808bf84dea52c98/lib/appium_lib/driver.rb#L215) > def device Returns the value of attribute device -- -##### [app_package](https://github.com/appium/ruby_lib/blob/b9264f66b9dd04eb5221c3a4c4ea17c4eb9ef8aa/lib/appium_lib/driver.rb#L213) +##### [app_package](https://github.com/appium/ruby_lib/blob/8571197b04ea923db6e375bae808bf84dea52c98/lib/appium_lib/driver.rb#L215) > def app_package Returns the value of attribute app_package -- -##### [app_activity](https://github.com/appium/ruby_lib/blob/b9264f66b9dd04eb5221c3a4c4ea17c4eb9ef8aa/lib/appium_lib/driver.rb#L213) +##### [app_activity](https://github.com/appium/ruby_lib/blob/8571197b04ea923db6e375bae808bf84dea52c98/lib/appium_lib/driver.rb#L215) > def app_activity Returns the value of attribute app_activity -- -##### [app_wait_activity](https://github.com/appium/ruby_lib/blob/b9264f66b9dd04eb5221c3a4c4ea17c4eb9ef8aa/lib/appium_lib/driver.rb#L213) +##### [app_wait_activity](https://github.com/appium/ruby_lib/blob/8571197b04ea923db6e375bae808bf84dea52c98/lib/appium_lib/driver.rb#L215) > def app_wait_activity Returns the value of attribute app_wait_activity -- -##### [sauce_username](https://github.com/appium/ruby_lib/blob/b9264f66b9dd04eb5221c3a4c4ea17c4eb9ef8aa/lib/appium_lib/driver.rb#L213) +##### [sauce_username](https://github.com/appium/ruby_lib/blob/8571197b04ea923db6e375bae808bf84dea52c98/lib/appium_lib/driver.rb#L215) > def sauce_username Returns the value of attribute sauce_username -- -##### [sauce_access_key](https://github.com/appium/ruby_lib/blob/b9264f66b9dd04eb5221c3a4c4ea17c4eb9ef8aa/lib/appium_lib/driver.rb#L213) +##### [sauce_access_key](https://github.com/appium/ruby_lib/blob/8571197b04ea923db6e375bae808bf84dea52c98/lib/appium_lib/driver.rb#L215) > def sauce_access_key Returns the value of attribute sauce_access_key -- -##### [port](https://github.com/appium/ruby_lib/blob/b9264f66b9dd04eb5221c3a4c4ea17c4eb9ef8aa/lib/appium_lib/driver.rb#L213) +##### [port](https://github.com/appium/ruby_lib/blob/8571197b04ea923db6e375bae808bf84dea52c98/lib/appium_lib/driver.rb#L215) > def port Returns the value of attribute port -- -##### [debug](https://github.com/appium/ruby_lib/blob/b9264f66b9dd04eb5221c3a4c4ea17c4eb9ef8aa/lib/appium_lib/driver.rb#L213) +##### [debug](https://github.com/appium/ruby_lib/blob/8571197b04ea923db6e375bae808bf84dea52c98/lib/appium_lib/driver.rb#L215) > def debug Returns the value of attribute debug -- -##### [export_session](https://github.com/appium/ruby_lib/blob/b9264f66b9dd04eb5221c3a4c4ea17c4eb9ef8aa/lib/appium_lib/driver.rb#L213) +##### [export_session](https://github.com/appium/ruby_lib/blob/8571197b04ea923db6e375bae808bf84dea52c98/lib/appium_lib/driver.rb#L215) > def export_session Returns the value of attribute export_session -- -##### [device_cap](https://github.com/appium/ruby_lib/blob/b9264f66b9dd04eb5221c3a4c4ea17c4eb9ef8aa/lib/appium_lib/driver.rb#L213) +##### [device_cap](https://github.com/appium/ruby_lib/blob/8571197b04ea923db6e375bae808bf84dea52c98/lib/appium_lib/driver.rb#L215) > def device_cap Returns the value of attribute device_cap -- -##### [compress_xml](https://github.com/appium/ruby_lib/blob/b9264f66b9dd04eb5221c3a4c4ea17c4eb9ef8aa/lib/appium_lib/driver.rb#L213) +##### [compress_xml](https://github.com/appium/ruby_lib/blob/8571197b04ea923db6e375bae808bf84dea52c98/lib/appium_lib/driver.rb#L215) > def compress_xml Returns the value of attribute compress_xml -- -##### [custom_url](https://github.com/appium/ruby_lib/blob/b9264f66b9dd04eb5221c3a4c4ea17c4eb9ef8aa/lib/appium_lib/driver.rb#L213) +##### [custom_url](https://github.com/appium/ruby_lib/blob/8571197b04ea923db6e375bae808bf84dea52c98/lib/appium_lib/driver.rb#L215) > def custom_url Returns the value of attribute custom_url -- -##### [global_webdriver_http_sleep](https://github.com/appium/ruby_lib/blob/b9264f66b9dd04eb5221c3a4c4ea17c4eb9ef8aa/lib/appium_lib/driver.rb#L219) +##### [global_webdriver_http_sleep](https://github.com/appium/ruby_lib/blob/8571197b04ea923db6e375bae808bf84dea52c98/lib/appium_lib/driver.rb#L221) > 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/b9264f66b9dd04eb5221c3a4c4ea17c4eb9ef8aa/lib/appium_lib/driver.rb#L219) +##### [global_webdriver_http_sleep=](https://github.com/appium/ruby_lib/blob/8571197b04ea923db6e375bae808bf84dea52c98/lib/appium_lib/driver.rb#L221) > 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/b9264f66b9dd04eb5221c3a4c4ea17c4eb9ef8aa/lib/appium_lib/driver.rb#L249) +##### [initialize](https://github.com/appium/ruby_lib/blob/8571197b04ea923db6e375bae808bf84dea52c98/lib/appium_lib/driver.rb#L251) > def initialize opts={} Creates a new driver. :device is :android, :ios, or :selendroid @@ -1474,11 +1474,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Driver] -- -##### [status](https://github.com/appium/ruby_lib/blob/b9264f66b9dd04eb5221c3a4c4ea17c4eb9ef8aa/lib/appium_lib/driver.rb#L357) +##### [status](https://github.com/appium/ruby_lib/blob/8571197b04ea923db6e375bae808bf84dea52c98/lib/appium_lib/driver.rb#L363) > def status Returns the status payload @@ -1500,11 +1500,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[JSON] -- -##### [server_version](https://github.com/appium/ruby_lib/blob/b9264f66b9dd04eb5221c3a4c4ea17c4eb9ef8aa/lib/appium_lib/driver.rb#L363) +##### [server_version](https://github.com/appium/ruby_lib/blob/8571197b04ea923db6e375bae808bf84dea52c98/lib/appium_lib/driver.rb#L369) > def server_version Returns the server's version string @@ -1512,11 +1512,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[String] -- -##### [absolute_app_path](https://github.com/appium/ruby_lib/blob/b9264f66b9dd04eb5221c3a4c4ea17c4eb9ef8aa/lib/appium_lib/driver.rb#L404) +##### [absolute_app_path](https://github.com/appium/ruby_lib/blob/8571197b04ea923db6e375bae808bf84dea52c98/lib/appium_lib/driver.rb#L410) > def absolute_app_path Converts environment variable APP_PATH to an absolute path. @@ -1524,11 +1524,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[String] APP_PATH as an absolute path -- -##### [server_url](https://github.com/appium/ruby_lib/blob/b9264f66b9dd04eb5221c3a4c4ea17c4eb9ef8aa/lib/appium_lib/driver.rb#L424) +##### [server_url](https://github.com/appium/ruby_lib/blob/8571197b04ea923db6e375bae808bf84dea52c98/lib/appium_lib/driver.rb#L430) > def server_url Get the server url for sauce or local based on env vars. @@ -1536,11 +1536,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[String] the server url -- -##### [restart](https://github.com/appium/ruby_lib/blob/b9264f66b9dd04eb5221c3a4c4ea17c4eb9ef8aa/lib/appium_lib/driver.rb#L435) +##### [restart](https://github.com/appium/ruby_lib/blob/8571197b04ea923db6e375bae808bf84dea52c98/lib/appium_lib/driver.rb#L441) > def restart Restarts the driver @@ -1548,11 +1548,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Driver] the driver -- -##### [driver](https://github.com/appium/ruby_lib/blob/b9264f66b9dd04eb5221c3a4c4ea17c4eb9ef8aa/lib/appium_lib/driver.rb#L442) +##### [driver](https://github.com/appium/ruby_lib/blob/8571197b04ea923db6e375bae808bf84dea52c98/lib/appium_lib/driver.rb#L448) > def driver Returns the driver @@ -1560,11 +1560,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Driver] the driver -- -##### [screenshot](https://github.com/appium/ruby_lib/blob/b9264f66b9dd04eb5221c3a4c4ea17c4eb9ef8aa/lib/appium_lib/driver.rb#L452) +##### [screenshot](https://github.com/appium/ruby_lib/blob/8571197b04ea923db6e375bae808bf84dea52c98/lib/appium_lib/driver.rb#L458) > def screenshot png_save_path Takes a png screenshot and saves to the target path. @@ -1578,11 +1578,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[nil] -- -##### [driver_quit](https://github.com/appium/ruby_lib/blob/b9264f66b9dd04eb5221c3a4c4ea17c4eb9ef8aa/lib/appium_lib/driver.rb#L459) +##### [driver_quit](https://github.com/appium/ruby_lib/blob/8571197b04ea923db6e375bae808bf84dea52c98/lib/appium_lib/driver.rb#L465) > def driver_quit Quits the driver @@ -1590,11 +1590,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[void] -- -##### [start_driver](https://github.com/appium/ruby_lib/blob/b9264f66b9dd04eb5221c3a4c4ea17c4eb9ef8aa/lib/appium_lib/driver.rb#L467) +##### [start_driver](https://github.com/appium/ruby_lib/blob/8571197b04ea923db6e375bae808bf84dea52c98/lib/appium_lib/driver.rb#L473) > def start_driver Creates a new global driver and quits the old one if it exists. @@ -1602,19 +1602,19 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Selenium::WebDriver] the new global driver -- -##### [no_wait](https://github.com/appium/ruby_lib/blob/b9264f66b9dd04eb5221c3a4c4ea17c4eb9ef8aa/lib/appium_lib/driver.rb#L501) +##### [no_wait](https://github.com/appium/ruby_lib/blob/8571197b04ea923db6e375bae808bf84dea52c98/lib/appium_lib/driver.rb#L507) > def no_wait Set implicit wait and default_wait to zero. -- -##### [set_wait](https://github.com/appium/ruby_lib/blob/b9264f66b9dd04eb5221c3a4c4ea17c4eb9ef8aa/lib/appium_lib/driver.rb#L520) +##### [set_wait](https://github.com/appium/ruby_lib/blob/8571197b04ea923db6e375bae808bf84dea52c98/lib/appium_lib/driver.rb#L526) > def set_wait timeout=nil Set implicit wait and default_wait to timeout, defaults to 30. if set_wait is called without a param then the second to last @@ -1635,11 +1635,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[void] -- -##### [exists](https://github.com/appium/ruby_lib/blob/b9264f66b9dd04eb5221c3a4c4ea17c4eb9ef8aa/lib/appium_lib/driver.rb#L554) +##### [exists](https://github.com/appium/ruby_lib/blob/8571197b04ea923db6e375bae808bf84dea52c98/lib/appium_lib/driver.rb#L560) > def exists pre_check=0, post_check=@default_wait, &search_block Returns existence of element. @@ -1661,11 +1661,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Boolean] -- -##### [execute_script](https://github.com/appium/ruby_lib/blob/b9264f66b9dd04eb5221c3a4c4ea17c4eb9ef8aa/lib/appium_lib/driver.rb#L578) +##### [execute_script](https://github.com/appium/ruby_lib/blob/8571197b04ea923db6e375bae808bf84dea52c98/lib/appium_lib/driver.rb#L584) > def execute_script script, *args The same as @driver.execute_script @@ -1679,11 +1679,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Object] -- -##### [mobile](https://github.com/appium/ruby_lib/blob/b9264f66b9dd04eb5221c3a4c4ea17c4eb9ef8aa/lib/appium_lib/driver.rb#L594) +##### [mobile](https://github.com/appium/ruby_lib/blob/8571197b04ea923db6e375bae808bf84dea52c98/lib/appium_lib/driver.rb#L600) > def mobile method, *args Helper method for mobile gestures @@ -1705,11 +1705,11 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Object] -- -##### [find_elements](https://github.com/appium/ruby_lib/blob/b9264f66b9dd04eb5221c3a4c4ea17c4eb9ef8aa/lib/appium_lib/driver.rb#L605) +##### [find_elements](https://github.com/appium/ruby_lib/blob/8571197b04ea923db6e375bae808bf84dea52c98/lib/appium_lib/driver.rb#L611) > def find_elements *args Calls @driver.find_elements @@ -1721,11 +1721,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/b9264f66b9dd04eb5221c3a4c4ea17c4eb9ef8aa/lib/appium_lib/driver.rb#L613) +##### [find_element](https://github.com/appium/ruby_lib/blob/8571197b04ea923db6e375bae808bf84dea52c98/lib/appium_lib/driver.rb#L619) > def find_element *args Calls @driver.find_elements @@ -1737,10 +1737,10 @@ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Element] -- -##### [x](https://github.com/appium/ruby_lib/blob/b9264f66b9dd04eb5221c3a4c4ea17c4eb9ef8aa/lib/appium_lib/driver.rb#L620) +##### [x](https://github.com/appium/ruby_lib/blob/8571197b04ea923db6e375bae808bf84dea52c98/lib/appium_lib/driver.rb#L626) > def x Quit the driver and Pry. quit and exit are reserved by Pry.