EyesBase (eyes-sdk-core-java5 5.0.2 API)

java.lang.Object
- com.applitools.eyes.EyesBase

All Implemented Interfaces:

IEyesBase

Direct Known Subclasses:

RunningTest
```
public abstract class EyesBase
extends Object
implements IEyesBase
```
Applitools Eyes Base for Java API .

Field Summary

Fields
Modifier and Type	Field and Description
`protected String`	`agentRunId`
`protected PropertyHandler<CutProvider>`	`cutProviderHandler`
`protected DebugScreenshotsProvider`	`debugScreenshotsProvider`
`protected boolean`	`isOpen`
`protected EyesScreenshot`	`lastScreenshot`
`protected Logger`	`logger`
`protected PropertyHandler<PositionProvider>`	`positionProviderHandler`
`protected ClassicRunner0`	`runner`
`protected RunningSession`	`runningSession`
`protected PropertyHandler<ScaleProvider>`	`scaleProviderHandler`
`protected ServerConnector`	`serverConnector`
`protected SessionStartInfo`	`sessionStartInfo`
`protected TestResultContainer`	`testResultContainer`
`protected static int`	`USE_DEFAULT_TIMEOUT`

Constructor Summary

Constructors
Constructor and Description

EyesBase()

EyesBase(ClassicRunner0 runner)

Constructors
Constructor and Description
`EyesBase()`
`EyesBase(ClassicRunner0 runner)`

Method Summary

