io.appium.java_client.service.local.flags

Enum AndroidServerFlag

java.lang.Object

java.lang.Enum<AndroidServerFlag>

io.appium.java_client.service.local.flags.AndroidServerFlag

All Implemented Interfaces:

ServerArgument, Serializable, Comparable<AndroidServerFlag>

public enum AndroidServerFlag
extends Enum<AndroidServerFlag>
implements ServerArgument

Here is the list of Android specific server arguments. All flags are optional, but some are required in conjunction with certain others. The full list is available here: http://appium.io/slate/en/master/?ruby#appium-server-arguments Android specific arguments are marked by (Android-only)

Enum Constant Summary

Enum Constants

Enum Constant and Description
ACTIVITY Activity name for the Android activity you want to launch from your package (e.g., MainActivity) Sample: --app-activity MainActivity
ANDROID_COVERAGE Fully qualified instrumentation class.
APP_WAIT_ACTIVITY Activity name for the Android activity you want to wait for (e.g., SplashActivity) Sample: --app-wait-activity SplashActivity
APP_WAIT_PACKAGE Package name for the Android activity you want to wait for (e.g., com.example.android.MyApp) Sample: --app-wait-package com.example.android.MyApp
AVD Name of the avd to launch Sample: --avd @default
AVD_ARGS Additional emulator arguments to launch the avd Sample: --avd-args -no-snapshot-load
BOOTSTRAP_PORT_NUMBER Port to use on device to talk to Appium Sample: --bootstrap-port 4724
DEVICE_READY_TIMEOUT Timeout in seconds while waiting for device to become ready Sample: --device-ready-timeout 5
DO_NOT_STOP_APP_ON_RESET When included, refrains from stopping the app before restart Default: false
INTENT_ACTION Intent action which will be used to start activity Default: android.intent.action.MAIN Sample: --intent-action android.intent.action.MAIN
INTENT_ARGUMENTS Additional intent arguments that will be used to start activity Default: null Sample: --intent-args 0x10200000
INTENT_CATEGORY Intent category which will be used to start activity Default: android.intent.category.LAUNCHER Sample: --intent-category android.intent.category.APP_CONTACTS
INTENT_FLAGS Flags that will be used to start activity Default: 0x10200000 Sample: --intent-flags 0x10200000
KEY_ALIAS Key alias Default: androiddebugkey
KEY_PASSWORD Key password Default: android
KEY_STORE_PASSWORD Password to keystore Default: android
KEY_STORE_PATH Path to keystore Sample: --keystore-path /Users/user/.android/debug.keystore
PACKAGE Java package of the Android app you want to run (e.g., com.example.android.MyApp) Sample: --app-pkg com.example.android.MyApp
SELENDROID_PORT Local port used for communication with Selendroid Sample: --selendroid-port 8080
SUPPRESS_ADB_KILL_SERVER If set, prevents Appium from killing the adb server instance Default: false
USE_KEY_STORE When set the keystore will be used to sign apks. Default: false

Method Summary

Methods

Modifier and Type	Method and Description
String	getArgument()
static AndroidServerFlag	valueOf(String name) Returns the enum constant of this type with the specified name.
static AndroidServerFlag[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

BOOTSTRAP_PORT_NUMBER

public static final AndroidServerFlag BOOTSTRAP_PORT_NUMBER

Port to use on device to talk to Appium
Sample:
--bootstrap-port 4724

PACKAGE

public static final AndroidServerFlag PACKAGE

Java package of the Android app you want to run (e.g., com.example.android.MyApp)
Sample:
--app-pkg com.example.android.MyApp

ACTIVITY

public static final AndroidServerFlag ACTIVITY

Activity name for the Android activity you want to launch from your package (e.g., MainActivity)
Sample:
--app-activity MainActivity

APP_WAIT_PACKAGE

public static final AndroidServerFlag APP_WAIT_PACKAGE

Package name for the Android activity you want to wait for (e.g., com.example.android.MyApp)
Sample:
--app-wait-package com.example.android.MyApp

APP_WAIT_ACTIVITY

public static final AndroidServerFlag APP_WAIT_ACTIVITY

Activity name for the Android activity you want to wait for (e.g., SplashActivity) Sample:
--app-wait-activity SplashActivity

ANDROID_COVERAGE

public static final AndroidServerFlag ANDROID_COVERAGE

Fully qualified instrumentation class. Passed to -w in adb shell am instrument -e coverage true -w
Sample:
--android-coverage com.my.Pkg/com.my.Pkg.instrumentation.MyInstrumentation

AVD

public static final AndroidServerFlag AVD

Name of the avd to launch
Sample:
--avd @default

AVD_ARGS

public static final AndroidServerFlag AVD_ARGS

Additional emulator arguments to launch the avd
Sample:
--avd-args -no-snapshot-load

DEVICE_READY_TIMEOUT

public static final AndroidServerFlag DEVICE_READY_TIMEOUT

Timeout in seconds while waiting for device to become ready
Sample:
--device-ready-timeout 5

SELENDROID_PORT

public static final AndroidServerFlag SELENDROID_PORT

Local port used for communication with Selendroid
Sample:
--selendroid-port 8080

USE_KEY_STORE

public static final AndroidServerFlag USE_KEY_STORE

When set the keystore will be used to sign apks.
Default: false

KEY_STORE_PATH

public static final AndroidServerFlag KEY_STORE_PATH

Path to keystore
Sample:
--keystore-path /Users/user/.android/debug.keystore

KEY_STORE_PASSWORD

public static final AndroidServerFlag KEY_STORE_PASSWORD

Password to keystore
Default: android

KEY_ALIAS

public static final AndroidServerFlag KEY_ALIAS

Key alias
Default: androiddebugkey

KEY_PASSWORD

public static final AndroidServerFlag KEY_PASSWORD

Key password
Default: android

INTENT_ACTION

public static final AndroidServerFlag INTENT_ACTION

Intent action which will be used to start activity
Default: android.intent.action.MAIN
Sample:
--intent-action android.intent.action.MAIN

INTENT_CATEGORY

public static final AndroidServerFlag INTENT_CATEGORY

Intent category which will be used to start activity
Default: android.intent.category.LAUNCHER
Sample:
--intent-category android.intent.category.APP_CONTACTS

INTENT_FLAGS

public static final AndroidServerFlag INTENT_FLAGS

Flags that will be used to start activity
Default: 0x10200000
Sample:
--intent-flags 0x10200000

INTENT_ARGUMENTS

public static final AndroidServerFlag INTENT_ARGUMENTS

Additional intent arguments that will be used to start activity
Default: null
Sample:
--intent-args 0x10200000

DO_NOT_STOP_APP_ON_RESET

public static final AndroidServerFlag DO_NOT_STOP_APP_ON_RESET

When included, refrains from stopping the app before restart
Default: false

SUPPRESS_ADB_KILL_SERVER

public static final AndroidServerFlag SUPPRESS_ADB_KILL_SERVER

If set, prevents Appium from killing the adb server instance
Default: false

Method Detail

values

public static AndroidServerFlag[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (AndroidServerFlag c : AndroidServerFlag.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static AndroidServerFlag valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null

getArgument

public String getArgument()

Specified by:

getArgument in interface ServerArgument