appium_lib 9.2.0 → 9.3.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.
data/docs/ios_docs.md CHANGED
@@ -1,4 +1,4 @@
1
- ##### [load_settings](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/driver.rb#L74)
1
+ ##### [load_settings](https://github.com/appium/ruby_lib/blob/94f3348a8fbec111a7a958063d3a2e643051b2e9/lib/appium_lib/driver.rb#L74)
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/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/driver.rb#L110)
29
+ ##### [load_appium_txt](https://github.com/appium/ruby_lib/blob/94f3348a8fbec111a7a958063d3a2e643051b2e9/lib/appium_lib/driver.rb#L110)
30
30
 
31
31
  > def self.load_settings(opts = {})
32
32
 
@@ -55,7 +55,7 @@ __Returns:__
55
55
 
56
56
  --
57
57
 
58
- ##### [expand_required_files](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/driver.rb#L116)
58
+ ##### [expand_required_files](https://github.com/appium/ruby_lib/blob/94f3348a8fbec111a7a958063d3a2e643051b2e9/lib/appium_lib/driver.rb#L116)
59
59
 
60
60
  > def self.expand_required_files(base_dir, file_paths)
61
61
 
@@ -73,7 +73,7 @@ __Returns:__
73
73
 
74
74
  --
75
75
 
76
- ##### [symbolize_keys](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/driver.rb#L148)
76
+ ##### [symbolize_keys](https://github.com/appium/ruby_lib/blob/94f3348a8fbec111a7a958063d3a2e643051b2e9/lib/appium_lib/driver.rb#L148)
77
77
 
78
78
  > def self.symbolize_keys(hash)
79
79
 
@@ -84,7 +84,7 @@ https://github.com/rails/docrails/blob/a3b1105ada3da64acfa3843b164b14b734456a50/
84
84
 
85
85
  --
86
86
 
87
- ##### [promote_singleton_appium_methods](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/driver.rb#L169)
87
+ ##### [promote_singleton_appium_methods](https://github.com/appium/ruby_lib/blob/94f3348a8fbec111a7a958063d3a2e643051b2e9/lib/appium_lib/driver.rb#L169)
88
88
 
89
89
  > def self.promote_singleton_appium_methods(modules)
90
90
 
@@ -102,7 +102,7 @@ otherwise, the array of modules will be used as the promotion target.
102
102
 
103
103
  --
104
104
 
105
- ##### [promote_appium_methods](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/driver.rb#L222)
105
+ ##### [promote_appium_methods](https://github.com/appium/ruby_lib/blob/94f3348a8fbec111a7a958063d3a2e643051b2e9/lib/appium_lib/driver.rb#L222)
106
106
 
107
107
  > def self.promote_appium_methods(class_array)
108
108
 
@@ -132,7 +132,7 @@ __Parameters:__
132
132
 
133
133
  --
134
134
 
135
- ##### [init_caps_for_appium](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/driver.rb#L254)
135
+ ##### [init_caps_for_appium](https://github.com/appium/ruby_lib/blob/94f3348a8fbec111a7a958063d3a2e643051b2e9/lib/appium_lib/driver.rb#L254)
136
136
 
137
137
  > def self.init_caps_for_appium(opts_caps = {})
138
138
 
@@ -142,7 +142,7 @@ https://github.com/SeleniumHQ/selenium/blob/selenium-3.0.1/rb/lib/selenium/webdr
142
142
 
143
143
  --
144
144
 
145
- ##### [global_webdriver_http_sleep](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/driver.rb#L272)
145
+ ##### [global_webdriver_http_sleep](https://github.com/appium/ruby_lib/blob/94f3348a8fbec111a7a958063d3a2e643051b2e9/lib/appium_lib/driver.rb#L272)
146
146
 
147
147
  > def global_webdriver_http_sleep
148
148
 
@@ -150,7 +150,7 @@ The amount to sleep in seconds before every webdriver http call.
150
150
 
151
151
  --
152
152
 
153
- ##### [global_webdriver_http_sleep=](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/driver.rb#L272)
153
+ ##### [global_webdriver_http_sleep=](https://github.com/appium/ruby_lib/blob/94f3348a8fbec111a7a958063d3a2e643051b2e9/lib/appium_lib/driver.rb#L272)
154
154
 
155
155
  > def global_webdriver_http_sleep=(value)
156
156
 
@@ -158,7 +158,7 @@ The amount to sleep in seconds before every webdriver http call.
158
158
 
159
159
  --
160
160
 
161
- ##### [caps](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/driver.rb#L274)
161
+ ##### [caps](https://github.com/appium/ruby_lib/blob/94f3348a8fbec111a7a958063d3a2e643051b2e9/lib/appium_lib/driver.rb#L274)
162
162
 
163
163
  > def caps
164
164
 
@@ -166,7 +166,7 @@ Selenium webdriver capabilities
166
166
 
167
167
  --
168
168
 
169
- ##### [caps=](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/driver.rb#L274)
169
+ ##### [caps=](https://github.com/appium/ruby_lib/blob/94f3348a8fbec111a7a958063d3a2e643051b2e9/lib/appium_lib/driver.rb#L274)
170
170
 
171
171
  > def caps=(value)
172
172
 
@@ -174,7 +174,7 @@ Selenium webdriver capabilities
174
174
 
175
175
  --
176
176
 
177
- ##### [custom_url](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/driver.rb#L276)
177
+ ##### [custom_url](https://github.com/appium/ruby_lib/blob/94f3348a8fbec111a7a958063d3a2e643051b2e9/lib/appium_lib/driver.rb#L276)
178
178
 
179
179
  > def custom_url
180
180
 
@@ -182,7 +182,7 @@ Custom URL for the selenium server
182
182
 
183
183
  --
184
184
 
185
- ##### [custom_url=](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/driver.rb#L276)
185
+ ##### [custom_url=](https://github.com/appium/ruby_lib/blob/94f3348a8fbec111a7a958063d3a2e643051b2e9/lib/appium_lib/driver.rb#L276)
186
186
 
187
187
  > def custom_url=(value)
188
188
 
@@ -190,7 +190,7 @@ Custom URL for the selenium server
190
190
 
191
191
  --
192
192
 
193
- ##### [export_session](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/driver.rb#L278)
193
+ ##### [export_session](https://github.com/appium/ruby_lib/blob/94f3348a8fbec111a7a958063d3a2e643051b2e9/lib/appium_lib/driver.rb#L278)
194
194
 
195
195
  > def export_session
196
196
 
@@ -198,7 +198,7 @@ Export session id to textfile in /tmp for 3rd party tools
198
198
 
199
199
  --
200
200
 
201
- ##### [export_session=](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/driver.rb#L278)
201
+ ##### [export_session=](https://github.com/appium/ruby_lib/blob/94f3348a8fbec111a7a958063d3a2e643051b2e9/lib/appium_lib/driver.rb#L278)
202
202
 
203
203
  > def export_session=(value)
204
204
 
@@ -206,7 +206,7 @@ Export session id to textfile in /tmp for 3rd party tools
206
206
 
207
207
  --
208
208
 
209
- ##### [default_wait](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/driver.rb#L283)
209
+ ##### [default_wait](https://github.com/appium/ruby_lib/blob/94f3348a8fbec111a7a958063d3a2e643051b2e9/lib/appium_lib/driver.rb#L283)
210
210
 
211
211
  > def default_wait
212
212
 
@@ -220,7 +220,7 @@ __Returns:__
220
220
 
221
221
  --
222
222
 
223
- ##### [sauce_username](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/driver.rb#L285)
223
+ ##### [sauce_username](https://github.com/appium/ruby_lib/blob/94f3348a8fbec111a7a958063d3a2e643051b2e9/lib/appium_lib/driver.rb#L285)
224
224
 
225
225
  > def sauce_username
226
226
 
@@ -228,7 +228,7 @@ Username for use on Sauce Labs
228
228
 
229
229
  --
230
230
 
231
- ##### [sauce_username=](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/driver.rb#L285)
231
+ ##### [sauce_username=](https://github.com/appium/ruby_lib/blob/94f3348a8fbec111a7a958063d3a2e643051b2e9/lib/appium_lib/driver.rb#L285)
232
232
 
233
233
  > def sauce_username=(value)
234
234
 
@@ -236,7 +236,7 @@ Username for use on Sauce Labs
236
236
 
237
237
  --
238
238
 
239
- ##### [sauce_access_key](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/driver.rb#L287)
239
+ ##### [sauce_access_key](https://github.com/appium/ruby_lib/blob/94f3348a8fbec111a7a958063d3a2e643051b2e9/lib/appium_lib/driver.rb#L287)
240
240
 
241
241
  > def sauce_access_key
242
242
 
@@ -244,7 +244,7 @@ Access Key for use on Sauce Labs
244
244
 
245
245
  --
246
246
 
247
- ##### [sauce_access_key=](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/driver.rb#L287)
247
+ ##### [sauce_access_key=](https://github.com/appium/ruby_lib/blob/94f3348a8fbec111a7a958063d3a2e643051b2e9/lib/appium_lib/driver.rb#L287)
248
248
 
249
249
  > def sauce_access_key=(value)
250
250
 
@@ -252,7 +252,7 @@ Access Key for use on Sauce Labs
252
252
 
253
253
  --
254
254
 
255
- ##### [appium_port](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/driver.rb#L289)
255
+ ##### [appium_port](https://github.com/appium/ruby_lib/blob/94f3348a8fbec111a7a958063d3a2e643051b2e9/lib/appium_lib/driver.rb#L289)
256
256
 
257
257
  > def appium_port
258
258
 
@@ -260,7 +260,7 @@ Appium's server port
260
260
 
261
261
  --
262
262
 
263
- ##### [appium_port=](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/driver.rb#L289)
263
+ ##### [appium_port=](https://github.com/appium/ruby_lib/blob/94f3348a8fbec111a7a958063d3a2e643051b2e9/lib/appium_lib/driver.rb#L289)
264
264
 
265
265
  > def appium_port=(value)
266
266
 
@@ -268,7 +268,7 @@ Appium's server port
268
268
 
269
269
  --
270
270
 
271
- ##### [appium_device](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/driver.rb#L291)
271
+ ##### [appium_device](https://github.com/appium/ruby_lib/blob/94f3348a8fbec111a7a958063d3a2e643051b2e9/lib/appium_lib/driver.rb#L291)
272
272
 
273
273
  > def appium_device
274
274
 
@@ -276,7 +276,7 @@ Device type to request from the appium server
276
276
 
277
277
  --
278
278
 
279
- ##### [appium_device=](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/driver.rb#L291)
279
+ ##### [appium_device=](https://github.com/appium/ruby_lib/blob/94f3348a8fbec111a7a958063d3a2e643051b2e9/lib/appium_lib/driver.rb#L291)
280
280
 
281
281
  > def appium_device=(value)
282
282
 
@@ -284,7 +284,7 @@ Device type to request from the appium server
284
284
 
285
285
  --
286
286
 
287
- ##### [automation_name](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/driver.rb#L294)
287
+ ##### [automation_name](https://github.com/appium/ruby_lib/blob/94f3348a8fbec111a7a958063d3a2e643051b2e9/lib/appium_lib/driver.rb#L294)
288
288
 
289
289
  > def automation_name
290
290
 
@@ -293,7 +293,7 @@ If automation_name is nil, it is not set both client side and server side.
293
293
 
294
294
  --
295
295
 
296
- ##### [appium_server_version](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/driver.rb#L296)
296
+ ##### [appium_server_version](https://github.com/appium/ruby_lib/blob/94f3348a8fbec111a7a958063d3a2e643051b2e9/lib/appium_lib/driver.rb#L296)
297
297
 
298
298
  > def appium_server_version
299
299
 
@@ -314,7 +314,7 @@ __Returns:__
314
314
 
315
315
  --
316
316
 
317
- ##### [appium_debug](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/driver.rb#L298)
317
+ ##### [appium_debug](https://github.com/appium/ruby_lib/blob/94f3348a8fbec111a7a958063d3a2e643051b2e9/lib/appium_lib/driver.rb#L298)
318
318
 
319
319
  > def appium_debug
320
320
 
@@ -322,7 +322,7 @@ Boolean debug mode for the Appium Ruby bindings
322
322
 
323
323
  --
324
324
 
325
- ##### [appium_debug=](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/driver.rb#L298)
325
+ ##### [appium_debug=](https://github.com/appium/ruby_lib/blob/94f3348a8fbec111a7a958063d3a2e643051b2e9/lib/appium_lib/driver.rb#L298)
326
326
 
327
327
  > def appium_debug=(value)
328
328
 
@@ -330,7 +330,7 @@ Boolean debug mode for the Appium Ruby bindings
330
330
 
331
331
  --
332
332
 
333
- ##### [listener](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/driver.rb#L300)
333
+ ##### [listener](https://github.com/appium/ruby_lib/blob/94f3348a8fbec111a7a958063d3a2e643051b2e9/lib/appium_lib/driver.rb#L300)
334
334
 
335
335
  > def listener
336
336
 
@@ -338,7 +338,7 @@ instance of AbstractEventListener for logging support
338
338
 
339
339
  --
340
340
 
341
- ##### [listener=](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/driver.rb#L300)
341
+ ##### [listener=](https://github.com/appium/ruby_lib/blob/94f3348a8fbec111a7a958063d3a2e643051b2e9/lib/appium_lib/driver.rb#L300)
342
342
 
343
343
  > def listener=(value)
344
344
 
@@ -346,7 +346,7 @@ instance of AbstractEventListener for logging support
346
346
 
347
347
  --
348
348
 
349
- ##### [driver](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/driver.rb#L303)
349
+ ##### [driver](https://github.com/appium/ruby_lib/blob/94f3348a8fbec111a7a958063d3a2e643051b2e9/lib/appium_lib/driver.rb#L303)
350
350
 
351
351
  > def driver
352
352
 
@@ -358,7 +358,7 @@ __Returns:__
358
358
 
359
359
  --
360
360
 
361
- ##### [http_client](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/driver.rb#L306)
361
+ ##### [http_client](https://github.com/appium/ruby_lib/blob/94f3348a8fbec111a7a958063d3a2e643051b2e9/lib/appium_lib/driver.rb#L306)
362
362
 
363
363
  > def http_client
364
364
 
@@ -370,26 +370,39 @@ __Returns:__
370
370
 
371
371
  --
372
372
 
