Package com.applitools.eyes.appium

Class AppiumCheckSettings

java.lang.Object

com.applitools.eyes.fluent.CheckSettings

com.applitools.eyes.appium.AppiumCheckSettings

All Implemented Interfaces:

com.applitools.eyes.fluent.ICheckSettingsInternal, com.applitools.ICheckSettings, com.applitools.ICheckSettingsInternal

public class AppiumCheckSettings
extends com.applitools.eyes.fluent.CheckSettings

Field Summary

Fields inherited from class com.applitools.eyes.fluent.CheckSettings

accessibilityRegions, BEFORE_CAPTURE_SCREENSHOT, contentRegions, enablePatterns, floatingRegions, ignoreDisplacements, ignoreRegions, layoutRegions, name, scriptHooks, sendDom, strictRegions, useDom

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	AppiumCheckSettings()
protected	AppiumCheckSettings(boolean isWebView)
protected	AppiumCheckSettings(com.applitools.eyes.Region region)
protected	AppiumCheckSettings(String webview)
protected	AppiumCheckSettings(org.openqa.selenium.By selector)
protected	AppiumCheckSettings(org.openqa.selenium.WebElement webElement)

Method Summary

Modifier and Type	Method	Description
AppiumCheckSettings	accessibility(com.applitools.eyes.AccessibilityRegionType regionType, org.openqa.selenium.WebElement[] elementsToIgnore)
AppiumCheckSettings	accessibility(org.openqa.selenium.By regionSelector, com.applitools.eyes.AccessibilityRegionType regionType)
AppiumCheckSettings	accessibility(org.openqa.selenium.WebElement element, com.applitools.eyes.AccessibilityRegionType regionType)
AppiumCheckSettings	captureStatusBar()
AppiumCheckSettings	captureStatusBar(boolean captureStatusBar)
AppiumCheckSettings	clone()
AppiumCheckSettings	content(org.openqa.selenium.By regionSelector, org.openqa.selenium.By... regionSelectors)
AppiumCheckSettings	content(org.openqa.selenium.WebElement[] elements)
AppiumCheckSettings	content(org.openqa.selenium.WebElement element, org.openqa.selenium.WebElement... elements)
AppiumCheckSettings	cut(ElementType type, org.openqa.selenium.By selector)
AppiumCheckSettings	densityMetrics(int xDpi, int yDpi)
AppiumCheckSettings	densityMetrics(int xDpi, int yDpi, Double scaleRatio)
AppiumCheckSettings	floating(org.openqa.selenium.By regionSelector, int maxUpOffset, int maxDownOffset, int maxLeftOffset, int maxRightOffset)
AppiumCheckSettings	floating(org.openqa.selenium.WebElement element, int maxUpOffset, int maxDownOffset, int maxLeftOffset, int maxRightOffset)
AppiumCheckSettings	fully()
AppiumCheckSettings	fully(Boolean fully)
Boolean	getCaptureStatusBar()
org.openqa.selenium.By	getCutElementSelector()
ElementType	getCutElementType()
Boolean	getIsDefaultWebview()
com.applitools.eyes.LazyLoadOptions	getLazyLoadOptions()
List<com.applitools.eyes.visualgrid.model.NMGOptions>	getNMGOptions()
String	getPageId()
Boolean	getScreenshotMode()
org.openqa.selenium.WebElement	getScrollRootElement()
String	getScrollRootElementId()
org.openqa.selenium.By	getScrollRootElementSelector()
Boolean	getStatusBarExists()
org.openqa.selenium.WebElement	getTargetElement()
org.openqa.selenium.By	getTargetSelector()
String	getWebview()
AppiumCheckSettings	ignore(org.openqa.selenium.By regionSelector, org.openqa.selenium.By... regionSelectors)
AppiumCheckSettings	ignore(org.openqa.selenium.WebElement[] elements)
AppiumCheckSettings	ignore(org.openqa.selenium.WebElement element, org.openqa.selenium.WebElement... elements)
boolean	isNotRegion()
AppiumCheckSettings	layout(org.openqa.selenium.By regionSelector, org.openqa.selenium.By... regionSelectors)
AppiumCheckSettings	layout(org.openqa.selenium.WebElement[] elements)
AppiumCheckSettings	layout(org.openqa.selenium.WebElement element, org.openqa.selenium.WebElement... elements)
AppiumCheckSettings	lazyLoad()
AppiumCheckSettings	lazyLoad(com.applitools.eyes.LazyLoadOptions lazyLoadOptions)
AppiumCheckSettings	NMGOptions(com.applitools.eyes.visualgrid.model.NMGOptions... options)
AppiumCheckSettings	pageId(String pageId)
AppiumCheckSettings	scrollRootElement(String elementId)
AppiumCheckSettings	scrollRootElement(org.openqa.selenium.By selector)
AppiumCheckSettings	scrollRootElement(org.openqa.selenium.WebElement element)
AppiumCheckSettings	statusBarExists()
AppiumCheckSettings	statusBarExists(boolean statusBarExists)
AppiumCheckSettings	strict(org.openqa.selenium.By regionSelector, org.openqa.selenium.By... regionSelectors)
AppiumCheckSettings	strict(org.openqa.selenium.WebElement[] elements)
AppiumCheckSettings	strict(org.openqa.selenium.WebElement element, org.openqa.selenium.WebElement... elements)
AppiumCheckSettings	useSystemScreenshot()
AppiumCheckSettings	useSystemScreenshot(Boolean useSystemScreenshot)
AppiumCheckSettings	webview()
AppiumCheckSettings	webview(Boolean isWebView)
AppiumCheckSettings	webview(String webView)

