Package com.microsoft.playwright.impl

Class BrowserTypeImpl

java.lang.Object
com.microsoft.playwright.impl.LoggingSupport
com.microsoft.playwright.impl.ChannelOwner
com.microsoft.playwright.impl.BrowserTypeImpl
All Implemented Interfaces:
BrowserType
class BrowserTypeImpl extends ChannelOwner implements BrowserType

  • Constructor Details

    • BrowserTypeImpl

      BrowserTypeImpl(ChannelOwner parent, String type, String guid, com.google.gson.JsonObject initializer)

  • Method Details

    • launch

      public BrowserImpl launch(BrowserType.LaunchOptions options)
      Description copied from interface: BrowserType
      Returns the browser instance.

      **Usage**

      You can use ignoreDefaultArgs to filter out --mute-audio from default arguments: 

      
 // Or "firefox" or "webkit".
 Browser browser = chromium.launch(new BrowserType.LaunchOptions()
   .setIgnoreDefaultArgs(Arrays.asList("--mute-audio")));

      > **Chromium-only** Playwright can also be used to control the Google Chrome or Microsoft Edge browsers, but it works best with the version of Chromium it is bundled with. There is no guarantee it will work with any other version. Use executablePath option with extreme caution.

      >

      > If Google Chrome (rather than Chromium) is preferred, a Chrome Canary or Dev Channel build is suggested.

      >

      > Stock browsers like Google Chrome and Microsoft Edge are suitable for tests that require proprietary media codecs for video playback. See this article for other differences between Chromium and Chrome. This article describes some differences for Linux users.

      Specified by:
      launch in interface BrowserType

    • launchImpl

      private BrowserImpl launchImpl(BrowserType.LaunchOptions options)

    • connect

      public Browser connect(String wsEndpoint, BrowserType.ConnectOptions options)
      Description copied from interface: BrowserType
      This method attaches Playwright to an existing browser instance. When connecting to another browser launched via BrowserType.launchServer in Node.js, the major and minor version needs to match the client version (1.2.3 → is compatible with 1.2.x).
      Specified by:
      connect in interface BrowserType
      Parameters:
      wsEndpoint - A browser websocket endpoint to connect to.

    • connectImpl

      private Browser connectImpl(String wsEndpoint, BrowserType.ConnectOptions options)

    • connectOverCDP

      public Browser connectOverCDP(String endpointURL, BrowserType.ConnectOverCDPOptions options)
      Description copied from interface: BrowserType
      This method attaches Playwright to an existing browser instance using the Chrome DevTools Protocol.

      The default browser context is accessible via Browser.contexts().

      NOTE: Connecting over the Chrome DevTools Protocol is only supported for Chromium-based browsers.

      **Usage** 

      
 Browser browser = playwright.chromium().connectOverCDP("http://localhost:9222");
 BrowserContext defaultContext = browser.contexts().get(0);
 Page page = defaultContext.pages().get(0);
      Specified by:
      connectOverCDP in interface BrowserType
      Parameters:
      endpointURL - A CDP websocket endpoint or http url to connect to. For example http://localhost:9222/ or ws://127.0.0.1:9222/devtools/browser/387adf4c-243f-4051-a181-46798f4a46f4.

    • connectOverCDPImpl

      private Browser connectOverCDPImpl(String endpointURL, BrowserType.ConnectOverCDPOptions options)

    • executablePath

      public String executablePath()
      Description copied from interface: BrowserType
      A path where Playwright expects to find a bundled browser executable.
      Specified by:
      executablePath in interface BrowserType

    • launchPersistentContext

      public BrowserContextImpl launchPersistentContext(Path userDataDir, BrowserType.LaunchPersistentContextOptions options)
      Description copied from interface: BrowserType
      Returns the persistent browser context instance.

      Launches browser that uses persistent storage located at userDataDir and returns the only context. Closing this context will automatically close the browser.

      Specified by:
      launchPersistentContext in interface BrowserType
      Parameters:
      userDataDir - Path to a User Data Directory, which stores browser session data like cookies and local storage. More details for Chromium and Firefox. Note that Chromium's user data directory is the **parent** directory of the "Profile Path" seen at chrome://version. Pass an empty string to use a temporary directory instead.

    • launchPersistentContextImpl

      private BrowserContextImpl launchPersistentContextImpl(Path userDataDir, BrowserType.LaunchPersistentContextOptions options)

    • name

      public String name()
      Description copied from interface: BrowserType
      Returns browser name. For example: "chromium", "webkit" or "firefox".
      Specified by:
      name in interface BrowserType