Browser.NewContextOptions (Playwright - Main Library 1.11.1 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.
`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.
`Geolocation`	`geolocation`
`Boolean`	`hasTouch` Specifies if viewport supports touch events.
`HttpCredentials`	`httpCredentials` Credentials for HTTP authentication.
`Boolean`	`ignoreHTTPSErrors` Whether to ignore HTTPS errors during navigation.
`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.
`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.
`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)`
`Browser.NewContextOptions`	`setBypassCSP(boolean bypassCSP)`
`Browser.NewContextOptions`	`setColorScheme(ColorScheme colorScheme)`
`Browser.NewContextOptions`	`setDeviceScaleFactor(double deviceScaleFactor)`
`Browser.NewContextOptions`	`setExtraHTTPHeaders(Map<String,String> extraHTTPHeaders)`
`Browser.NewContextOptions`	`setGeolocation(double latitude, double longitude)`
`Browser.NewContextOptions`	`setGeolocation(Geolocation geolocation)`
`Browser.NewContextOptions`	`setHasTouch(boolean hasTouch)`
`Browser.NewContextOptions`	`setHttpCredentials(HttpCredentials httpCredentials)`
`Browser.NewContextOptions`	`setHttpCredentials(String username, String password)`
`Browser.NewContextOptions`	`setIgnoreHTTPSErrors(boolean ignoreHTTPSErrors)`
`Browser.NewContextOptions`	`setIsMobile(boolean isMobile)`
`Browser.NewContextOptions`	`setJavaScriptEnabled(boolean javaScriptEnabled)`
`Browser.NewContextOptions`	`setLocale(String locale)`
`Browser.NewContextOptions`	`setOffline(boolean offline)`
`Browser.NewContextOptions`	`setPermissions(List<String> permissions)`
`Browser.NewContextOptions`	`setProxy(Proxy proxy)`
`Browser.NewContextOptions`	`setProxy(String server)`
`Browser.NewContextOptions`	`setRecordHarOmitContent(boolean recordHarOmitContent)`
`Browser.NewContextOptions`	`setRecordHarPath(Path recordHarPath)`
`Browser.NewContextOptions`	`setRecordVideoDir(Path recordVideoDir)`
`Browser.NewContextOptions`	`setRecordVideoSize(int width, int height)`
`Browser.NewContextOptions`	`setRecordVideoSize(RecordVideoSize recordVideoSize)`
`Browser.NewContextOptions`	`setScreenSize(int width, int height)`
`Browser.NewContextOptions`	`setScreenSize(ScreenSize screenSize)`
`Browser.NewContextOptions`	`setStorageState(String storageState)`
`Browser.NewContextOptions`	`setStorageStatePath(Path storageStatePath)`
`Browser.NewContextOptions`	`setTimezoneId(String timezoneId)`
`Browser.NewContextOptions`	`setUserAgent(String userAgent)`
`Browser.NewContextOptions`	`setViewportSize(int width, int height)`
`Browser.NewContextOptions`	`setViewportSize(ViewportSize viewportSize)`

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 false where all the downloads are canceled.
  - 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. All header values must be strings.
  - 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 during navigation. 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.
  - 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.
  - 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)
```
  - setBypassCSP
```
public Browser.NewContextOptions setBypassCSP(boolean bypassCSP)
```
  - setColorScheme
```
public Browser.NewContextOptions setColorScheme(ColorScheme colorScheme)
```
  - setDeviceScaleFactor
```
public Browser.NewContextOptions setDeviceScaleFactor(double deviceScaleFactor)
```
  - setExtraHTTPHeaders
```
public Browser.NewContextOptions setExtraHTTPHeaders(Map<String,String> extraHTTPHeaders)
```
  - setGeolocation
```
public Browser.NewContextOptions setGeolocation(double latitude,
                                                double longitude)
```
  - setGeolocation
```
public Browser.NewContextOptions setGeolocation(Geolocation geolocation)
```
  - setHasTouch
