Package com.intuit.karate.driver

Interface Driver

All Superinterfaces:

Plugin

All Known Implementing Classes:

AndroidDriver, AppiumDriver, Chrome, ChromeWebDriver, DevToolsDriver, EdgeChromium, GeckoWebDriver, IeWebDriver, IosDriver, MsEdgeDriver, MsWebDriver, PlaywrightDriver, SafariWebDriver, WebDriver, WinAppDriver

public interface Driver
extends Plugin

Author:

pthomas3

Field Summary

Fields

Modifier and Type	Field	Description
static List<String>	METHOD_NAMES

Method Summary

Modifier and Type	Method	Description
default Finder	above(String locator)
void	actions(List<Map<String,Object>> actions)
void	activate()
default Map<String,Object>	afterScenario()
String	attribute(String locator, String name)
void	back()
default Finder	below(String locator)
Element	clear(String locator)
void	clearCookies()
Element	click(String locator)
void	close()
Map<String,Object>	cookie(String name)
void	cookie(Map<String,Object> cookie)
default Driver	delay(int millis)
void	deleteCookie(String name)
void	dialog(boolean accept)
void	dialog(boolean accept, String input)
Object	elementId(String locator)
List	elementIds(String locator)
boolean	enabled(String locator)
default boolean	exists(String locator)
Element	focus(String locator)
void	forward()
void	fullscreen()
List<Map>	getCookies()
String	getDialogText()
Map<String,Object>	getDimensions()
DriverOptions	getOptions()
List<String>	getPages()
String	getTitle()
String	getUrl()
default Element	highlight(String locator)
default Element	highlight(String locator, int millis)
default void	highlightAll(String locator)
default void	highlightAll(String locator, int millis)
String	html(String locator)
Element	input(String locator, String value)
default Element	input(String locator, String[] values)
default Element	input(String locator, String[] values, int delay)
default Element	input(String locator, String chars, int delay)
boolean	isTerminated()
default Keys	keys()
default Finder	leftOf(String locator)
default Element	locate(String locator)
default List<Element>	locateAll(String locator)
default List<Element>	locateAll(String locator, java.util.function.Predicate predicate)
void	maximize()
default List<String>	methodNames()
void	minimize()
default Mouse	mouse()
default Mouse	mouse(int x, int y)
default Mouse	mouse(String locator)
default Finder	near(String locator)
default void	onFailure(StepResult stepResult)
default Element	optional(String locator)
byte[]	pdf(Map<String,Object> options)
Map<String,Object>	position(String locator)
Map<String,Object>	position(String locator, boolean relative)
String	property(String locator, String name)
void	quit()
void	refresh()
void	reload()
default Driver	retry()
default Driver	retry(int count)
default Driver	retry(Integer count, Integer interval)
default Finder	rightOf(String locator)
default byte[]	screenshot()
byte[]	screenshot(boolean embed)
default byte[]	screenshot(String locator)
byte[]	screenshot(String locator, boolean embed)
Object	script(String expression)
default Object	script(String locator, String expression)
default List	scriptAll(String locator, String expression)
default List	scriptAll(String locator, String expression, java.util.function.Predicate predicate)
default Element	scroll(String locator)
Element	select(String locator, int index)
Element	select(String locator, String text)
default void	setCookies(List<Map<String,Object>> cookies)
void	setDimensions(Map<String,Object> map)
void	setUrl(String url)
static Driver	start(String browserType)
static Driver	start(Map<String,Object> options)
Driver	submit()
void	switchFrame(int index)
void	switchFrame(String locator)
void	switchPage(int index)
void	switchPage(String titleOrUrl)
String	text(String locator)
Driver	timeout()
Driver	timeout(Integer millis)
String	value(String locator)
Element	value(String locator, String value)
default Element	waitFor(String locator)
default Element	waitForAny(String[] locators)
default Element	waitForAny(String locator1, String locator2)
default Element	waitForEnabled(String locator)
default List<Element>	waitForResultCount(String locator, int count)
default List	waitForResultCount(String locator, int count, String expression)
default Element	waitForText(String locator, String expected)
default String	waitForUrl(String expected)
boolean	waitUntil(String expression)
default Element	waitUntil(String locator, String expression)
default Object	waitUntil(java.util.function.Supplier<Object> condition)

Methods inherited from interface com.intuit.karate.core.Plugin

getRuntime

Field Detail

METHOD_NAMES

static final List<String> METHOD_NAMES

Method Detail

start

static Driver start(String browserType)

start

static Driver start(Map<String,Object> options)

activate

void activate()

refresh

void refresh()

reload

void reload()

back

void back()

forward