373
- ##### [initialize](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/driver.rb#L327)
373
+ ##### [appium_wait_timeout](https://github.com/appium/ruby_lib/blob/94f3348a8fbec111a7a958063d3a2e643051b2e9/lib/appium_lib/driver.rb#L311)
374
374
 
375
- > def initialize(opts = {})
375
+ > def appium_wait_timeout
376
376
 
377
- Creates a new driver
377
+ Return a time wait timeout
378
+ Wait time for ::Appium::Common.wait or ::Appium::Common.wait_true.
379
+ Provide Appium::Drive like { appium_lib: { wait_timeout: 20 } }
378
380
 
379
- ```ruby
380
- require 'rubygems'
381
- require 'appium_lib'
381
+ __Returns:__
382
382
 
383
- # platformName takes a string or a symbol.
383
+      [Integer]
384
384
 
385
- # Start iOS driver
386
- opts = { caps: { platformName: :ios, app: '/path/to/MyiOS.app' } }
387
- Appium::Driver.new(opts).start_driver
385
+ --
388
386
 
389
- # Start Android driver
390
- opts = { caps: { platformName: :android, app: '/path/to/my.apk' } }
391
- Appium::Driver.new(opts).start_driver
392
- ```
387
+ ##### [appium_wait_interval](https://github.com/appium/ruby_lib/blob/94f3348a8fbec111a7a958063d3a2e643051b2e9/lib/appium_lib/driver.rb#L316)
388
+
389
+ > def appium_wait_interval
390
+
391
+ Return a time wait timeout
392
+ Wait interval time for ::Appium::Common.wait or ::Appium::Common.wait_true.
393
+ Provide Appium::Drive like { appium_lib: { wait_interval: 20 } }
394
+
395
+ __Returns:__
396
+
397
+      [Integer]
398
+
399
+ --
400
+
401
+ ##### [initialize](https://github.com/appium/ruby_lib/blob/94f3348a8fbec111a7a958063d3a2e643051b2e9/lib/appium_lib/driver.rb#L356)
402
+
403
+ > def initialize(opts = {})
404
+
405
+ Creates a new driver
393
406
 
394
407
  __Parameters:__
395
408
 
@@ -401,7 +414,7 @@ __Returns:__
401
414
 
402
415
  --
403
416
 
404
- ##### [driver_attributes](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/driver.rb#L399)
417
+ ##### [driver_attributes](https://github.com/appium/ruby_lib/blob/94f3348a8fbec111a7a958063d3a2e643051b2e9/lib/appium_lib/driver.rb#L431)
405
418
 
406
419
  > def driver_attributes
407
420
 
@@ -409,7 +422,7 @@ Returns a hash of the driver attributes
409
422
 
410
423
  --
411
424
 
412
- ##### [device_is_android?](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/driver.rb#L421)
425
+ ##### [device_is_android?](https://github.com/appium/ruby_lib/blob/94f3348a8fbec111a7a958063d3a2e643051b2e9/lib/appium_lib/driver.rb#L455)
413
426
 
414
427
  > def device_is_android?
415
428
 
@@ -421,7 +434,7 @@ __Returns:__
421
434
 
422
435
  --
423
436
 
424
- ##### [automation_name_is_xcuitest?](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/driver.rb#L427)
437
+ ##### [automation_name_is_xcuitest?](https://github.com/appium/ruby_lib/blob/94f3348a8fbec111a7a958063d3a2e643051b2e9/lib/appium_lib/driver.rb#L461)
425
438
 
426
439
  > def automation_name_is_xcuitest?
427
440
 
@@ -433,7 +446,7 @@ __Returns:__
433
446
 
434
447
  --
435
448
 
436
- ##### [check_server_version_xcuitest](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/driver.rb#L434)
449
+ ##### [check_server_version_xcuitest](https://github.com/appium/ruby_lib/blob/94f3348a8fbec111a7a958063d3a2e643051b2e9/lib/appium_lib/driver.rb#L468)
437
450
 
438
451
  > def check_server_version_xcuitest
439
452
 
@@ -446,7 +459,7 @@ __Returns:__
446
459
 
447
460
  --
448
461
 
449
- ##### [appium_client_version](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/driver.rb#L466)
462
+ ##### [appium_client_version](https://github.com/appium/ruby_lib/blob/94f3348a8fbec111a7a958063d3a2e643051b2e9/lib/appium_lib/driver.rb#L500)
450
463
 
451
464
  > def appium_client_version
452
465
 
@@ -464,7 +477,7 @@ __Returns:__
464
477
 
465
478
  --
466
479
 
467
- ##### [absolute_app_path](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/driver.rb#L478)
480
+ ##### [absolute_app_path](https://github.com/appium/ruby_lib/blob/94f3348a8fbec111a7a958063d3a2e643051b2e9/lib/appium_lib/driver.rb#L512)
468
481
 
469
482
  > def self.absolute_app_path(opts)
470
483
 
@@ -481,7 +494,7 @@ __Returns:__
481
494
 
482
495
  --
483
496
 
484
- ##### [server_url](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/driver.rb#L511)
497
+ ##### [server_url](https://github.com/appium/ruby_lib/blob/94f3348a8fbec111a7a958063d3a2e643051b2e9/lib/appium_lib/driver.rb#L545)
485
498
 
486
499
  > def server_url
487
500
 
@@ -493,7 +506,7 @@ __Returns:__
493
506
 
494
507
  --
495
508
 
496
- ##### [restart](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/driver.rb#L522)
509
+ ##### [restart](https://github.com/appium/ruby_lib/blob/94f3348a8fbec111a7a958063d3a2e643051b2e9/lib/appium_lib/driver.rb#L556)
497
510
 
498
511
  > def restart
499
512
 
@@ -505,7 +518,7 @@ __Returns:__
505
518
 
506
519
  --
507
520
 
508
- ##### [screenshot](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/driver.rb#L533)
521
+ ##### [screenshot](https://github.com/appium/ruby_lib/blob/94f3348a8fbec111a7a958063d3a2e643051b2e9/lib/appium_lib/driver.rb#L567)
509
522
 
510
523
  > def screenshot(png_save_path)
511
524
 
@@ -523,7 +536,7 @@ __Returns:__
523
536
 
524
537
  --
525
538
 
526
- ##### [driver_quit](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/driver.rb#L540)
539
+ ##### [driver_quit](https://github.com/appium/ruby_lib/blob/94f3348a8fbec111a7a958063d3a2e643051b2e9/lib/appium_lib/driver.rb#L574)
527
540
 
528
541
  > def driver_quit
529
542
 
@@ -535,7 +548,7 @@ __Returns:__
535
548
 
536
549
  --
537
550
 
538
- ##### [start_driver](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/driver.rb#L550)
551
+ ##### [start_driver](https://github.com/appium/ruby_lib/blob/94f3348a8fbec111a7a958063d3a2e643051b2e9/lib/appium_lib/driver.rb#L584)
539
552
 
540
553
  > def start_driver
541
554
 
@@ -547,7 +560,7 @@ __Returns:__
547
560
 
548
561
  --
549
562
 
550
- ##### [no_wait](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/driver.rb#L588)
563
+ ##### [no_wait](https://github.com/appium/ruby_lib/blob/94f3348a8fbec111a7a958063d3a2e643051b2e9/lib/appium_lib/driver.rb#L622)
551
564
 
552
565
  > def no_wait
553
566
 
@@ -555,7 +568,7 @@ Set implicit wait to zero.
555
568
 
556
569
  --
557
570
 
558
- ##### [set_wait](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/driver.rb#L602)
571
+ ##### [set_wait](https://github.com/appium/ruby_lib/blob/94f3348a8fbec111a7a958063d3a2e643051b2e9/lib/appium_lib/driver.rb#L636)
559
572
 
560
573
  > def set_wait(timeout = nil)
561
574
 
@@ -577,7 +590,7 @@ __Returns:__
577
590
 
578
591
  --
579
592
 
580
- ##### [exists](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/driver.rb#L619)
593
+ ##### [exists](https://github.com/appium/ruby_lib/blob/94f3348a8fbec111a7a958063d3a2e643051b2e9/lib/appium_lib/driver.rb#L653)
581
594
 
582
595
  > def exists(pre_check = 0, post_check = @default_wait)
583
596
 
@@ -589,13 +602,11 @@ exists { button('sign in') } ? puts('true') : puts('false')
589
602
 
590
603
  __Parameters:__
591
604
 
592
-      [Integer] pre_check - the amount in seconds to set the
593
- wait to before checking existance
605
+      [Integer] pre_check - The amount in seconds to set the
606
+ wait to before checking existence
594
607
 
595
-      [Integer] post_check - the amount in seconds to set the
596
- wait to after checking existance
597
-
598
-      [Block] search_block - the block to call
608
+      [Integer] post_check - The amount in seconds to set the
609
+ wait to after checking existence
599
610
 
600
611
  __Returns:__
601
612
 
@@ -603,7 +614,7 @@ __Returns:__
603
614
 
604
615
  --
605
616
 
606
- ##### [execute_script](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/driver.rb#L643)
617
+ ##### [execute_script](https://github.com/appium/ruby_lib/blob/94f3348a8fbec111a7a958063d3a2e643051b2e9/lib/appium_lib/driver.rb#L677)
607
618
 
608
619
  > def execute_script(script, *args)
609
620
 
@@ -611,9 +622,9 @@ The same as @driver.execute_script
611
622
 
612
623
  __Parameters:__
613
624
 
614
-      [String] script - the script to execute
625
+      [String] script - The script to execute
615
626
 
616
-      [*args] args - the args to pass to the script
627
+      [*args] args - The args to pass to the script
617
628
 
618
629
  __Returns:__
619
630
 
@@ -621,7 +632,7 @@ __Returns:__
621
632
 
622
633
  --
623
634
 
624
- ##### [find_elements](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/driver.rb#L651)
635
+ ##### [find_elements](https://github.com/appium/ruby_lib/blob/94f3348a8fbec111a7a958063d3a2e643051b2e9/lib/appium_lib/driver.rb#L685)
625
636
 
626
637
  > def find_elements(*args)
627
638
 
@@ -629,7 +640,7 @@ Calls @driver.find_elements
629
640
 
630
641
  __Parameters:__
631
642
 
632
-      [*args] args - the args to use
643
+      [*args] args - The args to use
633
644
 
634
645
  __Returns:__
635
646
 
@@ -637,7 +648,7 @@ __Returns:__
637
648
 
638
649
  --
639
650
 
640
- ##### [find_element](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/driver.rb#L659)
651
+ ##### [find_element](https://github.com/appium/ruby_lib/blob/94f3348a8fbec111a7a958063d3a2e643051b2e9/lib/appium_lib/driver.rb#L693)
641
652
 
642
653
  > def find_element(*args)
643
654
 
@@ -645,7 +656,7 @@ Calls @driver.find_elements
645
656
 
646
657
  __Parameters:__
647
658
 
648
-      [*args] args - the args to use
659
+      [*args] args - The args to use
649
660
 
650
661
  __Returns:__
651
662
 
@@ -653,7 +664,7 @@ __Returns:__
653
664
 
654
665
  --
655
666
 
656
- ##### [set_location](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/driver.rb#L672)
667
+ ##### [set_location](https://github.com/appium/ruby_lib/blob/94f3348a8fbec111a7a958063d3a2e643051b2e9/lib/appium_lib/driver.rb#L706)
657
668
 
658
669
  > def set_location(opts = {})
659
670
 
@@ -669,7 +680,7 @@ __Returns:__
669
680
 
670
681
  --
671
682
 
672
- ##### [x](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/driver.rb#L682)
683
+ ##### [x](https://github.com/appium/ruby_lib/blob/94f3348a8fbec111a7a958063d3a2e643051b2e9/lib/appium_lib/driver.rb#L716)
673
684
 
674
685
  > def x
675
686
 
@@ -682,7 +693,7 @@ __Returns:__
682
693
 
683
694
  --
684
695
 
685
- ##### [set_automation_name_if_nil](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/driver.rb#L691)
696
+ ##### [set_automation_name_if_nil](https://github.com/appium/ruby_lib/blob/94f3348a8fbec111a7a958063d3a2e643051b2e9/lib/appium_lib/driver.rb#L725)
686
697
 
687
698
  > def set_automation_name_if_nil
688
699
 
@@ -691,7 +702,7 @@ Since @automation_name is set only client side before start_driver is called.
691
702
 
692
703
  --
693
704
 
694
- ##### [logger=](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/logger.rb#L13)
705
+ ##### [logger=](https://github.com/appium/ruby_lib/blob/94f3348a8fbec111a7a958063d3a2e643051b2e9/lib/appium_lib/logger.rb#L13)
695
706
 
696
707
  > def logger=(value)
697
708
 
@@ -703,7 +714,7 @@ __Parameters:__
703
714
 
704
715
  --
705
716
 
706
- ##### [logger](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/logger.rb#L17)
717
+ ##### [logger](https://github.com/appium/ruby_lib/blob/94f3348a8fbec111a7a958063d3a2e643051b2e9/lib/appium_lib/logger.rb#L17)
707
718
 
708
719
  > def logger
709
720
 
@@ -711,7 +722,7 @@ __Parameters:__
711
722
 
712
723
  --
713
724
 
714
- ##### [app_strings](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/device/device.rb#L7)
725
+ ##### [app_strings](https://github.com/appium/ruby_lib/blob/94f3348a8fbec111a7a958063d3a2e643051b2e9/lib/appium_lib/device/device.rb#L7)
715
726
 
716
727
  > def app_strings
717
728
 
@@ -722,7 +733,7 @@ app_strings #=> "TransitionsTitle"=>"Transitions", "WebTitle"=>"Web"
722
733
 
723
734
  --
724
735
 
725
- ##### [background_app](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/device/device.rb#L13)
736
+ ##### [background_app](https://github.com/appium/ruby_lib/blob/94f3348a8fbec111a7a958063d3a2e643051b2e9/lib/appium_lib/device/device.rb#L13)
726
737
 
727
738
  > def background_app
728
739
 
@@ -731,7 +742,7 @@ This is a blocking application
731
742
 
732
743
  --
733
744
 
734
- ##### [current_activity](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/device/device.rb#L18)
745
+ ##### [current_activity](https://github.com/appium/ruby_lib/blob/94f3348a8fbec111a7a958063d3a2e643051b2e9/lib/appium_lib/device/device.rb#L18)
735
746
 
736
747
  > def current_activity
737
748
 
@@ -739,7 +750,7 @@ This is a blocking application
739
750
 
740
751
  --
741
752
 