All Methods Static Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method and Description
`TestResults`	`abort()`
`void`	`abortAsync()`
`TestResults`	`abortIfNotClosed()`
`protected void`	`addMouseTriggerBase(MouseAction action, Region control, Location cursor)` Adds a mouse trigger.
`protected void`	`addProperty(PropertyData property)`
`void`	`addProperty(String name, String value)` Adds a property to be sent to the server.
`protected void`	`addTextTriggerBase(Region control, String text)` Adds a text trigger.
`protected void`	`addUserInput(Trigger trigger)` Adds a trigger to the current list of user inputs.
`protected MatchResult`	`checkWindowBase(Region region, ICheckSettingsInternal checkSettingsInternal, String source)`
`protected MatchResult`	`checkWindowBase(Region region, ICheckSettings checkSettings, String source)` Takes a snapshot of the application under test and matches it with the expected output.
`protected MatchResult`	`checkWindowBase(Region region, String tag, ICheckSettings checkSettings)`
`protected MatchResult`	`checkWindowBase(Region region, String tag, int retryTimeout, String source)` Takes a snapshot of the application under test and matches it with the expected output.
`protected MatchResult`	`checkWindowBase(Region region, String tag, String source)` See `checkWindowBase(Region, String, int, String)`.
`void`	`clearProperties()` Clears the list of custom properties.
`protected void`	`clearUserInputs()` Clears the user inputs list.
`TestResults`	`close()` See `close(boolean)`.
`TestResults`	`close(boolean throwEx)` Ends the test.
`void`	`closeAsync()`
`List<String>`	`extractText(BaseOcrRegion... ocrRegions)`
`Map<String,List<TextRegion>>`	`extractTextRegions(TextRegionSettings textRegionSettings)`
`protected ValidationInfo`	`fireValidationWillStartEvent(String tag)`
`Object`	`getAgentSetup()`
`String`	`getApiKey()`
`protected Object`	`getAppEnvironment()` Application environment is the environment (e.g., the host OS) which runs the application under test.
`protected String`	`getAppName()`
`protected abstract void`	`getAppOutputForOcr(BaseOcrRegion ocrRegion)`
`protected abstract String`	`getBaseAgentId()`
`protected String`	`getBaselineEnvName()`
`Configuration`	`getConfiguration()`
`protected abstract Configuration`	`getConfigurationInstance()`
`String`	`getDebugScreenshotsPath()`
`String`	`getDebugScreenshotsPrefix()`
`DebugScreenshotsProvider`	`getDebugScreenshotsProvider()`
`static URI`	`getDefaultServerUrl()`
`Map<String,DeviceSize>`	`getDevicesSizes(String path)`
`String`	`getFullAgentId()`
`protected abstract String`	`getInferredEnvironment()`
`boolean`	`getIsCutProviderExplicitlySet()`
`Boolean`	`getIsDisabled()`
`boolean`	`getIsOpen()`
`boolean`	`getIsScaleProviderExplicitlySet()`
`Logger`	`getLogger()`
`LogHandler`	`getLogHandler()`
`Map<String,MobileDeviceInfo>`	`getMobileDeviceInfo()`
`PositionProvider`	`getPositionProvider()`
`AbstractProxySettings`	`getProxy()`
`RenderingInfo`	`getRenderingInfo()`
`boolean`	`getSaveDebugScreenshots()`
`double`	`getScaleRatio()`
`protected abstract EyesScreenshot`	`getScreenshot(Region targetRegion, ICheckSettingsInternal checkSettingsInternal)`
`protected abstract ScreenshotProvider`	`getScreenshotProvider()`
`ServerConnector`	`getServerConnector()`
`URI`	`getServerUrl()`
`String`	`getTestId()`
`protected String`	`getTestName()`
`protected abstract String`	`getTitle()`
`Map<String,String>`	`getUserAgents()`
`protected Trigger[]`	`getUserInputs()`
`protected abstract RectangleSize`	`getViewportSize()`
`protected RectangleSize`	`getViewportSizeForOpen()`
`boolean`	`isCompleted()`
`Boolean`	`isSendDom()`
`void`	`logSessionResultsAndThrowException(boolean throwEx, TestResults results)`
`protected void`	`openBase()`
`void`	`openCompleted(RunningSession result)`
`protected void`	`openLogger()`
`MatchResult`	`performMatch(MatchWindowData data)`
`protected MatchWindowData`	`prepareForMatch(ICheckSettingsInternal checkSettingsInternal, List<Trigger> userInputs, AppOutput appOutput, String tag, boolean replaceLast, ImageMatchSettings imageMatchSettings, String renderId, String source)` Creates the match model
`SessionStartInfo`	`prepareForOpen()`
`SessionStopInfo`	`prepareStopSession(boolean isAborted)`
`Configuration`	`setApiKey(String apiKey)` Sets the API key of your applitools Eyes account.
`Configuration`	`setBatch(BatchInfo batch)` Sets the batch in which context future tests will run or `null` if tests are to run standalone.
`void`	`setDebugScreenshotsPath(String pathToSave)`
`void`	`setDebugScreenshotsPrefix(String prefix)`
`protected void`	`setEffectiveViewportSize(RectangleSize size)`
`void`	`setExplicitViewportSize(RectangleSize explicitViewportSize)` Define the viewport size as `size` without doing any actual action on the
`void`	`setImageCut(CutProvider cutProvider)` Manually set the the sizes to cut from an image before it's validated.
`void`	`setIsDisabled(boolean isDisabled)`
`void`	`setIsDisabled(Boolean isDisabled)`
`void`	`setLogHandler(LogHandler logHandler)` Sets a handler of log messages generated by this API.
`void`	`setPositionProvider(PositionProvider positionProvider)`
`Configuration`	`setProxy(AbstractProxySettings abstractProxySettings)` Sets the proxy settings to be used by the rest client.
`void`	`setSaveDebugScreenshots(boolean saveDebugScreenshots)`
`void`	`setScaleRatio(Double scaleRatio)` Manually set the scale ratio for the images being validated.
`Configuration`	`setSendDom(boolean isSendDom)`
`void`	`setServerConnector(ServerConnector serverConnector)` Sets the server connector to use.
`Configuration`	`setServerUrl(String serverUrl)` Sets the current server URL used by the rest client.
`Configuration`	`setServerUrl(URI serverUrl)` Sets the current server URL used by the rest client.
`void`	`setTestId(String testId)`
`protected abstract Configuration`	`setViewportSize(RectangleSize size)`
`protected boolean`	`shouldCaptureDom(Boolean sendDomFromCheckSettings)`
`protected TestResults`	`stopSession(boolean isAborted)`
`protected String`	`tryCaptureAndPostDom()`
`protected abstract String`	`tryCaptureDom()`
`protected void`	`validateResult(MatchResult result)`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - USE_DEFAULT_TIMEOUT
```
protected static final int USE_DEFAULT_TIMEOUT
```
    See Also:
    
    Constant Field Values
  - agentRunId
```
protected String agentRunId
```
  - runner
```
protected ClassicRunner0 runner
```
  - serverConnector
```
protected ServerConnector serverConnector
```
  - runningSession
```
protected RunningSession runningSession
```
  - sessionStartInfo
```
protected SessionStartInfo sessionStartInfo
```
  - testResultContainer
```
protected TestResultContainer testResultContainer
```
  - lastScreenshot