Methods inherited from class com.applitools.eyes.fluent.CheckSettings

accessibility, accessibility, accessibility_, accessibility_, autProxy, beforeRenderScreenshotHook, content, content, content, content_, content_, enablePatterns, enablePatterns, exact, floating, floating, floating, floating_, getAccessibilityRegions, getAccessibilityValidation, getAutProxy, getContentRegions, getDensityMetrics, getFloatingRegions, getHideCaret, getHideScrollBars, getIgnoreCaret, getIgnoreRegions, getLayoutBreakpoints, getLayoutBreakpointsOptions, getLayoutRegions, getMatchLevel, getName, getOcrRegion, getOverlap, getScriptHooks, getSizeMode, getStepPositionProvider, getStitchContent, getStitchMode, getStitchOverlap, getStrictRegions, getTargetRegion, getTimeout, getVariationGroupId, getVisualGridOptions, getWaitBeforeCapture, hideCaret, hideScrollBars, ignore, ignore, ignore_, ignore_, ignoreCaret, ignoreCaret, ignoreColors, ignoreDisplacements, ignoreDisplacements, isCheckWindow, isDefaultLayoutBreakpointsSet, isDisableBrowserFetching, isEnablePatterns, isIgnoreDisplacements, isSendDom, isStitchContent, isUseDom, layout, layout, layout, layout_, layout_, layoutBreakpoints, layoutBreakpoints, layoutBreakpoints, layoutBreakpoints, matchLevel, ocrRegion, populateClone, scriptHook, sendDom, sendDom, setAccessibilityValidation, setDisableBrowserFetching, setHideCaret, setHideScrollBars, setLayoutBreakpoints, setLayoutBreakpoints, setLayoutBreakpoints, setOverlap, setStitchContent, stitchMode, stitchOverlap, stitchOverlap, strict, strict, strict, strict_, strict_, timeout, updateTargetRegion, useDom, variationGroupId, visualGridOptions, waitBeforeCapture, withName

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

AppiumCheckSettings

protected AppiumCheckSettings()

AppiumCheckSettings

protected AppiumCheckSettings(com.applitools.eyes.Region region)

AppiumCheckSettings

protected AppiumCheckSettings(org.openqa.selenium.By selector)

AppiumCheckSettings

protected AppiumCheckSettings(org.openqa.selenium.WebElement webElement)

AppiumCheckSettings

protected AppiumCheckSettings(boolean isWebView)

AppiumCheckSettings

protected AppiumCheckSettings(String webview)

Method Detail

clone

public AppiumCheckSettings clone()

Specified by:

clone in interface com.applitools.ICheckSettingsInternal

Overrides:

clone in class com.applitools.eyes.fluent.CheckSettings

layout

public AppiumCheckSettings layout(org.openqa.selenium.By regionSelector,
                                  org.openqa.selenium.By... regionSelectors)

layout

public AppiumCheckSettings layout(org.openqa.selenium.WebElement[] elements)

layout

public AppiumCheckSettings layout(org.openqa.selenium.WebElement element,
                                  org.openqa.selenium.WebElement... elements)

ignore

public AppiumCheckSettings ignore(org.openqa.selenium.By regionSelector,
                                  org.openqa.selenium.By... regionSelectors)

ignore

public AppiumCheckSettings ignore(org.openqa.selenium.WebElement element,
                                  org.openqa.selenium.WebElement... elements)

ignore

public AppiumCheckSettings ignore(org.openqa.selenium.WebElement[] elements)

strict

public AppiumCheckSettings strict(org.openqa.selenium.By regionSelector,
                                  org.openqa.selenium.By... regionSelectors)

strict

public AppiumCheckSettings strict(org.openqa.selenium.WebElement element,
                                  org.openqa.selenium.WebElement... elements)

strict

public AppiumCheckSettings strict(org.openqa.selenium.WebElement[] elements)

content

public AppiumCheckSettings content(org.openqa.selenium.By regionSelector,
                                   org.openqa.selenium.By... regionSelectors)

content

public AppiumCheckSettings content(org.openqa.selenium.WebElement element,
                                   org.openqa.selenium.WebElement... elements)

content

public AppiumCheckSettings content(org.openqa.selenium.WebElement[] elements)

floating

public AppiumCheckSettings floating(org.openqa.selenium.By regionSelector,
                                    int maxUpOffset,
                                    int maxDownOffset,
                                    int maxLeftOffset,
                                    int maxRightOffset)

