Appium

getLogTypes

Get available log types.

Appium command. More details can be found in the official protocol docs.

Usage

driver.getLogTypes()

Returns

• <String[]> logTypes: The list of available log types, example: browser, driver.

---

getLogs

Get the log for a given log type. Log buffer is reset after each request.

Appium command. More details can be found in the official protocol docs.

Usage

driver.getLogs(type)

Parameters

Name	Type	Details
type	string	the log type

Returns

• <Object[]> logs: The list of log entries.

---

getSession

Retrieve the capabilities of the current session.

Appium command. More details can be found in the official protocol docs.

caution

This protocol command is deprecated
Use getAppiumSessionCapabilities instead

Usage

driver.getSession()

Returns

• <Object> capabilities: An object describing the session's capabilities.

---

getAppiumContext

Appium command. More details can be found in the official protocol docs.

Usage

driver.getAppiumContext()

Returns

• <Context> context: a string representing the current context or null representing 'no context'

---

switchAppiumContext

Appium command. More details can be found in the official protocol docs.

Usage

driver.switchAppiumContext(name)

Parameters

Name	Type	Details
name	string	a string representing an available context

---

getAppiumContexts

Appium command. More details can be found in the official protocol docs.

Usage

driver.getAppiumContexts()

Returns

• <Context[]> contexts: an array of strings representing available contexts, e.g. 'WEBVIEW', or 'NATIVE'

---

getAppiumCommands

Retrieve the endpoints and BiDi commands supported in the current session.

Appium command. More details can be found in the official protocol docs.

Usage

driver.getAppiumCommands()

Returns

• <Object> commands: Supported endpoints and BiDi commands, each grouped into common, driver-specific, and plugin-specific endpoints/commands.

---

getAppiumExtensions

Retrieve the extension commands supported in the current session.

Appium command. More details can be found in the official protocol docs.

Usage

driver.getAppiumExtensions()

Returns

• <Object> commands: Supported extension commands, grouped into driver-specific and plugin-specific commands.

---

getAppiumSessionCapabilities

Retrieve the capabilities of the current session.

Appium command. More details can be found in the official protocol docs.

Usage

driver.getAppiumSessionCapabilities()

Returns

• <Object> capabilities: An object describing the session's capabilities.

---

shake

Perform a shake action on the device.

Appium command. More details can be found in the official protocol docs.

caution

This protocol command is deprecated
Use driver.execute('mobile: shake') instead

Usage

driver.shake()

Support

---

lock

Lock the device.

Appium command. More details can be found in the official protocol docs.

caution

This protocol command is deprecated
Use driver.execute('mobile: lock', { ... }) instead

Usage

driver.lock(seconds)

Parameters

Name	Type	Details
seconds optional	number	how long to lock the screen (iOS only)

Support

---

unlock

Unlock the device.

Appium command. More details can be found in the official protocol docs.

caution

This protocol command is deprecated
Use driver.execute('mobile: unlock') instead

Usage

driver.unlock()

Support

---

isLocked

Check whether the device is locked or not.

Appium command. More details can be found in the official protocol docs.

caution

This protocol command is deprecated
Use driver.execute('mobile: isLocked') instead

Usage

driver.isLocked()

Returns

• <boolean> isLocked: True if the device is locked, false if not

Support

---

startRecordingScreen

Start recording the screen.

Appium command. More details can be found in the official protocol docs.

Usage

driver.startRecordingScreen(options)

Parameters

Name	Type	Details
options optional	object	command parameters that can contain keys like: remotePath, username, password, method, forceRestart, timeLimit, videoType, videoQuality, videoFps, bitRate, videoSize, bugReport (see more description in Appium docs)

Support

---

stopRecordingScreen

Stop recording screen

Appium command. More details can be found in the official protocol docs.

Usage

driver.stopRecordingScreen(remotePath, username, password, method)

Parameters

Name	Type	Details
remotePath optional	string	The path to the remote location, where the resulting video should be uploaded. The following protocols are supported http/https, ftp. This option only has an effect if there is screen recording process in progreess and forceRestart parameter is not set to true. Null or empty string value (the default setting) means the content of resulting file should be encoded as Base64.
username optional	string	The name of the user for the remote authentication.
password optional	string	The password for the remote authentication.
method optional	string	The http multipart upload method name. The 'PUT' one is used by default.

Returns

• <string> response: Base64 encoded string. If remote_path is set, the response is empty string

Support

---

getPerformanceDataTypes

