AppCenterTestRunAppiumSettings Class

Summary

Settings for appcenter test run appium. Starts a test run with Appium tests..
Assembly
Cake.AppCenter.dll
Namespace
Cake.AppCenter
Base Types
graph BT Type-->Base0["AutoToolSettings"] click Base0 "/api/Cake.AppCenter/AutoToolSettings" Base0-->Base1["ToolSettings"] Type["AppCenterTestRunAppiumSettings"] class Type type-node

Syntax

public sealed class AppCenterTestRunAppiumSettings : AutoToolSettings

Attributes

Type Description
CompilerGeneratedAttribute

Constructors

Properties

Name Value Summary
App string
-a|--app <arg> Specify app in the <ownerName>/<appName> format
AppPath string
--app-path <arg> Path to an application file
Async Nullable<bool>
--async Exit the command when tests are uploaded, without waiting for test results
BuildDir string
--build-dir <arg> Path to the directory with the Appium tests (usually <project>/target/upload)
Debug Nullable<bool>
--debug Display extra output for debugging
Devices string
--devices <arg> Device selection slug
DisableTelemetry Nullable<bool>
--disable-telemetry Disable telemetry for this command
DsymDir string
--dsym-dir <arg> Path to the directory with iOS symbol files. This option is deprecated and ignored
Env string
--env <arg> Environment when using API token
Help Nullable<bool>
-h|--help Display help for current command
Include string
--include <arg> Additional files and directories to include. The value must be either path relative to the input directory, or be in format "targetDir=sourceDir"
Language string
--language <arg> Override the language (iOS only) for the test run
Locale string
--locale <arg> The system locale for the test run. For example, en_US
MergeJunitXml string
--merge-junit-xml <arg> Merge the xml files into the <arg> file. Requires --test-output-dir to specify the directory where the <arg> file will be. This parameter is ignored when used with the --async option because we have to wait for test results.
Output string
--output <arg> Output format: json
Quiet Nullable<bool>
--quiet Auto-confirm any prompts without waiting for input
TestOutputDir string
--test-output-dir <arg> Path to the directory for test results. This parameter won't work when you run using --async because we have to wait for test results. The results will be saved in the working directory if a relative path is specified
TestParameter string
-p|--test-parameter <arg> Additional test parameters. The value must be in format "key=value"
TestSeries string
--test-series <arg> Name of the test series
Timeout string
--timeout <arg> Maximum time (in seconds) to wait for test results
Token string
--token <arg> API token
Version Nullable<bool>
-v|--version Display appcenter version
VstsIdVariable string
--vsts-id-variable <arg> Outputs the Test Run Id to the named VSTS variable

Extension Methods

Name Value Summary
Dump<AppCenterTestRunAppiumSettings>() string
Get a basic string representation of specified object.
Requires the Cake.Incubator addin
IsIn<AppCenterTestRunAppiumSettings>(AppCenterTestRunAppiumSettings[]) bool
Checks if the source is contained in a list
Requires the Cake.Incubator addin
NotNull<AppCenterTestRunAppiumSettings>(string) void
Throws an exception if the specified parameter's value is null.
Requires the Cake.Ftp addin
NotNull<AppCenterTestRunAppiumSettings>(string) void
Throws an exception if the specified parameter's value is null.
Requires the Cake.Issues addin
ThrowIfNull<AppCenterTestRunAppiumSettings>(string) T
Throws a System.ArgumentNullException if the value is null, otherwise returns the value
Requires the Cake.Incubator addin
ThrowIfNull<AppCenterTestRunAppiumSettings>(string, string) T
Throws a System.ArgumentNullException with a specific message if the value is null, otherwise returns the value
Requires the Cake.Incubator addin
ToDictionary() IDictionary<string, object>
Requires the Cake.DeployParams addin