Edit this Doc Appium 客户端类库

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

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

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

锁定

锁定屏幕。

driver.lockScreen(3);
driver.lock(5)
driver.lock(3)
lock 5
driver.LockDevice(3);
$this->lock(3);
// objective c
[driver lockDeviceScreen:3];

将应用切换至后台

将当前的应用切换到后台,然后可以让其在指定时间内回到前台,或者让它一直留在后台。

传递给这个方法的参数有两种类型:

  1. 一个整型(秒):表示后台状态维持多久。-1 表示持续置于后台。这种风格的参数已经被废弃。
  2. 一个看起来像 {"timeout": secs} 的对象。里面的 secs 是含义和第一个类型一样的整型数字(即表示置于后台多少秒),或者为 null (表示持续置于后台)。
driver.runAppInBackground(5);  // 置于后台,持续5秒
driver.runAppInBackground(-1);  // 持续置于后台
driver.background_app(5)  # 置于后台,持续5秒
driver.background_app(-1) # 持续置于后台
driver.background_app({'timeout': None}) # 持续置于后台
driver.backgroundApp(5);  // 置于后台,持续5秒
driver.backgroundApp(-1); // 持续置于后台
driver.backgroundApp({timeout: null}); // 持续置于后台
background_app 5  # 置于后台,持续5秒
background_app -1  # 持续置于后台
driver.BackgroundApp(5);
driver.BackgroundApp(-1);
$this->backgroundApp(5);
$this->backgroundApp(-1);
// objective c
[driver runAppInBackground:3];
[driver runAppInBackground:-1];

收起键盘

收起键盘。 注意: 在 iOS,这辅助功能并不能保证一定有效。因为没有用于隐藏键盘的自动化钩子方法(译者注:可以理解为 iOS 没有提供隐藏键盘的 API),而且应用是允许用户去使用各种策略去收起键盘的,无论是点击键盘以外的区域,还是向下滑动诸如此类...相比于使用该方法,我们更加鼓励你去思考 用户 在应用中是如何收起键盘(如滑动,点击一个固定的坐标,等等...),并让 Appium 去执行这些方法,而不是调用这个 API 。话虽如此,但这里默认的行为还是可能帮助到你的。

driver.hideKeyboard();
driver.hide_keyboard()
driver.hideKeyboard()
hide_keyboard
driver.HideKeyboard("Done");
$this->hideKeyboard();
$this->hideKeyboard(array('strategy' => 'pressKey', 'key' => 'Done'));
// objective c
[driver hideKeyboard];

启动 Activity

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

driver.startActivity("appPackage","com.example.android.apis", null, null);
driver.start_activity('com.example.android.apis', '.Foo')
driver.startActivity({appPackage: 'com.example.android.apis', appActivity: '.Foo'}, cb);
start_activity app_package: 'io.appium.android.apis', app_activity: '.accessibility.AccessibilityNodeProviderActivity'
driver.StartActivity("com.example.android.apis", ".Foo");
$this->startActivity(array("appPackage" => "com.example.android.apis",
                            "appActivity" => ".Foo"));
// objective c
[driver startActivity:@"com.example.android.apis" package:@".Foo"];

打开通知栏

打开通知栏,仅支持 Android

driver.openNotifications();
driver.open_notifications()
driver.openNotifications(cb);
open_notifications
driver.OpenNotifications();
$this->openNotifications();
// objective c
[driver openNotifications];

应用是否已安装

检测应用是否已被安装。

driver.isAppInstalled("com.example.android.apis")
driver.is_app_installed('com.example.android.apis')
driver.isAppInstalled("com.example.android.apis")
  .then(function (isAppInstalled) { /*...*/ })
is_installed? "com.example.android.apis"
driver.IsAppInstalled("com.example.android.apis-");
$this->isAppInstalled('com.example.android.apis');
// objective c
[driver isAppInstalled:@"com.example.android.apis-"];

安装应用

在设备上安装应用。

driver.installApp("path/to/my.apk")
driver.install_app('path/to/my.apk')
driver.installApp("path/to/my.apk")
install 'path/to/my.apk'
driver.InstallApp("path/to/my.apk");
$this->installApp('path/to/my.apk');
// objective c
[driver installAppAtPath:@"path/to/my.apk"];

卸载应用

卸载设备上的应用。