floating

public AppiumCheckSettings floating(org.openqa.selenium.WebElement element,
                                    int maxUpOffset,
                                    int maxDownOffset,
                                    int maxLeftOffset,
                                    int maxRightOffset)

accessibility

public AppiumCheckSettings accessibility(org.openqa.selenium.By regionSelector,
                                         com.applitools.eyes.AccessibilityRegionType regionType)

accessibility

public AppiumCheckSettings accessibility(org.openqa.selenium.WebElement element,
                                         com.applitools.eyes.AccessibilityRegionType regionType)

accessibility

public AppiumCheckSettings accessibility(com.applitools.eyes.AccessibilityRegionType regionType,
                                         org.openqa.selenium.WebElement[] elementsToIgnore)

cut

public AppiumCheckSettings cut(@Nonnull
                               ElementType type,
                               @Nonnull
                               org.openqa.selenium.By selector)

getCutElementType

public ElementType getCutElementType()

getCutElementSelector

public org.openqa.selenium.By getCutElementSelector()

statusBarExists

public AppiumCheckSettings statusBarExists()

statusBarExists

public AppiumCheckSettings statusBarExists(boolean statusBarExists)

getStatusBarExists

public Boolean getStatusBarExists()

getTargetSelector

public org.openqa.selenium.By getTargetSelector()

getTargetElement

public org.openqa.selenium.WebElement getTargetElement()

fully

public AppiumCheckSettings fully()

Specified by:

fully in interface com.applitools.ICheckSettings

Overrides:

fully in class com.applitools.eyes.fluent.CheckSettings

fully

public AppiumCheckSettings fully(Boolean fully)

Specified by:

fully in interface com.applitools.ICheckSettings

Overrides:

fully in class com.applitools.eyes.fluent.CheckSettings

scrollRootElement

public AppiumCheckSettings scrollRootElement(String elementId)

scrollRootElement

public AppiumCheckSettings scrollRootElement(org.openqa.selenium.By selector)

scrollRootElement

public AppiumCheckSettings scrollRootElement(org.openqa.selenium.WebElement element)

captureStatusBar

public AppiumCheckSettings captureStatusBar()

captureStatusBar

public AppiumCheckSettings captureStatusBar(boolean captureStatusBar)

getScrollRootElementId

public String getScrollRootElementId()

getScrollRootElementSelector

public org.openqa.selenium.By getScrollRootElementSelector()

getScrollRootElement

public org.openqa.selenium.WebElement getScrollRootElement()

getCaptureStatusBar

public Boolean getCaptureStatusBar()

isNotRegion

public boolean isNotRegion()

pageId

public AppiumCheckSettings pageId(String pageId)

Overrides:

pageId in class com.applitools.eyes.fluent.CheckSettings

getPageId

public String getPageId()

Overrides:

getPageId in class com.applitools.eyes.fluent.CheckSettings

lazyLoad

public AppiumCheckSettings lazyLoad()

Specified by:

lazyLoad in interface com.applitools.ICheckSettings

Overrides:

lazyLoad in class com.applitools.eyes.fluent.CheckSettings

lazyLoad

public AppiumCheckSettings lazyLoad(com.applitools.eyes.LazyLoadOptions lazyLoadOptions)

Specified by:

lazyLoad in interface com.applitools.ICheckSettings

Overrides:

lazyLoad in class com.applitools.eyes.fluent.CheckSettings

getLazyLoadOptions

public com.applitools.eyes.LazyLoadOptions getLazyLoadOptions()

Overrides:

getLazyLoadOptions in class com.applitools.eyes.fluent.CheckSettings

densityMetrics

public AppiumCheckSettings densityMetrics(int xDpi,
                                          int yDpi)

Specified by:

densityMetrics in interface com.applitools.ICheckSettings

Overrides:

densityMetrics in class com.applitools.eyes.fluent.CheckSettings

densityMetrics

public AppiumCheckSettings densityMetrics(int xDpi,
                                          int yDpi,
                                          Double scaleRatio)

Specified by:

densityMetrics in interface com.applitools.ICheckSettings

Overrides:

densityMetrics in class com.applitools.eyes.fluent.CheckSettings

webview

public AppiumCheckSettings webview()

webview

public AppiumCheckSettings webview(Boolean isWebView)

webview

public AppiumCheckSettings webview(String webView)

getIsDefaultWebview

public Boolean getIsDefaultWebview()

getWebview

public String getWebview()

getNMGOptions

public List<com.applitools.eyes.visualgrid.model.NMGOptions> getNMGOptions()

NMGOptions

public AppiumCheckSettings NMGOptions(com.applitools.eyes.visualgrid.model.NMGOptions... options)

getScreenshotMode

public Boolean getScreenshotMode()

useSystemScreenshot

public AppiumCheckSettings useSystemScreenshot()

useSystemScreenshot

public AppiumCheckSettings useSystemScreenshot(Boolean useSystemScreenshot)