abstractPlaywrightBrowsingSession

Playwright-specific implementation of BrowsingSession.

Hierarchy

• BrowsingSession<PlaywrightPage>
  • PlaywrightBrowsingSession
    • PlaywrightBrowsingSessionWithBrowser
    • PlaywrightBrowsingSessionWithPage

Index

Methods

• browserCapabilities
• cookie
• setCookie
• deleteAllCookies
• closePagesOtherThan
• currentPage
• register
• deregister
• allPages
• registeredPageIds
• changeCurrentPageTo
• closeAllPages

Methods

publicabstractbrowserCapabilities

• browserCapabilities(): Promise<BrowserCapabilities>

• Overrides BrowsingSession.browserCapabilities

  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>

cookie

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

• Parameters

  • name: string

  Returns Promise<Cookie>

setCookie

• setCookie(cookie: CookieData): Promise<void>

• Parameters

  • cookie: CookieData

  Returns Promise<void>

deleteAllCookies

• deleteAllCookies(): Promise<void>

• Returns Promise<void>

closePagesOtherThan

• closePagesOtherThan(pageOfInterest: PlaywrightPage): Promise<void>

• Inherited from BrowsingSession.closePagesOtherThan

  Parameters

  • pageOfInterest: PlaywrightPage

  Returns Promise<void>

currentPage

• currentPage(): Promise<PlaywrightPage>

• Inherited from BrowsingSession.currentPage

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

  ---

  Returns Promise<PlaywrightPage>

register

• register(...pages: PlaywrightPage[]): void

• Inherited from BrowsingSession.register

  Registers specified pages to be managed by this BrowsingSession.

  ---

  Parameters

  • rest...pages: PlaywrightPage[]

  Returns void

deregister

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

• Inherited from BrowsingSession.deregister

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

  ---

  Parameters

  • rest...pageIds: CorrelationId[]

  Returns void

allPages

• allPages(): Promise<PlaywrightPage[]>

• Inherited from BrowsingSession.allPages

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

  ---

  Returns Promise<PlaywrightPage[]>

registeredPageIds

• registeredPageIds(): CorrelationId[]

• Inherited from BrowsingSession.registeredPageIds

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

  ---

  Returns CorrelationId[]

changeCurrentPageTo

• changeCurrentPageTo(page: PlaywrightPage): Promise<void>

• Inherited from BrowsingSession.changeCurrentPageTo

  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

  • page: PlaywrightPage

  Returns Promise<void>

closeAllPages

• closeAllPages(): Promise<void>

• Inherited from BrowsingSession.closeAllPages

  Closes all the pages available in this browsing context

  ---

  Returns Promise<void>