【翻译】appium-bindings

Appium 客户端类库

Appium 支持以下语言的客户端类库：

语言 源码
Ruby GitHub
Python GitHub
Java GitHub
JavaScript GitHub
PHP GitHub
C# GitHub
Objective-C GitHub

注意，一些方法类似 endTestCoverage() 目前并不能完全支持。当这个问题被解决后，适当的覆盖率支持才会被添加。如果你仍然想使用这些方法，请参考 GitHub 上关于 bindings 的文档。

锁定

锁定屏幕。

# ruby
lock 5

# python
driver.lock(5)

// java
driver.lockScreen(3);

// javascript
driver.lock(3)

// php
$this->lock(3);

// c#
driver.LockDevice(3);

// objective c
[driver lockDeviceScreen:3];

将应用切换至后台

将当前的应用切换到后台。

# ruby
background_app 5

# python
driver.background_app(5)

// java
driver.runAppInBackground(5);

// javascript
driver.backgroundApp(5)

// php
$this->backgroundApp(5);

// c#
driver.BackgroundApp(5);

// objective c
[driver runAppInBackground:3];

收起键盘

收起键盘。
注意: 在 iOS，这辅助功能并不能保证一定有效。因为没有用于隐藏键盘的 automation hook，而且应用是允许用户去使用各种策略去收起键盘的，无论是点击键盘以外的区域，还是向下滑动诸如此类...相比于使用该方法，我们更加鼓励你去思考 用户 在应用中是如何收起键盘，并告诉 Appium 去执行，代替掉内些操作（滑动，点击一个固定的坐标，等等...）。话虽如此，但默认的行为是可能是最能帮助到你的。

# ruby
hide_keyboard

# python
driver.hide_keyboard()

// java
driver.hideKeyboard();

// javascript
driver.hideKeyboard()

// php
$this->hideKeyboard();
$this->hideKeyboard(array('strategy' => 'pressKey', 'key' => 'Done'));

// c#
driver.HideKeyboard("Done");

// objective c
[driver hideKeyboard];

启动 Activity

在当前 app 打开一个 activity，或者新打开一个应用并启动一个 acticity， 仅支持 Android。

// java
driver.startActivity("appPackage","com.example.android.apis", null, null);

// javascript
driver.startActivity({appPackage: 'com.example.android.apis', appActivity: '.Foo'}, cb);

# python
driver.start_activity('com.example.android.apis', '.Foo')

# ruby
start_activity app_package: 'io.appium.android.apis', app_activity: '.accessibility.AccessibilityNodeProviderActivity'

// c#
driver.StartActivity("com.example.android.apis", ".Foo");

// php
$this->startActivity(array("appPackage" => "com.example.android.apis",
                            "appActivity" => ".Foo"));

// objective c
[driver startActivity:@"com.example.android.apis" package:@".Foo"];

打开通知栏

打开通知栏，仅支持 Android。

// java
driver.openNotifications();

// javascript
driver.openNotifications(cb);

# python
driver.open_notifications()

# ruby
open_notifications

// c#
driver.OpenNotifications();

// php
$this->openNotifications();

// objective c
[driver openNotifications];

应用是否已安装

检查应用是否已被安装。

# ruby
is_installed? "com.example.android.apis"

# python
driver.is_app_installed('com.example.android.apis')

// java
driver.isAppInstalled("com.example.android.apis")

// javascript
driver.isAppInstalled("com.example.android.apis")
  .then(function (isAppInstalled) { /*...*/ })

// php
$this->isAppInstalled('com.example.android.apis');

// c#
driver.IsAppInstalled("com.example.android.apis-");

// objective c
[driver isAppInstalled:@"com.example.android.apis-"];

安装应用

在设备上安装应用。

# ruby
install 'path/to/my.apk'

# python
driver.install_app('path/to/my.apk')

// java
driver.installApp("path/to/my.apk")

// javascript
driver.installApp("path/to/my.apk")

// php
$this->installApp('path/to/my.apk');

// c#
driver.InstallApp("path/to/my.apk");

// objective c
[driver installAppAtPath:@"path/to/my.apk"];

卸载应用

移除设备上的应用。

# ruby
remove 'com.example.android.apis'

# python
driver.remove_app('com.example.android.apis')

// java
driver.removeApp("com.example.android.apis")