```
protected EyesScreenshot lastScreenshot
```
  - scaleProviderHandler
```
protected PropertyHandler<ScaleProvider> scaleProviderHandler
```
  - cutProviderHandler
```
protected PropertyHandler<CutProvider> cutProviderHandler
```
  - positionProviderHandler
```
protected PropertyHandler<PositionProvider> positionProviderHandler
```
  - logger
```
protected Logger logger
```
  - isOpen
```
protected boolean isOpen
```
  - debugScreenshotsProvider
```
protected DebugScreenshotsProvider debugScreenshotsProvider
```
- Constructor Detail
  - EyesBase
```
public EyesBase()
```
  - EyesBase
```
public EyesBase(ClassicRunner0 runner)
```
- Method Detail
  - getTestId
```
public String getTestId()
```
  - setTestId
```
public void setTestId(String testId)
```
  - setServerConnector
```
public void setServerConnector(ServerConnector serverConnector)
```
    Sets the server connector to use. MUST BE SET IN ORDER FOR THE EYES OBJECT TO WORK!
    
    Parameters:
    
    serverConnector - The server connector object to use.
  - getServerConnector
```
public ServerConnector getServerConnector()
```
  - setApiKey
```
public Configuration setApiKey(String apiKey)
```
    Sets the API key of your applitools Eyes account.
    
    Parameters:
    
    apiKey - The api key to set.
  - getApiKey
```
public String getApiKey()
```
    Specified by:
    
    getApiKey in interface IEyesBase
    
    Returns:
    
    The currently set API key or null if no key is set.
  - setServerUrl
```
public Configuration setServerUrl(String serverUrl)
```
    Sets the current server URL used by the rest client.
    
    Parameters:
    
    serverUrl - The URI of the rest server, or null to use the default server.
  - setServerUrl
```
public Configuration setServerUrl(URI serverUrl)
```
    Sets the current server URL used by the rest client.
    
    Parameters:
    
    serverUrl - The URI of the rest server, or null to use the default server.
  - getServerUrl
```
public URI getServerUrl()
```
    Specified by:
    
    getServerUrl in interface IEyesBase
    
    Returns:
    
    The URI of the eyes server.
  - setProxy
```
public Configuration setProxy(AbstractProxySettings abstractProxySettings)
```
    Sets the proxy settings to be used by the rest client.
    
    Parameters:
    
    abstractProxySettings - The proxy settings to be used by the rest client. If null then no proxy is set.
  - getProxy
```
public AbstractProxySettings getProxy()
```
    Returns:
    
    The current proxy settings used by the server connector, or null if no proxy is set.
  - setIsDisabled
```
public void setIsDisabled(boolean isDisabled)
```
    Parameters:
    
    isDisabled - If true, all interactions with this API will be silently ignored.
  - getIsDisabled
```
public Boolean getIsDisabled()
```
    Specified by:
    
    getIsDisabled in interface IEyesBase
    
    Returns:
    
    Whether eyes is disabled.
  - clearUserInputs
```
protected void clearUserInputs()
```
    Clears the user inputs list.
  - getUserInputs
```
protected Trigger[] getUserInputs()
```
    Returns:
    
    User inputs collected between checkWindowBase invocations.
  - getBaseAgentId
```
protected abstract String getBaseAgentId()
```
    Returns:
    
    The base agent id of the SDK.
  - getFullAgentId
```
public String getFullAgentId()
```
    Specified by:
    
    getFullAgentId in interface IEyesBase
    
    Returns:
    
    The full agent id composed of both the base agent id and the user given agent id.
  - getIsOpen
```
public boolean getIsOpen()
```
    Specified by:
    
    getIsOpen in interface IEyesBase
    
    Returns:
    
    Whether a session is open.
  - getDefaultServerUrl
```
public static URI getDefaultServerUrl()
```
  - setLogHandler
```
public void setLogHandler(LogHandler logHandler)
```
    Sets a handler of log messages generated by this API.
    
    Specified by:
    
    setLogHandler in interface IEyesBase
    
    Parameters:
    
    logHandler - Handles log messages generated by this API.
  - getLogHandler
```
public LogHandler getLogHandler()
```
    Specified by:
    
    getLogHandler in interface IEyesBase
    
    Returns:
    
    The currently set log handler.
  - getLogger
```
public Logger getLogger()
```
    Specified by:
    
    getLogger in interface IEyesBase
  - setImageCut
