Enum Class GeneralServerFlag
- All Implemented Interfaces:
ServerArgument,Serializable,Comparable<GeneralServerFlag>,Constable
Here is the list of common Appium server arguments.
-
Nested Class Summary
Nested classes/interfaces inherited from class java.lang.Enum
Enum.EnumDesc<E extends Enum<E>> -
Enum Constant Summary
Enum ConstantsEnum ConstantDescriptionAllow a list of features which are considered insecure and must be turned on explicitly by system administrators.Add long stack traces to log entries.Base path to use as the prefix for all webdriver routes running on this server.callback IP Address (default: same as address).callback port (default: same as port).Configuration JSON file to register Appium with selenium grid.Add exaggerated spacing in logs to help with visual inspection.Specify a list of features which will never be allowed to run, even if --relaxed-security is turned on, and even if feature names are listed with --allow-insecure.Enables NodeJS memory dumps collection feature.Use local timezone for timestamps.The message log level to be shown.Don’t use colors in console output.Show timestamps in console output.Bypass Appium’s checks to ensure we can read/write necessary files.Disable additional security checks.Enables session override (clobbering).Enter REPL mode.Show info about the Appium server configuration and exit.Cause sessions to fail if desired caps are sent in that Appium does not recognize as valid for the selected device.Absolute path to directory Appium can use to manage temporary files, like built-in iOS apps it needs to move around.A comma-separated list of installed driver names that should be active for this server.Plugins are little programs which can be added to an Appium installation and activated, for the purpose of extending or modifying the behavior of pretty much any aspect of Appium.Also send log output to this HTTP listener. -
Method Summary
Modifier and TypeMethodDescriptionstatic GeneralServerFlagReturns the enum constant of this class with the specified name.static GeneralServerFlag[]values()Returns an array containing the constants of this enum class, in the order they are declared.
-
Enum Constant Details
-
SHELL
Enter REPL mode. -
CALLBACK_ADDRESS
callback IP Address (default: same as address). Sample: --callback-address 127.0.0.1 -
CALLBACK_PORT
callback port (default: same as port). Sample: --callback-port 4723 -
SESSION_OVERRIDE
Enables session override (clobbering). Default: false -
LOG_LEVEL
The message log level to be shown. Sample: --log-level debug -
LOG_TIMESTAMP
Show timestamps in console output. Default: false -
LOCAL_TIMEZONE
Use local timezone for timestamps. Default: false -
LOG_NO_COLORS
Don’t use colors in console output. Default: false -
WEB_HOOK
Also send log output to this HTTP listener. Sample: --webhook localhost:9876 -
CONFIGURATION_FILE
Configuration JSON file to register Appium with selenium grid. Sample: --nodeconfig /abs/path/to/nodeconfig.json -
SHOW_CONFIG
Show info about the Appium server configuration and exit. Default: false -
NO_PERMS_CHECKS
Bypass Appium’s checks to ensure we can read/write necessary files. Default: false -
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
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
Add exaggerated spacing in logs to help with visual inspection. Default: false -
ASYNC_TRACE
Add long stack traces to log entries. Recommended for debugging only. Default: false -
RELAXED_SECURITY
Disable additional security checks. Only enable it if all the clients are in the trusted network. Default: false -
ENABLE_HEAP_DUMP
Enables NodeJS memory dumps collection feature. -
ALLOW_INSECURE
Allow a list of features which are considered insecure and must be turned on explicitly by system administrators. Default: [] Sample: --allow-insecure=foo,bar -
DENY_INSECURE
Specify a list of features which will never be allowed to run, even if --relaxed-security is turned on, and even if feature names are listed with --allow-insecure. Default: [] Sample: --deny-insecure=foo,bar -
USE_PLUGINS
Plugins are little programs which can be added to an Appium installation and activated, for the purpose of extending or modifying the behavior of pretty much any aspect of Appium. Plugins are available with Appium as of Appium 2.0. To activate all plugins, you can use the single string "all" as the value (e.g --plugins=all) Default: [] Sample: --use-plugins=device-farm,images -
USE_DRIVERS
A comma-separated list of installed driver names that should be active for this server. All drivers will be active by default. Default: [] Sample: --use-drivers=uiautomator2,xcuitest -
BASEPATH
Base path to use as the prefix for all webdriver routes running on this server. Sample: --base-path=/wd/hub
-
-
Method Details
-
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
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 nameNullPointerException- if the argument is null
-
getArgument
- Specified by:
getArgumentin interfaceServerArgument
-