Appium Service Keywords

Key Words	Description	Example
automationName	The automated test engine you want to use	Appium(default) orSelendroid
platformName	The phone operating system you want to test	iOS, Android , orFirefoxOS
platformVersion	Mobile OS Version	For example: 7.1 ,4.4
deviceName	Type of phone or simulator used	iPhone Simulator,,,, iPad Simulator iPhone Retina 4-inch Android Emulator Galaxy S4 , et. On IOS, the value of this keyword must be one of the instruments -s devices available device names that are used. On Android, this keyword does not work at this time.
app	.ipa or .apk file is located in the local absolute path or remote path, or it can be one of the two Code class= "Prettyprint" >.zip . Appium will first try to install the path corresponding to the application on the appropriate real machine or simulator. For Android Systems, if you specify app-package and app-activity ( See below), then you can not specify app . will conflict with browsername	/abs/path/to/my.apk or http://myapp.com/app.ipa
browserName	The name of the mobile Web browser that requires automated testing. If you are automating your application, the value of this keyword should be empty.	The IOS system can be used with ' Safari ', Android system can be ' Chrome ', ' Chromium ', or ' Browser '.
newCommandTimeout	Sets the command time-out, in seconds. When the timeout is reached and the new command is not received, Appium assumes that the client exits and then ends the session automatically.	Like what60
autoLaunch	Appium whether the app needs to be installed and started automatically. Default valuetrue	true,false
language	(sim/emu-only) Sets the language of the simulator (Simulator/emulator).	Such as:fr
locale	(sim/emu-only) Sets the locale of the simulator (Simulator/emulator).	Such as:fr_CA
udid	Unique device identity of the connected physical device	Such as:1ae203187fc012g
orientation	(sim/emu-only) to start the test in a set direction mode	LANDSCAPE(landscape) or PORTRAIT (portrait)
autoWebview	Translates directly to the WebView context. Default Value false ,	true,false
noReset	Do not reset the app state before the session. The default value false .	true,false
fullReset	(IOS) To delete the entire emulator directory. (Android) resets the app state by uninstalling-rather than emptying the data. On Android, this also automatically clears the app under test at the end of the session. Default valuefalse	true,false

Android Specific

Key Words	Description	Example
appActivity	The Android Activity name you want to launch from your app package. It usually needs to be added in front . (e.g., use .MainActivity instead of MainActivity )	MainActivity,.Settings
appPackage	The package name of the Android app you want to run	For example com.example.android.myApp ,com.android.settings
appWaitActivity	You want to wait for the Android Activity name to start	SplashActivity
deviceReadyTimeout	Set a timeout to wait for an emulator or a real machine to be ready	5
androidCoverage	The instrumentation class used to perform the test. As a adb shell am instrument -e coverage true -w parameter to the command -w .	com.my.Pkg/com.my.Pkg.instrumentation.MyInstrumentation
enablePerformanceLogging	(Chrome and WebView only) turn on Chromedriver Performance Logs. (Default false )	true,false
androidDeviceReadyTimeout	Wait for the device to be ready when the app is started. The unit is in seconds.	Such as30
androidDeviceSocket	The socket name of the development tool. Required only if the application being tested is a browser that uses the Chromium kernel. The socket is opened by the browser and chromedriver it as a developer tool to connect.	Such aschrome_devtools_remote
avd	The name of the AVD (Android virtual appliance) that needs to be started.	Such asapi19
avdLaunchTimeout	The time-out in milliseconds to wait for the AVD to start and connect to the ADB. (Default value 120000 )	300000
avdReadyTimeout	The time-out in milliseconds to wait for the AVD to finish starting the animation. (Default value 120000 )	300000
avdArgs	Additional parameters that need to be added when starting the AVD.	Such as-netfast
useKeystore	Use a custom KeyStore to re-sign the APK. Default valuefalse	trueOrfalse
keystorePath	The path to the custom KeyStore. Default: ~/.android/debug.keystore	Such as/path/to.keystore
keystorePassword	Customize the password for the KeyStore.	Such asfoo
keyAlias	Alias for Key	Such asandroiddebugkey
keyPassword	Key's password	Such asfoo
chromedriverExecutable	Webdriver the absolute path to the executable file (if the Chromium core provides the corresponding webdriver, it should be used instead of Appium's own webdriver)	/abs/path/to/webdriver
autoWebviewTimeout	The time, in milliseconds, to wait for the Webview context to be activated. Default value2000	Such as4
intentAction	The intent action used to start the activity. (Default value android.intent.action.MAIN )	such as android.intent.action.MAIN ,android.intent.action.VIEW
intentCategory	The intent category used to initiate activity. (Default value android.intent.category.LAUNCHER )	such as android.intent.category.LAUNCHER ,android.intent.category.APP_CONTACTS
intentFlags	Flags (default) for initiating activity 0x10200000	Such as0x10200000
optionalIntentArguments	The additional intent parameter used to initiate activity. Please see the Intent parameter	such as --esn <EXTRA_KEY> ,--ez <EXTRA_KEY> <EXTRA_BOOLEAN_VALUE>
stopAppOnReset	Stop the process of the app being tested before using ADB to start the app. If the application being tested is created by another application, when this parameter is set to False, the process that allows another app to continue to survive when using ADB to initiate the application under test. Default valuetrue	trueOrfalse
unicodeKeyboard	Use the Unicode input method. Default valuefalse	trueOrfalse
resetKeyboard	After the Unicode test for the keyword has been set, reset the unicodeKeyboard input method to its original state. If used alone, it will be ignored. Default valuefalse	trueOrfalse
noSign	Skip the steps to check and debug your app. Can only be used when using Uiautomator, using selendroid is not possible. Default valuefalse	trueOrfalse
ignoreUnimportantViews	Call the Uiautomator function setCompressedLayoutHierarchy() . Because the accessibility command performs faster when some elements are ignored, this keyword can speed up the test execution. Ignored elements will not be found, so this keyword is also implemented as a * setting (settings) * that can be changed at any time. Default valuefalse	trueOrfalse

Appium Service Keywords