com.microsoft.playwright

Class BrowserType.LaunchPersistentContextOptions

java.lang.Object

com.microsoft.playwright.BrowserType.LaunchPersistentContextOptions

Enclosing interface:

BrowserType

public static class BrowserType.LaunchPersistentContextOptions
extends Object

Field Summary

Fields

Modifier and Type	Field and Description
Boolean	acceptDownloads Whether to automatically download all the attachments.
List<String>	args Additional arguments to pass to the browser instance.
Boolean	bypassCSP Toggles bypassing page's Content-Security-Policy.
BrowserChannel	channel Browser distribution channel.
Boolean	chromiumSandbox Enable Chromium sandboxing.
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).
Boolean	devtools **Chromium-only** Whether to auto-open a Developer Tools panel for each tab.
Path	downloadsPath If specified, accepted downloads are downloaded into this directory.
Map<String,String>	env Specify environment variables that will be visible to the browser.
Path	executablePath Path to a browser executable to run instead of the bundled one.
Map<String,String>	extraHTTPHeaders An object containing additional HTTP headers to be sent with every request.
Geolocation	geolocation
Boolean	handleSIGHUP Close the browser process on SIGHUP.
Boolean	handleSIGINT Close the browser process on Ctrl-C.
Boolean	handleSIGTERM Close the browser process on SIGTERM.
Boolean	hasTouch Specifies if viewport supports touch events.
Boolean	headless Whether to run browser in headless mode.
HttpCredentials	httpCredentials Credentials for HTTP authentication.
Boolean	ignoreAllDefaultArgs If true, Playwright does not pass its own configurations args and only uses the ones from args.
List<String>	ignoreDefaultArgs If true, Playwright does not pass its own configurations args and only uses the ones from args.
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.
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.
Double	slowMo Slows down Playwright operations by the specified amount of milliseconds.
Double	timeout Maximum time in milliseconds to wait for the browser instance to start.
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
LaunchPersistentContextOptions()

Method Summary

Modifier and Type	Method and Description
BrowserType.LaunchPersistentContextOptions	setAcceptDownloads(boolean acceptDownloads)
BrowserType.LaunchPersistentContextOptions	setArgs(List<String> args)
BrowserType.LaunchPersistentContextOptions	setBypassCSP(boolean bypassCSP)
BrowserType.LaunchPersistentContextOptions	setChannel(BrowserChannel channel)
BrowserType.LaunchPersistentContextOptions	setChromiumSandbox(boolean chromiumSandbox)
BrowserType.LaunchPersistentContextOptions	setColorScheme(ColorScheme colorScheme)
BrowserType.LaunchPersistentContextOptions	setDeviceScaleFactor(double deviceScaleFactor)
BrowserType.LaunchPersistentContextOptions	setDevtools(boolean devtools)
BrowserType.LaunchPersistentContextOptions	setDownloadsPath(Path downloadsPath)
BrowserType.LaunchPersistentContextOptions	setEnv(Map<String,String> env)
BrowserType.LaunchPersistentContextOptions	setExecutablePath(Path executablePath)
BrowserType.LaunchPersistentContextOptions	setExtraHTTPHeaders(Map<String,String> extraHTTPHeaders)
BrowserType.LaunchPersistentContextOptions	setGeolocation(double latitude, double longitude)
BrowserType.LaunchPersistentContextOptions	setGeolocation(Geolocation geolocation)
BrowserType.LaunchPersistentContextOptions	setHandleSIGHUP(boolean handleSIGHUP)
BrowserType.LaunchPersistentContextOptions	setHandleSIGINT(boolean handleSIGINT)
BrowserType.LaunchPersistentContextOptions	setHandleSIGTERM(boolean handleSIGTERM)
BrowserType.LaunchPersistentContextOptions	setHasTouch(boolean hasTouch)
BrowserType.LaunchPersistentContextOptions	setHeadless(boolean headless)
BrowserType.LaunchPersistentContextOptions	setHttpCredentials(HttpCredentials httpCredentials)
BrowserType.LaunchPersistentContextOptions	setHttpCredentials(String username, String password)
BrowserType.LaunchPersistentContextOptions	setIgnoreAllDefaultArgs(boolean ignoreAllDefaultArgs)
BrowserType.LaunchPersistentContextOptions	setIgnoreDefaultArgs(List<String> ignoreDefaultArgs)
BrowserType.LaunchPersistentContextOptions	setIgnoreHTTPSErrors(boolean ignoreHTTPSErrors)
BrowserType.LaunchPersistentContextOptions	setIsMobile(boolean isMobile)
BrowserType.LaunchPersistentContextOptions	setJavaScriptEnabled(boolean javaScriptEnabled)
BrowserType.LaunchPersistentContextOptions	setLocale(String locale)
BrowserType.LaunchPersistentContextOptions	setOffline(boolean offline)
BrowserType.LaunchPersistentContextOptions	setPermissions(List<String> permissions)
BrowserType.LaunchPersistentContextOptions	setProxy(Proxy proxy)
BrowserType.LaunchPersistentContextOptions	setProxy(String server)
BrowserType.LaunchPersistentContextOptions	setRecordHarOmitContent(boolean recordHarOmitContent)
BrowserType.LaunchPersistentContextOptions	setRecordHarPath(Path recordHarPath)
BrowserType.LaunchPersistentContextOptions	setRecordVideoDir(Path recordVideoDir)
BrowserType.LaunchPersistentContextOptions	setRecordVideoSize(int width, int height)
BrowserType.LaunchPersistentContextOptions	setRecordVideoSize(RecordVideoSize recordVideoSize)
BrowserType.LaunchPersistentContextOptions	setScreenSize(int width, int height)
BrowserType.LaunchPersistentContextOptions	setScreenSize(ScreenSize screenSize)
BrowserType.LaunchPersistentContextOptions	setSlowMo(double slowMo)
BrowserType.LaunchPersistentContextOptions	setTimeout(double timeout)
BrowserType.LaunchPersistentContextOptions	setTimezoneId(String timezoneId)
BrowserType.LaunchPersistentContextOptions	setUserAgent(String userAgent)
BrowserType.LaunchPersistentContextOptions	setViewportSize(int width, int height)
BrowserType.LaunchPersistentContextOptions	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.

