BrowserType.LaunchOptions (Playwright - Main Library 1.11.1 API)

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 and Description
`List<String>`	`args` Additional arguments to pass to the browser instance.
`BrowserChannel`	`channel` Browser distribution channel.
`Boolean`	`chromiumSandbox` Enable Chromium sandboxing.
`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,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.

Constructor Summary

Constructors
Constructor and Description

LaunchOptions()

Constructors
Constructor and Description
`LaunchOptions()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`BrowserType.LaunchOptions`	`setArgs(List<String> args)`
`BrowserType.LaunchOptions`	`setChannel(BrowserChannel channel)`
`BrowserType.LaunchOptions`	`setChromiumSandbox(boolean chromiumSandbox)`
`BrowserType.LaunchOptions`	`setDevtools(boolean devtools)`
`BrowserType.LaunchOptions`	`setDownloadsPath(Path downloadsPath)`
`BrowserType.LaunchOptions`	`setEnv(Map<String,String> env)`
`BrowserType.LaunchOptions`	`setExecutablePath(Path executablePath)`
`BrowserType.LaunchOptions`	`setFirefoxUserPrefs(Map<String,Object> firefoxUserPrefs)`
`BrowserType.LaunchOptions`	`setHandleSIGHUP(boolean handleSIGHUP)`
`BrowserType.LaunchOptions`	`setHandleSIGINT(boolean handleSIGINT)`
`BrowserType.LaunchOptions`	`setHandleSIGTERM(boolean handleSIGTERM)`
`BrowserType.LaunchOptions`	`setHeadless(boolean headless)`
`BrowserType.LaunchOptions`	`setIgnoreAllDefaultArgs(boolean ignoreAllDefaultArgs)`
`BrowserType.LaunchOptions`	`setIgnoreDefaultArgs(List<String> ignoreDefaultArgs)`
`BrowserType.LaunchOptions`	`setProxy(Proxy proxy)`
`BrowserType.LaunchOptions`	`setProxy(String server)`
`BrowserType.LaunchOptions`	`setSlowMo(double slowMo)`
`BrowserType.LaunchOptions`	`setTimeout(double timeout)`

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
```
    Additional arguments to pass to the browser instance. The list of Chromium flags can be found here.
  - 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 false.
  - 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. 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.
- Constructor Detail
  - LaunchOptions
```
public LaunchOptions()
```
- Method Detail
  - setArgs
```
public BrowserType.LaunchOptions setArgs(List<String> args)
```
  - setChannel
```
public BrowserType.LaunchOptions setChannel(BrowserChannel channel)
```
  - setChromiumSandbox
```
public BrowserType.LaunchOptions setChromiumSandbox(boolean chromiumSandbox)
```
  - setDevtools
```
public BrowserType.LaunchOptions setDevtools(boolean devtools)
```
  - setDownloadsPath
```
public BrowserType.LaunchOptions setDownloadsPath(Path downloadsPath)
```
  - setEnv
```
public BrowserType.LaunchOptions setEnv(Map<String,String> env)
```
  - setExecutablePath
```
public BrowserType.LaunchOptions setExecutablePath(Path executablePath)
```
  - setFirefoxUserPrefs
```
public BrowserType.LaunchOptions setFirefoxUserPrefs(Map<String,Object> firefoxUserPrefs)
```
  - setHandleSIGHUP
```
public BrowserType.LaunchOptions setHandleSIGHUP(boolean handleSIGHUP)
```
  - setHandleSIGINT
```
public BrowserType.LaunchOptions setHandleSIGINT(boolean handleSIGINT)
```
  - setHandleSIGTERM
```
public BrowserType.LaunchOptions setHandleSIGTERM(boolean handleSIGTERM)
```
  - setHeadless
```
public BrowserType.LaunchOptions setHeadless(boolean headless)
```
  - setIgnoreAllDefaultArgs
```
public BrowserType.LaunchOptions setIgnoreAllDefaultArgs(boolean ignoreAllDefaultArgs)
```
  - setIgnoreDefaultArgs
```
public BrowserType.LaunchOptions setIgnoreDefaultArgs(List<String> ignoreDefaultArgs)
```
  - setProxy
```
public BrowserType.LaunchOptions setProxy(String server)
```
  - setProxy
```
public BrowserType.LaunchOptions setProxy(Proxy proxy)
```
  - setSlowMo
```
public BrowserType.LaunchOptions setSlowMo(double slowMo)
```
  - setTimeout
```
public BrowserType.LaunchOptions setTimeout(double timeout)
```

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

Constructor Detail

LaunchOptions

Method Detail

setArgs

setChannel

setChromiumSandbox

setDevtools

setDownloadsPath

setEnv

setExecutablePath

setFirefoxUserPrefs

setHandleSIGHUP

setHandleSIGINT

setHandleSIGTERM

setHeadless

setIgnoreAllDefaultArgs

setIgnoreDefaultArgs

setProxy

setProxy

setSlowMo

setTimeout