driver.removeApp("com.example.android.apis")
driver.remove_app('com.example.android.apis')
driver.removeApp("com.example.android.apis")
remove 'com.example.android.apis'
driver.RemoveApp("com.example.android.apis");
$this->removeApp('com.example.android.apis');
// objective c
[driver removeApp:@"com.example.android.apis"];

摇一摇

模拟摇晃设备的操作。

driver.shake()
driver.shake()
driver.shake()
shake
driver.ShakeDevice();
$this->shake();
// objective c
[driver shakeDevice];

关闭应用

关闭应用。

driver.closeApp()
driver.close_app();
driver.closeApp()
close_app
driver.CloseApp();
$this->closeApp();
// objective c
[driver closeApp];

启动(Launch)

为 desired capabilities 启动一个 session。请注意只有设置了 autoLaunch=false 关键字时才会生效。这不是为了随意启动一个应用或 activities ——如果你想这么做,请使用 start_activity 这个 desired capability 的参数。这个方法的使用场景是在你设置了 autoLaunch=false 后,用来继续执行初始化("launch")流程的。(译者注:举个例子,国产系统经常会在应用安装时弹出提示窗阻碍安装,此时可以通过 autoLaunch=false 来让应用安装后先执行你的脚本来关掉弹窗,然后再用这个函数来继续启动应用。)

driver.launchApp()
driver.launch_app()
driver.launchApp()
launch_app
driver.LaunchApp();
$this->launchApp();
// objective c
[driver launchApp];

重置

重置应用。(译者注:类似于清除缓存)

driver.resetApp()
driver.reset()
driver.resetApp()
driver.reset
driver.ResetApp();
$this->reset();
// objective c
[driver resetApp];

可用的上下文(Contexts)

列出所有可用的上下文(contexts)。

driver.getContextHandles()
driver.contexts
driver.contexts().then(function (contexts) { /*...*/ })
context_array = available_contexts
driver.GetContexts()
$this->contexts();
// objective c
NSArray *contexts = driver.allContexts;

当前上下文(context)

列出当前的上下文(context)。

driver.getContext()
driver.current_context
driver.currentContext().then(function (context) { /*...*/ })
context = current_context
driver.GetContext()
$this->context();
// objective c
NSString *context = driver.context;

切换至默认的上下文(context)

切换回默认的上下文(context)。(译者注:一般就是原生上下文 “NATIVE_APP”)

driver.context();
driver.switch_to.context(None)
driver.context()
switch_to_default_context
driver.SetContext();
$this->context(NULL);
// objective c
[driver setContext:nil];

应用的字符串

获得应用的字符串。(译者注:这里实际指的是返回应用的多语言文本,即每个 string 变量及在指定语言上的显示内容。例如 {"action_forgot_password":"Forgot your password?"} 。在 android 上对应的是项目中的 strings.xml 多语言配置文件)

driver.getAppStrings();
driver.app_strings
driver.getAppStrings().then(function (appStrings) { /*...*/ })
app_strings
driver.GetAppStrings();
$this->appStrings();
$this->appStrings('ru');
// objective c
[driver appStrings];
[driver appStringsForLanguage:"@ru"];

按键事件

给设备发送按键事件。

driver.sendKeyEvent(AndroidKeyCode.HOME);
driver.keyevent(176)
driver.deviceKeyEvent(wd.SPECIAL_KEYS.Home)
key_event 176
driver.KeyEvent("176");
$this->keyEvent('176');
// objective c
NSError *err;
[driver triggerKeyEvent:176 metastate:0 error:&err];

当前 Activity

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

driver.currentActivity();
driver.current_activity
driver.getCurrentActivity().then(function (activity) { /*...*/ })
current_activity
driver.GetCurrentActivity();
$this->currentActivity();
// objective c
NSError *err;
[driver currentActivity];

当前包名(package)

获取当前包名(package)。仅支持 Android 。

driver.getCurrentPackage();
driver.current_package
driver.getCurrentPackage().then(function (package) { /*...*/ })
current_package
driver.GetCurrentPackage();
$this->currentPackage();

点击操作 / 多点触控操作

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

TouchAction action = new TouchAction(driver)
.press(mapview, 10, 10)
.release().
perform();
action = TouchAction(driver)
action.press(element=el, x=10, y=10).release().perform()
var action = new wd.TouchAction(driver);
action
  .tap({el: el, x: 10, y: 10})
  .release();
