docs/android_docs.md in appium_lib-0.13.0 vs docs/android_docs.md in appium_lib-0.14.0
- old
+ new
@@ -1,1631 +1 @@
-##### [s_texts](https://github.com/appium/ruby_lib/blob/c92bd3710be09731aa8ba4547a3e19af9eeaceab/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.
-
-__Parameters:__
-
- [String] text - the text to find.
-
-__Returns:__
-
- [Array]
-
---
-
-##### [s_texts_names](https://github.com/appium/ruby_lib/blob/c92bd3710be09731aa8ba4547a3e19af9eeaceab/lib/appium_lib/common/element/text.rb#L18)
-
-> def s_texts_names
-
-
-
---
-
-##### [e_s_texts](https://github.com/appium/ruby_lib/blob/c92bd3710be09731aa8ba4547a3e19af9eeaceab/lib/appium_lib/common/element/text.rb#L24)
-
-> def e_s_texts
-
-Get an array of text elements.
-
-__Returns:__
-
- [Array<Text>]
-
---
-
-##### [first_s_text](https://github.com/appium/ruby_lib/blob/c92bd3710be09731aa8ba4547a3e19af9eeaceab/lib/appium_lib/common/element/text.rb#L30)
-
-> def first_s_text
-
-Get the first text element.
-
-__Returns:__
-
- [Text]
-
---
-
-##### [last_s_text](https://github.com/appium/ruby_lib/blob/c92bd3710be09731aa8ba4547a3e19af9eeaceab/lib/appium_lib/common/element/text.rb#L36)
-
-> def last_s_text
-
-Get the last text element
-
-__Returns:__
-
- [Text]
-
---
-
-##### [s_text](https://github.com/appium/ruby_lib/blob/c92bd3710be09731aa8ba4547a3e19af9eeaceab/lib/appium_lib/common/element/text.rb#L43)
-
-> def s_text text
-
-Get the first element that includes text.
-
-__Parameters:__
-
- [String, Integer] text - the text to find. If int then the text at that index is returned.
-
-__Returns:__
-
- [Text]
-
---
-
-##### [s_text_exact](https://github.com/appium/ruby_lib/blob/c92bd3710be09731aa8ba4547a3e19af9eeaceab/lib/appium_lib/common/element/text.rb#L51)
-
-> def s_text_exact text
-
-Get the first textfield that matches text.
-
-__Parameters:__
-
- [String] text - the text that the tag must match
-
-__Returns:__
-
- [Text]
-
---
-
-##### [s_texts_exact](https://github.com/appium/ruby_lib/blob/c92bd3710be09731aa8ba4547a3e19af9eeaceab/lib/appium_lib/common/element/text.rb#L58)
-
-> def s_texts_exact text
-
-Get all static textfields that matches text.
-
-__Parameters:__
-
- [String] text - the text that the tag must match
-
-__Returns:__
-
- [Array<Text>]
-
---
-
-##### [window_size](https://github.com/appium/ruby_lib/blob/c92bd3710be09731aa8ba4547a3e19af9eeaceab/lib/appium_lib/common/element/window.rb#L5)
-
-> def window_size
-
-Get the window's size
-
---
-
-##### [button](https://github.com/appium/ruby_lib/blob/c92bd3710be09731aa8ba4547a3e19af9eeaceab/lib/appium_lib/common/element/button.rb#L8)
-
-> def button text, number=0
-
-Find a button by text and optionally number.
-
-__Parameters:__
-
- [String, Integer] text - the text to exactly match. If int then the button at that index is returned.
-
- [Integer] number - the occurrence of the button matching text. Defaults to the first button.
-
-__Returns:__
-
- [Button] the button found with text and matching number
-
---
-
-##### [buttons](https://github.com/appium/ruby_lib/blob/c92bd3710be09731aa8ba4547a3e19af9eeaceab/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.
-
-__Parameters:__
-
- [String] text - the text to exactly match
-
-__Returns:__
-
- [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/c92bd3710be09731aa8ba4547a3e19af9eeaceab/lib/appium_lib/common/element/button.rb#L26)
-
-> def first_button
-
-Get the first button element.
-
-__Returns:__
-
- [Button]
-
---
-
-##### [last_button](https://github.com/appium/ruby_lib/blob/c92bd3710be09731aa8ba4547a3e19af9eeaceab/lib/appium_lib/common/element/button.rb#L32)
-
-> def last_button
-
-Get the last button element.
-
-__Returns:__
-
- [Button]
-
---
-
-##### [button_exact](https://github.com/appium/ruby_lib/blob/c92bd3710be09731aa8ba4547a3e19af9eeaceab/lib/appium_lib/common/element/button.rb#L39)
-
-> def button_exact text
-
-Get the first button element that exactly matches text.
-
-__Parameters:__
-
- [String] text - the text to match exactly
-
-__Returns:__
-
- [Button]
-
---
-
-##### [buttons_exact](https://github.com/appium/ruby_lib/blob/c92bd3710be09731aa8ba4547a3e19af9eeaceab/lib/appium_lib/common/element/button.rb#L46)
-
-> def buttons_exact text
-
-Get all button elements that exactly match text.
-
-__Parameters:__
-
- [String] text - the text to match exactly
-
-__Returns:__
-
- [Array<Button>]
-
---
-
-##### [e_buttons](https://github.com/appium/ruby_lib/blob/c92bd3710be09731aa8ba4547a3e19af9eeaceab/lib/appium_lib/common/element/button.rb#L52)
-
-> def e_buttons
-
-Get an array of button elements.
-
-__Returns:__
-
- [Array<Button>]
-
---
-
-##### [button_num](https://github.com/appium/ruby_lib/blob/c92bd3710be09731aa8ba4547a3e19af9eeaceab/lib/appium_lib/common/element/button.rb#L72)
-
-> def button_num text, number=1
-
-Expected to be called via button method.
-
-Get the button element exactly matching text and
-occurrence. number=2 means the 2nd occurrence.
-
-find the second Sign In button
-
-b = e_button 'Sign In', 2
-
-Button order will change in iOS vs Android
-so if there's no button found at number then
-return the first button.
-
-__Parameters:__
-
- [String] text - the text to match
-
- [Integer] number - the button occurance to return. 1 = first button
-
-__Returns:__
-
- [Button] the button that matches text and number
-
---
-
-##### [tag_name_to_android](https://github.com/appium/ruby_lib/blob/c92bd3710be09731aa8ba4547a3e19af9eeaceab/lib/appium_lib/android/helper.rb#L6) android
-
-> def tag_name_to_android tag_name
-
-Returns an array of android classes that match the tag name
-
-__Parameters:__
-
- [String] tag_name - the tag name to convert to an android class
-
-__Returns:__
-
- [String]
-
---
-
-##### [find_eles_attr](https://github.com/appium/ruby_lib/blob/c92bd3710be09731aa8ba4547a3e19af9eeaceab/lib/appium_lib/android/helper.rb#L198) android
-
-> def find_eles_attr tag_name, attribute=nil
-
-Find all elements matching the attribute
-On android, assume the attr is name (which falls back to text).
-
-```ruby
- find_eles_attr :text
-```
-
-__Parameters:__
-
- [String] tag_name - the tag name to search for
-
-__Returns:__
-
- [Element]
-
---
-
-##### [get_selendroid_inspect](https://github.com/appium/ruby_lib/blob/c92bd3710be09731aa8ba4547a3e19af9eeaceab/lib/appium_lib/android/helper.rb#L220) android
-
-> def get_selendroid_inspect
-
-Selendroid only.
-Returns a string containing interesting elements.
-
-__Returns:__
-
- [String]
-
---
-
-##### [get_page_class](https://github.com/appium/ruby_lib/blob/c92bd3710be09731aa8ba4547a3e19af9eeaceab/lib/appium_lib/android/helper.rb#L282) android
-
-> def get_page_class
-
-
-
---
-
-##### [page_class](https://github.com/appium/ruby_lib/blob/c92bd3710be09731aa8ba4547a3e19af9eeaceab/lib/appium_lib/android/helper.rb#L310) android
-
-> def page_class
-
-Count all classes on screen and print to stdout.
-Useful for appium_console.
-
---
-
-##### [get_android_inspect](https://github.com/appium/ruby_lib/blob/c92bd3710be09731aa8ba4547a3e19af9eeaceab/lib/appium_lib/android/helper.rb#L319) android
-
-> def get_android_inspect
-
-Android only.
-Returns a string containing interesting elements.
-If an element has no content desc or text, then it's not returned by this method.
-
-__Returns:__
-
- [String]
-
---
-
-##### [get_inspect](https://github.com/appium/ruby_lib/blob/c92bd3710be09731aa8ba4547a3e19af9eeaceab/lib/appium_lib/android/helper.rb#L403) android
-
-> def get_inspect
-
-Automatically detects selendroid or android.
-Returns a string containing interesting elements.
-
-__Returns:__
-
- [String]
-
---
-
-##### [page](https://github.com/appium/ruby_lib/blob/c92bd3710be09731aa8ba4547a3e19af9eeaceab/lib/appium_lib/android/helper.rb#L409) android
-
-> def page
-
-Intended for use with console.
-Inspects and prints the current page.
-
---
-
-##### [fast_duration](https://github.com/appium/ruby_lib/blob/c92bd3710be09731aa8ba4547a3e19af9eeaceab/lib/appium_lib/android/helper.rb#L421) android
-
-> def fast_duration
-
-JavaScript code from https://github.com/appium/appium/blob/master/app/android.js
-
-```javascript
-Math.round(1.0/28.0 * 28) = 1
-```
-
-We want steps to be exactly 1. If it's zero then a tap is used instead of a swipe.
-
---
-
-##### [current_app](https://github.com/appium/ruby_lib/blob/c92bd3710be09731aa8ba4547a3e19af9eeaceab/lib/appium_lib/android/helper.rb#L427) android
-
-> def current_app
-
-Lists package, activity, and adb shell am start -n value for current app.
-Works on local host only (not remote).
-
---
-
-##### [id](https://github.com/appium/ruby_lib/blob/c92bd3710be09731aa8ba4547a3e19af9eeaceab/lib/appium_lib/android/helper.rb#L441) android
-
-> def id id
-
-Find by id. Useful for selendroid
-
-__Parameters:__
-
- [String] id - the id to search for
-
-__Returns:__
-
- [Element]
-
---
-
-##### [alert_click](https://github.com/appium/ruby_lib/blob/c92bd3710be09731aa8ba4547a3e19af9eeaceab/lib/appium_lib/android/element/alert.rb#L6) android
-
-> def alert_click value
-
-Tap the alert button identified by value.
-
-__Parameters:__
-
- [Integer, String] value - either an integer index of the button or the button's name
-
-__Returns:__
-
- [void]
-
---
-
-##### [alert_accept](https://github.com/appium/ruby_lib/blob/c92bd3710be09731aa8ba4547a3e19af9eeaceab/lib/appium_lib/android/element/alert.rb#L13) android
-
-> def alert_accept
-
-Accept the alert.
-The last button is considered "accept."
-
-__Returns:__
-
- [void]
-
---
-
-##### [alert_accept_text](https://github.com/appium/ruby_lib/blob/c92bd3710be09731aa8ba4547a3e19af9eeaceab/lib/appium_lib/android/element/alert.rb#L20) android
-
-> def alert_accept_text
-
-Get the text of the alert's accept button.
-The last button is considered "accept."
-
-__Returns:__
-
- [String]
-
---
-
-##### [alert_dismiss](https://github.com/appium/ruby_lib/blob/c92bd3710be09731aa8ba4547a3e19af9eeaceab/lib/appium_lib/android/element/alert.rb#L27) android
-
-> def alert_dismiss
-
-Dismiss the alert.
-The first button is considered "dismiss."
-
-__Returns:__
-
- [void]
-
---
-
-##### [alert_dismiss_text](https://github.com/appium/ruby_lib/blob/c92bd3710be09731aa8ba4547a3e19af9eeaceab/lib/appium_lib/android/element/alert.rb#L34) android
-
-> def alert_dismiss_text
-
-Get the text of the alert's dismiss button.
-The first button is considered "dismiss."
-
-__Returns:__
-
- [String]
-
---
-
-##### [find](https://github.com/appium/ruby_lib/blob/c92bd3710be09731aa8ba4547a3e19af9eeaceab/lib/appium_lib/android/element/generic.rb#L44) android
-
-> def find val
-
-Find the value contained in content description or text. Search elements
-in this order: EditText, Button, ImageButton
-
-__Parameters:__
-
- [String] val - the value to search for
-
-__Returns:__
-
- [Element]
-
---
-
-##### [text](https://github.com/appium/ruby_lib/blob/c92bd3710be09731aa8ba4547a3e19af9eeaceab/lib/appium_lib/android/element/generic.rb#L70) android
-
-> def text text
-
-Return the first element matching text.
-
-__Parameters:__
-
- [String] text - the text to search for
-
-__Returns:__
-
- [Element] the first matching element
-
---
-
-##### [texts](https://github.com/appium/ruby_lib/blob/c92bd3710be09731aa8ba4547a3e19af9eeaceab/lib/appium_lib/android/element/generic.rb#L79) android
-
-> def texts text
-
-Return all elements matching text.
-
-__Parameters:__
-
- [String] text - the text to search for
-
-__Returns:__
-
- [Array<Element>] all matching elements
-
---
-
-##### [name](https://github.com/appium/ruby_lib/blob/c92bd3710be09731aa8ba4547a3e19af9eeaceab/lib/appium_lib/android/element/generic.rb#L88) android
-
-> def name name
-
-Return the first element matching name.
-on Android name is content description
-on iOS name is the accessibility label or the text.
-
-__Parameters:__
-
- [String] name - the name to search for
-
-__Returns:__
-
- [Element] the first matching element
-
---
-
-##### [names](https://github.com/appium/ruby_lib/blob/c92bd3710be09731aa8ba4547a3e19af9eeaceab/lib/appium_lib/android/element/generic.rb#L99) android
-
-> def names name
-
-Return all elements matching name.
-on Android name is content description
-on iOS name is the accessibility label or the text.
-
-__Parameters:__
-
- [String] name - the name to search for
-
-__Returns:__
-
- [Array<Element>] all matching elements
-
---
-
-##### [scroll_to](https://github.com/appium/ruby_lib/blob/c92bd3710be09731aa8ba4547a3e19af9eeaceab/lib/appium_lib/android/element/generic.rb#L108) android
-
-> def scroll_to text
-
-Scroll to an element containing target text or description.
-
-__Parameters:__
-
- [String] text - the text to search for in the text value and content description
-
-__Returns:__
-
- [Element] the element scrolled to
-
---
-
-##### [textfields](https://github.com/appium/ruby_lib/blob/c92bd3710be09731aa8ba4547a3e19af9eeaceab/lib/appium_lib/android/element/textfield.rb#L7) android
-
-> def textfields
-
-Get an array of textfield texts.
-
-__Returns:__
-
- [Array<String>]
-
---
-
-##### [e_textfields](https://github.com/appium/ruby_lib/blob/c92bd3710be09731aa8ba4547a3e19af9eeaceab/lib/appium_lib/android/element/textfield.rb#L13) android
-
-> def e_textfields
-
-Get an array of textfield elements.
-
-__Returns:__
-
- [Array<Textfield>]
-
---
-
-##### [first_textfield](https://github.com/appium/ruby_lib/blob/c92bd3710be09731aa8ba4547a3e19af9eeaceab/lib/appium_lib/android/element/textfield.rb#L19) android
-
-> def first_textfield
-
-Get the first textfield element.
-
-__Returns:__
-
- [Textfield]
-
---
-
-##### [last_textfield](https://github.com/appium/ruby_lib/blob/c92bd3710be09731aa8ba4547a3e19af9eeaceab/lib/appium_lib/android/element/textfield.rb#L25) android
-
-> def last_textfield
-
-Get the last textfield element.
-
-__Returns:__
-
- [Textfield]
-
---
-
-##### [textfield](https://github.com/appium/ruby_lib/blob/c92bd3710be09731aa8ba4547a3e19af9eeaceab/lib/appium_lib/android/element/textfield.rb#L32) android
-
-> def textfield text
-
-Get the first textfield that includes text or name (content description).
-
-__Parameters:__
-
- [String, Integer] text - the text to search for. If int then the textfield at that index is returned.
-
-__Returns:__
-
- [Textfield]
-
---
-
-##### [textfield_exact](https://github.com/appium/ruby_lib/blob/c92bd3710be09731aa8ba4547a3e19af9eeaceab/lib/appium_lib/android/element/textfield.rb#L45) android
-
-> def textfield_exact text
-
-Get the first textfield that matches text.
-
-__Parameters:__
-
- [String] text - the text to match
-
-__Returns:__
-
- [Textfield]
-
---
-
-##### [wait](https://github.com/appium/ruby_lib/blob/c92bd3710be09731aa8ba4547a3e19af9eeaceab/lib/appium_lib/common/helper.rb#L33)
-
-> def wait max_wait=-1, 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.
-if .call doesn't raise an exception then it will stop waiting.
-
-Example: wait { name('back').click }
-
-Give up after 30 seconds.
-
-__Parameters:__
-
- [Integer] max_wait - the maximum time in seconds to wait for.
-Note that max wait 0 means infinity.
-
- [Float] interval - the time in seconds to wait after calling the block
-
- [Block] block - the block to call
-
-__Returns:__
-
- [Object] the result of block.call
-
---
-
-##### [ignore](https://github.com/appium/ruby_lib/blob/c92bd3710be09731aa8ba4547a3e19af9eeaceab/lib/appium_lib/common/helper.rb#L53)
-
-> def ignore &block
-
-Return block.call and ignore any exceptions.
-
---
-
-##### [wait_true](https://github.com/appium/ruby_lib/blob/c92bd3710be09731aa8ba4547a3e19af9eeaceab/lib/appium_lib/common/helper.rb#L63)
-
-> def wait_true max_wait=-1, 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.
-
-__Parameters:__
-
- [Integer] max_wait - the maximum time in seconds to wait for
-
- [Float] interval - the time in seconds to wait after calling the block
-
- [Block] block - the block to call
-
-__Returns:__
-
- [Object] the result of block.call
-
---
-
-##### [back](https://github.com/appium/ruby_lib/blob/c92bd3710be09731aa8ba4547a3e19af9eeaceab/lib/appium_lib/common/helper.rb#L84)
-
-> def back
-
-Navigate back.
-
-__Returns:__
-
- [void]
-
---
-
-##### [session_id](https://github.com/appium/ruby_lib/blob/c92bd3710be09731aa8ba4547a3e19af9eeaceab/lib/appium_lib/common/helper.rb#L89)
-
-> def session_id
-
-For Sauce Labs reporting. Returns the current session id.
-
---
-
-##### [xpath](https://github.com/appium/ruby_lib/blob/c92bd3710be09731aa8ba4547a3e19af9eeaceab/lib/appium_lib/common/helper.rb#L97)
-
-> def xpath xpath_str
-
-Returns the first element that matches the provided xpath.
-
-__Parameters:__
-
- [String] xpath_str - the XPath string
-
-__Returns:__
-
- [Element]
-
---
-
-##### [xpaths](https://github.com/appium/ruby_lib/blob/c92bd3710be09731aa8ba4547a3e19af9eeaceab/lib/appium_lib/common/helper.rb#L105)
-
-> def xpaths xpath_str
-
-Returns all elements that match the provided xpath.
-
-__Parameters:__
-
- [String] xpath_str - the XPath string
-
-__Returns:__
-
- [Array<Element>]
-
---
-
-##### [ele_index](https://github.com/appium/ruby_lib/blob/c92bd3710be09731aa8ba4547a3e19af9eeaceab/lib/appium_lib/common/helper.rb#L113)
-
-> def ele_index tag_name, index
-
-Get the element of type tag_name at matching index.
-
-__Parameters:__
-
- [String] tag_name - the tag name to find
-
- [Integer] index - the index
-
-__Returns:__
-
- [Element] the found element of type tag_name
-
---
-
-##### [find_eles](https://github.com/appium/ruby_lib/blob/c92bd3710be09731aa8ba4547a3e19af9eeaceab/lib/appium_lib/common/helper.rb#L122)
-
-> def find_eles tag_name
-
-Get all elements exactly matching tag name
-
-__Parameters:__
-
- [String] tag_name - the tag name to find
-
-__Returns:__
-
- [Array<Element>] the found elements of type tag_name
-
---
-
-##### [find_ele_by_text](https://github.com/appium/ruby_lib/blob/c92bd3710be09731aa8ba4547a3e19af9eeaceab/lib/appium_lib/common/helper.rb#L130)
-
-> def find_ele_by_text tag, text
-
-Get the first tag that exactly matches tag and text.
-
-__Parameters:__
-
- [String] tag - the tag name to match
-
- [String] text - the text to exactly match
-
-__Returns:__
-
- [Element] the element of type tag exactly matching text
-
---
-
-##### [find_eles_by_text](https://github.com/appium/ruby_lib/blob/c92bd3710be09731aa8ba4547a3e19af9eeaceab/lib/appium_lib/common/helper.rb#L138)
-
-> def find_eles_by_text tag, text
-
-Get all tags that exactly match tag and text.
-
-__Parameters:__
-
- [String] tag - the tag name to match
-
- [String] text - the text to exactly match
-
-__Returns:__
-
- [Array<Element>] the elements of type tag exactly matching text
-
---
-
-##### [find_ele_by_attr_include](https://github.com/appium/ruby_lib/blob/c92bd3710be09731aa8ba4547a3e19af9eeaceab/lib/appium_lib/common/helper.rb#L147)
-
-> def find_ele_by_attr_include tag, attr, value
-
-Get the first tag by attribute that exactly matches value.
-
-__Parameters:__
-
- [String] tag - the tag name to match
-
- [String] attr - the attribute to compare
-
- [String] value - the value of the attribute that the element must include
-
-__Returns:__
-
- [Element] the element of type tag who's attribute includes value
-
---
-
-##### [find_eles_by_attr_include](https://github.com/appium/ruby_lib/blob/c92bd3710be09731aa8ba4547a3e19af9eeaceab/lib/appium_lib/common/helper.rb#L156)
-
-> def find_eles_by_attr_include tag, attr, value
-
-Get tags by attribute that include value.
-
-__Parameters:__
-
- [String] tag - the tag name to match
-
- [String] attr - the attribute to compare
-
- [String] value - the value of the attribute that the element must include
-
-__Returns:__
-
- [Array<Element>] the elements of type tag who's attribute includes value
-
---
-
-##### [find_ele_by_text_include](https://github.com/appium/ruby_lib/blob/c92bd3710be09731aa8ba4547a3e19af9eeaceab/lib/appium_lib/common/helper.rb#L165)
-
-> def find_ele_by_text_include tag, text
-
-Get the first tag that includes text.
-element.attribute(:text).include? text
-
-__Parameters:__
-
- [String] tag - the tag name to match
-
- [String] text - the text the element must include
-
-__Returns:__
-
- [Element] the element of type tag that includes text
-
---
-
-##### [find_eles_by_text_include](https://github.com/appium/ruby_lib/blob/c92bd3710be09731aa8ba4547a3e19af9eeaceab/lib/appium_lib/common/helper.rb#L174)
-
-> def find_eles_by_text_include tag, text
-
-Get the tags that include text.
-element.attribute(:text).include? text
-
-__Parameters:__
-
- [String] tag - the tag name to match
-
- [String] text - the text the element must include
-
-__Returns:__
-
- [Array<Element>] the elements of type tag that includes text
-
---
-
-##### [first_ele](https://github.com/appium/ruby_lib/blob/c92bd3710be09731aa8ba4547a3e19af9eeaceab/lib/appium_lib/common/helper.rb#L181)
-
-> def first_ele tag_name
-
-Get the first tag that matches tag_name
-
-__Parameters:__
-
- [String] tag_name - the tag to match
-
-__Returns:__
-
- [Element]
-
---
-
-##### [last_ele](https://github.com/appium/ruby_lib/blob/c92bd3710be09731aa8ba4547a3e19af9eeaceab/lib/appium_lib/common/helper.rb#L189)
-
-> def last_ele tag_name
-
-Get the last tag that matches tag_name
-
-__Parameters:__
-
- [String] tag_name - the tag to match
-
-__Returns:__
-
- [Element]
-
---
-
-##### [source](https://github.com/appium/ruby_lib/blob/c92bd3710be09731aa8ba4547a3e19af9eeaceab/lib/appium_lib/common/helper.rb#L195)
-
-> def source
-
-Prints a JSON view of the current page
-
-__Returns:__
-
- [void]
-
---
-
-##### [get_source](https://github.com/appium/ruby_lib/blob/c92bd3710be09731aa8ba4547a3e19af9eeaceab/lib/appium_lib/common/helper.rb#L201)
-
-> def get_source
-
-Gets a JSON view of the current page
-
-__Returns:__
-
- [JSON]
-
---
-
-##### [find_name](https://github.com/appium/ruby_lib/blob/c92bd3710be09731aa8ba4547a3e19af9eeaceab/lib/appium_lib/common/helper.rb#L210)
-
-> def find_name name
-
-Returns the first element that exactly matches name
-
-__Parameters:__
-
- [String] name - the name to exactly match
-
-__Returns:__
-
- [Element]
-
---
-
-##### [find_names](https://github.com/appium/ruby_lib/blob/c92bd3710be09731aa8ba4547a3e19af9eeaceab/lib/appium_lib/common/helper.rb#L218)
-
-> def find_names name
-
-Returns all elements that exactly match name
-
-__Parameters:__
-
- [String] name - the name to exactly match
-
-__Returns:__
-
- [Array<Element>]
-
---
-
-##### [tag](https://github.com/appium/ruby_lib/blob/c92bd3710be09731aa8ba4547a3e19af9eeaceab/lib/appium_lib/common/helper.rb#L226)
-
-> def tag tag_name
-
-Returns the first element matching tag_name
-
-__Parameters:__
-
- [String] tag_name - the tag_name to search for
-
-__Returns:__
-
- [Element]
-
---
-
-##### [px_to_window_rel](https://github.com/appium/ruby_lib/blob/c92bd3710be09731aa8ba4547a3e19af9eeaceab/lib/appium_lib/common/helper.rb#L236)
-
-> def px_to_window_rel opts={}
-
-Converts pixel values to window relative values
-
-```ruby
-px_to_window_rel x: 50, y: 150
-```
-
---
-
-##### [lazy_load_strings](https://github.com/appium/ruby_lib/blob/c92bd3710be09731aa8ba4547a3e19af9eeaceab/lib/appium_lib/common/helper.rb#L246)
-
-> def lazy_load_strings
-
-
-
---
-
-##### [xml_keys](https://github.com/appium/ruby_lib/blob/c92bd3710be09731aa8ba4547a3e19af9eeaceab/lib/appium_lib/common/helper.rb#L253)
-
-> def xml_keys target
-
-Search strings.xml's values for target.
-
-__Parameters:__
-
- [String] target - the target to search for in strings.xml values
-
-__Returns:__
-
- [Array]
-
---
-
-##### [xml_values](https://github.com/appium/ruby_lib/blob/c92bd3710be09731aa8ba4547a3e19af9eeaceab/lib/appium_lib/common/helper.rb#L261)
-
-> def xml_values target
-
-Search strings.xml's keys for target.
-
-__Parameters:__
-
- [String] target - the target to search for in strings.xml keys
-
-__Returns:__
-
- [Array]
-
---
-
-##### [resolve_id](https://github.com/appium/ruby_lib/blob/c92bd3710be09731aa8ba4547a3e19af9eeaceab/lib/appium_lib/common/helper.rb#L269)
-
-> def resolve_id id
-
-Resolve id in strings.xml and return the value.
-
-__Parameters:__
-
- [String] id - the id to resolve
-
-__Returns:__
-
- [String]
-
---
-
-##### [raise_no_element_error](https://github.com/appium/ruby_lib/blob/c92bd3710be09731aa8ba4547a3e19af9eeaceab/lib/appium_lib/common/helper.rb#L275)
-
-> def raise_no_element_error
-
-Used to error when finding a single element fails.
-
---
-
-##### [value](https://github.com/appium/ruby_lib/blob/c92bd3710be09731aa8ba4547a3e19af9eeaceab/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/c92bd3710be09731aa8ba4547a3e19af9eeaceab/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/c92bd3710be09731aa8ba4547a3e19af9eeaceab/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/c92bd3710be09731aa8ba4547a3e19af9eeaceab/lib/appium_lib/common/patch.rb#L58)
-
-> def location_rel
-
-For use with mobile tap.
-
-```ruby
-execute_script 'mobile: tap', :x => 0.0, :y => 0.98
-```
-
-https://github.com/appium/appium/wiki/Automating-mobile-gestures
-
-__Returns:__
-
- [OpenStruct] the relative x, y in a struct. ex: { x: 0.50, y: 0.20 }
-
---
-
-##### [CORE](https://github.com/appium/ruby_lib/blob/c92bd3710be09731aa8ba4547a3e19af9eeaceab/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/c92bd3710be09731aa8ba4547a3e19af9eeaceab/lib/appium_lib/driver.rb#L18)
-
-> def awesome_openstruct target
-
-
-
---
-
-##### [load_appium_txt](https://github.com/appium/ruby_lib/blob/c92bd3710be09731aa8ba4547a3e19af9eeaceab/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
-
-__Parameters:__
-
- [Hash] opts - file: '/path/to/appium.txt', verbose: true
-
-__Returns:__
-
- [Array<String>] the require files. nil if require doesn't exist
-
---
-
-##### [promote_singleton_appium_methods](https://github.com/appium/ruby_lib/blob/c92bd3710be09731aa8ba4547a3e19af9eeaceab/lib/appium_lib/driver.rb#L154)
-
-> def self.promote_singleton_appium_methods main_module
-
-
-
---
-
-##### [promote_appium_methods](https://github.com/appium/ruby_lib/blob/c92bd3710be09731aa8ba4547a3e19af9eeaceab/lib/appium_lib/driver.rb#L184)
-
-> def self.promote_appium_methods class_array
-
-Promote appium methods to class instance methods
-
-To promote methods to all classes:
-
-```ruby
-Appium.promote_appium_methods Object
-```
-
-__Parameters:__
-
- [Array<Class>] class_array - An array of classes
-
---
-
-##### [default_wait](https://github.com/appium/ruby_lib/blob/c92bd3710be09731aa8ba4547a3e19af9eeaceab/lib/appium_lib/driver.rb#L515)
-
-> def default_wait
-
-Returns the default client side wait.
-This value is independent of what the server is using
-
-__Returns:__
-
- [Integer]
-
---
-
-##### [app_path](https://github.com/appium/ruby_lib/blob/c92bd3710be09731aa8ba4547a3e19af9eeaceab/lib/appium_lib/driver.rb#L213)
-
-> def app_path
-
-Returns the value of attribute app_path
-
---
-
-##### [app_name](https://github.com/appium/ruby_lib/blob/c92bd3710be09731aa8ba4547a3e19af9eeaceab/lib/appium_lib/driver.rb#L213)
-
-> def app_name
-
-Returns the value of attribute app_name
-
---
-
-##### [device](https://github.com/appium/ruby_lib/blob/c92bd3710be09731aa8ba4547a3e19af9eeaceab/lib/appium_lib/driver.rb#L213)
-
-> def device
-
-Returns the value of attribute device
-
---
-
-##### [app_package](https://github.com/appium/ruby_lib/blob/c92bd3710be09731aa8ba4547a3e19af9eeaceab/lib/appium_lib/driver.rb#L213)
-
-> def app_package
-
-Returns the value of attribute app_package
-
---
-
-##### [app_activity](https://github.com/appium/ruby_lib/blob/c92bd3710be09731aa8ba4547a3e19af9eeaceab/lib/appium_lib/driver.rb#L213)
-
-> def app_activity
-
-Returns the value of attribute app_activity
-
---
-
-##### [app_wait_activity](https://github.com/appium/ruby_lib/blob/c92bd3710be09731aa8ba4547a3e19af9eeaceab/lib/appium_lib/driver.rb#L213)
-
-> def app_wait_activity
-
-Returns the value of attribute app_wait_activity
-
---
-
-##### [sauce_username](https://github.com/appium/ruby_lib/blob/c92bd3710be09731aa8ba4547a3e19af9eeaceab/lib/appium_lib/driver.rb#L213)
-
-> def sauce_username
-
-Returns the value of attribute sauce_username
-
---
-
-##### [sauce_access_key](https://github.com/appium/ruby_lib/blob/c92bd3710be09731aa8ba4547a3e19af9eeaceab/lib/appium_lib/driver.rb#L213)
-
-> def sauce_access_key
-
-Returns the value of attribute sauce_access_key
-
---
-
-##### [port](https://github.com/appium/ruby_lib/blob/c92bd3710be09731aa8ba4547a3e19af9eeaceab/lib/appium_lib/driver.rb#L213)
-
-> def port
-
-Returns the value of attribute port
-
---
-
-##### [debug](https://github.com/appium/ruby_lib/blob/c92bd3710be09731aa8ba4547a3e19af9eeaceab/lib/appium_lib/driver.rb#L213)
-
-> def debug
-
-Returns the value of attribute debug
-
---
-
-##### [export_session](https://github.com/appium/ruby_lib/blob/c92bd3710be09731aa8ba4547a3e19af9eeaceab/lib/appium_lib/driver.rb#L213)
-
-> def export_session
-
-Returns the value of attribute export_session
-
---
-
-##### [device_cap](https://github.com/appium/ruby_lib/blob/c92bd3710be09731aa8ba4547a3e19af9eeaceab/lib/appium_lib/driver.rb#L213)
-
-> def device_cap
-
-Returns the value of attribute device_cap
-
---
-
-##### [compress_xml](https://github.com/appium/ruby_lib/blob/c92bd3710be09731aa8ba4547a3e19af9eeaceab/lib/appium_lib/driver.rb#L213)
-
-> def compress_xml
-
-Returns the value of attribute compress_xml
-
---
-
-##### [custom_url](https://github.com/appium/ruby_lib/blob/c92bd3710be09731aa8ba4547a3e19af9eeaceab/lib/appium_lib/driver.rb#L213)
-
-> def custom_url
-
-Returns the value of attribute custom_url
-
---
-
-##### [global_webdriver_http_sleep](https://github.com/appium/ruby_lib/blob/c92bd3710be09731aa8ba4547a3e19af9eeaceab/lib/appium_lib/driver.rb#L219)
-
-> 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/c92bd3710be09731aa8ba4547a3e19af9eeaceab/lib/appium_lib/driver.rb#L219)
-
-> 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/c92bd3710be09731aa8ba4547a3e19af9eeaceab/lib/appium_lib/driver.rb#L249)
-
-> def initialize opts={}
-
-Creates a new driver.
-:device is :android, :ios, or :selendroid
-
-```ruby
-# Options include:
-:app_path, :app_name, :app_package, :app_activity,
-:app_wait_activity, :sauce_username, :sauce_access_key,
-:port, :os, :debug
-
-require 'rubygems'
-require 'appium_lib'
-
-# Start iOS driver
-app = { device: :ios, app_path: '/path/to/MyiOS.app'}
-Appium::Driver.new(app).start_driver
-
-# Start Android driver
-apk = { device: :android
- app_path: '/path/to/the.apk',
- app_package: 'com.example.pkg',
- app_activity: 'act.Start',
- app_wait_activity: 'act.Start'
-}
-
-Appium::Driver.new(apk).start_driver
-```
-
-__Parameters:__
-
- [Object] opts - A hash containing various options.
-
-__Returns:__
-
- [Driver]
-
---
-
-##### [status](https://github.com/appium/ruby_lib/blob/c92bd3710be09731aa8ba4547a3e19af9eeaceab/lib/appium_lib/driver.rb#L356)
-
-> def status
-
-Returns the status payload
-
-```ruby
-{"status"=>0,
- "value"=>
- {"build"=>
- {"version"=>"0.8.2",
- "revision"=>"f2a2bc3782e4b0370d97a097d7e04913cf008995"}},
- "sessionId"=>"8f4b34a7-a9a9-4ac5-b125-36258143446a"}
-```
-
- Discover the Appium rev running on the server.
-
-`status["value"]["build"]["revision"]`
-`f2a2bc3782e4b0370d97a097d7e04913cf008995`
-
-__Returns:__
-
- [JSON]
-
---
-
-##### [server_version](https://github.com/appium/ruby_lib/blob/c92bd3710be09731aa8ba4547a3e19af9eeaceab/lib/appium_lib/driver.rb#L362)
-
-> def server_version
-
-Returns the server's version string
-
-__Returns:__
-
- [String]
-
---
-
-##### [absolute_app_path](https://github.com/appium/ruby_lib/blob/c92bd3710be09731aa8ba4547a3e19af9eeaceab/lib/appium_lib/driver.rb#L402)
-
-> def absolute_app_path
-
-Converts environment variable APP_PATH to an absolute path.
-
-__Returns:__
-
- [String] APP_PATH as an absolute path
-
---
-
-##### [server_url](https://github.com/appium/ruby_lib/blob/c92bd3710be09731aa8ba4547a3e19af9eeaceab/lib/appium_lib/driver.rb#L422)
-
-> def server_url
-
-Get the server url for sauce or local based on env vars.
-
-__Returns:__
-
- [String] the server url
-
---
-
-##### [restart](https://github.com/appium/ruby_lib/blob/c92bd3710be09731aa8ba4547a3e19af9eeaceab/lib/appium_lib/driver.rb#L433)
-
-> def restart
-
-Restarts the driver
-
-__Returns:__
-
- [Driver] the driver
-
---
-
-##### [driver](https://github.com/appium/ruby_lib/blob/c92bd3710be09731aa8ba4547a3e19af9eeaceab/lib/appium_lib/driver.rb#L440)
-
-> def driver
-
-Returns the driver
-
-__Returns:__
-
- [Driver] the driver
-
---
-
-##### [screenshot](https://github.com/appium/ruby_lib/blob/c92bd3710be09731aa8ba4547a3e19af9eeaceab/lib/appium_lib/driver.rb#L450)
-
-> def screenshot png_save_path
-
-Takes a png screenshot and saves to the target path.
-
-Example: screenshot '/tmp/hi.png'
-
-__Parameters:__
-
- [String] png_save_path - the full path to save the png
-
-__Returns:__
-
- [nil]
-
---
-
-##### [driver_quit](https://github.com/appium/ruby_lib/blob/c92bd3710be09731aa8ba4547a3e19af9eeaceab/lib/appium_lib/driver.rb#L457)
-
-> def driver_quit
-
-Quits the driver
-
-__Returns:__
-
- [void]
-
---
-
-##### [start_driver](https://github.com/appium/ruby_lib/blob/c92bd3710be09731aa8ba4547a3e19af9eeaceab/lib/appium_lib/driver.rb#L465)
-
-> def start_driver
-
-Creates a new global driver and quits the old one if it exists.
-
-__Returns:__
-
- [Selenium::WebDriver] the new global driver
-
---
-
-##### [no_wait](https://github.com/appium/ruby_lib/blob/c92bd3710be09731aa8ba4547a3e19af9eeaceab/lib/appium_lib/driver.rb#L499)
-
-> def no_wait
-
-Set implicit wait and default_wait to zero.
-
---
-
-##### [set_wait](https://github.com/appium/ruby_lib/blob/c92bd3710be09731aa8ba4547a3e19af9eeaceab/lib/appium_lib/driver.rb#L507)
-
-> def set_wait timeout=@default_wait
-
-Set implicit wait and default_wait to timeout, defaults to 30.
-
-__Parameters:__
-
- [Integer] timeout - the timeout in seconds
-
-__Returns:__
-
- [void]
-
---
-
-##### [exists](https://github.com/appium/ruby_lib/blob/c92bd3710be09731aa8ba4547a3e19af9eeaceab/lib/appium_lib/driver.rb#L531)
-
-> def exists pre_check=0, post_check=@default_wait, &search_block
-
-Returns existence of element.
-
-Example:
-
-exists { button('sign in') } ? puts('true') : puts('false')
-
-__Parameters:__
-
- [Integer] pre_check - the amount in seconds to set the
-wait to before checking existance
-
- [Integer] post_check - the amount in seconds to set the
-wait to after checking existance
-
- [Block] search_block - the block to call
-
-__Returns:__
-
- [Boolean]
-
---
-
-##### [execute_script](https://github.com/appium/ruby_lib/blob/c92bd3710be09731aa8ba4547a3e19af9eeaceab/lib/appium_lib/driver.rb#L553)
-
-> def execute_script script, *args
-
-The same as @driver.execute_script
-
-__Parameters:__
-
- [String] script - the script to execute
-
- [*args] args - the args to pass to the script
-
-__Returns:__
-
- [Object]
-
---
-
-##### [mobile](https://github.com/appium/ruby_lib/blob/c92bd3710be09731aa8ba4547a3e19af9eeaceab/lib/appium_lib/driver.rb#L569)
-
-> def mobile method, *args
-
-Helper method for mobile gestures
-
-https://github.com/appium/appium/wiki/Automating-mobile-gestures
-
-driver.execute_script 'mobile: swipe', endX: 100, endY: 100, duration: 0.01
-
-becomes
-
-mobile :swipe, endX: 100, endY: 100, duration: 0.01
-
-__Parameters:__
-
- [String, Symbol] method - the method to execute
-
- [*args] args - the args to pass to the method
-
-__Returns:__
-
- [Object]
-
---
-
-##### [find_elements](https://github.com/appium/ruby_lib/blob/c92bd3710be09731aa8ba4547a3e19af9eeaceab/lib/appium_lib/driver.rb#L580)
-
-> def find_elements *args
-
-Calls @driver.find_elements
-
-__Parameters:__
-
- [*args] args - the args to use
-
-__Returns:__
-
- [Array<Element>] Array is empty when no elements are found.
-
---
-
-##### [find_element](https://github.com/appium/ruby_lib/blob/c92bd3710be09731aa8ba4547a3e19af9eeaceab/lib/appium_lib/driver.rb#L588)
-
-> def find_element *args
-
-Calls @driver.find_elements
-
-__Parameters:__
-
- [*args] args - the args to use
-
-__Returns:__
-
- [Element]
-
---
-
-##### [x](https://github.com/appium/ruby_lib/blob/c92bd3710be09731aa8ba4547a3e19af9eeaceab/lib/appium_lib/driver.rb#L595)
-
-> def x
-
-Quit the driver and Pry.
-quit and exit are reserved by Pry.
-
-__Returns:__
-
- [void]
-
---
-
\ No newline at end of file