java.lang.Object
- com.microsoft.playwright.BrowserType.LaunchOptions

Enclosing interface:: BrowserType

public static class BrowserType.LaunchOptions
extends Object

Field Summary

Fields
Modifier and Type	Field	Description
`List<String>`	`args`	NOTE: Use custom browser args at your own risk, as some of them may break Playwright functionality.
`Object`	`channel`	Browser distribution channel.
`Boolean`	`chromiumSandbox`	Enable Chromium sandboxing.
`Boolean`	`devtools`	Deprecated. Use debugging tools instead.
`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,Object>`	`firefoxUserPrefs`	Firefox user preferences.
`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`	`headless`	Whether to run browser in headless mode.
`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`.
`Proxy`	`proxy`	Network proxy settings.
`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.
`Path`	`tracesDir`	If specified, traces are saved into this directory.

Constructor Summary

Constructors
Constructor Description

LaunchOptions()

Method Summary

All Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method	Description
`BrowserType.LaunchOptions`	`setArgs(List<String> args)`	NOTE: Use custom browser args at your own risk, as some of them may break Playwright functionality.
`BrowserType.LaunchOptions`	`setChannel(BrowserChannel channel)`	Deprecated.
`BrowserType.LaunchOptions`	`setChannel(String channel)`	Browser distribution channel.
`BrowserType.LaunchOptions`	`setChromiumSandbox(boolean chromiumSandbox)`	Enable Chromium sandboxing.
`BrowserType.LaunchOptions`	`setDevtools(boolean devtools)`	Deprecated. Use debugging tools instead.
`BrowserType.LaunchOptions`	`setDownloadsPath(Path downloadsPath)`	If specified, accepted downloads are downloaded into this directory.
`BrowserType.LaunchOptions`	`setEnv(Map<String,String> env)`	Specify environment variables that will be visible to the browser.
`BrowserType.LaunchOptions`	`setExecutablePath(Path executablePath)`	Path to a browser executable to run instead of the bundled one.
`BrowserType.LaunchOptions`	`setFirefoxUserPrefs(Map<String,Object> firefoxUserPrefs)`	Firefox user preferences.
`BrowserType.LaunchOptions`	`setHandleSIGHUP(boolean handleSIGHUP)`	Close the browser process on SIGHUP.
`BrowserType.LaunchOptions`	`setHandleSIGINT(boolean handleSIGINT)`	Close the browser process on Ctrl-C.
`BrowserType.LaunchOptions`	`setHandleSIGTERM(boolean handleSIGTERM)`	Close the browser process on SIGTERM.
`BrowserType.LaunchOptions`	`setHeadless(boolean headless)`	Whether to run browser in headless mode.
`BrowserType.LaunchOptions`	`setIgnoreAllDefaultArgs(boolean ignoreAllDefaultArgs)`	If `true`, Playwright does not pass its own configurations args and only uses the ones from `args`.
`BrowserType.LaunchOptions`	`setIgnoreDefaultArgs(List<String> ignoreDefaultArgs)`	If `true`, Playwright does not pass its own configurations args and only uses the ones from `args`.
`BrowserType.LaunchOptions`	`setProxy(Proxy proxy)`	Network proxy settings.
`BrowserType.LaunchOptions`	`setProxy(String server)`	Network proxy settings.
`BrowserType.LaunchOptions`	`setSlowMo(double slowMo)`	Slows down Playwright operations by the specified amount of milliseconds.
`BrowserType.LaunchOptions`	`setTimeout(double timeout)`	Maximum time in milliseconds to wait for the browser instance to start.
`BrowserType.LaunchOptions`	`setTracesDir(Path tracesDir)`	If specified, traces are saved into this directory.

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

- Field Detail
  - args
```
public List<String> args
```
    NOTE: Use custom browser args at your own risk, as some of them may break Playwright functionality.
    Additional arguments to pass to the browser instance. The list of Chromium flags can be found here.
  - channel
```
public Object channel
```
    Browser distribution channel. Supported values are "chrome", "chrome-beta", "chrome-dev", "chrome-canary", "msedge", "msedge-beta", "msedge-dev", "msedge-canary". Read more about using Google Chrome and Microsoft Edge.
  - chromiumSandbox
```
public Boolean chromiumSandbox
```
    Enable Chromium sandboxing. Defaults to false.
  - devtools
```
public Boolean devtools
```
    Deprecated.
    Use debugging tools instead.
  - 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. In either case, the downloads are deleted when the browser context they were created in 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. Note that Playwright only works with the bundled Chromium, Firefox or WebKit, use at your own risk.
  - firefoxUserPrefs
```
public Map<String,Object> firefoxUserPrefs
```
    Firefox user preferences. Learn more about the Firefox user preferences at about:config.
  - 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.
  - 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.
  - 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.
  - proxy
```
public Proxy proxy
```
    Network proxy settings.
  - slowMo
```
public Double slowMo
```
    Slows down Playwright operations by the specified amount of milliseconds. Useful so that you can see what is going on.
  - 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.
  - tracesDir
```
public Path tracesDir
```
    If specified, traces are saved into this directory.
- Constructor Detail
  - LaunchOptions
```
public LaunchOptions()
```
- Method Detail
  - setArgs
```
public BrowserType.LaunchOptions setArgs(List<String> args)
```
    NOTE: Use custom browser args at your own risk, as some of them may break Playwright functionality.
    Additional arguments to pass to the browser instance. The list of Chromium flags can be found here.
  - setChannel
```
@Deprecated
public BrowserType.LaunchOptions setChannel(BrowserChannel channel)
```
    Deprecated.
  - setChannel
```
public BrowserType.LaunchOptions setChannel(String channel)
```
    Browser distribution channel. Supported values are "chrome", "chrome-beta", "chrome-dev", "chrome-canary", "msedge", "msedge-beta", "msedge-dev", "msedge-canary". Read more about using Google Chrome and Microsoft Edge.
  - setChromiumSandbox
```
public BrowserType.LaunchOptions setChromiumSandbox(boolean chromiumSandbox)
```
    Enable Chromium sandboxing. Defaults to false.
  - setDevtools
```
public BrowserType.LaunchOptions setDevtools(boolean devtools)
```
    Deprecated.
    Use debugging tools instead.
  - setDownloadsPath
```
public BrowserType.LaunchOptions setDownloadsPath(Path downloadsPath)
```
    If specified, accepted downloads are downloaded into this directory. Otherwise, temporary directory is created and is deleted when browser is closed. In either case, the downloads are deleted when the browser context they were created in is closed.
  - setEnv
```
public BrowserType.LaunchOptions setEnv(Map<String,String> env)
```
    Specify environment variables that will be visible to the browser. Defaults to process.env.
  - setExecutablePath
```
public BrowserType.LaunchOptions setExecutablePath(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. Note that Playwright only works with the bundled Chromium, Firefox or WebKit, use at your own risk.
  - setFirefoxUserPrefs
```
public BrowserType.LaunchOptions setFirefoxUserPrefs(Map<String,Object> firefoxUserPrefs)
```
    Firefox user preferences. Learn more about the Firefox user preferences at about:config.
  - setHandleSIGHUP
```
public BrowserType.LaunchOptions setHandleSIGHUP(boolean handleSIGHUP)
```
    Close the browser process on SIGHUP. Defaults to true.
  - setHandleSIGINT
```
public BrowserType.LaunchOptions setHandleSIGINT(boolean handleSIGINT)
```
    Close the browser process on Ctrl-C. Defaults to true.
  - setHandleSIGTERM
```
public BrowserType.LaunchOptions setHandleSIGTERM(boolean handleSIGTERM)
```
    Close the browser process on SIGTERM. Defaults to true.
  - setHeadless
```
public BrowserType.LaunchOptions setHeadless(boolean headless)
```
    Whether to run browser in headless mode. More details for Chromium and Firefox. Defaults to true unless the devtools option is true.
  - setIgnoreAllDefaultArgs
```
public BrowserType.LaunchOptions setIgnoreAllDefaultArgs(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.
  - setIgnoreDefaultArgs
```
public BrowserType.LaunchOptions setIgnoreDefaultArgs(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.
  - setProxy
```
public BrowserType.LaunchOptions setProxy(String server)
```
    Network proxy settings.
  - setProxy
```
public BrowserType.LaunchOptions setProxy(Proxy proxy)
```
    Network proxy settings.
  - setSlowMo
```
public BrowserType.LaunchOptions setSlowMo(double slowMo)
```
    Slows down Playwright operations by the specified amount of milliseconds. Useful so that you can see what is going on.
  - setTimeout
```
public BrowserType.LaunchOptions setTimeout(double timeout)
```
    Maximum time in milliseconds to wait for the browser instance to start. Defaults to 30000 (30 seconds). Pass 0 to disable timeout.
  - setTracesDir
```
public BrowserType.LaunchOptions setTracesDir(Path tracesDir)
```
    If specified, traces are saved into this directory.

Class BrowserType.LaunchOptions

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

args

channel

chromiumSandbox

devtools

downloadsPath

env

executablePath

firefoxUserPrefs

handleSIGHUP

handleSIGINT

handleSIGTERM

headless

ignoreAllDefaultArgs

ignoreDefaultArgs

proxy

slowMo

timeout

tracesDir

Constructor Detail

LaunchOptions

Method Detail

setArgs

setChannel

setChannel

setChromiumSandbox

setDevtools

setDownloadsPath

setEnv

setExecutablePath

setFirefoxUserPrefs

setHandleSIGHUP

setHandleSIGINT

setHandleSIGTERM

setHeadless

setIgnoreAllDefaultArgs

setIgnoreDefaultArgs

setProxy

setProxy

setSlowMo

setTimeout

setTracesDir