Returns the information types of the system state which is supported to read as like cpu, memory, network traffic, and battery.

Appium command. More details can be found in the official protocol docs.

caution

This protocol command is deprecated
Use driver.execute('mobile: getPerformanceDataTypes') instead

Usage

driver.getPerformanceDataTypes()

Returns

• <string[]> performanceTypes: The available performance data types (cpuinfo|batteryinfo|networkinfo|memoryinfo)

Support

---

getPerformanceData

Returns the information of the system state which is supported to read as like cpu, memory, network traffic, and battery.

Appium command. More details can be found in the official protocol docs.

caution

This protocol command is deprecated
Use driver.execute('mobile: getPerformanceData', { ... }) instead

Usage

driver.getPerformanceData(packageName, dataType, dataReadTimeout)

Parameters

Name	Type	Details
packageName	string	the package name of the application
dataType	string	the type of system state which wants to read. It should be one of the supported performance data types
dataReadTimeout optional	number	the number of attempts to read

Returns

• <string[]> performanceData: The information type of the system state which is supported to read as like cpu, memory, network traffic, and battery

Support

---

pressKeyCode

Press a particular key on the device.

Appium command. More details can be found in the official protocol docs.

caution

This protocol command is deprecated
Use driver.execute('mobile: pressKey', { ... }) instead

Usage

driver.pressKeyCode(keycode, metastate, flags)

Parameters

Name	Type	Details
keycode	number	keycode to press
metastate optional	number	meta state to press the keycode with
flags optional	number	flags for the keypress

Support

---

longPressKeyCode

Press and hold a particular key code on the device.

Appium command. More details can be found in the official protocol docs.

caution

This protocol command is deprecated
Use driver.execute('mobile: pressKey', { ... }) instead

Usage

driver.longPressKeyCode(keycode, metastate, flags)

Parameters

Name	Type	Details
keycode	number	keycode to press on the device
metastate optional	number	metastate for the keypress
flags optional	number	flags for the keypress

Support

---

sendKeyEvent

Send a key code to the device.

Appium command. More details can be found in the official protocol docs.

caution

This protocol command is deprecated
Use driver.execute('mobile: pressKey', { ... }) instead

Usage

driver.sendKeyEvent(keycode, metastate)

Parameters

Name	Type	Details
keycode	string	keycode to press
metastate optional	string	meta state to press the keycode with

Support

---

rotateDevice

Rotate the device in three dimensions.

Appium command. More details can be found in the official protocol docs.

Usage

driver.rotateDevice(x, y, z)

Parameters

Name	Type	Details
x	number	x offset to use for the center of the rotate gesture
y	number	y offset to use for the center of the rotate gesture
z	number	z offset to use for the center of the rotate gesture

Support

---

getCurrentActivity

Get the name of the current Android activity.

Appium command. More details can be found in the official protocol docs.

caution

This protocol command is deprecated
Use driver.execute('mobile: getCurrentActivity') instead

Usage

driver.getCurrentActivity()

Returns

• <string> activity: Name of the current activity

Support

---

getCurrentPackage

Get the name of the current Android package.

Appium command. More details can be found in the official protocol docs.

caution

This protocol command is deprecated
Use driver.execute('mobile: getCurrentPackage') instead

Usage

driver.getCurrentPackage()

Returns

• <string> package: Name of the current package

Support

---

installApp

Install the given app onto the device.

Appium command. More details can be found in the official protocol docs.

Usage

driver.installApp(appPath, options)

Parameters

Name	Type	Details
appPath	string	Path to application .apk file
options optional	object	Driver-specific installation options

Support

---

activateApp

Activate the given app on the device

Appium command. More details can be found in the official protocol docs.

Usage

driver.activateApp(appId, bundleId, options)

Parameters

Name	Type	Details
appId optional	string	App package ID (required for Android)
bundleId optional	string	Bundle ID (required for iOS)
options optional	object	Driver-specific launch options

Support

---

removeApp

Remove an app from the device.

Appium command. More details can be found in the official protocol docs.

Usage

driver.removeApp(appId, bundleId, options)

Parameters

Name	Type	Details
appId optional	string	App package ID (required for Android)
bundleId optional	string	Bundle ID (required for iOS)
options optional	object	Driver-specific uninstall options

Returns

• <boolean> didRemovalSucceed: Return true if uninstall was successful, false if not

Support

---

terminateApp

Terminate the given app on the device

Appium command. More details can be found in the official protocol docs.

Usage

