appium_lib 8.2.1 → 9.0.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (40) hide show
  1. checksums.yaml +4 -4
  2. data/android_tests/lib/android/specs/common/device_touchaction.rb +2 -2
  3. data/appium_lib.gemspec +2 -2
  4. data/docs/android_docs.md +245 -212
  5. data/docs/docs.md +17 -15
  6. data/docs/index_paths.md +2 -2
  7. data/docs/ios_docs.md +422 -240
  8. data/docs/ios_xcuitest.md +25 -0
  9. data/ios_tests/Gemfile +2 -0
  10. data/ios_tests/appium.txt +2 -1
  11. data/ios_tests/lib/common.rb +98 -4
  12. data/ios_tests/lib/ios/specs/common/helper.rb +24 -28
  13. data/ios_tests/lib/ios/specs/common/patch.rb +1 -1
  14. data/ios_tests/lib/ios/specs/device/device.rb +17 -11
  15. data/ios_tests/lib/ios/specs/device/multi_touch.rb +22 -1
  16. data/ios_tests/lib/ios/specs/device/touch_actions.rb +14 -5
  17. data/ios_tests/lib/ios/specs/driver.rb +13 -9
  18. data/ios_tests/lib/ios/specs/ios/element/alert.rb +12 -8
  19. data/ios_tests/lib/ios/specs/ios/element/button.rb +6 -3
  20. data/ios_tests/lib/ios/specs/ios/element/text.rb +5 -3
  21. data/ios_tests/lib/ios/specs/ios/element/textfield.rb +12 -8
  22. data/ios_tests/lib/ios/specs/ios/helper.rb +9 -3
  23. data/ios_tests/lib/ios/specs/ios/patch.rb +9 -1
  24. data/ios_tests/readme.md +3 -2
  25. data/lib/appium_lib/common/error.rb +5 -0
  26. data/lib/appium_lib/common/version.rb +2 -2
  27. data/lib/appium_lib/device/device.rb +7 -1
  28. data/lib/appium_lib/device/multi_touch.rb +27 -9
  29. data/lib/appium_lib/device/touch_actions.rb +12 -5
  30. data/lib/appium_lib/driver.rb +29 -1
  31. data/lib/appium_lib/ios/element/button.rb +50 -24
  32. data/lib/appium_lib/ios/element/generic.rb +20 -4
  33. data/lib/appium_lib/ios/element/text.rb +48 -24
  34. data/lib/appium_lib/ios/element/textfield.rb +80 -40
  35. data/lib/appium_lib/ios/helper.rb +107 -33
  36. data/lib/appium_lib/ios/mobile_methods.rb +1 -0
  37. data/lib/appium_lib/ios/patch.rb +5 -2
  38. data/readme.md +1 -0
  39. data/release_notes.md +10 -0
  40. metadata +16 -2
@@ -1,22 +1,24 @@
1
- #### Documentation
1
+ ### Documentation
2
2
 
3
3
  - find_elements returns an empty array [] when no elements are found.
4
4
  - button(int), textfield(int) use xpath so 1 is the first button, 2 the second etc. 0 is invalid.
5
5
 
