App (Selenified Testing Framework 3.0.0-SNAPSHOT API)

java.lang.Object
- com.coveros.selenified.application.App

```
public class App
extends Object
```
App is an instance of the browser based application that is under test. Pages should be build out of this object (if using the page object model (POM)), so that several pages make up an app. Within each page, multiple elements should be created. In this way, we can act on our app, page, or element directly. If you choose not to use the POM, then simply build your elements directly out of your app.

Version:

3.0.0

Author:

Max Saperstone

Constructor Summary

Constructors
Constructor and Description

App(Browser browser, org.openqa.selenium.remote.DesiredCapabilities capabilities, OutputFile file)
Sets up the app object.

Constructors
Constructor and Description
`App(Browser browser, org.openqa.selenium.remote.DesiredCapabilities capabilities, OutputFile file)` Sets up the app object.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`acceptAlert()` Accept (click 'OK' on) an alert box
`void`	`acceptConfirmation()` Accept (click 'OK' on) a confirmation box
`void`	`acceptPrompt()` Accept (click 'OK' on) a prompt box
`Assert`	`azzert()` Will handle all verifications performed on the actual application itself.
`void`	`closeCurrentWindow()` Close the currently selected window.
`void`	`closeTab()` Closes the current tab.
`void`	`deleteAllCookies()` Delete all stored cookies for this particular test
`void`	`deleteCookie(String cookieName)` Deletes a stored cookie, indicated by the cookieName for this particular test.
`void`	`dismissConfirmation()` Dismiss (click 'Cancel' on) a confirmation box
`void`	`dismissPrompt()` Dismiss (click 'Cancel' on) a prompt box
`Get`	`get()` Retrieves information about the app in general, not specific to any particular page or element.
`Browser`	`getBrowser()` Retrieves the browser being used for this particular test
`org.openqa.selenium.remote.DesiredCapabilities`	`getCapabilities()` Retrieves the browser (and potentially device) capabilities setup for this particular test
`org.openqa.selenium.WebDriver`	`getDriver()` Retrieves the Selenium driver instance
`OutputFile`	`getOutputFile()` Retrieves the output file responsible for logging all actions and assertions associated with this particular test
`void`	`goBack()` Go back one page in the current test's browser history
`void`	`goForward()` Go forward one page in the current test's browser history
`void`	`goToURL(String url)` Navigates to a new url
`Is`	`is()` Checks information about the app in general, not specific to any particular page or element.
`void`	`killDriver()` Ends the current Selenium driver instance, which will end the test.
`void`	`maximize()` Maximizes the current window
`Element`	`newElement(Locator type, String locator)` setups a new element which is located on the page
`Element`	`newElement(Locator type, String locator, int match)` setups a new element which is located on the page
`boolean`	`openTab()` Opens a new tab, and have it selected.
`void`	`openTab(String url)` Opens a new tab, and have it selected.
`void`	`refresh()` Reloads the current page
`void`	`refreshHard()` Reloads the current page while clearing the cache.
`void`	`scroll(int desiredPosition)` An custom script to scroll to a given position on the page, using javascript.
`void`	`selectFrame(int frameNumber)` Select a frame by its (zero-based) index.
`void`	`selectFrame(String frameIdentifier)` Select a frame by its name or ID.
`void`	`setCookie(org.openqa.selenium.Cookie cookie)` Adds a cookie to the application for this particular test
`void`	`switchNextTab()` Switches to the next available tab.
`void`	`switchPreviousTab()` Switch to the previous available tab.
`void`	`switchToNewWindow()` Switches to the next window.
`void`	`switchToParentWindow()` Switches to the originally opened window.
`void`	`takeScreenshot(String imageName)` Takes a full screenshot of the entire page
`void`	`typeIntoPrompt(String text)` Type text into a prompt box
`void`	`wait(double seconds)` Pauses the test for a set amount of time
`WaitFor`	`waitFor()` Performs dynamic waits on the app in general, until a particular condition of the application is met, not one for a particular page or element.

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

- Constructor Detail
  - App
