Package 

Interface WebDriver

  • All Implemented Interfaces:
    java.io.Closeable , java.lang.AutoCloseable 
    
public interface WebDriver
 implements Closeable

    WebDriver defines a concise interface to visit and interact with web pages, all actions and behaviors are optimized to mimic real people as closely as possible, such as scrolling, clicking, typing text, dragging and dropping, etc.

    The methods in this interface fall into three categories:

    • Control of the browser itself

    • Selection of textContent and attributes of Elements

    • Interact with the webpage

    Key methods:

    • navigateTo: open a page.

    • scrollDown: scroll down on a web page to fully load the page, most modern webpages support lazy loading using ajax tech, where the page content only starts to load when it is scrolled into view.

    • pageSource: retrieve the source code of a webpage.

    • Method Detail

      • jvm

         abstract JvmWebDriver jvm()

        Returns a JvmWebDriver to support other JVM languages, such as java, clojure, scala, and so on, which had difficulty handling kotlin suspend methods.

      • addInitScript

         abstract Unit addInitScript(String script)

        Adds a script which would be evaluated in one of the following scenarios:

        • Whenever the page is navigated.

        The script is evaluated after the document was created but before any of its scripts were run. This is useful to amend the JavaScript environment, e.g. to seed Math.random.

        This function should be invoked before a navigation, usually in an onWillNavigate event handler.

        Parameters:
        script - Javascript source code to add.

      • addBlockedURLs

         abstract Unit addBlockedURLs(List<String> urls)

        Blocks resource URLs from loading.

        Parameters:
        urls - URL patterns to block.

      • addProbabilityBlockedURLs

         abstract Unit addProbabilityBlockedURLs(List<String> urls)

        Block resource URL loading with a certain probability.

        Parameters:
        urls - URL patterns to block.

      • navigateTo

         abstract Unit navigateTo(String url)

        Returns the main resource response. In case of multiple redirects, the navigation will resolve with the first non-redirect response.

        Parameters:
        url - URL to navigate page to.

      • navigateTo

         abstract Unit navigateTo(NavigateEntry entry)

        Returns the response of the main resource. In case of multiple redirects, the navigation will resolve with the first non-redirect response.

        Parameters:
        entry - NavigateEntry to navigate page to.

      • setTimeouts

         abstract Unit setTimeouts(BrowserSettings browserSettings)

      • currentUrl

         abstract String currentUrl()

        Returns a string representing the current URL that the browser is looking at.

        If the browser failed to return a proper url, return the url to navigate.

      • location

         abstract String location()

        In javascript, the window.location, or document.location, is a read-only property returns a Location object, which contains information about the URL of the document and provides methods for changing that URL and loading another URL.

        To retrieve just the URL as a string, the read-only document.URL property can also be used.

      • baseURI

         abstract String baseURI()

        In javascript, the baseURI is a property of Node, it's the absolute base URL of the document containing the node. A baseURI is used to resolve relative URLs.

        The base URL is determined as follows:

        • By default, the base URL is the location of the document (as determined by window.location).

        • If the document has an <base> element, its href attribute is used.

      • pageSource

         abstract String pageSource()

        Returns the source of the last loaded page. If the page has been modified after loading (for example, by Javascript) there is no guarantee that the returned text is that of the modified page.

      • mainRequestHeaders

        @Deprecated(message = Getter is available, replaceWith = @ReplaceWith(imports = {}, expression = mainRequestHeaders)) abstract Map<String, Object> mainRequestHeaders()

      • mainRequestCookies

        @Deprecated(message = Getter is available, replaceWith = @ReplaceWith(imports = {}, expression = mainRequestCookies)) abstract List<Map<String, String>> mainRequestCookies()

      • bringToFront

         abstract Unit bringToFront()

        Brings page to front (activates tab).

      • waitForSelector

         abstract Long waitForSelector(String selector)

        Returns when element specified by selector satisfies {@code state} option.

      • waitForSelector

         abstract Long waitForSelector(String selector, Long timeoutMillis)

        Returns when element specified by selector satisfies {@code state} option. Returns the time remaining until timeout.

      • clickMatches

        @Deprecated(message = Inappropriate name, replaceWith = @ReplaceWith(imports = {}, expression = clickTextMatches(selector, pattern, count)) Unit clickMatches(String selector, String pattern, Integer count)

        Use clickTextMatches instead

      • evaluate

         abstract Object evaluate(String expression)

        Executes JavaScript in the context of the currently selected frame or window. The script fragment provided will be executed as the body of an anonymous function.

        Parameters:
        expression - Javascript expression to evaluate

      • evaluateDetail

        @Beta() abstract JsEvaluation evaluateDetail(String expression)

        Executes JavaScript in the context of the currently selected frame or window. The script fragment provided will be executed as the body of an anonymous function.

        Parameters:
        expression - Javascript expression to evaluate

      • evaluateSilently

         abstract Object evaluateSilently(String expression)

        Executes JavaScript in the context of the currently selected frame or window. The script fragment provided will be executed as the body of an anonymous function.

        All possible exceptions are suppressed and do not throw.

        Parameters:
        expression - Javascript expression to evaluate

      • captureScreenshot

         abstract String captureScreenshot(String selector)

        This method scrolls element into view if needed, and then ake a screenshot of the element.

      • clickablePoint

         abstract PointD clickablePoint(String selector)

        Calculate the clickable point of an element located by selector. If the element does not exist, or is not clickable, returns null.

      • boundingBox

         abstract RectD boundingBox(String selector)

        Return the bounding box of an element located by selector. If the element does not exist, returns null.

      • newSession

         abstract Connection newSession()

        Create a new Jsoup session with the last page's context, which means, the same headers and cookies.

      • loadResource

         abstract Connection.Response loadResource(String url)

        Load url as a resource without browser rendering, with the last page's context, which means, the same headers and cookies.

      • pause

         abstract Unit pause()

        Force the page pauses all navigations and PENDING resource fetches. If the page loading stops, the user can still interact with the page, and therefore resources can continue to load.

      • stopLoading

        @Deprecated(message = Inappropriate name, replaceWith = @ReplaceWith(imports = {}, expression = pause)) Unit stopLoading()

      • stop

         abstract Unit stop()

        Force the page stop all navigations and RELEASES all resources. Interaction with the stop page results in undefined behavior and the results should not be trusted.

        If a web driver stops, it can later be used to visit new pages.

      • terminate

         abstract Unit terminate()

        Force the page stop all navigations and RELEASES all resources. If a web driver is terminated, it should not be used any more and should be quit as soon as possible.

      • quit

        @Deprecated(message = Inappropriate name, replaceWith = @ReplaceWith(imports = {}, expression = close())) abstract Unit quit()

        Quits this driver, closing every associated window.

      • awaitTermination

         abstract Unit awaitTermination()

        Wait until the tab is terminated and closed.

      • free

         abstract Unit free()

        Mark the driver as free, so it can be used to fetch a new page.

      • startWork

         abstract Unit startWork()

        Mark the driver as working, so it can not be used to fetch another page.

      • retire

         abstract Unit retire()

        Mark the driver as retired, so it can not be used to fetch any page, and should be quit as soon as possible.

      • cancel

         abstract Unit cancel()

        Mark the driver as canceled, so the fetch process should return as soon as possible, and the fetch result should be dropped.

      • getBrowser

         abstract Browser getBrowser()

        The browser of the driver. The browser defines methods and events to manipulate a real browser.

      • getBrowserType

         abstract BrowserType getBrowserType()

        The browser type.

      • getSupportJavascript

         abstract Boolean getSupportJavascript()

        Indicates whether the driver supports javascript. Web drivers such as MockDriver do not support javascript.

      • getIsRecovered

         abstract Boolean getIsRecovered()

        Whether the driver is recovered from the browser's tab list.

      • setIsRecovered

         abstract Unit setIsRecovered(Boolean isRecovered)

        Whether the driver is recovered from the browser's tab list.

      • getIsReused

         abstract Boolean getIsReused()

        Whether the driver is recovered and is reused to serve new tasks.

      • setIsReused

         abstract Unit setIsReused(Boolean isReused)

        Whether the driver is recovered and is reused to serve new tasks.