appium/docs/en/commands/interactions/touch/flick.md

Flick

Flick on the touch screen using finger motion events //: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/interactions/touch/flick.yml)

Example Usage

// Java
TouchActions action = new TouchActions(driver);
action.flick(element, 1, 10, 10);
action.perform();

# Python
from appium.webdriver.common.touch_action import TouchAction
# ...
actions = TouchAction(driver)
actions.flick_element(element, 1, 10, 10)
actions.perform()

// Javascript
// webdriver.io example
driver.touchFlick(10, 10, element, 1);

// wd example
await element.flick(1, 10, 10);

# Ruby
# ruby_lib example
touch_action.flick(element, 1, 10, 10).perform

# ruby_lib_core example
@driver.touch_action.flick(element, 1, 10, 10).perform

# PHP
// TODO PHP sample

// C#
TouchActions action = new TouchActions(driver);
action.Flick(element, 10, 10, 1);
action.Perform();

Support

Appium Server

Platform	Driver	Platform Versions	Appium Version	Driver Version
iOS	XCUITest	9.3+	1.6.0+	All
	UIAutomation	8.0 to 9.3	All	All
Android	Espresso	None	None	None
	UiAutomator2	?+	1.6.0+	All
	UiAutomator	4.3+	All	All
Mac	Mac	?+	1.6.4+	All
Windows	Windows	10+	1.6.0+	All

Appium Clients

Language	Support	Documentation
Java	All	seleniumhq.github.io
Python	All	selenium-python.readthedocs.io
Javascript (WebdriverIO)	All
Javascript (WD)	All	github.com
Ruby	All	www.rubydoc.info
PHP	All	github.com
C#	All	github.com

HTTP API Specifications

Endpoint

POST /session/:session_id/touch/flick

URL Parameters

name	description
session_id	ID of the session to route the command to

JSON Parameters

name	type	description
element	string	ID of the element where the flick starts
xoffset	number	The x offset in pixels to flick by
yoffset	number	The y offset in pixels to flick by
speed	number	The speed in pixels per seconds

Response

null

See Also

• JSONWP Specification