742
- ##### [launch_app](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/device/device.rb#L20)
753
+ ##### [launch_app](https://github.com/appium/ruby_lib/blob/94f3348a8fbec111a7a958063d3a2e643051b2e9/lib/appium_lib/device/device.rb#L20)
743
754
 
744
755
  > def launch_app
745
756
 
@@ -747,7 +758,7 @@ Start the simulator and application configured with desired capabilities
747
758
 
748
759
  --
749
760
 
750
- ##### [reset](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/device/device.rb#L23)
761
+ ##### [reset](https://github.com/appium/ruby_lib/blob/94f3348a8fbec111a7a958063d3a2e643051b2e9/lib/appium_lib/device/device.rb#L23)
751
762
 
752
763
  > def reset
753
764
 
@@ -755,7 +766,7 @@ Reset the device, relaunching the application.
755
766
 
756
767
  --
757
768
 
758
- ##### [shake](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/device/device.rb#L26)
769
+ ##### [shake](https://github.com/appium/ruby_lib/blob/94f3348a8fbec111a7a958063d3a2e643051b2e9/lib/appium_lib/device/device.rb#L26)
759
770
 
760
771
  > def shake
761
772
 
@@ -763,7 +774,7 @@ Cause the device to shake
763
774
 
764
775
  --
765
776
 
766
- ##### [toggle_flight_mode](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/device/device.rb#L29)
777
+ ##### [toggle_flight_mode](https://github.com/appium/ruby_lib/blob/94f3348a8fbec111a7a958063d3a2e643051b2e9/lib/appium_lib/device/device.rb#L29)
767
778
 
768
779
  > def toggle_flight_mode
769
780
 
@@ -771,7 +782,7 @@ Toggle flight mode on or off
771
782
 
772
783
  --
773
784
 
774
- ##### [device_locked?](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/device/device.rb#L32)
785
+ ##### [device_locked?](https://github.com/appium/ruby_lib/blob/94f3348a8fbec111a7a958063d3a2e643051b2e9/lib/appium_lib/device/device.rb#L32)
775
786
 
776
787
  > def device_locked?
777
788
 
@@ -779,7 +790,7 @@ Toggle flight mode on or off
779
790
 
780
791
  --
781
792
 
782
- ##### [hide_keyboard](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/device/device.rb#L34)
793
+ ##### [hide_keyboard](https://github.com/appium/ruby_lib/blob/94f3348a8fbec111a7a958063d3a2e643051b2e9/lib/appium_lib/device/device.rb#L34)
783
794
 
784
795
  > def hide_keyboard
785
796
 
@@ -787,12 +798,12 @@ Hide the onscreen keyboard
787
798
 
788
799
  __Parameters:__
789
800
 
790
-      [String] close_key - the name of the key which closes the keyboard.
801
+      [String] close_key - The name of the key which closes the keyboard.
791
802
  Defaults to 'Done'.
792
803
 
793
804
  --
794
805
 
795
- ##### [press_keycode](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/device/device.rb#L43)
806
+ ##### [press_keycode](https://github.com/appium/ruby_lib/blob/94f3348a8fbec111a7a958063d3a2e643051b2e9/lib/appium_lib/device/device.rb#L43)
796
807
 
797
808
  > def press_keycode
798
809
 
@@ -807,7 +818,7 @@ __Parameters:__
807
818
 
808
819
  --
809
820
 
810
- ##### [long_press_keycode](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/device/device.rb#L49)
821
+ ##### [long_press_keycode](https://github.com/appium/ruby_lib/blob/94f3348a8fbec111a7a958063d3a2e643051b2e9/lib/appium_lib/device/device.rb#L49)
811
822
 
812
823
  > def long_press_keycode
813
824
 
@@ -822,7 +833,7 @@ __Parameters:__
822
833
 
823
834
  --
824
835
 
825
- ##### [push_file](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/device/device.rb#L55)
836
+ ##### [push_file](https://github.com/appium/ruby_lib/blob/94f3348a8fbec111a7a958063d3a2e643051b2e9/lib/appium_lib/device/device.rb#L55)
826
837
 
827
838
  > def push_file
828
839
 
@@ -836,7 +847,7 @@ __Parameters:__
836
847
 
837
848
  --
838
849
 
839
- ##### [pull_file](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/device/device.rb#L60)
850
+ ##### [pull_file](https://github.com/appium/ruby_lib/blob/94f3348a8fbec111a7a958063d3a2e643051b2e9/lib/appium_lib/device/device.rb#L60)
840
851
 
841
852
  > def pull_file
842
853
 
@@ -853,7 +864,7 @@ __Parameters:__
853
864
 
854
865
  --
855
866
 
856
- ##### [pull_folder](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/device/device.rb#L70)
867
+ ##### [pull_folder](https://github.com/appium/ruby_lib/blob/94f3348a8fbec111a7a958063d3a2e643051b2e9/lib/appium_lib/device/device.rb#L70)
857
868
 
858
869
  > def pull_folder
859
870
 
@@ -868,7 +879,7 @@ __Parameters:__
868
879
 
869
880
  --
870
881
 
871
- ##### [touch_id](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/device/device.rb#L78)
882
+ ##### [touch_id](https://github.com/appium/ruby_lib/blob/94f3348a8fbec111a7a958063d3a2e643051b2e9/lib/appium_lib/device/device.rb#L78)
872
883
 
873
884
  > def touch_id
874
885
 
@@ -885,7 +896,7 @@ Defaults to true.
885
896
 
886
897
  --
887
898
 
888
- ##### [end_coverage](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/device/device.rb#L87)
899
+ ##### [end_coverage](https://github.com/appium/ruby_lib/blob/94f3348a8fbec111a7a958063d3a2e643051b2e9/lib/appium_lib/device/device.rb#L87)
889
900
 
890
901
  > def end_coverage
891
902
 
@@ -899,7 +910,7 @@ __Parameters:__
899
910
 
900
911
  --
901
912
 
902
- ##### [get_settings](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/device/device.rb#L92)
913
+ ##### [get_settings](https://github.com/appium/ruby_lib/blob/94f3348a8fbec111a7a958063d3a2e643051b2e9/lib/appium_lib/device/device.rb#L92)
903
914
 
904
915
  > def get_settings
905
916
 
@@ -907,7 +918,61 @@ Get appium Settings for current test session
907
918
 
908
919
  --
909
920
 
910
- ##### [extend_search_contexts](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/device/device.rb#L356)
921
+ ##### [update_settings](https://github.com/appium/ruby_lib/blob/94f3348a8fbec111a7a958063d3a2e643051b2e9/lib/appium_lib/device/device.rb#L95)
922
+
923
+ > def update_settings
924
+
925
+ Update appium Settings for current test session
926
+
927
+ __Parameters:__
928
+
929
+      [Hash] settings - Settings to update, keys are settings, values to value to set each setting to
930
+
931
+ --
932
+
933
+ ##### [start_activity](https://github.com/appium/ruby_lib/blob/94f3348a8fbec111a7a958063d3a2e643051b2e9/lib/appium_lib/device/device.rb#L99)
934
+
935
+ > def start_activity
936
+
937
+ Start a new activity within the current app or launch a new app and start the target activity.
938
+
939
+ Android only.
940
+ ```ruby
941
+ start_activity app_package: 'io.appium.android.apis',
942
+ app_activity: '.accessibility.AccessibilityNodeProviderActivity'
943
+ ```
944
+
945
+ --
946
+
947
+ ##### [get_network_connection](https://github.com/appium/ruby_lib/blob/94f3348a8fbec111a7a958063d3a2e643051b2e9/lib/appium_lib/device/device.rb#L113)
948
+
949
+ > def get_network_connection
950
+
951
+ Get the device network connection current status
952
+ See set_network_connection method for return value
953
+
954
+ --
955
+
956
+ ##### [set_network_connection](https://github.com/appium/ruby_lib/blob/94f3348a8fbec111a7a958063d3a2e643051b2e9/lib/appium_lib/device/device.rb#L117)
957
+
958
+ > def set_network_connection
959
+
960
+ Set the device network connection mode
961
+ Value (Alias) | Data | Wifi | Airplane Mode
962
+ -------------------------------------------------
963
+ 1 (Airplane Mode) | 0 | 0 | 1
964
+ 6 (All network on) | 1 | 1 | 0
965
+ 4 (Data only) | 1 | 0 | 0
966
+ 2 (Wifi only) | 0 | 1 | 0
967
+ 0 (None) | 0 | 0 | 0
968
+
969
+ __Parameters:__
970
+
971
+      [String] path - Bit mask that represent the network mode
972
+
973
+ --
974
+
975
+ ##### [extend_search_contexts](https://github.com/appium/ruby_lib/blob/94f3348a8fbec111a7a958063d3a2e643051b2e9/lib/appium_lib/device/device.rb#L360)
911
976
 
912
977
  > def extend_search_contexts
913
978
 
@@ -915,7 +980,7 @@ Get appium Settings for current test session
915
980
 
916
981
  --
917
982
 
918
- ##### [find_element](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/device/device.rb#L356)
983
+ ##### [find_element](https://github.com/appium/ruby_lib/blob/94f3348a8fbec111a7a958063d3a2e643051b2e9/lib/appium_lib/device/device.rb#L360)
919
984
 
920
985
  > def find_element
921
986
 
@@ -923,7 +988,7 @@ Get appium Settings for current test session
923
988
 
924
989
  --
925
990
 
926
- ##### [find_elements](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/device/device.rb#L356)
991
+ ##### [find_elements](https://github.com/appium/ruby_lib/blob/94f3348a8fbec111a7a958063d3a2e643051b2e9/lib/appium_lib/device/device.rb#L360)
927
992
 
928
993
  > def find_elements
929
994
 
@@ -935,7 +1000,7 @@ find_element/s with their accessibility_id
935
1000
 
936
1001
  --
937
1002
 
938
- ##### [add_touch_actions](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/device/device.rb#L387)
1003
+ ##### [add_touch_actions](https://github.com/appium/ruby_lib/blob/94f3348a8fbec111a7a958063d3a2e643051b2e9/lib/appium_lib/device/device.rb#L391)
939
1004
 
940
1005
  > def add_touch_actions
941
1006
 
@@ -943,7 +1008,7 @@ find_element/s with their accessibility_id
943
1008
 
944
1009
  --
945
1010
 
946
- ##### [add_ime_actions](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/device/device.rb#L410)
1011
+ ##### [add_ime_actions](https://github.com/appium/ruby_lib/blob/94f3348a8fbec111a7a958063d3a2e643051b2e9/lib/appium_lib/device/device.rb#L414)
947
1012
 
948
1013
  > def add_ime_actions
949
1014
 
@@ -951,7 +1016,7 @@ find_element/s with their accessibility_id
951
1016
 
952
1017
  --
953
1018
 
954
- ##### [set_context](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/device/device.rb#L485)
1019
+ ##### [set_context](https://github.com/appium/ruby_lib/blob/94f3348a8fbec111a7a958063d3a2e643051b2e9/lib/appium_lib/device/device.rb#L489)
955
1020
 
956
1021
  > def set_context
957
1022
 
@@ -966,7 +1031,7 @@ __Parameters:__
966
1031
 
967
1032
  --
968
1033
 
969
- ##### [current_context](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/device/device.rb#L493)
1034
+ ##### [current_context](https://github.com/appium/ruby_lib/blob/94f3348a8fbec111a7a958063d3a2e643051b2e9/lib/appium_lib/device/device.rb#L497)
970
1035
 
971
1036
  > def current_context
972
1037
 
@@ -978,7 +1043,7 @@ __Returns:__
978
1043
 
979
1044
  --
980
1045
 
981
- ##### [available_contexts](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/device/device.rb#L496)
1046
+ ##### [available_contexts](https://github.com/appium/ruby_lib/blob/94f3348a8fbec111a7a958063d3a2e643051b2e9/lib/appium_lib/device/device.rb#L500)
982
1047
 
983
1048
  > def available_contexts
984
1049
 
@@ -990,7 +1055,7 @@ __Returns:__
990
1055
 
991
1056
  --
992
1057
 
993
- ##### [within_context](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/device/device.rb#L506)
1058
+ ##### [within_context](https://github.com/appium/ruby_lib/blob/94f3348a8fbec111a7a958063d3a2e643051b2e9/lib/appium_lib/device/device.rb#L510)
994
1059
 
995
1060
  > def within_context(context)
996
1061
 
@@ -1006,7 +1071,7 @@ __Parameters:__
1006
1071
 
1007
1072
  --
1008
1073
 
1009
- ##### [switch_to_default_context](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/device/device.rb#L514)
1074
+ ##### [switch_to_default_context](https://github.com/appium/ruby_lib/blob/94f3348a8fbec111a7a958063d3a2e643051b2e9/lib/appium_lib/device/device.rb#L518)
1010
1075
 
1011
1076
  > def switch_to_default_context
1012
1077
 
@@ -1014,7 +1079,7 @@ Change to the default context. This is equivalent to `set_context nil`.
1014
1079
 
1015
1080
  --
1016
1081
 
1017
- ##### [pinch](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/device/multi_touch.rb#L28)
1082
+ ##### [pinch](https://github.com/appium/ruby_lib/blob/94f3348a8fbec111a7a958063d3a2e643051b2e9/lib/appium_lib/device/multi_touch.rb#L28)
1018
1083
 
1019
1084
  > def pinch(percentage = 25, auto_perform = true)
1020
1085
 
@@ -1033,7 +1098,7 @@ __Parameters:__
1033
1098
 
1034
1099
  --
1035
1100
 
1036
- ##### [zoom](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/device/multi_touch.rb#L64)
1101
+ ##### [zoom](https://github.com/appium/ruby_lib/blob/94f3348a8fbec111a7a958063d3a2e643051b2e9/lib/appium_lib/device/multi_touch.rb#L57)
1037
1102
 
1038
1103
  > def zoom(percentage = 200, auto_perform = true)
1039
1104
 
@@ -1052,7 +1117,55 @@ __Parameters:__
1052
1117
 
1053
1118
  --
1054
1119
 
