Browser.NewContextOptions (Playwright - Main Library 1.21.0 API)

java.lang.Object
- com.microsoft.playwright.Browser.NewContextOptions

Enclosing interface:: Browser

public static class Browser.NewContextOptions
extends Object

Field Summary

Fields
Modifier and Type	Field and Description
`Boolean`	`acceptDownloads` Whether to automatically download all the attachments.
`String`	`baseURL` When using `Page.navigate()`, `Page.route()`, `Page.waitForURL()`, `Page.waitForRequest()`, or `Page.waitForResponse()` it takes the base URL in consideration by using the `URL()` constructor for building the corresponding URL.
`Boolean`	`bypassCSP` Toggles bypassing page's Content-Security-Policy.
`ColorScheme`	`colorScheme` Emulates `"prefers-colors-scheme"` media feature, supported values are `"light"`, `"dark"`, `"no-preference"`.
`Double`	`deviceScaleFactor` Specify device scale factor (can be thought of as dpr).
`Map<String,String>`	`extraHTTPHeaders` An object containing additional HTTP headers to be sent with every request.
`ForcedColors`	`forcedColors` Emulates `"forced-colors"` media feature, supported values are `"active"`, `"none"`.
`Geolocation`	`geolocation`
`Boolean`	`hasTouch` Specifies if viewport supports touch events.
`HttpCredentials`	`httpCredentials` Credentials for HTTP authentication.
`Boolean`	`ignoreHTTPSErrors` Whether to ignore HTTPS errors when sending network requests.
`Boolean`	`isMobile` Whether the `meta viewport` tag is taken into account and touch events are enabled.
`Boolean`	`javaScriptEnabled` Whether or not to enable JavaScript in the context.
`String`	`locale` Specify user locale, for example `en-GB`, `de-DE`, etc.
`Boolean`	`offline` Whether to emulate network being offline.
`List<String>`	`permissions` A list of permissions to grant to all pages in this context.
`Proxy`	`proxy` Network proxy settings to use with this context.
`Boolean`	`recordHarOmitContent` Optional setting to control whether to omit request content from the HAR.
`Path`	`recordHarPath` Enables HAR recording for all pages into the specified HAR file on the filesystem.
`Path`	`recordVideoDir` Enables video recording for all pages into the specified directory.
`RecordVideoSize`	`recordVideoSize` Dimensions of the recorded videos.
`ReducedMotion`	`reducedMotion` Emulates `"prefers-reduced-motion"` media feature, supported values are `"reduce"`, `"no-preference"`.
`ScreenSize`	`screenSize` Emulates consistent window screen size available inside web page via `window.screen`.
`String`	`storageState` Populates context with given storage state.
`Path`	`storageStatePath` Populates context with given storage state.
`Boolean`	`strictSelectors` It specified, enables strict selectors mode for this context.
`String`	`timezoneId` Changes the timezone of the context.
`String`	`userAgent` Specific user agent to use in this context.
`Optional<ViewportSize>`	`viewportSize` Emulates consistent viewport for each page.

Constructor Summary

Constructors
Constructor and Description

NewContextOptions()