return action.perform(); // returns a promise
touch_action = Appium::TouchAction.new
element  = find_element :accessibility_id, 'Buttons, Various uses of UIButton'
touch_action.press(element: element, x: 10, y: 10).perform
ITouchAction action = new TouchAction(driver);
action.Press(el, 10, 10).Release();
action.Perform ();
$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();

滑动屏幕

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

driver.swipe(75, 500, 75, 0, 0.8)
driver.swipe(start_x=75, start_y=500, end_x=75, end_y=0, duration=800)
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 });
swipe start_x: 75, start_y: 500, end_x: 75, end_y: 0, duration: 0.8
todo: c#
$this->swipe(75, 500, 75, 0, 800);

捏(Pinch)手势

在屏幕上使用捏(Pinch)手势。

driver.pinch(element);
driver.pinch(element=el)
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();
pinch 75
driver.Pinch(25, 25)
$this->pinch($el);

放大屏幕(Zoom)

在屏幕上使用放大手势。

driver.zoom(element);
driver.zoom(element=el)
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();
zoom 200
driver.Zoom(100, 200);
$this->zoom($el);

滚动到

滚动到指定的元素。

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);
driver.execute_script("mobile: scroll", {"direction": "down", "element": element.id})
return driver.elementByAccessibilityId().then(function (el) {
  driver.execute("mobile: scroll", [{direction: "down", element: el.value}]);
});
element = find_element :accessibility_id, "Element ID"
execute_script "mobile: scroll", direction: "down", element: element.ref
Dictionary<string, string> scrollObject = new Dictionary<string, string>();
scrollObject.Add("direction", "down");
scrollObject.Add("element", <element_id>);
((IJavaScriptExecutor)driver).ExecuteScript("mobile: scroll", scrollObject));
$els = $this->elements($this->using('class name')->value('android.widget.TextView'));
$this->scroll($els[count($els) - 1], $els[0]);

拉取(pull)文件

从设备上拉取文件。

driver.pullFile("Library/AddressBook/AddressBook.sqlitedb");
driver.pull_file('Library/AddressBook/AddressBook.sqlitedb')
driver.pullFile("Library/AddressBook/AddressBook.sqlitedb")
  .then(function (base64File) { /*...*/ })
pull_file 'Library/AddressBook/AddressBook.sqlitedb'
driver.PullFile("Library/AddressBook/AddressBook.sqlitedb");
$this->pullFile('Library/AddressBook/AddressBook.sqlitedb');

推送(push)文件

推送文件到设备。

byte[] data = Base64.encodeBase64("some data for the file".getBytes());
String path = "/data/local/tmp/file.txt";
driver.pushFile(path, data)
data = "some data for the file"
path = "/data/local/tmp/file.txt"
driver.push_file(path, data.encode('base64'))
driver.pushFile(path, data)
data = "some data for the file"
path = "/data/local/tmp/file.txt"
push_file path, data
driver.PushFile("/data/local/tmp/file.txt", "some data for the file");
$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));

设置

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

JsonObject settings = driver.getSettings()
// java 客户端不支持设置任意的设置项,只能设置 appium 当前支持的部分。
// 所以对于 `ignoreUnimportantViews`(译者注:忽略不重要的视图,即 android uiautomator 上的压缩后 xml )这个设置项,对应存在下面这个设置方法:
driver.ignoreUnimportantViews(true);
current_settings = driver.get_settings()
driver.update_settings({"someSetting": true})
var settings = driver.settings();
browser.updateSettings({'someSetting': true});
current_settings = get_settings
update_settings someSetting: true
Dictionary<String, Object>settings = driver.GetSettings();
// .net 客户端不支持设置任意的设置项,只能设置 appium 当前支持的部分。
// 所以对于 `ignoreUnimportantViews`(译者注:忽略不重要的视图,即 android uiautomator 上的压缩后 xml )这个设置项,对应存在下面这个设置方法:
driver.IgnoreUnimportantViews(true);
$settings = $this->getSettings();
$this->updateSettings(array('cyberdelia' => "open"));

Appium 桌面应用

Appium 的桌面应用支持 OS X, Windows 及 Linux.

本文由 thanksdanny 翻译,由 chenhengjie123 校验。