com.microsoft.playwright

Interface Browser

All Superinterfaces:

AutoCloseable

public interface Browser
extends AutoCloseable

A Browser is created via BrowserType.launch(). An example of using a Browser to create a Page:

 import com.microsoft.playwright.*;

 public class Example {
   public static void main(String[] args) {
     try (Playwright playwright = Playwright.create()) {
       BrowserType firefox = playwright.firefox()
       Browser browser = firefox.launch();
       Page page = browser.newPage();
       page.navigate('https://example.com');
       browser.close();
     }
   }
 }
 

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	Browser.NewContextOptions
static class	Browser.NewPageOptions
static class	Browser.StartTracingOptions

Method Summary

Modifier and Type	Method and Description
void	close() In case this browser is obtained using BrowserType.launch(), closes the browser and all of its pages (if any were opened).
List<BrowserContext>	contexts() Returns an array of all open browser contexts.
boolean	isConnected() Indicates that the browser is connected.
default BrowserContext	newContext() Creates a new browser context.
BrowserContext	newContext(Browser.NewContextOptions options) Creates a new browser context.
default Page	newPage() Creates a new page in a new browser context.
Page	newPage(Browser.NewPageOptions options) Creates a new page in a new browser context.
void	offDisconnected(Consumer<Browser> handler) Removes handler that was previously added with onDisconnected(handler).
void	onDisconnected(Consumer<Browser> handler) Emitted when Browser gets disconnected from the browser application.
default void	startTracing() NOTE: This API controls Chromium Tracing which is a low-level chromium-specific debugging tool.
default void	startTracing(Page page) NOTE: This API controls Chromium Tracing which is a low-level chromium-specific debugging tool.
void	startTracing(Page page, Browser.StartTracingOptions options) NOTE: This API controls Chromium Tracing which is a low-level chromium-specific debugging tool.
byte[]	stopTracing() NOTE: This API controls Chromium Tracing which is a low-level chromium-specific debugging tool.
String	version() Returns the browser version.

Method Detail

onDisconnected

void onDisconnected(Consumer<Browser> handler)

Emitted when Browser gets disconnected from the browser application. This might happen because of one of the following:

• Browser application is closed or crashed.
• The Browser.close() method was called.

offDisconnected

void offDisconnected(Consumer<Browser> handler)

Removes handler that was previously added with onDisconnected(handler).

close

void close()

In case this browser is obtained using BrowserType.launch(), closes the browser and all of its pages (if any were opened).

In case this browser is connected to, clears all created contexts belonging to this browser and disconnects from the browser server.

The Browser object itself is considered to be disposed and cannot be used anymore.

Specified by:

close in interface AutoCloseable

contexts

List<BrowserContext> contexts()

Returns an array of all open browser contexts. In a newly created browser, this will return zero browser contexts.

 Browser browser = pw.webkit().launch();
 System.out.println(browser.contexts().size()); // prints "0"
 BrowserContext context = browser.newContext();
 System.out.println(browser.contexts().size()); // prints "1"
 

isConnected

boolean isConnected()

Indicates that the browser is connected.

newContext

default BrowserContext newContext()

Creates a new browser context. It won't share cookies/cache with other browser contexts.

 Browser browser = playwright.firefox().launch();  // Or 'chromium' or 'webkit'.
 // Create a new incognito browser context.
 BrowserContext context = browser.newContext();
 // Create a new page in a pristine context.
 Page page = context.newPage();
 page.navigate('https://example.com');
 

newContext

BrowserContext newContext(Browser.NewContextOptions options)

Creates a new browser context. It won't share cookies/cache with other browser contexts.

 Browser browser = playwright.firefox().launch();  // Or 'chromium' or 'webkit'.
 // Create a new incognito browser context.
 BrowserContext context = browser.newContext();
 // Create a new page in a pristine context.
 Page page = context.newPage();
 page.navigate('https://example.com');
 

newPage

default Page newPage()

Creates a new page in a new browser context. Closing this page will close the context as well.

This is a convenience API that should only be used for the single-page scenarios and short snippets. Production code and testing frameworks should explicitly create Browser.newContext() followed by the BrowserContext.newPage() to control their exact life times.

newPage

Page newPage(Browser.NewPageOptions options)

Creates a new page in a new browser context. Closing this page will close the context as well.

This is a convenience API that should only be used for the single-page scenarios and short snippets. Production code and testing frameworks should explicitly create Browser.newContext() followed by the BrowserContext.newPage() to control their exact life times.

startTracing

default void startTracing(Page page)

NOTE: This API controls Chromium Tracing which is a low-level chromium-specific debugging tool. API to control Playwright Tracing could be found here.

You can use Browser.startTracing() and Browser.stopTracing() to create a trace file that can be opened in Chrome DevTools performance panel.

 browser.startTracing(page, new Browser.StartTracingOptions()
   .setPath(Paths.get("trace.json")));
 page.goto('https://www.google.com');
 browser.stopTracing();
 

Parameters:

page - Optional, if specified, tracing includes screenshots of the given page.

startTracing

default void startTracing()

NOTE: This API controls Chromium Tracing which is a low-level chromium-specific debugging tool. API to control Playwright Tracing could be found here.

You can use Browser.startTracing() and Browser.stopTracing() to create a trace file that can be opened in Chrome DevTools performance panel.

 browser.startTracing(page, new Browser.StartTracingOptions()
   .setPath(Paths.get("trace.json")));
 page.goto('https://www.google.com');
 browser.stopTracing();
 

startTracing

void startTracing(Page page,
                  Browser.StartTracingOptions options)

NOTE: This API controls Chromium Tracing which is a low-level chromium-specific debugging tool. API to control Playwright Tracing could be found here.

You can use Browser.startTracing() and Browser.stopTracing() to create a trace file that can be opened in Chrome DevTools performance panel.

 browser.startTracing(page, new Browser.StartTracingOptions()
   .setPath(Paths.get("trace.json")));
 page.goto('https://www.google.com');
 browser.stopTracing();
 

Parameters:

page - Optional, if specified, tracing includes screenshots of the given page.

stopTracing

byte[] stopTracing()

NOTE: This API controls Chromium Tracing which is a low-level chromium-specific debugging tool. API to control Playwright Tracing could be found here.

Returns the buffer with trace data.

version

String version()

Returns the browser version.