driver.terminateApp(appId, bundleId, options)

Parameters

Name	Type	Details
appId optional	string	App package ID (required for Android)
bundleId optional	string	Bundle ID (required for iOS)
options optional	object	Driver-specific termination options

Support

---

isAppInstalled

Check whether the specified app is installed on the device.

Appium command. More details can be found in the official protocol docs.

Usage

driver.isAppInstalled(appId, bundleId)

Parameters

Name	Type	Details
appId optional	string	App package ID (required for Android)
bundleId optional	string	Bundle ID (required for iOS)

Returns

• <boolean> isAppInstalled: Return true if installed, false if not

Support

---

queryAppState

Get the given app status on the device

Appium command. More details can be found in the official protocol docs.

Usage

driver.queryAppState(appId, bundleId)

Parameters

Name	Type	Details
appId optional	string	App package ID (required for Android)
bundleId optional	string	Bundle ID (required for iOS)

Returns

• <number> appStatus: 0 is not installed. 1 is not running. 2 is running in background suspended. 3 is running in background. 4 is running in foreground

Support

---

hideKeyboard

Hide soft keyboard.

Appium command. More details can be found in the official protocol docs.

Usage

driver.hideKeyboard(strategy, key, keyCode, keyName)

Parameters

Name	Type	Details
strategy optional	string	hide keyboard strategy (UIAutomation only), available strategies - 'press', 'pressKey', 'swipeDown', 'tapOut', 'tapOutside', 'default'
key optional	string	key value if strategy is 'pressKey'
keyCode optional	string	key code if strategy is 'pressKey'
keyName optional	string	key name if strategy is 'pressKey'

Support

---

isKeyboardShown

Whether or not the soft keyboard is shown.

Appium command. More details can be found in the official protocol docs.

Usage

driver.isKeyboardShown()

Returns

• <boolean> isKeyboardShown: True if the keyboard is shown

Support

---

pushFile

Place a file onto the device in a particular place.

Appium command. More details can be found in the official protocol docs.

Usage

driver.pushFile(path, data)

Parameters

Name	Type	Details
path	string	path to install the data to
data	string	contents of file in base64

Support

---

pullFile

Retrieve a file from the device's file system.

Appium command. More details can be found in the official protocol docs.

Usage

driver.pullFile(path)

Parameters

Name	Type	Details
path	string	path on the device to pull file from

Returns

• <string> response: Contents of file in base64

Support

---

pullFolder

Retrieve a folder from the device's file system.

Appium command. More details can be found in the official protocol docs.

Usage

driver.pullFolder(path)

Parameters

Name	Type	Details
path	string	path to an entire folder on the device

Returns

• <string> response: Zip file of the folder contents in base64

Support

---

toggleAirplaneMode

Toggle airplane mode on device.

Appium command. More details can be found in the official protocol docs.

caution

This protocol command is deprecated
Use driver.execute('mobile: setConnectivity', { ... }) instead

Usage

driver.toggleAirplaneMode()

Support

---

toggleData

Switch the state of data service.

Appium command. More details can be found in the official protocol docs.

caution

This protocol command is deprecated
Use driver.execute('mobile: setConnectivity', { ... }) instead

Usage

driver.toggleData()

Support

---

toggleWiFi

Switch the state of the wifi service.

Appium command. More details can be found in the official protocol docs.

caution

This protocol command is deprecated
Use driver.execute('mobile: setConnectivity', { ... }) instead

Usage

driver.toggleWiFi()

Support

---

toggleLocationServices

Switch the state of the location service.

Appium command. More details can be found in the official protocol docs.

caution

This protocol command is deprecated
Use driver.execute('mobile: toggleGps') instead

Usage

driver.toggleLocationServices()

Support

---

toggleNetworkSpeed

Set network speed (Emulator only)

Appium command. More details can be found in the official protocol docs.

caution

This protocol command is deprecated
Use driver.execute('mobile: networkSpeed', { ... }) instead

Usage

driver.toggleNetworkSpeed(netspeed)

Parameters

Name	Type	Details
netspeed	string	Network type - 'full','gsm', 'edge', 'hscsd', 'gprs', 'umts', 'hsdpa', 'lte', 'evdo'

Support

---

openNotifications

Open Android notifications.

Appium command. More details can be found in the official protocol docs.

caution

This protocol command is deprecated
Use driver.execute('mobile: openNotifications') or driver.execute('mobile: statusBar', { ... }) instead

Usage

driver.openNotifications()

Support

---

startActivity

Start an Android activity by providing package name and activity name.

Appium command. More details can be found in the official protocol docs.

caution

This protocol command is deprecated
Use driver.execute('mobile: startActivity', { ... }) instead

Usage

driver.startActivity(appPackage, appActivity, appWaitPackage, appWaitActivity, intentAction, intentCategory, intentFlags, optionalIntentArguments, dontStopAppOnReset)

Parameters

Name	Type	Details
appPackage	string	name of app
appActivity	string	name of activity
appWaitPackage optional	string	name of app to wait for
appWaitActivity optional	string	name of activity to wait for
intentAction=android.intent.action.MAIN optional	string	intent action which will be used to start activity
intentCategory=android.intent.category.LAUNCHER optional	string	intent category which will be used to start activity
intentFlags=0x10200000 optional	string	flags that will be used to start activity
optionalIntentArguments optional	string	additional intent arguments that will be used to start activity
dontStopAppOnReset optional	string	doesn’t stop the process of the app under test, before starting the app using adb

Support

---

getSystemBars

Retrieve visibility and bounds information of the status and navigation bars.

Appium command. More details can be found in the official protocol docs.

caution

This protocol command is deprecated
Use driver.execute('mobile: getSystemBars') instead

Usage

driver.getSystemBars()

Returns

• <object[]> systemBars: Information about visibility and bounds of status and navigation bar

Support

---

getDeviceTime

Get the time on the device.

Appium command. More details can be found in the official protocol docs.

Usage

driver.getDeviceTime()

Returns

• <string> time: Time on the device

Support

---

getDisplayDensity

Get display density from device.

Appium command. More details can be found in the official protocol docs.

caution

This protocol command is deprecated
Use driver.execute('mobile: getDisplayDensity') instead

Usage

driver.getDisplayDensity()

Returns

• <*>

Support

---

touchId

Simulate a touch id event (iOS Simulator only). To enable this feature, the allowTouchIdEnroll desired capability must be set to true and the Simulator must be enrolled. When you set allowTouchIdEnroll to true, it will set the Simulator to be enrolled by default. The enrollment state can be toggled. This call will only work if Appium process or its parent application (e.g. Terminal.app or Appium.app) has access to Mac OS accessibility in System Preferences > Security & Privacy > Privacy > Accessibility list.

Appium command. More details can be found in the official protocol docs.

caution

This protocol command is deprecated
Use driver.execute('mobile: sendBiometricMatch', { ... }) instead

Usage

driver.touchId(match)

Parameters

Name	Type	Details
match	boolean	are we simulating a successful touch (true) or a failed touch (false)

Support

---

toggleEnrollTouchId

Toggle the simulator being enrolled to accept touchId (iOS Simulator only). To enable this feature, the allowTouchIdEnroll desired capability must be set to true. When allowTouchIdEnroll is set to true the Simulator will be enrolled by default, and the 'Toggle Touch ID Enrollment' changes the enrollment state. This call will only work if the Appium process or its parent application (e.g., Terminal.app or Appium.app) has access to Mac OS accessibility in System Preferences > Security & Privacy > Privacy > Accessibility list.

Appium command. More details can be found in the official protocol docs.

caution

This protocol command is deprecated
Use driver.execute('mobile: enrollBiometric', { ... }) instead

Usage

driver.toggleEnrollTouchId(enabled)

Parameters

Name	Type	Details
enabled=true optional	boolean	equals to true if TouchID enrollment should be enabled

Support

---

launchApp

Launch an app on device.

Appium command. More details can be found in the official protocol docs.

caution

This protocol command is deprecated
Use driver.execute('mobile: launchApp', { ... }) (iOS) or driver.execute('mobile: activateApp', { ... }) (Android) instead

Usage

driver.launchApp()

Support

---

closeApp

Close an app on device.

Appium command. More details can be found in the official protocol docs.

caution

This protocol command is deprecated
Use driver.execute('mobile: terminateApp', { ... }) instead

Usage

driver.closeApp()

Support

---

background

Send the currently running app for this session to the background.

Appium command. More details can be found in the official protocol docs.

caution

This protocol command is deprecated
Use driver.execute('mobile: backgroundApp', { ... }) instead

Usage

driver.background(seconds)

Parameters

Name	Type	Details
seconds=null	number, null	Timeout after which to restore the app. A value of -1 disables the timeout

Support

---

endCoverage

Get test coverage data.

Appium command. More details can be found in the official protocol docs.

caution

