Compare commits

...
Author SHA1 Message Date
Kazuaki Matsuo d7e3954013 1.22.1 2021-11-15 22:43:01 -08:00
Kazuaki Matsuo 44e2dff1f9 1.22.1-rc.5 2021-11-11 09:55:16 -08:00
Kazuaki Matsuo c5fcbec2ec chore: bump base-driver 2021-11-11 09:44:26 -08:00
Kazuaki Matsuo 9372e82272 1.22.1-rc.4 2021-11-04 23:57:40 -07:00
Kazuaki Matsuo b9428a3339 chore: bump xcuitest version 2021-11-04 23:52:15 -07:00
Kazuaki Matsuo 73ddda0841 1.22.1-rc.3 2021-11-02 18:10:24 -07:00
Kazuaki Matsuo 517e5b91e2 chore: bump wda 2021-11-02 18:05:52 -07:00
Kazuaki Matsuo 03bcad2503 1.22.1-rc.2 2021-11-02 01:08:13 -07:00
Kazuaki Matsuo 6a7ab2410d chore: bump xcuitest driver 2021-11-02 01:07:11 -07:00
Kazuaki Matsuo 2199fe8271 1.22.1-rc.1 2021-10-24 18:16:03 -07:00
Kazuaki Matsuo fb1e42a23a chore: releases/1.22.1 to releases/1.22 (#15999)
* 1.22.0

* bump xcuitest, uia2

* bump to 1.22.1-rc.0

* bump appium-xcuitest-driver
2021-10-25 04:19:37 +09:00
Kazuaki Matsuo 476ba90166 1.22.0-rc.8 2021-09-20 10:57:28 -07:00
Kazuaki Matsuo 6108ff9ac3 bump asyncbox 2021-09-20 10:56:42 -07:00
Kazuaki Matsuo 021db8c95d 1.22.0-rc.7 2021-09-19 01:00:18 -07:00
Kazuaki Matsuo 4c19647b30 bump appium-uiautomator2-server 2021-09-19 00:56:44 -07:00
Kazuaki Matsuo da36f83c29 1.22.0-rc.6 2021-09-14 18:39:17 -07:00
Kazuaki Matsuo 857efd37aa bump xcuitest-driver 2021-09-14 18:31:12 -07:00
Kazuaki Matsuo f166948a8e 1.22.0-rc.5 2021-09-13 00:13:18 -07:00
Kazuaki Matsuo fc60df391e nump appium-uiautomator2-server 2021-09-13 00:12:11 -07:00
Kazuaki Matsuo d5a4a276c7 1.22.0-rc.4 2021-09-11 10:26:53 -07:00
Kazuaki Matsuo a924b0059d bump xcuitest, flutter driver 2021-09-11 10:26:04 -07:00
Kazuaki Matsuo 90f856e700 1.22.0-rc.3 2021-09-04 12:29:29 -07:00
Kazuaki Matsuo ae6d28f243 bump drivers for rc.3 2021-09-04 12:20:59 -07:00
Kazuaki Matsuo 10963d9104 1.22.0-rc.2 2021-08-17 11:39:05 -07:00
Kazuaki Matsuo 0e2c1bb559 bump base, support, espresso and xcuitest 2021-08-17 11:31:15 -07:00
Kazuaki Matsuo 81500a0175 1.22.0-rc.1 2021-08-07 21:35:26 -07:00
Kazuaki Matsuo edad7870c7 bump xcuitest and webdriveragent 2021-08-07 21:30:46 -07:00
Kazuaki Matsuo 6dfc0e7142 1.22.0-rc.0 2021-07-17 22:47:26 -07:00
Kazuaki Matsuo 86595102ff add shrinkwrap 2021-07-17 22:45:00 -07:00
Kazuaki Matsuo 59715c658a chore: remove ./scripts/release.sh from release-branch.sh to avoid accidental release (#15639) 2021-07-18 13:56:14 +09:00
Johan Lundstroem 0651bf8220 docs: Removed tiny typo from get-log.yml (#15614)
No ; in Python (that is all)
2021-07-07 15:42:33 -07:00
Kazuaki Matsuo 5dbcc3f48a Revert "chore: try out issue template feature in yml instead of plain markdown (#15605)" (#15612)
This reverts commit 4213532815.
2021-07-07 06:04:30 +09:00
Kazuaki Matsuo 4213532815 chore: try out issue template feature in yml instead of plain markdown (#15605)
* chore: try to use issue_report.yml instead of plain markdown

* tweak placeholder
2021-07-07 05:42:12 +09:00
Kazuaki Matsuo 94be80697c docs: add description in get clipboard for ios (#15582)
* docs: add description in get clipboard for ios

* tweak description

* docs: tweak review
2021-06-27 17:39:36 +09:00
Appium Triagerandrunner 96c215c81e docs: Update generated docs [ci skip] (#15569)
Co-authored-by: runner <runner@Mac-1624421148213.local>
2021-06-27 17:33:06 +09:00
youngfree c28452e206 doc[cn]: the doc of drives. (#15561)
* doc/cn: add driver/android-uiautomator2.md and modify toc.js (part of UIAutomator2 Android)

* doc/cn: add driver/ios-xcuitest.md and modify toc.js (part of XCUITest)

* modify the interpretation of driver

* doc/cn: add driver/ios-xcuitest-real-devices.md and modify toc.js (part of XCUITest Real Devices (iOS))

* modify
2021-06-23 13:25:08 +09:00
Jonathan Lipps 5097032cb0 chore(deps): attempt to avoid pinning main deps 2021-06-15 08:22:15 -07:00
Jonathan Lipps eed23ec179 chore(deps): don't pin global deps 2021-06-11 08:37:36 -07:00
87c33f4af1 chore: Configure Renovate (#15480)
* Add renovate.json

* chore(deps): make renovate use the 2.0 branch only

* chore(deps): tell renovate not to keep sample-code deps updated

* chore(deps): tell renovate to use parent dirname as scope

* chore(deps) more renovate config

* chore(deps): renovate auto range

* chore(deps): force semantic commits on

* chore(deps): set renovate timezone

* chore(deps): force commit type to chore

Co-authored-by: Renovate Bot <bot@renovateapp.com>
Co-authored-by: Jonathan Lipps <jlipps@gmail.com>
2021-06-10 08:51:58 -07:00
dependabot[bot] 020d58bfde chore: Bump mocha from 8.4.0 to 9.0.0 (#15477)
Bumps [mocha](https://github.com/mochajs/mocha) from 8.4.0 to 9.0.0.
- [Release notes](https://github.com/mochajs/mocha/releases)
- [Changelog](https://github.com/mochajs/mocha/blob/master/CHANGELOG.md)
- [Commits](https://github.com/mochajs/mocha/compare/v8.4.0...v9.0.0)

---
updated-dependencies:
- dependency-name: mocha
  dependency-type: direct:development
  update-type: version-update:semver-major
...

Signed-off-by: dependabot[bot] <support@github.com>

Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
2021-06-09 18:50:55 +02:00
merrill-kashiwabara-bose 30125e1bb7 docs: fix cut-and-paste error in 'Get Log Types' description. get-log-types.yml (#15465)
Wrong description: current description is for 'Get Logs'.
2021-06-04 11:10:32 -07:00
Appium Triagerandrunner 83f9a229ec docs: Update generated docs [ci skip] (#15407)
Co-authored-by: runner <runner@Mac-1621621685489.local>
2021-05-24 10:09:39 +09:00
Mykola Mokhnach 5034563a65 docs: Avoid unnecessary duplication in extensions documentation (#15406) 2021-05-21 20:47:09 +02:00
Kazuaki Matsuo 51fb442dc4 docs: fix typo in get settings in python (#15375) 2021-05-13 16:56:39 +09:00
Appium Triagerandrunner fbff369908 docs: Update generated docs [ci skip] (#15370)
Co-authored-by: runner <runner@Mac-1620835583584.local>
2021-05-12 12:25:42 -07:00
Kazuaki Matsuo a177e686b7 docs: add imageMatchMethod (#15362)
* docs: add imageMatchMethod

* Update image-elements.md
2021-05-13 01:20:24 +09:00
Jhon Delgado 4c3275040e docs: typo in executeAsync doc (#15369) 2021-05-13 01:19:15 +09:00
Appium Triagerandrunner a0e276b13e docs: Update generated docs [ci skip] (#15351)
Co-authored-by: runner <runner@Mac-1620634473792.local>
2021-05-10 17:43:26 +09:00
Kazuaki Matsuo 4f38f5d618 docs: remove php more, remove objective-c stuff (#15350)
* docs: remove php more, remove objective-c stuff

* remove Objective-C
2021-05-10 17:25:12 +09:00
Appium Triagerandrunner f88b667d75 docs: Update generated docs [ci skip] (#15349)
Co-authored-by: runner <runner@Mac-1620631271561.local>
2021-05-10 16:26:57 +09:00
Kazuaki Matsuo 54307c91fd chore: Remove php from .yml files and a few .md files which do not autogenerated ones (#15345)
* remove php stuff

* remove php sample code

* remove php stuff

* remove php more
2021-05-10 16:03:11 +09:00
Kazuaki Matsuo b8d7153499 chore: Add beta in release steps (#15346)
* add to create a beta

* append a line to create the next beta

* tix typo
2021-05-10 09:34:26 +09:00
Appium Triagerandrunner 8e4f4f944e docs: Update generated docs [ci skip] (#15344)
Co-authored-by: runner <runner@Mac-1620507065329.local>
2021-05-09 07:26:40 +09:00
Kazuaki Matsuo 5713e4ac73 docs: cleanup appium clients (#15334) 2021-05-09 06:57:25 +09:00
jvdeijnden e7d917929c docs: fix page reference (#15323) 2021-05-04 11:22:25 -07:00
Kazuaki Matsuo 7d14e60e60 chore: add release-latest script (#15316)
* chore: add release-latest

* add sh
2021-05-04 13:00:03 +09:00
Kazuaki Matsuo cc2271f9b1 docs: update changelog for 1.21.0 (#15298)
* chore: add 1.21

* update xcuitest

* add find by images, tweak xcuitest

* add lines for uia2

* add espresso and android

* fix typo

* fix review, add other drivers, add user names

* fix typo

* tweak review

* docs: address flutter driver version

* fix typo
2021-05-02 15:16:51 +09:00
Kazuaki Matsuo af3063b5ac chore: replace a new demo apk (#15290) 2021-04-22 15:15:53 +02:00
Dan Foad db4c057cf8 feat: update appium-youiengine-driver to 1.2.8 (#15282) 2021-04-20 14:58:44 -07:00
Kazuaki Matsuo 1f8a7981d5 docs: fix urls in support platforms (#15278) 2021-04-18 17:46:36 +09:00
Carmelo Buelvas 1e30207ec4 feat: Add WebOS Driver (#15260)
* Add WebOS Driver

* Update appium.js
2021-04-11 17:54:05 +09:00
Kazuaki Matsuo 6040817982 chore: add renamed scripts/release.sh in d9bb604 and troubleshooting (#15258)
* chore: add renamed scripts/release.sh in d9bb604

* add troubleshooting for accidental publishment

* remove new lines

* fix typo

* fix review
2021-04-08 11:25:09 +09:00
Kazuaki Matsuo f7f6e72ca7 chore: remove phonegap since the URL no longer worked (#15259)
* chore: remove Phonegap from readme since it returned 403

* fix typo
2021-04-08 11:10:47 +09:00
dependabot[bot] fcfa7151e3 chore: Bump sinon from 9.2.4 to 10.0.0 (#15213)
Bumps [sinon](https://github.com/sinonjs/sinon) from 9.2.4 to 10.0.0.
- [Release notes](https://github.com/sinonjs/sinon/releases)
- [Changelog](https://github.com/sinonjs/sinon/blob/master/CHANGELOG.md)
- [Commits](https://github.com/sinonjs/sinon/compare/v9.2.4...v10.0.0)

Signed-off-by: dependabot[bot] <support@github.com>

Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
2021-04-05 13:54:14 +09:00
Frederick Engelhardt f5d0045014 docs: update android-shell.md with javascript example (#15241)
Add javascript example. Took me ~2hrs to figure out this syntax. Hopefully this helps someone else!
2021-04-01 15:18:42 +09:00
Appium Triagerandrunner bae236aae5 docs: Update generated docs [ci skip] (#15235)
Co-authored-by: runner <runner@Mac-1617127159463.local>
2021-03-31 16:08:08 +09:00
Berolfingen 1905b2ac85 docs: remove a duplicated capability (#15228)
* Update caps.md

"udid" capability is already mentioned in "iOS Only" block that is correct.

* Update caps.md
2021-03-31 08:54:03 +09:00
Carmelo Buelvas 29f7f9e741 feat: Add Roku driver (#15227) 2021-03-30 19:36:09 +02:00
Mykola Mokhnach 5dbb9a403b fix: Cleanup the logsink before closing the server (#15207) 2021-03-22 06:21:59 +01:00
Appium Triagerandrunner 10373683d9 docs: Update generated docs [ci skip] (#15208)
Co-authored-by: runner <runner@Mac-1616353323838.local>
2021-03-22 10:24:27 +09:00
Sam Yamashita 7d0832ed59 docs: Change a method instruments → xctrace (#15193) 2021-03-21 22:08:01 +01:00
dependabot[bot] bfe01b344b chore: Bump webdriverio in /sample-code/javascript-webdriverio (#15198)
Bumps [webdriverio](https://github.com/webdriverio/webdriverio) from 6.12.1 to 7.2.0.
- [Release notes](https://github.com/webdriverio/webdriverio/releases)
- [Changelog](https://github.com/webdriverio/webdriverio/blob/main/CHANGELOG.md)
- [Commits](https://github.com/webdriverio/webdriverio/compare/v6.12.1...v7.2.0)

Signed-off-by: dependabot[bot] <support@github.com>

Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
2021-03-17 19:30:42 -07:00
mwakizaka eb2c7aaf1b docs: fix http method (#15191) 2021-03-14 11:42:15 +09:00
Mykola Mokhnach ae4b1fa917 fix: Add Linux to platforms mapping (#15183) 2021-03-11 19:52:03 +01:00
Appium Triagerandrunner 12dc5cf652 docs: Update generated docs [ci skip] (#15162)
Co-authored-by: runner <runner@Mac-1614847130465.local>
2021-03-04 18:07:31 +09:00
Kazuaki Matsuo 562e1d52c4 docs: add only 1.20- for xcuitest in real devices (#15158)
* docs: add only 1.20- for xcuitest in real devices

* split shell script into two parts

* Update ios-xcuitest-real-devices.md
2021-03-04 17:39:51 +09:00
Andrew Gabriel 78bd23abcb chore: javascript-webdriverio mocha timeout fix in sample (#15149)
* Remove mocha.opts

* Define mocha timeout flag in package.json
2021-03-01 21:17:49 -08:00
Kazuaki Matsuo 0b9e80f9ac docs: update method in get active element (#15133)
* docs: update method in get active element

* Update active.yml
2021-02-24 16:57:22 +09:00
Mykola Mokhnach 48726516d0 docs: Add appWaitForLaunch solution description (#15126) 2021-02-22 21:10:08 +01:00
Appium Triagerandrunner 92bf2ca065 docs: Update generated docs [ci skip] (#15120)
Co-authored-by: runner <runner@Mac-1613608033541.local>
2021-02-18 10:11:59 +09:00
Kazuaki Matsuo f40a2070ba docs: replace table to each link (#15117) 2021-02-17 10:02:55 -08:00
Kazuaki Matsuo ac3059b662 docs: remove a 404 link (#15107) 2021-02-12 16:57:33 +09:00
Kazuaki Matsuo ef966aa862 chore: bump minimum node version to 12, npm 6.9 (#15000) 2021-02-12 08:39:24 +01:00
Mykola Mokhnach 024aab3f45 docs: Document doubleClick uia2 gesture (#15106) 2021-02-12 08:37:52 +01:00
Mykola Mokhnach 1e8b1e361c fix: Properly handle updates for modules with major version zero (#15104) 2021-02-11 19:23:24 +01:00
blane1988 a539a56130 docs: fix typo of Appium (#15075) 2021-02-02 02:45:54 +09:00
Kazuaki Matsuo f25bb663a2 chore: bump version (#15069) 2021-01-31 11:33:01 +09:00
LionFat 8667777b01 docs: Update hybrid.md (#15070)
Ruby symbol copy-pasted to python example. CSS locator type in python is specifying either by a constant (By.CSS) or by a string (css).
2021-01-31 02:11:37 +09:00
Kazuaki Matsuo 2835b953be docs: update recent added japanese resource (#15066) 2021-01-28 10:59:23 +09:00
Kazuaki Matsuo 974a8c3891 chore: Update sample in Ruby (#15062)
* docs: tweak platform-support in readme and platform-support page

* add you.i and flutter

* add section, tweak gecko, review

* test: update ruby sample

* fix android

* update readme

* remove unused gem
2021-01-27 17:45:04 +09:00
Kazuaki Matsuo d37090e67e docs: update support platform (#15053)
* docs: tweak platform-support in readme and platform-support page

* add you.i and flutter

* add section, tweak gecko, review
2021-01-26 07:40:48 +09:00
Yuuki EbiharaandKazuaki Matsuo 297d70f70a docs: add translation into Japanese (#15048)
* translate introduction into japanese.

* translate getting-started into japanese.

* translate appium-clients into japanese.

* translate platform-support into japanese.

* Update docs/ja/about-appium/appium-clients.md

Have them review it and reflect their suggestions.

Co-authored-by: Kazuaki Matsuo <fly.49.89.over@gmail.com>

* The word "driver" needs no translation.

* Update docs/ja/about-appium/getting-started.md

Co-authored-by: Kazuaki Matsuo <fly.49.89.over@gmail.com>

* Update docs/ja/about-appium/getting-started.md

Co-authored-by: Kazuaki Matsuo <fly.49.89.over@gmail.com>

* Update docs/ja/about-appium/getting-started.md

Co-authored-by: Kazuaki Matsuo <fly.49.89.over@gmail.com>

* Update docs/ja/about-appium/getting-started.md

Co-authored-by: Kazuaki Matsuo <fly.49.89.over@gmail.com>

* Update docs/ja/about-appium/getting-started.md

Co-authored-by: Kazuaki Matsuo <fly.49.89.over@gmail.com>

* Update docs/ja/about-appium/getting-started.md

Co-authored-by: Kazuaki Matsuo <fly.49.89.over@gmail.com>

* Update docs/ja/about-appium/getting-started.md

Co-authored-by: Kazuaki Matsuo <fly.49.89.over@gmail.com>

* Update docs/ja/about-appium/getting-started.md

Co-authored-by: Kazuaki Matsuo <fly.49.89.over@gmail.com>

* Update docs/ja/about-appium/getting-started.md

Co-authored-by: Kazuaki Matsuo <fly.49.89.over@gmail.com>

* Update docs/ja/about-appium/platform-support.md

Co-authored-by: Kazuaki Matsuo <fly.49.89.over@gmail.com>

* Update docs/ja/about-appium/getting-started.md

Co-authored-by: Kazuaki Matsuo <fly.49.89.over@gmail.com>

* Update docs/ja/about-appium/getting-started.md

Co-authored-by: Kazuaki Matsuo <fly.49.89.over@gmail.com>

* Update docs/ja/about-appium/intro.md

Co-authored-by: Kazuaki Matsuo <fly.49.89.over@gmail.com>

* Update docs/ja/about-appium/intro.md

Co-authored-by: Kazuaki Matsuo <fly.49.89.over@gmail.com>

* Update docs/ja/about-appium/intro.md

Co-authored-by: Kazuaki Matsuo <fly.49.89.over@gmail.com>

* Update docs/ja/about-appium/platform-support.md

Co-authored-by: Kazuaki Matsuo <fly.49.89.over@gmail.com>

* Update docs/ja/about-appium/platform-support.md

Co-authored-by: Kazuaki Matsuo <fly.49.89.over@gmail.com>

* Update docs/ja/about-appium/intro.md

Co-authored-by: Kazuaki Matsuo <fly.49.89.over@gmail.com>

* Update docs/ja/about-appium/intro.md

Co-authored-by: Kazuaki Matsuo <fly.49.89.over@gmail.com>

* Update docs/ja/about-appium/platform-support.md

Co-authored-by: Kazuaki Matsuo <fly.49.89.over@gmail.com>

* Update docs/ja/about-appium/intro.md

Co-authored-by: Kazuaki Matsuo <fly.49.89.over@gmail.com>

* No need to translate'capability' into japanese.

* Unify the word to "サーバー"

* A space around alphabet or number

* Fix Review point.

Co-authored-by: Kazuaki Matsuo <fly.49.89.over@gmail.com>
2021-01-25 12:46:33 +09:00
Mykola Mokhnach ca001513ab docs: Document rotateElement extension (#15051) 2021-01-24 21:16:47 +01:00
Kazuaki Matsuo 5b72c1e6ff docs: refer to each repository (#15050) 2021-01-25 03:13:52 +09:00
Kazuaki Matsuo 05466e45a7 docs: address 1.20.2, add a hint to enable accessibility for ios (#15043)
* docs: address 1.20.2, add a hint to enable accessibility for ios

* update review
2021-01-23 03:47:35 +09:00
Kazuaki Matsuo ea8ac8a57c docs: address build tools version 24+ for apksigner (#15030)
* docs: address build tools version 24+ for apksigner

* Update android-espresso.md

* Update android-uiautomator2.md
2021-01-17 18:09:07 +09:00
Appium Triagerandrunner f1a56274fe docs: Update generated docs [ci skip] (#15025)
Co-authored-by: runner <runner@Mac-1610686944435.local>
2021-01-15 14:54:32 +09:00
Kazuaki Matsuo f1dadc4c98 docs: fix a link in caps 2021-01-14 21:48:57 -08:00
ian.zhang 3d7d9802ab docs: Update start-recording-screen.yml (#15014)
Revise the default value  of options.videoType.
Previous:
mpeg4
Post:
mjpeg

reference:
https://github.com/appium/java-client/blob/master/src/main/java/io/appium/java_client/ios/IOSStartScreenRecordingOptions.java
2021-01-14 21:22:24 -08:00
Kazuaki Matsuo 84aaf5eae6 docs: update changelog for 1.20.1 (#15023) 2021-01-15 04:57:36 +09:00
Kazuaki Matsuo b4b4c3cc89 docs: refer to each repository (#15010) 2021-01-11 17:41:03 +09:00
Maria Clara dos Santos Bezerra 628dc1aef2 docs: update README with english tutorial version to learn Appium with Python (#14999)
* update README

* Update README.md
2021-01-08 02:58:10 +09:00
BoldAsLove 793e9e17e0 docs: fix example comment (#14995)
changed the app name in a comment for the notepad example from AlarmClock to Notepad
2021-01-06 09:12:24 +09:00
Dan Graham 87b64b9a18 docs: swap out hamcrest.org reference 2021-01-05 09:48:13 -08:00
Dan Graham 7a7d0ced10 docs: changelog for Appium v1.20 (#14985) 2021-01-05 08:34:14 -08:00
Mykola Mokhnach a776456ed5 chore: Switch to GitHub CI (#14978) 2021-01-01 18:19:32 +01:00
dpgraham d9bb604fb6 rename release-candidate.sh to release 2020-12-30 11:41:58 -08:00
Jonathan Lipps 9d8779a224 feat: add --keep-alive-timeout CLI arg to adjust server keepalive and connection timeout 2020-12-15 11:01:17 -08:00
Kazuaki Matsuo a1ef920af1 chore: add 1.19.1 in changelog (#14947) 2020-12-14 10:40:15 +09:00
Kazuaki Matsuo 149ce03b84 chore: remove authorize-ios from package (#14946) 2020-12-13 06:18:09 +09:00
Kazuaki Matsuo 09437412c8 docs: add links to mac2 driver in caps and settings (#14942)
* cods: add links to mac2 driver in caps and settings

* tweak naming
2020-12-11 04:39:58 +09:00
roman-olshevskiy 0256991162 docs: removed deprecated method (#14934)
assert.equal was deprecated — since v9.9.0 - use strictEqual() instead.
2020-12-09 09:14:26 +09:00
Appium Triagerandrunner 604170a7ad docs: Update generated docs [ci skip] (#14930)
Co-authored-by: runner <runner@Mac-1607067954655.local>
2020-12-04 17:11:34 +09:00
Kazuaki Matsuo 509ab16612 chore: fix a link in appium.io (#14929)
* fix links

* fix
2020-12-04 17:07:53 +09:00
Ilija Boshkov 6184bf96b6 docs: Update push-file.yml (#14920) 2020-12-01 12:00:00 +09:00
Dan Graham 12e28c9e08 chore: add scripts for doing releases (#14918) 2020-11-29 13:01:03 -08:00
Mykola Mokhnach 090640e348 docs: Add Mac2Driver documentation (#14914) 2020-11-25 08:26:11 +01:00
Mykola Mokhnach a5c6f1c80e feat: Add Mac2Driver (#14911) 2020-11-25 07:52:48 +01:00
Appium Triagerandrunner 8d181dd19f docs: Update generated docs [ci skip] (#14913)
Co-authored-by: runner <runner@Mac-1606273407156.local>
2020-11-25 12:20:45 +09:00
Kazuaki Matsuo eb189d4588 fix: fix urls in docs (#14910) 2020-11-25 05:25:01 +09:00
380 changed files with 17422 additions and 4159 deletions
+37
View File
@@ -0,0 +1,37 @@
# This workflow will do a clean install of node dependencies, build the source code and run tests across different versions of node
# For more information see: https://help.github.com/actions/language-and-framework-guides/using-nodejs-with-github-actions
name: Node.js CI
on: [push, pull_request]
jobs:
build:
runs-on: ubuntu-latest
strategy:
matrix:
node-version: [12.x, 14.x]
steps:
- uses: actions/checkout@v2
- name: Use Node.js ${{ matrix.node-version }}
uses: actions/setup-node@v1
with:
node-version: ${{ matrix.node-version }}
- run: npm run clean
- run: npm run test
- run: npm run e2e-test
generate_docs:
needs: [build]
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v2
- name: Use Node.js 12.x
uses: actions/setup-node@v1
with:
node-version: 12.x
- run: npm run clean
- run: npm run generate-docs
-2
View File
@@ -41,8 +41,6 @@ old
coverage
docs/mkdocs.yml
sample-code/javascript-wd/node_modules
sample-code/php/vendor
sample-code/php/composer.lock
sample-code/java/out/
sample-code/ruby/Gemfile.lock
sample-code/python/test/results/
-30
View File
@@ -1,30 +0,0 @@
language: node_js
node_js: "10"
os: linux
addons:
apt:
sources:
- ubuntu-toolchain-r-test
packages:
- g++-4.8
- build-essential
env:
global:
- CXX=g++-4.8
cache:
npm: false
jobs:
include:
- stage: Tests
name: node 10
before_script: npm outdated || true
script: npm run test && npm run e2e-test
after_script: npm run coverage
- stage:
name: node 12
before_script: npm outdated || true
script: npm run test && npm run e2e-test
node_js: "12"
- stage:
name: test documentation generation
script: npm run generate-docs
+170 -1
View File
@@ -1,3 +1,172 @@
CHANGES IN VERSION 1.21.0 (FROM 1.20.2)
===================================
Appium 1.21.0 is a minor release
### General
* Minimum NodeJS version moved to 12
* Support multiple image matches for [Finding and Interacting with Image Elements](http://appium.io/docs/en/advanced-concepts/image-elements/) [appium-base-driver#449](https://github.com/appium/appium-base-driver/pull/449) (@khaong)
### Android General
* Disable sending of Google analytics data by instruments [appium-uiautomator2-driver#452](https://github.com/appium/appium-uiautomator2-driver/pull/452), [appium-espresso-driver#666](https://github.com/appium/appium-espresso-driver/pull/666)
* Improve detection of screen lock status [appium/appium-adb#564](https://github.com/appium/appium-adb/pull/564)
* Add `speed` optional parameter to mock location [appium-android-driver#681](https://github.com/appium/appium-android-driver/pull/681) (Thanks to @salabogdan)
* Fix `autoLaunch` to install applications by `app` and `otherApps` capabilities, but does not launch them as same as iOS [appium-uiautomator2-driver#440](https://github.com/appium/appium-uiautomator2-driver/pull/440), [appium-espresso-driver#654](https://github.com/appium/appium-espresso-driver/pull/654), [appium-android-driver#676](https://github.com/appium/appium-android-driver/pull/676)
* Fix to handle special characters by `mobile:type` [appium-adb#567](https://github.com/appium/appium-adb/pull/567)
* Fix to switch to Web Views with same package name, but different process names [appium-android-driver#687](https://github.com/appium/appium-android-driver/pull/687)
* Fix to stop screen recording after a session is closed [appium-android-driver#675](https://github.com/appium/appium-android-driver/pull/675) and each driver
### Android(UIAutomator2)
* Add `mobile:` extensions:
* `mobile:doubleClickGesture` for double click guesture [appium-uiautomator2-driver#441](https://github.com/appium/appium-uiautomator2-driver/pull/441), [appium-uiautomator2-server#415](https://github.com/appium/appium-uiautomator2-server/pull/415)
* `mobile:installMultipleApks` to install multiple apks via `adb install-multiple` command. Please read [mobile:installMultipleApks](https://github.com/appium/appium-uiautomator2-driver/blob/master/README.md#mobile-installmultipleapks) for more details
* Fix XPath lookup for queries which have `@*` attribute pattern [appium-uiautomator2-server#417](https://github.com/appium/appium-uiautomator2-server/pull/417)
### Android(Espresso)
* Fix to raise an error in [Reset App](http://appium.io/docs/en/commands/device/app/reset-app/). It must quit the session and create a new one in Espresso driver. [appium-espresso-driver#649](https://github.com/appium/appium-espresso-driver/pull/649)
* Fix to reset instrumentation state before starting a new instance [appium-espresso-driver#662](https://github.com/appium/appium-espresso-driver/pull/662)
* Gradle wrapper has been rewritten using Kotlin DSL [appium-espresso-driver#658](https://github.com/appium/appium-espresso-driver/pull/658), [appium-espresso-driver#659](https://github.com/appium/appium-espresso-driver/pull/659) (Thanks to @misa)
### iOS General
* Xcode 12.5 support
### iOS(XCUITest)
* Add capabilities:
* `appium:includeDeviceCapsToSessionInfo` to skip adding the screen information in order to improve [Get Session Capabilities](http://appium.io/docs/en/commands/session/get/) API. `mobile:viewportRect` and `mobile:deviceScreenInfo` help to get these information when this capability is `false`. [appium-xcuitest-driver#1278](https://github.com/appium/appium-xcuitest-driver/pull/1278)
* `appium:disableAutomaticScreenshots` to handle automatic screenshot by XCTest. Defaults to `true` [appium-xcuitest-driver#1288](https://github.com/appium/appium-xcuitest-driver/pull/1288) (@mrmacete)
* `appium:shouldTerminateApp` to handle if Appium terminates the application under test process on the session end. Defaults to `true` [appium-xcuitest-driver#1290](https://github.com/appium/appium-xcuitest-driver/pull/1290), [WebDriverAgent#486/](https://github.com/appium/WebDriverAgent/pull/486/) (Thanks to @mrmacete)
* Add `mobile:` extensions:
* `mobile:viewportRect` returns the screen viewport information which is part of [Get Session Capabilities](http://appium.io/docs/en/commands/session/get/)
* `mobile:deviceScreenInfo` returns the screen information which is part of [Get Session Capabilities](http://appium.io/docs/en/commands/session/get/), [WebDriverAgent#483](https://github.com/appium/WebDriverAgent/pull/483)
* `mobile:pushNotification` to simulator push notification on simulator by `xcrun simctl push` command. It requires Xcode 11.4+. Please read [mobile:pushNotification](https://github.com/appium/appium-xcuitest-driver#mobile-pushnotification) for mroe details to trigger a push notification. [appium-xcuitest-driver#1286](https://github.com/appium/appium-xcuitest-driver/pull/1286/)
* `mobile:expectNotification` to wait for a notification on the device under test. Please read [mobile:expectNotification](https://github.com/appium/appium-xcuitest-driver#mobile-pushnotification) for more information on how to use it. [appium-xcuitest-driver#1287](https://github.com/appium/appium-xcuitest-driver/pull/1287) [WebDriverAgent#480](https://github.com/appium/WebDriverAgent/pull/480)
* `mobile:performIoHidEvent` to emulate low-level IO HID device events. Read [mobile:performIoHidEvent](https://github.com/appium/appium-xcuitest-driver#mobile-performiohidevent) for more details. [appium-xcuitest-driver#1291](https://github.com/appium/appium-xcuitest-driver/pull/1291), [WebDriverAgent#494](https://github.com/appium/WebDriverAgent/pull/494)
* Add css selector support [appium-xcuitest-driver#1274](https://github.com/appium/appium-xcuitest-driver/pull/1274)
* `css selector` selector will be converted to `-ios class chain` selector
* Support [Get Geolocation](https://appium.io/docs/en/commands/session/geolocation/get-geolocation/) API [appium-xcuitest-driver#1266](https://github.com/appium/appium-xcuitest-driver/pull/1266)
* _Allow Location Access_ in _Location Services_ for _WebDriverAgent-Runner_ must be set to **Always**
* Add `accessible` attribute field into the XML page source [WebDriverAgent#493](https://github.com/appium/WebDriverAgent/pull/493) (Thanks to @TheDarkestDay)
* Improve performance of the keyboard dismissal logic [appium-xcuitest-driver#1267](https://github.com/appium/appium-xcuitest-driver/pull/1267), [WebDriverAgent#458](https://github.com/appium/WebDriverAgent/pull/458)
* Fix performance degradation of interaction in `nativeWebTap:true` [appium-xcuitest-driver/pull/1265](https://github.com/appium/appium-xcuitest-driver#1265)
### Mac2
* Add capabilities:
* `appium:webDriverAgentMacUrl` to allow Appium to connect to a running WebDriverAgentMac instance at this URL [appium-mac2-driver#41](https://github.com/appium/appium-mac2-driver/pull/41)
* Add a possibility to provide key names for `macos:keys` extension [appium-mac2-driver#60](https://github.com/appium/appium-mac2-driver/pull/60)
* Add `hittable` attribute field into the XML page source [appium-mac2-driver#65](https://github.com/appium/appium-mac2-driver/pull/65)
* More fine-grained handling of orphaned xcodebuild processes [appium-mac2-driver#73](https://github.com/appium/appium-mac2-driver/pull/73)
### You.i Engine Driver
The version is `1.2.8`
### Community based drivers
#### Flutter driver
The version is `0.0.28`
#### New drivers
Add the ability to load `appium-roku-driver`([appium#15227](https://github.com/appium/appium/pull/15227)) and `appium-webos-driver`([appium#15260](https://github.com/appium/appium/pull/15260)) by @cbuelvasc
CHANGES IN VERSION 1.20.2 (FROM 1.20.1)
===================================
Appium 1.20.2 is a patch release
### Android(UIAutomator2)
* Fix element caching performance [appium-uiautomator2-server#406](https://github.com/appium/appium-uiautomator2-server/pull/406)
CHANGES IN VERSION 1.20.1 (FROM 1.20.0)
===================================
Appium 1.20.1 is a patch release
### Android(UIAutomator2)
* Fix setting the session capabilities [appium-uiautomator2-server#404](https://github.com/appium/appium-uiautomator2-server/pull/404)
CHANGES IN VERSION 1.20.0 (FROM 1.19.1)
===================================
Appium 1.20.0 is a minor release
### General
* Does not destory sockets explicitly against a client [appium-base-driver#437](https://github.com/appium/appium-base-driver/pull/437)
* Connection timeout to each driver respects `--keep-alive-timeout` configuration [appium-base-driver#443](https://github.com/appium/appium-base-driver/pull/443). Default to 10 minutes
### Android General
* `InvalidContextError` error is thrown if running instrumentation process was dead
* Fix Android emulator config paths on Windows [appium-adb#558](https://github.com/appium/appium-adb/pull/558)
### Android(UIAutomator2)
* Appium adds `io.appium.settings`, `io.appium.uiautomator2.server` and `io.appium.uiautomator2.server.test` as the device's Doze whitelist to keep working [appium-uiautomator2-driver#420](https://github.com/appium/appium-uiautomator2-driver/pull/420)
* Add settings:
* `useResourcesForOrientationDetection` to use application resource propertires to determine the current device orientation [appium-uiautomator2-server#389](https://github.com/appium/appium-uiautomator2-server/pull/389)
### Android(Espresso)
* Appium adds `io.appium.settings` and `io.appium.espressoserver.test` as the device's Doze whitelist to keep working [appium-espresso-driver#627](https://github.com/appium/appium-espresso-driver/pull/627)
* Add `mobile:` extensions:
* `uiautomatorPageSource` returns the page source dump by UIAutomator [appium-espresso-driver#628](https://github.com/appium/appium-espresso-driver/pull/628)
* Improves XPath lookup performance [appium-espresso-driver#637](https://github.com/appium/appium-espresso-driver/pull/637)
### iOS General
* Fix updating simulator preference method [appium-ios-simulator#298](https://github.com/appium/appium-ios-simulator/pull/298)
### iOS(XCUITest)
* Support M1 chip based Mac, Xcode 12.3
* Snapshots caching logic has been rewritten to improve lookup performance e.g. [WebDriverAgent#404](https://github.com/appium/WebDriverAgent/pull/404), [WebDriverAgent#407](https://github.com/appium/WebDriverAgent/pull/407)
* Breaking changes
* Support over Xcode 10.2, iOS 12.2 (Drop supporting Xcode 10.0 and 10.1)
* `accessibility id`, `name` and `id` lookup strategies now find elements by `name`(`wdName`) attributes in page source: [WebDriverAgent#414](https://github.com/appium/WebDriverAgent/pull/414)
* Previously, they found elements by `name`(`wdName`) and `value`(`wdValue`)
* Please use `predicate` strategy to find `value`(`wdValue`) attribute like [this change](https://github.com/appium/ruby_lib_core/pull/282)
* Add capabilities:
* `resultBundlePath` and `resultBundleVersion` to allow to specify the path to the result bundle of WebDriverAgent xcodebuild [WebDriverAgent#410](https://github.com/appium/WebDriverAgent/pull/410)
* `safariIgnoreWebHostnames` to provide a list of hostnames that the Safari automation tools should ignore [appium-xcuitest-driver#1258](https://github.com/appium/appium-xcuitest-driver/pull/
1258)
* `waitForIdleTimeout` (Please read the below settings section)
* Add settings: (Please read [Settings API](http://appium.io/docs/en/advanced-concepts/settings/index.html) for more details)
* `customSnapshotTimeout` which was renamed from `snapshotTimeout` sets how much time is allowed to resolve a single accessibility snapshot with custom attributes
* `waitForIdleTimeout` to customize the time for waiting until the application under test is idling
* The value `zero` (not recommended) is equal to `waitForQuiescence` to `false`
* **Important**: this is still a workaround, so there is no guarantee it is going to always work. Please consider rather fixing your application source code, because XCTest uses idle intervals to send commands to the accessibility manager. You may get unexpected testing results or application crashes if such intervals don't exist or are too tiny.
* `animationCoolOffTimeout` customize the timeout to wait until the application under test has no animation
* Add a possibility to select elements by indexes [WebDriverAgent#417](https://github.com/appium/WebDriverAgent/pull/417)
* Fix parsing SSL output from OpenSSL output [appium-xcuitest-driver#1256](https://github.com/appium/appium-xcuitest-driver/pull/1256)
### iOS(Safari)
This driver provides you to communicate with Apple's `safaridriver` binary via Appium.
It only supports Safari browser automation on macOS and iOS (Simulator/Real Device).
Read https://github.com/appium/appium-safari-driver for more details.
### Mac2
This driver provides you to handle macOS native applications with Apple's `XCTest` framework.
Read https://github.com/appium/appium-mac2-driver for more details.
### Gecko
This driver provides you to communicate with Firefox browsers on macOS, Windows, Linux and Android with geckodriver binary via Appium.
Read https://github.com/appium/appium-geckodriver for more details to set the environment up.
CHANGES IN VERSION 1.19.1(FROM 1.19.0)
===================================
Appium 1.19.1 is a patch release
### iOS(XCUITest)
Patches "missing target for targetId" bug in Safari tests (see [#14867](https://github.com/appium/appium/issues/14867))
CHANGES IN VERSION 1.19.0 (FROM 1.18.3)
===================================
@@ -58,7 +227,7 @@ Appium 1.19.0 is a minor release
### Flutter
The version is `0.0.25`
The version is `0.25`
### You.i Engine Driver
+3 -12
View File
@@ -19,18 +19,9 @@ started](/docs/en/about-appium/getting-started.md) doc.
Appium supports app automation across a variety of platforms, like iOS,
Android, and Windows. Each platform is supported by one or more "drivers",
which know how to automate that particular platform. Choose a driver below for
specific information about how that driver works and how to set it up:
which know how to automate that particular platform.
* iOS
* The [XCUITest Driver](/docs/en/drivers/ios-xcuitest.md)
* (DEPRECATED) The [UIAutomation Driver](/docs/en/drivers/ios-uiautomation.md)
* Android
* The [Espresso Driver](/docs/en/drivers/android-espresso.md)
* The [UiAutomator2 Driver](/docs/en/drivers/android-uiautomator2.md)
* (DEPRECATED) The [UiAutomator Driver](/docs/en/drivers/android-uiautomator.md)
* The [Windows Driver](/docs/en/drivers/windows.md) (for Windows Desktop apps)
* The [Mac Driver](/docs/en/drivers/mac.md) (for Mac Desktop apps)
Please refer to [Appium Platform Support](/docs/en/about-appium/platform-support.md) for more details.
### Why Appium?
@@ -67,7 +58,7 @@ Concepts](/docs/en/about-appium/intro.md).
Your environment needs to be set up for the particular platforms that you want
to run tests on. Each of the drivers above documents the requirements for their
particular brand of automation. At a minimum, you will need to be able to run
Node.js 10+.
Node.js 12+.
### Get Started
-7
View File
@@ -14,13 +14,6 @@ jobs:
versionSpec: '12.x'
- script: npm ci || npm install # "npm ci" if shrinkwrap is present
displayName: Install NPM Dependencies
- script: |
pushd node_modules/appium-webdriveragent
carthage bootstrap --no-use-binaries
cp Cartfile.resolved Carthage
mkdir -p ./Resources/WebDriverAgent.bundle
popd
displayName: Fully build XCUITestDriver
- script: npm run build
displayName: npm run build
- script: npm prune --production
+2 -2
View File
@@ -9,7 +9,7 @@ jobs:
steps:
- task: NodeTool@0
inputs:
versionSpec: '10.x'
versionSpec: '14.x'
- script: |
pip install mkdocs==0.16.3
git config --global user.email "maintainers@appium.io"
@@ -28,4 +28,4 @@ jobs:
popd
displayName: Make branch with Updated Docs and make PR
env:
GITHUB_TOKEN: $(GITHUB_TOKEN)
GITHUB_TOKEN: $(GITHUB_TOKEN)
@@ -32,9 +32,6 @@ example_usage:
context = current_context
ruby_core:
context = @driver.current_context
php:
|
$context = $driver->context();
csharp:
|
string Context = driver.Context;
@@ -46,7 +43,6 @@ client_docs:
javascript_wd: "https://github.com/admc/wd/blob/master/doc/api.md"
ruby: "https://www.rubydoc.info/github/appium/ruby_lib_core/Appium/Core/Device#current_context-instance_method"
ruby_core: "https://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
# Driver support by platform
@@ -66,7 +62,6 @@ client_support:
java: true
python: true
ruby: true
php: true
csharp: true
javascript_wd: true
javascript_wdio: true
@@ -8,10 +8,10 @@ description:
For information on the format of the context names, see the [get context
documentation](/docs/en/commands/context/get-context.md).
[mobile command](/docs/en/commands/mobile-command.md)
`mobile: getContexts` is available on iOS (XCUITest) and Android
(UIAutomator2 and Espresso) to get more detailed contexts.
[mobile command](/docs/en/commands/mobile-command.md)
`mobile: getContexts` is available on iOS (XCUITest) and Android
(UIAutomator2 and Espresso) to get more detailed contexts.
For information on contexts, see Appium's [hybrid automation docs](/docs/en/writing-running-appium/web/hybrid.md).
example_usage:
@@ -33,9 +33,6 @@ example_usage:
ruby_core:
|
context = @driver.available_contexts
php:
|
$contexts = $driver->contexts();
csharp:
|
List<string> AllContexts = new List<string>();
@@ -51,7 +48,6 @@ client_docs:
javascript_wd: "https://github.com/admc/wd/blob/master/doc/api.md"
ruby: "https://www.rubydoc.info/github/appium/ruby_lib_core/Appium/Core/Device#available_contexts-instance_method"
ruby_core: "https://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
# Driver support by platform
@@ -71,7 +67,6 @@ client_support:
java: true
python: true
ruby: true
php: true
csharp: true
javascript_wd: true
javascript_wdio: true
@@ -50,12 +50,6 @@ example_usage:
@driver.set_context(webview)
# ...
@driver.set_context('NATIVE_APP')
php:
|
$contexts = $driver->contexts();
$driver->context($contexts[1]);
// ...
$driver->context('NATIVE_APP');
csharp:
|
// Switch to specific webview
@@ -75,7 +69,6 @@ client_docs:
javascript_wd: "https://github.com/admc/wd/blob/master/doc/api.md"
ruby: "https://www.rubydoc.info/github/appium/ruby_lib_core/Appium/Core/Device#set_context-instance_method"
ruby_core: "https://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
# Driver support by platform
@@ -95,7 +88,6 @@ client_support:
java: true
python: true
ruby: true
php: true
csharp: true
javascript_wd: true
javascript_wdio: true
@@ -21,9 +21,6 @@ example_usage:
ruby_core:
|
@driver.current_activity
php:
|
$activity = $driver->currentActivity();
csharp:
|
string activity = driver.CurrentActivity;
@@ -35,7 +32,6 @@ client_docs:
javascript_wd: "https://github.com/admc/wd/blob/master/lib/commands.js#L2519"
ruby: "https://www.rubydoc.info/github/appium/ruby_lib_core/Appium/Core/Device#current_activity-instance_method"
ruby_core: "https://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/blob/master/src/Appium.Net/Appium/Android/AndroidDriver.cs"
# Driver support by platform
@@ -55,7 +51,6 @@ client_support:
java: true
python: true
ruby: true
php: true
csharp: true
javascript_wd: true
javascript_wdio: true
@@ -21,9 +21,6 @@ example_usage:
ruby_core:
|
@driver.current_package
php:
|
// TODO PHP sample
csharp:
|
string package = driver.CurrentPackage;
@@ -35,7 +32,6 @@ client_docs:
javascript_wdio: "https://webdriver.io/docs/api/appium.html#getcurrentpackage"
ruby: "https://www.rubydoc.info/github/appium/ruby_lib_core/Appium/Core/Device#current_package-instance_method"
ruby_core: "https://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/blob/master/src/Appium.Net/Appium/Android/AndroidDriver.cs"
# Driver support by platform
@@ -55,7 +51,6 @@ client_support:
java: true
python: true
ruby: true
php: true
csharp: true
javascript_wd: true
javascript_wdio: false
@@ -24,10 +24,6 @@ example_usage:
ruby_core:
|
@driver.start_activity app_package: "com.example", app_activity: "ActivityName"
php:
|
$driver->startActivity(array('appPackage' => 'com.example',
'appActivity' => 'ActivityName'));
csharp:
|
driver.StartActivity("com.example", "ActivityName");
@@ -39,7 +35,6 @@ client_docs:
javascript_wd: "https://github.com/admc/wd/blob/master/lib/commands.js#L2948"
ruby: "https://www.rubydoc.info/github/appium/ruby_lib_core/Appium/Core/Android/Device#start_activity-instance_method"
ruby_core: "https://www.rubydoc.info/github/appium/ruby_lib_core/Appium/Core/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/blob/master/src/Appium.Net/Appium/Android/AndroidDriver.cs"
# Driver support by platform
@@ -59,7 +54,6 @@ client_support:
java: true
python: true
ruby: true
php: true
csharp: true
javascript_wd: true
javascript_wdio: true
@@ -30,9 +30,6 @@ example_usage:
|
@driver.activate_app('com.apple.Preferences')
@driver.activate_app('io.appium.android.apis')
php:
|
// Supports only `mobile: queryAppState` for iOS, XCUITest
csharp:
|
driver.activateApp('com.apple.Preferences');
@@ -45,7 +42,6 @@ client_docs:
javascript_wd: "https://github.com/admc/wd/blob/master/lib/commands.js" # TODO wd documentation link
ruby: "https://www.rubydoc.info/github/appium/ruby_lib_core/Appium/Core/Device#activate_app-instance_method"
ruby_core: "https://www.rubydoc.info/github/appium/ruby_lib_core/Appium/Core/Device#activate_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
# Driver support by platform
@@ -65,7 +61,6 @@ client_support:
java: true
python: true
ruby: true
php: true
csharp: true
javascript_wd: true
javascript_wdio: true
@@ -30,9 +30,6 @@ example_usage:
|
@driver.app_state('com.apple.Preferences')
@driver.query_app_state('io.appium.android.apis') # `query_` prefix is also available
php:
|
// Supports only `mobile: queryAppState` for iOS, XCUITest
csharp:
|
// Supports only `mobile: queryAppState` for iOS, XCUITest
@@ -44,7 +41,6 @@ client_docs:
javascript_wd: "https://github.com/admc/wd/blob/master/lib/commands.js" # TODO wd documentation link
ruby: "https://www.rubydoc.info/github/appium/ruby_lib_core/Appium/Core/Base/Driver#app_state-instance_method"
ruby_core: "https://www.rubydoc.info/github/appium/ruby_lib_core/Appium/Core/Base/Driver#app_state-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
# Driver support by platform
@@ -64,7 +60,6 @@ client_support:
java: true
python: true
ruby: true
php: true
csharp: true
javascript_wd: true
javascript_wdio: true
@@ -73,7 +68,7 @@ client_support:
# Information about the HTTP endpoints
endpoint:
url: /session/:session_id/appium/device/app_state
method: GET
method: POST
url_parameters:
- name: session_id
description: ID of the session to route the command to
@@ -42,9 +42,6 @@ example_usage:
ruby_core:
|
@driver.background_app(10)
php:
|
$driver->backgroundApp(10);
csharp:
|
driver.BackgroundApp(10)
@@ -56,7 +53,6 @@ client_docs:
javascript_wd: "https://github.com/admc/wd/blob/master/lib/commands.js#L2841"
ruby: "https://www.rubydoc.info/github/appium/ruby_lib_core/Appium/Core/Device#background_app-instance_method"
ruby_core: "https://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
# Driver support by platform
@@ -76,7 +72,6 @@ client_support:
java: true
python: true
ruby: true
php: true
csharp: true
javascript_wd: true
javascript_wdio: true
@@ -20,9 +20,6 @@ example_usage:
ruby_core:
|
@driver.close_app
php:
|
$driver->closeApp();
csharp:
|
driver.CloseApp();
@@ -34,7 +31,6 @@ client_docs:
javascript_wd: "https://github.com/admc/wd/blob/master/lib/commands.js#L2798"
ruby: "https://www.rubydoc.info/github/appium/ruby_lib_core/Appium/Core/Device#close_app-instance_method"
ruby_core: "https://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/blob/master/src/Appium.Net/Appium/AppiumDriver.cs"
# Driver support by platform
@@ -54,7 +50,6 @@ client_support:
java: true
python: true
ruby: true
php: true
csharp: true
javascript_wd: true
javascript_wdio: true
@@ -20,9 +20,6 @@ example_usage:
ruby_core:
|
@driver.end_coverage("Intent", "/path")
php:
|
$driver->endTestCoverage('Intent', '/path');
csharp:
|
driver.EndTestCoverage("Intent", "/path");
@@ -34,7 +31,6 @@ client_docs:
javascript_wdio: "https://webdriver.io/docs/api/appium.html#endcoverage"
ruby: "https://www.rubydoc.info/github/appium/ruby_lib_core/Appium/Core/Android/Device#end_coverage-instance_method"
ruby_core: "https://www.rubydoc.info/github/appium/ruby_lib_core/Appium/Core/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/blob/master/src/Appium.Net/Appium/Android/AndroidDriver.cs"
# Driver support by platform
@@ -54,7 +50,6 @@ client_support:
java: true
python: true
ruby: false
php: true
csharp: true
javascript_wd: true
javascript_wdio: true
@@ -20,9 +20,6 @@ example_usage:
ruby_core:
|
@driver.app_strings("en")
php:
|
$strings = $driver->appStrings();
csharp:
|
Dictionary<string, object> appStrings = driver.GetAppStringDictionary("end", "/path/to/file");
@@ -34,7 +31,6 @@ client_docs:
javascript_wd: "https://github.com/admc/wd/blob/master/lib/commands.js#L2916"
ruby: "https://www.rubydoc.info/github/appium/ruby_lib_core/Appium/Core/Device#app_strings-instance_method"
ruby_core: "https://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/blob/master/src/Appium.Net/Appium/AppiumDriver.cs"
# Driver support by platform
@@ -54,7 +50,6 @@ client_support:
java: true
python: true
ruby: true
php: true
csharp: true
javascript_wd: true
javascript_wdio: true
@@ -25,9 +25,6 @@ example_usage:
ruby_core:
|
@driver.install_app('/Users/johndoe/path/to/app.apk')
php:
|
$driver->installApp('/Users/johndoe/path/to/app.apk');
csharp:
|
driver.InstallApp("/Users/johndoe/path/to/app.apk")
@@ -39,7 +36,6 @@ client_docs:
javascript_wd: "https://github.com/admc/wd/blob/master/lib/commands.js#L2540"
ruby: "https://www.rubydoc.info/github/appium/ruby_lib_core/Appium/Core/Device#install_app-instance_method"
ruby_core: "https://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/blob/master/src/Appium.Net/Appium/AppiumDriver.cs"
# Driver support by platform
@@ -59,7 +55,6 @@ client_support:
java: true
python: true
ruby: true
php: true
csharp: true
javascript_wd: true
javascript_wdio: true
@@ -25,9 +25,6 @@ example_usage:
ruby_core:
|
@driver.app_installed?('com.example.AppName')
php:
|
$driver->isAppInstalled('com.example.AppName')
csharp:
|
driver.IsAppInstalled("com.example.AppName");
@@ -39,7 +36,6 @@ client_docs:
javascript_wd: "https://github.com/admc/wd/blob/master/lib/commands.js#L2586"
ruby: "https://www.rubydoc.info/github/appium/ruby_lib_core/Appium/Core/Device#app_installed%3F-instance_method"
ruby_core: "https://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/blob/master/src/Appium.Net/Appium/AppiumDriver.cs"
# Driver support by platform
@@ -59,7 +55,6 @@ client_support:
java: true
python: true
ruby: true
php: true
csharp: true
javascript_wd: true
javascript_wdio: true
@@ -28,9 +28,6 @@ example_usage:
ruby_core:
|
@driver.launch_app
php:
|
$driver->launchApp();
csharp:
|
driver.LaunchApp();
@@ -42,7 +39,6 @@ client_docs:
javascript_wd: "https://github.com/admc/wd/blob/master/lib/commands.js#L2798"
ruby: "https://www.rubydoc.info/github/appium/ruby_lib_core/Appium/Core/Device#launch_app-instance_method"
ruby_core: "https://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/blob/master/src/Appium.Net/Appium/AppiumDriver.cs"
# Driver support by platform
@@ -62,7 +58,6 @@ client_support:
java: true
python: true
ruby: true
php: true
csharp: true
javascript_wd: true
javascript_wdio: true
@@ -26,9 +26,6 @@ example_usage:
ruby_core:
|
@driver.remove_app('com.example.AppName')
php:
|
$driver->removeApp('com.example.AppName');
csharp:
|
driver.RemoveApp("com.example.AppName");
@@ -40,7 +37,6 @@ client_docs:
javascript_wd: "https://github.com/admc/wd/blob/master/lib/commands.js#L2563"
ruby: "https://www.rubydoc.info/github/appium/ruby_lib_core/Appium/Core/Device#remove_app-instance_method"
ruby_core: "https://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/blob/master/src/Appium.Net/Appium/AppiumDriver.cs"
# Driver support by platform
@@ -60,7 +56,6 @@ client_support:
java: true
python: true
ruby: true
php: true
csharp: true
javascript_wd: true
javascript_wdio: true
@@ -20,9 +20,6 @@ example_usage:
ruby_core:
|
@driver.reset
php:
|
$driver->reset();
csharp:
|
driver.ResetApp();
@@ -34,7 +31,6 @@ client_docs:
javascript_wd: "https://github.com/admc/wd/blob/master/lib/commands.js#L2827"
ruby: "https://www.rubydoc.info/github/appium/ruby_lib_core/Appium/Core/Device#reset-instance_method"
ruby_core: "https://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/blob/master/src/Appium.Net/Appium/AppiumDriver.cs"
# Driver support by platform
@@ -54,7 +50,6 @@ client_support:
java: true
python: true
ruby: true
php: true
csharp: true
javascript_wd: true
javascript_wdio: true
@@ -30,9 +30,6 @@ example_usage:
|
@driver.terminate_app('com.apple.Preferences')
@driver.terminate_app('io.appium.android.apis')
php:
|
// Supports only `mobile: queryAppState` for iOS, XCUITest
csharp:
|
// Supports only `mobile: queryAppState` for iOS, XCUITest
@@ -44,7 +41,6 @@ client_docs:
javascript_wd: "https://github.com/admc/wd/blob/master/lib/commands.js" # TODO wd documentation link
ruby: "https://www.rubydoc.info/github/appium/ruby_lib_core/Appium/Core/Base/Driver#terminate_app-instance_method"
ruby_core: "https://www.rubydoc.info/github/appium/ruby_lib_core/Appium/Core/Base/Driver#terminate_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
# Driver support by platform
@@ -64,7 +60,6 @@ client_support:
java: true
python: true
ruby: true
php: true
csharp: true
javascript_wd: true
javascript_wdio: true
@@ -28,9 +28,6 @@ example_usage:
ruby_core:
|
@driver.finger_print 1
php:
|
// PHP Code here
csharp:
|
// CSharp Code here
@@ -42,7 +39,6 @@ client_docs:
javascript_wd: "https://github.com/appium/appium-android-driver/blob/d16c7161d92ab6f6c9cec3f22218219ac3659716/lib/commands/actions.js#L260"
ruby: "https://www.rubydoc.info/github/appium/ruby_lib_core/master/Appium/Core/Android/Device#finger_print-instance_method"
ruby_core: "https://www.rubydoc.info/github/appium/ruby_lib_core/master/Appium/Core/Android/Device#finger_print-instance_method"
php:
csharp:
# Driver support by platform
@@ -62,7 +58,6 @@ client_support:
java: true
python: true
ruby: true
php: false
csharp: false
javascript_wd: true
javascript_wdio: true
@@ -8,6 +8,12 @@ description:
(For iOS real devices)
Apple security preferences require the WebDriverAgentRunner application to be in [foreground](https://github.com/appium/WebDriverAgent/issues/330) in order to be able to receive the system clipboard content. Otherwise an empty string is always returned. Consider using [Activate App](/docs/en/commands/device/app/activate-app.md) and [Background App](/docs/en/commands/device/app/background-app.md) to change the foreground application.
Activate App command cannot launch the WebDriverAgent properly on some environments. It depends on XCTest framework by Apple. Then, you should launch the WebDriverAgent using its Springboard's application icon. Follow the example below.
1. Open springboard, `@driver.activate_app 'com.apple.springboard'`.
2. Find the WDA icon with `@driver.find_element :accessibility_id, 'WebDriverAgentRunner-Runner'` (It should be visible on the screen) and click it.
3. Call the get clipboard API.
4. Open the application under test with the [Activate App](/docs/en/commands/device/app/activate-app.md).
example_usage:
java:
@@ -30,9 +36,6 @@ example_usage:
ruby_core:
|
@driver.get_clipboard
php:
|
// PHP Code here
csharp:
|
// CSharp Code here
@@ -48,7 +51,6 @@ client_docs:
ruby_core:
- android: "https://www.rubydoc.info/github/appium/ruby_lib_core/Appium/Core/Android/Device#get_clipboard-instance_method"
- ios: "https://www.rubydoc.info/github/appium/ruby_lib_core/Appium/Core/Ios/Device#get_clipboard-instance_method"
php: "https://github.com/appium/php-client/releases/latest"
csharp: "https://github.com/appium/appium" # TODO
# Driver support by platform
@@ -68,7 +70,6 @@ client_support:
java: true
python: true
ruby: true
php: false
csharp: false
javascript_wd: true
javascript_wdio: true
@@ -27,9 +27,6 @@ example_usage:
ruby_core:
|
@driver.set_clipboard content: 'happy testing'
php:
|
// PHP Code here
csharp:
|
// CSharp Code here
@@ -45,7 +42,6 @@ client_docs:
ruby_core:
- ios: "https://www.rubydoc.info/github/appium/ruby_lib_core/Appium/Core/Ios/Device#set_clipboard-instance_method"
- android: "https://www.rubydoc.info/github/appium/ruby_lib_core/Appium/Core/Android/Device#set_clipboard-instance_method"
php: "https://github.com/appium/php-client/releases/latest"
csharp: "https://github.com/appium/appium" # TODO
# Driver support by platform
@@ -65,7 +61,6 @@ client_support:
java: true
python: true
ruby: true
php: false
csharp: false
javascript_wd: true
javascript_wdio: true
@@ -48,7 +48,6 @@ client_support:
java: true
python: true
ruby: true
php: false
csharp: false
javascript_wd: false
javascript_wdio: false
@@ -48,7 +48,6 @@ client_support:
java: true
python: true
ruby: true
php: false
csharp: false
javascript_wd: false
javascript_wdio: false
@@ -21,9 +21,6 @@ example_usage:
ruby_core:
|
@driver.pull_file('/data/local/tmp/file.txt')
php:
|
$data = $driver->pullFile('data/local/tmp/file.txt');
csharp:
|
byte[] fileBase64 = driver.PullFile("/path/to/device/foo.bar");
@@ -35,7 +32,6 @@ client_docs:
javascript_wd: "https://github.com/admc/wd/blob/master/lib/commands.js#L2665"
ruby: "https://www.rubydoc.info/github/appium/ruby_lib_core/Appium/Core/Device#pull_file-instance_method"
ruby_core: "https://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/blob/master/src/Appium.Net/Appium/AppiumDriver.cs"
# Driver support by platform
@@ -55,7 +51,6 @@ client_support:
java: true
python: true
ruby: true
php: true
csharp: true
javascript_wd: true
javascript_wdio: true
@@ -21,9 +21,6 @@ example_usage:
ruby_core:
|
@driver.pull_folder('/data/local/tmp/file.txt')
php:
|
$folderBase64 = $driver->pullFolder($path);
csharp:
|
byte[] folder = driver.PullFolder("/path/to/device");
@@ -35,7 +32,6 @@ client_docs:
javascript_wd: "https://github.com/admc/wd/blob/master/lib/commands.js#L2688"
ruby: "https://www.rubydoc.info/github/appium/ruby_lib_core/Appium/Core/Device#pull_folder-instance_method"
ruby_core: "https://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/blob/master/src/Appium.Net/Appium/AppiumDriver.cs"
# Driver support by platform
@@ -55,7 +51,6 @@ client_support:
java: true
python: true
ruby: true
php: true
csharp: true
javascript_wd: true
javascript_wdio: true
@@ -5,7 +5,7 @@ short_description: Place a file onto the device in a particular place
example_usage:
java:
|
driver.pushFile("/path/to/device/foo.bar", new File("/Users/johndoe/files/foo.bar"));
driver.pushFile("/data/local/tmp/foo.bar", new File("/Users/johndoe/files/foo.bar"));
python:
|
dest_path = '/data/local/tmp/test_push_file.txt'
@@ -13,23 +13,20 @@ example_usage:
self.driver.push_file(dest_path, base64.b64encode(data).decode('utf-8'))
javascript_wd:
|
await driver.pushFileToDevice('/path/to/device/foo.bar', 'QXJlIHlvdXIgYmVlcnMgb2theT8=');
await driver.pushFileToDevice('/data/local/tmp/foo.bar', 'QXJlIHlvdXIgYmVlcnMgb2theT8=');
javascript_wdio:
|
let data = new Buffer("Hello World").toString('base64');
driver.pushFile('/data/local/tmp/file.txt', data);
ruby:
|
push_file('/path/to/device/foo.bar', File.read('path/to/file.png'))
push_file('/data/local/tmp/foo.bar', File.read('path/to/file.png'))
ruby_core:
|
@driver.push_file('/path/to/device/foo.bar', File.read('path/to/file.png'))
php:
|
$driver->pushFile('/path/to/device/foo.bar', 'QXJlIHlvdXIgYmVlcnMgb2theT8=');
@driver.push_file('/data/local/tmp/foo.bar', File.read('path/to/file.png'))
csharp:
|
driver.PushFile("/path/to/device/foo.bar", new FileInfo("/Users/johndoe/files/foo.bar"))
driver.PushFile("/data/local/tmp/foo.bar", new FileInfo("/Users/johndoe/files/foo.bar"))
client_docs:
java: "https://appium.github.io/java-client/io/appium/java_client/android/PushesFiles.html#pushFile-java.lang.String-java.io.File-"
@@ -38,7 +35,6 @@ client_docs:
javascript_wd: "https://github.com/admc/wd/blob/master/lib/commands.js#L2640"
ruby: "https://www.rubydoc.info/github/appium/ruby_lib_core/Appium/Core/Device#push_file-instance_method"
ruby_core: "https://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/blob/master/src/Appium.Net/Appium/AppiumDriver.cs"
# Driver support by platform
@@ -58,7 +54,6 @@ client_support:
java: true
python: true
ruby: true
php: true
csharp: true
javascript_wd: true
javascript_wdio: true
@@ -22,9 +22,6 @@ example_usage:
ruby_core:
|
@driver.device_locked?
php:
|
// TODO PHP sample
csharp:
|
bool isLocked = driver.IsLocked(); // Supported by IOSDriver & AndroidDriver
@@ -36,7 +33,6 @@ client_docs:
javascript_wd: "https://github.com/admc/wd/blob/master/lib/commands.js#L2407"
ruby: "https://www.rubydoc.info/github/appium/ruby_lib_core/Appium/Core/Device#device_locked%3F-instance_method"
ruby_core: "https://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/blob/master/src/Appium.Net/Appium/Android/AndroidDriver.cs"
# Driver support by platform
@@ -56,7 +52,6 @@ client_support:
java: true
python: true
ruby: true
php: true
csharp: true
javascript_wd: true
javascript_wdio: true
@@ -25,9 +25,6 @@ example_usage:
|
@driver.lock
@driver.lock(5) # lock 5 seconds
php:
|
$driver->lock(5);
csharp:
|
driver.Lock(); // Supported by IOSDriver & AndroidDriver
@@ -39,7 +36,6 @@ client_docs:
javascript_wd: "https://github.com/admc/wd/blob/master/lib/commands.js#L2363"
ruby: "https://www.rubydoc.info/github/appium/ruby_lib_core/Appium/Core/Device#lock-instance_method"
ruby_core: "https://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/blob/master/src/Appium.Net/Appium/Android/AndroidDriver.cs"
# Driver support by platform
@@ -59,7 +55,6 @@ client_support:
java: true
python: true
ruby: true
php: true
csharp: true
javascript_wd: true
javascript_wdio: true
@@ -12,9 +12,6 @@ example_usage:
javascript_wdio:
|
driver.rotateDevice(100, 100);
php:
|
// TODO PHP sample
csharp:
|
driver.Rotate(new Dictionary<string, int> { { "x", 114 }, { "y", 198 }, { "duration", 5 }, { "radius", 3 }, { "rotation", 220 }, { "touchCount", 2 } });
@@ -23,7 +20,6 @@ client_docs:
java: "https://appium.github.io/java-client/io/appium/java_client/AppiumDriver.html#rotate-org.openqa.selenium.DeviceRotation-"
javascript_wdio: "https://webdriver.io/docs/api/appium.html#rotatedevice"
javascript_wd: "https://github.com/admc/wd/blob/master/lib/commands.js#L2470"
php: "https://github.com/appium/php-client/" # TODO PHP documentation link
csharp: "https://github.com/appium/appium-dotnet-driver/blob/master/src/Appium.Net/Appium/AppiumDriver.cs"
# Driver support by platform
@@ -43,7 +39,6 @@ client_support:
java: true
python: true
ruby: true
php: true
csharp: true
javascript_wd: true
javascript_wdio: true
@@ -22,9 +22,6 @@ example_usage:
ruby_core:
|
@driver.shake
php:
|
$driver->shake();
csharp:
|
driver.ShakeDevice();
@@ -36,7 +33,6 @@ client_docs:
javascript_wd: "https://github.com/admc/wd/blob/master/lib/commands.js#L2342"
ruby: "https://www.rubydoc.info/github/appium/ruby_lib_core/Appium/Core/Device#shake-instance_method"
ruby_core: "https://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/blob/master/src/Appium.Net/Appium/iOS/IOSDriver.cs"
# Driver support by platform
@@ -56,7 +52,6 @@ client_support:
java: true
python: true
ruby: true
php: true
csharp: true
javascript_wd: true
javascript_wdio: true
@@ -25,9 +25,6 @@ example_usage:
ruby_core:
|
@driver.unlock
php:
|
// TODO PHP sample
csharp:
|
driver.Unlock(); // Supported by IOSDriver & AndroidDriver
@@ -39,7 +36,6 @@ client_docs:
javascript_wd: "https://github.com/admc/wd/blob/master/lib/commands.js#L2386"
ruby: "https://www.rubydoc.info/github/appium/ruby_lib_core/Appium/Core/Device#unlock-instance_method"
ruby_core: "https://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/blob/master/src/Appium.Net/Appium/Android/AndroidDriver.cs"
# Driver support by platform
@@ -59,7 +55,6 @@ client_support:
java: true
python: true
ruby: true
php: true
csharp: true
javascript_wd: true
javascript_wdio: true
@@ -21,12 +21,6 @@ example_usage:
ruby_core:
|
@driver.hide_keyboard
php:
|
$driver->hideKeyboard();
$driver->hideKeyboard(array(
'keyName' => 'Done'
));
csharp:
|
driver.HideKeyboard();
@@ -38,7 +32,6 @@ client_docs:
javascript_wd: "https://github.com/admc/wd/blob/master/lib/commands.js#L2723"
ruby: "https://www.rubydoc.info/github/appium/ruby_lib_core/Appium/Core/Device#hide_keyboard-instance_method"
ruby_core: "https://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/blob/master/src/Appium.Net/Appium/AppiumDriver.cs"
# Driver support by platform
@@ -58,7 +51,6 @@ client_support:
java: true
python: true
ruby: true
php: true
csharp: true
javascript_wd: true
javascript_wdio: true
@@ -47,7 +47,6 @@ client_support:
java: true
python: true
ruby: true
php: false
csharp: false
javascript_wd: true
javascript_wdio: false
@@ -23,9 +23,6 @@ example_usage:
ruby_core:
|
@driver.long_press_keycode(10)
php:
|
// TODO PHP sample
csharp:
|
driver.LongPressKeyCode(WindowsKeyCode.Back);
@@ -37,7 +34,6 @@ client_docs:
javascript_wd: "https://github.com/admc/wd/blob/master/lib/commands.js#L2478"
ruby: "https://www.rubydoc.info/github/appium/ruby_lib_core/Appium/Core/Device#long_press_keycode-instance_method"
ruby_core: "https://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/blob/master/src/Appium.Net/Appium/Windows/WindowsDriver.cs"
# Driver support by platform
@@ -57,7 +53,6 @@ client_support:
java: true
python: true
ruby: true
php: true
csharp: true
javascript_wd: true
javascript_wdio: true
@@ -23,9 +23,6 @@ example_usage:
ruby_core:
|
@driver.press_keycode(10)
php:
|
// TODO PHP sample
csharp:
|
driver.PressKeyCode(WindowsKeyCode.Windows);
@@ -37,7 +34,6 @@ client_docs:
javascript_wd: "https://github.com/admc/wd/blob/master/lib/commands.js#L2457"
ruby: "https://www.rubydoc.info/github/appium/ruby_lib_core/Appium/Core/Device#press_keycode-instance_method"
ruby_core: "https://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/blob/master/src/Appium.Net/Appium/Windows/WindowsDriver.cs"
# Driver support by platform
@@ -57,7 +53,6 @@ client_support:
java: true
python: true
ruby: true
php: true
csharp: true
javascript_wd: true
javascript_wdio: true
@@ -21,9 +21,6 @@ example_usage:
ruby_core:
|
@driver.gsm_call(phone_number: '5551234567', action: :call)
php:
|
// TODO
csharp:
|
// TODO
@@ -35,7 +32,6 @@ client_docs:
javascript_wdio: "https://webdriver.io/docs/api/appium.html#gsmcall"
ruby: "https://www.rubydoc.info/github/appium/ruby_lib_core/master/Appium/Core/Android/Device/Emulator#gsm_call-instance_method"
ruby_core: "https://www.rubydoc.info/github/appium/ruby_lib_core/master/Appium/Core/Android/Device/Emulator#gsm_call-instance_method"
php: "https://github.com/appium/php-client/" # TODO
csharp: "https://github.com/appium/appium-dotnet-driver/" # TODO
# Driver support by platform
@@ -55,7 +51,6 @@ client_support:
java: true
python: true
ruby: true
php: false
csharp: false
javascript_wd: true
javascript_wdio: true
@@ -21,9 +21,6 @@ example_usage:
ruby_core:
|
@driver.gsm_signal :good
php:
|
// TODO
csharp:
|
// TODO
@@ -35,7 +32,6 @@ client_docs:
javascript_wdio: "https://webdriver.io/docs/api/appium.html#gsmsignal"
ruby: "https://www.rubydoc.info/github/appium/ruby_lib_core/master/Appium/Core/Android/Device/Emulator#gsm_signal-instance_method"
ruby_core: "https://www.rubydoc.info/github/appium/ruby_lib_core/master/Appium/Core/Android/Device/Emulator#gsm_signal-instance_method"
php: "https://github.com/appium/php-client/" # TODO
csharp: "https://github.com/appium/appium-dotnet-driver/" # TODO
# Driver support by platform
@@ -55,7 +51,6 @@ client_support:
java: true
python: true
ruby: true
php: false
csharp: false
javascript_wd: true
javascript_wdio: true
@@ -21,9 +21,6 @@ example_usage:
ruby_core:
|
@driver.gsm_voice :home
php:
|
// TODO
csharp:
|
// TODO
@@ -35,7 +32,6 @@ client_docs:
javascript_wdio: "https://webdriver.io/docs/api/appium.html#gsmvoice"
ruby: "https://www.rubydoc.info/github/appium/ruby_lib_core/master/Appium/Core/Android/Device/Emulator#gsm_voice-instance_method"
ruby_core: "https://www.rubydoc.info/github/appium/ruby_lib_core/master/Appium/Core/Android/Device/Emulator#gsm_voice-instance_method"
php: "https://github.com/appium/php-client/" # TODO
csharp: "https://github.com/appium/appium-dotnet-driver/" # TODO
# Driver support by platform
@@ -55,7 +51,6 @@ client_support:
java: true
python: true
ruby: true
php: false
csharp: false
javascript_wd: true
javascript_wdio: true
@@ -47,7 +47,6 @@ client_support:
java: true
python: true
ruby: true
php: false
csharp: false
javascript_wd: true
javascript_wdio: true
@@ -21,9 +21,6 @@ example_usage:
ruby_core:
|
@driver.send_sms(phone_number: '555-123-4567', message: 'Hey lol')
php:
|
// TODO
csharp:
|
// TODO
@@ -35,7 +32,6 @@ client_docs:
javascript_wdio: "https://webdriver.io/docs/api/appium.html#sendsms"
ruby: "https://www.rubydoc.info/github/appium/ruby_lib_core/master/Appium/Core/Android/Device/Emulator#send_sms-instance_method"
ruby_core: "https://www.rubydoc.info/github/appium/ruby_lib_core/master/Appium/Core/Android/Device/Emulator#send_sms-instance_method"
php: "https://github.com/appium/php-client/" # TODO
csharp: "https://github.com/appium/appium-dotnet-driver/" # TODO
# Driver support by platform
@@ -55,7 +51,6 @@ client_support:
java: true
python: true
ruby: true
php: false
csharp: false
javascript_wd: true
javascript_wdio: true
@@ -18,9 +18,6 @@ example_usage:
ruby_core:
|
@driver.toggle_flight_mode
php:
|
// TODO
csharp:
|
// TODO
@@ -31,7 +28,6 @@ client_docs:
javascript_wd: "https://github.com/admc/wd/blob/master/lib/commands.js#L2712"
ruby: "https://www.rubydoc.info/github/appium/ruby_lib_core/Appium/Core/Device#toggle_flight_mode-instance_method"
ruby_core: "https://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
# Driver support by platform
@@ -51,7 +47,6 @@ client_support:
java: true
python: false
ruby: true
php: true
csharp: true
javascript_wd: true
javascript_wdio: true
@@ -24,9 +24,6 @@ example_usage:
ruby_core:
|
@driver.toggle_data
php:
|
// TODO
csharp:
|
// TODO
@@ -37,7 +34,6 @@ client_docs:
javascript_wd: "https://github.com/admc/wd/blob/master/lib/commands.js#L2771"
ruby: "https://www.rubydoc.info/github/appium/ruby_lib_core/master/Appium/Core/Device#toggle_data-instance_method"
ruby_core: "https://www.rubydoc.info/github/appium/ruby_lib_core/master/Appium/Core/Device#toggle_data-instance_method"
php: "https://github.com/appium/php-client/" # TODO
csharp: "https://github.com/appium/appium-dotnet-driver/" # TODO
# Driver support by platform
@@ -57,7 +53,6 @@ client_support:
java: true
python: false
ruby: true
php: true
csharp: true
javascript_wd: true
javascript_wdio: true
@@ -21,9 +21,6 @@ example_usage:
ruby_core:
|
@driver.toggle_location_services
php:
|
// TODO
csharp:
|
// TODO
@@ -35,7 +32,6 @@ client_docs:
javascript_wd: "https://github.com/admc/wd/blob/master/lib/commands.js#L2758"
ruby: "https://www.rubydoc.info/github/appium/ruby_lib_core/master/Appium/Core/Device#toggle_location_services-instance_method"
ruby_core: "https://www.rubydoc.info/github/appium/ruby_lib_core/master/Appium/Core/Device#toggle_location_services-instance_method"
php: "https://github.com/appium/php-client/" # TODO
csharp: "https://github.com/appium/appium-dotnet-driver/" # TODO
# Driver support by platform
@@ -55,7 +51,6 @@ client_support:
java: true
python: true
ruby: true
php: true
csharp: true
javascript_wd: true
javascript_wdio: true
@@ -29,9 +29,6 @@ example_usage:
ruby_core:
|
@driver.toggle_wifi
php:
|
// TODO
csharp:
|
// TODO
@@ -43,7 +40,6 @@ client_docs:
javascript_wd: "https://github.com/admc/wd/blob/master/lib/commands.js#L2738"
ruby: "https://www.rubydoc.info/github/appium/ruby_lib_core/master/Appium/Core/Device#toggle_wifi-instance_method"
ruby_core: "https://www.rubydoc.info/github/appium/ruby_lib_core/master/Appium/Core/Device#toggle_wifi-instance_method"
php: "https://github.com/appium/php-client/" # TODO
csharp: "https://github.com/appium/appium-dotnet-driver/" # TODO
# Driver support by platform
@@ -63,7 +59,6 @@ client_support:
java: true
python: true
ruby: true
php: true
csharp: true
javascript_wd: true
javascript_wdio: true
@@ -22,9 +22,6 @@ example_usage:
ruby_core:
|
@driver.get_performance_data package_name: 'io.appium.android.apis', data_type: 'cpuinfo', data_read_timeout: 10
php:
|
// TODO PHP sample
csharp:
|
// Not supported
@@ -36,7 +33,6 @@ client_docs:
javascript_wdio: "https://webdriver.io/docs/api/appium.html#getperformancedata"
ruby: "https://www.rubydoc.info/github/appium/ruby_lib_core/Appium/Core/Android/Device#get_performance_data-instance_method"
ruby_core: "https://www.rubydoc.info/github/appium/ruby_lib_core/Appium/Core/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
# Driver support by platform
@@ -56,7 +52,6 @@ client_support:
java: true
python: false
ruby: true
php: false
csharp: false
javascript_wd: true
javascript_wdio: true
@@ -21,9 +21,6 @@ example_usage:
ruby_core:
|
@driver.get_performance_data_types
php:
|
// TODO PHP sample
csharp:
|
// Not supported
@@ -35,7 +32,6 @@ client_docs:
javascript_wdio: "https://webdriver.io/docs/api/appium.html#getperformancedatatypes"
ruby: "https://www.rubydoc.info/github/appium/ruby_lib_core/Appium/Core/Android/Device#get_performance_data_types-instance_method"
ruby_core: "https://www.rubydoc.info/github/appium/ruby_lib_core/Appium/Core/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
# Driver support by platform
@@ -55,7 +51,6 @@ client_support:
java: true
python: false
ruby: true
php: false
csharp: false
javascript_wd: true
javascript_wdio: true
@@ -26,9 +26,6 @@ example_usage:
python:
|
self.driver.start_recording_screen()
php:
|
// TODO PHP sample
csharp:
|
driver.StartRecordingScreen(
@@ -48,7 +45,6 @@ client_docs:
ruby_core:
- android: "https://www.rubydoc.info/github/appium/ruby_lib_core/Appium/Core/Android/Device#start_recording_screen-instance_method"
ios: "https://www.rubydoc.info/github/appium/ruby_lib_core/Appium/Core/Ios/Xcuitest/Device#start_recording_screen-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
# Driver support by platform
@@ -68,7 +64,6 @@ client_support:
java: true
python: true
ruby: true
php: false
csharp: false
javascript_wd: true
javascript_wdio: true
@@ -115,7 +110,7 @@ endpoint:
- name: options.videoType
type: string
description: (iOS Only) The format of the screen capture to be recorded.
Available formats are the output of `ffmpeg -codecs` such as `libx264` and `mpeg4`. Defaults to `mpeg4`.
Available formats are the output of `ffmpeg -codecs` such as `libx264` and `mpeg4`. Defaults to `mjpeg`.
- name: options.videoQuality
type: string
description: (iOS Only) The video encoding quality (low, medium, high, photo - defaults to medium).
@@ -24,9 +24,6 @@ example_usage:
python:
|
self.driver.stop_recording_screen()
php:
|
// TODO PHP sample
csharp:
|
driver.StopRecordingScreen();
@@ -38,7 +35,6 @@ client_docs:
javascript_wdio: "https://webdriver.io/docs/api/appium.html#stoprecordingscreen"
ruby: "https://www.rubydoc.info/github/appium/ruby_lib_core/Appium/Core/Device#stop_recording_screen-instance_method"
ruby_core: "https://www.rubydoc.info/github/appium/ruby_lib_core/Appium/Core/Device#stop_recording_screen-instance_method"
php: "https://github.com/appium/php-client/" # TODO PHP documentation link
csharp: "https://github.com/appium/appium-dotnet-driver/blob/master/src/Appium.Net/Appium/AppiumDriver.cs"
# Driver support by platform
@@ -58,7 +54,6 @@ client_support:
java: true
python: true
ruby: true
php: false
csharp: false
javascript_wd: true
javascript_wdio: true
@@ -28,9 +28,6 @@ example_usage:
ruby_core:
|
@driver.toggle_touch_id_enrollment
php:
|
// TODO PHP sample
csharp:
|
// TODO C# sample
@@ -42,7 +39,6 @@ client_docs:
javascript_wd: "https://github.com/admc/wd/blob/master/lib/commands.js#L3150"
ruby: "https://www.rubydoc.info/github/appium/ruby_lib_core/Appium/Core/Ios/Device#toggle_touch_id_enrollment-instance_method"
ruby_core: "https://www.rubydoc.info/github/appium/ruby_lib_core/Appium/Core/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
# Driver support by platform
@@ -62,7 +58,6 @@ client_support:
java: true
python: true
ruby: true
php: true
csharp: true
javascript_wd: true
javascript_wdio: true
@@ -40,9 +40,6 @@ example_usage:
|
@driver.touch_id(false) # Simulates a failed touch
@driver.touch_id(true) # Simulates a passing touch
php:
|
// TODO PHP sample
csharp:
|
driver.PerformTouchID(false); // Simulates a failed touch
@@ -55,8 +52,7 @@ client_docs:
javascript_wd: "https://github.com/admc/wd/blob/master/lib/commands.js#L3133"
ruby: "https://www.rubydoc.info/github/appium/ruby_lib_core/Appium/Core/Ios/Device#touch_id-instance_method"
ruby_core: "https://www.rubydoc.info/github/appium/ruby_lib_core/Appium/Core/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/blob/master/src/Appium.Net/Appium/iOS/IOSDriver.cs"
csharp: "https://github.com/appium/appium-dotnet-driver/blob/master/src/Appium.Net/Appium/iOS/IOSDriver.cs"
# Driver support by platform
driver_support:
@@ -75,7 +71,6 @@ client_support:
java: true
python: true
ruby: true
php: true
csharp: true
javascript_wd: true
javascript_wdio: true
@@ -43,7 +43,6 @@ client_support:
java: true
python: true
ruby: true
php: false
csharp: false
javascript_wd: false
javascript_wdio: true
@@ -21,9 +21,6 @@ example_usage:
ruby_core:
|
@driver.open_notifications();
php:
|
$driver->openNotifications();
csharp:
|
// TODO
@@ -35,7 +32,6 @@ client_docs:
javascript_wd: "https://github.com/admc/wd/blob/master/lib/commands.js#L3004"
ruby: "https://www.rubydoc.info/github/appium/ruby_lib_core/Appium/Core/Device#open_notifications-instance_method"
ruby_core: "https://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
# Driver support by platform
@@ -55,7 +51,6 @@ client_support:
java: true
python: true
ruby: true
php: true
csharp: true
javascript_wd: true
javascript_wdio: true
@@ -18,9 +18,6 @@ example_usage:
ruby_core:
|
@driver.get_system_bars
php:
|
// TODO
csharp:
|
// TODO
@@ -31,7 +28,6 @@ client_docs:
javascript_wdio: "https://webdriver.io/docs/api/appium.html#getsystembars"
ruby: "https://www.rubydoc.info/github/appium/ruby_lib_core/Appium/Core/Device#get_system_bars-instance_method"
ruby_core: "https://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
# Driver support by platform
@@ -51,7 +47,6 @@ client_support:
java: true
python: true
ruby: true
php: false
csharp: false
javascript_wd: false
javascript_wdio: true
@@ -24,9 +24,6 @@ example_usage:
ruby_core:
|
@driver.device_time
php:
|
$time = $driver->getDeviceTime();
csharp:
|
string result = driver.DeviceTime;
@@ -38,7 +35,6 @@ client_docs:
javascript_wd: "https://github.com/admc/wd/blob/master/lib/commands.js#L3119"
ruby: "https://www.rubydoc.info/github/appium/ruby_lib_core/Appium/Core/Device#device_time-instance_method"
ruby_core: "https://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
# Driver support by platform
@@ -58,7 +54,6 @@ client_support:
java: true
python: true
ruby: true
php: true
csharp: true
javascript_wd: true
javascript_wdio: true
@@ -22,9 +22,6 @@ example_usage:
ruby_core:
|
@driver.find_element(:accessibility_id, "SomeAccessibilityID").clear
php:
|
// TODO PHP sample
csharp:
|
var element = driver.FindElementByAccessibilityId("SomeAccessibilityID");
@@ -38,7 +35,6 @@ client_docs:
javascript_wd: "https://github.com/admc/wd/blob/master/lib/commands.js#L1780"
ruby: "https://www.rubydoc.info/gems/selenium-webdriver/Selenium/WebDriver/Element:clear"
ruby_core: "https://www.rubydoc.info/gems/selenium-webdriver/Selenium/WebDriver/Element:clear"
php: "https://github.com/appium/php-client/" # TODO PHP documentation link
csharp: "https://github.com/SeleniumHQ/selenium/blob/master/dotnet/src/webdriver/Remote/RemoteWebElement.cs"
# Driver support by platform
@@ -58,7 +54,6 @@ client_support:
java: true
python: true
ruby: true
php: true
csharp: true
javascript_wd: true
javascript_wdio: true
@@ -29,9 +29,6 @@ example_usage:
ruby_core:
|
@driver.find_element(:accessibility_id, 'SomeId').click
php:
|
$driver->byAccessibilityId('SomeId')->click();
csharp:
|
MobileElement el = driver.FindElement(MobileByAccessibilityID("Some ID");
@@ -48,7 +45,6 @@ client_docs:
javascript_wd: "https://github.com/admc/wd/blob/master/lib/commands.js#L1672"
ruby: "https://www.rubydoc.info/gems/selenium-webdriver/Selenium/WebDriver/Element#click-instance_method"
ruby_core: "https://www.rubydoc.info/gems/selenium-webdriver/Selenium/WebDriver/Element#click-instance_method"
php: "https://github.com/appium/php-client/" # TODO
csharp: "https://github.com/appium/appium-dotnet-driver/" # TODO
# Driver support by platform
@@ -68,7 +64,6 @@ client_support:
java: true
python: true
ruby: true
php: true
csharp: true
javascript_wd: true
javascript_wdio: true
@@ -28,10 +28,6 @@ example_usage:
ruby_core:
|
@driver.find_element(:accessibility_id, "SomeAccessibilityID").send_keys("Hello World!")
php:
|
$el = $this->byAccessibilityId('SomeAccessibilityID');
$el->setText('Hello world!');
csharp:
|
MobileElement el = driver.FindElement(MobileByAccessibilityID("Some ID");
@@ -48,7 +44,6 @@ client_docs:
javascript_wd: "https://github.com/admc/wd/blob/master/lib/commands.js#L1700"
ruby: "https://www.rubydoc.info/gems/selenium-webdriver/Selenium/WebDriver/Element#send_keys-instance_method"
ruby_core: "https://www.rubydoc.info/gems/selenium-webdriver/Selenium/WebDriver/Element#send_keys-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
# Driver support by platform
@@ -68,7 +63,6 @@ client_support:
java: true
python: true
ruby: true
php: true
csharp: true
javascript_wd: true
javascript_wdio: true
@@ -23,10 +23,6 @@ example_usage:
ruby_core:
|
@driver.find_element(:accessibility_id, 'SomeAccessibilityID').attribute("content-desc")
php:
|
$el = $this->byAccessibilityId('SomeAccessibilityID');
$name = $el->attribute('name');
csharp:
|
var element = driver.FindElementByAccessibilityId("SomeAccessibilityID");
@@ -40,7 +36,6 @@ client_docs:
javascript_wd: "https://github.com/admc/wd/blob/master/lib/commands.js#L1350"
ruby: "https://www.rubydoc.info/gems/selenium-webdriver/Selenium%2FWebDriver%2FElement:attribute"
ruby_core: "https://www.rubydoc.info/gems/selenium-webdriver/Selenium%2FWebDriver%2FElement:attribute"
php: "https://github.com/appium/php-client/" # TODO PHP documentation link
csharp: "https://github.com/appium/appium-dotnet-driver/blob/master/src/Appium.Net/Appium/AppiumWebElement.cs"
# TODO: Confirm if all the drivers support this
@@ -60,7 +55,6 @@ client_support:
java: true
python: true
ruby: true
php: true
csharp: true
javascript_wd: true
javascript_wdio: true
@@ -29,9 +29,6 @@ example_usage:
ruby_core:
|
@driver.find_element(:id, 'SomeId').css_value
php:
|
// TODO PHP sample
csharp:
|
var element = driver.FindElementById("SomeId");
@@ -44,7 +41,6 @@ client_docs:
javascript_wd: "https://github.com/admc/wd/blob/master/lib/commands.js#L1447"
ruby: "https://www.rubydoc.info/gems/selenium-webdriver/Selenium/WebDriver/Element:css_value"
ruby_core: "https://www.rubydoc.info/gems/selenium-webdriver/Selenium/WebDriver/Element:css_value"
php: "https://github.com/appium/php-client/" # TODO PHP documentation link
csharp: "https://github.com/appium/appium-dotnet-driver/blob/master/src/Appium.Net/Appium/AppiumWebElement.cs"
# TODO: Confirm if all the drivers support this
@@ -64,7 +60,6 @@ client_support:
java: true
python: true
ruby: true
php: true
csharp: true
javascript_wd: true
javascript_wdio: true
@@ -23,10 +23,6 @@ example_usage:
ruby_core:
|
@driver.find_element(:accessibility_id, "SomeAccessibilityID").displayed?
php:
|
$el = $this->byAccessibilityId('SomeAccessibilityID');
$isDisplayed = $el->displayed();
csharp:
|
var element = driver.FindElementByAccessibilityId("SomeAccessibilityID");
@@ -39,7 +35,6 @@ client_docs:
javascript_wd: "https://github.com/admc/wd/blob/master/lib/commands.js#L1370"
ruby: "https://www.rubydoc.info/gems/selenium-webdriver/Selenium%2FWebDriver%2FElement:displayed%3F"
ruby_core: "https://www.rubydoc.info/gems/selenium-webdriver/Selenium%2FWebDriver%2FElement:displayed%3F"
php: "https://github.com/appium/php-client/" # TODO PHP documentation link
csharp: "https://github.com/appium/appium-dotnet-driver/blob/master/src/Appium.Net/Appium/AppiumWebElement.cs"
# TODO: Confirm support for these per platform
@@ -59,7 +54,6 @@ client_support:
java: true
python: true
ruby: true
php: true
csharp: true
javascript_wd: true
javascript_wdio: true
@@ -22,9 +22,6 @@ example_usage:
ruby_core:
|
@driver.find_element(:accessibility_id, "SomeAccessibilityID").enabled?
php:
|
// TODO PHP sample
csharp:
|
var element = driver.FindElementByAccessibilityId("SomeAccessibilityID");
@@ -37,7 +34,6 @@ client_docs:
javascript_wd: "https://github.com/admc/wd/blob/master/lib/commands.js#L1386"
ruby: "https://www.rubydoc.info/gems/selenium-webdriver/Selenium/WebDriver/Element#enabled%3F-instance_method"
ruby_core: "https://www.rubydoc.info/gems/selenium-webdriver/Selenium/WebDriver/Element#enabled%3F-instance_method"
php: "https://github.com/appium/php-client/" # TODO PHP documentation link
csharp: "https://github.com/appium/appium-dotnet-driver/blob/master/src/Appium.Net/Appium/AppiumWebElement.cs"
# TODO: Confirm support for these per platform
@@ -57,7 +53,6 @@ client_support:
java: true
python: true
ruby: true
php: true
csharp: true
javascript_wd: true
javascript_wdio: true
@@ -37,7 +37,6 @@ client_support:
java: true
python: true
ruby: true
php: true
csharp: true
javascript_wd: true
javascript_wdio: true
@@ -25,10 +25,6 @@ example_usage:
ruby_core:
|
@driver.find_element(:accessibility_id, 'SomeAccessibilityID').location
php:
|
$el = $this->byAccessibilityId('SomeAccessibilityID');
$location = $el->location();
csharp:
|
var element = driver.FindElementByAccessibilityId("SomeAccessibilityID");
@@ -41,7 +37,6 @@ client_docs:
javascript_wd: "https://github.com/admc/wd/blob/master/lib/commands.js#L2175"
ruby: "https://www.rubydoc.info/gems/selenium-webdriver/Selenium/WebDriver/Element:location"
ruby_core: "https://www.rubydoc.info/gems/selenium-webdriver/Selenium/WebDriver/Element:location"
php: "https://github.com/appium/php-client/" # TODO PHP documentation link
csharp: "https://github.com/appium/appium-dotnet-driver/blob/master/src/Appium.Net/Appium/AppiumWebElement.cs"
# TODO: Confirm if all the drivers support this
@@ -61,7 +56,6 @@ client_support:
java: true
python: true
ruby: true
php: true
csharp: true
javascript_wd: true
javascript_wdio: true
@@ -23,9 +23,6 @@ example_usage:
ruby_core:
|
@driver.find_element(:accessibility_id, 'SomeAccessibilityID').tag_name
php:
|
// TODO PHP sample
csharp:
|
var element = driver.FindElementByAccessibilityId("SomeAccessibilityID");
@@ -38,7 +35,6 @@ client_docs:
javascript_wd: "https://github.com/admc/wd/blob/master/lib/commands.js#L1336"
ruby: "https://www.rubydoc.info/gems/selenium-webdriver/Selenium/WebDriver/Element#tag_name-instance_method"
ruby_core: "https://www.rubydoc.info/gems/selenium-webdriver/Selenium/WebDriver/Element#tag_name-instance_method"
php: "https://github.com/appium/php-client/" # TODO PHP documentation link
csharp: "https://github.com/appium/appium-dotnet-driver/blob/master/src/Appium.Net/Appium/AppiumWebElement.cs"
# TODO: Confirm if all the drivers support this
@@ -58,7 +54,6 @@ client_support:
java: true
python: true
ruby: true
php: true
csharp: true
javascript_wd: true
javascript_wdio: true
@@ -18,9 +18,6 @@ example_usage:
ruby:
|
// TODO Ruby sample
php:
|
// TODO PHP sample
csharp:
|
// TODO C# sample
@@ -31,7 +28,6 @@ client_docs:
javascript_wdio: "https://webdriver.io/docs/api/mjsonwp.html#getpageindex"
javascript_wd: "https://github.com/admc/wd/blob/master/lib/commands.js#L1336"
ruby: "https://www.rubydoc.info/gems/selenium-webdriver/Selenium/WebDriver/Element#tag_name-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
# TODO: Confirm if all the drivers support this
@@ -51,7 +47,6 @@ client_support:
java: true
python: true
ruby: true
php: true
csharp: true
javascript_wd: true
javascript_wdio: true
@@ -27,9 +27,6 @@ example_usage:
|
element = @driver.find_element :accessibility_id, "SomeAccessibilityID"
element.rect
php:
|
// TODO PHP sample
csharp:
|
var element = driver.FindElementByAccessibilityId("SomeAccessibilityID");
@@ -40,7 +37,6 @@ client_docs:
javascript_wdio: "https://webdriver.io/docs/api/webdriver.html#getelementrect"
ruby: "https://www.rubydoc.info/gems/selenium-webdriver/Selenium/WebDriver/Element#rect-instance_method"
ruby_core: "https://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/blob/master/src/Appium.Net/Appium/AppiumWebElement.cs"
# TODO: Confirm if all the drivers support this
@@ -60,7 +56,6 @@ client_support:
java: true
python: true
ruby: true
php: true
csharp: true
javascript_wd: true
javascript_wdio: true
@@ -27,9 +27,6 @@ example_usage:
|
element = @driver.find_element :accessibility_id, "SomeAccessibilityID"
@driver.replace_value element, 'some'
php:
|
// TODO PHP sample
csharp:
|
// TODO C# sample
@@ -41,7 +38,6 @@ client_docs:
javascript_wd: "https://github.com/admc/wd/blob/master/lib/commands.js#L1832" # TODO JAvaScript documentation link
ruby: "https://www.rubydoc.info/github/appium/ruby_lib_core/Appium/Core/Device#replace_value-instance_method"
ruby_core: "https://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
# Driver support by platform
@@ -61,7 +57,6 @@ client_support:
java: true
python: true
ruby: true
php: true
csharp: true
javascript_wd: true
javascript_wdio: true
@@ -22,9 +22,6 @@ example_usage:
ruby_core:
|
@driver.find_element(:accessibility_id, "SomeAccessibilityID").selected?
php:
|
// TODO PHP sample
csharp:
|
var element = driver.FindElementByAccessibilityId("SomeAccessibilityID");
@@ -37,7 +34,6 @@ client_docs:
javascript_wd: "https://github.com/admc/wd/blob/master/lib/commands.js#L1402"
ruby: "https://www.rubydoc.info/gems/selenium-webdriver/Selenium/WebDriver/Element#selected%3F-instance_method"
ruby_core: "https://www.rubydoc.info/gems/selenium-webdriver/Selenium/WebDriver/Element#selected%3F-instance_method"
php: "https://github.com/appium/php-client/" # TODO PHP documentation link
csharp: "https://github.com/appium/appium-dotnet-driver/blob/master/src/Appium.Net/Appium/AppiumWebElement.cs"
# TODO: Confirm support for these per platform
@@ -57,7 +53,6 @@ client_support:
java: true
python: true
ruby: true
php: true
csharp: true
javascript_wd: true
javascript_wdio: true
@@ -25,10 +25,6 @@ example_usage:
ruby_core:
|
@driver.find_element(:accessibility_id, 'SomeAccessibilityID').size
php:
|
$el = $this->byAccessibilityId('SomeAccessibilityID');
$size = $el->size();
csharp:
|
var element = driver.FindElementByAccessibilityId("SomeAccessibilityID");
@@ -41,7 +37,6 @@ client_docs:
javascript_wd: "https://github.com/admc/wd/blob/master/lib/commands.js#L2203"
ruby: "https://www.rubydoc.info/gems/selenium-webdriver/Selenium/WebDriver/Element:size"
ruby_core: "https://www.rubydoc.info/gems/selenium-webdriver/Selenium/WebDriver/Element:size"
php: "https://github.com/appium/php-client/" # TODO PHP documentation link
csharp: "https://github.com/appium/appium-dotnet-driver/blob/master/src/Appium.Net/Appium/AppiumWebElement.cs"
# TODO: Confirm if all the drivers support this
@@ -61,7 +56,6 @@ client_support:
java: true
python: true
ruby: true
php: true
csharp: true
javascript_wd: true
javascript_wdio: true
@@ -29,10 +29,6 @@ example_usage:
|
element = @driver.find_element :accessibility_id, "SomeAccessibilityID"
element.text
php:
|
$el = $this->byAccessibilityId('SomeAccessibilityID');
$text = $el->text();
csharp:
|
var element = driver.FindElementByClassName("SomeClassName");
@@ -45,7 +41,6 @@ client_docs:
javascript_wd: "https://github.com/admc/wd/blob/master/lib/commands.js#L1832"
ruby: "https://www.rubydoc.info/gems/selenium-webdriver/Selenium/WebDriver/Element#text-instance_method"
ruby_core: "https://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/blob/master/src/Appium.Net/Appium/AppiumWebElement.cs"
# Driver support by platform
@@ -65,7 +60,6 @@ client_support:
java: true
python: true
ruby: true
php: true
csharp: true
javascript_wd: true
javascript_wdio: true
@@ -26,9 +26,6 @@ example_usage:
ruby_core:
|
@driver.find_element(:accessibility_id, 'SomeAccessibilityID')
php:
|
$el = $this->byAccessibilityId('SomeAccessibilityID');
csharp:
|
AndroidElement elementOne = driver.FindElementByAccessibilityID("Some ID");
@@ -41,7 +38,6 @@ client_docs:
javascript_wd: "https://github.com/admc/wd/blob/master/lib/commands.js#L745"
ruby: "https://www.rubydoc.info/gems/selenium-webdriver/Selenium/WebDriver/SearchContext:find_element"
ruby_core: "https://www.rubydoc.info/gems/selenium-webdriver/Selenium/WebDriver/SearchContext:find_element"
php: "https://github.com/appium/php-client/" # TODO PHP documentation link
csharp: "https://github.com/appium/appium-dotnet-driver/" # TODO Dotnet documentation link
# Driver support by platform
@@ -61,7 +57,6 @@ client_support:
java: true
python: true
ruby: true
php: true
csharp: true
javascript_wd: true
javascript_wdio: true
@@ -47,9 +47,6 @@ example_usage:
ruby_core:
|
@driver.find_elements(:accessibility_id, "~SomeAccessibilityID")
php:
|
$els = $this->elements($this->using('accessibility id')->value('SomeAccessibilityID'));
csharp:
|
IEnumerable<AppiumWebElement> elementsOne = driver.FindElementsByAccessibilityId("SomeAccessibilityID");
@@ -62,7 +59,6 @@ client_docs:
javascript_wd: "https://github.com/admc/wd/blob/master/lib/commands.js#L798"
ruby: "https://www.rubydoc.info/gems/selenium-webdriver/Selenium/WebDriver/SearchContext:find_elements"
ruby_core: "https://www.rubydoc.info/gems/selenium-webdriver/Selenium/WebDriver/SearchContext:find_elements"
php: "https://github.com/appium/php-client/" # TODO PHP documentation link
csharp: "https://github.com/appium/appium-dotnet-driver/blob/master/src/Appium.Net/Appium/AppiumWebElement.cs"
# Driver support by platform
@@ -82,7 +78,6 @@ client_support:
java: true
python: true
ruby: true
php: true
csharp: true
javascript_wd: true
javascript_wdio: true
@@ -21,9 +21,6 @@ example_usage:
ruby_core:
|
@driver.switch_to.active_element
php:
|
// TODO PHP example
csharp:
|
IWebElement currentElement = driver.SwitchTo().ActiveElement();
@@ -36,7 +33,6 @@ client_docs:
javascript_wd: "https://github.com/admc/wd/blob/master/lib/commands.js#L1934"
ruby: "https://www.rubydoc.info/gems/selenium-webdriver/0.0.28/Selenium/WebDriver/TargetLocator#active_element-instance_method"
ruby_core: "https://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/SeleniumHQ/selenium/blob/master/dotnet/src/webdriver/Remote/RemoteTargetLocator.cs"
# Driver support by platform
@@ -56,7 +52,6 @@ client_support:
java: true
python: true
ruby: true
php: true
csharp: true
javascript_wd: true
javascript_wdio: true
@@ -65,7 +60,7 @@ client_support:
# Information about the HTTP endpoints
endpoint:
url: /session/:session_id/element/active
method: 'POST'
method: "'GET'(W3C), 'POST'(JSONWP)"
response:
- name: ELEMENT
type: object
@@ -33,9 +33,6 @@ example_usage:
element1 = @driver.find_element :class_name, "someClass"
element2 = @driver.find_element :class_name, "someOtherClass"
element1 == element2
php:
|
// TODO PHP sample
csharp:
|
var elementOne = driver.FindElementByClassName("SomeClassName");
@@ -49,7 +46,6 @@ client_docs:
javascript_wd: "https://github.com/admc/wd/blob/master/lib/commands.js#L1463"
ruby: "https://www.rubydoc.info/gems/selenium-webdriver/0.0.28/Selenium/WebDriver/Element#==-instance_method"
ruby_core: "https://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/SeleniumHQ/selenium/blob/master/dotnet/src/webdriver/Remote/RemoteWebElement.cs"
# TODO: Confirm support for these per platform
@@ -69,7 +65,6 @@ client_support:
java: true
python: true
ruby: true
php: true
csharp: true
javascript_wd: true
javascript_wdio: true
@@ -30,9 +30,6 @@ example_usage:
|
element = @driver.find_element :class_name, "someClass"
element.submit element
php:
|
// TODO PHP sample
csharp:
|
var element = driver.FindElementByClassName("SomeClassName");
@@ -45,7 +42,6 @@ client_docs:
javascript_wd: "https://github.com/admc/wd/blob/master/lib/commands.js#L1741"
ruby: "https://www.rubydoc.info/gems/selenium-webdriver/0.0.28/Selenium/WebDriver/Element#submit-instance_method"
ruby_core: "https://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/SeleniumHQ/selenium/blob/master/dotnet/src/webdriver/Remote/RemoteWebElement.cs"
# Driver support by platform
@@ -65,7 +61,6 @@ client_support:
java: true
python: true
ruby: true
php: true
csharp: true
javascript_wd: true
javascript_wdio: true
-5
View File
@@ -26,9 +26,6 @@ example_usage:
ruby_core:
|
# Ruby Code in ruby_lib_core here
php:
|
// PHP Code here
csharp:
|
driver.FindElementById("elementId").Click();
@@ -41,7 +38,6 @@ client_docs:
javascript_wd: "https://github.com/admc/wd/releases"
ruby: "https://github.com/appium/ruby_lib/releases/latest"
ruby_core: "https://github.com/appium/ruby_lib/releases/latest"
php: "https://github.com/appium/php-client/releases/latest"
csharp: "https://github.com/appium/appium" # TODO
# Driver support by platform
@@ -70,7 +66,6 @@ client_support:
python:
min: 2
ruby: true # If true, means it supports all
php: false # If false(y), means it is not supported
# Information about the HTTP endpoints
@@ -138,9 +138,6 @@ example_usage:
f2.create_pointer_up(:left)
@driver.perform_actions [f1, f2]
php:
|
// TODO
csharp:
|
var inputDevice = new PointerInputDevice(PointerKind.Touch);
@@ -160,7 +157,6 @@ client_docs:
#javascript_wd: "https://github.com/admc/wd/blob/master/lib/commands.js#L44"
ruby: "https://www.rubydoc.info/gems/selenium-webdriver/Selenium/WebDriver/W3CActionBuilder"
ruby_core: "https://www.rubydoc.info/gems/selenium-webdriver/Selenium/WebDriver/W3CActionBuilder"
php: "https://github.com/jupeter/selenium-php-webdriver/blob/master/Webdriver/Common/ActionChains.php"
csharp: "https://github.com/appium/appium-dotnet-driver/" # TODO
# Driver support by platform
@@ -180,7 +176,6 @@ client_support:
java: true
python: true
ruby: true
php: true
csharp: true
javascript_wd: true
javascript_wdio: true
@@ -34,9 +34,6 @@ example_usage:
ruby_core:
|
@driver.action.move_to(element).click_and_hold.perform
php:
|
// TODO PHP sample
csharp:
|
Actions action = new Actions(driver);
@@ -51,7 +48,6 @@ client_docs:
javascript_wd: "https://github.com/admc/wd/blob/master/lib/commands.js#L1625"
ruby: "https://www.rubydoc.info/gems/selenium-webdriver/Selenium/WebDriver/ActionBuilder:click_and_hold"
ruby_core: "https://www.rubydoc.info/gems/selenium-webdriver/Selenium/WebDriver/ActionBuilder:click_and_hold"
php: "https://github.com/appium/php-client/" # TODO PHP documentation link
csharp: "https://github.com/SeleniumHQ/selenium/blob/master/dotnet/src/webdriver/Interactions/Actions.cs"
# Driver support by platform
@@ -71,7 +67,6 @@ client_support:
java: true
python: true
ruby: true
php: true
csharp: true
javascript_wd: true
javascript_wdio: true
@@ -42,9 +42,6 @@ example_usage:
ruby_core:
|
@driver.action.click_and_hold(el).move_to(el, 10, 10).release.perform
php:
|
// TODO PHP sample
csharp:
|
Actions action = new Actions(driver);
@@ -61,7 +58,6 @@ client_docs:
javascript_wd: "https://github.com/admc/wd/blob/master/lib/commands.js#L1645"
ruby: "https://www.rubydoc.info/gems/selenium-webdriver/Selenium/WebDriver/ActionBuilder:release"
ruby_core: "https://www.rubydoc.info/gems/selenium-webdriver/Selenium/WebDriver/ActionBuilder:release"
php: "https://github.com/appium/php-client/" # TODO PHP documentation link
csharp: "https://github.com/SeleniumHQ/selenium/blob/master/dotnet/src/webdriver/Interactions/Actions.cs"
# Driver support by platform
@@ -81,7 +77,6 @@ client_support:
java: true
python: true
ruby: true
php: true
csharp: true
javascript_wd: true
javascript_wdio: true
@@ -29,9 +29,6 @@ example_usage:
ruby_core:
|
@driver.action.move_to(element).click.perform
php:
|
// TODO PHP sample
csharp:
|
Actions action = new Actions(driver);
@@ -39,8 +36,6 @@ example_usage:
action.Click();
action.Perform();
client_docs:
java: "https://seleniumhq.github.io/selenium/docs/api/java/org/openqa/selenium/interactions/Actions.html#click--"
python: "http://selenium-python.readthedocs.io/api.html#selenium.webdriver.common.action_chains.ActionChains.click"
@@ -48,7 +43,6 @@ client_docs:
javascript_wd: "https://github.com/admc/wd/blob/master/lib/commands.js#L1665"
ruby: "https://www.rubydoc.info/gems/selenium-webdriver/Selenium/WebDriver/Mouse:click"
ruby_core: "https://www.rubydoc.info/gems/selenium-webdriver/Selenium/WebDriver/Mouse:click"
php: "https://github.com/appium/php-client/" # TODO PHP documentation link
csharp: "https://github.com/appium/appium-dotnet-driver/" # TODO Dotnet documentation link
# Driver support by platform
@@ -68,7 +62,6 @@ client_support:
java: true
python: true
ruby: true
php: true
csharp: true
javascript_wd: true
javascript_wdio: true
@@ -29,9 +29,6 @@ example_usage:
ruby_core:
|
@driver.action.move_to(element).double_click.perform
php:
|
// TODO PHP sample
csharp:
|
Actions action = new Actions(driver);
@@ -46,7 +43,6 @@ client_docs:
javascript_wd: "https://github.com/admc/wd/blob/master/lib/commands.js#L1686"
ruby: "https://www.rubydoc.info/gems/selenium-webdriver/Selenium/WebDriver/ActionBuilder:double_click"
ruby_core: "https://www.rubydoc.info/gems/selenium-webdriver/Selenium/WebDriver/ActionBuilder:double_click"
php: "https://github.com/appium/php-client/" # TODO PHP documentation link
csharp: "https://github.com/SeleniumHQ/selenium/blob/master/dotnet/src/webdriver/Interactions/Actions.cs"
# Driver support by platform
@@ -66,7 +62,6 @@ client_support:
java: true
python: true
ruby: true
php: true
csharp: true
javascript_wd: true
javascript_wdio: true
@@ -32,9 +32,6 @@ example_usage:
|
@driver.mouse.move_to(element)
@driver.mouse.move_to(element, 5, 5)
php:
|
// TODO PHP sample
csharp:
|
Actions action = new Actions(driver);
@@ -50,7 +47,6 @@ client_docs:
javascript_wd: "https://github.com/admc/wd/blob/master/lib/commands.js#L1600"
ruby: "https://www.rubydoc.info/gems/selenium-webdriver/Selenium/WebDriver/Mouse:move_to"
ruby_core: "https://www.rubydoc.info/gems/selenium-webdriver/Selenium/WebDriver/Mouse:move_to"
php: "https://github.com/appium/php-client/" # TODO PHP documentation link
csharp: "https://github.com/appium/appium-dotnet-driver/" # TODO Dotnet documentation link
# Driver support by platform
@@ -70,7 +66,6 @@ client_support:
java: true
python: true
ruby: true
php: true
csharp: true
javascript_wd: true
javascript_wdio: true
@@ -32,9 +32,6 @@ example_usage:
ruby_core:
|
@driver.touch_action.double_tap(element).perform
php:
|
// TODO PHP sample
csharp:
|
TouchActions action = new TouchActions(driver);
@@ -42,13 +39,12 @@ example_usage:
action.Perform();
client_docs:
java: "https://seleniumhq.github.io/selenium/docs/api/java/org/openqa/selenium/interactions/touch/TouchActions.html#doubleTap-org.openqa.selenium.WebElement-"
python: "https://seleniumhq.github.io/selenium/docs/api/py/webdriver/selenium.webdriver.common.touch_actions.html#selenium.webdriver.common.touch_actions.TouchActions.double_tap"
java: "https://www.selenium.dev/selenium/docs/api/java/overview-summary.html"
python: "https://selenium-python.readthedocs.io/api.html?highlight=tap_and_hold#selenium.webdriver.common.touch_actions.TouchActions.double_tap"
javascript_wd: "https://github.com/admc/wd/blob/master/lib/commands.js#L425"
javascript_wdio: "https://webdriver.io/docs/api/jsonwp.html#touchdoubleclick"
ruby: "https://www.rubydoc.info/gems/selenium-webdriver/Selenium%2FWebDriver%2FTouchActionBuilder:double_tap"
ruby_core: "https://www.rubydoc.info/gems/selenium-webdriver/Selenium%2FWebDriver%2FTouchActionBuilder:double_tap"
php: "https://github.com/appium/php-client/" # TODO PHP documentation link
csharp: "https://github.com/SeleniumHQ/selenium/blob/master/dotnet/src/webdriver/Interactions/TouchActions.cs"
# Driver support by platform
@@ -68,7 +64,6 @@ client_support:
java: true
python: true
ruby: true
php: true
csharp: true
javascript_wd: true
javascript_wdio: true
@@ -27,9 +27,6 @@ example_usage:
ruby_core:
|
@driver.touch_action.flick(element, 1, 10, 10).perform
php:
|
// TODO PHP sample
csharp:
|
TouchActions action = new TouchActions(driver);
@@ -38,12 +35,11 @@ example_usage:
client_docs:
java: "https://seleniumhq.github.io/selenium/docs/api/java/org/openqa/selenium/interactions/touch/TouchActions.html#flick-org.openqa.selenium.WebElement-int-int-int-"
python: "https://seleniumhq.github.io/selenium/docs/api/py/webdriver/selenium.webdriver.common.touch_actions.html#selenium.webdriver.common.touch_actions.TouchActions.flick_element"
python: "https://selenium-python.readthedocs.io/api.html#selenium.webdriver.common.touch_actions.TouchActions.flick_element"
javascript_wdio: "https://webdriver.io/docs/api/jsonwp.html#touchflick"
javascript_wd: "https://github.com/admc/wd/blob/master/lib/commands.js#L1513"
ruby: "https://www.rubydoc.info/gems/selenium-webdriver/Selenium%2FWebDriver%2FTouchActionBuilder:flick"
ruby_core: "https://www.rubydoc.info/gems/selenium-webdriver/Selenium%2FWebDriver%2FTouchActionBuilder:flick"
php: "https://github.com/appium/php-client/" # TODO PHP documentation link
csharp: "https://github.com/SeleniumHQ/selenium/blob/master/dotnet/src/webdriver/Interactions/TouchActions.cs"
# Driver support by platform
@@ -63,7 +59,6 @@ client_support:
java: true
python: true
ruby: true
php: true
csharp: true
javascript_wd: true
javascript_wdio: true
@@ -35,9 +35,6 @@ example_usage:
ruby_core:
|
@driver.touch_action.long_press(element).perform
php:
|
// TODO PHP sample
csharp:
|
var touchAction = new TouchAction(Driver);
@@ -45,12 +42,11 @@ example_usage:
client_docs:
java: "https://seleniumhq.github.io/selenium/docs/api/java/org/openqa/selenium/interactions/touch/TouchActions.html#longPress-org.openqa.selenium.WebElement-"
python: "https://seleniumhq.github.io/selenium/docs/api/py/webdriver/selenium.webdriver.common.touch_actions.html#selenium.webdriver.common.touch_actions.TouchActions.long_press"
python: "https://selenium-python.readthedocs.io/api.html#selenium.webdriver.common.touch_actions.TouchActions.long_press"
javascript_wdio: "https://webdriver.io/docs/api/mjsonwp.html#touchperform"
javascript_wd: "https://github.com/admc/wd/blob/master/lib/commands.js#L1531"
ruby: "https://www.rubydoc.info/gems/selenium-webdriver/Selenium%2FWebDriver%2FTouchActionBuilder:long_press"
ruby_core: "https://www.rubydoc.info/gems/selenium-webdriver/Selenium%2FWebDriver%2FTouchActionBuilder:long_press"
php: "https://github.com/appium/php-client/" # TODO PHP documentation link
csharp: "https://github.com/appium/appium-dotnet-driver/" # TODO Dotnet documentation link
# Driver support by platform
@@ -70,7 +66,6 @@ client_support:
java: true
python: true
ruby: true
php: true
csharp: true
javascript_wd: true
javascript_wdio: true
@@ -40,9 +40,6 @@ example_usage:
ruby_core:
|
@driver.touch_action.down(element).move_to().perform
php:
|
// TODO PHP sample
csharp:
|
TouchActions action = new TouchActions(driver);
@@ -52,12 +49,11 @@ example_usage:
client_docs:
java: "https://seleniumhq.github.io/selenium/docs/api/java/org/openqa/selenium/interactions/touch/TouchActions.html#down-int-int-"
python: "https://seleniumhq.github.io/selenium/docs/api/py/webdriver/selenium.webdriver.common.touch_actions.html#selenium.webdriver.common.touch_actions.TouchActions.move"
python: "https://selenium-python.readthedocs.io/api.html#module-selenium.webdriver.common.touch_actions"
javascript_wdio: "https://webdriver.io/docs/api/mjsonwp.html#multitouchperform"
javascript_wd: "https://github.com/admc/wd/blob/master/lib/commands.js#L1531"
ruby: "https://www.rubydoc.info/gems/selenium-webdriver/Selenium%2FWebDriver%2FTouchActionBuilder:move"
ruby_core: "https://www.rubydoc.info/gems/selenium-webdriver/Selenium%2FWebDriver%2FTouchActionBuilder:move"
php: "https://github.com/appium/php-client/" # TODO PHP documentation link
csharp: "https://github.com/SeleniumHQ/selenium/blob/master/dotnet/src/webdriver/Interactions/TouchActions.cs"
# Driver support by platform
@@ -77,7 +73,6 @@ client_support:
java: true
python: true
ruby: true
php: true
csharp: true
javascript_wd: true
javascript_wdio: true
@@ -55,9 +55,6 @@ example_usage:
ruby_core:
|
@driver.multi_touch.down(element).move_to(10, 100).up(50, 50).perform
php:
|
// TODO PHP sample
csharp:
|
// TODO C# sample
@@ -69,7 +66,6 @@ client_docs:
javascript_wd: "https://github.com/admc/wd/blob/master/lib/commands.js#L1546"
ruby: "https://www.rubydoc.info/github/appium/ruby_lib/Appium/MultiTouch"
ruby_core: "https://www.rubydoc.info/github/appium/ruby_lib/Appium/MultiTouch"
php: "https://github.com/appium/php-client/" # TODO PHP documentation link
csharp: "https://github.com/appium/appium-dotnet-driver/" # TODO Dotnet documentation link
# Driver support by platform
@@ -89,7 +85,6 @@ client_support:
java: true
python: true
ruby: true
php: true
csharp: true
javascript_wd: true
javascript_wdio: true
@@ -28,9 +28,6 @@ example_usage:
ruby_core:
|
@driver.touch_actions.scroll(element, 10, 100).perform
php:
|
// TODO PHP sample
csharp:
|
TouchActions action = new TouchActions(driver);
@@ -39,12 +36,11 @@ example_usage:
client_docs:
java: "https://seleniumhq.github.io/selenium/docs/api/java/org/openqa/selenium/interactions/touch/TouchActions.html#scroll-int-int-"
python: "https://seleniumhq.github.io/selenium/docs/api/py/webdriver/selenium.webdriver.common.touch_actions.html#selenium.webdriver.common.touch_actions.TouchActions.scroll"
python: "https://selenium-python.readthedocs.io/api.html#selenium.webdriver.common.touch_actions.TouchActions.scroll"
javascript_wdio: "https://webdriver.io/docs/api/jsonwp.html#touchscroll"
javascript_wd: "https://github.com/admc/wd/blob/master/lib/commands.js#L425"
ruby: "https://www.rubydoc.info/gems/selenium-webdriver/Selenium%2FWebDriver%2FTouchActionBuilder:scroll"
ruby_core: "https://www.rubydoc.info/gems/selenium-webdriver/Selenium%2FWebDriver%2FTouchActionBuilder:scroll"
php: "https://github.com/appium/php-client/" # TODO PHP documentation link
csharp: "https://github.com/SeleniumHQ/selenium/blob/master/dotnet/src/webdriver/Interactions/TouchActions.cs"
# Driver support by platform
@@ -64,7 +60,6 @@ client_support:
java: true
python: true
ruby: true
php: true
csharp: true
javascript_wd: true
javascript_wdio: true
@@ -37,9 +37,6 @@ example_usage:
ruby_core:
|
@driver.touch_action.single_tap(element).perform
php:
|
// TODO PHP sample
csharp:
|
TouchAction touchAction = new TouchAction(driver);
@@ -52,7 +49,6 @@ client_docs:
javascript_wd: "https://github.com/admc/wd/blob/master/lib/commands.js#L1531"
ruby: "https://www.rubydoc.info/gems/selenium-webdriver/Selenium%2FWebDriver%2FTouchActionBuilder:single_tap"
ruby_core: "https://www.rubydoc.info/gems/selenium-webdriver/Selenium%2FWebDriver%2FTouchActionBuilder:single_tap"
php: "https://github.com/appium/php-client/" # TODO PHP documentation link
csharp: "https://github.com/appium/appium-dotnet-driver/" # TODO Dotnet documentation link
# Driver support by platform
@@ -72,7 +68,6 @@ client_support:
java: true
python: true
ruby: true
php: true
csharp: true
javascript_wd: true
javascript_wdio: true
@@ -36,9 +36,6 @@ example_usage:
ruby_core:
|
@driver.touch_action.down(element).move().perform
php:
|
// TODO PHP sample
csharp:
|
TouchActions action = new TouchActions(driver);
@@ -48,12 +45,11 @@ example_usage:
client_docs:
java: "https://seleniumhq.github.io/selenium/docs/api/java/org/openqa/selenium/interactions/touch/TouchActions.html#down-int-int-"
python: "https://seleniumhq.github.io/selenium/docs/api/py/webdriver/selenium.webdriver.common.touch_actions.html#selenium.webdriver.common.touch_actions.TouchActions.tap_and_hold"
python: "https://selenium-python.readthedocs.io/api.html?highlight=tap_and_hold#selenium.webdriver.common.touch_actions.TouchActions.tap_and_hold"
javascript_wdio: "https://webdriver.io/docs/api/jsonwp.html#touchdown"
javascript_wd: "https://github.com/admc/wd/blob/master/lib/commands.js#L1546"
ruby: "https://www.rubydoc.info/gems/selenium-webdriver/Selenium/WebDriver/TouchActionBuilder#down-instance_method"
ruby_core: "https://www.rubydoc.info/gems/selenium-webdriver/Selenium/WebDriver/TouchActionBuilder#down-instance_method"
php: "https://github.com/appium/php-client/" # TODO PHP documentation link
csharp: "https://github.com/SeleniumHQ/selenium/blob/master/dotnet/src/webdriver/Interactions/TouchActions.cs"
# Driver support by platform
@@ -73,7 +69,6 @@ client_support:
java: true
python: true
ruby: true
php: true
csharp: true
javascript_wd: true
javascript_wdio: true
@@ -48,9 +48,6 @@ example_usage:
ruby_core:
|
@driver.touch_action.down(element).move_to(10, 100).up(50, 50).perform
php:
|
// TODO PHP sample
csharp:
|
TouchAction action = new TouchAction(driver);
@@ -66,7 +63,6 @@ client_docs:
javascript_wd: "https://github.com/admc/wd/blob/master/lib/commands.js#L1546"
ruby: "https://www.rubydoc.info/github/appium/ruby_lib/Appium/TouchAction"
ruby_core: "https://www.rubydoc.info/github/appium/ruby_lib/Appium/TouchAction"
php: "https://github.com/appium/php-client/" # TODO PHP documentation link
csharp: "https://github.com/appium/appium-dotnet-driver/blob/master/src/Appium.Net/Appium/MultiAction/TouchAction.cs"
# Driver support by platform
@@ -86,7 +82,6 @@ client_support:
java: true
python: true
ruby: true
php: true
csharp: true
javascript_wd: true
javascript_wdio: true
@@ -36,9 +36,6 @@ example_usage:
ruby_core:
|
@driver.touch_action.down(element).up(50, 50).perform
php:
|
// TODO PHP sample
csharp:
|
TouchActions action = new TouchActions(driver);
@@ -48,12 +45,11 @@ example_usage:
client_docs:
java: "https://seleniumhq.github.io/selenium/docs/api/java/org/openqa/selenium/interactions/touch/TouchActions.html#up-int-int-"
python: "https://seleniumhq.github.io/selenium/docs/api/py/webdriver/selenium.webdriver.common.touch_actions.html#selenium.webdriver.common.touch_actions.TouchActions.release"
python: "https://selenium-python.readthedocs.io/api.html#selenium.webdriver.common.touch_actions.TouchActions.release"
javascript_wdio: "https://webdriver.io/docs/api/jsonwp.html#touchup"
javascript_wd: "https://github.com/admc/wd/blob/master/lib/commands.js#L1546"
ruby: "https://www.rubydoc.info/gems/selenium-webdriver/Selenium%2FWebDriver%2FTouchActionBuilder:up"
ruby_core: "https://www.rubydoc.info/gems/selenium-webdriver/Selenium%2FWebDriver%2FTouchActionBuilder:up"
php: "https://github.com/appium/php-client/" # TODO PHP documentation link
csharp: "https://github.com/SeleniumHQ/selenium/blob/master/dotnet/src/webdriver/Interactions/TouchActions.cs"
# Driver support by platform
@@ -73,7 +69,6 @@ client_support:
java: true
python: true
ruby: true
php: true
csharp: true
javascript_wd: true
javascript_wdio: true
+8 -119
View File
@@ -10,125 +10,19 @@
(see [Execute Script](/docs/en/commands/web/execute.md) for more details
on syntax).
List of available commands:
## Android
### UiAutomator2
### IOS
| Command | Description | Argument | Argument Example |
| ------- | ----------- | -------- | ---------------- |
| mobile:viewportScreenshot | Like [screenshot](/docs/en/commands/session/screenshot.md) but only includes contents of viewport | <none> | <none> |
Please refer to [mobile commands](https://github.com/appium/appium-uiautomator2-driver#platform-specific-extensions) section in UiAutomator2 driver repository.
### IOS (XCUITest Only)
| Command | Description | Argument | Argument Example |
| ------- | ----------- | -------- | ---------------- |
| mobile:startPerfRecord | Starts performance profiling for the device under test | <none> | |
| mobile:stopPerfRecord | Stops performance profiling for the device under test | <none> | |
| mobile:startLogsBroadcast | Starts iOS system logs broadcast websocket on the same host and port where Appium server is running at `/ws/session/:sessionId:/appium/device/syslog` endpoint. | <none> | |
| mobile:stopLogsBroadcast | Stops the iOS system logs broadcasting websocket server started by `mobile:startLogsBroadcast` | <none> | |
| mobile:swipe | refer to [Automating Mobile Gestures For iOS With WebDriverAgent/XCTest Backend](/docs/en/writing-running-appium/ios/ios-xctest-mobile-gestures.md#mobile-swipe) | | |
| mobile:scroll | refer to [Automating Mobile Gestures For iOS With WebDriverAgent/XCTest Backend](/docs/en/writing-running-appium/ios/ios-xctest-mobile-gestures.md#mobile-scroll) | | |
| mobile:pinch | refer to [Automating Mobile Gestures For iOS With WebDriverAgent/XCTest Backend](/docs/en/writing-running-appium/ios/ios-xctest-mobile-gestures.md#mobile-pinch) | | |
| mobile:doubleTap | refer to [Automating Mobile Gestures For iOS With WebDriverAgent/XCTest Backend](/docs/en/writing-running-appium/ios/ios-xctest-mobile-gestures.md#mobile-doubleTap) | | |
| mobile:touchAndHold | refer to [Automating Mobile Gestures For iOS With WebDriverAgent/XCTest Backend](/docs/en/writing-running-appium/ios/ios-xctest-mobile-gestures.md#mobile-touchAndHold) | | |
| mobile:twoFingerTap | refer to [Automating Mobile Gestures For iOS With WebDriverAgent/XCTest Backend](/docs/en/writing-running-appium/ios/ios-xctest-mobile-gestures.md#mobile-twoFingerTap) | | |
| mobile:tapWithNumberOfTaps | refer to [Automating Mobile Gestures For iOS With WebDriverAgent/XCTest Backend](/docs/en/writing-running-appium/ios/ios-xctest-mobile-gestures.md#mobile-tapWithNumberOfTaps) | | |
| mobile:tap | refer to [Automating Mobile Gestures For iOS With WebDriverAgent/XCTest Backend](/docs/en/writing-running-appium/ios/ios-xctest-mobile-gestures.md#mobile-tap) | | |
| mobile:dragFromToForDuration | refer to [Automating Mobile Gestures For iOS With WebDriverAgent/XCTest Backend](/docs/en/writing-running-appium/ios/ios-xctest-mobile-gestures.md#mobile-dragFromToForDuration) | | |
| mobile:selectPickerWheelValue | refer to [Automating Mobile Gestures For iOS With WebDriverAgent/XCTest Backend](/docs/en/writing-running-appium/ios/ios-xctest-mobile-gestures.md#mobile-selectPickerWheelValue) | | |
| mobile:alert | refer to [Automating Mobile Gestures For iOS With WebDriverAgent/XCTest Backend](/docs/en/writing-running-appium/ios/ios-xctest-mobile-gestures.md#mobile-alert) | | |
| mobile:installApp | refer to [XCUITest Mobile App Managemenet](/docs/en/writing-running-appium/ios/ios-xctest-mobile-apps-management.md#mobile-installapp) | | |
| mobile:removeApp | refer to [XCUITest Mobile App Managemenet](/docs/en/writing-running-appium/ios/ios-xctest-mobile-apps-management.md#mobile-removeapp) | | |
| mobile:isAppInstalled | refer to [XCUITest Mobile App Managemenet](/docs/en/writing-running-appium/ios/ios-xctest-mobile-apps-management.md#mobile-isappinstalled) | | |
| mobile:launchApp | refer to [XCUITest Mobile App Managemenet](/docs/en/writing-running-appium/ios/ios-xctest-mobile-apps-management.md#mobile-launchapp) | | |
| mobile:terminateApp | refer to [XCUITest Mobile App Managemenet](/docs/en/writing-running-appium/ios/ios-xctest-mobile-apps-management.md#mobile-terminateapp) | | |
| mobile:activateApp | refer to [XCUITest Mobile App Managemenet](/docs/en/writing-running-appium/ios/ios-xctest-mobile-apps-management.md#mobile-activateapp) | | |
| mobile:queryAppState | refer to [XCUITest Mobile App Managemenet](/docs/en/writing-running-appium/ios/ios-xctest-mobile-apps-management.md#mobile-queryappstate) | | |
| mobile:setPasteboard | refer to [IOS Pasteboard Guide](/docs/en/writing-running-appium/ios/ios-xctest-pasteboard.md#mobile-setpasteboard) | | |
| mobile:getPasteboard | refer to [IOS Pasteboard Guide](/docs/en/writing-running-appium/ios/ios-xctest-pasteboard.md#mobile-getpasteboard) | | |
| mobile:installCertificate | refer to [IOS Pasteboard Guide](/docs/en/writing-running-appium/ios/ios-xctest-install-certificate.md) | | |
| mobile:getContexts | Retrieve available contexts, along with the url and title associated with each webview (see [get contexts](/docs/en/commands/context/get-contexts.md)). If `waitForWebviewMs` is provided, Appium will wait for available WebViews up to the number since Appium 1.17.0. | `{waitForWebviewMs}` | `{waitForWebviewMs: 5000}` |
| mobile:batteryInfo | Reads the battery information from the device under test | <none> | <none> |
| mobile:pressButton | Press a physical button. The available button options are: _home_, _volumeup_ and _volumedown_. Real devices support all three buttons whereas simulator only supports _home_. | `{name}` | `{name: "home"}` |
| mobile:enrollBiometric | Enroll (or unenroll) an iOS Simulator to use [biometrics](https://developer.apple.com/design/human-interface-guidelines/ios/user-interaction/authentication/#face-id-and-touch-id) | `{isEnabled}` | `{isEnabled: true}` |
| mobile:sendBiometricMatch | Send a matching or non-matching biometric input to an iOS Simulator. 'type' must be `touchId` or `faceId`. Match is a boolean indicating if it's a matching or non-matching input | `{type, match}` | `{type: "touchId", match: true}` |
| mobile:isBiometricEnrolled | Check if an iOS Simulator is enrolled or not. Returns `true` if enrolled, `false` if not enrolled. |||
| mobile:clearKeychains | Clear the keychains for an iOS Simulator |||
| mobile:siriCommand| Sends a command to Siri | `{text}` | `{text: "What time is it?"}` |
| mobile:source | This endpoint allows to retrieve the current native page source from WDA as a string (also being in a web context). Possible output formats are: `xml` (same output as for `getPageSource` command, the default value), `json` (the same tree structure as for the `xml` format, but represented as JSON) and `description` (native `debugDescription` output generated by XCTest). An optional `excludedAttributes` array allows to provide attributes names, which are going to be excluded from the resulting xml tree. This might significantly improve the performance of page source retrieval, especially if the `visible` attribute gets excluded. | `{format, excludedAttributes}` | `{format: 'description'}` `{format: 'xml', excludedAttributes: ['visible']}` |
| mobile:activeAppInfo | Gets current active application's information such as bundleId and process arguments | <none> | <none> |
| mobile:deviceInfo | Gets device information like locale and timezone. The timezone is TZ database format like `America/New_York` by default, fallback to Apple name like `US/New_York` | <none> | <none> |
| mobile:rotateElement | Sends a rotation gesture with two touches to the given element. See [rotate:withVelocity:](https://developer.apple.com/documentation/xctest/xcuielement/1618665-rotate) for more details. | `{element, rotation, velocity}` | `{element: 2, rotation: π/2, velocity: 1.5}` |
| mobile:deleteFile | Delete a file on the device under test. The remote path value should comply to [Pushing/Pulling Files](/docs/en/writing-running-appium/ios/ios-xctest-file-movement.md) tutorial. | `{remotePath}` | `{remotePath: 'path/to/file'}` |
| mobile:deleteFolder | Delete a folder on the device under test. The remote path value should comply to [Pushing/Pulling Files](/docs/en/writing-running-appium/ios/ios-xctest-file-movement.md) tutorial. | `{remotePath}` | `{remotePath: '@io.appium.example:documents/path/to/folder'}` |
| mobile:getPermission | Gets application permission state on a simulator. It requires https://github.com/wix/AppleSimulatorUtils |||
| mobile:setPermission | Set a permission for the given bundleId via `xcrun simctl privacy` which is available since Xcode 11.4. `key` is 'service' in the list of `xcrun simctl privacy`. `value` is `yes`(grant), `no`(revoke) or `unset`(reset). It works on simulator. | `{bundleId, {key: value}}`| `{bundleId: 'io.appium.example', {'location-always': 'yes', calendar: 'no'}` |
| mobile:getAppearance | Get the device's UI appearance style via `xcrun simctl ui`. It returns `light`, `dark`, `unknown` or `unsupported` (below iOS 12). |||
| mobile:setAppearance | Set the device's UI appearance style via `xcrun simctl ui` or Siri command. | `{style}` | `{style: 'dark'}` |
| mobile:getDeviceTime | Get time of the device under test. https://momentjs.com/docs/ is the full list of supported datetime format specifiers. Defaults to `YYYY-MM-DDTHH:mm:ssZ` which is ISO-8601. | `{format}` | `{format: 'YYYY-MM'}` |
| mobile:startAudioRecording | Start recording audio stream. Read [Audio Capture From iOS Simulators and Real Devices](/docs/en/writing-running-appium/ios/audio-capture.md) for more details | | |
| mobile:stopAudioRecording | Stop and store the recording audio stream. Read [Audio Capture From iOS Simulators and Real Devices](/docs/en/writing-running-appium/ios/audio-capture.md) for more details | | |
### Espresso
### Android
| Command | Description | Argument | Argument Example |
| ------- | ----------- | -------- | ---------------- |
| mobile:shell | Execute [ADB shell](https://developer.android.com/studio/command-line/adb#shellcommands) commands (requires [insecure feature](/docs/en/writing-running-appium/security.md) `adb_shell` to be enabled) | Read [this page](/docs/en/writing-running-appium/android/android-shell.md) | `{'command': 'echo', 'args': ['arg1', 'arg2']}` |
| mobile:startLogsBroadcast | Starts Android logcat broadcast websocket on the same host and port where Appium is running at `/ws/session/:sessionId:/appium/device/logcat` endpoint | <none> | <none> |
| mobile:stopLogsBroadcast | Stops the logcat broadcasting websocket server started by `mobile:startLogsBroadcast` | <none> | <none> |
| mobile:performEditorAction | Performs the given editor action on the focused input field. The following action names are supported: `normal, unspecified, none, go, search, send, next, done, previous`. | `{action}` | `{action: "previous"}`|
| mobile:getPermissions | Gets a list of permissions which are `denied`, `granted` or `requested`. | `{type, appPackage}` | `{type: "granted", appPackage: "io.appium.android.apis"}`|
| mobile:changePermissions | Grants or revokes permissions. | `{action, appPackage, permissions}` | `{action: "grant", appPackage: "io.appium.android.apis", permissions: "android.permission.READ_CONTACTS"}`, `{action: "revoke", appPackage: "io.appium.android.apis", permissions: ["android.permission.READ_CONTACTS", "android.permission.CAMERA"]}` |
| mobile:getNotifications | Get the list of items as JSON format in the status bar notifications. Please turn 'Notification access' on via _Settings > App & notifications > Special app access_ (the actual path depends on the device model). Please read [Appium Pro](https://appiumpro.com/editions/106-retrieving-status-bar-notifications-for-android-devices) for more details. | <none> | <none> |
| mobile: listSms | Get the list of SMS messages as [JSON format](https://github.com/appium/io.appium.settings#sms). | <none> | <none> |
| mobile:type | Send Unicode text to a focused element. | `{text}` | `{text: "happy testing"}` |
| mobile:getDeviceTime | Get time of the device under test. https://momentjs.com/docs/ is the full list of supported datetime format. Defaults to `YYYY-MM-DDTHH:mm:ssZ` which is ISO-8601. | `{format}` | `{format: 'YYYY-MM'}` |
| mobile:deleteFile | Delete a file on the device under test. The remote path value should be the full path or a file inside an application bundle. | `{remotePath}` | `{remotePath: '@io.appium.example/path/in/bundle'}`, `{remotePath: '/tmp/data/file'}` |
| mobile:startService | Starts the given service by calling `am start-service` or `am start-foreground-service` under the hood since Appium 1.18.0. The `intent` argument is mandatory. `user` is the ID of the user the service should be started for (the current user ID is used by default). If `foreground` is set to `true` then the service will be started in foreground. | `{intent, user, foreground}` | `{intent: 'my.app/my.activity', foreground: true}` |
| mobile:stopService | Stops the given service by calling `am stop-service` under the hood since Appium 1.18.0. The `intent` argument is mandatory. `user` is the ID of the user the service should be stopped for (the current user ID is used by default). | `{intent, user}` | `{intent: 'my.app/my.activity'}` |
| mobile:getContexts | Retrieve available contexts, along with details associated with each webview (see [get contexts](/docs/en/commands/context/get-contexts.md)) in JSON structure. The details of each webview includes such as android package name and its window handles details (see [get handles](/docs/en/commands/web/window/get-handles.md)). The details of each window handle (which donated as `pages` in the JSON) contains such as url, title and id. The id is part of a window handle name. Therefore, by concatenating a string like "CDwindow-" + id, you can use the string for switching to window (see [set window](/docs/en/commands/web/window/set-window.md).) | | |
Please refer to [mobile commands](https://github.com/appium/appium-espresso-driver#platform-specific-extensions) section in Espresso driver repository.
### Android (UiAutomator2 only)
| Command | Description | Argument | Argument Example |
| ------- | ----------- | -------- | ---------------- |
| mobile:batteryInfo | Reads the battery information from the device under test | <none> | <none> |
| mobile:acceptAlert | Accepts an on-screen alert | Optional button label to click on | <none> |
| mobile:dismissAlert | Dismisses an on-screen alert | Optional button label to click on | <none> |
| mobile:scrollBackTo | Scroll from one element to another | `{elementId, elementToId}` | `{elementId: 2, elementToId: 1}` |
| mobile:scroll | Scroll the given scrollable element until the element identifier by `strategy` and `selector` becomes visible since Appium 1.18.0. An optional `maxSwipes` property can limit the number of scroll actions. It accepts an optional `element` property which should be the element identifier and scrollable. Without this property, Appium will select the first currently available scrollable container. Please read `mobileScroll` section in [appium-uiautomator2-driver](https://github.com/appium/appium-uiautomator2-driver/blob/master/lib/commands/general.js) for more details. | `{element, strategy, selector, maxSwipes}` | `{strategy: 'accessibility id', selector: 'target content description'}` |
| mobile:viewportScreenshot | Like [screenshot](/commands/session/screenshot/) but only includes contents of viewport | <none> | <none> |
| mobile:viewportRect | Returns the coordinates and size of the viewports since Appium 1.18.0. The return type is Rectangle defined in [general.js](https://github.com/appium/appium-uiautomator2-driver/blob/master/lib/commands/general.js).| <none> | <none> |
| mobile:deepLink | Opens a deep-link URL for testing [Instant Apps](https://support.google.com/googleplay/answer/7240211?hl=en) | `{url, package}` | `{url: "https://www.site.com/", package: "com.site.SomeAndroidPackage"}` |
| mobile:deviceInfo | Gets device information like manufacturer, model, timezone and locale. Read [GetDeviceInfo](https://github.com/appium/appium-uiautomator2-server/blob/master/app/src/main/java/io/appium/uiautomator2/handler/GetDeviceInfo.java) for more details. | <none> | <none> |
| mobile:type | Types the given Unicode string into focused field. The combination of `unicodeKeyboard` capability and the [send keys](https://appium.io/docs/en/commands/element/actions/send-keys/) works as _replacing_ the text field content. The send key in W3C action works only for ASCII. This command helps such cases to append unicode text content against the focused field. | `{text}` | `{text: 'happy testing'}` |
| mobile:longClickGesture | Refer to [Automating Mobile Gestures With UiAutomator2 Backend](/docs/en/writing-running-appium/android/android-mobile-gestures.md##mobile-longclickgesture) since Appium 1.19.0 | | |
| mobile:dragGesture | Refer to [Automating Mobile Gestures With UiAutomator2 Backend](/docs/en/writing-running-appium/android/android-mobile-gestures.md##mobile-draggesture) since Appium 1.19.0 | | |
| mobile:flingGesture | Refer to [Automating Mobile Gestures With UiAutomator2 Backend](/docs/en/writing-running-appium/android/android-mobile-gestures.md##mobile-flinggesture) since Appium 1.19.0 | | |
| mobile:pinchOpenGesture | Refer to [Automating Mobile Gestures With UiAutomator2 Backend](/docs/en/writing-running-appium/android/android-mobile-gestures.md##mobile-pinchopengesture) since Appium 1.19.0 | | |
| mobile:pinchCloseGesture | Refer to [Automating Mobile Gestures With UiAutomator2 Backend](/docs/en/writing-running-appium/android/android-mobile-gestures.md##mobile-pinchclosegesture) since Appium 1.19.0 | | |
| mobile:swipeGesture | Refer to [Automating Mobile Gestures With UiAutomator2 Backend](/docs/en/writing-running-appium/android/android-mobile-gestures.md##mobile-swipegesture) since Appium 1.19.0 | | |
| mobile:scrollGesture | Refer to [Automating Mobile Gestures With UiAutomator2 Backend](/docs/en/writing-running-appium/android/android-mobile-gestures.md##mobile-scrollgesture) since Appium 1.19.0 | | |
### Android (Espresso only)
| Command | Description | Argument | Argument Example |
| ------- | ----------- | -------- | ---------------- |
| mobile:swipe | Perform the ["swipe" view action](https://developer.android.com/reference/android/support/test/espresso/action/ViewActions.html#swipeDown()) | `{element, direction}` | `{element: 2, direction: "down|up|left|right"}` |
| mobile:swipe | Perform ["GeneralSwipeAction"](https://developer.android.com/reference/androidx/test/espresso/action/GeneralSwipeAction) | `{element, swiper, startCoordinates, endCoordinates, precisionDescriber}` | `{element: 3, swiper: "FAST|SLOW", startCoordinates: 'BOTTOM_RIGHT', endCoordinates: 'TOP_RIGHT', precisionDescriber: 'FINGER'}` |
| mobile:clickAction | Perform ["ClickAction"](https://developer.android.com/reference/androidx/test/espresso/action/GeneralClickAction) | `{element, tapper, coordinatesProvider, precisionDescriber, inputDevice, buttonState}` | `{element: 2, tapper: 'Long', coordinatesProvider: 'BOTTOM_RIGHT', precisionDescriber: 'Thumb', inputDevice: 0, buttonState: 0}` |
| mobile:isToastVisible | Check whether a toast message is visible. `text` is the mandatory argument. `isRegexp` is optional. `text` will be parsed as a regular expression pattern if `isRegexp` is `true`. `isRegexp` is `false` by default. It returns `true` if the `text` exists, or `false` otherwise. | `{text, isRegexp}` | `{ text: 'A toast' }`, `{ text: '^regex$', isRegexp: true } `|
| mobile:openDrawer | Open drawer by [DrawerAction](https://developer.android.com/reference/android/support/test/espresso/contrib/DrawerActions) with [gravity](https://developer.android.com/reference/android/view/Gravity). `gravity` is option. The default is [GravityCompat.START](https://developer.android.com/reference/android/support/v4/view/GravityCompat.html#START). This method blocks until the drawer is fully open. No operation if the drawer is already open. | `{element, gravity}` | `{ element: element_id }`, `{ element: element_id, gravity: 3 }` |
| mobile:closeDrawer | Close drawer by [DrawerAction](https://developer.android.com/reference/android/support/test/espresso/contrib/DrawerActions) with [gravity](https://developer.android.com/reference/android/view/Gravity). `gravity` is option. The default is [GravityCompat.START](https://developer.android.com/reference/android/support/v4/view/GravityCompat.html#START). This method blocks until the drawer is fully closed. No operation if the drawer is already closed. | `{element, gravity}` | `{ element: element_id }`, `{ element: elementId, gravity: 3 }` |
| mobile:setDate | Set date by [PickerActions#setDate](https://developer.android.com/reference/android/support/test/espresso/contrib/PickerActions.html#setDate(int,%20int,%20int)) for [DataPicker](https://developer.android.com/reference/android/widget/DatePicker). | `{element, year, monthOfYear, dayOfMonth}` | `{element: elementId, year: 2018, monthOfYear: 12, dayOfMonth: 1}` |
| mobile:setTime | Set time by [PickerActions#setTime](https://developer.android.com/reference/android/support/test/espresso/contrib/PickerActions.html#setTime(int,%20int)) for [TimePicker](https://developer.android.com/reference/android/widget/TimePicker). | `{element, hours, minutes}` | `{element: elementId, hours: 12, minutes: 10}` |
| mobile:navigateTo | Action to [NavigationView](https://developer.android.com/reference/android/support/design/widget/NavigationView) by [NavigationViewActions#navigateTo](https://developer.android.com/reference/android/support/test/espresso/contrib/NavigationViewActions.html#navigateTo(int)). The view must be a child of a DrawerLayout, of type NavigationView, visible on screen and displayed on screen. `com.google.android.material:material` as `additionalAndroidTestDependencies` capability is necessary. | `{element, menuItemId}` | `{element: elementId, menuItemId: 1}` |
| mobile:scrollToPage | Action to [ViewPager](https://developer.android.com/reference/android/support/v4/view/ViewPager) by [ViewPagerActions](https://developer.android.com/reference/android/support/test/espresso/contrib/ViewPagerActions). `scrollTo` must be one of `first`, `last`, `left`, `right`. `scrollTo` is used by default if `scrollTo` and `scrollToPage` are provided. | `{scrollTo, scrollToPage, smoothScroll}` | `{element: elementId, scrollTo: 'left', smoothScroll: true}`, `{element: elementId, scrollToPage: 2}`|
| mobile:backdoor | Invoke arbitrary methods defined in Android app. The methods must be `public` in Java and must be `open` in Kotlin. `target` is `activity`, `application` or `element`. `methods` are methods you would like to invoke. `element` is mandatory if `target` is `element`. Read docstring of _mobileBackdoor_ method [here](https://github.com/appium/appium-espresso-driver/blob/master/lib/commands/general.js) for more details | `{target, methods, element}` | `{target: 'activity', methods: [{name: 'method1'}, {name: 'method2', args: [{value: 'hello appium', type: 'java.lang.String'}] }] }`, `{target: 'element', element: elementId, [{name: 'getTypeface'}, {name: 'isItalic'}]}` |
| mobile:flashElement | Flashes an element on the screen to visually confirm you are operating on the correct element. Can optionally set `durationMillis` (in ms) and `repeatCount` of animation| `{element, durationMillis, repeatCount}` | `{element: "1234-abcd-5678", durationMillis: 1000, repeatCount: 10}` |
| mobile:uiautomator | Drive areas which are not part of App Under Test, using uiautomator2 APIs. `strategy` can be one of: "clazz", "res", "text", "textContains", "textEndsWith", "textStartsWith","desc", "descContains", "descEndsWith", "descStartsWith" and "pkg", taken from uiautomator [By class](https://developer.android.com/reference/androidx/test/uiautomator/By). `action` can be one of: "click", "longClick", "getText", "getContentDescription", "getClassName","getResourceName", "getVisibleBounds", "getVisibleCenter", "getApplicationPackage","getChildCount", "clear", "isCheckable", "isChecked", "isClickable", "isEnabled","isFocusable", "isFocused", "isLongClickable", "isScrollable" and "isSelected", taken from uiautomator [UiObject2](https://developer.android.com/reference/androidx/test/uiautomator/UiObject2). `index` is optional, if not given, will return all matching results | `{strategy, locator, index, action}` | `{strategy: 'clazz', locator: 'android.widget.TextView', index: 2, action: "getText"}` |
| mobile:webAtoms | Runs a chain of [webatoms](https://developer.android.com/training/testing/espresso/web). `withElement` and `perform` are basic chain items. Please refer [issue](https://github.com/appium/appium-espresso-driver/pull/380) and [Sample test code](https://github.com/appium/ruby_lib_core/blob/c9062c4b744263d790c7de17263cbd4645cdefc6/test/functional/android/android/mobile_commands_test.rb#L196-L239) as references. | `{webviewElement, forceJavascriptEnabled, methodChain}` | (webdriverio) `{ webviewElement: webviewEl.value, forceJavascriptEnabled: true, methodChain: [...]}` |
| mobile:dismissAutofill | Disable autofill dialog in Android O+ | `{element}` | `{element: elementId}` |
| mobile:deviceInfo | Gets device information like manufacturer, model, timezone and locale. Read [GetDeviceInfo](https://github.com/appium/appium-espresso-driver/blob/master/espresso-server/app/src/androidTest/java/io/appium/espressoserver/lib/handlers/GetDeviceInfo.kt) for more details. | <none> | <none> |
| mobile:registerIdlingResources | Registers one or more idling resources. Read [idling-resources.js](https://github.com/appium/appium-espresso-driver/blob/master/lib/commands/idling-resources.js) for more details. | `{classNames}` | `{classNames: 'com.package.MyIdlingResource1, com.package.MyIdlingResource2'}` |
| mobile:unregisterIdlingResources | Unregisters one or more idling resources. Read [idling-resources.js](https://github.com/appium/appium-espresso-driver/blob/master/lib/commands/idling-resources.js) for more details. | `{classNames}` | `{classNames: 'com.package.MyIdlingResource1, com.package.MyIdlingResource2'}` |
| mobile:listIdlingResources | Returns the list of canonical class names of currently registered idling resources. Read [idling-resources.js](https://github.com/appium/appium-espresso-driver/blob/master/lib/commands/idling-resources.js) for more details. | <none> | <none> |
## IOS
### XCUITest
Please refer to [mobile commands](https://github.com/appium/appium-xcuitest-driver#platform-specific-extensions) section in XCUITest driver repository.
example_usage:
java:
@@ -150,9 +44,6 @@
ruby_core:
|
@driver.execute_script("mobile: scroll", { "direction" => "down"})
php:
|
// TODO PHP sample
csharp:
|
driver.ExecuteScript("mobile:scroll", new Dictionary<string, string> { { "direction", "down" } });
@@ -164,7 +55,6 @@
javascript_wd: "https://github.com/admc/wd/blob/master/lib/commands.js#L102"
ruby: "https://www.rubydoc.info/gems/selenium-webdriver/Selenium/WebDriver/Driver:execute_script"
ruby_core: "https://www.rubydoc.info/gems/selenium-webdriver/Selenium/WebDriver/Driver:execute_script"
php: "https://github.com/appium/php-client/" # TODO PHP documentation link
csharp: "https://github.com/appium/appium-dotnet-driver/" # TODO Dotnet documentation link
# Driver support by platform
@@ -184,7 +74,6 @@
java: true
python: true
ruby: true
php: true
csharp: true
javascript_wd: true
javascript_wdio: true

Some files were not shown because too many files have changed in this diff Show More