appium/commands-yml/commands/interactions/touch/scroll.yml

Automation for Apps.

---
name: Scroll
short_description: Scroll on the touch screen using finger based motion events
   
example_usage:
  java:
    |
      TouchActions action = new TouchActions(driver);
      action.scroll(element, 10, 100);
      action.perform();
  python:
    |
      actions = TouchActions(driver)
      actions.scroll_from_element(element, 10, 100)
      actions.scroll(10, 100)
      actions.perform()
  javascript_wd:
    |
      await driver.scroll(10, 100);

  javascript_wdio:
    |
      driver.touchScroll({
        el: element,
        xOffset: 10,
        yOffset: 100
      });
  ruby:
    |
      @driver.touch_action.scroll(element, 10, 100).perform
  php:
    |
      // TODO PHP sample
  csharp:
    |
      // TODO C# sample

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"
  javascript_wdio: "http://webdriver.io/api/protocol/touchScroll.html"
  javascript_wd: "https://github.com/admc/wd/blob/master/lib/commands.js#L425"
  ruby: "http://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/appium/appium-dotnet-driver/" # TODO Dotnet documentation link

# Driver support by platform
driver_support:
  ios:
    xcuitest: true
    uiautomation: true
  android:
    uiautomator2: true
    uiautomator: true
  mac:
    mac: true # TODO Confirm this that mouse movements
  windows:
    windows: true # TODO Confirm this
client_support:
  java: true
  python: true
  ruby: true
  php: true
  csharp: true
  javascript_wd: true
  javascript_wdio: true
  

# Information about the HTTP endpoints
endpoint:
  url: /session/:session_id/touch/scroll
  method: POST
  url_parameters:
    - name: session_id
      description: ID of the session to route the command to
  json_parameters:
    - name: x
      type: number
      description: X coordinate on the screen
    - name: y
      type: number
      description: Y coordinate on the screen

# Links to specifications. Should link to at least one specification
specifications:
  jsonwp: https://github.com/SeleniumHQ/selenium/wiki/JsonWireProtocol#sessionsessionidtouchscroll