io.appium.java_client.service.local.flags

Enum GeneralServerFlag

java.lang.Object

java.lang.Enum<GeneralServerFlag>

io.appium.java_client.service.local.flags.GeneralServerFlag

All Implemented Interfaces:

ServerArgument, Serializable, Comparable<GeneralServerFlag>

public enum GeneralServerFlag
extends Enum<GeneralServerFlag>
implements ServerArgument

Here is the list of common Appium server arguments.

Enum Constant Summary

Enum Constants

Enum Constant and Description
APP Deprecated.
ASYNC_TRACE Add long stack traces to log entries.
AUTOMATION_NAME Deprecated.
BROWSER_NAME Deprecated.
CALLBACK_ADDRESS callback IP Address (default: same as address).
CALLBACK_PORT callback port (default: same as port).
CHROME_DRIVER_EXECUTABLE Deprecated.
CHROME_DRIVER_PORT Deprecated.
COMMAND_TIMEOUT Deprecated.
CONFIGURATION_FILE Configuration JSON file to register Appium with selenium grid.
DEBUG_LOG_SPACING Add exaggerated spacing in logs to help with visual inspection.
DEVICE_NAME Deprecated.
LANGUAGE Deprecated.
LOCAL_TIMEZONE Use local timezone for timestamps.
LOCALE Deprecated.
LOG_LEVEL The message log level to be shown.
LOG_NO_COLORS Don’t use colors in console output.
LOG_TIMESTAMP Show timestamps in console output.
NO_PERMS_CHECKS Bypass Appium’s checks to ensure we can read/write necessary files.
NO_RESET Deprecated.
PLATFORM_NAME Deprecated.
PLATFORM_VERSION Deprecated.
PRE_LAUNCH Pre-launch the application before allowing the first session (Requires –app and, for Android, –app-pkg and –app-activity).
ROBOT_ADDRESS IP Address of robot.
ROBOT_PORT Port for robot.
SESSION_OVERRIDE Enables session override (clobbering).
SHELL Enter REPL mode
SHOW_CONFIG Show info about the Appium server configuration and exit.
STRICT_CAPS Cause sessions to fail if desired caps are sent in that Appium does not recognize as valid for the selected device.
TEMP_DIRECTORY Absolute path to directory Appium can use to manage temporary files, like built-in iOS apps it needs to move around.
UIID Deprecated.
WEB_HOOK Also send log output to this HTTP listener.

Method Summary

Methods

Modifier and Type	Method and Description
String	getArgument()
static GeneralServerFlag	valueOf(String name) Returns the enum constant of this type with the specified name.
static GeneralServerFlag[]	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

SHELL

public static final GeneralServerFlag SHELL

Enter REPL mode

APP

@Deprecated
public static final GeneralServerFlag APP

Deprecated.

UIID

@Deprecated
public static final GeneralServerFlag UIID

Deprecated.

This flag IS deprecated since appium node 1.5.x. It will be removed in the next release. Be careful.

Unique device identifier of the connected physical device. Sample: --udid 1adsf-sdfas-asdf-123sdf

CALLBACK_ADDRESS

public static final GeneralServerFlag CALLBACK_ADDRESS

callback IP Address (default: same as address). Sample: --callback-address 127.0.0.1

CALLBACK_PORT

public static final GeneralServerFlag CALLBACK_PORT

callback port (default: same as port). Sample: --callback-port 4723

SESSION_OVERRIDE

public static final GeneralServerFlag SESSION_OVERRIDE

Enables session override (clobbering). Default: false

NO_RESET

@Deprecated
public static final GeneralServerFlag NO_RESET

Deprecated.

This flag IS deprecated since appium node 1.5.x. It will be removed in the next release. Be careful.

Don’t reset app state between sessions (IOS: don’t delete app plist files; Android: don’t uninstall app before new session). Default: false

PRE_LAUNCH

public static final GeneralServerFlag PRE_LAUNCH

Pre-launch the application before allowing the first session (Requires –app and, for Android, –app-pkg and –app-activity). Default: false

LOG_LEVEL

public static final GeneralServerFlag LOG_LEVEL

The message log level to be shown. Sample: --log-level debug

LOG_TIMESTAMP

public static final GeneralServerFlag LOG_TIMESTAMP

Show timestamps in console output. Default: false

LOCAL_TIMEZONE

public static final GeneralServerFlag LOCAL_TIMEZONE

Use local timezone for timestamps. Default: false

LOG_NO_COLORS

public static final GeneralServerFlag LOG_NO_COLORS

Don’t use colors in console output. Default: false

WEB_HOOK

