Index
All Classes and Interfaces|All Packages|Serialized Form
A
- activateTab(String) - Method in class dev.botcity.framework.bot.WebBot
-
Activate a tab given by the handle.
- addImage(String, String) - Method in class dev.botcity.framework.bot.DesktopBot
-
Add image of UI element to be recognized in automation processes.
- addImage(String, String) - Method in class dev.botcity.framework.bot.WebBot
-
Add an image into the state image map.
- addImage(String, MarvinImage) - Method in class dev.botcity.framework.bot.DesktopBot
-
Add image of UI element to be recognized in automation processes.
- altE() - Method in class dev.botcity.framework.bot.DesktopBot
- altE(int) - Method in class dev.botcity.framework.bot.DesktopBot
- altF() - Method in class dev.botcity.framework.bot.DesktopBot
- altF(int) - Method in class dev.botcity.framework.bot.DesktopBot
- altF4() - Method in class dev.botcity.framework.bot.DesktopBot
- altF4(int) - Method in class dev.botcity.framework.bot.DesktopBot
- altPlusLetter(char) - Method in class dev.botcity.framework.bot.DesktopBot
- altPlusLetter(char, int) - Method in class dev.botcity.framework.bot.DesktopBot
- altR() - Method in class dev.botcity.framework.bot.DesktopBot
- altR(int) - Method in class dev.botcity.framework.bot.DesktopBot
- altSpace() - Method in class dev.botcity.framework.bot.DesktopBot
- altSpace(int) - Method in class dev.botcity.framework.bot.DesktopBot
- altU() - Method in class dev.botcity.framework.bot.DesktopBot
- altU(int) - Method in class dev.botcity.framework.bot.DesktopBot
B
- back() - Method in class dev.botcity.framework.bot.WebBot
-
Pressing the browser’s back button.
- backspace() - Method in class dev.botcity.framework.bot.DesktopBot
- backspace() - Method in class dev.botcity.framework.bot.WebBot
-
Press Backspace key.
- backspace(int) - Method in class dev.botcity.framework.bot.DesktopBot
- backspace(int) - Method in class dev.botcity.framework.bot.WebBot
-
Press Backspace key.
- browse(String) - Method in class dev.botcity.framework.bot.DesktopBot
-
Invoke the default browser passing a URL
- browse(String) - Method in class dev.botcity.framework.bot.WebBot
-
Opens the browser on the given URL.
- Browser - Enum in dev.botcity.framework.web.browsers
-
Supported browsers.
- BrowserConfig - Interface in dev.botcity.framework.web.browsers
C
- center() - Method in class dev.botcity.framework.bot.UIElement
- CHROME - Enum constant in enum dev.botcity.framework.web.browsers.Browser
- ChromeConfig - Class in dev.botcity.framework.web.browsers
- ChromeConfig() - Constructor for class dev.botcity.framework.web.browsers.ChromeConfig
- click() - Method in class dev.botcity.framework.bot.DesktopBot
-
Click in last found UI element.
- click() - Method in class dev.botcity.framework.bot.WebBot
-
Click on the last found element.
- click(int) - Method in class dev.botcity.framework.bot.DesktopBot
- click(int) - Method in class dev.botcity.framework.bot.WebBot
-
Click on the last found element.
- click(int, int, String, int) - Method in class dev.botcity.framework.bot.WebBot
-
Click on the last found element.
- click(State) - Method in class dev.botcity.framework.bot.WebBot
-
Left click on the last found element.
- clickAt(int, int) - Method in class dev.botcity.framework.bot.DesktopBot
- clickAt(int, int) - Method in class dev.botcity.framework.bot.WebBot
-
Click at the coordinate defined by x and y.
- clickAt(int, int, int) - Method in class dev.botcity.framework.bot.DesktopBot
- clickAt(int, int, int) - Method in class dev.botcity.framework.bot.WebBot
-
Click at the coordinate defined by x and y.
- clickAt(int, int, int, int, String) - Method in class dev.botcity.framework.bot.WebBot
-
Click at the coordinate defined by x and y.
- clickOn(String) - Method in class dev.botcity.framework.bot.DesktopBot
- clickOn(String) - Method in class dev.botcity.framework.bot.WebBot
-
Click on the element.
- clickOn(String, double) - Method in class dev.botcity.framework.bot.WebBot
-
Click on the element.
- clickOn(MarvinImage) - Method in class dev.botcity.framework.bot.DesktopBot
- clickRelative(int, int) - Method in class dev.botcity.framework.bot.DesktopBot
-
Click relative the last found UI element.
- clickRelative(int, int) - Method in class dev.botcity.framework.bot.WebBot
-
Click Relative on the last found element.
- closePage() - Method in class dev.botcity.framework.bot.WebBot
-
Close the current active page (tab or window).
- controlA() - Method in class dev.botcity.framework.bot.DesktopBot
- controlA() - Method in class dev.botcity.framework.bot.WebBot
-
Press keys CTRL+A.
- controlA(int) - Method in class dev.botcity.framework.bot.DesktopBot
- controlA(int) - Method in class dev.botcity.framework.bot.WebBot
-
Press keys CTRL+A.
- controlC() - Method in class dev.botcity.framework.bot.DesktopBot
- controlC() - Method in class dev.botcity.framework.bot.WebBot
-
Press keys CTRL+C.
- controlC(int) - Method in class dev.botcity.framework.bot.DesktopBot
- controlC(int) - Method in class dev.botcity.framework.bot.WebBot
-
Press keys CTRL+C.
- controlEnd() - Method in class dev.botcity.framework.bot.DesktopBot
- controlEnd(int) - Method in class dev.botcity.framework.bot.DesktopBot
- controlF() - Method in class dev.botcity.framework.bot.DesktopBot
- controlF(int) - Method in class dev.botcity.framework.bot.DesktopBot
- controlHome() - Method in class dev.botcity.framework.bot.DesktopBot
- controlHome(int) - Method in class dev.botcity.framework.bot.DesktopBot
- controlP() - Method in class dev.botcity.framework.bot.DesktopBot
- controlP(int) - Method in class dev.botcity.framework.bot.DesktopBot
- controlR() - Method in class dev.botcity.framework.bot.DesktopBot
- controlR(int) - Method in class dev.botcity.framework.bot.DesktopBot
- controlShiftJ() - Method in class dev.botcity.framework.bot.DesktopBot
- controlShiftJ(int) - Method in class dev.botcity.framework.bot.DesktopBot
- controlShiftP() - Method in class dev.botcity.framework.bot.DesktopBot
- controlShiftP(int) - Method in class dev.botcity.framework.bot.DesktopBot
- controlT() - Method in class dev.botcity.framework.bot.DesktopBot
- controlT(int) - Method in class dev.botcity.framework.bot.DesktopBot
- controlU() - Method in class dev.botcity.framework.bot.DesktopBot
- controlU(int) - Method in class dev.botcity.framework.bot.DesktopBot
- controlV() - Method in class dev.botcity.framework.bot.DesktopBot
- controlV() - Method in class dev.botcity.framework.bot.WebBot
-
Press keys CTRL+X.
- controlV(int) - Method in class dev.botcity.framework.bot.DesktopBot
- controlW() - Method in class dev.botcity.framework.bot.DesktopBot
- controlW(int) - Method in class dev.botcity.framework.bot.DesktopBot
- copyToClipboard(String) - Method in class dev.botcity.framework.bot.DesktopBot
-
Copy content to the clipboard
- copyToClipboard(String) - Method in class dev.botcity.framework.bot.WebBot
-
Copy content to the clipboard.
- copyToClipboard(String, int) - Method in class dev.botcity.framework.bot.DesktopBot
-
Copy content to the clipboard
- createTab(String) - Method in class dev.botcity.framework.bot.WebBot
-
Create a new tab and navigate to the given URL.
- createWindow(String) - Method in class dev.botcity.framework.bot.WebBot
-
Creates a new window with the given URL.
- CVFind - Class in dev.botcity.framework.web
- CVFind() - Constructor for class dev.botcity.framework.web.CVFind
D
- dataFromRow(WebElement, String, String) - Static method in class dev.botcity.framework.web.parsers.TableParser
-
Extract data from a row and return it as a list.
- defaultCapabilities() - Method in interface dev.botcity.framework.web.browsers.BrowserConfig
-
Fetch the default capabilities from the browser.
- defaultCapabilities() - Method in class dev.botcity.framework.web.browsers.ChromeConfig
- defaultCapabilities() - Method in class dev.botcity.framework.web.browsers.EdgeConfig
- defaultCapabilities() - Method in class dev.botcity.framework.web.browsers.FirefoxConfig
- defaultOptions(boolean, String, String) - Method in class dev.botcity.framework.web.browsers.ChromeConfig
- defaultOptions(boolean, String, String) - Method in class dev.botcity.framework.web.browsers.EdgeConfig
- defaultOptions(boolean, String, String) - Method in class dev.botcity.framework.web.browsers.FirefoxConfig
- defaultOptions(boolean, String, String, PageLoadStrategy) - Method in interface dev.botcity.framework.web.browsers.BrowserConfig
-
Retrieve the default options from the browser curated by BotCity.
- defaultOptions(boolean, String, String, PageLoadStrategy) - Method in class dev.botcity.framework.web.browsers.ChromeConfig
- defaultOptions(boolean, String, String, PageLoadStrategy) - Method in class dev.botcity.framework.web.browsers.EdgeConfig
- defaultOptions(boolean, String, String, PageLoadStrategy) - Method in class dev.botcity.framework.web.browsers.FirefoxConfig
- delete() - Method in class dev.botcity.framework.bot.DesktopBot
- delete() - Method in class dev.botcity.framework.bot.WebBot
-
Press key Delete.
- delete(int) - Method in class dev.botcity.framework.bot.DesktopBot
- delete(int) - Method in class dev.botcity.framework.bot.WebBot
-
Press key Delete.
- DesktopBot - Class in dev.botcity.framework.bot
-
Provides a robot interface to operate desktop applications.
- DesktopBot() - Constructor for class dev.botcity.framework.bot.DesktopBot
- dev.botcity.framework.bot - package dev.botcity.framework.bot
-
Bot development package.
- dev.botcity.framework.web - package dev.botcity.framework.web
-
WebBot development package.
- dev.botcity.framework.web.browsers - package dev.botcity.framework.web.browsers
- dev.botcity.framework.web.exceptions - package dev.botcity.framework.web.exceptions
- dev.botcity.framework.web.parsers - package dev.botcity.framework.web.parsers
- displaySize() - Method in class dev.botcity.framework.bot.WebBot
-
Returns the display size in pixels.
- doubleclick() - Method in class dev.botcity.framework.bot.DesktopBot
-
Double-click in last found UI element.
- doubleClick() - Method in class dev.botcity.framework.bot.WebBot
-
Double Click on the last found element.
- doubleClick(int) - Method in class dev.botcity.framework.bot.WebBot
-
Double Click on the last found element.
- doubleClickRelative(int, int) - Method in class dev.botcity.framework.bot.DesktopBot
-
Double-click relative the last found UI element.
- doubleClickRelative(int, int) - Method in class dev.botcity.framework.bot.WebBot
-
Double Click Relative on the last found element.
- doubleClickRelative(int, int, int) - Method in class dev.botcity.framework.bot.DesktopBot
-
Double-click relative the last found UI element.
E
- EAGER - Enum constant in enum dev.botcity.framework.web.browsers.PageLoadStrategy
- EDGE - Enum constant in enum dev.botcity.framework.web.browsers.Browser
- EdgeConfig - Class in dev.botcity.framework.web.browsers
- EdgeConfig() - Constructor for class dev.botcity.framework.web.browsers.EdgeConfig
- ElementNotAvailableException - Exception in dev.botcity.framework.web.exceptions
- ElementNotAvailableException(String) - Constructor for exception dev.botcity.framework.web.exceptions.ElementNotAvailableException
- enableDebug() - Method in class dev.botcity.framework.bot.DesktopBot
- enter() - Method in class dev.botcity.framework.bot.DesktopBot
-
Press key "enter"
- enter() - Method in class dev.botcity.framework.bot.WebBot
-
Press key Enter.
- enter(int) - Method in class dev.botcity.framework.bot.DesktopBot
-
Press key "enter"
- enter(int) - Method in class dev.botcity.framework.bot.WebBot
- enterIframe(WebElement) - Method in class dev.botcity.framework.bot.WebBot
-
Switch the WebBot driver to the specified iframe.
- exec(String) - Method in class dev.botcity.framework.bot.DesktopBot
-
Command line execution used to run commands or start applications.
- executeJavascript(String, Object...) - Method in class dev.botcity.framework.bot.WebBot
-
Execute the given javascript code.
- executor(WebDriver) - Method in interface dev.botcity.framework.web.browsers.BrowserConfig
-
Get browser executor.
- executor(WebDriver) - Method in class dev.botcity.framework.web.browsers.ChromeConfig
- executor(WebDriver) - Method in class dev.botcity.framework.web.browsers.EdgeConfig
- executor(WebDriver) - Method in class dev.botcity.framework.web.browsers.FirefoxConfig
F
- find(String, double, boolean, long) - Method in class dev.botcity.framework.bot.WebBot
-
Find an element defined by label on screen until a timeout happens.
- find(String, double, int, boolean, long) - Method in class dev.botcity.framework.bot.WebBot
-
Find an element defined by label on screen until a timeout happens.
- find(String, double, long) - Method in class dev.botcity.framework.bot.WebBot
-
Find an element defined by label on screen until a timeout happens.
- find(String, int, int, int, int, Double, int) - Method in class dev.botcity.framework.bot.DesktopBot
- find(String, Double, int) - Method in class dev.botcity.framework.bot.DesktopBot
- find(String, Double, int, boolean) - Method in class dev.botcity.framework.bot.DesktopBot
- find(String, MarvinImage, int, int, int, int, Double, int) - Method in class dev.botcity.framework.bot.DesktopBot
- find(String, MarvinImage, Double, int) - Method in class dev.botcity.framework.bot.DesktopBot
- find(String, MarvinImage, Double, int, boolean) - Method in class dev.botcity.framework.bot.DesktopBot
- findAll(String, double, long) - Method in class dev.botcity.framework.bot.WebBot
-
Find all elements defined by label on screen until a timeout happens.
- findAll(String, Region, int, boolean, double, long, boolean) - Method in class dev.botcity.framework.bot.WebBot
-
Find all elements defined by label on screen until a timeout happens.
- findAll(MarvinImage, Region, int, boolean, double, long, boolean) - Method in class dev.botcity.framework.bot.WebBot
-
Find all elements defined by label on screen until a timeout happens.
- findAllElements(MarvinImage, MarvinImage, Region, double, boolean) - Method in class dev.botcity.framework.web.CVFind
-
Find all elements in the image.
- findAllSubimages(MarvinImage, MarvinImage, int, int, int, int, Double) - Method in class dev.botcity.framework.bot.DesktopBot
- findAllUntil(String, double, int) - Method in class dev.botcity.framework.bot.DesktopBot
- findAllUntil(String, MarvinImage, Integer, Integer, Integer, Integer, Integer, Double, int) - Method in class dev.botcity.framework.bot.DesktopBot
- findBestElement(List<State>) - Method in class dev.botcity.framework.web.CVFind
-
Returns the element with the best score.
- findElement(By) - Method in class dev.botcity.framework.bot.WebBot
-
Find an element using the specified selector with selector type specified by `by`.
- findElement(By, boolean, boolean, long) - Method in class dev.botcity.framework.bot.WebBot
-
Find an element using the specified selector with selector type specified by `by`.
- findElements(By) - Method in class dev.botcity.framework.bot.WebBot
-
Find elements using the specified selector with selector type specified by `by`.
- findElements(By, boolean, long) - Method in class dev.botcity.framework.bot.WebBot
-
Find elements using the specified selector with selector type specified by `by`.
- findLastUntil(String, int) - Method in class dev.botcity.framework.bot.DesktopBot
- findLastUntil(String, MarvinImage, int) - Method in class dev.botcity.framework.bot.DesktopBot
- findLastUntil(String, MarvinImage, Integer, int) - Method in class dev.botcity.framework.bot.DesktopBot
- findMultiple(List<String>, double, long) - Method in class dev.botcity.framework.bot.WebBot
-
Find multiple elements defined by label on screen until a timeout happens.
- findMultiple(List<String>, Region, int, boolean, double, long, boolean) - Method in class dev.botcity.framework.bot.WebBot
-
Find multiple elements defined by label on screen until a timeout happens.
- findRelative(String, MarvinImage, UIElement, int, int, int, int, Integer, Double, int, boolean) - Method in class dev.botcity.framework.bot.DesktopBot
- findSubimage(MarvinImage, MarvinImage, int, int, int, int, Double, boolean) - Method in class dev.botcity.framework.bot.DesktopBot
- findSubimage(MarvinImage, MarvinImage, int, int, Double, boolean) - Method in class dev.botcity.framework.bot.DesktopBot
- findText(String, double, long) - Method in class dev.botcity.framework.bot.WebBot
-
Find an element defined by label on screen until a timeout happens.
- findText(String, int) - Method in class dev.botcity.framework.bot.DesktopBot
-
Find a text element in the UI.
- findText(String, int, boolean) - Method in class dev.botcity.framework.bot.DesktopBot
-
Find a text element in the UI.
- findText(String, int, double, long) - Method in class dev.botcity.framework.bot.WebBot
-
Find an element defined by label on screen until a timeout happens.
- findText(String, Integer, double, int) - Method in class dev.botcity.framework.bot.DesktopBot
-
Find a text element in the UI.
- findText(String, Integer, double, int, boolean) - Method in class dev.botcity.framework.bot.DesktopBot
-
Find a text element in the UI.
- findText(String, Integer, int) - Method in class dev.botcity.framework.bot.DesktopBot
-
Find a text element in the UI.
- findText(String, Integer, int, boolean) - Method in class dev.botcity.framework.bot.DesktopBot
-
Find a text element in the UI.
- findText(String, MarvinImage, int) - Method in class dev.botcity.framework.bot.DesktopBot
- findText(String, MarvinImage, int, boolean) - Method in class dev.botcity.framework.bot.DesktopBot
- findText(String, MarvinImage, Integer, double, int) - Method in class dev.botcity.framework.bot.DesktopBot
- findText(String, MarvinImage, Integer, double, int, boolean) - Method in class dev.botcity.framework.bot.DesktopBot
- findText(String, MarvinImage, Integer, int) - Method in class dev.botcity.framework.bot.DesktopBot
- findText(String, MarvinImage, Integer, int, boolean) - Method in class dev.botcity.framework.bot.DesktopBot
- findText(String, MarvinImage, Integer, Integer, Integer, Integer, Integer, int, boolean) - Method in class dev.botcity.framework.bot.DesktopBot
- findUntil(String, int, boolean, double, long) - Method in class dev.botcity.framework.bot.WebBot
-
Find an element defined by label on screen until a timeout happens.
- findUntil(String, Region, int, boolean, double, long, boolean) - Method in class dev.botcity.framework.bot.WebBot
-
Find an element defined by label on screen until a timeout happens.
- findUntil(String, Integer, Double, int) - Method in class dev.botcity.framework.bot.DesktopBot
- findUntil(String, Integer, Double, int, boolean) - Method in class dev.botcity.framework.bot.DesktopBot
- findUntil(String, MarvinImage, int, int, int, int, Integer, Double, int) - Method in class dev.botcity.framework.bot.DesktopBot
- findUntil(String, MarvinImage, int, int, Integer, Double, int) - Method in class dev.botcity.framework.bot.DesktopBot
- findUntil(String, MarvinImage, Integer, Double, int) - Method in class dev.botcity.framework.bot.DesktopBot
- findUntil(String, MarvinImage, Integer, Double, int, boolean) - Method in class dev.botcity.framework.bot.DesktopBot
- findUntil(String, MarvinImage, Integer, Integer, Integer, Integer, Integer, Double, int, boolean) - Method in class dev.botcity.framework.bot.DesktopBot
- findUntil(MarvinImage, int, boolean, double) - Method in class dev.botcity.framework.bot.WebBot
-
Find an element defined by label on screen until a timeout happens.
- findUntil(MarvinImage, Region, int, boolean, double, long, boolean) - Method in class dev.botcity.framework.bot.WebBot
-
Find an element defined by label on screen until a timeout happens.
- FIREFOX - Enum constant in enum dev.botcity.framework.web.browsers.Browser
- FirefoxConfig - Class in dev.botcity.framework.web.browsers
- FirefoxConfig() - Constructor for class dev.botcity.framework.web.browsers.FirefoxConfig
- forward() - Method in class dev.botcity.framework.bot.WebBot
-
Pressing the browser’s forward button.
G
- getCenteredPosition() - Method in class dev.botcity.framework.web.State
-
Returns the center point of the element.
- getClipboard() - Method in class dev.botcity.framework.bot.DesktopBot
-
Get the current content in the clipboard.
- getClipboard() - Method in class dev.botcity.framework.bot.WebBot
-
Get the current content in the clipboard.
- getColorSensibility() - Method in class dev.botcity.framework.bot.DesktopBot
- getCoordinates(String, int, boolean) - Method in class dev.botcity.framework.bot.DesktopBot
- getDriver() - Method in class dev.botcity.framework.bot.WebBot
-
The WebDriver driver instance.
- getDriverName() - Method in interface dev.botcity.framework.web.browsers.BrowserConfig
-
Get driver name from the browser.
- getDriverName() - Method in class dev.botcity.framework.web.browsers.ChromeConfig
- getDriverName() - Method in class dev.botcity.framework.web.browsers.EdgeConfig
- getDriverName() - Method in class dev.botcity.framework.web.browsers.FirefoxConfig
- getElementCoords(String, double) - Method in class dev.botcity.framework.bot.WebBot
-
Find an element defined by label on screen and returns its coordinates.
- getElementCoords(String, Region, double) - Method in class dev.botcity.framework.bot.WebBot
-
Find an element defined by label on screen and returns its coordinates.
- getElementCoordsCentered(String, double) - Method in class dev.botcity.framework.bot.WebBot
-
Find an element defined by label on screen and returns its centered coordinates.
- getFileCount(String, String) - Method in class dev.botcity.framework.bot.WebBot
-
Get the total number of files of the same type.
- getHeight() - Method in class dev.botcity.framework.bot.UIElement
- getImage() - Method in class dev.botcity.framework.bot.UIElement
- getJsDialog() - Method in class dev.botcity.framework.bot.WebBot
-
Return the last found dialog.
- getLastElement() - Method in class dev.botcity.framework.bot.DesktopBot
-
Returns the last recognized UI element.
- getLastElement() - Method in class dev.botcity.framework.bot.WebBot
-
Return the last element found.
- getLastX() - Method in class dev.botcity.framework.bot.DesktopBot
- getLastX() - Method in class dev.botcity.framework.bot.WebBot
-
Return the x position of the last element found.
- getLastY() - Method in class dev.botcity.framework.bot.DesktopBot
- getLastY() - Method in class dev.botcity.framework.bot.WebBot
-
Return the y position of the last element found.
- getPageSize() - Method in class dev.botcity.framework.bot.WebBot
-
Returns the browser current page size.
- getResourceAsMarvinImage(ClassLoader, String) - Static method in class dev.botcity.framework.web.Resource
-
Get the resource as a MarvinImage.
- getRobot() - Method in class dev.botcity.framework.bot.DesktopBot
- getScaleX() - Method in class dev.botcity.framework.bot.Scale
- getScaleY() - Method in class dev.botcity.framework.bot.Scale
- getScreenImage() - Method in class dev.botcity.framework.bot.WebBot
-
Capture and returns a screenshot from the browser.
- getScreenImage(Region) - Method in class dev.botcity.framework.bot.WebBot
-
Capture and returns a screenshot from the browser.
- getScreenshot() - Method in class dev.botcity.framework.bot.WebBot
-
Capture a screenshot.
- getScreenShot() - Method in class dev.botcity.framework.bot.DesktopBot
-
Returns the current screen in MarvinImage format.
- getSessionId() - Method in interface dev.botcity.framework.web.browsers.BrowserConfig
-
Get the session id.
- getSessionId() - Method in class dev.botcity.framework.web.browsers.ChromeConfig
- getSessionId() - Method in class dev.botcity.framework.web.browsers.EdgeConfig
- getSessionId() - Method in class dev.botcity.framework.web.browsers.FirefoxConfig
- getTabs() - Method in class dev.botcity.framework.bot.WebBot
-
Get a list of tab handlers.
- getViewportSize() - Method in class dev.botcity.framework.bot.WebBot
-
Returns the browser current viewport size.
- getWebDriver(Browser, boolean, MutableCapabilities, MutableCapabilities, String, String, PageLoadStrategy) - Static method in class dev.botcity.framework.web.WebDriverFactory
-
Factory method to create a Browser config instance.
- getWebDriverDriver() - Method in interface dev.botcity.framework.web.browsers.BrowserConfig
-
Get driver instance.
- getWebDriverDriver() - Method in class dev.botcity.framework.web.browsers.ChromeConfig
- getWebDriverDriver() - Method in class dev.botcity.framework.web.browsers.EdgeConfig
- getWebDriverDriver() - Method in class dev.botcity.framework.web.browsers.FirefoxConfig
- getWidth() - Method in class dev.botcity.framework.bot.UIElement
- getX() - Method in class dev.botcity.framework.bot.UIElement
- getY() - Method in class dev.botcity.framework.bot.UIElement
- grayscale(MarvinImage) - Method in class dev.botcity.framework.web.CVFind
-
Grayscale image.
H
- handleJsDialog(boolean) - Method in class dev.botcity.framework.bot.WebBot
-
Accepts or dismisses a JavaScript initiated dialog (alert, confirm, prompt, or onbeforeunload).
- handleJsDialog(boolean, String) - Method in class dev.botcity.framework.bot.WebBot
-
Accepts or dismisses a JavaScript initiated dialog (alert, confirm, prompt, or onbeforeunload).
- holdShift() - Method in class dev.botcity.framework.bot.DesktopBot
-
Hold key "shift"
- holdShift() - Method in class dev.botcity.framework.bot.WebBot
-
Hold key Shift.
- holdShift(int) - Method in class dev.botcity.framework.bot.DesktopBot
-
Hold key "shift"
- holdShift(int) - Method in class dev.botcity.framework.bot.WebBot
-
Hold key Shift.
I
- installFirefoxExtension(String) - Method in class dev.botcity.framework.bot.WebBot
-
Install an extension in the Firefox browser.
K
- kbType(String) - Method in class dev.botcity.framework.bot.WebBot
-
Type a text char by char (individual key events).
- keyDown() - Method in class dev.botcity.framework.bot.DesktopBot
-
Press key "down"
- keyDown(int) - Method in class dev.botcity.framework.bot.DesktopBot
-
Press key "down"
- keyEnd() - Method in class dev.botcity.framework.bot.DesktopBot
- keyEnd() - Method in class dev.botcity.framework.bot.WebBot
-
Press key End.
- keyEnd(int) - Method in class dev.botcity.framework.bot.DesktopBot
- keyEnd(int) - Method in class dev.botcity.framework.bot.WebBot
-
Press key End.
- keyEnter() - Method in class dev.botcity.framework.bot.WebBot
-
Press key Enter.
- keyEnter(int) - Method in class dev.botcity.framework.bot.DesktopBot
-
Press key "enter"
- keyEnter(int) - Method in class dev.botcity.framework.bot.WebBot
-
Press key Enter.
- keyEsc() - Method in class dev.botcity.framework.bot.DesktopBot
- keyEsc() - Method in class dev.botcity.framework.bot.WebBot
-
Press key Esc.
- keyEsc(int) - Method in class dev.botcity.framework.bot.DesktopBot
- keyEsc(int) - Method in class dev.botcity.framework.bot.WebBot
-
Press key Esc.
- keyF1() - Method in class dev.botcity.framework.bot.DesktopBot
- keyF1(int) - Method in class dev.botcity.framework.bot.DesktopBot
- keyF10() - Method in class dev.botcity.framework.bot.DesktopBot
- keyF10(int) - Method in class dev.botcity.framework.bot.DesktopBot
- keyF11() - Method in class dev.botcity.framework.bot.DesktopBot
- keyF11(int) - Method in class dev.botcity.framework.bot.DesktopBot
- keyF12() - Method in class dev.botcity.framework.bot.DesktopBot
- keyF12(int) - Method in class dev.botcity.framework.bot.DesktopBot
- keyF2() - Method in class dev.botcity.framework.bot.DesktopBot
- keyF2(int) - Method in class dev.botcity.framework.bot.DesktopBot
- keyF3() - Method in class dev.botcity.framework.bot.DesktopBot
- keyF3(int) - Method in class dev.botcity.framework.bot.DesktopBot
- keyF4() - Method in class dev.botcity.framework.bot.DesktopBot
- keyF4(int) - Method in class dev.botcity.framework.bot.DesktopBot
- keyF5() - Method in class dev.botcity.framework.bot.DesktopBot
- keyF5(int) - Method in class dev.botcity.framework.bot.DesktopBot
- keyF6() - Method in class dev.botcity.framework.bot.DesktopBot
- keyF6(int) - Method in class dev.botcity.framework.bot.DesktopBot
- keyF7() - Method in class dev.botcity.framework.bot.DesktopBot
- keyF7(int) - Method in class dev.botcity.framework.bot.DesktopBot
- keyF8() - Method in class dev.botcity.framework.bot.DesktopBot
- keyF8(int) - Method in class dev.botcity.framework.bot.DesktopBot
- keyF9() - Method in class dev.botcity.framework.bot.DesktopBot
- keyF9(int) - Method in class dev.botcity.framework.bot.DesktopBot
- keyHome() - Method in class dev.botcity.framework.bot.WebBot
-
Press key Home.
- keyHome(int) - Method in class dev.botcity.framework.bot.WebBot
-
Press key Home.
- keyLeft() - Method in class dev.botcity.framework.bot.DesktopBot
-
Press key "left"
- keyLeft(int) - Method in class dev.botcity.framework.bot.DesktopBot
-
Press key "left"
- keyRight() - Method in class dev.botcity.framework.bot.DesktopBot
-
Press key "right"
- keyRight(int) - Method in class dev.botcity.framework.bot.DesktopBot
-
Press key "right"
- keyRight(int) - Method in class dev.botcity.framework.bot.WebBot
-
Press key Right.
- keyUp() - Method in class dev.botcity.framework.bot.DesktopBot
-
Press key "up"
- keyUp(int) - Method in class dev.botcity.framework.bot.DesktopBot
-
Press key "up"
- keyWindows() - Method in class dev.botcity.framework.bot.DesktopBot
- keyWindows(int) - Method in class dev.botcity.framework.bot.DesktopBot
L
- leaveIframe() - Method in class dev.botcity.framework.bot.WebBot
-
Leave the iframe and switch the WebBot driver to the default content.
M
- maximizeWindow() - Method in class dev.botcity.framework.bot.DesktopBot
-
Shortcut to maximize window on Windows Operating System
- maximizeWindow() - Method in class dev.botcity.framework.bot.WebBot
-
Shortcut to maximize window on Windows OS.
- mouseDown() - Method in class dev.botcity.framework.bot.WebBot
-
Holds down the requested mouse button.
- mouseDown(int) - Method in class dev.botcity.framework.bot.WebBot
-
Holds down the requested mouse button.
- mouseMove(int, int) - Method in class dev.botcity.framework.bot.WebBot
-
Mouse the move to the coordinate defined by x and y.
- mouseUp() - Method in class dev.botcity.framework.bot.WebBot
-
Releases the requested mouse button.
- mouseUp(int) - Method in class dev.botcity.framework.bot.WebBot
-
Releases the requested mouse button.
- move() - Method in class dev.botcity.framework.bot.DesktopBot
-
Move cursor to the last found element.
- move() - Method in class dev.botcity.framework.bot.WebBot
-
Move to the center position of last found item.
- move(int) - Method in class dev.botcity.framework.bot.WebBot
-
Move to the center position of last found item.
- moveRandom(int, int) - Method in class dev.botcity.framework.bot.DesktopBot
- moveRandom(int, int) - Method in class dev.botcity.framework.bot.WebBot
-
Move randomly along the given x, y range.
- moveRelative(int, int) - Method in class dev.botcity.framework.bot.DesktopBot
-
Move cursor relative the last found UI element.
- moveRelative(int, int) - Method in class dev.botcity.framework.bot.WebBot
-
Move the mouse relative to its current position.
- moveTo(int, int) - Method in class dev.botcity.framework.bot.DesktopBot
-
Move cursor to an specific coordinate.
- moveTo(int, int) - Method in class dev.botcity.framework.bot.WebBot
-
Move the mouse relative to its current position.
- moveTo(int, int, int) - Method in class dev.botcity.framework.bot.WebBot
-
Move the mouse relative to its current position.
N
- navigateTo(String) - Method in class dev.botcity.framework.bot.WebBot
-
Opens the browser on the given URL.
- NONE - Enum constant in enum dev.botcity.framework.web.browsers.PageLoadStrategy
- NORMAL - Enum constant in enum dev.botcity.framework.web.browsers.PageLoadStrategy
P
- pageDown() - Method in class dev.botcity.framework.bot.WebBot
-
Press Page Down key
- pageDown(int) - Method in class dev.botcity.framework.bot.WebBot
-
Press Page Down key.
- PageLoadStrategy - Enum in dev.botcity.framework.web.browsers
-
Page Load Strategy.
- pageSource() - Method in class dev.botcity.framework.bot.WebBot
-
Returns the active page source.
- pageTitle() - Method in class dev.botcity.framework.bot.WebBot
-
Returns the active page title.
- pageUp() - Method in class dev.botcity.framework.bot.WebBot
-
Press Page Up key
- pageUp(int) - Method in class dev.botcity.framework.bot.WebBot
-
Press Page Up key.
- paste() - Method in class dev.botcity.framework.bot.WebBot
-
Paste content from the clipboard.
- paste(String) - Method in class dev.botcity.framework.bot.DesktopBot
-
Paste content from the clipboard.
- paste(String, int) - Method in class dev.botcity.framework.bot.DesktopBot
-
Paste content from the clipboard.
- print(String) - Method in class dev.botcity.framework.bot.DesktopBot
- printPdf() - Method in class dev.botcity.framework.bot.WebBot
-
Print the current page as a PDF file.
- printPdf(String) - Method in class dev.botcity.framework.bot.WebBot
-
Print the current page as a PDF file.
- printPdf(String, Map<String, Object>) - Method in class dev.botcity.framework.bot.WebBot
-
Print the current page as a PDF file.
R
- refresh() - Method in class dev.botcity.framework.bot.WebBot
-
Refresh the current page.
- Region - Class in dev.botcity.framework.web
-
Represents a region on the screen.
- Region() - Constructor for class dev.botcity.framework.web.Region
- releaseShift() - Method in class dev.botcity.framework.bot.DesktopBot
-
Release key "shift".
- releaseShift() - Method in class dev.botcity.framework.bot.WebBot
-
Release key Shift.
- Resource - Class in dev.botcity.framework.web
- Resource() - Constructor for class dev.botcity.framework.web.Resource
- ResourceNotFoundException - Exception in dev.botcity.framework.web.exceptions
- ResourceNotFoundException(String) - Constructor for exception dev.botcity.framework.web.exceptions.ResourceNotFoundException
- rightClick() - Method in class dev.botcity.framework.bot.DesktopBot
-
Right Click in last found UI element.
- rightClick() - Method in class dev.botcity.framework.bot.WebBot
-
Right click on the last found element.
- rightClick(int) - Method in class dev.botcity.framework.bot.WebBot
-
Right click on the last found element.
- rightClick(State) - Method in class dev.botcity.framework.bot.WebBot
-
Right click on the last found element.
- rightClickAt(int, int) - Method in class dev.botcity.framework.bot.DesktopBot
- rightClickAt(int, int) - Method in class dev.botcity.framework.bot.WebBot
-
Right click at the coordinate defined by x and y.
- rightClickAt(int, int, int) - Method in class dev.botcity.framework.bot.WebBot
-
Right click at the coordinate defined by x and y.
- rightClickRelative(int, int) - Method in class dev.botcity.framework.bot.DesktopBot
- rightClickRelative(int, int) - Method in class dev.botcity.framework.bot.WebBot
-
Right Click Relative on the last found element.
S
- sanitizeHeader(List<String>) - Static method in class dev.botcity.framework.web.parsers.TableParser
-
Sanitize header labels.
- saveScreenshot(String) - Method in class dev.botcity.framework.bot.DesktopBot
-
Saves a screenshot in a given path
- saveScreenshot(String) - Method in class dev.botcity.framework.bot.WebBot
-
Saves a screenshot in a given path.
- Scale - Class in dev.botcity.framework.bot
- Scale() - Constructor for class dev.botcity.framework.bot.Scale
- screenCut(int, int, int, int) - Method in class dev.botcity.framework.bot.DesktopBot
-
Returns a given region of the current screen in MarvinImage format
- screenCut(Region) - Method in class dev.botcity.framework.bot.WebBot
-
Capture a screenshot from a region of the screen.
- screenshot(String) - Method in class dev.botcity.framework.bot.WebBot
-
Capture a screenshot.
- scrollDown(int) - Method in class dev.botcity.framework.bot.DesktopBot
-
Scroll down wheel action.
- scrollDown(int) - Method in class dev.botcity.framework.bot.WebBot
-
Scroll Down n clicks.
- scrollElement(WebElement) - Method in class dev.botcity.framework.bot.WebBot
-
Scrolls down an element by its scroll height or a given amount defined by `start` and `end`.
- scrollElement(WebElement, int, int, int, int) - Method in class dev.botcity.framework.bot.WebBot
-
Scrolls down an element by its scroll height or a given amount defined by `start` and `end`.
- scrollUp(int) - Method in class dev.botcity.framework.bot.DesktopBot
-
Scroll up wheel action.
- scrollUp(int) - Method in class dev.botcity.framework.bot.WebBot
-
Scroll Up n clicks.
- setColorSensibility(double) - Method in class dev.botcity.framework.bot.DesktopBot
- setCurrentElement(UIElement) - Method in class dev.botcity.framework.bot.DesktopBot
-
Set current UI element.
- setCurrentElement(State) - Method in class dev.botcity.framework.bot.WebBot
-
Changes the current screen element the bot will interact when using click(), move(), and similar methods.
- setDownloadPath(String) - Method in class dev.botcity.framework.bot.WebBot
- setDriverPath(String) - Method in class dev.botcity.framework.bot.WebBot
- setFileInputElement(WebElement, File) - Method in class dev.botcity.framework.bot.WebBot
-
Configure the filepath for upload in a file element.
- setImage(MarvinImage) - Method in class dev.botcity.framework.bot.UIElement
- setResourceClassLoader(ClassLoader) - Method in class dev.botcity.framework.bot.DesktopBot
-
Set classloader for loading resources exported in JAR files.
- setScreenResolution(int, int) - Method in class dev.botcity.framework.bot.WebBot
-
Configures the browser dimensions.
- setX(Integer) - Method in class dev.botcity.framework.bot.UIElement
- setY(Integer) - Method in class dev.botcity.framework.bot.UIElement
- shiftTab() - Method in class dev.botcity.framework.bot.DesktopBot
- shiftTab(int) - Method in class dev.botcity.framework.bot.DesktopBot
- sleep(int) - Method in class dev.botcity.framework.bot.WebBot
-
Wait / Sleep for a given interval.
- space() - Method in class dev.botcity.framework.bot.DesktopBot
- space() - Method in class dev.botcity.framework.bot.WebBot
-
Press key Space.
- space(int) - Method in class dev.botcity.framework.bot.DesktopBot
- space(int) - Method in class dev.botcity.framework.bot.WebBot
-
Press key Space.
- startBrowser() - Method in class dev.botcity.framework.bot.WebBot
-
Starts the selected browser.
- startRun(String) - Method in class dev.botcity.framework.bot.DesktopBot
-
Key "Window" + R shortcut to run commands on windws UI.
- State - Class in dev.botcity.framework.web
-
Represents a state of element found.
- State() - Constructor for class dev.botcity.framework.web.State
- stopBrowser() - Method in class dev.botcity.framework.bot.WebBot
-
Stops the Chrome browser and clean up the User Data Directory.
T
- tab() - Method in class dev.botcity.framework.bot.DesktopBot
-
Press key tab
- tab() - Method in class dev.botcity.framework.bot.WebBot
-
Press key Tab.
- tab(int) - Method in class dev.botcity.framework.bot.DesktopBot
-
Press key "tab"
- tab(int) - Method in class dev.botcity.framework.bot.WebBot
-
Press key Tab.
- TableParser - Class in dev.botcity.framework.web.parsers
- TableParser() - Constructor for class dev.botcity.framework.web.parsers.TableParser
- tableToMapArray(WebElement) - Static method in class dev.botcity.framework.web.parsers.TableParser
-
Convert a table WebElement to a list of maps
- tableToMapArray(WebElement, boolean, int) - Static method in class dev.botcity.framework.web.parsers.TableParser
-
Convert a table WebElement to a list of maps
- tableToMapArray(WebElement, boolean, int, String) - Static method in class dev.botcity.framework.web.parsers.TableParser
-
Convert a table WebElement to a list of maps
- tableToMapArray(WebElement, boolean, int, String, String) - Static method in class dev.botcity.framework.web.parsers.TableParser
-
Convert a table WebElement to a list of maps
- threshold(MarvinImage, int) - Method in class dev.botcity.framework.web.CVFind
-
Threshold image.
- tripleClick() - Method in class dev.botcity.framework.bot.DesktopBot
-
Triple-click in last found UI element.
- tripleClick() - Method in class dev.botcity.framework.bot.WebBot
-
Triple Click on the last found element.
- tripleClick(int) - Method in class dev.botcity.framework.bot.WebBot
-
Triple Click on the last found element.
- tripleClickRelative(int, int) - Method in class dev.botcity.framework.bot.DesktopBot
-
Triple-click relative the last found UI element.
- tripleClickRelative(int, int) - Method in class dev.botcity.framework.bot.WebBot
-
Triple Click Relative on the last found element.
- type(String) - Method in class dev.botcity.framework.bot.DesktopBot
-
Type a text, char by char (inividual key events)
- type(String) - Method in class dev.botcity.framework.bot.WebBot
-
Type a text char by char (individual key events).
- type(String, int) - Method in class dev.botcity.framework.bot.DesktopBot
-
Type text, char by char.
- type(String, int) - Method in class dev.botcity.framework.bot.WebBot
-
Type a text char by char (individual key events).
- type(String, int, int) - Method in class dev.botcity.framework.bot.DesktopBot
-
Type text, char by char, specifying key interval time
- typeDown() - Method in class dev.botcity.framework.bot.WebBot
-
Press Down key
- typeDown(int) - Method in class dev.botcity.framework.bot.WebBot
-
Press Down key
- typeKeys(CharSequence...) - Method in class dev.botcity.framework.bot.WebBot
-
Press a sequence of keys.
- typeKeys(Integer...) - Method in class dev.botcity.framework.bot.DesktopBot
-
Press a sequence of keys.
- typeKeysWithInterval(Integer, Integer...) - Method in class dev.botcity.framework.bot.DesktopBot
- typeLeft() - Method in class dev.botcity.framework.bot.WebBot
-
Press Left key.
- typeLeft(int) - Method in class dev.botcity.framework.bot.WebBot
-
Press Left key.
- typeRight() - Method in class dev.botcity.framework.bot.WebBot
-
Press Right key.
- typeRight(int) - Method in class dev.botcity.framework.bot.WebBot
-
Press Right key.
- typeUp() - Method in class dev.botcity.framework.bot.WebBot
-
Press Up key
- typeUp(int) - Method in class dev.botcity.framework.bot.WebBot
-
Press Up key
- typeWaitAfterChars(String, int) - Method in class dev.botcity.framework.bot.DesktopBot
-
Type text, char by char, specifying key interval time
- typeWaitAfterChars(String, int, int) - Method in class dev.botcity.framework.bot.DesktopBot
-
Type text, char by char, specifying key interval time
U
- UIElement - Class in dev.botcity.framework.bot
-
UI element representation model.
- UIElement() - Constructor for class dev.botcity.framework.bot.UIElement
- UIElement(Integer, Integer, MarvinImage) - Constructor for class dev.botcity.framework.bot.UIElement
V
- valueOf(String) - Static method in enum dev.botcity.framework.web.browsers.Browser
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum dev.botcity.framework.web.browsers.PageLoadStrategy
-
Returns the enum constant of this type with the specified name.
- values() - Static method in enum dev.botcity.framework.web.browsers.Browser
-
Returns an array containing the constants of this enum type, in the order they are declared.
- values() - Static method in enum dev.botcity.framework.web.browsers.PageLoadStrategy
-
Returns an array containing the constants of this enum type, in the order they are declared.
W
- wait(int) - Method in class dev.botcity.framework.bot.DesktopBot
-
Wait / Sleep for a given interval.
- wait(int) - Method in class dev.botcity.framework.bot.WebBot
-
Wait / Sleep for a given interval.
- waitForDownloads(int) - Method in class dev.botcity.framework.bot.WebBot
-
Wait for all downloads to be finished.
- waitForDownloads(WebDriver) - Method in interface dev.botcity.framework.web.browsers.BrowserConfig
-
Wait for all downloads to finish.
- waitForDownloads(WebDriver) - Method in class dev.botcity.framework.web.browsers.ChromeConfig
- waitForDownloads(WebDriver) - Method in class dev.botcity.framework.web.browsers.EdgeConfig
- waitForDownloads(WebDriver) - Method in class dev.botcity.framework.web.browsers.FirefoxConfig
- waitForElementVisibilitiy(WebElement, boolean, long) - Method in class dev.botcity.framework.bot.WebBot
-
Wait for the element to be visible or hidden.
- waitForElementVisibilitiy(WebElement, long) - Method in class dev.botcity.framework.bot.WebBot
-
Wait for the element to be visible or hidden.
- waitForFile(String, long) - Method in class dev.botcity.framework.bot.WebBot
-
Wait for a file to be available on disk.
- waitForNewFile(String, String, int, long) - Method in class dev.botcity.framework.bot.WebBot
-
Wait for a new file to be available on disk without the file path.
- waitForNewPage(boolean, long, Runnable) - Method in class dev.botcity.framework.bot.WebBot
-
Context manager to wait for a new page to load and activate it.
- waitForNewPage(boolean, Runnable) - Method in class dev.botcity.framework.bot.WebBot
-
Context manager to wait for a new page to load and activate it.
- waitForNewPage(Runnable) - Method in class dev.botcity.framework.bot.WebBot
-
Context manager to wait for a new page to load and activate it.
- waitForStaleElement(WebElement, long) - Method in class dev.botcity.framework.bot.WebBot
-
Wait until the WebElement element becomes stale (outdated).
- WebBot - Class in dev.botcity.framework.bot
-
Base class for Web Bots.
- WebBot() - Constructor for class dev.botcity.framework.bot.WebBot
- WebDriverFactory - Class in dev.botcity.framework.web
- WebDriverFactory() - Constructor for class dev.botcity.framework.web.WebDriverFactory
- WebDriverResponse - Class in dev.botcity.framework.web
- WebDriverResponse() - Constructor for class dev.botcity.framework.web.WebDriverResponse
All Classes and Interfaces|All Packages|Serialized Form