org.openqa.selenium.TakesScreenshot Maven / Gradle / Ivy
// Licensed to the Software Freedom Conservancy (SFC) under one
// or more contributor license agreements. See the NOTICE file
// distributed with this work for additional information
// regarding copyright ownership. The SFC licenses this file
// to you under the Apache License, Version 2.0 (the
// "License"); you may not use this file except in compliance
// with the License. You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing,
// software distributed under the License is distributed on an
// "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
// KIND, either express or implied. See the License for the
// specific language governing permissions and limitations
// under the License.
package org.openqa.selenium;
/**
* Indicates a driver that can capture a screenshot and store it in different ways.
*
* Example usage:
*
*
* import static openqa.selenium.OutputType.*;
*
* File screenshotFile = ((Screenshot)driver).getScreenshotAs(file);
* String screenshotBase64 = ((Screenshot)driver).getScreenshotAs(base64);
*
*
* @see OutputType
*/
public interface TakesScreenshot {
/**
* Capture the screenshot and store it in the specified location.
*
* For WebDriver extending TakesScreenshot, this makes a best effort
* depending on the browser to return the following in order of preference:
*
* - Entire page
* - Current window
* - Visible portion of the current frame
* - The screenshot of the entire display containing the browser
*
*
* For WebElement extending TakesScreenshot, this makes a best effort
* depending on the browser to return the following in order of preference:
* - The entire content of the HTML element
* - The visisble portion of the HTML element
*
* @param Return type for getScreenshotAs.
* @param target target type, @see OutputType
* @return Object in which is stored information about the screenshot.
* @throws WebDriverException on failure.
*/
X getScreenshotAs(OutputType target) throws WebDriverException;
}