Package org.openqa.selenium.remote

Class RemoteWebDriver.RemoteWebDriverOptions.RemoteTimeouts

java.lang.Object

org.openqa.selenium.remote.RemoteWebDriver.RemoteWebDriverOptions.RemoteTimeouts

All Implemented Interfaces:

WebDriver.Timeouts

Enclosing class:

RemoteWebDriver.RemoteWebDriverOptions

protected class RemoteWebDriver.RemoteWebDriverOptions.RemoteTimeouts
extends Object
implements WebDriver.Timeouts

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	RemoteTimeouts()

Method Summary

Modifier and Type	Method	Description
Duration	getImplicitWaitTimeout()	Gets the amount of time the driver should wait when searching for an element if it is not immediately present.
Duration	getPageLoadTimeout()	Gets the amount of time to wait for a page load to complete before throwing an error.
Duration	getScriptTimeout()	Gets the amount of time to wait for an asynchronous script to finish execution before throwing an error.
WebDriver.Timeouts	implicitlyWait(long time, TimeUnit unit)	Deprecated.
WebDriver.Timeouts	implicitlyWait(Duration duration)	Specifies the amount of time the driver should wait when searching for an element if it is not immediately present.
WebDriver.Timeouts	pageLoadTimeout(long time, TimeUnit unit)	Deprecated.
WebDriver.Timeouts	pageLoadTimeout(Duration duration)	Sets the amount of time to wait for a page load to complete before throwing an error.
WebDriver.Timeouts	scriptTimeout(Duration duration)	Sets the amount of time to wait for an asynchronous script to finish execution before throwing an error.
WebDriver.Timeouts	setScriptTimeout(long time, TimeUnit unit)	Deprecated.
WebDriver.Timeouts	setScriptTimeout(Duration duration)	Deprecated.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

RemoteTimeouts

protected RemoteTimeouts()

Method Details

implicitlyWait

@Deprecated
public WebDriver.Timeouts implicitlyWait(long time,
 TimeUnit unit)

Deprecated.

Specified by:

implicitlyWait in interface WebDriver.Timeouts

Parameters:

time - The amount of time to wait.

unit - The unit of measure for time.

Returns:

A self reference.

implicitlyWait

public WebDriver.Timeouts implicitlyWait(Duration duration)

Description copied from interface: WebDriver.Timeouts

Specifies the amount of time the driver should wait when searching for an element if it is not immediately present.

When searching for a single element, the driver should poll the page until the element has been found, or this timeout expires before throwing a NoSuchElementException. When searching for multiple elements, the driver should poll the page until at least one element has been found or this timeout has expired.

Increasing the implicit wait timeout should be used judiciously as it will have an adverse effect on test run time, especially when used with slower location strategies like XPath.

If the timeout is negative, not null, or greater than 2e16 - 1, an error code with invalid argument will be returned.

Specified by:

implicitlyWait in interface WebDriver.Timeouts

Parameters:

duration - The duration to wait.

Returns:

A self reference.

getImplicitWaitTimeout

public Duration getImplicitWaitTimeout()

Description copied from interface: WebDriver.Timeouts

Gets the amount of time the driver should wait when searching for an element if it is not immediately present.

Specified by:

getImplicitWaitTimeout in interface WebDriver.Timeouts

Returns:

The amount of time the driver should wait when searching for an element.

See Also:

• W3C WebDriver

setScriptTimeout

@Deprecated
public WebDriver.Timeouts setScriptTimeout(long time,
 TimeUnit unit)

Deprecated.

Specified by:

setScriptTimeout in interface WebDriver.Timeouts

Parameters:

time - The timeout value.

unit - The unit of time.

Returns:

A self reference.

See Also:

• JavascriptExecutor.executeAsyncScript(String, Object...)
• W3C WebDriver
• W3C WebDriver

setScriptTimeout

@Deprecated
public WebDriver.Timeouts setScriptTimeout(Duration duration)

Deprecated.

Description copied from interface: WebDriver.Timeouts

Sets the amount of time to wait for an asynchronous script to finish execution before throwing an error. If the timeout is negative, not null, or greater than 2e16 - 1, an error code with invalid argument will be returned.

Specified by:

setScriptTimeout in interface WebDriver.Timeouts

Parameters:

duration - The timeout value.

Returns:

A self reference.

See Also:

• JavascriptExecutor.executeAsyncScript(String, Object...)
• W3C WebDriver
• W3C WebDriver

scriptTimeout

public WebDriver.Timeouts scriptTimeout(Duration duration)

Description copied from interface: WebDriver.Timeouts

Sets the amount of time to wait for an asynchronous script to finish execution before throwing an error. If the timeout is negative, not null, or greater than 2e16 - 1, an error code with invalid argument will be returned.

Specified by:

scriptTimeout in interface WebDriver.Timeouts

Parameters:

duration - The timeout value.

Returns:

A self reference.

See Also:

• JavascriptExecutor.executeAsyncScript(String, Object...)
• W3C WebDriver
• W3C WebDriver

getScriptTimeout

public Duration getScriptTimeout()

Description copied from interface: WebDriver.Timeouts

Gets the amount of time to wait for an asynchronous script to finish execution before throwing an error. If the timeout is negative, not null, or greater than 2e16 - 1, an error code with invalid argument will be returned.

Specified by:

getScriptTimeout in interface WebDriver.Timeouts

Returns:

The amount of time to wait for an asynchronous script to finish execution.

See Also:

• W3C WebDriver
• W3C WebDriver

pageLoadTimeout

@Deprecated
public WebDriver.Timeouts pageLoadTimeout(long time,
 TimeUnit unit)

Deprecated.

Specified by:

pageLoadTimeout in interface WebDriver.Timeouts

Parameters:

time - The timeout value.

unit - The unit of time.

Returns:

A Timeouts interface.

See Also:

• W3C WebDriver
• W3C WebDriver

pageLoadTimeout

public WebDriver.Timeouts pageLoadTimeout(Duration duration)

Description copied from interface: WebDriver.Timeouts

Sets the amount of time to wait for a page load to complete before throwing an error. If the timeout is negative, not null, or greater than 2e16 - 1, an error code with invalid argument will be returned.

Specified by:

pageLoadTimeout in interface WebDriver.Timeouts

Parameters:

duration - The timeout value.

Returns:

A Timeouts interface.

See Also:

• W3C WebDriver
• W3C WebDriver

getPageLoadTimeout

public Duration getPageLoadTimeout()

Description copied from interface: WebDriver.Timeouts

Gets the amount of time to wait for a page load to complete before throwing an error. If the timeout is negative, not null, or greater than 2e16 - 1, an error code with invalid argument will be returned.

Specified by:

getPageLoadTimeout in interface WebDriver.Timeouts

Returns:

The amount of time to wait for a page load to complete.

See Also:

• W3C WebDriver
• W3C WebDriver