Update commands for the Ruby client (#9662)

* context, activity. app, files, interactions

* update commands
This commit is contained in:
Kazuaki Matsuo
2017-11-21 10:46:00 +00:00
committed by GitHub
parent 136ea4d015
commit ceb8acd4df
64 changed files with 137 additions and 117 deletions

View File

@@ -42,7 +42,7 @@ client_docs:
python: "https://github.com/appium/python-client/blob/master/README.md#switching-between-native-and-webview"
javascript_wdio: "http://webdriver.io/api/mobile/context.html"
javascript_wd: "https://github.com/admc/wd/blob/master/doc/api.md"
ruby: "https://github.com/appium/ruby_lib"
ruby: "http://www.rubydoc.info/github/appium/ruby_lib_core/Appium/Core/Device#current_context-instance_method"
php: "https://github.com/appium/php-client/" # TODO PHP documentation link
csharp: "https://github.com/appium/appium-dotnet-driver/" # TODO Dotnet documentation link

View File

@@ -39,7 +39,7 @@ client_docs:
python: "https://github.com/appium/python-client/blob/master/README.md#switching-between-native-and-webview"
javascript_wdio: "http://webdriver.io/api/mobile/contexts.html"
javascript_wd: "https://github.com/admc/wd/blob/master/doc/api.md"
ruby: "https://github.com/appium/ruby_lib"
ruby: "http://www.rubydoc.info/github/appium/ruby_lib_core/Appium/Core/Device#available_contexts-instance_method"
php: "https://github.com/appium/php-client/" # TODO PHP documentation link
csharp: "https://github.com/appium/appium-dotnet-driver/" # TODO Dotnet documentation link

View File

@@ -41,9 +41,9 @@ example_usage:
ruby:
|
webview = @driver.available_contexts[1]
@driver.switch_to.context(webview)
@driver.set_context(webview)
# ...
@driver.switch_to.context('NATIVE_APP')
@driver.set_context('NATIVE_APP')
php:
|
$contexts = $driver->contexts();
@@ -59,7 +59,7 @@ client_docs:
python: "https://github.com/appium/python-client/blob/master/README.md#switching-between-native-and-webview"
javascript_wdio: "http://webdriver.io/api/mobile/context.html"
javascript_wd: "https://github.com/admc/wd/blob/master/doc/api.md"
ruby: "https://github.com/appium/ruby_lib"
ruby: "http://www.rubydoc.info/github/appium/ruby_lib_core/Appium/Core/Device#set_context-instance_method"
php: "https://github.com/appium/php-client/" # TODO PHP documentation link
csharp: "https://github.com/appium/appium-dotnet-driver/" # TODO Dotnet documentation link

View File

@@ -17,7 +17,7 @@ example_usage:
let activity = driver.currentActivity();
ruby:
|
@driver.current_activity;
@driver.current_activity
php:
|
// TODO PHP sample
@@ -30,7 +30,7 @@ client_docs:
python: "https://github.com/appium/python-client/blob/master/appium/webdriver/webdriver.py#L447"
javascript_wdio: "http://webdriver.io/api/mobile/currentActivity.html"
javascript_wd: "https://github.com/admc/wd/blob/master/lib/commands.js#L2519"
ruby: "http://www.rubydoc.info/github/appium/ruby_lib/Appium/Core/Device:current_activity"
ruby: "http://www.rubydoc.info/github/appium/ruby_lib_core/Appium/Core/Device#current_activity-instance_method"
php: "https://github.com/appium/php-client/" # TODO PHP documentation link
csharp: "https://github.com/appium/appium-dotnet-driver/" # TODO Dotnet documentation link

View File

@@ -14,7 +14,7 @@ example_usage:
let package = await driver.getCurrentPackage();
ruby:
|
@driver.current_package;
@driver.current_package
php:
|
// TODO PHP sample
@@ -26,7 +26,7 @@ client_docs:
java: "http://appium.github.io/java-client/io/appium/java_client/android/StartsActivity.html#getCurrentPackage--"
python: "https://github.com/appium/python-client/blob/master/appium/webdriver/webdriver.py#L453"
javascript_wd: "https://github.com/admc/wd/blob/master/lib/commands.js#L2526"
ruby: "http://www.rubydoc.info/github/appium/ruby_lib/Appium/Core/Device:current_package"
ruby: "http://www.rubydoc.info/github/appium/ruby_lib_core/Appium/Core/Device#current_package-instance_method"
php: "https://github.com/appium/php-client/" # TODO PHP documentation link
csharp: "https://github.com/appium/appium-dotnet-driver/" # TODO Dotnet documentation link

View File

@@ -20,7 +20,7 @@ example_usage:
driver.startActivity("com.example", "ActivityName");
ruby:
|
@driver.start_activity("com.example", "ActivityName");
@driver.start_activity app_package: "com.example", app_activity: "ActivityName"
php:
|
// TODO PHP sample
@@ -33,7 +33,7 @@ client_docs:
python: "https://github.com/appium/python-client/blob/master/appium/webdriver/webdriver.py#L591"
javascript_wdio: "http://webdriver.io/api/mobile/startActivity.html"
javascript_wd: "https://github.com/admc/wd/blob/master/lib/commands.js#L2948"
ruby: "http://www.rubydoc.info/github/appium/ruby_lib/Appium/Android/Device:start_activity"
ruby: "http://www.rubydoc.info/github/appium/ruby_lib_core/Appium/Android/Device#start_activity-instance_method"
php: "https://github.com/appium/php-client/" # TODO PHP documentation link
csharp: "https://github.com/appium/appium-dotnet-driver/" # TODO Dotnet documentation link

View File

@@ -29,7 +29,7 @@ client_docs:
python: "https://github.com/appium/python-client/blob/master/appium/webdriver/webdriver.py#L529"
javascript_wdio: "http://webdriver.io/api/mobile/background.html"
javascript_wd: "https://github.com/admc/wd/blob/master/lib/commands.js#L2841"
ruby: "http://www.rubydoc.info/github/appium/ruby_lib/Appium/Core/Device:background_app"
ruby: "http://www.rubydoc.info/github/appium/ruby_lib_core/Appium/Core/Device#background_app-instance_method"
php: "https://github.com/appium/php-client/" # TODO PHP documentation link
csharp: "https://github.com/appium/appium-dotnet-driver/" # TODO Dotnet documentation link

View File

@@ -16,7 +16,7 @@ example_usage:
driver.close_app();
ruby:
|
@driver.close_app()
@driver.close_app
php:
|
// TODO PHP sample
@@ -29,7 +29,7 @@ client_docs:
python: "https://github.com/appium/python-client/blob/master/appium/webdriver/webdriver.py#L584"
javascript_wdio: "http://webdriver.io/api/mobile/closeApp.html"
javascript_wd: "https://github.com/admc/wd/blob/master/lib/commands.js#L2798"
ruby: "https://github.com/appium/ruby_lib/blob/master/lib/appium_lib/core/common/command.rb#L10"
ruby: "http://www.rubydoc.info/github/appium/ruby_lib_core/Appium/Core/Device#close_app-instance_method"
php: "https://github.com/appium/php-client/" # TODO PHP documentation link
csharp: "https://github.com/appium/appium-dotnet-driver/" # TODO Dotnet documentation link

View File

@@ -25,7 +25,7 @@ client_docs:
java: "http://appium.github.io/java-client/io/appium/java_client/android/AndroidDriver.html#endTestCoverage-java.lang.String-java.lang.String-"
python: "https://github.com/appium/python-client/blob/master/appium/webdriver/webdriver.py#L627"
javascript_wd: "https://github.com/admc/wd/blob/master/lib/commands.js#L2858"
ruby: "http://www.rubydoc.info/github/appium/ruby_lib/Appium/Android/Device:end_coverage"
ruby: "http://www.rubydoc.info/github/appium/ruby_lib_core/Appium/Android/Device#end_coverage-instance_method"
php: "https://github.com/appium/php-client/" # TODO PHP documentation link
csharp: "https://github.com/appium/appium-dotnet-driver/" # TODO Dotnet documentation link

View File

@@ -29,7 +29,7 @@ client_docs:
python: "https://github.com/appium/python-client/blob/master/appium/webdriver/webdriver.py#L357"
javascript_wdio: "http://webdriver.io/api/mobile/getAppStrings.html"
javascript_wd: "https://github.com/admc/wd/blob/master/lib/commands.js#L2916"
ruby: "http://www.rubydoc.info/github/appium/ruby_lib/Appium/Core/Device:app_strings"
ruby: "http://www.rubydoc.info/github/appium/ruby_lib_core/Appium/Core/Device#app_strings-instance_method"
php: "https://github.com/appium/php-client/" # TODO PHP documentation link
csharp: "https://github.com/appium/appium-dotnet-driver/" # TODO Dotnet documentation link

View File

@@ -17,7 +17,7 @@ example_usage:
driver.installApp('/Users/johndoe/path/to/app.apk')
ruby:
|
@driver.install_app('/Users/johndoe/path/to/app.apk');
@driver.install_app('/Users/johndoe/path/to/app.apk')
php:
|
// TODO PHP sample
@@ -30,7 +30,7 @@ client_docs:
python: "https://github.com/appium/python-client/blob/master/appium/webdriver/webdriver.py#L554"
javascript_wdio: "http://webdriver.io/api/mobile/installApp.html"
javascript_wd: "https://github.com/admc/wd/blob/master/lib/commands.js#L2540"
ruby: "https://github.com/appium/ruby_lib/blob/eb7680f6db1e821901045beacba0a8b80de722fb/lib/appium_lib/core/common/command.rb#L38"
ruby: "http://www.rubydoc.info/github/appium/ruby_lib_core/Appium/Core/Device#install_app-instance_method"
php: "https://github.com/appium/php-client/" # TODO PHP documentation link
csharp: "https://github.com/appium/appium-dotnet-driver/" # TODO Dotnet documentation link

View File

@@ -30,7 +30,7 @@ client_docs:
python: "https://github.com/appium/python-client/blob/master/appium/webdriver/webdriver.py#L542"
javascript_wdio: "http://webdriver.io/api/mobile/isAppInstalled.html"
javascript_wd: "https://github.com/admc/wd/blob/master/lib/commands.js#L2586"
ruby: "https://github.com/appium/ruby_lib/blob/master/lib/appium_lib/core/common/command.rb#L40"
ruby: "http://www.rubydoc.info/github/appium/ruby_lib_core/Appium/Core/Device#app_installed%3F-instance_method"
php: "https://github.com/appium/php-client/" # TODO PHP documentation link
csharp: "https://github.com/appium/appium-dotnet-driver/" # TODO Dotnet documentation link

View File

@@ -16,7 +16,7 @@ example_usage:
driver.launch();
ruby:
|
@driver.launch_app()
@driver.launch_app
php:
|
// TODO PHP sample
@@ -29,7 +29,7 @@ client_docs:
python: "https://github.com/appium/python-client/blob/master/appium/webdriver/webdriver.py#L578"
javascript_wdio: "http://webdriver.io/api/mobile/launch.html"
javascript_wd: "https://github.com/admc/wd/blob/master/lib/commands.js#L2798"
ruby: "http://www.rubydoc.info/github/appium/ruby_lib/Appium/Core/Device:launch_app"
ruby: "http://www.rubydoc.info/github/appium/ruby_lib_core/Appium/Core/Device#launch_app-instance_method"
php: "https://github.com/appium/php-client/" # TODO PHP documentation link
csharp: "https://github.com/appium/appium-dotnet-driver/" # TODO Dotnet documentation link

View File

@@ -17,7 +17,7 @@ example_usage:
driver.removeApp('com.example.AppName')
ruby:
|
@driver.remove_app('com.example.AppName');
@driver.remove_app('com.example.AppName')
php:
|
// TODO PHP sample
@@ -30,7 +30,7 @@ client_docs:
python: "https://github.com/appium/python-client/blob/master/appium/webdriver/webdriver.py#L566"
javascript_wdio: "http://webdriver.io/api/mobile/removeApp.html"
javascript_wd: "https://github.com/admc/wd/blob/master/lib/commands.js#L2563"
ruby: "https://github.com/appium/ruby_lib/blob/master/lib/appium_lib/core/common/command.rb#L39"
ruby: "http://www.rubydoc.info/github/appium/ruby_lib_core/Appium/Core/Device#remove_app-instance_method"
php: "https://github.com/appium/php-client/" # TODO PHP documentation link
csharp: "https://github.com/appium/appium-dotnet-driver/" # TODO Dotnet documentation link

View File

@@ -16,7 +16,7 @@ example_usage:
driver.reset();
ruby:
|
@driver.reset()
@driver.reset
php:
|
// TODO PHP sample
@@ -29,7 +29,7 @@ client_docs:
python: "https://github.com/appium/python-client/blob/master/appium/webdriver/webdriver.py#L372"
javascript_wdio: "http://webdriver.io/api/mobile/reset.html"
javascript_wd: "https://github.com/admc/wd/blob/master/lib/commands.js#L2827"
ruby: "https://github.com/appium/ruby_lib/blob/master/lib/appium_lib/core/common/command.rb#L11"
ruby: "http://www.rubydoc.info/github/appium/ruby_lib_core/Appium/Core/Device#reset-instance_method"
php: "https://github.com/appium/php-client/" # TODO PHP documentation link
csharp: "https://github.com/appium/appium-dotnet-driver/" # TODO Dotnet documentation link

View File

@@ -17,7 +17,7 @@ example_usage:
let data = driver.pullFile('/data/local/tmp/file.txt');
ruby:
|
@driver.pull_file('/data/local/tmp/file.txt');
@driver.pull_file('/data/local/tmp/file.txt')
php:
|
// TODO PHP sample
@@ -30,7 +30,7 @@ client_docs:
python: "https://github.com/appium/python-client/blob/master/appium/webdriver/webdriver.py#L491"
javascript_wdio: "http://webdriver.io/api/mobile/pullFile.html"
javascript_wd: "https://github.com/admc/wd/blob/master/lib/commands.js#L2665"
ruby: "http://www.rubydoc.info/github/appium/ruby_lib/Appium/Core/Device:pull_file"
ruby: "http://www.rubydoc.info/github/appium/ruby_lib_core/Appium/Core/Device#pull_file-instance_method"
php: "https://github.com/appium/php-client/" # TODO PHP documentation link
csharp: "https://github.com/appium/appium-dotnet-driver/" # TODO Dotnet documentation link

View File

@@ -17,7 +17,7 @@ example_usage:
let data = driver.pullFolder('/data/local/tmp/file.txt');
ruby:
|
@driver.pull_folder('/data/local/tmp/file.txt');
@driver.pull_folder('/data/local/tmp/file.txt')
php:
|
// TODO PHP sample
@@ -30,7 +30,7 @@ client_docs:
python: "https://github.com/appium/python-client/blob/master/appium/webdriver/webdriver.py#L503"
javascript_wdio: "http://webdriver.io/api/mobile/pullFolder.html"
javascript_wd: "https://github.com/admc/wd/blob/master/lib/commands.js#L2688"
ruby: "http://www.rubydoc.info/github/appium/ruby_lib/Appium/Core/Device:pull_folder"
ruby: "http://www.rubydoc.info/github/appium/ruby_lib_core/Appium/Core/Device#pull_folder-instance_method"
php: "https://github.com/appium/php-client/" # TODO PHP documentation link
csharp: "https://github.com/appium/appium-dotnet-driver/" # TODO Dotnet documentation link

View File

@@ -18,7 +18,7 @@ example_usage:
driver.pushFile('/data/local/tmp/file.txt', data);
ruby:
|
@driver.push_file('/Users/johndoe/path/to/app.apk');
@driver.push_file('/path/to/device/foo.bar', 'QXJlIHlvdXIgYmVlcnMgb2theT8=')
php:
|
// TODO PHP sample
@@ -31,7 +31,7 @@ client_docs:
python: "https://github.com/appium/python-client/blob/master/appium/webdriver/webdriver.py#L515"
javascript_wdio: "http://webdriver.io/api/mobile/pushFile.html"
javascript_wd: "https://github.com/admc/wd/blob/master/lib/commands.js#L2640"
ruby: "http://www.rubydoc.info/github/appium/ruby_lib/Appium/Core/Device:push_file"
ruby: "http://www.rubydoc.info/github/appium/ruby_lib_core/Appium/Core/Device#push_file-instance_method"
php: "https://github.com/appium/php-client/" # TODO PHP documentation link
csharp: "https://github.com/appium/appium-dotnet-driver/" # TODO Dotnet documentation link

View File

@@ -15,7 +15,7 @@ example_usage:
driver.isLocked();
ruby:
|
@driver.device_locked()
@driver.device_locked?
php:
|
// TODO PHP sample
@@ -27,7 +27,7 @@ client_docs:
java: "http://appium.github.io/java-client/io/appium/java_client/android/LocksAndroidDevice.html#isLocked--"
javascript_wdio: "http://webdriver.io/api/mobile/isLocked.html"
javascript_wd: "https://github.com/admc/wd/blob/master/lib/commands.js#L2407"
ruby: "http://www.rubydoc.info/github/appium/ruby_lib/Appium/Core/Device:device_locked%3F"
ruby: "http://www.rubydoc.info/github/appium/ruby_lib_core/Appium/Core/Device#device_locked%3F-instance_method"
php: "https://github.com/appium/php-client/" # TODO PHP documentation link
csharp: "https://github.com/appium/appium-dotnet-driver/" # TODO Dotnet documentation link

View File

@@ -19,7 +19,8 @@ example_usage:
driver.lock();
ruby:
|
@driver.lock()
@driver.lock
@driver.lock(5) # lock 5 seconds
php:
|
// TODO PHP sample
@@ -32,7 +33,7 @@ client_docs:
python: "https://github.com/appium/python-client/blob/master/appium/webdriver/webdriver.py#L643"
javascript_wdio: "http://webdriver.io/api/mobile/lock.html"
javascript_wd: "https://github.com/admc/wd/blob/master/lib/commands.js#L2363"
ruby: "https://github.com/appium/ruby_lib/blob/master/lib/appium_lib/core/common/command.rb#L37"
ruby: "http://www.rubydoc.info/github/appium/ruby_lib_core/Appium/Core/Device#lock-instance_method"
php: "https://github.com/appium/php-client/" # TODO PHP documentation link
csharp: "https://github.com/appium/appium-dotnet-driver/" # TODO Dotnet documentation link

View File

@@ -18,7 +18,7 @@ example_usage:
driver.shake();
ruby:
|
@driver.shake()
@driver.shake
php:
|
// TODO PHP sample
@@ -31,7 +31,7 @@ client_docs:
python: "https://github.com/appium/python-client/blob/master/appium/webdriver/webdriver.py#L655"
javascript_wdio: "http://webdriver.io/api/mobile/shake.html"
javascript_wd: "https://github.com/admc/wd/blob/master/lib/commands.js#L2342"
ruby: "http://www.rubydoc.info/github/appium/ruby_lib/Appium/Core/Device:shake"
ruby: "http://www.rubydoc.info/github/appium/ruby_lib_core/Appium/Core/Device#shake-instance_method"
php: "https://github.com/appium/php-client/" # TODO PHP documentation link
csharp: "https://github.com/appium/appium-dotnet-driver/" # TODO Dotnet documentation link

View File

@@ -15,11 +15,13 @@ example_usage:
|
await driver.lock();
await driver.unlock();
javascript_wdio:
|
driver.lock()
.unlock();
ruby:
|
@driver.unlock
php:
|
// TODO PHP sample
@@ -31,6 +33,7 @@ client_docs:
java: "http://appium.github.io/java-client/io/appium/java_client/android/LocksAndroidDevice.html#unlockDevice---"
javascript_wdio: "http://webdriver.io/api/mobile/unlock.html"
javascript_wd: "https://github.com/admc/wd/blob/master/lib/commands.js#L2386"
ruby: "http://www.rubydoc.info/github/appium/ruby_lib_core/Appium/Core/Device#unlock-instance_method"
php: "https://github.com/appium/php-client/" # TODO PHP documentation link
csharp: "https://github.com/appium/appium-dotnet-driver/" # TODO Dotnet documentation link

View File

@@ -17,7 +17,7 @@ example_usage:
driver.hideDeviceKeyboard();
ruby:
|
@driver.hide_keyboard()
@driver.hide_keyboard
php:
|
// TODO PHP sample
@@ -30,7 +30,7 @@ client_docs:
python: "https://github.com/appium/python-client/blob/master/appium/webdriver/webdriver.py#L378"
javascript_wdio: "http://webdriver.io/api/mobile/hideDeviceKeyboard.html"
javascript_wd: "https://github.com/admc/wd/blob/master/lib/commands.js#L2609"
ruby: "https://github.com/appium/ruby_lib/blob/master/lib/appium_lib/core/common/command.rb#L42"
ruby: "http://www.rubydoc.info/github/appium/ruby_lib_core/Appium/Core/Device#hide_keyboard-instance_method"
php: "https://github.com/appium/php-client/" # TODO PHP documentation link
csharp: "https://github.com/appium/appium-dotnet-driver/" # TODO Dotnet documentation link

View File

@@ -8,11 +8,11 @@ example_usage:
boolean isKeyboardShown = driver.isKeyboardShown();
ruby:
|
@driver.is_keyboard_shown();
@driver.is_keyboard_shown
client_docs:
java: "http://appium.github.io/java-client/io/appium/java_client/android/HasDeviceDetails.html#isKeyboardShown--"
ruby: "https://github.com/appium/ruby_lib/blob/master/lib/appium_lib/core/common/command.rb#L24"
ruby: "http://www.rubydoc.info/github/appium/ruby_lib_core/Appium/Core/Device#is_keyboard_shown-instance_method"
# Driver support by platform
driver_support:

View File

@@ -27,7 +27,7 @@ client_docs:
java: "http://appium.github.io/java-client/io/appium/java_client/PressesKeyCode.html#longPressKeyCode-int-"
python: "https://github.com/appium/python-client/blob/master/appium/webdriver/webdriver.py#L431"
javascript_wdio: "http://webdriver.io/api/mobile/longPressKeycode.html"
ruby: "http://www.rubydoc.info/github/appium/ruby_lib/Appium/Core/Device:long_press_keycode"
ruby: "http://www.rubydoc.info/github/appium/ruby_lib_core/Appium/Core/Device#long_press_keycode-instance_method"
php: "https://github.com/appium/php-client/" # TODO PHP documentation link
csharp: "https://github.com/appium/appium-dotnet-driver/" # TODO Dotnet documentation link

View File

@@ -27,7 +27,7 @@ client_docs:
java: "http://appium.github.io/java-client/io/appium/java_client/PressesKeyCode.html#pressKeyCode-int-"
python: "https://github.com/appium/python-client/blob/master/appium/webdriver/webdriver.py#L415"
javascript_wdio: "http://webdriver.io/api/mobile/longPressKeycode.html"
ruby: "http://www.rubydoc.info/github/appium/ruby_lib/Appium/Core/Device:long_press_keycode"
ruby: "http://www.rubydoc.info/github/appium/ruby_lib_core/Appium/Core/Device#press_keycode-instance_method"
php: "https://github.com/appium/php-client/" # TODO PHP documentation link
csharp: "https://github.com/appium/appium-dotnet-driver/" # TODO Dotnet documentation link

View File

@@ -11,7 +11,7 @@ example_usage:
driver.toggleAirplaneMode();
ruby:
|
@driver.toggle_flight_mode();
@driver.toggle_flight_mode
php:
|
// TODO
@@ -22,7 +22,7 @@ example_usage:
client_docs:
javascript_wdio: "http://webdriver.io/api/mobile/toggleAirplaneMode.html"
javascript_wd: "https://github.com/admc/wd/blob/master/lib/commands.js#L2712"
ruby: "http://www.rubydoc.info/github/appium/ruby_lib/Appium/Core/Device:toggle_flight_mode"
ruby: "http://www.rubydoc.info/github/appium/ruby_lib_core/Appium/Core/Device#toggle_flight_mode-instance_method"
php: "https://github.com/appium/php-client/" # TODO
csharp: "https://github.com/appium/appium-dotnet-driver/" # TODO

View File

@@ -8,7 +8,7 @@ example_usage:
List<List<Object>> performanceData = driver.getPerformanceData("my.app.package", "cpuinfo", 5);
ruby:
|
@driver.get_performance_data()
@driver.get_performance_data package_name: 'io.appium.android.apis', data_type: 'cpuinfo', data_read_timeout: 10
php:
|
// TODO PHP sample
@@ -18,7 +18,7 @@ example_usage:
client_docs:
java: "http://appium.github.io/java-client/io/appium/java_client/android/HasSupportedPerformanceDataType.html#getSupportedPerformanceDataTypes--"
ruby: "https://github.com/appium/ruby_lib/blob/master/lib/appium_lib/core/common/command.rb#L59"
ruby: "http://www.rubydoc.info/github/appium/ruby_lib_core/Appium/Android/Device#get_performance_data-instance_method"
php: "https://github.com/appium/php-client/" # TODO PHP documentation link
csharp: "https://github.com/appium/appium-dotnet-driver/" # TODO Dotnet documentation link

View File

@@ -8,7 +8,7 @@ example_usage:
List<String> performanceTypes = driver.getSupportedPerformanceDataTypes();
ruby:
|
@driver.get_performance_data_types()
@driver.get_performance_data_types
php:
|
// TODO PHP sample
@@ -18,7 +18,7 @@ example_usage:
client_docs:
java: "http://appium.github.io/java-client/io/appium/java_client/android/HasSupportedPerformanceDataType.html#getSupportedPerformanceDataTypes--"
ruby: "http://www.rubydoc.info/github/appium/ruby_lib/Appium/Android/Device:get_performance_data_types"
ruby: "http://www.rubydoc.info/github/appium/ruby_lib_core/Appium/Android/Device#get_performance_data_types-instance_method"
php: "https://github.com/appium/php-client/" # TODO PHP documentation link
csharp: "https://github.com/appium/appium-dotnet-driver/" # TODO Dotnet documentation link

View File

@@ -24,7 +24,7 @@ example_usage:
driver.toggleTouchIdEnrollment(true);
ruby:
|
@driver.toggle_touch_id_enrollment()
@driver.toggle_touch_id_enrollment
php:
|
// TODO PHP sample
@@ -37,7 +37,7 @@ client_docs:
python: "https://github.com/appium/python-client/blob/master/appium/webdriver/webdriver.py#L670"
javascript_wdio: "http://webdriver.io/api/mobile/toggleTouchIdEnrollment.html"
javascript_wd: "https://github.com/admc/wd/blob/master/lib/commands.js#L3150"
ruby: "https://github.com/appium/ruby_lib/blob/master/lib/appium_lib/core/common/command.rb#L64"
ruby: "http://www.rubydoc.info/github/appium/ruby_lib_core/Appium/Ios/Device#toggle_touch_id_enrollment-instance_method"
php: "https://github.com/appium/php-client/" # TODO PHP documentation link
csharp: "https://github.com/appium/appium-dotnet-driver/" # TODO Dotnet documentation link

View File

@@ -45,7 +45,7 @@ client_docs:
python: "https://github.com/appium/python-client/blob/master/appium/webdriver/webdriver.py#L661"
javascript_wdio: "http://webdriver.io/api/mobile/touchId.html"
javascript_wd: "https://github.com/admc/wd/blob/master/lib/commands.js#L3133"
ruby: "http://www.rubydoc.info/github/appium/ruby_lib/Appium/Ios/Device:touch_id"
ruby: "http://www.rubydoc.info/github/appium/ruby_lib_core/Appium/Ios/Device#touch_id-instance_method"
php: "https://github.com/appium/php-client/" # TODO PHP documentation link
csharp: "https://github.com/appium/appium-dotnet-driver/" # TODO Dotnet documentation link

View File

@@ -30,7 +30,7 @@ client_docs:
python: "https://github.com/appium/python-client/blob/master/appium/webdriver/webdriver.py#L676"
javascript_wdio: "http://webdriver.io/api/mobile/openNotifications.html"
javascript_wd: "https://github.com/admc/wd/blob/master/lib/commands.js#L3004"
ruby: "https://github.com/appium/ruby_lib/blob/master/lib/appium_lib/core/common/command.rb#L18"
ruby: "http://www.rubydoc.info/github/appium/ruby_lib_core/Appium/Core/Device#open_notifications-instance_method"
php: "https://github.com/appium/php-client/" # TODO
csharp: "https://github.com/appium/appium-dotnet-driver/" # TODO

View File

@@ -8,7 +8,7 @@ example_usage:
Map<String, String> systemBars = driver.getSystemBars();
ruby:
|
@driver.get_system_bars();
@driver.get_system_bars
php:
|
// TODO
@@ -18,7 +18,7 @@ example_usage:
client_docs:
java: "http://appium.github.io/java-client/io/appium/java_client/android/HasDeviceDetails.html#getSystemBars--"
ruby: "http://www.rubydoc.info/github/appium/ruby_lib/Appium/Core/Device:get_system_bars"
ruby: "http://www.rubydoc.info/github/appium/ruby_lib_core/Appium/Core/Device#get_system_bars-instance_method"
php: "https://github.com/appium/php-client/" # TODO
csharp: "https://github.com/appium/appium-dotnet-driver/" # TODO

View File

@@ -30,7 +30,7 @@ client_docs:
python: "https://github.com/appium/python-client/blob/master/appium/webdriver/webdriver.py#L798"
javascript_wdio: "http://webdriver.io/api/mobile/getDeviceTime.html"
javascript_wd: "https://github.com/admc/wd/blob/master/lib/commands.js#L3119"
ruby: "https://github.com/appium/ruby_lib/blob/master/lib/appium_lib/core/common/command.rb#L13"
ruby: "http://www.rubydoc.info/github/appium/ruby_lib_core/Appium/Core/Device#device_time-instance_method"
php: "https://github.com/appium/php-client/" # TODO
csharp: "https://github.com/appium/appium-dotnet-driver/" # TODO

View File

@@ -18,7 +18,7 @@ example_usage:
driver.clearElement("~SomeAccessibilityId");
ruby:
|
@driver.find_element(:accessibility_id, "SomeAccessibilityID").clear()
@driver.find_element(:accessibility_id, "SomeAccessibilityID").clear
php:
|
// TODO PHP sample

View File

@@ -20,7 +20,7 @@ example_usage:
let isDisplayed = driver.elementIdDisplayed("~SomeAccessibilityId");
ruby:
|
@driver.find_element(:accessibility_id, "SomeAccessibilityID").displayed?()
@driver.find_element(:accessibility_id, "SomeAccessibilityID").displayed?
php:
|
// TODO PHP sample

View File

@@ -18,7 +18,7 @@ example_usage:
let isEnabled = driver.isEnabled("~SomeAccessibilityId");
ruby:
|
@driver.find_element(:accessibility_id, "SomeAccessibilityID").enabled?()
@driver.find_element(:accessibility_id, "SomeAccessibilityID").enabled?
php:
|
// TODO PHP sample

View File

@@ -5,21 +5,19 @@ short_description: Get an element's tag name
example_usage:
java:
|
MobileElement element = (MobileElement) driver.findElementByAccessibilityId("SomeAccessibilityID");
String tagName = element.getTagName();
// TODO Java sample
python:
|
tagName = self.driver.find_element_by_accessibility_id('SomeAccessibilityID').tag_name
// TODO Python sample
javascript_wd:
|
let element = await driver.elementByAccessibilityId("SomeAccessibilityID");
let tagName = await element.getTagName();
// TODO javascript_wd sample
javascript_wdio:
|
let tagName = driver.getTagName("~SomeAccessibilityId");
// TODO javascript_wdio sample
ruby:
|
@driver.find_element(:accessibility_id, 'SomeAccessibilityID').tag_name
// TODO Ruby sample
php:
|
// TODO PHP sample
@@ -60,7 +58,7 @@ client_support:
# Information about the HTTP endpoints
endpoint:
url: /wd/hub/session/:session_id/elements/:element_id/name
url: /wd/hub/session/:session_id/element/:element_id/pageIndex
method: 'GET'
url_parameters:
- name: session_id
@@ -73,5 +71,4 @@ endpoint:
# Links to specifications. Should link to at least one specification
specifications:
w3c: https://www.w3.org/TR/webdriver/#dfn-get-element-tag-name
jsonwp: https://github.com/SeleniumHQ/selenium/wiki/JsonWireProtocol#sessionsessionidelementidname
jsonwp: https://github.com/appium/appium-base-driver/blob/master/lib/mjsonwp/routes.js#L285

View File

@@ -14,6 +14,10 @@ example_usage:
javascript_wdio:
|
let rect = driver.elementIdRect("~SomeAccessibilityId");
ruby:
|
element = @driver.find_element :accessibility_id, "SomeAccessibilityID"
element.rect
php:
|
// TODO PHP sample
@@ -24,6 +28,7 @@ example_usage:
client_docs:
java: "https://seleniumhq.github.io/selenium/docs/api/java/org/openqa/selenium/WebElement.html#getRect--"
javascript_wdio: "http://webdriver.io/api/protocol/elementIdRect.html"
ruby: "http://www.rubydoc.info/gems/selenium-webdriver/Selenium/WebDriver/Element#rect-instance_method"
php: "https://github.com/appium/php-client/" # TODO PHP documentation link
csharp: "https://github.com/appium/appium-dotnet-driver/" # TODO Dotnet documentation link

View File

@@ -1,29 +1,27 @@
---
name: Get Element Text
short_description: Returns visible text for element
name: Replace the value
short_description: Replace the value to element directly
description:
>
Returns the visible text for the element.
Replace the value to element directly.
example_usage:
java:
|
MobileElement element = (MobileElement) driver.findElementByClassName("SomeClassName");
let elText = element.getText();
// TODO Java sample
python:
|
# el = self.driver.find_element_by_accessibility_id('SomeId')
# TODO: Python example
// TODO: Python example
javascript_wd:
|
let element = await driver.elementByAccessibilityId("SomeAccessibilityID");
await element.submit();
// TODO JavaScript sample
javascript_wdio:
|
driver.getText("~SomeAccessibilityId");
// TODO JavaScript sample
ruby:
|
# TODO Ruby sample
element = @driver.find_element :accessibility_id, "SomeAccessibilityID"
@driver.replace_value element, 'some'
php:
|
// TODO PHP sample
@@ -32,11 +30,11 @@ example_usage:
// TODO C# sample
client_docs:
java: "https://seleniumhq.github.io/selenium/docs/api/java/org/openqa/selenium/WebElement.html#getText--"
java: "https://seleniumhq.github.io/selenium/docs/api/java/org/openqa/selenium/WebElement.html#getText--" # TODO Java documentation link
python: "http://selenium-python.readthedocs.io/api.html" # TODO Python documentation link
javascript_wdio: "http://webdriver.io/api/property/getText.html"
javascript_wd: "https://github.com/admc/wd/blob/master/lib/commands.js#L1832"
ruby: "http://www.rubydoc.info/gems/selenium-webdriver/Selenium/WebDriver/" # TODO Ruby documentation link
javascript_wdio: "http://webdriver.io/api/property/getText.html" # TODO JAvaScript documentation link
javascript_wd: "https://github.com/admc/wd/blob/master/lib/commands.js#L1832" # TODO JAvaScript documentation link
ruby: "http://www.rubydoc.info/github/appium/ruby_lib_core/Appium/Core/Device#replace_value-instance_method"
php: "https://github.com/appium/php-client/" # TODO PHP documentation link
csharp: "https://github.com/appium/appium-dotnet-driver/" # TODO Dotnet documentation link
@@ -64,15 +62,18 @@ client_support:
# Information about the HTTP endpoints
endpoint:
url: /wd/hub/session/:session_id/element/:element_id/value
url: /wd/hub/session/:session_id/appium/element/:element_id/replace_value
method: 'POST'
url_parameters:
- name: session_id
description: ID of the session to route the command to
- name: element_id
description: ID of the element to get the text from
json_parameters:
- name: value
type: array<string>
description: The sequence of keys to type. An array must be provided. The server should flatten the array items to a single string to be typed.
# Links to specifications. Should link to at least one specification
specifications:
w3c: https://www.w3.org/TR/webdriver/#dfn-get-element-text
jsonwp: https://github.com/SeleniumHQ/selenium/wiki/JsonWireProtocol#sessionsessionidelementidvalue
jsonwp: https://github.com/appium/appium-base-driver/blob/master/lib/mjsonwp/routes.js#L451

View File

@@ -18,7 +18,7 @@ example_usage:
let isSelected = driver.isSelected("~SomeAccessibilityId");
ruby:
|
@driver.find_element(:accessibility_id, "SomeAccessibilityID").selected?()
@driver.find_element(:accessibility_id, "SomeAccessibilityID").selected?
php:
|
// TODO PHP sample

View File

@@ -23,7 +23,8 @@ example_usage:
driver.getText("~SomeAccessibilityId");
ruby:
|
# TODO Ruby sample
element = @driver.find_element :accessibility_id, "SomeAccessibilityID"
element.text
php:
|
// TODO PHP sample
@@ -36,7 +37,7 @@ client_docs:
python: "http://selenium-python.readthedocs.io/api.html" # TODO Python documentation link
javascript_wdio: "http://webdriver.io/api/property/getText.html"
javascript_wd: "https://github.com/admc/wd/blob/master/lib/commands.js#L1832"
ruby: "http://www.rubydoc.info/gems/selenium-webdriver/Selenium/WebDriver/" # TODO Ruby documentation link
ruby: "http://www.rubydoc.info/gems/selenium-webdriver/Selenium/WebDriver/Element#text-instance_method"
php: "https://github.com/appium/php-client/" # TODO PHP documentation link
csharp: "https://github.com/appium/appium-dotnet-driver/" # TODO Dotnet documentation link

View File

@@ -36,7 +36,7 @@ example_usage:
driver.elements("~SomeAccessibilityId");
ruby:
|
@driver.find_elements("~SomeAccessibilityID")
@driver.find_elements(:accessibility_id, "~SomeAccessibilityID")
php:
|
// TODO PHP sample

View File

@@ -17,7 +17,7 @@ example_usage:
driver.elementActive();
ruby:
|
# TODO Ruby example
@driver.switch_to.active_element
php:
|
// TODO PHP example
@@ -30,7 +30,7 @@ client_docs:
python: "http://selenium-python.readthedocs.io/api.html?highlight=active_element#selenium.webdriver.remote.webdriver.WebDriver.switch_to_active_element" # TODO
javascript_wdio: "http://webdriver.io/api/protocol/elementActive.html"
javascript_wd: "https://github.com/admc/wd/blob/master/lib/commands.js#L1934"
ruby: "http://www.rubydoc.info/gems/selenium-webdriver/Selenium/WebDriver/" # TODO
ruby: "http://www.rubydoc.info/gems/selenium-webdriver/0.0.28/Selenium/WebDriver/TargetLocator#active_element-instance_method"
php: "https://github.com/appium/php-client/" # TODO
csharp: "https://github.com/appium/appium-dotnet-driver/" # TODO

View File

@@ -23,7 +23,9 @@ example_usage:
# TODO WDIO example
ruby:
|
# TODO Ruby example
element1 = @driver.find_element :class_name, "someClass"
element2 = @driver.find_element :class_name, "someOtherClass"
element1 == element2
php:
|
// TODO PHP sample
@@ -36,7 +38,7 @@ client_docs:
python: "http://selenium-python.readthedocs.io/api.html" # TODO Python documentation link
javascript_wdio: "http://webdriver.io/api/state/isEnabled.html"
javascript_wd: "https://github.com/admc/wd/blob/master/lib/commands.js#L1463"
ruby: "http://www.rubydoc.info/gems/selenium-webdriver/Selenium/WebDriver/Element#enabled%3F-instance_method"
ruby: "http://www.rubydoc.info/gems/selenium-webdriver/0.0.28/Selenium/WebDriver/Element#==-instance_method"
php: "https://github.com/appium/php-client/" # TODO PHP documentation link
csharp: "https://github.com/appium/appium-dotnet-driver/" # TODO Dotnet documentation link

View File

@@ -23,7 +23,8 @@ example_usage:
driver.submitForm("~SomeAccessibilityId");
ruby:
|
# TODO Ruby sample
element = @driver.find_element :class_name, "someClass"
element.submit element
php:
|
// TODO PHP sample
@@ -36,7 +37,7 @@ client_docs:
python: "http://selenium-python.readthedocs.io/api.html#selenium.webdriver.remote.webelement.WebElement.submit"
javascript_wdio: "http://webdriver.io/api/action/submitForm.html"
javascript_wd: "https://github.com/admc/wd/blob/master/lib/commands.js#L1741"
ruby: "http://www.rubydoc.info/gems/selenium-webdriver/Selenium/WebDriver/" # TODO Ruby documentation link
ruby: "http://www.rubydoc.info/gems/selenium-webdriver/0.0.28/Selenium/WebDriver/Element#submit-instance_method"
php: "https://github.com/appium/php-client/" # TODO PHP documentation link
csharp: "https://github.com/appium/appium-dotnet-driver/" # TODO Dotnet documentation link

View File

@@ -17,7 +17,7 @@ example_usage:
driver.back();
ruby:
|
@driver.back()
@driver.back
php:
|
// TODO PHP sample

View File

@@ -18,7 +18,7 @@ example_usage:
driver.end();
ruby:
|
@driver.quit();
@driver.quit
php:
|
// TODO PHP sample

View File

@@ -18,7 +18,7 @@ example_usage:
let location = driver.location();
ruby:
|
@driver.location()
@driver.location
php:
|
// TODO PHP sample

View File

@@ -18,7 +18,7 @@ example_usage:
let caps = driver.session('c8db88a0-47a6-47a1-802d-164d746c06aa');
ruby:
|
@driver.session_capabilities()
@driver.session_capabilities
php:
|
// TODO PHP sample

View File

@@ -18,7 +18,7 @@ example_usage:
driver.log()
ruby:
|
log_types = @driver.logTypes
@driver.get_available_log_types
php:
|
// TODO PHP sample
@@ -31,7 +31,7 @@ client_docs:
python: "http://selenium-python.readthedocs.io/api.html?highlight=get_log#selenium.webdriver.remote.webdriver.WebDriver.log_types"
javascript_wdio: "http://webdriver.io/api/protocol/logTypes.html"
javascript_wd: "https://github.com/admc/wd/blob/master/lib/commands.js#L441"
ruby: "http://www.rubydoc.info/gems/selenium-webdriver/Selenium%2FWebDriver%2FRemote%2FOSS%2FBridge:available_log_types"
ruby: "http://www.rubydoc.info/github/appium/ruby_lib/Appium/Common#get_available_log_types-instance_method"
php: "https://github.com/appium/php-client/" # TODO PHP documentation link
csharp: "https://github.com/appium/appium-dotnet-driver/" # TODO Dotnet documentation link

View File

@@ -18,7 +18,7 @@ example_usage:
let logs = driver.log('driver')
ruby:
|
@driver.logs('driver')
@driver.get_log('driver')
php:
|
// TODO PHP sample
@@ -31,7 +31,7 @@ client_docs:
python: "http://selenium-python.readthedocs.io/api.html?highlight=get_log#selenium.webdriver.remote.webdriver.WebDriver.get_log"
javascript_wdio: "http://webdriver.io/api/protocol/log.html"
javascript_wd: "https://github.com/admc/wd/blob/master/lib/commands.js#L455"
ruby: "http://www.rubydoc.info/gems/selenium-webdriver/Selenium%2FWebDriver%2FTouchActionBuilder:scroll"
ruby: "http://www.rubydoc.info/github/appium/ruby_lib/Appium/Common#get_log-instance_method"
php: "https://github.com/appium/php-client/" # TODO PHP documentation link
csharp: "https://github.com/appium/appium-dotnet-driver/" # TODO Dotnet documentation link

View File

@@ -18,7 +18,7 @@ example_usage:
let orientation = driver.orientation();
ruby:
|
@driver.orientation()
@driver.orientation
php:
|
// TODO PHP sample

View File

@@ -18,7 +18,7 @@ example_usage:
driver.orientation("LANDSCAPE");
ruby:
|
@driver.orientation("LANDSCAPE")
@driver.rotation = :landscape
php:
|
// TODO PHP sample

View File

@@ -11,11 +11,15 @@ example_usage:
javascript_wdio:
|
let settings = driver.settings();
ruby:
|
@driver.get_settings
client_docs:
java: "http://appium.github.io/java-client/io/appium/java_client/HasSettings.html#getSettings--"
javascript_wdio: "http://webdriver.io/api/mobile/settings.html"
javascript_wd: "https://github.com/admc/wd/blob/master/lib/commands.js#L3018"
ruby: "http://www.rubydoc.info/github/appium/ruby_lib_core/Appium/Core/Device#get_settings-instance_method"
# Driver support by platform
driver_support:

View File

@@ -11,11 +11,15 @@ example_usage:
javascript_wdio:
|
driver.settings({nativeWebTap: true});
ruby:
|
@driver.update_settings(sample: 'value')
client_docs:
java: "http://appium.github.io/java-client/io/appium/java_client/HasSettings.html#setSetting-io.appium.java_client.Setting-java.lang.Object-"
javascript_wdio: "http://webdriver.io/api/mobile/settings.html"
javascript_wd: "https://github.com/admc/wd/blob/master/lib/commands.js#L3032"
ruby: "http://www.rubydoc.info/github/appium/ruby_lib_core/Appium/Core/Device#update_settings-instance_method"
# Driver support by platform
driver_support:

View File

@@ -27,7 +27,7 @@ example_usage:
driver.timeoutsImplicitWait(5000)
ruby:
|
@driver.implicit_wait(5) # Ruby translates it to seconds
@driver.manage.timeouts.implicit_wait = 5 # Ruby translates it to seconds
php:
|
// TODO PHP sample

View File

@@ -22,7 +22,7 @@ example_usage:
driver.timeouts('pageLoad', 5000)
ruby:
|
@driver.page_load(5) # Ruby translates it to seconds
@driver.timeout('pageLoad', 5) # Ruby translates it to seconds
php:
|
// TODO PHP sample
@@ -35,7 +35,7 @@ client_docs:
python: "http://selenium-python.readthedocs.io/api.html#selenium.webdriver.remote.webdriver.WebDriver.set_page_load_timeout"
javascript_wdio: "http://webdriver.io/guide/testrunner/timeouts.html#Selenium-timeouts"
javascript_wd: "https://github.com/admc/wd/blob/master/lib/commands.js#L714"
ruby: "http://www.rubydoc.info/gems/selenium-webdriver/Selenium/WebDriver/Timeouts:page_load="
ruby: "http://www.rubydoc.info/gems/selenium-webdriver/Selenium/WebDriver/Remote/OSS/Bridge#timeout-instance_method"
php: "https://github.com/appium/php-client/" # TODO PHP documentation link
csharp: "https://github.com/appium/appium-dotnet-driver/" # TODO Dotnet documentation link

View File

@@ -21,7 +21,8 @@ example_usage:
driver.status();
ruby:
|
# TODO
@driver.remote_status
remote_status
php:
|
// TODO

View File

@@ -18,7 +18,7 @@ example_usage:
driver.frameParent();
ruby:
|
@driver.parent_frame()
@driver.parent_frame
php:
|
// TODO PHP sample

View File

@@ -17,7 +17,7 @@ example_usage:
driver.back();
ruby:
|
@driver.back()
@driver.back
php:
|
// TODO PHP sample

View File

@@ -17,7 +17,7 @@ example_usage:
driver.forward();
ruby:
|
@driver.forward()
@driver.forward
php:
|
// TODO PHP sample

View File

@@ -17,7 +17,7 @@ example_usage:
driver.refresh();
ruby:
|
@driver.refresh()
@driver.refresh
php:
|
// TODO PHP sample

View File

@@ -17,7 +17,7 @@ example_usage:
driver.cookie("delete");
ruby:
|
@driver.delete_all_cookies()
@driver.delete_all_cookies
php:
|
// TODO PHP sample