Interface TakesScreenshot

java/src/org/openqa/selenium/TakesScreenshot.java:32–65

Indicates a driver or an HTML element that can capture a screenshot and store it in different ways. Example usage: File screenshotFile = ((TakesScreenshot) driver).getScreenshotAs(OutputType.FILE); String screenshotBase64 = ((TakesScreenshot) element).getScreenshotAs(OutputType.BASE64); <

 * @see OutputType
 */
public interface TakesScreenshot {
  /**
   * Capture the screenshot and store it in the specified location.
   *
   * <p>For a W3C-conformant WebDriver or WebElement, this behaves as stated in <a
   * href="https://w3c.github.io/webdriver/#screen-capture">W3C WebDriver specification</a>.
   *
   * <p>For a non-W3C-conformant WebDriver, this makes a best effort depending on the browser to
   * return the following in order of preference:
   *
   * <ul>
   *   <li>Entire page
   *   <li>Current window
   *   <li>Visible portion of the current frame
   *   <li>The screenshot of the entire display containing the browser
   * </ul>
   *
   * For a non-W3C-conformant WebElement extending TakesScreenshot, this makes a best effort
   * depending on the browser to return the following in order of preference:
   *
   * <ul>
   *   <li>The entire content of the HTML element
   *   <li>The visible portion of the HTML element
   * </ul>
   *
   * @param <X> Return type for getScreenshotAs.
   * @param target target type, @see OutputType
   * @return Object in which is stored information about the screenshot.
   * @throws WebDriverException on failure.
   * @throws UnsupportedOperationException if the underlying implementation does not support
   *     screenshot capturing.
   */
  <X> X getScreenshotAs(OutputType<X> target) throws WebDriverException;
}