externalPlaywrightBrowsingSessionWithBrowser

Hierarchy

• PlaywrightBrowsingSession
  • PlaywrightBrowsingSessionWithBrowser

Index

Constructors

• constructor

Methods

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

Constructors

externalconstructor

• new PlaywrightBrowsingSessionWithBrowser(browser: Browser, browserContextOptions: PlaywrightOptions, selectors: Selectors): PlaywrightBrowsingSessionWithBrowser

• Overrides PlaywrightBrowsingSession.constructor

  Parameters

  • externalbrowser: Browser

  • externalbrowserContextOptions: PlaywrightOptions

  • externalselectors: Selectors

  Returns PlaywrightBrowsingSessionWithBrowser

Methods

externalcookie

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

• Inherited from PlaywrightBrowsingSession.cookie

  Parameters

  • externalname: string

  Returns Promise<Cookie>

externalsetCookie

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

• Inherited from PlaywrightBrowsingSession.setCookie

  Parameters

  • externalcookie: CookieData

  Returns Promise<void>

externaldeleteAllCookies

• deleteAllCookies(): Promise<void>

• Inherited from PlaywrightBrowsingSession.deleteAllCookies

  Returns Promise<void>

externalcloseAllPages

• closeAllPages(): Promise<void>

• Overrides PlaywrightBrowsingSession.closeAllPages

  Closes all the pages available in this browsing context

  ---

  Returns Promise<void>

externalbrowserCapabilities

• browserCapabilities(): Promise<BrowserCapabilities>

• Overrides PlaywrightBrowsingSession.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>

externalclosePagesOtherThan

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

• Inherited from PlaywrightBrowsingSession.closePagesOtherThan

  Parameters

  • externalpageOfInterest: PlaywrightPage

  Returns Promise<void>

externalcurrentPage

• currentPage(): Promise<PlaywrightPage>

• Inherited from PlaywrightBrowsingSession.currentPage

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

  ---

  Returns Promise<PlaywrightPage>

externalregister

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

• Inherited from PlaywrightBrowsingSession.register

  Registers specified pages to be managed by this BrowsingSession.

  ---

  Parameters

  • externalrest...pages: PlaywrightPage[]

  Returns void

externalderegister

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

• Inherited from PlaywrightBrowsingSession.deregister

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

  ---

  Parameters

  • externalrest...pageIds: CorrelationId[]

  Returns void

externalallPages

• allPages(): Promise<PlaywrightPage[]>

• Inherited from PlaywrightBrowsingSession.allPages

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

  ---

  Returns Promise<PlaywrightPage[]>

externalregisteredPageIds

• registeredPageIds(): CorrelationId[]

• Inherited from PlaywrightBrowsingSession.registeredPageIds

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

  ---

  Returns CorrelationId[]

externalchangeCurrentPageTo

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

• Inherited from PlaywrightBrowsingSession.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

  • externalpage: PlaywrightPage

  Returns Promise<void>