args

public List<String> args

Additional arguments to pass to the browser instance. The list of Chromium flags can be found here.

bypassCSP

public Boolean bypassCSP

Toggles bypassing page's Content-Security-Policy.

channel

public BrowserChannel channel

Browser distribution channel. Read more about using Google Chrome and Microsoft Edge.

chromiumSandbox

public Boolean chromiumSandbox

Enable Chromium sandboxing. Defaults to true.

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.

devtools

public Boolean devtools

**Chromium-only** Whether to auto-open a Developer Tools panel for each tab. If this option is true, the headless option will be set false.

downloadsPath

public Path downloadsPath

If specified, accepted downloads are downloaded into this directory. Otherwise, temporary directory is created and is deleted when browser is closed.

env

public Map<String,String> env

Specify environment variables that will be visible to the browser. Defaults to process.env.

executablePath

public Path executablePath

Path to a browser executable to run instead of the bundled one. If executablePath is a relative path, then it is resolved relative to the current working directory. **BEWARE**: Playwright is only guaranteed to work with the bundled Chromium, Firefox or WebKit, use at your own risk.

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

handleSIGHUP

public Boolean handleSIGHUP

Close the browser process on SIGHUP. Defaults to true.

handleSIGINT

public Boolean handleSIGINT

Close the browser process on Ctrl-C. Defaults to true.

handleSIGTERM

public Boolean handleSIGTERM

Close the browser process on SIGTERM. Defaults to true.

hasTouch

public Boolean hasTouch

Specifies if viewport supports touch events. Defaults to false.

headless

public Boolean headless

Whether to run browser in headless mode. More details for Chromium and Firefox. Defaults to true unless the devtools option is true.

httpCredentials

public HttpCredentials httpCredentials

Credentials for HTTP authentication.

ignoreAllDefaultArgs

public Boolean ignoreAllDefaultArgs

If true, Playwright does not pass its own configurations args and only uses the ones from args. Dangerous option; use with care. Defaults to false.

ignoreDefaultArgs

public List<String> ignoreDefaultArgs

If true, Playwright does not pass its own configurations args and only uses the ones from args. Dangerous option; use with care.

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.

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.

slowMo

public Double slowMo

Slows down Playwright operations by the specified amount of milliseconds. Useful so that you can see what is going on. Defaults to 0.

timeout

public Double timeout

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

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

LaunchPersistentContextOptions

public LaunchPersistentContextOptions()

Method Detail

setAcceptDownloads

public BrowserType.LaunchPersistentContextOptions setAcceptDownloads(boolean acceptDownloads)

setArgs

public BrowserType.LaunchPersistentContextOptions setArgs(List<String> args)

setBypassCSP

public BrowserType.LaunchPersistentContextOptions setBypassCSP(boolean bypassCSP)

setChannel

public BrowserType.LaunchPersistentContextOptions setChannel(BrowserChannel channel)

setChromiumSandbox

public BrowserType.LaunchPersistentContextOptions setChromiumSandbox(boolean chromiumSandbox)

setColorScheme

public BrowserType.LaunchPersistentContextOptions setColorScheme(ColorScheme colorScheme)

