io.appium.java_client.service.local.flags

Enum IOSServerFlag

java.lang.Object

java.lang.Enum<IOSServerFlag>

io.appium.java_client.service.local.flags.IOSServerFlag

All Implemented Interfaces:

ServerArgument, Serializable, Comparable<IOSServerFlag>

public enum IOSServerFlag
extends Enum<IOSServerFlag>
implements ServerArgument

Here is the list of iOS specific server arguments.

Enum Constant Summary

Enum Constants

Enum Constant and Description
BACK_END_RETRIES How many times to retry launching Instruments before saying it crashed or timed out.
CALENDAR_FORMAT Deprecated.
CUSTOM_INSTRUMENTS_PATH custom path to the instruments commandline tool.
DEFAULT_DEVICE use the default simulator that instruments launches on its own.
FORCE_IPAD_SIMULATOR Use the iPad Simulator no matter what the app wants.
FORCE_IPHONE_SIMULATOR Use the iPhone Simulator no matter what the app wants.
IPA_ABSOLUTE_PATH absolute path to compiled .ipa file.
ISOLATE_SIM_DEVICE Xcode 6 has a bug on some platforms where a certain simulator can only be launched without error if all other simulator devices are first deleted.
KEEP_KEYCHAINS Deprecated.
LAUNCH_TIMEOUT Deprecated.
LOCALIZABLE_STRING_PATH Deprecated.
ORIENTATION Deprecated.
SAFARI Use the safari app.
SHOW_IOS_LOG Deprecated.
SHOW_SIMULATOR_LOG Deprecated.
TRACE_DIRECTORY_ABSOLUTE_PATH Absolute path to directory Appium use to save ios instruments traces, defaults to /appium-instruments.
TRACE_TEMPLATE_FILE_PATH .tracetemplate file to use with Instruments.
USE_NATIVE_INSTRUMENTS Deprecated.
WEBKIT_DEBUG_PROXY_PORT Local port used for communication with ios-webkit-debug-proxy Default value: 27753 Sample: --webkit-debug-proxy-port 27753

Method Summary

Methods

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

LOCALIZABLE_STRING_PATH

@Deprecated
public static final IOSServerFlag LOCALIZABLE_STRING_PATH

Deprecated.

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

the relative path of the dir where Localizable.strings file resides. Default: en.lproj. Sample: --localizable-strings-dir en.lproj

IPA_ABSOLUTE_PATH

public static final IOSServerFlag IPA_ABSOLUTE_PATH

absolute path to compiled .ipa file. Sample: --ipa /abs/path/to/my.ipa

BACK_END_RETRIES

public static final IOSServerFlag BACK_END_RETRIES

How many times to retry launching Instruments before saying it crashed or timed out. Sample: --backend-retries 3

LAUNCH_TIMEOUT

@Deprecated
public static final IOSServerFlag LAUNCH_TIMEOUT

Deprecated.

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

how long in ms to wait for Instruments to launch. Default: 90000

USE_NATIVE_INSTRUMENTS

@Deprecated
public static final IOSServerFlag USE_NATIVE_INSTRUMENTS

Deprecated.

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

IOS has a weird built-in unavoidable delay. We patch this in appium. If you do not want it patched, pass in this flag. Default: false

SAFARI

public static final IOSServerFlag SAFARI

Use the safari app. Default: false

DEFAULT_DEVICE

public static final IOSServerFlag DEFAULT_DEVICE

use the default simulator that instruments launches on its own. Default: false

FORCE_IPHONE_SIMULATOR

public static final IOSServerFlag FORCE_IPHONE_SIMULATOR

Use the iPhone Simulator no matter what the app wants. Default: false

FORCE_IPAD_SIMULATOR

public static final IOSServerFlag FORCE_IPAD_SIMULATOR

Use the iPad Simulator no matter what the app wants. Default: false

CALENDAR_FORMAT

@Deprecated
public static final IOSServerFlag CALENDAR_FORMAT

Deprecated.

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

Calendar format for the iOS simulator. Default: null Sample: --calendar-format gregorian

ORIENTATION

@Deprecated
public static final IOSServerFlag ORIENTATION

Deprecated.

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

use LANDSCAPE or PORTRAIT to initialize all requests to this orientation. Sample: --orientation LANDSCAPE

TRACE_TEMPLATE_FILE_PATH

public static final IOSServerFlag TRACE_TEMPLATE_FILE_PATH

.tracetemplate file to use with Instruments. Sample: --tracetemplate /Users/me/Automation.tracetemplate

CUSTOM_INSTRUMENTS_PATH

public static final IOSServerFlag CUSTOM_INSTRUMENTS_PATH

custom path to the instruments commandline tool. Sample: --instruments /path/to/instruments

SHOW_SIMULATOR_LOG

@Deprecated
public static final IOSServerFlag SHOW_SIMULATOR_LOG

Deprecated.

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

if set, the iOS simulator log will be written to the console. Default: false

SHOW_IOS_LOG

@Deprecated
public static final IOSServerFlag SHOW_IOS_LOG

Deprecated.

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

if set, the iOS system log will be written to the console. Default: false

KEEP_KEYCHAINS

@Deprecated
public static final IOSServerFlag KEEP_KEYCHAINS

Deprecated.

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

Whether to keep keychains (Library/Keychains) when reset app between sessions. Default: false

ISOLATE_SIM_DEVICE

public static final IOSServerFlag ISOLATE_SIM_DEVICE

Xcode 6 has a bug on some platforms where a certain simulator can only be launched without error if all other simulator devices are first deleted. This option causes Appium to delete all devices other than the one being used by Appium. Note that this is a permanent deletion, and you are responsible for using simctl or xcode to manage the categories of devices used with Appium. Default: false

TRACE_DIRECTORY_ABSOLUTE_PATH

public static final IOSServerFlag TRACE_DIRECTORY_ABSOLUTE_PATH

Absolute path to directory Appium use to save ios instruments traces, defaults to /appium-instruments. Default: null

WEBKIT_DEBUG_PROXY_PORT

public static final IOSServerFlag WEBKIT_DEBUG_PROXY_PORT

Local port used for communication with ios-webkit-debug-proxy

Default value: 27753

Sample: --webkit-debug-proxy-port 27753

Method Detail

values

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

Returns:

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

valueOf

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