// javascript
driver.removeApp("com.example.android.apis")

// php
$this->removeApp('com.example.android.apis');

// c#
driver.RemoveApp("com.example.android.apis");

// objective c
[driver removeApp:@"com.example.android.apis"];

摇一摇

模拟摇晃设备的操作。

# ruby
shake

# python
driver.shake()

// java
driver.shake()

// javascript
driver.shake()

// php
$this->shake();

// c#
driver.ShakeDevice();

// objective c
[driver shakeDevice];

关闭应用

关闭应用。

# ruby
close_app

# python
driver.close_app();

// java
driver.closeApp()

// javascript
driver.closeApp()

// php
$this->closeApp();

// c#
driver.CloseApp();

// objective c
[driver closeApp];

启动（Launch）

为 desired capabilities 启动一个 session。请注意只有设置了 autoLaunch=false 关键字时才会生效。使用 start_activity 这个参数不是为了随意启动一个应用或 activities。这是在你设置了 autoLaunch=false 后，用来继续执行初始化（"launch"）流程的。

# ruby
launch_app

# python
driver.launch_app()

// java
driver.launchApp()

// javascript
driver.launchApp()

// php
$this->launchApp();

// c#
driver.LaunchApp();

// objective c
[driver launchApp];

重置

重置应用。

# ruby
driver.reset

# python
driver.reset()

// java
driver.resetApp()

// javascript
driver.resetApp()

// php
$this->reset();

// c#
driver.ResetApp();

// objective c
[driver resetApp];

可用的 Contexts

列出所有可用的 contexts。

# ruby
context_array = available_contexts

# python
driver.contexts

// java
driver.getContextHandles()

// javascript
driver.contexts().then(function (contexts) { /*...*/ })

// php
$this->contexts();

// c#
driver.GetContexts()

// objective c
NSArray *contexts = driver.allContexts;

当前 context

列出当前的 context。

# ruby
context = current_context

# python
driver.current_context

// java
driver.getContext()

// javascript
driver.currentContext().then(function (context) { /*...*/ })

// php
$this->context();

// c#
driver.GetContext()

// objective c
NSString *context = driver.context;

切换至默认的 context

切换回默认的 context。

# ruby
switch_to_default_context

# python
driver.switch_to.context(None)

// java
driver.context();

// javascript
driver.context()

// php
$this->context(NULL);

// c#
driver.SetContext();

// objective c
[driver setContext:nil];

应用的字符串

获得应用的字符串。

# ruby
app_strings

# python
driver.app_strings

// java
driver.getAppStrings();

// javascript
driver.getAppStrings().then(function (appStrings) { /*...*/ })

// php
$this->appStrings();
$this->appStrings('ru');

// c#
driver.GetAppStrings();

// objective c
[driver appStrings];
[driver appStringsForLanguage:"@ru"];

按键事件

给设备发送按键事件。

# ruby
key_event 176

# python
driver.keyevent(176)

// java
driver.sendKeyEvent(AndroidKeyCode.HOME);

// javascript
driver.deviceKeyEvent(wd.SPECIAL_KEYS.Home)

// php
$this->keyEvent('176');

// c#
driver.KeyEvent("176");

// objective c
NSError *err;
[driver triggerKeyEvent:176 metastate:0 error:&err];

当前 Activity

获取当前的 Acticity，但仅支持 Android。

# ruby
current_activity

# python
driver.current_activity

// java
driver.currentActivity();

// javascript
driver.getCurrentActivity().then(function (activity) { /*...*/ })

// php
$this->currentActivity();

// c#
driver.GetCurrentActivity();

// objective c
NSError *err;
[driver currentActivity];

点击操作 / 多点触控操作

用于生成点击操作的 API。这部分文档的内容将会很快被补充进来。

# 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
action = TouchAction(driver)
action.press(element=el, x=10, y=10).release().perform()

// java
TouchAction action = new TouchAction(driver)
.press(mapview, 10, 10)
.release().
perform();

// javascript
var action = new wd.TouchAction(driver);
action
  .tap({el: el, x: 10, y: 10})
  .release();
return action.perform(); // returns a promise

// 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();

// c#
ITouchAction action = new TouchAction(driver);
action.Press(el, 10, 10).Release();
action.Perform ();

滑动屏幕