This protocol command is deprecated
Use driver.execute('mobile: shell', { ... }) instead

Usage

driver.endCoverage(intent, path)

Parameters

Name	Type	Details
intent	string	intent to broadcast
path	string	path to .ec file

Support

---

getStrings

Get app strings.

Appium command. More details can be found in the official protocol docs.

caution

This protocol command is deprecated
Use driver.execute('mobile: getAppStrings', { ... }) instead

Usage

driver.getStrings(language, stringFile)

Parameters

Name	Type	Details
language optional	string	language code
stringFile optional	string	path to the string file

Returns

• <object> appStrings: all defined Strings from an app for the specified language and strings filename

Support

---

setValueImmediate

Appium command. More details can be found in the official protocol docs.

caution

This protocol command is deprecated
Use driver.addValue(...) or driver.setValue(...) instead

Usage

driver.setValueImmediate(elementId, text)

Parameters

Name	Type	Details
elementId	String	the id of an element returned in a previous call to Find Element(s)
text	string	text to set to an element

Support

---

replaceValue

Replace the value to element directly.

Appium command. More details can be found in the official protocol docs.

caution

This protocol command is deprecated
Use driver.addValue(...) or driver.setValue(...) instead

Usage

driver.replaceValue(elementId, value)

Parameters

Name	Type	Details
elementId	String	the id of an element returned in a previous call to Find Element(s)
value	string	value to replace on element

Support

---

getSettings

Retrieve the current session settings.

Appium command. More details can be found in the official protocol docs.

Usage

driver.getSettings()

Returns

• <object> settings: JSON hash of all the currently specified settings, see Settings API

Support

---

updateSettings

Update the session settings.

Appium command. More details can be found in the official protocol docs.

Usage

driver.updateSettings(settings)

Parameters

Name	Type	Details
settings	object	key/value object with settings to update

Support

---

receiveAsyncResponse

Callback url for asynchronous execution of JavaScript.

Appium command. More details can be found in the official protocol docs.

caution

This protocol command is deprecated
Use driver.executeAsyncScript(...) instead

Usage

driver.receiveAsyncResponse(response)

Parameters

Name	Type	Details
response	object	response to receive on device

Support

---

gsmCall

Make GSM call (Emulator only).

Appium command. More details can be found in the official protocol docs.

caution

This protocol command is deprecated
Use driver.execute('mobile: gsmCall', { ... }) instead

Usage

driver.gsmCall(phoneNumber, action)

Parameters

Name	Type	Details
phoneNumber	string	the phone number to call to
action	string	The action - 'call', 'accept', 'cancel', 'hold'

Support

---

gsmSignal

Set GSM signal strength (Emulator only).

Appium command. More details can be found in the official protocol docs.

caution

This protocol command is deprecated
Use driver.execute('mobile: gsmSignal', { ... }) instead

Usage

driver.gsmSignal(signalStrength, signalStrengh)

Parameters

