Skip to main content

externalPlaywrightBrowsingSessionWithBrowser

Hierarchy

Index

Constructors

Methods

Constructors

externalconstructor

Methods

externalcookie

  • cookie(name: string): Promise<Cookie>

  • Parameters

    • externalname: string

    Returns Promise<Cookie>

externalsetCookie

  • Parameters

    Returns Promise<void>

externaldeleteAllCookies

  • deleteAllCookies(): Promise<void>

  • Returns Promise<void>

externalcloseAllPages

  • closeAllPages(): Promise<void>

  • Closes all the pages available in this browsing context

    Returns Promise<void>

externalbrowserCapabilities

  • Returns basic meta-data about the browser associated with this ability.

    Please note that since Playwright does not expose information about the operating system the tests are running on, Serenity/JS assumes that the tests are running locally and therefore returns the value of Node.js process.platform for platformName.

    Returns Promise<BrowserCapabilities>

externalclosePagesOtherThan

  • Parameters

    Returns Promise<void>

externalcurrentPage

  • Returns a Page representing the currently active top-level browsing context.

    Returns Promise<PlaywrightPage>

externalregister

  • Registers specified pages to be managed by this BrowsingSession.

    Parameters

    Returns void

externalderegister

  • deregister(...pageIds: CorrelationId[]): void

  • Informs this BrowsingSession that it should no longer manage pages identified by the given pageIds.

    Parameters

    • externalrest...pageIds: CorrelationId[]

    Returns void

externalallPages

  • Returns a pages representing all the available top-level browsing context, e.g. all the open browser tabs.

    Returns Promise<PlaywrightPage[]>

externalregisteredPageIds

  • registeredPageIds(): CorrelationId[]

  • Returns the ids of any pages this BrowsingSession is aware of.

    Returns CorrelationId[]

externalchangeCurrentPageTo

  • Informs the BrowsingSession that the "current page" has changed to page.

    Please note that different Web integration tools have a different definition of what a "current page" is. For example, Selenium or WebdriverIO use a single "focused" window that a developer needs to explicitly "switch to" in their tests in order to interact with it. This is similar to how a regular user would interact with Web pages; switching from one tab to another, but not interacting with more than one window/tab simultaneously.

    Playwright and Puppeteer, on the other hand, don't have a concept of the "current" page at all, since they allow the developer to interact with multiple open tabs/windows at the same time.

    Web integration-specific implementations of this class should override this method to define how the concept of the "current page" should be interpreted by Serenity/JS.

    Parameters

    Returns Promise<void>