6
- ##### [app_lib on rubydoc.info](http://www.rubydoc.info/github/appium/ruby_lib/master/toplevel)
6
+ #### [app_lib on rubydoc.info](http://www.rubydoc.info/github/appium/ruby_lib/master/toplevel)
7
+ ##### General
8
+ - [Appium](https://github.com/appium/appium/blob/master/README.md)
9
+ - [Ruby selenium-webdriver](https://github.com/SeleniumHQ/selenium/wiki/Ruby-Bindings)
10
+ - [All methods supported by Appium](https://github.com/appium/appium-base-driver/blob/master/docs/mjsonwp/protocol-methods.md)
11
+ - [MiniTest Expectations](http://docs.seattlerb.org/minitest/Minitest/Expectations.html)
7
12
 
13
+ ##### iOS
8
14
  - [iOS UI Automation](http://developer.apple.com/library/ios/#documentation/DeveloperTools/Reference/UIAutomationRef/_index.html) Example use `@driver.execute_script "UIATarget.localTarget().frontMostApp().mainWindow().rect()"
9
15
  `
16
+ - [mechanic names of elements](https://github.com/jaykz52/mechanic/blob/8c490e1d225f384847e47ffdafb47cc2248bb96c/src/mechanic-core.js#L28)
17
+ - [WebDriverAgent](https://github.com/facebook/WebDriverAgent)
18
+
19
+ ##### Android
10
20
  - [Android UIAutomator](http://developer.android.com/tools/help/uiautomator/index.html)
11
21
  - [UiSelector.java](https://android.googlesource.com/platform/frameworks/testing/+/master/uiautomator/library/core-src/com/android/uiautomator/core/UiSelector.java)
12
- - [Ruby selenium-webdriver](http://selenium.googlecode.com/svn/trunk/docs/api/rb/index.html)
13
- - [Appium](https://github.com/appium/appium/blob/master/README.md)
14
- - [Appium extension](https://github.com/appium/appium/wiki/Automating-mobile-gestures)
15
- - [mechanic names of elements](https://github.com/jaykz52/mechanic/blob/8c490e1d225f384847e47ffdafb47cc2248bb96c/src/mechanic-core.js#L28)
16
- - [All methods supported by Appium](https://github.com/appium/appium/wiki/JSON-Wire-Protocol:-Supported-Methods)
17
- - [Appium's mobile gesture docs](https://github.com/appium/appium/wiki/Automating-mobile-gestures)
18
- - [MiniTest Expectations](http://docs.seattlerb.org/minitest/Minitest/Expectations.html)
19
-
20
22
 
21
23
  --
22
24
 
@@ -36,7 +38,7 @@ Example of automating the built in Android settings.
36
38
  ```ruby
37
39
  # run Pry, and paste the following
38
40
  apk = {
39
- platformName: :android,
41
+ platformName: 'android',
40
42
  deviceName: :nexus,
41
43
  appPackage: 'com.android.settings',
42
44
  appActivity: '.Settings',
@@ -49,7 +51,7 @@ Appium::Driver.new(caps: apk).start_driver
49
51
 
50
52
  Example use of Appium's mobile gesture.
51
53
 
52
- > @driver.execute_script 'mobile: tap', :x => 0, :y => 500
54
+ > @driver.find_element()
53
55
 
54
56
  `console.rb` uses some code from [simple_test.rb](
55
57
  https://github.com/appium/appium/blob/82995f47408530c80c3376f4e07a1f649d96ba22/sample-code/examples/ruby/simple_test.rb) and is released under the [same license](https://github.com/appium/appium/blob/c58eeb66f2d6fa3b9a89d188a2e657cca7cb300f/LICENSE) as Appium. The [Accessibility Inspector](https://developer.apple.com/library/ios/#documentation/UserExperience/Conceptual/iPhoneAccessibility/Testing_Accessibility/Testing_Accessibility.html) is helpful for discovering button names and textfield values.
@@ -59,7 +61,7 @@ Long click on an ImageView in Android.
59
61
 
60
62
  ```
61
63
  last_image = find_elements(:tag_name, :ImageView).last
62
- mobile(:longClick, element: last_image.ref)
64
+ long_press(element: last_image)
63
65
  ```
64
66
 
65
67
  Rotate examples.
@@ -216,7 +218,7 @@ au._returnElems(r);
216
218
  execute_script s
217
219
  ```
218
220
 
219
- #### XPath
221
+ #### XPath(UIAutomation)
220
222
 
221
223
  See [#194](https://github.com/appium/appium/pull/194/files) for details.
222
224
 
@@ -304,7 +306,7 @@ mobile gestures on iOS are known to be crashy. Fix by adding pre/post event slee
304
306
 
305
307
  ```ruby
306
308
  sleep 3
307
- mobile :tap, x: 10, y: 100, duration: 0.5
309
+ tap(x: 10, y: 100)
308
310
  sleep 1
309
311
  ```
310
312
 
@@ -8,14 +8,14 @@ that appium calculates when the page source is requested. Note this is not the s
8
8
  The index path can be used by calling [getElementByIndexPath]( https://github.com/appium/appium-uiauto/blob/af1befa8208074686cd38b845ddefabc057106fc/uiauto/lib/mechanic-ext/xpath-ext.js#L239):
9
9
 
10
10
  ```ruby
11
- # ruby example
11
+ # ruby example # For Appium(automation name), not XCUITest
12
12
  execute_script('$.getElementByIndexPath("/0/1/1/10/0")').text # Alerts
13
13
  ```
14
14
 
15
15
  Internally what happens is `/0/1/1/10/0` is transformed into `1/1/10/0` and executed as follows:
16
16
 
17
17
  ```ruby
18
- # ruby example
18
+ # ruby example # For Appium(automation name), not XCUITest
19
19
  execute_script('$.mainApp().elements()[1].elements()[1].elements()[10].elements()[0]').text # Alerts
20
20
  ```
21
21
 
@@ -1,4 +1,4 @@
1
- ##### [load_settings](https://github.com/appium/ruby_lib/blob/ad91ee47a96bf7a19b6f784dc760ac70b8788e5a/lib/appium_lib/driver.rb#L69)
1
+ ##### [load_settings](https://github.com/appium/ruby_lib/blob/54ff9c45df80ce901b718347e79e761f93a4316b/lib/appium_lib/driver.rb#L72)
2
2
 
3
3
  > def self.load_settings(opts = {})
4
4
 
@@ -26,7 +26,7 @@ __Returns:__
26
26
 
27
27
  --
28
28
 
29
- ##### [load_appium_txt](https://github.com/appium/ruby_lib/blob/ad91ee47a96bf7a19b6f784dc760ac70b8788e5a/lib/appium_lib/driver.rb#L102)
29
+ ##### [load_appium_txt](https://github.com/appium/ruby_lib/blob/54ff9c45df80ce901b718347e79e761f93a4316b/lib/appium_lib/driver.rb#L105)
30
30
 
31
31
  > def self.load_settings(opts = {})
32
32
 
@@ -54,7 +54,7 @@ __Returns:__
54
54
 
55
55
  --
56
56
 
57
- ##### [expand_required_files](https://github.com/appium/ruby_lib/blob/ad91ee47a96bf7a19b6f784dc760ac70b8788e5a/lib/appium_lib/driver.rb#L108)
57
+ ##### [expand_required_files](https://github.com/appium/ruby_lib/blob/54ff9c45df80ce901b718347e79e761f93a4316b/lib/appium_lib/driver.rb#L111)
58
58
 
59
59
  > def self.expand_required_files(base_dir, file_paths)
60
60
 
@@ -72,7 +72,7 @@ __Returns:__
72
72
 
73
73
  --
74
74
 
75
- ##### [symbolize_keys](https://github.com/appium/ruby_lib/blob/ad91ee47a96bf7a19b6f784dc760ac70b8788e5a/lib/appium_lib/driver.rb#L140)
75
+ ##### [symbolize_keys](https://github.com/appium/ruby_lib/blob/54ff9c45df80ce901b718347e79e761f93a4316b/lib/appium_lib/driver.rb#L143)
76
76
 
77
77
  > def self.symbolize_keys(hash)
78
78
 
@@ -83,7 +83,7 @@ https://github.com/rails/docrails/blob/a3b1105ada3da64acfa3843b164b14b734456a50/
83
83
 
84
84
  --
85
85
 
86
- ##### [promote_singleton_appium_methods](https://github.com/appium/ruby_lib/blob/ad91ee47a96bf7a19b6f784dc760ac70b8788e5a/lib/appium_lib/driver.rb#L161)
86
+ ##### [promote_singleton_appium_methods](https://github.com/appium/ruby_lib/blob/54ff9c45df80ce901b718347e79e761f93a4316b/lib/appium_lib/driver.rb#L164)
87
87
 
88
88
  > def self.promote_singleton_appium_methods(modules)
89
89
 
@@ -101,7 +101,7 @@ otherwise, the array of modules will be used as the promotion target.
101
101
 
102
102
  --
103
103
 
104
- ##### [promote_appium_methods](https://github.com/appium/ruby_lib/blob/ad91ee47a96bf7a19b6f784dc760ac70b8788e5a/lib/appium_lib/driver.rb#L212)
104
+ ##### [promote_appium_methods](https://github.com/appium/ruby_lib/blob/54ff9c45df80ce901b718347e79e761f93a4316b/lib/appium_lib/driver.rb#L215)
105
105
 
106
106
  > def self.promote_appium_methods(class_array)
107
107
 
@@ -131,7 +131,7 @@ __Parameters:__
131
131
 
132
132
  --
133
133
 
134
- ##### [global_webdriver_http_sleep](https://github.com/appium/ruby_lib/blob/ad91ee47a96bf7a19b6f784dc760ac70b8788e5a/lib/appium_lib/driver.rb#L246)
134
+ ##### [global_webdriver_http_sleep](https://github.com/appium/ruby_lib/blob/54ff9c45df80ce901b718347e79e761f93a4316b/lib/appium_lib/driver.rb#L249)
135
135
 
136
136
  > def global_webdriver_http_sleep
137
137
 
@@ -139,7 +139,7 @@ The amount to sleep in seconds before every webdriver http call.
139
139
 
140
140
  --
141
141
 
142
- ##### [global_webdriver_http_sleep=](https://github.com/appium/ruby_lib/blob/ad91ee47a96bf7a19b6f784dc760ac70b8788e5a/lib/appium_lib/driver.rb#L246)
142
+ ##### [global_webdriver_http_sleep=](https://github.com/appium/ruby_lib/blob/54ff9c45df80ce901b718347e79e761f93a4316b/lib/appium_lib/driver.rb#L249)
143
143
 
144
144
  > def global_webdriver_http_sleep=(value)
145
145
 
@@ -147,7 +147,7 @@ The amount to sleep in seconds before every webdriver http call.
147
147
 
148
148
  --
149
149
 
150
- ##### [caps](https://github.com/appium/ruby_lib/blob/ad91ee47a96bf7a19b6f784dc760ac70b8788e5a/lib/appium_lib/driver.rb#L248)
150
+ ##### [caps](https://github.com/appium/ruby_lib/blob/54ff9c45df80ce901b718347e79e761f93a4316b/lib/appium_lib/driver.rb#L251)
151
151
 
152
152
  > def caps
153
153
 
@@ -155,7 +155,7 @@ Selenium webdriver capabilities
155
155
 
156
156
  --
157
157
 
158
- ##### [caps=](https://github.com/appium/ruby_lib/blob/ad91ee47a96bf7a19b6f784dc760ac70b8788e5a/lib/appium_lib/driver.rb#L248)
158
+ ##### [caps=](https://github.com/appium/ruby_lib/blob/54ff9c45df80ce901b718347e79e761f93a4316b/lib/appium_lib/driver.rb#L251)
159
159
 
160
160
  > def caps=(value)
161
161
 
@@ -163,7 +163,7 @@ Selenium webdriver capabilities
163
163
 
164
164
  --
165
165
 
166
- ##### [custom_url](https://github.com/appium/ruby_lib/blob/ad91ee47a96bf7a19b6f784dc760ac70b8788e5a/lib/appium_lib/driver.rb#L250)
166
+ ##### [custom_url](https://github.com/appium/ruby_lib/blob/54ff9c45df80ce901b718347e79e761f93a4316b/lib/appium_lib/driver.rb#L253)
167
167
 
168
168
  > def custom_url
169
169
 
@@ -171,7 +171,7 @@ Custom URL for the selenium server
171
171
 
172
172
  --
173
173
 
174
- ##### [custom_url=](https://github.com/appium/ruby_lib/blob/ad91ee47a96bf7a19b6f784dc760ac70b8788e5a/lib/appium_lib/driver.rb#L250)
174
+ ##### [custom_url=](https://github.com/appium/ruby_lib/blob/54ff9c45df80ce901b718347e79e761f93a4316b/lib/appium_lib/driver.rb#L253)
175
175
 
176
176
  > def custom_url=(value)
177
177
 
@@ -179,7 +179,7 @@ Custom URL for the selenium server
179
179
 
180
180
  --
181
181
 
182
- ##### [export_session](https://github.com/appium/ruby_lib/blob/ad91ee47a96bf7a19b6f784dc760ac70b8788e5a/lib/appium_lib/driver.rb#L252)
182
+ ##### [export_session](https://github.com/appium/ruby_lib/blob/54ff9c45df80ce901b718347e79e761f93a4316b/lib/appium_lib/driver.rb#L255)
183
183
 
184
184
  > def export_session
185
185
 
@@ -187,7 +187,7 @@ Export session id to textfile in /tmp for 3rd party tools
187
187
 
188
188
  --
189
189
 
190
- ##### [export_session=](https://github.com/appium/ruby_lib/blob/ad91ee47a96bf7a19b6f784dc760ac70b8788e5a/lib/appium_lib/driver.rb#L252)
190
+ ##### [export_session=](https://github.com/appium/ruby_lib/blob/54ff9c45df80ce901b718347e79e761f93a4316b/lib/appium_lib/driver.rb#L255)
191
191
 
192
192
  > def export_session=(value)
193
193
 
@@ -195,7 +195,7 @@ Export session id to textfile in /tmp for 3rd party tools
195
195
 
196
196
  --
197
197
 
198
- ##### [default_wait](https://github.com/appium/ruby_lib/blob/ad91ee47a96bf7a19b6f784dc760ac70b8788e5a/lib/appium_lib/driver.rb#L257)
198
+ ##### [default_wait](https://github.com/appium/ruby_lib/blob/54ff9c45df80ce901b718347e79e761f93a4316b/lib/appium_lib/driver.rb#L260)
199
199
 
200
200
  > def default_wait
201
201
 
@@ -209,7 +209,7 @@ __Returns:__
209
209
 
210
210
  --
211
211
 
212
- ##### [default_wait=](https://github.com/appium/ruby_lib/blob/ad91ee47a96bf7a19b6f784dc760ac70b8788e5a/lib/appium_lib/driver.rb#L257)
212
+ ##### [default_wait=](https://github.com/appium/ruby_lib/blob/54ff9c45df80ce901b718347e79e761f93a4316b/lib/appium_lib/driver.rb#L260)
213
213
 
214
214
  > def default_wait=(value)
215
215
 
@@ -223,7 +223,7 @@ __Returns:__
223
223
 
224
224
  --
225
225
 
226
- ##### [last_waits](https://github.com/appium/ruby_lib/blob/ad91ee47a96bf7a19b6f784dc760ac70b8788e5a/lib/appium_lib/driver.rb#L259)
226
+ ##### [last_waits](https://github.com/appium/ruby_lib/blob/54ff9c45df80ce901b718347e79e761f93a4316b/lib/appium_lib/driver.rb#L262)
227
227
 
228
228
  > def last_waits
229
229
 
@@ -231,7 +231,7 @@ Array of previous wait time values
231
231
 
232
232
  --
233
233
 
234
- ##### [last_waits=](https://github.com/appium/ruby_lib/blob/ad91ee47a96bf7a19b6f784dc760ac70b8788e5a/lib/appium_lib/driver.rb#L259)
234
+ ##### [last_waits=](https://github.com/appium/ruby_lib/blob/54ff9c45df80ce901b718347e79e761f93a4316b/lib/appium_lib/driver.rb#L262)
235
235
 
236
236
  > def last_waits=(value)
237
237
 
@@ -239,7 +239,7 @@ Array of previous wait time values
239
239
 
240
240
  --
241
241
 
242
- ##### [sauce_username](https://github.com/appium/ruby_lib/blob/ad91ee47a96bf7a19b6f784dc760ac70b8788e5a/lib/appium_lib/driver.rb#L261)
242
+ ##### [sauce_username](https://github.com/appium/ruby_lib/blob/54ff9c45df80ce901b718347e79e761f93a4316b/lib/appium_lib/driver.rb#L264)
243
243
 
244
244
  > def sauce_username
245
245
 
@@ -247,7 +247,7 @@ Username for use on Sauce Labs
247
247
 
248
248
  --
249
249
 
250
- ##### [sauce_username=](https://github.com/appium/ruby_lib/blob/ad91ee47a96bf7a19b6f784dc760ac70b8788e5a/lib/appium_lib/driver.rb#L261)
250
+ ##### [sauce_username=](https://github.com/appium/ruby_lib/blob/54ff9c45df80ce901b718347e79e761f93a4316b/lib/appium_lib/driver.rb#L264)
251
251
 
252
252
  > def sauce_username=(value)
253
253
 
@@ -255,7 +255,7 @@ Username for use on Sauce Labs
255
255
 
256
256
  --
257
257
 
258
- ##### [sauce_access_key](https://github.com/appium/ruby_lib/blob/ad91ee47a96bf7a19b6f784dc760ac70b8788e5a/lib/appium_lib/driver.rb#L263)
258
+ ##### [sauce_access_key](https://github.com/appium/ruby_lib/blob/54ff9c45df80ce901b718347e79e761f93a4316b/lib/appium_lib/driver.rb#L266)
259
259
 
260
260
  > def sauce_access_key
261
261
 
@@ -263,7 +263,7 @@ Access Key for use on Sauce Labs
263
263
 
264
264
  --
265
265
 
266
- ##### [sauce_access_key=](https://github.com/appium/ruby_lib/blob/ad91ee47a96bf7a19b6f784dc760ac70b8788e5a/lib/appium_lib/driver.rb#L263)
266
+ ##### [sauce_access_key=](https://github.com/appium/ruby_lib/blob/54ff9c45df80ce901b718347e79e761f93a4316b/lib/appium_lib/driver.rb#L266)
267
267
 
268
268
  > def sauce_access_key=(value)
269
269
 
@@ -271,7 +271,7 @@ Access Key for use on Sauce Labs
271
271
 
272
272
  --
273
273
 
274
- ##### [appium_port](https://github.com/appium/ruby_lib/blob/ad91ee47a96bf7a19b6f784dc760ac70b8788e5a/lib/appium_lib/driver.rb#L265)
274
+ ##### [appium_port](https://github.com/appium/ruby_lib/blob/54ff9c45df80ce901b718347e79e761f93a4316b/lib/appium_lib/driver.rb#L268)
275
275
 
276
276
  > def appium_port
277
277
 
@@ -279,7 +279,7 @@ Appium's server port
279
279
 
280
280
  --
281
281
 
282
- ##### [appium_port=](https://github.com/appium/ruby_lib/blob/ad91ee47a96bf7a19b6f784dc760ac70b8788e5a/lib/appium_lib/driver.rb#L265)
282
+ ##### [appium_port=](https://github.com/appium/ruby_lib/blob/54ff9c45df80ce901b718347e79e761f93a4316b/lib/appium_lib/driver.rb#L268)
283
283
 
284
284
  > def appium_port=(value)
285
285
 
@@ -287,7 +287,7 @@ Appium's server port
287
287
 
288
288
  --
289
289
 
290
- ##### [appium_device](https://github.com/appium/ruby_lib/blob/ad91ee47a96bf7a19b6f784dc760ac70b8788e5a/lib/appium_lib/driver.rb#L267)
290
+ ##### [appium_device](https://github.com/appium/ruby_lib/blob/54ff9c45df80ce901b718347e79e761f93a4316b/lib/appium_lib/driver.rb#L270)
291
291
 
292
292
  > def appium_device
293
293
 
@@ -295,7 +295,7 @@ Device type to request from the appium server
295
295
 
296
296
  --
297
297
 
298
- ##### [appium_device=](https://github.com/appium/ruby_lib/blob/ad91ee47a96bf7a19b6f784dc760ac70b8788e5a/lib/appium_lib/driver.rb#L267)
298
+ ##### [appium_device=](https://github.com/appium/ruby_lib/blob/54ff9c45df80ce901b718347e79e761f93a4316b/lib/appium_lib/driver.rb#L270)
299
299
 
300
300
  > def appium_device=(value)
301
301
 
@@ -303,7 +303,36 @@ Device type to request from the appium server
303
303
 
304
304
  --
305
305
 
306
- ##### [appium_debug](https://github.com/appium/ruby_lib/blob/ad91ee47a96bf7a19b6f784dc760ac70b8788e5a/lib/appium_lib/driver.rb#L269)
306
+ ##### [automation_name](https://github.com/appium/ruby_lib/blob/54ff9c45df80ce901b718347e79e761f93a4316b/lib/appium_lib/driver.rb#L272)
307
+
308
+ > def automation_name
309
+
310
+ Automation name sent to appium server
311
+
312
+ --
313
+
314
+ ##### [appium_server_version](https://github.com/appium/ruby_lib/blob/54ff9c45df80ce901b718347e79e761f93a4316b/lib/appium_lib/driver.rb#L274)
315
+
316
+ > def appium_server_version
317
+
318
+ Returns the server's version info
319
+
320
+ ```ruby
321
+ {
322
+ "build" => {
323
+ "version" => "0.18.1",
324
+ "revision" => "d242ebcfd92046a974347ccc3a28f0e898595198"
325
+ }
326
+ }
327
+ ```
328
+
329
+ __Returns:__
330
+
331
+      [Hash]
332
+
333
+ --
334
+
335
+ ##### [appium_debug](https://github.com/appium/ruby_lib/blob/54ff9c45df80ce901b718347e79e761f93a4316b/lib/appium_lib/driver.rb#L276)
307
336
 
308
337
  > def appium_debug
309
338
 
@@ -311,7 +340,7 @@ Boolean debug mode for the Appium Ruby bindings
311
340
 
312
341
  --
313
342
 
314
- ##### [appium_debug=](https://github.com/appium/ruby_lib/blob/ad91ee47a96bf7a19b6f784dc760ac70b8788e5a/lib/appium_lib/driver.rb#L269)
343
+ ##### [appium_debug=](https://github.com/appium/ruby_lib/blob/54ff9c45df80ce901b718347e79e761f93a4316b/lib/appium_lib/driver.rb#L276)
315
344
 
316
345
  > def appium_debug=(value)
317
346
 
@@ -319,7 +348,7 @@ Boolean debug mode for the Appium Ruby bindings
319
348
 
320
349
  --
321
350
 
322
- ##### [listener](https://github.com/appium/ruby_lib/blob/ad91ee47a96bf7a19b6f784dc760ac70b8788e5a/lib/appium_lib/driver.rb#L271)
351
+ ##### [listener](https://github.com/appium/ruby_lib/blob/54ff9c45df80ce901b718347e79e761f93a4316b/lib/appium_lib/driver.rb#L278)
323
352
 
324
353
  > def listener
325
354
 
@@ -327,7 +356,7 @@ instance of AbstractEventListener for logging support
327
356
 
328
357
  --
329
358
 
330
- ##### [listener=](https://github.com/appium/ruby_lib/blob/ad91ee47a96bf7a19b6f784dc760ac70b8788e5a/lib/appium_lib/driver.rb#L271)
359
+ ##### [listener=](https://github.com/appium/ruby_lib/blob/54ff9c45df80ce901b718347e79e761f93a4316b/lib/appium_lib/driver.rb#L278)
331
360
 
332
361
  > def listener=(value)
333
362
 
@@ -335,7 +364,7 @@ instance of AbstractEventListener for logging support
335
364
 
336
365
  --
337
366
 
338
- ##### [driver](https://github.com/appium/ruby_lib/blob/ad91ee47a96bf7a19b6f784dc760ac70b8788e5a/lib/appium_lib/driver.rb#L275)
367
+ ##### [driver](https://github.com/appium/ruby_lib/blob/54ff9c45df80ce901b718347e79e761f93a4316b/lib/appium_lib/driver.rb#L281)
339
368
 
340
369
  > def driver
341
370
 
@@ -347,7 +376,7 @@ __Returns:__
347
376
 
348
377
  --
349
378
 
350
- ##### [initialize](https://github.com/appium/ruby_lib/blob/ad91ee47a96bf7a19b6f784dc760ac70b8788e5a/lib/appium_lib/driver.rb#L296)
379
+ ##### [initialize](https://github.com/appium/ruby_lib/blob/54ff9c45df80ce901b718347e79e761f93a4316b/lib/appium_lib/driver.rb#L302)
351
380
 
352
381
  > def initialize(opts = {})
353
382
 
@@ -378,7 +407,7 @@ __Returns:__
378
407
 
379
408
  --
380
409
 
381
- ##### [driver_attributes](https://github.com/appium/ruby_lib/blob/ad91ee47a96bf7a19b6f784dc760ac70b8788e5a/lib/appium_lib/driver.rb#L364)
410
+ ##### [driver_attributes](https://github.com/appium/ruby_lib/blob/54ff9c45df80ce901b718347e79e761f93a4316b/lib/appium_lib/driver.rb#L372)
382
411
 
383
412
  > def driver_attributes
384
413
 
@@ -386,7 +415,7 @@ Returns a hash of the driver attributes
386
415
 
387
416
  --
388
417
 
389
- ##### [device_is_android?](https://github.com/appium/ruby_lib/blob/ad91ee47a96bf7a19b6f784dc760ac70b8788e5a/lib/appium_lib/driver.rb#L385)
418
+ ##### [device_is_android?](https://github.com/appium/ruby_lib/blob/54ff9c45df80ce901b718347e79e761f93a4316b/lib/appium_lib/driver.rb#L393)
390
419
 
391
420
  > def device_is_android?
392
421
 
@@ -398,28 +427,32 @@ __Returns:__
398
427
 
399
428
  --
400
429
 
401
- ##### [appium_server_version](https://github.com/appium/ruby_lib/blob/ad91ee47a96bf7a19b6f784dc760ac70b8788e5a/lib/appium_lib/driver.rb#L401)
430
+ ##### [automation_name_is_xcuitest?](https://github.com/appium/ruby_lib/blob/54ff9c45df80ce901b718347e79e761f93a4316b/lib/appium_lib/driver.rb#L399)
402
431
 
403
- > def appium_server_version
432
+ > def automation_name_is_xcuitest?
404
433
 
405
- Returns the server's version info
434
+ Return true if automationName is 'XCUITest'
406
435
 
407
- ```ruby
408
- {
409
- "build" => {
410
- "version" => "0.18.1",
411
- "revision" => "d242ebcfd92046a974347ccc3a28f0e898595198"
412
- }
413
- }
414
- ```
436
+ __Returns:__
437
+
438
+      [Boolean]
439
+
440
+ --
441
+
442
+ ##### [check_server_version_xcuitest](https://github.com/appium/ruby_lib/blob/54ff9c45df80ce901b718347e79e761f93a4316b/lib/appium_lib/driver.rb#L406)
443
+
444
+ > def check_server_version_xcuitest
445
+
446
+ Return true if the target Appium server is over REQUIRED_VERSION_XCUITEST.
447
+ If the Appium server is under REQUIRED_VERSION_XCUITEST, then error is raised.
415
448
 
416
449
  __Returns:__
417
450
 
418
-      [Hash]
451
+      [Boolean]
419
452
 
420
453
  --
421
454
 
422
- ##### [absolute_app_path](https://github.com/appium/ruby_lib/blob/ad91ee47a96bf7a19b6f784dc760ac70b8788e5a/lib/appium_lib/driver.rb#L413)
455
+ ##### [absolute_app_path](https://github.com/appium/ruby_lib/blob/54ff9c45df80ce901b718347e79e761f93a4316b/lib/appium_lib/driver.rb#L437)
423
456
 
424
457
  > def self.absolute_app_path(opts)
425
458
 
@@ -436,7 +469,7 @@ __Returns:__
436
469
 
437
470
  --
438
471
 
439
- ##### [server_url](https://github.com/appium/ruby_lib/blob/ad91ee47a96bf7a19b6f784dc760ac70b8788e5a/lib/appium_lib/driver.rb#L446)
472
+ ##### [server_url](https://github.com/appium/ruby_lib/blob/54ff9c45df80ce901b718347e79e761f93a4316b/lib/appium_lib/driver.rb#L470)
440
473
 
441
474
  > def server_url
442
475
 
@@ -448,7 +481,7 @@ __Returns:__
448
481
 
449
482
  --
450
483
 
451
- ##### [restart](https://github.com/appium/ruby_lib/blob/ad91ee47a96bf7a19b6f784dc760ac70b8788e5a/lib/appium_lib/driver.rb#L457)
484
+ ##### [restart](https://github.com/appium/ruby_lib/blob/54ff9c45df80ce901b718347e79e761f93a4316b/lib/appium_lib/driver.rb#L481)
452
485
 
453
486
  > def restart
454
487
 
@@ -460,7 +493,7 @@ __Returns:__
460
493
 
461
494
  --
462
495
 
463
- ##### [screenshot](https://github.com/appium/ruby_lib/blob/ad91ee47a96bf7a19b6f784dc760ac70b8788e5a/lib/appium_lib/driver.rb#L468)
496
+ ##### [screenshot](https://github.com/appium/ruby_lib/blob/54ff9c45df80ce901b718347e79e761f93a4316b/lib/appium_lib/driver.rb#L492)
464
497
 
465
498
  > def screenshot(png_save_path)
466
499
 
@@ -478,7 +511,7 @@ __Returns:__
478
511
 
479
512
  --
480
513
 
481
- ##### [driver_quit](https://github.com/appium/ruby_lib/blob/ad91ee47a96bf7a19b6f784dc760ac70b8788e5a/lib/appium_lib/driver.rb#L475)
514
+ ##### [driver_quit](https://github.com/appium/ruby_lib/blob/54ff9c45df80ce901b718347e79e761f93a4316b/lib/appium_lib/driver.rb#L499)
482
515
 
483
516
  > def driver_quit
484
517
 
@@ -490,7 +523,7 @@ __Returns:__
490
523
 
491
524
  --
492
525
 
493
- ##### [start_driver](https://github.com/appium/ruby_lib/blob/ad91ee47a96bf7a19b6f784dc760ac70b8788e5a/lib/appium_lib/driver.rb#L484)
526
+ ##### [start_driver](https://github.com/appium/ruby_lib/blob/54ff9c45df80ce901b718347e79e761f93a4316b/lib/appium_lib/driver.rb#L508)
494
527
 
495
528
  > def start_driver
496
529
 
@@ -502,7 +535,7 @@ __Returns:__
502
535
 
503
536
  --
504
537
 
505
- ##### [no_wait](https://github.com/appium/ruby_lib/blob/ad91ee47a96bf7a19b6f784dc760ac70b8788e5a/lib/appium_lib/driver.rb#L517)
538
+ ##### [no_wait](https://github.com/appium/ruby_lib/blob/54ff9c45df80ce901b718347e79e761f93a4316b/lib/appium_lib/driver.rb#L545)
506
539
 
507
540
  > def no_wait
508
541
 
@@ -510,7 +543,7 @@ Set implicit wait and default_wait to zero.
510
543
 
511
544
  --
512
545
 
513
- ##### [set_wait](https://github.com/appium/ruby_lib/blob/ad91ee47a96bf7a19b6f784dc760ac70b8788e5a/lib/appium_lib/driver.rb#L536)
546
+ ##### [set_wait](https://github.com/appium/ruby_lib/blob/54ff9c45df80ce901b718347e79e761f93a4316b/lib/appium_lib/driver.rb#L564)
514
547
 
515
548
  > def set_wait(timeout = nil)
516
549
 
@@ -535,7 +568,7 @@ __Returns:__
535
568
 
536
569
  --
537
570
 
538
- ##### [exists](https://github.com/appium/ruby_lib/blob/ad91ee47a96bf7a19b6f784dc760ac70b8788e5a/lib/appium_lib/driver.rb#L563)
571
+ ##### [exists](https://github.com/appium/ruby_lib/blob/54ff9c45df80ce901b718347e79e761f93a4316b/lib/appium_lib/driver.rb#L591)
539
572
 
540
573
  > def exists(pre_check = 0, post_check = @default_wait, &search_block)
541
574
 
@@ -561,7 +594,7 @@ __Returns:__
561
594
 
562
595
  --
563
596
 
564
- ##### [execute_script](https://github.com/appium/ruby_lib/blob/ad91ee47a96bf7a19b6f784dc760ac70b8788e5a/lib/appium_lib/driver.rb#L587)
597
+ ##### [execute_script](https://github.com/appium/ruby_lib/blob/54ff9c45df80ce901b718347e79e761f93a4316b/lib/appium_lib/driver.rb#L615)
565
598
 
566
599
  > def execute_script(script, *args)
567
600
 
@@ -579,7 +612,7 @@ __Returns:__
579
612
 
580
613
  --
581
614
 
582
- ##### [find_elements](https://github.com/appium/ruby_lib/blob/ad91ee47a96bf7a19b6f784dc760ac70b8788e5a/lib/appium_lib/driver.rb#L595)
615
+ ##### [find_elements](https://github.com/appium/ruby_lib/blob/54ff9c45df80ce901b718347e79e761f93a4316b/lib/appium_lib/driver.rb#L623)
583
616
 
584
617
  > def find_elements(*args)
585
618
 
@@ -595,7 +628,7 @@ __Returns:__
595
628
 
596
629
  --
597
630
 
598
- ##### [find_element](https://github.com/appium/ruby_lib/blob/ad91ee47a96bf7a19b6f784dc760ac70b8788e5a/lib/appium_lib/driver.rb#L603)
631
+ ##### [find_element](https://github.com/appium/ruby_lib/blob/54ff9c45df80ce901b718347e79e761f93a4316b/lib/appium_lib/driver.rb#L631)
599
632
 
600
633
  > def find_element(*args)
601
634
 
@@ -611,7 +644,7 @@ __Returns:__
611
644
 
612
645
  --
613
646
 
614
- ##### [set_location](https://github.com/appium/ruby_lib/blob/ad91ee47a96bf7a19b6f784dc760ac70b8788e5a/lib/appium_lib/driver.rb#L616)
647
+ ##### [set_location](https://github.com/appium/ruby_lib/blob/54ff9c45df80ce901b718347e79e761f93a4316b/lib/appium_lib/driver.rb#L644)
615
648
 
616
649
  > def set_location(opts = {})
617
650
 
@@ -627,7 +660,7 @@ __Returns:__
627
660
 
628
661
  --
629
662
 
630
- ##### [x](https://github.com/appium/ruby_lib/blob/ad91ee47a96bf7a19b6f784dc760ac70b8788e5a/lib/appium_lib/driver.rb#L626)
663
+ ##### [x](https://github.com/appium/ruby_lib/blob/54ff9c45df80ce901b718347e79e761f93a4316b/lib/appium_lib/driver.rb#L654)
631
664
 
632
665
  > def x
633
666
 
@@ -640,7 +673,7 @@ __Returns:__
640
673
 
641
674
  --
642
675
 
643
- ##### [logger=](https://github.com/appium/ruby_lib/blob/ad91ee47a96bf7a19b6f784dc760ac70b8788e5a/lib/appium_lib/logger.rb#L13)
676
+ ##### [logger=](https://github.com/appium/ruby_lib/blob/54ff9c45df80ce901b718347e79e761f93a4316b/lib/appium_lib/logger.rb#L13)
644
677
 
645
678
  > def logger=(value)
646
679
 
@@ -652,7 +685,7 @@ __Parameters:__
652
685
 
653
686
  --
654
687
 
655
- ##### [logger](https://github.com/appium/ruby_lib/blob/ad91ee47a96bf7a19b6f784dc760ac70b8788e5a/lib/appium_lib/logger.rb#L17)
688
+ ##### [logger](https://github.com/appium/ruby_lib/blob/54ff9c45df80ce901b718347e79e761f93a4316b/lib/appium_lib/logger.rb#L17)
656
689
 
657
690
  > def logger
658
691
 
@@ -660,7 +693,7 @@ __Parameters:__
660
693
 
661
694
  --
662
695
 
663
- ##### [NoArgMethods](https://github.com/appium/ruby_lib/blob/ad91ee47a96bf7a19b6f784dc760ac70b8788e5a/lib/appium_lib/device/device.rb#L7)
696
+ ##### [NoArgMethods](https://github.com/appium/ruby_lib/blob/54ff9c45df80ce901b718347e79e761f93a4316b/lib/appium_lib/device/device.rb#L7)
664
697
 
665
698
  > NoArgMethods = {
666
699
 
@@ -668,7 +701,7 @@ __Parameters:__
668
701
 
669
702
  --
670
703
 
671
- ##### [app_strings](https://github.com/appium/ruby_lib/blob/ad91ee47a96bf7a19b6f784dc760ac70b8788e5a/lib/appium_lib/device/device.rb#L25)
704
+ ##### [app_strings](https://github.com/appium/ruby_lib/blob/54ff9c45df80ce901b718347e79e761f93a4316b/lib/appium_lib/device/device.rb#L25)
672
705
 
673
706
  > def app_strings
674
707
 
@@ -679,7 +712,7 @@ app_strings #=> "TransitionsTitle"=>"Transitions", "WebTitle"=>"Web"
679
712
 
680
713
  --
681
714
 
682
- ##### [background_app](https://github.com/appium/ruby_lib/blob/ad91ee47a96bf7a19b6f784dc760ac70b8788e5a/lib/appium_lib/device/device.rb#L31)
715
+ ##### [background_app](https://github.com/appium/ruby_lib/blob/54ff9c45df80ce901b718347e79e761f93a4316b/lib/appium_lib/device/device.rb#L31)
683
716
 
684
717
  > def background_app
685
718
 
@@ -688,7 +721,7 @@ This is a blocking application
688
721
 
689
722
  --
690
723
 
691
- ##### [current_activity](https://github.com/appium/ruby_lib/blob/ad91ee47a96bf7a19b6f784dc760ac70b8788e5a/lib/appium_lib/device/device.rb#L36)
724
+ ##### [current_activity](https://github.com/appium/ruby_lib/blob/54ff9c45df80ce901b718347e79e761f93a4316b/lib/appium_lib/device/device.rb#L36)
692
725
 
693
726
  > def current_activity
694
727
 
@@ -696,7 +729,7 @@ This is a blocking application
696
729
 
697
730
  --
698
731
 
699
- ##### [launch_app](https://github.com/appium/ruby_lib/blob/ad91ee47a96bf7a19b6f784dc760ac70b8788e5a/lib/appium_lib/device/device.rb#L38)
732
+ ##### [launch_app](https://github.com/appium/ruby_lib/blob/54ff9c45df80ce901b718347e79e761f93a4316b/lib/appium_lib/device/device.rb#L38)
700
733
 
701
734
  > def launch_app
702
735
 
@@ -704,7 +737,7 @@ Start the simulator and application configured with desired capabilities
704
737
 
705
738
  --
706
739
 
707
- ##### [reset](https://github.com/appium/ruby_lib/blob/ad91ee47a96bf7a19b6f784dc760ac70b8788e5a/lib/appium_lib/device/device.rb#L41)
740
+ ##### [reset](https://github.com/appium/ruby_lib/blob/54ff9c45df80ce901b718347e79e761f93a4316b/lib/appium_lib/device/device.rb#L41)
708
741
 
709
742
  > def reset
710
743
 
@@ -712,7 +745,7 @@ Reset the device, relaunching the application.
712
745
 
713
746
  --
714
747
 
715
- ##### [shake](https://github.com/appium/ruby_lib/blob/ad91ee47a96bf7a19b6f784dc760ac70b8788e5a/lib/appium_lib/device/device.rb#L44)
748
+ ##### [shake](https://github.com/appium/ruby_lib/blob/54ff9c45df80ce901b718347e79e761f93a4316b/lib/appium_lib/device/device.rb#L44)
716
749
 
717
750
  > def shake
718
751
 
@@ -720,7 +753,7 @@ Cause the device to shake
720
753
 
721
754
  --
722
755
 
723
- ##### [toggle_flight_mode](https://github.com/appium/ruby_lib/blob/ad91ee47a96bf7a19b6f784dc760ac70b8788e5a/lib/appium_lib/device/device.rb#L47)
756
+ ##### [toggle_flight_mode](https://github.com/appium/ruby_lib/blob/54ff9c45df80ce901b718347e79e761f93a4316b/lib/appium_lib/device/device.rb#L47)
724
757
 
725
758
  > def toggle_flight_mode
726
759
 
@@ -728,7 +761,7 @@ Toggle flight mode on or off
728
761
 
729
762
  --
730
763
 
731
- ##### [device_locked?](https://github.com/appium/ruby_lib/blob/ad91ee47a96bf7a19b6f784dc760ac70b8788e5a/lib/appium_lib/device/device.rb#L50)
764
+ ##### [device_locked?](https://github.com/appium/ruby_lib/blob/54ff9c45df80ce901b718347e79e761f93a4316b/lib/appium_lib/device/device.rb#L50)
732
765
 
733
766
  > def device_locked?
734
767
 
@@ -736,7 +769,7 @@ Toggle flight mode on or off
736
769
 
737
770
  --
738
771
 
739
- ##### [hide_keyboard](https://github.com/appium/ruby_lib/blob/ad91ee47a96bf7a19b6f784dc760ac70b8788e5a/lib/appium_lib/device/device.rb#L52)
772
+ ##### [hide_keyboard](https://github.com/appium/ruby_lib/blob/54ff9c45df80ce901b718347e79e761f93a4316b/lib/appium_lib/device/device.rb#L52)
740
773
 
741
774
  > def hide_keyboard
742
775
 
@@ -749,7 +782,7 @@ Defaults to 'Done'.
749
782
 
750
783
  --
751
784
 
752
- ##### [press_keycode](https://github.com/appium/ruby_lib/blob/ad91ee47a96bf7a19b6f784dc760ac70b8788e5a/lib/appium_lib/device/device.rb#L61)
785
+ ##### [press_keycode](https://github.com/appium/ruby_lib/blob/54ff9c45df80ce901b718347e79e761f93a4316b/lib/appium_lib/device/device.rb#L61)
753
786
 
754
787
  > def press_keycode
755
788
 
@@ -764,7 +797,7 @@ __Parameters:__
764
797
 
765
798
  --
766
799
 
767
- ##### [long_press_keycode](https://github.com/appium/ruby_lib/blob/ad91ee47a96bf7a19b6f784dc760ac70b8788e5a/lib/appium_lib/device/device.rb#L67)
800
+ ##### [long_press_keycode](https://github.com/appium/ruby_lib/blob/54ff9c45df80ce901b718347e79e761f93a4316b/lib/appium_lib/device/device.rb#L67)
768
801
 
769
802
  > def long_press_keycode
770
803
 
@@ -779,7 +812,7 @@ __Parameters:__
779
812
 
780
813
  --
781
814
 
782
- ##### [push_file](https://github.com/appium/ruby_lib/blob/ad91ee47a96bf7a19b6f784dc760ac70b8788e5a/lib/appium_lib/device/device.rb#L73)
815
+ ##### [push_file](https://github.com/appium/ruby_lib/blob/54ff9c45df80ce901b718347e79e761f93a4316b/lib/appium_lib/device/device.rb#L73)
783
816
 
784
817
  > def push_file
785
818
 
@@ -793,7 +826,7 @@ __Parameters:__
793
826
 
794
827
  --
795
828
 
796
- ##### [pull_file](https://github.com/appium/ruby_lib/blob/ad91ee47a96bf7a19b6f784dc760ac70b8788e5a/lib/appium_lib/device/device.rb#L78)
829
+ ##### [pull_file](https://github.com/appium/ruby_lib/blob/54ff9c45df80ce901b718347e79e761f93a4316b/lib/appium_lib/device/device.rb#L78)
797
830
 
798
831
  > def pull_file
799
832
 
@@ -810,7 +843,7 @@ __Parameters:__
810
843
 
811
844
  --
812
845
 
813
- ##### [pull_folder](https://github.com/appium/ruby_lib/blob/ad91ee47a96bf7a19b6f784dc760ac70b8788e5a/lib/appium_lib/device/device.rb#L88)
846
+ ##### [pull_folder](https://github.com/appium/ruby_lib/blob/54ff9c45df80ce901b718347e79e761f93a4316b/lib/appium_lib/device/device.rb#L88)
814
847
 
815
848
  > def pull_folder
816
849
 
@@ -825,7 +858,7 @@ __Parameters:__
825
858
 
826
859
  --
827
860
 
828
- ##### [touch_id](https://github.com/appium/ruby_lib/blob/ad91ee47a96bf7a19b6f784dc760ac70b8788e5a/lib/appium_lib/device/device.rb#L96)
861
+ ##### [touch_id](https://github.com/appium/ruby_lib/blob/54ff9c45df80ce901b718347e79e761f93a4316b/lib/appium_lib/device/device.rb#L96)
829
862
 
830
863
  > def touch_id
831
864
 
@@ -842,7 +875,7 @@ Defaults to true.
842
875
 
843
876
  --
844
877
 
845
- ##### [end_coverage](https://github.com/appium/ruby_lib/blob/ad91ee47a96bf7a19b6f784dc760ac70b8788e5a/lib/appium_lib/device/device.rb#L105)
878
+ ##### [end_coverage](https://github.com/appium/ruby_lib/blob/54ff9c45df80ce901b718347e79e761f93a4316b/lib/appium_lib/device/device.rb#L105)
846
879
 
847
880
  > def end_coverage
848
881
 
@@ -856,7 +889,7 @@ __Parameters:__
856
889
 
857
890
  --
858
891
 
859
- ##### [get_settings](https://github.com/appium/ruby_lib/blob/ad91ee47a96bf7a19b6f784dc760ac70b8788e5a/lib/appium_lib/device/device.rb#L110)
892
+ ##### [get_settings](https://github.com/appium/ruby_lib/blob/54ff9c45df80ce901b718347e79e761f93a4316b/lib/appium_lib/device/device.rb#L110)
860
893
 
861
894
  > def get_settings
862
895
 
@@ -864,7 +897,7 @@ Get appium Settings for current test session
864
897
 
865
898
  --
866
899
 
867
- ##### [extend_search_contexts](https://github.com/appium/ruby_lib/blob/ad91ee47a96bf7a19b6f784dc760ac70b8788e5a/lib/appium_lib/device/device.rb#L394)
900
+ ##### [extend_search_contexts](https://github.com/appium/ruby_lib/blob/54ff9c45df80ce901b718347e79e761f93a4316b/lib/appium_lib/device/device.rb#L400)
868
901
 
869
902
  > def extend_search_contexts
870
903
 
@@ -872,7 +905,7 @@ Get appium Settings for current test session
872
905
 
873
906
  --
874
907
 
875
- ##### [find_element](https://github.com/appium/ruby_lib/blob/ad91ee47a96bf7a19b6f784dc760ac70b8788e5a/lib/appium_lib/device/device.rb#L394)
908
+ ##### [find_element](https://github.com/appium/ruby_lib/blob/54ff9c45df80ce901b718347e79e761f93a4316b/lib/appium_lib/device/device.rb#L400)
876
909
 
877
910
  > def find_element
878
911
 
@@ -880,7 +913,7 @@ Get appium Settings for current test session
880
913
 
881
914
  --
882
915
 
883
- ##### [find_elements](https://github.com/appium/ruby_lib/blob/ad91ee47a96bf7a19b6f784dc760ac70b8788e5a/lib/appium_lib/device/device.rb#L394)
916
+ ##### [find_elements](https://github.com/appium/ruby_lib/blob/54ff9c45df80ce901b718347e79e761f93a4316b/lib/appium_lib/device/device.rb#L400)
884
917
 
885
918
  > def find_elements
886
919
 
@@ -892,7 +925,7 @@ find_element/s with their accessibility_id
892
925
 
893
926
  --
894
927
 
895
- ##### [add_touch_actions](https://github.com/appium/ruby_lib/blob/ad91ee47a96bf7a19b6f784dc760ac70b8788e5a/lib/appium_lib/device/device.rb#L400)
928
+ ##### [add_touch_actions](https://github.com/appium/ruby_lib/blob/54ff9c45df80ce901b718347e79e761f93a4316b/lib/appium_lib/device/device.rb#L406)
896
929
 
897
930
  > def add_touch_actions
898
931
 
@@ -900,7 +933,7 @@ find_element/s with their accessibility_id
900
933
 
901
934
  --
902
935
 
903
- ##### [add_ime_actions](https://github.com/appium/ruby_lib/blob/ad91ee47a96bf7a19b6f784dc760ac70b8788e5a/lib/appium_lib/device/device.rb#L423)
936
+ ##### [add_ime_actions](https://github.com/appium/ruby_lib/blob/54ff9c45df80ce901b718347e79e761f93a4316b/lib/appium_lib/device/device.rb#L429)
904
937
 
905
938
  > def add_ime_actions
906
939
 
@@ -908,7 +941,7 @@ find_element/s with their accessibility_id
908
941
 
909
942
  --
910
943
 
911
- ##### [set_context](https://github.com/appium/ruby_lib/blob/ad91ee47a96bf7a19b6f784dc760ac70b8788e5a/lib/appium_lib/device/device.rb#L498)
944
+ ##### [set_context](https://github.com/appium/ruby_lib/blob/54ff9c45df80ce901b718347e79e761f93a4316b/lib/appium_lib/device/device.rb#L504)
912
945
 
913
946
  > def set_context
914
947
 
@@ -923,7 +956,7 @@ __Parameters:__
923
956
 
924
957
  --
925
958
 
926
- ##### [current_context](https://github.com/appium/ruby_lib/blob/ad91ee47a96bf7a19b6f784dc760ac70b8788e5a/lib/appium_lib/device/device.rb#L506)
959
+ ##### [current_context](https://github.com/appium/ruby_lib/blob/54ff9c45df80ce901b718347e79e761f93a4316b/lib/appium_lib/device/device.rb#L512)
927
960
 
928
961
  > def current_context
929
962
 
@@ -935,7 +968,7 @@ __Returns:__
935
968
 
936
969
  --
937
970
 
938
- ##### [available_contexts](https://github.com/appium/ruby_lib/blob/ad91ee47a96bf7a19b6f784dc760ac70b8788e5a/lib/appium_lib/device/device.rb#L509)
971
+ ##### [available_contexts](https://github.com/appium/ruby_lib/blob/54ff9c45df80ce901b718347e79e761f93a4316b/lib/appium_lib/device/device.rb#L515)
939
972
 
940
973
  > def available_contexts
941
974
 
@@ -947,7 +980,7 @@ __Returns:__
947
980
 
948
981
  --
949
982
 
950
- ##### [within_context](https://github.com/appium/ruby_lib/blob/ad91ee47a96bf7a19b6f784dc760ac70b8788e5a/lib/appium_lib/device/device.rb#L519)
983
+ ##### [within_context](https://github.com/appium/ruby_lib/blob/54ff9c45df80ce901b718347e79e761f93a4316b/lib/appium_lib/device/device.rb#L525)
951
984
 
952
985
  > def within_context(context)
953
986
 
@@ -963,7 +996,7 @@ __Parameters:__
963
996
 
964
997
  --
965
998
 
966
- ##### [switch_to_default_context](https://github.com/appium/ruby_lib/blob/ad91ee47a96bf7a19b6f784dc760ac70b8788e5a/lib/appium_lib/device/device.rb#L527)
999
+ ##### [switch_to_default_context](https://github.com/appium/ruby_lib/blob/54ff9c45df80ce901b718347e79e761f93a4316b/lib/appium_lib/device/device.rb#L533)
967
1000
 
968
1001
  > def switch_to_default_context
969
1002
 
@@ -971,7 +1004,7 @@ Change to the default context. This is equivalent to `set_context nil`.
971
1004
 
972
1005
  --
973
1006
 
974
- ##### [pinch](https://github.com/appium/ruby_lib/blob/ad91ee47a96bf7a19b6f784dc760ac70b8788e5a/lib/appium_lib/device/multi_touch.rb#L28)
1007
+ ##### [pinch](https://github.com/appium/ruby_lib/blob/54ff9c45df80ce901b718347e79e761f93a4316b/lib/appium_lib/device/multi_touch.rb#L28)
975
1008
 
976
1009
  > def pinch(percentage = 25, auto_perform = true)
977
1010
 
@@ -990,7 +1023,7 @@ __Parameters:__
990
1023
 
991
1024
  --
992
1025
 
993
- ##### [zoom](https://github.com/appium/ruby_lib/blob/ad91ee47a96bf7a19b6f784dc760ac70b8788e5a/lib/appium_lib/device/multi_touch.rb#L56)
1026
+ ##### [zoom](https://github.com/appium/ruby_lib/blob/54ff9c45df80ce901b718347e79e761f93a4316b/lib/appium_lib/device/multi_touch.rb#L64)
994
1027
 
995
1028
  > def zoom(percentage = 200, auto_perform = true)
996
1029
 
@@ -1009,7 +1042,7 @@ __Parameters:__
1009
1042
 
1010
1043
  --
1011
1044
 
1012
- ##### [initialize](https://github.com/appium/ruby_lib/blob/ad91ee47a96bf7a19b6f784dc760ac70b8788e5a/lib/appium_lib/device/multi_touch.rb#L77)
1045
+ ##### [initialize](https://github.com/appium/ruby_lib/blob/54ff9c45df80ce901b718347e79e761f93a4316b/lib/appium_lib/device/multi_touch.rb#L95)
1013
1046
 
1014
1047
  > def initialize
1015
1048
 
@@ -1021,7 +1054,7 @@ __Returns:__
1021
1054
 
1022
1055
  --
1023
1056
 
1024
- ##### [add](https://github.com/appium/ruby_lib/blob/ad91ee47a96bf7a19b6f784dc760ac70b8788e5a/lib/appium_lib/device/multi_touch.rb#L83)
1057
+ ##### [add](https://github.com/appium/ruby_lib/blob/54ff9c45df80ce901b718347e79e761f93a4316b/lib/appium_lib/device/multi_touch.rb#L101)
1025
1058
 
1026
1059
  > def add(chain)
1027
1060
 
@@ -1033,7 +1066,7 @@ __Parameters:__
1033
1066
 
1034
1067
  --
1035
1068
 
1036
- ##### [perform](https://github.com/appium/ruby_lib/blob/ad91ee47a96bf7a19b6f784dc760ac70b8788e5a/lib/appium_lib/device/multi_touch.rb#L88)
1069
+ ##### [perform](https://github.com/appium/ruby_lib/blob/54ff9c45df80ce901b718347e79e761f93a4316b/lib/appium_lib/device/multi_touch.rb#L106)
1037
1070
 
1038
1071
  > def perform
1039
1072
 
@@ -1041,7 +1074,7 @@ Ask Appium to perform the actions
1041
1074
 
1042
1075
  --
1043
1076
 
1044
- ##### [ACTIONS](https://github.com/appium/ruby_lib/blob/ad91ee47a96bf7a19b6f784dc760ac70b8788e5a/lib/appium_lib/device/touch_actions.rb#L11)
1077
+ ##### [ACTIONS](https://github.com/appium/ruby_lib/blob/54ff9c45df80ce901b718347e79e761f93a4316b/lib/appium_lib/device/touch_actions.rb#L11)
1045
1078
 
1046
1079
  > ACTIONS = [:move_to, :long_press, :double_tap, :two_finger_tap, :press, :release, :tap, :wait, :perform]
1047
1080
 
@@ -1049,7 +1082,7 @@ Ask Appium to perform the actions
1049
1082
 
1050
1083
  --
1051
1084
 
1052
- ##### [COMPLEX_ACTIONS](https://github.com/appium/ruby_lib/blob/ad91ee47a96bf7a19b6f784dc760ac70b8788e5a/lib/appium_lib/device/touch_actions.rb#L12)
1085
+ ##### [COMPLEX_ACTIONS](https://github.com/appium/ruby_lib/blob/54ff9c45df80ce901b718347e79e761f93a4316b/lib/appium_lib/device/touch_actions.rb#L12)
1053
1086
 
1054
1087
  > COMPLEX_ACTIONS = [:swipe]
1055
1088
 
@@ -1057,7 +1090,7 @@ Ask Appium to perform the actions
1057
1090
 
1058
1091
  --
1059
1092
 
1060
- ##### [actions](https://github.com/appium/ruby_lib/blob/ad91ee47a96bf7a19b6f784dc760ac70b8788e5a/lib/appium_lib/device/touch_actions.rb#L26)
1093
+ ##### [actions](https://github.com/appium/ruby_lib/blob/54ff9c45df80ce901b718347e79e761f93a4316b/lib/appium_lib/device/touch_actions.rb#L26)
1061
1094
 
1062
1095
  > def actions
1063
1096
 
@@ -1065,7 +1098,7 @@ Returns the value of attribute actions
1065
1098
 
1066
1099
  --
1067
1100
 
1068
- ##### [initialize](https://github.com/appium/ruby_lib/blob/ad91ee47a96bf7a19b6f784dc760ac70b8788e5a/lib/appium_lib/device/touch_actions.rb#L28)
1101
+ ##### [initialize](https://github.com/appium/ruby_lib/blob/54ff9c45df80ce901b718347e79e761f93a4316b/lib/appium_lib/device/touch_actions.rb#L28)
1069
1102
 
1070
1103
  > def initialize
1071
1104
 
@@ -1077,7 +1110,7 @@ __Returns:__
1077
1110
 
1078
1111
  --
1079
1112
 
1080
- ##### [move_to](https://github.com/appium/ruby_lib/blob/ad91ee47a96bf7a19b6f784dc760ac70b8788e5a/lib/appium_lib/device/touch_actions.rb#L36)
1113
+ ##### [move_to](https://github.com/appium/ruby_lib/blob/54ff9c45df80ce901b718347e79e761f93a4316b/lib/appium_lib/device/touch_actions.rb#L36)
1081
1114
 
1082
1115
  > def move_to(opts)
1083
1116
 
@@ -1089,7 +1122,7 @@ __Parameters:__
1089
1122
 
1090
1123
  --
1091
1124
 
1092
- ##### [long_press](https://github.com/appium/ruby_lib/blob/ad91ee47a96bf7a19b6f784dc760ac70b8788e5a/lib/appium_lib/device/touch_actions.rb#L46)
1125
+ ##### [long_press](https://github.com/appium/ruby_lib/blob/54ff9c45df80ce901b718347e79e761f93a4316b/lib/appium_lib/device/touch_actions.rb#L46)
1093
1126
 
1094
1127
  > def long_press(opts)
1095
1128
 
@@ -1107,7 +1140,7 @@ __Parameters:__
1107
1140
 
1108
1141
  --
1109
1142
 
1110
- ##### [press](https://github.com/appium/ruby_lib/blob/ad91ee47a96bf7a19b6f784dc760ac70b8788e5a/lib/appium_lib/device/touch_actions.rb#L58)
1143
+ ##### [press](https://github.com/appium/ruby_lib/blob/54ff9c45df80ce901b718347e79e761f93a4316b/lib/appium_lib/device/touch_actions.rb#L58)
1111
1144
 
1112
1145
  > def press(opts)
1113
1146
 
@@ -1120,7 +1153,7 @@ __Parameters:__
1120
1153
 
1121
1154
  --
1122
1155
 
1123
- ##### [release](https://github.com/appium/ruby_lib/blob/ad91ee47a96bf7a19b6f784dc760ac70b8788e5a/lib/appium_lib/device/touch_actions.rb#L69)
1156
+ ##### [release](https://github.com/appium/ruby_lib/blob/54ff9c45df80ce901b718347e79e761f93a4316b/lib/appium_lib/device/touch_actions.rb#L69)
1124
1157
 
1125
1158
  > def release(opts = nil)
1126
1159
 
@@ -1132,7 +1165,7 @@ __Parameters:__
1132
1165
 
1133
1166
  --
1134
1167
 
1135
- ##### [tap](https://github.com/appium/ruby_lib/blob/ad91ee47a96bf7a19b6f784dc760ac70b8788e5a/lib/appium_lib/device/touch_actions.rb#L80)
1168
+ ##### [tap](https://github.com/appium/ruby_lib/blob/54ff9c45df80ce901b718347e79e761f93a4316b/lib/appium_lib/device/touch_actions.rb#L80)
1136
1169
 
1137
1170
  > def tap(opts)
1138
1171
 
@@ -1144,7 +1177,7 @@ __Parameters:__
1144
1177
 
1145
1178
  --
1146
1179
 
1147
- ##### [double_tap](https://github.com/appium/ruby_lib/blob/ad91ee47a96bf7a19b6f784dc760ac70b8788e5a/lib/appium_lib/device/touch_actions.rb#L93)
1180
+ ##### [double_tap](https://github.com/appium/ruby_lib/blob/54ff9c45df80ce901b718347e79e761f93a4316b/lib/appium_lib/device/touch_actions.rb#L93)
1148
1181
 
1149
1182
  > def double_tap(opts)
1150
1183
 
@@ -1156,7 +1189,7 @@ __Parameters:__
1156
1189
 
1157
1190
  --
1158
1191
 
1159
- ##### [two_finger_tap](https://github.com/appium/ruby_lib/blob/ad91ee47a96bf7a19b6f784dc760ac70b8788e5a/lib/appium_lib/device/touch_actions.rb#L104)
1192
+ ##### [two_finger_tap](https://github.com/appium/ruby_lib/blob/54ff9c45df80ce901b718347e79e761f93a4316b/lib/appium_lib/device/touch_actions.rb#L104)
1160
1193
 
1161
1194
  > def two_finger_tap(opts)
1162
1195
 
@@ -1168,7 +1201,7 @@ __Parameters:__
1168
1201
 
1169
1202
  --
1170
1203
 
1171
- ##### [wait](https://github.com/appium/ruby_lib/blob/ad91ee47a96bf7a19b6f784dc760ac70b8788e5a/lib/appium_lib/device/touch_actions.rb#L112)
1204
+ ##### [wait](https://github.com/appium/ruby_lib/blob/54ff9c45df80ce901b718347e79e761f93a4316b/lib/appium_lib/device/touch_actions.rb#L112)
1172
1205
 
1173
1206
  > def wait(milliseconds)
1174
1207
 
@@ -1180,9 +1213,9 @@ __Parameters:__
1180
1213
 
1181
1214
  --
1182
1215
 
1183
- ##### [swipe](https://github.com/appium/ruby_lib/blob/ad91ee47a96bf7a19b6f784dc760ac70b8788e5a/lib/appium_lib/device/touch_actions.rb#L127)
1216
+ ##### [swipe](https://github.com/appium/ruby_lib/blob/54ff9c45df80ce901b718347e79e761f93a4316b/lib/appium_lib/device/touch_actions.rb#L127)
1184
1217
 
1185
- > def swipe(opts)
1218
+ > def swipe(opts, ele = nil)
1186
1219
 
1187
1220
  Convenience method to peform a swipe.
1188
1221
 
@@ -1194,7 +1227,7 @@ __Parameters:__
1194
1227
 
1195
1228
  --
1196
1229
 
1197
- ##### [perform](https://github.com/appium/ruby_lib/blob/ad91ee47a96bf7a19b6f784dc760ac70b8788e5a/lib/appium_lib/device/touch_actions.rb#L155)
1230
+ ##### [perform](https://github.com/appium/ruby_lib/blob/54ff9c45df80ce901b718347e79e761f93a4316b/lib/appium_lib/device/touch_actions.rb#L162)
1198
1231
 
1199
1232
  > def perform
1200
1233
 
@@ -1202,7 +1235,7 @@ Ask the driver to perform all actions in this action chain.
1202
1235
 
1203
1236
  --
1204
1237
 
1205
- ##### [cancel](https://github.com/appium/ruby_lib/blob/ad91ee47a96bf7a19b6f784dc760ac70b8788e5a/lib/appium_lib/device/touch_actions.rb#L161)
1238
+ ##### [cancel](https://github.com/appium/ruby_lib/blob/54ff9c45df80ce901b718347e79e761f93a4316b/lib/appium_lib/device/touch_actions.rb#L168)
1206
1239
 
1207
1240
  > def cancel
1208
1241
 
@@ -1210,7 +1243,7 @@ Does nothing, currently.
1210
1243
 
1211
1244
  --
1212
1245
 
1213
- ##### [chain_method](https://github.com/appium/ruby_lib/blob/ad91ee47a96bf7a19b6f784dc760ac70b8788e5a/lib/appium_lib/device/touch_actions.rb#L169)
1246
+ ##### [chain_method](https://github.com/appium/ruby_lib/blob/54ff9c45df80ce901b718347e79e761f93a4316b/lib/appium_lib/device/touch_actions.rb#L176)
1214
1247
 
1215
1248
  > def chain_method(method, args = nil)
1216
1249
 
@@ -1218,7 +1251,7 @@ Does nothing, currently.
1218
1251
 
1219
1252
  --
1220
1253
 
1221
- ##### [args_with_ele_ref](https://github.com/appium/ruby_lib/blob/ad91ee47a96bf7a19b6f784dc760ac70b8788e5a/lib/appium_lib/device/touch_actions.rb#L178)
1254
+ ##### [args_with_ele_ref](https://github.com/appium/ruby_lib/blob/54ff9c45df80ce901b718347e79e761f93a4316b/lib/appium_lib/device/touch_actions.rb#L185)
1222
1255
 
1223
1256
  > def args_with_ele_ref(args)
1224
1257
 
@@ -1226,7 +1259,7 @@ Does nothing, currently.
1226
1259
 
1227
1260
  --
1228
1261
 
1229
- ##### [_generic_wait](https://github.com/appium/ruby_lib/blob/ad91ee47a96bf7a19b6f784dc760ac70b8788e5a/lib/appium_lib/common/wait.rb#L9)
1262
+ ##### [_generic_wait](https://github.com/appium/ruby_lib/blob/54ff9c45df80ce901b718347e79e761f93a4316b/lib/appium_lib/common/wait.rb#L9)
1230
1263
 
1231
1264
  > def _generic_wait(opts = {}, &block)
1232
1265
 
@@ -1235,7 +1268,7 @@ https://github.com/SeleniumHQ/selenium/blob/cf501dda3f0ed12233de51ce8170c0e8090f
1235
1268
 
1236
1269
  --
1237
1270
 
1238
- ##### [_process_wait_opts](https://github.com/appium/ruby_lib/blob/ad91ee47a96bf7a19b6f784dc760ac70b8788e5a/lib/appium_lib/common/wait.rb#L54)
1271
+ ##### [_process_wait_opts](https://github.com/appium/ruby_lib/blob/54ff9c45df80ce901b718347e79e761f93a4316b/lib/appium_lib/common/wait.rb#L54)
1239
1272
 
1240
1273
  > def _process_wait_opts(opts)
1241
1274
 
@@ -1243,7 +1276,7 @@ process opts before calling _generic_wait
1243
1276
 
1244
1277
  --
1245
1278
 
1246
- ##### [wait_true](https://github.com/appium/ruby_lib/blob/ad91ee47a96bf7a19b6f784dc760ac70b8788e5a/lib/appium_lib/common/wait.rb#L75)
1279
+ ##### [wait_true](https://github.com/appium/ruby_lib/blob/54ff9c45df80ce901b718347e79e761f93a4316b/lib/appium_lib/common/wait.rb#L75)
1247
1280
 
1248
1281
  > def wait_true(opts = {}, &block)
1249
1282
 
@@ -1263,7 +1296,7 @@ __Parameters:__
1263
1296
 
1264
1297
  --
1265
1298
 
1266
- ##### [wait](https://github.com/appium/ruby_lib/blob/ad91ee47a96bf7a19b6f784dc760ac70b8788e5a/lib/appium_lib/common/wait.rb#L93)
1299
+ ##### [wait](https://github.com/appium/ruby_lib/blob/54ff9c45df80ce901b718347e79e761f93a4316b/lib/appium_lib/common/wait.rb#L93)
1267
1300
 
1268
1301
  > def wait(opts = {}, &block)
1269
1302
 
@@ -1281,7 +1314,7 @@ __Parameters:__
1281
1314
 
1282
1315
  --
1283
1316
 
1284
- ##### [ignore](https://github.com/appium/ruby_lib/blob/ad91ee47a96bf7a19b6f784dc760ac70b8788e5a/lib/appium_lib/common/helper.rb#L24)
1317
+ ##### [ignore](https://github.com/appium/ruby_lib/blob/54ff9c45df80ce901b718347e79e761f93a4316b/lib/appium_lib/common/helper.rb#L24)
1285
1318
 
1286
1319
  > def ignore(&block)
1287
1320
 
@@ -1289,7 +1322,7 @@ Return block.call and ignore any exceptions.
1289
1322
 
1290
1323
  --
1291
1324
 
1292
- ##### [back](https://github.com/appium/ruby_lib/blob/ad91ee47a96bf7a19b6f784dc760ac70b8788e5a/lib/appium_lib/common/helper.rb#L31)
1325
+ ##### [back](https://github.com/appium/ruby_lib/blob/54ff9c45df80ce901b718347e79e761f93a4316b/lib/appium_lib/common/helper.rb#L31)
1293
1326
 
1294
1327
  > def back
1295
1328
 
@@ -1301,7 +1334,7 @@ __Returns:__
1301
1334
 
1302
1335
  --
1303
1336
 
1304
- ##### [session_id](https://github.com/appium/ruby_lib/blob/ad91ee47a96bf7a19b6f784dc760ac70b8788e5a/lib/appium_lib/common/helper.rb#L36)
1337
+ ##### [session_id](https://github.com/appium/ruby_lib/blob/54ff9c45df80ce901b718347e79e761f93a4316b/lib/appium_lib/common/helper.rb#L36)
1305
1338
 
1306
1339
  > def session_id
1307
1340
 
@@ -1309,7 +1342,7 @@ For Sauce Labs reporting. Returns the current session id.
1309
1342
 
1310
1343
  --
1311
1344
 
1312
- ##### [xpath](https://github.com/appium/ruby_lib/blob/ad91ee47a96bf7a19b6f784dc760ac70b8788e5a/lib/appium_lib/common/helper.rb#L44)
1345
+ ##### [xpath](https://github.com/appium/ruby_lib/blob/54ff9c45df80ce901b718347e79e761f93a4316b/lib/appium_lib/common/helper.rb#L44)
1313
1346
 
1314
1347
  > def xpath(xpath_str)
1315
1348
 
@@ -1325,7 +1358,7 @@ __Returns:__
1325
1358
 
1326
1359
  --
1327
1360
 
1328
- ##### [xpaths](https://github.com/appium/ruby_lib/blob/ad91ee47a96bf7a19b6f784dc760ac70b8788e5a/lib/appium_lib/common/helper.rb#L52)
1361
+ ##### [xpaths](https://github.com/appium/ruby_lib/blob/54ff9c45df80ce901b718347e79e761f93a4316b/lib/appium_lib/common/helper.rb#L52)
1329
1362
 
1330
1363
  > def xpaths(xpath_str)
1331
1364
 
@@ -1341,7 +1374,7 @@ __Returns:__
1341
1374
 
1342
1375
  --
1343
1376
 
1344
- ##### [_print_source](https://github.com/appium/ruby_lib/blob/ad91ee47a96bf7a19b6f784dc760ac70b8788e5a/lib/appium_lib/common/helper.rb#L56)
1377
+ ##### [_print_source](https://github.com/appium/ruby_lib/blob/54ff9c45df80ce901b718347e79e761f93a4316b/lib/appium_lib/common/helper.rb#L56)
1345
1378
 
1346
1379
  > def _print_source(source)
1347
1380
 
@@ -1349,7 +1382,7 @@ __Returns:__
1349
1382
 
1350
1383
  --
1351
1384
 
1352
- ##### [result](https://github.com/appium/ruby_lib/blob/ad91ee47a96bf7a19b6f784dc760ac70b8788e5a/lib/appium_lib/common/helper.rb#L69)
1385
+ ##### [result](https://github.com/appium/ruby_lib/blob/54ff9c45df80ce901b718347e79e761f93a4316b/lib/appium_lib/common/helper.rb#L69)
1353
1386
 
1354
1387
  > def result
1355
1388
 
@@ -1357,7 +1390,7 @@ Returns the value of attribute result
1357
1390
 
1358
1391
  --
1359
1392
 
1360
- ##### [initialize](https://github.com/appium/ruby_lib/blob/ad91ee47a96bf7a19b6f784dc760ac70b8788e5a/lib/appium_lib/common/helper.rb#L71)
1393
+ ##### [initialize](https://github.com/appium/ruby_lib/blob/54ff9c45df80ce901b718347e79e761f93a4316b/lib/appium_lib/common/helper.rb#L71)
1361
1394
 
1362
1395
  > def initialize
1363
1396
 
@@ -1369,7 +1402,7 @@ __Returns:__
1369
1402
 
1370
1403
  --
1371
1404
 
1372
- ##### [reset](https://github.com/appium/ruby_lib/blob/ad91ee47a96bf7a19b6f784dc760ac70b8788e5a/lib/appium_lib/common/helper.rb#L75)
1405
+ ##### [reset](https://github.com/appium/ruby_lib/blob/54ff9c45df80ce901b718347e79e761f93a4316b/lib/appium_lib/common/helper.rb#L75)
1373
1406
 
1374
1407
  > def reset
1375
1408
 
@@ -1377,7 +1410,7 @@ __Returns:__
1377
1410
 
1378
1411
  --
1379
1412
 
1380
- ##### [start_element](https://github.com/appium/ruby_lib/blob/ad91ee47a96bf7a19b6f784dc760ac70b8788e5a/lib/appium_lib/common/helper.rb#L80)
1413
+ ##### [start_element](https://github.com/appium/ruby_lib/blob/54ff9c45df80ce901b718347e79e761f93a4316b/lib/appium_lib/common/helper.rb#L80)
1381
1414
 
1382
1415
  > def start_element(name, attrs = [])
1383
1416
 
@@ -1385,7 +1418,7 @@ http://nokogiri.org/Nokogiri/XML/SAX/Document.html
1385
1418
 
1386
1419
  --
1387
1420
 
1388
- ##### [formatted_result](https://github.com/appium/ruby_lib/blob/ad91ee47a96bf7a19b6f784dc760ac70b8788e5a/lib/appium_lib/common/helper.rb#L86)
1421
+ ##### [formatted_result](https://github.com/appium/ruby_lib/blob/54ff9c45df80ce901b718347e79e761f93a4316b/lib/appium_lib/common/helper.rb#L86)
1389
1422
 
1390
1423
  > def formatted_result
1391
1424
 
@@ -1393,7 +1426,7 @@ http://nokogiri.org/Nokogiri/XML/SAX/Document.html
1393
1426
 
1394
1427
  --
1395
1428
 
1396
- ##### [get_page_class](https://github.com/appium/ruby_lib/blob/ad91ee47a96bf7a19b6f784dc760ac70b8788e5a/lib/appium_lib/common/helper.rb#L97)
1429
+ ##### [get_page_class](https://github.com/appium/ruby_lib/blob/54ff9c45df80ce901b718347e79e761f93a4316b/lib/appium_lib/common/helper.rb#L97)
1397
1430
 
1398
1431
  > def get_page_class
1399
1432
 
@@ -1401,7 +1434,7 @@ Returns a string of class counts of visible elements.
1401
1434
 
1402
1435
  --
1403
1436
 
1404
- ##### [page_class](https://github.com/appium/ruby_lib/blob/ad91ee47a96bf7a19b6f784dc760ac70b8788e5a/lib/appium_lib/common/helper.rb#L108)
1437
+ ##### [page_class](https://github.com/appium/ruby_lib/blob/54ff9c45df80ce901b718347e79e761f93a4316b/lib/appium_lib/common/helper.rb#L108)
1405
1438
 
1406
1439
  > def page_class
1407
1440
 
@@ -1410,7 +1443,7 @@ Useful for appium_console.
1410
1443
 
1411
1444
  --
1412
1445
 
1413
- ##### [px_to_window_rel](https://github.com/appium/ruby_lib/blob/ad91ee47a96bf7a19b6f784dc760ac70b8788e5a/lib/appium_lib/common/helper.rb#L118)
1446
+ ##### [px_to_window_rel](https://github.com/appium/ruby_lib/blob/54ff9c45df80ce901b718347e79e761f93a4316b/lib/appium_lib/common/helper.rb#L118)
1414
1447
 
1415
1448
  > def px_to_window_rel(opts = {})
1416
1449
 
@@ -1422,7 +1455,7 @@ px_to_window_rel x: 50, y: 150
1422
1455
 
1423
1456
  --
1424
1457
 
1425
- ##### [xml_keys](https://github.com/appium/ruby_lib/blob/ad91ee47a96bf7a19b6f784dc760ac70b8788e5a/lib/appium_lib/common/helper.rb#L137)
1458
+ ##### [xml_keys](https://github.com/appium/ruby_lib/blob/54ff9c45df80ce901b718347e79e761f93a4316b/lib/appium_lib/common/helper.rb#L137)
1426
1459
 
1427
1460
  > def xml_keys(target)
1428
1461
 
@@ -1438,7 +1471,7 @@ __Returns:__
1438
1471
 
1439
1472
  --
1440
1473
 
1441
- ##### [xml_values](https://github.com/appium/ruby_lib/blob/ad91ee47a96bf7a19b6f784dc760ac70b8788e5a/lib/appium_lib/common/helper.rb#L145)
1474
+ ##### [xml_values](https://github.com/appium/ruby_lib/blob/54ff9c45df80ce901b718347e79e761f93a4316b/lib/appium_lib/common/helper.rb#L145)
1442
1475
 
1443
1476
  > def xml_values(target)
1444
1477
 
@@ -1454,7 +1487,7 @@ __Returns:__
1454
1487
 
1455
1488
  --
1456
1489
 
1457
- ##### [resolve_id](https://github.com/appium/ruby_lib/blob/ad91ee47a96bf7a19b6f784dc760ac70b8788e5a/lib/appium_lib/common/helper.rb#L153)
1490
+ ##### [resolve_id](https://github.com/appium/ruby_lib/blob/54ff9c45df80ce901b718347e79e761f93a4316b/lib/appium_lib/common/helper.rb#L153)
1458
1491
 
1459
1492
  > def resolve_id(id)
1460
1493
 
@@ -1470,7 +1503,7 @@ __Returns:__
1470
1503
 
1471
1504
  --
1472
1505
 
1473
- ##### [filter](https://github.com/appium/ruby_lib/blob/ad91ee47a96bf7a19b6f784dc760ac70b8788e5a/lib/appium_lib/common/helper.rb#L159)
1506
+ ##### [filter](https://github.com/appium/ruby_lib/blob/54ff9c45df80ce901b718347e79e761f93a4316b/lib/appium_lib/common/helper.rb#L159)
1474
1507
 
1475
1508
  > def filter
1476
1509
 
@@ -1478,7 +1511,7 @@ Returns the value of attribute filter
1478
1511
 
1479
1512
  --
1480
1513
 
1481
- ##### [filter=](https://github.com/appium/ruby_lib/blob/ad91ee47a96bf7a19b6f784dc760ac70b8788e5a/lib/appium_lib/common/helper.rb#L162)
1514
+ ##### [filter=](https://github.com/appium/ruby_lib/blob/54ff9c45df80ce901b718347e79e761f93a4316b/lib/appium_lib/common/helper.rb#L162)
1482
1515
 
1483
1516
  > def filter=(value)
1484
1517
 
@@ -1486,7 +1519,7 @@ convert to string to support symbols
1486
1519
 
1487
1520
  --
1488
1521
 
1489
- ##### [initialize](https://github.com/appium/ruby_lib/blob/ad91ee47a96bf7a19b6f784dc760ac70b8788e5a/lib/appium_lib/common/helper.rb#L168)
1522
+ ##### [initialize](https://github.com/appium/ruby_lib/blob/54ff9c45df80ce901b718347e79e761f93a4316b/lib/appium_lib/common/helper.rb#L168)
1490
1523
 
1491
1524
  > def initialize
1492
1525
 
@@ -1498,7 +1531,7 @@ __Returns:__
1498
1531
 
1499
1532
  --
1500
1533
 
1501
- ##### [reset](https://github.com/appium/ruby_lib/blob/ad91ee47a96bf7a19b6f784dc760ac70b8788e5a/lib/appium_lib/common/helper.rb#L173)
1534
+ ##### [reset](https://github.com/appium/ruby_lib/blob/54ff9c45df80ce901b718347e79e761f93a4316b/lib/appium_lib/common/helper.rb#L173)
1502
1535
 
1503
1536
  > def reset
1504
1537
 
@@ -1506,7 +1539,7 @@ __Returns:__
1506
1539
 
1507
1540
  --
1508
1541
 
1509
- ##### [result](https://github.com/appium/ruby_lib/blob/ad91ee47a96bf7a19b6f784dc760ac70b8788e5a/lib/appium_lib/common/helper.rb#L179)
1542
+ ##### [result](https://github.com/appium/ruby_lib/blob/54ff9c45df80ce901b718347e79e761f93a4316b/lib/appium_lib/common/helper.rb#L179)
1510
1543
 
1511
1544
  > def result
1512
1545
 
@@ -1514,7 +1547,7 @@ __Returns:__
1514
1547
 
1515
1548
  --
1516
1549
 
1517
- ##### [start_element](https://github.com/appium/ruby_lib/blob/ad91ee47a96bf7a19b6f784dc760ac70b8788e5a/lib/appium_lib/common/helper.rb#L195)
1550
+ ##### [start_element](https://github.com/appium/ruby_lib/blob/54ff9c45df80ce901b718347e79e761f93a4316b/lib/appium_lib/common/helper.rb#L195)
1518
1551
 
1519
1552
  > def start_element(name, attrs = [])
1520
1553
 
@@ -1522,7 +1555,7 @@ __Returns:__
1522
1555
 
1523
1556
  --
1524
1557
 
1525
- ##### [end_element](https://github.com/appium/ruby_lib/blob/ad91ee47a96bf7a19b6f784dc760ac70b8788e5a/lib/appium_lib/common/helper.rb#L204)
1558
+ ##### [end_element](https://github.com/appium/ruby_lib/blob/54ff9c45df80ce901b718347e79e761f93a4316b/lib/appium_lib/common/helper.rb#L204)
1526
1559
 
1527
1560
  > def end_element(name)
1528
1561
 
@@ -1530,7 +1563,7 @@ __Returns:__
1530
1563
 
1531
1564
  --
1532
1565
 
1533
- ##### [characters](https://github.com/appium/ruby_lib/blob/ad91ee47a96bf7a19b6f784dc760ac70b8788e5a/lib/appium_lib/common/helper.rb#L210)
1566
+ ##### [characters](https://github.com/appium/ruby_lib/blob/54ff9c45df80ce901b718347e79e761f93a4316b/lib/appium_lib/common/helper.rb#L210)
1534
1567
 
1535
1568
  > def characters(chars)
1536
1569
 
@@ -1538,7 +1571,7 @@ __Returns:__
1538
1571
 
1539
1572
  --
1540
1573
 
1541
- ##### [_no_such_element](https://github.com/appium/ruby_lib/blob/ad91ee47a96bf7a19b6f784dc760ac70b8788e5a/lib/appium_lib/common/helper.rb#L217)
1574
+ ##### [_no_such_element](https://github.com/appium/ruby_lib/blob/54ff9c45df80ce901b718347e79e761f93a4316b/lib/appium_lib/common/helper.rb#L217)
1542
1575
 
1543
1576
  > def _no_such_element
1544
1577
 
@@ -1546,7 +1579,7 @@ __Returns:__
1546
1579
 
1547
1580
  --
1548
1581
 
1549
- ##### [window_size](https://github.com/appium/ruby_lib/blob/ad91ee47a96bf7a19b6f784dc760ac70b8788e5a/lib/appium_lib/common/element/window.rb#L5)
1582
+ ##### [window_size](https://github.com/appium/ruby_lib/blob/54ff9c45df80ce901b718347e79e761f93a4316b/lib/appium_lib/common/element/window.rb#L5)
1550
1583
 
1551
1584
  > def window_size
1552
1585
 
@@ -1554,7 +1587,43 @@ Get the window's size
1554
1587
 
1555
1588
  --
1556
1589
 
1557
- ##### [ios_password](https://github.com/appium/ruby_lib/blob/ad91ee47a96bf7a19b6f784dc760ac70b8788e5a/lib/appium_lib/ios/helper.rb#L8) ios
1590
+ ##### [filter](https://github.com/appium/ruby_lib/blob/54ff9c45df80ce901b718347e79e761f93a4316b/lib/appium_lib/ios/helper.rb#L4) ios
1591
+
1592
+ > def filter
1593
+
1594
+ Returns the value of attribute filter
1595
+
1596
+ --
1597
+
1598
+ ##### [filter=](https://github.com/appium/ruby_lib/blob/54ff9c45df80ce901b718347e79e761f93a4316b/lib/appium_lib/ios/helper.rb#L4) ios
1599
+
1600
+ > def filter=(value)
1601
+
1602
+ Sets the attribute filter
1603
+
1604
+ __Parameters:__
1605
+
1606
+      value - the value to set the attribute filter to.
1607
+
1608
+ --
1609
+
1610
+ ##### [start_element](https://github.com/appium/ruby_lib/blob/54ff9c45df80ce901b718347e79e761f93a4316b/lib/appium_lib/ios/helper.rb#L6) ios
1611
+
1612
+ > def start_element(type, attrs = [])
1613
+
1614
+
1615
+
1616
+ --
1617
+
1618
+ ##### [_print_attr](https://github.com/appium/ruby_lib/blob/54ff9c45df80ce901b718347e79e761f93a4316b/lib/appium_lib/ios/helper.rb#L15) ios
1619
+
1620
+ > def _print_attr(type, name, label, value, hint)
1621
+
1622
+
1623
+
1624
+ --
1625
+
1626
+ ##### [ios_password](https://github.com/appium/ruby_lib/blob/54ff9c45df80ce901b718347e79e761f93a4316b/lib/appium_lib/ios/helper.rb#L44) ios
1558
1627
 
1559
1628
  > def ios_password(length = 1)
1560
1629
 
@@ -1572,7 +1641,7 @@ __Returns:__
1572
1641
 
1573
1642
  --
1574
1643
 
1575
- ##### [get_page](https://github.com/appium/ruby_lib/blob/ad91ee47a96bf7a19b6f784dc760ac70b8788e5a/lib/appium_lib/ios/helper.rb#L20) ios
1644
+ ##### [get_page](https://github.com/appium/ruby_lib/blob/54ff9c45df80ce901b718347e79e761f93a4316b/lib/appium_lib/ios/helper.rb#L56) ios
1576
1645
 
1577
1646
  > def get_page(element = source_window(0), class_name = nil)
1578
1647
 
@@ -1593,7 +1662,7 @@ __Returns:__
1593
1662
 
1594
1663
  --
1595
1664
 
1596
- ##### [page](https://github.com/appium/ruby_lib/blob/ad91ee47a96bf7a19b6f784dc760ac70b8788e5a/lib/appium_lib/ios/helper.rb#L129) ios
1665
+ ##### [page](https://github.com/appium/ruby_lib/blob/54ff9c45df80ce901b718347e79e761f93a4316b/lib/appium_lib/ios/helper.rb#L165) ios
1597
1666
 
1598
1667
  > def page(opts = {})
1599
1668
 
@@ -1619,9 +1688,9 @@ __Returns:__
1619
1688
 
1620
1689
  --
1621
1690
 
1622
- ##### [source_window](https://github.com/appium/ruby_lib/blob/ad91ee47a96bf7a19b6f784dc760ac70b8788e5a/lib/appium_lib/ios/helper.rb#L161) ios
1691
+ ##### [source_window](https://github.com/appium/ruby_lib/blob/54ff9c45df80ce901b718347e79e761f93a4316b/lib/appium_lib/ios/helper.rb#L196) ios
1623
1692
 
1624
- > def source_window(window_number = 0)
1693
+ > def source_window(_window_number = 0)
1625
1694
 
1626
1695
  Gets the JSON source of window number
1627
1696
 
@@ -1635,7 +1704,7 @@ __Returns:__
1635
1704
 
1636
1705
  --
1637
1706
 
1638
- ##### [page_window](https://github.com/appium/ruby_lib/blob/ad91ee47a96bf7a19b6f784dc760ac70b8788e5a/lib/appium_lib/ios/helper.rb#L175) ios
1707
+ ##### [page_window](https://github.com/appium/ruby_lib/blob/54ff9c45df80ce901b718347e79e761f93a4316b/lib/appium_lib/ios/helper.rb#L211) ios
1639
1708
 
1640
1709
  > def page_window(window_number = 0)
1641
1710
 
@@ -1653,7 +1722,7 @@ __Returns:__
1653
1722
 
1654
1723
  --
1655
1724
 
1656
- ##### [id](https://github.com/appium/ruby_lib/blob/ad91ee47a96bf7a19b6f784dc760ac70b8788e5a/lib/appium_lib/ios/helper.rb#L183) ios
1725
+ ##### [id](https://github.com/appium/ruby_lib/blob/54ff9c45df80ce901b718347e79e761f93a4316b/lib/appium_lib/ios/helper.rb#L219) ios
1657
1726
 
1658
1727
  > def id(id)
1659
1728
 
@@ -1669,7 +1738,7 @@ __Returns:__
1669
1738
 
1670
1739
  --
1671
1740
 
1672
- ##### [ios_version](https://github.com/appium/ruby_lib/blob/ad91ee47a96bf7a19b6f784dc760ac70b8788e5a/lib/appium_lib/ios/helper.rb#L189) ios
1741
+ ##### [ios_version](https://github.com/appium/ruby_lib/blob/54ff9c45df80ce901b718347e79e761f93a4316b/lib/appium_lib/ios/helper.rb#L225) ios
1673
1742
 
1674
1743
  > def ios_version
1675
1744
 
@@ -1681,7 +1750,7 @@ __Returns:__
1681
1750
 
1682
1751
  --
1683
1752
 
1684
- ##### [ele_index](https://github.com/appium/ruby_lib/blob/ad91ee47a96bf7a19b6f784dc760ac70b8788e5a/lib/appium_lib/ios/helper.rb#L198) ios
1753
+ ##### [ele_index](https://github.com/appium/ruby_lib/blob/54ff9c45df80ce901b718347e79e761f93a4316b/lib/appium_lib/ios/helper.rb#L238) ios
1685
1754
 
1686
1755
  > def ele_index(class_name, index)
1687
1756
 
@@ -1699,7 +1768,7 @@ __Returns:__
1699
1768
 
1700
1769
  --
1701
1770
 
1702
- ##### [find_ele_by_attr](https://github.com/appium/ruby_lib/blob/ad91ee47a96bf7a19b6f784dc760ac70b8788e5a/lib/appium_lib/ios/helper.rb#L225) ios
1771
+ ##### [find_ele_by_attr](https://github.com/appium/ruby_lib/blob/54ff9c45df80ce901b718347e79e761f93a4316b/lib/appium_lib/ios/helper.rb#L273) ios
1703
1772
 
1704
1773
  > def find_ele_by_attr(class_name, attr, value)
1705
1774
 
@@ -1720,7 +1789,7 @@ __Returns:__
1720
1789
 
1721
1790
  --
1722
1791
 
1723
- ##### [find_eles_by_attr](https://github.com/appium/ruby_lib/blob/ad91ee47a96bf7a19b6f784dc760ac70b8788e5a/lib/appium_lib/ios/helper.rb#L235) ios
1792
+ ##### [find_eles_by_attr](https://github.com/appium/ruby_lib/blob/54ff9c45df80ce901b718347e79e761f93a4316b/lib/appium_lib/ios/helper.rb#L283) ios
1724
1793
 
1725
1794
  > def find_eles_by_attr(class_name, attr, value)
1726
1795
 
@@ -1741,7 +1810,7 @@ __Returns:__
1741
1810
 
1742
1811
  --
1743
1812
 
1744
- ##### [find_ele_by_attr_include](https://github.com/appium/ruby_lib/blob/ad91ee47a96bf7a19b6f784dc760ac70b8788e5a/lib/appium_lib/ios/helper.rb#L250) ios
1813
+ ##### [find_ele_by_attr_include](https://github.com/appium/ruby_lib/blob/54ff9c45df80ce901b718347e79e761f93a4316b/lib/appium_lib/ios/helper.rb#L306) ios
1745
1814
 
1746
1815
  > def find_ele_by_attr_include(class_name, attr, value)
1747
1816
 
@@ -1762,7 +1831,7 @@ __Returns:__
1762
1831
 
1763
1832
  --
1764
1833
 
1765
- ##### [find_eles_by_attr_include](https://github.com/appium/ruby_lib/blob/ad91ee47a96bf7a19b6f784dc760ac70b8788e5a/lib/appium_lib/ios/helper.rb#L260) ios
1834
+ ##### [find_eles_by_attr_include](https://github.com/appium/ruby_lib/blob/54ff9c45df80ce901b718347e79e761f93a4316b/lib/appium_lib/ios/helper.rb#L316) ios
1766
1835
 
1767
1836
  > def find_eles_by_attr_include(class_name, attr, value)
1768
1837
 
@@ -1783,7 +1852,7 @@ __Returns:__
1783
1852
 
1784
1853
  --
1785
1854
 
1786
- ##### [first_ele](https://github.com/appium/ruby_lib/blob/ad91ee47a96bf7a19b6f784dc760ac70b8788e5a/lib/appium_lib/ios/helper.rb#L267) ios
1855
+ ##### [first_ele](https://github.com/appium/ruby_lib/blob/54ff9c45df80ce901b718347e79e761f93a4316b/lib/appium_lib/ios/helper.rb#L323) ios
1787
1856
 
1788
1857
  > def first_ele(class_name)
1789
1858
 
@@ -1799,7 +1868,7 @@ __Returns:__
1799
1868
 
1800
1869
  --
1801
1870
 
1802
- ##### [last_ele](https://github.com/appium/ruby_lib/blob/ad91ee47a96bf7a19b6f784dc760ac70b8788e5a/lib/appium_lib/ios/helper.rb#L275) ios
1871
+ ##### [last_ele](https://github.com/appium/ruby_lib/blob/54ff9c45df80ce901b718347e79e761f93a4316b/lib/appium_lib/ios/helper.rb#L334) ios
1803
1872
 
1804
1873
  > def last_ele(class_name)
1805
1874
 
@@ -1815,7 +1884,7 @@ __Returns:__
1815
1884
 
1816
1885
  --
1817
1886
 
1818
- ##### [tag](https://github.com/appium/ruby_lib/blob/ad91ee47a96bf7a19b6f784dc760ac70b8788e5a/lib/appium_lib/ios/helper.rb#L283) ios
1887
+ ##### [tag](https://github.com/appium/ruby_lib/blob/54ff9c45df80ce901b718347e79e761f93a4316b/lib/appium_lib/ios/helper.rb#L348) ios
1819
1888
 
1820
1889
  > def tag(class_name)
1821
1890
 
@@ -1831,7 +1900,7 @@ __Returns:__
1831
1900
 
1832
1901
  --
1833
1902
 
1834
- ##### [tags](https://github.com/appium/ruby_lib/blob/ad91ee47a96bf7a19b6f784dc760ac70b8788e5a/lib/appium_lib/ios/helper.rb#L294) ios
1903
+ ##### [tags](https://github.com/appium/ruby_lib/blob/54ff9c45df80ce901b718347e79e761f93a4316b/lib/appium_lib/ios/helper.rb#L360) ios
1835
1904
 
1836
1905
  > def tags(class_name)
1837
1906
 
@@ -1847,11 +1916,12 @@ __Returns:__
1847
1916
 
1848
1917
  --
1849
1918
 
1850
- ##### [ele_by_json_visible_contains](https://github.com/appium/ruby_lib/blob/ad91ee47a96bf7a19b6f784dc760ac70b8788e5a/lib/appium_lib/ios/helper.rb#L329) ios
1919
+ ##### [ele_by_json_visible_contains](https://github.com/appium/ruby_lib/blob/54ff9c45df80ce901b718347e79e761f93a4316b/lib/appium_lib/ios/helper.rb#L397) ios
1851
1920
 
1852
1921
  > def ele_by_json_visible_contains(element, value)
1853
1922
 
1854
- Find the first element that contains value
1923
+ Find the first element that contains value.
1924
+ For Appium(automation name), not XCUITest
1855
1925
 
1856
1926
  __Parameters:__
1857
1927
 
@@ -1865,11 +1935,12 @@ __Returns:__
1865
1935
 
1866
1936
  --
1867
1937
 
1868
- ##### [eles_by_json_visible_contains](https://github.com/appium/ruby_lib/blob/ad91ee47a96bf7a19b6f784dc760ac70b8788e5a/lib/appium_lib/ios/helper.rb#L337) ios
1938
+ ##### [eles_by_json_visible_contains](https://github.com/appium/ruby_lib/blob/54ff9c45df80ce901b718347e79e761f93a4316b/lib/appium_lib/ios/helper.rb#L406) ios
1869
1939
 
1870
1940
  > def eles_by_json_visible_contains(element, value)
1871
1941
 
1872
1942
  Find all elements containing value
1943
+ For Appium(automation name), not XCUITest
1873
1944
 
1874
1945
  __Parameters:__
1875
1946
 
@@ -1883,11 +1954,12 @@ __Returns:__
1883
1954
 
1884
1955
  --
1885
1956
 
1886
- ##### [ele_by_json_visible_exact](https://github.com/appium/ruby_lib/blob/ad91ee47a96bf7a19b6f784dc760ac70b8788e5a/lib/appium_lib/ios/helper.rb#L366) ios
1957
+ ##### [ele_by_json_visible_exact](https://github.com/appium/ruby_lib/blob/54ff9c45df80ce901b718347e79e761f93a4316b/lib/appium_lib/ios/helper.rb#L436) ios
1887
1958
 
1888
1959
  > def ele_by_json_visible_exact(element, value)
1889
1960
 
1890
1961
  Find the first element exactly matching value
1962
+ For Appium(automation name), not XCUITest
1891
1963
 
1892
1964
  __Parameters:__
1893
1965
 
@@ -1901,11 +1973,12 @@ __Returns:__
1901
1973
 
1902
1974
  --
1903
1975
 
1904
- ##### [eles_by_json_visible_exact](https://github.com/appium/ruby_lib/blob/ad91ee47a96bf7a19b6f784dc760ac70b8788e5a/lib/appium_lib/ios/helper.rb#L374) ios
1976
+ ##### [eles_by_json_visible_exact](https://github.com/appium/ruby_lib/blob/54ff9c45df80ce901b718347e79e761f93a4316b/lib/appium_lib/ios/helper.rb#L445) ios
1905
1977
 
1906
1978
  > def eles_by_json_visible_exact(element, value)
1907
1979
 
1908
1980
  Find all elements exactly matching value
1981
+ For Appium(automation name), not XCUITest
1909
1982
 
1910
1983
  __Parameters:__
1911
1984
 
@@ -1919,7 +1992,7 @@ __Returns:__
1919
1992
 
1920
1993
  --
1921
1994
 
1922
- ##### [_all_pred](https://github.com/appium/ruby_lib/blob/ad91ee47a96bf7a19b6f784dc760ac70b8788e5a/lib/appium_lib/ios/helper.rb#L438) ios
1995
+ ##### [_all_pred](https://github.com/appium/ruby_lib/blob/54ff9c45df80ce901b718347e79e761f93a4316b/lib/appium_lib/ios/helper.rb#L510) ios
1923
1996
 
1924
1997
  > def _all_pred(opts)
1925
1998
 
@@ -1929,7 +2002,7 @@ visible - if true, only visible elements are returned. default true
1929
2002
 
1930
2003
  --
1931
2004
 
1932
- ##### [ele_with_pred](https://github.com/appium/ruby_lib/blob/ad91ee47a96bf7a19b6f784dc760ac70b8788e5a/lib/appium_lib/ios/helper.rb#L451) ios
2005
+ ##### [ele_with_pred](https://github.com/appium/ruby_lib/blob/54ff9c45df80ce901b718347e79e761f93a4316b/lib/appium_lib/ios/helper.rb#L523) ios
1933
2006
 
1934
2007
  > def ele_with_pred(opts)
1935
2008
 
@@ -1945,7 +2018,7 @@ __Returns:__
1945
2018
 
1946
2019
  --
1947
2020
 
1948
- ##### [eles_with_pred](https://github.com/appium/ruby_lib/blob/ad91ee47a96bf7a19b6f784dc760ac70b8788e5a/lib/appium_lib/ios/helper.rb#L462) ios
2021
+ ##### [eles_with_pred](https://github.com/appium/ruby_lib/blob/54ff9c45df80ce901b718347e79e761f93a4316b/lib/appium_lib/ios/helper.rb#L534) ios
1949
2022
 
1950
2023
  > def eles_with_pred(opts)
1951
2024
 
@@ -1961,7 +2034,7 @@ __Returns:__
1961
2034
 
1962
2035
  --
1963
2036
 
1964
- ##### [source](https://github.com/appium/ruby_lib/blob/ad91ee47a96bf7a19b6f784dc760ac70b8788e5a/lib/appium_lib/ios/helper.rb#L468) ios
2037
+ ##### [source](https://github.com/appium/ruby_lib/blob/54ff9c45df80ce901b718347e79e761f93a4316b/lib/appium_lib/ios/helper.rb#L540) ios
1965
2038
 
1966
2039
  > def source
1967
2040
 
@@ -1973,7 +2046,7 @@ __Returns:__
1973
2046
 
1974
2047
  --
1975
2048
 
1976
- ##### [_validate_object](https://github.com/appium/ruby_lib/blob/ad91ee47a96bf7a19b6f784dc760ac70b8788e5a/lib/appium_lib/ios/helper.rb#L472) ios
2049
+ ##### [_validate_object](https://github.com/appium/ruby_lib/blob/54ff9c45df80ce901b718347e79e761f93a4316b/lib/appium_lib/ios/helper.rb#L544) ios
1977
2050
 
1978
2051
  > def _validate_object(*objects)
1979
2052
 
@@ -1981,10 +2054,11 @@ __Returns:__
1981
2054
 
1982
2055
  --
1983
2056
 
1984
- ##### [_by_json](https://github.com/appium/ruby_lib/blob/ad91ee47a96bf7a19b6f784dc760ac70b8788e5a/lib/appium_lib/ios/helper.rb#L520) ios
2057
+ ##### [_by_json](https://github.com/appium/ruby_lib/blob/54ff9c45df80ce901b718347e79e761f93a4316b/lib/appium_lib/ios/helper.rb#L593) ios
1985
2058
 
1986
2059
  > def _by_json(opts)
1987
2060
 
2061
+ For Appium(automation name), not XCUITest
1988
2062
  typeArray - array of string types to search for. Example: ["UIAStaticText"]
1989
2063
  onlyFirst - boolean. returns only the first result if true. Example: true
1990
2064
  onlyVisible - boolean. returns only visible elements if true. Example: true
@@ -2015,10 +2089,11 @@ opts = {
2015
2089
 
2016
2090
  --
2017
2091
 
2018
- ##### [eles_by_json](https://github.com/appium/ruby_lib/blob/ad91ee47a96bf7a19b6f784dc760ac70b8788e5a/lib/appium_lib/ios/helper.rb#L569) ios
2092
+ ##### [eles_by_json](https://github.com/appium/ruby_lib/blob/54ff9c45df80ce901b718347e79e761f93a4316b/lib/appium_lib/ios/helper.rb#L643) ios
2019
2093
 
2020
2094
  > def eles_by_json(opts)
2021
2095
 
2096
+ For Appium(automation name), not XCUITest
2022
2097
  example usage:
2023
2098
 
2024
2099
  eles_by_json({
@@ -2033,7 +2108,7 @@ eles_by_json({
2033
2108
 
2034
2109
  --
2035
2110
 
2036
- ##### [ele_by_json](https://github.com/appium/ruby_lib/blob/ad91ee47a96bf7a19b6f784dc760ac70b8788e5a/lib/appium_lib/ios/helper.rb#L575) ios
2111
+ ##### [ele_by_json](https://github.com/appium/ruby_lib/blob/54ff9c45df80ce901b718347e79e761f93a4316b/lib/appium_lib/ios/helper.rb#L649) ios
2037
2112
 
2038
2113
  > def ele_by_json(opts)
2039
2114
 
@@ -2041,7 +2116,7 @@ see eles_by_json
2041
2116
 
2042
2117
  --
2043
2118
 
2044
- ##### [get_source](https://github.com/appium/ruby_lib/blob/ad91ee47a96bf7a19b6f784dc760ac70b8788e5a/lib/appium_lib/ios/helper.rb#L585) ios
2119
+ ##### [get_source](https://github.com/appium/ruby_lib/blob/54ff9c45df80ce901b718347e79e761f93a4316b/lib/appium_lib/ios/helper.rb#L659) ios
2045
2120
 
2046
2121
  > def get_source
2047
2122
 
@@ -2054,20 +2129,40 @@ __Returns:__
2054
2129
 
2055
2130
  --
2056
2131
 
2057
- ##### [UIAStaticText](https://github.com/appium/ruby_lib/blob/ad91ee47a96bf7a19b6f784dc760ac70b8788e5a/lib/appium_lib/ios/element/text.rb#L4) ios
2132
+ ##### [IAStaticText](https://github.com/appium/ruby_lib/blob/54ff9c45df80ce901b718347e79e761f93a4316b/lib/appium_lib/ios/element/text.rb#L4) ios
2058
2133
 
2059
- > UIAStaticText = 'UIAStaticText'
2134
+ > IAStaticText = 'UIAStaticText'.freeze
2060
2135
 
2061
2136
 
2062
2137
 
2063
2138
  --
2064
2139
 
2065
- ##### [text](https://github.com/appium/ruby_lib/blob/ad91ee47a96bf7a19b6f784dc760ac70b8788e5a/lib/appium_lib/ios/element/text.rb#L10) ios
2140
+ ##### [XCUIElementTypeStaticText](https://github.com/appium/ruby_lib/blob/54ff9c45df80ce901b718347e79e761f93a4316b/lib/appium_lib/ios/element/text.rb#L5) ios
2141
+
2142
+ > XCUIElementTypeStaticText = 'XCUIElementTypeStaticText'.freeze
2143
+
2144
+
2145
+
2146
+ --
2147
+
2148
+ ##### [static_text_class](https://github.com/appium/ruby_lib/blob/54ff9c45df80ce901b718347e79e761f93a4316b/lib/appium_lib/ios/element/text.rb#L8) ios
2149
+
2150
+ > def static_text_class
2151
+
2152
+
2153
+
2154
+ __Returns:__
2155
+
2156
+      [String] Class name for text
2157
+
2158
+ --
2159
+
2160
+ ##### [text](https://github.com/appium/ruby_lib/blob/54ff9c45df80ce901b718347e79e761f93a4316b/lib/appium_lib/ios/element/text.rb#L16) ios
2066
2161
 
2067
2162
  > def text(value)
2068
2163
 
2069
- Find the first UIAStaticText that contains value or by index.
2070
- If int then the UIAStaticText at that index is returned.
2164
+ Find the first UIAStaticText|XCUIElementTypeStaticText that contains value or by index.
2165
+ If int then the UIAStaticText|XCUIElementTypeStaticText at that index is returned.
2071
2166
 
2072
2167
  __Parameters:__
2073
2168
 
@@ -2075,16 +2170,16 @@ __Parameters:__
2075
2170
 
2076
2171
  __Returns:__
2077
2172
 
2078
-      [UIAStaticText]
2173
+      [UIAStaticText|XCUIElementTypeStaticText]
2079
2174
 
2080
2175
  --
2081
2176
 
2082
- ##### [texts](https://github.com/appium/ruby_lib/blob/ad91ee47a96bf7a19b6f784dc760ac70b8788e5a/lib/appium_lib/ios/element/text.rb#L19) ios
2177
+ ##### [texts](https://github.com/appium/ruby_lib/blob/54ff9c45df80ce901b718347e79e761f93a4316b/lib/appium_lib/ios/element/text.rb#L30) ios
2083
2178
 
2084
2179
  > def texts(value = false)
2085
2180
 
2086
- Find all UIAStaticText containing value.
2087
- If value is omitted, all UIAStaticTexts are returned
2181
+ Find all UIAStaticTexts|XCUIElementTypeStaticTexts containing value.
2182
+ If value is omitted, all UIAStaticTexts|XCUIElementTypeStaticTexts are returned
2088
2183
 
2089
2184
  __Parameters:__
2090
2185
 
@@ -2092,39 +2187,39 @@ __Parameters:__
2092
2187
 
2093
2188
  __Returns:__
2094
2189
 
2095
- &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Array<UIAStaticText>]
2190
+ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Array<UIAStaticText|XCUIElementTypeStaticText>]
2096
2191
 
2097
2192
  --
2098
2193
 
2099
- ##### [first_text](https://github.com/appium/ruby_lib/blob/ad91ee47a96bf7a19b6f784dc760ac70b8788e5a/lib/appium_lib/ios/element/text.rb#L26) ios
2194
+ ##### [first_text](https://github.com/appium/ruby_lib/blob/54ff9c45df80ce901b718347e79e761f93a4316b/lib/appium_lib/ios/element/text.rb#L42) ios
2100
2195
 
2101
2196
  > def first_text
2102
2197
 
2103
- Find the first UIAStaticText.
2198
+ Find the first UIAStaticText|XCUIElementTypeStaticText.
2104
2199
 
2105
2200
  __Returns:__
2106
2201
 
2107
- &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[UIAStaticText]
2202
+ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[UIAStaticText|XCUIElementTypeStaticText]
2108
2203
 
2109
2204
  --
2110
2205
 
2111
- ##### [last_text](https://github.com/appium/ruby_lib/blob/ad91ee47a96bf7a19b6f784dc760ac70b8788e5a/lib/appium_lib/ios/element/text.rb#L32) ios
2206
+ ##### [last_text](https://github.com/appium/ruby_lib/blob/54ff9c45df80ce901b718347e79e761f93a4316b/lib/appium_lib/ios/element/text.rb#L48) ios
2112
2207
 
2113
2208
  > def last_text
2114
2209
 
2115
- Find the last UIAStaticText.
2210
+ Find the last UIAStaticText|XCUIElementTypeStaticText.
2116
2211
 
2117
2212
  __Returns:__
2118
2213
 
2119
- &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[UIAStaticText]
2214
+ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[UIAStaticText|XCUIElementTypeStaticText]
2120
2215
 
2121
2216
  --
2122
2217
 
2123
- ##### [text_exact](https://github.com/appium/ruby_lib/blob/ad91ee47a96bf7a19b6f784dc760ac70b8788e5a/lib/appium_lib/ios/element/text.rb#L39) ios
2218
+ ##### [text_exact](https://github.com/appium/ruby_lib/blob/54ff9c45df80ce901b718347e79e761f93a4316b/lib/appium_lib/ios/element/text.rb#L55) ios
2124
2219
 
2125
2220
  > def text_exact(value)
2126
2221
 
2127
- Find the first UIAStaticText that exactly matches value.
2222
+ Find the first UIAStaticText|XCUIElementTypeStaticText that exactly matches value.
2128
2223
 
2129
2224
  __Parameters:__
2130
2225
 
@@ -2132,15 +2227,15 @@ __Parameters:__
2132
2227
 
2133
2228
  __Returns:__
2134
2229
 
2135
- &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[UIAStaticText]
2230
+ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[UIAStaticText|XCUIElementTypeStaticText]
2136
2231
 
2137
2232
  --
2138
2233
 
2139
- ##### [texts_exact](https://github.com/appium/ruby_lib/blob/ad91ee47a96bf7a19b6f784dc760ac70b8788e5a/lib/appium_lib/ios/element/text.rb#L46) ios
2234
+ ##### [texts_exact](https://github.com/appium/ruby_lib/blob/54ff9c45df80ce901b718347e79e761f93a4316b/lib/appium_lib/ios/element/text.rb#L66) ios
2140
2235
 
2141
2236
  > def texts_exact(value)
2142
2237
 
2143
- Find all UIAStaticTexts that exactly match value.
2238
+ Find all UIAStaticTexts|XCUIElementTypeStaticTexts that exactly match value.
2144
2239
 
2145
2240
  __Parameters:__
2146
2241
 
@@ -2148,11 +2243,11 @@ __Parameters:__
2148
2243
 
2149
2244
  __Returns:__
2150
2245
 
2151
- &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Array<UIAStaticText>]
2246
+ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Array<UIAStaticText|XCUIElementTypeStaticText>]
2152
2247
 
2153
2248
  --
2154
2249
 
2155
- ##### [alert_accept](https://github.com/appium/ruby_lib/blob/ad91ee47a96bf7a19b6f784dc760ac70b8788e5a/lib/appium_lib/ios/element/alert.rb#L5) ios
2250
+ ##### [alert_accept](https://github.com/appium/ruby_lib/blob/54ff9c45df80ce901b718347e79e761f93a4316b/lib/appium_lib/ios/element/alert.rb#L5) ios
2156
2251
 
2157
2252
  > def alert_accept
2158
2253
 
@@ -2164,7 +2259,7 @@ __Returns:__
2164
2259
 
2165
2260
  --
2166
2261
 
2167
- ##### [alert_dismiss](https://github.com/appium/ruby_lib/blob/ad91ee47a96bf7a19b6f784dc760ac70b8788e5a/lib/appium_lib/ios/element/alert.rb#L13) ios
2262
+ ##### [alert_dismiss](https://github.com/appium/ruby_lib/blob/54ff9c45df80ce901b718347e79e761f93a4316b/lib/appium_lib/ios/element/alert.rb#L13) ios
2168
2263
 
2169
2264
  > def alert_dismiss
2170
2265
 
@@ -2176,7 +2271,7 @@ __Returns:__
2176
2271
 
2177
2272
  --
2178
2273
 
2179
- ##### [uiautomation_find](https://github.com/appium/ruby_lib/blob/ad91ee47a96bf7a19b6f784dc760ac70b8788e5a/lib/appium_lib/ios/mobile_methods.rb#L10) ios
2274
+ ##### [uiautomation_find](https://github.com/appium/ruby_lib/blob/54ff9c45df80ce901b718347e79e761f93a4316b/lib/appium_lib/ios/mobile_methods.rb#L10) ios
2180
2275
 
2181
2276
  > def uiautomation_find
2182
2277
 
@@ -2188,20 +2283,40 @@ find_element/s can be used with a [UIAutomation command](https://developer.apple
2188
2283
 
2189
2284
  --
2190
2285
 
2191
- ##### [UIAButton](https://github.com/appium/ruby_lib/blob/ad91ee47a96bf7a19b6f784dc760ac70b8788e5a/lib/appium_lib/ios/element/button.rb#L4) ios
2286
+ ##### [UIAButton](https://github.com/appium/ruby_lib/blob/54ff9c45df80ce901b718347e79e761f93a4316b/lib/appium_lib/ios/element/button.rb#L4) ios
2287
+
2288
+ > UIAButton = 'UIAButton'.freeze
2289
+
2290
+
2291
+
2292
+ --
2293
+
2294
+ ##### [XCUIElementTypeButton](https://github.com/appium/ruby_lib/blob/54ff9c45df80ce901b718347e79e761f93a4316b/lib/appium_lib/ios/element/button.rb#L5) ios
2192
2295
 
2193
- > UIAButton = 'UIAButton'
2296
+ > XCUIElementTypeButton = 'XCUIElementTypeButton'.freeze
2194
2297
 
2195
2298
 
2196
2299
 
2197
2300
  --
2198
2301
 
2199
- ##### [button](https://github.com/appium/ruby_lib/blob/ad91ee47a96bf7a19b6f784dc760ac70b8788e5a/lib/appium_lib/ios/element/button.rb#L10) ios
2302
+ ##### [button_class](https://github.com/appium/ruby_lib/blob/54ff9c45df80ce901b718347e79e761f93a4316b/lib/appium_lib/ios/element/button.rb#L8) ios
2303
+
2304
+ > def button_class
2305
+
2306
+
2307
+
2308
+ __Returns:__
2309
+
2310
+ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[String] Class name for button
2311
+
2312
+ --
2313
+
2314
+ ##### [button](https://github.com/appium/ruby_lib/blob/54ff9c45df80ce901b718347e79e761f93a4316b/lib/appium_lib/ios/element/button.rb#L16) ios
2200
2315
 
2201
2316
  > def button(value)
2202
2317
 
2203
- Find the first UIAButton that contains value or by index.
2204
- If int then the UIAButton at that index is returned.
2318
+ Find the first UIAButton|XCUIElementTypeButton that contains value or by index.
2319
+ If int then the UIAButton|XCUIElementTypeButton at that index is returned.
2205
2320
 
2206
2321
  __Parameters:__
2207
2322
 
@@ -2209,16 +2324,16 @@ __Parameters:__
2209
2324
 
2210
2325
  __Returns:__
2211
2326
 
2212
- &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[UIAButton]
2327
+ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[UIAButton|XCUIElementTypeButton]
2213
2328
 
2214
2329
  --
2215
2330
 
2216
- ##### [buttons](https://github.com/appium/ruby_lib/blob/ad91ee47a96bf7a19b6f784dc760ac70b8788e5a/lib/appium_lib/ios/element/button.rb#L20) ios
2331
+ ##### [buttons](https://github.com/appium/ruby_lib/blob/54ff9c45df80ce901b718347e79e761f93a4316b/lib/appium_lib/ios/element/button.rb#L31) ios
2217
2332
 
2218
2333
  > def buttons(value = false)
2219
2334
 
2220
- Find all UIAButtons containing value.
2221
- If value is omitted, all UIAButtons are returned.
2335
+ Find all UIAButtons|XCUIElementTypeButtons containing value.
2336
+ If value is omitted, all UIAButtons|XCUIElementTypeButtons are returned.
2222
2337
 
2223
2338
  __Parameters:__
2224
2339
 
@@ -2226,39 +2341,41 @@ __Parameters:__
2226
2341
 
2227
2342
  __Returns:__
2228
2343
 
2229
- &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Array<UIAButton>]
2344
+ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Array<UIAButton|XCUIElementTypeButton>]
2230
2345
 
2231
2346
  --
2232
2347
 
2233
- ##### [first_button](https://github.com/appium/ruby_lib/blob/ad91ee47a96bf7a19b6f784dc760ac70b8788e5a/lib/appium_lib/ios/element/button.rb#L27) ios
2348
+ ##### [first_button](https://github.com/appium/ruby_lib/blob/54ff9c45df80ce901b718347e79e761f93a4316b/lib/appium_lib/ios/element/button.rb#L43) ios
2234
2349
 
2235
2350
  > def first_button
2236
2351
 
2237
- Find the first UIAButton.
2352
+ Find the first UIAButton|XCUIElementTypeButton.
2238
2353
 
2239
2354
  __Returns:__
2240
2355
 
2241
- &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[UIAButton]
2356
+ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[UIAButton|XCUIElementTypeButton]
2242
2357
 
2243
2358
  --
2244
2359
 
2245
- ##### [last_button](https://github.com/appium/ruby_lib/blob/ad91ee47a96bf7a19b6f784dc760ac70b8788e5a/lib/appium_lib/ios/element/button.rb#L33) ios
2360
+ ##### [last_button](https://github.com/appium/ruby_lib/blob/54ff9c45df80ce901b718347e79e761f93a4316b/lib/appium_lib/ios/element/button.rb#L51) ios
2246
2361
 
2247
2362
  > def last_button
2248
2363
 
2249
- Find the last UIAButton.
2364
+ TODO: add documentation regarding previous element.
2365
+ Previous UIAElement is differ from UIAButton|XCUIElementTypeButton. So, the results are different.
2366
+ Find the last UIAButton|XCUIElementTypeButton.
2250
2367
 
2251
2368
  __Returns:__
2252
2369
 
2253
- &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[UIAButton]
2370
+ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[UIAButton|XCUIElementTypeButton]
2254
2371
 
2255
2372
  --
2256
2373
 
2257
- ##### [button_exact](https://github.com/appium/ruby_lib/blob/ad91ee47a96bf7a19b6f784dc760ac70b8788e5a/lib/appium_lib/ios/element/button.rb#L40) ios
2374
+ ##### [button_exact](https://github.com/appium/ruby_lib/blob/54ff9c45df80ce901b718347e79e761f93a4316b/lib/appium_lib/ios/element/button.rb#L58) ios
2258
2375
 
2259
2376
  > def button_exact(value)
2260
2377
 
2261
- Find the first UIAButton that exactly matches value.
2378
+ Find the first UIAButton|XCUIElementTypeButton that exactly matches value.
2262
2379
 
2263
2380
  __Parameters:__
2264
2381
 
@@ -2266,15 +2383,15 @@ __Parameters:__
2266
2383
 
2267
2384
  __Returns:__
2268
2385
 
2269
- &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[UIAButton]
2386
+ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[UIAButton|XCUIElementTypeButton]
2270
2387
 
2271
2388
  --
2272
2389
 
2273
- ##### [buttons_exact](https://github.com/appium/ruby_lib/blob/ad91ee47a96bf7a19b6f784dc760ac70b8788e5a/lib/appium_lib/ios/element/button.rb#L47) ios
2390
+ ##### [buttons_exact](https://github.com/appium/ruby_lib/blob/54ff9c45df80ce901b718347e79e761f93a4316b/lib/appium_lib/ios/element/button.rb#L69) ios
2274
2391
 
2275
2392
  > def buttons_exact(value)
2276
2393
 
2277
- Find all UIAButtons that exactly match value.
2394
+ Find all UIAButtons|XCUIElementTypeButtons that exactly match value.
2278
2395
 
2279
2396
  __Parameters:__
2280
2397
 
@@ -2282,11 +2399,11 @@ __Parameters:__
2282
2399
 
2283
2400
  __Returns:__
2284
2401
 
2285
- &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Array<UIAButton>]
2402
+ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Array<UIAButton|XCUIElementTypeButton>]
2286
2403
 
2287
2404
  --
2288
2405
 
2289
- ##### [find](https://github.com/appium/ruby_lib/blob/ad91ee47a96bf7a19b6f784dc760ac70b8788e5a/lib/appium_lib/ios/element/generic.rb#L6) ios
2406
+ ##### [find](https://github.com/appium/ruby_lib/blob/54ff9c45df80ce901b718347e79e761f93a4316b/lib/appium_lib/ios/element/generic.rb#L6) ios
2290
2407
 
2291
2408
  > def find(value)
2292
2409
 
@@ -2302,7 +2419,7 @@ __Returns:__
2302
2419
 
2303
2420
  --
2304
2421
 
2305
- ##### [finds](https://github.com/appium/ruby_lib/blob/ad91ee47a96bf7a19b6f784dc760ac70b8788e5a/lib/appium_lib/ios/element/generic.rb#L13) ios
2422
+ ##### [finds](https://github.com/appium/ruby_lib/blob/54ff9c45df80ce901b718347e79e761f93a4316b/lib/appium_lib/ios/element/generic.rb#L17) ios
2306
2423
 
2307
2424
  > def finds(value)
2308
2425
 
@@ -2318,7 +2435,7 @@ __Returns:__
2318
2435
 
2319
2436
  --
2320
2437
 
2321
- ##### [find_exact](https://github.com/appium/ruby_lib/blob/ad91ee47a96bf7a19b6f784dc760ac70b8788e5a/lib/appium_lib/ios/element/generic.rb#L20) ios
2438
+ ##### [find_exact](https://github.com/appium/ruby_lib/blob/54ff9c45df80ce901b718347e79e761f93a4316b/lib/appium_lib/ios/element/generic.rb#L28) ios
2322
2439
 
2323
2440
  > def find_exact(value)
2324
2441
 
@@ -2334,7 +2451,7 @@ __Returns:__
2334
2451
 
2335
2452
  --
2336
2453
 
2337
- ##### [finds_exact](https://github.com/appium/ruby_lib/blob/ad91ee47a96bf7a19b6f784dc760ac70b8788e5a/lib/appium_lib/ios/element/generic.rb#L27) ios
2454
+ ##### [finds_exact](https://github.com/appium/ruby_lib/blob/54ff9c45df80ce901b718347e79e761f93a4316b/lib/appium_lib/ios/element/generic.rb#L39) ios
2338
2455
 
2339
2456
  > def finds_exact(value)
2340
2457
 
@@ -2350,27 +2467,92 @@ __Returns:__
2350
2467
 
2351
2468
  --
2352
2469
 
2353
- ##### [UIATextField](https://github.com/appium/ruby_lib/blob/ad91ee47a96bf7a19b6f784dc760ac70b8788e5a/lib/appium_lib/ios/element/textfield.rb#L3) ios
2470
+ ##### [UIATextField](https://github.com/appium/ruby_lib/blob/54ff9c45df80ce901b718347e79e761f93a4316b/lib/appium_lib/ios/element/textfield.rb#L3) ios
2471
+
2472
+ > UIATextField = 'UIATextField'.freeze
2473
+
2474
+
2475
+
2476
+ --
2477
+
2478
+ ##### [UIASecureTextField](https://github.com/appium/ruby_lib/blob/54ff9c45df80ce901b718347e79e761f93a4316b/lib/appium_lib/ios/element/textfield.rb#L4) ios
2479
+
2480
+ > UIASecureTextField = 'UIASecureTextField'.freeze
2481
+
2482
+
2483
+
2484
+ --
2485
+
2486
+ ##### [XCUIElementTypeTextField](https://github.com/appium/ruby_lib/blob/54ff9c45df80ce901b718347e79e761f93a4316b/lib/appium_lib/ios/element/textfield.rb#L6) ios
2354
2487
 
2355
- > UIATextField = 'UIATextField'
2488
+ > XCUIElementTypeTextField = 'XCUIElementTypeTextField'.freeze
2356
2489
 
2357
2490
 
2358
2491
 
2359
2492
  --
2360
2493
 
2361
- ##### [UIASecureTextField](https://github.com/appium/ruby_lib/blob/ad91ee47a96bf7a19b6f784dc760ac70b8788e5a/lib/appium_lib/ios/element/textfield.rb#L4) ios
2494
+ ##### [XCUIElementTypeSecureTextField](https://github.com/appium/ruby_lib/blob/54ff9c45df80ce901b718347e79e761f93a4316b/lib/appium_lib/ios/element/textfield.rb#L7) ios
2362
2495
 
2363
- > UIASecureTextField = 'UIASecureTextField'
2496
+ > XCUIElementTypeSecureTextField = 'XCUIElementTypeSecureTextField'.freeze
2364
2497
 
2365
2498
 
2366
2499
 
2367
2500
  --
2368
2501
 
2369
- ##### [textfield](https://github.com/appium/ruby_lib/blob/ad91ee47a96bf7a19b6f784dc760ac70b8788e5a/lib/appium_lib/ios/element/textfield.rb#L52) ios
2502
+ ##### [text_field_class](https://github.com/appium/ruby_lib/blob/54ff9c45df80ce901b718347e79e761f93a4316b/lib/appium_lib/ios/element/textfield.rb#L10) ios
2503
+
2504
+ > def text_field_class
2505
+
2506
+
2507
+
2508
+ __Returns:__
2509
+
2510
+ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[String] Class name for text field
2511
+
2512
+ --
2513
+
2514
+ ##### [secure_text_field_class](https://github.com/appium/ruby_lib/blob/54ff9c45df80ce901b718347e79e761f93a4316b/lib/appium_lib/ios/element/textfield.rb#L15) ios
2515
+
2516
+ > def secure_text_field_class
2517
+
2518
+
2519
+
2520
+ __Returns:__
2521
+
2522
+ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[String] Class name for secure text field
2523
+
2524
+ --
2525
+
2526
+ ##### [_textfield_visible](https://github.com/appium/ruby_lib/blob/54ff9c45df80ce901b718347e79e761f93a4316b/lib/appium_lib/ios/element/textfield.rb#L40) ios
2527
+
2528
+ > def _textfield_visible
2529
+
2530
+ Appium
2531
+
2532
+ --
2533
+
2534
+ ##### [_textfield_exact_string](https://github.com/appium/ruby_lib/blob/54ff9c45df80ce901b718347e79e761f93a4316b/lib/appium_lib/ios/element/textfield.rb#L45) ios
2535
+
2536
+ > def _textfield_exact_string(value)
2537
+
2538
+ Appium
2539
+
2540
+ --
2541
+
2542
+ ##### [_textfield_contains_string](https://github.com/appium/ruby_lib/blob/54ff9c45df80ce901b718347e79e761f93a4316b/lib/appium_lib/ios/element/textfield.rb#L52) ios
2543
+
2544
+ > def _textfield_contains_string(value)
2545
+
2546
+ Appium
2547
+
2548
+ --
2549
+
2550
+ ##### [textfield](https://github.com/appium/ruby_lib/blob/54ff9c45df80ce901b718347e79e761f93a4316b/lib/appium_lib/ios/element/textfield.rb#L65) ios
2370
2551
 
2371
2552
  > def textfield(value)
2372
2553
 
2373
2554
  Find the first TextField that contains value or by index.
2555
+ Note: Uses XPath
2374
2556
  If int then the TextField at that index is returned.
2375
2557
 
2376
2558
  __Parameters:__
@@ -2383,7 +2565,7 @@ __Returns:__
2383
2565
 
2384
2566
  --
2385
2567
 
2386
- ##### [textfields](https://github.com/appium/ruby_lib/blob/ad91ee47a96bf7a19b6f784dc760ac70b8788e5a/lib/appium_lib/ios/element/textfield.rb#L72) ios
2568
+ ##### [textfields](https://github.com/appium/ruby_lib/blob/54ff9c45df80ce901b718347e79e761f93a4316b/lib/appium_lib/ios/element/textfield.rb#L91) ios
2387
2569
 
2388
2570
  > def textfields(value = false)
2389
2571
 
@@ -2400,7 +2582,7 @@ __Returns:__
2400
2582
 
2401
2583
  --
2402
2584
 
2403
- ##### [first_textfield](https://github.com/appium/ruby_lib/blob/ad91ee47a96bf7a19b6f784dc760ac70b8788e5a/lib/appium_lib/ios/element/textfield.rb#L79) ios
2585
+ ##### [first_textfield](https://github.com/appium/ruby_lib/blob/54ff9c45df80ce901b718347e79e761f93a4316b/lib/appium_lib/ios/element/textfield.rb#L103) ios
2404
2586
 
2405
2587
  > def first_textfield
2406
2588
 
@@ -2412,7 +2594,7 @@ __Returns:__
2412
2594
 
2413
2595
  --
2414
2596
 
2415
- ##### [last_textfield](https://github.com/appium/ruby_lib/blob/ad91ee47a96bf7a19b6f784dc760ac70b8788e5a/lib/appium_lib/ios/element/textfield.rb#L85) ios
2597
+ ##### [last_textfield](https://github.com/appium/ruby_lib/blob/54ff9c45df80ce901b718347e79e761f93a4316b/lib/appium_lib/ios/element/textfield.rb#L113) ios
2416
2598
 
2417
2599
  > def last_textfield
2418
2600
 
@@ -2424,7 +2606,7 @@ __Returns:__
2424
2606
 
2425
2607
  --
2426
2608
 
2427
- ##### [textfield_exact](https://github.com/appium/ruby_lib/blob/ad91ee47a96bf7a19b6f784dc760ac70b8788e5a/lib/appium_lib/ios/element/textfield.rb#L94) ios
2609
+ ##### [textfield_exact](https://github.com/appium/ruby_lib/blob/54ff9c45df80ce901b718347e79e761f93a4316b/lib/appium_lib/ios/element/textfield.rb#L126) ios
2428
2610
 
2429
2611
  > def textfield_exact(value)
2430
2612
 
@@ -2440,7 +2622,7 @@ __Returns:__
2440
2622
 
2441
2623
  --
2442
2624
 
2443
- ##### [textfields_exact](https://github.com/appium/ruby_lib/blob/ad91ee47a96bf7a19b6f784dc760ac70b8788e5a/lib/appium_lib/ios/element/textfield.rb#L101) ios
2625
+ ##### [textfields_exact](https://github.com/appium/ruby_lib/blob/54ff9c45df80ce901b718347e79e761f93a4316b/lib/appium_lib/ios/element/textfield.rb#L137) ios
2444
2626
 
2445
2627
  > def textfields_exact(value)
2446
2628
 
@@ -2456,7 +2638,7 @@ __Returns:__
2456
2638
 
2457
2639
  --
2458
2640
 
2459
- ##### [value](https://github.com/appium/ruby_lib/blob/ad91ee47a96bf7a19b6f784dc760ac70b8788e5a/lib/appium_lib/common/patch.rb#L12)
2641
+ ##### [value](https://github.com/appium/ruby_lib/blob/54ff9c45df80ce901b718347e79e761f93a4316b/lib/appium_lib/common/patch.rb#L12)
2460
2642
 
2461
2643
  > def value
2462
2644
 
@@ -2466,7 +2648,7 @@ Fixes NoMethodError: undefined method `value' for Selenium::WebDriver::Element
2466
2648
 
2467
2649
  --
2468
2650
 
2469
- ##### [name](https://github.com/appium/ruby_lib/blob/ad91ee47a96bf7a19b6f784dc760ac70b8788e5a/lib/appium_lib/common/patch.rb#L19)
2651
+ ##### [name](https://github.com/appium/ruby_lib/blob/54ff9c45df80ce901b718347e79e761f93a4316b/lib/appium_lib/common/patch.rb#L19)
2470
2652
 
2471
2653
  > def name
2472
2654
 
@@ -2476,7 +2658,7 @@ Fixes NoMethodError: undefined method `name' for Selenium::WebDriver::Element
2476
2658
 
2477
2659
  --
2478
2660
 
2479
- ##### [location_rel](https://github.com/appium/ruby_lib/blob/ad91ee47a96bf7a19b6f784dc760ac70b8788e5a/lib/appium_lib/common/patch.rb#L31)
2661
+ ##### [location_rel](https://github.com/appium/ruby_lib/blob/54ff9c45df80ce901b718347e79e761f93a4316b/lib/appium_lib/common/patch.rb#L31)
2480
2662
 
2481
2663
  > def location_rel
2482
2664
 
@@ -2494,7 +2676,7 @@ __Returns:__
2494
2676
 
2495
2677
  --
2496
2678
 
2497
- ##### [DEFAULT_HEADERS](https://github.com/appium/ruby_lib/blob/ad91ee47a96bf7a19b6f784dc760ac70b8788e5a/lib/appium_lib/common/patch.rb#L147)
2679
+ ##### [DEFAULT_HEADERS](https://github.com/appium/ruby_lib/blob/54ff9c45df80ce901b718347e79e761f93a4316b/lib/appium_lib/common/patch.rb#L147)
2498
2680
 
2499
2681
  > DEFAULT_HEADERS = { 'Accept' => CONTENT_TYPE, 'User-Agent' => "appium/ruby_lib/#{::Appium::VERSION}" }
2500
2682