appium_lib 9.15.2 → 9.16.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.
- checksums.yaml +4 -4
- data/CHANGELOG.md +23 -0
- data/Rakefile +1 -258
- data/Thorfile +15 -0
- data/appium_lib.gemspec +2 -1
- data/contributing.md +3 -14
- data/docs/android_docs.md +377 -1128
- data/docs/ios_docs.md +515 -1500
- data/lib/appium_lib/driver.rb +8 -3
- data/lib/appium_lib/version.rb +2 -2
- data/readme.md +1 -0
- data/release_notes.md +308 -381
- metadata +26 -7
- data/docs_gen/docs_from_js.md +0 -44
- data/docs_gen/make_docs.rb +0 -87
data/docs/ios_docs.md
CHANGED
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
##### [load_settings](https://github.com/appium/ruby_lib/blob/
|
|
1
|
+
##### [load_settings](https://github.com/appium/ruby_lib/blob/621a9ebaf18bcd80eb0e1f5fc17fbb4dddf5293a/lib/appium_lib/appium.rb#L46) common
|
|
2
2
|
|
|
3
3
|
> def load_settings(opts = {})
|
|
4
4
|
|
|
@@ -17,17 +17,11 @@ port = 8080
|
|
|
17
17
|
:require is expanded
|
|
18
18
|
all keys are converted to symbols
|
|
19
19
|
|
|
20
|
-
__Parameters:__
|
|
20
|
+
__Parameters:__\n\n [Hash] opts - file: '/path/to/appium.txt', verbose: true
|
|
21
21
|
|
|
22
|
-
[
|
|
22
|
+
__Returns:__\n\n [hash] the symbolized hash with updated :app and :require keys
|
|
23
23
|
|
|
24
|
-
|
|
25
|
-
|
|
26
|
-
[hash] the symbolized hash with updated :app and :require keys
|
|
27
|
-
|
|
28
|
-
--
|
|
29
|
-
|
|
30
|
-
##### [load_appium_txt](https://github.com/appium/ruby_lib/blob/c6eb8f5416ccdf75b161bc60c0986caec43d9ff8/lib/appium_lib/appium.rb#L82)
|
|
24
|
+
--\n\n##### [load_appium_txt](https://github.com/appium/ruby_lib/blob/621a9ebaf18bcd80eb0e1f5fc17fbb4dddf5293a/lib/appium_lib/appium.rb#L82) common
|
|
31
25
|
|
|
32
26
|
> def load_settings(opts = {})
|
|
33
27
|
|
|
@@ -46,35 +40,23 @@ port = 8080
|
|
|
46
40
|
:require is expanded
|
|
47
41
|
all keys are converted to symbols
|
|
48
42
|
|
|
49
|
-
__Parameters:__
|
|
50
|
-
|
|
51
|
-
[Hash] opts - file: '/path/to/appium.txt', verbose: true
|
|
43
|
+
__Parameters:__\n\n [Hash] opts - file: '/path/to/appium.txt', verbose: true
|
|
52
44
|
|
|
53
|
-
__Returns:__
|
|
45
|
+
__Returns:__\n\n [hash] the symbolized hash with updated :app and :require keys
|
|
54
46
|
|
|
55
|
-
|
|
56
|
-
|
|
57
|
-
--
|
|
58
|
-
|
|
59
|
-
##### [expand_required_files](https://github.com/appium/ruby_lib/blob/c6eb8f5416ccdf75b161bc60c0986caec43d9ff8/lib/appium_lib/appium.rb#L87)
|
|
47
|
+
--\n\n##### [expand_required_files](https://github.com/appium/ruby_lib/blob/621a9ebaf18bcd80eb0e1f5fc17fbb4dddf5293a/lib/appium_lib/appium.rb#L87) common
|
|
60
48
|
|
|
61
49
|
> def expand_required_files(base_dir, file_paths)
|
|
62
50
|
|
|
63
51
|
|
|
64
52
|
|
|
65
|
-
__Parameters:__
|
|
66
|
-
|
|
67
|
-
[String] base_dir - parent directory of loaded appium.txt (toml)
|
|
53
|
+
__Parameters:__\n\n [String] base_dir - parent directory of loaded appium.txt (toml)
|
|
68
54
|
|
|
69
55
|
[String] file_paths -
|
|
70
56
|
|
|
71
|
-
__Returns:__
|
|
72
|
-
|
|
73
|
-
[Array] list of require files as an array, nil if require doesn't exist
|
|
57
|
+
__Returns:__\n\n [Array] list of require files as an array, nil if require doesn't exist
|
|
74
58
|
|
|
75
|
-
|
|
76
|
-
|
|
77
|
-
##### [promote_singleton_appium_methods](https://github.com/appium/ruby_lib/blob/c6eb8f5416ccdf75b161bc60c0986caec43d9ff8/lib/appium_lib/appium.rb#L129)
|
|
59
|
+
--\n\n##### [promote_singleton_appium_methods](https://github.com/appium/ruby_lib/blob/621a9ebaf18bcd80eb0e1f5fc17fbb4dddf5293a/lib/appium_lib/appium.rb#L129) common
|
|
78
60
|
|
|
79
61
|
> def promote_singleton_appium_methods(modules, driver = $driver)
|
|
80
62
|
|
|
@@ -90,15 +72,11 @@ if modules is a module instead of an array, then the constants of
|
|
|
90
72
|
that module are promoted on.
|
|
91
73
|
otherwise, the array of modules will be used as the promotion target.
|
|
92
74
|
|
|
93
|
-
__Parameters:__
|
|
94
|
-
|
|
95
|
-
[Array<Module>] modules - An array of modules
|
|
75
|
+
__Parameters:__\n\n [Array<Module>] modules - An array of modules
|
|
96
76
|
|
|
97
77
|
[Driver] driver - A driver to extend for
|
|
98
78
|
|
|
99
|
-
|
|
100
|
-
|
|
101
|
-
##### [promote_appium_methods](https://github.com/appium/ruby_lib/blob/c6eb8f5416ccdf75b161bc60c0986caec43d9ff8/lib/appium_lib/appium.rb#L185)
|
|
79
|
+
--\n\n##### [promote_appium_methods](https://github.com/appium/ruby_lib/blob/621a9ebaf18bcd80eb0e1f5fc17fbb4dddf5293a/lib/appium_lib/appium.rb#L185) common
|
|
102
80
|
|
|
103
81
|
> def promote_appium_methods(class_array, driver = $driver)
|
|
104
82
|
|
|
@@ -108,306 +86,222 @@ To promote methods to all classes:
|
|
|
108
86
|
|
|
109
87
|
It's better to promote on specific classes instead of Object
|
|
110
88
|
|
|
111
|
-
__Parameters:__
|
|
112
|
-
|
|
113
|
-
[Array<Class>] class_array - An array of classes
|
|
89
|
+
__Parameters:__\n\n [Array<Class>] class_array - An array of classes
|
|
114
90
|
|
|
115
91
|
[Driver] driver - A driver to extend for
|
|
116
92
|
|
|
117
|
-
|
|
118
|
-
|
|
119
|
-
##### [global_webdriver_http_sleep](https://github.com/appium/ruby_lib/blob/c6eb8f5416ccdf75b161bc60c0986caec43d9ff8/lib/appium_lib/driver.rb#L37)
|
|
93
|
+
--\n\n##### [global_webdriver_http_sleep](https://github.com/appium/ruby_lib/blob/621a9ebaf18bcd80eb0e1f5fc17fbb4dddf5293a/lib/appium_lib/driver.rb#L37) common
|
|
120
94
|
|
|
121
95
|
> def global_webdriver_http_sleep
|
|
122
96
|
|
|
123
97
|
The amount to sleep in seconds before every webdriver http call.
|
|
124
98
|
|
|
125
|
-
|
|
126
|
-
|
|
127
|
-
##### [global_webdriver_http_sleep=](https://github.com/appium/ruby_lib/blob/c6eb8f5416ccdf75b161bc60c0986caec43d9ff8/lib/appium_lib/driver.rb#L37)
|
|
99
|
+
--\n\n##### [global_webdriver_http_sleep=](https://github.com/appium/ruby_lib/blob/621a9ebaf18bcd80eb0e1f5fc17fbb4dddf5293a/lib/appium_lib/driver.rb#L37) common
|
|
128
100
|
|
|
129
101
|
> def global_webdriver_http_sleep=(value)
|
|
130
102
|
|
|
131
103
|
The amount to sleep in seconds before every webdriver http call.
|
|
132
104
|
|
|
133
|
-
|
|
134
|
-
|
|
135
|
-
##### [sauce](https://github.com/appium/ruby_lib/blob/c6eb8f5416ccdf75b161bc60c0986caec43d9ff8/lib/appium_lib/driver.rb#L40)
|
|
105
|
+
--\n\n##### [sauce](https://github.com/appium/ruby_lib/blob/621a9ebaf18bcd80eb0e1f5fc17fbb4dddf5293a/lib/appium_lib/driver.rb#L40) common
|
|
136
106
|
|
|
137
107
|
> def sauce
|
|
138
108
|
|
|
139
109
|
SauceLab's settings
|
|
140
110
|
|
|
141
|
-
|
|
142
|
-
|
|
143
|
-
##### [sauce_username](https://github.com/appium/ruby_lib/blob/c6eb8f5416ccdf75b161bc60c0986caec43d9ff8/lib/appium_lib/driver.rb#L43)
|
|
111
|
+
--\n\n##### [sauce_username](https://github.com/appium/ruby_lib/blob/621a9ebaf18bcd80eb0e1f5fc17fbb4dddf5293a/lib/appium_lib/driver.rb#L43) common
|
|
144
112
|
|
|
145
113
|
> def sauce_username
|
|
146
114
|
|
|
147
115
|
Username for use on Sauce Labs. Set `false` to disable Sauce, even when SAUCE_USERNAME is in ENV.
|
|
148
116
|
same as @sauce.username
|
|
149
117
|
|
|
150
|
-
|
|
151
|
-
|
|
152
|
-
##### [sauce_access_key](https://github.com/appium/ruby_lib/blob/c6eb8f5416ccdf75b161bc60c0986caec43d9ff8/lib/appium_lib/driver.rb#L46)
|
|
118
|
+
--\n\n##### [sauce_access_key](https://github.com/appium/ruby_lib/blob/621a9ebaf18bcd80eb0e1f5fc17fbb4dddf5293a/lib/appium_lib/driver.rb#L46) common
|
|
153
119
|
|
|
154
120
|
> def sauce_access_key
|
|
155
121
|
|
|
156
122
|
Access Key for use on Sauce Labs. Set `false` to disable Sauce, even when SAUCE_ACCESS_KEY is in ENV.
|
|
157
123
|
same as @sauce.access_key
|
|
158
124
|
|
|
159
|
-
|
|
160
|
-
|
|
161
|
-
##### [sauce_endpoint](https://github.com/appium/ruby_lib/blob/c6eb8f5416ccdf75b161bc60c0986caec43d9ff8/lib/appium_lib/driver.rb#L49)
|
|
125
|
+
--\n\n##### [sauce_endpoint](https://github.com/appium/ruby_lib/blob/621a9ebaf18bcd80eb0e1f5fc17fbb4dddf5293a/lib/appium_lib/driver.rb#L49) common
|
|
162
126
|
|
|
163
127
|
> def sauce_endpoint
|
|
164
128
|
|
|
165
129
|
Override the Sauce Appium endpoint to allow e.g. TestObject tests
|
|
166
130
|
same as @sauce.endpoint
|
|
167
131
|
|
|
168
|
-
|
|
169
|
-
|
|
170
|
-
##### [caps](https://github.com/appium/ruby_lib/blob/c6eb8f5416ccdf75b161bc60c0986caec43d9ff8/lib/appium_lib/driver.rb#L53)
|
|
132
|
+
--\n\n##### [caps](https://github.com/appium/ruby_lib/blob/621a9ebaf18bcd80eb0e1f5fc17fbb4dddf5293a/lib/appium_lib/driver.rb#L53) common
|
|
171
133
|
|
|
172
134
|
> def caps
|
|
173
135
|
|
|
174
136
|
from Core
|
|
175
137
|
read http://www.rubydoc.info/github/appium/ruby_lib_core/Appium/Core/Driver
|
|
176
138
|
|
|
177
|
-
|
|
178
|
-
|
|
179
|
-
##### [custom_url](https://github.com/appium/ruby_lib/blob/c6eb8f5416ccdf75b161bc60c0986caec43d9ff8/lib/appium_lib/driver.rb#L54)
|
|
139
|
+
--\n\n##### [custom_url](https://github.com/appium/ruby_lib/blob/621a9ebaf18bcd80eb0e1f5fc17fbb4dddf5293a/lib/appium_lib/driver.rb#L54) common
|
|
180
140
|
|
|
181
141
|
> def custom_url
|
|
182
142
|
|
|
183
143
|
Returns the value of attribute custom_url
|
|
184
144
|
|
|
185
|
-
|
|
186
|
-
|
|
187
|
-
##### [export_session](https://github.com/appium/ruby_lib/blob/c6eb8f5416ccdf75b161bc60c0986caec43d9ff8/lib/appium_lib/driver.rb#L55)
|
|
145
|
+
--\n\n##### [export_session](https://github.com/appium/ruby_lib/blob/621a9ebaf18bcd80eb0e1f5fc17fbb4dddf5293a/lib/appium_lib/driver.rb#L55) common
|
|
188
146
|
|
|
189
147
|
> def export_session
|
|
190
148
|
|
|
191
149
|
Returns the value of attribute export_session
|
|
192
150
|
|
|
193
|
-
|
|
194
|
-
|
|
195
|
-
##### [export_session_path](https://github.com/appium/ruby_lib/blob/c6eb8f5416ccdf75b161bc60c0986caec43d9ff8/lib/appium_lib/driver.rb#L56)
|
|
151
|
+
--\n\n##### [export_session_path](https://github.com/appium/ruby_lib/blob/621a9ebaf18bcd80eb0e1f5fc17fbb4dddf5293a/lib/appium_lib/driver.rb#L56) common
|
|
196
152
|
|
|
197
153
|
> def export_session_path
|
|
198
154
|
|
|
199
155
|
Returns the value of attribute export_session_path
|
|
200
156
|
|
|
201
|
-
|
|
202
|
-
|
|
203
|
-
##### [default_wait](https://github.com/appium/ruby_lib/blob/c6eb8f5416ccdf75b161bc60c0986caec43d9ff8/lib/appium_lib/driver.rb#L57)
|
|
157
|
+
--\n\n##### [default_wait](https://github.com/appium/ruby_lib/blob/621a9ebaf18bcd80eb0e1f5fc17fbb4dddf5293a/lib/appium_lib/driver.rb#L57) common
|
|
204
158
|
|
|
205
159
|
> def default_wait
|
|
206
160
|
|
|
207
161
|
Returns the value of attribute default_wait
|
|
208
162
|
|
|
209
|
-
|
|
210
|
-
|
|
211
|
-
##### [appium_port](https://github.com/appium/ruby_lib/blob/c6eb8f5416ccdf75b161bc60c0986caec43d9ff8/lib/appium_lib/driver.rb#L58)
|
|
163
|
+
--\n\n##### [appium_port](https://github.com/appium/ruby_lib/blob/621a9ebaf18bcd80eb0e1f5fc17fbb4dddf5293a/lib/appium_lib/driver.rb#L58) common
|
|
212
164
|
|
|
213
165
|
> def appium_port
|
|
214
166
|
|
|
215
167
|
Returns the value of attribute appium_port
|
|
216
168
|
|
|
217
|
-
|
|
218
|
-
|
|
219
|
-
##### [appium_device](https://github.com/appium/ruby_lib/blob/c6eb8f5416ccdf75b161bc60c0986caec43d9ff8/lib/appium_lib/driver.rb#L59)
|
|
169
|
+
--\n\n##### [appium_device](https://github.com/appium/ruby_lib/blob/621a9ebaf18bcd80eb0e1f5fc17fbb4dddf5293a/lib/appium_lib/driver.rb#L59) common
|
|
220
170
|
|
|
221
171
|
> def appium_device
|
|
222
172
|
|
|
223
173
|
Returns the value of attribute appium_device
|
|
224
174
|
|
|
225
|
-
|
|
226
|
-
|
|
227
|
-
##### [automation_name](https://github.com/appium/ruby_lib/blob/c6eb8f5416ccdf75b161bc60c0986caec43d9ff8/lib/appium_lib/driver.rb#L60)
|
|
175
|
+
--\n\n##### [automation_name](https://github.com/appium/ruby_lib/blob/621a9ebaf18bcd80eb0e1f5fc17fbb4dddf5293a/lib/appium_lib/driver.rb#L60) common
|
|
228
176
|
|
|
229
177
|
> def automation_name
|
|
230
178
|
|
|
231
179
|
Returns the value of attribute automation_name
|
|
232
180
|
|
|
233
|
-
|
|
234
|
-
|
|
235
|
-
##### [listener](https://github.com/appium/ruby_lib/blob/c6eb8f5416ccdf75b161bc60c0986caec43d9ff8/lib/appium_lib/driver.rb#L61)
|
|
181
|
+
--\n\n##### [listener](https://github.com/appium/ruby_lib/blob/621a9ebaf18bcd80eb0e1f5fc17fbb4dddf5293a/lib/appium_lib/driver.rb#L61) common
|
|
236
182
|
|
|
237
183
|
> def listener
|
|
238
184
|
|
|
239
185
|
Returns the value of attribute listener
|
|
240
186
|
|
|
241
|
-
|
|
242
|
-
|
|
243
|
-
##### [http_client](https://github.com/appium/ruby_lib/blob/c6eb8f5416ccdf75b161bc60c0986caec43d9ff8/lib/appium_lib/driver.rb#L62)
|
|
187
|
+
--\n\n##### [http_client](https://github.com/appium/ruby_lib/blob/621a9ebaf18bcd80eb0e1f5fc17fbb4dddf5293a/lib/appium_lib/driver.rb#L62) common
|
|
244
188
|
|
|
245
189
|
> def http_client
|
|
246
190
|
|
|
247
191
|
Returns the value of attribute http_client
|
|
248
192
|
|
|
249
|
-
|
|
250
|
-
|
|
251
|
-
##### [appium_wait_timeout](https://github.com/appium/ruby_lib/blob/c6eb8f5416ccdf75b161bc60c0986caec43d9ff8/lib/appium_lib/driver.rb#L63)
|
|
193
|
+
--\n\n##### [appium_wait_timeout](https://github.com/appium/ruby_lib/blob/621a9ebaf18bcd80eb0e1f5fc17fbb4dddf5293a/lib/appium_lib/driver.rb#L63) common
|
|
252
194
|
|
|
253
195
|
> def appium_wait_timeout
|
|
254
196
|
|
|
255
197
|
Returns the value of attribute appium_wait_timeout
|
|
256
198
|
|
|
257
|
-
|
|
258
|
-
|
|
259
|
-
##### [appium_wait_interval](https://github.com/appium/ruby_lib/blob/c6eb8f5416ccdf75b161bc60c0986caec43d9ff8/lib/appium_lib/driver.rb#L64)
|
|
199
|
+
--\n\n##### [appium_wait_interval](https://github.com/appium/ruby_lib/blob/621a9ebaf18bcd80eb0e1f5fc17fbb4dddf5293a/lib/appium_lib/driver.rb#L64) common
|
|
260
200
|
|
|
261
201
|
> def appium_wait_interval
|
|
262
202
|
|
|
263
203
|
Returns the value of attribute appium_wait_interval
|
|
264
204
|
|
|
265
|
-
|
|
266
|
-
|
|
267
|
-
##### [appium_server_status](https://github.com/appium/ruby_lib/blob/c6eb8f5416ccdf75b161bc60c0986caec43d9ff8/lib/appium_lib/driver.rb#L67)
|
|
205
|
+
--\n\n##### [appium_server_status](https://github.com/appium/ruby_lib/blob/621a9ebaf18bcd80eb0e1f5fc17fbb4dddf5293a/lib/appium_lib/driver.rb#L67) common
|
|
268
206
|
|
|
269
207
|
> def appium_server_status
|
|
270
208
|
|
|
271
209
|
Appium's server version
|
|
272
210
|
|
|
273
|
-
|
|
274
|
-
|
|
275
|
-
##### [appium_debug](https://github.com/appium/ruby_lib/blob/c6eb8f5416ccdf75b161bc60c0986caec43d9ff8/lib/appium_lib/driver.rb#L69)
|
|
211
|
+
--\n\n##### [appium_debug](https://github.com/appium/ruby_lib/blob/621a9ebaf18bcd80eb0e1f5fc17fbb4dddf5293a/lib/appium_lib/driver.rb#L69) common
|
|
276
212
|
|
|
277
213
|
> def appium_debug
|
|
278
214
|
|
|
279
215
|
Boolean debug mode for the Appium Ruby bindings
|
|
280
216
|
|
|
281
|
-
|
|
282
|
-
|
|
283
|
-
##### [driver](https://github.com/appium/ruby_lib/blob/c6eb8f5416ccdf75b161bc60c0986caec43d9ff8/lib/appium_lib/driver.rb#L72)
|
|
217
|
+
--\n\n##### [driver](https://github.com/appium/ruby_lib/blob/621a9ebaf18bcd80eb0e1f5fc17fbb4dddf5293a/lib/appium_lib/driver.rb#L72) common
|
|
284
218
|
|
|
285
219
|
> def driver
|
|
286
220
|
|
|
287
221
|
Returns the driver
|
|
288
222
|
|
|
289
|
-
__Returns:__
|
|
290
|
-
|
|
291
|
-
[Driver] the driver
|
|
223
|
+
__Returns:__\n\n [Driver] the driver
|
|
292
224
|
|
|
293
|
-
|
|
294
|
-
|
|
295
|
-
##### [core](https://github.com/appium/ruby_lib/blob/c6eb8f5416ccdf75b161bc60c0986caec43d9ff8/lib/appium_lib/driver.rb#L74)
|
|
225
|
+
--\n\n##### [core](https://github.com/appium/ruby_lib/blob/621a9ebaf18bcd80eb0e1f5fc17fbb4dddf5293a/lib/appium_lib/driver.rb#L74) common
|
|
296
226
|
|
|
297
227
|
> def core
|
|
298
228
|
|
|
299
229
|
Instance of Appium::Core::Driver
|
|
300
230
|
|
|
301
|
-
|
|
302
|
-
|
|
303
|
-
##### [initialize](https://github.com/appium/ruby_lib/blob/c6eb8f5416ccdf75b161bc60c0986caec43d9ff8/lib/appium_lib/driver.rb#L142)
|
|
231
|
+
--\n\n##### [initialize](https://github.com/appium/ruby_lib/blob/621a9ebaf18bcd80eb0e1f5fc17fbb4dddf5293a/lib/appium_lib/driver.rb#L142) common
|
|
304
232
|
|
|
305
233
|
> def initialize(opts = {}, global_driver = nil)
|
|
306
234
|
|
|
307
235
|
Creates a new driver. The driver is defined as global scope by default.
|
|
308
236
|
We can avoid defining global driver.
|
|
309
237
|
|
|
310
|
-
__Parameters:__
|
|
311
|
-
|
|
312
|
-
[Object] opts - A hash containing various options.
|
|
238
|
+
__Parameters:__\n\n [Object] opts - A hash containing various options.
|
|
313
239
|
|
|
314
240
|
[Bool] global_driver - A bool require global driver before initialize.
|
|
315
241
|
|
|
316
|
-
__Returns:__
|
|
317
|
-
|
|
318
|
-
[Driver]
|
|
242
|
+
__Returns:__\n\n [Driver]
|
|
319
243
|
|
|
320
|
-
|
|
321
|
-
|
|
322
|
-
##### [driver_attributes](https://github.com/appium/ruby_lib/blob/c6eb8f5416ccdf75b161bc60c0986caec43d9ff8/lib/appium_lib/driver.rb#L256)
|
|
244
|
+
--\n\n##### [driver_attributes](https://github.com/appium/ruby_lib/blob/621a9ebaf18bcd80eb0e1f5fc17fbb4dddf5293a/lib/appium_lib/driver.rb#L256) common
|
|
323
245
|
|
|
324
246
|
> def driver_attributes
|
|
325
247
|
|
|
326
248
|
Returns a hash of the driver attributes
|
|
327
249
|
|
|
328
|
-
|
|
329
|
-
|
|
330
|
-
##### [device_is_android?](https://github.com/appium/ruby_lib/blob/c6eb8f5416ccdf75b161bc60c0986caec43d9ff8/lib/appium_lib/driver.rb#L278)
|
|
250
|
+
--\n\n##### [device_is_android?](https://github.com/appium/ruby_lib/blob/621a9ebaf18bcd80eb0e1f5fc17fbb4dddf5293a/lib/appium_lib/driver.rb#L278) common
|
|
331
251
|
|
|
332
252
|
> def device_is_android?
|
|
333
253
|
|
|
334
254
|
|
|
335
255
|
|
|
336
|
-
__Returns:__
|
|
256
|
+
__Returns:__\n\n [Boolean]
|
|
337
257
|
|
|
338
|
-
|
|
339
|
-
|
|
340
|
-
--
|
|
341
|
-
|
|
342
|
-
##### [device_is_ios?](https://github.com/appium/ruby_lib/blob/c6eb8f5416ccdf75b161bc60c0986caec43d9ff8/lib/appium_lib/driver.rb#L282)
|
|
258
|
+
--\n\n##### [device_is_ios?](https://github.com/appium/ruby_lib/blob/621a9ebaf18bcd80eb0e1f5fc17fbb4dddf5293a/lib/appium_lib/driver.rb#L282) common
|
|
343
259
|
|
|
344
260
|
> def device_is_ios?
|
|
345
261
|
|
|
346
262
|
|
|
347
263
|
|
|
348
|
-
__Returns:__
|
|
349
|
-
|
|
350
|
-
[Boolean]
|
|
351
|
-
|
|
352
|
-
--
|
|
264
|
+
__Returns:__\n\n [Boolean]
|
|
353
265
|
|
|
354
|
-
##### [device_is_windows?](https://github.com/appium/ruby_lib/blob/
|
|
266
|
+
--\n\n##### [device_is_windows?](https://github.com/appium/ruby_lib/blob/621a9ebaf18bcd80eb0e1f5fc17fbb4dddf5293a/lib/appium_lib/driver.rb#L286) common
|
|
355
267
|
|
|
356
268
|
> def device_is_windows?
|
|
357
269
|
|
|
358
270
|
|
|
359
271
|
|
|
360
|
-
__Returns:__
|
|
272
|
+
__Returns:__\n\n [Boolean]
|
|
361
273
|
|
|
362
|
-
|
|
363
|
-
|
|
364
|
-
--
|
|
365
|
-
|
|
366
|
-
##### [automation_name_is_uiautomator2?](https://github.com/appium/ruby_lib/blob/c6eb8f5416ccdf75b161bc60c0986caec43d9ff8/lib/appium_lib/driver.rb#L292)
|
|
274
|
+
--\n\n##### [automation_name_is_uiautomator2?](https://github.com/appium/ruby_lib/blob/621a9ebaf18bcd80eb0e1f5fc17fbb4dddf5293a/lib/appium_lib/driver.rb#L292) common
|
|
367
275
|
|
|
368
276
|
> def automation_name_is_uiautomator2?
|
|
369
277
|
|
|
370
278
|
Return true if automationName is 'uiautomator2'
|
|
371
279
|
|
|
372
|
-
__Returns:__
|
|
373
|
-
|
|
374
|
-
[Boolean]
|
|
375
|
-
|
|
376
|
-
--
|
|
280
|
+
__Returns:__\n\n [Boolean]
|
|
377
281
|
|
|
378
|
-
##### [automation_name_is_espresso?](https://github.com/appium/ruby_lib/blob/
|
|
282
|
+
--\n\n##### [automation_name_is_espresso?](https://github.com/appium/ruby_lib/blob/621a9ebaf18bcd80eb0e1f5fc17fbb4dddf5293a/lib/appium_lib/driver.rb#L298) common
|
|
379
283
|
|
|
380
284
|
> def automation_name_is_espresso?
|
|
381
285
|
|
|
382
286
|
Return true if automationName is 'Espresso'
|
|
383
287
|
|
|
384
|
-
__Returns:__
|
|
288
|
+
__Returns:__\n\n [Boolean]
|
|
385
289
|
|
|
386
|
-
|
|
387
|
-
|
|
388
|
-
--
|
|
389
|
-
|
|
390
|
-
##### [automation_name_is_xcuitest?](https://github.com/appium/ruby_lib/blob/c6eb8f5416ccdf75b161bc60c0986caec43d9ff8/lib/appium_lib/driver.rb#L304)
|
|
290
|
+
--\n\n##### [automation_name_is_xcuitest?](https://github.com/appium/ruby_lib/blob/621a9ebaf18bcd80eb0e1f5fc17fbb4dddf5293a/lib/appium_lib/driver.rb#L304) common
|
|
391
291
|
|
|
392
292
|
> def automation_name_is_xcuitest?
|
|
393
293
|
|
|
394
294
|
Return true if automationName is 'XCUITest'
|
|
395
295
|
|
|
396
|
-
__Returns:__
|
|
397
|
-
|
|
398
|
-
[Boolean]
|
|
399
|
-
|
|
400
|
-
--
|
|
296
|
+
__Returns:__\n\n [Boolean]
|
|
401
297
|
|
|
402
|
-
##### [dialect](https://github.com/appium/ruby_lib/blob/
|
|
298
|
+
--\n\n##### [dialect](https://github.com/appium/ruby_lib/blob/621a9ebaf18bcd80eb0e1f5fc17fbb4dddf5293a/lib/appium_lib/driver.rb#L324) common
|
|
403
299
|
|
|
404
300
|
> def dialect
|
|
405
301
|
|
|
406
302
|
Get the dialect value whether current driver is OSS or W3C
|
|
407
303
|
|
|
408
|
-
__Returns:__
|
|
409
|
-
|
|
410
|
-
[:oss | :w3c] @example
|
|
304
|
+
__Returns:__\n\n [:oss | :w3c] @example
|
|
411
305
|
|
|
412
306
|
if dialect == :w3c
|
|
413
307
|
driver.action
|
|
@@ -419,70 +313,48 @@ __Returns:__
|
|
|
419
313
|
action.perform
|
|
420
314
|
end
|
|
421
315
|
|
|
422
|
-
|
|
423
|
-
|
|
424
|
-
##### [check_server_version_xcuitest](https://github.com/appium/ruby_lib/blob/c6eb8f5416ccdf75b161bc60c0986caec43d9ff8/lib/appium_lib/driver.rb#L331)
|
|
316
|
+
--\n\n##### [check_server_version_xcuitest](https://github.com/appium/ruby_lib/blob/621a9ebaf18bcd80eb0e1f5fc17fbb4dddf5293a/lib/appium_lib/driver.rb#L331) common
|
|
425
317
|
|
|
426
318
|
> def check_server_version_xcuitest
|
|
427
319
|
|
|
428
320
|
Return true if the target Appium server is over REQUIRED_VERSION_XCUITEST.
|
|
429
321
|
If the Appium server is under REQUIRED_VERSION_XCUITEST, then error is raised.
|
|
430
322
|
|
|
431
|
-
__Returns:__
|
|
432
|
-
|
|
433
|
-
[Boolean]
|
|
434
|
-
|
|
435
|
-
--
|
|
323
|
+
__Returns:__\n\n [Boolean]
|
|
436
324
|
|
|
437
|
-
##### [appium_server_version](https://github.com/appium/ruby_lib/blob/
|
|
325
|
+
--\n\n##### [appium_server_version](https://github.com/appium/ruby_lib/blob/621a9ebaf18bcd80eb0e1f5fc17fbb4dddf5293a/lib/appium_lib/driver.rb#L353) common
|
|
438
326
|
|
|
439
327
|
> def appium_server_version
|
|
440
328
|
|
|
441
329
|
Returns the server's version info
|
|
442
330
|
|
|
443
|
-
__Returns:__
|
|
331
|
+
__Returns:__\n\n [Hash]
|
|
444
332
|
|
|
445
|
-
|
|
446
|
-
|
|
447
|
-
--
|
|
448
|
-
|
|
449
|
-
##### [remote_status](https://github.com/appium/ruby_lib/blob/c6eb8f5416ccdf75b161bc60c0986caec43d9ff8/lib/appium_lib/driver.rb#L361)
|
|
333
|
+
--\n\n##### [remote_status](https://github.com/appium/ruby_lib/blob/621a9ebaf18bcd80eb0e1f5fc17fbb4dddf5293a/lib/appium_lib/driver.rb#L361) common
|
|
450
334
|
|
|
451
335
|
> def appium_server_version
|
|
452
336
|
|
|
453
337
|
Returns the server's version info
|
|
454
338
|
|
|
455
|
-
__Returns:__
|
|
456
|
-
|
|
457
|
-
[Hash]
|
|
458
|
-
|
|
459
|
-
--
|
|
339
|
+
__Returns:__\n\n [Hash]
|
|
460
340
|
|
|
461
|
-
##### [platform_version](https://github.com/appium/ruby_lib/blob/
|
|
341
|
+
--\n\n##### [platform_version](https://github.com/appium/ruby_lib/blob/621a9ebaf18bcd80eb0e1f5fc17fbb4dddf5293a/lib/appium_lib/driver.rb#L365) common
|
|
462
342
|
|
|
463
343
|
> def platform_version
|
|
464
344
|
|
|
465
345
|
Return the platform version as an array of integers
|
|
466
346
|
|
|
467
|
-
__Returns:__
|
|
347
|
+
__Returns:__\n\n [Array<Integer>]
|
|
468
348
|
|
|
469
|
-
|
|
470
|
-
|
|
471
|
-
--
|
|
472
|
-
|
|
473
|
-
##### [appium_client_version](https://github.com/appium/ruby_lib/blob/c6eb8f5416ccdf75b161bc60c0986caec43d9ff8/lib/appium_lib/driver.rb#L378)
|
|
349
|
+
--\n\n##### [appium_client_version](https://github.com/appium/ruby_lib/blob/621a9ebaf18bcd80eb0e1f5fc17fbb4dddf5293a/lib/appium_lib/driver.rb#L378) common
|
|
474
350
|
|
|
475
351
|
> def appium_client_version
|
|
476
352
|
|
|
477
353
|
Returns the client's version info
|
|
478
354
|
|
|
479
|
-
__Returns:__
|
|
480
|
-
|
|
481
|
-
[Hash]
|
|
482
|
-
|
|
483
|
-
--
|
|
355
|
+
__Returns:__\n\n [Hash]
|
|
484
356
|
|
|
485
|
-
##### [absolute_app_path](https://github.com/appium/ruby_lib/blob/
|
|
357
|
+
--\n\n##### [absolute_app_path](https://github.com/appium/ruby_lib/blob/621a9ebaf18bcd80eb0e1f5fc17fbb4dddf5293a/lib/appium_lib/driver.rb#L390) common
|
|
486
358
|
|
|
487
359
|
> def self.absolute_app_path(opts)
|
|
488
360
|
|
|
@@ -493,107 +365,71 @@ then the app path is used as is.
|
|
|
493
365
|
|
|
494
366
|
if app isn't set then an error is raised.
|
|
495
367
|
|
|
496
|
-
__Returns:__
|
|
368
|
+
__Returns:__\n\n [String] APP_PATH as an absolute path
|
|
497
369
|
|
|
498
|
-
|
|
499
|
-
|
|
500
|
-
--
|
|
501
|
-
|
|
502
|
-
##### [server_url](https://github.com/appium/ruby_lib/blob/c6eb8f5416ccdf75b161bc60c0986caec43d9ff8/lib/appium_lib/driver.rb#L408)
|
|
370
|
+
--\n\n##### [server_url](https://github.com/appium/ruby_lib/blob/621a9ebaf18bcd80eb0e1f5fc17fbb4dddf5293a/lib/appium_lib/driver.rb#L413) common
|
|
503
371
|
|
|
504
372
|
> def server_url
|
|
505
373
|
|
|
506
374
|
Get the server url
|
|
507
375
|
|
|
508
|
-
__Returns:__
|
|
509
|
-
|
|
510
|
-
[String] the server url
|
|
511
|
-
|
|
512
|
-
--
|
|
376
|
+
__Returns:__\n\n [String] the server url
|
|
513
377
|
|
|
514
|
-
##### [restart](https://github.com/appium/ruby_lib/blob/
|
|
378
|
+
--\n\n##### [restart](https://github.com/appium/ruby_lib/blob/621a9ebaf18bcd80eb0e1f5fc17fbb4dddf5293a/lib/appium_lib/driver.rb#L422) common
|
|
515
379
|
|
|
516
380
|
> def restart
|
|
517
381
|
|
|
518
382
|
Restarts the driver
|
|
519
383
|
|
|
520
|
-
__Returns:__
|
|
384
|
+
__Returns:__\n\n [Driver] the driver
|
|
521
385
|
|
|
522
|
-
|
|
523
|
-
|
|
524
|
-
--
|
|
525
|
-
|
|
526
|
-
##### [screenshot](https://github.com/appium/ruby_lib/blob/c6eb8f5416ccdf75b161bc60c0986caec43d9ff8/lib/appium_lib/driver.rb#L430)
|
|
386
|
+
--\n\n##### [screenshot](https://github.com/appium/ruby_lib/blob/621a9ebaf18bcd80eb0e1f5fc17fbb4dddf5293a/lib/appium_lib/driver.rb#L435) common
|
|
527
387
|
|
|
528
388
|
> def screenshot(png_save_path)
|
|
529
389
|
|
|
530
390
|
Takes a png screenshot and saves to the target path.
|
|
531
391
|
|
|
532
|
-
__Parameters:__
|
|
533
|
-
|
|
534
|
-
[String] png_save_path - the full path to save the png
|
|
535
|
-
|
|
536
|
-
__Returns:__
|
|
537
|
-
|
|
538
|
-
[File]
|
|
392
|
+
__Parameters:__\n\n [String] png_save_path - the full path to save the png
|
|
539
393
|
|
|
540
|
-
|
|
394
|
+
__Returns:__\n\n [File]
|
|
541
395
|
|
|
542
|
-
##### [element_screenshot](https://github.com/appium/ruby_lib/blob/
|
|
396
|
+
--\n\n##### [element_screenshot](https://github.com/appium/ruby_lib/blob/621a9ebaf18bcd80eb0e1f5fc17fbb4dddf5293a/lib/appium_lib/driver.rb#L449) common
|
|
543
397
|
|
|
544
398
|
> def element_screenshot(element, png_save_path)
|
|
545
399
|
|
|
546
400
|
Takes a png screenshot of particular element's area
|
|
547
401
|
|
|
548
|
-
__Parameters:__
|
|
549
|
-
|
|
550
|
-
[String] element - Element take a screenshot
|
|
402
|
+
__Parameters:__\n\n [String] element - Element take a screenshot
|
|
551
403
|
|
|
552
404
|
[String] png_save_path - the full path to save the png
|
|
553
405
|
|
|
554
|
-
__Returns:__
|
|
555
|
-
|
|
556
|
-
[File]
|
|
406
|
+
__Returns:__\n\n [File]
|
|
557
407
|
|
|
558
|
-
|
|
559
|
-
|
|
560
|
-
##### [driver_quit](https://github.com/appium/ruby_lib/blob/c6eb8f5416ccdf75b161bc60c0986caec43d9ff8/lib/appium_lib/driver.rb#L451)
|
|
408
|
+
--\n\n##### [driver_quit](https://github.com/appium/ruby_lib/blob/621a9ebaf18bcd80eb0e1f5fc17fbb4dddf5293a/lib/appium_lib/driver.rb#L456) common
|
|
561
409
|
|
|
562
410
|
> def driver_quit
|
|
563
411
|
|
|
564
412
|
Quits the driver
|
|
565
413
|
|
|
566
|
-
__Returns:__
|
|
567
|
-
|
|
568
|
-
[void]
|
|
414
|
+
__Returns:__\n\n [void]
|
|
569
415
|
|
|
570
|
-
|
|
571
|
-
|
|
572
|
-
##### [quit_driver](https://github.com/appium/ruby_lib/blob/c6eb8f5416ccdf75b161bc60c0986caec43d9ff8/lib/appium_lib/driver.rb#L454)
|
|
416
|
+
--\n\n##### [quit_driver](https://github.com/appium/ruby_lib/blob/621a9ebaf18bcd80eb0e1f5fc17fbb4dddf5293a/lib/appium_lib/driver.rb#L459) common
|
|
573
417
|
|
|
574
418
|
> def driver_quit
|
|
575
419
|
|
|
576
420
|
Quits the driver
|
|
577
421
|
|
|
578
|
-
__Returns:__
|
|
579
|
-
|
|
580
|
-
[void]
|
|
422
|
+
__Returns:__\n\n [void]
|
|
581
423
|
|
|
582
|
-
|
|
583
|
-
|
|
584
|
-
##### [window_size](https://github.com/appium/ruby_lib/blob/c6eb8f5416ccdf75b161bc60c0986caec43d9ff8/lib/appium_lib/driver.rb#L465)
|
|
424
|
+
--\n\n##### [window_size](https://github.com/appium/ruby_lib/blob/621a9ebaf18bcd80eb0e1f5fc17fbb4dddf5293a/lib/appium_lib/driver.rb#L470) common
|
|
585
425
|
|
|
586
426
|
> def window_size
|
|
587
427
|
|
|
588
428
|
Get the device window's size.
|
|
589
429
|
|
|
590
|
-
__Returns:__
|
|
591
|
-
|
|
592
|
-
[Selenium::WebDriver::Dimension]
|
|
430
|
+
__Returns:__\n\n [Selenium::WebDriver::Dimension]
|
|
593
431
|
|
|
594
|
-
|
|
595
|
-
|
|
596
|
-
##### [start_driver](https://github.com/appium/ruby_lib/blob/c6eb8f5416ccdf75b161bc60c0986caec43d9ff8/lib/appium_lib/driver.rb#L498)
|
|
432
|
+
--\n\n##### [start_driver](https://github.com/appium/ruby_lib/blob/621a9ebaf18bcd80eb0e1f5fc17fbb4dddf5293a/lib/appium_lib/driver.rb#L503) common
|
|
597
433
|
|
|
598
434
|
> def start_driver(http_client_ops =
|
|
599
435
|
|
|
@@ -603,49 +439,33 @@ You can customise http_client as the following
|
|
|
603
439
|
Read http://www.rubydoc.info/github/appium/ruby_lib_core/Appium/Core/Device to understand more what the driver
|
|
604
440
|
can call instance methods.
|
|
605
441
|
|
|
606
|
-
__Parameters:__
|
|
607
|
-
|
|
608
|
-
[Hash] http_client_ops - a customizable set of options
|
|
442
|
+
__Parameters:__\n\n [Hash] http_client_ops - a customizable set of options
|
|
609
443
|
|
|
610
|
-
__Returns:__
|
|
444
|
+
__Returns:__\n\n [Selenium::WebDriver] the new global driver
|
|
611
445
|
|
|
612
|
-
|
|
613
|
-
|
|
614
|
-
--
|
|
615
|
-
|
|
616
|
-
##### [set_implicit_wait](https://github.com/appium/ruby_lib/blob/c6eb8f5416ccdf75b161bc60c0986caec43d9ff8/lib/appium_lib/driver.rb#L520)
|
|
446
|
+
--\n\n##### [set_implicit_wait](https://github.com/appium/ruby_lib/blob/621a9ebaf18bcd80eb0e1f5fc17fbb4dddf5293a/lib/appium_lib/driver.rb#L525) common
|
|
617
447
|
|
|
618
448
|
> def set_implicit_wait(wait)
|
|
619
449
|
|
|
620
450
|
To ignore error for Espresso Driver
|
|
621
451
|
|
|
622
|
-
|
|
623
|
-
|
|
624
|
-
##### [no_wait](https://github.com/appium/ruby_lib/blob/c6eb8f5416ccdf75b161bc60c0986caec43d9ff8/lib/appium_lib/driver.rb#L531)
|
|
452
|
+
--\n\n##### [no_wait](https://github.com/appium/ruby_lib/blob/621a9ebaf18bcd80eb0e1f5fc17fbb4dddf5293a/lib/appium_lib/driver.rb#L536) common
|
|
625
453
|
|
|
626
454
|
> def no_wait
|
|
627
455
|
|
|
628
456
|
Set implicit wait to zero.
|
|
629
457
|
|
|
630
|
-
|
|
631
|
-
|
|
632
|
-
##### [set_wait](https://github.com/appium/ruby_lib/blob/c6eb8f5416ccdf75b161bc60c0986caec43d9ff8/lib/appium_lib/driver.rb#L545)
|
|
458
|
+
--\n\n##### [set_wait](https://github.com/appium/ruby_lib/blob/621a9ebaf18bcd80eb0e1f5fc17fbb4dddf5293a/lib/appium_lib/driver.rb#L550) common
|
|
633
459
|
|
|
634
460
|
> def set_wait(timeout = nil)
|
|
635
461
|
|
|
636
462
|
Set implicit wait. Default to @core.default_wait.
|
|
637
463
|
|
|
638
|
-
__Parameters:__
|
|
464
|
+
__Parameters:__\n\n [Integer] timeout - the timeout in seconds
|
|
639
465
|
|
|
640
|
-
[
|
|
466
|
+
__Returns:__\n\n [void]
|
|
641
467
|
|
|
642
|
-
|
|
643
|
-
|
|
644
|
-
[void]
|
|
645
|
-
|
|
646
|
-
--
|
|
647
|
-
|
|
648
|
-
##### [exists](https://github.com/appium/ruby_lib/blob/c6eb8f5416ccdf75b161bc60c0986caec43d9ff8/lib/appium_lib/driver.rb#L562)
|
|
468
|
+
--\n\n##### [exists](https://github.com/appium/ruby_lib/blob/621a9ebaf18bcd80eb0e1f5fc17fbb4dddf5293a/lib/appium_lib/driver.rb#L567) common
|
|
649
469
|
|
|
650
470
|
> def exists(pre_check = 0, post_check = @core.default_wait)
|
|
651
471
|
|
|
@@ -655,39 +475,27 @@ Example:
|
|
|
655
475
|
|
|
656
476
|
exists { button('sign in') } ? puts('true') : puts('false')
|
|
657
477
|
|
|
658
|
-
__Parameters:__
|
|
659
|
-
|
|
660
|
-
[Integer] pre_check - The amount in seconds to set the
|
|
478
|
+
__Parameters:__\n\n [Integer] pre_check - The amount in seconds to set the
|
|
661
479
|
wait to before checking existence
|
|
662
480
|
|
|
663
481
|
[Integer] post_check - The amount in seconds to set the
|
|
664
482
|
wait to after checking existence
|
|
665
483
|
|
|
666
|
-
__Returns:__
|
|
484
|
+
__Returns:__\n\n [Boolean]
|
|
667
485
|
|
|
668
|
-
|
|
669
|
-
|
|
670
|
-
--
|
|
671
|
-
|
|
672
|
-
##### [execute_script](https://github.com/appium/ruby_lib/blob/c6eb8f5416ccdf75b161bc60c0986caec43d9ff8/lib/appium_lib/driver.rb#L586)
|
|
486
|
+
--\n\n##### [execute_script](https://github.com/appium/ruby_lib/blob/621a9ebaf18bcd80eb0e1f5fc17fbb4dddf5293a/lib/appium_lib/driver.rb#L591) common
|
|
673
487
|
|
|
674
488
|
> def execute_script(script, *args)
|
|
675
489
|
|
|
676
490
|
The same as @driver.execute_script
|
|
677
491
|
|
|
678
|
-
__Parameters:__
|
|
679
|
-
|
|
680
|
-
[String] script - The script to execute
|
|
492
|
+
__Parameters:__\n\n [String] script - The script to execute
|
|
681
493
|
|
|
682
494
|
[*args] args - The args to pass to the script
|
|
683
495
|
|
|
684
|
-
__Returns:__
|
|
685
|
-
|
|
686
|
-
[Object]
|
|
496
|
+
__Returns:__\n\n [Object]
|
|
687
497
|
|
|
688
|
-
|
|
689
|
-
|
|
690
|
-
##### [execute_async_script](https://github.com/appium/ruby_lib/blob/c6eb8f5416ccdf75b161bc60c0986caec43d9ff8/lib/appium_lib/driver.rb#L594)
|
|
498
|
+
--\n\n##### [execute_async_script](https://github.com/appium/ruby_lib/blob/621a9ebaf18bcd80eb0e1f5fc17fbb4dddf5293a/lib/appium_lib/driver.rb#L599) common
|
|
691
499
|
|
|
692
500
|
> def execute_async_script(script, *args)
|
|
693
501
|
|
|
@@ -695,77 +503,57 @@ Wrap calling selenium webdrier APIs via ruby_core
|
|
|
695
503
|
|
|
696
504
|
Get the window handles of open browser windows
|
|
697
505
|
|
|
698
|
-
|
|
699
|
-
|
|
700
|
-
##### [window_handles](https://github.com/appium/ruby_lib/blob/c6eb8f5416ccdf75b161bc60c0986caec43d9ff8/lib/appium_lib/driver.rb#L598)
|
|
506
|
+
--\n\n##### [window_handles](https://github.com/appium/ruby_lib/blob/621a9ebaf18bcd80eb0e1f5fc17fbb4dddf5293a/lib/appium_lib/driver.rb#L603) common
|
|
701
507
|
|
|
702
508
|
> def window_handles
|
|
703
509
|
|
|
704
510
|
|
|
705
511
|
|
|
706
|
-
|
|
707
|
-
|
|
708
|
-
##### [window_handle](https://github.com/appium/ruby_lib/blob/c6eb8f5416ccdf75b161bc60c0986caec43d9ff8/lib/appium_lib/driver.rb#L603)
|
|
512
|
+
--\n\n##### [window_handle](https://github.com/appium/ruby_lib/blob/621a9ebaf18bcd80eb0e1f5fc17fbb4dddf5293a/lib/appium_lib/driver.rb#L608) common
|
|
709
513
|
|
|
710
514
|
> def window_handle
|
|
711
515
|
|
|
712
516
|
Get the current window handle
|
|
713
517
|
|
|
714
|
-
|
|
715
|
-
|
|
716
|
-
##### [navigate](https://github.com/appium/ruby_lib/blob/c6eb8f5416ccdf75b161bc60c0986caec43d9ff8/lib/appium_lib/driver.rb#L607)
|
|
518
|
+
--\n\n##### [navigate](https://github.com/appium/ruby_lib/blob/621a9ebaf18bcd80eb0e1f5fc17fbb4dddf5293a/lib/appium_lib/driver.rb#L612) common
|
|
717
519
|
|
|
718
520
|
> def navigate
|
|
719
521
|
|
|
720
522
|
|
|
721
523
|
|
|
722
|
-
|
|
723
|
-
|
|
724
|
-
##### [manage](https://github.com/appium/ruby_lib/blob/c6eb8f5416ccdf75b161bc60c0986caec43d9ff8/lib/appium_lib/driver.rb#L611)
|
|
524
|
+
--\n\n##### [manage](https://github.com/appium/ruby_lib/blob/621a9ebaf18bcd80eb0e1f5fc17fbb4dddf5293a/lib/appium_lib/driver.rb#L616) common
|
|
725
525
|
|
|
726
526
|
> def manage
|
|
727
527
|
|
|
728
528
|
|
|
729
529
|
|
|
730
|
-
|
|
731
|
-
|
|
732
|
-
##### [get](https://github.com/appium/ruby_lib/blob/c6eb8f5416ccdf75b161bc60c0986caec43d9ff8/lib/appium_lib/driver.rb#L615)
|
|
530
|
+
--\n\n##### [get](https://github.com/appium/ruby_lib/blob/621a9ebaf18bcd80eb0e1f5fc17fbb4dddf5293a/lib/appium_lib/driver.rb#L620) common
|
|
733
531
|
|
|
734
532
|
> def get(url)
|
|
735
533
|
|
|
736
534
|
|
|
737
535
|
|
|
738
|
-
|
|
739
|
-
|
|
740
|
-
##### [current_url](https://github.com/appium/ruby_lib/blob/c6eb8f5416ccdf75b161bc60c0986caec43d9ff8/lib/appium_lib/driver.rb#L619)
|
|
536
|
+
--\n\n##### [current_url](https://github.com/appium/ruby_lib/blob/621a9ebaf18bcd80eb0e1f5fc17fbb4dddf5293a/lib/appium_lib/driver.rb#L624) common
|
|
741
537
|
|
|
742
538
|
> def current_url
|
|
743
539
|
|
|
744
540
|
|
|
745
541
|
|
|
746
|
-
|
|
747
|
-
|
|
748
|
-
##### [title](https://github.com/appium/ruby_lib/blob/c6eb8f5416ccdf75b161bc60c0986caec43d9ff8/lib/appium_lib/driver.rb#L623)
|
|
542
|
+
--\n\n##### [title](https://github.com/appium/ruby_lib/blob/621a9ebaf18bcd80eb0e1f5fc17fbb4dddf5293a/lib/appium_lib/driver.rb#L628) common
|
|
749
543
|
|
|
750
544
|
> def title
|
|
751
545
|
|
|
752
546
|
|
|
753
547
|
|
|
754
|
-
|
|
755
|
-
|
|
756
|
-
##### [switch_to](https://github.com/appium/ruby_lib/blob/c6eb8f5416ccdf75b161bc60c0986caec43d9ff8/lib/appium_lib/driver.rb#L629)
|
|
548
|
+
--\n\n##### [switch_to](https://github.com/appium/ruby_lib/blob/621a9ebaf18bcd80eb0e1f5fc17fbb4dddf5293a/lib/appium_lib/driver.rb#L634) common
|
|
757
549
|
|
|
758
550
|
> def switch_to
|
|
759
551
|
|
|
760
552
|
|
|
761
553
|
|
|
762
|
-
__Returns:__
|
|
763
|
-
|
|
764
|
-
[TargetLocator]
|
|
554
|
+
__Returns:__\n\n [TargetLocator]
|
|
765
555
|
|
|
766
|
-
|
|
767
|
-
|
|
768
|
-
##### [find_elements](https://github.com/appium/ruby_lib/blob/c6eb8f5416ccdf75b161bc60c0986caec43d9ff8/lib/appium_lib/driver.rb#L656)
|
|
556
|
+
--\n\n##### [find_elements](https://github.com/appium/ruby_lib/blob/621a9ebaf18bcd80eb0e1f5fc17fbb4dddf5293a/lib/appium_lib/driver.rb#L661) common
|
|
769
557
|
|
|
770
558
|
> def find_elements(*args)
|
|
771
559
|
|
|
@@ -775,17 +563,11 @@ If you call `Appium.promote_appium_methods`, you can call `find_elements` direct
|
|
|
775
563
|
|
|
776
564
|
If you call `Appium.promote_appium_methods`, you can call `find_elements` directly.
|
|
777
565
|
|
|
778
|
-
__Parameters:__
|
|
779
|
-
|
|
780
|
-
[*args] args - The args to use
|
|
566
|
+
__Parameters:__\n\n [*args] args - The args to use
|
|
781
567
|
|
|
782
|
-
__Returns:__
|
|
568
|
+
__Returns:__\n\n [Array<Element>] Array is empty when no elements are found.
|
|
783
569
|
|
|
784
|
-
|
|
785
|
-
|
|
786
|
-
--
|
|
787
|
-
|
|
788
|
-
##### [find_element](https://github.com/appium/ruby_lib/blob/c6eb8f5416ccdf75b161bc60c0986caec43d9ff8/lib/appium_lib/driver.rb#L672)
|
|
570
|
+
--\n\n##### [find_element](https://github.com/appium/ruby_lib/blob/621a9ebaf18bcd80eb0e1f5fc17fbb4dddf5293a/lib/appium_lib/driver.rb#L677) common
|
|
789
571
|
|
|
790
572
|
> def find_element(*args)
|
|
791
573
|
|
|
@@ -793,188 +575,128 @@ Calls @driver.find_element
|
|
|
793
575
|
|
|
794
576
|
If you call `Appium.promote_appium_methods`, you can call `find_element` directly.
|
|
795
577
|
|
|
796
|
-
__Parameters:__
|
|
797
|
-
|
|
798
|
-
[*args] args - The args to use
|
|
799
|
-
|
|
800
|
-
__Returns:__
|
|
578
|
+
__Parameters:__\n\n [*args] args - The args to use
|
|
801
579
|
|
|
802
|
-
[Element]
|
|
580
|
+
__Returns:__\n\n [Element]
|
|
803
581
|
|
|
804
|
-
|
|
805
|
-
|
|
806
|
-
##### [DEFAULT_MATCH_THRESHOLD](https://github.com/appium/ruby_lib/blob/c6eb8f5416ccdf75b161bc60c0986caec43d9ff8/lib/appium_lib/driver.rb#L690)
|
|
582
|
+
--\n\n##### [DEFAULT_MATCH_THRESHOLD](https://github.com/appium/ruby_lib/blob/621a9ebaf18bcd80eb0e1f5fc17fbb4dddf5293a/lib/appium_lib/driver.rb#L695) common
|
|
807
583
|
|
|
808
584
|
> DEFAULT_MATCH_THRESHOLD = 0.5
|
|
809
585
|
|
|
810
586
|
Return ImageElement if current view has a partial image
|
|
811
587
|
|
|
812
|
-
__Parameters:__
|
|
813
|
-
|
|
814
|
-
[String] png_img_path - A path to a partial image you'd like to find
|
|
588
|
+
__Parameters:__\n\n [String] png_img_path - A path to a partial image you'd like to find
|
|
815
589
|
|
|
816
590
|
[Flood] match_threshold - At what normalized threshold to reject
|
|
817
591
|
|
|
818
592
|
[Bool] visualize - Makes the endpoint to return an image, which contains the visualized result of
|
|
819
593
|
the corresponding picture matching operation. This option is disabled by default.
|
|
820
594
|
|
|
821
|
-
__Returns:__
|
|
822
|
-
|
|
823
|
-
[::Appium::Core::ImageElement]
|
|
824
|
-
|
|
825
|
-
--
|
|
595
|
+
__Returns:__\n\n [::Appium::Core::ImageElement]
|
|
826
596
|
|
|
827
|
-
##### [find_element_by_image](https://github.com/appium/ruby_lib/blob/
|
|
597
|
+
--\n\n##### [find_element_by_image](https://github.com/appium/ruby_lib/blob/621a9ebaf18bcd80eb0e1f5fc17fbb4dddf5293a/lib/appium_lib/driver.rb#L696) common
|
|
828
598
|
|
|
829
599
|
> def find_element_by_image(png_img_path, match_threshold: DEFAULT_MATCH_THRESHOLD, visualize: false)
|
|
830
600
|
|
|
831
601
|
|
|
832
602
|
|
|
833
|
-
|
|
834
|
-
|
|
835
|
-
##### [find_elements_by_image](https://github.com/appium/ruby_lib/blob/c6eb8f5416ccdf75b161bc60c0986caec43d9ff8/lib/appium_lib/driver.rb#L709)
|
|
603
|
+
--\n\n##### [find_elements_by_image](https://github.com/appium/ruby_lib/blob/621a9ebaf18bcd80eb0e1f5fc17fbb4dddf5293a/lib/appium_lib/driver.rb#L714) common
|
|
836
604
|
|
|
837
605
|
> def find_elements_by_image(png_img_paths, match_threshold: DEFAULT_MATCH_THRESHOLD, visualize: false)
|
|
838
606
|
|
|
839
607
|
Return ImageElement if current view has partial images
|
|
840
608
|
|
|
841
|
-
__Parameters:__
|
|
842
|
-
|
|
843
|
-
[[String]] png_img_paths - Paths to a partial image you'd like to find
|
|
609
|
+
__Parameters:__\n\n [[String]] png_img_paths - Paths to a partial image you'd like to find
|
|
844
610
|
|
|
845
611
|
[Flood] match_threshold - At what normalized threshold to reject
|
|
846
612
|
|
|
847
613
|
[Bool] visualize - Makes the endpoint to return an image, which contains the visualized result of
|
|
848
614
|
the corresponding picture matching operation. This option is disabled by default.
|
|
849
615
|
|
|
850
|
-
__Returns:__
|
|
851
|
-
|
|
852
|
-
[[::Appium::Core::ImageElement]]
|
|
853
|
-
|
|
854
|
-
--
|
|
616
|
+
__Returns:__\n\n [[::Appium::Core::ImageElement]]
|
|
855
617
|
|
|
856
|
-
##### [set_location](https://github.com/appium/ruby_lib/blob/
|
|
618
|
+
--\n\n##### [set_location](https://github.com/appium/ruby_lib/blob/621a9ebaf18bcd80eb0e1f5fc17fbb4dddf5293a/lib/appium_lib/driver.rb#L727) common
|
|
857
619
|
|
|
858
620
|
> def set_location(opts = {})
|
|
859
621
|
|
|
860
622
|
Calls @driver.set_location
|
|
861
623
|
|
|
862
|
-
__Parameters:__
|
|
624
|
+
__Parameters:__\n\n [Hash] opts - consisting of:
|
|
863
625
|
|
|
864
|
-
[
|
|
626
|
+
__Returns:__\n\n [Selenium::WebDriver::Location] the location constructed by the selenium webdriver
|
|
865
627
|
|
|
866
|
-
|
|
867
|
-
|
|
868
|
-
[Selenium::WebDriver::Location] the location constructed by the selenium webdriver
|
|
869
|
-
|
|
870
|
-
--
|
|
871
|
-
|
|
872
|
-
##### [x](https://github.com/appium/ruby_lib/blob/c6eb8f5416ccdf75b161bc60c0986caec43d9ff8/lib/appium_lib/driver.rb#L732)
|
|
628
|
+
--\n\n##### [x](https://github.com/appium/ruby_lib/blob/621a9ebaf18bcd80eb0e1f5fc17fbb4dddf5293a/lib/appium_lib/driver.rb#L737) common
|
|
873
629
|
|
|
874
630
|
> def x
|
|
875
631
|
|
|
876
632
|
Quit the driver and Pry.
|
|
877
633
|
quit and exit are reserved by Pry.
|
|
878
634
|
|
|
879
|
-
__Returns:__
|
|
880
|
-
|
|
881
|
-
[void]
|
|
635
|
+
__Returns:__\n\n [void]
|
|
882
636
|
|
|
883
|
-
|
|
884
|
-
|
|
885
|
-
##### [username](https://github.com/appium/ruby_lib/blob/c6eb8f5416ccdf75b161bc60c0986caec43d9ff8/lib/appium_lib/sauce_labs.rb#L4)
|
|
637
|
+
--\n\n##### [username](https://github.com/appium/ruby_lib/blob/621a9ebaf18bcd80eb0e1f5fc17fbb4dddf5293a/lib/appium_lib/sauce_labs.rb#L4) common
|
|
886
638
|
|
|
887
639
|
> def username
|
|
888
640
|
|
|
889
641
|
Username for use on Sauce Labs. Set `false` to disable Sauce, even when SAUCE_USERNAME is in ENV.
|
|
890
642
|
|
|
891
|
-
|
|
892
|
-
|
|
893
|
-
##### [access_key](https://github.com/appium/ruby_lib/blob/c6eb8f5416ccdf75b161bc60c0986caec43d9ff8/lib/appium_lib/sauce_labs.rb#L6)
|
|
643
|
+
--\n\n##### [access_key](https://github.com/appium/ruby_lib/blob/621a9ebaf18bcd80eb0e1f5fc17fbb4dddf5293a/lib/appium_lib/sauce_labs.rb#L6) common
|
|
894
644
|
|
|
895
645
|
> def access_key
|
|
896
646
|
|
|
897
647
|
Access Key for use on Sauce Labs. Set `false` to disable Sauce, even when SAUCE_ACCESS_KEY is in ENV.
|
|
898
648
|
|
|
899
|
-
|
|
900
|
-
|
|
901
|
-
##### [endpoint](https://github.com/appium/ruby_lib/blob/c6eb8f5416ccdf75b161bc60c0986caec43d9ff8/lib/appium_lib/sauce_labs.rb#L8)
|
|
649
|
+
--\n\n##### [endpoint](https://github.com/appium/ruby_lib/blob/621a9ebaf18bcd80eb0e1f5fc17fbb4dddf5293a/lib/appium_lib/sauce_labs.rb#L8) common
|
|
902
650
|
|
|
903
651
|
> def endpoint
|
|
904
652
|
|
|
905
653
|
Override the Sauce Appium endpoint to allow e.g. TestObject tests. Default is 'ondemand.saucelabs.com:443/wd/hub'.
|
|
906
654
|
|
|
907
|
-
|
|
908
|
-
|
|
909
|
-
##### [initialize](https://github.com/appium/ruby_lib/blob/c6eb8f5416ccdf75b161bc60c0986caec43d9ff8/lib/appium_lib/sauce_labs.rb#L33)
|
|
655
|
+
--\n\n##### [initialize](https://github.com/appium/ruby_lib/blob/621a9ebaf18bcd80eb0e1f5fc17fbb4dddf5293a/lib/appium_lib/sauce_labs.rb#L33) common
|
|
910
656
|
|
|
911
657
|
> def initialize(appium_lib_opts)
|
|
912
658
|
|
|
913
659
|
Create a SauceLabs instance to manage sauce labs related attributes.
|
|
914
660
|
|
|
915
|
-
__Parameters:__
|
|
661
|
+
__Parameters:__\n\n [Hash] appium_lib_opts - Appium library parameter
|
|
916
662
|
|
|
917
|
-
[
|
|
663
|
+
__Returns:__\n\n [Appium::SauceLabs]
|
|
918
664
|
|
|
919
|
-
|
|
920
|
-
|
|
921
|
-
[Appium::SauceLabs]
|
|
922
|
-
|
|
923
|
-
--
|
|
924
|
-
|
|
925
|
-
##### [sauce_server_url?](https://github.com/appium/ruby_lib/blob/c6eb8f5416ccdf75b161bc60c0986caec43d9ff8/lib/appium_lib/sauce_labs.rb#L53)
|
|
665
|
+
--\n\n##### [sauce_server_url?](https://github.com/appium/ruby_lib/blob/621a9ebaf18bcd80eb0e1f5fc17fbb4dddf5293a/lib/appium_lib/sauce_labs.rb#L53) common
|
|
926
666
|
|
|
927
667
|
> def sauce_server_url?
|
|
928
668
|
|
|
929
669
|
Return true if an instance of Appium::SauceLabs has sauce_username and sauce_access_key.
|
|
930
670
|
|
|
931
|
-
__Returns:__
|
|
932
|
-
|
|
933
|
-
[Boolean]
|
|
671
|
+
__Returns:__\n\n [Boolean]
|
|
934
672
|
|
|
935
|
-
|
|
936
|
-
|
|
937
|
-
##### [server_url](https://github.com/appium/ruby_lib/blob/c6eb8f5416ccdf75b161bc60c0986caec43d9ff8/lib/appium_lib/sauce_labs.rb#L66)
|
|
673
|
+
--\n\n##### [server_url](https://github.com/appium/ruby_lib/blob/621a9ebaf18bcd80eb0e1f5fc17fbb4dddf5293a/lib/appium_lib/sauce_labs.rb#L66) common
|
|
938
674
|
|
|
939
675
|
> def server_url
|
|
940
676
|
|
|
941
677
|
Return a particular server url to access to. Default is the local address.
|
|
942
678
|
|
|
943
|
-
__Returns:__
|
|
944
|
-
|
|
945
|
-
[String]
|
|
679
|
+
__Returns:__\n\n [String]
|
|
946
680
|
|
|
947
|
-
|
|
948
|
-
|
|
949
|
-
##### [get_log](https://github.com/appium/ruby_lib/blob/c6eb8f5416ccdf75b161bc60c0986caec43d9ff8/lib/appium_lib/common/log.rb#L11)
|
|
681
|
+
--\n\n##### [get_log](https://github.com/appium/ruby_lib/blob/621a9ebaf18bcd80eb0e1f5fc17fbb4dddf5293a/lib/appium_lib/common/log.rb#L11) common
|
|
950
682
|
|
|
951
683
|
> def get_log(type)
|
|
952
684
|
|
|
953
685
|
|
|
954
686
|
|
|
955
|
-
__Parameters:__
|
|
956
|
-
|
|
957
|
-
[String|Hash] type - You can get particular type's logs.
|
|
687
|
+
__Parameters:__\n\n [String|Hash] type - You can get particular type's logs.
|
|
958
688
|
|
|
959
|
-
__Returns:__
|
|
689
|
+
__Returns:__\n\n [[Selenium::WebDriver::LogEntry]] A list of logs data.
|
|
960
690
|
|
|
961
|
-
|
|
962
|
-
|
|
963
|
-
--
|
|
964
|
-
|
|
965
|
-
##### [get_available_log_types](https://github.com/appium/ruby_lib/blob/c6eb8f5416ccdf75b161bc60c0986caec43d9ff8/lib/appium_lib/common/log.rb#L23)
|
|
691
|
+
--\n\n##### [get_available_log_types](https://github.com/appium/ruby_lib/blob/621a9ebaf18bcd80eb0e1f5fc17fbb4dddf5293a/lib/appium_lib/common/log.rb#L23) common
|
|
966
692
|
|
|
967
693
|
> def get_available_log_types
|
|
968
694
|
|
|
969
695
|
Get a list of available log types
|
|
970
696
|
|
|
971
|
-
__Returns:__
|
|
972
|
-
|
|
973
|
-
[[String]] A list of available log types.
|
|
974
|
-
|
|
975
|
-
--
|
|
697
|
+
__Returns:__\n\n [[String]] A list of available log types.
|
|
976
698
|
|
|
977
|
-
##### [wait_true](https://github.com/appium/ruby_lib/blob/
|
|
699
|
+
--\n\n##### [wait_true](https://github.com/appium/ruby_lib/blob/621a9ebaf18bcd80eb0e1f5fc17fbb4dddf5293a/lib/appium_lib/common/wait.rb#L30) common
|
|
978
700
|
|
|
979
701
|
> def wait_true(opts = {})
|
|
980
702
|
|
|
@@ -988,13 +710,9 @@ https://github.com/SeleniumHQ/selenium/blob/cf501dda3f0ed12233de51ce8170c0e8090f
|
|
|
988
710
|
|
|
989
711
|
If only a number is provided then it's treated as the timeout value.
|
|
990
712
|
|
|
991
|
-
__Parameters:__
|
|
713
|
+
__Parameters:__\n\n [Hash|Numeric] opts - Options. If the value is _Numeric_, the value is set as `{ timeout: value }`
|
|
992
714
|
|
|
993
|
-
|
|
994
|
-
|
|
995
|
-
--
|
|
996
|
-
|
|
997
|
-
##### [wait](https://github.com/appium/ruby_lib/blob/c6eb8f5416ccdf75b161bc60c0986caec43d9ff8/lib/appium_lib/common/wait.rb#L59)
|
|
715
|
+
--\n\n##### [wait](https://github.com/appium/ruby_lib/blob/621a9ebaf18bcd80eb0e1f5fc17fbb4dddf5293a/lib/appium_lib/common/wait.rb#L59) common
|
|
998
716
|
|
|
999
717
|
> def wait(opts = {})
|
|
1000
718
|
|
|
@@ -1006,319 +724,221 @@ https://github.com/SeleniumHQ/selenium/blob/cf501dda3f0ed12233de51ce8170c0e8090f
|
|
|
1006
724
|
|
|
1007
725
|
If only a number is provided then it's treated as the timeout value.
|
|
1008
726
|
|
|
1009
|
-
__Parameters:__
|
|
1010
|
-
|
|
1011
|
-
[Hash|Numeric] opts - Options. If the value is _Numeric_, the value is set as `{ timeout: value }`
|
|
1012
|
-
|
|
1013
|
-
--
|
|
727
|
+
__Parameters:__\n\n [Hash|Numeric] opts - Options. If the value is _Numeric_, the value is set as `{ timeout: value }`
|
|
1014
728
|
|
|
1015
|
-
##### [add_touch_actions](https://github.com/appium/ruby_lib/blob/
|
|
729
|
+
--\n\n##### [add_touch_actions](https://github.com/appium/ruby_lib/blob/621a9ebaf18bcd80eb0e1f5fc17fbb4dddf5293a/lib/appium_lib/common/device.rb#L12) common
|
|
1016
730
|
|
|
1017
731
|
> def add_touch_actions
|
|
1018
732
|
|
|
1019
733
|
|
|
1020
734
|
|
|
1021
|
-
|
|
1022
|
-
|
|
1023
|
-
##### [delegate_from_appium_driver](https://github.com/appium/ruby_lib/blob/c6eb8f5416ccdf75b161bc60c0986caec43d9ff8/lib/appium_lib/common/device.rb#L24)
|
|
735
|
+
--\n\n##### [delegate_from_appium_driver](https://github.com/appium/ruby_lib/blob/621a9ebaf18bcd80eb0e1f5fc17fbb4dddf5293a/lib/appium_lib/common/device.rb#L24) common
|
|
1024
736
|
|
|
1025
737
|
> def delegate_from_appium_driver(method, delegation_target)
|
|
1026
738
|
|
|
1027
739
|
|
|
1028
740
|
|
|
1029
|
-
|
|
1030
|
-
|
|
1031
|
-
##### [ignore](https://github.com/appium/ruby_lib/blob/c6eb8f5416ccdf75b161bc60c0986caec43d9ff8/lib/appium_lib/common/helper.rb#L16)
|
|
741
|
+
--\n\n##### [ignore](https://github.com/appium/ruby_lib/blob/621a9ebaf18bcd80eb0e1f5fc17fbb4dddf5293a/lib/appium_lib/common/helper.rb#L16) common
|
|
1032
742
|
|
|
1033
743
|
> def ignore
|
|
1034
744
|
|
|
1035
745
|
Return yield and ignore any exceptions.
|
|
1036
746
|
|
|
1037
|
-
|
|
1038
|
-
|
|
1039
|
-
##### [back](https://github.com/appium/ruby_lib/blob/c6eb8f5416ccdf75b161bc60c0986caec43d9ff8/lib/appium_lib/common/helper.rb#L23)
|
|
747
|
+
--\n\n##### [back](https://github.com/appium/ruby_lib/blob/621a9ebaf18bcd80eb0e1f5fc17fbb4dddf5293a/lib/appium_lib/common/helper.rb#L23) common
|
|
1040
748
|
|
|
1041
749
|
> def back
|
|
1042
750
|
|
|
1043
751
|
Navigate back.
|
|
1044
752
|
|
|
1045
|
-
__Returns:__
|
|
1046
|
-
|
|
1047
|
-
[void]
|
|
753
|
+
__Returns:__\n\n [void]
|
|
1048
754
|
|
|
1049
|
-
|
|
1050
|
-
|
|
1051
|
-
##### [session_id](https://github.com/appium/ruby_lib/blob/c6eb8f5416ccdf75b161bc60c0986caec43d9ff8/lib/appium_lib/common/helper.rb#L34)
|
|
755
|
+
--\n\n##### [session_id](https://github.com/appium/ruby_lib/blob/621a9ebaf18bcd80eb0e1f5fc17fbb4dddf5293a/lib/appium_lib/common/helper.rb#L34) common
|
|
1052
756
|
|
|
1053
757
|
> def session_id
|
|
1054
758
|
|
|
1055
759
|
For Sauce Labs reporting. Returns the current session id.
|
|
1056
760
|
|
|
1057
|
-
__Returns:__
|
|
1058
|
-
|
|
1059
|
-
[String]
|
|
761
|
+
__Returns:__\n\n [String]
|
|
1060
762
|
|
|
1061
|
-
|
|
1062
|
-
|
|
1063
|
-
##### [xpath](https://github.com/appium/ruby_lib/blob/c6eb8f5416ccdf75b161bc60c0986caec43d9ff8/lib/appium_lib/common/helper.rb#L42)
|
|
763
|
+
--\n\n##### [xpath](https://github.com/appium/ruby_lib/blob/621a9ebaf18bcd80eb0e1f5fc17fbb4dddf5293a/lib/appium_lib/common/helper.rb#L42) common
|
|
1064
764
|
|
|
1065
765
|
> def xpath(xpath_str)
|
|
1066
766
|
|
|
1067
767
|
Returns the first element that matches the provided xpath.
|
|
1068
768
|
|
|
1069
|
-
__Parameters:__
|
|
1070
|
-
|
|
1071
|
-
[String] xpath_str - the XPath string
|
|
769
|
+
__Parameters:__\n\n [String] xpath_str - the XPath string
|
|
1072
770
|
|
|
1073
|
-
__Returns:__
|
|
771
|
+
__Returns:__\n\n [Element]
|
|
1074
772
|
|
|
1075
|
-
|
|
1076
|
-
|
|
1077
|
-
--
|
|
1078
|
-
|
|
1079
|
-
##### [xpaths](https://github.com/appium/ruby_lib/blob/c6eb8f5416ccdf75b161bc60c0986caec43d9ff8/lib/appium_lib/common/helper.rb#L50)
|
|
773
|
+
--\n\n##### [xpaths](https://github.com/appium/ruby_lib/blob/621a9ebaf18bcd80eb0e1f5fc17fbb4dddf5293a/lib/appium_lib/common/helper.rb#L50) common
|
|
1080
774
|
|
|
1081
775
|
> def xpaths(xpath_str)
|
|
1082
776
|
|
|
1083
777
|
Returns all elements that match the provided xpath.
|
|
1084
778
|
|
|
1085
|
-
__Parameters:__
|
|
1086
|
-
|
|
1087
|
-
[String] xpath_str - the XPath string
|
|
1088
|
-
|
|
1089
|
-
__Returns:__
|
|
779
|
+
__Parameters:__\n\n [String] xpath_str - the XPath string
|
|
1090
780
|
|
|
1091
|
-
[Array<Element>]
|
|
781
|
+
__Returns:__\n\n [Array<Element>]
|
|
1092
782
|
|
|
1093
|
-
|
|
1094
|
-
|
|
1095
|
-
##### [result](https://github.com/appium/ruby_lib/blob/c6eb8f5416ccdf75b161bc60c0986caec43d9ff8/lib/appium_lib/common/helper.rb#L60)
|
|
783
|
+
--\n\n##### [result](https://github.com/appium/ruby_lib/blob/621a9ebaf18bcd80eb0e1f5fc17fbb4dddf5293a/lib/appium_lib/common/helper.rb#L60) common
|
|
1096
784
|
|
|
1097
785
|
> def result
|
|
1098
786
|
|
|
1099
787
|
Returns the value of attribute result
|
|
1100
788
|
|
|
1101
|
-
|
|
1102
|
-
|
|
1103
|
-
##### [initialize](https://github.com/appium/ruby_lib/blob/c6eb8f5416ccdf75b161bc60c0986caec43d9ff8/lib/appium_lib/common/helper.rb#L62)
|
|
789
|
+
--\n\n##### [initialize](https://github.com/appium/ruby_lib/blob/621a9ebaf18bcd80eb0e1f5fc17fbb4dddf5293a/lib/appium_lib/common/helper.rb#L62) common
|
|
1104
790
|
|
|
1105
791
|
> def initialize(platform)
|
|
1106
792
|
|
|
1107
793
|
|
|
1108
794
|
|
|
1109
|
-
__Returns:__
|
|
1110
|
-
|
|
1111
|
-
[CountElements] a new instance of CountElements
|
|
1112
|
-
|
|
1113
|
-
--
|
|
795
|
+
__Returns:__\n\n [CountElements] a new instance of CountElements
|
|
1114
796
|
|
|
1115
|
-
##### [reset](https://github.com/appium/ruby_lib/blob/
|
|
797
|
+
--\n\n##### [reset](https://github.com/appium/ruby_lib/blob/621a9ebaf18bcd80eb0e1f5fc17fbb4dddf5293a/lib/appium_lib/common/helper.rb#L67) common
|
|
1116
798
|
|
|
1117
799
|
> def reset
|
|
1118
800
|
|
|
1119
801
|
|
|
1120
802
|
|
|
1121
|
-
|
|
1122
|
-
|
|
1123
|
-
##### [start_element](https://github.com/appium/ruby_lib/blob/c6eb8f5416ccdf75b161bc60c0986caec43d9ff8/lib/appium_lib/common/helper.rb#L72)
|
|
803
|
+
--\n\n##### [start_element](https://github.com/appium/ruby_lib/blob/621a9ebaf18bcd80eb0e1f5fc17fbb4dddf5293a/lib/appium_lib/common/helper.rb#L72) common
|
|
1124
804
|
|
|
1125
805
|
> def start_element(name, attrs = [])
|
|
1126
806
|
|
|
1127
807
|
http://nokogiri.org/Nokogiri/XML/SAX/Document.html
|
|
1128
808
|
|
|
1129
|
-
|
|
1130
|
-
|
|
1131
|
-
##### [formatted_result](https://github.com/appium/ruby_lib/blob/c6eb8f5416ccdf75b161bc60c0986caec43d9ff8/lib/appium_lib/common/helper.rb#L83)
|
|
809
|
+
--\n\n##### [formatted_result](https://github.com/appium/ruby_lib/blob/621a9ebaf18bcd80eb0e1f5fc17fbb4dddf5293a/lib/appium_lib/common/helper.rb#L83) common
|
|
1132
810
|
|
|
1133
811
|
> def formatted_result
|
|
1134
812
|
|
|
1135
813
|
|
|
1136
814
|
|
|
1137
|
-
|
|
1138
|
-
|
|
1139
|
-
##### [get_page_class](https://github.com/appium/ruby_lib/blob/c6eb8f5416ccdf75b161bc60c0986caec43d9ff8/lib/appium_lib/common/helper.rb#L101)
|
|
815
|
+
--\n\n##### [get_page_class](https://github.com/appium/ruby_lib/blob/621a9ebaf18bcd80eb0e1f5fc17fbb4dddf5293a/lib/appium_lib/common/helper.rb#L101) common
|
|
1140
816
|
|
|
1141
817
|
> def get_page_class
|
|
1142
818
|
|
|
1143
819
|
Returns a string of class counts of visible elements.
|
|
1144
820
|
|
|
1145
|
-
__Returns:__
|
|
1146
|
-
|
|
1147
|
-
[String]
|
|
821
|
+
__Returns:__\n\n [String]
|
|
1148
822
|
|
|
1149
|
-
|
|
1150
|
-
|
|
1151
|
-
##### [page_class](https://github.com/appium/ruby_lib/blob/c6eb8f5416ccdf75b161bc60c0986caec43d9ff8/lib/appium_lib/common/helper.rb#L126)
|
|
823
|
+
--\n\n##### [page_class](https://github.com/appium/ruby_lib/blob/621a9ebaf18bcd80eb0e1f5fc17fbb4dddf5293a/lib/appium_lib/common/helper.rb#L126) common
|
|
1152
824
|
|
|
1153
825
|
> def page_class
|
|
1154
826
|
|
|
1155
827
|
Count all classes on screen and print to stdout.
|
|
1156
828
|
Useful for appium_console.
|
|
1157
829
|
|
|
1158
|
-
__Returns:__
|
|
1159
|
-
|
|
1160
|
-
[nil]
|
|
830
|
+
__Returns:__\n\n [nil]
|
|
1161
831
|
|
|
1162
|
-
|
|
1163
|
-
|
|
1164
|
-
##### [source](https://github.com/appium/ruby_lib/blob/c6eb8f5416ccdf75b161bc60c0986caec43d9ff8/lib/appium_lib/common/helper.rb#L133)
|
|
832
|
+
--\n\n##### [source](https://github.com/appium/ruby_lib/blob/621a9ebaf18bcd80eb0e1f5fc17fbb4dddf5293a/lib/appium_lib/common/helper.rb#L133) common
|
|
1165
833
|
|
|
1166
834
|
> def source
|
|
1167
835
|
|
|
1168
836
|
Prints xml of the current page
|
|
1169
837
|
|
|
1170
|
-
__Returns:__
|
|
1171
|
-
|
|
1172
|
-
[void]
|
|
838
|
+
__Returns:__\n\n [void]
|
|
1173
839
|
|
|
1174
|
-
|
|
1175
|
-
|
|
1176
|
-
##### [get_source](https://github.com/appium/ruby_lib/blob/c6eb8f5416ccdf75b161bc60c0986caec43d9ff8/lib/appium_lib/common/helper.rb#L140)
|
|
840
|
+
--\n\n##### [get_source](https://github.com/appium/ruby_lib/blob/621a9ebaf18bcd80eb0e1f5fc17fbb4dddf5293a/lib/appium_lib/common/helper.rb#L140) common
|
|
1177
841
|
|
|
1178
842
|
> def get_source
|
|
1179
843
|
|
|
1180
844
|
Returns XML string for the current page
|
|
1181
845
|
Same as driver.page_source
|
|
1182
846
|
|
|
1183
|
-
__Returns:__
|
|
1184
|
-
|
|
1185
|
-
[String]
|
|
847
|
+
__Returns:__\n\n [String]
|
|
1186
848
|
|
|
1187
|
-
|
|
1188
|
-
|
|
1189
|
-
##### [px_to_window_rel](https://github.com/appium/ruby_lib/blob/c6eb8f5416ccdf75b161bc60c0986caec43d9ff8/lib/appium_lib/common/helper.rb#L150)
|
|
849
|
+
--\n\n##### [px_to_window_rel](https://github.com/appium/ruby_lib/blob/621a9ebaf18bcd80eb0e1f5fc17fbb4dddf5293a/lib/appium_lib/common/helper.rb#L150) common
|
|
1190
850
|
|
|
1191
851
|
> def px_to_window_rel(opts = {}, driver = $driver)
|
|
1192
852
|
|
|
1193
853
|
Converts pixel values to window relative values
|
|
1194
854
|
|
|
1195
|
-
|
|
1196
|
-
|
|
1197
|
-
##### [xml_keys](https://github.com/appium/ruby_lib/blob/c6eb8f5416ccdf75b161bc60c0986caec43d9ff8/lib/appium_lib/common/helper.rb#L169)
|
|
855
|
+
--\n\n##### [xml_keys](https://github.com/appium/ruby_lib/blob/621a9ebaf18bcd80eb0e1f5fc17fbb4dddf5293a/lib/appium_lib/common/helper.rb#L169) common
|
|
1198
856
|
|
|
1199
857
|
> def xml_keys(target)
|
|
1200
858
|
|
|
1201
859
|
Search strings.xml's values for target.
|
|
1202
860
|
|
|
1203
|
-
__Parameters:__
|
|
861
|
+
__Parameters:__\n\n [String] target - the target to search for in strings.xml values
|
|
1204
862
|
|
|
1205
|
-
[
|
|
863
|
+
__Returns:__\n\n [Array]
|
|
1206
864
|
|
|
1207
|
-
|
|
1208
|
-
|
|
1209
|
-
[Array]
|
|
1210
|
-
|
|
1211
|
-
--
|
|
1212
|
-
|
|
1213
|
-
##### [xml_values](https://github.com/appium/ruby_lib/blob/c6eb8f5416ccdf75b161bc60c0986caec43d9ff8/lib/appium_lib/common/helper.rb#L177)
|
|
865
|
+
--\n\n##### [xml_values](https://github.com/appium/ruby_lib/blob/621a9ebaf18bcd80eb0e1f5fc17fbb4dddf5293a/lib/appium_lib/common/helper.rb#L177) common
|
|
1214
866
|
|
|
1215
867
|
> def xml_values(target)
|
|
1216
868
|
|
|
1217
869
|
Search strings.xml's keys for target.
|
|
1218
870
|
|
|
1219
|
-
__Parameters:__
|
|
1220
|
-
|
|
1221
|
-
[String] target - the target to search for in strings.xml keys
|
|
871
|
+
__Parameters:__\n\n [String] target - the target to search for in strings.xml keys
|
|
1222
872
|
|
|
1223
|
-
__Returns:__
|
|
873
|
+
__Returns:__\n\n [Array]
|
|
1224
874
|
|
|
1225
|
-
|
|
1226
|
-
|
|
1227
|
-
--
|
|
1228
|
-
|
|
1229
|
-
##### [resolve_id](https://github.com/appium/ruby_lib/blob/c6eb8f5416ccdf75b161bc60c0986caec43d9ff8/lib/appium_lib/common/helper.rb#L185)
|
|
875
|
+
--\n\n##### [resolve_id](https://github.com/appium/ruby_lib/blob/621a9ebaf18bcd80eb0e1f5fc17fbb4dddf5293a/lib/appium_lib/common/helper.rb#L185) common
|
|
1230
876
|
|
|
1231
877
|
> def resolve_id(id)
|
|
1232
878
|
|
|
1233
879
|
Resolve id in strings.xml and return the value.
|
|
1234
880
|
|
|
1235
|
-
__Parameters:__
|
|
1236
|
-
|
|
1237
|
-
[String] id - the id to resolve
|
|
1238
|
-
|
|
1239
|
-
__Returns:__
|
|
881
|
+
__Parameters:__\n\n [String] id - the id to resolve
|
|
1240
882
|
|
|
1241
|
-
[String]
|
|
883
|
+
__Returns:__\n\n [String]
|
|
1242
884
|
|
|
1243
|
-
|
|
1244
|
-
|
|
1245
|
-
##### [filter](https://github.com/appium/ruby_lib/blob/c6eb8f5416ccdf75b161bc60c0986caec43d9ff8/lib/appium_lib/common/helper.rb#L192)
|
|
885
|
+
--\n\n##### [filter](https://github.com/appium/ruby_lib/blob/621a9ebaf18bcd80eb0e1f5fc17fbb4dddf5293a/lib/appium_lib/common/helper.rb#L192) common
|
|
1246
886
|
|
|
1247
887
|
> def filter
|
|
1248
888
|
|
|
1249
889
|
Returns the value of attribute filter
|
|
1250
890
|
|
|
1251
|
-
|
|
1252
|
-
|
|
1253
|
-
##### [filter=](https://github.com/appium/ruby_lib/blob/c6eb8f5416ccdf75b161bc60c0986caec43d9ff8/lib/appium_lib/common/helper.rb#L195)
|
|
891
|
+
--\n\n##### [filter=](https://github.com/appium/ruby_lib/blob/621a9ebaf18bcd80eb0e1f5fc17fbb4dddf5293a/lib/appium_lib/common/helper.rb#L195) common
|
|
1254
892
|
|
|
1255
893
|
> def filter=(value)
|
|
1256
894
|
|
|
1257
895
|
convert to string to support symbols
|
|
1258
896
|
|
|
1259
|
-
|
|
1260
|
-
|
|
1261
|
-
##### [initialize](https://github.com/appium/ruby_lib/blob/c6eb8f5416ccdf75b161bc60c0986caec43d9ff8/lib/appium_lib/common/helper.rb#L202)
|
|
897
|
+
--\n\n##### [initialize](https://github.com/appium/ruby_lib/blob/621a9ebaf18bcd80eb0e1f5fc17fbb4dddf5293a/lib/appium_lib/common/helper.rb#L202) common
|
|
1262
898
|
|
|
1263
899
|
> def initialize
|
|
1264
900
|
|
|
1265
901
|
|
|
1266
902
|
|
|
1267
|
-
__Returns:__
|
|
1268
|
-
|
|
1269
|
-
[HTMLElements] a new instance of HTMLElements
|
|
903
|
+
__Returns:__\n\n [HTMLElements] a new instance of HTMLElements
|
|
1270
904
|
|
|
1271
|
-
|
|
1272
|
-
|
|
1273
|
-
##### [reset](https://github.com/appium/ruby_lib/blob/c6eb8f5416ccdf75b161bc60c0986caec43d9ff8/lib/appium_lib/common/helper.rb#L207)
|
|
905
|
+
--\n\n##### [reset](https://github.com/appium/ruby_lib/blob/621a9ebaf18bcd80eb0e1f5fc17fbb4dddf5293a/lib/appium_lib/common/helper.rb#L207) common
|
|
1274
906
|
|
|
1275
907
|
> def reset
|
|
1276
908
|
|
|
1277
909
|
|
|
1278
910
|
|
|
1279
|
-
|
|
1280
|
-
|
|
1281
|
-
##### [result](https://github.com/appium/ruby_lib/blob/c6eb8f5416ccdf75b161bc60c0986caec43d9ff8/lib/appium_lib/common/helper.rb#L213)
|
|
911
|
+
--\n\n##### [result](https://github.com/appium/ruby_lib/blob/621a9ebaf18bcd80eb0e1f5fc17fbb4dddf5293a/lib/appium_lib/common/helper.rb#L213) common
|
|
1282
912
|
|
|
1283
913
|
> def result
|
|
1284
914
|
|
|
1285
915
|
|
|
1286
916
|
|
|
1287
|
-
|
|
1288
|
-
|
|
1289
|
-
##### [start_element](https://github.com/appium/ruby_lib/blob/c6eb8f5416ccdf75b161bc60c0986caec43d9ff8/lib/appium_lib/common/helper.rb#L226)
|
|
917
|
+
--\n\n##### [start_element](https://github.com/appium/ruby_lib/blob/621a9ebaf18bcd80eb0e1f5fc17fbb4dddf5293a/lib/appium_lib/common/helper.rb#L226) common
|
|
1290
918
|
|
|
1291
919
|
> def start_element(name, attrs = [])
|
|
1292
920
|
|
|
1293
921
|
|
|
1294
922
|
|
|
1295
|
-
|
|
1296
|
-
|
|
1297
|
-
##### [end_element](https://github.com/appium/ruby_lib/blob/c6eb8f5416ccdf75b161bc60c0986caec43d9ff8/lib/appium_lib/common/helper.rb#L236)
|
|
923
|
+
--\n\n##### [end_element](https://github.com/appium/ruby_lib/blob/621a9ebaf18bcd80eb0e1f5fc17fbb4dddf5293a/lib/appium_lib/common/helper.rb#L236) common
|
|
1298
924
|
|
|
1299
925
|
> def end_element(name)
|
|
1300
926
|
|
|
1301
927
|
|
|
1302
928
|
|
|
1303
|
-
|
|
1304
|
-
|
|
1305
|
-
##### [characters](https://github.com/appium/ruby_lib/blob/c6eb8f5416ccdf75b161bc60c0986caec43d9ff8/lib/appium_lib/common/helper.rb#L243)
|
|
929
|
+
--\n\n##### [characters](https://github.com/appium/ruby_lib/blob/621a9ebaf18bcd80eb0e1f5fc17fbb4dddf5293a/lib/appium_lib/common/helper.rb#L243) common
|
|
1306
930
|
|
|
1307
931
|
> def characters(chars)
|
|
1308
932
|
|
|
1309
933
|
|
|
1310
934
|
|
|
1311
|
-
|
|
1312
|
-
|
|
1313
|
-
##### [DEFAULT_HEADERS](https://github.com/appium/ruby_lib/blob/c6eb8f5416ccdf75b161bc60c0986caec43d9ff8/lib/appium_lib/common/http_client.rb#L8)
|
|
935
|
+
--\n\n##### [DEFAULT_HEADERS](https://github.com/appium/ruby_lib/blob/621a9ebaf18bcd80eb0e1f5fc17fbb4dddf5293a/lib/appium_lib/common/http_client.rb#L8) common
|
|
1314
936
|
|
|
1315
937
|
> DEFAULT_HEADERS = { 'Accept' => CONTENT_TYPE, 'User-Agent' => "appium/ruby_lib/#{::Appium::VERSION}" }.freeze
|
|
1316
938
|
|
|
1317
939
|
Default HTTP client inherit Appium::Core::Base::Http::Default, but has different DEFAULT_HEADERS
|
|
1318
940
|
|
|
1319
|
-
|
|
1320
|
-
|
|
1321
|
-
##### [pinch](https://github.com/appium/ruby_lib/blob/c6eb8f5416ccdf75b161bc60c0986caec43d9ff8/lib/appium_lib/common/multi_touch.rb#L51)
|
|
941
|
+
--\n\n##### [pinch](https://github.com/appium/ruby_lib/blob/621a9ebaf18bcd80eb0e1f5fc17fbb4dddf5293a/lib/appium_lib/common/multi_touch.rb#L51) common
|
|
1322
942
|
|
|
1323
943
|
> def pinch(percentage = 25, auto_perform = true, driver = $driver)
|
|
1324
944
|
|
|
@@ -1328,17 +948,13 @@ Without auto_perform
|
|
|
1328
948
|
|
|
1329
949
|
With driver
|
|
1330
950
|
|
|
1331
|
-
__Parameters:__
|
|
1332
|
-
|
|
1333
|
-
[int] percentage - The percent size by which to shrink the screen when pinched.
|
|
951
|
+
__Parameters:__\n\n [int] percentage - The percent size by which to shrink the screen when pinched.
|
|
1334
952
|
|
|
1335
953
|
[boolean] auto_perform - Whether to perform the action immediately (default true)
|
|
1336
954
|
|
|
1337
955
|
[Driver] driver - Set a driver to conduct the action. DEfault is global driver($driver)
|
|
1338
956
|
|
|
1339
|
-
|
|
1340
|
-
|
|
1341
|
-
##### [zoom](https://github.com/appium/ruby_lib/blob/c6eb8f5416ccdf75b161bc60c0986caec43d9ff8/lib/appium_lib/common/multi_touch.rb#L94)
|
|
957
|
+
--\n\n##### [zoom](https://github.com/appium/ruby_lib/blob/621a9ebaf18bcd80eb0e1f5fc17fbb4dddf5293a/lib/appium_lib/common/multi_touch.rb#L94) common
|
|
1342
958
|
|
|
1343
959
|
> def zoom(percentage = 200, auto_perform = true, driver = $driver)
|
|
1344
960
|
|
|
@@ -1348,231 +964,159 @@ Without auto_perform
|
|
|
1348
964
|
|
|
1349
965
|
With driver
|
|
1350
966
|
|
|
1351
|
-
__Parameters:__
|
|
1352
|
-
|
|
1353
|
-
[int] percentage - The percent size by which to shrink the screen when pinched.
|
|
967
|
+
__Parameters:__\n\n [int] percentage - The percent size by which to shrink the screen when pinched.
|
|
1354
968
|
|
|
1355
969
|
[boolean] auto_perform - Whether to perform the action immediately (default true)
|
|
1356
970
|
|
|
1357
971
|
[Driver] driver - Set a driver to conduct the action. DEfault is global driver($driver)
|
|
1358
972
|
|
|
1359
|
-
|
|
1360
|
-
|
|
1361
|
-
##### [initialize](https://github.com/appium/ruby_lib/blob/c6eb8f5416ccdf75b161bc60c0986caec43d9ff8/lib/appium_lib/common/multi_touch.rb#L180)
|
|
973
|
+
--\n\n##### [initialize](https://github.com/appium/ruby_lib/blob/621a9ebaf18bcd80eb0e1f5fc17fbb4dddf5293a/lib/appium_lib/common/multi_touch.rb#L180) common
|
|
1362
974
|
|
|
1363
975
|
> def initialize(driver = $driver)
|
|
1364
976
|
|
|
1365
977
|
self
|
|
1366
978
|
|
|
1367
|
-
__Returns:__
|
|
1368
|
-
|
|
1369
|
-
[MultiTouch] a new instance of MultiTouch
|
|
979
|
+
__Returns:__\n\n [MultiTouch] a new instance of MultiTouch
|
|
1370
980
|
|
|
1371
|
-
|
|
1372
|
-
|
|
1373
|
-
##### [COMPLEX_ACTIONS](https://github.com/appium/ruby_lib/blob/c6eb8f5416ccdf75b161bc60c0986caec43d9ff8/lib/appium_lib/common/touch_actions.rb#L33)
|
|
981
|
+
--\n\n##### [COMPLEX_ACTIONS](https://github.com/appium/ruby_lib/blob/621a9ebaf18bcd80eb0e1f5fc17fbb4dddf5293a/lib/appium_lib/common/touch_actions.rb#L33) common
|
|
1374
982
|
|
|
1375
983
|
> COMPLEX_ACTIONS = ::Appium::Core::TouchAction::COMPLEX_ACTIONS
|
|
1376
984
|
|
|
1377
985
|
|
|
1378
986
|
|
|
1379
|
-
|
|
1380
|
-
|
|
1381
|
-
##### [initialize](https://github.com/appium/ruby_lib/blob/c6eb8f5416ccdf75b161bc60c0986caec43d9ff8/lib/appium_lib/common/touch_actions.rb#L48)
|
|
987
|
+
--\n\n##### [initialize](https://github.com/appium/ruby_lib/blob/621a9ebaf18bcd80eb0e1f5fc17fbb4dddf5293a/lib/appium_lib/common/touch_actions.rb#L48) common
|
|
1382
988
|
|
|
1383
989
|
> def initialize(driver = $driver)
|
|
1384
990
|
|
|
1385
991
|
|
|
1386
992
|
|
|
1387
|
-
__Returns:__
|
|
1388
|
-
|
|
1389
|
-
[TouchAction] a new instance of TouchAction
|
|
1390
|
-
|
|
1391
|
-
--
|
|
993
|
+
__Returns:__\n\n [TouchAction] a new instance of TouchAction
|
|
1392
994
|
|
|
1393
|
-
##### [swipe](https://github.com/appium/ruby_lib/blob/
|
|
995
|
+
--\n\n##### [swipe](https://github.com/appium/ruby_lib/blob/621a9ebaf18bcd80eb0e1f5fc17fbb4dddf5293a/lib/appium_lib/common/touch_actions.rb#L52) common
|
|
1394
996
|
|
|
1395
997
|
> def swipe(opts)
|
|
1396
998
|
|
|
1397
999
|
|
|
1398
1000
|
|
|
1399
|
-
|
|
1400
|
-
|
|
1401
|
-
##### [initialize](https://github.com/appium/ruby_lib/blob/c6eb8f5416ccdf75b161bc60c0986caec43d9ff8/lib/appium_lib/common/command/ws_logcat.rb#L5)
|
|
1001
|
+
--\n\n##### [initialize](https://github.com/appium/ruby_lib/blob/621a9ebaf18bcd80eb0e1f5fc17fbb4dddf5293a/lib/appium_lib/common/command/ws_logcat.rb#L5) common
|
|
1402
1002
|
|
|
1403
1003
|
> def initialize(url:, output_file: 'logcat.log')
|
|
1404
1004
|
|
|
1405
1005
|
|
|
1406
1006
|
|
|
1407
|
-
__Returns:__
|
|
1408
|
-
|
|
1409
|
-
[WsLogcat] a new instance of WsLogcat
|
|
1007
|
+
__Returns:__\n\n [WsLogcat] a new instance of WsLogcat
|
|
1410
1008
|
|
|
1411
|
-
|
|
1412
|
-
|
|
1413
|
-
##### [handle_message_data](https://github.com/appium/ruby_lib/blob/c6eb8f5416ccdf75b161bc60c0986caec43d9ff8/lib/appium_lib/common/command/ws_logcat.rb#L10)
|
|
1009
|
+
--\n\n##### [handle_message_data](https://github.com/appium/ruby_lib/blob/621a9ebaf18bcd80eb0e1f5fc17fbb4dddf5293a/lib/appium_lib/common/command/ws_logcat.rb#L10) common
|
|
1414
1010
|
|
|
1415
1011
|
> def handle_message_data(data)
|
|
1416
1012
|
|
|
1417
1013
|
|
|
1418
1014
|
|
|
1419
|
-
|
|
1420
|
-
|
|
1421
|
-
##### [for](https://github.com/appium/ruby_lib/blob/c6eb8f5416ccdf75b161bc60c0986caec43d9ff8/lib/appium_lib/ios/ios.rb#L15) ios
|
|
1015
|
+
--\n\n##### [for](https://github.com/appium/ruby_lib/blob/621a9ebaf18bcd80eb0e1f5fc17fbb4dddf5293a/lib/appium_lib/ios/ios.rb#L15) ios
|
|
1422
1016
|
|
|
1423
1017
|
> def self.for(target)
|
|
1424
1018
|
|
|
1425
1019
|
|
|
1426
1020
|
|
|
1427
|
-
|
|
1428
|
-
|
|
1429
|
-
##### [UIAStaticText](https://github.com/appium/ruby_lib/blob/c6eb8f5416ccdf75b161bc60c0986caec43d9ff8/lib/appium_lib/ios/element/text.rb#L4) ios
|
|
1021
|
+
--\n\n##### [UIAStaticText](https://github.com/appium/ruby_lib/blob/621a9ebaf18bcd80eb0e1f5fc17fbb4dddf5293a/lib/appium_lib/ios/element/text.rb#L4) ios
|
|
1430
1022
|
|
|
1431
1023
|
> UIAStaticText = 'UIAStaticText'.freeze
|
|
1432
1024
|
|
|
1433
1025
|
|
|
1434
1026
|
|
|
1435
|
-
|
|
1436
|
-
|
|
1437
|
-
##### [XCUIElementTypeStaticText](https://github.com/appium/ruby_lib/blob/c6eb8f5416ccdf75b161bc60c0986caec43d9ff8/lib/appium_lib/ios/element/text.rb#L5) ios
|
|
1027
|
+
--\n\n##### [XCUIElementTypeStaticText](https://github.com/appium/ruby_lib/blob/621a9ebaf18bcd80eb0e1f5fc17fbb4dddf5293a/lib/appium_lib/ios/element/text.rb#L5) ios
|
|
1438
1028
|
|
|
1439
1029
|
> XCUIElementTypeStaticText = 'XCUIElementTypeStaticText'.freeze
|
|
1440
1030
|
|
|
1441
1031
|
|
|
1442
1032
|
|
|
1443
|
-
|
|
1444
|
-
|
|
1445
|
-
##### [static_text_class](https://github.com/appium/ruby_lib/blob/c6eb8f5416ccdf75b161bc60c0986caec43d9ff8/lib/appium_lib/ios/element/text.rb#L8) ios
|
|
1033
|
+
--\n\n##### [static_text_class](https://github.com/appium/ruby_lib/blob/621a9ebaf18bcd80eb0e1f5fc17fbb4dddf5293a/lib/appium_lib/ios/element/text.rb#L8) ios
|
|
1446
1034
|
|
|
1447
1035
|
> def static_text_class
|
|
1448
1036
|
|
|
1449
1037
|
|
|
1450
1038
|
|
|
1451
|
-
__Returns:__
|
|
1452
|
-
|
|
1453
|
-
[String] Class name for text
|
|
1039
|
+
__Returns:__\n\n [String] Class name for text
|
|
1454
1040
|
|
|
1455
|
-
|
|
1456
|
-
|
|
1457
|
-
##### [text](https://github.com/appium/ruby_lib/blob/c6eb8f5416ccdf75b161bc60c0986caec43d9ff8/lib/appium_lib/ios/element/text.rb#L16) ios
|
|
1041
|
+
--\n\n##### [text](https://github.com/appium/ruby_lib/blob/621a9ebaf18bcd80eb0e1f5fc17fbb4dddf5293a/lib/appium_lib/ios/element/text.rb#L16) ios
|
|
1458
1042
|
|
|
1459
1043
|
> def text(value)
|
|
1460
1044
|
|
|
1461
1045
|
Find the first UIAStaticText|XCUIElementTypeStaticText that contains value or by index.
|
|
1462
1046
|
If int then the UIAStaticText|XCUIElementTypeStaticText at that index is returned.
|
|
1463
1047
|
|
|
1464
|
-
__Parameters:__
|
|
1465
|
-
|
|
1466
|
-
[String, Integer] value - the value to find.
|
|
1467
|
-
|
|
1468
|
-
__Returns:__
|
|
1469
|
-
|
|
1470
|
-
[UIAStaticText|XCUIElementTypeStaticText]
|
|
1048
|
+
__Parameters:__\n\n [String, Integer] value - the value to find.
|
|
1471
1049
|
|
|
1472
|
-
|
|
1050
|
+
__Returns:__\n\n [UIAStaticText|XCUIElementTypeStaticText]
|
|
1473
1051
|
|
|
1474
|
-
##### [texts](https://github.com/appium/ruby_lib/blob/
|
|
1052
|
+
--\n\n##### [texts](https://github.com/appium/ruby_lib/blob/621a9ebaf18bcd80eb0e1f5fc17fbb4dddf5293a/lib/appium_lib/ios/element/text.rb#L26) ios
|
|
1475
1053
|
|
|
1476
1054
|
> def texts(value = false)
|
|
1477
1055
|
|
|
1478
1056
|
Find all UIAStaticTexts|XCUIElementTypeStaticTexts containing value.
|
|
1479
1057
|
If value is omitted, all UIAStaticTexts|XCUIElementTypeStaticTexts are returned
|
|
1480
1058
|
|
|
1481
|
-
__Parameters:__
|
|
1482
|
-
|
|
1483
|
-
[String] value - the value to search for
|
|
1484
|
-
|
|
1485
|
-
__Returns:__
|
|
1486
|
-
|
|
1487
|
-
[Array<UIAStaticText|XCUIElementTypeStaticText>]
|
|
1059
|
+
__Parameters:__\n\n [String] value - the value to search for
|
|
1488
1060
|
|
|
1489
|
-
|
|
1061
|
+
__Returns:__\n\n [Array<UIAStaticText|XCUIElementTypeStaticText>]
|
|
1490
1062
|
|
|
1491
|
-
##### [first_text](https://github.com/appium/ruby_lib/blob/
|
|
1063
|
+
--\n\n##### [first_text](https://github.com/appium/ruby_lib/blob/621a9ebaf18bcd80eb0e1f5fc17fbb4dddf5293a/lib/appium_lib/ios/element/text.rb#L34) ios
|
|
1492
1064
|
|
|
1493
1065
|
> def first_text
|
|
1494
1066
|
|
|
1495
1067
|
Find the first UIAStaticText|XCUIElementTypeStaticText.
|
|
1496
1068
|
|
|
1497
|
-
__Returns:__
|
|
1069
|
+
__Returns:__\n\n [UIAStaticText|XCUIElementTypeStaticText]
|
|
1498
1070
|
|
|
1499
|
-
|
|
1500
|
-
|
|
1501
|
-
--
|
|
1502
|
-
|
|
1503
|
-
##### [last_text](https://github.com/appium/ruby_lib/blob/c6eb8f5416ccdf75b161bc60c0986caec43d9ff8/lib/appium_lib/ios/element/text.rb#L40) ios
|
|
1071
|
+
--\n\n##### [last_text](https://github.com/appium/ruby_lib/blob/621a9ebaf18bcd80eb0e1f5fc17fbb4dddf5293a/lib/appium_lib/ios/element/text.rb#L40) ios
|
|
1504
1072
|
|
|
1505
1073
|
> def last_text
|
|
1506
1074
|
|
|
1507
1075
|
Find the last UIAStaticText|XCUIElementTypeStaticText.
|
|
1508
1076
|
|
|
1509
|
-
__Returns:__
|
|
1510
|
-
|
|
1511
|
-
[UIAStaticText|XCUIElementTypeStaticText]
|
|
1512
|
-
|
|
1513
|
-
--
|
|
1077
|
+
__Returns:__\n\n [UIAStaticText|XCUIElementTypeStaticText]
|
|
1514
1078
|
|
|
1515
|
-
##### [text_exact](https://github.com/appium/ruby_lib/blob/
|
|
1079
|
+
--\n\n##### [text_exact](https://github.com/appium/ruby_lib/blob/621a9ebaf18bcd80eb0e1f5fc17fbb4dddf5293a/lib/appium_lib/ios/element/text.rb#L47) ios
|
|
1516
1080
|
|
|
1517
1081
|
> def text_exact(value)
|
|
1518
1082
|
|
|
1519
1083
|
Find the first UIAStaticText|XCUIElementTypeStaticText that exactly matches value.
|
|
1520
1084
|
|
|
1521
|
-
__Parameters:__
|
|
1085
|
+
__Parameters:__\n\n [String] value - the value to match exactly
|
|
1522
1086
|
|
|
1523
|
-
[
|
|
1087
|
+
__Returns:__\n\n [UIAStaticText|XCUIElementTypeStaticText]
|
|
1524
1088
|
|
|
1525
|
-
|
|
1526
|
-
|
|
1527
|
-
[UIAStaticText|XCUIElementTypeStaticText]
|
|
1528
|
-
|
|
1529
|
-
--
|
|
1530
|
-
|
|
1531
|
-
##### [texts_exact](https://github.com/appium/ruby_lib/blob/c6eb8f5416ccdf75b161bc60c0986caec43d9ff8/lib/appium_lib/ios/element/text.rb#L54) ios
|
|
1089
|
+
--\n\n##### [texts_exact](https://github.com/appium/ruby_lib/blob/621a9ebaf18bcd80eb0e1f5fc17fbb4dddf5293a/lib/appium_lib/ios/element/text.rb#L54) ios
|
|
1532
1090
|
|
|
1533
1091
|
> def texts_exact(value)
|
|
1534
1092
|
|
|
1535
1093
|
Find all UIAStaticTexts|XCUIElementTypeStaticTexts that exactly match value.
|
|
1536
1094
|
|
|
1537
|
-
__Parameters:__
|
|
1538
|
-
|
|
1539
|
-
[String] value - the value to match exactly
|
|
1095
|
+
__Parameters:__\n\n [String] value - the value to match exactly
|
|
1540
1096
|
|
|
1541
|
-
__Returns:__
|
|
1097
|
+
__Returns:__\n\n [Array<UIAStaticText|XCUIElementTypeStaticText>]
|
|
1542
1098
|
|
|
1543
|
-
|
|
1544
|
-
|
|
1545
|
-
--
|
|
1546
|
-
|
|
1547
|
-
##### [filter](https://github.com/appium/ruby_lib/blob/c6eb8f5416ccdf75b161bc60c0986caec43d9ff8/lib/appium_lib/ios/common/helper.rb#L5) ios
|
|
1099
|
+
--\n\n##### [filter](https://github.com/appium/ruby_lib/blob/621a9ebaf18bcd80eb0e1f5fc17fbb4dddf5293a/lib/appium_lib/ios/common/helper.rb#L5) ios
|
|
1548
1100
|
|
|
1549
1101
|
> def filter
|
|
1550
1102
|
|
|
1551
1103
|
Returns the value of attribute filter
|
|
1552
1104
|
|
|
1553
|
-
|
|
1554
|
-
|
|
1555
|
-
##### [filter=](https://github.com/appium/ruby_lib/blob/c6eb8f5416ccdf75b161bc60c0986caec43d9ff8/lib/appium_lib/ios/common/helper.rb#L5) ios
|
|
1105
|
+
--\n\n##### [filter=](https://github.com/appium/ruby_lib/blob/621a9ebaf18bcd80eb0e1f5fc17fbb4dddf5293a/lib/appium_lib/ios/common/helper.rb#L5) ios
|
|
1556
1106
|
|
|
1557
1107
|
> def filter=(value)
|
|
1558
1108
|
|
|
1559
1109
|
Sets the attribute filter
|
|
1560
1110
|
|
|
1561
|
-
__Parameters:__
|
|
1562
|
-
|
|
1563
|
-
value - the value to set the attribute filter to.
|
|
1111
|
+
__Parameters:__\n\n [] value - the value to set the attribute filter to.
|
|
1564
1112
|
|
|
1565
|
-
|
|
1566
|
-
|
|
1567
|
-
##### [start_element](https://github.com/appium/ruby_lib/blob/c6eb8f5416ccdf75b161bc60c0986caec43d9ff8/lib/appium_lib/ios/common/helper.rb#L7) ios
|
|
1113
|
+
--\n\n##### [start_element](https://github.com/appium/ruby_lib/blob/621a9ebaf18bcd80eb0e1f5fc17fbb4dddf5293a/lib/appium_lib/ios/common/helper.rb#L7) ios
|
|
1568
1114
|
|
|
1569
1115
|
> def start_element(type, attrs = [])
|
|
1570
1116
|
|
|
1571
1117
|
|
|
1572
1118
|
|
|
1573
|
-
|
|
1574
|
-
|
|
1575
|
-
##### [ios_password](https://github.com/appium/ruby_lib/blob/c6eb8f5416ccdf75b161bc60c0986caec43d9ff8/lib/appium_lib/ios/common/helper.rb#L43) ios
|
|
1119
|
+
--\n\n##### [ios_password](https://github.com/appium/ruby_lib/blob/621a9ebaf18bcd80eb0e1f5fc17fbb4dddf5293a/lib/appium_lib/ios/common/helper.rb#L43) ios
|
|
1576
1120
|
|
|
1577
1121
|
> def ios_password(length = 1)
|
|
1578
1122
|
|
|
@@ -1580,69 +1124,45 @@ iOS only. On Android uiautomator always returns an empty string for EditText pas
|
|
|
1580
1124
|
|
|
1581
1125
|
Password character returned from value of UIASecureTextField
|
|
1582
1126
|
|
|
1583
|
-
__Parameters:__
|
|
1584
|
-
|
|
1585
|
-
[Integer] length - the length of the password to generate
|
|
1586
|
-
|
|
1587
|
-
__Returns:__
|
|
1127
|
+
__Parameters:__\n\n [Integer] length - the length of the password to generate
|
|
1588
1128
|
|
|
1589
|
-
[String] the returned string is of size length
|
|
1129
|
+
__Returns:__\n\n [String] the returned string is of size length
|
|
1590
1130
|
|
|
1591
|
-
|
|
1592
|
-
|
|
1593
|
-
##### [page](https://github.com/appium/ruby_lib/blob/c6eb8f5416ccdf75b161bc60c0986caec43d9ff8/lib/appium_lib/ios/common/helper.rb#L59) ios
|
|
1131
|
+
--\n\n##### [page](https://github.com/appium/ruby_lib/blob/621a9ebaf18bcd80eb0e1f5fc17fbb4dddf5293a/lib/appium_lib/ios/common/helper.rb#L59) ios
|
|
1594
1132
|
|
|
1595
1133
|
> def page(opts = {})
|
|
1596
1134
|
|
|
1597
1135
|
Prints a string of interesting elements to the console.
|
|
1598
1136
|
|
|
1599
|
-
__Parameters:__
|
|
1600
|
-
|
|
1601
|
-
[Hash] visible - a customizable set of options
|
|
1137
|
+
__Parameters:__\n\n [Hash] visible - a customizable set of options
|
|
1602
1138
|
|
|
1603
1139
|
[Hash] class - a customizable set of options
|
|
1604
1140
|
|
|
1605
|
-
__Returns:__
|
|
1606
|
-
|
|
1607
|
-
[void]
|
|
1608
|
-
|
|
1609
|
-
--
|
|
1141
|
+
__Returns:__\n\n [void]
|
|
1610
1142
|
|
|
1611
|
-
##### [id](https://github.com/appium/ruby_lib/blob/
|
|
1143
|
+
--\n\n##### [id](https://github.com/appium/ruby_lib/blob/621a9ebaf18bcd80eb0e1f5fc17fbb4dddf5293a/lib/appium_lib/ios/common/helper.rb#L86) ios
|
|
1612
1144
|
|
|
1613
1145
|
> def id(id)
|
|
1614
1146
|
|
|
1615
1147
|
Find by id
|
|
1616
1148
|
|
|
1617
|
-
__Parameters:__
|
|
1149
|
+
__Parameters:__\n\n [String] id - the id to search for
|
|
1618
1150
|
|
|
1619
|
-
[
|
|
1151
|
+
__Returns:__\n\n [Element]
|
|
1620
1152
|
|
|
1621
|
-
|
|
1622
|
-
|
|
1623
|
-
[Element]
|
|
1624
|
-
|
|
1625
|
-
--
|
|
1626
|
-
|
|
1627
|
-
##### [ele_index](https://github.com/appium/ruby_lib/blob/c6eb8f5416ccdf75b161bc60c0986caec43d9ff8/lib/appium_lib/ios/common/helper.rb#L94) ios
|
|
1153
|
+
--\n\n##### [ele_index](https://github.com/appium/ruby_lib/blob/621a9ebaf18bcd80eb0e1f5fc17fbb4dddf5293a/lib/appium_lib/ios/common/helper.rb#L94) ios
|
|
1628
1154
|
|
|
1629
1155
|
> def ele_index(class_name, index)
|
|
1630
1156
|
|
|
1631
1157
|
Get the element of type class_name at matching index.
|
|
1632
1158
|
|
|
1633
|
-
__Parameters:__
|
|
1634
|
-
|
|
1635
|
-
[String] class_name - the class name to find
|
|
1159
|
+
__Parameters:__\n\n [String] class_name - the class name to find
|
|
1636
1160
|
|
|
1637
1161
|
[Integer] index - the index
|
|
1638
1162
|
|
|
1639
|
-
__Returns:__
|
|
1163
|
+
__Returns:__\n\n [Element]
|
|
1640
1164
|
|
|
1641
|
-
|
|
1642
|
-
|
|
1643
|
-
--
|
|
1644
|
-
|
|
1645
|
-
##### [find_ele_by_attr](https://github.com/appium/ruby_lib/blob/c6eb8f5416ccdf75b161bc60c0986caec43d9ff8/lib/appium_lib/ios/common/helper.rb#L124) ios
|
|
1165
|
+
--\n\n##### [find_ele_by_attr](https://github.com/appium/ruby_lib/blob/621a9ebaf18bcd80eb0e1f5fc17fbb4dddf5293a/lib/appium_lib/ios/common/helper.rb#L124) ios
|
|
1646
1166
|
|
|
1647
1167
|
> def find_ele_by_attr(class_name, attr, value)
|
|
1648
1168
|
|
|
@@ -1650,21 +1170,15 @@ Find the first element exactly matching class and attribute value.
|
|
|
1650
1170
|
Note: Uses XPath
|
|
1651
1171
|
Note: For XCUITest, this method return ALL elements include displayed or not displayed elements.
|
|
1652
1172
|
|
|
1653
|
-
__Parameters:__
|
|
1654
|
-
|
|
1655
|
-
[String] class_name - the class name to search for
|
|
1173
|
+
__Parameters:__\n\n [String] class_name - the class name to search for
|
|
1656
1174
|
|
|
1657
1175
|
[String] attr - the attribute to inspect
|
|
1658
1176
|
|
|
1659
1177
|
[String] value - the expected value of the attribute
|
|
1660
1178
|
|
|
1661
|
-
__Returns:__
|
|
1662
|
-
|
|
1663
|
-
[Element]
|
|
1179
|
+
__Returns:__\n\n [Element]
|
|
1664
1180
|
|
|
1665
|
-
|
|
1666
|
-
|
|
1667
|
-
##### [find_eles_by_attr](https://github.com/appium/ruby_lib/blob/c6eb8f5416ccdf75b161bc60c0986caec43d9ff8/lib/appium_lib/ios/common/helper.rb#L135) ios
|
|
1181
|
+
--\n\n##### [find_eles_by_attr](https://github.com/appium/ruby_lib/blob/621a9ebaf18bcd80eb0e1f5fc17fbb4dddf5293a/lib/appium_lib/ios/common/helper.rb#L135) ios
|
|
1668
1182
|
|
|
1669
1183
|
> def find_eles_by_attr(class_name, attr, value)
|
|
1670
1184
|
|
|
@@ -1672,199 +1186,133 @@ Find all elements exactly matching class and attribute value.
|
|
|
1672
1186
|
Note: Uses XPath
|
|
1673
1187
|
Note: For XCUITest, this method return ALL elements include displayed or not displayed elements.
|
|
1674
1188
|
|
|
1675
|
-
__Parameters:__
|
|
1676
|
-
|
|
1677
|
-
[String] class_name - the class name to match
|
|
1189
|
+
__Parameters:__\n\n [String] class_name - the class name to match
|
|
1678
1190
|
|
|
1679
1191
|
[String] attr - the attribute to compare
|
|
1680
1192
|
|
|
1681
1193
|
[String] value - the value of the attribute that the element must have
|
|
1682
1194
|
|
|
1683
|
-
__Returns:__
|
|
1684
|
-
|
|
1685
|
-
[Array<Element>]
|
|
1686
|
-
|
|
1687
|
-
--
|
|
1195
|
+
__Returns:__\n\n [Array<Element>]
|
|
1688
1196
|
|
|
1689
|
-
##### [find_ele_by_predicate](https://github.com/appium/ruby_lib/blob/
|
|
1197
|
+
--\n\n##### [find_ele_by_predicate](https://github.com/appium/ruby_lib/blob/621a9ebaf18bcd80eb0e1f5fc17fbb4dddf5293a/lib/appium_lib/ios/common/helper.rb#L148) ios
|
|
1690
1198
|
|
|
1691
1199
|
> def find_ele_by_predicate(class_name: '*', value:)
|
|
1692
1200
|
|
|
1693
1201
|
Find the first element exactly matching attribute case insensitive value.
|
|
1694
1202
|
Note: Uses Predicate
|
|
1695
1203
|
|
|
1696
|
-
__Parameters:__
|
|
1204
|
+
__Parameters:__\n\n [String] value - the expected value of the attribute
|
|
1697
1205
|
|
|
1698
|
-
[
|
|
1699
|
-
|
|
1700
|
-
__Returns:__
|
|
1701
|
-
|
|
1702
|
-
[Element]
|
|
1703
|
-
|
|
1704
|
-
--
|
|
1206
|
+
__Returns:__\n\n [Element]
|
|
1705
1207
|
|
|
1706
|
-
##### [find_eles_by_predicate](https://github.com/appium/ruby_lib/blob/
|
|
1208
|
+
--\n\n##### [find_eles_by_predicate](https://github.com/appium/ruby_lib/blob/621a9ebaf18bcd80eb0e1f5fc17fbb4dddf5293a/lib/appium_lib/ios/common/helper.rb#L160) ios
|
|
1707
1209
|
|
|
1708
1210
|
> def find_eles_by_predicate(class_name: '*', value:)
|
|
1709
1211
|
|
|
1710
1212
|
Find all elements exactly matching attribute case insensitive value.
|
|
1711
1213
|
Note: Uses Predicate
|
|
1712
1214
|
|
|
1713
|
-
__Parameters:__
|
|
1714
|
-
|
|
1715
|
-
[String] value - the value of the attribute that the element must have
|
|
1215
|
+
__Parameters:__\n\n [String] value - the value of the attribute that the element must have
|
|
1716
1216
|
|
|
1717
1217
|
[String] class_name - the tag name to match
|
|
1718
1218
|
|
|
1719
|
-
__Returns:__
|
|
1720
|
-
|
|
1721
|
-
[Array<Element>]
|
|
1722
|
-
|
|
1723
|
-
--
|
|
1219
|
+
__Returns:__\n\n [Array<Element>]
|
|
1724
1220
|
|
|
1725
|
-
##### [find_ele_by_attr_include](https://github.com/appium/ruby_lib/blob/
|
|
1221
|
+
--\n\n##### [find_ele_by_attr_include](https://github.com/appium/ruby_lib/blob/621a9ebaf18bcd80eb0e1f5fc17fbb4dddf5293a/lib/appium_lib/ios/common/helper.rb#L176) ios
|
|
1726
1222
|
|
|
1727
1223
|
> def find_ele_by_attr_include(class_name, attr, value)
|
|
1728
1224
|
|
|
1729
1225
|
Get the first tag by attribute that exactly matches value.
|
|
1730
1226
|
Note: Uses XPath
|
|
1731
1227
|
|
|
1732
|
-
__Parameters:__
|
|
1733
|
-
|
|
1734
|
-
[String] class_name - the tag name to match
|
|
1228
|
+
__Parameters:__\n\n [String] class_name - the tag name to match
|
|
1735
1229
|
|
|
1736
1230
|
[String] attr - the attribute to compare
|
|
1737
1231
|
|
|
1738
1232
|
[String] value - the value of the attribute that the element must include
|
|
1739
1233
|
|
|
1740
|
-
__Returns:__
|
|
1741
|
-
|
|
1742
|
-
[Element] the element of type tag who's attribute includes value
|
|
1234
|
+
__Returns:__\n\n [Element] the element of type tag who's attribute includes value
|
|
1743
1235
|
|
|
1744
|
-
|
|
1745
|
-
|
|
1746
|
-
##### [find_eles_by_attr_include](https://github.com/appium/ruby_lib/blob/c6eb8f5416ccdf75b161bc60c0986caec43d9ff8/lib/appium_lib/ios/common/helper.rb#L186) ios
|
|
1236
|
+
--\n\n##### [find_eles_by_attr_include](https://github.com/appium/ruby_lib/blob/621a9ebaf18bcd80eb0e1f5fc17fbb4dddf5293a/lib/appium_lib/ios/common/helper.rb#L186) ios
|
|
1747
1237
|
|
|
1748
1238
|
> def find_eles_by_attr_include(class_name, attr, value)
|
|
1749
1239
|
|
|
1750
1240
|
Get tags by attribute that include value.
|
|
1751
1241
|
Note: Uses XPath
|
|
1752
1242
|
|
|
1753
|
-
__Parameters:__
|
|
1754
|
-
|
|
1755
|
-
[String] class_name - the tag name to match
|
|
1243
|
+
__Parameters:__\n\n [String] class_name - the tag name to match
|
|
1756
1244
|
|
|
1757
1245
|
[String] attr - the attribute to compare
|
|
1758
1246
|
|
|
1759
1247
|
[String] value - the value of the attribute that the element must include
|
|
1760
1248
|
|
|
1761
|
-
__Returns:__
|
|
1762
|
-
|
|
1763
|
-
[Array<Element>] the elements of type tag who's attribute includes value
|
|
1249
|
+
__Returns:__\n\n [Array<Element>] the elements of type tag who's attribute includes value
|
|
1764
1250
|
|
|
1765
|
-
|
|
1766
|
-
|
|
1767
|
-
##### [find_ele_by_predicate_include](https://github.com/appium/ruby_lib/blob/c6eb8f5416ccdf75b161bc60c0986caec43d9ff8/lib/appium_lib/ios/common/helper.rb#L194) ios
|
|
1251
|
+
--\n\n##### [find_ele_by_predicate_include](https://github.com/appium/ruby_lib/blob/621a9ebaf18bcd80eb0e1f5fc17fbb4dddf5293a/lib/appium_lib/ios/common/helper.rb#L194) ios
|
|
1768
1252
|
|
|
1769
1253
|
> def find_ele_by_predicate_include(class_name: '*', value:)
|
|
1770
1254
|
|
|
1771
1255
|
Get the first elements that include insensitive value.
|
|
1772
1256
|
Note: Uses Predicate
|
|
1773
1257
|
|
|
1774
|
-
__Parameters:__
|
|
1258
|
+
__Parameters:__\n\n [String] value - the value of the attribute that the element must include
|
|
1775
1259
|
|
|
1776
|
-
[
|
|
1260
|
+
__Returns:__\n\n [Element] the element of type tag who's attribute includes value
|
|
1777
1261
|
|
|
1778
|
-
|
|
1779
|
-
|
|
1780
|
-
[Element] the element of type tag who's attribute includes value
|
|
1781
|
-
|
|
1782
|
-
--
|
|
1783
|
-
|
|
1784
|
-
##### [find_eles_by_predicate_include](https://github.com/appium/ruby_lib/blob/c6eb8f5416ccdf75b161bc60c0986caec43d9ff8/lib/appium_lib/ios/common/helper.rb#L206) ios
|
|
1262
|
+
--\n\n##### [find_eles_by_predicate_include](https://github.com/appium/ruby_lib/blob/621a9ebaf18bcd80eb0e1f5fc17fbb4dddf5293a/lib/appium_lib/ios/common/helper.rb#L206) ios
|
|
1785
1263
|
|
|
1786
1264
|
> def find_eles_by_predicate_include(class_name: '*', value:)
|
|
1787
1265
|
|
|
1788
1266
|
Get elements that include case insensitive value.
|
|
1789
1267
|
Note: Uses Predicate
|
|
1790
1268
|
|
|
1791
|
-
__Parameters:__
|
|
1792
|
-
|
|
1793
|
-
[String] value - the value of the attribute that the element must include
|
|
1269
|
+
__Parameters:__\n\n [String] value - the value of the attribute that the element must include
|
|
1794
1270
|
|
|
1795
1271
|
[String] class_name - the tag name to match
|
|
1796
1272
|
|
|
1797
|
-
__Returns:__
|
|
1798
|
-
|
|
1799
|
-
[Array<Element>] the elements of type tag who's attribute includes value
|
|
1273
|
+
__Returns:__\n\n [Array<Element>] the elements of type tag who's attribute includes value
|
|
1800
1274
|
|
|
1801
|
-
|
|
1802
|
-
|
|
1803
|
-
##### [first_ele](https://github.com/appium/ruby_lib/blob/c6eb8f5416ccdf75b161bc60c0986caec43d9ff8/lib/appium_lib/ios/common/helper.rb#L219) ios
|
|
1275
|
+
--\n\n##### [first_ele](https://github.com/appium/ruby_lib/blob/621a9ebaf18bcd80eb0e1f5fc17fbb4dddf5293a/lib/appium_lib/ios/common/helper.rb#L219) ios
|
|
1804
1276
|
|
|
1805
1277
|
> def first_ele(class_name)
|
|
1806
1278
|
|
|
1807
1279
|
Get the first tag that matches class_name
|
|
1808
1280
|
|
|
1809
|
-
__Parameters:__
|
|
1810
|
-
|
|
1811
|
-
[String] class_name - the tag to match
|
|
1281
|
+
__Parameters:__\n\n [String] class_name - the tag to match
|
|
1812
1282
|
|
|
1813
|
-
__Returns:__
|
|
1283
|
+
__Returns:__\n\n [Element]
|
|
1814
1284
|
|
|
1815
|
-
|
|
1816
|
-
|
|
1817
|
-
--
|
|
1818
|
-
|
|
1819
|
-
##### [last_ele](https://github.com/appium/ruby_lib/blob/c6eb8f5416ccdf75b161bc60c0986caec43d9ff8/lib/appium_lib/ios/common/helper.rb#L226) ios
|
|
1285
|
+
--\n\n##### [last_ele](https://github.com/appium/ruby_lib/blob/621a9ebaf18bcd80eb0e1f5fc17fbb4dddf5293a/lib/appium_lib/ios/common/helper.rb#L226) ios
|
|
1820
1286
|
|
|
1821
1287
|
> def last_ele(class_name)
|
|
1822
1288
|
|
|
1823
1289
|
Get the last tag that matches class_name
|
|
1824
1290
|
|
|
1825
|
-
__Parameters:__
|
|
1826
|
-
|
|
1827
|
-
[String] class_name - the tag to match
|
|
1828
|
-
|
|
1829
|
-
__Returns:__
|
|
1830
|
-
|
|
1831
|
-
[Element]
|
|
1291
|
+
__Parameters:__\n\n [String] class_name - the tag to match
|
|
1832
1292
|
|
|
1833
|
-
|
|
1293
|
+
__Returns:__\n\n [Element]
|
|
1834
1294
|
|
|
1835
|
-
##### [tag](https://github.com/appium/ruby_lib/blob/
|
|
1295
|
+
--\n\n##### [tag](https://github.com/appium/ruby_lib/blob/621a9ebaf18bcd80eb0e1f5fc17fbb4dddf5293a/lib/appium_lib/ios/common/helper.rb#L234) ios
|
|
1836
1296
|
|
|
1837
1297
|
> def tag(class_name)
|
|
1838
1298
|
|
|
1839
1299
|
Returns the first **visible** element matching class_name
|
|
1840
1300
|
|
|
1841
|
-
__Parameters:__
|
|
1301
|
+
__Parameters:__\n\n [String] class_name - the class_name to search for
|
|
1842
1302
|
|
|
1843
|
-
[
|
|
1303
|
+
__Returns:__\n\n [Element]
|
|
1844
1304
|
|
|
1845
|
-
|
|
1846
|
-
|
|
1847
|
-
[Element]
|
|
1848
|
-
|
|
1849
|
-
--
|
|
1850
|
-
|
|
1851
|
-
##### [tags](https://github.com/appium/ruby_lib/blob/c6eb8f5416ccdf75b161bc60c0986caec43d9ff8/lib/appium_lib/ios/common/helper.rb#L242) ios
|
|
1305
|
+
--\n\n##### [tags](https://github.com/appium/ruby_lib/blob/621a9ebaf18bcd80eb0e1f5fc17fbb4dddf5293a/lib/appium_lib/ios/common/helper.rb#L242) ios
|
|
1852
1306
|
|
|
1853
1307
|
> def tags(class_name)
|
|
1854
1308
|
|
|
1855
1309
|
Returns all visible elements matching class_name
|
|
1856
1310
|
|
|
1857
|
-
__Parameters:__
|
|
1858
|
-
|
|
1859
|
-
[String] class_name - the class_name to search for
|
|
1311
|
+
__Parameters:__\n\n [String] class_name - the class_name to search for
|
|
1860
1312
|
|
|
1861
|
-
__Returns:__
|
|
1313
|
+
__Returns:__\n\n [Element]
|
|
1862
1314
|
|
|
1863
|
-
|
|
1864
|
-
|
|
1865
|
-
--
|
|
1866
|
-
|
|
1867
|
-
##### [tags_include](https://github.com/appium/ruby_lib/blob/c6eb8f5416ccdf75b161bc60c0986caec43d9ff8/lib/appium_lib/ios/common/helper.rb#L253) ios
|
|
1315
|
+
--\n\n##### [tags_include](https://github.com/appium/ruby_lib/blob/621a9ebaf18bcd80eb0e1f5fc17fbb4dddf5293a/lib/appium_lib/ios/common/helper.rb#L253) ios
|
|
1868
1316
|
|
|
1869
1317
|
> def tags_include(class_names:, value: nil)
|
|
1870
1318
|
|
|
@@ -1872,19 +1320,13 @@ Returns all visible elements matching class_names and value
|
|
|
1872
1320
|
This method calls find_element/s and element.value/text many times.
|
|
1873
1321
|
So, if you set many class_names, this method's performance become worse.
|
|
1874
1322
|
|
|
1875
|
-
__Parameters:__
|
|
1876
|
-
|
|
1877
|
-
[Array[String]] class_names - the class_names to search for
|
|
1323
|
+
__Parameters:__\n\n [Array[String]] class_names - the class_names to search for
|
|
1878
1324
|
|
|
1879
1325
|
[String] value - the value to search for
|
|
1880
1326
|
|
|
1881
|
-
__Returns:__
|
|
1882
|
-
|
|
1883
|
-
[Array[Element]]
|
|
1327
|
+
__Returns:__\n\n [Array[Element]]
|
|
1884
1328
|
|
|
1885
|
-
|
|
1886
|
-
|
|
1887
|
-
##### [tags_exact](https://github.com/appium/ruby_lib/blob/c6eb8f5416ccdf75b161bc60c0986caec43d9ff8/lib/appium_lib/ios/common/helper.rb#L268) ios
|
|
1329
|
+
--\n\n##### [tags_exact](https://github.com/appium/ruby_lib/blob/621a9ebaf18bcd80eb0e1f5fc17fbb4dddf5293a/lib/appium_lib/ios/common/helper.rb#L268) ios
|
|
1888
1330
|
|
|
1889
1331
|
> def tags_exact(class_names:, value: nil)
|
|
1890
1332
|
|
|
@@ -1892,95 +1334,65 @@ Returns all visible elements matching class_names and value.
|
|
|
1892
1334
|
This method calls find_element/s and element.value/text many times.
|
|
1893
1335
|
So, if you set many class_names, this method's performance become worse.
|
|
1894
1336
|
|
|
1895
|
-
__Parameters:__
|
|
1896
|
-
|
|
1897
|
-
[Array[String]] class_names - the class_names to search for
|
|
1337
|
+
__Parameters:__\n\n [Array[String]] class_names - the class_names to search for
|
|
1898
1338
|
|
|
1899
1339
|
[String] value - the value to search for
|
|
1900
1340
|
|
|
1901
|
-
__Returns:__
|
|
1902
|
-
|
|
1903
|
-
[Array[Element]]
|
|
1904
|
-
|
|
1905
|
-
--
|
|
1341
|
+
__Returns:__\n\n [Array[Element]]
|
|
1906
1342
|
|
|
1907
|
-
##### [ele_by_json_visible_contains](https://github.com/appium/ruby_lib/blob/
|
|
1343
|
+
--\n\n##### [ele_by_json_visible_contains](https://github.com/appium/ruby_lib/blob/621a9ebaf18bcd80eb0e1f5fc17fbb4dddf5293a/lib/appium_lib/ios/common/helper.rb#L305) ios
|
|
1908
1344
|
|
|
1909
1345
|
> def ele_by_json_visible_contains(element, value)
|
|
1910
1346
|
|
|
1911
1347
|
Find the first element that contains value.
|
|
1912
1348
|
For Appium(automation name), not XCUITest
|
|
1913
1349
|
|
|
1914
|
-
__Parameters:__
|
|
1915
|
-
|
|
1916
|
-
[String] element - the class name for the element
|
|
1350
|
+
__Parameters:__\n\n [String] element - the class name for the element
|
|
1917
1351
|
|
|
1918
1352
|
[String] value - the value to search for
|
|
1919
1353
|
|
|
1920
|
-
__Returns:__
|
|
1921
|
-
|
|
1922
|
-
[Element]
|
|
1923
|
-
|
|
1924
|
-
--
|
|
1354
|
+
__Returns:__\n\n [Element]
|
|
1925
1355
|
|
|
1926
|
-
##### [eles_by_json_visible_contains](https://github.com/appium/ruby_lib/blob/
|
|
1356
|
+
--\n\n##### [eles_by_json_visible_contains](https://github.com/appium/ruby_lib/blob/621a9ebaf18bcd80eb0e1f5fc17fbb4dddf5293a/lib/appium_lib/ios/common/helper.rb#L314) ios
|
|
1927
1357
|
|
|
1928
1358
|
> def eles_by_json_visible_contains(element, value)
|
|
1929
1359
|
|
|
1930
1360
|
Find all elements containing value
|
|
1931
1361
|
For Appium(automation name), not XCUITest
|
|
1932
1362
|
|
|
1933
|
-
__Parameters:__
|
|
1934
|
-
|
|
1935
|
-
[String] element - the class name for the element
|
|
1363
|
+
__Parameters:__\n\n [String] element - the class name for the element
|
|
1936
1364
|
|
|
1937
1365
|
[String] value - the value to search for
|
|
1938
1366
|
|
|
1939
|
-
__Returns:__
|
|
1940
|
-
|
|
1941
|
-
[Array<Element>]
|
|
1367
|
+
__Returns:__\n\n [Array<Element>]
|
|
1942
1368
|
|
|
1943
|
-
|
|
1944
|
-
|
|
1945
|
-
##### [ele_by_json_visible_exact](https://github.com/appium/ruby_lib/blob/c6eb8f5416ccdf75b161bc60c0986caec43d9ff8/lib/appium_lib/ios/common/helper.rb#L344) ios
|
|
1369
|
+
--\n\n##### [ele_by_json_visible_exact](https://github.com/appium/ruby_lib/blob/621a9ebaf18bcd80eb0e1f5fc17fbb4dddf5293a/lib/appium_lib/ios/common/helper.rb#L344) ios
|
|
1946
1370
|
|
|
1947
1371
|
> def ele_by_json_visible_exact(element, value)
|
|
1948
1372
|
|
|
1949
1373
|
Find the first element exactly matching value
|
|
1950
1374
|
For Appium(automation name), not XCUITest
|
|
1951
1375
|
|
|
1952
|
-
__Parameters:__
|
|
1953
|
-
|
|
1954
|
-
[String] element - the class name for the element
|
|
1376
|
+
__Parameters:__\n\n [String] element - the class name for the element
|
|
1955
1377
|
|
|
1956
1378
|
[String] value - the value to search for
|
|
1957
1379
|
|
|
1958
|
-
__Returns:__
|
|
1959
|
-
|
|
1960
|
-
[Element]
|
|
1961
|
-
|
|
1962
|
-
--
|
|
1380
|
+
__Returns:__\n\n [Element]
|
|
1963
1381
|
|
|
1964
|
-
##### [eles_by_json_visible_exact](https://github.com/appium/ruby_lib/blob/
|
|
1382
|
+
--\n\n##### [eles_by_json_visible_exact](https://github.com/appium/ruby_lib/blob/621a9ebaf18bcd80eb0e1f5fc17fbb4dddf5293a/lib/appium_lib/ios/common/helper.rb#L353) ios
|
|
1965
1383
|
|
|
1966
1384
|
> def eles_by_json_visible_exact(element, value)
|
|
1967
1385
|
|
|
1968
1386
|
Find all elements exactly matching value
|
|
1969
1387
|
For Appium(automation name), not XCUITest
|
|
1970
1388
|
|
|
1971
|
-
__Parameters:__
|
|
1972
|
-
|
|
1973
|
-
[String] element - the class name for the element
|
|
1389
|
+
__Parameters:__\n\n [String] element - the class name for the element
|
|
1974
1390
|
|
|
1975
1391
|
[String] value - the value to search for
|
|
1976
1392
|
|
|
1977
|
-
__Returns:__
|
|
1978
|
-
|
|
1979
|
-
[Element]
|
|
1393
|
+
__Returns:__\n\n [Element]
|
|
1980
1394
|
|
|
1981
|
-
|
|
1982
|
-
|
|
1983
|
-
##### [_all_pred](https://github.com/appium/ruby_lib/blob/c6eb8f5416ccdf75b161bc60c0986caec43d9ff8/lib/appium_lib/ios/common/helper.rb#L362) ios
|
|
1395
|
+
--\n\n##### [_all_pred](https://github.com/appium/ruby_lib/blob/621a9ebaf18bcd80eb0e1f5fc17fbb4dddf5293a/lib/appium_lib/ios/common/helper.rb#L362) ios
|
|
1984
1396
|
|
|
1985
1397
|
> def _all_pred(opts)
|
|
1986
1398
|
|
|
@@ -1988,9 +1400,7 @@ predicate - the predicate to evaluate on the main app
|
|
|
1988
1400
|
|
|
1989
1401
|
visible - if true, only visible elements are returned. default true
|
|
1990
1402
|
|
|
1991
|
-
|
|
1992
|
-
|
|
1993
|
-
##### [ele_with_pred](https://github.com/appium/ruby_lib/blob/c6eb8f5416ccdf75b161bc60c0986caec43d9ff8/lib/appium_lib/ios/common/helper.rb#L376) ios
|
|
1403
|
+
--\n\n##### [ele_with_pred](https://github.com/appium/ruby_lib/blob/621a9ebaf18bcd80eb0e1f5fc17fbb4dddf5293a/lib/appium_lib/ios/common/helper.rb#L376) ios
|
|
1994
1404
|
|
|
1995
1405
|
> def ele_with_pred(opts)
|
|
1996
1406
|
|
|
@@ -2000,13 +1410,9 @@ predicate - the predicate to evaluate on the main app
|
|
|
2000
1410
|
|
|
2001
1411
|
visible - if true, only visible elements are returned. default true
|
|
2002
1412
|
|
|
2003
|
-
__Returns:__
|
|
1413
|
+
__Returns:__\n\n [Element]
|
|
2004
1414
|
|
|
2005
|
-
|
|
2006
|
-
|
|
2007
|
-
--
|
|
2008
|
-
|
|
2009
|
-
##### [eles_with_pred](https://github.com/appium/ruby_lib/blob/c6eb8f5416ccdf75b161bc60c0986caec43d9ff8/lib/appium_lib/ios/common/helper.rb#L387) ios
|
|
1415
|
+
--\n\n##### [eles_with_pred](https://github.com/appium/ruby_lib/blob/621a9ebaf18bcd80eb0e1f5fc17fbb4dddf5293a/lib/appium_lib/ios/common/helper.rb#L387) ios
|
|
2010
1416
|
|
|
2011
1417
|
> def eles_with_pred(opts)
|
|
2012
1418
|
|
|
@@ -2016,21 +1422,15 @@ predicate - the predicate to evaluate on the main app
|
|
|
2016
1422
|
|
|
2017
1423
|
visible - if true, only visible elements are returned. default true
|
|
2018
1424
|
|
|
2019
|
-
__Returns:__
|
|
2020
|
-
|
|
2021
|
-
[Array<Element>]
|
|
2022
|
-
|
|
2023
|
-
--
|
|
1425
|
+
__Returns:__\n\n [Array<Element>]
|
|
2024
1426
|
|
|
2025
|
-
##### [_validate_object](https://github.com/appium/ruby_lib/blob/
|
|
1427
|
+
--\n\n##### [_validate_object](https://github.com/appium/ruby_lib/blob/621a9ebaf18bcd80eb0e1f5fc17fbb4dddf5293a/lib/appium_lib/ios/common/helper.rb#L391) ios
|
|
2026
1428
|
|
|
2027
1429
|
> def _validate_object(*objects)
|
|
2028
1430
|
|
|
2029
1431
|
|
|
2030
1432
|
|
|
2031
|
-
|
|
2032
|
-
|
|
2033
|
-
##### [_by_json](https://github.com/appium/ruby_lib/blob/c6eb8f5416ccdf75b161bc60c0986caec43d9ff8/lib/appium_lib/ios/common/helper.rb#L441) ios
|
|
1433
|
+
--\n\n##### [_by_json](https://github.com/appium/ruby_lib/blob/621a9ebaf18bcd80eb0e1f5fc17fbb4dddf5293a/lib/appium_lib/ios/common/helper.rb#L441) ios
|
|
2034
1434
|
|
|
2035
1435
|
> def _by_json(opts)
|
|
2036
1436
|
|
|
@@ -2063,9 +1463,7 @@ opts = {
|
|
|
2063
1463
|
}
|
|
2064
1464
|
}
|
|
2065
1465
|
|
|
2066
|
-
|
|
2067
|
-
|
|
2068
|
-
##### [eles_by_json](https://github.com/appium/ruby_lib/blob/c6eb8f5416ccdf75b161bc60c0986caec43d9ff8/lib/appium_lib/ios/common/helper.rb#L491) ios
|
|
1466
|
+
--\n\n##### [eles_by_json](https://github.com/appium/ruby_lib/blob/621a9ebaf18bcd80eb0e1f5fc17fbb4dddf5293a/lib/appium_lib/ios/common/helper.rb#L491) ios
|
|
2069
1467
|
|
|
2070
1468
|
> def eles_by_json(opts)
|
|
2071
1469
|
|
|
@@ -2082,115 +1480,79 @@ eles_by_json({
|
|
|
2082
1480
|
},
|
|
2083
1481
|
})
|
|
2084
1482
|
|
|
2085
|
-
|
|
2086
|
-
|
|
2087
|
-
##### [ele_by_json](https://github.com/appium/ruby_lib/blob/c6eb8f5416ccdf75b161bc60c0986caec43d9ff8/lib/appium_lib/ios/common/helper.rb#L497) ios
|
|
1483
|
+
--\n\n##### [ele_by_json](https://github.com/appium/ruby_lib/blob/621a9ebaf18bcd80eb0e1f5fc17fbb4dddf5293a/lib/appium_lib/ios/common/helper.rb#L497) ios
|
|
2088
1484
|
|
|
2089
1485
|
> def ele_by_json(opts)
|
|
2090
1486
|
|
|
2091
1487
|
see eles_by_json
|
|
2092
1488
|
|
|
2093
|
-
|
|
2094
|
-
|
|
2095
|
-
##### [alert_accept](https://github.com/appium/ruby_lib/blob/c6eb8f5416ccdf75b161bc60c0986caec43d9ff8/lib/appium_lib/ios/element/alert.rb#L5) ios
|
|
1489
|
+
--\n\n##### [alert_accept](https://github.com/appium/ruby_lib/blob/621a9ebaf18bcd80eb0e1f5fc17fbb4dddf5293a/lib/appium_lib/ios/element/alert.rb#L5) ios
|
|
2096
1490
|
|
|
2097
1491
|
> def alert_accept
|
|
2098
1492
|
|
|
2099
1493
|
Accept the alert.
|
|
2100
1494
|
|
|
2101
|
-
__Returns:__
|
|
1495
|
+
__Returns:__\n\n [void]
|
|
2102
1496
|
|
|
2103
|
-
|
|
2104
|
-
|
|
2105
|
-
--
|
|
2106
|
-
|
|
2107
|
-
##### [alert_dismiss](https://github.com/appium/ruby_lib/blob/c6eb8f5416ccdf75b161bc60c0986caec43d9ff8/lib/appium_lib/ios/element/alert.rb#L13) ios
|
|
1497
|
+
--\n\n##### [alert_dismiss](https://github.com/appium/ruby_lib/blob/621a9ebaf18bcd80eb0e1f5fc17fbb4dddf5293a/lib/appium_lib/ios/element/alert.rb#L13) ios
|
|
2108
1498
|
|
|
2109
1499
|
> def alert_dismiss
|
|
2110
1500
|
|
|
2111
1501
|
Dismiss the alert.
|
|
2112
1502
|
|
|
2113
|
-
__Returns:__
|
|
2114
|
-
|
|
2115
|
-
[void]
|
|
2116
|
-
|
|
2117
|
-
--
|
|
1503
|
+
__Returns:__\n\n [void]
|
|
2118
1504
|
|
|
2119
|
-
##### [UIAButton](https://github.com/appium/ruby_lib/blob/
|
|
1505
|
+
--\n\n##### [UIAButton](https://github.com/appium/ruby_lib/blob/621a9ebaf18bcd80eb0e1f5fc17fbb4dddf5293a/lib/appium_lib/ios/element/button.rb#L4) ios
|
|
2120
1506
|
|
|
2121
1507
|
> UIAButton = 'UIAButton'.freeze
|
|
2122
1508
|
|
|
2123
1509
|
|
|
2124
1510
|
|
|
2125
|
-
|
|
2126
|
-
|
|
2127
|
-
##### [XCUIElementTypeButton](https://github.com/appium/ruby_lib/blob/c6eb8f5416ccdf75b161bc60c0986caec43d9ff8/lib/appium_lib/ios/element/button.rb#L5) ios
|
|
1511
|
+
--\n\n##### [XCUIElementTypeButton](https://github.com/appium/ruby_lib/blob/621a9ebaf18bcd80eb0e1f5fc17fbb4dddf5293a/lib/appium_lib/ios/element/button.rb#L5) ios
|
|
2128
1512
|
|
|
2129
1513
|
> XCUIElementTypeButton = 'XCUIElementTypeButton'.freeze
|
|
2130
1514
|
|
|
2131
1515
|
|
|
2132
1516
|
|
|
2133
|
-
|
|
2134
|
-
|
|
2135
|
-
##### [button_class](https://github.com/appium/ruby_lib/blob/c6eb8f5416ccdf75b161bc60c0986caec43d9ff8/lib/appium_lib/ios/element/button.rb#L8) ios
|
|
1517
|
+
--\n\n##### [button_class](https://github.com/appium/ruby_lib/blob/621a9ebaf18bcd80eb0e1f5fc17fbb4dddf5293a/lib/appium_lib/ios/element/button.rb#L8) ios
|
|
2136
1518
|
|
|
2137
1519
|
> def button_class
|
|
2138
1520
|
|
|
2139
1521
|
|
|
2140
1522
|
|
|
2141
|
-
__Returns:__
|
|
2142
|
-
|
|
2143
|
-
[String] Class name for button
|
|
2144
|
-
|
|
2145
|
-
--
|
|
1523
|
+
__Returns:__\n\n [String] Class name for button
|
|
2146
1524
|
|
|
2147
|
-
##### [button](https://github.com/appium/ruby_lib/blob/
|
|
1525
|
+
--\n\n##### [button](https://github.com/appium/ruby_lib/blob/621a9ebaf18bcd80eb0e1f5fc17fbb4dddf5293a/lib/appium_lib/ios/element/button.rb#L16) ios
|
|
2148
1526
|
|
|
2149
1527
|
> def button(value)
|
|
2150
1528
|
|
|
2151
1529
|
Find the first UIAButton|XCUIElementTypeButton that contains value or by index.
|
|
2152
1530
|
If int then the UIAButton|XCUIElementTypeButton at that index is returned.
|
|
2153
1531
|
|
|
2154
|
-
__Parameters:__
|
|
1532
|
+
__Parameters:__\n\n [String, Integer] value - the value to exactly match.
|
|
2155
1533
|
|
|
2156
|
-
[
|
|
1534
|
+
__Returns:__\n\n [UIAButton|XCUIElementTypeButton]
|
|
2157
1535
|
|
|
2158
|
-
|
|
2159
|
-
|
|
2160
|
-
[UIAButton|XCUIElementTypeButton]
|
|
2161
|
-
|
|
2162
|
-
--
|
|
2163
|
-
|
|
2164
|
-
##### [buttons](https://github.com/appium/ruby_lib/blob/c6eb8f5416ccdf75b161bc60c0986caec43d9ff8/lib/appium_lib/ios/element/button.rb#L27) ios
|
|
1536
|
+
--\n\n##### [buttons](https://github.com/appium/ruby_lib/blob/621a9ebaf18bcd80eb0e1f5fc17fbb4dddf5293a/lib/appium_lib/ios/element/button.rb#L27) ios
|
|
2165
1537
|
|
|
2166
1538
|
> def buttons(value = false)
|
|
2167
1539
|
|
|
2168
1540
|
Find all UIAButtons|XCUIElementTypeButtons containing value.
|
|
2169
1541
|
If value is omitted, all UIAButtons|XCUIElementTypeButtons are returned.
|
|
2170
1542
|
|
|
2171
|
-
__Parameters:__
|
|
1543
|
+
__Parameters:__\n\n [String] value - the value to search for
|
|
2172
1544
|
|
|
2173
|
-
[
|
|
1545
|
+
__Returns:__\n\n [Array<UIAButton|XCUIElementTypeButton>]
|
|
2174
1546
|
|
|
2175
|
-
|
|
2176
|
-
|
|
2177
|
-
[Array<UIAButton|XCUIElementTypeButton>]
|
|
2178
|
-
|
|
2179
|
-
--
|
|
2180
|
-
|
|
2181
|
-
##### [first_button](https://github.com/appium/ruby_lib/blob/c6eb8f5416ccdf75b161bc60c0986caec43d9ff8/lib/appium_lib/ios/element/button.rb#L35) ios
|
|
1547
|
+
--\n\n##### [first_button](https://github.com/appium/ruby_lib/blob/621a9ebaf18bcd80eb0e1f5fc17fbb4dddf5293a/lib/appium_lib/ios/element/button.rb#L35) ios
|
|
2182
1548
|
|
|
2183
1549
|
> def first_button
|
|
2184
1550
|
|
|
2185
1551
|
Find the first UIAButton|XCUIElementTypeButton.
|
|
2186
1552
|
|
|
2187
|
-
__Returns:__
|
|
2188
|
-
|
|
2189
|
-
[UIAButton|XCUIElementTypeButton]
|
|
2190
|
-
|
|
2191
|
-
--
|
|
1553
|
+
__Returns:__\n\n [UIAButton|XCUIElementTypeButton]
|
|
2192
1554
|
|
|
2193
|
-
##### [last_button](https://github.com/appium/ruby_lib/blob/
|
|
1555
|
+
--\n\n##### [last_button](https://github.com/appium/ruby_lib/blob/621a9ebaf18bcd80eb0e1f5fc17fbb4dddf5293a/lib/appium_lib/ios/element/button.rb#L43) ios
|
|
2194
1556
|
|
|
2195
1557
|
> def last_button
|
|
2196
1558
|
|
|
@@ -2198,181 +1560,117 @@ TODO: add documentation regarding previous element.
|
|
|
2198
1560
|
Previous UIAElement is differ from UIAButton|XCUIElementTypeButton. So, the results are different.
|
|
2199
1561
|
Find the last UIAButton|XCUIElementTypeButton.
|
|
2200
1562
|
|
|
2201
|
-
__Returns:__
|
|
1563
|
+
__Returns:__\n\n [UIAButton|XCUIElementTypeButton]
|
|
2202
1564
|
|
|
2203
|
-
|
|
2204
|
-
|
|
2205
|
-
--
|
|
2206
|
-
|
|
2207
|
-
##### [button_exact](https://github.com/appium/ruby_lib/blob/c6eb8f5416ccdf75b161bc60c0986caec43d9ff8/lib/appium_lib/ios/element/button.rb#L50) ios
|
|
1565
|
+
--\n\n##### [button_exact](https://github.com/appium/ruby_lib/blob/621a9ebaf18bcd80eb0e1f5fc17fbb4dddf5293a/lib/appium_lib/ios/element/button.rb#L50) ios
|
|
2208
1566
|
|
|
2209
1567
|
> def button_exact(value)
|
|
2210
1568
|
|
|
2211
1569
|
Find the first UIAButton|XCUIElementTypeButton that exactly matches value.
|
|
2212
1570
|
|
|
2213
|
-
__Parameters:__
|
|
2214
|
-
|
|
2215
|
-
[String] value - the value to match exactly
|
|
2216
|
-
|
|
2217
|
-
__Returns:__
|
|
1571
|
+
__Parameters:__\n\n [String] value - the value to match exactly
|
|
2218
1572
|
|
|
2219
|
-
[UIAButton|XCUIElementTypeButton]
|
|
1573
|
+
__Returns:__\n\n [UIAButton|XCUIElementTypeButton]
|
|
2220
1574
|
|
|
2221
|
-
|
|
2222
|
-
|
|
2223
|
-
##### [buttons_exact](https://github.com/appium/ruby_lib/blob/c6eb8f5416ccdf75b161bc60c0986caec43d9ff8/lib/appium_lib/ios/element/button.rb#L57) ios
|
|
1575
|
+
--\n\n##### [buttons_exact](https://github.com/appium/ruby_lib/blob/621a9ebaf18bcd80eb0e1f5fc17fbb4dddf5293a/lib/appium_lib/ios/element/button.rb#L57) ios
|
|
2224
1576
|
|
|
2225
1577
|
> def buttons_exact(value)
|
|
2226
1578
|
|
|
2227
1579
|
Find all UIAButtons|XCUIElementTypeButtons that exactly match value.
|
|
2228
1580
|
|
|
2229
|
-
__Parameters:__
|
|
2230
|
-
|
|
2231
|
-
[String] value - the value to match exactly
|
|
2232
|
-
|
|
2233
|
-
__Returns:__
|
|
2234
|
-
|
|
2235
|
-
[Array<UIAButton|XCUIElementTypeButton>]
|
|
1581
|
+
__Parameters:__\n\n [String] value - the value to match exactly
|
|
2236
1582
|
|
|
2237
|
-
|
|
1583
|
+
__Returns:__\n\n [Array<UIAButton|XCUIElementTypeButton>]
|
|
2238
1584
|
|
|
2239
|
-
##### [find](https://github.com/appium/ruby_lib/blob/
|
|
1585
|
+
--\n\n##### [find](https://github.com/appium/ruby_lib/blob/621a9ebaf18bcd80eb0e1f5fc17fbb4dddf5293a/lib/appium_lib/ios/element/generic.rb#L6) ios
|
|
2240
1586
|
|
|
2241
1587
|
> def find(value)
|
|
2242
1588
|
|
|
2243
1589
|
Find the first element containing value
|
|
2244
1590
|
|
|
2245
|
-
__Parameters:__
|
|
2246
|
-
|
|
2247
|
-
[String] value - the value to search for
|
|
2248
|
-
|
|
2249
|
-
__Returns:__
|
|
2250
|
-
|
|
2251
|
-
[Element]
|
|
1591
|
+
__Parameters:__\n\n [String] value - the value to search for
|
|
2252
1592
|
|
|
2253
|
-
|
|
1593
|
+
__Returns:__\n\n [Element]
|
|
2254
1594
|
|
|
2255
|
-
##### [finds](https://github.com/appium/ruby_lib/blob/
|
|
1595
|
+
--\n\n##### [finds](https://github.com/appium/ruby_lib/blob/621a9ebaf18bcd80eb0e1f5fc17fbb4dddf5293a/lib/appium_lib/ios/element/generic.rb#L13) ios
|
|
2256
1596
|
|
|
2257
1597
|
> def finds(value)
|
|
2258
1598
|
|
|
2259
1599
|
Find all elements containing value
|
|
2260
1600
|
|
|
2261
|
-
__Parameters:__
|
|
1601
|
+
__Parameters:__\n\n [String] value - the value to search for
|
|
2262
1602
|
|
|
2263
|
-
[
|
|
2264
|
-
|
|
2265
|
-
__Returns:__
|
|
2266
|
-
|
|
2267
|
-
[Array<Element>]
|
|
2268
|
-
|
|
2269
|
-
--
|
|
1603
|
+
__Returns:__\n\n [Array<Element>]
|
|
2270
1604
|
|
|
2271
|
-
##### [find_exact](https://github.com/appium/ruby_lib/blob/
|
|
1605
|
+
--\n\n##### [find_exact](https://github.com/appium/ruby_lib/blob/621a9ebaf18bcd80eb0e1f5fc17fbb4dddf5293a/lib/appium_lib/ios/element/generic.rb#L20) ios
|
|
2272
1606
|
|
|
2273
1607
|
> def find_exact(value)
|
|
2274
1608
|
|
|
2275
1609
|
Find the first element exactly matching value
|
|
2276
1610
|
|
|
2277
|
-
__Parameters:__
|
|
2278
|
-
|
|
2279
|
-
[String] value - the value to search for
|
|
2280
|
-
|
|
2281
|
-
__Returns:__
|
|
2282
|
-
|
|
2283
|
-
[Element]
|
|
1611
|
+
__Parameters:__\n\n [String] value - the value to search for
|
|
2284
1612
|
|
|
2285
|
-
|
|
1613
|
+
__Returns:__\n\n [Element]
|
|
2286
1614
|
|
|
2287
|
-
##### [finds_exact](https://github.com/appium/ruby_lib/blob/
|
|
1615
|
+
--\n\n##### [finds_exact](https://github.com/appium/ruby_lib/blob/621a9ebaf18bcd80eb0e1f5fc17fbb4dddf5293a/lib/appium_lib/ios/element/generic.rb#L27) ios
|
|
2288
1616
|
|
|
2289
1617
|
> def finds_exact(value)
|
|
2290
1618
|
|
|
2291
1619
|
Find all elements exactly matching value
|
|
2292
1620
|
|
|
2293
|
-
__Parameters:__
|
|
1621
|
+
__Parameters:__\n\n [String] value - the value to search for
|
|
2294
1622
|
|
|
2295
|
-
[
|
|
2296
|
-
|
|
2297
|
-
__Returns:__
|
|
2298
|
-
|
|
2299
|
-
[Array<Element>]
|
|
2300
|
-
|
|
2301
|
-
--
|
|
1623
|
+
__Returns:__\n\n [Array<Element>]
|
|
2302
1624
|
|
|
2303
|
-
##### [raise_error_if_no_element](https://github.com/appium/ruby_lib/blob/
|
|
1625
|
+
--\n\n##### [raise_error_if_no_element](https://github.com/appium/ruby_lib/blob/621a9ebaf18bcd80eb0e1f5fc17fbb4dddf5293a/lib/appium_lib/ios/element/generic.rb#L33) ios
|
|
2304
1626
|
|
|
2305
1627
|
> def raise_error_if_no_element(element)
|
|
2306
1628
|
|
|
2307
1629
|
|
|
2308
1630
|
|
|
2309
|
-
|
|
2310
|
-
|
|
2311
|
-
##### [select_visible_elements](https://github.com/appium/ruby_lib/blob/c6eb8f5416ccdf75b161bc60c0986caec43d9ff8/lib/appium_lib/ios/element/generic.rb#L41) ios
|
|
1631
|
+
--\n\n##### [select_visible_elements](https://github.com/appium/ruby_lib/blob/621a9ebaf18bcd80eb0e1f5fc17fbb4dddf5293a/lib/appium_lib/ios/element/generic.rb#L41) ios
|
|
2312
1632
|
|
|
2313
1633
|
> def select_visible_elements(elements)
|
|
2314
1634
|
|
|
2315
1635
|
Return visible elements.
|
|
2316
1636
|
|
|
2317
|
-
|
|
2318
|
-
|
|
2319
|
-
##### [for](https://github.com/appium/ruby_lib/blob/c6eb8f5416ccdf75b161bc60c0986caec43d9ff8/lib/appium_lib/ios/xcuitest/bridge.rb#L7) ios
|
|
1637
|
+
--\n\n##### [for](https://github.com/appium/ruby_lib/blob/621a9ebaf18bcd80eb0e1f5fc17fbb4dddf5293a/lib/appium_lib/ios/xcuitest/bridge.rb#L7) ios
|
|
2320
1638
|
|
|
2321
1639
|
> def self.for(target)
|
|
2322
1640
|
|
|
2323
1641
|
|
|
2324
1642
|
|
|
2325
|
-
|
|
2326
|
-
|
|
2327
|
-
##### [last_ele](https://github.com/appium/ruby_lib/blob/c6eb8f5416ccdf75b161bc60c0986caec43d9ff8/lib/appium_lib/ios/xcuitest/helper.rb#L26) ios
|
|
1643
|
+
--\n\n##### [last_ele](https://github.com/appium/ruby_lib/blob/621a9ebaf18bcd80eb0e1f5fc17fbb4dddf5293a/lib/appium_lib/ios/xcuitest/helper.rb#L26) ios
|
|
2328
1644
|
|
|
2329
1645
|
> def last_ele(class_name)
|
|
2330
1646
|
|
|
2331
1647
|
Get the last tag that matches class_name
|
|
2332
1648
|
|
|
2333
|
-
__Parameters:__
|
|
2334
|
-
|
|
2335
|
-
[String] class_name - the tag to match
|
|
1649
|
+
__Parameters:__\n\n [String] class_name - the tag to match
|
|
2336
1650
|
|
|
2337
|
-
__Returns:__
|
|
1651
|
+
__Returns:__\n\n [Element]
|
|
2338
1652
|
|
|
2339
|
-
|
|
2340
|
-
|
|
2341
|
-
--
|
|
2342
|
-
|
|
2343
|
-
##### [tag](https://github.com/appium/ruby_lib/blob/c6eb8f5416ccdf75b161bc60c0986caec43d9ff8/lib/appium_lib/ios/xcuitest/helper.rb#L37) ios
|
|
1653
|
+
--\n\n##### [tag](https://github.com/appium/ruby_lib/blob/621a9ebaf18bcd80eb0e1f5fc17fbb4dddf5293a/lib/appium_lib/ios/xcuitest/helper.rb#L37) ios
|
|
2344
1654
|
|
|
2345
1655
|
> def tag(class_name)
|
|
2346
1656
|
|
|
2347
1657
|
Returns the first **visible** element matching class_name
|
|
2348
1658
|
|
|
2349
|
-
__Parameters:__
|
|
2350
|
-
|
|
2351
|
-
[String] class_name - the class_name to search for
|
|
2352
|
-
|
|
2353
|
-
__Returns:__
|
|
2354
|
-
|
|
2355
|
-
[Element]
|
|
1659
|
+
__Parameters:__\n\n [String] class_name - the class_name to search for
|
|
2356
1660
|
|
|
2357
|
-
|
|
1661
|
+
__Returns:__\n\n [Element]
|
|
2358
1662
|
|
|
2359
|
-
##### [tags](https://github.com/appium/ruby_lib/blob/
|
|
1663
|
+
--\n\n##### [tags](https://github.com/appium/ruby_lib/blob/621a9ebaf18bcd80eb0e1f5fc17fbb4dddf5293a/lib/appium_lib/ios/xcuitest/helper.rb#L45) ios
|
|
2360
1664
|
|
|
2361
1665
|
> def tags(class_name)
|
|
2362
1666
|
|
|
2363
1667
|
Returns all visible elements matching class_name
|
|
2364
1668
|
|
|
2365
|
-
__Parameters:__
|
|
1669
|
+
__Parameters:__\n\n [String] class_name - the class_name to search for
|
|
2366
1670
|
|
|
2367
|
-
[
|
|
1671
|
+
__Returns:__\n\n [Element]
|
|
2368
1672
|
|
|
2369
|
-
|
|
2370
|
-
|
|
2371
|
-
[Element]
|
|
2372
|
-
|
|
2373
|
-
--
|
|
2374
|
-
|
|
2375
|
-
##### [tags_include](https://github.com/appium/ruby_lib/blob/c6eb8f5416ccdf75b161bc60c0986caec43d9ff8/lib/appium_lib/ios/xcuitest/helper.rb#L57) ios
|
|
1673
|
+
--\n\n##### [tags_include](https://github.com/appium/ruby_lib/blob/621a9ebaf18bcd80eb0e1f5fc17fbb4dddf5293a/lib/appium_lib/ios/xcuitest/helper.rb#L57) ios
|
|
2376
1674
|
|
|
2377
1675
|
> def tags_include(class_names:, value: nil)
|
|
2378
1676
|
|
|
@@ -2380,19 +1678,13 @@ Returns all visible elements matching class_names and value
|
|
|
2380
1678
|
This method calls find_element/s and element.value/text many times.
|
|
2381
1679
|
So, if you set many class_names, this method's performance become worse.
|
|
2382
1680
|
|
|
2383
|
-
__Parameters:__
|
|
2384
|
-
|
|
2385
|
-
[Array[String]] class_names - the class_names to search for
|
|
1681
|
+
__Parameters:__\n\n [Array[String]] class_names - the class_names to search for
|
|
2386
1682
|
|
|
2387
1683
|
[String] value - the value to search for
|
|
2388
1684
|
|
|
2389
|
-
__Returns:__
|
|
1685
|
+
__Returns:__\n\n [Array[Element]]
|
|
2390
1686
|
|
|
2391
|
-
|
|
2392
|
-
|
|
2393
|
-
--
|
|
2394
|
-
|
|
2395
|
-
##### [tags_exact](https://github.com/appium/ruby_lib/blob/c6eb8f5416ccdf75b161bc60c0986caec43d9ff8/lib/appium_lib/ios/xcuitest/helper.rb#L79) ios
|
|
1687
|
+
--\n\n##### [tags_exact](https://github.com/appium/ruby_lib/blob/621a9ebaf18bcd80eb0e1f5fc17fbb4dddf5293a/lib/appium_lib/ios/xcuitest/helper.rb#L79) ios
|
|
2396
1688
|
|
|
2397
1689
|
> def tags_exact(class_names:, value: nil)
|
|
2398
1690
|
|
|
@@ -2400,95 +1692,67 @@ Returns all visible elements matching class_names and value.
|
|
|
2400
1692
|
This method calls find_element/s and element.value/text many times.
|
|
2401
1693
|
So, if you set many class_names, this method's performance become worse.
|
|
2402
1694
|
|
|
2403
|
-
__Parameters:__
|
|
2404
|
-
|
|
2405
|
-
[Array[String]] class_names - the class_names to search for
|
|
1695
|
+
__Parameters:__\n\n [Array[String]] class_names - the class_names to search for
|
|
2406
1696
|
|
|
2407
1697
|
[String] value - the value to search for
|
|
2408
1698
|
|
|
2409
|
-
__Returns:__
|
|
2410
|
-
|
|
2411
|
-
[Array[Element]]
|
|
1699
|
+
__Returns:__\n\n [Array[Element]]
|
|
2412
1700
|
|
|
2413
|
-
|
|
2414
|
-
|
|
2415
|
-
##### [start_logs_broadcast](https://github.com/appium/ruby_lib/blob/c6eb8f5416ccdf75b161bc60c0986caec43d9ff8/lib/appium_lib/ios/xcuitest/command.rb#L19) ios
|
|
1701
|
+
--\n\n##### [start_logs_broadcast](https://github.com/appium/ruby_lib/blob/621a9ebaf18bcd80eb0e1f5fc17fbb4dddf5293a/lib/appium_lib/ios/xcuitest/command.rb#L19) ios
|
|
2416
1702
|
|
|
2417
1703
|
> def start_logs_broadcast(syslog_file = 'syslog.log')
|
|
2418
1704
|
|
|
2419
1705
|
Starts iOS syslog broadcast websocket
|
|
2420
1706
|
|
|
2421
|
-
__Parameters:__
|
|
2422
|
-
|
|
2423
|
-
[String] syslog_file - A file path to write messages from a syslog WebSocket client
|
|
1707
|
+
__Parameters:__\n\n [String] syslog_file - A file path to write messages from a syslog WebSocket client
|
|
2424
1708
|
|
|
2425
|
-
|
|
2426
|
-
|
|
2427
|
-
##### [stop_logs_broadcast](https://github.com/appium/ruby_lib/blob/c6eb8f5416ccdf75b161bc60c0986caec43d9ff8/lib/appium_lib/ios/xcuitest/command.rb#L32) ios
|
|
1709
|
+
--\n\n##### [stop_logs_broadcast](https://github.com/appium/ruby_lib/blob/621a9ebaf18bcd80eb0e1f5fc17fbb4dddf5293a/lib/appium_lib/ios/xcuitest/command.rb#L32) ios
|
|
2428
1710
|
|
|
2429
1711
|
> def stop_logs_broadcast
|
|
2430
1712
|
|
|
2431
1713
|
Stop iOS syslog broadcast websocket
|
|
2432
1714
|
|
|
2433
|
-
|
|
2434
|
-
|
|
2435
|
-
##### [UIATextField](https://github.com/appium/ruby_lib/blob/c6eb8f5416ccdf75b161bc60c0986caec43d9ff8/lib/appium_lib/ios/element/textfield.rb#L3) ios
|
|
1715
|
+
--\n\n##### [UIATextField](https://github.com/appium/ruby_lib/blob/621a9ebaf18bcd80eb0e1f5fc17fbb4dddf5293a/lib/appium_lib/ios/element/textfield.rb#L3) ios
|
|
2436
1716
|
|
|
2437
1717
|
> UIATextField = 'UIATextField'.freeze
|
|
2438
1718
|
|
|
2439
1719
|
|
|
2440
1720
|
|
|
2441
|
-
|
|
2442
|
-
|
|
2443
|
-
##### [UIASecureTextField](https://github.com/appium/ruby_lib/blob/c6eb8f5416ccdf75b161bc60c0986caec43d9ff8/lib/appium_lib/ios/element/textfield.rb#L4) ios
|
|
1721
|
+
--\n\n##### [UIASecureTextField](https://github.com/appium/ruby_lib/blob/621a9ebaf18bcd80eb0e1f5fc17fbb4dddf5293a/lib/appium_lib/ios/element/textfield.rb#L4) ios
|
|
2444
1722
|
|
|
2445
1723
|
> UIASecureTextField = 'UIASecureTextField'.freeze
|
|
2446
1724
|
|
|
2447
1725
|
|
|
2448
1726
|
|
|
2449
|
-
|
|
2450
|
-
|
|
2451
|
-
##### [XCUIElementTypeTextField](https://github.com/appium/ruby_lib/blob/c6eb8f5416ccdf75b161bc60c0986caec43d9ff8/lib/appium_lib/ios/element/textfield.rb#L6) ios
|
|
1727
|
+
--\n\n##### [XCUIElementTypeTextField](https://github.com/appium/ruby_lib/blob/621a9ebaf18bcd80eb0e1f5fc17fbb4dddf5293a/lib/appium_lib/ios/element/textfield.rb#L6) ios
|
|
2452
1728
|
|
|
2453
1729
|
> XCUIElementTypeTextField = 'XCUIElementTypeTextField'.freeze
|
|
2454
1730
|
|
|
2455
1731
|
|
|
2456
1732
|
|
|
2457
|
-
|
|
2458
|
-
|
|
2459
|
-
##### [XCUIElementTypeSecureTextField](https://github.com/appium/ruby_lib/blob/c6eb8f5416ccdf75b161bc60c0986caec43d9ff8/lib/appium_lib/ios/element/textfield.rb#L7) ios
|
|
1733
|
+
--\n\n##### [XCUIElementTypeSecureTextField](https://github.com/appium/ruby_lib/blob/621a9ebaf18bcd80eb0e1f5fc17fbb4dddf5293a/lib/appium_lib/ios/element/textfield.rb#L7) ios
|
|
2460
1734
|
|
|
2461
1735
|
> XCUIElementTypeSecureTextField = 'XCUIElementTypeSecureTextField'.freeze
|
|
2462
1736
|
|
|
2463
1737
|
|
|
2464
1738
|
|
|
2465
|
-
|
|
2466
|
-
|
|
2467
|
-
##### [text_field_class](https://github.com/appium/ruby_lib/blob/c6eb8f5416ccdf75b161bc60c0986caec43d9ff8/lib/appium_lib/ios/element/textfield.rb#L10) ios
|
|
1739
|
+
--\n\n##### [text_field_class](https://github.com/appium/ruby_lib/blob/621a9ebaf18bcd80eb0e1f5fc17fbb4dddf5293a/lib/appium_lib/ios/element/textfield.rb#L10) ios
|
|
2468
1740
|
|
|
2469
1741
|
> def text_field_class
|
|
2470
1742
|
|
|
2471
1743
|
|
|
2472
1744
|
|
|
2473
|
-
__Returns:__
|
|
1745
|
+
__Returns:__\n\n [String] Class name for text field
|
|
2474
1746
|
|
|
2475
|
-
|
|
2476
|
-
|
|
2477
|
-
--
|
|
2478
|
-
|
|
2479
|
-
##### [secure_text_field_class](https://github.com/appium/ruby_lib/blob/c6eb8f5416ccdf75b161bc60c0986caec43d9ff8/lib/appium_lib/ios/element/textfield.rb#L15) ios
|
|
1747
|
+
--\n\n##### [secure_text_field_class](https://github.com/appium/ruby_lib/blob/621a9ebaf18bcd80eb0e1f5fc17fbb4dddf5293a/lib/appium_lib/ios/element/textfield.rb#L15) ios
|
|
2480
1748
|
|
|
2481
1749
|
> def secure_text_field_class
|
|
2482
1750
|
|
|
2483
1751
|
|
|
2484
1752
|
|
|
2485
|
-
__Returns:__
|
|
2486
|
-
|
|
2487
|
-
[String] Class name for secure text field
|
|
2488
|
-
|
|
2489
|
-
--
|
|
1753
|
+
__Returns:__\n\n [String] Class name for secure text field
|
|
2490
1754
|
|
|
2491
|
-
##### [textfield](https://github.com/appium/ruby_lib/blob/
|
|
1755
|
+
--\n\n##### [textfield](https://github.com/appium/ruby_lib/blob/621a9ebaf18bcd80eb0e1f5fc17fbb4dddf5293a/lib/appium_lib/ios/element/textfield.rb#L24) ios
|
|
2492
1756
|
|
|
2493
1757
|
> def textfield(value)
|
|
2494
1758
|
|
|
@@ -2496,288 +1760,190 @@ Find the first TextField that contains value or by index.
|
|
|
2496
1760
|
Note: Uses XPath
|
|
2497
1761
|
If int then the TextField at that index is returned.
|
|
2498
1762
|
|
|
2499
|
-
__Parameters:__
|
|
1763
|
+
__Parameters:__\n\n [String, Integer] value - the text to match exactly.
|
|
2500
1764
|
|
|
2501
|
-
[
|
|
1765
|
+
__Returns:__\n\n [TextField]
|
|
2502
1766
|
|
|
2503
|
-
|
|
2504
|
-
|
|
2505
|
-
[TextField]
|
|
2506
|
-
|
|
2507
|
-
--
|
|
2508
|
-
|
|
2509
|
-
##### [textfields](https://github.com/appium/ruby_lib/blob/c6eb8f5416ccdf75b161bc60c0986caec43d9ff8/lib/appium_lib/ios/element/textfield.rb#L43) ios
|
|
1767
|
+
--\n\n##### [textfields](https://github.com/appium/ruby_lib/blob/621a9ebaf18bcd80eb0e1f5fc17fbb4dddf5293a/lib/appium_lib/ios/element/textfield.rb#L43) ios
|
|
2510
1768
|
|
|
2511
1769
|
> def textfields(value = false)
|
|
2512
1770
|
|
|
2513
1771
|
Find all TextFields containing value.
|
|
2514
1772
|
If value is omitted, all TextFields are returned.
|
|
2515
1773
|
|
|
2516
|
-
__Parameters:__
|
|
2517
|
-
|
|
2518
|
-
[String] value - the value to search for
|
|
2519
|
-
|
|
2520
|
-
__Returns:__
|
|
1774
|
+
__Parameters:__\n\n [String] value - the value to search for
|
|
2521
1775
|
|
|
2522
|
-
[Array<TextField>]
|
|
1776
|
+
__Returns:__\n\n [Array<TextField>]
|
|
2523
1777
|
|
|
2524
|
-
|
|
2525
|
-
|
|
2526
|
-
##### [first_textfield](https://github.com/appium/ruby_lib/blob/c6eb8f5416ccdf75b161bc60c0986caec43d9ff8/lib/appium_lib/ios/element/textfield.rb#L51) ios
|
|
1778
|
+
--\n\n##### [first_textfield](https://github.com/appium/ruby_lib/blob/621a9ebaf18bcd80eb0e1f5fc17fbb4dddf5293a/lib/appium_lib/ios/element/textfield.rb#L51) ios
|
|
2527
1779
|
|
|
2528
1780
|
> def first_textfield
|
|
2529
1781
|
|
|
2530
1782
|
Find the first TextField.
|
|
2531
1783
|
|
|
2532
|
-
__Returns:__
|
|
2533
|
-
|
|
2534
|
-
[TextField]
|
|
1784
|
+
__Returns:__\n\n [TextField]
|
|
2535
1785
|
|
|
2536
|
-
|
|
2537
|
-
|
|
2538
|
-
##### [last_textfield](https://github.com/appium/ruby_lib/blob/c6eb8f5416ccdf75b161bc60c0986caec43d9ff8/lib/appium_lib/ios/element/textfield.rb#L57) ios
|
|
1786
|
+
--\n\n##### [last_textfield](https://github.com/appium/ruby_lib/blob/621a9ebaf18bcd80eb0e1f5fc17fbb4dddf5293a/lib/appium_lib/ios/element/textfield.rb#L57) ios
|
|
2539
1787
|
|
|
2540
1788
|
> def last_textfield
|
|
2541
1789
|
|
|
2542
1790
|
Find the last TextField.
|
|
2543
1791
|
|
|
2544
|
-
__Returns:__
|
|
2545
|
-
|
|
2546
|
-
[TextField]
|
|
2547
|
-
|
|
2548
|
-
--
|
|
1792
|
+
__Returns:__\n\n [TextField]
|
|
2549
1793
|
|
|
2550
|
-
##### [textfield_exact](https://github.com/appium/ruby_lib/blob/
|
|
1794
|
+
--\n\n##### [textfield_exact](https://github.com/appium/ruby_lib/blob/621a9ebaf18bcd80eb0e1f5fc17fbb4dddf5293a/lib/appium_lib/ios/element/textfield.rb#L67) ios
|
|
2551
1795
|
|
|
2552
1796
|
> def textfield_exact(value)
|
|
2553
1797
|
|
|
2554
1798
|
Find the first TextField that exactly matches value.
|
|
2555
1799
|
|
|
2556
|
-
__Parameters:__
|
|
2557
|
-
|
|
2558
|
-
[String] value - the value to match exactly
|
|
2559
|
-
|
|
2560
|
-
__Returns:__
|
|
1800
|
+
__Parameters:__\n\n [String] value - the value to match exactly
|
|
2561
1801
|
|
|
2562
|
-
[TextField]
|
|
1802
|
+
__Returns:__\n\n [TextField]
|
|
2563
1803
|
|
|
2564
|
-
|
|
2565
|
-
|
|
2566
|
-
##### [textfields_exact](https://github.com/appium/ruby_lib/blob/c6eb8f5416ccdf75b161bc60c0986caec43d9ff8/lib/appium_lib/ios/element/textfield.rb#L74) ios
|
|
1804
|
+
--\n\n##### [textfields_exact](https://github.com/appium/ruby_lib/blob/621a9ebaf18bcd80eb0e1f5fc17fbb4dddf5293a/lib/appium_lib/ios/element/textfield.rb#L74) ios
|
|
2567
1805
|
|
|
2568
1806
|
> def textfields_exact(value)
|
|
2569
1807
|
|
|
2570
1808
|
Find all TextFields that exactly match value.
|
|
2571
1809
|
|
|
2572
|
-
__Parameters:__
|
|
2573
|
-
|
|
2574
|
-
[String] value - the value to match exactly
|
|
2575
|
-
|
|
2576
|
-
__Returns:__
|
|
2577
|
-
|
|
2578
|
-
[Array<TextField>]
|
|
1810
|
+
__Parameters:__\n\n [String] value - the value to match exactly
|
|
2579
1811
|
|
|
2580
|
-
|
|
1812
|
+
__Returns:__\n\n [Array<TextField>]
|
|
2581
1813
|
|
|
2582
|
-
##### [_textfield_visible](https://github.com/appium/ruby_lib/blob/
|
|
1814
|
+
--\n\n##### [_textfield_visible](https://github.com/appium/ruby_lib/blob/621a9ebaf18bcd80eb0e1f5fc17fbb4dddf5293a/lib/appium_lib/ios/element/textfield.rb#L81) ios
|
|
2583
1815
|
|
|
2584
1816
|
> def _textfield_visible
|
|
2585
1817
|
|
|
2586
1818
|
Appium
|
|
2587
1819
|
|
|
2588
|
-
|
|
2589
|
-
|
|
2590
|
-
##### [_textfield_exact_string](https://github.com/appium/ruby_lib/blob/c6eb8f5416ccdf75b161bc60c0986caec43d9ff8/lib/appium_lib/ios/element/textfield.rb#L86) ios
|
|
1820
|
+
--\n\n##### [_textfield_exact_string](https://github.com/appium/ruby_lib/blob/621a9ebaf18bcd80eb0e1f5fc17fbb4dddf5293a/lib/appium_lib/ios/element/textfield.rb#L86) ios
|
|
2591
1821
|
|
|
2592
1822
|
> def _textfield_exact_string(value)
|
|
2593
1823
|
|
|
2594
1824
|
Appium
|
|
2595
1825
|
|
|
2596
|
-
|
|
2597
|
-
|
|
2598
|
-
##### [_textfield_contains_string](https://github.com/appium/ruby_lib/blob/c6eb8f5416ccdf75b161bc60c0986caec43d9ff8/lib/appium_lib/ios/element/textfield.rb#L93) ios
|
|
1826
|
+
--\n\n##### [_textfield_contains_string](https://github.com/appium/ruby_lib/blob/621a9ebaf18bcd80eb0e1f5fc17fbb4dddf5293a/lib/appium_lib/ios/element/textfield.rb#L93) ios
|
|
2599
1827
|
|
|
2600
1828
|
> def _textfield_contains_string(value)
|
|
2601
1829
|
|
|
2602
1830
|
Appium
|
|
2603
1831
|
|
|
2604
|
-
|
|
2605
|
-
|
|
2606
|
-
##### [static_text_class](https://github.com/appium/ruby_lib/blob/c6eb8f5416ccdf75b161bc60c0986caec43d9ff8/lib/appium_lib/ios/xcuitest/element/text.rb#L9) ios
|
|
1832
|
+
--\n\n##### [static_text_class](https://github.com/appium/ruby_lib/blob/621a9ebaf18bcd80eb0e1f5fc17fbb4dddf5293a/lib/appium_lib/ios/xcuitest/element/text.rb#L9) ios
|
|
2607
1833
|
|
|
2608
1834
|
> def static_text_class
|
|
2609
1835
|
|
|
2610
1836
|
|
|
2611
1837
|
|
|
2612
|
-
__Returns:__
|
|
2613
|
-
|
|
2614
|
-
[String] Class name for text
|
|
1838
|
+
__Returns:__\n\n [String] Class name for text
|
|
2615
1839
|
|
|
2616
|
-
|
|
2617
|
-
|
|
2618
|
-
##### [text](https://github.com/appium/ruby_lib/blob/c6eb8f5416ccdf75b161bc60c0986caec43d9ff8/lib/appium_lib/ios/xcuitest/element/text.rb#L17) ios
|
|
1840
|
+
--\n\n##### [text](https://github.com/appium/ruby_lib/blob/621a9ebaf18bcd80eb0e1f5fc17fbb4dddf5293a/lib/appium_lib/ios/xcuitest/element/text.rb#L17) ios
|
|
2619
1841
|
|
|
2620
1842
|
> def text(value)
|
|
2621
1843
|
|
|
2622
1844
|
Find the first UIAStaticText|XCUIElementTypeStaticText that contains value or by index.
|
|
2623
1845
|
If int then the UIAStaticText|XCUIElementTypeStaticText at that index is returned.
|
|
2624
1846
|
|
|
2625
|
-
__Parameters:__
|
|
2626
|
-
|
|
2627
|
-
[String, Integer] value - the value to find.
|
|
2628
|
-
|
|
2629
|
-
__Returns:__
|
|
2630
|
-
|
|
2631
|
-
[UIAStaticText|XCUIElementTypeStaticText]
|
|
1847
|
+
__Parameters:__\n\n [String, Integer] value - the value to find.
|
|
2632
1848
|
|
|
2633
|
-
|
|
1849
|
+
__Returns:__\n\n [UIAStaticText|XCUIElementTypeStaticText]
|
|
2634
1850
|
|
|
2635
|
-
##### [texts](https://github.com/appium/ruby_lib/blob/
|
|
1851
|
+
--\n\n##### [texts](https://github.com/appium/ruby_lib/blob/621a9ebaf18bcd80eb0e1f5fc17fbb4dddf5293a/lib/appium_lib/ios/xcuitest/element/text.rb#L27) ios
|
|
2636
1852
|
|
|
2637
1853
|
> def texts(value = false)
|
|
2638
1854
|
|
|
2639
1855
|
Find all UIAStaticTexts|XCUIElementTypeStaticTexts containing value.
|
|
2640
1856
|
If value is omitted, all UIAStaticTexts|XCUIElementTypeStaticTexts are returned
|
|
2641
1857
|
|
|
2642
|
-
__Parameters:__
|
|
1858
|
+
__Parameters:__\n\n [String] value - the value to search for
|
|
2643
1859
|
|
|
2644
|
-
[
|
|
2645
|
-
|
|
2646
|
-
__Returns:__
|
|
2647
|
-
|
|
2648
|
-
[Array<UIAStaticText|XCUIElementTypeStaticText>]
|
|
2649
|
-
|
|
2650
|
-
--
|
|
1860
|
+
__Returns:__\n\n [Array<UIAStaticText|XCUIElementTypeStaticText>]
|
|
2651
1861
|
|
|
2652
|
-
##### [first_text](https://github.com/appium/ruby_lib/blob/
|
|
1862
|
+
--\n\n##### [first_text](https://github.com/appium/ruby_lib/blob/621a9ebaf18bcd80eb0e1f5fc17fbb4dddf5293a/lib/appium_lib/ios/xcuitest/element/text.rb#L36) ios
|
|
2653
1863
|
|
|
2654
1864
|
> def first_text
|
|
2655
1865
|
|
|
2656
1866
|
Find the first UIAStaticText|XCUIElementTypeStaticText.
|
|
2657
1867
|
|
|
2658
|
-
__Returns:__
|
|
1868
|
+
__Returns:__\n\n [UIAStaticText|XCUIElementTypeStaticText]
|
|
2659
1869
|
|
|
2660
|
-
|
|
2661
|
-
|
|
2662
|
-
--
|
|
2663
|
-
|
|
2664
|
-
##### [last_text](https://github.com/appium/ruby_lib/blob/c6eb8f5416ccdf75b161bc60c0986caec43d9ff8/lib/appium_lib/ios/xcuitest/element/text.rb#L42) ios
|
|
1870
|
+
--\n\n##### [last_text](https://github.com/appium/ruby_lib/blob/621a9ebaf18bcd80eb0e1f5fc17fbb4dddf5293a/lib/appium_lib/ios/xcuitest/element/text.rb#L42) ios
|
|
2665
1871
|
|
|
2666
1872
|
> def last_text
|
|
2667
1873
|
|
|
2668
1874
|
Find the last UIAStaticText|XCUIElementTypeStaticText.
|
|
2669
1875
|
|
|
2670
|
-
__Returns:__
|
|
2671
|
-
|
|
2672
|
-
[UIAStaticText|XCUIElementTypeStaticText]
|
|
2673
|
-
|
|
2674
|
-
--
|
|
1876
|
+
__Returns:__\n\n [UIAStaticText|XCUIElementTypeStaticText]
|
|
2675
1877
|
|
|
2676
|
-
##### [text_exact](https://github.com/appium/ruby_lib/blob/
|
|
1878
|
+
--\n\n##### [text_exact](https://github.com/appium/ruby_lib/blob/621a9ebaf18bcd80eb0e1f5fc17fbb4dddf5293a/lib/appium_lib/ios/xcuitest/element/text.rb#L49) ios
|
|
2677
1879
|
|
|
2678
1880
|
> def text_exact(value)
|
|
2679
1881
|
|
|
2680
1882
|
Find the first UIAStaticText|XCUIElementTypeStaticText that exactly matches value.
|
|
2681
1883
|
|
|
2682
|
-
__Parameters:__
|
|
1884
|
+
__Parameters:__\n\n [String] value - the value to match exactly
|
|
2683
1885
|
|
|
2684
|
-
[
|
|
1886
|
+
__Returns:__\n\n [UIAStaticText|XCUIElementTypeStaticText]
|
|
2685
1887
|
|
|
2686
|
-
|
|
2687
|
-
|
|
2688
|
-
[UIAStaticText|XCUIElementTypeStaticText]
|
|
2689
|
-
|
|
2690
|
-
--
|
|
2691
|
-
|
|
2692
|
-
##### [texts_exact](https://github.com/appium/ruby_lib/blob/c6eb8f5416ccdf75b161bc60c0986caec43d9ff8/lib/appium_lib/ios/xcuitest/element/text.rb#L56) ios
|
|
1888
|
+
--\n\n##### [texts_exact](https://github.com/appium/ruby_lib/blob/621a9ebaf18bcd80eb0e1f5fc17fbb4dddf5293a/lib/appium_lib/ios/xcuitest/element/text.rb#L56) ios
|
|
2693
1889
|
|
|
2694
1890
|
> def texts_exact(value)
|
|
2695
1891
|
|
|
2696
1892
|
Find all UIAStaticTexts|XCUIElementTypeStaticTexts that exactly match value.
|
|
2697
1893
|
|
|
2698
|
-
__Parameters:__
|
|
2699
|
-
|
|
2700
|
-
[String] value - the value to match exactly
|
|
1894
|
+
__Parameters:__\n\n [String] value - the value to match exactly
|
|
2701
1895
|
|
|
2702
|
-
__Returns:__
|
|
1896
|
+
__Returns:__\n\n [Array<UIAStaticText|XCUIElementTypeStaticText>]
|
|
2703
1897
|
|
|
2704
|
-
|
|
2705
|
-
|
|
2706
|
-
--
|
|
2707
|
-
|
|
2708
|
-
##### [xcuitest_source](https://github.com/appium/ruby_lib/blob/c6eb8f5416ccdf75b161bc60c0986caec43d9ff8/lib/appium_lib/ios/xcuitest/command/source.rb#L12) ios
|
|
1898
|
+
--\n\n##### [xcuitest_source](https://github.com/appium/ruby_lib/blob/621a9ebaf18bcd80eb0e1f5fc17fbb4dddf5293a/lib/appium_lib/ios/xcuitest/command/source.rb#L12) ios
|
|
2709
1899
|
|
|
2710
1900
|
> def xcuitest_source(format: :xml)
|
|
2711
1901
|
|
|
2712
1902
|
|
|
2713
1903
|
|
|
2714
|
-
__Parameters:__
|
|
2715
|
-
|
|
2716
|
-
[String|Symbol] format - :xml or :json. :xml is by default.
|
|
1904
|
+
__Parameters:__\n\n [String|Symbol] format - :xml or :json. :xml is by default.
|
|
2717
1905
|
|
|
2718
1906
|
[Hash] opts - a customizable set of options
|
|
2719
1907
|
|
|
2720
|
-
|
|
2721
|
-
|
|
2722
|
-
##### [button_class](https://github.com/appium/ruby_lib/blob/c6eb8f5416ccdf75b161bc60c0986caec43d9ff8/lib/appium_lib/ios/xcuitest/element/button.rb#L9) ios
|
|
1908
|
+
--\n\n##### [button_class](https://github.com/appium/ruby_lib/blob/621a9ebaf18bcd80eb0e1f5fc17fbb4dddf5293a/lib/appium_lib/ios/xcuitest/element/button.rb#L9) ios
|
|
2723
1909
|
|
|
2724
1910
|
> def button_class
|
|
2725
1911
|
|
|
2726
1912
|
|
|
2727
1913
|
|
|
2728
|
-
__Returns:__
|
|
1914
|
+
__Returns:__\n\n [String] Class name for button
|
|
2729
1915
|
|
|
2730
|
-
|
|
2731
|
-
|
|
2732
|
-
--
|
|
2733
|
-
|
|
2734
|
-
##### [button](https://github.com/appium/ruby_lib/blob/c6eb8f5416ccdf75b161bc60c0986caec43d9ff8/lib/appium_lib/ios/xcuitest/element/button.rb#L17) ios
|
|
1916
|
+
--\n\n##### [button](https://github.com/appium/ruby_lib/blob/621a9ebaf18bcd80eb0e1f5fc17fbb4dddf5293a/lib/appium_lib/ios/xcuitest/element/button.rb#L17) ios
|
|
2735
1917
|
|
|
2736
1918
|
> def button(value)
|
|
2737
1919
|
|
|
2738
1920
|
Find the first UIAButton|XCUIElementTypeButton that contains value or by index.
|
|
2739
1921
|
If int then the UIAButton|XCUIElementTypeButton at that index is returned.
|
|
2740
1922
|
|
|
2741
|
-
__Parameters:__
|
|
2742
|
-
|
|
2743
|
-
[String, Integer] value - the value to exactly match.
|
|
2744
|
-
|
|
2745
|
-
__Returns:__
|
|
2746
|
-
|
|
2747
|
-
[UIAButton|XCUIElementTypeButton]
|
|
1923
|
+
__Parameters:__\n\n [String, Integer] value - the value to exactly match.
|
|
2748
1924
|
|
|
2749
|
-
|
|
1925
|
+
__Returns:__\n\n [UIAButton|XCUIElementTypeButton]
|
|
2750
1926
|
|
|
2751
|
-
##### [buttons](https://github.com/appium/ruby_lib/blob/
|
|
1927
|
+
--\n\n##### [buttons](https://github.com/appium/ruby_lib/blob/621a9ebaf18bcd80eb0e1f5fc17fbb4dddf5293a/lib/appium_lib/ios/xcuitest/element/button.rb#L28) ios
|
|
2752
1928
|
|
|
2753
1929
|
> def buttons(value = false)
|
|
2754
1930
|
|
|
2755
1931
|
Find all UIAButtons|XCUIElementTypeButtons containing value.
|
|
2756
1932
|
If value is omitted, all UIAButtons|XCUIElementTypeButtons are returned.
|
|
2757
1933
|
|
|
2758
|
-
__Parameters:__
|
|
2759
|
-
|
|
2760
|
-
[String] value - the value to search for
|
|
2761
|
-
|
|
2762
|
-
__Returns:__
|
|
2763
|
-
|
|
2764
|
-
[Array<UIAButton|XCUIElementTypeButton>]
|
|
1934
|
+
__Parameters:__\n\n [String] value - the value to search for
|
|
2765
1935
|
|
|
2766
|
-
|
|
1936
|
+
__Returns:__\n\n [Array<UIAButton|XCUIElementTypeButton>]
|
|
2767
1937
|
|
|
2768
|
-
##### [first_button](https://github.com/appium/ruby_lib/blob/
|
|
1938
|
+
--\n\n##### [first_button](https://github.com/appium/ruby_lib/blob/621a9ebaf18bcd80eb0e1f5fc17fbb4dddf5293a/lib/appium_lib/ios/xcuitest/element/button.rb#L37) ios
|
|
2769
1939
|
|
|
2770
1940
|
> def first_button
|
|
2771
1941
|
|
|
2772
1942
|
Find the first UIAButton|XCUIElementTypeButton.
|
|
2773
1943
|
|
|
2774
|
-
__Returns:__
|
|
1944
|
+
__Returns:__\n\n [UIAButton|XCUIElementTypeButton]
|
|
2775
1945
|
|
|
2776
|
-
|
|
2777
|
-
|
|
2778
|
-
--
|
|
2779
|
-
|
|
2780
|
-
##### [last_button](https://github.com/appium/ruby_lib/blob/c6eb8f5416ccdf75b161bc60c0986caec43d9ff8/lib/appium_lib/ios/xcuitest/element/button.rb#L45) ios
|
|
1946
|
+
--\n\n##### [last_button](https://github.com/appium/ruby_lib/blob/621a9ebaf18bcd80eb0e1f5fc17fbb4dddf5293a/lib/appium_lib/ios/xcuitest/element/button.rb#L45) ios
|
|
2781
1947
|
|
|
2782
1948
|
> def last_button
|
|
2783
1949
|
|
|
@@ -2785,193 +1951,131 @@ TODO: add documentation regarding previous element.
|
|
|
2785
1951
|
Previous UIAElement is differ from UIAButton|XCUIElementTypeButton. So, the results are different.
|
|
2786
1952
|
Find the last UIAButton|XCUIElementTypeButton.
|
|
2787
1953
|
|
|
2788
|
-
__Returns:__
|
|
2789
|
-
|
|
2790
|
-
[UIAButton|XCUIElementTypeButton]
|
|
2791
|
-
|
|
2792
|
-
--
|
|
1954
|
+
__Returns:__\n\n [UIAButton|XCUIElementTypeButton]
|
|
2793
1955
|
|
|
2794
|
-
##### [button_exact](https://github.com/appium/ruby_lib/blob/
|
|
1956
|
+
--\n\n##### [button_exact](https://github.com/appium/ruby_lib/blob/621a9ebaf18bcd80eb0e1f5fc17fbb4dddf5293a/lib/appium_lib/ios/xcuitest/element/button.rb#L52) ios
|
|
2795
1957
|
|
|
2796
1958
|
> def button_exact(value)
|
|
2797
1959
|
|
|
2798
1960
|
Find the first UIAButton|XCUIElementTypeButton that exactly matches value.
|
|
2799
1961
|
|
|
2800
|
-
__Parameters:__
|
|
1962
|
+
__Parameters:__\n\n [String] value - the value to match exactly
|
|
2801
1963
|
|
|
2802
|
-
[
|
|
1964
|
+
__Returns:__\n\n [UIAButton|XCUIElementTypeButton]
|
|
2803
1965
|
|
|
2804
|
-
|
|
2805
|
-
|
|
2806
|
-
[UIAButton|XCUIElementTypeButton]
|
|
2807
|
-
|
|
2808
|
-
--
|
|
2809
|
-
|
|
2810
|
-
##### [buttons_exact](https://github.com/appium/ruby_lib/blob/c6eb8f5416ccdf75b161bc60c0986caec43d9ff8/lib/appium_lib/ios/xcuitest/element/button.rb#L59) ios
|
|
1966
|
+
--\n\n##### [buttons_exact](https://github.com/appium/ruby_lib/blob/621a9ebaf18bcd80eb0e1f5fc17fbb4dddf5293a/lib/appium_lib/ios/xcuitest/element/button.rb#L59) ios
|
|
2811
1967
|
|
|
2812
1968
|
> def buttons_exact(value)
|
|
2813
1969
|
|
|
2814
1970
|
Find all UIAButtons|XCUIElementTypeButtons that exactly match value.
|
|
2815
1971
|
|
|
2816
|
-
__Parameters:__
|
|
2817
|
-
|
|
2818
|
-
[String] value - the value to match exactly
|
|
1972
|
+
__Parameters:__\n\n [String] value - the value to match exactly
|
|
2819
1973
|
|
|
2820
|
-
__Returns:__
|
|
1974
|
+
__Returns:__\n\n [Array<UIAButton|XCUIElementTypeButton>]
|
|
2821
1975
|
|
|
2822
|
-
|
|
2823
|
-
|
|
2824
|
-
--
|
|
2825
|
-
|
|
2826
|
-
##### [find](https://github.com/appium/ruby_lib/blob/c6eb8f5416ccdf75b161bc60c0986caec43d9ff8/lib/appium_lib/ios/xcuitest/element/generic.rb#L8) ios
|
|
1976
|
+
--\n\n##### [find](https://github.com/appium/ruby_lib/blob/621a9ebaf18bcd80eb0e1f5fc17fbb4dddf5293a/lib/appium_lib/ios/xcuitest/element/generic.rb#L8) ios
|
|
2827
1977
|
|
|
2828
1978
|
> def find(value)
|
|
2829
1979
|
|
|
2830
1980
|
Find the first element containing value
|
|
2831
1981
|
|
|
2832
|
-
__Parameters:__
|
|
2833
|
-
|
|
2834
|
-
[String] value - the value to search for
|
|
2835
|
-
|
|
2836
|
-
__Returns:__
|
|
2837
|
-
|
|
2838
|
-
[Element]
|
|
1982
|
+
__Parameters:__\n\n [String] value - the value to search for
|
|
2839
1983
|
|
|
2840
|
-
|
|
1984
|
+
__Returns:__\n\n [Element]
|
|
2841
1985
|
|
|
2842
|
-
##### [finds](https://github.com/appium/ruby_lib/blob/
|
|
1986
|
+
--\n\n##### [finds](https://github.com/appium/ruby_lib/blob/621a9ebaf18bcd80eb0e1f5fc17fbb4dddf5293a/lib/appium_lib/ios/xcuitest/element/generic.rb#L15) ios
|
|
2843
1987
|
|
|
2844
1988
|
> def finds(value)
|
|
2845
1989
|
|
|
2846
1990
|
Find all elements containing value
|
|
2847
1991
|
|
|
2848
|
-
__Parameters:__
|
|
2849
|
-
|
|
2850
|
-
[String] value - the value to search for
|
|
2851
|
-
|
|
2852
|
-
__Returns:__
|
|
2853
|
-
|
|
2854
|
-
[Array<Element>]
|
|
1992
|
+
__Parameters:__\n\n [String] value - the value to search for
|
|
2855
1993
|
|
|
2856
|
-
|
|
1994
|
+
__Returns:__\n\n [Array<Element>]
|
|
2857
1995
|
|
|
2858
|
-
##### [find_exact](https://github.com/appium/ruby_lib/blob/
|
|
1996
|
+
--\n\n##### [find_exact](https://github.com/appium/ruby_lib/blob/621a9ebaf18bcd80eb0e1f5fc17fbb4dddf5293a/lib/appium_lib/ios/xcuitest/element/generic.rb#L23) ios
|
|
2859
1997
|
|
|
2860
1998
|
> def find_exact(value)
|
|
2861
1999
|
|
|
2862
2000
|
Find the first element exactly matching value
|
|
2863
2001
|
|
|
2864
|
-
__Parameters:__
|
|
2865
|
-
|
|
2866
|
-
[String] value - the value to search for
|
|
2867
|
-
|
|
2868
|
-
__Returns:__
|
|
2869
|
-
|
|
2870
|
-
[Element]
|
|
2002
|
+
__Parameters:__\n\n [String] value - the value to search for
|
|
2871
2003
|
|
|
2872
|
-
|
|
2004
|
+
__Returns:__\n\n [Element]
|
|
2873
2005
|
|
|
2874
|
-
##### [finds_exact](https://github.com/appium/ruby_lib/blob/
|
|
2006
|
+
--\n\n##### [finds_exact](https://github.com/appium/ruby_lib/blob/621a9ebaf18bcd80eb0e1f5fc17fbb4dddf5293a/lib/appium_lib/ios/xcuitest/element/generic.rb#L30) ios
|
|
2875
2007
|
|
|
2876
2008
|
> def finds_exact(value)
|
|
2877
2009
|
|
|
2878
2010
|
Find all elements exactly matching value
|
|
2879
2011
|
|
|
2880
|
-
__Parameters:__
|
|
2881
|
-
|
|
2882
|
-
[String] value - the value to search for
|
|
2883
|
-
|
|
2884
|
-
__Returns:__
|
|
2885
|
-
|
|
2886
|
-
[Array<Element>]
|
|
2012
|
+
__Parameters:__\n\n [String] value - the value to search for
|
|
2887
2013
|
|
|
2888
|
-
|
|
2014
|
+
__Returns:__\n\n [Array<Element>]
|
|
2889
2015
|
|
|
2890
|
-
##### [raise_error_if_no_element](https://github.com/appium/ruby_lib/blob/
|
|
2016
|
+
--\n\n##### [raise_error_if_no_element](https://github.com/appium/ruby_lib/blob/621a9ebaf18bcd80eb0e1f5fc17fbb4dddf5293a/lib/appium_lib/ios/xcuitest/element/generic.rb#L37) ios
|
|
2891
2017
|
|
|
2892
2018
|
> def raise_error_if_no_element(element)
|
|
2893
2019
|
|
|
2894
2020
|
|
|
2895
2021
|
|
|
2896
|
-
|
|
2897
|
-
|
|
2898
|
-
##### [select_visible_elements](https://github.com/appium/ruby_lib/blob/c6eb8f5416ccdf75b161bc60c0986caec43d9ff8/lib/appium_lib/ios/xcuitest/element/generic.rb#L45) ios
|
|
2022
|
+
--\n\n##### [select_visible_elements](https://github.com/appium/ruby_lib/blob/621a9ebaf18bcd80eb0e1f5fc17fbb4dddf5293a/lib/appium_lib/ios/xcuitest/element/generic.rb#L45) ios
|
|
2899
2023
|
|
|
2900
2024
|
> def select_visible_elements(elements)
|
|
2901
2025
|
|
|
2902
2026
|
Return visible elements.
|
|
2903
2027
|
|
|
2904
|
-
|
|
2905
|
-
|
|
2906
|
-
##### [swipe](https://github.com/appium/ruby_lib/blob/c6eb8f5416ccdf75b161bc60c0986caec43d9ff8/lib/appium_lib/ios/xcuitest/command/gestures.rb#L11) ios
|
|
2028
|
+
--\n\n##### [swipe](https://github.com/appium/ruby_lib/blob/621a9ebaf18bcd80eb0e1f5fc17fbb4dddf5293a/lib/appium_lib/ios/xcuitest/command/gestures.rb#L11) ios
|
|
2907
2029
|
|
|
2908
2030
|
> def swipe(direction:, element: nil)
|
|
2909
2031
|
|
|
2910
2032
|
|
|
2911
2033
|
|
|
2912
|
-
__Parameters:__
|
|
2913
|
-
|
|
2914
|
-
[string] direction - Either 'up', 'down', 'left' or 'right'.
|
|
2034
|
+
__Parameters:__\n\n [string] direction - Either 'up', 'down', 'left' or 'right'.
|
|
2915
2035
|
|
|
2916
2036
|
[Hash] opts - a customizable set of options
|
|
2917
2037
|
|
|
2918
|
-
|
|
2919
|
-
|
|
2920
|
-
##### [scroll](https://github.com/appium/ruby_lib/blob/c6eb8f5416ccdf75b161bc60c0986caec43d9ff8/lib/appium_lib/ios/xcuitest/command/gestures.rb#L31) ios
|
|
2038
|
+
--\n\n##### [scroll](https://github.com/appium/ruby_lib/blob/621a9ebaf18bcd80eb0e1f5fc17fbb4dddf5293a/lib/appium_lib/ios/xcuitest/command/gestures.rb#L31) ios
|
|
2921
2039
|
|
|
2922
2040
|
> def scroll(direction:, # rubocop:disable Metrics/ParameterLists
|
|
2923
2041
|
|
|
2924
2042
|
|
|
2925
2043
|
|
|
2926
|
-
__Parameters:__
|
|
2927
|
-
|
|
2928
|
-
[string] direction - Either 'up', 'down', 'left' or 'right'.
|
|
2044
|
+
__Parameters:__\n\n [string] direction - Either 'up', 'down', 'left' or 'right'.
|
|
2929
2045
|
|
|
2930
2046
|
[Hash] opts - a customizable set of options
|
|
2931
2047
|
|
|
2932
|
-
|
|
2933
|
-
|
|
2934
|
-
##### [pinch](https://github.com/appium/ruby_lib/blob/c6eb8f5416ccdf75b161bc60c0986caec43d9ff8/lib/appium_lib/ios/xcuitest/command/gestures.rb#L56) ios
|
|
2048
|
+
--\n\n##### [pinch](https://github.com/appium/ruby_lib/blob/621a9ebaf18bcd80eb0e1f5fc17fbb4dddf5293a/lib/appium_lib/ios/xcuitest/command/gestures.rb#L56) ios
|
|
2935
2049
|
|
|
2936
2050
|
> def pinch(scale:, velocity: 1.0, element: nil)
|
|
2937
2051
|
|
|
2938
2052
|
|
|
2939
2053
|
|
|
2940
|
-
__Parameters:__
|
|
2941
|
-
|
|
2942
|
-
[scale] scale - X tap coordinate of type float. Mandatory parameter
|
|
2054
|
+
__Parameters:__\n\n [scale] scale - X tap coordinate of type float. Mandatory parameter
|
|
2943
2055
|
|
|
2944
2056
|
[float] velocity - Y tap coordinate of type float. Mandatory parameter
|
|
2945
2057
|
|
|
2946
2058
|
[Hash] opts - a customizable set of options
|
|
2947
2059
|
|
|
2948
|
-
|
|
2949
|
-
|
|
2950
|
-
##### [double_tap](https://github.com/appium/ruby_lib/blob/c6eb8f5416ccdf75b161bc60c0986caec43d9ff8/lib/appium_lib/ios/xcuitest/command/gestures.rb#L71) ios
|
|
2060
|
+
--\n\n##### [double_tap](https://github.com/appium/ruby_lib/blob/621a9ebaf18bcd80eb0e1f5fc17fbb4dddf5293a/lib/appium_lib/ios/xcuitest/command/gestures.rb#L71) ios
|
|
2951
2061
|
|
|
2952
2062
|
> def double_tap(x: nil, y: nil, element: nil) # rubocop:disable Naming/UncommunicativeMethodParamName
|
|
2953
2063
|
|
|
2954
2064
|
|
|
2955
2065
|
|
|
2956
|
-
__Parameters:__
|
|
2957
|
-
|
|
2958
|
-
[float] x - X Screen x tap coordinate of type float. Mandatory parameter only if element is not set
|
|
2066
|
+
__Parameters:__\n\n [float] x - X Screen x tap coordinate of type float. Mandatory parameter only if element is not set
|
|
2959
2067
|
|
|
2960
2068
|
[float] y - Y Screen y tap coordinate of type float. Mandatory parameter only if element is not set
|
|
2961
2069
|
|
|
2962
2070
|
[Hash] opts - a customizable set of options
|
|
2963
2071
|
|
|
2964
|
-
|
|
2965
|
-
|
|
2966
|
-
##### [touch_and_hold](https://github.com/appium/ruby_lib/blob/c6eb8f5416ccdf75b161bc60c0986caec43d9ff8/lib/appium_lib/ios/xcuitest/command/gestures.rb#L88) ios
|
|
2072
|
+
--\n\n##### [touch_and_hold](https://github.com/appium/ruby_lib/blob/621a9ebaf18bcd80eb0e1f5fc17fbb4dddf5293a/lib/appium_lib/ios/xcuitest/command/gestures.rb#L88) ios
|
|
2967
2073
|
|
|
2968
2074
|
> def touch_and_hold(x: nil, y: nil, element: nil, duration: 1.0) # rubocop:disable Naming/UncommunicativeMethodParamName
|
|
2969
2075
|
|
|
2970
2076
|
|
|
2971
2077
|
|
|
2972
|
-
__Parameters:__
|
|
2973
|
-
|
|
2974
|
-
[float] x - Screen x long tap coordinate of type float. Mandatory parameter only if element is not set
|
|
2078
|
+
__Parameters:__\n\n [float] x - Screen x long tap coordinate of type float. Mandatory parameter only if element is not set
|
|
2975
2079
|
|
|
2976
2080
|
[float] y - Screen y long tap coordinate of type float. Mandatory parameter only if element is not set
|
|
2977
2081
|
|
|
@@ -2979,49 +2083,37 @@ __Parameters:__
|
|
|
2979
2083
|
|
|
2980
2084
|
[Hash] opts - a customizable set of options
|
|
2981
2085
|
|
|
2982
|
-
|
|
2983
|
-
|
|
2984
|
-
##### [two_finger_tap](https://github.com/appium/ruby_lib/blob/c6eb8f5416ccdf75b161bc60c0986caec43d9ff8/lib/appium_lib/ios/xcuitest/command/gestures.rb#L101) ios
|
|
2086
|
+
--\n\n##### [two_finger_tap](https://github.com/appium/ruby_lib/blob/621a9ebaf18bcd80eb0e1f5fc17fbb4dddf5293a/lib/appium_lib/ios/xcuitest/command/gestures.rb#L101) ios
|
|
2985
2087
|
|
|
2986
2088
|
> def two_finger_tap(element:)
|
|
2987
2089
|
|
|
2988
2090
|
|
|
2989
2091
|
|
|
2990
|
-
__Parameters:__
|
|
2991
|
-
|
|
2992
|
-
[Element] element - Element to long tap on.
|
|
2092
|
+
__Parameters:__\n\n [Element] element - Element to long tap on.
|
|
2993
2093
|
|
|
2994
2094
|
```ruby
|
|
2995
2095
|
two_finger_tap element: find_element(:accessibility_id, "some item")
|
|
2996
2096
|
```
|
|
2997
2097
|
|
|
2998
|
-
|
|
2999
|
-
|
|
3000
|
-
##### [tap](https://github.com/appium/ruby_lib/blob/c6eb8f5416ccdf75b161bc60c0986caec43d9ff8/lib/appium_lib/ios/xcuitest/command/gestures.rb#L116) ios
|
|
2098
|
+
--\n\n##### [tap](https://github.com/appium/ruby_lib/blob/621a9ebaf18bcd80eb0e1f5fc17fbb4dddf5293a/lib/appium_lib/ios/xcuitest/command/gestures.rb#L116) ios
|
|
3001
2099
|
|
|
3002
2100
|
> def tap(x:, y:, element: nil) # rubocop:disable Naming/UncommunicativeMethodParamName
|
|
3003
2101
|
|
|
3004
2102
|
|
|
3005
2103
|
|
|
3006
|
-
__Parameters:__
|
|
3007
|
-
|
|
3008
|
-
[float] x - X tap coordinate of type float. Mandatory parameter
|
|
2104
|
+
__Parameters:__\n\n [float] x - X tap coordinate of type float. Mandatory parameter
|
|
3009
2105
|
|
|
3010
2106
|
[float] y - Y tap coordinate of type float. Mandatory parameter
|
|
3011
2107
|
|
|
3012
2108
|
[Hash] opts - a customizable set of options
|
|
3013
2109
|
|
|
3014
|
-
|
|
3015
|
-
|
|
3016
|
-
##### [drag_from_to_for_duration](https://github.com/appium/ruby_lib/blob/c6eb8f5416ccdf75b161bc60c0986caec43d9ff8/lib/appium_lib/ios/xcuitest/command/gestures.rb#L136) ios
|
|
2110
|
+
--\n\n##### [drag_from_to_for_duration](https://github.com/appium/ruby_lib/blob/621a9ebaf18bcd80eb0e1f5fc17fbb4dddf5293a/lib/appium_lib/ios/xcuitest/command/gestures.rb#L136) ios
|
|
3017
2111
|
|
|
3018
2112
|
> def drag_from_to_for_duration(from_x:, from_y:, to_x:, to_y:, duration: 1.0, element: nil)
|
|
3019
2113
|
|
|
3020
2114
|
rubocop:disable Metrics/ParameterLists
|
|
3021
2115
|
|
|
3022
|
-
__Parameters:__
|
|
3023
|
-
|
|
3024
|
-
[float] duration - Float number of seconds in range [0.5, 60]. How long the tap gesture at starting
|
|
2116
|
+
__Parameters:__\n\n [float] duration - Float number of seconds in range [0.5, 60]. How long the tap gesture at starting
|
|
3025
2117
|
drag point should be before to start dragging. Mandatory parameter
|
|
3026
2118
|
|
|
3027
2119
|
[float] from_x - The x coordinate of starting drag point (type float). Mandatory parameter
|
|
@@ -3034,65 +2126,55 @@ drag point should be before to start dragging. Mandatory parameter
|
|
|
3034
2126
|
|
|
3035
2127
|
[Hash] opts - a customizable set of options
|
|
3036
2128
|
|
|
3037
|
-
|
|
3038
|
-
|
|
3039
|
-
##### [select_picker_wheel](https://github.com/appium/ruby_lib/blob/c6eb8f5416ccdf75b161bc60c0986caec43d9ff8/lib/appium_lib/ios/xcuitest/command/gestures.rb#L153) ios
|
|
2129
|
+
--\n\n##### [select_picker_wheel](https://github.com/appium/ruby_lib/blob/621a9ebaf18bcd80eb0e1f5fc17fbb4dddf5293a/lib/appium_lib/ios/xcuitest/command/gestures.rb#L153) ios
|
|
3040
2130
|
|
|
3041
2131
|
> def select_picker_wheel(element:, order:, offset: nil)
|
|
3042
2132
|
|
|
3043
2133
|
https://github.com/facebook/WebDriverAgent/pull/523
|
|
3044
2134
|
https://github.com/appium/appium-xcuitest-driver/pull/420
|
|
3045
2135
|
|
|
3046
|
-
__Parameters:__
|
|
3047
|
-
|
|
3048
|
-
[String] order - The order to move picker to. "next" or "previous".
|
|
2136
|
+
__Parameters:__\n\n [String] order - The order to move picker to. "next" or "previous".
|
|
3049
2137
|
|
|
3050
2138
|
[Element] element - Element id to perform select picker wheel on.
|
|
3051
2139
|
|
|
3052
2140
|
[Hash] opts - a customizable set of options
|
|
3053
2141
|
|
|
3054
|
-
|
|
3055
|
-
|
|
3056
|
-
##### [alert](https://github.com/appium/ruby_lib/blob/c6eb8f5416ccdf75b161bc60c0986caec43d9ff8/lib/appium_lib/ios/xcuitest/command/gestures.rb#L171) ios
|
|
2142
|
+
--\n\n##### [alert](https://github.com/appium/ruby_lib/blob/621a9ebaf18bcd80eb0e1f5fc17fbb4dddf5293a/lib/appium_lib/ios/xcuitest/command/gestures.rb#L171) ios
|
|
3057
2143
|
|
|
3058
2144
|
> def alert(action:, button_label: nil)
|
|
3059
2145
|
|
|
3060
2146
|
|
|
3061
2147
|
|
|
3062
|
-
__Parameters:__
|
|
3063
|
-
|
|
3064
|
-
[String] action - The following actions are supported: accept, dismiss and getButtons. Mandatory parameter
|
|
2148
|
+
__Parameters:__\n\n [String] action - The following actions are supported: accept, dismiss and getButtons. Mandatory parameter
|
|
3065
2149
|
|
|
3066
2150
|
[String] button_label - The label text of an existing alert button to click on.
|
|
3067
2151
|
This is an optional parameter and is only valid in combination with accept and dismiss actions.
|
|
3068
2152
|
|
|
3069
|
-
|
|
2153
|
+
__Returns:__\n\n [] {} or Selenium::WebDriver::Error::NoSuchAlertError if no action sheet or alert
|
|
2154
|
+
or button labels if action is equal to getButtons.
|
|
3070
2155
|
|
|
3071
|
-
|
|
3072
|
-
|
|
3073
|
-
|
|
2156
|
+
```ruby
|
|
2157
|
+
alert action: "accept"
|
|
2158
|
+
alert action: "dismiss"
|
|
2159
|
+
```
|
|
3074
2160
|
|
|
2161
|
+
--\n\n##### [text_field_class](https://github.com/appium/ruby_lib/blob/621a9ebaf18bcd80eb0e1f5fc17fbb4dddf5293a/lib/appium_lib/ios/xcuitest/element/textfield.rb#L9) ios
|
|
3075
2162
|
|
|
2163
|
+
> def text_field_class
|
|
3076
2164
|
|
|
3077
|
-
__Returns:__
|
|
3078
2165
|
|
|
3079
|
-
[String] Class name for text field
|
|
3080
2166
|
|
|
3081
|
-
|
|
2167
|
+
__Returns:__\n\n [String] Class name for text field
|
|
3082
2168
|
|
|
3083
|
-
##### [secure_text_field_class](https://github.com/appium/ruby_lib/blob/
|
|
2169
|
+
--\n\n##### [secure_text_field_class](https://github.com/appium/ruby_lib/blob/621a9ebaf18bcd80eb0e1f5fc17fbb4dddf5293a/lib/appium_lib/ios/xcuitest/element/textfield.rb#L14) ios
|
|
3084
2170
|
|
|
3085
2171
|
> def secure_text_field_class
|
|
3086
2172
|
|
|
3087
2173
|
|
|
3088
2174
|
|
|
3089
|
-
__Returns:__
|
|
3090
|
-
|
|
3091
|
-
[String] Class name for secure text field
|
|
2175
|
+
__Returns:__\n\n [String] Class name for secure text field
|
|
3092
2176
|
|
|
3093
|
-
|
|
3094
|
-
|
|
3095
|
-
##### [textfield](https://github.com/appium/ruby_lib/blob/c6eb8f5416ccdf75b161bc60c0986caec43d9ff8/lib/appium_lib/ios/xcuitest/element/textfield.rb#L23) ios
|
|
2177
|
+
--\n\n##### [textfield](https://github.com/appium/ruby_lib/blob/621a9ebaf18bcd80eb0e1f5fc17fbb4dddf5293a/lib/appium_lib/ios/xcuitest/element/textfield.rb#L23) ios
|
|
3096
2178
|
|
|
3097
2179
|
> def textfield(value)
|
|
3098
2180
|
|
|
@@ -3100,117 +2182,77 @@ Find the first TextField that contains value or by index.
|
|
|
3100
2182
|
Note: Uses XPath
|
|
3101
2183
|
If int then the TextField at that index is returned.
|
|
3102
2184
|
|
|
3103
|
-
__Parameters:__
|
|
3104
|
-
|
|
3105
|
-
[String, Integer] value - the text to match exactly.
|
|
3106
|
-
|
|
3107
|
-
__Returns:__
|
|
3108
|
-
|
|
3109
|
-
[TextField]
|
|
2185
|
+
__Parameters:__\n\n [String, Integer] value - the text to match exactly.
|
|
3110
2186
|
|
|
3111
|
-
|
|
2187
|
+
__Returns:__\n\n [TextField]
|
|
3112
2188
|
|
|
3113
|
-
##### [textfields](https://github.com/appium/ruby_lib/blob/
|
|
2189
|
+
--\n\n##### [textfields](https://github.com/appium/ruby_lib/blob/621a9ebaf18bcd80eb0e1f5fc17fbb4dddf5293a/lib/appium_lib/ios/xcuitest/element/textfield.rb#L43) ios
|
|
3114
2190
|
|
|
3115
2191
|
> def textfields(value = false)
|
|
3116
2192
|
|
|
3117
2193
|
Find all TextFields containing value.
|
|
3118
2194
|
If value is omitted, all TextFields are returned.
|
|
3119
2195
|
|
|
3120
|
-
__Parameters:__
|
|
2196
|
+
__Parameters:__\n\n [String] value - the value to search for
|
|
3121
2197
|
|
|
3122
|
-
[
|
|
3123
|
-
|
|
3124
|
-
__Returns:__
|
|
3125
|
-
|
|
3126
|
-
[Array<TextField>]
|
|
2198
|
+
__Returns:__\n\n [Array<TextField>]
|
|
3127
2199
|
|
|
3128
|
-
|
|
3129
|
-
|
|
3130
|
-
##### [first_textfield](https://github.com/appium/ruby_lib/blob/c6eb8f5416ccdf75b161bc60c0986caec43d9ff8/lib/appium_lib/ios/xcuitest/element/textfield.rb#L52) ios
|
|
2200
|
+
--\n\n##### [first_textfield](https://github.com/appium/ruby_lib/blob/621a9ebaf18bcd80eb0e1f5fc17fbb4dddf5293a/lib/appium_lib/ios/xcuitest/element/textfield.rb#L52) ios
|
|
3131
2201
|
|
|
3132
2202
|
> def first_textfield
|
|
3133
2203
|
|
|
3134
2204
|
Find the first TextField.
|
|
3135
2205
|
|
|
3136
|
-
__Returns:__
|
|
3137
|
-
|
|
3138
|
-
[TextField]
|
|
2206
|
+
__Returns:__\n\n [TextField]
|
|
3139
2207
|
|
|
3140
|
-
|
|
3141
|
-
|
|
3142
|
-
##### [last_textfield](https://github.com/appium/ruby_lib/blob/c6eb8f5416ccdf75b161bc60c0986caec43d9ff8/lib/appium_lib/ios/xcuitest/element/textfield.rb#L58) ios
|
|
2208
|
+
--\n\n##### [last_textfield](https://github.com/appium/ruby_lib/blob/621a9ebaf18bcd80eb0e1f5fc17fbb4dddf5293a/lib/appium_lib/ios/xcuitest/element/textfield.rb#L58) ios
|
|
3143
2209
|
|
|
3144
2210
|
> def last_textfield
|
|
3145
2211
|
|
|
3146
2212
|
Find the last TextField.
|
|
3147
2213
|
|
|
3148
|
-
__Returns:__
|
|
3149
|
-
|
|
3150
|
-
[TextField]
|
|
2214
|
+
__Returns:__\n\n [TextField]
|
|
3151
2215
|
|
|
3152
|
-
|
|
3153
|
-
|
|
3154
|
-
##### [textfield_exact](https://github.com/appium/ruby_lib/blob/c6eb8f5416ccdf75b161bc60c0986caec43d9ff8/lib/appium_lib/ios/xcuitest/element/textfield.rb#L68) ios
|
|
2216
|
+
--\n\n##### [textfield_exact](https://github.com/appium/ruby_lib/blob/621a9ebaf18bcd80eb0e1f5fc17fbb4dddf5293a/lib/appium_lib/ios/xcuitest/element/textfield.rb#L68) ios
|
|
3155
2217
|
|
|
3156
2218
|
> def textfield_exact(value)
|
|
3157
2219
|
|
|
3158
2220
|
Find the first TextField that exactly matches value.
|
|
3159
2221
|
|
|
3160
|
-
__Parameters:__
|
|
3161
|
-
|
|
3162
|
-
[String] value - the value to match exactly
|
|
2222
|
+
__Parameters:__\n\n [String] value - the value to match exactly
|
|
3163
2223
|
|
|
3164
|
-
__Returns:__
|
|
2224
|
+
__Returns:__\n\n [TextField]
|
|
3165
2225
|
|
|
3166
|
-
|
|
3167
|
-
|
|
3168
|
-
--
|
|
3169
|
-
|
|
3170
|
-
##### [textfields_exact](https://github.com/appium/ruby_lib/blob/c6eb8f5416ccdf75b161bc60c0986caec43d9ff8/lib/appium_lib/ios/xcuitest/element/textfield.rb#L75) ios
|
|
2226
|
+
--\n\n##### [textfields_exact](https://github.com/appium/ruby_lib/blob/621a9ebaf18bcd80eb0e1f5fc17fbb4dddf5293a/lib/appium_lib/ios/xcuitest/element/textfield.rb#L75) ios
|
|
3171
2227
|
|
|
3172
2228
|
> def textfields_exact(value)
|
|
3173
2229
|
|
|
3174
2230
|
Find all TextFields that exactly match value.
|
|
3175
2231
|
|
|
3176
|
-
__Parameters:__
|
|
3177
|
-
|
|
3178
|
-
[String] value - the value to match exactly
|
|
3179
|
-
|
|
3180
|
-
__Returns:__
|
|
2232
|
+
__Parameters:__\n\n [String] value - the value to match exactly
|
|
3181
2233
|
|
|
3182
|
-
[Array<TextField>]
|
|
2234
|
+
__Returns:__\n\n [Array<TextField>]
|
|
3183
2235
|
|
|
3184
|
-
|
|
3185
|
-
|
|
3186
|
-
##### [set_pasteboard](https://github.com/appium/ruby_lib/blob/c6eb8f5416ccdf75b161bc60c0986caec43d9ff8/lib/appium_lib/ios/xcuitest/command/pasteboard.rb#L12) ios
|
|
2236
|
+
--\n\n##### [set_pasteboard](https://github.com/appium/ruby_lib/blob/621a9ebaf18bcd80eb0e1f5fc17fbb4dddf5293a/lib/appium_lib/ios/xcuitest/command/pasteboard.rb#L12) ios
|
|
3187
2237
|
|
|
3188
2238
|
> def set_pasteboard(content:, encoding: nil)
|
|
3189
2239
|
|
|
3190
2240
|
|
|
3191
2241
|
|
|
3192
|
-
__Parameters:__
|
|
3193
|
-
|
|
3194
|
-
[string] content - The content of the pasteboard. The previous content is going to be overridden.
|
|
2242
|
+
__Parameters:__\n\n [string] content - The content of the pasteboard. The previous content is going to be overridden.
|
|
3195
2243
|
The parameter is mandatory
|
|
3196
2244
|
|
|
3197
2245
|
[Hash] opts - a customizable set of options
|
|
3198
2246
|
|
|
3199
|
-
|
|
3200
|
-
|
|
3201
|
-
##### [get_pasteboard](https://github.com/appium/ruby_lib/blob/c6eb8f5416ccdf75b161bc60c0986caec43d9ff8/lib/appium_lib/ios/xcuitest/command/pasteboard.rb#L24) ios
|
|
2247
|
+
--\n\n##### [get_pasteboard](https://github.com/appium/ruby_lib/blob/621a9ebaf18bcd80eb0e1f5fc17fbb4dddf5293a/lib/appium_lib/ios/xcuitest/command/pasteboard.rb#L24) ios
|
|
3202
2248
|
|
|
3203
2249
|
> def get_pasteboard(encoding: nil)
|
|
3204
2250
|
|
|
3205
2251
|
|
|
3206
2252
|
|
|
3207
|
-
__Parameters:__
|
|
2253
|
+
__Parameters:__\n\n [Hash] opts - a customizable set of options
|
|
3208
2254
|
|
|
3209
|
-
|
|
3210
|
-
|
|
3211
|
-
--
|
|
3212
|
-
|
|
3213
|
-
##### [install_certificate](https://github.com/appium/ruby_lib/blob/c6eb8f5416ccdf75b161bc60c0986caec43d9ff8/lib/appium_lib/ios/xcuitest/command/certificate.rb#L18) ios
|
|
2255
|
+
--\n\n##### [install_certificate](https://github.com/appium/ruby_lib/blob/621a9ebaf18bcd80eb0e1f5fc17fbb4dddf5293a/lib/appium_lib/ios/xcuitest/command/certificate.rb#L18) ios
|
|
3214
2256
|
|
|
3215
2257
|
> def install_certificate(cer_file:)
|
|
3216
2258
|
|
|
@@ -3219,21 +2261,15 @@ based on the given PEM certificate content.
|
|
|
3219
2261
|
https://developer.apple.com/library/content/documentation/NetworkingInternet/Conceptual/iPhoneOTAConfiguration/Introduction/Introduction.html
|
|
3220
2262
|
https://github.com/appium/appium-xcuitest-driver/pull/652
|
|
3221
2263
|
|
|
3222
|
-
__Parameters:__
|
|
3223
|
-
|
|
3224
|
-
[string] cer_file - The content of the certificate file.
|
|
3225
|
-
|
|
3226
|
-
--
|
|
2264
|
+
__Parameters:__\n\n [string] cer_file - The content of the certificate file.
|
|
3227
2265
|
|
|
3228
|
-
##### [xcuitest_get_contexts](https://github.com/appium/ruby_lib/blob/
|
|
2266
|
+
--\n\n##### [xcuitest_get_contexts](https://github.com/appium/ruby_lib/blob/621a9ebaf18bcd80eb0e1f5fc17fbb4dddf5293a/lib/appium_lib/ios/xcuitest/command/get_context.rb#L14) ios
|
|
3229
2267
|
|
|
3230
2268
|
> def xcuitest_get_contexts
|
|
3231
2269
|
|
|
3232
2270
|
Get contexts
|
|
3233
2271
|
|
|
3234
|
-
|
|
3235
|
-
|
|
3236
|
-
##### [xcuitest_install_app](https://github.com/appium/ruby_lib/blob/c6eb8f5416ccdf75b161bc60c0986caec43d9ff8/lib/appium_lib/ios/xcuitest/command/multi_app_handler.rb#L21) ios
|
|
2272
|
+
--\n\n##### [xcuitest_install_app](https://github.com/appium/ruby_lib/blob/621a9ebaf18bcd80eb0e1f5fc17fbb4dddf5293a/lib/appium_lib/ios/xcuitest/command/multi_app_handler.rb#L21) ios
|
|
3237
2273
|
|
|
3238
2274
|
> def xcuitest_install_app(app:)
|
|
3239
2275
|
|
|
@@ -3242,69 +2278,55 @@ then it's going to be installed over it, which allows to test upgrades.
|
|
|
3242
2278
|
Be careful while reinstalling the main application under test - make sure you called terminateApp
|
|
3243
2279
|
for it first, otherwise WebDriverAgent will detect it as a potential application crash.
|
|
3244
2280
|
|
|
3245
|
-
__Parameters:__
|
|
3246
|
-
|
|
3247
|
-
[String] app - The path to an existing .ipa/.app file on the server file system, zipped .app file
|
|
2281
|
+
__Parameters:__\n\n [String] app - The path to an existing .ipa/.app file on the server file system, zipped .app file
|
|
3248
2282
|
or an URL pointing to a remote .ipa/.zip file. Mandatory argument.
|
|
3249
2283
|
|
|
3250
|
-
|
|
2284
|
+
__Returns:__\n\n [] {}
|
|
3251
2285
|
|
|
3252
|
-
##### [xcuitest_app_installed?](https://github.com/appium/ruby_lib/blob/
|
|
2286
|
+
--\n\n##### [xcuitest_app_installed?](https://github.com/appium/ruby_lib/blob/621a9ebaf18bcd80eb0e1f5fc17fbb4dddf5293a/lib/appium_lib/ios/xcuitest/command/multi_app_handler.rb#L35) ios
|
|
3253
2287
|
|
|
3254
2288
|
> def xcuitest_app_installed?(bundle_id:)
|
|
3255
2289
|
|
|
3256
2290
|
Verifies whether the application with given bundle identifier is installed on the device.
|
|
3257
2291
|
|
|
3258
|
-
__Parameters:__
|
|
3259
|
-
|
|
3260
|
-
[String] bundle_id - The bundle identifier of the application, which is going to be verified.
|
|
3261
|
-
|
|
3262
|
-
__Returns:__
|
|
2292
|
+
__Parameters:__\n\n [String] bundle_id - The bundle identifier of the application, which is going to be verified.
|
|
3263
2293
|
|
|
3264
|
-
[boolean]
|
|
2294
|
+
__Returns:__\n\n [boolean]
|
|
3265
2295
|
|
|
3266
|
-
|
|
3267
|
-
|
|
3268
|
-
##### [xcuitest_remove_app](https://github.com/appium/ruby_lib/blob/c6eb8f5416ccdf75b161bc60c0986caec43d9ff8/lib/appium_lib/ios/xcuitest/command/multi_app_handler.rb#L50) ios
|
|
2296
|
+
--\n\n##### [xcuitest_remove_app](https://github.com/appium/ruby_lib/blob/621a9ebaf18bcd80eb0e1f5fc17fbb4dddf5293a/lib/appium_lib/ios/xcuitest/command/multi_app_handler.rb#L50) ios
|
|
3269
2297
|
|
|
3270
2298
|
> def xcuitest_remove_app(bundle_id:)
|
|
3271
2299
|
|
|
3272
2300
|
Uninstalls an existing application from the device under test. This endpoint does not verify
|
|
3273
2301
|
whether the application is already installed or not before uninstalling it.
|
|
3274
2302
|
|
|
3275
|
-
__Parameters:__
|
|
3276
|
-
|
|
3277
|
-
[String] bundle_id - The bundle identifier of the application, which is going to be uninstalled.
|
|
2303
|
+
__Parameters:__\n\n [String] bundle_id - The bundle identifier of the application, which is going to be uninstalled.
|
|
3278
2304
|
|
|
3279
|
-
|
|
2305
|
+
__Returns:__\n\n [] {}
|
|
3280
2306
|
|
|
3281
|
-
##### [xcuitest_launch_app](https://github.com/appium/ruby_lib/blob/
|
|
2307
|
+
--\n\n##### [xcuitest_launch_app](https://github.com/appium/ruby_lib/blob/621a9ebaf18bcd80eb0e1f5fc17fbb4dddf5293a/lib/appium_lib/ios/xcuitest/command/multi_app_handler.rb#L65) ios
|
|
3282
2308
|
|
|
3283
2309
|
> def xcuitest_launch_app(bundle_id:)
|
|
3284
2310
|
|
|
3285
2311
|
Executes an existing application on the device. If the application is already running then
|
|
3286
2312
|
it will be brought to the foreground.
|
|
3287
2313
|
|
|
3288
|
-
__Parameters:__
|
|
2314
|
+
__Parameters:__\n\n [String] bundle_id - The bundle identifier of the application, which is going to be executed.
|
|
3289
2315
|
|
|
3290
|
-
[
|
|
2316
|
+
__Returns:__\n\n [] {}
|
|
3291
2317
|
|
|
3292
|
-
|
|
3293
|
-
|
|
3294
|
-
##### [xcuitest_terminate_app](https://github.com/appium/ruby_lib/blob/c6eb8f5416ccdf75b161bc60c0986caec43d9ff8/lib/appium_lib/ios/xcuitest/command/multi_app_handler.rb#L80) ios
|
|
2318
|
+
--\n\n##### [xcuitest_terminate_app](https://github.com/appium/ruby_lib/blob/621a9ebaf18bcd80eb0e1f5fc17fbb4dddf5293a/lib/appium_lib/ios/xcuitest/command/multi_app_handler.rb#L80) ios
|
|
3295
2319
|
|
|
3296
2320
|
> def xcuitest_terminate_app(bundle_id:)
|
|
3297
2321
|
|
|
3298
2322
|
Terminates an existing application on the device. If the application is not running then
|
|
3299
2323
|
the returned result will be false, otherwise true.
|
|
3300
2324
|
|
|
3301
|
-
__Parameters:__
|
|
3302
|
-
|
|
3303
|
-
[String] bundle_id - The bundle identifier of the application, which is going to be terminated.
|
|
2325
|
+
__Parameters:__\n\n [String] bundle_id - The bundle identifier of the application, which is going to be terminated.
|
|
3304
2326
|
|
|
3305
|
-
|
|
2327
|
+
__Returns:__\n\n [] {}
|
|
3306
2328
|
|
|
3307
|
-
##### [xcuitest_query_app_status](https://github.com/appium/ruby_lib/blob/
|
|
2329
|
+
--\n\n##### [xcuitest_query_app_status](https://github.com/appium/ruby_lib/blob/621a9ebaf18bcd80eb0e1f5fc17fbb4dddf5293a/lib/appium_lib/ios/xcuitest/command/multi_app_handler.rb#L102) ios
|
|
3308
2330
|
|
|
3309
2331
|
> def xcuitest_query_app_status(bundle_id:)
|
|
3310
2332
|
|
|
@@ -3318,17 +2340,11 @@ State:
|
|
|
3318
2340
|
|
|
3319
2341
|
For more details: https://developer.apple.com/documentation/xctest/xcuiapplicationstate
|
|
3320
2342
|
|
|
3321
|
-
__Parameters:__
|
|
2343
|
+
__Parameters:__\n\n [String] bundle_id - A target app's bundle id
|
|
3322
2344
|
|
|
3323
|
-
[
|
|
2345
|
+
__Returns:__\n\n [0|1|2|3|4] A number of the state
|
|
3324
2346
|
|
|
3325
|
-
|
|
3326
|
-
|
|
3327
|
-
[0|1|2|3|4] A number of the state
|
|
3328
|
-
|
|
3329
|
-
--
|
|
3330
|
-
|
|
3331
|
-
##### [xcuitest_activate_app](https://github.com/appium/ruby_lib/blob/c6eb8f5416ccdf75b161bc60c0986caec43d9ff8/lib/appium_lib/ios/xcuitest/command/multi_app_handler.rb#L118) ios
|
|
2347
|
+
--\n\n##### [xcuitest_activate_app](https://github.com/appium/ruby_lib/blob/621a9ebaf18bcd80eb0e1f5fc17fbb4dddf5293a/lib/appium_lib/ios/xcuitest/command/multi_app_handler.rb#L118) ios
|
|
3332
2348
|
|
|
3333
2349
|
> def xcuitest_activate_app(bundle_id:)
|
|
3334
2350
|
|
|
@@ -3336,9 +2352,8 @@ Activates an existing application on the device under test and moves it to the f
|
|
|
3336
2352
|
The application should be already running in order to activate it.
|
|
3337
2353
|
The call is ignored if the application is already in foreground.
|
|
3338
2354
|
|
|
3339
|
-
__Parameters:__
|
|
3340
|
-
|
|
3341
|
-
[String] bundle_id - The bundle identifier of the application, which is going to be brought to the foreground.
|
|
2355
|
+
__Parameters:__\n\n [String] bundle_id - The bundle identifier of the application, which is going to be brought to the foreground.
|
|
3342
2356
|
|
|
3343
|
-
|
|
2357
|
+
__Returns:__\n\n [] {}
|
|
3344
2358
|
|
|
2359
|
+
--\n\n
|