```
public void setImageCut(CutProvider cutProvider)
```
    Manually set the the sizes to cut from an image before it's validated.
    
    Parameters:
    
    cutProvider - the provider doing the cut.
  - getIsCutProviderExplicitlySet
```
public boolean getIsCutProviderExplicitlySet()
```
  - getIsScaleProviderExplicitlySet
```
public boolean getIsScaleProviderExplicitlySet()
```
  - setScaleRatio
```
public void setScaleRatio(Double scaleRatio)
```
    Manually set the scale ratio for the images being validated.
    
    Parameters:
    
    scaleRatio - The scale ratio to use, or null to reset back to automatic scaling.
  - getScaleRatio
```
public double getScaleRatio()
```
    Returns:
    
    The ratio used to scale the images being validated.
  - addProperty
```
public void addProperty(String name,
                        String value)
```
    Adds a property to be sent to the server.
    
    Specified by:
    
    addProperty in interface IEyesBase
    
    Parameters:
    
    name - The property name.
    
    value - The property value.
  - addProperty
```
protected void addProperty(PropertyData property)
```
  - clearProperties
```
public void clearProperties()
```
    Clears the list of custom properties.
    
    Specified by:
    
    clearProperties in interface IEyesBase
  - setSaveDebugScreenshots
```
public void setSaveDebugScreenshots(boolean saveDebugScreenshots)
```
    Parameters:
    
    saveDebugScreenshots - If true, will save all screenshots to local directory.
  - getSaveDebugScreenshots
```
public boolean getSaveDebugScreenshots()
```
    Returns:
    
    True if screenshots saving enabled.
  - setDebugScreenshotsPath
```
public void setDebugScreenshotsPath(String pathToSave)
```
    Parameters:
    
    pathToSave - Path where you want to save the debug screenshots.
  - getDebugScreenshotsPath
```
public String getDebugScreenshotsPath()
```
    Returns:
    
    The path where you want to save the debug screenshots.
  - setDebugScreenshotsPrefix
```
public void setDebugScreenshotsPrefix(String prefix)
```
    Parameters:
    
    prefix - The prefix for the screenshots' names.
  - getDebugScreenshotsPrefix
```
public String getDebugScreenshotsPrefix()
```
    Returns:
    
    The prefix for the screenshots' names.
  - getDebugScreenshotsProvider
```
public DebugScreenshotsProvider getDebugScreenshotsProvider()
```
  - prepareStopSession
```
public SessionStopInfo prepareStopSession(boolean isAborted)
```
  - close
```
public TestResults close()
```
    See close(boolean). throwEx defaults to true.
    
    Returns:
    
    The test results.
  - abort
```
public TestResults abort()
```
    Specified by:
    
    abort in interface IEyesBase
  - close
```
public TestResults close(boolean throwEx)
```
    Ends the test.
    
    Parameters:
    
    throwEx - If true, an exception will be thrown for failed/new tests.
    
    Returns:
    
    The test results.
    
    Throws:
    
    TestFailedException - if a mismatch was found and throwEx is true.
    
    NewTestException - if this is a new test was found and throwEx is true.
  - abortIfNotClosed
```
public TestResults abortIfNotClosed()
```
    Specified by:
    
    abortIfNotClosed in interface IEyesBase
  - stopSession
```
protected TestResults stopSession(boolean isAborted)
```
  - logSessionResultsAndThrowException
```
public void logSessionResultsAndThrowException(boolean throwEx,
                                               TestResults results)
```
  - openLogger
```
protected void openLogger()
```
  - getPositionProvider
```
public PositionProvider getPositionProvider()
```
    Returns:
    
    The currently set position provider.
  - setPositionProvider
```
public void setPositionProvider(PositionProvider positionProvider)
```
    Parameters:
    
    positionProvider - The position provider to be used.
  - extractText
```
public List<String> extractText(BaseOcrRegion... ocrRegions)
```
  - getAppOutputForOcr
```
protected abstract void getAppOutputForOcr(BaseOcrRegion ocrRegion)
```
  - extractTextRegions
```
public Map<String,List<TextRegion>> extractTextRegions(TextRegionSettings textRegionSettings)
```
  - getScreenshotProvider
```
protected abstract ScreenshotProvider getScreenshotProvider()
```
  - prepareForMatch