Constructors
Constructor and Description
`NewContextOptions()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Browser.NewContextOptions`	`setAcceptDownloads(boolean acceptDownloads)` Whether to automatically download all the attachments.
`Browser.NewContextOptions`	`setBaseURL(String baseURL)` When using `Page.navigate()`, `Page.route()`, `Page.waitForURL()`, `Page.waitForRequest()`, or `Page.waitForResponse()` it takes the base URL in consideration by using the `URL()` constructor for building the corresponding URL.
`Browser.NewContextOptions`	`setBypassCSP(boolean bypassCSP)` Toggles bypassing page's Content-Security-Policy.
`Browser.NewContextOptions`	`setColorScheme(ColorScheme colorScheme)` Emulates `"prefers-colors-scheme"` media feature, supported values are `"light"`, `"dark"`, `"no-preference"`.
`Browser.NewContextOptions`	`setDeviceScaleFactor(double deviceScaleFactor)` Specify device scale factor (can be thought of as dpr).
`Browser.NewContextOptions`	`setExtraHTTPHeaders(Map<String,String> extraHTTPHeaders)` An object containing additional HTTP headers to be sent with every request.
`Browser.NewContextOptions`	`setForcedColors(ForcedColors forcedColors)` Emulates `"forced-colors"` media feature, supported values are `"active"`, `"none"`.
`Browser.NewContextOptions`	`setGeolocation(double latitude, double longitude)`
`Browser.NewContextOptions`	`setGeolocation(Geolocation geolocation)`
`Browser.NewContextOptions`	`setHasTouch(boolean hasTouch)` Specifies if viewport supports touch events.
`Browser.NewContextOptions`	`setHttpCredentials(HttpCredentials httpCredentials)` Credentials for HTTP authentication.
`Browser.NewContextOptions`	`setHttpCredentials(String username, String password)` Credentials for HTTP authentication.
`Browser.NewContextOptions`	`setIgnoreHTTPSErrors(boolean ignoreHTTPSErrors)` Whether to ignore HTTPS errors when sending network requests.
`Browser.NewContextOptions`	`setIsMobile(boolean isMobile)` Whether the `meta viewport` tag is taken into account and touch events are enabled.
`Browser.NewContextOptions`	`setJavaScriptEnabled(boolean javaScriptEnabled)` Whether or not to enable JavaScript in the context.
`Browser.NewContextOptions`	`setLocale(String locale)` Specify user locale, for example `en-GB`, `de-DE`, etc.
`Browser.NewContextOptions`	`setOffline(boolean offline)` Whether to emulate network being offline.
`Browser.NewContextOptions`	`setPermissions(List<String> permissions)` A list of permissions to grant to all pages in this context.
`Browser.NewContextOptions`	`setProxy(Proxy proxy)` Network proxy settings to use with this context.
`Browser.NewContextOptions`	`setProxy(String server)` Network proxy settings to use with this context.
`Browser.NewContextOptions`	`setRecordHarOmitContent(boolean recordHarOmitContent)` Optional setting to control whether to omit request content from the HAR.
`Browser.NewContextOptions`	`setRecordHarPath(Path recordHarPath)` Enables HAR recording for all pages into the specified HAR file on the filesystem.
`Browser.NewContextOptions`	`setRecordVideoDir(Path recordVideoDir)` Enables video recording for all pages into the specified directory.
`Browser.NewContextOptions`	`setRecordVideoSize(int width, int height)` Dimensions of the recorded videos.
`Browser.NewContextOptions`	`setRecordVideoSize(RecordVideoSize recordVideoSize)` Dimensions of the recorded videos.
`Browser.NewContextOptions`	`setReducedMotion(ReducedMotion reducedMotion)` Emulates `"prefers-reduced-motion"` media feature, supported values are `"reduce"`, `"no-preference"`.
`Browser.NewContextOptions`	`setScreenSize(int width, int height)` Emulates consistent window screen size available inside web page via `window.screen`.
`Browser.NewContextOptions`	`setScreenSize(ScreenSize screenSize)` Emulates consistent window screen size available inside web page via `window.screen`.
`Browser.NewContextOptions`	`setStorageState(String storageState)` Populates context with given storage state.
`Browser.NewContextOptions`	`setStorageStatePath(Path storageStatePath)` Populates context with given storage state.
`Browser.NewContextOptions`	`setStrictSelectors(boolean strictSelectors)` It specified, enables strict selectors mode for this context.
`Browser.NewContextOptions`	`setTimezoneId(String timezoneId)` Changes the timezone of the context.
`Browser.NewContextOptions`	`setUserAgent(String userAgent)` Specific user agent to use in this context.
`Browser.NewContextOptions`	`setViewportSize(int width, int height)` Emulates consistent viewport for each page.
`Browser.NewContextOptions`	`setViewportSize(ViewportSize viewportSize)` Emulates consistent viewport for each page.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - acceptDownloads
```
public Boolean acceptDownloads
```
    Whether to automatically download all the attachments. Defaults to true where all the downloads are accepted.
  - baseURL
```
public String baseURL
```
    When using Page.navigate(), Page.route(), Page.waitForURL(), Page.waitForRequest(), or Page.waitForResponse() it takes the base URL in consideration by using the URL() constructor for building the corresponding URL. Examples:
    - baseURL: http://localhost:3000 and navigating to /bar.html results in http://localhost:3000/bar.html
    - baseURL: http://localhost:3000/foo/ and navigating 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
  - bypassCSP
```
public Boolean bypassCSP
```
    Toggles bypassing page's Content-Security-Policy.
  - colorScheme
```
public ColorScheme colorScheme
```
    Emulates "prefers-colors-scheme" media feature, supported values are "light", "dark", "no-preference". See Page.emulateMedia() for more details. Defaults to "light".
  - deviceScaleFactor