```
public App(Browser browser,
           org.openqa.selenium.remote.DesiredCapabilities capabilities,
           OutputFile file)
    throws InvalidBrowserException,
           MalformedURLException
```
    Sets up the app object. Browser, and Output are defined here, which will control actions and all logging and records
    
    Parameters:
    
    browser - - the Browser we are running the test on
    
    capabilities - - what browser capabilities are desired
    
    file - - the TestOutput file. This is provided by the SeleniumTestBase functionality
    
    Throws:
    
    InvalidBrowserException - If a browser that is not one specified in the Selenium.Browser class is used, this exception will be thrown
    
    MalformedURLException - If the provided hub address isn't a URL, this exception will be thrown
- Method Detail
  - newElement
```
public Element newElement(Locator type,
                          String locator)
```
    setups a new element which is located on the page
    
    Parameters:
    
    type - - the locator type e.g. Locator.id, Locator.xpath
    
    locator - - the locator string e.g. login, //input[@id='login']
    
    Returns:
    
    Element: a page element to interact with
  - newElement
```
public Element newElement(Locator type,
                          String locator,
                          int match)
```
    setups a new element which is located on the page
    
    Parameters:
    
    type - - the locator type e.g. Locator.id, Locator.xpath
    
    locator - - the locator string e.g. login, //input[@id='login']
    
    match - - if there are multiple matches of the selector, this is which match (starting at 0) to interact with
    
    Returns:
    
    Element: a page element to interact with
  - is
```
public Is is()
```
    Checks information about the app in general, not specific to any particular page or element. A boolean is always returning, indicating if an object is present or not
  - waitFor
```
public WaitFor waitFor()
```
    Performs dynamic waits on the app in general, until a particular condition of the application is met, not one for a particular page or element. Nothing is ever returned. The default wait is 5 seconds, but can be overridden. If the condition is not met in the allotted time, still nothing is returned, but an error is logged
  - get
```
public Get get()
```
    Retrieves information about the app in general, not specific to any particular page or element. If an object isn't present, null will be returned
  - azzert
```
public Assert azzert()
```
    Will handle all verifications performed on the actual application itself. These asserts are custom to the framework, and in addition to providing easy object oriented capabilities, they take screenshots with each verification to provide additional traceability, and assist in troubleshooting and debugging failing tests.
  - getDriver
```
public org.openqa.selenium.WebDriver getDriver()
```
    Retrieves the Selenium driver instance
    
    Returns:
    
    WebDriver: access to the driver controlling the browser via webdriver
  - getBrowser
```
public Browser getBrowser()
```
    Retrieves the browser being used for this particular test
    
    Returns:
    
    Browser: the enum of the browser
  - getOutputFile
```
public OutputFile getOutputFile()
```
    Retrieves the output file responsible for logging all actions and assertions associated with this particular test
    
    Returns:
    
    OutputFile: the file recording all actions
  - getCapabilities
```
public org.openqa.selenium.remote.DesiredCapabilities getCapabilities()
```
    Retrieves the browser (and potentially device) capabilities setup for this particular test
    
    Returns:
    
    capabilities: the listing of set capabilities
  - killDriver
```
public void killDriver()
```
    Ends the current Selenium driver instance, which will end the test. No additional actions or asserts can be performed after this, as the browser will be terminated as well
  - wait
```
public void wait(double seconds)
```
    Pauses the test for a set amount of time
    
    Parameters:
    
    seconds - - the number of seconds to wait
  - goToURL
```
public void goToURL(String url)
```
    Navigates to a new url
    
    Parameters:
    
    url - - the URL to navigate to
  - takeScreenshot
```
public void takeScreenshot(String imageName)
```
    Takes a full screenshot of the entire page
    
    Parameters:
    
    imageName - - the name of the image typically generated via functions from TestOutput.generateImageName
  - openTab
```
public boolean openTab()
```
    Opens a new tab, and have it selected. Note, no content will be present on this new tab, use the goToURL method to open load some content
    
    Returns:
    
    Boolean: returns a true if a tab was successfully opened, a false if it was not.
  - openTab
```
public void openTab(String url)
```
    Opens a new tab, and have it selected. The page provided will be loaded
    
    Parameters:
    
    url - - the url to load once the new tab is opened and selected
  - switchNextTab
```
public void switchNextTab()
```
    Switches to the next available tab. If the last tab is already selected, it will loop back to the first tab. This is an alternative to switchToNewWindow, as this works better for some systems and environments that others.
  - switchPreviousTab
```
public void switchPreviousTab()
```
    Switch to the previous available tab. If the first tab is already selected, it will loop back to the last tab. This is an alternative to switchToNewWindow, as this works better for some systems and environments that others.
  - closeTab
