appium/commands-yml/commands/interactions/mouse/click.yml

Automation for Apps.

---
name: Click
short_description: Click any mouse button at the current mouse coordinates
   
example_usage:
  java:
    |
      Actions action = new Actions(driver);
      action.moveTo(element);
      action.click();
      action.perform();
  python:
    |
      actions = ActionChains(driver)
      actions.move_to_element(element)
      actions.click()
      actions.perform()
  javascript_wd:
    |
      await driver.moveTo(element);
      await driver.click();

  javascript_wdio:
    |
      driver.moveTo(element)
        .click();
  ruby:
    |
      @driver.action.move_to(element).click.perform
  php:
    |
      // TODO PHP sample
  csharp:
    |
      // TODO C# sample

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"
  javascript_wdio: "http://webdriver.io/api/action/click.html"
  javascript_wd: "https://github.com/admc/wd/blob/master/lib/commands.js#L1665"
  ruby: "http://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
driver_support:
  ios:
    xcuitest: false
    uiautomation: false
  android:
    uiautomator2: false
    uiautomator: false
  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/click
  method: POST
  url_parameters:
    - name: session_id
      description: ID of the session to route the command to
  json_parameters:
    - name: button
      type: number
      description: Which button, {LEFT = 0, MIDDLE = 1 , RIGHT = 2}. Defaults to the left mouse button if not specified

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