Package com.microsoft.playwright

Class Frame.NavigateOptions

java.lang.Object

com.microsoft.playwright.Frame.NavigateOptions

Enclosing interface:

Frame

public static class Frame.NavigateOptions
extends Object

Field Summary

Fields

Modifier and Type	Field	Description
String	referer	Referer header value.
Double	timeout	Maximum operation time in milliseconds, defaults to 30 seconds, pass 0 to disable timeout.
WaitUntilState	waitUntil	When to consider operation succeeded, defaults to load.

Constructor Summary

Constructors

Constructor	Description
NavigateOptions()

Method Summary

Modifier and Type	Method	Description
Frame.NavigateOptions	setReferer(String referer)	Referer header value.
Frame.NavigateOptions	setTimeout(double timeout)	Maximum operation time in milliseconds, defaults to 30 seconds, pass 0 to disable timeout.
Frame.NavigateOptions	setWaitUntil(WaitUntilState waitUntil)	When to consider operation succeeded, defaults to load.

Methods inherited from class java.lang.Object

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

Field Details

referer

public String referer

Referer header value. If provided it will take preference over the referer header value set by Page.setExtraHTTPHeaders().

timeout

public Double timeout

Maximum operation time in milliseconds, defaults to 30 seconds, pass 0 to disable timeout. The default value can be changed by using the BrowserContext.setDefaultNavigationTimeout(), BrowserContext.setDefaultTimeout(), Page.setDefaultNavigationTimeout() or Page.setDefaultTimeout() methods.

waitUntil

public WaitUntilState waitUntil

When to consider operation succeeded, defaults to load. Events can be either:

• "domcontentloaded" - consider operation to be finished when the DOMContentLoaded event is fired.
• "load" - consider operation to be finished when the load event is fired.
• "networkidle" - **DISCOURAGED** consider operation to be finished when there are no network connections for at least 500 ms. Don't use this method for testing, rely on web assertions to assess readiness instead.
• "commit" - consider operation to be finished when network response is received and the document started loading.

Constructor Details

NavigateOptions

public NavigateOptions()

Method Details

setReferer

public Frame.NavigateOptions setReferer(String referer)

Referer header value. If provided it will take preference over the referer header value set by Page.setExtraHTTPHeaders().

setTimeout

public Frame.NavigateOptions setTimeout(double timeout)

Maximum operation time in milliseconds, defaults to 30 seconds, pass 0 to disable timeout. The default value can be changed by using the BrowserContext.setDefaultNavigationTimeout(), BrowserContext.setDefaultTimeout(), Page.setDefaultNavigationTimeout() or Page.setDefaultTimeout() methods.

setWaitUntil

public Frame.NavigateOptions setWaitUntil(WaitUntilState waitUntil)

When to consider operation succeeded, defaults to load. Events can be either:

• "domcontentloaded" - consider operation to be finished when the DOMContentLoaded event is fired.
• "load" - consider operation to be finished when the load event is fired.
• "networkidle" - **DISCOURAGED** consider operation to be finished when there are no network connections for at least 500 ms. Don't use this method for testing, rely on web assertions to assess readiness instead.
• "commit" - consider operation to be finished when network response is received and the document started loading.