```
public Browser.NewContextOptions setHasTouch(boolean hasTouch)
```
  - setHttpCredentials
```
public Browser.NewContextOptions setHttpCredentials(String username,
                                                    String password)
```
  - setHttpCredentials
```
public Browser.NewContextOptions setHttpCredentials(HttpCredentials httpCredentials)
```
  - setIgnoreHTTPSErrors
```
public Browser.NewContextOptions setIgnoreHTTPSErrors(boolean ignoreHTTPSErrors)
```
  - setIsMobile
```
public Browser.NewContextOptions setIsMobile(boolean isMobile)
```
  - setJavaScriptEnabled
```
public Browser.NewContextOptions setJavaScriptEnabled(boolean javaScriptEnabled)
```
  - setLocale
```
public Browser.NewContextOptions setLocale(String locale)
```
  - setOffline
```
public Browser.NewContextOptions setOffline(boolean offline)
```
  - setPermissions
```
public Browser.NewContextOptions setPermissions(List<String> permissions)
```
  - setProxy
```
public Browser.NewContextOptions setProxy(String server)
```
  - setProxy
```
public Browser.NewContextOptions setProxy(Proxy proxy)
```
  - setRecordHarOmitContent
```
public Browser.NewContextOptions setRecordHarOmitContent(boolean recordHarOmitContent)
```
  - setRecordHarPath
```
public Browser.NewContextOptions setRecordHarPath(Path recordHarPath)
```
  - setRecordVideoDir
```
public Browser.NewContextOptions setRecordVideoDir(Path recordVideoDir)
```
  - setRecordVideoSize
```
public Browser.NewContextOptions setRecordVideoSize(int width,
                                                    int height)
```
  - setRecordVideoSize
```
public Browser.NewContextOptions setRecordVideoSize(RecordVideoSize recordVideoSize)
```
  - setScreenSize
```
public Browser.NewContextOptions setScreenSize(int width,
                                               int height)
```
  - setScreenSize
```
public Browser.NewContextOptions setScreenSize(ScreenSize screenSize)
```
  - setStorageState
```
public Browser.NewContextOptions setStorageState(String storageState)
```
  - setStorageStatePath
```
public Browser.NewContextOptions setStorageStatePath(Path storageStatePath)
```
  - setTimezoneId
```
public Browser.NewContextOptions setTimezoneId(String timezoneId)
```
  - setUserAgent
```
public Browser.NewContextOptions setUserAgent(String userAgent)
```
  - setViewportSize
```
public Browser.NewContextOptions setViewportSize(int width,
                                                 int height)
```
  - setViewportSize
```
public Browser.NewContextOptions setViewportSize(ViewportSize viewportSize)
```

Class Browser.NewContextOptions

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

acceptDownloads

bypassCSP

colorScheme

deviceScaleFactor

extraHTTPHeaders

geolocation

hasTouch

httpCredentials

ignoreHTTPSErrors

isMobile

javaScriptEnabled

locale

offline

permissions

proxy

recordHarOmitContent

recordHarPath

recordVideoDir

recordVideoSize

screenSize

storageState

storageStatePath

timezoneId

userAgent

viewportSize

Constructor Detail

NewContextOptions

Method Detail

setAcceptDownloads

setBypassCSP

setColorScheme

setDeviceScaleFactor

setExtraHTTPHeaders

setGeolocation

setGeolocation

setHasTouch

setHttpCredentials

setHttpCredentials

setIgnoreHTTPSErrors

setIsMobile

setJavaScriptEnabled

setLocale

setOffline

setPermissions

setProxy

setProxy

setRecordHarOmitContent

setRecordHarPath

setRecordVideoDir

setRecordVideoSize

setRecordVideoSize

setScreenSize

setScreenSize

setStorageState

setStorageStatePath

setTimezoneId

setUserAgent

setViewportSize

setViewportSize