com.applitools.eyes.settings

Interface IOpenSettings

All Known Implementing Classes:

OpenSettings

public interface IOpenSettings

The interface for a command settings.

Method Summary

Modifier and Type	Method and Description
void	addProperty(String name, String value)
IOpenSettings	setAbortIdleTestTimeout(Integer idleTestTimeout)
IOpenSettings	setAgentId(String agentId)
IOpenSettings	setApiKey(String apiKey) Sets the API key.
IOpenSettings	setAppName(String appName) Sets the application name.
IOpenSettings	setBaselineBranchName(String baselineBranchName)
IOpenSettings	setBaselineEnvName(String baselineEnvName)
IOpenSettings	setBatch(BatchInfo batch)
IOpenSettings	setBranchName(String branchName)
IOpenSettings	setCompareWithParentBranch(Boolean compareWithParentBranch)
IOpenSettings	setConnectionTimeout(Integer connectionTimeout) Sets the connection timeout.
IOpenSettings	setDisplayName(String displayName)
IOpenSettings	setEnvironment(AppEnvironment environment)
IOpenSettings	setEnvironmentName(String environmentName)
IOpenSettings	setIgnoreBaseline(Boolean ignoreBaseline)
IOpenSettings	setIgnoreGitBranching(Boolean ignoreGitBranching)
IOpenSettings	setIsDisabled(Boolean isDisabled)
IOpenSettings	setKeepBatchOpen(Boolean keepBatchOpen)
IOpenSettings	setParentBranchName(String parentBranchName)
IOpenSettings	setProperties(List<PropertyData> properties)
IOpenSettings	setProxy(AbstractProxySettings proxySettings) Sets the proxy.
IOpenSettings	setRemoveSession(Boolean removeSession) Sets if the session should be removed
IOpenSettings	setSaveDiffs(Boolean saveDiffs)
IOpenSettings	setServerUrl(String serverUrl) Sets the server URL.
IOpenSettings	setSessionType(SessionType sessionType)
IOpenSettings	setTestName(String testName) Sets the test name
IOpenSettings	setUserTestId(String userTestId)

Method Detail

setIsDisabled

IOpenSettings setIsDisabled(Boolean isDisabled)

setServerUrl

IOpenSettings setServerUrl(String serverUrl)

Sets the server URL.

Parameters:

serverUrl - A string of the server's URL.

Returns:

An updated clone of this settings object.

setApiKey

IOpenSettings setApiKey(String apiKey)

Sets the API key.

Parameters:

apiKey - A string representing the API key.

Returns:

An updated clone of this settings object.

setProxy

IOpenSettings setProxy(AbstractProxySettings proxySettings)

Sets the proxy.

Parameters:

proxySettings - the proxy settings.

Returns:

An updated clone of this settings object.

setConnectionTimeout

IOpenSettings setConnectionTimeout(Integer connectionTimeout)

Sets the connection timeout.

Parameters:

connectionTimeout - Integer representing the timeout

Returns:

An updated clone of this settings object.

setRemoveSession

IOpenSettings setRemoveSession(Boolean removeSession)

Sets if the session should be removed

Parameters:

removeSession - should remove session.

Returns:

An updated clone of this settings object.

setAgentId

IOpenSettings setAgentId(String agentId)

setAppName

IOpenSettings setAppName(String appName)

Sets the application name. This is one of the baseline parameters.

Parameters:

appName - the application's name

Returns:

An updated clone of this settings object.

setTestName

IOpenSettings setTestName(String testName)

Sets the test name

Parameters:

testName - the test's name

Returns:

An updated clone of this settings object.

setDisplayName

IOpenSettings setDisplayName(String displayName)

setUserTestId

IOpenSettings setUserTestId(String userTestId)

setSessionType

IOpenSettings setSessionType(SessionType sessionType)

setProperties

IOpenSettings setProperties(List<PropertyData> properties)

addProperty

void addProperty(String name,
                 String value)

setBatch

IOpenSettings setBatch(BatchInfo batch)

setKeepBatchOpen

IOpenSettings setKeepBatchOpen(Boolean keepBatchOpen)

setEnvironmentName

IOpenSettings setEnvironmentName(String environmentName)

setEnvironment

IOpenSettings setEnvironment(AppEnvironment environment)

setBranchName

IOpenSettings setBranchName(String branchName)

setParentBranchName

IOpenSettings setParentBranchName(String parentBranchName)

setBaselineEnvName

IOpenSettings setBaselineEnvName(String baselineEnvName)

setBaselineBranchName

IOpenSettings setBaselineBranchName(String baselineBranchName)

setCompareWithParentBranch

IOpenSettings setCompareWithParentBranch(Boolean compareWithParentBranch)

setIgnoreBaseline

IOpenSettings setIgnoreBaseline(Boolean ignoreBaseline)

setIgnoreGitBranching

IOpenSettings setIgnoreGitBranching(Boolean ignoreGitBranching)

setSaveDiffs

IOpenSettings setSaveDiffs(Boolean saveDiffs)

setAbortIdleTestTimeout

IOpenSettings setAbortIdleTestTimeout(Integer idleTestTimeout)