1055
- ##### [initialize](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/device/multi_touch.rb#L95)
1120
+ ##### [pinch_for_xcuitest](https://github.com/appium/ruby_lib/blob/94f3348a8fbec111a7a958063d3a2e643051b2e9/lib/appium_lib/device/multi_touch.rb#L79)
1121
+
1122
+ > def pinch_for_xcuitest(rate)
1123
+
1124
+
1125
+
1126
+ --
1127
+
1128
+ ##### [pinch_android](https://github.com/appium/ruby_lib/blob/94f3348a8fbec111a7a958063d3a2e643051b2e9/lib/appium_lib/device/multi_touch.rb#L94)
1129
+
1130
+ > def pinch_android(rate)
1131
+
1132
+
1133
+
1134
+ --
1135
+
1136
+ ##### [pinch_ios](https://github.com/appium/ruby_lib/blob/94f3348a8fbec111a7a958063d3a2e643051b2e9/lib/appium_lib/device/multi_touch.rb#L108)
1137
+
1138
+ > def pinch_ios(rate)
1139
+
1140
+
1141
+
1142
+ --
1143
+
1144
+ ##### [zoom_for_xcuitest](https://github.com/appium/ruby_lib/blob/94f3348a8fbec111a7a958063d3a2e643051b2e9/lib/appium_lib/device/multi_touch.rb#L122)
1145
+
1146
+ > def zoom_for_xcuitest(rate)
1147
+
1148
+
1149
+
1150
+ --
1151
+
1152
+ ##### [zoom_android](https://github.com/appium/ruby_lib/blob/94f3348a8fbec111a7a958063d3a2e643051b2e9/lib/appium_lib/device/multi_touch.rb#L137)
1153
+
1154
+ > def zoom_android(rate)
1155
+
1156
+
1157
+
1158
+ --
1159
+
1160
+ ##### [zoom_ios](https://github.com/appium/ruby_lib/blob/94f3348a8fbec111a7a958063d3a2e643051b2e9/lib/appium_lib/device/multi_touch.rb#L151)
1161
+
1162
+ > def zoom_ios(rate)
1163
+
1164
+
1165
+
1166
+ --
1167
+
1168
+ ##### [initialize](https://github.com/appium/ruby_lib/blob/94f3348a8fbec111a7a958063d3a2e643051b2e9/lib/appium_lib/device/multi_touch.rb#L167)
1056
1169
 
1057
1170
  > def initialize
1058
1171
 
@@ -1064,7 +1177,7 @@ __Returns:__
1064
1177
 
1065
1178
  --
1066
1179
 
1067
- ##### [add](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/device/multi_touch.rb#L101)
1180
+ ##### [add](https://github.com/appium/ruby_lib/blob/94f3348a8fbec111a7a958063d3a2e643051b2e9/lib/appium_lib/device/multi_touch.rb#L173)
1068
1181
 
1069
1182
  > def add(chain)
1070
1183
 
@@ -1076,7 +1189,7 @@ __Parameters:__
1076
1189
 
1077
1190
  --
1078
1191
 
1079
- ##### [perform](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/device/multi_touch.rb#L106)
1192
+ ##### [perform](https://github.com/appium/ruby_lib/blob/94f3348a8fbec111a7a958063d3a2e643051b2e9/lib/appium_lib/device/multi_touch.rb#L178)
1080
1193
 
1081
1194
  > def perform
1082
1195
 
@@ -1084,7 +1197,7 @@ Ask Appium to perform the actions
1084
1197
 
1085
1198
  --
1086
1199
 
1087
- ##### [ACTIONS](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/device/touch_actions.rb#L11)
1200
+ ##### [ACTIONS](https://github.com/appium/ruby_lib/blob/94f3348a8fbec111a7a958063d3a2e643051b2e9/lib/appium_lib/device/touch_actions.rb#L11)
1088
1201
 
1089
1202
  > ACTIONS = [:move_to, :long_press, :double_tap, :two_finger_tap, :press, :release, :tap, :wait, :perform].freeze
1090
1203
 
@@ -1092,7 +1205,7 @@ Ask Appium to perform the actions
1092
1205
 
1093
1206
  --
1094
1207
 
1095
- ##### [COMPLEX_ACTIONS](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/device/touch_actions.rb#L12)
1208
+ ##### [COMPLEX_ACTIONS](https://github.com/appium/ruby_lib/blob/94f3348a8fbec111a7a958063d3a2e643051b2e9/lib/appium_lib/device/touch_actions.rb#L12)
1096
1209
 
1097
1210
  > COMPLEX_ACTIONS = [:swipe].freeze
1098
1211
 
@@ -1100,7 +1213,7 @@ Ask Appium to perform the actions
1100
1213
 
1101
1214
  --
1102
1215
 
1103
- ##### [actions](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/device/touch_actions.rb#L26)
1216
+ ##### [actions](https://github.com/appium/ruby_lib/blob/94f3348a8fbec111a7a958063d3a2e643051b2e9/lib/appium_lib/device/touch_actions.rb#L26)
1104
1217
 
1105
1218
  > def actions
1106
1219
 
@@ -1108,7 +1221,7 @@ Returns the value of attribute actions
1108
1221
 
1109
1222
  --
1110
1223
 
1111
- ##### [initialize](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/device/touch_actions.rb#L28)
1224
+ ##### [initialize](https://github.com/appium/ruby_lib/blob/94f3348a8fbec111a7a958063d3a2e643051b2e9/lib/appium_lib/device/touch_actions.rb#L28)
1112
1225
 
1113
1226
  > def initialize
1114
1227
 
@@ -1120,19 +1233,21 @@ __Returns:__
1120
1233
 
1121
1234
  --
1122
1235
 
1123
- ##### [move_to](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/device/touch_actions.rb#L36)
1236
+ ##### [move_to](https://github.com/appium/ruby_lib/blob/94f3348a8fbec111a7a958063d3a2e643051b2e9/lib/appium_lib/device/touch_actions.rb#L39)
1124
1237
 
1125
1238
  > def move_to(opts)
1126
1239
 
1127
1240
  Move to the given co-ordinates.
1128
1241
 
1242
+ `move_to`'s `x` and `y` have two case. One is working as coordinate, the other is working as offset.
1243
+
1129
1244
  __Parameters:__
1130
1245
 
1131
1246
       [Hash] opts - a customizable set of options
1132
1247
 
1133
1248
  --
1134
1249
 
1135
- ##### [long_press](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/device/touch_actions.rb#L50)
1250
+ ##### [long_press](https://github.com/appium/ruby_lib/blob/94f3348a8fbec111a7a958063d3a2e643051b2e9/lib/appium_lib/device/touch_actions.rb#L53)
1136
1251
 
1137
1252
  > def long_press(opts)
1138
1253
 
@@ -1153,7 +1268,7 @@ __Parameters:__
1153
1268
 
1154
1269
  --
1155
1270
 
1156
- ##### [press](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/device/touch_actions.rb#L62)
1271
+ ##### [press](https://github.com/appium/ruby_lib/blob/94f3348a8fbec111a7a958063d3a2e643051b2e9/lib/appium_lib/device/touch_actions.rb#L65)
1157
1272
 
1158
1273
  > def press(opts)
1159
1274
 
@@ -1166,7 +1281,7 @@ __Parameters:__
1166
1281
 
1167
1282
  --
1168
1283
 
1169
- ##### [release](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/device/touch_actions.rb#L73)
1284
+ ##### [release](https://github.com/appium/ruby_lib/blob/94f3348a8fbec111a7a958063d3a2e643051b2e9/lib/appium_lib/device/touch_actions.rb#L76)
1170
1285
 
1171
1286
  > def release(opts = nil)
1172
1287
 
@@ -1178,7 +1293,7 @@ __Parameters:__
1178
1293
 
1179
1294
  --
1180
1295
 
1181
- ##### [tap](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/device/touch_actions.rb#L85)
1296
+ ##### [tap](https://github.com/appium/ruby_lib/blob/94f3348a8fbec111a7a958063d3a2e643051b2e9/lib/appium_lib/device/touch_actions.rb#L88)
1182
1297
 
1183
1298
  > def tap(opts)
1184
1299
 
@@ -1191,7 +1306,7 @@ __Parameters:__
1191
1306
 
1192
1307
  --
1193
1308
 
1194
- ##### [double_tap](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/device/touch_actions.rb#L98)
1309
+ ##### [double_tap](https://github.com/appium/ruby_lib/blob/94f3348a8fbec111a7a958063d3a2e643051b2e9/lib/appium_lib/device/touch_actions.rb#L101)
1195
1310
 
1196
1311
  > def double_tap(opts)
1197
1312
 
@@ -1203,7 +1318,7 @@ __Parameters:__
1203
1318
 
1204
1319
  --
1205
1320
 
1206
- ##### [two_finger_tap](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/device/touch_actions.rb#L109)
1321
+ ##### [two_finger_tap](https://github.com/appium/ruby_lib/blob/94f3348a8fbec111a7a958063d3a2e643051b2e9/lib/appium_lib/device/touch_actions.rb#L112)
1207
1322
 
1208
1323
  > def two_finger_tap(opts)
1209
1324
 
@@ -1215,7 +1330,7 @@ __Parameters:__
1215
1330
 
1216
1331
  --
1217
1332
 
1218
- ##### [wait](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/device/touch_actions.rb#L117)
1333
+ ##### [wait](https://github.com/appium/ruby_lib/blob/94f3348a8fbec111a7a958063d3a2e643051b2e9/lib/appium_lib/device/touch_actions.rb#L120)
1219
1334
 
1220
1335
  > def wait(milliseconds)
1221
1336
 
@@ -1227,7 +1342,7 @@ __Parameters:__
1227
1342
 
1228
1343
  --
1229
1344
 
1230
- ##### [swipe](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/device/touch_actions.rb#L132)
1345
+ ##### [swipe](https://github.com/appium/ruby_lib/blob/94f3348a8fbec111a7a958063d3a2e643051b2e9/lib/appium_lib/device/touch_actions.rb#L143)
1231
1346
 
1232
1347
  > def swipe(opts, ele = nil)
1233
1348
 
@@ -1235,13 +1350,20 @@ Convenience method to peform a swipe.
1235
1350
 
1236
1351
  Note that iOS 7 simulators have broken swipe.
1237
1352
 
1353
+ For iOS: Use `offset_x` and `offset_y` to define the end point.
1354
+
1355
+ For Android: Use `end_x` and `end_y` to define the end point.
1356
+
1357
+ If you'd like more details, please read tests and its log samples in
1358
+ `ios_tests/lib/ios/specs/device/touch_actions.rb` and `ios_tests/lib/ios/specs/device/touch_actions.rb`
1359
+
1238
1360
  __Parameters:__
1239
1361
 
1240
1362
       [Hash] opts - a customizable set of options
1241
1363
 
1242
1364
  --
1243
1365
 
1244
- ##### [perform](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/device/touch_actions.rb#L166)
1366
+ ##### [perform](https://github.com/appium/ruby_lib/blob/94f3348a8fbec111a7a958063d3a2e643051b2e9/lib/appium_lib/device/touch_actions.rb#L168)
1245
1367
 
1246
1368
  > def perform
1247
1369
 
@@ -1249,7 +1371,7 @@ Ask the driver to perform all actions in this action chain.
1249
1371
 
1250
1372
  --
1251
1373
 
1252
- ##### [cancel](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/device/touch_actions.rb#L172)
1374
+ ##### [cancel](https://github.com/appium/ruby_lib/blob/94f3348a8fbec111a7a958063d3a2e643051b2e9/lib/appium_lib/device/touch_actions.rb#L174)
1253
1375
 
1254
1376
  > def cancel
1255
1377
 
@@ -1257,7 +1379,15 @@ Does nothing, currently.
1257
1379
 
1258
1380
  --
1259
1381
 
1260
- ##### [chain_method](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/device/touch_actions.rb#L180)
1382
+ ##### [swipe_coordinates](https://github.com/appium/ruby_lib/blob/94f3348a8fbec111a7a958063d3a2e643051b2e9/lib/appium_lib/device/touch_actions.rb#L180)
1383
+
1384
+ > def swipe_coordinates(end_x: nil, end_y: nil, offset_x: nil, offset_y: nil)
1385
+
1386
+
1387
+
1388
+ --
1389
+
1390
+ ##### [chain_method](https://github.com/appium/ruby_lib/blob/94f3348a8fbec111a7a958063d3a2e643051b2e9/lib/appium_lib/device/touch_actions.rb#L198)
1261
1391
 
1262
1392
  > def chain_method(method, args = nil)
1263
1393
 
@@ -1265,7 +1395,7 @@ Does nothing, currently.
1265
1395
 
1266
1396
  --
1267
1397
 
1268
- ##### [args_with_ele_ref](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/device/touch_actions.rb#L186)
1398
+ ##### [args_with_ele_ref](https://github.com/appium/ruby_lib/blob/94f3348a8fbec111a7a958063d3a2e643051b2e9/lib/appium_lib/device/touch_actions.rb#L204)
1269
1399
 
1270
1400
  > def args_with_ele_ref(args)
1271
1401
 
@@ -1273,7 +1403,7 @@ Does nothing, currently.
1273
1403
 
1274
1404
  --
1275
1405
 
1276
- ##### [_generic_wait](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/common/wait.rb#L9)
1406
+ ##### [_generic_wait](https://github.com/appium/ruby_lib/blob/94f3348a8fbec111a7a958063d3a2e643051b2e9/lib/appium_lib/common/wait.rb#L9)
1277
1407
 
1278
1408
  > def _generic_wait(opts = {})
1279
1409
 
@@ -1282,7 +1412,7 @@ https://github.com/SeleniumHQ/selenium/blob/cf501dda3f0ed12233de51ce8170c0e8090f
1282
1412
 
1283
1413
  --
1284
1414
 
1285
- ##### [_process_wait_opts](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/common/wait.rb#L48)
1415
+ ##### [_process_wait_opts](https://github.com/appium/ruby_lib/blob/94f3348a8fbec111a7a958063d3a2e643051b2e9/lib/appium_lib/common/wait.rb#L48)
1286
1416
 
1287
1417
  > def _process_wait_opts(opts)
1288
1418
 
@@ -1290,7 +1420,7 @@ process opts before calling _generic_wait
1290
1420
 
1291
1421
  --
1292
1422
 
1293
- ##### [wait_true](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/common/wait.rb#L69)
1423
+ ##### [wait_true](https://github.com/appium/ruby_lib/blob/94f3348a8fbec111a7a958063d3a2e643051b2e9/lib/appium_lib/common/wait.rb#L69)
1294
1424
 
1295
1425
  > def wait_true(opts = {}, &block)
1296
1426
 
@@ -1310,7 +1440,7 @@ __Parameters:__
1310
1440
 
1311
1441
  --
1312
1442
 