模拟用户滑动屏幕的操作。

# ruby
swipe start_x: 75, start_y: 500, end_x: 75, end_y: 0, duration: 0.8

# python
driver.swipe(start_x=75, start_y=500, end_x=75, end_y=0, duration=800)

// java
driver.swipe(75, 500, 75, 0, 0.8)

// 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
$this->swipe(75, 500, 75, 0, 800);

// c#
todo: c#

捏（Pinch）手势

在屏幕上使用捏（Pinch）手势。

# ruby
pinch 75

# python
driver.pinch(element=el)

// java
driver.pinch(element);

// 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();

$this->pinch($el);

// c#
driver.Pinch(25, 25)

放大屏幕（Zoom）

在屏幕上使用放大手势。

# ruby
zoom 200

# python
driver.zoom(element=el)

// java
driver.zoom(element);

// 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
$this->zoom($el);

// c#
driver.Zoom(100, 200);

滚动到

滚动到某个元素。

# ruby
element = find_element :name, "Element Name"
execute_script "mobile: scroll", direction: "down", element: element.ref

# python
driver.execute_script("mobile: scroll", {"direction": "down", "element": element.id})

// java
JavascriptExecutor js = (JavascriptExecutor) driver;
HashMap<String, String> scrollObject = new HashMap<String, String>();
scrollObject.put("direction", "down");
scrollObject.put("element", ((RemoteWebElement) element).getId());
js.executeScript("mobile: scroll", scrollObject);

// javascript
return driver.elementByName().then(function (el) {
  driver.execute("mobile: scroll", [{direction: "down", element: el.value}]);
});

// php
$els = $this->elements($this->using('class name')->value('android.widget.TextView'));
$this->scroll($els[count($els) - 1], $els[0]);

// c#
Dictionary<string, string> scrollObject = new Dictionary<string, string>();
scrollObject.Add("direction", "down");
scrollObject.Add("element", <element_id>);
((IJavaScriptExecutor)driver).ExecuteScript("mobile: scroll", scrollObject));

拉出（pull）文件

从设备上拉出文件。

# ruby
pull_file 'Library/AddressBook/AddressBook.sqlitedb'

# python
driver.pull_file('Library/AddressBook/AddressBook.sqlitedb')

// java
driver.pullFile("Library/AddressBook/AddressBook.sqlitedb");

// javascript
driver.pullFile("Library/AddressBook/AddressBook.sqlitedb")
  .then(function (base64File) { /*...*/ })

// php
$this->pullFile('Library/AddressBook/AddressBook.sqlitedb');

// c#
driver.PullFile("Library/AddressBook/AddressBook.sqlitedb");

推送（push）文件

推送文件到设备。

# ruby
data = "some data for the file"
path = "/data/local/tmp/file.txt"
push_file path, data

# python
data = "some data for the file"
path = "/data/local/tmp/file.txt"
driver.push_file(path, data.encode('base64'))

// java
byte[] data = Base64.encodeBase64("some data for the file".getBytes());
String path = "/data/local/tmp/file.txt";
driver.pushFile(path, data)

// javascript
driver.pushFile(path, data)

// 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));

// c#
driver.PushFile("/data/local/tmp/file.txt", "some data for the file");

设置

在这你会找到关于获取或设置 appium 服务器设置的示例代码。如果想了解工作原理，以及支持哪些设置，请查看设置文档

# 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"));

// c#
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。