public static final GeneralServerFlag WEB_HOOK

Also send log output to this HTTP listener. Sample: --webhook localhost:9876

DEVICE_NAME

@Deprecated
public static final GeneralServerFlag DEVICE_NAME

Deprecated.

This flag IS deprecated since appium node 1.5.x. It will be removed in the next release. Be careful.

Name of the mobile device to use. Sample: --device-name iPhone Retina (4-inch), Android Emulator

PLATFORM_NAME

@Deprecated
public static final GeneralServerFlag PLATFORM_NAME

Deprecated.

This flag IS deprecated since appium node 1.5.x. It will be removed in the next release. Be careful.

Name of the mobile platform: iOS, Android, or FirefoxOS Sample: --platform-name iOS

PLATFORM_VERSION

@Deprecated
public static final GeneralServerFlag PLATFORM_VERSION

Deprecated.

This flag IS deprecated since appium node 1.5.x. It will be removed in the next release. Be careful.

Version of the mobile platform. Sample: --platform-version 7.1

AUTOMATION_NAME

@Deprecated
public static final GeneralServerFlag AUTOMATION_NAME

Deprecated.

This flag IS deprecated since appium node 1.5.x. It will be removed in the next release. Be careful.

Name of the automation tool: Appium or Selendroid. Sample: --automation-name Appium

BROWSER_NAME

@Deprecated
public static final GeneralServerFlag BROWSER_NAME

Deprecated.

This flag IS deprecated since appium node 1.5.x. It will be removed in the next release. Be careful.

Name of the mobile browser: Safari or Chrome. Sample: --browser-name Safari

LANGUAGE

@Deprecated
public static final GeneralServerFlag LANGUAGE

Deprecated.

This flag IS deprecated since appium node 1.5.x. It will be removed in the next release. Be careful.

Language for the iOS simulator / Android Emulator. Sample: --language en

LOCALE

@Deprecated
public static final GeneralServerFlag LOCALE

Deprecated.

This flag IS deprecated since appium node 1.5.x. It will be removed in the next release. Be careful.

Locale for the iOS simulator / Android Emulator. Sample: --locale en_US

CONFIGURATION_FILE

public static final GeneralServerFlag CONFIGURATION_FILE

Configuration JSON file to register Appium with selenium grid. Sample: --nodeconfig /abs/path/to/nodeconfig.json

ROBOT_ADDRESS

public static final GeneralServerFlag ROBOT_ADDRESS

IP Address of robot. Sample: --robot-address 0.0.0.0

ROBOT_PORT

public static final GeneralServerFlag ROBOT_PORT

Port for robot. Sample: --robot-port 4242

CHROME_DRIVER_PORT

@Deprecated
public static final GeneralServerFlag CHROME_DRIVER_PORT

Deprecated.

CHROME_DRIVER_EXECUTABLE

@Deprecated
public static final GeneralServerFlag CHROME_DRIVER_EXECUTABLE

Deprecated.

SHOW_CONFIG

public static final GeneralServerFlag SHOW_CONFIG

Show info about the Appium server configuration and exit. Default: false

NO_PERMS_CHECKS

public static final GeneralServerFlag NO_PERMS_CHECKS

Bypass Appium’s checks to ensure we can read/write necessary files. Default: false

COMMAND_TIMEOUT

@Deprecated
public static final GeneralServerFlag COMMAND_TIMEOUT

Deprecated.

This flag IS deprecated since appium node 1.5.x. It will be removed in the next release. Be careful.

The default command timeout for the server to use for all sessions. Will still be overridden by newCommandTimeout cap. Default: 60

STRICT_CAPS

public static final GeneralServerFlag STRICT_CAPS

Cause sessions to fail if desired caps are sent in that Appium does not recognize as valid for the selected device. Default: false

TEMP_DIRECTORY

public static final GeneralServerFlag TEMP_DIRECTORY

Absolute path to directory Appium can use to manage temporary files, like built-in iOS apps it needs to move around. On *nix/Mac defaults to /tmp, on Windows defaults to C:\Windows\Temp.

DEBUG_LOG_SPACING

public static final GeneralServerFlag DEBUG_LOG_SPACING

Add exaggerated spacing in logs to help with visual inspection. Default: false

ASYNC_TRACE

public static final GeneralServerFlag ASYNC_TRACE

Add long stack traces to log entries. Recommended for debugging only.

Default: false

Method Detail

values

public static GeneralServerFlag[] 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 (GeneralServerFlag c : GeneralServerFlag.values())
    System.out.println(c);

Returns:

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

valueOf

public static GeneralServerFlag 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