Name	Type	Details
signalStrength	string	signal strength in the range [0, 4]
signalStrengh optional	string	signal strength in the range [0, 4]. Please also set this parameter with the same value if you use Appium v1.11.0 or lower (see https://github.com/appium/appium/issues/12234).

Support

---

powerCapacity

Set the battery percentage (Emulator only).

Appium command. More details can be found in the official protocol docs.

caution

This protocol command is deprecated
Use driver.execute('mobile: powerCapacity', { ... }) instead

Usage

driver.powerCapacity(percent)

Parameters

Name	Type	Details
percent	number	percentage value in range [0, 100]

Support

---

powerAC

Set the state of the battery charger to connected or not (Emulator only).

Appium command. More details can be found in the official protocol docs.

caution

This protocol command is deprecated
Use driver.execute('mobile: powerAC', { ... }) instead

Usage

driver.powerAC(state)

Parameters

Name	Type	Details
state	string	set the state. on or off

Support

---

gsmVoice

Set GSM voice state (Emulator only).

Appium command. More details can be found in the official protocol docs.

caution

This protocol command is deprecated
Use driver.execute('mobile: gsmVoice', { ... }) instead

Usage

driver.gsmVoice(state)

Parameters

Name	Type	Details
state	string	state of GSM voice - 'unregistered', 'home', 'roaming', 'searching', 'denied', 'off', 'on'

Support

---

sendSms

Simulate an SMS message (Emulator only).

Appium command. More details can be found in the official protocol docs.

caution

This protocol command is deprecated
Use driver.execute('mobile: sendSms', { ... }) instead

Usage

driver.sendSms(phoneNumber, message)

Parameters

Name	Type	Details
phoneNumber	string	the phone number to send the SMS too
message	string	the SMS message

Support

---

fingerPrint

Authenticate users by using their finger print scans on supported emulators.

Appium command. More details can be found in the official protocol docs.

caution

This protocol command is deprecated
Use driver.execute('mobile: fingerPrint', { ... }) instead

Usage

driver.fingerPrint(fingerprintId)

Parameters

Name	Type	Details
fingerprintId	number	finger prints stored in Android Keystore system (from 1 to 10)

Support

---

setClipboard

Set the content of the system clipboard

Appium command. More details can be found in the official protocol docs.

caution

This protocol command is deprecated
Use driver.execute('mobile: setClipboard', { ... }) instead

Usage

driver.setClipboard(content, contentType, label)

Parameters

Name	Type	Details
content	string	The actual base64 encoded clipboard content
contentType optional	string	The type of the content to get. Plaintext, Image, URL. Android supports only plaintext
label optional	string	Clipboard data label for Android

Returns

• <string> response: Response from Appium server

Support

---

getClipboard

Get the content of the system clipboard

Appium command. More details can be found in the official protocol docs.

caution

This protocol command is deprecated
Use driver.execute('mobile: getClipboard', { ... }) instead

Usage

driver.getClipboard(contentType)

Parameters

Name	Type	Details
contentType optional	string	The type of the content to get. Plaintext, Image, URL. Android supports only plaintext

Returns

• <string> response: Clipboard content as base64-encoded string or an empty string if the clipboard is empty

Support

---

touchPerform

This functionality is only available from within a native context. 'Touch Perform' works similarly to the other singular touch interactions, except that this allows you to chain together more than one touch action as one command. This is useful because Appium commands are sent over the network and there's latency between commands. This latency can make certain touch interactions impossible because some interactions need to be performed in one sequence. Vertical, for example, requires pressing down, moving to a different y coordinate, and then releasing. For it to work, there can't be a delay between the interactions.

Appium command. More details can be found in the official protocol docs.

caution

This protocol command is deprecated
Use driver.performActions(...) instead

Usage

driver.touchPerform(actions)

Parameters

Name	Type	Details
actions	object[]	The type of action to perform (e.g. moveTo, release, press, tap, wait)

Example

// do a horizontal swipe by percentage
const startPercentage = 10;
const endPercentage = 90;
const anchorPercentage = 50;

const { width, height } = driver.getWindowSize();
const anchor = height * anchorPercentage / 100;
const startPoint = width * startPercentage / 100;
const endPoint = width * endPercentage / 100;
driver.touchPerform([
  {
    action: 'press',
    options: {
      x: startPoint,
      y: anchor,
    },
  },
  {
    action: 'wait',
    options: {
      ms: 100,
    },
  },
  {
    action: 'moveTo',
    options: {
      x: endPoint,
      y: anchor,
    },
  },
  {
    action: 'release',
    options: {},
  },
]);

Support

---

multiTouchPerform

This functionality is only available from within a native context. Perform a multi touch action sequence.

Appium command. More details can be found in the official protocol docs.

caution

This protocol command is deprecated
Use driver.performActions(...) instead

Usage

driver.multiTouchPerform(actions)

Parameters

Name	Type	Details
actions	object[]	The type of action to perform (e.g. moveTo, release, press, tap, wait)

Support

---

executeDriverScript

Execute a script in a child process. This approach helps minimize potential latency associated with each command. Using this command in Appium 2 or later requires installing the execute-driver plugin.

Appium command. More details can be found in the official protocol docs.

Usage

driver.executeDriverScript(script, type, timeout)

Parameters

Name	Type	Details
script	string	The script to execute. It has access to a 'driver' object which represents a WebdriverIO session attached to the current server.
type optional	string	The language/framework used in the script. Currently, only 'webdriverio' is supported and is the default.
timeout optional	number	The number of milliseconds the script should be allowed to run before being killed by the Appium server. Defaults to the equivalent of 1 hour.

Returns

• <object> result: An object containing two fields: 'result', which is the return value of the script itself, and 'logs', which contains 3 inner fields, 'log', 'warn', and 'error', which hold an array of strings logged by console.log, console.warn, and console.error in the script's execution.

---

getEvents

Get events logged in the current session.

Appium command. More details can be found in the official protocol docs.

Usage

driver.getEvents(type)

Parameters

Name	Type	Details
type optional	string, string[]	One or more event types to filter the returned events

Returns

• <object> result: A JSON hash of events like {'commands' => [{'cmd' => 123455, ....}], 'startTime' => 1572954894127, }.

Support

---

logEvent

Log a custom event.

Appium command. More details can be found in the official protocol docs.

Usage

driver.logEvent(vendor, event)

Parameters

Name	Type	Details
vendor	string	Name of the namespace (vendor) used to prefix the event
event	string	Name of the event

Support

---

compareImages

Compare two images using the specified mode of comparison. Using this command in Appium 2 or later requires installing the images plugin.

Appium command. More details can be found in the official protocol docs.

Usage

driver.compareImages(mode, firstImage, secondImage, options)

Parameters

Name	Type	Details
mode	string	One of possible comparison modes: 'matchFeatures', 'getSimilarity', 'matchTemplate'.
firstImage	string	Base64-encoded image file.
secondImage	string	Base64-encoded image file.
options=[object Object] optional	object	The supported values of this property depend on the mode value. See Appium documentation for more details.

Returns

• <object> result: The content of the resulting dictionary depends on the mode and options values. See Appium documentation for more details.

---

implicitWait

Set the amount of time the driver should wait when searching for elements. When searching for a single element, the driver should poll the page until an element is found or the timeout expires, whichever occurs first. When searching for multiple elements, the driver should poll the page until at least one element is found or the timeout expires, at which point it should return an empty list. If this command is never sent, the driver should default to an implicit wait of 0ms.

Appium command. More details can be found in the official protocol docs.

caution

This protocol command is deprecated
Use driver.setTimeouts(...) instead

Usage

driver.implicitWait(ms)

Parameters

Name	Type	Details
ms	number	The amount of time, in milliseconds, to wait on an element.

Support

---

getLocationInView

Determine an element's location on the screen once it has been scrolled into view.

Note: This is considered an internal command and should only be used to determine an element's location for correctly generating native events.

Appium command. More details can be found in the official protocol docs.

caution

This protocol command is deprecated
Use driver.getElementRect(...) or element.getLocation() instead

Usage

driver.getLocationInView(elementId)

Parameters

Name	Type	Details
elementId	String	ID of the element to route the command to

Returns

• <Object> location: The X and Y coordinates for the element on the page.

Support

---

sendKeys

Send a sequence of key strokes to the active element

Appium command. More details can be found in the official protocol docs.

caution

This protocol command is deprecated
Use driver.performActions(...) with keyUp and keyDown actions instead

Usage

driver.sendKeys(value)

Parameters

Name	Type	Details
value	string[]	The sequence of keys to type. An array must be provided.

Support

---

availableIMEEngines

List all available IME engines on the device. To use an engine, it has to be present in this list.

Appium command. More details can be found in the official protocol docs.

Usage

driver.availableIMEEngines()

Returns

• <String[]> engines: A list of available engines

Support

---

getActiveIMEEngine

Get the name of the active IME engine. The name string is platform specific.

Appium command. More details can be found in the official protocol docs.

Usage

driver.getActiveIMEEngine()

Returns

• <String> engine: The name of the active IME engine

Support

---

isIMEActivated

Indicates whether IME input is active at the moment

Appium command. More details can be found in the official protocol docs.

Usage

driver.isIMEActivated()

Returns

• <Boolean> isActive: true if IME input is available and currently active, false otherwise

Support

---

deactivateIMEEngine

De-activates the currently-active IME engine.

Appium command. More details can be found in the official protocol docs.

Usage

driver.deactivateIMEEngine()

Support

---

activateIMEEngine

Activates an IME engine.

Appium command. More details can be found in the official protocol docs.

Usage

driver.activateIMEEngine(engine)

Parameters

Name	Type	Details
engine	string	name of the engine to activate

Support

---

asyncScriptTimeout

Set the amount of time, in milliseconds, that asynchronous scripts executed by /session/:sessionId/execute_async are permitted to run before they are aborted and a Timeout error is returned to the client.

Appium command. More details can be found in the official protocol docs.

caution

This protocol command is deprecated
Use driver.setTimeouts(...) instead

Usage

driver.asyncScriptTimeout(ms)

Parameters

Name	Type	Details
ms	number	The amount of time, in milliseconds, that time-limited commands are permitted to run

Support

---

submit

Submit a form element.

Appium command. More details can be found in the official protocol docs.

caution

This protocol command is deprecated
Please explicitly find and click the submit element

Usage

driver.submit(elementId)

Parameters

Name	Type	Details
elementId	String	ID of the form element to be submitted

Support

---

getElementSize

Determine an element's size in pixels. The size will be returned as a JSON object with width and height properties.

Appium command. More details can be found in the official protocol docs.

caution

This protocol command is deprecated
Use driver.getElementRect(...) or element.getSize() instead

Usage

driver.getElementSize(elementId)

Parameters

Name	Type	Details
elementId	String	ID of the element to route the command to

Returns

• <Object> size: The width and height of the element, in pixels.

Support

---

getElementLocation

Determine an element's location on the page. The point (0, 0) refers to the upper-left corner of the page. The element's coordinates are returned as a JSON object with x and y properties.

Appium command. More details can be found in the official protocol docs.

caution

This protocol command is deprecated
Use driver.getElementRect(...) or element.getLocation() instead

Usage

driver.getElementLocation(elementId)

Parameters

Name	Type	Details
elementId	String	ID of the element to route the command to

Returns

• <Object> location: The X and Y coordinates for the element on the page.

Support

---

touchClick

Single tap on the touch enabled device.

Appium command. More details can be found in the official protocol docs.

caution

This protocol command is deprecated
Use driver.performActions(...) with pointerDown and pointerUp actions instead

Usage

driver.touchClick(element)

Parameters

Name	Type	Details
element	string	ID of the element to single tap on.

Support

---

touchDown

Finger down on the screen.

Appium command. More details can be found in the official protocol docs.

caution

This protocol command is deprecated
Use driver.performActions(...) with a pointerDown action instead

Usage

driver.touchDown(x, y)

Parameters

Name	Type	Details
x	number	x coordinate on the screen
y	number	y coordinate on the screen

Support

---

touchUp

Finger up on the screen.

Appium command. More details can be found in the official protocol docs.

caution

This protocol command is deprecated
Use driver.performActions(...) with a pointerUp action instead

Usage

driver.touchUp(x, y)

Parameters

Name	Type	Details
x	number	x coordinate on the screen
y	number	y coordinate on the screen

Support

---

touchMove

Finger move on the screen.

Appium command. More details can be found in the official protocol docs.

caution

This protocol command is deprecated
Use driver.performActions(...) with a pointerMove action instead

Usage

driver.touchMove(x, y)

Parameters

Name	Type	Details
x	number	x coordinate on the screen
y	number	y coordinate on the screen

Support

---

touchLongClick

Long press on the touch screen using finger motion events.

Appium command. More details can be found in the official protocol docs.

caution

This protocol command is deprecated
Use driver.performActions(...) with pointerDown, pause and pointerUp actions instead

Usage

driver.touchLongClick(element)

Parameters

Name	Type	Details
element	string	ID of the element to long press on

Support

---

touchFlick

Flick on the touch screen using finger motion events. This flick command starts at a particular screen location.

Appium command. More details can be found in the official protocol docs.

caution

This protocol command is deprecated
Use driver.performActions(...) with pointerDown, pointerMove and pointerUp actions instead

Usage

driver.touchFlick(xoffset, yoffset, element, speed, xspeed, yspeed)

Parameters

Name	Type	Details
xoffset optional	number	the x offset in pixels to flick by
yoffset optional	number	the y offset in pixels to flick by
element optional	string	ID of the element where the flick starts
speed optional	number	the speed in pixels per seconds
xspeed optional	number	the x speed in pixels per second
yspeed optional	number	the y speed in pixels per second

Support

---

getOrientation

Get the current device orientation.

Appium command. More details can be found in the official protocol docs.

Usage

driver.getOrientation()

Returns

• <String> orientation: The current orientation corresponding to a value defined in ScreenOrientation: LANDSCAPE|PORTRAIT.

Support

---

setOrientation

Set the device orientation

Appium command. More details can be found in the official protocol docs.

Usage

driver.setOrientation(orientation)

Parameters

Name	Type	Details
orientation	string	the new browser orientation as defined in ScreenOrientation: LANDSCAPE|PORTRAIT

Support

---

getGeoLocation

Get the current geo location.

Appium command. More details can be found in the official protocol docs.

Usage

driver.getGeoLocation()

Returns

• <Object> location: The current geo location.

---

setGeoLocation

Set the current geo location.

Appium command. More details can be found in the official protocol docs.

Usage

driver.setGeoLocation(location)

Parameters

Name	Type	Details
location	object	the new location ({latitude: number, longitude: number, altitude: number})