setDeviceScaleFactor

public BrowserType.LaunchPersistentContextOptions setDeviceScaleFactor(double deviceScaleFactor)

setDevtools

public BrowserType.LaunchPersistentContextOptions setDevtools(boolean devtools)

setDownloadsPath

public BrowserType.LaunchPersistentContextOptions setDownloadsPath(Path downloadsPath)

setEnv

public BrowserType.LaunchPersistentContextOptions setEnv(Map<String,String> env)

setExecutablePath

public BrowserType.LaunchPersistentContextOptions setExecutablePath(Path executablePath)

setExtraHTTPHeaders

public BrowserType.LaunchPersistentContextOptions setExtraHTTPHeaders(Map<String,String> extraHTTPHeaders)

setGeolocation

public BrowserType.LaunchPersistentContextOptions setGeolocation(double latitude,
                                                                 double longitude)

setGeolocation

public BrowserType.LaunchPersistentContextOptions setGeolocation(Geolocation geolocation)

setHandleSIGHUP

public BrowserType.LaunchPersistentContextOptions setHandleSIGHUP(boolean handleSIGHUP)

setHandleSIGINT

public BrowserType.LaunchPersistentContextOptions setHandleSIGINT(boolean handleSIGINT)

setHandleSIGTERM

public BrowserType.LaunchPersistentContextOptions setHandleSIGTERM(boolean handleSIGTERM)

setHasTouch

public BrowserType.LaunchPersistentContextOptions setHasTouch(boolean hasTouch)

setHeadless

public BrowserType.LaunchPersistentContextOptions setHeadless(boolean headless)

setHttpCredentials

public BrowserType.LaunchPersistentContextOptions setHttpCredentials(String username,
                                                                     String password)

setHttpCredentials

public BrowserType.LaunchPersistentContextOptions setHttpCredentials(HttpCredentials httpCredentials)

setIgnoreAllDefaultArgs

public BrowserType.LaunchPersistentContextOptions setIgnoreAllDefaultArgs(boolean ignoreAllDefaultArgs)

setIgnoreDefaultArgs

public BrowserType.LaunchPersistentContextOptions setIgnoreDefaultArgs(List<String> ignoreDefaultArgs)

setIgnoreHTTPSErrors

public BrowserType.LaunchPersistentContextOptions setIgnoreHTTPSErrors(boolean ignoreHTTPSErrors)

setIsMobile

public BrowserType.LaunchPersistentContextOptions setIsMobile(boolean isMobile)

setJavaScriptEnabled

public BrowserType.LaunchPersistentContextOptions setJavaScriptEnabled(boolean javaScriptEnabled)

setLocale

public BrowserType.LaunchPersistentContextOptions setLocale(String locale)

setOffline

public BrowserType.LaunchPersistentContextOptions setOffline(boolean offline)

setPermissions

public BrowserType.LaunchPersistentContextOptions setPermissions(List<String> permissions)

setProxy

public BrowserType.LaunchPersistentContextOptions setProxy(String server)

setProxy

public BrowserType.LaunchPersistentContextOptions setProxy(Proxy proxy)

setRecordHarOmitContent

public BrowserType.LaunchPersistentContextOptions setRecordHarOmitContent(boolean recordHarOmitContent)

setRecordHarPath

public BrowserType.LaunchPersistentContextOptions setRecordHarPath(Path recordHarPath)

setRecordVideoDir

public BrowserType.LaunchPersistentContextOptions setRecordVideoDir(Path recordVideoDir)

setRecordVideoSize

public BrowserType.LaunchPersistentContextOptions setRecordVideoSize(int width,
                                                                     int height)

setRecordVideoSize

public BrowserType.LaunchPersistentContextOptions setRecordVideoSize(RecordVideoSize recordVideoSize)

setScreenSize

public BrowserType.LaunchPersistentContextOptions setScreenSize(int width,
                                                                int height)

setScreenSize

public BrowserType.LaunchPersistentContextOptions setScreenSize(ScreenSize screenSize)

setSlowMo

public BrowserType.LaunchPersistentContextOptions setSlowMo(double slowMo)

setTimeout

public BrowserType.LaunchPersistentContextOptions setTimeout(double timeout)

setTimezoneId

public BrowserType.LaunchPersistentContextOptions setTimezoneId(String timezoneId)

setUserAgent

public BrowserType.LaunchPersistentContextOptions setUserAgent(String userAgent)

setViewportSize

public BrowserType.LaunchPersistentContextOptions setViewportSize(int width,
                                                                  int height)

setViewportSize

public BrowserType.LaunchPersistentContextOptions setViewportSize(ViewportSize viewportSize)