```
protected MatchWindowData prepareForMatch(ICheckSettingsInternal checkSettingsInternal,
                                          List<Trigger> userInputs,
                                          AppOutput appOutput,
                                          String tag,
                                          boolean replaceLast,
                                          ImageMatchSettings imageMatchSettings,
                                          String renderId,
                                          String source)
```
    Creates the match model
    
    Parameters:
    
    userInputs - The user inputs related to the current appOutput.
    
    appOutput - The application output to be matched.
    
    tag - Optional tag to be associated with the match (can be null).
    
    replaceLast - Whether to instruct the server to replace the screenshot of the last step.
    
    imageMatchSettings - The settings to use.
    
    Returns:
    
    The match model.
  - performMatch
```
public MatchResult performMatch(MatchWindowData data)
```
  - checkWindowBase
```
protected MatchResult checkWindowBase(Region region,
                                      String tag,
                                      String source)
```
    See checkWindowBase(Region, String, int, String). retryTimeout defaults to USE_DEFAULT_TIMEOUT.
    
    Parameters:
    
    region - The region to check or null for the entire window.
    
    tag - An optional tag to be associated with the snapshot.
    
    source - A string representing the source of the checkpoint.
    
    Returns:
    
    The result of matching the output with the expected output.
  - checkWindowBase
```
protected MatchResult checkWindowBase(Region region,
                                      String tag,
                                      int retryTimeout,
                                      String source)
```
    Takes a snapshot of the application under test and matches it with the expected output.
    
    Parameters:
    
    region - The region to check or null for the entire window.
    
    tag - An optional tag to be associated with the snapshot.
    
    retryTimeout - The amount of time to retry matching in milliseconds or a negative value to use the default retry timeout.
    
    source - A string representing the source of the checkpoint.
    
    Returns:
    
    The result of matching the output with the expected output.
    
    Throws:
    
    TestFailedException - Thrown if a mismatch is detected and immediate failure reports are enabled.
  - checkWindowBase
```
protected MatchResult checkWindowBase(Region region,
                                      String tag,
                                      ICheckSettings checkSettings)
```
  - checkWindowBase
```
protected MatchResult checkWindowBase(Region region,
                                      ICheckSettings checkSettings,
                                      String source)
```
    Takes a snapshot of the application under test and matches it with the expected output.
    
    Parameters:
    
    region - The region to check or null for the entire window.
    
    checkSettings - The settings to use.
    
    source - A string representing the source of the checkpoint.
    
    Returns:
    
    The result of matching the output with the expected output.
    
    Throws:
    
    TestFailedException - Thrown if a mismatch is detected and immediate failure reports are enabled.
  - checkWindowBase
```
protected MatchResult checkWindowBase(Region region,
                                      ICheckSettingsInternal checkSettingsInternal,
                                      String source)
```
  - tryCaptureDom
```
protected abstract String tryCaptureDom()
```
  - tryCaptureAndPostDom
```
protected String tryCaptureAndPostDom()
```
  - shouldCaptureDom
```
protected boolean shouldCaptureDom(Boolean sendDomFromCheckSettings)
```
  - fireValidationWillStartEvent
```
protected ValidationInfo fireValidationWillStartEvent(String tag)
```
  - validateResult
```
protected void validateResult(MatchResult result)
```
  - setIsDisabled
```
public void setIsDisabled(Boolean isDisabled)
```
    Specified by:
    
    setIsDisabled in interface IEyesBase
  - prepareForOpen
```
public SessionStartInfo prepareForOpen()
```
  - openBase
```
protected void openBase()
                 throws EyesException
```
    Throws:
    
    EyesException
  - openCompleted
```
public void openCompleted(RunningSession result)
```
  - getViewportSizeForOpen
```
protected RectangleSize getViewportSizeForOpen()
```
  - getViewportSize
```
protected abstract RectangleSize getViewportSize()
```
    Returns:
    
    The viewport size of the AUT.
  - setViewportSize
```
protected abstract Configuration setViewportSize(RectangleSize size)
```
    Parameters:
    
    size - The required viewport size.
  - setEffectiveViewportSize
```
protected void setEffectiveViewportSize(RectangleSize size)
```
  - setExplicitViewportSize
```
public void setExplicitViewportSize(RectangleSize explicitViewportSize)
```
    Define the viewport size as size without doing any actual action on the
    
    Parameters:
    
    explicitViewportSize - The size of the viewport. null disables the explicit size.
  - getInferredEnvironment
```
protected abstract String getInferredEnvironment()
```
    Returns:
    
    The inferred environment string or null if none is available. The inferred string is in the format "source:info" where source is either "useragent" or "pos". Information associated with a "useragent" source is a valid browser user agent string. Information associated with a "pos" source is a string of the format "process-name;os-name" where "process-name" is the name of the main module of the executed process and "os-name" is the OS name.
  - getScreenshot
