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

Automation for Apps.

---
name: Tap
short_description: Flick on the touch screen using finger motion events
   
example_usage:
  java:
    |
      TouchActions action = new TouchActions(driver);
      action.flick(element, 1, 10, 10);
      action.perform();
  python:
    |
      actions = TouchActions(driver)
      actions.flick_element(element, 1, 10, 10)
      actions.perform()
  javascript_wd:
    |
      await element.flick(1, 10, 10);

  javascript_wdio:
    |
      driver.touchFlick('<ELEMENT_ID>', 1, 10, 10);
  ruby:
    |
      @driver.touch_action.flick(element, 1, 10, 10).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#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"
  javascript_wdio: "http://webdriver.io/api/protocol/touchFlick.html"
  javascript_wd: "https://github.com/admc/wd/blob/master/lib/commands.js#L1513"
  ruby: "http://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/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/flick
  method: POST
  url_parameters:
    - name: session_id
      description: ID of the session to route the command to
  json_parameters:
    - name: element
      type: string
      description: ID of the element where the flick starts
    - name: xoffset
      type: number
      description: The x offset in pixels to flick by
    - name: yoffset
      type: number
      description: The y offset in pixels to flick by
    - name: speed
      type: number
      description: The speed in pixels per seconds
    

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