appium_lib 9.15.2 → 9.16.0
Sign up to get free protection for your applications and to get access to all the features.
- 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
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA1:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: e005557548b4f0b0aafaa113654147612da771b0
|
4
|
+
data.tar.gz: ca25f7b466bde22322c6185ef383f2682394a95f
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: bb53dc6aec0b7d29d291475095a8ab9b91e63a1793cbf6687af15ee9ba2c6ac971ceabe17a2af385731e5aac1bf89a149720d494890c2ee59458f367bc4a0fe6
|
7
|
+
data.tar.gz: c82f419fe7b873598bdd735f223d7e154292e8ad1f5297de1a170672d0876441c688186867d0f64b1bb9b88ae62d4528f1cdd48c475c9423578342b3fc83f452
|
data/CHANGELOG.md
CHANGED
@@ -3,6 +3,7 @@ Commit based release not is [release_notes.md](./release_notes.md)
|
|
3
3
|
|
4
4
|
Release tags are https://github.com/appium/ruby_lib/releases .
|
5
5
|
|
6
|
+
|
6
7
|
## Unreleased
|
7
8
|
### 1. Enhancements
|
8
9
|
|
@@ -10,6 +11,28 @@ Release tags are https://github.com/appium/ruby_lib/releases .
|
|
10
11
|
|
11
12
|
### 3. Deprecations
|
12
13
|
|
14
|
+
## v9.16.0
|
15
|
+
### 1. Enhancements
|
16
|
+
- Introduce `appium_thor` in order to automate release
|
17
|
+
|
18
|
+
### 2. Bug fixes
|
19
|
+
- `:app` can be non-path capability like [Windows](https://github.com/Microsoft/WinAppDriver)
|
20
|
+
```ruby
|
21
|
+
{ caps:
|
22
|
+
{ platformName: :windows,
|
23
|
+
app: 'Microsoft.WindowsCalculator_8wekyb3d8bbwe!App'
|
24
|
+
}
|
25
|
+
} # `:app` is bundle id.
|
26
|
+
|
27
|
+
{ caps:
|
28
|
+
{ platformName: :windows,
|
29
|
+
app: 'relative/path/to/app'
|
30
|
+
}
|
31
|
+
} # `:app` will be alsolute path to the `:app` if the path exists
|
32
|
+
```
|
33
|
+
|
34
|
+
### 3. Deprecations
|
35
|
+
|
13
36
|
## v9.15.2
|
14
37
|
### 1. Enhancements
|
15
38
|
- Wrap selenium-webdriver apis via `Appium::Driver` through Appium Core Bridge [#827](https://github.com/appium/ruby_lib/pull/827/files)
|
data/Rakefile
CHANGED
@@ -1,263 +1,6 @@
|
|
1
|
-
|
2
|
-
require 'rubygems'
|
3
|
-
require 'rake'
|
4
|
-
require 'date'
|
5
|
-
require 'posix/spawn'
|
1
|
+
require 'bundler/gem_tasks'
|
6
2
|
require 'rubocop/rake_task'
|
7
3
|
|
8
|
-
# Defines gem name.
|
9
|
-
def repo_name
|
10
|
-
'appium_lib'
|
11
|
-
end
|
12
|
-
|
13
|
-
# ruby_lib published as appium_lib
|
14
|
-
def gh_name
|
15
|
-
'ruby_lib'
|
16
|
-
end
|
17
|
-
|
18
|
-
# the name as used on github.com
|
19
|
-
def version_file
|
20
|
-
"lib/#{repo_name}/version.rb"
|
21
|
-
end
|
22
|
-
|
23
|
-
def version_rgx
|
24
|
-
/\s*VERSION\s*=\s*'([^']+)'/m
|
25
|
-
end
|
26
|
-
|
27
|
-
def version
|
28
|
-
@version = @version || File.read(version_file).match(version_rgx)[1]
|
29
|
-
end
|
30
|
-
|
31
|
-
def bump value
|
32
|
-
data = File.read version_file
|
33
|
-
|
34
|
-
v_line = data.match version_rgx
|
35
|
-
d_line = data.match /\s*DATE\s*=\s*'([^']+)'/m
|
36
|
-
|
37
|
-
old_v = v_line[0]
|
38
|
-
old_d = d_line[0]
|
39
|
-
|
40
|
-
old_num = v_line[1]
|
41
|
-
new_num = old_num.split('.')
|
42
|
-
new_num[-1] = new_num[-1].to_i + 1
|
43
|
-
|
44
|
-
if value == :y
|
45
|
-
new_num[-1] = 0 # x.y.Z -> x.y.0
|
46
|
-
new_num[-2] = new_num[-2].to_i + 1 # x.Y -> x.Y+1
|
47
|
-
elsif value == :x
|
48
|
-
new_num[-1] = 0 # x.y.Z -> x.y.0
|
49
|
-
new_num[-2] = 0 # x.Y.z -> x.0.z
|
50
|
-
new_num[-3] = new_num[-3].to_i + 1
|
51
|
-
end
|
52
|
-
|
53
|
-
new_num = new_num.join '.'
|
54
|
-
|
55
|
-
new_v = old_v.sub old_num, new_num
|
56
|
-
puts "#{old_num} -> #{new_num}"
|
57
|
-
|
58
|
-
old_date = d_line[1]
|
59
|
-
new_date = Date.today.to_s
|
60
|
-
new_d = old_d.sub old_date, new_date
|
61
|
-
puts "#{old_date} -> #{new_date}" unless old_date == new_date
|
62
|
-
|
63
|
-
data.sub! old_v, new_v
|
64
|
-
data.sub! old_d, new_d
|
65
|
-
|
66
|
-
File.write version_file, data
|
67
|
-
end
|
68
|
-
|
69
|
-
desc 'Bump the z version number and update the date.'
|
70
|
-
task :bump do
|
71
|
-
bump :z
|
72
|
-
end
|
73
|
-
|
74
|
-
desc 'Bump the y version number, set z to zero, update the date.'
|
75
|
-
task :bumpy do
|
76
|
-
bump :y
|
77
|
-
end
|
78
|
-
|
79
|
-
desc 'Bump the x version number, set y & z to zero, update the date.'
|
80
|
-
task :bumpx do
|
81
|
-
bump :x
|
82
|
-
end
|
83
|
-
|
84
|
-
|
85
|
-
desc 'Install gems required for release task'
|
86
|
-
task :dev do
|
87
|
-
sh 'gem install --no-rdoc --no-ri yard'
|
88
|
-
sh 'gem install --no-rdoc --no-ri redcarpet'
|
89
|
-
end
|
90
|
-
|
91
|
-
def tag_exists tag_name
|
92
|
-
cmd = %Q(git branch -a --contains "#{tag_name}")
|
93
|
-
POSIX::Spawn::Child.new(cmd).out.include? '* master'
|
94
|
-
end
|
95
|
-
|
96
|
-
# Inspired by Gollum's Rakefile
|
97
|
-
desc 'Generate release note and create a release branch'
|
98
|
-
task :release => :gem do
|
99
|
-
unless `git branch`.include? '* master'
|
100
|
-
puts 'Master branch required to release.'
|
101
|
-
exit!
|
102
|
-
end
|
103
|
-
|
104
|
-
# ensure gems are installed
|
105
|
-
`bundle update`
|
106
|
-
|
107
|
-
# Commit then pull before pushing.
|
108
|
-
tag_name = "v#{version}"
|
109
|
-
raise 'Tag already exists!' if tag_exists tag_name
|
110
|
-
|
111
|
-
branch_name = "release_#{version.gsub('.', '_')}"
|
112
|
-
sh "git checkout -b #{branch_name}"
|
113
|
-
|
114
|
-
sh "git commit --allow-empty -am 'Release #{version}'"
|
115
|
-
|
116
|
-
# update notes now that there's a new tag
|
117
|
-
Rake::Task['notes'].execute
|
118
|
-
Rake::Task['docs'].execute
|
119
|
-
sh "git commit --allow-empty -am 'Update release notes'"
|
120
|
-
|
121
|
-
puts "Please git push #{branch_name} and send PR, merge it."
|
122
|
-
end
|
123
|
-
|
124
|
-
desc 'Build and release a new gem to rubygems.org'
|
125
|
-
task :publish do
|
126
|
-
unless `git branch`.include? '* master'
|
127
|
-
puts 'Master branch required to release.'
|
128
|
-
exit!
|
129
|
-
end
|
130
|
-
|
131
|
-
sh 'git pull'
|
132
|
-
|
133
|
-
tag_name = "v#{version}"
|
134
|
-
sh "git tag #{tag_name}"
|
135
|
-
sh "git push origin #{tag_name}"
|
136
|
-
|
137
|
-
gem_build
|
138
|
-
sh "gem push #{repo_name}-#{version}.gem"
|
139
|
-
end
|
140
|
-
|
141
|
-
def gem_build
|
142
|
-
`chmod 0600 ~/.gem/credentials`
|
143
|
-
sh "gem build #{repo_name}.gemspec"
|
144
|
-
end
|
145
|
-
|
146
|
-
desc 'Build a new gem'
|
147
|
-
task :gem do
|
148
|
-
gem_build
|
149
|
-
end
|
150
|
-
|
151
|
-
desc 'Build a new gem (same as gem task)'
|
152
|
-
task :build => :gem do
|
153
|
-
end
|
154
|
-
|
155
|
-
desc 'Uninstall gem'
|
156
|
-
task :uninstall do
|
157
|
-
cmd = "gem uninstall -aIx #{repo_name}"
|
158
|
-
# rescue on gem not installed error.
|
159
|
-
begin
|
160
|
-
sh "#{cmd}"
|
161
|
-
rescue
|
162
|
-
# ignored
|
163
|
-
end
|
164
|
-
end
|
165
|
-
|
166
|
-
desc 'Install gem'
|
167
|
-
task :install => [:gem, :uninstall] do
|
168
|
-
sh "gem install --no-rdoc --no-ri --local #{repo_name}-#{version}.gem"
|
169
|
-
end
|
170
|
-
|
171
|
-
desc 'Update android and iOS docs'
|
172
|
-
task :docs do
|
173
|
-
sh 'ruby docs_gen/make_docs.rb'
|
174
|
-
end
|
175
|
-
|
176
|
-
desc 'Update release notes'
|
177
|
-
task :notes do
|
178
|
-
tag_sort = ->(tag1, tag2) do
|
179
|
-
tag1_numbers = tag1.match(/\.?v(\d+\.\d+\.\d+)$/)[1].split('.').map!(&:to_i)
|
180
|
-
tag2_numbers = tag2.match(/\.?v(\d+\.\d+\.\d+)$/)[1].split('.').map!(&:to_i)
|
181
|
-
tag1_numbers <=> tag2_numbers
|
182
|
-
end
|
183
|
-
|
184
|
-
tags = `git tag`.split "\n"
|
185
|
-
tags.sort! &tag_sort
|
186
|
-
pairs = []
|
187
|
-
tags.each_index { |a| pairs.push tags[a] + '...' + tags[a+1] unless tags[a+1].nil? }
|
188
|
-
|
189
|
-
notes = ''
|
190
|
-
|
191
|
-
dates = `git log --tags --simplify-by-decoration --pretty="format:%d %ad" --date=short`.split "\n"
|
192
|
-
|
193
|
-
pairs.sort! &tag_sort
|
194
|
-
pairs.reverse! # pairs are in reverse order.
|
195
|
-
|
196
|
-
tag_date = []
|
197
|
-
pairs.each do |pair|
|
198
|
-
tag = pair.split('...').last
|
199
|
-
dates.each do |line|
|
200
|
-
# regular tag, or tag on master.
|
201
|
-
if line.include?(tag + ')') || line.include?(tag + ',')
|
202
|
-
tag_date.push tag + ' ' + line.match(/\d{4}-\d{2}-\d{2}/)[0]
|
203
|
-
break
|
204
|
-
end
|
205
|
-
end
|
206
|
-
end
|
207
|
-
|
208
|
-
pairs.each_index do |a|
|
209
|
-
data =`git log --pretty=oneline #{pairs[a]}`.force_encoding('UTF-8')
|
210
|
-
new_data = ''
|
211
|
-
data.split("\n").each do |line|
|
212
|
-
hex = line.match(/[a-zA-Z0-9]+/)[0]
|
213
|
-
# use first 7 chars to match GitHub
|
214
|
-
comment = line.gsub(hex, '').strip
|
215
|
-
next if skip_release_note?(comment)
|
216
|
-
|
217
|
-
issue_num = comment.slice(/\(#[0-9]+\)/)
|
218
|
-
# If the issue_num is pull request, GitHub redirects to the pull request.
|
219
|
-
comment_note = if issue_num
|
220
|
-
issue_num.gsub!(/[(#)]/, '')
|
221
|
-
"[#{comment}](https://github.com/appium/#{gh_name}/issues/#{issue_num})"
|
222
|
-
else
|
223
|
-
comment
|
224
|
-
end
|
225
|
-
|
226
|
-
new_data += "- [#{hex[0...7]}](https://github.com/appium/#{gh_name}/commit/#{hex}) #{comment_note}\n"
|
227
|
-
end
|
228
|
-
data = new_data + "\n"
|
229
|
-
|
230
|
-
# last pair is the released version.
|
231
|
-
notes += "#### #{tag_date[a]}\n\n" + data + "\n"
|
232
|
-
end
|
233
|
-
|
234
|
-
File.open('release_notes.md', 'w') { |f| f.write notes.to_s.strip }
|
235
|
-
end
|
236
|
-
|
237
|
-
# Return true if the comment is equal to 'Update release notes'
|
238
|
-
def skip_release_note?(comment)
|
239
|
-
true if comment == 'Update release notes'
|
240
|
-
false
|
241
|
-
end
|
242
|
-
|
243
|
-
# Used to purge byte order marks that mess up YARD
|
244
|
-
def remove_non_ascii
|
245
|
-
Dir.glob('./**/*.rb') do |path|
|
246
|
-
path = File.expand_path path
|
247
|
-
next if File.directory? path
|
248
|
-
|
249
|
-
data = File.read path
|
250
|
-
data = data.encode('US-ASCII', invalid: :replace, undef: :replace, replace: '')
|
251
|
-
data = data.encode('UTF-8')
|
252
|
-
File.open(path, 'w') { |f| f.write data }
|
253
|
-
end
|
254
|
-
end
|
255
|
-
|
256
|
-
desc 'Remove non-ascii bytes'
|
257
|
-
task :byte do
|
258
|
-
remove_non_ascii
|
259
|
-
end
|
260
|
-
|
261
4
|
desc 'Execute RuboCop static code analysis'
|
262
5
|
RuboCop::RakeTask.new(:rubocop) do |t|
|
263
6
|
t.patterns = %w(lib ios_tests android_tests)
|
data/Thorfile
ADDED
@@ -0,0 +1,15 @@
|
|
1
|
+
require 'appium_thor'
|
2
|
+
|
3
|
+
Appium::Thor::Config.set do
|
4
|
+
gem_name 'appium_lib'
|
5
|
+
github_name 'ruby_lib'
|
6
|
+
version_file 'lib/appium_lib/version.rb'
|
7
|
+
docs_block do
|
8
|
+
common_globs = %w(/lib/appium_lib/*.rb /lib/appium_lib/device/*.rb /lib/appium_lib/common/**/*.rb)
|
9
|
+
android_globs = common_globs + %w(/lib/appium_lib/android/**/*.rb)
|
10
|
+
ios_globs = common_globs + %w(/lib/appium_lib/ios/**/*.rb)
|
11
|
+
|
12
|
+
run 'docs/android_docs.md', globs(android_globs)
|
13
|
+
run 'docs/ios_docs.md', globs(ios_globs)
|
14
|
+
end
|
15
|
+
end
|
data/appium_lib.gemspec
CHANGED
@@ -14,10 +14,11 @@ Gem::Specification.new do |s|
|
|
14
14
|
s.homepage = 'https://github.com/appium/ruby_lib' # published as appium_lib
|
15
15
|
s.require_paths = ['lib']
|
16
16
|
|
17
|
-
s.add_runtime_dependency 'appium_lib_core', '~> 2.0
|
17
|
+
s.add_runtime_dependency 'appium_lib_core', '~> 2.0'
|
18
18
|
s.add_runtime_dependency 'nokogiri', '~> 1.8', '>= 1.8.1'
|
19
19
|
s.add_runtime_dependency 'tomlrb', '~> 1.1'
|
20
20
|
|
21
|
+
s.add_development_dependency 'appium_thor', '~> 1.1', '>= 1.1.2'
|
21
22
|
s.add_development_dependency 'fakefs', '~> 0.13.0'
|
22
23
|
s.add_development_dependency 'hashdiff', '~> 0.3.7'
|
23
24
|
s.add_development_dependency 'posix-spawn', '~> 0.3'
|
data/contributing.md
CHANGED
@@ -30,17 +30,6 @@ Android tests require running on physical hardware with Android 5.0 (API 21). Th
|
|
30
30
|
> $ curl -u username https://rubygems.org/api/v1/api_key.yaml >
|
31
31
|
~/.gem/credentials; chmod 0600 ~/.gem/credentials
|
32
32
|
|
33
|
-
1. Bump the version number `
|
34
|
-
2.
|
35
|
-
|
36
|
-
3. Build and publish gem with `rake publish`
|
37
|
-
4. Add release information on GitHub: https://github.com/appium/ruby_lib/releases
|
38
|
-
- Template
|
39
|
-
```
|
40
|
-
### 1. Enhancements
|
41
|
-
|
42
|
-
### 2. Bug fixes
|
43
|
-
|
44
|
-
### 3. Deprecations
|
45
|
-
```
|
46
|
-
|
33
|
+
1. Bump the version number: `thor bump` (`bumpy`, `bumpz`)
|
34
|
+
2. Update `CHANGELOG.md`
|
35
|
+
3. Generate release note, publish release gem and push the tag to this repository: `thor release`
|
data/docs/android_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:__
|
57
|
+
__Returns:__\n\n [Array] list of require files as an array, nil if require doesn't exist
|
72
58
|
|
73
|
-
|
74
|
-
|
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:__
|
242
|
+
__Returns:__\n\n [Driver]
|
317
243
|
|
318
|
-
|
319
|
-
|
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]
|
264
|
+
__Returns:__\n\n [Boolean]
|
351
265
|
|
352
|
-
|
353
|
-
|
354
|
-
##### [device_is_windows?](https://github.com/appium/ruby_lib/blob/c6eb8f5416ccdf75b161bc60c0986caec43d9ff8/lib/appium_lib/driver.rb#L286)
|
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:__
|
361
|
-
|
362
|
-
[Boolean]
|
363
|
-
|
364
|
-
--
|
272
|
+
__Returns:__\n\n [Boolean]
|
365
273
|
|
366
|
-
##### [automation_name_is_uiautomator2?](https://github.com/appium/ruby_lib/blob/
|
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:__
|
280
|
+
__Returns:__\n\n [Boolean]
|
373
281
|
|
374
|
-
|
375
|
-
|
376
|
-
--
|
377
|
-
|
378
|
-
##### [automation_name_is_espresso?](https://github.com/appium/ruby_lib/blob/c6eb8f5416ccdf75b161bc60c0986caec43d9ff8/lib/appium_lib/driver.rb#L298)
|
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:__
|
385
|
-
|
386
|
-
[Boolean]
|
288
|
+
__Returns:__\n\n [Boolean]
|
387
289
|
|
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]
|
323
|
+
__Returns:__\n\n [Boolean]
|
434
324
|
|
435
|
-
|
436
|
-
|
437
|
-
##### [appium_server_version](https://github.com/appium/ruby_lib/blob/c6eb8f5416ccdf75b161bc60c0986caec43d9ff8/lib/appium_lib/driver.rb#L353)
|
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:__
|
444
|
-
|
445
|
-
[Hash]
|
446
|
-
|
447
|
-
--
|
331
|
+
__Returns:__\n\n [Hash]
|
448
332
|
|
449
|
-
##### [remote_status](https://github.com/appium/ruby_lib/blob/
|
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:__
|
339
|
+
__Returns:__\n\n [Hash]
|
456
340
|
|
457
|
-
|
458
|
-
|
459
|
-
--
|
460
|
-
|
461
|
-
##### [platform_version](https://github.com/appium/ruby_lib/blob/c6eb8f5416ccdf75b161bc60c0986caec43d9ff8/lib/appium_lib/driver.rb#L365)
|
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:__
|
468
|
-
|
469
|
-
[Array<Integer>]
|
347
|
+
__Returns:__\n\n [Array<Integer>]
|
470
348
|
|
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
|
376
|
+
__Returns:__\n\n [String] the server url
|
511
377
|
|
512
|
-
|
513
|
-
|
514
|
-
##### [restart](https://github.com/appium/ruby_lib/blob/c6eb8f5416ccdf75b161bc60c0986caec43d9ff8/lib/appium_lib/driver.rb#L417)
|
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:__
|
521
|
-
|
522
|
-
[Driver] the driver
|
523
|
-
|
524
|
-
--
|
384
|
+
__Returns:__\n\n [Driver] the driver
|
525
385
|
|
526
|
-
##### [screenshot](https://github.com/appium/ruby_lib/blob/
|
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:__
|
392
|
+
__Parameters:__\n\n [String] png_save_path - the full path to save the png
|
537
393
|
|
538
|
-
[File]
|
394
|
+
__Returns:__\n\n [File]
|
539
395
|
|
540
|
-
|
541
|
-
|
542
|
-
##### [element_screenshot](https://github.com/appium/ruby_lib/blob/c6eb8f5416ccdf75b161bc60c0986caec43d9ff8/lib/appium_lib/driver.rb#L444)
|
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]
|
569
|
-
|
570
|
-
--
|
414
|
+
__Returns:__\n\n [void]
|
571
415
|
|
572
|
-
##### [quit_driver](https://github.com/appium/ruby_lib/blob/
|
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:__
|
422
|
+
__Returns:__\n\n [void]
|
579
423
|
|
580
|
-
|
581
|
-
|
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
|
609
|
-
|
610
|
-
__Returns:__
|
442
|
+
__Parameters:__\n\n [Hash] http_client_ops - a customizable set of options
|
611
443
|
|
612
|
-
[Selenium::WebDriver] the new global driver
|
444
|
+
__Returns:__\n\n [Selenium::WebDriver] the new global driver
|
613
445
|
|
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:__
|
639
|
-
|
640
|
-
[Integer] timeout - the timeout in seconds
|
641
|
-
|
642
|
-
__Returns:__
|
643
|
-
|
644
|
-
[void]
|
464
|
+
__Parameters:__\n\n [Integer] timeout - the timeout in seconds
|
645
465
|
|
646
|
-
|
466
|
+
__Returns:__\n\n [void]
|
647
467
|
|
648
|
-
##### [exists](https://github.com/appium/ruby_lib/blob/
|
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:__
|
667
|
-
|
668
|
-
[Boolean]
|
669
|
-
|
670
|
-
--
|
484
|
+
__Returns:__\n\n [Boolean]
|
671
485
|
|
672
|
-
##### [execute_script](https://github.com/appium/ruby_lib/blob/
|
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]
|
687
|
-
|
688
|
-
--
|
496
|
+
__Returns:__\n\n [Object]
|
689
497
|
|
690
|
-
##### [execute_async_script](https://github.com/appium/ruby_lib/blob/
|
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
|
781
|
-
|
782
|
-
__Returns:__
|
566
|
+
__Parameters:__\n\n [*args] args - The args to use
|
783
567
|
|
784
|
-
[Array<Element>] Array is empty when no elements are found.
|
568
|
+
__Returns:__\n\n [Array<Element>] Array is empty when no elements are found.
|
785
569
|
|
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]
|
595
|
+
__Returns:__\n\n [::Appium::Core::ImageElement]
|
824
596
|
|
825
|
-
|
826
|
-
|
827
|
-
##### [find_element_by_image](https://github.com/appium/ruby_lib/blob/c6eb8f5416ccdf75b161bc60c0986caec43d9ff8/lib/appium_lib/driver.rb#L691)
|
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:__
|
616
|
+
__Returns:__\n\n [[::Appium::Core::ImageElement]]
|
851
617
|
|
852
|
-
|
853
|
-
|
854
|
-
--
|
855
|
-
|
856
|
-
##### [set_location](https://github.com/appium/ruby_lib/blob/c6eb8f5416ccdf75b161bc60c0986caec43d9ff8/lib/appium_lib/driver.rb#L722)
|
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:__
|
863
|
-
|
864
|
-
[Hash] opts - consisting of:
|
624
|
+
__Parameters:__\n\n [Hash] opts - consisting of:
|
865
625
|
|
866
|
-
__Returns:__
|
626
|
+
__Returns:__\n\n [Selenium::WebDriver::Location] the location constructed by the selenium webdriver
|
867
627
|
|
868
|
-
|
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:__
|
916
|
-
|
917
|
-
[Hash] appium_lib_opts - Appium library parameter
|
918
|
-
|
919
|
-
__Returns:__
|
661
|
+
__Parameters:__\n\n [Hash] appium_lib_opts - Appium library parameter
|
920
662
|
|
921
|
-
[Appium::SauceLabs]
|
663
|
+
__Returns:__\n\n [Appium::SauceLabs]
|
922
664
|
|
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]
|
934
|
-
|
935
|
-
--
|
671
|
+
__Returns:__\n\n [Boolean]
|
936
672
|
|
937
|
-
##### [server_url](https://github.com/appium/ruby_lib/blob/
|
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:__
|
679
|
+
__Returns:__\n\n [String]
|
944
680
|
|
945
|
-
|
946
|
-
|
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.
|
697
|
+
__Returns:__\n\n [[String]] A list of available log types.
|
974
698
|
|
975
|
-
|
976
|
-
|
977
|
-
##### [wait_true](https://github.com/appium/ruby_lib/blob/c6eb8f5416ccdf75b161bc60c0986caec43d9ff8/lib/appium_lib/common/wait.rb#L30)
|
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:__
|
992
|
-
|
993
|
-
[Hash|Numeric] opts - Options. If the value is _Numeric_, the value is set as `{ timeout: value }`
|
994
|
-
|
995
|
-
--
|
713
|
+
__Parameters:__\n\n [Hash|Numeric] opts - Options. If the value is _Numeric_, the value is set as `{ timeout: value }`
|
996
714
|
|
997
|
-
##### [wait](https://github.com/appium/ruby_lib/blob/
|
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:__
|
727
|
+
__Parameters:__\n\n [Hash|Numeric] opts - Options. If the value is _Numeric_, the value is set as `{ timeout: value }`
|
1010
728
|
|
1011
|
-
|
1012
|
-
|
1013
|
-
--
|
1014
|
-
|
1015
|
-
##### [add_touch_actions](https://github.com/appium/ruby_lib/blob/c6eb8f5416ccdf75b161bc60c0986caec43d9ff8/lib/appium_lib/common/device.rb#L12)
|
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]
|
1060
|
-
|
1061
|
-
--
|
761
|
+
__Returns:__\n\n [String]
|
1062
762
|
|
1063
|
-
##### [xpath](https://github.com/appium/ruby_lib/blob/
|
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:__
|
769
|
+
__Parameters:__\n\n [String] xpath_str - the XPath string
|
1070
770
|
|
1071
|
-
[
|
771
|
+
__Returns:__\n\n [Element]
|
1072
772
|
|
1073
|
-
|
1074
|
-
|
1075
|
-
[Element]
|
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:__
|
1090
|
-
|
1091
|
-
[Array<Element>]
|
779
|
+
__Parameters:__\n\n [String] xpath_str - the XPath string
|
1092
780
|
|
1093
|
-
|
781
|
+
__Returns:__\n\n [Array<Element>]
|
1094
782
|
|
1095
|
-
##### [result](https://github.com/appium/ruby_lib/blob/
|
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:__
|
821
|
+
__Returns:__\n\n [String]
|
1146
822
|
|
1147
|
-
|
1148
|
-
|
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]
|
1173
|
-
|
1174
|
-
--
|
838
|
+
__Returns:__\n\n [void]
|
1175
839
|
|
1176
|
-
##### [get_source](https://github.com/appium/ruby_lib/blob/
|
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:__
|
847
|
+
__Returns:__\n\n [String]
|
1184
848
|
|
1185
|
-
|
1186
|
-
|
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:__
|
1204
|
-
|
1205
|
-
[String] target - the target to search for in strings.xml values
|
1206
|
-
|
1207
|
-
__Returns:__
|
1208
|
-
|
1209
|
-
[Array]
|
861
|
+
__Parameters:__\n\n [String] target - the target to search for in strings.xml values
|
1210
862
|
|
1211
|
-
|
863
|
+
__Returns:__\n\n [Array]
|
1212
864
|
|
1213
|
-
##### [xml_values](https://github.com/appium/ruby_lib/blob/
|
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:__
|
871
|
+
__Parameters:__\n\n [String] target - the target to search for in strings.xml keys
|
1220
872
|
|
1221
|
-
[
|
873
|
+
__Returns:__\n\n [Array]
|
1222
874
|
|
1223
|
-
|
1224
|
-
|
1225
|
-
[Array]
|
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:__
|
1240
|
-
|
1241
|
-
[String]
|
881
|
+
__Parameters:__\n\n [String] id - the id to resolve
|
1242
882
|
|
1243
|
-
|
883
|
+
__Returns:__\n\n [String]
|
1244
884
|
|
1245
|
-
##### [filter](https://github.com/appium/ruby_lib/blob/
|
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,243 +964,169 @@ 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
|
993
|
+
__Returns:__\n\n [TouchAction] a new instance of TouchAction
|
1390
994
|
|
1391
|
-
|
1392
|
-
|
1393
|
-
##### [swipe](https://github.com/appium/ruby_lib/blob/c6eb8f5416ccdf75b161bc60c0986caec43d9ff8/lib/appium_lib/common/touch_actions.rb#L52)
|
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/android/android.rb#L19) android
|
1015
|
+
--\n\n##### [for](https://github.com/appium/ruby_lib/blob/621a9ebaf18bcd80eb0e1f5fc17fbb4dddf5293a/lib/appium_lib/android/android.rb#L19) android
|
1422
1016
|
|
1423
1017
|
> def self.for(target)
|
1424
1018
|
|
1425
1019
|
|
1426
1020
|
|
1427
|
-
|
1428
|
-
|
1429
|
-
##### [TextView](https://github.com/appium/ruby_lib/blob/c6eb8f5416ccdf75b161bc60c0986caec43d9ff8/lib/appium_lib/android/element/text.rb#L4) android
|
1021
|
+
--\n\n##### [TextView](https://github.com/appium/ruby_lib/blob/621a9ebaf18bcd80eb0e1f5fc17fbb4dddf5293a/lib/appium_lib/android/element/text.rb#L4) android
|
1430
1022
|
|
1431
1023
|
> TextView = 'android.widget.TextView'.freeze
|
1432
1024
|
|
1433
1025
|
|
1434
1026
|
|
1435
|
-
|
1436
|
-
|
1437
|
-
##### [text](https://github.com/appium/ruby_lib/blob/c6eb8f5416ccdf75b161bc60c0986caec43d9ff8/lib/appium_lib/android/element/text.rb#L10) android
|
1027
|
+
--\n\n##### [text](https://github.com/appium/ruby_lib/blob/621a9ebaf18bcd80eb0e1f5fc17fbb4dddf5293a/lib/appium_lib/android/element/text.rb#L10) android
|
1438
1028
|
|
1439
1029
|
> def text(value)
|
1440
1030
|
|
1441
1031
|
Find the first TextView that contains value or by index.
|
1442
1032
|
If int then the TextView at that index is returned.
|
1443
1033
|
|
1444
|
-
__Parameters:__
|
1445
|
-
|
1446
|
-
[String, Integer] value - the value to find.
|
1447
|
-
|
1448
|
-
__Returns:__
|
1034
|
+
__Parameters:__\n\n [String, Integer] value - the value to find.
|
1449
1035
|
|
1450
|
-
[TextView]
|
1036
|
+
__Returns:__\n\n [TextView]
|
1451
1037
|
|
1452
|
-
|
1453
|
-
|
1454
|
-
##### [texts](https://github.com/appium/ruby_lib/blob/c6eb8f5416ccdf75b161bc60c0986caec43d9ff8/lib/appium_lib/android/element/text.rb#L20) android
|
1038
|
+
--\n\n##### [texts](https://github.com/appium/ruby_lib/blob/621a9ebaf18bcd80eb0e1f5fc17fbb4dddf5293a/lib/appium_lib/android/element/text.rb#L20) android
|
1455
1039
|
|
1456
1040
|
> def texts(value = false)
|
1457
1041
|
|
1458
1042
|
Find all TextViews containing value.
|
1459
1043
|
If value is omitted, all texts are returned.
|
1460
1044
|
|
1461
|
-
__Parameters:__
|
1462
|
-
|
1463
|
-
[String] value - the value to search for
|
1464
|
-
|
1465
|
-
__Returns:__
|
1466
|
-
|
1467
|
-
[Array<TextView>]
|
1045
|
+
__Parameters:__\n\n [String] value - the value to search for
|
1468
1046
|
|
1469
|
-
|
1047
|
+
__Returns:__\n\n [Array<TextView>]
|
1470
1048
|
|
1471
|
-
##### [first_text](https://github.com/appium/ruby_lib/blob/
|
1049
|
+
--\n\n##### [first_text](https://github.com/appium/ruby_lib/blob/621a9ebaf18bcd80eb0e1f5fc17fbb4dddf5293a/lib/appium_lib/android/element/text.rb#L28) android
|
1472
1050
|
|
1473
1051
|
> def first_text
|
1474
1052
|
|
1475
1053
|
Find the first TextView.
|
1476
1054
|
|
1477
|
-
__Returns:__
|
1478
|
-
|
1479
|
-
[TextView]
|
1055
|
+
__Returns:__\n\n [TextView]
|
1480
1056
|
|
1481
|
-
|
1482
|
-
|
1483
|
-
##### [last_text](https://github.com/appium/ruby_lib/blob/c6eb8f5416ccdf75b161bc60c0986caec43d9ff8/lib/appium_lib/android/element/text.rb#L34) android
|
1057
|
+
--\n\n##### [last_text](https://github.com/appium/ruby_lib/blob/621a9ebaf18bcd80eb0e1f5fc17fbb4dddf5293a/lib/appium_lib/android/element/text.rb#L34) android
|
1484
1058
|
|
1485
1059
|
> def last_text
|
1486
1060
|
|
1487
1061
|
Find the last TextView.
|
1488
1062
|
|
1489
|
-
__Returns:__
|
1490
|
-
|
1491
|
-
[TextView]
|
1492
|
-
|
1493
|
-
--
|
1063
|
+
__Returns:__\n\n [TextView]
|
1494
1064
|
|
1495
|
-
##### [text_exact](https://github.com/appium/ruby_lib/blob/
|
1065
|
+
--\n\n##### [text_exact](https://github.com/appium/ruby_lib/blob/621a9ebaf18bcd80eb0e1f5fc17fbb4dddf5293a/lib/appium_lib/android/element/text.rb#L41) android
|
1496
1066
|
|
1497
1067
|
> def text_exact(value)
|
1498
1068
|
|
1499
1069
|
Find the first TextView that exactly matches value.
|
1500
1070
|
|
1501
|
-
__Parameters:__
|
1071
|
+
__Parameters:__\n\n [String] value - the value to match exactly
|
1502
1072
|
|
1503
|
-
[
|
1073
|
+
__Returns:__\n\n [TextView]
|
1504
1074
|
|
1505
|
-
|
1506
|
-
|
1507
|
-
[TextView]
|
1508
|
-
|
1509
|
-
--
|
1510
|
-
|
1511
|
-
##### [texts_exact](https://github.com/appium/ruby_lib/blob/c6eb8f5416ccdf75b161bc60c0986caec43d9ff8/lib/appium_lib/android/element/text.rb#L48) android
|
1075
|
+
--\n\n##### [texts_exact](https://github.com/appium/ruby_lib/blob/621a9ebaf18bcd80eb0e1f5fc17fbb4dddf5293a/lib/appium_lib/android/element/text.rb#L48) android
|
1512
1076
|
|
1513
1077
|
> def texts_exact(value)
|
1514
1078
|
|
1515
1079
|
Find all TextViews that exactly match value.
|
1516
1080
|
|
1517
|
-
__Parameters:__
|
1518
|
-
|
1519
|
-
[String] value - the value to match exactly
|
1520
|
-
|
1521
|
-
__Returns:__
|
1522
|
-
|
1523
|
-
[Array<TextView>]
|
1081
|
+
__Parameters:__\n\n [String] value - the value to match exactly
|
1524
1082
|
|
1525
|
-
|
1083
|
+
__Returns:__\n\n [Array<TextView>]
|
1526
1084
|
|
1527
|
-
##### [result](https://github.com/appium/ruby_lib/blob/
|
1085
|
+
--\n\n##### [result](https://github.com/appium/ruby_lib/blob/621a9ebaf18bcd80eb0e1f5fc17fbb4dddf5293a/lib/appium_lib/android/common/helper.rb#L6) android
|
1528
1086
|
|
1529
1087
|
> def result
|
1530
1088
|
|
1531
1089
|
Returns the value of attribute result
|
1532
1090
|
|
1533
|
-
|
1534
|
-
|
1535
|
-
##### [keys](https://github.com/appium/ruby_lib/blob/c6eb8f5416ccdf75b161bc60c0986caec43d9ff8/lib/appium_lib/android/common/helper.rb#L6) android
|
1091
|
+
--\n\n##### [keys](https://github.com/appium/ruby_lib/blob/621a9ebaf18bcd80eb0e1f5fc17fbb4dddf5293a/lib/appium_lib/android/common/helper.rb#L6) android
|
1536
1092
|
|
1537
1093
|
> def keys
|
1538
1094
|
|
1539
1095
|
Returns the value of attribute keys
|
1540
1096
|
|
1541
|
-
|
1542
|
-
|
1543
|
-
##### [filter](https://github.com/appium/ruby_lib/blob/c6eb8f5416ccdf75b161bc60c0986caec43d9ff8/lib/appium_lib/android/common/helper.rb#L6) android
|
1097
|
+
--\n\n##### [filter](https://github.com/appium/ruby_lib/blob/621a9ebaf18bcd80eb0e1f5fc17fbb4dddf5293a/lib/appium_lib/android/common/helper.rb#L6) android
|
1544
1098
|
|
1545
1099
|
> def filter
|
1546
1100
|
|
1547
1101
|
Returns the value of attribute filter
|
1548
1102
|
|
1549
|
-
|
1550
|
-
|
1551
|
-
##### [filter=](https://github.com/appium/ruby_lib/blob/c6eb8f5416ccdf75b161bc60c0986caec43d9ff8/lib/appium_lib/android/common/helper.rb#L9) android
|
1103
|
+
--\n\n##### [filter=](https://github.com/appium/ruby_lib/blob/621a9ebaf18bcd80eb0e1f5fc17fbb4dddf5293a/lib/appium_lib/android/common/helper.rb#L9) android
|
1552
1104
|
|
1553
1105
|
> def filter=(value)
|
1554
1106
|
|
1555
1107
|
convert to string to support symbols
|
1556
1108
|
|
1557
|
-
|
1558
|
-
|
1559
|
-
##### [initialize](https://github.com/appium/ruby_lib/blob/c6eb8f5416ccdf75b161bc60c0986caec43d9ff8/lib/appium_lib/android/common/helper.rb#L16) android
|
1109
|
+
--\n\n##### [initialize](https://github.com/appium/ruby_lib/blob/621a9ebaf18bcd80eb0e1f5fc17fbb4dddf5293a/lib/appium_lib/android/common/helper.rb#L16) android
|
1560
1110
|
|
1561
1111
|
> def initialize
|
1562
1112
|
|
1563
1113
|
|
1564
1114
|
|
1565
|
-
__Returns:__
|
1566
|
-
|
1567
|
-
[AndroidElements] a new instance of AndroidElements
|
1568
|
-
|
1569
|
-
--
|
1115
|
+
__Returns:__\n\n [AndroidElements] a new instance of AndroidElements
|
1570
1116
|
|
1571
|
-
##### [reset](https://github.com/appium/ruby_lib/blob/
|
1117
|
+
--\n\n##### [reset](https://github.com/appium/ruby_lib/blob/621a9ebaf18bcd80eb0e1f5fc17fbb4dddf5293a/lib/appium_lib/android/common/helper.rb#L21) android
|
1572
1118
|
|
1573
1119
|
> def reset
|
1574
1120
|
|
1575
1121
|
|
1576
1122
|
|
1577
|
-
|
1578
|
-
|
1579
|
-
##### [start_element](https://github.com/appium/ruby_lib/blob/c6eb8f5416ccdf75b161bc60c0986caec43d9ff8/lib/appium_lib/android/common/helper.rb#L27) android
|
1123
|
+
--\n\n##### [start_element](https://github.com/appium/ruby_lib/blob/621a9ebaf18bcd80eb0e1f5fc17fbb4dddf5293a/lib/appium_lib/android/common/helper.rb#L27) android
|
1580
1124
|
|
1581
1125
|
> def start_element(name, attrs = [], driver = $driver)
|
1582
1126
|
|
1583
1127
|
http://nokogiri.org/Nokogiri/XML/SAX/Document.html
|
1584
1128
|
|
1585
|
-
|
1586
|
-
|
1587
|
-
##### [get_android_inspect](https://github.com/appium/ruby_lib/blob/c6eb8f5416ccdf75b161bc60c0986caec43d9ff8/lib/appium_lib/android/common/helper.rb#L81) android
|
1129
|
+
--\n\n##### [get_android_inspect](https://github.com/appium/ruby_lib/blob/621a9ebaf18bcd80eb0e1f5fc17fbb4dddf5293a/lib/appium_lib/android/common/helper.rb#L81) android
|
1588
1130
|
|
1589
1131
|
> def get_android_inspect(class_name = false)
|
1590
1132
|
|
@@ -1593,17 +1135,11 @@ Returns a string containing interesting elements.
|
|
1593
1135
|
The text, content description, and id are returned.
|
1594
1136
|
if false (default) then all classes will be inspected
|
1595
1137
|
|
1596
|
-
__Parameters:__
|
1597
|
-
|
1598
|
-
[String] class_name - the class name to filter on.
|
1138
|
+
__Parameters:__\n\n [String] class_name - the class name to filter on.
|
1599
1139
|
|
1600
|
-
__Returns:__
|
1140
|
+
__Returns:__\n\n [String]
|
1601
1141
|
|
1602
|
-
|
1603
|
-
|
1604
|
-
--
|
1605
|
-
|
1606
|
-
##### [page](https://github.com/appium/ruby_lib/blob/c6eb8f5416ccdf75b161bc60c0986caec43d9ff8/lib/appium_lib/android/common/helper.rb#L107) android
|
1142
|
+
--\n\n##### [page](https://github.com/appium/ruby_lib/blob/621a9ebaf18bcd80eb0e1f5fc17fbb4dddf5293a/lib/appium_lib/android/common/helper.rb#L107) android
|
1607
1143
|
|
1608
1144
|
> def page(opts = {})
|
1609
1145
|
|
@@ -1612,131 +1148,83 @@ Inspects and prints the current page.
|
|
1612
1148
|
Will return XHTML for Web contexts because of a quirk with Nokogiri.
|
1613
1149
|
if nil (default) then all classes will be inspected
|
1614
1150
|
|
1615
|
-
__Parameters:__
|
1616
|
-
|
1617
|
-
[Hash] class - a customizable set of options
|
1151
|
+
__Parameters:__\n\n [Hash] class - a customizable set of options
|
1618
1152
|
|
1619
|
-
__Returns:__
|
1153
|
+
__Returns:__\n\n [void]
|
1620
1154
|
|
1621
|
-
|
1622
|
-
|
1623
|
-
--
|
1624
|
-
|
1625
|
-
##### [id](https://github.com/appium/ruby_lib/blob/c6eb8f5416ccdf75b161bc60c0986caec43d9ff8/lib/appium_lib/android/common/helper.rb#L116) android
|
1155
|
+
--\n\n##### [id](https://github.com/appium/ruby_lib/blob/621a9ebaf18bcd80eb0e1f5fc17fbb4dddf5293a/lib/appium_lib/android/common/helper.rb#L116) android
|
1626
1156
|
|
1627
1157
|
> def id(id)
|
1628
1158
|
|
1629
1159
|
Find the first matching element by id
|
1630
1160
|
|
1631
|
-
__Parameters:__
|
1632
|
-
|
1633
|
-
[String] id - the id to search for
|
1161
|
+
__Parameters:__\n\n [String] id - the id to search for
|
1634
1162
|
|
1635
|
-
__Returns:__
|
1163
|
+
__Returns:__\n\n [Element]
|
1636
1164
|
|
1637
|
-
|
1638
|
-
|
1639
|
-
--
|
1640
|
-
|
1641
|
-
##### [ids](https://github.com/appium/ruby_lib/blob/c6eb8f5416ccdf75b161bc60c0986caec43d9ff8/lib/appium_lib/android/common/helper.rb#L124) android
|
1165
|
+
--\n\n##### [ids](https://github.com/appium/ruby_lib/blob/621a9ebaf18bcd80eb0e1f5fc17fbb4dddf5293a/lib/appium_lib/android/common/helper.rb#L124) android
|
1642
1166
|
|
1643
1167
|
> def ids(id)
|
1644
1168
|
|
1645
1169
|
Find all matching elements by id
|
1646
1170
|
|
1647
|
-
__Parameters:__
|
1648
|
-
|
1649
|
-
[String] id - the id to search for
|
1171
|
+
__Parameters:__\n\n [String] id - the id to search for
|
1650
1172
|
|
1651
|
-
__Returns:__
|
1173
|
+
__Returns:__\n\n [Element]
|
1652
1174
|
|
1653
|
-
|
1654
|
-
|
1655
|
-
--
|
1656
|
-
|
1657
|
-
##### [ele_index](https://github.com/appium/ruby_lib/blob/c6eb8f5416ccdf75b161bc60c0986caec43d9ff8/lib/appium_lib/android/common/helper.rb#L133) android
|
1175
|
+
--\n\n##### [ele_index](https://github.com/appium/ruby_lib/blob/621a9ebaf18bcd80eb0e1f5fc17fbb4dddf5293a/lib/appium_lib/android/common/helper.rb#L133) android
|
1658
1176
|
|
1659
1177
|
> def ele_index(class_name, index)
|
1660
1178
|
|
1661
1179
|
Find the element of type class_name at matching index.
|
1662
1180
|
|
1663
|
-
__Parameters:__
|
1664
|
-
|
1665
|
-
[String] class_name - the class name to find
|
1181
|
+
__Parameters:__\n\n [String] class_name - the class name to find
|
1666
1182
|
|
1667
1183
|
[Integer] index - the index
|
1668
1184
|
|
1669
|
-
__Returns:__
|
1185
|
+
__Returns:__\n\n [Element] the found element of type class_name
|
1670
1186
|
|
1671
|
-
|
1672
|
-
|
1673
|
-
--
|
1674
|
-
|
1675
|
-
##### [first_ele](https://github.com/appium/ruby_lib/blob/c6eb8f5416ccdf75b161bc60c0986caec43d9ff8/lib/appium_lib/android/common/helper.rb#L152) android
|
1187
|
+
--\n\n##### [first_ele](https://github.com/appium/ruby_lib/blob/621a9ebaf18bcd80eb0e1f5fc17fbb4dddf5293a/lib/appium_lib/android/common/helper.rb#L152) android
|
1676
1188
|
|
1677
1189
|
> def first_ele(class_name)
|
1678
1190
|
|
1679
1191
|
Find the first element that matches class_name
|
1680
1192
|
|
1681
|
-
__Parameters:__
|
1682
|
-
|
1683
|
-
[String] class_name - the tag to match
|
1193
|
+
__Parameters:__\n\n [String] class_name - the tag to match
|
1684
1194
|
|
1685
|
-
__Returns:__
|
1195
|
+
__Returns:__\n\n [Element]
|
1686
1196
|
|
1687
|
-
|
1688
|
-
|
1689
|
-
--
|
1690
|
-
|
1691
|
-
##### [last_ele](https://github.com/appium/ruby_lib/blob/c6eb8f5416ccdf75b161bc60c0986caec43d9ff8/lib/appium_lib/android/common/helper.rb#L159) android
|
1197
|
+
--\n\n##### [last_ele](https://github.com/appium/ruby_lib/blob/621a9ebaf18bcd80eb0e1f5fc17fbb4dddf5293a/lib/appium_lib/android/common/helper.rb#L159) android
|
1692
1198
|
|
1693
1199
|
> def last_ele(class_name)
|
1694
1200
|
|
1695
1201
|
Find the last element that matches class_name
|
1696
1202
|
|
1697
|
-
__Parameters:__
|
1698
|
-
|
1699
|
-
[String] class_name - the tag to match
|
1203
|
+
__Parameters:__\n\n [String] class_name - the tag to match
|
1700
1204
|
|
1701
|
-
__Returns:__
|
1205
|
+
__Returns:__\n\n [Element]
|
1702
1206
|
|
1703
|
-
|
1704
|
-
|
1705
|
-
--
|
1706
|
-
|
1707
|
-
##### [tag](https://github.com/appium/ruby_lib/blob/c6eb8f5416ccdf75b161bc60c0986caec43d9ff8/lib/appium_lib/android/common/helper.rb#L167) android
|
1207
|
+
--\n\n##### [tag](https://github.com/appium/ruby_lib/blob/621a9ebaf18bcd80eb0e1f5fc17fbb4dddf5293a/lib/appium_lib/android/common/helper.rb#L167) android
|
1708
1208
|
|
1709
1209
|
> def tag(class_name)
|
1710
1210
|
|
1711
1211
|
Find the first element of type class_name
|
1712
1212
|
|
1713
|
-
__Parameters:__
|
1714
|
-
|
1715
|
-
[String] class_name - the class_name to search for
|
1213
|
+
__Parameters:__\n\n [String] class_name - the class_name to search for
|
1716
1214
|
|
1717
|
-
__Returns:__
|
1215
|
+
__Returns:__\n\n [Element]
|
1718
1216
|
|
1719
|
-
|
1720
|
-
|
1721
|
-
--
|
1722
|
-
|
1723
|
-
##### [tags](https://github.com/appium/ruby_lib/blob/c6eb8f5416ccdf75b161bc60c0986caec43d9ff8/lib/appium_lib/android/common/helper.rb#L175) android
|
1217
|
+
--\n\n##### [tags](https://github.com/appium/ruby_lib/blob/621a9ebaf18bcd80eb0e1f5fc17fbb4dddf5293a/lib/appium_lib/android/common/helper.rb#L175) android
|
1724
1218
|
|
1725
1219
|
> def tags(class_name)
|
1726
1220
|
|
1727
1221
|
Find all elements of type class_name
|
1728
1222
|
|
1729
|
-
__Parameters:__
|
1730
|
-
|
1731
|
-
[String] class_name - the class_name to search for
|
1223
|
+
__Parameters:__\n\n [String] class_name - the class_name to search for
|
1732
1224
|
|
1733
|
-
__Returns:__
|
1225
|
+
__Returns:__\n\n [Element]
|
1734
1226
|
|
1735
|
-
|
1736
|
-
|
1737
|
-
--
|
1738
|
-
|
1739
|
-
##### [string_visible_contains_xpath](https://github.com/appium/ruby_lib/blob/c6eb8f5416ccdf75b161bc60c0986caec43d9ff8/lib/appium_lib/android/common/helper.rb#L218) android
|
1227
|
+
--\n\n##### [string_visible_contains_xpath](https://github.com/appium/ruby_lib/blob/621a9ebaf18bcd80eb0e1f5fc17fbb4dddf5293a/lib/appium_lib/android/common/helper.rb#L218) android
|
1740
1228
|
|
1741
1229
|
> def string_visible_contains_xpath(class_name, value)
|
1742
1230
|
|
@@ -1745,19 +1233,13 @@ For automationName is uiautomator2
|
|
1745
1233
|
example: string_visible_contains_xpath 'UIATextField', 'sign in'
|
1746
1234
|
note for XPath: https://github.com/appium/ruby_lib/pull/561
|
1747
1235
|
|
1748
|
-
__Parameters:__
|
1749
|
-
|
1750
|
-
[String] class_name - the class name for the element
|
1236
|
+
__Parameters:__\n\n [String] class_name - the class name for the element
|
1751
1237
|
|
1752
1238
|
[String] value - the value to search for
|
1753
1239
|
|
1754
|
-
__Returns:__
|
1240
|
+
__Returns:__\n\n [String]
|
1755
1241
|
|
1756
|
-
|
1757
|
-
|
1758
|
-
--
|
1759
|
-
|
1760
|
-
##### [string_visible_contains](https://github.com/appium/ruby_lib/blob/c6eb8f5416ccdf75b161bc60c0986caec43d9ff8/lib/appium_lib/android/common/helper.rb#L238) android
|
1242
|
+
--\n\n##### [string_visible_contains](https://github.com/appium/ruby_lib/blob/621a9ebaf18bcd80eb0e1f5fc17fbb4dddf5293a/lib/appium_lib/android/common/helper.rb#L238) android
|
1761
1243
|
|
1762
1244
|
> def string_visible_contains(class_name, value)
|
1763
1245
|
|
@@ -1766,479 +1248,317 @@ For automationName is Appium
|
|
1766
1248
|
example: string_visible_contains 'UIATextField', 'sign in'
|
1767
1249
|
note for XPath: https://github.com/appium/ruby_lib/pull/561
|
1768
1250
|
|
1769
|
-
__Parameters:__
|
1770
|
-
|
1771
|
-
[String] class_name - the class name for the element
|
1251
|
+
__Parameters:__\n\n [String] class_name - the class name for the element
|
1772
1252
|
|
1773
1253
|
[String] value - the value to search for
|
1774
1254
|
|
1775
|
-
__Returns:__
|
1255
|
+
__Returns:__\n\n [String]
|
1776
1256
|
|
1777
|
-
|
1778
|
-
|
1779
|
-
--
|
1780
|
-
|
1781
|
-
##### [complex_find_contains](https://github.com/appium/ruby_lib/blob/c6eb8f5416ccdf75b161bc60c0986caec43d9ff8/lib/appium_lib/android/common/helper.rb#L256) android
|
1257
|
+
--\n\n##### [complex_find_contains](https://github.com/appium/ruby_lib/blob/621a9ebaf18bcd80eb0e1f5fc17fbb4dddf5293a/lib/appium_lib/android/common/helper.rb#L256) android
|
1782
1258
|
|
1783
1259
|
> def complex_find_contains(class_name, value)
|
1784
1260
|
|
1785
1261
|
Find the first element that contains value
|
1786
1262
|
|
1787
|
-
__Parameters:__
|
1788
|
-
|
1789
|
-
[String] class_name - the class name for the element
|
1263
|
+
__Parameters:__\n\n [String] class_name - the class name for the element
|
1790
1264
|
|
1791
1265
|
[String] value - the value to search for
|
1792
1266
|
|
1793
|
-
__Returns:__
|
1267
|
+
__Returns:__\n\n [Element]
|
1794
1268
|
|
1795
|
-
|
1796
|
-
|
1797
|
-
--
|
1798
|
-
|
1799
|
-
##### [complex_finds_contains](https://github.com/appium/ruby_lib/blob/c6eb8f5416ccdf75b161bc60c0986caec43d9ff8/lib/appium_lib/android/common/helper.rb#L264) android
|
1269
|
+
--\n\n##### [complex_finds_contains](https://github.com/appium/ruby_lib/blob/621a9ebaf18bcd80eb0e1f5fc17fbb4dddf5293a/lib/appium_lib/android/common/helper.rb#L264) android
|
1800
1270
|
|
1801
1271
|
> def complex_finds_contains(class_name, value)
|
1802
1272
|
|
1803
1273
|
Find all elements containing value
|
1804
1274
|
|
1805
|
-
__Parameters:__
|
1806
|
-
|
1807
|
-
[String] class_name - the class name for the element
|
1275
|
+
__Parameters:__\n\n [String] class_name - the class name for the element
|
1808
1276
|
|
1809
1277
|
[String] value - the value to search for
|
1810
1278
|
|
1811
|
-
__Returns:__
|
1279
|
+
__Returns:__\n\n [Array<Element>]
|
1812
1280
|
|
1813
|
-
|
1814
|
-
|
1815
|
-
--
|
1816
|
-
|
1817
|
-
##### [complex_find_exact](https://github.com/appium/ruby_lib/blob/c6eb8f5416ccdf75b161bc60c0986caec43d9ff8/lib/appium_lib/android/common/helper.rb#L306) android
|
1281
|
+
--\n\n##### [complex_find_exact](https://github.com/appium/ruby_lib/blob/621a9ebaf18bcd80eb0e1f5fc17fbb4dddf5293a/lib/appium_lib/android/common/helper.rb#L306) android
|
1818
1282
|
|
1819
1283
|
> def complex_find_exact(class_name, value)
|
1820
1284
|
|
1821
1285
|
Find the first element exactly matching value
|
1822
1286
|
|
1823
|
-
__Parameters:__
|
1824
|
-
|
1825
|
-
[String] class_name - the class name for the element
|
1287
|
+
__Parameters:__\n\n [String] class_name - the class name for the element
|
1826
1288
|
|
1827
1289
|
[String] value - the value to search for
|
1828
1290
|
|
1829
|
-
__Returns:__
|
1291
|
+
__Returns:__\n\n [Element]
|
1830
1292
|
|
1831
|
-
|
1832
|
-
|
1833
|
-
--
|
1834
|
-
|
1835
|
-
##### [complex_finds_exact](https://github.com/appium/ruby_lib/blob/c6eb8f5416ccdf75b161bc60c0986caec43d9ff8/lib/appium_lib/android/common/helper.rb#L314) android
|
1293
|
+
--\n\n##### [complex_finds_exact](https://github.com/appium/ruby_lib/blob/621a9ebaf18bcd80eb0e1f5fc17fbb4dddf5293a/lib/appium_lib/android/common/helper.rb#L314) android
|
1836
1294
|
|
1837
1295
|
> def complex_finds_exact(class_name, value)
|
1838
1296
|
|
1839
1297
|
Find all elements exactly matching value
|
1840
1298
|
|
1841
|
-
__Parameters:__
|
1842
|
-
|
1843
|
-
[String] class_name - the class name for the element
|
1299
|
+
__Parameters:__\n\n [String] class_name - the class name for the element
|
1844
1300
|
|
1845
1301
|
[String] value - the value to search for
|
1846
1302
|
|
1847
|
-
__Returns:__
|
1303
|
+
__Returns:__\n\n [Element]
|
1848
1304
|
|
1849
|
-
|
1850
|
-
|
1851
|
-
--
|
1852
|
-
|
1853
|
-
##### [alert_click](https://github.com/appium/ruby_lib/blob/c6eb8f5416ccdf75b161bc60c0986caec43d9ff8/lib/appium_lib/android/element/alert.rb#L6) android
|
1305
|
+
--\n\n##### [alert_click](https://github.com/appium/ruby_lib/blob/621a9ebaf18bcd80eb0e1f5fc17fbb4dddf5293a/lib/appium_lib/android/element/alert.rb#L6) android
|
1854
1306
|
|
1855
1307
|
> def alert_click(value)
|
1856
1308
|
|
1857
1309
|
Click the first alert button that contains value or by index.
|
1858
1310
|
|
1859
|
-
__Parameters:__
|
1860
|
-
|
1861
|
-
[Integer, String] value - either an integer index of the button or the button's name
|
1311
|
+
__Parameters:__\n\n [Integer, String] value - either an integer index of the button or the button's name
|
1862
1312
|
|
1863
|
-
__Returns:__
|
1313
|
+
__Returns:__\n\n [void]
|
1864
1314
|
|
1865
|
-
|
1866
|
-
|
1867
|
-
--
|
1868
|
-
|
1869
|
-
##### [alert_accept](https://github.com/appium/ruby_lib/blob/c6eb8f5416ccdf75b161bc60c0986caec43d9ff8/lib/appium_lib/android/element/alert.rb#L13) android
|
1315
|
+
--\n\n##### [alert_accept](https://github.com/appium/ruby_lib/blob/621a9ebaf18bcd80eb0e1f5fc17fbb4dddf5293a/lib/appium_lib/android/element/alert.rb#L13) android
|
1870
1316
|
|
1871
1317
|
> def alert_accept
|
1872
1318
|
|
1873
1319
|
Accept the alert.
|
1874
1320
|
The last button is considered "accept."
|
1875
1321
|
|
1876
|
-
__Returns:__
|
1877
|
-
|
1878
|
-
[void]
|
1322
|
+
__Returns:__\n\n [void]
|
1879
1323
|
|
1880
|
-
|
1881
|
-
|
1882
|
-
##### [alert_accept_text](https://github.com/appium/ruby_lib/blob/c6eb8f5416ccdf75b161bc60c0986caec43d9ff8/lib/appium_lib/android/element/alert.rb#L20) android
|
1324
|
+
--\n\n##### [alert_accept_text](https://github.com/appium/ruby_lib/blob/621a9ebaf18bcd80eb0e1f5fc17fbb4dddf5293a/lib/appium_lib/android/element/alert.rb#L20) android
|
1883
1325
|
|
1884
1326
|
> def alert_accept_text
|
1885
1327
|
|
1886
1328
|
Get the text of the alert's accept button.
|
1887
1329
|
The last button is considered "accept."
|
1888
1330
|
|
1889
|
-
__Returns:__
|
1890
|
-
|
1891
|
-
[String]
|
1892
|
-
|
1893
|
-
--
|
1331
|
+
__Returns:__\n\n [String]
|
1894
1332
|
|
1895
|
-
##### [alert_dismiss](https://github.com/appium/ruby_lib/blob/
|
1333
|
+
--\n\n##### [alert_dismiss](https://github.com/appium/ruby_lib/blob/621a9ebaf18bcd80eb0e1f5fc17fbb4dddf5293a/lib/appium_lib/android/element/alert.rb#L27) android
|
1896
1334
|
|
1897
1335
|
> def alert_dismiss
|
1898
1336
|
|
1899
1337
|
Dismiss the alert.
|
1900
1338
|
The first button is considered "dismiss."
|
1901
1339
|
|
1902
|
-
__Returns:__
|
1340
|
+
__Returns:__\n\n [void]
|
1903
1341
|
|
1904
|
-
|
1905
|
-
|
1906
|
-
--
|
1907
|
-
|
1908
|
-
##### [alert_dismiss_text](https://github.com/appium/ruby_lib/blob/c6eb8f5416ccdf75b161bc60c0986caec43d9ff8/lib/appium_lib/android/element/alert.rb#L34) android
|
1342
|
+
--\n\n##### [alert_dismiss_text](https://github.com/appium/ruby_lib/blob/621a9ebaf18bcd80eb0e1f5fc17fbb4dddf5293a/lib/appium_lib/android/element/alert.rb#L34) android
|
1909
1343
|
|
1910
1344
|
> def alert_dismiss_text
|
1911
1345
|
|
1912
1346
|
Get the text of the alert's dismiss button.
|
1913
1347
|
The first button is considered "dismiss."
|
1914
1348
|
|
1915
|
-
__Returns:__
|
1916
|
-
|
1917
|
-
[String]
|
1349
|
+
__Returns:__\n\n [String]
|
1918
1350
|
|
1919
|
-
|
1920
|
-
|
1921
|
-
##### [Button](https://github.com/appium/ruby_lib/blob/c6eb8f5416ccdf75b161bc60c0986caec43d9ff8/lib/appium_lib/android/element/button.rb#L3) android
|
1351
|
+
--\n\n##### [Button](https://github.com/appium/ruby_lib/blob/621a9ebaf18bcd80eb0e1f5fc17fbb4dddf5293a/lib/appium_lib/android/element/button.rb#L3) android
|
1922
1352
|
|
1923
1353
|
> Button = 'android.widget.Button'.freeze
|
1924
1354
|
|
1925
1355
|
|
1926
1356
|
|
1927
|
-
|
1928
|
-
|
1929
|
-
##### [ImageButton](https://github.com/appium/ruby_lib/blob/c6eb8f5416ccdf75b161bc60c0986caec43d9ff8/lib/appium_lib/android/element/button.rb#L4) android
|
1357
|
+
--\n\n##### [ImageButton](https://github.com/appium/ruby_lib/blob/621a9ebaf18bcd80eb0e1f5fc17fbb4dddf5293a/lib/appium_lib/android/element/button.rb#L4) android
|
1930
1358
|
|
1931
1359
|
> ImageButton = 'android.widget.ImageButton'.freeze
|
1932
1360
|
|
1933
1361
|
|
1934
1362
|
|
1935
|
-
|
1936
|
-
|
1937
|
-
##### [button](https://github.com/appium/ruby_lib/blob/c6eb8f5416ccdf75b161bc60c0986caec43d9ff8/lib/appium_lib/android/element/button.rb#L10) android
|
1363
|
+
--\n\n##### [button](https://github.com/appium/ruby_lib/blob/621a9ebaf18bcd80eb0e1f5fc17fbb4dddf5293a/lib/appium_lib/android/element/button.rb#L10) android
|
1938
1364
|
|
1939
1365
|
> def button(value)
|
1940
1366
|
|
1941
1367
|
Find the first button that contains value or by index.
|
1942
1368
|
If int then the button at that index is returned.
|
1943
1369
|
|
1944
|
-
__Parameters:__
|
1370
|
+
__Parameters:__\n\n [String, Integer] value - the value to exactly match.
|
1945
1371
|
|
1946
|
-
[
|
1372
|
+
__Returns:__\n\n [Button]
|
1947
1373
|
|
1948
|
-
|
1949
|
-
|
1950
|
-
[Button]
|
1951
|
-
|
1952
|
-
--
|
1953
|
-
|
1954
|
-
##### [buttons](https://github.com/appium/ruby_lib/blob/c6eb8f5416ccdf75b161bc60c0986caec43d9ff8/lib/appium_lib/android/element/button.rb#L27) android
|
1374
|
+
--\n\n##### [buttons](https://github.com/appium/ruby_lib/blob/621a9ebaf18bcd80eb0e1f5fc17fbb4dddf5293a/lib/appium_lib/android/element/button.rb#L27) android
|
1955
1375
|
|
1956
1376
|
> def buttons(value = false)
|
1957
1377
|
|
1958
1378
|
Find all buttons containing value.
|
1959
1379
|
If value is omitted, all buttons are returned.
|
1960
1380
|
|
1961
|
-
__Parameters:__
|
1962
|
-
|
1963
|
-
[String] value - the value to search for
|
1964
|
-
|
1965
|
-
__Returns:__
|
1381
|
+
__Parameters:__\n\n [String] value - the value to search for
|
1966
1382
|
|
1967
|
-
[Array<Button>]
|
1383
|
+
__Returns:__\n\n [Array<Button>]
|
1968
1384
|
|
1969
|
-
|
1970
|
-
|
1971
|
-
##### [first_button](https://github.com/appium/ruby_lib/blob/c6eb8f5416ccdf75b161bc60c0986caec43d9ff8/lib/appium_lib/android/element/button.rb#L35) android
|
1385
|
+
--\n\n##### [first_button](https://github.com/appium/ruby_lib/blob/621a9ebaf18bcd80eb0e1f5fc17fbb4dddf5293a/lib/appium_lib/android/element/button.rb#L35) android
|
1972
1386
|
|
1973
1387
|
> def first_button
|
1974
1388
|
|
1975
1389
|
Find the first button.
|
1976
1390
|
|
1977
|
-
__Returns:__
|
1978
|
-
|
1979
|
-
[Button]
|
1980
|
-
|
1981
|
-
--
|
1391
|
+
__Returns:__\n\n [Button]
|
1982
1392
|
|
1983
|
-
##### [last_button](https://github.com/appium/ruby_lib/blob/
|
1393
|
+
--\n\n##### [last_button](https://github.com/appium/ruby_lib/blob/621a9ebaf18bcd80eb0e1f5fc17fbb4dddf5293a/lib/appium_lib/android/element/button.rb#L41) android
|
1984
1394
|
|
1985
1395
|
> def last_button
|
1986
1396
|
|
1987
1397
|
Find the last button.
|
1988
1398
|
|
1989
|
-
__Returns:__
|
1399
|
+
__Returns:__\n\n [Button]
|
1990
1400
|
|
1991
|
-
|
1992
|
-
|
1993
|
-
--
|
1994
|
-
|
1995
|
-
##### [button_exact](https://github.com/appium/ruby_lib/blob/c6eb8f5416ccdf75b161bc60c0986caec43d9ff8/lib/appium_lib/android/element/button.rb#L57) android
|
1401
|
+
--\n\n##### [button_exact](https://github.com/appium/ruby_lib/blob/621a9ebaf18bcd80eb0e1f5fc17fbb4dddf5293a/lib/appium_lib/android/element/button.rb#L57) android
|
1996
1402
|
|
1997
1403
|
> def button_exact(value)
|
1998
1404
|
|
1999
1405
|
Find the first button that exactly matches value.
|
2000
1406
|
|
2001
|
-
__Parameters:__
|
2002
|
-
|
2003
|
-
[String] value - the value to match exactly
|
1407
|
+
__Parameters:__\n\n [String] value - the value to match exactly
|
2004
1408
|
|
2005
|
-
__Returns:__
|
1409
|
+
__Returns:__\n\n [Button]
|
2006
1410
|
|
2007
|
-
|
2008
|
-
|
2009
|
-
--
|
2010
|
-
|
2011
|
-
##### [buttons_exact](https://github.com/appium/ruby_lib/blob/c6eb8f5416ccdf75b161bc60c0986caec43d9ff8/lib/appium_lib/android/element/button.rb#L64) android
|
1411
|
+
--\n\n##### [buttons_exact](https://github.com/appium/ruby_lib/blob/621a9ebaf18bcd80eb0e1f5fc17fbb4dddf5293a/lib/appium_lib/android/element/button.rb#L64) android
|
2012
1412
|
|
2013
1413
|
> def buttons_exact(value)
|
2014
1414
|
|
2015
1415
|
Find all buttons that exactly match value.
|
2016
1416
|
|
2017
|
-
__Parameters:__
|
2018
|
-
|
2019
|
-
[String] value - the value to match exactly
|
1417
|
+
__Parameters:__\n\n [String] value - the value to match exactly
|
2020
1418
|
|
2021
|
-
__Returns:__
|
1419
|
+
__Returns:__\n\n [Array<Button>]
|
2022
1420
|
|
2023
|
-
|
2024
|
-
|
2025
|
-
--
|
2026
|
-
|
2027
|
-
##### [find](https://github.com/appium/ruby_lib/blob/c6eb8f5416ccdf75b161bc60c0986caec43d9ff8/lib/appium_lib/android/element/generic.rb#L6) android
|
1421
|
+
--\n\n##### [find](https://github.com/appium/ruby_lib/blob/621a9ebaf18bcd80eb0e1f5fc17fbb4dddf5293a/lib/appium_lib/android/element/generic.rb#L6) android
|
2028
1422
|
|
2029
1423
|
> def find(value)
|
2030
1424
|
|
2031
1425
|
Find the first element containing value
|
2032
1426
|
|
2033
|
-
__Parameters:__
|
2034
|
-
|
2035
|
-
[String] value - the value to search for
|
2036
|
-
|
2037
|
-
__Returns:__
|
2038
|
-
|
2039
|
-
[Element]
|
1427
|
+
__Parameters:__\n\n [String] value - the value to search for
|
2040
1428
|
|
2041
|
-
|
1429
|
+
__Returns:__\n\n [Element]
|
2042
1430
|
|
2043
|
-
##### [finds](https://github.com/appium/ruby_lib/blob/
|
1431
|
+
--\n\n##### [finds](https://github.com/appium/ruby_lib/blob/621a9ebaf18bcd80eb0e1f5fc17fbb4dddf5293a/lib/appium_lib/android/element/generic.rb#L13) android
|
2044
1432
|
|
2045
1433
|
> def finds(value)
|
2046
1434
|
|
2047
1435
|
Find all elements containing value
|
2048
1436
|
|
2049
|
-
__Parameters:__
|
2050
|
-
|
2051
|
-
[String] value - the value to search for
|
2052
|
-
|
2053
|
-
__Returns:__
|
1437
|
+
__Parameters:__\n\n [String] value - the value to search for
|
2054
1438
|
|
2055
|
-
[Array<Element>]
|
1439
|
+
__Returns:__\n\n [Array<Element>]
|
2056
1440
|
|
2057
|
-
|
2058
|
-
|
2059
|
-
##### [find_exact](https://github.com/appium/ruby_lib/blob/c6eb8f5416ccdf75b161bc60c0986caec43d9ff8/lib/appium_lib/android/element/generic.rb#L20) android
|
1441
|
+
--\n\n##### [find_exact](https://github.com/appium/ruby_lib/blob/621a9ebaf18bcd80eb0e1f5fc17fbb4dddf5293a/lib/appium_lib/android/element/generic.rb#L20) android
|
2060
1442
|
|
2061
1443
|
> def find_exact(value)
|
2062
1444
|
|
2063
1445
|
Find the first element exactly matching value
|
2064
1446
|
|
2065
|
-
__Parameters:__
|
2066
|
-
|
2067
|
-
[String] value - the value to search for
|
2068
|
-
|
2069
|
-
__Returns:__
|
2070
|
-
|
2071
|
-
[Element]
|
1447
|
+
__Parameters:__\n\n [String] value - the value to search for
|
2072
1448
|
|
2073
|
-
|
1449
|
+
__Returns:__\n\n [Element]
|
2074
1450
|
|
2075
|
-
##### [finds_exact](https://github.com/appium/ruby_lib/blob/
|
1451
|
+
--\n\n##### [finds_exact](https://github.com/appium/ruby_lib/blob/621a9ebaf18bcd80eb0e1f5fc17fbb4dddf5293a/lib/appium_lib/android/element/generic.rb#L27) android
|
2076
1452
|
|
2077
1453
|
> def finds_exact(value)
|
2078
1454
|
|
2079
1455
|
Find all elements exactly matching value
|
2080
1456
|
|
2081
|
-
__Parameters:__
|
2082
|
-
|
2083
|
-
[String] value - the value to search for
|
2084
|
-
|
2085
|
-
__Returns:__
|
2086
|
-
|
2087
|
-
[Array<Element>]
|
1457
|
+
__Parameters:__\n\n [String] value - the value to search for
|
2088
1458
|
|
2089
|
-
|
1459
|
+
__Returns:__\n\n [Array<Element>]
|
2090
1460
|
|
2091
|
-
##### [scroll_to](https://github.com/appium/ruby_lib/blob/
|
1461
|
+
--\n\n##### [scroll_to](https://github.com/appium/ruby_lib/blob/621a9ebaf18bcd80eb0e1f5fc17fbb4dddf5293a/lib/appium_lib/android/element/generic.rb#L40) android
|
2092
1462
|
|
2093
1463
|
> def scroll_to(text, scrollable_index = 0)
|
2094
1464
|
|
2095
1465
|
Scroll to the first element containing target text or description.
|
2096
1466
|
|
2097
|
-
__Parameters:__
|
2098
|
-
|
2099
|
-
[String] text - the text or resourceId to search for in the text value and content description
|
1467
|
+
__Parameters:__\n\n [String] text - the text or resourceId to search for in the text value and content description
|
2100
1468
|
|
2101
1469
|
[Integer] scrollable_index - the index for scrollable views.
|
2102
1470
|
|
2103
|
-
__Returns:__
|
2104
|
-
|
2105
|
-
[Element] the element scrolled to
|
2106
|
-
|
2107
|
-
--
|
1471
|
+
__Returns:__\n\n [Element] the element scrolled to
|
2108
1472
|
|
2109
|
-
##### [scroll_to_exact](https://github.com/appium/ruby_lib/blob/
|
1473
|
+
--\n\n##### [scroll_to_exact](https://github.com/appium/ruby_lib/blob/621a9ebaf18bcd80eb0e1f5fc17fbb4dddf5293a/lib/appium_lib/android/element/generic.rb#L58) android
|
2110
1474
|
|
2111
1475
|
> def scroll_to_exact(text, scrollable_index = 0)
|
2112
1476
|
|
2113
1477
|
Scroll to the first element with the exact target text or description.
|
2114
1478
|
|
2115
|
-
__Parameters:__
|
2116
|
-
|
2117
|
-
[String] text - the text or resourceId to search for in the text value and content description
|
1479
|
+
__Parameters:__\n\n [String] text - the text or resourceId to search for in the text value and content description
|
2118
1480
|
|
2119
1481
|
[Integer] scrollable_index - the index for scrollable views.
|
2120
1482
|
|
2121
|
-
__Returns:__
|
2122
|
-
|
2123
|
-
[Element] the element scrolled to
|
2124
|
-
|
2125
|
-
--
|
1483
|
+
__Returns:__\n\n [Element] the element scrolled to
|
2126
1484
|
|
2127
|
-
##### [for](https://github.com/appium/ruby_lib/blob/
|
1485
|
+
--\n\n##### [for](https://github.com/appium/ruby_lib/blob/621a9ebaf18bcd80eb0e1f5fc17fbb4dddf5293a/lib/appium_lib/android/espresso/bridge.rb#L7) android
|
2128
1486
|
|
2129
1487
|
> def self.for(target)
|
2130
1488
|
|
2131
1489
|
|
2132
1490
|
|
2133
|
-
|
2134
|
-
|
2135
|
-
##### [EditText](https://github.com/appium/ruby_lib/blob/c6eb8f5416ccdf75b161bc60c0986caec43d9ff8/lib/appium_lib/android/element/textfield.rb#L3) android
|
1491
|
+
--\n\n##### [EditText](https://github.com/appium/ruby_lib/blob/621a9ebaf18bcd80eb0e1f5fc17fbb4dddf5293a/lib/appium_lib/android/element/textfield.rb#L3) android
|
2136
1492
|
|
2137
1493
|
> EditText = 'android.widget.EditText'.freeze
|
2138
1494
|
|
2139
1495
|
|
2140
1496
|
|
2141
|
-
|
2142
|
-
|
2143
|
-
##### [textfield](https://github.com/appium/ruby_lib/blob/c6eb8f5416ccdf75b161bc60c0986caec43d9ff8/lib/appium_lib/android/element/textfield.rb#L9) android
|
1497
|
+
--\n\n##### [textfield](https://github.com/appium/ruby_lib/blob/621a9ebaf18bcd80eb0e1f5fc17fbb4dddf5293a/lib/appium_lib/android/element/textfield.rb#L9) android
|
2144
1498
|
|
2145
1499
|
> def textfield(value)
|
2146
1500
|
|
2147
1501
|
Find the first EditText that contains value or by index.
|
2148
1502
|
If int then the EditText at that index is returned.
|
2149
1503
|
|
2150
|
-
__Parameters:__
|
2151
|
-
|
2152
|
-
[String, Integer] value - the text to match exactly.
|
1504
|
+
__Parameters:__\n\n [String, Integer] value - the text to match exactly.
|
2153
1505
|
|
2154
|
-
__Returns:__
|
1506
|
+
__Returns:__\n\n [EditText]
|
2155
1507
|
|
2156
|
-
|
2157
|
-
|
2158
|
-
--
|
2159
|
-
|
2160
|
-
##### [textfields](https://github.com/appium/ruby_lib/blob/c6eb8f5416ccdf75b161bc60c0986caec43d9ff8/lib/appium_lib/android/element/textfield.rb#L19) android
|
1508
|
+
--\n\n##### [textfields](https://github.com/appium/ruby_lib/blob/621a9ebaf18bcd80eb0e1f5fc17fbb4dddf5293a/lib/appium_lib/android/element/textfield.rb#L19) android
|
2161
1509
|
|
2162
1510
|
> def textfields(value = false)
|
2163
1511
|
|
2164
1512
|
Find all EditTexts containing value.
|
2165
1513
|
If value is omitted, all EditTexts are returned.
|
2166
1514
|
|
2167
|
-
__Parameters:__
|
2168
|
-
|
2169
|
-
[String] value - the value to search for
|
2170
|
-
|
2171
|
-
__Returns:__
|
2172
|
-
|
2173
|
-
[Array<EditText>]
|
1515
|
+
__Parameters:__\n\n [String] value - the value to search for
|
2174
1516
|
|
2175
|
-
|
1517
|
+
__Returns:__\n\n [Array<EditText>]
|
2176
1518
|
|
2177
|
-
##### [first_textfield](https://github.com/appium/ruby_lib/blob/
|
1519
|
+
--\n\n##### [first_textfield](https://github.com/appium/ruby_lib/blob/621a9ebaf18bcd80eb0e1f5fc17fbb4dddf5293a/lib/appium_lib/android/element/textfield.rb#L27) android
|
2178
1520
|
|
2179
1521
|
> def first_textfield
|
2180
1522
|
|
2181
1523
|
Find the first EditText.
|
2182
1524
|
|
2183
|
-
__Returns:__
|
1525
|
+
__Returns:__\n\n [EditText]
|
2184
1526
|
|
2185
|
-
|
2186
|
-
|
2187
|
-
--
|
2188
|
-
|
2189
|
-
##### [last_textfield](https://github.com/appium/ruby_lib/blob/c6eb8f5416ccdf75b161bc60c0986caec43d9ff8/lib/appium_lib/android/element/textfield.rb#L33) android
|
1527
|
+
--\n\n##### [last_textfield](https://github.com/appium/ruby_lib/blob/621a9ebaf18bcd80eb0e1f5fc17fbb4dddf5293a/lib/appium_lib/android/element/textfield.rb#L33) android
|
2190
1528
|
|
2191
1529
|
> def last_textfield
|
2192
1530
|
|
2193
1531
|
Find the last EditText.
|
2194
1532
|
|
2195
|
-
__Returns:__
|
2196
|
-
|
2197
|
-
[EditText]
|
1533
|
+
__Returns:__\n\n [EditText]
|
2198
1534
|
|
2199
|
-
|
2200
|
-
|
2201
|
-
##### [textfield_exact](https://github.com/appium/ruby_lib/blob/c6eb8f5416ccdf75b161bc60c0986caec43d9ff8/lib/appium_lib/android/element/textfield.rb#L40) android
|
1535
|
+
--\n\n##### [textfield_exact](https://github.com/appium/ruby_lib/blob/621a9ebaf18bcd80eb0e1f5fc17fbb4dddf5293a/lib/appium_lib/android/element/textfield.rb#L40) android
|
2202
1536
|
|
2203
1537
|
> def textfield_exact(value)
|
2204
1538
|
|
2205
1539
|
Find the first EditText that exactly matches value.
|
2206
1540
|
|
2207
|
-
__Parameters:__
|
2208
|
-
|
2209
|
-
[String] value - the value to match exactly
|
2210
|
-
|
2211
|
-
__Returns:__
|
1541
|
+
__Parameters:__\n\n [String] value - the value to match exactly
|
2212
1542
|
|
2213
|
-
[EditText]
|
1543
|
+
__Returns:__\n\n [EditText]
|
2214
1544
|
|
2215
|
-
|
2216
|
-
|
2217
|
-
##### [textfields_exact](https://github.com/appium/ruby_lib/blob/c6eb8f5416ccdf75b161bc60c0986caec43d9ff8/lib/appium_lib/android/element/textfield.rb#L47) android
|
1545
|
+
--\n\n##### [textfields_exact](https://github.com/appium/ruby_lib/blob/621a9ebaf18bcd80eb0e1f5fc17fbb4dddf5293a/lib/appium_lib/android/element/textfield.rb#L47) android
|
2218
1546
|
|
2219
1547
|
> def textfields_exact(value)
|
2220
1548
|
|
2221
1549
|
Find all EditTexts that exactly match value.
|
2222
1550
|
|
2223
|
-
__Parameters:__
|
2224
|
-
|
2225
|
-
[String] value - the value to match exactly
|
2226
|
-
|
2227
|
-
__Returns:__
|
1551
|
+
__Parameters:__\n\n [String] value - the value to match exactly
|
2228
1552
|
|
2229
|
-
[Array<EditText>]
|
1553
|
+
__Returns:__\n\n [Array<EditText>]
|
2230
1554
|
|
2231
|
-
|
2232
|
-
|
2233
|
-
##### [for](https://github.com/appium/ruby_lib/blob/c6eb8f5416ccdf75b161bc60c0986caec43d9ff8/lib/appium_lib/android/uiautomator2/bridge.rb#L7) android
|
1555
|
+
--\n\n##### [for](https://github.com/appium/ruby_lib/blob/621a9ebaf18bcd80eb0e1f5fc17fbb4dddf5293a/lib/appium_lib/android/uiautomator2/bridge.rb#L7) android
|
2234
1556
|
|
2235
1557
|
> def self.for(target)
|
2236
1558
|
|
2237
1559
|
|
2238
1560
|
|
2239
|
-
|
2240
|
-
|
2241
|
-
##### [string_visible_contains](https://github.com/appium/ruby_lib/blob/c6eb8f5416ccdf75b161bc60c0986caec43d9ff8/lib/appium_lib/android/uiautomator2/helper.rb#L13) android
|
1561
|
+
--\n\n##### [string_visible_contains](https://github.com/appium/ruby_lib/blob/621a9ebaf18bcd80eb0e1f5fc17fbb4dddf5293a/lib/appium_lib/android/uiautomator2/helper.rb#L13) android
|
2242
1562
|
|
2243
1563
|
> def string_visible_contains(class_name, value)
|
2244
1564
|
|
@@ -2247,212 +1567,141 @@ For automationName is Appium
|
|
2247
1567
|
example: string_visible_contains 'UIATextField', 'sign in'
|
2248
1568
|
note for XPath: https://github.com/appium/ruby_lib/pull/561
|
2249
1569
|
|
2250
|
-
__Parameters:__
|
2251
|
-
|
2252
|
-
[String] class_name - the class name for the element
|
1570
|
+
__Parameters:__\n\n [String] class_name - the class name for the element
|
2253
1571
|
|
2254
1572
|
[String] value - the value to search for
|
2255
1573
|
|
2256
|
-
__Returns:__
|
1574
|
+
__Returns:__\n\n [String]
|
2257
1575
|
|
2258
|
-
|
2259
|
-
|
2260
|
-
--
|
2261
|
-
|
2262
|
-
##### [complex_find_contains](https://github.com/appium/ruby_lib/blob/c6eb8f5416ccdf75b161bc60c0986caec43d9ff8/lib/appium_lib/android/uiautomator2/helper.rb#L31) android
|
1576
|
+
--\n\n##### [complex_find_contains](https://github.com/appium/ruby_lib/blob/621a9ebaf18bcd80eb0e1f5fc17fbb4dddf5293a/lib/appium_lib/android/uiautomator2/helper.rb#L31) android
|
2263
1577
|
|
2264
1578
|
> def complex_find_contains(class_name, value)
|
2265
1579
|
|
2266
1580
|
Find the first element that contains value
|
2267
1581
|
|
2268
|
-
__Parameters:__
|
2269
|
-
|
2270
|
-
[String] class_name - the class name for the element
|
1582
|
+
__Parameters:__\n\n [String] class_name - the class name for the element
|
2271
1583
|
|
2272
1584
|
[String] value - the value to search for
|
2273
1585
|
|
2274
|
-
__Returns:__
|
1586
|
+
__Returns:__\n\n [Element]
|
2275
1587
|
|
2276
|
-
|
2277
|
-
|
2278
|
-
--
|
2279
|
-
|
2280
|
-
##### [complex_finds_contains](https://github.com/appium/ruby_lib/blob/c6eb8f5416ccdf75b161bc60c0986caec43d9ff8/lib/appium_lib/android/uiautomator2/helper.rb#L42) android
|
1588
|
+
--\n\n##### [complex_finds_contains](https://github.com/appium/ruby_lib/blob/621a9ebaf18bcd80eb0e1f5fc17fbb4dddf5293a/lib/appium_lib/android/uiautomator2/helper.rb#L42) android
|
2281
1589
|
|
2282
1590
|
> def complex_finds_contains(class_name, value)
|
2283
1591
|
|
2284
1592
|
Find all elements containing value
|
2285
1593
|
|
2286
|
-
__Parameters:__
|
2287
|
-
|
2288
|
-
[String] class_name - the class name for the element
|
1594
|
+
__Parameters:__\n\n [String] class_name - the class name for the element
|
2289
1595
|
|
2290
1596
|
[String] value - the value to search for
|
2291
1597
|
|
2292
|
-
__Returns:__
|
1598
|
+
__Returns:__\n\n [Array<Element>]
|
2293
1599
|
|
2294
|
-
|
2295
|
-
|
2296
|
-
--
|
2297
|
-
|
2298
|
-
##### [complex_find_exact](https://github.com/appium/ruby_lib/blob/c6eb8f5416ccdf75b161bc60c0986caec43d9ff8/lib/appium_lib/android/uiautomator2/helper.rb#L70) android
|
1600
|
+
--\n\n##### [complex_find_exact](https://github.com/appium/ruby_lib/blob/621a9ebaf18bcd80eb0e1f5fc17fbb4dddf5293a/lib/appium_lib/android/uiautomator2/helper.rb#L70) android
|
2299
1601
|
|
2300
1602
|
> def complex_find_exact(class_name, value)
|
2301
1603
|
|
2302
1604
|
Find the first element exactly matching value
|
2303
1605
|
|
2304
|
-
__Parameters:__
|
2305
|
-
|
2306
|
-
[String] class_name - the class name for the element
|
1606
|
+
__Parameters:__\n\n [String] class_name - the class name for the element
|
2307
1607
|
|
2308
1608
|
[String] value - the value to search for
|
2309
1609
|
|
2310
|
-
__Returns:__
|
1610
|
+
__Returns:__\n\n [Element]
|
2311
1611
|
|
2312
|
-
|
2313
|
-
|
2314
|
-
--
|
2315
|
-
|
2316
|
-
##### [complex_finds_exact](https://github.com/appium/ruby_lib/blob/c6eb8f5416ccdf75b161bc60c0986caec43d9ff8/lib/appium_lib/android/uiautomator2/helper.rb#L81) android
|
1612
|
+
--\n\n##### [complex_finds_exact](https://github.com/appium/ruby_lib/blob/621a9ebaf18bcd80eb0e1f5fc17fbb4dddf5293a/lib/appium_lib/android/uiautomator2/helper.rb#L81) android
|
2317
1613
|
|
2318
1614
|
> def complex_finds_exact(class_name, value)
|
2319
1615
|
|
2320
1616
|
Find all elements exactly matching value
|
2321
1617
|
|
2322
|
-
__Parameters:__
|
2323
|
-
|
2324
|
-
[String] class_name - the class name for the element
|
1618
|
+
__Parameters:__\n\n [String] class_name - the class name for the element
|
2325
1619
|
|
2326
1620
|
[String] value - the value to search for
|
2327
1621
|
|
2328
|
-
__Returns:__
|
1622
|
+
__Returns:__\n\n [Element]
|
2329
1623
|
|
2330
|
-
|
2331
|
-
|
2332
|
-
--
|
2333
|
-
|
2334
|
-
##### [shell](https://github.com/appium/ruby_lib/blob/c6eb8f5416ccdf75b161bc60c0986caec43d9ff8/lib/appium_lib/android/common/command/command.rb#L14) android
|
1624
|
+
--\n\n##### [shell](https://github.com/appium/ruby_lib/blob/621a9ebaf18bcd80eb0e1f5fc17fbb4dddf5293a/lib/appium_lib/android/common/command/command.rb#L14) android
|
2335
1625
|
|
2336
1626
|
> def shell(command, arguments)
|
2337
1627
|
|
2338
1628
|
Conduct an adb shell script on Appium server.
|
2339
1629
|
Require `--relaxed-security` arguments when run Appium server as server side arguments.
|
2340
1630
|
|
2341
|
-
__Parameters:__
|
2342
|
-
|
2343
|
-
[String] command - Command for "adb shell"
|
1631
|
+
__Parameters:__\n\n [String] command - Command for "adb shell"
|
2344
1632
|
|
2345
1633
|
[Array] arguments - Arguments for the adb command
|
2346
1634
|
|
2347
|
-
|
2348
|
-
|
2349
|
-
##### [start_logs_broadcast](https://github.com/appium/ruby_lib/blob/c6eb8f5416ccdf75b161bc60c0986caec43d9ff8/lib/appium_lib/android/common/command/command.rb#L28) android
|
1635
|
+
--\n\n##### [start_logs_broadcast](https://github.com/appium/ruby_lib/blob/621a9ebaf18bcd80eb0e1f5fc17fbb4dddf5293a/lib/appium_lib/android/common/command/command.rb#L28) android
|
2350
1636
|
|
2351
1637
|
> def start_logs_broadcast(logcat_file = 'logcat.log')
|
2352
1638
|
|
2353
1639
|
Starts Android logcat broadcast websocket
|
2354
1640
|
|
2355
|
-
__Parameters:__
|
2356
|
-
|
2357
|
-
[String] logcat_file - A file path to write messages from a logcat WebSocket client
|
2358
|
-
|
2359
|
-
--
|
1641
|
+
__Parameters:__\n\n [String] logcat_file - A file path to write messages from a logcat WebSocket client
|
2360
1642
|
|
2361
|
-
##### [stop_logs_broadcast](https://github.com/appium/ruby_lib/blob/
|
1643
|
+
--\n\n##### [stop_logs_broadcast](https://github.com/appium/ruby_lib/blob/621a9ebaf18bcd80eb0e1f5fc17fbb4dddf5293a/lib/appium_lib/android/common/command/command.rb#L41) android
|
2362
1644
|
|
2363
1645
|
> def stop_logs_broadcast
|
2364
1646
|
|
2365
1647
|
Stop Android logcat broadcast websocket
|
2366
1648
|
|
2367
|
-
|
2368
|
-
|
2369
|
-
##### [button](https://github.com/appium/ruby_lib/blob/c6eb8f5416ccdf75b161bc60c0986caec43d9ff8/lib/appium_lib/android/uiautomator2/element/button.rb#L9) android
|
1649
|
+
--\n\n##### [button](https://github.com/appium/ruby_lib/blob/621a9ebaf18bcd80eb0e1f5fc17fbb4dddf5293a/lib/appium_lib/android/uiautomator2/element/button.rb#L9) android
|
2370
1650
|
|
2371
1651
|
> def button(value)
|
2372
1652
|
|
2373
1653
|
Find the first button that contains value or by index.
|
2374
1654
|
If int then the button at that index is returned.
|
2375
1655
|
|
2376
|
-
__Parameters:__
|
2377
|
-
|
2378
|
-
[String, Integer] value - the value to exactly match.
|
2379
|
-
|
2380
|
-
__Returns:__
|
1656
|
+
__Parameters:__\n\n [String, Integer] value - the value to exactly match.
|
2381
1657
|
|
2382
|
-
[Button]
|
1658
|
+
__Returns:__\n\n [Button]
|
2383
1659
|
|
2384
|
-
|
2385
|
-
|
2386
|
-
##### [buttons](https://github.com/appium/ruby_lib/blob/c6eb8f5416ccdf75b161bc60c0986caec43d9ff8/lib/appium_lib/android/uiautomator2/element/button.rb#L30) android
|
1660
|
+
--\n\n##### [buttons](https://github.com/appium/ruby_lib/blob/621a9ebaf18bcd80eb0e1f5fc17fbb4dddf5293a/lib/appium_lib/android/uiautomator2/element/button.rb#L30) android
|
2387
1661
|
|
2388
1662
|
> def buttons(value = false)
|
2389
1663
|
|
2390
1664
|
Find all buttons containing value.
|
2391
1665
|
If value is omitted, all buttons are returned.
|
2392
1666
|
|
2393
|
-
__Parameters:__
|
2394
|
-
|
2395
|
-
[String] value - the value to search for
|
2396
|
-
|
2397
|
-
__Returns:__
|
2398
|
-
|
2399
|
-
[Array<Button>]
|
1667
|
+
__Parameters:__\n\n [String] value - the value to search for
|
2400
1668
|
|
2401
|
-
|
1669
|
+
__Returns:__\n\n [Array<Button>]
|
2402
1670
|
|
2403
|
-
##### [first_button](https://github.com/appium/ruby_lib/blob/
|
1671
|
+
--\n\n##### [first_button](https://github.com/appium/ruby_lib/blob/621a9ebaf18bcd80eb0e1f5fc17fbb4dddf5293a/lib/appium_lib/android/uiautomator2/element/button.rb#L38) android
|
2404
1672
|
|
2405
1673
|
> def first_button
|
2406
1674
|
|
2407
1675
|
Find the first button.
|
2408
1676
|
|
2409
|
-
__Returns:__
|
2410
|
-
|
2411
|
-
[Button]
|
1677
|
+
__Returns:__\n\n [Button]
|
2412
1678
|
|
2413
|
-
|
2414
|
-
|
2415
|
-
##### [last_button](https://github.com/appium/ruby_lib/blob/c6eb8f5416ccdf75b161bc60c0986caec43d9ff8/lib/appium_lib/android/uiautomator2/element/button.rb#L45) android
|
1679
|
+
--\n\n##### [last_button](https://github.com/appium/ruby_lib/blob/621a9ebaf18bcd80eb0e1f5fc17fbb4dddf5293a/lib/appium_lib/android/uiautomator2/element/button.rb#L45) android
|
2416
1680
|
|
2417
1681
|
> def last_button
|
2418
1682
|
|
2419
1683
|
Find the last button.
|
2420
1684
|
|
2421
|
-
__Returns:__
|
2422
|
-
|
2423
|
-
[Button]
|
2424
|
-
|
2425
|
-
--
|
1685
|
+
__Returns:__\n\n [Button]
|
2426
1686
|
|
2427
|
-
##### [button_exact](https://github.com/appium/ruby_lib/blob/
|
1687
|
+
--\n\n##### [button_exact](https://github.com/appium/ruby_lib/blob/621a9ebaf18bcd80eb0e1f5fc17fbb4dddf5293a/lib/appium_lib/android/uiautomator2/element/button.rb#L62) android
|
2428
1688
|
|
2429
1689
|
> def button_exact(value)
|
2430
1690
|
|
2431
1691
|
Find the first button that exactly matches value.
|
2432
1692
|
|
2433
|
-
__Parameters:__
|
1693
|
+
__Parameters:__\n\n [String] value - the value to match exactly
|
2434
1694
|
|
2435
|
-
[
|
1695
|
+
__Returns:__\n\n [Button]
|
2436
1696
|
|
2437
|
-
|
2438
|
-
|
2439
|
-
[Button]
|
2440
|
-
|
2441
|
-
--
|
2442
|
-
|
2443
|
-
##### [buttons_exact](https://github.com/appium/ruby_lib/blob/c6eb8f5416ccdf75b161bc60c0986caec43d9ff8/lib/appium_lib/android/uiautomator2/element/button.rb#L70) android
|
1697
|
+
--\n\n##### [buttons_exact](https://github.com/appium/ruby_lib/blob/621a9ebaf18bcd80eb0e1f5fc17fbb4dddf5293a/lib/appium_lib/android/uiautomator2/element/button.rb#L70) android
|
2444
1698
|
|
2445
1699
|
> def buttons_exact(value)
|
2446
1700
|
|
2447
1701
|
Find all buttons that exactly match value.
|
2448
1702
|
|
2449
|
-
__Parameters:__
|
2450
|
-
|
2451
|
-
[String] value - the value to match exactly
|
2452
|
-
|
2453
|
-
__Returns:__
|
2454
|
-
|
2455
|
-
[Array<Button>]
|
1703
|
+
__Parameters:__\n\n [String] value - the value to match exactly
|
2456
1704
|
|
2457
|
-
|
1705
|
+
__Returns:__\n\n [Array<Button>]
|
2458
1706
|
|
1707
|
+
--\n\n
|