```
public void closeTab()
```
    Closes the current tab. Note that if this is the only tab open, this will end the test. No additional actions or asserts can be performed after this, as the browser will be terminated as well
  - goBack
```
public void goBack()
```
    Go back one page in the current test's browser history
  - goForward
```
public void goForward()
```
    Go forward one page in the current test's browser history
  - refresh
```
public void refresh()
```
    Reloads the current page
  - refreshHard
```
public void refreshHard()
```
    Reloads the current page while clearing the cache. This only works for certain browsers, as the command/control and F5 key combination is used to perform the action. Note that each time a test is run, nothing is currently in the cache, as each test is run in a completely new/fresh/clean session
  - setCookie
```
public void setCookie(org.openqa.selenium.Cookie cookie)
```
    Adds a cookie to the application for this particular test
    
    Parameters:
    
    cookie - - the details of the cookie to set
  - deleteCookie
```
public void deleteCookie(String cookieName)
```
    Deletes a stored cookie, indicated by the cookieName for this particular test. If the cookie by the provided name isn't present, than an error will be logged and recorded
    
    Parameters:
    
    cookieName - - the name of the cookie to delete
  - deleteAllCookies
```
public void deleteAllCookies()
```
    Delete all stored cookies for this particular test
  - maximize
```
public void maximize()
```
    Maximizes the current window
  - scroll
```
public void scroll(int desiredPosition)
```
    An custom script to scroll to a given position on the page, using javascript. If the browser being used doesn't support javascript, or the page isn't long enough to support scrolling to the desired position, than an error will be logged and recorded
    
    Parameters:
    
    desiredPosition - - the position on the page to scroll to
  - switchToNewWindow
```
public void switchToNewWindow()
```
    Switches to the next window. This is an alternative to switchNextTab or switchPreviousTab, as this works better for some systems and environments that others.
  - switchToParentWindow
```
public void switchToParentWindow()
```
    Switches to the originally opened window. This is an alternative to switchNextTab or switchPreviousTab, as this works better for some systems and environments that others.
  - closeCurrentWindow
```
public void closeCurrentWindow()
```
    Close the currently selected window. After this window is closed, ensure that focus is shifted to the next window using switchToNewWindow or switchToParentWindow methods. This is an alternative to closeTab, as this works better for some systems and environments that others.
  - selectFrame
```
public void selectFrame(int frameNumber)
```
    Select a frame by its (zero-based) index. That is, if a page has three frames, the first frame would be at index 0, the second at index 1 and the third at index 2. Once the frame has been selected, all subsequent calls on the WebDriver interface are made to that frame.
    
    Parameters:
    
    frameNumber - - the frame number, starts at 0
  - selectFrame
```
public void selectFrame(String frameIdentifier)
```
    Select a frame by its name or ID. Frames located by matching name attributes are always given precedence over those matched by ID.
    
    Parameters:
    
    frameIdentifier - - the frame name or ID
  - acceptAlert
```
public void acceptAlert()
```
    Accept (click 'OK' on) an alert box
  - acceptConfirmation
```
public void acceptConfirmation()
```
    Accept (click 'OK' on) a confirmation box
  - dismissConfirmation
```
public void dismissConfirmation()
```
    Dismiss (click 'Cancel' on) a confirmation box
  - acceptPrompt
```
public void acceptPrompt()
```
    Accept (click 'OK' on) a prompt box
  - dismissPrompt
```
public void dismissPrompt()
```
    Dismiss (click 'Cancel' on) a prompt box
  - typeIntoPrompt
```
public void typeIntoPrompt(String text)
```
    Type text into a prompt box
    
    Parameters:
    
    text - - the text to type into the prompt

Class App

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

App

Method Detail

newElement

newElement

is

waitFor

get

azzert

getDriver

getBrowser

getOutputFile

getCapabilities

killDriver

wait

goToURL

takeScreenshot

openTab

openTab

switchNextTab

switchPreviousTab

closeTab

goBack

goForward

refresh

refreshHard

setCookie

deleteCookie

deleteAllCookies

maximize

scroll

switchToNewWindow

switchToParentWindow

closeCurrentWindow

selectFrame

selectFrame

acceptAlert

acceptConfirmation

dismissConfirmation

acceptPrompt

dismissPrompt

typeIntoPrompt