Files
appium/docs/en/commands/interactions/touch/scroll.md
T
Kazuaki Matsuo f877df6fb5 chore: merge master into 2.0 and added mac2 in lib/drivers.js (#14928)
* fix: fix urls in docs (#14910)

* docs: Update generated docs [ci skip] (#14913)

Co-authored-by: runner <runner@Mac-1606273407156.local>

* feat: Add Mac2Driver (#14911)

* docs: Add Mac2Driver documentation (#14914)

* chore: add scripts for doing releases (#14918)

* docs: Update push-file.yml (#14920)

* add appium-mac2-driver

Co-authored-by: Appium Triager <maintainers@appium.io>
Co-authored-by: runner <runner@Mac-1606273407156.local>
Co-authored-by: Mykola Mokhnach <mokhnach@gmail.com>
Co-authored-by: Dan Graham <dpgraham.85@gmail.com>
Co-authored-by: Ilija Boshkov <ilija.boshkov@gmail.com>
2020-12-04 08:44:34 +09:00

124 lines
4.9 KiB
Markdown

[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/interactions/touch/scroll.yml)
# Scroll
Scroll on the touch screen using finger based motion events
[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/interactions/touch/scroll.yml)
## Example Usage
```java
// Java
TouchActions action = new TouchActions(driver);
action.scroll(element, 10, 100);
action.perform();
```
```python
# Python
from appium.webdriver.common.touch_action import TouchAction
# ...
actions = TouchAction(driver)
actions.scroll_from_element(element, 10, 100)
actions.scroll(10, 100)
actions.perform()
```
```javascript
// Javascript
// webdriver.io example
driver.touchScroll(10, 100, element);
// wd example
await driver.scroll(10, 100);
```
```ruby
# Ruby
# ruby_lib example
touch_actions.scroll(element, 10, 100).perform
# ruby_lib_core example
@driver.touch_actions.scroll(element, 10, 100).perform
```
```php
# PHP
// TODO PHP sample
```
```csharp
// C#
TouchActions action = new TouchActions(driver);
action.Scroll(element, 10, 100);
action.Perform();
```
[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/interactions/touch/scroll.yml)
## Support
[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/interactions/touch/scroll.yml)
### Appium Server
|Platform|Driver|Platform Versions|Appium Version|Driver Version|
|--------|----------------|------|--------------|--------------|
| iOS | [XCUITest](/docs/en/drivers/ios-xcuitest.md) | 9.3+ | 1.6.0+ | All |
| | [UIAutomation](/docs/en/drivers/ios-uiautomation.md) | 8.0 to 9.3 | All | All |
| Android | [Espresso](/docs/en/drivers/android-espresso.md) | ?+ | 1.9.0+ | All |
| | [UiAutomator2](/docs/en/drivers/android-uiautomator2.md) | ?+ | 1.6.0+ | All |
| | [UiAutomator](/docs/en/drivers/android-uiautomator.md) | 4.3+ | All | All |
| Mac | [Mac](/docs/en/drivers/mac.md) | ?+ | 1.6.4+ | All |
| Windows | [Windows](/docs/en/drivers/windows.md) | 10+ | 1.6.0+ | All |
[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/interactions/touch/scroll.yml)
### Appium Clients
|Language|Support|Documentation|
|--------|-------|-------------|
|[Java](https://github.com/appium/java-client/releases/latest)| All | [seleniumhq.github.io](https://seleniumhq.github.io/selenium/docs/api/java/org/openqa/selenium/interactions/touch/TouchActions.html#scroll-int-int-) |
|[Python](https://github.com/appium/python-client/releases/latest)| All | [selenium-python.readthedocs.io](https://selenium-python.readthedocs.io/api.html#selenium.webdriver.common.touch_actions.TouchActions.scroll) |
|[Javascript (WebdriverIO)](http://webdriver.io/index.html)| All | |
|[Javascript (WD)](https://github.com/admc/wd/releases/latest)| All | [github.com](https://github.com/admc/wd/blob/master/lib/commands.js#L425) |
|[Ruby](https://github.com/appium/ruby_lib/releases/latest)| All | [www.rubydoc.info](https://www.rubydoc.info/gems/selenium-webdriver/Selenium%2FWebDriver%2FTouchActionBuilder:scroll) |
|[PHP](https://github.com/appium/php-client/releases/latest)| All | [github.com](https://github.com/appium/php-client/) |
|[C#](https://github.com/appium/appium-dotnet-driver/releases/latest)| All | [github.com](https://github.com/SeleniumHQ/selenium/blob/master/dotnet/src/webdriver/Interactions/TouchActions.cs) |
[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/interactions/touch/scroll.yml)
## HTTP API Specifications
[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/interactions/touch/scroll.yml)
### Endpoint
`POST /session/:session_id/touch/scroll`
[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/interactions/touch/scroll.yml)
### URL Parameters
|name|description|
|----|-----------|
|session_id|ID of the session to route the command to|
[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/interactions/touch/scroll.yml)
### JSON Parameters
|name|type|description|
|----|----|-----------|
| x | `number` | X coordinate on the screen |
| y | `number` | Y coordinate on the screen |
[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/interactions/touch/scroll.yml)
### Response
null
[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/interactions/touch/scroll.yml)
## See Also
* [JSONWP Specification](https://github.com/SeleniumHQ/selenium/wiki/JsonWireProtocol#sessionsessionidtouchscroll)