Package io.appium.java_client.service.local.flags

Enum Class IOSServerFlag

java.lang.Object
java.lang.Enum<IOSServerFlag>
io.appium.java_client.service.local.flags.IOSServerFlag
All Implemented Interfaces:
ServerArgument, Serializable, Comparable<IOSServerFlag>, Constable
public enum IOSServerFlag extends Enum<IOSServerFlag> implements ServerArgument
Here is the list of iOS specific server arguments.

  • Enum Constant Details

    • 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

    • 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

    • 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

    • 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 Details

    • values

      public static IOSServerFlag[] values()
      Returns an array containing the constants of this enum class, in the order they are declared.
      Returns:
      an array containing the constants of this enum class, in the order they are declared

    • valueOf

      public static IOSServerFlag valueOf(String name)
      Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (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 class has no constant with the specified name
      NullPointerException - if the argument is null

    • getArgument

      public String getArgument()
      Specified by:
      getArgument in interface ServerArgument