1313
- ##### [wait](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/common/wait.rb#L87)
1443
+ ##### [wait](https://github.com/appium/ruby_lib/blob/94f3348a8fbec111a7a958063d3a2e643051b2e9/lib/appium_lib/common/wait.rb#L87)
1314
1444
 
1315
1445
  > def wait(opts = {}, &block)
1316
1446
 
@@ -1328,7 +1458,7 @@ __Parameters:__
1328
1458
 
1329
1459
  --
1330
1460
 
1331
- ##### [ignore](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/common/helper.rb#L24)
1461
+ ##### [ignore](https://github.com/appium/ruby_lib/blob/94f3348a8fbec111a7a958063d3a2e643051b2e9/lib/appium_lib/common/helper.rb#L24)
1332
1462
 
1333
1463
  > def ignore
1334
1464
 
@@ -1336,7 +1466,7 @@ Return yield and ignore any exceptions.
1336
1466
 
1337
1467
  --
1338
1468
 
1339
- ##### [back](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/common/helper.rb#L31)
1469
+ ##### [back](https://github.com/appium/ruby_lib/blob/94f3348a8fbec111a7a958063d3a2e643051b2e9/lib/appium_lib/common/helper.rb#L31)
1340
1470
 
1341
1471
  > def back
1342
1472
 
@@ -1348,7 +1478,7 @@ __Returns:__
1348
1478
 
1349
1479
  --
1350
1480
 
1351
- ##### [session_id](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/common/helper.rb#L36)
1481
+ ##### [session_id](https://github.com/appium/ruby_lib/blob/94f3348a8fbec111a7a958063d3a2e643051b2e9/lib/appium_lib/common/helper.rb#L36)
1352
1482
 
1353
1483
  > def session_id
1354
1484
 
@@ -1356,7 +1486,7 @@ For Sauce Labs reporting. Returns the current session id.
1356
1486
 
1357
1487
  --
1358
1488
 
1359
- ##### [xpath](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/common/helper.rb#L44)
1489
+ ##### [xpath](https://github.com/appium/ruby_lib/blob/94f3348a8fbec111a7a958063d3a2e643051b2e9/lib/appium_lib/common/helper.rb#L44)
1360
1490
 
1361
1491
  > def xpath(xpath_str)
1362
1492
 
@@ -1372,7 +1502,7 @@ __Returns:__
1372
1502
 
1373
1503
  --
1374
1504
 
1375
- ##### [xpaths](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/common/helper.rb#L52)
1505
+ ##### [xpaths](https://github.com/appium/ruby_lib/blob/94f3348a8fbec111a7a958063d3a2e643051b2e9/lib/appium_lib/common/helper.rb#L52)
1376
1506
 
1377
1507
  > def xpaths(xpath_str)
1378
1508
 
@@ -1388,7 +1518,7 @@ __Returns:__
1388
1518
 
1389
1519
  --
1390
1520
 
1391
- ##### [_print_source](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/common/helper.rb#L56)
1521
+ ##### [_print_source](https://github.com/appium/ruby_lib/blob/94f3348a8fbec111a7a958063d3a2e643051b2e9/lib/appium_lib/common/helper.rb#L56)
1392
1522
 
1393
1523
  > def _print_source(source)
1394
1524
 
@@ -1396,7 +1526,7 @@ __Returns:__
1396
1526
 
1397
1527
  --
1398
1528
 
1399
- ##### [result](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/common/helper.rb#L69)
1529
+ ##### [result](https://github.com/appium/ruby_lib/blob/94f3348a8fbec111a7a958063d3a2e643051b2e9/lib/appium_lib/common/helper.rb#L69)
1400
1530
 
1401
1531
  > def result
1402
1532
 
@@ -1404,7 +1534,7 @@ Returns the value of attribute result
1404
1534
 
1405
1535
  --
1406
1536
 
1407
- ##### [initialize](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/common/helper.rb#L71)
1537
+ ##### [initialize](https://github.com/appium/ruby_lib/blob/94f3348a8fbec111a7a958063d3a2e643051b2e9/lib/appium_lib/common/helper.rb#L71)
1408
1538
 
1409
1539
  > def initialize
1410
1540
 
@@ -1416,7 +1546,7 @@ __Returns:__
1416
1546
 
1417
1547
  --
1418
1548
 
1419
- ##### [reset](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/common/helper.rb#L75)
1549
+ ##### [reset](https://github.com/appium/ruby_lib/blob/94f3348a8fbec111a7a958063d3a2e643051b2e9/lib/appium_lib/common/helper.rb#L75)
1420
1550
 
1421
1551
  > def reset
1422
1552
 
@@ -1424,7 +1554,7 @@ __Returns:__
1424
1554
 
1425
1555
  --
1426
1556
 
1427
- ##### [start_element](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/common/helper.rb#L80)
1557
+ ##### [start_element](https://github.com/appium/ruby_lib/blob/94f3348a8fbec111a7a958063d3a2e643051b2e9/lib/appium_lib/common/helper.rb#L80)
1428
1558
 
1429
1559
  > def start_element(name, attrs = [])
1430
1560
 
@@ -1432,7 +1562,7 @@ http://nokogiri.org/Nokogiri/XML/SAX/Document.html
1432
1562
 
1433
1563
  --
1434
1564
 
1435
- ##### [formatted_result](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/common/helper.rb#L86)
1565
+ ##### [formatted_result](https://github.com/appium/ruby_lib/blob/94f3348a8fbec111a7a958063d3a2e643051b2e9/lib/appium_lib/common/helper.rb#L86)
1436
1566
 
1437
1567
  > def formatted_result
1438
1568
 
@@ -1440,7 +1570,7 @@ http://nokogiri.org/Nokogiri/XML/SAX/Document.html
1440
1570
 
1441
1571
  --
1442
1572
 
1443
- ##### [get_page_class](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/common/helper.rb#L97)
1573
+ ##### [get_page_class](https://github.com/appium/ruby_lib/blob/94f3348a8fbec111a7a958063d3a2e643051b2e9/lib/appium_lib/common/helper.rb#L97)
1444
1574
 
1445
1575
  > def get_page_class
1446
1576
 
@@ -1448,7 +1578,7 @@ Returns a string of class counts of visible elements.
1448
1578
 
1449
1579
  --
1450
1580
 
1451
- ##### [page_class](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/common/helper.rb#L108)
1581
+ ##### [page_class](https://github.com/appium/ruby_lib/blob/94f3348a8fbec111a7a958063d3a2e643051b2e9/lib/appium_lib/common/helper.rb#L108)
1452
1582
 
1453
1583
  > def page_class
1454
1584
 
@@ -1457,7 +1587,7 @@ Useful for appium_console.
1457
1587
 
1458
1588
  --
1459
1589
 
1460
- ##### [px_to_window_rel](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/common/helper.rb#L118)
1590
+ ##### [px_to_window_rel](https://github.com/appium/ruby_lib/blob/94f3348a8fbec111a7a958063d3a2e643051b2e9/lib/appium_lib/common/helper.rb#L118)
1461
1591
 
1462
1592
  > def px_to_window_rel(opts = {})
1463
1593
 
@@ -1469,7 +1599,7 @@ px_to_window_rel x: 50, y: 150
1469
1599
 
1470
1600
  --
1471
1601
 
1472
- ##### [xml_keys](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/common/helper.rb#L137)
1602
+ ##### [xml_keys](https://github.com/appium/ruby_lib/blob/94f3348a8fbec111a7a958063d3a2e643051b2e9/lib/appium_lib/common/helper.rb#L137)
1473
1603
 
1474
1604
  > def xml_keys(target)
1475
1605
 
@@ -1485,7 +1615,7 @@ __Returns:__
1485
1615
 
1486
1616
  --
1487
1617
 
1488
- ##### [xml_values](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/common/helper.rb#L145)
1618
+ ##### [xml_values](https://github.com/appium/ruby_lib/blob/94f3348a8fbec111a7a958063d3a2e643051b2e9/lib/appium_lib/common/helper.rb#L145)
1489
1619
 
1490
1620
  > def xml_values(target)
1491
1621
 
@@ -1501,7 +1631,7 @@ __Returns:__
1501
1631
 
1502
1632
  --
1503
1633
 
1504
- ##### [resolve_id](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/common/helper.rb#L153)
1634
+ ##### [resolve_id](https://github.com/appium/ruby_lib/blob/94f3348a8fbec111a7a958063d3a2e643051b2e9/lib/appium_lib/common/helper.rb#L153)
1505
1635
 
1506
1636
  > def resolve_id(id)
1507
1637
 
@@ -1517,7 +1647,7 @@ __Returns:__
1517
1647
 
1518
1648
  --
1519
1649
 
1520
- ##### [filter](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/common/helper.rb#L159)
1650
+ ##### [filter](https://github.com/appium/ruby_lib/blob/94f3348a8fbec111a7a958063d3a2e643051b2e9/lib/appium_lib/common/helper.rb#L159)
1521
1651
 
1522
1652
  > def filter
1523
1653
 
@@ -1525,7 +1655,7 @@ Returns the value of attribute filter
1525
1655
 
1526
1656
  --
1527
1657
 
1528
- ##### [filter=](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/common/helper.rb#L162)
1658
+ ##### [filter=](https://github.com/appium/ruby_lib/blob/94f3348a8fbec111a7a958063d3a2e643051b2e9/lib/appium_lib/common/helper.rb#L162)
1529
1659
 
1530
1660
  > def filter=(value)
1531
1661
 
@@ -1533,7 +1663,7 @@ convert to string to support symbols
1533
1663
 
1534
1664
  --
1535
1665
 
1536
- ##### [initialize](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/common/helper.rb#L168)
1666
+ ##### [initialize](https://github.com/appium/ruby_lib/blob/94f3348a8fbec111a7a958063d3a2e643051b2e9/lib/appium_lib/common/helper.rb#L168)
1537
1667
 
1538
1668
  > def initialize
1539
1669
 
@@ -1545,7 +1675,7 @@ __Returns:__
1545
1675
 
1546
1676
  --
1547
1677
 
1548
- ##### [reset](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/common/helper.rb#L173)
1678
+ ##### [reset](https://github.com/appium/ruby_lib/blob/94f3348a8fbec111a7a958063d3a2e643051b2e9/lib/appium_lib/common/helper.rb#L173)
1549
1679
 
1550
1680
  > def reset
1551
1681
 
@@ -1553,7 +1683,7 @@ __Returns:__
1553
1683
 
1554
1684
  --
1555
1685
 
1556
- ##### [result](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/common/helper.rb#L179)
1686
+ ##### [result](https://github.com/appium/ruby_lib/blob/94f3348a8fbec111a7a958063d3a2e643051b2e9/lib/appium_lib/common/helper.rb#L179)
1557
1687
 
1558
1688
  > def result
1559
1689
 
@@ -1561,7 +1691,7 @@ __Returns:__
1561
1691
 
1562
1692
  --
1563
1693
 
1564
- ##### [start_element](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/common/helper.rb#L195)
1694
+ ##### [start_element](https://github.com/appium/ruby_lib/blob/94f3348a8fbec111a7a958063d3a2e643051b2e9/lib/appium_lib/common/helper.rb#L195)
1565
1695
 
1566
1696
  > def start_element(name, attrs = [])
1567
1697
 
@@ -1569,7 +1699,7 @@ __Returns:__
1569
1699
 
1570
1700
  --
1571
1701
 
1572
- ##### [end_element](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/common/helper.rb#L204)
1702
+ ##### [end_element](https://github.com/appium/ruby_lib/blob/94f3348a8fbec111a7a958063d3a2e643051b2e9/lib/appium_lib/common/helper.rb#L204)
1573
1703
 
1574
1704
  > def end_element(name)
1575
1705
 
@@ -1577,7 +1707,7 @@ __Returns:__
1577
1707
 
1578
1708
  --
1579
1709
 
1580
- ##### [characters](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/common/helper.rb#L210)
1710
+ ##### [characters](https://github.com/appium/ruby_lib/blob/94f3348a8fbec111a7a958063d3a2e643051b2e9/lib/appium_lib/common/helper.rb#L210)
1581
1711
 
1582
1712
  > def characters(chars)
1583
1713
 
@@ -1585,7 +1715,7 @@ __Returns:__
1585
1715
 
1586
1716
  --
1587
1717
 
1588
- ##### [_no_such_element](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/common/helper.rb#L217)
1718
+ ##### [_no_such_element](https://github.com/appium/ruby_lib/blob/94f3348a8fbec111a7a958063d3a2e643051b2e9/lib/appium_lib/common/helper.rb#L217)
1589
1719
 
1590
1720
  > def _no_such_element
1591
1721
 
@@ -1593,7 +1723,7 @@ __Returns:__
1593
1723
 
1594
1724
  --
1595
1725
 
1596
- ##### [COMMAND_NO_ARG](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/common/command.rb#L4)
1726
+ ##### [COMMAND_NO_ARG](https://github.com/appium/ruby_lib/blob/94f3348a8fbec111a7a958063d3a2e643051b2e9/lib/appium_lib/common/command.rb#L4)
1597
1727
 
