IOSServerFlag (java-client 3.3.0 API)

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. 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 iOS specific arguments are marked by (IOS-only)

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 Sample: --backend-retries 3
`CALENDAR_FORMAT` Calendar format for the iOS simulator Default: null Sample: --calendar-format gregorian
`CUSTOM_INSTRUMENTS_PATH` custom path to the instruments commandline tool Sample: --instruments /path/to/instruments
`DEFAULT_DEVICE` use the default simulator that instruments launches on its own Default: false
`FORCE_IPAD_SIMULATOR` Use the iPad Simulator no matter what the app wants Default: false
`FORCE_IPHONE_SIMULATOR` Use the iPhone Simulator no matter what the app wants Default: false
`IPA_ABSOLUTE_PATH` absolute path to compiled .ipa file Sample: --ipa /abs/path/to/my.ipa
`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` Whether to keep keychains (Library/Keychains) when reset app between sessions Default: false
`LAUNCH_TIMEOUT` how long in ms to wait for Instruments to launch Default: 90000
`LOCALIZABLE_STRING_PATH` the relative path of the dir where Localizable.strings file resides Default: en.lproj Sample: --localizable-strings-dir en.lproj
`ORIENTATION` use LANDSCAPE or PORTRAIT to initialize all requests to this orientation Sample: --orientation LANDSCAPE
`SAFARI` Use the safari app Default: false
`SHOW_IOS_LOG` if set, the iOS system log will be written to the console Default: false
`SHOW_SIMULATOR_LOG` if set, the iOS simulator log will be written to the console Default: false
`TRACE_DIRECTORY_ABSOLUTE_PATH` Absolute path to directory Appium use to save ios instruments traces, defaults to /appium-instruments Default: null
`TRACE_TEMPLATE_FILE_PATH` .tracetemplate file to use with Instruments Sample: --tracetemplate /Users/me/Automation.tracetemplate
`USE_NATIVE_INSTRUMENTS` IOS has a weird built-in unavoidable delay.

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
```
public static final IOSServerFlag LOCALIZABLE_STRING_PATH
```
    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
```
public static final IOSServerFlag LAUNCH_TIMEOUT
```
    how long in ms to wait for Instruments to launch
    Default: 90000
  - USE_NATIVE_INSTRUMENTS
```
public static final IOSServerFlag USE_NATIVE_INSTRUMENTS
```
    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
```
public static final IOSServerFlag CALENDAR_FORMAT
```
    Calendar format for the iOS simulator
    Default: null
    Sample:
    --calendar-format gregorian
  - ORIENTATION
```
public static final IOSServerFlag ORIENTATION
```
    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
```
public static final IOSServerFlag SHOW_SIMULATOR_LOG
```
    if set, the iOS simulator log will be written to the console
    Default: false
  - SHOW_IOS_LOG
```
public static final IOSServerFlag SHOW_IOS_LOG
```
    if set, the iOS system log will be written to the console
    Default: false
  - KEEP_KEYCHAINS
```
public static final IOSServerFlag KEEP_KEYCHAINS
```
    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
- 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

Enum IOSServerFlag

Enum Constant Summary

Method Summary

Methods inherited from class java.lang.Enum

Methods inherited from class java.lang.Object

Enum Constant Detail

LOCALIZABLE_STRING_PATH

IPA_ABSOLUTE_PATH

BACK_END_RETRIES

LAUNCH_TIMEOUT

USE_NATIVE_INSTRUMENTS

SAFARI

DEFAULT_DEVICE

FORCE_IPHONE_SIMULATOR

FORCE_IPAD_SIMULATOR

CALENDAR_FORMAT

ORIENTATION

TRACE_TEMPLATE_FILE_PATH

CUSTOM_INSTRUMENTS_PATH

SHOW_SIMULATOR_LOG

SHOW_IOS_LOG

KEEP_KEYCHAINS

ISOLATE_SIM_DEVICE

TRACE_DIRECTORY_ABSOLUTE_PATH

Method Detail

values

valueOf

getArgument