Appium 客户端库 API
## Appium 客户端库
Appium 有对应以下语言的客户端库:
语言 | 代码
:--|--:
[Ruby][rubygems] | [GitHub](https://github.com/appium/ruby_lib)
[Python][pypi] | [GitHub](https://github.com/appium/python-client)
[Java][maven] | [GitHub](https://github.com/appium/java-client)
[JavaScript][npm] | [GitHub](https://github.com/admc/wd)
[PHP][php] | [GitHub](https://github.com/appium/php-client)
[C#][nuget] | [GitHub](https://github.com/appium/appium-dotnet-driver)
[Objective-C][cocoapods] | [GitHub](https://github.com/appium/selenium-objective-c)
[rubygems]: http://rubygems.org/gems/appium_lib
[pypi]: https://pypi.python.org/pypi/Appium-Python-Client
[maven]: https://search.maven.org/#search%7Cga%7C1%7Cg%3Aio.appium%20a%3Ajava-client
[npm]: https://www.npmjs.org/package/wd
[php]: https://github.com/appium/php-client
[nuget]: http://www.nuget.org/packages/Appium.WebDriver/
[cocoapods]: https://github.com/appium/selenium-objective-c
请注意：有些方法，比如 `endTestCoverage()` 目前不能提供完整支持。
只有[这个问题](https://github.com/appium/appium/issues/2448)修复， 完整的覆盖率支持才会被添加。
如果你一定要用这些方法，请先查看 Github 上关于 bindings 的文档。
### 锁定
锁定屏幕
```ruby
# ruby
lock 5
```
```python
# python
driver.lock(5)
```
```java
// java
driver.lockScreen(3);
```
```javascript
// javascript
driver.lock(3)
```
```php
// php
$this->lock(3);
```
```csharp
// c#
driver.LockDevice(3);
```
```objectivec
// objective c
[driver lockDeviceScreen:3];
```
### 将 app 置于后台
把当前应用放到后台去
```ruby
# ruby
background_app 5
```
```python
# python
driver.background_app(5)
```
```java
// java
driver.runAppInBackground(5);
```
```javascript
// javascript
driver.backgroundApp(5)
```
```php
// php
$this->backgroundApp(5);
```
```csharp
// c#
driver.BackgroundApp(5);
```
```objectivec
// objective c
[driver runAppInBackground:3];
```
### 收起键盘
收起键盘
```ruby
# ruby
hide_keyboard
```
```python
# python
driver.hide_keyboard()
```
```java
// java
driver.hideKeyboard();
```
```javascript
// javascript
driver.hideKeyboard()
```
```php
// php
$this->hideKeyboard();
$this->hideKeyboard(array('strategy' => 'pressKey', 'key' => 'Done'));
```
```csharp
// c#
driver.HideKeyboard("Done");
```
```objectivec
// objective c
[driver hideKeyboard];
```
### 启动 Activity
在当前应用中打开一个 activity 或者启动一个新应用并打开一个 activity 。 *只能在 Android 上使用*
```java
// java
driver.startActivity("appPackage","com.example.android.apis", null, null);
```
```javascript
// javascript
driver.startActivity({appPackage: 'com.example.android.apis', appActivity: '.Foo'}, cb);
```
```python
# python
driver.start_activity('com.example.android.apis', '.Foo')
```
```ruby
# ruby
start_activity app_package: 'io.appium.android.apis', app_activity: '.accessibility.AccessibilityNodeProviderActivity'
```
```csharp
// c#
driver.StartActivity("com.example.android.apis", ".Foo");
```
```php
// php
$this->startActivity(array("appPackage" => "com.example.android.apis",
"appActivity" => ".Foo"));
```
```objectivec
// objective c
[driver startActivity:@"com.example.android.apis" package:@".Foo"];
```
### 打开通知栏 (Notifications)
打开下拉通知栏 *只能在 Android 上使用*
```java
// java
driver.openNotifications();
```
```javascript
// javascript
driver.openNotifications(cb);
```
```python
# python
driver.open_notifications()
```
```ruby
# ruby
openNotifications
```
```csharp
// c#
driver.OpenNotifications();
```
```php
// php
$this->openNotifications();
```
```objectivec
// objective c
[driver openNotifications];
```
### 是否已经安装
检查应用是否已经安装
```ruby
# ruby
is_installed? "com.example.android.apis"
```
```python
# python
driver.is_app_installed('com.example.android.apis')
```
```java
// java
driver.isAppInstalled("com.example.android.apis")
```
```javascript
// javascript
driver.isAppInstalled("com.example.android.apis")
.then(function (isAppInstalled) { /*...*/ })
```
```php
// php
$this->isAppInstalled('com.example.android.apis');
```
```csharp
// c#
driver.IsAppInstalled("com.example.android.apis-");
```
```objectivec
// objective c
[driver isAppInstalled:@"com.example.android.apis-"];
```
### 安装应用
安装应用到设备中去
```ruby
# ruby
install 'path/to/my.apk'
```
```python
# python
driver.install_app('path/to/my.apk')
```
```java
// java
driver.installApp("path/to/my.apk")
```
```javascript
// javascript
driver.installApp("path/to/my.apk")
```
```php
// php
$this->installApp('path/to/my.apk');
```
```csharp
// c#
driver.InstallApp("path/to/my.apk");
```
```objectivec
// objective c
[driver installAppAtPath:@"path/to/my.apk"];
```
### 删除应用
从设备中删除一个应用
```ruby
# ruby
remove 'com.example.android.apis'
```
```python
# python
driver.remove_app('com.example.android.apis')
```
```java
// java
driver.removeApp("com.example.android.apis")
```
```javascript
// javascript
driver.removeApp("com.example.android.apis")
```
```php
// php
$this->removeApp('com.example.android.apis');
```
```csharp
// c#
driver.RemoveApp("com.example.android.apis");
```
```objectivec
// objective c
[driver removeApp:@"com.example.android.apis"];
```
### 摇晃 (Shake)
模拟设备摇晃
```ruby
# ruby
shake
```
```python
# python
driver.shake()
```
```java
// java
driver.shake()
```
```javascript
// javascript
driver.shake()
```
```php
// php
$this->shake();
```
```csharp
// c#
driver.ShakeDevice();
```
```objectivec
// objective c
[driver shakeDevice];
```
### 关闭应用
关闭应用
```ruby
# ruby
close_app
```
```python
# python
driver.close_app();
```
```java
// java
driver.closeApp()
```
```javascript
// javascript
driver.closeApp()
```
```php
// php
$this->closeApp();
```
```csharp
// c#
driver.CloseApp();
```
```objectivec
// objective c
[driver closeApp];
```
### 启动 (Launch)
根据服务关键字 (desired capabilities) 启动会话 (session) 。请注意这必须在设定 `autoLaunch=false` 关键字时才能生效。这不是用于启动指定的 app/activities ————你可以使用 `start_activity` 做到这个效果————这是用来继续进行使用了 `autoLaunch=false` 关键字时的初始化 (Launch) 流程的。
```ruby
# ruby
launch
```
```python
# python
driver.launch_app()
```
```java
// java
driver.launchApp()
```
```javascript
// javascript
driver.launchApp()
```
```php
// php
$this->launchApp();
```
```csharp
// c#
driver.LaunchApp();
```
```objectivec
// objective c
[driver launchApp];
```
### 重置 (Reset)
应用重置
(翻译者注：相当于卸载重装应用)
```ruby
# ruby
reset
```
```python
# python
driver.reset()
```
```java
// java
driver.resetApp()
```
```javascript
// javascript
driver.resetApp()
```
```php
// php
$this->reset();
```
```csharp
// c#
driver.ResetApp();
```
```objectivec
// objective c
[driver resetApp];
```
### 可用上下文 (context)
列出所有的可用上下文
翻译备注：context可以理解为 可进入的窗口 。例如，对于原生应用，可用的context和默认context均为`NATIVE_APP`。详情可查看[对混合应用进行自动化测试](http://appium.io/slate/en/v1.3.4/?ruby#automating-hybrid-apps)
```ruby
# ruby
context_array = available_contexts
```
```python
# python
driver.contexts
```
```java
// java
driver.getContextHandles()
```
```javascript
// javascript
driver.contexts().then(function (contexts) { /*...*/ })
```
```php
// php
$this->contexts();
```
```csharp
// c#
driver.GetContexts()
```
```objectivec
// objective c
NSArray *contexts = driver.allContexts;
```
### 当前上下文 (context)
列出当前上下文
```ruby
# ruby
context = current_context
```
```python
# python
driver.current_context
```
```java
// java
driver.getContext()
```
```javascript
// javascript
driver.currentContext().then(function (context) { /*...*/ })
```
```php
// php
$this->context();
```
```csharp
// c#
driver.GetContext()
```
```objectivec
// objective c
NSString *context = driver.context;
```
### 切换到默认的上下文 (context)
将上下文切换到默认上下文
```ruby
# ruby
switch_to_default_context
```
```python
# python
driver.switch_to.context(None)
```
```java
// java
driver.context();
```
```javascript
// javascript
driver.context()
```
```php
// php
$this->context(NULL);
```
```csharp
// c#
driver.SetContext();
```
```objectivec
// objective c
[driver setContext:nil];
```
### 应用的字符串 (App Strings)
获取应用的字符串
```ruby
# ruby
strings = app_strings
```
```python
# python
driver.app_strings
```
```java
// java
driver.getAppStrings();
```
```javascript
// javascript
driver.getAppStrings().then(function (appStrings) { /*...*/ })
```
```php
// php
$this->appStrings();
$this->appStrings('ru');
```
```csharp
// c#
driver.GetAppStrings();
```
```objectivec
// objective c
[driver appStrings];
[driver appStringsForLanguage:"@ru"];
```
### 按键事件 (Key Event)
给设备发送一个按键事件
```ruby
# ruby
key_event 176
```
```python
# python
driver.keyevent(176)
```
```java
// java
driver.sendKeyEvent(AndroidKeyCode.HOME);
```
```javascript
// javascript
driver.deviceKeyEvent(wd.SPECIAL_KEYS.Home)
```
```php
// php
$this->keyEvent('176');
```
```csharp
// c#
driver.KeyEvent("176");
```
```objectivec
// objective c
NSError *err;
[driver triggerKeyEvent:176 metastate:0 error:&err];
```
### 当前 Activity
获取当前 activity。只能在 Android 上使用
```ruby
# ruby
current_activity
```
```python
# python
driver.current_activity
```
```java
// java
driver.currentActivity();
```
```javascript
// javascript
driver.getCurrentActivity().then(function (activity) { /*...*/ })
```
```php
// php
$this->currentActivity();
```
```csharp
// c#
driver.GetCurrentActivity();
```
```objectivec
// objective c
NSError *err;
[driver currentActivity];
```
### 触摸动作(TouchAction) / 多点触摸动作(MultiTouchAction)
生成触摸动作的接口。这部分文档很快将会补充更多的内容进来。
```ruby
# ruby
touch_action = Appium::TouchAction.new
element = find_element :name, 'Buttons, Various uses of UIButton'
touch_action.press(element: element, x: 10, y: 10).perform
```
```python
# python
action = TouchAction(driver)
action.press(element=el, x=10, y=10).release().perform()
```
```java
// java
TouchAction action = new TouchAction(driver)
.press(mapview, 10, 10)
.release().
perform();
```
```javascript
// javascript
var action = new wd.TouchAction(driver);
action
.tap({el: el, x: 10, y: 10})
.release();
return action.perform(); // returns a promise
```
```php
// php
$action = $this->initiateTouchAction();
->press(array('element' => $el))
->release()
->perform();
$action1 = $this->initiateTouchAction();
$action1->press(array('element' => $els[0]))
->moveTo(array('x' => 10, 'y' => 0))
->moveTo(array('x' => 10, 'y' => -75))
->moveTo(array('x' => 10, 'y' => -600))
->release();
$action2 = $this->initiateTouchAction();
$action2->press(array('element' => $els[1]))
->moveTo(array('x' => 10, 'y' => 10))
->moveTo(array('x' => 10, 'y' => -300))
->moveTo(array('x' => 10, 'y' => -600))
->release();
$multiAction = $this->initiateMultiAction();
$multiAction->add($action1);
$multiAction->add($action2);
$multiAction->perform();
```
```csharp
// c#
ITouchAction action = new TouchAction(driver);
action.Press(el, 10, 10).Release();
action.Perform ();
```
### 滑动(Swipe)
模拟用户滑动
```ruby
# ruby
swipe start_x: 75, start_y: 500, end_x: 75, end_y: 0, duration: 0.8
```
```python
# python
driver.swipe(start=75, starty=500, endx=75, endy=0, duration=800)
```
```java
// java
driver.swipe(75, 500, 75, 0, 0.8)
```
```javascript
// javascript
function swipe(opts) {
var action = new wd.TouchAction(this);
action
.press({x: opts.startX, y: opts.startY})
.wait(opts.duration)
.moveTo({x: opts.endX, y: opts.endY})
.release();
return action.perform();
}
wd.addPromiseChainMethod('swipe', swipe);
// ...
return driver.swipe({ startX: 75, startY: 500,
endX: 75, endY: 0, duration: 800 });
```
```php
// php
$this->swipe(75, 500, 75, 0, 800);
```
```csharp
// c#
todo: c#
```
### 捏 (Pinch)
捏屏幕 (双指往内移动来缩小屏幕)
```ruby
# ruby
pinch 75
```
```python
# python
driver.pinch(element=el)
```
```java
// java
driver.pinch(element);
```
```javascript
// javascript
function pinch(el) {
return Q.all([
el.getSize(),
el.getLocation(),
]).then(function(res) {
var size = res[0];
var loc = res[1];
var center = {
x: loc.x + size.width / 2,
y: loc.y + size.height / 2
};
var a1 = new wd.TouchAction(this);
a1.press({el: el, x: center.x, y:center.y - 100}).moveTo({el: el}).release();
var a2 = new wd.TouchAction(this);
a2.press({el: el, x: center.x, y: center.y + 100}).moveTo({el: el}).release();
var m = new wd.MultiAction(this);
m.add(a1, a2);
return m.perform();
}.bind(this));
};
wd.addPromiseChainMethod('pinch', pinch);
wd.addElementPromiseChainMethod('pinch', function() {
return this.browser.pinch(this);
});
// ...
return driver.pinch(el);
// ...
return el.pinch();
```
```php
$this->pinch($el);
```
```csharp
// c#
driver.Pinch(25, 25)
```
### 放大 (Zoom)
放大屏幕 (双指往外移动来放大屏幕)
```ruby
# ruby
zoom 200
```
```python
# python
driver.zoom(element=el)
```
```java
// java
driver.zoom(element);
```
```javascript
// javascript
function zoom(el) {
return Q.all([
this.getWindowSize(),
this.getLocation(el),
]).then(function(res) {
var size = res[0];
var loc = res[1];
var center = {
x: loc.x + size.width / 2,
y: loc.y + size.height / 2
};
var a1 = new wd.TouchAction(this);
a1.press({el: el}).moveTo({el: el, x: center.x, y: center.y - 100}).release();
var a2 = new wd.TouchAction(this);
a2.press({el: el}).moveTo({el: el, x: center.x, y: center.y + 100}).release();
var m = new wd.MultiAction(this);
m.add(a1, a2);
return m.perform();
}.bind(this));
};
wd.addPromiseChainMethod('zoom', zoom);
wd.addElementPromiseChainMethod('zoom', function() {
return this.browser.zoom(this);
});
// ...
return driver.zoom(el);
// ...
return el.zoom();
```
```php
// php
$this->zoom($el);
```
```csharp
// c#
driver.Zoom(100, 200);
```
### 滑动到 (Scroll To)
滑动到某个元素。
```ruby
# ruby
element = find_element :name, 'Element Name'
execute_script "mobile: scrollTo", :element => element.ref
```
```python
# python
todo: python
```
```java
// java
WebElement element = driver.findElement(By.name("Element Name"));
HashMap<String, String> arguments = new HashMap<String, String>();
arguments.put("element", element.getId());
(JavascriptExecutor)driver.executeScript("mobile: scrollTo", arguments);
```
```javascript
// javascript
return driver.elementByName().then(function (el) {
return driver.execute('mobile: scrollTo', {element: el.value});
});
```
```php
// php
$els = $this->elements($this->using('class name')->value('android.widget.TextView'));
$this->scroll($els[count($els) - 1], $els[0]);
```
```csharp
// c#
todo: csharp
```
### 拉出文件 (Pull File)
从设备中拉出文件
```ruby
# ruby
pull_file 'Library/AddressBook/AddressBook.sqlitedb'
```
```python
# python
driver.pull_file('Library/AddressBook/AddressBook.sqlitedb')
```
```java
// java
driver.pullFile("Library/AddressBook/AddressBook.sqlitedb");
```
```javascript
// javascript
driver.pullFile("Library/AddressBook/AddressBook.sqlitedb")
.then(function (base64File) { /*...*/ })
```
```php
// php
$this->pullFile('Library/AddressBook/AddressBook.sqlitedb');
```
```csharp
// c#
driver.PullFile("Library/AddressBook/AddressBook.sqlitedb");
```
### 推送文件(Push file)
推送文件到设备中去
```ruby
# ruby
data = "some data for the file"
path = "/data/local/tmp/file.txt"
push_file path, data
```
```python
# python
data = "some data for the file"
path = "/data/local/tmp/file.txt"
driver.push_file(path, data.encode('base64'))
```
```java
// java
byte[] data = Base64.encodeBase64("some data for the file".getBytes());
String path = "/data/local/tmp/file.txt";
driver.pushFile(path, data)
```
```javascript
// javascript
driver.pushFile(path, data)
```
```php
// php
$path = 'data/local/tmp/test_push_file.txt';
$data = 'This is the contents of the file to push to the device.';
$this->pushFile($path, base64_encode($data));
```
```csharp
// c#
driver.PushFile("/data/local/tmp/file.txt", "some data for the file");
```
### 设置
从这里你可以获取/设置 appium 的服务器设置。
想知道它如何工作，以及它支持哪些设置，请查看[关于设置的文档](/docs/en/advanced-concepts/settings.cn.md)
```ruby
current_settings = get_settings
update_settings someSetting: true
```
```python
current_settings = driver.get_settings()
driver.update_settings({"someSetting": true})
```
```java
JsonObject settings = driver.getSettings()
// java-client doesn't support setting arbitrary settings, just settings which are already provided by appium.
// So for the 'ignoreUnimportantViews' setting, the following method exists:
driver.ignoreUnimportantViews(true);
```
```javascript
var settings = driver.settings();
browser.updateSettings({'someSetting': true});
```
```php
$settings = $this->getSettings();
$this->updateSettings(array('cyberdelia' => "open"));
```
```csharp
Dictionary<String, Object>settings = driver.GetSettings();
// dotnet-driver doesn't support setting arbitrary settings, just settings which are already provided by appium.
// So for the 'ignoreUnimportantViews' setting, the following method exists:
driver.IgnoreUnimportantViews(true);
```
### Appium 桌面应用
Appium 的桌面应用支持 OS X 和 Windows.
- [Appium.app for OS X][bitbucket]
- [Appium.exe for Windows][bitbucket]
[bitbucket]: https://bitbucket.org/appium/appium.app/downloads/
Appium 客户端库 API的更多相关文章
- Alljoyn瘦客户端库介绍(官方文档翻译 下）
由于其他事情耽误,这个翻译现在才完成.接上篇—— 4 瘦客户端核心库架构 由于AllJoyn瘦客户端核心库(AJTCL)必须运行在那些功耗受限.计算能力有限.资源紧缺的设备上,因此它无法像运行在通用型 ...
- Alljoyn瘦客户端库介绍(官方文档翻译）
Alljoyn瘦客户端库介绍(上) 1.简介 本文档对AllJoynTM瘦客户端的核心库文件(AJTCL)进行了详尽的介绍.本文档介绍了系统整体架构,AllJoyn框架结构,并着重于介绍如何将嵌入式设 ...
- Raphael Js矢量库API简介：
Raphael Js矢量库API简介:Raphael Javascript 是一个 Javascript的矢量库. 2010年6月15日,著名的JavaScript库ExtJS与触摸屏代码库项目jQT ...
- MQTT客户端库-Paho GO
为了加深理解,本文是翻译文章.原文地址 Paho GO Client 语言 GO 协议 EPL AND EDL 官网地址 http://www.eclipse.org/paho/ API类型 As ...
- Redis学习之路（008）- Redis C语言客户端库hiredis文档翻译
Hiredis是Redis数据库一个轻量的C语言客户端库. 之所以轻量是由于它只是简单的提供了对redis操作语句支持的接口,并没有实现具体的操作语句的功能.但正是由于这种设计使我们只要熟悉了通用的r ...
- 【Mac + Python3.6 + ATX基于facebook-wda】之IOS自动化（三）:facebook-wda库--API学习以及附录：Github上对WDA的问题解答
下面简单介绍facebook-wda库--API的学习 import wda # debug模式,会在run运行时控制台生成消息 wda.DEBUG = False # False 关闭,True开启 ...
- 网易云音乐PC客户端加密API逆向解析
1.前言 网上已经有大量的web端接口解析的方法了,但是对客户端的接口解析基本上找不到什么资料,本文主要分析网易云音乐PC客户端的API接口交互方式. 通过内部的代理设置,使用fiddler作为代理工 ...
- 【HTTP/FTP客户端库】
[HTTP/FTP客户端库]资料来源:http://curl.haxx.se/libcurl/competitors.html Free Software and Open Source projec ...
- 尝试加载 Oracle 客户端库时引发 BadImageFormatException
尝试加载 Oracle 客户端库时引发 BadImageFormatException 工程师给计算机诊断,就像医生给病人诊断一样,很多同样的症状,可能是由多种截然不同的原因导致的. 最近进行C# ...
随机推荐
- 全选，全不选，反选的js实现
全选练习 ** 使用复选框上面一个属性判断是否选中 - checked属性 - checked=true:选中 ...
- MySQL分表自增ID解决方案（转）
当我们对MySQL进行分表操作后,将不能依赖MySQL的自动增量来产生唯一ID了,因为数据已经分散到多个表中. 应尽量避免使用自增IP来做为主键,为数据库分表操作带来极大的不便. 在postgreSQ ...
- 存储过程中的when others then 和 raise
EXCEPTION when others then rollback; dbms_output.put_line('code:' || sqlcode); dbms_output.put_line( ...
- webpack构建与loaders
loaders 定义 先了解一下webpack,webpack是一个用于针对js文件的构建工具,在被构建的js文件中,我们可以使用require语句和webpack loader,如下: var cs ...
- 密码学初级教程(五）消息认证码MAC-Message Authentication Code
密码学家工具箱中的6个重要的工具: 对称密码 公钥密码 单向散列函数 消息认证码 数字签名 伪随机数生成器 MAC能识别出篡改和伪装,也就是既可以确认消息的完整性,也可以进行认证. 消息认证码的输入包 ...
- Vno博客样式分享
不知不觉有一年多没有更新博客了,还是几位园友因为喜欢这套博客样式发了消息,否则我都快忘记自己还有一个博客了,哈哈. 言归正传,这套博客样式是当时闲来无事copy的iOS界喵神的博客Vno,确实很漂亮, ...
- 【开源一个小工具】一键将网页内容推送到Kindle
最近工作上稍微闲点,这一周利用下班时间写了一个小工具,其实功能挺简单但也小折腾了会. 工具名称:Simple Send to Kindle Github地址:https://github.com/zh ...
- Jcrop+uploadify+php实现上传头像预览裁剪
最近由于项目需要,所以做了一个上传头像预览并且可以预览裁剪的功能,大概思路是上传的图片先保存到服务器,然后通过ajax从服务器获取到图片信息,再利用Jcrop插件进行裁剪,之后通过PHP获取到的四个裁 ...
- centos 6.5 zabbix3.0.4 监控apache
开启apache的server-status httpd.conf 末尾添加 [root@test3 /]# vim /usr/local/httpd-/conf/httpd.conf Extende ...
- C#画表格
下面给一个简单的例子,至于多个单元格合并,请自己去实现,也就是坐标计算的事情. 至于画图,用GDI,还是DirectX画,自己选择,不过这里主要讲的是算法:坐标计算以及画的过程. 注意不要每个列都画一 ...