void forward()

maximize

void maximize()

minimize

void minimize()

fullscreen

void fullscreen()

close

void close()

quit

void quit()

switchPage

void switchPage(String titleOrUrl)

switchPage

void switchPage(int index)

switchFrame

void switchFrame(int index)

switchFrame

void switchFrame(String locator)

getUrl

String getUrl()

setUrl

void setUrl(String url)

getDimensions

Map<String,Object> getDimensions()

setDimensions

void setDimensions(Map<String,Object> map)

getTitle

String getTitle()

getPages

List<String> getPages()

getDialogText

String getDialogText()

screenshot

byte[] screenshot(boolean embed)

screenshot

default byte[] screenshot()

cookie

Map<String,Object> cookie(String name)

setCookies

default void setCookies(List<Map<String,Object>> cookies)

cookie

void cookie(Map<String,Object> cookie)

deleteCookie

void deleteCookie(String name)

clearCookies

void clearCookies()

getCookies

List<Map> getCookies()

dialog

void dialog(boolean accept)

dialog

void dialog(boolean accept,
            String input)

script

Object script(String expression)

waitUntil

boolean waitUntil(String expression)

submit

Driver submit()

retry

default Driver retry()

retry

default Driver retry(int count)

retry

default Driver retry(Integer count,
                     Integer interval)

delay

default Driver delay(int millis)

timeout

Driver timeout(Integer millis)

timeout

Driver timeout()

focus

Element focus(String locator)

clear

Element clear(String locator)

click

Element click(String locator)

input

Element input(String locator,
              String value)

input

default Element input(String locator,
                      String[] values)

input

default Element input(String locator,
                      String chars,
                      int delay)

input

default Element input(String locator,
                      String[] values,
                      int delay)

select

Element select(String locator,
               String text)

select

Element select(String locator,
               int index)

value

Element value(String locator,
              String value)

waitFor

default Element waitFor(String locator)

waitForUrl

default String waitForUrl(String expected)

waitForText

default Element waitForText(String locator,
                            String expected)

waitForEnabled

default Element waitForEnabled(String locator)

waitForResultCount

default List<Element> waitForResultCount(String locator,
                                         int count)

waitForResultCount

default List waitForResultCount(String locator,
                                int count,
                                String expression)

waitForAny

default Element waitForAny(String locator1,
                           String locator2)

waitForAny

default Element waitForAny(String[] locators)

waitUntil

default Element waitUntil(String locator,
                          String expression)

waitUntil

default Object waitUntil(java.util.function.Supplier<Object> condition)

locate

default Element locate(String locator)

locateAll

default List<Element> locateAll(String locator)

locateAll

default List<Element> locateAll(String locator,
                                java.util.function.Predicate predicate)

scroll

default Element scroll(String locator)

highlight

default Element highlight(String locator)

highlight

default Element highlight(String locator,
                          int millis)

highlightAll

default void highlightAll(String locator)

highlightAll

default void highlightAll(String locator,
                          int millis)

rightOf

default Finder rightOf(String locator)

leftOf

default Finder leftOf(String locator)

above

default Finder above(String locator)

below

default Finder below(String locator)

near

default Finder near(String locator)

mouse

default Mouse mouse()

mouse

default Mouse mouse(String locator)

mouse

default Mouse mouse(int x,
                    int y)

keys

default Keys keys()

actions

void actions(List<Map<String,Object>> actions)

html

String html(String locator)

text

String text(String locator)

value

String value(String locator)

attribute

String attribute(String locator,
                 String name)

property

String property(String locator,
                String name)

enabled

boolean enabled(String locator)

exists

default boolean exists(String locator)

optional

default Element optional(String locator)

position

Map<String,Object> position(String locator)

position

Map<String,Object> position(String locator,
                                  boolean relative)

screenshot

byte[] screenshot(String locator,
                  boolean embed)

screenshot

default byte[] screenshot(String locator)

script

default Object script(String locator,
                      String expression)

scriptAll

default List scriptAll(String locator,
                       String expression)

scriptAll

default List scriptAll(String locator,
                       String expression,
                       java.util.function.Predicate predicate)

pdf

byte[] pdf(Map<String,Object> options)

isTerminated

boolean isTerminated()

getOptions

DriverOptions getOptions()

elementId

Object elementId(String locator)

elementIds

List elementIds(String locator)

methodNames

default List<String> methodNames()

Specified by:

methodNames in interface Plugin

afterScenario

default Map<String,Object> afterScenario()

Specified by:

afterScenario in interface Plugin

onFailure

default void onFailure(StepResult stepResult)

Specified by:

onFailure in interface Plugin