```
protected abstract EyesScreenshot getScreenshot(Region targetRegion,
                                                ICheckSettingsInternal checkSettingsInternal)
```
    Returns:
    
    An updated screenshot.
  - getTitle
```
protected abstract String getTitle()
```
    Returns:
    
    The current title of of the AUT.
  - addUserInput
```
protected void addUserInput(Trigger trigger)
```
    Adds a trigger to the current list of user inputs.
    
    Parameters:
    
    trigger - The trigger to add to the user inputs list.
  - addTextTriggerBase
```
protected void addTextTriggerBase(Region control,
                                  String text)
```
    Adds a text trigger.
    
    Parameters:
    
    control - The control's position relative to the window.
    
    text - The trigger's text.
  - addMouseTriggerBase
```
protected void addMouseTriggerBase(MouseAction action,
                                   Region control,
                                   Location cursor)
```
    Adds a mouse trigger.
    
    Parameters:
    
    action - Mouse action.
    
    control - The control on which the trigger is activated (location is relative to the window).
    
    cursor - The cursor's position relative to the control.
  - getAppEnvironment
```
protected Object getAppEnvironment()
```
    Application environment is the environment (e.g., the host OS) which runs the application under test.
    
    Returns:
    
    The current application environment.
  - getTestName
```
protected String getTestName()
```
  - getAppName
```
protected String getAppName()
```
  - getBaselineEnvName
```
protected String getBaselineEnvName()
```
  - getAgentSetup
```
public Object getAgentSetup()
```
  - isSendDom
```
public Boolean isSendDom()
```
  - setSendDom
```
public Configuration setSendDom(boolean isSendDom)
```
  - getRenderingInfo
```
public RenderingInfo getRenderingInfo()
```
  - getDevicesSizes
```
public Map<String,DeviceSize> getDevicesSizes(String path)
```
  - getUserAgents
```
public Map<String,String> getUserAgents()
```
  - getMobileDeviceInfo
```
public Map<String,MobileDeviceInfo> getMobileDeviceInfo()
```
  - setBatch
```
public Configuration setBatch(BatchInfo batch)
```
    Sets the batch in which context future tests will run or null if tests are to run standalone.
    
    Parameters:
    
    batch - The batch info to set.
  - getConfigurationInstance
```
protected abstract Configuration getConfigurationInstance()
```
    Returns:
    
    Underlying instance of the configuration for modification
  - getConfiguration
```
public Configuration getConfiguration()
```
    Returns:
    
    Cloned instance of the configuration
  - closeAsync
```
public void closeAsync()
```
    Specified by:
    
    closeAsync in interface IEyesBase
  - abortAsync
```
public void abortAsync()
```
    Specified by:
    
    abortAsync in interface IEyesBase
  - isCompleted
```
public boolean isCompleted()
```

Class EyesBase

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

USE_DEFAULT_TIMEOUT

agentRunId

runner

serverConnector

runningSession

sessionStartInfo

testResultContainer

lastScreenshot

scaleProviderHandler

cutProviderHandler

positionProviderHandler

logger

isOpen

debugScreenshotsProvider

Constructor Detail

EyesBase

EyesBase

Method Detail

getTestId

setTestId

setServerConnector

getServerConnector

setApiKey

getApiKey

setServerUrl

setServerUrl

getServerUrl

setProxy

getProxy

setIsDisabled

getIsDisabled

clearUserInputs

getUserInputs

getBaseAgentId

getFullAgentId

getIsOpen

getDefaultServerUrl

setLogHandler

getLogHandler

getLogger

setImageCut

getIsCutProviderExplicitlySet

getIsScaleProviderExplicitlySet

setScaleRatio

getScaleRatio

addProperty

addProperty

clearProperties

setSaveDebugScreenshots

getSaveDebugScreenshots

setDebugScreenshotsPath

getDebugScreenshotsPath

setDebugScreenshotsPrefix

getDebugScreenshotsPrefix

getDebugScreenshotsProvider

prepareStopSession

close

abort

close

abortIfNotClosed

stopSession

logSessionResultsAndThrowException

openLogger

getPositionProvider

setPositionProvider

extractText

getAppOutputForOcr

extractTextRegions

getScreenshotProvider

prepareForMatch

performMatch

checkWindowBase

checkWindowBase

checkWindowBase