```
public Double deviceScaleFactor
```
    Specify device scale factor (can be thought of as dpr). Defaults to 1.
  - extraHTTPHeaders
```
public Map<String,String> extraHTTPHeaders
```
    An object containing additional HTTP headers to be sent with every request.
  - forcedColors
```
public ForcedColors forcedColors
```
    Emulates "forced-colors" media feature, supported values are "active", "none". See Page.emulateMedia() for more details. Defaults to "none".
    NOTE: It's not supported in WebKit, see here in their issue tracker.
  - geolocation
```
public Geolocation geolocation
```
  - hasTouch
```
public Boolean hasTouch
```
    Specifies if viewport supports touch events. Defaults to false.
  - httpCredentials
```
public HttpCredentials httpCredentials
```
    Credentials for HTTP authentication.
  - ignoreHTTPSErrors
```
public Boolean ignoreHTTPSErrors
```
    Whether to ignore HTTPS errors when sending network requests. Defaults to false.
  - isMobile
```
public Boolean isMobile
```
    Whether the meta viewport tag is taken into account and touch events are enabled. Defaults to false. Not supported in Firefox.
  - javaScriptEnabled
```
public Boolean javaScriptEnabled
```
    Whether or not to enable JavaScript in the context. Defaults to true.
  - locale
```
public String locale
```
    Specify user locale, for example en-GB, de-DE, etc. Locale will affect navigator.language value, Accept-Language request header value as well as number and date formatting rules.
  - offline
```
public Boolean offline
```
    Whether to emulate network being offline. Defaults to false.
  - permissions
```
public List<String> permissions
```
    A list of permissions to grant to all pages in this context. See BrowserContext.grantPermissions() for more details.
  - proxy
```
public Proxy proxy
```
    Network proxy settings to use with this context.
    NOTE: For Chromium on Windows the browser needs to be launched with the global proxy for this option to work. If all contexts override the proxy, global proxy will be never used and can be any string, for example launch({ proxy: { server: 'http://per-context' } }).
  - recordHarOmitContent
```
public Boolean recordHarOmitContent
```
    Optional setting to control whether to omit request content from the HAR. Defaults to false.
  - recordHarPath
```
public Path recordHarPath
```
    Enables HAR recording for all pages into the specified HAR file on the filesystem. If not specified, the HAR is not recorded. Make sure to call BrowserContext.close() for the HAR to be saved.
  - recordVideoDir
```
public Path recordVideoDir
```
    Enables video recording for all pages into the specified directory. If not specified videos are not recorded. Make sure to call BrowserContext.close() for videos to be saved.
  - recordVideoSize
```
public RecordVideoSize recordVideoSize
```
    Dimensions of the recorded videos. If not specified the size will be equal to viewport scaled down to fit into 800x800. If viewport is not configured explicitly the video size defaults to 800x450. Actual picture of each page will be scaled down if necessary to fit the specified size.
  - reducedMotion
```
public ReducedMotion reducedMotion
```
    Emulates "prefers-reduced-motion" media feature, supported values are "reduce", "no-preference". See Page.emulateMedia() for more details. Defaults to "no-preference".
  - screenSize
```
public ScreenSize screenSize
```
    Emulates consistent window screen size available inside web page via window.screen. Is only used when the viewport is set.
  - 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().
  - 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.
  - strictSelectors
```
public Boolean strictSelectors
```
    It specified, enables strict selectors mode for this context. In the strict selectors mode all operations on selectors that imply single target DOM element will throw when more than one element matches the selector. See Locator to learn more about the strict mode.
  - timezoneId
```
public String timezoneId
```
    Changes the timezone of the context. See ICU's metaZones.txt for a list of supported timezone IDs.
  - userAgent
```
public String userAgent
```
    Specific user agent to use in this context.
  - viewportSize
```
public Optional<ViewportSize> viewportSize
```
    Emulates consistent viewport for each page. Defaults to an 1280x720 viewport. null disables the default viewport.
- Constructor Detail
  - NewContextOptions
```
public NewContextOptions()
```
- Method Detail
  - setAcceptDownloads
```
public Browser.NewContextOptions setAcceptDownloads(boolean acceptDownloads)
```
    Whether to automatically download all the attachments. Defaults to true where all the downloads are accepted.
  - setBaseURL
```
public Browser.NewContextOptions setBaseURL(String baseURL)
```
    When using Page.navigate(), Page.route(), Page.waitForURL(), Page.waitForRequest(), or Page.waitForResponse() it takes the base URL in consideration by using the URL() constructor for building the corresponding URL. Examples:
    - baseURL: http://localhost:3000 and navigating to /bar.html results in http://localhost:3000/bar.html
    - baseURL: http://localhost:3000/foo/ and navigating 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
  - setBypassCSP
```
public Browser.NewContextOptions setBypassCSP(boolean bypassCSP)
```
    Toggles bypassing page's Content-Security-Policy.
  - setColorScheme
```
public Browser.NewContextOptions setColorScheme(ColorScheme colorScheme)
```
    Emulates "prefers-colors-scheme" media feature, supported values are "light", "dark", "no-preference". See Page.emulateMedia() for more details. Defaults to "light".
  - setDeviceScaleFactor
```
public Browser.NewContextOptions setDeviceScaleFactor(double deviceScaleFactor)
```
    Specify device scale factor (can be thought of as dpr). Defaults to 1.
  - setExtraHTTPHeaders
```
public Browser.NewContextOptions setExtraHTTPHeaders(Map<String,String> extraHTTPHeaders)
```
    An object containing additional HTTP headers to be sent with every request.
  - setForcedColors
```
public Browser.NewContextOptions setForcedColors(ForcedColors forcedColors)
```
    Emulates "forced-colors" media feature, supported values are "active", "none". See Page.emulateMedia() for more details. Defaults to "none".
    NOTE: It's not supported in WebKit, see here in their issue tracker.
  - setGeolocation
```
public Browser.NewContextOptions setGeolocation(double latitude,
                                                double longitude)
```
  - setGeolocation
```
public Browser.NewContextOptions setGeolocation(Geolocation geolocation)
```
  - setHasTouch
```
public Browser.NewContextOptions setHasTouch(boolean hasTouch)
```
    Specifies if viewport supports touch events. Defaults to false.
  - setHttpCredentials
```
public Browser.NewContextOptions setHttpCredentials(String username,
                                                    String password)
```
    Credentials for HTTP authentication.
  - setHttpCredentials
```
public Browser.NewContextOptions setHttpCredentials(HttpCredentials httpCredentials)
```
    Credentials for HTTP authentication.
  - setIgnoreHTTPSErrors
```
public Browser.NewContextOptions setIgnoreHTTPSErrors(boolean ignoreHTTPSErrors)
```
    Whether to ignore HTTPS errors when sending network requests. Defaults to false.
  - setIsMobile
```
public Browser.NewContextOptions setIsMobile(boolean isMobile)
```
    Whether the meta viewport tag is taken into account and touch events are enabled. Defaults to false. Not supported in Firefox.
  - setJavaScriptEnabled
```
public Browser.NewContextOptions setJavaScriptEnabled(boolean javaScriptEnabled)
```
    Whether or not to enable JavaScript in the context. Defaults to true.
  - setLocale
```
public Browser.NewContextOptions setLocale(String locale)
```
    Specify user locale, for example en-GB, de-DE, etc. Locale will affect navigator.language value, Accept-Language request header value as well as number and date formatting rules.
  - setOffline
```
public Browser.NewContextOptions setOffline(boolean offline)
```
    Whether to emulate network being offline. Defaults to false.
  - setPermissions
```
public Browser.NewContextOptions setPermissions(List<String> permissions)
```
    A list of permissions to grant to all pages in this context. See BrowserContext.grantPermissions() for more details.
  - setProxy
```
public Browser.NewContextOptions setProxy(String server)
```
    Network proxy settings to use with this context.
    NOTE: For Chromium on Windows the browser needs to be launched with the global proxy for this option to work. If all contexts override the proxy, global proxy will be never used and can be any string, for example launch({ proxy: { server: 'http://per-context' } }).
  - setProxy
```
public Browser.NewContextOptions setProxy(Proxy proxy)
```
    Network proxy settings to use with this context.
    NOTE: For Chromium on Windows the browser needs to be launched with the global proxy for this option to work. If all contexts override the proxy, global proxy will be never used and can be any string, for example launch({ proxy: { server: 'http://per-context' } }).
  - setRecordHarOmitContent
```
public Browser.NewContextOptions setRecordHarOmitContent(boolean recordHarOmitContent)
```
    Optional setting to control whether to omit request content from the HAR. Defaults to false.
  - setRecordHarPath