最后编辑于 ：
©著作权归作者所有,转载或内容合作请联系作者
  • 人面猴
    序言：七十年代末，一起剥皮案震惊了整个滨河市，随后出现的几起案子，更是在滨河造成了极大的恐慌，老刑警刘岩，带你破解...
    沈念sama阅读 204,590评论 6赞 478
  • 死咒
    序言：滨河连续发生了三起死亡事件，死亡现场离奇诡异，居然都是意外死亡，警方通过查阅死者的电脑和手机，发现死者居然都...
    沈念sama阅读 86,808评论 2赞 381
  • 救了他两次的神仙让他今天三更去死
    文/潘晓璐 我一进店门，熙熙楼的掌柜王于贵愁眉苦脸地迎上来，“玉大人，你说我怎么就摊上这事。” “怎么了？”我有些...
    开封第一讲书人阅读 151,151评论 0赞 337
  • 道士缉凶录：失踪的卖姜人
    文/不坏的土叔 我叫张陵，是天一观的道长。 经常有香客问我，道长，这世上最难降的妖魔是什么？ 我笑而不...
    开封第一讲书人阅读 54,779评论 1赞 277
  • 港岛之恋（遗憾婚礼）
    正文 为了忘掉前任，我火速办了婚礼，结果婚礼上，老公的妹妹穿的比我还像新娘。我一直安慰自己，他们只是感情好，可当我...
    茶点故事阅读 63,773评论 5赞 367
  • 恶毒庶女顶嫁案：这布局不是一般人想出来的
    文/花漫 我一把揭开白布。 她就那样静静地躺着，像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上，一...
    开封第一讲书人阅读 48,656评论 1赞 281
  • 城市分裂传说
    那天，我揣着相机与录音，去河边找鬼。 笑死，一个胖子当着我的面吹牛，可吹牛的内容都是我干的。 我是一名探鬼主播，决...
    沈念sama阅读 38,022评论 3赞 398
  • 双鸳鸯连环套：你想象不到人心有多黑
    文/苍兰香墨 我猛地睁开眼，长吁一口气：“原来是场噩梦啊……” “哼！你这毒妇竟也来了？” 一声冷哼从身侧响起，我...
    开封第一讲书人阅读 36,678评论 0赞 258
  • 万荣杀人案实录
    序言：老挝万荣一对情侣失踪，失踪者是张志新（化名）和其女友刘颖，没想到半个月后，有当地人在树林里发现了一具尸体，经...
    沈念sama阅读 41,038评论 1赞 299
  • 护林员之死
    正文 独居荒郊野岭守林人离奇死亡，尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 35,659评论 2赞 321
  • 白月光启示录
    正文 我和宋清朗相恋三年，在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 37,756评论 1赞 330
  • 活死人
    序言：一个原本活蹦乱跳的男人离奇死亡，死状恐怖，灵堂内的尸体忽然破棺而出，到底是诈尸还是另有隐情，我是刑警宁泽，带...
    沈念sama阅读 33,411评论 4赞 321
  • 日本核电站爆炸内幕
    正文 年R本政府宣布，位于F岛的核电站，受9级特大地震影响，放射性物质发生泄漏。R本人自食恶果不足惜，却给世界环境...
    茶点故事阅读 39,005评论 3赞 307
  • 男人毒药：我在死后第九天来索命
    文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹，春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 29,973评论 0赞 19
  • 一桩弑父案，背后竟有这般阴谋
    文/苍兰香墨 我抬头看了看天上的太阳。三九已至，却和暖如春，着一层夹袄步出监牢的瞬间，已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 31,203评论 1赞 260
  • 情欲美人皮
    我被黑心中介骗来泰国打工， 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留，地道东北人。 一个月前我还...
    沈念sama阅读 45,053评论 2赞 350
  • 代替公主和亲
    正文 我出身青楼，却偏偏与公主长得像，于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子，可洞房花烛夜当晚...
    茶点故事阅读 42,495评论 2赞 343

推荐阅读更多精彩内容

  • Android - 收藏集
    Android 自定义View的各种姿势1 Activity的显示之ViewRootImpl详解 Activity...
    passiontim阅读 171,435评论 25赞 707
  • 源码众享最新教程 - 草稿
    ¥开启¥ 【iAPP实现进入界面执行逐一显】 〖2017-08-25 15:22:14〗 《//首先开一个线程，因...
    小菜c阅读 6,357评论 0赞 17
  • 优秀第三方
    发现 关注 消息 iOS 第三方库、插件、知名博客总结 作者大灰狼的小绵羊哥哥关注 2017.06.26 09:4...
    肇东周阅读 12,019评论 4赞 62
  • 《一年》
    撕下最顶一页的备忘卡 用毛巾拂去桌面的灰尘 文档、笔记本都塞进书架 ———— 年岁不知不觉间来到腊月 炮竹声在看不...
    Hua一阅读 233评论 0赞 2
  • 模特的镜头感是如何炼成的？
    镜前表演是模特培训中的关键环节，其中，最重要的就是面部表情、眼神运用和整体造型设计。羽翼国际模特学校的模特老师在镜...
    彩虹姐教你玩时髦阅读 1,665评论 0赞 4