##### [load_settings](https://github.com/appium/ruby_lib/blob/a4c238552724878c31d8ff0179ef00d8258c76a4/lib/appium_lib/driver.rb#L91)
> def self.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/a4c238552724878c31d8ff0179ef00d8258c76a4/lib/appium_lib/driver.rb#L127)
> def self.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
rubocop:disable Style/Alias
__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/a4c238552724878c31d8ff0179ef00d8258c76a4/lib/appium_lib/driver.rb#L133)
> def self.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
--
##### [symbolize_keys](https://github.com/appium/ruby_lib/blob/a4c238552724878c31d8ff0179ef00d8258c76a4/lib/appium_lib/driver.rb#L165)
> def self.symbolize_keys(hash)
convert all keys (including nested) to symbols
based on deep_symbolize_keys & deep_transform_keys from rails
https://github.com/rails/docrails/blob/a3b1105ada3da64acfa3843b164b14b734456a50/activesupport/lib/active_support/core_ext/hash/keys.rb#L84
--
##### [promote_singleton_appium_methods](https://github.com/appium/ruby_lib/blob/a4c238552724878c31d8ff0179ef00d8258c76a4/lib/appium_lib/driver.rb#L186)
> def self.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.
--
##### [promote_appium_methods](https://github.com/appium/ruby_lib/blob/a4c238552724878c31d8ff0179ef00d8258c76a4/lib/appium_lib/driver.rb#L239)
> def self.promote_appium_methods(class_array, driver = $driver)
Promote appium methods to class instance methods
To promote methods to all classes:
```ruby
Appium.promote_appium_methods Object
```
It's better to promote on specific classes instead of Object
```ruby
# promote on rspec
Appium.promote_appium_methods RSpec::Core::ExampleGroup
```
```ruby
# promote on minispec
Appium.promote_appium_methods Minitest::Spec
```
__Parameters:__
[Array<Class>] class_array - An array of classes
--
##### [selenium_webdriver_version_more?](https://github.com/appium/ruby_lib/blob/a4c238552724878c31d8ff0179ef00d8258c76a4/lib/appium_lib/driver.rb#L266)
> def self.selenium_webdriver_version_more?(version)
__Returns:__
[Boolean]
--
##### [init_caps_for_appium](https://github.com/appium/ruby_lib/blob/a4c238552724878c31d8ff0179ef00d8258c76a4/lib/appium_lib/driver.rb#L277)
> def self.init_caps_for_appium(opts_caps = {})
__Parameters:__
[Hash] opts_caps - Capabilities for Appium server. All capability keys are converted to lowerCamelCase when
this client sends capabilities to Appium server as JSON format.
__Returns:__
[::Selenium::WebDriver::Remote::W3C::Capabilities] Return instance of Appium::Driver::Capabilities
inherited ::Selenium::WebDriver::Remote::W3C::Capabilities
--
##### [global_webdriver_http_sleep](https://github.com/appium/ruby_lib/blob/a4c238552724878c31d8ff0179ef00d8258c76a4/lib/appium_lib/driver.rb#L290)
> 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/a4c238552724878c31d8ff0179ef00d8258c76a4/lib/appium_lib/driver.rb#L290)
> def global_webdriver_http_sleep=(value)
The amount to sleep in seconds before every webdriver http call.
--
##### [caps](https://github.com/appium/ruby_lib/blob/a4c238552724878c31d8ff0179ef00d8258c76a4/lib/appium_lib/driver.rb#L292)
> def caps
Selenium webdriver capabilities
--
##### [custom_url](https://github.com/appium/ruby_lib/blob/a4c238552724878c31d8ff0179ef00d8258c76a4/lib/appium_lib/driver.rb#L294)
> def custom_url
Custom URL for the selenium server
--
##### [export_session](https://github.com/appium/ruby_lib/blob/a4c238552724878c31d8ff0179ef00d8258c76a4/lib/appium_lib/driver.rb#L296)
> def export_session
Export session id to textfile in /tmp for 3rd party tools
--
##### [default_wait](https://github.com/appium/ruby_lib/blob/a4c238552724878c31d8ff0179ef00d8258c76a4/lib/appium_lib/driver.rb#L301)
> def default_wait
Default wait time for elements to appear
Returns the default client side wait.
This value is independent of what the server is using
__Returns:__
[Integer]
--
##### [sauce_username](https://github.com/appium/ruby_lib/blob/a4c238552724878c31d8ff0179ef00d8258c76a4/lib/appium_lib/driver.rb#L303)
> def sauce_username
Username for use on Sauce Labs. Set `false` to disable Sauce, even when SAUCE_USERNAME is in ENV.
--
##### [sauce_access_key](https://github.com/appium/ruby_lib/blob/a4c238552724878c31d8ff0179ef00d8258c76a4/lib/appium_lib/driver.rb#L305)
> def sauce_access_key
Access Key for use on Sauce Labs. Set `false` to disable Sauce, even when SAUCE_ACCESS_KEY is in ENV.
--
##### [sauce_endpoint](https://github.com/appium/ruby_lib/blob/a4c238552724878c31d8ff0179ef00d8258c76a4/lib/appium_lib/driver.rb#L307)
> def sauce_endpoint
Override the Sauce Appium endpoint to allow e.g. TestObject tests
--
##### [appium_port](https://github.com/appium/ruby_lib/blob/a4c238552724878c31d8ff0179ef00d8258c76a4/lib/appium_lib/driver.rb#L309)
> def appium_port
Appium's server port
--
##### [appium_device](https://github.com/appium/ruby_lib/blob/a4c238552724878c31d8ff0179ef00d8258c76a4/lib/appium_lib/driver.rb#L311)
> def appium_device
Device type to request from the appium server
--
##### [automation_name](https://github.com/appium/ruby_lib/blob/a4c238552724878c31d8ff0179ef00d8258c76a4/lib/appium_lib/driver.rb#L314)
> def automation_name
Automation name sent to appium server or received from server
If automation_name is nil, it is not set both client side and server side.
--
##### [appium_server_status](https://github.com/appium/ruby_lib/blob/a4c238552724878c31d8ff0179ef00d8258c76a4/lib/appium_lib/driver.rb#L316)
> def appium_server_status
Appium's server version
--
##### [appium_debug](https://github.com/appium/ruby_lib/blob/a4c238552724878c31d8ff0179ef00d8258c76a4/lib/appium_lib/driver.rb#L318)
> def appium_debug
Boolean debug mode for the Appium Ruby bindings
--
##### [listener](https://github.com/appium/ruby_lib/blob/a4c238552724878c31d8ff0179ef00d8258c76a4/lib/appium_lib/driver.rb#L320)
> def listener
instance of AbstractEventListener for logging support
--
##### [driver](https://github.com/appium/ruby_lib/blob/a4c238552724878c31d8ff0179ef00d8258c76a4/lib/appium_lib/driver.rb#L323)
> def driver
Returns the driver
__Returns:__
[Driver] the driver
--
##### [http_client](https://github.com/appium/ruby_lib/blob/a4c238552724878c31d8ff0179ef00d8258c76a4/lib/appium_lib/driver.rb#L326)
> def http_client
Return http client called in start_driver()
__Returns:__
[Selenium::WebDriver::Remote::Http::Default] the http client
--
##### [appium_wait_timeout](https://github.com/appium/ruby_lib/blob/a4c238552724878c31d8ff0179ef00d8258c76a4/lib/appium_lib/driver.rb#L331)
> def appium_wait_timeout
Return a time wait timeout
Wait time for ::Appium::Common.wait or ::Appium::Common.wait_true.
Provide Appium::Drive like { appium_lib: { wait_timeout: 20 } }
__Returns:__
[Integer]
--
##### [appium_wait_interval](https://github.com/appium/ruby_lib/blob/a4c238552724878c31d8ff0179ef00d8258c76a4/lib/appium_lib/driver.rb#L336)
> def appium_wait_interval
Return a time wait timeout
Wait interval time for ::Appium::Common.wait or ::Appium::Common.wait_true.
Provide Appium::Drive like { appium_lib: { wait_interval: 20 } }
__Returns:__
[Integer]
--
##### [initialize](https://github.com/appium/ruby_lib/blob/a4c238552724878c31d8ff0179ef00d8258c76a4/lib/appium_lib/driver.rb#L390)
> def initialize(opts = {}, global_driver = true)
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]
--
##### [set_appium_lib_specific_values](https://github.com/appium/ruby_lib/blob/a4c238552724878c31d8ff0179ef00d8258c76a4/lib/appium_lib/driver.rb#L468)
> def set_appium_lib_specific_values(appium_lib_opts)
--
##### [driver_attributes](https://github.com/appium/ruby_lib/blob/a4c238552724878c31d8ff0179ef00d8258c76a4/lib/appium_lib/driver.rb#L494)
> def driver_attributes
Returns a hash of the driver attributes
--
##### [device_is_android?](https://github.com/appium/ruby_lib/blob/a4c238552724878c31d8ff0179ef00d8258c76a4/lib/appium_lib/driver.rb#L513)
> def device_is_android?
__Returns:__
[Boolean]
--
##### [automation_name_is_xcuitest?](https://github.com/appium/ruby_lib/blob/a4c238552724878c31d8ff0179ef00d8258c76a4/lib/appium_lib/driver.rb#L519)
> def automation_name_is_xcuitest?
Return true if automationName is 'XCUITest'
__Returns:__
[Boolean]
--
##### [automation_name_is_uiautomator2?](https://github.com/appium/ruby_lib/blob/a4c238552724878c31d8ff0179ef00d8258c76a4/lib/appium_lib/driver.rb#L525)
> def automation_name_is_uiautomator2?
Return true if automationName is 'uiautomator2'
__Returns:__
[Boolean]
--
##### [automation_name_is_espresso?](https://github.com/appium/ruby_lib/blob/a4c238552724878c31d8ff0179ef00d8258c76a4/lib/appium_lib/driver.rb#L531)
> def automation_name_is_espresso?
Return true if automationName is 'Espresso'
__Returns:__
[Boolean]
--
##### [check_server_version_xcuitest](https://github.com/appium/ruby_lib/blob/a4c238552724878c31d8ff0179ef00d8258c76a4/lib/appium_lib/driver.rb#L538)
> def check_server_version_xcuitest
Return true if the target Appium server is over REQUIRED_VERSION_XCUITEST.
If the Appium server is under REQUIRED_VERSION_XCUITEST, then error is raised.
__Returns:__
[Boolean]
--
##### [appium_server_version](https://github.com/appium/ruby_lib/blob/a4c238552724878c31d8ff0179ef00d8258c76a4/lib/appium_lib/driver.rb#L565)
> def appium_server_version
Returns the server's version info
```ruby
{
"build" => {
"version" => "0.18.1",
"revision" => "d242ebcfd92046a974347ccc3a28f0e898595198"
}
}
```
Returns blank hash for Selenium Grid since `remote_status` gets 500 error
```ruby
{}
```
__Returns:__
[Hash]
--
##### [appium_client_version](https://github.com/appium/ruby_lib/blob/a4c238552724878c31d8ff0179ef00d8258c76a4/lib/appium_lib/driver.rb#L586)
> def appium_client_version
Returns the client's version info
```ruby
{
"version" => "9.1.1"
}
```
__Returns:__
[Hash]
--
##### [absolute_app_path](https://github.com/appium/ruby_lib/blob/a4c238552724878c31d8ff0179ef00d8258c76a4/lib/appium_lib/driver.rb#L598)
> def self.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/a4c238552724878c31d8ff0179ef00d8258c76a4/lib/appium_lib/driver.rb#L631)
> def server_url
Get the server url
__Returns:__
[String] the server url
--
##### [restart](https://github.com/appium/ruby_lib/blob/a4c238552724878c31d8ff0179ef00d8258c76a4/lib/appium_lib/driver.rb#L642)
> def restart
Restarts the driver
__Returns:__
[Driver] the driver
--
##### [screenshot](https://github.com/appium/ruby_lib/blob/a4c238552724878c31d8ff0179ef00d8258c76a4/lib/appium_lib/driver.rb#L653)
> 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/a4c238552724878c31d8ff0179ef00d8258c76a4/lib/appium_lib/driver.rb#L660)
> def driver_quit
Quits the driver
__Returns:__
[void]
--
##### [quit_driver](https://github.com/appium/ruby_lib/blob/a4c238552724878c31d8ff0179ef00d8258c76a4/lib/appium_lib/driver.rb#L668)
> def driver_quit
Quits the driver
Alias for driver_quit
__Returns:__
[void]
--
##### [start_driver](https://github.com/appium/ruby_lib/blob/a4c238552724878c31d8ff0179ef00d8258c76a4/lib/appium_lib/driver.rb#L696)
> def start_driver(http_client_ops = { http_client: nil, 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
__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/a4c238552724878c31d8ff0179ef00d8258c76a4/lib/appium_lib/driver.rb#L736)
> def set_implicit_wait(wait)
To ignore error for Espresso Driver
--
##### [no_wait](https://github.com/appium/ruby_lib/blob/a4c238552724878c31d8ff0179ef00d8258c76a4/lib/appium_lib/driver.rb#L746)
> def no_wait
Set implicit wait to zero.
--
##### [set_wait](https://github.com/appium/ruby_lib/blob/a4c238552724878c31d8ff0179ef00d8258c76a4/lib/appium_lib/driver.rb#L760)
> def set_wait(timeout = nil)
Set implicit wait. Default to @default_wait.
```ruby
set_wait 2
set_wait # @default_wait
```
__Parameters:__
[Integer] timeout - the timeout in seconds
__Returns:__
[void]
--
##### [exists](https://github.com/appium/ruby_lib/blob/a4c238552724878c31d8ff0179ef00d8258c76a4/lib/appium_lib/driver.rb#L777)
> def exists(pre_check = 0, post_check = @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/a4c238552724878c31d8ff0179ef00d8258c76a4/lib/appium_lib/driver.rb#L801)
> 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]
--
##### [find_elements](https://github.com/appium/ruby_lib/blob/a4c238552724878c31d8ff0179ef00d8258c76a4/lib/appium_lib/driver.rb#L823)
> 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/a4c238552724878c31d8ff0179ef00d8258c76a4/lib/appium_lib/driver.rb#L838)
> 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]
--
##### [set_location](https://github.com/appium/ruby_lib/blob/a4c238552724878c31d8ff0179ef00d8258c76a4/lib/appium_lib/driver.rb#L851)
> def set_location(opts = {})
Calls @driver.set_location
__Parameters:__
[Hash] opts - consisting of:
__Returns:__
[Selenium::WebDriver::Location] the location constructed by the selenium webdriver
--
##### [x](https://github.com/appium/ruby_lib/blob/a4c238552724878c31d8ff0179ef00d8258c76a4/lib/appium_lib/driver.rb#L861)
> def x
Quit the driver and Pry.
quit and exit are reserved by Pry.
__Returns:__
[void]
--
##### [write_session_id](https://github.com/appium/ruby_lib/blob/a4c238552724878c31d8ff0179ef00d8258c76a4/lib/appium_lib/driver.rb#L868)
> def write_session_id(session_id)
--
##### [set_automation_name_if_nil](https://github.com/appium/ruby_lib/blob/a4c238552724878c31d8ff0179ef00d8258c76a4/lib/appium_lib/driver.rb#L877)
> def set_automation_name_if_nil
If "automationName" is set only server side, this method set "automationName" attribute into @automation_name.
Since @automation_name is set only client side before start_driver is called.
--
##### [logger=](https://github.com/appium/ruby_lib/blob/a4c238552724878c31d8ff0179ef00d8258c76a4/lib/appium_lib/logger.rb#L18)
> def logger=(value)
Sets the attribute logger
__Parameters:__
value - the value to set the attribute logger to.
--
##### [logger](https://github.com/appium/ruby_lib/blob/a4c238552724878c31d8ff0179ef00d8258c76a4/lib/appium_lib/logger.rb#L22)
> def logger
--
##### [app_strings](https://github.com/appium/ruby_lib/blob/a4c238552724878c31d8ff0179ef00d8258c76a4/lib/appium_lib/device/device.rb#L7)
> def app_strings
Return the hash of all localization strings.
```ruby
app_strings #=> "TransitionsTitle"=>"Transitions", "WebTitle"=>"Web"
```
--
##### [background_app](https://github.com/appium/ruby_lib/blob/a4c238552724878c31d8ff0179ef00d8258c76a4/lib/appium_lib/device/device.rb#L13)
> def background_app
Backgrounds the app for a set number of seconds.
This is a blocking application
--
##### [current_activity](https://github.com/appium/ruby_lib/blob/a4c238552724878c31d8ff0179ef00d8258c76a4/lib/appium_lib/device/device.rb#L24)
> def current_activity
Get current activity name
```ruby
current_activity # '.ApiDemos'
```
__Returns:__
[String] An activity name
--
##### [current_package](https://github.com/appium/ruby_lib/blob/a4c238552724878c31d8ff0179ef00d8258c76a4/lib/appium_lib/device/device.rb#L32)
> def current_package
Get current package name
```ruby
current_package # 'com.example.android.apis'
```
__Returns:__
[String] A package name
--
##### [get_system_bars](https://github.com/appium/ruby_lib/blob/a4c238552724878c31d8ff0179ef00d8258c76a4/lib/appium_lib/device/device.rb#L40)
> def get_system_bars
Get system bar's information
```ruby
get_system_bars
```
__Returns:__
[String] System bar
--
##### [get_display_density](https://github.com/appium/ruby_lib/blob/a4c238552724878c31d8ff0179ef00d8258c76a4/lib/appium_lib/device/device.rb#L48)
> def get_display_density
Get connected device's density.
```ruby
get_display_density # 320
```
__Returns:__
[Integer] The size of density
--
##### [is_keyboard_shown](https://github.com/appium/ruby_lib/blob/a4c238552724878c31d8ff0179ef00d8258c76a4/lib/appium_lib/device/device.rb#L56)
> def is_keyboard_shown
Get whether keyboard is displayed or not.
```ruby
is_keyboard_shown # false
```
__Returns:__
[Bool] Return true if keyboard is shown. Return false if keyboard is hidden.
--
##### [launch_app](https://github.com/appium/ruby_lib/blob/a4c238552724878c31d8ff0179ef00d8258c76a4/lib/appium_lib/device/device.rb#L64)
> def launch_app
Start the simulator and application configured with desired capabilities
--
##### [reset](https://github.com/appium/ruby_lib/blob/a4c238552724878c31d8ff0179ef00d8258c76a4/lib/appium_lib/device/device.rb#L67)
> def reset
Reset the device, relaunching the application.
--
##### [shake](https://github.com/appium/ruby_lib/blob/a4c238552724878c31d8ff0179ef00d8258c76a4/lib/appium_lib/device/device.rb#L70)
> def shake
Cause the device to shake
--
##### [toggle_flight_mode](https://github.com/appium/ruby_lib/blob/a4c238552724878c31d8ff0179ef00d8258c76a4/lib/appium_lib/device/device.rb#L73)
> def toggle_flight_mode
Toggle flight mode on or off
--
##### [device_locked?](https://github.com/appium/ruby_lib/blob/a4c238552724878c31d8ff0179ef00d8258c76a4/lib/appium_lib/device/device.rb#L76)
> def device_locked?
--
##### [hide_keyboard](https://github.com/appium/ruby_lib/blob/a4c238552724878c31d8ff0179ef00d8258c76a4/lib/appium_lib/device/device.rb#L78)
> def hide_keyboard
Hide the onscreen keyboard
__Parameters:__
[String] close_key - The name of the key which closes the keyboard.
Defaults to 'Done' for iOS(except for XCUITest).
[Symbol] strategy - The symbol of the strategy which closes the keyboard.
XCUITest ignore this argument.
Default for iOS is `:pressKey`. Default for Android is `:tapOutside`.
--
##### [press_keycode](https://github.com/appium/ruby_lib/blob/a4c238552724878c31d8ff0179ef00d8258c76a4/lib/appium_lib/device/device.rb#L91)
> def press_keycode
Press keycode on the device.
http://developer.android.com/reference/android/view/KeyEvent.html
__Parameters:__
[integer] key - The key to press.
[String] metastate - The state the metakeys should be in when pressing the key.
--
##### [long_press_keycode](https://github.com/appium/ruby_lib/blob/a4c238552724878c31d8ff0179ef00d8258c76a4/lib/appium_lib/device/device.rb#L97)
> def long_press_keycode
Long press keycode on the device.
http://developer.android.com/reference/android/view/KeyEvent.html
__Parameters:__
[integer] key - The key to long press.
[String] metastate - The state the metakeys should be in when long pressing the key.
--
##### [push_file](https://github.com/appium/ruby_lib/blob/a4c238552724878c31d8ff0179ef00d8258c76a4/lib/appium_lib/device/device.rb#L103)
> def push_file
Place a file in a specific location on the device.
__Parameters:__
[String] path - The absolute path on the device to store data at.
[String] data - Raw file data to be sent to the device.
--
##### [pull_file](https://github.com/appium/ruby_lib/blob/a4c238552724878c31d8ff0179ef00d8258c76a4/lib/appium_lib/device/device.rb#L108)
> def pull_file
Retrieve a file from the device. This can retrieve an absolute path or
a path relative to the installed app (iOS only).
```ruby
pull_file '/local/data/some/path' #=> Get the file at that path
pull_file 'Shenanigans.app/some/file' #=> Get 'some/file' from the install location of Shenanigans.app
```
__Parameters:__
[String] path - Either an absolute path OR, for iOS devices, a path relative to the app, as described.
--
##### [pull_folder](https://github.com/appium/ruby_lib/blob/a4c238552724878c31d8ff0179ef00d8258c76a4/lib/appium_lib/device/device.rb#L118)
> def pull_folder
Retrieve a folder from the device.
```ruby
pull_folder '/data/local/tmp' #=> Get the folder at that path
```
__Parameters:__
[String] path - absolute path to the folder
--
##### [touch_id](https://github.com/appium/ruby_lib/blob/a4c238552724878c31d8ff0179ef00d8258c76a4/lib/appium_lib/device/device.rb#L126)
> def touch_id
iOS only; Simulate Touch ID with either valid (match == true) or invalid (match == false) fingerprint.
```ruby
touch_id true #=> Simulate valid fingerprint
touch_id false #=> Simulate invalid fingerprint
```
__Parameters:__
[Boolean] match - fingerprint validity
Defaults to true.
--
##### [toggle_touch_id_enrollment](https://github.com/appium/ruby_lib/blob/a4c238552724878c31d8ff0179ef00d8258c76a4/lib/appium_lib/device/device.rb#L135)
> def toggle_touch_id_enrollment
iOS Simulator only: Toggle touch id enrollment on an iOS Simulator.
--
##### [end_coverage](https://github.com/appium/ruby_lib/blob/a4c238552724878c31d8ff0179ef00d8258c76a4/lib/appium_lib/device/device.rb#L138)
> def end_coverage
Android only; Ends the test coverage and writes the results to the given path on device.
__Parameters:__
[String] path - Path on the device to write too.
[String] intent - Intent to broadcast when ending coverage.
--
##### [get_settings](https://github.com/appium/ruby_lib/blob/a4c238552724878c31d8ff0179ef00d8258c76a4/lib/appium_lib/device/device.rb#L143)
> def get_settings
Get appium Settings for current test session
--
##### [update_settings](https://github.com/appium/ruby_lib/blob/a4c238552724878c31d8ff0179ef00d8258c76a4/lib/appium_lib/device/device.rb#L146)
> def update_settings
Update appium Settings for current test session
__Parameters:__
[Hash] settings - Settings to update, keys are settings, values to value to set each setting to
--
##### [start_activity](https://github.com/appium/ruby_lib/blob/a4c238552724878c31d8ff0179ef00d8258c76a4/lib/appium_lib/device/device.rb#L150)
> def start_activity
Start a new activity within the current app or launch a new app and start the target activity.
Android only.
```ruby
start_activity app_package: 'io.appium.android.apis',
app_activity: '.accessibility.AccessibilityNodeProviderActivity'
```
--
##### [get_network_connection](https://github.com/appium/ruby_lib/blob/a4c238552724878c31d8ff0179ef00d8258c76a4/lib/appium_lib/device/device.rb#L164)
> def get_network_connection
Get the device network connection current status
See set_network_connection method for return value
--
##### [set_network_connection](https://github.com/appium/ruby_lib/blob/a4c238552724878c31d8ff0179ef00d8258c76a4/lib/appium_lib/device/device.rb#L168)
> def set_network_connection
Set the device network connection mode
Value (Alias) | Data | Wifi | Airplane Mode
-------------------------------------------------
1 (Airplane Mode) | 0 | 0 | 1
6 (All network on) | 1 | 1 | 0
4 (Data only) | 1 | 0 | 0
2 (Wifi only) | 0 | 1 | 0
0 (None) | 0 | 0 | 0
__Parameters:__
[String] path - Bit mask that represent the network mode
--
##### [set_immediate_value](https://github.com/appium/ruby_lib/blob/a4c238552724878c31d8ff0179ef00d8258c76a4/lib/appium_lib/device/device.rb#L181)
> def set_immediate_value
Set the value to element directly
for iOS; setValue is called in XCUITest instead because XCUITest doesn't provide set value directly.
https://github.com/appium/appium-xcuitest-driver/blob/793cdc7d5e84bd553e375076e1c6dc7e242c9cde/lib/commands/element.js#L123
```ruby
set_immediate_value element, 'hello'
```
--
##### [get_performance_data_types](https://github.com/appium/ruby_lib/blob/a4c238552724878c31d8ff0179ef00d8258c76a4/lib/appium_lib/device/device.rb#L190)
> def get_performance_data_types
Get the information type of the system state which is supported to read such as
cpu, memory, network, battery via adb commands.
https://github.com/appium/appium-base-driver/blob/be29aec2318316d12b5c3295e924a5ba8f09b0fb/lib/mjsonwp/routes.js#L300
```ruby
get_performance_data_types #=> ["cpuinfo", "batteryinfo", "networkinfo", "memoryinfo"]
```
--
##### [extend_search_contexts](https://github.com/appium/ruby_lib/blob/a4c238552724878c31d8ff0179ef00d8258c76a4/lib/appium_lib/device/device.rb#L443)
> def extend_search_contexts
--
##### [find_element_with_appium](https://github.com/appium/ruby_lib/blob/a4c238552724878c31d8ff0179ef00d8258c76a4/lib/appium_lib/device/device.rb#L443)
> def find_element_with_appium
--
##### [find_elements_with_appium](https://github.com/appium/ruby_lib/blob/a4c238552724878c31d8ff0179ef00d8258c76a4/lib/appium_lib/device/device.rb#L443)
> def find_elements_with_appium
find_element/s_with_appium with their accessibility_id
```ruby
find_elements :accessibility_id, 'Animation'
```
--
##### [add_touch_actions](https://github.com/appium/ruby_lib/blob/a4c238552724878c31d8ff0179ef00d8258c76a4/lib/appium_lib/device/device.rb#L474)
> def add_touch_actions
--
##### [add_ime_actions](https://github.com/appium/ruby_lib/blob/a4c238552724878c31d8ff0179ef00d8258c76a4/lib/appium_lib/device/device.rb#L497)
> def add_ime_actions
--
##### [set_context](https://github.com/appium/ruby_lib/blob/a4c238552724878c31d8ff0179ef00d8258c76a4/lib/appium_lib/device/device.rb#L572)
> def set_context
Change the context to the given context.
```ruby
set_context "NATIVE_APP"
```
__Parameters:__
[String] The - context to change to
--
##### [current_context](https://github.com/appium/ruby_lib/blob/a4c238552724878c31d8ff0179ef00d8258c76a4/lib/appium_lib/device/device.rb#L580)
> def current_context
__Returns:__
[String] The context currently being used.
--
##### [available_contexts](https://github.com/appium/ruby_lib/blob/a4c238552724878c31d8ff0179ef00d8258c76a4/lib/appium_lib/device/device.rb#L583)
> def available_contexts
__Returns:__
[Array<String>] All usable contexts, as an array of strings.
--
##### [within_context](https://github.com/appium/ruby_lib/blob/a4c238552724878c31d8ff0179ef00d8258c76a4/lib/appium_lib/device/device.rb#L594)
> def within_context(context)
Perform a block within the given context, then switch back to the starting context.
```ruby
result = within_context('NATIVE_APP') do
find_element :tag, "button"
end # The result of `find_element :tag, "button"`
```
__Parameters:__
[String] context - The context to switch to for the duration of the block.
--
##### [switch_to_default_context](https://github.com/appium/ruby_lib/blob/a4c238552724878c31d8ff0179ef00d8258c76a4/lib/appium_lib/device/device.rb#L607)
> def switch_to_default_context
Change to the default context. This is equivalent to `set_context nil`.
--
##### [pinch](https://github.com/appium/ruby_lib/blob/a4c238552724878c31d8ff0179ef00d8258c76a4/lib/appium_lib/device/multi_touch.rb#L53)
> 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.
```ruby
pinch 75 #=> Pinch the screen from the top right and bottom left corners
```
Without auto_perform
```ruby
action = pinch 75, false #=> Pinch the screen from the top right and bottom left corners
action.perform #=> to 25% of its size.
```
With driver
```ruby
driver = Appium::Driver.new(opts, false).start_driver
pinch 75, true, driver #=> Pinch the screen from the top right and bottom left corners
```
__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/a4c238552724878c31d8ff0179ef00d8258c76a4/lib/appium_lib/device/multi_touch.rb#L96)
> 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.
```ruby
action = zoom 200 #=> Zoom in the screen from the center until it doubles in size.
```
Without auto_perform
```ruby
action = zoom 200, false #=> Zoom in the screen from the center until it doubles in size.
action.perform #=> to 25% of its size.
```
With driver
```ruby
driver = Appium::Driver.new(opts, false).start_driver
pinch 200, true, driver #=> Zoom in the screen from the center until it doubles in size.
```
__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)
--
##### [pinch_for_xcuitest](https://github.com/appium/ruby_lib/blob/a4c238552724878c31d8ff0179ef00d8258c76a4/lib/appium_lib/device/multi_touch.rb#L118)
> def pinch_for_xcuitest(rate, driver)
--
##### [pinch_android](https://github.com/appium/ruby_lib/blob/a4c238552724878c31d8ff0179ef00d8258c76a4/lib/appium_lib/device/multi_touch.rb#L133)
> def pinch_android(rate)
--
##### [pinch_ios](https://github.com/appium/ruby_lib/blob/a4c238552724878c31d8ff0179ef00d8258c76a4/lib/appium_lib/device/multi_touch.rb#L147)
> def pinch_ios(rate)
--
##### [zoom_for_xcuitest](https://github.com/appium/ruby_lib/blob/a4c238552724878c31d8ff0179ef00d8258c76a4/lib/appium_lib/device/multi_touch.rb#L161)
> def zoom_for_xcuitest(rate, driver)
--
##### [zoom_android](https://github.com/appium/ruby_lib/blob/a4c238552724878c31d8ff0179ef00d8258c76a4/lib/appium_lib/device/multi_touch.rb#L176)
> def zoom_android(rate)
--
##### [zoom_ios](https://github.com/appium/ruby_lib/blob/a4c238552724878c31d8ff0179ef00d8258c76a4/lib/appium_lib/device/multi_touch.rb#L190)
> def zoom_ios(rate)
--
##### [actions](https://github.com/appium/ruby_lib/blob/a4c238552724878c31d8ff0179ef00d8258c76a4/lib/appium_lib/device/multi_touch.rb#L205)
> def actions
self
--
##### [driver](https://github.com/appium/ruby_lib/blob/a4c238552724878c31d8ff0179ef00d8258c76a4/lib/appium_lib/device/multi_touch.rb#L205)
> def driver
self
--
##### [initialize](https://github.com/appium/ruby_lib/blob/a4c238552724878c31d8ff0179ef00d8258c76a4/lib/appium_lib/device/multi_touch.rb#L208)
> def initialize(driver = $driver)
Create a new multi-action with Driver
__Returns:__
[MultiTouch] a new instance of MultiTouch
--
##### [add](https://github.com/appium/ruby_lib/blob/a4c238552724878c31d8ff0179ef00d8258c76a4/lib/appium_lib/device/multi_touch.rb#L215)
> def add(chain)
Add a touch_action to be performed
__Parameters:__
[TouchAction] chain - The action to add to the chain
--
##### [perform](https://github.com/appium/ruby_lib/blob/a4c238552724878c31d8ff0179ef00d8258c76a4/lib/appium_lib/device/multi_touch.rb#L220)
> def perform
Ask Appium to perform the actions
--
##### [ACTIONS](https://github.com/appium/ruby_lib/blob/a4c238552724878c31d8ff0179ef00d8258c76a4/lib/appium_lib/device/touch_actions.rb#L30)
> ACTIONS = [:move_to, :long_press, :double_tap, :two_finger_tap, :press, :release, :tap, :wait, :perform].freeze
--
##### [COMPLEX_ACTIONS](https://github.com/appium/ruby_lib/blob/a4c238552724878c31d8ff0179ef00d8258c76a4/lib/appium_lib/device/touch_actions.rb#L31)
> COMPLEX_ACTIONS = [:swipe].freeze
--
##### [actions](https://github.com/appium/ruby_lib/blob/a4c238552724878c31d8ff0179ef00d8258c76a4/lib/appium_lib/device/touch_actions.rb#L45)
> def actions
Returns the value of attribute actions
--
##### [initialize](https://github.com/appium/ruby_lib/blob/a4c238552724878c31d8ff0179ef00d8258c76a4/lib/appium_lib/device/touch_actions.rb#L47)
> def initialize
__Returns:__
[TouchAction] a new instance of TouchAction
--
##### [move_to](https://github.com/appium/ruby_lib/blob/a4c238552724878c31d8ff0179ef00d8258c76a4/lib/appium_lib/device/touch_actions.rb#L58)
> def move_to(opts)
Move to the given co-ordinates.
`move_to`'s `x` and `y` have two case. One is working as coordinate, the other is working as offset.
__Parameters:__
[Hash] opts - a customizable set of options
--
##### [long_press](https://github.com/appium/ruby_lib/blob/a4c238552724878c31d8ff0179ef00d8258c76a4/lib/appium_lib/device/touch_actions.rb#L72)
> def long_press(opts)
Press down for a specific duration.
Alternatively, you can use `press(...).wait(...).release()` instead of `long_press` if duration doesn't work well.
https://github.com/appium/ruby_lib/issues/231#issuecomment-269895512
e.g. Appium::TouchAction.new.press(x: 280, y: 530).wait(2000).release.perform
__Parameters:__
[Hash] element - a customizable set of options
[Hash] x - a customizable set of options
[Hash] y - a customizable set of options
[Hash] duration - a customizable set of options
--
##### [press](https://github.com/appium/ruby_lib/blob/a4c238552724878c31d8ff0179ef00d8258c76a4/lib/appium_lib/device/touch_actions.rb#L84)
> def press(opts)
Press a finger onto the screen. Finger will stay down until you call
`release`.
__Parameters:__
[Hash] opts - a customizable set of options
--
##### [release](https://github.com/appium/ruby_lib/blob/a4c238552724878c31d8ff0179ef00d8258c76a4/lib/appium_lib/device/touch_actions.rb#L95)
> def release(opts = nil)
Remove a finger from the screen.
__Parameters:__
[Hash] opts - a customizable set of options
--
##### [tap](https://github.com/appium/ruby_lib/blob/a4c238552724878c31d8ff0179ef00d8258c76a4/lib/appium_lib/device/touch_actions.rb#L107)
> def tap(opts)
Touch a point on the screen.
Alternatively, you can use `press(...).release.perform` instead of `tap(...).perform`.
__Parameters:__
[Hash] opts - a customizable set of options
--
##### [double_tap](https://github.com/appium/ruby_lib/blob/a4c238552724878c31d8ff0179ef00d8258c76a4/lib/appium_lib/device/touch_actions.rb#L120)
> def double_tap(opts)
Double tap an element on the screen
__Parameters:__
[Hash] opts - a customizable set of options
--
##### [two_finger_tap](https://github.com/appium/ruby_lib/blob/a4c238552724878c31d8ff0179ef00d8258c76a4/lib/appium_lib/device/touch_actions.rb#L131)
> def two_finger_tap(opts)
Two finger tap an element on the screen
__Parameters:__
[Hash] opts - a customizable set of options
--
##### [wait](https://github.com/appium/ruby_lib/blob/a4c238552724878c31d8ff0179ef00d8258c76a4/lib/appium_lib/device/touch_actions.rb#L139)
> def wait(milliseconds)
Pause for a number of milliseconds before the next action
__Parameters:__
[integer] milliseconds - Number of milliseconds to pause for
--
##### [swipe](https://github.com/appium/ruby_lib/blob/a4c238552724878c31d8ff0179ef00d8258c76a4/lib/appium_lib/device/touch_actions.rb#L162)
> def swipe(opts, ele = nil)
Convenience method to peform a swipe.
Note that iOS 7 simulators have broken swipe.
For iOS: Use `offset_x` and `offset_y` to define the end point.
For Android: Use `end_x` and `end_y` to define the end point.
If you'd like more details, please read tests and its log samples in
`ios_tests/lib/ios/specs/device/touch_actions.rb` and `ios_tests/lib/ios/specs/device/touch_actions.rb`
__Parameters:__
[Hash] opts - a customizable set of options
--
##### [perform](https://github.com/appium/ruby_lib/blob/a4c238552724878c31d8ff0179ef00d8258c76a4/lib/appium_lib/device/touch_actions.rb#L187)
> def perform(driver = $driver)
Ask the driver to perform all actions in this action chain.
--
##### [cancel](https://github.com/appium/ruby_lib/blob/a4c238552724878c31d8ff0179ef00d8258c76a4/lib/appium_lib/device/touch_actions.rb#L194)
> def cancel(driver = $driver)
Does nothing, currently.
--
##### [swipe_coordinates](https://github.com/appium/ruby_lib/blob/a4c238552724878c31d8ff0179ef00d8258c76a4/lib/appium_lib/device/touch_actions.rb#L201)
> def swipe_coordinates(end_x: nil, end_y: nil, offset_x: nil, offset_y: nil, driver: $driver)
Visible for testing
--
##### [chain_method](https://github.com/appium/ruby_lib/blob/a4c238552724878c31d8ff0179ef00d8258c76a4/lib/appium_lib/device/touch_actions.rb#L219)
> def chain_method(method, args = nil)
--
##### [args_with_ele_ref](https://github.com/appium/ruby_lib/blob/a4c238552724878c31d8ff0179ef00d8258c76a4/lib/appium_lib/device/touch_actions.rb#L225)
> def args_with_ele_ref(args)
--
##### [initialize](https://github.com/appium/ruby_lib/blob/a4c238552724878c31d8ff0179ef00d8258c76a4/lib/appium_lib/common/wait.rb#L4)
> def initialize(opts = {})
__Returns:__
[Wait] a new instance of Wait
--
##### [until](https://github.com/appium/ruby_lib/blob/a4c238552724878c31d8ff0179ef00d8258c76a4/lib/appium_lib/common/wait.rb#L23)
> def until
Wait code from the selenium Ruby gem
https://github.com/SeleniumHQ/selenium/blob/cf501dda3f0ed12233de51ce8170c0e8090f0c20/rb/lib/selenium/webdriver/common/wait.rb
--
##### [wait_true](https://github.com/appium/ruby_lib/blob/a4c238552724878c31d8ff0179ef00d8258c76a4/lib/appium_lib/common/wait.rb#L73)
> 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] opts - Options
--
##### [wait](https://github.com/appium/ruby_lib/blob/a4c238552724878c31d8ff0179ef00d8258c76a4/lib/appium_lib/common/wait.rb#L96)
> 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] opts - Options
--
##### [ignore](https://github.com/appium/ruby_lib/blob/a4c238552724878c31d8ff0179ef00d8258c76a4/lib/appium_lib/common/helper.rb#L24)
> def ignore
Return yield and ignore any exceptions.
--
##### [back](https://github.com/appium/ruby_lib/blob/a4c238552724878c31d8ff0179ef00d8258c76a4/lib/appium_lib/common/helper.rb#L31)
> def back
Navigate back.
__Returns:__
[void]
--
##### [session_id](https://github.com/appium/ruby_lib/blob/a4c238552724878c31d8ff0179ef00d8258c76a4/lib/appium_lib/common/helper.rb#L36)
> def session_id
For Sauce Labs reporting. Returns the current session id.
--
##### [xpath](https://github.com/appium/ruby_lib/blob/a4c238552724878c31d8ff0179ef00d8258c76a4/lib/appium_lib/common/helper.rb#L44)
> 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/a4c238552724878c31d8ff0179ef00d8258c76a4/lib/appium_lib/common/helper.rb#L52)
> def xpaths(xpath_str)
Returns all elements that match the provided xpath.
__Parameters:__
[String] xpath_str - the XPath string
__Returns:__
[Array<Element>]
--
##### [_print_source](https://github.com/appium/ruby_lib/blob/a4c238552724878c31d8ff0179ef00d8258c76a4/lib/appium_lib/common/helper.rb#L56)
> def _print_source(source)
--
##### [result](https://github.com/appium/ruby_lib/blob/a4c238552724878c31d8ff0179ef00d8258c76a4/lib/appium_lib/common/helper.rb#L69)
> def result
Returns the value of attribute result
--
##### [initialize](https://github.com/appium/ruby_lib/blob/a4c238552724878c31d8ff0179ef00d8258c76a4/lib/appium_lib/common/helper.rb#L71)
> def initialize
__Returns:__
[CountElements] a new instance of CountElements
--
##### [reset](https://github.com/appium/ruby_lib/blob/a4c238552724878c31d8ff0179ef00d8258c76a4/lib/appium_lib/common/helper.rb#L75)
> def reset
--
##### [start_element](https://github.com/appium/ruby_lib/blob/a4c238552724878c31d8ff0179ef00d8258c76a4/lib/appium_lib/common/helper.rb#L80)
> def start_element(name, attrs = [], driver = $driver)
http://nokogiri.org/Nokogiri/XML/SAX/Document.html
--
##### [formatted_result](https://github.com/appium/ruby_lib/blob/a4c238552724878c31d8ff0179ef00d8258c76a4/lib/appium_lib/common/helper.rb#L86)
> def formatted_result
--
##### [get_page_class](https://github.com/appium/ruby_lib/blob/a4c238552724878c31d8ff0179ef00d8258c76a4/lib/appium_lib/common/helper.rb#L97)
> def get_page_class
Returns a string of class counts of visible elements.
--
##### [page_class](https://github.com/appium/ruby_lib/blob/a4c238552724878c31d8ff0179ef00d8258c76a4/lib/appium_lib/common/helper.rb#L108)
> def page_class
Count all classes on screen and print to stdout.
Useful for appium_console.
--
##### [px_to_window_rel](https://github.com/appium/ruby_lib/blob/a4c238552724878c31d8ff0179ef00d8258c76a4/lib/appium_lib/common/helper.rb#L118)
> def px_to_window_rel(opts = {}, driver = $driver)
Converts pixel values to window relative values
```ruby
px_to_window_rel x: 50, y: 150
```
--
##### [xml_keys](https://github.com/appium/ruby_lib/blob/a4c238552724878c31d8ff0179ef00d8258c76a4/lib/appium_lib/common/helper.rb#L137)
> 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/a4c238552724878c31d8ff0179ef00d8258c76a4/lib/appium_lib/common/helper.rb#L145)
> 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/a4c238552724878c31d8ff0179ef00d8258c76a4/lib/appium_lib/common/helper.rb#L153)
> 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/a4c238552724878c31d8ff0179ef00d8258c76a4/lib/appium_lib/common/helper.rb#L159)
> def filter
Returns the value of attribute filter
--
##### [filter=](https://github.com/appium/ruby_lib/blob/a4c238552724878c31d8ff0179ef00d8258c76a4/lib/appium_lib/common/helper.rb#L162)
> def filter=(value)
convert to string to support symbols
--
##### [initialize](https://github.com/appium/ruby_lib/blob/a4c238552724878c31d8ff0179ef00d8258c76a4/lib/appium_lib/common/helper.rb#L168)
> def initialize
__Returns:__
[HTMLElements] a new instance of HTMLElements
--
##### [reset](https://github.com/appium/ruby_lib/blob/a4c238552724878c31d8ff0179ef00d8258c76a4/lib/appium_lib/common/helper.rb#L173)
> def reset
--
##### [result](https://github.com/appium/ruby_lib/blob/a4c238552724878c31d8ff0179ef00d8258c76a4/lib/appium_lib/common/helper.rb#L179)
> def result
--
##### [start_element](https://github.com/appium/ruby_lib/blob/a4c238552724878c31d8ff0179ef00d8258c76a4/lib/appium_lib/common/helper.rb#L195)
> def start_element(name, attrs = [])
--
##### [end_element](https://github.com/appium/ruby_lib/blob/a4c238552724878c31d8ff0179ef00d8258c76a4/lib/appium_lib/common/helper.rb#L204)
> def end_element(name)
--
##### [characters](https://github.com/appium/ruby_lib/blob/a4c238552724878c31d8ff0179ef00d8258c76a4/lib/appium_lib/common/helper.rb#L210)
> def characters(chars)
--
##### [COMMAND_NO_ARG](https://github.com/appium/ruby_lib/blob/a4c238552724878c31d8ff0179ef00d8258c76a4/lib/appium_lib/common/command.rb#L4)
> COMMAND_NO_ARG = {
--
##### [COMMAND](https://github.com/appium/ruby_lib/blob/a4c238552724878c31d8ff0179ef00d8258c76a4/lib/appium_lib/common/command.rb#L28)
> COMMAND = {
--
##### [COMMANDS_EXTEND_OSS](https://github.com/appium/ruby_lib/blob/a4c238552724878c31d8ff0179ef00d8258c76a4/lib/appium_lib/common/command.rb#L66)
> COMMANDS_EXTEND_OSS = COMMAND.merge(::Selenium::WebDriver::Remote::OSS::Bridge::COMMANDS).freeze
--
##### [COMMANDS_EXTEND_W3C](https://github.com/appium/ruby_lib/blob/a4c238552724878c31d8ff0179ef00d8258c76a4/lib/appium_lib/common/command.rb#L67)
> COMMANDS_EXTEND_W3C = COMMAND.merge(::Selenium::WebDriver::Remote::W3C::Bridge::COMMANDS).freeze
--
##### [window_size](https://github.com/appium/ruby_lib/blob/a4c238552724878c31d8ff0179ef00d8258c76a4/lib/appium_lib/common/element/window.rb#L5)
> def window_size
Get the window's size
--
##### [FINDERS](https://github.com/appium/ruby_lib/blob/a4c238552724878c31d8ff0179ef00d8258c76a4/lib/appium_lib/common/search_context.rb#L5)
> FINDERS = {
rubocop:disable Style/MutableConstant
--
##### [filter](https://github.com/appium/ruby_lib/blob/a4c238552724878c31d8ff0179ef00d8258c76a4/lib/appium_lib/ios/helper.rb#L4) ios
> def filter
Returns the value of attribute filter
--
##### [filter=](https://github.com/appium/ruby_lib/blob/a4c238552724878c31d8ff0179ef00d8258c76a4/lib/appium_lib/ios/helper.rb#L4) 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/a4c238552724878c31d8ff0179ef00d8258c76a4/lib/appium_lib/ios/helper.rb#L6) ios
> def start_element(type, attrs = [])
--
##### [_print_attr](https://github.com/appium/ruby_lib/blob/a4c238552724878c31d8ff0179ef00d8258c76a4/lib/appium_lib/ios/helper.rb#L15) ios
> def _print_attr(type, name, label, value, hint, visible) # rubocop:disable Metrics/ParameterLists
rubocop:disable Metrics/ParameterLists
--
##### [ios_password](https://github.com/appium/ruby_lib/blob/a4c238552724878c31d8ff0179ef00d8258c76a4/lib/appium_lib/ios/helper.rb#L42) 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
--
##### [get_page](https://github.com/appium/ruby_lib/blob/a4c238552724878c31d8ff0179ef00d8258c76a4/lib/appium_lib/ios/helper.rb#L55) ios
> def get_page(element = source_window(0), class_name = nil)
Returns a string of interesting elements. iOS only.
Defaults to inspecting the 1st windows source only.
use get_page(get_source) for all window sources
__Parameters:__
[Hash] element - a customizable set of options
[Hash] class_name - a customizable set of options
__Returns:__
[String]
--
##### [page](https://github.com/appium/ruby_lib/blob/a4c238552724878c31d8ff0179ef00d8258c76a4/lib/appium_lib/ios/helper.rb#L142) ios
> def page(opts = {})
Prints a string of interesting elements to the console.
Example
```ruby
page class: :UIAButton # filter on buttons
page class: :UIAButton, window: 1
```
__Parameters:__
[Hash] visible - a customizable set of options
[Hash] class - a customizable set of options
__Returns:__
[void]
--
##### [source_window](https://github.com/appium/ruby_lib/blob/a4c238552724878c31d8ff0179ef00d8258c76a4/lib/appium_lib/ios/helper.rb#L166) ios
> def source_window(window_number = nil)
Gets the JSON source of window number
__Returns:__
[JSON]
--
##### [page_window](https://github.com/appium/ruby_lib/blob/a4c238552724878c31d8ff0179ef00d8258c76a4/lib/appium_lib/ios/helper.rb#L177) ios
> def page_window(window_number = 0)
Prints parsed page source to console.
example: page_window 0
__Parameters:__
[Integer] window_number - the int index of the target window
__Returns:__
[void]
--
##### [id](https://github.com/appium/ruby_lib/blob/a4c238552724878c31d8ff0179ef00d8258c76a4/lib/appium_lib/ios/helper.rb#L185) ios
> def id(id)
Find by id
__Parameters:__
[String] id - the id to search for
__Returns:__
[Element]
--
##### [ios_version](https://github.com/appium/ruby_lib/blob/a4c238552724878c31d8ff0179ef00d8258c76a4/lib/appium_lib/ios/helper.rb#L191) ios
> def ios_version
Return the iOS version as an array of integers
__Returns:__
[Array<Integer>]
--
##### [ele_index](https://github.com/appium/ruby_lib/blob/a4c238552724878c31d8ff0179ef00d8258c76a4/lib/appium_lib/ios/helper.rb#L200) 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/a4c238552724878c31d8ff0179ef00d8258c76a4/lib/appium_lib/ios/helper.rb#L228) 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/a4c238552724878c31d8ff0179ef00d8258c76a4/lib/appium_lib/ios/helper.rb#L239) 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/a4c238552724878c31d8ff0179ef00d8258c76a4/lib/appium_lib/ios/helper.rb#L252) 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/a4c238552724878c31d8ff0179ef00d8258c76a4/lib/appium_lib/ios/helper.rb#L263) 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/a4c238552724878c31d8ff0179ef00d8258c76a4/lib/appium_lib/ios/helper.rb#L279) 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/a4c238552724878c31d8ff0179ef00d8258c76a4/lib/appium_lib/ios/helper.rb#L289) 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/a4c238552724878c31d8ff0179ef00d8258c76a4/lib/appium_lib/ios/helper.rb#L297) 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/a4c238552724878c31d8ff0179ef00d8258c76a4/lib/appium_lib/ios/helper.rb#L308) 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/a4c238552724878c31d8ff0179ef00d8258c76a4/lib/appium_lib/ios/helper.rb#L321) 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/a4c238552724878c31d8ff0179ef00d8258c76a4/lib/appium_lib/ios/helper.rb#L328) 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/a4c238552724878c31d8ff0179ef00d8258c76a4/lib/appium_lib/ios/helper.rb#L336) 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/a4c238552724878c31d8ff0179ef00d8258c76a4/lib/appium_lib/ios/helper.rb#L344) 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/a4c238552724878c31d8ff0179ef00d8258c76a4/lib/appium_lib/ios/helper.rb#L355) 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/a4c238552724878c31d8ff0179ef00d8258c76a4/lib/appium_lib/ios/helper.rb#L370) 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/a4c238552724878c31d8ff0179ef00d8258c76a4/lib/appium_lib/ios/helper.rb#L407) 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/a4c238552724878c31d8ff0179ef00d8258c76a4/lib/appium_lib/ios/helper.rb#L416) 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/a4c238552724878c31d8ff0179ef00d8258c76a4/lib/appium_lib/ios/helper.rb#L446) 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/a4c238552724878c31d8ff0179ef00d8258c76a4/lib/appium_lib/ios/helper.rb#L455) 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/a4c238552724878c31d8ff0179ef00d8258c76a4/lib/appium_lib/ios/helper.rb#L464) 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/a4c238552724878c31d8ff0179ef00d8258c76a4/lib/appium_lib/ios/helper.rb#L477) 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/a4c238552724878c31d8ff0179ef00d8258c76a4/lib/appium_lib/ios/helper.rb#L488) 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>]
--
##### [source](https://github.com/appium/ruby_lib/blob/a4c238552724878c31d8ff0179ef00d8258c76a4/lib/appium_lib/ios/helper.rb#L494) ios
> def source
Prints xml of the current page
__Returns:__
[void]
--
##### [_validate_object](https://github.com/appium/ruby_lib/blob/a4c238552724878c31d8ff0179ef00d8258c76a4/lib/appium_lib/ios/helper.rb#L498) ios
> def _validate_object(*objects)
--
##### [_by_json](https://github.com/appium/ruby_lib/blob/a4c238552724878c31d8ff0179ef00d8258c76a4/lib/appium_lib/ios/helper.rb#L547) 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/a4c238552724878c31d8ff0179ef00d8258c76a4/lib/appium_lib/ios/helper.rb#L597) 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/a4c238552724878c31d8ff0179ef00d8258c76a4/lib/appium_lib/ios/helper.rb#L603) ios
> def ele_by_json(opts)
see eles_by_json
--
##### [get_source](https://github.com/appium/ruby_lib/blob/a4c238552724878c31d8ff0179ef00d8258c76a4/lib/appium_lib/ios/helper.rb#L613) ios
> def get_source
Returns XML string for the current page
Same as driver.page_source
__Returns:__
[String]
--
##### [UIAStaticText](https://github.com/appium/ruby_lib/blob/a4c238552724878c31d8ff0179ef00d8258c76a4/lib/appium_lib/ios/element/text.rb#L4) ios
> UIAStaticText = 'UIAStaticText'.freeze
--
##### [XCUIElementTypeStaticText](https://github.com/appium/ruby_lib/blob/a4c238552724878c31d8ff0179ef00d8258c76a4/lib/appium_lib/ios/element/text.rb#L5) ios
> XCUIElementTypeStaticText = 'XCUIElementTypeStaticText'.freeze
--
##### [static_text_class](https://github.com/appium/ruby_lib/blob/a4c238552724878c31d8ff0179ef00d8258c76a4/lib/appium_lib/ios/element/text.rb#L8) ios
> def static_text_class
__Returns:__
[String] Class name for text
--
##### [text](https://github.com/appium/ruby_lib/blob/a4c238552724878c31d8ff0179ef00d8258c76a4/lib/appium_lib/ios/element/text.rb#L16) 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:__
[UIAStaticText|XCUIElementTypeStaticText]
--
##### [texts](https://github.com/appium/ruby_lib/blob/a4c238552724878c31d8ff0179ef00d8258c76a4/lib/appium_lib/ios/element/text.rb#L25) 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<UIAStaticText|XCUIElementTypeStaticText>]
--
##### [first_text](https://github.com/appium/ruby_lib/blob/a4c238552724878c31d8ff0179ef00d8258c76a4/lib/appium_lib/ios/element/text.rb#L32) ios
> def first_text
Find the first UIAStaticText|XCUIElementTypeStaticText.
__Returns:__
[UIAStaticText|XCUIElementTypeStaticText]
--
##### [last_text](https://github.com/appium/ruby_lib/blob/a4c238552724878c31d8ff0179ef00d8258c76a4/lib/appium_lib/ios/element/text.rb#L38) ios
> def last_text
Find the last UIAStaticText|XCUIElementTypeStaticText.
__Returns:__
[UIAStaticText|XCUIElementTypeStaticText]
--
##### [text_exact](https://github.com/appium/ruby_lib/blob/a4c238552724878c31d8ff0179ef00d8258c76a4/lib/appium_lib/ios/element/text.rb#L45) ios
> def text_exact(value)
Find the first UIAStaticText|XCUIElementTypeStaticText that exactly matches value.
__Parameters:__
[String] value - the value to match exactly
__Returns:__
[UIAStaticText|XCUIElementTypeStaticText]
--
##### [texts_exact](https://github.com/appium/ruby_lib/blob/a4c238552724878c31d8ff0179ef00d8258c76a4/lib/appium_lib/ios/element/text.rb#L52) ios
> def texts_exact(value)
Find all UIAStaticTexts|XCUIElementTypeStaticTexts that exactly match value.
__Parameters:__
[String] value - the value to match exactly
__Returns:__
[Array<UIAStaticText|XCUIElementTypeStaticText>]
--
##### [alert_accept](https://github.com/appium/ruby_lib/blob/a4c238552724878c31d8ff0179ef00d8258c76a4/lib/appium_lib/ios/element/alert.rb#L5) ios
> def alert_accept
Accept the alert.
__Returns:__
[void]
--
##### [alert_dismiss](https://github.com/appium/ruby_lib/blob/a4c238552724878c31d8ff0179ef00d8258c76a4/lib/appium_lib/ios/element/alert.rb#L13) ios
> def alert_dismiss
Dismiss the alert.
__Returns:__
[void]
--
##### [UIAButton](https://github.com/appium/ruby_lib/blob/a4c238552724878c31d8ff0179ef00d8258c76a4/lib/appium_lib/ios/element/button.rb#L4) ios
> UIAButton = 'UIAButton'.freeze
--
##### [XCUIElementTypeButton](https://github.com/appium/ruby_lib/blob/a4c238552724878c31d8ff0179ef00d8258c76a4/lib/appium_lib/ios/element/button.rb#L5) ios
> XCUIElementTypeButton = 'XCUIElementTypeButton'.freeze
--
##### [button_class](https://github.com/appium/ruby_lib/blob/a4c238552724878c31d8ff0179ef00d8258c76a4/lib/appium_lib/ios/element/button.rb#L8) ios
> def button_class
__Returns:__
[String] Class name for button
--
##### [button](https://github.com/appium/ruby_lib/blob/a4c238552724878c31d8ff0179ef00d8258c76a4/lib/appium_lib/ios/element/button.rb#L16) 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:__
[UIAButton|XCUIElementTypeButton]
--
##### [buttons](https://github.com/appium/ruby_lib/blob/a4c238552724878c31d8ff0179ef00d8258c76a4/lib/appium_lib/ios/element/button.rb#L26) 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<UIAButton|XCUIElementTypeButton>]
--
##### [first_button](https://github.com/appium/ruby_lib/blob/a4c238552724878c31d8ff0179ef00d8258c76a4/lib/appium_lib/ios/element/button.rb#L33) ios
> def first_button
Find the first UIAButton|XCUIElementTypeButton.
__Returns:__
[UIAButton|XCUIElementTypeButton]
--
##### [last_button](https://github.com/appium/ruby_lib/blob/a4c238552724878c31d8ff0179ef00d8258c76a4/lib/appium_lib/ios/element/button.rb#L41) 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:__
[UIAButton|XCUIElementTypeButton]
--
##### [button_exact](https://github.com/appium/ruby_lib/blob/a4c238552724878c31d8ff0179ef00d8258c76a4/lib/appium_lib/ios/element/button.rb#L48) ios
> def button_exact(value)
Find the first UIAButton|XCUIElementTypeButton that exactly matches value.
__Parameters:__
[String] value - the value to match exactly
__Returns:__
[UIAButton|XCUIElementTypeButton]
--
##### [buttons_exact](https://github.com/appium/ruby_lib/blob/a4c238552724878c31d8ff0179ef00d8258c76a4/lib/appium_lib/ios/element/button.rb#L55) ios
> def buttons_exact(value)
Find all UIAButtons|XCUIElementTypeButtons that exactly match value.
__Parameters:__
[String] value - the value to match exactly
__Returns:__
[Array<UIAButton|XCUIElementTypeButton>]
--
##### [uiautomation_find](https://github.com/appium/ruby_lib/blob/a4c238552724878c31d8ff0179ef00d8258c76a4/lib/appium_lib/ios/mobile_methods.rb#L19) ios
> def uiautomation_find
find_element/s can be used with a [UIAutomation command](https://developer.apple.com/library/ios/documentation/ToolsLanguages/Reference/UIAWindowClassReference/UIAWindow/UIAWindow.html#//apple_ref/doc/uid/TP40009930).
```ruby
find_elements :uiautomation, 'elements()
```
--
##### [ios_predicate_string_find](https://github.com/appium/ruby_lib/blob/a4c238552724878c31d8ff0179ef00d8258c76a4/lib/appium_lib/ios/mobile_methods.rb#L19) ios
> def ios_predicate_string_find
find_element/s can be used with a [Predicates](https://developer.apple.com/library/content/documentation/Cocoa/Conceptual/Predicates/AdditionalChapters/Introduction.html)
```ruby
find_elements :predicate, "isWDVisible == 1"
find_elements :predicate, 'wdName == "Buttons"'
find_elements :predicate, 'wdValue == "SearchBar" AND isWDDivisible == 1'
```
--
##### [find](https://github.com/appium/ruby_lib/blob/a4c238552724878c31d8ff0179ef00d8258c76a4/lib/appium_lib/ios/element/generic.rb#L6) 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/a4c238552724878c31d8ff0179ef00d8258c76a4/lib/appium_lib/ios/element/generic.rb#L13) 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/a4c238552724878c31d8ff0179ef00d8258c76a4/lib/appium_lib/ios/element/generic.rb#L20) 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/a4c238552724878c31d8ff0179ef00d8258c76a4/lib/appium_lib/ios/element/generic.rb#L27) 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/a4c238552724878c31d8ff0179ef00d8258c76a4/lib/appium_lib/ios/element/generic.rb#L33) ios
> def raise_error_if_no_element(element)
--
##### [select_visible_elements](https://github.com/appium/ruby_lib/blob/a4c238552724878c31d8ff0179ef00d8258c76a4/lib/appium_lib/ios/element/generic.rb#L40) ios
> def select_visible_elements(elements)
Return visible elements.
--
##### [hide_keyboard](https://github.com/appium/ruby_lib/blob/a4c238552724878c31d8ff0179ef00d8258c76a4/lib/appium_lib/ios/xcuitest/device.rb#L9) ios
> def hide_keyboard
Hide the onscreen keyboard
__Parameters:__
[String] close_key - The name of the key which closes the keyboard.
[Symbol] strategy - The symbol of the strategy which closes the keyboard.
XCUITest ignore this argument.
Default for iOS is `:pressKey`. Default for Android is `:tapOutside`.
--
##### [ios_version](https://github.com/appium/ruby_lib/blob/a4c238552724878c31d8ff0179ef00d8258c76a4/lib/appium_lib/ios/xcuitest/helper.rb#L7) ios
> def ios_version
Return the iOS version as an array of integers
__Returns:__
[Array<Integer>]
--
##### [last_ele](https://github.com/appium/ruby_lib/blob/a4c238552724878c31d8ff0179ef00d8258c76a4/lib/appium_lib/ios/xcuitest/helper.rb#L32) 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/a4c238552724878c31d8ff0179ef00d8258c76a4/lib/appium_lib/ios/xcuitest/helper.rb#L42) 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/a4c238552724878c31d8ff0179ef00d8258c76a4/lib/appium_lib/ios/xcuitest/helper.rb#L50) 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/a4c238552724878c31d8ff0179ef00d8258c76a4/lib/appium_lib/ios/xcuitest/helper.rb#L62) 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/a4c238552724878c31d8ff0179ef00d8258c76a4/lib/appium_lib/ios/xcuitest/helper.rb#L85) 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]]
--
##### [UIATextField](https://github.com/appium/ruby_lib/blob/a4c238552724878c31d8ff0179ef00d8258c76a4/lib/appium_lib/ios/element/textfield.rb#L3) ios
> UIATextField = 'UIATextField'.freeze
--
##### [UIASecureTextField](https://github.com/appium/ruby_lib/blob/a4c238552724878c31d8ff0179ef00d8258c76a4/lib/appium_lib/ios/element/textfield.rb#L4) ios
> UIASecureTextField = 'UIASecureTextField'.freeze
--
##### [XCUIElementTypeTextField](https://github.com/appium/ruby_lib/blob/a4c238552724878c31d8ff0179ef00d8258c76a4/lib/appium_lib/ios/element/textfield.rb#L6) ios
> XCUIElementTypeTextField = 'XCUIElementTypeTextField'.freeze
--
##### [XCUIElementTypeSecureTextField](https://github.com/appium/ruby_lib/blob/a4c238552724878c31d8ff0179ef00d8258c76a4/lib/appium_lib/ios/element/textfield.rb#L7) ios
> XCUIElementTypeSecureTextField = 'XCUIElementTypeSecureTextField'.freeze
--
##### [text_field_class](https://github.com/appium/ruby_lib/blob/a4c238552724878c31d8ff0179ef00d8258c76a4/lib/appium_lib/ios/element/textfield.rb#L10) ios
> def text_field_class
__Returns:__
[String] Class name for text field
--
##### [secure_text_field_class](https://github.com/appium/ruby_lib/blob/a4c238552724878c31d8ff0179ef00d8258c76a4/lib/appium_lib/ios/element/textfield.rb#L15) ios
> def secure_text_field_class
__Returns:__
[String] Class name for secure text field
--
##### [textfield](https://github.com/appium/ruby_lib/blob/a4c238552724878c31d8ff0179ef00d8258c76a4/lib/appium_lib/ios/element/textfield.rb#L24) 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/a4c238552724878c31d8ff0179ef00d8258c76a4/lib/appium_lib/ios/element/textfield.rb#L42) 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/a4c238552724878c31d8ff0179ef00d8258c76a4/lib/appium_lib/ios/element/textfield.rb#L49) ios
> def first_textfield
Find the first TextField.
__Returns:__
[TextField]
--
##### [last_textfield](https://github.com/appium/ruby_lib/blob/a4c238552724878c31d8ff0179ef00d8258c76a4/lib/appium_lib/ios/element/textfield.rb#L55) ios
> def last_textfield
Find the last TextField.
__Returns:__
[TextField]
--
##### [textfield_exact](https://github.com/appium/ruby_lib/blob/a4c238552724878c31d8ff0179ef00d8258c76a4/lib/appium_lib/ios/element/textfield.rb#L64) 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/a4c238552724878c31d8ff0179ef00d8258c76a4/lib/appium_lib/ios/element/textfield.rb#L71) 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/a4c238552724878c31d8ff0179ef00d8258c76a4/lib/appium_lib/ios/element/textfield.rb#L78) ios
> def _textfield_visible
Appium
--
##### [_textfield_exact_string](https://github.com/appium/ruby_lib/blob/a4c238552724878c31d8ff0179ef00d8258c76a4/lib/appium_lib/ios/element/textfield.rb#L83) ios
> def _textfield_exact_string(value)
Appium
--
##### [_textfield_contains_string](https://github.com/appium/ruby_lib/blob/a4c238552724878c31d8ff0179ef00d8258c76a4/lib/appium_lib/ios/element/textfield.rb#L90) ios
> def _textfield_contains_string(value)
Appium
--
##### [swipe](https://github.com/appium/ruby_lib/blob/a4c238552724878c31d8ff0179ef00d8258c76a4/lib/appium_lib/ios/xcuitest/gestures.rb#L11) 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/a4c238552724878c31d8ff0179ef00d8258c76a4/lib/appium_lib/ios/xcuitest/gestures.rb#L29) ios
> def scroll(direction:, name: nil, element: nil, to_visible: nil, predicate_string: nil)
__Parameters:__
[string] direction - Either 'up', 'down', 'left' or 'right'.
[Hash] opts - a customizable set of options
--
##### [pinch](https://github.com/appium/ruby_lib/blob/a4c238552724878c31d8ff0179ef00d8258c76a4/lib/appium_lib/ios/xcuitest/gestures.rb#L48) 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/a4c238552724878c31d8ff0179ef00d8258c76a4/lib/appium_lib/ios/xcuitest/gestures.rb#L63) 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/a4c238552724878c31d8ff0179ef00d8258c76a4/lib/appium_lib/ios/xcuitest/gestures.rb#L80) 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/a4c238552724878c31d8ff0179ef00d8258c76a4/lib/appium_lib/ios/xcuitest/gestures.rb#L93) 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")
```
--
##### [tap](https://github.com/appium/ruby_lib/blob/a4c238552724878c31d8ff0179ef00d8258c76a4/lib/appium_lib/ios/xcuitest/gestures.rb#L108) ios
> def 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/a4c238552724878c31d8ff0179ef00d8258c76a4/lib/appium_lib/ios/xcuitest/gestures.rb#L128) 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/a4c238552724878c31d8ff0179ef00d8258c76a4/lib/appium_lib/ios/xcuitest/gestures.rb#L145) 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/a4c238552724878c31d8ff0179ef00d8258c76a4/lib/appium_lib/ios/xcuitest/gestures.rb#L163) 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.
--
##### [static_text_class](https://github.com/appium/ruby_lib/blob/a4c238552724878c31d8ff0179ef00d8258c76a4/lib/appium_lib/ios/xcuitest/element/text.rb#L9) ios
> def static_text_class
__Returns:__
[String] Class name for text
--
##### [text](https://github.com/appium/ruby_lib/blob/a4c238552724878c31d8ff0179ef00d8258c76a4/lib/appium_lib/ios/xcuitest/element/text.rb#L17) 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:__
[UIAStaticText|XCUIElementTypeStaticText]
--
##### [texts](https://github.com/appium/ruby_lib/blob/a4c238552724878c31d8ff0179ef00d8258c76a4/lib/appium_lib/ios/xcuitest/element/text.rb#L26) 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<UIAStaticText|XCUIElementTypeStaticText>]
--
##### [first_text](https://github.com/appium/ruby_lib/blob/a4c238552724878c31d8ff0179ef00d8258c76a4/lib/appium_lib/ios/xcuitest/element/text.rb#L34) ios
> def first_text
Find the first UIAStaticText|XCUIElementTypeStaticText.
__Returns:__
[UIAStaticText|XCUIElementTypeStaticText]
--
##### [last_text](https://github.com/appium/ruby_lib/blob/a4c238552724878c31d8ff0179ef00d8258c76a4/lib/appium_lib/ios/xcuitest/element/text.rb#L40) ios
> def last_text
Find the last UIAStaticText|XCUIElementTypeStaticText.
__Returns:__
[UIAStaticText|XCUIElementTypeStaticText]
--
##### [text_exact](https://github.com/appium/ruby_lib/blob/a4c238552724878c31d8ff0179ef00d8258c76a4/lib/appium_lib/ios/xcuitest/element/text.rb#L47) ios
> def text_exact(value)
Find the first UIAStaticText|XCUIElementTypeStaticText that exactly matches value.
__Parameters:__
[String] value - the value to match exactly
__Returns:__
[UIAStaticText|XCUIElementTypeStaticText]
--
##### [texts_exact](https://github.com/appium/ruby_lib/blob/a4c238552724878c31d8ff0179ef00d8258c76a4/lib/appium_lib/ios/xcuitest/element/text.rb#L54) ios
> def texts_exact(value)
Find all UIAStaticTexts|XCUIElementTypeStaticTexts that exactly match value.
__Parameters:__
[String] value - the value to match exactly
__Returns:__
[Array<UIAStaticText|XCUIElementTypeStaticText>]
--
##### [button_class](https://github.com/appium/ruby_lib/blob/a4c238552724878c31d8ff0179ef00d8258c76a4/lib/appium_lib/ios/xcuitest/element/button.rb#L9) ios
> def button_class
__Returns:__
[String] Class name for button
--
##### [button](https://github.com/appium/ruby_lib/blob/a4c238552724878c31d8ff0179ef00d8258c76a4/lib/appium_lib/ios/xcuitest/element/button.rb#L17) 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:__
[UIAButton|XCUIElementTypeButton]
--
##### [buttons](https://github.com/appium/ruby_lib/blob/a4c238552724878c31d8ff0179ef00d8258c76a4/lib/appium_lib/ios/xcuitest/element/button.rb#L27) 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<UIAButton|XCUIElementTypeButton>]
--
##### [first_button](https://github.com/appium/ruby_lib/blob/a4c238552724878c31d8ff0179ef00d8258c76a4/lib/appium_lib/ios/xcuitest/element/button.rb#L35) ios
> def first_button
Find the first UIAButton|XCUIElementTypeButton.
__Returns:__
[UIAButton|XCUIElementTypeButton]
--
##### [last_button](https://github.com/appium/ruby_lib/blob/a4c238552724878c31d8ff0179ef00d8258c76a4/lib/appium_lib/ios/xcuitest/element/button.rb#L43) 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:__
[UIAButton|XCUIElementTypeButton]
--
##### [button_exact](https://github.com/appium/ruby_lib/blob/a4c238552724878c31d8ff0179ef00d8258c76a4/lib/appium_lib/ios/xcuitest/element/button.rb#L50) ios
> def button_exact(value)
Find the first UIAButton|XCUIElementTypeButton that exactly matches value.
__Parameters:__
[String] value - the value to match exactly
__Returns:__
[UIAButton|XCUIElementTypeButton]
--
##### [buttons_exact](https://github.com/appium/ruby_lib/blob/a4c238552724878c31d8ff0179ef00d8258c76a4/lib/appium_lib/ios/xcuitest/element/button.rb#L57) ios
> def buttons_exact(value)
Find all UIAButtons|XCUIElementTypeButtons that exactly match value.
__Parameters:__
[String] value - the value to match exactly
__Returns:__
[Array<UIAButton|XCUIElementTypeButton>]
--
##### [ios_class_chain_find](https://github.com/appium/ruby_lib/blob/a4c238552724878c31d8ff0179ef00d8258c76a4/lib/appium_lib/ios/xcuitest/mobile_methods.rb#L17) ios
> def ios_class_chain_find
Only for XCUITest(WebDriverAgent)
find_element/s can be used with a [class chain]( https://github.com/facebook/WebDriverAgent/wiki/Queries)
```ruby
# select the third child button of the first child window element
find_elements :class_chain, 'XCUIElementTypeWindow/XCUIElementTypeButton[3]'
# select all the children windows
find_elements :class_chain, 'XCUIElementTypeWindow'
# select the second last child of the second child window
find_elements :class_chain, 'XCUIElementTypeWindow[2]/XCUIElementTypeAny[-2]'
```
--
##### [find](https://github.com/appium/ruby_lib/blob/a4c238552724878c31d8ff0179ef00d8258c76a4/lib/appium_lib/ios/xcuitest/element/generic.rb#L8) 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/a4c238552724878c31d8ff0179ef00d8258c76a4/lib/appium_lib/ios/xcuitest/element/generic.rb#L15) 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/a4c238552724878c31d8ff0179ef00d8258c76a4/lib/appium_lib/ios/xcuitest/element/generic.rb#L23) 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/a4c238552724878c31d8ff0179ef00d8258c76a4/lib/appium_lib/ios/xcuitest/element/generic.rb#L30) 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/a4c238552724878c31d8ff0179ef00d8258c76a4/lib/appium_lib/ios/xcuitest/element/generic.rb#L37) ios
> def raise_error_if_no_element(element)
--
##### [select_visible_elements](https://github.com/appium/ruby_lib/blob/a4c238552724878c31d8ff0179ef00d8258c76a4/lib/appium_lib/ios/xcuitest/element/generic.rb#L44) ios
> def select_visible_elements(elements)
Return visible elements.
--
##### [text_field_class](https://github.com/appium/ruby_lib/blob/a4c238552724878c31d8ff0179ef00d8258c76a4/lib/appium_lib/ios/xcuitest/element/textfield.rb#L9) ios
> def text_field_class
__Returns:__
[String] Class name for text field
--
##### [secure_text_field_class](https://github.com/appium/ruby_lib/blob/a4c238552724878c31d8ff0179ef00d8258c76a4/lib/appium_lib/ios/xcuitest/element/textfield.rb#L14) ios
> def secure_text_field_class
__Returns:__
[String] Class name for secure text field
--
##### [textfield](https://github.com/appium/ruby_lib/blob/a4c238552724878c31d8ff0179ef00d8258c76a4/lib/appium_lib/ios/xcuitest/element/textfield.rb#L23) 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/a4c238552724878c31d8ff0179ef00d8258c76a4/lib/appium_lib/ios/xcuitest/element/textfield.rb#L41) 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/a4c238552724878c31d8ff0179ef00d8258c76a4/lib/appium_lib/ios/xcuitest/element/textfield.rb#L50) ios
> def first_textfield
Find the first TextField.
__Returns:__
[TextField]
--
##### [last_textfield](https://github.com/appium/ruby_lib/blob/a4c238552724878c31d8ff0179ef00d8258c76a4/lib/appium_lib/ios/xcuitest/element/textfield.rb#L56) ios
> def last_textfield
Find the last TextField.
__Returns:__
[TextField]
--
##### [textfield_exact](https://github.com/appium/ruby_lib/blob/a4c238552724878c31d8ff0179ef00d8258c76a4/lib/appium_lib/ios/xcuitest/element/textfield.rb#L65) 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/a4c238552724878c31d8ff0179ef00d8258c76a4/lib/appium_lib/ios/xcuitest/element/textfield.rb#L72) ios
> def textfields_exact(value)
Find all TextFields that exactly match value.
__Parameters:__
[String] value - the value to match exactly
__Returns:__
[Array<TextField>]
--
##### [value](https://github.com/appium/ruby_lib/blob/a4c238552724878c31d8ff0179ef00d8258c76a4/lib/appium_lib/common/patch.rb#L12)
> def value
Returns the value attribute
Fixes NoMethodError: undefined method `value' for Selenium::WebDriver::Element
--
##### [name](https://github.com/appium/ruby_lib/blob/a4c238552724878c31d8ff0179ef00d8258c76a4/lib/appium_lib/common/patch.rb#L19)
> def name
Returns the name attribute
Fixes NoMethodError: undefined method `name' for Selenium::WebDriver::Element
--
##### [location_rel](https://github.com/appium/ruby_lib/blob/a4c238552724878c31d8ff0179ef00d8258c76a4/lib/appium_lib/common/patch.rb#L30)
> def location_rel(driver = $driver)
For use with mobile tap.
```ruby
execute_script 'mobile: tap', :x => 0.0, :y => 0.98
```
__Returns:__
[OpenStruct] the relative x, y in a struct. ex: { x: 0.50, y: 0.20 }
--
##### [DEFAULT_HEADERS](https://github.com/appium/ruby_lib/blob/a4c238552724878c31d8ff0179ef00d8258c76a4/lib/appium_lib/common/patch.rb#L170)
> DEFAULT_HEADERS = { 'Accept' => CONTENT_TYPE, 'User-Agent' => "appium/ruby_lib/#{::Appium::VERSION}" }.freeze
--
##### [patch_remote_driver_commands](https://github.com/appium/ruby_lib/blob/a4c238552724878c31d8ff0179ef00d8258c76a4/lib/appium_lib/common/patch.rb#L173)
> def patch_remote_driver_commands
--