```
public Browser.NewContextOptions setRecordHarPath(Path recordHarPath)
```
    Enables HAR recording for all pages into the specified HAR file on the filesystem. If not specified, the HAR is not recorded. Make sure to call BrowserContext.close() for the HAR to be saved.
  - setRecordVideoDir
```
public Browser.NewContextOptions setRecordVideoDir(Path recordVideoDir)
```
    Enables video recording for all pages into the specified directory. If not specified videos are not recorded. Make sure to call BrowserContext.close() for videos to be saved.
  - setRecordVideoSize
```
public Browser.NewContextOptions setRecordVideoSize(int width,
                                                    int height)
```
    Dimensions of the recorded videos. If not specified the size will be equal to viewport scaled down to fit into 800x800. If viewport is not configured explicitly the video size defaults to 800x450. Actual picture of each page will be scaled down if necessary to fit the specified size.
  - setRecordVideoSize
```
public Browser.NewContextOptions setRecordVideoSize(RecordVideoSize recordVideoSize)
```
    Dimensions of the recorded videos. If not specified the size will be equal to viewport scaled down to fit into 800x800. If viewport is not configured explicitly the video size defaults to 800x450. Actual picture of each page will be scaled down if necessary to fit the specified size.
  - setReducedMotion
```
public Browser.NewContextOptions setReducedMotion(ReducedMotion reducedMotion)
```
    Emulates "prefers-reduced-motion" media feature, supported values are "reduce", "no-preference". See Page.emulateMedia() for more details. Defaults to "no-preference".
  - setScreenSize
```
public Browser.NewContextOptions setScreenSize(int width,
                                               int height)
```
    Emulates consistent window screen size available inside web page via window.screen. Is only used when the viewport is set.
  - setScreenSize
```
public Browser.NewContextOptions setScreenSize(ScreenSize screenSize)
```
    Emulates consistent window screen size available inside web page via window.screen. Is only used when the viewport is set.
  - setStorageState
```
public Browser.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().
  - setStorageStatePath
```
public Browser.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.
  - setStrictSelectors
```
public Browser.NewContextOptions setStrictSelectors(boolean strictSelectors)
```
    It specified, enables strict selectors mode for this context. In the strict selectors mode all operations on selectors that imply single target DOM element will throw when more than one element matches the selector. See Locator to learn more about the strict mode.
  - setTimezoneId
```
public Browser.NewContextOptions setTimezoneId(String timezoneId)
```
    Changes the timezone of the context. See ICU's metaZones.txt for a list of supported timezone IDs.
  - setUserAgent
```
public Browser.NewContextOptions setUserAgent(String userAgent)
```
    Specific user agent to use in this context.
  - setViewportSize
```
public Browser.NewContextOptions setViewportSize(int width,
                                                 int height)
```
    Emulates consistent viewport for each page. Defaults to an 1280x720 viewport. null disables the default viewport.
  - setViewportSize
```
public Browser.NewContextOptions setViewportSize(ViewportSize viewportSize)
```
    Emulates consistent viewport for each page. Defaults to an 1280x720 viewport. null disables the default viewport.

Class Browser.NewContextOptions

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

acceptDownloads

baseURL

bypassCSP

colorScheme

deviceScaleFactor

extraHTTPHeaders

forcedColors

geolocation

hasTouch

httpCredentials

ignoreHTTPSErrors

isMobile

javaScriptEnabled

locale

offline

permissions

proxy

recordHarOmitContent

recordHarPath

recordVideoDir

recordVideoSize

reducedMotion

screenSize

storageState

storageStatePath

strictSelectors

timezoneId

userAgent

viewportSize

Constructor Detail

NewContextOptions

Method Detail

setAcceptDownloads

setBaseURL

setBypassCSP

setColorScheme

setDeviceScaleFactor

setExtraHTTPHeaders

setForcedColors

setGeolocation

setGeolocation

setHasTouch

setHttpCredentials

setHttpCredentials

setIgnoreHTTPSErrors

setIsMobile

setJavaScriptEnabled

setLocale

setOffline

setPermissions

setProxy

setProxy

setRecordHarOmitContent

setRecordHarPath

setRecordVideoDir

setRecordVideoSize

setRecordVideoSize

setReducedMotion

setScreenSize

setScreenSize

setStorageState

setStorageStatePath

setStrictSelectors

setTimezoneId

setUserAgent

setViewportSize

setViewportSize