Package org.openqa.selenium

Interface WebDriver.Timeouts

All Known Implementing Classes:
RemoteWebDriver.RemoteWebDriverOptions.RemoteTimeouts
Enclosing interface:
WebDriver
public static interface WebDriver.Timeouts
An interface for managing timeout behavior for WebDriver instances.

See W3C WebDriver specification for more details.

  • Method Details

    • implicitlyWait

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

      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.

      Parameters:
      time - The amount of time to wait.
      unit - The unit of measure for time.
      Returns:
      A self reference.

    • implicitlyWait

      default 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.

      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.

      Parameters:
      duration - The duration to wait.
      Returns:
      A self reference.

    • getImplicitWaitTimeout

      default Duration getImplicitWaitTimeout()
      Gets the amount of time the driver should wait when searching for an element if it is not immediately present.
      Returns:
      The amount of time the driver should wait when searching for an element.
      See Also:

    • setScriptTimeout

      @Deprecated WebDriver.Timeouts setScriptTimeout(long time, TimeUnit unit)
      Deprecated.
      Use scriptTimeout(Duration)

      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.

      Parameters:
      time - The timeout value.
      unit - The unit of time.
      Returns:
      A self reference.
      See Also:

    • setScriptTimeout

      @Deprecated default WebDriver.Timeouts setScriptTimeout(Duration duration)
      Deprecated.
      Use scriptTimeout(Duration)
      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.
      Parameters:
      duration - The timeout value.
      Returns:
      A self reference.
      See Also:

    • scriptTimeout

      default WebDriver.Timeouts scriptTimeout(Duration duration)
      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.
      Parameters:
      duration - The timeout value.
      Returns:
      A self reference.
      See Also:

    • getScriptTimeout

      default Duration getScriptTimeout()
      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.
      Returns:
      The amount of time to wait for an asynchronous script to finish execution.
      See Also:

    • pageLoadTimeout

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

      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.

      Parameters:
      time - The timeout value.
      unit - The unit of time.
      Returns:
      A Timeouts interface.
      See Also:

    • pageLoadTimeout

      default WebDriver.Timeouts pageLoadTimeout(Duration duration)
      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.
      Parameters:
      duration - The timeout value.
      Returns:
      A Timeouts interface.
      See Also:

    • getPageLoadTimeout

      default Duration getPageLoadTimeout()
      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.
      Returns:
      The amount of time to wait for a page load to complete.
      See Also: