Package com.microsoft.playwright

Class APIRequest.NewContextOptions

java.lang.Object

com.microsoft.playwright.APIRequest.NewContextOptions

Enclosing interface:

APIRequest

public static class APIRequest.NewContextOptions
extends Object

Field Summary

Fields

Modifier and Type	Field	Description
String	baseURL	Methods like APIRequestContext.get() take the base URL into consideration by using the URL() constructor for building the corresponding URL.
Map<String,String>	extraHTTPHeaders	An object containing additional HTTP headers to be sent with every request.
HttpCredentials	httpCredentials	Credentials for HTTP authentication.
Boolean	ignoreHTTPSErrors	Whether to ignore HTTPS errors when sending network requests.
Proxy	proxy	Network proxy settings.
String	storageState	Populates context with given storage state.
Path	storageStatePath	Populates context with given storage state.
Double	timeout	Maximum time in milliseconds to wait for the response.
String	userAgent	Specific user agent to use in this context.

Constructor Summary

Constructors

Constructor	Description
NewContextOptions()

Method Summary

Modifier and Type	Method	Description
APIRequest.NewContextOptions	setBaseURL(String baseURL)	Methods like APIRequestContext.get() take the base URL into consideration by using the URL() constructor for building the corresponding URL.
APIRequest.NewContextOptions	setExtraHTTPHeaders(Map<String,String> extraHTTPHeaders)	An object containing additional HTTP headers to be sent with every request.
APIRequest.NewContextOptions	setHttpCredentials(HttpCredentials httpCredentials)	Credentials for HTTP authentication.
APIRequest.NewContextOptions	setHttpCredentials(String username, String password)	Credentials for HTTP authentication.
APIRequest.NewContextOptions	setIgnoreHTTPSErrors(boolean ignoreHTTPSErrors)	Whether to ignore HTTPS errors when sending network requests.
APIRequest.NewContextOptions	setProxy(Proxy proxy)	Network proxy settings.
APIRequest.NewContextOptions	setProxy(String server)	Network proxy settings.
APIRequest.NewContextOptions	setStorageState(String storageState)	Populates context with given storage state.
APIRequest.NewContextOptions	setStorageStatePath(Path storageStatePath)	Populates context with given storage state.
APIRequest.NewContextOptions	setTimeout(double timeout)	Maximum time in milliseconds to wait for the response.
APIRequest.NewContextOptions	setUserAgent(String userAgent)	Specific user agent to use in this context.

Methods inherited from class java.lang.Object

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

Field Details

baseURL

public String baseURL

Methods like APIRequestContext.get() take the base URL into consideration by using the URL() constructor for building the corresponding URL. Examples:

• baseURL: http://localhost:3000 and sending request to /bar.html results in http://localhost:3000/bar.html
• baseURL: http://localhost:3000/foo/ and sending request to ./bar.html results in http://localhost:3000/foo/bar.html
• baseURL: http://localhost:3000/foo (without trailing slash) and navigating to ./bar.html results in http://localhost:3000/bar.html

extraHTTPHeaders

public Map<String,String> extraHTTPHeaders

An object containing additional HTTP headers to be sent with every request. Defaults to none.

httpCredentials

public HttpCredentials httpCredentials

Credentials for HTTP authentication. If no origin is specified, the username and password are sent to any servers upon unauthorized responses.

ignoreHTTPSErrors

public Boolean ignoreHTTPSErrors

Whether to ignore HTTPS errors when sending network requests. Defaults to false.

proxy

public Proxy proxy

Network proxy settings.

storageState

public String storageState

Populates context with given storage state. This option can be used to initialize context with logged-in information obtained via BrowserContext.storageState() or APIRequestContext.storageState(). Either a path to the file with saved storage, or the value returned by one of BrowserContext.storageState() or APIRequestContext.storageState() methods.

storageStatePath

public Path storageStatePath

Populates context with given storage state. This option can be used to initialize context with logged-in information obtained via BrowserContext.storageState(). Path to the file with saved storage state.

timeout

public Double timeout

Maximum time in milliseconds to wait for the response. Defaults to 30000 (30 seconds). Pass 0 to disable timeout.

userAgent

public String userAgent

Specific user agent to use in this context.

Constructor Details

NewContextOptions

public NewContextOptions()

Method Details

setBaseURL

public APIRequest.NewContextOptions setBaseURL(String baseURL)

Methods like APIRequestContext.get() take the base URL into consideration by using the URL() constructor for building the corresponding URL. Examples:

• baseURL: http://localhost:3000 and sending request to /bar.html results in http://localhost:3000/bar.html
• baseURL: http://localhost:3000/foo/ and sending request to ./bar.html results in http://localhost:3000/foo/bar.html
• baseURL: http://localhost:3000/foo (without trailing slash) and navigating to ./bar.html results in http://localhost:3000/bar.html

setExtraHTTPHeaders

public APIRequest.NewContextOptions setExtraHTTPHeaders(Map<String,String> extraHTTPHeaders)

An object containing additional HTTP headers to be sent with every request. Defaults to none.

setHttpCredentials

public APIRequest.NewContextOptions setHttpCredentials(String username,
 String password)

Credentials for HTTP authentication. If no origin is specified, the username and password are sent to any servers upon unauthorized responses.

setHttpCredentials

public APIRequest.NewContextOptions setHttpCredentials(HttpCredentials httpCredentials)

Credentials for HTTP authentication. If no origin is specified, the username and password are sent to any servers upon unauthorized responses.

setIgnoreHTTPSErrors

public APIRequest.NewContextOptions setIgnoreHTTPSErrors(boolean ignoreHTTPSErrors)

Whether to ignore HTTPS errors when sending network requests. Defaults to false.

setProxy

public APIRequest.NewContextOptions setProxy(String server)

Network proxy settings.

setProxy

public APIRequest.NewContextOptions setProxy(Proxy proxy)

Network proxy settings.

setStorageState

public APIRequest.NewContextOptions setStorageState(String storageState)

Populates context with given storage state. This option can be used to initialize context with logged-in information obtained via BrowserContext.storageState() or APIRequestContext.storageState(). Either a path to the file with saved storage, or the value returned by one of BrowserContext.storageState() or APIRequestContext.storageState() methods.

setStorageStatePath

public APIRequest.NewContextOptions setStorageStatePath(Path storageStatePath)

Populates context with given storage state. This option can be used to initialize context with logged-in information obtained via BrowserContext.storageState(). Path to the file with saved storage state.

setTimeout

public APIRequest.NewContextOptions setTimeout(double timeout)

Maximum time in milliseconds to wait for the response. Defaults to 30000 (30 seconds). Pass 0 to disable timeout.

setUserAgent

public APIRequest.NewContextOptions setUserAgent(String userAgent)

Specific user agent to use in this context.