##### [load_settings](https://github.com/appium/ruby_lib/blob/06f2e54b4b55df25e624272b5a2cd7b23a000298/lib/appium_lib/appium.rb#L60) common
> def load_settings(opts = {})
Load arbitrary text ([toml format](https://github.com/toml-lang/toml))
The toml is parsed by https://github.com/fbernier/tomlrb .
```
[caps]
app = "path/to/app"
[appium_lib]
port = 8080
```
:app is expanded
:require is expanded
all keys are converted to symbols
__Parameters:__
[Hash] opts - file: '/path/to/appium.txt', verbose: true
__Returns:__
[hash] the symbolized hash with updated :app and :require keys
--
##### [load_appium_txt](https://github.com/appium/ruby_lib/blob/06f2e54b4b55df25e624272b5a2cd7b23a000298/lib/appium_lib/appium.rb#L95) common
> def load_settings(opts = {})
Load arbitrary text ([toml format](https://github.com/toml-lang/toml))
The toml is parsed by https://github.com/fbernier/tomlrb .
```
[caps]
app = "path/to/app"
[appium_lib]
port = 8080
```
:app is expanded
:require is expanded
all keys are converted to symbols
__Parameters:__
[Hash] opts - file: '/path/to/appium.txt', verbose: true
__Returns:__
[hash] the symbolized hash with updated :app and :require keys
--
##### [expand_required_files](https://github.com/appium/ruby_lib/blob/06f2e54b4b55df25e624272b5a2cd7b23a000298/lib/appium_lib/appium.rb#L100) common
> def expand_required_files(base_dir, file_paths)
__Parameters:__
[String] base_dir - parent directory of loaded appium.txt (toml)
[String] file_paths -
__Returns:__
[Array] list of require files as an array, nil if require doesn't exist
--
##### [promote_singleton_appium_methods](https://github.com/appium/ruby_lib/blob/06f2e54b4b55df25e624272b5a2cd7b23a000298/lib/appium_lib/appium.rb#L142) common
> def promote_singleton_appium_methods(modules, driver = $driver)
This method is intended to work with page objects that share
a common module. For example, Page::HomePage, Page::SignIn
those could be promoted on with Appium.promote_singleton_appium_methods Page
If you are promoting on an individual class then you should use
Appium.promote_appium_methods instead. The singleton method is intended
only for the shared module use case.
if modules is a module instead of an array, then the constants of
that module are promoted on.
otherwise, the array of modules will be used as the promotion target.
__Parameters:__
[Array<Module>] modules - An array of modules
[Driver] driver - A driver to extend for
--
##### [promote_appium_methods](https://github.com/appium/ruby_lib/blob/06f2e54b4b55df25e624272b5a2cd7b23a000298/lib/appium_lib/appium.rb#L198) common
> def promote_appium_methods(class_array, driver = $driver)
Promote appium methods to class instance methods
To promote methods to all classes:
It's better to promote on specific classes instead of Object
__Parameters:__
[Array<Class>] class_array - An array of classes
[Driver] driver - A driver to extend for
--
##### [global_webdriver_http_sleep](https://github.com/appium/ruby_lib/blob/06f2e54b4b55df25e624272b5a2cd7b23a000298/lib/appium_lib/driver.rb#L49) common
> 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/06f2e54b4b55df25e624272b5a2cd7b23a000298/lib/appium_lib/driver.rb#L49) common
> def global_webdriver_http_sleep=(value)
The amount to sleep in seconds before every webdriver http call.
--
##### [sauce](https://github.com/appium/ruby_lib/blob/06f2e54b4b55df25e624272b5a2cd7b23a000298/lib/appium_lib/driver.rb#L52) common
> def sauce
SauceLab's settings
--
##### [sauce_username](https://github.com/appium/ruby_lib/blob/06f2e54b4b55df25e624272b5a2cd7b23a000298/lib/appium_lib/driver.rb#L55) common
> def sauce_username
Username for use on Sauce Labs. Set `false` to disable Sauce, even when SAUCE_USERNAME is in ENV.
same as @sauce.username
--
##### [sauce_access_key](https://github.com/appium/ruby_lib/blob/06f2e54b4b55df25e624272b5a2cd7b23a000298/lib/appium_lib/driver.rb#L58) common
> def sauce_access_key
Access Key for use on Sauce Labs. Set `false` to disable Sauce, even when SAUCE_ACCESS_KEY is in ENV.
same as @sauce.access_key
--
##### [sauce_endpoint](https://github.com/appium/ruby_lib/blob/06f2e54b4b55df25e624272b5a2cd7b23a000298/lib/appium_lib/driver.rb#L61) common
> def sauce_endpoint
Override the Sauce Appium endpoint to allow e.g. TestObject tests
same as @sauce.endpoint
--
##### [caps](https://github.com/appium/ruby_lib/blob/06f2e54b4b55df25e624272b5a2cd7b23a000298/lib/appium_lib/driver.rb#L65) common
> def caps
from Core
read http://www.rubydoc.info/github/appium/ruby_lib_core/Appium/Core/Driver
--
##### [custom_url](https://github.com/appium/ruby_lib/blob/06f2e54b4b55df25e624272b5a2cd7b23a000298/lib/appium_lib/driver.rb#L66) common
> def custom_url
Returns the value of attribute custom_url.
--
##### [export_session](https://github.com/appium/ruby_lib/blob/06f2e54b4b55df25e624272b5a2cd7b23a000298/lib/appium_lib/driver.rb#L67) common
> def export_session
Returns the value of attribute export_session.
--
##### [export_session_path](https://github.com/appium/ruby_lib/blob/06f2e54b4b55df25e624272b5a2cd7b23a000298/lib/appium_lib/driver.rb#L68) common
> def export_session_path
Returns the value of attribute export_session_path.
--
##### [default_wait](https://github.com/appium/ruby_lib/blob/06f2e54b4b55df25e624272b5a2cd7b23a000298/lib/appium_lib/driver.rb#L69) common
> def default_wait
Returns the value of attribute default_wait.
--
##### [appium_port](https://github.com/appium/ruby_lib/blob/06f2e54b4b55df25e624272b5a2cd7b23a000298/lib/appium_lib/driver.rb#L70) common
> def appium_port
Returns the value of attribute appium_port.
--
##### [appium_device](https://github.com/appium/ruby_lib/blob/06f2e54b4b55df25e624272b5a2cd7b23a000298/lib/appium_lib/driver.rb#L71) common
> def appium_device
Returns the value of attribute appium_device.
--
##### [automation_name](https://github.com/appium/ruby_lib/blob/06f2e54b4b55df25e624272b5a2cd7b23a000298/lib/appium_lib/driver.rb#L72) common
> def automation_name
Returns the value of attribute automation_name.
--
##### [listener](https://github.com/appium/ruby_lib/blob/06f2e54b4b55df25e624272b5a2cd7b23a000298/lib/appium_lib/driver.rb#L73) common
> def listener
Returns the value of attribute listener.
--
##### [http_client](https://github.com/appium/ruby_lib/blob/06f2e54b4b55df25e624272b5a2cd7b23a000298/lib/appium_lib/driver.rb#L74) common
> def http_client
Returns the value of attribute http_client.
--
##### [appium_wait_timeout](https://github.com/appium/ruby_lib/blob/06f2e54b4b55df25e624272b5a2cd7b23a000298/lib/appium_lib/driver.rb#L75) common
> def appium_wait_timeout
Returns the value of attribute appium_wait_timeout.
--
##### [appium_wait_interval](https://github.com/appium/ruby_lib/blob/06f2e54b4b55df25e624272b5a2cd7b23a000298/lib/appium_lib/driver.rb#L76) common
> def appium_wait_interval
Returns the value of attribute appium_wait_interval.
--
##### [appium_server_status](https://github.com/appium/ruby_lib/blob/06f2e54b4b55df25e624272b5a2cd7b23a000298/lib/appium_lib/driver.rb#L79) common
> def appium_server_status
Appium's server version
--
##### [appium_debug](https://github.com/appium/ruby_lib/blob/06f2e54b4b55df25e624272b5a2cd7b23a000298/lib/appium_lib/driver.rb#L81) common
> def appium_debug
Boolean debug mode for the Appium Ruby bindings
--
##### [driver](https://github.com/appium/ruby_lib/blob/06f2e54b4b55df25e624272b5a2cd7b23a000298/lib/appium_lib/driver.rb#L84) common
> def driver
Returns the driver
__Returns:__
[Driver] the driver
--
##### [core](https://github.com/appium/ruby_lib/blob/06f2e54b4b55df25e624272b5a2cd7b23a000298/lib/appium_lib/driver.rb#L86) common
> def core
Instance of Appium::Core::Driver
--
##### [initialize](https://github.com/appium/ruby_lib/blob/06f2e54b4b55df25e624272b5a2cd7b23a000298/lib/appium_lib/driver.rb#L154) common
> def initialize(opts = {}, global_driver = nil)
Creates a new driver. The driver is defined as global scope by default.
We can avoid defining global driver.
__Parameters:__
[Object] opts - A hash containing various options.
[Bool] global_driver - A bool require global driver before initialize.
__Returns:__
[Driver]
--
##### [driver_attributes](https://github.com/appium/ruby_lib/blob/06f2e54b4b55df25e624272b5a2cd7b23a000298/lib/appium_lib/driver.rb#L278) common
> def driver_attributes
Returns a hash of the driver attributes
--
##### [device_is_android?](https://github.com/appium/ruby_lib/blob/06f2e54b4b55df25e624272b5a2cd7b23a000298/lib/appium_lib/driver.rb#L298) common
> def device_is_android?
__Returns:__
[Boolean]
--
##### [device_is_ios?](https://github.com/appium/ruby_lib/blob/06f2e54b4b55df25e624272b5a2cd7b23a000298/lib/appium_lib/driver.rb#L302) common
> def device_is_ios?
__Returns:__
[Boolean]
--
##### [device_is_windows?](https://github.com/appium/ruby_lib/blob/06f2e54b4b55df25e624272b5a2cd7b23a000298/lib/appium_lib/driver.rb#L306) common
> def device_is_windows?
__Returns:__
[Boolean]
--
##### [automation_name_is_uiautomator2?](https://github.com/appium/ruby_lib/blob/06f2e54b4b55df25e624272b5a2cd7b23a000298/lib/appium_lib/driver.rb#L312) common
> def automation_name_is_uiautomator2?
Return true if automationName is 'uiautomator2'
__Returns:__
[Boolean]
--
##### [automation_name_is_espresso?](https://github.com/appium/ruby_lib/blob/06f2e54b4b55df25e624272b5a2cd7b23a000298/lib/appium_lib/driver.rb#L318) common
> def automation_name_is_espresso?
Return true if automationName is 'Espresso'
__Returns:__
[Boolean]
--
##### [automation_name_is_xcuitest?](https://github.com/appium/ruby_lib/blob/06f2e54b4b55df25e624272b5a2cd7b23a000298/lib/appium_lib/driver.rb#L324) common
> def automation_name_is_xcuitest?
Return true if automationName is 'XCUITest'
__Returns:__
[Boolean]
--
##### [dialect](https://github.com/appium/ruby_lib/blob/06f2e54b4b55df25e624272b5a2cd7b23a000298/lib/appium_lib/driver.rb#L344) common
> def dialect
Get the dialect value whether current driver is OSS or W3C
__Returns:__
[:oss | :w3c] @example
if dialect == :w3c
driver.action
.move_to_location(500, 500).pointer_down(:left)
.move_to_location(0, 700)
.release.perform
else
action = TouchAction.new(driver).press(x: 500, y: 500).move_to(500, 700).release
action.perform
end
--
##### [action](https://github.com/appium/ruby_lib/blob/06f2e54b4b55df25e624272b5a2cd7b23a000298/lib/appium_lib/driver.rb#L358) common
> def action
An entry point to chain W3C actions. Returns `TouchAction.new` if it works as MJSONWP instead of W3C action.
Read https://www.rubydoc.info/github/appium/ruby_lib_core/Appium/Core/Base/Bridge/W3C#action-instance_method
__Returns:__
[TouchAction|Selenium::WebDriver::PointerActions]
--
##### [appium_server_version](https://github.com/appium/ruby_lib/blob/06f2e54b4b55df25e624272b5a2cd7b23a000298/lib/appium_lib/driver.rb#L378) common
> def appium_server_version
Returns the server's version info
__Returns:__
[Hash]
--
##### [remote_status](https://github.com/appium/ruby_lib/blob/06f2e54b4b55df25e624272b5a2cd7b23a000298/lib/appium_lib/driver.rb#L386) common
> def appium_server_version
Returns the server's version info
__Returns:__
[Hash]
--
##### [platform_version](https://github.com/appium/ruby_lib/blob/06f2e54b4b55df25e624272b5a2cd7b23a000298/lib/appium_lib/driver.rb#L390) common
> def platform_version
Return the platform version as an array of integers
__Returns:__
[Array<Integer>]
--
##### [appium_client_version](https://github.com/appium/ruby_lib/blob/06f2e54b4b55df25e624272b5a2cd7b23a000298/lib/appium_lib/driver.rb#L403) common
> def appium_client_version
Returns the client's version info
__Returns:__
[Hash]
--
##### [absolute_app_path](https://github.com/appium/ruby_lib/blob/06f2e54b4b55df25e624272b5a2cd7b23a000298/lib/appium_lib/driver.rb#L415) common
> def absolute_app_path(opts)
Converts app_path to an absolute path.
opts is the full options hash (caps and appium_lib). If server_url is set
then the app path is used as is.
if app isn't set then an error is raised.
__Returns:__
[String] APP_PATH as an absolute path
--
##### [server_url](https://github.com/appium/ruby_lib/blob/06f2e54b4b55df25e624272b5a2cd7b23a000298/lib/appium_lib/driver.rb#L436) common
> def server_url
Get the server url
__Returns:__
[String] the server url
--
##### [restart](https://github.com/appium/ruby_lib/blob/06f2e54b4b55df25e624272b5a2cd7b23a000298/lib/appium_lib/driver.rb#L445) common
> def restart
Restarts the driver
__Returns:__
[Driver] the driver
--
##### [screenshot](https://github.com/appium/ruby_lib/blob/06f2e54b4b55df25e624272b5a2cd7b23a000298/lib/appium_lib/driver.rb#L458) common
> def screenshot(png_save_path)
Takes a png screenshot and saves to the target path.
__Parameters:__
[String] png_save_path - the full path to save the png
__Returns:__
[File]
--
##### [element_screenshot](https://github.com/appium/ruby_lib/blob/06f2e54b4b55df25e624272b5a2cd7b23a000298/lib/appium_lib/driver.rb#L472) common
> def element_screenshot(element, png_save_path)
Takes a png screenshot of particular element's area
__Parameters:__
[String] element - Element take a screenshot
[String] png_save_path - the full path to save the png
__Returns:__
[File]
--
##### [driver_quit](https://github.com/appium/ruby_lib/blob/06f2e54b4b55df25e624272b5a2cd7b23a000298/lib/appium_lib/driver.rb#L479) common
> def driver_quit
Quits the driver
__Returns:__
[void]
--
##### [quit_driver](https://github.com/appium/ruby_lib/blob/06f2e54b4b55df25e624272b5a2cd7b23a000298/lib/appium_lib/driver.rb#L482) common
> def driver_quit
Quits the driver
__Returns:__
[void]
--
##### [window_size](https://github.com/appium/ruby_lib/blob/06f2e54b4b55df25e624272b5a2cd7b23a000298/lib/appium_lib/driver.rb#L493) common
> def window_size
Get the device window's size.
__Returns:__
[Selenium::WebDriver::Dimension]
--
##### [window_rect](https://github.com/appium/ruby_lib/blob/06f2e54b4b55df25e624272b5a2cd7b23a000298/lib/appium_lib/driver.rb#L508) common
> def window_rect
Get the device window's rect.
__Returns:__
[Selenium::WebDriver::Rectangle]
--
##### [start_driver](https://github.com/appium/ruby_lib/blob/06f2e54b4b55df25e624272b5a2cd7b23a000298/lib/appium_lib/driver.rb#L541) common
> def start_driver(http_client_ops = { http_client: ::Appium::Http::Default.new, open_timeout: 999_999, read_timeout: 999_999 })
Creates a new global driver and quits the old one if it exists.
You can customise http_client as the following
Read http://www.rubydoc.info/github/appium/ruby_lib_core/Appium/Core/Device to understand more what the driver
can call instance methods.
__Parameters:__
[Hash] http_client_ops - a customizable set of options
__Returns:__
[Selenium::WebDriver] the new global driver
--
##### [set_implicit_wait](https://github.com/appium/ruby_lib/blob/06f2e54b4b55df25e624272b5a2cd7b23a000298/lib/appium_lib/driver.rb#L562) common
> def set_implicit_wait(wait)
To ignore error for Espresso Driver
--
##### [no_wait](https://github.com/appium/ruby_lib/blob/06f2e54b4b55df25e624272b5a2cd7b23a000298/lib/appium_lib/driver.rb#L573) common
> def no_wait
Set implicit wait to zero.
--
##### [set_wait](https://github.com/appium/ruby_lib/blob/06f2e54b4b55df25e624272b5a2cd7b23a000298/lib/appium_lib/driver.rb#L587) common
> def set_wait(timeout = nil)
Set implicit wait. Default to @core.default_wait.
__Parameters:__
[Integer] timeout - the timeout in seconds
__Returns:__
[void]
--
##### [exists](https://github.com/appium/ruby_lib/blob/06f2e54b4b55df25e624272b5a2cd7b23a000298/lib/appium_lib/driver.rb#L604) common
> def exists(pre_check = 0, post_check = @core.default_wait)
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 existence
[Integer] post_check - The amount in seconds to set the
wait to after checking existence
__Returns:__
[Boolean]
--
##### [execute_script](https://github.com/appium/ruby_lib/blob/06f2e54b4b55df25e624272b5a2cd7b23a000298/lib/appium_lib/driver.rb#L628) common
> 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]
--
##### [execute_async_script](https://github.com/appium/ruby_lib/blob/06f2e54b4b55df25e624272b5a2cd7b23a000298/lib/appium_lib/driver.rb#L636) common
> def execute_async_script(script, *args)
Wrap calling selenium webdrier APIs via ruby_core
Get the window handles of open browser windows
--
##### [execute_driver](https://github.com/appium/ruby_lib/blob/06f2e54b4b55df25e624272b5a2cd7b23a000298/lib/appium_lib/driver.rb#L668) common
> def execute_driver(script: '', type: 'webdriverio', timeout_ms: nil)
Run a set of script against the current session, allowing execution of many commands in one Appium request.
Supports {https://webdriver.io/docs/api.html WebdriverIO} API so far.
Please read {http://appium.io/docs/en/commands/session/execute-driver command API} for more details
about acceptable scripts and the output.
__Parameters:__
[String] script - The string consisting of the script itself
[String] type - The name of the script type.
Defaults to 'webdriverio'. Depends on server implementation which type is supported.
[Integer] timeout_ms - The number of `ms` Appium should wait for the script to finish
before killing it due to timeout.
__Returns:__
[Appium::Core::Base::Device::ExecuteDriver::Result] The script result parsed by
Appium::Core::Base::Device::ExecuteDriver::Result.
--
##### [window_handles](https://github.com/appium/ruby_lib/blob/06f2e54b4b55df25e624272b5a2cd7b23a000298/lib/appium_lib/driver.rb#L672) common
> def window_handles
--
##### [window_handle](https://github.com/appium/ruby_lib/blob/06f2e54b4b55df25e624272b5a2cd7b23a000298/lib/appium_lib/driver.rb#L677) common
> def window_handle
Get the current window handle
--
##### [navigate](https://github.com/appium/ruby_lib/blob/06f2e54b4b55df25e624272b5a2cd7b23a000298/lib/appium_lib/driver.rb#L681) common
> def navigate
--
##### [manage](https://github.com/appium/ruby_lib/blob/06f2e54b4b55df25e624272b5a2cd7b23a000298/lib/appium_lib/driver.rb#L685) common
> def manage
--
##### [get](https://github.com/appium/ruby_lib/blob/06f2e54b4b55df25e624272b5a2cd7b23a000298/lib/appium_lib/driver.rb#L689) common
> def get(url)
--
##### [current_url](https://github.com/appium/ruby_lib/blob/06f2e54b4b55df25e624272b5a2cd7b23a000298/lib/appium_lib/driver.rb#L693) common
> def current_url
--
##### [title](https://github.com/appium/ruby_lib/blob/06f2e54b4b55df25e624272b5a2cd7b23a000298/lib/appium_lib/driver.rb#L697) common
> def title
--
##### [switch_to](https://github.com/appium/ruby_lib/blob/06f2e54b4b55df25e624272b5a2cd7b23a000298/lib/appium_lib/driver.rb#L703) common
> def switch_to
__Returns:__
[TargetLocator]
--
##### [find_elements](https://github.com/appium/ruby_lib/blob/06f2e54b4b55df25e624272b5a2cd7b23a000298/lib/appium_lib/driver.rb#L730) common
> def find_elements(*args)
Calls @driver.find_elements_with_appium
If you call `Appium.promote_appium_methods`, you can call `find_elements` directly.
If you call `Appium.promote_appium_methods`, you can call `find_elements` directly.
__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/06f2e54b4b55df25e624272b5a2cd7b23a000298/lib/appium_lib/driver.rb#L746) common
> def find_element(*args)
Calls @driver.find_element
If you call `Appium.promote_appium_methods`, you can call `find_element` directly.
__Parameters:__
[*args] args - The args to use
__Returns:__
[Element]
--
##### [find_element_by_image](https://github.com/appium/ruby_lib/blob/06f2e54b4b55df25e624272b5a2cd7b23a000298/lib/appium_lib/driver.rb#L761) common
> def find_element_by_image(png_img_path)
Return ImageElement if current view has a partial image
__Parameters:__
[String] png_img_path - A path to a partial image you'd like to find
__Returns:__
[::Appium::Core::ImageElement]
--
##### [find_elements_by_image](https://github.com/appium/ruby_lib/blob/06f2e54b4b55df25e624272b5a2cd7b23a000298/lib/appium_lib/driver.rb#L776) common
> def find_elements_by_image(png_img_paths)
Return ImageElement if current view has partial images
__Parameters:__
[[String]] png_img_paths - Paths to a partial image you'd like to find
__Returns:__
[[::Appium::Core::ImageElement]]
--
##### [set_location](https://github.com/appium/ruby_lib/blob/06f2e54b4b55df25e624272b5a2cd7b23a000298/lib/appium_lib/driver.rb#L789) common
> def set_location(opts = {})
Calls @driver.set_location
__Parameters:__
[Hash] opts - consisting of:
__Returns:__
[Selenium::WebDriver::Location] the location constructed by the selenium webdriver
--
##### [log_event](https://github.com/appium/ruby_lib/blob/06f2e54b4b55df25e624272b5a2cd7b23a000298/lib/appium_lib/driver.rb#L813) common
> def log_event(vendor:, event:)
Logs a custom event. The event is available via {::Appium::Core::Events#get} or
<code>driver.session_capabilities['events']</code> with <code>eventTimings</code> capabilities.
__Parameters:__
[String] vendor - The vendor prefix for the event
[String] event - The name of event
__Returns:__
[nil]
--
##### [log_event=](https://github.com/appium/ruby_lib/blob/06f2e54b4b55df25e624272b5a2cd7b23a000298/lib/appium_lib/driver.rb#L817) common
> def log_event=(log_event)
--
##### [log_events](https://github.com/appium/ruby_lib/blob/06f2e54b4b55df25e624272b5a2cd7b23a000298/lib/appium_lib/driver.rb#L834) common
> def log_events(type = nil)
Returns events with filtering with 'type'. Defaults to all available events.
__Parameters:__
[String] type - The type of events to get
__Returns:__
[Hash]
--
##### [x](https://github.com/appium/ruby_lib/blob/06f2e54b4b55df25e624272b5a2cd7b23a000298/lib/appium_lib/driver.rb#L841) common
> def x
Quit the driver and Pry.
quit and exit are reserved by Pry.
__Returns:__
[void]
--
##### [username](https://github.com/appium/ruby_lib/blob/06f2e54b4b55df25e624272b5a2cd7b23a000298/lib/appium_lib/sauce_labs.rb#L18) common
> def username
Username for use on Sauce Labs. Set `false` to disable Sauce, even when SAUCE_USERNAME is in ENV.
--
##### [access_key](https://github.com/appium/ruby_lib/blob/06f2e54b4b55df25e624272b5a2cd7b23a000298/lib/appium_lib/sauce_labs.rb#L20) common
> def access_key
Access Key for use on Sauce Labs. Set `false` to disable Sauce, even when SAUCE_ACCESS_KEY is in ENV.
--
##### [endpoint](https://github.com/appium/ruby_lib/blob/06f2e54b4b55df25e624272b5a2cd7b23a000298/lib/appium_lib/sauce_labs.rb#L22) common
> def endpoint
Override the Sauce Appium endpoint to allow e.g. TestObject tests. Default is 'ondemand.saucelabs.com:443/wd/hub'.
--
##### [initialize](https://github.com/appium/ruby_lib/blob/06f2e54b4b55df25e624272b5a2cd7b23a000298/lib/appium_lib/sauce_labs.rb#L47) common
> def initialize(appium_lib_opts)
Create a SauceLabs instance to manage sauce labs related attributes.
__Parameters:__
[Hash] appium_lib_opts - Appium library parameter
__Returns:__
[Appium::SauceLabs]
--
##### [sauce_server_url?](https://github.com/appium/ruby_lib/blob/06f2e54b4b55df25e624272b5a2cd7b23a000298/lib/appium_lib/sauce_labs.rb#L67) common
> def sauce_server_url?
Return true if an instance of Appium::SauceLabs has sauce_username and sauce_access_key.
__Returns:__
[Boolean]
--
##### [server_url](https://github.com/appium/ruby_lib/blob/06f2e54b4b55df25e624272b5a2cd7b23a000298/lib/appium_lib/sauce_labs.rb#L80) common
> def server_url
Return a particular server url to access to. Default is the local address.
__Returns:__
[String]
--
##### [get_log](https://github.com/appium/ruby_lib/blob/06f2e54b4b55df25e624272b5a2cd7b23a000298/lib/appium_lib/common/log.rb#L25) common
> def get_log(type)
__Parameters:__
[String|Hash] type - You can get particular type's logs.
__Returns:__
[[Selenium::WebDriver::LogEntry]] A list of logs data.
--
##### [get_available_log_types](https://github.com/appium/ruby_lib/blob/06f2e54b4b55df25e624272b5a2cd7b23a000298/lib/appium_lib/common/log.rb#L37) common
> def get_available_log_types
Get a list of available log types
__Returns:__
[[String]] A list of available log types.
--
##### [wait_true](https://github.com/appium/ruby_lib/blob/06f2e54b4b55df25e624272b5a2cd7b23a000298/lib/appium_lib/common/wait.rb#L44) common
> def wait_true(opts = {})
Check every interval seconds to see if yield returns a truthy value.
Note this isn't a strict boolean true, any truthy value is accepted.
false and nil are considered failures.
Give up after timeout seconds.
Wait code from the selenium Ruby gem
https://github.com/SeleniumHQ/selenium/blob/cf501dda3f0ed12233de51ce8170c0e8090f0c20/rb/lib/selenium/webdriver/common/wait.rb
If only a number is provided then it's treated as the timeout value.
__Parameters:__
[Hash|Numeric] opts - Options. If the value is _Numeric_, the value is set as `{ timeout: value }`
--
##### [wait](https://github.com/appium/ruby_lib/blob/06f2e54b4b55df25e624272b5a2cd7b23a000298/lib/appium_lib/common/wait.rb#L73) common
> def wait(opts = {})
Check every interval seconds to see if yield doesn't raise an exception.
Give up after timeout seconds.
Wait code from the selenium Ruby gem
https://github.com/SeleniumHQ/selenium/blob/cf501dda3f0ed12233de51ce8170c0e8090f0c20/rb/lib/selenium/webdriver/common/wait.rb
If only a number is provided then it's treated as the timeout value.
__Parameters:__
[Hash|Numeric] opts - Options. If the value is _Numeric_, the value is set as `{ timeout: value }`
--
##### [add_touch_actions](https://github.com/appium/ruby_lib/blob/06f2e54b4b55df25e624272b5a2cd7b23a000298/lib/appium_lib/common/device.rb#L26) common
> def add_touch_actions
--
##### [delegate_from_appium_driver](https://github.com/appium/ruby_lib/blob/06f2e54b4b55df25e624272b5a2cd7b23a000298/lib/appium_lib/common/device.rb#L38) common
> def delegate_from_appium_driver(method, delegation_target)
--
##### [ignore](https://github.com/appium/ruby_lib/blob/06f2e54b4b55df25e624272b5a2cd7b23a000298/lib/appium_lib/common/helper.rb#L30) common
> def ignore
Return yield and ignore any exceptions.
--
##### [back](https://github.com/appium/ruby_lib/blob/06f2e54b4b55df25e624272b5a2cd7b23a000298/lib/appium_lib/common/helper.rb#L38) common
> def back
Navigate back.
__Returns:__
[void]
--
##### [session_id](https://github.com/appium/ruby_lib/blob/06f2e54b4b55df25e624272b5a2cd7b23a000298/lib/appium_lib/common/helper.rb#L49) common
> def session_id
For Sauce Labs reporting. Returns the current session id.
__Returns:__
[String]
--
##### [xpath](https://github.com/appium/ruby_lib/blob/06f2e54b4b55df25e624272b5a2cd7b23a000298/lib/appium_lib/common/helper.rb#L57) common
> 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/06f2e54b4b55df25e624272b5a2cd7b23a000298/lib/appium_lib/common/helper.rb#L65) common
> def xpaths(xpath_str)
Returns all elements that match the provided xpath.
__Parameters:__
[String] xpath_str - the XPath string
__Returns:__
[Array<Element>]
--
##### [result](https://github.com/appium/ruby_lib/blob/06f2e54b4b55df25e624272b5a2cd7b23a000298/lib/appium_lib/common/helper.rb#L75) common
> def result
Returns the value of attribute result.
--
##### [initialize](https://github.com/appium/ruby_lib/blob/06f2e54b4b55df25e624272b5a2cd7b23a000298/lib/appium_lib/common/helper.rb#L77) common
> def initialize(platform)
rubocop:disable Lint/MissingSuper
__Returns:__
[CountElements] a new instance of CountElements
--
##### [reset](https://github.com/appium/ruby_lib/blob/06f2e54b4b55df25e624272b5a2cd7b23a000298/lib/appium_lib/common/helper.rb#L82) common
> def reset
--
##### [start_element](https://github.com/appium/ruby_lib/blob/06f2e54b4b55df25e624272b5a2cd7b23a000298/lib/appium_lib/common/helper.rb#L87) common
> def start_element(name, attrs = [])
http://nokogiri.org/Nokogiri/XML/SAX/Document.html
--
##### [formatted_result](https://github.com/appium/ruby_lib/blob/06f2e54b4b55df25e624272b5a2cd7b23a000298/lib/appium_lib/common/helper.rb#L98) common
> def formatted_result
--
##### [get_page_class](https://github.com/appium/ruby_lib/blob/06f2e54b4b55df25e624272b5a2cd7b23a000298/lib/appium_lib/common/helper.rb#L116) common
> def get_page_class
Returns a string of class counts of visible elements.
__Returns:__
[String]
--
##### [page_class](https://github.com/appium/ruby_lib/blob/06f2e54b4b55df25e624272b5a2cd7b23a000298/lib/appium_lib/common/helper.rb#L141) common
> def page_class
Count all classes on screen and print to stdout.
Useful for appium_console.
__Returns:__
[nil]
--
##### [source](https://github.com/appium/ruby_lib/blob/06f2e54b4b55df25e624272b5a2cd7b23a000298/lib/appium_lib/common/helper.rb#L148) common
> def source
Prints xml of the current page
__Returns:__
[void]
--
##### [get_source](https://github.com/appium/ruby_lib/blob/06f2e54b4b55df25e624272b5a2cd7b23a000298/lib/appium_lib/common/helper.rb#L155) common
> def get_source
Returns XML string for the current page
Same as driver.page_source
__Returns:__
[String]
--
##### [px_to_window_rel](https://github.com/appium/ruby_lib/blob/06f2e54b4b55df25e624272b5a2cd7b23a000298/lib/appium_lib/common/helper.rb#L165) common
> def px_to_window_rel(opts = {}, driver = $driver)
Converts pixel values to window relative values
--
##### [xml_keys](https://github.com/appium/ruby_lib/blob/06f2e54b4b55df25e624272b5a2cd7b23a000298/lib/appium_lib/common/helper.rb#L184) common
> 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/06f2e54b4b55df25e624272b5a2cd7b23a000298/lib/appium_lib/common/helper.rb#L192) common
> 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/06f2e54b4b55df25e624272b5a2cd7b23a000298/lib/appium_lib/common/helper.rb#L200) common
> def resolve_id(id)
Resolve id in strings.xml and return the value.
__Parameters:__
[String] id - the id to resolve
__Returns:__
[String]
--
##### [filter](https://github.com/appium/ruby_lib/blob/06f2e54b4b55df25e624272b5a2cd7b23a000298/lib/appium_lib/common/helper.rb#L207) common
> def filter
Returns the value of attribute filter.
--
##### [filter=](https://github.com/appium/ruby_lib/blob/06f2e54b4b55df25e624272b5a2cd7b23a000298/lib/appium_lib/common/helper.rb#L210) common
> def filter=(value)
convert to string to support symbols
--
##### [initialize](https://github.com/appium/ruby_lib/blob/06f2e54b4b55df25e624272b5a2cd7b23a000298/lib/appium_lib/common/helper.rb#L217) common
> def initialize
rubocop:disable Lint/MissingSuper
__Returns:__
[HTMLElements] a new instance of HTMLElements
--
##### [reset](https://github.com/appium/ruby_lib/blob/06f2e54b4b55df25e624272b5a2cd7b23a000298/lib/appium_lib/common/helper.rb#L222) common
> def reset
--
##### [result](https://github.com/appium/ruby_lib/blob/06f2e54b4b55df25e624272b5a2cd7b23a000298/lib/appium_lib/common/helper.rb#L228) common
> def result
--
##### [start_element](https://github.com/appium/ruby_lib/blob/06f2e54b4b55df25e624272b5a2cd7b23a000298/lib/appium_lib/common/helper.rb#L242) common
> def start_element(name, attrs = [])
--
##### [end_element](https://github.com/appium/ruby_lib/blob/06f2e54b4b55df25e624272b5a2cd7b23a000298/lib/appium_lib/common/helper.rb#L252) common
> def end_element(name)
--
##### [characters](https://github.com/appium/ruby_lib/blob/06f2e54b4b55df25e624272b5a2cd7b23a000298/lib/appium_lib/common/helper.rb#L259) common
> def characters(chars)
--
##### [pinch](https://github.com/appium/ruby_lib/blob/06f2e54b4b55df25e624272b5a2cd7b23a000298/lib/appium_lib/common/multi_touch.rb#L65) common
> def pinch(percentage = 25, auto_perform = true, driver = $driver)
Convenience method for pinching the screen.
Places two fingers at the edges of the screen and brings them together.
Without auto_perform
With driver
__Parameters:__
[int] percentage - The percent size by which to shrink the screen when pinched.
[boolean] auto_perform - Whether to perform the action immediately (default true)
[Driver] driver - Set a driver to conduct the action. DEfault is global driver($driver)
--
##### [zoom](https://github.com/appium/ruby_lib/blob/06f2e54b4b55df25e624272b5a2cd7b23a000298/lib/appium_lib/common/multi_touch.rb#L108) common
> def zoom(percentage = 200, auto_perform = true, driver = $driver)
Convenience method for zooming the screen.
Places two fingers at the edges of the screen and brings them together.
Without auto_perform
With driver
__Parameters:__
[int] percentage - The percent size by which to shrink the screen when pinched.
[boolean] auto_perform - Whether to perform the action immediately (default true)
[Driver] driver - Set a driver to conduct the action. DEfault is global driver($driver)
--
##### [initialize](https://github.com/appium/ruby_lib/blob/06f2e54b4b55df25e624272b5a2cd7b23a000298/lib/appium_lib/common/multi_touch.rb#L194) common
> def initialize(driver = $driver)
self
__Returns:__
[MultiTouch] a new instance of MultiTouch
--
##### [initialize](https://github.com/appium/ruby_lib/blob/06f2e54b4b55df25e624272b5a2cd7b23a000298/lib/appium_lib/common/touch_actions.rb#L62) common
> def initialize(driver = $driver)
__Returns:__
[TouchAction] a new instance of TouchAction
--
##### [swipe](https://github.com/appium/ruby_lib/blob/06f2e54b4b55df25e624272b5a2cd7b23a000298/lib/appium_lib/common/touch_actions.rb#L66) common
> def swipe(opts)
--
##### [initialize](https://github.com/appium/ruby_lib/blob/06f2e54b4b55df25e624272b5a2cd7b23a000298/lib/appium_lib/common/command/ws_logcat.rb#L19) common
> def initialize(url:, output_file: 'logcat.log')
__Returns:__
[WsLogcat] a new instance of WsLogcat
--
##### [handle_message_data](https://github.com/appium/ruby_lib/blob/06f2e54b4b55df25e624272b5a2cd7b23a000298/lib/appium_lib/common/command/ws_logcat.rb#L24) common
> def handle_message_data(data)
--
##### [for](https://github.com/appium/ruby_lib/blob/06f2e54b4b55df25e624272b5a2cd7b23a000298/lib/appium_lib/ios/ios.rb#L29) ios
> def for(target)
--
##### [static_text_class](https://github.com/appium/ruby_lib/blob/06f2e54b4b55df25e624272b5a2cd7b23a000298/lib/appium_lib/ios/element/text.rb#L25) ios
> def static_text_class
__Returns:__
[String] Class name for text
--
##### [text](https://github.com/appium/ruby_lib/blob/06f2e54b4b55df25e624272b5a2cd7b23a000298/lib/appium_lib/ios/element/text.rb#L33) ios
> def text(value)
Find the first UIAStaticText|XCUIElementTypeStaticText that contains value or by index.
If int then the UIAStaticText|XCUIElementTypeStaticText at that index is returned.
__Parameters:__
[String, Integer] value - the value to find.
__Returns:__
[UIA_STATIC_TEXT|XCUIELEMENT_TYPE_STATIC_TEXT]
--
##### [texts](https://github.com/appium/ruby_lib/blob/06f2e54b4b55df25e624272b5a2cd7b23a000298/lib/appium_lib/ios/element/text.rb#L43) ios
> def texts(value = false)
Find all UIAStaticTexts|XCUIElementTypeStaticTexts containing value.
If value is omitted, all UIAStaticTexts|XCUIElementTypeStaticTexts are returned
__Parameters:__
[String] value - the value to search for
__Returns:__
[Array<UIA_STATIC_TEXT|XCUIELEMENT_TYPE_STATIC_TEXT>]
--
##### [first_text](https://github.com/appium/ruby_lib/blob/06f2e54b4b55df25e624272b5a2cd7b23a000298/lib/appium_lib/ios/element/text.rb#L51) ios
> def first_text
Find the first UIAStaticText|XCUIElementTypeStaticText.
__Returns:__
[UIA_STATIC_TEXT|XCUIELEMENT_TYPE_STATIC_TEXT]
--
##### [last_text](https://github.com/appium/ruby_lib/blob/06f2e54b4b55df25e624272b5a2cd7b23a000298/lib/appium_lib/ios/element/text.rb#L57) ios
> def last_text
Find the last UIAStaticText|XCUIElementTypeStaticText.
__Returns:__
[UIA_STATIC_TEXT|XCUIELEMENT_TYPE_STATIC_TEXT]
--
##### [text_exact](https://github.com/appium/ruby_lib/blob/06f2e54b4b55df25e624272b5a2cd7b23a000298/lib/appium_lib/ios/element/text.rb#L64) ios
> def text_exact(value)
Find the first UIAStaticText|XCUIElementTypeStaticText that exactly matches value.
__Parameters:__
[String] value - the value to match exactly
__Returns:__
[UIA_STATIC_TEXT|XCUIElementTypeStaticText]
--
##### [texts_exact](https://github.com/appium/ruby_lib/blob/06f2e54b4b55df25e624272b5a2cd7b23a000298/lib/appium_lib/ios/element/text.rb#L71) ios
> def texts_exact(value)
Find all UIAStaticTexts|XCUIElementTypeStaticTexts that exactly match value.
__Parameters:__
[String] value - the value to match exactly
__Returns:__
[Array<UIA_STATIC_TEXT|XCUIElementTypeStaticText>]
--
##### [filter](https://github.com/appium/ruby_lib/blob/06f2e54b4b55df25e624272b5a2cd7b23a000298/lib/appium_lib/ios/common/helper.rb#L19) ios
> def filter
Returns the value of attribute filter.
--
##### [filter=](https://github.com/appium/ruby_lib/blob/06f2e54b4b55df25e624272b5a2cd7b23a000298/lib/appium_lib/ios/common/helper.rb#L19) ios
> def filter=(value)
Sets the attribute filter
__Parameters:__
[] value - the value to set the attribute filter to.
--
##### [start_element](https://github.com/appium/ruby_lib/blob/06f2e54b4b55df25e624272b5a2cd7b23a000298/lib/appium_lib/ios/common/helper.rb#L21) ios
> def start_element(type, attrs = [])
--
##### [ios_password](https://github.com/appium/ruby_lib/blob/06f2e54b4b55df25e624272b5a2cd7b23a000298/lib/appium_lib/ios/common/helper.rb#L58) ios
> def ios_password(length = 1)
iOS only. On Android uiautomator always returns an empty string for EditText password.
Password character returned from value of UIASecureTextField
__Parameters:__
[Integer] length - the length of the password to generate
__Returns:__
[String] the returned string is of size length
--
##### [page](https://github.com/appium/ruby_lib/blob/06f2e54b4b55df25e624272b5a2cd7b23a000298/lib/appium_lib/ios/common/helper.rb#L74) ios
> def page(opts = {})
Prints a string of interesting elements to the console.
__Parameters:__
[Hash] visible - a customizable set of options
[Hash] class - a customizable set of options
__Returns:__
[void]
--
##### [id](https://github.com/appium/ruby_lib/blob/06f2e54b4b55df25e624272b5a2cd7b23a000298/lib/appium_lib/ios/common/helper.rb#L101) ios
> def id(id)
Find by id
__Parameters:__
[String] id - the id to search for
__Returns:__
[Element]
--
##### [ele_index](https://github.com/appium/ruby_lib/blob/06f2e54b4b55df25e624272b5a2cd7b23a000298/lib/appium_lib/ios/common/helper.rb#L109) ios
> def ele_index(class_name, index)
Get the element of type class_name at matching index.
__Parameters:__
[String] class_name - the class name to find
[Integer] index - the index
__Returns:__
[Element]
--
##### [find_ele_by_attr](https://github.com/appium/ruby_lib/blob/06f2e54b4b55df25e624272b5a2cd7b23a000298/lib/appium_lib/ios/common/helper.rb#L139) ios
> def find_ele_by_attr(class_name, attr, value)
Find the first element exactly matching class and attribute value.
Note: Uses XPath
Note: For XCUITest, this method return ALL elements include displayed or not displayed elements.
__Parameters:__
[String] class_name - the class name to search for
[String] attr - the attribute to inspect
[String] value - the expected value of the attribute
__Returns:__
[Element]
--
##### [find_eles_by_attr](https://github.com/appium/ruby_lib/blob/06f2e54b4b55df25e624272b5a2cd7b23a000298/lib/appium_lib/ios/common/helper.rb#L150) ios
> def find_eles_by_attr(class_name, attr, value)
Find all elements exactly matching class and attribute value.
Note: Uses XPath
Note: For XCUITest, this method return ALL elements include displayed or not displayed elements.
__Parameters:__
[String] class_name - the class name to match
[String] attr - the attribute to compare
[String] value - the value of the attribute that the element must have
__Returns:__
[Array<Element>]
--
##### [find_ele_by_predicate](https://github.com/appium/ruby_lib/blob/06f2e54b4b55df25e624272b5a2cd7b23a000298/lib/appium_lib/ios/common/helper.rb#L163) ios
> def find_ele_by_predicate(class_name: '*', value:)
Find the first element exactly matching attribute case insensitive value.
Note: Uses Predicate
__Parameters:__
[String] value - the expected value of the attribute
__Returns:__
[Element]
--
##### [find_eles_by_predicate](https://github.com/appium/ruby_lib/blob/06f2e54b4b55df25e624272b5a2cd7b23a000298/lib/appium_lib/ios/common/helper.rb#L175) ios
> def find_eles_by_predicate(class_name: '*', value:)
Find all elements exactly matching attribute case insensitive value.
Note: Uses Predicate
__Parameters:__
[String] value - the value of the attribute that the element must have
[String] class_name - the tag name to match
__Returns:__
[Array<Element>]
--
##### [find_ele_by_attr_include](https://github.com/appium/ruby_lib/blob/06f2e54b4b55df25e624272b5a2cd7b23a000298/lib/appium_lib/ios/common/helper.rb#L191) ios
> def find_ele_by_attr_include(class_name, attr, value)
Get the first tag by attribute that exactly matches value.
Note: Uses XPath
__Parameters:__
[String] class_name - 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/06f2e54b4b55df25e624272b5a2cd7b23a000298/lib/appium_lib/ios/common/helper.rb#L201) ios
> def find_eles_by_attr_include(class_name, attr, value)
Get tags by attribute that include value.
Note: Uses XPath
__Parameters:__
[String] class_name - 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_predicate_include](https://github.com/appium/ruby_lib/blob/06f2e54b4b55df25e624272b5a2cd7b23a000298/lib/appium_lib/ios/common/helper.rb#L209) ios
> def find_ele_by_predicate_include(class_name: '*', value:)
Get the first elements that include insensitive value.
Note: Uses Predicate
__Parameters:__
[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_predicate_include](https://github.com/appium/ruby_lib/blob/06f2e54b4b55df25e624272b5a2cd7b23a000298/lib/appium_lib/ios/common/helper.rb#L221) ios
> def find_eles_by_predicate_include(class_name: '*', value:)
Get elements that include case insensitive value.
Note: Uses Predicate
__Parameters:__
[String] value - the value of the attribute that the element must include
[String] class_name - the tag name to match
__Returns:__
[Array<Element>] the elements of type tag who's attribute includes value
--
##### [first_ele](https://github.com/appium/ruby_lib/blob/06f2e54b4b55df25e624272b5a2cd7b23a000298/lib/appium_lib/ios/common/helper.rb#L234) ios
> def first_ele(class_name)
Get the first tag that matches class_name
__Parameters:__
[String] class_name - the tag to match
__Returns:__
[Element]
--
##### [last_ele](https://github.com/appium/ruby_lib/blob/06f2e54b4b55df25e624272b5a2cd7b23a000298/lib/appium_lib/ios/common/helper.rb#L241) ios
> def last_ele(class_name)
Get the last tag that matches class_name
__Parameters:__
[String] class_name - the tag to match
__Returns:__
[Element]
--
##### [tag](https://github.com/appium/ruby_lib/blob/06f2e54b4b55df25e624272b5a2cd7b23a000298/lib/appium_lib/ios/common/helper.rb#L249) ios
> def tag(class_name)
Returns the first **visible** element matching class_name
__Parameters:__
[String] class_name - the class_name to search for
__Returns:__
[Element]
--
##### [tags](https://github.com/appium/ruby_lib/blob/06f2e54b4b55df25e624272b5a2cd7b23a000298/lib/appium_lib/ios/common/helper.rb#L257) ios
> def tags(class_name)
Returns all visible elements matching class_name
__Parameters:__
[String] class_name - the class_name to search for
__Returns:__
[Element]
--
##### [tags_include](https://github.com/appium/ruby_lib/blob/06f2e54b4b55df25e624272b5a2cd7b23a000298/lib/appium_lib/ios/common/helper.rb#L268) ios
> def tags_include(class_names:, value: nil)
Returns all visible elements matching class_names and value
This method calls find_element/s and element.value/text many times.
So, if you set many class_names, this method's performance become worse.
__Parameters:__
[Array[String]] class_names - the class_names to search for
[String] value - the value to search for
__Returns:__
[Array[Element]]
--
##### [tags_exact](https://github.com/appium/ruby_lib/blob/06f2e54b4b55df25e624272b5a2cd7b23a000298/lib/appium_lib/ios/common/helper.rb#L283) ios
> def tags_exact(class_names:, value: nil)
Returns all visible elements matching class_names and value.
This method calls find_element/s and element.value/text many times.
So, if you set many class_names, this method's performance become worse.
__Parameters:__
[Array[String]] class_names - the class_names to search for
[String] value - the value to search for
__Returns:__
[Array[Element]]
--
##### [ele_by_json_visible_contains](https://github.com/appium/ruby_lib/blob/06f2e54b4b55df25e624272b5a2cd7b23a000298/lib/appium_lib/ios/common/helper.rb#L320) ios
> def ele_by_json_visible_contains(element, value)
Find the first element that contains value.
For Appium(automation name), not XCUITest
__Parameters:__
[String] element - the class name for the element
[String] value - the value to search for
__Returns:__
[Element]
--
##### [eles_by_json_visible_contains](https://github.com/appium/ruby_lib/blob/06f2e54b4b55df25e624272b5a2cd7b23a000298/lib/appium_lib/ios/common/helper.rb#L329) ios
> def eles_by_json_visible_contains(element, value)
Find all elements containing value
For Appium(automation name), not XCUITest
__Parameters:__
[String] element - the class name for the element
[String] value - the value to search for
__Returns:__
[Array<Element>]
--
##### [ele_by_json_visible_exact](https://github.com/appium/ruby_lib/blob/06f2e54b4b55df25e624272b5a2cd7b23a000298/lib/appium_lib/ios/common/helper.rb#L359) ios
> def ele_by_json_visible_exact(element, value)
Find the first element exactly matching value
For Appium(automation name), not XCUITest
__Parameters:__
[String] element - the class name for the element
[String] value - the value to search for
__Returns:__
[Element]
--
##### [eles_by_json_visible_exact](https://github.com/appium/ruby_lib/blob/06f2e54b4b55df25e624272b5a2cd7b23a000298/lib/appium_lib/ios/common/helper.rb#L368) ios
> def eles_by_json_visible_exact(element, value)
Find all elements exactly matching value
For Appium(automation name), not XCUITest
__Parameters:__
[String] element - the class name for the element
[String] value - the value to search for
__Returns:__
[Element]
--
##### [_all_pred](https://github.com/appium/ruby_lib/blob/06f2e54b4b55df25e624272b5a2cd7b23a000298/lib/appium_lib/ios/common/helper.rb#L377) ios
> def _all_pred(opts)
predicate - the predicate to evaluate on the main app
visible - if true, only visible elements are returned. default true
--
##### [ele_with_pred](https://github.com/appium/ruby_lib/blob/06f2e54b4b55df25e624272b5a2cd7b23a000298/lib/appium_lib/ios/common/helper.rb#L391) ios
> def ele_with_pred(opts)
returns element matching predicate contained in the main app
predicate - the predicate to evaluate on the main app
visible - if true, only visible elements are returned. default true
__Returns:__
[Element]
--
##### [eles_with_pred](https://github.com/appium/ruby_lib/blob/06f2e54b4b55df25e624272b5a2cd7b23a000298/lib/appium_lib/ios/common/helper.rb#L402) ios
> def eles_with_pred(opts)
returns elements matching predicate contained in the main app
predicate - the predicate to evaluate on the main app
visible - if true, only visible elements are returned. default true
__Returns:__
[Array<Element>]
--
##### [_validate_object](https://github.com/appium/ruby_lib/blob/06f2e54b4b55df25e624272b5a2cd7b23a000298/lib/appium_lib/ios/common/helper.rb#L406) ios
> def _validate_object(*objects)
--
##### [_by_json](https://github.com/appium/ruby_lib/blob/06f2e54b4b55df25e624272b5a2cd7b23a000298/lib/appium_lib/ios/common/helper.rb#L456) ios
> def _by_json(opts)
For Appium(automation name), not XCUITest
typeArray - array of string types to search for. Example: ["UIAStaticText"]
onlyFirst - boolean. returns only the first result if true. Example: true
onlyVisible - boolean. returns only visible elements if true. Example: true
target - string. the target value to search for. Example: "Buttons, Various uses of UIButton"
substring - boolean. matches on substrings if true otherwise an exact mathc is required. Example: true
insensitive - boolean. ignores case sensitivity if true otherwise it's case sensitive. Example: true
opts = {
typeArray: ["UIAStaticText"],
onlyFirst: true,
onlyVisible: true,
name: {
target: "Buttons, Various uses of UIButton",
substring: false,
insensitive: false,
},
label: {
target: "Buttons, Various uses of UIButton",
substring: false,
insensitive: false,
},
value: {
target: "Buttons, Various uses of UIButton",
substring: false,
insensitive: false,
}
}
--
##### [eles_by_json](https://github.com/appium/ruby_lib/blob/06f2e54b4b55df25e624272b5a2cd7b23a000298/lib/appium_lib/ios/common/helper.rb#L506) ios
> def eles_by_json(opts)
For Appium(automation name), not XCUITest
example usage:
eles_by_json({
typeArray: ["UIAStaticText"],
onlyVisible: true,
name: {
target: "Buttons, Various uses of UIButton",
substring: false,
insensitive: false,
},
})
--
##### [ele_by_json](https://github.com/appium/ruby_lib/blob/06f2e54b4b55df25e624272b5a2cd7b23a000298/lib/appium_lib/ios/common/helper.rb#L512) ios
> def ele_by_json(opts)
see eles_by_json
--
##### [alert_accept](https://github.com/appium/ruby_lib/blob/06f2e54b4b55df25e624272b5a2cd7b23a000298/lib/appium_lib/ios/element/alert.rb#L19) ios
> def alert_accept
Accept the alert.
__Returns:__
[void]
--
##### [alert_dismiss](https://github.com/appium/ruby_lib/blob/06f2e54b4b55df25e624272b5a2cd7b23a000298/lib/appium_lib/ios/element/alert.rb#L27) ios
> def alert_dismiss
Dismiss the alert.
__Returns:__
[void]
--
##### [button_class](https://github.com/appium/ruby_lib/blob/06f2e54b4b55df25e624272b5a2cd7b23a000298/lib/appium_lib/ios/element/button.rb#L25) ios
> def button_class
__Returns:__
[String] Class name for button
--
##### [button](https://github.com/appium/ruby_lib/blob/06f2e54b4b55df25e624272b5a2cd7b23a000298/lib/appium_lib/ios/element/button.rb#L33) ios
> def button(value)
Find the first UIAButton|XCUIElementTypeButton that contains value or by index.
If int then the UIAButton|XCUIElementTypeButton at that index is returned.
__Parameters:__
[String, Integer] value - the value to exactly match.
__Returns:__
[UIA_BUTTON|XCUIELEMENT_TYPE_BUTTON]
--
##### [buttons](https://github.com/appium/ruby_lib/blob/06f2e54b4b55df25e624272b5a2cd7b23a000298/lib/appium_lib/ios/element/button.rb#L44) ios
> def buttons(value = false)
Find all UIAButtons|XCUIElementTypeButtons containing value.
If value is omitted, all UIAButtons|XCUIElementTypeButtons are returned.
__Parameters:__
[String] value - the value to search for
__Returns:__
[Array<UIA_BUTTON|XCUIELEMENT_TYPE_BUTTON>]
--
##### [first_button](https://github.com/appium/ruby_lib/blob/06f2e54b4b55df25e624272b5a2cd7b23a000298/lib/appium_lib/ios/element/button.rb#L52) ios
> def first_button
Find the first UIAButton|XCUIElementTypeButton.
__Returns:__
[UIA_BUTTON|XCUIELEMENT_TYPE_BUTTON]
--
##### [last_button](https://github.com/appium/ruby_lib/blob/06f2e54b4b55df25e624272b5a2cd7b23a000298/lib/appium_lib/ios/element/button.rb#L60) ios
> def last_button
TODO: add documentation regarding previous element.
Previous UIAElement is differ from UIAButton|XCUIElementTypeButton. So, the results are different.
Find the last UIAButton|XCUIElementTypeButton.
__Returns:__
[UIA_BUTTON|XCUIELEMENT_TYPE_BUTTON]
--
##### [button_exact](https://github.com/appium/ruby_lib/blob/06f2e54b4b55df25e624272b5a2cd7b23a000298/lib/appium_lib/ios/element/button.rb#L67) ios
> def button_exact(value)
Find the first UIAButton|XCUIElementTypeButton that exactly matches value.
__Parameters:__
[String] value - the value to match exactly
__Returns:__
[UIA_BUTTON|XCUIELEMENT_TYPE_BUTTON]
--
##### [buttons_exact](https://github.com/appium/ruby_lib/blob/06f2e54b4b55df25e624272b5a2cd7b23a000298/lib/appium_lib/ios/element/button.rb#L74) ios
> def buttons_exact(value)
Find all UIAButtons|XCUIElementTypeButtons that exactly match value.
__Parameters:__
[String] value - the value to match exactly
__Returns:__
[Array<UIA_BUTTON|XCUIELEMENT_TYPE_BUTTON>]
--
##### [find](https://github.com/appium/ruby_lib/blob/06f2e54b4b55df25e624272b5a2cd7b23a000298/lib/appium_lib/ios/element/generic.rb#L20) ios
> def find(value)
Find the first element containing value
__Parameters:__
[String] value - the value to search for
__Returns:__
[Element]
--
##### [finds](https://github.com/appium/ruby_lib/blob/06f2e54b4b55df25e624272b5a2cd7b23a000298/lib/appium_lib/ios/element/generic.rb#L27) ios
> def finds(value)
Find all elements containing value
__Parameters:__
[String] value - the value to search for
__Returns:__
[Array<Element>]
--
##### [find_exact](https://github.com/appium/ruby_lib/blob/06f2e54b4b55df25e624272b5a2cd7b23a000298/lib/appium_lib/ios/element/generic.rb#L34) ios
> def find_exact(value)
Find the first element exactly matching value
__Parameters:__
[String] value - the value to search for
__Returns:__
[Element]
--
##### [finds_exact](https://github.com/appium/ruby_lib/blob/06f2e54b4b55df25e624272b5a2cd7b23a000298/lib/appium_lib/ios/element/generic.rb#L41) ios
> def finds_exact(value)
Find all elements exactly matching value
__Parameters:__
[String] value - the value to search for
__Returns:__
[Array<Element>]
--
##### [raise_error_if_no_element](https://github.com/appium/ruby_lib/blob/06f2e54b4b55df25e624272b5a2cd7b23a000298/lib/appium_lib/ios/element/generic.rb#L47) ios
> def raise_error_if_no_element(element)
--
##### [select_visible_elements](https://github.com/appium/ruby_lib/blob/06f2e54b4b55df25e624272b5a2cd7b23a000298/lib/appium_lib/ios/element/generic.rb#L55) ios
> def select_visible_elements(elements)
Return visible elements.
--
##### [for](https://github.com/appium/ruby_lib/blob/06f2e54b4b55df25e624272b5a2cd7b23a000298/lib/appium_lib/ios/xcuitest/bridge.rb#L21) ios
> def for(target)
--
##### [last_ele](https://github.com/appium/ruby_lib/blob/06f2e54b4b55df25e624272b5a2cd7b23a000298/lib/appium_lib/ios/xcuitest/helper.rb#L40) ios
> def last_ele(class_name)
Get the last tag that matches class_name
__Parameters:__
[String] class_name - the tag to match
__Returns:__
[Element]
--
##### [tag](https://github.com/appium/ruby_lib/blob/06f2e54b4b55df25e624272b5a2cd7b23a000298/lib/appium_lib/ios/xcuitest/helper.rb#L51) ios
> def tag(class_name)
Returns the first **visible** element matching class_name
__Parameters:__
[String] class_name - the class_name to search for
__Returns:__
[Element]
--
##### [tags](https://github.com/appium/ruby_lib/blob/06f2e54b4b55df25e624272b5a2cd7b23a000298/lib/appium_lib/ios/xcuitest/helper.rb#L59) ios
> def tags(class_name)
Returns all visible elements matching class_name
__Parameters:__
[String] class_name - the class_name to search for
__Returns:__
[Element]
--
##### [tags_include](https://github.com/appium/ruby_lib/blob/06f2e54b4b55df25e624272b5a2cd7b23a000298/lib/appium_lib/ios/xcuitest/helper.rb#L71) ios
> def tags_include(class_names:, value: nil)
Returns all visible elements matching class_names and value
This method calls find_element/s and element.value/text many times.
So, if you set many class_names, this method's performance become worse.
__Parameters:__
[Array[String]] class_names - the class_names to search for
[String] value - the value to search for
__Returns:__
[Array[Element]]
--
##### [tags_exact](https://github.com/appium/ruby_lib/blob/06f2e54b4b55df25e624272b5a2cd7b23a000298/lib/appium_lib/ios/xcuitest/helper.rb#L93) ios
> def tags_exact(class_names:, value: nil)
Returns all visible elements matching class_names and value.
This method calls find_element/s and element.value/text many times.
So, if you set many class_names, this method's performance become worse.
__Parameters:__
[Array[String]] class_names - the class_names to search for
[String] value - the value to search for
__Returns:__
[Array[Element]]
--
##### [start_logs_broadcast](https://github.com/appium/ruby_lib/blob/06f2e54b4b55df25e624272b5a2cd7b23a000298/lib/appium_lib/ios/xcuitest/command.rb#L33) ios
> def start_logs_broadcast(syslog_file = 'syslog.log')
Starts iOS syslog broadcast websocket
__Parameters:__
[String] syslog_file - A file path to write messages from a syslog WebSocket client
--
##### [stop_logs_broadcast](https://github.com/appium/ruby_lib/blob/06f2e54b4b55df25e624272b5a2cd7b23a000298/lib/appium_lib/ios/xcuitest/command.rb#L46) ios
> def stop_logs_broadcast
Stop iOS syslog broadcast websocket
--
##### [text_field_class](https://github.com/appium/ruby_lib/blob/06f2e54b4b55df25e624272b5a2cd7b23a000298/lib/appium_lib/ios/element/textfield.rb#L28) ios
> def text_field_class
__Returns:__
[String] Class name for text field
--
##### [secure_text_field_class](https://github.com/appium/ruby_lib/blob/06f2e54b4b55df25e624272b5a2cd7b23a000298/lib/appium_lib/ios/element/textfield.rb#L33) ios
> def secure_text_field_class
__Returns:__
[String] Class name for secure text field
--
##### [textfield](https://github.com/appium/ruby_lib/blob/06f2e54b4b55df25e624272b5a2cd7b23a000298/lib/appium_lib/ios/element/textfield.rb#L42) ios
> def textfield(value)
Find the first TextField that contains value or by index.
Note: Uses XPath
If int then the TextField at that index is returned.
__Parameters:__
[String, Integer] value - the text to match exactly.
__Returns:__
[TextField]
--
##### [textfields](https://github.com/appium/ruby_lib/blob/06f2e54b4b55df25e624272b5a2cd7b23a000298/lib/appium_lib/ios/element/textfield.rb#L61) ios
> def textfields(value = false)
Find all TextFields containing value.
If value is omitted, all TextFields are returned.
__Parameters:__
[String] value - the value to search for
__Returns:__
[Array<TextField>]
--
##### [first_textfield](https://github.com/appium/ruby_lib/blob/06f2e54b4b55df25e624272b5a2cd7b23a000298/lib/appium_lib/ios/element/textfield.rb#L69) ios
> def first_textfield
Find the first TextField.
__Returns:__
[TextField]
--
##### [last_textfield](https://github.com/appium/ruby_lib/blob/06f2e54b4b55df25e624272b5a2cd7b23a000298/lib/appium_lib/ios/element/textfield.rb#L75) ios
> def last_textfield
Find the last TextField.
__Returns:__
[TextField]
--
##### [textfield_exact](https://github.com/appium/ruby_lib/blob/06f2e54b4b55df25e624272b5a2cd7b23a000298/lib/appium_lib/ios/element/textfield.rb#L85) ios
> def textfield_exact(value)
Find the first TextField that exactly matches value.
__Parameters:__
[String] value - the value to match exactly
__Returns:__
[TextField]
--
##### [textfields_exact](https://github.com/appium/ruby_lib/blob/06f2e54b4b55df25e624272b5a2cd7b23a000298/lib/appium_lib/ios/element/textfield.rb#L92) ios
> def textfields_exact(value)
Find all TextFields that exactly match value.
__Parameters:__
[String] value - the value to match exactly
__Returns:__
[Array<TextField>]
--
##### [_textfield_visible](https://github.com/appium/ruby_lib/blob/06f2e54b4b55df25e624272b5a2cd7b23a000298/lib/appium_lib/ios/element/textfield.rb#L99) ios
> def _textfield_visible
Appium
--
##### [_textfield_exact_string](https://github.com/appium/ruby_lib/blob/06f2e54b4b55df25e624272b5a2cd7b23a000298/lib/appium_lib/ios/element/textfield.rb#L104) ios
> def _textfield_exact_string(value)
Appium
--
##### [_textfield_contains_string](https://github.com/appium/ruby_lib/blob/06f2e54b4b55df25e624272b5a2cd7b23a000298/lib/appium_lib/ios/element/textfield.rb#L111) ios
> def _textfield_contains_string(value)
Appium
--
##### [static_text_class](https://github.com/appium/ruby_lib/blob/06f2e54b4b55df25e624272b5a2cd7b23a000298/lib/appium_lib/ios/xcuitest/element/text.rb#L23) ios
> def static_text_class
__Returns:__
[String] Class name for text
--
##### [text](https://github.com/appium/ruby_lib/blob/06f2e54b4b55df25e624272b5a2cd7b23a000298/lib/appium_lib/ios/xcuitest/element/text.rb#L31) ios
> def text(value)
Find the first UIAStaticText|XCUIElementTypeStaticText that contains value or by index.
If int then the UIAStaticText|XCUIElementTypeStaticText at that index is returned.
__Parameters:__
[String, Integer] value - the value to find.
__Returns:__
[UIA_STATIC_TEXT|XCUIELEMENT_TYPE_STATIC_TEXT]
--
##### [texts](https://github.com/appium/ruby_lib/blob/06f2e54b4b55df25e624272b5a2cd7b23a000298/lib/appium_lib/ios/xcuitest/element/text.rb#L41) ios
> def texts(value = false)
Find all UIAStaticTexts|XCUIElementTypeStaticTexts containing value.
If value is omitted, all UIAStaticTexts|XCUIElementTypeStaticTexts are returned
__Parameters:__
[String] value - the value to search for
__Returns:__
[Array<UIA_STATIC_TEXT|XCUIELEMENT_TYPE_STATIC_TEXT>]
--
##### [first_text](https://github.com/appium/ruby_lib/blob/06f2e54b4b55df25e624272b5a2cd7b23a000298/lib/appium_lib/ios/xcuitest/element/text.rb#L50) ios
> def first_text
Find the first UIAStaticText|XCUIElementTypeStaticText.
__Returns:__
[UIA_STATIC_TEXT|XCUIELEMENT_TYPE_STATIC_TEXT]
--
##### [last_text](https://github.com/appium/ruby_lib/blob/06f2e54b4b55df25e624272b5a2cd7b23a000298/lib/appium_lib/ios/xcuitest/element/text.rb#L56) ios
> def last_text
Find the last UIAStaticText|XCUIElementTypeStaticText.
__Returns:__
[UIA_STATIC_TEXT|XCUIELEMENT_TYPE_STATIC_TEXT]
--
##### [text_exact](https://github.com/appium/ruby_lib/blob/06f2e54b4b55df25e624272b5a2cd7b23a000298/lib/appium_lib/ios/xcuitest/element/text.rb#L63) ios
> def text_exact(value)
Find the first UIAStaticText|XCUIElementTypeStaticText that exactly matches value.
__Parameters:__
[String] value - the value to match exactly
__Returns:__
[UIA_STATIC_TEXT|XCUIELEMENT_TYPE_STATIC_TEXT]
--
##### [texts_exact](https://github.com/appium/ruby_lib/blob/06f2e54b4b55df25e624272b5a2cd7b23a000298/lib/appium_lib/ios/xcuitest/element/text.rb#L70) ios
> def texts_exact(value)
Find all UIAStaticTexts|XCUIElementTypeStaticTexts that exactly match value.
__Parameters:__
[String] value - the value to match exactly
__Returns:__
[Array<UIA_STATIC_TEXT|XCUIELEMENT_TYPE_STATIC_TEXT>]
--
##### [xcuitest_source](https://github.com/appium/ruby_lib/blob/06f2e54b4b55df25e624272b5a2cd7b23a000298/lib/appium_lib/ios/xcuitest/command/source.rb#L25) ios
> def xcuitest_source(format: :xml)
__Parameters:__
[String|Symbol] format - :xml or :json. :xml is by default.
```ruby
xcuitest_source format: :json
```
--
##### [button_class](https://github.com/appium/ruby_lib/blob/06f2e54b4b55df25e624272b5a2cd7b23a000298/lib/appium_lib/ios/xcuitest/element/button.rb#L23) ios
> def button_class
__Returns:__
[String] Class name for button
--
##### [button](https://github.com/appium/ruby_lib/blob/06f2e54b4b55df25e624272b5a2cd7b23a000298/lib/appium_lib/ios/xcuitest/element/button.rb#L31) ios
> def button(value)
Find the first UIAButton|XCUIElementTypeButton that contains value or by index.
If int then the UIAButton|XCUIElementTypeButton at that index is returned.
__Parameters:__
[String, Integer] value - the value to exactly match.
__Returns:__
[UIA_BUTTON|XCUIELEMENT_TYPE_BUTTON]
--
##### [buttons](https://github.com/appium/ruby_lib/blob/06f2e54b4b55df25e624272b5a2cd7b23a000298/lib/appium_lib/ios/xcuitest/element/button.rb#L42) ios
> def buttons(value = false)
Find all UIAButtons|XCUIElementTypeButtons containing value.
If value is omitted, all UIAButtons|XCUIElementTypeButtons are returned.
__Parameters:__
[String] value - the value to search for
__Returns:__
[Array<UIA_BUTTON|XCUIELEMENT_TYPE_BUTTON>]
--
##### [first_button](https://github.com/appium/ruby_lib/blob/06f2e54b4b55df25e624272b5a2cd7b23a000298/lib/appium_lib/ios/xcuitest/element/button.rb#L51) ios
> def first_button
Find the first UIAButton|XCUIElementTypeButton.
__Returns:__
[UIA_BUTTON|XCUIELEMENT_TYPE_BUTTON]
--
##### [last_button](https://github.com/appium/ruby_lib/blob/06f2e54b4b55df25e624272b5a2cd7b23a000298/lib/appium_lib/ios/xcuitest/element/button.rb#L59) ios
> def last_button
TODO: add documentation regarding previous element.
Previous UIAElement is differ from UIAButton|XCUIElementTypeButton. So, the results are different.
Find the last UIAButton|XCUIElementTypeButton.
__Returns:__
[UIA_BUTTON|XCUIELEMENT_TYPE_BUTTON]
--
##### [button_exact](https://github.com/appium/ruby_lib/blob/06f2e54b4b55df25e624272b5a2cd7b23a000298/lib/appium_lib/ios/xcuitest/element/button.rb#L66) ios
> def button_exact(value)
Find the first UIAButton|XCUIElementTypeButton that exactly matches value.
__Parameters:__
[String] value - the value to match exactly
__Returns:__
[UIA_BUTTON|XCUIELEMENT_TYPE_BUTTON]
--
##### [buttons_exact](https://github.com/appium/ruby_lib/blob/06f2e54b4b55df25e624272b5a2cd7b23a000298/lib/appium_lib/ios/xcuitest/element/button.rb#L73) ios
> def buttons_exact(value)
Find all UIAButtons|XCUIElementTypeButtons that exactly match value.
__Parameters:__
[String] value - the value to match exactly
__Returns:__
[Array<UIA_BUTTON|XCUIELEMENT_TYPE_BUTTON>]
--
##### [find](https://github.com/appium/ruby_lib/blob/06f2e54b4b55df25e624272b5a2cd7b23a000298/lib/appium_lib/ios/xcuitest/element/generic.rb#L22) ios
> def find(value)
Find the first element containing value
__Parameters:__
[String] value - the value to search for
__Returns:__
[Element]
--
##### [finds](https://github.com/appium/ruby_lib/blob/06f2e54b4b55df25e624272b5a2cd7b23a000298/lib/appium_lib/ios/xcuitest/element/generic.rb#L29) ios
> def finds(value)
Find all elements containing value
__Parameters:__
[String] value - the value to search for
__Returns:__
[Array<Element>]
--
##### [find_exact](https://github.com/appium/ruby_lib/blob/06f2e54b4b55df25e624272b5a2cd7b23a000298/lib/appium_lib/ios/xcuitest/element/generic.rb#L37) ios
> def find_exact(value)
Find the first element exactly matching value
__Parameters:__
[String] value - the value to search for
__Returns:__
[Element]
--
##### [finds_exact](https://github.com/appium/ruby_lib/blob/06f2e54b4b55df25e624272b5a2cd7b23a000298/lib/appium_lib/ios/xcuitest/element/generic.rb#L44) ios
> def finds_exact(value)
Find all elements exactly matching value
__Parameters:__
[String] value - the value to search for
__Returns:__
[Array<Element>]
--
##### [raise_error_if_no_element](https://github.com/appium/ruby_lib/blob/06f2e54b4b55df25e624272b5a2cd7b23a000298/lib/appium_lib/ios/xcuitest/element/generic.rb#L51) ios
> def raise_error_if_no_element(element)
--
##### [select_visible_elements](https://github.com/appium/ruby_lib/blob/06f2e54b4b55df25e624272b5a2cd7b23a000298/lib/appium_lib/ios/xcuitest/element/generic.rb#L59) ios
> def select_visible_elements(elements)
Return visible elements.
--
##### [swipe](https://github.com/appium/ruby_lib/blob/06f2e54b4b55df25e624272b5a2cd7b23a000298/lib/appium_lib/ios/xcuitest/command/gestures.rb#L25) ios
> def swipe(direction:, element: nil)
__Parameters:__
[string] direction - Either 'up', 'down', 'left' or 'right'.
[Hash] opts - a customizable set of options
--
##### [scroll](https://github.com/appium/ruby_lib/blob/06f2e54b4b55df25e624272b5a2cd7b23a000298/lib/appium_lib/ios/xcuitest/command/gestures.rb#L46) ios
> def scroll(direction:, distance: nil, name: nil, element: nil, to_visible: nil, predicate_string: nil)
rubocop:disable Metrics/ParameterLists
__Parameters:__
[string] direction - Either 'up', 'down', 'left' or 'right'.
[Hash] opts - a customizable set of options
--
##### [pinch](https://github.com/appium/ruby_lib/blob/06f2e54b4b55df25e624272b5a2cd7b23a000298/lib/appium_lib/ios/xcuitest/command/gestures.rb#L67) ios
> def pinch(scale:, velocity: 1.0, element: nil)
__Parameters:__
[scale] scale - X tap coordinate of type float. Mandatory parameter
[float] velocity - Y tap coordinate of type float. Mandatory parameter
[Hash] opts - a customizable set of options
--
##### [double_tap](https://github.com/appium/ruby_lib/blob/06f2e54b4b55df25e624272b5a2cd7b23a000298/lib/appium_lib/ios/xcuitest/command/gestures.rb#L82) ios
> def double_tap(x: nil, y: nil, element: nil)
__Parameters:__
[float] x - X Screen x tap coordinate of type float. Mandatory parameter only if element is not set
[float] y - Y Screen y tap coordinate of type float. Mandatory parameter only if element is not set
[Hash] opts - a customizable set of options
--
##### [touch_and_hold](https://github.com/appium/ruby_lib/blob/06f2e54b4b55df25e624272b5a2cd7b23a000298/lib/appium_lib/ios/xcuitest/command/gestures.rb#L99) ios
> def touch_and_hold(x: nil, y: nil, element: nil, duration: 1.0)
__Parameters:__
[float] x - Screen x long tap coordinate of type float. Mandatory parameter only if element is not set
[float] y - Screen y long tap coordinate of type float. Mandatory parameter only if element is not set
[Float] duration - The float duration of press action in seconds. Mandatory parameter
[Hash] opts - a customizable set of options
--
##### [two_finger_tap](https://github.com/appium/ruby_lib/blob/06f2e54b4b55df25e624272b5a2cd7b23a000298/lib/appium_lib/ios/xcuitest/command/gestures.rb#L112) ios
> def two_finger_tap(element:)
__Parameters:__
[Element] element - Element to long tap on.
```ruby
two_finger_tap element: find_element(:accessibility_id, "some item")
```
--
##### [one_finger_tap](https://github.com/appium/ruby_lib/blob/06f2e54b4b55df25e624272b5a2cd7b23a000298/lib/appium_lib/ios/xcuitest/command/gestures.rb#L127) ios
> def one_finger_tap(x:, y:, element: nil)
__Parameters:__
[float] x - X tap coordinate of type float. Mandatory parameter
[float] y - Y tap coordinate of type float. Mandatory parameter
[Hash] opts - a customizable set of options
--
##### [drag_from_to_for_duration](https://github.com/appium/ruby_lib/blob/06f2e54b4b55df25e624272b5a2cd7b23a000298/lib/appium_lib/ios/xcuitest/command/gestures.rb#L147) ios
> def drag_from_to_for_duration(from_x:, from_y:, to_x:, to_y:, duration: 1.0, element: nil)
rubocop:disable Metrics/ParameterLists
__Parameters:__
[float] duration - Float number of seconds in range [0.5, 60]. How long the tap gesture at starting
drag point should be before to start dragging. Mandatory parameter
[float] from_x - The x coordinate of starting drag point (type float). Mandatory parameter
[float] from_y - The y coordinate of starting drag point (type float). Mandatory parameter
[float] to_x - The x coordinate of ending drag point (type float). Mandatory parameter
[float] to_y - The y coordinate of ending drag point (type float). Mandatory parameter
[Hash] opts - a customizable set of options
--
##### [select_picker_wheel](https://github.com/appium/ruby_lib/blob/06f2e54b4b55df25e624272b5a2cd7b23a000298/lib/appium_lib/ios/xcuitest/command/gestures.rb#L164) ios
> def select_picker_wheel(element:, order:, offset: nil)
https://github.com/facebook/WebDriverAgent/pull/523
https://github.com/appium/appium-xcuitest-driver/pull/420
__Parameters:__
[String] order - The order to move picker to. "next" or "previous".
[Element] element - Element id to perform select picker wheel on.
[Hash] opts - a customizable set of options
--
##### [alert](https://github.com/appium/ruby_lib/blob/06f2e54b4b55df25e624272b5a2cd7b23a000298/lib/appium_lib/ios/xcuitest/command/gestures.rb#L182) ios
> def alert(action:, button_label: nil)
__Parameters:__
[String] action - The following actions are supported: accept, dismiss and getButtons. Mandatory parameter
[String] button_label - The label text of an existing alert button to click on.
This is an optional parameter and is only valid in combination with accept and dismiss actions.
__Returns:__
[] {} or Selenium::WebDriver::Error::NoSuchAlertError if no action sheet or alert
or button labels if action is equal to getButtons.
```ruby
alert action: "accept"
alert action: "dismiss"
```
--
##### [text_field_class](https://github.com/appium/ruby_lib/blob/06f2e54b4b55df25e624272b5a2cd7b23a000298/lib/appium_lib/ios/xcuitest/element/textfield.rb#L23) ios
> def text_field_class
__Returns:__
[String] Class name for text field
--
##### [secure_text_field_class](https://github.com/appium/ruby_lib/blob/06f2e54b4b55df25e624272b5a2cd7b23a000298/lib/appium_lib/ios/xcuitest/element/textfield.rb#L28) ios
> def secure_text_field_class
__Returns:__
[String] Class name for secure text field
--
##### [textfield](https://github.com/appium/ruby_lib/blob/06f2e54b4b55df25e624272b5a2cd7b23a000298/lib/appium_lib/ios/xcuitest/element/textfield.rb#L37) ios
> def textfield(value)
Find the first TextField that contains value or by index.
Note: Uses XPath
If int then the TextField at that index is returned.
__Parameters:__
[String, Integer] value - the text to match exactly.
__Returns:__
[TextField]
--
##### [textfields](https://github.com/appium/ruby_lib/blob/06f2e54b4b55df25e624272b5a2cd7b23a000298/lib/appium_lib/ios/xcuitest/element/textfield.rb#L57) ios
> def textfields(value = false)
Find all TextFields containing value.
If value is omitted, all TextFields are returned.
__Parameters:__
[String] value - the value to search for
__Returns:__
[Array<TextField>]
--
##### [first_textfield](https://github.com/appium/ruby_lib/blob/06f2e54b4b55df25e624272b5a2cd7b23a000298/lib/appium_lib/ios/xcuitest/element/textfield.rb#L66) ios
> def first_textfield
Find the first TextField.
__Returns:__
[TextField]
--
##### [last_textfield](https://github.com/appium/ruby_lib/blob/06f2e54b4b55df25e624272b5a2cd7b23a000298/lib/appium_lib/ios/xcuitest/element/textfield.rb#L72) ios
> def last_textfield
Find the last TextField.
__Returns:__
[TextField]
--
##### [textfield_exact](https://github.com/appium/ruby_lib/blob/06f2e54b4b55df25e624272b5a2cd7b23a000298/lib/appium_lib/ios/xcuitest/element/textfield.rb#L82) ios
> def textfield_exact(value)
Find the first TextField that exactly matches value.
__Parameters:__
[String] value - the value to match exactly
__Returns:__
[TextField]
--
##### [textfields_exact](https://github.com/appium/ruby_lib/blob/06f2e54b4b55df25e624272b5a2cd7b23a000298/lib/appium_lib/ios/xcuitest/element/textfield.rb#L89) ios
> def textfields_exact(value)
Find all TextFields that exactly match value.
__Parameters:__
[String] value - the value to match exactly
__Returns:__
[Array<TextField>]
--
##### [set_pasteboard](https://github.com/appium/ruby_lib/blob/06f2e54b4b55df25e624272b5a2cd7b23a000298/lib/appium_lib/ios/xcuitest/command/pasteboard.rb#L26) ios
> def set_pasteboard(content:, encoding: nil)
__Parameters:__
[string] content - The content of the pasteboard. The previous content is going to be overridden.
The parameter is mandatory
[Hash] opts - a customizable set of options
--
##### [get_pasteboard](https://github.com/appium/ruby_lib/blob/06f2e54b4b55df25e624272b5a2cd7b23a000298/lib/appium_lib/ios/xcuitest/command/pasteboard.rb#L38) ios
> def get_pasteboard(encoding: nil)
__Parameters:__
[Hash] opts - a customizable set of options
--
##### [install_certificate](https://github.com/appium/ruby_lib/blob/06f2e54b4b55df25e624272b5a2cd7b23a000298/lib/appium_lib/ios/xcuitest/command/certificate.rb#L32) ios
> def install_certificate(cer_file:)
Generates Apple's over-the-air configuration profile for certificate deployment
based on the given PEM certificate content.
https://developer.apple.com/library/content/documentation/NetworkingInternet/Conceptual/iPhoneOTAConfiguration/Introduction/Introduction.html
https://github.com/appium/appium-xcuitest-driver/pull/652
__Parameters:__
[string] cer_file - The content of the certificate file.
--
##### [xcuitest_get_contexts](https://github.com/appium/ruby_lib/blob/06f2e54b4b55df25e624272b5a2cd7b23a000298/lib/appium_lib/ios/xcuitest/command/get_context.rb#L28) ios
> def xcuitest_get_contexts
Get contexts
--
##### [xcuitest_install_app](https://github.com/appium/ruby_lib/blob/06f2e54b4b55df25e624272b5a2cd7b23a000298/lib/appium_lib/ios/xcuitest/command/multi_app_handler.rb#L35) ios
> def xcuitest_install_app(app:)
Installs given application to the device under test. If the same application is already installed
then it's going to be installed over it, which allows to test upgrades.
Be careful while reinstalling the main application under test - make sure you called terminateApp
for it first, otherwise WebDriverAgent will detect it as a potential application crash.
__Parameters:__
[String] app - The path to an existing .ipa/.app file on the server file system, zipped .app file
or an URL pointing to a remote .ipa/.zip file. Mandatory argument.
__Returns:__
[] {}
--
##### [xcuitest_app_installed?](https://github.com/appium/ruby_lib/blob/06f2e54b4b55df25e624272b5a2cd7b23a000298/lib/appium_lib/ios/xcuitest/command/multi_app_handler.rb#L48) ios
> def xcuitest_app_installed?(bundle_id:)
Verifies whether the application with given bundle identifier is installed on the device.
__Parameters:__
[String] bundle_id - The bundle identifier of the application, which is going to be verified.
__Returns:__
[boolean]
--
##### [xcuitest_remove_app](https://github.com/appium/ruby_lib/blob/06f2e54b4b55df25e624272b5a2cd7b23a000298/lib/appium_lib/ios/xcuitest/command/multi_app_handler.rb#L62) ios
> def xcuitest_remove_app(bundle_id:)
Uninstalls an existing application from the device under test. This endpoint does not verify
whether the application is already installed or not before uninstalling it.
__Parameters:__
[String] bundle_id - The bundle identifier of the application, which is going to be uninstalled.
__Returns:__
[] {}
--
##### [xcuitest_launch_app](https://github.com/appium/ruby_lib/blob/06f2e54b4b55df25e624272b5a2cd7b23a000298/lib/appium_lib/ios/xcuitest/command/multi_app_handler.rb#L76) ios
> def xcuitest_launch_app(bundle_id:)
Executes an existing application on the device. If the application is already running then
it will be brought to the foreground.
__Parameters:__
[String] bundle_id - The bundle identifier of the application, which is going to be executed.
__Returns:__
[] {}
--
##### [xcuitest_terminate_app](https://github.com/appium/ruby_lib/blob/06f2e54b4b55df25e624272b5a2cd7b23a000298/lib/appium_lib/ios/xcuitest/command/multi_app_handler.rb#L91) ios
> def xcuitest_terminate_app(bundle_id:)
Terminates an existing application on the device. If the application is not running then
the returned result will be false, otherwise true.
__Parameters:__
[String] bundle_id - The bundle identifier of the application, which is going to be terminated.
__Returns:__
[] {}
--
##### [xcuitest_query_app_status](https://github.com/appium/ruby_lib/blob/06f2e54b4b55df25e624272b5a2cd7b23a000298/lib/appium_lib/ios/xcuitest/command/multi_app_handler.rb#L112) ios
> def xcuitest_query_app_status(bundle_id:)
Get the status of an existing application on the device.
State:
0: The current application state cannot be determined/is unknown
1: The application is not running
2: The application is running in the background and is suspended
3: The application is running in the background and is not suspended
4: The application is running in the foreground
For more details: https://developer.apple.com/documentation/xctest/xcuiapplicationstate
__Parameters:__
[String] bundle_id - A target app's bundle id
__Returns:__
[0|1|2|3|4] A number of the state
--
##### [xcuitest_activate_app](https://github.com/appium/ruby_lib/blob/06f2e54b4b55df25e624272b5a2cd7b23a000298/lib/appium_lib/ios/xcuitest/command/multi_app_handler.rb#L127) ios
> def xcuitest_activate_app(bundle_id:)
Activates an existing application on the device under test and moves it to the foreground.
The application should be already running in order to activate it.
The call is ignored if the application is already in foreground.
__Parameters:__
[String] bundle_id - The bundle identifier of the application, which is going to be brought to the foreground.
__Returns:__
[] {}
--