Package com.applitools.eyes.config
Class Configuration
java.lang.Object
com.applitools.eyes.config.Configuration
- All Implemented Interfaces:
IConfiguration
- Direct Known Subclasses:
Configuration,IConfigurationGetter,IConfigurationGetter,IConfigurationSetter,IConfigurationSetter
-
Field Summary
Fields -
Constructor Summary
ConstructorsConstructorDescriptionConfiguration(Configuration other) Configuration(com.applitools.eyes.RectangleSize viewportSize) Configuration(String testName) Configuration(String appName, String testName, com.applitools.eyes.RectangleSize viewportSize) -
Method Summary
Modifier and TypeMethodDescriptionaddBrowser(int width, int height, com.applitools.eyes.selenium.BrowserType browserType) addBrowser(int width, int height, com.applitools.eyes.selenium.BrowserType browserType, String baselineEnvName) addBrowser(int width, int height, com.applitools.eyes.visualgrid.BrowserType browserType) addBrowser(int width, int height, com.applitools.eyes.visualgrid.BrowserType browserType, String baselineEnvName) addBrowser(com.applitools.eyes.visualgrid.model.ChromeEmulationInfo chromeEmulationInfo) addBrowser(com.applitools.eyes.visualgrid.model.DesktopBrowserInfo desktopBrowserInfo) addBrowser(com.applitools.eyes.visualgrid.model.IosDeviceInfo iosDeviceInfo) addBrowser(com.applitools.eyes.visualgrid.model.RenderBrowserInfo renderBrowserInfo) addBrowsers(com.applitools.eyes.visualgrid.model.IRenderingBrowserInfo... browserInfos) addDeviceEmulation(com.applitools.eyes.visualgrid.model.DeviceName deviceName) addDeviceEmulation(com.applitools.eyes.visualgrid.model.DeviceName deviceName, com.applitools.eyes.visualgrid.model.ScreenOrientation orientation) addDeviceEmulation(com.applitools.eyes.visualgrid.model.DeviceName deviceName, com.applitools.eyes.visualgrid.model.ScreenOrientation orientation, String baselineEnvName) addDeviceEmulation(com.applitools.eyes.visualgrid.model.DeviceName deviceName, String baselineEnvName) addMobileDevice(com.applitools.eyes.visualgrid.model.IosDeviceInfo iosDeviceInfo) addMobileDevice(com.applitools.eyes.visualgrid.model.IosDeviceInfo iosDeviceInfo, String version) addMobileDevices(com.applitools.eyes.visualgrid.model.IosDeviceInfo iosDeviceInfo, com.applitools.eyes.visualgrid.model.IosDeviceInfo... iosDeviceInfos) addMultiDeviceTarget(com.applitools.eyes.visualgrid.model.DeviceTarget deviceTarget, com.applitools.eyes.visualgrid.model.DeviceTarget... deviceTargets) addProperty(String name, String value) voidcom.applitools.eyes.AutProxySettingsgetBatch()List<com.applitools.eyes.visualgrid.model.RenderBrowserInfo> com.applitools.eyes.visualgrid.model.IDebugResourceWriterDeprecated.com.applitools.eyes.AbstractProxySettingsgetProxy()com.applitools.eyes.RectangleSizeList<com.applitools.eyes.visualgrid.model.VisualGridOption> booleanisFeatureActivated(Feature feature) setAbortIdleTestTimeout(Integer abortIdleTestTimeout) setAccessibilityValidation(AccessibilitySettings accessibilitySettings) setAgentId(String agentId) setAppName(String appName) setAutProxy(com.applitools.eyes.AutProxySettings autProxy) setBaselineBranchName(String baselineBranchName) setBaselineEnvName(String baselineEnvName) setBranchName(String branchName) setBrowsersInfo(List<com.applitools.eyes.visualgrid.model.RenderBrowserInfo> browsersInfo) voidsetCaptureStatusBar(Boolean captureStatusBar) setContentInset(ContentInset contentInset) setCutProvider(CutProvider cutProvider) setDebugResourceWriter(com.applitools.eyes.visualgrid.model.IDebugResourceWriter debugResourceWriter) setDebugScreenshotsPath(String debugScreenshotsPath) setDebugScreenshotsPrefix(String debugScreenshotsPrefix) setDefaultMatchSettings(ImageMatchSettings defaultMatchSettings) setDeviceInfo(String deviceInfo) setDisableBrowserFetching(Boolean disableBrowserFetching) setDisableNMLUrlCache(Boolean disableNMLUrlCache) setEnablePatterns(Boolean enablePatterns) setEnvironmentName(String environmentName) setFailureReports(FailureReports failureReports) Deprecated.setFeatures(Feature feature, Feature... features) Sets features to for the Eyes test.setForceFullPageScreenshot(boolean forceFullPageScreenshot) setGitMergeBaseTimestamp(Calendar gitMergeBaseTimestamp) setHideCaret(boolean hideCaret) setHideScrollbars(boolean hideScrollbars) setHostApp(String hostApp) setHostingAppInfo(String hostingAppInfo) setIgnoreCaret(Boolean value) Sets the ignore blinking caret value.setIgnoreDisplacements(Boolean isIgnoreDisplacements) setIgnoreGitMergeBase(Boolean ignoreGitMergeBase) setIsDisabled(Boolean isDisabled) setIsVisualGrid(Boolean isVisualGrid) setLayoutBreakpoints(int[] breakpoints) setLayoutBreakpoints(LayoutBreakpointsOptions layoutBreakpointsOptions) setLayoutBreakpoints(Boolean shouldSet) setLayoutBreakpoints(Integer... breakpoints) setMatchLevel(MatchLevel matchLevel) setMatchTimeout(Integer matchTimeout) setMobileOptions(MobileOptionsData mobileOptions) setParentBranchName(String parentBranchName) setProxy(com.applitools.eyes.AbstractProxySettings proxy) setRenderingConfig(Boolean renderingConfig) setRotation(Integer rotation) setSaveDebugScreenshots(Boolean saveDebugScreenshots) setSaveDiffs(Boolean saveDiffs) setSaveFailedTests(Boolean saveFailedTests) setSaveNewTests(Boolean saveNewTests) setScaleRatio(Double scaleRatio) setSendDom(Boolean sendDom) setServerUrl(String serverUrl) setSessionType(SessionType sessionType) setStitchMode(StitchMode stitchMode) setStitchOverlap(StitchOverlap stitchOverlap) setStitchOverlap(Integer stitchOverlap) setTestName(String testName) setUseCeilForViewportSize(Boolean useCeilForViewportSize) setUseCookies(Boolean useCookies) setViewportSize(com.applitools.eyes.RectangleSize viewportSize) setVisualGridOptions(com.applitools.eyes.visualgrid.model.VisualGridOption option, com.applitools.eyes.visualgrid.model.VisualGridOption... options) voidsetWaitBeforeCapture(Integer milliSec) setWaitBeforeScreenshots(int waitBeforeScreenshots) setWebDriverProxy(WebDriverProxySettings proxySettings) toString()
-
Field Details
-
batch
-
baselineEnvName
-
appName
-
testName
-
viewportSize
protected com.applitools.eyes.RectangleSize viewportSize -
ignoreDisplacements
-
defaultMatchSettings
-
-
Constructor Details
-
Configuration
-
Configuration
public Configuration() -
Configuration
public Configuration(com.applitools.eyes.RectangleSize viewportSize) -
Configuration
-
Configuration
-
-
Method Details
-
getSaveNewTests
- Specified by:
getSaveNewTestsin interfaceIConfiguration
-
setSaveNewTests
- Specified by:
setSaveNewTestsin interfaceIConfiguration
-
getSaveFailedTests
- Specified by:
getSaveFailedTestsin interfaceIConfiguration
-
setSaveFailedTests
- Specified by:
setSaveFailedTestsin interfaceIConfiguration
-
getDefaultMatchSettings
- Specified by:
getDefaultMatchSettingsin interfaceIConfiguration
-
setDefaultMatchSettings
- Specified by:
setDefaultMatchSettingsin interfaceIConfiguration
-
getMatchTimeout
- Specified by:
getMatchTimeoutin interfaceIConfiguration
-
setMatchTimeout
- Specified by:
setMatchTimeoutin interfaceIConfiguration
-
getHostApp
- Specified by:
getHostAppin interfaceIConfiguration
-
setHostApp
- Specified by:
setHostAppin interfaceIConfiguration
-
getHostOS
- Specified by:
getHostOSin interfaceIConfiguration
-
setHostOS
- Specified by:
setHostOSin interfaceIConfiguration
-
getStitchOverlap
- Specified by:
getStitchOverlapin interfaceIConfiguration
-
getOverlap
- Specified by:
getOverlapin interfaceIConfiguration
-
setStitchOverlap
- Specified by:
setStitchOverlapin interfaceIConfiguration
-
setStitchOverlap
- Specified by:
setStitchOverlapin interfaceIConfiguration
-
setBatch
- Specified by:
setBatchin interfaceIConfiguration
-
getBatch
- Specified by:
getBatchin interfaceIConfiguration
-
setBranchName
- Specified by:
setBranchNamein interfaceIConfiguration
-
getBranchName
- Specified by:
getBranchNamein interfaceIConfiguration
-
getAgentId
- Specified by:
getAgentIdin interfaceIConfiguration
-
setAgentId
- Specified by:
setAgentIdin interfaceIConfiguration
-
getParentBranchName
- Specified by:
getParentBranchNamein interfaceIConfiguration
-
setParentBranchName
- Specified by:
setParentBranchNamein interfaceIConfiguration
-
getBaselineBranchName
- Specified by:
getBaselineBranchNamein interfaceIConfiguration
-
setBaselineBranchName
- Specified by:
setBaselineBranchNamein interfaceIConfiguration
-
getBaselineEnvName
- Specified by:
getBaselineEnvNamein interfaceIConfiguration
-
setBaselineEnvName
- Specified by:
setBaselineEnvNamein interfaceIConfiguration
-
getEnvironmentName
- Specified by:
getEnvironmentNamein interfaceIConfiguration
-
setEnvironmentName
- Specified by:
setEnvironmentNamein interfaceIConfiguration
-
getSaveDiffs
- Specified by:
getSaveDiffsin interfaceIConfiguration
-
setSaveDiffs
- Specified by:
setSaveDiffsin interfaceIConfiguration
-
getAppName
- Specified by:
getAppNamein interfaceIConfiguration
-
setAppName
- Specified by:
setAppNamein interfaceIConfiguration
-
getTestName
- Specified by:
getTestNamein interfaceIConfiguration
-
setTestName
- Specified by:
setTestNamein interfaceIConfiguration
-
getViewportSize
public com.applitools.eyes.RectangleSize getViewportSize()- Specified by:
getViewportSizein interfaceIConfiguration
-
setViewportSize
- Specified by:
setViewportSizein interfaceIConfiguration
-
getSessionType
- Specified by:
getSessionTypein interfaceIConfiguration
-
setSessionType
- Specified by:
setSessionTypein interfaceIConfiguration
-
setFailureReports
Deprecated.- Specified by:
setFailureReportsin interfaceIConfiguration
-
getFailureReports
Deprecated.- Specified by:
getFailureReportsin interfaceIConfiguration
-
toString
-
isSendDom
- Specified by:
isSendDomin interfaceIConfiguration
-
setSendDom
- Specified by:
setSendDomin interfaceIConfiguration
-
getIgnoreCaret
- Specified by:
getIgnoreCaretin interfaceIConfiguration- Returns:
- Whether to ignore or the blinking caret or not when comparing images.
-
setIgnoreCaret
Sets the ignore blinking caret value.- Specified by:
setIgnoreCaretin interfaceIConfiguration- Parameters:
value- The ignore value.
-
getApiKey
- Specified by:
getApiKeyin interfaceIConfiguration
-
setApiKey
- Specified by:
setApiKeyin interfaceIConfiguration
-
getServerUrl
- Specified by:
getServerUrlin interfaceIConfiguration
-
setServerUrl
- Specified by:
setServerUrlin interfaceIConfiguration
-
getProxy
public com.applitools.eyes.AbstractProxySettings getProxy()- Specified by:
getProxyin interfaceIConfiguration
-
setProxy
- Specified by:
setProxyin interfaceIConfiguration
-
getMatchLevel
- Specified by:
getMatchLevelin interfaceIConfiguration
-
getIgnoreDisplacements
- Specified by:
getIgnoreDisplacementsin interfaceIConfiguration
-
setMatchLevel
- Specified by:
setMatchLevelin interfaceIConfiguration
-
setIgnoreDisplacements
- Specified by:
setIgnoreDisplacementsin interfaceIConfiguration
-
getAccessibilityValidation
- Specified by:
getAccessibilityValidationin interfaceIConfiguration
-
setAccessibilityValidation
- Specified by:
setAccessibilityValidationin interfaceIConfiguration
-
setUseDom
- Specified by:
setUseDomin interfaceIConfiguration
-
getUseDom
- Specified by:
getUseDomin interfaceIConfiguration
-
setEnablePatterns
- Specified by:
setEnablePatternsin interfaceIConfiguration
-
getEnablePatterns
- Specified by:
getEnablePatternsin interfaceIConfiguration
-
getForceFullPageScreenshot
-
getWaitBeforeScreenshots
-
setWaitBeforeScreenshots
-
getStitchMode
-
setStitchMode
-
getHideScrollbars
-
setHideScrollbars
-
getHideCaret
-
setHideCaret
-
addBrowsers
public Configuration addBrowsers(com.applitools.eyes.visualgrid.model.IRenderingBrowserInfo... browserInfos) -
addBrowser
public Configuration addBrowser(com.applitools.eyes.visualgrid.model.RenderBrowserInfo renderBrowserInfo) -
addBrowser
public Configuration addBrowser(com.applitools.eyes.visualgrid.model.DesktopBrowserInfo desktopBrowserInfo) -
addBrowser
public Configuration addBrowser(com.applitools.eyes.visualgrid.model.ChromeEmulationInfo chromeEmulationInfo) -
addBrowser
-
addBrowser
public Configuration addBrowser(int width, int height, com.applitools.eyes.selenium.BrowserType browserType, String baselineEnvName) -
addBrowser
public Configuration addBrowser(int width, int height, com.applitools.eyes.selenium.BrowserType browserType) -
addBrowser
public Configuration addBrowser(int width, int height, com.applitools.eyes.visualgrid.BrowserType browserType, String baselineEnvName) -
addBrowser
public Configuration addBrowser(int width, int height, com.applitools.eyes.visualgrid.BrowserType browserType) -
addDeviceEmulation
public Configuration addDeviceEmulation(com.applitools.eyes.visualgrid.model.DeviceName deviceName, com.applitools.eyes.visualgrid.model.ScreenOrientation orientation) -
addDeviceEmulation
-
addDeviceEmulation
public Configuration addDeviceEmulation(com.applitools.eyes.visualgrid.model.DeviceName deviceName, String baselineEnvName) -
addDeviceEmulation
public Configuration addDeviceEmulation(com.applitools.eyes.visualgrid.model.DeviceName deviceName, com.applitools.eyes.visualgrid.model.ScreenOrientation orientation, String baselineEnvName) -
addMultiDeviceTarget
public Configuration addMultiDeviceTarget(com.applitools.eyes.visualgrid.model.DeviceTarget deviceTarget, com.applitools.eyes.visualgrid.model.DeviceTarget... deviceTargets) -
getBrowsersInfo
-
setBrowsersInfo
public Configuration setBrowsersInfo(List<com.applitools.eyes.visualgrid.model.RenderBrowserInfo> browsersInfo) -
isForceFullPageScreenshot
-
setForceFullPageScreenshot
-
isRenderingConfig
-
setRenderingConfig
-
setIsVisualGrid
-
isVisualGrid
-
setFeatures
Sets features to for the Eyes test. Overrides existing features. -
getFeatures
-
isFeatureActivated
-
setVisualGridOptions
public Configuration setVisualGridOptions(com.applitools.eyes.visualgrid.model.VisualGridOption option, com.applitools.eyes.visualgrid.model.VisualGridOption... options) -
getVisualGridOptions
-
getDeviceInfo
-
setDeviceInfo
-
getHostingAppInfo
-
setHostingAppInfo
-
getOsInfo
-
setOsInfo
-
isDisableBrowserFetching
-
setDisableBrowserFetching
-
isUseCookies
-
setUseCookies
-
setGitMergeBaseTimestamp
- Specified by:
setGitMergeBaseTimestampin interfaceIConfiguration
-
getGitMergeBaseTimestamp
- Specified by:
getGitMergeBaseTimestampin interfaceIConfiguration
-
getDebugResourceWriter
public com.applitools.eyes.visualgrid.model.IDebugResourceWriter getDebugResourceWriter() -
setDebugResourceWriter
public Configuration setDebugResourceWriter(com.applitools.eyes.visualgrid.model.IDebugResourceWriter debugResourceWriter) -
getAbortIdleTestTimeout
-
setAbortIdleTestTimeout
-
setLayoutBreakpoints
-
setLayoutBreakpoints
-
isDefaultLayoutBreakpointsSet
-
setLayoutBreakpoints
-
setLayoutBreakpoints
-
getLayoutBreakpoints
-
getLayoutBreakpointsOptions
-
isCaptureStatusBar
-
setCaptureStatusBar
-
setSaveDebugScreenshots
-
getSaveDebugScreenshots
-
setDebugScreenshotsPath
-
getDebugScreenshotsPath
-
setDebugScreenshotsPrefix
-
getDebugScreenshotsPrefix
-
setIsDisabled
-
getIsDisabled
-
addProperty
-
clearProperties
public void clearProperties() -
getProperties
-
setCutProvider
-
getCutProvider
-
setRotation
-
getRotation
-
setScaleRatio
-
getScaleRatio
-
addMobileDevice
public Configuration addMobileDevice(com.applitools.eyes.visualgrid.model.IosDeviceInfo iosDeviceInfo) -
addMobileDevices
public Configuration addMobileDevices(com.applitools.eyes.visualgrid.model.IosDeviceInfo iosDeviceInfo, com.applitools.eyes.visualgrid.model.IosDeviceInfo... iosDeviceInfos) -
addMobileDevice
public Configuration addMobileDevice(com.applitools.eyes.visualgrid.model.IosDeviceInfo iosDeviceInfo, String version) -
setUseCeilForViewportSize
-
getUseCeilForViewportSize
-
getWaitBeforeCapture
- Returns:
- wait before capture
-
setWaitBeforeCapture
- Parameters:
milliSec- time to wait before each screenshot
-
getWebDriverProxy
-
setWebDriverProxy
-
setAutProxy
-
getAutProxy
public com.applitools.eyes.AutProxySettings getAutProxy() -
getContentInset
-
setContentInset
-
getIgnoreGitMergeBase
- Specified by:
getIgnoreGitMergeBasein interfaceIConfiguration
-
setIgnoreGitMergeBase
- Specified by:
setIgnoreGitMergeBasein interfaceIConfiguration
-
getDisableNMLUrlCache
-
setDisableNMLUrlCache
-
getMobileOptions
-
setMobileOptions
-