1598
1728
  > COMMAND_NO_ARG = {
1599
1729
 
@@ -1601,7 +1731,7 @@ __Returns:__
1601
1731
 
1602
1732
  --
1603
1733
 
1604
- ##### [COMMAND](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/common/command.rb#L23)
1734
+ ##### [COMMAND](https://github.com/appium/ruby_lib/blob/94f3348a8fbec111a7a958063d3a2e643051b2e9/lib/appium_lib/common/command.rb#L23)
1605
1735
 
1606
1736
  > COMMAND = {
1607
1737
 
@@ -1609,7 +1739,7 @@ __Returns:__
1609
1739
 
1610
1740
  --
1611
1741
 
1612
- ##### [window_size](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/common/element/window.rb#L5)
1742
+ ##### [window_size](https://github.com/appium/ruby_lib/blob/94f3348a8fbec111a7a958063d3a2e643051b2e9/lib/appium_lib/common/element/window.rb#L5)
1613
1743
 
1614
1744
  > def window_size
1615
1745
 
@@ -1617,7 +1747,7 @@ Get the window's size
1617
1747
 
1618
1748
  --
1619
1749
 
1620
- ##### [FINDERS](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/common/search_context.rb#L5)
1750
+ ##### [FINDERS](https://github.com/appium/ruby_lib/blob/94f3348a8fbec111a7a958063d3a2e643051b2e9/lib/appium_lib/common/search_context.rb#L5)
1621
1751
 
1622
1752
  > FINDERS = {
1623
1753
 
@@ -1625,7 +1755,7 @@ rubocop:disable Style/MutableConstant
1625
1755
 
1626
1756
  --
1627
1757
 
1628
- ##### [filter](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/ios/helper.rb#L4) ios
1758
+ ##### [filter](https://github.com/appium/ruby_lib/blob/94f3348a8fbec111a7a958063d3a2e643051b2e9/lib/appium_lib/ios/helper.rb#L4) ios
1629
1759
 
1630
1760
  > def filter
1631
1761
 
@@ -1633,7 +1763,7 @@ Returns the value of attribute filter
1633
1763
 
1634
1764
  --
1635
1765
 
1636
- ##### [filter=](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/ios/helper.rb#L4) ios
1766
+ ##### [filter=](https://github.com/appium/ruby_lib/blob/94f3348a8fbec111a7a958063d3a2e643051b2e9/lib/appium_lib/ios/helper.rb#L4) ios
1637
1767
 
1638
1768
  > def filter=(value)
1639
1769
 
@@ -1645,7 +1775,7 @@ __Parameters:__
1645
1775
 
1646
1776
  --
1647
1777
 
1648
- ##### [start_element](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/ios/helper.rb#L6) ios
1778
+ ##### [start_element](https://github.com/appium/ruby_lib/blob/94f3348a8fbec111a7a958063d3a2e643051b2e9/lib/appium_lib/ios/helper.rb#L6) ios
1649
1779
 
1650
1780
  > def start_element(type, attrs = [])
1651
1781
 
@@ -1653,7 +1783,7 @@ __Parameters:__
1653
1783
 
1654
1784
  --
1655
1785
 
1656
- ##### [_print_attr](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/ios/helper.rb#L15) ios
1786
+ ##### [_print_attr](https://github.com/appium/ruby_lib/blob/94f3348a8fbec111a7a958063d3a2e643051b2e9/lib/appium_lib/ios/helper.rb#L15) ios
1657
1787
 
1658
1788
  > def _print_attr(type, name, label, value, hint)
1659
1789
 
@@ -1661,7 +1791,7 @@ __Parameters:__
1661
1791
 
1662
1792
  --
1663
1793
 
1664
- ##### [ios_password](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/ios/helper.rb#L41) ios
1794
+ ##### [ios_password](https://github.com/appium/ruby_lib/blob/94f3348a8fbec111a7a958063d3a2e643051b2e9/lib/appium_lib/ios/helper.rb#L41) ios
1665
1795
 
1666
1796
  > def ios_password(length = 1)
1667
1797
 
@@ -1679,7 +1809,7 @@ __Returns:__
1679
1809
 
1680
1810
  --
1681
1811
 
1682
- ##### [get_page](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/ios/helper.rb#L53) ios
1812
+ ##### [get_page](https://github.com/appium/ruby_lib/blob/94f3348a8fbec111a7a958063d3a2e643051b2e9/lib/appium_lib/ios/helper.rb#L53) ios
1683
1813
 
1684
1814
  > def get_page(element = source_window(0), class_name = nil)
1685
1815
 
@@ -1700,7 +1830,7 @@ __Returns:__
1700
1830
 
1701
1831
  --
1702
1832
 
1703
- ##### [page](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/ios/helper.rb#L139) ios
1833
+ ##### [page](https://github.com/appium/ruby_lib/blob/94f3348a8fbec111a7a958063d3a2e643051b2e9/lib/appium_lib/ios/helper.rb#L139) ios
1704
1834
 
1705
1835
  > def page(opts = {})
1706
1836
 
@@ -1726,7 +1856,7 @@ __Returns:__
1726
1856
 
1727
1857
  --
1728
1858
 
1729
- ##### [source_window](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/ios/helper.rb#L170) ios
1859
+ ##### [source_window](https://github.com/appium/ruby_lib/blob/94f3348a8fbec111a7a958063d3a2e643051b2e9/lib/appium_lib/ios/helper.rb#L170) ios
1730
1860
 
1731
1861
  > def source_window(_window_number = 0)
1732
1862
 
@@ -1734,7 +1864,7 @@ Gets the JSON source of window number
1734
1864
 
1735
1865
  __Parameters:__
1736
1866
 
1737
-      [Integer] window_number - the int index of the target window
1867
+      [Integer] _window_number - The int index of the target window
1738
1868
 
1739
1869
  __Returns:__
1740
1870
 
@@ -1742,7 +1872,7 @@ __Returns:__
1742
1872
 
1743
1873
  --
1744
1874
 
1745
- ##### [page_window](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/ios/helper.rb#L185) ios
1875
+ ##### [page_window](https://github.com/appium/ruby_lib/blob/94f3348a8fbec111a7a958063d3a2e643051b2e9/lib/appium_lib/ios/helper.rb#L185) ios
1746
1876
 
1747
1877
  > def page_window(window_number = 0)
1748
1878
 
@@ -1760,7 +1890,7 @@ __Returns:__
1760
1890
 
1761
1891
  --
1762
1892
 
1763
- ##### [id](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/ios/helper.rb#L193) ios
1893
+ ##### [id](https://github.com/appium/ruby_lib/blob/94f3348a8fbec111a7a958063d3a2e643051b2e9/lib/appium_lib/ios/helper.rb#L193) ios
1764
1894
 
1765
1895
  > def id(id)
1766
1896
 
@@ -1776,7 +1906,7 @@ __Returns:__
1776
1906
 
1777
1907
  --
1778
1908
 
1779
- ##### [ios_version](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/ios/helper.rb#L199) ios
1909
+ ##### [ios_version](https://github.com/appium/ruby_lib/blob/94f3348a8fbec111a7a958063d3a2e643051b2e9/lib/appium_lib/ios/helper.rb#L199) ios
1780
1910
 
1781
1911
  > def ios_version
1782
1912
 
@@ -1788,7 +1918,7 @@ __Returns:__
1788
1918
 
1789
1919
  --
1790
1920
 
1791
- ##### [ele_index](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/ios/helper.rb#L212) ios
1921
+ ##### [ele_index](https://github.com/appium/ruby_lib/blob/94f3348a8fbec111a7a958063d3a2e643051b2e9/lib/appium_lib/ios/helper.rb#L212) ios
1792
1922
 
1793
1923
  > def ele_index(class_name, index)
1794
1924
 
@@ -1806,12 +1936,13 @@ __Returns:__
1806
1936
 
1807
1937
  --
1808
1938
 
1809
- ##### [find_ele_by_attr](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/ios/helper.rb#L247) ios
1939
+ ##### [find_ele_by_attr](https://github.com/appium/ruby_lib/blob/94f3348a8fbec111a7a958063d3a2e643051b2e9/lib/appium_lib/ios/helper.rb#L248) ios
1810
1940
 
1811
1941
  > def find_ele_by_attr(class_name, attr, value)
1812
1942
 
1813
1943
  Find the first element exactly matching class and attribute value.
1814
1944
  Note: Uses XPath
1945
+ Note: For XCUITest, this method return ALL elements include displayed or not displayed elements.
1815
1946
 
1816
1947
  __Parameters:__
1817
1948
 
@@ -1827,12 +1958,13 @@ __Returns:__
1827
1958
 
1828
1959
  --
1829
1960
 
1830
- ##### [find_eles_by_attr](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/ios/helper.rb#L257) ios
1961
+ ##### [find_eles_by_attr](https://github.com/appium/ruby_lib/blob/94f3348a8fbec111a7a958063d3a2e643051b2e9/lib/appium_lib/ios/helper.rb#L259) ios
1831
1962
 
1832
1963
  > def find_eles_by_attr(class_name, attr, value)
1833
1964
 
1834
1965
  Find all elements exactly matching class and attribute value.
1835
1966
  Note: Uses XPath
1967
+ Note: For XCUITest, this method return ALL elements include displayed or not displayed elements.
1836
1968
 
1837
1969
  __Parameters:__
1838
1970
 
@@ -1848,7 +1980,7 @@ __Returns:__
1848
1980
 
1849
1981
  --
1850
1982
 
1851
- ##### [find_ele_by_attr_include](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/ios/helper.rb#L280) ios
1983
+ ##### [find_ele_by_attr_include](https://github.com/appium/ruby_lib/blob/94f3348a8fbec111a7a958063d3a2e643051b2e9/lib/appium_lib/ios/helper.rb#L282) ios
1852
1984
 
1853
1985
  > def find_ele_by_attr_include(class_name, attr, value)
1854
1986
 
@@ -1869,7 +2001,7 @@ __Returns:__
1869
2001
 
1870
2002
  --
1871
2003
 
1872
- ##### [find_eles_by_attr_include](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/ios/helper.rb#L290) ios
2004
+ ##### [find_eles_by_attr_include](https://github.com/appium/ruby_lib/blob/94f3348a8fbec111a7a958063d3a2e643051b2e9/lib/appium_lib/ios/helper.rb#L292) ios
1873
2005
 
1874
2006
  > def find_eles_by_attr_include(class_name, attr, value)
1875
2007
 
@@ -1890,7 +2022,7 @@ __Returns:__
1890
2022
 
1891
2023
  --
1892
2024
 
1893
- ##### [first_ele](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/ios/helper.rb#L297) ios
2025
+ ##### [first_ele](https://github.com/appium/ruby_lib/blob/94f3348a8fbec111a7a958063d3a2e643051b2e9/lib/appium_lib/ios/helper.rb#L299) ios
1894
2026
 
1895
2027
  > def first_ele(class_name)
1896
2028
 
@@ -1906,7 +2038,7 @@ __Returns:__
1906
2038
 
1907
2039
  --
1908
2040
 
1909
- ##### [last_ele](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/ios/helper.rb#L308) ios
2041
+ ##### [last_ele](https://github.com/appium/ruby_lib/blob/94f3348a8fbec111a7a958063d3a2e643051b2e9/lib/appium_lib/ios/helper.rb#L306) ios
1910
2042
 
1911
2043
  > def last_ele(class_name)
1912
2044
 
@@ -1922,11 +2054,11 @@ __Returns:__
1922
2054
 
1923
2055
  --
1924
2056
 
1925
- ##### [tag](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/ios/helper.rb#L322) ios
2057
+ ##### [tag](https://github.com/appium/ruby_lib/blob/94f3348a8fbec111a7a958063d3a2e643051b2e9/lib/appium_lib/ios/helper.rb#L320) ios
1926
2058
 
1927
2059
  > def tag(class_name)
1928
2060
 
1929
- Returns the first visible element matching class_name
2061
+ Returns the first **visible** element matching class_name
1930
2062
 
1931
2063
  __Parameters:__
1932
2064
 
@@ -1938,7 +2070,7 @@ __Returns:__
1938
2070
 
1939
2071
  --
1940
2072
 
1941
- ##### [tags](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/ios/helper.rb#L334) ios
2073
+ ##### [tags](https://github.com/appium/ruby_lib/blob/94f3348a8fbec111a7a958063d3a2e643051b2e9/lib/appium_lib/ios/helper.rb#L332) ios
1942
2074
 
1943
2075
  > def tags(class_name)
1944
2076
 
@@ -1954,7 +2086,7 @@ __Returns:__
1954
2086
 
1955
2087
  --
1956
2088
 
1957
- ##### [ele_by_json_visible_contains](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/ios/helper.rb#L371) ios
2089
+ ##### [ele_by_json_visible_contains](https://github.com/appium/ruby_lib/blob/94f3348a8fbec111a7a958063d3a2e643051b2e9/lib/appium_lib/ios/helper.rb#L370) ios
1958
2090
 
1959
2091
  > def ele_by_json_visible_contains(element, value)
1960
2092
 
@@ -1973,7 +2105,7 @@ __Returns:__
1973
2105
 
1974
2106
  --
1975
2107
 
1976
- ##### [eles_by_json_visible_contains](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/ios/helper.rb#L380) ios
2108
+ ##### [eles_by_json_visible_contains](https://github.com/appium/ruby_lib/blob/94f3348a8fbec111a7a958063d3a2e643051b2e9/lib/appium_lib/ios/helper.rb#L379) ios
1977
2109
 
1978
2110
  > def eles_by_json_visible_contains(element, value)
1979
2111
 
@@ -1992,7 +2124,7 @@ __Returns:__
1992
2124
 
1993
2125
  --
1994
2126
 
1995
- ##### [ele_by_json_visible_exact](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/ios/helper.rb#L410) ios
2127
+ ##### [ele_by_json_visible_exact](https://github.com/appium/ruby_lib/blob/94f3348a8fbec111a7a958063d3a2e643051b2e9/lib/appium_lib/ios/helper.rb#L409) ios
1996
2128
 
1997
2129
  > def ele_by_json_visible_exact(element, value)
1998
2130
 
@@ -2011,7 +2143,7 @@ __Returns:__
2011
2143
 
2012
2144
  --
2013
2145
 
2014
- ##### [eles_by_json_visible_exact](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/ios/helper.rb#L419) ios
2146
+ ##### [eles_by_json_visible_exact](https://github.com/appium/ruby_lib/blob/94f3348a8fbec111a7a958063d3a2e643051b2e9/lib/appium_lib/ios/helper.rb#L418) ios
2015
2147
 
2016
2148
  > def eles_by_json_visible_exact(element, value)
2017
2149
 
@@ -2030,7 +2162,7 @@ __Returns:__
2030
2162
 
2031
2163
  --
2032
2164
 
2033
- ##### [_all_pred](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/ios/helper.rb#L484) ios
2165
+ ##### [_all_pred](https://github.com/appium/ruby_lib/blob/94f3348a8fbec111a7a958063d3a2e643051b2e9/lib/appium_lib/ios/helper.rb#L483) ios
2034
2166
 
2035
2167
  > def _all_pred(opts)
2036
2168
 
@@ -2040,7 +2172,7 @@ visible - if true, only visible elements are returned. default true
2040
2172
 
2041
2173
  --
2042
2174
 
2043
- ##### [ele_with_pred](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/ios/helper.rb#L497) ios
2175
+ ##### [ele_with_pred](https://github.com/appium/ruby_lib/blob/94f3348a8fbec111a7a958063d3a2e643051b2e9/lib/appium_lib/ios/helper.rb#L496) ios
2044
2176
 
2045
2177
  > def ele_with_pred(opts)
2046
2178
 
@@ -2056,7 +2188,7 @@ __Returns:__
2056
2188
 
2057
2189
  --
2058
2190
 
2059
- ##### [eles_with_pred](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/ios/helper.rb#L508) ios
2191
+ ##### [eles_with_pred](https://github.com/appium/ruby_lib/blob/94f3348a8fbec111a7a958063d3a2e643051b2e9/lib/appium_lib/ios/helper.rb#L507) ios
2060
2192
 
2061
2193
  > def eles_with_pred(opts)
2062
2194
 
@@ -2072,7 +2204,7 @@ __Returns:__
2072
2204
 
2073
2205
  --
2074
2206
 
2075
- ##### [source](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/ios/helper.rb#L514) ios
2207
+ ##### [source](https://github.com/appium/ruby_lib/blob/94f3348a8fbec111a7a958063d3a2e643051b2e9/lib/appium_lib/ios/helper.rb#L513) ios
2076
2208
 
2077
2209
  > def source
2078
2210
 
@@ -2084,7 +2216,7 @@ __Returns:__
2084
2216
 
2085
2217
  --
2086
2218
 
2087
- ##### [_validate_object](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/ios/helper.rb#L518) ios
2219
+ ##### [_validate_object](https://github.com/appium/ruby_lib/blob/94f3348a8fbec111a7a958063d3a2e643051b2e9/lib/appium_lib/ios/helper.rb#L517) ios
2088
2220
 
2089
2221
  > def _validate_object(*objects)
2090
2222
 
@@ -2092,7 +2224,7 @@ __Returns:__
2092
2224
 
2093
2225
  --
2094
2226
 
2095
- ##### [_by_json](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/ios/helper.rb#L567) ios
2227
+ ##### [_by_json](https://github.com/appium/ruby_lib/blob/94f3348a8fbec111a7a958063d3a2e643051b2e9/lib/appium_lib/ios/helper.rb#L566) ios
2096
2228
 
2097
2229
  > def _by_json(opts)
2098
2230
 
@@ -2127,7 +2259,7 @@ opts = {
2127
2259
 
2128
2260
  --
2129
2261
 
2130
- ##### [eles_by_json](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/ios/helper.rb#L617) ios
2262
+ ##### [eles_by_json](https://github.com/appium/ruby_lib/blob/94f3348a8fbec111a7a958063d3a2e643051b2e9/lib/appium_lib/ios/helper.rb#L616) ios
2131
2263
 
2132
2264
  > def eles_by_json(opts)
2133
2265
 
@@ -2146,7 +2278,7 @@ eles_by_json({
2146
2278
 
2147
2279
  --
2148
2280
 
2149
- ##### [ele_by_json](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/ios/helper.rb#L623) ios
2281
+ ##### [ele_by_json](https://github.com/appium/ruby_lib/blob/94f3348a8fbec111a7a958063d3a2e643051b2e9/lib/appium_lib/ios/helper.rb#L622) ios
2150
2282
 
2151
2283
  > def ele_by_json(opts)
2152
2284
 
@@ -2154,7 +2286,7 @@ see eles_by_json
2154
2286
 
2155
2287
  --
2156
2288
 
2157
- ##### [get_source](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/ios/helper.rb#L633) ios
2289
+ ##### [get_source](https://github.com/appium/ruby_lib/blob/94f3348a8fbec111a7a958063d3a2e643051b2e9/lib/appium_lib/ios/helper.rb#L632) ios
2158
2290
 
2159
2291
  > def get_source
2160
2292
 
@@ -2167,15 +2299,15 @@ __Returns:__
2167
2299
 
2168
2300
  --
2169
2301
 
2170
- ##### [IAStaticText](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/ios/element/text.rb#L4) ios
2302
+ ##### [UIAStaticText](https://github.com/appium/ruby_lib/blob/94f3348a8fbec111a7a958063d3a2e643051b2e9/lib/appium_lib/ios/element/text.rb#L4) ios
2171
2303
 
2172
- > IAStaticText = 'UIAStaticText'.freeze
2304
+ > UIAStaticText = 'UIAStaticText'.freeze
2173
2305
 
2174
2306
 
2175
2307
 
2176
2308
  --
2177
2309
 
2178
- ##### [XCUIElementTypeStaticText](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/ios/element/text.rb#L5) ios
2310
+ ##### [XCUIElementTypeStaticText](https://github.com/appium/ruby_lib/blob/94f3348a8fbec111a7a958063d3a2e643051b2e9/lib/appium_lib/ios/element/text.rb#L5) ios
2179
2311
 
2180
2312
  > XCUIElementTypeStaticText = 'XCUIElementTypeStaticText'.freeze
2181
2313
 
@@ -2183,7 +2315,7 @@ __Returns:__
2183
2315
 
2184
2316
  --
2185
2317
 
2186
- ##### [static_text_class](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/ios/element/text.rb#L8) ios
2318
+ ##### [static_text_class](https://github.com/appium/ruby_lib/blob/94f3348a8fbec111a7a958063d3a2e643051b2e9/lib/appium_lib/ios/element/text.rb#L8) ios
2187
2319
 
2188
2320
  > def static_text_class
2189
2321
 
@@ -2195,7 +2327,7 @@ __Returns:__
2195
2327
 
2196
2328
  --
2197
2329
 
2198
- ##### [text](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/ios/element/text.rb#L16) ios
2330
+ ##### [text](https://github.com/appium/ruby_lib/blob/94f3348a8fbec111a7a958063d3a2e643051b2e9/lib/appium_lib/ios/element/text.rb#L16) ios
2199
2331
 
2200
2332
  > def text(value)
2201
2333
 
@@ -2212,7 +2344,7 @@ __Returns:__
2212
2344
 
2213
2345
  --
2214
2346
 
2215
- ##### [texts](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/ios/element/text.rb#L30) ios
2347
+ ##### [texts](https://github.com/appium/ruby_lib/blob/94f3348a8fbec111a7a958063d3a2e643051b2e9/lib/appium_lib/ios/element/text.rb#L30) ios
2216
2348
 
2217
2349
  > def texts(value = false)
2218
2350
 
@@ -2229,7 +2361,7 @@ __Returns:__
2229
2361
 
2230
2362
  --
2231
2363
 
2232
- ##### [first_text](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/ios/element/text.rb#L43) ios
2364
+ ##### [first_text](https://github.com/appium/ruby_lib/blob/94f3348a8fbec111a7a958063d3a2e643051b2e9/lib/appium_lib/ios/element/text.rb#L43) ios
2233
2365
 
2234
2366
  > def first_text
2235
2367
 
@@ -2241,7 +2373,7 @@ __Returns:__
2241
2373
 
2242
2374
  --
2243
2375
 
2244
- ##### [last_text](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/ios/element/text.rb#L49) ios
2376
+ ##### [last_text](https://github.com/appium/ruby_lib/blob/94f3348a8fbec111a7a958063d3a2e643051b2e9/lib/appium_lib/ios/element/text.rb#L49) ios
2245
2377
 
2246
2378
  > def last_text
2247
2379
 
@@ -2253,7 +2385,7 @@ __Returns:__
2253
2385
 
2254
2386
  --
2255
2387
 
2256
- ##### [text_exact](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/ios/element/text.rb#L56) ios
2388
+ ##### [text_exact](https://github.com/appium/ruby_lib/blob/94f3348a8fbec111a7a958063d3a2e643051b2e9/lib/appium_lib/ios/element/text.rb#L56) ios
2257
2389
 
2258
2390
  > def text_exact(value)
2259
2391
 
@@ -2269,7 +2401,7 @@ __Returns:__
2269
2401
 
2270
2402
  --
2271
2403
 
2272
- ##### [texts_exact](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/ios/element/text.rb#L67) ios
2404
+ ##### [texts_exact](https://github.com/appium/ruby_lib/blob/94f3348a8fbec111a7a958063d3a2e643051b2e9/lib/appium_lib/ios/element/text.rb#L67) ios
2273
2405
 
2274
2406
  > def texts_exact(value)
2275
2407
 
@@ -2285,7 +2417,7 @@ __Returns:__
2285
2417
 
2286
2418
  --
2287
2419
 
2288
- ##### [alert_accept](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/ios/element/alert.rb#L5) ios
2420
+ ##### [alert_accept](https://github.com/appium/ruby_lib/blob/94f3348a8fbec111a7a958063d3a2e643051b2e9/lib/appium_lib/ios/element/alert.rb#L5) ios
2289
2421
 
2290
2422
  > def alert_accept
2291
2423
 
@@ -2297,7 +2429,7 @@ __Returns:__
2297
2429
 
2298
2430
  --
2299
2431
 
2300
- ##### [alert_dismiss](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/ios/element/alert.rb#L13) ios
2432
+ ##### [alert_dismiss](https://github.com/appium/ruby_lib/blob/94f3348a8fbec111a7a958063d3a2e643051b2e9/lib/appium_lib/ios/element/alert.rb#L13) ios
2301
2433
 
2302
2434
  > def alert_dismiss
2303
2435
 
@@ -2309,7 +2441,7 @@ __Returns:__
2309
2441
 
2310
2442
  --
2311
2443
 
2312
- ##### [UIAButton](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/ios/element/button.rb#L4) ios
2444
+ ##### [UIAButton](https://github.com/appium/ruby_lib/blob/94f3348a8fbec111a7a958063d3a2e643051b2e9/lib/appium_lib/ios/element/button.rb#L4) ios
2313
2445
 
2314
2446
  > UIAButton = 'UIAButton'.freeze
2315
2447
 
@@ -2317,7 +2449,7 @@ __Returns:__
2317
2449
 
2318
2450
  --
2319
2451
 
2320
- ##### [XCUIElementTypeButton](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/ios/element/button.rb#L5) ios
2452
+ ##### [XCUIElementTypeButton](https://github.com/appium/ruby_lib/blob/94f3348a8fbec111a7a958063d3a2e643051b2e9/lib/appium_lib/ios/element/button.rb#L5) ios
2321
2453
 
2322
2454
  > XCUIElementTypeButton = 'XCUIElementTypeButton'.freeze
2323
2455
 
@@ -2325,7 +2457,7 @@ __Returns:__
2325
2457
 
2326
2458
  --
2327
2459
 
2328
- ##### [button_class](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/ios/element/button.rb#L8) ios
2460
+ ##### [button_class](https://github.com/appium/ruby_lib/blob/94f3348a8fbec111a7a958063d3a2e643051b2e9/lib/appium_lib/ios/element/button.rb#L8) ios
2329
2461
 
2330
2462
  > def button_class
2331
2463
 
@@ -2337,7 +2469,7 @@ __Returns:__
2337
2469
 
2338
2470
  --
2339
2471
 
2340
- ##### [button](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/ios/element/button.rb#L16) ios
2472
+ ##### [button](https://github.com/appium/ruby_lib/blob/94f3348a8fbec111a7a958063d3a2e643051b2e9/lib/appium_lib/ios/element/button.rb#L16) ios
2341
2473
 
2342
2474
  > def button(value)
2343
2475
 
@@ -2354,7 +2486,7 @@ __Returns:__
2354
2486
 
2355
2487
  --
2356
2488
 
2357
- ##### [buttons](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/ios/element/button.rb#L31) ios
2489
+ ##### [buttons](https://github.com/appium/ruby_lib/blob/94f3348a8fbec111a7a958063d3a2e643051b2e9/lib/appium_lib/ios/element/button.rb#L31) ios
2358
2490
 
2359
2491
  > def buttons(value = false)
2360
2492
 
@@ -2371,7 +2503,7 @@ __Returns:__
2371
2503
 
2372
2504
  --
2373
2505
 
2374
- ##### [first_button](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/ios/element/button.rb#L44) ios
2506
+ ##### [first_button](https://github.com/appium/ruby_lib/blob/94f3348a8fbec111a7a958063d3a2e643051b2e9/lib/appium_lib/ios/element/button.rb#L44) ios
2375
2507
 
2376
2508
  > def first_button
2377
2509
 
@@ -2383,7 +2515,7 @@ __Returns:__
2383
2515
 
2384
2516
  --
2385
2517
 
2386
- ##### [last_button](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/ios/element/button.rb#L52) ios
2518
+ ##### [last_button](https://github.com/appium/ruby_lib/blob/94f3348a8fbec111a7a958063d3a2e643051b2e9/lib/appium_lib/ios/element/button.rb#L52) ios
2387
2519
 
2388
2520
  > def last_button
2389
2521
 
@@ -2397,7 +2529,7 @@ __Returns:__
2397
2529
 
2398
2530
  --
2399
2531
 
2400
- ##### [button_exact](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/ios/element/button.rb#L59) ios
2532
+ ##### [button_exact](https://github.com/appium/ruby_lib/blob/94f3348a8fbec111a7a958063d3a2e643051b2e9/lib/appium_lib/ios/element/button.rb#L59) ios
2401
2533
 
2402
2534
  > def button_exact(value)
2403
2535
 
@@ -2413,7 +2545,7 @@ __Returns:__
2413
2545
 
2414
2546
  --
2415
2547
 
2416
- ##### [buttons_exact](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/ios/element/button.rb#L70) ios
2548
+ ##### [buttons_exact](https://github.com/appium/ruby_lib/blob/94f3348a8fbec111a7a958063d3a2e643051b2e9/lib/appium_lib/ios/element/button.rb#L70) ios
2417
2549
 
2418
2550
  > def buttons_exact(value)
2419
2551
 
@@ -2429,7 +2561,7 @@ __Returns:__
2429
2561
 
2430
2562
  --
2431
2563
 
2432
- ##### [uiautomation_find](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/ios/mobile_methods.rb#L19) ios
2564
+ ##### [uiautomation_find](https://github.com/appium/ruby_lib/blob/94f3348a8fbec111a7a958063d3a2e643051b2e9/lib/appium_lib/ios/mobile_methods.rb#L19) ios
2433
2565
 
2434
2566
  > def uiautomation_find
2435
2567
 
@@ -2441,7 +2573,7 @@ find_element/s can be used with a [UIAutomation command](https://developer.apple
2441
2573
 
2442
2574
  --
2443
2575
 
2444
- ##### [ios_predicate_string_find](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/ios/mobile_methods.rb#L19) ios
2576
+ ##### [ios_predicate_string_find](https://github.com/appium/ruby_lib/blob/94f3348a8fbec111a7a958063d3a2e643051b2e9/lib/appium_lib/ios/mobile_methods.rb#L19) ios
2445
2577
 
2446
2578
  > def ios_predicate_string_find
2447
2579
 
@@ -2455,7 +2587,7 @@ find_element/s can be used with a [Predicates](https://developer.apple.com/libra
2455
2587
 
2456
2588
  --
2457
2589
 
2458
- ##### [find](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/ios/element/generic.rb#L6) ios
2590
+ ##### [find](https://github.com/appium/ruby_lib/blob/94f3348a8fbec111a7a958063d3a2e643051b2e9/lib/appium_lib/ios/element/generic.rb#L6) ios
2459
2591
 
2460
2592
  > def find(value)
2461
2593
 
@@ -2471,7 +2603,7 @@ __Returns:__
2471
2603
 
2472
2604
  --
2473
2605
 
2474
- ##### [finds](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/ios/element/generic.rb#L17) ios
2606
+ ##### [finds](https://github.com/appium/ruby_lib/blob/94f3348a8fbec111a7a958063d3a2e643051b2e9/lib/appium_lib/ios/element/generic.rb#L17) ios
2475
2607
 
2476
2608
  > def finds(value)
2477
2609
 
@@ -2487,7 +2619,7 @@ __Returns:__
2487
2619
 
2488
2620
  --
2489
2621
 
2490
- ##### [find_exact](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/ios/element/generic.rb#L28) ios
2622
+ ##### [find_exact](https://github.com/appium/ruby_lib/blob/94f3348a8fbec111a7a958063d3a2e643051b2e9/lib/appium_lib/ios/element/generic.rb#L29) ios
2491
2623
 
2492
2624
  > def find_exact(value)
2493
2625
 
@@ -2503,7 +2635,7 @@ __Returns:__
2503
2635
 
2504
2636
  --
2505
2637
 
2506
- ##### [finds_exact](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/ios/element/generic.rb#L39) ios
2638
+ ##### [finds_exact](https://github.com/appium/ruby_lib/blob/94f3348a8fbec111a7a958063d3a2e643051b2e9/lib/appium_lib/ios/element/generic.rb#L40) ios
2507
2639
 
2508
2640
  > def finds_exact(value)
2509
2641
 
@@ -2519,31 +2651,39 @@ __Returns:__
2519
2651
 
2520
2652
  --
2521
2653
 
2522
- ##### [_raise_error_if_no_element](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/ios/element/generic.rb#L49) ios
2654
+ ##### [raise_error_if_no_element](https://github.com/appium/ruby_lib/blob/94f3348a8fbec111a7a958063d3a2e643051b2e9/lib/appium_lib/ios/element/generic.rb#L51) ios
2523
2655
 
2524
- > def _raise_error_if_no_element(element)
2656
+ > def raise_error_if_no_element(element)
2525
2657
 
2526
2658
 
2527
2659
 
2528
2660
  --
2529
2661
 
2530
- ##### [_elements_include](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/ios/element/generic.rb#L54) ios
2531
-
2532
- > def _elements_include(elements, value)
2662
+ ##### [elements_include](https://github.com/appium/ruby_lib/blob/94f3348a8fbec111a7a958063d3a2e643051b2e9/lib/appium_lib/ios/element/generic.rb#L58) ios
2533
2663
 
2664
+ > def elements_include(elements, value)
2534
2665
 
2666
+ Return all elements include not displayed elements.
2535
2667
 
2536
2668
  --
2537
2669
 
2538
- ##### [_elements_exact](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/ios/element/generic.rb#L62) ios
2670
+ ##### [elements_exact](https://github.com/appium/ruby_lib/blob/94f3348a8fbec111a7a958063d3a2e643051b2e9/lib/appium_lib/ios/element/generic.rb#L72) ios
2671
+
2672
+ > def elements_exact(elements, value)
2673
+
2674
+ Return all elements include not displayed elements.
2675
+
2676
+ --
2539
2677
 
2540
- > def _elements_exact(elements, value)
2678
+ ##### [select_visible_elements](https://github.com/appium/ruby_lib/blob/94f3348a8fbec111a7a958063d3a2e643051b2e9/lib/appium_lib/ios/element/generic.rb#L86) ios
2541
2679
 
2680
+ > def select_visible_elements(elements)
2542
2681
 
2682
+ Return visible elements.
2543
2683
 
2544
2684
  --
2545
2685
 
2546
- ##### [UIATextField](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/ios/element/textfield.rb#L3) ios
2686
+ ##### [UIATextField](https://github.com/appium/ruby_lib/blob/94f3348a8fbec111a7a958063d3a2e643051b2e9/lib/appium_lib/ios/element/textfield.rb#L3) ios
2547
2687
 
2548
2688
  > UIATextField = 'UIATextField'.freeze
2549
2689
 
@@ -2551,7 +2691,7 @@ __Returns:__
2551
2691
 
2552
2692
  --
2553
2693
 
2554
- ##### [UIASecureTextField](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/ios/element/textfield.rb#L4) ios
2694
+ ##### [UIASecureTextField](https://github.com/appium/ruby_lib/blob/94f3348a8fbec111a7a958063d3a2e643051b2e9/lib/appium_lib/ios/element/textfield.rb#L4) ios
2555
2695
 
2556
2696
  > UIASecureTextField = 'UIASecureTextField'.freeze
2557
2697
 
@@ -2559,7 +2699,7 @@ __Returns:__
2559
2699
 
2560
2700
  --
2561
2701
 
2562
- ##### [XCUIElementTypeTextField](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/ios/element/textfield.rb#L6) ios
2702
+ ##### [XCUIElementTypeTextField](https://github.com/appium/ruby_lib/blob/94f3348a8fbec111a7a958063d3a2e643051b2e9/lib/appium_lib/ios/element/textfield.rb#L6) ios
2563
2703
 
2564
2704
  > XCUIElementTypeTextField = 'XCUIElementTypeTextField'.freeze
2565
2705
 
@@ -2567,7 +2707,7 @@ __Returns:__
2567
2707
 
2568
2708
  --
2569
2709
 
2570
- ##### [XCUIElementTypeSecureTextField](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/ios/element/textfield.rb#L7) ios
2710
+ ##### [XCUIElementTypeSecureTextField](https://github.com/appium/ruby_lib/blob/94f3348a8fbec111a7a958063d3a2e643051b2e9/lib/appium_lib/ios/element/textfield.rb#L7) ios
2571
2711
 
2572
2712
  > XCUIElementTypeSecureTextField = 'XCUIElementTypeSecureTextField'.freeze
2573
2713
 
@@ -2575,7 +2715,7 @@ __Returns:__
2575
2715
 
2576
2716
  --
2577
2717
 
2578
- ##### [text_field_class](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/ios/element/textfield.rb#L10) ios
2718
+ ##### [text_field_class](https://github.com/appium/ruby_lib/blob/94f3348a8fbec111a7a958063d3a2e643051b2e9/lib/appium_lib/ios/element/textfield.rb#L10) ios
2579
2719
 
2580
2720
  > def text_field_class
2581
2721
 
@@ -2587,7 +2727,7 @@ __Returns:__
2587
2727
 
2588
2728
  --
2589
2729
 
2590
- ##### [secure_text_field_class](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/ios/element/textfield.rb#L15) ios
2730
+ ##### [secure_text_field_class](https://github.com/appium/ruby_lib/blob/94f3348a8fbec111a7a958063d3a2e643051b2e9/lib/appium_lib/ios/element/textfield.rb#L15) ios
2591
2731
 
2592
2732
  > def secure_text_field_class
2593
2733
 
@@ -2599,7 +2739,7 @@ __Returns:__
2599
2739
 
2600
2740
  --
2601
2741
 
2602
- ##### [_textfield_visible](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/ios/element/textfield.rb#L40) ios
2742
+ ##### [_textfield_visible](https://github.com/appium/ruby_lib/blob/94f3348a8fbec111a7a958063d3a2e643051b2e9/lib/appium_lib/ios/element/textfield.rb#L41) ios
2603
2743
 
2604
2744
  > def _textfield_visible
2605
2745
 
@@ -2607,7 +2747,7 @@ Appium
2607
2747
 
2608
2748
  --
2609
2749
 
2610
- ##### [_textfield_exact_string](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/ios/element/textfield.rb#L45) ios
2750
+ ##### [_textfield_exact_string](https://github.com/appium/ruby_lib/blob/94f3348a8fbec111a7a958063d3a2e643051b2e9/lib/appium_lib/ios/element/textfield.rb#L46) ios
2611
2751
 
2612
2752
  > def _textfield_exact_string(value)
2613
2753
 
@@ -2615,7 +2755,7 @@ Appium
2615
2755
 
2616
2756
  --
2617
2757
 
2618
- ##### [_textfield_contains_string](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/ios/element/textfield.rb#L52) ios
2758
+ ##### [_textfield_contains_string](https://github.com/appium/ruby_lib/blob/94f3348a8fbec111a7a958063d3a2e643051b2e9/lib/appium_lib/ios/element/textfield.rb#L53) ios
2619
2759
 
2620
2760
  > def _textfield_contains_string(value)
2621
2761
 
@@ -2623,7 +2763,7 @@ Appium
2623
2763
 
2624
2764
  --
2625
2765
 
2626
- ##### [textfield](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/ios/element/textfield.rb#L65) ios
2766
+ ##### [textfield](https://github.com/appium/ruby_lib/blob/94f3348a8fbec111a7a958063d3a2e643051b2e9/lib/appium_lib/ios/element/textfield.rb#L66) ios
2627
2767
 
2628
2768
  > def textfield(value)
2629
2769
 
@@ -2641,7 +2781,7 @@ __Returns:__
2641
2781
 
2642
2782
  --
2643
2783
 
2644
- ##### [textfields](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/ios/element/textfield.rb#L91) ios
2784
+ ##### [textfields](https://github.com/appium/ruby_lib/blob/94f3348a8fbec111a7a958063d3a2e643051b2e9/lib/appium_lib/ios/element/textfield.rb#L92) ios
2645
2785
 
2646
2786
  > def textfields(value = false)
2647
2787
 
@@ -2658,7 +2798,7 @@ __Returns:__
2658
2798
 
2659
2799
  --
2660
2800
 
2661
- ##### [first_textfield](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/ios/element/textfield.rb#L103) ios
2801
+ ##### [first_textfield](https://github.com/appium/ruby_lib/blob/94f3348a8fbec111a7a958063d3a2e643051b2e9/lib/appium_lib/ios/element/textfield.rb#L105) ios
2662
2802
 
2663
2803
  > def first_textfield
2664
2804
 
@@ -2670,7 +2810,7 @@ __Returns:__
2670
2810
 
2671
2811
  --
2672
2812
 
2673
- ##### [last_textfield](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/ios/element/textfield.rb#L113) ios
2813
+ ##### [last_textfield](https://github.com/appium/ruby_lib/blob/94f3348a8fbec111a7a958063d3a2e643051b2e9/lib/appium_lib/ios/element/textfield.rb#L115) ios
2674
2814
 
2675
2815
  > def last_textfield
2676
2816
 
@@ -2682,7 +2822,7 @@ __Returns:__
2682
2822
 
2683
2823
  --
2684
2824
 
2685
- ##### [textfield_exact](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/ios/element/textfield.rb#L126) ios
2825
+ ##### [textfield_exact](https://github.com/appium/ruby_lib/blob/94f3348a8fbec111a7a958063d3a2e643051b2e9/lib/appium_lib/ios/element/textfield.rb#L128) ios
2686
2826
 
2687
2827
  > def textfield_exact(value)
2688
2828
 
@@ -2698,7 +2838,7 @@ __Returns:__
2698
2838
 
2699
2839
  --
2700
2840
 
2701
- ##### [textfields_exact](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/ios/element/textfield.rb#L137) ios
2841
+ ##### [textfields_exact](https://github.com/appium/ruby_lib/blob/94f3348a8fbec111a7a958063d3a2e643051b2e9/lib/appium_lib/ios/element/textfield.rb#L139) ios
2702
2842
 
2703
2843
  > def textfields_exact(value)
2704
2844
 
@@ -2714,7 +2854,7 @@ __Returns:__
2714
2854
 
2715
2855
  --
2716
2856
 
2717
- ##### [value](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/common/patch.rb#L12)
2857
+ ##### [value](https://github.com/appium/ruby_lib/blob/94f3348a8fbec111a7a958063d3a2e643051b2e9/lib/appium_lib/common/patch.rb#L12)
2718
2858
 
2719
2859
  > def value
2720
2860
 
@@ -2724,7 +2864,7 @@ Fixes NoMethodError: undefined method `value' for Selenium::WebDriver::Element
2724
2864
 
2725
2865
  --
2726
2866
 
2727
- ##### [name](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/common/patch.rb#L19)
2867
+ ##### [name](https://github.com/appium/ruby_lib/blob/94f3348a8fbec111a7a958063d3a2e643051b2e9/lib/appium_lib/common/patch.rb#L19)
2728
2868
 
2729
2869
  > def name
2730
2870
 
@@ -2734,7 +2874,7 @@ Fixes NoMethodError: undefined method `name' for Selenium::WebDriver::Element
2734
2874
 
2735
2875
  --
2736
2876
 
2737
- ##### [location_rel](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/common/patch.rb#L31)
2877
+ ##### [location_rel](https://github.com/appium/ruby_lib/blob/94f3348a8fbec111a7a958063d3a2e643051b2e9/lib/appium_lib/common/patch.rb#L31)
2738
2878
 
2739
2879
  > def location_rel
2740
2880
 
@@ -2752,7 +2892,7 @@ __Returns:__
2752
2892
 
2753
2893
  --
2754
2894
 
2755
- ##### [DEFAULT_HEADERS](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/common/patch.rb#L152)
2895
+ ##### [DEFAULT_HEADERS](https://github.com/appium/ruby_lib/blob/94f3348a8fbec111a7a958063d3a2e643051b2e9/lib/appium_lib/common/patch.rb#L152)
2756
2896
 
2757
2897
  > DEFAULT_HEADERS = { 'Accept' => CONTENT_TYPE, 'User-Agent' => "appium/ruby_lib/#{::Appium::VERSION}" }.freeze
2758
2898
 
@@ -2760,7 +2900,7 @@ __Returns:__
2760
2900
 
2761
2901
  --
2762
2902
 
2763
- ##### [patch_remote_driver_commands](https://github.com/appium/ruby_lib/blob/ecf1a5a1e323aeb1efdaebbfe1ae566bfcae1978/lib/appium_lib/common/patch.rb#L155)
2903
+ ##### [patch_remote_driver_commands](https://github.com/appium/ruby_lib/blob/94f3348a8fbec111a7a958063d3a2e643051b2e9/lib/appium_lib/common/patch.rb#L155)
2764
2904
 
2765
2905
  > def patch_remote_driver_commands
2766
2906